sqlite3-binding.c 7.0 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944155945155946155947155948155949155950155951155952155953155954155955155956155957155958155959155960155961155962155963155964155965155966155967155968155969155970155971155972155973155974155975155976155977155978155979155980155981155982155983155984155985155986155987155988155989155990155991155992155993155994155995155996155997155998155999156000156001156002156003156004156005156006156007156008156009156010156011156012156013156014156015156016156017156018156019156020156021156022156023156024156025156026156027156028156029156030156031156032156033156034156035156036156037156038156039156040156041156042156043156044156045156046156047156048156049156050156051156052156053156054156055156056156057156058156059156060156061156062156063156064156065156066156067156068156069156070156071156072156073156074156075156076156077156078156079156080156081156082156083156084156085156086156087156088156089156090156091156092156093156094156095156096156097156098156099156100156101156102156103156104156105156106156107156108156109156110156111156112156113156114156115156116156117156118156119156120156121156122156123156124156125156126156127156128156129156130156131156132156133156134156135156136156137156138156139156140156141156142156143156144156145156146156147156148156149156150156151156152156153156154156155156156156157156158156159156160156161156162156163156164156165156166156167156168156169156170156171156172156173156174156175156176156177156178156179156180156181156182156183156184156185156186156187156188156189156190156191156192156193156194156195156196156197156198156199156200156201156202156203156204156205156206156207156208156209156210156211156212156213156214156215156216156217156218156219156220156221156222156223156224156225156226156227156228156229156230156231156232156233156234156235156236156237156238156239156240156241156242156243156244156245156246156247156248156249156250156251156252156253156254156255156256156257156258156259156260156261156262156263156264156265156266156267156268156269156270156271156272156273156274156275156276156277156278156279156280156281156282156283156284156285156286156287156288156289156290156291156292156293156294156295156296156297156298156299156300156301156302156303156304156305156306156307156308156309156310156311156312156313156314156315156316156317156318156319156320156321156322156323156324156325156326156327156328156329156330156331156332156333156334156335156336156337156338156339156340156341156342156343156344156345156346156347156348156349156350156351156352156353156354156355156356156357156358156359156360156361156362156363156364156365156366156367156368156369156370156371156372156373156374156375156376156377156378156379156380156381156382156383156384156385156386156387156388156389156390156391156392156393156394156395156396156397156398156399156400156401156402156403156404156405156406156407156408156409156410156411156412156413156414156415156416156417156418156419156420156421156422156423156424156425156426156427156428156429156430156431156432156433156434156435156436156437156438156439156440156441156442156443156444156445156446156447156448156449156450156451156452156453156454156455156456156457156458156459156460156461156462156463156464156465156466156467156468156469156470156471156472156473156474156475156476156477156478156479156480156481156482156483156484156485156486156487156488156489156490156491156492156493156494156495156496156497156498156499156500156501156502156503156504156505156506156507156508156509156510156511156512156513156514156515156516156517156518156519156520156521156522156523156524156525156526156527156528156529156530156531156532156533156534156535156536156537156538156539156540156541156542156543156544156545156546156547156548156549156550156551156552156553156554156555156556156557156558156559156560156561156562156563156564156565156566156567156568156569156570156571156572156573156574156575156576156577156578156579156580156581156582156583156584156585156586156587156588156589156590156591156592156593156594156595156596156597156598156599156600156601156602156603156604156605156606156607156608156609156610156611156612156613156614156615156616156617156618156619156620156621156622156623156624156625156626156627156628156629156630156631156632156633156634156635156636156637156638156639156640156641156642156643156644156645156646156647156648156649156650156651156652156653156654156655156656156657156658156659156660156661156662156663156664156665156666156667156668156669156670156671156672156673156674156675156676156677156678156679156680156681156682156683156684156685156686156687156688156689156690156691156692156693156694156695156696156697156698156699156700156701156702156703156704156705156706156707156708156709156710156711156712156713156714156715156716156717156718156719156720156721156722156723156724156725156726156727156728156729156730156731156732156733156734156735156736156737156738156739156740156741156742156743156744156745156746156747156748156749156750156751156752156753156754156755156756156757156758156759156760156761156762156763156764156765156766156767156768156769156770156771156772156773156774156775156776156777156778156779156780156781156782156783156784156785156786156787156788156789156790156791156792156793156794156795156796156797156798156799156800156801156802156803156804156805156806156807156808156809156810156811156812156813156814156815156816156817156818156819156820156821156822156823156824156825156826156827156828156829156830156831156832156833156834156835156836156837156838156839156840156841156842156843156844156845156846156847156848156849156850156851156852156853156854156855156856156857156858156859156860156861156862156863156864156865156866156867156868156869156870156871156872156873156874156875156876156877156878156879156880156881156882156883156884156885156886156887156888156889156890156891156892156893156894156895156896156897156898156899156900156901156902156903156904156905156906156907156908156909156910156911156912156913156914156915156916156917156918156919156920156921156922156923156924156925156926156927156928156929156930156931156932156933156934156935156936156937156938156939156940156941156942156943156944156945156946156947156948156949156950156951156952156953156954156955156956156957156958156959156960156961156962156963156964156965156966156967156968156969156970156971156972156973156974156975156976156977156978156979156980156981156982156983156984156985156986156987156988156989156990156991156992156993156994156995156996156997156998156999157000157001157002157003157004157005157006157007157008157009157010157011157012157013157014157015157016157017157018157019157020157021157022157023157024157025157026157027157028157029157030157031157032157033157034157035157036157037157038157039157040157041157042157043157044157045157046157047157048157049157050157051157052157053157054157055157056157057157058157059157060157061157062157063157064157065157066157067157068157069157070157071157072157073157074157075157076157077157078157079157080157081157082157083157084157085157086157087157088157089157090157091157092157093157094157095157096157097157098157099157100157101157102157103157104157105157106157107157108157109157110157111157112157113157114157115157116157117157118157119157120157121157122157123157124157125157126157127157128157129157130157131157132157133157134157135157136157137157138157139157140157141157142157143157144157145157146157147157148157149157150157151157152157153157154157155157156157157157158157159157160157161157162157163157164157165157166157167157168157169157170157171157172157173157174157175157176157177157178157179157180157181157182157183157184157185157186157187157188157189157190157191157192157193157194157195157196157197157198157199157200157201157202157203157204157205157206157207157208157209157210157211157212157213157214157215157216157217157218157219157220157221157222157223157224157225157226157227157228157229157230157231157232157233157234157235157236157237157238157239157240157241157242157243157244157245157246157247157248157249157250157251157252157253157254157255157256157257157258157259157260157261157262157263157264157265157266157267157268157269157270157271157272157273157274157275157276157277157278157279157280157281157282157283157284157285157286157287157288157289157290157291157292157293157294157295157296157297157298157299157300157301157302157303157304157305157306157307157308157309157310157311157312157313157314157315157316157317157318157319157320157321157322157323157324157325157326157327157328157329157330157331157332157333157334157335157336157337157338157339157340157341157342157343157344157345157346157347157348157349157350157351157352157353157354157355157356157357157358157359157360157361157362157363157364157365157366157367157368157369157370157371157372157373157374157375157376157377157378157379157380157381157382157383157384157385157386157387157388157389157390157391157392157393157394157395157396157397157398157399157400157401157402157403157404157405157406157407157408157409157410157411157412157413157414157415157416157417157418157419157420157421157422157423157424157425157426157427157428157429157430157431157432157433157434157435157436157437157438157439157440157441157442157443157444157445157446157447157448157449157450157451157452157453157454157455157456157457157458157459157460157461157462157463157464157465157466157467157468157469157470157471157472157473157474157475157476157477157478157479157480157481157482157483157484157485157486157487157488157489157490157491157492157493157494157495157496157497157498157499157500157501157502157503157504157505157506157507157508157509157510157511157512157513157514157515157516157517157518157519157520157521157522157523157524157525157526157527157528157529157530157531157532157533157534157535157536157537157538157539157540157541157542157543157544157545157546157547157548157549157550157551157552157553157554157555157556157557157558157559157560157561157562157563157564157565157566157567157568157569157570157571157572157573157574157575157576157577157578157579157580157581157582157583157584157585157586157587157588157589157590157591157592157593157594157595157596157597157598157599157600157601157602157603157604157605157606157607157608157609157610157611157612157613157614157615157616157617157618157619157620157621157622157623157624157625157626157627157628157629157630157631157632157633157634157635157636157637157638157639157640157641157642157643157644157645157646157647157648157649157650157651157652157653157654157655157656157657157658157659157660157661157662157663157664157665157666157667157668157669157670157671157672157673157674157675157676157677157678157679157680157681157682157683157684157685157686157687157688157689157690157691157692157693157694157695157696157697157698157699157700157701157702157703157704157705157706157707157708157709157710157711157712157713157714157715157716157717157718157719157720157721157722157723157724157725157726157727157728157729157730157731157732157733157734157735157736157737157738157739157740157741157742157743157744157745157746157747157748157749157750157751157752157753157754157755157756157757157758157759157760157761157762157763157764157765157766157767157768157769157770157771157772157773157774157775157776157777157778157779157780157781157782157783157784157785157786157787157788157789157790157791157792157793157794157795157796157797157798157799157800157801157802157803157804157805157806157807157808157809157810157811157812157813157814157815157816157817157818157819157820157821157822157823157824157825157826157827157828157829157830157831157832157833157834157835157836157837157838157839157840157841157842157843157844157845157846157847157848157849157850157851157852157853157854157855157856157857157858157859157860157861157862157863157864157865157866157867157868157869157870157871157872157873157874157875157876157877157878157879157880157881157882157883157884157885157886157887157888157889157890157891157892157893157894157895157896157897157898157899157900157901157902157903157904157905157906157907157908157909157910157911157912157913157914157915157916157917157918157919157920157921157922157923157924157925157926157927157928157929157930157931157932157933157934157935157936157937157938157939157940157941157942157943157944157945157946157947157948157949157950157951157952157953157954157955157956157957157958157959157960157961157962157963157964157965157966157967157968157969157970157971157972157973157974157975157976157977157978157979157980157981157982157983157984157985157986157987157988157989157990157991157992157993157994157995157996157997157998157999158000158001158002158003158004158005158006158007158008158009158010158011158012158013158014158015158016158017158018158019158020158021158022158023158024158025158026158027158028158029158030158031158032158033158034158035158036158037158038158039158040158041158042158043158044158045158046158047158048158049158050158051158052158053158054158055158056158057158058158059158060158061158062158063158064158065158066158067158068158069158070158071158072158073158074158075158076158077158078158079158080158081158082158083158084158085158086158087158088158089158090158091158092158093158094158095158096158097158098158099158100158101158102158103158104158105158106158107158108158109158110158111158112158113158114158115158116158117158118158119158120158121158122158123158124158125158126158127158128158129158130158131158132158133158134158135158136158137158138158139158140158141158142158143158144158145158146158147158148158149158150158151158152158153158154158155158156158157158158158159158160158161158162158163158164158165158166158167158168158169158170158171158172158173158174158175158176158177158178158179158180158181158182158183158184158185158186158187158188158189158190158191158192158193158194158195158196158197158198158199158200158201158202158203158204158205158206158207158208158209158210158211158212158213158214158215158216158217158218158219158220158221158222158223158224158225158226158227158228158229158230158231158232158233158234158235158236158237158238158239158240158241158242158243158244158245158246158247158248158249158250158251158252158253158254158255158256158257158258158259158260158261158262158263158264158265158266158267158268158269158270158271158272158273158274158275158276158277158278158279158280158281158282158283158284158285158286158287158288158289158290158291158292158293158294158295158296158297158298158299158300158301158302158303158304158305158306158307158308158309158310158311158312158313158314158315158316158317158318158319158320158321158322158323158324158325158326158327158328158329158330158331158332158333158334158335158336158337158338158339158340158341158342158343158344158345158346158347158348158349158350158351158352158353158354158355158356158357158358158359158360158361158362158363158364158365158366158367158368158369158370158371158372158373158374158375158376158377158378158379158380158381158382158383158384158385158386158387158388158389158390158391158392158393158394158395158396158397158398158399158400158401158402158403158404158405158406158407158408158409158410158411158412158413158414158415158416158417158418158419158420158421158422158423158424158425158426158427158428158429158430158431158432158433158434158435158436158437158438158439158440158441158442158443158444158445158446158447158448158449158450158451158452158453158454158455158456158457158458158459158460158461158462158463158464158465158466158467158468158469158470158471158472158473158474158475158476158477158478158479158480158481158482158483158484158485158486158487158488158489158490158491158492158493158494158495158496158497158498158499158500158501158502158503158504158505158506158507158508158509158510158511158512158513158514158515158516158517158518158519158520158521158522158523158524158525158526158527158528158529158530158531158532158533158534158535158536158537158538158539158540158541158542158543158544158545158546158547158548158549158550158551158552158553158554158555158556158557158558158559158560158561158562158563158564158565158566158567158568158569158570158571158572158573158574158575158576158577158578158579158580158581158582158583158584158585158586158587158588158589158590158591158592158593158594158595158596158597158598158599158600158601158602158603158604158605158606158607158608158609158610158611158612158613158614158615158616158617158618158619158620158621158622158623158624158625158626158627158628158629158630158631158632158633158634158635158636158637158638158639158640158641158642158643158644158645158646158647158648158649158650158651158652158653158654158655158656158657158658158659158660158661158662158663158664158665158666158667158668158669158670158671158672158673158674158675158676158677158678158679158680158681158682158683158684158685158686158687158688158689158690158691158692158693158694158695158696158697158698158699158700158701158702158703158704158705158706158707158708158709158710158711158712158713158714158715158716158717158718158719158720158721158722158723158724158725158726158727158728158729158730158731158732158733158734158735158736158737158738158739158740158741158742158743158744158745158746158747158748158749158750158751158752158753158754158755158756158757158758158759158760158761158762158763158764158765158766158767158768158769158770158771158772158773158774158775158776158777158778158779158780158781158782158783158784158785158786158787158788158789158790158791158792158793158794158795158796158797158798158799158800158801158802158803158804158805158806158807158808158809158810158811158812158813158814158815158816158817158818158819158820158821158822158823158824158825158826158827158828158829158830158831158832158833158834158835158836158837158838158839158840158841158842158843158844158845158846158847158848158849158850158851158852158853158854158855158856158857158858158859158860158861158862158863158864158865158866158867158868158869158870158871158872158873158874158875158876158877158878158879158880158881158882158883158884158885158886158887158888158889158890158891158892158893158894158895158896158897158898158899158900158901158902158903158904158905158906158907158908158909158910158911158912158913158914158915158916158917158918158919158920158921158922158923158924158925158926158927158928158929158930158931158932158933158934158935158936158937158938158939158940158941158942158943158944158945158946158947158948158949158950158951158952158953158954158955158956158957158958158959158960158961158962158963158964158965158966158967158968158969158970158971158972158973158974158975158976158977158978158979158980158981158982158983158984158985158986158987158988158989158990158991158992158993158994158995158996158997158998158999159000159001159002159003159004159005159006159007159008159009159010159011159012159013159014159015159016159017159018159019159020159021159022159023159024159025159026159027159028159029159030159031159032159033159034159035159036159037159038159039159040159041159042159043159044159045159046159047159048159049159050159051159052159053159054159055159056159057159058159059159060159061159062159063159064159065159066159067159068159069159070159071159072159073159074159075159076159077159078159079159080159081159082159083159084159085159086159087159088159089159090159091159092159093159094159095159096159097159098159099159100159101159102159103159104159105159106159107159108159109159110159111159112159113159114159115159116159117159118159119159120159121159122159123159124159125159126159127159128159129159130159131159132159133159134159135159136159137159138159139159140159141159142159143159144159145159146159147159148159149159150159151159152159153159154159155159156159157159158159159159160159161159162159163159164159165159166159167159168159169159170159171159172159173159174159175159176159177159178159179159180159181159182159183159184159185159186159187159188159189159190159191159192159193159194159195159196159197159198159199159200159201159202159203159204159205159206159207159208159209159210159211159212159213159214159215159216159217159218159219159220159221159222159223159224159225159226159227159228159229159230159231159232159233159234159235159236159237159238159239159240159241159242159243159244159245159246159247159248159249159250159251159252159253159254159255159256159257159258159259159260159261159262159263159264159265159266159267159268159269159270159271159272159273159274159275159276159277159278159279159280159281159282159283159284159285159286159287159288159289159290159291159292159293159294159295159296159297159298159299159300159301159302159303159304159305159306159307159308159309159310159311159312159313159314159315159316159317159318159319159320159321159322159323159324159325159326159327159328159329159330159331159332159333159334159335159336159337159338159339159340159341159342159343159344159345159346159347159348159349159350159351159352159353159354159355159356159357159358159359159360159361159362159363159364159365159366159367159368159369159370159371159372159373159374159375159376159377159378159379159380159381159382159383159384159385159386159387159388159389159390159391159392159393159394159395159396159397159398159399159400159401159402159403159404159405159406159407159408159409159410159411159412159413159414159415159416159417159418159419159420159421159422159423159424159425159426159427159428159429159430159431159432159433159434159435159436159437159438159439159440159441159442159443159444159445159446159447159448159449159450159451159452159453159454159455159456159457159458159459159460159461159462159463159464159465159466159467159468159469159470159471159472159473159474159475159476159477159478159479159480159481159482159483159484159485159486159487159488159489159490159491159492159493159494159495159496159497159498159499159500159501159502159503159504159505159506159507159508159509159510159511159512159513159514159515159516159517159518159519159520159521159522159523159524159525159526159527159528159529159530159531159532159533159534159535159536159537159538159539159540159541159542159543159544159545159546159547159548159549159550159551159552159553159554159555159556159557159558159559159560159561159562159563159564159565159566159567159568159569159570159571159572159573159574159575159576159577159578159579159580159581159582159583159584159585159586159587159588159589159590159591159592159593159594159595159596159597159598159599159600159601159602159603159604159605159606159607159608159609159610159611159612159613159614159615159616159617159618159619159620159621159622159623159624159625159626159627159628159629159630159631159632159633159634159635159636159637159638159639159640159641159642159643159644159645159646159647159648159649159650159651159652159653159654159655159656159657159658159659159660159661159662159663159664159665159666159667159668159669159670159671159672159673159674159675159676159677159678159679159680159681159682159683159684159685159686159687159688159689159690159691159692159693159694159695159696159697159698159699159700159701159702159703159704159705159706159707159708159709159710159711159712159713159714159715159716159717159718159719159720159721159722159723159724159725159726159727159728159729159730159731159732159733159734159735159736159737159738159739159740159741159742159743159744159745159746159747159748159749159750159751159752159753159754159755159756159757159758159759159760159761159762159763159764159765159766159767159768159769159770159771159772159773159774159775159776159777159778159779159780159781159782159783159784159785159786159787159788159789159790159791159792159793159794159795159796159797159798159799159800159801159802159803159804159805159806159807159808159809159810159811159812159813159814159815159816159817159818159819159820159821159822159823159824159825159826159827159828159829159830159831159832159833159834159835159836159837159838159839159840159841159842159843159844159845159846159847159848159849159850159851159852159853159854159855159856159857159858159859159860159861159862159863159864159865159866159867159868159869159870159871159872159873159874159875159876159877159878159879159880159881159882159883159884159885159886159887159888159889159890159891159892159893159894159895159896159897159898159899159900159901159902159903159904159905159906159907159908159909159910159911159912159913159914159915159916159917159918159919159920159921159922159923159924159925159926159927159928159929159930159931159932159933159934159935159936159937159938159939159940159941159942159943159944159945159946159947159948159949159950159951159952159953159954159955159956159957159958159959159960159961159962159963159964159965159966159967159968159969159970159971159972159973159974159975159976159977159978159979159980159981159982159983159984159985159986159987159988159989159990159991159992159993159994159995159996159997159998159999160000160001160002160003160004160005160006160007160008160009160010160011160012160013160014160015160016160017160018160019160020160021160022160023160024160025160026160027160028160029160030160031160032160033160034160035160036160037160038160039160040160041160042160043160044160045160046160047160048160049160050160051160052160053160054160055160056160057160058160059160060160061160062160063160064160065160066160067160068160069160070160071160072160073160074160075160076160077160078160079160080160081160082160083160084160085160086160087160088160089160090160091160092160093160094160095160096160097160098160099160100160101160102160103160104160105160106160107160108160109160110160111160112160113160114160115160116160117160118160119160120160121160122160123160124160125160126160127160128160129160130160131160132160133160134160135160136160137160138160139160140160141160142160143160144160145160146160147160148160149160150160151160152160153160154160155160156160157160158160159160160160161160162160163160164160165160166160167160168160169160170160171160172160173160174160175160176160177160178160179160180160181160182160183160184160185160186160187160188160189160190160191160192160193160194160195160196160197160198160199160200160201160202160203160204160205160206160207160208160209160210160211160212160213160214160215160216160217160218160219160220160221160222160223160224160225160226160227160228160229160230160231160232160233160234160235160236160237160238160239160240160241160242160243160244160245160246160247160248160249160250160251160252160253160254160255160256160257160258160259160260160261160262160263160264160265160266160267160268160269160270160271160272160273160274160275160276160277160278160279160280160281160282160283160284160285160286160287160288160289160290160291160292160293160294160295160296160297160298160299160300160301160302160303160304160305160306160307160308160309160310160311160312160313160314160315160316160317160318160319160320160321160322160323160324160325160326160327160328160329160330160331160332160333160334160335160336160337160338160339160340160341160342160343160344160345160346160347160348160349160350160351160352160353160354160355160356160357160358160359160360160361160362160363160364160365160366160367160368160369160370160371160372160373160374160375160376160377160378160379160380160381160382160383160384160385160386160387160388160389160390160391160392160393160394160395160396160397160398160399160400160401160402160403160404160405160406160407160408160409160410160411160412160413160414160415160416160417160418160419160420160421160422160423160424160425160426160427160428160429160430160431160432160433160434160435160436160437160438160439160440160441160442160443160444160445160446160447160448160449160450160451160452160453160454160455160456160457160458160459160460160461160462160463160464160465160466160467160468160469160470160471160472160473160474160475160476160477160478160479160480160481160482160483160484160485160486160487160488160489160490160491160492160493160494160495160496160497160498160499160500160501160502160503160504160505160506160507160508160509160510160511160512160513160514160515160516160517160518160519160520160521160522160523160524160525160526160527160528160529160530160531160532160533160534160535160536160537160538160539160540160541160542160543160544160545160546160547160548160549160550160551160552160553160554160555160556160557160558160559160560160561160562160563160564160565160566160567160568160569160570160571160572160573160574160575160576160577160578160579160580160581160582160583160584160585160586160587160588160589160590160591160592160593160594160595160596160597160598160599160600160601160602160603160604160605160606160607160608160609160610160611160612160613160614160615160616160617160618160619160620160621160622160623160624160625160626160627160628160629160630160631160632160633160634160635160636160637160638160639160640160641160642160643160644160645160646160647160648160649160650160651160652160653160654160655160656160657160658160659160660160661160662160663160664160665160666160667160668160669160670160671160672160673160674160675160676160677160678160679160680160681160682160683160684160685160686160687160688160689160690160691160692160693160694160695160696160697160698160699160700160701160702160703160704160705160706160707160708160709160710160711160712160713160714160715160716160717160718160719160720160721160722160723160724160725160726160727160728160729160730160731160732160733160734160735160736160737160738160739160740160741160742160743160744160745160746160747160748160749160750160751160752160753160754160755160756160757160758160759160760160761160762160763160764160765160766160767160768160769160770160771160772160773160774160775160776160777160778160779160780160781160782160783160784160785160786160787160788160789160790160791160792160793160794160795160796160797160798160799160800160801160802160803160804160805160806160807160808160809160810160811160812160813160814160815160816160817160818160819160820160821160822160823160824160825160826160827160828160829160830160831160832160833160834160835160836160837160838160839160840160841160842160843160844160845160846160847160848160849160850160851160852160853160854160855160856160857160858160859160860160861160862160863160864160865160866160867160868160869160870160871160872160873160874160875160876160877160878160879160880160881160882160883160884160885160886160887160888160889160890160891160892160893160894160895160896160897160898160899160900160901160902160903160904160905160906160907160908160909160910160911160912160913160914160915160916160917160918160919160920160921160922160923160924160925160926160927160928160929160930160931160932160933160934160935160936160937160938160939160940160941160942160943160944160945160946160947160948160949160950160951160952160953160954160955160956160957160958160959160960160961160962160963160964160965160966160967160968160969160970160971160972160973160974160975160976160977160978160979160980160981160982160983160984160985160986160987160988160989160990160991160992160993160994160995160996160997160998160999161000161001161002161003161004161005161006161007161008161009161010161011161012161013161014161015161016161017161018161019161020161021161022161023161024161025161026161027161028161029161030161031161032161033161034161035161036161037161038161039161040161041161042161043161044161045161046161047161048161049161050161051161052161053161054161055161056161057161058161059161060161061161062161063161064161065161066161067161068161069161070161071161072161073161074161075161076161077161078161079161080161081161082161083161084161085161086161087161088161089161090161091161092161093161094161095161096161097161098161099161100161101161102161103161104161105161106161107161108161109161110161111161112161113161114161115161116161117161118161119161120161121161122161123161124161125161126161127161128161129161130161131161132161133161134161135161136161137161138161139161140161141161142161143161144161145161146161147161148161149161150161151161152161153161154161155161156161157161158161159161160161161161162161163161164161165161166161167161168161169161170161171161172161173161174161175161176161177161178161179161180161181161182161183161184161185161186161187161188161189161190161191161192161193161194161195161196161197161198161199161200161201161202161203161204161205161206161207161208161209161210161211161212161213161214161215161216161217161218161219161220161221161222161223161224161225161226161227161228161229161230161231161232161233161234161235161236161237161238161239161240161241161242161243161244161245161246161247161248161249161250161251161252161253161254161255161256161257161258161259161260161261161262161263161264161265161266161267161268161269161270161271161272161273161274161275161276161277161278161279161280161281161282161283161284161285161286161287161288161289161290161291161292161293161294161295161296161297161298161299161300161301161302161303161304161305161306161307161308161309161310161311161312161313161314161315161316161317161318161319161320161321161322161323161324161325161326161327161328161329161330161331161332161333161334161335161336161337161338161339161340161341161342161343161344161345161346161347161348161349161350161351161352161353161354161355161356161357161358161359161360161361161362161363161364161365161366161367161368161369161370161371161372161373161374161375161376161377161378161379161380161381161382161383161384161385161386161387161388161389161390161391161392161393161394161395161396161397161398161399161400161401161402161403161404161405161406161407161408161409161410161411161412161413161414161415161416161417161418161419161420161421161422161423161424161425161426161427161428161429161430161431161432161433161434161435161436161437161438161439161440161441161442161443161444161445161446161447161448161449161450161451161452161453161454161455161456161457161458161459161460161461161462161463161464161465161466161467161468161469161470161471161472161473161474161475161476161477161478161479161480161481161482161483161484161485161486161487161488161489161490161491161492161493161494161495161496161497161498161499161500161501161502161503161504161505161506161507161508161509161510161511161512161513161514161515161516161517161518161519161520161521161522161523161524161525161526161527161528161529161530161531161532161533161534161535161536161537161538161539161540161541161542161543161544161545161546161547161548161549161550161551161552161553161554161555161556161557161558161559161560161561161562161563161564161565161566161567161568161569161570161571161572161573161574161575161576161577161578161579161580161581161582161583161584161585161586161587161588161589161590161591161592161593161594161595161596161597161598161599161600161601161602161603161604161605161606161607161608161609161610161611161612161613161614161615161616161617161618161619161620161621161622161623161624161625161626161627161628161629161630161631161632161633161634161635161636161637161638161639161640161641161642161643161644161645161646161647161648161649161650161651161652161653161654161655161656161657161658161659161660161661161662161663161664161665161666161667161668161669161670161671161672161673161674161675161676161677161678161679161680161681161682161683161684161685161686161687161688161689161690161691161692161693161694161695161696161697161698161699161700161701161702161703161704161705161706161707161708161709161710161711161712161713161714161715161716161717161718161719161720161721161722161723161724161725161726161727161728161729161730161731161732161733161734161735161736161737161738161739161740161741161742161743161744161745161746161747161748161749161750161751161752161753161754161755161756161757161758161759161760161761161762161763161764161765161766161767161768161769161770161771161772161773161774161775161776161777161778161779161780161781161782161783161784161785161786161787161788161789161790161791161792161793161794161795161796161797161798161799161800161801161802161803161804161805161806161807161808161809161810161811161812161813161814161815161816161817161818161819161820161821161822161823161824161825161826161827161828161829161830161831161832161833161834161835161836161837161838161839161840161841161842161843161844161845161846161847161848161849161850161851161852161853161854161855161856161857161858161859161860161861161862161863161864161865161866161867161868161869161870161871161872161873161874161875161876161877161878161879161880161881161882161883161884161885161886161887161888161889161890161891161892161893161894161895161896161897161898161899161900161901161902161903161904161905161906161907161908161909161910161911161912161913161914161915161916161917161918161919161920161921161922161923161924161925161926161927161928161929161930161931161932161933161934161935161936161937161938161939161940161941161942161943161944161945161946161947161948161949161950161951161952161953161954161955161956161957161958161959161960161961161962161963161964161965161966161967161968161969161970161971161972161973161974161975161976161977161978161979161980161981161982161983161984161985161986161987161988161989161990161991161992161993161994161995161996161997161998161999162000162001162002162003162004162005162006162007162008162009162010162011162012162013162014162015162016162017162018162019162020162021162022162023162024162025162026162027162028162029162030162031162032162033162034162035162036162037162038162039162040162041162042162043162044162045162046162047162048162049162050162051162052162053162054162055162056162057162058162059162060162061162062162063162064162065162066162067162068162069162070162071162072162073162074162075162076162077162078162079162080162081162082162083162084162085162086162087162088162089162090162091162092162093162094162095162096162097162098162099162100162101162102162103162104162105162106162107162108162109162110162111162112162113162114162115162116162117162118162119162120162121162122162123162124162125162126162127162128162129162130162131162132162133162134162135162136162137162138162139162140162141162142162143162144162145162146162147162148162149162150162151162152162153162154162155162156162157162158162159162160162161162162162163162164162165162166162167162168162169162170162171162172162173162174162175162176162177162178162179162180162181162182162183162184162185162186162187162188162189162190162191162192162193162194162195162196162197162198162199162200162201162202162203162204162205162206162207162208162209162210162211162212162213162214162215162216162217162218162219162220162221162222162223162224162225162226162227162228162229162230162231162232162233162234162235162236162237162238162239162240162241162242162243162244162245162246162247162248162249162250162251162252162253162254162255162256162257162258162259162260162261162262162263162264162265162266162267162268162269162270162271162272162273162274162275162276162277162278162279162280162281162282162283162284162285162286162287162288162289162290162291162292162293162294162295162296162297162298162299162300162301162302162303162304162305162306162307162308162309162310162311162312162313162314162315162316162317162318162319162320162321162322162323162324162325162326162327162328162329162330162331162332162333162334162335162336162337162338162339162340162341162342162343162344162345162346162347162348162349162350162351162352162353162354162355162356162357162358162359162360162361162362162363162364162365162366162367162368162369162370162371162372162373162374162375162376162377162378162379162380162381162382162383162384162385162386162387162388162389162390162391162392162393162394162395162396162397162398162399162400162401162402162403162404162405162406162407162408162409162410162411162412162413162414162415162416162417162418162419162420162421162422162423162424162425162426162427162428162429162430162431162432162433162434162435162436162437162438162439162440162441162442162443162444162445162446162447162448162449162450162451162452162453162454162455162456162457162458162459162460162461162462162463162464162465162466162467162468162469162470162471162472162473162474162475162476162477162478162479162480162481162482162483162484162485162486162487162488162489162490162491162492162493162494162495162496162497162498162499162500162501162502162503162504162505162506162507162508162509162510162511162512162513162514162515162516162517162518162519162520162521162522162523162524162525162526162527162528162529162530162531162532162533162534162535162536162537162538162539162540162541162542162543162544162545162546162547162548162549162550162551162552162553162554162555162556162557162558162559162560162561162562162563162564162565162566162567162568162569162570162571162572162573162574162575162576162577162578162579162580162581162582162583162584162585162586162587162588162589162590162591162592162593162594162595162596162597162598162599162600162601162602162603162604162605162606162607162608162609162610162611162612162613162614162615162616162617162618162619162620162621162622162623162624162625162626162627162628162629162630162631162632162633162634162635162636162637162638162639162640162641162642162643162644162645162646162647162648162649162650162651162652162653162654162655162656162657162658162659162660162661162662162663162664162665162666162667162668162669162670162671162672162673162674162675162676162677162678162679162680162681162682162683162684162685162686162687162688162689162690162691162692162693162694162695162696162697162698162699162700162701162702162703162704162705162706162707162708162709162710162711162712162713162714162715162716162717162718162719162720162721162722162723162724162725162726162727162728162729162730162731162732162733162734162735162736162737162738162739162740162741162742162743162744162745162746162747162748162749162750162751162752162753162754162755162756162757162758162759162760162761162762162763162764162765162766162767162768162769162770162771162772162773162774162775162776162777162778162779162780162781162782162783162784162785162786162787162788162789162790162791162792162793162794162795162796162797162798162799162800162801162802162803162804162805162806162807162808162809162810162811162812162813162814162815162816162817162818162819162820162821162822162823162824162825162826162827162828162829162830162831162832162833162834162835162836162837162838162839162840162841162842162843162844162845162846162847162848162849162850162851162852162853162854162855162856162857162858162859162860162861162862162863162864162865162866162867162868162869162870162871162872162873162874162875162876162877162878162879162880162881162882162883162884162885162886162887162888162889162890162891162892162893162894162895162896162897162898162899162900162901162902162903162904162905162906162907162908162909162910162911162912162913162914162915162916162917162918162919162920162921162922162923162924162925162926162927162928162929162930162931162932162933162934162935162936162937162938162939162940162941162942162943162944162945162946162947162948162949162950162951162952162953162954162955162956162957162958162959162960162961162962162963162964162965162966162967162968162969162970162971162972162973162974162975162976162977162978162979162980162981162982162983162984162985162986162987162988162989162990162991162992162993162994162995162996162997162998162999163000163001163002163003163004163005163006163007163008163009163010163011163012163013163014163015163016163017163018163019163020163021163022163023163024163025163026163027163028163029163030163031163032163033163034163035163036163037163038163039163040163041163042163043163044163045163046163047163048163049163050163051163052163053163054163055163056163057163058163059163060163061163062163063163064163065163066163067163068163069163070163071163072163073163074163075163076163077163078163079163080163081163082163083163084163085163086163087163088163089163090163091163092163093163094163095163096163097163098163099163100163101163102163103163104163105163106163107163108163109163110163111163112163113163114163115163116163117163118163119163120163121163122163123163124163125163126163127163128163129163130163131163132163133163134163135163136163137163138163139163140163141163142163143163144163145163146163147163148163149163150163151163152163153163154163155163156163157163158163159163160163161163162163163163164163165163166163167163168163169163170163171163172163173163174163175163176163177163178163179163180163181163182163183163184163185163186163187163188163189163190163191163192163193163194163195163196163197163198163199163200163201163202163203163204163205163206163207163208163209163210163211163212163213163214163215163216163217163218163219163220163221163222163223163224163225163226163227163228163229163230163231163232163233163234163235163236163237163238163239163240163241163242163243163244163245163246163247163248163249163250163251163252163253163254163255163256163257163258163259163260163261163262163263163264163265163266163267163268163269163270163271163272163273163274163275163276163277163278163279163280163281163282163283163284163285163286163287163288163289163290163291163292163293163294163295163296163297163298163299163300163301163302163303163304163305163306163307163308163309163310163311163312163313163314163315163316163317163318163319163320163321163322163323163324163325163326163327163328163329163330163331163332163333163334163335163336163337163338163339163340163341163342163343163344163345163346163347163348163349163350163351163352163353163354163355163356163357163358163359163360163361163362163363163364163365163366163367163368163369163370163371163372163373163374163375163376163377163378163379163380163381163382163383163384163385163386163387163388163389163390163391163392163393163394163395163396163397163398163399163400163401163402163403163404163405163406163407163408163409163410163411163412163413163414163415163416163417163418163419163420163421163422163423163424163425163426163427163428163429163430163431163432163433163434163435163436163437163438163439163440163441163442163443163444163445163446163447163448163449163450163451163452163453163454163455163456163457163458163459163460163461163462163463163464163465163466163467163468163469163470163471163472163473163474163475163476163477163478163479163480163481163482163483163484163485163486163487163488163489163490163491163492163493163494163495163496163497163498163499163500163501163502163503163504163505163506163507163508163509163510163511163512163513163514163515163516163517163518163519163520163521163522163523163524163525163526163527163528163529163530163531163532163533163534163535163536163537163538163539163540163541163542163543163544163545163546163547163548163549163550163551163552163553163554163555163556163557163558163559163560163561163562163563163564163565163566163567163568163569163570163571163572163573163574163575163576163577163578163579163580163581163582163583163584163585163586163587163588163589163590163591163592163593163594163595163596163597163598163599163600163601163602163603163604163605163606163607163608163609163610163611163612163613163614163615163616163617163618163619163620163621163622163623163624163625163626163627163628163629163630163631163632163633163634163635163636163637163638163639163640163641163642163643163644163645163646163647163648163649163650163651163652163653163654163655163656163657163658163659163660163661163662163663163664163665163666163667163668163669163670163671163672163673163674163675163676163677163678163679163680163681163682163683163684163685163686163687163688163689163690163691163692163693163694163695163696163697163698163699163700163701163702163703163704163705163706163707163708163709163710163711163712163713163714163715163716163717163718163719163720163721163722163723163724163725163726163727163728163729163730163731163732163733163734163735163736163737163738163739163740163741163742163743163744163745163746163747163748163749163750163751163752163753163754163755163756163757163758163759163760163761163762163763163764163765163766163767163768163769163770163771163772163773163774163775163776163777163778163779163780163781163782163783163784163785163786163787163788163789163790163791163792163793163794163795163796163797163798163799163800163801163802163803163804163805163806163807163808163809163810163811163812163813163814163815163816163817163818163819163820163821163822163823163824163825163826163827163828163829163830163831163832163833163834163835163836163837163838163839163840163841163842163843163844163845163846163847163848163849163850163851163852163853163854163855163856163857163858163859163860163861163862163863163864163865163866163867163868163869163870163871163872163873163874163875163876163877163878163879163880163881163882163883163884163885163886163887163888163889163890163891163892163893163894163895163896163897163898163899163900163901163902163903163904163905163906163907163908163909163910163911163912163913163914163915163916163917163918163919163920163921163922163923163924163925163926163927163928163929163930163931163932163933163934163935163936163937163938163939163940163941163942163943163944163945163946163947163948163949163950163951163952163953163954163955163956163957163958163959163960163961163962163963163964163965163966163967163968163969163970163971163972163973163974163975163976163977163978163979163980163981163982163983163984163985163986163987163988163989163990163991163992163993163994163995163996163997163998163999164000164001164002164003164004164005164006164007164008164009164010164011164012164013164014164015164016164017164018164019164020164021164022164023164024164025164026164027164028164029164030164031164032164033164034164035164036164037164038164039164040164041164042164043164044164045164046164047164048164049164050164051164052164053164054164055164056164057164058164059164060164061164062164063164064164065164066164067164068164069164070164071164072164073164074164075164076164077164078164079164080164081164082164083164084164085164086164087164088164089164090164091164092164093164094164095164096164097164098164099164100164101164102164103164104164105164106164107164108164109164110164111164112164113164114164115164116164117164118164119164120164121164122164123164124164125164126164127164128164129164130164131164132164133164134164135164136164137164138164139164140164141164142164143164144164145164146164147164148164149164150164151164152164153164154164155164156164157164158164159164160164161164162164163164164164165164166164167164168164169164170164171164172164173164174164175164176164177164178164179164180164181164182164183164184164185164186164187164188164189164190164191164192164193164194164195164196164197164198164199164200164201164202164203164204164205164206164207164208164209164210164211164212164213164214164215164216164217164218164219164220164221164222164223164224164225164226164227164228164229164230164231164232164233164234164235164236164237164238164239164240164241164242164243164244164245164246164247164248164249164250164251164252164253164254164255164256164257164258164259164260164261164262164263164264164265164266164267164268164269164270164271164272164273164274164275164276164277164278164279164280164281164282164283164284164285164286164287164288164289164290164291164292164293164294164295164296164297164298164299164300164301164302164303164304164305164306164307164308164309164310164311164312164313164314164315164316164317164318164319164320164321164322164323164324164325164326164327164328164329164330164331164332164333164334164335164336164337164338164339164340164341164342164343164344164345164346164347164348164349164350164351164352164353164354164355164356164357164358164359164360164361164362164363164364164365164366164367164368164369164370164371164372164373164374164375164376164377164378164379164380164381164382164383164384164385164386164387164388164389164390164391164392164393164394164395164396164397164398164399164400164401164402164403164404164405164406164407164408164409164410164411164412164413164414164415164416164417164418164419164420164421164422164423164424164425164426164427164428164429164430164431164432164433164434164435164436164437164438164439164440164441164442164443164444164445164446164447164448164449164450164451164452164453164454164455164456164457164458164459164460164461164462164463164464164465164466164467164468164469164470164471164472164473164474164475164476164477164478164479164480164481164482164483164484164485164486164487164488164489164490164491164492164493164494164495164496164497164498164499164500164501164502164503164504164505164506164507164508164509164510164511164512164513164514164515164516164517164518164519164520164521164522164523164524164525164526164527164528164529164530164531164532164533164534164535164536164537164538164539164540164541164542164543164544164545164546164547164548164549164550164551164552164553164554164555164556164557164558164559164560164561164562164563164564164565164566164567164568164569164570164571164572164573164574164575164576164577164578164579164580164581164582164583164584164585164586164587164588164589164590164591164592164593164594164595164596164597164598164599164600164601164602164603164604164605164606164607164608164609164610164611164612164613164614164615164616164617164618164619164620164621164622164623164624164625164626164627164628164629164630164631164632164633164634164635164636164637164638164639164640164641164642164643164644164645164646164647164648164649164650164651164652164653164654164655164656164657164658164659164660164661164662164663164664164665164666164667164668164669164670164671164672164673164674164675164676164677164678164679164680164681164682164683164684164685164686164687164688164689164690164691164692164693164694164695164696164697164698164699164700164701164702164703164704164705164706164707164708164709164710164711164712164713164714164715164716164717164718164719164720164721164722164723164724164725164726164727164728164729164730164731164732164733164734164735164736164737164738164739164740164741164742164743164744164745164746164747164748164749164750164751164752164753164754164755164756164757164758164759164760164761164762164763164764164765164766164767164768164769164770164771164772164773164774164775164776164777164778164779164780164781164782164783164784164785164786164787164788164789164790164791164792164793164794164795164796164797164798164799164800164801164802164803164804164805164806164807164808164809164810164811164812164813164814164815164816164817164818164819164820164821164822164823164824164825164826164827164828164829164830164831164832164833164834164835164836164837164838164839164840164841164842164843164844164845164846164847164848164849164850164851164852164853164854164855164856164857164858164859164860164861164862164863164864164865164866164867164868164869164870164871164872164873164874164875164876164877164878164879164880164881164882164883164884164885164886164887164888164889164890164891164892164893164894164895164896164897164898164899164900164901164902164903164904164905164906164907164908164909164910164911164912164913164914164915164916164917164918164919164920164921164922164923164924164925164926164927164928164929164930164931164932164933164934164935164936164937164938164939164940164941164942164943164944164945164946164947164948164949164950164951164952164953164954164955164956164957164958164959164960164961164962164963164964164965164966164967164968164969164970164971164972164973164974164975164976164977164978164979164980164981164982164983164984164985164986164987164988164989164990164991164992164993164994164995164996164997164998164999165000165001165002165003165004165005165006165007165008165009165010165011165012165013165014165015165016165017165018165019165020165021165022165023165024165025165026165027165028165029165030165031165032165033165034165035165036165037165038165039165040165041165042165043165044165045165046165047165048165049165050165051165052165053165054165055165056165057165058165059165060165061165062165063165064165065165066165067165068165069165070165071165072165073165074165075165076165077165078165079165080165081165082165083165084165085165086165087165088165089165090165091165092165093165094165095165096165097165098165099165100165101165102165103165104165105165106165107165108165109165110165111165112165113165114165115165116165117165118165119165120165121165122165123165124165125165126165127165128165129165130165131165132165133165134165135165136165137165138165139165140165141165142165143165144165145165146165147165148165149165150165151165152165153165154165155165156165157165158165159165160165161165162165163165164165165165166165167165168165169165170165171165172165173165174165175165176165177165178165179165180165181165182165183165184165185165186165187165188165189165190165191165192165193165194165195165196165197165198165199165200165201165202165203165204165205165206165207165208165209165210165211165212165213165214165215165216165217165218165219165220165221165222165223165224165225165226165227165228165229165230165231165232165233165234165235165236165237165238165239165240165241165242165243165244165245165246165247165248165249165250165251165252165253165254165255165256165257165258165259165260165261165262165263165264165265165266165267165268165269165270165271165272165273165274165275165276165277165278165279165280165281165282165283165284165285165286165287165288165289165290165291165292165293165294165295165296165297165298165299165300165301165302165303165304165305165306165307165308165309165310165311165312165313165314165315165316165317165318165319165320165321165322165323165324165325165326165327165328165329165330165331165332165333165334165335165336165337165338165339165340165341165342165343165344165345165346165347165348165349165350165351165352165353165354165355165356165357165358165359165360165361165362165363165364165365165366165367165368165369165370165371165372165373165374165375165376165377165378165379165380165381165382165383165384165385165386165387165388165389165390165391165392165393165394165395165396165397165398165399165400165401165402165403165404165405165406165407165408165409165410165411165412165413165414165415165416165417165418165419165420165421165422165423165424165425165426165427165428165429165430165431165432165433165434165435165436165437165438165439165440165441165442165443165444165445165446165447165448165449165450165451165452165453165454165455165456165457165458165459165460165461165462165463165464165465165466165467165468165469165470165471165472165473165474165475165476165477165478165479165480165481165482165483165484165485165486165487165488165489165490165491165492165493165494165495165496165497165498165499165500165501165502165503165504165505165506165507165508165509165510165511165512165513165514165515165516165517165518165519165520165521165522165523165524165525165526165527165528165529165530165531165532165533165534165535165536165537165538165539165540165541165542165543165544165545165546165547165548165549165550165551165552165553165554165555165556165557165558165559165560165561165562165563165564165565165566165567165568165569165570165571165572165573165574165575165576165577165578165579165580165581165582165583165584165585165586165587165588165589165590165591165592165593165594165595165596165597165598165599165600165601165602165603165604165605165606165607165608165609165610165611165612165613165614165615165616165617165618165619165620165621165622165623165624165625165626165627165628165629165630165631165632165633165634165635165636165637165638165639165640165641165642165643165644165645165646165647165648165649165650165651165652165653165654165655165656165657165658165659165660165661165662165663165664165665165666165667165668165669165670165671165672165673165674165675165676165677165678165679165680165681165682165683165684165685165686165687165688165689165690165691165692165693165694165695165696165697165698165699165700165701165702165703165704165705165706165707165708165709165710165711165712165713165714165715165716165717165718165719165720165721165722165723165724165725165726165727165728165729165730165731165732165733165734165735165736165737165738165739165740165741165742165743165744165745165746165747165748165749165750165751165752165753165754165755165756165757165758165759165760165761165762165763165764165765165766165767165768165769165770165771165772165773165774165775165776165777165778165779165780165781165782165783165784165785165786165787165788165789165790165791165792165793165794165795165796165797165798165799165800165801165802165803165804165805165806165807165808165809165810165811165812165813165814165815165816165817165818165819165820165821165822165823165824165825165826165827165828165829165830165831165832165833165834165835165836165837165838165839165840165841165842165843165844165845165846165847165848165849165850165851165852165853165854165855165856165857165858165859165860165861165862165863165864165865165866165867165868165869165870165871165872165873165874165875165876165877165878165879165880165881165882165883165884165885165886165887165888165889165890165891165892165893165894165895165896165897165898165899165900165901165902165903165904165905165906165907165908165909165910165911165912165913165914165915165916165917165918165919165920165921165922165923165924165925165926165927165928165929165930165931165932165933165934165935165936165937165938165939165940165941165942165943165944165945165946165947165948165949165950165951165952165953165954165955165956165957165958165959165960165961165962165963165964165965165966165967165968165969165970165971165972165973165974165975165976165977165978165979165980165981165982165983165984165985165986165987165988165989165990165991165992165993165994165995165996165997165998165999166000166001166002166003166004166005166006166007166008166009166010166011166012166013166014166015166016166017166018166019166020166021166022166023166024166025166026166027166028166029166030166031166032166033166034166035166036166037166038166039166040166041166042166043166044166045166046166047166048166049166050166051166052166053166054166055166056166057166058166059166060166061166062166063166064166065166066166067166068166069166070166071166072166073166074166075166076166077166078166079166080166081166082166083166084166085166086166087166088166089166090166091166092166093166094166095166096166097166098166099166100166101166102166103166104166105166106166107166108166109166110166111166112166113166114166115166116166117166118166119166120166121166122166123166124166125166126166127166128166129166130166131166132166133166134166135166136166137166138166139166140166141166142166143166144166145166146166147166148166149166150166151166152166153166154166155166156166157166158166159166160166161166162166163166164166165166166166167166168166169166170166171166172166173166174166175166176166177166178166179166180166181166182166183166184166185166186166187166188166189166190166191166192166193166194166195166196166197166198166199166200166201166202166203166204166205166206166207166208166209166210166211166212166213166214166215166216166217166218166219166220166221166222166223166224166225166226166227166228166229166230166231166232166233166234166235166236166237166238166239166240166241166242166243166244166245166246166247166248166249166250166251166252166253166254166255166256166257166258166259166260166261166262166263166264166265166266166267166268166269166270166271166272166273166274166275166276166277166278166279166280166281166282166283166284166285166286166287166288166289166290166291166292166293166294166295166296166297166298166299166300166301166302166303166304166305166306166307166308166309166310166311166312166313166314166315166316166317166318166319166320166321166322166323166324166325166326166327166328166329166330166331166332166333166334166335166336166337166338166339166340166341166342166343166344166345166346166347166348166349166350166351166352166353166354166355166356166357166358166359166360166361166362166363166364166365166366166367166368166369166370166371166372166373166374166375166376166377166378166379166380166381166382166383166384166385166386166387166388166389166390166391166392166393166394166395166396166397166398166399166400166401166402166403166404166405166406166407166408166409166410166411166412166413166414166415166416166417166418166419166420166421166422166423166424166425166426166427166428166429166430166431166432166433166434166435166436166437166438166439166440166441166442166443166444166445166446166447166448166449166450166451166452166453166454166455166456166457166458166459166460166461166462166463166464166465166466166467166468166469166470166471166472166473166474166475166476166477166478166479166480166481166482166483166484166485166486166487166488166489166490166491166492166493166494166495166496166497166498166499166500166501166502166503166504166505166506166507166508166509166510166511166512166513166514166515166516166517166518166519166520166521166522166523166524166525166526166527166528166529166530166531166532166533166534166535166536166537166538166539166540166541166542166543166544166545166546166547166548166549166550166551166552166553166554166555166556166557166558166559166560166561166562166563166564166565166566166567166568166569166570166571166572166573166574166575166576166577166578166579166580166581166582166583166584166585166586166587166588166589166590166591166592166593166594166595166596166597166598166599166600166601166602166603166604166605166606166607166608166609166610166611166612166613166614166615166616166617166618166619166620166621166622166623166624166625166626166627166628166629166630166631166632166633166634166635166636166637166638166639166640166641166642166643166644166645166646166647166648166649166650166651166652166653166654166655166656166657166658166659166660166661166662166663166664166665166666166667166668166669166670166671166672166673166674166675166676166677166678166679166680166681166682166683166684166685166686166687166688166689166690166691166692166693166694166695166696166697166698166699166700166701166702166703166704166705166706166707166708166709166710166711166712166713166714166715166716166717166718166719166720166721166722166723166724166725166726166727166728166729166730166731166732166733166734166735166736166737166738166739166740166741166742166743166744166745166746166747166748166749166750166751166752166753166754166755166756166757166758166759166760166761166762166763166764166765166766166767166768166769166770166771166772166773166774166775166776166777166778166779166780166781166782166783166784166785166786166787166788166789166790166791166792166793166794166795166796166797166798166799166800166801166802166803166804166805166806166807166808166809166810166811166812166813166814166815166816166817166818166819166820166821166822166823166824166825166826166827166828166829166830166831166832166833166834166835166836166837166838166839166840166841166842166843166844166845166846166847166848166849166850166851166852166853166854166855166856166857166858166859166860166861166862166863166864166865166866166867166868166869166870166871166872166873166874166875166876166877166878166879166880166881166882166883166884166885166886166887166888166889166890166891166892166893166894166895166896166897166898166899166900166901166902166903166904166905166906166907166908166909166910166911166912166913166914166915166916166917166918166919166920166921166922166923166924166925166926166927166928166929166930166931166932166933166934166935166936166937166938166939166940166941166942166943166944166945166946166947166948166949166950166951166952166953166954166955166956166957166958166959166960166961166962166963166964166965166966166967166968166969166970166971166972166973166974166975166976166977166978166979166980166981166982166983166984166985166986166987166988166989166990166991166992166993166994166995166996166997166998166999167000167001167002167003167004167005167006167007167008167009167010167011167012167013167014167015167016167017167018167019167020167021167022167023167024167025167026167027167028167029167030167031167032167033167034167035167036167037167038167039167040167041167042167043167044167045167046167047167048167049167050167051167052167053167054167055167056167057167058167059167060167061167062167063167064167065167066167067167068167069167070167071167072167073167074167075167076167077167078167079167080167081167082167083167084167085167086167087167088167089167090167091167092167093167094167095167096167097167098167099167100167101167102167103167104167105167106167107167108167109167110167111167112167113167114167115167116167117167118167119167120167121167122167123167124167125167126167127167128167129167130167131167132167133167134167135167136167137167138167139167140167141167142167143167144167145167146167147167148167149167150167151167152167153167154167155167156167157167158167159167160167161167162167163167164167165167166167167167168167169167170167171167172167173167174167175167176167177167178167179167180167181167182167183167184167185167186167187167188167189167190167191167192167193167194167195167196167197167198167199167200167201167202167203167204167205167206167207167208167209167210167211167212167213167214167215167216167217167218167219167220167221167222167223167224167225167226167227167228167229167230167231167232167233167234167235167236167237167238167239167240167241167242167243167244167245167246167247167248167249167250167251167252167253167254167255167256167257167258167259167260167261167262167263167264167265167266167267167268167269167270167271167272167273167274167275167276167277167278167279167280167281167282167283167284167285167286167287167288167289167290167291167292167293167294167295167296167297167298167299167300167301167302167303167304167305167306167307167308167309167310167311167312167313167314167315167316167317167318167319167320167321167322167323167324167325167326167327167328167329167330167331167332167333167334167335167336167337167338167339167340167341167342167343167344167345167346167347167348167349167350167351167352167353167354167355167356167357167358167359167360167361167362167363167364167365167366167367167368167369167370167371167372167373167374167375167376167377167378167379167380167381167382167383167384167385167386167387167388167389167390167391167392167393167394167395167396167397167398167399167400167401167402167403167404167405167406167407167408167409167410167411167412167413167414167415167416167417167418167419167420167421167422167423167424167425167426167427167428167429167430167431167432167433167434167435167436167437167438167439167440167441167442167443167444167445167446167447167448167449167450167451167452167453167454167455167456167457167458167459167460167461167462167463167464167465167466167467167468167469167470167471167472167473167474167475167476167477167478167479167480167481167482167483167484167485167486167487167488167489167490167491167492167493167494167495167496167497167498167499167500167501167502167503167504167505167506167507167508167509167510167511167512167513167514167515167516167517167518167519167520167521167522167523167524167525167526167527167528167529167530167531167532167533167534167535167536167537167538167539167540167541167542167543167544167545167546167547167548167549167550167551167552167553167554167555167556167557167558167559167560167561167562167563167564167565167566167567167568167569167570167571167572167573167574167575167576167577167578167579167580167581167582167583167584167585167586167587167588167589167590167591167592167593167594167595167596167597167598167599167600167601167602167603167604167605167606167607167608167609167610167611167612167613167614167615167616167617167618167619167620167621167622167623167624167625167626167627167628167629167630167631167632167633167634167635167636167637167638167639167640167641167642167643167644167645167646167647167648167649167650167651167652167653167654167655167656167657167658167659167660167661167662167663167664167665167666167667167668167669167670167671167672167673167674167675167676167677167678167679167680167681167682167683167684167685167686167687167688167689167690167691167692167693167694167695167696167697167698167699167700167701167702167703167704167705167706167707167708167709167710167711167712167713167714167715167716167717167718167719167720167721167722167723167724167725167726167727167728167729167730167731167732167733167734167735167736167737167738167739167740167741167742167743167744167745167746167747167748167749167750167751167752167753167754167755167756167757167758167759167760167761167762167763167764167765167766167767167768167769167770167771167772167773167774167775167776167777167778167779167780167781167782167783167784167785167786167787167788167789167790167791167792167793167794167795167796167797167798167799167800167801167802167803167804167805167806167807167808167809167810167811167812167813167814167815167816167817167818167819167820167821167822167823167824167825167826167827167828167829167830167831167832167833167834167835167836167837167838167839167840167841167842167843167844167845167846167847167848167849167850167851167852167853167854167855167856167857167858167859167860167861167862167863167864167865167866167867167868167869167870167871167872167873167874167875167876167877167878167879167880167881167882167883167884167885167886167887167888167889167890167891167892167893167894167895167896167897167898167899167900167901167902167903167904167905167906167907167908167909167910167911167912167913167914167915167916167917167918167919167920167921167922167923167924167925167926167927167928167929167930167931167932167933167934167935167936167937167938167939167940167941167942167943167944167945167946167947167948167949167950167951167952167953167954167955167956167957167958167959167960167961167962167963167964167965167966167967167968167969167970167971167972167973167974167975167976167977167978167979167980167981167982167983167984167985167986167987167988167989167990167991167992167993167994167995167996167997167998167999168000168001168002168003168004168005168006168007168008168009168010168011168012168013168014168015168016168017168018168019168020168021168022168023168024168025168026168027168028168029168030168031168032168033168034168035168036168037168038168039168040168041168042168043168044168045168046168047168048168049168050168051168052168053168054168055168056168057168058168059168060168061168062168063168064168065168066168067168068168069168070168071168072168073168074168075168076168077168078168079168080168081168082168083168084168085168086168087168088168089168090168091168092168093168094168095168096168097168098168099168100168101168102168103168104168105168106168107168108168109168110168111168112168113168114168115168116168117168118168119168120168121168122168123168124168125168126168127168128168129168130168131168132168133168134168135168136168137168138168139168140168141168142168143168144168145168146168147168148168149168150168151168152168153168154168155168156168157168158168159168160168161168162168163168164168165168166168167168168168169168170168171168172168173168174168175168176168177168178168179168180168181168182168183168184168185168186168187168188168189168190168191168192168193168194168195168196168197168198168199168200168201168202168203168204168205168206168207168208168209168210168211168212168213168214168215168216168217168218168219168220168221168222168223168224168225168226168227168228168229168230168231168232168233168234168235168236168237168238168239168240168241168242168243168244168245168246168247168248168249168250168251168252168253168254168255168256168257168258168259168260168261168262168263168264168265168266168267168268168269168270168271168272168273168274168275168276168277168278168279168280168281168282168283168284168285168286168287168288168289168290168291168292168293168294168295168296168297168298168299168300168301168302168303168304168305168306168307168308168309168310168311168312168313168314168315168316168317168318168319168320168321168322168323168324168325168326168327168328168329168330168331168332168333168334168335168336168337168338168339168340168341168342168343168344168345168346168347168348168349168350168351168352168353168354168355168356168357168358168359168360168361168362168363168364168365168366168367168368168369168370168371168372168373168374168375168376168377168378168379168380168381168382168383168384168385168386168387168388168389168390168391168392168393168394168395168396168397168398168399168400168401168402168403168404168405168406168407168408168409168410168411168412168413168414168415168416168417168418168419168420168421168422168423168424168425168426168427168428168429168430168431168432168433168434168435168436168437168438168439168440168441168442168443168444168445168446168447168448168449168450168451168452168453168454168455168456168457168458168459168460168461168462168463168464168465168466168467168468168469168470168471168472168473168474168475168476168477168478168479168480168481168482168483168484168485168486168487168488168489168490168491168492168493168494168495168496168497168498168499168500168501168502168503168504168505168506168507168508168509168510168511168512168513168514168515168516168517168518168519168520168521168522168523168524168525168526168527168528168529168530168531168532168533168534168535168536168537168538168539168540168541168542168543168544168545168546168547168548168549168550168551168552168553168554168555168556168557168558168559168560168561168562168563168564168565168566168567168568168569168570168571168572168573168574168575168576168577168578168579168580168581168582168583168584168585168586168587168588168589168590168591168592168593168594168595168596168597168598168599168600168601168602168603168604168605168606168607168608168609168610168611168612168613168614168615168616168617168618168619168620168621168622168623168624168625168626168627168628168629168630168631168632168633168634168635168636168637168638168639168640168641168642168643168644168645168646168647168648168649168650168651168652168653168654168655168656168657168658168659168660168661168662168663168664168665168666168667168668168669168670168671168672168673168674168675168676168677168678168679168680168681168682168683168684168685168686168687168688168689168690168691168692168693168694168695168696168697168698168699168700168701168702168703168704168705168706168707168708168709168710168711168712168713168714168715168716168717168718168719168720168721168722168723168724168725168726168727168728168729168730168731168732168733168734168735168736168737168738168739168740168741168742168743168744168745168746168747168748168749168750168751168752168753168754168755168756168757168758168759168760168761168762168763168764168765168766168767168768168769168770168771168772168773168774168775168776168777168778168779168780168781168782168783168784168785168786168787168788168789168790168791168792168793168794168795168796168797168798168799168800168801168802168803168804168805168806168807168808168809168810168811168812168813168814168815168816168817168818168819168820168821168822168823168824168825168826168827168828168829168830168831168832168833168834168835168836168837168838168839168840168841168842168843168844168845168846168847168848168849168850168851168852168853168854168855168856168857168858168859168860168861168862168863168864168865168866168867168868168869168870168871168872168873168874168875168876168877168878168879168880168881168882168883168884168885168886168887168888168889168890168891168892168893168894168895168896168897168898168899168900168901168902168903168904168905168906168907168908168909168910168911168912168913168914168915168916168917168918168919168920168921168922168923168924168925168926168927168928168929168930168931168932168933168934168935168936168937168938168939168940168941168942168943168944168945168946168947168948168949168950168951168952168953168954168955168956168957168958168959168960168961168962168963168964168965168966168967168968168969168970168971168972168973168974168975168976168977168978168979168980168981168982168983168984168985168986168987168988168989168990168991168992168993168994168995168996168997168998168999169000169001169002169003169004169005169006169007169008169009169010169011169012169013169014169015169016169017169018169019169020169021169022169023169024169025169026169027169028169029169030169031169032169033169034169035169036169037169038169039169040169041169042169043169044169045169046169047169048169049169050169051169052169053169054169055169056169057169058169059169060169061169062169063169064169065169066169067169068169069169070169071169072169073169074169075169076169077169078169079169080169081169082169083169084169085169086169087169088169089169090169091169092169093169094169095169096169097169098169099169100169101169102169103169104169105169106169107169108169109169110169111169112169113169114169115169116169117169118169119169120169121169122169123169124169125169126169127169128169129169130169131169132169133169134169135169136169137169138169139169140169141169142169143169144169145169146169147169148169149169150169151169152169153169154169155169156169157169158169159169160169161169162169163169164169165169166169167169168169169169170169171169172169173169174169175169176169177169178169179169180169181169182169183169184169185169186169187169188169189169190169191169192169193169194169195169196169197169198169199169200169201169202169203169204169205169206169207169208169209169210169211169212169213169214169215169216169217169218169219169220169221169222169223169224169225169226169227169228169229169230169231169232169233169234169235169236169237169238169239169240169241169242169243169244169245169246169247169248169249169250169251169252169253169254169255169256169257169258169259169260169261169262169263169264169265169266169267169268169269169270169271169272169273169274169275169276169277169278169279169280169281169282169283169284169285169286169287169288169289169290169291169292169293169294169295169296169297169298169299169300169301169302169303169304169305169306169307169308169309169310169311169312169313169314169315169316169317169318169319169320169321169322169323169324169325169326169327169328169329169330169331169332169333169334169335169336169337169338169339169340169341169342169343169344169345169346169347169348169349169350169351169352169353169354169355169356169357169358169359169360169361169362169363169364169365169366169367169368169369169370169371169372169373169374169375169376169377169378169379169380169381169382169383169384169385169386169387169388169389169390169391169392169393169394169395169396169397169398169399169400169401169402169403169404169405169406169407169408169409169410169411169412169413169414169415169416169417169418169419169420169421169422169423169424169425169426169427169428169429169430169431169432169433169434169435169436169437169438169439169440169441169442169443169444169445169446169447169448169449169450169451169452169453169454169455169456169457169458169459169460169461169462169463169464169465169466169467169468169469169470169471169472169473169474169475169476169477169478169479169480169481169482169483169484169485169486169487169488169489169490169491169492169493169494169495169496169497169498169499169500169501169502169503169504169505169506169507169508169509169510169511169512169513169514169515169516169517169518169519169520169521169522169523169524169525169526169527169528169529169530169531169532169533169534169535169536169537169538169539169540169541169542169543169544169545169546169547169548169549169550169551169552169553169554169555169556169557169558169559169560169561169562169563169564169565169566169567169568169569169570169571169572169573169574169575169576169577169578169579169580169581169582169583169584169585169586169587169588169589169590169591169592169593169594169595169596169597169598169599169600169601169602169603169604169605169606169607169608169609169610169611169612169613169614169615169616169617169618169619169620169621169622169623169624169625169626169627169628169629169630169631169632169633169634169635169636169637169638169639169640169641169642169643169644169645169646169647169648169649169650169651169652169653169654169655169656169657169658169659169660169661169662169663169664169665169666169667169668169669169670169671169672169673169674169675169676169677169678169679169680169681169682169683169684169685169686169687169688169689169690169691169692169693169694169695169696169697169698169699169700169701169702169703169704169705169706169707169708169709169710169711169712169713169714169715169716169717169718169719169720169721169722169723169724169725169726169727169728169729169730169731169732169733169734169735169736169737169738169739169740169741169742169743169744169745169746169747169748169749169750169751169752169753169754169755169756169757169758169759169760169761169762169763169764169765169766169767169768169769169770169771169772169773169774169775169776169777169778169779169780169781169782169783169784169785169786169787169788169789169790169791169792169793169794169795169796169797169798169799169800169801169802169803169804169805169806169807169808169809169810169811169812169813169814169815169816169817169818169819169820169821169822169823169824169825169826169827169828169829169830169831169832169833169834169835169836169837169838169839169840169841169842169843169844169845169846169847169848169849169850169851169852169853169854169855169856169857169858169859169860169861169862169863169864169865169866169867169868169869169870169871169872169873169874169875169876169877169878169879169880169881169882169883169884169885169886169887169888169889169890169891169892169893169894169895169896169897169898169899169900169901169902169903169904169905169906169907169908169909169910169911169912169913169914169915169916169917169918169919169920169921169922169923169924169925169926169927169928169929169930169931169932169933169934169935169936169937169938169939169940169941169942169943169944169945169946169947169948169949169950169951169952169953169954169955169956169957169958169959169960169961169962169963169964169965169966169967169968169969169970169971169972169973169974169975169976169977169978169979169980169981169982169983169984169985169986169987169988169989169990169991169992169993169994169995169996169997169998169999170000170001170002170003170004170005170006170007170008170009170010170011170012170013170014170015170016170017170018170019170020170021170022170023170024170025170026170027170028170029170030170031170032170033170034170035170036170037170038170039170040170041170042170043170044170045170046170047170048170049170050170051170052170053170054170055170056170057170058170059170060170061170062170063170064170065170066170067170068170069170070170071170072170073170074170075170076170077170078170079170080170081170082170083170084170085170086170087170088170089170090170091170092170093170094170095170096170097170098170099170100170101170102170103170104170105170106170107170108170109170110170111170112170113170114170115170116170117170118170119170120170121170122170123170124170125170126170127170128170129170130170131170132170133170134170135170136170137170138170139170140170141170142170143170144170145170146170147170148170149170150170151170152170153170154170155170156170157170158170159170160170161170162170163170164170165170166170167170168170169170170170171170172170173170174170175170176170177170178170179170180170181170182170183170184170185170186170187170188170189170190170191170192170193170194170195170196170197170198170199170200170201170202170203170204170205170206170207170208170209170210170211170212170213170214170215170216170217170218170219170220170221170222170223170224170225170226170227170228170229170230170231170232170233170234170235170236170237170238170239170240170241170242170243170244170245170246170247170248170249170250170251170252170253170254170255170256170257170258170259170260170261170262170263170264170265170266170267170268170269170270170271170272170273170274170275170276170277170278170279170280170281170282170283170284170285170286170287170288170289170290170291170292170293170294170295170296170297170298170299170300170301170302170303170304170305170306170307170308170309170310170311170312170313170314170315170316170317170318170319170320170321170322170323170324170325170326170327170328170329170330170331170332170333170334170335170336170337170338170339170340170341170342170343170344170345170346170347170348170349170350170351170352170353170354170355170356170357170358170359170360170361170362170363170364170365170366170367170368170369170370170371170372170373170374170375170376170377170378170379170380170381170382170383170384170385170386170387170388170389170390170391170392170393170394170395170396170397170398170399170400170401170402170403170404170405170406170407170408170409170410170411170412170413170414170415170416170417170418170419170420170421170422170423170424170425170426170427170428170429170430170431170432170433170434170435170436170437170438170439170440170441170442170443170444170445170446170447170448170449170450170451170452170453170454170455170456170457170458170459170460170461170462170463170464170465170466170467170468170469170470170471170472170473170474170475170476170477170478170479170480170481170482170483170484170485170486170487170488170489170490170491170492170493170494170495170496170497170498170499170500170501170502170503170504170505170506170507170508170509170510170511170512170513170514170515170516170517170518170519170520170521170522170523170524170525170526170527170528170529170530170531170532170533170534170535170536170537170538170539170540170541170542170543170544170545170546170547170548170549170550170551170552170553170554170555170556170557170558170559170560170561170562170563170564170565170566170567170568170569170570170571170572170573170574170575170576170577170578170579170580170581170582170583170584170585170586170587170588170589170590170591170592170593170594170595170596170597170598170599170600170601170602170603170604170605170606170607170608170609170610170611170612170613170614170615170616170617170618170619170620170621170622170623170624170625170626170627170628170629170630170631170632170633170634170635170636170637170638170639170640170641170642170643170644170645170646170647170648170649170650170651170652170653170654170655170656170657170658170659170660170661170662170663170664170665170666170667170668170669170670170671170672170673170674170675170676170677170678170679170680170681170682170683170684170685170686170687170688170689170690170691170692170693170694170695170696170697170698170699170700170701170702170703170704170705170706170707170708170709170710170711170712170713170714170715170716170717170718170719170720170721170722170723170724170725170726170727170728170729170730170731170732170733170734170735170736170737170738170739170740170741170742170743170744170745170746170747170748170749170750170751170752170753170754170755170756170757170758170759170760170761170762170763170764170765170766170767170768170769170770170771170772170773170774170775170776170777170778170779170780170781170782170783170784170785170786170787170788170789170790170791170792170793170794170795170796170797170798170799170800170801170802170803170804170805170806170807170808170809170810170811170812170813170814170815170816170817170818170819170820170821170822170823170824170825170826170827170828170829170830170831170832170833170834170835170836170837170838170839170840170841170842170843170844170845170846170847170848170849170850170851170852170853170854170855170856170857170858170859170860170861170862170863170864170865170866170867170868170869170870170871170872170873170874170875170876170877170878170879170880170881170882170883170884170885170886170887170888170889170890170891170892170893170894170895170896170897170898170899170900170901170902170903170904170905170906170907170908170909170910170911170912170913170914170915170916170917170918170919170920170921170922170923170924170925170926170927170928170929170930170931170932170933170934170935170936170937170938170939170940170941170942170943170944170945170946170947170948170949170950170951170952170953170954170955170956170957170958170959170960170961170962170963170964170965170966170967170968170969170970170971170972170973170974170975170976170977170978170979170980170981170982170983170984170985170986170987170988170989170990170991170992170993170994170995170996170997170998170999171000171001171002171003171004171005171006171007171008171009171010171011171012171013171014171015171016171017171018171019171020171021171022171023171024171025171026171027171028171029171030171031171032171033171034171035171036171037171038171039171040171041171042171043171044171045171046171047171048171049171050171051171052171053171054171055171056171057171058171059171060171061171062171063171064171065171066171067171068171069171070171071171072171073171074171075171076171077171078171079171080171081171082171083171084171085171086171087171088171089171090171091171092171093171094171095171096171097171098171099171100171101171102171103171104171105171106171107171108171109171110171111171112171113171114171115171116171117171118171119171120171121171122171123171124171125171126171127171128171129171130171131171132171133171134171135171136171137171138171139171140171141171142171143171144171145171146171147171148171149171150171151171152171153171154171155171156171157171158171159171160171161171162171163171164171165171166171167171168171169171170171171171172171173171174171175171176171177171178171179171180171181171182171183171184171185171186171187171188171189171190171191171192171193171194171195171196171197171198171199171200171201171202171203171204171205171206171207171208171209171210171211171212171213171214171215171216171217171218171219171220171221171222171223171224171225171226171227171228171229171230171231171232171233171234171235171236171237171238171239171240171241171242171243171244171245171246171247171248171249171250171251171252171253171254171255171256171257171258171259171260171261171262171263171264171265171266171267171268171269171270171271171272171273171274171275171276171277171278171279171280171281171282171283171284171285171286171287171288171289171290171291171292171293171294171295171296171297171298171299171300171301171302171303171304171305171306171307171308171309171310171311171312171313171314171315171316171317171318171319171320171321171322171323171324171325171326171327171328171329171330171331171332171333171334171335171336171337171338171339171340171341171342171343171344171345171346171347171348171349171350171351171352171353171354171355171356171357171358171359171360171361171362171363171364171365171366171367171368171369171370171371171372171373171374171375171376171377171378171379171380171381171382171383171384171385171386171387171388171389171390171391171392171393171394171395171396171397171398171399171400171401171402171403171404171405171406171407171408171409171410171411171412171413171414171415171416171417171418171419171420171421171422171423171424171425171426171427171428171429171430171431171432171433171434171435171436171437171438171439171440171441171442171443171444171445171446171447171448171449171450171451171452171453171454171455171456171457171458171459171460171461171462171463171464171465171466171467171468171469171470171471171472171473171474171475171476171477171478171479171480171481171482171483171484171485171486171487171488171489171490171491171492171493171494171495171496171497171498171499171500171501171502171503171504171505171506171507171508171509171510171511171512171513171514171515171516171517171518171519171520171521171522171523171524171525171526171527171528171529171530171531171532171533171534171535171536171537171538171539171540171541171542171543171544171545171546171547171548171549171550171551171552171553171554171555171556171557171558171559171560171561171562171563171564171565171566171567171568171569171570171571171572171573171574171575171576171577171578171579171580171581171582171583171584171585171586171587171588171589171590171591171592171593171594171595171596171597171598171599171600171601171602171603171604171605171606171607171608171609171610171611171612171613171614171615171616171617171618171619171620171621171622171623171624171625171626171627171628171629171630171631171632171633171634171635171636171637171638171639171640171641171642171643171644171645171646171647171648171649171650171651171652171653171654171655171656171657171658171659171660171661171662171663171664171665171666171667171668171669171670171671171672171673171674171675171676171677171678171679171680171681171682171683171684171685171686171687171688171689171690171691171692171693171694171695171696171697171698171699171700171701171702171703171704171705171706171707171708171709171710171711171712171713171714171715171716171717171718171719171720171721171722171723171724171725171726171727171728171729171730171731171732171733171734171735171736171737171738171739171740171741171742171743171744171745171746171747171748171749171750171751171752171753171754171755171756171757171758171759171760171761171762171763171764171765171766171767171768171769171770171771171772171773171774171775171776171777171778171779171780171781171782171783171784171785171786171787171788171789171790171791171792171793171794171795171796171797171798171799171800171801171802171803171804171805171806171807171808171809171810171811171812171813171814171815171816171817171818171819171820171821171822171823171824171825171826171827171828171829171830171831171832171833171834171835171836171837171838171839171840171841171842171843171844171845171846171847171848171849171850171851171852171853171854171855171856171857171858171859171860171861171862171863171864171865171866171867171868171869171870171871171872171873171874171875171876171877171878171879171880171881171882171883171884171885171886171887171888171889171890171891171892171893171894171895171896171897171898171899171900171901171902171903171904171905171906171907171908171909171910171911171912171913171914171915171916171917171918171919171920171921171922171923171924171925171926171927171928171929171930171931171932171933171934171935171936171937171938171939171940171941171942171943171944171945171946171947171948171949171950171951171952171953171954171955171956171957171958171959171960171961171962171963171964171965171966171967171968171969171970171971171972171973171974171975171976171977171978171979171980171981171982171983171984171985171986171987171988171989171990171991171992171993171994171995171996171997171998171999172000172001172002172003172004172005172006172007172008172009172010172011172012172013172014172015172016172017172018172019172020172021172022172023172024172025172026172027172028172029172030172031172032172033172034172035172036172037172038172039172040172041172042172043172044172045172046172047172048172049172050172051172052172053172054172055172056172057172058172059172060172061172062172063172064172065172066172067172068172069172070172071172072172073172074172075172076172077172078172079172080172081172082172083172084172085172086172087172088172089172090172091172092172093172094172095172096172097172098172099172100172101172102172103172104172105172106172107172108172109172110172111172112172113172114172115172116172117172118172119172120172121172122172123172124172125172126172127172128172129172130172131172132172133172134172135172136172137172138172139172140172141172142172143172144172145172146172147172148172149172150172151172152172153172154172155172156172157172158172159172160172161172162172163172164172165172166172167172168172169172170172171172172172173172174172175172176172177172178172179172180172181172182172183172184172185172186172187172188172189172190172191172192172193172194172195172196172197172198172199172200172201172202172203172204172205172206172207172208172209172210172211172212172213172214172215172216172217172218172219172220172221172222172223172224172225172226172227172228172229172230172231172232172233172234172235172236172237172238172239172240172241172242172243172244172245172246172247172248172249172250172251172252172253172254172255172256172257172258172259172260172261172262172263172264172265172266172267172268172269172270172271172272172273172274172275172276172277172278172279172280172281172282172283172284172285172286172287172288172289172290172291172292172293172294172295172296172297172298172299172300172301172302172303172304172305172306172307172308172309172310172311172312172313172314172315172316172317172318172319172320172321172322172323172324172325172326172327172328172329172330172331172332172333172334172335172336172337172338172339172340172341172342172343172344172345172346172347172348172349172350172351172352172353172354172355172356172357172358172359172360172361172362172363172364172365172366172367172368172369172370172371172372172373172374172375172376172377172378172379172380172381172382172383172384172385172386172387172388172389172390172391172392172393172394172395172396172397172398172399172400172401172402172403172404172405172406172407172408172409172410172411172412172413172414172415172416172417172418172419172420172421172422172423172424172425172426172427172428172429172430172431172432172433172434172435172436172437172438172439172440172441172442172443172444172445172446172447172448172449172450172451172452172453172454172455172456172457172458172459172460172461172462172463172464172465172466172467172468172469172470172471172472172473172474172475172476172477172478172479172480172481172482172483172484172485172486172487172488172489172490172491172492172493172494172495172496172497172498172499172500172501172502172503172504172505172506172507172508172509172510172511172512172513172514172515172516172517172518172519172520172521172522172523172524172525172526172527172528172529172530172531172532172533172534172535172536172537172538172539172540172541172542172543172544172545172546172547172548172549172550172551172552172553172554172555172556172557172558172559172560172561172562172563172564172565172566172567172568172569172570172571172572172573172574172575172576172577172578172579172580172581172582172583172584172585172586172587172588172589172590172591172592172593172594172595172596172597172598172599172600172601172602172603172604172605172606172607172608172609172610172611172612172613172614172615172616172617172618172619172620172621172622172623172624172625172626172627172628172629172630172631172632172633172634172635172636172637172638172639172640172641172642172643172644172645172646172647172648172649172650172651172652172653172654172655172656172657172658172659172660172661172662172663172664172665172666172667172668172669172670172671172672172673172674172675172676172677172678172679172680172681172682172683172684172685172686172687172688172689172690172691172692172693172694172695172696172697172698172699172700172701172702172703172704172705172706172707172708172709172710172711172712172713172714172715172716172717172718172719172720172721172722172723172724172725172726172727172728172729172730172731172732172733172734172735172736172737172738172739172740172741172742172743172744172745172746172747172748172749172750172751172752172753172754172755172756172757172758172759172760172761172762172763172764172765172766172767172768172769172770172771172772172773172774172775172776172777172778172779172780172781172782172783172784172785172786172787172788172789172790172791172792172793172794172795172796172797172798172799172800172801172802172803172804172805172806172807172808172809172810172811172812172813172814172815172816172817172818172819172820172821172822172823172824172825172826172827172828172829172830172831172832172833172834172835172836172837172838172839172840172841172842172843172844172845172846172847172848172849172850172851172852172853172854172855172856172857172858172859172860172861172862172863172864172865172866172867172868172869172870172871172872172873172874172875172876172877172878172879172880172881172882172883172884172885172886172887172888172889172890172891172892172893172894172895172896172897172898172899172900172901172902172903172904172905172906172907172908172909172910172911172912172913172914172915172916172917172918172919172920172921172922172923172924172925172926172927172928172929172930172931172932172933172934172935172936172937172938172939172940172941172942172943172944172945172946172947172948172949172950172951172952172953172954172955172956172957172958172959172960172961172962172963172964172965172966172967172968172969172970172971172972172973172974172975172976172977172978172979172980172981172982172983172984172985172986172987172988172989172990172991172992172993172994172995172996172997172998172999173000173001173002173003173004173005173006173007173008173009173010173011173012173013173014173015173016173017173018173019173020173021173022173023173024173025173026173027173028173029173030173031173032173033173034173035173036173037173038173039173040173041173042173043173044173045173046173047173048173049173050173051173052173053173054173055173056173057173058173059173060173061173062173063173064173065173066173067173068173069173070173071173072173073173074173075173076173077173078173079173080173081173082173083173084173085173086173087173088173089173090173091173092173093173094173095173096173097173098173099173100173101173102173103173104173105173106173107173108173109173110173111173112173113173114173115173116173117173118173119173120173121173122173123173124173125173126173127173128173129173130173131173132173133173134173135173136173137173138173139173140173141173142173143173144173145173146173147173148173149173150173151173152173153173154173155173156173157173158173159173160173161173162173163173164173165173166173167173168173169173170173171173172173173173174173175173176173177173178173179173180173181173182173183173184173185173186173187173188173189173190173191173192173193173194173195173196173197173198173199173200173201173202173203173204173205173206173207173208173209173210173211173212173213173214173215173216173217173218173219173220173221173222173223173224173225173226173227173228173229173230173231173232173233173234173235173236173237173238173239173240173241173242173243173244173245173246173247173248173249173250173251173252173253173254173255173256173257173258173259173260173261173262173263173264173265173266173267173268173269173270173271173272173273173274173275173276173277173278173279173280173281173282173283173284173285173286173287173288173289173290173291173292173293173294173295173296173297173298173299173300173301173302173303173304173305173306173307173308173309173310173311173312173313173314173315173316173317173318173319173320173321173322173323173324173325173326173327173328173329173330173331173332173333173334173335173336173337173338173339173340173341173342173343173344173345173346173347173348173349173350173351173352173353173354173355173356173357173358173359173360173361173362173363173364173365173366173367173368173369173370173371173372173373173374173375173376173377173378173379173380173381173382173383173384173385173386173387173388173389173390173391173392173393173394173395173396173397173398173399173400173401173402173403173404173405173406173407173408173409173410173411173412173413173414173415173416173417173418173419173420173421173422173423173424173425173426173427173428173429173430173431173432173433173434173435173436173437173438173439173440173441173442173443173444173445173446173447173448173449173450173451173452173453173454173455173456173457173458173459173460173461173462173463173464173465173466173467173468173469173470173471173472173473173474173475173476173477173478173479173480173481173482173483173484173485173486173487173488173489173490173491173492173493173494173495173496173497173498173499173500173501173502173503173504173505173506173507173508173509173510173511173512173513173514173515173516173517173518173519173520173521173522173523173524173525173526173527173528173529173530173531173532173533173534173535173536173537173538173539173540173541173542173543173544173545173546173547173548173549173550173551173552173553173554173555173556173557173558173559173560173561173562173563173564173565173566173567173568173569173570173571173572173573173574173575173576173577173578173579173580173581173582173583173584173585173586173587173588173589173590173591173592173593173594173595173596173597173598173599173600173601173602173603173604173605173606173607173608173609173610173611173612173613173614173615173616173617173618173619173620173621173622173623173624173625173626173627173628173629173630173631173632173633173634173635173636173637173638173639173640173641173642173643173644173645173646173647173648173649173650173651173652173653173654173655173656173657173658173659173660173661173662173663173664173665173666173667173668173669173670173671173672173673173674173675173676173677173678173679173680173681173682173683173684173685173686173687173688173689173690173691173692173693173694173695173696173697173698173699173700173701173702173703173704173705173706173707173708173709173710173711173712173713173714173715173716173717173718173719173720173721173722173723173724173725173726173727173728173729173730173731173732173733173734173735173736173737173738173739173740173741173742173743173744173745173746173747173748173749173750173751173752173753173754173755173756173757173758173759173760173761173762173763173764173765173766173767173768173769173770173771173772173773173774173775173776173777173778173779173780173781173782173783173784173785173786173787173788173789173790173791173792173793173794173795173796173797173798173799173800173801173802173803173804173805173806173807173808173809173810173811173812173813173814173815173816173817173818173819173820173821173822173823173824173825173826173827173828173829173830173831173832173833173834173835173836173837173838173839173840173841173842173843173844173845173846173847173848173849173850173851173852173853173854173855173856173857173858173859173860173861173862173863173864173865173866173867173868173869173870173871173872173873173874173875173876173877173878173879173880173881173882173883173884173885173886173887173888173889173890173891173892173893173894173895173896173897173898173899173900173901173902173903173904173905173906173907173908173909173910173911173912173913173914173915173916173917173918173919173920173921173922173923173924173925173926173927173928173929173930173931173932173933173934173935173936173937173938173939173940173941173942173943173944173945173946173947173948173949173950173951173952173953173954173955173956173957173958173959173960173961173962173963173964173965173966173967173968173969173970173971173972173973173974173975173976173977173978173979173980173981173982173983173984173985173986173987173988173989173990173991173992173993173994173995173996173997173998173999174000174001174002174003174004174005174006174007174008174009174010174011174012174013174014174015174016174017174018174019174020174021174022174023174024174025174026174027174028174029174030174031174032174033174034174035174036174037174038174039174040174041174042174043174044174045174046174047174048174049174050174051174052174053174054174055174056174057174058174059174060174061174062174063174064174065174066174067174068174069174070174071174072174073174074174075174076174077174078174079174080174081174082174083174084174085174086174087174088174089174090174091174092174093174094174095174096174097174098174099174100174101174102174103174104174105174106174107174108174109174110174111174112174113174114174115174116174117174118174119174120174121174122174123174124174125174126174127174128174129174130174131174132174133174134174135174136174137174138174139174140174141174142174143174144174145174146174147174148174149174150174151174152174153174154174155174156174157174158174159174160174161174162174163174164174165174166174167174168174169174170174171174172174173174174174175174176174177174178174179174180174181174182174183174184174185174186174187174188174189174190174191174192174193174194174195174196174197174198174199174200174201174202174203174204174205174206174207174208174209174210174211174212174213174214174215174216174217174218174219174220174221174222174223174224174225174226174227174228174229174230174231174232174233174234174235174236174237174238174239174240174241174242174243174244174245174246174247174248174249174250174251174252174253174254174255174256174257174258174259174260174261174262174263174264174265174266174267174268174269174270174271174272174273174274174275174276174277174278174279174280174281174282174283174284174285174286174287174288174289174290174291174292174293174294174295174296174297174298174299174300174301174302174303174304174305174306174307174308174309174310174311174312174313174314174315174316174317174318174319174320174321174322174323174324174325174326174327174328174329174330174331174332174333174334174335174336174337174338174339174340174341174342174343174344174345174346174347174348174349174350174351174352174353174354174355174356174357174358174359174360174361174362174363174364174365174366174367174368174369174370174371174372174373174374174375174376174377174378174379174380174381174382174383174384174385174386174387174388174389174390174391174392174393174394174395174396174397174398174399174400174401174402174403174404174405174406174407174408174409174410174411174412174413174414174415174416174417174418174419174420174421174422174423174424174425174426174427174428174429174430174431174432174433174434174435174436174437174438174439174440174441174442174443174444174445174446174447174448174449174450174451174452174453174454174455174456174457174458174459174460174461174462174463174464174465174466174467174468174469174470174471174472174473174474174475174476174477174478174479174480174481174482174483174484174485174486174487174488174489174490174491174492174493174494174495174496174497174498174499174500174501174502174503174504174505174506174507174508174509174510174511174512174513174514174515174516174517174518174519174520174521174522174523174524174525174526174527174528174529174530174531174532174533174534174535174536174537174538174539174540174541174542174543174544174545174546174547174548174549174550174551174552174553174554174555174556174557174558174559174560174561174562174563174564174565174566174567174568174569174570174571174572174573174574174575174576174577174578174579174580174581174582174583174584174585174586174587174588174589174590174591174592174593174594174595174596174597174598174599174600174601174602174603174604174605174606174607174608174609174610174611174612174613174614174615174616174617174618174619174620174621174622174623174624174625174626174627174628174629174630174631174632174633174634174635174636174637174638174639174640174641174642174643174644174645174646174647174648174649174650174651174652174653174654174655174656174657174658174659174660174661174662174663174664174665174666174667174668174669174670174671174672174673174674174675174676174677174678174679174680174681174682174683174684174685174686174687174688174689174690174691174692174693174694174695174696174697174698174699174700174701174702174703174704174705174706174707174708174709174710174711174712174713174714174715174716174717174718174719174720174721174722174723174724174725174726174727174728174729174730174731174732174733174734174735174736174737174738174739174740174741174742174743174744174745174746174747174748174749174750174751174752174753174754174755174756174757174758174759174760174761174762174763174764174765174766174767174768174769174770174771174772174773174774174775174776174777174778174779174780174781174782174783174784174785174786174787174788174789174790174791174792174793174794174795174796174797174798174799174800174801174802174803174804174805174806174807174808174809174810174811174812174813174814174815174816174817174818174819174820174821174822174823174824174825174826174827174828174829174830174831174832174833174834174835174836174837174838174839174840174841174842174843174844174845174846174847174848174849174850174851174852174853174854174855174856174857174858174859174860174861174862174863174864174865174866174867174868174869174870174871174872174873174874174875174876174877174878174879174880174881174882174883174884174885174886174887174888174889174890174891174892174893174894174895174896174897174898174899174900174901174902174903174904174905174906174907174908174909174910174911174912174913174914174915174916174917174918174919174920174921174922174923174924174925174926174927174928174929174930174931174932174933174934174935174936174937174938174939174940174941174942174943174944174945174946174947174948174949174950174951174952174953174954174955174956174957174958174959174960174961174962174963174964174965174966174967174968174969174970174971174972174973174974174975174976174977174978174979174980174981174982174983174984174985174986174987174988174989174990174991174992174993174994174995174996174997174998174999175000175001175002175003175004175005175006175007175008175009175010175011175012175013175014175015175016175017175018175019175020175021175022175023175024175025175026175027175028175029175030175031175032175033175034175035175036175037175038175039175040175041175042175043175044175045175046175047175048175049175050175051175052175053175054175055175056175057175058175059175060175061175062175063175064175065175066175067175068175069175070175071175072175073175074175075175076175077175078175079175080175081175082175083175084175085175086175087175088175089175090175091175092175093175094175095175096175097175098175099175100175101175102175103175104175105175106175107175108175109175110175111175112175113175114175115175116175117175118175119175120175121175122175123175124175125175126175127175128175129175130175131175132175133175134175135175136175137175138175139175140175141175142175143175144175145175146175147175148175149175150175151175152175153175154175155175156175157175158175159175160175161175162175163175164175165175166175167175168175169175170175171175172175173175174175175175176175177175178175179175180175181175182175183175184175185175186175187175188175189175190175191175192175193175194175195175196175197175198175199175200175201175202175203175204175205175206175207175208175209175210175211175212175213175214175215175216175217175218175219175220175221175222175223175224175225175226175227175228175229175230175231175232175233175234175235175236175237175238175239175240175241175242175243175244175245175246175247175248175249175250175251175252175253175254175255175256175257175258175259175260175261175262175263175264175265175266175267175268175269175270175271175272175273175274175275175276175277175278175279175280175281175282175283175284175285175286175287175288175289175290175291175292175293175294175295175296175297175298175299175300175301175302175303175304175305175306175307175308175309175310175311175312175313175314175315175316175317175318175319175320175321175322175323175324175325175326175327175328175329175330175331175332175333175334175335175336175337175338175339175340175341175342175343175344175345175346175347175348175349175350175351175352175353175354175355175356175357175358175359175360175361175362175363175364175365175366175367175368175369175370175371175372175373175374175375175376175377175378175379175380175381175382175383175384175385175386175387175388175389175390175391175392175393175394175395175396175397175398175399175400175401175402175403175404175405175406175407175408175409175410175411175412175413175414175415175416175417175418175419175420175421175422175423175424175425175426175427175428175429175430175431175432175433175434175435175436175437175438175439175440175441175442175443175444175445175446175447175448175449175450175451175452175453175454175455175456175457175458175459175460175461175462175463175464175465175466175467175468175469175470175471175472175473175474175475175476175477175478175479175480175481175482175483175484175485175486175487175488175489175490175491175492175493175494175495175496175497175498175499175500175501175502175503175504175505175506175507175508175509175510175511175512175513175514175515175516175517175518175519175520175521175522175523175524175525175526175527175528175529175530175531175532175533175534175535175536175537175538175539175540175541175542175543175544175545175546175547175548175549175550175551175552175553175554175555175556175557175558175559175560175561175562175563175564175565175566175567175568175569175570175571175572175573175574175575175576175577175578175579175580175581175582175583175584175585175586175587175588175589175590175591175592175593175594175595175596175597175598175599175600175601175602175603175604175605175606175607175608175609175610175611175612175613175614175615175616175617175618175619175620175621175622175623175624175625175626175627175628175629175630175631175632175633175634175635175636175637175638175639175640175641175642175643175644175645175646175647175648175649175650175651175652175653175654175655175656175657175658175659175660175661175662175663175664175665175666175667175668175669175670175671175672175673175674175675175676175677175678175679175680175681175682175683175684175685175686175687175688175689175690175691175692175693175694175695175696175697175698175699175700175701175702175703175704175705175706175707175708175709175710175711175712175713175714175715175716175717175718175719175720175721175722175723175724175725175726175727175728175729175730175731175732175733175734175735175736175737175738175739175740175741175742175743175744175745175746175747175748175749175750175751175752175753175754175755175756175757175758175759175760175761175762175763175764175765175766175767175768175769175770175771175772175773175774175775175776175777175778175779175780175781175782175783175784175785175786175787175788175789175790175791175792175793175794175795175796175797175798175799175800175801175802175803175804175805175806175807175808175809175810175811175812175813175814175815175816175817175818175819175820175821175822175823175824175825175826175827175828175829175830175831175832175833175834175835175836175837175838175839175840175841175842175843175844175845175846175847175848175849175850175851175852175853175854175855175856175857175858175859175860175861175862175863175864175865175866175867175868175869175870175871175872175873175874175875175876175877175878175879175880175881175882175883175884175885175886175887175888175889175890175891175892175893175894175895175896175897175898175899175900175901175902175903175904175905175906175907175908175909175910175911175912175913175914175915175916175917175918175919175920175921175922175923175924175925175926175927175928175929175930175931175932175933175934175935175936175937175938175939175940175941175942175943175944175945175946175947175948175949175950175951175952175953175954175955175956175957175958175959175960175961175962175963175964175965175966175967175968175969175970175971175972175973175974175975175976175977175978175979175980175981175982175983175984175985175986175987175988175989175990175991175992175993175994175995175996175997175998175999176000176001176002176003176004176005176006176007176008176009176010176011176012176013176014176015176016176017176018176019176020176021176022176023176024176025176026176027176028176029176030176031176032176033176034176035176036176037176038176039176040176041176042176043176044176045176046176047176048176049176050176051176052176053176054176055176056176057176058176059176060176061176062176063176064176065176066176067176068176069176070176071176072176073176074176075176076176077176078176079176080176081176082176083176084176085176086176087176088176089176090176091176092176093176094176095176096176097176098176099176100176101176102176103176104176105176106176107176108176109176110176111176112176113176114176115176116176117176118176119176120176121176122176123176124176125176126176127176128176129176130176131176132176133176134176135176136176137176138176139176140176141176142176143176144176145176146176147176148176149176150176151176152176153176154176155176156176157176158176159176160176161176162176163176164176165176166176167176168176169176170176171176172176173176174176175176176176177176178176179176180176181176182176183176184176185176186176187176188176189176190176191176192176193176194176195176196176197176198176199176200176201176202176203176204176205176206176207176208176209176210176211176212176213176214176215176216176217176218176219176220176221176222176223176224176225176226176227176228176229176230176231176232176233176234176235176236176237176238176239176240176241176242176243176244176245176246176247176248176249176250176251176252176253176254176255176256176257176258176259176260176261176262176263176264176265176266176267176268176269176270176271176272176273176274176275176276176277176278176279176280176281176282176283176284176285176286176287176288176289176290176291176292176293176294176295176296176297176298176299176300176301176302176303176304176305176306176307176308176309176310176311176312176313176314176315176316176317176318176319176320176321176322176323176324176325176326176327176328176329176330176331176332176333176334176335176336176337176338176339176340176341176342176343176344176345176346176347176348176349176350176351176352176353176354176355176356176357176358176359176360176361176362176363176364176365176366176367176368176369176370176371176372176373176374176375176376176377176378176379176380176381176382176383176384176385176386176387176388176389176390176391176392176393176394176395176396176397176398176399176400176401176402176403176404176405176406176407176408176409176410176411176412176413176414176415176416176417176418176419176420176421176422176423176424176425176426176427176428176429176430176431176432176433176434176435176436176437176438176439176440176441176442176443176444176445176446176447176448176449176450176451176452176453176454176455176456176457176458176459176460176461176462176463176464176465176466176467176468176469176470176471176472176473176474176475176476176477176478176479176480176481176482176483176484176485176486176487176488176489176490176491176492176493176494176495176496176497176498176499176500176501176502176503176504176505176506176507176508176509176510176511176512176513176514176515176516176517176518176519176520176521176522176523176524176525176526176527176528176529176530176531176532176533176534176535176536176537176538176539176540176541176542176543176544176545176546176547176548176549176550176551176552176553176554176555176556176557176558176559176560176561176562176563176564176565176566176567176568176569176570176571176572176573176574176575176576176577176578176579176580176581176582176583176584176585176586176587176588176589176590176591176592176593176594176595176596176597176598176599176600176601176602176603176604176605176606176607176608176609176610176611176612176613176614176615176616176617176618176619176620176621176622176623176624176625176626176627176628176629176630176631176632176633176634176635176636176637176638176639176640176641176642176643176644176645176646176647176648176649176650176651176652176653176654176655176656176657176658176659176660176661176662176663176664176665176666176667176668176669176670176671176672176673176674176675176676176677176678176679176680176681176682176683176684176685176686176687176688176689176690176691176692176693176694176695176696176697176698176699176700176701176702176703176704176705176706176707176708176709176710176711176712176713176714176715176716176717176718176719176720176721176722176723176724176725176726176727176728176729176730176731176732176733176734176735176736176737176738176739176740176741176742176743176744176745176746176747176748176749176750176751176752176753176754176755176756176757176758176759176760176761176762176763176764176765176766176767176768176769176770176771176772176773176774176775176776176777176778176779176780176781176782176783176784176785176786176787176788176789176790176791176792176793176794176795176796176797176798176799176800176801176802176803176804176805176806176807176808176809176810176811176812176813176814176815176816176817176818176819176820176821176822176823176824176825176826176827176828176829176830176831176832176833176834176835176836176837176838176839176840176841176842176843176844176845176846176847176848176849176850176851176852176853176854176855176856176857176858176859176860176861176862176863176864176865176866176867176868176869176870176871176872176873176874176875176876176877176878176879176880176881176882176883176884176885176886176887176888176889176890176891176892176893176894176895176896176897176898176899176900176901176902176903176904176905176906176907176908176909176910176911176912176913176914176915176916176917176918176919176920176921176922176923176924176925176926176927176928176929176930176931176932176933176934176935176936176937176938176939176940176941176942176943176944176945176946176947176948176949176950176951176952176953176954176955176956176957176958176959176960176961176962176963176964176965176966176967176968176969176970176971176972176973176974176975176976176977176978176979176980176981176982176983176984176985176986176987176988176989176990176991176992176993176994176995176996176997176998176999177000177001177002177003177004177005177006177007177008177009177010177011177012177013177014177015177016177017177018177019177020177021177022177023177024177025177026177027177028177029177030177031177032177033177034177035177036177037177038177039177040177041177042177043177044177045177046177047177048177049177050177051177052177053177054177055177056177057177058177059177060177061177062177063177064177065177066177067177068177069177070177071177072177073177074177075177076177077177078177079177080177081177082177083177084177085177086177087177088177089177090177091177092177093177094177095177096177097177098177099177100177101177102177103177104177105177106177107177108177109177110177111177112177113177114177115177116177117177118177119177120177121177122177123177124177125177126177127177128177129177130177131177132177133177134177135177136177137177138177139177140177141177142177143177144177145177146177147177148177149177150177151177152177153177154177155177156177157177158177159177160177161177162177163177164177165177166177167177168177169177170177171177172177173177174177175177176177177177178177179177180177181177182177183177184177185177186177187177188177189177190177191177192177193177194177195177196177197177198177199177200177201177202177203177204177205177206177207177208177209177210177211177212177213177214177215177216177217177218177219177220177221177222177223177224177225177226177227177228177229177230177231177232177233177234177235177236177237177238177239177240177241177242177243177244177245177246177247177248177249177250177251177252177253177254177255177256177257177258177259177260177261177262177263177264177265177266177267177268177269177270177271177272177273177274177275177276177277177278177279177280177281177282177283177284177285177286177287177288177289177290177291177292177293177294177295177296177297177298177299177300177301177302177303177304177305177306177307177308177309177310177311177312177313177314177315177316177317177318177319177320177321177322177323177324177325177326177327177328177329177330177331177332177333177334177335177336177337177338177339177340177341177342177343177344177345177346177347177348177349177350177351177352177353177354177355177356177357177358177359177360177361177362177363177364177365177366177367177368177369177370177371177372177373177374177375177376177377177378177379177380177381177382177383177384177385177386177387177388177389177390177391177392177393177394177395177396177397177398177399177400177401177402177403177404177405177406177407177408177409177410177411177412177413177414177415177416177417177418177419177420177421177422177423177424177425177426177427177428177429177430177431177432177433177434177435177436177437177438177439177440177441177442177443177444177445177446177447177448177449177450177451177452177453177454177455177456177457177458177459177460177461177462177463177464177465177466177467177468177469177470177471177472177473177474177475177476177477177478177479177480177481177482177483177484177485177486177487177488177489177490177491177492177493177494177495177496177497177498177499177500177501177502177503177504177505177506177507177508177509177510177511177512177513177514177515177516177517177518177519177520177521177522177523177524177525177526177527177528177529177530177531177532177533177534177535177536177537177538177539177540177541177542177543177544177545177546177547177548177549177550177551177552177553177554177555177556177557177558177559177560177561177562177563177564177565177566177567177568177569177570177571177572177573177574177575177576177577177578177579177580177581177582177583177584177585177586177587177588177589177590177591177592177593177594177595177596177597177598177599177600177601177602177603177604177605177606177607177608177609177610177611177612177613177614177615177616177617177618177619177620177621177622177623177624177625177626177627177628177629177630177631177632177633177634177635177636177637177638177639177640177641177642177643177644177645177646177647177648177649177650177651177652177653177654177655177656177657177658177659177660177661177662177663177664177665177666177667177668177669177670177671177672177673177674177675177676177677177678177679177680177681177682177683177684177685177686177687177688177689177690177691177692177693177694177695177696177697177698177699177700177701177702177703177704177705177706177707177708177709177710177711177712177713177714177715177716177717177718177719177720177721177722177723177724177725177726177727177728177729177730177731177732177733177734177735177736177737177738177739177740177741177742177743177744177745177746177747177748177749177750177751177752177753177754177755177756177757177758177759177760177761177762177763177764177765177766177767177768177769177770177771177772177773177774177775177776177777177778177779177780177781177782177783177784177785177786177787177788177789177790177791177792177793177794177795177796177797177798177799177800177801177802177803177804177805177806177807177808177809177810177811177812177813177814177815177816177817177818177819177820177821177822177823177824177825177826177827177828177829177830177831177832177833177834177835177836177837177838177839177840177841177842177843177844177845177846177847177848177849177850177851177852177853177854177855177856177857177858177859177860177861177862177863177864177865177866177867177868177869177870177871177872177873177874177875177876177877177878177879177880177881177882177883177884177885177886177887177888177889177890177891177892177893177894177895177896177897177898177899177900177901177902177903177904177905177906177907177908177909177910177911177912177913177914177915177916177917177918177919177920177921177922177923177924177925177926177927177928177929177930177931177932177933177934177935177936177937177938177939177940177941177942177943177944177945177946177947177948177949177950177951177952177953177954177955177956177957177958177959177960177961177962177963177964177965177966177967177968177969177970177971177972177973177974177975177976177977177978177979177980177981177982177983177984177985177986177987177988177989177990177991177992177993177994177995177996177997177998177999178000178001178002178003178004178005178006178007178008178009178010178011178012178013178014178015178016178017178018178019178020178021178022178023178024178025178026178027178028178029178030178031178032178033178034178035178036178037178038178039178040178041178042178043178044178045178046178047178048178049178050178051178052178053178054178055178056178057178058178059178060178061178062178063178064178065178066178067178068178069178070178071178072178073178074178075178076178077178078178079178080178081178082178083178084178085178086178087178088178089178090178091178092178093178094178095178096178097178098178099178100178101178102178103178104178105178106178107178108178109178110178111178112178113178114178115178116178117178118178119178120178121178122178123178124178125178126178127178128178129178130178131178132178133178134178135178136178137178138178139178140178141178142178143178144178145178146178147178148178149178150178151178152178153178154178155178156178157178158178159178160178161178162178163178164178165178166178167178168178169178170178171178172178173178174178175178176178177178178178179178180178181178182178183178184178185178186178187178188178189178190178191178192178193178194178195178196178197178198178199178200178201178202178203178204178205178206178207178208178209178210178211178212178213178214178215178216178217178218178219178220178221178222178223178224178225178226178227178228178229178230178231178232178233178234178235178236178237178238178239178240178241178242178243178244178245178246178247178248178249178250178251178252178253178254178255178256178257178258178259178260178261178262178263178264178265178266178267178268178269178270178271178272178273178274178275178276178277178278178279178280178281178282178283178284178285178286178287178288178289178290178291178292178293178294178295178296178297178298178299178300178301178302178303178304178305178306178307178308178309178310178311178312178313178314178315178316178317178318178319178320178321178322178323178324178325178326178327178328178329178330178331178332178333178334178335178336178337178338178339178340178341178342178343178344178345178346178347178348178349178350178351178352178353178354178355178356178357178358178359178360178361178362178363178364178365178366178367178368178369178370178371178372178373178374178375178376178377178378178379178380178381178382178383178384178385178386178387178388178389178390178391178392178393178394178395178396178397178398178399178400178401178402178403178404178405178406178407178408178409178410178411178412178413178414178415178416178417178418178419178420178421178422178423178424178425178426178427178428178429178430178431178432178433178434178435178436178437178438178439178440178441178442178443178444178445178446178447178448178449178450178451178452178453178454178455178456178457178458178459178460178461178462178463178464178465178466178467178468178469178470178471178472178473178474178475178476178477178478178479178480178481178482178483178484178485178486178487178488178489178490178491178492178493178494178495178496178497178498178499178500178501178502178503178504178505178506178507178508178509178510178511178512178513178514178515178516178517178518178519178520178521178522178523178524178525178526178527178528178529178530178531178532178533178534178535178536178537178538178539178540178541178542178543178544178545178546178547178548178549178550178551178552178553178554178555178556178557178558178559178560178561178562178563178564178565178566178567178568178569178570178571178572178573178574178575178576178577178578178579178580178581178582178583178584178585178586178587178588178589178590178591178592178593178594178595178596178597178598178599178600178601178602178603178604178605178606178607178608178609178610178611178612178613178614178615178616178617178618178619178620178621178622178623178624178625178626178627178628178629178630178631178632178633178634178635178636178637178638178639178640178641178642178643178644178645178646178647178648178649178650178651178652178653178654178655178656178657178658178659178660178661178662178663178664178665178666178667178668178669178670178671178672178673178674178675178676178677178678178679178680178681178682178683178684178685178686178687178688178689178690178691178692178693178694178695178696178697178698178699178700178701178702178703178704178705178706178707178708178709178710178711178712178713178714178715178716178717178718178719178720178721178722178723178724178725178726178727178728178729178730178731178732178733178734178735178736178737178738178739178740178741178742178743178744178745178746178747178748178749178750178751178752178753178754178755178756178757178758178759178760178761178762178763178764178765178766178767178768178769178770178771178772178773178774178775178776178777178778178779178780178781178782178783178784178785178786178787178788178789178790178791178792178793178794178795178796178797178798178799178800178801178802178803178804178805178806178807178808178809178810178811178812178813178814178815178816178817178818178819178820178821178822178823178824178825178826178827178828178829178830178831178832178833178834178835178836178837178838178839178840178841178842178843178844178845178846178847178848178849178850178851178852178853178854178855178856178857178858178859178860178861178862178863178864178865178866178867178868178869178870178871178872178873178874178875178876178877178878178879178880178881178882178883178884178885178886178887178888178889178890178891178892178893178894178895178896178897178898178899178900178901178902178903178904178905178906178907178908178909178910178911178912178913178914178915178916178917178918178919178920178921178922178923178924178925178926178927178928178929178930178931178932178933178934178935178936178937178938178939178940178941178942178943178944178945178946178947178948178949178950178951178952178953178954178955178956178957178958178959178960178961178962178963178964178965178966178967178968178969178970178971178972178973178974178975178976178977178978178979178980178981178982178983178984178985178986178987178988178989178990178991178992178993178994178995178996178997178998178999179000179001179002179003179004179005179006179007179008179009179010179011179012179013179014179015179016179017179018179019179020179021179022179023179024179025179026179027179028179029179030179031179032179033179034179035179036179037179038179039179040179041179042179043179044179045179046179047179048179049179050179051179052179053179054179055179056179057179058179059179060179061179062179063179064179065179066179067179068179069179070179071179072179073179074179075179076179077179078179079179080179081179082179083179084179085179086179087179088179089179090179091179092179093179094179095179096179097179098179099179100179101179102179103179104179105179106179107179108179109179110179111179112179113179114179115179116179117179118179119179120179121179122179123179124179125179126179127179128179129179130179131179132179133179134179135179136179137179138179139179140179141179142179143179144179145179146179147179148179149179150179151179152179153179154179155179156179157179158179159179160179161179162179163179164179165179166179167179168179169179170179171179172179173179174179175179176179177179178179179179180179181179182179183179184179185179186179187179188179189179190179191179192179193179194179195179196179197179198179199179200179201179202179203179204179205179206179207179208179209179210179211179212179213179214179215179216179217179218179219179220179221179222179223179224179225179226179227179228179229179230179231179232179233179234179235179236179237179238179239179240179241179242179243179244179245179246179247179248179249179250179251179252179253179254179255179256179257179258179259179260179261179262179263179264179265179266179267179268179269179270179271179272179273179274179275179276179277179278179279179280179281179282179283179284179285179286179287179288179289179290179291179292179293179294179295179296179297179298179299179300179301179302179303179304179305179306179307179308179309179310179311179312179313179314179315179316179317179318179319179320179321179322179323179324179325179326179327179328179329179330179331179332179333179334179335179336179337179338179339179340179341179342179343179344179345179346179347179348179349179350179351179352179353179354179355179356179357179358179359179360179361179362179363179364179365179366179367179368179369179370179371179372179373179374179375179376179377179378179379179380179381179382179383179384179385179386179387179388179389179390179391179392179393179394179395179396179397179398179399179400179401179402179403179404179405179406179407179408179409179410179411179412179413179414179415179416179417179418179419179420179421179422179423179424179425179426179427179428179429179430179431179432179433179434179435179436179437179438179439179440179441179442179443179444179445179446179447179448179449179450179451179452179453179454179455179456179457179458179459179460179461179462179463179464179465179466179467179468179469179470179471179472179473179474179475179476179477179478179479179480179481179482179483179484179485179486179487179488179489179490179491179492179493179494179495179496179497179498179499179500179501179502179503179504179505179506179507179508179509179510179511179512179513179514179515179516179517179518179519179520179521179522179523179524179525179526179527179528179529179530179531179532179533179534179535179536179537179538179539179540179541179542179543179544179545179546179547179548179549179550179551179552179553179554179555179556179557179558179559179560179561179562179563179564179565179566179567179568179569179570179571179572179573179574179575179576179577179578179579179580179581179582179583179584179585179586179587179588179589179590179591179592179593179594179595179596179597179598179599179600179601179602179603179604179605179606179607179608179609179610179611179612179613179614179615179616179617179618179619179620179621179622179623179624179625179626179627179628179629179630179631179632179633179634179635179636179637179638179639179640179641179642179643179644179645179646179647179648179649179650179651179652179653179654179655179656179657179658179659179660179661179662179663179664179665179666179667179668179669179670179671179672179673179674179675179676179677179678179679179680179681179682179683179684179685179686179687179688179689179690179691179692179693179694179695179696179697179698179699179700179701179702179703179704179705179706179707179708179709179710179711179712179713179714179715179716179717179718179719179720179721179722179723179724179725179726179727179728179729179730179731179732179733179734179735179736179737179738179739179740179741179742179743179744179745179746179747179748179749179750179751179752179753179754179755179756179757179758179759179760179761179762179763179764179765179766179767179768179769179770179771179772179773179774179775179776179777179778179779179780179781179782179783179784179785179786179787179788179789179790179791179792179793179794179795179796179797179798179799179800179801179802179803179804179805179806179807179808179809179810179811179812179813179814179815179816179817179818179819179820179821179822179823179824179825179826179827179828179829179830179831179832179833179834179835179836179837179838179839179840179841179842179843179844179845179846179847179848179849179850179851179852179853179854179855179856179857179858179859179860179861179862179863179864179865179866179867179868179869179870179871179872179873179874179875179876179877179878179879179880179881179882179883179884179885179886179887179888179889179890179891179892179893179894179895179896179897179898179899179900179901179902179903179904179905179906179907179908179909179910179911179912179913179914179915179916179917179918179919179920179921179922179923179924179925179926179927179928179929179930179931179932179933179934179935179936179937179938179939179940179941179942179943179944179945179946179947179948179949179950179951179952179953179954179955179956179957179958179959179960179961179962179963179964179965179966179967179968179969179970179971179972179973179974179975179976179977179978179979179980179981179982179983179984179985179986179987179988179989179990179991179992179993179994179995179996179997179998179999180000180001180002180003180004180005180006180007180008180009180010180011180012180013180014180015180016180017180018180019180020180021180022180023180024180025180026180027180028180029180030180031180032180033180034180035180036180037180038180039180040180041180042180043180044180045180046180047180048180049180050180051180052180053180054180055180056180057180058180059180060180061180062180063180064180065180066180067180068180069180070180071180072180073180074180075180076180077180078180079180080180081180082180083180084180085180086180087180088180089180090180091180092180093180094180095180096180097180098180099180100180101180102180103180104180105180106180107180108180109180110180111180112180113180114180115180116180117180118180119180120180121180122180123180124180125180126180127180128180129180130180131180132180133180134180135180136180137180138180139180140180141180142180143180144180145180146180147180148180149180150180151180152180153180154180155180156180157180158180159180160180161180162180163180164180165180166180167180168180169180170180171180172180173180174180175180176180177180178180179180180180181180182180183180184180185180186180187180188180189180190180191180192180193180194180195180196180197180198180199180200180201180202180203180204180205180206180207180208180209180210180211180212180213180214180215180216180217180218180219180220180221180222180223180224180225180226180227180228180229180230180231180232180233180234180235180236180237180238180239180240180241180242180243180244180245180246180247180248180249180250180251180252180253180254180255180256180257180258180259180260180261180262180263180264180265180266180267180268180269180270180271180272180273180274180275180276180277180278180279180280180281180282180283180284180285180286180287180288180289180290180291180292180293180294180295180296180297180298180299180300180301180302180303180304180305180306180307180308180309180310180311180312180313180314180315180316180317180318180319180320180321180322180323180324180325180326180327180328180329180330180331180332180333180334180335180336180337180338180339180340180341180342180343180344180345180346180347180348180349180350180351180352180353180354180355180356180357180358180359180360180361180362180363180364180365180366180367180368180369180370180371180372180373180374180375180376180377180378180379180380180381180382180383180384180385180386180387180388180389180390180391180392180393180394180395180396180397180398180399180400180401180402180403180404180405180406180407180408180409180410180411180412180413180414180415180416180417180418180419180420180421180422180423180424180425180426180427180428180429180430180431180432180433180434180435180436180437180438180439180440180441180442180443180444180445180446180447180448180449180450180451180452180453180454180455180456180457180458180459180460180461180462180463180464180465180466180467180468180469180470180471180472180473180474180475180476180477180478180479180480180481180482180483180484180485180486180487180488180489180490180491180492180493180494180495180496180497180498180499180500180501180502180503180504180505180506180507180508180509180510180511180512180513180514180515180516180517180518180519180520180521180522180523180524180525180526180527180528180529180530180531180532180533180534180535180536180537180538180539180540180541180542180543180544180545180546180547180548180549180550180551180552180553180554180555180556180557180558180559180560180561180562180563180564180565180566180567180568180569180570180571180572180573180574180575180576180577180578180579180580180581180582180583180584180585180586180587180588180589180590180591180592180593180594180595180596180597180598180599180600180601180602180603180604180605180606180607180608180609180610180611180612180613180614180615180616180617180618180619180620180621180622180623180624180625180626180627180628180629180630180631180632180633180634180635180636180637180638180639180640180641180642180643180644180645180646180647180648180649180650180651180652180653180654180655180656180657180658180659180660180661180662180663180664180665180666180667180668180669180670180671180672180673180674180675180676180677180678180679180680180681180682180683180684180685180686180687180688180689180690180691180692180693180694180695180696180697180698180699180700180701180702180703180704180705180706180707180708180709180710180711180712180713180714180715180716180717180718180719180720180721180722180723180724180725180726180727180728180729180730180731180732180733180734180735180736180737180738180739180740180741180742180743180744180745180746180747180748180749180750180751180752180753180754180755180756180757180758180759180760180761180762180763180764180765180766180767180768180769180770180771180772180773180774180775180776180777180778180779180780180781180782180783180784180785180786180787180788180789180790180791180792180793180794180795180796180797180798180799180800180801180802180803180804180805180806180807180808180809180810180811180812180813180814180815180816180817180818180819180820180821180822180823180824180825180826180827180828180829180830180831180832180833180834180835180836180837180838180839180840180841180842180843180844180845180846180847180848180849180850180851180852180853180854180855180856180857180858180859180860180861180862180863180864180865180866180867180868180869180870180871180872180873180874180875180876180877180878180879180880180881180882180883180884180885180886180887180888180889180890180891180892180893180894180895180896180897180898180899180900180901180902180903180904180905180906180907180908180909180910180911180912180913180914180915180916180917180918180919180920180921180922180923180924180925180926180927180928180929180930180931180932180933180934180935180936180937180938180939180940180941180942180943180944180945180946180947180948180949180950180951180952180953180954180955180956180957180958180959180960180961180962180963180964180965180966180967180968180969180970180971180972180973180974180975180976180977180978180979180980180981180982180983180984180985180986180987180988180989180990180991180992180993180994180995180996180997180998180999181000181001181002181003181004181005181006181007181008181009181010181011181012181013181014181015181016181017181018181019181020181021181022181023181024181025181026181027181028181029181030181031181032181033181034181035181036181037181038181039181040181041181042181043181044181045181046181047181048181049181050181051181052181053181054181055181056181057181058181059181060181061181062181063181064181065181066181067181068181069181070181071181072181073181074181075181076181077181078181079181080181081181082181083181084181085181086181087181088181089181090181091181092181093181094181095181096181097181098181099181100181101181102181103181104181105181106181107181108181109181110181111181112181113181114181115181116181117181118181119181120181121181122181123181124181125181126181127181128181129181130181131181132181133181134181135181136181137181138181139181140181141181142181143181144181145181146181147181148181149181150181151181152181153181154181155181156181157181158181159181160181161181162181163181164181165181166181167181168181169181170181171181172181173181174181175181176181177181178181179181180181181181182181183181184181185181186181187181188181189181190181191181192181193181194181195181196181197181198181199181200181201181202181203181204181205181206181207181208181209181210181211181212181213181214181215181216181217181218181219181220181221181222181223181224181225181226181227181228181229181230181231181232181233181234181235181236181237181238181239181240181241181242181243181244181245181246181247181248181249181250181251181252181253181254181255181256181257181258181259181260181261181262181263181264181265181266181267181268181269181270181271181272181273181274181275181276181277181278181279181280181281181282181283181284181285181286181287181288181289181290181291181292181293181294181295181296181297181298181299181300181301181302181303181304181305181306181307181308181309181310181311181312181313181314181315181316181317181318181319181320181321181322181323181324181325181326181327181328181329181330181331181332181333181334181335181336181337181338181339181340181341181342181343181344181345181346181347181348181349181350181351181352181353181354181355181356181357181358181359181360181361181362181363181364181365181366181367181368181369181370181371181372181373181374181375181376181377181378181379181380181381181382181383181384181385181386181387181388181389181390181391181392181393181394181395181396181397181398181399181400181401181402181403181404181405181406181407181408181409181410181411181412181413181414181415181416181417181418181419181420181421181422181423181424181425181426181427181428181429181430181431181432181433181434181435181436181437181438181439181440181441181442181443181444181445181446181447181448181449181450181451181452181453181454181455181456181457181458181459181460181461181462181463181464181465181466181467181468181469181470181471181472181473181474181475181476181477181478181479181480181481181482181483181484181485181486181487181488181489181490181491181492181493181494181495181496181497181498181499181500181501181502181503181504181505181506181507181508181509181510181511181512181513181514181515181516181517181518181519181520181521181522181523181524181525181526181527181528181529181530181531181532181533181534181535181536181537181538181539181540181541181542181543181544181545181546181547181548181549181550181551181552181553181554181555181556181557181558181559181560181561181562181563181564181565181566181567181568181569181570181571181572181573181574181575181576181577181578181579181580181581181582181583181584181585181586181587181588181589181590181591181592181593181594181595181596181597181598181599181600181601181602181603181604181605181606181607181608181609181610181611181612181613181614181615181616181617181618181619181620181621181622181623181624181625181626181627181628181629181630181631181632181633181634181635181636181637181638181639181640181641181642181643181644181645181646181647181648181649181650181651181652181653181654181655181656181657181658181659181660181661181662181663181664181665181666181667181668181669181670181671181672181673181674181675181676181677181678181679181680181681181682181683181684181685181686181687181688181689181690181691181692181693181694181695181696181697181698181699181700181701181702181703181704181705181706181707181708181709181710181711181712181713181714181715181716181717181718181719181720181721181722181723181724181725181726181727181728181729181730181731181732181733181734181735181736181737181738181739181740181741181742181743181744181745181746181747181748181749181750181751181752181753181754181755181756181757181758181759181760181761181762181763181764181765181766181767181768181769181770181771181772181773181774181775181776181777181778181779181780181781181782181783181784181785181786181787181788181789181790181791181792181793181794181795181796181797181798181799181800181801181802181803181804181805181806181807181808181809181810181811181812181813181814181815181816181817181818181819181820181821181822181823181824181825181826181827181828181829181830181831181832181833181834181835181836181837181838181839181840181841181842181843181844181845181846181847181848181849181850181851181852181853181854181855181856181857181858181859181860181861181862181863181864181865181866181867181868181869181870181871181872181873181874181875181876181877181878181879181880181881181882181883181884181885181886181887181888181889181890181891181892181893181894181895181896181897181898181899181900181901181902181903181904181905181906181907181908181909181910181911181912181913181914181915181916181917181918181919181920181921181922181923181924181925181926181927181928181929181930181931181932181933181934181935181936181937181938181939181940181941181942181943181944181945181946181947181948181949181950181951181952181953181954181955181956181957181958181959181960181961181962181963181964181965181966181967181968181969181970181971181972181973181974181975181976181977181978181979181980181981181982181983181984181985181986181987181988181989181990181991181992181993181994181995181996181997181998181999182000182001182002182003182004182005182006182007182008182009182010182011182012182013182014182015182016182017182018182019182020182021182022182023182024182025182026182027182028182029182030182031182032182033182034182035182036182037182038182039182040182041182042182043182044182045182046182047182048182049182050182051182052182053182054182055182056182057182058182059182060182061182062182063182064182065182066182067182068182069182070182071182072182073182074182075182076182077182078182079182080182081182082182083182084182085182086182087182088182089182090182091182092182093182094182095182096182097182098182099182100182101182102182103182104182105182106182107182108182109182110182111182112182113182114182115182116182117182118182119182120182121182122182123182124182125182126182127182128182129182130182131182132182133182134182135182136182137182138182139182140182141182142182143182144182145182146182147182148182149182150182151182152182153182154182155182156182157182158182159182160182161182162182163182164182165182166182167182168182169182170182171182172182173182174182175182176182177182178182179182180182181182182182183182184182185182186182187182188182189182190182191182192182193182194182195182196182197182198182199182200182201182202182203182204182205182206182207182208182209182210182211182212182213182214182215182216182217182218182219182220182221182222182223182224182225182226182227182228182229182230182231182232182233182234182235182236182237182238182239182240182241182242182243182244182245182246182247182248182249182250182251182252182253182254182255182256182257182258182259182260182261182262182263182264182265182266182267182268182269182270182271182272182273182274182275182276182277182278182279182280182281182282182283182284182285182286182287182288182289182290182291182292182293182294182295182296182297182298182299182300182301182302182303182304182305182306182307182308182309182310182311182312182313182314182315182316182317182318182319182320182321182322182323182324182325182326182327182328182329182330182331182332182333182334182335182336182337182338182339182340182341182342182343182344182345182346182347182348182349182350182351182352182353182354182355182356182357182358182359182360182361182362182363182364182365182366182367182368182369182370182371182372182373182374182375182376182377182378182379182380182381182382182383182384182385182386182387182388182389182390182391182392182393182394182395182396182397182398182399182400182401182402182403182404182405182406182407182408182409182410182411182412182413182414182415182416182417182418182419182420182421182422182423182424182425182426182427182428182429182430182431182432182433182434182435182436182437182438182439182440182441182442182443182444182445182446182447182448182449182450182451182452182453182454182455182456182457182458182459182460182461182462182463182464182465182466182467182468182469182470182471182472182473182474182475182476182477182478182479182480182481182482182483182484182485182486182487182488182489182490182491182492182493182494182495182496182497182498182499182500182501182502182503182504182505182506182507182508182509182510182511182512182513182514182515182516182517182518182519182520182521182522182523182524182525182526182527182528182529182530182531182532182533182534182535182536182537182538182539182540182541182542182543182544182545182546182547182548182549182550182551182552182553182554182555182556182557182558182559182560182561182562182563182564182565182566182567182568182569182570182571182572182573182574182575182576182577182578182579182580182581182582182583182584182585182586182587182588182589182590182591182592182593182594182595182596182597182598182599182600182601182602182603182604182605182606182607182608182609182610182611182612182613182614182615182616182617182618182619182620182621182622182623182624182625182626182627182628182629182630182631182632182633182634182635182636182637182638182639182640182641182642182643182644182645182646182647182648182649182650182651182652182653182654182655182656182657182658182659182660182661182662182663182664182665182666182667182668182669182670182671182672182673182674182675182676182677182678182679182680182681182682182683182684182685182686182687182688182689182690182691182692182693182694182695182696182697182698182699182700182701182702182703182704182705182706182707182708182709182710182711182712182713182714182715182716182717182718182719182720182721182722182723182724182725182726182727182728182729182730182731182732182733182734182735182736182737182738182739182740182741182742182743182744182745182746182747182748182749182750182751182752182753182754182755182756182757182758182759182760182761182762182763182764182765182766182767182768182769182770182771182772182773182774182775182776182777182778182779182780182781182782182783182784182785182786182787182788182789182790182791182792182793182794182795182796182797182798182799182800182801182802182803182804182805182806182807182808182809182810182811182812182813182814182815182816182817182818182819182820182821182822182823182824182825182826182827182828182829182830182831182832182833182834182835182836182837182838182839182840182841182842182843182844182845182846182847182848182849182850182851182852182853182854182855182856182857182858182859182860182861182862182863182864182865182866182867182868182869182870182871182872182873182874182875182876182877182878182879182880182881182882182883182884182885182886182887182888182889182890182891182892182893182894182895182896182897182898182899182900182901182902182903182904182905182906182907182908182909182910182911182912182913182914182915182916182917182918182919182920182921182922182923182924182925182926182927182928182929182930182931182932182933182934182935182936182937182938182939182940182941182942182943182944182945182946182947182948182949182950182951182952182953182954182955182956182957182958182959182960182961182962182963182964182965182966182967182968182969182970182971182972182973182974182975182976182977182978182979182980182981182982182983182984182985182986182987182988182989182990182991182992182993182994182995182996182997182998182999183000183001183002183003183004183005183006183007183008183009183010183011183012183013183014183015183016183017183018183019183020183021183022183023183024183025183026183027183028183029183030183031183032183033183034183035183036183037183038183039183040183041183042183043183044183045183046183047183048183049183050183051183052183053183054183055183056183057183058183059183060183061183062183063183064183065183066183067183068183069183070183071183072183073183074183075183076183077183078183079183080183081183082183083183084183085183086183087183088183089183090183091183092183093183094183095183096183097183098183099183100183101183102183103183104183105183106183107183108183109183110183111183112183113183114183115183116183117183118183119183120183121183122183123183124183125183126183127183128183129183130183131183132183133183134183135183136183137183138183139183140183141183142183143183144183145183146183147183148183149183150183151183152183153183154183155183156183157183158183159183160183161183162183163183164183165183166183167183168183169183170183171183172183173183174183175183176183177183178183179183180183181183182183183183184183185183186183187183188183189183190183191183192183193183194183195183196183197183198183199183200183201183202183203183204183205183206183207183208183209183210183211183212183213183214183215183216183217183218183219183220183221183222183223183224183225183226183227183228183229183230183231183232183233183234183235183236183237183238183239183240183241183242183243183244183245183246183247183248183249183250183251183252183253183254183255183256183257183258183259183260183261183262183263183264183265183266183267183268183269183270183271183272183273183274183275183276183277183278183279183280183281183282183283183284183285183286183287183288183289183290183291183292183293183294183295183296183297183298183299183300183301183302183303183304183305183306183307183308183309183310183311183312183313183314183315183316183317183318183319183320183321183322183323183324183325183326183327183328183329183330183331183332183333183334183335183336183337183338183339183340183341183342183343183344183345183346183347183348183349183350183351183352183353183354183355183356183357183358183359183360183361183362183363183364183365183366183367183368183369183370183371183372183373183374183375183376183377183378183379183380183381183382183383183384183385183386183387183388183389183390183391183392183393183394183395183396183397183398183399183400183401183402183403183404183405183406183407183408183409183410183411183412183413183414183415183416183417183418183419183420183421183422183423183424183425183426183427183428183429183430183431183432183433183434183435183436183437183438183439183440183441183442183443183444183445183446183447183448183449183450183451183452183453183454183455183456183457183458183459183460183461183462183463183464183465183466183467183468183469183470183471183472183473183474183475183476183477183478183479183480183481183482183483183484183485183486183487183488183489183490183491183492183493183494183495183496183497183498183499183500183501183502183503183504183505183506183507183508183509183510183511183512183513183514183515183516183517183518183519183520183521183522183523183524183525183526183527183528183529183530183531183532183533183534183535183536183537183538183539183540183541183542183543183544183545183546183547183548183549183550183551183552183553183554183555183556183557183558183559183560183561183562183563183564183565183566183567183568183569183570183571183572183573183574183575183576183577183578183579183580183581183582183583183584183585183586183587183588183589183590183591183592183593183594183595183596183597183598183599183600183601183602183603183604183605183606183607183608183609183610183611183612183613183614183615183616183617183618183619183620183621183622183623183624183625183626183627183628183629183630183631183632183633183634183635183636183637183638183639183640183641183642183643183644183645183646183647183648183649183650183651183652183653183654183655183656183657183658183659183660183661183662183663183664183665183666183667183668183669183670183671183672183673183674183675183676183677183678183679183680183681183682183683183684183685183686183687183688183689183690183691183692183693183694183695183696183697183698183699183700183701183702183703183704183705183706183707183708183709183710183711183712183713183714183715183716183717183718183719183720183721183722183723183724183725183726183727183728183729183730183731183732183733183734183735183736183737183738183739183740183741183742183743183744183745183746183747183748183749183750183751183752183753183754183755183756183757183758183759183760183761183762183763183764183765183766183767183768183769183770183771183772183773183774183775183776183777183778183779183780183781183782183783183784183785183786183787183788183789183790183791183792183793183794183795183796183797183798183799183800183801183802183803183804183805183806183807183808183809183810183811183812183813183814183815183816183817183818183819183820183821183822183823183824183825183826183827183828183829183830183831183832183833183834183835183836183837183838183839183840183841183842183843183844183845183846183847183848183849183850183851183852183853183854183855183856183857183858183859183860183861183862183863183864183865183866183867183868183869183870183871183872183873183874183875183876183877183878183879183880183881183882183883183884183885183886183887183888183889183890183891183892183893183894183895183896183897183898183899183900183901183902183903183904183905183906183907183908183909183910183911183912183913183914183915183916183917183918183919183920183921183922183923183924183925183926183927183928183929183930183931183932183933183934183935183936183937183938183939183940183941183942183943183944183945183946183947183948183949183950183951183952183953183954183955183956183957183958183959183960183961183962183963183964183965183966183967183968183969183970183971183972183973183974183975183976183977183978183979183980183981183982183983183984183985183986183987183988183989183990183991183992183993183994183995183996183997183998183999184000184001184002184003184004184005184006184007184008184009184010184011184012184013184014184015184016184017184018184019184020184021184022184023184024184025184026184027184028184029184030184031184032184033184034184035184036184037184038184039184040184041184042184043184044184045184046184047184048184049184050184051184052184053184054184055184056184057184058184059184060184061184062184063184064184065184066184067184068184069184070184071184072184073184074184075184076184077184078184079184080184081184082184083184084184085184086184087184088184089184090184091184092184093184094184095184096184097184098184099184100184101184102184103184104184105184106184107184108184109184110184111184112184113184114184115184116184117184118184119184120184121184122184123184124184125184126184127184128184129184130184131184132184133184134184135184136184137184138184139184140184141184142184143184144184145184146184147184148184149184150184151184152184153184154184155184156184157184158184159184160184161184162184163184164184165184166184167184168184169184170184171184172184173184174184175184176184177184178184179184180184181184182184183184184184185184186184187184188184189184190184191184192184193184194184195184196184197184198184199184200184201184202184203184204184205184206184207184208184209184210184211184212184213184214184215184216184217184218184219184220184221184222184223184224184225184226184227184228184229184230184231184232184233184234184235184236184237184238184239184240184241184242184243184244184245184246184247184248184249184250184251184252184253184254184255184256184257184258184259184260184261184262184263184264184265184266184267184268184269184270184271184272184273184274184275184276184277184278184279184280184281184282184283184284184285184286184287184288184289184290184291184292184293184294184295184296184297184298184299184300184301184302184303184304184305184306184307184308184309184310184311184312184313184314184315184316184317184318184319184320184321184322184323184324184325184326184327184328184329184330184331184332184333184334184335184336184337184338184339184340184341184342184343184344184345184346184347184348184349184350184351184352184353184354184355184356184357184358184359184360184361184362184363184364184365184366184367184368184369184370184371184372184373184374184375184376184377184378184379184380184381184382184383184384184385184386184387184388184389184390184391184392184393184394184395184396184397184398184399184400184401184402184403184404184405184406184407184408184409184410184411184412184413184414184415184416184417184418184419184420184421184422184423184424184425184426184427184428184429184430184431184432184433184434184435184436184437184438184439184440184441184442184443184444184445184446184447184448184449184450184451184452184453184454184455184456184457184458184459184460184461184462184463184464184465184466184467184468184469184470184471184472184473184474184475184476184477184478184479184480184481184482184483184484184485184486184487184488184489184490184491184492184493184494184495184496184497184498184499184500184501184502184503184504184505184506184507184508184509184510184511184512184513184514184515184516184517184518184519184520184521184522184523184524184525184526184527184528184529184530184531184532184533184534184535184536184537184538184539184540184541184542184543184544184545184546184547184548184549184550184551184552184553184554184555184556184557184558184559184560184561184562184563184564184565184566184567184568184569184570184571184572184573184574184575184576184577184578184579184580184581184582184583184584184585184586184587184588184589184590184591184592184593184594184595184596184597184598184599184600184601184602184603184604184605184606184607184608184609184610184611184612184613184614184615184616184617184618184619184620184621184622184623184624184625184626184627184628184629184630184631184632184633184634184635184636184637184638184639184640184641184642184643184644184645184646184647184648184649184650184651184652184653184654184655184656184657184658184659184660184661184662184663184664184665184666184667184668184669184670184671184672184673184674184675184676184677184678184679184680184681184682184683184684184685184686184687184688184689184690184691184692184693184694184695184696184697184698184699184700184701184702184703184704184705184706184707184708184709184710184711184712184713184714184715184716184717184718184719184720184721184722184723184724184725184726184727184728184729184730184731184732184733184734184735184736184737184738184739184740184741184742184743184744184745184746184747184748184749184750184751184752184753184754184755184756184757184758184759184760184761184762184763184764184765184766184767184768184769184770184771184772184773184774184775184776184777184778184779184780184781184782184783184784184785184786184787184788184789184790184791184792184793184794184795184796184797184798184799184800184801184802184803184804184805184806184807184808184809184810184811184812184813184814184815184816184817184818184819184820184821184822184823184824184825184826184827184828184829184830184831184832184833184834184835184836184837184838184839184840184841184842184843184844184845184846184847184848184849184850184851184852184853184854184855184856184857184858184859184860184861184862184863184864184865184866184867184868184869184870184871184872184873184874184875184876184877184878184879184880184881184882184883184884184885184886184887184888184889184890184891184892184893184894184895184896184897184898184899184900184901184902184903184904184905184906184907184908184909184910184911184912184913184914184915184916184917184918184919184920184921184922184923184924184925184926184927184928184929184930184931184932184933184934184935184936184937184938184939184940184941184942184943184944184945184946184947184948184949184950184951184952184953184954184955184956184957184958184959184960184961184962184963184964184965184966184967184968184969184970184971184972184973184974184975184976184977184978184979184980184981184982184983184984184985184986184987184988184989184990184991184992184993184994184995184996184997184998184999185000185001185002185003185004185005185006185007185008185009185010185011185012185013185014185015185016185017185018185019185020185021185022185023185024185025185026185027185028185029185030185031185032185033185034185035185036185037185038185039185040185041185042185043185044185045185046185047185048185049185050185051185052185053185054185055185056185057185058185059185060185061185062185063185064185065185066185067185068185069185070185071185072185073185074185075185076185077185078185079185080185081185082185083185084185085185086185087185088185089185090185091185092185093185094185095185096185097185098185099185100185101185102185103185104185105185106185107185108185109185110185111185112185113185114185115185116185117185118185119185120185121185122185123185124185125185126185127185128185129185130185131185132185133185134185135185136185137185138185139185140185141185142185143185144185145185146185147185148185149185150185151185152185153185154185155185156185157185158185159185160185161185162185163185164185165185166185167185168185169185170185171185172185173185174185175185176185177185178185179185180185181185182185183185184185185185186185187185188185189185190185191185192185193185194185195185196185197185198185199185200185201185202185203185204185205185206185207185208185209185210185211185212185213185214185215185216185217185218185219185220185221185222185223185224185225185226185227185228185229185230185231185232185233185234185235185236185237185238185239185240185241185242185243185244185245185246185247185248185249185250185251185252185253185254185255185256185257185258185259185260185261185262185263185264185265185266185267185268185269185270185271185272185273185274185275185276185277185278185279185280185281185282185283185284185285185286185287185288185289185290185291185292185293185294185295185296185297185298185299185300185301185302185303185304185305185306185307185308185309185310185311185312185313185314185315185316185317185318185319185320185321185322185323185324185325185326185327185328185329185330185331185332185333185334185335185336185337185338185339185340185341185342185343185344185345185346185347185348185349185350185351185352185353185354185355185356185357185358185359185360185361185362185363185364185365185366185367185368185369185370185371185372185373185374185375185376185377185378185379185380185381185382185383185384185385185386185387185388185389185390185391185392185393185394185395185396185397185398185399185400185401185402185403185404185405185406185407185408185409185410185411185412185413185414185415185416185417185418185419185420185421185422185423185424185425185426185427185428185429185430185431185432185433185434185435185436185437185438185439185440185441185442185443185444185445185446185447185448185449185450185451185452185453185454185455185456185457185458185459185460185461185462185463185464185465185466185467185468185469185470185471185472185473185474185475185476185477185478185479185480185481185482185483185484185485185486185487185488185489185490185491185492185493185494185495185496185497185498185499185500185501185502185503185504185505185506185507185508185509185510185511185512185513185514185515185516185517185518185519185520185521185522185523185524185525185526185527185528185529185530185531185532185533185534185535185536185537185538185539185540185541185542185543185544185545185546185547185548185549185550185551185552185553185554185555185556185557185558185559185560185561185562185563185564185565185566185567185568185569185570185571185572185573185574185575185576185577185578185579185580185581185582185583185584185585185586185587185588185589185590185591185592185593185594185595185596185597185598185599185600185601185602185603185604185605185606185607185608185609185610185611185612185613185614185615185616185617185618185619185620185621185622185623185624185625185626185627185628185629185630185631185632185633185634185635185636185637185638185639185640185641185642185643185644185645185646185647185648185649185650185651185652185653185654185655185656185657185658185659185660185661185662185663185664185665185666185667185668185669185670185671185672185673185674185675185676185677185678185679185680185681185682185683185684185685185686185687185688185689185690185691185692185693185694185695185696185697185698185699185700185701185702185703185704185705185706185707185708185709185710185711185712185713185714185715185716185717185718185719185720185721185722185723185724185725185726185727185728185729185730185731185732185733185734185735185736185737185738185739185740185741185742185743185744185745185746185747185748185749185750185751185752185753185754185755185756185757185758185759185760185761185762185763185764185765185766185767185768185769185770185771185772185773185774185775185776185777185778185779185780185781185782185783185784185785185786185787185788185789185790185791185792185793185794185795185796185797185798185799185800185801185802185803185804185805185806185807185808185809185810185811185812185813185814185815185816185817185818185819185820185821185822185823185824185825185826185827185828185829185830185831185832185833185834185835185836185837185838185839185840185841185842185843185844185845185846185847185848185849185850185851185852185853185854185855185856185857185858185859185860185861185862185863185864185865185866185867185868185869185870185871185872185873185874185875185876185877185878185879185880185881185882185883185884185885185886185887185888185889185890185891185892185893185894185895185896185897185898185899185900185901185902185903185904185905185906185907185908185909185910185911185912185913185914185915185916185917185918185919185920185921185922185923185924185925185926185927185928185929185930185931185932185933185934185935185936185937185938185939185940185941185942185943185944185945185946185947185948185949185950185951185952185953185954185955185956185957185958185959185960185961185962185963185964185965185966185967185968185969185970185971185972185973185974185975185976185977185978185979185980185981185982185983185984185985185986185987185988185989185990185991185992185993185994185995185996185997185998185999186000186001186002186003186004186005186006186007186008186009186010186011186012186013186014186015186016186017186018186019186020186021186022186023186024186025186026186027186028186029186030186031186032186033186034186035186036186037186038186039186040186041186042186043186044186045186046186047186048186049186050186051186052186053186054186055186056186057186058186059186060186061186062186063186064186065186066186067186068186069186070186071186072186073186074186075186076186077186078186079186080186081186082186083186084186085186086186087186088186089186090186091186092186093186094186095186096186097186098186099186100186101186102186103186104186105186106186107186108186109186110186111186112186113186114186115186116186117186118186119186120186121186122186123186124186125186126186127186128186129186130186131186132186133186134186135186136186137186138186139186140186141186142186143186144186145186146186147186148186149186150186151186152186153186154186155186156186157186158186159186160186161186162186163186164186165186166186167186168186169186170186171186172186173186174186175186176186177186178186179186180186181186182186183186184186185186186186187186188186189186190186191186192186193186194186195186196186197186198186199186200186201186202186203186204186205186206186207186208186209186210186211186212186213186214186215186216186217186218186219186220186221186222186223186224186225186226186227186228186229186230186231186232186233186234186235186236186237186238186239186240186241186242186243186244186245186246186247186248186249186250186251186252186253186254186255186256186257186258186259186260186261186262186263186264186265186266186267186268186269186270186271186272186273186274186275186276186277186278186279186280186281186282186283186284186285186286186287186288186289186290186291186292186293186294186295186296186297186298186299186300186301186302186303186304186305186306186307186308186309186310186311186312186313186314186315186316186317186318186319186320186321186322186323186324186325186326186327186328186329186330186331186332186333186334186335186336186337186338186339186340186341186342186343186344186345186346186347186348186349186350186351186352186353186354186355186356186357186358186359186360186361186362186363186364186365186366186367186368186369186370186371186372186373186374186375186376186377186378186379186380186381186382186383186384186385186386186387186388186389186390186391186392186393186394186395186396186397186398186399186400186401186402186403186404186405186406186407186408186409186410186411186412186413186414186415186416186417186418186419186420186421186422186423186424186425186426186427186428186429186430186431186432186433186434186435186436186437186438186439186440186441186442186443186444186445186446186447186448186449186450186451186452186453186454186455186456186457186458186459186460186461186462186463186464186465186466186467186468186469186470186471186472186473186474186475186476186477186478186479186480186481186482186483186484186485186486186487186488186489186490186491186492186493186494186495186496186497186498186499186500186501186502186503186504186505186506186507186508186509186510186511186512186513186514186515186516186517186518186519186520186521186522186523186524186525186526186527186528186529186530186531186532186533186534186535186536186537186538186539186540186541186542186543186544186545186546186547186548186549186550186551186552186553186554186555186556186557186558186559186560186561186562186563186564186565186566186567186568186569186570186571186572186573186574186575186576186577186578186579186580186581186582186583186584186585186586186587186588186589186590186591186592186593186594186595186596186597186598186599186600186601186602186603186604186605186606186607186608186609186610186611186612186613186614186615186616186617186618186619186620186621186622186623186624186625186626186627186628186629186630186631186632186633186634186635186636186637186638186639186640186641186642186643186644186645186646186647186648186649186650186651186652186653186654186655186656186657186658186659186660186661186662186663186664186665186666186667186668186669186670186671186672186673186674186675186676186677186678186679186680186681186682186683186684186685186686186687186688186689186690186691186692186693186694186695186696186697186698186699186700186701186702186703186704186705186706186707186708186709186710186711186712186713186714186715186716186717186718186719186720186721186722186723186724186725186726186727186728186729186730186731186732186733186734186735186736186737186738186739186740186741186742186743186744186745186746186747186748186749186750186751186752186753186754186755186756186757186758186759186760186761186762186763186764186765186766186767186768186769186770186771186772186773186774186775186776186777186778186779186780186781186782186783186784186785186786186787186788186789186790186791186792186793186794186795186796186797186798186799186800186801186802186803186804186805186806186807186808186809186810186811186812186813186814186815186816186817186818186819186820186821186822186823186824186825186826186827186828186829186830186831186832186833186834186835186836186837186838186839186840186841186842186843186844186845186846186847186848186849186850186851186852186853186854186855186856186857186858186859186860186861186862186863186864186865186866186867186868186869186870186871186872186873186874186875186876186877186878186879186880186881186882186883186884186885186886186887186888186889186890186891186892186893186894186895186896186897186898186899186900186901186902186903186904186905186906186907186908186909186910186911186912186913186914186915186916186917186918186919186920186921186922186923186924186925186926186927186928186929186930186931186932186933186934186935186936186937186938186939186940186941186942186943186944186945186946186947186948186949186950186951186952186953186954186955186956186957186958186959186960186961186962186963186964186965186966186967186968186969186970186971186972186973186974186975186976186977186978186979186980186981186982186983186984186985186986186987186988186989186990186991186992186993186994186995186996186997186998186999187000187001187002187003187004187005187006187007187008187009187010187011187012187013187014187015187016187017187018187019187020187021187022187023187024187025187026187027187028187029187030187031187032187033187034187035187036187037187038187039187040187041187042187043187044187045187046187047187048187049187050187051187052187053187054187055187056187057187058187059187060187061187062187063187064187065187066187067187068187069187070187071187072187073187074187075187076187077187078187079187080187081187082187083187084187085187086187087187088187089187090187091187092187093187094187095187096187097187098187099187100187101187102187103187104187105187106187107187108187109187110187111187112187113187114187115187116187117187118187119187120187121187122187123187124187125187126187127187128187129187130187131187132187133187134187135187136187137187138187139187140187141187142187143187144187145187146187147187148187149187150187151187152187153187154187155187156187157187158187159187160187161187162187163187164187165187166187167187168187169187170187171187172187173187174187175187176187177187178187179187180187181187182187183187184187185187186187187187188187189187190187191187192187193187194187195187196187197187198187199187200187201187202187203187204187205187206187207187208187209187210187211187212187213187214187215187216187217187218187219187220187221187222187223187224187225187226187227187228187229187230187231187232187233187234187235187236187237187238187239187240187241187242187243187244187245187246187247187248187249187250187251187252187253187254187255187256187257187258187259187260187261187262187263187264187265187266187267187268187269187270187271187272187273187274187275187276187277187278187279187280187281187282187283187284187285187286187287187288187289187290187291187292187293187294187295187296187297187298187299187300187301187302187303187304187305187306187307187308187309187310187311187312187313187314187315187316187317187318187319187320187321187322187323187324187325187326187327187328187329187330187331187332187333187334187335187336187337187338187339187340187341187342187343187344187345187346187347187348187349187350187351187352187353187354187355187356187357187358187359187360187361187362187363187364187365187366187367187368187369187370187371187372187373187374187375187376187377187378187379187380187381187382187383187384187385187386187387187388187389187390187391187392187393187394187395187396187397187398187399187400187401187402187403187404187405187406187407187408187409187410187411187412187413187414187415187416187417187418187419187420187421187422187423187424187425187426187427187428187429187430187431187432187433187434187435187436187437187438187439187440187441187442187443187444187445187446187447187448187449187450187451187452187453187454187455187456187457187458187459187460187461187462187463187464187465187466187467187468187469187470187471187472187473187474187475187476187477187478187479187480187481187482187483187484187485187486187487187488187489187490187491187492187493187494187495187496187497187498187499187500187501187502187503187504187505187506187507187508187509187510187511187512187513187514187515187516187517187518187519187520187521187522187523187524187525187526187527187528187529187530187531187532187533187534187535187536187537187538187539187540187541187542187543187544187545187546187547187548187549187550187551187552187553187554187555187556187557187558187559187560187561187562187563187564187565187566187567187568187569187570187571187572187573187574187575187576187577187578187579187580187581187582187583187584187585187586187587187588187589187590187591187592187593187594187595187596187597187598187599187600187601187602187603187604187605187606187607187608187609187610187611187612187613187614187615187616187617187618187619187620187621187622187623187624187625187626187627187628187629187630187631187632187633187634187635187636187637187638187639187640187641187642187643187644187645187646187647187648187649187650187651187652187653187654187655187656187657187658187659187660187661187662187663187664187665187666187667187668187669187670187671187672187673187674187675187676187677187678187679187680187681187682187683187684187685187686187687187688187689187690187691187692187693187694187695187696187697187698187699187700187701187702187703187704187705187706187707187708187709187710187711187712187713187714187715187716187717187718187719187720187721187722187723187724187725187726187727187728187729187730187731187732187733187734187735187736187737187738187739187740187741187742187743187744187745187746187747187748187749187750187751187752187753187754187755187756187757187758187759187760187761187762187763187764187765187766187767187768187769187770187771187772187773187774187775187776187777187778187779187780187781187782187783187784187785187786187787187788187789187790187791187792187793187794187795187796187797187798187799187800187801187802187803187804187805187806187807187808187809187810187811187812187813187814187815187816187817187818187819187820187821187822187823187824187825187826187827187828187829187830187831187832187833187834187835187836187837187838187839187840187841187842187843187844187845187846187847187848187849187850187851187852187853187854187855187856187857187858187859187860187861187862187863187864187865187866187867187868187869187870187871187872187873187874187875187876187877187878187879187880187881187882187883187884187885187886187887187888187889187890187891187892187893187894187895187896187897187898187899187900187901187902187903187904187905187906187907187908187909187910187911187912187913187914187915187916187917187918187919187920187921187922187923187924187925187926187927187928187929187930187931187932187933187934187935187936187937187938187939187940187941187942187943187944187945187946187947187948187949187950187951187952187953187954187955187956187957187958187959187960187961187962187963187964187965187966187967187968187969187970187971187972187973187974187975187976187977187978187979187980187981187982187983187984187985187986187987187988187989187990187991187992187993187994187995187996187997187998187999188000188001188002188003188004188005188006188007188008188009188010188011188012188013188014188015188016188017188018188019188020188021188022188023188024188025188026188027188028188029188030188031188032188033188034188035188036188037188038188039188040188041188042188043188044188045188046188047188048188049188050188051188052188053188054188055188056188057188058188059188060188061188062188063188064188065188066188067188068188069188070188071188072188073188074188075188076188077188078188079188080188081188082188083188084188085188086188087188088188089188090188091188092188093188094188095188096188097188098188099188100188101188102188103188104188105188106188107188108188109188110188111188112188113188114188115188116188117188118188119188120188121188122188123188124188125188126188127188128188129188130188131188132188133188134188135188136188137188138188139188140188141188142188143188144188145188146188147188148188149188150188151188152188153188154188155188156188157188158188159188160188161188162188163188164188165188166188167188168188169188170188171188172188173188174188175188176188177188178188179188180188181188182188183188184188185188186188187188188188189188190188191188192188193188194188195188196188197188198188199188200188201188202188203188204188205188206188207188208188209188210188211188212188213188214188215188216188217188218188219188220188221188222188223188224188225188226188227188228188229188230188231188232188233188234188235188236188237188238188239188240188241188242188243188244188245188246188247188248188249188250188251188252188253188254188255188256188257188258188259188260188261188262188263188264188265188266188267188268188269188270188271188272188273188274188275188276188277188278188279188280188281188282188283188284188285188286188287188288188289188290188291188292188293188294188295188296188297188298188299188300188301188302188303188304188305188306188307188308188309188310188311188312188313188314188315188316188317188318188319188320188321188322188323188324188325188326188327188328188329188330188331188332188333188334188335188336188337188338188339188340188341188342188343188344188345188346188347188348188349188350188351188352188353188354188355188356188357188358188359188360188361188362188363188364188365188366188367188368188369188370188371188372188373188374188375188376188377188378188379188380188381188382188383188384188385188386188387188388188389188390188391188392188393188394188395188396188397188398188399188400188401188402188403188404188405188406188407188408188409188410188411188412188413188414188415188416188417188418188419188420188421188422188423188424188425188426188427188428188429188430188431188432188433188434188435188436188437188438188439188440188441188442188443188444188445188446188447188448188449188450188451188452188453188454188455188456188457188458188459188460188461188462188463188464188465188466188467188468188469188470188471188472188473188474188475188476188477188478188479188480188481188482188483188484188485188486188487188488188489188490188491188492188493188494188495188496188497188498188499188500188501188502188503188504188505188506188507188508188509188510188511188512188513188514188515188516188517188518188519188520188521188522188523188524188525188526188527188528188529188530188531188532188533188534188535188536188537188538188539188540188541188542188543188544188545188546188547188548188549188550188551188552188553188554188555188556188557188558188559188560188561188562188563188564188565188566188567188568188569188570188571188572188573188574188575188576188577188578188579188580188581188582188583188584188585188586188587188588188589188590188591188592188593188594188595188596188597188598188599188600188601188602188603188604188605188606188607188608188609188610188611188612188613188614188615188616188617188618188619188620188621188622188623188624188625188626188627188628188629188630188631188632188633188634188635188636188637188638188639188640188641188642188643188644188645188646188647188648188649188650188651188652188653188654188655188656188657188658188659188660188661188662188663188664188665188666188667188668188669188670188671188672188673188674188675188676188677188678188679188680188681188682188683188684188685188686188687188688188689188690188691188692188693188694188695188696188697188698188699188700188701188702188703188704188705188706188707188708188709188710188711188712188713188714188715188716188717188718188719188720188721188722188723188724188725188726188727188728188729188730188731188732188733188734188735188736188737188738188739188740188741188742188743188744188745188746188747188748188749188750188751188752188753188754188755188756188757188758188759188760188761188762188763188764188765188766188767188768188769188770188771188772188773188774188775188776188777188778188779188780188781188782188783188784188785188786188787188788188789188790188791188792188793188794188795188796188797188798188799188800188801188802188803188804188805188806188807188808188809188810188811188812188813188814188815188816188817188818188819188820188821188822188823188824188825188826188827188828188829188830188831188832188833188834188835188836188837188838188839188840188841188842188843188844188845188846188847188848188849188850188851188852188853188854188855188856188857188858188859188860188861188862188863188864188865188866188867188868188869188870188871188872188873188874188875188876188877188878188879188880188881188882188883188884188885188886188887188888188889188890188891188892188893188894188895188896188897188898188899188900188901188902188903188904188905188906188907188908188909188910188911188912188913188914188915188916188917188918188919188920188921188922188923188924188925188926188927188928188929188930188931188932188933188934188935188936188937188938188939188940188941188942188943188944188945188946188947188948188949188950188951188952188953188954188955188956188957188958188959188960188961188962188963188964188965188966188967188968188969188970188971188972188973188974188975188976188977188978188979188980188981188982188983188984188985188986188987188988188989188990188991188992188993188994188995188996188997188998188999189000189001189002189003189004189005189006189007189008189009189010189011189012189013189014189015189016189017189018189019189020189021189022189023189024189025189026189027189028189029189030189031189032189033189034189035189036189037189038189039189040189041189042189043189044189045189046189047189048189049189050189051189052189053189054189055189056189057189058189059189060189061189062189063189064189065189066189067189068189069189070189071189072189073189074189075189076189077189078189079189080189081189082189083189084189085189086189087189088189089189090189091189092189093189094189095189096189097189098189099189100189101189102189103189104189105189106189107189108189109189110189111189112189113189114189115189116189117189118189119189120189121189122189123189124189125189126189127189128189129189130189131189132189133189134189135189136189137189138189139189140189141189142189143189144189145189146189147189148189149189150189151189152189153189154189155189156189157189158189159189160189161189162189163189164189165189166189167189168189169189170189171189172189173189174189175189176189177189178189179189180189181189182189183189184189185189186189187189188189189189190189191189192189193189194189195189196189197189198189199189200189201189202189203189204189205189206189207189208189209189210189211189212189213189214189215189216189217189218189219189220189221189222189223189224189225189226189227189228189229189230189231189232189233189234189235189236189237189238189239189240189241189242189243189244189245189246189247189248189249189250189251189252189253189254189255189256189257189258189259189260189261189262189263189264189265189266189267189268189269189270189271189272189273189274189275189276189277189278189279189280189281189282189283189284189285189286189287189288189289189290189291189292189293189294189295189296189297189298189299189300189301189302189303189304189305189306189307189308189309189310189311189312189313189314189315189316189317189318189319189320189321189322189323189324189325189326189327189328189329189330189331189332189333189334189335189336189337189338189339189340189341189342189343189344189345189346189347189348189349189350189351189352189353189354189355189356189357189358189359189360189361189362189363189364189365189366189367189368189369189370189371189372189373189374189375189376189377189378189379189380189381189382189383189384189385189386189387189388189389189390189391189392189393189394189395189396189397189398189399189400189401189402189403189404189405189406189407189408189409189410189411189412189413189414189415189416189417189418189419189420189421189422189423189424189425189426189427189428189429189430189431189432189433189434189435189436189437189438189439189440189441189442189443189444189445189446189447189448189449189450189451189452189453189454189455189456189457189458189459189460189461189462189463189464189465189466189467189468189469189470189471189472189473189474189475189476189477189478189479189480189481189482189483189484189485189486189487189488189489189490189491189492189493189494189495189496189497189498189499189500189501189502189503189504189505189506189507189508189509189510189511189512189513189514189515189516189517189518189519189520189521189522189523189524189525189526189527189528189529189530189531189532189533189534189535189536189537189538189539189540189541189542189543189544189545189546189547189548189549189550189551189552189553189554189555189556189557189558189559189560189561189562189563189564189565189566189567189568189569189570189571189572189573189574189575189576189577189578189579189580189581189582189583189584189585189586189587189588189589189590189591189592189593189594189595189596189597189598189599189600189601189602189603189604189605189606189607189608189609189610189611189612189613189614189615189616189617189618189619189620189621189622189623189624189625189626189627189628189629189630189631189632189633189634189635189636189637189638189639189640189641189642189643189644189645189646189647189648189649189650189651189652189653189654189655189656189657189658189659189660189661189662189663189664189665189666189667189668189669189670189671189672189673189674189675189676189677189678189679189680189681189682189683189684189685189686189687189688189689189690189691189692189693189694189695189696189697189698189699189700189701189702189703189704189705189706189707189708189709189710189711189712189713189714189715189716189717189718189719189720189721189722189723189724189725189726189727189728189729189730189731189732189733189734189735189736189737189738189739189740189741189742189743189744189745189746189747189748189749189750189751189752189753189754189755189756189757189758189759189760189761189762189763189764189765189766189767189768189769189770189771189772189773189774189775189776189777189778189779189780189781189782189783189784189785189786189787189788189789189790189791189792189793189794189795189796189797189798189799189800189801189802189803189804189805189806189807189808189809189810189811189812189813189814189815189816189817189818189819189820189821189822189823189824189825189826189827189828189829189830189831189832189833189834189835189836189837189838189839189840189841189842189843189844189845189846189847189848189849189850189851189852189853189854189855189856189857189858189859189860189861189862189863189864189865189866189867189868189869189870189871189872189873189874189875189876189877189878189879189880189881189882189883189884189885189886189887189888189889189890189891189892189893189894189895189896189897189898189899189900189901189902189903189904189905189906189907189908189909189910189911189912189913189914189915189916189917189918189919189920189921189922189923189924189925189926189927189928189929189930189931189932189933189934189935189936189937189938189939189940189941189942189943189944189945189946189947189948189949189950189951189952189953189954189955189956189957189958189959189960189961189962189963189964189965189966189967189968189969189970189971189972189973189974189975189976189977189978189979189980189981189982189983189984189985189986189987189988189989189990189991189992189993189994189995189996189997189998189999190000190001190002190003190004190005190006190007190008190009190010190011190012190013190014190015190016190017190018190019190020190021190022190023190024190025190026190027190028190029190030190031190032190033190034190035190036190037190038190039190040190041190042190043190044190045190046190047190048190049190050190051190052190053190054190055190056190057190058190059190060190061190062190063190064190065190066190067190068190069190070190071190072190073190074190075190076190077190078190079190080190081190082190083190084190085190086190087190088190089190090190091190092190093190094190095190096190097190098190099190100190101190102190103190104190105190106190107190108190109190110190111190112190113190114190115190116190117190118190119190120190121190122190123190124190125190126190127190128190129190130190131190132190133190134190135190136190137190138190139190140190141190142190143190144190145190146190147190148190149190150190151190152190153190154190155190156190157190158190159190160190161190162190163190164190165190166190167190168190169190170190171190172190173190174190175190176190177190178190179190180190181190182190183190184190185190186190187190188190189190190190191190192190193190194190195190196190197190198190199190200190201190202190203190204190205190206190207190208190209190210190211190212190213190214190215190216190217190218190219190220190221190222190223190224190225190226190227190228190229190230190231190232190233190234190235190236190237190238190239190240190241190242190243190244190245190246190247190248190249190250190251190252190253190254190255190256190257190258190259190260190261190262190263190264190265190266190267190268190269190270190271190272190273190274190275190276190277190278190279190280190281190282190283190284190285190286190287190288190289190290190291190292190293190294190295190296190297190298190299190300190301190302190303190304190305190306190307190308190309190310190311190312190313190314190315190316190317190318190319190320190321190322190323190324190325190326190327190328190329190330190331190332190333190334190335190336190337190338190339190340190341190342190343190344190345190346190347190348190349190350190351190352190353190354190355190356190357190358190359190360190361190362190363190364190365190366190367190368190369190370190371190372190373190374190375190376190377190378190379190380190381190382190383190384190385190386190387190388190389190390190391190392190393190394190395190396190397190398190399190400190401190402190403190404190405190406190407190408190409190410190411190412190413190414190415190416190417190418190419190420190421190422190423190424190425190426190427190428190429190430190431190432190433190434190435190436190437190438190439190440190441190442190443190444190445190446190447190448190449190450190451190452190453190454190455190456190457190458190459190460190461190462190463190464190465190466190467190468190469190470190471190472190473190474190475190476190477190478190479190480190481190482190483190484190485190486190487190488190489190490190491190492190493190494190495190496190497190498190499190500190501190502190503190504190505190506190507190508190509190510190511190512190513190514190515190516190517190518190519190520190521190522190523190524190525190526190527190528190529190530190531190532190533190534190535190536190537190538190539190540190541190542190543190544190545190546190547190548190549190550190551190552190553190554190555190556190557190558190559190560190561190562190563190564190565190566190567190568190569190570190571190572190573190574190575190576190577190578190579190580190581190582190583190584190585190586190587190588190589190590190591190592190593190594190595190596190597190598190599190600190601190602190603190604190605190606190607190608190609190610190611190612190613190614190615190616190617190618190619190620190621190622190623190624190625190626190627190628190629190630190631190632190633190634190635190636190637190638190639190640190641190642190643190644190645190646190647190648190649190650190651190652190653190654190655190656190657190658190659190660190661190662190663190664190665190666190667190668190669190670190671190672190673190674190675190676190677190678190679190680190681190682190683190684190685190686190687190688190689190690190691190692190693190694190695190696190697190698190699190700190701190702190703190704190705190706190707190708190709190710190711190712190713190714190715190716190717190718190719190720190721190722190723190724190725190726190727190728190729190730190731190732190733190734190735190736190737190738190739190740190741190742190743190744190745190746190747190748190749190750190751190752190753190754190755190756190757190758190759190760190761190762190763190764190765190766190767190768190769190770190771190772190773190774190775190776190777190778190779190780190781190782190783190784190785190786190787190788190789190790190791190792190793190794190795190796190797190798190799190800190801190802190803190804190805190806190807190808190809190810190811190812190813190814190815190816190817190818190819190820190821190822190823190824190825190826190827190828190829190830190831190832190833190834190835190836190837190838190839190840190841190842190843190844190845190846190847190848190849190850190851190852190853190854190855190856190857190858190859190860190861190862190863190864190865190866190867190868190869190870190871190872190873190874190875190876190877190878190879190880190881190882190883190884190885190886190887190888190889190890190891190892190893190894190895190896190897190898190899190900190901190902190903190904190905190906190907190908190909190910190911190912190913190914190915190916190917190918190919190920190921190922190923190924190925190926190927190928190929190930190931190932190933190934190935190936190937190938190939190940190941190942190943190944190945190946190947190948190949190950190951190952190953190954190955190956190957190958190959190960190961190962190963190964190965190966190967190968190969190970190971190972190973190974190975190976190977190978190979190980190981190982190983190984190985190986190987190988190989190990190991190992190993190994190995190996190997190998190999191000191001191002191003191004191005191006191007191008191009191010191011191012191013191014191015191016191017191018191019191020191021191022191023191024191025191026191027191028191029191030191031191032191033191034191035191036191037191038191039191040191041191042191043191044191045191046191047191048191049191050191051191052191053191054191055191056191057191058191059191060191061191062191063191064191065191066191067191068191069191070191071191072191073191074191075191076191077191078191079191080191081191082191083191084191085191086191087191088191089191090191091191092191093191094191095191096191097191098191099191100191101191102191103191104191105191106191107191108191109191110191111191112191113191114191115191116191117191118191119191120191121191122191123191124191125191126191127191128191129191130191131191132191133191134191135191136191137191138191139191140191141191142191143191144191145191146191147191148191149191150191151191152191153191154191155191156191157191158191159191160191161191162191163191164191165191166191167191168191169191170191171191172191173191174191175191176191177191178191179191180191181191182191183191184191185191186191187191188191189191190191191191192191193191194191195191196191197191198191199191200191201191202191203191204191205191206191207191208191209191210191211191212191213191214191215191216191217191218191219191220191221191222191223191224191225191226191227191228191229191230191231191232191233191234191235191236191237191238191239191240191241191242191243191244191245191246191247191248191249191250191251191252191253191254191255191256191257191258191259191260191261191262191263191264191265191266191267191268191269191270191271191272191273191274191275191276191277191278191279191280191281191282191283191284191285191286191287191288191289191290191291191292191293191294191295191296191297191298191299191300191301191302191303191304191305191306191307191308191309191310191311191312191313191314191315191316191317191318191319191320191321191322191323191324191325191326191327191328191329191330191331191332191333191334191335191336191337191338191339191340191341191342191343191344191345191346191347191348191349191350191351191352191353191354191355191356191357191358191359191360191361191362191363191364191365191366191367191368191369191370191371191372191373191374191375191376191377191378191379191380191381191382191383191384191385191386191387191388191389191390191391191392191393191394191395191396191397191398191399191400191401191402191403191404191405191406191407191408191409191410191411191412191413191414191415191416191417191418191419191420191421191422191423191424191425191426191427191428191429191430191431191432191433191434191435191436191437191438191439191440191441191442191443191444191445191446191447191448191449191450191451191452191453191454191455191456191457191458191459191460191461191462191463191464191465191466191467191468191469191470191471191472191473191474191475191476191477191478191479191480191481191482191483191484191485191486191487191488191489191490191491191492191493191494191495191496191497191498191499191500191501191502191503191504191505191506191507191508191509191510191511191512191513191514191515191516191517191518191519191520191521191522191523191524191525191526191527191528191529191530191531191532191533191534191535191536191537191538191539191540191541191542191543191544191545191546191547191548191549191550191551191552191553191554191555191556191557191558191559191560191561191562191563191564191565191566191567191568191569191570191571191572191573191574191575191576191577191578191579191580191581191582191583191584191585191586191587191588191589191590191591191592191593191594191595191596191597191598191599191600191601191602191603191604191605191606191607191608191609191610191611191612191613191614191615191616191617191618191619191620191621191622191623191624191625191626191627191628191629191630191631191632191633191634191635191636191637191638191639191640191641191642191643191644191645191646191647191648191649191650191651191652191653191654191655191656191657191658191659191660191661191662191663191664191665191666191667191668191669191670191671191672191673191674191675191676191677191678191679191680191681191682191683191684191685191686191687191688191689191690191691191692191693191694191695191696191697191698191699191700191701191702191703191704191705191706191707191708191709191710191711191712191713191714191715191716191717191718191719191720191721191722191723191724191725191726191727191728191729191730191731191732191733191734191735191736191737191738191739191740191741191742191743191744191745191746191747191748191749191750191751191752191753191754191755191756191757191758191759191760191761191762191763191764191765191766191767191768191769191770191771191772191773191774191775191776191777191778191779191780191781191782191783191784191785191786191787191788191789191790191791191792191793191794191795191796191797191798191799191800191801191802191803191804191805191806191807191808191809191810191811191812191813191814191815191816191817191818191819191820191821191822191823191824191825191826191827191828191829191830191831191832191833191834191835191836191837191838191839191840191841191842191843191844191845191846191847191848191849191850191851191852191853191854191855191856191857191858191859191860191861191862191863191864191865191866191867191868191869191870191871191872191873191874191875191876191877191878191879191880191881191882191883191884191885191886191887191888191889191890191891191892191893191894191895191896191897191898191899191900191901191902191903191904191905191906191907191908191909191910191911191912191913191914191915191916191917191918191919191920191921191922191923191924191925191926191927191928191929191930191931191932191933191934191935191936191937191938191939191940191941191942191943191944191945191946191947191948191949191950191951191952191953191954191955191956191957191958191959191960191961191962191963191964191965191966191967191968191969191970191971191972191973191974191975191976191977191978191979191980191981191982191983191984191985191986191987191988191989191990191991191992191993191994191995191996191997191998191999192000192001192002192003192004192005192006192007192008192009192010192011192012192013192014192015192016192017192018192019192020192021192022192023192024192025192026192027192028192029192030192031192032192033192034192035192036192037192038192039192040192041192042192043192044192045192046192047192048192049192050192051192052192053192054192055192056192057192058192059192060192061192062192063192064192065192066192067192068192069192070192071192072192073192074192075192076192077192078192079192080192081192082192083192084192085192086192087192088192089192090192091192092192093192094192095192096192097192098192099192100192101192102192103192104192105192106192107192108192109192110192111192112192113192114192115192116192117192118192119192120192121192122192123192124192125192126192127192128192129192130192131192132192133192134192135192136192137192138192139192140192141192142192143192144192145192146192147192148192149192150192151192152192153192154192155192156192157192158192159192160192161192162192163192164192165192166192167192168192169192170192171192172192173192174192175192176192177192178192179192180192181192182192183192184192185192186192187192188192189192190192191192192192193192194192195192196192197192198192199192200192201192202192203192204192205192206192207192208192209192210192211192212192213192214192215192216192217192218192219192220192221192222192223192224192225192226192227192228192229192230192231192232192233192234192235192236192237192238192239192240192241192242192243192244192245192246192247192248192249192250192251192252192253192254192255192256192257192258192259192260192261192262192263192264192265192266192267192268192269192270192271192272192273192274192275192276192277192278192279192280192281192282192283192284192285192286192287192288192289192290192291192292192293192294192295192296192297192298192299192300192301192302192303192304192305192306192307192308192309192310192311192312192313192314192315192316192317192318192319192320192321192322192323192324192325192326192327192328192329192330192331192332192333192334192335192336192337192338192339192340192341192342192343192344192345192346192347192348192349192350192351192352192353192354192355192356192357192358192359192360192361192362192363192364192365192366192367192368192369192370192371192372192373192374192375192376192377192378192379192380192381192382192383192384192385192386192387192388192389192390192391192392192393192394192395192396192397192398192399192400192401192402192403192404192405192406192407192408192409192410192411192412192413192414192415192416192417192418192419192420192421192422192423192424192425192426192427192428192429192430192431192432192433192434192435192436192437192438192439192440192441192442192443192444192445192446192447192448192449192450192451192452192453192454192455192456192457192458192459192460192461192462192463192464192465192466192467192468192469192470192471192472192473192474192475192476192477192478192479192480192481192482192483192484192485192486192487192488192489192490192491192492192493192494192495192496192497192498192499192500192501192502192503192504192505192506192507192508192509192510192511192512192513192514192515192516192517192518192519192520192521192522192523192524192525192526192527192528192529192530192531192532192533192534192535192536192537192538192539192540192541192542192543192544192545192546192547192548192549192550192551192552192553192554192555192556192557192558192559192560192561192562192563192564192565192566192567192568192569192570192571192572192573192574192575192576192577192578192579192580192581192582192583192584192585192586192587192588192589192590192591192592192593192594192595192596192597192598192599192600192601192602192603192604192605192606192607192608192609192610192611192612192613192614192615192616192617192618192619192620192621192622192623192624192625192626192627192628192629192630192631192632192633192634192635192636192637192638192639192640192641192642192643192644192645192646192647192648192649192650192651192652192653192654192655192656192657192658192659192660192661192662192663192664192665192666192667192668192669192670192671192672192673192674192675192676192677192678192679192680192681192682192683192684192685192686192687192688192689192690192691192692192693192694192695192696192697192698192699192700192701192702192703192704192705192706192707192708192709192710192711192712192713192714192715192716192717192718192719192720192721192722192723192724192725192726192727192728192729192730192731192732192733192734192735192736192737192738192739192740192741192742192743192744192745192746192747192748192749192750192751192752192753192754192755192756192757192758192759192760192761192762192763192764192765192766192767192768192769192770192771192772192773192774192775192776192777192778192779192780192781192782192783192784192785192786192787192788192789192790192791192792192793192794192795192796192797192798192799192800192801192802192803192804192805192806192807192808192809192810192811192812192813192814192815192816192817192818192819192820192821192822192823192824192825192826192827192828192829192830192831192832192833192834192835192836192837192838192839192840192841192842192843192844192845192846192847192848192849192850192851192852192853192854192855192856192857192858192859192860192861192862192863192864192865192866192867192868192869192870192871192872192873192874192875192876192877192878192879192880192881192882192883192884192885192886192887192888192889192890192891192892192893192894192895192896192897192898192899192900192901192902192903192904192905192906192907192908192909192910192911192912192913192914192915192916192917192918192919192920192921192922192923192924192925192926192927192928192929192930192931192932192933192934192935192936192937192938192939192940192941192942192943192944192945192946192947192948192949192950192951192952192953192954192955192956192957192958192959192960192961192962192963192964192965192966192967192968192969192970192971192972192973192974192975192976192977192978192979192980192981192982192983192984192985192986192987192988192989192990192991192992192993192994192995192996192997192998192999193000193001193002193003193004193005193006193007193008193009193010193011193012193013193014193015193016193017193018193019193020193021193022193023193024193025193026193027193028193029193030193031193032193033193034193035193036193037193038193039193040193041193042193043193044193045193046193047193048193049193050193051193052193053193054193055193056193057193058193059193060193061193062193063193064193065193066193067193068193069193070193071193072193073193074193075193076193077193078193079193080193081193082193083193084193085193086193087193088193089193090193091193092193093193094193095193096193097193098193099193100193101193102193103193104193105193106193107193108193109193110193111193112193113193114193115193116193117193118193119193120193121193122193123193124193125193126193127193128193129193130193131193132193133193134193135193136193137193138193139193140193141193142193143193144193145193146193147193148193149193150193151193152193153193154193155193156193157193158193159193160193161193162193163193164193165193166193167193168193169193170193171193172193173193174193175193176193177193178193179193180193181193182193183193184193185193186193187193188193189193190193191193192193193193194193195193196193197193198193199193200193201193202193203193204193205193206193207193208193209193210193211193212193213193214193215193216193217193218193219193220193221193222193223193224193225193226193227193228193229193230193231193232193233193234193235193236193237193238193239193240193241193242193243193244193245193246193247193248193249193250193251193252193253193254193255193256193257193258193259193260193261193262193263193264193265193266193267193268193269193270193271193272193273193274193275193276193277193278193279193280193281193282193283193284193285193286193287193288193289193290193291193292193293193294193295193296193297193298193299193300193301193302193303193304193305193306193307193308193309193310193311193312193313193314193315193316193317193318193319193320193321193322193323193324193325193326193327193328193329193330193331193332193333193334193335193336193337193338193339193340193341193342193343193344193345193346193347193348193349193350193351193352193353193354193355193356193357193358193359193360193361193362193363193364193365193366193367193368193369193370193371193372193373193374193375193376193377193378193379193380193381193382193383193384193385193386193387193388193389193390193391193392193393193394193395193396193397193398193399193400193401193402193403193404193405193406193407193408193409193410193411193412193413193414193415193416193417193418193419193420193421193422193423193424193425193426193427193428193429193430193431193432193433193434193435193436193437193438193439193440193441193442193443193444193445193446193447193448193449193450193451193452193453193454193455193456193457193458193459193460193461193462193463193464193465193466193467193468193469193470193471193472193473193474193475193476193477193478193479193480193481193482193483193484193485193486193487193488193489193490193491193492193493193494193495193496193497193498193499193500193501193502193503193504193505193506193507193508193509193510193511193512193513193514193515193516193517193518193519193520193521193522193523193524193525193526193527193528193529193530193531193532193533193534193535193536193537193538193539193540193541193542193543193544193545193546193547193548193549193550193551193552193553193554193555193556193557193558193559193560193561193562193563193564193565193566193567193568193569193570193571193572193573193574193575193576193577193578193579193580193581193582193583193584193585193586193587193588193589193590193591193592193593193594193595193596193597193598193599193600193601193602193603193604193605193606193607193608193609193610193611193612193613193614193615193616193617193618193619193620193621193622193623193624193625193626193627193628193629193630193631193632193633193634193635193636193637193638193639193640193641193642193643193644193645193646193647193648193649193650193651193652193653193654193655193656193657193658193659193660193661193662193663193664193665193666193667193668193669193670193671193672193673193674193675193676193677193678193679193680193681193682193683193684193685193686193687193688193689193690193691193692193693193694193695193696193697193698193699193700193701193702193703193704193705193706193707193708193709193710193711193712193713193714193715193716193717193718193719193720193721193722193723193724193725193726193727193728193729193730193731193732193733193734193735193736193737193738193739193740193741193742193743193744193745193746193747193748193749193750193751193752193753193754193755193756193757193758193759193760193761193762193763193764193765193766193767193768193769193770193771193772193773193774193775193776193777193778193779193780193781193782193783193784193785193786193787193788193789193790193791193792193793193794193795193796193797193798193799193800193801193802193803193804193805193806193807193808193809193810193811193812193813193814193815193816193817193818193819193820193821193822193823193824193825193826193827193828193829193830193831193832193833193834193835193836193837193838193839193840193841193842193843193844193845193846193847193848193849193850193851193852193853193854193855193856193857193858193859193860193861193862193863193864193865193866193867193868193869193870193871193872193873193874193875193876193877193878193879193880193881193882193883193884193885193886193887193888193889193890193891193892193893193894193895193896193897193898193899193900193901193902193903193904193905193906193907193908193909193910193911193912193913193914193915193916193917193918193919193920193921193922193923193924193925193926193927193928193929193930193931193932193933193934193935193936193937193938193939193940193941193942193943193944193945193946193947193948193949193950193951193952193953193954193955193956193957193958193959193960193961193962193963193964193965193966193967193968193969193970193971193972193973193974193975193976193977193978193979193980193981193982193983193984193985193986193987193988193989193990193991193992193993193994193995193996193997193998193999194000194001194002194003194004194005194006194007194008194009194010194011194012194013194014194015194016194017194018194019194020194021194022194023194024194025194026194027194028194029194030194031194032194033194034194035194036194037194038194039194040194041194042194043194044194045194046194047194048194049194050194051194052194053194054194055194056194057194058194059194060194061194062194063194064194065194066194067194068194069194070194071194072194073194074194075194076194077194078194079194080194081194082194083194084194085194086194087194088194089194090194091194092194093194094194095194096194097194098194099194100194101194102194103194104194105194106194107194108194109194110194111194112194113194114194115194116194117194118194119194120194121194122194123194124194125194126194127194128194129194130194131194132194133194134194135194136194137194138194139194140194141194142194143194144194145194146194147194148194149194150194151194152194153194154194155194156194157194158194159194160194161194162194163194164194165194166194167194168194169194170194171194172194173194174194175194176194177194178194179194180194181194182194183194184194185194186194187194188194189194190194191194192194193194194194195194196194197194198194199194200194201194202194203194204194205194206194207194208194209194210194211194212194213194214194215194216194217194218194219194220194221194222194223194224194225194226194227194228194229194230194231194232194233194234194235194236194237194238194239194240194241194242194243194244194245194246194247194248194249194250194251194252194253194254194255194256194257194258194259194260194261194262194263194264194265194266194267194268194269194270194271194272194273194274194275194276194277194278194279194280194281194282194283194284194285194286194287194288194289194290194291194292194293194294194295194296194297194298194299194300194301194302194303194304194305194306194307194308194309194310194311194312194313194314194315194316194317194318194319194320194321194322194323194324194325194326194327194328194329194330194331194332194333194334194335194336194337194338194339194340194341194342194343194344194345194346194347194348194349194350194351194352194353194354194355194356194357194358194359194360194361194362194363194364194365194366194367194368194369194370194371194372194373194374194375194376194377194378194379194380194381194382194383194384194385194386194387194388194389194390194391194392194393194394194395194396194397194398194399194400194401194402194403194404194405194406194407194408194409194410194411194412194413194414194415194416194417194418194419194420194421194422194423194424194425194426194427194428194429194430194431194432194433194434194435194436194437194438194439194440194441194442194443194444194445194446194447194448194449194450194451194452194453194454194455194456194457194458194459194460194461194462194463194464194465194466194467194468194469194470194471194472194473194474194475194476194477194478194479194480194481194482194483194484194485194486194487194488194489194490194491194492194493194494194495194496194497194498194499194500194501194502194503194504194505194506194507194508194509194510194511194512194513194514194515194516194517194518194519194520194521194522194523194524194525194526194527194528194529194530194531194532194533194534194535194536194537194538194539194540194541194542194543194544194545194546194547194548194549194550194551194552194553194554194555194556194557194558194559194560194561194562194563194564194565194566194567194568194569194570194571194572194573194574194575194576194577194578194579194580194581194582194583194584194585194586194587194588194589194590194591194592194593194594194595194596194597194598194599194600194601194602194603194604194605194606194607194608194609194610194611194612194613194614194615194616194617194618194619194620194621194622194623194624194625194626194627194628194629194630194631194632194633194634194635194636194637194638194639194640194641194642194643194644194645194646194647194648194649194650194651194652194653194654194655194656194657194658194659194660194661194662194663194664194665194666194667194668194669194670194671194672194673194674194675194676194677194678194679194680194681194682194683194684194685194686194687194688194689194690194691194692194693194694194695194696194697194698194699194700194701194702194703194704194705194706194707194708194709194710194711194712194713194714194715194716194717194718194719194720194721194722194723194724194725194726194727194728194729194730194731194732194733194734194735194736194737194738194739194740194741194742194743194744194745194746194747194748194749194750194751194752194753194754194755194756194757194758194759194760194761194762194763194764194765194766194767194768194769194770194771194772194773194774194775194776194777194778194779194780194781194782194783194784194785194786194787194788194789194790194791194792194793194794194795194796194797194798194799194800194801194802194803194804194805194806194807194808194809194810194811194812194813194814194815194816194817194818194819194820194821194822194823194824194825194826194827194828194829194830194831194832194833194834194835194836194837194838194839194840194841194842194843194844194845194846194847194848194849194850194851194852194853194854194855194856194857194858194859194860194861194862194863194864194865194866194867194868194869194870194871194872194873194874194875194876194877194878194879194880194881194882194883194884194885194886194887194888194889194890194891194892194893194894194895194896194897194898194899194900194901194902194903194904194905194906194907194908194909194910194911194912194913194914194915194916194917194918194919194920194921194922194923194924194925194926194927194928194929194930194931194932194933194934194935194936194937194938194939194940194941194942194943194944194945194946194947194948194949194950194951194952194953194954194955194956194957194958194959194960194961194962194963194964194965194966194967194968194969194970194971194972194973194974194975194976194977194978194979194980194981194982194983194984194985194986194987194988194989194990194991194992194993194994194995194996194997194998194999195000195001195002195003195004195005195006195007195008195009195010195011195012195013195014195015195016195017195018195019195020195021195022195023195024195025195026195027195028195029195030195031195032195033195034195035195036195037195038195039195040195041195042195043195044195045195046195047195048195049195050195051195052195053195054195055195056195057195058195059195060195061195062195063195064195065195066195067195068195069195070195071195072195073195074195075195076195077195078195079195080195081195082195083195084195085195086195087195088195089195090195091195092195093195094195095195096195097195098195099195100195101195102195103195104195105195106195107195108195109195110195111195112195113195114195115195116195117195118195119195120195121195122195123195124195125195126195127195128195129195130195131195132195133195134195135195136195137195138195139195140195141195142195143195144195145195146195147195148195149195150195151195152195153195154195155195156195157195158195159195160195161195162195163195164195165195166195167195168195169195170195171195172195173195174195175195176195177195178195179195180195181195182195183195184195185195186195187195188195189195190195191195192195193195194195195195196195197195198195199195200195201195202195203195204195205195206195207195208195209195210195211195212195213195214195215195216195217195218195219195220195221195222195223195224195225195226195227195228195229195230195231195232195233195234195235195236195237195238195239195240195241195242195243195244195245195246195247195248195249195250195251195252195253195254195255195256195257195258195259195260195261195262195263195264195265195266195267195268195269195270195271195272195273195274195275195276195277195278195279195280195281195282195283195284195285195286195287195288195289195290195291195292195293195294195295195296195297195298195299195300195301195302195303195304195305195306195307195308195309195310195311195312195313195314195315195316195317195318195319195320195321195322195323195324195325195326195327195328195329195330195331195332195333195334195335195336195337195338195339195340195341195342195343195344195345195346195347195348195349195350195351195352195353195354195355195356195357195358195359195360195361195362195363195364195365195366195367195368195369195370195371195372195373195374195375195376195377195378195379195380195381195382195383195384195385195386195387195388195389195390195391195392195393195394195395195396195397195398195399195400195401195402195403195404195405195406195407195408195409195410195411195412195413195414195415195416195417195418195419195420195421195422195423195424195425195426195427195428195429195430195431195432195433195434195435195436195437195438195439195440195441195442195443195444195445195446195447195448195449195450195451195452195453195454195455195456195457195458195459195460195461195462195463195464195465195466195467195468195469195470195471195472195473195474195475195476195477195478195479195480195481195482195483195484195485195486195487195488195489195490195491195492195493195494195495195496195497195498195499195500195501195502195503195504195505195506195507195508195509195510195511195512195513195514195515195516195517195518195519195520195521195522195523195524195525195526195527195528195529195530195531195532195533195534195535195536195537195538195539195540195541195542195543195544195545195546195547195548195549195550195551195552195553195554195555195556195557195558195559195560195561195562195563195564195565195566195567195568195569195570195571195572195573195574195575195576195577195578195579195580195581195582195583195584195585195586195587195588195589195590195591195592195593195594195595195596195597195598195599195600195601195602195603195604195605195606195607195608195609195610195611195612195613195614195615195616195617195618195619195620195621195622195623195624195625195626195627195628195629195630195631195632195633195634195635195636195637195638195639195640195641195642195643195644195645195646195647195648195649195650195651195652195653195654195655195656195657195658195659195660195661195662195663195664195665195666195667195668195669195670195671195672195673195674195675195676195677195678195679195680195681195682195683195684195685195686195687195688195689195690195691195692195693195694195695195696195697195698195699195700195701195702195703195704195705195706195707195708195709195710195711195712195713195714195715195716195717195718195719195720195721195722195723195724195725195726195727195728195729195730195731195732195733195734195735195736195737195738195739195740195741195742195743195744195745195746195747195748195749195750195751195752195753195754195755195756195757195758195759195760195761195762195763195764195765195766195767195768195769195770195771195772195773195774195775195776195777195778195779195780195781195782195783195784195785195786195787195788195789195790195791195792195793195794195795195796195797195798195799195800195801195802195803195804195805195806195807195808195809195810195811195812195813195814195815195816195817195818195819195820195821195822195823195824195825195826195827195828195829195830195831195832195833195834195835195836195837195838195839195840195841195842195843195844195845195846195847195848195849195850195851195852195853195854195855195856195857195858195859195860195861195862195863195864195865195866195867195868195869195870195871195872195873195874195875195876195877195878195879195880195881195882195883195884195885195886195887195888195889195890195891195892195893195894195895195896195897195898195899195900195901195902195903195904195905195906195907195908195909195910195911195912195913195914195915195916195917195918195919195920195921195922195923195924195925195926195927195928195929195930195931195932195933195934195935195936195937195938195939195940195941195942195943195944195945195946195947195948195949195950195951195952195953195954195955195956195957195958195959195960195961195962195963195964195965195966195967195968195969195970195971195972195973195974195975195976195977195978195979195980195981195982195983195984195985195986195987195988195989195990195991195992195993195994195995195996195997195998195999196000196001196002196003196004196005196006196007196008196009196010196011196012196013196014196015196016196017196018196019196020196021196022196023196024196025196026196027196028196029196030196031196032196033196034196035196036196037196038196039196040196041196042196043196044196045196046196047196048196049196050196051196052196053196054196055196056196057196058196059196060196061196062196063196064196065196066196067196068196069196070196071196072196073196074196075196076196077196078196079196080196081196082196083196084196085196086196087196088196089196090196091196092196093196094196095196096196097196098196099196100196101196102196103196104196105196106196107196108196109196110196111196112196113196114196115196116196117196118196119196120196121196122196123196124196125196126196127196128196129196130196131196132196133196134196135196136196137196138196139196140196141196142196143196144196145196146196147196148196149196150196151196152196153196154196155196156196157196158196159196160196161196162196163196164196165196166196167196168196169196170196171196172196173196174196175196176196177196178196179196180196181196182196183196184196185196186196187196188196189196190196191196192196193196194196195196196196197196198196199196200196201196202196203196204196205196206196207196208196209196210196211196212196213196214196215196216196217196218196219196220196221196222196223196224196225196226196227196228196229196230196231196232196233196234196235196236196237196238196239196240196241196242196243196244196245196246196247196248196249196250196251196252196253196254196255196256196257196258196259196260196261196262196263196264196265196266196267196268196269196270196271196272196273196274196275196276196277196278196279196280196281196282196283196284196285196286196287196288196289196290196291196292196293196294196295196296196297196298196299196300196301196302196303196304196305196306196307196308196309196310196311196312196313196314196315196316196317196318196319196320196321196322196323196324196325196326196327196328196329196330196331196332196333196334196335196336196337196338196339196340196341196342196343196344196345196346196347196348196349196350196351196352196353196354196355196356196357196358196359196360196361196362196363196364196365196366196367196368196369196370196371196372196373196374196375196376196377196378196379196380196381196382196383196384196385196386196387196388196389196390196391196392196393196394196395196396196397196398196399196400196401196402196403196404196405196406196407196408196409196410196411196412196413196414196415196416196417196418196419196420196421196422196423196424196425196426196427196428196429196430196431196432196433196434196435196436196437196438196439196440196441196442196443196444196445196446196447196448196449196450196451196452196453196454196455196456196457196458196459196460196461196462196463196464196465196466196467196468196469196470196471196472196473196474196475196476196477196478196479196480196481196482196483196484196485196486196487196488196489196490196491196492196493196494196495196496196497196498196499196500196501196502196503196504196505196506196507196508196509196510196511196512196513196514196515196516196517196518196519196520196521196522196523196524196525196526196527196528196529196530196531196532196533196534196535196536196537196538196539196540196541196542196543196544196545196546196547196548196549196550196551196552196553196554196555196556196557196558196559196560196561196562196563196564196565196566196567196568196569196570196571196572196573196574196575196576196577196578196579196580196581196582196583196584196585196586196587196588196589196590196591196592196593196594196595196596196597196598196599196600196601196602196603196604196605196606196607196608196609196610196611196612196613196614196615196616196617196618196619196620196621196622196623196624196625196626196627196628196629196630196631196632196633196634196635196636196637196638196639196640196641196642196643196644196645196646196647196648196649196650196651196652196653196654196655196656196657196658196659196660196661196662196663196664196665196666196667196668196669196670196671196672196673196674196675196676196677196678196679196680196681196682196683196684196685196686196687196688196689196690196691196692196693196694196695196696196697196698196699196700196701196702196703196704196705196706196707196708196709196710196711196712196713196714196715196716196717196718196719196720196721196722196723196724196725196726196727196728196729196730196731196732196733196734196735196736196737196738196739196740196741196742196743196744196745196746196747196748196749196750196751196752196753196754196755196756196757196758196759196760196761196762196763196764196765196766196767196768196769196770196771196772196773196774196775196776196777196778196779196780196781196782196783196784196785196786196787196788196789196790196791196792196793196794196795196796196797196798196799196800196801196802196803196804196805196806196807196808196809196810196811196812196813196814196815196816196817196818196819196820196821196822196823196824196825196826196827196828196829196830196831196832196833196834196835196836196837196838196839196840196841196842196843196844196845196846196847196848196849196850196851196852196853196854196855196856196857196858196859196860196861196862196863196864196865196866196867196868196869196870196871196872196873196874196875196876196877196878196879196880196881196882196883196884196885196886196887196888196889196890196891196892196893196894196895196896196897196898196899196900196901196902196903196904196905196906196907196908196909196910196911196912196913196914196915196916196917196918196919196920196921196922196923196924196925196926196927196928196929196930196931196932196933196934196935196936196937196938196939196940196941196942196943196944196945196946196947196948196949196950196951196952196953196954196955196956196957196958196959196960196961196962196963196964196965196966196967196968196969196970196971196972196973196974196975196976196977196978196979196980196981196982196983196984196985196986196987196988196989196990196991196992196993196994196995196996196997196998196999197000197001197002197003197004197005197006197007197008197009197010197011197012197013197014197015197016197017197018197019197020197021197022197023197024197025197026197027197028197029197030197031197032197033197034197035197036197037197038197039197040197041197042197043197044197045197046197047197048197049197050197051197052197053197054197055197056197057197058197059197060197061197062197063197064197065197066197067197068197069197070197071197072197073197074197075197076197077197078197079197080197081197082197083197084197085197086197087197088197089197090197091197092197093197094197095197096197097197098197099197100197101197102197103197104197105197106197107197108197109197110197111197112197113197114197115197116197117197118197119197120197121197122197123197124197125197126197127197128197129197130197131197132197133197134197135197136197137197138197139197140197141197142197143197144197145197146197147197148197149197150197151197152197153197154197155197156197157197158197159197160197161197162197163197164197165197166197167197168197169197170197171197172197173197174197175197176197177197178197179197180197181197182197183197184197185197186197187197188197189197190197191197192197193197194197195197196197197197198197199197200197201197202197203197204197205197206197207197208197209197210197211197212197213197214197215197216197217197218197219197220197221197222197223197224197225197226197227197228197229197230197231197232197233197234197235197236197237197238197239197240197241197242197243197244197245197246197247197248197249197250197251197252197253197254197255197256197257197258197259197260197261197262197263197264197265197266197267197268197269197270197271197272197273197274197275197276197277197278197279197280197281197282197283197284197285197286197287197288197289197290197291197292197293197294197295197296197297197298197299197300197301197302197303197304197305197306197307197308197309197310197311197312197313197314197315197316197317197318197319197320197321197322197323197324197325197326197327197328197329197330197331197332197333197334197335197336197337197338197339197340197341197342197343197344197345197346197347197348197349197350197351197352197353197354197355197356197357197358197359197360197361197362197363197364197365197366197367197368197369197370197371197372197373197374197375197376197377197378197379197380197381197382197383197384197385197386197387197388197389197390197391197392197393197394197395197396197397197398197399197400197401197402197403197404197405197406197407197408197409197410197411197412197413197414197415197416197417197418197419197420197421197422197423197424197425197426197427197428197429197430197431197432197433197434197435197436197437197438197439197440197441197442197443197444197445197446197447197448197449197450197451197452197453197454197455197456197457197458197459197460197461197462197463197464197465197466197467197468197469197470197471197472197473197474197475197476197477197478197479197480197481197482197483197484197485197486197487197488197489197490197491197492197493197494197495197496197497197498197499197500197501197502197503197504197505197506197507197508197509197510197511197512197513197514197515197516197517197518197519197520197521197522197523197524197525197526197527197528197529197530197531197532197533197534197535197536197537197538197539197540197541197542197543197544197545197546197547197548197549197550197551197552197553197554197555197556197557197558197559197560197561197562197563197564197565197566197567197568197569197570197571197572197573197574197575197576197577197578197579197580197581197582197583197584197585197586197587197588197589197590197591197592197593197594197595197596197597197598197599197600197601197602197603197604197605197606197607197608197609197610197611197612197613197614197615197616197617197618197619197620197621197622197623197624197625197626197627197628197629197630197631197632197633197634197635197636197637197638197639197640197641197642197643197644197645197646197647197648197649197650197651197652197653197654197655197656197657197658197659197660197661197662197663197664197665197666197667197668197669197670197671197672197673197674197675197676197677197678197679197680197681197682197683197684197685197686197687197688197689197690197691197692197693197694197695197696197697197698197699197700197701197702197703197704197705197706197707197708197709197710197711197712197713197714197715197716197717197718197719197720197721197722197723197724197725197726197727197728197729197730197731197732197733197734197735197736197737197738197739197740197741197742197743197744197745197746197747197748197749197750197751197752197753197754197755197756197757197758197759197760197761197762197763197764197765197766197767197768197769197770197771197772197773197774197775197776197777197778197779197780197781197782197783197784197785197786197787197788197789197790197791197792197793197794197795197796197797197798197799197800197801197802197803197804197805197806197807197808197809197810197811197812197813197814197815197816197817197818197819197820197821197822197823197824197825197826197827197828197829197830197831197832197833197834197835197836197837197838197839197840197841197842197843197844197845197846197847197848197849197850197851197852197853197854197855197856197857197858197859197860197861197862197863197864197865197866197867197868197869197870197871197872197873197874197875197876197877197878197879197880197881197882197883197884197885197886197887197888197889197890197891197892197893197894197895197896197897197898197899197900197901197902197903197904197905197906197907197908197909197910197911197912197913197914197915197916197917197918197919197920197921197922197923197924197925197926197927197928197929197930197931197932197933197934197935197936197937197938197939197940197941197942197943197944197945197946197947197948197949197950197951197952197953197954197955197956197957197958197959197960197961197962197963197964197965197966197967197968197969197970197971197972197973197974197975197976197977197978197979197980197981197982197983197984197985197986197987197988197989197990197991197992197993197994197995197996197997197998197999198000198001198002198003198004198005198006198007198008198009198010198011198012198013198014198015198016198017198018198019198020198021198022198023198024198025198026198027198028198029198030198031198032198033198034198035198036198037198038198039198040198041198042198043198044198045198046198047198048198049198050198051198052198053198054198055198056198057198058198059198060198061198062198063198064198065198066198067198068198069198070198071198072198073198074198075198076198077198078198079198080198081198082198083198084198085198086198087198088198089198090198091198092198093198094198095198096198097198098198099198100198101198102198103198104198105198106198107198108198109198110198111198112198113198114198115198116198117198118198119198120198121198122198123198124198125198126198127198128198129198130198131198132198133198134198135198136198137198138198139198140198141198142198143198144198145198146198147198148198149198150198151198152198153198154198155198156198157198158198159198160198161198162198163198164198165198166198167198168198169198170198171198172198173198174198175198176198177198178198179198180198181198182198183198184198185198186198187198188198189198190198191198192198193198194198195198196198197198198198199198200198201198202198203198204198205198206198207198208198209198210198211198212198213198214198215198216198217198218198219198220198221198222198223198224198225198226198227198228198229198230198231198232198233198234198235198236198237198238198239198240198241198242198243198244198245198246198247198248198249198250198251198252198253198254198255198256198257198258198259198260198261198262198263198264198265198266198267198268198269198270198271198272198273198274198275198276198277198278198279198280198281198282198283198284198285198286198287198288198289198290198291198292198293198294198295198296198297198298198299198300198301198302198303198304198305198306198307198308198309198310198311198312198313198314198315198316198317198318198319198320198321198322198323198324198325198326198327198328198329198330198331198332198333198334198335198336198337198338198339198340198341198342198343198344198345198346198347198348198349198350198351198352198353198354198355198356198357198358198359198360198361198362198363198364198365198366198367198368198369198370198371198372198373198374198375198376198377198378198379198380198381198382198383198384198385198386198387198388198389198390198391198392198393198394198395198396198397198398198399198400198401198402198403198404198405198406198407198408198409198410198411198412198413198414198415198416198417198418198419198420198421198422198423198424198425198426198427198428198429198430198431198432198433198434198435198436198437198438198439198440198441198442198443198444198445198446198447198448198449198450198451198452198453198454198455198456198457198458198459198460198461198462198463198464198465198466198467198468198469198470198471198472198473198474198475198476198477198478198479198480198481198482198483198484198485198486198487198488198489198490198491198492198493198494198495198496198497198498198499198500198501198502198503198504198505198506198507198508198509198510198511198512198513198514198515198516198517198518198519198520198521198522198523198524198525198526198527198528198529198530198531198532198533198534198535198536198537198538198539198540198541198542198543198544198545198546198547198548198549198550198551198552198553198554198555198556198557198558198559198560198561198562198563198564198565198566198567198568198569198570198571198572198573198574198575198576198577198578198579198580198581198582198583198584198585198586198587198588198589198590198591198592198593198594198595198596198597198598198599198600198601198602198603198604198605198606198607198608198609198610198611198612198613198614198615198616198617198618198619198620198621198622198623198624198625198626198627198628198629198630198631198632198633198634198635198636198637198638198639198640198641198642198643198644198645198646198647198648198649198650198651198652198653198654198655198656198657198658198659198660198661198662198663198664198665198666198667198668198669198670198671198672198673198674198675198676198677198678198679198680198681198682198683198684198685198686198687198688198689198690198691198692198693198694198695198696198697198698198699198700198701198702198703198704198705198706198707198708198709198710198711198712198713198714198715198716198717198718198719198720198721198722198723198724198725198726198727198728198729198730198731198732198733198734198735198736198737198738198739198740198741198742198743198744198745198746198747198748198749198750198751198752198753198754198755198756198757198758198759198760198761198762198763198764198765198766198767198768198769198770198771198772198773198774198775198776198777198778198779198780198781198782198783198784198785198786198787198788198789198790198791198792198793198794198795198796198797198798198799198800198801198802198803198804198805198806198807198808198809198810198811198812198813198814198815198816198817198818198819198820198821198822198823198824198825198826198827198828198829198830198831198832198833198834198835198836198837198838198839198840198841198842198843198844198845198846198847198848198849198850198851198852198853198854198855198856198857198858198859198860198861198862198863198864198865198866198867198868198869198870198871198872198873198874198875198876198877198878198879198880198881198882198883198884198885198886198887198888198889198890198891198892198893198894198895198896198897198898198899198900198901198902198903198904198905198906198907198908198909198910198911198912198913198914198915198916198917198918198919198920198921198922198923198924198925198926198927198928198929198930198931198932198933198934198935198936198937198938198939198940198941198942198943198944198945198946198947198948198949198950198951198952198953198954198955198956198957198958198959198960198961198962198963198964198965198966198967198968198969198970198971198972198973198974198975198976198977198978198979198980198981198982198983198984198985198986198987198988198989198990198991198992198993198994198995198996198997198998198999199000199001199002199003199004199005199006199007199008199009199010199011199012199013199014199015199016199017199018199019199020199021199022199023199024199025199026199027199028199029199030199031199032199033199034199035199036199037199038199039199040199041199042199043199044199045199046199047199048199049199050199051199052199053199054199055199056199057199058199059199060199061199062199063199064199065199066199067199068199069199070199071199072199073199074199075199076199077199078199079199080199081199082199083199084199085199086199087199088199089199090199091199092199093199094199095199096199097199098199099199100199101199102199103199104199105199106199107199108199109199110199111199112199113199114199115199116199117199118199119199120199121199122199123199124199125199126199127199128199129199130199131199132199133199134199135199136199137199138199139199140199141199142199143199144199145199146199147199148199149199150199151199152199153199154199155199156199157199158199159199160199161199162199163199164199165199166199167199168199169199170199171199172199173199174199175199176199177199178199179199180199181199182199183199184199185199186199187199188199189199190199191199192199193199194199195199196199197199198199199199200199201199202199203199204199205199206199207199208199209199210199211199212199213199214199215199216199217199218199219199220199221199222199223199224199225199226199227199228199229199230199231199232199233199234199235199236199237199238199239199240199241199242199243199244199245199246199247199248199249199250199251199252199253199254199255199256199257199258199259199260199261199262199263199264199265199266199267199268199269199270199271199272199273199274199275199276199277199278199279199280199281199282199283199284199285199286199287199288199289199290199291199292199293199294199295199296199297199298199299199300199301199302199303199304199305199306199307199308199309199310199311199312199313199314199315199316199317199318199319199320199321199322199323199324199325199326199327199328199329199330199331199332199333199334199335199336199337199338199339199340199341199342199343199344199345199346199347199348199349199350199351199352199353199354199355199356199357199358199359199360199361199362199363199364199365199366199367199368199369199370199371199372199373199374199375199376199377199378199379199380199381199382199383199384199385199386199387199388199389199390199391199392199393199394199395199396199397199398199399199400199401199402199403199404199405199406199407199408199409199410199411199412199413199414199415199416199417199418199419199420199421199422199423199424199425199426199427199428199429199430199431199432199433199434199435199436199437199438199439199440199441199442199443199444199445199446199447199448199449199450199451199452199453199454199455199456199457199458199459199460199461199462199463199464199465199466199467199468199469199470199471199472199473199474199475199476199477199478199479199480199481199482199483199484199485199486199487199488199489199490199491199492199493199494199495199496199497199498199499199500199501199502199503199504199505199506199507199508199509199510199511199512199513199514199515199516199517199518199519199520199521199522199523199524199525199526199527199528199529199530199531199532199533199534199535199536199537199538199539199540199541199542199543199544199545199546199547199548199549199550199551199552199553199554199555199556199557199558199559199560199561199562199563199564199565199566199567199568199569199570199571199572199573199574199575199576199577199578199579199580199581199582199583199584199585199586199587199588199589199590199591199592199593199594199595199596199597199598199599199600199601199602199603199604199605199606199607199608199609199610199611199612199613199614199615199616199617199618199619199620199621199622199623199624199625199626199627199628199629199630199631199632199633199634199635199636199637199638199639199640199641199642199643199644199645199646199647199648199649199650199651199652199653199654199655199656199657199658199659199660199661199662199663199664199665199666199667199668199669199670199671199672199673199674199675199676199677199678199679199680199681199682199683199684199685199686199687199688199689199690199691199692199693199694199695199696199697199698199699199700199701199702199703199704199705199706199707199708199709199710199711199712199713199714199715199716199717199718199719199720199721199722199723199724199725199726199727199728199729199730199731199732199733199734199735199736199737199738199739199740199741199742199743199744199745199746199747199748199749199750199751199752199753199754199755199756199757199758199759199760199761199762199763199764199765199766199767199768199769199770199771199772199773199774199775199776199777199778199779199780199781199782199783199784199785199786199787199788199789199790199791199792199793199794199795199796199797199798199799199800199801199802199803199804199805199806199807199808199809199810199811199812199813199814199815199816199817199818199819199820199821199822199823199824199825199826199827199828199829199830199831199832199833199834199835199836199837199838199839199840199841199842199843199844199845199846199847199848199849199850199851199852199853199854199855199856199857199858199859199860199861199862199863199864199865199866199867199868199869199870199871199872199873199874199875199876199877199878199879199880199881199882199883199884199885199886199887199888199889199890199891199892199893199894199895199896199897199898199899199900199901199902199903199904199905199906199907199908199909199910199911199912199913199914199915199916199917199918199919199920199921199922199923199924199925199926199927199928199929199930199931199932199933199934199935199936199937199938199939199940199941199942199943199944199945199946199947199948199949199950199951199952199953199954199955199956199957199958199959199960199961199962199963199964199965199966199967199968199969199970199971199972199973199974199975199976199977199978199979199980199981199982199983199984199985199986199987199988199989199990199991199992199993199994199995199996199997199998199999200000200001200002200003200004200005200006200007200008200009200010200011200012200013200014200015200016200017200018200019200020200021200022200023200024200025200026200027200028200029200030200031200032200033200034200035200036200037200038200039200040200041200042200043200044200045200046200047200048200049200050200051200052200053200054200055200056200057200058200059200060200061200062200063200064200065200066200067200068200069200070200071200072200073200074200075200076200077200078200079200080200081200082200083200084200085200086200087200088200089200090200091200092200093200094200095200096200097200098200099200100200101200102200103200104200105200106200107200108200109200110200111200112200113200114200115200116200117200118200119200120200121200122200123200124200125200126200127200128200129200130200131200132200133200134200135200136200137200138200139200140200141200142200143200144200145200146200147200148200149200150200151200152200153200154200155200156200157200158200159200160200161200162200163200164200165200166200167200168200169200170200171200172200173200174200175200176200177200178200179200180200181200182200183200184200185200186200187200188200189200190200191200192200193200194200195200196200197200198200199200200200201200202200203200204200205200206200207200208200209200210200211200212200213200214200215200216200217200218200219200220200221200222200223200224200225200226200227200228200229200230200231200232200233200234200235200236200237200238200239200240200241200242200243200244200245200246200247200248200249200250200251200252200253200254200255200256200257200258200259200260200261200262200263200264200265200266200267200268200269200270200271200272200273200274200275200276200277200278200279200280200281200282200283200284200285200286200287200288200289200290200291200292200293200294200295200296200297200298200299200300200301200302200303200304200305200306200307200308200309200310200311200312200313200314200315200316200317200318200319200320200321200322200323200324200325200326200327200328200329200330200331200332200333200334200335200336200337200338200339200340200341200342200343200344200345200346200347200348200349200350200351200352200353200354200355200356200357200358200359200360200361200362200363200364200365200366200367200368200369200370200371200372200373200374200375200376200377200378200379200380200381200382200383200384200385200386200387200388200389200390200391200392200393200394200395200396200397200398200399200400200401200402200403200404200405200406200407200408200409200410200411200412200413200414200415200416200417200418200419200420200421200422200423200424200425200426200427200428200429200430200431200432200433200434200435200436200437200438200439200440200441200442200443200444200445200446200447200448200449200450200451200452200453200454200455200456200457200458200459200460200461200462200463200464200465200466200467200468200469200470200471200472200473200474200475200476200477200478200479200480200481200482200483200484200485200486200487200488200489200490200491200492200493200494200495200496200497200498200499200500200501200502200503200504200505200506200507200508200509200510200511200512200513200514200515200516200517200518200519200520200521200522200523200524200525200526200527200528200529200530200531200532200533200534200535200536200537200538200539200540200541200542200543200544200545200546200547200548200549200550200551200552200553200554200555200556200557200558200559200560200561200562200563200564200565200566200567200568200569200570200571200572200573200574200575200576200577200578200579200580200581200582200583200584200585200586200587200588200589200590200591200592200593200594200595200596200597200598200599200600200601200602200603200604200605200606200607200608200609200610200611200612200613200614200615200616200617200618200619200620200621200622200623200624200625200626200627200628200629200630200631200632200633200634200635200636200637200638200639200640200641200642200643200644200645200646200647200648200649200650200651200652200653200654200655200656200657200658200659200660200661200662200663200664200665200666200667200668200669200670200671200672200673200674200675200676200677200678200679200680200681200682200683200684200685200686200687200688200689200690200691200692200693200694200695200696200697200698200699200700200701200702200703200704200705200706200707200708200709200710200711200712200713200714200715200716200717200718200719200720200721200722200723200724200725200726200727200728200729200730200731200732200733200734200735200736200737200738200739200740200741200742200743200744200745200746200747200748200749200750200751200752200753200754200755200756200757200758200759200760200761200762200763200764200765200766200767200768200769200770200771200772200773200774200775200776200777200778200779200780200781200782200783200784200785200786200787200788200789200790200791200792200793200794200795200796200797200798200799200800200801200802200803200804200805200806200807200808200809200810200811200812200813200814200815200816200817200818200819200820200821200822200823200824200825200826200827200828200829200830200831200832200833200834200835200836200837200838200839200840200841200842200843200844200845200846200847200848200849200850200851200852200853200854200855200856200857200858200859200860200861200862200863200864200865200866200867200868200869200870200871200872200873200874200875200876200877200878200879200880200881200882200883200884200885200886200887200888200889200890200891200892200893200894200895200896200897200898200899200900200901200902200903200904200905200906200907200908200909200910200911200912200913200914200915200916200917200918200919200920200921200922200923200924200925200926200927200928200929200930200931200932200933200934200935200936200937200938200939200940200941200942200943200944200945200946200947200948200949200950200951200952200953200954200955200956200957200958200959200960200961200962200963200964200965200966200967200968200969200970200971200972200973200974200975200976200977200978200979200980200981200982200983200984200985200986200987200988200989200990200991200992200993200994200995200996200997200998200999201000201001201002201003201004201005201006201007201008201009201010201011201012201013201014201015201016201017201018201019201020201021201022201023201024201025201026201027201028201029201030201031201032201033201034201035201036201037201038201039201040201041201042201043201044201045201046201047201048201049201050201051201052201053201054201055201056201057201058201059201060201061201062201063201064201065201066201067201068201069201070201071201072201073201074201075201076201077201078201079201080201081201082201083201084201085201086201087201088201089201090201091201092201093201094201095201096201097201098201099201100201101201102201103201104201105201106201107201108201109201110201111201112201113201114201115201116201117201118201119201120201121201122201123201124201125201126201127201128201129201130201131201132201133201134201135201136201137201138201139201140201141201142201143201144201145201146201147201148201149201150201151201152201153201154201155201156201157201158201159201160201161201162201163201164201165201166201167201168201169201170201171201172201173201174201175201176201177201178201179201180201181201182201183201184201185201186201187201188201189201190201191201192201193201194201195201196201197201198201199201200201201201202201203201204201205201206201207201208201209201210201211201212201213201214201215201216201217201218201219201220201221201222201223201224201225201226201227201228201229201230201231201232201233201234201235201236201237201238201239201240201241201242201243201244201245201246201247201248201249201250201251201252201253201254201255201256201257201258201259201260201261201262201263201264201265201266201267201268201269201270201271201272201273201274201275201276201277201278201279201280201281201282201283201284201285201286201287201288201289201290201291201292201293201294201295201296201297201298201299201300201301201302201303201304201305201306201307201308201309201310201311201312201313201314201315201316201317201318201319201320201321201322201323201324201325201326201327201328201329201330201331201332201333201334201335201336201337201338201339201340201341201342201343201344201345201346201347201348201349201350201351201352201353201354201355201356201357201358201359201360201361201362201363201364201365201366201367201368201369201370201371201372201373201374201375201376201377201378201379201380201381201382201383201384201385201386201387201388201389201390201391201392201393201394201395201396201397201398201399201400201401201402201403201404201405201406201407201408201409201410201411201412201413201414201415201416201417201418201419201420201421201422201423201424201425201426201427201428201429201430201431201432201433201434201435201436201437201438201439201440201441201442201443201444201445201446201447201448201449201450201451201452201453201454201455201456201457201458201459201460201461201462201463201464201465201466201467201468201469201470201471201472201473201474201475201476201477201478201479201480201481201482201483201484201485201486201487201488201489201490201491201492201493201494201495201496201497201498201499201500201501201502201503201504201505201506201507201508201509201510201511201512201513201514201515201516201517201518201519201520201521201522201523201524201525201526201527201528201529201530201531201532201533201534201535201536201537201538201539201540201541201542201543201544201545201546201547201548201549201550201551201552201553201554201555201556201557201558201559201560201561201562201563201564201565201566201567201568201569201570201571201572201573201574201575201576201577201578201579201580201581201582201583201584201585201586201587201588201589201590201591201592201593201594201595201596201597201598201599201600201601201602201603201604201605201606201607201608201609201610201611201612201613201614201615201616201617201618201619201620201621201622201623201624201625201626201627201628201629201630201631201632201633201634201635201636201637201638201639201640201641201642201643201644201645201646201647201648201649201650201651201652201653201654201655201656201657201658201659201660201661201662201663201664201665201666201667201668201669201670201671201672201673201674201675201676201677201678201679201680201681201682201683201684201685201686201687201688201689201690201691201692201693201694201695201696201697201698201699201700201701201702201703201704201705201706201707201708201709201710201711201712201713201714201715201716201717201718201719201720201721201722201723201724201725201726201727201728201729201730201731201732201733201734201735201736201737201738201739201740201741201742201743201744201745201746201747201748201749201750201751201752201753201754201755201756201757201758201759201760201761201762201763201764201765201766201767201768201769201770201771201772201773201774201775201776201777201778201779201780201781201782201783201784201785201786201787201788201789201790201791201792201793201794201795201796201797201798201799201800201801201802201803201804201805201806201807201808201809201810201811201812201813201814201815201816201817201818201819201820201821201822201823201824201825201826201827201828201829201830201831201832201833201834201835201836201837201838201839201840201841201842201843201844201845201846201847201848201849201850201851201852201853201854201855201856201857201858201859201860201861201862201863201864201865201866201867201868201869201870201871201872201873201874201875201876201877201878201879201880201881201882201883201884201885201886201887201888201889201890201891201892201893201894201895201896201897201898201899201900201901201902201903201904201905201906201907201908201909201910201911201912201913201914201915201916201917201918201919201920201921201922201923201924201925201926201927201928201929201930201931201932201933201934201935201936201937201938201939201940201941201942201943201944201945201946201947201948201949201950201951201952201953201954201955201956201957201958201959201960201961201962201963201964201965201966201967201968201969201970201971201972201973201974201975201976201977201978201979201980201981201982201983201984201985201986201987201988201989201990201991201992201993201994201995201996201997201998201999202000202001202002202003202004202005202006202007202008202009202010202011202012202013202014202015202016202017202018202019202020202021202022202023202024202025202026202027202028202029202030202031202032202033202034202035202036202037202038202039202040202041202042202043202044202045202046202047202048202049202050202051202052202053202054202055202056202057202058202059202060202061202062202063202064202065202066202067202068202069202070202071202072202073202074202075202076202077202078202079202080202081202082202083202084202085202086202087202088202089202090202091202092202093202094202095202096202097202098202099202100202101202102202103202104202105202106202107202108202109202110202111202112202113202114202115202116202117202118202119202120202121202122202123202124202125202126202127202128202129202130202131202132202133202134202135202136202137202138202139202140202141202142202143202144202145202146202147202148202149202150202151202152202153202154202155202156202157202158202159202160202161202162202163202164202165202166202167202168202169202170202171202172202173202174202175202176202177202178202179202180202181202182202183202184202185202186202187202188202189202190202191202192202193202194202195202196202197202198202199202200202201202202202203202204202205202206202207202208202209202210202211202212202213202214202215202216202217202218202219202220202221202222202223202224202225202226202227202228202229202230202231202232202233202234202235202236202237202238202239202240202241202242202243202244202245202246202247202248202249202250202251202252202253202254202255202256202257202258202259202260202261202262202263202264202265202266202267202268202269202270202271202272202273202274202275202276202277202278202279202280202281202282202283202284202285202286202287202288202289202290202291202292202293202294202295202296202297202298202299202300202301202302202303202304202305202306202307202308202309202310202311202312202313202314202315202316202317202318202319202320202321202322202323202324202325202326202327202328202329202330202331202332202333202334202335202336202337202338202339202340202341202342202343202344202345202346202347202348202349202350202351202352202353202354202355202356202357202358202359202360202361202362202363202364202365202366202367202368202369202370202371202372202373202374202375202376202377202378202379202380202381202382202383202384202385202386202387202388202389202390202391202392202393202394202395202396202397202398202399202400202401202402202403202404202405202406202407202408202409202410202411202412202413202414202415202416202417202418202419202420202421202422202423202424202425202426202427202428202429202430202431202432202433202434202435202436202437202438202439202440202441202442202443202444202445202446202447202448202449202450202451202452202453202454202455202456202457202458202459202460202461202462202463202464202465202466202467202468202469202470202471202472202473202474202475202476202477202478202479202480202481202482202483202484202485202486202487202488202489202490202491202492202493202494202495202496202497202498202499202500202501202502202503202504202505202506202507202508202509202510202511202512202513202514202515202516202517202518202519202520202521202522202523202524202525202526202527202528202529202530202531202532202533202534202535202536202537202538202539202540202541202542202543202544202545202546202547202548202549202550202551202552202553202554202555202556202557202558202559202560202561202562202563202564202565202566202567202568202569202570202571202572202573202574202575202576202577202578202579202580202581202582202583202584202585202586202587202588202589202590202591202592202593202594202595202596202597202598202599202600202601202602202603202604202605202606202607202608202609202610202611202612202613202614202615202616202617202618202619202620202621202622202623202624202625202626202627202628202629202630202631202632202633202634202635202636202637202638202639202640202641202642202643202644202645202646202647202648202649202650202651202652202653202654202655202656202657202658202659202660202661202662202663202664202665202666202667202668202669202670202671202672202673202674202675202676202677202678202679202680202681202682202683202684202685202686202687202688202689202690202691202692202693202694202695202696202697202698202699202700202701202702202703202704202705202706202707202708202709202710202711202712202713202714202715202716202717202718202719202720202721202722202723202724202725202726202727202728202729202730202731202732202733202734202735202736202737202738202739202740202741202742202743202744202745202746202747202748202749202750202751202752202753202754202755202756202757202758202759202760202761202762202763202764202765202766202767202768202769202770202771202772202773202774202775202776202777202778202779202780202781202782202783202784202785202786202787202788202789202790202791202792202793202794202795202796202797202798202799202800202801202802202803202804202805202806202807202808202809202810202811202812202813202814202815202816202817202818202819202820202821202822202823202824202825202826202827202828202829202830202831202832202833202834202835202836202837202838202839202840202841202842202843202844202845202846202847202848202849202850202851202852202853202854202855202856202857202858202859202860202861202862202863202864202865202866202867202868202869202870202871202872202873202874202875202876202877202878202879202880202881202882202883202884202885202886202887202888202889202890202891202892202893202894202895202896202897202898202899202900202901202902202903202904202905202906202907202908202909202910202911202912202913202914202915202916202917202918202919202920202921202922202923202924202925202926202927202928202929202930202931202932202933202934202935202936202937202938202939202940202941202942202943202944202945202946202947202948202949202950202951202952202953202954202955202956202957202958202959202960202961202962202963202964202965202966202967202968202969202970202971202972202973202974202975202976202977202978202979202980202981202982202983202984202985202986202987202988202989202990202991202992202993202994202995202996202997202998202999203000203001203002203003203004203005203006203007203008203009203010203011203012203013203014203015203016203017203018203019203020203021203022203023203024203025203026203027203028203029203030203031203032203033203034203035203036203037203038203039203040203041203042203043203044203045203046203047203048203049203050203051203052203053203054203055203056203057203058203059203060203061203062203063203064203065203066203067203068203069203070203071203072203073203074203075203076203077203078203079203080203081203082203083203084203085203086203087203088203089203090203091203092203093203094203095203096203097203098203099203100203101203102203103203104203105203106203107203108203109203110203111203112203113203114203115203116203117203118203119203120203121203122203123203124203125203126203127203128203129203130203131203132203133203134203135203136203137203138203139203140203141203142203143203144203145203146203147203148203149203150203151203152203153203154203155203156203157203158203159203160203161203162203163203164203165203166203167203168203169203170203171203172203173203174203175203176203177203178203179203180203181203182203183203184203185203186203187203188203189203190203191203192203193203194203195203196203197203198203199203200203201203202203203203204203205203206203207203208203209203210203211203212203213203214203215203216203217203218203219203220203221203222203223203224203225203226203227203228203229203230203231203232203233203234203235203236203237203238203239203240203241203242203243203244203245203246203247203248203249203250203251203252203253203254203255203256203257203258203259203260203261203262203263203264203265203266203267203268203269203270203271203272203273203274203275203276203277203278203279203280203281203282203283203284203285203286203287203288203289203290203291203292203293203294203295203296203297203298203299203300203301203302203303203304203305203306203307203308203309203310203311203312203313203314203315203316203317203318203319203320203321203322203323203324203325203326203327203328203329203330203331203332203333203334203335203336203337203338203339203340203341203342203343203344203345203346203347203348203349203350203351203352203353203354203355203356203357203358203359203360203361203362203363203364203365203366203367203368203369203370203371203372203373203374203375203376203377203378203379203380203381203382203383203384203385203386203387203388203389203390203391203392203393203394203395203396203397203398203399203400203401203402203403203404203405203406203407203408203409203410203411203412203413203414203415203416203417203418203419203420203421203422203423203424203425203426203427203428203429203430203431203432203433203434203435203436203437203438203439203440203441203442203443203444203445203446203447203448203449203450203451203452203453203454203455203456203457203458203459203460203461203462203463203464203465203466203467203468203469203470203471203472203473203474203475203476203477203478203479203480203481203482203483203484203485203486203487203488203489203490203491203492203493203494203495203496203497203498203499203500203501203502203503203504203505203506203507203508203509203510203511203512203513203514203515203516203517203518203519203520203521203522203523203524203525203526203527203528203529203530203531203532203533203534203535203536203537203538203539203540203541203542203543203544203545203546203547203548203549203550203551203552203553203554203555203556203557203558203559203560203561203562203563203564203565203566203567203568203569203570203571203572203573203574203575203576203577203578203579203580203581203582203583203584203585203586203587203588203589203590203591203592203593203594203595203596203597203598203599203600203601203602203603203604203605203606203607203608203609203610203611203612203613203614203615203616203617203618203619203620203621203622203623203624203625203626203627203628203629203630203631203632203633203634203635203636203637203638203639203640203641203642203643203644203645203646203647203648203649203650203651203652203653203654203655203656203657203658203659203660203661203662203663203664203665203666203667203668203669203670203671203672203673203674203675203676203677203678203679203680203681203682203683203684203685203686203687203688203689203690203691203692203693203694203695203696203697203698203699203700203701203702203703203704203705203706203707203708203709203710203711203712203713203714203715203716203717203718203719203720203721203722203723203724203725203726203727203728203729203730203731203732203733203734203735203736203737203738203739203740203741203742203743203744203745203746203747203748203749203750203751203752203753203754203755203756203757203758203759203760203761203762203763203764203765203766203767203768203769203770203771203772203773203774203775203776203777203778203779203780203781203782203783203784203785203786203787203788203789203790203791203792203793203794203795203796203797203798203799203800203801203802203803203804203805203806203807203808203809203810203811203812203813203814203815203816203817203818203819203820203821203822203823203824203825203826203827203828203829203830203831203832203833203834203835203836203837203838203839203840203841203842203843203844203845203846203847203848203849203850203851203852203853203854203855203856203857203858203859203860203861203862203863203864203865203866203867203868203869203870203871203872203873203874203875203876203877203878203879203880203881203882203883203884203885203886203887203888203889203890203891203892203893203894203895203896203897203898203899203900203901203902203903203904203905203906203907203908203909203910203911203912203913203914203915203916203917203918203919203920203921203922203923203924203925203926203927203928203929203930203931203932203933203934203935203936203937203938203939203940203941203942203943203944203945203946203947203948203949203950203951203952203953203954203955203956203957203958203959203960203961203962203963203964203965203966203967203968203969203970203971203972203973203974203975203976203977203978203979203980203981203982203983203984203985203986203987203988203989203990203991203992203993203994203995203996203997203998203999204000204001204002204003204004204005204006204007204008204009204010204011204012204013204014204015204016204017204018204019204020204021204022204023204024204025204026204027204028204029204030204031204032204033204034204035204036204037204038204039204040204041204042204043204044204045204046204047204048204049204050204051204052204053204054204055204056204057204058204059204060204061204062204063204064204065204066204067204068204069204070204071204072204073204074204075204076204077204078204079204080204081204082204083204084204085204086204087204088204089204090204091204092204093204094204095204096204097204098204099204100204101204102204103204104204105204106204107204108204109204110204111204112204113204114204115204116204117204118204119204120204121204122204123204124204125204126204127204128204129204130204131204132204133204134204135204136204137204138204139204140204141204142204143204144204145204146204147204148204149204150204151204152204153204154204155204156204157204158204159204160204161204162204163204164204165204166204167204168204169204170204171204172204173204174204175204176204177204178204179204180204181204182204183204184204185204186204187204188204189204190204191204192204193204194204195204196204197204198204199204200204201204202204203204204204205204206204207204208204209204210204211204212204213204214204215204216204217204218204219204220204221204222204223204224204225204226204227204228204229204230204231204232204233204234204235204236204237204238204239204240204241204242204243204244204245204246204247204248204249204250204251204252204253204254204255204256204257204258204259204260204261204262204263204264204265204266204267204268204269204270204271204272204273204274204275204276204277204278204279204280204281204282204283204284204285204286204287204288204289204290204291204292204293204294204295204296204297204298204299204300204301204302204303204304204305204306204307204308204309204310204311204312204313204314204315204316204317204318204319204320204321204322204323204324204325204326204327204328204329204330204331204332204333204334204335204336204337204338204339204340204341204342204343204344204345204346204347204348204349204350204351204352204353204354204355204356204357204358204359204360204361204362204363204364204365204366204367204368204369204370204371204372204373204374204375204376204377204378204379204380204381204382204383204384204385204386204387204388204389204390204391204392204393204394204395204396204397204398204399204400204401204402204403204404204405204406204407204408204409204410204411204412204413204414204415204416204417204418204419204420204421204422204423204424204425204426204427204428204429204430204431204432204433204434204435204436204437204438204439204440204441204442204443204444204445204446204447204448204449204450204451204452204453204454204455204456204457204458204459204460204461204462204463204464204465204466204467204468204469204470204471204472204473204474204475204476204477204478204479204480204481204482204483204484204485204486204487204488204489204490204491204492204493204494204495204496204497204498204499204500204501204502204503204504204505204506204507204508204509204510204511204512204513204514204515204516204517204518204519204520204521204522204523204524204525204526204527204528204529204530204531204532204533204534204535204536204537204538204539204540204541204542204543204544204545204546204547204548204549204550204551204552204553204554204555204556204557204558204559204560204561204562204563204564204565204566204567204568204569204570204571204572204573204574204575204576204577204578204579204580204581204582204583204584204585204586204587204588204589204590204591204592204593204594204595204596204597204598204599204600204601204602204603204604204605204606204607204608204609204610204611204612204613204614204615204616204617204618204619204620204621204622204623204624204625204626204627204628204629204630204631204632204633204634204635204636204637204638204639204640204641204642204643204644204645204646204647204648204649204650204651204652204653204654204655204656204657204658204659204660204661204662204663204664204665204666204667204668204669204670204671204672204673204674204675204676204677204678204679204680204681204682204683204684204685204686204687204688204689204690204691204692204693204694204695204696204697204698204699204700204701204702204703204704204705204706204707204708204709204710204711204712204713204714204715204716204717204718204719204720204721204722204723204724204725204726204727204728204729204730204731204732204733204734204735204736204737204738204739204740204741204742204743204744204745204746204747204748204749204750204751204752204753204754204755204756204757204758204759204760204761204762204763204764204765204766204767204768204769204770204771204772204773204774204775204776204777204778204779204780204781204782204783204784204785204786204787204788204789204790204791204792204793204794204795204796204797204798204799204800204801204802204803204804204805204806204807204808204809204810204811204812204813204814204815204816204817204818204819204820204821204822204823204824204825204826204827204828204829204830204831204832204833204834204835204836204837204838204839204840204841204842204843204844204845204846204847204848204849204850204851204852204853204854204855204856204857204858204859204860204861204862204863204864204865204866204867204868204869204870204871204872204873204874204875204876204877204878204879204880204881204882204883204884204885204886204887204888204889204890204891204892204893204894204895204896204897204898204899204900204901204902204903204904204905204906204907204908204909204910204911204912204913204914204915204916204917204918204919204920204921204922204923204924204925204926204927204928204929204930204931204932204933204934204935204936204937204938204939204940204941204942204943204944204945204946204947204948204949204950204951204952204953204954204955204956204957204958204959204960204961204962204963204964204965204966204967204968204969204970204971204972204973204974204975204976204977204978204979204980204981204982204983204984204985204986204987204988204989204990204991204992204993204994204995204996204997204998204999205000205001205002205003205004205005205006205007205008205009205010205011205012205013205014205015205016205017205018205019205020205021205022205023205024205025205026205027205028205029205030205031205032205033205034205035205036205037205038205039205040205041205042205043205044205045205046205047205048205049205050205051205052205053205054205055205056205057205058205059205060205061205062205063205064205065205066205067205068205069205070205071205072205073205074205075205076205077205078205079205080205081205082205083205084205085205086205087205088205089205090205091205092205093205094205095205096205097205098205099205100205101205102205103205104205105205106205107205108205109205110205111205112205113205114205115205116205117205118205119205120205121205122205123205124205125205126205127205128205129205130205131205132205133205134205135205136205137205138205139205140205141205142205143205144205145205146205147205148205149205150205151205152205153205154205155205156205157205158205159205160205161205162205163205164205165205166205167205168205169205170205171205172205173205174205175205176205177205178205179205180205181205182205183205184205185205186205187205188205189205190205191205192205193205194205195205196205197205198205199205200205201205202205203205204205205205206205207205208205209205210205211205212205213205214205215205216205217205218205219205220205221205222205223205224205225205226205227205228205229205230205231205232205233205234205235205236205237205238205239205240205241205242205243205244205245205246205247205248205249205250205251205252205253205254205255205256205257205258205259205260205261205262205263205264205265205266205267205268205269205270205271205272205273205274205275205276205277205278205279205280205281205282205283205284205285205286205287205288205289205290205291205292205293205294205295205296205297205298205299205300205301205302205303205304205305205306205307205308205309205310205311205312205313205314205315205316205317205318205319205320205321205322205323205324205325205326205327205328205329205330205331205332205333205334205335205336205337205338205339205340205341205342205343205344205345205346205347205348205349205350205351205352205353205354205355205356205357205358205359205360205361205362205363205364205365205366205367205368205369205370205371205372205373205374205375205376205377205378205379205380205381205382205383205384205385205386205387205388205389205390205391205392205393205394205395205396205397205398205399205400205401205402205403205404205405205406205407205408205409205410205411205412205413205414205415205416205417205418205419205420205421205422205423205424205425205426205427205428205429205430205431205432205433205434205435205436205437205438205439205440205441205442205443205444205445205446205447205448205449205450205451205452205453205454205455205456205457205458205459205460205461205462205463205464205465205466205467205468205469205470205471205472205473205474205475205476205477205478205479205480205481205482205483205484205485205486205487205488205489205490205491205492205493205494205495205496205497205498205499205500205501205502205503205504205505205506205507205508205509205510205511205512205513205514205515205516205517205518205519205520205521205522205523205524205525205526205527205528205529205530205531205532205533205534205535205536205537205538205539205540205541205542205543205544205545205546205547205548205549205550205551205552205553205554205555205556205557205558205559205560205561205562205563205564205565205566205567205568205569205570205571205572205573205574205575205576205577205578205579205580205581205582205583205584205585205586205587205588205589205590205591205592205593205594205595205596205597205598205599205600205601205602205603205604205605205606205607205608205609205610205611205612205613205614205615205616205617205618205619205620205621205622205623205624205625205626205627205628205629205630205631205632205633205634205635205636205637205638205639205640205641205642205643205644205645205646205647205648205649205650205651205652205653205654205655205656205657205658205659205660205661205662205663205664205665205666205667205668205669205670205671205672205673205674205675205676205677205678205679205680205681205682205683205684205685205686205687205688205689205690205691205692205693205694205695205696205697205698205699205700205701205702205703205704205705205706205707205708205709205710205711205712205713205714205715205716205717205718205719205720205721205722205723205724205725205726205727205728205729205730205731205732205733205734205735205736205737205738205739205740205741205742205743205744205745205746205747205748205749205750205751205752205753205754205755205756205757205758205759205760205761205762205763205764205765205766205767205768205769205770205771205772205773205774205775205776205777205778205779205780205781205782205783205784205785205786205787205788205789205790205791205792205793205794205795205796205797205798205799205800205801205802205803205804205805205806205807205808205809205810205811205812205813205814205815205816205817205818205819205820205821205822205823205824205825205826205827205828205829205830205831205832205833205834205835205836205837205838205839205840205841205842205843205844205845205846205847205848205849205850205851205852205853205854205855205856205857205858205859205860205861205862205863205864205865205866205867205868205869205870205871205872205873205874205875205876205877205878205879205880205881205882205883205884205885205886205887205888205889205890205891205892205893205894205895205896205897205898205899205900205901205902205903205904205905205906205907205908205909205910205911205912205913205914205915205916205917205918205919205920205921205922205923205924205925205926205927205928205929205930205931205932205933205934205935205936205937205938205939205940205941205942205943205944205945205946205947205948205949205950205951205952205953205954205955205956205957205958205959205960205961205962205963205964205965205966205967205968205969205970205971205972205973205974205975205976205977205978205979205980205981205982205983205984205985205986205987205988205989205990205991205992205993205994205995205996205997205998205999206000206001206002206003206004206005206006206007206008206009206010206011206012206013206014206015206016206017206018206019206020206021206022206023206024206025206026206027206028206029206030206031206032206033206034206035206036206037206038206039206040206041206042206043206044206045206046206047206048206049206050206051206052206053206054206055206056206057206058206059206060206061206062206063206064206065206066206067206068206069206070206071206072206073206074206075206076206077206078206079206080206081206082206083206084206085206086206087206088206089206090206091206092206093206094206095206096206097206098206099206100206101206102206103206104206105206106206107206108206109206110206111206112206113206114206115206116206117206118206119206120206121206122206123206124206125206126206127206128206129206130206131206132206133206134206135206136206137206138206139206140206141206142206143206144206145206146206147206148206149206150206151206152206153206154206155206156206157206158206159206160206161206162206163206164206165206166206167206168206169206170206171206172206173206174206175206176206177206178206179206180206181206182206183206184206185206186206187206188206189206190206191206192206193206194206195206196206197206198206199206200206201206202206203206204206205206206206207206208206209206210206211206212206213206214206215206216206217206218206219206220206221206222206223206224206225206226206227206228206229206230206231206232206233206234206235206236206237206238206239206240206241206242206243206244206245206246206247206248206249206250206251206252206253206254206255206256206257206258206259206260206261206262206263206264206265206266206267206268206269206270206271206272206273206274206275206276206277206278206279206280206281206282206283206284206285206286206287206288206289206290206291206292206293206294206295206296206297206298206299206300206301206302206303206304206305206306206307206308206309206310206311206312206313206314206315206316206317206318206319206320206321206322206323206324206325206326206327206328206329206330206331206332206333206334206335206336206337206338206339206340206341206342206343206344206345206346206347206348206349206350206351206352206353206354206355206356206357206358206359206360206361206362206363206364206365206366206367206368206369206370206371206372206373206374206375206376206377206378206379206380206381206382206383206384206385206386206387206388206389206390206391206392206393206394206395206396206397206398206399206400206401206402206403206404206405206406206407206408206409206410206411206412206413206414206415206416206417206418206419206420206421206422206423206424206425206426206427206428206429206430206431206432206433206434206435206436206437206438206439206440206441206442206443206444206445206446206447206448206449206450206451206452206453206454206455206456206457206458206459206460206461206462206463206464206465206466206467206468206469206470206471206472206473206474206475206476206477206478206479206480206481206482206483206484206485206486206487206488206489206490206491206492206493206494206495206496206497206498206499206500206501206502206503206504206505206506206507206508206509206510206511206512206513206514206515206516206517206518206519206520206521206522206523206524206525206526206527206528206529206530206531206532206533206534206535206536206537206538206539206540206541206542206543206544206545206546206547206548206549206550206551206552206553206554206555206556206557206558206559206560206561206562206563206564206565206566206567206568206569206570206571206572206573206574206575206576206577206578206579206580206581206582206583206584206585206586206587206588206589206590206591206592206593206594206595206596206597206598206599206600206601206602206603206604206605206606206607206608206609206610206611206612206613206614206615206616206617206618206619206620206621206622206623206624206625206626206627206628206629206630206631206632206633206634206635206636206637206638206639206640206641206642206643206644206645206646206647206648206649206650206651206652206653206654206655206656206657206658206659206660206661206662206663206664206665206666206667206668206669206670206671206672206673206674206675206676206677206678206679206680206681206682206683206684206685206686206687206688206689206690206691206692206693206694206695206696206697206698206699206700206701206702206703206704206705206706206707206708206709206710206711206712206713206714206715206716206717206718206719206720206721206722206723206724206725206726206727206728206729206730206731206732206733206734206735206736206737206738206739206740206741206742206743206744206745206746206747206748206749206750206751206752206753206754206755206756206757206758206759206760206761206762206763206764206765206766206767206768206769206770206771206772206773206774206775206776206777206778206779206780206781206782206783206784206785206786206787206788206789206790206791206792206793206794206795206796206797206798206799206800206801206802206803206804206805206806206807206808206809206810206811206812206813206814206815206816206817206818206819206820206821206822206823206824206825206826206827206828206829206830206831206832206833206834206835206836206837206838206839206840206841206842206843206844206845206846206847206848206849206850206851206852206853206854206855206856206857206858206859206860206861206862206863206864206865206866206867206868206869206870206871206872206873206874206875206876206877206878206879206880206881206882206883206884206885206886206887206888206889206890206891206892206893206894206895206896206897206898206899206900206901206902206903206904206905206906206907206908206909206910206911206912206913206914206915206916206917206918206919206920206921206922206923206924206925206926206927206928206929206930206931206932206933206934206935206936206937206938206939206940206941206942206943206944206945206946206947206948206949206950206951206952206953206954206955206956206957206958206959206960206961206962206963206964206965206966206967206968206969206970206971206972206973206974206975206976206977206978206979206980206981206982206983206984206985206986206987206988206989206990206991206992206993206994206995206996206997206998206999207000207001207002207003207004207005207006207007207008207009207010207011207012207013207014207015207016207017207018207019207020207021207022207023207024207025207026207027207028207029207030207031207032207033207034207035207036207037207038207039207040207041207042207043207044207045207046207047207048207049207050207051207052207053207054207055207056207057207058207059207060207061207062207063207064207065207066207067207068207069207070207071207072207073207074207075207076207077207078207079207080207081207082207083207084207085207086207087207088207089207090207091207092207093207094207095207096207097207098207099207100207101207102207103207104207105207106207107207108207109207110207111207112207113207114207115207116207117207118207119207120207121207122207123207124207125207126207127207128207129207130207131207132207133207134207135207136207137207138207139207140207141207142207143207144207145207146207147207148207149207150207151207152207153207154207155207156207157207158207159207160207161207162207163207164207165207166207167207168207169207170207171207172207173207174207175207176207177207178207179207180207181207182207183207184207185207186207187207188207189207190207191207192207193207194207195207196207197207198207199207200207201207202207203207204207205207206207207207208207209207210207211207212207213207214207215207216207217207218207219207220207221207222207223207224207225207226207227207228207229207230207231207232207233207234207235207236207237207238207239207240207241207242207243207244207245207246207247207248207249207250207251207252207253207254207255207256207257207258207259207260207261207262207263207264207265207266207267207268207269207270207271207272207273207274207275207276207277207278207279207280207281207282207283207284207285207286207287207288207289207290207291207292207293207294207295207296207297207298207299207300207301207302207303207304207305207306207307207308207309207310207311207312207313207314207315207316207317207318207319207320207321207322207323207324207325207326207327207328207329207330207331207332207333207334207335207336207337207338207339207340207341207342207343207344207345207346207347207348207349207350207351207352207353207354207355207356207357207358207359207360207361207362207363207364207365207366207367207368207369207370207371207372207373207374207375207376207377207378207379207380207381207382207383207384207385207386207387207388207389207390207391207392207393207394207395207396207397207398207399207400207401207402207403207404207405207406207407207408207409207410207411207412207413207414207415207416207417207418207419207420207421207422207423207424207425207426207427207428207429207430207431207432207433207434207435207436207437207438207439207440207441207442207443207444207445207446207447207448207449207450207451207452207453207454207455207456207457207458207459207460207461207462207463207464207465207466207467207468207469207470207471207472207473207474207475207476207477207478207479207480207481207482207483207484207485207486207487207488207489207490207491207492207493207494207495207496207497207498207499207500207501207502207503207504207505207506207507207508207509207510207511207512207513207514207515207516207517207518207519207520207521207522207523207524207525207526207527207528207529207530207531207532207533207534207535207536207537207538207539207540207541207542207543207544207545207546207547207548207549207550207551207552207553207554207555207556207557207558207559207560207561207562207563207564207565207566207567207568207569207570207571207572207573207574207575207576207577207578207579207580207581207582207583207584207585207586207587207588207589207590207591207592207593207594207595207596207597207598207599207600207601207602207603207604207605207606207607207608207609207610207611207612207613207614207615207616207617207618207619207620207621207622207623207624207625207626207627207628207629207630207631207632207633207634207635207636207637207638207639207640207641207642207643207644207645207646207647207648207649207650207651207652207653207654207655207656207657207658207659207660207661207662207663207664207665207666207667207668207669207670207671207672207673207674207675207676207677207678207679207680207681207682207683207684207685207686207687207688207689207690207691207692207693207694207695207696207697207698207699207700207701207702207703207704207705207706207707207708207709207710207711207712207713207714207715207716207717207718207719207720207721207722207723207724207725207726207727207728207729207730207731207732207733207734207735207736207737207738207739207740207741207742207743207744207745207746207747207748207749207750207751207752207753207754207755207756207757207758207759207760207761207762207763207764207765207766207767207768207769207770207771207772207773207774207775207776207777207778207779207780207781207782207783207784207785207786207787207788207789207790207791207792207793207794207795207796207797207798207799207800207801207802207803207804207805207806207807207808207809207810207811207812207813207814207815207816207817207818207819207820207821207822207823207824207825207826207827207828207829207830207831207832207833207834207835207836207837207838207839207840207841207842207843207844207845207846207847207848207849207850207851207852207853207854207855207856207857207858207859207860207861207862207863207864207865207866207867207868207869207870207871207872207873207874207875207876207877207878207879207880207881207882207883207884207885207886207887207888207889207890207891207892207893207894207895207896207897207898207899207900207901207902207903207904207905207906207907207908207909207910207911207912207913207914207915207916207917207918207919207920207921207922207923207924207925207926207927207928207929207930207931207932207933207934207935207936207937207938207939207940207941207942207943207944207945207946207947207948207949207950207951207952207953207954207955207956207957207958207959207960207961207962207963207964207965207966207967207968207969207970207971207972207973207974207975207976207977207978207979207980207981207982207983207984207985207986207987207988207989207990207991207992207993207994207995207996207997207998207999208000208001208002208003208004208005208006208007208008208009208010208011208012208013208014208015208016208017208018208019208020208021208022208023208024208025208026208027208028208029208030208031208032208033208034208035208036208037208038208039208040208041208042208043208044208045208046208047208048208049208050208051208052208053208054208055208056208057208058208059208060208061208062208063208064208065208066208067208068208069208070208071208072208073208074208075208076208077208078208079208080208081208082208083208084208085208086208087208088208089208090208091208092208093208094208095208096208097208098208099208100208101208102208103208104208105208106208107208108208109208110208111208112208113208114208115208116208117208118208119208120208121208122208123208124208125208126208127208128208129208130208131208132208133208134208135208136208137208138208139208140208141208142208143208144208145208146208147208148208149208150208151208152208153208154208155208156208157208158208159208160208161208162208163208164208165208166208167208168208169208170208171208172208173208174208175208176208177208178208179208180208181208182208183208184208185208186208187208188208189208190208191208192208193208194208195208196208197208198208199208200208201208202208203208204208205208206208207208208208209208210208211208212208213208214208215208216208217208218208219208220208221208222208223208224208225208226208227208228208229208230208231208232208233208234208235208236208237208238208239208240208241208242208243208244208245208246208247208248208249208250208251208252208253208254208255208256208257208258208259208260208261208262208263208264208265208266208267208268208269208270208271208272208273208274208275208276208277208278208279208280208281208282208283208284208285208286208287208288208289208290208291208292208293208294208295208296208297208298208299208300208301208302208303208304208305208306208307208308208309208310208311208312208313208314208315208316208317208318208319208320208321208322208323208324208325208326208327208328208329208330208331208332208333208334208335208336208337208338208339208340208341208342208343208344208345208346208347208348208349208350208351208352208353208354208355208356208357208358208359208360208361208362208363208364208365208366208367208368208369208370208371208372208373208374208375208376208377208378208379208380208381208382208383208384208385208386208387208388208389208390208391208392208393208394208395208396208397208398208399208400208401208402208403208404208405208406208407208408208409208410208411208412208413208414208415208416208417208418208419208420208421208422208423208424208425208426208427208428208429208430208431208432208433208434208435208436208437208438208439208440208441208442208443208444208445208446208447208448208449208450208451208452208453208454208455208456208457208458208459208460208461208462208463208464208465208466208467208468208469208470208471208472208473208474208475208476208477208478208479208480208481208482208483208484208485208486208487208488208489208490208491208492208493208494208495208496208497208498208499208500208501208502208503208504208505208506208507208508208509208510208511208512208513208514208515208516208517208518208519208520208521208522208523208524208525208526208527208528208529208530208531208532208533208534208535208536208537208538208539208540208541208542208543208544208545208546208547208548208549208550208551208552208553208554208555208556208557208558208559208560208561208562208563208564208565208566208567208568208569208570208571208572208573208574208575208576208577208578208579208580208581208582208583208584208585208586208587208588208589208590208591208592208593208594208595208596208597208598208599208600208601208602208603208604208605208606208607208608208609208610208611208612208613208614208615208616208617208618208619208620208621208622208623208624208625208626208627208628208629208630208631208632208633208634208635208636208637208638208639208640208641208642208643208644208645208646208647208648208649208650208651208652208653208654208655208656208657208658208659208660208661208662208663208664208665208666208667208668208669208670208671208672208673208674208675208676208677208678208679208680208681208682208683208684208685208686208687208688208689208690208691208692208693208694208695208696208697208698208699208700208701208702208703208704208705208706208707208708208709208710208711208712208713208714208715208716208717208718208719208720208721208722208723208724208725208726208727208728208729208730208731208732208733208734208735208736208737208738208739208740208741208742208743208744208745208746208747208748208749208750208751208752208753208754208755208756208757208758208759208760208761208762208763208764208765208766208767208768208769208770208771208772208773208774208775208776208777208778208779208780208781208782208783208784208785208786208787208788208789208790208791208792208793208794208795208796208797208798208799208800208801208802208803208804208805208806208807208808208809208810208811208812208813208814208815208816208817208818208819208820208821208822208823208824208825208826208827208828208829208830208831208832208833208834208835208836208837208838208839208840208841208842208843208844208845208846208847208848208849208850208851208852208853208854208855208856208857208858208859208860208861208862208863208864208865208866208867208868208869208870208871208872208873208874208875208876208877208878208879208880208881208882208883208884208885208886208887208888208889208890208891208892208893208894208895208896208897208898208899208900208901208902208903208904208905208906208907208908208909208910208911208912208913208914208915208916208917208918208919208920208921208922208923208924208925208926208927208928208929208930208931208932208933208934208935208936208937208938208939208940208941208942208943208944208945208946208947208948208949208950208951208952208953208954208955208956208957208958208959208960208961208962208963208964208965208966208967208968208969208970208971208972208973208974208975208976208977208978208979208980208981208982208983208984208985208986208987208988208989208990208991208992208993208994208995208996208997208998208999209000209001209002209003209004209005209006209007209008209009209010209011209012209013209014209015209016209017209018209019209020209021209022209023209024209025209026209027209028209029209030209031209032209033209034209035209036209037209038209039209040209041209042209043209044209045209046209047209048209049209050209051209052209053209054209055209056209057209058209059209060209061209062209063209064209065209066209067209068209069209070209071209072209073209074209075209076209077209078209079209080209081209082209083209084209085209086209087209088209089209090209091209092209093209094209095209096209097209098209099209100209101209102209103209104209105209106209107209108209109209110209111209112209113209114209115209116209117209118209119209120209121209122209123209124209125209126209127209128209129209130209131209132209133209134209135209136209137209138209139209140209141209142209143209144209145209146209147209148209149209150209151209152209153209154209155209156209157209158209159209160209161209162209163209164209165209166209167209168209169209170209171209172209173209174209175209176209177209178209179209180209181209182209183209184209185209186209187209188209189209190209191209192209193209194209195209196209197209198209199209200209201209202209203209204209205209206209207209208209209209210209211209212209213209214209215209216209217209218209219209220209221209222209223209224209225209226209227209228209229209230209231209232209233209234209235209236209237209238209239209240209241209242209243209244209245209246209247209248209249209250209251209252209253209254209255209256209257209258209259209260209261209262209263209264209265209266209267209268209269209270209271209272209273209274209275209276209277209278209279209280209281209282209283209284209285209286209287209288209289209290209291209292209293209294209295209296209297209298209299209300209301209302209303209304209305209306209307209308209309209310209311209312209313209314209315209316209317209318209319209320209321209322209323209324209325209326209327209328209329209330209331209332209333209334209335209336209337209338209339209340209341209342209343209344209345209346209347209348209349209350209351209352209353209354209355209356209357209358209359209360209361209362209363209364209365209366209367209368209369209370209371209372209373209374209375209376209377209378209379209380209381209382209383209384209385209386209387209388209389209390209391209392209393209394209395209396209397209398209399209400209401209402209403209404209405209406209407209408209409209410209411209412209413209414209415209416209417209418209419209420209421209422209423209424209425209426209427209428209429209430209431209432209433209434209435209436209437209438209439209440209441209442209443209444209445209446209447209448209449209450209451209452209453209454209455209456209457209458209459209460209461209462209463209464209465209466209467209468209469209470209471209472209473209474209475209476209477209478209479209480209481209482209483209484209485209486209487209488209489209490209491209492209493209494209495209496209497209498209499209500209501209502209503209504209505209506209507209508209509209510209511209512209513209514209515209516209517209518209519209520209521209522209523209524209525209526209527209528209529209530209531209532209533209534209535209536209537209538209539209540209541209542209543209544209545209546209547209548209549209550209551209552209553209554209555209556209557209558209559209560209561209562209563209564209565209566209567209568209569209570209571209572209573209574209575209576209577209578209579209580209581209582209583209584209585209586209587209588209589209590209591209592209593209594209595209596209597209598209599209600209601209602209603209604209605209606209607209608209609209610209611209612209613209614209615209616209617209618209619209620209621209622209623209624209625209626209627209628209629209630209631209632209633209634209635209636209637209638209639209640209641209642209643209644209645209646209647209648209649209650209651209652209653209654209655209656209657209658209659209660209661209662209663209664209665209666209667209668209669209670209671209672209673209674209675209676209677209678209679209680209681209682209683209684209685209686209687209688209689209690209691209692209693209694209695209696209697209698209699209700209701209702209703209704209705209706209707209708209709209710209711209712209713209714209715209716209717209718209719209720209721209722209723209724209725209726209727209728209729209730209731209732209733209734209735209736209737209738209739209740209741209742209743209744209745209746209747209748209749209750209751209752209753209754209755209756209757209758209759209760209761209762209763209764209765209766209767209768209769209770209771209772209773209774209775209776209777209778209779209780209781209782209783209784209785209786209787209788209789209790209791209792209793209794209795209796209797209798209799209800209801209802209803209804209805209806209807209808209809209810209811209812209813209814209815209816209817209818209819209820209821209822209823209824209825209826209827209828209829209830209831209832209833209834209835209836209837209838209839209840209841209842209843209844209845209846209847209848209849209850209851209852209853209854209855209856209857209858209859209860209861209862209863209864209865209866209867209868209869209870209871209872209873209874209875209876209877209878209879209880209881209882209883209884209885209886209887209888209889209890209891209892209893209894209895209896209897209898209899209900209901209902209903209904209905209906209907209908209909209910209911209912209913209914209915209916209917209918209919209920209921209922209923209924209925209926209927209928209929209930209931209932209933209934209935209936209937209938209939209940209941209942209943209944209945209946
  1. #ifndef USE_LIBSQLITE3
  2. /******************************************************************************
  3. ** This file is an amalgamation of many separate C source files from SQLite
  4. ** version 3.23.1. By combining all the individual C code files into this
  5. ** single large file, the entire code can be compiled as a single translation
  6. ** unit. This allows many compilers to do optimizations that would not be
  7. ** possible if the files were compiled separately. Performance improvements
  8. ** of 5% or more are commonly seen when SQLite is compiled as a single
  9. ** translation unit.
  10. **
  11. ** This file is all you need to compile SQLite. To use SQLite in other
  12. ** programs, you need this file and the "sqlite3.h" header file that defines
  13. ** the programming interface to the SQLite library. (If you do not have
  14. ** the "sqlite3.h" header file at hand, you will find a copy embedded within
  15. ** the text of this file. Search for "Begin file sqlite3.h" to find the start
  16. ** of the embedded sqlite3.h header file.) Additional code files may be needed
  17. ** if you want a wrapper to interface SQLite with your choice of programming
  18. ** language. The code for the "sqlite3" command-line shell is also in a
  19. ** separate file. This file contains only code for the core SQLite library.
  20. */
  21. #define SQLITE_CORE 1
  22. #define SQLITE_AMALGAMATION 1
  23. #ifndef SQLITE_PRIVATE
  24. # define SQLITE_PRIVATE static
  25. #endif
  26. /************** Begin file ctime.c *******************************************/
  27. /*
  28. ** 2010 February 23
  29. **
  30. ** The author disclaims copyright to this source code. In place of
  31. ** a legal notice, here is a blessing:
  32. **
  33. ** May you do good and not evil.
  34. ** May you find forgiveness for yourself and forgive others.
  35. ** May you share freely, never taking more than you give.
  36. **
  37. *************************************************************************
  38. **
  39. ** This file implements routines used to report what compile-time options
  40. ** SQLite was built with.
  41. */
  42. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  43. /*
  44. ** Include the configuration header output by 'configure' if we're using the
  45. ** autoconf-based build
  46. */
  47. #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H)
  48. #include "config.h"
  49. #define SQLITECONFIG_H 1
  50. #endif
  51. /* These macros are provided to "stringify" the value of the define
  52. ** for those options in which the value is meaningful. */
  53. #define CTIMEOPT_VAL_(opt) #opt
  54. #define CTIMEOPT_VAL(opt) CTIMEOPT_VAL_(opt)
  55. /*
  56. ** An array of names of all compile-time options. This array should
  57. ** be sorted A-Z.
  58. **
  59. ** This array looks large, but in a typical installation actually uses
  60. ** only a handful of compile-time options, so most times this array is usually
  61. ** rather short and uses little memory space.
  62. */
  63. static const char * const sqlite3azCompileOpt[] = {
  64. /*
  65. ** BEGIN CODE GENERATED BY tool/mkctime.tcl
  66. */
  67. #if SQLITE_32BIT_ROWID
  68. "32BIT_ROWID",
  69. #endif
  70. #if SQLITE_4_BYTE_ALIGNED_MALLOC
  71. "4_BYTE_ALIGNED_MALLOC",
  72. #endif
  73. #if SQLITE_64BIT_STATS
  74. "64BIT_STATS",
  75. #endif
  76. #if SQLITE_ALLOW_COVERING_INDEX_SCAN
  77. "ALLOW_COVERING_INDEX_SCAN",
  78. #endif
  79. #if SQLITE_ALLOW_URI_AUTHORITY
  80. "ALLOW_URI_AUTHORITY",
  81. #endif
  82. #ifdef SQLITE_BITMASK_TYPE
  83. "BITMASK_TYPE=" CTIMEOPT_VAL(SQLITE_BITMASK_TYPE),
  84. #endif
  85. #if SQLITE_BUG_COMPATIBLE_20160819
  86. "BUG_COMPATIBLE_20160819",
  87. #endif
  88. #if SQLITE_CASE_SENSITIVE_LIKE
  89. "CASE_SENSITIVE_LIKE",
  90. #endif
  91. #if SQLITE_CHECK_PAGES
  92. "CHECK_PAGES",
  93. #endif
  94. #if defined(__clang__) && defined(__clang_major__)
  95. "COMPILER=clang-" CTIMEOPT_VAL(__clang_major__) "."
  96. CTIMEOPT_VAL(__clang_minor__) "."
  97. CTIMEOPT_VAL(__clang_patchlevel__),
  98. #elif defined(_MSC_VER)
  99. "COMPILER=msvc-" CTIMEOPT_VAL(_MSC_VER),
  100. #elif defined(__GNUC__) && defined(__VERSION__)
  101. "COMPILER=gcc-" __VERSION__,
  102. #endif
  103. #if SQLITE_COVERAGE_TEST
  104. "COVERAGE_TEST",
  105. #endif
  106. #if SQLITE_DEBUG
  107. "DEBUG",
  108. #endif
  109. #if SQLITE_DEFAULT_AUTOMATIC_INDEX
  110. "DEFAULT_AUTOMATIC_INDEX",
  111. #endif
  112. #if SQLITE_DEFAULT_AUTOVACUUM
  113. "DEFAULT_AUTOVACUUM",
  114. #endif
  115. #ifdef SQLITE_DEFAULT_CACHE_SIZE
  116. "DEFAULT_CACHE_SIZE=" CTIMEOPT_VAL(SQLITE_DEFAULT_CACHE_SIZE),
  117. #endif
  118. #if SQLITE_DEFAULT_CKPTFULLFSYNC
  119. "DEFAULT_CKPTFULLFSYNC",
  120. #endif
  121. #ifdef SQLITE_DEFAULT_FILE_FORMAT
  122. "DEFAULT_FILE_FORMAT=" CTIMEOPT_VAL(SQLITE_DEFAULT_FILE_FORMAT),
  123. #endif
  124. #ifdef SQLITE_DEFAULT_FILE_PERMISSIONS
  125. "DEFAULT_FILE_PERMISSIONS=" CTIMEOPT_VAL(SQLITE_DEFAULT_FILE_PERMISSIONS),
  126. #endif
  127. #if SQLITE_DEFAULT_FOREIGN_KEYS
  128. "DEFAULT_FOREIGN_KEYS",
  129. #endif
  130. #ifdef SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT
  131. "DEFAULT_JOURNAL_SIZE_LIMIT=" CTIMEOPT_VAL(SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT),
  132. #endif
  133. #ifdef SQLITE_DEFAULT_LOCKING_MODE
  134. "DEFAULT_LOCKING_MODE=" CTIMEOPT_VAL(SQLITE_DEFAULT_LOCKING_MODE),
  135. #endif
  136. #ifdef SQLITE_DEFAULT_LOOKASIDE
  137. "DEFAULT_LOOKASIDE=" CTIMEOPT_VAL(SQLITE_DEFAULT_LOOKASIDE),
  138. #endif
  139. #if SQLITE_DEFAULT_MEMSTATUS
  140. "DEFAULT_MEMSTATUS",
  141. #endif
  142. #ifdef SQLITE_DEFAULT_MMAP_SIZE
  143. "DEFAULT_MMAP_SIZE=" CTIMEOPT_VAL(SQLITE_DEFAULT_MMAP_SIZE),
  144. #endif
  145. #ifdef SQLITE_DEFAULT_PAGE_SIZE
  146. "DEFAULT_PAGE_SIZE=" CTIMEOPT_VAL(SQLITE_DEFAULT_PAGE_SIZE),
  147. #endif
  148. #ifdef SQLITE_DEFAULT_PCACHE_INITSZ
  149. "DEFAULT_PCACHE_INITSZ=" CTIMEOPT_VAL(SQLITE_DEFAULT_PCACHE_INITSZ),
  150. #endif
  151. #ifdef SQLITE_DEFAULT_PROXYDIR_PERMISSIONS
  152. "DEFAULT_PROXYDIR_PERMISSIONS=" CTIMEOPT_VAL(SQLITE_DEFAULT_PROXYDIR_PERMISSIONS),
  153. #endif
  154. #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
  155. "DEFAULT_RECURSIVE_TRIGGERS",
  156. #endif
  157. #ifdef SQLITE_DEFAULT_ROWEST
  158. "DEFAULT_ROWEST=" CTIMEOPT_VAL(SQLITE_DEFAULT_ROWEST),
  159. #endif
  160. #ifdef SQLITE_DEFAULT_SECTOR_SIZE
  161. "DEFAULT_SECTOR_SIZE=" CTIMEOPT_VAL(SQLITE_DEFAULT_SECTOR_SIZE),
  162. #endif
  163. #ifdef SQLITE_DEFAULT_SYNCHRONOUS
  164. "DEFAULT_SYNCHRONOUS=" CTIMEOPT_VAL(SQLITE_DEFAULT_SYNCHRONOUS),
  165. #endif
  166. #ifdef SQLITE_DEFAULT_WAL_AUTOCHECKPOINT
  167. "DEFAULT_WAL_AUTOCHECKPOINT=" CTIMEOPT_VAL(SQLITE_DEFAULT_WAL_AUTOCHECKPOINT),
  168. #endif
  169. #ifdef SQLITE_DEFAULT_WAL_SYNCHRONOUS
  170. "DEFAULT_WAL_SYNCHRONOUS=" CTIMEOPT_VAL(SQLITE_DEFAULT_WAL_SYNCHRONOUS),
  171. #endif
  172. #ifdef SQLITE_DEFAULT_WORKER_THREADS
  173. "DEFAULT_WORKER_THREADS=" CTIMEOPT_VAL(SQLITE_DEFAULT_WORKER_THREADS),
  174. #endif
  175. #if SQLITE_DIRECT_OVERFLOW_READ
  176. "DIRECT_OVERFLOW_READ",
  177. #endif
  178. #if SQLITE_DISABLE_DIRSYNC
  179. "DISABLE_DIRSYNC",
  180. #endif
  181. #if SQLITE_DISABLE_FTS3_UNICODE
  182. "DISABLE_FTS3_UNICODE",
  183. #endif
  184. #if SQLITE_DISABLE_FTS4_DEFERRED
  185. "DISABLE_FTS4_DEFERRED",
  186. #endif
  187. #if SQLITE_DISABLE_INTRINSIC
  188. "DISABLE_INTRINSIC",
  189. #endif
  190. #if SQLITE_DISABLE_LFS
  191. "DISABLE_LFS",
  192. #endif
  193. #if SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS
  194. "DISABLE_PAGECACHE_OVERFLOW_STATS",
  195. #endif
  196. #if SQLITE_DISABLE_SKIPAHEAD_DISTINCT
  197. "DISABLE_SKIPAHEAD_DISTINCT",
  198. #endif
  199. #ifdef SQLITE_ENABLE_8_3_NAMES
  200. "ENABLE_8_3_NAMES=" CTIMEOPT_VAL(SQLITE_ENABLE_8_3_NAMES),
  201. #endif
  202. #if SQLITE_ENABLE_API_ARMOR
  203. "ENABLE_API_ARMOR",
  204. #endif
  205. #if SQLITE_ENABLE_ATOMIC_WRITE
  206. "ENABLE_ATOMIC_WRITE",
  207. #endif
  208. #if SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  209. "ENABLE_BATCH_ATOMIC_WRITE",
  210. #endif
  211. #if SQLITE_ENABLE_CEROD
  212. "ENABLE_CEROD=" CTIMEOPT_VAL(SQLITE_ENABLE_CEROD),
  213. #endif
  214. #if SQLITE_ENABLE_COLUMN_METADATA
  215. "ENABLE_COLUMN_METADATA",
  216. #endif
  217. #if SQLITE_ENABLE_COLUMN_USED_MASK
  218. "ENABLE_COLUMN_USED_MASK",
  219. #endif
  220. #if SQLITE_ENABLE_COSTMULT
  221. "ENABLE_COSTMULT",
  222. #endif
  223. #if SQLITE_ENABLE_CURSOR_HINTS
  224. "ENABLE_CURSOR_HINTS",
  225. #endif
  226. #if SQLITE_ENABLE_DBSTAT_VTAB
  227. "ENABLE_DBSTAT_VTAB",
  228. #endif
  229. #if SQLITE_ENABLE_EXPENSIVE_ASSERT
  230. "ENABLE_EXPENSIVE_ASSERT",
  231. #endif
  232. #if SQLITE_ENABLE_FTS1
  233. "ENABLE_FTS1",
  234. #endif
  235. #if SQLITE_ENABLE_FTS2
  236. "ENABLE_FTS2",
  237. #endif
  238. #if SQLITE_ENABLE_FTS3
  239. "ENABLE_FTS3",
  240. #endif
  241. #if SQLITE_ENABLE_FTS3_PARENTHESIS
  242. "ENABLE_FTS3_PARENTHESIS",
  243. #endif
  244. #if SQLITE_ENABLE_FTS3_TOKENIZER
  245. "ENABLE_FTS3_TOKENIZER",
  246. #endif
  247. #if SQLITE_ENABLE_FTS4
  248. "ENABLE_FTS4",
  249. #endif
  250. #if SQLITE_ENABLE_FTS5
  251. "ENABLE_FTS5",
  252. #endif
  253. #if SQLITE_ENABLE_HIDDEN_COLUMNS
  254. "ENABLE_HIDDEN_COLUMNS",
  255. #endif
  256. #if SQLITE_ENABLE_ICU
  257. "ENABLE_ICU",
  258. #endif
  259. #if SQLITE_ENABLE_IOTRACE
  260. "ENABLE_IOTRACE",
  261. #endif
  262. #if SQLITE_ENABLE_JSON1
  263. "ENABLE_JSON1",
  264. #endif
  265. #if SQLITE_ENABLE_LOAD_EXTENSION
  266. "ENABLE_LOAD_EXTENSION",
  267. #endif
  268. #ifdef SQLITE_ENABLE_LOCKING_STYLE
  269. "ENABLE_LOCKING_STYLE=" CTIMEOPT_VAL(SQLITE_ENABLE_LOCKING_STYLE),
  270. #endif
  271. #if SQLITE_ENABLE_MEMORY_MANAGEMENT
  272. "ENABLE_MEMORY_MANAGEMENT",
  273. #endif
  274. #if SQLITE_ENABLE_MEMSYS3
  275. "ENABLE_MEMSYS3",
  276. #endif
  277. #if SQLITE_ENABLE_MEMSYS5
  278. "ENABLE_MEMSYS5",
  279. #endif
  280. #if SQLITE_ENABLE_MULTIPLEX
  281. "ENABLE_MULTIPLEX",
  282. #endif
  283. #if SQLITE_ENABLE_NULL_TRIM
  284. "ENABLE_NULL_TRIM",
  285. #endif
  286. #if SQLITE_ENABLE_OVERSIZE_CELL_CHECK
  287. "ENABLE_OVERSIZE_CELL_CHECK",
  288. #endif
  289. #if SQLITE_ENABLE_PREUPDATE_HOOK
  290. "ENABLE_PREUPDATE_HOOK",
  291. #endif
  292. #if SQLITE_ENABLE_QPSG
  293. "ENABLE_QPSG",
  294. #endif
  295. #if SQLITE_ENABLE_RBU
  296. "ENABLE_RBU",
  297. #endif
  298. #if SQLITE_ENABLE_RTREE
  299. "ENABLE_RTREE",
  300. #endif
  301. #if SQLITE_ENABLE_SELECTTRACE
  302. "ENABLE_SELECTTRACE",
  303. #endif
  304. #if SQLITE_ENABLE_SESSION
  305. "ENABLE_SESSION",
  306. #endif
  307. #if SQLITE_ENABLE_SNAPSHOT
  308. "ENABLE_SNAPSHOT",
  309. #endif
  310. #if SQLITE_ENABLE_SQLLOG
  311. "ENABLE_SQLLOG",
  312. #endif
  313. #if defined(SQLITE_ENABLE_STAT4)
  314. "ENABLE_STAT4",
  315. #elif defined(SQLITE_ENABLE_STAT3)
  316. "ENABLE_STAT3",
  317. #endif
  318. #if SQLITE_ENABLE_STMTVTAB
  319. "ENABLE_STMTVTAB",
  320. #endif
  321. #if SQLITE_ENABLE_STMT_SCANSTATUS
  322. "ENABLE_STMT_SCANSTATUS",
  323. #endif
  324. #if SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  325. "ENABLE_UNKNOWN_SQL_FUNCTION",
  326. #endif
  327. #if SQLITE_ENABLE_UNLOCK_NOTIFY
  328. "ENABLE_UNLOCK_NOTIFY",
  329. #endif
  330. #if SQLITE_ENABLE_UPDATE_DELETE_LIMIT
  331. "ENABLE_UPDATE_DELETE_LIMIT",
  332. #endif
  333. #if SQLITE_ENABLE_URI_00_ERROR
  334. "ENABLE_URI_00_ERROR",
  335. #endif
  336. #if SQLITE_ENABLE_VFSTRACE
  337. "ENABLE_VFSTRACE",
  338. #endif
  339. #if SQLITE_ENABLE_WHERETRACE
  340. "ENABLE_WHERETRACE",
  341. #endif
  342. #if SQLITE_ENABLE_ZIPVFS
  343. "ENABLE_ZIPVFS",
  344. #endif
  345. #if SQLITE_EXPLAIN_ESTIMATED_ROWS
  346. "EXPLAIN_ESTIMATED_ROWS",
  347. #endif
  348. #if SQLITE_EXTRA_IFNULLROW
  349. "EXTRA_IFNULLROW",
  350. #endif
  351. #ifdef SQLITE_EXTRA_INIT
  352. "EXTRA_INIT=" CTIMEOPT_VAL(SQLITE_EXTRA_INIT),
  353. #endif
  354. #ifdef SQLITE_EXTRA_SHUTDOWN
  355. "EXTRA_SHUTDOWN=" CTIMEOPT_VAL(SQLITE_EXTRA_SHUTDOWN),
  356. #endif
  357. #ifdef SQLITE_FTS3_MAX_EXPR_DEPTH
  358. "FTS3_MAX_EXPR_DEPTH=" CTIMEOPT_VAL(SQLITE_FTS3_MAX_EXPR_DEPTH),
  359. #endif
  360. #if SQLITE_FTS5_ENABLE_TEST_MI
  361. "FTS5_ENABLE_TEST_MI",
  362. #endif
  363. #if SQLITE_FTS5_NO_WITHOUT_ROWID
  364. "FTS5_NO_WITHOUT_ROWID",
  365. #endif
  366. #if SQLITE_HAS_CODEC
  367. "HAS_CODEC",
  368. #endif
  369. #if HAVE_ISNAN || SQLITE_HAVE_ISNAN
  370. "HAVE_ISNAN",
  371. #endif
  372. #if SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  373. "HOMEGROWN_RECURSIVE_MUTEX",
  374. #endif
  375. #if SQLITE_IGNORE_AFP_LOCK_ERRORS
  376. "IGNORE_AFP_LOCK_ERRORS",
  377. #endif
  378. #if SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  379. "IGNORE_FLOCK_LOCK_ERRORS",
  380. #endif
  381. #if SQLITE_INLINE_MEMCPY
  382. "INLINE_MEMCPY",
  383. #endif
  384. #if SQLITE_INT64_TYPE
  385. "INT64_TYPE",
  386. #endif
  387. #ifdef SQLITE_INTEGRITY_CHECK_ERROR_MAX
  388. "INTEGRITY_CHECK_ERROR_MAX=" CTIMEOPT_VAL(SQLITE_INTEGRITY_CHECK_ERROR_MAX),
  389. #endif
  390. #if SQLITE_LIKE_DOESNT_MATCH_BLOBS
  391. "LIKE_DOESNT_MATCH_BLOBS",
  392. #endif
  393. #if SQLITE_LOCK_TRACE
  394. "LOCK_TRACE",
  395. #endif
  396. #if SQLITE_LOG_CACHE_SPILL
  397. "LOG_CACHE_SPILL",
  398. #endif
  399. #ifdef SQLITE_MALLOC_SOFT_LIMIT
  400. "MALLOC_SOFT_LIMIT=" CTIMEOPT_VAL(SQLITE_MALLOC_SOFT_LIMIT),
  401. #endif
  402. #ifdef SQLITE_MAX_ATTACHED
  403. "MAX_ATTACHED=" CTIMEOPT_VAL(SQLITE_MAX_ATTACHED),
  404. #endif
  405. #ifdef SQLITE_MAX_COLUMN
  406. "MAX_COLUMN=" CTIMEOPT_VAL(SQLITE_MAX_COLUMN),
  407. #endif
  408. #ifdef SQLITE_MAX_COMPOUND_SELECT
  409. "MAX_COMPOUND_SELECT=" CTIMEOPT_VAL(SQLITE_MAX_COMPOUND_SELECT),
  410. #endif
  411. #ifdef SQLITE_MAX_DEFAULT_PAGE_SIZE
  412. "MAX_DEFAULT_PAGE_SIZE=" CTIMEOPT_VAL(SQLITE_MAX_DEFAULT_PAGE_SIZE),
  413. #endif
  414. #ifdef SQLITE_MAX_EXPR_DEPTH
  415. "MAX_EXPR_DEPTH=" CTIMEOPT_VAL(SQLITE_MAX_EXPR_DEPTH),
  416. #endif
  417. #ifdef SQLITE_MAX_FUNCTION_ARG
  418. "MAX_FUNCTION_ARG=" CTIMEOPT_VAL(SQLITE_MAX_FUNCTION_ARG),
  419. #endif
  420. #ifdef SQLITE_MAX_LENGTH
  421. "MAX_LENGTH=" CTIMEOPT_VAL(SQLITE_MAX_LENGTH),
  422. #endif
  423. #ifdef SQLITE_MAX_LIKE_PATTERN_LENGTH
  424. "MAX_LIKE_PATTERN_LENGTH=" CTIMEOPT_VAL(SQLITE_MAX_LIKE_PATTERN_LENGTH),
  425. #endif
  426. #ifdef SQLITE_MAX_MEMORY
  427. "MAX_MEMORY=" CTIMEOPT_VAL(SQLITE_MAX_MEMORY),
  428. #endif
  429. #ifdef SQLITE_MAX_MMAP_SIZE
  430. "MAX_MMAP_SIZE=" CTIMEOPT_VAL(SQLITE_MAX_MMAP_SIZE),
  431. #endif
  432. #ifdef SQLITE_MAX_MMAP_SIZE_
  433. "MAX_MMAP_SIZE_=" CTIMEOPT_VAL(SQLITE_MAX_MMAP_SIZE_),
  434. #endif
  435. #ifdef SQLITE_MAX_PAGE_COUNT
  436. "MAX_PAGE_COUNT=" CTIMEOPT_VAL(SQLITE_MAX_PAGE_COUNT),
  437. #endif
  438. #ifdef SQLITE_MAX_PAGE_SIZE
  439. "MAX_PAGE_SIZE=" CTIMEOPT_VAL(SQLITE_MAX_PAGE_SIZE),
  440. #endif
  441. #ifdef SQLITE_MAX_SCHEMA_RETRY
  442. "MAX_SCHEMA_RETRY=" CTIMEOPT_VAL(SQLITE_MAX_SCHEMA_RETRY),
  443. #endif
  444. #ifdef SQLITE_MAX_SQL_LENGTH
  445. "MAX_SQL_LENGTH=" CTIMEOPT_VAL(SQLITE_MAX_SQL_LENGTH),
  446. #endif
  447. #ifdef SQLITE_MAX_TRIGGER_DEPTH
  448. "MAX_TRIGGER_DEPTH=" CTIMEOPT_VAL(SQLITE_MAX_TRIGGER_DEPTH),
  449. #endif
  450. #ifdef SQLITE_MAX_VARIABLE_NUMBER
  451. "MAX_VARIABLE_NUMBER=" CTIMEOPT_VAL(SQLITE_MAX_VARIABLE_NUMBER),
  452. #endif
  453. #ifdef SQLITE_MAX_VDBE_OP
  454. "MAX_VDBE_OP=" CTIMEOPT_VAL(SQLITE_MAX_VDBE_OP),
  455. #endif
  456. #ifdef SQLITE_MAX_WORKER_THREADS
  457. "MAX_WORKER_THREADS=" CTIMEOPT_VAL(SQLITE_MAX_WORKER_THREADS),
  458. #endif
  459. #if SQLITE_MEMDEBUG
  460. "MEMDEBUG",
  461. #endif
  462. #if SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  463. "MIXED_ENDIAN_64BIT_FLOAT",
  464. #endif
  465. #if SQLITE_MMAP_READWRITE
  466. "MMAP_READWRITE",
  467. #endif
  468. #if SQLITE_MUTEX_NOOP
  469. "MUTEX_NOOP",
  470. #endif
  471. #if SQLITE_MUTEX_NREF
  472. "MUTEX_NREF",
  473. #endif
  474. #if SQLITE_MUTEX_OMIT
  475. "MUTEX_OMIT",
  476. #endif
  477. #if SQLITE_MUTEX_PTHREADS
  478. "MUTEX_PTHREADS",
  479. #endif
  480. #if SQLITE_MUTEX_W32
  481. "MUTEX_W32",
  482. #endif
  483. #if SQLITE_NEED_ERR_NAME
  484. "NEED_ERR_NAME",
  485. #endif
  486. #if SQLITE_NOINLINE
  487. "NOINLINE",
  488. #endif
  489. #if SQLITE_NO_SYNC
  490. "NO_SYNC",
  491. #endif
  492. #if SQLITE_OMIT_ALTERTABLE
  493. "OMIT_ALTERTABLE",
  494. #endif
  495. #if SQLITE_OMIT_ANALYZE
  496. "OMIT_ANALYZE",
  497. #endif
  498. #if SQLITE_OMIT_ATTACH
  499. "OMIT_ATTACH",
  500. #endif
  501. #if SQLITE_OMIT_AUTHORIZATION
  502. "OMIT_AUTHORIZATION",
  503. #endif
  504. #if SQLITE_OMIT_AUTOINCREMENT
  505. "OMIT_AUTOINCREMENT",
  506. #endif
  507. #if SQLITE_OMIT_AUTOINIT
  508. "OMIT_AUTOINIT",
  509. #endif
  510. #if SQLITE_OMIT_AUTOMATIC_INDEX
  511. "OMIT_AUTOMATIC_INDEX",
  512. #endif
  513. #if SQLITE_OMIT_AUTORESET
  514. "OMIT_AUTORESET",
  515. #endif
  516. #if SQLITE_OMIT_AUTOVACUUM
  517. "OMIT_AUTOVACUUM",
  518. #endif
  519. #if SQLITE_OMIT_BETWEEN_OPTIMIZATION
  520. "OMIT_BETWEEN_OPTIMIZATION",
  521. #endif
  522. #if SQLITE_OMIT_BLOB_LITERAL
  523. "OMIT_BLOB_LITERAL",
  524. #endif
  525. #if SQLITE_OMIT_BTREECOUNT
  526. "OMIT_BTREECOUNT",
  527. #endif
  528. #if SQLITE_OMIT_CAST
  529. "OMIT_CAST",
  530. #endif
  531. #if SQLITE_OMIT_CHECK
  532. "OMIT_CHECK",
  533. #endif
  534. #if SQLITE_OMIT_COMPLETE
  535. "OMIT_COMPLETE",
  536. #endif
  537. #if SQLITE_OMIT_COMPOUND_SELECT
  538. "OMIT_COMPOUND_SELECT",
  539. #endif
  540. #if SQLITE_OMIT_CONFLICT_CLAUSE
  541. "OMIT_CONFLICT_CLAUSE",
  542. #endif
  543. #if SQLITE_OMIT_CTE
  544. "OMIT_CTE",
  545. #endif
  546. #if SQLITE_OMIT_DATETIME_FUNCS
  547. "OMIT_DATETIME_FUNCS",
  548. #endif
  549. #if SQLITE_OMIT_DECLTYPE
  550. "OMIT_DECLTYPE",
  551. #endif
  552. #if SQLITE_OMIT_DEPRECATED
  553. "OMIT_DEPRECATED",
  554. #endif
  555. #if SQLITE_OMIT_DISKIO
  556. "OMIT_DISKIO",
  557. #endif
  558. #if SQLITE_OMIT_EXPLAIN
  559. "OMIT_EXPLAIN",
  560. #endif
  561. #if SQLITE_OMIT_FLAG_PRAGMAS
  562. "OMIT_FLAG_PRAGMAS",
  563. #endif
  564. #if SQLITE_OMIT_FLOATING_POINT
  565. "OMIT_FLOATING_POINT",
  566. #endif
  567. #if SQLITE_OMIT_FOREIGN_KEY
  568. "OMIT_FOREIGN_KEY",
  569. #endif
  570. #if SQLITE_OMIT_GET_TABLE
  571. "OMIT_GET_TABLE",
  572. #endif
  573. #if SQLITE_OMIT_HEX_INTEGER
  574. "OMIT_HEX_INTEGER",
  575. #endif
  576. #if SQLITE_OMIT_INCRBLOB
  577. "OMIT_INCRBLOB",
  578. #endif
  579. #if SQLITE_OMIT_INTEGRITY_CHECK
  580. "OMIT_INTEGRITY_CHECK",
  581. #endif
  582. #if SQLITE_OMIT_LIKE_OPTIMIZATION
  583. "OMIT_LIKE_OPTIMIZATION",
  584. #endif
  585. #if SQLITE_OMIT_LOAD_EXTENSION
  586. "OMIT_LOAD_EXTENSION",
  587. #endif
  588. #if SQLITE_OMIT_LOCALTIME
  589. "OMIT_LOCALTIME",
  590. #endif
  591. #if SQLITE_OMIT_LOOKASIDE
  592. "OMIT_LOOKASIDE",
  593. #endif
  594. #if SQLITE_OMIT_MEMORYDB
  595. "OMIT_MEMORYDB",
  596. #endif
  597. #if SQLITE_OMIT_OR_OPTIMIZATION
  598. "OMIT_OR_OPTIMIZATION",
  599. #endif
  600. #if SQLITE_OMIT_PAGER_PRAGMAS
  601. "OMIT_PAGER_PRAGMAS",
  602. #endif
  603. #if SQLITE_OMIT_PARSER_TRACE
  604. "OMIT_PARSER_TRACE",
  605. #endif
  606. #if SQLITE_OMIT_POPEN
  607. "OMIT_POPEN",
  608. #endif
  609. #if SQLITE_OMIT_PRAGMA
  610. "OMIT_PRAGMA",
  611. #endif
  612. #if SQLITE_OMIT_PROGRESS_CALLBACK
  613. "OMIT_PROGRESS_CALLBACK",
  614. #endif
  615. #if SQLITE_OMIT_QUICKBALANCE
  616. "OMIT_QUICKBALANCE",
  617. #endif
  618. #if SQLITE_OMIT_REINDEX
  619. "OMIT_REINDEX",
  620. #endif
  621. #if SQLITE_OMIT_SCHEMA_PRAGMAS
  622. "OMIT_SCHEMA_PRAGMAS",
  623. #endif
  624. #if SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
  625. "OMIT_SCHEMA_VERSION_PRAGMAS",
  626. #endif
  627. #if SQLITE_OMIT_SHARED_CACHE
  628. "OMIT_SHARED_CACHE",
  629. #endif
  630. #if SQLITE_OMIT_SHUTDOWN_DIRECTORIES
  631. "OMIT_SHUTDOWN_DIRECTORIES",
  632. #endif
  633. #if SQLITE_OMIT_SUBQUERY
  634. "OMIT_SUBQUERY",
  635. #endif
  636. #if SQLITE_OMIT_TCL_VARIABLE
  637. "OMIT_TCL_VARIABLE",
  638. #endif
  639. #if SQLITE_OMIT_TEMPDB
  640. "OMIT_TEMPDB",
  641. #endif
  642. #if SQLITE_OMIT_TEST_CONTROL
  643. "OMIT_TEST_CONTROL",
  644. #endif
  645. #if SQLITE_OMIT_TRACE
  646. "OMIT_TRACE",
  647. #endif
  648. #if SQLITE_OMIT_TRIGGER
  649. "OMIT_TRIGGER",
  650. #endif
  651. #if SQLITE_OMIT_TRUNCATE_OPTIMIZATION
  652. "OMIT_TRUNCATE_OPTIMIZATION",
  653. #endif
  654. #if SQLITE_OMIT_UTF16
  655. "OMIT_UTF16",
  656. #endif
  657. #if SQLITE_OMIT_VACUUM
  658. "OMIT_VACUUM",
  659. #endif
  660. #if SQLITE_OMIT_VIEW
  661. "OMIT_VIEW",
  662. #endif
  663. #if SQLITE_OMIT_VIRTUALTABLE
  664. "OMIT_VIRTUALTABLE",
  665. #endif
  666. #if SQLITE_OMIT_WAL
  667. "OMIT_WAL",
  668. #endif
  669. #if SQLITE_OMIT_WSD
  670. "OMIT_WSD",
  671. #endif
  672. #if SQLITE_OMIT_XFER_OPT
  673. "OMIT_XFER_OPT",
  674. #endif
  675. #if SQLITE_PCACHE_SEPARATE_HEADER
  676. "PCACHE_SEPARATE_HEADER",
  677. #endif
  678. #if SQLITE_PERFORMANCE_TRACE
  679. "PERFORMANCE_TRACE",
  680. #endif
  681. #if SQLITE_POWERSAFE_OVERWRITE
  682. "POWERSAFE_OVERWRITE",
  683. #endif
  684. #if SQLITE_PREFER_PROXY_LOCKING
  685. "PREFER_PROXY_LOCKING",
  686. #endif
  687. #if SQLITE_PROXY_DEBUG
  688. "PROXY_DEBUG",
  689. #endif
  690. #if SQLITE_REVERSE_UNORDERED_SELECTS
  691. "REVERSE_UNORDERED_SELECTS",
  692. #endif
  693. #if SQLITE_RTREE_INT_ONLY
  694. "RTREE_INT_ONLY",
  695. #endif
  696. #if SQLITE_SECURE_DELETE
  697. "SECURE_DELETE",
  698. #endif
  699. #if SQLITE_SMALL_STACK
  700. "SMALL_STACK",
  701. #endif
  702. #ifdef SQLITE_SORTER_PMASZ
  703. "SORTER_PMASZ=" CTIMEOPT_VAL(SQLITE_SORTER_PMASZ),
  704. #endif
  705. #if SQLITE_SOUNDEX
  706. "SOUNDEX",
  707. #endif
  708. #ifdef SQLITE_STAT4_SAMPLES
  709. "STAT4_SAMPLES=" CTIMEOPT_VAL(SQLITE_STAT4_SAMPLES),
  710. #endif
  711. #ifdef SQLITE_STMTJRNL_SPILL
  712. "STMTJRNL_SPILL=" CTIMEOPT_VAL(SQLITE_STMTJRNL_SPILL),
  713. #endif
  714. #if SQLITE_SUBSTR_COMPATIBILITY
  715. "SUBSTR_COMPATIBILITY",
  716. #endif
  717. #if SQLITE_SYSTEM_MALLOC
  718. "SYSTEM_MALLOC",
  719. #endif
  720. #if SQLITE_TCL
  721. "TCL",
  722. #endif
  723. #ifdef SQLITE_TEMP_STORE
  724. "TEMP_STORE=" CTIMEOPT_VAL(SQLITE_TEMP_STORE),
  725. #endif
  726. #if SQLITE_TEST
  727. "TEST",
  728. #endif
  729. #if defined(SQLITE_THREADSAFE)
  730. "THREADSAFE=" CTIMEOPT_VAL(SQLITE_THREADSAFE),
  731. #elif defined(THREADSAFE)
  732. "THREADSAFE=" CTIMEOPT_VAL(THREADSAFE),
  733. #else
  734. "THREADSAFE=1",
  735. #endif
  736. #if SQLITE_UNLINK_AFTER_CLOSE
  737. "UNLINK_AFTER_CLOSE",
  738. #endif
  739. #if SQLITE_UNTESTABLE
  740. "UNTESTABLE",
  741. #endif
  742. #if SQLITE_USER_AUTHENTICATION
  743. "USER_AUTHENTICATION",
  744. #endif
  745. #if SQLITE_USE_ALLOCA
  746. "USE_ALLOCA",
  747. #endif
  748. #if SQLITE_USE_FCNTL_TRACE
  749. "USE_FCNTL_TRACE",
  750. #endif
  751. #if SQLITE_USE_URI
  752. "USE_URI",
  753. #endif
  754. #if SQLITE_VDBE_COVERAGE
  755. "VDBE_COVERAGE",
  756. #endif
  757. #if SQLITE_WIN32_MALLOC
  758. "WIN32_MALLOC",
  759. #endif
  760. #if SQLITE_ZERO_MALLOC
  761. "ZERO_MALLOC",
  762. #endif
  763. /*
  764. ** END CODE GENERATED BY tool/mkctime.tcl
  765. */
  766. };
  767. SQLITE_PRIVATE const char **sqlite3CompileOptions(int *pnOpt){
  768. *pnOpt = sizeof(sqlite3azCompileOpt) / sizeof(sqlite3azCompileOpt[0]);
  769. return (const char**)sqlite3azCompileOpt;
  770. }
  771. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  772. /************** End of ctime.c ***********************************************/
  773. /************** Begin file sqliteInt.h ***************************************/
  774. /*
  775. ** 2001 September 15
  776. **
  777. ** The author disclaims copyright to this source code. In place of
  778. ** a legal notice, here is a blessing:
  779. **
  780. ** May you do good and not evil.
  781. ** May you find forgiveness for yourself and forgive others.
  782. ** May you share freely, never taking more than you give.
  783. **
  784. *************************************************************************
  785. ** Internal interface definitions for SQLite.
  786. **
  787. */
  788. #ifndef SQLITEINT_H
  789. #define SQLITEINT_H
  790. /* Special Comments:
  791. **
  792. ** Some comments have special meaning to the tools that measure test
  793. ** coverage:
  794. **
  795. ** NO_TEST - The branches on this line are not
  796. ** measured by branch coverage. This is
  797. ** used on lines of code that actually
  798. ** implement parts of coverage testing.
  799. **
  800. ** OPTIMIZATION-IF-TRUE - This branch is allowed to alway be false
  801. ** and the correct answer is still obtained,
  802. ** though perhaps more slowly.
  803. **
  804. ** OPTIMIZATION-IF-FALSE - This branch is allowed to alway be true
  805. ** and the correct answer is still obtained,
  806. ** though perhaps more slowly.
  807. **
  808. ** PREVENTS-HARMLESS-OVERREAD - This branch prevents a buffer overread
  809. ** that would be harmless and undetectable
  810. ** if it did occur.
  811. **
  812. ** In all cases, the special comment must be enclosed in the usual
  813. ** slash-asterisk...asterisk-slash comment marks, with no spaces between the
  814. ** asterisks and the comment text.
  815. */
  816. /*
  817. ** Make sure the Tcl calling convention macro is defined. This macro is
  818. ** only used by test code and Tcl integration code.
  819. */
  820. #ifndef SQLITE_TCLAPI
  821. # define SQLITE_TCLAPI
  822. #endif
  823. /*
  824. ** Include the header file used to customize the compiler options for MSVC.
  825. ** This should be done first so that it can successfully prevent spurious
  826. ** compiler warnings due to subsequent content in this file and other files
  827. ** that are included by this file.
  828. */
  829. /************** Include msvc.h in the middle of sqliteInt.h ******************/
  830. /************** Begin file msvc.h ********************************************/
  831. /*
  832. ** 2015 January 12
  833. **
  834. ** The author disclaims copyright to this source code. In place of
  835. ** a legal notice, here is a blessing:
  836. **
  837. ** May you do good and not evil.
  838. ** May you find forgiveness for yourself and forgive others.
  839. ** May you share freely, never taking more than you give.
  840. **
  841. ******************************************************************************
  842. **
  843. ** This file contains code that is specific to MSVC.
  844. */
  845. #ifndef SQLITE_MSVC_H
  846. #define SQLITE_MSVC_H
  847. #if defined(_MSC_VER)
  848. #pragma warning(disable : 4054)
  849. #pragma warning(disable : 4055)
  850. #pragma warning(disable : 4100)
  851. #pragma warning(disable : 4127)
  852. #pragma warning(disable : 4130)
  853. #pragma warning(disable : 4152)
  854. #pragma warning(disable : 4189)
  855. #pragma warning(disable : 4206)
  856. #pragma warning(disable : 4210)
  857. #pragma warning(disable : 4232)
  858. #pragma warning(disable : 4244)
  859. #pragma warning(disable : 4305)
  860. #pragma warning(disable : 4306)
  861. #pragma warning(disable : 4702)
  862. #pragma warning(disable : 4706)
  863. #endif /* defined(_MSC_VER) */
  864. #endif /* SQLITE_MSVC_H */
  865. /************** End of msvc.h ************************************************/
  866. /************** Continuing where we left off in sqliteInt.h ******************/
  867. /*
  868. ** Special setup for VxWorks
  869. */
  870. /************** Include vxworks.h in the middle of sqliteInt.h ***************/
  871. /************** Begin file vxworks.h *****************************************/
  872. /*
  873. ** 2015-03-02
  874. **
  875. ** The author disclaims copyright to this source code. In place of
  876. ** a legal notice, here is a blessing:
  877. **
  878. ** May you do good and not evil.
  879. ** May you find forgiveness for yourself and forgive others.
  880. ** May you share freely, never taking more than you give.
  881. **
  882. ******************************************************************************
  883. **
  884. ** This file contains code that is specific to Wind River's VxWorks
  885. */
  886. #if defined(__RTP__) || defined(_WRS_KERNEL)
  887. /* This is VxWorks. Set up things specially for that OS
  888. */
  889. #include <vxWorks.h>
  890. #include <pthread.h> /* amalgamator: dontcache */
  891. #define OS_VXWORKS 1
  892. #define SQLITE_OS_OTHER 0
  893. #define SQLITE_HOMEGROWN_RECURSIVE_MUTEX 1
  894. #define SQLITE_OMIT_LOAD_EXTENSION 1
  895. #define SQLITE_ENABLE_LOCKING_STYLE 0
  896. #define HAVE_UTIME 1
  897. #else
  898. /* This is not VxWorks. */
  899. #define OS_VXWORKS 0
  900. #define HAVE_FCHOWN 1
  901. #define HAVE_READLINK 1
  902. #define HAVE_LSTAT 1
  903. #endif /* defined(_WRS_KERNEL) */
  904. /************** End of vxworks.h *********************************************/
  905. /************** Continuing where we left off in sqliteInt.h ******************/
  906. /*
  907. ** These #defines should enable >2GB file support on POSIX if the
  908. ** underlying operating system supports it. If the OS lacks
  909. ** large file support, or if the OS is windows, these should be no-ops.
  910. **
  911. ** Ticket #2739: The _LARGEFILE_SOURCE macro must appear before any
  912. ** system #includes. Hence, this block of code must be the very first
  913. ** code in all source files.
  914. **
  915. ** Large file support can be disabled using the -DSQLITE_DISABLE_LFS switch
  916. ** on the compiler command line. This is necessary if you are compiling
  917. ** on a recent machine (ex: Red Hat 7.2) but you want your code to work
  918. ** on an older machine (ex: Red Hat 6.0). If you compile on Red Hat 7.2
  919. ** without this option, LFS is enable. But LFS does not exist in the kernel
  920. ** in Red Hat 6.0, so the code won't work. Hence, for maximum binary
  921. ** portability you should omit LFS.
  922. **
  923. ** The previous paragraph was written in 2005. (This paragraph is written
  924. ** on 2008-11-28.) These days, all Linux kernels support large files, so
  925. ** you should probably leave LFS enabled. But some embedded platforms might
  926. ** lack LFS in which case the SQLITE_DISABLE_LFS macro might still be useful.
  927. **
  928. ** Similar is true for Mac OS X. LFS is only supported on Mac OS X 9 and later.
  929. */
  930. #ifndef SQLITE_DISABLE_LFS
  931. # define _LARGE_FILE 1
  932. # ifndef _FILE_OFFSET_BITS
  933. # define _FILE_OFFSET_BITS 64
  934. # endif
  935. # define _LARGEFILE_SOURCE 1
  936. #endif
  937. /* The GCC_VERSION and MSVC_VERSION macros are used to
  938. ** conditionally include optimizations for each of these compilers. A
  939. ** value of 0 means that compiler is not being used. The
  940. ** SQLITE_DISABLE_INTRINSIC macro means do not use any compiler-specific
  941. ** optimizations, and hence set all compiler macros to 0
  942. **
  943. ** There was once also a CLANG_VERSION macro. However, we learn that the
  944. ** version numbers in clang are for "marketing" only and are inconsistent
  945. ** and unreliable. Fortunately, all versions of clang also recognize the
  946. ** gcc version numbers and have reasonable settings for gcc version numbers,
  947. ** so the GCC_VERSION macro will be set to a correct non-zero value even
  948. ** when compiling with clang.
  949. */
  950. #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC)
  951. # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
  952. #else
  953. # define GCC_VERSION 0
  954. #endif
  955. #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC)
  956. # define MSVC_VERSION _MSC_VER
  957. #else
  958. # define MSVC_VERSION 0
  959. #endif
  960. /* Needed for various definitions... */
  961. #if defined(__GNUC__) && !defined(_GNU_SOURCE)
  962. # define _GNU_SOURCE
  963. #endif
  964. #if defined(__OpenBSD__) && !defined(_BSD_SOURCE)
  965. # define _BSD_SOURCE
  966. #endif
  967. /*
  968. ** For MinGW, check to see if we can include the header file containing its
  969. ** version information, among other things. Normally, this internal MinGW
  970. ** header file would [only] be included automatically by other MinGW header
  971. ** files; however, the contained version information is now required by this
  972. ** header file to work around binary compatibility issues (see below) and
  973. ** this is the only known way to reliably obtain it. This entire #if block
  974. ** would be completely unnecessary if there was any other way of detecting
  975. ** MinGW via their preprocessor (e.g. if they customized their GCC to define
  976. ** some MinGW-specific macros). When compiling for MinGW, either the
  977. ** _HAVE_MINGW_H or _HAVE__MINGW_H (note the extra underscore) macro must be
  978. ** defined; otherwise, detection of conditions specific to MinGW will be
  979. ** disabled.
  980. */
  981. #if defined(_HAVE_MINGW_H)
  982. # include "mingw.h"
  983. #elif defined(_HAVE__MINGW_H)
  984. # include "_mingw.h"
  985. #endif
  986. /*
  987. ** For MinGW version 4.x (and higher), check to see if the _USE_32BIT_TIME_T
  988. ** define is required to maintain binary compatibility with the MSVC runtime
  989. ** library in use (e.g. for Windows XP).
  990. */
  991. #if !defined(_USE_32BIT_TIME_T) && !defined(_USE_64BIT_TIME_T) && \
  992. defined(_WIN32) && !defined(_WIN64) && \
  993. defined(__MINGW_MAJOR_VERSION) && __MINGW_MAJOR_VERSION >= 4 && \
  994. defined(__MSVCRT__)
  995. # define _USE_32BIT_TIME_T
  996. #endif
  997. /* The public SQLite interface. The _FILE_OFFSET_BITS macro must appear
  998. ** first in QNX. Also, the _USE_32BIT_TIME_T macro must appear first for
  999. ** MinGW.
  1000. */
  1001. /************** Include sqlite3.h in the middle of sqliteInt.h ***************/
  1002. /************** Begin file sqlite3.h *****************************************/
  1003. /*
  1004. ** 2001-09-15
  1005. **
  1006. ** The author disclaims copyright to this source code. In place of
  1007. ** a legal notice, here is a blessing:
  1008. **
  1009. ** May you do good and not evil.
  1010. ** May you find forgiveness for yourself and forgive others.
  1011. ** May you share freely, never taking more than you give.
  1012. **
  1013. *************************************************************************
  1014. ** This header file defines the interface that the SQLite library
  1015. ** presents to client programs. If a C-function, structure, datatype,
  1016. ** or constant definition does not appear in this file, then it is
  1017. ** not a published API of SQLite, is subject to change without
  1018. ** notice, and should not be referenced by programs that use SQLite.
  1019. **
  1020. ** Some of the definitions that are in this file are marked as
  1021. ** "experimental". Experimental interfaces are normally new
  1022. ** features recently added to SQLite. We do not anticipate changes
  1023. ** to experimental interfaces but reserve the right to make minor changes
  1024. ** if experience from use "in the wild" suggest such changes are prudent.
  1025. **
  1026. ** The official C-language API documentation for SQLite is derived
  1027. ** from comments in this file. This file is the authoritative source
  1028. ** on how SQLite interfaces are supposed to operate.
  1029. **
  1030. ** The name of this file under configuration management is "sqlite.h.in".
  1031. ** The makefile makes some minor changes to this file (such as inserting
  1032. ** the version number) and changes its name to "sqlite3.h" as
  1033. ** part of the build process.
  1034. */
  1035. #ifndef SQLITE3_H
  1036. #define SQLITE3_H
  1037. #include <stdarg.h> /* Needed for the definition of va_list */
  1038. /*
  1039. ** Make sure we can call this stuff from C++.
  1040. */
  1041. #if 0
  1042. extern "C" {
  1043. #endif
  1044. /*
  1045. ** Provide the ability to override linkage features of the interface.
  1046. */
  1047. #ifndef SQLITE_EXTERN
  1048. # define SQLITE_EXTERN extern
  1049. #endif
  1050. #ifndef SQLITE_API
  1051. # define SQLITE_API
  1052. #endif
  1053. #ifndef SQLITE_CDECL
  1054. # define SQLITE_CDECL
  1055. #endif
  1056. #ifndef SQLITE_APICALL
  1057. # define SQLITE_APICALL
  1058. #endif
  1059. #ifndef SQLITE_STDCALL
  1060. # define SQLITE_STDCALL SQLITE_APICALL
  1061. #endif
  1062. #ifndef SQLITE_CALLBACK
  1063. # define SQLITE_CALLBACK
  1064. #endif
  1065. #ifndef SQLITE_SYSAPI
  1066. # define SQLITE_SYSAPI
  1067. #endif
  1068. /*
  1069. ** These no-op macros are used in front of interfaces to mark those
  1070. ** interfaces as either deprecated or experimental. New applications
  1071. ** should not use deprecated interfaces - they are supported for backwards
  1072. ** compatibility only. Application writers should be aware that
  1073. ** experimental interfaces are subject to change in point releases.
  1074. **
  1075. ** These macros used to resolve to various kinds of compiler magic that
  1076. ** would generate warning messages when they were used. But that
  1077. ** compiler magic ended up generating such a flurry of bug reports
  1078. ** that we have taken it all out and gone back to using simple
  1079. ** noop macros.
  1080. */
  1081. #define SQLITE_DEPRECATED
  1082. #define SQLITE_EXPERIMENTAL
  1083. /*
  1084. ** Ensure these symbols were not defined by some previous header file.
  1085. */
  1086. #ifdef SQLITE_VERSION
  1087. # undef SQLITE_VERSION
  1088. #endif
  1089. #ifdef SQLITE_VERSION_NUMBER
  1090. # undef SQLITE_VERSION_NUMBER
  1091. #endif
  1092. /*
  1093. ** CAPI3REF: Compile-Time Library Version Numbers
  1094. **
  1095. ** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
  1096. ** evaluates to a string literal that is the SQLite version in the
  1097. ** format "X.Y.Z" where X is the major version number (always 3 for
  1098. ** SQLite3) and Y is the minor version number and Z is the release number.)^
  1099. ** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
  1100. ** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
  1101. ** numbers used in [SQLITE_VERSION].)^
  1102. ** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
  1103. ** be larger than the release from which it is derived. Either Y will
  1104. ** be held constant and Z will be incremented or else Y will be incremented
  1105. ** and Z will be reset to zero.
  1106. **
  1107. ** Since [version 3.6.18] ([dateof:3.6.18]),
  1108. ** SQLite source code has been stored in the
  1109. ** <a href="http://www.fossil-scm.org/">Fossil configuration management
  1110. ** system</a>. ^The SQLITE_SOURCE_ID macro evaluates to
  1111. ** a string which identifies a particular check-in of SQLite
  1112. ** within its configuration management system. ^The SQLITE_SOURCE_ID
  1113. ** string contains the date and time of the check-in (UTC) and a SHA1
  1114. ** or SHA3-256 hash of the entire source tree. If the source code has
  1115. ** been edited in any way since it was last checked in, then the last
  1116. ** four hexadecimal digits of the hash may be modified.
  1117. **
  1118. ** See also: [sqlite3_libversion()],
  1119. ** [sqlite3_libversion_number()], [sqlite3_sourceid()],
  1120. ** [sqlite_version()] and [sqlite_source_id()].
  1121. */
  1122. #define SQLITE_VERSION "3.23.1"
  1123. #define SQLITE_VERSION_NUMBER 3023001
  1124. #define SQLITE_SOURCE_ID "2018-04-10 17:39:29 4bb2294022060e61de7da5c227a69ccd846ba330e31626ebcd59a94efd148b3b"
  1125. /*
  1126. ** CAPI3REF: Run-Time Library Version Numbers
  1127. ** KEYWORDS: sqlite3_version sqlite3_sourceid
  1128. **
  1129. ** These interfaces provide the same information as the [SQLITE_VERSION],
  1130. ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
  1131. ** but are associated with the library instead of the header file. ^(Cautious
  1132. ** programmers might include assert() statements in their application to
  1133. ** verify that values returned by these interfaces match the macros in
  1134. ** the header, and thus ensure that the application is
  1135. ** compiled with matching library and header files.
  1136. **
  1137. ** <blockquote><pre>
  1138. ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
  1139. ** assert( strncmp(sqlite3_sourceid(),SQLITE_SOURCE_ID,80)==0 );
  1140. ** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
  1141. ** </pre></blockquote>)^
  1142. **
  1143. ** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
  1144. ** macro. ^The sqlite3_libversion() function returns a pointer to the
  1145. ** to the sqlite3_version[] string constant. The sqlite3_libversion()
  1146. ** function is provided for use in DLLs since DLL users usually do not have
  1147. ** direct access to string constants within the DLL. ^The
  1148. ** sqlite3_libversion_number() function returns an integer equal to
  1149. ** [SQLITE_VERSION_NUMBER]. ^(The sqlite3_sourceid() function returns
  1150. ** a pointer to a string constant whose value is the same as the
  1151. ** [SQLITE_SOURCE_ID] C preprocessor macro. Except if SQLite is built
  1152. ** using an edited copy of [the amalgamation], then the last four characters
  1153. ** of the hash might be different from [SQLITE_SOURCE_ID].)^
  1154. **
  1155. ** See also: [sqlite_version()] and [sqlite_source_id()].
  1156. */
  1157. SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
  1158. SQLITE_API const char *sqlite3_libversion(void);
  1159. SQLITE_API const char *sqlite3_sourceid(void);
  1160. SQLITE_API int sqlite3_libversion_number(void);
  1161. /*
  1162. ** CAPI3REF: Run-Time Library Compilation Options Diagnostics
  1163. **
  1164. ** ^The sqlite3_compileoption_used() function returns 0 or 1
  1165. ** indicating whether the specified option was defined at
  1166. ** compile time. ^The SQLITE_ prefix may be omitted from the
  1167. ** option name passed to sqlite3_compileoption_used().
  1168. **
  1169. ** ^The sqlite3_compileoption_get() function allows iterating
  1170. ** over the list of options that were defined at compile time by
  1171. ** returning the N-th compile time option string. ^If N is out of range,
  1172. ** sqlite3_compileoption_get() returns a NULL pointer. ^The SQLITE_
  1173. ** prefix is omitted from any strings returned by
  1174. ** sqlite3_compileoption_get().
  1175. **
  1176. ** ^Support for the diagnostic functions sqlite3_compileoption_used()
  1177. ** and sqlite3_compileoption_get() may be omitted by specifying the
  1178. ** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
  1179. **
  1180. ** See also: SQL functions [sqlite_compileoption_used()] and
  1181. ** [sqlite_compileoption_get()] and the [compile_options pragma].
  1182. */
  1183. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  1184. SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
  1185. SQLITE_API const char *sqlite3_compileoption_get(int N);
  1186. #endif
  1187. /*
  1188. ** CAPI3REF: Test To See If The Library Is Threadsafe
  1189. **
  1190. ** ^The sqlite3_threadsafe() function returns zero if and only if
  1191. ** SQLite was compiled with mutexing code omitted due to the
  1192. ** [SQLITE_THREADSAFE] compile-time option being set to 0.
  1193. **
  1194. ** SQLite can be compiled with or without mutexes. When
  1195. ** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
  1196. ** are enabled and SQLite is threadsafe. When the
  1197. ** [SQLITE_THREADSAFE] macro is 0,
  1198. ** the mutexes are omitted. Without the mutexes, it is not safe
  1199. ** to use SQLite concurrently from more than one thread.
  1200. **
  1201. ** Enabling mutexes incurs a measurable performance penalty.
  1202. ** So if speed is of utmost importance, it makes sense to disable
  1203. ** the mutexes. But for maximum safety, mutexes should be enabled.
  1204. ** ^The default behavior is for mutexes to be enabled.
  1205. **
  1206. ** This interface can be used by an application to make sure that the
  1207. ** version of SQLite that it is linking against was compiled with
  1208. ** the desired setting of the [SQLITE_THREADSAFE] macro.
  1209. **
  1210. ** This interface only reports on the compile-time mutex setting
  1211. ** of the [SQLITE_THREADSAFE] flag. If SQLite is compiled with
  1212. ** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
  1213. ** can be fully or partially disabled using a call to [sqlite3_config()]
  1214. ** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
  1215. ** or [SQLITE_CONFIG_SERIALIZED]. ^(The return value of the
  1216. ** sqlite3_threadsafe() function shows only the compile-time setting of
  1217. ** thread safety, not any run-time changes to that setting made by
  1218. ** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
  1219. ** is unchanged by calls to sqlite3_config().)^
  1220. **
  1221. ** See the [threading mode] documentation for additional information.
  1222. */
  1223. SQLITE_API int sqlite3_threadsafe(void);
  1224. /*
  1225. ** CAPI3REF: Database Connection Handle
  1226. ** KEYWORDS: {database connection} {database connections}
  1227. **
  1228. ** Each open SQLite database is represented by a pointer to an instance of
  1229. ** the opaque structure named "sqlite3". It is useful to think of an sqlite3
  1230. ** pointer as an object. The [sqlite3_open()], [sqlite3_open16()], and
  1231. ** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
  1232. ** and [sqlite3_close_v2()] are its destructors. There are many other
  1233. ** interfaces (such as
  1234. ** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
  1235. ** [sqlite3_busy_timeout()] to name but three) that are methods on an
  1236. ** sqlite3 object.
  1237. */
  1238. typedef struct sqlite3 sqlite3;
  1239. /*
  1240. ** CAPI3REF: 64-Bit Integer Types
  1241. ** KEYWORDS: sqlite_int64 sqlite_uint64
  1242. **
  1243. ** Because there is no cross-platform way to specify 64-bit integer types
  1244. ** SQLite includes typedefs for 64-bit signed and unsigned integers.
  1245. **
  1246. ** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
  1247. ** The sqlite_int64 and sqlite_uint64 types are supported for backwards
  1248. ** compatibility only.
  1249. **
  1250. ** ^The sqlite3_int64 and sqlite_int64 types can store integer values
  1251. ** between -9223372036854775808 and +9223372036854775807 inclusive. ^The
  1252. ** sqlite3_uint64 and sqlite_uint64 types can store integer values
  1253. ** between 0 and +18446744073709551615 inclusive.
  1254. */
  1255. #ifdef SQLITE_INT64_TYPE
  1256. typedef SQLITE_INT64_TYPE sqlite_int64;
  1257. # ifdef SQLITE_UINT64_TYPE
  1258. typedef SQLITE_UINT64_TYPE sqlite_uint64;
  1259. # else
  1260. typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
  1261. # endif
  1262. #elif defined(_MSC_VER) || defined(__BORLANDC__)
  1263. typedef __int64 sqlite_int64;
  1264. typedef unsigned __int64 sqlite_uint64;
  1265. #else
  1266. typedef long long int sqlite_int64;
  1267. typedef unsigned long long int sqlite_uint64;
  1268. #endif
  1269. typedef sqlite_int64 sqlite3_int64;
  1270. typedef sqlite_uint64 sqlite3_uint64;
  1271. /*
  1272. ** If compiling for a processor that lacks floating point support,
  1273. ** substitute integer for floating-point.
  1274. */
  1275. #ifdef SQLITE_OMIT_FLOATING_POINT
  1276. # define double sqlite3_int64
  1277. #endif
  1278. /*
  1279. ** CAPI3REF: Closing A Database Connection
  1280. ** DESTRUCTOR: sqlite3
  1281. **
  1282. ** ^The sqlite3_close() and sqlite3_close_v2() routines are destructors
  1283. ** for the [sqlite3] object.
  1284. ** ^Calls to sqlite3_close() and sqlite3_close_v2() return [SQLITE_OK] if
  1285. ** the [sqlite3] object is successfully destroyed and all associated
  1286. ** resources are deallocated.
  1287. **
  1288. ** ^If the database connection is associated with unfinalized prepared
  1289. ** statements or unfinished sqlite3_backup objects then sqlite3_close()
  1290. ** will leave the database connection open and return [SQLITE_BUSY].
  1291. ** ^If sqlite3_close_v2() is called with unfinalized prepared statements
  1292. ** and/or unfinished sqlite3_backups, then the database connection becomes
  1293. ** an unusable "zombie" which will automatically be deallocated when the
  1294. ** last prepared statement is finalized or the last sqlite3_backup is
  1295. ** finished. The sqlite3_close_v2() interface is intended for use with
  1296. ** host languages that are garbage collected, and where the order in which
  1297. ** destructors are called is arbitrary.
  1298. **
  1299. ** Applications should [sqlite3_finalize | finalize] all [prepared statements],
  1300. ** [sqlite3_blob_close | close] all [BLOB handles], and
  1301. ** [sqlite3_backup_finish | finish] all [sqlite3_backup] objects associated
  1302. ** with the [sqlite3] object prior to attempting to close the object. ^If
  1303. ** sqlite3_close_v2() is called on a [database connection] that still has
  1304. ** outstanding [prepared statements], [BLOB handles], and/or
  1305. ** [sqlite3_backup] objects then it returns [SQLITE_OK] and the deallocation
  1306. ** of resources is deferred until all [prepared statements], [BLOB handles],
  1307. ** and [sqlite3_backup] objects are also destroyed.
  1308. **
  1309. ** ^If an [sqlite3] object is destroyed while a transaction is open,
  1310. ** the transaction is automatically rolled back.
  1311. **
  1312. ** The C parameter to [sqlite3_close(C)] and [sqlite3_close_v2(C)]
  1313. ** must be either a NULL
  1314. ** pointer or an [sqlite3] object pointer obtained
  1315. ** from [sqlite3_open()], [sqlite3_open16()], or
  1316. ** [sqlite3_open_v2()], and not previously closed.
  1317. ** ^Calling sqlite3_close() or sqlite3_close_v2() with a NULL pointer
  1318. ** argument is a harmless no-op.
  1319. */
  1320. SQLITE_API int sqlite3_close(sqlite3*);
  1321. SQLITE_API int sqlite3_close_v2(sqlite3*);
  1322. /*
  1323. ** The type for a callback function.
  1324. ** This is legacy and deprecated. It is included for historical
  1325. ** compatibility and is not documented.
  1326. */
  1327. typedef int (*sqlite3_callback)(void*,int,char**, char**);
  1328. /*
  1329. ** CAPI3REF: One-Step Query Execution Interface
  1330. ** METHOD: sqlite3
  1331. **
  1332. ** The sqlite3_exec() interface is a convenience wrapper around
  1333. ** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
  1334. ** that allows an application to run multiple statements of SQL
  1335. ** without having to use a lot of C code.
  1336. **
  1337. ** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
  1338. ** semicolon-separate SQL statements passed into its 2nd argument,
  1339. ** in the context of the [database connection] passed in as its 1st
  1340. ** argument. ^If the callback function of the 3rd argument to
  1341. ** sqlite3_exec() is not NULL, then it is invoked for each result row
  1342. ** coming out of the evaluated SQL statements. ^The 4th argument to
  1343. ** sqlite3_exec() is relayed through to the 1st argument of each
  1344. ** callback invocation. ^If the callback pointer to sqlite3_exec()
  1345. ** is NULL, then no callback is ever invoked and result rows are
  1346. ** ignored.
  1347. **
  1348. ** ^If an error occurs while evaluating the SQL statements passed into
  1349. ** sqlite3_exec(), then execution of the current statement stops and
  1350. ** subsequent statements are skipped. ^If the 5th parameter to sqlite3_exec()
  1351. ** is not NULL then any error message is written into memory obtained
  1352. ** from [sqlite3_malloc()] and passed back through the 5th parameter.
  1353. ** To avoid memory leaks, the application should invoke [sqlite3_free()]
  1354. ** on error message strings returned through the 5th parameter of
  1355. ** sqlite3_exec() after the error message string is no longer needed.
  1356. ** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
  1357. ** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
  1358. ** NULL before returning.
  1359. **
  1360. ** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
  1361. ** routine returns SQLITE_ABORT without invoking the callback again and
  1362. ** without running any subsequent SQL statements.
  1363. **
  1364. ** ^The 2nd argument to the sqlite3_exec() callback function is the
  1365. ** number of columns in the result. ^The 3rd argument to the sqlite3_exec()
  1366. ** callback is an array of pointers to strings obtained as if from
  1367. ** [sqlite3_column_text()], one for each column. ^If an element of a
  1368. ** result row is NULL then the corresponding string pointer for the
  1369. ** sqlite3_exec() callback is a NULL pointer. ^The 4th argument to the
  1370. ** sqlite3_exec() callback is an array of pointers to strings where each
  1371. ** entry represents the name of corresponding result column as obtained
  1372. ** from [sqlite3_column_name()].
  1373. **
  1374. ** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
  1375. ** to an empty string, or a pointer that contains only whitespace and/or
  1376. ** SQL comments, then no SQL statements are evaluated and the database
  1377. ** is not changed.
  1378. **
  1379. ** Restrictions:
  1380. **
  1381. ** <ul>
  1382. ** <li> The application must ensure that the 1st parameter to sqlite3_exec()
  1383. ** is a valid and open [database connection].
  1384. ** <li> The application must not close the [database connection] specified by
  1385. ** the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
  1386. ** <li> The application must not modify the SQL statement text passed into
  1387. ** the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
  1388. ** </ul>
  1389. */
  1390. SQLITE_API int sqlite3_exec(
  1391. sqlite3*, /* An open database */
  1392. const char *sql, /* SQL to be evaluated */
  1393. int (*callback)(void*,int,char**,char**), /* Callback function */
  1394. void *, /* 1st argument to callback */
  1395. char **errmsg /* Error msg written here */
  1396. );
  1397. /*
  1398. ** CAPI3REF: Result Codes
  1399. ** KEYWORDS: {result code definitions}
  1400. **
  1401. ** Many SQLite functions return an integer result code from the set shown
  1402. ** here in order to indicate success or failure.
  1403. **
  1404. ** New error codes may be added in future versions of SQLite.
  1405. **
  1406. ** See also: [extended result code definitions]
  1407. */
  1408. #define SQLITE_OK 0 /* Successful result */
  1409. /* beginning-of-error-codes */
  1410. #define SQLITE_ERROR 1 /* Generic error */
  1411. #define SQLITE_INTERNAL 2 /* Internal logic error in SQLite */
  1412. #define SQLITE_PERM 3 /* Access permission denied */
  1413. #define SQLITE_ABORT 4 /* Callback routine requested an abort */
  1414. #define SQLITE_BUSY 5 /* The database file is locked */
  1415. #define SQLITE_LOCKED 6 /* A table in the database is locked */
  1416. #define SQLITE_NOMEM 7 /* A malloc() failed */
  1417. #define SQLITE_READONLY 8 /* Attempt to write a readonly database */
  1418. #define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite3_interrupt()*/
  1419. #define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */
  1420. #define SQLITE_CORRUPT 11 /* The database disk image is malformed */
  1421. #define SQLITE_NOTFOUND 12 /* Unknown opcode in sqlite3_file_control() */
  1422. #define SQLITE_FULL 13 /* Insertion failed because database is full */
  1423. #define SQLITE_CANTOPEN 14 /* Unable to open the database file */
  1424. #define SQLITE_PROTOCOL 15 /* Database lock protocol error */
  1425. #define SQLITE_EMPTY 16 /* Internal use only */
  1426. #define SQLITE_SCHEMA 17 /* The database schema changed */
  1427. #define SQLITE_TOOBIG 18 /* String or BLOB exceeds size limit */
  1428. #define SQLITE_CONSTRAINT 19 /* Abort due to constraint violation */
  1429. #define SQLITE_MISMATCH 20 /* Data type mismatch */
  1430. #define SQLITE_MISUSE 21 /* Library used incorrectly */
  1431. #define SQLITE_NOLFS 22 /* Uses OS features not supported on host */
  1432. #define SQLITE_AUTH 23 /* Authorization denied */
  1433. #define SQLITE_FORMAT 24 /* Not used */
  1434. #define SQLITE_RANGE 25 /* 2nd parameter to sqlite3_bind out of range */
  1435. #define SQLITE_NOTADB 26 /* File opened that is not a database file */
  1436. #define SQLITE_NOTICE 27 /* Notifications from sqlite3_log() */
  1437. #define SQLITE_WARNING 28 /* Warnings from sqlite3_log() */
  1438. #define SQLITE_ROW 100 /* sqlite3_step() has another row ready */
  1439. #define SQLITE_DONE 101 /* sqlite3_step() has finished executing */
  1440. /* end-of-error-codes */
  1441. /*
  1442. ** CAPI3REF: Extended Result Codes
  1443. ** KEYWORDS: {extended result code definitions}
  1444. **
  1445. ** In its default configuration, SQLite API routines return one of 30 integer
  1446. ** [result codes]. However, experience has shown that many of
  1447. ** these result codes are too coarse-grained. They do not provide as
  1448. ** much information about problems as programmers might like. In an effort to
  1449. ** address this, newer versions of SQLite (version 3.3.8 [dateof:3.3.8]
  1450. ** and later) include
  1451. ** support for additional result codes that provide more detailed information
  1452. ** about errors. These [extended result codes] are enabled or disabled
  1453. ** on a per database connection basis using the
  1454. ** [sqlite3_extended_result_codes()] API. Or, the extended code for
  1455. ** the most recent error can be obtained using
  1456. ** [sqlite3_extended_errcode()].
  1457. */
  1458. #define SQLITE_ERROR_MISSING_COLLSEQ (SQLITE_ERROR | (1<<8))
  1459. #define SQLITE_ERROR_RETRY (SQLITE_ERROR | (2<<8))
  1460. #define SQLITE_IOERR_READ (SQLITE_IOERR | (1<<8))
  1461. #define SQLITE_IOERR_SHORT_READ (SQLITE_IOERR | (2<<8))
  1462. #define SQLITE_IOERR_WRITE (SQLITE_IOERR | (3<<8))
  1463. #define SQLITE_IOERR_FSYNC (SQLITE_IOERR | (4<<8))
  1464. #define SQLITE_IOERR_DIR_FSYNC (SQLITE_IOERR | (5<<8))
  1465. #define SQLITE_IOERR_TRUNCATE (SQLITE_IOERR | (6<<8))
  1466. #define SQLITE_IOERR_FSTAT (SQLITE_IOERR | (7<<8))
  1467. #define SQLITE_IOERR_UNLOCK (SQLITE_IOERR | (8<<8))
  1468. #define SQLITE_IOERR_RDLOCK (SQLITE_IOERR | (9<<8))
  1469. #define SQLITE_IOERR_DELETE (SQLITE_IOERR | (10<<8))
  1470. #define SQLITE_IOERR_BLOCKED (SQLITE_IOERR | (11<<8))
  1471. #define SQLITE_IOERR_NOMEM (SQLITE_IOERR | (12<<8))
  1472. #define SQLITE_IOERR_ACCESS (SQLITE_IOERR | (13<<8))
  1473. #define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
  1474. #define SQLITE_IOERR_LOCK (SQLITE_IOERR | (15<<8))
  1475. #define SQLITE_IOERR_CLOSE (SQLITE_IOERR | (16<<8))
  1476. #define SQLITE_IOERR_DIR_CLOSE (SQLITE_IOERR | (17<<8))
  1477. #define SQLITE_IOERR_SHMOPEN (SQLITE_IOERR | (18<<8))
  1478. #define SQLITE_IOERR_SHMSIZE (SQLITE_IOERR | (19<<8))
  1479. #define SQLITE_IOERR_SHMLOCK (SQLITE_IOERR | (20<<8))
  1480. #define SQLITE_IOERR_SHMMAP (SQLITE_IOERR | (21<<8))
  1481. #define SQLITE_IOERR_SEEK (SQLITE_IOERR | (22<<8))
  1482. #define SQLITE_IOERR_DELETE_NOENT (SQLITE_IOERR | (23<<8))
  1483. #define SQLITE_IOERR_MMAP (SQLITE_IOERR | (24<<8))
  1484. #define SQLITE_IOERR_GETTEMPPATH (SQLITE_IOERR | (25<<8))
  1485. #define SQLITE_IOERR_CONVPATH (SQLITE_IOERR | (26<<8))
  1486. #define SQLITE_IOERR_VNODE (SQLITE_IOERR | (27<<8))
  1487. #define SQLITE_IOERR_AUTH (SQLITE_IOERR | (28<<8))
  1488. #define SQLITE_IOERR_BEGIN_ATOMIC (SQLITE_IOERR | (29<<8))
  1489. #define SQLITE_IOERR_COMMIT_ATOMIC (SQLITE_IOERR | (30<<8))
  1490. #define SQLITE_IOERR_ROLLBACK_ATOMIC (SQLITE_IOERR | (31<<8))
  1491. #define SQLITE_LOCKED_SHAREDCACHE (SQLITE_LOCKED | (1<<8))
  1492. #define SQLITE_BUSY_RECOVERY (SQLITE_BUSY | (1<<8))
  1493. #define SQLITE_BUSY_SNAPSHOT (SQLITE_BUSY | (2<<8))
  1494. #define SQLITE_CANTOPEN_NOTEMPDIR (SQLITE_CANTOPEN | (1<<8))
  1495. #define SQLITE_CANTOPEN_ISDIR (SQLITE_CANTOPEN | (2<<8))
  1496. #define SQLITE_CANTOPEN_FULLPATH (SQLITE_CANTOPEN | (3<<8))
  1497. #define SQLITE_CANTOPEN_CONVPATH (SQLITE_CANTOPEN | (4<<8))
  1498. #define SQLITE_CORRUPT_VTAB (SQLITE_CORRUPT | (1<<8))
  1499. #define SQLITE_READONLY_RECOVERY (SQLITE_READONLY | (1<<8))
  1500. #define SQLITE_READONLY_CANTLOCK (SQLITE_READONLY | (2<<8))
  1501. #define SQLITE_READONLY_ROLLBACK (SQLITE_READONLY | (3<<8))
  1502. #define SQLITE_READONLY_DBMOVED (SQLITE_READONLY | (4<<8))
  1503. #define SQLITE_READONLY_CANTINIT (SQLITE_READONLY | (5<<8))
  1504. #define SQLITE_READONLY_DIRECTORY (SQLITE_READONLY | (6<<8))
  1505. #define SQLITE_ABORT_ROLLBACK (SQLITE_ABORT | (2<<8))
  1506. #define SQLITE_CONSTRAINT_CHECK (SQLITE_CONSTRAINT | (1<<8))
  1507. #define SQLITE_CONSTRAINT_COMMITHOOK (SQLITE_CONSTRAINT | (2<<8))
  1508. #define SQLITE_CONSTRAINT_FOREIGNKEY (SQLITE_CONSTRAINT | (3<<8))
  1509. #define SQLITE_CONSTRAINT_FUNCTION (SQLITE_CONSTRAINT | (4<<8))
  1510. #define SQLITE_CONSTRAINT_NOTNULL (SQLITE_CONSTRAINT | (5<<8))
  1511. #define SQLITE_CONSTRAINT_PRIMARYKEY (SQLITE_CONSTRAINT | (6<<8))
  1512. #define SQLITE_CONSTRAINT_TRIGGER (SQLITE_CONSTRAINT | (7<<8))
  1513. #define SQLITE_CONSTRAINT_UNIQUE (SQLITE_CONSTRAINT | (8<<8))
  1514. #define SQLITE_CONSTRAINT_VTAB (SQLITE_CONSTRAINT | (9<<8))
  1515. #define SQLITE_CONSTRAINT_ROWID (SQLITE_CONSTRAINT |(10<<8))
  1516. #define SQLITE_NOTICE_RECOVER_WAL (SQLITE_NOTICE | (1<<8))
  1517. #define SQLITE_NOTICE_RECOVER_ROLLBACK (SQLITE_NOTICE | (2<<8))
  1518. #define SQLITE_WARNING_AUTOINDEX (SQLITE_WARNING | (1<<8))
  1519. #define SQLITE_AUTH_USER (SQLITE_AUTH | (1<<8))
  1520. #define SQLITE_OK_LOAD_PERMANENTLY (SQLITE_OK | (1<<8))
  1521. /*
  1522. ** CAPI3REF: Flags For File Open Operations
  1523. **
  1524. ** These bit values are intended for use in the
  1525. ** 3rd parameter to the [sqlite3_open_v2()] interface and
  1526. ** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
  1527. */
  1528. #define SQLITE_OPEN_READONLY 0x00000001 /* Ok for sqlite3_open_v2() */
  1529. #define SQLITE_OPEN_READWRITE 0x00000002 /* Ok for sqlite3_open_v2() */
  1530. #define SQLITE_OPEN_CREATE 0x00000004 /* Ok for sqlite3_open_v2() */
  1531. #define SQLITE_OPEN_DELETEONCLOSE 0x00000008 /* VFS only */
  1532. #define SQLITE_OPEN_EXCLUSIVE 0x00000010 /* VFS only */
  1533. #define SQLITE_OPEN_AUTOPROXY 0x00000020 /* VFS only */
  1534. #define SQLITE_OPEN_URI 0x00000040 /* Ok for sqlite3_open_v2() */
  1535. #define SQLITE_OPEN_MEMORY 0x00000080 /* Ok for sqlite3_open_v2() */
  1536. #define SQLITE_OPEN_MAIN_DB 0x00000100 /* VFS only */
  1537. #define SQLITE_OPEN_TEMP_DB 0x00000200 /* VFS only */
  1538. #define SQLITE_OPEN_TRANSIENT_DB 0x00000400 /* VFS only */
  1539. #define SQLITE_OPEN_MAIN_JOURNAL 0x00000800 /* VFS only */
  1540. #define SQLITE_OPEN_TEMP_JOURNAL 0x00001000 /* VFS only */
  1541. #define SQLITE_OPEN_SUBJOURNAL 0x00002000 /* VFS only */
  1542. #define SQLITE_OPEN_MASTER_JOURNAL 0x00004000 /* VFS only */
  1543. #define SQLITE_OPEN_NOMUTEX 0x00008000 /* Ok for sqlite3_open_v2() */
  1544. #define SQLITE_OPEN_FULLMUTEX 0x00010000 /* Ok for sqlite3_open_v2() */
  1545. #define SQLITE_OPEN_SHAREDCACHE 0x00020000 /* Ok for sqlite3_open_v2() */
  1546. #define SQLITE_OPEN_PRIVATECACHE 0x00040000 /* Ok for sqlite3_open_v2() */
  1547. #define SQLITE_OPEN_WAL 0x00080000 /* VFS only */
  1548. /* Reserved: 0x00F00000 */
  1549. /*
  1550. ** CAPI3REF: Device Characteristics
  1551. **
  1552. ** The xDeviceCharacteristics method of the [sqlite3_io_methods]
  1553. ** object returns an integer which is a vector of these
  1554. ** bit values expressing I/O characteristics of the mass storage
  1555. ** device that holds the file that the [sqlite3_io_methods]
  1556. ** refers to.
  1557. **
  1558. ** The SQLITE_IOCAP_ATOMIC property means that all writes of
  1559. ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
  1560. ** mean that writes of blocks that are nnn bytes in size and
  1561. ** are aligned to an address which is an integer multiple of
  1562. ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
  1563. ** that when data is appended to a file, the data is appended
  1564. ** first then the size of the file is extended, never the other
  1565. ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
  1566. ** information is written to disk in the same order as calls
  1567. ** to xWrite(). The SQLITE_IOCAP_POWERSAFE_OVERWRITE property means that
  1568. ** after reboot following a crash or power loss, the only bytes in a
  1569. ** file that were written at the application level might have changed
  1570. ** and that adjacent bytes, even bytes within the same sector are
  1571. ** guaranteed to be unchanged. The SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
  1572. ** flag indicates that a file cannot be deleted when open. The
  1573. ** SQLITE_IOCAP_IMMUTABLE flag indicates that the file is on
  1574. ** read-only media and cannot be changed even by processes with
  1575. ** elevated privileges.
  1576. **
  1577. ** The SQLITE_IOCAP_BATCH_ATOMIC property means that the underlying
  1578. ** filesystem supports doing multiple write operations atomically when those
  1579. ** write operations are bracketed by [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] and
  1580. ** [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE].
  1581. */
  1582. #define SQLITE_IOCAP_ATOMIC 0x00000001
  1583. #define SQLITE_IOCAP_ATOMIC512 0x00000002
  1584. #define SQLITE_IOCAP_ATOMIC1K 0x00000004
  1585. #define SQLITE_IOCAP_ATOMIC2K 0x00000008
  1586. #define SQLITE_IOCAP_ATOMIC4K 0x00000010
  1587. #define SQLITE_IOCAP_ATOMIC8K 0x00000020
  1588. #define SQLITE_IOCAP_ATOMIC16K 0x00000040
  1589. #define SQLITE_IOCAP_ATOMIC32K 0x00000080
  1590. #define SQLITE_IOCAP_ATOMIC64K 0x00000100
  1591. #define SQLITE_IOCAP_SAFE_APPEND 0x00000200
  1592. #define SQLITE_IOCAP_SEQUENTIAL 0x00000400
  1593. #define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN 0x00000800
  1594. #define SQLITE_IOCAP_POWERSAFE_OVERWRITE 0x00001000
  1595. #define SQLITE_IOCAP_IMMUTABLE 0x00002000
  1596. #define SQLITE_IOCAP_BATCH_ATOMIC 0x00004000
  1597. /*
  1598. ** CAPI3REF: File Locking Levels
  1599. **
  1600. ** SQLite uses one of these integer values as the second
  1601. ** argument to calls it makes to the xLock() and xUnlock() methods
  1602. ** of an [sqlite3_io_methods] object.
  1603. */
  1604. #define SQLITE_LOCK_NONE 0
  1605. #define SQLITE_LOCK_SHARED 1
  1606. #define SQLITE_LOCK_RESERVED 2
  1607. #define SQLITE_LOCK_PENDING 3
  1608. #define SQLITE_LOCK_EXCLUSIVE 4
  1609. /*
  1610. ** CAPI3REF: Synchronization Type Flags
  1611. **
  1612. ** When SQLite invokes the xSync() method of an
  1613. ** [sqlite3_io_methods] object it uses a combination of
  1614. ** these integer values as the second argument.
  1615. **
  1616. ** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
  1617. ** sync operation only needs to flush data to mass storage. Inode
  1618. ** information need not be flushed. If the lower four bits of the flag
  1619. ** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
  1620. ** If the lower four bits equal SQLITE_SYNC_FULL, that means
  1621. ** to use Mac OS X style fullsync instead of fsync().
  1622. **
  1623. ** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
  1624. ** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
  1625. ** settings. The [synchronous pragma] determines when calls to the
  1626. ** xSync VFS method occur and applies uniformly across all platforms.
  1627. ** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
  1628. ** energetic or rigorous or forceful the sync operations are and
  1629. ** only make a difference on Mac OSX for the default SQLite code.
  1630. ** (Third-party VFS implementations might also make the distinction
  1631. ** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
  1632. ** operating systems natively supported by SQLite, only Mac OSX
  1633. ** cares about the difference.)
  1634. */
  1635. #define SQLITE_SYNC_NORMAL 0x00002
  1636. #define SQLITE_SYNC_FULL 0x00003
  1637. #define SQLITE_SYNC_DATAONLY 0x00010
  1638. /*
  1639. ** CAPI3REF: OS Interface Open File Handle
  1640. **
  1641. ** An [sqlite3_file] object represents an open file in the
  1642. ** [sqlite3_vfs | OS interface layer]. Individual OS interface
  1643. ** implementations will
  1644. ** want to subclass this object by appending additional fields
  1645. ** for their own use. The pMethods entry is a pointer to an
  1646. ** [sqlite3_io_methods] object that defines methods for performing
  1647. ** I/O operations on the open file.
  1648. */
  1649. typedef struct sqlite3_file sqlite3_file;
  1650. struct sqlite3_file {
  1651. const struct sqlite3_io_methods *pMethods; /* Methods for an open file */
  1652. };
  1653. /*
  1654. ** CAPI3REF: OS Interface File Virtual Methods Object
  1655. **
  1656. ** Every file opened by the [sqlite3_vfs.xOpen] method populates an
  1657. ** [sqlite3_file] object (or, more commonly, a subclass of the
  1658. ** [sqlite3_file] object) with a pointer to an instance of this object.
  1659. ** This object defines the methods used to perform various operations
  1660. ** against the open file represented by the [sqlite3_file] object.
  1661. **
  1662. ** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element
  1663. ** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
  1664. ** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed. The
  1665. ** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
  1666. ** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
  1667. ** to NULL.
  1668. **
  1669. ** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
  1670. ** [SQLITE_SYNC_FULL]. The first choice is the normal fsync().
  1671. ** The second choice is a Mac OS X style fullsync. The [SQLITE_SYNC_DATAONLY]
  1672. ** flag may be ORed in to indicate that only the data of the file
  1673. ** and not its inode needs to be synced.
  1674. **
  1675. ** The integer values to xLock() and xUnlock() are one of
  1676. ** <ul>
  1677. ** <li> [SQLITE_LOCK_NONE],
  1678. ** <li> [SQLITE_LOCK_SHARED],
  1679. ** <li> [SQLITE_LOCK_RESERVED],
  1680. ** <li> [SQLITE_LOCK_PENDING], or
  1681. ** <li> [SQLITE_LOCK_EXCLUSIVE].
  1682. ** </ul>
  1683. ** xLock() increases the lock. xUnlock() decreases the lock.
  1684. ** The xCheckReservedLock() method checks whether any database connection,
  1685. ** either in this process or in some other process, is holding a RESERVED,
  1686. ** PENDING, or EXCLUSIVE lock on the file. It returns true
  1687. ** if such a lock exists and false otherwise.
  1688. **
  1689. ** The xFileControl() method is a generic interface that allows custom
  1690. ** VFS implementations to directly control an open file using the
  1691. ** [sqlite3_file_control()] interface. The second "op" argument is an
  1692. ** integer opcode. The third argument is a generic pointer intended to
  1693. ** point to a structure that may contain arguments or space in which to
  1694. ** write return values. Potential uses for xFileControl() might be
  1695. ** functions to enable blocking locks with timeouts, to change the
  1696. ** locking strategy (for example to use dot-file locks), to inquire
  1697. ** about the status of a lock, or to break stale locks. The SQLite
  1698. ** core reserves all opcodes less than 100 for its own use.
  1699. ** A [file control opcodes | list of opcodes] less than 100 is available.
  1700. ** Applications that define a custom xFileControl method should use opcodes
  1701. ** greater than 100 to avoid conflicts. VFS implementations should
  1702. ** return [SQLITE_NOTFOUND] for file control opcodes that they do not
  1703. ** recognize.
  1704. **
  1705. ** The xSectorSize() method returns the sector size of the
  1706. ** device that underlies the file. The sector size is the
  1707. ** minimum write that can be performed without disturbing
  1708. ** other bytes in the file. The xDeviceCharacteristics()
  1709. ** method returns a bit vector describing behaviors of the
  1710. ** underlying device:
  1711. **
  1712. ** <ul>
  1713. ** <li> [SQLITE_IOCAP_ATOMIC]
  1714. ** <li> [SQLITE_IOCAP_ATOMIC512]
  1715. ** <li> [SQLITE_IOCAP_ATOMIC1K]
  1716. ** <li> [SQLITE_IOCAP_ATOMIC2K]
  1717. ** <li> [SQLITE_IOCAP_ATOMIC4K]
  1718. ** <li> [SQLITE_IOCAP_ATOMIC8K]
  1719. ** <li> [SQLITE_IOCAP_ATOMIC16K]
  1720. ** <li> [SQLITE_IOCAP_ATOMIC32K]
  1721. ** <li> [SQLITE_IOCAP_ATOMIC64K]
  1722. ** <li> [SQLITE_IOCAP_SAFE_APPEND]
  1723. ** <li> [SQLITE_IOCAP_SEQUENTIAL]
  1724. ** <li> [SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN]
  1725. ** <li> [SQLITE_IOCAP_POWERSAFE_OVERWRITE]
  1726. ** <li> [SQLITE_IOCAP_IMMUTABLE]
  1727. ** <li> [SQLITE_IOCAP_BATCH_ATOMIC]
  1728. ** </ul>
  1729. **
  1730. ** The SQLITE_IOCAP_ATOMIC property means that all writes of
  1731. ** any size are atomic. The SQLITE_IOCAP_ATOMICnnn values
  1732. ** mean that writes of blocks that are nnn bytes in size and
  1733. ** are aligned to an address which is an integer multiple of
  1734. ** nnn are atomic. The SQLITE_IOCAP_SAFE_APPEND value means
  1735. ** that when data is appended to a file, the data is appended
  1736. ** first then the size of the file is extended, never the other
  1737. ** way around. The SQLITE_IOCAP_SEQUENTIAL property means that
  1738. ** information is written to disk in the same order as calls
  1739. ** to xWrite().
  1740. **
  1741. ** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
  1742. ** in the unread portions of the buffer with zeros. A VFS that
  1743. ** fails to zero-fill short reads might seem to work. However,
  1744. ** failure to zero-fill short reads will eventually lead to
  1745. ** database corruption.
  1746. */
  1747. typedef struct sqlite3_io_methods sqlite3_io_methods;
  1748. struct sqlite3_io_methods {
  1749. int iVersion;
  1750. int (*xClose)(sqlite3_file*);
  1751. int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
  1752. int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
  1753. int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
  1754. int (*xSync)(sqlite3_file*, int flags);
  1755. int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
  1756. int (*xLock)(sqlite3_file*, int);
  1757. int (*xUnlock)(sqlite3_file*, int);
  1758. int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
  1759. int (*xFileControl)(sqlite3_file*, int op, void *pArg);
  1760. int (*xSectorSize)(sqlite3_file*);
  1761. int (*xDeviceCharacteristics)(sqlite3_file*);
  1762. /* Methods above are valid for version 1 */
  1763. int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
  1764. int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
  1765. void (*xShmBarrier)(sqlite3_file*);
  1766. int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
  1767. /* Methods above are valid for version 2 */
  1768. int (*xFetch)(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
  1769. int (*xUnfetch)(sqlite3_file*, sqlite3_int64 iOfst, void *p);
  1770. /* Methods above are valid for version 3 */
  1771. /* Additional methods may be added in future releases */
  1772. };
  1773. /*
  1774. ** CAPI3REF: Standard File Control Opcodes
  1775. ** KEYWORDS: {file control opcodes} {file control opcode}
  1776. **
  1777. ** These integer constants are opcodes for the xFileControl method
  1778. ** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
  1779. ** interface.
  1780. **
  1781. ** <ul>
  1782. ** <li>[[SQLITE_FCNTL_LOCKSTATE]]
  1783. ** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging. This
  1784. ** opcode causes the xFileControl method to write the current state of
  1785. ** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
  1786. ** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
  1787. ** into an integer that the pArg argument points to. This capability
  1788. ** is used during testing and is only available when the SQLITE_TEST
  1789. ** compile-time option is used.
  1790. **
  1791. ** <li>[[SQLITE_FCNTL_SIZE_HINT]]
  1792. ** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
  1793. ** layer a hint of how large the database file will grow to be during the
  1794. ** current transaction. This hint is not guaranteed to be accurate but it
  1795. ** is often close. The underlying VFS might choose to preallocate database
  1796. ** file space based on this hint in order to help writes to the database
  1797. ** file run faster.
  1798. **
  1799. ** <li>[[SQLITE_FCNTL_CHUNK_SIZE]]
  1800. ** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
  1801. ** extends and truncates the database file in chunks of a size specified
  1802. ** by the user. The fourth argument to [sqlite3_file_control()] should
  1803. ** point to an integer (type int) containing the new chunk-size to use
  1804. ** for the nominated database. Allocating database file space in large
  1805. ** chunks (say 1MB at a time), may reduce file-system fragmentation and
  1806. ** improve performance on some systems.
  1807. **
  1808. ** <li>[[SQLITE_FCNTL_FILE_POINTER]]
  1809. ** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
  1810. ** to the [sqlite3_file] object associated with a particular database
  1811. ** connection. See also [SQLITE_FCNTL_JOURNAL_POINTER].
  1812. **
  1813. ** <li>[[SQLITE_FCNTL_JOURNAL_POINTER]]
  1814. ** The [SQLITE_FCNTL_JOURNAL_POINTER] opcode is used to obtain a pointer
  1815. ** to the [sqlite3_file] object associated with the journal file (either
  1816. ** the [rollback journal] or the [write-ahead log]) for a particular database
  1817. ** connection. See also [SQLITE_FCNTL_FILE_POINTER].
  1818. **
  1819. ** <li>[[SQLITE_FCNTL_SYNC_OMITTED]]
  1820. ** No longer in use.
  1821. **
  1822. ** <li>[[SQLITE_FCNTL_SYNC]]
  1823. ** The [SQLITE_FCNTL_SYNC] opcode is generated internally by SQLite and
  1824. ** sent to the VFS immediately before the xSync method is invoked on a
  1825. ** database file descriptor. Or, if the xSync method is not invoked
  1826. ** because the user has configured SQLite with
  1827. ** [PRAGMA synchronous | PRAGMA synchronous=OFF] it is invoked in place
  1828. ** of the xSync method. In most cases, the pointer argument passed with
  1829. ** this file-control is NULL. However, if the database file is being synced
  1830. ** as part of a multi-database commit, the argument points to a nul-terminated
  1831. ** string containing the transactions master-journal file name. VFSes that
  1832. ** do not need this signal should silently ignore this opcode. Applications
  1833. ** should not call [sqlite3_file_control()] with this opcode as doing so may
  1834. ** disrupt the operation of the specialized VFSes that do require it.
  1835. **
  1836. ** <li>[[SQLITE_FCNTL_COMMIT_PHASETWO]]
  1837. ** The [SQLITE_FCNTL_COMMIT_PHASETWO] opcode is generated internally by SQLite
  1838. ** and sent to the VFS after a transaction has been committed immediately
  1839. ** but before the database is unlocked. VFSes that do not need this signal
  1840. ** should silently ignore this opcode. Applications should not call
  1841. ** [sqlite3_file_control()] with this opcode as doing so may disrupt the
  1842. ** operation of the specialized VFSes that do require it.
  1843. **
  1844. ** <li>[[SQLITE_FCNTL_WIN32_AV_RETRY]]
  1845. ** ^The [SQLITE_FCNTL_WIN32_AV_RETRY] opcode is used to configure automatic
  1846. ** retry counts and intervals for certain disk I/O operations for the
  1847. ** windows [VFS] in order to provide robustness in the presence of
  1848. ** anti-virus programs. By default, the windows VFS will retry file read,
  1849. ** file write, and file delete operations up to 10 times, with a delay
  1850. ** of 25 milliseconds before the first retry and with the delay increasing
  1851. ** by an additional 25 milliseconds with each subsequent retry. This
  1852. ** opcode allows these two values (10 retries and 25 milliseconds of delay)
  1853. ** to be adjusted. The values are changed for all database connections
  1854. ** within the same process. The argument is a pointer to an array of two
  1855. ** integers where the first integer is the new retry count and the second
  1856. ** integer is the delay. If either integer is negative, then the setting
  1857. ** is not changed but instead the prior value of that setting is written
  1858. ** into the array entry, allowing the current retry settings to be
  1859. ** interrogated. The zDbName parameter is ignored.
  1860. **
  1861. ** <li>[[SQLITE_FCNTL_PERSIST_WAL]]
  1862. ** ^The [SQLITE_FCNTL_PERSIST_WAL] opcode is used to set or query the
  1863. ** persistent [WAL | Write Ahead Log] setting. By default, the auxiliary
  1864. ** write ahead log and shared memory files used for transaction control
  1865. ** are automatically deleted when the latest connection to the database
  1866. ** closes. Setting persistent WAL mode causes those files to persist after
  1867. ** close. Persisting the files is useful when other processes that do not
  1868. ** have write permission on the directory containing the database file want
  1869. ** to read the database file, as the WAL and shared memory files must exist
  1870. ** in order for the database to be readable. The fourth parameter to
  1871. ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
  1872. ** That integer is 0 to disable persistent WAL mode or 1 to enable persistent
  1873. ** WAL mode. If the integer is -1, then it is overwritten with the current
  1874. ** WAL persistence setting.
  1875. **
  1876. ** <li>[[SQLITE_FCNTL_POWERSAFE_OVERWRITE]]
  1877. ** ^The [SQLITE_FCNTL_POWERSAFE_OVERWRITE] opcode is used to set or query the
  1878. ** persistent "powersafe-overwrite" or "PSOW" setting. The PSOW setting
  1879. ** determines the [SQLITE_IOCAP_POWERSAFE_OVERWRITE] bit of the
  1880. ** xDeviceCharacteristics methods. The fourth parameter to
  1881. ** [sqlite3_file_control()] for this opcode should be a pointer to an integer.
  1882. ** That integer is 0 to disable zero-damage mode or 1 to enable zero-damage
  1883. ** mode. If the integer is -1, then it is overwritten with the current
  1884. ** zero-damage mode setting.
  1885. **
  1886. ** <li>[[SQLITE_FCNTL_OVERWRITE]]
  1887. ** ^The [SQLITE_FCNTL_OVERWRITE] opcode is invoked by SQLite after opening
  1888. ** a write transaction to indicate that, unless it is rolled back for some
  1889. ** reason, the entire database file will be overwritten by the current
  1890. ** transaction. This is used by VACUUM operations.
  1891. **
  1892. ** <li>[[SQLITE_FCNTL_VFSNAME]]
  1893. ** ^The [SQLITE_FCNTL_VFSNAME] opcode can be used to obtain the names of
  1894. ** all [VFSes] in the VFS stack. The names are of all VFS shims and the
  1895. ** final bottom-level VFS are written into memory obtained from
  1896. ** [sqlite3_malloc()] and the result is stored in the char* variable
  1897. ** that the fourth parameter of [sqlite3_file_control()] points to.
  1898. ** The caller is responsible for freeing the memory when done. As with
  1899. ** all file-control actions, there is no guarantee that this will actually
  1900. ** do anything. Callers should initialize the char* variable to a NULL
  1901. ** pointer in case this file-control is not implemented. This file-control
  1902. ** is intended for diagnostic use only.
  1903. **
  1904. ** <li>[[SQLITE_FCNTL_VFS_POINTER]]
  1905. ** ^The [SQLITE_FCNTL_VFS_POINTER] opcode finds a pointer to the top-level
  1906. ** [VFSes] currently in use. ^(The argument X in
  1907. ** sqlite3_file_control(db,SQLITE_FCNTL_VFS_POINTER,X) must be
  1908. ** of type "[sqlite3_vfs] **". This opcodes will set *X
  1909. ** to a pointer to the top-level VFS.)^
  1910. ** ^When there are multiple VFS shims in the stack, this opcode finds the
  1911. ** upper-most shim only.
  1912. **
  1913. ** <li>[[SQLITE_FCNTL_PRAGMA]]
  1914. ** ^Whenever a [PRAGMA] statement is parsed, an [SQLITE_FCNTL_PRAGMA]
  1915. ** file control is sent to the open [sqlite3_file] object corresponding
  1916. ** to the database file to which the pragma statement refers. ^The argument
  1917. ** to the [SQLITE_FCNTL_PRAGMA] file control is an array of
  1918. ** pointers to strings (char**) in which the second element of the array
  1919. ** is the name of the pragma and the third element is the argument to the
  1920. ** pragma or NULL if the pragma has no argument. ^The handler for an
  1921. ** [SQLITE_FCNTL_PRAGMA] file control can optionally make the first element
  1922. ** of the char** argument point to a string obtained from [sqlite3_mprintf()]
  1923. ** or the equivalent and that string will become the result of the pragma or
  1924. ** the error message if the pragma fails. ^If the
  1925. ** [SQLITE_FCNTL_PRAGMA] file control returns [SQLITE_NOTFOUND], then normal
  1926. ** [PRAGMA] processing continues. ^If the [SQLITE_FCNTL_PRAGMA]
  1927. ** file control returns [SQLITE_OK], then the parser assumes that the
  1928. ** VFS has handled the PRAGMA itself and the parser generates a no-op
  1929. ** prepared statement if result string is NULL, or that returns a copy
  1930. ** of the result string if the string is non-NULL.
  1931. ** ^If the [SQLITE_FCNTL_PRAGMA] file control returns
  1932. ** any result code other than [SQLITE_OK] or [SQLITE_NOTFOUND], that means
  1933. ** that the VFS encountered an error while handling the [PRAGMA] and the
  1934. ** compilation of the PRAGMA fails with an error. ^The [SQLITE_FCNTL_PRAGMA]
  1935. ** file control occurs at the beginning of pragma statement analysis and so
  1936. ** it is able to override built-in [PRAGMA] statements.
  1937. **
  1938. ** <li>[[SQLITE_FCNTL_BUSYHANDLER]]
  1939. ** ^The [SQLITE_FCNTL_BUSYHANDLER]
  1940. ** file-control may be invoked by SQLite on the database file handle
  1941. ** shortly after it is opened in order to provide a custom VFS with access
  1942. ** to the connections busy-handler callback. The argument is of type (void **)
  1943. ** - an array of two (void *) values. The first (void *) actually points
  1944. ** to a function of type (int (*)(void *)). In order to invoke the connections
  1945. ** busy-handler, this function should be invoked with the second (void *) in
  1946. ** the array as the only argument. If it returns non-zero, then the operation
  1947. ** should be retried. If it returns zero, the custom VFS should abandon the
  1948. ** current operation.
  1949. **
  1950. ** <li>[[SQLITE_FCNTL_TEMPFILENAME]]
  1951. ** ^Application can invoke the [SQLITE_FCNTL_TEMPFILENAME] file-control
  1952. ** to have SQLite generate a
  1953. ** temporary filename using the same algorithm that is followed to generate
  1954. ** temporary filenames for TEMP tables and other internal uses. The
  1955. ** argument should be a char** which will be filled with the filename
  1956. ** written into memory obtained from [sqlite3_malloc()]. The caller should
  1957. ** invoke [sqlite3_free()] on the result to avoid a memory leak.
  1958. **
  1959. ** <li>[[SQLITE_FCNTL_MMAP_SIZE]]
  1960. ** The [SQLITE_FCNTL_MMAP_SIZE] file control is used to query or set the
  1961. ** maximum number of bytes that will be used for memory-mapped I/O.
  1962. ** The argument is a pointer to a value of type sqlite3_int64 that
  1963. ** is an advisory maximum number of bytes in the file to memory map. The
  1964. ** pointer is overwritten with the old value. The limit is not changed if
  1965. ** the value originally pointed to is negative, and so the current limit
  1966. ** can be queried by passing in a pointer to a negative number. This
  1967. ** file-control is used internally to implement [PRAGMA mmap_size].
  1968. **
  1969. ** <li>[[SQLITE_FCNTL_TRACE]]
  1970. ** The [SQLITE_FCNTL_TRACE] file control provides advisory information
  1971. ** to the VFS about what the higher layers of the SQLite stack are doing.
  1972. ** This file control is used by some VFS activity tracing [shims].
  1973. ** The argument is a zero-terminated string. Higher layers in the
  1974. ** SQLite stack may generate instances of this file control if
  1975. ** the [SQLITE_USE_FCNTL_TRACE] compile-time option is enabled.
  1976. **
  1977. ** <li>[[SQLITE_FCNTL_HAS_MOVED]]
  1978. ** The [SQLITE_FCNTL_HAS_MOVED] file control interprets its argument as a
  1979. ** pointer to an integer and it writes a boolean into that integer depending
  1980. ** on whether or not the file has been renamed, moved, or deleted since it
  1981. ** was first opened.
  1982. **
  1983. ** <li>[[SQLITE_FCNTL_WIN32_GET_HANDLE]]
  1984. ** The [SQLITE_FCNTL_WIN32_GET_HANDLE] opcode can be used to obtain the
  1985. ** underlying native file handle associated with a file handle. This file
  1986. ** control interprets its argument as a pointer to a native file handle and
  1987. ** writes the resulting value there.
  1988. **
  1989. ** <li>[[SQLITE_FCNTL_WIN32_SET_HANDLE]]
  1990. ** The [SQLITE_FCNTL_WIN32_SET_HANDLE] opcode is used for debugging. This
  1991. ** opcode causes the xFileControl method to swap the file handle with the one
  1992. ** pointed to by the pArg argument. This capability is used during testing
  1993. ** and only needs to be supported when SQLITE_TEST is defined.
  1994. **
  1995. ** <li>[[SQLITE_FCNTL_WAL_BLOCK]]
  1996. ** The [SQLITE_FCNTL_WAL_BLOCK] is a signal to the VFS layer that it might
  1997. ** be advantageous to block on the next WAL lock if the lock is not immediately
  1998. ** available. The WAL subsystem issues this signal during rare
  1999. ** circumstances in order to fix a problem with priority inversion.
  2000. ** Applications should <em>not</em> use this file-control.
  2001. **
  2002. ** <li>[[SQLITE_FCNTL_ZIPVFS]]
  2003. ** The [SQLITE_FCNTL_ZIPVFS] opcode is implemented by zipvfs only. All other
  2004. ** VFS should return SQLITE_NOTFOUND for this opcode.
  2005. **
  2006. ** <li>[[SQLITE_FCNTL_RBU]]
  2007. ** The [SQLITE_FCNTL_RBU] opcode is implemented by the special VFS used by
  2008. ** the RBU extension only. All other VFS should return SQLITE_NOTFOUND for
  2009. ** this opcode.
  2010. **
  2011. ** <li>[[SQLITE_FCNTL_BEGIN_ATOMIC_WRITE]]
  2012. ** If the [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] opcode returns SQLITE_OK, then
  2013. ** the file descriptor is placed in "batch write mode", which
  2014. ** means all subsequent write operations will be deferred and done
  2015. ** atomically at the next [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]. Systems
  2016. ** that do not support batch atomic writes will return SQLITE_NOTFOUND.
  2017. ** ^Following a successful SQLITE_FCNTL_BEGIN_ATOMIC_WRITE and prior to
  2018. ** the closing [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] or
  2019. ** [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE], SQLite will make
  2020. ** no VFS interface calls on the same [sqlite3_file] file descriptor
  2021. ** except for calls to the xWrite method and the xFileControl method
  2022. ** with [SQLITE_FCNTL_SIZE_HINT].
  2023. **
  2024. ** <li>[[SQLITE_FCNTL_COMMIT_ATOMIC_WRITE]]
  2025. ** The [SQLITE_FCNTL_COMMIT_ATOMIC_WRITE] opcode causes all write
  2026. ** operations since the previous successful call to
  2027. ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be performed atomically.
  2028. ** This file control returns [SQLITE_OK] if and only if the writes were
  2029. ** all performed successfully and have been committed to persistent storage.
  2030. ** ^Regardless of whether or not it is successful, this file control takes
  2031. ** the file descriptor out of batch write mode so that all subsequent
  2032. ** write operations are independent.
  2033. ** ^SQLite will never invoke SQLITE_FCNTL_COMMIT_ATOMIC_WRITE without
  2034. ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
  2035. **
  2036. ** <li>[[SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE]]
  2037. ** The [SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE] opcode causes all write
  2038. ** operations since the previous successful call to
  2039. ** [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE] to be rolled back.
  2040. ** ^This file control takes the file descriptor out of batch write mode
  2041. ** so that all subsequent write operations are independent.
  2042. ** ^SQLite will never invoke SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE without
  2043. ** a prior successful call to [SQLITE_FCNTL_BEGIN_ATOMIC_WRITE].
  2044. **
  2045. ** <li>[[SQLITE_FCNTL_LOCK_TIMEOUT]]
  2046. ** The [SQLITE_FCNTL_LOCK_TIMEOUT] opcode causes attempts to obtain
  2047. ** a file lock using the xLock or xShmLock methods of the VFS to wait
  2048. ** for up to M milliseconds before failing, where M is the single
  2049. ** unsigned integer parameter.
  2050. ** </ul>
  2051. */
  2052. #define SQLITE_FCNTL_LOCKSTATE 1
  2053. #define SQLITE_FCNTL_GET_LOCKPROXYFILE 2
  2054. #define SQLITE_FCNTL_SET_LOCKPROXYFILE 3
  2055. #define SQLITE_FCNTL_LAST_ERRNO 4
  2056. #define SQLITE_FCNTL_SIZE_HINT 5
  2057. #define SQLITE_FCNTL_CHUNK_SIZE 6
  2058. #define SQLITE_FCNTL_FILE_POINTER 7
  2059. #define SQLITE_FCNTL_SYNC_OMITTED 8
  2060. #define SQLITE_FCNTL_WIN32_AV_RETRY 9
  2061. #define SQLITE_FCNTL_PERSIST_WAL 10
  2062. #define SQLITE_FCNTL_OVERWRITE 11
  2063. #define SQLITE_FCNTL_VFSNAME 12
  2064. #define SQLITE_FCNTL_POWERSAFE_OVERWRITE 13
  2065. #define SQLITE_FCNTL_PRAGMA 14
  2066. #define SQLITE_FCNTL_BUSYHANDLER 15
  2067. #define SQLITE_FCNTL_TEMPFILENAME 16
  2068. #define SQLITE_FCNTL_MMAP_SIZE 18
  2069. #define SQLITE_FCNTL_TRACE 19
  2070. #define SQLITE_FCNTL_HAS_MOVED 20
  2071. #define SQLITE_FCNTL_SYNC 21
  2072. #define SQLITE_FCNTL_COMMIT_PHASETWO 22
  2073. #define SQLITE_FCNTL_WIN32_SET_HANDLE 23
  2074. #define SQLITE_FCNTL_WAL_BLOCK 24
  2075. #define SQLITE_FCNTL_ZIPVFS 25
  2076. #define SQLITE_FCNTL_RBU 26
  2077. #define SQLITE_FCNTL_VFS_POINTER 27
  2078. #define SQLITE_FCNTL_JOURNAL_POINTER 28
  2079. #define SQLITE_FCNTL_WIN32_GET_HANDLE 29
  2080. #define SQLITE_FCNTL_PDB 30
  2081. #define SQLITE_FCNTL_BEGIN_ATOMIC_WRITE 31
  2082. #define SQLITE_FCNTL_COMMIT_ATOMIC_WRITE 32
  2083. #define SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE 33
  2084. #define SQLITE_FCNTL_LOCK_TIMEOUT 34
  2085. /* deprecated names */
  2086. #define SQLITE_GET_LOCKPROXYFILE SQLITE_FCNTL_GET_LOCKPROXYFILE
  2087. #define SQLITE_SET_LOCKPROXYFILE SQLITE_FCNTL_SET_LOCKPROXYFILE
  2088. #define SQLITE_LAST_ERRNO SQLITE_FCNTL_LAST_ERRNO
  2089. /*
  2090. ** CAPI3REF: Mutex Handle
  2091. **
  2092. ** The mutex module within SQLite defines [sqlite3_mutex] to be an
  2093. ** abstract type for a mutex object. The SQLite core never looks
  2094. ** at the internal representation of an [sqlite3_mutex]. It only
  2095. ** deals with pointers to the [sqlite3_mutex] object.
  2096. **
  2097. ** Mutexes are created using [sqlite3_mutex_alloc()].
  2098. */
  2099. typedef struct sqlite3_mutex sqlite3_mutex;
  2100. /*
  2101. ** CAPI3REF: Loadable Extension Thunk
  2102. **
  2103. ** A pointer to the opaque sqlite3_api_routines structure is passed as
  2104. ** the third parameter to entry points of [loadable extensions]. This
  2105. ** structure must be typedefed in order to work around compiler warnings
  2106. ** on some platforms.
  2107. */
  2108. typedef struct sqlite3_api_routines sqlite3_api_routines;
  2109. /*
  2110. ** CAPI3REF: OS Interface Object
  2111. **
  2112. ** An instance of the sqlite3_vfs object defines the interface between
  2113. ** the SQLite core and the underlying operating system. The "vfs"
  2114. ** in the name of the object stands for "virtual file system". See
  2115. ** the [VFS | VFS documentation] for further information.
  2116. **
  2117. ** The VFS interface is sometimes extended by adding new methods onto
  2118. ** the end. Each time such an extension occurs, the iVersion field
  2119. ** is incremented. The iVersion value started out as 1 in
  2120. ** SQLite [version 3.5.0] on [dateof:3.5.0], then increased to 2
  2121. ** with SQLite [version 3.7.0] on [dateof:3.7.0], and then increased
  2122. ** to 3 with SQLite [version 3.7.6] on [dateof:3.7.6]. Additional fields
  2123. ** may be appended to the sqlite3_vfs object and the iVersion value
  2124. ** may increase again in future versions of SQLite.
  2125. ** Note that the structure
  2126. ** of the sqlite3_vfs object changes in the transition from
  2127. ** SQLite [version 3.5.9] to [version 3.6.0] on [dateof:3.6.0]
  2128. ** and yet the iVersion field was not modified.
  2129. **
  2130. ** The szOsFile field is the size of the subclassed [sqlite3_file]
  2131. ** structure used by this VFS. mxPathname is the maximum length of
  2132. ** a pathname in this VFS.
  2133. **
  2134. ** Registered sqlite3_vfs objects are kept on a linked list formed by
  2135. ** the pNext pointer. The [sqlite3_vfs_register()]
  2136. ** and [sqlite3_vfs_unregister()] interfaces manage this list
  2137. ** in a thread-safe way. The [sqlite3_vfs_find()] interface
  2138. ** searches the list. Neither the application code nor the VFS
  2139. ** implementation should use the pNext pointer.
  2140. **
  2141. ** The pNext field is the only field in the sqlite3_vfs
  2142. ** structure that SQLite will ever modify. SQLite will only access
  2143. ** or modify this field while holding a particular static mutex.
  2144. ** The application should never modify anything within the sqlite3_vfs
  2145. ** object once the object has been registered.
  2146. **
  2147. ** The zName field holds the name of the VFS module. The name must
  2148. ** be unique across all VFS modules.
  2149. **
  2150. ** [[sqlite3_vfs.xOpen]]
  2151. ** ^SQLite guarantees that the zFilename parameter to xOpen
  2152. ** is either a NULL pointer or string obtained
  2153. ** from xFullPathname() with an optional suffix added.
  2154. ** ^If a suffix is added to the zFilename parameter, it will
  2155. ** consist of a single "-" character followed by no more than
  2156. ** 11 alphanumeric and/or "-" characters.
  2157. ** ^SQLite further guarantees that
  2158. ** the string will be valid and unchanged until xClose() is
  2159. ** called. Because of the previous sentence,
  2160. ** the [sqlite3_file] can safely store a pointer to the
  2161. ** filename if it needs to remember the filename for some reason.
  2162. ** If the zFilename parameter to xOpen is a NULL pointer then xOpen
  2163. ** must invent its own temporary name for the file. ^Whenever the
  2164. ** xFilename parameter is NULL it will also be the case that the
  2165. ** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
  2166. **
  2167. ** The flags argument to xOpen() includes all bits set in
  2168. ** the flags argument to [sqlite3_open_v2()]. Or if [sqlite3_open()]
  2169. ** or [sqlite3_open16()] is used, then flags includes at least
  2170. ** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE].
  2171. ** If xOpen() opens a file read-only then it sets *pOutFlags to
  2172. ** include [SQLITE_OPEN_READONLY]. Other bits in *pOutFlags may be set.
  2173. **
  2174. ** ^(SQLite will also add one of the following flags to the xOpen()
  2175. ** call, depending on the object being opened:
  2176. **
  2177. ** <ul>
  2178. ** <li> [SQLITE_OPEN_MAIN_DB]
  2179. ** <li> [SQLITE_OPEN_MAIN_JOURNAL]
  2180. ** <li> [SQLITE_OPEN_TEMP_DB]
  2181. ** <li> [SQLITE_OPEN_TEMP_JOURNAL]
  2182. ** <li> [SQLITE_OPEN_TRANSIENT_DB]
  2183. ** <li> [SQLITE_OPEN_SUBJOURNAL]
  2184. ** <li> [SQLITE_OPEN_MASTER_JOURNAL]
  2185. ** <li> [SQLITE_OPEN_WAL]
  2186. ** </ul>)^
  2187. **
  2188. ** The file I/O implementation can use the object type flags to
  2189. ** change the way it deals with files. For example, an application
  2190. ** that does not care about crash recovery or rollback might make
  2191. ** the open of a journal file a no-op. Writes to this journal would
  2192. ** also be no-ops, and any attempt to read the journal would return
  2193. ** SQLITE_IOERR. Or the implementation might recognize that a database
  2194. ** file will be doing page-aligned sector reads and writes in a random
  2195. ** order and set up its I/O subsystem accordingly.
  2196. **
  2197. ** SQLite might also add one of the following flags to the xOpen method:
  2198. **
  2199. ** <ul>
  2200. ** <li> [SQLITE_OPEN_DELETEONCLOSE]
  2201. ** <li> [SQLITE_OPEN_EXCLUSIVE]
  2202. ** </ul>
  2203. **
  2204. ** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
  2205. ** deleted when it is closed. ^The [SQLITE_OPEN_DELETEONCLOSE]
  2206. ** will be set for TEMP databases and their journals, transient
  2207. ** databases, and subjournals.
  2208. **
  2209. ** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
  2210. ** with the [SQLITE_OPEN_CREATE] flag, which are both directly
  2211. ** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
  2212. ** API. The SQLITE_OPEN_EXCLUSIVE flag, when paired with the
  2213. ** SQLITE_OPEN_CREATE, is used to indicate that file should always
  2214. ** be created, and that it is an error if it already exists.
  2215. ** It is <i>not</i> used to indicate the file should be opened
  2216. ** for exclusive access.
  2217. **
  2218. ** ^At least szOsFile bytes of memory are allocated by SQLite
  2219. ** to hold the [sqlite3_file] structure passed as the third
  2220. ** argument to xOpen. The xOpen method does not have to
  2221. ** allocate the structure; it should just fill it in. Note that
  2222. ** the xOpen method must set the sqlite3_file.pMethods to either
  2223. ** a valid [sqlite3_io_methods] object or to NULL. xOpen must do
  2224. ** this even if the open fails. SQLite expects that the sqlite3_file.pMethods
  2225. ** element will be valid after xOpen returns regardless of the success
  2226. ** or failure of the xOpen call.
  2227. **
  2228. ** [[sqlite3_vfs.xAccess]]
  2229. ** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
  2230. ** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
  2231. ** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
  2232. ** to test whether a file is at least readable. The file can be a
  2233. ** directory.
  2234. **
  2235. ** ^SQLite will always allocate at least mxPathname+1 bytes for the
  2236. ** output buffer xFullPathname. The exact size of the output buffer
  2237. ** is also passed as a parameter to both methods. If the output buffer
  2238. ** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
  2239. ** handled as a fatal error by SQLite, vfs implementations should endeavor
  2240. ** to prevent this by setting mxPathname to a sufficiently large value.
  2241. **
  2242. ** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
  2243. ** interfaces are not strictly a part of the filesystem, but they are
  2244. ** included in the VFS structure for completeness.
  2245. ** The xRandomness() function attempts to return nBytes bytes
  2246. ** of good-quality randomness into zOut. The return value is
  2247. ** the actual number of bytes of randomness obtained.
  2248. ** The xSleep() method causes the calling thread to sleep for at
  2249. ** least the number of microseconds given. ^The xCurrentTime()
  2250. ** method returns a Julian Day Number for the current date and time as
  2251. ** a floating point value.
  2252. ** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
  2253. ** Day Number multiplied by 86400000 (the number of milliseconds in
  2254. ** a 24-hour day).
  2255. ** ^SQLite will use the xCurrentTimeInt64() method to get the current
  2256. ** date and time if that method is available (if iVersion is 2 or
  2257. ** greater and the function pointer is not NULL) and will fall back
  2258. ** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
  2259. **
  2260. ** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
  2261. ** are not used by the SQLite core. These optional interfaces are provided
  2262. ** by some VFSes to facilitate testing of the VFS code. By overriding
  2263. ** system calls with functions under its control, a test program can
  2264. ** simulate faults and error conditions that would otherwise be difficult
  2265. ** or impossible to induce. The set of system calls that can be overridden
  2266. ** varies from one VFS to another, and from one version of the same VFS to the
  2267. ** next. Applications that use these interfaces must be prepared for any
  2268. ** or all of these interfaces to be NULL or for their behavior to change
  2269. ** from one release to the next. Applications must not attempt to access
  2270. ** any of these methods if the iVersion of the VFS is less than 3.
  2271. */
  2272. typedef struct sqlite3_vfs sqlite3_vfs;
  2273. typedef void (*sqlite3_syscall_ptr)(void);
  2274. struct sqlite3_vfs {
  2275. int iVersion; /* Structure version number (currently 3) */
  2276. int szOsFile; /* Size of subclassed sqlite3_file */
  2277. int mxPathname; /* Maximum file pathname length */
  2278. sqlite3_vfs *pNext; /* Next registered VFS */
  2279. const char *zName; /* Name of this virtual file system */
  2280. void *pAppData; /* Pointer to application-specific data */
  2281. int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
  2282. int flags, int *pOutFlags);
  2283. int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
  2284. int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
  2285. int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
  2286. void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
  2287. void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
  2288. void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
  2289. void (*xDlClose)(sqlite3_vfs*, void*);
  2290. int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
  2291. int (*xSleep)(sqlite3_vfs*, int microseconds);
  2292. int (*xCurrentTime)(sqlite3_vfs*, double*);
  2293. int (*xGetLastError)(sqlite3_vfs*, int, char *);
  2294. /*
  2295. ** The methods above are in version 1 of the sqlite_vfs object
  2296. ** definition. Those that follow are added in version 2 or later
  2297. */
  2298. int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
  2299. /*
  2300. ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
  2301. ** Those below are for version 3 and greater.
  2302. */
  2303. int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
  2304. sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
  2305. const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
  2306. /*
  2307. ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
  2308. ** New fields may be appended in future versions. The iVersion
  2309. ** value will increment whenever this happens.
  2310. */
  2311. };
  2312. /*
  2313. ** CAPI3REF: Flags for the xAccess VFS method
  2314. **
  2315. ** These integer constants can be used as the third parameter to
  2316. ** the xAccess method of an [sqlite3_vfs] object. They determine
  2317. ** what kind of permissions the xAccess method is looking for.
  2318. ** With SQLITE_ACCESS_EXISTS, the xAccess method
  2319. ** simply checks whether the file exists.
  2320. ** With SQLITE_ACCESS_READWRITE, the xAccess method
  2321. ** checks whether the named directory is both readable and writable
  2322. ** (in other words, if files can be added, removed, and renamed within
  2323. ** the directory).
  2324. ** The SQLITE_ACCESS_READWRITE constant is currently used only by the
  2325. ** [temp_store_directory pragma], though this could change in a future
  2326. ** release of SQLite.
  2327. ** With SQLITE_ACCESS_READ, the xAccess method
  2328. ** checks whether the file is readable. The SQLITE_ACCESS_READ constant is
  2329. ** currently unused, though it might be used in a future release of
  2330. ** SQLite.
  2331. */
  2332. #define SQLITE_ACCESS_EXISTS 0
  2333. #define SQLITE_ACCESS_READWRITE 1 /* Used by PRAGMA temp_store_directory */
  2334. #define SQLITE_ACCESS_READ 2 /* Unused */
  2335. /*
  2336. ** CAPI3REF: Flags for the xShmLock VFS method
  2337. **
  2338. ** These integer constants define the various locking operations
  2339. ** allowed by the xShmLock method of [sqlite3_io_methods]. The
  2340. ** following are the only legal combinations of flags to the
  2341. ** xShmLock method:
  2342. **
  2343. ** <ul>
  2344. ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
  2345. ** <li> SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
  2346. ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
  2347. ** <li> SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
  2348. ** </ul>
  2349. **
  2350. ** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
  2351. ** was given on the corresponding lock.
  2352. **
  2353. ** The xShmLock method can transition between unlocked and SHARED or
  2354. ** between unlocked and EXCLUSIVE. It cannot transition between SHARED
  2355. ** and EXCLUSIVE.
  2356. */
  2357. #define SQLITE_SHM_UNLOCK 1
  2358. #define SQLITE_SHM_LOCK 2
  2359. #define SQLITE_SHM_SHARED 4
  2360. #define SQLITE_SHM_EXCLUSIVE 8
  2361. /*
  2362. ** CAPI3REF: Maximum xShmLock index
  2363. **
  2364. ** The xShmLock method on [sqlite3_io_methods] may use values
  2365. ** between 0 and this upper bound as its "offset" argument.
  2366. ** The SQLite core will never attempt to acquire or release a
  2367. ** lock outside of this range
  2368. */
  2369. #define SQLITE_SHM_NLOCK 8
  2370. /*
  2371. ** CAPI3REF: Initialize The SQLite Library
  2372. **
  2373. ** ^The sqlite3_initialize() routine initializes the
  2374. ** SQLite library. ^The sqlite3_shutdown() routine
  2375. ** deallocates any resources that were allocated by sqlite3_initialize().
  2376. ** These routines are designed to aid in process initialization and
  2377. ** shutdown on embedded systems. Workstation applications using
  2378. ** SQLite normally do not need to invoke either of these routines.
  2379. **
  2380. ** A call to sqlite3_initialize() is an "effective" call if it is
  2381. ** the first time sqlite3_initialize() is invoked during the lifetime of
  2382. ** the process, or if it is the first time sqlite3_initialize() is invoked
  2383. ** following a call to sqlite3_shutdown(). ^(Only an effective call
  2384. ** of sqlite3_initialize() does any initialization. All other calls
  2385. ** are harmless no-ops.)^
  2386. **
  2387. ** A call to sqlite3_shutdown() is an "effective" call if it is the first
  2388. ** call to sqlite3_shutdown() since the last sqlite3_initialize(). ^(Only
  2389. ** an effective call to sqlite3_shutdown() does any deinitialization.
  2390. ** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
  2391. **
  2392. ** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
  2393. ** is not. The sqlite3_shutdown() interface must only be called from a
  2394. ** single thread. All open [database connections] must be closed and all
  2395. ** other SQLite resources must be deallocated prior to invoking
  2396. ** sqlite3_shutdown().
  2397. **
  2398. ** Among other things, ^sqlite3_initialize() will invoke
  2399. ** sqlite3_os_init(). Similarly, ^sqlite3_shutdown()
  2400. ** will invoke sqlite3_os_end().
  2401. **
  2402. ** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
  2403. ** ^If for some reason, sqlite3_initialize() is unable to initialize
  2404. ** the library (perhaps it is unable to allocate a needed resource such
  2405. ** as a mutex) it returns an [error code] other than [SQLITE_OK].
  2406. **
  2407. ** ^The sqlite3_initialize() routine is called internally by many other
  2408. ** SQLite interfaces so that an application usually does not need to
  2409. ** invoke sqlite3_initialize() directly. For example, [sqlite3_open()]
  2410. ** calls sqlite3_initialize() so the SQLite library will be automatically
  2411. ** initialized when [sqlite3_open()] is called if it has not be initialized
  2412. ** already. ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
  2413. ** compile-time option, then the automatic calls to sqlite3_initialize()
  2414. ** are omitted and the application must call sqlite3_initialize() directly
  2415. ** prior to using any other SQLite interface. For maximum portability,
  2416. ** it is recommended that applications always invoke sqlite3_initialize()
  2417. ** directly prior to using any other SQLite interface. Future releases
  2418. ** of SQLite may require this. In other words, the behavior exhibited
  2419. ** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
  2420. ** default behavior in some future release of SQLite.
  2421. **
  2422. ** The sqlite3_os_init() routine does operating-system specific
  2423. ** initialization of the SQLite library. The sqlite3_os_end()
  2424. ** routine undoes the effect of sqlite3_os_init(). Typical tasks
  2425. ** performed by these routines include allocation or deallocation
  2426. ** of static resources, initialization of global variables,
  2427. ** setting up a default [sqlite3_vfs] module, or setting up
  2428. ** a default configuration using [sqlite3_config()].
  2429. **
  2430. ** The application should never invoke either sqlite3_os_init()
  2431. ** or sqlite3_os_end() directly. The application should only invoke
  2432. ** sqlite3_initialize() and sqlite3_shutdown(). The sqlite3_os_init()
  2433. ** interface is called automatically by sqlite3_initialize() and
  2434. ** sqlite3_os_end() is called by sqlite3_shutdown(). Appropriate
  2435. ** implementations for sqlite3_os_init() and sqlite3_os_end()
  2436. ** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
  2437. ** When [custom builds | built for other platforms]
  2438. ** (using the [SQLITE_OS_OTHER=1] compile-time
  2439. ** option) the application must supply a suitable implementation for
  2440. ** sqlite3_os_init() and sqlite3_os_end(). An application-supplied
  2441. ** implementation of sqlite3_os_init() or sqlite3_os_end()
  2442. ** must return [SQLITE_OK] on success and some other [error code] upon
  2443. ** failure.
  2444. */
  2445. SQLITE_API int sqlite3_initialize(void);
  2446. SQLITE_API int sqlite3_shutdown(void);
  2447. SQLITE_API int sqlite3_os_init(void);
  2448. SQLITE_API int sqlite3_os_end(void);
  2449. /*
  2450. ** CAPI3REF: Configuring The SQLite Library
  2451. **
  2452. ** The sqlite3_config() interface is used to make global configuration
  2453. ** changes to SQLite in order to tune SQLite to the specific needs of
  2454. ** the application. The default configuration is recommended for most
  2455. ** applications and so this routine is usually not necessary. It is
  2456. ** provided to support rare applications with unusual needs.
  2457. **
  2458. ** <b>The sqlite3_config() interface is not threadsafe. The application
  2459. ** must ensure that no other SQLite interfaces are invoked by other
  2460. ** threads while sqlite3_config() is running.</b>
  2461. **
  2462. ** The sqlite3_config() interface
  2463. ** may only be invoked prior to library initialization using
  2464. ** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
  2465. ** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
  2466. ** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
  2467. ** Note, however, that ^sqlite3_config() can be called as part of the
  2468. ** implementation of an application-defined [sqlite3_os_init()].
  2469. **
  2470. ** The first argument to sqlite3_config() is an integer
  2471. ** [configuration option] that determines
  2472. ** what property of SQLite is to be configured. Subsequent arguments
  2473. ** vary depending on the [configuration option]
  2474. ** in the first argument.
  2475. **
  2476. ** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
  2477. ** ^If the option is unknown or SQLite is unable to set the option
  2478. ** then this routine returns a non-zero [error code].
  2479. */
  2480. SQLITE_API int sqlite3_config(int, ...);
  2481. /*
  2482. ** CAPI3REF: Configure database connections
  2483. ** METHOD: sqlite3
  2484. **
  2485. ** The sqlite3_db_config() interface is used to make configuration
  2486. ** changes to a [database connection]. The interface is similar to
  2487. ** [sqlite3_config()] except that the changes apply to a single
  2488. ** [database connection] (specified in the first argument).
  2489. **
  2490. ** The second argument to sqlite3_db_config(D,V,...) is the
  2491. ** [SQLITE_DBCONFIG_LOOKASIDE | configuration verb] - an integer code
  2492. ** that indicates what aspect of the [database connection] is being configured.
  2493. ** Subsequent arguments vary depending on the configuration verb.
  2494. **
  2495. ** ^Calls to sqlite3_db_config() return SQLITE_OK if and only if
  2496. ** the call is considered successful.
  2497. */
  2498. SQLITE_API int sqlite3_db_config(sqlite3*, int op, ...);
  2499. /*
  2500. ** CAPI3REF: Memory Allocation Routines
  2501. **
  2502. ** An instance of this object defines the interface between SQLite
  2503. ** and low-level memory allocation routines.
  2504. **
  2505. ** This object is used in only one place in the SQLite interface.
  2506. ** A pointer to an instance of this object is the argument to
  2507. ** [sqlite3_config()] when the configuration option is
  2508. ** [SQLITE_CONFIG_MALLOC] or [SQLITE_CONFIG_GETMALLOC].
  2509. ** By creating an instance of this object
  2510. ** and passing it to [sqlite3_config]([SQLITE_CONFIG_MALLOC])
  2511. ** during configuration, an application can specify an alternative
  2512. ** memory allocation subsystem for SQLite to use for all of its
  2513. ** dynamic memory needs.
  2514. **
  2515. ** Note that SQLite comes with several [built-in memory allocators]
  2516. ** that are perfectly adequate for the overwhelming majority of applications
  2517. ** and that this object is only useful to a tiny minority of applications
  2518. ** with specialized memory allocation requirements. This object is
  2519. ** also used during testing of SQLite in order to specify an alternative
  2520. ** memory allocator that simulates memory out-of-memory conditions in
  2521. ** order to verify that SQLite recovers gracefully from such
  2522. ** conditions.
  2523. **
  2524. ** The xMalloc, xRealloc, and xFree methods must work like the
  2525. ** malloc(), realloc() and free() functions from the standard C library.
  2526. ** ^SQLite guarantees that the second argument to
  2527. ** xRealloc is always a value returned by a prior call to xRoundup.
  2528. **
  2529. ** xSize should return the allocated size of a memory allocation
  2530. ** previously obtained from xMalloc or xRealloc. The allocated size
  2531. ** is always at least as big as the requested size but may be larger.
  2532. **
  2533. ** The xRoundup method returns what would be the allocated size of
  2534. ** a memory allocation given a particular requested size. Most memory
  2535. ** allocators round up memory allocations at least to the next multiple
  2536. ** of 8. Some allocators round up to a larger multiple or to a power of 2.
  2537. ** Every memory allocation request coming in through [sqlite3_malloc()]
  2538. ** or [sqlite3_realloc()] first calls xRoundup. If xRoundup returns 0,
  2539. ** that causes the corresponding memory allocation to fail.
  2540. **
  2541. ** The xInit method initializes the memory allocator. For example,
  2542. ** it might allocate any require mutexes or initialize internal data
  2543. ** structures. The xShutdown method is invoked (indirectly) by
  2544. ** [sqlite3_shutdown()] and should deallocate any resources acquired
  2545. ** by xInit. The pAppData pointer is used as the only parameter to
  2546. ** xInit and xShutdown.
  2547. **
  2548. ** SQLite holds the [SQLITE_MUTEX_STATIC_MASTER] mutex when it invokes
  2549. ** the xInit method, so the xInit method need not be threadsafe. The
  2550. ** xShutdown method is only called from [sqlite3_shutdown()] so it does
  2551. ** not need to be threadsafe either. For all other methods, SQLite
  2552. ** holds the [SQLITE_MUTEX_STATIC_MEM] mutex as long as the
  2553. ** [SQLITE_CONFIG_MEMSTATUS] configuration option is turned on (which
  2554. ** it is by default) and so the methods are automatically serialized.
  2555. ** However, if [SQLITE_CONFIG_MEMSTATUS] is disabled, then the other
  2556. ** methods must be threadsafe or else make their own arrangements for
  2557. ** serialization.
  2558. **
  2559. ** SQLite will never invoke xInit() more than once without an intervening
  2560. ** call to xShutdown().
  2561. */
  2562. typedef struct sqlite3_mem_methods sqlite3_mem_methods;
  2563. struct sqlite3_mem_methods {
  2564. void *(*xMalloc)(int); /* Memory allocation function */
  2565. void (*xFree)(void*); /* Free a prior allocation */
  2566. void *(*xRealloc)(void*,int); /* Resize an allocation */
  2567. int (*xSize)(void*); /* Return the size of an allocation */
  2568. int (*xRoundup)(int); /* Round up request size to allocation size */
  2569. int (*xInit)(void*); /* Initialize the memory allocator */
  2570. void (*xShutdown)(void*); /* Deinitialize the memory allocator */
  2571. void *pAppData; /* Argument to xInit() and xShutdown() */
  2572. };
  2573. /*
  2574. ** CAPI3REF: Configuration Options
  2575. ** KEYWORDS: {configuration option}
  2576. **
  2577. ** These constants are the available integer configuration options that
  2578. ** can be passed as the first argument to the [sqlite3_config()] interface.
  2579. **
  2580. ** New configuration options may be added in future releases of SQLite.
  2581. ** Existing configuration options might be discontinued. Applications
  2582. ** should check the return code from [sqlite3_config()] to make sure that
  2583. ** the call worked. The [sqlite3_config()] interface will return a
  2584. ** non-zero [error code] if a discontinued or unsupported configuration option
  2585. ** is invoked.
  2586. **
  2587. ** <dl>
  2588. ** [[SQLITE_CONFIG_SINGLETHREAD]] <dt>SQLITE_CONFIG_SINGLETHREAD</dt>
  2589. ** <dd>There are no arguments to this option. ^This option sets the
  2590. ** [threading mode] to Single-thread. In other words, it disables
  2591. ** all mutexing and puts SQLite into a mode where it can only be used
  2592. ** by a single thread. ^If SQLite is compiled with
  2593. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  2594. ** it is not possible to change the [threading mode] from its default
  2595. ** value of Single-thread and so [sqlite3_config()] will return
  2596. ** [SQLITE_ERROR] if called with the SQLITE_CONFIG_SINGLETHREAD
  2597. ** configuration option.</dd>
  2598. **
  2599. ** [[SQLITE_CONFIG_MULTITHREAD]] <dt>SQLITE_CONFIG_MULTITHREAD</dt>
  2600. ** <dd>There are no arguments to this option. ^This option sets the
  2601. ** [threading mode] to Multi-thread. In other words, it disables
  2602. ** mutexing on [database connection] and [prepared statement] objects.
  2603. ** The application is responsible for serializing access to
  2604. ** [database connections] and [prepared statements]. But other mutexes
  2605. ** are enabled so that SQLite will be safe to use in a multi-threaded
  2606. ** environment as long as no two threads attempt to use the same
  2607. ** [database connection] at the same time. ^If SQLite is compiled with
  2608. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  2609. ** it is not possible to set the Multi-thread [threading mode] and
  2610. ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
  2611. ** SQLITE_CONFIG_MULTITHREAD configuration option.</dd>
  2612. **
  2613. ** [[SQLITE_CONFIG_SERIALIZED]] <dt>SQLITE_CONFIG_SERIALIZED</dt>
  2614. ** <dd>There are no arguments to this option. ^This option sets the
  2615. ** [threading mode] to Serialized. In other words, this option enables
  2616. ** all mutexes including the recursive
  2617. ** mutexes on [database connection] and [prepared statement] objects.
  2618. ** In this mode (which is the default when SQLite is compiled with
  2619. ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
  2620. ** to [database connections] and [prepared statements] so that the
  2621. ** application is free to use the same [database connection] or the
  2622. ** same [prepared statement] in different threads at the same time.
  2623. ** ^If SQLite is compiled with
  2624. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  2625. ** it is not possible to set the Serialized [threading mode] and
  2626. ** [sqlite3_config()] will return [SQLITE_ERROR] if called with the
  2627. ** SQLITE_CONFIG_SERIALIZED configuration option.</dd>
  2628. **
  2629. ** [[SQLITE_CONFIG_MALLOC]] <dt>SQLITE_CONFIG_MALLOC</dt>
  2630. ** <dd> ^(The SQLITE_CONFIG_MALLOC option takes a single argument which is
  2631. ** a pointer to an instance of the [sqlite3_mem_methods] structure.
  2632. ** The argument specifies
  2633. ** alternative low-level memory allocation routines to be used in place of
  2634. ** the memory allocation routines built into SQLite.)^ ^SQLite makes
  2635. ** its own private copy of the content of the [sqlite3_mem_methods] structure
  2636. ** before the [sqlite3_config()] call returns.</dd>
  2637. **
  2638. ** [[SQLITE_CONFIG_GETMALLOC]] <dt>SQLITE_CONFIG_GETMALLOC</dt>
  2639. ** <dd> ^(The SQLITE_CONFIG_GETMALLOC option takes a single argument which
  2640. ** is a pointer to an instance of the [sqlite3_mem_methods] structure.
  2641. ** The [sqlite3_mem_methods]
  2642. ** structure is filled with the currently defined memory allocation routines.)^
  2643. ** This option can be used to overload the default memory allocation
  2644. ** routines with a wrapper that simulations memory allocation failure or
  2645. ** tracks memory usage, for example. </dd>
  2646. **
  2647. ** [[SQLITE_CONFIG_SMALL_MALLOC]] <dt>SQLITE_CONFIG_SMALL_MALLOC</dt>
  2648. ** <dd> ^The SQLITE_CONFIG_SMALL_MALLOC option takes single argument of
  2649. ** type int, interpreted as a boolean, which if true provides a hint to
  2650. ** SQLite that it should avoid large memory allocations if possible.
  2651. ** SQLite will run faster if it is free to make large memory allocations,
  2652. ** but some application might prefer to run slower in exchange for
  2653. ** guarantees about memory fragmentation that are possible if large
  2654. ** allocations are avoided. This hint is normally off.
  2655. ** </dd>
  2656. **
  2657. ** [[SQLITE_CONFIG_MEMSTATUS]] <dt>SQLITE_CONFIG_MEMSTATUS</dt>
  2658. ** <dd> ^The SQLITE_CONFIG_MEMSTATUS option takes single argument of type int,
  2659. ** interpreted as a boolean, which enables or disables the collection of
  2660. ** memory allocation statistics. ^(When memory allocation statistics are
  2661. ** disabled, the following SQLite interfaces become non-operational:
  2662. ** <ul>
  2663. ** <li> [sqlite3_memory_used()]
  2664. ** <li> [sqlite3_memory_highwater()]
  2665. ** <li> [sqlite3_soft_heap_limit64()]
  2666. ** <li> [sqlite3_status64()]
  2667. ** </ul>)^
  2668. ** ^Memory allocation statistics are enabled by default unless SQLite is
  2669. ** compiled with [SQLITE_DEFAULT_MEMSTATUS]=0 in which case memory
  2670. ** allocation statistics are disabled by default.
  2671. ** </dd>
  2672. **
  2673. ** [[SQLITE_CONFIG_SCRATCH]] <dt>SQLITE_CONFIG_SCRATCH</dt>
  2674. ** <dd> The SQLITE_CONFIG_SCRATCH option is no longer used.
  2675. ** </dd>
  2676. **
  2677. ** [[SQLITE_CONFIG_PAGECACHE]] <dt>SQLITE_CONFIG_PAGECACHE</dt>
  2678. ** <dd> ^The SQLITE_CONFIG_PAGECACHE option specifies a memory pool
  2679. ** that SQLite can use for the database page cache with the default page
  2680. ** cache implementation.
  2681. ** This configuration option is a no-op if an application-define page
  2682. ** cache implementation is loaded using the [SQLITE_CONFIG_PCACHE2].
  2683. ** ^There are three arguments to SQLITE_CONFIG_PAGECACHE: A pointer to
  2684. ** 8-byte aligned memory (pMem), the size of each page cache line (sz),
  2685. ** and the number of cache lines (N).
  2686. ** The sz argument should be the size of the largest database page
  2687. ** (a power of two between 512 and 65536) plus some extra bytes for each
  2688. ** page header. ^The number of extra bytes needed by the page header
  2689. ** can be determined using [SQLITE_CONFIG_PCACHE_HDRSZ].
  2690. ** ^It is harmless, apart from the wasted memory,
  2691. ** for the sz parameter to be larger than necessary. The pMem
  2692. ** argument must be either a NULL pointer or a pointer to an 8-byte
  2693. ** aligned block of memory of at least sz*N bytes, otherwise
  2694. ** subsequent behavior is undefined.
  2695. ** ^When pMem is not NULL, SQLite will strive to use the memory provided
  2696. ** to satisfy page cache needs, falling back to [sqlite3_malloc()] if
  2697. ** a page cache line is larger than sz bytes or if all of the pMem buffer
  2698. ** is exhausted.
  2699. ** ^If pMem is NULL and N is non-zero, then each database connection
  2700. ** does an initial bulk allocation for page cache memory
  2701. ** from [sqlite3_malloc()] sufficient for N cache lines if N is positive or
  2702. ** of -1024*N bytes if N is negative, . ^If additional
  2703. ** page cache memory is needed beyond what is provided by the initial
  2704. ** allocation, then SQLite goes to [sqlite3_malloc()] separately for each
  2705. ** additional cache line. </dd>
  2706. **
  2707. ** [[SQLITE_CONFIG_HEAP]] <dt>SQLITE_CONFIG_HEAP</dt>
  2708. ** <dd> ^The SQLITE_CONFIG_HEAP option specifies a static memory buffer
  2709. ** that SQLite will use for all of its dynamic memory allocation needs
  2710. ** beyond those provided for by [SQLITE_CONFIG_PAGECACHE].
  2711. ** ^The SQLITE_CONFIG_HEAP option is only available if SQLite is compiled
  2712. ** with either [SQLITE_ENABLE_MEMSYS3] or [SQLITE_ENABLE_MEMSYS5] and returns
  2713. ** [SQLITE_ERROR] if invoked otherwise.
  2714. ** ^There are three arguments to SQLITE_CONFIG_HEAP:
  2715. ** An 8-byte aligned pointer to the memory,
  2716. ** the number of bytes in the memory buffer, and the minimum allocation size.
  2717. ** ^If the first pointer (the memory pointer) is NULL, then SQLite reverts
  2718. ** to using its default memory allocator (the system malloc() implementation),
  2719. ** undoing any prior invocation of [SQLITE_CONFIG_MALLOC]. ^If the
  2720. ** memory pointer is not NULL then the alternative memory
  2721. ** allocator is engaged to handle all of SQLites memory allocation needs.
  2722. ** The first pointer (the memory pointer) must be aligned to an 8-byte
  2723. ** boundary or subsequent behavior of SQLite will be undefined.
  2724. ** The minimum allocation size is capped at 2**12. Reasonable values
  2725. ** for the minimum allocation size are 2**5 through 2**8.</dd>
  2726. **
  2727. ** [[SQLITE_CONFIG_MUTEX]] <dt>SQLITE_CONFIG_MUTEX</dt>
  2728. ** <dd> ^(The SQLITE_CONFIG_MUTEX option takes a single argument which is a
  2729. ** pointer to an instance of the [sqlite3_mutex_methods] structure.
  2730. ** The argument specifies alternative low-level mutex routines to be used
  2731. ** in place the mutex routines built into SQLite.)^ ^SQLite makes a copy of
  2732. ** the content of the [sqlite3_mutex_methods] structure before the call to
  2733. ** [sqlite3_config()] returns. ^If SQLite is compiled with
  2734. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  2735. ** the entire mutexing subsystem is omitted from the build and hence calls to
  2736. ** [sqlite3_config()] with the SQLITE_CONFIG_MUTEX configuration option will
  2737. ** return [SQLITE_ERROR].</dd>
  2738. **
  2739. ** [[SQLITE_CONFIG_GETMUTEX]] <dt>SQLITE_CONFIG_GETMUTEX</dt>
  2740. ** <dd> ^(The SQLITE_CONFIG_GETMUTEX option takes a single argument which
  2741. ** is a pointer to an instance of the [sqlite3_mutex_methods] structure. The
  2742. ** [sqlite3_mutex_methods]
  2743. ** structure is filled with the currently defined mutex routines.)^
  2744. ** This option can be used to overload the default mutex allocation
  2745. ** routines with a wrapper used to track mutex usage for performance
  2746. ** profiling or testing, for example. ^If SQLite is compiled with
  2747. ** the [SQLITE_THREADSAFE | SQLITE_THREADSAFE=0] compile-time option then
  2748. ** the entire mutexing subsystem is omitted from the build and hence calls to
  2749. ** [sqlite3_config()] with the SQLITE_CONFIG_GETMUTEX configuration option will
  2750. ** return [SQLITE_ERROR].</dd>
  2751. **
  2752. ** [[SQLITE_CONFIG_LOOKASIDE]] <dt>SQLITE_CONFIG_LOOKASIDE</dt>
  2753. ** <dd> ^(The SQLITE_CONFIG_LOOKASIDE option takes two arguments that determine
  2754. ** the default size of lookaside memory on each [database connection].
  2755. ** The first argument is the
  2756. ** size of each lookaside buffer slot and the second is the number of
  2757. ** slots allocated to each database connection.)^ ^(SQLITE_CONFIG_LOOKASIDE
  2758. ** sets the <i>default</i> lookaside size. The [SQLITE_DBCONFIG_LOOKASIDE]
  2759. ** option to [sqlite3_db_config()] can be used to change the lookaside
  2760. ** configuration on individual connections.)^ </dd>
  2761. **
  2762. ** [[SQLITE_CONFIG_PCACHE2]] <dt>SQLITE_CONFIG_PCACHE2</dt>
  2763. ** <dd> ^(The SQLITE_CONFIG_PCACHE2 option takes a single argument which is
  2764. ** a pointer to an [sqlite3_pcache_methods2] object. This object specifies
  2765. ** the interface to a custom page cache implementation.)^
  2766. ** ^SQLite makes a copy of the [sqlite3_pcache_methods2] object.</dd>
  2767. **
  2768. ** [[SQLITE_CONFIG_GETPCACHE2]] <dt>SQLITE_CONFIG_GETPCACHE2</dt>
  2769. ** <dd> ^(The SQLITE_CONFIG_GETPCACHE2 option takes a single argument which
  2770. ** is a pointer to an [sqlite3_pcache_methods2] object. SQLite copies of
  2771. ** the current page cache implementation into that object.)^ </dd>
  2772. **
  2773. ** [[SQLITE_CONFIG_LOG]] <dt>SQLITE_CONFIG_LOG</dt>
  2774. ** <dd> The SQLITE_CONFIG_LOG option is used to configure the SQLite
  2775. ** global [error log].
  2776. ** (^The SQLITE_CONFIG_LOG option takes two arguments: a pointer to a
  2777. ** function with a call signature of void(*)(void*,int,const char*),
  2778. ** and a pointer to void. ^If the function pointer is not NULL, it is
  2779. ** invoked by [sqlite3_log()] to process each logging event. ^If the
  2780. ** function pointer is NULL, the [sqlite3_log()] interface becomes a no-op.
  2781. ** ^The void pointer that is the second argument to SQLITE_CONFIG_LOG is
  2782. ** passed through as the first parameter to the application-defined logger
  2783. ** function whenever that function is invoked. ^The second parameter to
  2784. ** the logger function is a copy of the first parameter to the corresponding
  2785. ** [sqlite3_log()] call and is intended to be a [result code] or an
  2786. ** [extended result code]. ^The third parameter passed to the logger is
  2787. ** log message after formatting via [sqlite3_snprintf()].
  2788. ** The SQLite logging interface is not reentrant; the logger function
  2789. ** supplied by the application must not invoke any SQLite interface.
  2790. ** In a multi-threaded application, the application-defined logger
  2791. ** function must be threadsafe. </dd>
  2792. **
  2793. ** [[SQLITE_CONFIG_URI]] <dt>SQLITE_CONFIG_URI
  2794. ** <dd>^(The SQLITE_CONFIG_URI option takes a single argument of type int.
  2795. ** If non-zero, then URI handling is globally enabled. If the parameter is zero,
  2796. ** then URI handling is globally disabled.)^ ^If URI handling is globally
  2797. ** enabled, all filenames passed to [sqlite3_open()], [sqlite3_open_v2()],
  2798. ** [sqlite3_open16()] or
  2799. ** specified as part of [ATTACH] commands are interpreted as URIs, regardless
  2800. ** of whether or not the [SQLITE_OPEN_URI] flag is set when the database
  2801. ** connection is opened. ^If it is globally disabled, filenames are
  2802. ** only interpreted as URIs if the SQLITE_OPEN_URI flag is set when the
  2803. ** database connection is opened. ^(By default, URI handling is globally
  2804. ** disabled. The default value may be changed by compiling with the
  2805. ** [SQLITE_USE_URI] symbol defined.)^
  2806. **
  2807. ** [[SQLITE_CONFIG_COVERING_INDEX_SCAN]] <dt>SQLITE_CONFIG_COVERING_INDEX_SCAN
  2808. ** <dd>^The SQLITE_CONFIG_COVERING_INDEX_SCAN option takes a single integer
  2809. ** argument which is interpreted as a boolean in order to enable or disable
  2810. ** the use of covering indices for full table scans in the query optimizer.
  2811. ** ^The default setting is determined
  2812. ** by the [SQLITE_ALLOW_COVERING_INDEX_SCAN] compile-time option, or is "on"
  2813. ** if that compile-time option is omitted.
  2814. ** The ability to disable the use of covering indices for full table scans
  2815. ** is because some incorrectly coded legacy applications might malfunction
  2816. ** when the optimization is enabled. Providing the ability to
  2817. ** disable the optimization allows the older, buggy application code to work
  2818. ** without change even with newer versions of SQLite.
  2819. **
  2820. ** [[SQLITE_CONFIG_PCACHE]] [[SQLITE_CONFIG_GETPCACHE]]
  2821. ** <dt>SQLITE_CONFIG_PCACHE and SQLITE_CONFIG_GETPCACHE
  2822. ** <dd> These options are obsolete and should not be used by new code.
  2823. ** They are retained for backwards compatibility but are now no-ops.
  2824. ** </dd>
  2825. **
  2826. ** [[SQLITE_CONFIG_SQLLOG]]
  2827. ** <dt>SQLITE_CONFIG_SQLLOG
  2828. ** <dd>This option is only available if sqlite is compiled with the
  2829. ** [SQLITE_ENABLE_SQLLOG] pre-processor macro defined. The first argument should
  2830. ** be a pointer to a function of type void(*)(void*,sqlite3*,const char*, int).
  2831. ** The second should be of type (void*). The callback is invoked by the library
  2832. ** in three separate circumstances, identified by the value passed as the
  2833. ** fourth parameter. If the fourth parameter is 0, then the database connection
  2834. ** passed as the second argument has just been opened. The third argument
  2835. ** points to a buffer containing the name of the main database file. If the
  2836. ** fourth parameter is 1, then the SQL statement that the third parameter
  2837. ** points to has just been executed. Or, if the fourth parameter is 2, then
  2838. ** the connection being passed as the second parameter is being closed. The
  2839. ** third parameter is passed NULL In this case. An example of using this
  2840. ** configuration option can be seen in the "test_sqllog.c" source file in
  2841. ** the canonical SQLite source tree.</dd>
  2842. **
  2843. ** [[SQLITE_CONFIG_MMAP_SIZE]]
  2844. ** <dt>SQLITE_CONFIG_MMAP_SIZE
  2845. ** <dd>^SQLITE_CONFIG_MMAP_SIZE takes two 64-bit integer (sqlite3_int64) values
  2846. ** that are the default mmap size limit (the default setting for
  2847. ** [PRAGMA mmap_size]) and the maximum allowed mmap size limit.
  2848. ** ^The default setting can be overridden by each database connection using
  2849. ** either the [PRAGMA mmap_size] command, or by using the
  2850. ** [SQLITE_FCNTL_MMAP_SIZE] file control. ^(The maximum allowed mmap size
  2851. ** will be silently truncated if necessary so that it does not exceed the
  2852. ** compile-time maximum mmap size set by the
  2853. ** [SQLITE_MAX_MMAP_SIZE] compile-time option.)^
  2854. ** ^If either argument to this option is negative, then that argument is
  2855. ** changed to its compile-time default.
  2856. **
  2857. ** [[SQLITE_CONFIG_WIN32_HEAPSIZE]]
  2858. ** <dt>SQLITE_CONFIG_WIN32_HEAPSIZE
  2859. ** <dd>^The SQLITE_CONFIG_WIN32_HEAPSIZE option is only available if SQLite is
  2860. ** compiled for Windows with the [SQLITE_WIN32_MALLOC] pre-processor macro
  2861. ** defined. ^SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit unsigned integer value
  2862. ** that specifies the maximum size of the created heap.
  2863. **
  2864. ** [[SQLITE_CONFIG_PCACHE_HDRSZ]]
  2865. ** <dt>SQLITE_CONFIG_PCACHE_HDRSZ
  2866. ** <dd>^The SQLITE_CONFIG_PCACHE_HDRSZ option takes a single parameter which
  2867. ** is a pointer to an integer and writes into that integer the number of extra
  2868. ** bytes per page required for each page in [SQLITE_CONFIG_PAGECACHE].
  2869. ** The amount of extra space required can change depending on the compiler,
  2870. ** target platform, and SQLite version.
  2871. **
  2872. ** [[SQLITE_CONFIG_PMASZ]]
  2873. ** <dt>SQLITE_CONFIG_PMASZ
  2874. ** <dd>^The SQLITE_CONFIG_PMASZ option takes a single parameter which
  2875. ** is an unsigned integer and sets the "Minimum PMA Size" for the multithreaded
  2876. ** sorter to that integer. The default minimum PMA Size is set by the
  2877. ** [SQLITE_SORTER_PMASZ] compile-time option. New threads are launched
  2878. ** to help with sort operations when multithreaded sorting
  2879. ** is enabled (using the [PRAGMA threads] command) and the amount of content
  2880. ** to be sorted exceeds the page size times the minimum of the
  2881. ** [PRAGMA cache_size] setting and this value.
  2882. **
  2883. ** [[SQLITE_CONFIG_STMTJRNL_SPILL]]
  2884. ** <dt>SQLITE_CONFIG_STMTJRNL_SPILL
  2885. ** <dd>^The SQLITE_CONFIG_STMTJRNL_SPILL option takes a single parameter which
  2886. ** becomes the [statement journal] spill-to-disk threshold.
  2887. ** [Statement journals] are held in memory until their size (in bytes)
  2888. ** exceeds this threshold, at which point they are written to disk.
  2889. ** Or if the threshold is -1, statement journals are always held
  2890. ** exclusively in memory.
  2891. ** Since many statement journals never become large, setting the spill
  2892. ** threshold to a value such as 64KiB can greatly reduce the amount of
  2893. ** I/O required to support statement rollback.
  2894. ** The default value for this setting is controlled by the
  2895. ** [SQLITE_STMTJRNL_SPILL] compile-time option.
  2896. ** </dl>
  2897. */
  2898. #define SQLITE_CONFIG_SINGLETHREAD 1 /* nil */
  2899. #define SQLITE_CONFIG_MULTITHREAD 2 /* nil */
  2900. #define SQLITE_CONFIG_SERIALIZED 3 /* nil */
  2901. #define SQLITE_CONFIG_MALLOC 4 /* sqlite3_mem_methods* */
  2902. #define SQLITE_CONFIG_GETMALLOC 5 /* sqlite3_mem_methods* */
  2903. #define SQLITE_CONFIG_SCRATCH 6 /* No longer used */
  2904. #define SQLITE_CONFIG_PAGECACHE 7 /* void*, int sz, int N */
  2905. #define SQLITE_CONFIG_HEAP 8 /* void*, int nByte, int min */
  2906. #define SQLITE_CONFIG_MEMSTATUS 9 /* boolean */
  2907. #define SQLITE_CONFIG_MUTEX 10 /* sqlite3_mutex_methods* */
  2908. #define SQLITE_CONFIG_GETMUTEX 11 /* sqlite3_mutex_methods* */
  2909. /* previously SQLITE_CONFIG_CHUNKALLOC 12 which is now unused. */
  2910. #define SQLITE_CONFIG_LOOKASIDE 13 /* int int */
  2911. #define SQLITE_CONFIG_PCACHE 14 /* no-op */
  2912. #define SQLITE_CONFIG_GETPCACHE 15 /* no-op */
  2913. #define SQLITE_CONFIG_LOG 16 /* xFunc, void* */
  2914. #define SQLITE_CONFIG_URI 17 /* int */
  2915. #define SQLITE_CONFIG_PCACHE2 18 /* sqlite3_pcache_methods2* */
  2916. #define SQLITE_CONFIG_GETPCACHE2 19 /* sqlite3_pcache_methods2* */
  2917. #define SQLITE_CONFIG_COVERING_INDEX_SCAN 20 /* int */
  2918. #define SQLITE_CONFIG_SQLLOG 21 /* xSqllog, void* */
  2919. #define SQLITE_CONFIG_MMAP_SIZE 22 /* sqlite3_int64, sqlite3_int64 */
  2920. #define SQLITE_CONFIG_WIN32_HEAPSIZE 23 /* int nByte */
  2921. #define SQLITE_CONFIG_PCACHE_HDRSZ 24 /* int *psz */
  2922. #define SQLITE_CONFIG_PMASZ 25 /* unsigned int szPma */
  2923. #define SQLITE_CONFIG_STMTJRNL_SPILL 26 /* int nByte */
  2924. #define SQLITE_CONFIG_SMALL_MALLOC 27 /* boolean */
  2925. /*
  2926. ** CAPI3REF: Database Connection Configuration Options
  2927. **
  2928. ** These constants are the available integer configuration options that
  2929. ** can be passed as the second argument to the [sqlite3_db_config()] interface.
  2930. **
  2931. ** New configuration options may be added in future releases of SQLite.
  2932. ** Existing configuration options might be discontinued. Applications
  2933. ** should check the return code from [sqlite3_db_config()] to make sure that
  2934. ** the call worked. ^The [sqlite3_db_config()] interface will return a
  2935. ** non-zero [error code] if a discontinued or unsupported configuration option
  2936. ** is invoked.
  2937. **
  2938. ** <dl>
  2939. ** <dt>SQLITE_DBCONFIG_LOOKASIDE</dt>
  2940. ** <dd> ^This option takes three additional arguments that determine the
  2941. ** [lookaside memory allocator] configuration for the [database connection].
  2942. ** ^The first argument (the third parameter to [sqlite3_db_config()] is a
  2943. ** pointer to a memory buffer to use for lookaside memory.
  2944. ** ^The first argument after the SQLITE_DBCONFIG_LOOKASIDE verb
  2945. ** may be NULL in which case SQLite will allocate the
  2946. ** lookaside buffer itself using [sqlite3_malloc()]. ^The second argument is the
  2947. ** size of each lookaside buffer slot. ^The third argument is the number of
  2948. ** slots. The size of the buffer in the first argument must be greater than
  2949. ** or equal to the product of the second and third arguments. The buffer
  2950. ** must be aligned to an 8-byte boundary. ^If the second argument to
  2951. ** SQLITE_DBCONFIG_LOOKASIDE is not a multiple of 8, it is internally
  2952. ** rounded down to the next smaller multiple of 8. ^(The lookaside memory
  2953. ** configuration for a database connection can only be changed when that
  2954. ** connection is not currently using lookaside memory, or in other words
  2955. ** when the "current value" returned by
  2956. ** [sqlite3_db_status](D,[SQLITE_CONFIG_LOOKASIDE],...) is zero.
  2957. ** Any attempt to change the lookaside memory configuration when lookaside
  2958. ** memory is in use leaves the configuration unchanged and returns
  2959. ** [SQLITE_BUSY].)^</dd>
  2960. **
  2961. ** <dt>SQLITE_DBCONFIG_ENABLE_FKEY</dt>
  2962. ** <dd> ^This option is used to enable or disable the enforcement of
  2963. ** [foreign key constraints]. There should be two additional arguments.
  2964. ** The first argument is an integer which is 0 to disable FK enforcement,
  2965. ** positive to enable FK enforcement or negative to leave FK enforcement
  2966. ** unchanged. The second parameter is a pointer to an integer into which
  2967. ** is written 0 or 1 to indicate whether FK enforcement is off or on
  2968. ** following this call. The second parameter may be a NULL pointer, in
  2969. ** which case the FK enforcement setting is not reported back. </dd>
  2970. **
  2971. ** <dt>SQLITE_DBCONFIG_ENABLE_TRIGGER</dt>
  2972. ** <dd> ^This option is used to enable or disable [CREATE TRIGGER | triggers].
  2973. ** There should be two additional arguments.
  2974. ** The first argument is an integer which is 0 to disable triggers,
  2975. ** positive to enable triggers or negative to leave the setting unchanged.
  2976. ** The second parameter is a pointer to an integer into which
  2977. ** is written 0 or 1 to indicate whether triggers are disabled or enabled
  2978. ** following this call. The second parameter may be a NULL pointer, in
  2979. ** which case the trigger setting is not reported back. </dd>
  2980. **
  2981. ** <dt>SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</dt>
  2982. ** <dd> ^This option is used to enable or disable the two-argument
  2983. ** version of the [fts3_tokenizer()] function which is part of the
  2984. ** [FTS3] full-text search engine extension.
  2985. ** There should be two additional arguments.
  2986. ** The first argument is an integer which is 0 to disable fts3_tokenizer() or
  2987. ** positive to enable fts3_tokenizer() or negative to leave the setting
  2988. ** unchanged.
  2989. ** The second parameter is a pointer to an integer into which
  2990. ** is written 0 or 1 to indicate whether fts3_tokenizer is disabled or enabled
  2991. ** following this call. The second parameter may be a NULL pointer, in
  2992. ** which case the new setting is not reported back. </dd>
  2993. **
  2994. ** <dt>SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</dt>
  2995. ** <dd> ^This option is used to enable or disable the [sqlite3_load_extension()]
  2996. ** interface independently of the [load_extension()] SQL function.
  2997. ** The [sqlite3_enable_load_extension()] API enables or disables both the
  2998. ** C-API [sqlite3_load_extension()] and the SQL function [load_extension()].
  2999. ** There should be two additional arguments.
  3000. ** When the first argument to this interface is 1, then only the C-API is
  3001. ** enabled and the SQL function remains disabled. If the first argument to
  3002. ** this interface is 0, then both the C-API and the SQL function are disabled.
  3003. ** If the first argument is -1, then no changes are made to state of either the
  3004. ** C-API or the SQL function.
  3005. ** The second parameter is a pointer to an integer into which
  3006. ** is written 0 or 1 to indicate whether [sqlite3_load_extension()] interface
  3007. ** is disabled or enabled following this call. The second parameter may
  3008. ** be a NULL pointer, in which case the new setting is not reported back.
  3009. ** </dd>
  3010. **
  3011. ** <dt>SQLITE_DBCONFIG_MAINDBNAME</dt>
  3012. ** <dd> ^This option is used to change the name of the "main" database
  3013. ** schema. ^The sole argument is a pointer to a constant UTF8 string
  3014. ** which will become the new schema name in place of "main". ^SQLite
  3015. ** does not make a copy of the new main schema name string, so the application
  3016. ** must ensure that the argument passed into this DBCONFIG option is unchanged
  3017. ** until after the database connection closes.
  3018. ** </dd>
  3019. **
  3020. ** <dt>SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</dt>
  3021. ** <dd> Usually, when a database in wal mode is closed or detached from a
  3022. ** database handle, SQLite checks if this will mean that there are now no
  3023. ** connections at all to the database. If so, it performs a checkpoint
  3024. ** operation before closing the connection. This option may be used to
  3025. ** override this behaviour. The first parameter passed to this operation
  3026. ** is an integer - positive to disable checkpoints-on-close, or zero (the
  3027. ** default) to enable them, and negative to leave the setting unchanged.
  3028. ** The second parameter is a pointer to an integer
  3029. ** into which is written 0 or 1 to indicate whether checkpoints-on-close
  3030. ** have been disabled - 0 if they are not disabled, 1 if they are.
  3031. ** </dd>
  3032. **
  3033. ** <dt>SQLITE_DBCONFIG_ENABLE_QPSG</dt>
  3034. ** <dd>^(The SQLITE_DBCONFIG_ENABLE_QPSG option activates or deactivates
  3035. ** the [query planner stability guarantee] (QPSG). When the QPSG is active,
  3036. ** a single SQL query statement will always use the same algorithm regardless
  3037. ** of values of [bound parameters].)^ The QPSG disables some query optimizations
  3038. ** that look at the values of bound parameters, which can make some queries
  3039. ** slower. But the QPSG has the advantage of more predictable behavior. With
  3040. ** the QPSG active, SQLite will always use the same query plan in the field as
  3041. ** was used during testing in the lab.
  3042. ** The first argument to this setting is an integer which is 0 to disable
  3043. ** the QPSG, positive to enable QPSG, or negative to leave the setting
  3044. ** unchanged. The second parameter is a pointer to an integer into which
  3045. ** is written 0 or 1 to indicate whether the QPSG is disabled or enabled
  3046. ** following this call.
  3047. ** </dd>
  3048. **
  3049. ** <dt>SQLITE_DBCONFIG_TRIGGER_EQP</dt>
  3050. ** <dd> By default, the output of EXPLAIN QUERY PLAN commands does not
  3051. ** include output for any operations performed by trigger programs. This
  3052. ** option is used to set or clear (the default) a flag that governs this
  3053. ** behavior. The first parameter passed to this operation is an integer -
  3054. ** positive to enable output for trigger programs, or zero to disable it,
  3055. ** or negative to leave the setting unchanged.
  3056. ** The second parameter is a pointer to an integer into which is written
  3057. ** 0 or 1 to indicate whether output-for-triggers has been disabled - 0 if
  3058. ** it is not disabled, 1 if it is.
  3059. ** </dd>
  3060. ** </dl>
  3061. */
  3062. #define SQLITE_DBCONFIG_MAINDBNAME 1000 /* const char* */
  3063. #define SQLITE_DBCONFIG_LOOKASIDE 1001 /* void* int int */
  3064. #define SQLITE_DBCONFIG_ENABLE_FKEY 1002 /* int int* */
  3065. #define SQLITE_DBCONFIG_ENABLE_TRIGGER 1003 /* int int* */
  3066. #define SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER 1004 /* int int* */
  3067. #define SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION 1005 /* int int* */
  3068. #define SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE 1006 /* int int* */
  3069. #define SQLITE_DBCONFIG_ENABLE_QPSG 1007 /* int int* */
  3070. #define SQLITE_DBCONFIG_TRIGGER_EQP 1008 /* int int* */
  3071. #define SQLITE_DBCONFIG_MAX 1008 /* Largest DBCONFIG */
  3072. /*
  3073. ** CAPI3REF: Enable Or Disable Extended Result Codes
  3074. ** METHOD: sqlite3
  3075. **
  3076. ** ^The sqlite3_extended_result_codes() routine enables or disables the
  3077. ** [extended result codes] feature of SQLite. ^The extended result
  3078. ** codes are disabled by default for historical compatibility.
  3079. */
  3080. SQLITE_API int sqlite3_extended_result_codes(sqlite3*, int onoff);
  3081. /*
  3082. ** CAPI3REF: Last Insert Rowid
  3083. ** METHOD: sqlite3
  3084. **
  3085. ** ^Each entry in most SQLite tables (except for [WITHOUT ROWID] tables)
  3086. ** has a unique 64-bit signed
  3087. ** integer key called the [ROWID | "rowid"]. ^The rowid is always available
  3088. ** as an undeclared column named ROWID, OID, or _ROWID_ as long as those
  3089. ** names are not also used by explicitly declared columns. ^If
  3090. ** the table has a column of type [INTEGER PRIMARY KEY] then that column
  3091. ** is another alias for the rowid.
  3092. **
  3093. ** ^The sqlite3_last_insert_rowid(D) interface usually returns the [rowid] of
  3094. ** the most recent successful [INSERT] into a rowid table or [virtual table]
  3095. ** on database connection D. ^Inserts into [WITHOUT ROWID] tables are not
  3096. ** recorded. ^If no successful [INSERT]s into rowid tables have ever occurred
  3097. ** on the database connection D, then sqlite3_last_insert_rowid(D) returns
  3098. ** zero.
  3099. **
  3100. ** As well as being set automatically as rows are inserted into database
  3101. ** tables, the value returned by this function may be set explicitly by
  3102. ** [sqlite3_set_last_insert_rowid()]
  3103. **
  3104. ** Some virtual table implementations may INSERT rows into rowid tables as
  3105. ** part of committing a transaction (e.g. to flush data accumulated in memory
  3106. ** to disk). In this case subsequent calls to this function return the rowid
  3107. ** associated with these internal INSERT operations, which leads to
  3108. ** unintuitive results. Virtual table implementations that do write to rowid
  3109. ** tables in this way can avoid this problem by restoring the original
  3110. ** rowid value using [sqlite3_set_last_insert_rowid()] before returning
  3111. ** control to the user.
  3112. **
  3113. ** ^(If an [INSERT] occurs within a trigger then this routine will
  3114. ** return the [rowid] of the inserted row as long as the trigger is
  3115. ** running. Once the trigger program ends, the value returned
  3116. ** by this routine reverts to what it was before the trigger was fired.)^
  3117. **
  3118. ** ^An [INSERT] that fails due to a constraint violation is not a
  3119. ** successful [INSERT] and does not change the value returned by this
  3120. ** routine. ^Thus INSERT OR FAIL, INSERT OR IGNORE, INSERT OR ROLLBACK,
  3121. ** and INSERT OR ABORT make no changes to the return value of this
  3122. ** routine when their insertion fails. ^(When INSERT OR REPLACE
  3123. ** encounters a constraint violation, it does not fail. The
  3124. ** INSERT continues to completion after deleting rows that caused
  3125. ** the constraint problem so INSERT OR REPLACE will always change
  3126. ** the return value of this interface.)^
  3127. **
  3128. ** ^For the purposes of this routine, an [INSERT] is considered to
  3129. ** be successful even if it is subsequently rolled back.
  3130. **
  3131. ** This function is accessible to SQL statements via the
  3132. ** [last_insert_rowid() SQL function].
  3133. **
  3134. ** If a separate thread performs a new [INSERT] on the same
  3135. ** database connection while the [sqlite3_last_insert_rowid()]
  3136. ** function is running and thus changes the last insert [rowid],
  3137. ** then the value returned by [sqlite3_last_insert_rowid()] is
  3138. ** unpredictable and might not equal either the old or the new
  3139. ** last insert [rowid].
  3140. */
  3141. SQLITE_API sqlite3_int64 sqlite3_last_insert_rowid(sqlite3*);
  3142. /*
  3143. ** CAPI3REF: Set the Last Insert Rowid value.
  3144. ** METHOD: sqlite3
  3145. **
  3146. ** The sqlite3_set_last_insert_rowid(D, R) method allows the application to
  3147. ** set the value returned by calling sqlite3_last_insert_rowid(D) to R
  3148. ** without inserting a row into the database.
  3149. */
  3150. SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3*,sqlite3_int64);
  3151. /*
  3152. ** CAPI3REF: Count The Number Of Rows Modified
  3153. ** METHOD: sqlite3
  3154. **
  3155. ** ^This function returns the number of rows modified, inserted or
  3156. ** deleted by the most recently completed INSERT, UPDATE or DELETE
  3157. ** statement on the database connection specified by the only parameter.
  3158. ** ^Executing any other type of SQL statement does not modify the value
  3159. ** returned by this function.
  3160. **
  3161. ** ^Only changes made directly by the INSERT, UPDATE or DELETE statement are
  3162. ** considered - auxiliary changes caused by [CREATE TRIGGER | triggers],
  3163. ** [foreign key actions] or [REPLACE] constraint resolution are not counted.
  3164. **
  3165. ** Changes to a view that are intercepted by
  3166. ** [INSTEAD OF trigger | INSTEAD OF triggers] are not counted. ^The value
  3167. ** returned by sqlite3_changes() immediately after an INSERT, UPDATE or
  3168. ** DELETE statement run on a view is always zero. Only changes made to real
  3169. ** tables are counted.
  3170. **
  3171. ** Things are more complicated if the sqlite3_changes() function is
  3172. ** executed while a trigger program is running. This may happen if the
  3173. ** program uses the [changes() SQL function], or if some other callback
  3174. ** function invokes sqlite3_changes() directly. Essentially:
  3175. **
  3176. ** <ul>
  3177. ** <li> ^(Before entering a trigger program the value returned by
  3178. ** sqlite3_changes() function is saved. After the trigger program
  3179. ** has finished, the original value is restored.)^
  3180. **
  3181. ** <li> ^(Within a trigger program each INSERT, UPDATE and DELETE
  3182. ** statement sets the value returned by sqlite3_changes()
  3183. ** upon completion as normal. Of course, this value will not include
  3184. ** any changes performed by sub-triggers, as the sqlite3_changes()
  3185. ** value will be saved and restored after each sub-trigger has run.)^
  3186. ** </ul>
  3187. **
  3188. ** ^This means that if the changes() SQL function (or similar) is used
  3189. ** by the first INSERT, UPDATE or DELETE statement within a trigger, it
  3190. ** returns the value as set when the calling statement began executing.
  3191. ** ^If it is used by the second or subsequent such statement within a trigger
  3192. ** program, the value returned reflects the number of rows modified by the
  3193. ** previous INSERT, UPDATE or DELETE statement within the same trigger.
  3194. **
  3195. ** See also the [sqlite3_total_changes()] interface, the
  3196. ** [count_changes pragma], and the [changes() SQL function].
  3197. **
  3198. ** If a separate thread makes changes on the same database connection
  3199. ** while [sqlite3_changes()] is running then the value returned
  3200. ** is unpredictable and not meaningful.
  3201. */
  3202. SQLITE_API int sqlite3_changes(sqlite3*);
  3203. /*
  3204. ** CAPI3REF: Total Number Of Rows Modified
  3205. ** METHOD: sqlite3
  3206. **
  3207. ** ^This function returns the total number of rows inserted, modified or
  3208. ** deleted by all [INSERT], [UPDATE] or [DELETE] statements completed
  3209. ** since the database connection was opened, including those executed as
  3210. ** part of trigger programs. ^Executing any other type of SQL statement
  3211. ** does not affect the value returned by sqlite3_total_changes().
  3212. **
  3213. ** ^Changes made as part of [foreign key actions] are included in the
  3214. ** count, but those made as part of REPLACE constraint resolution are
  3215. ** not. ^Changes to a view that are intercepted by INSTEAD OF triggers
  3216. ** are not counted.
  3217. **
  3218. ** See also the [sqlite3_changes()] interface, the
  3219. ** [count_changes pragma], and the [total_changes() SQL function].
  3220. **
  3221. ** If a separate thread makes changes on the same database connection
  3222. ** while [sqlite3_total_changes()] is running then the value
  3223. ** returned is unpredictable and not meaningful.
  3224. */
  3225. SQLITE_API int sqlite3_total_changes(sqlite3*);
  3226. /*
  3227. ** CAPI3REF: Interrupt A Long-Running Query
  3228. ** METHOD: sqlite3
  3229. **
  3230. ** ^This function causes any pending database operation to abort and
  3231. ** return at its earliest opportunity. This routine is typically
  3232. ** called in response to a user action such as pressing "Cancel"
  3233. ** or Ctrl-C where the user wants a long query operation to halt
  3234. ** immediately.
  3235. **
  3236. ** ^It is safe to call this routine from a thread different from the
  3237. ** thread that is currently running the database operation. But it
  3238. ** is not safe to call this routine with a [database connection] that
  3239. ** is closed or might close before sqlite3_interrupt() returns.
  3240. **
  3241. ** ^If an SQL operation is very nearly finished at the time when
  3242. ** sqlite3_interrupt() is called, then it might not have an opportunity
  3243. ** to be interrupted and might continue to completion.
  3244. **
  3245. ** ^An SQL operation that is interrupted will return [SQLITE_INTERRUPT].
  3246. ** ^If the interrupted SQL operation is an INSERT, UPDATE, or DELETE
  3247. ** that is inside an explicit transaction, then the entire transaction
  3248. ** will be rolled back automatically.
  3249. **
  3250. ** ^The sqlite3_interrupt(D) call is in effect until all currently running
  3251. ** SQL statements on [database connection] D complete. ^Any new SQL statements
  3252. ** that are started after the sqlite3_interrupt() call and before the
  3253. ** running statements reaches zero are interrupted as if they had been
  3254. ** running prior to the sqlite3_interrupt() call. ^New SQL statements
  3255. ** that are started after the running statement count reaches zero are
  3256. ** not effected by the sqlite3_interrupt().
  3257. ** ^A call to sqlite3_interrupt(D) that occurs when there are no running
  3258. ** SQL statements is a no-op and has no effect on SQL statements
  3259. ** that are started after the sqlite3_interrupt() call returns.
  3260. */
  3261. SQLITE_API void sqlite3_interrupt(sqlite3*);
  3262. /*
  3263. ** CAPI3REF: Determine If An SQL Statement Is Complete
  3264. **
  3265. ** These routines are useful during command-line input to determine if the
  3266. ** currently entered text seems to form a complete SQL statement or
  3267. ** if additional input is needed before sending the text into
  3268. ** SQLite for parsing. ^These routines return 1 if the input string
  3269. ** appears to be a complete SQL statement. ^A statement is judged to be
  3270. ** complete if it ends with a semicolon token and is not a prefix of a
  3271. ** well-formed CREATE TRIGGER statement. ^Semicolons that are embedded within
  3272. ** string literals or quoted identifier names or comments are not
  3273. ** independent tokens (they are part of the token in which they are
  3274. ** embedded) and thus do not count as a statement terminator. ^Whitespace
  3275. ** and comments that follow the final semicolon are ignored.
  3276. **
  3277. ** ^These routines return 0 if the statement is incomplete. ^If a
  3278. ** memory allocation fails, then SQLITE_NOMEM is returned.
  3279. **
  3280. ** ^These routines do not parse the SQL statements thus
  3281. ** will not detect syntactically incorrect SQL.
  3282. **
  3283. ** ^(If SQLite has not been initialized using [sqlite3_initialize()] prior
  3284. ** to invoking sqlite3_complete16() then sqlite3_initialize() is invoked
  3285. ** automatically by sqlite3_complete16(). If that initialization fails,
  3286. ** then the return value from sqlite3_complete16() will be non-zero
  3287. ** regardless of whether or not the input SQL is complete.)^
  3288. **
  3289. ** The input to [sqlite3_complete()] must be a zero-terminated
  3290. ** UTF-8 string.
  3291. **
  3292. ** The input to [sqlite3_complete16()] must be a zero-terminated
  3293. ** UTF-16 string in native byte order.
  3294. */
  3295. SQLITE_API int sqlite3_complete(const char *sql);
  3296. SQLITE_API int sqlite3_complete16(const void *sql);
  3297. /*
  3298. ** CAPI3REF: Register A Callback To Handle SQLITE_BUSY Errors
  3299. ** KEYWORDS: {busy-handler callback} {busy handler}
  3300. ** METHOD: sqlite3
  3301. **
  3302. ** ^The sqlite3_busy_handler(D,X,P) routine sets a callback function X
  3303. ** that might be invoked with argument P whenever
  3304. ** an attempt is made to access a database table associated with
  3305. ** [database connection] D when another thread
  3306. ** or process has the table locked.
  3307. ** The sqlite3_busy_handler() interface is used to implement
  3308. ** [sqlite3_busy_timeout()] and [PRAGMA busy_timeout].
  3309. **
  3310. ** ^If the busy callback is NULL, then [SQLITE_BUSY]
  3311. ** is returned immediately upon encountering the lock. ^If the busy callback
  3312. ** is not NULL, then the callback might be invoked with two arguments.
  3313. **
  3314. ** ^The first argument to the busy handler is a copy of the void* pointer which
  3315. ** is the third argument to sqlite3_busy_handler(). ^The second argument to
  3316. ** the busy handler callback is the number of times that the busy handler has
  3317. ** been invoked previously for the same locking event. ^If the
  3318. ** busy callback returns 0, then no additional attempts are made to
  3319. ** access the database and [SQLITE_BUSY] is returned
  3320. ** to the application.
  3321. ** ^If the callback returns non-zero, then another attempt
  3322. ** is made to access the database and the cycle repeats.
  3323. **
  3324. ** The presence of a busy handler does not guarantee that it will be invoked
  3325. ** when there is lock contention. ^If SQLite determines that invoking the busy
  3326. ** handler could result in a deadlock, it will go ahead and return [SQLITE_BUSY]
  3327. ** to the application instead of invoking the
  3328. ** busy handler.
  3329. ** Consider a scenario where one process is holding a read lock that
  3330. ** it is trying to promote to a reserved lock and
  3331. ** a second process is holding a reserved lock that it is trying
  3332. ** to promote to an exclusive lock. The first process cannot proceed
  3333. ** because it is blocked by the second and the second process cannot
  3334. ** proceed because it is blocked by the first. If both processes
  3335. ** invoke the busy handlers, neither will make any progress. Therefore,
  3336. ** SQLite returns [SQLITE_BUSY] for the first process, hoping that this
  3337. ** will induce the first process to release its read lock and allow
  3338. ** the second process to proceed.
  3339. **
  3340. ** ^The default busy callback is NULL.
  3341. **
  3342. ** ^(There can only be a single busy handler defined for each
  3343. ** [database connection]. Setting a new busy handler clears any
  3344. ** previously set handler.)^ ^Note that calling [sqlite3_busy_timeout()]
  3345. ** or evaluating [PRAGMA busy_timeout=N] will change the
  3346. ** busy handler and thus clear any previously set busy handler.
  3347. **
  3348. ** The busy callback should not take any actions which modify the
  3349. ** database connection that invoked the busy handler. In other words,
  3350. ** the busy handler is not reentrant. Any such actions
  3351. ** result in undefined behavior.
  3352. **
  3353. ** A busy handler must not close the database connection
  3354. ** or [prepared statement] that invoked the busy handler.
  3355. */
  3356. SQLITE_API int sqlite3_busy_handler(sqlite3*,int(*)(void*,int),void*);
  3357. /*
  3358. ** CAPI3REF: Set A Busy Timeout
  3359. ** METHOD: sqlite3
  3360. **
  3361. ** ^This routine sets a [sqlite3_busy_handler | busy handler] that sleeps
  3362. ** for a specified amount of time when a table is locked. ^The handler
  3363. ** will sleep multiple times until at least "ms" milliseconds of sleeping
  3364. ** have accumulated. ^After at least "ms" milliseconds of sleeping,
  3365. ** the handler returns 0 which causes [sqlite3_step()] to return
  3366. ** [SQLITE_BUSY].
  3367. **
  3368. ** ^Calling this routine with an argument less than or equal to zero
  3369. ** turns off all busy handlers.
  3370. **
  3371. ** ^(There can only be a single busy handler for a particular
  3372. ** [database connection] at any given moment. If another busy handler
  3373. ** was defined (using [sqlite3_busy_handler()]) prior to calling
  3374. ** this routine, that other busy handler is cleared.)^
  3375. **
  3376. ** See also: [PRAGMA busy_timeout]
  3377. */
  3378. SQLITE_API int sqlite3_busy_timeout(sqlite3*, int ms);
  3379. /*
  3380. ** CAPI3REF: Convenience Routines For Running Queries
  3381. ** METHOD: sqlite3
  3382. **
  3383. ** This is a legacy interface that is preserved for backwards compatibility.
  3384. ** Use of this interface is not recommended.
  3385. **
  3386. ** Definition: A <b>result table</b> is memory data structure created by the
  3387. ** [sqlite3_get_table()] interface. A result table records the
  3388. ** complete query results from one or more queries.
  3389. **
  3390. ** The table conceptually has a number of rows and columns. But
  3391. ** these numbers are not part of the result table itself. These
  3392. ** numbers are obtained separately. Let N be the number of rows
  3393. ** and M be the number of columns.
  3394. **
  3395. ** A result table is an array of pointers to zero-terminated UTF-8 strings.
  3396. ** There are (N+1)*M elements in the array. The first M pointers point
  3397. ** to zero-terminated strings that contain the names of the columns.
  3398. ** The remaining entries all point to query results. NULL values result
  3399. ** in NULL pointers. All other values are in their UTF-8 zero-terminated
  3400. ** string representation as returned by [sqlite3_column_text()].
  3401. **
  3402. ** A result table might consist of one or more memory allocations.
  3403. ** It is not safe to pass a result table directly to [sqlite3_free()].
  3404. ** A result table should be deallocated using [sqlite3_free_table()].
  3405. **
  3406. ** ^(As an example of the result table format, suppose a query result
  3407. ** is as follows:
  3408. **
  3409. ** <blockquote><pre>
  3410. ** Name | Age
  3411. ** -----------------------
  3412. ** Alice | 43
  3413. ** Bob | 28
  3414. ** Cindy | 21
  3415. ** </pre></blockquote>
  3416. **
  3417. ** There are two column (M==2) and three rows (N==3). Thus the
  3418. ** result table has 8 entries. Suppose the result table is stored
  3419. ** in an array names azResult. Then azResult holds this content:
  3420. **
  3421. ** <blockquote><pre>
  3422. ** azResult&#91;0] = "Name";
  3423. ** azResult&#91;1] = "Age";
  3424. ** azResult&#91;2] = "Alice";
  3425. ** azResult&#91;3] = "43";
  3426. ** azResult&#91;4] = "Bob";
  3427. ** azResult&#91;5] = "28";
  3428. ** azResult&#91;6] = "Cindy";
  3429. ** azResult&#91;7] = "21";
  3430. ** </pre></blockquote>)^
  3431. **
  3432. ** ^The sqlite3_get_table() function evaluates one or more
  3433. ** semicolon-separated SQL statements in the zero-terminated UTF-8
  3434. ** string of its 2nd parameter and returns a result table to the
  3435. ** pointer given in its 3rd parameter.
  3436. **
  3437. ** After the application has finished with the result from sqlite3_get_table(),
  3438. ** it must pass the result table pointer to sqlite3_free_table() in order to
  3439. ** release the memory that was malloced. Because of the way the
  3440. ** [sqlite3_malloc()] happens within sqlite3_get_table(), the calling
  3441. ** function must not try to call [sqlite3_free()] directly. Only
  3442. ** [sqlite3_free_table()] is able to release the memory properly and safely.
  3443. **
  3444. ** The sqlite3_get_table() interface is implemented as a wrapper around
  3445. ** [sqlite3_exec()]. The sqlite3_get_table() routine does not have access
  3446. ** to any internal data structures of SQLite. It uses only the public
  3447. ** interface defined here. As a consequence, errors that occur in the
  3448. ** wrapper layer outside of the internal [sqlite3_exec()] call are not
  3449. ** reflected in subsequent calls to [sqlite3_errcode()] or
  3450. ** [sqlite3_errmsg()].
  3451. */
  3452. SQLITE_API int sqlite3_get_table(
  3453. sqlite3 *db, /* An open database */
  3454. const char *zSql, /* SQL to be evaluated */
  3455. char ***pazResult, /* Results of the query */
  3456. int *pnRow, /* Number of result rows written here */
  3457. int *pnColumn, /* Number of result columns written here */
  3458. char **pzErrmsg /* Error msg written here */
  3459. );
  3460. SQLITE_API void sqlite3_free_table(char **result);
  3461. /*
  3462. ** CAPI3REF: Formatted String Printing Functions
  3463. **
  3464. ** These routines are work-alikes of the "printf()" family of functions
  3465. ** from the standard C library.
  3466. ** These routines understand most of the common formatting options from
  3467. ** the standard library printf()
  3468. ** plus some additional non-standard formats ([%q], [%Q], [%w], and [%z]).
  3469. ** See the [built-in printf()] documentation for details.
  3470. **
  3471. ** ^The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
  3472. ** results into memory obtained from [sqlite3_malloc64()].
  3473. ** The strings returned by these two routines should be
  3474. ** released by [sqlite3_free()]. ^Both routines return a
  3475. ** NULL pointer if [sqlite3_malloc64()] is unable to allocate enough
  3476. ** memory to hold the resulting string.
  3477. **
  3478. ** ^(The sqlite3_snprintf() routine is similar to "snprintf()" from
  3479. ** the standard C library. The result is written into the
  3480. ** buffer supplied as the second parameter whose size is given by
  3481. ** the first parameter. Note that the order of the
  3482. ** first two parameters is reversed from snprintf().)^ This is an
  3483. ** historical accident that cannot be fixed without breaking
  3484. ** backwards compatibility. ^(Note also that sqlite3_snprintf()
  3485. ** returns a pointer to its buffer instead of the number of
  3486. ** characters actually written into the buffer.)^ We admit that
  3487. ** the number of characters written would be a more useful return
  3488. ** value but we cannot change the implementation of sqlite3_snprintf()
  3489. ** now without breaking compatibility.
  3490. **
  3491. ** ^As long as the buffer size is greater than zero, sqlite3_snprintf()
  3492. ** guarantees that the buffer is always zero-terminated. ^The first
  3493. ** parameter "n" is the total size of the buffer, including space for
  3494. ** the zero terminator. So the longest string that can be completely
  3495. ** written will be n-1 characters.
  3496. **
  3497. ** ^The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().
  3498. **
  3499. ** See also: [built-in printf()], [printf() SQL function]
  3500. */
  3501. SQLITE_API char *sqlite3_mprintf(const char*,...);
  3502. SQLITE_API char *sqlite3_vmprintf(const char*, va_list);
  3503. SQLITE_API char *sqlite3_snprintf(int,char*,const char*, ...);
  3504. SQLITE_API char *sqlite3_vsnprintf(int,char*,const char*, va_list);
  3505. /*
  3506. ** CAPI3REF: Memory Allocation Subsystem
  3507. **
  3508. ** The SQLite core uses these three routines for all of its own
  3509. ** internal memory allocation needs. "Core" in the previous sentence
  3510. ** does not include operating-system specific VFS implementation. The
  3511. ** Windows VFS uses native malloc() and free() for some operations.
  3512. **
  3513. ** ^The sqlite3_malloc() routine returns a pointer to a block
  3514. ** of memory at least N bytes in length, where N is the parameter.
  3515. ** ^If sqlite3_malloc() is unable to obtain sufficient free
  3516. ** memory, it returns a NULL pointer. ^If the parameter N to
  3517. ** sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
  3518. ** a NULL pointer.
  3519. **
  3520. ** ^The sqlite3_malloc64(N) routine works just like
  3521. ** sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
  3522. ** of a signed 32-bit integer.
  3523. **
  3524. ** ^Calling sqlite3_free() with a pointer previously returned
  3525. ** by sqlite3_malloc() or sqlite3_realloc() releases that memory so
  3526. ** that it might be reused. ^The sqlite3_free() routine is
  3527. ** a no-op if is called with a NULL pointer. Passing a NULL pointer
  3528. ** to sqlite3_free() is harmless. After being freed, memory
  3529. ** should neither be read nor written. Even reading previously freed
  3530. ** memory might result in a segmentation fault or other severe error.
  3531. ** Memory corruption, a segmentation fault, or other severe error
  3532. ** might result if sqlite3_free() is called with a non-NULL pointer that
  3533. ** was not obtained from sqlite3_malloc() or sqlite3_realloc().
  3534. **
  3535. ** ^The sqlite3_realloc(X,N) interface attempts to resize a
  3536. ** prior memory allocation X to be at least N bytes.
  3537. ** ^If the X parameter to sqlite3_realloc(X,N)
  3538. ** is a NULL pointer then its behavior is identical to calling
  3539. ** sqlite3_malloc(N).
  3540. ** ^If the N parameter to sqlite3_realloc(X,N) is zero or
  3541. ** negative then the behavior is exactly the same as calling
  3542. ** sqlite3_free(X).
  3543. ** ^sqlite3_realloc(X,N) returns a pointer to a memory allocation
  3544. ** of at least N bytes in size or NULL if insufficient memory is available.
  3545. ** ^If M is the size of the prior allocation, then min(N,M) bytes
  3546. ** of the prior allocation are copied into the beginning of buffer returned
  3547. ** by sqlite3_realloc(X,N) and the prior allocation is freed.
  3548. ** ^If sqlite3_realloc(X,N) returns NULL and N is positive, then the
  3549. ** prior allocation is not freed.
  3550. **
  3551. ** ^The sqlite3_realloc64(X,N) interfaces works the same as
  3552. ** sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
  3553. ** of a 32-bit signed integer.
  3554. **
  3555. ** ^If X is a memory allocation previously obtained from sqlite3_malloc(),
  3556. ** sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
  3557. ** sqlite3_msize(X) returns the size of that memory allocation in bytes.
  3558. ** ^The value returned by sqlite3_msize(X) might be larger than the number
  3559. ** of bytes requested when X was allocated. ^If X is a NULL pointer then
  3560. ** sqlite3_msize(X) returns zero. If X points to something that is not
  3561. ** the beginning of memory allocation, or if it points to a formerly
  3562. ** valid memory allocation that has now been freed, then the behavior
  3563. ** of sqlite3_msize(X) is undefined and possibly harmful.
  3564. **
  3565. ** ^The memory returned by sqlite3_malloc(), sqlite3_realloc(),
  3566. ** sqlite3_malloc64(), and sqlite3_realloc64()
  3567. ** is always aligned to at least an 8 byte boundary, or to a
  3568. ** 4 byte boundary if the [SQLITE_4_BYTE_ALIGNED_MALLOC] compile-time
  3569. ** option is used.
  3570. **
  3571. ** In SQLite version 3.5.0 and 3.5.1, it was possible to define
  3572. ** the SQLITE_OMIT_MEMORY_ALLOCATION which would cause the built-in
  3573. ** implementation of these routines to be omitted. That capability
  3574. ** is no longer provided. Only built-in memory allocators can be used.
  3575. **
  3576. ** Prior to SQLite version 3.7.10, the Windows OS interface layer called
  3577. ** the system malloc() and free() directly when converting
  3578. ** filenames between the UTF-8 encoding used by SQLite
  3579. ** and whatever filename encoding is used by the particular Windows
  3580. ** installation. Memory allocation errors were detected, but
  3581. ** they were reported back as [SQLITE_CANTOPEN] or
  3582. ** [SQLITE_IOERR] rather than [SQLITE_NOMEM].
  3583. **
  3584. ** The pointer arguments to [sqlite3_free()] and [sqlite3_realloc()]
  3585. ** must be either NULL or else pointers obtained from a prior
  3586. ** invocation of [sqlite3_malloc()] or [sqlite3_realloc()] that have
  3587. ** not yet been released.
  3588. **
  3589. ** The application must not read or write any part of
  3590. ** a block of memory after it has been released using
  3591. ** [sqlite3_free()] or [sqlite3_realloc()].
  3592. */
  3593. SQLITE_API void *sqlite3_malloc(int);
  3594. SQLITE_API void *sqlite3_malloc64(sqlite3_uint64);
  3595. SQLITE_API void *sqlite3_realloc(void*, int);
  3596. SQLITE_API void *sqlite3_realloc64(void*, sqlite3_uint64);
  3597. SQLITE_API void sqlite3_free(void*);
  3598. SQLITE_API sqlite3_uint64 sqlite3_msize(void*);
  3599. /*
  3600. ** CAPI3REF: Memory Allocator Statistics
  3601. **
  3602. ** SQLite provides these two interfaces for reporting on the status
  3603. ** of the [sqlite3_malloc()], [sqlite3_free()], and [sqlite3_realloc()]
  3604. ** routines, which form the built-in memory allocation subsystem.
  3605. **
  3606. ** ^The [sqlite3_memory_used()] routine returns the number of bytes
  3607. ** of memory currently outstanding (malloced but not freed).
  3608. ** ^The [sqlite3_memory_highwater()] routine returns the maximum
  3609. ** value of [sqlite3_memory_used()] since the high-water mark
  3610. ** was last reset. ^The values returned by [sqlite3_memory_used()] and
  3611. ** [sqlite3_memory_highwater()] include any overhead
  3612. ** added by SQLite in its implementation of [sqlite3_malloc()],
  3613. ** but not overhead added by the any underlying system library
  3614. ** routines that [sqlite3_malloc()] may call.
  3615. **
  3616. ** ^The memory high-water mark is reset to the current value of
  3617. ** [sqlite3_memory_used()] if and only if the parameter to
  3618. ** [sqlite3_memory_highwater()] is true. ^The value returned
  3619. ** by [sqlite3_memory_highwater(1)] is the high-water mark
  3620. ** prior to the reset.
  3621. */
  3622. SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
  3623. SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
  3624. /*
  3625. ** CAPI3REF: Pseudo-Random Number Generator
  3626. **
  3627. ** SQLite contains a high-quality pseudo-random number generator (PRNG) used to
  3628. ** select random [ROWID | ROWIDs] when inserting new records into a table that
  3629. ** already uses the largest possible [ROWID]. The PRNG is also used for
  3630. ** the build-in random() and randomblob() SQL functions. This interface allows
  3631. ** applications to access the same PRNG for other purposes.
  3632. **
  3633. ** ^A call to this routine stores N bytes of randomness into buffer P.
  3634. ** ^The P parameter can be a NULL pointer.
  3635. **
  3636. ** ^If this routine has not been previously called or if the previous
  3637. ** call had N less than one or a NULL pointer for P, then the PRNG is
  3638. ** seeded using randomness obtained from the xRandomness method of
  3639. ** the default [sqlite3_vfs] object.
  3640. ** ^If the previous call to this routine had an N of 1 or more and a
  3641. ** non-NULL P then the pseudo-randomness is generated
  3642. ** internally and without recourse to the [sqlite3_vfs] xRandomness
  3643. ** method.
  3644. */
  3645. SQLITE_API void sqlite3_randomness(int N, void *P);
  3646. /*
  3647. ** CAPI3REF: Compile-Time Authorization Callbacks
  3648. ** METHOD: sqlite3
  3649. ** KEYWORDS: {authorizer callback}
  3650. **
  3651. ** ^This routine registers an authorizer callback with a particular
  3652. ** [database connection], supplied in the first argument.
  3653. ** ^The authorizer callback is invoked as SQL statements are being compiled
  3654. ** by [sqlite3_prepare()] or its variants [sqlite3_prepare_v2()],
  3655. ** [sqlite3_prepare_v3()], [sqlite3_prepare16()], [sqlite3_prepare16_v2()],
  3656. ** and [sqlite3_prepare16_v3()]. ^At various
  3657. ** points during the compilation process, as logic is being created
  3658. ** to perform various actions, the authorizer callback is invoked to
  3659. ** see if those actions are allowed. ^The authorizer callback should
  3660. ** return [SQLITE_OK] to allow the action, [SQLITE_IGNORE] to disallow the
  3661. ** specific action but allow the SQL statement to continue to be
  3662. ** compiled, or [SQLITE_DENY] to cause the entire SQL statement to be
  3663. ** rejected with an error. ^If the authorizer callback returns
  3664. ** any value other than [SQLITE_IGNORE], [SQLITE_OK], or [SQLITE_DENY]
  3665. ** then the [sqlite3_prepare_v2()] or equivalent call that triggered
  3666. ** the authorizer will fail with an error message.
  3667. **
  3668. ** When the callback returns [SQLITE_OK], that means the operation
  3669. ** requested is ok. ^When the callback returns [SQLITE_DENY], the
  3670. ** [sqlite3_prepare_v2()] or equivalent call that triggered the
  3671. ** authorizer will fail with an error message explaining that
  3672. ** access is denied.
  3673. **
  3674. ** ^The first parameter to the authorizer callback is a copy of the third
  3675. ** parameter to the sqlite3_set_authorizer() interface. ^The second parameter
  3676. ** to the callback is an integer [SQLITE_COPY | action code] that specifies
  3677. ** the particular action to be authorized. ^The third through sixth parameters
  3678. ** to the callback are either NULL pointers or zero-terminated strings
  3679. ** that contain additional details about the action to be authorized.
  3680. ** Applications must always be prepared to encounter a NULL pointer in any
  3681. ** of the third through the sixth parameters of the authorization callback.
  3682. **
  3683. ** ^If the action code is [SQLITE_READ]
  3684. ** and the callback returns [SQLITE_IGNORE] then the
  3685. ** [prepared statement] statement is constructed to substitute
  3686. ** a NULL value in place of the table column that would have
  3687. ** been read if [SQLITE_OK] had been returned. The [SQLITE_IGNORE]
  3688. ** return can be used to deny an untrusted user access to individual
  3689. ** columns of a table.
  3690. ** ^When a table is referenced by a [SELECT] but no column values are
  3691. ** extracted from that table (for example in a query like
  3692. ** "SELECT count(*) FROM tab") then the [SQLITE_READ] authorizer callback
  3693. ** is invoked once for that table with a column name that is an empty string.
  3694. ** ^If the action code is [SQLITE_DELETE] and the callback returns
  3695. ** [SQLITE_IGNORE] then the [DELETE] operation proceeds but the
  3696. ** [truncate optimization] is disabled and all rows are deleted individually.
  3697. **
  3698. ** An authorizer is used when [sqlite3_prepare | preparing]
  3699. ** SQL statements from an untrusted source, to ensure that the SQL statements
  3700. ** do not try to access data they are not allowed to see, or that they do not
  3701. ** try to execute malicious statements that damage the database. For
  3702. ** example, an application may allow a user to enter arbitrary
  3703. ** SQL queries for evaluation by a database. But the application does
  3704. ** not want the user to be able to make arbitrary changes to the
  3705. ** database. An authorizer could then be put in place while the
  3706. ** user-entered SQL is being [sqlite3_prepare | prepared] that
  3707. ** disallows everything except [SELECT] statements.
  3708. **
  3709. ** Applications that need to process SQL from untrusted sources
  3710. ** might also consider lowering resource limits using [sqlite3_limit()]
  3711. ** and limiting database size using the [max_page_count] [PRAGMA]
  3712. ** in addition to using an authorizer.
  3713. **
  3714. ** ^(Only a single authorizer can be in place on a database connection
  3715. ** at a time. Each call to sqlite3_set_authorizer overrides the
  3716. ** previous call.)^ ^Disable the authorizer by installing a NULL callback.
  3717. ** The authorizer is disabled by default.
  3718. **
  3719. ** The authorizer callback must not do anything that will modify
  3720. ** the database connection that invoked the authorizer callback.
  3721. ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
  3722. ** database connections for the meaning of "modify" in this paragraph.
  3723. **
  3724. ** ^When [sqlite3_prepare_v2()] is used to prepare a statement, the
  3725. ** statement might be re-prepared during [sqlite3_step()] due to a
  3726. ** schema change. Hence, the application should ensure that the
  3727. ** correct authorizer callback remains in place during the [sqlite3_step()].
  3728. **
  3729. ** ^Note that the authorizer callback is invoked only during
  3730. ** [sqlite3_prepare()] or its variants. Authorization is not
  3731. ** performed during statement evaluation in [sqlite3_step()], unless
  3732. ** as stated in the previous paragraph, sqlite3_step() invokes
  3733. ** sqlite3_prepare_v2() to reprepare a statement after a schema change.
  3734. */
  3735. SQLITE_API int sqlite3_set_authorizer(
  3736. sqlite3*,
  3737. int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
  3738. void *pUserData
  3739. );
  3740. /*
  3741. ** CAPI3REF: Authorizer Return Codes
  3742. **
  3743. ** The [sqlite3_set_authorizer | authorizer callback function] must
  3744. ** return either [SQLITE_OK] or one of these two constants in order
  3745. ** to signal SQLite whether or not the action is permitted. See the
  3746. ** [sqlite3_set_authorizer | authorizer documentation] for additional
  3747. ** information.
  3748. **
  3749. ** Note that SQLITE_IGNORE is also used as a [conflict resolution mode]
  3750. ** returned from the [sqlite3_vtab_on_conflict()] interface.
  3751. */
  3752. #define SQLITE_DENY 1 /* Abort the SQL statement with an error */
  3753. #define SQLITE_IGNORE 2 /* Don't allow access, but don't generate an error */
  3754. /*
  3755. ** CAPI3REF: Authorizer Action Codes
  3756. **
  3757. ** The [sqlite3_set_authorizer()] interface registers a callback function
  3758. ** that is invoked to authorize certain SQL statement actions. The
  3759. ** second parameter to the callback is an integer code that specifies
  3760. ** what action is being authorized. These are the integer action codes that
  3761. ** the authorizer callback may be passed.
  3762. **
  3763. ** These action code values signify what kind of operation is to be
  3764. ** authorized. The 3rd and 4th parameters to the authorization
  3765. ** callback function will be parameters or NULL depending on which of these
  3766. ** codes is used as the second parameter. ^(The 5th parameter to the
  3767. ** authorizer callback is the name of the database ("main", "temp",
  3768. ** etc.) if applicable.)^ ^The 6th parameter to the authorizer callback
  3769. ** is the name of the inner-most trigger or view that is responsible for
  3770. ** the access attempt or NULL if this access attempt is directly from
  3771. ** top-level SQL code.
  3772. */
  3773. /******************************************* 3rd ************ 4th ***********/
  3774. #define SQLITE_CREATE_INDEX 1 /* Index Name Table Name */
  3775. #define SQLITE_CREATE_TABLE 2 /* Table Name NULL */
  3776. #define SQLITE_CREATE_TEMP_INDEX 3 /* Index Name Table Name */
  3777. #define SQLITE_CREATE_TEMP_TABLE 4 /* Table Name NULL */
  3778. #define SQLITE_CREATE_TEMP_TRIGGER 5 /* Trigger Name Table Name */
  3779. #define SQLITE_CREATE_TEMP_VIEW 6 /* View Name NULL */
  3780. #define SQLITE_CREATE_TRIGGER 7 /* Trigger Name Table Name */
  3781. #define SQLITE_CREATE_VIEW 8 /* View Name NULL */
  3782. #define SQLITE_DELETE 9 /* Table Name NULL */
  3783. #define SQLITE_DROP_INDEX 10 /* Index Name Table Name */
  3784. #define SQLITE_DROP_TABLE 11 /* Table Name NULL */
  3785. #define SQLITE_DROP_TEMP_INDEX 12 /* Index Name Table Name */
  3786. #define SQLITE_DROP_TEMP_TABLE 13 /* Table Name NULL */
  3787. #define SQLITE_DROP_TEMP_TRIGGER 14 /* Trigger Name Table Name */
  3788. #define SQLITE_DROP_TEMP_VIEW 15 /* View Name NULL */
  3789. #define SQLITE_DROP_TRIGGER 16 /* Trigger Name Table Name */
  3790. #define SQLITE_DROP_VIEW 17 /* View Name NULL */
  3791. #define SQLITE_INSERT 18 /* Table Name NULL */
  3792. #define SQLITE_PRAGMA 19 /* Pragma Name 1st arg or NULL */
  3793. #define SQLITE_READ 20 /* Table Name Column Name */
  3794. #define SQLITE_SELECT 21 /* NULL NULL */
  3795. #define SQLITE_TRANSACTION 22 /* Operation NULL */
  3796. #define SQLITE_UPDATE 23 /* Table Name Column Name */
  3797. #define SQLITE_ATTACH 24 /* Filename NULL */
  3798. #define SQLITE_DETACH 25 /* Database Name NULL */
  3799. #define SQLITE_ALTER_TABLE 26 /* Database Name Table Name */
  3800. #define SQLITE_REINDEX 27 /* Index Name NULL */
  3801. #define SQLITE_ANALYZE 28 /* Table Name NULL */
  3802. #define SQLITE_CREATE_VTABLE 29 /* Table Name Module Name */
  3803. #define SQLITE_DROP_VTABLE 30 /* Table Name Module Name */
  3804. #define SQLITE_FUNCTION 31 /* NULL Function Name */
  3805. #define SQLITE_SAVEPOINT 32 /* Operation Savepoint Name */
  3806. #define SQLITE_COPY 0 /* No longer used */
  3807. #define SQLITE_RECURSIVE 33 /* NULL NULL */
  3808. /*
  3809. ** CAPI3REF: Tracing And Profiling Functions
  3810. ** METHOD: sqlite3
  3811. **
  3812. ** These routines are deprecated. Use the [sqlite3_trace_v2()] interface
  3813. ** instead of the routines described here.
  3814. **
  3815. ** These routines register callback functions that can be used for
  3816. ** tracing and profiling the execution of SQL statements.
  3817. **
  3818. ** ^The callback function registered by sqlite3_trace() is invoked at
  3819. ** various times when an SQL statement is being run by [sqlite3_step()].
  3820. ** ^The sqlite3_trace() callback is invoked with a UTF-8 rendering of the
  3821. ** SQL statement text as the statement first begins executing.
  3822. ** ^(Additional sqlite3_trace() callbacks might occur
  3823. ** as each triggered subprogram is entered. The callbacks for triggers
  3824. ** contain a UTF-8 SQL comment that identifies the trigger.)^
  3825. **
  3826. ** The [SQLITE_TRACE_SIZE_LIMIT] compile-time option can be used to limit
  3827. ** the length of [bound parameter] expansion in the output of sqlite3_trace().
  3828. **
  3829. ** ^The callback function registered by sqlite3_profile() is invoked
  3830. ** as each SQL statement finishes. ^The profile callback contains
  3831. ** the original statement text and an estimate of wall-clock time
  3832. ** of how long that statement took to run. ^The profile callback
  3833. ** time is in units of nanoseconds, however the current implementation
  3834. ** is only capable of millisecond resolution so the six least significant
  3835. ** digits in the time are meaningless. Future versions of SQLite
  3836. ** might provide greater resolution on the profiler callback. The
  3837. ** sqlite3_profile() function is considered experimental and is
  3838. ** subject to change in future versions of SQLite.
  3839. */
  3840. SQLITE_API SQLITE_DEPRECATED void *sqlite3_trace(sqlite3*,
  3841. void(*xTrace)(void*,const char*), void*);
  3842. SQLITE_API SQLITE_DEPRECATED void *sqlite3_profile(sqlite3*,
  3843. void(*xProfile)(void*,const char*,sqlite3_uint64), void*);
  3844. /*
  3845. ** CAPI3REF: SQL Trace Event Codes
  3846. ** KEYWORDS: SQLITE_TRACE
  3847. **
  3848. ** These constants identify classes of events that can be monitored
  3849. ** using the [sqlite3_trace_v2()] tracing logic. The M argument
  3850. ** to [sqlite3_trace_v2(D,M,X,P)] is an OR-ed combination of one or more of
  3851. ** the following constants. ^The first argument to the trace callback
  3852. ** is one of the following constants.
  3853. **
  3854. ** New tracing constants may be added in future releases.
  3855. **
  3856. ** ^A trace callback has four arguments: xCallback(T,C,P,X).
  3857. ** ^The T argument is one of the integer type codes above.
  3858. ** ^The C argument is a copy of the context pointer passed in as the
  3859. ** fourth argument to [sqlite3_trace_v2()].
  3860. ** The P and X arguments are pointers whose meanings depend on T.
  3861. **
  3862. ** <dl>
  3863. ** [[SQLITE_TRACE_STMT]] <dt>SQLITE_TRACE_STMT</dt>
  3864. ** <dd>^An SQLITE_TRACE_STMT callback is invoked when a prepared statement
  3865. ** first begins running and possibly at other times during the
  3866. ** execution of the prepared statement, such as at the start of each
  3867. ** trigger subprogram. ^The P argument is a pointer to the
  3868. ** [prepared statement]. ^The X argument is a pointer to a string which
  3869. ** is the unexpanded SQL text of the prepared statement or an SQL comment
  3870. ** that indicates the invocation of a trigger. ^The callback can compute
  3871. ** the same text that would have been returned by the legacy [sqlite3_trace()]
  3872. ** interface by using the X argument when X begins with "--" and invoking
  3873. ** [sqlite3_expanded_sql(P)] otherwise.
  3874. **
  3875. ** [[SQLITE_TRACE_PROFILE]] <dt>SQLITE_TRACE_PROFILE</dt>
  3876. ** <dd>^An SQLITE_TRACE_PROFILE callback provides approximately the same
  3877. ** information as is provided by the [sqlite3_profile()] callback.
  3878. ** ^The P argument is a pointer to the [prepared statement] and the
  3879. ** X argument points to a 64-bit integer which is the estimated of
  3880. ** the number of nanosecond that the prepared statement took to run.
  3881. ** ^The SQLITE_TRACE_PROFILE callback is invoked when the statement finishes.
  3882. **
  3883. ** [[SQLITE_TRACE_ROW]] <dt>SQLITE_TRACE_ROW</dt>
  3884. ** <dd>^An SQLITE_TRACE_ROW callback is invoked whenever a prepared
  3885. ** statement generates a single row of result.
  3886. ** ^The P argument is a pointer to the [prepared statement] and the
  3887. ** X argument is unused.
  3888. **
  3889. ** [[SQLITE_TRACE_CLOSE]] <dt>SQLITE_TRACE_CLOSE</dt>
  3890. ** <dd>^An SQLITE_TRACE_CLOSE callback is invoked when a database
  3891. ** connection closes.
  3892. ** ^The P argument is a pointer to the [database connection] object
  3893. ** and the X argument is unused.
  3894. ** </dl>
  3895. */
  3896. #define SQLITE_TRACE_STMT 0x01
  3897. #define SQLITE_TRACE_PROFILE 0x02
  3898. #define SQLITE_TRACE_ROW 0x04
  3899. #define SQLITE_TRACE_CLOSE 0x08
  3900. /*
  3901. ** CAPI3REF: SQL Trace Hook
  3902. ** METHOD: sqlite3
  3903. **
  3904. ** ^The sqlite3_trace_v2(D,M,X,P) interface registers a trace callback
  3905. ** function X against [database connection] D, using property mask M
  3906. ** and context pointer P. ^If the X callback is
  3907. ** NULL or if the M mask is zero, then tracing is disabled. The
  3908. ** M argument should be the bitwise OR-ed combination of
  3909. ** zero or more [SQLITE_TRACE] constants.
  3910. **
  3911. ** ^Each call to either sqlite3_trace() or sqlite3_trace_v2() overrides
  3912. ** (cancels) any prior calls to sqlite3_trace() or sqlite3_trace_v2().
  3913. **
  3914. ** ^The X callback is invoked whenever any of the events identified by
  3915. ** mask M occur. ^The integer return value from the callback is currently
  3916. ** ignored, though this may change in future releases. Callback
  3917. ** implementations should return zero to ensure future compatibility.
  3918. **
  3919. ** ^A trace callback is invoked with four arguments: callback(T,C,P,X).
  3920. ** ^The T argument is one of the [SQLITE_TRACE]
  3921. ** constants to indicate why the callback was invoked.
  3922. ** ^The C argument is a copy of the context pointer.
  3923. ** The P and X arguments are pointers whose meanings depend on T.
  3924. **
  3925. ** The sqlite3_trace_v2() interface is intended to replace the legacy
  3926. ** interfaces [sqlite3_trace()] and [sqlite3_profile()], both of which
  3927. ** are deprecated.
  3928. */
  3929. SQLITE_API int sqlite3_trace_v2(
  3930. sqlite3*,
  3931. unsigned uMask,
  3932. int(*xCallback)(unsigned,void*,void*,void*),
  3933. void *pCtx
  3934. );
  3935. /*
  3936. ** CAPI3REF: Query Progress Callbacks
  3937. ** METHOD: sqlite3
  3938. **
  3939. ** ^The sqlite3_progress_handler(D,N,X,P) interface causes the callback
  3940. ** function X to be invoked periodically during long running calls to
  3941. ** [sqlite3_exec()], [sqlite3_step()] and [sqlite3_get_table()] for
  3942. ** database connection D. An example use for this
  3943. ** interface is to keep a GUI updated during a large query.
  3944. **
  3945. ** ^The parameter P is passed through as the only parameter to the
  3946. ** callback function X. ^The parameter N is the approximate number of
  3947. ** [virtual machine instructions] that are evaluated between successive
  3948. ** invocations of the callback X. ^If N is less than one then the progress
  3949. ** handler is disabled.
  3950. **
  3951. ** ^Only a single progress handler may be defined at one time per
  3952. ** [database connection]; setting a new progress handler cancels the
  3953. ** old one. ^Setting parameter X to NULL disables the progress handler.
  3954. ** ^The progress handler is also disabled by setting N to a value less
  3955. ** than 1.
  3956. **
  3957. ** ^If the progress callback returns non-zero, the operation is
  3958. ** interrupted. This feature can be used to implement a
  3959. ** "Cancel" button on a GUI progress dialog box.
  3960. **
  3961. ** The progress handler callback must not do anything that will modify
  3962. ** the database connection that invoked the progress handler.
  3963. ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
  3964. ** database connections for the meaning of "modify" in this paragraph.
  3965. **
  3966. */
  3967. SQLITE_API void sqlite3_progress_handler(sqlite3*, int, int(*)(void*), void*);
  3968. /*
  3969. ** CAPI3REF: Opening A New Database Connection
  3970. ** CONSTRUCTOR: sqlite3
  3971. **
  3972. ** ^These routines open an SQLite database file as specified by the
  3973. ** filename argument. ^The filename argument is interpreted as UTF-8 for
  3974. ** sqlite3_open() and sqlite3_open_v2() and as UTF-16 in the native byte
  3975. ** order for sqlite3_open16(). ^(A [database connection] handle is usually
  3976. ** returned in *ppDb, even if an error occurs. The only exception is that
  3977. ** if SQLite is unable to allocate memory to hold the [sqlite3] object,
  3978. ** a NULL will be written into *ppDb instead of a pointer to the [sqlite3]
  3979. ** object.)^ ^(If the database is opened (and/or created) successfully, then
  3980. ** [SQLITE_OK] is returned. Otherwise an [error code] is returned.)^ ^The
  3981. ** [sqlite3_errmsg()] or [sqlite3_errmsg16()] routines can be used to obtain
  3982. ** an English language description of the error following a failure of any
  3983. ** of the sqlite3_open() routines.
  3984. **
  3985. ** ^The default encoding will be UTF-8 for databases created using
  3986. ** sqlite3_open() or sqlite3_open_v2(). ^The default encoding for databases
  3987. ** created using sqlite3_open16() will be UTF-16 in the native byte order.
  3988. **
  3989. ** Whether or not an error occurs when it is opened, resources
  3990. ** associated with the [database connection] handle should be released by
  3991. ** passing it to [sqlite3_close()] when it is no longer required.
  3992. **
  3993. ** The sqlite3_open_v2() interface works like sqlite3_open()
  3994. ** except that it accepts two additional parameters for additional control
  3995. ** over the new database connection. ^(The flags parameter to
  3996. ** sqlite3_open_v2() can take one of
  3997. ** the following three values, optionally combined with the
  3998. ** [SQLITE_OPEN_NOMUTEX], [SQLITE_OPEN_FULLMUTEX], [SQLITE_OPEN_SHAREDCACHE],
  3999. ** [SQLITE_OPEN_PRIVATECACHE], and/or [SQLITE_OPEN_URI] flags:)^
  4000. **
  4001. ** <dl>
  4002. ** ^(<dt>[SQLITE_OPEN_READONLY]</dt>
  4003. ** <dd>The database is opened in read-only mode. If the database does not
  4004. ** already exist, an error is returned.</dd>)^
  4005. **
  4006. ** ^(<dt>[SQLITE_OPEN_READWRITE]</dt>
  4007. ** <dd>The database is opened for reading and writing if possible, or reading
  4008. ** only if the file is write protected by the operating system. In either
  4009. ** case the database must already exist, otherwise an error is returned.</dd>)^
  4010. **
  4011. ** ^(<dt>[SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]</dt>
  4012. ** <dd>The database is opened for reading and writing, and is created if
  4013. ** it does not already exist. This is the behavior that is always used for
  4014. ** sqlite3_open() and sqlite3_open16().</dd>)^
  4015. ** </dl>
  4016. **
  4017. ** If the 3rd parameter to sqlite3_open_v2() is not one of the
  4018. ** combinations shown above optionally combined with other
  4019. ** [SQLITE_OPEN_READONLY | SQLITE_OPEN_* bits]
  4020. ** then the behavior is undefined.
  4021. **
  4022. ** ^If the [SQLITE_OPEN_NOMUTEX] flag is set, then the database connection
  4023. ** opens in the multi-thread [threading mode] as long as the single-thread
  4024. ** mode has not been set at compile-time or start-time. ^If the
  4025. ** [SQLITE_OPEN_FULLMUTEX] flag is set then the database connection opens
  4026. ** in the serialized [threading mode] unless single-thread was
  4027. ** previously selected at compile-time or start-time.
  4028. ** ^The [SQLITE_OPEN_SHAREDCACHE] flag causes the database connection to be
  4029. ** eligible to use [shared cache mode], regardless of whether or not shared
  4030. ** cache is enabled using [sqlite3_enable_shared_cache()]. ^The
  4031. ** [SQLITE_OPEN_PRIVATECACHE] flag causes the database connection to not
  4032. ** participate in [shared cache mode] even if it is enabled.
  4033. **
  4034. ** ^The fourth parameter to sqlite3_open_v2() is the name of the
  4035. ** [sqlite3_vfs] object that defines the operating system interface that
  4036. ** the new database connection should use. ^If the fourth parameter is
  4037. ** a NULL pointer then the default [sqlite3_vfs] object is used.
  4038. **
  4039. ** ^If the filename is ":memory:", then a private, temporary in-memory database
  4040. ** is created for the connection. ^This in-memory database will vanish when
  4041. ** the database connection is closed. Future versions of SQLite might
  4042. ** make use of additional special filenames that begin with the ":" character.
  4043. ** It is recommended that when a database filename actually does begin with
  4044. ** a ":" character you should prefix the filename with a pathname such as
  4045. ** "./" to avoid ambiguity.
  4046. **
  4047. ** ^If the filename is an empty string, then a private, temporary
  4048. ** on-disk database will be created. ^This private database will be
  4049. ** automatically deleted as soon as the database connection is closed.
  4050. **
  4051. ** [[URI filenames in sqlite3_open()]] <h3>URI Filenames</h3>
  4052. **
  4053. ** ^If [URI filename] interpretation is enabled, and the filename argument
  4054. ** begins with "file:", then the filename is interpreted as a URI. ^URI
  4055. ** filename interpretation is enabled if the [SQLITE_OPEN_URI] flag is
  4056. ** set in the third argument to sqlite3_open_v2(), or if it has
  4057. ** been enabled globally using the [SQLITE_CONFIG_URI] option with the
  4058. ** [sqlite3_config()] method or by the [SQLITE_USE_URI] compile-time option.
  4059. ** URI filename interpretation is turned off
  4060. ** by default, but future releases of SQLite might enable URI filename
  4061. ** interpretation by default. See "[URI filenames]" for additional
  4062. ** information.
  4063. **
  4064. ** URI filenames are parsed according to RFC 3986. ^If the URI contains an
  4065. ** authority, then it must be either an empty string or the string
  4066. ** "localhost". ^If the authority is not an empty string or "localhost", an
  4067. ** error is returned to the caller. ^The fragment component of a URI, if
  4068. ** present, is ignored.
  4069. **
  4070. ** ^SQLite uses the path component of the URI as the name of the disk file
  4071. ** which contains the database. ^If the path begins with a '/' character,
  4072. ** then it is interpreted as an absolute path. ^If the path does not begin
  4073. ** with a '/' (meaning that the authority section is omitted from the URI)
  4074. ** then the path is interpreted as a relative path.
  4075. ** ^(On windows, the first component of an absolute path
  4076. ** is a drive specification (e.g. "C:").)^
  4077. **
  4078. ** [[core URI query parameters]]
  4079. ** The query component of a URI may contain parameters that are interpreted
  4080. ** either by SQLite itself, or by a [VFS | custom VFS implementation].
  4081. ** SQLite and its built-in [VFSes] interpret the
  4082. ** following query parameters:
  4083. **
  4084. ** <ul>
  4085. ** <li> <b>vfs</b>: ^The "vfs" parameter may be used to specify the name of
  4086. ** a VFS object that provides the operating system interface that should
  4087. ** be used to access the database file on disk. ^If this option is set to
  4088. ** an empty string the default VFS object is used. ^Specifying an unknown
  4089. ** VFS is an error. ^If sqlite3_open_v2() is used and the vfs option is
  4090. ** present, then the VFS specified by the option takes precedence over
  4091. ** the value passed as the fourth parameter to sqlite3_open_v2().
  4092. **
  4093. ** <li> <b>mode</b>: ^(The mode parameter may be set to either "ro", "rw",
  4094. ** "rwc", or "memory". Attempting to set it to any other value is
  4095. ** an error)^.
  4096. ** ^If "ro" is specified, then the database is opened for read-only
  4097. ** access, just as if the [SQLITE_OPEN_READONLY] flag had been set in the
  4098. ** third argument to sqlite3_open_v2(). ^If the mode option is set to
  4099. ** "rw", then the database is opened for read-write (but not create)
  4100. ** access, as if SQLITE_OPEN_READWRITE (but not SQLITE_OPEN_CREATE) had
  4101. ** been set. ^Value "rwc" is equivalent to setting both
  4102. ** SQLITE_OPEN_READWRITE and SQLITE_OPEN_CREATE. ^If the mode option is
  4103. ** set to "memory" then a pure [in-memory database] that never reads
  4104. ** or writes from disk is used. ^It is an error to specify a value for
  4105. ** the mode parameter that is less restrictive than that specified by
  4106. ** the flags passed in the third parameter to sqlite3_open_v2().
  4107. **
  4108. ** <li> <b>cache</b>: ^The cache parameter may be set to either "shared" or
  4109. ** "private". ^Setting it to "shared" is equivalent to setting the
  4110. ** SQLITE_OPEN_SHAREDCACHE bit in the flags argument passed to
  4111. ** sqlite3_open_v2(). ^Setting the cache parameter to "private" is
  4112. ** equivalent to setting the SQLITE_OPEN_PRIVATECACHE bit.
  4113. ** ^If sqlite3_open_v2() is used and the "cache" parameter is present in
  4114. ** a URI filename, its value overrides any behavior requested by setting
  4115. ** SQLITE_OPEN_PRIVATECACHE or SQLITE_OPEN_SHAREDCACHE flag.
  4116. **
  4117. ** <li> <b>psow</b>: ^The psow parameter indicates whether or not the
  4118. ** [powersafe overwrite] property does or does not apply to the
  4119. ** storage media on which the database file resides.
  4120. **
  4121. ** <li> <b>nolock</b>: ^The nolock parameter is a boolean query parameter
  4122. ** which if set disables file locking in rollback journal modes. This
  4123. ** is useful for accessing a database on a filesystem that does not
  4124. ** support locking. Caution: Database corruption might result if two
  4125. ** or more processes write to the same database and any one of those
  4126. ** processes uses nolock=1.
  4127. **
  4128. ** <li> <b>immutable</b>: ^The immutable parameter is a boolean query
  4129. ** parameter that indicates that the database file is stored on
  4130. ** read-only media. ^When immutable is set, SQLite assumes that the
  4131. ** database file cannot be changed, even by a process with higher
  4132. ** privilege, and so the database is opened read-only and all locking
  4133. ** and change detection is disabled. Caution: Setting the immutable
  4134. ** property on a database file that does in fact change can result
  4135. ** in incorrect query results and/or [SQLITE_CORRUPT] errors.
  4136. ** See also: [SQLITE_IOCAP_IMMUTABLE].
  4137. **
  4138. ** </ul>
  4139. **
  4140. ** ^Specifying an unknown parameter in the query component of a URI is not an
  4141. ** error. Future versions of SQLite might understand additional query
  4142. ** parameters. See "[query parameters with special meaning to SQLite]" for
  4143. ** additional information.
  4144. **
  4145. ** [[URI filename examples]] <h3>URI filename examples</h3>
  4146. **
  4147. ** <table border="1" align=center cellpadding=5>
  4148. ** <tr><th> URI filenames <th> Results
  4149. ** <tr><td> file:data.db <td>
  4150. ** Open the file "data.db" in the current directory.
  4151. ** <tr><td> file:/home/fred/data.db<br>
  4152. ** file:///home/fred/data.db <br>
  4153. ** file://localhost/home/fred/data.db <br> <td>
  4154. ** Open the database file "/home/fred/data.db".
  4155. ** <tr><td> file://darkstar/home/fred/data.db <td>
  4156. ** An error. "darkstar" is not a recognized authority.
  4157. ** <tr><td style="white-space:nowrap">
  4158. ** file:///C:/Documents%20and%20Settings/fred/Desktop/data.db
  4159. ** <td> Windows only: Open the file "data.db" on fred's desktop on drive
  4160. ** C:. Note that the %20 escaping in this example is not strictly
  4161. ** necessary - space characters can be used literally
  4162. ** in URI filenames.
  4163. ** <tr><td> file:data.db?mode=ro&cache=private <td>
  4164. ** Open file "data.db" in the current directory for read-only access.
  4165. ** Regardless of whether or not shared-cache mode is enabled by
  4166. ** default, use a private cache.
  4167. ** <tr><td> file:/home/fred/data.db?vfs=unix-dotfile <td>
  4168. ** Open file "/home/fred/data.db". Use the special VFS "unix-dotfile"
  4169. ** that uses dot-files in place of posix advisory locking.
  4170. ** <tr><td> file:data.db?mode=readonly <td>
  4171. ** An error. "readonly" is not a valid option for the "mode" parameter.
  4172. ** </table>
  4173. **
  4174. ** ^URI hexadecimal escape sequences (%HH) are supported within the path and
  4175. ** query components of a URI. A hexadecimal escape sequence consists of a
  4176. ** percent sign - "%" - followed by exactly two hexadecimal digits
  4177. ** specifying an octet value. ^Before the path or query components of a
  4178. ** URI filename are interpreted, they are encoded using UTF-8 and all
  4179. ** hexadecimal escape sequences replaced by a single byte containing the
  4180. ** corresponding octet. If this process generates an invalid UTF-8 encoding,
  4181. ** the results are undefined.
  4182. **
  4183. ** <b>Note to Windows users:</b> The encoding used for the filename argument
  4184. ** of sqlite3_open() and sqlite3_open_v2() must be UTF-8, not whatever
  4185. ** codepage is currently defined. Filenames containing international
  4186. ** characters must be converted to UTF-8 prior to passing them into
  4187. ** sqlite3_open() or sqlite3_open_v2().
  4188. **
  4189. ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
  4190. ** prior to calling sqlite3_open() or sqlite3_open_v2(). Otherwise, various
  4191. ** features that require the use of temporary files may fail.
  4192. **
  4193. ** See also: [sqlite3_temp_directory]
  4194. */
  4195. SQLITE_API int sqlite3_open(
  4196. const char *filename, /* Database filename (UTF-8) */
  4197. sqlite3 **ppDb /* OUT: SQLite db handle */
  4198. );
  4199. SQLITE_API int sqlite3_open16(
  4200. const void *filename, /* Database filename (UTF-16) */
  4201. sqlite3 **ppDb /* OUT: SQLite db handle */
  4202. );
  4203. SQLITE_API int sqlite3_open_v2(
  4204. const char *filename, /* Database filename (UTF-8) */
  4205. sqlite3 **ppDb, /* OUT: SQLite db handle */
  4206. int flags, /* Flags */
  4207. const char *zVfs /* Name of VFS module to use */
  4208. );
  4209. /*
  4210. ** CAPI3REF: Obtain Values For URI Parameters
  4211. **
  4212. ** These are utility routines, useful to VFS implementations, that check
  4213. ** to see if a database file was a URI that contained a specific query
  4214. ** parameter, and if so obtains the value of that query parameter.
  4215. **
  4216. ** If F is the database filename pointer passed into the xOpen() method of
  4217. ** a VFS implementation when the flags parameter to xOpen() has one or
  4218. ** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
  4219. ** P is the name of the query parameter, then
  4220. ** sqlite3_uri_parameter(F,P) returns the value of the P
  4221. ** parameter if it exists or a NULL pointer if P does not appear as a
  4222. ** query parameter on F. If P is a query parameter of F
  4223. ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
  4224. ** a pointer to an empty string.
  4225. **
  4226. ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
  4227. ** parameter and returns true (1) or false (0) according to the value
  4228. ** of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
  4229. ** value of query parameter P is one of "yes", "true", or "on" in any
  4230. ** case or if the value begins with a non-zero number. The
  4231. ** sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
  4232. ** query parameter P is one of "no", "false", or "off" in any case or
  4233. ** if the value begins with a numeric zero. If P is not a query
  4234. ** parameter on F or if the value of P is does not match any of the
  4235. ** above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).
  4236. **
  4237. ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
  4238. ** 64-bit signed integer and returns that integer, or D if P does not
  4239. ** exist. If the value of P is something other than an integer, then
  4240. ** zero is returned.
  4241. **
  4242. ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
  4243. ** sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
  4244. ** is not a database file pathname pointer that SQLite passed into the xOpen
  4245. ** VFS method, then the behavior of this routine is undefined and probably
  4246. ** undesirable.
  4247. */
  4248. SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
  4249. SQLITE_API int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
  4250. SQLITE_API sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
  4251. /*
  4252. ** CAPI3REF: Error Codes And Messages
  4253. ** METHOD: sqlite3
  4254. **
  4255. ** ^If the most recent sqlite3_* API call associated with
  4256. ** [database connection] D failed, then the sqlite3_errcode(D) interface
  4257. ** returns the numeric [result code] or [extended result code] for that
  4258. ** API call.
  4259. ** If the most recent API call was successful,
  4260. ** then the return value from sqlite3_errcode() is undefined.
  4261. ** ^The sqlite3_extended_errcode()
  4262. ** interface is the same except that it always returns the
  4263. ** [extended result code] even when extended result codes are
  4264. ** disabled.
  4265. **
  4266. ** ^The sqlite3_errmsg() and sqlite3_errmsg16() return English-language
  4267. ** text that describes the error, as either UTF-8 or UTF-16 respectively.
  4268. ** ^(Memory to hold the error message string is managed internally.
  4269. ** The application does not need to worry about freeing the result.
  4270. ** However, the error string might be overwritten or deallocated by
  4271. ** subsequent calls to other SQLite interface functions.)^
  4272. **
  4273. ** ^The sqlite3_errstr() interface returns the English-language text
  4274. ** that describes the [result code], as UTF-8.
  4275. ** ^(Memory to hold the error message string is managed internally
  4276. ** and must not be freed by the application)^.
  4277. **
  4278. ** When the serialized [threading mode] is in use, it might be the
  4279. ** case that a second error occurs on a separate thread in between
  4280. ** the time of the first error and the call to these interfaces.
  4281. ** When that happens, the second error will be reported since these
  4282. ** interfaces always report the most recent result. To avoid
  4283. ** this, each thread can obtain exclusive use of the [database connection] D
  4284. ** by invoking [sqlite3_mutex_enter]([sqlite3_db_mutex](D)) before beginning
  4285. ** to use D and invoking [sqlite3_mutex_leave]([sqlite3_db_mutex](D)) after
  4286. ** all calls to the interfaces listed here are completed.
  4287. **
  4288. ** If an interface fails with SQLITE_MISUSE, that means the interface
  4289. ** was invoked incorrectly by the application. In that case, the
  4290. ** error code and message may or may not be set.
  4291. */
  4292. SQLITE_API int sqlite3_errcode(sqlite3 *db);
  4293. SQLITE_API int sqlite3_extended_errcode(sqlite3 *db);
  4294. SQLITE_API const char *sqlite3_errmsg(sqlite3*);
  4295. SQLITE_API const void *sqlite3_errmsg16(sqlite3*);
  4296. SQLITE_API const char *sqlite3_errstr(int);
  4297. /*
  4298. ** CAPI3REF: Prepared Statement Object
  4299. ** KEYWORDS: {prepared statement} {prepared statements}
  4300. **
  4301. ** An instance of this object represents a single SQL statement that
  4302. ** has been compiled into binary form and is ready to be evaluated.
  4303. **
  4304. ** Think of each SQL statement as a separate computer program. The
  4305. ** original SQL text is source code. A prepared statement object
  4306. ** is the compiled object code. All SQL must be converted into a
  4307. ** prepared statement before it can be run.
  4308. **
  4309. ** The life-cycle of a prepared statement object usually goes like this:
  4310. **
  4311. ** <ol>
  4312. ** <li> Create the prepared statement object using [sqlite3_prepare_v2()].
  4313. ** <li> Bind values to [parameters] using the sqlite3_bind_*()
  4314. ** interfaces.
  4315. ** <li> Run the SQL by calling [sqlite3_step()] one or more times.
  4316. ** <li> Reset the prepared statement using [sqlite3_reset()] then go back
  4317. ** to step 2. Do this zero or more times.
  4318. ** <li> Destroy the object using [sqlite3_finalize()].
  4319. ** </ol>
  4320. */
  4321. typedef struct sqlite3_stmt sqlite3_stmt;
  4322. /*
  4323. ** CAPI3REF: Run-time Limits
  4324. ** METHOD: sqlite3
  4325. **
  4326. ** ^(This interface allows the size of various constructs to be limited
  4327. ** on a connection by connection basis. The first parameter is the
  4328. ** [database connection] whose limit is to be set or queried. The
  4329. ** second parameter is one of the [limit categories] that define a
  4330. ** class of constructs to be size limited. The third parameter is the
  4331. ** new limit for that construct.)^
  4332. **
  4333. ** ^If the new limit is a negative number, the limit is unchanged.
  4334. ** ^(For each limit category SQLITE_LIMIT_<i>NAME</i> there is a
  4335. ** [limits | hard upper bound]
  4336. ** set at compile-time by a C preprocessor macro called
  4337. ** [limits | SQLITE_MAX_<i>NAME</i>].
  4338. ** (The "_LIMIT_" in the name is changed to "_MAX_".))^
  4339. ** ^Attempts to increase a limit above its hard upper bound are
  4340. ** silently truncated to the hard upper bound.
  4341. **
  4342. ** ^Regardless of whether or not the limit was changed, the
  4343. ** [sqlite3_limit()] interface returns the prior value of the limit.
  4344. ** ^Hence, to find the current value of a limit without changing it,
  4345. ** simply invoke this interface with the third parameter set to -1.
  4346. **
  4347. ** Run-time limits are intended for use in applications that manage
  4348. ** both their own internal database and also databases that are controlled
  4349. ** by untrusted external sources. An example application might be a
  4350. ** web browser that has its own databases for storing history and
  4351. ** separate databases controlled by JavaScript applications downloaded
  4352. ** off the Internet. The internal databases can be given the
  4353. ** large, default limits. Databases managed by external sources can
  4354. ** be given much smaller limits designed to prevent a denial of service
  4355. ** attack. Developers might also want to use the [sqlite3_set_authorizer()]
  4356. ** interface to further control untrusted SQL. The size of the database
  4357. ** created by an untrusted script can be contained using the
  4358. ** [max_page_count] [PRAGMA].
  4359. **
  4360. ** New run-time limit categories may be added in future releases.
  4361. */
  4362. SQLITE_API int sqlite3_limit(sqlite3*, int id, int newVal);
  4363. /*
  4364. ** CAPI3REF: Run-Time Limit Categories
  4365. ** KEYWORDS: {limit category} {*limit categories}
  4366. **
  4367. ** These constants define various performance limits
  4368. ** that can be lowered at run-time using [sqlite3_limit()].
  4369. ** The synopsis of the meanings of the various limits is shown below.
  4370. ** Additional information is available at [limits | Limits in SQLite].
  4371. **
  4372. ** <dl>
  4373. ** [[SQLITE_LIMIT_LENGTH]] ^(<dt>SQLITE_LIMIT_LENGTH</dt>
  4374. ** <dd>The maximum size of any string or BLOB or table row, in bytes.<dd>)^
  4375. **
  4376. ** [[SQLITE_LIMIT_SQL_LENGTH]] ^(<dt>SQLITE_LIMIT_SQL_LENGTH</dt>
  4377. ** <dd>The maximum length of an SQL statement, in bytes.</dd>)^
  4378. **
  4379. ** [[SQLITE_LIMIT_COLUMN]] ^(<dt>SQLITE_LIMIT_COLUMN</dt>
  4380. ** <dd>The maximum number of columns in a table definition or in the
  4381. ** result set of a [SELECT] or the maximum number of columns in an index
  4382. ** or in an ORDER BY or GROUP BY clause.</dd>)^
  4383. **
  4384. ** [[SQLITE_LIMIT_EXPR_DEPTH]] ^(<dt>SQLITE_LIMIT_EXPR_DEPTH</dt>
  4385. ** <dd>The maximum depth of the parse tree on any expression.</dd>)^
  4386. **
  4387. ** [[SQLITE_LIMIT_COMPOUND_SELECT]] ^(<dt>SQLITE_LIMIT_COMPOUND_SELECT</dt>
  4388. ** <dd>The maximum number of terms in a compound SELECT statement.</dd>)^
  4389. **
  4390. ** [[SQLITE_LIMIT_VDBE_OP]] ^(<dt>SQLITE_LIMIT_VDBE_OP</dt>
  4391. ** <dd>The maximum number of instructions in a virtual machine program
  4392. ** used to implement an SQL statement. If [sqlite3_prepare_v2()] or
  4393. ** the equivalent tries to allocate space for more than this many opcodes
  4394. ** in a single prepared statement, an SQLITE_NOMEM error is returned.</dd>)^
  4395. **
  4396. ** [[SQLITE_LIMIT_FUNCTION_ARG]] ^(<dt>SQLITE_LIMIT_FUNCTION_ARG</dt>
  4397. ** <dd>The maximum number of arguments on a function.</dd>)^
  4398. **
  4399. ** [[SQLITE_LIMIT_ATTACHED]] ^(<dt>SQLITE_LIMIT_ATTACHED</dt>
  4400. ** <dd>The maximum number of [ATTACH | attached databases].)^</dd>
  4401. **
  4402. ** [[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]]
  4403. ** ^(<dt>SQLITE_LIMIT_LIKE_PATTERN_LENGTH</dt>
  4404. ** <dd>The maximum length of the pattern argument to the [LIKE] or
  4405. ** [GLOB] operators.</dd>)^
  4406. **
  4407. ** [[SQLITE_LIMIT_VARIABLE_NUMBER]]
  4408. ** ^(<dt>SQLITE_LIMIT_VARIABLE_NUMBER</dt>
  4409. ** <dd>The maximum index number of any [parameter] in an SQL statement.)^
  4410. **
  4411. ** [[SQLITE_LIMIT_TRIGGER_DEPTH]] ^(<dt>SQLITE_LIMIT_TRIGGER_DEPTH</dt>
  4412. ** <dd>The maximum depth of recursion for triggers.</dd>)^
  4413. **
  4414. ** [[SQLITE_LIMIT_WORKER_THREADS]] ^(<dt>SQLITE_LIMIT_WORKER_THREADS</dt>
  4415. ** <dd>The maximum number of auxiliary worker threads that a single
  4416. ** [prepared statement] may start.</dd>)^
  4417. ** </dl>
  4418. */
  4419. #define SQLITE_LIMIT_LENGTH 0
  4420. #define SQLITE_LIMIT_SQL_LENGTH 1
  4421. #define SQLITE_LIMIT_COLUMN 2
  4422. #define SQLITE_LIMIT_EXPR_DEPTH 3
  4423. #define SQLITE_LIMIT_COMPOUND_SELECT 4
  4424. #define SQLITE_LIMIT_VDBE_OP 5
  4425. #define SQLITE_LIMIT_FUNCTION_ARG 6
  4426. #define SQLITE_LIMIT_ATTACHED 7
  4427. #define SQLITE_LIMIT_LIKE_PATTERN_LENGTH 8
  4428. #define SQLITE_LIMIT_VARIABLE_NUMBER 9
  4429. #define SQLITE_LIMIT_TRIGGER_DEPTH 10
  4430. #define SQLITE_LIMIT_WORKER_THREADS 11
  4431. /*
  4432. ** CAPI3REF: Prepare Flags
  4433. **
  4434. ** These constants define various flags that can be passed into
  4435. ** "prepFlags" parameter of the [sqlite3_prepare_v3()] and
  4436. ** [sqlite3_prepare16_v3()] interfaces.
  4437. **
  4438. ** New flags may be added in future releases of SQLite.
  4439. **
  4440. ** <dl>
  4441. ** [[SQLITE_PREPARE_PERSISTENT]] ^(<dt>SQLITE_PREPARE_PERSISTENT</dt>
  4442. ** <dd>The SQLITE_PREPARE_PERSISTENT flag is a hint to the query planner
  4443. ** that the prepared statement will be retained for a long time and
  4444. ** probably reused many times.)^ ^Without this flag, [sqlite3_prepare_v3()]
  4445. ** and [sqlite3_prepare16_v3()] assume that the prepared statement will
  4446. ** be used just once or at most a few times and then destroyed using
  4447. ** [sqlite3_finalize()] relatively soon. The current implementation acts
  4448. ** on this hint by avoiding the use of [lookaside memory] so as not to
  4449. ** deplete the limited store of lookaside memory. Future versions of
  4450. ** SQLite may act on this hint differently.
  4451. ** </dl>
  4452. */
  4453. #define SQLITE_PREPARE_PERSISTENT 0x01
  4454. /*
  4455. ** CAPI3REF: Compiling An SQL Statement
  4456. ** KEYWORDS: {SQL statement compiler}
  4457. ** METHOD: sqlite3
  4458. ** CONSTRUCTOR: sqlite3_stmt
  4459. **
  4460. ** To execute an SQL statement, it must first be compiled into a byte-code
  4461. ** program using one of these routines. Or, in other words, these routines
  4462. ** are constructors for the [prepared statement] object.
  4463. **
  4464. ** The preferred routine to use is [sqlite3_prepare_v2()]. The
  4465. ** [sqlite3_prepare()] interface is legacy and should be avoided.
  4466. ** [sqlite3_prepare_v3()] has an extra "prepFlags" option that is used
  4467. ** for special purposes.
  4468. **
  4469. ** The use of the UTF-8 interfaces is preferred, as SQLite currently
  4470. ** does all parsing using UTF-8. The UTF-16 interfaces are provided
  4471. ** as a convenience. The UTF-16 interfaces work by converting the
  4472. ** input text into UTF-8, then invoking the corresponding UTF-8 interface.
  4473. **
  4474. ** The first argument, "db", is a [database connection] obtained from a
  4475. ** prior successful call to [sqlite3_open()], [sqlite3_open_v2()] or
  4476. ** [sqlite3_open16()]. The database connection must not have been closed.
  4477. **
  4478. ** The second argument, "zSql", is the statement to be compiled, encoded
  4479. ** as either UTF-8 or UTF-16. The sqlite3_prepare(), sqlite3_prepare_v2(),
  4480. ** and sqlite3_prepare_v3()
  4481. ** interfaces use UTF-8, and sqlite3_prepare16(), sqlite3_prepare16_v2(),
  4482. ** and sqlite3_prepare16_v3() use UTF-16.
  4483. **
  4484. ** ^If the nByte argument is negative, then zSql is read up to the
  4485. ** first zero terminator. ^If nByte is positive, then it is the
  4486. ** number of bytes read from zSql. ^If nByte is zero, then no prepared
  4487. ** statement is generated.
  4488. ** If the caller knows that the supplied string is nul-terminated, then
  4489. ** there is a small performance advantage to passing an nByte parameter that
  4490. ** is the number of bytes in the input string <i>including</i>
  4491. ** the nul-terminator.
  4492. **
  4493. ** ^If pzTail is not NULL then *pzTail is made to point to the first byte
  4494. ** past the end of the first SQL statement in zSql. These routines only
  4495. ** compile the first statement in zSql, so *pzTail is left pointing to
  4496. ** what remains uncompiled.
  4497. **
  4498. ** ^*ppStmt is left pointing to a compiled [prepared statement] that can be
  4499. ** executed using [sqlite3_step()]. ^If there is an error, *ppStmt is set
  4500. ** to NULL. ^If the input text contains no SQL (if the input is an empty
  4501. ** string or a comment) then *ppStmt is set to NULL.
  4502. ** The calling procedure is responsible for deleting the compiled
  4503. ** SQL statement using [sqlite3_finalize()] after it has finished with it.
  4504. ** ppStmt may not be NULL.
  4505. **
  4506. ** ^On success, the sqlite3_prepare() family of routines return [SQLITE_OK];
  4507. ** otherwise an [error code] is returned.
  4508. **
  4509. ** The sqlite3_prepare_v2(), sqlite3_prepare_v3(), sqlite3_prepare16_v2(),
  4510. ** and sqlite3_prepare16_v3() interfaces are recommended for all new programs.
  4511. ** The older interfaces (sqlite3_prepare() and sqlite3_prepare16())
  4512. ** are retained for backwards compatibility, but their use is discouraged.
  4513. ** ^In the "vX" interfaces, the prepared statement
  4514. ** that is returned (the [sqlite3_stmt] object) contains a copy of the
  4515. ** original SQL text. This causes the [sqlite3_step()] interface to
  4516. ** behave differently in three ways:
  4517. **
  4518. ** <ol>
  4519. ** <li>
  4520. ** ^If the database schema changes, instead of returning [SQLITE_SCHEMA] as it
  4521. ** always used to do, [sqlite3_step()] will automatically recompile the SQL
  4522. ** statement and try to run it again. As many as [SQLITE_MAX_SCHEMA_RETRY]
  4523. ** retries will occur before sqlite3_step() gives up and returns an error.
  4524. ** </li>
  4525. **
  4526. ** <li>
  4527. ** ^When an error occurs, [sqlite3_step()] will return one of the detailed
  4528. ** [error codes] or [extended error codes]. ^The legacy behavior was that
  4529. ** [sqlite3_step()] would only return a generic [SQLITE_ERROR] result code
  4530. ** and the application would have to make a second call to [sqlite3_reset()]
  4531. ** in order to find the underlying cause of the problem. With the "v2" prepare
  4532. ** interfaces, the underlying reason for the error is returned immediately.
  4533. ** </li>
  4534. **
  4535. ** <li>
  4536. ** ^If the specific value bound to [parameter | host parameter] in the
  4537. ** WHERE clause might influence the choice of query plan for a statement,
  4538. ** then the statement will be automatically recompiled, as if there had been
  4539. ** a schema change, on the first [sqlite3_step()] call following any change
  4540. ** to the [sqlite3_bind_text | bindings] of that [parameter].
  4541. ** ^The specific value of WHERE-clause [parameter] might influence the
  4542. ** choice of query plan if the parameter is the left-hand side of a [LIKE]
  4543. ** or [GLOB] operator or if the parameter is compared to an indexed column
  4544. ** and the [SQLITE_ENABLE_STAT3] compile-time option is enabled.
  4545. ** </li>
  4546. ** </ol>
  4547. **
  4548. ** <p>^sqlite3_prepare_v3() differs from sqlite3_prepare_v2() only in having
  4549. ** the extra prepFlags parameter, which is a bit array consisting of zero or
  4550. ** more of the [SQLITE_PREPARE_PERSISTENT|SQLITE_PREPARE_*] flags. ^The
  4551. ** sqlite3_prepare_v2() interface works exactly the same as
  4552. ** sqlite3_prepare_v3() with a zero prepFlags parameter.
  4553. */
  4554. SQLITE_API int sqlite3_prepare(
  4555. sqlite3 *db, /* Database handle */
  4556. const char *zSql, /* SQL statement, UTF-8 encoded */
  4557. int nByte, /* Maximum length of zSql in bytes. */
  4558. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  4559. const char **pzTail /* OUT: Pointer to unused portion of zSql */
  4560. );
  4561. SQLITE_API int sqlite3_prepare_v2(
  4562. sqlite3 *db, /* Database handle */
  4563. const char *zSql, /* SQL statement, UTF-8 encoded */
  4564. int nByte, /* Maximum length of zSql in bytes. */
  4565. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  4566. const char **pzTail /* OUT: Pointer to unused portion of zSql */
  4567. );
  4568. SQLITE_API int sqlite3_prepare_v3(
  4569. sqlite3 *db, /* Database handle */
  4570. const char *zSql, /* SQL statement, UTF-8 encoded */
  4571. int nByte, /* Maximum length of zSql in bytes. */
  4572. unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
  4573. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  4574. const char **pzTail /* OUT: Pointer to unused portion of zSql */
  4575. );
  4576. SQLITE_API int sqlite3_prepare16(
  4577. sqlite3 *db, /* Database handle */
  4578. const void *zSql, /* SQL statement, UTF-16 encoded */
  4579. int nByte, /* Maximum length of zSql in bytes. */
  4580. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  4581. const void **pzTail /* OUT: Pointer to unused portion of zSql */
  4582. );
  4583. SQLITE_API int sqlite3_prepare16_v2(
  4584. sqlite3 *db, /* Database handle */
  4585. const void *zSql, /* SQL statement, UTF-16 encoded */
  4586. int nByte, /* Maximum length of zSql in bytes. */
  4587. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  4588. const void **pzTail /* OUT: Pointer to unused portion of zSql */
  4589. );
  4590. SQLITE_API int sqlite3_prepare16_v3(
  4591. sqlite3 *db, /* Database handle */
  4592. const void *zSql, /* SQL statement, UTF-16 encoded */
  4593. int nByte, /* Maximum length of zSql in bytes. */
  4594. unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_ flags */
  4595. sqlite3_stmt **ppStmt, /* OUT: Statement handle */
  4596. const void **pzTail /* OUT: Pointer to unused portion of zSql */
  4597. );
  4598. /*
  4599. ** CAPI3REF: Retrieving Statement SQL
  4600. ** METHOD: sqlite3_stmt
  4601. **
  4602. ** ^The sqlite3_sql(P) interface returns a pointer to a copy of the UTF-8
  4603. ** SQL text used to create [prepared statement] P if P was
  4604. ** created by [sqlite3_prepare_v2()], [sqlite3_prepare_v3()],
  4605. ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
  4606. ** ^The sqlite3_expanded_sql(P) interface returns a pointer to a UTF-8
  4607. ** string containing the SQL text of prepared statement P with
  4608. ** [bound parameters] expanded.
  4609. **
  4610. ** ^(For example, if a prepared statement is created using the SQL
  4611. ** text "SELECT $abc,:xyz" and if parameter $abc is bound to integer 2345
  4612. ** and parameter :xyz is unbound, then sqlite3_sql() will return
  4613. ** the original string, "SELECT $abc,:xyz" but sqlite3_expanded_sql()
  4614. ** will return "SELECT 2345,NULL".)^
  4615. **
  4616. ** ^The sqlite3_expanded_sql() interface returns NULL if insufficient memory
  4617. ** is available to hold the result, or if the result would exceed the
  4618. ** the maximum string length determined by the [SQLITE_LIMIT_LENGTH].
  4619. **
  4620. ** ^The [SQLITE_TRACE_SIZE_LIMIT] compile-time option limits the size of
  4621. ** bound parameter expansions. ^The [SQLITE_OMIT_TRACE] compile-time
  4622. ** option causes sqlite3_expanded_sql() to always return NULL.
  4623. **
  4624. ** ^The string returned by sqlite3_sql(P) is managed by SQLite and is
  4625. ** automatically freed when the prepared statement is finalized.
  4626. ** ^The string returned by sqlite3_expanded_sql(P), on the other hand,
  4627. ** is obtained from [sqlite3_malloc()] and must be free by the application
  4628. ** by passing it to [sqlite3_free()].
  4629. */
  4630. SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt);
  4631. SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt);
  4632. /*
  4633. ** CAPI3REF: Determine If An SQL Statement Writes The Database
  4634. ** METHOD: sqlite3_stmt
  4635. **
  4636. ** ^The sqlite3_stmt_readonly(X) interface returns true (non-zero) if
  4637. ** and only if the [prepared statement] X makes no direct changes to
  4638. ** the content of the database file.
  4639. **
  4640. ** Note that [application-defined SQL functions] or
  4641. ** [virtual tables] might change the database indirectly as a side effect.
  4642. ** ^(For example, if an application defines a function "eval()" that
  4643. ** calls [sqlite3_exec()], then the following SQL statement would
  4644. ** change the database file through side-effects:
  4645. **
  4646. ** <blockquote><pre>
  4647. ** SELECT eval('DELETE FROM t1') FROM t2;
  4648. ** </pre></blockquote>
  4649. **
  4650. ** But because the [SELECT] statement does not change the database file
  4651. ** directly, sqlite3_stmt_readonly() would still return true.)^
  4652. **
  4653. ** ^Transaction control statements such as [BEGIN], [COMMIT], [ROLLBACK],
  4654. ** [SAVEPOINT], and [RELEASE] cause sqlite3_stmt_readonly() to return true,
  4655. ** since the statements themselves do not actually modify the database but
  4656. ** rather they control the timing of when other statements modify the
  4657. ** database. ^The [ATTACH] and [DETACH] statements also cause
  4658. ** sqlite3_stmt_readonly() to return true since, while those statements
  4659. ** change the configuration of a database connection, they do not make
  4660. ** changes to the content of the database files on disk.
  4661. ** ^The sqlite3_stmt_readonly() interface returns true for [BEGIN] since
  4662. ** [BEGIN] merely sets internal flags, but the [BEGIN|BEGIN IMMEDIATE] and
  4663. ** [BEGIN|BEGIN EXCLUSIVE] commands do touch the database and so
  4664. ** sqlite3_stmt_readonly() returns false for those commands.
  4665. */
  4666. SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt);
  4667. /*
  4668. ** CAPI3REF: Determine If A Prepared Statement Has Been Reset
  4669. ** METHOD: sqlite3_stmt
  4670. **
  4671. ** ^The sqlite3_stmt_busy(S) interface returns true (non-zero) if the
  4672. ** [prepared statement] S has been stepped at least once using
  4673. ** [sqlite3_step(S)] but has neither run to completion (returned
  4674. ** [SQLITE_DONE] from [sqlite3_step(S)]) nor
  4675. ** been reset using [sqlite3_reset(S)]. ^The sqlite3_stmt_busy(S)
  4676. ** interface returns false if S is a NULL pointer. If S is not a
  4677. ** NULL pointer and is not a pointer to a valid [prepared statement]
  4678. ** object, then the behavior is undefined and probably undesirable.
  4679. **
  4680. ** This interface can be used in combination [sqlite3_next_stmt()]
  4681. ** to locate all prepared statements associated with a database
  4682. ** connection that are in need of being reset. This can be used,
  4683. ** for example, in diagnostic routines to search for prepared
  4684. ** statements that are holding a transaction open.
  4685. */
  4686. SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt*);
  4687. /*
  4688. ** CAPI3REF: Dynamically Typed Value Object
  4689. ** KEYWORDS: {protected sqlite3_value} {unprotected sqlite3_value}
  4690. **
  4691. ** SQLite uses the sqlite3_value object to represent all values
  4692. ** that can be stored in a database table. SQLite uses dynamic typing
  4693. ** for the values it stores. ^Values stored in sqlite3_value objects
  4694. ** can be integers, floating point values, strings, BLOBs, or NULL.
  4695. **
  4696. ** An sqlite3_value object may be either "protected" or "unprotected".
  4697. ** Some interfaces require a protected sqlite3_value. Other interfaces
  4698. ** will accept either a protected or an unprotected sqlite3_value.
  4699. ** Every interface that accepts sqlite3_value arguments specifies
  4700. ** whether or not it requires a protected sqlite3_value. The
  4701. ** [sqlite3_value_dup()] interface can be used to construct a new
  4702. ** protected sqlite3_value from an unprotected sqlite3_value.
  4703. **
  4704. ** The terms "protected" and "unprotected" refer to whether or not
  4705. ** a mutex is held. An internal mutex is held for a protected
  4706. ** sqlite3_value object but no mutex is held for an unprotected
  4707. ** sqlite3_value object. If SQLite is compiled to be single-threaded
  4708. ** (with [SQLITE_THREADSAFE=0] and with [sqlite3_threadsafe()] returning 0)
  4709. ** or if SQLite is run in one of reduced mutex modes
  4710. ** [SQLITE_CONFIG_SINGLETHREAD] or [SQLITE_CONFIG_MULTITHREAD]
  4711. ** then there is no distinction between protected and unprotected
  4712. ** sqlite3_value objects and they can be used interchangeably. However,
  4713. ** for maximum code portability it is recommended that applications
  4714. ** still make the distinction between protected and unprotected
  4715. ** sqlite3_value objects even when not strictly required.
  4716. **
  4717. ** ^The sqlite3_value objects that are passed as parameters into the
  4718. ** implementation of [application-defined SQL functions] are protected.
  4719. ** ^The sqlite3_value object returned by
  4720. ** [sqlite3_column_value()] is unprotected.
  4721. ** Unprotected sqlite3_value objects may only be used as arguments
  4722. ** to [sqlite3_result_value()], [sqlite3_bind_value()], and
  4723. ** [sqlite3_value_dup()].
  4724. ** The [sqlite3_value_blob | sqlite3_value_type()] family of
  4725. ** interfaces require protected sqlite3_value objects.
  4726. */
  4727. typedef struct sqlite3_value sqlite3_value;
  4728. /*
  4729. ** CAPI3REF: SQL Function Context Object
  4730. **
  4731. ** The context in which an SQL function executes is stored in an
  4732. ** sqlite3_context object. ^A pointer to an sqlite3_context object
  4733. ** is always first parameter to [application-defined SQL functions].
  4734. ** The application-defined SQL function implementation will pass this
  4735. ** pointer through into calls to [sqlite3_result_int | sqlite3_result()],
  4736. ** [sqlite3_aggregate_context()], [sqlite3_user_data()],
  4737. ** [sqlite3_context_db_handle()], [sqlite3_get_auxdata()],
  4738. ** and/or [sqlite3_set_auxdata()].
  4739. */
  4740. typedef struct sqlite3_context sqlite3_context;
  4741. /*
  4742. ** CAPI3REF: Binding Values To Prepared Statements
  4743. ** KEYWORDS: {host parameter} {host parameters} {host parameter name}
  4744. ** KEYWORDS: {SQL parameter} {SQL parameters} {parameter binding}
  4745. ** METHOD: sqlite3_stmt
  4746. **
  4747. ** ^(In the SQL statement text input to [sqlite3_prepare_v2()] and its variants,
  4748. ** literals may be replaced by a [parameter] that matches one of following
  4749. ** templates:
  4750. **
  4751. ** <ul>
  4752. ** <li> ?
  4753. ** <li> ?NNN
  4754. ** <li> :VVV
  4755. ** <li> @VVV
  4756. ** <li> $VVV
  4757. ** </ul>
  4758. **
  4759. ** In the templates above, NNN represents an integer literal,
  4760. ** and VVV represents an alphanumeric identifier.)^ ^The values of these
  4761. ** parameters (also called "host parameter names" or "SQL parameters")
  4762. ** can be set using the sqlite3_bind_*() routines defined here.
  4763. **
  4764. ** ^The first argument to the sqlite3_bind_*() routines is always
  4765. ** a pointer to the [sqlite3_stmt] object returned from
  4766. ** [sqlite3_prepare_v2()] or its variants.
  4767. **
  4768. ** ^The second argument is the index of the SQL parameter to be set.
  4769. ** ^The leftmost SQL parameter has an index of 1. ^When the same named
  4770. ** SQL parameter is used more than once, second and subsequent
  4771. ** occurrences have the same index as the first occurrence.
  4772. ** ^The index for named parameters can be looked up using the
  4773. ** [sqlite3_bind_parameter_index()] API if desired. ^The index
  4774. ** for "?NNN" parameters is the value of NNN.
  4775. ** ^The NNN value must be between 1 and the [sqlite3_limit()]
  4776. ** parameter [SQLITE_LIMIT_VARIABLE_NUMBER] (default value: 999).
  4777. **
  4778. ** ^The third argument is the value to bind to the parameter.
  4779. ** ^If the third parameter to sqlite3_bind_text() or sqlite3_bind_text16()
  4780. ** or sqlite3_bind_blob() is a NULL pointer then the fourth parameter
  4781. ** is ignored and the end result is the same as sqlite3_bind_null().
  4782. **
  4783. ** ^(In those routines that have a fourth argument, its value is the
  4784. ** number of bytes in the parameter. To be clear: the value is the
  4785. ** number of <u>bytes</u> in the value, not the number of characters.)^
  4786. ** ^If the fourth parameter to sqlite3_bind_text() or sqlite3_bind_text16()
  4787. ** is negative, then the length of the string is
  4788. ** the number of bytes up to the first zero terminator.
  4789. ** If the fourth parameter to sqlite3_bind_blob() is negative, then
  4790. ** the behavior is undefined.
  4791. ** If a non-negative fourth parameter is provided to sqlite3_bind_text()
  4792. ** or sqlite3_bind_text16() or sqlite3_bind_text64() then
  4793. ** that parameter must be the byte offset
  4794. ** where the NUL terminator would occur assuming the string were NUL
  4795. ** terminated. If any NUL characters occur at byte offsets less than
  4796. ** the value of the fourth parameter then the resulting string value will
  4797. ** contain embedded NULs. The result of expressions involving strings
  4798. ** with embedded NULs is undefined.
  4799. **
  4800. ** ^The fifth argument to the BLOB and string binding interfaces
  4801. ** is a destructor used to dispose of the BLOB or
  4802. ** string after SQLite has finished with it. ^The destructor is called
  4803. ** to dispose of the BLOB or string even if the call to bind API fails.
  4804. ** ^If the fifth argument is
  4805. ** the special value [SQLITE_STATIC], then SQLite assumes that the
  4806. ** information is in static, unmanaged space and does not need to be freed.
  4807. ** ^If the fifth argument has the value [SQLITE_TRANSIENT], then
  4808. ** SQLite makes its own private copy of the data immediately, before
  4809. ** the sqlite3_bind_*() routine returns.
  4810. **
  4811. ** ^The sixth argument to sqlite3_bind_text64() must be one of
  4812. ** [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE]
  4813. ** to specify the encoding of the text in the third parameter. If
  4814. ** the sixth argument to sqlite3_bind_text64() is not one of the
  4815. ** allowed values shown above, or if the text encoding is different
  4816. ** from the encoding specified by the sixth parameter, then the behavior
  4817. ** is undefined.
  4818. **
  4819. ** ^The sqlite3_bind_zeroblob() routine binds a BLOB of length N that
  4820. ** is filled with zeroes. ^A zeroblob uses a fixed amount of memory
  4821. ** (just an integer to hold its size) while it is being processed.
  4822. ** Zeroblobs are intended to serve as placeholders for BLOBs whose
  4823. ** content is later written using
  4824. ** [sqlite3_blob_open | incremental BLOB I/O] routines.
  4825. ** ^A negative value for the zeroblob results in a zero-length BLOB.
  4826. **
  4827. ** ^The sqlite3_bind_pointer(S,I,P,T,D) routine causes the I-th parameter in
  4828. ** [prepared statement] S to have an SQL value of NULL, but to also be
  4829. ** associated with the pointer P of type T. ^D is either a NULL pointer or
  4830. ** a pointer to a destructor function for P. ^SQLite will invoke the
  4831. ** destructor D with a single argument of P when it is finished using
  4832. ** P. The T parameter should be a static string, preferably a string
  4833. ** literal. The sqlite3_bind_pointer() routine is part of the
  4834. ** [pointer passing interface] added for SQLite 3.20.0.
  4835. **
  4836. ** ^If any of the sqlite3_bind_*() routines are called with a NULL pointer
  4837. ** for the [prepared statement] or with a prepared statement for which
  4838. ** [sqlite3_step()] has been called more recently than [sqlite3_reset()],
  4839. ** then the call will return [SQLITE_MISUSE]. If any sqlite3_bind_()
  4840. ** routine is passed a [prepared statement] that has been finalized, the
  4841. ** result is undefined and probably harmful.
  4842. **
  4843. ** ^Bindings are not cleared by the [sqlite3_reset()] routine.
  4844. ** ^Unbound parameters are interpreted as NULL.
  4845. **
  4846. ** ^The sqlite3_bind_* routines return [SQLITE_OK] on success or an
  4847. ** [error code] if anything goes wrong.
  4848. ** ^[SQLITE_TOOBIG] might be returned if the size of a string or BLOB
  4849. ** exceeds limits imposed by [sqlite3_limit]([SQLITE_LIMIT_LENGTH]) or
  4850. ** [SQLITE_MAX_LENGTH].
  4851. ** ^[SQLITE_RANGE] is returned if the parameter
  4852. ** index is out of range. ^[SQLITE_NOMEM] is returned if malloc() fails.
  4853. **
  4854. ** See also: [sqlite3_bind_parameter_count()],
  4855. ** [sqlite3_bind_parameter_name()], and [sqlite3_bind_parameter_index()].
  4856. */
  4857. SQLITE_API int sqlite3_bind_blob(sqlite3_stmt*, int, const void*, int n, void(*)(void*));
  4858. SQLITE_API int sqlite3_bind_blob64(sqlite3_stmt*, int, const void*, sqlite3_uint64,
  4859. void(*)(void*));
  4860. SQLITE_API int sqlite3_bind_double(sqlite3_stmt*, int, double);
  4861. SQLITE_API int sqlite3_bind_int(sqlite3_stmt*, int, int);
  4862. SQLITE_API int sqlite3_bind_int64(sqlite3_stmt*, int, sqlite3_int64);
  4863. SQLITE_API int sqlite3_bind_null(sqlite3_stmt*, int);
  4864. SQLITE_API int sqlite3_bind_text(sqlite3_stmt*,int,const char*,int,void(*)(void*));
  4865. SQLITE_API int sqlite3_bind_text16(sqlite3_stmt*, int, const void*, int, void(*)(void*));
  4866. SQLITE_API int sqlite3_bind_text64(sqlite3_stmt*, int, const char*, sqlite3_uint64,
  4867. void(*)(void*), unsigned char encoding);
  4868. SQLITE_API int sqlite3_bind_value(sqlite3_stmt*, int, const sqlite3_value*);
  4869. SQLITE_API int sqlite3_bind_pointer(sqlite3_stmt*, int, void*, const char*,void(*)(void*));
  4870. SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt*, int, int n);
  4871. SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt*, int, sqlite3_uint64);
  4872. /*
  4873. ** CAPI3REF: Number Of SQL Parameters
  4874. ** METHOD: sqlite3_stmt
  4875. **
  4876. ** ^This routine can be used to find the number of [SQL parameters]
  4877. ** in a [prepared statement]. SQL parameters are tokens of the
  4878. ** form "?", "?NNN", ":AAA", "$AAA", or "@AAA" that serve as
  4879. ** placeholders for values that are [sqlite3_bind_blob | bound]
  4880. ** to the parameters at a later time.
  4881. **
  4882. ** ^(This routine actually returns the index of the largest (rightmost)
  4883. ** parameter. For all forms except ?NNN, this will correspond to the
  4884. ** number of unique parameters. If parameters of the ?NNN form are used,
  4885. ** there may be gaps in the list.)^
  4886. **
  4887. ** See also: [sqlite3_bind_blob|sqlite3_bind()],
  4888. ** [sqlite3_bind_parameter_name()], and
  4889. ** [sqlite3_bind_parameter_index()].
  4890. */
  4891. SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt*);
  4892. /*
  4893. ** CAPI3REF: Name Of A Host Parameter
  4894. ** METHOD: sqlite3_stmt
  4895. **
  4896. ** ^The sqlite3_bind_parameter_name(P,N) interface returns
  4897. ** the name of the N-th [SQL parameter] in the [prepared statement] P.
  4898. ** ^(SQL parameters of the form "?NNN" or ":AAA" or "@AAA" or "$AAA"
  4899. ** have a name which is the string "?NNN" or ":AAA" or "@AAA" or "$AAA"
  4900. ** respectively.
  4901. ** In other words, the initial ":" or "$" or "@" or "?"
  4902. ** is included as part of the name.)^
  4903. ** ^Parameters of the form "?" without a following integer have no name
  4904. ** and are referred to as "nameless" or "anonymous parameters".
  4905. **
  4906. ** ^The first host parameter has an index of 1, not 0.
  4907. **
  4908. ** ^If the value N is out of range or if the N-th parameter is
  4909. ** nameless, then NULL is returned. ^The returned string is
  4910. ** always in UTF-8 encoding even if the named parameter was
  4911. ** originally specified as UTF-16 in [sqlite3_prepare16()],
  4912. ** [sqlite3_prepare16_v2()], or [sqlite3_prepare16_v3()].
  4913. **
  4914. ** See also: [sqlite3_bind_blob|sqlite3_bind()],
  4915. ** [sqlite3_bind_parameter_count()], and
  4916. ** [sqlite3_bind_parameter_index()].
  4917. */
  4918. SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt*, int);
  4919. /*
  4920. ** CAPI3REF: Index Of A Parameter With A Given Name
  4921. ** METHOD: sqlite3_stmt
  4922. **
  4923. ** ^Return the index of an SQL parameter given its name. ^The
  4924. ** index value returned is suitable for use as the second
  4925. ** parameter to [sqlite3_bind_blob|sqlite3_bind()]. ^A zero
  4926. ** is returned if no matching parameter is found. ^The parameter
  4927. ** name must be given in UTF-8 even if the original statement
  4928. ** was prepared from UTF-16 text using [sqlite3_prepare16_v2()] or
  4929. ** [sqlite3_prepare16_v3()].
  4930. **
  4931. ** See also: [sqlite3_bind_blob|sqlite3_bind()],
  4932. ** [sqlite3_bind_parameter_count()], and
  4933. ** [sqlite3_bind_parameter_name()].
  4934. */
  4935. SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt*, const char *zName);
  4936. /*
  4937. ** CAPI3REF: Reset All Bindings On A Prepared Statement
  4938. ** METHOD: sqlite3_stmt
  4939. **
  4940. ** ^Contrary to the intuition of many, [sqlite3_reset()] does not reset
  4941. ** the [sqlite3_bind_blob | bindings] on a [prepared statement].
  4942. ** ^Use this routine to reset all host parameters to NULL.
  4943. */
  4944. SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt*);
  4945. /*
  4946. ** CAPI3REF: Number Of Columns In A Result Set
  4947. ** METHOD: sqlite3_stmt
  4948. **
  4949. ** ^Return the number of columns in the result set returned by the
  4950. ** [prepared statement]. ^If this routine returns 0, that means the
  4951. ** [prepared statement] returns no data (for example an [UPDATE]).
  4952. ** ^However, just because this routine returns a positive number does not
  4953. ** mean that one or more rows of data will be returned. ^A SELECT statement
  4954. ** will always have a positive sqlite3_column_count() but depending on the
  4955. ** WHERE clause constraints and the table content, it might return no rows.
  4956. **
  4957. ** See also: [sqlite3_data_count()]
  4958. */
  4959. SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt);
  4960. /*
  4961. ** CAPI3REF: Column Names In A Result Set
  4962. ** METHOD: sqlite3_stmt
  4963. **
  4964. ** ^These routines return the name assigned to a particular column
  4965. ** in the result set of a [SELECT] statement. ^The sqlite3_column_name()
  4966. ** interface returns a pointer to a zero-terminated UTF-8 string
  4967. ** and sqlite3_column_name16() returns a pointer to a zero-terminated
  4968. ** UTF-16 string. ^The first parameter is the [prepared statement]
  4969. ** that implements the [SELECT] statement. ^The second parameter is the
  4970. ** column number. ^The leftmost column is number 0.
  4971. **
  4972. ** ^The returned string pointer is valid until either the [prepared statement]
  4973. ** is destroyed by [sqlite3_finalize()] or until the statement is automatically
  4974. ** reprepared by the first call to [sqlite3_step()] for a particular run
  4975. ** or until the next call to
  4976. ** sqlite3_column_name() or sqlite3_column_name16() on the same column.
  4977. **
  4978. ** ^If sqlite3_malloc() fails during the processing of either routine
  4979. ** (for example during a conversion from UTF-8 to UTF-16) then a
  4980. ** NULL pointer is returned.
  4981. **
  4982. ** ^The name of a result column is the value of the "AS" clause for
  4983. ** that column, if there is an AS clause. If there is no AS clause
  4984. ** then the name of the column is unspecified and may change from
  4985. ** one release of SQLite to the next.
  4986. */
  4987. SQLITE_API const char *sqlite3_column_name(sqlite3_stmt*, int N);
  4988. SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt*, int N);
  4989. /*
  4990. ** CAPI3REF: Source Of Data In A Query Result
  4991. ** METHOD: sqlite3_stmt
  4992. **
  4993. ** ^These routines provide a means to determine the database, table, and
  4994. ** table column that is the origin of a particular result column in
  4995. ** [SELECT] statement.
  4996. ** ^The name of the database or table or column can be returned as
  4997. ** either a UTF-8 or UTF-16 string. ^The _database_ routines return
  4998. ** the database name, the _table_ routines return the table name, and
  4999. ** the origin_ routines return the column name.
  5000. ** ^The returned string is valid until the [prepared statement] is destroyed
  5001. ** using [sqlite3_finalize()] or until the statement is automatically
  5002. ** reprepared by the first call to [sqlite3_step()] for a particular run
  5003. ** or until the same information is requested
  5004. ** again in a different encoding.
  5005. **
  5006. ** ^The names returned are the original un-aliased names of the
  5007. ** database, table, and column.
  5008. **
  5009. ** ^The first argument to these interfaces is a [prepared statement].
  5010. ** ^These functions return information about the Nth result column returned by
  5011. ** the statement, where N is the second function argument.
  5012. ** ^The left-most column is column 0 for these routines.
  5013. **
  5014. ** ^If the Nth column returned by the statement is an expression or
  5015. ** subquery and is not a column value, then all of these functions return
  5016. ** NULL. ^These routine might also return NULL if a memory allocation error
  5017. ** occurs. ^Otherwise, they return the name of the attached database, table,
  5018. ** or column that query result column was extracted from.
  5019. **
  5020. ** ^As with all other SQLite APIs, those whose names end with "16" return
  5021. ** UTF-16 encoded strings and the other functions return UTF-8.
  5022. **
  5023. ** ^These APIs are only available if the library was compiled with the
  5024. ** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol.
  5025. **
  5026. ** If two or more threads call one or more of these routines against the same
  5027. ** prepared statement and column at the same time then the results are
  5028. ** undefined.
  5029. **
  5030. ** If two or more threads call one or more
  5031. ** [sqlite3_column_database_name | column metadata interfaces]
  5032. ** for the same [prepared statement] and result column
  5033. ** at the same time then the results are undefined.
  5034. */
  5035. SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt*,int);
  5036. SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt*,int);
  5037. SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt*,int);
  5038. SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt*,int);
  5039. SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt*,int);
  5040. SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt*,int);
  5041. /*
  5042. ** CAPI3REF: Declared Datatype Of A Query Result
  5043. ** METHOD: sqlite3_stmt
  5044. **
  5045. ** ^(The first parameter is a [prepared statement].
  5046. ** If this statement is a [SELECT] statement and the Nth column of the
  5047. ** returned result set of that [SELECT] is a table column (not an
  5048. ** expression or subquery) then the declared type of the table
  5049. ** column is returned.)^ ^If the Nth column of the result set is an
  5050. ** expression or subquery, then a NULL pointer is returned.
  5051. ** ^The returned string is always UTF-8 encoded.
  5052. **
  5053. ** ^(For example, given the database schema:
  5054. **
  5055. ** CREATE TABLE t1(c1 VARIANT);
  5056. **
  5057. ** and the following statement to be compiled:
  5058. **
  5059. ** SELECT c1 + 1, c1 FROM t1;
  5060. **
  5061. ** this routine would return the string "VARIANT" for the second result
  5062. ** column (i==1), and a NULL pointer for the first result column (i==0).)^
  5063. **
  5064. ** ^SQLite uses dynamic run-time typing. ^So just because a column
  5065. ** is declared to contain a particular type does not mean that the
  5066. ** data stored in that column is of the declared type. SQLite is
  5067. ** strongly typed, but the typing is dynamic not static. ^Type
  5068. ** is associated with individual values, not with the containers
  5069. ** used to hold those values.
  5070. */
  5071. SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt*,int);
  5072. SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt*,int);
  5073. /*
  5074. ** CAPI3REF: Evaluate An SQL Statement
  5075. ** METHOD: sqlite3_stmt
  5076. **
  5077. ** After a [prepared statement] has been prepared using any of
  5078. ** [sqlite3_prepare_v2()], [sqlite3_prepare_v3()], [sqlite3_prepare16_v2()],
  5079. ** or [sqlite3_prepare16_v3()] or one of the legacy
  5080. ** interfaces [sqlite3_prepare()] or [sqlite3_prepare16()], this function
  5081. ** must be called one or more times to evaluate the statement.
  5082. **
  5083. ** The details of the behavior of the sqlite3_step() interface depend
  5084. ** on whether the statement was prepared using the newer "vX" interfaces
  5085. ** [sqlite3_prepare_v3()], [sqlite3_prepare_v2()], [sqlite3_prepare16_v3()],
  5086. ** [sqlite3_prepare16_v2()] or the older legacy
  5087. ** interfaces [sqlite3_prepare()] and [sqlite3_prepare16()]. The use of the
  5088. ** new "vX" interface is recommended for new applications but the legacy
  5089. ** interface will continue to be supported.
  5090. **
  5091. ** ^In the legacy interface, the return value will be either [SQLITE_BUSY],
  5092. ** [SQLITE_DONE], [SQLITE_ROW], [SQLITE_ERROR], or [SQLITE_MISUSE].
  5093. ** ^With the "v2" interface, any of the other [result codes] or
  5094. ** [extended result codes] might be returned as well.
  5095. **
  5096. ** ^[SQLITE_BUSY] means that the database engine was unable to acquire the
  5097. ** database locks it needs to do its job. ^If the statement is a [COMMIT]
  5098. ** or occurs outside of an explicit transaction, then you can retry the
  5099. ** statement. If the statement is not a [COMMIT] and occurs within an
  5100. ** explicit transaction then you should rollback the transaction before
  5101. ** continuing.
  5102. **
  5103. ** ^[SQLITE_DONE] means that the statement has finished executing
  5104. ** successfully. sqlite3_step() should not be called again on this virtual
  5105. ** machine without first calling [sqlite3_reset()] to reset the virtual
  5106. ** machine back to its initial state.
  5107. **
  5108. ** ^If the SQL statement being executed returns any data, then [SQLITE_ROW]
  5109. ** is returned each time a new row of data is ready for processing by the
  5110. ** caller. The values may be accessed using the [column access functions].
  5111. ** sqlite3_step() is called again to retrieve the next row of data.
  5112. **
  5113. ** ^[SQLITE_ERROR] means that a run-time error (such as a constraint
  5114. ** violation) has occurred. sqlite3_step() should not be called again on
  5115. ** the VM. More information may be found by calling [sqlite3_errmsg()].
  5116. ** ^With the legacy interface, a more specific error code (for example,
  5117. ** [SQLITE_INTERRUPT], [SQLITE_SCHEMA], [SQLITE_CORRUPT], and so forth)
  5118. ** can be obtained by calling [sqlite3_reset()] on the
  5119. ** [prepared statement]. ^In the "v2" interface,
  5120. ** the more specific error code is returned directly by sqlite3_step().
  5121. **
  5122. ** [SQLITE_MISUSE] means that the this routine was called inappropriately.
  5123. ** Perhaps it was called on a [prepared statement] that has
  5124. ** already been [sqlite3_finalize | finalized] or on one that had
  5125. ** previously returned [SQLITE_ERROR] or [SQLITE_DONE]. Or it could
  5126. ** be the case that the same database connection is being used by two or
  5127. ** more threads at the same moment in time.
  5128. **
  5129. ** For all versions of SQLite up to and including 3.6.23.1, a call to
  5130. ** [sqlite3_reset()] was required after sqlite3_step() returned anything
  5131. ** other than [SQLITE_ROW] before any subsequent invocation of
  5132. ** sqlite3_step(). Failure to reset the prepared statement using
  5133. ** [sqlite3_reset()] would result in an [SQLITE_MISUSE] return from
  5134. ** sqlite3_step(). But after [version 3.6.23.1] ([dateof:3.6.23.1],
  5135. ** sqlite3_step() began
  5136. ** calling [sqlite3_reset()] automatically in this circumstance rather
  5137. ** than returning [SQLITE_MISUSE]. This is not considered a compatibility
  5138. ** break because any application that ever receives an SQLITE_MISUSE error
  5139. ** is broken by definition. The [SQLITE_OMIT_AUTORESET] compile-time option
  5140. ** can be used to restore the legacy behavior.
  5141. **
  5142. ** <b>Goofy Interface Alert:</b> In the legacy interface, the sqlite3_step()
  5143. ** API always returns a generic error code, [SQLITE_ERROR], following any
  5144. ** error other than [SQLITE_BUSY] and [SQLITE_MISUSE]. You must call
  5145. ** [sqlite3_reset()] or [sqlite3_finalize()] in order to find one of the
  5146. ** specific [error codes] that better describes the error.
  5147. ** We admit that this is a goofy design. The problem has been fixed
  5148. ** with the "v2" interface. If you prepare all of your SQL statements
  5149. ** using [sqlite3_prepare_v3()] or [sqlite3_prepare_v2()]
  5150. ** or [sqlite3_prepare16_v2()] or [sqlite3_prepare16_v3()] instead
  5151. ** of the legacy [sqlite3_prepare()] and [sqlite3_prepare16()] interfaces,
  5152. ** then the more specific [error codes] are returned directly
  5153. ** by sqlite3_step(). The use of the "vX" interfaces is recommended.
  5154. */
  5155. SQLITE_API int sqlite3_step(sqlite3_stmt*);
  5156. /*
  5157. ** CAPI3REF: Number of columns in a result set
  5158. ** METHOD: sqlite3_stmt
  5159. **
  5160. ** ^The sqlite3_data_count(P) interface returns the number of columns in the
  5161. ** current row of the result set of [prepared statement] P.
  5162. ** ^If prepared statement P does not have results ready to return
  5163. ** (via calls to the [sqlite3_column_int | sqlite3_column_*()] of
  5164. ** interfaces) then sqlite3_data_count(P) returns 0.
  5165. ** ^The sqlite3_data_count(P) routine also returns 0 if P is a NULL pointer.
  5166. ** ^The sqlite3_data_count(P) routine returns 0 if the previous call to
  5167. ** [sqlite3_step](P) returned [SQLITE_DONE]. ^The sqlite3_data_count(P)
  5168. ** will return non-zero if previous call to [sqlite3_step](P) returned
  5169. ** [SQLITE_ROW], except in the case of the [PRAGMA incremental_vacuum]
  5170. ** where it always returns zero since each step of that multi-step
  5171. ** pragma returns 0 columns of data.
  5172. **
  5173. ** See also: [sqlite3_column_count()]
  5174. */
  5175. SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt);
  5176. /*
  5177. ** CAPI3REF: Fundamental Datatypes
  5178. ** KEYWORDS: SQLITE_TEXT
  5179. **
  5180. ** ^(Every value in SQLite has one of five fundamental datatypes:
  5181. **
  5182. ** <ul>
  5183. ** <li> 64-bit signed integer
  5184. ** <li> 64-bit IEEE floating point number
  5185. ** <li> string
  5186. ** <li> BLOB
  5187. ** <li> NULL
  5188. ** </ul>)^
  5189. **
  5190. ** These constants are codes for each of those types.
  5191. **
  5192. ** Note that the SQLITE_TEXT constant was also used in SQLite version 2
  5193. ** for a completely different meaning. Software that links against both
  5194. ** SQLite version 2 and SQLite version 3 should use SQLITE3_TEXT, not
  5195. ** SQLITE_TEXT.
  5196. */
  5197. #define SQLITE_INTEGER 1
  5198. #define SQLITE_FLOAT 2
  5199. #define SQLITE_BLOB 4
  5200. #define SQLITE_NULL 5
  5201. #ifdef SQLITE_TEXT
  5202. # undef SQLITE_TEXT
  5203. #else
  5204. # define SQLITE_TEXT 3
  5205. #endif
  5206. #define SQLITE3_TEXT 3
  5207. /*
  5208. ** CAPI3REF: Result Values From A Query
  5209. ** KEYWORDS: {column access functions}
  5210. ** METHOD: sqlite3_stmt
  5211. **
  5212. ** <b>Summary:</b>
  5213. ** <blockquote><table border=0 cellpadding=0 cellspacing=0>
  5214. ** <tr><td><b>sqlite3_column_blob</b><td>&rarr;<td>BLOB result
  5215. ** <tr><td><b>sqlite3_column_double</b><td>&rarr;<td>REAL result
  5216. ** <tr><td><b>sqlite3_column_int</b><td>&rarr;<td>32-bit INTEGER result
  5217. ** <tr><td><b>sqlite3_column_int64</b><td>&rarr;<td>64-bit INTEGER result
  5218. ** <tr><td><b>sqlite3_column_text</b><td>&rarr;<td>UTF-8 TEXT result
  5219. ** <tr><td><b>sqlite3_column_text16</b><td>&rarr;<td>UTF-16 TEXT result
  5220. ** <tr><td><b>sqlite3_column_value</b><td>&rarr;<td>The result as an
  5221. ** [sqlite3_value|unprotected sqlite3_value] object.
  5222. ** <tr><td>&nbsp;<td>&nbsp;<td>&nbsp;
  5223. ** <tr><td><b>sqlite3_column_bytes</b><td>&rarr;<td>Size of a BLOB
  5224. ** or a UTF-8 TEXT result in bytes
  5225. ** <tr><td><b>sqlite3_column_bytes16&nbsp;&nbsp;</b>
  5226. ** <td>&rarr;&nbsp;&nbsp;<td>Size of UTF-16
  5227. ** TEXT in bytes
  5228. ** <tr><td><b>sqlite3_column_type</b><td>&rarr;<td>Default
  5229. ** datatype of the result
  5230. ** </table></blockquote>
  5231. **
  5232. ** <b>Details:</b>
  5233. **
  5234. ** ^These routines return information about a single column of the current
  5235. ** result row of a query. ^In every case the first argument is a pointer
  5236. ** to the [prepared statement] that is being evaluated (the [sqlite3_stmt*]
  5237. ** that was returned from [sqlite3_prepare_v2()] or one of its variants)
  5238. ** and the second argument is the index of the column for which information
  5239. ** should be returned. ^The leftmost column of the result set has the index 0.
  5240. ** ^The number of columns in the result can be determined using
  5241. ** [sqlite3_column_count()].
  5242. **
  5243. ** If the SQL statement does not currently point to a valid row, or if the
  5244. ** column index is out of range, the result is undefined.
  5245. ** These routines may only be called when the most recent call to
  5246. ** [sqlite3_step()] has returned [SQLITE_ROW] and neither
  5247. ** [sqlite3_reset()] nor [sqlite3_finalize()] have been called subsequently.
  5248. ** If any of these routines are called after [sqlite3_reset()] or
  5249. ** [sqlite3_finalize()] or after [sqlite3_step()] has returned
  5250. ** something other than [SQLITE_ROW], the results are undefined.
  5251. ** If [sqlite3_step()] or [sqlite3_reset()] or [sqlite3_finalize()]
  5252. ** are called from a different thread while any of these routines
  5253. ** are pending, then the results are undefined.
  5254. **
  5255. ** The first six interfaces (_blob, _double, _int, _int64, _text, and _text16)
  5256. ** each return the value of a result column in a specific data format. If
  5257. ** the result column is not initially in the requested format (for example,
  5258. ** if the query returns an integer but the sqlite3_column_text() interface
  5259. ** is used to extract the value) then an automatic type conversion is performed.
  5260. **
  5261. ** ^The sqlite3_column_type() routine returns the
  5262. ** [SQLITE_INTEGER | datatype code] for the initial data type
  5263. ** of the result column. ^The returned value is one of [SQLITE_INTEGER],
  5264. ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].
  5265. ** The return value of sqlite3_column_type() can be used to decide which
  5266. ** of the first six interface should be used to extract the column value.
  5267. ** The value returned by sqlite3_column_type() is only meaningful if no
  5268. ** automatic type conversions have occurred for the value in question.
  5269. ** After a type conversion, the result of calling sqlite3_column_type()
  5270. ** is undefined, though harmless. Future
  5271. ** versions of SQLite may change the behavior of sqlite3_column_type()
  5272. ** following a type conversion.
  5273. **
  5274. ** If the result is a BLOB or a TEXT string, then the sqlite3_column_bytes()
  5275. ** or sqlite3_column_bytes16() interfaces can be used to determine the size
  5276. ** of that BLOB or string.
  5277. **
  5278. ** ^If the result is a BLOB or UTF-8 string then the sqlite3_column_bytes()
  5279. ** routine returns the number of bytes in that BLOB or string.
  5280. ** ^If the result is a UTF-16 string, then sqlite3_column_bytes() converts
  5281. ** the string to UTF-8 and then returns the number of bytes.
  5282. ** ^If the result is a numeric value then sqlite3_column_bytes() uses
  5283. ** [sqlite3_snprintf()] to convert that value to a UTF-8 string and returns
  5284. ** the number of bytes in that string.
  5285. ** ^If the result is NULL, then sqlite3_column_bytes() returns zero.
  5286. **
  5287. ** ^If the result is a BLOB or UTF-16 string then the sqlite3_column_bytes16()
  5288. ** routine returns the number of bytes in that BLOB or string.
  5289. ** ^If the result is a UTF-8 string, then sqlite3_column_bytes16() converts
  5290. ** the string to UTF-16 and then returns the number of bytes.
  5291. ** ^If the result is a numeric value then sqlite3_column_bytes16() uses
  5292. ** [sqlite3_snprintf()] to convert that value to a UTF-16 string and returns
  5293. ** the number of bytes in that string.
  5294. ** ^If the result is NULL, then sqlite3_column_bytes16() returns zero.
  5295. **
  5296. ** ^The values returned by [sqlite3_column_bytes()] and
  5297. ** [sqlite3_column_bytes16()] do not include the zero terminators at the end
  5298. ** of the string. ^For clarity: the values returned by
  5299. ** [sqlite3_column_bytes()] and [sqlite3_column_bytes16()] are the number of
  5300. ** bytes in the string, not the number of characters.
  5301. **
  5302. ** ^Strings returned by sqlite3_column_text() and sqlite3_column_text16(),
  5303. ** even empty strings, are always zero-terminated. ^The return
  5304. ** value from sqlite3_column_blob() for a zero-length BLOB is a NULL pointer.
  5305. **
  5306. ** <b>Warning:</b> ^The object returned by [sqlite3_column_value()] is an
  5307. ** [unprotected sqlite3_value] object. In a multithreaded environment,
  5308. ** an unprotected sqlite3_value object may only be used safely with
  5309. ** [sqlite3_bind_value()] and [sqlite3_result_value()].
  5310. ** If the [unprotected sqlite3_value] object returned by
  5311. ** [sqlite3_column_value()] is used in any other way, including calls
  5312. ** to routines like [sqlite3_value_int()], [sqlite3_value_text()],
  5313. ** or [sqlite3_value_bytes()], the behavior is not threadsafe.
  5314. ** Hence, the sqlite3_column_value() interface
  5315. ** is normally only useful within the implementation of
  5316. ** [application-defined SQL functions] or [virtual tables], not within
  5317. ** top-level application code.
  5318. **
  5319. ** The these routines may attempt to convert the datatype of the result.
  5320. ** ^For example, if the internal representation is FLOAT and a text result
  5321. ** is requested, [sqlite3_snprintf()] is used internally to perform the
  5322. ** conversion automatically. ^(The following table details the conversions
  5323. ** that are applied:
  5324. **
  5325. ** <blockquote>
  5326. ** <table border="1">
  5327. ** <tr><th> Internal<br>Type <th> Requested<br>Type <th> Conversion
  5328. **
  5329. ** <tr><td> NULL <td> INTEGER <td> Result is 0
  5330. ** <tr><td> NULL <td> FLOAT <td> Result is 0.0
  5331. ** <tr><td> NULL <td> TEXT <td> Result is a NULL pointer
  5332. ** <tr><td> NULL <td> BLOB <td> Result is a NULL pointer
  5333. ** <tr><td> INTEGER <td> FLOAT <td> Convert from integer to float
  5334. ** <tr><td> INTEGER <td> TEXT <td> ASCII rendering of the integer
  5335. ** <tr><td> INTEGER <td> BLOB <td> Same as INTEGER->TEXT
  5336. ** <tr><td> FLOAT <td> INTEGER <td> [CAST] to INTEGER
  5337. ** <tr><td> FLOAT <td> TEXT <td> ASCII rendering of the float
  5338. ** <tr><td> FLOAT <td> BLOB <td> [CAST] to BLOB
  5339. ** <tr><td> TEXT <td> INTEGER <td> [CAST] to INTEGER
  5340. ** <tr><td> TEXT <td> FLOAT <td> [CAST] to REAL
  5341. ** <tr><td> TEXT <td> BLOB <td> No change
  5342. ** <tr><td> BLOB <td> INTEGER <td> [CAST] to INTEGER
  5343. ** <tr><td> BLOB <td> FLOAT <td> [CAST] to REAL
  5344. ** <tr><td> BLOB <td> TEXT <td> Add a zero terminator if needed
  5345. ** </table>
  5346. ** </blockquote>)^
  5347. **
  5348. ** Note that when type conversions occur, pointers returned by prior
  5349. ** calls to sqlite3_column_blob(), sqlite3_column_text(), and/or
  5350. ** sqlite3_column_text16() may be invalidated.
  5351. ** Type conversions and pointer invalidations might occur
  5352. ** in the following cases:
  5353. **
  5354. ** <ul>
  5355. ** <li> The initial content is a BLOB and sqlite3_column_text() or
  5356. ** sqlite3_column_text16() is called. A zero-terminator might
  5357. ** need to be added to the string.</li>
  5358. ** <li> The initial content is UTF-8 text and sqlite3_column_bytes16() or
  5359. ** sqlite3_column_text16() is called. The content must be converted
  5360. ** to UTF-16.</li>
  5361. ** <li> The initial content is UTF-16 text and sqlite3_column_bytes() or
  5362. ** sqlite3_column_text() is called. The content must be converted
  5363. ** to UTF-8.</li>
  5364. ** </ul>
  5365. **
  5366. ** ^Conversions between UTF-16be and UTF-16le are always done in place and do
  5367. ** not invalidate a prior pointer, though of course the content of the buffer
  5368. ** that the prior pointer references will have been modified. Other kinds
  5369. ** of conversion are done in place when it is possible, but sometimes they
  5370. ** are not possible and in those cases prior pointers are invalidated.
  5371. **
  5372. ** The safest policy is to invoke these routines
  5373. ** in one of the following ways:
  5374. **
  5375. ** <ul>
  5376. ** <li>sqlite3_column_text() followed by sqlite3_column_bytes()</li>
  5377. ** <li>sqlite3_column_blob() followed by sqlite3_column_bytes()</li>
  5378. ** <li>sqlite3_column_text16() followed by sqlite3_column_bytes16()</li>
  5379. ** </ul>
  5380. **
  5381. ** In other words, you should call sqlite3_column_text(),
  5382. ** sqlite3_column_blob(), or sqlite3_column_text16() first to force the result
  5383. ** into the desired format, then invoke sqlite3_column_bytes() or
  5384. ** sqlite3_column_bytes16() to find the size of the result. Do not mix calls
  5385. ** to sqlite3_column_text() or sqlite3_column_blob() with calls to
  5386. ** sqlite3_column_bytes16(), and do not mix calls to sqlite3_column_text16()
  5387. ** with calls to sqlite3_column_bytes().
  5388. **
  5389. ** ^The pointers returned are valid until a type conversion occurs as
  5390. ** described above, or until [sqlite3_step()] or [sqlite3_reset()] or
  5391. ** [sqlite3_finalize()] is called. ^The memory space used to hold strings
  5392. ** and BLOBs is freed automatically. Do not pass the pointers returned
  5393. ** from [sqlite3_column_blob()], [sqlite3_column_text()], etc. into
  5394. ** [sqlite3_free()].
  5395. **
  5396. ** ^(If a memory allocation error occurs during the evaluation of any
  5397. ** of these routines, a default value is returned. The default value
  5398. ** is either the integer 0, the floating point number 0.0, or a NULL
  5399. ** pointer. Subsequent calls to [sqlite3_errcode()] will return
  5400. ** [SQLITE_NOMEM].)^
  5401. */
  5402. SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt*, int iCol);
  5403. SQLITE_API double sqlite3_column_double(sqlite3_stmt*, int iCol);
  5404. SQLITE_API int sqlite3_column_int(sqlite3_stmt*, int iCol);
  5405. SQLITE_API sqlite3_int64 sqlite3_column_int64(sqlite3_stmt*, int iCol);
  5406. SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt*, int iCol);
  5407. SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt*, int iCol);
  5408. SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt*, int iCol);
  5409. SQLITE_API int sqlite3_column_bytes(sqlite3_stmt*, int iCol);
  5410. SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt*, int iCol);
  5411. SQLITE_API int sqlite3_column_type(sqlite3_stmt*, int iCol);
  5412. /*
  5413. ** CAPI3REF: Destroy A Prepared Statement Object
  5414. ** DESTRUCTOR: sqlite3_stmt
  5415. **
  5416. ** ^The sqlite3_finalize() function is called to delete a [prepared statement].
  5417. ** ^If the most recent evaluation of the statement encountered no errors
  5418. ** or if the statement is never been evaluated, then sqlite3_finalize() returns
  5419. ** SQLITE_OK. ^If the most recent evaluation of statement S failed, then
  5420. ** sqlite3_finalize(S) returns the appropriate [error code] or
  5421. ** [extended error code].
  5422. **
  5423. ** ^The sqlite3_finalize(S) routine can be called at any point during
  5424. ** the life cycle of [prepared statement] S:
  5425. ** before statement S is ever evaluated, after
  5426. ** one or more calls to [sqlite3_reset()], or after any call
  5427. ** to [sqlite3_step()] regardless of whether or not the statement has
  5428. ** completed execution.
  5429. **
  5430. ** ^Invoking sqlite3_finalize() on a NULL pointer is a harmless no-op.
  5431. **
  5432. ** The application must finalize every [prepared statement] in order to avoid
  5433. ** resource leaks. It is a grievous error for the application to try to use
  5434. ** a prepared statement after it has been finalized. Any use of a prepared
  5435. ** statement after it has been finalized can result in undefined and
  5436. ** undesirable behavior such as segfaults and heap corruption.
  5437. */
  5438. SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt);
  5439. /*
  5440. ** CAPI3REF: Reset A Prepared Statement Object
  5441. ** METHOD: sqlite3_stmt
  5442. **
  5443. ** The sqlite3_reset() function is called to reset a [prepared statement]
  5444. ** object back to its initial state, ready to be re-executed.
  5445. ** ^Any SQL statement variables that had values bound to them using
  5446. ** the [sqlite3_bind_blob | sqlite3_bind_*() API] retain their values.
  5447. ** Use [sqlite3_clear_bindings()] to reset the bindings.
  5448. **
  5449. ** ^The [sqlite3_reset(S)] interface resets the [prepared statement] S
  5450. ** back to the beginning of its program.
  5451. **
  5452. ** ^If the most recent call to [sqlite3_step(S)] for the
  5453. ** [prepared statement] S returned [SQLITE_ROW] or [SQLITE_DONE],
  5454. ** or if [sqlite3_step(S)] has never before been called on S,
  5455. ** then [sqlite3_reset(S)] returns [SQLITE_OK].
  5456. **
  5457. ** ^If the most recent call to [sqlite3_step(S)] for the
  5458. ** [prepared statement] S indicated an error, then
  5459. ** [sqlite3_reset(S)] returns an appropriate [error code].
  5460. **
  5461. ** ^The [sqlite3_reset(S)] interface does not change the values
  5462. ** of any [sqlite3_bind_blob|bindings] on the [prepared statement] S.
  5463. */
  5464. SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt);
  5465. /*
  5466. ** CAPI3REF: Create Or Redefine SQL Functions
  5467. ** KEYWORDS: {function creation routines}
  5468. ** KEYWORDS: {application-defined SQL function}
  5469. ** KEYWORDS: {application-defined SQL functions}
  5470. ** METHOD: sqlite3
  5471. **
  5472. ** ^These functions (collectively known as "function creation routines")
  5473. ** are used to add SQL functions or aggregates or to redefine the behavior
  5474. ** of existing SQL functions or aggregates. The only differences between
  5475. ** these routines are the text encoding expected for
  5476. ** the second parameter (the name of the function being created)
  5477. ** and the presence or absence of a destructor callback for
  5478. ** the application data pointer.
  5479. **
  5480. ** ^The first parameter is the [database connection] to which the SQL
  5481. ** function is to be added. ^If an application uses more than one database
  5482. ** connection then application-defined SQL functions must be added
  5483. ** to each database connection separately.
  5484. **
  5485. ** ^The second parameter is the name of the SQL function to be created or
  5486. ** redefined. ^The length of the name is limited to 255 bytes in a UTF-8
  5487. ** representation, exclusive of the zero-terminator. ^Note that the name
  5488. ** length limit is in UTF-8 bytes, not characters nor UTF-16 bytes.
  5489. ** ^Any attempt to create a function with a longer name
  5490. ** will result in [SQLITE_MISUSE] being returned.
  5491. **
  5492. ** ^The third parameter (nArg)
  5493. ** is the number of arguments that the SQL function or
  5494. ** aggregate takes. ^If this parameter is -1, then the SQL function or
  5495. ** aggregate may take any number of arguments between 0 and the limit
  5496. ** set by [sqlite3_limit]([SQLITE_LIMIT_FUNCTION_ARG]). If the third
  5497. ** parameter is less than -1 or greater than 127 then the behavior is
  5498. ** undefined.
  5499. **
  5500. ** ^The fourth parameter, eTextRep, specifies what
  5501. ** [SQLITE_UTF8 | text encoding] this SQL function prefers for
  5502. ** its parameters. The application should set this parameter to
  5503. ** [SQLITE_UTF16LE] if the function implementation invokes
  5504. ** [sqlite3_value_text16le()] on an input, or [SQLITE_UTF16BE] if the
  5505. ** implementation invokes [sqlite3_value_text16be()] on an input, or
  5506. ** [SQLITE_UTF16] if [sqlite3_value_text16()] is used, or [SQLITE_UTF8]
  5507. ** otherwise. ^The same SQL function may be registered multiple times using
  5508. ** different preferred text encodings, with different implementations for
  5509. ** each encoding.
  5510. ** ^When multiple implementations of the same function are available, SQLite
  5511. ** will pick the one that involves the least amount of data conversion.
  5512. **
  5513. ** ^The fourth parameter may optionally be ORed with [SQLITE_DETERMINISTIC]
  5514. ** to signal that the function will always return the same result given
  5515. ** the same inputs within a single SQL statement. Most SQL functions are
  5516. ** deterministic. The built-in [random()] SQL function is an example of a
  5517. ** function that is not deterministic. The SQLite query planner is able to
  5518. ** perform additional optimizations on deterministic functions, so use
  5519. ** of the [SQLITE_DETERMINISTIC] flag is recommended where possible.
  5520. **
  5521. ** ^(The fifth parameter is an arbitrary pointer. The implementation of the
  5522. ** function can gain access to this pointer using [sqlite3_user_data()].)^
  5523. **
  5524. ** ^The sixth, seventh and eighth parameters, xFunc, xStep and xFinal, are
  5525. ** pointers to C-language functions that implement the SQL function or
  5526. ** aggregate. ^A scalar SQL function requires an implementation of the xFunc
  5527. ** callback only; NULL pointers must be passed as the xStep and xFinal
  5528. ** parameters. ^An aggregate SQL function requires an implementation of xStep
  5529. ** and xFinal and NULL pointer must be passed for xFunc. ^To delete an existing
  5530. ** SQL function or aggregate, pass NULL pointers for all three function
  5531. ** callbacks.
  5532. **
  5533. ** ^(If the ninth parameter to sqlite3_create_function_v2() is not NULL,
  5534. ** then it is destructor for the application data pointer.
  5535. ** The destructor is invoked when the function is deleted, either by being
  5536. ** overloaded or when the database connection closes.)^
  5537. ** ^The destructor is also invoked if the call to
  5538. ** sqlite3_create_function_v2() fails.
  5539. ** ^When the destructor callback of the tenth parameter is invoked, it
  5540. ** is passed a single argument which is a copy of the application data
  5541. ** pointer which was the fifth parameter to sqlite3_create_function_v2().
  5542. **
  5543. ** ^It is permitted to register multiple implementations of the same
  5544. ** functions with the same name but with either differing numbers of
  5545. ** arguments or differing preferred text encodings. ^SQLite will use
  5546. ** the implementation that most closely matches the way in which the
  5547. ** SQL function is used. ^A function implementation with a non-negative
  5548. ** nArg parameter is a better match than a function implementation with
  5549. ** a negative nArg. ^A function where the preferred text encoding
  5550. ** matches the database encoding is a better
  5551. ** match than a function where the encoding is different.
  5552. ** ^A function where the encoding difference is between UTF16le and UTF16be
  5553. ** is a closer match than a function where the encoding difference is
  5554. ** between UTF8 and UTF16.
  5555. **
  5556. ** ^Built-in functions may be overloaded by new application-defined functions.
  5557. **
  5558. ** ^An application-defined function is permitted to call other
  5559. ** SQLite interfaces. However, such calls must not
  5560. ** close the database connection nor finalize or reset the prepared
  5561. ** statement in which the function is running.
  5562. */
  5563. SQLITE_API int sqlite3_create_function(
  5564. sqlite3 *db,
  5565. const char *zFunctionName,
  5566. int nArg,
  5567. int eTextRep,
  5568. void *pApp,
  5569. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  5570. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  5571. void (*xFinal)(sqlite3_context*)
  5572. );
  5573. SQLITE_API int sqlite3_create_function16(
  5574. sqlite3 *db,
  5575. const void *zFunctionName,
  5576. int nArg,
  5577. int eTextRep,
  5578. void *pApp,
  5579. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  5580. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  5581. void (*xFinal)(sqlite3_context*)
  5582. );
  5583. SQLITE_API int sqlite3_create_function_v2(
  5584. sqlite3 *db,
  5585. const char *zFunctionName,
  5586. int nArg,
  5587. int eTextRep,
  5588. void *pApp,
  5589. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  5590. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  5591. void (*xFinal)(sqlite3_context*),
  5592. void(*xDestroy)(void*)
  5593. );
  5594. /*
  5595. ** CAPI3REF: Text Encodings
  5596. **
  5597. ** These constant define integer codes that represent the various
  5598. ** text encodings supported by SQLite.
  5599. */
  5600. #define SQLITE_UTF8 1 /* IMP: R-37514-35566 */
  5601. #define SQLITE_UTF16LE 2 /* IMP: R-03371-37637 */
  5602. #define SQLITE_UTF16BE 3 /* IMP: R-51971-34154 */
  5603. #define SQLITE_UTF16 4 /* Use native byte order */
  5604. #define SQLITE_ANY 5 /* Deprecated */
  5605. #define SQLITE_UTF16_ALIGNED 8 /* sqlite3_create_collation only */
  5606. /*
  5607. ** CAPI3REF: Function Flags
  5608. **
  5609. ** These constants may be ORed together with the
  5610. ** [SQLITE_UTF8 | preferred text encoding] as the fourth argument
  5611. ** to [sqlite3_create_function()], [sqlite3_create_function16()], or
  5612. ** [sqlite3_create_function_v2()].
  5613. */
  5614. #define SQLITE_DETERMINISTIC 0x800
  5615. /*
  5616. ** CAPI3REF: Deprecated Functions
  5617. ** DEPRECATED
  5618. **
  5619. ** These functions are [deprecated]. In order to maintain
  5620. ** backwards compatibility with older code, these functions continue
  5621. ** to be supported. However, new applications should avoid
  5622. ** the use of these functions. To encourage programmers to avoid
  5623. ** these functions, we will not explain what they do.
  5624. */
  5625. #ifndef SQLITE_OMIT_DEPRECATED
  5626. SQLITE_API SQLITE_DEPRECATED int sqlite3_aggregate_count(sqlite3_context*);
  5627. SQLITE_API SQLITE_DEPRECATED int sqlite3_expired(sqlite3_stmt*);
  5628. SQLITE_API SQLITE_DEPRECATED int sqlite3_transfer_bindings(sqlite3_stmt*, sqlite3_stmt*);
  5629. SQLITE_API SQLITE_DEPRECATED int sqlite3_global_recover(void);
  5630. SQLITE_API SQLITE_DEPRECATED void sqlite3_thread_cleanup(void);
  5631. SQLITE_API SQLITE_DEPRECATED int sqlite3_memory_alarm(void(*)(void*,sqlite3_int64,int),
  5632. void*,sqlite3_int64);
  5633. #endif
  5634. /*
  5635. ** CAPI3REF: Obtaining SQL Values
  5636. ** METHOD: sqlite3_value
  5637. **
  5638. ** <b>Summary:</b>
  5639. ** <blockquote><table border=0 cellpadding=0 cellspacing=0>
  5640. ** <tr><td><b>sqlite3_value_blob</b><td>&rarr;<td>BLOB value
  5641. ** <tr><td><b>sqlite3_value_double</b><td>&rarr;<td>REAL value
  5642. ** <tr><td><b>sqlite3_value_int</b><td>&rarr;<td>32-bit INTEGER value
  5643. ** <tr><td><b>sqlite3_value_int64</b><td>&rarr;<td>64-bit INTEGER value
  5644. ** <tr><td><b>sqlite3_value_pointer</b><td>&rarr;<td>Pointer value
  5645. ** <tr><td><b>sqlite3_value_text</b><td>&rarr;<td>UTF-8 TEXT value
  5646. ** <tr><td><b>sqlite3_value_text16</b><td>&rarr;<td>UTF-16 TEXT value in
  5647. ** the native byteorder
  5648. ** <tr><td><b>sqlite3_value_text16be</b><td>&rarr;<td>UTF-16be TEXT value
  5649. ** <tr><td><b>sqlite3_value_text16le</b><td>&rarr;<td>UTF-16le TEXT value
  5650. ** <tr><td>&nbsp;<td>&nbsp;<td>&nbsp;
  5651. ** <tr><td><b>sqlite3_value_bytes</b><td>&rarr;<td>Size of a BLOB
  5652. ** or a UTF-8 TEXT in bytes
  5653. ** <tr><td><b>sqlite3_value_bytes16&nbsp;&nbsp;</b>
  5654. ** <td>&rarr;&nbsp;&nbsp;<td>Size of UTF-16
  5655. ** TEXT in bytes
  5656. ** <tr><td><b>sqlite3_value_type</b><td>&rarr;<td>Default
  5657. ** datatype of the value
  5658. ** <tr><td><b>sqlite3_value_numeric_type&nbsp;&nbsp;</b>
  5659. ** <td>&rarr;&nbsp;&nbsp;<td>Best numeric datatype of the value
  5660. ** <tr><td><b>sqlite3_value_nochange&nbsp;&nbsp;</b>
  5661. ** <td>&rarr;&nbsp;&nbsp;<td>True if the column is unchanged in an UPDATE
  5662. ** against a virtual table.
  5663. ** </table></blockquote>
  5664. **
  5665. ** <b>Details:</b>
  5666. **
  5667. ** These routines extract type, size, and content information from
  5668. ** [protected sqlite3_value] objects. Protected sqlite3_value objects
  5669. ** are used to pass parameter information into implementation of
  5670. ** [application-defined SQL functions] and [virtual tables].
  5671. **
  5672. ** These routines work only with [protected sqlite3_value] objects.
  5673. ** Any attempt to use these routines on an [unprotected sqlite3_value]
  5674. ** is not threadsafe.
  5675. **
  5676. ** ^These routines work just like the corresponding [column access functions]
  5677. ** except that these routines take a single [protected sqlite3_value] object
  5678. ** pointer instead of a [sqlite3_stmt*] pointer and an integer column number.
  5679. **
  5680. ** ^The sqlite3_value_text16() interface extracts a UTF-16 string
  5681. ** in the native byte-order of the host machine. ^The
  5682. ** sqlite3_value_text16be() and sqlite3_value_text16le() interfaces
  5683. ** extract UTF-16 strings as big-endian and little-endian respectively.
  5684. **
  5685. ** ^If [sqlite3_value] object V was initialized
  5686. ** using [sqlite3_bind_pointer(S,I,P,X,D)] or [sqlite3_result_pointer(C,P,X,D)]
  5687. ** and if X and Y are strings that compare equal according to strcmp(X,Y),
  5688. ** then sqlite3_value_pointer(V,Y) will return the pointer P. ^Otherwise,
  5689. ** sqlite3_value_pointer(V,Y) returns a NULL. The sqlite3_bind_pointer()
  5690. ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
  5691. **
  5692. ** ^(The sqlite3_value_type(V) interface returns the
  5693. ** [SQLITE_INTEGER | datatype code] for the initial datatype of the
  5694. ** [sqlite3_value] object V. The returned value is one of [SQLITE_INTEGER],
  5695. ** [SQLITE_FLOAT], [SQLITE_TEXT], [SQLITE_BLOB], or [SQLITE_NULL].)^
  5696. ** Other interfaces might change the datatype for an sqlite3_value object.
  5697. ** For example, if the datatype is initially SQLITE_INTEGER and
  5698. ** sqlite3_value_text(V) is called to extract a text value for that
  5699. ** integer, then subsequent calls to sqlite3_value_type(V) might return
  5700. ** SQLITE_TEXT. Whether or not a persistent internal datatype conversion
  5701. ** occurs is undefined and may change from one release of SQLite to the next.
  5702. **
  5703. ** ^(The sqlite3_value_numeric_type() interface attempts to apply
  5704. ** numeric affinity to the value. This means that an attempt is
  5705. ** made to convert the value to an integer or floating point. If
  5706. ** such a conversion is possible without loss of information (in other
  5707. ** words, if the value is a string that looks like a number)
  5708. ** then the conversion is performed. Otherwise no conversion occurs.
  5709. ** The [SQLITE_INTEGER | datatype] after conversion is returned.)^
  5710. **
  5711. ** ^Within the [xUpdate] method of a [virtual table], the
  5712. ** sqlite3_value_nochange(X) interface returns true if and only if
  5713. ** the column corresponding to X is unchanged by the UPDATE operation
  5714. ** that the xUpdate method call was invoked to implement and if
  5715. ** and the prior [xColumn] method call that was invoked to extracted
  5716. ** the value for that column returned without setting a result (probably
  5717. ** because it queried [sqlite3_vtab_nochange()] and found that the column
  5718. ** was unchanging). ^Within an [xUpdate] method, any value for which
  5719. ** sqlite3_value_nochange(X) is true will in all other respects appear
  5720. ** to be a NULL value. If sqlite3_value_nochange(X) is invoked anywhere other
  5721. ** than within an [xUpdate] method call for an UPDATE statement, then
  5722. ** the return value is arbitrary and meaningless.
  5723. **
  5724. ** Please pay particular attention to the fact that the pointer returned
  5725. ** from [sqlite3_value_blob()], [sqlite3_value_text()], or
  5726. ** [sqlite3_value_text16()] can be invalidated by a subsequent call to
  5727. ** [sqlite3_value_bytes()], [sqlite3_value_bytes16()], [sqlite3_value_text()],
  5728. ** or [sqlite3_value_text16()].
  5729. **
  5730. ** These routines must be called from the same thread as
  5731. ** the SQL function that supplied the [sqlite3_value*] parameters.
  5732. */
  5733. SQLITE_API const void *sqlite3_value_blob(sqlite3_value*);
  5734. SQLITE_API double sqlite3_value_double(sqlite3_value*);
  5735. SQLITE_API int sqlite3_value_int(sqlite3_value*);
  5736. SQLITE_API sqlite3_int64 sqlite3_value_int64(sqlite3_value*);
  5737. SQLITE_API void *sqlite3_value_pointer(sqlite3_value*, const char*);
  5738. SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value*);
  5739. SQLITE_API const void *sqlite3_value_text16(sqlite3_value*);
  5740. SQLITE_API const void *sqlite3_value_text16le(sqlite3_value*);
  5741. SQLITE_API const void *sqlite3_value_text16be(sqlite3_value*);
  5742. SQLITE_API int sqlite3_value_bytes(sqlite3_value*);
  5743. SQLITE_API int sqlite3_value_bytes16(sqlite3_value*);
  5744. SQLITE_API int sqlite3_value_type(sqlite3_value*);
  5745. SQLITE_API int sqlite3_value_numeric_type(sqlite3_value*);
  5746. SQLITE_API int sqlite3_value_nochange(sqlite3_value*);
  5747. /*
  5748. ** CAPI3REF: Finding The Subtype Of SQL Values
  5749. ** METHOD: sqlite3_value
  5750. **
  5751. ** The sqlite3_value_subtype(V) function returns the subtype for
  5752. ** an [application-defined SQL function] argument V. The subtype
  5753. ** information can be used to pass a limited amount of context from
  5754. ** one SQL function to another. Use the [sqlite3_result_subtype()]
  5755. ** routine to set the subtype for the return value of an SQL function.
  5756. */
  5757. SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value*);
  5758. /*
  5759. ** CAPI3REF: Copy And Free SQL Values
  5760. ** METHOD: sqlite3_value
  5761. **
  5762. ** ^The sqlite3_value_dup(V) interface makes a copy of the [sqlite3_value]
  5763. ** object D and returns a pointer to that copy. ^The [sqlite3_value] returned
  5764. ** is a [protected sqlite3_value] object even if the input is not.
  5765. ** ^The sqlite3_value_dup(V) interface returns NULL if V is NULL or if a
  5766. ** memory allocation fails.
  5767. **
  5768. ** ^The sqlite3_value_free(V) interface frees an [sqlite3_value] object
  5769. ** previously obtained from [sqlite3_value_dup()]. ^If V is a NULL pointer
  5770. ** then sqlite3_value_free(V) is a harmless no-op.
  5771. */
  5772. SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value*);
  5773. SQLITE_API void sqlite3_value_free(sqlite3_value*);
  5774. /*
  5775. ** CAPI3REF: Obtain Aggregate Function Context
  5776. ** METHOD: sqlite3_context
  5777. **
  5778. ** Implementations of aggregate SQL functions use this
  5779. ** routine to allocate memory for storing their state.
  5780. **
  5781. ** ^The first time the sqlite3_aggregate_context(C,N) routine is called
  5782. ** for a particular aggregate function, SQLite
  5783. ** allocates N of memory, zeroes out that memory, and returns a pointer
  5784. ** to the new memory. ^On second and subsequent calls to
  5785. ** sqlite3_aggregate_context() for the same aggregate function instance,
  5786. ** the same buffer is returned. Sqlite3_aggregate_context() is normally
  5787. ** called once for each invocation of the xStep callback and then one
  5788. ** last time when the xFinal callback is invoked. ^(When no rows match
  5789. ** an aggregate query, the xStep() callback of the aggregate function
  5790. ** implementation is never called and xFinal() is called exactly once.
  5791. ** In those cases, sqlite3_aggregate_context() might be called for the
  5792. ** first time from within xFinal().)^
  5793. **
  5794. ** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
  5795. ** when first called if N is less than or equal to zero or if a memory
  5796. ** allocate error occurs.
  5797. **
  5798. ** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
  5799. ** determined by the N parameter on first successful call. Changing the
  5800. ** value of N in subsequent call to sqlite3_aggregate_context() within
  5801. ** the same aggregate function instance will not resize the memory
  5802. ** allocation.)^ Within the xFinal callback, it is customary to set
  5803. ** N=0 in calls to sqlite3_aggregate_context(C,N) so that no
  5804. ** pointless memory allocations occur.
  5805. **
  5806. ** ^SQLite automatically frees the memory allocated by
  5807. ** sqlite3_aggregate_context() when the aggregate query concludes.
  5808. **
  5809. ** The first parameter must be a copy of the
  5810. ** [sqlite3_context | SQL function context] that is the first parameter
  5811. ** to the xStep or xFinal callback routine that implements the aggregate
  5812. ** function.
  5813. **
  5814. ** This routine must be called from the same thread in which
  5815. ** the aggregate SQL function is running.
  5816. */
  5817. SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
  5818. /*
  5819. ** CAPI3REF: User Data For Functions
  5820. ** METHOD: sqlite3_context
  5821. **
  5822. ** ^The sqlite3_user_data() interface returns a copy of
  5823. ** the pointer that was the pUserData parameter (the 5th parameter)
  5824. ** of the [sqlite3_create_function()]
  5825. ** and [sqlite3_create_function16()] routines that originally
  5826. ** registered the application defined function.
  5827. **
  5828. ** This routine must be called from the same thread in which
  5829. ** the application-defined function is running.
  5830. */
  5831. SQLITE_API void *sqlite3_user_data(sqlite3_context*);
  5832. /*
  5833. ** CAPI3REF: Database Connection For Functions
  5834. ** METHOD: sqlite3_context
  5835. **
  5836. ** ^The sqlite3_context_db_handle() interface returns a copy of
  5837. ** the pointer to the [database connection] (the 1st parameter)
  5838. ** of the [sqlite3_create_function()]
  5839. ** and [sqlite3_create_function16()] routines that originally
  5840. ** registered the application defined function.
  5841. */
  5842. SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);
  5843. /*
  5844. ** CAPI3REF: Function Auxiliary Data
  5845. ** METHOD: sqlite3_context
  5846. **
  5847. ** These functions may be used by (non-aggregate) SQL functions to
  5848. ** associate metadata with argument values. If the same value is passed to
  5849. ** multiple invocations of the same SQL function during query execution, under
  5850. ** some circumstances the associated metadata may be preserved. An example
  5851. ** of where this might be useful is in a regular-expression matching
  5852. ** function. The compiled version of the regular expression can be stored as
  5853. ** metadata associated with the pattern string.
  5854. ** Then as long as the pattern string remains the same,
  5855. ** the compiled regular expression can be reused on multiple
  5856. ** invocations of the same function.
  5857. **
  5858. ** ^The sqlite3_get_auxdata(C,N) interface returns a pointer to the metadata
  5859. ** associated by the sqlite3_set_auxdata(C,N,P,X) function with the Nth argument
  5860. ** value to the application-defined function. ^N is zero for the left-most
  5861. ** function argument. ^If there is no metadata
  5862. ** associated with the function argument, the sqlite3_get_auxdata(C,N) interface
  5863. ** returns a NULL pointer.
  5864. **
  5865. ** ^The sqlite3_set_auxdata(C,N,P,X) interface saves P as metadata for the N-th
  5866. ** argument of the application-defined function. ^Subsequent
  5867. ** calls to sqlite3_get_auxdata(C,N) return P from the most recent
  5868. ** sqlite3_set_auxdata(C,N,P,X) call if the metadata is still valid or
  5869. ** NULL if the metadata has been discarded.
  5870. ** ^After each call to sqlite3_set_auxdata(C,N,P,X) where X is not NULL,
  5871. ** SQLite will invoke the destructor function X with parameter P exactly
  5872. ** once, when the metadata is discarded.
  5873. ** SQLite is free to discard the metadata at any time, including: <ul>
  5874. ** <li> ^(when the corresponding function parameter changes)^, or
  5875. ** <li> ^(when [sqlite3_reset()] or [sqlite3_finalize()] is called for the
  5876. ** SQL statement)^, or
  5877. ** <li> ^(when sqlite3_set_auxdata() is invoked again on the same
  5878. ** parameter)^, or
  5879. ** <li> ^(during the original sqlite3_set_auxdata() call when a memory
  5880. ** allocation error occurs.)^ </ul>
  5881. **
  5882. ** Note the last bullet in particular. The destructor X in
  5883. ** sqlite3_set_auxdata(C,N,P,X) might be called immediately, before the
  5884. ** sqlite3_set_auxdata() interface even returns. Hence sqlite3_set_auxdata()
  5885. ** should be called near the end of the function implementation and the
  5886. ** function implementation should not make any use of P after
  5887. ** sqlite3_set_auxdata() has been called.
  5888. **
  5889. ** ^(In practice, metadata is preserved between function calls for
  5890. ** function parameters that are compile-time constants, including literal
  5891. ** values and [parameters] and expressions composed from the same.)^
  5892. **
  5893. ** The value of the N parameter to these interfaces should be non-negative.
  5894. ** Future enhancements may make use of negative N values to define new
  5895. ** kinds of function caching behavior.
  5896. **
  5897. ** These routines must be called from the same thread in which
  5898. ** the SQL function is running.
  5899. */
  5900. SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
  5901. SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));
  5902. /*
  5903. ** CAPI3REF: Constants Defining Special Destructor Behavior
  5904. **
  5905. ** These are special values for the destructor that is passed in as the
  5906. ** final argument to routines like [sqlite3_result_blob()]. ^If the destructor
  5907. ** argument is SQLITE_STATIC, it means that the content pointer is constant
  5908. ** and will never change. It does not need to be destroyed. ^The
  5909. ** SQLITE_TRANSIENT value means that the content will likely change in
  5910. ** the near future and that SQLite should make its own private copy of
  5911. ** the content before returning.
  5912. **
  5913. ** The typedef is necessary to work around problems in certain
  5914. ** C++ compilers.
  5915. */
  5916. typedef void (*sqlite3_destructor_type)(void*);
  5917. #define SQLITE_STATIC ((sqlite3_destructor_type)0)
  5918. #define SQLITE_TRANSIENT ((sqlite3_destructor_type)-1)
  5919. /*
  5920. ** CAPI3REF: Setting The Result Of An SQL Function
  5921. ** METHOD: sqlite3_context
  5922. **
  5923. ** These routines are used by the xFunc or xFinal callbacks that
  5924. ** implement SQL functions and aggregates. See
  5925. ** [sqlite3_create_function()] and [sqlite3_create_function16()]
  5926. ** for additional information.
  5927. **
  5928. ** These functions work very much like the [parameter binding] family of
  5929. ** functions used to bind values to host parameters in prepared statements.
  5930. ** Refer to the [SQL parameter] documentation for additional information.
  5931. **
  5932. ** ^The sqlite3_result_blob() interface sets the result from
  5933. ** an application-defined function to be the BLOB whose content is pointed
  5934. ** to by the second parameter and which is N bytes long where N is the
  5935. ** third parameter.
  5936. **
  5937. ** ^The sqlite3_result_zeroblob(C,N) and sqlite3_result_zeroblob64(C,N)
  5938. ** interfaces set the result of the application-defined function to be
  5939. ** a BLOB containing all zero bytes and N bytes in size.
  5940. **
  5941. ** ^The sqlite3_result_double() interface sets the result from
  5942. ** an application-defined function to be a floating point value specified
  5943. ** by its 2nd argument.
  5944. **
  5945. ** ^The sqlite3_result_error() and sqlite3_result_error16() functions
  5946. ** cause the implemented SQL function to throw an exception.
  5947. ** ^SQLite uses the string pointed to by the
  5948. ** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
  5949. ** as the text of an error message. ^SQLite interprets the error
  5950. ** message string from sqlite3_result_error() as UTF-8. ^SQLite
  5951. ** interprets the string from sqlite3_result_error16() as UTF-16 in native
  5952. ** byte order. ^If the third parameter to sqlite3_result_error()
  5953. ** or sqlite3_result_error16() is negative then SQLite takes as the error
  5954. ** message all text up through the first zero character.
  5955. ** ^If the third parameter to sqlite3_result_error() or
  5956. ** sqlite3_result_error16() is non-negative then SQLite takes that many
  5957. ** bytes (not characters) from the 2nd parameter as the error message.
  5958. ** ^The sqlite3_result_error() and sqlite3_result_error16()
  5959. ** routines make a private copy of the error message text before
  5960. ** they return. Hence, the calling function can deallocate or
  5961. ** modify the text after they return without harm.
  5962. ** ^The sqlite3_result_error_code() function changes the error code
  5963. ** returned by SQLite as a result of an error in a function. ^By default,
  5964. ** the error code is SQLITE_ERROR. ^A subsequent call to sqlite3_result_error()
  5965. ** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
  5966. **
  5967. ** ^The sqlite3_result_error_toobig() interface causes SQLite to throw an
  5968. ** error indicating that a string or BLOB is too long to represent.
  5969. **
  5970. ** ^The sqlite3_result_error_nomem() interface causes SQLite to throw an
  5971. ** error indicating that a memory allocation failed.
  5972. **
  5973. ** ^The sqlite3_result_int() interface sets the return value
  5974. ** of the application-defined function to be the 32-bit signed integer
  5975. ** value given in the 2nd argument.
  5976. ** ^The sqlite3_result_int64() interface sets the return value
  5977. ** of the application-defined function to be the 64-bit signed integer
  5978. ** value given in the 2nd argument.
  5979. **
  5980. ** ^The sqlite3_result_null() interface sets the return value
  5981. ** of the application-defined function to be NULL.
  5982. **
  5983. ** ^The sqlite3_result_text(), sqlite3_result_text16(),
  5984. ** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
  5985. ** set the return value of the application-defined function to be
  5986. ** a text string which is represented as UTF-8, UTF-16 native byte order,
  5987. ** UTF-16 little endian, or UTF-16 big endian, respectively.
  5988. ** ^The sqlite3_result_text64() interface sets the return value of an
  5989. ** application-defined function to be a text string in an encoding
  5990. ** specified by the fifth (and last) parameter, which must be one
  5991. ** of [SQLITE_UTF8], [SQLITE_UTF16], [SQLITE_UTF16BE], or [SQLITE_UTF16LE].
  5992. ** ^SQLite takes the text result from the application from
  5993. ** the 2nd parameter of the sqlite3_result_text* interfaces.
  5994. ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
  5995. ** is negative, then SQLite takes result text from the 2nd parameter
  5996. ** through the first zero character.
  5997. ** ^If the 3rd parameter to the sqlite3_result_text* interfaces
  5998. ** is non-negative, then as many bytes (not characters) of the text
  5999. ** pointed to by the 2nd parameter are taken as the application-defined
  6000. ** function result. If the 3rd parameter is non-negative, then it
  6001. ** must be the byte offset into the string where the NUL terminator would
  6002. ** appear if the string where NUL terminated. If any NUL characters occur
  6003. ** in the string at a byte offset that is less than the value of the 3rd
  6004. ** parameter, then the resulting string will contain embedded NULs and the
  6005. ** result of expressions operating on strings with embedded NULs is undefined.
  6006. ** ^If the 4th parameter to the sqlite3_result_text* interfaces
  6007. ** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
  6008. ** function as the destructor on the text or BLOB result when it has
  6009. ** finished using that result.
  6010. ** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
  6011. ** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
  6012. ** assumes that the text or BLOB result is in constant space and does not
  6013. ** copy the content of the parameter nor call a destructor on the content
  6014. ** when it has finished using that result.
  6015. ** ^If the 4th parameter to the sqlite3_result_text* interfaces
  6016. ** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
  6017. ** then SQLite makes a copy of the result into space obtained
  6018. ** from [sqlite3_malloc()] before it returns.
  6019. **
  6020. ** ^The sqlite3_result_value() interface sets the result of
  6021. ** the application-defined function to be a copy of the
  6022. ** [unprotected sqlite3_value] object specified by the 2nd parameter. ^The
  6023. ** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
  6024. ** so that the [sqlite3_value] specified in the parameter may change or
  6025. ** be deallocated after sqlite3_result_value() returns without harm.
  6026. ** ^A [protected sqlite3_value] object may always be used where an
  6027. ** [unprotected sqlite3_value] object is required, so either
  6028. ** kind of [sqlite3_value] object can be used with this interface.
  6029. **
  6030. ** ^The sqlite3_result_pointer(C,P,T,D) interface sets the result to an
  6031. ** SQL NULL value, just like [sqlite3_result_null(C)], except that it
  6032. ** also associates the host-language pointer P or type T with that
  6033. ** NULL value such that the pointer can be retrieved within an
  6034. ** [application-defined SQL function] using [sqlite3_value_pointer()].
  6035. ** ^If the D parameter is not NULL, then it is a pointer to a destructor
  6036. ** for the P parameter. ^SQLite invokes D with P as its only argument
  6037. ** when SQLite is finished with P. The T parameter should be a static
  6038. ** string and preferably a string literal. The sqlite3_result_pointer()
  6039. ** routine is part of the [pointer passing interface] added for SQLite 3.20.0.
  6040. **
  6041. ** If these routines are called from within the different thread
  6042. ** than the one containing the application-defined function that received
  6043. ** the [sqlite3_context] pointer, the results are undefined.
  6044. */
  6045. SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
  6046. SQLITE_API void sqlite3_result_blob64(sqlite3_context*,const void*,
  6047. sqlite3_uint64,void(*)(void*));
  6048. SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
  6049. SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
  6050. SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
  6051. SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
  6052. SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
  6053. SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
  6054. SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
  6055. SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
  6056. SQLITE_API void sqlite3_result_null(sqlite3_context*);
  6057. SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
  6058. SQLITE_API void sqlite3_result_text64(sqlite3_context*, const char*,sqlite3_uint64,
  6059. void(*)(void*), unsigned char encoding);
  6060. SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
  6061. SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
  6062. SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
  6063. SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
  6064. SQLITE_API void sqlite3_result_pointer(sqlite3_context*, void*,const char*,void(*)(void*));
  6065. SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);
  6066. SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context*, sqlite3_uint64 n);
  6067. /*
  6068. ** CAPI3REF: Setting The Subtype Of An SQL Function
  6069. ** METHOD: sqlite3_context
  6070. **
  6071. ** The sqlite3_result_subtype(C,T) function causes the subtype of
  6072. ** the result from the [application-defined SQL function] with
  6073. ** [sqlite3_context] C to be the value T. Only the lower 8 bits
  6074. ** of the subtype T are preserved in current versions of SQLite;
  6075. ** higher order bits are discarded.
  6076. ** The number of subtype bytes preserved by SQLite might increase
  6077. ** in future releases of SQLite.
  6078. */
  6079. SQLITE_API void sqlite3_result_subtype(sqlite3_context*,unsigned int);
  6080. /*
  6081. ** CAPI3REF: Define New Collating Sequences
  6082. ** METHOD: sqlite3
  6083. **
  6084. ** ^These functions add, remove, or modify a [collation] associated
  6085. ** with the [database connection] specified as the first argument.
  6086. **
  6087. ** ^The name of the collation is a UTF-8 string
  6088. ** for sqlite3_create_collation() and sqlite3_create_collation_v2()
  6089. ** and a UTF-16 string in native byte order for sqlite3_create_collation16().
  6090. ** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
  6091. ** considered to be the same name.
  6092. **
  6093. ** ^(The third argument (eTextRep) must be one of the constants:
  6094. ** <ul>
  6095. ** <li> [SQLITE_UTF8],
  6096. ** <li> [SQLITE_UTF16LE],
  6097. ** <li> [SQLITE_UTF16BE],
  6098. ** <li> [SQLITE_UTF16], or
  6099. ** <li> [SQLITE_UTF16_ALIGNED].
  6100. ** </ul>)^
  6101. ** ^The eTextRep argument determines the encoding of strings passed
  6102. ** to the collating function callback, xCallback.
  6103. ** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
  6104. ** force strings to be UTF16 with native byte order.
  6105. ** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
  6106. ** on an even byte address.
  6107. **
  6108. ** ^The fourth argument, pArg, is an application data pointer that is passed
  6109. ** through as the first argument to the collating function callback.
  6110. **
  6111. ** ^The fifth argument, xCallback, is a pointer to the collating function.
  6112. ** ^Multiple collating functions can be registered using the same name but
  6113. ** with different eTextRep parameters and SQLite will use whichever
  6114. ** function requires the least amount of data transformation.
  6115. ** ^If the xCallback argument is NULL then the collating function is
  6116. ** deleted. ^When all collating functions having the same name are deleted,
  6117. ** that collation is no longer usable.
  6118. **
  6119. ** ^The collating function callback is invoked with a copy of the pArg
  6120. ** application data pointer and with two strings in the encoding specified
  6121. ** by the eTextRep argument. The collating function must return an
  6122. ** integer that is negative, zero, or positive
  6123. ** if the first string is less than, equal to, or greater than the second,
  6124. ** respectively. A collating function must always return the same answer
  6125. ** given the same inputs. If two or more collating functions are registered
  6126. ** to the same collation name (using different eTextRep values) then all
  6127. ** must give an equivalent answer when invoked with equivalent strings.
  6128. ** The collating function must obey the following properties for all
  6129. ** strings A, B, and C:
  6130. **
  6131. ** <ol>
  6132. ** <li> If A==B then B==A.
  6133. ** <li> If A==B and B==C then A==C.
  6134. ** <li> If A&lt;B THEN B&gt;A.
  6135. ** <li> If A&lt;B and B&lt;C then A&lt;C.
  6136. ** </ol>
  6137. **
  6138. ** If a collating function fails any of the above constraints and that
  6139. ** collating function is registered and used, then the behavior of SQLite
  6140. ** is undefined.
  6141. **
  6142. ** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
  6143. ** with the addition that the xDestroy callback is invoked on pArg when
  6144. ** the collating function is deleted.
  6145. ** ^Collating functions are deleted when they are overridden by later
  6146. ** calls to the collation creation functions or when the
  6147. ** [database connection] is closed using [sqlite3_close()].
  6148. **
  6149. ** ^The xDestroy callback is <u>not</u> called if the
  6150. ** sqlite3_create_collation_v2() function fails. Applications that invoke
  6151. ** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should
  6152. ** check the return code and dispose of the application data pointer
  6153. ** themselves rather than expecting SQLite to deal with it for them.
  6154. ** This is different from every other SQLite interface. The inconsistency
  6155. ** is unfortunate but cannot be changed without breaking backwards
  6156. ** compatibility.
  6157. **
  6158. ** See also: [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
  6159. */
  6160. SQLITE_API int sqlite3_create_collation(
  6161. sqlite3*,
  6162. const char *zName,
  6163. int eTextRep,
  6164. void *pArg,
  6165. int(*xCompare)(void*,int,const void*,int,const void*)
  6166. );
  6167. SQLITE_API int sqlite3_create_collation_v2(
  6168. sqlite3*,
  6169. const char *zName,
  6170. int eTextRep,
  6171. void *pArg,
  6172. int(*xCompare)(void*,int,const void*,int,const void*),
  6173. void(*xDestroy)(void*)
  6174. );
  6175. SQLITE_API int sqlite3_create_collation16(
  6176. sqlite3*,
  6177. const void *zName,
  6178. int eTextRep,
  6179. void *pArg,
  6180. int(*xCompare)(void*,int,const void*,int,const void*)
  6181. );
  6182. /*
  6183. ** CAPI3REF: Collation Needed Callbacks
  6184. ** METHOD: sqlite3
  6185. **
  6186. ** ^To avoid having to register all collation sequences before a database
  6187. ** can be used, a single callback function may be registered with the
  6188. ** [database connection] to be invoked whenever an undefined collation
  6189. ** sequence is required.
  6190. **
  6191. ** ^If the function is registered using the sqlite3_collation_needed() API,
  6192. ** then it is passed the names of undefined collation sequences as strings
  6193. ** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
  6194. ** the names are passed as UTF-16 in machine native byte order.
  6195. ** ^A call to either function replaces the existing collation-needed callback.
  6196. **
  6197. ** ^(When the callback is invoked, the first argument passed is a copy
  6198. ** of the second argument to sqlite3_collation_needed() or
  6199. ** sqlite3_collation_needed16(). The second argument is the database
  6200. ** connection. The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
  6201. ** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
  6202. ** sequence function required. The fourth parameter is the name of the
  6203. ** required collation sequence.)^
  6204. **
  6205. ** The callback function should register the desired collation using
  6206. ** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
  6207. ** [sqlite3_create_collation_v2()].
  6208. */
  6209. SQLITE_API int sqlite3_collation_needed(
  6210. sqlite3*,
  6211. void*,
  6212. void(*)(void*,sqlite3*,int eTextRep,const char*)
  6213. );
  6214. SQLITE_API int sqlite3_collation_needed16(
  6215. sqlite3*,
  6216. void*,
  6217. void(*)(void*,sqlite3*,int eTextRep,const void*)
  6218. );
  6219. #ifdef SQLITE_HAS_CODEC
  6220. /*
  6221. ** Specify the key for an encrypted database. This routine should be
  6222. ** called right after sqlite3_open().
  6223. **
  6224. ** The code to implement this API is not available in the public release
  6225. ** of SQLite.
  6226. */
  6227. SQLITE_API int sqlite3_key(
  6228. sqlite3 *db, /* Database to be rekeyed */
  6229. const void *pKey, int nKey /* The key */
  6230. );
  6231. SQLITE_API int sqlite3_key_v2(
  6232. sqlite3 *db, /* Database to be rekeyed */
  6233. const char *zDbName, /* Name of the database */
  6234. const void *pKey, int nKey /* The key */
  6235. );
  6236. /*
  6237. ** Change the key on an open database. If the current database is not
  6238. ** encrypted, this routine will encrypt it. If pNew==0 or nNew==0, the
  6239. ** database is decrypted.
  6240. **
  6241. ** The code to implement this API is not available in the public release
  6242. ** of SQLite.
  6243. */
  6244. SQLITE_API int sqlite3_rekey(
  6245. sqlite3 *db, /* Database to be rekeyed */
  6246. const void *pKey, int nKey /* The new key */
  6247. );
  6248. SQLITE_API int sqlite3_rekey_v2(
  6249. sqlite3 *db, /* Database to be rekeyed */
  6250. const char *zDbName, /* Name of the database */
  6251. const void *pKey, int nKey /* The new key */
  6252. );
  6253. /*
  6254. ** Specify the activation key for a SEE database. Unless
  6255. ** activated, none of the SEE routines will work.
  6256. */
  6257. SQLITE_API void sqlite3_activate_see(
  6258. const char *zPassPhrase /* Activation phrase */
  6259. );
  6260. #endif
  6261. #ifdef SQLITE_ENABLE_CEROD
  6262. /*
  6263. ** Specify the activation key for a CEROD database. Unless
  6264. ** activated, none of the CEROD routines will work.
  6265. */
  6266. SQLITE_API void sqlite3_activate_cerod(
  6267. const char *zPassPhrase /* Activation phrase */
  6268. );
  6269. #endif
  6270. /*
  6271. ** CAPI3REF: Suspend Execution For A Short Time
  6272. **
  6273. ** The sqlite3_sleep() function causes the current thread to suspend execution
  6274. ** for at least a number of milliseconds specified in its parameter.
  6275. **
  6276. ** If the operating system does not support sleep requests with
  6277. ** millisecond time resolution, then the time will be rounded up to
  6278. ** the nearest second. The number of milliseconds of sleep actually
  6279. ** requested from the operating system is returned.
  6280. **
  6281. ** ^SQLite implements this interface by calling the xSleep()
  6282. ** method of the default [sqlite3_vfs] object. If the xSleep() method
  6283. ** of the default VFS is not implemented correctly, or not implemented at
  6284. ** all, then the behavior of sqlite3_sleep() may deviate from the description
  6285. ** in the previous paragraphs.
  6286. */
  6287. SQLITE_API int sqlite3_sleep(int);
  6288. /*
  6289. ** CAPI3REF: Name Of The Folder Holding Temporary Files
  6290. **
  6291. ** ^(If this global variable is made to point to a string which is
  6292. ** the name of a folder (a.k.a. directory), then all temporary files
  6293. ** created by SQLite when using a built-in [sqlite3_vfs | VFS]
  6294. ** will be placed in that directory.)^ ^If this variable
  6295. ** is a NULL pointer, then SQLite performs a search for an appropriate
  6296. ** temporary file directory.
  6297. **
  6298. ** Applications are strongly discouraged from using this global variable.
  6299. ** It is required to set a temporary folder on Windows Runtime (WinRT).
  6300. ** But for all other platforms, it is highly recommended that applications
  6301. ** neither read nor write this variable. This global variable is a relic
  6302. ** that exists for backwards compatibility of legacy applications and should
  6303. ** be avoided in new projects.
  6304. **
  6305. ** It is not safe to read or modify this variable in more than one
  6306. ** thread at a time. It is not safe to read or modify this variable
  6307. ** if a [database connection] is being used at the same time in a separate
  6308. ** thread.
  6309. ** It is intended that this variable be set once
  6310. ** as part of process initialization and before any SQLite interface
  6311. ** routines have been called and that this variable remain unchanged
  6312. ** thereafter.
  6313. **
  6314. ** ^The [temp_store_directory pragma] may modify this variable and cause
  6315. ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
  6316. ** the [temp_store_directory pragma] always assumes that any string
  6317. ** that this variable points to is held in memory obtained from
  6318. ** [sqlite3_malloc] and the pragma may attempt to free that memory
  6319. ** using [sqlite3_free].
  6320. ** Hence, if this variable is modified directly, either it should be
  6321. ** made NULL or made to point to memory obtained from [sqlite3_malloc]
  6322. ** or else the use of the [temp_store_directory pragma] should be avoided.
  6323. ** Except when requested by the [temp_store_directory pragma], SQLite
  6324. ** does not free the memory that sqlite3_temp_directory points to. If
  6325. ** the application wants that memory to be freed, it must do
  6326. ** so itself, taking care to only do so after all [database connection]
  6327. ** objects have been destroyed.
  6328. **
  6329. ** <b>Note to Windows Runtime users:</b> The temporary directory must be set
  6330. ** prior to calling [sqlite3_open] or [sqlite3_open_v2]. Otherwise, various
  6331. ** features that require the use of temporary files may fail. Here is an
  6332. ** example of how to do this using C++ with the Windows Runtime:
  6333. **
  6334. ** <blockquote><pre>
  6335. ** LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
  6336. ** &nbsp; TemporaryFolder->Path->Data();
  6337. ** char zPathBuf&#91;MAX_PATH + 1&#93;;
  6338. ** memset(zPathBuf, 0, sizeof(zPathBuf));
  6339. ** WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
  6340. ** &nbsp; NULL, NULL);
  6341. ** sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
  6342. ** </pre></blockquote>
  6343. */
  6344. SQLITE_API char *sqlite3_temp_directory;
  6345. /*
  6346. ** CAPI3REF: Name Of The Folder Holding Database Files
  6347. **
  6348. ** ^(If this global variable is made to point to a string which is
  6349. ** the name of a folder (a.k.a. directory), then all database files
  6350. ** specified with a relative pathname and created or accessed by
  6351. ** SQLite when using a built-in windows [sqlite3_vfs | VFS] will be assumed
  6352. ** to be relative to that directory.)^ ^If this variable is a NULL
  6353. ** pointer, then SQLite assumes that all database files specified
  6354. ** with a relative pathname are relative to the current directory
  6355. ** for the process. Only the windows VFS makes use of this global
  6356. ** variable; it is ignored by the unix VFS.
  6357. **
  6358. ** Changing the value of this variable while a database connection is
  6359. ** open can result in a corrupt database.
  6360. **
  6361. ** It is not safe to read or modify this variable in more than one
  6362. ** thread at a time. It is not safe to read or modify this variable
  6363. ** if a [database connection] is being used at the same time in a separate
  6364. ** thread.
  6365. ** It is intended that this variable be set once
  6366. ** as part of process initialization and before any SQLite interface
  6367. ** routines have been called and that this variable remain unchanged
  6368. ** thereafter.
  6369. **
  6370. ** ^The [data_store_directory pragma] may modify this variable and cause
  6371. ** it to point to memory obtained from [sqlite3_malloc]. ^Furthermore,
  6372. ** the [data_store_directory pragma] always assumes that any string
  6373. ** that this variable points to is held in memory obtained from
  6374. ** [sqlite3_malloc] and the pragma may attempt to free that memory
  6375. ** using [sqlite3_free].
  6376. ** Hence, if this variable is modified directly, either it should be
  6377. ** made NULL or made to point to memory obtained from [sqlite3_malloc]
  6378. ** or else the use of the [data_store_directory pragma] should be avoided.
  6379. */
  6380. SQLITE_API char *sqlite3_data_directory;
  6381. /*
  6382. ** CAPI3REF: Test For Auto-Commit Mode
  6383. ** KEYWORDS: {autocommit mode}
  6384. ** METHOD: sqlite3
  6385. **
  6386. ** ^The sqlite3_get_autocommit() interface returns non-zero or
  6387. ** zero if the given database connection is or is not in autocommit mode,
  6388. ** respectively. ^Autocommit mode is on by default.
  6389. ** ^Autocommit mode is disabled by a [BEGIN] statement.
  6390. ** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
  6391. **
  6392. ** If certain kinds of errors occur on a statement within a multi-statement
  6393. ** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
  6394. ** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
  6395. ** transaction might be rolled back automatically. The only way to
  6396. ** find out whether SQLite automatically rolled back the transaction after
  6397. ** an error is to use this function.
  6398. **
  6399. ** If another thread changes the autocommit status of the database
  6400. ** connection while this routine is running, then the return value
  6401. ** is undefined.
  6402. */
  6403. SQLITE_API int sqlite3_get_autocommit(sqlite3*);
  6404. /*
  6405. ** CAPI3REF: Find The Database Handle Of A Prepared Statement
  6406. ** METHOD: sqlite3_stmt
  6407. **
  6408. ** ^The sqlite3_db_handle interface returns the [database connection] handle
  6409. ** to which a [prepared statement] belongs. ^The [database connection]
  6410. ** returned by sqlite3_db_handle is the same [database connection]
  6411. ** that was the first argument
  6412. ** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
  6413. ** create the statement in the first place.
  6414. */
  6415. SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);
  6416. /*
  6417. ** CAPI3REF: Return The Filename For A Database Connection
  6418. ** METHOD: sqlite3
  6419. **
  6420. ** ^The sqlite3_db_filename(D,N) interface returns a pointer to a filename
  6421. ** associated with database N of connection D. ^The main database file
  6422. ** has the name "main". If there is no attached database N on the database
  6423. ** connection D, or if database N is a temporary or in-memory database, then
  6424. ** a NULL pointer is returned.
  6425. **
  6426. ** ^The filename returned by this function is the output of the
  6427. ** xFullPathname method of the [VFS]. ^In other words, the filename
  6428. ** will be an absolute pathname, even if the filename used
  6429. ** to open the database originally was a URI or relative pathname.
  6430. */
  6431. SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName);
  6432. /*
  6433. ** CAPI3REF: Determine if a database is read-only
  6434. ** METHOD: sqlite3
  6435. **
  6436. ** ^The sqlite3_db_readonly(D,N) interface returns 1 if the database N
  6437. ** of connection D is read-only, 0 if it is read/write, or -1 if N is not
  6438. ** the name of a database on connection D.
  6439. */
  6440. SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName);
  6441. /*
  6442. ** CAPI3REF: Find the next prepared statement
  6443. ** METHOD: sqlite3
  6444. **
  6445. ** ^This interface returns a pointer to the next [prepared statement] after
  6446. ** pStmt associated with the [database connection] pDb. ^If pStmt is NULL
  6447. ** then this interface returns a pointer to the first prepared statement
  6448. ** associated with the database connection pDb. ^If no prepared statement
  6449. ** satisfies the conditions of this routine, it returns NULL.
  6450. **
  6451. ** The [database connection] pointer D in a call to
  6452. ** [sqlite3_next_stmt(D,S)] must refer to an open database
  6453. ** connection and in particular must not be a NULL pointer.
  6454. */
  6455. SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);
  6456. /*
  6457. ** CAPI3REF: Commit And Rollback Notification Callbacks
  6458. ** METHOD: sqlite3
  6459. **
  6460. ** ^The sqlite3_commit_hook() interface registers a callback
  6461. ** function to be invoked whenever a transaction is [COMMIT | committed].
  6462. ** ^Any callback set by a previous call to sqlite3_commit_hook()
  6463. ** for the same database connection is overridden.
  6464. ** ^The sqlite3_rollback_hook() interface registers a callback
  6465. ** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
  6466. ** ^Any callback set by a previous call to sqlite3_rollback_hook()
  6467. ** for the same database connection is overridden.
  6468. ** ^The pArg argument is passed through to the callback.
  6469. ** ^If the callback on a commit hook function returns non-zero,
  6470. ** then the commit is converted into a rollback.
  6471. **
  6472. ** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
  6473. ** return the P argument from the previous call of the same function
  6474. ** on the same [database connection] D, or NULL for
  6475. ** the first call for each function on D.
  6476. **
  6477. ** The commit and rollback hook callbacks are not reentrant.
  6478. ** The callback implementation must not do anything that will modify
  6479. ** the database connection that invoked the callback. Any actions
  6480. ** to modify the database connection must be deferred until after the
  6481. ** completion of the [sqlite3_step()] call that triggered the commit
  6482. ** or rollback hook in the first place.
  6483. ** Note that running any other SQL statements, including SELECT statements,
  6484. ** or merely calling [sqlite3_prepare_v2()] and [sqlite3_step()] will modify
  6485. ** the database connections for the meaning of "modify" in this paragraph.
  6486. **
  6487. ** ^Registering a NULL function disables the callback.
  6488. **
  6489. ** ^When the commit hook callback routine returns zero, the [COMMIT]
  6490. ** operation is allowed to continue normally. ^If the commit hook
  6491. ** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
  6492. ** ^The rollback hook is invoked on a rollback that results from a commit
  6493. ** hook returning non-zero, just as it would be with any other rollback.
  6494. **
  6495. ** ^For the purposes of this API, a transaction is said to have been
  6496. ** rolled back if an explicit "ROLLBACK" statement is executed, or
  6497. ** an error or constraint causes an implicit rollback to occur.
  6498. ** ^The rollback callback is not invoked if a transaction is
  6499. ** automatically rolled back because the database connection is closed.
  6500. **
  6501. ** See also the [sqlite3_update_hook()] interface.
  6502. */
  6503. SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
  6504. SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);
  6505. /*
  6506. ** CAPI3REF: Data Change Notification Callbacks
  6507. ** METHOD: sqlite3
  6508. **
  6509. ** ^The sqlite3_update_hook() interface registers a callback function
  6510. ** with the [database connection] identified by the first argument
  6511. ** to be invoked whenever a row is updated, inserted or deleted in
  6512. ** a [rowid table].
  6513. ** ^Any callback set by a previous call to this function
  6514. ** for the same database connection is overridden.
  6515. **
  6516. ** ^The second argument is a pointer to the function to invoke when a
  6517. ** row is updated, inserted or deleted in a rowid table.
  6518. ** ^The first argument to the callback is a copy of the third argument
  6519. ** to sqlite3_update_hook().
  6520. ** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
  6521. ** or [SQLITE_UPDATE], depending on the operation that caused the callback
  6522. ** to be invoked.
  6523. ** ^The third and fourth arguments to the callback contain pointers to the
  6524. ** database and table name containing the affected row.
  6525. ** ^The final callback parameter is the [rowid] of the row.
  6526. ** ^In the case of an update, this is the [rowid] after the update takes place.
  6527. **
  6528. ** ^(The update hook is not invoked when internal system tables are
  6529. ** modified (i.e. sqlite_master and sqlite_sequence).)^
  6530. ** ^The update hook is not invoked when [WITHOUT ROWID] tables are modified.
  6531. **
  6532. ** ^In the current implementation, the update hook
  6533. ** is not invoked when conflicting rows are deleted because of an
  6534. ** [ON CONFLICT | ON CONFLICT REPLACE] clause. ^Nor is the update hook
  6535. ** invoked when rows are deleted using the [truncate optimization].
  6536. ** The exceptions defined in this paragraph might change in a future
  6537. ** release of SQLite.
  6538. **
  6539. ** The update hook implementation must not do anything that will modify
  6540. ** the database connection that invoked the update hook. Any actions
  6541. ** to modify the database connection must be deferred until after the
  6542. ** completion of the [sqlite3_step()] call that triggered the update hook.
  6543. ** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
  6544. ** database connections for the meaning of "modify" in this paragraph.
  6545. **
  6546. ** ^The sqlite3_update_hook(D,C,P) function
  6547. ** returns the P argument from the previous call
  6548. ** on the same [database connection] D, or NULL for
  6549. ** the first call on D.
  6550. **
  6551. ** See also the [sqlite3_commit_hook()], [sqlite3_rollback_hook()],
  6552. ** and [sqlite3_preupdate_hook()] interfaces.
  6553. */
  6554. SQLITE_API void *sqlite3_update_hook(
  6555. sqlite3*,
  6556. void(*)(void *,int ,char const *,char const *,sqlite3_int64),
  6557. void*
  6558. );
  6559. /*
  6560. ** CAPI3REF: Enable Or Disable Shared Pager Cache
  6561. **
  6562. ** ^(This routine enables or disables the sharing of the database cache
  6563. ** and schema data structures between [database connection | connections]
  6564. ** to the same database. Sharing is enabled if the argument is true
  6565. ** and disabled if the argument is false.)^
  6566. **
  6567. ** ^Cache sharing is enabled and disabled for an entire process.
  6568. ** This is a change as of SQLite [version 3.5.0] ([dateof:3.5.0]).
  6569. ** In prior versions of SQLite,
  6570. ** sharing was enabled or disabled for each thread separately.
  6571. **
  6572. ** ^(The cache sharing mode set by this interface effects all subsequent
  6573. ** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
  6574. ** Existing database connections continue use the sharing mode
  6575. ** that was in effect at the time they were opened.)^
  6576. **
  6577. ** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
  6578. ** successfully. An [error code] is returned otherwise.)^
  6579. **
  6580. ** ^Shared cache is disabled by default. But this might change in
  6581. ** future releases of SQLite. Applications that care about shared
  6582. ** cache setting should set it explicitly.
  6583. **
  6584. ** Note: This method is disabled on MacOS X 10.7 and iOS version 5.0
  6585. ** and will always return SQLITE_MISUSE. On those systems,
  6586. ** shared cache mode should be enabled per-database connection via
  6587. ** [sqlite3_open_v2()] with [SQLITE_OPEN_SHAREDCACHE].
  6588. **
  6589. ** This interface is threadsafe on processors where writing a
  6590. ** 32-bit integer is atomic.
  6591. **
  6592. ** See Also: [SQLite Shared-Cache Mode]
  6593. */
  6594. SQLITE_API int sqlite3_enable_shared_cache(int);
  6595. /*
  6596. ** CAPI3REF: Attempt To Free Heap Memory
  6597. **
  6598. ** ^The sqlite3_release_memory() interface attempts to free N bytes
  6599. ** of heap memory by deallocating non-essential memory allocations
  6600. ** held by the database library. Memory used to cache database
  6601. ** pages to improve performance is an example of non-essential memory.
  6602. ** ^sqlite3_release_memory() returns the number of bytes actually freed,
  6603. ** which might be more or less than the amount requested.
  6604. ** ^The sqlite3_release_memory() routine is a no-op returning zero
  6605. ** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
  6606. **
  6607. ** See also: [sqlite3_db_release_memory()]
  6608. */
  6609. SQLITE_API int sqlite3_release_memory(int);
  6610. /*
  6611. ** CAPI3REF: Free Memory Used By A Database Connection
  6612. ** METHOD: sqlite3
  6613. **
  6614. ** ^The sqlite3_db_release_memory(D) interface attempts to free as much heap
  6615. ** memory as possible from database connection D. Unlike the
  6616. ** [sqlite3_release_memory()] interface, this interface is in effect even
  6617. ** when the [SQLITE_ENABLE_MEMORY_MANAGEMENT] compile-time option is
  6618. ** omitted.
  6619. **
  6620. ** See also: [sqlite3_release_memory()]
  6621. */
  6622. SQLITE_API int sqlite3_db_release_memory(sqlite3*);
  6623. /*
  6624. ** CAPI3REF: Impose A Limit On Heap Size
  6625. **
  6626. ** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
  6627. ** soft limit on the amount of heap memory that may be allocated by SQLite.
  6628. ** ^SQLite strives to keep heap memory utilization below the soft heap
  6629. ** limit by reducing the number of pages held in the page cache
  6630. ** as heap memory usages approaches the limit.
  6631. ** ^The soft heap limit is "soft" because even though SQLite strives to stay
  6632. ** below the limit, it will exceed the limit rather than generate
  6633. ** an [SQLITE_NOMEM] error. In other words, the soft heap limit
  6634. ** is advisory only.
  6635. **
  6636. ** ^The return value from sqlite3_soft_heap_limit64() is the size of
  6637. ** the soft heap limit prior to the call, or negative in the case of an
  6638. ** error. ^If the argument N is negative
  6639. ** then no change is made to the soft heap limit. Hence, the current
  6640. ** size of the soft heap limit can be determined by invoking
  6641. ** sqlite3_soft_heap_limit64() with a negative argument.
  6642. **
  6643. ** ^If the argument N is zero then the soft heap limit is disabled.
  6644. **
  6645. ** ^(The soft heap limit is not enforced in the current implementation
  6646. ** if one or more of following conditions are true:
  6647. **
  6648. ** <ul>
  6649. ** <li> The soft heap limit is set to zero.
  6650. ** <li> Memory accounting is disabled using a combination of the
  6651. ** [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
  6652. ** the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
  6653. ** <li> An alternative page cache implementation is specified using
  6654. ** [sqlite3_config]([SQLITE_CONFIG_PCACHE2],...).
  6655. ** <li> The page cache allocates from its own memory pool supplied
  6656. ** by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
  6657. ** from the heap.
  6658. ** </ul>)^
  6659. **
  6660. ** Beginning with SQLite [version 3.7.3] ([dateof:3.7.3]),
  6661. ** the soft heap limit is enforced
  6662. ** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
  6663. ** compile-time option is invoked. With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
  6664. ** the soft heap limit is enforced on every memory allocation. Without
  6665. ** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
  6666. ** when memory is allocated by the page cache. Testing suggests that because
  6667. ** the page cache is the predominate memory user in SQLite, most
  6668. ** applications will achieve adequate soft heap limit enforcement without
  6669. ** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
  6670. **
  6671. ** The circumstances under which SQLite will enforce the soft heap limit may
  6672. ** changes in future releases of SQLite.
  6673. */
  6674. SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);
  6675. /*
  6676. ** CAPI3REF: Deprecated Soft Heap Limit Interface
  6677. ** DEPRECATED
  6678. **
  6679. ** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
  6680. ** interface. This routine is provided for historical compatibility
  6681. ** only. All new applications should use the
  6682. ** [sqlite3_soft_heap_limit64()] interface rather than this one.
  6683. */
  6684. SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);
  6685. /*
  6686. ** CAPI3REF: Extract Metadata About A Column Of A Table
  6687. ** METHOD: sqlite3
  6688. **
  6689. ** ^(The sqlite3_table_column_metadata(X,D,T,C,....) routine returns
  6690. ** information about column C of table T in database D
  6691. ** on [database connection] X.)^ ^The sqlite3_table_column_metadata()
  6692. ** interface returns SQLITE_OK and fills in the non-NULL pointers in
  6693. ** the final five arguments with appropriate values if the specified
  6694. ** column exists. ^The sqlite3_table_column_metadata() interface returns
  6695. ** SQLITE_ERROR and if the specified column does not exist.
  6696. ** ^If the column-name parameter to sqlite3_table_column_metadata() is a
  6697. ** NULL pointer, then this routine simply checks for the existence of the
  6698. ** table and returns SQLITE_OK if the table exists and SQLITE_ERROR if it
  6699. ** does not. If the table name parameter T in a call to
  6700. ** sqlite3_table_column_metadata(X,D,T,C,...) is NULL then the result is
  6701. ** undefined behavior.
  6702. **
  6703. ** ^The column is identified by the second, third and fourth parameters to
  6704. ** this function. ^(The second parameter is either the name of the database
  6705. ** (i.e. "main", "temp", or an attached database) containing the specified
  6706. ** table or NULL.)^ ^If it is NULL, then all attached databases are searched
  6707. ** for the table using the same algorithm used by the database engine to
  6708. ** resolve unqualified table references.
  6709. **
  6710. ** ^The third and fourth parameters to this function are the table and column
  6711. ** name of the desired column, respectively.
  6712. **
  6713. ** ^Metadata is returned by writing to the memory locations passed as the 5th
  6714. ** and subsequent parameters to this function. ^Any of these arguments may be
  6715. ** NULL, in which case the corresponding element of metadata is omitted.
  6716. **
  6717. ** ^(<blockquote>
  6718. ** <table border="1">
  6719. ** <tr><th> Parameter <th> Output<br>Type <th> Description
  6720. **
  6721. ** <tr><td> 5th <td> const char* <td> Data type
  6722. ** <tr><td> 6th <td> const char* <td> Name of default collation sequence
  6723. ** <tr><td> 7th <td> int <td> True if column has a NOT NULL constraint
  6724. ** <tr><td> 8th <td> int <td> True if column is part of the PRIMARY KEY
  6725. ** <tr><td> 9th <td> int <td> True if column is [AUTOINCREMENT]
  6726. ** </table>
  6727. ** </blockquote>)^
  6728. **
  6729. ** ^The memory pointed to by the character pointers returned for the
  6730. ** declaration type and collation sequence is valid until the next
  6731. ** call to any SQLite API function.
  6732. **
  6733. ** ^If the specified table is actually a view, an [error code] is returned.
  6734. **
  6735. ** ^If the specified column is "rowid", "oid" or "_rowid_" and the table
  6736. ** is not a [WITHOUT ROWID] table and an
  6737. ** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
  6738. ** parameters are set for the explicitly declared column. ^(If there is no
  6739. ** [INTEGER PRIMARY KEY] column, then the outputs
  6740. ** for the [rowid] are set as follows:
  6741. **
  6742. ** <pre>
  6743. ** data type: "INTEGER"
  6744. ** collation sequence: "BINARY"
  6745. ** not null: 0
  6746. ** primary key: 1
  6747. ** auto increment: 0
  6748. ** </pre>)^
  6749. **
  6750. ** ^This function causes all database schemas to be read from disk and
  6751. ** parsed, if that has not already been done, and returns an error if
  6752. ** any errors are encountered while loading the schema.
  6753. */
  6754. SQLITE_API int sqlite3_table_column_metadata(
  6755. sqlite3 *db, /* Connection handle */
  6756. const char *zDbName, /* Database name or NULL */
  6757. const char *zTableName, /* Table name */
  6758. const char *zColumnName, /* Column name */
  6759. char const **pzDataType, /* OUTPUT: Declared data type */
  6760. char const **pzCollSeq, /* OUTPUT: Collation sequence name */
  6761. int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
  6762. int *pPrimaryKey, /* OUTPUT: True if column part of PK */
  6763. int *pAutoinc /* OUTPUT: True if column is auto-increment */
  6764. );
  6765. /*
  6766. ** CAPI3REF: Load An Extension
  6767. ** METHOD: sqlite3
  6768. **
  6769. ** ^This interface loads an SQLite extension library from the named file.
  6770. **
  6771. ** ^The sqlite3_load_extension() interface attempts to load an
  6772. ** [SQLite extension] library contained in the file zFile. If
  6773. ** the file cannot be loaded directly, attempts are made to load
  6774. ** with various operating-system specific extensions added.
  6775. ** So for example, if "samplelib" cannot be loaded, then names like
  6776. ** "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
  6777. ** be tried also.
  6778. **
  6779. ** ^The entry point is zProc.
  6780. ** ^(zProc may be 0, in which case SQLite will try to come up with an
  6781. ** entry point name on its own. It first tries "sqlite3_extension_init".
  6782. ** If that does not work, it constructs a name "sqlite3_X_init" where the
  6783. ** X is consists of the lower-case equivalent of all ASCII alphabetic
  6784. ** characters in the filename from the last "/" to the first following
  6785. ** "." and omitting any initial "lib".)^
  6786. ** ^The sqlite3_load_extension() interface returns
  6787. ** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
  6788. ** ^If an error occurs and pzErrMsg is not 0, then the
  6789. ** [sqlite3_load_extension()] interface shall attempt to
  6790. ** fill *pzErrMsg with error message text stored in memory
  6791. ** obtained from [sqlite3_malloc()]. The calling function
  6792. ** should free this memory by calling [sqlite3_free()].
  6793. **
  6794. ** ^Extension loading must be enabled using
  6795. ** [sqlite3_enable_load_extension()] or
  6796. ** [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],1,NULL)
  6797. ** prior to calling this API,
  6798. ** otherwise an error will be returned.
  6799. **
  6800. ** <b>Security warning:</b> It is recommended that the
  6801. ** [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method be used to enable only this
  6802. ** interface. The use of the [sqlite3_enable_load_extension()] interface
  6803. ** should be avoided. This will keep the SQL function [load_extension()]
  6804. ** disabled and prevent SQL injections from giving attackers
  6805. ** access to extension loading capabilities.
  6806. **
  6807. ** See also the [load_extension() SQL function].
  6808. */
  6809. SQLITE_API int sqlite3_load_extension(
  6810. sqlite3 *db, /* Load the extension into this database connection */
  6811. const char *zFile, /* Name of the shared library containing extension */
  6812. const char *zProc, /* Entry point. Derived from zFile if 0 */
  6813. char **pzErrMsg /* Put error message here if not 0 */
  6814. );
  6815. /*
  6816. ** CAPI3REF: Enable Or Disable Extension Loading
  6817. ** METHOD: sqlite3
  6818. **
  6819. ** ^So as not to open security holes in older applications that are
  6820. ** unprepared to deal with [extension loading], and as a means of disabling
  6821. ** [extension loading] while evaluating user-entered SQL, the following API
  6822. ** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
  6823. **
  6824. ** ^Extension loading is off by default.
  6825. ** ^Call the sqlite3_enable_load_extension() routine with onoff==1
  6826. ** to turn extension loading on and call it with onoff==0 to turn
  6827. ** it back off again.
  6828. **
  6829. ** ^This interface enables or disables both the C-API
  6830. ** [sqlite3_load_extension()] and the SQL function [load_extension()].
  6831. ** ^(Use [sqlite3_db_config](db,[SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION],..)
  6832. ** to enable or disable only the C-API.)^
  6833. **
  6834. ** <b>Security warning:</b> It is recommended that extension loading
  6835. ** be disabled using the [SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION] method
  6836. ** rather than this interface, so the [load_extension()] SQL function
  6837. ** remains disabled. This will prevent SQL injections from giving attackers
  6838. ** access to extension loading capabilities.
  6839. */
  6840. SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);
  6841. /*
  6842. ** CAPI3REF: Automatically Load Statically Linked Extensions
  6843. **
  6844. ** ^This interface causes the xEntryPoint() function to be invoked for
  6845. ** each new [database connection] that is created. The idea here is that
  6846. ** xEntryPoint() is the entry point for a statically linked [SQLite extension]
  6847. ** that is to be automatically loaded into all new database connections.
  6848. **
  6849. ** ^(Even though the function prototype shows that xEntryPoint() takes
  6850. ** no arguments and returns void, SQLite invokes xEntryPoint() with three
  6851. ** arguments and expects an integer result as if the signature of the
  6852. ** entry point where as follows:
  6853. **
  6854. ** <blockquote><pre>
  6855. ** &nbsp; int xEntryPoint(
  6856. ** &nbsp; sqlite3 *db,
  6857. ** &nbsp; const char **pzErrMsg,
  6858. ** &nbsp; const struct sqlite3_api_routines *pThunk
  6859. ** &nbsp; );
  6860. ** </pre></blockquote>)^
  6861. **
  6862. ** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
  6863. ** point to an appropriate error message (obtained from [sqlite3_mprintf()])
  6864. ** and return an appropriate [error code]. ^SQLite ensures that *pzErrMsg
  6865. ** is NULL before calling the xEntryPoint(). ^SQLite will invoke
  6866. ** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns. ^If any
  6867. ** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
  6868. ** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
  6869. **
  6870. ** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
  6871. ** on the list of automatic extensions is a harmless no-op. ^No entry point
  6872. ** will be called more than once for each database connection that is opened.
  6873. **
  6874. ** See also: [sqlite3_reset_auto_extension()]
  6875. ** and [sqlite3_cancel_auto_extension()]
  6876. */
  6877. SQLITE_API int sqlite3_auto_extension(void(*xEntryPoint)(void));
  6878. /*
  6879. ** CAPI3REF: Cancel Automatic Extension Loading
  6880. **
  6881. ** ^The [sqlite3_cancel_auto_extension(X)] interface unregisters the
  6882. ** initialization routine X that was registered using a prior call to
  6883. ** [sqlite3_auto_extension(X)]. ^The [sqlite3_cancel_auto_extension(X)]
  6884. ** routine returns 1 if initialization routine X was successfully
  6885. ** unregistered and it returns 0 if X was not on the list of initialization
  6886. ** routines.
  6887. */
  6888. SQLITE_API int sqlite3_cancel_auto_extension(void(*xEntryPoint)(void));
  6889. /*
  6890. ** CAPI3REF: Reset Automatic Extension Loading
  6891. **
  6892. ** ^This interface disables all automatic extensions previously
  6893. ** registered using [sqlite3_auto_extension()].
  6894. */
  6895. SQLITE_API void sqlite3_reset_auto_extension(void);
  6896. /*
  6897. ** The interface to the virtual-table mechanism is currently considered
  6898. ** to be experimental. The interface might change in incompatible ways.
  6899. ** If this is a problem for you, do not use the interface at this time.
  6900. **
  6901. ** When the virtual-table mechanism stabilizes, we will declare the
  6902. ** interface fixed, support it indefinitely, and remove this comment.
  6903. */
  6904. /*
  6905. ** Structures used by the virtual table interface
  6906. */
  6907. typedef struct sqlite3_vtab sqlite3_vtab;
  6908. typedef struct sqlite3_index_info sqlite3_index_info;
  6909. typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
  6910. typedef struct sqlite3_module sqlite3_module;
  6911. /*
  6912. ** CAPI3REF: Virtual Table Object
  6913. ** KEYWORDS: sqlite3_module {virtual table module}
  6914. **
  6915. ** This structure, sometimes called a "virtual table module",
  6916. ** defines the implementation of a [virtual tables].
  6917. ** This structure consists mostly of methods for the module.
  6918. **
  6919. ** ^A virtual table module is created by filling in a persistent
  6920. ** instance of this structure and passing a pointer to that instance
  6921. ** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
  6922. ** ^The registration remains valid until it is replaced by a different
  6923. ** module or until the [database connection] closes. The content
  6924. ** of this structure must not change while it is registered with
  6925. ** any database connection.
  6926. */
  6927. struct sqlite3_module {
  6928. int iVersion;
  6929. int (*xCreate)(sqlite3*, void *pAux,
  6930. int argc, const char *const*argv,
  6931. sqlite3_vtab **ppVTab, char**);
  6932. int (*xConnect)(sqlite3*, void *pAux,
  6933. int argc, const char *const*argv,
  6934. sqlite3_vtab **ppVTab, char**);
  6935. int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
  6936. int (*xDisconnect)(sqlite3_vtab *pVTab);
  6937. int (*xDestroy)(sqlite3_vtab *pVTab);
  6938. int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
  6939. int (*xClose)(sqlite3_vtab_cursor*);
  6940. int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
  6941. int argc, sqlite3_value **argv);
  6942. int (*xNext)(sqlite3_vtab_cursor*);
  6943. int (*xEof)(sqlite3_vtab_cursor*);
  6944. int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
  6945. int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
  6946. int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
  6947. int (*xBegin)(sqlite3_vtab *pVTab);
  6948. int (*xSync)(sqlite3_vtab *pVTab);
  6949. int (*xCommit)(sqlite3_vtab *pVTab);
  6950. int (*xRollback)(sqlite3_vtab *pVTab);
  6951. int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
  6952. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
  6953. void **ppArg);
  6954. int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
  6955. /* The methods above are in version 1 of the sqlite_module object. Those
  6956. ** below are for version 2 and greater. */
  6957. int (*xSavepoint)(sqlite3_vtab *pVTab, int);
  6958. int (*xRelease)(sqlite3_vtab *pVTab, int);
  6959. int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
  6960. };
  6961. /*
  6962. ** CAPI3REF: Virtual Table Indexing Information
  6963. ** KEYWORDS: sqlite3_index_info
  6964. **
  6965. ** The sqlite3_index_info structure and its substructures is used as part
  6966. ** of the [virtual table] interface to
  6967. ** pass information into and receive the reply from the [xBestIndex]
  6968. ** method of a [virtual table module]. The fields under **Inputs** are the
  6969. ** inputs to xBestIndex and are read-only. xBestIndex inserts its
  6970. ** results into the **Outputs** fields.
  6971. **
  6972. ** ^(The aConstraint[] array records WHERE clause constraints of the form:
  6973. **
  6974. ** <blockquote>column OP expr</blockquote>
  6975. **
  6976. ** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^ ^(The particular operator is
  6977. ** stored in aConstraint[].op using one of the
  6978. ** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
  6979. ** ^(The index of the column is stored in
  6980. ** aConstraint[].iColumn.)^ ^(aConstraint[].usable is TRUE if the
  6981. ** expr on the right-hand side can be evaluated (and thus the constraint
  6982. ** is usable) and false if it cannot.)^
  6983. **
  6984. ** ^The optimizer automatically inverts terms of the form "expr OP column"
  6985. ** and makes other simplifications to the WHERE clause in an attempt to
  6986. ** get as many WHERE clause terms into the form shown above as possible.
  6987. ** ^The aConstraint[] array only reports WHERE clause terms that are
  6988. ** relevant to the particular virtual table being queried.
  6989. **
  6990. ** ^Information about the ORDER BY clause is stored in aOrderBy[].
  6991. ** ^Each term of aOrderBy records a column of the ORDER BY clause.
  6992. **
  6993. ** The colUsed field indicates which columns of the virtual table may be
  6994. ** required by the current scan. Virtual table columns are numbered from
  6995. ** zero in the order in which they appear within the CREATE TABLE statement
  6996. ** passed to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
  6997. ** the corresponding bit is set within the colUsed mask if the column may be
  6998. ** required by SQLite. If the table has at least 64 columns and any column
  6999. ** to the right of the first 63 is required, then bit 63 of colUsed is also
  7000. ** set. In other words, column iCol may be required if the expression
  7001. ** (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) evaluates to
  7002. ** non-zero.
  7003. **
  7004. ** The [xBestIndex] method must fill aConstraintUsage[] with information
  7005. ** about what parameters to pass to xFilter. ^If argvIndex>0 then
  7006. ** the right-hand side of the corresponding aConstraint[] is evaluated
  7007. ** and becomes the argvIndex-th entry in argv. ^(If aConstraintUsage[].omit
  7008. ** is true, then the constraint is assumed to be fully handled by the
  7009. ** virtual table and is not checked again by SQLite.)^
  7010. **
  7011. ** ^The idxNum and idxPtr values are recorded and passed into the
  7012. ** [xFilter] method.
  7013. ** ^[sqlite3_free()] is used to free idxPtr if and only if
  7014. ** needToFreeIdxPtr is true.
  7015. **
  7016. ** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
  7017. ** the correct order to satisfy the ORDER BY clause so that no separate
  7018. ** sorting step is required.
  7019. **
  7020. ** ^The estimatedCost value is an estimate of the cost of a particular
  7021. ** strategy. A cost of N indicates that the cost of the strategy is similar
  7022. ** to a linear scan of an SQLite table with N rows. A cost of log(N)
  7023. ** indicates that the expense of the operation is similar to that of a
  7024. ** binary search on a unique indexed field of an SQLite table with N rows.
  7025. **
  7026. ** ^The estimatedRows value is an estimate of the number of rows that
  7027. ** will be returned by the strategy.
  7028. **
  7029. ** The xBestIndex method may optionally populate the idxFlags field with a
  7030. ** mask of SQLITE_INDEX_SCAN_* flags. Currently there is only one such flag -
  7031. ** SQLITE_INDEX_SCAN_UNIQUE. If the xBestIndex method sets this flag, SQLite
  7032. ** assumes that the strategy may visit at most one row.
  7033. **
  7034. ** Additionally, if xBestIndex sets the SQLITE_INDEX_SCAN_UNIQUE flag, then
  7035. ** SQLite also assumes that if a call to the xUpdate() method is made as
  7036. ** part of the same statement to delete or update a virtual table row and the
  7037. ** implementation returns SQLITE_CONSTRAINT, then there is no need to rollback
  7038. ** any database changes. In other words, if the xUpdate() returns
  7039. ** SQLITE_CONSTRAINT, the database contents must be exactly as they were
  7040. ** before xUpdate was called. By contrast, if SQLITE_INDEX_SCAN_UNIQUE is not
  7041. ** set and xUpdate returns SQLITE_CONSTRAINT, any database changes made by
  7042. ** the xUpdate method are automatically rolled back by SQLite.
  7043. **
  7044. ** IMPORTANT: The estimatedRows field was added to the sqlite3_index_info
  7045. ** structure for SQLite [version 3.8.2] ([dateof:3.8.2]).
  7046. ** If a virtual table extension is
  7047. ** used with an SQLite version earlier than 3.8.2, the results of attempting
  7048. ** to read or write the estimatedRows field are undefined (but are likely
  7049. ** to included crashing the application). The estimatedRows field should
  7050. ** therefore only be used if [sqlite3_libversion_number()] returns a
  7051. ** value greater than or equal to 3008002. Similarly, the idxFlags field
  7052. ** was added for [version 3.9.0] ([dateof:3.9.0]).
  7053. ** It may therefore only be used if
  7054. ** sqlite3_libversion_number() returns a value greater than or equal to
  7055. ** 3009000.
  7056. */
  7057. struct sqlite3_index_info {
  7058. /* Inputs */
  7059. int nConstraint; /* Number of entries in aConstraint */
  7060. struct sqlite3_index_constraint {
  7061. int iColumn; /* Column constrained. -1 for ROWID */
  7062. unsigned char op; /* Constraint operator */
  7063. unsigned char usable; /* True if this constraint is usable */
  7064. int iTermOffset; /* Used internally - xBestIndex should ignore */
  7065. } *aConstraint; /* Table of WHERE clause constraints */
  7066. int nOrderBy; /* Number of terms in the ORDER BY clause */
  7067. struct sqlite3_index_orderby {
  7068. int iColumn; /* Column number */
  7069. unsigned char desc; /* True for DESC. False for ASC. */
  7070. } *aOrderBy; /* The ORDER BY clause */
  7071. /* Outputs */
  7072. struct sqlite3_index_constraint_usage {
  7073. int argvIndex; /* if >0, constraint is part of argv to xFilter */
  7074. unsigned char omit; /* Do not code a test for this constraint */
  7075. } *aConstraintUsage;
  7076. int idxNum; /* Number used to identify the index */
  7077. char *idxStr; /* String, possibly obtained from sqlite3_malloc */
  7078. int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
  7079. int orderByConsumed; /* True if output is already ordered */
  7080. double estimatedCost; /* Estimated cost of using this index */
  7081. /* Fields below are only available in SQLite 3.8.2 and later */
  7082. sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
  7083. /* Fields below are only available in SQLite 3.9.0 and later */
  7084. int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
  7085. /* Fields below are only available in SQLite 3.10.0 and later */
  7086. sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
  7087. };
  7088. /*
  7089. ** CAPI3REF: Virtual Table Scan Flags
  7090. */
  7091. #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
  7092. /*
  7093. ** CAPI3REF: Virtual Table Constraint Operator Codes
  7094. **
  7095. ** These macros defined the allowed values for the
  7096. ** [sqlite3_index_info].aConstraint[].op field. Each value represents
  7097. ** an operator that is part of a constraint term in the wHERE clause of
  7098. ** a query that uses a [virtual table].
  7099. */
  7100. #define SQLITE_INDEX_CONSTRAINT_EQ 2
  7101. #define SQLITE_INDEX_CONSTRAINT_GT 4
  7102. #define SQLITE_INDEX_CONSTRAINT_LE 8
  7103. #define SQLITE_INDEX_CONSTRAINT_LT 16
  7104. #define SQLITE_INDEX_CONSTRAINT_GE 32
  7105. #define SQLITE_INDEX_CONSTRAINT_MATCH 64
  7106. #define SQLITE_INDEX_CONSTRAINT_LIKE 65
  7107. #define SQLITE_INDEX_CONSTRAINT_GLOB 66
  7108. #define SQLITE_INDEX_CONSTRAINT_REGEXP 67
  7109. #define SQLITE_INDEX_CONSTRAINT_NE 68
  7110. #define SQLITE_INDEX_CONSTRAINT_ISNOT 69
  7111. #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70
  7112. #define SQLITE_INDEX_CONSTRAINT_ISNULL 71
  7113. #define SQLITE_INDEX_CONSTRAINT_IS 72
  7114. /*
  7115. ** CAPI3REF: Register A Virtual Table Implementation
  7116. ** METHOD: sqlite3
  7117. **
  7118. ** ^These routines are used to register a new [virtual table module] name.
  7119. ** ^Module names must be registered before
  7120. ** creating a new [virtual table] using the module and before using a
  7121. ** preexisting [virtual table] for the module.
  7122. **
  7123. ** ^The module name is registered on the [database connection] specified
  7124. ** by the first parameter. ^The name of the module is given by the
  7125. ** second parameter. ^The third parameter is a pointer to
  7126. ** the implementation of the [virtual table module]. ^The fourth
  7127. ** parameter is an arbitrary client data pointer that is passed through
  7128. ** into the [xCreate] and [xConnect] methods of the virtual table module
  7129. ** when a new virtual table is be being created or reinitialized.
  7130. **
  7131. ** ^The sqlite3_create_module_v2() interface has a fifth parameter which
  7132. ** is a pointer to a destructor for the pClientData. ^SQLite will
  7133. ** invoke the destructor function (if it is not NULL) when SQLite
  7134. ** no longer needs the pClientData pointer. ^The destructor will also
  7135. ** be invoked if the call to sqlite3_create_module_v2() fails.
  7136. ** ^The sqlite3_create_module()
  7137. ** interface is equivalent to sqlite3_create_module_v2() with a NULL
  7138. ** destructor.
  7139. */
  7140. SQLITE_API int sqlite3_create_module(
  7141. sqlite3 *db, /* SQLite connection to register module with */
  7142. const char *zName, /* Name of the module */
  7143. const sqlite3_module *p, /* Methods for the module */
  7144. void *pClientData /* Client data for xCreate/xConnect */
  7145. );
  7146. SQLITE_API int sqlite3_create_module_v2(
  7147. sqlite3 *db, /* SQLite connection to register module with */
  7148. const char *zName, /* Name of the module */
  7149. const sqlite3_module *p, /* Methods for the module */
  7150. void *pClientData, /* Client data for xCreate/xConnect */
  7151. void(*xDestroy)(void*) /* Module destructor function */
  7152. );
  7153. /*
  7154. ** CAPI3REF: Virtual Table Instance Object
  7155. ** KEYWORDS: sqlite3_vtab
  7156. **
  7157. ** Every [virtual table module] implementation uses a subclass
  7158. ** of this object to describe a particular instance
  7159. ** of the [virtual table]. Each subclass will
  7160. ** be tailored to the specific needs of the module implementation.
  7161. ** The purpose of this superclass is to define certain fields that are
  7162. ** common to all module implementations.
  7163. **
  7164. ** ^Virtual tables methods can set an error message by assigning a
  7165. ** string obtained from [sqlite3_mprintf()] to zErrMsg. The method should
  7166. ** take care that any prior string is freed by a call to [sqlite3_free()]
  7167. ** prior to assigning a new string to zErrMsg. ^After the error message
  7168. ** is delivered up to the client application, the string will be automatically
  7169. ** freed by sqlite3_free() and the zErrMsg field will be zeroed.
  7170. */
  7171. struct sqlite3_vtab {
  7172. const sqlite3_module *pModule; /* The module for this virtual table */
  7173. int nRef; /* Number of open cursors */
  7174. char *zErrMsg; /* Error message from sqlite3_mprintf() */
  7175. /* Virtual table implementations will typically add additional fields */
  7176. };
  7177. /*
  7178. ** CAPI3REF: Virtual Table Cursor Object
  7179. ** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
  7180. **
  7181. ** Every [virtual table module] implementation uses a subclass of the
  7182. ** following structure to describe cursors that point into the
  7183. ** [virtual table] and are used
  7184. ** to loop through the virtual table. Cursors are created using the
  7185. ** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
  7186. ** by the [sqlite3_module.xClose | xClose] method. Cursors are used
  7187. ** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
  7188. ** of the module. Each module implementation will define
  7189. ** the content of a cursor structure to suit its own needs.
  7190. **
  7191. ** This superclass exists in order to define fields of the cursor that
  7192. ** are common to all implementations.
  7193. */
  7194. struct sqlite3_vtab_cursor {
  7195. sqlite3_vtab *pVtab; /* Virtual table of this cursor */
  7196. /* Virtual table implementations will typically add additional fields */
  7197. };
  7198. /*
  7199. ** CAPI3REF: Declare The Schema Of A Virtual Table
  7200. **
  7201. ** ^The [xCreate] and [xConnect] methods of a
  7202. ** [virtual table module] call this interface
  7203. ** to declare the format (the names and datatypes of the columns) of
  7204. ** the virtual tables they implement.
  7205. */
  7206. SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);
  7207. /*
  7208. ** CAPI3REF: Overload A Function For A Virtual Table
  7209. ** METHOD: sqlite3
  7210. **
  7211. ** ^(Virtual tables can provide alternative implementations of functions
  7212. ** using the [xFindFunction] method of the [virtual table module].
  7213. ** But global versions of those functions
  7214. ** must exist in order to be overloaded.)^
  7215. **
  7216. ** ^(This API makes sure a global version of a function with a particular
  7217. ** name and number of parameters exists. If no such function exists
  7218. ** before this API is called, a new function is created.)^ ^The implementation
  7219. ** of the new function always causes an exception to be thrown. So
  7220. ** the new function is not good for anything by itself. Its only
  7221. ** purpose is to be a placeholder function that can be overloaded
  7222. ** by a [virtual table].
  7223. */
  7224. SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);
  7225. /*
  7226. ** The interface to the virtual-table mechanism defined above (back up
  7227. ** to a comment remarkably similar to this one) is currently considered
  7228. ** to be experimental. The interface might change in incompatible ways.
  7229. ** If this is a problem for you, do not use the interface at this time.
  7230. **
  7231. ** When the virtual-table mechanism stabilizes, we will declare the
  7232. ** interface fixed, support it indefinitely, and remove this comment.
  7233. */
  7234. /*
  7235. ** CAPI3REF: A Handle To An Open BLOB
  7236. ** KEYWORDS: {BLOB handle} {BLOB handles}
  7237. **
  7238. ** An instance of this object represents an open BLOB on which
  7239. ** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
  7240. ** ^Objects of this type are created by [sqlite3_blob_open()]
  7241. ** and destroyed by [sqlite3_blob_close()].
  7242. ** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
  7243. ** can be used to read or write small subsections of the BLOB.
  7244. ** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
  7245. */
  7246. typedef struct sqlite3_blob sqlite3_blob;
  7247. /*
  7248. ** CAPI3REF: Open A BLOB For Incremental I/O
  7249. ** METHOD: sqlite3
  7250. ** CONSTRUCTOR: sqlite3_blob
  7251. **
  7252. ** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
  7253. ** in row iRow, column zColumn, table zTable in database zDb;
  7254. ** in other words, the same BLOB that would be selected by:
  7255. **
  7256. ** <pre>
  7257. ** SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
  7258. ** </pre>)^
  7259. **
  7260. ** ^(Parameter zDb is not the filename that contains the database, but
  7261. ** rather the symbolic name of the database. For attached databases, this is
  7262. ** the name that appears after the AS keyword in the [ATTACH] statement.
  7263. ** For the main database file, the database name is "main". For TEMP
  7264. ** tables, the database name is "temp".)^
  7265. **
  7266. ** ^If the flags parameter is non-zero, then the BLOB is opened for read
  7267. ** and write access. ^If the flags parameter is zero, the BLOB is opened for
  7268. ** read-only access.
  7269. **
  7270. ** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is stored
  7271. ** in *ppBlob. Otherwise an [error code] is returned and, unless the error
  7272. ** code is SQLITE_MISUSE, *ppBlob is set to NULL.)^ ^This means that, provided
  7273. ** the API is not misused, it is always safe to call [sqlite3_blob_close()]
  7274. ** on *ppBlob after this function it returns.
  7275. **
  7276. ** This function fails with SQLITE_ERROR if any of the following are true:
  7277. ** <ul>
  7278. ** <li> ^(Database zDb does not exist)^,
  7279. ** <li> ^(Table zTable does not exist within database zDb)^,
  7280. ** <li> ^(Table zTable is a WITHOUT ROWID table)^,
  7281. ** <li> ^(Column zColumn does not exist)^,
  7282. ** <li> ^(Row iRow is not present in the table)^,
  7283. ** <li> ^(The specified column of row iRow contains a value that is not
  7284. ** a TEXT or BLOB value)^,
  7285. ** <li> ^(Column zColumn is part of an index, PRIMARY KEY or UNIQUE
  7286. ** constraint and the blob is being opened for read/write access)^,
  7287. ** <li> ^([foreign key constraints | Foreign key constraints] are enabled,
  7288. ** column zColumn is part of a [child key] definition and the blob is
  7289. ** being opened for read/write access)^.
  7290. ** </ul>
  7291. **
  7292. ** ^Unless it returns SQLITE_MISUSE, this function sets the
  7293. ** [database connection] error code and message accessible via
  7294. ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
  7295. **
  7296. ** A BLOB referenced by sqlite3_blob_open() may be read using the
  7297. ** [sqlite3_blob_read()] interface and modified by using
  7298. ** [sqlite3_blob_write()]. The [BLOB handle] can be moved to a
  7299. ** different row of the same table using the [sqlite3_blob_reopen()]
  7300. ** interface. However, the column, table, or database of a [BLOB handle]
  7301. ** cannot be changed after the [BLOB handle] is opened.
  7302. **
  7303. ** ^(If the row that a BLOB handle points to is modified by an
  7304. ** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
  7305. ** then the BLOB handle is marked as "expired".
  7306. ** This is true if any column of the row is changed, even a column
  7307. ** other than the one the BLOB handle is open on.)^
  7308. ** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
  7309. ** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
  7310. ** ^(Changes written into a BLOB prior to the BLOB expiring are not
  7311. ** rolled back by the expiration of the BLOB. Such changes will eventually
  7312. ** commit if the transaction continues to completion.)^
  7313. **
  7314. ** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
  7315. ** the opened blob. ^The size of a blob may not be changed by this
  7316. ** interface. Use the [UPDATE] SQL command to change the size of a
  7317. ** blob.
  7318. **
  7319. ** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
  7320. ** and the built-in [zeroblob] SQL function may be used to create a
  7321. ** zero-filled blob to read or write using the incremental-blob interface.
  7322. **
  7323. ** To avoid a resource leak, every open [BLOB handle] should eventually
  7324. ** be released by a call to [sqlite3_blob_close()].
  7325. **
  7326. ** See also: [sqlite3_blob_close()],
  7327. ** [sqlite3_blob_reopen()], [sqlite3_blob_read()],
  7328. ** [sqlite3_blob_bytes()], [sqlite3_blob_write()].
  7329. */
  7330. SQLITE_API int sqlite3_blob_open(
  7331. sqlite3*,
  7332. const char *zDb,
  7333. const char *zTable,
  7334. const char *zColumn,
  7335. sqlite3_int64 iRow,
  7336. int flags,
  7337. sqlite3_blob **ppBlob
  7338. );
  7339. /*
  7340. ** CAPI3REF: Move a BLOB Handle to a New Row
  7341. ** METHOD: sqlite3_blob
  7342. **
  7343. ** ^This function is used to move an existing [BLOB handle] so that it points
  7344. ** to a different row of the same database table. ^The new row is identified
  7345. ** by the rowid value passed as the second argument. Only the row can be
  7346. ** changed. ^The database, table and column on which the blob handle is open
  7347. ** remain the same. Moving an existing [BLOB handle] to a new row is
  7348. ** faster than closing the existing handle and opening a new one.
  7349. **
  7350. ** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
  7351. ** it must exist and there must be either a blob or text value stored in
  7352. ** the nominated column.)^ ^If the new row is not present in the table, or if
  7353. ** it does not contain a blob or text value, or if another error occurs, an
  7354. ** SQLite error code is returned and the blob handle is considered aborted.
  7355. ** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
  7356. ** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
  7357. ** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
  7358. ** always returns zero.
  7359. **
  7360. ** ^This function sets the database handle error code and message.
  7361. */
  7362. SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);
  7363. /*
  7364. ** CAPI3REF: Close A BLOB Handle
  7365. ** DESTRUCTOR: sqlite3_blob
  7366. **
  7367. ** ^This function closes an open [BLOB handle]. ^(The BLOB handle is closed
  7368. ** unconditionally. Even if this routine returns an error code, the
  7369. ** handle is still closed.)^
  7370. **
  7371. ** ^If the blob handle being closed was opened for read-write access, and if
  7372. ** the database is in auto-commit mode and there are no other open read-write
  7373. ** blob handles or active write statements, the current transaction is
  7374. ** committed. ^If an error occurs while committing the transaction, an error
  7375. ** code is returned and the transaction rolled back.
  7376. **
  7377. ** Calling this function with an argument that is not a NULL pointer or an
  7378. ** open blob handle results in undefined behaviour. ^Calling this routine
  7379. ** with a null pointer (such as would be returned by a failed call to
  7380. ** [sqlite3_blob_open()]) is a harmless no-op. ^Otherwise, if this function
  7381. ** is passed a valid open blob handle, the values returned by the
  7382. ** sqlite3_errcode() and sqlite3_errmsg() functions are set before returning.
  7383. */
  7384. SQLITE_API int sqlite3_blob_close(sqlite3_blob *);
  7385. /*
  7386. ** CAPI3REF: Return The Size Of An Open BLOB
  7387. ** METHOD: sqlite3_blob
  7388. **
  7389. ** ^Returns the size in bytes of the BLOB accessible via the
  7390. ** successfully opened [BLOB handle] in its only argument. ^The
  7391. ** incremental blob I/O routines can only read or overwriting existing
  7392. ** blob content; they cannot change the size of a blob.
  7393. **
  7394. ** This routine only works on a [BLOB handle] which has been created
  7395. ** by a prior successful call to [sqlite3_blob_open()] and which has not
  7396. ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
  7397. ** to this routine results in undefined and probably undesirable behavior.
  7398. */
  7399. SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);
  7400. /*
  7401. ** CAPI3REF: Read Data From A BLOB Incrementally
  7402. ** METHOD: sqlite3_blob
  7403. **
  7404. ** ^(This function is used to read data from an open [BLOB handle] into a
  7405. ** caller-supplied buffer. N bytes of data are copied into buffer Z
  7406. ** from the open BLOB, starting at offset iOffset.)^
  7407. **
  7408. ** ^If offset iOffset is less than N bytes from the end of the BLOB,
  7409. ** [SQLITE_ERROR] is returned and no data is read. ^If N or iOffset is
  7410. ** less than zero, [SQLITE_ERROR] is returned and no data is read.
  7411. ** ^The size of the blob (and hence the maximum value of N+iOffset)
  7412. ** can be determined using the [sqlite3_blob_bytes()] interface.
  7413. **
  7414. ** ^An attempt to read from an expired [BLOB handle] fails with an
  7415. ** error code of [SQLITE_ABORT].
  7416. **
  7417. ** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
  7418. ** Otherwise, an [error code] or an [extended error code] is returned.)^
  7419. **
  7420. ** This routine only works on a [BLOB handle] which has been created
  7421. ** by a prior successful call to [sqlite3_blob_open()] and which has not
  7422. ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
  7423. ** to this routine results in undefined and probably undesirable behavior.
  7424. **
  7425. ** See also: [sqlite3_blob_write()].
  7426. */
  7427. SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);
  7428. /*
  7429. ** CAPI3REF: Write Data Into A BLOB Incrementally
  7430. ** METHOD: sqlite3_blob
  7431. **
  7432. ** ^(This function is used to write data into an open [BLOB handle] from a
  7433. ** caller-supplied buffer. N bytes of data are copied from the buffer Z
  7434. ** into the open BLOB, starting at offset iOffset.)^
  7435. **
  7436. ** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
  7437. ** Otherwise, an [error code] or an [extended error code] is returned.)^
  7438. ** ^Unless SQLITE_MISUSE is returned, this function sets the
  7439. ** [database connection] error code and message accessible via
  7440. ** [sqlite3_errcode()] and [sqlite3_errmsg()] and related functions.
  7441. **
  7442. ** ^If the [BLOB handle] passed as the first argument was not opened for
  7443. ** writing (the flags parameter to [sqlite3_blob_open()] was zero),
  7444. ** this function returns [SQLITE_READONLY].
  7445. **
  7446. ** This function may only modify the contents of the BLOB; it is
  7447. ** not possible to increase the size of a BLOB using this API.
  7448. ** ^If offset iOffset is less than N bytes from the end of the BLOB,
  7449. ** [SQLITE_ERROR] is returned and no data is written. The size of the
  7450. ** BLOB (and hence the maximum value of N+iOffset) can be determined
  7451. ** using the [sqlite3_blob_bytes()] interface. ^If N or iOffset are less
  7452. ** than zero [SQLITE_ERROR] is returned and no data is written.
  7453. **
  7454. ** ^An attempt to write to an expired [BLOB handle] fails with an
  7455. ** error code of [SQLITE_ABORT]. ^Writes to the BLOB that occurred
  7456. ** before the [BLOB handle] expired are not rolled back by the
  7457. ** expiration of the handle, though of course those changes might
  7458. ** have been overwritten by the statement that expired the BLOB handle
  7459. ** or by other independent statements.
  7460. **
  7461. ** This routine only works on a [BLOB handle] which has been created
  7462. ** by a prior successful call to [sqlite3_blob_open()] and which has not
  7463. ** been closed by [sqlite3_blob_close()]. Passing any other pointer in
  7464. ** to this routine results in undefined and probably undesirable behavior.
  7465. **
  7466. ** See also: [sqlite3_blob_read()].
  7467. */
  7468. SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
  7469. /*
  7470. ** CAPI3REF: Virtual File System Objects
  7471. **
  7472. ** A virtual filesystem (VFS) is an [sqlite3_vfs] object
  7473. ** that SQLite uses to interact
  7474. ** with the underlying operating system. Most SQLite builds come with a
  7475. ** single default VFS that is appropriate for the host computer.
  7476. ** New VFSes can be registered and existing VFSes can be unregistered.
  7477. ** The following interfaces are provided.
  7478. **
  7479. ** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
  7480. ** ^Names are case sensitive.
  7481. ** ^Names are zero-terminated UTF-8 strings.
  7482. ** ^If there is no match, a NULL pointer is returned.
  7483. ** ^If zVfsName is NULL then the default VFS is returned.
  7484. **
  7485. ** ^New VFSes are registered with sqlite3_vfs_register().
  7486. ** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
  7487. ** ^The same VFS can be registered multiple times without injury.
  7488. ** ^To make an existing VFS into the default VFS, register it again
  7489. ** with the makeDflt flag set. If two different VFSes with the
  7490. ** same name are registered, the behavior is undefined. If a
  7491. ** VFS is registered with a name that is NULL or an empty string,
  7492. ** then the behavior is undefined.
  7493. **
  7494. ** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
  7495. ** ^(If the default VFS is unregistered, another VFS is chosen as
  7496. ** the default. The choice for the new VFS is arbitrary.)^
  7497. */
  7498. SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
  7499. SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
  7500. SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);
  7501. /*
  7502. ** CAPI3REF: Mutexes
  7503. **
  7504. ** The SQLite core uses these routines for thread
  7505. ** synchronization. Though they are intended for internal
  7506. ** use by SQLite, code that links against SQLite is
  7507. ** permitted to use any of these routines.
  7508. **
  7509. ** The SQLite source code contains multiple implementations
  7510. ** of these mutex routines. An appropriate implementation
  7511. ** is selected automatically at compile-time. The following
  7512. ** implementations are available in the SQLite core:
  7513. **
  7514. ** <ul>
  7515. ** <li> SQLITE_MUTEX_PTHREADS
  7516. ** <li> SQLITE_MUTEX_W32
  7517. ** <li> SQLITE_MUTEX_NOOP
  7518. ** </ul>
  7519. **
  7520. ** The SQLITE_MUTEX_NOOP implementation is a set of routines
  7521. ** that does no real locking and is appropriate for use in
  7522. ** a single-threaded application. The SQLITE_MUTEX_PTHREADS and
  7523. ** SQLITE_MUTEX_W32 implementations are appropriate for use on Unix
  7524. ** and Windows.
  7525. **
  7526. ** If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
  7527. ** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
  7528. ** implementation is included with the library. In this case the
  7529. ** application must supply a custom mutex implementation using the
  7530. ** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
  7531. ** before calling sqlite3_initialize() or any other public sqlite3_
  7532. ** function that calls sqlite3_initialize().
  7533. **
  7534. ** ^The sqlite3_mutex_alloc() routine allocates a new
  7535. ** mutex and returns a pointer to it. ^The sqlite3_mutex_alloc()
  7536. ** routine returns NULL if it is unable to allocate the requested
  7537. ** mutex. The argument to sqlite3_mutex_alloc() must one of these
  7538. ** integer constants:
  7539. **
  7540. ** <ul>
  7541. ** <li> SQLITE_MUTEX_FAST
  7542. ** <li> SQLITE_MUTEX_RECURSIVE
  7543. ** <li> SQLITE_MUTEX_STATIC_MASTER
  7544. ** <li> SQLITE_MUTEX_STATIC_MEM
  7545. ** <li> SQLITE_MUTEX_STATIC_OPEN
  7546. ** <li> SQLITE_MUTEX_STATIC_PRNG
  7547. ** <li> SQLITE_MUTEX_STATIC_LRU
  7548. ** <li> SQLITE_MUTEX_STATIC_PMEM
  7549. ** <li> SQLITE_MUTEX_STATIC_APP1
  7550. ** <li> SQLITE_MUTEX_STATIC_APP2
  7551. ** <li> SQLITE_MUTEX_STATIC_APP3
  7552. ** <li> SQLITE_MUTEX_STATIC_VFS1
  7553. ** <li> SQLITE_MUTEX_STATIC_VFS2
  7554. ** <li> SQLITE_MUTEX_STATIC_VFS3
  7555. ** </ul>
  7556. **
  7557. ** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
  7558. ** cause sqlite3_mutex_alloc() to create
  7559. ** a new mutex. ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
  7560. ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
  7561. ** The mutex implementation does not need to make a distinction
  7562. ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
  7563. ** not want to. SQLite will only request a recursive mutex in
  7564. ** cases where it really needs one. If a faster non-recursive mutex
  7565. ** implementation is available on the host platform, the mutex subsystem
  7566. ** might return such a mutex in response to SQLITE_MUTEX_FAST.
  7567. **
  7568. ** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
  7569. ** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
  7570. ** a pointer to a static preexisting mutex. ^Nine static mutexes are
  7571. ** used by the current version of SQLite. Future versions of SQLite
  7572. ** may add additional static mutexes. Static mutexes are for internal
  7573. ** use by SQLite only. Applications that use SQLite mutexes should
  7574. ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
  7575. ** SQLITE_MUTEX_RECURSIVE.
  7576. **
  7577. ** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
  7578. ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
  7579. ** returns a different mutex on every call. ^For the static
  7580. ** mutex types, the same mutex is returned on every call that has
  7581. ** the same type number.
  7582. **
  7583. ** ^The sqlite3_mutex_free() routine deallocates a previously
  7584. ** allocated dynamic mutex. Attempting to deallocate a static
  7585. ** mutex results in undefined behavior.
  7586. **
  7587. ** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  7588. ** to enter a mutex. ^If another thread is already within the mutex,
  7589. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  7590. ** SQLITE_BUSY. ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
  7591. ** upon successful entry. ^(Mutexes created using
  7592. ** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
  7593. ** In such cases, the
  7594. ** mutex must be exited an equal number of times before another thread
  7595. ** can enter.)^ If the same thread tries to enter any mutex other
  7596. ** than an SQLITE_MUTEX_RECURSIVE more than once, the behavior is undefined.
  7597. **
  7598. ** ^(Some systems (for example, Windows 95) do not support the operation
  7599. ** implemented by sqlite3_mutex_try(). On those systems, sqlite3_mutex_try()
  7600. ** will always return SQLITE_BUSY. The SQLite core only ever uses
  7601. ** sqlite3_mutex_try() as an optimization so this is acceptable
  7602. ** behavior.)^
  7603. **
  7604. ** ^The sqlite3_mutex_leave() routine exits a mutex that was
  7605. ** previously entered by the same thread. The behavior
  7606. ** is undefined if the mutex is not currently entered by the
  7607. ** calling thread or is not currently allocated.
  7608. **
  7609. ** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
  7610. ** sqlite3_mutex_leave() is a NULL pointer, then all three routines
  7611. ** behave as no-ops.
  7612. **
  7613. ** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
  7614. */
  7615. SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
  7616. SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
  7617. SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
  7618. SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
  7619. SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);
  7620. /*
  7621. ** CAPI3REF: Mutex Methods Object
  7622. **
  7623. ** An instance of this structure defines the low-level routines
  7624. ** used to allocate and use mutexes.
  7625. **
  7626. ** Usually, the default mutex implementations provided by SQLite are
  7627. ** sufficient, however the application has the option of substituting a custom
  7628. ** implementation for specialized deployments or systems for which SQLite
  7629. ** does not provide a suitable implementation. In this case, the application
  7630. ** creates and populates an instance of this structure to pass
  7631. ** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
  7632. ** Additionally, an instance of this structure can be used as an
  7633. ** output variable when querying the system for the current mutex
  7634. ** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
  7635. **
  7636. ** ^The xMutexInit method defined by this structure is invoked as
  7637. ** part of system initialization by the sqlite3_initialize() function.
  7638. ** ^The xMutexInit routine is called by SQLite exactly once for each
  7639. ** effective call to [sqlite3_initialize()].
  7640. **
  7641. ** ^The xMutexEnd method defined by this structure is invoked as
  7642. ** part of system shutdown by the sqlite3_shutdown() function. The
  7643. ** implementation of this method is expected to release all outstanding
  7644. ** resources obtained by the mutex methods implementation, especially
  7645. ** those obtained by the xMutexInit method. ^The xMutexEnd()
  7646. ** interface is invoked exactly once for each call to [sqlite3_shutdown()].
  7647. **
  7648. ** ^(The remaining seven methods defined by this structure (xMutexAlloc,
  7649. ** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
  7650. ** xMutexNotheld) implement the following interfaces (respectively):
  7651. **
  7652. ** <ul>
  7653. ** <li> [sqlite3_mutex_alloc()] </li>
  7654. ** <li> [sqlite3_mutex_free()] </li>
  7655. ** <li> [sqlite3_mutex_enter()] </li>
  7656. ** <li> [sqlite3_mutex_try()] </li>
  7657. ** <li> [sqlite3_mutex_leave()] </li>
  7658. ** <li> [sqlite3_mutex_held()] </li>
  7659. ** <li> [sqlite3_mutex_notheld()] </li>
  7660. ** </ul>)^
  7661. **
  7662. ** The only difference is that the public sqlite3_XXX functions enumerated
  7663. ** above silently ignore any invocations that pass a NULL pointer instead
  7664. ** of a valid mutex handle. The implementations of the methods defined
  7665. ** by this structure are not required to handle this case, the results
  7666. ** of passing a NULL pointer instead of a valid mutex handle are undefined
  7667. ** (i.e. it is acceptable to provide an implementation that segfaults if
  7668. ** it is passed a NULL pointer).
  7669. **
  7670. ** The xMutexInit() method must be threadsafe. It must be harmless to
  7671. ** invoke xMutexInit() multiple times within the same process and without
  7672. ** intervening calls to xMutexEnd(). Second and subsequent calls to
  7673. ** xMutexInit() must be no-ops.
  7674. **
  7675. ** xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
  7676. ** and its associates). Similarly, xMutexAlloc() must not use SQLite memory
  7677. ** allocation for a static mutex. ^However xMutexAlloc() may use SQLite
  7678. ** memory allocation for a fast or recursive mutex.
  7679. **
  7680. ** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
  7681. ** called, but only if the prior call to xMutexInit returned SQLITE_OK.
  7682. ** If xMutexInit fails in any way, it is expected to clean up after itself
  7683. ** prior to returning.
  7684. */
  7685. typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
  7686. struct sqlite3_mutex_methods {
  7687. int (*xMutexInit)(void);
  7688. int (*xMutexEnd)(void);
  7689. sqlite3_mutex *(*xMutexAlloc)(int);
  7690. void (*xMutexFree)(sqlite3_mutex *);
  7691. void (*xMutexEnter)(sqlite3_mutex *);
  7692. int (*xMutexTry)(sqlite3_mutex *);
  7693. void (*xMutexLeave)(sqlite3_mutex *);
  7694. int (*xMutexHeld)(sqlite3_mutex *);
  7695. int (*xMutexNotheld)(sqlite3_mutex *);
  7696. };
  7697. /*
  7698. ** CAPI3REF: Mutex Verification Routines
  7699. **
  7700. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
  7701. ** are intended for use inside assert() statements. The SQLite core
  7702. ** never uses these routines except inside an assert() and applications
  7703. ** are advised to follow the lead of the core. The SQLite core only
  7704. ** provides implementations for these routines when it is compiled
  7705. ** with the SQLITE_DEBUG flag. External mutex implementations
  7706. ** are only required to provide these routines if SQLITE_DEBUG is
  7707. ** defined and if NDEBUG is not defined.
  7708. **
  7709. ** These routines should return true if the mutex in their argument
  7710. ** is held or not held, respectively, by the calling thread.
  7711. **
  7712. ** The implementation is not required to provide versions of these
  7713. ** routines that actually work. If the implementation does not provide working
  7714. ** versions of these routines, it should at least provide stubs that always
  7715. ** return true so that one does not get spurious assertion failures.
  7716. **
  7717. ** If the argument to sqlite3_mutex_held() is a NULL pointer then
  7718. ** the routine should return 1. This seems counter-intuitive since
  7719. ** clearly the mutex cannot be held if it does not exist. But
  7720. ** the reason the mutex does not exist is because the build is not
  7721. ** using mutexes. And we do not want the assert() containing the
  7722. ** call to sqlite3_mutex_held() to fail, so a non-zero return is
  7723. ** the appropriate thing to do. The sqlite3_mutex_notheld()
  7724. ** interface should also return 1 when given a NULL pointer.
  7725. */
  7726. #ifndef NDEBUG
  7727. SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
  7728. SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
  7729. #endif
  7730. /*
  7731. ** CAPI3REF: Mutex Types
  7732. **
  7733. ** The [sqlite3_mutex_alloc()] interface takes a single argument
  7734. ** which is one of these integer constants.
  7735. **
  7736. ** The set of static mutexes may change from one SQLite release to the
  7737. ** next. Applications that override the built-in mutex logic must be
  7738. ** prepared to accommodate additional static mutexes.
  7739. */
  7740. #define SQLITE_MUTEX_FAST 0
  7741. #define SQLITE_MUTEX_RECURSIVE 1
  7742. #define SQLITE_MUTEX_STATIC_MASTER 2
  7743. #define SQLITE_MUTEX_STATIC_MEM 3 /* sqlite3_malloc() */
  7744. #define SQLITE_MUTEX_STATIC_MEM2 4 /* NOT USED */
  7745. #define SQLITE_MUTEX_STATIC_OPEN 4 /* sqlite3BtreeOpen() */
  7746. #define SQLITE_MUTEX_STATIC_PRNG 5 /* sqlite3_randomness() */
  7747. #define SQLITE_MUTEX_STATIC_LRU 6 /* lru page list */
  7748. #define SQLITE_MUTEX_STATIC_LRU2 7 /* NOT USED */
  7749. #define SQLITE_MUTEX_STATIC_PMEM 7 /* sqlite3PageMalloc() */
  7750. #define SQLITE_MUTEX_STATIC_APP1 8 /* For use by application */
  7751. #define SQLITE_MUTEX_STATIC_APP2 9 /* For use by application */
  7752. #define SQLITE_MUTEX_STATIC_APP3 10 /* For use by application */
  7753. #define SQLITE_MUTEX_STATIC_VFS1 11 /* For use by built-in VFS */
  7754. #define SQLITE_MUTEX_STATIC_VFS2 12 /* For use by extension VFS */
  7755. #define SQLITE_MUTEX_STATIC_VFS3 13 /* For use by application VFS */
  7756. /*
  7757. ** CAPI3REF: Retrieve the mutex for a database connection
  7758. ** METHOD: sqlite3
  7759. **
  7760. ** ^This interface returns a pointer the [sqlite3_mutex] object that
  7761. ** serializes access to the [database connection] given in the argument
  7762. ** when the [threading mode] is Serialized.
  7763. ** ^If the [threading mode] is Single-thread or Multi-thread then this
  7764. ** routine returns a NULL pointer.
  7765. */
  7766. SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);
  7767. /*
  7768. ** CAPI3REF: Low-Level Control Of Database Files
  7769. ** METHOD: sqlite3
  7770. **
  7771. ** ^The [sqlite3_file_control()] interface makes a direct call to the
  7772. ** xFileControl method for the [sqlite3_io_methods] object associated
  7773. ** with a particular database identified by the second argument. ^The
  7774. ** name of the database is "main" for the main database or "temp" for the
  7775. ** TEMP database, or the name that appears after the AS keyword for
  7776. ** databases that are added using the [ATTACH] SQL command.
  7777. ** ^A NULL pointer can be used in place of "main" to refer to the
  7778. ** main database file.
  7779. ** ^The third and fourth parameters to this routine
  7780. ** are passed directly through to the second and third parameters of
  7781. ** the xFileControl method. ^The return value of the xFileControl
  7782. ** method becomes the return value of this routine.
  7783. **
  7784. ** ^The [SQLITE_FCNTL_FILE_POINTER] value for the op parameter causes
  7785. ** a pointer to the underlying [sqlite3_file] object to be written into
  7786. ** the space pointed to by the 4th parameter. ^The [SQLITE_FCNTL_FILE_POINTER]
  7787. ** case is a short-circuit path which does not actually invoke the
  7788. ** underlying sqlite3_io_methods.xFileControl method.
  7789. **
  7790. ** ^If the second parameter (zDbName) does not match the name of any
  7791. ** open database file, then SQLITE_ERROR is returned. ^This error
  7792. ** code is not remembered and will not be recalled by [sqlite3_errcode()]
  7793. ** or [sqlite3_errmsg()]. The underlying xFileControl method might
  7794. ** also return SQLITE_ERROR. There is no way to distinguish between
  7795. ** an incorrect zDbName and an SQLITE_ERROR return from the underlying
  7796. ** xFileControl method.
  7797. **
  7798. ** See also: [file control opcodes]
  7799. */
  7800. SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
  7801. /*
  7802. ** CAPI3REF: Testing Interface
  7803. **
  7804. ** ^The sqlite3_test_control() interface is used to read out internal
  7805. ** state of SQLite and to inject faults into SQLite for testing
  7806. ** purposes. ^The first parameter is an operation code that determines
  7807. ** the number, meaning, and operation of all subsequent parameters.
  7808. **
  7809. ** This interface is not for use by applications. It exists solely
  7810. ** for verifying the correct operation of the SQLite library. Depending
  7811. ** on how the SQLite library is compiled, this interface might not exist.
  7812. **
  7813. ** The details of the operation codes, their meanings, the parameters
  7814. ** they take, and what they do are all subject to change without notice.
  7815. ** Unlike most of the SQLite API, this function is not guaranteed to
  7816. ** operate consistently from one release to the next.
  7817. */
  7818. SQLITE_API int sqlite3_test_control(int op, ...);
  7819. /*
  7820. ** CAPI3REF: Testing Interface Operation Codes
  7821. **
  7822. ** These constants are the valid operation code parameters used
  7823. ** as the first argument to [sqlite3_test_control()].
  7824. **
  7825. ** These parameters and their meanings are subject to change
  7826. ** without notice. These values are for testing purposes only.
  7827. ** Applications should not use any of these parameters or the
  7828. ** [sqlite3_test_control()] interface.
  7829. */
  7830. #define SQLITE_TESTCTRL_FIRST 5
  7831. #define SQLITE_TESTCTRL_PRNG_SAVE 5
  7832. #define SQLITE_TESTCTRL_PRNG_RESTORE 6
  7833. #define SQLITE_TESTCTRL_PRNG_RESET 7
  7834. #define SQLITE_TESTCTRL_BITVEC_TEST 8
  7835. #define SQLITE_TESTCTRL_FAULT_INSTALL 9
  7836. #define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS 10
  7837. #define SQLITE_TESTCTRL_PENDING_BYTE 11
  7838. #define SQLITE_TESTCTRL_ASSERT 12
  7839. #define SQLITE_TESTCTRL_ALWAYS 13
  7840. #define SQLITE_TESTCTRL_RESERVE 14
  7841. #define SQLITE_TESTCTRL_OPTIMIZATIONS 15
  7842. #define SQLITE_TESTCTRL_ISKEYWORD 16
  7843. #define SQLITE_TESTCTRL_SCRATCHMALLOC 17 /* NOT USED */
  7844. #define SQLITE_TESTCTRL_LOCALTIME_FAULT 18
  7845. #define SQLITE_TESTCTRL_EXPLAIN_STMT 19 /* NOT USED */
  7846. #define SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD 19
  7847. #define SQLITE_TESTCTRL_NEVER_CORRUPT 20
  7848. #define SQLITE_TESTCTRL_VDBE_COVERAGE 21
  7849. #define SQLITE_TESTCTRL_BYTEORDER 22
  7850. #define SQLITE_TESTCTRL_ISINIT 23
  7851. #define SQLITE_TESTCTRL_SORTER_MMAP 24
  7852. #define SQLITE_TESTCTRL_IMPOSTER 25
  7853. #define SQLITE_TESTCTRL_PARSER_COVERAGE 26
  7854. #define SQLITE_TESTCTRL_LAST 26 /* Largest TESTCTRL */
  7855. /*
  7856. ** CAPI3REF: SQLite Runtime Status
  7857. **
  7858. ** ^These interfaces are used to retrieve runtime status information
  7859. ** about the performance of SQLite, and optionally to reset various
  7860. ** highwater marks. ^The first argument is an integer code for
  7861. ** the specific parameter to measure. ^(Recognized integer codes
  7862. ** are of the form [status parameters | SQLITE_STATUS_...].)^
  7863. ** ^The current value of the parameter is returned into *pCurrent.
  7864. ** ^The highest recorded value is returned in *pHighwater. ^If the
  7865. ** resetFlag is true, then the highest record value is reset after
  7866. ** *pHighwater is written. ^(Some parameters do not record the highest
  7867. ** value. For those parameters
  7868. ** nothing is written into *pHighwater and the resetFlag is ignored.)^
  7869. ** ^(Other parameters record only the highwater mark and not the current
  7870. ** value. For these latter parameters nothing is written into *pCurrent.)^
  7871. **
  7872. ** ^The sqlite3_status() and sqlite3_status64() routines return
  7873. ** SQLITE_OK on success and a non-zero [error code] on failure.
  7874. **
  7875. ** If either the current value or the highwater mark is too large to
  7876. ** be represented by a 32-bit integer, then the values returned by
  7877. ** sqlite3_status() are undefined.
  7878. **
  7879. ** See also: [sqlite3_db_status()]
  7880. */
  7881. SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);
  7882. SQLITE_API int sqlite3_status64(
  7883. int op,
  7884. sqlite3_int64 *pCurrent,
  7885. sqlite3_int64 *pHighwater,
  7886. int resetFlag
  7887. );
  7888. /*
  7889. ** CAPI3REF: Status Parameters
  7890. ** KEYWORDS: {status parameters}
  7891. **
  7892. ** These integer constants designate various run-time status parameters
  7893. ** that can be returned by [sqlite3_status()].
  7894. **
  7895. ** <dl>
  7896. ** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
  7897. ** <dd>This parameter is the current amount of memory checked out
  7898. ** using [sqlite3_malloc()], either directly or indirectly. The
  7899. ** figure includes calls made to [sqlite3_malloc()] by the application
  7900. ** and internal memory usage by the SQLite library. Auxiliary page-cache
  7901. ** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
  7902. ** this parameter. The amount returned is the sum of the allocation
  7903. ** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
  7904. **
  7905. ** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
  7906. ** <dd>This parameter records the largest memory allocation request
  7907. ** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
  7908. ** internal equivalents). Only the value returned in the
  7909. ** *pHighwater parameter to [sqlite3_status()] is of interest.
  7910. ** The value written into the *pCurrent parameter is undefined.</dd>)^
  7911. **
  7912. ** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
  7913. ** <dd>This parameter records the number of separate memory allocations
  7914. ** currently checked out.</dd>)^
  7915. **
  7916. ** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
  7917. ** <dd>This parameter returns the number of pages used out of the
  7918. ** [pagecache memory allocator] that was configured using
  7919. ** [SQLITE_CONFIG_PAGECACHE]. The
  7920. ** value returned is in pages, not in bytes.</dd>)^
  7921. **
  7922. ** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]]
  7923. ** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
  7924. ** <dd>This parameter returns the number of bytes of page cache
  7925. ** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
  7926. ** buffer and where forced to overflow to [sqlite3_malloc()]. The
  7927. ** returned value includes allocations that overflowed because they
  7928. ** where too large (they were larger than the "sz" parameter to
  7929. ** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
  7930. ** no space was left in the page cache.</dd>)^
  7931. **
  7932. ** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
  7933. ** <dd>This parameter records the largest memory allocation request
  7934. ** handed to [pagecache memory allocator]. Only the value returned in the
  7935. ** *pHighwater parameter to [sqlite3_status()] is of interest.
  7936. ** The value written into the *pCurrent parameter is undefined.</dd>)^
  7937. **
  7938. ** [[SQLITE_STATUS_SCRATCH_USED]] <dt>SQLITE_STATUS_SCRATCH_USED</dt>
  7939. ** <dd>No longer used.</dd>
  7940. **
  7941. ** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
  7942. ** <dd>No longer used.</dd>
  7943. **
  7944. ** [[SQLITE_STATUS_SCRATCH_SIZE]] <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
  7945. ** <dd>No longer used.</dd>
  7946. **
  7947. ** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
  7948. ** <dd>The *pHighwater parameter records the deepest parser stack.
  7949. ** The *pCurrent value is undefined. The *pHighwater value is only
  7950. ** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
  7951. ** </dl>
  7952. **
  7953. ** New status parameters may be added from time to time.
  7954. */
  7955. #define SQLITE_STATUS_MEMORY_USED 0
  7956. #define SQLITE_STATUS_PAGECACHE_USED 1
  7957. #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
  7958. #define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */
  7959. #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */
  7960. #define SQLITE_STATUS_MALLOC_SIZE 5
  7961. #define SQLITE_STATUS_PARSER_STACK 6
  7962. #define SQLITE_STATUS_PAGECACHE_SIZE 7
  7963. #define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */
  7964. #define SQLITE_STATUS_MALLOC_COUNT 9
  7965. /*
  7966. ** CAPI3REF: Database Connection Status
  7967. ** METHOD: sqlite3
  7968. **
  7969. ** ^This interface is used to retrieve runtime status information
  7970. ** about a single [database connection]. ^The first argument is the
  7971. ** database connection object to be interrogated. ^The second argument
  7972. ** is an integer constant, taken from the set of
  7973. ** [SQLITE_DBSTATUS options], that
  7974. ** determines the parameter to interrogate. The set of
  7975. ** [SQLITE_DBSTATUS options] is likely
  7976. ** to grow in future releases of SQLite.
  7977. **
  7978. ** ^The current value of the requested parameter is written into *pCur
  7979. ** and the highest instantaneous value is written into *pHiwtr. ^If
  7980. ** the resetFlg is true, then the highest instantaneous value is
  7981. ** reset back down to the current value.
  7982. **
  7983. ** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
  7984. ** non-zero [error code] on failure.
  7985. **
  7986. ** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
  7987. */
  7988. SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);
  7989. /*
  7990. ** CAPI3REF: Status Parameters for database connections
  7991. ** KEYWORDS: {SQLITE_DBSTATUS options}
  7992. **
  7993. ** These constants are the available integer "verbs" that can be passed as
  7994. ** the second argument to the [sqlite3_db_status()] interface.
  7995. **
  7996. ** New verbs may be added in future releases of SQLite. Existing verbs
  7997. ** might be discontinued. Applications should check the return code from
  7998. ** [sqlite3_db_status()] to make sure that the call worked.
  7999. ** The [sqlite3_db_status()] interface will return a non-zero error code
  8000. ** if a discontinued or unsupported verb is invoked.
  8001. **
  8002. ** <dl>
  8003. ** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
  8004. ** <dd>This parameter returns the number of lookaside memory slots currently
  8005. ** checked out.</dd>)^
  8006. **
  8007. ** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
  8008. ** <dd>This parameter returns the number malloc attempts that were
  8009. ** satisfied using lookaside memory. Only the high-water value is meaningful;
  8010. ** the current value is always zero.)^
  8011. **
  8012. ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
  8013. ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
  8014. ** <dd>This parameter returns the number malloc attempts that might have
  8015. ** been satisfied using lookaside memory but failed due to the amount of
  8016. ** memory requested being larger than the lookaside slot size.
  8017. ** Only the high-water value is meaningful;
  8018. ** the current value is always zero.)^
  8019. **
  8020. ** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
  8021. ** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
  8022. ** <dd>This parameter returns the number malloc attempts that might have
  8023. ** been satisfied using lookaside memory but failed due to all lookaside
  8024. ** memory already being in use.
  8025. ** Only the high-water value is meaningful;
  8026. ** the current value is always zero.)^
  8027. **
  8028. ** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
  8029. ** <dd>This parameter returns the approximate number of bytes of heap
  8030. ** memory used by all pager caches associated with the database connection.)^
  8031. ** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
  8032. **
  8033. ** [[SQLITE_DBSTATUS_CACHE_USED_SHARED]]
  8034. ** ^(<dt>SQLITE_DBSTATUS_CACHE_USED_SHARED</dt>
  8035. ** <dd>This parameter is similar to DBSTATUS_CACHE_USED, except that if a
  8036. ** pager cache is shared between two or more connections the bytes of heap
  8037. ** memory used by that pager cache is divided evenly between the attached
  8038. ** connections.)^ In other words, if none of the pager caches associated
  8039. ** with the database connection are shared, this request returns the same
  8040. ** value as DBSTATUS_CACHE_USED. Or, if one or more or the pager caches are
  8041. ** shared, the value returned by this call will be smaller than that returned
  8042. ** by DBSTATUS_CACHE_USED. ^The highwater mark associated with
  8043. ** SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
  8044. **
  8045. ** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
  8046. ** <dd>This parameter returns the approximate number of bytes of heap
  8047. ** memory used to store the schema for all databases associated
  8048. ** with the connection - main, temp, and any [ATTACH]-ed databases.)^
  8049. ** ^The full amount of memory used by the schemas is reported, even if the
  8050. ** schema memory is shared with other database connections due to
  8051. ** [shared cache mode] being enabled.
  8052. ** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
  8053. **
  8054. ** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
  8055. ** <dd>This parameter returns the approximate number of bytes of heap
  8056. ** and lookaside memory used by all prepared statements associated with
  8057. ** the database connection.)^
  8058. ** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
  8059. ** </dd>
  8060. **
  8061. ** [[SQLITE_DBSTATUS_CACHE_HIT]] ^(<dt>SQLITE_DBSTATUS_CACHE_HIT</dt>
  8062. ** <dd>This parameter returns the number of pager cache hits that have
  8063. ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_HIT
  8064. ** is always 0.
  8065. ** </dd>
  8066. **
  8067. ** [[SQLITE_DBSTATUS_CACHE_MISS]] ^(<dt>SQLITE_DBSTATUS_CACHE_MISS</dt>
  8068. ** <dd>This parameter returns the number of pager cache misses that have
  8069. ** occurred.)^ ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_MISS
  8070. ** is always 0.
  8071. ** </dd>
  8072. **
  8073. ** [[SQLITE_DBSTATUS_CACHE_WRITE]] ^(<dt>SQLITE_DBSTATUS_CACHE_WRITE</dt>
  8074. ** <dd>This parameter returns the number of dirty cache entries that have
  8075. ** been written to disk. Specifically, the number of pages written to the
  8076. ** wal file in wal mode databases, or the number of pages written to the
  8077. ** database file in rollback mode databases. Any pages written as part of
  8078. ** transaction rollback or database recovery operations are not included.
  8079. ** If an IO or other error occurs while writing a page to disk, the effect
  8080. ** on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is undefined.)^ ^The
  8081. ** highwater mark associated with SQLITE_DBSTATUS_CACHE_WRITE is always 0.
  8082. ** </dd>
  8083. **
  8084. ** [[SQLITE_DBSTATUS_CACHE_SPILL]] ^(<dt>SQLITE_DBSTATUS_CACHE_SPILL</dt>
  8085. ** <dd>This parameter returns the number of dirty cache entries that have
  8086. ** been written to disk in the middle of a transaction due to the page
  8087. ** cache overflowing. Transactions are more efficient if they are written
  8088. ** to disk all at once. When pages spill mid-transaction, that introduces
  8089. ** additional overhead. This parameter can be used help identify
  8090. ** inefficiencies that can be resolve by increasing the cache size.
  8091. ** </dd>
  8092. **
  8093. ** [[SQLITE_DBSTATUS_DEFERRED_FKS]] ^(<dt>SQLITE_DBSTATUS_DEFERRED_FKS</dt>
  8094. ** <dd>This parameter returns zero for the current value if and only if
  8095. ** all foreign key constraints (deferred or immediate) have been
  8096. ** resolved.)^ ^The highwater mark is always 0.
  8097. ** </dd>
  8098. ** </dl>
  8099. */
  8100. #define SQLITE_DBSTATUS_LOOKASIDE_USED 0
  8101. #define SQLITE_DBSTATUS_CACHE_USED 1
  8102. #define SQLITE_DBSTATUS_SCHEMA_USED 2
  8103. #define SQLITE_DBSTATUS_STMT_USED 3
  8104. #define SQLITE_DBSTATUS_LOOKASIDE_HIT 4
  8105. #define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE 5
  8106. #define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL 6
  8107. #define SQLITE_DBSTATUS_CACHE_HIT 7
  8108. #define SQLITE_DBSTATUS_CACHE_MISS 8
  8109. #define SQLITE_DBSTATUS_CACHE_WRITE 9
  8110. #define SQLITE_DBSTATUS_DEFERRED_FKS 10
  8111. #define SQLITE_DBSTATUS_CACHE_USED_SHARED 11
  8112. #define SQLITE_DBSTATUS_CACHE_SPILL 12
  8113. #define SQLITE_DBSTATUS_MAX 12 /* Largest defined DBSTATUS */
  8114. /*
  8115. ** CAPI3REF: Prepared Statement Status
  8116. ** METHOD: sqlite3_stmt
  8117. **
  8118. ** ^(Each prepared statement maintains various
  8119. ** [SQLITE_STMTSTATUS counters] that measure the number
  8120. ** of times it has performed specific operations.)^ These counters can
  8121. ** be used to monitor the performance characteristics of the prepared
  8122. ** statements. For example, if the number of table steps greatly exceeds
  8123. ** the number of table searches or result rows, that would tend to indicate
  8124. ** that the prepared statement is using a full table scan rather than
  8125. ** an index.
  8126. **
  8127. ** ^(This interface is used to retrieve and reset counter values from
  8128. ** a [prepared statement]. The first argument is the prepared statement
  8129. ** object to be interrogated. The second argument
  8130. ** is an integer code for a specific [SQLITE_STMTSTATUS counter]
  8131. ** to be interrogated.)^
  8132. ** ^The current value of the requested counter is returned.
  8133. ** ^If the resetFlg is true, then the counter is reset to zero after this
  8134. ** interface call returns.
  8135. **
  8136. ** See also: [sqlite3_status()] and [sqlite3_db_status()].
  8137. */
  8138. SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);
  8139. /*
  8140. ** CAPI3REF: Status Parameters for prepared statements
  8141. ** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
  8142. **
  8143. ** These preprocessor macros define integer codes that name counter
  8144. ** values associated with the [sqlite3_stmt_status()] interface.
  8145. ** The meanings of the various counters are as follows:
  8146. **
  8147. ** <dl>
  8148. ** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
  8149. ** <dd>^This is the number of times that SQLite has stepped forward in
  8150. ** a table as part of a full table scan. Large numbers for this counter
  8151. ** may indicate opportunities for performance improvement through
  8152. ** careful use of indices.</dd>
  8153. **
  8154. ** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
  8155. ** <dd>^This is the number of sort operations that have occurred.
  8156. ** A non-zero value in this counter may indicate an opportunity to
  8157. ** improvement performance through careful use of indices.</dd>
  8158. **
  8159. ** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
  8160. ** <dd>^This is the number of rows inserted into transient indices that
  8161. ** were created automatically in order to help joins run faster.
  8162. ** A non-zero value in this counter may indicate an opportunity to
  8163. ** improvement performance by adding permanent indices that do not
  8164. ** need to be reinitialized each time the statement is run.</dd>
  8165. **
  8166. ** [[SQLITE_STMTSTATUS_VM_STEP]] <dt>SQLITE_STMTSTATUS_VM_STEP</dt>
  8167. ** <dd>^This is the number of virtual machine operations executed
  8168. ** by the prepared statement if that number is less than or equal
  8169. ** to 2147483647. The number of virtual machine operations can be
  8170. ** used as a proxy for the total work done by the prepared statement.
  8171. ** If the number of virtual machine operations exceeds 2147483647
  8172. ** then the value returned by this statement status code is undefined.
  8173. **
  8174. ** [[SQLITE_STMTSTATUS_REPREPARE]] <dt>SQLITE_STMTSTATUS_REPREPARE</dt>
  8175. ** <dd>^This is the number of times that the prepare statement has been
  8176. ** automatically regenerated due to schema changes or change to
  8177. ** [bound parameters] that might affect the query plan.
  8178. **
  8179. ** [[SQLITE_STMTSTATUS_RUN]] <dt>SQLITE_STMTSTATUS_RUN</dt>
  8180. ** <dd>^This is the number of times that the prepared statement has
  8181. ** been run. A single "run" for the purposes of this counter is one
  8182. ** or more calls to [sqlite3_step()] followed by a call to [sqlite3_reset()].
  8183. ** The counter is incremented on the first [sqlite3_step()] call of each
  8184. ** cycle.
  8185. **
  8186. ** [[SQLITE_STMTSTATUS_MEMUSED]] <dt>SQLITE_STMTSTATUS_MEMUSED</dt>
  8187. ** <dd>^This is the approximate number of bytes of heap memory
  8188. ** used to store the prepared statement. ^This value is not actually
  8189. ** a counter, and so the resetFlg parameter to sqlite3_stmt_status()
  8190. ** is ignored when the opcode is SQLITE_STMTSTATUS_MEMUSED.
  8191. ** </dd>
  8192. ** </dl>
  8193. */
  8194. #define SQLITE_STMTSTATUS_FULLSCAN_STEP 1
  8195. #define SQLITE_STMTSTATUS_SORT 2
  8196. #define SQLITE_STMTSTATUS_AUTOINDEX 3
  8197. #define SQLITE_STMTSTATUS_VM_STEP 4
  8198. #define SQLITE_STMTSTATUS_REPREPARE 5
  8199. #define SQLITE_STMTSTATUS_RUN 6
  8200. #define SQLITE_STMTSTATUS_MEMUSED 99
  8201. /*
  8202. ** CAPI3REF: Custom Page Cache Object
  8203. **
  8204. ** The sqlite3_pcache type is opaque. It is implemented by
  8205. ** the pluggable module. The SQLite core has no knowledge of
  8206. ** its size or internal structure and never deals with the
  8207. ** sqlite3_pcache object except by holding and passing pointers
  8208. ** to the object.
  8209. **
  8210. ** See [sqlite3_pcache_methods2] for additional information.
  8211. */
  8212. typedef struct sqlite3_pcache sqlite3_pcache;
  8213. /*
  8214. ** CAPI3REF: Custom Page Cache Object
  8215. **
  8216. ** The sqlite3_pcache_page object represents a single page in the
  8217. ** page cache. The page cache will allocate instances of this
  8218. ** object. Various methods of the page cache use pointers to instances
  8219. ** of this object as parameters or as their return value.
  8220. **
  8221. ** See [sqlite3_pcache_methods2] for additional information.
  8222. */
  8223. typedef struct sqlite3_pcache_page sqlite3_pcache_page;
  8224. struct sqlite3_pcache_page {
  8225. void *pBuf; /* The content of the page */
  8226. void *pExtra; /* Extra information associated with the page */
  8227. };
  8228. /*
  8229. ** CAPI3REF: Application Defined Page Cache.
  8230. ** KEYWORDS: {page cache}
  8231. **
  8232. ** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE2], ...) interface can
  8233. ** register an alternative page cache implementation by passing in an
  8234. ** instance of the sqlite3_pcache_methods2 structure.)^
  8235. ** In many applications, most of the heap memory allocated by
  8236. ** SQLite is used for the page cache.
  8237. ** By implementing a
  8238. ** custom page cache using this API, an application can better control
  8239. ** the amount of memory consumed by SQLite, the way in which
  8240. ** that memory is allocated and released, and the policies used to
  8241. ** determine exactly which parts of a database file are cached and for
  8242. ** how long.
  8243. **
  8244. ** The alternative page cache mechanism is an
  8245. ** extreme measure that is only needed by the most demanding applications.
  8246. ** The built-in page cache is recommended for most uses.
  8247. **
  8248. ** ^(The contents of the sqlite3_pcache_methods2 structure are copied to an
  8249. ** internal buffer by SQLite within the call to [sqlite3_config]. Hence
  8250. ** the application may discard the parameter after the call to
  8251. ** [sqlite3_config()] returns.)^
  8252. **
  8253. ** [[the xInit() page cache method]]
  8254. ** ^(The xInit() method is called once for each effective
  8255. ** call to [sqlite3_initialize()])^
  8256. ** (usually only once during the lifetime of the process). ^(The xInit()
  8257. ** method is passed a copy of the sqlite3_pcache_methods2.pArg value.)^
  8258. ** The intent of the xInit() method is to set up global data structures
  8259. ** required by the custom page cache implementation.
  8260. ** ^(If the xInit() method is NULL, then the
  8261. ** built-in default page cache is used instead of the application defined
  8262. ** page cache.)^
  8263. **
  8264. ** [[the xShutdown() page cache method]]
  8265. ** ^The xShutdown() method is called by [sqlite3_shutdown()].
  8266. ** It can be used to clean up
  8267. ** any outstanding resources before process shutdown, if required.
  8268. ** ^The xShutdown() method may be NULL.
  8269. **
  8270. ** ^SQLite automatically serializes calls to the xInit method,
  8271. ** so the xInit method need not be threadsafe. ^The
  8272. ** xShutdown method is only called from [sqlite3_shutdown()] so it does
  8273. ** not need to be threadsafe either. All other methods must be threadsafe
  8274. ** in multithreaded applications.
  8275. **
  8276. ** ^SQLite will never invoke xInit() more than once without an intervening
  8277. ** call to xShutdown().
  8278. **
  8279. ** [[the xCreate() page cache methods]]
  8280. ** ^SQLite invokes the xCreate() method to construct a new cache instance.
  8281. ** SQLite will typically create one cache instance for each open database file,
  8282. ** though this is not guaranteed. ^The
  8283. ** first parameter, szPage, is the size in bytes of the pages that must
  8284. ** be allocated by the cache. ^szPage will always a power of two. ^The
  8285. ** second parameter szExtra is a number of bytes of extra storage
  8286. ** associated with each page cache entry. ^The szExtra parameter will
  8287. ** a number less than 250. SQLite will use the
  8288. ** extra szExtra bytes on each page to store metadata about the underlying
  8289. ** database page on disk. The value passed into szExtra depends
  8290. ** on the SQLite version, the target platform, and how SQLite was compiled.
  8291. ** ^The third argument to xCreate(), bPurgeable, is true if the cache being
  8292. ** created will be used to cache database pages of a file stored on disk, or
  8293. ** false if it is used for an in-memory database. The cache implementation
  8294. ** does not have to do anything special based with the value of bPurgeable;
  8295. ** it is purely advisory. ^On a cache where bPurgeable is false, SQLite will
  8296. ** never invoke xUnpin() except to deliberately delete a page.
  8297. ** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
  8298. ** false will always have the "discard" flag set to true.
  8299. ** ^Hence, a cache created with bPurgeable false will
  8300. ** never contain any unpinned pages.
  8301. **
  8302. ** [[the xCachesize() page cache method]]
  8303. ** ^(The xCachesize() method may be called at any time by SQLite to set the
  8304. ** suggested maximum cache-size (number of pages stored by) the cache
  8305. ** instance passed as the first argument. This is the value configured using
  8306. ** the SQLite "[PRAGMA cache_size]" command.)^ As with the bPurgeable
  8307. ** parameter, the implementation is not required to do anything with this
  8308. ** value; it is advisory only.
  8309. **
  8310. ** [[the xPagecount() page cache methods]]
  8311. ** The xPagecount() method must return the number of pages currently
  8312. ** stored in the cache, both pinned and unpinned.
  8313. **
  8314. ** [[the xFetch() page cache methods]]
  8315. ** The xFetch() method locates a page in the cache and returns a pointer to
  8316. ** an sqlite3_pcache_page object associated with that page, or a NULL pointer.
  8317. ** The pBuf element of the returned sqlite3_pcache_page object will be a
  8318. ** pointer to a buffer of szPage bytes used to store the content of a
  8319. ** single database page. The pExtra element of sqlite3_pcache_page will be
  8320. ** a pointer to the szExtra bytes of extra storage that SQLite has requested
  8321. ** for each entry in the page cache.
  8322. **
  8323. ** The page to be fetched is determined by the key. ^The minimum key value
  8324. ** is 1. After it has been retrieved using xFetch, the page is considered
  8325. ** to be "pinned".
  8326. **
  8327. ** If the requested page is already in the page cache, then the page cache
  8328. ** implementation must return a pointer to the page buffer with its content
  8329. ** intact. If the requested page is not already in the cache, then the
  8330. ** cache implementation should use the value of the createFlag
  8331. ** parameter to help it determined what action to take:
  8332. **
  8333. ** <table border=1 width=85% align=center>
  8334. ** <tr><th> createFlag <th> Behavior when page is not already in cache
  8335. ** <tr><td> 0 <td> Do not allocate a new page. Return NULL.
  8336. ** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
  8337. ** Otherwise return NULL.
  8338. ** <tr><td> 2 <td> Make every effort to allocate a new page. Only return
  8339. ** NULL if allocating a new page is effectively impossible.
  8340. ** </table>
  8341. **
  8342. ** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1. SQLite
  8343. ** will only use a createFlag of 2 after a prior call with a createFlag of 1
  8344. ** failed.)^ In between the to xFetch() calls, SQLite may
  8345. ** attempt to unpin one or more cache pages by spilling the content of
  8346. ** pinned pages to disk and synching the operating system disk cache.
  8347. **
  8348. ** [[the xUnpin() page cache method]]
  8349. ** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
  8350. ** as its second argument. If the third parameter, discard, is non-zero,
  8351. ** then the page must be evicted from the cache.
  8352. ** ^If the discard parameter is
  8353. ** zero, then the page may be discarded or retained at the discretion of
  8354. ** page cache implementation. ^The page cache implementation
  8355. ** may choose to evict unpinned pages at any time.
  8356. **
  8357. ** The cache must not perform any reference counting. A single
  8358. ** call to xUnpin() unpins the page regardless of the number of prior calls
  8359. ** to xFetch().
  8360. **
  8361. ** [[the xRekey() page cache methods]]
  8362. ** The xRekey() method is used to change the key value associated with the
  8363. ** page passed as the second argument. If the cache
  8364. ** previously contains an entry associated with newKey, it must be
  8365. ** discarded. ^Any prior cache entry associated with newKey is guaranteed not
  8366. ** to be pinned.
  8367. **
  8368. ** When SQLite calls the xTruncate() method, the cache must discard all
  8369. ** existing cache entries with page numbers (keys) greater than or equal
  8370. ** to the value of the iLimit parameter passed to xTruncate(). If any
  8371. ** of these pages are pinned, they are implicitly unpinned, meaning that
  8372. ** they can be safely discarded.
  8373. **
  8374. ** [[the xDestroy() page cache method]]
  8375. ** ^The xDestroy() method is used to delete a cache allocated by xCreate().
  8376. ** All resources associated with the specified cache should be freed. ^After
  8377. ** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
  8378. ** handle invalid, and will not use it with any other sqlite3_pcache_methods2
  8379. ** functions.
  8380. **
  8381. ** [[the xShrink() page cache method]]
  8382. ** ^SQLite invokes the xShrink() method when it wants the page cache to
  8383. ** free up as much of heap memory as possible. The page cache implementation
  8384. ** is not obligated to free any memory, but well-behaved implementations should
  8385. ** do their best.
  8386. */
  8387. typedef struct sqlite3_pcache_methods2 sqlite3_pcache_methods2;
  8388. struct sqlite3_pcache_methods2 {
  8389. int iVersion;
  8390. void *pArg;
  8391. int (*xInit)(void*);
  8392. void (*xShutdown)(void*);
  8393. sqlite3_pcache *(*xCreate)(int szPage, int szExtra, int bPurgeable);
  8394. void (*xCachesize)(sqlite3_pcache*, int nCachesize);
  8395. int (*xPagecount)(sqlite3_pcache*);
  8396. sqlite3_pcache_page *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
  8397. void (*xUnpin)(sqlite3_pcache*, sqlite3_pcache_page*, int discard);
  8398. void (*xRekey)(sqlite3_pcache*, sqlite3_pcache_page*,
  8399. unsigned oldKey, unsigned newKey);
  8400. void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
  8401. void (*xDestroy)(sqlite3_pcache*);
  8402. void (*xShrink)(sqlite3_pcache*);
  8403. };
  8404. /*
  8405. ** This is the obsolete pcache_methods object that has now been replaced
  8406. ** by sqlite3_pcache_methods2. This object is not used by SQLite. It is
  8407. ** retained in the header file for backwards compatibility only.
  8408. */
  8409. typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
  8410. struct sqlite3_pcache_methods {
  8411. void *pArg;
  8412. int (*xInit)(void*);
  8413. void (*xShutdown)(void*);
  8414. sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
  8415. void (*xCachesize)(sqlite3_pcache*, int nCachesize);
  8416. int (*xPagecount)(sqlite3_pcache*);
  8417. void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
  8418. void (*xUnpin)(sqlite3_pcache*, void*, int discard);
  8419. void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
  8420. void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
  8421. void (*xDestroy)(sqlite3_pcache*);
  8422. };
  8423. /*
  8424. ** CAPI3REF: Online Backup Object
  8425. **
  8426. ** The sqlite3_backup object records state information about an ongoing
  8427. ** online backup operation. ^The sqlite3_backup object is created by
  8428. ** a call to [sqlite3_backup_init()] and is destroyed by a call to
  8429. ** [sqlite3_backup_finish()].
  8430. **
  8431. ** See Also: [Using the SQLite Online Backup API]
  8432. */
  8433. typedef struct sqlite3_backup sqlite3_backup;
  8434. /*
  8435. ** CAPI3REF: Online Backup API.
  8436. **
  8437. ** The backup API copies the content of one database into another.
  8438. ** It is useful either for creating backups of databases or
  8439. ** for copying in-memory databases to or from persistent files.
  8440. **
  8441. ** See Also: [Using the SQLite Online Backup API]
  8442. **
  8443. ** ^SQLite holds a write transaction open on the destination database file
  8444. ** for the duration of the backup operation.
  8445. ** ^The source database is read-locked only while it is being read;
  8446. ** it is not locked continuously for the entire backup operation.
  8447. ** ^Thus, the backup may be performed on a live source database without
  8448. ** preventing other database connections from
  8449. ** reading or writing to the source database while the backup is underway.
  8450. **
  8451. ** ^(To perform a backup operation:
  8452. ** <ol>
  8453. ** <li><b>sqlite3_backup_init()</b> is called once to initialize the
  8454. ** backup,
  8455. ** <li><b>sqlite3_backup_step()</b> is called one or more times to transfer
  8456. ** the data between the two databases, and finally
  8457. ** <li><b>sqlite3_backup_finish()</b> is called to release all resources
  8458. ** associated with the backup operation.
  8459. ** </ol>)^
  8460. ** There should be exactly one call to sqlite3_backup_finish() for each
  8461. ** successful call to sqlite3_backup_init().
  8462. **
  8463. ** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
  8464. **
  8465. ** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the
  8466. ** [database connection] associated with the destination database
  8467. ** and the database name, respectively.
  8468. ** ^The database name is "main" for the main database, "temp" for the
  8469. ** temporary database, or the name specified after the AS keyword in
  8470. ** an [ATTACH] statement for an attached database.
  8471. ** ^The S and M arguments passed to
  8472. ** sqlite3_backup_init(D,N,S,M) identify the [database connection]
  8473. ** and database name of the source database, respectively.
  8474. ** ^The source and destination [database connections] (parameters S and D)
  8475. ** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
  8476. ** an error.
  8477. **
  8478. ** ^A call to sqlite3_backup_init() will fail, returning NULL, if
  8479. ** there is already a read or read-write transaction open on the
  8480. ** destination database.
  8481. **
  8482. ** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
  8483. ** returned and an error code and error message are stored in the
  8484. ** destination [database connection] D.
  8485. ** ^The error code and message for the failed call to sqlite3_backup_init()
  8486. ** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
  8487. ** [sqlite3_errmsg16()] functions.
  8488. ** ^A successful call to sqlite3_backup_init() returns a pointer to an
  8489. ** [sqlite3_backup] object.
  8490. ** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
  8491. ** sqlite3_backup_finish() functions to perform the specified backup
  8492. ** operation.
  8493. **
  8494. ** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
  8495. **
  8496. ** ^Function sqlite3_backup_step(B,N) will copy up to N pages between
  8497. ** the source and destination databases specified by [sqlite3_backup] object B.
  8498. ** ^If N is negative, all remaining source pages are copied.
  8499. ** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
  8500. ** are still more pages to be copied, then the function returns [SQLITE_OK].
  8501. ** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
  8502. ** from source to destination, then it returns [SQLITE_DONE].
  8503. ** ^If an error occurs while running sqlite3_backup_step(B,N),
  8504. ** then an [error code] is returned. ^As well as [SQLITE_OK] and
  8505. ** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
  8506. ** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
  8507. ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
  8508. **
  8509. ** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
  8510. ** <ol>
  8511. ** <li> the destination database was opened read-only, or
  8512. ** <li> the destination database is using write-ahead-log journaling
  8513. ** and the destination and source page sizes differ, or
  8514. ** <li> the destination database is an in-memory database and the
  8515. ** destination and source page sizes differ.
  8516. ** </ol>)^
  8517. **
  8518. ** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
  8519. ** the [sqlite3_busy_handler | busy-handler function]
  8520. ** is invoked (if one is specified). ^If the
  8521. ** busy-handler returns non-zero before the lock is available, then
  8522. ** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
  8523. ** sqlite3_backup_step() can be retried later. ^If the source
  8524. ** [database connection]
  8525. ** is being used to write to the source database when sqlite3_backup_step()
  8526. ** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
  8527. ** case the call to sqlite3_backup_step() can be retried later on. ^(If
  8528. ** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
  8529. ** [SQLITE_READONLY] is returned, then
  8530. ** there is no point in retrying the call to sqlite3_backup_step(). These
  8531. ** errors are considered fatal.)^ The application must accept
  8532. ** that the backup operation has failed and pass the backup operation handle
  8533. ** to the sqlite3_backup_finish() to release associated resources.
  8534. **
  8535. ** ^The first call to sqlite3_backup_step() obtains an exclusive lock
  8536. ** on the destination file. ^The exclusive lock is not released until either
  8537. ** sqlite3_backup_finish() is called or the backup operation is complete
  8538. ** and sqlite3_backup_step() returns [SQLITE_DONE]. ^Every call to
  8539. ** sqlite3_backup_step() obtains a [shared lock] on the source database that
  8540. ** lasts for the duration of the sqlite3_backup_step() call.
  8541. ** ^Because the source database is not locked between calls to
  8542. ** sqlite3_backup_step(), the source database may be modified mid-way
  8543. ** through the backup process. ^If the source database is modified by an
  8544. ** external process or via a database connection other than the one being
  8545. ** used by the backup operation, then the backup will be automatically
  8546. ** restarted by the next call to sqlite3_backup_step(). ^If the source
  8547. ** database is modified by the using the same database connection as is used
  8548. ** by the backup operation, then the backup database is automatically
  8549. ** updated at the same time.
  8550. **
  8551. ** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
  8552. **
  8553. ** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the
  8554. ** application wishes to abandon the backup operation, the application
  8555. ** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
  8556. ** ^The sqlite3_backup_finish() interfaces releases all
  8557. ** resources associated with the [sqlite3_backup] object.
  8558. ** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
  8559. ** active write-transaction on the destination database is rolled back.
  8560. ** The [sqlite3_backup] object is invalid
  8561. ** and may not be used following a call to sqlite3_backup_finish().
  8562. **
  8563. ** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
  8564. ** sqlite3_backup_step() errors occurred, regardless or whether or not
  8565. ** sqlite3_backup_step() completed.
  8566. ** ^If an out-of-memory condition or IO error occurred during any prior
  8567. ** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
  8568. ** sqlite3_backup_finish() returns the corresponding [error code].
  8569. **
  8570. ** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
  8571. ** is not a permanent error and does not affect the return value of
  8572. ** sqlite3_backup_finish().
  8573. **
  8574. ** [[sqlite3_backup_remaining()]] [[sqlite3_backup_pagecount()]]
  8575. ** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
  8576. **
  8577. ** ^The sqlite3_backup_remaining() routine returns the number of pages still
  8578. ** to be backed up at the conclusion of the most recent sqlite3_backup_step().
  8579. ** ^The sqlite3_backup_pagecount() routine returns the total number of pages
  8580. ** in the source database at the conclusion of the most recent
  8581. ** sqlite3_backup_step().
  8582. ** ^(The values returned by these functions are only updated by
  8583. ** sqlite3_backup_step(). If the source database is modified in a way that
  8584. ** changes the size of the source database or the number of pages remaining,
  8585. ** those changes are not reflected in the output of sqlite3_backup_pagecount()
  8586. ** and sqlite3_backup_remaining() until after the next
  8587. ** sqlite3_backup_step().)^
  8588. **
  8589. ** <b>Concurrent Usage of Database Handles</b>
  8590. **
  8591. ** ^The source [database connection] may be used by the application for other
  8592. ** purposes while a backup operation is underway or being initialized.
  8593. ** ^If SQLite is compiled and configured to support threadsafe database
  8594. ** connections, then the source database connection may be used concurrently
  8595. ** from within other threads.
  8596. **
  8597. ** However, the application must guarantee that the destination
  8598. ** [database connection] is not passed to any other API (by any thread) after
  8599. ** sqlite3_backup_init() is called and before the corresponding call to
  8600. ** sqlite3_backup_finish(). SQLite does not currently check to see
  8601. ** if the application incorrectly accesses the destination [database connection]
  8602. ** and so no error code is reported, but the operations may malfunction
  8603. ** nevertheless. Use of the destination database connection while a
  8604. ** backup is in progress might also also cause a mutex deadlock.
  8605. **
  8606. ** If running in [shared cache mode], the application must
  8607. ** guarantee that the shared cache used by the destination database
  8608. ** is not accessed while the backup is running. In practice this means
  8609. ** that the application must guarantee that the disk file being
  8610. ** backed up to is not accessed by any connection within the process,
  8611. ** not just the specific connection that was passed to sqlite3_backup_init().
  8612. **
  8613. ** The [sqlite3_backup] object itself is partially threadsafe. Multiple
  8614. ** threads may safely make multiple concurrent calls to sqlite3_backup_step().
  8615. ** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
  8616. ** APIs are not strictly speaking threadsafe. If they are invoked at the
  8617. ** same time as another thread is invoking sqlite3_backup_step() it is
  8618. ** possible that they return invalid values.
  8619. */
  8620. SQLITE_API sqlite3_backup *sqlite3_backup_init(
  8621. sqlite3 *pDest, /* Destination database handle */
  8622. const char *zDestName, /* Destination database name */
  8623. sqlite3 *pSource, /* Source database handle */
  8624. const char *zSourceName /* Source database name */
  8625. );
  8626. SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
  8627. SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
  8628. SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
  8629. SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);
  8630. /*
  8631. ** CAPI3REF: Unlock Notification
  8632. ** METHOD: sqlite3
  8633. **
  8634. ** ^When running in shared-cache mode, a database operation may fail with
  8635. ** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
  8636. ** individual tables within the shared-cache cannot be obtained. See
  8637. ** [SQLite Shared-Cache Mode] for a description of shared-cache locking.
  8638. ** ^This API may be used to register a callback that SQLite will invoke
  8639. ** when the connection currently holding the required lock relinquishes it.
  8640. ** ^This API is only available if the library was compiled with the
  8641. ** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
  8642. **
  8643. ** See Also: [Using the SQLite Unlock Notification Feature].
  8644. **
  8645. ** ^Shared-cache locks are released when a database connection concludes
  8646. ** its current transaction, either by committing it or rolling it back.
  8647. **
  8648. ** ^When a connection (known as the blocked connection) fails to obtain a
  8649. ** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
  8650. ** identity of the database connection (the blocking connection) that
  8651. ** has locked the required resource is stored internally. ^After an
  8652. ** application receives an SQLITE_LOCKED error, it may call the
  8653. ** sqlite3_unlock_notify() method with the blocked connection handle as
  8654. ** the first argument to register for a callback that will be invoked
  8655. ** when the blocking connections current transaction is concluded. ^The
  8656. ** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
  8657. ** call that concludes the blocking connections transaction.
  8658. **
  8659. ** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
  8660. ** there is a chance that the blocking connection will have already
  8661. ** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
  8662. ** If this happens, then the specified callback is invoked immediately,
  8663. ** from within the call to sqlite3_unlock_notify().)^
  8664. **
  8665. ** ^If the blocked connection is attempting to obtain a write-lock on a
  8666. ** shared-cache table, and more than one other connection currently holds
  8667. ** a read-lock on the same table, then SQLite arbitrarily selects one of
  8668. ** the other connections to use as the blocking connection.
  8669. **
  8670. ** ^(There may be at most one unlock-notify callback registered by a
  8671. ** blocked connection. If sqlite3_unlock_notify() is called when the
  8672. ** blocked connection already has a registered unlock-notify callback,
  8673. ** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
  8674. ** called with a NULL pointer as its second argument, then any existing
  8675. ** unlock-notify callback is canceled. ^The blocked connections
  8676. ** unlock-notify callback may also be canceled by closing the blocked
  8677. ** connection using [sqlite3_close()].
  8678. **
  8679. ** The unlock-notify callback is not reentrant. If an application invokes
  8680. ** any sqlite3_xxx API functions from within an unlock-notify callback, a
  8681. ** crash or deadlock may be the result.
  8682. **
  8683. ** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
  8684. ** returns SQLITE_OK.
  8685. **
  8686. ** <b>Callback Invocation Details</b>
  8687. **
  8688. ** When an unlock-notify callback is registered, the application provides a
  8689. ** single void* pointer that is passed to the callback when it is invoked.
  8690. ** However, the signature of the callback function allows SQLite to pass
  8691. ** it an array of void* context pointers. The first argument passed to
  8692. ** an unlock-notify callback is a pointer to an array of void* pointers,
  8693. ** and the second is the number of entries in the array.
  8694. **
  8695. ** When a blocking connections transaction is concluded, there may be
  8696. ** more than one blocked connection that has registered for an unlock-notify
  8697. ** callback. ^If two or more such blocked connections have specified the
  8698. ** same callback function, then instead of invoking the callback function
  8699. ** multiple times, it is invoked once with the set of void* context pointers
  8700. ** specified by the blocked connections bundled together into an array.
  8701. ** This gives the application an opportunity to prioritize any actions
  8702. ** related to the set of unblocked database connections.
  8703. **
  8704. ** <b>Deadlock Detection</b>
  8705. **
  8706. ** Assuming that after registering for an unlock-notify callback a
  8707. ** database waits for the callback to be issued before taking any further
  8708. ** action (a reasonable assumption), then using this API may cause the
  8709. ** application to deadlock. For example, if connection X is waiting for
  8710. ** connection Y's transaction to be concluded, and similarly connection
  8711. ** Y is waiting on connection X's transaction, then neither connection
  8712. ** will proceed and the system may remain deadlocked indefinitely.
  8713. **
  8714. ** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
  8715. ** detection. ^If a given call to sqlite3_unlock_notify() would put the
  8716. ** system in a deadlocked state, then SQLITE_LOCKED is returned and no
  8717. ** unlock-notify callback is registered. The system is said to be in
  8718. ** a deadlocked state if connection A has registered for an unlock-notify
  8719. ** callback on the conclusion of connection B's transaction, and connection
  8720. ** B has itself registered for an unlock-notify callback when connection
  8721. ** A's transaction is concluded. ^Indirect deadlock is also detected, so
  8722. ** the system is also considered to be deadlocked if connection B has
  8723. ** registered for an unlock-notify callback on the conclusion of connection
  8724. ** C's transaction, where connection C is waiting on connection A. ^Any
  8725. ** number of levels of indirection are allowed.
  8726. **
  8727. ** <b>The "DROP TABLE" Exception</b>
  8728. **
  8729. ** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost
  8730. ** always appropriate to call sqlite3_unlock_notify(). There is however,
  8731. ** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
  8732. ** SQLite checks if there are any currently executing SELECT statements
  8733. ** that belong to the same connection. If there are, SQLITE_LOCKED is
  8734. ** returned. In this case there is no "blocking connection", so invoking
  8735. ** sqlite3_unlock_notify() results in the unlock-notify callback being
  8736. ** invoked immediately. If the application then re-attempts the "DROP TABLE"
  8737. ** or "DROP INDEX" query, an infinite loop might be the result.
  8738. **
  8739. ** One way around this problem is to check the extended error code returned
  8740. ** by an sqlite3_step() call. ^(If there is a blocking connection, then the
  8741. ** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
  8742. ** the special "DROP TABLE/INDEX" case, the extended error code is just
  8743. ** SQLITE_LOCKED.)^
  8744. */
  8745. SQLITE_API int sqlite3_unlock_notify(
  8746. sqlite3 *pBlocked, /* Waiting connection */
  8747. void (*xNotify)(void **apArg, int nArg), /* Callback function to invoke */
  8748. void *pNotifyArg /* Argument to pass to xNotify */
  8749. );
  8750. /*
  8751. ** CAPI3REF: String Comparison
  8752. **
  8753. ** ^The [sqlite3_stricmp()] and [sqlite3_strnicmp()] APIs allow applications
  8754. ** and extensions to compare the contents of two buffers containing UTF-8
  8755. ** strings in a case-independent fashion, using the same definition of "case
  8756. ** independence" that SQLite uses internally when comparing identifiers.
  8757. */
  8758. SQLITE_API int sqlite3_stricmp(const char *, const char *);
  8759. SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);
  8760. /*
  8761. ** CAPI3REF: String Globbing
  8762. *
  8763. ** ^The [sqlite3_strglob(P,X)] interface returns zero if and only if
  8764. ** string X matches the [GLOB] pattern P.
  8765. ** ^The definition of [GLOB] pattern matching used in
  8766. ** [sqlite3_strglob(P,X)] is the same as for the "X GLOB P" operator in the
  8767. ** SQL dialect understood by SQLite. ^The [sqlite3_strglob(P,X)] function
  8768. ** is case sensitive.
  8769. **
  8770. ** Note that this routine returns zero on a match and non-zero if the strings
  8771. ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
  8772. **
  8773. ** See also: [sqlite3_strlike()].
  8774. */
  8775. SQLITE_API int sqlite3_strglob(const char *zGlob, const char *zStr);
  8776. /*
  8777. ** CAPI3REF: String LIKE Matching
  8778. *
  8779. ** ^The [sqlite3_strlike(P,X,E)] interface returns zero if and only if
  8780. ** string X matches the [LIKE] pattern P with escape character E.
  8781. ** ^The definition of [LIKE] pattern matching used in
  8782. ** [sqlite3_strlike(P,X,E)] is the same as for the "X LIKE P ESCAPE E"
  8783. ** operator in the SQL dialect understood by SQLite. ^For "X LIKE P" without
  8784. ** the ESCAPE clause, set the E parameter of [sqlite3_strlike(P,X,E)] to 0.
  8785. ** ^As with the LIKE operator, the [sqlite3_strlike(P,X,E)] function is case
  8786. ** insensitive - equivalent upper and lower case ASCII characters match
  8787. ** one another.
  8788. **
  8789. ** ^The [sqlite3_strlike(P,X,E)] function matches Unicode characters, though
  8790. ** only ASCII characters are case folded.
  8791. **
  8792. ** Note that this routine returns zero on a match and non-zero if the strings
  8793. ** do not match, the same as [sqlite3_stricmp()] and [sqlite3_strnicmp()].
  8794. **
  8795. ** See also: [sqlite3_strglob()].
  8796. */
  8797. SQLITE_API int sqlite3_strlike(const char *zGlob, const char *zStr, unsigned int cEsc);
  8798. /*
  8799. ** CAPI3REF: Error Logging Interface
  8800. **
  8801. ** ^The [sqlite3_log()] interface writes a message into the [error log]
  8802. ** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
  8803. ** ^If logging is enabled, the zFormat string and subsequent arguments are
  8804. ** used with [sqlite3_snprintf()] to generate the final output string.
  8805. **
  8806. ** The sqlite3_log() interface is intended for use by extensions such as
  8807. ** virtual tables, collating functions, and SQL functions. While there is
  8808. ** nothing to prevent an application from calling sqlite3_log(), doing so
  8809. ** is considered bad form.
  8810. **
  8811. ** The zFormat string must not be NULL.
  8812. **
  8813. ** To avoid deadlocks and other threading problems, the sqlite3_log() routine
  8814. ** will not use dynamically allocated memory. The log message is stored in
  8815. ** a fixed-length buffer on the stack. If the log message is longer than
  8816. ** a few hundred characters, it will be truncated to the length of the
  8817. ** buffer.
  8818. */
  8819. SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);
  8820. /*
  8821. ** CAPI3REF: Write-Ahead Log Commit Hook
  8822. ** METHOD: sqlite3
  8823. **
  8824. ** ^The [sqlite3_wal_hook()] function is used to register a callback that
  8825. ** is invoked each time data is committed to a database in wal mode.
  8826. **
  8827. ** ^(The callback is invoked by SQLite after the commit has taken place and
  8828. ** the associated write-lock on the database released)^, so the implementation
  8829. ** may read, write or [checkpoint] the database as required.
  8830. **
  8831. ** ^The first parameter passed to the callback function when it is invoked
  8832. ** is a copy of the third parameter passed to sqlite3_wal_hook() when
  8833. ** registering the callback. ^The second is a copy of the database handle.
  8834. ** ^The third parameter is the name of the database that was written to -
  8835. ** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
  8836. ** is the number of pages currently in the write-ahead log file,
  8837. ** including those that were just committed.
  8838. **
  8839. ** The callback function should normally return [SQLITE_OK]. ^If an error
  8840. ** code is returned, that error will propagate back up through the
  8841. ** SQLite code base to cause the statement that provoked the callback
  8842. ** to report an error, though the commit will have still occurred. If the
  8843. ** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
  8844. ** that does not correspond to any valid SQLite error code, the results
  8845. ** are undefined.
  8846. **
  8847. ** A single database handle may have at most a single write-ahead log callback
  8848. ** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
  8849. ** previously registered write-ahead log callback. ^Note that the
  8850. ** [sqlite3_wal_autocheckpoint()] interface and the
  8851. ** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
  8852. ** overwrite any prior [sqlite3_wal_hook()] settings.
  8853. */
  8854. SQLITE_API void *sqlite3_wal_hook(
  8855. sqlite3*,
  8856. int(*)(void *,sqlite3*,const char*,int),
  8857. void*
  8858. );
  8859. /*
  8860. ** CAPI3REF: Configure an auto-checkpoint
  8861. ** METHOD: sqlite3
  8862. **
  8863. ** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
  8864. ** [sqlite3_wal_hook()] that causes any database on [database connection] D
  8865. ** to automatically [checkpoint]
  8866. ** after committing a transaction if there are N or
  8867. ** more frames in the [write-ahead log] file. ^Passing zero or
  8868. ** a negative value as the nFrame parameter disables automatic
  8869. ** checkpoints entirely.
  8870. **
  8871. ** ^The callback registered by this function replaces any existing callback
  8872. ** registered using [sqlite3_wal_hook()]. ^Likewise, registering a callback
  8873. ** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
  8874. ** configured by this function.
  8875. **
  8876. ** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
  8877. ** from SQL.
  8878. **
  8879. ** ^Checkpoints initiated by this mechanism are
  8880. ** [sqlite3_wal_checkpoint_v2|PASSIVE].
  8881. **
  8882. ** ^Every new [database connection] defaults to having the auto-checkpoint
  8883. ** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
  8884. ** pages. The use of this interface
  8885. ** is only necessary if the default setting is found to be suboptimal
  8886. ** for a particular application.
  8887. */
  8888. SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);
  8889. /*
  8890. ** CAPI3REF: Checkpoint a database
  8891. ** METHOD: sqlite3
  8892. **
  8893. ** ^(The sqlite3_wal_checkpoint(D,X) is equivalent to
  8894. ** [sqlite3_wal_checkpoint_v2](D,X,[SQLITE_CHECKPOINT_PASSIVE],0,0).)^
  8895. **
  8896. ** In brief, sqlite3_wal_checkpoint(D,X) causes the content in the
  8897. ** [write-ahead log] for database X on [database connection] D to be
  8898. ** transferred into the database file and for the write-ahead log to
  8899. ** be reset. See the [checkpointing] documentation for addition
  8900. ** information.
  8901. **
  8902. ** This interface used to be the only way to cause a checkpoint to
  8903. ** occur. But then the newer and more powerful [sqlite3_wal_checkpoint_v2()]
  8904. ** interface was added. This interface is retained for backwards
  8905. ** compatibility and as a convenience for applications that need to manually
  8906. ** start a callback but which do not need the full power (and corresponding
  8907. ** complication) of [sqlite3_wal_checkpoint_v2()].
  8908. */
  8909. SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);
  8910. /*
  8911. ** CAPI3REF: Checkpoint a database
  8912. ** METHOD: sqlite3
  8913. **
  8914. ** ^(The sqlite3_wal_checkpoint_v2(D,X,M,L,C) interface runs a checkpoint
  8915. ** operation on database X of [database connection] D in mode M. Status
  8916. ** information is written back into integers pointed to by L and C.)^
  8917. ** ^(The M parameter must be a valid [checkpoint mode]:)^
  8918. **
  8919. ** <dl>
  8920. ** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
  8921. ** ^Checkpoint as many frames as possible without waiting for any database
  8922. ** readers or writers to finish, then sync the database file if all frames
  8923. ** in the log were checkpointed. ^The [busy-handler callback]
  8924. ** is never invoked in the SQLITE_CHECKPOINT_PASSIVE mode.
  8925. ** ^On the other hand, passive mode might leave the checkpoint unfinished
  8926. ** if there are concurrent readers or writers.
  8927. **
  8928. ** <dt>SQLITE_CHECKPOINT_FULL<dd>
  8929. ** ^This mode blocks (it invokes the
  8930. ** [sqlite3_busy_handler|busy-handler callback]) until there is no
  8931. ** database writer and all readers are reading from the most recent database
  8932. ** snapshot. ^It then checkpoints all frames in the log file and syncs the
  8933. ** database file. ^This mode blocks new database writers while it is pending,
  8934. ** but new database readers are allowed to continue unimpeded.
  8935. **
  8936. ** <dt>SQLITE_CHECKPOINT_RESTART<dd>
  8937. ** ^This mode works the same way as SQLITE_CHECKPOINT_FULL with the addition
  8938. ** that after checkpointing the log file it blocks (calls the
  8939. ** [busy-handler callback])
  8940. ** until all readers are reading from the database file only. ^This ensures
  8941. ** that the next writer will restart the log file from the beginning.
  8942. ** ^Like SQLITE_CHECKPOINT_FULL, this mode blocks new
  8943. ** database writer attempts while it is pending, but does not impede readers.
  8944. **
  8945. ** <dt>SQLITE_CHECKPOINT_TRUNCATE<dd>
  8946. ** ^This mode works the same way as SQLITE_CHECKPOINT_RESTART with the
  8947. ** addition that it also truncates the log file to zero bytes just prior
  8948. ** to a successful return.
  8949. ** </dl>
  8950. **
  8951. ** ^If pnLog is not NULL, then *pnLog is set to the total number of frames in
  8952. ** the log file or to -1 if the checkpoint could not run because
  8953. ** of an error or because the database is not in [WAL mode]. ^If pnCkpt is not
  8954. ** NULL,then *pnCkpt is set to the total number of checkpointed frames in the
  8955. ** log file (including any that were already checkpointed before the function
  8956. ** was called) or to -1 if the checkpoint could not run due to an error or
  8957. ** because the database is not in WAL mode. ^Note that upon successful
  8958. ** completion of an SQLITE_CHECKPOINT_TRUNCATE, the log file will have been
  8959. ** truncated to zero bytes and so both *pnLog and *pnCkpt will be set to zero.
  8960. **
  8961. ** ^All calls obtain an exclusive "checkpoint" lock on the database file. ^If
  8962. ** any other process is running a checkpoint operation at the same time, the
  8963. ** lock cannot be obtained and SQLITE_BUSY is returned. ^Even if there is a
  8964. ** busy-handler configured, it will not be invoked in this case.
  8965. **
  8966. ** ^The SQLITE_CHECKPOINT_FULL, RESTART and TRUNCATE modes also obtain the
  8967. ** exclusive "writer" lock on the database file. ^If the writer lock cannot be
  8968. ** obtained immediately, and a busy-handler is configured, it is invoked and
  8969. ** the writer lock retried until either the busy-handler returns 0 or the lock
  8970. ** is successfully obtained. ^The busy-handler is also invoked while waiting for
  8971. ** database readers as described above. ^If the busy-handler returns 0 before
  8972. ** the writer lock is obtained or while waiting for database readers, the
  8973. ** checkpoint operation proceeds from that point in the same way as
  8974. ** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible
  8975. ** without blocking any further. ^SQLITE_BUSY is returned in this case.
  8976. **
  8977. ** ^If parameter zDb is NULL or points to a zero length string, then the
  8978. ** specified operation is attempted on all WAL databases [attached] to
  8979. ** [database connection] db. In this case the
  8980. ** values written to output parameters *pnLog and *pnCkpt are undefined. ^If
  8981. ** an SQLITE_BUSY error is encountered when processing one or more of the
  8982. ** attached WAL databases, the operation is still attempted on any remaining
  8983. ** attached databases and SQLITE_BUSY is returned at the end. ^If any other
  8984. ** error occurs while processing an attached database, processing is abandoned
  8985. ** and the error code is returned to the caller immediately. ^If no error
  8986. ** (SQLITE_BUSY or otherwise) is encountered while processing the attached
  8987. ** databases, SQLITE_OK is returned.
  8988. **
  8989. ** ^If database zDb is the name of an attached database that is not in WAL
  8990. ** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. ^If
  8991. ** zDb is not NULL (or a zero length string) and is not the name of any
  8992. ** attached database, SQLITE_ERROR is returned to the caller.
  8993. **
  8994. ** ^Unless it returns SQLITE_MISUSE,
  8995. ** the sqlite3_wal_checkpoint_v2() interface
  8996. ** sets the error information that is queried by
  8997. ** [sqlite3_errcode()] and [sqlite3_errmsg()].
  8998. **
  8999. ** ^The [PRAGMA wal_checkpoint] command can be used to invoke this interface
  9000. ** from SQL.
  9001. */
  9002. SQLITE_API int sqlite3_wal_checkpoint_v2(
  9003. sqlite3 *db, /* Database handle */
  9004. const char *zDb, /* Name of attached database (or NULL) */
  9005. int eMode, /* SQLITE_CHECKPOINT_* value */
  9006. int *pnLog, /* OUT: Size of WAL log in frames */
  9007. int *pnCkpt /* OUT: Total number of frames checkpointed */
  9008. );
  9009. /*
  9010. ** CAPI3REF: Checkpoint Mode Values
  9011. ** KEYWORDS: {checkpoint mode}
  9012. **
  9013. ** These constants define all valid values for the "checkpoint mode" passed
  9014. ** as the third parameter to the [sqlite3_wal_checkpoint_v2()] interface.
  9015. ** See the [sqlite3_wal_checkpoint_v2()] documentation for details on the
  9016. ** meaning of each of these checkpoint modes.
  9017. */
  9018. #define SQLITE_CHECKPOINT_PASSIVE 0 /* Do as much as possible w/o blocking */
  9019. #define SQLITE_CHECKPOINT_FULL 1 /* Wait for writers, then checkpoint */
  9020. #define SQLITE_CHECKPOINT_RESTART 2 /* Like FULL but wait for for readers */
  9021. #define SQLITE_CHECKPOINT_TRUNCATE 3 /* Like RESTART but also truncate WAL */
  9022. /*
  9023. ** CAPI3REF: Virtual Table Interface Configuration
  9024. **
  9025. ** This function may be called by either the [xConnect] or [xCreate] method
  9026. ** of a [virtual table] implementation to configure
  9027. ** various facets of the virtual table interface.
  9028. **
  9029. ** If this interface is invoked outside the context of an xConnect or
  9030. ** xCreate virtual table method then the behavior is undefined.
  9031. **
  9032. ** At present, there is only one option that may be configured using
  9033. ** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].) Further options
  9034. ** may be added in the future.
  9035. */
  9036. SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);
  9037. /*
  9038. ** CAPI3REF: Virtual Table Configuration Options
  9039. **
  9040. ** These macros define the various options to the
  9041. ** [sqlite3_vtab_config()] interface that [virtual table] implementations
  9042. ** can use to customize and optimize their behavior.
  9043. **
  9044. ** <dl>
  9045. ** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
  9046. ** <dd>Calls of the form
  9047. ** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
  9048. ** where X is an integer. If X is zero, then the [virtual table] whose
  9049. ** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
  9050. ** support constraints. In this configuration (which is the default) if
  9051. ** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
  9052. ** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
  9053. ** specified as part of the users SQL statement, regardless of the actual
  9054. ** ON CONFLICT mode specified.
  9055. **
  9056. ** If X is non-zero, then the virtual table implementation guarantees
  9057. ** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
  9058. ** any modifications to internal or persistent data structures have been made.
  9059. ** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite
  9060. ** is able to roll back a statement or database transaction, and abandon
  9061. ** or continue processing the current SQL statement as appropriate.
  9062. ** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
  9063. ** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
  9064. ** had been ABORT.
  9065. **
  9066. ** Virtual table implementations that are required to handle OR REPLACE
  9067. ** must do so within the [xUpdate] method. If a call to the
  9068. ** [sqlite3_vtab_on_conflict()] function indicates that the current ON
  9069. ** CONFLICT policy is REPLACE, the virtual table implementation should
  9070. ** silently replace the appropriate rows within the xUpdate callback and
  9071. ** return SQLITE_OK. Or, if this is not possible, it may return
  9072. ** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT
  9073. ** constraint handling.
  9074. ** </dl>
  9075. */
  9076. #define SQLITE_VTAB_CONSTRAINT_SUPPORT 1
  9077. /*
  9078. ** CAPI3REF: Determine The Virtual Table Conflict Policy
  9079. **
  9080. ** This function may only be called from within a call to the [xUpdate] method
  9081. ** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
  9082. ** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
  9083. ** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
  9084. ** of the SQL statement that triggered the call to the [xUpdate] method of the
  9085. ** [virtual table].
  9086. */
  9087. SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);
  9088. /*
  9089. ** CAPI3REF: Determine If Virtual Table Column Access Is For UPDATE
  9090. **
  9091. ** If the sqlite3_vtab_nochange(X) routine is called within the [xColumn]
  9092. ** method of a [virtual table], then it returns true if and only if the
  9093. ** column is being fetched as part of an UPDATE operation during which the
  9094. ** column value will not change. Applications might use this to substitute
  9095. ** a lighter-weight value to return that the corresponding [xUpdate] method
  9096. ** understands as a "no-change" value.
  9097. **
  9098. ** If the [xColumn] method calls sqlite3_vtab_nochange() and finds that
  9099. ** the column is not changed by the UPDATE statement, they the xColumn
  9100. ** method can optionally return without setting a result, without calling
  9101. ** any of the [sqlite3_result_int|sqlite3_result_xxxxx() interfaces].
  9102. ** In that case, [sqlite3_value_nochange(X)] will return true for the
  9103. ** same column in the [xUpdate] method.
  9104. */
  9105. SQLITE_API int sqlite3_vtab_nochange(sqlite3_context*);
  9106. /*
  9107. ** CAPI3REF: Determine The Collation For a Virtual Table Constraint
  9108. **
  9109. ** This function may only be called from within a call to the [xBestIndex]
  9110. ** method of a [virtual table].
  9111. **
  9112. ** The first argument must be the sqlite3_index_info object that is the
  9113. ** first parameter to the xBestIndex() method. The second argument must be
  9114. ** an index into the aConstraint[] array belonging to the sqlite3_index_info
  9115. ** structure passed to xBestIndex. This function returns a pointer to a buffer
  9116. ** containing the name of the collation sequence for the corresponding
  9117. ** constraint.
  9118. */
  9119. SQLITE_API SQLITE_EXPERIMENTAL const char *sqlite3_vtab_collation(sqlite3_index_info*,int);
  9120. /*
  9121. ** CAPI3REF: Conflict resolution modes
  9122. ** KEYWORDS: {conflict resolution mode}
  9123. **
  9124. ** These constants are returned by [sqlite3_vtab_on_conflict()] to
  9125. ** inform a [virtual table] implementation what the [ON CONFLICT] mode
  9126. ** is for the SQL statement being evaluated.
  9127. **
  9128. ** Note that the [SQLITE_IGNORE] constant is also used as a potential
  9129. ** return value from the [sqlite3_set_authorizer()] callback and that
  9130. ** [SQLITE_ABORT] is also a [result code].
  9131. */
  9132. #define SQLITE_ROLLBACK 1
  9133. /* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
  9134. #define SQLITE_FAIL 3
  9135. /* #define SQLITE_ABORT 4 // Also an error code */
  9136. #define SQLITE_REPLACE 5
  9137. /*
  9138. ** CAPI3REF: Prepared Statement Scan Status Opcodes
  9139. ** KEYWORDS: {scanstatus options}
  9140. **
  9141. ** The following constants can be used for the T parameter to the
  9142. ** [sqlite3_stmt_scanstatus(S,X,T,V)] interface. Each constant designates a
  9143. ** different metric for sqlite3_stmt_scanstatus() to return.
  9144. **
  9145. ** When the value returned to V is a string, space to hold that string is
  9146. ** managed by the prepared statement S and will be automatically freed when
  9147. ** S is finalized.
  9148. **
  9149. ** <dl>
  9150. ** [[SQLITE_SCANSTAT_NLOOP]] <dt>SQLITE_SCANSTAT_NLOOP</dt>
  9151. ** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be
  9152. ** set to the total number of times that the X-th loop has run.</dd>
  9153. **
  9154. ** [[SQLITE_SCANSTAT_NVISIT]] <dt>SQLITE_SCANSTAT_NVISIT</dt>
  9155. ** <dd>^The [sqlite3_int64] variable pointed to by the T parameter will be set
  9156. ** to the total number of rows examined by all iterations of the X-th loop.</dd>
  9157. **
  9158. ** [[SQLITE_SCANSTAT_EST]] <dt>SQLITE_SCANSTAT_EST</dt>
  9159. ** <dd>^The "double" variable pointed to by the T parameter will be set to the
  9160. ** query planner's estimate for the average number of rows output from each
  9161. ** iteration of the X-th loop. If the query planner's estimates was accurate,
  9162. ** then this value will approximate the quotient NVISIT/NLOOP and the
  9163. ** product of this value for all prior loops with the same SELECTID will
  9164. ** be the NLOOP value for the current loop.
  9165. **
  9166. ** [[SQLITE_SCANSTAT_NAME]] <dt>SQLITE_SCANSTAT_NAME</dt>
  9167. ** <dd>^The "const char *" variable pointed to by the T parameter will be set
  9168. ** to a zero-terminated UTF-8 string containing the name of the index or table
  9169. ** used for the X-th loop.
  9170. **
  9171. ** [[SQLITE_SCANSTAT_EXPLAIN]] <dt>SQLITE_SCANSTAT_EXPLAIN</dt>
  9172. ** <dd>^The "const char *" variable pointed to by the T parameter will be set
  9173. ** to a zero-terminated UTF-8 string containing the [EXPLAIN QUERY PLAN]
  9174. ** description for the X-th loop.
  9175. **
  9176. ** [[SQLITE_SCANSTAT_SELECTID]] <dt>SQLITE_SCANSTAT_SELECT</dt>
  9177. ** <dd>^The "int" variable pointed to by the T parameter will be set to the
  9178. ** "select-id" for the X-th loop. The select-id identifies which query or
  9179. ** subquery the loop is part of. The main query has a select-id of zero.
  9180. ** The select-id is the same value as is output in the first column
  9181. ** of an [EXPLAIN QUERY PLAN] query.
  9182. ** </dl>
  9183. */
  9184. #define SQLITE_SCANSTAT_NLOOP 0
  9185. #define SQLITE_SCANSTAT_NVISIT 1
  9186. #define SQLITE_SCANSTAT_EST 2
  9187. #define SQLITE_SCANSTAT_NAME 3
  9188. #define SQLITE_SCANSTAT_EXPLAIN 4
  9189. #define SQLITE_SCANSTAT_SELECTID 5
  9190. /*
  9191. ** CAPI3REF: Prepared Statement Scan Status
  9192. ** METHOD: sqlite3_stmt
  9193. **
  9194. ** This interface returns information about the predicted and measured
  9195. ** performance for pStmt. Advanced applications can use this
  9196. ** interface to compare the predicted and the measured performance and
  9197. ** issue warnings and/or rerun [ANALYZE] if discrepancies are found.
  9198. **
  9199. ** Since this interface is expected to be rarely used, it is only
  9200. ** available if SQLite is compiled using the [SQLITE_ENABLE_STMT_SCANSTATUS]
  9201. ** compile-time option.
  9202. **
  9203. ** The "iScanStatusOp" parameter determines which status information to return.
  9204. ** The "iScanStatusOp" must be one of the [scanstatus options] or the behavior
  9205. ** of this interface is undefined.
  9206. ** ^The requested measurement is written into a variable pointed to by
  9207. ** the "pOut" parameter.
  9208. ** Parameter "idx" identifies the specific loop to retrieve statistics for.
  9209. ** Loops are numbered starting from zero. ^If idx is out of range - less than
  9210. ** zero or greater than or equal to the total number of loops used to implement
  9211. ** the statement - a non-zero value is returned and the variable that pOut
  9212. ** points to is unchanged.
  9213. **
  9214. ** ^Statistics might not be available for all loops in all statements. ^In cases
  9215. ** where there exist loops with no available statistics, this function behaves
  9216. ** as if the loop did not exist - it returns non-zero and leave the variable
  9217. ** that pOut points to unchanged.
  9218. **
  9219. ** See also: [sqlite3_stmt_scanstatus_reset()]
  9220. */
  9221. SQLITE_API int sqlite3_stmt_scanstatus(
  9222. sqlite3_stmt *pStmt, /* Prepared statement for which info desired */
  9223. int idx, /* Index of loop to report on */
  9224. int iScanStatusOp, /* Information desired. SQLITE_SCANSTAT_* */
  9225. void *pOut /* Result written here */
  9226. );
  9227. /*
  9228. ** CAPI3REF: Zero Scan-Status Counters
  9229. ** METHOD: sqlite3_stmt
  9230. **
  9231. ** ^Zero all [sqlite3_stmt_scanstatus()] related event counters.
  9232. **
  9233. ** This API is only available if the library is built with pre-processor
  9234. ** symbol [SQLITE_ENABLE_STMT_SCANSTATUS] defined.
  9235. */
  9236. SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt*);
  9237. /*
  9238. ** CAPI3REF: Flush caches to disk mid-transaction
  9239. **
  9240. ** ^If a write-transaction is open on [database connection] D when the
  9241. ** [sqlite3_db_cacheflush(D)] interface invoked, any dirty
  9242. ** pages in the pager-cache that are not currently in use are written out
  9243. ** to disk. A dirty page may be in use if a database cursor created by an
  9244. ** active SQL statement is reading from it, or if it is page 1 of a database
  9245. ** file (page 1 is always "in use"). ^The [sqlite3_db_cacheflush(D)]
  9246. ** interface flushes caches for all schemas - "main", "temp", and
  9247. ** any [attached] databases.
  9248. **
  9249. ** ^If this function needs to obtain extra database locks before dirty pages
  9250. ** can be flushed to disk, it does so. ^If those locks cannot be obtained
  9251. ** immediately and there is a busy-handler callback configured, it is invoked
  9252. ** in the usual manner. ^If the required lock still cannot be obtained, then
  9253. ** the database is skipped and an attempt made to flush any dirty pages
  9254. ** belonging to the next (if any) database. ^If any databases are skipped
  9255. ** because locks cannot be obtained, but no other error occurs, this
  9256. ** function returns SQLITE_BUSY.
  9257. **
  9258. ** ^If any other error occurs while flushing dirty pages to disk (for
  9259. ** example an IO error or out-of-memory condition), then processing is
  9260. ** abandoned and an SQLite [error code] is returned to the caller immediately.
  9261. **
  9262. ** ^Otherwise, if no error occurs, [sqlite3_db_cacheflush()] returns SQLITE_OK.
  9263. **
  9264. ** ^This function does not set the database handle error code or message
  9265. ** returned by the [sqlite3_errcode()] and [sqlite3_errmsg()] functions.
  9266. */
  9267. SQLITE_API int sqlite3_db_cacheflush(sqlite3*);
  9268. /*
  9269. ** CAPI3REF: The pre-update hook.
  9270. **
  9271. ** ^These interfaces are only available if SQLite is compiled using the
  9272. ** [SQLITE_ENABLE_PREUPDATE_HOOK] compile-time option.
  9273. **
  9274. ** ^The [sqlite3_preupdate_hook()] interface registers a callback function
  9275. ** that is invoked prior to each [INSERT], [UPDATE], and [DELETE] operation
  9276. ** on a database table.
  9277. ** ^At most one preupdate hook may be registered at a time on a single
  9278. ** [database connection]; each call to [sqlite3_preupdate_hook()] overrides
  9279. ** the previous setting.
  9280. ** ^The preupdate hook is disabled by invoking [sqlite3_preupdate_hook()]
  9281. ** with a NULL pointer as the second parameter.
  9282. ** ^The third parameter to [sqlite3_preupdate_hook()] is passed through as
  9283. ** the first parameter to callbacks.
  9284. **
  9285. ** ^The preupdate hook only fires for changes to real database tables; the
  9286. ** preupdate hook is not invoked for changes to [virtual tables] or to
  9287. ** system tables like sqlite_master or sqlite_stat1.
  9288. **
  9289. ** ^The second parameter to the preupdate callback is a pointer to
  9290. ** the [database connection] that registered the preupdate hook.
  9291. ** ^The third parameter to the preupdate callback is one of the constants
  9292. ** [SQLITE_INSERT], [SQLITE_DELETE], or [SQLITE_UPDATE] to identify the
  9293. ** kind of update operation that is about to occur.
  9294. ** ^(The fourth parameter to the preupdate callback is the name of the
  9295. ** database within the database connection that is being modified. This
  9296. ** will be "main" for the main database or "temp" for TEMP tables or
  9297. ** the name given after the AS keyword in the [ATTACH] statement for attached
  9298. ** databases.)^
  9299. ** ^The fifth parameter to the preupdate callback is the name of the
  9300. ** table that is being modified.
  9301. **
  9302. ** For an UPDATE or DELETE operation on a [rowid table], the sixth
  9303. ** parameter passed to the preupdate callback is the initial [rowid] of the
  9304. ** row being modified or deleted. For an INSERT operation on a rowid table,
  9305. ** or any operation on a WITHOUT ROWID table, the value of the sixth
  9306. ** parameter is undefined. For an INSERT or UPDATE on a rowid table the
  9307. ** seventh parameter is the final rowid value of the row being inserted
  9308. ** or updated. The value of the seventh parameter passed to the callback
  9309. ** function is not defined for operations on WITHOUT ROWID tables, or for
  9310. ** INSERT operations on rowid tables.
  9311. **
  9312. ** The [sqlite3_preupdate_old()], [sqlite3_preupdate_new()],
  9313. ** [sqlite3_preupdate_count()], and [sqlite3_preupdate_depth()] interfaces
  9314. ** provide additional information about a preupdate event. These routines
  9315. ** may only be called from within a preupdate callback. Invoking any of
  9316. ** these routines from outside of a preupdate callback or with a
  9317. ** [database connection] pointer that is different from the one supplied
  9318. ** to the preupdate callback results in undefined and probably undesirable
  9319. ** behavior.
  9320. **
  9321. ** ^The [sqlite3_preupdate_count(D)] interface returns the number of columns
  9322. ** in the row that is being inserted, updated, or deleted.
  9323. **
  9324. ** ^The [sqlite3_preupdate_old(D,N,P)] interface writes into P a pointer to
  9325. ** a [protected sqlite3_value] that contains the value of the Nth column of
  9326. ** the table row before it is updated. The N parameter must be between 0
  9327. ** and one less than the number of columns or the behavior will be
  9328. ** undefined. This must only be used within SQLITE_UPDATE and SQLITE_DELETE
  9329. ** preupdate callbacks; if it is used by an SQLITE_INSERT callback then the
  9330. ** behavior is undefined. The [sqlite3_value] that P points to
  9331. ** will be destroyed when the preupdate callback returns.
  9332. **
  9333. ** ^The [sqlite3_preupdate_new(D,N,P)] interface writes into P a pointer to
  9334. ** a [protected sqlite3_value] that contains the value of the Nth column of
  9335. ** the table row after it is updated. The N parameter must be between 0
  9336. ** and one less than the number of columns or the behavior will be
  9337. ** undefined. This must only be used within SQLITE_INSERT and SQLITE_UPDATE
  9338. ** preupdate callbacks; if it is used by an SQLITE_DELETE callback then the
  9339. ** behavior is undefined. The [sqlite3_value] that P points to
  9340. ** will be destroyed when the preupdate callback returns.
  9341. **
  9342. ** ^The [sqlite3_preupdate_depth(D)] interface returns 0 if the preupdate
  9343. ** callback was invoked as a result of a direct insert, update, or delete
  9344. ** operation; or 1 for inserts, updates, or deletes invoked by top-level
  9345. ** triggers; or 2 for changes resulting from triggers called by top-level
  9346. ** triggers; and so forth.
  9347. **
  9348. ** See also: [sqlite3_update_hook()]
  9349. */
  9350. #if defined(SQLITE_ENABLE_PREUPDATE_HOOK)
  9351. SQLITE_API void *sqlite3_preupdate_hook(
  9352. sqlite3 *db,
  9353. void(*xPreUpdate)(
  9354. void *pCtx, /* Copy of third arg to preupdate_hook() */
  9355. sqlite3 *db, /* Database handle */
  9356. int op, /* SQLITE_UPDATE, DELETE or INSERT */
  9357. char const *zDb, /* Database name */
  9358. char const *zName, /* Table name */
  9359. sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
  9360. sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
  9361. ),
  9362. void*
  9363. );
  9364. SQLITE_API int sqlite3_preupdate_old(sqlite3 *, int, sqlite3_value **);
  9365. SQLITE_API int sqlite3_preupdate_count(sqlite3 *);
  9366. SQLITE_API int sqlite3_preupdate_depth(sqlite3 *);
  9367. SQLITE_API int sqlite3_preupdate_new(sqlite3 *, int, sqlite3_value **);
  9368. #endif
  9369. /*
  9370. ** CAPI3REF: Low-level system error code
  9371. **
  9372. ** ^Attempt to return the underlying operating system error code or error
  9373. ** number that caused the most recent I/O error or failure to open a file.
  9374. ** The return value is OS-dependent. For example, on unix systems, after
  9375. ** [sqlite3_open_v2()] returns [SQLITE_CANTOPEN], this interface could be
  9376. ** called to get back the underlying "errno" that caused the problem, such
  9377. ** as ENOSPC, EAUTH, EISDIR, and so forth.
  9378. */
  9379. SQLITE_API int sqlite3_system_errno(sqlite3*);
  9380. /*
  9381. ** CAPI3REF: Database Snapshot
  9382. ** KEYWORDS: {snapshot} {sqlite3_snapshot}
  9383. ** EXPERIMENTAL
  9384. **
  9385. ** An instance of the snapshot object records the state of a [WAL mode]
  9386. ** database for some specific point in history.
  9387. **
  9388. ** In [WAL mode], multiple [database connections] that are open on the
  9389. ** same database file can each be reading a different historical version
  9390. ** of the database file. When a [database connection] begins a read
  9391. ** transaction, that connection sees an unchanging copy of the database
  9392. ** as it existed for the point in time when the transaction first started.
  9393. ** Subsequent changes to the database from other connections are not seen
  9394. ** by the reader until a new read transaction is started.
  9395. **
  9396. ** The sqlite3_snapshot object records state information about an historical
  9397. ** version of the database file so that it is possible to later open a new read
  9398. ** transaction that sees that historical version of the database rather than
  9399. ** the most recent version.
  9400. **
  9401. ** The constructor for this object is [sqlite3_snapshot_get()]. The
  9402. ** [sqlite3_snapshot_open()] method causes a fresh read transaction to refer
  9403. ** to an historical snapshot (if possible). The destructor for
  9404. ** sqlite3_snapshot objects is [sqlite3_snapshot_free()].
  9405. */
  9406. typedef struct sqlite3_snapshot {
  9407. unsigned char hidden[48];
  9408. } sqlite3_snapshot;
  9409. /*
  9410. ** CAPI3REF: Record A Database Snapshot
  9411. ** EXPERIMENTAL
  9412. **
  9413. ** ^The [sqlite3_snapshot_get(D,S,P)] interface attempts to make a
  9414. ** new [sqlite3_snapshot] object that records the current state of
  9415. ** schema S in database connection D. ^On success, the
  9416. ** [sqlite3_snapshot_get(D,S,P)] interface writes a pointer to the newly
  9417. ** created [sqlite3_snapshot] object into *P and returns SQLITE_OK.
  9418. ** If there is not already a read-transaction open on schema S when
  9419. ** this function is called, one is opened automatically.
  9420. **
  9421. ** The following must be true for this function to succeed. If any of
  9422. ** the following statements are false when sqlite3_snapshot_get() is
  9423. ** called, SQLITE_ERROR is returned. The final value of *P is undefined
  9424. ** in this case.
  9425. **
  9426. ** <ul>
  9427. ** <li> The database handle must be in [autocommit mode].
  9428. **
  9429. ** <li> Schema S of [database connection] D must be a [WAL mode] database.
  9430. **
  9431. ** <li> There must not be a write transaction open on schema S of database
  9432. ** connection D.
  9433. **
  9434. ** <li> One or more transactions must have been written to the current wal
  9435. ** file since it was created on disk (by any connection). This means
  9436. ** that a snapshot cannot be taken on a wal mode database with no wal
  9437. ** file immediately after it is first opened. At least one transaction
  9438. ** must be written to it first.
  9439. ** </ul>
  9440. **
  9441. ** This function may also return SQLITE_NOMEM. If it is called with the
  9442. ** database handle in autocommit mode but fails for some other reason,
  9443. ** whether or not a read transaction is opened on schema S is undefined.
  9444. **
  9445. ** The [sqlite3_snapshot] object returned from a successful call to
  9446. ** [sqlite3_snapshot_get()] must be freed using [sqlite3_snapshot_free()]
  9447. ** to avoid a memory leak.
  9448. **
  9449. ** The [sqlite3_snapshot_get()] interface is only available when the
  9450. ** SQLITE_ENABLE_SNAPSHOT compile-time option is used.
  9451. */
  9452. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_get(
  9453. sqlite3 *db,
  9454. const char *zSchema,
  9455. sqlite3_snapshot **ppSnapshot
  9456. );
  9457. /*
  9458. ** CAPI3REF: Start a read transaction on an historical snapshot
  9459. ** EXPERIMENTAL
  9460. **
  9461. ** ^The [sqlite3_snapshot_open(D,S,P)] interface starts a
  9462. ** read transaction for schema S of
  9463. ** [database connection] D such that the read transaction
  9464. ** refers to historical [snapshot] P, rather than the most
  9465. ** recent change to the database.
  9466. ** ^The [sqlite3_snapshot_open()] interface returns SQLITE_OK on success
  9467. ** or an appropriate [error code] if it fails.
  9468. **
  9469. ** ^In order to succeed, a call to [sqlite3_snapshot_open(D,S,P)] must be
  9470. ** the first operation following the [BEGIN] that takes the schema S
  9471. ** out of [autocommit mode].
  9472. ** ^In other words, schema S must not currently be in
  9473. ** a transaction for [sqlite3_snapshot_open(D,S,P)] to work, but the
  9474. ** database connection D must be out of [autocommit mode].
  9475. ** ^A [snapshot] will fail to open if it has been overwritten by a
  9476. ** [checkpoint].
  9477. ** ^(A call to [sqlite3_snapshot_open(D,S,P)] will fail if the
  9478. ** database connection D does not know that the database file for
  9479. ** schema S is in [WAL mode]. A database connection might not know
  9480. ** that the database file is in [WAL mode] if there has been no prior
  9481. ** I/O on that database connection, or if the database entered [WAL mode]
  9482. ** after the most recent I/O on the database connection.)^
  9483. ** (Hint: Run "[PRAGMA application_id]" against a newly opened
  9484. ** database connection in order to make it ready to use snapshots.)
  9485. **
  9486. ** The [sqlite3_snapshot_open()] interface is only available when the
  9487. ** SQLITE_ENABLE_SNAPSHOT compile-time option is used.
  9488. */
  9489. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_open(
  9490. sqlite3 *db,
  9491. const char *zSchema,
  9492. sqlite3_snapshot *pSnapshot
  9493. );
  9494. /*
  9495. ** CAPI3REF: Destroy a snapshot
  9496. ** EXPERIMENTAL
  9497. **
  9498. ** ^The [sqlite3_snapshot_free(P)] interface destroys [sqlite3_snapshot] P.
  9499. ** The application must eventually free every [sqlite3_snapshot] object
  9500. ** using this routine to avoid a memory leak.
  9501. **
  9502. ** The [sqlite3_snapshot_free()] interface is only available when the
  9503. ** SQLITE_ENABLE_SNAPSHOT compile-time option is used.
  9504. */
  9505. SQLITE_API SQLITE_EXPERIMENTAL void sqlite3_snapshot_free(sqlite3_snapshot*);
  9506. /*
  9507. ** CAPI3REF: Compare the ages of two snapshot handles.
  9508. ** EXPERIMENTAL
  9509. **
  9510. ** The sqlite3_snapshot_cmp(P1, P2) interface is used to compare the ages
  9511. ** of two valid snapshot handles.
  9512. **
  9513. ** If the two snapshot handles are not associated with the same database
  9514. ** file, the result of the comparison is undefined.
  9515. **
  9516. ** Additionally, the result of the comparison is only valid if both of the
  9517. ** snapshot handles were obtained by calling sqlite3_snapshot_get() since the
  9518. ** last time the wal file was deleted. The wal file is deleted when the
  9519. ** database is changed back to rollback mode or when the number of database
  9520. ** clients drops to zero. If either snapshot handle was obtained before the
  9521. ** wal file was last deleted, the value returned by this function
  9522. ** is undefined.
  9523. **
  9524. ** Otherwise, this API returns a negative value if P1 refers to an older
  9525. ** snapshot than P2, zero if the two handles refer to the same database
  9526. ** snapshot, and a positive value if P1 is a newer snapshot than P2.
  9527. */
  9528. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_cmp(
  9529. sqlite3_snapshot *p1,
  9530. sqlite3_snapshot *p2
  9531. );
  9532. /*
  9533. ** CAPI3REF: Recover snapshots from a wal file
  9534. ** EXPERIMENTAL
  9535. **
  9536. ** If all connections disconnect from a database file but do not perform
  9537. ** a checkpoint, the existing wal file is opened along with the database
  9538. ** file the next time the database is opened. At this point it is only
  9539. ** possible to successfully call sqlite3_snapshot_open() to open the most
  9540. ** recent snapshot of the database (the one at the head of the wal file),
  9541. ** even though the wal file may contain other valid snapshots for which
  9542. ** clients have sqlite3_snapshot handles.
  9543. **
  9544. ** This function attempts to scan the wal file associated with database zDb
  9545. ** of database handle db and make all valid snapshots available to
  9546. ** sqlite3_snapshot_open(). It is an error if there is already a read
  9547. ** transaction open on the database, or if the database is not a wal mode
  9548. ** database.
  9549. **
  9550. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  9551. */
  9552. SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb);
  9553. /*
  9554. ** CAPI3REF: Serialize a database
  9555. **
  9556. ** The sqlite3_serialize(D,S,P,F) interface returns a pointer to memory
  9557. ** that is a serialization of the S database on [database connection] D.
  9558. ** If P is not a NULL pointer, then the size of the database in bytes
  9559. ** is written into *P.
  9560. **
  9561. ** For an ordinary on-disk database file, the serialization is just a
  9562. ** copy of the disk file. For an in-memory database or a "TEMP" database,
  9563. ** the serialization is the same sequence of bytes which would be written
  9564. ** to disk if that database where backed up to disk.
  9565. **
  9566. ** The usual case is that sqlite3_serialize() copies the serialization of
  9567. ** the database into memory obtained from [sqlite3_malloc64()] and returns
  9568. ** a pointer to that memory. The caller is responsible for freeing the
  9569. ** returned value to avoid a memory leak. However, if the F argument
  9570. ** contains the SQLITE_SERIALIZE_NOCOPY bit, then no memory allocations
  9571. ** are made, and the sqlite3_serialize() function will return a pointer
  9572. ** to the contiguous memory representation of the database that SQLite
  9573. ** is currently using for that database, or NULL if the no such contiguous
  9574. ** memory representation of the database exists. A contiguous memory
  9575. ** representation of the database will usually only exist if there has
  9576. ** been a prior call to [sqlite3_deserialize(D,S,...)] with the same
  9577. ** values of D and S.
  9578. ** The size of the database is written into *P even if the
  9579. ** SQLITE_SERIALIZE_NOCOPY bit is set but no contigious copy
  9580. ** of the database exists.
  9581. **
  9582. ** A call to sqlite3_serialize(D,S,P,F) might return NULL even if the
  9583. ** SQLITE_SERIALIZE_NOCOPY bit is omitted from argument F if a memory
  9584. ** allocation error occurs.
  9585. **
  9586. ** This interface is only available if SQLite is compiled with the
  9587. ** [SQLITE_ENABLE_DESERIALIZE] option.
  9588. */
  9589. SQLITE_API unsigned char *sqlite3_serialize(
  9590. sqlite3 *db, /* The database connection */
  9591. const char *zSchema, /* Which DB to serialize. ex: "main", "temp", ... */
  9592. sqlite3_int64 *piSize, /* Write size of the DB here, if not NULL */
  9593. unsigned int mFlags /* Zero or more SQLITE_SERIALIZE_* flags */
  9594. );
  9595. /*
  9596. ** CAPI3REF: Flags for sqlite3_serialize
  9597. **
  9598. ** Zero or more of the following constants can be OR-ed together for
  9599. ** the F argument to [sqlite3_serialize(D,S,P,F)].
  9600. **
  9601. ** SQLITE_SERIALIZE_NOCOPY means that [sqlite3_serialize()] will return
  9602. ** a pointer to contiguous in-memory database that it is currently using,
  9603. ** without making a copy of the database. If SQLite is not currently using
  9604. ** a contiguous in-memory database, then this option causes
  9605. ** [sqlite3_serialize()] to return a NULL pointer. SQLite will only be
  9606. ** using a contiguous in-memory database if it has been initialized by a
  9607. ** prior call to [sqlite3_deserialize()].
  9608. */
  9609. #define SQLITE_SERIALIZE_NOCOPY 0x001 /* Do no memory allocations */
  9610. /*
  9611. ** CAPI3REF: Deserialize a database
  9612. **
  9613. ** The sqlite3_deserialize(D,S,P,N,M,F) interface causes the
  9614. ** [database connection] D to disconnect from database S and then
  9615. ** reopen S as an in-memory database based on the serialization contained
  9616. ** in P. The serialized database P is N bytes in size. M is the size of
  9617. ** the buffer P, which might be larger than N. If M is larger than N, and
  9618. ** the SQLITE_DESERIALIZE_READONLY bit is not set in F, then SQLite is
  9619. ** permitted to add content to the in-memory database as long as the total
  9620. ** size does not exceed M bytes.
  9621. **
  9622. ** If the SQLITE_DESERIALIZE_FREEONCLOSE bit is set in F, then SQLite will
  9623. ** invoke sqlite3_free() on the serialization buffer when the database
  9624. ** connection closes. If the SQLITE_DESERIALIZE_RESIZEABLE bit is set, then
  9625. ** SQLite will try to increase the buffer size using sqlite3_realloc64()
  9626. ** if writes on the database cause it to grow larger than M bytes.
  9627. **
  9628. ** The sqlite3_deserialize() interface will fail with SQLITE_BUSY if the
  9629. ** database is currently in a read transaction or is involved in a backup
  9630. ** operation.
  9631. **
  9632. ** If sqlite3_deserialize(D,S,P,N,M,F) fails for any reason and if the
  9633. ** SQLITE_DESERIALIZE_FREEONCLOSE bit is set in argument F, then
  9634. ** [sqlite3_free()] is invoked on argument P prior to returning.
  9635. **
  9636. ** This interface is only available if SQLite is compiled with the
  9637. ** [SQLITE_ENABLE_DESERIALIZE] option.
  9638. */
  9639. SQLITE_API int sqlite3_deserialize(
  9640. sqlite3 *db, /* The database connection */
  9641. const char *zSchema, /* Which DB to reopen with the deserialization */
  9642. unsigned char *pData, /* The serialized database content */
  9643. sqlite3_int64 szDb, /* Number bytes in the deserialization */
  9644. sqlite3_int64 szBuf, /* Total size of buffer pData[] */
  9645. unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */
  9646. );
  9647. /*
  9648. ** CAPI3REF: Flags for sqlite3_deserialize()
  9649. **
  9650. ** The following are allowed values for 6th argument (the F argument) to
  9651. ** the [sqlite3_deserialize(D,S,P,N,M,F)] interface.
  9652. **
  9653. ** The SQLITE_DESERIALIZE_FREEONCLOSE means that the database serialization
  9654. ** in the P argument is held in memory obtained from [sqlite3_malloc64()]
  9655. ** and that SQLite should take ownership of this memory and automatically
  9656. ** free it when it has finished using it. Without this flag, the caller
  9657. ** is resposible for freeing any dynamically allocated memory.
  9658. **
  9659. ** The SQLITE_DESERIALIZE_RESIZEABLE flag means that SQLite is allowed to
  9660. ** grow the size of the database using calls to [sqlite3_realloc64()]. This
  9661. ** flag should only be used if SQLITE_DESERIALIZE_FREEONCLOSE is also used.
  9662. ** Without this flag, the deserialized database cannot increase in size beyond
  9663. ** the number of bytes specified by the M parameter.
  9664. **
  9665. ** The SQLITE_DESERIALIZE_READONLY flag means that the deserialized database
  9666. ** should be treated as read-only.
  9667. */
  9668. #define SQLITE_DESERIALIZE_FREEONCLOSE 1 /* Call sqlite3_free() on close */
  9669. #define SQLITE_DESERIALIZE_RESIZEABLE 2 /* Resize using sqlite3_realloc64() */
  9670. #define SQLITE_DESERIALIZE_READONLY 4 /* Database is read-only */
  9671. /*
  9672. ** Undo the hack that converts floating point types to integer for
  9673. ** builds on processors without floating point support.
  9674. */
  9675. #ifdef SQLITE_OMIT_FLOATING_POINT
  9676. # undef double
  9677. #endif
  9678. #if 0
  9679. } /* End of the 'extern "C"' block */
  9680. #endif
  9681. #endif /* SQLITE3_H */
  9682. /******** Begin file sqlite3rtree.h *********/
  9683. /*
  9684. ** 2010 August 30
  9685. **
  9686. ** The author disclaims copyright to this source code. In place of
  9687. ** a legal notice, here is a blessing:
  9688. **
  9689. ** May you do good and not evil.
  9690. ** May you find forgiveness for yourself and forgive others.
  9691. ** May you share freely, never taking more than you give.
  9692. **
  9693. *************************************************************************
  9694. */
  9695. #ifndef _SQLITE3RTREE_H_
  9696. #define _SQLITE3RTREE_H_
  9697. #if 0
  9698. extern "C" {
  9699. #endif
  9700. typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;
  9701. typedef struct sqlite3_rtree_query_info sqlite3_rtree_query_info;
  9702. /* The double-precision datatype used by RTree depends on the
  9703. ** SQLITE_RTREE_INT_ONLY compile-time option.
  9704. */
  9705. #ifdef SQLITE_RTREE_INT_ONLY
  9706. typedef sqlite3_int64 sqlite3_rtree_dbl;
  9707. #else
  9708. typedef double sqlite3_rtree_dbl;
  9709. #endif
  9710. /*
  9711. ** Register a geometry callback named zGeom that can be used as part of an
  9712. ** R-Tree geometry query as follows:
  9713. **
  9714. ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
  9715. */
  9716. SQLITE_API int sqlite3_rtree_geometry_callback(
  9717. sqlite3 *db,
  9718. const char *zGeom,
  9719. int (*xGeom)(sqlite3_rtree_geometry*, int, sqlite3_rtree_dbl*,int*),
  9720. void *pContext
  9721. );
  9722. /*
  9723. ** A pointer to a structure of the following type is passed as the first
  9724. ** argument to callbacks registered using rtree_geometry_callback().
  9725. */
  9726. struct sqlite3_rtree_geometry {
  9727. void *pContext; /* Copy of pContext passed to s_r_g_c() */
  9728. int nParam; /* Size of array aParam[] */
  9729. sqlite3_rtree_dbl *aParam; /* Parameters passed to SQL geom function */
  9730. void *pUser; /* Callback implementation user data */
  9731. void (*xDelUser)(void *); /* Called by SQLite to clean up pUser */
  9732. };
  9733. /*
  9734. ** Register a 2nd-generation geometry callback named zScore that can be
  9735. ** used as part of an R-Tree geometry query as follows:
  9736. **
  9737. ** SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zQueryFunc(... params ...)
  9738. */
  9739. SQLITE_API int sqlite3_rtree_query_callback(
  9740. sqlite3 *db,
  9741. const char *zQueryFunc,
  9742. int (*xQueryFunc)(sqlite3_rtree_query_info*),
  9743. void *pContext,
  9744. void (*xDestructor)(void*)
  9745. );
  9746. /*
  9747. ** A pointer to a structure of the following type is passed as the
  9748. ** argument to scored geometry callback registered using
  9749. ** sqlite3_rtree_query_callback().
  9750. **
  9751. ** Note that the first 5 fields of this structure are identical to
  9752. ** sqlite3_rtree_geometry. This structure is a subclass of
  9753. ** sqlite3_rtree_geometry.
  9754. */
  9755. struct sqlite3_rtree_query_info {
  9756. void *pContext; /* pContext from when function registered */
  9757. int nParam; /* Number of function parameters */
  9758. sqlite3_rtree_dbl *aParam; /* value of function parameters */
  9759. void *pUser; /* callback can use this, if desired */
  9760. void (*xDelUser)(void*); /* function to free pUser */
  9761. sqlite3_rtree_dbl *aCoord; /* Coordinates of node or entry to check */
  9762. unsigned int *anQueue; /* Number of pending entries in the queue */
  9763. int nCoord; /* Number of coordinates */
  9764. int iLevel; /* Level of current node or entry */
  9765. int mxLevel; /* The largest iLevel value in the tree */
  9766. sqlite3_int64 iRowid; /* Rowid for current entry */
  9767. sqlite3_rtree_dbl rParentScore; /* Score of parent node */
  9768. int eParentWithin; /* Visibility of parent node */
  9769. int eWithin; /* OUT: Visiblity */
  9770. sqlite3_rtree_dbl rScore; /* OUT: Write the score here */
  9771. /* The following fields are only available in 3.8.11 and later */
  9772. sqlite3_value **apSqlParam; /* Original SQL values of parameters */
  9773. };
  9774. /*
  9775. ** Allowed values for sqlite3_rtree_query.eWithin and .eParentWithin.
  9776. */
  9777. #define NOT_WITHIN 0 /* Object completely outside of query region */
  9778. #define PARTLY_WITHIN 1 /* Object partially overlaps query region */
  9779. #define FULLY_WITHIN 2 /* Object fully contained within query region */
  9780. #if 0
  9781. } /* end of the 'extern "C"' block */
  9782. #endif
  9783. #endif /* ifndef _SQLITE3RTREE_H_ */
  9784. /******** End of sqlite3rtree.h *********/
  9785. /******** Begin file sqlite3session.h *********/
  9786. #if !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION)
  9787. #define __SQLITESESSION_H_ 1
  9788. /*
  9789. ** Make sure we can call this stuff from C++.
  9790. */
  9791. #if 0
  9792. extern "C" {
  9793. #endif
  9794. /*
  9795. ** CAPI3REF: Session Object Handle
  9796. **
  9797. ** An instance of this object is a [session] that can be used to
  9798. ** record changes to a database.
  9799. */
  9800. typedef struct sqlite3_session sqlite3_session;
  9801. /*
  9802. ** CAPI3REF: Changeset Iterator Handle
  9803. **
  9804. ** An instance of this object acts as a cursor for iterating
  9805. ** over the elements of a [changeset] or [patchset].
  9806. */
  9807. typedef struct sqlite3_changeset_iter sqlite3_changeset_iter;
  9808. /*
  9809. ** CAPI3REF: Create A New Session Object
  9810. ** CONSTRUCTOR: sqlite3_session
  9811. **
  9812. ** Create a new session object attached to database handle db. If successful,
  9813. ** a pointer to the new object is written to *ppSession and SQLITE_OK is
  9814. ** returned. If an error occurs, *ppSession is set to NULL and an SQLite
  9815. ** error code (e.g. SQLITE_NOMEM) is returned.
  9816. **
  9817. ** It is possible to create multiple session objects attached to a single
  9818. ** database handle.
  9819. **
  9820. ** Session objects created using this function should be deleted using the
  9821. ** [sqlite3session_delete()] function before the database handle that they
  9822. ** are attached to is itself closed. If the database handle is closed before
  9823. ** the session object is deleted, then the results of calling any session
  9824. ** module function, including [sqlite3session_delete()] on the session object
  9825. ** are undefined.
  9826. **
  9827. ** Because the session module uses the [sqlite3_preupdate_hook()] API, it
  9828. ** is not possible for an application to register a pre-update hook on a
  9829. ** database handle that has one or more session objects attached. Nor is
  9830. ** it possible to create a session object attached to a database handle for
  9831. ** which a pre-update hook is already defined. The results of attempting
  9832. ** either of these things are undefined.
  9833. **
  9834. ** The session object will be used to create changesets for tables in
  9835. ** database zDb, where zDb is either "main", or "temp", or the name of an
  9836. ** attached database. It is not an error if database zDb is not attached
  9837. ** to the database when the session object is created.
  9838. */
  9839. SQLITE_API int sqlite3session_create(
  9840. sqlite3 *db, /* Database handle */
  9841. const char *zDb, /* Name of db (e.g. "main") */
  9842. sqlite3_session **ppSession /* OUT: New session object */
  9843. );
  9844. /*
  9845. ** CAPI3REF: Delete A Session Object
  9846. ** DESTRUCTOR: sqlite3_session
  9847. **
  9848. ** Delete a session object previously allocated using
  9849. ** [sqlite3session_create()]. Once a session object has been deleted, the
  9850. ** results of attempting to use pSession with any other session module
  9851. ** function are undefined.
  9852. **
  9853. ** Session objects must be deleted before the database handle to which they
  9854. ** are attached is closed. Refer to the documentation for
  9855. ** [sqlite3session_create()] for details.
  9856. */
  9857. SQLITE_API void sqlite3session_delete(sqlite3_session *pSession);
  9858. /*
  9859. ** CAPI3REF: Enable Or Disable A Session Object
  9860. ** METHOD: sqlite3_session
  9861. **
  9862. ** Enable or disable the recording of changes by a session object. When
  9863. ** enabled, a session object records changes made to the database. When
  9864. ** disabled - it does not. A newly created session object is enabled.
  9865. ** Refer to the documentation for [sqlite3session_changeset()] for further
  9866. ** details regarding how enabling and disabling a session object affects
  9867. ** the eventual changesets.
  9868. **
  9869. ** Passing zero to this function disables the session. Passing a value
  9870. ** greater than zero enables it. Passing a value less than zero is a
  9871. ** no-op, and may be used to query the current state of the session.
  9872. **
  9873. ** The return value indicates the final state of the session object: 0 if
  9874. ** the session is disabled, or 1 if it is enabled.
  9875. */
  9876. SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable);
  9877. /*
  9878. ** CAPI3REF: Set Or Clear the Indirect Change Flag
  9879. ** METHOD: sqlite3_session
  9880. **
  9881. ** Each change recorded by a session object is marked as either direct or
  9882. ** indirect. A change is marked as indirect if either:
  9883. **
  9884. ** <ul>
  9885. ** <li> The session object "indirect" flag is set when the change is
  9886. ** made, or
  9887. ** <li> The change is made by an SQL trigger or foreign key action
  9888. ** instead of directly as a result of a users SQL statement.
  9889. ** </ul>
  9890. **
  9891. ** If a single row is affected by more than one operation within a session,
  9892. ** then the change is considered indirect if all operations meet the criteria
  9893. ** for an indirect change above, or direct otherwise.
  9894. **
  9895. ** This function is used to set, clear or query the session object indirect
  9896. ** flag. If the second argument passed to this function is zero, then the
  9897. ** indirect flag is cleared. If it is greater than zero, the indirect flag
  9898. ** is set. Passing a value less than zero does not modify the current value
  9899. ** of the indirect flag, and may be used to query the current state of the
  9900. ** indirect flag for the specified session object.
  9901. **
  9902. ** The return value indicates the final state of the indirect flag: 0 if
  9903. ** it is clear, or 1 if it is set.
  9904. */
  9905. SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect);
  9906. /*
  9907. ** CAPI3REF: Attach A Table To A Session Object
  9908. ** METHOD: sqlite3_session
  9909. **
  9910. ** If argument zTab is not NULL, then it is the name of a table to attach
  9911. ** to the session object passed as the first argument. All subsequent changes
  9912. ** made to the table while the session object is enabled will be recorded. See
  9913. ** documentation for [sqlite3session_changeset()] for further details.
  9914. **
  9915. ** Or, if argument zTab is NULL, then changes are recorded for all tables
  9916. ** in the database. If additional tables are added to the database (by
  9917. ** executing "CREATE TABLE" statements) after this call is made, changes for
  9918. ** the new tables are also recorded.
  9919. **
  9920. ** Changes can only be recorded for tables that have a PRIMARY KEY explicitly
  9921. ** defined as part of their CREATE TABLE statement. It does not matter if the
  9922. ** PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias) or not. The PRIMARY
  9923. ** KEY may consist of a single column, or may be a composite key.
  9924. **
  9925. ** It is not an error if the named table does not exist in the database. Nor
  9926. ** is it an error if the named table does not have a PRIMARY KEY. However,
  9927. ** no changes will be recorded in either of these scenarios.
  9928. **
  9929. ** Changes are not recorded for individual rows that have NULL values stored
  9930. ** in one or more of their PRIMARY KEY columns.
  9931. **
  9932. ** SQLITE_OK is returned if the call completes without error. Or, if an error
  9933. ** occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
  9934. **
  9935. ** <h3>Special sqlite_stat1 Handling</h3>
  9936. **
  9937. ** As of SQLite version 3.22.0, the "sqlite_stat1" table is an exception to
  9938. ** some of the rules above. In SQLite, the schema of sqlite_stat1 is:
  9939. ** <pre>
  9940. ** &nbsp; CREATE TABLE sqlite_stat1(tbl,idx,stat)
  9941. ** </pre>
  9942. **
  9943. ** Even though sqlite_stat1 does not have a PRIMARY KEY, changes are
  9944. ** recorded for it as if the PRIMARY KEY is (tbl,idx). Additionally, changes
  9945. ** are recorded for rows for which (idx IS NULL) is true. However, for such
  9946. ** rows a zero-length blob (SQL value X'') is stored in the changeset or
  9947. ** patchset instead of a NULL value. This allows such changesets to be
  9948. ** manipulated by legacy implementations of sqlite3changeset_invert(),
  9949. ** concat() and similar.
  9950. **
  9951. ** The sqlite3changeset_apply() function automatically converts the
  9952. ** zero-length blob back to a NULL value when updating the sqlite_stat1
  9953. ** table. However, if the application calls sqlite3changeset_new(),
  9954. ** sqlite3changeset_old() or sqlite3changeset_conflict on a changeset
  9955. ** iterator directly (including on a changeset iterator passed to a
  9956. ** conflict-handler callback) then the X'' value is returned. The application
  9957. ** must translate X'' to NULL itself if required.
  9958. **
  9959. ** Legacy (older than 3.22.0) versions of the sessions module cannot capture
  9960. ** changes made to the sqlite_stat1 table. Legacy versions of the
  9961. ** sqlite3changeset_apply() function silently ignore any modifications to the
  9962. ** sqlite_stat1 table that are part of a changeset or patchset.
  9963. */
  9964. SQLITE_API int sqlite3session_attach(
  9965. sqlite3_session *pSession, /* Session object */
  9966. const char *zTab /* Table name */
  9967. );
  9968. /*
  9969. ** CAPI3REF: Set a table filter on a Session Object.
  9970. ** METHOD: sqlite3_session
  9971. **
  9972. ** The second argument (xFilter) is the "filter callback". For changes to rows
  9973. ** in tables that are not attached to the Session object, the filter is called
  9974. ** to determine whether changes to the table's rows should be tracked or not.
  9975. ** If xFilter returns 0, changes is not tracked. Note that once a table is
  9976. ** attached, xFilter will not be called again.
  9977. */
  9978. SQLITE_API void sqlite3session_table_filter(
  9979. sqlite3_session *pSession, /* Session object */
  9980. int(*xFilter)(
  9981. void *pCtx, /* Copy of third arg to _filter_table() */
  9982. const char *zTab /* Table name */
  9983. ),
  9984. void *pCtx /* First argument passed to xFilter */
  9985. );
  9986. /*
  9987. ** CAPI3REF: Generate A Changeset From A Session Object
  9988. ** METHOD: sqlite3_session
  9989. **
  9990. ** Obtain a changeset containing changes to the tables attached to the
  9991. ** session object passed as the first argument. If successful,
  9992. ** set *ppChangeset to point to a buffer containing the changeset
  9993. ** and *pnChangeset to the size of the changeset in bytes before returning
  9994. ** SQLITE_OK. If an error occurs, set both *ppChangeset and *pnChangeset to
  9995. ** zero and return an SQLite error code.
  9996. **
  9997. ** A changeset consists of zero or more INSERT, UPDATE and/or DELETE changes,
  9998. ** each representing a change to a single row of an attached table. An INSERT
  9999. ** change contains the values of each field of a new database row. A DELETE
  10000. ** contains the original values of each field of a deleted database row. An
  10001. ** UPDATE change contains the original values of each field of an updated
  10002. ** database row along with the updated values for each updated non-primary-key
  10003. ** column. It is not possible for an UPDATE change to represent a change that
  10004. ** modifies the values of primary key columns. If such a change is made, it
  10005. ** is represented in a changeset as a DELETE followed by an INSERT.
  10006. **
  10007. ** Changes are not recorded for rows that have NULL values stored in one or
  10008. ** more of their PRIMARY KEY columns. If such a row is inserted or deleted,
  10009. ** no corresponding change is present in the changesets returned by this
  10010. ** function. If an existing row with one or more NULL values stored in
  10011. ** PRIMARY KEY columns is updated so that all PRIMARY KEY columns are non-NULL,
  10012. ** only an INSERT is appears in the changeset. Similarly, if an existing row
  10013. ** with non-NULL PRIMARY KEY values is updated so that one or more of its
  10014. ** PRIMARY KEY columns are set to NULL, the resulting changeset contains a
  10015. ** DELETE change only.
  10016. **
  10017. ** The contents of a changeset may be traversed using an iterator created
  10018. ** using the [sqlite3changeset_start()] API. A changeset may be applied to
  10019. ** a database with a compatible schema using the [sqlite3changeset_apply()]
  10020. ** API.
  10021. **
  10022. ** Within a changeset generated by this function, all changes related to a
  10023. ** single table are grouped together. In other words, when iterating through
  10024. ** a changeset or when applying a changeset to a database, all changes related
  10025. ** to a single table are processed before moving on to the next table. Tables
  10026. ** are sorted in the same order in which they were attached (or auto-attached)
  10027. ** to the sqlite3_session object. The order in which the changes related to
  10028. ** a single table are stored is undefined.
  10029. **
  10030. ** Following a successful call to this function, it is the responsibility of
  10031. ** the caller to eventually free the buffer that *ppChangeset points to using
  10032. ** [sqlite3_free()].
  10033. **
  10034. ** <h3>Changeset Generation</h3>
  10035. **
  10036. ** Once a table has been attached to a session object, the session object
  10037. ** records the primary key values of all new rows inserted into the table.
  10038. ** It also records the original primary key and other column values of any
  10039. ** deleted or updated rows. For each unique primary key value, data is only
  10040. ** recorded once - the first time a row with said primary key is inserted,
  10041. ** updated or deleted in the lifetime of the session.
  10042. **
  10043. ** There is one exception to the previous paragraph: when a row is inserted,
  10044. ** updated or deleted, if one or more of its primary key columns contain a
  10045. ** NULL value, no record of the change is made.
  10046. **
  10047. ** The session object therefore accumulates two types of records - those
  10048. ** that consist of primary key values only (created when the user inserts
  10049. ** a new record) and those that consist of the primary key values and the
  10050. ** original values of other table columns (created when the users deletes
  10051. ** or updates a record).
  10052. **
  10053. ** When this function is called, the requested changeset is created using
  10054. ** both the accumulated records and the current contents of the database
  10055. ** file. Specifically:
  10056. **
  10057. ** <ul>
  10058. ** <li> For each record generated by an insert, the database is queried
  10059. ** for a row with a matching primary key. If one is found, an INSERT
  10060. ** change is added to the changeset. If no such row is found, no change
  10061. ** is added to the changeset.
  10062. **
  10063. ** <li> For each record generated by an update or delete, the database is
  10064. ** queried for a row with a matching primary key. If such a row is
  10065. ** found and one or more of the non-primary key fields have been
  10066. ** modified from their original values, an UPDATE change is added to
  10067. ** the changeset. Or, if no such row is found in the table, a DELETE
  10068. ** change is added to the changeset. If there is a row with a matching
  10069. ** primary key in the database, but all fields contain their original
  10070. ** values, no change is added to the changeset.
  10071. ** </ul>
  10072. **
  10073. ** This means, amongst other things, that if a row is inserted and then later
  10074. ** deleted while a session object is active, neither the insert nor the delete
  10075. ** will be present in the changeset. Or if a row is deleted and then later a
  10076. ** row with the same primary key values inserted while a session object is
  10077. ** active, the resulting changeset will contain an UPDATE change instead of
  10078. ** a DELETE and an INSERT.
  10079. **
  10080. ** When a session object is disabled (see the [sqlite3session_enable()] API),
  10081. ** it does not accumulate records when rows are inserted, updated or deleted.
  10082. ** This may appear to have some counter-intuitive effects if a single row
  10083. ** is written to more than once during a session. For example, if a row
  10084. ** is inserted while a session object is enabled, then later deleted while
  10085. ** the same session object is disabled, no INSERT record will appear in the
  10086. ** changeset, even though the delete took place while the session was disabled.
  10087. ** Or, if one field of a row is updated while a session is disabled, and
  10088. ** another field of the same row is updated while the session is enabled, the
  10089. ** resulting changeset will contain an UPDATE change that updates both fields.
  10090. */
  10091. SQLITE_API int sqlite3session_changeset(
  10092. sqlite3_session *pSession, /* Session object */
  10093. int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
  10094. void **ppChangeset /* OUT: Buffer containing changeset */
  10095. );
  10096. /*
  10097. ** CAPI3REF: Load The Difference Between Tables Into A Session
  10098. ** METHOD: sqlite3_session
  10099. **
  10100. ** If it is not already attached to the session object passed as the first
  10101. ** argument, this function attaches table zTbl in the same manner as the
  10102. ** [sqlite3session_attach()] function. If zTbl does not exist, or if it
  10103. ** does not have a primary key, this function is a no-op (but does not return
  10104. ** an error).
  10105. **
  10106. ** Argument zFromDb must be the name of a database ("main", "temp" etc.)
  10107. ** attached to the same database handle as the session object that contains
  10108. ** a table compatible with the table attached to the session by this function.
  10109. ** A table is considered compatible if it:
  10110. **
  10111. ** <ul>
  10112. ** <li> Has the same name,
  10113. ** <li> Has the same set of columns declared in the same order, and
  10114. ** <li> Has the same PRIMARY KEY definition.
  10115. ** </ul>
  10116. **
  10117. ** If the tables are not compatible, SQLITE_SCHEMA is returned. If the tables
  10118. ** are compatible but do not have any PRIMARY KEY columns, it is not an error
  10119. ** but no changes are added to the session object. As with other session
  10120. ** APIs, tables without PRIMARY KEYs are simply ignored.
  10121. **
  10122. ** This function adds a set of changes to the session object that could be
  10123. ** used to update the table in database zFrom (call this the "from-table")
  10124. ** so that its content is the same as the table attached to the session
  10125. ** object (call this the "to-table"). Specifically:
  10126. **
  10127. ** <ul>
  10128. ** <li> For each row (primary key) that exists in the to-table but not in
  10129. ** the from-table, an INSERT record is added to the session object.
  10130. **
  10131. ** <li> For each row (primary key) that exists in the to-table but not in
  10132. ** the from-table, a DELETE record is added to the session object.
  10133. **
  10134. ** <li> For each row (primary key) that exists in both tables, but features
  10135. ** different non-PK values in each, an UPDATE record is added to the
  10136. ** session.
  10137. ** </ul>
  10138. **
  10139. ** To clarify, if this function is called and then a changeset constructed
  10140. ** using [sqlite3session_changeset()], then after applying that changeset to
  10141. ** database zFrom the contents of the two compatible tables would be
  10142. ** identical.
  10143. **
  10144. ** It an error if database zFrom does not exist or does not contain the
  10145. ** required compatible table.
  10146. **
  10147. ** If the operation successful, SQLITE_OK is returned. Otherwise, an SQLite
  10148. ** error code. In this case, if argument pzErrMsg is not NULL, *pzErrMsg
  10149. ** may be set to point to a buffer containing an English language error
  10150. ** message. It is the responsibility of the caller to free this buffer using
  10151. ** sqlite3_free().
  10152. */
  10153. SQLITE_API int sqlite3session_diff(
  10154. sqlite3_session *pSession,
  10155. const char *zFromDb,
  10156. const char *zTbl,
  10157. char **pzErrMsg
  10158. );
  10159. /*
  10160. ** CAPI3REF: Generate A Patchset From A Session Object
  10161. ** METHOD: sqlite3_session
  10162. **
  10163. ** The differences between a patchset and a changeset are that:
  10164. **
  10165. ** <ul>
  10166. ** <li> DELETE records consist of the primary key fields only. The
  10167. ** original values of other fields are omitted.
  10168. ** <li> The original values of any modified fields are omitted from
  10169. ** UPDATE records.
  10170. ** </ul>
  10171. **
  10172. ** A patchset blob may be used with up to date versions of all
  10173. ** sqlite3changeset_xxx API functions except for sqlite3changeset_invert(),
  10174. ** which returns SQLITE_CORRUPT if it is passed a patchset. Similarly,
  10175. ** attempting to use a patchset blob with old versions of the
  10176. ** sqlite3changeset_xxx APIs also provokes an SQLITE_CORRUPT error.
  10177. **
  10178. ** Because the non-primary key "old.*" fields are omitted, no
  10179. ** SQLITE_CHANGESET_DATA conflicts can be detected or reported if a patchset
  10180. ** is passed to the sqlite3changeset_apply() API. Other conflict types work
  10181. ** in the same way as for changesets.
  10182. **
  10183. ** Changes within a patchset are ordered in the same way as for changesets
  10184. ** generated by the sqlite3session_changeset() function (i.e. all changes for
  10185. ** a single table are grouped together, tables appear in the order in which
  10186. ** they were attached to the session object).
  10187. */
  10188. SQLITE_API int sqlite3session_patchset(
  10189. sqlite3_session *pSession, /* Session object */
  10190. int *pnPatchset, /* OUT: Size of buffer at *ppPatchset */
  10191. void **ppPatchset /* OUT: Buffer containing patchset */
  10192. );
  10193. /*
  10194. ** CAPI3REF: Test if a changeset has recorded any changes.
  10195. **
  10196. ** Return non-zero if no changes to attached tables have been recorded by
  10197. ** the session object passed as the first argument. Otherwise, if one or
  10198. ** more changes have been recorded, return zero.
  10199. **
  10200. ** Even if this function returns zero, it is possible that calling
  10201. ** [sqlite3session_changeset()] on the session handle may still return a
  10202. ** changeset that contains no changes. This can happen when a row in
  10203. ** an attached table is modified and then later on the original values
  10204. ** are restored. However, if this function returns non-zero, then it is
  10205. ** guaranteed that a call to sqlite3session_changeset() will return a
  10206. ** changeset containing zero changes.
  10207. */
  10208. SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession);
  10209. /*
  10210. ** CAPI3REF: Create An Iterator To Traverse A Changeset
  10211. ** CONSTRUCTOR: sqlite3_changeset_iter
  10212. **
  10213. ** Create an iterator used to iterate through the contents of a changeset.
  10214. ** If successful, *pp is set to point to the iterator handle and SQLITE_OK
  10215. ** is returned. Otherwise, if an error occurs, *pp is set to zero and an
  10216. ** SQLite error code is returned.
  10217. **
  10218. ** The following functions can be used to advance and query a changeset
  10219. ** iterator created by this function:
  10220. **
  10221. ** <ul>
  10222. ** <li> [sqlite3changeset_next()]
  10223. ** <li> [sqlite3changeset_op()]
  10224. ** <li> [sqlite3changeset_new()]
  10225. ** <li> [sqlite3changeset_old()]
  10226. ** </ul>
  10227. **
  10228. ** It is the responsibility of the caller to eventually destroy the iterator
  10229. ** by passing it to [sqlite3changeset_finalize()]. The buffer containing the
  10230. ** changeset (pChangeset) must remain valid until after the iterator is
  10231. ** destroyed.
  10232. **
  10233. ** Assuming the changeset blob was created by one of the
  10234. ** [sqlite3session_changeset()], [sqlite3changeset_concat()] or
  10235. ** [sqlite3changeset_invert()] functions, all changes within the changeset
  10236. ** that apply to a single table are grouped together. This means that when
  10237. ** an application iterates through a changeset using an iterator created by
  10238. ** this function, all changes that relate to a single table are visited
  10239. ** consecutively. There is no chance that the iterator will visit a change
  10240. ** the applies to table X, then one for table Y, and then later on visit
  10241. ** another change for table X.
  10242. */
  10243. SQLITE_API int sqlite3changeset_start(
  10244. sqlite3_changeset_iter **pp, /* OUT: New changeset iterator handle */
  10245. int nChangeset, /* Size of changeset blob in bytes */
  10246. void *pChangeset /* Pointer to blob containing changeset */
  10247. );
  10248. /*
  10249. ** CAPI3REF: Advance A Changeset Iterator
  10250. ** METHOD: sqlite3_changeset_iter
  10251. **
  10252. ** This function may only be used with iterators created by function
  10253. ** [sqlite3changeset_start()]. If it is called on an iterator passed to
  10254. ** a conflict-handler callback by [sqlite3changeset_apply()], SQLITE_MISUSE
  10255. ** is returned and the call has no effect.
  10256. **
  10257. ** Immediately after an iterator is created by sqlite3changeset_start(), it
  10258. ** does not point to any change in the changeset. Assuming the changeset
  10259. ** is not empty, the first call to this function advances the iterator to
  10260. ** point to the first change in the changeset. Each subsequent call advances
  10261. ** the iterator to point to the next change in the changeset (if any). If
  10262. ** no error occurs and the iterator points to a valid change after a call
  10263. ** to sqlite3changeset_next() has advanced it, SQLITE_ROW is returned.
  10264. ** Otherwise, if all changes in the changeset have already been visited,
  10265. ** SQLITE_DONE is returned.
  10266. **
  10267. ** If an error occurs, an SQLite error code is returned. Possible error
  10268. ** codes include SQLITE_CORRUPT (if the changeset buffer is corrupt) or
  10269. ** SQLITE_NOMEM.
  10270. */
  10271. SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *pIter);
  10272. /*
  10273. ** CAPI3REF: Obtain The Current Operation From A Changeset Iterator
  10274. ** METHOD: sqlite3_changeset_iter
  10275. **
  10276. ** The pIter argument passed to this function may either be an iterator
  10277. ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
  10278. ** created by [sqlite3changeset_start()]. In the latter case, the most recent
  10279. ** call to [sqlite3changeset_next()] must have returned [SQLITE_ROW]. If this
  10280. ** is not the case, this function returns [SQLITE_MISUSE].
  10281. **
  10282. ** If argument pzTab is not NULL, then *pzTab is set to point to a
  10283. ** nul-terminated utf-8 encoded string containing the name of the table
  10284. ** affected by the current change. The buffer remains valid until either
  10285. ** sqlite3changeset_next() is called on the iterator or until the
  10286. ** conflict-handler function returns. If pnCol is not NULL, then *pnCol is
  10287. ** set to the number of columns in the table affected by the change. If
  10288. ** pbIncorrect is not NULL, then *pbIndirect is set to true (1) if the change
  10289. ** is an indirect change, or false (0) otherwise. See the documentation for
  10290. ** [sqlite3session_indirect()] for a description of direct and indirect
  10291. ** changes. Finally, if pOp is not NULL, then *pOp is set to one of
  10292. ** [SQLITE_INSERT], [SQLITE_DELETE] or [SQLITE_UPDATE], depending on the
  10293. ** type of change that the iterator currently points to.
  10294. **
  10295. ** If no error occurs, SQLITE_OK is returned. If an error does occur, an
  10296. ** SQLite error code is returned. The values of the output variables may not
  10297. ** be trusted in this case.
  10298. */
  10299. SQLITE_API int sqlite3changeset_op(
  10300. sqlite3_changeset_iter *pIter, /* Iterator object */
  10301. const char **pzTab, /* OUT: Pointer to table name */
  10302. int *pnCol, /* OUT: Number of columns in table */
  10303. int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */
  10304. int *pbIndirect /* OUT: True for an 'indirect' change */
  10305. );
  10306. /*
  10307. ** CAPI3REF: Obtain The Primary Key Definition Of A Table
  10308. ** METHOD: sqlite3_changeset_iter
  10309. **
  10310. ** For each modified table, a changeset includes the following:
  10311. **
  10312. ** <ul>
  10313. ** <li> The number of columns in the table, and
  10314. ** <li> Which of those columns make up the tables PRIMARY KEY.
  10315. ** </ul>
  10316. **
  10317. ** This function is used to find which columns comprise the PRIMARY KEY of
  10318. ** the table modified by the change that iterator pIter currently points to.
  10319. ** If successful, *pabPK is set to point to an array of nCol entries, where
  10320. ** nCol is the number of columns in the table. Elements of *pabPK are set to
  10321. ** 0x01 if the corresponding column is part of the tables primary key, or
  10322. ** 0x00 if it is not.
  10323. **
  10324. ** If argument pnCol is not NULL, then *pnCol is set to the number of columns
  10325. ** in the table.
  10326. **
  10327. ** If this function is called when the iterator does not point to a valid
  10328. ** entry, SQLITE_MISUSE is returned and the output variables zeroed. Otherwise,
  10329. ** SQLITE_OK is returned and the output variables populated as described
  10330. ** above.
  10331. */
  10332. SQLITE_API int sqlite3changeset_pk(
  10333. sqlite3_changeset_iter *pIter, /* Iterator object */
  10334. unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */
  10335. int *pnCol /* OUT: Number of entries in output array */
  10336. );
  10337. /*
  10338. ** CAPI3REF: Obtain old.* Values From A Changeset Iterator
  10339. ** METHOD: sqlite3_changeset_iter
  10340. **
  10341. ** The pIter argument passed to this function may either be an iterator
  10342. ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
  10343. ** created by [sqlite3changeset_start()]. In the latter case, the most recent
  10344. ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
  10345. ** Furthermore, it may only be called if the type of change that the iterator
  10346. ** currently points to is either [SQLITE_DELETE] or [SQLITE_UPDATE]. Otherwise,
  10347. ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
  10348. **
  10349. ** Argument iVal must be greater than or equal to 0, and less than the number
  10350. ** of columns in the table affected by the current change. Otherwise,
  10351. ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
  10352. **
  10353. ** If successful, this function sets *ppValue to point to a protected
  10354. ** sqlite3_value object containing the iVal'th value from the vector of
  10355. ** original row values stored as part of the UPDATE or DELETE change and
  10356. ** returns SQLITE_OK. The name of the function comes from the fact that this
  10357. ** is similar to the "old.*" columns available to update or delete triggers.
  10358. **
  10359. ** If some other error occurs (e.g. an OOM condition), an SQLite error code
  10360. ** is returned and *ppValue is set to NULL.
  10361. */
  10362. SQLITE_API int sqlite3changeset_old(
  10363. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  10364. int iVal, /* Column number */
  10365. sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */
  10366. );
  10367. /*
  10368. ** CAPI3REF: Obtain new.* Values From A Changeset Iterator
  10369. ** METHOD: sqlite3_changeset_iter
  10370. **
  10371. ** The pIter argument passed to this function may either be an iterator
  10372. ** passed to a conflict-handler by [sqlite3changeset_apply()], or an iterator
  10373. ** created by [sqlite3changeset_start()]. In the latter case, the most recent
  10374. ** call to [sqlite3changeset_next()] must have returned SQLITE_ROW.
  10375. ** Furthermore, it may only be called if the type of change that the iterator
  10376. ** currently points to is either [SQLITE_UPDATE] or [SQLITE_INSERT]. Otherwise,
  10377. ** this function returns [SQLITE_MISUSE] and sets *ppValue to NULL.
  10378. **
  10379. ** Argument iVal must be greater than or equal to 0, and less than the number
  10380. ** of columns in the table affected by the current change. Otherwise,
  10381. ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
  10382. **
  10383. ** If successful, this function sets *ppValue to point to a protected
  10384. ** sqlite3_value object containing the iVal'th value from the vector of
  10385. ** new row values stored as part of the UPDATE or INSERT change and
  10386. ** returns SQLITE_OK. If the change is an UPDATE and does not include
  10387. ** a new value for the requested column, *ppValue is set to NULL and
  10388. ** SQLITE_OK returned. The name of the function comes from the fact that
  10389. ** this is similar to the "new.*" columns available to update or delete
  10390. ** triggers.
  10391. **
  10392. ** If some other error occurs (e.g. an OOM condition), an SQLite error code
  10393. ** is returned and *ppValue is set to NULL.
  10394. */
  10395. SQLITE_API int sqlite3changeset_new(
  10396. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  10397. int iVal, /* Column number */
  10398. sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */
  10399. );
  10400. /*
  10401. ** CAPI3REF: Obtain Conflicting Row Values From A Changeset Iterator
  10402. ** METHOD: sqlite3_changeset_iter
  10403. **
  10404. ** This function should only be used with iterator objects passed to a
  10405. ** conflict-handler callback by [sqlite3changeset_apply()] with either
  10406. ** [SQLITE_CHANGESET_DATA] or [SQLITE_CHANGESET_CONFLICT]. If this function
  10407. ** is called on any other iterator, [SQLITE_MISUSE] is returned and *ppValue
  10408. ** is set to NULL.
  10409. **
  10410. ** Argument iVal must be greater than or equal to 0, and less than the number
  10411. ** of columns in the table affected by the current change. Otherwise,
  10412. ** [SQLITE_RANGE] is returned and *ppValue is set to NULL.
  10413. **
  10414. ** If successful, this function sets *ppValue to point to a protected
  10415. ** sqlite3_value object containing the iVal'th value from the
  10416. ** "conflicting row" associated with the current conflict-handler callback
  10417. ** and returns SQLITE_OK.
  10418. **
  10419. ** If some other error occurs (e.g. an OOM condition), an SQLite error code
  10420. ** is returned and *ppValue is set to NULL.
  10421. */
  10422. SQLITE_API int sqlite3changeset_conflict(
  10423. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  10424. int iVal, /* Column number */
  10425. sqlite3_value **ppValue /* OUT: Value from conflicting row */
  10426. );
  10427. /*
  10428. ** CAPI3REF: Determine The Number Of Foreign Key Constraint Violations
  10429. ** METHOD: sqlite3_changeset_iter
  10430. **
  10431. ** This function may only be called with an iterator passed to an
  10432. ** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
  10433. ** it sets the output variable to the total number of known foreign key
  10434. ** violations in the destination database and returns SQLITE_OK.
  10435. **
  10436. ** In all other cases this function returns SQLITE_MISUSE.
  10437. */
  10438. SQLITE_API int sqlite3changeset_fk_conflicts(
  10439. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  10440. int *pnOut /* OUT: Number of FK violations */
  10441. );
  10442. /*
  10443. ** CAPI3REF: Finalize A Changeset Iterator
  10444. ** METHOD: sqlite3_changeset_iter
  10445. **
  10446. ** This function is used to finalize an iterator allocated with
  10447. ** [sqlite3changeset_start()].
  10448. **
  10449. ** This function should only be called on iterators created using the
  10450. ** [sqlite3changeset_start()] function. If an application calls this
  10451. ** function with an iterator passed to a conflict-handler by
  10452. ** [sqlite3changeset_apply()], [SQLITE_MISUSE] is immediately returned and the
  10453. ** call has no effect.
  10454. **
  10455. ** If an error was encountered within a call to an sqlite3changeset_xxx()
  10456. ** function (for example an [SQLITE_CORRUPT] in [sqlite3changeset_next()] or an
  10457. ** [SQLITE_NOMEM] in [sqlite3changeset_new()]) then an error code corresponding
  10458. ** to that error is returned by this function. Otherwise, SQLITE_OK is
  10459. ** returned. This is to allow the following pattern (pseudo-code):
  10460. **
  10461. ** <pre>
  10462. ** sqlite3changeset_start();
  10463. ** while( SQLITE_ROW==sqlite3changeset_next() ){
  10464. ** // Do something with change.
  10465. ** }
  10466. ** rc = sqlite3changeset_finalize();
  10467. ** if( rc!=SQLITE_OK ){
  10468. ** // An error has occurred
  10469. ** }
  10470. ** </pre>
  10471. */
  10472. SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *pIter);
  10473. /*
  10474. ** CAPI3REF: Invert A Changeset
  10475. **
  10476. ** This function is used to "invert" a changeset object. Applying an inverted
  10477. ** changeset to a database reverses the effects of applying the uninverted
  10478. ** changeset. Specifically:
  10479. **
  10480. ** <ul>
  10481. ** <li> Each DELETE change is changed to an INSERT, and
  10482. ** <li> Each INSERT change is changed to a DELETE, and
  10483. ** <li> For each UPDATE change, the old.* and new.* values are exchanged.
  10484. ** </ul>
  10485. **
  10486. ** This function does not change the order in which changes appear within
  10487. ** the changeset. It merely reverses the sense of each individual change.
  10488. **
  10489. ** If successful, a pointer to a buffer containing the inverted changeset
  10490. ** is stored in *ppOut, the size of the same buffer is stored in *pnOut, and
  10491. ** SQLITE_OK is returned. If an error occurs, both *pnOut and *ppOut are
  10492. ** zeroed and an SQLite error code returned.
  10493. **
  10494. ** It is the responsibility of the caller to eventually call sqlite3_free()
  10495. ** on the *ppOut pointer to free the buffer allocation following a successful
  10496. ** call to this function.
  10497. **
  10498. ** WARNING/TODO: This function currently assumes that the input is a valid
  10499. ** changeset. If it is not, the results are undefined.
  10500. */
  10501. SQLITE_API int sqlite3changeset_invert(
  10502. int nIn, const void *pIn, /* Input changeset */
  10503. int *pnOut, void **ppOut /* OUT: Inverse of input */
  10504. );
  10505. /*
  10506. ** CAPI3REF: Concatenate Two Changeset Objects
  10507. **
  10508. ** This function is used to concatenate two changesets, A and B, into a
  10509. ** single changeset. The result is a changeset equivalent to applying
  10510. ** changeset A followed by changeset B.
  10511. **
  10512. ** This function combines the two input changesets using an
  10513. ** sqlite3_changegroup object. Calling it produces similar results as the
  10514. ** following code fragment:
  10515. **
  10516. ** <pre>
  10517. ** sqlite3_changegroup *pGrp;
  10518. ** rc = sqlite3_changegroup_new(&pGrp);
  10519. ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nA, pA);
  10520. ** if( rc==SQLITE_OK ) rc = sqlite3changegroup_add(pGrp, nB, pB);
  10521. ** if( rc==SQLITE_OK ){
  10522. ** rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
  10523. ** }else{
  10524. ** *ppOut = 0;
  10525. ** *pnOut = 0;
  10526. ** }
  10527. ** </pre>
  10528. **
  10529. ** Refer to the sqlite3_changegroup documentation below for details.
  10530. */
  10531. SQLITE_API int sqlite3changeset_concat(
  10532. int nA, /* Number of bytes in buffer pA */
  10533. void *pA, /* Pointer to buffer containing changeset A */
  10534. int nB, /* Number of bytes in buffer pB */
  10535. void *pB, /* Pointer to buffer containing changeset B */
  10536. int *pnOut, /* OUT: Number of bytes in output changeset */
  10537. void **ppOut /* OUT: Buffer containing output changeset */
  10538. );
  10539. /*
  10540. ** CAPI3REF: Changegroup Handle
  10541. **
  10542. ** A changegroup is an object used to combine two or more
  10543. ** [changesets] or [patchsets]
  10544. */
  10545. typedef struct sqlite3_changegroup sqlite3_changegroup;
  10546. /*
  10547. ** CAPI3REF: Create A New Changegroup Object
  10548. ** CONSTRUCTOR: sqlite3_changegroup
  10549. **
  10550. ** An sqlite3_changegroup object is used to combine two or more changesets
  10551. ** (or patchsets) into a single changeset (or patchset). A single changegroup
  10552. ** object may combine changesets or patchsets, but not both. The output is
  10553. ** always in the same format as the input.
  10554. **
  10555. ** If successful, this function returns SQLITE_OK and populates (*pp) with
  10556. ** a pointer to a new sqlite3_changegroup object before returning. The caller
  10557. ** should eventually free the returned object using a call to
  10558. ** sqlite3changegroup_delete(). If an error occurs, an SQLite error code
  10559. ** (i.e. SQLITE_NOMEM) is returned and *pp is set to NULL.
  10560. **
  10561. ** The usual usage pattern for an sqlite3_changegroup object is as follows:
  10562. **
  10563. ** <ul>
  10564. ** <li> It is created using a call to sqlite3changegroup_new().
  10565. **
  10566. ** <li> Zero or more changesets (or patchsets) are added to the object
  10567. ** by calling sqlite3changegroup_add().
  10568. **
  10569. ** <li> The result of combining all input changesets together is obtained
  10570. ** by the application via a call to sqlite3changegroup_output().
  10571. **
  10572. ** <li> The object is deleted using a call to sqlite3changegroup_delete().
  10573. ** </ul>
  10574. **
  10575. ** Any number of calls to add() and output() may be made between the calls to
  10576. ** new() and delete(), and in any order.
  10577. **
  10578. ** As well as the regular sqlite3changegroup_add() and
  10579. ** sqlite3changegroup_output() functions, also available are the streaming
  10580. ** versions sqlite3changegroup_add_strm() and sqlite3changegroup_output_strm().
  10581. */
  10582. SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp);
  10583. /*
  10584. ** CAPI3REF: Add A Changeset To A Changegroup
  10585. ** METHOD: sqlite3_changegroup
  10586. **
  10587. ** Add all changes within the changeset (or patchset) in buffer pData (size
  10588. ** nData bytes) to the changegroup.
  10589. **
  10590. ** If the buffer contains a patchset, then all prior calls to this function
  10591. ** on the same changegroup object must also have specified patchsets. Or, if
  10592. ** the buffer contains a changeset, so must have the earlier calls to this
  10593. ** function. Otherwise, SQLITE_ERROR is returned and no changes are added
  10594. ** to the changegroup.
  10595. **
  10596. ** Rows within the changeset and changegroup are identified by the values in
  10597. ** their PRIMARY KEY columns. A change in the changeset is considered to
  10598. ** apply to the same row as a change already present in the changegroup if
  10599. ** the two rows have the same primary key.
  10600. **
  10601. ** Changes to rows that do not already appear in the changegroup are
  10602. ** simply copied into it. Or, if both the new changeset and the changegroup
  10603. ** contain changes that apply to a single row, the final contents of the
  10604. ** changegroup depends on the type of each change, as follows:
  10605. **
  10606. ** <table border=1 style="margin-left:8ex;margin-right:8ex">
  10607. ** <tr><th style="white-space:pre">Existing Change </th>
  10608. ** <th style="white-space:pre">New Change </th>
  10609. ** <th>Output Change
  10610. ** <tr><td>INSERT <td>INSERT <td>
  10611. ** The new change is ignored. This case does not occur if the new
  10612. ** changeset was recorded immediately after the changesets already
  10613. ** added to the changegroup.
  10614. ** <tr><td>INSERT <td>UPDATE <td>
  10615. ** The INSERT change remains in the changegroup. The values in the
  10616. ** INSERT change are modified as if the row was inserted by the
  10617. ** existing change and then updated according to the new change.
  10618. ** <tr><td>INSERT <td>DELETE <td>
  10619. ** The existing INSERT is removed from the changegroup. The DELETE is
  10620. ** not added.
  10621. ** <tr><td>UPDATE <td>INSERT <td>
  10622. ** The new change is ignored. This case does not occur if the new
  10623. ** changeset was recorded immediately after the changesets already
  10624. ** added to the changegroup.
  10625. ** <tr><td>UPDATE <td>UPDATE <td>
  10626. ** The existing UPDATE remains within the changegroup. It is amended
  10627. ** so that the accompanying values are as if the row was updated once
  10628. ** by the existing change and then again by the new change.
  10629. ** <tr><td>UPDATE <td>DELETE <td>
  10630. ** The existing UPDATE is replaced by the new DELETE within the
  10631. ** changegroup.
  10632. ** <tr><td>DELETE <td>INSERT <td>
  10633. ** If one or more of the column values in the row inserted by the
  10634. ** new change differ from those in the row deleted by the existing
  10635. ** change, the existing DELETE is replaced by an UPDATE within the
  10636. ** changegroup. Otherwise, if the inserted row is exactly the same
  10637. ** as the deleted row, the existing DELETE is simply discarded.
  10638. ** <tr><td>DELETE <td>UPDATE <td>
  10639. ** The new change is ignored. This case does not occur if the new
  10640. ** changeset was recorded immediately after the changesets already
  10641. ** added to the changegroup.
  10642. ** <tr><td>DELETE <td>DELETE <td>
  10643. ** The new change is ignored. This case does not occur if the new
  10644. ** changeset was recorded immediately after the changesets already
  10645. ** added to the changegroup.
  10646. ** </table>
  10647. **
  10648. ** If the new changeset contains changes to a table that is already present
  10649. ** in the changegroup, then the number of columns and the position of the
  10650. ** primary key columns for the table must be consistent. If this is not the
  10651. ** case, this function fails with SQLITE_SCHEMA. If the input changeset
  10652. ** appears to be corrupt and the corruption is detected, SQLITE_CORRUPT is
  10653. ** returned. Or, if an out-of-memory condition occurs during processing, this
  10654. ** function returns SQLITE_NOMEM. In all cases, if an error occurs the
  10655. ** final contents of the changegroup is undefined.
  10656. **
  10657. ** If no error occurs, SQLITE_OK is returned.
  10658. */
  10659. SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup*, int nData, void *pData);
  10660. /*
  10661. ** CAPI3REF: Obtain A Composite Changeset From A Changegroup
  10662. ** METHOD: sqlite3_changegroup
  10663. **
  10664. ** Obtain a buffer containing a changeset (or patchset) representing the
  10665. ** current contents of the changegroup. If the inputs to the changegroup
  10666. ** were themselves changesets, the output is a changeset. Or, if the
  10667. ** inputs were patchsets, the output is also a patchset.
  10668. **
  10669. ** As with the output of the sqlite3session_changeset() and
  10670. ** sqlite3session_patchset() functions, all changes related to a single
  10671. ** table are grouped together in the output of this function. Tables appear
  10672. ** in the same order as for the very first changeset added to the changegroup.
  10673. ** If the second or subsequent changesets added to the changegroup contain
  10674. ** changes for tables that do not appear in the first changeset, they are
  10675. ** appended onto the end of the output changeset, again in the order in
  10676. ** which they are first encountered.
  10677. **
  10678. ** If an error occurs, an SQLite error code is returned and the output
  10679. ** variables (*pnData) and (*ppData) are set to 0. Otherwise, SQLITE_OK
  10680. ** is returned and the output variables are set to the size of and a
  10681. ** pointer to the output buffer, respectively. In this case it is the
  10682. ** responsibility of the caller to eventually free the buffer using a
  10683. ** call to sqlite3_free().
  10684. */
  10685. SQLITE_API int sqlite3changegroup_output(
  10686. sqlite3_changegroup*,
  10687. int *pnData, /* OUT: Size of output buffer in bytes */
  10688. void **ppData /* OUT: Pointer to output buffer */
  10689. );
  10690. /*
  10691. ** CAPI3REF: Delete A Changegroup Object
  10692. ** DESTRUCTOR: sqlite3_changegroup
  10693. */
  10694. SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup*);
  10695. /*
  10696. ** CAPI3REF: Apply A Changeset To A Database
  10697. **
  10698. ** Apply a changeset or patchset to a database. These functions attempt to
  10699. ** update the "main" database attached to handle db with the changes found in
  10700. ** the changeset passed via the second and third arguments.
  10701. **
  10702. ** The fourth argument (xFilter) passed to these functions is the "filter
  10703. ** callback". If it is not NULL, then for each table affected by at least one
  10704. ** change in the changeset, the filter callback is invoked with
  10705. ** the table name as the second argument, and a copy of the context pointer
  10706. ** passed as the sixth argument as the first. If the "filter callback"
  10707. ** returns zero, then no attempt is made to apply any changes to the table.
  10708. ** Otherwise, if the return value is non-zero or the xFilter argument to
  10709. ** is NULL, all changes related to the table are attempted.
  10710. **
  10711. ** For each table that is not excluded by the filter callback, this function
  10712. ** tests that the target database contains a compatible table. A table is
  10713. ** considered compatible if all of the following are true:
  10714. **
  10715. ** <ul>
  10716. ** <li> The table has the same name as the name recorded in the
  10717. ** changeset, and
  10718. ** <li> The table has at least as many columns as recorded in the
  10719. ** changeset, and
  10720. ** <li> The table has primary key columns in the same position as
  10721. ** recorded in the changeset.
  10722. ** </ul>
  10723. **
  10724. ** If there is no compatible table, it is not an error, but none of the
  10725. ** changes associated with the table are applied. A warning message is issued
  10726. ** via the sqlite3_log() mechanism with the error code SQLITE_SCHEMA. At most
  10727. ** one such warning is issued for each table in the changeset.
  10728. **
  10729. ** For each change for which there is a compatible table, an attempt is made
  10730. ** to modify the table contents according to the UPDATE, INSERT or DELETE
  10731. ** change. If a change cannot be applied cleanly, the conflict handler
  10732. ** function passed as the fifth argument to sqlite3changeset_apply() may be
  10733. ** invoked. A description of exactly when the conflict handler is invoked for
  10734. ** each type of change is below.
  10735. **
  10736. ** Unlike the xFilter argument, xConflict may not be passed NULL. The results
  10737. ** of passing anything other than a valid function pointer as the xConflict
  10738. ** argument are undefined.
  10739. **
  10740. ** Each time the conflict handler function is invoked, it must return one
  10741. ** of [SQLITE_CHANGESET_OMIT], [SQLITE_CHANGESET_ABORT] or
  10742. ** [SQLITE_CHANGESET_REPLACE]. SQLITE_CHANGESET_REPLACE may only be returned
  10743. ** if the second argument passed to the conflict handler is either
  10744. ** SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If the conflict-handler
  10745. ** returns an illegal value, any changes already made are rolled back and
  10746. ** the call to sqlite3changeset_apply() returns SQLITE_MISUSE. Different
  10747. ** actions are taken by sqlite3changeset_apply() depending on the value
  10748. ** returned by each invocation of the conflict-handler function. Refer to
  10749. ** the documentation for the three
  10750. ** [SQLITE_CHANGESET_OMIT|available return values] for details.
  10751. **
  10752. ** <dl>
  10753. ** <dt>DELETE Changes<dd>
  10754. ** For each DELETE change, the function checks if the target database
  10755. ** contains a row with the same primary key value (or values) as the
  10756. ** original row values stored in the changeset. If it does, and the values
  10757. ** stored in all non-primary key columns also match the values stored in
  10758. ** the changeset the row is deleted from the target database.
  10759. **
  10760. ** If a row with matching primary key values is found, but one or more of
  10761. ** the non-primary key fields contains a value different from the original
  10762. ** row value stored in the changeset, the conflict-handler function is
  10763. ** invoked with [SQLITE_CHANGESET_DATA] as the second argument. If the
  10764. ** database table has more columns than are recorded in the changeset,
  10765. ** only the values of those non-primary key fields are compared against
  10766. ** the current database contents - any trailing database table columns
  10767. ** are ignored.
  10768. **
  10769. ** If no row with matching primary key values is found in the database,
  10770. ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
  10771. ** passed as the second argument.
  10772. **
  10773. ** If the DELETE operation is attempted, but SQLite returns SQLITE_CONSTRAINT
  10774. ** (which can only happen if a foreign key constraint is violated), the
  10775. ** conflict-handler function is invoked with [SQLITE_CHANGESET_CONSTRAINT]
  10776. ** passed as the second argument. This includes the case where the DELETE
  10777. ** operation is attempted because an earlier call to the conflict handler
  10778. ** function returned [SQLITE_CHANGESET_REPLACE].
  10779. **
  10780. ** <dt>INSERT Changes<dd>
  10781. ** For each INSERT change, an attempt is made to insert the new row into
  10782. ** the database. If the changeset row contains fewer fields than the
  10783. ** database table, the trailing fields are populated with their default
  10784. ** values.
  10785. **
  10786. ** If the attempt to insert the row fails because the database already
  10787. ** contains a row with the same primary key values, the conflict handler
  10788. ** function is invoked with the second argument set to
  10789. ** [SQLITE_CHANGESET_CONFLICT].
  10790. **
  10791. ** If the attempt to insert the row fails because of some other constraint
  10792. ** violation (e.g. NOT NULL or UNIQUE), the conflict handler function is
  10793. ** invoked with the second argument set to [SQLITE_CHANGESET_CONSTRAINT].
  10794. ** This includes the case where the INSERT operation is re-attempted because
  10795. ** an earlier call to the conflict handler function returned
  10796. ** [SQLITE_CHANGESET_REPLACE].
  10797. **
  10798. ** <dt>UPDATE Changes<dd>
  10799. ** For each UPDATE change, the function checks if the target database
  10800. ** contains a row with the same primary key value (or values) as the
  10801. ** original row values stored in the changeset. If it does, and the values
  10802. ** stored in all modified non-primary key columns also match the values
  10803. ** stored in the changeset the row is updated within the target database.
  10804. **
  10805. ** If a row with matching primary key values is found, but one or more of
  10806. ** the modified non-primary key fields contains a value different from an
  10807. ** original row value stored in the changeset, the conflict-handler function
  10808. ** is invoked with [SQLITE_CHANGESET_DATA] as the second argument. Since
  10809. ** UPDATE changes only contain values for non-primary key fields that are
  10810. ** to be modified, only those fields need to match the original values to
  10811. ** avoid the SQLITE_CHANGESET_DATA conflict-handler callback.
  10812. **
  10813. ** If no row with matching primary key values is found in the database,
  10814. ** the conflict-handler function is invoked with [SQLITE_CHANGESET_NOTFOUND]
  10815. ** passed as the second argument.
  10816. **
  10817. ** If the UPDATE operation is attempted, but SQLite returns
  10818. ** SQLITE_CONSTRAINT, the conflict-handler function is invoked with
  10819. ** [SQLITE_CHANGESET_CONSTRAINT] passed as the second argument.
  10820. ** This includes the case where the UPDATE operation is attempted after
  10821. ** an earlier call to the conflict handler function returned
  10822. ** [SQLITE_CHANGESET_REPLACE].
  10823. ** </dl>
  10824. **
  10825. ** It is safe to execute SQL statements, including those that write to the
  10826. ** table that the callback related to, from within the xConflict callback.
  10827. ** This can be used to further customize the applications conflict
  10828. ** resolution strategy.
  10829. **
  10830. ** All changes made by these functions are enclosed in a savepoint transaction.
  10831. ** If any other error (aside from a constraint failure when attempting to
  10832. ** write to the target database) occurs, then the savepoint transaction is
  10833. ** rolled back, restoring the target database to its original state, and an
  10834. ** SQLite error code returned.
  10835. **
  10836. ** If the output parameters (ppRebase) and (pnRebase) are non-NULL and
  10837. ** the input is a changeset (not a patchset), then sqlite3changeset_apply_v2()
  10838. ** may set (*ppRebase) to point to a "rebase" that may be used with the
  10839. ** sqlite3_rebaser APIs buffer before returning. In this case (*pnRebase)
  10840. ** is set to the size of the buffer in bytes. It is the responsibility of the
  10841. ** caller to eventually free any such buffer using sqlite3_free(). The buffer
  10842. ** is only allocated and populated if one or more conflicts were encountered
  10843. ** while applying the patchset. See comments surrounding the sqlite3_rebaser
  10844. ** APIs for further details.
  10845. **
  10846. ** The behavior of sqlite3changeset_apply_v2() and its streaming equivalent
  10847. ** may be modified by passing a combination of
  10848. ** [SQLITE_CHANGESETAPPLY_NOSAVEPOINT | supported flags] as the 9th parameter.
  10849. **
  10850. ** Note that the sqlite3changeset_apply_v2() API is still <b>experimental</b>
  10851. ** and therefore subject to change.
  10852. */
  10853. SQLITE_API int sqlite3changeset_apply(
  10854. sqlite3 *db, /* Apply change to "main" db of this handle */
  10855. int nChangeset, /* Size of changeset in bytes */
  10856. void *pChangeset, /* Changeset blob */
  10857. int(*xFilter)(
  10858. void *pCtx, /* Copy of sixth arg to _apply() */
  10859. const char *zTab /* Table name */
  10860. ),
  10861. int(*xConflict)(
  10862. void *pCtx, /* Copy of sixth arg to _apply() */
  10863. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  10864. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  10865. ),
  10866. void *pCtx /* First argument passed to xConflict */
  10867. );
  10868. SQLITE_API int sqlite3changeset_apply_v2(
  10869. sqlite3 *db, /* Apply change to "main" db of this handle */
  10870. int nChangeset, /* Size of changeset in bytes */
  10871. void *pChangeset, /* Changeset blob */
  10872. int(*xFilter)(
  10873. void *pCtx, /* Copy of sixth arg to _apply() */
  10874. const char *zTab /* Table name */
  10875. ),
  10876. int(*xConflict)(
  10877. void *pCtx, /* Copy of sixth arg to _apply() */
  10878. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  10879. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  10880. ),
  10881. void *pCtx, /* First argument passed to xConflict */
  10882. void **ppRebase, int *pnRebase, /* OUT: Rebase data */
  10883. int flags /* Combination of SESSION_APPLY_* flags */
  10884. );
  10885. /*
  10886. ** CAPI3REF: Flags for sqlite3changeset_apply_v2
  10887. **
  10888. ** The following flags may passed via the 9th parameter to
  10889. ** [sqlite3changeset_apply_v2] and [sqlite3changeset_apply_v2_strm]:
  10890. **
  10891. ** <dl>
  10892. ** <dt>SQLITE_CHANGESETAPPLY_NOSAVEPOINT <dd>
  10893. ** Usually, the sessions module encloses all operations performed by
  10894. ** a single call to apply_v2() or apply_v2_strm() in a [SAVEPOINT]. The
  10895. ** SAVEPOINT is committed if the changeset or patchset is successfully
  10896. ** applied, or rolled back if an error occurs. Specifying this flag
  10897. ** causes the sessions module to omit this savepoint. In this case, if the
  10898. ** caller has an open transaction or savepoint when apply_v2() is called,
  10899. ** it may revert the partially applied changeset by rolling it back.
  10900. */
  10901. #define SQLITE_CHANGESETAPPLY_NOSAVEPOINT 0x0001
  10902. /*
  10903. ** CAPI3REF: Constants Passed To The Conflict Handler
  10904. **
  10905. ** Values that may be passed as the second argument to a conflict-handler.
  10906. **
  10907. ** <dl>
  10908. ** <dt>SQLITE_CHANGESET_DATA<dd>
  10909. ** The conflict handler is invoked with CHANGESET_DATA as the second argument
  10910. ** when processing a DELETE or UPDATE change if a row with the required
  10911. ** PRIMARY KEY fields is present in the database, but one or more other
  10912. ** (non primary-key) fields modified by the update do not contain the
  10913. ** expected "before" values.
  10914. **
  10915. ** The conflicting row, in this case, is the database row with the matching
  10916. ** primary key.
  10917. **
  10918. ** <dt>SQLITE_CHANGESET_NOTFOUND<dd>
  10919. ** The conflict handler is invoked with CHANGESET_NOTFOUND as the second
  10920. ** argument when processing a DELETE or UPDATE change if a row with the
  10921. ** required PRIMARY KEY fields is not present in the database.
  10922. **
  10923. ** There is no conflicting row in this case. The results of invoking the
  10924. ** sqlite3changeset_conflict() API are undefined.
  10925. **
  10926. ** <dt>SQLITE_CHANGESET_CONFLICT<dd>
  10927. ** CHANGESET_CONFLICT is passed as the second argument to the conflict
  10928. ** handler while processing an INSERT change if the operation would result
  10929. ** in duplicate primary key values.
  10930. **
  10931. ** The conflicting row in this case is the database row with the matching
  10932. ** primary key.
  10933. **
  10934. ** <dt>SQLITE_CHANGESET_FOREIGN_KEY<dd>
  10935. ** If foreign key handling is enabled, and applying a changeset leaves the
  10936. ** database in a state containing foreign key violations, the conflict
  10937. ** handler is invoked with CHANGESET_FOREIGN_KEY as the second argument
  10938. ** exactly once before the changeset is committed. If the conflict handler
  10939. ** returns CHANGESET_OMIT, the changes, including those that caused the
  10940. ** foreign key constraint violation, are committed. Or, if it returns
  10941. ** CHANGESET_ABORT, the changeset is rolled back.
  10942. **
  10943. ** No current or conflicting row information is provided. The only function
  10944. ** it is possible to call on the supplied sqlite3_changeset_iter handle
  10945. ** is sqlite3changeset_fk_conflicts().
  10946. **
  10947. ** <dt>SQLITE_CHANGESET_CONSTRAINT<dd>
  10948. ** If any other constraint violation occurs while applying a change (i.e.
  10949. ** a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is
  10950. ** invoked with CHANGESET_CONSTRAINT as the second argument.
  10951. **
  10952. ** There is no conflicting row in this case. The results of invoking the
  10953. ** sqlite3changeset_conflict() API are undefined.
  10954. **
  10955. ** </dl>
  10956. */
  10957. #define SQLITE_CHANGESET_DATA 1
  10958. #define SQLITE_CHANGESET_NOTFOUND 2
  10959. #define SQLITE_CHANGESET_CONFLICT 3
  10960. #define SQLITE_CHANGESET_CONSTRAINT 4
  10961. #define SQLITE_CHANGESET_FOREIGN_KEY 5
  10962. /*
  10963. ** CAPI3REF: Constants Returned By The Conflict Handler
  10964. **
  10965. ** A conflict handler callback must return one of the following three values.
  10966. **
  10967. ** <dl>
  10968. ** <dt>SQLITE_CHANGESET_OMIT<dd>
  10969. ** If a conflict handler returns this value no special action is taken. The
  10970. ** change that caused the conflict is not applied. The session module
  10971. ** continues to the next change in the changeset.
  10972. **
  10973. ** <dt>SQLITE_CHANGESET_REPLACE<dd>
  10974. ** This value may only be returned if the second argument to the conflict
  10975. ** handler was SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT. If this
  10976. ** is not the case, any changes applied so far are rolled back and the
  10977. ** call to sqlite3changeset_apply() returns SQLITE_MISUSE.
  10978. **
  10979. ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_DATA conflict
  10980. ** handler, then the conflicting row is either updated or deleted, depending
  10981. ** on the type of change.
  10982. **
  10983. ** If CHANGESET_REPLACE is returned by an SQLITE_CHANGESET_CONFLICT conflict
  10984. ** handler, then the conflicting row is removed from the database and a
  10985. ** second attempt to apply the change is made. If this second attempt fails,
  10986. ** the original row is restored to the database before continuing.
  10987. **
  10988. ** <dt>SQLITE_CHANGESET_ABORT<dd>
  10989. ** If this value is returned, any changes applied so far are rolled back
  10990. ** and the call to sqlite3changeset_apply() returns SQLITE_ABORT.
  10991. ** </dl>
  10992. */
  10993. #define SQLITE_CHANGESET_OMIT 0
  10994. #define SQLITE_CHANGESET_REPLACE 1
  10995. #define SQLITE_CHANGESET_ABORT 2
  10996. /*
  10997. ** CAPI3REF: Rebasing changesets
  10998. ** EXPERIMENTAL
  10999. **
  11000. ** Suppose there is a site hosting a database in state S0. And that
  11001. ** modifications are made that move that database to state S1 and a
  11002. ** changeset recorded (the "local" changeset). Then, a changeset based
  11003. ** on S0 is received from another site (the "remote" changeset) and
  11004. ** applied to the database. The database is then in state
  11005. ** (S1+"remote"), where the exact state depends on any conflict
  11006. ** resolution decisions (OMIT or REPLACE) made while applying "remote".
  11007. ** Rebasing a changeset is to update it to take those conflict
  11008. ** resolution decisions into account, so that the same conflicts
  11009. ** do not have to be resolved elsewhere in the network.
  11010. **
  11011. ** For example, if both the local and remote changesets contain an
  11012. ** INSERT of the same key on "CREATE TABLE t1(a PRIMARY KEY, b)":
  11013. **
  11014. ** local: INSERT INTO t1 VALUES(1, 'v1');
  11015. ** remote: INSERT INTO t1 VALUES(1, 'v2');
  11016. **
  11017. ** and the conflict resolution is REPLACE, then the INSERT change is
  11018. ** removed from the local changeset (it was overridden). Or, if the
  11019. ** conflict resolution was "OMIT", then the local changeset is modified
  11020. ** to instead contain:
  11021. **
  11022. ** UPDATE t1 SET b = 'v2' WHERE a=1;
  11023. **
  11024. ** Changes within the local changeset are rebased as follows:
  11025. **
  11026. ** <dl>
  11027. ** <dt>Local INSERT<dd>
  11028. ** This may only conflict with a remote INSERT. If the conflict
  11029. ** resolution was OMIT, then add an UPDATE change to the rebased
  11030. ** changeset. Or, if the conflict resolution was REPLACE, add
  11031. ** nothing to the rebased changeset.
  11032. **
  11033. ** <dt>Local DELETE<dd>
  11034. ** This may conflict with a remote UPDATE or DELETE. In both cases the
  11035. ** only possible resolution is OMIT. If the remote operation was a
  11036. ** DELETE, then add no change to the rebased changeset. If the remote
  11037. ** operation was an UPDATE, then the old.* fields of change are updated
  11038. ** to reflect the new.* values in the UPDATE.
  11039. **
  11040. ** <dt>Local UPDATE<dd>
  11041. ** This may conflict with a remote UPDATE or DELETE. If it conflicts
  11042. ** with a DELETE, and the conflict resolution was OMIT, then the update
  11043. ** is changed into an INSERT. Any undefined values in the new.* record
  11044. ** from the update change are filled in using the old.* values from
  11045. ** the conflicting DELETE. Or, if the conflict resolution was REPLACE,
  11046. ** the UPDATE change is simply omitted from the rebased changeset.
  11047. **
  11048. ** If conflict is with a remote UPDATE and the resolution is OMIT, then
  11049. ** the old.* values are rebased using the new.* values in the remote
  11050. ** change. Or, if the resolution is REPLACE, then the change is copied
  11051. ** into the rebased changeset with updates to columns also updated by
  11052. ** the conflicting remote UPDATE removed. If this means no columns would
  11053. ** be updated, the change is omitted.
  11054. ** </dl>
  11055. **
  11056. ** A local change may be rebased against multiple remote changes
  11057. ** simultaneously. If a single key is modified by multiple remote
  11058. ** changesets, they are combined as follows before the local changeset
  11059. ** is rebased:
  11060. **
  11061. ** <ul>
  11062. ** <li> If there has been one or more REPLACE resolutions on a
  11063. ** key, it is rebased according to a REPLACE.
  11064. **
  11065. ** <li> If there have been no REPLACE resolutions on a key, then
  11066. ** the local changeset is rebased according to the most recent
  11067. ** of the OMIT resolutions.
  11068. ** </ul>
  11069. **
  11070. ** Note that conflict resolutions from multiple remote changesets are
  11071. ** combined on a per-field basis, not per-row. This means that in the
  11072. ** case of multiple remote UPDATE operations, some fields of a single
  11073. ** local change may be rebased for REPLACE while others are rebased for
  11074. ** OMIT.
  11075. **
  11076. ** In order to rebase a local changeset, the remote changeset must first
  11077. ** be applied to the local database using sqlite3changeset_apply_v2() and
  11078. ** the buffer of rebase information captured. Then:
  11079. **
  11080. ** <ol>
  11081. ** <li> An sqlite3_rebaser object is created by calling
  11082. ** sqlite3rebaser_create().
  11083. ** <li> The new object is configured with the rebase buffer obtained from
  11084. ** sqlite3changeset_apply_v2() by calling sqlite3rebaser_configure().
  11085. ** If the local changeset is to be rebased against multiple remote
  11086. ** changesets, then sqlite3rebaser_configure() should be called
  11087. ** multiple times, in the same order that the multiple
  11088. ** sqlite3changeset_apply_v2() calls were made.
  11089. ** <li> Each local changeset is rebased by calling sqlite3rebaser_rebase().
  11090. ** <li> The sqlite3_rebaser object is deleted by calling
  11091. ** sqlite3rebaser_delete().
  11092. ** </ol>
  11093. */
  11094. typedef struct sqlite3_rebaser sqlite3_rebaser;
  11095. /*
  11096. ** CAPI3REF: Create a changeset rebaser object.
  11097. ** EXPERIMENTAL
  11098. **
  11099. ** Allocate a new changeset rebaser object. If successful, set (*ppNew) to
  11100. ** point to the new object and return SQLITE_OK. Otherwise, if an error
  11101. ** occurs, return an SQLite error code (e.g. SQLITE_NOMEM) and set (*ppNew)
  11102. ** to NULL.
  11103. */
  11104. SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew);
  11105. /*
  11106. ** CAPI3REF: Configure a changeset rebaser object.
  11107. ** EXPERIMENTAL
  11108. **
  11109. ** Configure the changeset rebaser object to rebase changesets according
  11110. ** to the conflict resolutions described by buffer pRebase (size nRebase
  11111. ** bytes), which must have been obtained from a previous call to
  11112. ** sqlite3changeset_apply_v2().
  11113. */
  11114. SQLITE_API int sqlite3rebaser_configure(
  11115. sqlite3_rebaser*,
  11116. int nRebase, const void *pRebase
  11117. );
  11118. /*
  11119. ** CAPI3REF: Rebase a changeset
  11120. ** EXPERIMENTAL
  11121. **
  11122. ** Argument pIn must point to a buffer containing a changeset nIn bytes
  11123. ** in size. This function allocates and populates a buffer with a copy
  11124. ** of the changeset rebased rebased according to the configuration of the
  11125. ** rebaser object passed as the first argument. If successful, (*ppOut)
  11126. ** is set to point to the new buffer containing the rebased changset and
  11127. ** (*pnOut) to its size in bytes and SQLITE_OK returned. It is the
  11128. ** responsibility of the caller to eventually free the new buffer using
  11129. ** sqlite3_free(). Otherwise, if an error occurs, (*ppOut) and (*pnOut)
  11130. ** are set to zero and an SQLite error code returned.
  11131. */
  11132. SQLITE_API int sqlite3rebaser_rebase(
  11133. sqlite3_rebaser*,
  11134. int nIn, const void *pIn,
  11135. int *pnOut, void **ppOut
  11136. );
  11137. /*
  11138. ** CAPI3REF: Delete a changeset rebaser object.
  11139. ** EXPERIMENTAL
  11140. **
  11141. ** Delete the changeset rebaser object and all associated resources. There
  11142. ** should be one call to this function for each successful invocation
  11143. ** of sqlite3rebaser_create().
  11144. */
  11145. SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p);
  11146. /*
  11147. ** CAPI3REF: Streaming Versions of API functions.
  11148. **
  11149. ** The six streaming API xxx_strm() functions serve similar purposes to the
  11150. ** corresponding non-streaming API functions:
  11151. **
  11152. ** <table border=1 style="margin-left:8ex;margin-right:8ex">
  11153. ** <tr><th>Streaming function<th>Non-streaming equivalent</th>
  11154. ** <tr><td>sqlite3changeset_apply_strm<td>[sqlite3changeset_apply]
  11155. ** <tr><td>sqlite3changeset_apply_strm_v2<td>[sqlite3changeset_apply_v2]
  11156. ** <tr><td>sqlite3changeset_concat_strm<td>[sqlite3changeset_concat]
  11157. ** <tr><td>sqlite3changeset_invert_strm<td>[sqlite3changeset_invert]
  11158. ** <tr><td>sqlite3changeset_start_strm<td>[sqlite3changeset_start]
  11159. ** <tr><td>sqlite3session_changeset_strm<td>[sqlite3session_changeset]
  11160. ** <tr><td>sqlite3session_patchset_strm<td>[sqlite3session_patchset]
  11161. ** </table>
  11162. **
  11163. ** Non-streaming functions that accept changesets (or patchsets) as input
  11164. ** require that the entire changeset be stored in a single buffer in memory.
  11165. ** Similarly, those that return a changeset or patchset do so by returning
  11166. ** a pointer to a single large buffer allocated using sqlite3_malloc().
  11167. ** Normally this is convenient. However, if an application running in a
  11168. ** low-memory environment is required to handle very large changesets, the
  11169. ** large contiguous memory allocations required can become onerous.
  11170. **
  11171. ** In order to avoid this problem, instead of a single large buffer, input
  11172. ** is passed to a streaming API functions by way of a callback function that
  11173. ** the sessions module invokes to incrementally request input data as it is
  11174. ** required. In all cases, a pair of API function parameters such as
  11175. **
  11176. ** <pre>
  11177. ** &nbsp; int nChangeset,
  11178. ** &nbsp; void *pChangeset,
  11179. ** </pre>
  11180. **
  11181. ** Is replaced by:
  11182. **
  11183. ** <pre>
  11184. ** &nbsp; int (*xInput)(void *pIn, void *pData, int *pnData),
  11185. ** &nbsp; void *pIn,
  11186. ** </pre>
  11187. **
  11188. ** Each time the xInput callback is invoked by the sessions module, the first
  11189. ** argument passed is a copy of the supplied pIn context pointer. The second
  11190. ** argument, pData, points to a buffer (*pnData) bytes in size. Assuming no
  11191. ** error occurs the xInput method should copy up to (*pnData) bytes of data
  11192. ** into the buffer and set (*pnData) to the actual number of bytes copied
  11193. ** before returning SQLITE_OK. If the input is completely exhausted, (*pnData)
  11194. ** should be set to zero to indicate this. Or, if an error occurs, an SQLite
  11195. ** error code should be returned. In all cases, if an xInput callback returns
  11196. ** an error, all processing is abandoned and the streaming API function
  11197. ** returns a copy of the error code to the caller.
  11198. **
  11199. ** In the case of sqlite3changeset_start_strm(), the xInput callback may be
  11200. ** invoked by the sessions module at any point during the lifetime of the
  11201. ** iterator. If such an xInput callback returns an error, the iterator enters
  11202. ** an error state, whereby all subsequent calls to iterator functions
  11203. ** immediately fail with the same error code as returned by xInput.
  11204. **
  11205. ** Similarly, streaming API functions that return changesets (or patchsets)
  11206. ** return them in chunks by way of a callback function instead of via a
  11207. ** pointer to a single large buffer. In this case, a pair of parameters such
  11208. ** as:
  11209. **
  11210. ** <pre>
  11211. ** &nbsp; int *pnChangeset,
  11212. ** &nbsp; void **ppChangeset,
  11213. ** </pre>
  11214. **
  11215. ** Is replaced by:
  11216. **
  11217. ** <pre>
  11218. ** &nbsp; int (*xOutput)(void *pOut, const void *pData, int nData),
  11219. ** &nbsp; void *pOut
  11220. ** </pre>
  11221. **
  11222. ** The xOutput callback is invoked zero or more times to return data to
  11223. ** the application. The first parameter passed to each call is a copy of the
  11224. ** pOut pointer supplied by the application. The second parameter, pData,
  11225. ** points to a buffer nData bytes in size containing the chunk of output
  11226. ** data being returned. If the xOutput callback successfully processes the
  11227. ** supplied data, it should return SQLITE_OK to indicate success. Otherwise,
  11228. ** it should return some other SQLite error code. In this case processing
  11229. ** is immediately abandoned and the streaming API function returns a copy
  11230. ** of the xOutput error code to the application.
  11231. **
  11232. ** The sessions module never invokes an xOutput callback with the third
  11233. ** parameter set to a value less than or equal to zero. Other than this,
  11234. ** no guarantees are made as to the size of the chunks of data returned.
  11235. */
  11236. SQLITE_API int sqlite3changeset_apply_strm(
  11237. sqlite3 *db, /* Apply change to "main" db of this handle */
  11238. int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
  11239. void *pIn, /* First arg for xInput */
  11240. int(*xFilter)(
  11241. void *pCtx, /* Copy of sixth arg to _apply() */
  11242. const char *zTab /* Table name */
  11243. ),
  11244. int(*xConflict)(
  11245. void *pCtx, /* Copy of sixth arg to _apply() */
  11246. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  11247. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  11248. ),
  11249. void *pCtx /* First argument passed to xConflict */
  11250. );
  11251. SQLITE_API int sqlite3changeset_apply_v2_strm(
  11252. sqlite3 *db, /* Apply change to "main" db of this handle */
  11253. int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
  11254. void *pIn, /* First arg for xInput */
  11255. int(*xFilter)(
  11256. void *pCtx, /* Copy of sixth arg to _apply() */
  11257. const char *zTab /* Table name */
  11258. ),
  11259. int(*xConflict)(
  11260. void *pCtx, /* Copy of sixth arg to _apply() */
  11261. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  11262. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  11263. ),
  11264. void *pCtx, /* First argument passed to xConflict */
  11265. void **ppRebase, int *pnRebase,
  11266. int flags
  11267. );
  11268. SQLITE_API int sqlite3changeset_concat_strm(
  11269. int (*xInputA)(void *pIn, void *pData, int *pnData),
  11270. void *pInA,
  11271. int (*xInputB)(void *pIn, void *pData, int *pnData),
  11272. void *pInB,
  11273. int (*xOutput)(void *pOut, const void *pData, int nData),
  11274. void *pOut
  11275. );
  11276. SQLITE_API int sqlite3changeset_invert_strm(
  11277. int (*xInput)(void *pIn, void *pData, int *pnData),
  11278. void *pIn,
  11279. int (*xOutput)(void *pOut, const void *pData, int nData),
  11280. void *pOut
  11281. );
  11282. SQLITE_API int sqlite3changeset_start_strm(
  11283. sqlite3_changeset_iter **pp,
  11284. int (*xInput)(void *pIn, void *pData, int *pnData),
  11285. void *pIn
  11286. );
  11287. SQLITE_API int sqlite3session_changeset_strm(
  11288. sqlite3_session *pSession,
  11289. int (*xOutput)(void *pOut, const void *pData, int nData),
  11290. void *pOut
  11291. );
  11292. SQLITE_API int sqlite3session_patchset_strm(
  11293. sqlite3_session *pSession,
  11294. int (*xOutput)(void *pOut, const void *pData, int nData),
  11295. void *pOut
  11296. );
  11297. SQLITE_API int sqlite3changegroup_add_strm(sqlite3_changegroup*,
  11298. int (*xInput)(void *pIn, void *pData, int *pnData),
  11299. void *pIn
  11300. );
  11301. SQLITE_API int sqlite3changegroup_output_strm(sqlite3_changegroup*,
  11302. int (*xOutput)(void *pOut, const void *pData, int nData),
  11303. void *pOut
  11304. );
  11305. SQLITE_API int sqlite3rebaser_rebase_strm(
  11306. sqlite3_rebaser *pRebaser,
  11307. int (*xInput)(void *pIn, void *pData, int *pnData),
  11308. void *pIn,
  11309. int (*xOutput)(void *pOut, const void *pData, int nData),
  11310. void *pOut
  11311. );
  11312. /*
  11313. ** Make sure we can call this stuff from C++.
  11314. */
  11315. #if 0
  11316. }
  11317. #endif
  11318. #endif /* !defined(__SQLITESESSION_H_) && defined(SQLITE_ENABLE_SESSION) */
  11319. /******** End of sqlite3session.h *********/
  11320. /******** Begin file fts5.h *********/
  11321. /*
  11322. ** 2014 May 31
  11323. **
  11324. ** The author disclaims copyright to this source code. In place of
  11325. ** a legal notice, here is a blessing:
  11326. **
  11327. ** May you do good and not evil.
  11328. ** May you find forgiveness for yourself and forgive others.
  11329. ** May you share freely, never taking more than you give.
  11330. **
  11331. ******************************************************************************
  11332. **
  11333. ** Interfaces to extend FTS5. Using the interfaces defined in this file,
  11334. ** FTS5 may be extended with:
  11335. **
  11336. ** * custom tokenizers, and
  11337. ** * custom auxiliary functions.
  11338. */
  11339. #ifndef _FTS5_H
  11340. #define _FTS5_H
  11341. #if 0
  11342. extern "C" {
  11343. #endif
  11344. /*************************************************************************
  11345. ** CUSTOM AUXILIARY FUNCTIONS
  11346. **
  11347. ** Virtual table implementations may overload SQL functions by implementing
  11348. ** the sqlite3_module.xFindFunction() method.
  11349. */
  11350. typedef struct Fts5ExtensionApi Fts5ExtensionApi;
  11351. typedef struct Fts5Context Fts5Context;
  11352. typedef struct Fts5PhraseIter Fts5PhraseIter;
  11353. typedef void (*fts5_extension_function)(
  11354. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  11355. Fts5Context *pFts, /* First arg to pass to pApi functions */
  11356. sqlite3_context *pCtx, /* Context for returning result/error */
  11357. int nVal, /* Number of values in apVal[] array */
  11358. sqlite3_value **apVal /* Array of trailing arguments */
  11359. );
  11360. struct Fts5PhraseIter {
  11361. const unsigned char *a;
  11362. const unsigned char *b;
  11363. };
  11364. /*
  11365. ** EXTENSION API FUNCTIONS
  11366. **
  11367. ** xUserData(pFts):
  11368. ** Return a copy of the context pointer the extension function was
  11369. ** registered with.
  11370. **
  11371. ** xColumnTotalSize(pFts, iCol, pnToken):
  11372. ** If parameter iCol is less than zero, set output variable *pnToken
  11373. ** to the total number of tokens in the FTS5 table. Or, if iCol is
  11374. ** non-negative but less than the number of columns in the table, return
  11375. ** the total number of tokens in column iCol, considering all rows in
  11376. ** the FTS5 table.
  11377. **
  11378. ** If parameter iCol is greater than or equal to the number of columns
  11379. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  11380. ** an OOM condition or IO error), an appropriate SQLite error code is
  11381. ** returned.
  11382. **
  11383. ** xColumnCount(pFts):
  11384. ** Return the number of columns in the table.
  11385. **
  11386. ** xColumnSize(pFts, iCol, pnToken):
  11387. ** If parameter iCol is less than zero, set output variable *pnToken
  11388. ** to the total number of tokens in the current row. Or, if iCol is
  11389. ** non-negative but less than the number of columns in the table, set
  11390. ** *pnToken to the number of tokens in column iCol of the current row.
  11391. **
  11392. ** If parameter iCol is greater than or equal to the number of columns
  11393. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  11394. ** an OOM condition or IO error), an appropriate SQLite error code is
  11395. ** returned.
  11396. **
  11397. ** This function may be quite inefficient if used with an FTS5 table
  11398. ** created with the "columnsize=0" option.
  11399. **
  11400. ** xColumnText:
  11401. ** This function attempts to retrieve the text of column iCol of the
  11402. ** current document. If successful, (*pz) is set to point to a buffer
  11403. ** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
  11404. ** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
  11405. ** if an error occurs, an SQLite error code is returned and the final values
  11406. ** of (*pz) and (*pn) are undefined.
  11407. **
  11408. ** xPhraseCount:
  11409. ** Returns the number of phrases in the current query expression.
  11410. **
  11411. ** xPhraseSize:
  11412. ** Returns the number of tokens in phrase iPhrase of the query. Phrases
  11413. ** are numbered starting from zero.
  11414. **
  11415. ** xInstCount:
  11416. ** Set *pnInst to the total number of occurrences of all phrases within
  11417. ** the query within the current row. Return SQLITE_OK if successful, or
  11418. ** an error code (i.e. SQLITE_NOMEM) if an error occurs.
  11419. **
  11420. ** This API can be quite slow if used with an FTS5 table created with the
  11421. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  11422. ** with either "detail=none" or "detail=column" and "content=" option
  11423. ** (i.e. if it is a contentless table), then this API always returns 0.
  11424. **
  11425. ** xInst:
  11426. ** Query for the details of phrase match iIdx within the current row.
  11427. ** Phrase matches are numbered starting from zero, so the iIdx argument
  11428. ** should be greater than or equal to zero and smaller than the value
  11429. ** output by xInstCount().
  11430. **
  11431. ** Usually, output parameter *piPhrase is set to the phrase number, *piCol
  11432. ** to the column in which it occurs and *piOff the token offset of the
  11433. ** first token of the phrase. The exception is if the table was created
  11434. ** with the offsets=0 option specified. In this case *piOff is always
  11435. ** set to -1.
  11436. **
  11437. ** Returns SQLITE_OK if successful, or an error code (i.e. SQLITE_NOMEM)
  11438. ** if an error occurs.
  11439. **
  11440. ** This API can be quite slow if used with an FTS5 table created with the
  11441. ** "detail=none" or "detail=column" option.
  11442. **
  11443. ** xRowid:
  11444. ** Returns the rowid of the current row.
  11445. **
  11446. ** xTokenize:
  11447. ** Tokenize text using the tokenizer belonging to the FTS5 table.
  11448. **
  11449. ** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
  11450. ** This API function is used to query the FTS table for phrase iPhrase
  11451. ** of the current query. Specifically, a query equivalent to:
  11452. **
  11453. ** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
  11454. **
  11455. ** with $p set to a phrase equivalent to the phrase iPhrase of the
  11456. ** current query is executed. Any column filter that applies to
  11457. ** phrase iPhrase of the current query is included in $p. For each
  11458. ** row visited, the callback function passed as the fourth argument
  11459. ** is invoked. The context and API objects passed to the callback
  11460. ** function may be used to access the properties of each matched row.
  11461. ** Invoking Api.xUserData() returns a copy of the pointer passed as
  11462. ** the third argument to pUserData.
  11463. **
  11464. ** If the callback function returns any value other than SQLITE_OK, the
  11465. ** query is abandoned and the xQueryPhrase function returns immediately.
  11466. ** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
  11467. ** Otherwise, the error code is propagated upwards.
  11468. **
  11469. ** If the query runs to completion without incident, SQLITE_OK is returned.
  11470. ** Or, if some error occurs before the query completes or is aborted by
  11471. ** the callback, an SQLite error code is returned.
  11472. **
  11473. **
  11474. ** xSetAuxdata(pFts5, pAux, xDelete)
  11475. **
  11476. ** Save the pointer passed as the second argument as the extension functions
  11477. ** "auxiliary data". The pointer may then be retrieved by the current or any
  11478. ** future invocation of the same fts5 extension function made as part of
  11479. ** of the same MATCH query using the xGetAuxdata() API.
  11480. **
  11481. ** Each extension function is allocated a single auxiliary data slot for
  11482. ** each FTS query (MATCH expression). If the extension function is invoked
  11483. ** more than once for a single FTS query, then all invocations share a
  11484. ** single auxiliary data context.
  11485. **
  11486. ** If there is already an auxiliary data pointer when this function is
  11487. ** invoked, then it is replaced by the new pointer. If an xDelete callback
  11488. ** was specified along with the original pointer, it is invoked at this
  11489. ** point.
  11490. **
  11491. ** The xDelete callback, if one is specified, is also invoked on the
  11492. ** auxiliary data pointer after the FTS5 query has finished.
  11493. **
  11494. ** If an error (e.g. an OOM condition) occurs within this function, an
  11495. ** the auxiliary data is set to NULL and an error code returned. If the
  11496. ** xDelete parameter was not NULL, it is invoked on the auxiliary data
  11497. ** pointer before returning.
  11498. **
  11499. **
  11500. ** xGetAuxdata(pFts5, bClear)
  11501. **
  11502. ** Returns the current auxiliary data pointer for the fts5 extension
  11503. ** function. See the xSetAuxdata() method for details.
  11504. **
  11505. ** If the bClear argument is non-zero, then the auxiliary data is cleared
  11506. ** (set to NULL) before this function returns. In this case the xDelete,
  11507. ** if any, is not invoked.
  11508. **
  11509. **
  11510. ** xRowCount(pFts5, pnRow)
  11511. **
  11512. ** This function is used to retrieve the total number of rows in the table.
  11513. ** In other words, the same value that would be returned by:
  11514. **
  11515. ** SELECT count(*) FROM ftstable;
  11516. **
  11517. ** xPhraseFirst()
  11518. ** This function is used, along with type Fts5PhraseIter and the xPhraseNext
  11519. ** method, to iterate through all instances of a single query phrase within
  11520. ** the current row. This is the same information as is accessible via the
  11521. ** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
  11522. ** to use, this API may be faster under some circumstances. To iterate
  11523. ** through instances of phrase iPhrase, use the following code:
  11524. **
  11525. ** Fts5PhraseIter iter;
  11526. ** int iCol, iOff;
  11527. ** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
  11528. ** iCol>=0;
  11529. ** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
  11530. ** ){
  11531. ** // An instance of phrase iPhrase at offset iOff of column iCol
  11532. ** }
  11533. **
  11534. ** The Fts5PhraseIter structure is defined above. Applications should not
  11535. ** modify this structure directly - it should only be used as shown above
  11536. ** with the xPhraseFirst() and xPhraseNext() API methods (and by
  11537. ** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
  11538. **
  11539. ** This API can be quite slow if used with an FTS5 table created with the
  11540. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  11541. ** with either "detail=none" or "detail=column" and "content=" option
  11542. ** (i.e. if it is a contentless table), then this API always iterates
  11543. ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
  11544. **
  11545. ** xPhraseNext()
  11546. ** See xPhraseFirst above.
  11547. **
  11548. ** xPhraseFirstColumn()
  11549. ** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
  11550. ** and xPhraseNext() APIs described above. The difference is that instead
  11551. ** of iterating through all instances of a phrase in the current row, these
  11552. ** APIs are used to iterate through the set of columns in the current row
  11553. ** that contain one or more instances of a specified phrase. For example:
  11554. **
  11555. ** Fts5PhraseIter iter;
  11556. ** int iCol;
  11557. ** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
  11558. ** iCol>=0;
  11559. ** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
  11560. ** ){
  11561. ** // Column iCol contains at least one instance of phrase iPhrase
  11562. ** }
  11563. **
  11564. ** This API can be quite slow if used with an FTS5 table created with the
  11565. ** "detail=none" option. If the FTS5 table is created with either
  11566. ** "detail=none" "content=" option (i.e. if it is a contentless table),
  11567. ** then this API always iterates through an empty set (all calls to
  11568. ** xPhraseFirstColumn() set iCol to -1).
  11569. **
  11570. ** The information accessed using this API and its companion
  11571. ** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
  11572. ** (or xInst/xInstCount). The chief advantage of this API is that it is
  11573. ** significantly more efficient than those alternatives when used with
  11574. ** "detail=column" tables.
  11575. **
  11576. ** xPhraseNextColumn()
  11577. ** See xPhraseFirstColumn above.
  11578. */
  11579. struct Fts5ExtensionApi {
  11580. int iVersion; /* Currently always set to 3 */
  11581. void *(*xUserData)(Fts5Context*);
  11582. int (*xColumnCount)(Fts5Context*);
  11583. int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
  11584. int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
  11585. int (*xTokenize)(Fts5Context*,
  11586. const char *pText, int nText, /* Text to tokenize */
  11587. void *pCtx, /* Context passed to xToken() */
  11588. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  11589. );
  11590. int (*xPhraseCount)(Fts5Context*);
  11591. int (*xPhraseSize)(Fts5Context*, int iPhrase);
  11592. int (*xInstCount)(Fts5Context*, int *pnInst);
  11593. int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);
  11594. sqlite3_int64 (*xRowid)(Fts5Context*);
  11595. int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);
  11596. int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);
  11597. int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,
  11598. int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)
  11599. );
  11600. int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));
  11601. void *(*xGetAuxdata)(Fts5Context*, int bClear);
  11602. int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);
  11603. void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);
  11604. int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);
  11605. void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
  11606. };
  11607. /*
  11608. ** CUSTOM AUXILIARY FUNCTIONS
  11609. *************************************************************************/
  11610. /*************************************************************************
  11611. ** CUSTOM TOKENIZERS
  11612. **
  11613. ** Applications may also register custom tokenizer types. A tokenizer
  11614. ** is registered by providing fts5 with a populated instance of the
  11615. ** following structure. All structure methods must be defined, setting
  11616. ** any member of the fts5_tokenizer struct to NULL leads to undefined
  11617. ** behaviour. The structure methods are expected to function as follows:
  11618. **
  11619. ** xCreate:
  11620. ** This function is used to allocate and initialize a tokenizer instance.
  11621. ** A tokenizer instance is required to actually tokenize text.
  11622. **
  11623. ** The first argument passed to this function is a copy of the (void*)
  11624. ** pointer provided by the application when the fts5_tokenizer object
  11625. ** was registered with FTS5 (the third argument to xCreateTokenizer()).
  11626. ** The second and third arguments are an array of nul-terminated strings
  11627. ** containing the tokenizer arguments, if any, specified following the
  11628. ** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
  11629. ** to create the FTS5 table.
  11630. **
  11631. ** The final argument is an output variable. If successful, (*ppOut)
  11632. ** should be set to point to the new tokenizer handle and SQLITE_OK
  11633. ** returned. If an error occurs, some value other than SQLITE_OK should
  11634. ** be returned. In this case, fts5 assumes that the final value of *ppOut
  11635. ** is undefined.
  11636. **
  11637. ** xDelete:
  11638. ** This function is invoked to delete a tokenizer handle previously
  11639. ** allocated using xCreate(). Fts5 guarantees that this function will
  11640. ** be invoked exactly once for each successful call to xCreate().
  11641. **
  11642. ** xTokenize:
  11643. ** This function is expected to tokenize the nText byte string indicated
  11644. ** by argument pText. pText may or may not be nul-terminated. The first
  11645. ** argument passed to this function is a pointer to an Fts5Tokenizer object
  11646. ** returned by an earlier call to xCreate().
  11647. **
  11648. ** The second argument indicates the reason that FTS5 is requesting
  11649. ** tokenization of the supplied text. This is always one of the following
  11650. ** four values:
  11651. **
  11652. ** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
  11653. ** or removed from the FTS table. The tokenizer is being invoked to
  11654. ** determine the set of tokens to add to (or delete from) the
  11655. ** FTS index.
  11656. **
  11657. ** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
  11658. ** against the FTS index. The tokenizer is being called to tokenize
  11659. ** a bareword or quoted string specified as part of the query.
  11660. **
  11661. ** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
  11662. ** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
  11663. ** followed by a "*" character, indicating that the last token
  11664. ** returned by the tokenizer will be treated as a token prefix.
  11665. **
  11666. ** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
  11667. ** satisfy an fts5_api.xTokenize() request made by an auxiliary
  11668. ** function. Or an fts5_api.xColumnSize() request made by the same
  11669. ** on a columnsize=0 database.
  11670. ** </ul>
  11671. **
  11672. ** For each token in the input string, the supplied callback xToken() must
  11673. ** be invoked. The first argument to it should be a copy of the pointer
  11674. ** passed as the second argument to xTokenize(). The third and fourth
  11675. ** arguments are a pointer to a buffer containing the token text, and the
  11676. ** size of the token in bytes. The 4th and 5th arguments are the byte offsets
  11677. ** of the first byte of and first byte immediately following the text from
  11678. ** which the token is derived within the input.
  11679. **
  11680. ** The second argument passed to the xToken() callback ("tflags") should
  11681. ** normally be set to 0. The exception is if the tokenizer supports
  11682. ** synonyms. In this case see the discussion below for details.
  11683. **
  11684. ** FTS5 assumes the xToken() callback is invoked for each token in the
  11685. ** order that they occur within the input text.
  11686. **
  11687. ** If an xToken() callback returns any value other than SQLITE_OK, then
  11688. ** the tokenization should be abandoned and the xTokenize() method should
  11689. ** immediately return a copy of the xToken() return value. Or, if the
  11690. ** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
  11691. ** if an error occurs with the xTokenize() implementation itself, it
  11692. ** may abandon the tokenization and return any error code other than
  11693. ** SQLITE_OK or SQLITE_DONE.
  11694. **
  11695. ** SYNONYM SUPPORT
  11696. **
  11697. ** Custom tokenizers may also support synonyms. Consider a case in which a
  11698. ** user wishes to query for a phrase such as "first place". Using the
  11699. ** built-in tokenizers, the FTS5 query 'first + place' will match instances
  11700. ** of "first place" within the document set, but not alternative forms
  11701. ** such as "1st place". In some applications, it would be better to match
  11702. ** all instances of "first place" or "1st place" regardless of which form
  11703. ** the user specified in the MATCH query text.
  11704. **
  11705. ** There are several ways to approach this in FTS5:
  11706. **
  11707. ** <ol><li> By mapping all synonyms to a single token. In this case, the
  11708. ** In the above example, this means that the tokenizer returns the
  11709. ** same token for inputs "first" and "1st". Say that token is in
  11710. ** fact "first", so that when the user inserts the document "I won
  11711. ** 1st place" entries are added to the index for tokens "i", "won",
  11712. ** "first" and "place". If the user then queries for '1st + place',
  11713. ** the tokenizer substitutes "first" for "1st" and the query works
  11714. ** as expected.
  11715. **
  11716. ** <li> By adding multiple synonyms for a single term to the FTS index.
  11717. ** In this case, when tokenizing query text, the tokenizer may
  11718. ** provide multiple synonyms for a single term within the document.
  11719. ** FTS5 then queries the index for each synonym individually. For
  11720. ** example, faced with the query:
  11721. **
  11722. ** <codeblock>
  11723. ** ... MATCH 'first place'</codeblock>
  11724. **
  11725. ** the tokenizer offers both "1st" and "first" as synonyms for the
  11726. ** first token in the MATCH query and FTS5 effectively runs a query
  11727. ** similar to:
  11728. **
  11729. ** <codeblock>
  11730. ** ... MATCH '(first OR 1st) place'</codeblock>
  11731. **
  11732. ** except that, for the purposes of auxiliary functions, the query
  11733. ** still appears to contain just two phrases - "(first OR 1st)"
  11734. ** being treated as a single phrase.
  11735. **
  11736. ** <li> By adding multiple synonyms for a single term to the FTS index.
  11737. ** Using this method, when tokenizing document text, the tokenizer
  11738. ** provides multiple synonyms for each token. So that when a
  11739. ** document such as "I won first place" is tokenized, entries are
  11740. ** added to the FTS index for "i", "won", "first", "1st" and
  11741. ** "place".
  11742. **
  11743. ** This way, even if the tokenizer does not provide synonyms
  11744. ** when tokenizing query text (it should not - to do would be
  11745. ** inefficient), it doesn't matter if the user queries for
  11746. ** 'first + place' or '1st + place', as there are entires in the
  11747. ** FTS index corresponding to both forms of the first token.
  11748. ** </ol>
  11749. **
  11750. ** Whether it is parsing document or query text, any call to xToken that
  11751. ** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
  11752. ** is considered to supply a synonym for the previous token. For example,
  11753. ** when parsing the document "I won first place", a tokenizer that supports
  11754. ** synonyms would call xToken() 5 times, as follows:
  11755. **
  11756. ** <codeblock>
  11757. ** xToken(pCtx, 0, "i", 1, 0, 1);
  11758. ** xToken(pCtx, 0, "won", 3, 2, 5);
  11759. ** xToken(pCtx, 0, "first", 5, 6, 11);
  11760. ** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
  11761. ** xToken(pCtx, 0, "place", 5, 12, 17);
  11762. **</codeblock>
  11763. **
  11764. ** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
  11765. ** xToken() is called. Multiple synonyms may be specified for a single token
  11766. ** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
  11767. ** There is no limit to the number of synonyms that may be provided for a
  11768. ** single token.
  11769. **
  11770. ** In many cases, method (1) above is the best approach. It does not add
  11771. ** extra data to the FTS index or require FTS5 to query for multiple terms,
  11772. ** so it is efficient in terms of disk space and query speed. However, it
  11773. ** does not support prefix queries very well. If, as suggested above, the
  11774. ** token "first" is subsituted for "1st" by the tokenizer, then the query:
  11775. **
  11776. ** <codeblock>
  11777. ** ... MATCH '1s*'</codeblock>
  11778. **
  11779. ** will not match documents that contain the token "1st" (as the tokenizer
  11780. ** will probably not map "1s" to any prefix of "first").
  11781. **
  11782. ** For full prefix support, method (3) may be preferred. In this case,
  11783. ** because the index contains entries for both "first" and "1st", prefix
  11784. ** queries such as 'fi*' or '1s*' will match correctly. However, because
  11785. ** extra entries are added to the FTS index, this method uses more space
  11786. ** within the database.
  11787. **
  11788. ** Method (2) offers a midpoint between (1) and (3). Using this method,
  11789. ** a query such as '1s*' will match documents that contain the literal
  11790. ** token "1st", but not "first" (assuming the tokenizer is not able to
  11791. ** provide synonyms for prefixes). However, a non-prefix query like '1st'
  11792. ** will match against "1st" and "first". This method does not require
  11793. ** extra disk space, as no extra entries are added to the FTS index.
  11794. ** On the other hand, it may require more CPU cycles to run MATCH queries,
  11795. ** as separate queries of the FTS index are required for each synonym.
  11796. **
  11797. ** When using methods (2) or (3), it is important that the tokenizer only
  11798. ** provide synonyms when tokenizing document text (method (2)) or query
  11799. ** text (method (3)), not both. Doing so will not cause any errors, but is
  11800. ** inefficient.
  11801. */
  11802. typedef struct Fts5Tokenizer Fts5Tokenizer;
  11803. typedef struct fts5_tokenizer fts5_tokenizer;
  11804. struct fts5_tokenizer {
  11805. int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
  11806. void (*xDelete)(Fts5Tokenizer*);
  11807. int (*xTokenize)(Fts5Tokenizer*,
  11808. void *pCtx,
  11809. int flags, /* Mask of FTS5_TOKENIZE_* flags */
  11810. const char *pText, int nText,
  11811. int (*xToken)(
  11812. void *pCtx, /* Copy of 2nd argument to xTokenize() */
  11813. int tflags, /* Mask of FTS5_TOKEN_* flags */
  11814. const char *pToken, /* Pointer to buffer containing token */
  11815. int nToken, /* Size of token in bytes */
  11816. int iStart, /* Byte offset of token within input text */
  11817. int iEnd /* Byte offset of end of token within input text */
  11818. )
  11819. );
  11820. };
  11821. /* Flags that may be passed as the third argument to xTokenize() */
  11822. #define FTS5_TOKENIZE_QUERY 0x0001
  11823. #define FTS5_TOKENIZE_PREFIX 0x0002
  11824. #define FTS5_TOKENIZE_DOCUMENT 0x0004
  11825. #define FTS5_TOKENIZE_AUX 0x0008
  11826. /* Flags that may be passed by the tokenizer implementation back to FTS5
  11827. ** as the third argument to the supplied xToken callback. */
  11828. #define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
  11829. /*
  11830. ** END OF CUSTOM TOKENIZERS
  11831. *************************************************************************/
  11832. /*************************************************************************
  11833. ** FTS5 EXTENSION REGISTRATION API
  11834. */
  11835. typedef struct fts5_api fts5_api;
  11836. struct fts5_api {
  11837. int iVersion; /* Currently always set to 2 */
  11838. /* Create a new tokenizer */
  11839. int (*xCreateTokenizer)(
  11840. fts5_api *pApi,
  11841. const char *zName,
  11842. void *pContext,
  11843. fts5_tokenizer *pTokenizer,
  11844. void (*xDestroy)(void*)
  11845. );
  11846. /* Find an existing tokenizer */
  11847. int (*xFindTokenizer)(
  11848. fts5_api *pApi,
  11849. const char *zName,
  11850. void **ppContext,
  11851. fts5_tokenizer *pTokenizer
  11852. );
  11853. /* Create a new auxiliary function */
  11854. int (*xCreateFunction)(
  11855. fts5_api *pApi,
  11856. const char *zName,
  11857. void *pContext,
  11858. fts5_extension_function xFunction,
  11859. void (*xDestroy)(void*)
  11860. );
  11861. };
  11862. /*
  11863. ** END OF REGISTRATION API
  11864. *************************************************************************/
  11865. #if 0
  11866. } /* end of the 'extern "C"' block */
  11867. #endif
  11868. #endif /* _FTS5_H */
  11869. /******** End of fts5.h *********/
  11870. /************** End of sqlite3.h *********************************************/
  11871. /************** Continuing where we left off in sqliteInt.h ******************/
  11872. /*
  11873. ** Include the configuration header output by 'configure' if we're using the
  11874. ** autoconf-based build
  11875. */
  11876. #if defined(_HAVE_SQLITE_CONFIG_H) && !defined(SQLITECONFIG_H)
  11877. /* #include "config.h" */
  11878. #define SQLITECONFIG_H 1
  11879. #endif
  11880. /************** Include sqliteLimit.h in the middle of sqliteInt.h ***********/
  11881. /************** Begin file sqliteLimit.h *************************************/
  11882. /*
  11883. ** 2007 May 7
  11884. **
  11885. ** The author disclaims copyright to this source code. In place of
  11886. ** a legal notice, here is a blessing:
  11887. **
  11888. ** May you do good and not evil.
  11889. ** May you find forgiveness for yourself and forgive others.
  11890. ** May you share freely, never taking more than you give.
  11891. **
  11892. *************************************************************************
  11893. **
  11894. ** This file defines various limits of what SQLite can process.
  11895. */
  11896. /*
  11897. ** The maximum length of a TEXT or BLOB in bytes. This also
  11898. ** limits the size of a row in a table or index.
  11899. **
  11900. ** The hard limit is the ability of a 32-bit signed integer
  11901. ** to count the size: 2^31-1 or 2147483647.
  11902. */
  11903. #ifndef SQLITE_MAX_LENGTH
  11904. # define SQLITE_MAX_LENGTH 1000000000
  11905. #endif
  11906. /*
  11907. ** This is the maximum number of
  11908. **
  11909. ** * Columns in a table
  11910. ** * Columns in an index
  11911. ** * Columns in a view
  11912. ** * Terms in the SET clause of an UPDATE statement
  11913. ** * Terms in the result set of a SELECT statement
  11914. ** * Terms in the GROUP BY or ORDER BY clauses of a SELECT statement.
  11915. ** * Terms in the VALUES clause of an INSERT statement
  11916. **
  11917. ** The hard upper limit here is 32676. Most database people will
  11918. ** tell you that in a well-normalized database, you usually should
  11919. ** not have more than a dozen or so columns in any table. And if
  11920. ** that is the case, there is no point in having more than a few
  11921. ** dozen values in any of the other situations described above.
  11922. */
  11923. #ifndef SQLITE_MAX_COLUMN
  11924. # define SQLITE_MAX_COLUMN 2000
  11925. #endif
  11926. /*
  11927. ** The maximum length of a single SQL statement in bytes.
  11928. **
  11929. ** It used to be the case that setting this value to zero would
  11930. ** turn the limit off. That is no longer true. It is not possible
  11931. ** to turn this limit off.
  11932. */
  11933. #ifndef SQLITE_MAX_SQL_LENGTH
  11934. # define SQLITE_MAX_SQL_LENGTH 1000000000
  11935. #endif
  11936. /*
  11937. ** The maximum depth of an expression tree. This is limited to
  11938. ** some extent by SQLITE_MAX_SQL_LENGTH. But sometime you might
  11939. ** want to place more severe limits on the complexity of an
  11940. ** expression.
  11941. **
  11942. ** A value of 0 used to mean that the limit was not enforced.
  11943. ** But that is no longer true. The limit is now strictly enforced
  11944. ** at all times.
  11945. */
  11946. #ifndef SQLITE_MAX_EXPR_DEPTH
  11947. # define SQLITE_MAX_EXPR_DEPTH 1000
  11948. #endif
  11949. /*
  11950. ** The maximum number of terms in a compound SELECT statement.
  11951. ** The code generator for compound SELECT statements does one
  11952. ** level of recursion for each term. A stack overflow can result
  11953. ** if the number of terms is too large. In practice, most SQL
  11954. ** never has more than 3 or 4 terms. Use a value of 0 to disable
  11955. ** any limit on the number of terms in a compount SELECT.
  11956. */
  11957. #ifndef SQLITE_MAX_COMPOUND_SELECT
  11958. # define SQLITE_MAX_COMPOUND_SELECT 500
  11959. #endif
  11960. /*
  11961. ** The maximum number of opcodes in a VDBE program.
  11962. ** Not currently enforced.
  11963. */
  11964. #ifndef SQLITE_MAX_VDBE_OP
  11965. # define SQLITE_MAX_VDBE_OP 250000000
  11966. #endif
  11967. /*
  11968. ** The maximum number of arguments to an SQL function.
  11969. */
  11970. #ifndef SQLITE_MAX_FUNCTION_ARG
  11971. # define SQLITE_MAX_FUNCTION_ARG 127
  11972. #endif
  11973. /*
  11974. ** The suggested maximum number of in-memory pages to use for
  11975. ** the main database table and for temporary tables.
  11976. **
  11977. ** IMPLEMENTATION-OF: R-30185-15359 The default suggested cache size is -2000,
  11978. ** which means the cache size is limited to 2048000 bytes of memory.
  11979. ** IMPLEMENTATION-OF: R-48205-43578 The default suggested cache size can be
  11980. ** altered using the SQLITE_DEFAULT_CACHE_SIZE compile-time options.
  11981. */
  11982. #ifndef SQLITE_DEFAULT_CACHE_SIZE
  11983. # define SQLITE_DEFAULT_CACHE_SIZE -2000
  11984. #endif
  11985. /*
  11986. ** The default number of frames to accumulate in the log file before
  11987. ** checkpointing the database in WAL mode.
  11988. */
  11989. #ifndef SQLITE_DEFAULT_WAL_AUTOCHECKPOINT
  11990. # define SQLITE_DEFAULT_WAL_AUTOCHECKPOINT 1000
  11991. #endif
  11992. /*
  11993. ** The maximum number of attached databases. This must be between 0
  11994. ** and 125. The upper bound of 125 is because the attached databases are
  11995. ** counted using a signed 8-bit integer which has a maximum value of 127
  11996. ** and we have to allow 2 extra counts for the "main" and "temp" databases.
  11997. */
  11998. #ifndef SQLITE_MAX_ATTACHED
  11999. # define SQLITE_MAX_ATTACHED 10
  12000. #endif
  12001. /*
  12002. ** The maximum value of a ?nnn wildcard that the parser will accept.
  12003. */
  12004. #ifndef SQLITE_MAX_VARIABLE_NUMBER
  12005. # define SQLITE_MAX_VARIABLE_NUMBER 999
  12006. #endif
  12007. /* Maximum page size. The upper bound on this value is 65536. This a limit
  12008. ** imposed by the use of 16-bit offsets within each page.
  12009. **
  12010. ** Earlier versions of SQLite allowed the user to change this value at
  12011. ** compile time. This is no longer permitted, on the grounds that it creates
  12012. ** a library that is technically incompatible with an SQLite library
  12013. ** compiled with a different limit. If a process operating on a database
  12014. ** with a page-size of 65536 bytes crashes, then an instance of SQLite
  12015. ** compiled with the default page-size limit will not be able to rollback
  12016. ** the aborted transaction. This could lead to database corruption.
  12017. */
  12018. #ifdef SQLITE_MAX_PAGE_SIZE
  12019. # undef SQLITE_MAX_PAGE_SIZE
  12020. #endif
  12021. #define SQLITE_MAX_PAGE_SIZE 65536
  12022. /*
  12023. ** The default size of a database page.
  12024. */
  12025. #ifndef SQLITE_DEFAULT_PAGE_SIZE
  12026. # define SQLITE_DEFAULT_PAGE_SIZE 4096
  12027. #endif
  12028. #if SQLITE_DEFAULT_PAGE_SIZE>SQLITE_MAX_PAGE_SIZE
  12029. # undef SQLITE_DEFAULT_PAGE_SIZE
  12030. # define SQLITE_DEFAULT_PAGE_SIZE SQLITE_MAX_PAGE_SIZE
  12031. #endif
  12032. /*
  12033. ** Ordinarily, if no value is explicitly provided, SQLite creates databases
  12034. ** with page size SQLITE_DEFAULT_PAGE_SIZE. However, based on certain
  12035. ** device characteristics (sector-size and atomic write() support),
  12036. ** SQLite may choose a larger value. This constant is the maximum value
  12037. ** SQLite will choose on its own.
  12038. */
  12039. #ifndef SQLITE_MAX_DEFAULT_PAGE_SIZE
  12040. # define SQLITE_MAX_DEFAULT_PAGE_SIZE 8192
  12041. #endif
  12042. #if SQLITE_MAX_DEFAULT_PAGE_SIZE>SQLITE_MAX_PAGE_SIZE
  12043. # undef SQLITE_MAX_DEFAULT_PAGE_SIZE
  12044. # define SQLITE_MAX_DEFAULT_PAGE_SIZE SQLITE_MAX_PAGE_SIZE
  12045. #endif
  12046. /*
  12047. ** Maximum number of pages in one database file.
  12048. **
  12049. ** This is really just the default value for the max_page_count pragma.
  12050. ** This value can be lowered (or raised) at run-time using that the
  12051. ** max_page_count macro.
  12052. */
  12053. #ifndef SQLITE_MAX_PAGE_COUNT
  12054. # define SQLITE_MAX_PAGE_COUNT 1073741823
  12055. #endif
  12056. /*
  12057. ** Maximum length (in bytes) of the pattern in a LIKE or GLOB
  12058. ** operator.
  12059. */
  12060. #ifndef SQLITE_MAX_LIKE_PATTERN_LENGTH
  12061. # define SQLITE_MAX_LIKE_PATTERN_LENGTH 50000
  12062. #endif
  12063. /*
  12064. ** Maximum depth of recursion for triggers.
  12065. **
  12066. ** A value of 1 means that a trigger program will not be able to itself
  12067. ** fire any triggers. A value of 0 means that no trigger programs at all
  12068. ** may be executed.
  12069. */
  12070. #ifndef SQLITE_MAX_TRIGGER_DEPTH
  12071. # define SQLITE_MAX_TRIGGER_DEPTH 1000
  12072. #endif
  12073. /************** End of sqliteLimit.h *****************************************/
  12074. /************** Continuing where we left off in sqliteInt.h ******************/
  12075. /* Disable nuisance warnings on Borland compilers */
  12076. #if defined(__BORLANDC__)
  12077. #pragma warn -rch /* unreachable code */
  12078. #pragma warn -ccc /* Condition is always true or false */
  12079. #pragma warn -aus /* Assigned value is never used */
  12080. #pragma warn -csu /* Comparing signed and unsigned */
  12081. #pragma warn -spa /* Suspicious pointer arithmetic */
  12082. #endif
  12083. /*
  12084. ** Include standard header files as necessary
  12085. */
  12086. #ifdef HAVE_STDINT_H
  12087. #include <stdint.h>
  12088. #endif
  12089. #ifdef HAVE_INTTYPES_H
  12090. #include <inttypes.h>
  12091. #endif
  12092. /*
  12093. ** The following macros are used to cast pointers to integers and
  12094. ** integers to pointers. The way you do this varies from one compiler
  12095. ** to the next, so we have developed the following set of #if statements
  12096. ** to generate appropriate macros for a wide range of compilers.
  12097. **
  12098. ** The correct "ANSI" way to do this is to use the intptr_t type.
  12099. ** Unfortunately, that typedef is not available on all compilers, or
  12100. ** if it is available, it requires an #include of specific headers
  12101. ** that vary from one machine to the next.
  12102. **
  12103. ** Ticket #3860: The llvm-gcc-4.2 compiler from Apple chokes on
  12104. ** the ((void*)&((char*)0)[X]) construct. But MSVC chokes on ((void*)(X)).
  12105. ** So we have to define the macros in different ways depending on the
  12106. ** compiler.
  12107. */
  12108. #if defined(__PTRDIFF_TYPE__) /* This case should work for GCC */
  12109. # define SQLITE_INT_TO_PTR(X) ((void*)(__PTRDIFF_TYPE__)(X))
  12110. # define SQLITE_PTR_TO_INT(X) ((int)(__PTRDIFF_TYPE__)(X))
  12111. #elif !defined(__GNUC__) /* Works for compilers other than LLVM */
  12112. # define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X])
  12113. # define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
  12114. #elif defined(HAVE_STDINT_H) /* Use this case if we have ANSI headers */
  12115. # define SQLITE_INT_TO_PTR(X) ((void*)(intptr_t)(X))
  12116. # define SQLITE_PTR_TO_INT(X) ((int)(intptr_t)(X))
  12117. #else /* Generates a warning - but it always works */
  12118. # define SQLITE_INT_TO_PTR(X) ((void*)(X))
  12119. # define SQLITE_PTR_TO_INT(X) ((int)(X))
  12120. #endif
  12121. /*
  12122. ** A macro to hint to the compiler that a function should not be
  12123. ** inlined.
  12124. */
  12125. #if defined(__GNUC__)
  12126. # define SQLITE_NOINLINE __attribute__((noinline))
  12127. #elif defined(_MSC_VER) && _MSC_VER>=1310
  12128. # define SQLITE_NOINLINE __declspec(noinline)
  12129. #else
  12130. # define SQLITE_NOINLINE
  12131. #endif
  12132. /*
  12133. ** Make sure that the compiler intrinsics we desire are enabled when
  12134. ** compiling with an appropriate version of MSVC unless prevented by
  12135. ** the SQLITE_DISABLE_INTRINSIC define.
  12136. */
  12137. #if !defined(SQLITE_DISABLE_INTRINSIC)
  12138. # if defined(_MSC_VER) && _MSC_VER>=1400
  12139. # if !defined(_WIN32_WCE)
  12140. # include <intrin.h>
  12141. # pragma intrinsic(_byteswap_ushort)
  12142. # pragma intrinsic(_byteswap_ulong)
  12143. # pragma intrinsic(_byteswap_uint64)
  12144. # pragma intrinsic(_ReadWriteBarrier)
  12145. # else
  12146. # include <cmnintrin.h>
  12147. # endif
  12148. # endif
  12149. #endif
  12150. /*
  12151. ** The SQLITE_THREADSAFE macro must be defined as 0, 1, or 2.
  12152. ** 0 means mutexes are permanently disable and the library is never
  12153. ** threadsafe. 1 means the library is serialized which is the highest
  12154. ** level of threadsafety. 2 means the library is multithreaded - multiple
  12155. ** threads can use SQLite as long as no two threads try to use the same
  12156. ** database connection at the same time.
  12157. **
  12158. ** Older versions of SQLite used an optional THREADSAFE macro.
  12159. ** We support that for legacy.
  12160. **
  12161. ** To ensure that the correct value of "THREADSAFE" is reported when querying
  12162. ** for compile-time options at runtime (e.g. "PRAGMA compile_options"), this
  12163. ** logic is partially replicated in ctime.c. If it is updated here, it should
  12164. ** also be updated there.
  12165. */
  12166. #if !defined(SQLITE_THREADSAFE)
  12167. # if defined(THREADSAFE)
  12168. # define SQLITE_THREADSAFE THREADSAFE
  12169. # else
  12170. # define SQLITE_THREADSAFE 1 /* IMP: R-07272-22309 */
  12171. # endif
  12172. #endif
  12173. /*
  12174. ** Powersafe overwrite is on by default. But can be turned off using
  12175. ** the -DSQLITE_POWERSAFE_OVERWRITE=0 command-line option.
  12176. */
  12177. #ifndef SQLITE_POWERSAFE_OVERWRITE
  12178. # define SQLITE_POWERSAFE_OVERWRITE 1
  12179. #endif
  12180. /*
  12181. ** EVIDENCE-OF: R-25715-37072 Memory allocation statistics are enabled by
  12182. ** default unless SQLite is compiled with SQLITE_DEFAULT_MEMSTATUS=0 in
  12183. ** which case memory allocation statistics are disabled by default.
  12184. */
  12185. #if !defined(SQLITE_DEFAULT_MEMSTATUS)
  12186. # define SQLITE_DEFAULT_MEMSTATUS 1
  12187. #endif
  12188. /*
  12189. ** Exactly one of the following macros must be defined in order to
  12190. ** specify which memory allocation subsystem to use.
  12191. **
  12192. ** SQLITE_SYSTEM_MALLOC // Use normal system malloc()
  12193. ** SQLITE_WIN32_MALLOC // Use Win32 native heap API
  12194. ** SQLITE_ZERO_MALLOC // Use a stub allocator that always fails
  12195. ** SQLITE_MEMDEBUG // Debugging version of system malloc()
  12196. **
  12197. ** On Windows, if the SQLITE_WIN32_MALLOC_VALIDATE macro is defined and the
  12198. ** assert() macro is enabled, each call into the Win32 native heap subsystem
  12199. ** will cause HeapValidate to be called. If heap validation should fail, an
  12200. ** assertion will be triggered.
  12201. **
  12202. ** If none of the above are defined, then set SQLITE_SYSTEM_MALLOC as
  12203. ** the default.
  12204. */
  12205. #if defined(SQLITE_SYSTEM_MALLOC) \
  12206. + defined(SQLITE_WIN32_MALLOC) \
  12207. + defined(SQLITE_ZERO_MALLOC) \
  12208. + defined(SQLITE_MEMDEBUG)>1
  12209. # error "Two or more of the following compile-time configuration options\
  12210. are defined but at most one is allowed:\
  12211. SQLITE_SYSTEM_MALLOC, SQLITE_WIN32_MALLOC, SQLITE_MEMDEBUG,\
  12212. SQLITE_ZERO_MALLOC"
  12213. #endif
  12214. #if defined(SQLITE_SYSTEM_MALLOC) \
  12215. + defined(SQLITE_WIN32_MALLOC) \
  12216. + defined(SQLITE_ZERO_MALLOC) \
  12217. + defined(SQLITE_MEMDEBUG)==0
  12218. # define SQLITE_SYSTEM_MALLOC 1
  12219. #endif
  12220. /*
  12221. ** If SQLITE_MALLOC_SOFT_LIMIT is not zero, then try to keep the
  12222. ** sizes of memory allocations below this value where possible.
  12223. */
  12224. #if !defined(SQLITE_MALLOC_SOFT_LIMIT)
  12225. # define SQLITE_MALLOC_SOFT_LIMIT 1024
  12226. #endif
  12227. /*
  12228. ** We need to define _XOPEN_SOURCE as follows in order to enable
  12229. ** recursive mutexes on most Unix systems and fchmod() on OpenBSD.
  12230. ** But _XOPEN_SOURCE define causes problems for Mac OS X, so omit
  12231. ** it.
  12232. */
  12233. #if !defined(_XOPEN_SOURCE) && !defined(__DARWIN__) && !defined(__APPLE__)
  12234. # define _XOPEN_SOURCE 600
  12235. #endif
  12236. /*
  12237. ** NDEBUG and SQLITE_DEBUG are opposites. It should always be true that
  12238. ** defined(NDEBUG)==!defined(SQLITE_DEBUG). If this is not currently true,
  12239. ** make it true by defining or undefining NDEBUG.
  12240. **
  12241. ** Setting NDEBUG makes the code smaller and faster by disabling the
  12242. ** assert() statements in the code. So we want the default action
  12243. ** to be for NDEBUG to be set and NDEBUG to be undefined only if SQLITE_DEBUG
  12244. ** is set. Thus NDEBUG becomes an opt-in rather than an opt-out
  12245. ** feature.
  12246. */
  12247. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  12248. # define NDEBUG 1
  12249. #endif
  12250. #if defined(NDEBUG) && defined(SQLITE_DEBUG)
  12251. # undef NDEBUG
  12252. #endif
  12253. /*
  12254. ** Enable SQLITE_ENABLE_EXPLAIN_COMMENTS if SQLITE_DEBUG is turned on.
  12255. */
  12256. #if !defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) && defined(SQLITE_DEBUG)
  12257. # define SQLITE_ENABLE_EXPLAIN_COMMENTS 1
  12258. #endif
  12259. /*
  12260. ** The testcase() macro is used to aid in coverage testing. When
  12261. ** doing coverage testing, the condition inside the argument to
  12262. ** testcase() must be evaluated both true and false in order to
  12263. ** get full branch coverage. The testcase() macro is inserted
  12264. ** to help ensure adequate test coverage in places where simple
  12265. ** condition/decision coverage is inadequate. For example, testcase()
  12266. ** can be used to make sure boundary values are tested. For
  12267. ** bitmask tests, testcase() can be used to make sure each bit
  12268. ** is significant and used at least once. On switch statements
  12269. ** where multiple cases go to the same block of code, testcase()
  12270. ** can insure that all cases are evaluated.
  12271. **
  12272. */
  12273. #ifdef SQLITE_COVERAGE_TEST
  12274. SQLITE_PRIVATE void sqlite3Coverage(int);
  12275. # define testcase(X) if( X ){ sqlite3Coverage(__LINE__); }
  12276. #else
  12277. # define testcase(X)
  12278. #endif
  12279. /*
  12280. ** The TESTONLY macro is used to enclose variable declarations or
  12281. ** other bits of code that are needed to support the arguments
  12282. ** within testcase() and assert() macros.
  12283. */
  12284. #if !defined(NDEBUG) || defined(SQLITE_COVERAGE_TEST)
  12285. # define TESTONLY(X) X
  12286. #else
  12287. # define TESTONLY(X)
  12288. #endif
  12289. /*
  12290. ** Sometimes we need a small amount of code such as a variable initialization
  12291. ** to setup for a later assert() statement. We do not want this code to
  12292. ** appear when assert() is disabled. The following macro is therefore
  12293. ** used to contain that setup code. The "VVA" acronym stands for
  12294. ** "Verification, Validation, and Accreditation". In other words, the
  12295. ** code within VVA_ONLY() will only run during verification processes.
  12296. */
  12297. #ifndef NDEBUG
  12298. # define VVA_ONLY(X) X
  12299. #else
  12300. # define VVA_ONLY(X)
  12301. #endif
  12302. /*
  12303. ** The ALWAYS and NEVER macros surround boolean expressions which
  12304. ** are intended to always be true or false, respectively. Such
  12305. ** expressions could be omitted from the code completely. But they
  12306. ** are included in a few cases in order to enhance the resilience
  12307. ** of SQLite to unexpected behavior - to make the code "self-healing"
  12308. ** or "ductile" rather than being "brittle" and crashing at the first
  12309. ** hint of unplanned behavior.
  12310. **
  12311. ** In other words, ALWAYS and NEVER are added for defensive code.
  12312. **
  12313. ** When doing coverage testing ALWAYS and NEVER are hard-coded to
  12314. ** be true and false so that the unreachable code they specify will
  12315. ** not be counted as untested code.
  12316. */
  12317. #if defined(SQLITE_COVERAGE_TEST) || defined(SQLITE_MUTATION_TEST)
  12318. # define ALWAYS(X) (1)
  12319. # define NEVER(X) (0)
  12320. #elif !defined(NDEBUG)
  12321. # define ALWAYS(X) ((X)?1:(assert(0),0))
  12322. # define NEVER(X) ((X)?(assert(0),1):0)
  12323. #else
  12324. # define ALWAYS(X) (X)
  12325. # define NEVER(X) (X)
  12326. #endif
  12327. /*
  12328. ** Some conditionals are optimizations only. In other words, if the
  12329. ** conditionals are replaced with a constant 1 (true) or 0 (false) then
  12330. ** the correct answer is still obtained, though perhaps not as quickly.
  12331. **
  12332. ** The following macros mark these optimizations conditionals.
  12333. */
  12334. #if defined(SQLITE_MUTATION_TEST)
  12335. # define OK_IF_ALWAYS_TRUE(X) (1)
  12336. # define OK_IF_ALWAYS_FALSE(X) (0)
  12337. #else
  12338. # define OK_IF_ALWAYS_TRUE(X) (X)
  12339. # define OK_IF_ALWAYS_FALSE(X) (X)
  12340. #endif
  12341. /*
  12342. ** Some malloc failures are only possible if SQLITE_TEST_REALLOC_STRESS is
  12343. ** defined. We need to defend against those failures when testing with
  12344. ** SQLITE_TEST_REALLOC_STRESS, but we don't want the unreachable branches
  12345. ** during a normal build. The following macro can be used to disable tests
  12346. ** that are always false except when SQLITE_TEST_REALLOC_STRESS is set.
  12347. */
  12348. #if defined(SQLITE_TEST_REALLOC_STRESS)
  12349. # define ONLY_IF_REALLOC_STRESS(X) (X)
  12350. #elif !defined(NDEBUG)
  12351. # define ONLY_IF_REALLOC_STRESS(X) ((X)?(assert(0),1):0)
  12352. #else
  12353. # define ONLY_IF_REALLOC_STRESS(X) (0)
  12354. #endif
  12355. /*
  12356. ** Declarations used for tracing the operating system interfaces.
  12357. */
  12358. #if defined(SQLITE_FORCE_OS_TRACE) || defined(SQLITE_TEST) || \
  12359. (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
  12360. extern int sqlite3OSTrace;
  12361. # define OSTRACE(X) if( sqlite3OSTrace ) sqlite3DebugPrintf X
  12362. # define SQLITE_HAVE_OS_TRACE
  12363. #else
  12364. # define OSTRACE(X)
  12365. # undef SQLITE_HAVE_OS_TRACE
  12366. #endif
  12367. /*
  12368. ** Is the sqlite3ErrName() function needed in the build? Currently,
  12369. ** it is needed by "mutex_w32.c" (when debugging), "os_win.c" (when
  12370. ** OSTRACE is enabled), and by several "test*.c" files (which are
  12371. ** compiled using SQLITE_TEST).
  12372. */
  12373. #if defined(SQLITE_HAVE_OS_TRACE) || defined(SQLITE_TEST) || \
  12374. (defined(SQLITE_DEBUG) && SQLITE_OS_WIN)
  12375. # define SQLITE_NEED_ERR_NAME
  12376. #else
  12377. # undef SQLITE_NEED_ERR_NAME
  12378. #endif
  12379. /*
  12380. ** SQLITE_ENABLE_EXPLAIN_COMMENTS is incompatible with SQLITE_OMIT_EXPLAIN
  12381. */
  12382. #ifdef SQLITE_OMIT_EXPLAIN
  12383. # undef SQLITE_ENABLE_EXPLAIN_COMMENTS
  12384. #endif
  12385. /*
  12386. ** Return true (non-zero) if the input is an integer that is too large
  12387. ** to fit in 32-bits. This macro is used inside of various testcase()
  12388. ** macros to verify that we have tested SQLite for large-file support.
  12389. */
  12390. #define IS_BIG_INT(X) (((X)&~(i64)0xffffffff)!=0)
  12391. /*
  12392. ** The macro unlikely() is a hint that surrounds a boolean
  12393. ** expression that is usually false. Macro likely() surrounds
  12394. ** a boolean expression that is usually true. These hints could,
  12395. ** in theory, be used by the compiler to generate better code, but
  12396. ** currently they are just comments for human readers.
  12397. */
  12398. #define likely(X) (X)
  12399. #define unlikely(X) (X)
  12400. /************** Include hash.h in the middle of sqliteInt.h ******************/
  12401. /************** Begin file hash.h ********************************************/
  12402. /*
  12403. ** 2001 September 22
  12404. **
  12405. ** The author disclaims copyright to this source code. In place of
  12406. ** a legal notice, here is a blessing:
  12407. **
  12408. ** May you do good and not evil.
  12409. ** May you find forgiveness for yourself and forgive others.
  12410. ** May you share freely, never taking more than you give.
  12411. **
  12412. *************************************************************************
  12413. ** This is the header file for the generic hash-table implementation
  12414. ** used in SQLite.
  12415. */
  12416. #ifndef SQLITE_HASH_H
  12417. #define SQLITE_HASH_H
  12418. /* Forward declarations of structures. */
  12419. typedef struct Hash Hash;
  12420. typedef struct HashElem HashElem;
  12421. /* A complete hash table is an instance of the following structure.
  12422. ** The internals of this structure are intended to be opaque -- client
  12423. ** code should not attempt to access or modify the fields of this structure
  12424. ** directly. Change this structure only by using the routines below.
  12425. ** However, some of the "procedures" and "functions" for modifying and
  12426. ** accessing this structure are really macros, so we can't really make
  12427. ** this structure opaque.
  12428. **
  12429. ** All elements of the hash table are on a single doubly-linked list.
  12430. ** Hash.first points to the head of this list.
  12431. **
  12432. ** There are Hash.htsize buckets. Each bucket points to a spot in
  12433. ** the global doubly-linked list. The contents of the bucket are the
  12434. ** element pointed to plus the next _ht.count-1 elements in the list.
  12435. **
  12436. ** Hash.htsize and Hash.ht may be zero. In that case lookup is done
  12437. ** by a linear search of the global list. For small tables, the
  12438. ** Hash.ht table is never allocated because if there are few elements
  12439. ** in the table, it is faster to do a linear search than to manage
  12440. ** the hash table.
  12441. */
  12442. struct Hash {
  12443. unsigned int htsize; /* Number of buckets in the hash table */
  12444. unsigned int count; /* Number of entries in this table */
  12445. HashElem *first; /* The first element of the array */
  12446. struct _ht { /* the hash table */
  12447. int count; /* Number of entries with this hash */
  12448. HashElem *chain; /* Pointer to first entry with this hash */
  12449. } *ht;
  12450. };
  12451. /* Each element in the hash table is an instance of the following
  12452. ** structure. All elements are stored on a single doubly-linked list.
  12453. **
  12454. ** Again, this structure is intended to be opaque, but it can't really
  12455. ** be opaque because it is used by macros.
  12456. */
  12457. struct HashElem {
  12458. HashElem *next, *prev; /* Next and previous elements in the table */
  12459. void *data; /* Data associated with this element */
  12460. const char *pKey; /* Key associated with this element */
  12461. };
  12462. /*
  12463. ** Access routines. To delete, insert a NULL pointer.
  12464. */
  12465. SQLITE_PRIVATE void sqlite3HashInit(Hash*);
  12466. SQLITE_PRIVATE void *sqlite3HashInsert(Hash*, const char *pKey, void *pData);
  12467. SQLITE_PRIVATE void *sqlite3HashFind(const Hash*, const char *pKey);
  12468. SQLITE_PRIVATE void sqlite3HashClear(Hash*);
  12469. /*
  12470. ** Macros for looping over all elements of a hash table. The idiom is
  12471. ** like this:
  12472. **
  12473. ** Hash h;
  12474. ** HashElem *p;
  12475. ** ...
  12476. ** for(p=sqliteHashFirst(&h); p; p=sqliteHashNext(p)){
  12477. ** SomeStructure *pData = sqliteHashData(p);
  12478. ** // do something with pData
  12479. ** }
  12480. */
  12481. #define sqliteHashFirst(H) ((H)->first)
  12482. #define sqliteHashNext(E) ((E)->next)
  12483. #define sqliteHashData(E) ((E)->data)
  12484. /* #define sqliteHashKey(E) ((E)->pKey) // NOT USED */
  12485. /* #define sqliteHashKeysize(E) ((E)->nKey) // NOT USED */
  12486. /*
  12487. ** Number of entries in a hash table
  12488. */
  12489. /* #define sqliteHashCount(H) ((H)->count) // NOT USED */
  12490. #endif /* SQLITE_HASH_H */
  12491. /************** End of hash.h ************************************************/
  12492. /************** Continuing where we left off in sqliteInt.h ******************/
  12493. /************** Include parse.h in the middle of sqliteInt.h *****************/
  12494. /************** Begin file parse.h *******************************************/
  12495. #define TK_SEMI 1
  12496. #define TK_EXPLAIN 2
  12497. #define TK_QUERY 3
  12498. #define TK_PLAN 4
  12499. #define TK_BEGIN 5
  12500. #define TK_TRANSACTION 6
  12501. #define TK_DEFERRED 7
  12502. #define TK_IMMEDIATE 8
  12503. #define TK_EXCLUSIVE 9
  12504. #define TK_COMMIT 10
  12505. #define TK_END 11
  12506. #define TK_ROLLBACK 12
  12507. #define TK_SAVEPOINT 13
  12508. #define TK_RELEASE 14
  12509. #define TK_TO 15
  12510. #define TK_TABLE 16
  12511. #define TK_CREATE 17
  12512. #define TK_IF 18
  12513. #define TK_NOT 19
  12514. #define TK_EXISTS 20
  12515. #define TK_TEMP 21
  12516. #define TK_LP 22
  12517. #define TK_RP 23
  12518. #define TK_AS 24
  12519. #define TK_WITHOUT 25
  12520. #define TK_COMMA 26
  12521. #define TK_ABORT 27
  12522. #define TK_ACTION 28
  12523. #define TK_AFTER 29
  12524. #define TK_ANALYZE 30
  12525. #define TK_ASC 31
  12526. #define TK_ATTACH 32
  12527. #define TK_BEFORE 33
  12528. #define TK_BY 34
  12529. #define TK_CASCADE 35
  12530. #define TK_CAST 36
  12531. #define TK_CONFLICT 37
  12532. #define TK_DATABASE 38
  12533. #define TK_DESC 39
  12534. #define TK_DETACH 40
  12535. #define TK_EACH 41
  12536. #define TK_FAIL 42
  12537. #define TK_OR 43
  12538. #define TK_AND 44
  12539. #define TK_IS 45
  12540. #define TK_MATCH 46
  12541. #define TK_LIKE_KW 47
  12542. #define TK_BETWEEN 48
  12543. #define TK_IN 49
  12544. #define TK_ISNULL 50
  12545. #define TK_NOTNULL 51
  12546. #define TK_NE 52
  12547. #define TK_EQ 53
  12548. #define TK_GT 54
  12549. #define TK_LE 55
  12550. #define TK_LT 56
  12551. #define TK_GE 57
  12552. #define TK_ESCAPE 58
  12553. #define TK_ID 59
  12554. #define TK_COLUMNKW 60
  12555. #define TK_FOR 61
  12556. #define TK_IGNORE 62
  12557. #define TK_INITIALLY 63
  12558. #define TK_INSTEAD 64
  12559. #define TK_NO 65
  12560. #define TK_KEY 66
  12561. #define TK_OF 67
  12562. #define TK_OFFSET 68
  12563. #define TK_PRAGMA 69
  12564. #define TK_RAISE 70
  12565. #define TK_RECURSIVE 71
  12566. #define TK_REPLACE 72
  12567. #define TK_RESTRICT 73
  12568. #define TK_ROW 74
  12569. #define TK_TRIGGER 75
  12570. #define TK_VACUUM 76
  12571. #define TK_VIEW 77
  12572. #define TK_VIRTUAL 78
  12573. #define TK_WITH 79
  12574. #define TK_REINDEX 80
  12575. #define TK_RENAME 81
  12576. #define TK_CTIME_KW 82
  12577. #define TK_ANY 83
  12578. #define TK_BITAND 84
  12579. #define TK_BITOR 85
  12580. #define TK_LSHIFT 86
  12581. #define TK_RSHIFT 87
  12582. #define TK_PLUS 88
  12583. #define TK_MINUS 89
  12584. #define TK_STAR 90
  12585. #define TK_SLASH 91
  12586. #define TK_REM 92
  12587. #define TK_CONCAT 93
  12588. #define TK_COLLATE 94
  12589. #define TK_BITNOT 95
  12590. #define TK_INDEXED 96
  12591. #define TK_STRING 97
  12592. #define TK_JOIN_KW 98
  12593. #define TK_CONSTRAINT 99
  12594. #define TK_DEFAULT 100
  12595. #define TK_NULL 101
  12596. #define TK_PRIMARY 102
  12597. #define TK_UNIQUE 103
  12598. #define TK_CHECK 104
  12599. #define TK_REFERENCES 105
  12600. #define TK_AUTOINCR 106
  12601. #define TK_ON 107
  12602. #define TK_INSERT 108
  12603. #define TK_DELETE 109
  12604. #define TK_UPDATE 110
  12605. #define TK_SET 111
  12606. #define TK_DEFERRABLE 112
  12607. #define TK_FOREIGN 113
  12608. #define TK_DROP 114
  12609. #define TK_UNION 115
  12610. #define TK_ALL 116
  12611. #define TK_EXCEPT 117
  12612. #define TK_INTERSECT 118
  12613. #define TK_SELECT 119
  12614. #define TK_VALUES 120
  12615. #define TK_DISTINCT 121
  12616. #define TK_DOT 122
  12617. #define TK_FROM 123
  12618. #define TK_JOIN 124
  12619. #define TK_USING 125
  12620. #define TK_ORDER 126
  12621. #define TK_GROUP 127
  12622. #define TK_HAVING 128
  12623. #define TK_LIMIT 129
  12624. #define TK_WHERE 130
  12625. #define TK_INTO 131
  12626. #define TK_FLOAT 132
  12627. #define TK_BLOB 133
  12628. #define TK_INTEGER 134
  12629. #define TK_VARIABLE 135
  12630. #define TK_CASE 136
  12631. #define TK_WHEN 137
  12632. #define TK_THEN 138
  12633. #define TK_ELSE 139
  12634. #define TK_INDEX 140
  12635. #define TK_ALTER 141
  12636. #define TK_ADD 142
  12637. #define TK_TRUEFALSE 143
  12638. #define TK_ISNOT 144
  12639. #define TK_FUNCTION 145
  12640. #define TK_COLUMN 146
  12641. #define TK_AGG_FUNCTION 147
  12642. #define TK_AGG_COLUMN 148
  12643. #define TK_UMINUS 149
  12644. #define TK_UPLUS 150
  12645. #define TK_TRUTH 151
  12646. #define TK_REGISTER 152
  12647. #define TK_VECTOR 153
  12648. #define TK_SELECT_COLUMN 154
  12649. #define TK_IF_NULL_ROW 155
  12650. #define TK_ASTERISK 156
  12651. #define TK_SPAN 157
  12652. #define TK_END_OF_FILE 158
  12653. #define TK_UNCLOSED_STRING 159
  12654. #define TK_SPACE 160
  12655. #define TK_ILLEGAL 161
  12656. /* The token codes above must all fit in 8 bits */
  12657. #define TKFLG_MASK 0xff
  12658. /* Flags that can be added to a token code when it is not
  12659. ** being stored in a u8: */
  12660. #define TKFLG_DONTFOLD 0x100 /* Omit constant folding optimizations */
  12661. /************** End of parse.h ***********************************************/
  12662. /************** Continuing where we left off in sqliteInt.h ******************/
  12663. #include <stdio.h>
  12664. #include <stdlib.h>
  12665. #include <string.h>
  12666. #include <assert.h>
  12667. #include <stddef.h>
  12668. /*
  12669. ** Use a macro to replace memcpy() if compiled with SQLITE_INLINE_MEMCPY.
  12670. ** This allows better measurements of where memcpy() is used when running
  12671. ** cachegrind. But this macro version of memcpy() is very slow so it
  12672. ** should not be used in production. This is a performance measurement
  12673. ** hack only.
  12674. */
  12675. #ifdef SQLITE_INLINE_MEMCPY
  12676. # define memcpy(D,S,N) {char*xxd=(char*)(D);const char*xxs=(const char*)(S);\
  12677. int xxn=(N);while(xxn-->0)*(xxd++)=*(xxs++);}
  12678. #endif
  12679. /*
  12680. ** If compiling for a processor that lacks floating point support,
  12681. ** substitute integer for floating-point
  12682. */
  12683. #ifdef SQLITE_OMIT_FLOATING_POINT
  12684. # define double sqlite_int64
  12685. # define float sqlite_int64
  12686. # define LONGDOUBLE_TYPE sqlite_int64
  12687. # ifndef SQLITE_BIG_DBL
  12688. # define SQLITE_BIG_DBL (((sqlite3_int64)1)<<50)
  12689. # endif
  12690. # define SQLITE_OMIT_DATETIME_FUNCS 1
  12691. # define SQLITE_OMIT_TRACE 1
  12692. # undef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  12693. # undef SQLITE_HAVE_ISNAN
  12694. #endif
  12695. #ifndef SQLITE_BIG_DBL
  12696. # define SQLITE_BIG_DBL (1e99)
  12697. #endif
  12698. /*
  12699. ** OMIT_TEMPDB is set to 1 if SQLITE_OMIT_TEMPDB is defined, or 0
  12700. ** afterward. Having this macro allows us to cause the C compiler
  12701. ** to omit code used by TEMP tables without messy #ifndef statements.
  12702. */
  12703. #ifdef SQLITE_OMIT_TEMPDB
  12704. #define OMIT_TEMPDB 1
  12705. #else
  12706. #define OMIT_TEMPDB 0
  12707. #endif
  12708. /*
  12709. ** The "file format" number is an integer that is incremented whenever
  12710. ** the VDBE-level file format changes. The following macros define the
  12711. ** the default file format for new databases and the maximum file format
  12712. ** that the library can read.
  12713. */
  12714. #define SQLITE_MAX_FILE_FORMAT 4
  12715. #ifndef SQLITE_DEFAULT_FILE_FORMAT
  12716. # define SQLITE_DEFAULT_FILE_FORMAT 4
  12717. #endif
  12718. /*
  12719. ** Determine whether triggers are recursive by default. This can be
  12720. ** changed at run-time using a pragma.
  12721. */
  12722. #ifndef SQLITE_DEFAULT_RECURSIVE_TRIGGERS
  12723. # define SQLITE_DEFAULT_RECURSIVE_TRIGGERS 0
  12724. #endif
  12725. /*
  12726. ** Provide a default value for SQLITE_TEMP_STORE in case it is not specified
  12727. ** on the command-line
  12728. */
  12729. #ifndef SQLITE_TEMP_STORE
  12730. # define SQLITE_TEMP_STORE 1
  12731. #endif
  12732. /*
  12733. ** If no value has been provided for SQLITE_MAX_WORKER_THREADS, or if
  12734. ** SQLITE_TEMP_STORE is set to 3 (never use temporary files), set it
  12735. ** to zero.
  12736. */
  12737. #if SQLITE_TEMP_STORE==3 || SQLITE_THREADSAFE==0
  12738. # undef SQLITE_MAX_WORKER_THREADS
  12739. # define SQLITE_MAX_WORKER_THREADS 0
  12740. #endif
  12741. #ifndef SQLITE_MAX_WORKER_THREADS
  12742. # define SQLITE_MAX_WORKER_THREADS 8
  12743. #endif
  12744. #ifndef SQLITE_DEFAULT_WORKER_THREADS
  12745. # define SQLITE_DEFAULT_WORKER_THREADS 0
  12746. #endif
  12747. #if SQLITE_DEFAULT_WORKER_THREADS>SQLITE_MAX_WORKER_THREADS
  12748. # undef SQLITE_MAX_WORKER_THREADS
  12749. # define SQLITE_MAX_WORKER_THREADS SQLITE_DEFAULT_WORKER_THREADS
  12750. #endif
  12751. /*
  12752. ** The default initial allocation for the pagecache when using separate
  12753. ** pagecaches for each database connection. A positive number is the
  12754. ** number of pages. A negative number N translations means that a buffer
  12755. ** of -1024*N bytes is allocated and used for as many pages as it will hold.
  12756. **
  12757. ** The default value of "20" was choosen to minimize the run-time of the
  12758. ** speedtest1 test program with options: --shrink-memory --reprepare
  12759. */
  12760. #ifndef SQLITE_DEFAULT_PCACHE_INITSZ
  12761. # define SQLITE_DEFAULT_PCACHE_INITSZ 20
  12762. #endif
  12763. /*
  12764. ** The compile-time options SQLITE_MMAP_READWRITE and
  12765. ** SQLITE_ENABLE_BATCH_ATOMIC_WRITE are not compatible with one another.
  12766. ** You must choose one or the other (or neither) but not both.
  12767. */
  12768. #if defined(SQLITE_MMAP_READWRITE) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  12769. #error Cannot use both SQLITE_MMAP_READWRITE and SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  12770. #endif
  12771. /*
  12772. ** GCC does not define the offsetof() macro so we'll have to do it
  12773. ** ourselves.
  12774. */
  12775. #ifndef offsetof
  12776. #define offsetof(STRUCTURE,FIELD) ((int)((char*)&((STRUCTURE*)0)->FIELD))
  12777. #endif
  12778. /*
  12779. ** Macros to compute minimum and maximum of two numbers.
  12780. */
  12781. #ifndef MIN
  12782. # define MIN(A,B) ((A)<(B)?(A):(B))
  12783. #endif
  12784. #ifndef MAX
  12785. # define MAX(A,B) ((A)>(B)?(A):(B))
  12786. #endif
  12787. /*
  12788. ** Swap two objects of type TYPE.
  12789. */
  12790. #define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
  12791. /*
  12792. ** Check to see if this machine uses EBCDIC. (Yes, believe it or
  12793. ** not, there are still machines out there that use EBCDIC.)
  12794. */
  12795. #if 'A' == '\301'
  12796. # define SQLITE_EBCDIC 1
  12797. #else
  12798. # define SQLITE_ASCII 1
  12799. #endif
  12800. /*
  12801. ** Integers of known sizes. These typedefs might change for architectures
  12802. ** where the sizes very. Preprocessor macros are available so that the
  12803. ** types can be conveniently redefined at compile-type. Like this:
  12804. **
  12805. ** cc '-DUINTPTR_TYPE=long long int' ...
  12806. */
  12807. #ifndef UINT32_TYPE
  12808. # ifdef HAVE_UINT32_T
  12809. # define UINT32_TYPE uint32_t
  12810. # else
  12811. # define UINT32_TYPE unsigned int
  12812. # endif
  12813. #endif
  12814. #ifndef UINT16_TYPE
  12815. # ifdef HAVE_UINT16_T
  12816. # define UINT16_TYPE uint16_t
  12817. # else
  12818. # define UINT16_TYPE unsigned short int
  12819. # endif
  12820. #endif
  12821. #ifndef INT16_TYPE
  12822. # ifdef HAVE_INT16_T
  12823. # define INT16_TYPE int16_t
  12824. # else
  12825. # define INT16_TYPE short int
  12826. # endif
  12827. #endif
  12828. #ifndef UINT8_TYPE
  12829. # ifdef HAVE_UINT8_T
  12830. # define UINT8_TYPE uint8_t
  12831. # else
  12832. # define UINT8_TYPE unsigned char
  12833. # endif
  12834. #endif
  12835. #ifndef INT8_TYPE
  12836. # ifdef HAVE_INT8_T
  12837. # define INT8_TYPE int8_t
  12838. # else
  12839. # define INT8_TYPE signed char
  12840. # endif
  12841. #endif
  12842. #ifndef LONGDOUBLE_TYPE
  12843. # define LONGDOUBLE_TYPE long double
  12844. #endif
  12845. typedef sqlite_int64 i64; /* 8-byte signed integer */
  12846. typedef sqlite_uint64 u64; /* 8-byte unsigned integer */
  12847. typedef UINT32_TYPE u32; /* 4-byte unsigned integer */
  12848. typedef UINT16_TYPE u16; /* 2-byte unsigned integer */
  12849. typedef INT16_TYPE i16; /* 2-byte signed integer */
  12850. typedef UINT8_TYPE u8; /* 1-byte unsigned integer */
  12851. typedef INT8_TYPE i8; /* 1-byte signed integer */
  12852. /*
  12853. ** SQLITE_MAX_U32 is a u64 constant that is the maximum u64 value
  12854. ** that can be stored in a u32 without loss of data. The value
  12855. ** is 0x00000000ffffffff. But because of quirks of some compilers, we
  12856. ** have to specify the value in the less intuitive manner shown:
  12857. */
  12858. #define SQLITE_MAX_U32 ((((u64)1)<<32)-1)
  12859. /*
  12860. ** The datatype used to store estimates of the number of rows in a
  12861. ** table or index. This is an unsigned integer type. For 99.9% of
  12862. ** the world, a 32-bit integer is sufficient. But a 64-bit integer
  12863. ** can be used at compile-time if desired.
  12864. */
  12865. #ifdef SQLITE_64BIT_STATS
  12866. typedef u64 tRowcnt; /* 64-bit only if requested at compile-time */
  12867. #else
  12868. typedef u32 tRowcnt; /* 32-bit is the default */
  12869. #endif
  12870. /*
  12871. ** Estimated quantities used for query planning are stored as 16-bit
  12872. ** logarithms. For quantity X, the value stored is 10*log2(X). This
  12873. ** gives a possible range of values of approximately 1.0e986 to 1e-986.
  12874. ** But the allowed values are "grainy". Not every value is representable.
  12875. ** For example, quantities 16 and 17 are both represented by a LogEst
  12876. ** of 40. However, since LogEst quantities are suppose to be estimates,
  12877. ** not exact values, this imprecision is not a problem.
  12878. **
  12879. ** "LogEst" is short for "Logarithmic Estimate".
  12880. **
  12881. ** Examples:
  12882. ** 1 -> 0 20 -> 43 10000 -> 132
  12883. ** 2 -> 10 25 -> 46 25000 -> 146
  12884. ** 3 -> 16 100 -> 66 1000000 -> 199
  12885. ** 4 -> 20 1000 -> 99 1048576 -> 200
  12886. ** 10 -> 33 1024 -> 100 4294967296 -> 320
  12887. **
  12888. ** The LogEst can be negative to indicate fractional values.
  12889. ** Examples:
  12890. **
  12891. ** 0.5 -> -10 0.1 -> -33 0.0625 -> -40
  12892. */
  12893. typedef INT16_TYPE LogEst;
  12894. /*
  12895. ** Set the SQLITE_PTRSIZE macro to the number of bytes in a pointer
  12896. */
  12897. #ifndef SQLITE_PTRSIZE
  12898. # if defined(__SIZEOF_POINTER__)
  12899. # define SQLITE_PTRSIZE __SIZEOF_POINTER__
  12900. # elif defined(i386) || defined(__i386__) || defined(_M_IX86) || \
  12901. defined(_M_ARM) || defined(__arm__) || defined(__x86)
  12902. # define SQLITE_PTRSIZE 4
  12903. # else
  12904. # define SQLITE_PTRSIZE 8
  12905. # endif
  12906. #endif
  12907. /* The uptr type is an unsigned integer large enough to hold a pointer
  12908. */
  12909. #if defined(HAVE_STDINT_H)
  12910. typedef uintptr_t uptr;
  12911. #elif SQLITE_PTRSIZE==4
  12912. typedef u32 uptr;
  12913. #else
  12914. typedef u64 uptr;
  12915. #endif
  12916. /*
  12917. ** The SQLITE_WITHIN(P,S,E) macro checks to see if pointer P points to
  12918. ** something between S (inclusive) and E (exclusive).
  12919. **
  12920. ** In other words, S is a buffer and E is a pointer to the first byte after
  12921. ** the end of buffer S. This macro returns true if P points to something
  12922. ** contained within the buffer S.
  12923. */
  12924. #define SQLITE_WITHIN(P,S,E) (((uptr)(P)>=(uptr)(S))&&((uptr)(P)<(uptr)(E)))
  12925. /*
  12926. ** Macros to determine whether the machine is big or little endian,
  12927. ** and whether or not that determination is run-time or compile-time.
  12928. **
  12929. ** For best performance, an attempt is made to guess at the byte-order
  12930. ** using C-preprocessor macros. If that is unsuccessful, or if
  12931. ** -DSQLITE_BYTEORDER=0 is set, then byte-order is determined
  12932. ** at run-time.
  12933. */
  12934. #ifndef SQLITE_BYTEORDER
  12935. # if defined(i386) || defined(__i386__) || defined(_M_IX86) || \
  12936. defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \
  12937. defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \
  12938. defined(__arm__)
  12939. # define SQLITE_BYTEORDER 1234
  12940. # elif defined(sparc) || defined(__ppc__)
  12941. # define SQLITE_BYTEORDER 4321
  12942. # else
  12943. # define SQLITE_BYTEORDER 0
  12944. # endif
  12945. #endif
  12946. #if SQLITE_BYTEORDER==4321
  12947. # define SQLITE_BIGENDIAN 1
  12948. # define SQLITE_LITTLEENDIAN 0
  12949. # define SQLITE_UTF16NATIVE SQLITE_UTF16BE
  12950. #elif SQLITE_BYTEORDER==1234
  12951. # define SQLITE_BIGENDIAN 0
  12952. # define SQLITE_LITTLEENDIAN 1
  12953. # define SQLITE_UTF16NATIVE SQLITE_UTF16LE
  12954. #else
  12955. # ifdef SQLITE_AMALGAMATION
  12956. const int sqlite3one = 1;
  12957. # else
  12958. extern const int sqlite3one;
  12959. # endif
  12960. # define SQLITE_BIGENDIAN (*(char *)(&sqlite3one)==0)
  12961. # define SQLITE_LITTLEENDIAN (*(char *)(&sqlite3one)==1)
  12962. # define SQLITE_UTF16NATIVE (SQLITE_BIGENDIAN?SQLITE_UTF16BE:SQLITE_UTF16LE)
  12963. #endif
  12964. /*
  12965. ** Constants for the largest and smallest possible 64-bit signed integers.
  12966. ** These macros are designed to work correctly on both 32-bit and 64-bit
  12967. ** compilers.
  12968. */
  12969. #define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
  12970. #define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
  12971. /*
  12972. ** Round up a number to the next larger multiple of 8. This is used
  12973. ** to force 8-byte alignment on 64-bit architectures.
  12974. */
  12975. #define ROUND8(x) (((x)+7)&~7)
  12976. /*
  12977. ** Round down to the nearest multiple of 8
  12978. */
  12979. #define ROUNDDOWN8(x) ((x)&~7)
  12980. /*
  12981. ** Assert that the pointer X is aligned to an 8-byte boundary. This
  12982. ** macro is used only within assert() to verify that the code gets
  12983. ** all alignment restrictions correct.
  12984. **
  12985. ** Except, if SQLITE_4_BYTE_ALIGNED_MALLOC is defined, then the
  12986. ** underlying malloc() implementation might return us 4-byte aligned
  12987. ** pointers. In that case, only verify 4-byte alignment.
  12988. */
  12989. #ifdef SQLITE_4_BYTE_ALIGNED_MALLOC
  12990. # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&3)==0)
  12991. #else
  12992. # define EIGHT_BYTE_ALIGNMENT(X) ((((char*)(X) - (char*)0)&7)==0)
  12993. #endif
  12994. /*
  12995. ** Disable MMAP on platforms where it is known to not work
  12996. */
  12997. #if defined(__OpenBSD__) || defined(__QNXNTO__)
  12998. # undef SQLITE_MAX_MMAP_SIZE
  12999. # define SQLITE_MAX_MMAP_SIZE 0
  13000. #endif
  13001. /*
  13002. ** Default maximum size of memory used by memory-mapped I/O in the VFS
  13003. */
  13004. #ifdef __APPLE__
  13005. # include <TargetConditionals.h>
  13006. #endif
  13007. #ifndef SQLITE_MAX_MMAP_SIZE
  13008. # if defined(__linux__) \
  13009. || defined(_WIN32) \
  13010. || (defined(__APPLE__) && defined(__MACH__)) \
  13011. || defined(__sun) \
  13012. || defined(__FreeBSD__) \
  13013. || defined(__DragonFly__)
  13014. # define SQLITE_MAX_MMAP_SIZE 0x7fff0000 /* 2147418112 */
  13015. # else
  13016. # define SQLITE_MAX_MMAP_SIZE 0
  13017. # endif
  13018. #endif
  13019. /*
  13020. ** The default MMAP_SIZE is zero on all platforms. Or, even if a larger
  13021. ** default MMAP_SIZE is specified at compile-time, make sure that it does
  13022. ** not exceed the maximum mmap size.
  13023. */
  13024. #ifndef SQLITE_DEFAULT_MMAP_SIZE
  13025. # define SQLITE_DEFAULT_MMAP_SIZE 0
  13026. #endif
  13027. #if SQLITE_DEFAULT_MMAP_SIZE>SQLITE_MAX_MMAP_SIZE
  13028. # undef SQLITE_DEFAULT_MMAP_SIZE
  13029. # define SQLITE_DEFAULT_MMAP_SIZE SQLITE_MAX_MMAP_SIZE
  13030. #endif
  13031. /*
  13032. ** Only one of SQLITE_ENABLE_STAT3 or SQLITE_ENABLE_STAT4 can be defined.
  13033. ** Priority is given to SQLITE_ENABLE_STAT4. If either are defined, also
  13034. ** define SQLITE_ENABLE_STAT3_OR_STAT4
  13035. */
  13036. #ifdef SQLITE_ENABLE_STAT4
  13037. # undef SQLITE_ENABLE_STAT3
  13038. # define SQLITE_ENABLE_STAT3_OR_STAT4 1
  13039. #elif SQLITE_ENABLE_STAT3
  13040. # define SQLITE_ENABLE_STAT3_OR_STAT4 1
  13041. #elif SQLITE_ENABLE_STAT3_OR_STAT4
  13042. # undef SQLITE_ENABLE_STAT3_OR_STAT4
  13043. #endif
  13044. /*
  13045. ** SELECTTRACE_ENABLED will be either 1 or 0 depending on whether or not
  13046. ** the Select query generator tracing logic is turned on.
  13047. */
  13048. #if defined(SQLITE_ENABLE_SELECTTRACE)
  13049. # define SELECTTRACE_ENABLED 1
  13050. #else
  13051. # define SELECTTRACE_ENABLED 0
  13052. #endif
  13053. /*
  13054. ** An instance of the following structure is used to store the busy-handler
  13055. ** callback for a given sqlite handle.
  13056. **
  13057. ** The sqlite.busyHandler member of the sqlite struct contains the busy
  13058. ** callback for the database handle. Each pager opened via the sqlite
  13059. ** handle is passed a pointer to sqlite.busyHandler. The busy-handler
  13060. ** callback is currently invoked only from within pager.c.
  13061. */
  13062. typedef struct BusyHandler BusyHandler;
  13063. struct BusyHandler {
  13064. int (*xBusyHandler)(void *,int); /* The busy callback */
  13065. void *pBusyArg; /* First arg to busy callback */
  13066. int nBusy; /* Incremented with each busy call */
  13067. u8 bExtraFileArg; /* Include sqlite3_file as callback arg */
  13068. };
  13069. /*
  13070. ** Name of the master database table. The master database table
  13071. ** is a special table that holds the names and attributes of all
  13072. ** user tables and indices.
  13073. */
  13074. #define MASTER_NAME "sqlite_master"
  13075. #define TEMP_MASTER_NAME "sqlite_temp_master"
  13076. /*
  13077. ** The root-page of the master database table.
  13078. */
  13079. #define MASTER_ROOT 1
  13080. /*
  13081. ** The name of the schema table.
  13082. */
  13083. #define SCHEMA_TABLE(x) ((!OMIT_TEMPDB)&&(x==1)?TEMP_MASTER_NAME:MASTER_NAME)
  13084. /*
  13085. ** A convenience macro that returns the number of elements in
  13086. ** an array.
  13087. */
  13088. #define ArraySize(X) ((int)(sizeof(X)/sizeof(X[0])))
  13089. /*
  13090. ** Determine if the argument is a power of two
  13091. */
  13092. #define IsPowerOfTwo(X) (((X)&((X)-1))==0)
  13093. /*
  13094. ** The following value as a destructor means to use sqlite3DbFree().
  13095. ** The sqlite3DbFree() routine requires two parameters instead of the
  13096. ** one parameter that destructors normally want. So we have to introduce
  13097. ** this magic value that the code knows to handle differently. Any
  13098. ** pointer will work here as long as it is distinct from SQLITE_STATIC
  13099. ** and SQLITE_TRANSIENT.
  13100. */
  13101. #define SQLITE_DYNAMIC ((sqlite3_destructor_type)sqlite3MallocSize)
  13102. /*
  13103. ** When SQLITE_OMIT_WSD is defined, it means that the target platform does
  13104. ** not support Writable Static Data (WSD) such as global and static variables.
  13105. ** All variables must either be on the stack or dynamically allocated from
  13106. ** the heap. When WSD is unsupported, the variable declarations scattered
  13107. ** throughout the SQLite code must become constants instead. The SQLITE_WSD
  13108. ** macro is used for this purpose. And instead of referencing the variable
  13109. ** directly, we use its constant as a key to lookup the run-time allocated
  13110. ** buffer that holds real variable. The constant is also the initializer
  13111. ** for the run-time allocated buffer.
  13112. **
  13113. ** In the usual case where WSD is supported, the SQLITE_WSD and GLOBAL
  13114. ** macros become no-ops and have zero performance impact.
  13115. */
  13116. #ifdef SQLITE_OMIT_WSD
  13117. #define SQLITE_WSD const
  13118. #define GLOBAL(t,v) (*(t*)sqlite3_wsd_find((void*)&(v), sizeof(v)))
  13119. #define sqlite3GlobalConfig GLOBAL(struct Sqlite3Config, sqlite3Config)
  13120. SQLITE_API int sqlite3_wsd_init(int N, int J);
  13121. SQLITE_API void *sqlite3_wsd_find(void *K, int L);
  13122. #else
  13123. #define SQLITE_WSD
  13124. #define GLOBAL(t,v) v
  13125. #define sqlite3GlobalConfig sqlite3Config
  13126. #endif
  13127. /*
  13128. ** The following macros are used to suppress compiler warnings and to
  13129. ** make it clear to human readers when a function parameter is deliberately
  13130. ** left unused within the body of a function. This usually happens when
  13131. ** a function is called via a function pointer. For example the
  13132. ** implementation of an SQL aggregate step callback may not use the
  13133. ** parameter indicating the number of arguments passed to the aggregate,
  13134. ** if it knows that this is enforced elsewhere.
  13135. **
  13136. ** When a function parameter is not used at all within the body of a function,
  13137. ** it is generally named "NotUsed" or "NotUsed2" to make things even clearer.
  13138. ** However, these macros may also be used to suppress warnings related to
  13139. ** parameters that may or may not be used depending on compilation options.
  13140. ** For example those parameters only used in assert() statements. In these
  13141. ** cases the parameters are named as per the usual conventions.
  13142. */
  13143. #define UNUSED_PARAMETER(x) (void)(x)
  13144. #define UNUSED_PARAMETER2(x,y) UNUSED_PARAMETER(x),UNUSED_PARAMETER(y)
  13145. /*
  13146. ** Forward references to structures
  13147. */
  13148. typedef struct AggInfo AggInfo;
  13149. typedef struct AuthContext AuthContext;
  13150. typedef struct AutoincInfo AutoincInfo;
  13151. typedef struct Bitvec Bitvec;
  13152. typedef struct CollSeq CollSeq;
  13153. typedef struct Column Column;
  13154. typedef struct Db Db;
  13155. typedef struct Schema Schema;
  13156. typedef struct Expr Expr;
  13157. typedef struct ExprList ExprList;
  13158. typedef struct FKey FKey;
  13159. typedef struct FuncDestructor FuncDestructor;
  13160. typedef struct FuncDef FuncDef;
  13161. typedef struct FuncDefHash FuncDefHash;
  13162. typedef struct IdList IdList;
  13163. typedef struct Index Index;
  13164. typedef struct IndexSample IndexSample;
  13165. typedef struct KeyClass KeyClass;
  13166. typedef struct KeyInfo KeyInfo;
  13167. typedef struct Lookaside Lookaside;
  13168. typedef struct LookasideSlot LookasideSlot;
  13169. typedef struct Module Module;
  13170. typedef struct NameContext NameContext;
  13171. typedef struct Parse Parse;
  13172. typedef struct PreUpdate PreUpdate;
  13173. typedef struct PrintfArguments PrintfArguments;
  13174. typedef struct RowSet RowSet;
  13175. typedef struct Savepoint Savepoint;
  13176. typedef struct Select Select;
  13177. typedef struct SQLiteThread SQLiteThread;
  13178. typedef struct SelectDest SelectDest;
  13179. typedef struct SrcList SrcList;
  13180. typedef struct StrAccum StrAccum;
  13181. typedef struct Table Table;
  13182. typedef struct TableLock TableLock;
  13183. typedef struct Token Token;
  13184. typedef struct TreeView TreeView;
  13185. typedef struct Trigger Trigger;
  13186. typedef struct TriggerPrg TriggerPrg;
  13187. typedef struct TriggerStep TriggerStep;
  13188. typedef struct UnpackedRecord UnpackedRecord;
  13189. typedef struct VTable VTable;
  13190. typedef struct VtabCtx VtabCtx;
  13191. typedef struct Walker Walker;
  13192. typedef struct WhereInfo WhereInfo;
  13193. typedef struct With With;
  13194. /* A VList object records a mapping between parameters/variables/wildcards
  13195. ** in the SQL statement (such as $abc, @pqr, or :xyz) and the integer
  13196. ** variable number associated with that parameter. See the format description
  13197. ** on the sqlite3VListAdd() routine for more information. A VList is really
  13198. ** just an array of integers.
  13199. */
  13200. typedef int VList;
  13201. /*
  13202. ** Defer sourcing vdbe.h and btree.h until after the "u8" and
  13203. ** "BusyHandler" typedefs. vdbe.h also requires a few of the opaque
  13204. ** pointer types (i.e. FuncDef) defined above.
  13205. */
  13206. /************** Include btree.h in the middle of sqliteInt.h *****************/
  13207. /************** Begin file btree.h *******************************************/
  13208. /*
  13209. ** 2001 September 15
  13210. **
  13211. ** The author disclaims copyright to this source code. In place of
  13212. ** a legal notice, here is a blessing:
  13213. **
  13214. ** May you do good and not evil.
  13215. ** May you find forgiveness for yourself and forgive others.
  13216. ** May you share freely, never taking more than you give.
  13217. **
  13218. *************************************************************************
  13219. ** This header file defines the interface that the sqlite B-Tree file
  13220. ** subsystem. See comments in the source code for a detailed description
  13221. ** of what each interface routine does.
  13222. */
  13223. #ifndef SQLITE_BTREE_H
  13224. #define SQLITE_BTREE_H
  13225. /* TODO: This definition is just included so other modules compile. It
  13226. ** needs to be revisited.
  13227. */
  13228. #define SQLITE_N_BTREE_META 16
  13229. /*
  13230. ** If defined as non-zero, auto-vacuum is enabled by default. Otherwise
  13231. ** it must be turned on for each database using "PRAGMA auto_vacuum = 1".
  13232. */
  13233. #ifndef SQLITE_DEFAULT_AUTOVACUUM
  13234. #define SQLITE_DEFAULT_AUTOVACUUM 0
  13235. #endif
  13236. #define BTREE_AUTOVACUUM_NONE 0 /* Do not do auto-vacuum */
  13237. #define BTREE_AUTOVACUUM_FULL 1 /* Do full auto-vacuum */
  13238. #define BTREE_AUTOVACUUM_INCR 2 /* Incremental vacuum */
  13239. /*
  13240. ** Forward declarations of structure
  13241. */
  13242. typedef struct Btree Btree;
  13243. typedef struct BtCursor BtCursor;
  13244. typedef struct BtShared BtShared;
  13245. typedef struct BtreePayload BtreePayload;
  13246. SQLITE_PRIVATE int sqlite3BtreeOpen(
  13247. sqlite3_vfs *pVfs, /* VFS to use with this b-tree */
  13248. const char *zFilename, /* Name of database file to open */
  13249. sqlite3 *db, /* Associated database connection */
  13250. Btree **ppBtree, /* Return open Btree* here */
  13251. int flags, /* Flags */
  13252. int vfsFlags /* Flags passed through to VFS open */
  13253. );
  13254. /* The flags parameter to sqlite3BtreeOpen can be the bitwise or of the
  13255. ** following values.
  13256. **
  13257. ** NOTE: These values must match the corresponding PAGER_ values in
  13258. ** pager.h.
  13259. */
  13260. #define BTREE_OMIT_JOURNAL 1 /* Do not create or use a rollback journal */
  13261. #define BTREE_MEMORY 2 /* This is an in-memory DB */
  13262. #define BTREE_SINGLE 4 /* The file contains at most 1 b-tree */
  13263. #define BTREE_UNORDERED 8 /* Use of a hash implementation is OK */
  13264. SQLITE_PRIVATE int sqlite3BtreeClose(Btree*);
  13265. SQLITE_PRIVATE int sqlite3BtreeSetCacheSize(Btree*,int);
  13266. SQLITE_PRIVATE int sqlite3BtreeSetSpillSize(Btree*,int);
  13267. #if SQLITE_MAX_MMAP_SIZE>0
  13268. SQLITE_PRIVATE int sqlite3BtreeSetMmapLimit(Btree*,sqlite3_int64);
  13269. #endif
  13270. SQLITE_PRIVATE int sqlite3BtreeSetPagerFlags(Btree*,unsigned);
  13271. SQLITE_PRIVATE int sqlite3BtreeSetPageSize(Btree *p, int nPagesize, int nReserve, int eFix);
  13272. SQLITE_PRIVATE int sqlite3BtreeGetPageSize(Btree*);
  13273. SQLITE_PRIVATE int sqlite3BtreeMaxPageCount(Btree*,int);
  13274. SQLITE_PRIVATE u32 sqlite3BtreeLastPage(Btree*);
  13275. SQLITE_PRIVATE int sqlite3BtreeSecureDelete(Btree*,int);
  13276. SQLITE_PRIVATE int sqlite3BtreeGetOptimalReserve(Btree*);
  13277. SQLITE_PRIVATE int sqlite3BtreeGetReserveNoMutex(Btree *p);
  13278. SQLITE_PRIVATE int sqlite3BtreeSetAutoVacuum(Btree *, int);
  13279. SQLITE_PRIVATE int sqlite3BtreeGetAutoVacuum(Btree *);
  13280. SQLITE_PRIVATE int sqlite3BtreeBeginTrans(Btree*,int);
  13281. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseOne(Btree*, const char *zMaster);
  13282. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseTwo(Btree*, int);
  13283. SQLITE_PRIVATE int sqlite3BtreeCommit(Btree*);
  13284. SQLITE_PRIVATE int sqlite3BtreeRollback(Btree*,int,int);
  13285. SQLITE_PRIVATE int sqlite3BtreeBeginStmt(Btree*,int);
  13286. SQLITE_PRIVATE int sqlite3BtreeCreateTable(Btree*, int*, int flags);
  13287. SQLITE_PRIVATE int sqlite3BtreeIsInTrans(Btree*);
  13288. SQLITE_PRIVATE int sqlite3BtreeIsInReadTrans(Btree*);
  13289. SQLITE_PRIVATE int sqlite3BtreeIsInBackup(Btree*);
  13290. SQLITE_PRIVATE void *sqlite3BtreeSchema(Btree *, int, void(*)(void *));
  13291. SQLITE_PRIVATE int sqlite3BtreeSchemaLocked(Btree *pBtree);
  13292. #ifndef SQLITE_OMIT_SHARED_CACHE
  13293. SQLITE_PRIVATE int sqlite3BtreeLockTable(Btree *pBtree, int iTab, u8 isWriteLock);
  13294. #endif
  13295. SQLITE_PRIVATE int sqlite3BtreeSavepoint(Btree *, int, int);
  13296. SQLITE_PRIVATE const char *sqlite3BtreeGetFilename(Btree *);
  13297. SQLITE_PRIVATE const char *sqlite3BtreeGetJournalname(Btree *);
  13298. SQLITE_PRIVATE int sqlite3BtreeCopyFile(Btree *, Btree *);
  13299. SQLITE_PRIVATE int sqlite3BtreeIncrVacuum(Btree *);
  13300. /* The flags parameter to sqlite3BtreeCreateTable can be the bitwise OR
  13301. ** of the flags shown below.
  13302. **
  13303. ** Every SQLite table must have either BTREE_INTKEY or BTREE_BLOBKEY set.
  13304. ** With BTREE_INTKEY, the table key is a 64-bit integer and arbitrary data
  13305. ** is stored in the leaves. (BTREE_INTKEY is used for SQL tables.) With
  13306. ** BTREE_BLOBKEY, the key is an arbitrary BLOB and no content is stored
  13307. ** anywhere - the key is the content. (BTREE_BLOBKEY is used for SQL
  13308. ** indices.)
  13309. */
  13310. #define BTREE_INTKEY 1 /* Table has only 64-bit signed integer keys */
  13311. #define BTREE_BLOBKEY 2 /* Table has keys only - no data */
  13312. SQLITE_PRIVATE int sqlite3BtreeDropTable(Btree*, int, int*);
  13313. SQLITE_PRIVATE int sqlite3BtreeClearTable(Btree*, int, int*);
  13314. SQLITE_PRIVATE int sqlite3BtreeClearTableOfCursor(BtCursor*);
  13315. SQLITE_PRIVATE int sqlite3BtreeTripAllCursors(Btree*, int, int);
  13316. SQLITE_PRIVATE void sqlite3BtreeGetMeta(Btree *pBtree, int idx, u32 *pValue);
  13317. SQLITE_PRIVATE int sqlite3BtreeUpdateMeta(Btree*, int idx, u32 value);
  13318. SQLITE_PRIVATE int sqlite3BtreeNewDb(Btree *p);
  13319. /*
  13320. ** The second parameter to sqlite3BtreeGetMeta or sqlite3BtreeUpdateMeta
  13321. ** should be one of the following values. The integer values are assigned
  13322. ** to constants so that the offset of the corresponding field in an
  13323. ** SQLite database header may be found using the following formula:
  13324. **
  13325. ** offset = 36 + (idx * 4)
  13326. **
  13327. ** For example, the free-page-count field is located at byte offset 36 of
  13328. ** the database file header. The incr-vacuum-flag field is located at
  13329. ** byte offset 64 (== 36+4*7).
  13330. **
  13331. ** The BTREE_DATA_VERSION value is not really a value stored in the header.
  13332. ** It is a read-only number computed by the pager. But we merge it with
  13333. ** the header value access routines since its access pattern is the same.
  13334. ** Call it a "virtual meta value".
  13335. */
  13336. #define BTREE_FREE_PAGE_COUNT 0
  13337. #define BTREE_SCHEMA_VERSION 1
  13338. #define BTREE_FILE_FORMAT 2
  13339. #define BTREE_DEFAULT_CACHE_SIZE 3
  13340. #define BTREE_LARGEST_ROOT_PAGE 4
  13341. #define BTREE_TEXT_ENCODING 5
  13342. #define BTREE_USER_VERSION 6
  13343. #define BTREE_INCR_VACUUM 7
  13344. #define BTREE_APPLICATION_ID 8
  13345. #define BTREE_DATA_VERSION 15 /* A virtual meta-value */
  13346. /*
  13347. ** Kinds of hints that can be passed into the sqlite3BtreeCursorHint()
  13348. ** interface.
  13349. **
  13350. ** BTREE_HINT_RANGE (arguments: Expr*, Mem*)
  13351. **
  13352. ** The first argument is an Expr* (which is guaranteed to be constant for
  13353. ** the lifetime of the cursor) that defines constraints on which rows
  13354. ** might be fetched with this cursor. The Expr* tree may contain
  13355. ** TK_REGISTER nodes that refer to values stored in the array of registers
  13356. ** passed as the second parameter. In other words, if Expr.op==TK_REGISTER
  13357. ** then the value of the node is the value in Mem[pExpr.iTable]. Any
  13358. ** TK_COLUMN node in the expression tree refers to the Expr.iColumn-th
  13359. ** column of the b-tree of the cursor. The Expr tree will not contain
  13360. ** any function calls nor subqueries nor references to b-trees other than
  13361. ** the cursor being hinted.
  13362. **
  13363. ** The design of the _RANGE hint is aid b-tree implementations that try
  13364. ** to prefetch content from remote machines - to provide those
  13365. ** implementations with limits on what needs to be prefetched and thereby
  13366. ** reduce network bandwidth.
  13367. **
  13368. ** Note that BTREE_HINT_FLAGS with BTREE_BULKLOAD is the only hint used by
  13369. ** standard SQLite. The other hints are provided for extentions that use
  13370. ** the SQLite parser and code generator but substitute their own storage
  13371. ** engine.
  13372. */
  13373. #define BTREE_HINT_RANGE 0 /* Range constraints on queries */
  13374. /*
  13375. ** Values that may be OR'd together to form the argument to the
  13376. ** BTREE_HINT_FLAGS hint for sqlite3BtreeCursorHint():
  13377. **
  13378. ** The BTREE_BULKLOAD flag is set on index cursors when the index is going
  13379. ** to be filled with content that is already in sorted order.
  13380. **
  13381. ** The BTREE_SEEK_EQ flag is set on cursors that will get OP_SeekGE or
  13382. ** OP_SeekLE opcodes for a range search, but where the range of entries
  13383. ** selected will all have the same key. In other words, the cursor will
  13384. ** be used only for equality key searches.
  13385. **
  13386. */
  13387. #define BTREE_BULKLOAD 0x00000001 /* Used to full index in sorted order */
  13388. #define BTREE_SEEK_EQ 0x00000002 /* EQ seeks only - no range seeks */
  13389. /*
  13390. ** Flags passed as the third argument to sqlite3BtreeCursor().
  13391. **
  13392. ** For read-only cursors the wrFlag argument is always zero. For read-write
  13393. ** cursors it may be set to either (BTREE_WRCSR|BTREE_FORDELETE) or just
  13394. ** (BTREE_WRCSR). If the BTREE_FORDELETE bit is set, then the cursor will
  13395. ** only be used by SQLite for the following:
  13396. **
  13397. ** * to seek to and then delete specific entries, and/or
  13398. **
  13399. ** * to read values that will be used to create keys that other
  13400. ** BTREE_FORDELETE cursors will seek to and delete.
  13401. **
  13402. ** The BTREE_FORDELETE flag is an optimization hint. It is not used by
  13403. ** by this, the native b-tree engine of SQLite, but it is available to
  13404. ** alternative storage engines that might be substituted in place of this
  13405. ** b-tree system. For alternative storage engines in which a delete of
  13406. ** the main table row automatically deletes corresponding index rows,
  13407. ** the FORDELETE flag hint allows those alternative storage engines to
  13408. ** skip a lot of work. Namely: FORDELETE cursors may treat all SEEK
  13409. ** and DELETE operations as no-ops, and any READ operation against a
  13410. ** FORDELETE cursor may return a null row: 0x01 0x00.
  13411. */
  13412. #define BTREE_WRCSR 0x00000004 /* read-write cursor */
  13413. #define BTREE_FORDELETE 0x00000008 /* Cursor is for seek/delete only */
  13414. SQLITE_PRIVATE int sqlite3BtreeCursor(
  13415. Btree*, /* BTree containing table to open */
  13416. int iTable, /* Index of root page */
  13417. int wrFlag, /* 1 for writing. 0 for read-only */
  13418. struct KeyInfo*, /* First argument to compare function */
  13419. BtCursor *pCursor /* Space to write cursor structure */
  13420. );
  13421. SQLITE_PRIVATE BtCursor *sqlite3BtreeFakeValidCursor(void);
  13422. SQLITE_PRIVATE int sqlite3BtreeCursorSize(void);
  13423. SQLITE_PRIVATE void sqlite3BtreeCursorZero(BtCursor*);
  13424. SQLITE_PRIVATE void sqlite3BtreeCursorHintFlags(BtCursor*, unsigned);
  13425. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  13426. SQLITE_PRIVATE void sqlite3BtreeCursorHint(BtCursor*, int, ...);
  13427. #endif
  13428. SQLITE_PRIVATE int sqlite3BtreeCloseCursor(BtCursor*);
  13429. SQLITE_PRIVATE int sqlite3BtreeMovetoUnpacked(
  13430. BtCursor*,
  13431. UnpackedRecord *pUnKey,
  13432. i64 intKey,
  13433. int bias,
  13434. int *pRes
  13435. );
  13436. SQLITE_PRIVATE int sqlite3BtreeCursorHasMoved(BtCursor*);
  13437. SQLITE_PRIVATE int sqlite3BtreeCursorRestore(BtCursor*, int*);
  13438. SQLITE_PRIVATE int sqlite3BtreeDelete(BtCursor*, u8 flags);
  13439. /* Allowed flags for sqlite3BtreeDelete() and sqlite3BtreeInsert() */
  13440. #define BTREE_SAVEPOSITION 0x02 /* Leave cursor pointing at NEXT or PREV */
  13441. #define BTREE_AUXDELETE 0x04 /* not the primary delete operation */
  13442. #define BTREE_APPEND 0x08 /* Insert is likely an append */
  13443. /* An instance of the BtreePayload object describes the content of a single
  13444. ** entry in either an index or table btree.
  13445. **
  13446. ** Index btrees (used for indexes and also WITHOUT ROWID tables) contain
  13447. ** an arbitrary key and no data. These btrees have pKey,nKey set to their
  13448. ** key and pData,nData,nZero set to zero.
  13449. **
  13450. ** Table btrees (used for rowid tables) contain an integer rowid used as
  13451. ** the key and passed in the nKey field. The pKey field is zero.
  13452. ** pData,nData hold the content of the new entry. nZero extra zero bytes
  13453. ** are appended to the end of the content when constructing the entry.
  13454. **
  13455. ** This object is used to pass information into sqlite3BtreeInsert(). The
  13456. ** same information used to be passed as five separate parameters. But placing
  13457. ** the information into this object helps to keep the interface more
  13458. ** organized and understandable, and it also helps the resulting code to
  13459. ** run a little faster by using fewer registers for parameter passing.
  13460. */
  13461. struct BtreePayload {
  13462. const void *pKey; /* Key content for indexes. NULL for tables */
  13463. sqlite3_int64 nKey; /* Size of pKey for indexes. PRIMARY KEY for tabs */
  13464. const void *pData; /* Data for tables. NULL for indexes */
  13465. sqlite3_value *aMem; /* First of nMem value in the unpacked pKey */
  13466. u16 nMem; /* Number of aMem[] value. Might be zero */
  13467. int nData; /* Size of pData. 0 if none. */
  13468. int nZero; /* Extra zero data appended after pData,nData */
  13469. };
  13470. SQLITE_PRIVATE int sqlite3BtreeInsert(BtCursor*, const BtreePayload *pPayload,
  13471. int flags, int seekResult);
  13472. SQLITE_PRIVATE int sqlite3BtreeFirst(BtCursor*, int *pRes);
  13473. SQLITE_PRIVATE int sqlite3BtreeLast(BtCursor*, int *pRes);
  13474. SQLITE_PRIVATE int sqlite3BtreeNext(BtCursor*, int flags);
  13475. SQLITE_PRIVATE int sqlite3BtreeEof(BtCursor*);
  13476. SQLITE_PRIVATE int sqlite3BtreePrevious(BtCursor*, int flags);
  13477. SQLITE_PRIVATE i64 sqlite3BtreeIntegerKey(BtCursor*);
  13478. #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
  13479. SQLITE_PRIVATE i64 sqlite3BtreeOffset(BtCursor*);
  13480. #endif
  13481. SQLITE_PRIVATE int sqlite3BtreePayload(BtCursor*, u32 offset, u32 amt, void*);
  13482. SQLITE_PRIVATE const void *sqlite3BtreePayloadFetch(BtCursor*, u32 *pAmt);
  13483. SQLITE_PRIVATE u32 sqlite3BtreePayloadSize(BtCursor*);
  13484. SQLITE_PRIVATE char *sqlite3BtreeIntegrityCheck(Btree*, int *aRoot, int nRoot, int, int*);
  13485. SQLITE_PRIVATE struct Pager *sqlite3BtreePager(Btree*);
  13486. SQLITE_PRIVATE i64 sqlite3BtreeRowCountEst(BtCursor*);
  13487. #ifndef SQLITE_OMIT_INCRBLOB
  13488. SQLITE_PRIVATE int sqlite3BtreePayloadChecked(BtCursor*, u32 offset, u32 amt, void*);
  13489. SQLITE_PRIVATE int sqlite3BtreePutData(BtCursor*, u32 offset, u32 amt, void*);
  13490. SQLITE_PRIVATE void sqlite3BtreeIncrblobCursor(BtCursor *);
  13491. #endif
  13492. SQLITE_PRIVATE void sqlite3BtreeClearCursor(BtCursor *);
  13493. SQLITE_PRIVATE int sqlite3BtreeSetVersion(Btree *pBt, int iVersion);
  13494. SQLITE_PRIVATE int sqlite3BtreeCursorHasHint(BtCursor*, unsigned int mask);
  13495. SQLITE_PRIVATE int sqlite3BtreeIsReadonly(Btree *pBt);
  13496. SQLITE_PRIVATE int sqlite3HeaderSizeBtree(void);
  13497. #ifndef NDEBUG
  13498. SQLITE_PRIVATE int sqlite3BtreeCursorIsValid(BtCursor*);
  13499. #endif
  13500. SQLITE_PRIVATE int sqlite3BtreeCursorIsValidNN(BtCursor*);
  13501. #ifndef SQLITE_OMIT_BTREECOUNT
  13502. SQLITE_PRIVATE int sqlite3BtreeCount(BtCursor *, i64 *);
  13503. #endif
  13504. #ifdef SQLITE_TEST
  13505. SQLITE_PRIVATE int sqlite3BtreeCursorInfo(BtCursor*, int*, int);
  13506. SQLITE_PRIVATE void sqlite3BtreeCursorList(Btree*);
  13507. #endif
  13508. #ifndef SQLITE_OMIT_WAL
  13509. SQLITE_PRIVATE int sqlite3BtreeCheckpoint(Btree*, int, int *, int *);
  13510. #endif
  13511. /*
  13512. ** If we are not using shared cache, then there is no need to
  13513. ** use mutexes to access the BtShared structures. So make the
  13514. ** Enter and Leave procedures no-ops.
  13515. */
  13516. #ifndef SQLITE_OMIT_SHARED_CACHE
  13517. SQLITE_PRIVATE void sqlite3BtreeEnter(Btree*);
  13518. SQLITE_PRIVATE void sqlite3BtreeEnterAll(sqlite3*);
  13519. SQLITE_PRIVATE int sqlite3BtreeSharable(Btree*);
  13520. SQLITE_PRIVATE void sqlite3BtreeEnterCursor(BtCursor*);
  13521. SQLITE_PRIVATE int sqlite3BtreeConnectionCount(Btree*);
  13522. #else
  13523. # define sqlite3BtreeEnter(X)
  13524. # define sqlite3BtreeEnterAll(X)
  13525. # define sqlite3BtreeSharable(X) 0
  13526. # define sqlite3BtreeEnterCursor(X)
  13527. # define sqlite3BtreeConnectionCount(X) 1
  13528. #endif
  13529. #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE
  13530. SQLITE_PRIVATE void sqlite3BtreeLeave(Btree*);
  13531. SQLITE_PRIVATE void sqlite3BtreeLeaveCursor(BtCursor*);
  13532. SQLITE_PRIVATE void sqlite3BtreeLeaveAll(sqlite3*);
  13533. #ifndef NDEBUG
  13534. /* These routines are used inside assert() statements only. */
  13535. SQLITE_PRIVATE int sqlite3BtreeHoldsMutex(Btree*);
  13536. SQLITE_PRIVATE int sqlite3BtreeHoldsAllMutexes(sqlite3*);
  13537. SQLITE_PRIVATE int sqlite3SchemaMutexHeld(sqlite3*,int,Schema*);
  13538. #endif
  13539. #else
  13540. # define sqlite3BtreeLeave(X)
  13541. # define sqlite3BtreeLeaveCursor(X)
  13542. # define sqlite3BtreeLeaveAll(X)
  13543. # define sqlite3BtreeHoldsMutex(X) 1
  13544. # define sqlite3BtreeHoldsAllMutexes(X) 1
  13545. # define sqlite3SchemaMutexHeld(X,Y,Z) 1
  13546. #endif
  13547. #endif /* SQLITE_BTREE_H */
  13548. /************** End of btree.h ***********************************************/
  13549. /************** Continuing where we left off in sqliteInt.h ******************/
  13550. /************** Include vdbe.h in the middle of sqliteInt.h ******************/
  13551. /************** Begin file vdbe.h ********************************************/
  13552. /*
  13553. ** 2001 September 15
  13554. **
  13555. ** The author disclaims copyright to this source code. In place of
  13556. ** a legal notice, here is a blessing:
  13557. **
  13558. ** May you do good and not evil.
  13559. ** May you find forgiveness for yourself and forgive others.
  13560. ** May you share freely, never taking more than you give.
  13561. **
  13562. *************************************************************************
  13563. ** Header file for the Virtual DataBase Engine (VDBE)
  13564. **
  13565. ** This header defines the interface to the virtual database engine
  13566. ** or VDBE. The VDBE implements an abstract machine that runs a
  13567. ** simple program to access and modify the underlying database.
  13568. */
  13569. #ifndef SQLITE_VDBE_H
  13570. #define SQLITE_VDBE_H
  13571. /* #include <stdio.h> */
  13572. /*
  13573. ** A single VDBE is an opaque structure named "Vdbe". Only routines
  13574. ** in the source file sqliteVdbe.c are allowed to see the insides
  13575. ** of this structure.
  13576. */
  13577. typedef struct Vdbe Vdbe;
  13578. /*
  13579. ** The names of the following types declared in vdbeInt.h are required
  13580. ** for the VdbeOp definition.
  13581. */
  13582. typedef struct sqlite3_value Mem;
  13583. typedef struct SubProgram SubProgram;
  13584. /*
  13585. ** A single instruction of the virtual machine has an opcode
  13586. ** and as many as three operands. The instruction is recorded
  13587. ** as an instance of the following structure:
  13588. */
  13589. struct VdbeOp {
  13590. u8 opcode; /* What operation to perform */
  13591. signed char p4type; /* One of the P4_xxx constants for p4 */
  13592. u16 p5; /* Fifth parameter is an unsigned 16-bit integer */
  13593. int p1; /* First operand */
  13594. int p2; /* Second parameter (often the jump destination) */
  13595. int p3; /* The third parameter */
  13596. union p4union { /* fourth parameter */
  13597. int i; /* Integer value if p4type==P4_INT32 */
  13598. void *p; /* Generic pointer */
  13599. char *z; /* Pointer to data for string (char array) types */
  13600. i64 *pI64; /* Used when p4type is P4_INT64 */
  13601. double *pReal; /* Used when p4type is P4_REAL */
  13602. FuncDef *pFunc; /* Used when p4type is P4_FUNCDEF */
  13603. sqlite3_context *pCtx; /* Used when p4type is P4_FUNCCTX */
  13604. CollSeq *pColl; /* Used when p4type is P4_COLLSEQ */
  13605. Mem *pMem; /* Used when p4type is P4_MEM */
  13606. VTable *pVtab; /* Used when p4type is P4_VTAB */
  13607. KeyInfo *pKeyInfo; /* Used when p4type is P4_KEYINFO */
  13608. int *ai; /* Used when p4type is P4_INTARRAY */
  13609. SubProgram *pProgram; /* Used when p4type is P4_SUBPROGRAM */
  13610. Table *pTab; /* Used when p4type is P4_TABLE */
  13611. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  13612. Expr *pExpr; /* Used when p4type is P4_EXPR */
  13613. #endif
  13614. int (*xAdvance)(BtCursor *, int);
  13615. } p4;
  13616. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  13617. char *zComment; /* Comment to improve readability */
  13618. #endif
  13619. #ifdef VDBE_PROFILE
  13620. u32 cnt; /* Number of times this instruction was executed */
  13621. u64 cycles; /* Total time spent executing this instruction */
  13622. #endif
  13623. #ifdef SQLITE_VDBE_COVERAGE
  13624. int iSrcLine; /* Source-code line that generated this opcode */
  13625. #endif
  13626. };
  13627. typedef struct VdbeOp VdbeOp;
  13628. /*
  13629. ** A sub-routine used to implement a trigger program.
  13630. */
  13631. struct SubProgram {
  13632. VdbeOp *aOp; /* Array of opcodes for sub-program */
  13633. int nOp; /* Elements in aOp[] */
  13634. int nMem; /* Number of memory cells required */
  13635. int nCsr; /* Number of cursors required */
  13636. u8 *aOnce; /* Array of OP_Once flags */
  13637. void *token; /* id that may be used to recursive triggers */
  13638. SubProgram *pNext; /* Next sub-program already visited */
  13639. };
  13640. /*
  13641. ** A smaller version of VdbeOp used for the VdbeAddOpList() function because
  13642. ** it takes up less space.
  13643. */
  13644. struct VdbeOpList {
  13645. u8 opcode; /* What operation to perform */
  13646. signed char p1; /* First operand */
  13647. signed char p2; /* Second parameter (often the jump destination) */
  13648. signed char p3; /* Third parameter */
  13649. };
  13650. typedef struct VdbeOpList VdbeOpList;
  13651. /*
  13652. ** Allowed values of VdbeOp.p4type
  13653. */
  13654. #define P4_NOTUSED 0 /* The P4 parameter is not used */
  13655. #define P4_TRANSIENT 0 /* P4 is a pointer to a transient string */
  13656. #define P4_STATIC (-1) /* Pointer to a static string */
  13657. #define P4_COLLSEQ (-2) /* P4 is a pointer to a CollSeq structure */
  13658. #define P4_INT32 (-3) /* P4 is a 32-bit signed integer */
  13659. #define P4_SUBPROGRAM (-4) /* P4 is a pointer to a SubProgram structure */
  13660. #define P4_ADVANCE (-5) /* P4 is a pointer to BtreeNext() or BtreePrev() */
  13661. #define P4_TABLE (-6) /* P4 is a pointer to a Table structure */
  13662. /* Above do not own any resources. Must free those below */
  13663. #define P4_FREE_IF_LE (-7)
  13664. #define P4_DYNAMIC (-7) /* Pointer to memory from sqliteMalloc() */
  13665. #define P4_FUNCDEF (-8) /* P4 is a pointer to a FuncDef structure */
  13666. #define P4_KEYINFO (-9) /* P4 is a pointer to a KeyInfo structure */
  13667. #define P4_EXPR (-10) /* P4 is a pointer to an Expr tree */
  13668. #define P4_MEM (-11) /* P4 is a pointer to a Mem* structure */
  13669. #define P4_VTAB (-12) /* P4 is a pointer to an sqlite3_vtab structure */
  13670. #define P4_REAL (-13) /* P4 is a 64-bit floating point value */
  13671. #define P4_INT64 (-14) /* P4 is a 64-bit signed integer */
  13672. #define P4_INTARRAY (-15) /* P4 is a vector of 32-bit integers */
  13673. #define P4_FUNCCTX (-16) /* P4 is a pointer to an sqlite3_context object */
  13674. #define P4_DYNBLOB (-17) /* Pointer to memory from sqliteMalloc() */
  13675. /* Error message codes for OP_Halt */
  13676. #define P5_ConstraintNotNull 1
  13677. #define P5_ConstraintUnique 2
  13678. #define P5_ConstraintCheck 3
  13679. #define P5_ConstraintFK 4
  13680. /*
  13681. ** The Vdbe.aColName array contains 5n Mem structures, where n is the
  13682. ** number of columns of data returned by the statement.
  13683. */
  13684. #define COLNAME_NAME 0
  13685. #define COLNAME_DECLTYPE 1
  13686. #define COLNAME_DATABASE 2
  13687. #define COLNAME_TABLE 3
  13688. #define COLNAME_COLUMN 4
  13689. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  13690. # define COLNAME_N 5 /* Number of COLNAME_xxx symbols */
  13691. #else
  13692. # ifdef SQLITE_OMIT_DECLTYPE
  13693. # define COLNAME_N 1 /* Store only the name */
  13694. # else
  13695. # define COLNAME_N 2 /* Store the name and decltype */
  13696. # endif
  13697. #endif
  13698. /*
  13699. ** The following macro converts a relative address in the p2 field
  13700. ** of a VdbeOp structure into a negative number so that
  13701. ** sqlite3VdbeAddOpList() knows that the address is relative. Calling
  13702. ** the macro again restores the address.
  13703. */
  13704. #define ADDR(X) (-1-(X))
  13705. /*
  13706. ** The makefile scans the vdbe.c source file and creates the "opcodes.h"
  13707. ** header file that defines a number for each opcode used by the VDBE.
  13708. */
  13709. /************** Include opcodes.h in the middle of vdbe.h ********************/
  13710. /************** Begin file opcodes.h *****************************************/
  13711. /* Automatically generated. Do not edit */
  13712. /* See the tool/mkopcodeh.tcl script for details */
  13713. #define OP_Savepoint 0
  13714. #define OP_AutoCommit 1
  13715. #define OP_Transaction 2
  13716. #define OP_SorterNext 3 /* jump */
  13717. #define OP_PrevIfOpen 4 /* jump */
  13718. #define OP_NextIfOpen 5 /* jump */
  13719. #define OP_Prev 6 /* jump */
  13720. #define OP_Next 7 /* jump */
  13721. #define OP_Checkpoint 8
  13722. #define OP_JournalMode 9
  13723. #define OP_Vacuum 10
  13724. #define OP_VFilter 11 /* jump, synopsis: iplan=r[P3] zplan='P4' */
  13725. #define OP_VUpdate 12 /* synopsis: data=r[P3@P2] */
  13726. #define OP_Goto 13 /* jump */
  13727. #define OP_Gosub 14 /* jump */
  13728. #define OP_InitCoroutine 15 /* jump */
  13729. #define OP_Yield 16 /* jump */
  13730. #define OP_MustBeInt 17 /* jump */
  13731. #define OP_Jump 18 /* jump */
  13732. #define OP_Not 19 /* same as TK_NOT, synopsis: r[P2]= !r[P1] */
  13733. #define OP_Once 20 /* jump */
  13734. #define OP_If 21 /* jump */
  13735. #define OP_IfNot 22 /* jump */
  13736. #define OP_IfNullRow 23 /* jump, synopsis: if P1.nullRow then r[P3]=NULL, goto P2 */
  13737. #define OP_SeekLT 24 /* jump, synopsis: key=r[P3@P4] */
  13738. #define OP_SeekLE 25 /* jump, synopsis: key=r[P3@P4] */
  13739. #define OP_SeekGE 26 /* jump, synopsis: key=r[P3@P4] */
  13740. #define OP_SeekGT 27 /* jump, synopsis: key=r[P3@P4] */
  13741. #define OP_NoConflict 28 /* jump, synopsis: key=r[P3@P4] */
  13742. #define OP_NotFound 29 /* jump, synopsis: key=r[P3@P4] */
  13743. #define OP_Found 30 /* jump, synopsis: key=r[P3@P4] */
  13744. #define OP_SeekRowid 31 /* jump, synopsis: intkey=r[P3] */
  13745. #define OP_NotExists 32 /* jump, synopsis: intkey=r[P3] */
  13746. #define OP_Last 33 /* jump */
  13747. #define OP_IfSmaller 34 /* jump */
  13748. #define OP_SorterSort 35 /* jump */
  13749. #define OP_Sort 36 /* jump */
  13750. #define OP_Rewind 37 /* jump */
  13751. #define OP_IdxLE 38 /* jump, synopsis: key=r[P3@P4] */
  13752. #define OP_IdxGT 39 /* jump, synopsis: key=r[P3@P4] */
  13753. #define OP_IdxLT 40 /* jump, synopsis: key=r[P3@P4] */
  13754. #define OP_IdxGE 41 /* jump, synopsis: key=r[P3@P4] */
  13755. #define OP_RowSetRead 42 /* jump, synopsis: r[P3]=rowset(P1) */
  13756. #define OP_Or 43 /* same as TK_OR, synopsis: r[P3]=(r[P1] || r[P2]) */
  13757. #define OP_And 44 /* same as TK_AND, synopsis: r[P3]=(r[P1] && r[P2]) */
  13758. #define OP_RowSetTest 45 /* jump, synopsis: if r[P3] in rowset(P1) goto P2 */
  13759. #define OP_Program 46 /* jump */
  13760. #define OP_FkIfZero 47 /* jump, synopsis: if fkctr[P1]==0 goto P2 */
  13761. #define OP_IfPos 48 /* jump, synopsis: if r[P1]>0 then r[P1]-=P3, goto P2 */
  13762. #define OP_IfNotZero 49 /* jump, synopsis: if r[P1]!=0 then r[P1]--, goto P2 */
  13763. #define OP_IsNull 50 /* jump, same as TK_ISNULL, synopsis: if r[P1]==NULL goto P2 */
  13764. #define OP_NotNull 51 /* jump, same as TK_NOTNULL, synopsis: if r[P1]!=NULL goto P2 */
  13765. #define OP_Ne 52 /* jump, same as TK_NE, synopsis: IF r[P3]!=r[P1] */
  13766. #define OP_Eq 53 /* jump, same as TK_EQ, synopsis: IF r[P3]==r[P1] */
  13767. #define OP_Gt 54 /* jump, same as TK_GT, synopsis: IF r[P3]>r[P1] */
  13768. #define OP_Le 55 /* jump, same as TK_LE, synopsis: IF r[P3]<=r[P1] */
  13769. #define OP_Lt 56 /* jump, same as TK_LT, synopsis: IF r[P3]<r[P1] */
  13770. #define OP_Ge 57 /* jump, same as TK_GE, synopsis: IF r[P3]>=r[P1] */
  13771. #define OP_ElseNotEq 58 /* jump, same as TK_ESCAPE */
  13772. #define OP_DecrJumpZero 59 /* jump, synopsis: if (--r[P1])==0 goto P2 */
  13773. #define OP_IncrVacuum 60 /* jump */
  13774. #define OP_VNext 61 /* jump */
  13775. #define OP_Init 62 /* jump, synopsis: Start at P2 */
  13776. #define OP_Return 63
  13777. #define OP_EndCoroutine 64
  13778. #define OP_HaltIfNull 65 /* synopsis: if r[P3]=null halt */
  13779. #define OP_Halt 66
  13780. #define OP_Integer 67 /* synopsis: r[P2]=P1 */
  13781. #define OP_Int64 68 /* synopsis: r[P2]=P4 */
  13782. #define OP_String 69 /* synopsis: r[P2]='P4' (len=P1) */
  13783. #define OP_Null 70 /* synopsis: r[P2..P3]=NULL */
  13784. #define OP_SoftNull 71 /* synopsis: r[P1]=NULL */
  13785. #define OP_Blob 72 /* synopsis: r[P2]=P4 (len=P1) */
  13786. #define OP_Variable 73 /* synopsis: r[P2]=parameter(P1,P4) */
  13787. #define OP_Move 74 /* synopsis: r[P2@P3]=r[P1@P3] */
  13788. #define OP_Copy 75 /* synopsis: r[P2@P3+1]=r[P1@P3+1] */
  13789. #define OP_SCopy 76 /* synopsis: r[P2]=r[P1] */
  13790. #define OP_IntCopy 77 /* synopsis: r[P2]=r[P1] */
  13791. #define OP_ResultRow 78 /* synopsis: output=r[P1@P2] */
  13792. #define OP_CollSeq 79
  13793. #define OP_AddImm 80 /* synopsis: r[P1]=r[P1]+P2 */
  13794. #define OP_RealAffinity 81
  13795. #define OP_Cast 82 /* synopsis: affinity(r[P1]) */
  13796. #define OP_Permutation 83
  13797. #define OP_BitAnd 84 /* same as TK_BITAND, synopsis: r[P3]=r[P1]&r[P2] */
  13798. #define OP_BitOr 85 /* same as TK_BITOR, synopsis: r[P3]=r[P1]|r[P2] */
  13799. #define OP_ShiftLeft 86 /* same as TK_LSHIFT, synopsis: r[P3]=r[P2]<<r[P1] */
  13800. #define OP_ShiftRight 87 /* same as TK_RSHIFT, synopsis: r[P3]=r[P2]>>r[P1] */
  13801. #define OP_Add 88 /* same as TK_PLUS, synopsis: r[P3]=r[P1]+r[P2] */
  13802. #define OP_Subtract 89 /* same as TK_MINUS, synopsis: r[P3]=r[P2]-r[P1] */
  13803. #define OP_Multiply 90 /* same as TK_STAR, synopsis: r[P3]=r[P1]*r[P2] */
  13804. #define OP_Divide 91 /* same as TK_SLASH, synopsis: r[P3]=r[P2]/r[P1] */
  13805. #define OP_Remainder 92 /* same as TK_REM, synopsis: r[P3]=r[P2]%r[P1] */
  13806. #define OP_Concat 93 /* same as TK_CONCAT, synopsis: r[P3]=r[P2]+r[P1] */
  13807. #define OP_Compare 94 /* synopsis: r[P1@P3] <-> r[P2@P3] */
  13808. #define OP_BitNot 95 /* same as TK_BITNOT, synopsis: r[P1]= ~r[P1] */
  13809. #define OP_IsTrue 96 /* synopsis: r[P2] = coalesce(r[P1]==TRUE,P3) ^ P4 */
  13810. #define OP_String8 97 /* same as TK_STRING, synopsis: r[P2]='P4' */
  13811. #define OP_Offset 98 /* synopsis: r[P3] = sqlite_offset(P1) */
  13812. #define OP_Column 99 /* synopsis: r[P3]=PX */
  13813. #define OP_Affinity 100 /* synopsis: affinity(r[P1@P2]) */
  13814. #define OP_MakeRecord 101 /* synopsis: r[P3]=mkrec(r[P1@P2]) */
  13815. #define OP_Count 102 /* synopsis: r[P2]=count() */
  13816. #define OP_ReadCookie 103
  13817. #define OP_SetCookie 104
  13818. #define OP_ReopenIdx 105 /* synopsis: root=P2 iDb=P3 */
  13819. #define OP_OpenRead 106 /* synopsis: root=P2 iDb=P3 */
  13820. #define OP_OpenWrite 107 /* synopsis: root=P2 iDb=P3 */
  13821. #define OP_OpenDup 108
  13822. #define OP_OpenAutoindex 109 /* synopsis: nColumn=P2 */
  13823. #define OP_OpenEphemeral 110 /* synopsis: nColumn=P2 */
  13824. #define OP_SorterOpen 111
  13825. #define OP_SequenceTest 112 /* synopsis: if( cursor[P1].ctr++ ) pc = P2 */
  13826. #define OP_OpenPseudo 113 /* synopsis: P3 columns in r[P2] */
  13827. #define OP_Close 114
  13828. #define OP_ColumnsUsed 115
  13829. #define OP_Sequence 116 /* synopsis: r[P2]=cursor[P1].ctr++ */
  13830. #define OP_NewRowid 117 /* synopsis: r[P2]=rowid */
  13831. #define OP_Insert 118 /* synopsis: intkey=r[P3] data=r[P2] */
  13832. #define OP_InsertInt 119 /* synopsis: intkey=P3 data=r[P2] */
  13833. #define OP_Delete 120
  13834. #define OP_ResetCount 121
  13835. #define OP_SorterCompare 122 /* synopsis: if key(P1)!=trim(r[P3],P4) goto P2 */
  13836. #define OP_SorterData 123 /* synopsis: r[P2]=data */
  13837. #define OP_RowData 124 /* synopsis: r[P2]=data */
  13838. #define OP_Rowid 125 /* synopsis: r[P2]=rowid */
  13839. #define OP_NullRow 126
  13840. #define OP_SeekEnd 127
  13841. #define OP_SorterInsert 128 /* synopsis: key=r[P2] */
  13842. #define OP_IdxInsert 129 /* synopsis: key=r[P2] */
  13843. #define OP_IdxDelete 130 /* synopsis: key=r[P2@P3] */
  13844. #define OP_DeferredSeek 131 /* synopsis: Move P3 to P1.rowid if needed */
  13845. #define OP_Real 132 /* same as TK_FLOAT, synopsis: r[P2]=P4 */
  13846. #define OP_IdxRowid 133 /* synopsis: r[P2]=rowid */
  13847. #define OP_Destroy 134
  13848. #define OP_Clear 135
  13849. #define OP_ResetSorter 136
  13850. #define OP_CreateBtree 137 /* synopsis: r[P2]=root iDb=P1 flags=P3 */
  13851. #define OP_SqlExec 138
  13852. #define OP_ParseSchema 139
  13853. #define OP_LoadAnalysis 140
  13854. #define OP_DropTable 141
  13855. #define OP_DropIndex 142
  13856. #define OP_DropTrigger 143
  13857. #define OP_IntegrityCk 144
  13858. #define OP_RowSetAdd 145 /* synopsis: rowset(P1)=r[P2] */
  13859. #define OP_Param 146
  13860. #define OP_FkCounter 147 /* synopsis: fkctr[P1]+=P2 */
  13861. #define OP_MemMax 148 /* synopsis: r[P1]=max(r[P1],r[P2]) */
  13862. #define OP_OffsetLimit 149 /* synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1) */
  13863. #define OP_AggStep0 150 /* synopsis: accum=r[P3] step(r[P2@P5]) */
  13864. #define OP_AggStep 151 /* synopsis: accum=r[P3] step(r[P2@P5]) */
  13865. #define OP_AggFinal 152 /* synopsis: accum=r[P1] N=P2 */
  13866. #define OP_Expire 153
  13867. #define OP_TableLock 154 /* synopsis: iDb=P1 root=P2 write=P3 */
  13868. #define OP_VBegin 155
  13869. #define OP_VCreate 156
  13870. #define OP_VDestroy 157
  13871. #define OP_VOpen 158
  13872. #define OP_VColumn 159 /* synopsis: r[P3]=vcolumn(P2) */
  13873. #define OP_VRename 160
  13874. #define OP_Pagecount 161
  13875. #define OP_MaxPgcnt 162
  13876. #define OP_PureFunc0 163
  13877. #define OP_Function0 164 /* synopsis: r[P3]=func(r[P2@P5]) */
  13878. #define OP_PureFunc 165
  13879. #define OP_Function 166 /* synopsis: r[P3]=func(r[P2@P5]) */
  13880. #define OP_Trace 167
  13881. #define OP_CursorHint 168
  13882. #define OP_Noop 169
  13883. #define OP_Explain 170
  13884. /* Properties such as "out2" or "jump" that are specified in
  13885. ** comments following the "case" for each opcode in the vdbe.c
  13886. ** are encoded into bitvectors as follows:
  13887. */
  13888. #define OPFLG_JUMP 0x01 /* jump: P2 holds jmp target */
  13889. #define OPFLG_IN1 0x02 /* in1: P1 is an input */
  13890. #define OPFLG_IN2 0x04 /* in2: P2 is an input */
  13891. #define OPFLG_IN3 0x08 /* in3: P3 is an input */
  13892. #define OPFLG_OUT2 0x10 /* out2: P2 is an output */
  13893. #define OPFLG_OUT3 0x20 /* out3: P3 is an output */
  13894. #define OPFLG_INITIALIZER {\
  13895. /* 0 */ 0x00, 0x00, 0x00, 0x01, 0x01, 0x01, 0x01, 0x01,\
  13896. /* 8 */ 0x00, 0x10, 0x00, 0x01, 0x00, 0x01, 0x01, 0x01,\
  13897. /* 16 */ 0x03, 0x03, 0x01, 0x12, 0x01, 0x03, 0x03, 0x01,\
  13898. /* 24 */ 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,\
  13899. /* 32 */ 0x09, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,\
  13900. /* 40 */ 0x01, 0x01, 0x23, 0x26, 0x26, 0x0b, 0x01, 0x01,\
  13901. /* 48 */ 0x03, 0x03, 0x03, 0x03, 0x0b, 0x0b, 0x0b, 0x0b,\
  13902. /* 56 */ 0x0b, 0x0b, 0x01, 0x03, 0x01, 0x01, 0x01, 0x02,\
  13903. /* 64 */ 0x02, 0x08, 0x00, 0x10, 0x10, 0x10, 0x10, 0x00,\
  13904. /* 72 */ 0x10, 0x10, 0x00, 0x00, 0x10, 0x10, 0x00, 0x00,\
  13905. /* 80 */ 0x02, 0x02, 0x02, 0x00, 0x26, 0x26, 0x26, 0x26,\
  13906. /* 88 */ 0x26, 0x26, 0x26, 0x26, 0x26, 0x26, 0x00, 0x12,\
  13907. /* 96 */ 0x12, 0x10, 0x20, 0x00, 0x00, 0x00, 0x10, 0x10,\
  13908. /* 104 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
  13909. /* 112 */ 0x00, 0x00, 0x00, 0x00, 0x10, 0x10, 0x00, 0x00,\
  13910. /* 120 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, 0x00,\
  13911. /* 128 */ 0x04, 0x04, 0x00, 0x00, 0x10, 0x10, 0x10, 0x00,\
  13912. /* 136 */ 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
  13913. /* 144 */ 0x00, 0x06, 0x10, 0x00, 0x04, 0x1a, 0x00, 0x00,\
  13914. /* 152 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,\
  13915. /* 160 */ 0x00, 0x10, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00,\
  13916. /* 168 */ 0x00, 0x00, 0x00,}
  13917. /* The sqlite3P2Values() routine is able to run faster if it knows
  13918. ** the value of the largest JUMP opcode. The smaller the maximum
  13919. ** JUMP opcode the better, so the mkopcodeh.tcl script that
  13920. ** generated this include file strives to group all JUMP opcodes
  13921. ** together near the beginning of the list.
  13922. */
  13923. #define SQLITE_MX_JUMP_OPCODE 62 /* Maximum JUMP opcode */
  13924. /************** End of opcodes.h *********************************************/
  13925. /************** Continuing where we left off in vdbe.h ***********************/
  13926. /*
  13927. ** Additional non-public SQLITE_PREPARE_* flags
  13928. */
  13929. #define SQLITE_PREPARE_SAVESQL 0x80 /* Preserve SQL text */
  13930. #define SQLITE_PREPARE_MASK 0x0f /* Mask of public flags */
  13931. /*
  13932. ** Prototypes for the VDBE interface. See comments on the implementation
  13933. ** for a description of what each of these routines does.
  13934. */
  13935. SQLITE_PRIVATE Vdbe *sqlite3VdbeCreate(Parse*);
  13936. SQLITE_PRIVATE int sqlite3VdbeAddOp0(Vdbe*,int);
  13937. SQLITE_PRIVATE int sqlite3VdbeAddOp1(Vdbe*,int,int);
  13938. SQLITE_PRIVATE int sqlite3VdbeAddOp2(Vdbe*,int,int,int);
  13939. SQLITE_PRIVATE int sqlite3VdbeGoto(Vdbe*,int);
  13940. SQLITE_PRIVATE int sqlite3VdbeLoadString(Vdbe*,int,const char*);
  13941. SQLITE_PRIVATE void sqlite3VdbeMultiLoad(Vdbe*,int,const char*,...);
  13942. SQLITE_PRIVATE int sqlite3VdbeAddOp3(Vdbe*,int,int,int,int);
  13943. SQLITE_PRIVATE int sqlite3VdbeAddOp4(Vdbe*,int,int,int,int,const char *zP4,int);
  13944. SQLITE_PRIVATE int sqlite3VdbeAddOp4Dup8(Vdbe*,int,int,int,int,const u8*,int);
  13945. SQLITE_PRIVATE int sqlite3VdbeAddOp4Int(Vdbe*,int,int,int,int,int);
  13946. SQLITE_PRIVATE void sqlite3VdbeEndCoroutine(Vdbe*,int);
  13947. #if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
  13948. SQLITE_PRIVATE void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N);
  13949. SQLITE_PRIVATE void sqlite3VdbeVerifyNoResultRow(Vdbe *p);
  13950. #else
  13951. # define sqlite3VdbeVerifyNoMallocRequired(A,B)
  13952. # define sqlite3VdbeVerifyNoResultRow(A)
  13953. #endif
  13954. SQLITE_PRIVATE VdbeOp *sqlite3VdbeAddOpList(Vdbe*, int nOp, VdbeOpList const *aOp, int iLineno);
  13955. SQLITE_PRIVATE void sqlite3VdbeAddParseSchemaOp(Vdbe*,int,char*);
  13956. SQLITE_PRIVATE void sqlite3VdbeChangeOpcode(Vdbe*, u32 addr, u8);
  13957. SQLITE_PRIVATE void sqlite3VdbeChangeP1(Vdbe*, u32 addr, int P1);
  13958. SQLITE_PRIVATE void sqlite3VdbeChangeP2(Vdbe*, u32 addr, int P2);
  13959. SQLITE_PRIVATE void sqlite3VdbeChangeP3(Vdbe*, u32 addr, int P3);
  13960. SQLITE_PRIVATE void sqlite3VdbeChangeP5(Vdbe*, u16 P5);
  13961. SQLITE_PRIVATE void sqlite3VdbeJumpHere(Vdbe*, int addr);
  13962. SQLITE_PRIVATE int sqlite3VdbeChangeToNoop(Vdbe*, int addr);
  13963. SQLITE_PRIVATE int sqlite3VdbeDeletePriorOpcode(Vdbe*, u8 op);
  13964. SQLITE_PRIVATE void sqlite3VdbeChangeP4(Vdbe*, int addr, const char *zP4, int N);
  13965. SQLITE_PRIVATE void sqlite3VdbeAppendP4(Vdbe*, void *pP4, int p4type);
  13966. SQLITE_PRIVATE void sqlite3VdbeSetP4KeyInfo(Parse*, Index*);
  13967. SQLITE_PRIVATE void sqlite3VdbeUsesBtree(Vdbe*, int);
  13968. SQLITE_PRIVATE VdbeOp *sqlite3VdbeGetOp(Vdbe*, int);
  13969. SQLITE_PRIVATE int sqlite3VdbeMakeLabel(Vdbe*);
  13970. SQLITE_PRIVATE void sqlite3VdbeRunOnlyOnce(Vdbe*);
  13971. SQLITE_PRIVATE void sqlite3VdbeReusable(Vdbe*);
  13972. SQLITE_PRIVATE void sqlite3VdbeDelete(Vdbe*);
  13973. SQLITE_PRIVATE void sqlite3VdbeClearObject(sqlite3*,Vdbe*);
  13974. SQLITE_PRIVATE void sqlite3VdbeMakeReady(Vdbe*,Parse*);
  13975. SQLITE_PRIVATE int sqlite3VdbeFinalize(Vdbe*);
  13976. SQLITE_PRIVATE void sqlite3VdbeResolveLabel(Vdbe*, int);
  13977. SQLITE_PRIVATE int sqlite3VdbeCurrentAddr(Vdbe*);
  13978. #ifdef SQLITE_DEBUG
  13979. SQLITE_PRIVATE int sqlite3VdbeAssertMayAbort(Vdbe *, int);
  13980. #endif
  13981. SQLITE_PRIVATE void sqlite3VdbeResetStepResult(Vdbe*);
  13982. SQLITE_PRIVATE void sqlite3VdbeRewind(Vdbe*);
  13983. SQLITE_PRIVATE int sqlite3VdbeReset(Vdbe*);
  13984. SQLITE_PRIVATE void sqlite3VdbeSetNumCols(Vdbe*,int);
  13985. SQLITE_PRIVATE int sqlite3VdbeSetColName(Vdbe*, int, int, const char *, void(*)(void*));
  13986. SQLITE_PRIVATE void sqlite3VdbeCountChanges(Vdbe*);
  13987. SQLITE_PRIVATE sqlite3 *sqlite3VdbeDb(Vdbe*);
  13988. SQLITE_PRIVATE u8 sqlite3VdbePrepareFlags(Vdbe*);
  13989. SQLITE_PRIVATE void sqlite3VdbeSetSql(Vdbe*, const char *z, int n, u8);
  13990. SQLITE_PRIVATE void sqlite3VdbeSwap(Vdbe*,Vdbe*);
  13991. SQLITE_PRIVATE VdbeOp *sqlite3VdbeTakeOpArray(Vdbe*, int*, int*);
  13992. SQLITE_PRIVATE sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe*, int, u8);
  13993. SQLITE_PRIVATE void sqlite3VdbeSetVarmask(Vdbe*, int);
  13994. #ifndef SQLITE_OMIT_TRACE
  13995. SQLITE_PRIVATE char *sqlite3VdbeExpandSql(Vdbe*, const char*);
  13996. #endif
  13997. SQLITE_PRIVATE int sqlite3MemCompare(const Mem*, const Mem*, const CollSeq*);
  13998. SQLITE_PRIVATE void sqlite3VdbeRecordUnpack(KeyInfo*,int,const void*,UnpackedRecord*);
  13999. SQLITE_PRIVATE int sqlite3VdbeRecordCompare(int,const void*,UnpackedRecord*);
  14000. SQLITE_PRIVATE int sqlite3VdbeRecordCompareWithSkip(int, const void *, UnpackedRecord *, int);
  14001. SQLITE_PRIVATE UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(KeyInfo*);
  14002. typedef int (*RecordCompare)(int,const void*,UnpackedRecord*);
  14003. SQLITE_PRIVATE RecordCompare sqlite3VdbeFindCompare(UnpackedRecord*);
  14004. #ifndef SQLITE_OMIT_TRIGGER
  14005. SQLITE_PRIVATE void sqlite3VdbeLinkSubProgram(Vdbe *, SubProgram *);
  14006. #endif
  14007. SQLITE_PRIVATE int sqlite3NotPureFunc(sqlite3_context*);
  14008. /* Use SQLITE_ENABLE_COMMENTS to enable generation of extra comments on
  14009. ** each VDBE opcode.
  14010. **
  14011. ** Use the SQLITE_ENABLE_MODULE_COMMENTS macro to see some extra no-op
  14012. ** comments in VDBE programs that show key decision points in the code
  14013. ** generator.
  14014. */
  14015. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  14016. SQLITE_PRIVATE void sqlite3VdbeComment(Vdbe*, const char*, ...);
  14017. # define VdbeComment(X) sqlite3VdbeComment X
  14018. SQLITE_PRIVATE void sqlite3VdbeNoopComment(Vdbe*, const char*, ...);
  14019. # define VdbeNoopComment(X) sqlite3VdbeNoopComment X
  14020. # ifdef SQLITE_ENABLE_MODULE_COMMENTS
  14021. # define VdbeModuleComment(X) sqlite3VdbeNoopComment X
  14022. # else
  14023. # define VdbeModuleComment(X)
  14024. # endif
  14025. #else
  14026. # define VdbeComment(X)
  14027. # define VdbeNoopComment(X)
  14028. # define VdbeModuleComment(X)
  14029. #endif
  14030. /*
  14031. ** The VdbeCoverage macros are used to set a coverage testing point
  14032. ** for VDBE branch instructions. The coverage testing points are line
  14033. ** numbers in the sqlite3.c source file. VDBE branch coverage testing
  14034. ** only works with an amalagmation build. That's ok since a VDBE branch
  14035. ** coverage build designed for testing the test suite only. No application
  14036. ** should ever ship with VDBE branch coverage measuring turned on.
  14037. **
  14038. ** VdbeCoverage(v) // Mark the previously coded instruction
  14039. ** // as a branch
  14040. **
  14041. ** VdbeCoverageIf(v, conditional) // Mark previous if conditional true
  14042. **
  14043. ** VdbeCoverageAlwaysTaken(v) // Previous branch is always taken
  14044. **
  14045. ** VdbeCoverageNeverTaken(v) // Previous branch is never taken
  14046. **
  14047. ** Every VDBE branch operation must be tagged with one of the macros above.
  14048. ** If not, then when "make test" is run with -DSQLITE_VDBE_COVERAGE and
  14049. ** -DSQLITE_DEBUG then an ALWAYS() will fail in the vdbeTakeBranch()
  14050. ** routine in vdbe.c, alerting the developer to the missed tag.
  14051. */
  14052. #ifdef SQLITE_VDBE_COVERAGE
  14053. SQLITE_PRIVATE void sqlite3VdbeSetLineNumber(Vdbe*,int);
  14054. # define VdbeCoverage(v) sqlite3VdbeSetLineNumber(v,__LINE__)
  14055. # define VdbeCoverageIf(v,x) if(x)sqlite3VdbeSetLineNumber(v,__LINE__)
  14056. # define VdbeCoverageAlwaysTaken(v) sqlite3VdbeSetLineNumber(v,2);
  14057. # define VdbeCoverageNeverTaken(v) sqlite3VdbeSetLineNumber(v,1);
  14058. # define VDBE_OFFSET_LINENO(x) (__LINE__+x)
  14059. #else
  14060. # define VdbeCoverage(v)
  14061. # define VdbeCoverageIf(v,x)
  14062. # define VdbeCoverageAlwaysTaken(v)
  14063. # define VdbeCoverageNeverTaken(v)
  14064. # define VDBE_OFFSET_LINENO(x) 0
  14065. #endif
  14066. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  14067. SQLITE_PRIVATE void sqlite3VdbeScanStatus(Vdbe*, int, int, int, LogEst, const char*);
  14068. #else
  14069. # define sqlite3VdbeScanStatus(a,b,c,d,e)
  14070. #endif
  14071. #endif /* SQLITE_VDBE_H */
  14072. /************** End of vdbe.h ************************************************/
  14073. /************** Continuing where we left off in sqliteInt.h ******************/
  14074. /************** Include pager.h in the middle of sqliteInt.h *****************/
  14075. /************** Begin file pager.h *******************************************/
  14076. /*
  14077. ** 2001 September 15
  14078. **
  14079. ** The author disclaims copyright to this source code. In place of
  14080. ** a legal notice, here is a blessing:
  14081. **
  14082. ** May you do good and not evil.
  14083. ** May you find forgiveness for yourself and forgive others.
  14084. ** May you share freely, never taking more than you give.
  14085. **
  14086. *************************************************************************
  14087. ** This header file defines the interface that the sqlite page cache
  14088. ** subsystem. The page cache subsystem reads and writes a file a page
  14089. ** at a time and provides a journal for rollback.
  14090. */
  14091. #ifndef SQLITE_PAGER_H
  14092. #define SQLITE_PAGER_H
  14093. /*
  14094. ** Default maximum size for persistent journal files. A negative
  14095. ** value means no limit. This value may be overridden using the
  14096. ** sqlite3PagerJournalSizeLimit() API. See also "PRAGMA journal_size_limit".
  14097. */
  14098. #ifndef SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT
  14099. #define SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT -1
  14100. #endif
  14101. /*
  14102. ** The type used to represent a page number. The first page in a file
  14103. ** is called page 1. 0 is used to represent "not a page".
  14104. */
  14105. typedef u32 Pgno;
  14106. /*
  14107. ** Each open file is managed by a separate instance of the "Pager" structure.
  14108. */
  14109. typedef struct Pager Pager;
  14110. /*
  14111. ** Handle type for pages.
  14112. */
  14113. typedef struct PgHdr DbPage;
  14114. /*
  14115. ** Page number PAGER_MJ_PGNO is never used in an SQLite database (it is
  14116. ** reserved for working around a windows/posix incompatibility). It is
  14117. ** used in the journal to signify that the remainder of the journal file
  14118. ** is devoted to storing a master journal name - there are no more pages to
  14119. ** roll back. See comments for function writeMasterJournal() in pager.c
  14120. ** for details.
  14121. */
  14122. #define PAGER_MJ_PGNO(x) ((Pgno)((PENDING_BYTE/((x)->pageSize))+1))
  14123. /*
  14124. ** Allowed values for the flags parameter to sqlite3PagerOpen().
  14125. **
  14126. ** NOTE: These values must match the corresponding BTREE_ values in btree.h.
  14127. */
  14128. #define PAGER_OMIT_JOURNAL 0x0001 /* Do not use a rollback journal */
  14129. #define PAGER_MEMORY 0x0002 /* In-memory database */
  14130. /*
  14131. ** Valid values for the second argument to sqlite3PagerLockingMode().
  14132. */
  14133. #define PAGER_LOCKINGMODE_QUERY -1
  14134. #define PAGER_LOCKINGMODE_NORMAL 0
  14135. #define PAGER_LOCKINGMODE_EXCLUSIVE 1
  14136. /*
  14137. ** Numeric constants that encode the journalmode.
  14138. **
  14139. ** The numeric values encoded here (other than PAGER_JOURNALMODE_QUERY)
  14140. ** are exposed in the API via the "PRAGMA journal_mode" command and
  14141. ** therefore cannot be changed without a compatibility break.
  14142. */
  14143. #define PAGER_JOURNALMODE_QUERY (-1) /* Query the value of journalmode */
  14144. #define PAGER_JOURNALMODE_DELETE 0 /* Commit by deleting journal file */
  14145. #define PAGER_JOURNALMODE_PERSIST 1 /* Commit by zeroing journal header */
  14146. #define PAGER_JOURNALMODE_OFF 2 /* Journal omitted. */
  14147. #define PAGER_JOURNALMODE_TRUNCATE 3 /* Commit by truncating journal */
  14148. #define PAGER_JOURNALMODE_MEMORY 4 /* In-memory journal file */
  14149. #define PAGER_JOURNALMODE_WAL 5 /* Use write-ahead logging */
  14150. /*
  14151. ** Flags that make up the mask passed to sqlite3PagerGet().
  14152. */
  14153. #define PAGER_GET_NOCONTENT 0x01 /* Do not load data from disk */
  14154. #define PAGER_GET_READONLY 0x02 /* Read-only page is acceptable */
  14155. /*
  14156. ** Flags for sqlite3PagerSetFlags()
  14157. **
  14158. ** Value constraints (enforced via assert()):
  14159. ** PAGER_FULLFSYNC == SQLITE_FullFSync
  14160. ** PAGER_CKPT_FULLFSYNC == SQLITE_CkptFullFSync
  14161. ** PAGER_CACHE_SPILL == SQLITE_CacheSpill
  14162. */
  14163. #define PAGER_SYNCHRONOUS_OFF 0x01 /* PRAGMA synchronous=OFF */
  14164. #define PAGER_SYNCHRONOUS_NORMAL 0x02 /* PRAGMA synchronous=NORMAL */
  14165. #define PAGER_SYNCHRONOUS_FULL 0x03 /* PRAGMA synchronous=FULL */
  14166. #define PAGER_SYNCHRONOUS_EXTRA 0x04 /* PRAGMA synchronous=EXTRA */
  14167. #define PAGER_SYNCHRONOUS_MASK 0x07 /* Mask for four values above */
  14168. #define PAGER_FULLFSYNC 0x08 /* PRAGMA fullfsync=ON */
  14169. #define PAGER_CKPT_FULLFSYNC 0x10 /* PRAGMA checkpoint_fullfsync=ON */
  14170. #define PAGER_CACHESPILL 0x20 /* PRAGMA cache_spill=ON */
  14171. #define PAGER_FLAGS_MASK 0x38 /* All above except SYNCHRONOUS */
  14172. /*
  14173. ** The remainder of this file contains the declarations of the functions
  14174. ** that make up the Pager sub-system API. See source code comments for
  14175. ** a detailed description of each routine.
  14176. */
  14177. /* Open and close a Pager connection. */
  14178. SQLITE_PRIVATE int sqlite3PagerOpen(
  14179. sqlite3_vfs*,
  14180. Pager **ppPager,
  14181. const char*,
  14182. int,
  14183. int,
  14184. int,
  14185. void(*)(DbPage*)
  14186. );
  14187. SQLITE_PRIVATE int sqlite3PagerClose(Pager *pPager, sqlite3*);
  14188. SQLITE_PRIVATE int sqlite3PagerReadFileheader(Pager*, int, unsigned char*);
  14189. /* Functions used to configure a Pager object. */
  14190. SQLITE_PRIVATE void sqlite3PagerSetBusyHandler(Pager*, int(*)(void *), void *);
  14191. SQLITE_PRIVATE int sqlite3PagerSetPagesize(Pager*, u32*, int);
  14192. #ifdef SQLITE_HAS_CODEC
  14193. SQLITE_PRIVATE void sqlite3PagerAlignReserve(Pager*,Pager*);
  14194. #endif
  14195. SQLITE_PRIVATE int sqlite3PagerMaxPageCount(Pager*, int);
  14196. SQLITE_PRIVATE void sqlite3PagerSetCachesize(Pager*, int);
  14197. SQLITE_PRIVATE int sqlite3PagerSetSpillsize(Pager*, int);
  14198. SQLITE_PRIVATE void sqlite3PagerSetMmapLimit(Pager *, sqlite3_int64);
  14199. SQLITE_PRIVATE void sqlite3PagerShrink(Pager*);
  14200. SQLITE_PRIVATE void sqlite3PagerSetFlags(Pager*,unsigned);
  14201. SQLITE_PRIVATE int sqlite3PagerLockingMode(Pager *, int);
  14202. SQLITE_PRIVATE int sqlite3PagerSetJournalMode(Pager *, int);
  14203. SQLITE_PRIVATE int sqlite3PagerGetJournalMode(Pager*);
  14204. SQLITE_PRIVATE int sqlite3PagerOkToChangeJournalMode(Pager*);
  14205. SQLITE_PRIVATE i64 sqlite3PagerJournalSizeLimit(Pager *, i64);
  14206. SQLITE_PRIVATE sqlite3_backup **sqlite3PagerBackupPtr(Pager*);
  14207. SQLITE_PRIVATE int sqlite3PagerFlush(Pager*);
  14208. /* Functions used to obtain and release page references. */
  14209. SQLITE_PRIVATE int sqlite3PagerGet(Pager *pPager, Pgno pgno, DbPage **ppPage, int clrFlag);
  14210. SQLITE_PRIVATE DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno);
  14211. SQLITE_PRIVATE void sqlite3PagerRef(DbPage*);
  14212. SQLITE_PRIVATE void sqlite3PagerUnref(DbPage*);
  14213. SQLITE_PRIVATE void sqlite3PagerUnrefNotNull(DbPage*);
  14214. SQLITE_PRIVATE void sqlite3PagerUnrefPageOne(DbPage*);
  14215. /* Operations on page references. */
  14216. SQLITE_PRIVATE int sqlite3PagerWrite(DbPage*);
  14217. SQLITE_PRIVATE void sqlite3PagerDontWrite(DbPage*);
  14218. SQLITE_PRIVATE int sqlite3PagerMovepage(Pager*,DbPage*,Pgno,int);
  14219. SQLITE_PRIVATE int sqlite3PagerPageRefcount(DbPage*);
  14220. SQLITE_PRIVATE void *sqlite3PagerGetData(DbPage *);
  14221. SQLITE_PRIVATE void *sqlite3PagerGetExtra(DbPage *);
  14222. /* Functions used to manage pager transactions and savepoints. */
  14223. SQLITE_PRIVATE void sqlite3PagerPagecount(Pager*, int*);
  14224. SQLITE_PRIVATE int sqlite3PagerBegin(Pager*, int exFlag, int);
  14225. SQLITE_PRIVATE int sqlite3PagerCommitPhaseOne(Pager*,const char *zMaster, int);
  14226. SQLITE_PRIVATE int sqlite3PagerExclusiveLock(Pager*);
  14227. SQLITE_PRIVATE int sqlite3PagerSync(Pager *pPager, const char *zMaster);
  14228. SQLITE_PRIVATE int sqlite3PagerCommitPhaseTwo(Pager*);
  14229. SQLITE_PRIVATE int sqlite3PagerRollback(Pager*);
  14230. SQLITE_PRIVATE int sqlite3PagerOpenSavepoint(Pager *pPager, int n);
  14231. SQLITE_PRIVATE int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint);
  14232. SQLITE_PRIVATE int sqlite3PagerSharedLock(Pager *pPager);
  14233. #ifndef SQLITE_OMIT_WAL
  14234. SQLITE_PRIVATE int sqlite3PagerCheckpoint(Pager *pPager, sqlite3*, int, int*, int*);
  14235. SQLITE_PRIVATE int sqlite3PagerWalSupported(Pager *pPager);
  14236. SQLITE_PRIVATE int sqlite3PagerWalCallback(Pager *pPager);
  14237. SQLITE_PRIVATE int sqlite3PagerOpenWal(Pager *pPager, int *pisOpen);
  14238. SQLITE_PRIVATE int sqlite3PagerCloseWal(Pager *pPager, sqlite3*);
  14239. # ifdef SQLITE_DIRECT_OVERFLOW_READ
  14240. SQLITE_PRIVATE int sqlite3PagerUseWal(Pager *pPager, Pgno);
  14241. # endif
  14242. # ifdef SQLITE_ENABLE_SNAPSHOT
  14243. SQLITE_PRIVATE int sqlite3PagerSnapshotGet(Pager *pPager, sqlite3_snapshot **ppSnapshot);
  14244. SQLITE_PRIVATE int sqlite3PagerSnapshotOpen(Pager *pPager, sqlite3_snapshot *pSnapshot);
  14245. SQLITE_PRIVATE int sqlite3PagerSnapshotRecover(Pager *pPager);
  14246. # endif
  14247. #else
  14248. # define sqlite3PagerUseWal(x,y) 0
  14249. #endif
  14250. #ifdef SQLITE_ENABLE_ZIPVFS
  14251. SQLITE_PRIVATE int sqlite3PagerWalFramesize(Pager *pPager);
  14252. #endif
  14253. /* Functions used to query pager state and configuration. */
  14254. SQLITE_PRIVATE u8 sqlite3PagerIsreadonly(Pager*);
  14255. SQLITE_PRIVATE u32 sqlite3PagerDataVersion(Pager*);
  14256. #ifdef SQLITE_DEBUG
  14257. SQLITE_PRIVATE int sqlite3PagerRefcount(Pager*);
  14258. #endif
  14259. SQLITE_PRIVATE int sqlite3PagerMemUsed(Pager*);
  14260. SQLITE_PRIVATE const char *sqlite3PagerFilename(Pager*, int);
  14261. SQLITE_PRIVATE sqlite3_vfs *sqlite3PagerVfs(Pager*);
  14262. SQLITE_PRIVATE sqlite3_file *sqlite3PagerFile(Pager*);
  14263. SQLITE_PRIVATE sqlite3_file *sqlite3PagerJrnlFile(Pager*);
  14264. SQLITE_PRIVATE const char *sqlite3PagerJournalname(Pager*);
  14265. SQLITE_PRIVATE void *sqlite3PagerTempSpace(Pager*);
  14266. SQLITE_PRIVATE int sqlite3PagerIsMemdb(Pager*);
  14267. SQLITE_PRIVATE void sqlite3PagerCacheStat(Pager *, int, int, int *);
  14268. SQLITE_PRIVATE void sqlite3PagerClearCache(Pager*);
  14269. SQLITE_PRIVATE int sqlite3SectorSize(sqlite3_file *);
  14270. #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
  14271. SQLITE_PRIVATE void sqlite3PagerResetLockTimeout(Pager *pPager);
  14272. #else
  14273. # define sqlite3PagerResetLockTimeout(X)
  14274. #endif
  14275. /* Functions used to truncate the database file. */
  14276. SQLITE_PRIVATE void sqlite3PagerTruncateImage(Pager*,Pgno);
  14277. SQLITE_PRIVATE void sqlite3PagerRekey(DbPage*, Pgno, u16);
  14278. #if defined(SQLITE_HAS_CODEC) && !defined(SQLITE_OMIT_WAL)
  14279. SQLITE_PRIVATE void *sqlite3PagerCodec(DbPage *);
  14280. #endif
  14281. /* Functions to support testing and debugging. */
  14282. #if !defined(NDEBUG) || defined(SQLITE_TEST)
  14283. SQLITE_PRIVATE Pgno sqlite3PagerPagenumber(DbPage*);
  14284. SQLITE_PRIVATE int sqlite3PagerIswriteable(DbPage*);
  14285. #endif
  14286. #ifdef SQLITE_TEST
  14287. SQLITE_PRIVATE int *sqlite3PagerStats(Pager*);
  14288. SQLITE_PRIVATE void sqlite3PagerRefdump(Pager*);
  14289. void disable_simulated_io_errors(void);
  14290. void enable_simulated_io_errors(void);
  14291. #else
  14292. # define disable_simulated_io_errors()
  14293. # define enable_simulated_io_errors()
  14294. #endif
  14295. #endif /* SQLITE_PAGER_H */
  14296. /************** End of pager.h ***********************************************/
  14297. /************** Continuing where we left off in sqliteInt.h ******************/
  14298. /************** Include pcache.h in the middle of sqliteInt.h ****************/
  14299. /************** Begin file pcache.h ******************************************/
  14300. /*
  14301. ** 2008 August 05
  14302. **
  14303. ** The author disclaims copyright to this source code. In place of
  14304. ** a legal notice, here is a blessing:
  14305. **
  14306. ** May you do good and not evil.
  14307. ** May you find forgiveness for yourself and forgive others.
  14308. ** May you share freely, never taking more than you give.
  14309. **
  14310. *************************************************************************
  14311. ** This header file defines the interface that the sqlite page cache
  14312. ** subsystem.
  14313. */
  14314. #ifndef _PCACHE_H_
  14315. typedef struct PgHdr PgHdr;
  14316. typedef struct PCache PCache;
  14317. /*
  14318. ** Every page in the cache is controlled by an instance of the following
  14319. ** structure.
  14320. */
  14321. struct PgHdr {
  14322. sqlite3_pcache_page *pPage; /* Pcache object page handle */
  14323. void *pData; /* Page data */
  14324. void *pExtra; /* Extra content */
  14325. PCache *pCache; /* PRIVATE: Cache that owns this page */
  14326. PgHdr *pDirty; /* Transient list of dirty sorted by pgno */
  14327. Pager *pPager; /* The pager this page is part of */
  14328. Pgno pgno; /* Page number for this page */
  14329. #ifdef SQLITE_CHECK_PAGES
  14330. u32 pageHash; /* Hash of page content */
  14331. #endif
  14332. u16 flags; /* PGHDR flags defined below */
  14333. /**********************************************************************
  14334. ** Elements above, except pCache, are public. All that follow are
  14335. ** private to pcache.c and should not be accessed by other modules.
  14336. ** pCache is grouped with the public elements for efficiency.
  14337. */
  14338. i16 nRef; /* Number of users of this page */
  14339. PgHdr *pDirtyNext; /* Next element in list of dirty pages */
  14340. PgHdr *pDirtyPrev; /* Previous element in list of dirty pages */
  14341. /* NB: pDirtyNext and pDirtyPrev are undefined if the
  14342. ** PgHdr object is not dirty */
  14343. };
  14344. /* Bit values for PgHdr.flags */
  14345. #define PGHDR_CLEAN 0x001 /* Page not on the PCache.pDirty list */
  14346. #define PGHDR_DIRTY 0x002 /* Page is on the PCache.pDirty list */
  14347. #define PGHDR_WRITEABLE 0x004 /* Journaled and ready to modify */
  14348. #define PGHDR_NEED_SYNC 0x008 /* Fsync the rollback journal before
  14349. ** writing this page to the database */
  14350. #define PGHDR_DONT_WRITE 0x010 /* Do not write content to disk */
  14351. #define PGHDR_MMAP 0x020 /* This is an mmap page object */
  14352. #define PGHDR_WAL_APPEND 0x040 /* Appended to wal file */
  14353. /* Initialize and shutdown the page cache subsystem */
  14354. SQLITE_PRIVATE int sqlite3PcacheInitialize(void);
  14355. SQLITE_PRIVATE void sqlite3PcacheShutdown(void);
  14356. /* Page cache buffer management:
  14357. ** These routines implement SQLITE_CONFIG_PAGECACHE.
  14358. */
  14359. SQLITE_PRIVATE void sqlite3PCacheBufferSetup(void *, int sz, int n);
  14360. /* Create a new pager cache.
  14361. ** Under memory stress, invoke xStress to try to make pages clean.
  14362. ** Only clean and unpinned pages can be reclaimed.
  14363. */
  14364. SQLITE_PRIVATE int sqlite3PcacheOpen(
  14365. int szPage, /* Size of every page */
  14366. int szExtra, /* Extra space associated with each page */
  14367. int bPurgeable, /* True if pages are on backing store */
  14368. int (*xStress)(void*, PgHdr*), /* Call to try to make pages clean */
  14369. void *pStress, /* Argument to xStress */
  14370. PCache *pToInit /* Preallocated space for the PCache */
  14371. );
  14372. /* Modify the page-size after the cache has been created. */
  14373. SQLITE_PRIVATE int sqlite3PcacheSetPageSize(PCache *, int);
  14374. /* Return the size in bytes of a PCache object. Used to preallocate
  14375. ** storage space.
  14376. */
  14377. SQLITE_PRIVATE int sqlite3PcacheSize(void);
  14378. /* One release per successful fetch. Page is pinned until released.
  14379. ** Reference counted.
  14380. */
  14381. SQLITE_PRIVATE sqlite3_pcache_page *sqlite3PcacheFetch(PCache*, Pgno, int createFlag);
  14382. SQLITE_PRIVATE int sqlite3PcacheFetchStress(PCache*, Pgno, sqlite3_pcache_page**);
  14383. SQLITE_PRIVATE PgHdr *sqlite3PcacheFetchFinish(PCache*, Pgno, sqlite3_pcache_page *pPage);
  14384. SQLITE_PRIVATE void sqlite3PcacheRelease(PgHdr*);
  14385. SQLITE_PRIVATE void sqlite3PcacheDrop(PgHdr*); /* Remove page from cache */
  14386. SQLITE_PRIVATE void sqlite3PcacheMakeDirty(PgHdr*); /* Make sure page is marked dirty */
  14387. SQLITE_PRIVATE void sqlite3PcacheMakeClean(PgHdr*); /* Mark a single page as clean */
  14388. SQLITE_PRIVATE void sqlite3PcacheCleanAll(PCache*); /* Mark all dirty list pages as clean */
  14389. SQLITE_PRIVATE void sqlite3PcacheClearWritable(PCache*);
  14390. /* Change a page number. Used by incr-vacuum. */
  14391. SQLITE_PRIVATE void sqlite3PcacheMove(PgHdr*, Pgno);
  14392. /* Remove all pages with pgno>x. Reset the cache if x==0 */
  14393. SQLITE_PRIVATE void sqlite3PcacheTruncate(PCache*, Pgno x);
  14394. /* Get a list of all dirty pages in the cache, sorted by page number */
  14395. SQLITE_PRIVATE PgHdr *sqlite3PcacheDirtyList(PCache*);
  14396. /* Reset and close the cache object */
  14397. SQLITE_PRIVATE void sqlite3PcacheClose(PCache*);
  14398. /* Clear flags from pages of the page cache */
  14399. SQLITE_PRIVATE void sqlite3PcacheClearSyncFlags(PCache *);
  14400. /* Discard the contents of the cache */
  14401. SQLITE_PRIVATE void sqlite3PcacheClear(PCache*);
  14402. /* Return the total number of outstanding page references */
  14403. SQLITE_PRIVATE int sqlite3PcacheRefCount(PCache*);
  14404. /* Increment the reference count of an existing page */
  14405. SQLITE_PRIVATE void sqlite3PcacheRef(PgHdr*);
  14406. SQLITE_PRIVATE int sqlite3PcachePageRefcount(PgHdr*);
  14407. /* Return the total number of pages stored in the cache */
  14408. SQLITE_PRIVATE int sqlite3PcachePagecount(PCache*);
  14409. #if defined(SQLITE_CHECK_PAGES) || defined(SQLITE_DEBUG)
  14410. /* Iterate through all dirty pages currently stored in the cache. This
  14411. ** interface is only available if SQLITE_CHECK_PAGES is defined when the
  14412. ** library is built.
  14413. */
  14414. SQLITE_PRIVATE void sqlite3PcacheIterateDirty(PCache *pCache, void (*xIter)(PgHdr *));
  14415. #endif
  14416. #if defined(SQLITE_DEBUG)
  14417. /* Check invariants on a PgHdr object */
  14418. SQLITE_PRIVATE int sqlite3PcachePageSanity(PgHdr*);
  14419. #endif
  14420. /* Set and get the suggested cache-size for the specified pager-cache.
  14421. **
  14422. ** If no global maximum is configured, then the system attempts to limit
  14423. ** the total number of pages cached by purgeable pager-caches to the sum
  14424. ** of the suggested cache-sizes.
  14425. */
  14426. SQLITE_PRIVATE void sqlite3PcacheSetCachesize(PCache *, int);
  14427. #ifdef SQLITE_TEST
  14428. SQLITE_PRIVATE int sqlite3PcacheGetCachesize(PCache *);
  14429. #endif
  14430. /* Set or get the suggested spill-size for the specified pager-cache.
  14431. **
  14432. ** The spill-size is the minimum number of pages in cache before the cache
  14433. ** will attempt to spill dirty pages by calling xStress.
  14434. */
  14435. SQLITE_PRIVATE int sqlite3PcacheSetSpillsize(PCache *, int);
  14436. /* Free up as much memory as possible from the page cache */
  14437. SQLITE_PRIVATE void sqlite3PcacheShrink(PCache*);
  14438. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  14439. /* Try to return memory used by the pcache module to the main memory heap */
  14440. SQLITE_PRIVATE int sqlite3PcacheReleaseMemory(int);
  14441. #endif
  14442. #ifdef SQLITE_TEST
  14443. SQLITE_PRIVATE void sqlite3PcacheStats(int*,int*,int*,int*);
  14444. #endif
  14445. SQLITE_PRIVATE void sqlite3PCacheSetDefault(void);
  14446. /* Return the header size */
  14447. SQLITE_PRIVATE int sqlite3HeaderSizePcache(void);
  14448. SQLITE_PRIVATE int sqlite3HeaderSizePcache1(void);
  14449. /* Number of dirty pages as a percentage of the configured cache size */
  14450. SQLITE_PRIVATE int sqlite3PCachePercentDirty(PCache*);
  14451. #endif /* _PCACHE_H_ */
  14452. /************** End of pcache.h **********************************************/
  14453. /************** Continuing where we left off in sqliteInt.h ******************/
  14454. /************** Include os.h in the middle of sqliteInt.h ********************/
  14455. /************** Begin file os.h **********************************************/
  14456. /*
  14457. ** 2001 September 16
  14458. **
  14459. ** The author disclaims copyright to this source code. In place of
  14460. ** a legal notice, here is a blessing:
  14461. **
  14462. ** May you do good and not evil.
  14463. ** May you find forgiveness for yourself and forgive others.
  14464. ** May you share freely, never taking more than you give.
  14465. **
  14466. ******************************************************************************
  14467. **
  14468. ** This header file (together with is companion C source-code file
  14469. ** "os.c") attempt to abstract the underlying operating system so that
  14470. ** the SQLite library will work on both POSIX and windows systems.
  14471. **
  14472. ** This header file is #include-ed by sqliteInt.h and thus ends up
  14473. ** being included by every source file.
  14474. */
  14475. #ifndef _SQLITE_OS_H_
  14476. #define _SQLITE_OS_H_
  14477. /*
  14478. ** Attempt to automatically detect the operating system and setup the
  14479. ** necessary pre-processor macros for it.
  14480. */
  14481. /************** Include os_setup.h in the middle of os.h *********************/
  14482. /************** Begin file os_setup.h ****************************************/
  14483. /*
  14484. ** 2013 November 25
  14485. **
  14486. ** The author disclaims copyright to this source code. In place of
  14487. ** a legal notice, here is a blessing:
  14488. **
  14489. ** May you do good and not evil.
  14490. ** May you find forgiveness for yourself and forgive others.
  14491. ** May you share freely, never taking more than you give.
  14492. **
  14493. ******************************************************************************
  14494. **
  14495. ** This file contains pre-processor directives related to operating system
  14496. ** detection and/or setup.
  14497. */
  14498. #ifndef SQLITE_OS_SETUP_H
  14499. #define SQLITE_OS_SETUP_H
  14500. /*
  14501. ** Figure out if we are dealing with Unix, Windows, or some other operating
  14502. ** system.
  14503. **
  14504. ** After the following block of preprocess macros, all of SQLITE_OS_UNIX,
  14505. ** SQLITE_OS_WIN, and SQLITE_OS_OTHER will defined to either 1 or 0. One of
  14506. ** the three will be 1. The other two will be 0.
  14507. */
  14508. #if defined(SQLITE_OS_OTHER)
  14509. # if SQLITE_OS_OTHER==1
  14510. # undef SQLITE_OS_UNIX
  14511. # define SQLITE_OS_UNIX 0
  14512. # undef SQLITE_OS_WIN
  14513. # define SQLITE_OS_WIN 0
  14514. # else
  14515. # undef SQLITE_OS_OTHER
  14516. # endif
  14517. #endif
  14518. #if !defined(SQLITE_OS_UNIX) && !defined(SQLITE_OS_OTHER)
  14519. # define SQLITE_OS_OTHER 0
  14520. # ifndef SQLITE_OS_WIN
  14521. # if defined(_WIN32) || defined(WIN32) || defined(__CYGWIN__) || \
  14522. defined(__MINGW32__) || defined(__BORLANDC__)
  14523. # define SQLITE_OS_WIN 1
  14524. # define SQLITE_OS_UNIX 0
  14525. # else
  14526. # define SQLITE_OS_WIN 0
  14527. # define SQLITE_OS_UNIX 1
  14528. # endif
  14529. # else
  14530. # define SQLITE_OS_UNIX 0
  14531. # endif
  14532. #else
  14533. # ifndef SQLITE_OS_WIN
  14534. # define SQLITE_OS_WIN 0
  14535. # endif
  14536. #endif
  14537. #endif /* SQLITE_OS_SETUP_H */
  14538. /************** End of os_setup.h ********************************************/
  14539. /************** Continuing where we left off in os.h *************************/
  14540. /* If the SET_FULLSYNC macro is not defined above, then make it
  14541. ** a no-op
  14542. */
  14543. #ifndef SET_FULLSYNC
  14544. # define SET_FULLSYNC(x,y)
  14545. #endif
  14546. /*
  14547. ** The default size of a disk sector
  14548. */
  14549. #ifndef SQLITE_DEFAULT_SECTOR_SIZE
  14550. # define SQLITE_DEFAULT_SECTOR_SIZE 4096
  14551. #endif
  14552. /*
  14553. ** Temporary files are named starting with this prefix followed by 16 random
  14554. ** alphanumeric characters, and no file extension. They are stored in the
  14555. ** OS's standard temporary file directory, and are deleted prior to exit.
  14556. ** If sqlite is being embedded in another program, you may wish to change the
  14557. ** prefix to reflect your program's name, so that if your program exits
  14558. ** prematurely, old temporary files can be easily identified. This can be done
  14559. ** using -DSQLITE_TEMP_FILE_PREFIX=myprefix_ on the compiler command line.
  14560. **
  14561. ** 2006-10-31: The default prefix used to be "sqlite_". But then
  14562. ** Mcafee started using SQLite in their anti-virus product and it
  14563. ** started putting files with the "sqlite" name in the c:/temp folder.
  14564. ** This annoyed many windows users. Those users would then do a
  14565. ** Google search for "sqlite", find the telephone numbers of the
  14566. ** developers and call to wake them up at night and complain.
  14567. ** For this reason, the default name prefix is changed to be "sqlite"
  14568. ** spelled backwards. So the temp files are still identified, but
  14569. ** anybody smart enough to figure out the code is also likely smart
  14570. ** enough to know that calling the developer will not help get rid
  14571. ** of the file.
  14572. */
  14573. #ifndef SQLITE_TEMP_FILE_PREFIX
  14574. # define SQLITE_TEMP_FILE_PREFIX "etilqs_"
  14575. #endif
  14576. /*
  14577. ** The following values may be passed as the second argument to
  14578. ** sqlite3OsLock(). The various locks exhibit the following semantics:
  14579. **
  14580. ** SHARED: Any number of processes may hold a SHARED lock simultaneously.
  14581. ** RESERVED: A single process may hold a RESERVED lock on a file at
  14582. ** any time. Other processes may hold and obtain new SHARED locks.
  14583. ** PENDING: A single process may hold a PENDING lock on a file at
  14584. ** any one time. Existing SHARED locks may persist, but no new
  14585. ** SHARED locks may be obtained by other processes.
  14586. ** EXCLUSIVE: An EXCLUSIVE lock precludes all other locks.
  14587. **
  14588. ** PENDING_LOCK may not be passed directly to sqlite3OsLock(). Instead, a
  14589. ** process that requests an EXCLUSIVE lock may actually obtain a PENDING
  14590. ** lock. This can be upgraded to an EXCLUSIVE lock by a subsequent call to
  14591. ** sqlite3OsLock().
  14592. */
  14593. #define NO_LOCK 0
  14594. #define SHARED_LOCK 1
  14595. #define RESERVED_LOCK 2
  14596. #define PENDING_LOCK 3
  14597. #define EXCLUSIVE_LOCK 4
  14598. /*
  14599. ** File Locking Notes: (Mostly about windows but also some info for Unix)
  14600. **
  14601. ** We cannot use LockFileEx() or UnlockFileEx() on Win95/98/ME because
  14602. ** those functions are not available. So we use only LockFile() and
  14603. ** UnlockFile().
  14604. **
  14605. ** LockFile() prevents not just writing but also reading by other processes.
  14606. ** A SHARED_LOCK is obtained by locking a single randomly-chosen
  14607. ** byte out of a specific range of bytes. The lock byte is obtained at
  14608. ** random so two separate readers can probably access the file at the
  14609. ** same time, unless they are unlucky and choose the same lock byte.
  14610. ** An EXCLUSIVE_LOCK is obtained by locking all bytes in the range.
  14611. ** There can only be one writer. A RESERVED_LOCK is obtained by locking
  14612. ** a single byte of the file that is designated as the reserved lock byte.
  14613. ** A PENDING_LOCK is obtained by locking a designated byte different from
  14614. ** the RESERVED_LOCK byte.
  14615. **
  14616. ** On WinNT/2K/XP systems, LockFileEx() and UnlockFileEx() are available,
  14617. ** which means we can use reader/writer locks. When reader/writer locks
  14618. ** are used, the lock is placed on the same range of bytes that is used
  14619. ** for probabilistic locking in Win95/98/ME. Hence, the locking scheme
  14620. ** will support two or more Win95 readers or two or more WinNT readers.
  14621. ** But a single Win95 reader will lock out all WinNT readers and a single
  14622. ** WinNT reader will lock out all other Win95 readers.
  14623. **
  14624. ** The following #defines specify the range of bytes used for locking.
  14625. ** SHARED_SIZE is the number of bytes available in the pool from which
  14626. ** a random byte is selected for a shared lock. The pool of bytes for
  14627. ** shared locks begins at SHARED_FIRST.
  14628. **
  14629. ** The same locking strategy and
  14630. ** byte ranges are used for Unix. This leaves open the possibility of having
  14631. ** clients on win95, winNT, and unix all talking to the same shared file
  14632. ** and all locking correctly. To do so would require that samba (or whatever
  14633. ** tool is being used for file sharing) implements locks correctly between
  14634. ** windows and unix. I'm guessing that isn't likely to happen, but by
  14635. ** using the same locking range we are at least open to the possibility.
  14636. **
  14637. ** Locking in windows is manditory. For this reason, we cannot store
  14638. ** actual data in the bytes used for locking. The pager never allocates
  14639. ** the pages involved in locking therefore. SHARED_SIZE is selected so
  14640. ** that all locks will fit on a single page even at the minimum page size.
  14641. ** PENDING_BYTE defines the beginning of the locks. By default PENDING_BYTE
  14642. ** is set high so that we don't have to allocate an unused page except
  14643. ** for very large databases. But one should test the page skipping logic
  14644. ** by setting PENDING_BYTE low and running the entire regression suite.
  14645. **
  14646. ** Changing the value of PENDING_BYTE results in a subtly incompatible
  14647. ** file format. Depending on how it is changed, you might not notice
  14648. ** the incompatibility right away, even running a full regression test.
  14649. ** The default location of PENDING_BYTE is the first byte past the
  14650. ** 1GB boundary.
  14651. **
  14652. */
  14653. #ifdef SQLITE_OMIT_WSD
  14654. # define PENDING_BYTE (0x40000000)
  14655. #else
  14656. # define PENDING_BYTE sqlite3PendingByte
  14657. #endif
  14658. #define RESERVED_BYTE (PENDING_BYTE+1)
  14659. #define SHARED_FIRST (PENDING_BYTE+2)
  14660. #define SHARED_SIZE 510
  14661. /*
  14662. ** Wrapper around OS specific sqlite3_os_init() function.
  14663. */
  14664. SQLITE_PRIVATE int sqlite3OsInit(void);
  14665. /*
  14666. ** Functions for accessing sqlite3_file methods
  14667. */
  14668. SQLITE_PRIVATE void sqlite3OsClose(sqlite3_file*);
  14669. SQLITE_PRIVATE int sqlite3OsRead(sqlite3_file*, void*, int amt, i64 offset);
  14670. SQLITE_PRIVATE int sqlite3OsWrite(sqlite3_file*, const void*, int amt, i64 offset);
  14671. SQLITE_PRIVATE int sqlite3OsTruncate(sqlite3_file*, i64 size);
  14672. SQLITE_PRIVATE int sqlite3OsSync(sqlite3_file*, int);
  14673. SQLITE_PRIVATE int sqlite3OsFileSize(sqlite3_file*, i64 *pSize);
  14674. SQLITE_PRIVATE int sqlite3OsLock(sqlite3_file*, int);
  14675. SQLITE_PRIVATE int sqlite3OsUnlock(sqlite3_file*, int);
  14676. SQLITE_PRIVATE int sqlite3OsCheckReservedLock(sqlite3_file *id, int *pResOut);
  14677. SQLITE_PRIVATE int sqlite3OsFileControl(sqlite3_file*,int,void*);
  14678. SQLITE_PRIVATE void sqlite3OsFileControlHint(sqlite3_file*,int,void*);
  14679. #define SQLITE_FCNTL_DB_UNCHANGED 0xca093fa0
  14680. SQLITE_PRIVATE int sqlite3OsSectorSize(sqlite3_file *id);
  14681. SQLITE_PRIVATE int sqlite3OsDeviceCharacteristics(sqlite3_file *id);
  14682. #ifndef SQLITE_OMIT_WAL
  14683. SQLITE_PRIVATE int sqlite3OsShmMap(sqlite3_file *,int,int,int,void volatile **);
  14684. SQLITE_PRIVATE int sqlite3OsShmLock(sqlite3_file *id, int, int, int);
  14685. SQLITE_PRIVATE void sqlite3OsShmBarrier(sqlite3_file *id);
  14686. SQLITE_PRIVATE int sqlite3OsShmUnmap(sqlite3_file *id, int);
  14687. #endif /* SQLITE_OMIT_WAL */
  14688. SQLITE_PRIVATE int sqlite3OsFetch(sqlite3_file *id, i64, int, void **);
  14689. SQLITE_PRIVATE int sqlite3OsUnfetch(sqlite3_file *, i64, void *);
  14690. /*
  14691. ** Functions for accessing sqlite3_vfs methods
  14692. */
  14693. SQLITE_PRIVATE int sqlite3OsOpen(sqlite3_vfs *, const char *, sqlite3_file*, int, int *);
  14694. SQLITE_PRIVATE int sqlite3OsDelete(sqlite3_vfs *, const char *, int);
  14695. SQLITE_PRIVATE int sqlite3OsAccess(sqlite3_vfs *, const char *, int, int *pResOut);
  14696. SQLITE_PRIVATE int sqlite3OsFullPathname(sqlite3_vfs *, const char *, int, char *);
  14697. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  14698. SQLITE_PRIVATE void *sqlite3OsDlOpen(sqlite3_vfs *, const char *);
  14699. SQLITE_PRIVATE void sqlite3OsDlError(sqlite3_vfs *, int, char *);
  14700. SQLITE_PRIVATE void (*sqlite3OsDlSym(sqlite3_vfs *, void *, const char *))(void);
  14701. SQLITE_PRIVATE void sqlite3OsDlClose(sqlite3_vfs *, void *);
  14702. #endif /* SQLITE_OMIT_LOAD_EXTENSION */
  14703. SQLITE_PRIVATE int sqlite3OsRandomness(sqlite3_vfs *, int, char *);
  14704. SQLITE_PRIVATE int sqlite3OsSleep(sqlite3_vfs *, int);
  14705. SQLITE_PRIVATE int sqlite3OsGetLastError(sqlite3_vfs*);
  14706. SQLITE_PRIVATE int sqlite3OsCurrentTimeInt64(sqlite3_vfs *, sqlite3_int64*);
  14707. /*
  14708. ** Convenience functions for opening and closing files using
  14709. ** sqlite3_malloc() to obtain space for the file-handle structure.
  14710. */
  14711. SQLITE_PRIVATE int sqlite3OsOpenMalloc(sqlite3_vfs *, const char *, sqlite3_file **, int,int*);
  14712. SQLITE_PRIVATE void sqlite3OsCloseFree(sqlite3_file *);
  14713. #endif /* _SQLITE_OS_H_ */
  14714. /************** End of os.h **************************************************/
  14715. /************** Continuing where we left off in sqliteInt.h ******************/
  14716. /************** Include mutex.h in the middle of sqliteInt.h *****************/
  14717. /************** Begin file mutex.h *******************************************/
  14718. /*
  14719. ** 2007 August 28
  14720. **
  14721. ** The author disclaims copyright to this source code. In place of
  14722. ** a legal notice, here is a blessing:
  14723. **
  14724. ** May you do good and not evil.
  14725. ** May you find forgiveness for yourself and forgive others.
  14726. ** May you share freely, never taking more than you give.
  14727. **
  14728. *************************************************************************
  14729. **
  14730. ** This file contains the common header for all mutex implementations.
  14731. ** The sqliteInt.h header #includes this file so that it is available
  14732. ** to all source files. We break it out in an effort to keep the code
  14733. ** better organized.
  14734. **
  14735. ** NOTE: source files should *not* #include this header file directly.
  14736. ** Source files should #include the sqliteInt.h file and let that file
  14737. ** include this one indirectly.
  14738. */
  14739. /*
  14740. ** Figure out what version of the code to use. The choices are
  14741. **
  14742. ** SQLITE_MUTEX_OMIT No mutex logic. Not even stubs. The
  14743. ** mutexes implementation cannot be overridden
  14744. ** at start-time.
  14745. **
  14746. ** SQLITE_MUTEX_NOOP For single-threaded applications. No
  14747. ** mutual exclusion is provided. But this
  14748. ** implementation can be overridden at
  14749. ** start-time.
  14750. **
  14751. ** SQLITE_MUTEX_PTHREADS For multi-threaded applications on Unix.
  14752. **
  14753. ** SQLITE_MUTEX_W32 For multi-threaded applications on Win32.
  14754. */
  14755. #if !SQLITE_THREADSAFE
  14756. # define SQLITE_MUTEX_OMIT
  14757. #endif
  14758. #if SQLITE_THREADSAFE && !defined(SQLITE_MUTEX_NOOP)
  14759. # if SQLITE_OS_UNIX
  14760. # define SQLITE_MUTEX_PTHREADS
  14761. # elif SQLITE_OS_WIN
  14762. # define SQLITE_MUTEX_W32
  14763. # else
  14764. # define SQLITE_MUTEX_NOOP
  14765. # endif
  14766. #endif
  14767. #ifdef SQLITE_MUTEX_OMIT
  14768. /*
  14769. ** If this is a no-op implementation, implement everything as macros.
  14770. */
  14771. #define sqlite3_mutex_alloc(X) ((sqlite3_mutex*)8)
  14772. #define sqlite3_mutex_free(X)
  14773. #define sqlite3_mutex_enter(X)
  14774. #define sqlite3_mutex_try(X) SQLITE_OK
  14775. #define sqlite3_mutex_leave(X)
  14776. #define sqlite3_mutex_held(X) ((void)(X),1)
  14777. #define sqlite3_mutex_notheld(X) ((void)(X),1)
  14778. #define sqlite3MutexAlloc(X) ((sqlite3_mutex*)8)
  14779. #define sqlite3MutexInit() SQLITE_OK
  14780. #define sqlite3MutexEnd()
  14781. #define MUTEX_LOGIC(X)
  14782. #else
  14783. #define MUTEX_LOGIC(X) X
  14784. #endif /* defined(SQLITE_MUTEX_OMIT) */
  14785. /************** End of mutex.h ***********************************************/
  14786. /************** Continuing where we left off in sqliteInt.h ******************/
  14787. /* The SQLITE_EXTRA_DURABLE compile-time option used to set the default
  14788. ** synchronous setting to EXTRA. It is no longer supported.
  14789. */
  14790. #ifdef SQLITE_EXTRA_DURABLE
  14791. # warning Use SQLITE_DEFAULT_SYNCHRONOUS=3 instead of SQLITE_EXTRA_DURABLE
  14792. # define SQLITE_DEFAULT_SYNCHRONOUS 3
  14793. #endif
  14794. /*
  14795. ** Default synchronous levels.
  14796. **
  14797. ** Note that (for historcal reasons) the PAGER_SYNCHRONOUS_* macros differ
  14798. ** from the SQLITE_DEFAULT_SYNCHRONOUS value by 1.
  14799. **
  14800. ** PAGER_SYNCHRONOUS DEFAULT_SYNCHRONOUS
  14801. ** OFF 1 0
  14802. ** NORMAL 2 1
  14803. ** FULL 3 2
  14804. ** EXTRA 4 3
  14805. **
  14806. ** The "PRAGMA synchronous" statement also uses the zero-based numbers.
  14807. ** In other words, the zero-based numbers are used for all external interfaces
  14808. ** and the one-based values are used internally.
  14809. */
  14810. #ifndef SQLITE_DEFAULT_SYNCHRONOUS
  14811. # define SQLITE_DEFAULT_SYNCHRONOUS 2
  14812. #endif
  14813. #ifndef SQLITE_DEFAULT_WAL_SYNCHRONOUS
  14814. # define SQLITE_DEFAULT_WAL_SYNCHRONOUS SQLITE_DEFAULT_SYNCHRONOUS
  14815. #endif
  14816. /*
  14817. ** Each database file to be accessed by the system is an instance
  14818. ** of the following structure. There are normally two of these structures
  14819. ** in the sqlite.aDb[] array. aDb[0] is the main database file and
  14820. ** aDb[1] is the database file used to hold temporary tables. Additional
  14821. ** databases may be attached.
  14822. */
  14823. struct Db {
  14824. char *zDbSName; /* Name of this database. (schema name, not filename) */
  14825. Btree *pBt; /* The B*Tree structure for this database file */
  14826. u8 safety_level; /* How aggressive at syncing data to disk */
  14827. u8 bSyncSet; /* True if "PRAGMA synchronous=N" has been run */
  14828. Schema *pSchema; /* Pointer to database schema (possibly shared) */
  14829. };
  14830. /*
  14831. ** An instance of the following structure stores a database schema.
  14832. **
  14833. ** Most Schema objects are associated with a Btree. The exception is
  14834. ** the Schema for the TEMP databaes (sqlite3.aDb[1]) which is free-standing.
  14835. ** In shared cache mode, a single Schema object can be shared by multiple
  14836. ** Btrees that refer to the same underlying BtShared object.
  14837. **
  14838. ** Schema objects are automatically deallocated when the last Btree that
  14839. ** references them is destroyed. The TEMP Schema is manually freed by
  14840. ** sqlite3_close().
  14841. *
  14842. ** A thread must be holding a mutex on the corresponding Btree in order
  14843. ** to access Schema content. This implies that the thread must also be
  14844. ** holding a mutex on the sqlite3 connection pointer that owns the Btree.
  14845. ** For a TEMP Schema, only the connection mutex is required.
  14846. */
  14847. struct Schema {
  14848. int schema_cookie; /* Database schema version number for this file */
  14849. int iGeneration; /* Generation counter. Incremented with each change */
  14850. Hash tblHash; /* All tables indexed by name */
  14851. Hash idxHash; /* All (named) indices indexed by name */
  14852. Hash trigHash; /* All triggers indexed by name */
  14853. Hash fkeyHash; /* All foreign keys by referenced table name */
  14854. Table *pSeqTab; /* The sqlite_sequence table used by AUTOINCREMENT */
  14855. u8 file_format; /* Schema format version for this file */
  14856. u8 enc; /* Text encoding used by this database */
  14857. u16 schemaFlags; /* Flags associated with this schema */
  14858. int cache_size; /* Number of pages to use in the cache */
  14859. };
  14860. /*
  14861. ** These macros can be used to test, set, or clear bits in the
  14862. ** Db.pSchema->flags field.
  14863. */
  14864. #define DbHasProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))==(P))
  14865. #define DbHasAnyProperty(D,I,P) (((D)->aDb[I].pSchema->schemaFlags&(P))!=0)
  14866. #define DbSetProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags|=(P)
  14867. #define DbClearProperty(D,I,P) (D)->aDb[I].pSchema->schemaFlags&=~(P)
  14868. /*
  14869. ** Allowed values for the DB.pSchema->flags field.
  14870. **
  14871. ** The DB_SchemaLoaded flag is set after the database schema has been
  14872. ** read into internal hash tables.
  14873. **
  14874. ** DB_UnresetViews means that one or more views have column names that
  14875. ** have been filled out. If the schema changes, these column names might
  14876. ** changes and so the view will need to be reset.
  14877. */
  14878. #define DB_SchemaLoaded 0x0001 /* The schema has been loaded */
  14879. #define DB_UnresetViews 0x0002 /* Some views have defined column names */
  14880. #define DB_Empty 0x0004 /* The file is empty (length 0 bytes) */
  14881. #define DB_ResetWanted 0x0008 /* Reset the schema when nSchemaLock==0 */
  14882. /*
  14883. ** The number of different kinds of things that can be limited
  14884. ** using the sqlite3_limit() interface.
  14885. */
  14886. #define SQLITE_N_LIMIT (SQLITE_LIMIT_WORKER_THREADS+1)
  14887. /*
  14888. ** Lookaside malloc is a set of fixed-size buffers that can be used
  14889. ** to satisfy small transient memory allocation requests for objects
  14890. ** associated with a particular database connection. The use of
  14891. ** lookaside malloc provides a significant performance enhancement
  14892. ** (approx 10%) by avoiding numerous malloc/free requests while parsing
  14893. ** SQL statements.
  14894. **
  14895. ** The Lookaside structure holds configuration information about the
  14896. ** lookaside malloc subsystem. Each available memory allocation in
  14897. ** the lookaside subsystem is stored on a linked list of LookasideSlot
  14898. ** objects.
  14899. **
  14900. ** Lookaside allocations are only allowed for objects that are associated
  14901. ** with a particular database connection. Hence, schema information cannot
  14902. ** be stored in lookaside because in shared cache mode the schema information
  14903. ** is shared by multiple database connections. Therefore, while parsing
  14904. ** schema information, the Lookaside.bEnabled flag is cleared so that
  14905. ** lookaside allocations are not used to construct the schema objects.
  14906. */
  14907. struct Lookaside {
  14908. u32 bDisable; /* Only operate the lookaside when zero */
  14909. u16 sz; /* Size of each buffer in bytes */
  14910. u8 bMalloced; /* True if pStart obtained from sqlite3_malloc() */
  14911. u32 nSlot; /* Number of lookaside slots allocated */
  14912. u32 anStat[3]; /* 0: hits. 1: size misses. 2: full misses */
  14913. LookasideSlot *pInit; /* List of buffers not previously used */
  14914. LookasideSlot *pFree; /* List of available buffers */
  14915. void *pStart; /* First byte of available memory space */
  14916. void *pEnd; /* First byte past end of available space */
  14917. };
  14918. struct LookasideSlot {
  14919. LookasideSlot *pNext; /* Next buffer in the list of free buffers */
  14920. };
  14921. /*
  14922. ** A hash table for built-in function definitions. (Application-defined
  14923. ** functions use a regular table table from hash.h.)
  14924. **
  14925. ** Hash each FuncDef structure into one of the FuncDefHash.a[] slots.
  14926. ** Collisions are on the FuncDef.u.pHash chain.
  14927. */
  14928. #define SQLITE_FUNC_HASH_SZ 23
  14929. struct FuncDefHash {
  14930. FuncDef *a[SQLITE_FUNC_HASH_SZ]; /* Hash table for functions */
  14931. };
  14932. #ifdef SQLITE_USER_AUTHENTICATION
  14933. /*
  14934. ** Information held in the "sqlite3" database connection object and used
  14935. ** to manage user authentication.
  14936. */
  14937. typedef struct sqlite3_userauth sqlite3_userauth;
  14938. struct sqlite3_userauth {
  14939. u8 authLevel; /* Current authentication level */
  14940. int nAuthPW; /* Size of the zAuthPW in bytes */
  14941. char *zAuthPW; /* Password used to authenticate */
  14942. char *zAuthUser; /* User name used to authenticate */
  14943. };
  14944. /* Allowed values for sqlite3_userauth.authLevel */
  14945. #define UAUTH_Unknown 0 /* Authentication not yet checked */
  14946. #define UAUTH_Fail 1 /* User authentication failed */
  14947. #define UAUTH_User 2 /* Authenticated as a normal user */
  14948. #define UAUTH_Admin 3 /* Authenticated as an administrator */
  14949. /* Functions used only by user authorization logic */
  14950. SQLITE_PRIVATE int sqlite3UserAuthTable(const char*);
  14951. SQLITE_PRIVATE int sqlite3UserAuthCheckLogin(sqlite3*,const char*,u8*);
  14952. SQLITE_PRIVATE void sqlite3UserAuthInit(sqlite3*);
  14953. SQLITE_PRIVATE void sqlite3CryptFunc(sqlite3_context*,int,sqlite3_value**);
  14954. #endif /* SQLITE_USER_AUTHENTICATION */
  14955. /*
  14956. ** typedef for the authorization callback function.
  14957. */
  14958. #ifdef SQLITE_USER_AUTHENTICATION
  14959. typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
  14960. const char*, const char*);
  14961. #else
  14962. typedef int (*sqlite3_xauth)(void*,int,const char*,const char*,const char*,
  14963. const char*);
  14964. #endif
  14965. #ifndef SQLITE_OMIT_DEPRECATED
  14966. /* This is an extra SQLITE_TRACE macro that indicates "legacy" tracing
  14967. ** in the style of sqlite3_trace()
  14968. */
  14969. #define SQLITE_TRACE_LEGACY 0x80
  14970. #else
  14971. #define SQLITE_TRACE_LEGACY 0
  14972. #endif /* SQLITE_OMIT_DEPRECATED */
  14973. /*
  14974. ** Each database connection is an instance of the following structure.
  14975. */
  14976. struct sqlite3 {
  14977. sqlite3_vfs *pVfs; /* OS Interface */
  14978. struct Vdbe *pVdbe; /* List of active virtual machines */
  14979. CollSeq *pDfltColl; /* The default collating sequence (BINARY) */
  14980. sqlite3_mutex *mutex; /* Connection mutex */
  14981. Db *aDb; /* All backends */
  14982. int nDb; /* Number of backends currently in use */
  14983. u32 mDbFlags; /* flags recording internal state */
  14984. u32 flags; /* flags settable by pragmas. See below */
  14985. i64 lastRowid; /* ROWID of most recent insert (see above) */
  14986. i64 szMmap; /* Default mmap_size setting */
  14987. u32 nSchemaLock; /* Do not reset the schema when non-zero */
  14988. unsigned int openFlags; /* Flags passed to sqlite3_vfs.xOpen() */
  14989. int errCode; /* Most recent error code (SQLITE_*) */
  14990. int errMask; /* & result codes with this before returning */
  14991. int iSysErrno; /* Errno value from last system error */
  14992. u16 dbOptFlags; /* Flags to enable/disable optimizations */
  14993. u8 enc; /* Text encoding */
  14994. u8 autoCommit; /* The auto-commit flag. */
  14995. u8 temp_store; /* 1: file 2: memory 0: default */
  14996. u8 mallocFailed; /* True if we have seen a malloc failure */
  14997. u8 bBenignMalloc; /* Do not require OOMs if true */
  14998. u8 dfltLockMode; /* Default locking-mode for attached dbs */
  14999. signed char nextAutovac; /* Autovac setting after VACUUM if >=0 */
  15000. u8 suppressErr; /* Do not issue error messages if true */
  15001. u8 vtabOnConflict; /* Value to return for s3_vtab_on_conflict() */
  15002. u8 isTransactionSavepoint; /* True if the outermost savepoint is a TS */
  15003. u8 mTrace; /* zero or more SQLITE_TRACE flags */
  15004. u8 skipBtreeMutex; /* True if no shared-cache backends */
  15005. u8 nSqlExec; /* Number of pending OP_SqlExec opcodes */
  15006. int nextPagesize; /* Pagesize after VACUUM if >0 */
  15007. u32 magic; /* Magic number for detect library misuse */
  15008. int nChange; /* Value returned by sqlite3_changes() */
  15009. int nTotalChange; /* Value returned by sqlite3_total_changes() */
  15010. int aLimit[SQLITE_N_LIMIT]; /* Limits */
  15011. int nMaxSorterMmap; /* Maximum size of regions mapped by sorter */
  15012. struct sqlite3InitInfo { /* Information used during initialization */
  15013. int newTnum; /* Rootpage of table being initialized */
  15014. u8 iDb; /* Which db file is being initialized */
  15015. u8 busy; /* TRUE if currently initializing */
  15016. unsigned orphanTrigger : 1; /* Last statement is orphaned TEMP trigger */
  15017. unsigned imposterTable : 1; /* Building an imposter table */
  15018. unsigned reopenMemdb : 1; /* ATTACH is really a reopen using MemDB */
  15019. } init;
  15020. int nVdbeActive; /* Number of VDBEs currently running */
  15021. int nVdbeRead; /* Number of active VDBEs that read or write */
  15022. int nVdbeWrite; /* Number of active VDBEs that read and write */
  15023. int nVdbeExec; /* Number of nested calls to VdbeExec() */
  15024. int nVDestroy; /* Number of active OP_VDestroy operations */
  15025. int nExtension; /* Number of loaded extensions */
  15026. void **aExtension; /* Array of shared library handles */
  15027. int (*xTrace)(u32,void*,void*,void*); /* Trace function */
  15028. void *pTraceArg; /* Argument to the trace function */
  15029. void (*xProfile)(void*,const char*,u64); /* Profiling function */
  15030. void *pProfileArg; /* Argument to profile function */
  15031. void *pCommitArg; /* Argument to xCommitCallback() */
  15032. int (*xCommitCallback)(void*); /* Invoked at every commit. */
  15033. void *pRollbackArg; /* Argument to xRollbackCallback() */
  15034. void (*xRollbackCallback)(void*); /* Invoked at every commit. */
  15035. void *pUpdateArg;
  15036. void (*xUpdateCallback)(void*,int, const char*,const char*,sqlite_int64);
  15037. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  15038. void *pPreUpdateArg; /* First argument to xPreUpdateCallback */
  15039. void (*xPreUpdateCallback)( /* Registered using sqlite3_preupdate_hook() */
  15040. void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64
  15041. );
  15042. PreUpdate *pPreUpdate; /* Context for active pre-update callback */
  15043. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  15044. #ifndef SQLITE_OMIT_WAL
  15045. int (*xWalCallback)(void *, sqlite3 *, const char *, int);
  15046. void *pWalArg;
  15047. #endif
  15048. void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*);
  15049. void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*);
  15050. void *pCollNeededArg;
  15051. sqlite3_value *pErr; /* Most recent error message */
  15052. union {
  15053. volatile int isInterrupted; /* True if sqlite3_interrupt has been called */
  15054. double notUsed1; /* Spacer */
  15055. } u1;
  15056. Lookaside lookaside; /* Lookaside malloc configuration */
  15057. #ifndef SQLITE_OMIT_AUTHORIZATION
  15058. sqlite3_xauth xAuth; /* Access authorization function */
  15059. void *pAuthArg; /* 1st argument to the access auth function */
  15060. #endif
  15061. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  15062. int (*xProgress)(void *); /* The progress callback */
  15063. void *pProgressArg; /* Argument to the progress callback */
  15064. unsigned nProgressOps; /* Number of opcodes for progress callback */
  15065. #endif
  15066. #ifndef SQLITE_OMIT_VIRTUALTABLE
  15067. int nVTrans; /* Allocated size of aVTrans */
  15068. Hash aModule; /* populated by sqlite3_create_module() */
  15069. VtabCtx *pVtabCtx; /* Context for active vtab connect/create */
  15070. VTable **aVTrans; /* Virtual tables with open transactions */
  15071. VTable *pDisconnect; /* Disconnect these in next sqlite3_prepare() */
  15072. #endif
  15073. Hash aFunc; /* Hash table of connection functions */
  15074. Hash aCollSeq; /* All collating sequences */
  15075. BusyHandler busyHandler; /* Busy callback */
  15076. Db aDbStatic[2]; /* Static space for the 2 default backends */
  15077. Savepoint *pSavepoint; /* List of active savepoints */
  15078. int busyTimeout; /* Busy handler timeout, in msec */
  15079. int nSavepoint; /* Number of non-transaction savepoints */
  15080. int nStatement; /* Number of nested statement-transactions */
  15081. i64 nDeferredCons; /* Net deferred constraints this transaction. */
  15082. i64 nDeferredImmCons; /* Net deferred immediate constraints */
  15083. int *pnBytesFreed; /* If not NULL, increment this in DbFree() */
  15084. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  15085. /* The following variables are all protected by the STATIC_MASTER
  15086. ** mutex, not by sqlite3.mutex. They are used by code in notify.c.
  15087. **
  15088. ** When X.pUnlockConnection==Y, that means that X is waiting for Y to
  15089. ** unlock so that it can proceed.
  15090. **
  15091. ** When X.pBlockingConnection==Y, that means that something that X tried
  15092. ** tried to do recently failed with an SQLITE_LOCKED error due to locks
  15093. ** held by Y.
  15094. */
  15095. sqlite3 *pBlockingConnection; /* Connection that caused SQLITE_LOCKED */
  15096. sqlite3 *pUnlockConnection; /* Connection to watch for unlock */
  15097. void *pUnlockArg; /* Argument to xUnlockNotify */
  15098. void (*xUnlockNotify)(void **, int); /* Unlock notify callback */
  15099. sqlite3 *pNextBlocked; /* Next in list of all blocked connections */
  15100. #endif
  15101. #ifdef SQLITE_USER_AUTHENTICATION
  15102. sqlite3_userauth auth; /* User authentication information */
  15103. #endif
  15104. };
  15105. /*
  15106. ** A macro to discover the encoding of a database.
  15107. */
  15108. #define SCHEMA_ENC(db) ((db)->aDb[0].pSchema->enc)
  15109. #define ENC(db) ((db)->enc)
  15110. /*
  15111. ** Possible values for the sqlite3.flags.
  15112. **
  15113. ** Value constraints (enforced via assert()):
  15114. ** SQLITE_FullFSync == PAGER_FULLFSYNC
  15115. ** SQLITE_CkptFullFSync == PAGER_CKPT_FULLFSYNC
  15116. ** SQLITE_CacheSpill == PAGER_CACHE_SPILL
  15117. */
  15118. #define SQLITE_WriteSchema 0x00000001 /* OK to update SQLITE_MASTER */
  15119. #define SQLITE_LegacyFileFmt 0x00000002 /* Create new databases in format 1 */
  15120. #define SQLITE_FullColNames 0x00000004 /* Show full column names on SELECT */
  15121. #define SQLITE_FullFSync 0x00000008 /* Use full fsync on the backend */
  15122. #define SQLITE_CkptFullFSync 0x00000010 /* Use full fsync for checkpoint */
  15123. #define SQLITE_CacheSpill 0x00000020 /* OK to spill pager cache */
  15124. #define SQLITE_ShortColNames 0x00000040 /* Show short columns names */
  15125. #define SQLITE_CountRows 0x00000080 /* Count rows changed by INSERT, */
  15126. /* DELETE, or UPDATE and return */
  15127. /* the count using a callback. */
  15128. #define SQLITE_NullCallback 0x00000100 /* Invoke the callback once if the */
  15129. /* result set is empty */
  15130. #define SQLITE_IgnoreChecks 0x00000200 /* Do not enforce check constraints */
  15131. #define SQLITE_ReadUncommit 0x00000400 /* READ UNCOMMITTED in shared-cache */
  15132. #define SQLITE_NoCkptOnClose 0x00000800 /* No checkpoint on close()/DETACH */
  15133. #define SQLITE_ReverseOrder 0x00001000 /* Reverse unordered SELECTs */
  15134. #define SQLITE_RecTriggers 0x00002000 /* Enable recursive triggers */
  15135. #define SQLITE_ForeignKeys 0x00004000 /* Enforce foreign key constraints */
  15136. #define SQLITE_AutoIndex 0x00008000 /* Enable automatic indexes */
  15137. #define SQLITE_LoadExtension 0x00010000 /* Enable load_extension */
  15138. #define SQLITE_LoadExtFunc 0x00020000 /* Enable load_extension() SQL func */
  15139. #define SQLITE_EnableTrigger 0x00040000 /* True to enable triggers */
  15140. #define SQLITE_DeferFKs 0x00080000 /* Defer all FK constraints */
  15141. #define SQLITE_QueryOnly 0x00100000 /* Disable database changes */
  15142. #define SQLITE_CellSizeCk 0x00200000 /* Check btree cell sizes on load */
  15143. #define SQLITE_Fts3Tokenizer 0x00400000 /* Enable fts3_tokenizer(2) */
  15144. #define SQLITE_EnableQPSG 0x00800000 /* Query Planner Stability Guarantee*/
  15145. #define SQLITE_TriggerEQP 0x01000000 /* Show trigger EXPLAIN QUERY PLAN */
  15146. /* Flags used only if debugging */
  15147. #ifdef SQLITE_DEBUG
  15148. #define SQLITE_SqlTrace 0x08000000 /* Debug print SQL as it executes */
  15149. #define SQLITE_VdbeListing 0x10000000 /* Debug listings of VDBE programs */
  15150. #define SQLITE_VdbeTrace 0x20000000 /* True to trace VDBE execution */
  15151. #define SQLITE_VdbeAddopTrace 0x40000000 /* Trace sqlite3VdbeAddOp() calls */
  15152. #define SQLITE_VdbeEQP 0x80000000 /* Debug EXPLAIN QUERY PLAN */
  15153. #endif
  15154. /*
  15155. ** Allowed values for sqlite3.mDbFlags
  15156. */
  15157. #define DBFLAG_SchemaChange 0x0001 /* Uncommitted Hash table changes */
  15158. #define DBFLAG_PreferBuiltin 0x0002 /* Preference to built-in funcs */
  15159. #define DBFLAG_Vacuum 0x0004 /* Currently in a VACUUM */
  15160. /*
  15161. ** Bits of the sqlite3.dbOptFlags field that are used by the
  15162. ** sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS,...) interface to
  15163. ** selectively disable various optimizations.
  15164. */
  15165. #define SQLITE_QueryFlattener 0x0001 /* Query flattening */
  15166. #define SQLITE_ColumnCache 0x0002 /* Column cache */
  15167. #define SQLITE_GroupByOrder 0x0004 /* GROUPBY cover of ORDERBY */
  15168. #define SQLITE_FactorOutConst 0x0008 /* Constant factoring */
  15169. #define SQLITE_DistinctOpt 0x0010 /* DISTINCT using indexes */
  15170. #define SQLITE_CoverIdxScan 0x0020 /* Covering index scans */
  15171. #define SQLITE_OrderByIdxJoin 0x0040 /* ORDER BY of joins via index */
  15172. #define SQLITE_Transitive 0x0080 /* Transitive constraints */
  15173. #define SQLITE_OmitNoopJoin 0x0100 /* Omit unused tables in joins */
  15174. #define SQLITE_CountOfView 0x0200 /* The count-of-view optimization */
  15175. #define SQLITE_CursorHints 0x0400 /* Add OP_CursorHint opcodes */
  15176. #define SQLITE_Stat34 0x0800 /* Use STAT3 or STAT4 data */
  15177. /* TH3 expects the Stat34 ^^^^^^ value to be 0x0800. Don't change it */
  15178. #define SQLITE_PushDown 0x1000 /* The push-down optimization */
  15179. #define SQLITE_SimplifyJoin 0x2000 /* Convert LEFT JOIN to JOIN */
  15180. #define SQLITE_AllOpts 0xffff /* All optimizations */
  15181. /*
  15182. ** Macros for testing whether or not optimizations are enabled or disabled.
  15183. */
  15184. #define OptimizationDisabled(db, mask) (((db)->dbOptFlags&(mask))!=0)
  15185. #define OptimizationEnabled(db, mask) (((db)->dbOptFlags&(mask))==0)
  15186. /*
  15187. ** Return true if it OK to factor constant expressions into the initialization
  15188. ** code. The argument is a Parse object for the code generator.
  15189. */
  15190. #define ConstFactorOk(P) ((P)->okConstFactor)
  15191. /*
  15192. ** Possible values for the sqlite.magic field.
  15193. ** The numbers are obtained at random and have no special meaning, other
  15194. ** than being distinct from one another.
  15195. */
  15196. #define SQLITE_MAGIC_OPEN 0xa029a697 /* Database is open */
  15197. #define SQLITE_MAGIC_CLOSED 0x9f3c2d33 /* Database is closed */
  15198. #define SQLITE_MAGIC_SICK 0x4b771290 /* Error and awaiting close */
  15199. #define SQLITE_MAGIC_BUSY 0xf03b7906 /* Database currently in use */
  15200. #define SQLITE_MAGIC_ERROR 0xb5357930 /* An SQLITE_MISUSE error occurred */
  15201. #define SQLITE_MAGIC_ZOMBIE 0x64cffc7f /* Close with last statement close */
  15202. /*
  15203. ** Each SQL function is defined by an instance of the following
  15204. ** structure. For global built-in functions (ex: substr(), max(), count())
  15205. ** a pointer to this structure is held in the sqlite3BuiltinFunctions object.
  15206. ** For per-connection application-defined functions, a pointer to this
  15207. ** structure is held in the db->aHash hash table.
  15208. **
  15209. ** The u.pHash field is used by the global built-ins. The u.pDestructor
  15210. ** field is used by per-connection app-def functions.
  15211. */
  15212. struct FuncDef {
  15213. i8 nArg; /* Number of arguments. -1 means unlimited */
  15214. u16 funcFlags; /* Some combination of SQLITE_FUNC_* */
  15215. void *pUserData; /* User data parameter */
  15216. FuncDef *pNext; /* Next function with same name */
  15217. void (*xSFunc)(sqlite3_context*,int,sqlite3_value**); /* func or agg-step */
  15218. void (*xFinalize)(sqlite3_context*); /* Agg finalizer */
  15219. const char *zName; /* SQL name of the function. */
  15220. union {
  15221. FuncDef *pHash; /* Next with a different name but the same hash */
  15222. FuncDestructor *pDestructor; /* Reference counted destructor function */
  15223. } u;
  15224. };
  15225. /*
  15226. ** This structure encapsulates a user-function destructor callback (as
  15227. ** configured using create_function_v2()) and a reference counter. When
  15228. ** create_function_v2() is called to create a function with a destructor,
  15229. ** a single object of this type is allocated. FuncDestructor.nRef is set to
  15230. ** the number of FuncDef objects created (either 1 or 3, depending on whether
  15231. ** or not the specified encoding is SQLITE_ANY). The FuncDef.pDestructor
  15232. ** member of each of the new FuncDef objects is set to point to the allocated
  15233. ** FuncDestructor.
  15234. **
  15235. ** Thereafter, when one of the FuncDef objects is deleted, the reference
  15236. ** count on this object is decremented. When it reaches 0, the destructor
  15237. ** is invoked and the FuncDestructor structure freed.
  15238. */
  15239. struct FuncDestructor {
  15240. int nRef;
  15241. void (*xDestroy)(void *);
  15242. void *pUserData;
  15243. };
  15244. /*
  15245. ** Possible values for FuncDef.flags. Note that the _LENGTH and _TYPEOF
  15246. ** values must correspond to OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG. And
  15247. ** SQLITE_FUNC_CONSTANT must be the same as SQLITE_DETERMINISTIC. There
  15248. ** are assert() statements in the code to verify this.
  15249. **
  15250. ** Value constraints (enforced via assert()):
  15251. ** SQLITE_FUNC_MINMAX == NC_MinMaxAgg == SF_MinMaxAgg
  15252. ** SQLITE_FUNC_LENGTH == OPFLAG_LENGTHARG
  15253. ** SQLITE_FUNC_TYPEOF == OPFLAG_TYPEOFARG
  15254. ** SQLITE_FUNC_CONSTANT == SQLITE_DETERMINISTIC from the API
  15255. ** SQLITE_FUNC_ENCMASK depends on SQLITE_UTF* macros in the API
  15256. */
  15257. #define SQLITE_FUNC_ENCMASK 0x0003 /* SQLITE_UTF8, SQLITE_UTF16BE or UTF16LE */
  15258. #define SQLITE_FUNC_LIKE 0x0004 /* Candidate for the LIKE optimization */
  15259. #define SQLITE_FUNC_CASE 0x0008 /* Case-sensitive LIKE-type function */
  15260. #define SQLITE_FUNC_EPHEM 0x0010 /* Ephemeral. Delete with VDBE */
  15261. #define SQLITE_FUNC_NEEDCOLL 0x0020 /* sqlite3GetFuncCollSeq() might be called*/
  15262. #define SQLITE_FUNC_LENGTH 0x0040 /* Built-in length() function */
  15263. #define SQLITE_FUNC_TYPEOF 0x0080 /* Built-in typeof() function */
  15264. #define SQLITE_FUNC_COUNT 0x0100 /* Built-in count(*) aggregate */
  15265. #define SQLITE_FUNC_COALESCE 0x0200 /* Built-in coalesce() or ifnull() */
  15266. #define SQLITE_FUNC_UNLIKELY 0x0400 /* Built-in unlikely() function */
  15267. #define SQLITE_FUNC_CONSTANT 0x0800 /* Constant inputs give a constant output */
  15268. #define SQLITE_FUNC_MINMAX 0x1000 /* True for min() and max() aggregates */
  15269. #define SQLITE_FUNC_SLOCHNG 0x2000 /* "Slow Change". Value constant during a
  15270. ** single query - might change over time */
  15271. #define SQLITE_FUNC_AFFINITY 0x4000 /* Built-in affinity() function */
  15272. #define SQLITE_FUNC_OFFSET 0x8000 /* Built-in sqlite_offset() function */
  15273. /*
  15274. ** The following three macros, FUNCTION(), LIKEFUNC() and AGGREGATE() are
  15275. ** used to create the initializers for the FuncDef structures.
  15276. **
  15277. ** FUNCTION(zName, nArg, iArg, bNC, xFunc)
  15278. ** Used to create a scalar function definition of a function zName
  15279. ** implemented by C function xFunc that accepts nArg arguments. The
  15280. ** value passed as iArg is cast to a (void*) and made available
  15281. ** as the user-data (sqlite3_user_data()) for the function. If
  15282. ** argument bNC is true, then the SQLITE_FUNC_NEEDCOLL flag is set.
  15283. **
  15284. ** VFUNCTION(zName, nArg, iArg, bNC, xFunc)
  15285. ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag.
  15286. **
  15287. ** DFUNCTION(zName, nArg, iArg, bNC, xFunc)
  15288. ** Like FUNCTION except it omits the SQLITE_FUNC_CONSTANT flag and
  15289. ** adds the SQLITE_FUNC_SLOCHNG flag. Used for date & time functions
  15290. ** and functions like sqlite_version() that can change, but not during
  15291. ** a single query. The iArg is ignored. The user-data is always set
  15292. ** to a NULL pointer. The bNC parameter is not used.
  15293. **
  15294. ** PURE_DATE(zName, nArg, iArg, bNC, xFunc)
  15295. ** Used for "pure" date/time functions, this macro is like DFUNCTION
  15296. ** except that it does set the SQLITE_FUNC_CONSTANT flags. iArg is
  15297. ** ignored and the user-data for these functions is set to an
  15298. ** arbitrary non-NULL pointer. The bNC parameter is not used.
  15299. **
  15300. ** AGGREGATE(zName, nArg, iArg, bNC, xStep, xFinal)
  15301. ** Used to create an aggregate function definition implemented by
  15302. ** the C functions xStep and xFinal. The first four parameters
  15303. ** are interpreted in the same way as the first 4 parameters to
  15304. ** FUNCTION().
  15305. **
  15306. ** LIKEFUNC(zName, nArg, pArg, flags)
  15307. ** Used to create a scalar function definition of a function zName
  15308. ** that accepts nArg arguments and is implemented by a call to C
  15309. ** function likeFunc. Argument pArg is cast to a (void *) and made
  15310. ** available as the function user-data (sqlite3_user_data()). The
  15311. ** FuncDef.flags variable is set to the value passed as the flags
  15312. ** parameter.
  15313. */
  15314. #define FUNCTION(zName, nArg, iArg, bNC, xFunc) \
  15315. {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  15316. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  15317. #define VFUNCTION(zName, nArg, iArg, bNC, xFunc) \
  15318. {nArg, SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  15319. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  15320. #define DFUNCTION(zName, nArg, iArg, bNC, xFunc) \
  15321. {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8, \
  15322. 0, 0, xFunc, 0, #zName, {0} }
  15323. #define PURE_DATE(zName, nArg, iArg, bNC, xFunc) \
  15324. {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|SQLITE_FUNC_CONSTANT, \
  15325. (void*)&sqlite3Config, 0, xFunc, 0, #zName, {0} }
  15326. #define FUNCTION2(zName, nArg, iArg, bNC, xFunc, extraFlags) \
  15327. {nArg,SQLITE_FUNC_CONSTANT|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL)|extraFlags,\
  15328. SQLITE_INT_TO_PTR(iArg), 0, xFunc, 0, #zName, {0} }
  15329. #define STR_FUNCTION(zName, nArg, pArg, bNC, xFunc) \
  15330. {nArg, SQLITE_FUNC_SLOCHNG|SQLITE_UTF8|(bNC*SQLITE_FUNC_NEEDCOLL), \
  15331. pArg, 0, xFunc, 0, #zName, }
  15332. #define LIKEFUNC(zName, nArg, arg, flags) \
  15333. {nArg, SQLITE_FUNC_CONSTANT|SQLITE_UTF8|flags, \
  15334. (void *)arg, 0, likeFunc, 0, #zName, {0} }
  15335. #define AGGREGATE(zName, nArg, arg, nc, xStep, xFinal) \
  15336. {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL), \
  15337. SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
  15338. #define AGGREGATE2(zName, nArg, arg, nc, xStep, xFinal, extraFlags) \
  15339. {nArg, SQLITE_UTF8|(nc*SQLITE_FUNC_NEEDCOLL)|extraFlags, \
  15340. SQLITE_INT_TO_PTR(arg), 0, xStep,xFinal,#zName, {0}}
  15341. /*
  15342. ** All current savepoints are stored in a linked list starting at
  15343. ** sqlite3.pSavepoint. The first element in the list is the most recently
  15344. ** opened savepoint. Savepoints are added to the list by the vdbe
  15345. ** OP_Savepoint instruction.
  15346. */
  15347. struct Savepoint {
  15348. char *zName; /* Savepoint name (nul-terminated) */
  15349. i64 nDeferredCons; /* Number of deferred fk violations */
  15350. i64 nDeferredImmCons; /* Number of deferred imm fk. */
  15351. Savepoint *pNext; /* Parent savepoint (if any) */
  15352. };
  15353. /*
  15354. ** The following are used as the second parameter to sqlite3Savepoint(),
  15355. ** and as the P1 argument to the OP_Savepoint instruction.
  15356. */
  15357. #define SAVEPOINT_BEGIN 0
  15358. #define SAVEPOINT_RELEASE 1
  15359. #define SAVEPOINT_ROLLBACK 2
  15360. /*
  15361. ** Each SQLite module (virtual table definition) is defined by an
  15362. ** instance of the following structure, stored in the sqlite3.aModule
  15363. ** hash table.
  15364. */
  15365. struct Module {
  15366. const sqlite3_module *pModule; /* Callback pointers */
  15367. const char *zName; /* Name passed to create_module() */
  15368. void *pAux; /* pAux passed to create_module() */
  15369. void (*xDestroy)(void *); /* Module destructor function */
  15370. Table *pEpoTab; /* Eponymous table for this module */
  15371. };
  15372. /*
  15373. ** information about each column of an SQL table is held in an instance
  15374. ** of this structure.
  15375. */
  15376. struct Column {
  15377. char *zName; /* Name of this column, \000, then the type */
  15378. Expr *pDflt; /* Default value of this column */
  15379. char *zColl; /* Collating sequence. If NULL, use the default */
  15380. u8 notNull; /* An OE_ code for handling a NOT NULL constraint */
  15381. char affinity; /* One of the SQLITE_AFF_... values */
  15382. u8 szEst; /* Estimated size of value in this column. sizeof(INT)==1 */
  15383. u8 colFlags; /* Boolean properties. See COLFLAG_ defines below */
  15384. };
  15385. /* Allowed values for Column.colFlags:
  15386. */
  15387. #define COLFLAG_PRIMKEY 0x0001 /* Column is part of the primary key */
  15388. #define COLFLAG_HIDDEN 0x0002 /* A hidden column in a virtual table */
  15389. #define COLFLAG_HASTYPE 0x0004 /* Type name follows column name */
  15390. #define COLFLAG_UNIQUE 0x0008 /* Column def contains "UNIQUE" or "PK" */
  15391. /*
  15392. ** A "Collating Sequence" is defined by an instance of the following
  15393. ** structure. Conceptually, a collating sequence consists of a name and
  15394. ** a comparison routine that defines the order of that sequence.
  15395. **
  15396. ** If CollSeq.xCmp is NULL, it means that the
  15397. ** collating sequence is undefined. Indices built on an undefined
  15398. ** collating sequence may not be read or written.
  15399. */
  15400. struct CollSeq {
  15401. char *zName; /* Name of the collating sequence, UTF-8 encoded */
  15402. u8 enc; /* Text encoding handled by xCmp() */
  15403. void *pUser; /* First argument to xCmp() */
  15404. int (*xCmp)(void*,int, const void*, int, const void*);
  15405. void (*xDel)(void*); /* Destructor for pUser */
  15406. };
  15407. /*
  15408. ** A sort order can be either ASC or DESC.
  15409. */
  15410. #define SQLITE_SO_ASC 0 /* Sort in ascending order */
  15411. #define SQLITE_SO_DESC 1 /* Sort in ascending order */
  15412. #define SQLITE_SO_UNDEFINED -1 /* No sort order specified */
  15413. /*
  15414. ** Column affinity types.
  15415. **
  15416. ** These used to have mnemonic name like 'i' for SQLITE_AFF_INTEGER and
  15417. ** 't' for SQLITE_AFF_TEXT. But we can save a little space and improve
  15418. ** the speed a little by numbering the values consecutively.
  15419. **
  15420. ** But rather than start with 0 or 1, we begin with 'A'. That way,
  15421. ** when multiple affinity types are concatenated into a string and
  15422. ** used as the P4 operand, they will be more readable.
  15423. **
  15424. ** Note also that the numeric types are grouped together so that testing
  15425. ** for a numeric type is a single comparison. And the BLOB type is first.
  15426. */
  15427. #define SQLITE_AFF_BLOB 'A'
  15428. #define SQLITE_AFF_TEXT 'B'
  15429. #define SQLITE_AFF_NUMERIC 'C'
  15430. #define SQLITE_AFF_INTEGER 'D'
  15431. #define SQLITE_AFF_REAL 'E'
  15432. #define sqlite3IsNumericAffinity(X) ((X)>=SQLITE_AFF_NUMERIC)
  15433. /*
  15434. ** The SQLITE_AFF_MASK values masks off the significant bits of an
  15435. ** affinity value.
  15436. */
  15437. #define SQLITE_AFF_MASK 0x47
  15438. /*
  15439. ** Additional bit values that can be ORed with an affinity without
  15440. ** changing the affinity.
  15441. **
  15442. ** The SQLITE_NOTNULL flag is a combination of NULLEQ and JUMPIFNULL.
  15443. ** It causes an assert() to fire if either operand to a comparison
  15444. ** operator is NULL. It is added to certain comparison operators to
  15445. ** prove that the operands are always NOT NULL.
  15446. */
  15447. #define SQLITE_KEEPNULL 0x08 /* Used by vector == or <> */
  15448. #define SQLITE_JUMPIFNULL 0x10 /* jumps if either operand is NULL */
  15449. #define SQLITE_STOREP2 0x20 /* Store result in reg[P2] rather than jump */
  15450. #define SQLITE_NULLEQ 0x80 /* NULL=NULL */
  15451. #define SQLITE_NOTNULL 0x90 /* Assert that operands are never NULL */
  15452. /*
  15453. ** An object of this type is created for each virtual table present in
  15454. ** the database schema.
  15455. **
  15456. ** If the database schema is shared, then there is one instance of this
  15457. ** structure for each database connection (sqlite3*) that uses the shared
  15458. ** schema. This is because each database connection requires its own unique
  15459. ** instance of the sqlite3_vtab* handle used to access the virtual table
  15460. ** implementation. sqlite3_vtab* handles can not be shared between
  15461. ** database connections, even when the rest of the in-memory database
  15462. ** schema is shared, as the implementation often stores the database
  15463. ** connection handle passed to it via the xConnect() or xCreate() method
  15464. ** during initialization internally. This database connection handle may
  15465. ** then be used by the virtual table implementation to access real tables
  15466. ** within the database. So that they appear as part of the callers
  15467. ** transaction, these accesses need to be made via the same database
  15468. ** connection as that used to execute SQL operations on the virtual table.
  15469. **
  15470. ** All VTable objects that correspond to a single table in a shared
  15471. ** database schema are initially stored in a linked-list pointed to by
  15472. ** the Table.pVTable member variable of the corresponding Table object.
  15473. ** When an sqlite3_prepare() operation is required to access the virtual
  15474. ** table, it searches the list for the VTable that corresponds to the
  15475. ** database connection doing the preparing so as to use the correct
  15476. ** sqlite3_vtab* handle in the compiled query.
  15477. **
  15478. ** When an in-memory Table object is deleted (for example when the
  15479. ** schema is being reloaded for some reason), the VTable objects are not
  15480. ** deleted and the sqlite3_vtab* handles are not xDisconnect()ed
  15481. ** immediately. Instead, they are moved from the Table.pVTable list to
  15482. ** another linked list headed by the sqlite3.pDisconnect member of the
  15483. ** corresponding sqlite3 structure. They are then deleted/xDisconnected
  15484. ** next time a statement is prepared using said sqlite3*. This is done
  15485. ** to avoid deadlock issues involving multiple sqlite3.mutex mutexes.
  15486. ** Refer to comments above function sqlite3VtabUnlockList() for an
  15487. ** explanation as to why it is safe to add an entry to an sqlite3.pDisconnect
  15488. ** list without holding the corresponding sqlite3.mutex mutex.
  15489. **
  15490. ** The memory for objects of this type is always allocated by
  15491. ** sqlite3DbMalloc(), using the connection handle stored in VTable.db as
  15492. ** the first argument.
  15493. */
  15494. struct VTable {
  15495. sqlite3 *db; /* Database connection associated with this table */
  15496. Module *pMod; /* Pointer to module implementation */
  15497. sqlite3_vtab *pVtab; /* Pointer to vtab instance */
  15498. int nRef; /* Number of pointers to this structure */
  15499. u8 bConstraint; /* True if constraints are supported */
  15500. int iSavepoint; /* Depth of the SAVEPOINT stack */
  15501. VTable *pNext; /* Next in linked list (see above) */
  15502. };
  15503. /*
  15504. ** The schema for each SQL table and view is represented in memory
  15505. ** by an instance of the following structure.
  15506. */
  15507. struct Table {
  15508. char *zName; /* Name of the table or view */
  15509. Column *aCol; /* Information about each column */
  15510. Index *pIndex; /* List of SQL indexes on this table. */
  15511. Select *pSelect; /* NULL for tables. Points to definition if a view. */
  15512. FKey *pFKey; /* Linked list of all foreign keys in this table */
  15513. char *zColAff; /* String defining the affinity of each column */
  15514. ExprList *pCheck; /* All CHECK constraints */
  15515. /* ... also used as column name list in a VIEW */
  15516. int tnum; /* Root BTree page for this table */
  15517. u32 nTabRef; /* Number of pointers to this Table */
  15518. u32 tabFlags; /* Mask of TF_* values */
  15519. i16 iPKey; /* If not negative, use aCol[iPKey] as the rowid */
  15520. i16 nCol; /* Number of columns in this table */
  15521. LogEst nRowLogEst; /* Estimated rows in table - from sqlite_stat1 table */
  15522. LogEst szTabRow; /* Estimated size of each table row in bytes */
  15523. #ifdef SQLITE_ENABLE_COSTMULT
  15524. LogEst costMult; /* Cost multiplier for using this table */
  15525. #endif
  15526. u8 keyConf; /* What to do in case of uniqueness conflict on iPKey */
  15527. #ifndef SQLITE_OMIT_ALTERTABLE
  15528. int addColOffset; /* Offset in CREATE TABLE stmt to add a new column */
  15529. #endif
  15530. #ifndef SQLITE_OMIT_VIRTUALTABLE
  15531. int nModuleArg; /* Number of arguments to the module */
  15532. char **azModuleArg; /* 0: module 1: schema 2: vtab name 3...: args */
  15533. VTable *pVTable; /* List of VTable objects. */
  15534. #endif
  15535. Trigger *pTrigger; /* List of triggers stored in pSchema */
  15536. Schema *pSchema; /* Schema that contains this table */
  15537. Table *pNextZombie; /* Next on the Parse.pZombieTab list */
  15538. };
  15539. /*
  15540. ** Allowed values for Table.tabFlags.
  15541. **
  15542. ** TF_OOOHidden applies to tables or view that have hidden columns that are
  15543. ** followed by non-hidden columns. Example: "CREATE VIRTUAL TABLE x USING
  15544. ** vtab1(a HIDDEN, b);". Since "b" is a non-hidden column but "a" is hidden,
  15545. ** the TF_OOOHidden attribute would apply in this case. Such tables require
  15546. ** special handling during INSERT processing.
  15547. */
  15548. #define TF_Readonly 0x0001 /* Read-only system table */
  15549. #define TF_Ephemeral 0x0002 /* An ephemeral table */
  15550. #define TF_HasPrimaryKey 0x0004 /* Table has a primary key */
  15551. #define TF_Autoincrement 0x0008 /* Integer primary key is autoincrement */
  15552. #define TF_HasStat1 0x0010 /* nRowLogEst set from sqlite_stat1 */
  15553. #define TF_WithoutRowid 0x0020 /* No rowid. PRIMARY KEY is the key */
  15554. #define TF_NoVisibleRowid 0x0040 /* No user-visible "rowid" column */
  15555. #define TF_OOOHidden 0x0080 /* Out-of-Order hidden columns */
  15556. #define TF_StatsUsed 0x0100 /* Query planner decisions affected by
  15557. ** Index.aiRowLogEst[] values */
  15558. #define TF_HasNotNull 0x0200 /* Contains NOT NULL constraints */
  15559. /*
  15560. ** Test to see whether or not a table is a virtual table. This is
  15561. ** done as a macro so that it will be optimized out when virtual
  15562. ** table support is omitted from the build.
  15563. */
  15564. #ifndef SQLITE_OMIT_VIRTUALTABLE
  15565. # define IsVirtual(X) ((X)->nModuleArg)
  15566. #else
  15567. # define IsVirtual(X) 0
  15568. #endif
  15569. /*
  15570. ** Macros to determine if a column is hidden. IsOrdinaryHiddenColumn()
  15571. ** only works for non-virtual tables (ordinary tables and views) and is
  15572. ** always false unless SQLITE_ENABLE_HIDDEN_COLUMNS is defined. The
  15573. ** IsHiddenColumn() macro is general purpose.
  15574. */
  15575. #if defined(SQLITE_ENABLE_HIDDEN_COLUMNS)
  15576. # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
  15577. # define IsOrdinaryHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
  15578. #elif !defined(SQLITE_OMIT_VIRTUALTABLE)
  15579. # define IsHiddenColumn(X) (((X)->colFlags & COLFLAG_HIDDEN)!=0)
  15580. # define IsOrdinaryHiddenColumn(X) 0
  15581. #else
  15582. # define IsHiddenColumn(X) 0
  15583. # define IsOrdinaryHiddenColumn(X) 0
  15584. #endif
  15585. /* Does the table have a rowid */
  15586. #define HasRowid(X) (((X)->tabFlags & TF_WithoutRowid)==0)
  15587. #define VisibleRowid(X) (((X)->tabFlags & TF_NoVisibleRowid)==0)
  15588. /*
  15589. ** Each foreign key constraint is an instance of the following structure.
  15590. **
  15591. ** A foreign key is associated with two tables. The "from" table is
  15592. ** the table that contains the REFERENCES clause that creates the foreign
  15593. ** key. The "to" table is the table that is named in the REFERENCES clause.
  15594. ** Consider this example:
  15595. **
  15596. ** CREATE TABLE ex1(
  15597. ** a INTEGER PRIMARY KEY,
  15598. ** b INTEGER CONSTRAINT fk1 REFERENCES ex2(x)
  15599. ** );
  15600. **
  15601. ** For foreign key "fk1", the from-table is "ex1" and the to-table is "ex2".
  15602. ** Equivalent names:
  15603. **
  15604. ** from-table == child-table
  15605. ** to-table == parent-table
  15606. **
  15607. ** Each REFERENCES clause generates an instance of the following structure
  15608. ** which is attached to the from-table. The to-table need not exist when
  15609. ** the from-table is created. The existence of the to-table is not checked.
  15610. **
  15611. ** The list of all parents for child Table X is held at X.pFKey.
  15612. **
  15613. ** A list of all children for a table named Z (which might not even exist)
  15614. ** is held in Schema.fkeyHash with a hash key of Z.
  15615. */
  15616. struct FKey {
  15617. Table *pFrom; /* Table containing the REFERENCES clause (aka: Child) */
  15618. FKey *pNextFrom; /* Next FKey with the same in pFrom. Next parent of pFrom */
  15619. char *zTo; /* Name of table that the key points to (aka: Parent) */
  15620. FKey *pNextTo; /* Next with the same zTo. Next child of zTo. */
  15621. FKey *pPrevTo; /* Previous with the same zTo */
  15622. int nCol; /* Number of columns in this key */
  15623. /* EV: R-30323-21917 */
  15624. u8 isDeferred; /* True if constraint checking is deferred till COMMIT */
  15625. u8 aAction[2]; /* ON DELETE and ON UPDATE actions, respectively */
  15626. Trigger *apTrigger[2];/* Triggers for aAction[] actions */
  15627. struct sColMap { /* Mapping of columns in pFrom to columns in zTo */
  15628. int iFrom; /* Index of column in pFrom */
  15629. char *zCol; /* Name of column in zTo. If NULL use PRIMARY KEY */
  15630. } aCol[1]; /* One entry for each of nCol columns */
  15631. };
  15632. /*
  15633. ** SQLite supports many different ways to resolve a constraint
  15634. ** error. ROLLBACK processing means that a constraint violation
  15635. ** causes the operation in process to fail and for the current transaction
  15636. ** to be rolled back. ABORT processing means the operation in process
  15637. ** fails and any prior changes from that one operation are backed out,
  15638. ** but the transaction is not rolled back. FAIL processing means that
  15639. ** the operation in progress stops and returns an error code. But prior
  15640. ** changes due to the same operation are not backed out and no rollback
  15641. ** occurs. IGNORE means that the particular row that caused the constraint
  15642. ** error is not inserted or updated. Processing continues and no error
  15643. ** is returned. REPLACE means that preexisting database rows that caused
  15644. ** a UNIQUE constraint violation are removed so that the new insert or
  15645. ** update can proceed. Processing continues and no error is reported.
  15646. **
  15647. ** RESTRICT, SETNULL, and CASCADE actions apply only to foreign keys.
  15648. ** RESTRICT is the same as ABORT for IMMEDIATE foreign keys and the
  15649. ** same as ROLLBACK for DEFERRED keys. SETNULL means that the foreign
  15650. ** key is set to NULL. CASCADE means that a DELETE or UPDATE of the
  15651. ** referenced table row is propagated into the row that holds the
  15652. ** foreign key.
  15653. **
  15654. ** The following symbolic values are used to record which type
  15655. ** of action to take.
  15656. */
  15657. #define OE_None 0 /* There is no constraint to check */
  15658. #define OE_Rollback 1 /* Fail the operation and rollback the transaction */
  15659. #define OE_Abort 2 /* Back out changes but do no rollback transaction */
  15660. #define OE_Fail 3 /* Stop the operation but leave all prior changes */
  15661. #define OE_Ignore 4 /* Ignore the error. Do not do the INSERT or UPDATE */
  15662. #define OE_Replace 5 /* Delete existing record, then do INSERT or UPDATE */
  15663. #define OE_Restrict 6 /* OE_Abort for IMMEDIATE, OE_Rollback for DEFERRED */
  15664. #define OE_SetNull 7 /* Set the foreign key value to NULL */
  15665. #define OE_SetDflt 8 /* Set the foreign key value to its default */
  15666. #define OE_Cascade 9 /* Cascade the changes */
  15667. #define OE_Default 10 /* Do whatever the default action is */
  15668. /*
  15669. ** An instance of the following structure is passed as the first
  15670. ** argument to sqlite3VdbeKeyCompare and is used to control the
  15671. ** comparison of the two index keys.
  15672. **
  15673. ** Note that aSortOrder[] and aColl[] have nField+1 slots. There
  15674. ** are nField slots for the columns of an index then one extra slot
  15675. ** for the rowid at the end.
  15676. */
  15677. struct KeyInfo {
  15678. u32 nRef; /* Number of references to this KeyInfo object */
  15679. u8 enc; /* Text encoding - one of the SQLITE_UTF* values */
  15680. u16 nKeyField; /* Number of key columns in the index */
  15681. u16 nAllField; /* Total columns, including key plus others */
  15682. sqlite3 *db; /* The database connection */
  15683. u8 *aSortOrder; /* Sort order for each column. */
  15684. CollSeq *aColl[1]; /* Collating sequence for each term of the key */
  15685. };
  15686. /*
  15687. ** This object holds a record which has been parsed out into individual
  15688. ** fields, for the purposes of doing a comparison.
  15689. **
  15690. ** A record is an object that contains one or more fields of data.
  15691. ** Records are used to store the content of a table row and to store
  15692. ** the key of an index. A blob encoding of a record is created by
  15693. ** the OP_MakeRecord opcode of the VDBE and is disassembled by the
  15694. ** OP_Column opcode.
  15695. **
  15696. ** An instance of this object serves as a "key" for doing a search on
  15697. ** an index b+tree. The goal of the search is to find the entry that
  15698. ** is closed to the key described by this object. This object might hold
  15699. ** just a prefix of the key. The number of fields is given by
  15700. ** pKeyInfo->nField.
  15701. **
  15702. ** The r1 and r2 fields are the values to return if this key is less than
  15703. ** or greater than a key in the btree, respectively. These are normally
  15704. ** -1 and +1 respectively, but might be inverted to +1 and -1 if the b-tree
  15705. ** is in DESC order.
  15706. **
  15707. ** The key comparison functions actually return default_rc when they find
  15708. ** an equals comparison. default_rc can be -1, 0, or +1. If there are
  15709. ** multiple entries in the b-tree with the same key (when only looking
  15710. ** at the first pKeyInfo->nFields,) then default_rc can be set to -1 to
  15711. ** cause the search to find the last match, or +1 to cause the search to
  15712. ** find the first match.
  15713. **
  15714. ** The key comparison functions will set eqSeen to true if they ever
  15715. ** get and equal results when comparing this structure to a b-tree record.
  15716. ** When default_rc!=0, the search might end up on the record immediately
  15717. ** before the first match or immediately after the last match. The
  15718. ** eqSeen field will indicate whether or not an exact match exists in the
  15719. ** b-tree.
  15720. */
  15721. struct UnpackedRecord {
  15722. KeyInfo *pKeyInfo; /* Collation and sort-order information */
  15723. Mem *aMem; /* Values */
  15724. u16 nField; /* Number of entries in apMem[] */
  15725. i8 default_rc; /* Comparison result if keys are equal */
  15726. u8 errCode; /* Error detected by xRecordCompare (CORRUPT or NOMEM) */
  15727. i8 r1; /* Value to return if (lhs < rhs) */
  15728. i8 r2; /* Value to return if (lhs > rhs) */
  15729. u8 eqSeen; /* True if an equality comparison has been seen */
  15730. };
  15731. /*
  15732. ** Each SQL index is represented in memory by an
  15733. ** instance of the following structure.
  15734. **
  15735. ** The columns of the table that are to be indexed are described
  15736. ** by the aiColumn[] field of this structure. For example, suppose
  15737. ** we have the following table and index:
  15738. **
  15739. ** CREATE TABLE Ex1(c1 int, c2 int, c3 text);
  15740. ** CREATE INDEX Ex2 ON Ex1(c3,c1);
  15741. **
  15742. ** In the Table structure describing Ex1, nCol==3 because there are
  15743. ** three columns in the table. In the Index structure describing
  15744. ** Ex2, nColumn==2 since 2 of the 3 columns of Ex1 are indexed.
  15745. ** The value of aiColumn is {2, 0}. aiColumn[0]==2 because the
  15746. ** first column to be indexed (c3) has an index of 2 in Ex1.aCol[].
  15747. ** The second column to be indexed (c1) has an index of 0 in
  15748. ** Ex1.aCol[], hence Ex2.aiColumn[1]==0.
  15749. **
  15750. ** The Index.onError field determines whether or not the indexed columns
  15751. ** must be unique and what to do if they are not. When Index.onError=OE_None,
  15752. ** it means this is not a unique index. Otherwise it is a unique index
  15753. ** and the value of Index.onError indicate the which conflict resolution
  15754. ** algorithm to employ whenever an attempt is made to insert a non-unique
  15755. ** element.
  15756. **
  15757. ** While parsing a CREATE TABLE or CREATE INDEX statement in order to
  15758. ** generate VDBE code (as opposed to parsing one read from an sqlite_master
  15759. ** table as part of parsing an existing database schema), transient instances
  15760. ** of this structure may be created. In this case the Index.tnum variable is
  15761. ** used to store the address of a VDBE instruction, not a database page
  15762. ** number (it cannot - the database page is not allocated until the VDBE
  15763. ** program is executed). See convertToWithoutRowidTable() for details.
  15764. */
  15765. struct Index {
  15766. char *zName; /* Name of this index */
  15767. i16 *aiColumn; /* Which columns are used by this index. 1st is 0 */
  15768. LogEst *aiRowLogEst; /* From ANALYZE: Est. rows selected by each column */
  15769. Table *pTable; /* The SQL table being indexed */
  15770. char *zColAff; /* String defining the affinity of each column */
  15771. Index *pNext; /* The next index associated with the same table */
  15772. Schema *pSchema; /* Schema containing this index */
  15773. u8 *aSortOrder; /* for each column: True==DESC, False==ASC */
  15774. const char **azColl; /* Array of collation sequence names for index */
  15775. Expr *pPartIdxWhere; /* WHERE clause for partial indices */
  15776. ExprList *aColExpr; /* Column expressions */
  15777. int tnum; /* DB Page containing root of this index */
  15778. LogEst szIdxRow; /* Estimated average row size in bytes */
  15779. u16 nKeyCol; /* Number of columns forming the key */
  15780. u16 nColumn; /* Number of columns stored in the index */
  15781. u8 onError; /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
  15782. unsigned idxType:2; /* 1==UNIQUE, 2==PRIMARY KEY, 0==CREATE INDEX */
  15783. unsigned bUnordered:1; /* Use this index for == or IN queries only */
  15784. unsigned uniqNotNull:1; /* True if UNIQUE and NOT NULL for all columns */
  15785. unsigned isResized:1; /* True if resizeIndexObject() has been called */
  15786. unsigned isCovering:1; /* True if this is a covering index */
  15787. unsigned noSkipScan:1; /* Do not try to use skip-scan if true */
  15788. unsigned hasStat1:1; /* aiRowLogEst values come from sqlite_stat1 */
  15789. unsigned bNoQuery:1; /* Do not use this index to optimize queries */
  15790. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  15791. int nSample; /* Number of elements in aSample[] */
  15792. int nSampleCol; /* Size of IndexSample.anEq[] and so on */
  15793. tRowcnt *aAvgEq; /* Average nEq values for keys not in aSample */
  15794. IndexSample *aSample; /* Samples of the left-most key */
  15795. tRowcnt *aiRowEst; /* Non-logarithmic stat1 data for this index */
  15796. tRowcnt nRowEst0; /* Non-logarithmic number of rows in the index */
  15797. #endif
  15798. };
  15799. /*
  15800. ** Allowed values for Index.idxType
  15801. */
  15802. #define SQLITE_IDXTYPE_APPDEF 0 /* Created using CREATE INDEX */
  15803. #define SQLITE_IDXTYPE_UNIQUE 1 /* Implements a UNIQUE constraint */
  15804. #define SQLITE_IDXTYPE_PRIMARYKEY 2 /* Is the PRIMARY KEY for the table */
  15805. /* Return true if index X is a PRIMARY KEY index */
  15806. #define IsPrimaryKeyIndex(X) ((X)->idxType==SQLITE_IDXTYPE_PRIMARYKEY)
  15807. /* Return true if index X is a UNIQUE index */
  15808. #define IsUniqueIndex(X) ((X)->onError!=OE_None)
  15809. /* The Index.aiColumn[] values are normally positive integer. But
  15810. ** there are some negative values that have special meaning:
  15811. */
  15812. #define XN_ROWID (-1) /* Indexed column is the rowid */
  15813. #define XN_EXPR (-2) /* Indexed column is an expression */
  15814. /*
  15815. ** Each sample stored in the sqlite_stat3 table is represented in memory
  15816. ** using a structure of this type. See documentation at the top of the
  15817. ** analyze.c source file for additional information.
  15818. */
  15819. struct IndexSample {
  15820. void *p; /* Pointer to sampled record */
  15821. int n; /* Size of record in bytes */
  15822. tRowcnt *anEq; /* Est. number of rows where the key equals this sample */
  15823. tRowcnt *anLt; /* Est. number of rows where key is less than this sample */
  15824. tRowcnt *anDLt; /* Est. number of distinct keys less than this sample */
  15825. };
  15826. /*
  15827. ** Each token coming out of the lexer is an instance of
  15828. ** this structure. Tokens are also used as part of an expression.
  15829. **
  15830. ** Note if Token.z==0 then Token.dyn and Token.n are undefined and
  15831. ** may contain random values. Do not make any assumptions about Token.dyn
  15832. ** and Token.n when Token.z==0.
  15833. */
  15834. struct Token {
  15835. const char *z; /* Text of the token. Not NULL-terminated! */
  15836. unsigned int n; /* Number of characters in this token */
  15837. };
  15838. /*
  15839. ** An instance of this structure contains information needed to generate
  15840. ** code for a SELECT that contains aggregate functions.
  15841. **
  15842. ** If Expr.op==TK_AGG_COLUMN or TK_AGG_FUNCTION then Expr.pAggInfo is a
  15843. ** pointer to this structure. The Expr.iColumn field is the index in
  15844. ** AggInfo.aCol[] or AggInfo.aFunc[] of information needed to generate
  15845. ** code for that node.
  15846. **
  15847. ** AggInfo.pGroupBy and AggInfo.aFunc.pExpr point to fields within the
  15848. ** original Select structure that describes the SELECT statement. These
  15849. ** fields do not need to be freed when deallocating the AggInfo structure.
  15850. */
  15851. struct AggInfo {
  15852. u8 directMode; /* Direct rendering mode means take data directly
  15853. ** from source tables rather than from accumulators */
  15854. u8 useSortingIdx; /* In direct mode, reference the sorting index rather
  15855. ** than the source table */
  15856. int sortingIdx; /* Cursor number of the sorting index */
  15857. int sortingIdxPTab; /* Cursor number of pseudo-table */
  15858. int nSortingColumn; /* Number of columns in the sorting index */
  15859. int mnReg, mxReg; /* Range of registers allocated for aCol and aFunc */
  15860. ExprList *pGroupBy; /* The group by clause */
  15861. struct AggInfo_col { /* For each column used in source tables */
  15862. Table *pTab; /* Source table */
  15863. int iTable; /* Cursor number of the source table */
  15864. int iColumn; /* Column number within the source table */
  15865. int iSorterColumn; /* Column number in the sorting index */
  15866. int iMem; /* Memory location that acts as accumulator */
  15867. Expr *pExpr; /* The original expression */
  15868. } *aCol;
  15869. int nColumn; /* Number of used entries in aCol[] */
  15870. int nAccumulator; /* Number of columns that show through to the output.
  15871. ** Additional columns are used only as parameters to
  15872. ** aggregate functions */
  15873. struct AggInfo_func { /* For each aggregate function */
  15874. Expr *pExpr; /* Expression encoding the function */
  15875. FuncDef *pFunc; /* The aggregate function implementation */
  15876. int iMem; /* Memory location that acts as accumulator */
  15877. int iDistinct; /* Ephemeral table used to enforce DISTINCT */
  15878. } *aFunc;
  15879. int nFunc; /* Number of entries in aFunc[] */
  15880. };
  15881. /*
  15882. ** The datatype ynVar is a signed integer, either 16-bit or 32-bit.
  15883. ** Usually it is 16-bits. But if SQLITE_MAX_VARIABLE_NUMBER is greater
  15884. ** than 32767 we have to make it 32-bit. 16-bit is preferred because
  15885. ** it uses less memory in the Expr object, which is a big memory user
  15886. ** in systems with lots of prepared statements. And few applications
  15887. ** need more than about 10 or 20 variables. But some extreme users want
  15888. ** to have prepared statements with over 32767 variables, and for them
  15889. ** the option is available (at compile-time).
  15890. */
  15891. #if SQLITE_MAX_VARIABLE_NUMBER<=32767
  15892. typedef i16 ynVar;
  15893. #else
  15894. typedef int ynVar;
  15895. #endif
  15896. /*
  15897. ** Each node of an expression in the parse tree is an instance
  15898. ** of this structure.
  15899. **
  15900. ** Expr.op is the opcode. The integer parser token codes are reused
  15901. ** as opcodes here. For example, the parser defines TK_GE to be an integer
  15902. ** code representing the ">=" operator. This same integer code is reused
  15903. ** to represent the greater-than-or-equal-to operator in the expression
  15904. ** tree.
  15905. **
  15906. ** If the expression is an SQL literal (TK_INTEGER, TK_FLOAT, TK_BLOB,
  15907. ** or TK_STRING), then Expr.token contains the text of the SQL literal. If
  15908. ** the expression is a variable (TK_VARIABLE), then Expr.token contains the
  15909. ** variable name. Finally, if the expression is an SQL function (TK_FUNCTION),
  15910. ** then Expr.token contains the name of the function.
  15911. **
  15912. ** Expr.pRight and Expr.pLeft are the left and right subexpressions of a
  15913. ** binary operator. Either or both may be NULL.
  15914. **
  15915. ** Expr.x.pList is a list of arguments if the expression is an SQL function,
  15916. ** a CASE expression or an IN expression of the form "<lhs> IN (<y>, <z>...)".
  15917. ** Expr.x.pSelect is used if the expression is a sub-select or an expression of
  15918. ** the form "<lhs> IN (SELECT ...)". If the EP_xIsSelect bit is set in the
  15919. ** Expr.flags mask, then Expr.x.pSelect is valid. Otherwise, Expr.x.pList is
  15920. ** valid.
  15921. **
  15922. ** An expression of the form ID or ID.ID refers to a column in a table.
  15923. ** For such expressions, Expr.op is set to TK_COLUMN and Expr.iTable is
  15924. ** the integer cursor number of a VDBE cursor pointing to that table and
  15925. ** Expr.iColumn is the column number for the specific column. If the
  15926. ** expression is used as a result in an aggregate SELECT, then the
  15927. ** value is also stored in the Expr.iAgg column in the aggregate so that
  15928. ** it can be accessed after all aggregates are computed.
  15929. **
  15930. ** If the expression is an unbound variable marker (a question mark
  15931. ** character '?' in the original SQL) then the Expr.iTable holds the index
  15932. ** number for that variable.
  15933. **
  15934. ** If the expression is a subquery then Expr.iColumn holds an integer
  15935. ** register number containing the result of the subquery. If the
  15936. ** subquery gives a constant result, then iTable is -1. If the subquery
  15937. ** gives a different answer at different times during statement processing
  15938. ** then iTable is the address of a subroutine that computes the subquery.
  15939. **
  15940. ** If the Expr is of type OP_Column, and the table it is selecting from
  15941. ** is a disk table or the "old.*" pseudo-table, then pTab points to the
  15942. ** corresponding table definition.
  15943. **
  15944. ** ALLOCATION NOTES:
  15945. **
  15946. ** Expr objects can use a lot of memory space in database schema. To
  15947. ** help reduce memory requirements, sometimes an Expr object will be
  15948. ** truncated. And to reduce the number of memory allocations, sometimes
  15949. ** two or more Expr objects will be stored in a single memory allocation,
  15950. ** together with Expr.zToken strings.
  15951. **
  15952. ** If the EP_Reduced and EP_TokenOnly flags are set when
  15953. ** an Expr object is truncated. When EP_Reduced is set, then all
  15954. ** the child Expr objects in the Expr.pLeft and Expr.pRight subtrees
  15955. ** are contained within the same memory allocation. Note, however, that
  15956. ** the subtrees in Expr.x.pList or Expr.x.pSelect are always separately
  15957. ** allocated, regardless of whether or not EP_Reduced is set.
  15958. */
  15959. struct Expr {
  15960. u8 op; /* Operation performed by this node */
  15961. char affinity; /* The affinity of the column or 0 if not a column */
  15962. u32 flags; /* Various flags. EP_* See below */
  15963. union {
  15964. char *zToken; /* Token value. Zero terminated and dequoted */
  15965. int iValue; /* Non-negative integer value if EP_IntValue */
  15966. } u;
  15967. /* If the EP_TokenOnly flag is set in the Expr.flags mask, then no
  15968. ** space is allocated for the fields below this point. An attempt to
  15969. ** access them will result in a segfault or malfunction.
  15970. *********************************************************************/
  15971. Expr *pLeft; /* Left subnode */
  15972. Expr *pRight; /* Right subnode */
  15973. union {
  15974. ExprList *pList; /* op = IN, EXISTS, SELECT, CASE, FUNCTION, BETWEEN */
  15975. Select *pSelect; /* EP_xIsSelect and op = IN, EXISTS, SELECT */
  15976. } x;
  15977. /* If the EP_Reduced flag is set in the Expr.flags mask, then no
  15978. ** space is allocated for the fields below this point. An attempt to
  15979. ** access them will result in a segfault or malfunction.
  15980. *********************************************************************/
  15981. #if SQLITE_MAX_EXPR_DEPTH>0
  15982. int nHeight; /* Height of the tree headed by this node */
  15983. #endif
  15984. int iTable; /* TK_COLUMN: cursor number of table holding column
  15985. ** TK_REGISTER: register number
  15986. ** TK_TRIGGER: 1 -> new, 0 -> old
  15987. ** EP_Unlikely: 134217728 times likelihood
  15988. ** TK_SELECT: 1st register of result vector */
  15989. ynVar iColumn; /* TK_COLUMN: column index. -1 for rowid.
  15990. ** TK_VARIABLE: variable number (always >= 1).
  15991. ** TK_SELECT_COLUMN: column of the result vector */
  15992. i16 iAgg; /* Which entry in pAggInfo->aCol[] or ->aFunc[] */
  15993. i16 iRightJoinTable; /* If EP_FromJoin, the right table of the join */
  15994. u8 op2; /* TK_REGISTER: original value of Expr.op
  15995. ** TK_COLUMN: the value of p5 for OP_Column
  15996. ** TK_AGG_FUNCTION: nesting depth */
  15997. AggInfo *pAggInfo; /* Used by TK_AGG_COLUMN and TK_AGG_FUNCTION */
  15998. Table *pTab; /* Table for TK_COLUMN expressions. Can be NULL
  15999. ** for a column of an index on an expression */
  16000. };
  16001. /*
  16002. ** The following are the meanings of bits in the Expr.flags field.
  16003. */
  16004. #define EP_FromJoin 0x000001 /* Originates in ON/USING clause of outer join */
  16005. #define EP_Agg 0x000002 /* Contains one or more aggregate functions */
  16006. #define EP_HasFunc 0x000004 /* Contains one or more functions of any kind */
  16007. /* 0x000008 // available for use */
  16008. #define EP_Distinct 0x000010 /* Aggregate function with DISTINCT keyword */
  16009. #define EP_VarSelect 0x000020 /* pSelect is correlated, not constant */
  16010. #define EP_DblQuoted 0x000040 /* token.z was originally in "..." */
  16011. #define EP_InfixFunc 0x000080 /* True for an infix function: LIKE, GLOB, etc */
  16012. #define EP_Collate 0x000100 /* Tree contains a TK_COLLATE operator */
  16013. #define EP_Generic 0x000200 /* Ignore COLLATE or affinity on this tree */
  16014. #define EP_IntValue 0x000400 /* Integer value contained in u.iValue */
  16015. #define EP_xIsSelect 0x000800 /* x.pSelect is valid (otherwise x.pList is) */
  16016. #define EP_Skip 0x001000 /* COLLATE, AS, or UNLIKELY */
  16017. #define EP_Reduced 0x002000 /* Expr struct EXPR_REDUCEDSIZE bytes only */
  16018. #define EP_TokenOnly 0x004000 /* Expr struct EXPR_TOKENONLYSIZE bytes only */
  16019. #define EP_Static 0x008000 /* Held in memory not obtained from malloc() */
  16020. #define EP_MemToken 0x010000 /* Need to sqlite3DbFree() Expr.zToken */
  16021. #define EP_NoReduce 0x020000 /* Cannot EXPRDUP_REDUCE this Expr */
  16022. #define EP_Unlikely 0x040000 /* unlikely() or likelihood() function */
  16023. #define EP_ConstFunc 0x080000 /* A SQLITE_FUNC_CONSTANT or _SLOCHNG function */
  16024. #define EP_CanBeNull 0x100000 /* Can be null despite NOT NULL constraint */
  16025. #define EP_Subquery 0x200000 /* Tree contains a TK_SELECT operator */
  16026. #define EP_Alias 0x400000 /* Is an alias for a result set column */
  16027. #define EP_Leaf 0x800000 /* Expr.pLeft, .pRight, .u.pSelect all NULL */
  16028. /*
  16029. ** The EP_Propagate mask is a set of properties that automatically propagate
  16030. ** upwards into parent nodes.
  16031. */
  16032. #define EP_Propagate (EP_Collate|EP_Subquery|EP_HasFunc)
  16033. /*
  16034. ** These macros can be used to test, set, or clear bits in the
  16035. ** Expr.flags field.
  16036. */
  16037. #define ExprHasProperty(E,P) (((E)->flags&(P))!=0)
  16038. #define ExprHasAllProperty(E,P) (((E)->flags&(P))==(P))
  16039. #define ExprSetProperty(E,P) (E)->flags|=(P)
  16040. #define ExprClearProperty(E,P) (E)->flags&=~(P)
  16041. /* The ExprSetVVAProperty() macro is used for Verification, Validation,
  16042. ** and Accreditation only. It works like ExprSetProperty() during VVA
  16043. ** processes but is a no-op for delivery.
  16044. */
  16045. #ifdef SQLITE_DEBUG
  16046. # define ExprSetVVAProperty(E,P) (E)->flags|=(P)
  16047. #else
  16048. # define ExprSetVVAProperty(E,P)
  16049. #endif
  16050. /*
  16051. ** Macros to determine the number of bytes required by a normal Expr
  16052. ** struct, an Expr struct with the EP_Reduced flag set in Expr.flags
  16053. ** and an Expr struct with the EP_TokenOnly flag set.
  16054. */
  16055. #define EXPR_FULLSIZE sizeof(Expr) /* Full size */
  16056. #define EXPR_REDUCEDSIZE offsetof(Expr,iTable) /* Common features */
  16057. #define EXPR_TOKENONLYSIZE offsetof(Expr,pLeft) /* Fewer features */
  16058. /*
  16059. ** Flags passed to the sqlite3ExprDup() function. See the header comment
  16060. ** above sqlite3ExprDup() for details.
  16061. */
  16062. #define EXPRDUP_REDUCE 0x0001 /* Used reduced-size Expr nodes */
  16063. /*
  16064. ** A list of expressions. Each expression may optionally have a
  16065. ** name. An expr/name combination can be used in several ways, such
  16066. ** as the list of "expr AS ID" fields following a "SELECT" or in the
  16067. ** list of "ID = expr" items in an UPDATE. A list of expressions can
  16068. ** also be used as the argument to a function, in which case the a.zName
  16069. ** field is not used.
  16070. **
  16071. ** By default the Expr.zSpan field holds a human-readable description of
  16072. ** the expression that is used in the generation of error messages and
  16073. ** column labels. In this case, Expr.zSpan is typically the text of a
  16074. ** column expression as it exists in a SELECT statement. However, if
  16075. ** the bSpanIsTab flag is set, then zSpan is overloaded to mean the name
  16076. ** of the result column in the form: DATABASE.TABLE.COLUMN. This later
  16077. ** form is used for name resolution with nested FROM clauses.
  16078. */
  16079. struct ExprList {
  16080. int nExpr; /* Number of expressions on the list */
  16081. struct ExprList_item { /* For each expression in the list */
  16082. Expr *pExpr; /* The parse tree for this expression */
  16083. char *zName; /* Token associated with this expression */
  16084. char *zSpan; /* Original text of the expression */
  16085. u8 sortOrder; /* 1 for DESC or 0 for ASC */
  16086. unsigned done :1; /* A flag to indicate when processing is finished */
  16087. unsigned bSpanIsTab :1; /* zSpan holds DB.TABLE.COLUMN */
  16088. unsigned reusable :1; /* Constant expression is reusable */
  16089. union {
  16090. struct {
  16091. u16 iOrderByCol; /* For ORDER BY, column number in result set */
  16092. u16 iAlias; /* Index into Parse.aAlias[] for zName */
  16093. } x;
  16094. int iConstExprReg; /* Register in which Expr value is cached */
  16095. } u;
  16096. } a[1]; /* One slot for each expression in the list */
  16097. };
  16098. /*
  16099. ** An instance of this structure can hold a simple list of identifiers,
  16100. ** such as the list "a,b,c" in the following statements:
  16101. **
  16102. ** INSERT INTO t(a,b,c) VALUES ...;
  16103. ** CREATE INDEX idx ON t(a,b,c);
  16104. ** CREATE TRIGGER trig BEFORE UPDATE ON t(a,b,c) ...;
  16105. **
  16106. ** The IdList.a.idx field is used when the IdList represents the list of
  16107. ** column names after a table name in an INSERT statement. In the statement
  16108. **
  16109. ** INSERT INTO t(a,b,c) ...
  16110. **
  16111. ** If "a" is the k-th column of table "t", then IdList.a[0].idx==k.
  16112. */
  16113. struct IdList {
  16114. struct IdList_item {
  16115. char *zName; /* Name of the identifier */
  16116. int idx; /* Index in some Table.aCol[] of a column named zName */
  16117. } *a;
  16118. int nId; /* Number of identifiers on the list */
  16119. };
  16120. /*
  16121. ** The bitmask datatype defined below is used for various optimizations.
  16122. **
  16123. ** Changing this from a 64-bit to a 32-bit type limits the number of
  16124. ** tables in a join to 32 instead of 64. But it also reduces the size
  16125. ** of the library by 738 bytes on ix86.
  16126. */
  16127. #ifdef SQLITE_BITMASK_TYPE
  16128. typedef SQLITE_BITMASK_TYPE Bitmask;
  16129. #else
  16130. typedef u64 Bitmask;
  16131. #endif
  16132. /*
  16133. ** The number of bits in a Bitmask. "BMS" means "BitMask Size".
  16134. */
  16135. #define BMS ((int)(sizeof(Bitmask)*8))
  16136. /*
  16137. ** A bit in a Bitmask
  16138. */
  16139. #define MASKBIT(n) (((Bitmask)1)<<(n))
  16140. #define MASKBIT32(n) (((unsigned int)1)<<(n))
  16141. #define ALLBITS ((Bitmask)-1)
  16142. /*
  16143. ** The following structure describes the FROM clause of a SELECT statement.
  16144. ** Each table or subquery in the FROM clause is a separate element of
  16145. ** the SrcList.a[] array.
  16146. **
  16147. ** With the addition of multiple database support, the following structure
  16148. ** can also be used to describe a particular table such as the table that
  16149. ** is modified by an INSERT, DELETE, or UPDATE statement. In standard SQL,
  16150. ** such a table must be a simple name: ID. But in SQLite, the table can
  16151. ** now be identified by a database name, a dot, then the table name: ID.ID.
  16152. **
  16153. ** The jointype starts out showing the join type between the current table
  16154. ** and the next table on the list. The parser builds the list this way.
  16155. ** But sqlite3SrcListShiftJoinType() later shifts the jointypes so that each
  16156. ** jointype expresses the join between the table and the previous table.
  16157. **
  16158. ** In the colUsed field, the high-order bit (bit 63) is set if the table
  16159. ** contains more than 63 columns and the 64-th or later column is used.
  16160. */
  16161. struct SrcList {
  16162. int nSrc; /* Number of tables or subqueries in the FROM clause */
  16163. u32 nAlloc; /* Number of entries allocated in a[] below */
  16164. struct SrcList_item {
  16165. Schema *pSchema; /* Schema to which this item is fixed */
  16166. char *zDatabase; /* Name of database holding this table */
  16167. char *zName; /* Name of the table */
  16168. char *zAlias; /* The "B" part of a "A AS B" phrase. zName is the "A" */
  16169. Table *pTab; /* An SQL table corresponding to zName */
  16170. Select *pSelect; /* A SELECT statement used in place of a table name */
  16171. int addrFillSub; /* Address of subroutine to manifest a subquery */
  16172. int regReturn; /* Register holding return address of addrFillSub */
  16173. int regResult; /* Registers holding results of a co-routine */
  16174. struct {
  16175. u8 jointype; /* Type of join between this table and the previous */
  16176. unsigned notIndexed :1; /* True if there is a NOT INDEXED clause */
  16177. unsigned isIndexedBy :1; /* True if there is an INDEXED BY clause */
  16178. unsigned isTabFunc :1; /* True if table-valued-function syntax */
  16179. unsigned isCorrelated :1; /* True if sub-query is correlated */
  16180. unsigned viaCoroutine :1; /* Implemented as a co-routine */
  16181. unsigned isRecursive :1; /* True for recursive reference in WITH */
  16182. } fg;
  16183. #ifndef SQLITE_OMIT_EXPLAIN
  16184. u8 iSelectId; /* If pSelect!=0, the id of the sub-select in EQP */
  16185. #endif
  16186. int iCursor; /* The VDBE cursor number used to access this table */
  16187. Expr *pOn; /* The ON clause of a join */
  16188. IdList *pUsing; /* The USING clause of a join */
  16189. Bitmask colUsed; /* Bit N (1<<N) set if column N of pTab is used */
  16190. union {
  16191. char *zIndexedBy; /* Identifier from "INDEXED BY <zIndex>" clause */
  16192. ExprList *pFuncArg; /* Arguments to table-valued-function */
  16193. } u1;
  16194. Index *pIBIndex; /* Index structure corresponding to u1.zIndexedBy */
  16195. } a[1]; /* One entry for each identifier on the list */
  16196. };
  16197. /*
  16198. ** Permitted values of the SrcList.a.jointype field
  16199. */
  16200. #define JT_INNER 0x0001 /* Any kind of inner or cross join */
  16201. #define JT_CROSS 0x0002 /* Explicit use of the CROSS keyword */
  16202. #define JT_NATURAL 0x0004 /* True for a "natural" join */
  16203. #define JT_LEFT 0x0008 /* Left outer join */
  16204. #define JT_RIGHT 0x0010 /* Right outer join */
  16205. #define JT_OUTER 0x0020 /* The "OUTER" keyword is present */
  16206. #define JT_ERROR 0x0040 /* unknown or unsupported join type */
  16207. /*
  16208. ** Flags appropriate for the wctrlFlags parameter of sqlite3WhereBegin()
  16209. ** and the WhereInfo.wctrlFlags member.
  16210. **
  16211. ** Value constraints (enforced via assert()):
  16212. ** WHERE_USE_LIMIT == SF_FixedLimit
  16213. */
  16214. #define WHERE_ORDERBY_NORMAL 0x0000 /* No-op */
  16215. #define WHERE_ORDERBY_MIN 0x0001 /* ORDER BY processing for min() func */
  16216. #define WHERE_ORDERBY_MAX 0x0002 /* ORDER BY processing for max() func */
  16217. #define WHERE_ONEPASS_DESIRED 0x0004 /* Want to do one-pass UPDATE/DELETE */
  16218. #define WHERE_ONEPASS_MULTIROW 0x0008 /* ONEPASS is ok with multiple rows */
  16219. #define WHERE_DUPLICATES_OK 0x0010 /* Ok to return a row more than once */
  16220. #define WHERE_OR_SUBCLAUSE 0x0020 /* Processing a sub-WHERE as part of
  16221. ** the OR optimization */
  16222. #define WHERE_GROUPBY 0x0040 /* pOrderBy is really a GROUP BY */
  16223. #define WHERE_DISTINCTBY 0x0080 /* pOrderby is really a DISTINCT clause */
  16224. #define WHERE_WANT_DISTINCT 0x0100 /* All output needs to be distinct */
  16225. #define WHERE_SORTBYGROUP 0x0200 /* Support sqlite3WhereIsSorted() */
  16226. #define WHERE_SEEK_TABLE 0x0400 /* Do not defer seeks on main table */
  16227. #define WHERE_ORDERBY_LIMIT 0x0800 /* ORDERBY+LIMIT on the inner loop */
  16228. #define WHERE_SEEK_UNIQ_TABLE 0x1000 /* Do not defer seeks if unique */
  16229. /* 0x2000 not currently used */
  16230. #define WHERE_USE_LIMIT 0x4000 /* Use the LIMIT in cost estimates */
  16231. /* 0x8000 not currently used */
  16232. /* Allowed return values from sqlite3WhereIsDistinct()
  16233. */
  16234. #define WHERE_DISTINCT_NOOP 0 /* DISTINCT keyword not used */
  16235. #define WHERE_DISTINCT_UNIQUE 1 /* No duplicates */
  16236. #define WHERE_DISTINCT_ORDERED 2 /* All duplicates are adjacent */
  16237. #define WHERE_DISTINCT_UNORDERED 3 /* Duplicates are scattered */
  16238. /*
  16239. ** A NameContext defines a context in which to resolve table and column
  16240. ** names. The context consists of a list of tables (the pSrcList) field and
  16241. ** a list of named expression (pEList). The named expression list may
  16242. ** be NULL. The pSrc corresponds to the FROM clause of a SELECT or
  16243. ** to the table being operated on by INSERT, UPDATE, or DELETE. The
  16244. ** pEList corresponds to the result set of a SELECT and is NULL for
  16245. ** other statements.
  16246. **
  16247. ** NameContexts can be nested. When resolving names, the inner-most
  16248. ** context is searched first. If no match is found, the next outer
  16249. ** context is checked. If there is still no match, the next context
  16250. ** is checked. This process continues until either a match is found
  16251. ** or all contexts are check. When a match is found, the nRef member of
  16252. ** the context containing the match is incremented.
  16253. **
  16254. ** Each subquery gets a new NameContext. The pNext field points to the
  16255. ** NameContext in the parent query. Thus the process of scanning the
  16256. ** NameContext list corresponds to searching through successively outer
  16257. ** subqueries looking for a match.
  16258. */
  16259. struct NameContext {
  16260. Parse *pParse; /* The parser */
  16261. SrcList *pSrcList; /* One or more tables used to resolve names */
  16262. ExprList *pEList; /* Optional list of result-set columns */
  16263. AggInfo *pAggInfo; /* Information about aggregates at this level */
  16264. NameContext *pNext; /* Next outer name context. NULL for outermost */
  16265. int nRef; /* Number of names resolved by this context */
  16266. int nErr; /* Number of errors encountered while resolving names */
  16267. u16 ncFlags; /* Zero or more NC_* flags defined below */
  16268. };
  16269. /*
  16270. ** Allowed values for the NameContext, ncFlags field.
  16271. **
  16272. ** Value constraints (all checked via assert()):
  16273. ** NC_HasAgg == SF_HasAgg
  16274. ** NC_MinMaxAgg == SF_MinMaxAgg == SQLITE_FUNC_MINMAX
  16275. **
  16276. */
  16277. #define NC_AllowAgg 0x0001 /* Aggregate functions are allowed here */
  16278. #define NC_PartIdx 0x0002 /* True if resolving a partial index WHERE */
  16279. #define NC_IsCheck 0x0004 /* True if resolving names in a CHECK constraint */
  16280. #define NC_InAggFunc 0x0008 /* True if analyzing arguments to an agg func */
  16281. #define NC_HasAgg 0x0010 /* One or more aggregate functions seen */
  16282. #define NC_IdxExpr 0x0020 /* True if resolving columns of CREATE INDEX */
  16283. #define NC_VarSelect 0x0040 /* A correlated subquery has been seen */
  16284. #define NC_MinMaxAgg 0x1000 /* min/max aggregates seen. See note above */
  16285. #define NC_Complex 0x2000 /* True if a function or subquery seen */
  16286. /*
  16287. ** An instance of the following structure contains all information
  16288. ** needed to generate code for a single SELECT statement.
  16289. **
  16290. ** nLimit is set to -1 if there is no LIMIT clause. nOffset is set to 0.
  16291. ** If there is a LIMIT clause, the parser sets nLimit to the value of the
  16292. ** limit and nOffset to the value of the offset (or 0 if there is not
  16293. ** offset). But later on, nLimit and nOffset become the memory locations
  16294. ** in the VDBE that record the limit and offset counters.
  16295. **
  16296. ** addrOpenEphm[] entries contain the address of OP_OpenEphemeral opcodes.
  16297. ** These addresses must be stored so that we can go back and fill in
  16298. ** the P4_KEYINFO and P2 parameters later. Neither the KeyInfo nor
  16299. ** the number of columns in P2 can be computed at the same time
  16300. ** as the OP_OpenEphm instruction is coded because not
  16301. ** enough information about the compound query is known at that point.
  16302. ** The KeyInfo for addrOpenTran[0] and [1] contains collating sequences
  16303. ** for the result set. The KeyInfo for addrOpenEphm[2] contains collating
  16304. ** sequences for the ORDER BY clause.
  16305. */
  16306. struct Select {
  16307. ExprList *pEList; /* The fields of the result */
  16308. u8 op; /* One of: TK_UNION TK_ALL TK_INTERSECT TK_EXCEPT */
  16309. LogEst nSelectRow; /* Estimated number of result rows */
  16310. u32 selFlags; /* Various SF_* values */
  16311. int iLimit, iOffset; /* Memory registers holding LIMIT & OFFSET counters */
  16312. #if SELECTTRACE_ENABLED
  16313. char zSelName[12]; /* Symbolic name of this SELECT use for debugging */
  16314. #endif
  16315. int addrOpenEphm[2]; /* OP_OpenEphem opcodes related to this select */
  16316. SrcList *pSrc; /* The FROM clause */
  16317. Expr *pWhere; /* The WHERE clause */
  16318. ExprList *pGroupBy; /* The GROUP BY clause */
  16319. Expr *pHaving; /* The HAVING clause */
  16320. ExprList *pOrderBy; /* The ORDER BY clause */
  16321. Select *pPrior; /* Prior select in a compound select statement */
  16322. Select *pNext; /* Next select to the left in a compound */
  16323. Expr *pLimit; /* LIMIT expression. NULL means not used. */
  16324. With *pWith; /* WITH clause attached to this select. Or NULL. */
  16325. };
  16326. /*
  16327. ** Allowed values for Select.selFlags. The "SF" prefix stands for
  16328. ** "Select Flag".
  16329. **
  16330. ** Value constraints (all checked via assert())
  16331. ** SF_HasAgg == NC_HasAgg
  16332. ** SF_MinMaxAgg == NC_MinMaxAgg == SQLITE_FUNC_MINMAX
  16333. ** SF_FixedLimit == WHERE_USE_LIMIT
  16334. */
  16335. #define SF_Distinct 0x00001 /* Output should be DISTINCT */
  16336. #define SF_All 0x00002 /* Includes the ALL keyword */
  16337. #define SF_Resolved 0x00004 /* Identifiers have been resolved */
  16338. #define SF_Aggregate 0x00008 /* Contains agg functions or a GROUP BY */
  16339. #define SF_HasAgg 0x00010 /* Contains aggregate functions */
  16340. #define SF_UsesEphemeral 0x00020 /* Uses the OpenEphemeral opcode */
  16341. #define SF_Expanded 0x00040 /* sqlite3SelectExpand() called on this */
  16342. #define SF_HasTypeInfo 0x00080 /* FROM subqueries have Table metadata */
  16343. #define SF_Compound 0x00100 /* Part of a compound query */
  16344. #define SF_Values 0x00200 /* Synthesized from VALUES clause */
  16345. #define SF_MultiValue 0x00400 /* Single VALUES term with multiple rows */
  16346. #define SF_NestedFrom 0x00800 /* Part of a parenthesized FROM clause */
  16347. #define SF_MinMaxAgg 0x01000 /* Aggregate containing min() or max() */
  16348. #define SF_Recursive 0x02000 /* The recursive part of a recursive CTE */
  16349. #define SF_FixedLimit 0x04000 /* nSelectRow set by a constant LIMIT */
  16350. #define SF_MaybeConvert 0x08000 /* Need convertCompoundSelectToSubquery() */
  16351. #define SF_Converted 0x10000 /* By convertCompoundSelectToSubquery() */
  16352. #define SF_IncludeHidden 0x20000 /* Include hidden columns in output */
  16353. #define SF_ComplexResult 0x40000 /* Result set contains subquery or function */
  16354. /*
  16355. ** The results of a SELECT can be distributed in several ways, as defined
  16356. ** by one of the following macros. The "SRT" prefix means "SELECT Result
  16357. ** Type".
  16358. **
  16359. ** SRT_Union Store results as a key in a temporary index
  16360. ** identified by pDest->iSDParm.
  16361. **
  16362. ** SRT_Except Remove results from the temporary index pDest->iSDParm.
  16363. **
  16364. ** SRT_Exists Store a 1 in memory cell pDest->iSDParm if the result
  16365. ** set is not empty.
  16366. **
  16367. ** SRT_Discard Throw the results away. This is used by SELECT
  16368. ** statements within triggers whose only purpose is
  16369. ** the side-effects of functions.
  16370. **
  16371. ** All of the above are free to ignore their ORDER BY clause. Those that
  16372. ** follow must honor the ORDER BY clause.
  16373. **
  16374. ** SRT_Output Generate a row of output (using the OP_ResultRow
  16375. ** opcode) for each row in the result set.
  16376. **
  16377. ** SRT_Mem Only valid if the result is a single column.
  16378. ** Store the first column of the first result row
  16379. ** in register pDest->iSDParm then abandon the rest
  16380. ** of the query. This destination implies "LIMIT 1".
  16381. **
  16382. ** SRT_Set The result must be a single column. Store each
  16383. ** row of result as the key in table pDest->iSDParm.
  16384. ** Apply the affinity pDest->affSdst before storing
  16385. ** results. Used to implement "IN (SELECT ...)".
  16386. **
  16387. ** SRT_EphemTab Create an temporary table pDest->iSDParm and store
  16388. ** the result there. The cursor is left open after
  16389. ** returning. This is like SRT_Table except that
  16390. ** this destination uses OP_OpenEphemeral to create
  16391. ** the table first.
  16392. **
  16393. ** SRT_Coroutine Generate a co-routine that returns a new row of
  16394. ** results each time it is invoked. The entry point
  16395. ** of the co-routine is stored in register pDest->iSDParm
  16396. ** and the result row is stored in pDest->nDest registers
  16397. ** starting with pDest->iSdst.
  16398. **
  16399. ** SRT_Table Store results in temporary table pDest->iSDParm.
  16400. ** SRT_Fifo This is like SRT_EphemTab except that the table
  16401. ** is assumed to already be open. SRT_Fifo has
  16402. ** the additional property of being able to ignore
  16403. ** the ORDER BY clause.
  16404. **
  16405. ** SRT_DistFifo Store results in a temporary table pDest->iSDParm.
  16406. ** But also use temporary table pDest->iSDParm+1 as
  16407. ** a record of all prior results and ignore any duplicate
  16408. ** rows. Name means: "Distinct Fifo".
  16409. **
  16410. ** SRT_Queue Store results in priority queue pDest->iSDParm (really
  16411. ** an index). Append a sequence number so that all entries
  16412. ** are distinct.
  16413. **
  16414. ** SRT_DistQueue Store results in priority queue pDest->iSDParm only if
  16415. ** the same record has never been stored before. The
  16416. ** index at pDest->iSDParm+1 hold all prior stores.
  16417. */
  16418. #define SRT_Union 1 /* Store result as keys in an index */
  16419. #define SRT_Except 2 /* Remove result from a UNION index */
  16420. #define SRT_Exists 3 /* Store 1 if the result is not empty */
  16421. #define SRT_Discard 4 /* Do not save the results anywhere */
  16422. #define SRT_Fifo 5 /* Store result as data with an automatic rowid */
  16423. #define SRT_DistFifo 6 /* Like SRT_Fifo, but unique results only */
  16424. #define SRT_Queue 7 /* Store result in an queue */
  16425. #define SRT_DistQueue 8 /* Like SRT_Queue, but unique results only */
  16426. /* The ORDER BY clause is ignored for all of the above */
  16427. #define IgnorableOrderby(X) ((X->eDest)<=SRT_DistQueue)
  16428. #define SRT_Output 9 /* Output each row of result */
  16429. #define SRT_Mem 10 /* Store result in a memory cell */
  16430. #define SRT_Set 11 /* Store results as keys in an index */
  16431. #define SRT_EphemTab 12 /* Create transient tab and store like SRT_Table */
  16432. #define SRT_Coroutine 13 /* Generate a single row of result */
  16433. #define SRT_Table 14 /* Store result as data with an automatic rowid */
  16434. /*
  16435. ** An instance of this object describes where to put of the results of
  16436. ** a SELECT statement.
  16437. */
  16438. struct SelectDest {
  16439. u8 eDest; /* How to dispose of the results. On of SRT_* above. */
  16440. int iSDParm; /* A parameter used by the eDest disposal method */
  16441. int iSdst; /* Base register where results are written */
  16442. int nSdst; /* Number of registers allocated */
  16443. char *zAffSdst; /* Affinity used when eDest==SRT_Set */
  16444. ExprList *pOrderBy; /* Key columns for SRT_Queue and SRT_DistQueue */
  16445. };
  16446. /*
  16447. ** During code generation of statements that do inserts into AUTOINCREMENT
  16448. ** tables, the following information is attached to the Table.u.autoInc.p
  16449. ** pointer of each autoincrement table to record some side information that
  16450. ** the code generator needs. We have to keep per-table autoincrement
  16451. ** information in case inserts are done within triggers. Triggers do not
  16452. ** normally coordinate their activities, but we do need to coordinate the
  16453. ** loading and saving of autoincrement information.
  16454. */
  16455. struct AutoincInfo {
  16456. AutoincInfo *pNext; /* Next info block in a list of them all */
  16457. Table *pTab; /* Table this info block refers to */
  16458. int iDb; /* Index in sqlite3.aDb[] of database holding pTab */
  16459. int regCtr; /* Memory register holding the rowid counter */
  16460. };
  16461. /*
  16462. ** Size of the column cache
  16463. */
  16464. #ifndef SQLITE_N_COLCACHE
  16465. # define SQLITE_N_COLCACHE 10
  16466. #endif
  16467. /*
  16468. ** At least one instance of the following structure is created for each
  16469. ** trigger that may be fired while parsing an INSERT, UPDATE or DELETE
  16470. ** statement. All such objects are stored in the linked list headed at
  16471. ** Parse.pTriggerPrg and deleted once statement compilation has been
  16472. ** completed.
  16473. **
  16474. ** A Vdbe sub-program that implements the body and WHEN clause of trigger
  16475. ** TriggerPrg.pTrigger, assuming a default ON CONFLICT clause of
  16476. ** TriggerPrg.orconf, is stored in the TriggerPrg.pProgram variable.
  16477. ** The Parse.pTriggerPrg list never contains two entries with the same
  16478. ** values for both pTrigger and orconf.
  16479. **
  16480. ** The TriggerPrg.aColmask[0] variable is set to a mask of old.* columns
  16481. ** accessed (or set to 0 for triggers fired as a result of INSERT
  16482. ** statements). Similarly, the TriggerPrg.aColmask[1] variable is set to
  16483. ** a mask of new.* columns used by the program.
  16484. */
  16485. struct TriggerPrg {
  16486. Trigger *pTrigger; /* Trigger this program was coded from */
  16487. TriggerPrg *pNext; /* Next entry in Parse.pTriggerPrg list */
  16488. SubProgram *pProgram; /* Program implementing pTrigger/orconf */
  16489. int orconf; /* Default ON CONFLICT policy */
  16490. u32 aColmask[2]; /* Masks of old.*, new.* columns accessed */
  16491. };
  16492. /*
  16493. ** The yDbMask datatype for the bitmask of all attached databases.
  16494. */
  16495. #if SQLITE_MAX_ATTACHED>30
  16496. typedef unsigned char yDbMask[(SQLITE_MAX_ATTACHED+9)/8];
  16497. # define DbMaskTest(M,I) (((M)[(I)/8]&(1<<((I)&7)))!=0)
  16498. # define DbMaskZero(M) memset((M),0,sizeof(M))
  16499. # define DbMaskSet(M,I) (M)[(I)/8]|=(1<<((I)&7))
  16500. # define DbMaskAllZero(M) sqlite3DbMaskAllZero(M)
  16501. # define DbMaskNonZero(M) (sqlite3DbMaskAllZero(M)==0)
  16502. #else
  16503. typedef unsigned int yDbMask;
  16504. # define DbMaskTest(M,I) (((M)&(((yDbMask)1)<<(I)))!=0)
  16505. # define DbMaskZero(M) (M)=0
  16506. # define DbMaskSet(M,I) (M)|=(((yDbMask)1)<<(I))
  16507. # define DbMaskAllZero(M) (M)==0
  16508. # define DbMaskNonZero(M) (M)!=0
  16509. #endif
  16510. /*
  16511. ** An SQL parser context. A copy of this structure is passed through
  16512. ** the parser and down into all the parser action routine in order to
  16513. ** carry around information that is global to the entire parse.
  16514. **
  16515. ** The structure is divided into two parts. When the parser and code
  16516. ** generate call themselves recursively, the first part of the structure
  16517. ** is constant but the second part is reset at the beginning and end of
  16518. ** each recursion.
  16519. **
  16520. ** The nTableLock and aTableLock variables are only used if the shared-cache
  16521. ** feature is enabled (if sqlite3Tsd()->useSharedData is true). They are
  16522. ** used to store the set of table-locks required by the statement being
  16523. ** compiled. Function sqlite3TableLock() is used to add entries to the
  16524. ** list.
  16525. */
  16526. struct Parse {
  16527. sqlite3 *db; /* The main database structure */
  16528. char *zErrMsg; /* An error message */
  16529. Vdbe *pVdbe; /* An engine for executing database bytecode */
  16530. int rc; /* Return code from execution */
  16531. u8 colNamesSet; /* TRUE after OP_ColumnName has been issued to pVdbe */
  16532. u8 checkSchema; /* Causes schema cookie check after an error */
  16533. u8 nested; /* Number of nested calls to the parser/code generator */
  16534. u8 nTempReg; /* Number of temporary registers in aTempReg[] */
  16535. u8 isMultiWrite; /* True if statement may modify/insert multiple rows */
  16536. u8 mayAbort; /* True if statement may throw an ABORT exception */
  16537. u8 hasCompound; /* Need to invoke convertCompoundSelectToSubquery() */
  16538. u8 okConstFactor; /* OK to factor out constants */
  16539. u8 disableLookaside; /* Number of times lookaside has been disabled */
  16540. u8 nColCache; /* Number of entries in aColCache[] */
  16541. int nRangeReg; /* Size of the temporary register block */
  16542. int iRangeReg; /* First register in temporary register block */
  16543. int nErr; /* Number of errors seen */
  16544. int nTab; /* Number of previously allocated VDBE cursors */
  16545. int nMem; /* Number of memory cells used so far */
  16546. int nOpAlloc; /* Number of slots allocated for Vdbe.aOp[] */
  16547. int szOpAlloc; /* Bytes of memory space allocated for Vdbe.aOp[] */
  16548. int iSelfTab; /* Table associated with an index on expr, or negative
  16549. ** of the base register during check-constraint eval */
  16550. int iCacheLevel; /* ColCache valid when aColCache[].iLevel<=iCacheLevel */
  16551. int iCacheCnt; /* Counter used to generate aColCache[].lru values */
  16552. int nLabel; /* Number of labels used */
  16553. int *aLabel; /* Space to hold the labels */
  16554. ExprList *pConstExpr;/* Constant expressions */
  16555. Token constraintName;/* Name of the constraint currently being parsed */
  16556. yDbMask writeMask; /* Start a write transaction on these databases */
  16557. yDbMask cookieMask; /* Bitmask of schema verified databases */
  16558. int regRowid; /* Register holding rowid of CREATE TABLE entry */
  16559. int regRoot; /* Register holding root page number for new objects */
  16560. int nMaxArg; /* Max args passed to user function by sub-program */
  16561. #if SELECTTRACE_ENABLED
  16562. int nSelect; /* Number of SELECT statements seen */
  16563. #endif
  16564. #ifndef SQLITE_OMIT_SHARED_CACHE
  16565. int nTableLock; /* Number of locks in aTableLock */
  16566. TableLock *aTableLock; /* Required table locks for shared-cache mode */
  16567. #endif
  16568. AutoincInfo *pAinc; /* Information about AUTOINCREMENT counters */
  16569. Parse *pToplevel; /* Parse structure for main program (or NULL) */
  16570. Table *pTriggerTab; /* Table triggers are being coded for */
  16571. int addrCrTab; /* Address of OP_CreateBtree opcode on CREATE TABLE */
  16572. u32 nQueryLoop; /* Est number of iterations of a query (10*log2(N)) */
  16573. u32 oldmask; /* Mask of old.* columns referenced */
  16574. u32 newmask; /* Mask of new.* columns referenced */
  16575. u8 eTriggerOp; /* TK_UPDATE, TK_INSERT or TK_DELETE */
  16576. u8 eOrconf; /* Default ON CONFLICT policy for trigger steps */
  16577. u8 disableTriggers; /* True to disable triggers */
  16578. /**************************************************************************
  16579. ** Fields above must be initialized to zero. The fields that follow,
  16580. ** down to the beginning of the recursive section, do not need to be
  16581. ** initialized as they will be set before being used. The boundary is
  16582. ** determined by offsetof(Parse,aColCache).
  16583. **************************************************************************/
  16584. struct yColCache {
  16585. int iTable; /* Table cursor number */
  16586. i16 iColumn; /* Table column number */
  16587. u8 tempReg; /* iReg is a temp register that needs to be freed */
  16588. int iLevel; /* Nesting level */
  16589. int iReg; /* Reg with value of this column. 0 means none. */
  16590. int lru; /* Least recently used entry has the smallest value */
  16591. } aColCache[SQLITE_N_COLCACHE]; /* One for each column cache entry */
  16592. int aTempReg[8]; /* Holding area for temporary registers */
  16593. Token sNameToken; /* Token with unqualified schema object name */
  16594. /************************************************************************
  16595. ** Above is constant between recursions. Below is reset before and after
  16596. ** each recursion. The boundary between these two regions is determined
  16597. ** using offsetof(Parse,sLastToken) so the sLastToken field must be the
  16598. ** first field in the recursive region.
  16599. ************************************************************************/
  16600. Token sLastToken; /* The last token parsed */
  16601. ynVar nVar; /* Number of '?' variables seen in the SQL so far */
  16602. u8 iPkSortOrder; /* ASC or DESC for INTEGER PRIMARY KEY */
  16603. u8 explain; /* True if the EXPLAIN flag is found on the query */
  16604. #ifndef SQLITE_OMIT_VIRTUALTABLE
  16605. u8 declareVtab; /* True if inside sqlite3_declare_vtab() */
  16606. int nVtabLock; /* Number of virtual tables to lock */
  16607. #endif
  16608. int nHeight; /* Expression tree height of current sub-select */
  16609. #ifndef SQLITE_OMIT_EXPLAIN
  16610. int iSelectId; /* ID of current select for EXPLAIN output */
  16611. int iNextSelectId; /* Next available select ID for EXPLAIN output */
  16612. #endif
  16613. VList *pVList; /* Mapping between variable names and numbers */
  16614. Vdbe *pReprepare; /* VM being reprepared (sqlite3Reprepare()) */
  16615. const char *zTail; /* All SQL text past the last semicolon parsed */
  16616. Table *pNewTable; /* A table being constructed by CREATE TABLE */
  16617. Trigger *pNewTrigger; /* Trigger under construct by a CREATE TRIGGER */
  16618. const char *zAuthContext; /* The 6th parameter to db->xAuth callbacks */
  16619. #ifndef SQLITE_OMIT_VIRTUALTABLE
  16620. Token sArg; /* Complete text of a module argument */
  16621. Table **apVtabLock; /* Pointer to virtual tables needing locking */
  16622. #endif
  16623. Table *pZombieTab; /* List of Table objects to delete after code gen */
  16624. TriggerPrg *pTriggerPrg; /* Linked list of coded triggers */
  16625. With *pWith; /* Current WITH clause, or NULL */
  16626. With *pWithToFree; /* Free this WITH object at the end of the parse */
  16627. };
  16628. /*
  16629. ** Sizes and pointers of various parts of the Parse object.
  16630. */
  16631. #define PARSE_HDR_SZ offsetof(Parse,aColCache) /* Recursive part w/o aColCache*/
  16632. #define PARSE_RECURSE_SZ offsetof(Parse,sLastToken) /* Recursive part */
  16633. #define PARSE_TAIL_SZ (sizeof(Parse)-PARSE_RECURSE_SZ) /* Non-recursive part */
  16634. #define PARSE_TAIL(X) (((char*)(X))+PARSE_RECURSE_SZ) /* Pointer to tail */
  16635. /*
  16636. ** Return true if currently inside an sqlite3_declare_vtab() call.
  16637. */
  16638. #ifdef SQLITE_OMIT_VIRTUALTABLE
  16639. #define IN_DECLARE_VTAB 0
  16640. #else
  16641. #define IN_DECLARE_VTAB (pParse->declareVtab)
  16642. #endif
  16643. /*
  16644. ** An instance of the following structure can be declared on a stack and used
  16645. ** to save the Parse.zAuthContext value so that it can be restored later.
  16646. */
  16647. struct AuthContext {
  16648. const char *zAuthContext; /* Put saved Parse.zAuthContext here */
  16649. Parse *pParse; /* The Parse structure */
  16650. };
  16651. /*
  16652. ** Bitfield flags for P5 value in various opcodes.
  16653. **
  16654. ** Value constraints (enforced via assert()):
  16655. ** OPFLAG_LENGTHARG == SQLITE_FUNC_LENGTH
  16656. ** OPFLAG_TYPEOFARG == SQLITE_FUNC_TYPEOF
  16657. ** OPFLAG_BULKCSR == BTREE_BULKLOAD
  16658. ** OPFLAG_SEEKEQ == BTREE_SEEK_EQ
  16659. ** OPFLAG_FORDELETE == BTREE_FORDELETE
  16660. ** OPFLAG_SAVEPOSITION == BTREE_SAVEPOSITION
  16661. ** OPFLAG_AUXDELETE == BTREE_AUXDELETE
  16662. */
  16663. #define OPFLAG_NCHANGE 0x01 /* OP_Insert: Set to update db->nChange */
  16664. /* Also used in P2 (not P5) of OP_Delete */
  16665. #define OPFLAG_EPHEM 0x01 /* OP_Column: Ephemeral output is ok */
  16666. #define OPFLAG_LASTROWID 0x20 /* Set to update db->lastRowid */
  16667. #define OPFLAG_ISUPDATE 0x04 /* This OP_Insert is an sql UPDATE */
  16668. #define OPFLAG_APPEND 0x08 /* This is likely to be an append */
  16669. #define OPFLAG_USESEEKRESULT 0x10 /* Try to avoid a seek in BtreeInsert() */
  16670. #define OPFLAG_ISNOOP 0x40 /* OP_Delete does pre-update-hook only */
  16671. #define OPFLAG_LENGTHARG 0x40 /* OP_Column only used for length() */
  16672. #define OPFLAG_TYPEOFARG 0x80 /* OP_Column only used for typeof() */
  16673. #define OPFLAG_BULKCSR 0x01 /* OP_Open** used to open bulk cursor */
  16674. #define OPFLAG_SEEKEQ 0x02 /* OP_Open** cursor uses EQ seek only */
  16675. #define OPFLAG_FORDELETE 0x08 /* OP_Open should use BTREE_FORDELETE */
  16676. #define OPFLAG_P2ISREG 0x10 /* P2 to OP_Open** is a register number */
  16677. #define OPFLAG_PERMUTE 0x01 /* OP_Compare: use the permutation */
  16678. #define OPFLAG_SAVEPOSITION 0x02 /* OP_Delete/Insert: save cursor pos */
  16679. #define OPFLAG_AUXDELETE 0x04 /* OP_Delete: index in a DELETE op */
  16680. #define OPFLAG_NOCHNG_MAGIC 0x6d /* OP_MakeRecord: serialtype 10 is ok */
  16681. /*
  16682. * Each trigger present in the database schema is stored as an instance of
  16683. * struct Trigger.
  16684. *
  16685. * Pointers to instances of struct Trigger are stored in two ways.
  16686. * 1. In the "trigHash" hash table (part of the sqlite3* that represents the
  16687. * database). This allows Trigger structures to be retrieved by name.
  16688. * 2. All triggers associated with a single table form a linked list, using the
  16689. * pNext member of struct Trigger. A pointer to the first element of the
  16690. * linked list is stored as the "pTrigger" member of the associated
  16691. * struct Table.
  16692. *
  16693. * The "step_list" member points to the first element of a linked list
  16694. * containing the SQL statements specified as the trigger program.
  16695. */
  16696. struct Trigger {
  16697. char *zName; /* The name of the trigger */
  16698. char *table; /* The table or view to which the trigger applies */
  16699. u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT */
  16700. u8 tr_tm; /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
  16701. Expr *pWhen; /* The WHEN clause of the expression (may be NULL) */
  16702. IdList *pColumns; /* If this is an UPDATE OF <column-list> trigger,
  16703. the <column-list> is stored here */
  16704. Schema *pSchema; /* Schema containing the trigger */
  16705. Schema *pTabSchema; /* Schema containing the table */
  16706. TriggerStep *step_list; /* Link list of trigger program steps */
  16707. Trigger *pNext; /* Next trigger associated with the table */
  16708. };
  16709. /*
  16710. ** A trigger is either a BEFORE or an AFTER trigger. The following constants
  16711. ** determine which.
  16712. **
  16713. ** If there are multiple triggers, you might of some BEFORE and some AFTER.
  16714. ** In that cases, the constants below can be ORed together.
  16715. */
  16716. #define TRIGGER_BEFORE 1
  16717. #define TRIGGER_AFTER 2
  16718. /*
  16719. * An instance of struct TriggerStep is used to store a single SQL statement
  16720. * that is a part of a trigger-program.
  16721. *
  16722. * Instances of struct TriggerStep are stored in a singly linked list (linked
  16723. * using the "pNext" member) referenced by the "step_list" member of the
  16724. * associated struct Trigger instance. The first element of the linked list is
  16725. * the first step of the trigger-program.
  16726. *
  16727. * The "op" member indicates whether this is a "DELETE", "INSERT", "UPDATE" or
  16728. * "SELECT" statement. The meanings of the other members is determined by the
  16729. * value of "op" as follows:
  16730. *
  16731. * (op == TK_INSERT)
  16732. * orconf -> stores the ON CONFLICT algorithm
  16733. * pSelect -> If this is an INSERT INTO ... SELECT ... statement, then
  16734. * this stores a pointer to the SELECT statement. Otherwise NULL.
  16735. * zTarget -> Dequoted name of the table to insert into.
  16736. * pExprList -> If this is an INSERT INTO ... VALUES ... statement, then
  16737. * this stores values to be inserted. Otherwise NULL.
  16738. * pIdList -> If this is an INSERT INTO ... (<column-names>) VALUES ...
  16739. * statement, then this stores the column-names to be
  16740. * inserted into.
  16741. *
  16742. * (op == TK_DELETE)
  16743. * zTarget -> Dequoted name of the table to delete from.
  16744. * pWhere -> The WHERE clause of the DELETE statement if one is specified.
  16745. * Otherwise NULL.
  16746. *
  16747. * (op == TK_UPDATE)
  16748. * zTarget -> Dequoted name of the table to update.
  16749. * pWhere -> The WHERE clause of the UPDATE statement if one is specified.
  16750. * Otherwise NULL.
  16751. * pExprList -> A list of the columns to update and the expressions to update
  16752. * them to. See sqlite3Update() documentation of "pChanges"
  16753. * argument.
  16754. *
  16755. */
  16756. struct TriggerStep {
  16757. u8 op; /* One of TK_DELETE, TK_UPDATE, TK_INSERT, TK_SELECT */
  16758. u8 orconf; /* OE_Rollback etc. */
  16759. Trigger *pTrig; /* The trigger that this step is a part of */
  16760. Select *pSelect; /* SELECT statement or RHS of INSERT INTO SELECT ... */
  16761. char *zTarget; /* Target table for DELETE, UPDATE, INSERT */
  16762. Expr *pWhere; /* The WHERE clause for DELETE or UPDATE steps */
  16763. ExprList *pExprList; /* SET clause for UPDATE. */
  16764. IdList *pIdList; /* Column names for INSERT */
  16765. char *zSpan; /* Original SQL text of this command */
  16766. TriggerStep *pNext; /* Next in the link-list */
  16767. TriggerStep *pLast; /* Last element in link-list. Valid for 1st elem only */
  16768. };
  16769. /*
  16770. ** The following structure contains information used by the sqliteFix...
  16771. ** routines as they walk the parse tree to make database references
  16772. ** explicit.
  16773. */
  16774. typedef struct DbFixer DbFixer;
  16775. struct DbFixer {
  16776. Parse *pParse; /* The parsing context. Error messages written here */
  16777. Schema *pSchema; /* Fix items to this schema */
  16778. int bVarOnly; /* Check for variable references only */
  16779. const char *zDb; /* Make sure all objects are contained in this database */
  16780. const char *zType; /* Type of the container - used for error messages */
  16781. const Token *pName; /* Name of the container - used for error messages */
  16782. };
  16783. /*
  16784. ** An objected used to accumulate the text of a string where we
  16785. ** do not necessarily know how big the string will be in the end.
  16786. */
  16787. struct StrAccum {
  16788. sqlite3 *db; /* Optional database for lookaside. Can be NULL */
  16789. char *zText; /* The string collected so far */
  16790. u32 nAlloc; /* Amount of space allocated in zText */
  16791. u32 mxAlloc; /* Maximum allowed allocation. 0 for no malloc usage */
  16792. u32 nChar; /* Length of the string so far */
  16793. u8 accError; /* STRACCUM_NOMEM or STRACCUM_TOOBIG */
  16794. u8 printfFlags; /* SQLITE_PRINTF flags below */
  16795. };
  16796. #define STRACCUM_NOMEM 1
  16797. #define STRACCUM_TOOBIG 2
  16798. #define SQLITE_PRINTF_INTERNAL 0x01 /* Internal-use-only converters allowed */
  16799. #define SQLITE_PRINTF_SQLFUNC 0x02 /* SQL function arguments to VXPrintf */
  16800. #define SQLITE_PRINTF_MALLOCED 0x04 /* True if xText is allocated space */
  16801. #define isMalloced(X) (((X)->printfFlags & SQLITE_PRINTF_MALLOCED)!=0)
  16802. /*
  16803. ** A pointer to this structure is used to communicate information
  16804. ** from sqlite3Init and OP_ParseSchema into the sqlite3InitCallback.
  16805. */
  16806. typedef struct {
  16807. sqlite3 *db; /* The database being initialized */
  16808. char **pzErrMsg; /* Error message stored here */
  16809. int iDb; /* 0 for main database. 1 for TEMP, 2.. for ATTACHed */
  16810. int rc; /* Result code stored here */
  16811. } InitData;
  16812. /*
  16813. ** Structure containing global configuration data for the SQLite library.
  16814. **
  16815. ** This structure also contains some state information.
  16816. */
  16817. struct Sqlite3Config {
  16818. int bMemstat; /* True to enable memory status */
  16819. int bCoreMutex; /* True to enable core mutexing */
  16820. int bFullMutex; /* True to enable full mutexing */
  16821. int bOpenUri; /* True to interpret filenames as URIs */
  16822. int bUseCis; /* Use covering indices for full-scans */
  16823. int bSmallMalloc; /* Avoid large memory allocations if true */
  16824. int mxStrlen; /* Maximum string length */
  16825. int neverCorrupt; /* Database is always well-formed */
  16826. int szLookaside; /* Default lookaside buffer size */
  16827. int nLookaside; /* Default lookaside buffer count */
  16828. int nStmtSpill; /* Stmt-journal spill-to-disk threshold */
  16829. sqlite3_mem_methods m; /* Low-level memory allocation interface */
  16830. sqlite3_mutex_methods mutex; /* Low-level mutex interface */
  16831. sqlite3_pcache_methods2 pcache2; /* Low-level page-cache interface */
  16832. void *pHeap; /* Heap storage space */
  16833. int nHeap; /* Size of pHeap[] */
  16834. int mnReq, mxReq; /* Min and max heap requests sizes */
  16835. sqlite3_int64 szMmap; /* mmap() space per open file */
  16836. sqlite3_int64 mxMmap; /* Maximum value for szMmap */
  16837. void *pPage; /* Page cache memory */
  16838. int szPage; /* Size of each page in pPage[] */
  16839. int nPage; /* Number of pages in pPage[] */
  16840. int mxParserStack; /* maximum depth of the parser stack */
  16841. int sharedCacheEnabled; /* true if shared-cache mode enabled */
  16842. u32 szPma; /* Maximum Sorter PMA size */
  16843. /* The above might be initialized to non-zero. The following need to always
  16844. ** initially be zero, however. */
  16845. int isInit; /* True after initialization has finished */
  16846. int inProgress; /* True while initialization in progress */
  16847. int isMutexInit; /* True after mutexes are initialized */
  16848. int isMallocInit; /* True after malloc is initialized */
  16849. int isPCacheInit; /* True after malloc is initialized */
  16850. int nRefInitMutex; /* Number of users of pInitMutex */
  16851. sqlite3_mutex *pInitMutex; /* Mutex used by sqlite3_initialize() */
  16852. void (*xLog)(void*,int,const char*); /* Function for logging */
  16853. void *pLogArg; /* First argument to xLog() */
  16854. #ifdef SQLITE_ENABLE_SQLLOG
  16855. void(*xSqllog)(void*,sqlite3*,const char*, int);
  16856. void *pSqllogArg;
  16857. #endif
  16858. #ifdef SQLITE_VDBE_COVERAGE
  16859. /* The following callback (if not NULL) is invoked on every VDBE branch
  16860. ** operation. Set the callback using SQLITE_TESTCTRL_VDBE_COVERAGE.
  16861. */
  16862. void (*xVdbeBranch)(void*,int iSrcLine,u8 eThis,u8 eMx); /* Callback */
  16863. void *pVdbeBranchArg; /* 1st argument */
  16864. #endif
  16865. #ifndef SQLITE_UNTESTABLE
  16866. int (*xTestCallback)(int); /* Invoked by sqlite3FaultSim() */
  16867. #endif
  16868. int bLocaltimeFault; /* True to fail localtime() calls */
  16869. int iOnceResetThreshold; /* When to reset OP_Once counters */
  16870. };
  16871. /*
  16872. ** This macro is used inside of assert() statements to indicate that
  16873. ** the assert is only valid on a well-formed database. Instead of:
  16874. **
  16875. ** assert( X );
  16876. **
  16877. ** One writes:
  16878. **
  16879. ** assert( X || CORRUPT_DB );
  16880. **
  16881. ** CORRUPT_DB is true during normal operation. CORRUPT_DB does not indicate
  16882. ** that the database is definitely corrupt, only that it might be corrupt.
  16883. ** For most test cases, CORRUPT_DB is set to false using a special
  16884. ** sqlite3_test_control(). This enables assert() statements to prove
  16885. ** things that are always true for well-formed databases.
  16886. */
  16887. #define CORRUPT_DB (sqlite3Config.neverCorrupt==0)
  16888. /*
  16889. ** Context pointer passed down through the tree-walk.
  16890. */
  16891. struct Walker {
  16892. Parse *pParse; /* Parser context. */
  16893. int (*xExprCallback)(Walker*, Expr*); /* Callback for expressions */
  16894. int (*xSelectCallback)(Walker*,Select*); /* Callback for SELECTs */
  16895. void (*xSelectCallback2)(Walker*,Select*);/* Second callback for SELECTs */
  16896. int walkerDepth; /* Number of subqueries */
  16897. u8 eCode; /* A small processing code */
  16898. union { /* Extra data for callback */
  16899. NameContext *pNC; /* Naming context */
  16900. int n; /* A counter */
  16901. int iCur; /* A cursor number */
  16902. SrcList *pSrcList; /* FROM clause */
  16903. struct SrcCount *pSrcCount; /* Counting column references */
  16904. struct CCurHint *pCCurHint; /* Used by codeCursorHint() */
  16905. int *aiCol; /* array of column indexes */
  16906. struct IdxCover *pIdxCover; /* Check for index coverage */
  16907. struct IdxExprTrans *pIdxTrans; /* Convert idxed expr to column */
  16908. ExprList *pGroupBy; /* GROUP BY clause */
  16909. Select *pSelect; /* HAVING to WHERE clause ctx */
  16910. } u;
  16911. };
  16912. /* Forward declarations */
  16913. SQLITE_PRIVATE int sqlite3WalkExpr(Walker*, Expr*);
  16914. SQLITE_PRIVATE int sqlite3WalkExprList(Walker*, ExprList*);
  16915. SQLITE_PRIVATE int sqlite3WalkSelect(Walker*, Select*);
  16916. SQLITE_PRIVATE int sqlite3WalkSelectExpr(Walker*, Select*);
  16917. SQLITE_PRIVATE int sqlite3WalkSelectFrom(Walker*, Select*);
  16918. SQLITE_PRIVATE int sqlite3ExprWalkNoop(Walker*, Expr*);
  16919. SQLITE_PRIVATE int sqlite3SelectWalkNoop(Walker*, Select*);
  16920. SQLITE_PRIVATE int sqlite3SelectWalkFail(Walker*, Select*);
  16921. #ifdef SQLITE_DEBUG
  16922. SQLITE_PRIVATE void sqlite3SelectWalkAssert2(Walker*, Select*);
  16923. #endif
  16924. /*
  16925. ** Return code from the parse-tree walking primitives and their
  16926. ** callbacks.
  16927. */
  16928. #define WRC_Continue 0 /* Continue down into children */
  16929. #define WRC_Prune 1 /* Omit children but continue walking siblings */
  16930. #define WRC_Abort 2 /* Abandon the tree walk */
  16931. /*
  16932. ** An instance of this structure represents a set of one or more CTEs
  16933. ** (common table expressions) created by a single WITH clause.
  16934. */
  16935. struct With {
  16936. int nCte; /* Number of CTEs in the WITH clause */
  16937. With *pOuter; /* Containing WITH clause, or NULL */
  16938. struct Cte { /* For each CTE in the WITH clause.... */
  16939. char *zName; /* Name of this CTE */
  16940. ExprList *pCols; /* List of explicit column names, or NULL */
  16941. Select *pSelect; /* The definition of this CTE */
  16942. const char *zCteErr; /* Error message for circular references */
  16943. } a[1];
  16944. };
  16945. #ifdef SQLITE_DEBUG
  16946. /*
  16947. ** An instance of the TreeView object is used for printing the content of
  16948. ** data structures on sqlite3DebugPrintf() using a tree-like view.
  16949. */
  16950. struct TreeView {
  16951. int iLevel; /* Which level of the tree we are on */
  16952. u8 bLine[100]; /* Draw vertical in column i if bLine[i] is true */
  16953. };
  16954. #endif /* SQLITE_DEBUG */
  16955. /*
  16956. ** Assuming zIn points to the first byte of a UTF-8 character,
  16957. ** advance zIn to point to the first byte of the next UTF-8 character.
  16958. */
  16959. #define SQLITE_SKIP_UTF8(zIn) { \
  16960. if( (*(zIn++))>=0xc0 ){ \
  16961. while( (*zIn & 0xc0)==0x80 ){ zIn++; } \
  16962. } \
  16963. }
  16964. /*
  16965. ** The SQLITE_*_BKPT macros are substitutes for the error codes with
  16966. ** the same name but without the _BKPT suffix. These macros invoke
  16967. ** routines that report the line-number on which the error originated
  16968. ** using sqlite3_log(). The routines also provide a convenient place
  16969. ** to set a debugger breakpoint.
  16970. */
  16971. SQLITE_PRIVATE int sqlite3ReportError(int iErr, int lineno, const char *zType);
  16972. SQLITE_PRIVATE int sqlite3CorruptError(int);
  16973. SQLITE_PRIVATE int sqlite3MisuseError(int);
  16974. SQLITE_PRIVATE int sqlite3CantopenError(int);
  16975. #define SQLITE_CORRUPT_BKPT sqlite3CorruptError(__LINE__)
  16976. #define SQLITE_MISUSE_BKPT sqlite3MisuseError(__LINE__)
  16977. #define SQLITE_CANTOPEN_BKPT sqlite3CantopenError(__LINE__)
  16978. #ifdef SQLITE_DEBUG
  16979. SQLITE_PRIVATE int sqlite3NomemError(int);
  16980. SQLITE_PRIVATE int sqlite3IoerrnomemError(int);
  16981. SQLITE_PRIVATE int sqlite3CorruptPgnoError(int,Pgno);
  16982. # define SQLITE_NOMEM_BKPT sqlite3NomemError(__LINE__)
  16983. # define SQLITE_IOERR_NOMEM_BKPT sqlite3IoerrnomemError(__LINE__)
  16984. # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptPgnoError(__LINE__,(P))
  16985. #else
  16986. # define SQLITE_NOMEM_BKPT SQLITE_NOMEM
  16987. # define SQLITE_IOERR_NOMEM_BKPT SQLITE_IOERR_NOMEM
  16988. # define SQLITE_CORRUPT_PGNO(P) sqlite3CorruptError(__LINE__)
  16989. #endif
  16990. /*
  16991. ** FTS3 and FTS4 both require virtual table support
  16992. */
  16993. #if defined(SQLITE_OMIT_VIRTUALTABLE)
  16994. # undef SQLITE_ENABLE_FTS3
  16995. # undef SQLITE_ENABLE_FTS4
  16996. #endif
  16997. /*
  16998. ** FTS4 is really an extension for FTS3. It is enabled using the
  16999. ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also call
  17000. ** the SQLITE_ENABLE_FTS4 macro to serve as an alias for SQLITE_ENABLE_FTS3.
  17001. */
  17002. #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
  17003. # define SQLITE_ENABLE_FTS3 1
  17004. #endif
  17005. /*
  17006. ** The ctype.h header is needed for non-ASCII systems. It is also
  17007. ** needed by FTS3 when FTS3 is included in the amalgamation.
  17008. */
  17009. #if !defined(SQLITE_ASCII) || \
  17010. (defined(SQLITE_ENABLE_FTS3) && defined(SQLITE_AMALGAMATION))
  17011. # include <ctype.h>
  17012. #endif
  17013. /*
  17014. ** The following macros mimic the standard library functions toupper(),
  17015. ** isspace(), isalnum(), isdigit() and isxdigit(), respectively. The
  17016. ** sqlite versions only work for ASCII characters, regardless of locale.
  17017. */
  17018. #ifdef SQLITE_ASCII
  17019. # define sqlite3Toupper(x) ((x)&~(sqlite3CtypeMap[(unsigned char)(x)]&0x20))
  17020. # define sqlite3Isspace(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x01)
  17021. # define sqlite3Isalnum(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x06)
  17022. # define sqlite3Isalpha(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x02)
  17023. # define sqlite3Isdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x04)
  17024. # define sqlite3Isxdigit(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x08)
  17025. # define sqlite3Tolower(x) (sqlite3UpperToLower[(unsigned char)(x)])
  17026. # define sqlite3Isquote(x) (sqlite3CtypeMap[(unsigned char)(x)]&0x80)
  17027. #else
  17028. # define sqlite3Toupper(x) toupper((unsigned char)(x))
  17029. # define sqlite3Isspace(x) isspace((unsigned char)(x))
  17030. # define sqlite3Isalnum(x) isalnum((unsigned char)(x))
  17031. # define sqlite3Isalpha(x) isalpha((unsigned char)(x))
  17032. # define sqlite3Isdigit(x) isdigit((unsigned char)(x))
  17033. # define sqlite3Isxdigit(x) isxdigit((unsigned char)(x))
  17034. # define sqlite3Tolower(x) tolower((unsigned char)(x))
  17035. # define sqlite3Isquote(x) ((x)=='"'||(x)=='\''||(x)=='['||(x)=='`')
  17036. #endif
  17037. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  17038. SQLITE_PRIVATE int sqlite3IsIdChar(u8);
  17039. #endif
  17040. /*
  17041. ** Internal function prototypes
  17042. */
  17043. SQLITE_PRIVATE int sqlite3StrICmp(const char*,const char*);
  17044. SQLITE_PRIVATE int sqlite3Strlen30(const char*);
  17045. SQLITE_PRIVATE char *sqlite3ColumnType(Column*,char*);
  17046. #define sqlite3StrNICmp sqlite3_strnicmp
  17047. SQLITE_PRIVATE int sqlite3MallocInit(void);
  17048. SQLITE_PRIVATE void sqlite3MallocEnd(void);
  17049. SQLITE_PRIVATE void *sqlite3Malloc(u64);
  17050. SQLITE_PRIVATE void *sqlite3MallocZero(u64);
  17051. SQLITE_PRIVATE void *sqlite3DbMallocZero(sqlite3*, u64);
  17052. SQLITE_PRIVATE void *sqlite3DbMallocRaw(sqlite3*, u64);
  17053. SQLITE_PRIVATE void *sqlite3DbMallocRawNN(sqlite3*, u64);
  17054. SQLITE_PRIVATE char *sqlite3DbStrDup(sqlite3*,const char*);
  17055. SQLITE_PRIVATE char *sqlite3DbStrNDup(sqlite3*,const char*, u64);
  17056. SQLITE_PRIVATE char *sqlite3DbSpanDup(sqlite3*,const char*,const char*);
  17057. SQLITE_PRIVATE void *sqlite3Realloc(void*, u64);
  17058. SQLITE_PRIVATE void *sqlite3DbReallocOrFree(sqlite3 *, void *, u64);
  17059. SQLITE_PRIVATE void *sqlite3DbRealloc(sqlite3 *, void *, u64);
  17060. SQLITE_PRIVATE void sqlite3DbFree(sqlite3*, void*);
  17061. SQLITE_PRIVATE void sqlite3DbFreeNN(sqlite3*, void*);
  17062. SQLITE_PRIVATE int sqlite3MallocSize(void*);
  17063. SQLITE_PRIVATE int sqlite3DbMallocSize(sqlite3*, void*);
  17064. SQLITE_PRIVATE void *sqlite3PageMalloc(int);
  17065. SQLITE_PRIVATE void sqlite3PageFree(void*);
  17066. SQLITE_PRIVATE void sqlite3MemSetDefault(void);
  17067. #ifndef SQLITE_UNTESTABLE
  17068. SQLITE_PRIVATE void sqlite3BenignMallocHooks(void (*)(void), void (*)(void));
  17069. #endif
  17070. SQLITE_PRIVATE int sqlite3HeapNearlyFull(void);
  17071. /*
  17072. ** On systems with ample stack space and that support alloca(), make
  17073. ** use of alloca() to obtain space for large automatic objects. By default,
  17074. ** obtain space from malloc().
  17075. **
  17076. ** The alloca() routine never returns NULL. This will cause code paths
  17077. ** that deal with sqlite3StackAlloc() failures to be unreachable.
  17078. */
  17079. #ifdef SQLITE_USE_ALLOCA
  17080. # define sqlite3StackAllocRaw(D,N) alloca(N)
  17081. # define sqlite3StackAllocZero(D,N) memset(alloca(N), 0, N)
  17082. # define sqlite3StackFree(D,P)
  17083. #else
  17084. # define sqlite3StackAllocRaw(D,N) sqlite3DbMallocRaw(D,N)
  17085. # define sqlite3StackAllocZero(D,N) sqlite3DbMallocZero(D,N)
  17086. # define sqlite3StackFree(D,P) sqlite3DbFree(D,P)
  17087. #endif
  17088. /* Do not allow both MEMSYS5 and MEMSYS3 to be defined together. If they
  17089. ** are, disable MEMSYS3
  17090. */
  17091. #ifdef SQLITE_ENABLE_MEMSYS5
  17092. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys5(void);
  17093. #undef SQLITE_ENABLE_MEMSYS3
  17094. #endif
  17095. #ifdef SQLITE_ENABLE_MEMSYS3
  17096. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys3(void);
  17097. #endif
  17098. #ifndef SQLITE_MUTEX_OMIT
  17099. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void);
  17100. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3NoopMutex(void);
  17101. SQLITE_PRIVATE sqlite3_mutex *sqlite3MutexAlloc(int);
  17102. SQLITE_PRIVATE int sqlite3MutexInit(void);
  17103. SQLITE_PRIVATE int sqlite3MutexEnd(void);
  17104. #endif
  17105. #if !defined(SQLITE_MUTEX_OMIT) && !defined(SQLITE_MUTEX_NOOP)
  17106. SQLITE_PRIVATE void sqlite3MemoryBarrier(void);
  17107. #else
  17108. # define sqlite3MemoryBarrier()
  17109. #endif
  17110. SQLITE_PRIVATE sqlite3_int64 sqlite3StatusValue(int);
  17111. SQLITE_PRIVATE void sqlite3StatusUp(int, int);
  17112. SQLITE_PRIVATE void sqlite3StatusDown(int, int);
  17113. SQLITE_PRIVATE void sqlite3StatusHighwater(int, int);
  17114. SQLITE_PRIVATE int sqlite3LookasideUsed(sqlite3*,int*);
  17115. /* Access to mutexes used by sqlite3_status() */
  17116. SQLITE_PRIVATE sqlite3_mutex *sqlite3Pcache1Mutex(void);
  17117. SQLITE_PRIVATE sqlite3_mutex *sqlite3MallocMutex(void);
  17118. #if defined(SQLITE_ENABLE_MULTITHREADED_CHECKS) && !defined(SQLITE_MUTEX_OMIT)
  17119. SQLITE_PRIVATE void sqlite3MutexWarnOnContention(sqlite3_mutex*);
  17120. #else
  17121. # define sqlite3MutexWarnOnContention(x)
  17122. #endif
  17123. #ifndef SQLITE_OMIT_FLOATING_POINT
  17124. SQLITE_PRIVATE int sqlite3IsNaN(double);
  17125. #else
  17126. # define sqlite3IsNaN(X) 0
  17127. #endif
  17128. /*
  17129. ** An instance of the following structure holds information about SQL
  17130. ** functions arguments that are the parameters to the printf() function.
  17131. */
  17132. struct PrintfArguments {
  17133. int nArg; /* Total number of arguments */
  17134. int nUsed; /* Number of arguments used so far */
  17135. sqlite3_value **apArg; /* The argument values */
  17136. };
  17137. SQLITE_PRIVATE void sqlite3VXPrintf(StrAccum*, const char*, va_list);
  17138. SQLITE_PRIVATE void sqlite3XPrintf(StrAccum*, const char*, ...);
  17139. SQLITE_PRIVATE char *sqlite3MPrintf(sqlite3*,const char*, ...);
  17140. SQLITE_PRIVATE char *sqlite3VMPrintf(sqlite3*,const char*, va_list);
  17141. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  17142. SQLITE_PRIVATE void sqlite3DebugPrintf(const char*, ...);
  17143. #endif
  17144. #if defined(SQLITE_TEST)
  17145. SQLITE_PRIVATE void *sqlite3TestTextToPtr(const char*);
  17146. #endif
  17147. #if defined(SQLITE_DEBUG)
  17148. SQLITE_PRIVATE void sqlite3TreeViewExpr(TreeView*, const Expr*, u8);
  17149. SQLITE_PRIVATE void sqlite3TreeViewBareExprList(TreeView*, const ExprList*, const char*);
  17150. SQLITE_PRIVATE void sqlite3TreeViewExprList(TreeView*, const ExprList*, u8, const char*);
  17151. SQLITE_PRIVATE void sqlite3TreeViewSelect(TreeView*, const Select*, u8);
  17152. SQLITE_PRIVATE void sqlite3TreeViewWith(TreeView*, const With*, u8);
  17153. #endif
  17154. SQLITE_PRIVATE void sqlite3SetString(char **, sqlite3*, const char*);
  17155. SQLITE_PRIVATE void sqlite3ErrorMsg(Parse*, const char*, ...);
  17156. SQLITE_PRIVATE void sqlite3Dequote(char*);
  17157. SQLITE_PRIVATE void sqlite3TokenInit(Token*,char*);
  17158. SQLITE_PRIVATE int sqlite3KeywordCode(const unsigned char*, int);
  17159. SQLITE_PRIVATE int sqlite3RunParser(Parse*, const char*, char **);
  17160. SQLITE_PRIVATE void sqlite3FinishCoding(Parse*);
  17161. SQLITE_PRIVATE int sqlite3GetTempReg(Parse*);
  17162. SQLITE_PRIVATE void sqlite3ReleaseTempReg(Parse*,int);
  17163. SQLITE_PRIVATE int sqlite3GetTempRange(Parse*,int);
  17164. SQLITE_PRIVATE void sqlite3ReleaseTempRange(Parse*,int,int);
  17165. SQLITE_PRIVATE void sqlite3ClearTempRegCache(Parse*);
  17166. #ifdef SQLITE_DEBUG
  17167. SQLITE_PRIVATE int sqlite3NoTempsInRange(Parse*,int,int);
  17168. #endif
  17169. SQLITE_PRIVATE Expr *sqlite3ExprAlloc(sqlite3*,int,const Token*,int);
  17170. SQLITE_PRIVATE Expr *sqlite3Expr(sqlite3*,int,const char*);
  17171. SQLITE_PRIVATE void sqlite3ExprAttachSubtrees(sqlite3*,Expr*,Expr*,Expr*);
  17172. SQLITE_PRIVATE Expr *sqlite3PExpr(Parse*, int, Expr*, Expr*);
  17173. SQLITE_PRIVATE void sqlite3PExprAddSelect(Parse*, Expr*, Select*);
  17174. SQLITE_PRIVATE Expr *sqlite3ExprAnd(sqlite3*,Expr*, Expr*);
  17175. SQLITE_PRIVATE Expr *sqlite3ExprFunction(Parse*,ExprList*, Token*);
  17176. SQLITE_PRIVATE void sqlite3ExprAssignVarNumber(Parse*, Expr*, u32);
  17177. SQLITE_PRIVATE void sqlite3ExprDelete(sqlite3*, Expr*);
  17178. SQLITE_PRIVATE ExprList *sqlite3ExprListAppend(Parse*,ExprList*,Expr*);
  17179. SQLITE_PRIVATE ExprList *sqlite3ExprListAppendVector(Parse*,ExprList*,IdList*,Expr*);
  17180. SQLITE_PRIVATE void sqlite3ExprListSetSortOrder(ExprList*,int);
  17181. SQLITE_PRIVATE void sqlite3ExprListSetName(Parse*,ExprList*,Token*,int);
  17182. SQLITE_PRIVATE void sqlite3ExprListSetSpan(Parse*,ExprList*,const char*,const char*);
  17183. SQLITE_PRIVATE void sqlite3ExprListDelete(sqlite3*, ExprList*);
  17184. SQLITE_PRIVATE u32 sqlite3ExprListFlags(const ExprList*);
  17185. SQLITE_PRIVATE int sqlite3Init(sqlite3*, char**);
  17186. SQLITE_PRIVATE int sqlite3InitCallback(void*, int, char**, char**);
  17187. SQLITE_PRIVATE void sqlite3Pragma(Parse*,Token*,Token*,Token*,int);
  17188. #ifndef SQLITE_OMIT_VIRTUALTABLE
  17189. SQLITE_PRIVATE Module *sqlite3PragmaVtabRegister(sqlite3*,const char *zName);
  17190. #endif
  17191. SQLITE_PRIVATE void sqlite3ResetAllSchemasOfConnection(sqlite3*);
  17192. SQLITE_PRIVATE void sqlite3ResetOneSchema(sqlite3*,int);
  17193. SQLITE_PRIVATE void sqlite3CollapseDatabaseArray(sqlite3*);
  17194. SQLITE_PRIVATE void sqlite3CommitInternalChanges(sqlite3*);
  17195. SQLITE_PRIVATE void sqlite3DeleteColumnNames(sqlite3*,Table*);
  17196. SQLITE_PRIVATE int sqlite3ColumnsFromExprList(Parse*,ExprList*,i16*,Column**);
  17197. SQLITE_PRIVATE void sqlite3SelectAddColumnTypeAndCollation(Parse*,Table*,Select*);
  17198. SQLITE_PRIVATE Table *sqlite3ResultSetOfSelect(Parse*,Select*);
  17199. SQLITE_PRIVATE void sqlite3OpenMasterTable(Parse *, int);
  17200. SQLITE_PRIVATE Index *sqlite3PrimaryKeyIndex(Table*);
  17201. SQLITE_PRIVATE i16 sqlite3ColumnOfIndex(Index*, i16);
  17202. SQLITE_PRIVATE void sqlite3StartTable(Parse*,Token*,Token*,int,int,int,int);
  17203. #if SQLITE_ENABLE_HIDDEN_COLUMNS
  17204. SQLITE_PRIVATE void sqlite3ColumnPropertiesFromName(Table*, Column*);
  17205. #else
  17206. # define sqlite3ColumnPropertiesFromName(T,C) /* no-op */
  17207. #endif
  17208. SQLITE_PRIVATE void sqlite3AddColumn(Parse*,Token*,Token*);
  17209. SQLITE_PRIVATE void sqlite3AddNotNull(Parse*, int);
  17210. SQLITE_PRIVATE void sqlite3AddPrimaryKey(Parse*, ExprList*, int, int, int);
  17211. SQLITE_PRIVATE void sqlite3AddCheckConstraint(Parse*, Expr*);
  17212. SQLITE_PRIVATE void sqlite3AddDefaultValue(Parse*,Expr*,const char*,const char*);
  17213. SQLITE_PRIVATE void sqlite3AddCollateType(Parse*, Token*);
  17214. SQLITE_PRIVATE void sqlite3EndTable(Parse*,Token*,Token*,u8,Select*);
  17215. SQLITE_PRIVATE int sqlite3ParseUri(const char*,const char*,unsigned int*,
  17216. sqlite3_vfs**,char**,char **);
  17217. SQLITE_PRIVATE Btree *sqlite3DbNameToBtree(sqlite3*,const char*);
  17218. #ifdef SQLITE_UNTESTABLE
  17219. # define sqlite3FaultSim(X) SQLITE_OK
  17220. #else
  17221. SQLITE_PRIVATE int sqlite3FaultSim(int);
  17222. #endif
  17223. SQLITE_PRIVATE Bitvec *sqlite3BitvecCreate(u32);
  17224. SQLITE_PRIVATE int sqlite3BitvecTest(Bitvec*, u32);
  17225. SQLITE_PRIVATE int sqlite3BitvecTestNotNull(Bitvec*, u32);
  17226. SQLITE_PRIVATE int sqlite3BitvecSet(Bitvec*, u32);
  17227. SQLITE_PRIVATE void sqlite3BitvecClear(Bitvec*, u32, void*);
  17228. SQLITE_PRIVATE void sqlite3BitvecDestroy(Bitvec*);
  17229. SQLITE_PRIVATE u32 sqlite3BitvecSize(Bitvec*);
  17230. #ifndef SQLITE_UNTESTABLE
  17231. SQLITE_PRIVATE int sqlite3BitvecBuiltinTest(int,int*);
  17232. #endif
  17233. SQLITE_PRIVATE RowSet *sqlite3RowSetInit(sqlite3*, void*, unsigned int);
  17234. SQLITE_PRIVATE void sqlite3RowSetClear(RowSet*);
  17235. SQLITE_PRIVATE void sqlite3RowSetInsert(RowSet*, i64);
  17236. SQLITE_PRIVATE int sqlite3RowSetTest(RowSet*, int iBatch, i64);
  17237. SQLITE_PRIVATE int sqlite3RowSetNext(RowSet*, i64*);
  17238. SQLITE_PRIVATE void sqlite3CreateView(Parse*,Token*,Token*,Token*,ExprList*,Select*,int,int);
  17239. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
  17240. SQLITE_PRIVATE int sqlite3ViewGetColumnNames(Parse*,Table*);
  17241. #else
  17242. # define sqlite3ViewGetColumnNames(A,B) 0
  17243. #endif
  17244. #if SQLITE_MAX_ATTACHED>30
  17245. SQLITE_PRIVATE int sqlite3DbMaskAllZero(yDbMask);
  17246. #endif
  17247. SQLITE_PRIVATE void sqlite3DropTable(Parse*, SrcList*, int, int);
  17248. SQLITE_PRIVATE void sqlite3CodeDropTable(Parse*, Table*, int, int);
  17249. SQLITE_PRIVATE void sqlite3DeleteTable(sqlite3*, Table*);
  17250. #ifndef SQLITE_OMIT_AUTOINCREMENT
  17251. SQLITE_PRIVATE void sqlite3AutoincrementBegin(Parse *pParse);
  17252. SQLITE_PRIVATE void sqlite3AutoincrementEnd(Parse *pParse);
  17253. #else
  17254. # define sqlite3AutoincrementBegin(X)
  17255. # define sqlite3AutoincrementEnd(X)
  17256. #endif
  17257. SQLITE_PRIVATE void sqlite3Insert(Parse*, SrcList*, Select*, IdList*, int);
  17258. SQLITE_PRIVATE void *sqlite3ArrayAllocate(sqlite3*,void*,int,int*,int*);
  17259. SQLITE_PRIVATE IdList *sqlite3IdListAppend(sqlite3*, IdList*, Token*);
  17260. SQLITE_PRIVATE int sqlite3IdListIndex(IdList*,const char*);
  17261. SQLITE_PRIVATE SrcList *sqlite3SrcListEnlarge(sqlite3*, SrcList*, int, int);
  17262. SQLITE_PRIVATE SrcList *sqlite3SrcListAppend(sqlite3*, SrcList*, Token*, Token*);
  17263. SQLITE_PRIVATE SrcList *sqlite3SrcListAppendFromTerm(Parse*, SrcList*, Token*, Token*,
  17264. Token*, Select*, Expr*, IdList*);
  17265. SQLITE_PRIVATE void sqlite3SrcListIndexedBy(Parse *, SrcList *, Token *);
  17266. SQLITE_PRIVATE void sqlite3SrcListFuncArgs(Parse*, SrcList*, ExprList*);
  17267. SQLITE_PRIVATE int sqlite3IndexedByLookup(Parse *, struct SrcList_item *);
  17268. SQLITE_PRIVATE void sqlite3SrcListShiftJoinType(SrcList*);
  17269. SQLITE_PRIVATE void sqlite3SrcListAssignCursors(Parse*, SrcList*);
  17270. SQLITE_PRIVATE void sqlite3IdListDelete(sqlite3*, IdList*);
  17271. SQLITE_PRIVATE void sqlite3SrcListDelete(sqlite3*, SrcList*);
  17272. SQLITE_PRIVATE Index *sqlite3AllocateIndexObject(sqlite3*,i16,int,char**);
  17273. SQLITE_PRIVATE void sqlite3CreateIndex(Parse*,Token*,Token*,SrcList*,ExprList*,int,Token*,
  17274. Expr*, int, int, u8);
  17275. SQLITE_PRIVATE void sqlite3DropIndex(Parse*, SrcList*, int);
  17276. SQLITE_PRIVATE int sqlite3Select(Parse*, Select*, SelectDest*);
  17277. SQLITE_PRIVATE Select *sqlite3SelectNew(Parse*,ExprList*,SrcList*,Expr*,ExprList*,
  17278. Expr*,ExprList*,u32,Expr*);
  17279. SQLITE_PRIVATE void sqlite3SelectDelete(sqlite3*, Select*);
  17280. SQLITE_PRIVATE Table *sqlite3SrcListLookup(Parse*, SrcList*);
  17281. SQLITE_PRIVATE int sqlite3IsReadOnly(Parse*, Table*, int);
  17282. SQLITE_PRIVATE void sqlite3OpenTable(Parse*, int iCur, int iDb, Table*, int);
  17283. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
  17284. SQLITE_PRIVATE Expr *sqlite3LimitWhere(Parse*,SrcList*,Expr*,ExprList*,Expr*,char*);
  17285. #endif
  17286. SQLITE_PRIVATE void sqlite3DeleteFrom(Parse*, SrcList*, Expr*, ExprList*, Expr*);
  17287. SQLITE_PRIVATE void sqlite3Update(Parse*, SrcList*, ExprList*,Expr*,int,ExprList*,Expr*);
  17288. SQLITE_PRIVATE WhereInfo *sqlite3WhereBegin(Parse*,SrcList*,Expr*,ExprList*,ExprList*,u16,int);
  17289. SQLITE_PRIVATE void sqlite3WhereEnd(WhereInfo*);
  17290. SQLITE_PRIVATE LogEst sqlite3WhereOutputRowCount(WhereInfo*);
  17291. SQLITE_PRIVATE int sqlite3WhereIsDistinct(WhereInfo*);
  17292. SQLITE_PRIVATE int sqlite3WhereIsOrdered(WhereInfo*);
  17293. SQLITE_PRIVATE int sqlite3WhereOrderedInnerLoop(WhereInfo*);
  17294. SQLITE_PRIVATE int sqlite3WhereIsSorted(WhereInfo*);
  17295. SQLITE_PRIVATE int sqlite3WhereContinueLabel(WhereInfo*);
  17296. SQLITE_PRIVATE int sqlite3WhereBreakLabel(WhereInfo*);
  17297. SQLITE_PRIVATE int sqlite3WhereOkOnePass(WhereInfo*, int*);
  17298. #define ONEPASS_OFF 0 /* Use of ONEPASS not allowed */
  17299. #define ONEPASS_SINGLE 1 /* ONEPASS valid for a single row update */
  17300. #define ONEPASS_MULTI 2 /* ONEPASS is valid for multiple rows */
  17301. SQLITE_PRIVATE void sqlite3ExprCodeLoadIndexColumn(Parse*, Index*, int, int, int);
  17302. SQLITE_PRIVATE int sqlite3ExprCodeGetColumn(Parse*, Table*, int, int, int, u8);
  17303. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnToReg(Parse*, Table*, int, int, int);
  17304. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnOfTable(Vdbe*, Table*, int, int, int);
  17305. SQLITE_PRIVATE void sqlite3ExprCodeMove(Parse*, int, int, int);
  17306. SQLITE_PRIVATE void sqlite3ExprCacheStore(Parse*, int, int, int);
  17307. SQLITE_PRIVATE void sqlite3ExprCachePush(Parse*);
  17308. SQLITE_PRIVATE void sqlite3ExprCachePop(Parse*);
  17309. SQLITE_PRIVATE void sqlite3ExprCacheRemove(Parse*, int, int);
  17310. SQLITE_PRIVATE void sqlite3ExprCacheClear(Parse*);
  17311. SQLITE_PRIVATE void sqlite3ExprCacheAffinityChange(Parse*, int, int);
  17312. SQLITE_PRIVATE void sqlite3ExprCode(Parse*, Expr*, int);
  17313. SQLITE_PRIVATE void sqlite3ExprCodeCopy(Parse*, Expr*, int);
  17314. SQLITE_PRIVATE void sqlite3ExprCodeFactorable(Parse*, Expr*, int);
  17315. SQLITE_PRIVATE int sqlite3ExprCodeAtInit(Parse*, Expr*, int);
  17316. SQLITE_PRIVATE int sqlite3ExprCodeTemp(Parse*, Expr*, int*);
  17317. SQLITE_PRIVATE int sqlite3ExprCodeTarget(Parse*, Expr*, int);
  17318. SQLITE_PRIVATE void sqlite3ExprCodeAndCache(Parse*, Expr*, int);
  17319. SQLITE_PRIVATE int sqlite3ExprCodeExprList(Parse*, ExprList*, int, int, u8);
  17320. #define SQLITE_ECEL_DUP 0x01 /* Deep, not shallow copies */
  17321. #define SQLITE_ECEL_FACTOR 0x02 /* Factor out constant terms */
  17322. #define SQLITE_ECEL_REF 0x04 /* Use ExprList.u.x.iOrderByCol */
  17323. #define SQLITE_ECEL_OMITREF 0x08 /* Omit if ExprList.u.x.iOrderByCol */
  17324. SQLITE_PRIVATE void sqlite3ExprIfTrue(Parse*, Expr*, int, int);
  17325. SQLITE_PRIVATE void sqlite3ExprIfFalse(Parse*, Expr*, int, int);
  17326. SQLITE_PRIVATE void sqlite3ExprIfFalseDup(Parse*, Expr*, int, int);
  17327. SQLITE_PRIVATE Table *sqlite3FindTable(sqlite3*,const char*, const char*);
  17328. #define LOCATE_VIEW 0x01
  17329. #define LOCATE_NOERR 0x02
  17330. SQLITE_PRIVATE Table *sqlite3LocateTable(Parse*,u32 flags,const char*, const char*);
  17331. SQLITE_PRIVATE Table *sqlite3LocateTableItem(Parse*,u32 flags,struct SrcList_item *);
  17332. SQLITE_PRIVATE Index *sqlite3FindIndex(sqlite3*,const char*, const char*);
  17333. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTable(sqlite3*,int,const char*);
  17334. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteIndex(sqlite3*,int,const char*);
  17335. SQLITE_PRIVATE void sqlite3Vacuum(Parse*,Token*);
  17336. SQLITE_PRIVATE int sqlite3RunVacuum(char**, sqlite3*, int);
  17337. SQLITE_PRIVATE char *sqlite3NameFromToken(sqlite3*, Token*);
  17338. SQLITE_PRIVATE int sqlite3ExprCompare(Parse*,Expr*, Expr*, int);
  17339. SQLITE_PRIVATE int sqlite3ExprCompareSkip(Expr*, Expr*, int);
  17340. SQLITE_PRIVATE int sqlite3ExprListCompare(ExprList*, ExprList*, int);
  17341. SQLITE_PRIVATE int sqlite3ExprImpliesExpr(Parse*,Expr*, Expr*, int);
  17342. SQLITE_PRIVATE int sqlite3ExprImpliesNonNullRow(Expr*,int);
  17343. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggregates(NameContext*, Expr*);
  17344. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggList(NameContext*,ExprList*);
  17345. SQLITE_PRIVATE int sqlite3ExprCoveredByIndex(Expr*, int iCur, Index *pIdx);
  17346. SQLITE_PRIVATE int sqlite3FunctionUsesThisSrc(Expr*, SrcList*);
  17347. SQLITE_PRIVATE Vdbe *sqlite3GetVdbe(Parse*);
  17348. #ifndef SQLITE_UNTESTABLE
  17349. SQLITE_PRIVATE void sqlite3PrngSaveState(void);
  17350. SQLITE_PRIVATE void sqlite3PrngRestoreState(void);
  17351. #endif
  17352. SQLITE_PRIVATE void sqlite3RollbackAll(sqlite3*,int);
  17353. SQLITE_PRIVATE void sqlite3CodeVerifySchema(Parse*, int);
  17354. SQLITE_PRIVATE void sqlite3CodeVerifyNamedSchema(Parse*, const char *zDb);
  17355. SQLITE_PRIVATE void sqlite3BeginTransaction(Parse*, int);
  17356. SQLITE_PRIVATE void sqlite3EndTransaction(Parse*,int);
  17357. SQLITE_PRIVATE void sqlite3Savepoint(Parse*, int, Token*);
  17358. SQLITE_PRIVATE void sqlite3CloseSavepoints(sqlite3 *);
  17359. SQLITE_PRIVATE void sqlite3LeaveMutexAndCloseZombie(sqlite3*);
  17360. SQLITE_PRIVATE int sqlite3ExprIdToTrueFalse(Expr*);
  17361. SQLITE_PRIVATE int sqlite3ExprTruthValue(const Expr*);
  17362. SQLITE_PRIVATE int sqlite3ExprIsConstant(Expr*);
  17363. SQLITE_PRIVATE int sqlite3ExprIsConstantNotJoin(Expr*);
  17364. SQLITE_PRIVATE int sqlite3ExprIsConstantOrFunction(Expr*, u8);
  17365. SQLITE_PRIVATE int sqlite3ExprIsConstantOrGroupBy(Parse*, Expr*, ExprList*);
  17366. SQLITE_PRIVATE int sqlite3ExprIsTableConstant(Expr*,int);
  17367. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  17368. SQLITE_PRIVATE int sqlite3ExprContainsSubquery(Expr*);
  17369. #endif
  17370. SQLITE_PRIVATE int sqlite3ExprIsInteger(Expr*, int*);
  17371. SQLITE_PRIVATE int sqlite3ExprCanBeNull(const Expr*);
  17372. SQLITE_PRIVATE int sqlite3ExprNeedsNoAffinityChange(const Expr*, char);
  17373. SQLITE_PRIVATE int sqlite3IsRowid(const char*);
  17374. SQLITE_PRIVATE void sqlite3GenerateRowDelete(
  17375. Parse*,Table*,Trigger*,int,int,int,i16,u8,u8,u8,int);
  17376. SQLITE_PRIVATE void sqlite3GenerateRowIndexDelete(Parse*, Table*, int, int, int*, int);
  17377. SQLITE_PRIVATE int sqlite3GenerateIndexKey(Parse*, Index*, int, int, int, int*,Index*,int);
  17378. SQLITE_PRIVATE void sqlite3ResolvePartIdxLabel(Parse*,int);
  17379. SQLITE_PRIVATE void sqlite3GenerateConstraintChecks(Parse*,Table*,int*,int,int,int,int,
  17380. u8,u8,int,int*,int*);
  17381. #ifdef SQLITE_ENABLE_NULL_TRIM
  17382. SQLITE_PRIVATE void sqlite3SetMakeRecordP5(Vdbe*,Table*);
  17383. #else
  17384. # define sqlite3SetMakeRecordP5(A,B)
  17385. #endif
  17386. SQLITE_PRIVATE void sqlite3CompleteInsertion(Parse*,Table*,int,int,int,int*,int,int,int);
  17387. SQLITE_PRIVATE int sqlite3OpenTableAndIndices(Parse*, Table*, int, u8, int, u8*, int*, int*);
  17388. SQLITE_PRIVATE void sqlite3BeginWriteOperation(Parse*, int, int);
  17389. SQLITE_PRIVATE void sqlite3MultiWrite(Parse*);
  17390. SQLITE_PRIVATE void sqlite3MayAbort(Parse*);
  17391. SQLITE_PRIVATE void sqlite3HaltConstraint(Parse*, int, int, char*, i8, u8);
  17392. SQLITE_PRIVATE void sqlite3UniqueConstraint(Parse*, int, Index*);
  17393. SQLITE_PRIVATE void sqlite3RowidConstraint(Parse*, int, Table*);
  17394. SQLITE_PRIVATE Expr *sqlite3ExprDup(sqlite3*,Expr*,int);
  17395. SQLITE_PRIVATE ExprList *sqlite3ExprListDup(sqlite3*,ExprList*,int);
  17396. SQLITE_PRIVATE SrcList *sqlite3SrcListDup(sqlite3*,SrcList*,int);
  17397. SQLITE_PRIVATE IdList *sqlite3IdListDup(sqlite3*,IdList*);
  17398. SQLITE_PRIVATE Select *sqlite3SelectDup(sqlite3*,Select*,int);
  17399. #if SELECTTRACE_ENABLED
  17400. SQLITE_PRIVATE void sqlite3SelectSetName(Select*,const char*);
  17401. #else
  17402. # define sqlite3SelectSetName(A,B)
  17403. #endif
  17404. SQLITE_PRIVATE void sqlite3InsertBuiltinFuncs(FuncDef*,int);
  17405. SQLITE_PRIVATE FuncDef *sqlite3FindFunction(sqlite3*,const char*,int,u8,u8);
  17406. SQLITE_PRIVATE void sqlite3RegisterBuiltinFunctions(void);
  17407. SQLITE_PRIVATE void sqlite3RegisterDateTimeFunctions(void);
  17408. SQLITE_PRIVATE void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3*);
  17409. SQLITE_PRIVATE int sqlite3SafetyCheckOk(sqlite3*);
  17410. SQLITE_PRIVATE int sqlite3SafetyCheckSickOrOk(sqlite3*);
  17411. SQLITE_PRIVATE void sqlite3ChangeCookie(Parse*, int);
  17412. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  17413. SQLITE_PRIVATE void sqlite3MaterializeView(Parse*, Table*, Expr*, ExprList*,Expr*,int);
  17414. #endif
  17415. #ifndef SQLITE_OMIT_TRIGGER
  17416. SQLITE_PRIVATE void sqlite3BeginTrigger(Parse*, Token*,Token*,int,int,IdList*,SrcList*,
  17417. Expr*,int, int);
  17418. SQLITE_PRIVATE void sqlite3FinishTrigger(Parse*, TriggerStep*, Token*);
  17419. SQLITE_PRIVATE void sqlite3DropTrigger(Parse*, SrcList*, int);
  17420. SQLITE_PRIVATE void sqlite3DropTriggerPtr(Parse*, Trigger*);
  17421. SQLITE_PRIVATE Trigger *sqlite3TriggersExist(Parse *, Table*, int, ExprList*, int *pMask);
  17422. SQLITE_PRIVATE Trigger *sqlite3TriggerList(Parse *, Table *);
  17423. SQLITE_PRIVATE void sqlite3CodeRowTrigger(Parse*, Trigger *, int, ExprList*, int, Table *,
  17424. int, int, int);
  17425. SQLITE_PRIVATE void sqlite3CodeRowTriggerDirect(Parse *, Trigger *, Table *, int, int, int);
  17426. void sqliteViewTriggers(Parse*, Table*, Expr*, int, ExprList*);
  17427. SQLITE_PRIVATE void sqlite3DeleteTriggerStep(sqlite3*, TriggerStep*);
  17428. SQLITE_PRIVATE TriggerStep *sqlite3TriggerSelectStep(sqlite3*,Select*,
  17429. const char*,const char*);
  17430. SQLITE_PRIVATE TriggerStep *sqlite3TriggerInsertStep(sqlite3*,Token*, IdList*,
  17431. Select*,u8,const char*,const char*);
  17432. SQLITE_PRIVATE TriggerStep *sqlite3TriggerUpdateStep(sqlite3*,Token*,ExprList*, Expr*, u8,
  17433. const char*,const char*);
  17434. SQLITE_PRIVATE TriggerStep *sqlite3TriggerDeleteStep(sqlite3*,Token*, Expr*,
  17435. const char*,const char*);
  17436. SQLITE_PRIVATE void sqlite3DeleteTrigger(sqlite3*, Trigger*);
  17437. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTrigger(sqlite3*,int,const char*);
  17438. SQLITE_PRIVATE u32 sqlite3TriggerColmask(Parse*,Trigger*,ExprList*,int,int,Table*,int);
  17439. # define sqlite3ParseToplevel(p) ((p)->pToplevel ? (p)->pToplevel : (p))
  17440. # define sqlite3IsToplevel(p) ((p)->pToplevel==0)
  17441. #else
  17442. # define sqlite3TriggersExist(B,C,D,E,F) 0
  17443. # define sqlite3DeleteTrigger(A,B)
  17444. # define sqlite3DropTriggerPtr(A,B)
  17445. # define sqlite3UnlinkAndDeleteTrigger(A,B,C)
  17446. # define sqlite3CodeRowTrigger(A,B,C,D,E,F,G,H,I)
  17447. # define sqlite3CodeRowTriggerDirect(A,B,C,D,E,F)
  17448. # define sqlite3TriggerList(X, Y) 0
  17449. # define sqlite3ParseToplevel(p) p
  17450. # define sqlite3IsToplevel(p) 1
  17451. # define sqlite3TriggerColmask(A,B,C,D,E,F,G) 0
  17452. #endif
  17453. SQLITE_PRIVATE int sqlite3JoinType(Parse*, Token*, Token*, Token*);
  17454. SQLITE_PRIVATE void sqlite3CreateForeignKey(Parse*, ExprList*, Token*, ExprList*, int);
  17455. SQLITE_PRIVATE void sqlite3DeferForeignKey(Parse*, int);
  17456. #ifndef SQLITE_OMIT_AUTHORIZATION
  17457. SQLITE_PRIVATE void sqlite3AuthRead(Parse*,Expr*,Schema*,SrcList*);
  17458. SQLITE_PRIVATE int sqlite3AuthCheck(Parse*,int, const char*, const char*, const char*);
  17459. SQLITE_PRIVATE void sqlite3AuthContextPush(Parse*, AuthContext*, const char*);
  17460. SQLITE_PRIVATE void sqlite3AuthContextPop(AuthContext*);
  17461. SQLITE_PRIVATE int sqlite3AuthReadCol(Parse*, const char *, const char *, int);
  17462. #else
  17463. # define sqlite3AuthRead(a,b,c,d)
  17464. # define sqlite3AuthCheck(a,b,c,d,e) SQLITE_OK
  17465. # define sqlite3AuthContextPush(a,b,c)
  17466. # define sqlite3AuthContextPop(a) ((void)(a))
  17467. #endif
  17468. SQLITE_PRIVATE void sqlite3Attach(Parse*, Expr*, Expr*, Expr*);
  17469. SQLITE_PRIVATE void sqlite3Detach(Parse*, Expr*);
  17470. SQLITE_PRIVATE void sqlite3FixInit(DbFixer*, Parse*, int, const char*, const Token*);
  17471. SQLITE_PRIVATE int sqlite3FixSrcList(DbFixer*, SrcList*);
  17472. SQLITE_PRIVATE int sqlite3FixSelect(DbFixer*, Select*);
  17473. SQLITE_PRIVATE int sqlite3FixExpr(DbFixer*, Expr*);
  17474. SQLITE_PRIVATE int sqlite3FixExprList(DbFixer*, ExprList*);
  17475. SQLITE_PRIVATE int sqlite3FixTriggerStep(DbFixer*, TriggerStep*);
  17476. SQLITE_PRIVATE int sqlite3AtoF(const char *z, double*, int, u8);
  17477. SQLITE_PRIVATE int sqlite3GetInt32(const char *, int*);
  17478. SQLITE_PRIVATE int sqlite3Atoi(const char*);
  17479. #ifndef SQLITE_OMIT_UTF16
  17480. SQLITE_PRIVATE int sqlite3Utf16ByteLen(const void *pData, int nChar);
  17481. #endif
  17482. SQLITE_PRIVATE int sqlite3Utf8CharLen(const char *pData, int nByte);
  17483. SQLITE_PRIVATE u32 sqlite3Utf8Read(const u8**);
  17484. SQLITE_PRIVATE LogEst sqlite3LogEst(u64);
  17485. SQLITE_PRIVATE LogEst sqlite3LogEstAdd(LogEst,LogEst);
  17486. #ifndef SQLITE_OMIT_VIRTUALTABLE
  17487. SQLITE_PRIVATE LogEst sqlite3LogEstFromDouble(double);
  17488. #endif
  17489. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
  17490. defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
  17491. defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
  17492. SQLITE_PRIVATE u64 sqlite3LogEstToInt(LogEst);
  17493. #endif
  17494. SQLITE_PRIVATE VList *sqlite3VListAdd(sqlite3*,VList*,const char*,int,int);
  17495. SQLITE_PRIVATE const char *sqlite3VListNumToName(VList*,int);
  17496. SQLITE_PRIVATE int sqlite3VListNameToNum(VList*,const char*,int);
  17497. /*
  17498. ** Routines to read and write variable-length integers. These used to
  17499. ** be defined locally, but now we use the varint routines in the util.c
  17500. ** file.
  17501. */
  17502. SQLITE_PRIVATE int sqlite3PutVarint(unsigned char*, u64);
  17503. SQLITE_PRIVATE u8 sqlite3GetVarint(const unsigned char *, u64 *);
  17504. SQLITE_PRIVATE u8 sqlite3GetVarint32(const unsigned char *, u32 *);
  17505. SQLITE_PRIVATE int sqlite3VarintLen(u64 v);
  17506. /*
  17507. ** The common case is for a varint to be a single byte. They following
  17508. ** macros handle the common case without a procedure call, but then call
  17509. ** the procedure for larger varints.
  17510. */
  17511. #define getVarint32(A,B) \
  17512. (u8)((*(A)<(u8)0x80)?((B)=(u32)*(A)),1:sqlite3GetVarint32((A),(u32 *)&(B)))
  17513. #define putVarint32(A,B) \
  17514. (u8)(((u32)(B)<(u32)0x80)?(*(A)=(unsigned char)(B)),1:\
  17515. sqlite3PutVarint((A),(B)))
  17516. #define getVarint sqlite3GetVarint
  17517. #define putVarint sqlite3PutVarint
  17518. SQLITE_PRIVATE const char *sqlite3IndexAffinityStr(sqlite3*, Index*);
  17519. SQLITE_PRIVATE void sqlite3TableAffinity(Vdbe*, Table*, int);
  17520. SQLITE_PRIVATE char sqlite3CompareAffinity(Expr *pExpr, char aff2);
  17521. SQLITE_PRIVATE int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity);
  17522. SQLITE_PRIVATE char sqlite3TableColumnAffinity(Table*,int);
  17523. SQLITE_PRIVATE char sqlite3ExprAffinity(Expr *pExpr);
  17524. SQLITE_PRIVATE int sqlite3Atoi64(const char*, i64*, int, u8);
  17525. SQLITE_PRIVATE int sqlite3DecOrHexToI64(const char*, i64*);
  17526. SQLITE_PRIVATE void sqlite3ErrorWithMsg(sqlite3*, int, const char*,...);
  17527. SQLITE_PRIVATE void sqlite3Error(sqlite3*,int);
  17528. SQLITE_PRIVATE void sqlite3SystemError(sqlite3*,int);
  17529. SQLITE_PRIVATE void *sqlite3HexToBlob(sqlite3*, const char *z, int n);
  17530. SQLITE_PRIVATE u8 sqlite3HexToInt(int h);
  17531. SQLITE_PRIVATE int sqlite3TwoPartName(Parse *, Token *, Token *, Token **);
  17532. #if defined(SQLITE_NEED_ERR_NAME)
  17533. SQLITE_PRIVATE const char *sqlite3ErrName(int);
  17534. #endif
  17535. #ifdef SQLITE_ENABLE_DESERIALIZE
  17536. SQLITE_PRIVATE int sqlite3MemdbInit(void);
  17537. #endif
  17538. SQLITE_PRIVATE const char *sqlite3ErrStr(int);
  17539. SQLITE_PRIVATE int sqlite3ReadSchema(Parse *pParse);
  17540. SQLITE_PRIVATE CollSeq *sqlite3FindCollSeq(sqlite3*,u8 enc, const char*,int);
  17541. SQLITE_PRIVATE CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char*zName);
  17542. SQLITE_PRIVATE CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr);
  17543. SQLITE_PRIVATE CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr);
  17544. SQLITE_PRIVATE int sqlite3ExprCollSeqMatch(Parse*,Expr*,Expr*);
  17545. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr*, const Token*, int);
  17546. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateString(Parse*,Expr*,const char*);
  17547. SQLITE_PRIVATE Expr *sqlite3ExprSkipCollate(Expr*);
  17548. SQLITE_PRIVATE int sqlite3CheckCollSeq(Parse *, CollSeq *);
  17549. SQLITE_PRIVATE int sqlite3CheckObjectName(Parse *, const char *);
  17550. SQLITE_PRIVATE void sqlite3VdbeSetChanges(sqlite3 *, int);
  17551. SQLITE_PRIVATE int sqlite3AddInt64(i64*,i64);
  17552. SQLITE_PRIVATE int sqlite3SubInt64(i64*,i64);
  17553. SQLITE_PRIVATE int sqlite3MulInt64(i64*,i64);
  17554. SQLITE_PRIVATE int sqlite3AbsInt32(int);
  17555. #ifdef SQLITE_ENABLE_8_3_NAMES
  17556. SQLITE_PRIVATE void sqlite3FileSuffix3(const char*, char*);
  17557. #else
  17558. # define sqlite3FileSuffix3(X,Y)
  17559. #endif
  17560. SQLITE_PRIVATE u8 sqlite3GetBoolean(const char *z,u8);
  17561. SQLITE_PRIVATE const void *sqlite3ValueText(sqlite3_value*, u8);
  17562. SQLITE_PRIVATE int sqlite3ValueBytes(sqlite3_value*, u8);
  17563. SQLITE_PRIVATE void sqlite3ValueSetStr(sqlite3_value*, int, const void *,u8,
  17564. void(*)(void*));
  17565. SQLITE_PRIVATE void sqlite3ValueSetNull(sqlite3_value*);
  17566. SQLITE_PRIVATE void sqlite3ValueFree(sqlite3_value*);
  17567. SQLITE_PRIVATE sqlite3_value *sqlite3ValueNew(sqlite3 *);
  17568. #ifndef SQLITE_OMIT_UTF16
  17569. SQLITE_PRIVATE char *sqlite3Utf16to8(sqlite3 *, const void*, int, u8);
  17570. #endif
  17571. SQLITE_PRIVATE int sqlite3ValueFromExpr(sqlite3 *, Expr *, u8, u8, sqlite3_value **);
  17572. SQLITE_PRIVATE void sqlite3ValueApplyAffinity(sqlite3_value *, u8, u8);
  17573. #ifndef SQLITE_AMALGAMATION
  17574. SQLITE_PRIVATE const unsigned char sqlite3OpcodeProperty[];
  17575. SQLITE_PRIVATE const char sqlite3StrBINARY[];
  17576. SQLITE_PRIVATE const unsigned char sqlite3UpperToLower[];
  17577. SQLITE_PRIVATE const unsigned char sqlite3CtypeMap[];
  17578. SQLITE_PRIVATE const Token sqlite3IntTokens[];
  17579. SQLITE_PRIVATE SQLITE_WSD struct Sqlite3Config sqlite3Config;
  17580. SQLITE_PRIVATE FuncDefHash sqlite3BuiltinFunctions;
  17581. #ifndef SQLITE_OMIT_WSD
  17582. SQLITE_PRIVATE int sqlite3PendingByte;
  17583. #endif
  17584. #endif
  17585. #ifdef VDBE_PROFILE
  17586. SQLITE_PRIVATE sqlite3_uint64 sqlite3NProfileCnt;
  17587. #endif
  17588. SQLITE_PRIVATE void sqlite3RootPageMoved(sqlite3*, int, int, int);
  17589. SQLITE_PRIVATE void sqlite3Reindex(Parse*, Token*, Token*);
  17590. SQLITE_PRIVATE void sqlite3AlterFunctions(void);
  17591. SQLITE_PRIVATE void sqlite3AlterRenameTable(Parse*, SrcList*, Token*);
  17592. SQLITE_PRIVATE int sqlite3GetToken(const unsigned char *, int *);
  17593. SQLITE_PRIVATE void sqlite3NestedParse(Parse*, const char*, ...);
  17594. SQLITE_PRIVATE void sqlite3ExpirePreparedStatements(sqlite3*);
  17595. SQLITE_PRIVATE int sqlite3CodeSubselect(Parse*, Expr *, int, int);
  17596. SQLITE_PRIVATE void sqlite3SelectPrep(Parse*, Select*, NameContext*);
  17597. SQLITE_PRIVATE void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p);
  17598. SQLITE_PRIVATE int sqlite3MatchSpanName(const char*, const char*, const char*, const char*);
  17599. SQLITE_PRIVATE int sqlite3ResolveExprNames(NameContext*, Expr*);
  17600. SQLITE_PRIVATE int sqlite3ResolveExprListNames(NameContext*, ExprList*);
  17601. SQLITE_PRIVATE void sqlite3ResolveSelectNames(Parse*, Select*, NameContext*);
  17602. SQLITE_PRIVATE void sqlite3ResolveSelfReference(Parse*,Table*,int,Expr*,ExprList*);
  17603. SQLITE_PRIVATE int sqlite3ResolveOrderGroupBy(Parse*, Select*, ExprList*, const char*);
  17604. SQLITE_PRIVATE void sqlite3ColumnDefault(Vdbe *, Table *, int, int);
  17605. SQLITE_PRIVATE void sqlite3AlterFinishAddColumn(Parse *, Token *);
  17606. SQLITE_PRIVATE void sqlite3AlterBeginAddColumn(Parse *, SrcList *);
  17607. SQLITE_PRIVATE CollSeq *sqlite3GetCollSeq(Parse*, u8, CollSeq *, const char*);
  17608. SQLITE_PRIVATE char sqlite3AffinityType(const char*, u8*);
  17609. SQLITE_PRIVATE void sqlite3Analyze(Parse*, Token*, Token*);
  17610. SQLITE_PRIVATE int sqlite3InvokeBusyHandler(BusyHandler*, sqlite3_file*);
  17611. SQLITE_PRIVATE int sqlite3FindDb(sqlite3*, Token*);
  17612. SQLITE_PRIVATE int sqlite3FindDbName(sqlite3 *, const char *);
  17613. SQLITE_PRIVATE int sqlite3AnalysisLoad(sqlite3*,int iDB);
  17614. SQLITE_PRIVATE void sqlite3DeleteIndexSamples(sqlite3*,Index*);
  17615. SQLITE_PRIVATE void sqlite3DefaultRowEst(Index*);
  17616. SQLITE_PRIVATE void sqlite3RegisterLikeFunctions(sqlite3*, int);
  17617. SQLITE_PRIVATE int sqlite3IsLikeFunction(sqlite3*,Expr*,int*,char*);
  17618. SQLITE_PRIVATE void sqlite3SchemaClear(void *);
  17619. SQLITE_PRIVATE Schema *sqlite3SchemaGet(sqlite3 *, Btree *);
  17620. SQLITE_PRIVATE int sqlite3SchemaToIndex(sqlite3 *db, Schema *);
  17621. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoAlloc(sqlite3*,int,int);
  17622. SQLITE_PRIVATE void sqlite3KeyInfoUnref(KeyInfo*);
  17623. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoRef(KeyInfo*);
  17624. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoOfIndex(Parse*, Index*);
  17625. #ifdef SQLITE_DEBUG
  17626. SQLITE_PRIVATE int sqlite3KeyInfoIsWriteable(KeyInfo*);
  17627. #endif
  17628. SQLITE_PRIVATE int sqlite3CreateFunc(sqlite3 *, const char *, int, int, void *,
  17629. void (*)(sqlite3_context*,int,sqlite3_value **),
  17630. void (*)(sqlite3_context*,int,sqlite3_value **), void (*)(sqlite3_context*),
  17631. FuncDestructor *pDestructor
  17632. );
  17633. SQLITE_PRIVATE void sqlite3OomFault(sqlite3*);
  17634. SQLITE_PRIVATE void sqlite3OomClear(sqlite3*);
  17635. SQLITE_PRIVATE int sqlite3ApiExit(sqlite3 *db, int);
  17636. SQLITE_PRIVATE int sqlite3OpenTempDatabase(Parse *);
  17637. SQLITE_PRIVATE void sqlite3StrAccumInit(StrAccum*, sqlite3*, char*, int, int);
  17638. SQLITE_PRIVATE void sqlite3StrAccumAppend(StrAccum*,const char*,int);
  17639. SQLITE_PRIVATE void sqlite3StrAccumAppendAll(StrAccum*,const char*);
  17640. SQLITE_PRIVATE void sqlite3AppendChar(StrAccum*,int,char);
  17641. SQLITE_PRIVATE char *sqlite3StrAccumFinish(StrAccum*);
  17642. SQLITE_PRIVATE void sqlite3StrAccumReset(StrAccum*);
  17643. SQLITE_PRIVATE void sqlite3SelectDestInit(SelectDest*,int,int);
  17644. SQLITE_PRIVATE Expr *sqlite3CreateColumnExpr(sqlite3 *, SrcList *, int, int);
  17645. SQLITE_PRIVATE void sqlite3BackupRestart(sqlite3_backup *);
  17646. SQLITE_PRIVATE void sqlite3BackupUpdate(sqlite3_backup *, Pgno, const u8 *);
  17647. #ifndef SQLITE_OMIT_SUBQUERY
  17648. SQLITE_PRIVATE int sqlite3ExprCheckIN(Parse*, Expr*);
  17649. #else
  17650. # define sqlite3ExprCheckIN(x,y) SQLITE_OK
  17651. #endif
  17652. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  17653. SQLITE_PRIVATE void sqlite3AnalyzeFunctions(void);
  17654. SQLITE_PRIVATE int sqlite3Stat4ProbeSetValue(
  17655. Parse*,Index*,UnpackedRecord**,Expr*,int,int,int*);
  17656. SQLITE_PRIVATE int sqlite3Stat4ValueFromExpr(Parse*, Expr*, u8, sqlite3_value**);
  17657. SQLITE_PRIVATE void sqlite3Stat4ProbeFree(UnpackedRecord*);
  17658. SQLITE_PRIVATE int sqlite3Stat4Column(sqlite3*, const void*, int, int, sqlite3_value**);
  17659. SQLITE_PRIVATE char sqlite3IndexColumnAffinity(sqlite3*, Index*, int);
  17660. #endif
  17661. /*
  17662. ** The interface to the LEMON-generated parser
  17663. */
  17664. #ifndef SQLITE_AMALGAMATION
  17665. SQLITE_PRIVATE void *sqlite3ParserAlloc(void*(*)(u64));
  17666. SQLITE_PRIVATE void sqlite3ParserFree(void*, void(*)(void*));
  17667. #endif
  17668. SQLITE_PRIVATE void sqlite3Parser(void*, int, Token, Parse*);
  17669. #ifdef YYTRACKMAXSTACKDEPTH
  17670. SQLITE_PRIVATE int sqlite3ParserStackPeak(void*);
  17671. #endif
  17672. SQLITE_PRIVATE void sqlite3AutoLoadExtensions(sqlite3*);
  17673. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  17674. SQLITE_PRIVATE void sqlite3CloseExtensions(sqlite3*);
  17675. #else
  17676. # define sqlite3CloseExtensions(X)
  17677. #endif
  17678. #ifndef SQLITE_OMIT_SHARED_CACHE
  17679. SQLITE_PRIVATE void sqlite3TableLock(Parse *, int, int, u8, const char *);
  17680. #else
  17681. #define sqlite3TableLock(v,w,x,y,z)
  17682. #endif
  17683. #ifdef SQLITE_TEST
  17684. SQLITE_PRIVATE int sqlite3Utf8To8(unsigned char*);
  17685. #endif
  17686. #ifdef SQLITE_OMIT_VIRTUALTABLE
  17687. # define sqlite3VtabClear(Y)
  17688. # define sqlite3VtabSync(X,Y) SQLITE_OK
  17689. # define sqlite3VtabRollback(X)
  17690. # define sqlite3VtabCommit(X)
  17691. # define sqlite3VtabInSync(db) 0
  17692. # define sqlite3VtabLock(X)
  17693. # define sqlite3VtabUnlock(X)
  17694. # define sqlite3VtabUnlockList(X)
  17695. # define sqlite3VtabSavepoint(X, Y, Z) SQLITE_OK
  17696. # define sqlite3GetVTable(X,Y) ((VTable*)0)
  17697. #else
  17698. SQLITE_PRIVATE void sqlite3VtabClear(sqlite3 *db, Table*);
  17699. SQLITE_PRIVATE void sqlite3VtabDisconnect(sqlite3 *db, Table *p);
  17700. SQLITE_PRIVATE int sqlite3VtabSync(sqlite3 *db, Vdbe*);
  17701. SQLITE_PRIVATE int sqlite3VtabRollback(sqlite3 *db);
  17702. SQLITE_PRIVATE int sqlite3VtabCommit(sqlite3 *db);
  17703. SQLITE_PRIVATE void sqlite3VtabLock(VTable *);
  17704. SQLITE_PRIVATE void sqlite3VtabUnlock(VTable *);
  17705. SQLITE_PRIVATE void sqlite3VtabUnlockList(sqlite3*);
  17706. SQLITE_PRIVATE int sqlite3VtabSavepoint(sqlite3 *, int, int);
  17707. SQLITE_PRIVATE void sqlite3VtabImportErrmsg(Vdbe*, sqlite3_vtab*);
  17708. SQLITE_PRIVATE VTable *sqlite3GetVTable(sqlite3*, Table*);
  17709. SQLITE_PRIVATE Module *sqlite3VtabCreateModule(
  17710. sqlite3*,
  17711. const char*,
  17712. const sqlite3_module*,
  17713. void*,
  17714. void(*)(void*)
  17715. );
  17716. # define sqlite3VtabInSync(db) ((db)->nVTrans>0 && (db)->aVTrans==0)
  17717. #endif
  17718. SQLITE_PRIVATE int sqlite3VtabEponymousTableInit(Parse*,Module*);
  17719. SQLITE_PRIVATE void sqlite3VtabEponymousTableClear(sqlite3*,Module*);
  17720. SQLITE_PRIVATE void sqlite3VtabMakeWritable(Parse*,Table*);
  17721. SQLITE_PRIVATE void sqlite3VtabBeginParse(Parse*, Token*, Token*, Token*, int);
  17722. SQLITE_PRIVATE void sqlite3VtabFinishParse(Parse*, Token*);
  17723. SQLITE_PRIVATE void sqlite3VtabArgInit(Parse*);
  17724. SQLITE_PRIVATE void sqlite3VtabArgExtend(Parse*, Token*);
  17725. SQLITE_PRIVATE int sqlite3VtabCallCreate(sqlite3*, int, const char *, char **);
  17726. SQLITE_PRIVATE int sqlite3VtabCallConnect(Parse*, Table*);
  17727. SQLITE_PRIVATE int sqlite3VtabCallDestroy(sqlite3*, int, const char *);
  17728. SQLITE_PRIVATE int sqlite3VtabBegin(sqlite3 *, VTable *);
  17729. SQLITE_PRIVATE FuncDef *sqlite3VtabOverloadFunction(sqlite3 *,FuncDef*, int nArg, Expr*);
  17730. SQLITE_PRIVATE void sqlite3InvalidFunction(sqlite3_context*,int,sqlite3_value**);
  17731. SQLITE_PRIVATE sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context*);
  17732. SQLITE_PRIVATE int sqlite3VdbeParameterIndex(Vdbe*, const char*, int);
  17733. SQLITE_PRIVATE int sqlite3TransferBindings(sqlite3_stmt *, sqlite3_stmt *);
  17734. SQLITE_PRIVATE void sqlite3ParserReset(Parse*);
  17735. SQLITE_PRIVATE int sqlite3Reprepare(Vdbe*);
  17736. SQLITE_PRIVATE void sqlite3ExprListCheckLength(Parse*, ExprList*, const char*);
  17737. SQLITE_PRIVATE CollSeq *sqlite3BinaryCompareCollSeq(Parse *, Expr *, Expr *);
  17738. SQLITE_PRIVATE int sqlite3TempInMemory(const sqlite3*);
  17739. SQLITE_PRIVATE const char *sqlite3JournalModename(int);
  17740. #ifndef SQLITE_OMIT_WAL
  17741. SQLITE_PRIVATE int sqlite3Checkpoint(sqlite3*, int, int, int*, int*);
  17742. SQLITE_PRIVATE int sqlite3WalDefaultHook(void*,sqlite3*,const char*,int);
  17743. #endif
  17744. #ifndef SQLITE_OMIT_CTE
  17745. SQLITE_PRIVATE With *sqlite3WithAdd(Parse*,With*,Token*,ExprList*,Select*);
  17746. SQLITE_PRIVATE void sqlite3WithDelete(sqlite3*,With*);
  17747. SQLITE_PRIVATE void sqlite3WithPush(Parse*, With*, u8);
  17748. #else
  17749. #define sqlite3WithPush(x,y,z)
  17750. #define sqlite3WithDelete(x,y)
  17751. #endif
  17752. /* Declarations for functions in fkey.c. All of these are replaced by
  17753. ** no-op macros if OMIT_FOREIGN_KEY is defined. In this case no foreign
  17754. ** key functionality is available. If OMIT_TRIGGER is defined but
  17755. ** OMIT_FOREIGN_KEY is not, only some of the functions are no-oped. In
  17756. ** this case foreign keys are parsed, but no other functionality is
  17757. ** provided (enforcement of FK constraints requires the triggers sub-system).
  17758. */
  17759. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  17760. SQLITE_PRIVATE void sqlite3FkCheck(Parse*, Table*, int, int, int*, int);
  17761. SQLITE_PRIVATE void sqlite3FkDropTable(Parse*, SrcList *, Table*);
  17762. SQLITE_PRIVATE void sqlite3FkActions(Parse*, Table*, ExprList*, int, int*, int);
  17763. SQLITE_PRIVATE int sqlite3FkRequired(Parse*, Table*, int*, int);
  17764. SQLITE_PRIVATE u32 sqlite3FkOldmask(Parse*, Table*);
  17765. SQLITE_PRIVATE FKey *sqlite3FkReferences(Table *);
  17766. #else
  17767. #define sqlite3FkActions(a,b,c,d,e,f)
  17768. #define sqlite3FkCheck(a,b,c,d,e,f)
  17769. #define sqlite3FkDropTable(a,b,c)
  17770. #define sqlite3FkOldmask(a,b) 0
  17771. #define sqlite3FkRequired(a,b,c,d) 0
  17772. #define sqlite3FkReferences(a) 0
  17773. #endif
  17774. #ifndef SQLITE_OMIT_FOREIGN_KEY
  17775. SQLITE_PRIVATE void sqlite3FkDelete(sqlite3 *, Table*);
  17776. SQLITE_PRIVATE int sqlite3FkLocateIndex(Parse*,Table*,FKey*,Index**,int**);
  17777. #else
  17778. #define sqlite3FkDelete(a,b)
  17779. #define sqlite3FkLocateIndex(a,b,c,d,e)
  17780. #endif
  17781. /*
  17782. ** Available fault injectors. Should be numbered beginning with 0.
  17783. */
  17784. #define SQLITE_FAULTINJECTOR_MALLOC 0
  17785. #define SQLITE_FAULTINJECTOR_COUNT 1
  17786. /*
  17787. ** The interface to the code in fault.c used for identifying "benign"
  17788. ** malloc failures. This is only present if SQLITE_UNTESTABLE
  17789. ** is not defined.
  17790. */
  17791. #ifndef SQLITE_UNTESTABLE
  17792. SQLITE_PRIVATE void sqlite3BeginBenignMalloc(void);
  17793. SQLITE_PRIVATE void sqlite3EndBenignMalloc(void);
  17794. #else
  17795. #define sqlite3BeginBenignMalloc()
  17796. #define sqlite3EndBenignMalloc()
  17797. #endif
  17798. /*
  17799. ** Allowed return values from sqlite3FindInIndex()
  17800. */
  17801. #define IN_INDEX_ROWID 1 /* Search the rowid of the table */
  17802. #define IN_INDEX_EPH 2 /* Search an ephemeral b-tree */
  17803. #define IN_INDEX_INDEX_ASC 3 /* Existing index ASCENDING */
  17804. #define IN_INDEX_INDEX_DESC 4 /* Existing index DESCENDING */
  17805. #define IN_INDEX_NOOP 5 /* No table available. Use comparisons */
  17806. /*
  17807. ** Allowed flags for the 3rd parameter to sqlite3FindInIndex().
  17808. */
  17809. #define IN_INDEX_NOOP_OK 0x0001 /* OK to return IN_INDEX_NOOP */
  17810. #define IN_INDEX_MEMBERSHIP 0x0002 /* IN operator used for membership test */
  17811. #define IN_INDEX_LOOP 0x0004 /* IN operator used as a loop */
  17812. SQLITE_PRIVATE int sqlite3FindInIndex(Parse *, Expr *, u32, int*, int*);
  17813. SQLITE_PRIVATE int sqlite3JournalOpen(sqlite3_vfs *, const char *, sqlite3_file *, int, int);
  17814. SQLITE_PRIVATE int sqlite3JournalSize(sqlite3_vfs *);
  17815. #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
  17816. || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  17817. SQLITE_PRIVATE int sqlite3JournalCreate(sqlite3_file *);
  17818. #endif
  17819. SQLITE_PRIVATE int sqlite3JournalIsInMemory(sqlite3_file *p);
  17820. SQLITE_PRIVATE void sqlite3MemJournalOpen(sqlite3_file *);
  17821. SQLITE_PRIVATE void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p);
  17822. #if SQLITE_MAX_EXPR_DEPTH>0
  17823. SQLITE_PRIVATE int sqlite3SelectExprHeight(Select *);
  17824. SQLITE_PRIVATE int sqlite3ExprCheckHeight(Parse*, int);
  17825. #else
  17826. #define sqlite3SelectExprHeight(x) 0
  17827. #define sqlite3ExprCheckHeight(x,y)
  17828. #endif
  17829. SQLITE_PRIVATE u32 sqlite3Get4byte(const u8*);
  17830. SQLITE_PRIVATE void sqlite3Put4byte(u8*, u32);
  17831. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  17832. SQLITE_PRIVATE void sqlite3ConnectionBlocked(sqlite3 *, sqlite3 *);
  17833. SQLITE_PRIVATE void sqlite3ConnectionUnlocked(sqlite3 *db);
  17834. SQLITE_PRIVATE void sqlite3ConnectionClosed(sqlite3 *db);
  17835. #else
  17836. #define sqlite3ConnectionBlocked(x,y)
  17837. #define sqlite3ConnectionUnlocked(x)
  17838. #define sqlite3ConnectionClosed(x)
  17839. #endif
  17840. #ifdef SQLITE_DEBUG
  17841. SQLITE_PRIVATE void sqlite3ParserTrace(FILE*, char *);
  17842. #endif
  17843. #if defined(YYCOVERAGE)
  17844. SQLITE_PRIVATE int sqlite3ParserCoverage(FILE*);
  17845. #endif
  17846. /*
  17847. ** If the SQLITE_ENABLE IOTRACE exists then the global variable
  17848. ** sqlite3IoTrace is a pointer to a printf-like routine used to
  17849. ** print I/O tracing messages.
  17850. */
  17851. #ifdef SQLITE_ENABLE_IOTRACE
  17852. # define IOTRACE(A) if( sqlite3IoTrace ){ sqlite3IoTrace A; }
  17853. SQLITE_PRIVATE void sqlite3VdbeIOTraceSql(Vdbe*);
  17854. SQLITE_API SQLITE_EXTERN void (SQLITE_CDECL *sqlite3IoTrace)(const char*,...);
  17855. #else
  17856. # define IOTRACE(A)
  17857. # define sqlite3VdbeIOTraceSql(X)
  17858. #endif
  17859. /*
  17860. ** These routines are available for the mem2.c debugging memory allocator
  17861. ** only. They are used to verify that different "types" of memory
  17862. ** allocations are properly tracked by the system.
  17863. **
  17864. ** sqlite3MemdebugSetType() sets the "type" of an allocation to one of
  17865. ** the MEMTYPE_* macros defined below. The type must be a bitmask with
  17866. ** a single bit set.
  17867. **
  17868. ** sqlite3MemdebugHasType() returns true if any of the bits in its second
  17869. ** argument match the type set by the previous sqlite3MemdebugSetType().
  17870. ** sqlite3MemdebugHasType() is intended for use inside assert() statements.
  17871. **
  17872. ** sqlite3MemdebugNoType() returns true if none of the bits in its second
  17873. ** argument match the type set by the previous sqlite3MemdebugSetType().
  17874. **
  17875. ** Perhaps the most important point is the difference between MEMTYPE_HEAP
  17876. ** and MEMTYPE_LOOKASIDE. If an allocation is MEMTYPE_LOOKASIDE, that means
  17877. ** it might have been allocated by lookaside, except the allocation was
  17878. ** too large or lookaside was already full. It is important to verify
  17879. ** that allocations that might have been satisfied by lookaside are not
  17880. ** passed back to non-lookaside free() routines. Asserts such as the
  17881. ** example above are placed on the non-lookaside free() routines to verify
  17882. ** this constraint.
  17883. **
  17884. ** All of this is no-op for a production build. It only comes into
  17885. ** play when the SQLITE_MEMDEBUG compile-time option is used.
  17886. */
  17887. #ifdef SQLITE_MEMDEBUG
  17888. SQLITE_PRIVATE void sqlite3MemdebugSetType(void*,u8);
  17889. SQLITE_PRIVATE int sqlite3MemdebugHasType(void*,u8);
  17890. SQLITE_PRIVATE int sqlite3MemdebugNoType(void*,u8);
  17891. #else
  17892. # define sqlite3MemdebugSetType(X,Y) /* no-op */
  17893. # define sqlite3MemdebugHasType(X,Y) 1
  17894. # define sqlite3MemdebugNoType(X,Y) 1
  17895. #endif
  17896. #define MEMTYPE_HEAP 0x01 /* General heap allocations */
  17897. #define MEMTYPE_LOOKASIDE 0x02 /* Heap that might have been lookaside */
  17898. #define MEMTYPE_PCACHE 0x04 /* Page cache allocations */
  17899. /*
  17900. ** Threading interface
  17901. */
  17902. #if SQLITE_MAX_WORKER_THREADS>0
  17903. SQLITE_PRIVATE int sqlite3ThreadCreate(SQLiteThread**,void*(*)(void*),void*);
  17904. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread*, void**);
  17905. #endif
  17906. #if defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST)
  17907. SQLITE_PRIVATE int sqlite3DbpageRegister(sqlite3*);
  17908. #endif
  17909. #if defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)
  17910. SQLITE_PRIVATE int sqlite3DbstatRegister(sqlite3*);
  17911. #endif
  17912. SQLITE_PRIVATE int sqlite3ExprVectorSize(Expr *pExpr);
  17913. SQLITE_PRIVATE int sqlite3ExprIsVector(Expr *pExpr);
  17914. SQLITE_PRIVATE Expr *sqlite3VectorFieldSubexpr(Expr*, int);
  17915. SQLITE_PRIVATE Expr *sqlite3ExprForVectorField(Parse*,Expr*,int);
  17916. SQLITE_PRIVATE void sqlite3VectorErrorMsg(Parse*, Expr*);
  17917. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  17918. SQLITE_PRIVATE const char **sqlite3CompileOptions(int *pnOpt);
  17919. #endif
  17920. #endif /* SQLITEINT_H */
  17921. /************** End of sqliteInt.h *******************************************/
  17922. /************** Begin file global.c ******************************************/
  17923. /*
  17924. ** 2008 June 13
  17925. **
  17926. ** The author disclaims copyright to this source code. In place of
  17927. ** a legal notice, here is a blessing:
  17928. **
  17929. ** May you do good and not evil.
  17930. ** May you find forgiveness for yourself and forgive others.
  17931. ** May you share freely, never taking more than you give.
  17932. **
  17933. *************************************************************************
  17934. **
  17935. ** This file contains definitions of global variables and constants.
  17936. */
  17937. /* #include "sqliteInt.h" */
  17938. /* An array to map all upper-case characters into their corresponding
  17939. ** lower-case character.
  17940. **
  17941. ** SQLite only considers US-ASCII (or EBCDIC) characters. We do not
  17942. ** handle case conversions for the UTF character set since the tables
  17943. ** involved are nearly as big or bigger than SQLite itself.
  17944. */
  17945. SQLITE_PRIVATE const unsigned char sqlite3UpperToLower[] = {
  17946. #ifdef SQLITE_ASCII
  17947. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
  17948. 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35,
  17949. 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
  17950. 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 97, 98, 99,100,101,102,103,
  17951. 104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,
  17952. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99,100,101,102,103,104,105,106,107,
  17953. 108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,
  17954. 126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,
  17955. 144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,
  17956. 162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,
  17957. 180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,
  17958. 198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,
  17959. 216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,
  17960. 234,235,236,237,238,239,240,241,242,243,244,245,246,247,248,249,250,251,
  17961. 252,253,254,255
  17962. #endif
  17963. #ifdef SQLITE_EBCDIC
  17964. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, /* 0x */
  17965. 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, /* 1x */
  17966. 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, /* 2x */
  17967. 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, /* 3x */
  17968. 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, /* 4x */
  17969. 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, /* 5x */
  17970. 96, 97, 98, 99,100,101,102,103,104,105,106,107,108,109,110,111, /* 6x */
  17971. 112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127, /* 7x */
  17972. 128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143, /* 8x */
  17973. 144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159, /* 9x */
  17974. 160,161,162,163,164,165,166,167,168,169,170,171,140,141,142,175, /* Ax */
  17975. 176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191, /* Bx */
  17976. 192,129,130,131,132,133,134,135,136,137,202,203,204,205,206,207, /* Cx */
  17977. 208,145,146,147,148,149,150,151,152,153,218,219,220,221,222,223, /* Dx */
  17978. 224,225,162,163,164,165,166,167,168,169,234,235,236,237,238,239, /* Ex */
  17979. 240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255, /* Fx */
  17980. #endif
  17981. };
  17982. /*
  17983. ** The following 256 byte lookup table is used to support SQLites built-in
  17984. ** equivalents to the following standard library functions:
  17985. **
  17986. ** isspace() 0x01
  17987. ** isalpha() 0x02
  17988. ** isdigit() 0x04
  17989. ** isalnum() 0x06
  17990. ** isxdigit() 0x08
  17991. ** toupper() 0x20
  17992. ** SQLite identifier character 0x40
  17993. ** Quote character 0x80
  17994. **
  17995. ** Bit 0x20 is set if the mapped character requires translation to upper
  17996. ** case. i.e. if the character is a lower-case ASCII character.
  17997. ** If x is a lower-case ASCII character, then its upper-case equivalent
  17998. ** is (x - 0x20). Therefore toupper() can be implemented as:
  17999. **
  18000. ** (x & ~(map[x]&0x20))
  18001. **
  18002. ** The equivalent of tolower() is implemented using the sqlite3UpperToLower[]
  18003. ** array. tolower() is used more often than toupper() by SQLite.
  18004. **
  18005. ** Bit 0x40 is set if the character is non-alphanumeric and can be used in an
  18006. ** SQLite identifier. Identifiers are alphanumerics, "_", "$", and any
  18007. ** non-ASCII UTF character. Hence the test for whether or not a character is
  18008. ** part of an identifier is 0x46.
  18009. */
  18010. #ifdef SQLITE_ASCII
  18011. SQLITE_PRIVATE const unsigned char sqlite3CtypeMap[256] = {
  18012. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 00..07 ........ */
  18013. 0x00, 0x01, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, /* 08..0f ........ */
  18014. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 10..17 ........ */
  18015. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 18..1f ........ */
  18016. 0x01, 0x00, 0x80, 0x00, 0x40, 0x00, 0x00, 0x80, /* 20..27 !"#$%&' */
  18017. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 28..2f ()*+,-./ */
  18018. 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, 0x0c, /* 30..37 01234567 */
  18019. 0x0c, 0x0c, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, /* 38..3f 89:;<=>? */
  18020. 0x00, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x02, /* 40..47 @ABCDEFG */
  18021. 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 48..4f HIJKLMNO */
  18022. 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 50..57 PQRSTUVW */
  18023. 0x02, 0x02, 0x02, 0x80, 0x00, 0x00, 0x00, 0x40, /* 58..5f XYZ[\]^_ */
  18024. 0x80, 0x2a, 0x2a, 0x2a, 0x2a, 0x2a, 0x2a, 0x22, /* 60..67 `abcdefg */
  18025. 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, /* 68..6f hijklmno */
  18026. 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, 0x22, /* 70..77 pqrstuvw */
  18027. 0x22, 0x22, 0x22, 0x00, 0x00, 0x00, 0x00, 0x00, /* 78..7f xyz{|}~. */
  18028. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 80..87 ........ */
  18029. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 88..8f ........ */
  18030. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 90..97 ........ */
  18031. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* 98..9f ........ */
  18032. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* a0..a7 ........ */
  18033. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* a8..af ........ */
  18034. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* b0..b7 ........ */
  18035. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* b8..bf ........ */
  18036. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* c0..c7 ........ */
  18037. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* c8..cf ........ */
  18038. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* d0..d7 ........ */
  18039. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* d8..df ........ */
  18040. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* e0..e7 ........ */
  18041. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* e8..ef ........ */
  18042. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, /* f0..f7 ........ */
  18043. 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40, 0x40 /* f8..ff ........ */
  18044. };
  18045. #endif
  18046. /* EVIDENCE-OF: R-02982-34736 In order to maintain full backwards
  18047. ** compatibility for legacy applications, the URI filename capability is
  18048. ** disabled by default.
  18049. **
  18050. ** EVIDENCE-OF: R-38799-08373 URI filenames can be enabled or disabled
  18051. ** using the SQLITE_USE_URI=1 or SQLITE_USE_URI=0 compile-time options.
  18052. **
  18053. ** EVIDENCE-OF: R-43642-56306 By default, URI handling is globally
  18054. ** disabled. The default value may be changed by compiling with the
  18055. ** SQLITE_USE_URI symbol defined.
  18056. **
  18057. ** URI filenames are enabled by default if SQLITE_HAS_CODEC is
  18058. ** enabled.
  18059. */
  18060. #ifndef SQLITE_USE_URI
  18061. # ifdef SQLITE_HAS_CODEC
  18062. # define SQLITE_USE_URI 1
  18063. # else
  18064. # define SQLITE_USE_URI 0
  18065. # endif
  18066. #endif
  18067. /* EVIDENCE-OF: R-38720-18127 The default setting is determined by the
  18068. ** SQLITE_ALLOW_COVERING_INDEX_SCAN compile-time option, or is "on" if
  18069. ** that compile-time option is omitted.
  18070. */
  18071. #ifndef SQLITE_ALLOW_COVERING_INDEX_SCAN
  18072. # define SQLITE_ALLOW_COVERING_INDEX_SCAN 1
  18073. #endif
  18074. /* The minimum PMA size is set to this value multiplied by the database
  18075. ** page size in bytes.
  18076. */
  18077. #ifndef SQLITE_SORTER_PMASZ
  18078. # define SQLITE_SORTER_PMASZ 250
  18079. #endif
  18080. /* Statement journals spill to disk when their size exceeds the following
  18081. ** threshold (in bytes). 0 means that statement journals are created and
  18082. ** written to disk immediately (the default behavior for SQLite versions
  18083. ** before 3.12.0). -1 means always keep the entire statement journal in
  18084. ** memory. (The statement journal is also always held entirely in memory
  18085. ** if journal_mode=MEMORY or if temp_store=MEMORY, regardless of this
  18086. ** setting.)
  18087. */
  18088. #ifndef SQLITE_STMTJRNL_SPILL
  18089. # define SQLITE_STMTJRNL_SPILL (64*1024)
  18090. #endif
  18091. /*
  18092. ** The default lookaside-configuration, the format "SZ,N". SZ is the
  18093. ** number of bytes in each lookaside slot (should be a multiple of 8)
  18094. ** and N is the number of slots. The lookaside-configuration can be
  18095. ** changed as start-time using sqlite3_config(SQLITE_CONFIG_LOOKASIDE)
  18096. ** or at run-time for an individual database connection using
  18097. ** sqlite3_db_config(db, SQLITE_DBCONFIG_LOOKASIDE);
  18098. */
  18099. #ifndef SQLITE_DEFAULT_LOOKASIDE
  18100. # define SQLITE_DEFAULT_LOOKASIDE 1200,100
  18101. #endif
  18102. /*
  18103. ** The following singleton contains the global configuration for
  18104. ** the SQLite library.
  18105. */
  18106. SQLITE_PRIVATE SQLITE_WSD struct Sqlite3Config sqlite3Config = {
  18107. SQLITE_DEFAULT_MEMSTATUS, /* bMemstat */
  18108. 1, /* bCoreMutex */
  18109. SQLITE_THREADSAFE==1, /* bFullMutex */
  18110. SQLITE_USE_URI, /* bOpenUri */
  18111. SQLITE_ALLOW_COVERING_INDEX_SCAN, /* bUseCis */
  18112. 0, /* bSmallMalloc */
  18113. 0x7ffffffe, /* mxStrlen */
  18114. 0, /* neverCorrupt */
  18115. SQLITE_DEFAULT_LOOKASIDE, /* szLookaside, nLookaside */
  18116. SQLITE_STMTJRNL_SPILL, /* nStmtSpill */
  18117. {0,0,0,0,0,0,0,0}, /* m */
  18118. {0,0,0,0,0,0,0,0,0}, /* mutex */
  18119. {0,0,0,0,0,0,0,0,0,0,0,0,0},/* pcache2 */
  18120. (void*)0, /* pHeap */
  18121. 0, /* nHeap */
  18122. 0, 0, /* mnHeap, mxHeap */
  18123. SQLITE_DEFAULT_MMAP_SIZE, /* szMmap */
  18124. SQLITE_MAX_MMAP_SIZE, /* mxMmap */
  18125. (void*)0, /* pPage */
  18126. 0, /* szPage */
  18127. SQLITE_DEFAULT_PCACHE_INITSZ, /* nPage */
  18128. 0, /* mxParserStack */
  18129. 0, /* sharedCacheEnabled */
  18130. SQLITE_SORTER_PMASZ, /* szPma */
  18131. /* All the rest should always be initialized to zero */
  18132. 0, /* isInit */
  18133. 0, /* inProgress */
  18134. 0, /* isMutexInit */
  18135. 0, /* isMallocInit */
  18136. 0, /* isPCacheInit */
  18137. 0, /* nRefInitMutex */
  18138. 0, /* pInitMutex */
  18139. 0, /* xLog */
  18140. 0, /* pLogArg */
  18141. #ifdef SQLITE_ENABLE_SQLLOG
  18142. 0, /* xSqllog */
  18143. 0, /* pSqllogArg */
  18144. #endif
  18145. #ifdef SQLITE_VDBE_COVERAGE
  18146. 0, /* xVdbeBranch */
  18147. 0, /* pVbeBranchArg */
  18148. #endif
  18149. #ifndef SQLITE_UNTESTABLE
  18150. 0, /* xTestCallback */
  18151. #endif
  18152. 0, /* bLocaltimeFault */
  18153. 0x7ffffffe /* iOnceResetThreshold */
  18154. };
  18155. /*
  18156. ** Hash table for global functions - functions common to all
  18157. ** database connections. After initialization, this table is
  18158. ** read-only.
  18159. */
  18160. SQLITE_PRIVATE FuncDefHash sqlite3BuiltinFunctions;
  18161. /*
  18162. ** Constant tokens for values 0 and 1.
  18163. */
  18164. SQLITE_PRIVATE const Token sqlite3IntTokens[] = {
  18165. { "0", 1 },
  18166. { "1", 1 }
  18167. };
  18168. #ifdef VDBE_PROFILE
  18169. /*
  18170. ** The following performance counter can be used in place of
  18171. ** sqlite3Hwtime() for profiling. This is a no-op on standard builds.
  18172. */
  18173. SQLITE_PRIVATE sqlite3_uint64 sqlite3NProfileCnt = 0;
  18174. #endif
  18175. /*
  18176. ** The value of the "pending" byte must be 0x40000000 (1 byte past the
  18177. ** 1-gibabyte boundary) in a compatible database. SQLite never uses
  18178. ** the database page that contains the pending byte. It never attempts
  18179. ** to read or write that page. The pending byte page is set aside
  18180. ** for use by the VFS layers as space for managing file locks.
  18181. **
  18182. ** During testing, it is often desirable to move the pending byte to
  18183. ** a different position in the file. This allows code that has to
  18184. ** deal with the pending byte to run on files that are much smaller
  18185. ** than 1 GiB. The sqlite3_test_control() interface can be used to
  18186. ** move the pending byte.
  18187. **
  18188. ** IMPORTANT: Changing the pending byte to any value other than
  18189. ** 0x40000000 results in an incompatible database file format!
  18190. ** Changing the pending byte during operation will result in undefined
  18191. ** and incorrect behavior.
  18192. */
  18193. #ifndef SQLITE_OMIT_WSD
  18194. SQLITE_PRIVATE int sqlite3PendingByte = 0x40000000;
  18195. #endif
  18196. /* #include "opcodes.h" */
  18197. /*
  18198. ** Properties of opcodes. The OPFLG_INITIALIZER macro is
  18199. ** created by mkopcodeh.awk during compilation. Data is obtained
  18200. ** from the comments following the "case OP_xxxx:" statements in
  18201. ** the vdbe.c file.
  18202. */
  18203. SQLITE_PRIVATE const unsigned char sqlite3OpcodeProperty[] = OPFLG_INITIALIZER;
  18204. /*
  18205. ** Name of the default collating sequence
  18206. */
  18207. SQLITE_PRIVATE const char sqlite3StrBINARY[] = "BINARY";
  18208. /************** End of global.c **********************************************/
  18209. /************** Begin file status.c ******************************************/
  18210. /*
  18211. ** 2008 June 18
  18212. **
  18213. ** The author disclaims copyright to this source code. In place of
  18214. ** a legal notice, here is a blessing:
  18215. **
  18216. ** May you do good and not evil.
  18217. ** May you find forgiveness for yourself and forgive others.
  18218. ** May you share freely, never taking more than you give.
  18219. **
  18220. *************************************************************************
  18221. **
  18222. ** This module implements the sqlite3_status() interface and related
  18223. ** functionality.
  18224. */
  18225. /* #include "sqliteInt.h" */
  18226. /************** Include vdbeInt.h in the middle of status.c ******************/
  18227. /************** Begin file vdbeInt.h *****************************************/
  18228. /*
  18229. ** 2003 September 6
  18230. **
  18231. ** The author disclaims copyright to this source code. In place of
  18232. ** a legal notice, here is a blessing:
  18233. **
  18234. ** May you do good and not evil.
  18235. ** May you find forgiveness for yourself and forgive others.
  18236. ** May you share freely, never taking more than you give.
  18237. **
  18238. *************************************************************************
  18239. ** This is the header file for information that is private to the
  18240. ** VDBE. This information used to all be at the top of the single
  18241. ** source code file "vdbe.c". When that file became too big (over
  18242. ** 6000 lines long) it was split up into several smaller files and
  18243. ** this header information was factored out.
  18244. */
  18245. #ifndef SQLITE_VDBEINT_H
  18246. #define SQLITE_VDBEINT_H
  18247. /*
  18248. ** The maximum number of times that a statement will try to reparse
  18249. ** itself before giving up and returning SQLITE_SCHEMA.
  18250. */
  18251. #ifndef SQLITE_MAX_SCHEMA_RETRY
  18252. # define SQLITE_MAX_SCHEMA_RETRY 50
  18253. #endif
  18254. /*
  18255. ** VDBE_DISPLAY_P4 is true or false depending on whether or not the
  18256. ** "explain" P4 display logic is enabled.
  18257. */
  18258. #if !defined(SQLITE_OMIT_EXPLAIN) || !defined(NDEBUG) \
  18259. || defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
  18260. # define VDBE_DISPLAY_P4 1
  18261. #else
  18262. # define VDBE_DISPLAY_P4 0
  18263. #endif
  18264. /*
  18265. ** SQL is translated into a sequence of instructions to be
  18266. ** executed by a virtual machine. Each instruction is an instance
  18267. ** of the following structure.
  18268. */
  18269. typedef struct VdbeOp Op;
  18270. /*
  18271. ** Boolean values
  18272. */
  18273. typedef unsigned Bool;
  18274. /* Opaque type used by code in vdbesort.c */
  18275. typedef struct VdbeSorter VdbeSorter;
  18276. /* Elements of the linked list at Vdbe.pAuxData */
  18277. typedef struct AuxData AuxData;
  18278. /* Types of VDBE cursors */
  18279. #define CURTYPE_BTREE 0
  18280. #define CURTYPE_SORTER 1
  18281. #define CURTYPE_VTAB 2
  18282. #define CURTYPE_PSEUDO 3
  18283. /*
  18284. ** A VdbeCursor is an superclass (a wrapper) for various cursor objects:
  18285. **
  18286. ** * A b-tree cursor
  18287. ** - In the main database or in an ephemeral database
  18288. ** - On either an index or a table
  18289. ** * A sorter
  18290. ** * A virtual table
  18291. ** * A one-row "pseudotable" stored in a single register
  18292. */
  18293. typedef struct VdbeCursor VdbeCursor;
  18294. struct VdbeCursor {
  18295. u8 eCurType; /* One of the CURTYPE_* values above */
  18296. i8 iDb; /* Index of cursor database in db->aDb[] (or -1) */
  18297. u8 nullRow; /* True if pointing to a row with no data */
  18298. u8 deferredMoveto; /* A call to sqlite3BtreeMoveto() is needed */
  18299. u8 isTable; /* True for rowid tables. False for indexes */
  18300. #ifdef SQLITE_DEBUG
  18301. u8 seekOp; /* Most recent seek operation on this cursor */
  18302. u8 wrFlag; /* The wrFlag argument to sqlite3BtreeCursor() */
  18303. #endif
  18304. Bool isEphemeral:1; /* True for an ephemeral table */
  18305. Bool useRandomRowid:1; /* Generate new record numbers semi-randomly */
  18306. Bool isOrdered:1; /* True if the table is not BTREE_UNORDERED */
  18307. Btree *pBtx; /* Separate file holding temporary table */
  18308. i64 seqCount; /* Sequence counter */
  18309. int *aAltMap; /* Mapping from table to index column numbers */
  18310. /* Cached OP_Column parse information is only valid if cacheStatus matches
  18311. ** Vdbe.cacheCtr. Vdbe.cacheCtr will never take on the value of
  18312. ** CACHE_STALE (0) and so setting cacheStatus=CACHE_STALE guarantees that
  18313. ** the cache is out of date. */
  18314. u32 cacheStatus; /* Cache is valid if this matches Vdbe.cacheCtr */
  18315. int seekResult; /* Result of previous sqlite3BtreeMoveto() or 0
  18316. ** if there have been no prior seeks on the cursor. */
  18317. /* seekResult does not distinguish between "no seeks have ever occurred
  18318. ** on this cursor" and "the most recent seek was an exact match".
  18319. ** For CURTYPE_PSEUDO, seekResult is the register holding the record */
  18320. /* When a new VdbeCursor is allocated, only the fields above are zeroed.
  18321. ** The fields that follow are uninitialized, and must be individually
  18322. ** initialized prior to first use. */
  18323. VdbeCursor *pAltCursor; /* Associated index cursor from which to read */
  18324. union {
  18325. BtCursor *pCursor; /* CURTYPE_BTREE or _PSEUDO. Btree cursor */
  18326. sqlite3_vtab_cursor *pVCur; /* CURTYPE_VTAB. Vtab cursor */
  18327. VdbeSorter *pSorter; /* CURTYPE_SORTER. Sorter object */
  18328. } uc;
  18329. KeyInfo *pKeyInfo; /* Info about index keys needed by index cursors */
  18330. u32 iHdrOffset; /* Offset to next unparsed byte of the header */
  18331. Pgno pgnoRoot; /* Root page of the open btree cursor */
  18332. i16 nField; /* Number of fields in the header */
  18333. u16 nHdrParsed; /* Number of header fields parsed so far */
  18334. i64 movetoTarget; /* Argument to the deferred sqlite3BtreeMoveto() */
  18335. u32 *aOffset; /* Pointer to aType[nField] */
  18336. const u8 *aRow; /* Data for the current row, if all on one page */
  18337. u32 payloadSize; /* Total number of bytes in the record */
  18338. u32 szRow; /* Byte available in aRow */
  18339. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  18340. u64 maskUsed; /* Mask of columns used by this cursor */
  18341. #endif
  18342. /* 2*nField extra array elements allocated for aType[], beyond the one
  18343. ** static element declared in the structure. nField total array slots for
  18344. ** aType[] and nField+1 array slots for aOffset[] */
  18345. u32 aType[1]; /* Type values record decode. MUST BE LAST */
  18346. };
  18347. /*
  18348. ** A value for VdbeCursor.cacheStatus that means the cache is always invalid.
  18349. */
  18350. #define CACHE_STALE 0
  18351. /*
  18352. ** When a sub-program is executed (OP_Program), a structure of this type
  18353. ** is allocated to store the current value of the program counter, as
  18354. ** well as the current memory cell array and various other frame specific
  18355. ** values stored in the Vdbe struct. When the sub-program is finished,
  18356. ** these values are copied back to the Vdbe from the VdbeFrame structure,
  18357. ** restoring the state of the VM to as it was before the sub-program
  18358. ** began executing.
  18359. **
  18360. ** The memory for a VdbeFrame object is allocated and managed by a memory
  18361. ** cell in the parent (calling) frame. When the memory cell is deleted or
  18362. ** overwritten, the VdbeFrame object is not freed immediately. Instead, it
  18363. ** is linked into the Vdbe.pDelFrame list. The contents of the Vdbe.pDelFrame
  18364. ** list is deleted when the VM is reset in VdbeHalt(). The reason for doing
  18365. ** this instead of deleting the VdbeFrame immediately is to avoid recursive
  18366. ** calls to sqlite3VdbeMemRelease() when the memory cells belonging to the
  18367. ** child frame are released.
  18368. **
  18369. ** The currently executing frame is stored in Vdbe.pFrame. Vdbe.pFrame is
  18370. ** set to NULL if the currently executing frame is the main program.
  18371. */
  18372. typedef struct VdbeFrame VdbeFrame;
  18373. struct VdbeFrame {
  18374. Vdbe *v; /* VM this frame belongs to */
  18375. VdbeFrame *pParent; /* Parent of this frame, or NULL if parent is main */
  18376. Op *aOp; /* Program instructions for parent frame */
  18377. i64 *anExec; /* Event counters from parent frame */
  18378. Mem *aMem; /* Array of memory cells for parent frame */
  18379. VdbeCursor **apCsr; /* Array of Vdbe cursors for parent frame */
  18380. u8 *aOnce; /* Bitmask used by OP_Once */
  18381. void *token; /* Copy of SubProgram.token */
  18382. i64 lastRowid; /* Last insert rowid (sqlite3.lastRowid) */
  18383. AuxData *pAuxData; /* Linked list of auxdata allocations */
  18384. int nCursor; /* Number of entries in apCsr */
  18385. int pc; /* Program Counter in parent (calling) frame */
  18386. int nOp; /* Size of aOp array */
  18387. int nMem; /* Number of entries in aMem */
  18388. int nChildMem; /* Number of memory cells for child frame */
  18389. int nChildCsr; /* Number of cursors for child frame */
  18390. int nChange; /* Statement changes (Vdbe.nChange) */
  18391. int nDbChange; /* Value of db->nChange */
  18392. };
  18393. #define VdbeFrameMem(p) ((Mem *)&((u8 *)p)[ROUND8(sizeof(VdbeFrame))])
  18394. /*
  18395. ** Internally, the vdbe manipulates nearly all SQL values as Mem
  18396. ** structures. Each Mem struct may cache multiple representations (string,
  18397. ** integer etc.) of the same value.
  18398. */
  18399. struct sqlite3_value {
  18400. union MemValue {
  18401. double r; /* Real value used when MEM_Real is set in flags */
  18402. i64 i; /* Integer value used when MEM_Int is set in flags */
  18403. int nZero; /* Extra zero bytes when MEM_Zero and MEM_Blob set */
  18404. const char *zPType; /* Pointer type when MEM_Term|MEM_Subtype|MEM_Null */
  18405. FuncDef *pDef; /* Used only when flags==MEM_Agg */
  18406. RowSet *pRowSet; /* Used only when flags==MEM_RowSet */
  18407. VdbeFrame *pFrame; /* Used when flags==MEM_Frame */
  18408. } u;
  18409. u16 flags; /* Some combination of MEM_Null, MEM_Str, MEM_Dyn, etc. */
  18410. u8 enc; /* SQLITE_UTF8, SQLITE_UTF16BE, SQLITE_UTF16LE */
  18411. u8 eSubtype; /* Subtype for this value */
  18412. int n; /* Number of characters in string value, excluding '\0' */
  18413. char *z; /* String or BLOB value */
  18414. /* ShallowCopy only needs to copy the information above */
  18415. char *zMalloc; /* Space to hold MEM_Str or MEM_Blob if szMalloc>0 */
  18416. int szMalloc; /* Size of the zMalloc allocation */
  18417. u32 uTemp; /* Transient storage for serial_type in OP_MakeRecord */
  18418. sqlite3 *db; /* The associated database connection */
  18419. void (*xDel)(void*);/* Destructor for Mem.z - only valid if MEM_Dyn */
  18420. #ifdef SQLITE_DEBUG
  18421. Mem *pScopyFrom; /* This Mem is a shallow copy of pScopyFrom */
  18422. void *pFiller; /* So that sizeof(Mem) is a multiple of 8 */
  18423. #endif
  18424. };
  18425. /*
  18426. ** Size of struct Mem not including the Mem.zMalloc member or anything that
  18427. ** follows.
  18428. */
  18429. #define MEMCELLSIZE offsetof(Mem,zMalloc)
  18430. /* One or more of the following flags are set to indicate the validOK
  18431. ** representations of the value stored in the Mem struct.
  18432. **
  18433. ** If the MEM_Null flag is set, then the value is an SQL NULL value.
  18434. ** For a pointer type created using sqlite3_bind_pointer() or
  18435. ** sqlite3_result_pointer() the MEM_Term and MEM_Subtype flags are also set.
  18436. **
  18437. ** If the MEM_Str flag is set then Mem.z points at a string representation.
  18438. ** Usually this is encoded in the same unicode encoding as the main
  18439. ** database (see below for exceptions). If the MEM_Term flag is also
  18440. ** set, then the string is nul terminated. The MEM_Int and MEM_Real
  18441. ** flags may coexist with the MEM_Str flag.
  18442. */
  18443. #define MEM_Null 0x0001 /* Value is NULL (or a pointer) */
  18444. #define MEM_Str 0x0002 /* Value is a string */
  18445. #define MEM_Int 0x0004 /* Value is an integer */
  18446. #define MEM_Real 0x0008 /* Value is a real number */
  18447. #define MEM_Blob 0x0010 /* Value is a BLOB */
  18448. #define MEM_AffMask 0x001f /* Mask of affinity bits */
  18449. #define MEM_RowSet 0x0020 /* Value is a RowSet object */
  18450. #define MEM_Frame 0x0040 /* Value is a VdbeFrame object */
  18451. #define MEM_Undefined 0x0080 /* Value is undefined */
  18452. #define MEM_Cleared 0x0100 /* NULL set by OP_Null, not from data */
  18453. #define MEM_TypeMask 0xc1ff /* Mask of type bits */
  18454. /* Whenever Mem contains a valid string or blob representation, one of
  18455. ** the following flags must be set to determine the memory management
  18456. ** policy for Mem.z. The MEM_Term flag tells us whether or not the
  18457. ** string is \000 or \u0000 terminated
  18458. */
  18459. #define MEM_Term 0x0200 /* String in Mem.z is zero terminated */
  18460. #define MEM_Dyn 0x0400 /* Need to call Mem.xDel() on Mem.z */
  18461. #define MEM_Static 0x0800 /* Mem.z points to a static string */
  18462. #define MEM_Ephem 0x1000 /* Mem.z points to an ephemeral string */
  18463. #define MEM_Agg 0x2000 /* Mem.z points to an agg function context */
  18464. #define MEM_Zero 0x4000 /* Mem.i contains count of 0s appended to blob */
  18465. #define MEM_Subtype 0x8000 /* Mem.eSubtype is valid */
  18466. #ifdef SQLITE_OMIT_INCRBLOB
  18467. #undef MEM_Zero
  18468. #define MEM_Zero 0x0000
  18469. #endif
  18470. /* Return TRUE if Mem X contains dynamically allocated content - anything
  18471. ** that needs to be deallocated to avoid a leak.
  18472. */
  18473. #define VdbeMemDynamic(X) \
  18474. (((X)->flags&(MEM_Agg|MEM_Dyn|MEM_RowSet|MEM_Frame))!=0)
  18475. /*
  18476. ** Clear any existing type flags from a Mem and replace them with f
  18477. */
  18478. #define MemSetTypeFlag(p, f) \
  18479. ((p)->flags = ((p)->flags&~(MEM_TypeMask|MEM_Zero))|f)
  18480. /*
  18481. ** Return true if a memory cell is not marked as invalid. This macro
  18482. ** is for use inside assert() statements only.
  18483. */
  18484. #ifdef SQLITE_DEBUG
  18485. #define memIsValid(M) ((M)->flags & MEM_Undefined)==0
  18486. #endif
  18487. /*
  18488. ** Each auxiliary data pointer stored by a user defined function
  18489. ** implementation calling sqlite3_set_auxdata() is stored in an instance
  18490. ** of this structure. All such structures associated with a single VM
  18491. ** are stored in a linked list headed at Vdbe.pAuxData. All are destroyed
  18492. ** when the VM is halted (if not before).
  18493. */
  18494. struct AuxData {
  18495. int iAuxOp; /* Instruction number of OP_Function opcode */
  18496. int iAuxArg; /* Index of function argument. */
  18497. void *pAux; /* Aux data pointer */
  18498. void (*xDeleteAux)(void*); /* Destructor for the aux data */
  18499. AuxData *pNextAux; /* Next element in list */
  18500. };
  18501. /*
  18502. ** The "context" argument for an installable function. A pointer to an
  18503. ** instance of this structure is the first argument to the routines used
  18504. ** implement the SQL functions.
  18505. **
  18506. ** There is a typedef for this structure in sqlite.h. So all routines,
  18507. ** even the public interface to SQLite, can use a pointer to this structure.
  18508. ** But this file is the only place where the internal details of this
  18509. ** structure are known.
  18510. **
  18511. ** This structure is defined inside of vdbeInt.h because it uses substructures
  18512. ** (Mem) which are only defined there.
  18513. */
  18514. struct sqlite3_context {
  18515. Mem *pOut; /* The return value is stored here */
  18516. FuncDef *pFunc; /* Pointer to function information */
  18517. Mem *pMem; /* Memory cell used to store aggregate context */
  18518. Vdbe *pVdbe; /* The VM that owns this context */
  18519. int iOp; /* Instruction number of OP_Function */
  18520. int isError; /* Error code returned by the function. */
  18521. u8 skipFlag; /* Skip accumulator loading if true */
  18522. u8 argc; /* Number of arguments */
  18523. sqlite3_value *argv[1]; /* Argument set */
  18524. };
  18525. /* A bitfield type for use inside of structures. Always follow with :N where
  18526. ** N is the number of bits.
  18527. */
  18528. typedef unsigned bft; /* Bit Field Type */
  18529. typedef struct ScanStatus ScanStatus;
  18530. struct ScanStatus {
  18531. int addrExplain; /* OP_Explain for loop */
  18532. int addrLoop; /* Address of "loops" counter */
  18533. int addrVisit; /* Address of "rows visited" counter */
  18534. int iSelectID; /* The "Select-ID" for this loop */
  18535. LogEst nEst; /* Estimated output rows per loop */
  18536. char *zName; /* Name of table or index */
  18537. };
  18538. /*
  18539. ** An instance of the virtual machine. This structure contains the complete
  18540. ** state of the virtual machine.
  18541. **
  18542. ** The "sqlite3_stmt" structure pointer that is returned by sqlite3_prepare()
  18543. ** is really a pointer to an instance of this structure.
  18544. */
  18545. struct Vdbe {
  18546. sqlite3 *db; /* The database connection that owns this statement */
  18547. Vdbe *pPrev,*pNext; /* Linked list of VDBEs with the same Vdbe.db */
  18548. Parse *pParse; /* Parsing context used to create this Vdbe */
  18549. ynVar nVar; /* Number of entries in aVar[] */
  18550. u32 magic; /* Magic number for sanity checking */
  18551. int nMem; /* Number of memory locations currently allocated */
  18552. int nCursor; /* Number of slots in apCsr[] */
  18553. u32 cacheCtr; /* VdbeCursor row cache generation counter */
  18554. int pc; /* The program counter */
  18555. int rc; /* Value to return */
  18556. int nChange; /* Number of db changes made since last reset */
  18557. int iStatement; /* Statement number (or 0 if has not opened stmt) */
  18558. i64 iCurrentTime; /* Value of julianday('now') for this statement */
  18559. i64 nFkConstraint; /* Number of imm. FK constraints this VM */
  18560. i64 nStmtDefCons; /* Number of def. constraints when stmt started */
  18561. i64 nStmtDefImmCons; /* Number of def. imm constraints when stmt started */
  18562. /* When allocating a new Vdbe object, all of the fields below should be
  18563. ** initialized to zero or NULL */
  18564. Op *aOp; /* Space to hold the virtual machine's program */
  18565. Mem *aMem; /* The memory locations */
  18566. Mem **apArg; /* Arguments to currently executing user function */
  18567. Mem *aColName; /* Column names to return */
  18568. Mem *pResultSet; /* Pointer to an array of results */
  18569. char *zErrMsg; /* Error message written here */
  18570. VdbeCursor **apCsr; /* One element of this array for each open cursor */
  18571. Mem *aVar; /* Values for the OP_Variable opcode. */
  18572. VList *pVList; /* Name of variables */
  18573. #ifndef SQLITE_OMIT_TRACE
  18574. i64 startTime; /* Time when query started - used for profiling */
  18575. #endif
  18576. int nOp; /* Number of instructions in the program */
  18577. #ifdef SQLITE_DEBUG
  18578. int rcApp; /* errcode set by sqlite3_result_error_code() */
  18579. #endif
  18580. u16 nResColumn; /* Number of columns in one row of the result set */
  18581. u8 errorAction; /* Recovery action to do in case of an error */
  18582. u8 minWriteFileFormat; /* Minimum file format for writable database files */
  18583. u8 prepFlags; /* SQLITE_PREPARE_* flags */
  18584. bft expired:1; /* True if the VM needs to be recompiled */
  18585. bft doingRerun:1; /* True if rerunning after an auto-reprepare */
  18586. bft explain:2; /* True if EXPLAIN present on SQL command */
  18587. bft changeCntOn:1; /* True to update the change-counter */
  18588. bft runOnlyOnce:1; /* Automatically expire on reset */
  18589. bft usesStmtJournal:1; /* True if uses a statement journal */
  18590. bft readOnly:1; /* True for statements that do not write */
  18591. bft bIsReader:1; /* True for statements that read */
  18592. yDbMask btreeMask; /* Bitmask of db->aDb[] entries referenced */
  18593. yDbMask lockMask; /* Subset of btreeMask that requires a lock */
  18594. u32 aCounter[7]; /* Counters used by sqlite3_stmt_status() */
  18595. char *zSql; /* Text of the SQL statement that generated this */
  18596. void *pFree; /* Free this when deleting the vdbe */
  18597. VdbeFrame *pFrame; /* Parent frame */
  18598. VdbeFrame *pDelFrame; /* List of frame objects to free on VM reset */
  18599. int nFrame; /* Number of frames in pFrame list */
  18600. u32 expmask; /* Binding to these vars invalidates VM */
  18601. SubProgram *pProgram; /* Linked list of all sub-programs used by VM */
  18602. AuxData *pAuxData; /* Linked list of auxdata allocations */
  18603. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  18604. i64 *anExec; /* Number of times each op has been executed */
  18605. int nScan; /* Entries in aScan[] */
  18606. ScanStatus *aScan; /* Scan definitions for sqlite3_stmt_scanstatus() */
  18607. #endif
  18608. };
  18609. /*
  18610. ** The following are allowed values for Vdbe.magic
  18611. */
  18612. #define VDBE_MAGIC_INIT 0x16bceaa5 /* Building a VDBE program */
  18613. #define VDBE_MAGIC_RUN 0x2df20da3 /* VDBE is ready to execute */
  18614. #define VDBE_MAGIC_HALT 0x319c2973 /* VDBE has completed execution */
  18615. #define VDBE_MAGIC_RESET 0x48fa9f76 /* Reset and ready to run again */
  18616. #define VDBE_MAGIC_DEAD 0x5606c3c8 /* The VDBE has been deallocated */
  18617. /*
  18618. ** Structure used to store the context required by the
  18619. ** sqlite3_preupdate_*() API functions.
  18620. */
  18621. struct PreUpdate {
  18622. Vdbe *v;
  18623. VdbeCursor *pCsr; /* Cursor to read old values from */
  18624. int op; /* One of SQLITE_INSERT, UPDATE, DELETE */
  18625. u8 *aRecord; /* old.* database record */
  18626. KeyInfo keyinfo;
  18627. UnpackedRecord *pUnpacked; /* Unpacked version of aRecord[] */
  18628. UnpackedRecord *pNewUnpacked; /* Unpacked version of new.* record */
  18629. int iNewReg; /* Register for new.* values */
  18630. i64 iKey1; /* First key value passed to hook */
  18631. i64 iKey2; /* Second key value passed to hook */
  18632. Mem *aNew; /* Array of new.* values */
  18633. Table *pTab; /* Schema object being upated */
  18634. Index *pPk; /* PK index if pTab is WITHOUT ROWID */
  18635. };
  18636. /*
  18637. ** Function prototypes
  18638. */
  18639. SQLITE_PRIVATE void sqlite3VdbeError(Vdbe*, const char *, ...);
  18640. SQLITE_PRIVATE void sqlite3VdbeFreeCursor(Vdbe *, VdbeCursor*);
  18641. void sqliteVdbePopStack(Vdbe*,int);
  18642. SQLITE_PRIVATE int sqlite3VdbeCursorMoveto(VdbeCursor**, int*);
  18643. SQLITE_PRIVATE int sqlite3VdbeCursorRestore(VdbeCursor*);
  18644. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  18645. SQLITE_PRIVATE void sqlite3VdbePrintOp(FILE*, int, Op*);
  18646. #endif
  18647. SQLITE_PRIVATE u32 sqlite3VdbeSerialTypeLen(u32);
  18648. SQLITE_PRIVATE u8 sqlite3VdbeOneByteSerialTypeLen(u8);
  18649. SQLITE_PRIVATE u32 sqlite3VdbeSerialType(Mem*, int, u32*);
  18650. SQLITE_PRIVATE u32 sqlite3VdbeSerialPut(unsigned char*, Mem*, u32);
  18651. SQLITE_PRIVATE u32 sqlite3VdbeSerialGet(const unsigned char*, u32, Mem*);
  18652. SQLITE_PRIVATE void sqlite3VdbeDeleteAuxData(sqlite3*, AuxData**, int, int);
  18653. int sqlite2BtreeKeyCompare(BtCursor *, const void *, int, int, int *);
  18654. SQLITE_PRIVATE int sqlite3VdbeIdxKeyCompare(sqlite3*,VdbeCursor*,UnpackedRecord*,int*);
  18655. SQLITE_PRIVATE int sqlite3VdbeIdxRowid(sqlite3*, BtCursor*, i64*);
  18656. SQLITE_PRIVATE int sqlite3VdbeExec(Vdbe*);
  18657. SQLITE_PRIVATE int sqlite3VdbeList(Vdbe*);
  18658. SQLITE_PRIVATE int sqlite3VdbeHalt(Vdbe*);
  18659. SQLITE_PRIVATE int sqlite3VdbeChangeEncoding(Mem *, int);
  18660. SQLITE_PRIVATE int sqlite3VdbeMemTooBig(Mem*);
  18661. SQLITE_PRIVATE int sqlite3VdbeMemCopy(Mem*, const Mem*);
  18662. SQLITE_PRIVATE void sqlite3VdbeMemShallowCopy(Mem*, const Mem*, int);
  18663. SQLITE_PRIVATE void sqlite3VdbeMemMove(Mem*, Mem*);
  18664. SQLITE_PRIVATE int sqlite3VdbeMemNulTerminate(Mem*);
  18665. SQLITE_PRIVATE int sqlite3VdbeMemSetStr(Mem*, const char*, int, u8, void(*)(void*));
  18666. SQLITE_PRIVATE void sqlite3VdbeMemSetInt64(Mem*, i64);
  18667. #ifdef SQLITE_OMIT_FLOATING_POINT
  18668. # define sqlite3VdbeMemSetDouble sqlite3VdbeMemSetInt64
  18669. #else
  18670. SQLITE_PRIVATE void sqlite3VdbeMemSetDouble(Mem*, double);
  18671. #endif
  18672. SQLITE_PRIVATE void sqlite3VdbeMemSetPointer(Mem*, void*, const char*, void(*)(void*));
  18673. SQLITE_PRIVATE void sqlite3VdbeMemInit(Mem*,sqlite3*,u16);
  18674. SQLITE_PRIVATE void sqlite3VdbeMemSetNull(Mem*);
  18675. SQLITE_PRIVATE void sqlite3VdbeMemSetZeroBlob(Mem*,int);
  18676. SQLITE_PRIVATE void sqlite3VdbeMemSetRowSet(Mem*);
  18677. SQLITE_PRIVATE int sqlite3VdbeMemMakeWriteable(Mem*);
  18678. SQLITE_PRIVATE int sqlite3VdbeMemStringify(Mem*, u8, u8);
  18679. SQLITE_PRIVATE i64 sqlite3VdbeIntValue(Mem*);
  18680. SQLITE_PRIVATE int sqlite3VdbeMemIntegerify(Mem*);
  18681. SQLITE_PRIVATE double sqlite3VdbeRealValue(Mem*);
  18682. SQLITE_PRIVATE int sqlite3VdbeBooleanValue(Mem*, int ifNull);
  18683. SQLITE_PRIVATE void sqlite3VdbeIntegerAffinity(Mem*);
  18684. SQLITE_PRIVATE int sqlite3VdbeMemRealify(Mem*);
  18685. SQLITE_PRIVATE int sqlite3VdbeMemNumerify(Mem*);
  18686. SQLITE_PRIVATE void sqlite3VdbeMemCast(Mem*,u8,u8);
  18687. SQLITE_PRIVATE int sqlite3VdbeMemFromBtree(BtCursor*,u32,u32,Mem*);
  18688. SQLITE_PRIVATE void sqlite3VdbeMemRelease(Mem *p);
  18689. SQLITE_PRIVATE int sqlite3VdbeMemFinalize(Mem*, FuncDef*);
  18690. SQLITE_PRIVATE const char *sqlite3OpcodeName(int);
  18691. SQLITE_PRIVATE int sqlite3VdbeMemGrow(Mem *pMem, int n, int preserve);
  18692. SQLITE_PRIVATE int sqlite3VdbeMemClearAndResize(Mem *pMem, int n);
  18693. SQLITE_PRIVATE int sqlite3VdbeCloseStatement(Vdbe *, int);
  18694. SQLITE_PRIVATE void sqlite3VdbeFrameDelete(VdbeFrame*);
  18695. SQLITE_PRIVATE int sqlite3VdbeFrameRestore(VdbeFrame *);
  18696. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  18697. SQLITE_PRIVATE void sqlite3VdbePreUpdateHook(Vdbe*,VdbeCursor*,int,const char*,Table*,i64,int);
  18698. #endif
  18699. SQLITE_PRIVATE int sqlite3VdbeTransferError(Vdbe *p);
  18700. SQLITE_PRIVATE int sqlite3VdbeSorterInit(sqlite3 *, int, VdbeCursor *);
  18701. SQLITE_PRIVATE void sqlite3VdbeSorterReset(sqlite3 *, VdbeSorter *);
  18702. SQLITE_PRIVATE void sqlite3VdbeSorterClose(sqlite3 *, VdbeCursor *);
  18703. SQLITE_PRIVATE int sqlite3VdbeSorterRowkey(const VdbeCursor *, Mem *);
  18704. SQLITE_PRIVATE int sqlite3VdbeSorterNext(sqlite3 *, const VdbeCursor *);
  18705. SQLITE_PRIVATE int sqlite3VdbeSorterRewind(const VdbeCursor *, int *);
  18706. SQLITE_PRIVATE int sqlite3VdbeSorterWrite(const VdbeCursor *, Mem *);
  18707. SQLITE_PRIVATE int sqlite3VdbeSorterCompare(const VdbeCursor *, Mem *, int, int *);
  18708. #if !defined(SQLITE_OMIT_SHARED_CACHE)
  18709. SQLITE_PRIVATE void sqlite3VdbeEnter(Vdbe*);
  18710. #else
  18711. # define sqlite3VdbeEnter(X)
  18712. #endif
  18713. #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
  18714. SQLITE_PRIVATE void sqlite3VdbeLeave(Vdbe*);
  18715. #else
  18716. # define sqlite3VdbeLeave(X)
  18717. #endif
  18718. #ifdef SQLITE_DEBUG
  18719. SQLITE_PRIVATE void sqlite3VdbeMemAboutToChange(Vdbe*,Mem*);
  18720. SQLITE_PRIVATE int sqlite3VdbeCheckMemInvariants(Mem*);
  18721. #endif
  18722. #ifndef SQLITE_OMIT_FOREIGN_KEY
  18723. SQLITE_PRIVATE int sqlite3VdbeCheckFk(Vdbe *, int);
  18724. #else
  18725. # define sqlite3VdbeCheckFk(p,i) 0
  18726. #endif
  18727. #ifdef SQLITE_DEBUG
  18728. SQLITE_PRIVATE void sqlite3VdbePrintSql(Vdbe*);
  18729. SQLITE_PRIVATE void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf);
  18730. #endif
  18731. #ifndef SQLITE_OMIT_UTF16
  18732. SQLITE_PRIVATE int sqlite3VdbeMemTranslate(Mem*, u8);
  18733. SQLITE_PRIVATE int sqlite3VdbeMemHandleBom(Mem *pMem);
  18734. #endif
  18735. #ifndef SQLITE_OMIT_INCRBLOB
  18736. SQLITE_PRIVATE int sqlite3VdbeMemExpandBlob(Mem *);
  18737. #define ExpandBlob(P) (((P)->flags&MEM_Zero)?sqlite3VdbeMemExpandBlob(P):0)
  18738. #else
  18739. #define sqlite3VdbeMemExpandBlob(x) SQLITE_OK
  18740. #define ExpandBlob(P) SQLITE_OK
  18741. #endif
  18742. #endif /* !defined(SQLITE_VDBEINT_H) */
  18743. /************** End of vdbeInt.h *********************************************/
  18744. /************** Continuing where we left off in status.c *********************/
  18745. /*
  18746. ** Variables in which to record status information.
  18747. */
  18748. #if SQLITE_PTRSIZE>4
  18749. typedef sqlite3_int64 sqlite3StatValueType;
  18750. #else
  18751. typedef u32 sqlite3StatValueType;
  18752. #endif
  18753. typedef struct sqlite3StatType sqlite3StatType;
  18754. static SQLITE_WSD struct sqlite3StatType {
  18755. sqlite3StatValueType nowValue[10]; /* Current value */
  18756. sqlite3StatValueType mxValue[10]; /* Maximum value */
  18757. } sqlite3Stat = { {0,}, {0,} };
  18758. /*
  18759. ** Elements of sqlite3Stat[] are protected by either the memory allocator
  18760. ** mutex, or by the pcache1 mutex. The following array determines which.
  18761. */
  18762. static const char statMutex[] = {
  18763. 0, /* SQLITE_STATUS_MEMORY_USED */
  18764. 1, /* SQLITE_STATUS_PAGECACHE_USED */
  18765. 1, /* SQLITE_STATUS_PAGECACHE_OVERFLOW */
  18766. 0, /* SQLITE_STATUS_SCRATCH_USED */
  18767. 0, /* SQLITE_STATUS_SCRATCH_OVERFLOW */
  18768. 0, /* SQLITE_STATUS_MALLOC_SIZE */
  18769. 0, /* SQLITE_STATUS_PARSER_STACK */
  18770. 1, /* SQLITE_STATUS_PAGECACHE_SIZE */
  18771. 0, /* SQLITE_STATUS_SCRATCH_SIZE */
  18772. 0, /* SQLITE_STATUS_MALLOC_COUNT */
  18773. };
  18774. /* The "wsdStat" macro will resolve to the status information
  18775. ** state vector. If writable static data is unsupported on the target,
  18776. ** we have to locate the state vector at run-time. In the more common
  18777. ** case where writable static data is supported, wsdStat can refer directly
  18778. ** to the "sqlite3Stat" state vector declared above.
  18779. */
  18780. #ifdef SQLITE_OMIT_WSD
  18781. # define wsdStatInit sqlite3StatType *x = &GLOBAL(sqlite3StatType,sqlite3Stat)
  18782. # define wsdStat x[0]
  18783. #else
  18784. # define wsdStatInit
  18785. # define wsdStat sqlite3Stat
  18786. #endif
  18787. /*
  18788. ** Return the current value of a status parameter. The caller must
  18789. ** be holding the appropriate mutex.
  18790. */
  18791. SQLITE_PRIVATE sqlite3_int64 sqlite3StatusValue(int op){
  18792. wsdStatInit;
  18793. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  18794. assert( op>=0 && op<ArraySize(statMutex) );
  18795. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  18796. : sqlite3MallocMutex()) );
  18797. return wsdStat.nowValue[op];
  18798. }
  18799. /*
  18800. ** Add N to the value of a status record. The caller must hold the
  18801. ** appropriate mutex. (Locking is checked by assert()).
  18802. **
  18803. ** The StatusUp() routine can accept positive or negative values for N.
  18804. ** The value of N is added to the current status value and the high-water
  18805. ** mark is adjusted if necessary.
  18806. **
  18807. ** The StatusDown() routine lowers the current value by N. The highwater
  18808. ** mark is unchanged. N must be non-negative for StatusDown().
  18809. */
  18810. SQLITE_PRIVATE void sqlite3StatusUp(int op, int N){
  18811. wsdStatInit;
  18812. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  18813. assert( op>=0 && op<ArraySize(statMutex) );
  18814. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  18815. : sqlite3MallocMutex()) );
  18816. wsdStat.nowValue[op] += N;
  18817. if( wsdStat.nowValue[op]>wsdStat.mxValue[op] ){
  18818. wsdStat.mxValue[op] = wsdStat.nowValue[op];
  18819. }
  18820. }
  18821. SQLITE_PRIVATE void sqlite3StatusDown(int op, int N){
  18822. wsdStatInit;
  18823. assert( N>=0 );
  18824. assert( op>=0 && op<ArraySize(statMutex) );
  18825. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  18826. : sqlite3MallocMutex()) );
  18827. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  18828. wsdStat.nowValue[op] -= N;
  18829. }
  18830. /*
  18831. ** Adjust the highwater mark if necessary.
  18832. ** The caller must hold the appropriate mutex.
  18833. */
  18834. SQLITE_PRIVATE void sqlite3StatusHighwater(int op, int X){
  18835. sqlite3StatValueType newValue;
  18836. wsdStatInit;
  18837. assert( X>=0 );
  18838. newValue = (sqlite3StatValueType)X;
  18839. assert( op>=0 && op<ArraySize(wsdStat.nowValue) );
  18840. assert( op>=0 && op<ArraySize(statMutex) );
  18841. assert( sqlite3_mutex_held(statMutex[op] ? sqlite3Pcache1Mutex()
  18842. : sqlite3MallocMutex()) );
  18843. assert( op==SQLITE_STATUS_MALLOC_SIZE
  18844. || op==SQLITE_STATUS_PAGECACHE_SIZE
  18845. || op==SQLITE_STATUS_PARSER_STACK );
  18846. if( newValue>wsdStat.mxValue[op] ){
  18847. wsdStat.mxValue[op] = newValue;
  18848. }
  18849. }
  18850. /*
  18851. ** Query status information.
  18852. */
  18853. SQLITE_API int sqlite3_status64(
  18854. int op,
  18855. sqlite3_int64 *pCurrent,
  18856. sqlite3_int64 *pHighwater,
  18857. int resetFlag
  18858. ){
  18859. sqlite3_mutex *pMutex;
  18860. wsdStatInit;
  18861. if( op<0 || op>=ArraySize(wsdStat.nowValue) ){
  18862. return SQLITE_MISUSE_BKPT;
  18863. }
  18864. #ifdef SQLITE_ENABLE_API_ARMOR
  18865. if( pCurrent==0 || pHighwater==0 ) return SQLITE_MISUSE_BKPT;
  18866. #endif
  18867. pMutex = statMutex[op] ? sqlite3Pcache1Mutex() : sqlite3MallocMutex();
  18868. sqlite3_mutex_enter(pMutex);
  18869. *pCurrent = wsdStat.nowValue[op];
  18870. *pHighwater = wsdStat.mxValue[op];
  18871. if( resetFlag ){
  18872. wsdStat.mxValue[op] = wsdStat.nowValue[op];
  18873. }
  18874. sqlite3_mutex_leave(pMutex);
  18875. (void)pMutex; /* Prevent warning when SQLITE_THREADSAFE=0 */
  18876. return SQLITE_OK;
  18877. }
  18878. SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag){
  18879. sqlite3_int64 iCur = 0, iHwtr = 0;
  18880. int rc;
  18881. #ifdef SQLITE_ENABLE_API_ARMOR
  18882. if( pCurrent==0 || pHighwater==0 ) return SQLITE_MISUSE_BKPT;
  18883. #endif
  18884. rc = sqlite3_status64(op, &iCur, &iHwtr, resetFlag);
  18885. if( rc==0 ){
  18886. *pCurrent = (int)iCur;
  18887. *pHighwater = (int)iHwtr;
  18888. }
  18889. return rc;
  18890. }
  18891. /*
  18892. ** Return the number of LookasideSlot elements on the linked list
  18893. */
  18894. static u32 countLookasideSlots(LookasideSlot *p){
  18895. u32 cnt = 0;
  18896. while( p ){
  18897. p = p->pNext;
  18898. cnt++;
  18899. }
  18900. return cnt;
  18901. }
  18902. /*
  18903. ** Count the number of slots of lookaside memory that are outstanding
  18904. */
  18905. SQLITE_PRIVATE int sqlite3LookasideUsed(sqlite3 *db, int *pHighwater){
  18906. u32 nInit = countLookasideSlots(db->lookaside.pInit);
  18907. u32 nFree = countLookasideSlots(db->lookaside.pFree);
  18908. if( pHighwater ) *pHighwater = db->lookaside.nSlot - nInit;
  18909. return db->lookaside.nSlot - (nInit+nFree);
  18910. }
  18911. /*
  18912. ** Query status information for a single database connection
  18913. */
  18914. SQLITE_API int sqlite3_db_status(
  18915. sqlite3 *db, /* The database connection whose status is desired */
  18916. int op, /* Status verb */
  18917. int *pCurrent, /* Write current value here */
  18918. int *pHighwater, /* Write high-water mark here */
  18919. int resetFlag /* Reset high-water mark if true */
  18920. ){
  18921. int rc = SQLITE_OK; /* Return code */
  18922. #ifdef SQLITE_ENABLE_API_ARMOR
  18923. if( !sqlite3SafetyCheckOk(db) || pCurrent==0|| pHighwater==0 ){
  18924. return SQLITE_MISUSE_BKPT;
  18925. }
  18926. #endif
  18927. sqlite3_mutex_enter(db->mutex);
  18928. switch( op ){
  18929. case SQLITE_DBSTATUS_LOOKASIDE_USED: {
  18930. *pCurrent = sqlite3LookasideUsed(db, pHighwater);
  18931. if( resetFlag ){
  18932. LookasideSlot *p = db->lookaside.pFree;
  18933. if( p ){
  18934. while( p->pNext ) p = p->pNext;
  18935. p->pNext = db->lookaside.pInit;
  18936. db->lookaside.pInit = db->lookaside.pFree;
  18937. db->lookaside.pFree = 0;
  18938. }
  18939. }
  18940. break;
  18941. }
  18942. case SQLITE_DBSTATUS_LOOKASIDE_HIT:
  18943. case SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE:
  18944. case SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL: {
  18945. testcase( op==SQLITE_DBSTATUS_LOOKASIDE_HIT );
  18946. testcase( op==SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE );
  18947. testcase( op==SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL );
  18948. assert( (op-SQLITE_DBSTATUS_LOOKASIDE_HIT)>=0 );
  18949. assert( (op-SQLITE_DBSTATUS_LOOKASIDE_HIT)<3 );
  18950. *pCurrent = 0;
  18951. *pHighwater = db->lookaside.anStat[op - SQLITE_DBSTATUS_LOOKASIDE_HIT];
  18952. if( resetFlag ){
  18953. db->lookaside.anStat[op - SQLITE_DBSTATUS_LOOKASIDE_HIT] = 0;
  18954. }
  18955. break;
  18956. }
  18957. /*
  18958. ** Return an approximation for the amount of memory currently used
  18959. ** by all pagers associated with the given database connection. The
  18960. ** highwater mark is meaningless and is returned as zero.
  18961. */
  18962. case SQLITE_DBSTATUS_CACHE_USED_SHARED:
  18963. case SQLITE_DBSTATUS_CACHE_USED: {
  18964. int totalUsed = 0;
  18965. int i;
  18966. sqlite3BtreeEnterAll(db);
  18967. for(i=0; i<db->nDb; i++){
  18968. Btree *pBt = db->aDb[i].pBt;
  18969. if( pBt ){
  18970. Pager *pPager = sqlite3BtreePager(pBt);
  18971. int nByte = sqlite3PagerMemUsed(pPager);
  18972. if( op==SQLITE_DBSTATUS_CACHE_USED_SHARED ){
  18973. nByte = nByte / sqlite3BtreeConnectionCount(pBt);
  18974. }
  18975. totalUsed += nByte;
  18976. }
  18977. }
  18978. sqlite3BtreeLeaveAll(db);
  18979. *pCurrent = totalUsed;
  18980. *pHighwater = 0;
  18981. break;
  18982. }
  18983. /*
  18984. ** *pCurrent gets an accurate estimate of the amount of memory used
  18985. ** to store the schema for all databases (main, temp, and any ATTACHed
  18986. ** databases. *pHighwater is set to zero.
  18987. */
  18988. case SQLITE_DBSTATUS_SCHEMA_USED: {
  18989. int i; /* Used to iterate through schemas */
  18990. int nByte = 0; /* Used to accumulate return value */
  18991. sqlite3BtreeEnterAll(db);
  18992. db->pnBytesFreed = &nByte;
  18993. for(i=0; i<db->nDb; i++){
  18994. Schema *pSchema = db->aDb[i].pSchema;
  18995. if( ALWAYS(pSchema!=0) ){
  18996. HashElem *p;
  18997. nByte += sqlite3GlobalConfig.m.xRoundup(sizeof(HashElem)) * (
  18998. pSchema->tblHash.count
  18999. + pSchema->trigHash.count
  19000. + pSchema->idxHash.count
  19001. + pSchema->fkeyHash.count
  19002. );
  19003. nByte += sqlite3_msize(pSchema->tblHash.ht);
  19004. nByte += sqlite3_msize(pSchema->trigHash.ht);
  19005. nByte += sqlite3_msize(pSchema->idxHash.ht);
  19006. nByte += sqlite3_msize(pSchema->fkeyHash.ht);
  19007. for(p=sqliteHashFirst(&pSchema->trigHash); p; p=sqliteHashNext(p)){
  19008. sqlite3DeleteTrigger(db, (Trigger*)sqliteHashData(p));
  19009. }
  19010. for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
  19011. sqlite3DeleteTable(db, (Table *)sqliteHashData(p));
  19012. }
  19013. }
  19014. }
  19015. db->pnBytesFreed = 0;
  19016. sqlite3BtreeLeaveAll(db);
  19017. *pHighwater = 0;
  19018. *pCurrent = nByte;
  19019. break;
  19020. }
  19021. /*
  19022. ** *pCurrent gets an accurate estimate of the amount of memory used
  19023. ** to store all prepared statements.
  19024. ** *pHighwater is set to zero.
  19025. */
  19026. case SQLITE_DBSTATUS_STMT_USED: {
  19027. struct Vdbe *pVdbe; /* Used to iterate through VMs */
  19028. int nByte = 0; /* Used to accumulate return value */
  19029. db->pnBytesFreed = &nByte;
  19030. for(pVdbe=db->pVdbe; pVdbe; pVdbe=pVdbe->pNext){
  19031. sqlite3VdbeClearObject(db, pVdbe);
  19032. sqlite3DbFree(db, pVdbe);
  19033. }
  19034. db->pnBytesFreed = 0;
  19035. *pHighwater = 0; /* IMP: R-64479-57858 */
  19036. *pCurrent = nByte;
  19037. break;
  19038. }
  19039. /*
  19040. ** Set *pCurrent to the total cache hits or misses encountered by all
  19041. ** pagers the database handle is connected to. *pHighwater is always set
  19042. ** to zero.
  19043. */
  19044. case SQLITE_DBSTATUS_CACHE_SPILL:
  19045. op = SQLITE_DBSTATUS_CACHE_WRITE+1;
  19046. /* Fall through into the next case */
  19047. case SQLITE_DBSTATUS_CACHE_HIT:
  19048. case SQLITE_DBSTATUS_CACHE_MISS:
  19049. case SQLITE_DBSTATUS_CACHE_WRITE:{
  19050. int i;
  19051. int nRet = 0;
  19052. assert( SQLITE_DBSTATUS_CACHE_MISS==SQLITE_DBSTATUS_CACHE_HIT+1 );
  19053. assert( SQLITE_DBSTATUS_CACHE_WRITE==SQLITE_DBSTATUS_CACHE_HIT+2 );
  19054. for(i=0; i<db->nDb; i++){
  19055. if( db->aDb[i].pBt ){
  19056. Pager *pPager = sqlite3BtreePager(db->aDb[i].pBt);
  19057. sqlite3PagerCacheStat(pPager, op, resetFlag, &nRet);
  19058. }
  19059. }
  19060. *pHighwater = 0; /* IMP: R-42420-56072 */
  19061. /* IMP: R-54100-20147 */
  19062. /* IMP: R-29431-39229 */
  19063. *pCurrent = nRet;
  19064. break;
  19065. }
  19066. /* Set *pCurrent to non-zero if there are unresolved deferred foreign
  19067. ** key constraints. Set *pCurrent to zero if all foreign key constraints
  19068. ** have been satisfied. The *pHighwater is always set to zero.
  19069. */
  19070. case SQLITE_DBSTATUS_DEFERRED_FKS: {
  19071. *pHighwater = 0; /* IMP: R-11967-56545 */
  19072. *pCurrent = db->nDeferredImmCons>0 || db->nDeferredCons>0;
  19073. break;
  19074. }
  19075. default: {
  19076. rc = SQLITE_ERROR;
  19077. }
  19078. }
  19079. sqlite3_mutex_leave(db->mutex);
  19080. return rc;
  19081. }
  19082. /************** End of status.c **********************************************/
  19083. /************** Begin file date.c ********************************************/
  19084. /*
  19085. ** 2003 October 31
  19086. **
  19087. ** The author disclaims copyright to this source code. In place of
  19088. ** a legal notice, here is a blessing:
  19089. **
  19090. ** May you do good and not evil.
  19091. ** May you find forgiveness for yourself and forgive others.
  19092. ** May you share freely, never taking more than you give.
  19093. **
  19094. *************************************************************************
  19095. ** This file contains the C functions that implement date and time
  19096. ** functions for SQLite.
  19097. **
  19098. ** There is only one exported symbol in this file - the function
  19099. ** sqlite3RegisterDateTimeFunctions() found at the bottom of the file.
  19100. ** All other code has file scope.
  19101. **
  19102. ** SQLite processes all times and dates as julian day numbers. The
  19103. ** dates and times are stored as the number of days since noon
  19104. ** in Greenwich on November 24, 4714 B.C. according to the Gregorian
  19105. ** calendar system.
  19106. **
  19107. ** 1970-01-01 00:00:00 is JD 2440587.5
  19108. ** 2000-01-01 00:00:00 is JD 2451544.5
  19109. **
  19110. ** This implementation requires years to be expressed as a 4-digit number
  19111. ** which means that only dates between 0000-01-01 and 9999-12-31 can
  19112. ** be represented, even though julian day numbers allow a much wider
  19113. ** range of dates.
  19114. **
  19115. ** The Gregorian calendar system is used for all dates and times,
  19116. ** even those that predate the Gregorian calendar. Historians usually
  19117. ** use the julian calendar for dates prior to 1582-10-15 and for some
  19118. ** dates afterwards, depending on locale. Beware of this difference.
  19119. **
  19120. ** The conversion algorithms are implemented based on descriptions
  19121. ** in the following text:
  19122. **
  19123. ** Jean Meeus
  19124. ** Astronomical Algorithms, 2nd Edition, 1998
  19125. ** ISBN 0-943396-61-1
  19126. ** Willmann-Bell, Inc
  19127. ** Richmond, Virginia (USA)
  19128. */
  19129. /* #include "sqliteInt.h" */
  19130. /* #include <stdlib.h> */
  19131. /* #include <assert.h> */
  19132. #include <time.h>
  19133. #ifndef SQLITE_OMIT_DATETIME_FUNCS
  19134. /*
  19135. ** The MSVC CRT on Windows CE may not have a localtime() function.
  19136. ** So declare a substitute. The substitute function itself is
  19137. ** defined in "os_win.c".
  19138. */
  19139. #if !defined(SQLITE_OMIT_LOCALTIME) && defined(_WIN32_WCE) && \
  19140. (!defined(SQLITE_MSVC_LOCALTIME_API) || !SQLITE_MSVC_LOCALTIME_API)
  19141. struct tm *__cdecl localtime(const time_t *);
  19142. #endif
  19143. /*
  19144. ** A structure for holding a single date and time.
  19145. */
  19146. typedef struct DateTime DateTime;
  19147. struct DateTime {
  19148. sqlite3_int64 iJD; /* The julian day number times 86400000 */
  19149. int Y, M, D; /* Year, month, and day */
  19150. int h, m; /* Hour and minutes */
  19151. int tz; /* Timezone offset in minutes */
  19152. double s; /* Seconds */
  19153. char validJD; /* True (1) if iJD is valid */
  19154. char rawS; /* Raw numeric value stored in s */
  19155. char validYMD; /* True (1) if Y,M,D are valid */
  19156. char validHMS; /* True (1) if h,m,s are valid */
  19157. char validTZ; /* True (1) if tz is valid */
  19158. char tzSet; /* Timezone was set explicitly */
  19159. char isError; /* An overflow has occurred */
  19160. };
  19161. /*
  19162. ** Convert zDate into one or more integers according to the conversion
  19163. ** specifier zFormat.
  19164. **
  19165. ** zFormat[] contains 4 characters for each integer converted, except for
  19166. ** the last integer which is specified by three characters. The meaning
  19167. ** of a four-character format specifiers ABCD is:
  19168. **
  19169. ** A: number of digits to convert. Always "2" or "4".
  19170. ** B: minimum value. Always "0" or "1".
  19171. ** C: maximum value, decoded as:
  19172. ** a: 12
  19173. ** b: 14
  19174. ** c: 24
  19175. ** d: 31
  19176. ** e: 59
  19177. ** f: 9999
  19178. ** D: the separator character, or \000 to indicate this is the
  19179. ** last number to convert.
  19180. **
  19181. ** Example: To translate an ISO-8601 date YYYY-MM-DD, the format would
  19182. ** be "40f-21a-20c". The "40f-" indicates the 4-digit year followed by "-".
  19183. ** The "21a-" indicates the 2-digit month followed by "-". The "20c" indicates
  19184. ** the 2-digit day which is the last integer in the set.
  19185. **
  19186. ** The function returns the number of successful conversions.
  19187. */
  19188. static int getDigits(const char *zDate, const char *zFormat, ...){
  19189. /* The aMx[] array translates the 3rd character of each format
  19190. ** spec into a max size: a b c d e f */
  19191. static const u16 aMx[] = { 12, 14, 24, 31, 59, 9999 };
  19192. va_list ap;
  19193. int cnt = 0;
  19194. char nextC;
  19195. va_start(ap, zFormat);
  19196. do{
  19197. char N = zFormat[0] - '0';
  19198. char min = zFormat[1] - '0';
  19199. int val = 0;
  19200. u16 max;
  19201. assert( zFormat[2]>='a' && zFormat[2]<='f' );
  19202. max = aMx[zFormat[2] - 'a'];
  19203. nextC = zFormat[3];
  19204. val = 0;
  19205. while( N-- ){
  19206. if( !sqlite3Isdigit(*zDate) ){
  19207. goto end_getDigits;
  19208. }
  19209. val = val*10 + *zDate - '0';
  19210. zDate++;
  19211. }
  19212. if( val<(int)min || val>(int)max || (nextC!=0 && nextC!=*zDate) ){
  19213. goto end_getDigits;
  19214. }
  19215. *va_arg(ap,int*) = val;
  19216. zDate++;
  19217. cnt++;
  19218. zFormat += 4;
  19219. }while( nextC );
  19220. end_getDigits:
  19221. va_end(ap);
  19222. return cnt;
  19223. }
  19224. /*
  19225. ** Parse a timezone extension on the end of a date-time.
  19226. ** The extension is of the form:
  19227. **
  19228. ** (+/-)HH:MM
  19229. **
  19230. ** Or the "zulu" notation:
  19231. **
  19232. ** Z
  19233. **
  19234. ** If the parse is successful, write the number of minutes
  19235. ** of change in p->tz and return 0. If a parser error occurs,
  19236. ** return non-zero.
  19237. **
  19238. ** A missing specifier is not considered an error.
  19239. */
  19240. static int parseTimezone(const char *zDate, DateTime *p){
  19241. int sgn = 0;
  19242. int nHr, nMn;
  19243. int c;
  19244. while( sqlite3Isspace(*zDate) ){ zDate++; }
  19245. p->tz = 0;
  19246. c = *zDate;
  19247. if( c=='-' ){
  19248. sgn = -1;
  19249. }else if( c=='+' ){
  19250. sgn = +1;
  19251. }else if( c=='Z' || c=='z' ){
  19252. zDate++;
  19253. goto zulu_time;
  19254. }else{
  19255. return c!=0;
  19256. }
  19257. zDate++;
  19258. if( getDigits(zDate, "20b:20e", &nHr, &nMn)!=2 ){
  19259. return 1;
  19260. }
  19261. zDate += 5;
  19262. p->tz = sgn*(nMn + nHr*60);
  19263. zulu_time:
  19264. while( sqlite3Isspace(*zDate) ){ zDate++; }
  19265. p->tzSet = 1;
  19266. return *zDate!=0;
  19267. }
  19268. /*
  19269. ** Parse times of the form HH:MM or HH:MM:SS or HH:MM:SS.FFFF.
  19270. ** The HH, MM, and SS must each be exactly 2 digits. The
  19271. ** fractional seconds FFFF can be one or more digits.
  19272. **
  19273. ** Return 1 if there is a parsing error and 0 on success.
  19274. */
  19275. static int parseHhMmSs(const char *zDate, DateTime *p){
  19276. int h, m, s;
  19277. double ms = 0.0;
  19278. if( getDigits(zDate, "20c:20e", &h, &m)!=2 ){
  19279. return 1;
  19280. }
  19281. zDate += 5;
  19282. if( *zDate==':' ){
  19283. zDate++;
  19284. if( getDigits(zDate, "20e", &s)!=1 ){
  19285. return 1;
  19286. }
  19287. zDate += 2;
  19288. if( *zDate=='.' && sqlite3Isdigit(zDate[1]) ){
  19289. double rScale = 1.0;
  19290. zDate++;
  19291. while( sqlite3Isdigit(*zDate) ){
  19292. ms = ms*10.0 + *zDate - '0';
  19293. rScale *= 10.0;
  19294. zDate++;
  19295. }
  19296. ms /= rScale;
  19297. }
  19298. }else{
  19299. s = 0;
  19300. }
  19301. p->validJD = 0;
  19302. p->rawS = 0;
  19303. p->validHMS = 1;
  19304. p->h = h;
  19305. p->m = m;
  19306. p->s = s + ms;
  19307. if( parseTimezone(zDate, p) ) return 1;
  19308. p->validTZ = (p->tz!=0)?1:0;
  19309. return 0;
  19310. }
  19311. /*
  19312. ** Put the DateTime object into its error state.
  19313. */
  19314. static void datetimeError(DateTime *p){
  19315. memset(p, 0, sizeof(*p));
  19316. p->isError = 1;
  19317. }
  19318. /*
  19319. ** Convert from YYYY-MM-DD HH:MM:SS to julian day. We always assume
  19320. ** that the YYYY-MM-DD is according to the Gregorian calendar.
  19321. **
  19322. ** Reference: Meeus page 61
  19323. */
  19324. static void computeJD(DateTime *p){
  19325. int Y, M, D, A, B, X1, X2;
  19326. if( p->validJD ) return;
  19327. if( p->validYMD ){
  19328. Y = p->Y;
  19329. M = p->M;
  19330. D = p->D;
  19331. }else{
  19332. Y = 2000; /* If no YMD specified, assume 2000-Jan-01 */
  19333. M = 1;
  19334. D = 1;
  19335. }
  19336. if( Y<-4713 || Y>9999 || p->rawS ){
  19337. datetimeError(p);
  19338. return;
  19339. }
  19340. if( M<=2 ){
  19341. Y--;
  19342. M += 12;
  19343. }
  19344. A = Y/100;
  19345. B = 2 - A + (A/4);
  19346. X1 = 36525*(Y+4716)/100;
  19347. X2 = 306001*(M+1)/10000;
  19348. p->iJD = (sqlite3_int64)((X1 + X2 + D + B - 1524.5 ) * 86400000);
  19349. p->validJD = 1;
  19350. if( p->validHMS ){
  19351. p->iJD += p->h*3600000 + p->m*60000 + (sqlite3_int64)(p->s*1000);
  19352. if( p->validTZ ){
  19353. p->iJD -= p->tz*60000;
  19354. p->validYMD = 0;
  19355. p->validHMS = 0;
  19356. p->validTZ = 0;
  19357. }
  19358. }
  19359. }
  19360. /*
  19361. ** Parse dates of the form
  19362. **
  19363. ** YYYY-MM-DD HH:MM:SS.FFF
  19364. ** YYYY-MM-DD HH:MM:SS
  19365. ** YYYY-MM-DD HH:MM
  19366. ** YYYY-MM-DD
  19367. **
  19368. ** Write the result into the DateTime structure and return 0
  19369. ** on success and 1 if the input string is not a well-formed
  19370. ** date.
  19371. */
  19372. static int parseYyyyMmDd(const char *zDate, DateTime *p){
  19373. int Y, M, D, neg;
  19374. if( zDate[0]=='-' ){
  19375. zDate++;
  19376. neg = 1;
  19377. }else{
  19378. neg = 0;
  19379. }
  19380. if( getDigits(zDate, "40f-21a-21d", &Y, &M, &D)!=3 ){
  19381. return 1;
  19382. }
  19383. zDate += 10;
  19384. while( sqlite3Isspace(*zDate) || 'T'==*(u8*)zDate ){ zDate++; }
  19385. if( parseHhMmSs(zDate, p)==0 ){
  19386. /* We got the time */
  19387. }else if( *zDate==0 ){
  19388. p->validHMS = 0;
  19389. }else{
  19390. return 1;
  19391. }
  19392. p->validJD = 0;
  19393. p->validYMD = 1;
  19394. p->Y = neg ? -Y : Y;
  19395. p->M = M;
  19396. p->D = D;
  19397. if( p->validTZ ){
  19398. computeJD(p);
  19399. }
  19400. return 0;
  19401. }
  19402. /*
  19403. ** Set the time to the current time reported by the VFS.
  19404. **
  19405. ** Return the number of errors.
  19406. */
  19407. static int setDateTimeToCurrent(sqlite3_context *context, DateTime *p){
  19408. p->iJD = sqlite3StmtCurrentTime(context);
  19409. if( p->iJD>0 ){
  19410. p->validJD = 1;
  19411. return 0;
  19412. }else{
  19413. return 1;
  19414. }
  19415. }
  19416. /*
  19417. ** Input "r" is a numeric quantity which might be a julian day number,
  19418. ** or the number of seconds since 1970. If the value if r is within
  19419. ** range of a julian day number, install it as such and set validJD.
  19420. ** If the value is a valid unix timestamp, put it in p->s and set p->rawS.
  19421. */
  19422. static void setRawDateNumber(DateTime *p, double r){
  19423. p->s = r;
  19424. p->rawS = 1;
  19425. if( r>=0.0 && r<5373484.5 ){
  19426. p->iJD = (sqlite3_int64)(r*86400000.0 + 0.5);
  19427. p->validJD = 1;
  19428. }
  19429. }
  19430. /*
  19431. ** Attempt to parse the given string into a julian day number. Return
  19432. ** the number of errors.
  19433. **
  19434. ** The following are acceptable forms for the input string:
  19435. **
  19436. ** YYYY-MM-DD HH:MM:SS.FFF +/-HH:MM
  19437. ** DDDD.DD
  19438. ** now
  19439. **
  19440. ** In the first form, the +/-HH:MM is always optional. The fractional
  19441. ** seconds extension (the ".FFF") is optional. The seconds portion
  19442. ** (":SS.FFF") is option. The year and date can be omitted as long
  19443. ** as there is a time string. The time string can be omitted as long
  19444. ** as there is a year and date.
  19445. */
  19446. static int parseDateOrTime(
  19447. sqlite3_context *context,
  19448. const char *zDate,
  19449. DateTime *p
  19450. ){
  19451. double r;
  19452. if( parseYyyyMmDd(zDate,p)==0 ){
  19453. return 0;
  19454. }else if( parseHhMmSs(zDate, p)==0 ){
  19455. return 0;
  19456. }else if( sqlite3StrICmp(zDate,"now")==0 && sqlite3NotPureFunc(context) ){
  19457. return setDateTimeToCurrent(context, p);
  19458. }else if( sqlite3AtoF(zDate, &r, sqlite3Strlen30(zDate), SQLITE_UTF8) ){
  19459. setRawDateNumber(p, r);
  19460. return 0;
  19461. }
  19462. return 1;
  19463. }
  19464. /* The julian day number for 9999-12-31 23:59:59.999 is 5373484.4999999.
  19465. ** Multiplying this by 86400000 gives 464269060799999 as the maximum value
  19466. ** for DateTime.iJD.
  19467. **
  19468. ** But some older compilers (ex: gcc 4.2.1 on older Macs) cannot deal with
  19469. ** such a large integer literal, so we have to encode it.
  19470. */
  19471. #define INT_464269060799999 ((((i64)0x1a640)<<32)|0x1072fdff)
  19472. /*
  19473. ** Return TRUE if the given julian day number is within range.
  19474. **
  19475. ** The input is the JulianDay times 86400000.
  19476. */
  19477. static int validJulianDay(sqlite3_int64 iJD){
  19478. return iJD>=0 && iJD<=INT_464269060799999;
  19479. }
  19480. /*
  19481. ** Compute the Year, Month, and Day from the julian day number.
  19482. */
  19483. static void computeYMD(DateTime *p){
  19484. int Z, A, B, C, D, E, X1;
  19485. if( p->validYMD ) return;
  19486. if( !p->validJD ){
  19487. p->Y = 2000;
  19488. p->M = 1;
  19489. p->D = 1;
  19490. }else if( !validJulianDay(p->iJD) ){
  19491. datetimeError(p);
  19492. return;
  19493. }else{
  19494. Z = (int)((p->iJD + 43200000)/86400000);
  19495. A = (int)((Z - 1867216.25)/36524.25);
  19496. A = Z + 1 + A - (A/4);
  19497. B = A + 1524;
  19498. C = (int)((B - 122.1)/365.25);
  19499. D = (36525*(C&32767))/100;
  19500. E = (int)((B-D)/30.6001);
  19501. X1 = (int)(30.6001*E);
  19502. p->D = B - D - X1;
  19503. p->M = E<14 ? E-1 : E-13;
  19504. p->Y = p->M>2 ? C - 4716 : C - 4715;
  19505. }
  19506. p->validYMD = 1;
  19507. }
  19508. /*
  19509. ** Compute the Hour, Minute, and Seconds from the julian day number.
  19510. */
  19511. static void computeHMS(DateTime *p){
  19512. int s;
  19513. if( p->validHMS ) return;
  19514. computeJD(p);
  19515. s = (int)((p->iJD + 43200000) % 86400000);
  19516. p->s = s/1000.0;
  19517. s = (int)p->s;
  19518. p->s -= s;
  19519. p->h = s/3600;
  19520. s -= p->h*3600;
  19521. p->m = s/60;
  19522. p->s += s - p->m*60;
  19523. p->rawS = 0;
  19524. p->validHMS = 1;
  19525. }
  19526. /*
  19527. ** Compute both YMD and HMS
  19528. */
  19529. static void computeYMD_HMS(DateTime *p){
  19530. computeYMD(p);
  19531. computeHMS(p);
  19532. }
  19533. /*
  19534. ** Clear the YMD and HMS and the TZ
  19535. */
  19536. static void clearYMD_HMS_TZ(DateTime *p){
  19537. p->validYMD = 0;
  19538. p->validHMS = 0;
  19539. p->validTZ = 0;
  19540. }
  19541. #ifndef SQLITE_OMIT_LOCALTIME
  19542. /*
  19543. ** On recent Windows platforms, the localtime_s() function is available
  19544. ** as part of the "Secure CRT". It is essentially equivalent to
  19545. ** localtime_r() available under most POSIX platforms, except that the
  19546. ** order of the parameters is reversed.
  19547. **
  19548. ** See http://msdn.microsoft.com/en-us/library/a442x3ye(VS.80).aspx.
  19549. **
  19550. ** If the user has not indicated to use localtime_r() or localtime_s()
  19551. ** already, check for an MSVC build environment that provides
  19552. ** localtime_s().
  19553. */
  19554. #if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S \
  19555. && defined(_MSC_VER) && defined(_CRT_INSECURE_DEPRECATE)
  19556. #undef HAVE_LOCALTIME_S
  19557. #define HAVE_LOCALTIME_S 1
  19558. #endif
  19559. /*
  19560. ** The following routine implements the rough equivalent of localtime_r()
  19561. ** using whatever operating-system specific localtime facility that
  19562. ** is available. This routine returns 0 on success and
  19563. ** non-zero on any kind of error.
  19564. **
  19565. ** If the sqlite3GlobalConfig.bLocaltimeFault variable is true then this
  19566. ** routine will always fail.
  19567. **
  19568. ** EVIDENCE-OF: R-62172-00036 In this implementation, the standard C
  19569. ** library function localtime_r() is used to assist in the calculation of
  19570. ** local time.
  19571. */
  19572. static int osLocaltime(time_t *t, struct tm *pTm){
  19573. int rc;
  19574. #if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S
  19575. struct tm *pX;
  19576. #if SQLITE_THREADSAFE>0
  19577. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  19578. #endif
  19579. sqlite3_mutex_enter(mutex);
  19580. pX = localtime(t);
  19581. #ifndef SQLITE_UNTESTABLE
  19582. if( sqlite3GlobalConfig.bLocaltimeFault ) pX = 0;
  19583. #endif
  19584. if( pX ) *pTm = *pX;
  19585. sqlite3_mutex_leave(mutex);
  19586. rc = pX==0;
  19587. #else
  19588. #ifndef SQLITE_UNTESTABLE
  19589. if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
  19590. #endif
  19591. #if HAVE_LOCALTIME_R
  19592. rc = localtime_r(t, pTm)==0;
  19593. #else
  19594. rc = localtime_s(pTm, t);
  19595. #endif /* HAVE_LOCALTIME_R */
  19596. #endif /* HAVE_LOCALTIME_R || HAVE_LOCALTIME_S */
  19597. return rc;
  19598. }
  19599. #endif /* SQLITE_OMIT_LOCALTIME */
  19600. #ifndef SQLITE_OMIT_LOCALTIME
  19601. /*
  19602. ** Compute the difference (in milliseconds) between localtime and UTC
  19603. ** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
  19604. ** return this value and set *pRc to SQLITE_OK.
  19605. **
  19606. ** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
  19607. ** is undefined in this case.
  19608. */
  19609. static sqlite3_int64 localtimeOffset(
  19610. DateTime *p, /* Date at which to calculate offset */
  19611. sqlite3_context *pCtx, /* Write error here if one occurs */
  19612. int *pRc /* OUT: Error code. SQLITE_OK or ERROR */
  19613. ){
  19614. DateTime x, y;
  19615. time_t t;
  19616. struct tm sLocal;
  19617. /* Initialize the contents of sLocal to avoid a compiler warning. */
  19618. memset(&sLocal, 0, sizeof(sLocal));
  19619. x = *p;
  19620. computeYMD_HMS(&x);
  19621. if( x.Y<1971 || x.Y>=2038 ){
  19622. /* EVIDENCE-OF: R-55269-29598 The localtime_r() C function normally only
  19623. ** works for years between 1970 and 2037. For dates outside this range,
  19624. ** SQLite attempts to map the year into an equivalent year within this
  19625. ** range, do the calculation, then map the year back.
  19626. */
  19627. x.Y = 2000;
  19628. x.M = 1;
  19629. x.D = 1;
  19630. x.h = 0;
  19631. x.m = 0;
  19632. x.s = 0.0;
  19633. } else {
  19634. int s = (int)(x.s + 0.5);
  19635. x.s = s;
  19636. }
  19637. x.tz = 0;
  19638. x.validJD = 0;
  19639. computeJD(&x);
  19640. t = (time_t)(x.iJD/1000 - 21086676*(i64)10000);
  19641. if( osLocaltime(&t, &sLocal) ){
  19642. sqlite3_result_error(pCtx, "local time unavailable", -1);
  19643. *pRc = SQLITE_ERROR;
  19644. return 0;
  19645. }
  19646. y.Y = sLocal.tm_year + 1900;
  19647. y.M = sLocal.tm_mon + 1;
  19648. y.D = sLocal.tm_mday;
  19649. y.h = sLocal.tm_hour;
  19650. y.m = sLocal.tm_min;
  19651. y.s = sLocal.tm_sec;
  19652. y.validYMD = 1;
  19653. y.validHMS = 1;
  19654. y.validJD = 0;
  19655. y.rawS = 0;
  19656. y.validTZ = 0;
  19657. y.isError = 0;
  19658. computeJD(&y);
  19659. *pRc = SQLITE_OK;
  19660. return y.iJD - x.iJD;
  19661. }
  19662. #endif /* SQLITE_OMIT_LOCALTIME */
  19663. /*
  19664. ** The following table defines various date transformations of the form
  19665. **
  19666. ** 'NNN days'
  19667. **
  19668. ** Where NNN is an arbitrary floating-point number and "days" can be one
  19669. ** of several units of time.
  19670. */
  19671. static const struct {
  19672. u8 eType; /* Transformation type code */
  19673. u8 nName; /* Length of th name */
  19674. char *zName; /* Name of the transformation */
  19675. double rLimit; /* Maximum NNN value for this transform */
  19676. double rXform; /* Constant used for this transform */
  19677. } aXformType[] = {
  19678. { 0, 6, "second", 464269060800.0, 86400000.0/(24.0*60.0*60.0) },
  19679. { 0, 6, "minute", 7737817680.0, 86400000.0/(24.0*60.0) },
  19680. { 0, 4, "hour", 128963628.0, 86400000.0/24.0 },
  19681. { 0, 3, "day", 5373485.0, 86400000.0 },
  19682. { 1, 5, "month", 176546.0, 30.0*86400000.0 },
  19683. { 2, 4, "year", 14713.0, 365.0*86400000.0 },
  19684. };
  19685. /*
  19686. ** Process a modifier to a date-time stamp. The modifiers are
  19687. ** as follows:
  19688. **
  19689. ** NNN days
  19690. ** NNN hours
  19691. ** NNN minutes
  19692. ** NNN.NNNN seconds
  19693. ** NNN months
  19694. ** NNN years
  19695. ** start of month
  19696. ** start of year
  19697. ** start of week
  19698. ** start of day
  19699. ** weekday N
  19700. ** unixepoch
  19701. ** localtime
  19702. ** utc
  19703. **
  19704. ** Return 0 on success and 1 if there is any kind of error. If the error
  19705. ** is in a system call (i.e. localtime()), then an error message is written
  19706. ** to context pCtx. If the error is an unrecognized modifier, no error is
  19707. ** written to pCtx.
  19708. */
  19709. static int parseModifier(
  19710. sqlite3_context *pCtx, /* Function context */
  19711. const char *z, /* The text of the modifier */
  19712. int n, /* Length of zMod in bytes */
  19713. DateTime *p /* The date/time value to be modified */
  19714. ){
  19715. int rc = 1;
  19716. double r;
  19717. switch(sqlite3UpperToLower[(u8)z[0]] ){
  19718. #ifndef SQLITE_OMIT_LOCALTIME
  19719. case 'l': {
  19720. /* localtime
  19721. **
  19722. ** Assuming the current time value is UTC (a.k.a. GMT), shift it to
  19723. ** show local time.
  19724. */
  19725. if( sqlite3_stricmp(z, "localtime")==0 && sqlite3NotPureFunc(pCtx) ){
  19726. computeJD(p);
  19727. p->iJD += localtimeOffset(p, pCtx, &rc);
  19728. clearYMD_HMS_TZ(p);
  19729. }
  19730. break;
  19731. }
  19732. #endif
  19733. case 'u': {
  19734. /*
  19735. ** unixepoch
  19736. **
  19737. ** Treat the current value of p->s as the number of
  19738. ** seconds since 1970. Convert to a real julian day number.
  19739. */
  19740. if( sqlite3_stricmp(z, "unixepoch")==0 && p->rawS ){
  19741. r = p->s*1000.0 + 210866760000000.0;
  19742. if( r>=0.0 && r<464269060800000.0 ){
  19743. clearYMD_HMS_TZ(p);
  19744. p->iJD = (sqlite3_int64)r;
  19745. p->validJD = 1;
  19746. p->rawS = 0;
  19747. rc = 0;
  19748. }
  19749. }
  19750. #ifndef SQLITE_OMIT_LOCALTIME
  19751. else if( sqlite3_stricmp(z, "utc")==0 && sqlite3NotPureFunc(pCtx) ){
  19752. if( p->tzSet==0 ){
  19753. sqlite3_int64 c1;
  19754. computeJD(p);
  19755. c1 = localtimeOffset(p, pCtx, &rc);
  19756. if( rc==SQLITE_OK ){
  19757. p->iJD -= c1;
  19758. clearYMD_HMS_TZ(p);
  19759. p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
  19760. }
  19761. p->tzSet = 1;
  19762. }else{
  19763. rc = SQLITE_OK;
  19764. }
  19765. }
  19766. #endif
  19767. break;
  19768. }
  19769. case 'w': {
  19770. /*
  19771. ** weekday N
  19772. **
  19773. ** Move the date to the same time on the next occurrence of
  19774. ** weekday N where 0==Sunday, 1==Monday, and so forth. If the
  19775. ** date is already on the appropriate weekday, this is a no-op.
  19776. */
  19777. if( sqlite3_strnicmp(z, "weekday ", 8)==0
  19778. && sqlite3AtoF(&z[8], &r, sqlite3Strlen30(&z[8]), SQLITE_UTF8)
  19779. && (n=(int)r)==r && n>=0 && r<7 ){
  19780. sqlite3_int64 Z;
  19781. computeYMD_HMS(p);
  19782. p->validTZ = 0;
  19783. p->validJD = 0;
  19784. computeJD(p);
  19785. Z = ((p->iJD + 129600000)/86400000) % 7;
  19786. if( Z>n ) Z -= 7;
  19787. p->iJD += (n - Z)*86400000;
  19788. clearYMD_HMS_TZ(p);
  19789. rc = 0;
  19790. }
  19791. break;
  19792. }
  19793. case 's': {
  19794. /*
  19795. ** start of TTTTT
  19796. **
  19797. ** Move the date backwards to the beginning of the current day,
  19798. ** or month or year.
  19799. */
  19800. if( sqlite3_strnicmp(z, "start of ", 9)!=0 ) break;
  19801. if( !p->validJD && !p->validYMD && !p->validHMS ) break;
  19802. z += 9;
  19803. computeYMD(p);
  19804. p->validHMS = 1;
  19805. p->h = p->m = 0;
  19806. p->s = 0.0;
  19807. p->rawS = 0;
  19808. p->validTZ = 0;
  19809. p->validJD = 0;
  19810. if( sqlite3_stricmp(z,"month")==0 ){
  19811. p->D = 1;
  19812. rc = 0;
  19813. }else if( sqlite3_stricmp(z,"year")==0 ){
  19814. p->M = 1;
  19815. p->D = 1;
  19816. rc = 0;
  19817. }else if( sqlite3_stricmp(z,"day")==0 ){
  19818. rc = 0;
  19819. }
  19820. break;
  19821. }
  19822. case '+':
  19823. case '-':
  19824. case '0':
  19825. case '1':
  19826. case '2':
  19827. case '3':
  19828. case '4':
  19829. case '5':
  19830. case '6':
  19831. case '7':
  19832. case '8':
  19833. case '9': {
  19834. double rRounder;
  19835. int i;
  19836. for(n=1; z[n] && z[n]!=':' && !sqlite3Isspace(z[n]); n++){}
  19837. if( !sqlite3AtoF(z, &r, n, SQLITE_UTF8) ){
  19838. rc = 1;
  19839. break;
  19840. }
  19841. if( z[n]==':' ){
  19842. /* A modifier of the form (+|-)HH:MM:SS.FFF adds (or subtracts) the
  19843. ** specified number of hours, minutes, seconds, and fractional seconds
  19844. ** to the time. The ".FFF" may be omitted. The ":SS.FFF" may be
  19845. ** omitted.
  19846. */
  19847. const char *z2 = z;
  19848. DateTime tx;
  19849. sqlite3_int64 day;
  19850. if( !sqlite3Isdigit(*z2) ) z2++;
  19851. memset(&tx, 0, sizeof(tx));
  19852. if( parseHhMmSs(z2, &tx) ) break;
  19853. computeJD(&tx);
  19854. tx.iJD -= 43200000;
  19855. day = tx.iJD/86400000;
  19856. tx.iJD -= day*86400000;
  19857. if( z[0]=='-' ) tx.iJD = -tx.iJD;
  19858. computeJD(p);
  19859. clearYMD_HMS_TZ(p);
  19860. p->iJD += tx.iJD;
  19861. rc = 0;
  19862. break;
  19863. }
  19864. /* If control reaches this point, it means the transformation is
  19865. ** one of the forms like "+NNN days". */
  19866. z += n;
  19867. while( sqlite3Isspace(*z) ) z++;
  19868. n = sqlite3Strlen30(z);
  19869. if( n>10 || n<3 ) break;
  19870. if( sqlite3UpperToLower[(u8)z[n-1]]=='s' ) n--;
  19871. computeJD(p);
  19872. rc = 1;
  19873. rRounder = r<0 ? -0.5 : +0.5;
  19874. for(i=0; i<ArraySize(aXformType); i++){
  19875. if( aXformType[i].nName==n
  19876. && sqlite3_strnicmp(aXformType[i].zName, z, n)==0
  19877. && r>-aXformType[i].rLimit && r<aXformType[i].rLimit
  19878. ){
  19879. switch( aXformType[i].eType ){
  19880. case 1: { /* Special processing to add months */
  19881. int x;
  19882. computeYMD_HMS(p);
  19883. p->M += (int)r;
  19884. x = p->M>0 ? (p->M-1)/12 : (p->M-12)/12;
  19885. p->Y += x;
  19886. p->M -= x*12;
  19887. p->validJD = 0;
  19888. r -= (int)r;
  19889. break;
  19890. }
  19891. case 2: { /* Special processing to add years */
  19892. int y = (int)r;
  19893. computeYMD_HMS(p);
  19894. p->Y += y;
  19895. p->validJD = 0;
  19896. r -= (int)r;
  19897. break;
  19898. }
  19899. }
  19900. computeJD(p);
  19901. p->iJD += (sqlite3_int64)(r*aXformType[i].rXform + rRounder);
  19902. rc = 0;
  19903. break;
  19904. }
  19905. }
  19906. clearYMD_HMS_TZ(p);
  19907. break;
  19908. }
  19909. default: {
  19910. break;
  19911. }
  19912. }
  19913. return rc;
  19914. }
  19915. /*
  19916. ** Process time function arguments. argv[0] is a date-time stamp.
  19917. ** argv[1] and following are modifiers. Parse them all and write
  19918. ** the resulting time into the DateTime structure p. Return 0
  19919. ** on success and 1 if there are any errors.
  19920. **
  19921. ** If there are zero parameters (if even argv[0] is undefined)
  19922. ** then assume a default value of "now" for argv[0].
  19923. */
  19924. static int isDate(
  19925. sqlite3_context *context,
  19926. int argc,
  19927. sqlite3_value **argv,
  19928. DateTime *p
  19929. ){
  19930. int i, n;
  19931. const unsigned char *z;
  19932. int eType;
  19933. memset(p, 0, sizeof(*p));
  19934. if( argc==0 ){
  19935. return setDateTimeToCurrent(context, p);
  19936. }
  19937. if( (eType = sqlite3_value_type(argv[0]))==SQLITE_FLOAT
  19938. || eType==SQLITE_INTEGER ){
  19939. setRawDateNumber(p, sqlite3_value_double(argv[0]));
  19940. }else{
  19941. z = sqlite3_value_text(argv[0]);
  19942. if( !z || parseDateOrTime(context, (char*)z, p) ){
  19943. return 1;
  19944. }
  19945. }
  19946. for(i=1; i<argc; i++){
  19947. z = sqlite3_value_text(argv[i]);
  19948. n = sqlite3_value_bytes(argv[i]);
  19949. if( z==0 || parseModifier(context, (char*)z, n, p) ) return 1;
  19950. }
  19951. computeJD(p);
  19952. if( p->isError || !validJulianDay(p->iJD) ) return 1;
  19953. return 0;
  19954. }
  19955. /*
  19956. ** The following routines implement the various date and time functions
  19957. ** of SQLite.
  19958. */
  19959. /*
  19960. ** julianday( TIMESTRING, MOD, MOD, ...)
  19961. **
  19962. ** Return the julian day number of the date specified in the arguments
  19963. */
  19964. static void juliandayFunc(
  19965. sqlite3_context *context,
  19966. int argc,
  19967. sqlite3_value **argv
  19968. ){
  19969. DateTime x;
  19970. if( isDate(context, argc, argv, &x)==0 ){
  19971. computeJD(&x);
  19972. sqlite3_result_double(context, x.iJD/86400000.0);
  19973. }
  19974. }
  19975. /*
  19976. ** datetime( TIMESTRING, MOD, MOD, ...)
  19977. **
  19978. ** Return YYYY-MM-DD HH:MM:SS
  19979. */
  19980. static void datetimeFunc(
  19981. sqlite3_context *context,
  19982. int argc,
  19983. sqlite3_value **argv
  19984. ){
  19985. DateTime x;
  19986. if( isDate(context, argc, argv, &x)==0 ){
  19987. char zBuf[100];
  19988. computeYMD_HMS(&x);
  19989. sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d %02d:%02d:%02d",
  19990. x.Y, x.M, x.D, x.h, x.m, (int)(x.s));
  19991. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  19992. }
  19993. }
  19994. /*
  19995. ** time( TIMESTRING, MOD, MOD, ...)
  19996. **
  19997. ** Return HH:MM:SS
  19998. */
  19999. static void timeFunc(
  20000. sqlite3_context *context,
  20001. int argc,
  20002. sqlite3_value **argv
  20003. ){
  20004. DateTime x;
  20005. if( isDate(context, argc, argv, &x)==0 ){
  20006. char zBuf[100];
  20007. computeHMS(&x);
  20008. sqlite3_snprintf(sizeof(zBuf), zBuf, "%02d:%02d:%02d", x.h, x.m, (int)x.s);
  20009. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  20010. }
  20011. }
  20012. /*
  20013. ** date( TIMESTRING, MOD, MOD, ...)
  20014. **
  20015. ** Return YYYY-MM-DD
  20016. */
  20017. static void dateFunc(
  20018. sqlite3_context *context,
  20019. int argc,
  20020. sqlite3_value **argv
  20021. ){
  20022. DateTime x;
  20023. if( isDate(context, argc, argv, &x)==0 ){
  20024. char zBuf[100];
  20025. computeYMD(&x);
  20026. sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d", x.Y, x.M, x.D);
  20027. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  20028. }
  20029. }
  20030. /*
  20031. ** strftime( FORMAT, TIMESTRING, MOD, MOD, ...)
  20032. **
  20033. ** Return a string described by FORMAT. Conversions as follows:
  20034. **
  20035. ** %d day of month
  20036. ** %f ** fractional seconds SS.SSS
  20037. ** %H hour 00-24
  20038. ** %j day of year 000-366
  20039. ** %J ** julian day number
  20040. ** %m month 01-12
  20041. ** %M minute 00-59
  20042. ** %s seconds since 1970-01-01
  20043. ** %S seconds 00-59
  20044. ** %w day of week 0-6 sunday==0
  20045. ** %W week of year 00-53
  20046. ** %Y year 0000-9999
  20047. ** %% %
  20048. */
  20049. static void strftimeFunc(
  20050. sqlite3_context *context,
  20051. int argc,
  20052. sqlite3_value **argv
  20053. ){
  20054. DateTime x;
  20055. u64 n;
  20056. size_t i,j;
  20057. char *z;
  20058. sqlite3 *db;
  20059. const char *zFmt;
  20060. char zBuf[100];
  20061. if( argc==0 ) return;
  20062. zFmt = (const char*)sqlite3_value_text(argv[0]);
  20063. if( zFmt==0 || isDate(context, argc-1, argv+1, &x) ) return;
  20064. db = sqlite3_context_db_handle(context);
  20065. for(i=0, n=1; zFmt[i]; i++, n++){
  20066. if( zFmt[i]=='%' ){
  20067. switch( zFmt[i+1] ){
  20068. case 'd':
  20069. case 'H':
  20070. case 'm':
  20071. case 'M':
  20072. case 'S':
  20073. case 'W':
  20074. n++;
  20075. /* fall thru */
  20076. case 'w':
  20077. case '%':
  20078. break;
  20079. case 'f':
  20080. n += 8;
  20081. break;
  20082. case 'j':
  20083. n += 3;
  20084. break;
  20085. case 'Y':
  20086. n += 8;
  20087. break;
  20088. case 's':
  20089. case 'J':
  20090. n += 50;
  20091. break;
  20092. default:
  20093. return; /* ERROR. return a NULL */
  20094. }
  20095. i++;
  20096. }
  20097. }
  20098. testcase( n==sizeof(zBuf)-1 );
  20099. testcase( n==sizeof(zBuf) );
  20100. testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
  20101. testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH] );
  20102. if( n<sizeof(zBuf) ){
  20103. z = zBuf;
  20104. }else if( n>(u64)db->aLimit[SQLITE_LIMIT_LENGTH] ){
  20105. sqlite3_result_error_toobig(context);
  20106. return;
  20107. }else{
  20108. z = sqlite3DbMallocRawNN(db, (int)n);
  20109. if( z==0 ){
  20110. sqlite3_result_error_nomem(context);
  20111. return;
  20112. }
  20113. }
  20114. computeJD(&x);
  20115. computeYMD_HMS(&x);
  20116. for(i=j=0; zFmt[i]; i++){
  20117. if( zFmt[i]!='%' ){
  20118. z[j++] = zFmt[i];
  20119. }else{
  20120. i++;
  20121. switch( zFmt[i] ){
  20122. case 'd': sqlite3_snprintf(3, &z[j],"%02d",x.D); j+=2; break;
  20123. case 'f': {
  20124. double s = x.s;
  20125. if( s>59.999 ) s = 59.999;
  20126. sqlite3_snprintf(7, &z[j],"%06.3f", s);
  20127. j += sqlite3Strlen30(&z[j]);
  20128. break;
  20129. }
  20130. case 'H': sqlite3_snprintf(3, &z[j],"%02d",x.h); j+=2; break;
  20131. case 'W': /* Fall thru */
  20132. case 'j': {
  20133. int nDay; /* Number of days since 1st day of year */
  20134. DateTime y = x;
  20135. y.validJD = 0;
  20136. y.M = 1;
  20137. y.D = 1;
  20138. computeJD(&y);
  20139. nDay = (int)((x.iJD-y.iJD+43200000)/86400000);
  20140. if( zFmt[i]=='W' ){
  20141. int wd; /* 0=Monday, 1=Tuesday, ... 6=Sunday */
  20142. wd = (int)(((x.iJD+43200000)/86400000)%7);
  20143. sqlite3_snprintf(3, &z[j],"%02d",(nDay+7-wd)/7);
  20144. j += 2;
  20145. }else{
  20146. sqlite3_snprintf(4, &z[j],"%03d",nDay+1);
  20147. j += 3;
  20148. }
  20149. break;
  20150. }
  20151. case 'J': {
  20152. sqlite3_snprintf(20, &z[j],"%.16g",x.iJD/86400000.0);
  20153. j+=sqlite3Strlen30(&z[j]);
  20154. break;
  20155. }
  20156. case 'm': sqlite3_snprintf(3, &z[j],"%02d",x.M); j+=2; break;
  20157. case 'M': sqlite3_snprintf(3, &z[j],"%02d",x.m); j+=2; break;
  20158. case 's': {
  20159. sqlite3_snprintf(30,&z[j],"%lld",
  20160. (i64)(x.iJD/1000 - 21086676*(i64)10000));
  20161. j += sqlite3Strlen30(&z[j]);
  20162. break;
  20163. }
  20164. case 'S': sqlite3_snprintf(3,&z[j],"%02d",(int)x.s); j+=2; break;
  20165. case 'w': {
  20166. z[j++] = (char)(((x.iJD+129600000)/86400000) % 7) + '0';
  20167. break;
  20168. }
  20169. case 'Y': {
  20170. sqlite3_snprintf(5,&z[j],"%04d",x.Y); j+=sqlite3Strlen30(&z[j]);
  20171. break;
  20172. }
  20173. default: z[j++] = '%'; break;
  20174. }
  20175. }
  20176. }
  20177. z[j] = 0;
  20178. sqlite3_result_text(context, z, -1,
  20179. z==zBuf ? SQLITE_TRANSIENT : SQLITE_DYNAMIC);
  20180. }
  20181. /*
  20182. ** current_time()
  20183. **
  20184. ** This function returns the same value as time('now').
  20185. */
  20186. static void ctimeFunc(
  20187. sqlite3_context *context,
  20188. int NotUsed,
  20189. sqlite3_value **NotUsed2
  20190. ){
  20191. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  20192. timeFunc(context, 0, 0);
  20193. }
  20194. /*
  20195. ** current_date()
  20196. **
  20197. ** This function returns the same value as date('now').
  20198. */
  20199. static void cdateFunc(
  20200. sqlite3_context *context,
  20201. int NotUsed,
  20202. sqlite3_value **NotUsed2
  20203. ){
  20204. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  20205. dateFunc(context, 0, 0);
  20206. }
  20207. /*
  20208. ** current_timestamp()
  20209. **
  20210. ** This function returns the same value as datetime('now').
  20211. */
  20212. static void ctimestampFunc(
  20213. sqlite3_context *context,
  20214. int NotUsed,
  20215. sqlite3_value **NotUsed2
  20216. ){
  20217. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  20218. datetimeFunc(context, 0, 0);
  20219. }
  20220. #endif /* !defined(SQLITE_OMIT_DATETIME_FUNCS) */
  20221. #ifdef SQLITE_OMIT_DATETIME_FUNCS
  20222. /*
  20223. ** If the library is compiled to omit the full-scale date and time
  20224. ** handling (to get a smaller binary), the following minimal version
  20225. ** of the functions current_time(), current_date() and current_timestamp()
  20226. ** are included instead. This is to support column declarations that
  20227. ** include "DEFAULT CURRENT_TIME" etc.
  20228. **
  20229. ** This function uses the C-library functions time(), gmtime()
  20230. ** and strftime(). The format string to pass to strftime() is supplied
  20231. ** as the user-data for the function.
  20232. */
  20233. static void currentTimeFunc(
  20234. sqlite3_context *context,
  20235. int argc,
  20236. sqlite3_value **argv
  20237. ){
  20238. time_t t;
  20239. char *zFormat = (char *)sqlite3_user_data(context);
  20240. sqlite3_int64 iT;
  20241. struct tm *pTm;
  20242. struct tm sNow;
  20243. char zBuf[20];
  20244. UNUSED_PARAMETER(argc);
  20245. UNUSED_PARAMETER(argv);
  20246. iT = sqlite3StmtCurrentTime(context);
  20247. if( iT<=0 ) return;
  20248. t = iT/1000 - 10000*(sqlite3_int64)21086676;
  20249. #if HAVE_GMTIME_R
  20250. pTm = gmtime_r(&t, &sNow);
  20251. #else
  20252. sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  20253. pTm = gmtime(&t);
  20254. if( pTm ) memcpy(&sNow, pTm, sizeof(sNow));
  20255. sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  20256. #endif
  20257. if( pTm ){
  20258. strftime(zBuf, 20, zFormat, &sNow);
  20259. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  20260. }
  20261. }
  20262. #endif
  20263. /*
  20264. ** This function registered all of the above C functions as SQL
  20265. ** functions. This should be the only routine in this file with
  20266. ** external linkage.
  20267. */
  20268. SQLITE_PRIVATE void sqlite3RegisterDateTimeFunctions(void){
  20269. static FuncDef aDateTimeFuncs[] = {
  20270. #ifndef SQLITE_OMIT_DATETIME_FUNCS
  20271. PURE_DATE(julianday, -1, 0, 0, juliandayFunc ),
  20272. PURE_DATE(date, -1, 0, 0, dateFunc ),
  20273. PURE_DATE(time, -1, 0, 0, timeFunc ),
  20274. PURE_DATE(datetime, -1, 0, 0, datetimeFunc ),
  20275. PURE_DATE(strftime, -1, 0, 0, strftimeFunc ),
  20276. DFUNCTION(current_time, 0, 0, 0, ctimeFunc ),
  20277. DFUNCTION(current_timestamp, 0, 0, 0, ctimestampFunc),
  20278. DFUNCTION(current_date, 0, 0, 0, cdateFunc ),
  20279. #else
  20280. STR_FUNCTION(current_time, 0, "%H:%M:%S", 0, currentTimeFunc),
  20281. STR_FUNCTION(current_date, 0, "%Y-%m-%d", 0, currentTimeFunc),
  20282. STR_FUNCTION(current_timestamp, 0, "%Y-%m-%d %H:%M:%S", 0, currentTimeFunc),
  20283. #endif
  20284. };
  20285. sqlite3InsertBuiltinFuncs(aDateTimeFuncs, ArraySize(aDateTimeFuncs));
  20286. }
  20287. /************** End of date.c ************************************************/
  20288. /************** Begin file os.c **********************************************/
  20289. /*
  20290. ** 2005 November 29
  20291. **
  20292. ** The author disclaims copyright to this source code. In place of
  20293. ** a legal notice, here is a blessing:
  20294. **
  20295. ** May you do good and not evil.
  20296. ** May you find forgiveness for yourself and forgive others.
  20297. ** May you share freely, never taking more than you give.
  20298. **
  20299. ******************************************************************************
  20300. **
  20301. ** This file contains OS interface code that is common to all
  20302. ** architectures.
  20303. */
  20304. /* #include "sqliteInt.h" */
  20305. /*
  20306. ** If we compile with the SQLITE_TEST macro set, then the following block
  20307. ** of code will give us the ability to simulate a disk I/O error. This
  20308. ** is used for testing the I/O recovery logic.
  20309. */
  20310. #if defined(SQLITE_TEST)
  20311. SQLITE_API int sqlite3_io_error_hit = 0; /* Total number of I/O Errors */
  20312. SQLITE_API int sqlite3_io_error_hardhit = 0; /* Number of non-benign errors */
  20313. SQLITE_API int sqlite3_io_error_pending = 0; /* Count down to first I/O error */
  20314. SQLITE_API int sqlite3_io_error_persist = 0; /* True if I/O errors persist */
  20315. SQLITE_API int sqlite3_io_error_benign = 0; /* True if errors are benign */
  20316. SQLITE_API int sqlite3_diskfull_pending = 0;
  20317. SQLITE_API int sqlite3_diskfull = 0;
  20318. #endif /* defined(SQLITE_TEST) */
  20319. /*
  20320. ** When testing, also keep a count of the number of open files.
  20321. */
  20322. #if defined(SQLITE_TEST)
  20323. SQLITE_API int sqlite3_open_file_count = 0;
  20324. #endif /* defined(SQLITE_TEST) */
  20325. /*
  20326. ** The default SQLite sqlite3_vfs implementations do not allocate
  20327. ** memory (actually, os_unix.c allocates a small amount of memory
  20328. ** from within OsOpen()), but some third-party implementations may.
  20329. ** So we test the effects of a malloc() failing and the sqlite3OsXXX()
  20330. ** function returning SQLITE_IOERR_NOMEM using the DO_OS_MALLOC_TEST macro.
  20331. **
  20332. ** The following functions are instrumented for malloc() failure
  20333. ** testing:
  20334. **
  20335. ** sqlite3OsRead()
  20336. ** sqlite3OsWrite()
  20337. ** sqlite3OsSync()
  20338. ** sqlite3OsFileSize()
  20339. ** sqlite3OsLock()
  20340. ** sqlite3OsCheckReservedLock()
  20341. ** sqlite3OsFileControl()
  20342. ** sqlite3OsShmMap()
  20343. ** sqlite3OsOpen()
  20344. ** sqlite3OsDelete()
  20345. ** sqlite3OsAccess()
  20346. ** sqlite3OsFullPathname()
  20347. **
  20348. */
  20349. #if defined(SQLITE_TEST)
  20350. SQLITE_API int sqlite3_memdebug_vfs_oom_test = 1;
  20351. #define DO_OS_MALLOC_TEST(x) \
  20352. if (sqlite3_memdebug_vfs_oom_test && (!x || !sqlite3JournalIsInMemory(x))) { \
  20353. void *pTstAlloc = sqlite3Malloc(10); \
  20354. if (!pTstAlloc) return SQLITE_IOERR_NOMEM_BKPT; \
  20355. sqlite3_free(pTstAlloc); \
  20356. }
  20357. #else
  20358. #define DO_OS_MALLOC_TEST(x)
  20359. #endif
  20360. /*
  20361. ** The following routines are convenience wrappers around methods
  20362. ** of the sqlite3_file object. This is mostly just syntactic sugar. All
  20363. ** of this would be completely automatic if SQLite were coded using
  20364. ** C++ instead of plain old C.
  20365. */
  20366. SQLITE_PRIVATE void sqlite3OsClose(sqlite3_file *pId){
  20367. if( pId->pMethods ){
  20368. pId->pMethods->xClose(pId);
  20369. pId->pMethods = 0;
  20370. }
  20371. }
  20372. SQLITE_PRIVATE int sqlite3OsRead(sqlite3_file *id, void *pBuf, int amt, i64 offset){
  20373. DO_OS_MALLOC_TEST(id);
  20374. return id->pMethods->xRead(id, pBuf, amt, offset);
  20375. }
  20376. SQLITE_PRIVATE int sqlite3OsWrite(sqlite3_file *id, const void *pBuf, int amt, i64 offset){
  20377. DO_OS_MALLOC_TEST(id);
  20378. return id->pMethods->xWrite(id, pBuf, amt, offset);
  20379. }
  20380. SQLITE_PRIVATE int sqlite3OsTruncate(sqlite3_file *id, i64 size){
  20381. return id->pMethods->xTruncate(id, size);
  20382. }
  20383. SQLITE_PRIVATE int sqlite3OsSync(sqlite3_file *id, int flags){
  20384. DO_OS_MALLOC_TEST(id);
  20385. return flags ? id->pMethods->xSync(id, flags) : SQLITE_OK;
  20386. }
  20387. SQLITE_PRIVATE int sqlite3OsFileSize(sqlite3_file *id, i64 *pSize){
  20388. DO_OS_MALLOC_TEST(id);
  20389. return id->pMethods->xFileSize(id, pSize);
  20390. }
  20391. SQLITE_PRIVATE int sqlite3OsLock(sqlite3_file *id, int lockType){
  20392. DO_OS_MALLOC_TEST(id);
  20393. return id->pMethods->xLock(id, lockType);
  20394. }
  20395. SQLITE_PRIVATE int sqlite3OsUnlock(sqlite3_file *id, int lockType){
  20396. return id->pMethods->xUnlock(id, lockType);
  20397. }
  20398. SQLITE_PRIVATE int sqlite3OsCheckReservedLock(sqlite3_file *id, int *pResOut){
  20399. DO_OS_MALLOC_TEST(id);
  20400. return id->pMethods->xCheckReservedLock(id, pResOut);
  20401. }
  20402. /*
  20403. ** Use sqlite3OsFileControl() when we are doing something that might fail
  20404. ** and we need to know about the failures. Use sqlite3OsFileControlHint()
  20405. ** when simply tossing information over the wall to the VFS and we do not
  20406. ** really care if the VFS receives and understands the information since it
  20407. ** is only a hint and can be safely ignored. The sqlite3OsFileControlHint()
  20408. ** routine has no return value since the return value would be meaningless.
  20409. */
  20410. SQLITE_PRIVATE int sqlite3OsFileControl(sqlite3_file *id, int op, void *pArg){
  20411. if( id->pMethods==0 ) return SQLITE_NOTFOUND;
  20412. #ifdef SQLITE_TEST
  20413. if( op!=SQLITE_FCNTL_COMMIT_PHASETWO
  20414. && op!=SQLITE_FCNTL_LOCK_TIMEOUT
  20415. ){
  20416. /* Faults are not injected into COMMIT_PHASETWO because, assuming SQLite
  20417. ** is using a regular VFS, it is called after the corresponding
  20418. ** transaction has been committed. Injecting a fault at this point
  20419. ** confuses the test scripts - the COMMIT comand returns SQLITE_NOMEM
  20420. ** but the transaction is committed anyway.
  20421. **
  20422. ** The core must call OsFileControl() though, not OsFileControlHint(),
  20423. ** as if a custom VFS (e.g. zipvfs) returns an error here, it probably
  20424. ** means the commit really has failed and an error should be returned
  20425. ** to the user. */
  20426. DO_OS_MALLOC_TEST(id);
  20427. }
  20428. #endif
  20429. return id->pMethods->xFileControl(id, op, pArg);
  20430. }
  20431. SQLITE_PRIVATE void sqlite3OsFileControlHint(sqlite3_file *id, int op, void *pArg){
  20432. if( id->pMethods ) (void)id->pMethods->xFileControl(id, op, pArg);
  20433. }
  20434. SQLITE_PRIVATE int sqlite3OsSectorSize(sqlite3_file *id){
  20435. int (*xSectorSize)(sqlite3_file*) = id->pMethods->xSectorSize;
  20436. return (xSectorSize ? xSectorSize(id) : SQLITE_DEFAULT_SECTOR_SIZE);
  20437. }
  20438. SQLITE_PRIVATE int sqlite3OsDeviceCharacteristics(sqlite3_file *id){
  20439. return id->pMethods->xDeviceCharacteristics(id);
  20440. }
  20441. #ifndef SQLITE_OMIT_WAL
  20442. SQLITE_PRIVATE int sqlite3OsShmLock(sqlite3_file *id, int offset, int n, int flags){
  20443. return id->pMethods->xShmLock(id, offset, n, flags);
  20444. }
  20445. SQLITE_PRIVATE void sqlite3OsShmBarrier(sqlite3_file *id){
  20446. id->pMethods->xShmBarrier(id);
  20447. }
  20448. SQLITE_PRIVATE int sqlite3OsShmUnmap(sqlite3_file *id, int deleteFlag){
  20449. return id->pMethods->xShmUnmap(id, deleteFlag);
  20450. }
  20451. SQLITE_PRIVATE int sqlite3OsShmMap(
  20452. sqlite3_file *id, /* Database file handle */
  20453. int iPage,
  20454. int pgsz,
  20455. int bExtend, /* True to extend file if necessary */
  20456. void volatile **pp /* OUT: Pointer to mapping */
  20457. ){
  20458. DO_OS_MALLOC_TEST(id);
  20459. return id->pMethods->xShmMap(id, iPage, pgsz, bExtend, pp);
  20460. }
  20461. #endif /* SQLITE_OMIT_WAL */
  20462. #if SQLITE_MAX_MMAP_SIZE>0
  20463. /* The real implementation of xFetch and xUnfetch */
  20464. SQLITE_PRIVATE int sqlite3OsFetch(sqlite3_file *id, i64 iOff, int iAmt, void **pp){
  20465. DO_OS_MALLOC_TEST(id);
  20466. return id->pMethods->xFetch(id, iOff, iAmt, pp);
  20467. }
  20468. SQLITE_PRIVATE int sqlite3OsUnfetch(sqlite3_file *id, i64 iOff, void *p){
  20469. return id->pMethods->xUnfetch(id, iOff, p);
  20470. }
  20471. #else
  20472. /* No-op stubs to use when memory-mapped I/O is disabled */
  20473. SQLITE_PRIVATE int sqlite3OsFetch(sqlite3_file *id, i64 iOff, int iAmt, void **pp){
  20474. *pp = 0;
  20475. return SQLITE_OK;
  20476. }
  20477. SQLITE_PRIVATE int sqlite3OsUnfetch(sqlite3_file *id, i64 iOff, void *p){
  20478. return SQLITE_OK;
  20479. }
  20480. #endif
  20481. /*
  20482. ** The next group of routines are convenience wrappers around the
  20483. ** VFS methods.
  20484. */
  20485. SQLITE_PRIVATE int sqlite3OsOpen(
  20486. sqlite3_vfs *pVfs,
  20487. const char *zPath,
  20488. sqlite3_file *pFile,
  20489. int flags,
  20490. int *pFlagsOut
  20491. ){
  20492. int rc;
  20493. DO_OS_MALLOC_TEST(0);
  20494. /* 0x87f7f is a mask of SQLITE_OPEN_ flags that are valid to be passed
  20495. ** down into the VFS layer. Some SQLITE_OPEN_ flags (for example,
  20496. ** SQLITE_OPEN_FULLMUTEX or SQLITE_OPEN_SHAREDCACHE) are blocked before
  20497. ** reaching the VFS. */
  20498. rc = pVfs->xOpen(pVfs, zPath, pFile, flags & 0x87f7f, pFlagsOut);
  20499. assert( rc==SQLITE_OK || pFile->pMethods==0 );
  20500. return rc;
  20501. }
  20502. SQLITE_PRIVATE int sqlite3OsDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
  20503. DO_OS_MALLOC_TEST(0);
  20504. assert( dirSync==0 || dirSync==1 );
  20505. return pVfs->xDelete(pVfs, zPath, dirSync);
  20506. }
  20507. SQLITE_PRIVATE int sqlite3OsAccess(
  20508. sqlite3_vfs *pVfs,
  20509. const char *zPath,
  20510. int flags,
  20511. int *pResOut
  20512. ){
  20513. DO_OS_MALLOC_TEST(0);
  20514. return pVfs->xAccess(pVfs, zPath, flags, pResOut);
  20515. }
  20516. SQLITE_PRIVATE int sqlite3OsFullPathname(
  20517. sqlite3_vfs *pVfs,
  20518. const char *zPath,
  20519. int nPathOut,
  20520. char *zPathOut
  20521. ){
  20522. DO_OS_MALLOC_TEST(0);
  20523. zPathOut[0] = 0;
  20524. return pVfs->xFullPathname(pVfs, zPath, nPathOut, zPathOut);
  20525. }
  20526. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  20527. SQLITE_PRIVATE void *sqlite3OsDlOpen(sqlite3_vfs *pVfs, const char *zPath){
  20528. return pVfs->xDlOpen(pVfs, zPath);
  20529. }
  20530. SQLITE_PRIVATE void sqlite3OsDlError(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  20531. pVfs->xDlError(pVfs, nByte, zBufOut);
  20532. }
  20533. SQLITE_PRIVATE void (*sqlite3OsDlSym(sqlite3_vfs *pVfs, void *pHdle, const char *zSym))(void){
  20534. return pVfs->xDlSym(pVfs, pHdle, zSym);
  20535. }
  20536. SQLITE_PRIVATE void sqlite3OsDlClose(sqlite3_vfs *pVfs, void *pHandle){
  20537. pVfs->xDlClose(pVfs, pHandle);
  20538. }
  20539. #endif /* SQLITE_OMIT_LOAD_EXTENSION */
  20540. SQLITE_PRIVATE int sqlite3OsRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  20541. return pVfs->xRandomness(pVfs, nByte, zBufOut);
  20542. }
  20543. SQLITE_PRIVATE int sqlite3OsSleep(sqlite3_vfs *pVfs, int nMicro){
  20544. return pVfs->xSleep(pVfs, nMicro);
  20545. }
  20546. SQLITE_PRIVATE int sqlite3OsGetLastError(sqlite3_vfs *pVfs){
  20547. return pVfs->xGetLastError ? pVfs->xGetLastError(pVfs, 0, 0) : 0;
  20548. }
  20549. SQLITE_PRIVATE int sqlite3OsCurrentTimeInt64(sqlite3_vfs *pVfs, sqlite3_int64 *pTimeOut){
  20550. int rc;
  20551. /* IMPLEMENTATION-OF: R-49045-42493 SQLite will use the xCurrentTimeInt64()
  20552. ** method to get the current date and time if that method is available
  20553. ** (if iVersion is 2 or greater and the function pointer is not NULL) and
  20554. ** will fall back to xCurrentTime() if xCurrentTimeInt64() is
  20555. ** unavailable.
  20556. */
  20557. if( pVfs->iVersion>=2 && pVfs->xCurrentTimeInt64 ){
  20558. rc = pVfs->xCurrentTimeInt64(pVfs, pTimeOut);
  20559. }else{
  20560. double r;
  20561. rc = pVfs->xCurrentTime(pVfs, &r);
  20562. *pTimeOut = (sqlite3_int64)(r*86400000.0);
  20563. }
  20564. return rc;
  20565. }
  20566. SQLITE_PRIVATE int sqlite3OsOpenMalloc(
  20567. sqlite3_vfs *pVfs,
  20568. const char *zFile,
  20569. sqlite3_file **ppFile,
  20570. int flags,
  20571. int *pOutFlags
  20572. ){
  20573. int rc;
  20574. sqlite3_file *pFile;
  20575. pFile = (sqlite3_file *)sqlite3MallocZero(pVfs->szOsFile);
  20576. if( pFile ){
  20577. rc = sqlite3OsOpen(pVfs, zFile, pFile, flags, pOutFlags);
  20578. if( rc!=SQLITE_OK ){
  20579. sqlite3_free(pFile);
  20580. }else{
  20581. *ppFile = pFile;
  20582. }
  20583. }else{
  20584. rc = SQLITE_NOMEM_BKPT;
  20585. }
  20586. return rc;
  20587. }
  20588. SQLITE_PRIVATE void sqlite3OsCloseFree(sqlite3_file *pFile){
  20589. assert( pFile );
  20590. sqlite3OsClose(pFile);
  20591. sqlite3_free(pFile);
  20592. }
  20593. /*
  20594. ** This function is a wrapper around the OS specific implementation of
  20595. ** sqlite3_os_init(). The purpose of the wrapper is to provide the
  20596. ** ability to simulate a malloc failure, so that the handling of an
  20597. ** error in sqlite3_os_init() by the upper layers can be tested.
  20598. */
  20599. SQLITE_PRIVATE int sqlite3OsInit(void){
  20600. void *p = sqlite3_malloc(10);
  20601. if( p==0 ) return SQLITE_NOMEM_BKPT;
  20602. sqlite3_free(p);
  20603. return sqlite3_os_init();
  20604. }
  20605. /*
  20606. ** The list of all registered VFS implementations.
  20607. */
  20608. static sqlite3_vfs * SQLITE_WSD vfsList = 0;
  20609. #define vfsList GLOBAL(sqlite3_vfs *, vfsList)
  20610. /*
  20611. ** Locate a VFS by name. If no name is given, simply return the
  20612. ** first VFS on the list.
  20613. */
  20614. SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfs){
  20615. sqlite3_vfs *pVfs = 0;
  20616. #if SQLITE_THREADSAFE
  20617. sqlite3_mutex *mutex;
  20618. #endif
  20619. #ifndef SQLITE_OMIT_AUTOINIT
  20620. int rc = sqlite3_initialize();
  20621. if( rc ) return 0;
  20622. #endif
  20623. #if SQLITE_THREADSAFE
  20624. mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  20625. #endif
  20626. sqlite3_mutex_enter(mutex);
  20627. for(pVfs = vfsList; pVfs; pVfs=pVfs->pNext){
  20628. if( zVfs==0 ) break;
  20629. if( strcmp(zVfs, pVfs->zName)==0 ) break;
  20630. }
  20631. sqlite3_mutex_leave(mutex);
  20632. return pVfs;
  20633. }
  20634. /*
  20635. ** Unlink a VFS from the linked list
  20636. */
  20637. static void vfsUnlink(sqlite3_vfs *pVfs){
  20638. assert( sqlite3_mutex_held(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER)) );
  20639. if( pVfs==0 ){
  20640. /* No-op */
  20641. }else if( vfsList==pVfs ){
  20642. vfsList = pVfs->pNext;
  20643. }else if( vfsList ){
  20644. sqlite3_vfs *p = vfsList;
  20645. while( p->pNext && p->pNext!=pVfs ){
  20646. p = p->pNext;
  20647. }
  20648. if( p->pNext==pVfs ){
  20649. p->pNext = pVfs->pNext;
  20650. }
  20651. }
  20652. }
  20653. /*
  20654. ** Register a VFS with the system. It is harmless to register the same
  20655. ** VFS multiple times. The new VFS becomes the default if makeDflt is
  20656. ** true.
  20657. */
  20658. SQLITE_API int sqlite3_vfs_register(sqlite3_vfs *pVfs, int makeDflt){
  20659. MUTEX_LOGIC(sqlite3_mutex *mutex;)
  20660. #ifndef SQLITE_OMIT_AUTOINIT
  20661. int rc = sqlite3_initialize();
  20662. if( rc ) return rc;
  20663. #endif
  20664. #ifdef SQLITE_ENABLE_API_ARMOR
  20665. if( pVfs==0 ) return SQLITE_MISUSE_BKPT;
  20666. #endif
  20667. MUTEX_LOGIC( mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  20668. sqlite3_mutex_enter(mutex);
  20669. vfsUnlink(pVfs);
  20670. if( makeDflt || vfsList==0 ){
  20671. pVfs->pNext = vfsList;
  20672. vfsList = pVfs;
  20673. }else{
  20674. pVfs->pNext = vfsList->pNext;
  20675. vfsList->pNext = pVfs;
  20676. }
  20677. assert(vfsList);
  20678. sqlite3_mutex_leave(mutex);
  20679. return SQLITE_OK;
  20680. }
  20681. /*
  20682. ** Unregister a VFS so that it is no longer accessible.
  20683. */
  20684. SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs *pVfs){
  20685. #if SQLITE_THREADSAFE
  20686. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  20687. #endif
  20688. sqlite3_mutex_enter(mutex);
  20689. vfsUnlink(pVfs);
  20690. sqlite3_mutex_leave(mutex);
  20691. return SQLITE_OK;
  20692. }
  20693. /************** End of os.c **************************************************/
  20694. /************** Begin file fault.c *******************************************/
  20695. /*
  20696. ** 2008 Jan 22
  20697. **
  20698. ** The author disclaims copyright to this source code. In place of
  20699. ** a legal notice, here is a blessing:
  20700. **
  20701. ** May you do good and not evil.
  20702. ** May you find forgiveness for yourself and forgive others.
  20703. ** May you share freely, never taking more than you give.
  20704. **
  20705. *************************************************************************
  20706. **
  20707. ** This file contains code to support the concept of "benign"
  20708. ** malloc failures (when the xMalloc() or xRealloc() method of the
  20709. ** sqlite3_mem_methods structure fails to allocate a block of memory
  20710. ** and returns 0).
  20711. **
  20712. ** Most malloc failures are non-benign. After they occur, SQLite
  20713. ** abandons the current operation and returns an error code (usually
  20714. ** SQLITE_NOMEM) to the user. However, sometimes a fault is not necessarily
  20715. ** fatal. For example, if a malloc fails while resizing a hash table, this
  20716. ** is completely recoverable simply by not carrying out the resize. The
  20717. ** hash table will continue to function normally. So a malloc failure
  20718. ** during a hash table resize is a benign fault.
  20719. */
  20720. /* #include "sqliteInt.h" */
  20721. #ifndef SQLITE_UNTESTABLE
  20722. /*
  20723. ** Global variables.
  20724. */
  20725. typedef struct BenignMallocHooks BenignMallocHooks;
  20726. static SQLITE_WSD struct BenignMallocHooks {
  20727. void (*xBenignBegin)(void);
  20728. void (*xBenignEnd)(void);
  20729. } sqlite3Hooks = { 0, 0 };
  20730. /* The "wsdHooks" macro will resolve to the appropriate BenignMallocHooks
  20731. ** structure. If writable static data is unsupported on the target,
  20732. ** we have to locate the state vector at run-time. In the more common
  20733. ** case where writable static data is supported, wsdHooks can refer directly
  20734. ** to the "sqlite3Hooks" state vector declared above.
  20735. */
  20736. #ifdef SQLITE_OMIT_WSD
  20737. # define wsdHooksInit \
  20738. BenignMallocHooks *x = &GLOBAL(BenignMallocHooks,sqlite3Hooks)
  20739. # define wsdHooks x[0]
  20740. #else
  20741. # define wsdHooksInit
  20742. # define wsdHooks sqlite3Hooks
  20743. #endif
  20744. /*
  20745. ** Register hooks to call when sqlite3BeginBenignMalloc() and
  20746. ** sqlite3EndBenignMalloc() are called, respectively.
  20747. */
  20748. SQLITE_PRIVATE void sqlite3BenignMallocHooks(
  20749. void (*xBenignBegin)(void),
  20750. void (*xBenignEnd)(void)
  20751. ){
  20752. wsdHooksInit;
  20753. wsdHooks.xBenignBegin = xBenignBegin;
  20754. wsdHooks.xBenignEnd = xBenignEnd;
  20755. }
  20756. /*
  20757. ** This (sqlite3EndBenignMalloc()) is called by SQLite code to indicate that
  20758. ** subsequent malloc failures are benign. A call to sqlite3EndBenignMalloc()
  20759. ** indicates that subsequent malloc failures are non-benign.
  20760. */
  20761. SQLITE_PRIVATE void sqlite3BeginBenignMalloc(void){
  20762. wsdHooksInit;
  20763. if( wsdHooks.xBenignBegin ){
  20764. wsdHooks.xBenignBegin();
  20765. }
  20766. }
  20767. SQLITE_PRIVATE void sqlite3EndBenignMalloc(void){
  20768. wsdHooksInit;
  20769. if( wsdHooks.xBenignEnd ){
  20770. wsdHooks.xBenignEnd();
  20771. }
  20772. }
  20773. #endif /* #ifndef SQLITE_UNTESTABLE */
  20774. /************** End of fault.c ***********************************************/
  20775. /************** Begin file mem0.c ********************************************/
  20776. /*
  20777. ** 2008 October 28
  20778. **
  20779. ** The author disclaims copyright to this source code. In place of
  20780. ** a legal notice, here is a blessing:
  20781. **
  20782. ** May you do good and not evil.
  20783. ** May you find forgiveness for yourself and forgive others.
  20784. ** May you share freely, never taking more than you give.
  20785. **
  20786. *************************************************************************
  20787. **
  20788. ** This file contains a no-op memory allocation drivers for use when
  20789. ** SQLITE_ZERO_MALLOC is defined. The allocation drivers implemented
  20790. ** here always fail. SQLite will not operate with these drivers. These
  20791. ** are merely placeholders. Real drivers must be substituted using
  20792. ** sqlite3_config() before SQLite will operate.
  20793. */
  20794. /* #include "sqliteInt.h" */
  20795. /*
  20796. ** This version of the memory allocator is the default. It is
  20797. ** used when no other memory allocator is specified using compile-time
  20798. ** macros.
  20799. */
  20800. #ifdef SQLITE_ZERO_MALLOC
  20801. /*
  20802. ** No-op versions of all memory allocation routines
  20803. */
  20804. static void *sqlite3MemMalloc(int nByte){ return 0; }
  20805. static void sqlite3MemFree(void *pPrior){ return; }
  20806. static void *sqlite3MemRealloc(void *pPrior, int nByte){ return 0; }
  20807. static int sqlite3MemSize(void *pPrior){ return 0; }
  20808. static int sqlite3MemRoundup(int n){ return n; }
  20809. static int sqlite3MemInit(void *NotUsed){ return SQLITE_OK; }
  20810. static void sqlite3MemShutdown(void *NotUsed){ return; }
  20811. /*
  20812. ** This routine is the only routine in this file with external linkage.
  20813. **
  20814. ** Populate the low-level memory allocation function pointers in
  20815. ** sqlite3GlobalConfig.m with pointers to the routines in this file.
  20816. */
  20817. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  20818. static const sqlite3_mem_methods defaultMethods = {
  20819. sqlite3MemMalloc,
  20820. sqlite3MemFree,
  20821. sqlite3MemRealloc,
  20822. sqlite3MemSize,
  20823. sqlite3MemRoundup,
  20824. sqlite3MemInit,
  20825. sqlite3MemShutdown,
  20826. 0
  20827. };
  20828. sqlite3_config(SQLITE_CONFIG_MALLOC, &defaultMethods);
  20829. }
  20830. #endif /* SQLITE_ZERO_MALLOC */
  20831. /************** End of mem0.c ************************************************/
  20832. /************** Begin file mem1.c ********************************************/
  20833. /*
  20834. ** 2007 August 14
  20835. **
  20836. ** The author disclaims copyright to this source code. In place of
  20837. ** a legal notice, here is a blessing:
  20838. **
  20839. ** May you do good and not evil.
  20840. ** May you find forgiveness for yourself and forgive others.
  20841. ** May you share freely, never taking more than you give.
  20842. **
  20843. *************************************************************************
  20844. **
  20845. ** This file contains low-level memory allocation drivers for when
  20846. ** SQLite will use the standard C-library malloc/realloc/free interface
  20847. ** to obtain the memory it needs.
  20848. **
  20849. ** This file contains implementations of the low-level memory allocation
  20850. ** routines specified in the sqlite3_mem_methods object. The content of
  20851. ** this file is only used if SQLITE_SYSTEM_MALLOC is defined. The
  20852. ** SQLITE_SYSTEM_MALLOC macro is defined automatically if neither the
  20853. ** SQLITE_MEMDEBUG nor the SQLITE_WIN32_MALLOC macros are defined. The
  20854. ** default configuration is to use memory allocation routines in this
  20855. ** file.
  20856. **
  20857. ** C-preprocessor macro summary:
  20858. **
  20859. ** HAVE_MALLOC_USABLE_SIZE The configure script sets this symbol if
  20860. ** the malloc_usable_size() interface exists
  20861. ** on the target platform. Or, this symbol
  20862. ** can be set manually, if desired.
  20863. ** If an equivalent interface exists by
  20864. ** a different name, using a separate -D
  20865. ** option to rename it.
  20866. **
  20867. ** SQLITE_WITHOUT_ZONEMALLOC Some older macs lack support for the zone
  20868. ** memory allocator. Set this symbol to enable
  20869. ** building on older macs.
  20870. **
  20871. ** SQLITE_WITHOUT_MSIZE Set this symbol to disable the use of
  20872. ** _msize() on windows systems. This might
  20873. ** be necessary when compiling for Delphi,
  20874. ** for example.
  20875. */
  20876. /* #include "sqliteInt.h" */
  20877. /*
  20878. ** This version of the memory allocator is the default. It is
  20879. ** used when no other memory allocator is specified using compile-time
  20880. ** macros.
  20881. */
  20882. #ifdef SQLITE_SYSTEM_MALLOC
  20883. #if defined(__APPLE__) && !defined(SQLITE_WITHOUT_ZONEMALLOC)
  20884. /*
  20885. ** Use the zone allocator available on apple products unless the
  20886. ** SQLITE_WITHOUT_ZONEMALLOC symbol is defined.
  20887. */
  20888. #include <sys/sysctl.h>
  20889. #include <malloc/malloc.h>
  20890. #ifdef SQLITE_MIGHT_BE_SINGLE_CORE
  20891. #include <libkern/OSAtomic.h>
  20892. #endif /* SQLITE_MIGHT_BE_SINGLE_CORE */
  20893. static malloc_zone_t* _sqliteZone_;
  20894. #define SQLITE_MALLOC(x) malloc_zone_malloc(_sqliteZone_, (x))
  20895. #define SQLITE_FREE(x) malloc_zone_free(_sqliteZone_, (x));
  20896. #define SQLITE_REALLOC(x,y) malloc_zone_realloc(_sqliteZone_, (x), (y))
  20897. #define SQLITE_MALLOCSIZE(x) \
  20898. (_sqliteZone_ ? _sqliteZone_->size(_sqliteZone_,x) : malloc_size(x))
  20899. #else /* if not __APPLE__ */
  20900. /*
  20901. ** Use standard C library malloc and free on non-Apple systems.
  20902. ** Also used by Apple systems if SQLITE_WITHOUT_ZONEMALLOC is defined.
  20903. */
  20904. #define SQLITE_MALLOC(x) malloc(x)
  20905. #define SQLITE_FREE(x) free(x)
  20906. #define SQLITE_REALLOC(x,y) realloc((x),(y))
  20907. /*
  20908. ** The malloc.h header file is needed for malloc_usable_size() function
  20909. ** on some systems (e.g. Linux).
  20910. */
  20911. #if HAVE_MALLOC_H && HAVE_MALLOC_USABLE_SIZE
  20912. # define SQLITE_USE_MALLOC_H 1
  20913. # define SQLITE_USE_MALLOC_USABLE_SIZE 1
  20914. /*
  20915. ** The MSVCRT has malloc_usable_size(), but it is called _msize(). The
  20916. ** use of _msize() is automatic, but can be disabled by compiling with
  20917. ** -DSQLITE_WITHOUT_MSIZE. Using the _msize() function also requires
  20918. ** the malloc.h header file.
  20919. */
  20920. #elif defined(_MSC_VER) && !defined(SQLITE_WITHOUT_MSIZE)
  20921. # define SQLITE_USE_MALLOC_H
  20922. # define SQLITE_USE_MSIZE
  20923. #endif
  20924. /*
  20925. ** Include the malloc.h header file, if necessary. Also set define macro
  20926. ** SQLITE_MALLOCSIZE to the appropriate function name, which is _msize()
  20927. ** for MSVC and malloc_usable_size() for most other systems (e.g. Linux).
  20928. ** The memory size function can always be overridden manually by defining
  20929. ** the macro SQLITE_MALLOCSIZE to the desired function name.
  20930. */
  20931. #if defined(SQLITE_USE_MALLOC_H)
  20932. # include <malloc.h>
  20933. # if defined(SQLITE_USE_MALLOC_USABLE_SIZE)
  20934. # if !defined(SQLITE_MALLOCSIZE)
  20935. # define SQLITE_MALLOCSIZE(x) malloc_usable_size(x)
  20936. # endif
  20937. # elif defined(SQLITE_USE_MSIZE)
  20938. # if !defined(SQLITE_MALLOCSIZE)
  20939. # define SQLITE_MALLOCSIZE _msize
  20940. # endif
  20941. # endif
  20942. #endif /* defined(SQLITE_USE_MALLOC_H) */
  20943. #endif /* __APPLE__ or not __APPLE__ */
  20944. /*
  20945. ** Like malloc(), but remember the size of the allocation
  20946. ** so that we can find it later using sqlite3MemSize().
  20947. **
  20948. ** For this low-level routine, we are guaranteed that nByte>0 because
  20949. ** cases of nByte<=0 will be intercepted and dealt with by higher level
  20950. ** routines.
  20951. */
  20952. static void *sqlite3MemMalloc(int nByte){
  20953. #ifdef SQLITE_MALLOCSIZE
  20954. void *p;
  20955. testcase( ROUND8(nByte)==nByte );
  20956. p = SQLITE_MALLOC( nByte );
  20957. if( p==0 ){
  20958. testcase( sqlite3GlobalConfig.xLog!=0 );
  20959. sqlite3_log(SQLITE_NOMEM, "failed to allocate %u bytes of memory", nByte);
  20960. }
  20961. return p;
  20962. #else
  20963. sqlite3_int64 *p;
  20964. assert( nByte>0 );
  20965. testcase( ROUND8(nByte)!=nByte );
  20966. p = SQLITE_MALLOC( nByte+8 );
  20967. if( p ){
  20968. p[0] = nByte;
  20969. p++;
  20970. }else{
  20971. testcase( sqlite3GlobalConfig.xLog!=0 );
  20972. sqlite3_log(SQLITE_NOMEM, "failed to allocate %u bytes of memory", nByte);
  20973. }
  20974. return (void *)p;
  20975. #endif
  20976. }
  20977. /*
  20978. ** Like free() but works for allocations obtained from sqlite3MemMalloc()
  20979. ** or sqlite3MemRealloc().
  20980. **
  20981. ** For this low-level routine, we already know that pPrior!=0 since
  20982. ** cases where pPrior==0 will have been intecepted and dealt with
  20983. ** by higher-level routines.
  20984. */
  20985. static void sqlite3MemFree(void *pPrior){
  20986. #ifdef SQLITE_MALLOCSIZE
  20987. SQLITE_FREE(pPrior);
  20988. #else
  20989. sqlite3_int64 *p = (sqlite3_int64*)pPrior;
  20990. assert( pPrior!=0 );
  20991. p--;
  20992. SQLITE_FREE(p);
  20993. #endif
  20994. }
  20995. /*
  20996. ** Report the allocated size of a prior return from xMalloc()
  20997. ** or xRealloc().
  20998. */
  20999. static int sqlite3MemSize(void *pPrior){
  21000. #ifdef SQLITE_MALLOCSIZE
  21001. assert( pPrior!=0 );
  21002. return (int)SQLITE_MALLOCSIZE(pPrior);
  21003. #else
  21004. sqlite3_int64 *p;
  21005. assert( pPrior!=0 );
  21006. p = (sqlite3_int64*)pPrior;
  21007. p--;
  21008. return (int)p[0];
  21009. #endif
  21010. }
  21011. /*
  21012. ** Like realloc(). Resize an allocation previously obtained from
  21013. ** sqlite3MemMalloc().
  21014. **
  21015. ** For this low-level interface, we know that pPrior!=0. Cases where
  21016. ** pPrior==0 while have been intercepted by higher-level routine and
  21017. ** redirected to xMalloc. Similarly, we know that nByte>0 because
  21018. ** cases where nByte<=0 will have been intercepted by higher-level
  21019. ** routines and redirected to xFree.
  21020. */
  21021. static void *sqlite3MemRealloc(void *pPrior, int nByte){
  21022. #ifdef SQLITE_MALLOCSIZE
  21023. void *p = SQLITE_REALLOC(pPrior, nByte);
  21024. if( p==0 ){
  21025. testcase( sqlite3GlobalConfig.xLog!=0 );
  21026. sqlite3_log(SQLITE_NOMEM,
  21027. "failed memory resize %u to %u bytes",
  21028. SQLITE_MALLOCSIZE(pPrior), nByte);
  21029. }
  21030. return p;
  21031. #else
  21032. sqlite3_int64 *p = (sqlite3_int64*)pPrior;
  21033. assert( pPrior!=0 && nByte>0 );
  21034. assert( nByte==ROUND8(nByte) ); /* EV: R-46199-30249 */
  21035. p--;
  21036. p = SQLITE_REALLOC(p, nByte+8 );
  21037. if( p ){
  21038. p[0] = nByte;
  21039. p++;
  21040. }else{
  21041. testcase( sqlite3GlobalConfig.xLog!=0 );
  21042. sqlite3_log(SQLITE_NOMEM,
  21043. "failed memory resize %u to %u bytes",
  21044. sqlite3MemSize(pPrior), nByte);
  21045. }
  21046. return (void*)p;
  21047. #endif
  21048. }
  21049. /*
  21050. ** Round up a request size to the next valid allocation size.
  21051. */
  21052. static int sqlite3MemRoundup(int n){
  21053. return ROUND8(n);
  21054. }
  21055. /*
  21056. ** Initialize this module.
  21057. */
  21058. static int sqlite3MemInit(void *NotUsed){
  21059. #if defined(__APPLE__) && !defined(SQLITE_WITHOUT_ZONEMALLOC)
  21060. int cpuCount;
  21061. size_t len;
  21062. if( _sqliteZone_ ){
  21063. return SQLITE_OK;
  21064. }
  21065. len = sizeof(cpuCount);
  21066. /* One usually wants to use hw.acctivecpu for MT decisions, but not here */
  21067. sysctlbyname("hw.ncpu", &cpuCount, &len, NULL, 0);
  21068. if( cpuCount>1 ){
  21069. /* defer MT decisions to system malloc */
  21070. _sqliteZone_ = malloc_default_zone();
  21071. }else{
  21072. /* only 1 core, use our own zone to contention over global locks,
  21073. ** e.g. we have our own dedicated locks */
  21074. _sqliteZone_ = malloc_create_zone(4096, 0);
  21075. malloc_set_zone_name(_sqliteZone_, "Sqlite_Heap");
  21076. }
  21077. #endif /* defined(__APPLE__) && !defined(SQLITE_WITHOUT_ZONEMALLOC) */
  21078. UNUSED_PARAMETER(NotUsed);
  21079. return SQLITE_OK;
  21080. }
  21081. /*
  21082. ** Deinitialize this module.
  21083. */
  21084. static void sqlite3MemShutdown(void *NotUsed){
  21085. UNUSED_PARAMETER(NotUsed);
  21086. return;
  21087. }
  21088. /*
  21089. ** This routine is the only routine in this file with external linkage.
  21090. **
  21091. ** Populate the low-level memory allocation function pointers in
  21092. ** sqlite3GlobalConfig.m with pointers to the routines in this file.
  21093. */
  21094. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  21095. static const sqlite3_mem_methods defaultMethods = {
  21096. sqlite3MemMalloc,
  21097. sqlite3MemFree,
  21098. sqlite3MemRealloc,
  21099. sqlite3MemSize,
  21100. sqlite3MemRoundup,
  21101. sqlite3MemInit,
  21102. sqlite3MemShutdown,
  21103. 0
  21104. };
  21105. sqlite3_config(SQLITE_CONFIG_MALLOC, &defaultMethods);
  21106. }
  21107. #endif /* SQLITE_SYSTEM_MALLOC */
  21108. /************** End of mem1.c ************************************************/
  21109. /************** Begin file mem2.c ********************************************/
  21110. /*
  21111. ** 2007 August 15
  21112. **
  21113. ** The author disclaims copyright to this source code. In place of
  21114. ** a legal notice, here is a blessing:
  21115. **
  21116. ** May you do good and not evil.
  21117. ** May you find forgiveness for yourself and forgive others.
  21118. ** May you share freely, never taking more than you give.
  21119. **
  21120. *************************************************************************
  21121. **
  21122. ** This file contains low-level memory allocation drivers for when
  21123. ** SQLite will use the standard C-library malloc/realloc/free interface
  21124. ** to obtain the memory it needs while adding lots of additional debugging
  21125. ** information to each allocation in order to help detect and fix memory
  21126. ** leaks and memory usage errors.
  21127. **
  21128. ** This file contains implementations of the low-level memory allocation
  21129. ** routines specified in the sqlite3_mem_methods object.
  21130. */
  21131. /* #include "sqliteInt.h" */
  21132. /*
  21133. ** This version of the memory allocator is used only if the
  21134. ** SQLITE_MEMDEBUG macro is defined
  21135. */
  21136. #ifdef SQLITE_MEMDEBUG
  21137. /*
  21138. ** The backtrace functionality is only available with GLIBC
  21139. */
  21140. #ifdef __GLIBC__
  21141. extern int backtrace(void**,int);
  21142. extern void backtrace_symbols_fd(void*const*,int,int);
  21143. #else
  21144. # define backtrace(A,B) 1
  21145. # define backtrace_symbols_fd(A,B,C)
  21146. #endif
  21147. /* #include <stdio.h> */
  21148. /*
  21149. ** Each memory allocation looks like this:
  21150. **
  21151. ** ------------------------------------------------------------------------
  21152. ** | Title | backtrace pointers | MemBlockHdr | allocation | EndGuard |
  21153. ** ------------------------------------------------------------------------
  21154. **
  21155. ** The application code sees only a pointer to the allocation. We have
  21156. ** to back up from the allocation pointer to find the MemBlockHdr. The
  21157. ** MemBlockHdr tells us the size of the allocation and the number of
  21158. ** backtrace pointers. There is also a guard word at the end of the
  21159. ** MemBlockHdr.
  21160. */
  21161. struct MemBlockHdr {
  21162. i64 iSize; /* Size of this allocation */
  21163. struct MemBlockHdr *pNext, *pPrev; /* Linked list of all unfreed memory */
  21164. char nBacktrace; /* Number of backtraces on this alloc */
  21165. char nBacktraceSlots; /* Available backtrace slots */
  21166. u8 nTitle; /* Bytes of title; includes '\0' */
  21167. u8 eType; /* Allocation type code */
  21168. int iForeGuard; /* Guard word for sanity */
  21169. };
  21170. /*
  21171. ** Guard words
  21172. */
  21173. #define FOREGUARD 0x80F5E153
  21174. #define REARGUARD 0xE4676B53
  21175. /*
  21176. ** Number of malloc size increments to track.
  21177. */
  21178. #define NCSIZE 1000
  21179. /*
  21180. ** All of the static variables used by this module are collected
  21181. ** into a single structure named "mem". This is to keep the
  21182. ** static variables organized and to reduce namespace pollution
  21183. ** when this module is combined with other in the amalgamation.
  21184. */
  21185. static struct {
  21186. /*
  21187. ** Mutex to control access to the memory allocation subsystem.
  21188. */
  21189. sqlite3_mutex *mutex;
  21190. /*
  21191. ** Head and tail of a linked list of all outstanding allocations
  21192. */
  21193. struct MemBlockHdr *pFirst;
  21194. struct MemBlockHdr *pLast;
  21195. /*
  21196. ** The number of levels of backtrace to save in new allocations.
  21197. */
  21198. int nBacktrace;
  21199. void (*xBacktrace)(int, int, void **);
  21200. /*
  21201. ** Title text to insert in front of each block
  21202. */
  21203. int nTitle; /* Bytes of zTitle to save. Includes '\0' and padding */
  21204. char zTitle[100]; /* The title text */
  21205. /*
  21206. ** sqlite3MallocDisallow() increments the following counter.
  21207. ** sqlite3MallocAllow() decrements it.
  21208. */
  21209. int disallow; /* Do not allow memory allocation */
  21210. /*
  21211. ** Gather statistics on the sizes of memory allocations.
  21212. ** nAlloc[i] is the number of allocation attempts of i*8
  21213. ** bytes. i==NCSIZE is the number of allocation attempts for
  21214. ** sizes more than NCSIZE*8 bytes.
  21215. */
  21216. int nAlloc[NCSIZE]; /* Total number of allocations */
  21217. int nCurrent[NCSIZE]; /* Current number of allocations */
  21218. int mxCurrent[NCSIZE]; /* Highwater mark for nCurrent */
  21219. } mem;
  21220. /*
  21221. ** Adjust memory usage statistics
  21222. */
  21223. static void adjustStats(int iSize, int increment){
  21224. int i = ROUND8(iSize)/8;
  21225. if( i>NCSIZE-1 ){
  21226. i = NCSIZE - 1;
  21227. }
  21228. if( increment>0 ){
  21229. mem.nAlloc[i]++;
  21230. mem.nCurrent[i]++;
  21231. if( mem.nCurrent[i]>mem.mxCurrent[i] ){
  21232. mem.mxCurrent[i] = mem.nCurrent[i];
  21233. }
  21234. }else{
  21235. mem.nCurrent[i]--;
  21236. assert( mem.nCurrent[i]>=0 );
  21237. }
  21238. }
  21239. /*
  21240. ** Given an allocation, find the MemBlockHdr for that allocation.
  21241. **
  21242. ** This routine checks the guards at either end of the allocation and
  21243. ** if they are incorrect it asserts.
  21244. */
  21245. static struct MemBlockHdr *sqlite3MemsysGetHeader(void *pAllocation){
  21246. struct MemBlockHdr *p;
  21247. int *pInt;
  21248. u8 *pU8;
  21249. int nReserve;
  21250. p = (struct MemBlockHdr*)pAllocation;
  21251. p--;
  21252. assert( p->iForeGuard==(int)FOREGUARD );
  21253. nReserve = ROUND8(p->iSize);
  21254. pInt = (int*)pAllocation;
  21255. pU8 = (u8*)pAllocation;
  21256. assert( pInt[nReserve/sizeof(int)]==(int)REARGUARD );
  21257. /* This checks any of the "extra" bytes allocated due
  21258. ** to rounding up to an 8 byte boundary to ensure
  21259. ** they haven't been overwritten.
  21260. */
  21261. while( nReserve-- > p->iSize ) assert( pU8[nReserve]==0x65 );
  21262. return p;
  21263. }
  21264. /*
  21265. ** Return the number of bytes currently allocated at address p.
  21266. */
  21267. static int sqlite3MemSize(void *p){
  21268. struct MemBlockHdr *pHdr;
  21269. if( !p ){
  21270. return 0;
  21271. }
  21272. pHdr = sqlite3MemsysGetHeader(p);
  21273. return (int)pHdr->iSize;
  21274. }
  21275. /*
  21276. ** Initialize the memory allocation subsystem.
  21277. */
  21278. static int sqlite3MemInit(void *NotUsed){
  21279. UNUSED_PARAMETER(NotUsed);
  21280. assert( (sizeof(struct MemBlockHdr)&7) == 0 );
  21281. if( !sqlite3GlobalConfig.bMemstat ){
  21282. /* If memory status is enabled, then the malloc.c wrapper will already
  21283. ** hold the STATIC_MEM mutex when the routines here are invoked. */
  21284. mem.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  21285. }
  21286. return SQLITE_OK;
  21287. }
  21288. /*
  21289. ** Deinitialize the memory allocation subsystem.
  21290. */
  21291. static void sqlite3MemShutdown(void *NotUsed){
  21292. UNUSED_PARAMETER(NotUsed);
  21293. mem.mutex = 0;
  21294. }
  21295. /*
  21296. ** Round up a request size to the next valid allocation size.
  21297. */
  21298. static int sqlite3MemRoundup(int n){
  21299. return ROUND8(n);
  21300. }
  21301. /*
  21302. ** Fill a buffer with pseudo-random bytes. This is used to preset
  21303. ** the content of a new memory allocation to unpredictable values and
  21304. ** to clear the content of a freed allocation to unpredictable values.
  21305. */
  21306. static void randomFill(char *pBuf, int nByte){
  21307. unsigned int x, y, r;
  21308. x = SQLITE_PTR_TO_INT(pBuf);
  21309. y = nByte | 1;
  21310. while( nByte >= 4 ){
  21311. x = (x>>1) ^ (-(int)(x&1) & 0xd0000001);
  21312. y = y*1103515245 + 12345;
  21313. r = x ^ y;
  21314. *(int*)pBuf = r;
  21315. pBuf += 4;
  21316. nByte -= 4;
  21317. }
  21318. while( nByte-- > 0 ){
  21319. x = (x>>1) ^ (-(int)(x&1) & 0xd0000001);
  21320. y = y*1103515245 + 12345;
  21321. r = x ^ y;
  21322. *(pBuf++) = r & 0xff;
  21323. }
  21324. }
  21325. /*
  21326. ** Allocate nByte bytes of memory.
  21327. */
  21328. static void *sqlite3MemMalloc(int nByte){
  21329. struct MemBlockHdr *pHdr;
  21330. void **pBt;
  21331. char *z;
  21332. int *pInt;
  21333. void *p = 0;
  21334. int totalSize;
  21335. int nReserve;
  21336. sqlite3_mutex_enter(mem.mutex);
  21337. assert( mem.disallow==0 );
  21338. nReserve = ROUND8(nByte);
  21339. totalSize = nReserve + sizeof(*pHdr) + sizeof(int) +
  21340. mem.nBacktrace*sizeof(void*) + mem.nTitle;
  21341. p = malloc(totalSize);
  21342. if( p ){
  21343. z = p;
  21344. pBt = (void**)&z[mem.nTitle];
  21345. pHdr = (struct MemBlockHdr*)&pBt[mem.nBacktrace];
  21346. pHdr->pNext = 0;
  21347. pHdr->pPrev = mem.pLast;
  21348. if( mem.pLast ){
  21349. mem.pLast->pNext = pHdr;
  21350. }else{
  21351. mem.pFirst = pHdr;
  21352. }
  21353. mem.pLast = pHdr;
  21354. pHdr->iForeGuard = FOREGUARD;
  21355. pHdr->eType = MEMTYPE_HEAP;
  21356. pHdr->nBacktraceSlots = mem.nBacktrace;
  21357. pHdr->nTitle = mem.nTitle;
  21358. if( mem.nBacktrace ){
  21359. void *aAddr[40];
  21360. pHdr->nBacktrace = backtrace(aAddr, mem.nBacktrace+1)-1;
  21361. memcpy(pBt, &aAddr[1], pHdr->nBacktrace*sizeof(void*));
  21362. assert(pBt[0]);
  21363. if( mem.xBacktrace ){
  21364. mem.xBacktrace(nByte, pHdr->nBacktrace-1, &aAddr[1]);
  21365. }
  21366. }else{
  21367. pHdr->nBacktrace = 0;
  21368. }
  21369. if( mem.nTitle ){
  21370. memcpy(z, mem.zTitle, mem.nTitle);
  21371. }
  21372. pHdr->iSize = nByte;
  21373. adjustStats(nByte, +1);
  21374. pInt = (int*)&pHdr[1];
  21375. pInt[nReserve/sizeof(int)] = REARGUARD;
  21376. randomFill((char*)pInt, nByte);
  21377. memset(((char*)pInt)+nByte, 0x65, nReserve-nByte);
  21378. p = (void*)pInt;
  21379. }
  21380. sqlite3_mutex_leave(mem.mutex);
  21381. return p;
  21382. }
  21383. /*
  21384. ** Free memory.
  21385. */
  21386. static void sqlite3MemFree(void *pPrior){
  21387. struct MemBlockHdr *pHdr;
  21388. void **pBt;
  21389. char *z;
  21390. assert( sqlite3GlobalConfig.bMemstat || sqlite3GlobalConfig.bCoreMutex==0
  21391. || mem.mutex!=0 );
  21392. pHdr = sqlite3MemsysGetHeader(pPrior);
  21393. pBt = (void**)pHdr;
  21394. pBt -= pHdr->nBacktraceSlots;
  21395. sqlite3_mutex_enter(mem.mutex);
  21396. if( pHdr->pPrev ){
  21397. assert( pHdr->pPrev->pNext==pHdr );
  21398. pHdr->pPrev->pNext = pHdr->pNext;
  21399. }else{
  21400. assert( mem.pFirst==pHdr );
  21401. mem.pFirst = pHdr->pNext;
  21402. }
  21403. if( pHdr->pNext ){
  21404. assert( pHdr->pNext->pPrev==pHdr );
  21405. pHdr->pNext->pPrev = pHdr->pPrev;
  21406. }else{
  21407. assert( mem.pLast==pHdr );
  21408. mem.pLast = pHdr->pPrev;
  21409. }
  21410. z = (char*)pBt;
  21411. z -= pHdr->nTitle;
  21412. adjustStats((int)pHdr->iSize, -1);
  21413. randomFill(z, sizeof(void*)*pHdr->nBacktraceSlots + sizeof(*pHdr) +
  21414. (int)pHdr->iSize + sizeof(int) + pHdr->nTitle);
  21415. free(z);
  21416. sqlite3_mutex_leave(mem.mutex);
  21417. }
  21418. /*
  21419. ** Change the size of an existing memory allocation.
  21420. **
  21421. ** For this debugging implementation, we *always* make a copy of the
  21422. ** allocation into a new place in memory. In this way, if the
  21423. ** higher level code is using pointer to the old allocation, it is
  21424. ** much more likely to break and we are much more liking to find
  21425. ** the error.
  21426. */
  21427. static void *sqlite3MemRealloc(void *pPrior, int nByte){
  21428. struct MemBlockHdr *pOldHdr;
  21429. void *pNew;
  21430. assert( mem.disallow==0 );
  21431. assert( (nByte & 7)==0 ); /* EV: R-46199-30249 */
  21432. pOldHdr = sqlite3MemsysGetHeader(pPrior);
  21433. pNew = sqlite3MemMalloc(nByte);
  21434. if( pNew ){
  21435. memcpy(pNew, pPrior, (int)(nByte<pOldHdr->iSize ? nByte : pOldHdr->iSize));
  21436. if( nByte>pOldHdr->iSize ){
  21437. randomFill(&((char*)pNew)[pOldHdr->iSize], nByte - (int)pOldHdr->iSize);
  21438. }
  21439. sqlite3MemFree(pPrior);
  21440. }
  21441. return pNew;
  21442. }
  21443. /*
  21444. ** Populate the low-level memory allocation function pointers in
  21445. ** sqlite3GlobalConfig.m with pointers to the routines in this file.
  21446. */
  21447. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  21448. static const sqlite3_mem_methods defaultMethods = {
  21449. sqlite3MemMalloc,
  21450. sqlite3MemFree,
  21451. sqlite3MemRealloc,
  21452. sqlite3MemSize,
  21453. sqlite3MemRoundup,
  21454. sqlite3MemInit,
  21455. sqlite3MemShutdown,
  21456. 0
  21457. };
  21458. sqlite3_config(SQLITE_CONFIG_MALLOC, &defaultMethods);
  21459. }
  21460. /*
  21461. ** Set the "type" of an allocation.
  21462. */
  21463. SQLITE_PRIVATE void sqlite3MemdebugSetType(void *p, u8 eType){
  21464. if( p && sqlite3GlobalConfig.m.xMalloc==sqlite3MemMalloc ){
  21465. struct MemBlockHdr *pHdr;
  21466. pHdr = sqlite3MemsysGetHeader(p);
  21467. assert( pHdr->iForeGuard==FOREGUARD );
  21468. pHdr->eType = eType;
  21469. }
  21470. }
  21471. /*
  21472. ** Return TRUE if the mask of type in eType matches the type of the
  21473. ** allocation p. Also return true if p==NULL.
  21474. **
  21475. ** This routine is designed for use within an assert() statement, to
  21476. ** verify the type of an allocation. For example:
  21477. **
  21478. ** assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  21479. */
  21480. SQLITE_PRIVATE int sqlite3MemdebugHasType(void *p, u8 eType){
  21481. int rc = 1;
  21482. if( p && sqlite3GlobalConfig.m.xMalloc==sqlite3MemMalloc ){
  21483. struct MemBlockHdr *pHdr;
  21484. pHdr = sqlite3MemsysGetHeader(p);
  21485. assert( pHdr->iForeGuard==FOREGUARD ); /* Allocation is valid */
  21486. if( (pHdr->eType&eType)==0 ){
  21487. rc = 0;
  21488. }
  21489. }
  21490. return rc;
  21491. }
  21492. /*
  21493. ** Return TRUE if the mask of type in eType matches no bits of the type of the
  21494. ** allocation p. Also return true if p==NULL.
  21495. **
  21496. ** This routine is designed for use within an assert() statement, to
  21497. ** verify the type of an allocation. For example:
  21498. **
  21499. ** assert( sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
  21500. */
  21501. SQLITE_PRIVATE int sqlite3MemdebugNoType(void *p, u8 eType){
  21502. int rc = 1;
  21503. if( p && sqlite3GlobalConfig.m.xMalloc==sqlite3MemMalloc ){
  21504. struct MemBlockHdr *pHdr;
  21505. pHdr = sqlite3MemsysGetHeader(p);
  21506. assert( pHdr->iForeGuard==FOREGUARD ); /* Allocation is valid */
  21507. if( (pHdr->eType&eType)!=0 ){
  21508. rc = 0;
  21509. }
  21510. }
  21511. return rc;
  21512. }
  21513. /*
  21514. ** Set the number of backtrace levels kept for each allocation.
  21515. ** A value of zero turns off backtracing. The number is always rounded
  21516. ** up to a multiple of 2.
  21517. */
  21518. SQLITE_PRIVATE void sqlite3MemdebugBacktrace(int depth){
  21519. if( depth<0 ){ depth = 0; }
  21520. if( depth>20 ){ depth = 20; }
  21521. depth = (depth+1)&0xfe;
  21522. mem.nBacktrace = depth;
  21523. }
  21524. SQLITE_PRIVATE void sqlite3MemdebugBacktraceCallback(void (*xBacktrace)(int, int, void **)){
  21525. mem.xBacktrace = xBacktrace;
  21526. }
  21527. /*
  21528. ** Set the title string for subsequent allocations.
  21529. */
  21530. SQLITE_PRIVATE void sqlite3MemdebugSettitle(const char *zTitle){
  21531. unsigned int n = sqlite3Strlen30(zTitle) + 1;
  21532. sqlite3_mutex_enter(mem.mutex);
  21533. if( n>=sizeof(mem.zTitle) ) n = sizeof(mem.zTitle)-1;
  21534. memcpy(mem.zTitle, zTitle, n);
  21535. mem.zTitle[n] = 0;
  21536. mem.nTitle = ROUND8(n);
  21537. sqlite3_mutex_leave(mem.mutex);
  21538. }
  21539. SQLITE_PRIVATE void sqlite3MemdebugSync(){
  21540. struct MemBlockHdr *pHdr;
  21541. for(pHdr=mem.pFirst; pHdr; pHdr=pHdr->pNext){
  21542. void **pBt = (void**)pHdr;
  21543. pBt -= pHdr->nBacktraceSlots;
  21544. mem.xBacktrace((int)pHdr->iSize, pHdr->nBacktrace-1, &pBt[1]);
  21545. }
  21546. }
  21547. /*
  21548. ** Open the file indicated and write a log of all unfreed memory
  21549. ** allocations into that log.
  21550. */
  21551. SQLITE_PRIVATE void sqlite3MemdebugDump(const char *zFilename){
  21552. FILE *out;
  21553. struct MemBlockHdr *pHdr;
  21554. void **pBt;
  21555. int i;
  21556. out = fopen(zFilename, "w");
  21557. if( out==0 ){
  21558. fprintf(stderr, "** Unable to output memory debug output log: %s **\n",
  21559. zFilename);
  21560. return;
  21561. }
  21562. for(pHdr=mem.pFirst; pHdr; pHdr=pHdr->pNext){
  21563. char *z = (char*)pHdr;
  21564. z -= pHdr->nBacktraceSlots*sizeof(void*) + pHdr->nTitle;
  21565. fprintf(out, "**** %lld bytes at %p from %s ****\n",
  21566. pHdr->iSize, &pHdr[1], pHdr->nTitle ? z : "???");
  21567. if( pHdr->nBacktrace ){
  21568. fflush(out);
  21569. pBt = (void**)pHdr;
  21570. pBt -= pHdr->nBacktraceSlots;
  21571. backtrace_symbols_fd(pBt, pHdr->nBacktrace, fileno(out));
  21572. fprintf(out, "\n");
  21573. }
  21574. }
  21575. fprintf(out, "COUNTS:\n");
  21576. for(i=0; i<NCSIZE-1; i++){
  21577. if( mem.nAlloc[i] ){
  21578. fprintf(out, " %5d: %10d %10d %10d\n",
  21579. i*8, mem.nAlloc[i], mem.nCurrent[i], mem.mxCurrent[i]);
  21580. }
  21581. }
  21582. if( mem.nAlloc[NCSIZE-1] ){
  21583. fprintf(out, " %5d: %10d %10d %10d\n",
  21584. NCSIZE*8-8, mem.nAlloc[NCSIZE-1],
  21585. mem.nCurrent[NCSIZE-1], mem.mxCurrent[NCSIZE-1]);
  21586. }
  21587. fclose(out);
  21588. }
  21589. /*
  21590. ** Return the number of times sqlite3MemMalloc() has been called.
  21591. */
  21592. SQLITE_PRIVATE int sqlite3MemdebugMallocCount(){
  21593. int i;
  21594. int nTotal = 0;
  21595. for(i=0; i<NCSIZE; i++){
  21596. nTotal += mem.nAlloc[i];
  21597. }
  21598. return nTotal;
  21599. }
  21600. #endif /* SQLITE_MEMDEBUG */
  21601. /************** End of mem2.c ************************************************/
  21602. /************** Begin file mem3.c ********************************************/
  21603. /*
  21604. ** 2007 October 14
  21605. **
  21606. ** The author disclaims copyright to this source code. In place of
  21607. ** a legal notice, here is a blessing:
  21608. **
  21609. ** May you do good and not evil.
  21610. ** May you find forgiveness for yourself and forgive others.
  21611. ** May you share freely, never taking more than you give.
  21612. **
  21613. *************************************************************************
  21614. ** This file contains the C functions that implement a memory
  21615. ** allocation subsystem for use by SQLite.
  21616. **
  21617. ** This version of the memory allocation subsystem omits all
  21618. ** use of malloc(). The SQLite user supplies a block of memory
  21619. ** before calling sqlite3_initialize() from which allocations
  21620. ** are made and returned by the xMalloc() and xRealloc()
  21621. ** implementations. Once sqlite3_initialize() has been called,
  21622. ** the amount of memory available to SQLite is fixed and cannot
  21623. ** be changed.
  21624. **
  21625. ** This version of the memory allocation subsystem is included
  21626. ** in the build only if SQLITE_ENABLE_MEMSYS3 is defined.
  21627. */
  21628. /* #include "sqliteInt.h" */
  21629. /*
  21630. ** This version of the memory allocator is only built into the library
  21631. ** SQLITE_ENABLE_MEMSYS3 is defined. Defining this symbol does not
  21632. ** mean that the library will use a memory-pool by default, just that
  21633. ** it is available. The mempool allocator is activated by calling
  21634. ** sqlite3_config().
  21635. */
  21636. #ifdef SQLITE_ENABLE_MEMSYS3
  21637. /*
  21638. ** Maximum size (in Mem3Blocks) of a "small" chunk.
  21639. */
  21640. #define MX_SMALL 10
  21641. /*
  21642. ** Number of freelist hash slots
  21643. */
  21644. #define N_HASH 61
  21645. /*
  21646. ** A memory allocation (also called a "chunk") consists of two or
  21647. ** more blocks where each block is 8 bytes. The first 8 bytes are
  21648. ** a header that is not returned to the user.
  21649. **
  21650. ** A chunk is two or more blocks that is either checked out or
  21651. ** free. The first block has format u.hdr. u.hdr.size4x is 4 times the
  21652. ** size of the allocation in blocks if the allocation is free.
  21653. ** The u.hdr.size4x&1 bit is true if the chunk is checked out and
  21654. ** false if the chunk is on the freelist. The u.hdr.size4x&2 bit
  21655. ** is true if the previous chunk is checked out and false if the
  21656. ** previous chunk is free. The u.hdr.prevSize field is the size of
  21657. ** the previous chunk in blocks if the previous chunk is on the
  21658. ** freelist. If the previous chunk is checked out, then
  21659. ** u.hdr.prevSize can be part of the data for that chunk and should
  21660. ** not be read or written.
  21661. **
  21662. ** We often identify a chunk by its index in mem3.aPool[]. When
  21663. ** this is done, the chunk index refers to the second block of
  21664. ** the chunk. In this way, the first chunk has an index of 1.
  21665. ** A chunk index of 0 means "no such chunk" and is the equivalent
  21666. ** of a NULL pointer.
  21667. **
  21668. ** The second block of free chunks is of the form u.list. The
  21669. ** two fields form a double-linked list of chunks of related sizes.
  21670. ** Pointers to the head of the list are stored in mem3.aiSmall[]
  21671. ** for smaller chunks and mem3.aiHash[] for larger chunks.
  21672. **
  21673. ** The second block of a chunk is user data if the chunk is checked
  21674. ** out. If a chunk is checked out, the user data may extend into
  21675. ** the u.hdr.prevSize value of the following chunk.
  21676. */
  21677. typedef struct Mem3Block Mem3Block;
  21678. struct Mem3Block {
  21679. union {
  21680. struct {
  21681. u32 prevSize; /* Size of previous chunk in Mem3Block elements */
  21682. u32 size4x; /* 4x the size of current chunk in Mem3Block elements */
  21683. } hdr;
  21684. struct {
  21685. u32 next; /* Index in mem3.aPool[] of next free chunk */
  21686. u32 prev; /* Index in mem3.aPool[] of previous free chunk */
  21687. } list;
  21688. } u;
  21689. };
  21690. /*
  21691. ** All of the static variables used by this module are collected
  21692. ** into a single structure named "mem3". This is to keep the
  21693. ** static variables organized and to reduce namespace pollution
  21694. ** when this module is combined with other in the amalgamation.
  21695. */
  21696. static SQLITE_WSD struct Mem3Global {
  21697. /*
  21698. ** Memory available for allocation. nPool is the size of the array
  21699. ** (in Mem3Blocks) pointed to by aPool less 2.
  21700. */
  21701. u32 nPool;
  21702. Mem3Block *aPool;
  21703. /*
  21704. ** True if we are evaluating an out-of-memory callback.
  21705. */
  21706. int alarmBusy;
  21707. /*
  21708. ** Mutex to control access to the memory allocation subsystem.
  21709. */
  21710. sqlite3_mutex *mutex;
  21711. /*
  21712. ** The minimum amount of free space that we have seen.
  21713. */
  21714. u32 mnMaster;
  21715. /*
  21716. ** iMaster is the index of the master chunk. Most new allocations
  21717. ** occur off of this chunk. szMaster is the size (in Mem3Blocks)
  21718. ** of the current master. iMaster is 0 if there is not master chunk.
  21719. ** The master chunk is not in either the aiHash[] or aiSmall[].
  21720. */
  21721. u32 iMaster;
  21722. u32 szMaster;
  21723. /*
  21724. ** Array of lists of free blocks according to the block size
  21725. ** for smaller chunks, or a hash on the block size for larger
  21726. ** chunks.
  21727. */
  21728. u32 aiSmall[MX_SMALL-1]; /* For sizes 2 through MX_SMALL, inclusive */
  21729. u32 aiHash[N_HASH]; /* For sizes MX_SMALL+1 and larger */
  21730. } mem3 = { 97535575 };
  21731. #define mem3 GLOBAL(struct Mem3Global, mem3)
  21732. /*
  21733. ** Unlink the chunk at mem3.aPool[i] from list it is currently
  21734. ** on. *pRoot is the list that i is a member of.
  21735. */
  21736. static void memsys3UnlinkFromList(u32 i, u32 *pRoot){
  21737. u32 next = mem3.aPool[i].u.list.next;
  21738. u32 prev = mem3.aPool[i].u.list.prev;
  21739. assert( sqlite3_mutex_held(mem3.mutex) );
  21740. if( prev==0 ){
  21741. *pRoot = next;
  21742. }else{
  21743. mem3.aPool[prev].u.list.next = next;
  21744. }
  21745. if( next ){
  21746. mem3.aPool[next].u.list.prev = prev;
  21747. }
  21748. mem3.aPool[i].u.list.next = 0;
  21749. mem3.aPool[i].u.list.prev = 0;
  21750. }
  21751. /*
  21752. ** Unlink the chunk at index i from
  21753. ** whatever list is currently a member of.
  21754. */
  21755. static void memsys3Unlink(u32 i){
  21756. u32 size, hash;
  21757. assert( sqlite3_mutex_held(mem3.mutex) );
  21758. assert( (mem3.aPool[i-1].u.hdr.size4x & 1)==0 );
  21759. assert( i>=1 );
  21760. size = mem3.aPool[i-1].u.hdr.size4x/4;
  21761. assert( size==mem3.aPool[i+size-1].u.hdr.prevSize );
  21762. assert( size>=2 );
  21763. if( size <= MX_SMALL ){
  21764. memsys3UnlinkFromList(i, &mem3.aiSmall[size-2]);
  21765. }else{
  21766. hash = size % N_HASH;
  21767. memsys3UnlinkFromList(i, &mem3.aiHash[hash]);
  21768. }
  21769. }
  21770. /*
  21771. ** Link the chunk at mem3.aPool[i] so that is on the list rooted
  21772. ** at *pRoot.
  21773. */
  21774. static void memsys3LinkIntoList(u32 i, u32 *pRoot){
  21775. assert( sqlite3_mutex_held(mem3.mutex) );
  21776. mem3.aPool[i].u.list.next = *pRoot;
  21777. mem3.aPool[i].u.list.prev = 0;
  21778. if( *pRoot ){
  21779. mem3.aPool[*pRoot].u.list.prev = i;
  21780. }
  21781. *pRoot = i;
  21782. }
  21783. /*
  21784. ** Link the chunk at index i into either the appropriate
  21785. ** small chunk list, or into the large chunk hash table.
  21786. */
  21787. static void memsys3Link(u32 i){
  21788. u32 size, hash;
  21789. assert( sqlite3_mutex_held(mem3.mutex) );
  21790. assert( i>=1 );
  21791. assert( (mem3.aPool[i-1].u.hdr.size4x & 1)==0 );
  21792. size = mem3.aPool[i-1].u.hdr.size4x/4;
  21793. assert( size==mem3.aPool[i+size-1].u.hdr.prevSize );
  21794. assert( size>=2 );
  21795. if( size <= MX_SMALL ){
  21796. memsys3LinkIntoList(i, &mem3.aiSmall[size-2]);
  21797. }else{
  21798. hash = size % N_HASH;
  21799. memsys3LinkIntoList(i, &mem3.aiHash[hash]);
  21800. }
  21801. }
  21802. /*
  21803. ** If the STATIC_MEM mutex is not already held, obtain it now. The mutex
  21804. ** will already be held (obtained by code in malloc.c) if
  21805. ** sqlite3GlobalConfig.bMemStat is true.
  21806. */
  21807. static void memsys3Enter(void){
  21808. if( sqlite3GlobalConfig.bMemstat==0 && mem3.mutex==0 ){
  21809. mem3.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  21810. }
  21811. sqlite3_mutex_enter(mem3.mutex);
  21812. }
  21813. static void memsys3Leave(void){
  21814. sqlite3_mutex_leave(mem3.mutex);
  21815. }
  21816. /*
  21817. ** Called when we are unable to satisfy an allocation of nBytes.
  21818. */
  21819. static void memsys3OutOfMemory(int nByte){
  21820. if( !mem3.alarmBusy ){
  21821. mem3.alarmBusy = 1;
  21822. assert( sqlite3_mutex_held(mem3.mutex) );
  21823. sqlite3_mutex_leave(mem3.mutex);
  21824. sqlite3_release_memory(nByte);
  21825. sqlite3_mutex_enter(mem3.mutex);
  21826. mem3.alarmBusy = 0;
  21827. }
  21828. }
  21829. /*
  21830. ** Chunk i is a free chunk that has been unlinked. Adjust its
  21831. ** size parameters for check-out and return a pointer to the
  21832. ** user portion of the chunk.
  21833. */
  21834. static void *memsys3Checkout(u32 i, u32 nBlock){
  21835. u32 x;
  21836. assert( sqlite3_mutex_held(mem3.mutex) );
  21837. assert( i>=1 );
  21838. assert( mem3.aPool[i-1].u.hdr.size4x/4==nBlock );
  21839. assert( mem3.aPool[i+nBlock-1].u.hdr.prevSize==nBlock );
  21840. x = mem3.aPool[i-1].u.hdr.size4x;
  21841. mem3.aPool[i-1].u.hdr.size4x = nBlock*4 | 1 | (x&2);
  21842. mem3.aPool[i+nBlock-1].u.hdr.prevSize = nBlock;
  21843. mem3.aPool[i+nBlock-1].u.hdr.size4x |= 2;
  21844. return &mem3.aPool[i];
  21845. }
  21846. /*
  21847. ** Carve a piece off of the end of the mem3.iMaster free chunk.
  21848. ** Return a pointer to the new allocation. Or, if the master chunk
  21849. ** is not large enough, return 0.
  21850. */
  21851. static void *memsys3FromMaster(u32 nBlock){
  21852. assert( sqlite3_mutex_held(mem3.mutex) );
  21853. assert( mem3.szMaster>=nBlock );
  21854. if( nBlock>=mem3.szMaster-1 ){
  21855. /* Use the entire master */
  21856. void *p = memsys3Checkout(mem3.iMaster, mem3.szMaster);
  21857. mem3.iMaster = 0;
  21858. mem3.szMaster = 0;
  21859. mem3.mnMaster = 0;
  21860. return p;
  21861. }else{
  21862. /* Split the master block. Return the tail. */
  21863. u32 newi, x;
  21864. newi = mem3.iMaster + mem3.szMaster - nBlock;
  21865. assert( newi > mem3.iMaster+1 );
  21866. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.prevSize = nBlock;
  21867. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.size4x |= 2;
  21868. mem3.aPool[newi-1].u.hdr.size4x = nBlock*4 + 1;
  21869. mem3.szMaster -= nBlock;
  21870. mem3.aPool[newi-1].u.hdr.prevSize = mem3.szMaster;
  21871. x = mem3.aPool[mem3.iMaster-1].u.hdr.size4x & 2;
  21872. mem3.aPool[mem3.iMaster-1].u.hdr.size4x = mem3.szMaster*4 | x;
  21873. if( mem3.szMaster < mem3.mnMaster ){
  21874. mem3.mnMaster = mem3.szMaster;
  21875. }
  21876. return (void*)&mem3.aPool[newi];
  21877. }
  21878. }
  21879. /*
  21880. ** *pRoot is the head of a list of free chunks of the same size
  21881. ** or same size hash. In other words, *pRoot is an entry in either
  21882. ** mem3.aiSmall[] or mem3.aiHash[].
  21883. **
  21884. ** This routine examines all entries on the given list and tries
  21885. ** to coalesce each entries with adjacent free chunks.
  21886. **
  21887. ** If it sees a chunk that is larger than mem3.iMaster, it replaces
  21888. ** the current mem3.iMaster with the new larger chunk. In order for
  21889. ** this mem3.iMaster replacement to work, the master chunk must be
  21890. ** linked into the hash tables. That is not the normal state of
  21891. ** affairs, of course. The calling routine must link the master
  21892. ** chunk before invoking this routine, then must unlink the (possibly
  21893. ** changed) master chunk once this routine has finished.
  21894. */
  21895. static void memsys3Merge(u32 *pRoot){
  21896. u32 iNext, prev, size, i, x;
  21897. assert( sqlite3_mutex_held(mem3.mutex) );
  21898. for(i=*pRoot; i>0; i=iNext){
  21899. iNext = mem3.aPool[i].u.list.next;
  21900. size = mem3.aPool[i-1].u.hdr.size4x;
  21901. assert( (size&1)==0 );
  21902. if( (size&2)==0 ){
  21903. memsys3UnlinkFromList(i, pRoot);
  21904. assert( i > mem3.aPool[i-1].u.hdr.prevSize );
  21905. prev = i - mem3.aPool[i-1].u.hdr.prevSize;
  21906. if( prev==iNext ){
  21907. iNext = mem3.aPool[prev].u.list.next;
  21908. }
  21909. memsys3Unlink(prev);
  21910. size = i + size/4 - prev;
  21911. x = mem3.aPool[prev-1].u.hdr.size4x & 2;
  21912. mem3.aPool[prev-1].u.hdr.size4x = size*4 | x;
  21913. mem3.aPool[prev+size-1].u.hdr.prevSize = size;
  21914. memsys3Link(prev);
  21915. i = prev;
  21916. }else{
  21917. size /= 4;
  21918. }
  21919. if( size>mem3.szMaster ){
  21920. mem3.iMaster = i;
  21921. mem3.szMaster = size;
  21922. }
  21923. }
  21924. }
  21925. /*
  21926. ** Return a block of memory of at least nBytes in size.
  21927. ** Return NULL if unable.
  21928. **
  21929. ** This function assumes that the necessary mutexes, if any, are
  21930. ** already held by the caller. Hence "Unsafe".
  21931. */
  21932. static void *memsys3MallocUnsafe(int nByte){
  21933. u32 i;
  21934. u32 nBlock;
  21935. u32 toFree;
  21936. assert( sqlite3_mutex_held(mem3.mutex) );
  21937. assert( sizeof(Mem3Block)==8 );
  21938. if( nByte<=12 ){
  21939. nBlock = 2;
  21940. }else{
  21941. nBlock = (nByte + 11)/8;
  21942. }
  21943. assert( nBlock>=2 );
  21944. /* STEP 1:
  21945. ** Look for an entry of the correct size in either the small
  21946. ** chunk table or in the large chunk hash table. This is
  21947. ** successful most of the time (about 9 times out of 10).
  21948. */
  21949. if( nBlock <= MX_SMALL ){
  21950. i = mem3.aiSmall[nBlock-2];
  21951. if( i>0 ){
  21952. memsys3UnlinkFromList(i, &mem3.aiSmall[nBlock-2]);
  21953. return memsys3Checkout(i, nBlock);
  21954. }
  21955. }else{
  21956. int hash = nBlock % N_HASH;
  21957. for(i=mem3.aiHash[hash]; i>0; i=mem3.aPool[i].u.list.next){
  21958. if( mem3.aPool[i-1].u.hdr.size4x/4==nBlock ){
  21959. memsys3UnlinkFromList(i, &mem3.aiHash[hash]);
  21960. return memsys3Checkout(i, nBlock);
  21961. }
  21962. }
  21963. }
  21964. /* STEP 2:
  21965. ** Try to satisfy the allocation by carving a piece off of the end
  21966. ** of the master chunk. This step usually works if step 1 fails.
  21967. */
  21968. if( mem3.szMaster>=nBlock ){
  21969. return memsys3FromMaster(nBlock);
  21970. }
  21971. /* STEP 3:
  21972. ** Loop through the entire memory pool. Coalesce adjacent free
  21973. ** chunks. Recompute the master chunk as the largest free chunk.
  21974. ** Then try again to satisfy the allocation by carving a piece off
  21975. ** of the end of the master chunk. This step happens very
  21976. ** rarely (we hope!)
  21977. */
  21978. for(toFree=nBlock*16; toFree<(mem3.nPool*16); toFree *= 2){
  21979. memsys3OutOfMemory(toFree);
  21980. if( mem3.iMaster ){
  21981. memsys3Link(mem3.iMaster);
  21982. mem3.iMaster = 0;
  21983. mem3.szMaster = 0;
  21984. }
  21985. for(i=0; i<N_HASH; i++){
  21986. memsys3Merge(&mem3.aiHash[i]);
  21987. }
  21988. for(i=0; i<MX_SMALL-1; i++){
  21989. memsys3Merge(&mem3.aiSmall[i]);
  21990. }
  21991. if( mem3.szMaster ){
  21992. memsys3Unlink(mem3.iMaster);
  21993. if( mem3.szMaster>=nBlock ){
  21994. return memsys3FromMaster(nBlock);
  21995. }
  21996. }
  21997. }
  21998. /* If none of the above worked, then we fail. */
  21999. return 0;
  22000. }
  22001. /*
  22002. ** Free an outstanding memory allocation.
  22003. **
  22004. ** This function assumes that the necessary mutexes, if any, are
  22005. ** already held by the caller. Hence "Unsafe".
  22006. */
  22007. static void memsys3FreeUnsafe(void *pOld){
  22008. Mem3Block *p = (Mem3Block*)pOld;
  22009. int i;
  22010. u32 size, x;
  22011. assert( sqlite3_mutex_held(mem3.mutex) );
  22012. assert( p>mem3.aPool && p<&mem3.aPool[mem3.nPool] );
  22013. i = p - mem3.aPool;
  22014. assert( (mem3.aPool[i-1].u.hdr.size4x&1)==1 );
  22015. size = mem3.aPool[i-1].u.hdr.size4x/4;
  22016. assert( i+size<=mem3.nPool+1 );
  22017. mem3.aPool[i-1].u.hdr.size4x &= ~1;
  22018. mem3.aPool[i+size-1].u.hdr.prevSize = size;
  22019. mem3.aPool[i+size-1].u.hdr.size4x &= ~2;
  22020. memsys3Link(i);
  22021. /* Try to expand the master using the newly freed chunk */
  22022. if( mem3.iMaster ){
  22023. while( (mem3.aPool[mem3.iMaster-1].u.hdr.size4x&2)==0 ){
  22024. size = mem3.aPool[mem3.iMaster-1].u.hdr.prevSize;
  22025. mem3.iMaster -= size;
  22026. mem3.szMaster += size;
  22027. memsys3Unlink(mem3.iMaster);
  22028. x = mem3.aPool[mem3.iMaster-1].u.hdr.size4x & 2;
  22029. mem3.aPool[mem3.iMaster-1].u.hdr.size4x = mem3.szMaster*4 | x;
  22030. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.prevSize = mem3.szMaster;
  22031. }
  22032. x = mem3.aPool[mem3.iMaster-1].u.hdr.size4x & 2;
  22033. while( (mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.size4x&1)==0 ){
  22034. memsys3Unlink(mem3.iMaster+mem3.szMaster);
  22035. mem3.szMaster += mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.size4x/4;
  22036. mem3.aPool[mem3.iMaster-1].u.hdr.size4x = mem3.szMaster*4 | x;
  22037. mem3.aPool[mem3.iMaster+mem3.szMaster-1].u.hdr.prevSize = mem3.szMaster;
  22038. }
  22039. }
  22040. }
  22041. /*
  22042. ** Return the size of an outstanding allocation, in bytes. The
  22043. ** size returned omits the 8-byte header overhead. This only
  22044. ** works for chunks that are currently checked out.
  22045. */
  22046. static int memsys3Size(void *p){
  22047. Mem3Block *pBlock;
  22048. assert( p!=0 );
  22049. pBlock = (Mem3Block*)p;
  22050. assert( (pBlock[-1].u.hdr.size4x&1)!=0 );
  22051. return (pBlock[-1].u.hdr.size4x&~3)*2 - 4;
  22052. }
  22053. /*
  22054. ** Round up a request size to the next valid allocation size.
  22055. */
  22056. static int memsys3Roundup(int n){
  22057. if( n<=12 ){
  22058. return 12;
  22059. }else{
  22060. return ((n+11)&~7) - 4;
  22061. }
  22062. }
  22063. /*
  22064. ** Allocate nBytes of memory.
  22065. */
  22066. static void *memsys3Malloc(int nBytes){
  22067. sqlite3_int64 *p;
  22068. assert( nBytes>0 ); /* malloc.c filters out 0 byte requests */
  22069. memsys3Enter();
  22070. p = memsys3MallocUnsafe(nBytes);
  22071. memsys3Leave();
  22072. return (void*)p;
  22073. }
  22074. /*
  22075. ** Free memory.
  22076. */
  22077. static void memsys3Free(void *pPrior){
  22078. assert( pPrior );
  22079. memsys3Enter();
  22080. memsys3FreeUnsafe(pPrior);
  22081. memsys3Leave();
  22082. }
  22083. /*
  22084. ** Change the size of an existing memory allocation
  22085. */
  22086. static void *memsys3Realloc(void *pPrior, int nBytes){
  22087. int nOld;
  22088. void *p;
  22089. if( pPrior==0 ){
  22090. return sqlite3_malloc(nBytes);
  22091. }
  22092. if( nBytes<=0 ){
  22093. sqlite3_free(pPrior);
  22094. return 0;
  22095. }
  22096. nOld = memsys3Size(pPrior);
  22097. if( nBytes<=nOld && nBytes>=nOld-128 ){
  22098. return pPrior;
  22099. }
  22100. memsys3Enter();
  22101. p = memsys3MallocUnsafe(nBytes);
  22102. if( p ){
  22103. if( nOld<nBytes ){
  22104. memcpy(p, pPrior, nOld);
  22105. }else{
  22106. memcpy(p, pPrior, nBytes);
  22107. }
  22108. memsys3FreeUnsafe(pPrior);
  22109. }
  22110. memsys3Leave();
  22111. return p;
  22112. }
  22113. /*
  22114. ** Initialize this module.
  22115. */
  22116. static int memsys3Init(void *NotUsed){
  22117. UNUSED_PARAMETER(NotUsed);
  22118. if( !sqlite3GlobalConfig.pHeap ){
  22119. return SQLITE_ERROR;
  22120. }
  22121. /* Store a pointer to the memory block in global structure mem3. */
  22122. assert( sizeof(Mem3Block)==8 );
  22123. mem3.aPool = (Mem3Block *)sqlite3GlobalConfig.pHeap;
  22124. mem3.nPool = (sqlite3GlobalConfig.nHeap / sizeof(Mem3Block)) - 2;
  22125. /* Initialize the master block. */
  22126. mem3.szMaster = mem3.nPool;
  22127. mem3.mnMaster = mem3.szMaster;
  22128. mem3.iMaster = 1;
  22129. mem3.aPool[0].u.hdr.size4x = (mem3.szMaster<<2) + 2;
  22130. mem3.aPool[mem3.nPool].u.hdr.prevSize = mem3.nPool;
  22131. mem3.aPool[mem3.nPool].u.hdr.size4x = 1;
  22132. return SQLITE_OK;
  22133. }
  22134. /*
  22135. ** Deinitialize this module.
  22136. */
  22137. static void memsys3Shutdown(void *NotUsed){
  22138. UNUSED_PARAMETER(NotUsed);
  22139. mem3.mutex = 0;
  22140. return;
  22141. }
  22142. /*
  22143. ** Open the file indicated and write a log of all unfreed memory
  22144. ** allocations into that log.
  22145. */
  22146. SQLITE_PRIVATE void sqlite3Memsys3Dump(const char *zFilename){
  22147. #ifdef SQLITE_DEBUG
  22148. FILE *out;
  22149. u32 i, j;
  22150. u32 size;
  22151. if( zFilename==0 || zFilename[0]==0 ){
  22152. out = stdout;
  22153. }else{
  22154. out = fopen(zFilename, "w");
  22155. if( out==0 ){
  22156. fprintf(stderr, "** Unable to output memory debug output log: %s **\n",
  22157. zFilename);
  22158. return;
  22159. }
  22160. }
  22161. memsys3Enter();
  22162. fprintf(out, "CHUNKS:\n");
  22163. for(i=1; i<=mem3.nPool; i+=size/4){
  22164. size = mem3.aPool[i-1].u.hdr.size4x;
  22165. if( size/4<=1 ){
  22166. fprintf(out, "%p size error\n", &mem3.aPool[i]);
  22167. assert( 0 );
  22168. break;
  22169. }
  22170. if( (size&1)==0 && mem3.aPool[i+size/4-1].u.hdr.prevSize!=size/4 ){
  22171. fprintf(out, "%p tail size does not match\n", &mem3.aPool[i]);
  22172. assert( 0 );
  22173. break;
  22174. }
  22175. if( ((mem3.aPool[i+size/4-1].u.hdr.size4x&2)>>1)!=(size&1) ){
  22176. fprintf(out, "%p tail checkout bit is incorrect\n", &mem3.aPool[i]);
  22177. assert( 0 );
  22178. break;
  22179. }
  22180. if( size&1 ){
  22181. fprintf(out, "%p %6d bytes checked out\n", &mem3.aPool[i], (size/4)*8-8);
  22182. }else{
  22183. fprintf(out, "%p %6d bytes free%s\n", &mem3.aPool[i], (size/4)*8-8,
  22184. i==mem3.iMaster ? " **master**" : "");
  22185. }
  22186. }
  22187. for(i=0; i<MX_SMALL-1; i++){
  22188. if( mem3.aiSmall[i]==0 ) continue;
  22189. fprintf(out, "small(%2d):", i);
  22190. for(j = mem3.aiSmall[i]; j>0; j=mem3.aPool[j].u.list.next){
  22191. fprintf(out, " %p(%d)", &mem3.aPool[j],
  22192. (mem3.aPool[j-1].u.hdr.size4x/4)*8-8);
  22193. }
  22194. fprintf(out, "\n");
  22195. }
  22196. for(i=0; i<N_HASH; i++){
  22197. if( mem3.aiHash[i]==0 ) continue;
  22198. fprintf(out, "hash(%2d):", i);
  22199. for(j = mem3.aiHash[i]; j>0; j=mem3.aPool[j].u.list.next){
  22200. fprintf(out, " %p(%d)", &mem3.aPool[j],
  22201. (mem3.aPool[j-1].u.hdr.size4x/4)*8-8);
  22202. }
  22203. fprintf(out, "\n");
  22204. }
  22205. fprintf(out, "master=%d\n", mem3.iMaster);
  22206. fprintf(out, "nowUsed=%d\n", mem3.nPool*8 - mem3.szMaster*8);
  22207. fprintf(out, "mxUsed=%d\n", mem3.nPool*8 - mem3.mnMaster*8);
  22208. sqlite3_mutex_leave(mem3.mutex);
  22209. if( out==stdout ){
  22210. fflush(stdout);
  22211. }else{
  22212. fclose(out);
  22213. }
  22214. #else
  22215. UNUSED_PARAMETER(zFilename);
  22216. #endif
  22217. }
  22218. /*
  22219. ** This routine is the only routine in this file with external
  22220. ** linkage.
  22221. **
  22222. ** Populate the low-level memory allocation function pointers in
  22223. ** sqlite3GlobalConfig.m with pointers to the routines in this file. The
  22224. ** arguments specify the block of memory to manage.
  22225. **
  22226. ** This routine is only called by sqlite3_config(), and therefore
  22227. ** is not required to be threadsafe (it is not).
  22228. */
  22229. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys3(void){
  22230. static const sqlite3_mem_methods mempoolMethods = {
  22231. memsys3Malloc,
  22232. memsys3Free,
  22233. memsys3Realloc,
  22234. memsys3Size,
  22235. memsys3Roundup,
  22236. memsys3Init,
  22237. memsys3Shutdown,
  22238. 0
  22239. };
  22240. return &mempoolMethods;
  22241. }
  22242. #endif /* SQLITE_ENABLE_MEMSYS3 */
  22243. /************** End of mem3.c ************************************************/
  22244. /************** Begin file mem5.c ********************************************/
  22245. /*
  22246. ** 2007 October 14
  22247. **
  22248. ** The author disclaims copyright to this source code. In place of
  22249. ** a legal notice, here is a blessing:
  22250. **
  22251. ** May you do good and not evil.
  22252. ** May you find forgiveness for yourself and forgive others.
  22253. ** May you share freely, never taking more than you give.
  22254. **
  22255. *************************************************************************
  22256. ** This file contains the C functions that implement a memory
  22257. ** allocation subsystem for use by SQLite.
  22258. **
  22259. ** This version of the memory allocation subsystem omits all
  22260. ** use of malloc(). The application gives SQLite a block of memory
  22261. ** before calling sqlite3_initialize() from which allocations
  22262. ** are made and returned by the xMalloc() and xRealloc()
  22263. ** implementations. Once sqlite3_initialize() has been called,
  22264. ** the amount of memory available to SQLite is fixed and cannot
  22265. ** be changed.
  22266. **
  22267. ** This version of the memory allocation subsystem is included
  22268. ** in the build only if SQLITE_ENABLE_MEMSYS5 is defined.
  22269. **
  22270. ** This memory allocator uses the following algorithm:
  22271. **
  22272. ** 1. All memory allocation sizes are rounded up to a power of 2.
  22273. **
  22274. ** 2. If two adjacent free blocks are the halves of a larger block,
  22275. ** then the two blocks are coalesced into the single larger block.
  22276. **
  22277. ** 3. New memory is allocated from the first available free block.
  22278. **
  22279. ** This algorithm is described in: J. M. Robson. "Bounds for Some Functions
  22280. ** Concerning Dynamic Storage Allocation". Journal of the Association for
  22281. ** Computing Machinery, Volume 21, Number 8, July 1974, pages 491-499.
  22282. **
  22283. ** Let n be the size of the largest allocation divided by the minimum
  22284. ** allocation size (after rounding all sizes up to a power of 2.) Let M
  22285. ** be the maximum amount of memory ever outstanding at one time. Let
  22286. ** N be the total amount of memory available for allocation. Robson
  22287. ** proved that this memory allocator will never breakdown due to
  22288. ** fragmentation as long as the following constraint holds:
  22289. **
  22290. ** N >= M*(1 + log2(n)/2) - n + 1
  22291. **
  22292. ** The sqlite3_status() logic tracks the maximum values of n and M so
  22293. ** that an application can, at any time, verify this constraint.
  22294. */
  22295. /* #include "sqliteInt.h" */
  22296. /*
  22297. ** This version of the memory allocator is used only when
  22298. ** SQLITE_ENABLE_MEMSYS5 is defined.
  22299. */
  22300. #ifdef SQLITE_ENABLE_MEMSYS5
  22301. /*
  22302. ** A minimum allocation is an instance of the following structure.
  22303. ** Larger allocations are an array of these structures where the
  22304. ** size of the array is a power of 2.
  22305. **
  22306. ** The size of this object must be a power of two. That fact is
  22307. ** verified in memsys5Init().
  22308. */
  22309. typedef struct Mem5Link Mem5Link;
  22310. struct Mem5Link {
  22311. int next; /* Index of next free chunk */
  22312. int prev; /* Index of previous free chunk */
  22313. };
  22314. /*
  22315. ** Maximum size of any allocation is ((1<<LOGMAX)*mem5.szAtom). Since
  22316. ** mem5.szAtom is always at least 8 and 32-bit integers are used,
  22317. ** it is not actually possible to reach this limit.
  22318. */
  22319. #define LOGMAX 30
  22320. /*
  22321. ** Masks used for mem5.aCtrl[] elements.
  22322. */
  22323. #define CTRL_LOGSIZE 0x1f /* Log2 Size of this block */
  22324. #define CTRL_FREE 0x20 /* True if not checked out */
  22325. /*
  22326. ** All of the static variables used by this module are collected
  22327. ** into a single structure named "mem5". This is to keep the
  22328. ** static variables organized and to reduce namespace pollution
  22329. ** when this module is combined with other in the amalgamation.
  22330. */
  22331. static SQLITE_WSD struct Mem5Global {
  22332. /*
  22333. ** Memory available for allocation
  22334. */
  22335. int szAtom; /* Smallest possible allocation in bytes */
  22336. int nBlock; /* Number of szAtom sized blocks in zPool */
  22337. u8 *zPool; /* Memory available to be allocated */
  22338. /*
  22339. ** Mutex to control access to the memory allocation subsystem.
  22340. */
  22341. sqlite3_mutex *mutex;
  22342. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22343. /*
  22344. ** Performance statistics
  22345. */
  22346. u64 nAlloc; /* Total number of calls to malloc */
  22347. u64 totalAlloc; /* Total of all malloc calls - includes internal frag */
  22348. u64 totalExcess; /* Total internal fragmentation */
  22349. u32 currentOut; /* Current checkout, including internal fragmentation */
  22350. u32 currentCount; /* Current number of distinct checkouts */
  22351. u32 maxOut; /* Maximum instantaneous currentOut */
  22352. u32 maxCount; /* Maximum instantaneous currentCount */
  22353. u32 maxRequest; /* Largest allocation (exclusive of internal frag) */
  22354. #endif
  22355. /*
  22356. ** Lists of free blocks. aiFreelist[0] is a list of free blocks of
  22357. ** size mem5.szAtom. aiFreelist[1] holds blocks of size szAtom*2.
  22358. ** aiFreelist[2] holds free blocks of size szAtom*4. And so forth.
  22359. */
  22360. int aiFreelist[LOGMAX+1];
  22361. /*
  22362. ** Space for tracking which blocks are checked out and the size
  22363. ** of each block. One byte per block.
  22364. */
  22365. u8 *aCtrl;
  22366. } mem5;
  22367. /*
  22368. ** Access the static variable through a macro for SQLITE_OMIT_WSD.
  22369. */
  22370. #define mem5 GLOBAL(struct Mem5Global, mem5)
  22371. /*
  22372. ** Assuming mem5.zPool is divided up into an array of Mem5Link
  22373. ** structures, return a pointer to the idx-th such link.
  22374. */
  22375. #define MEM5LINK(idx) ((Mem5Link *)(&mem5.zPool[(idx)*mem5.szAtom]))
  22376. /*
  22377. ** Unlink the chunk at mem5.aPool[i] from list it is currently
  22378. ** on. It should be found on mem5.aiFreelist[iLogsize].
  22379. */
  22380. static void memsys5Unlink(int i, int iLogsize){
  22381. int next, prev;
  22382. assert( i>=0 && i<mem5.nBlock );
  22383. assert( iLogsize>=0 && iLogsize<=LOGMAX );
  22384. assert( (mem5.aCtrl[i] & CTRL_LOGSIZE)==iLogsize );
  22385. next = MEM5LINK(i)->next;
  22386. prev = MEM5LINK(i)->prev;
  22387. if( prev<0 ){
  22388. mem5.aiFreelist[iLogsize] = next;
  22389. }else{
  22390. MEM5LINK(prev)->next = next;
  22391. }
  22392. if( next>=0 ){
  22393. MEM5LINK(next)->prev = prev;
  22394. }
  22395. }
  22396. /*
  22397. ** Link the chunk at mem5.aPool[i] so that is on the iLogsize
  22398. ** free list.
  22399. */
  22400. static void memsys5Link(int i, int iLogsize){
  22401. int x;
  22402. assert( sqlite3_mutex_held(mem5.mutex) );
  22403. assert( i>=0 && i<mem5.nBlock );
  22404. assert( iLogsize>=0 && iLogsize<=LOGMAX );
  22405. assert( (mem5.aCtrl[i] & CTRL_LOGSIZE)==iLogsize );
  22406. x = MEM5LINK(i)->next = mem5.aiFreelist[iLogsize];
  22407. MEM5LINK(i)->prev = -1;
  22408. if( x>=0 ){
  22409. assert( x<mem5.nBlock );
  22410. MEM5LINK(x)->prev = i;
  22411. }
  22412. mem5.aiFreelist[iLogsize] = i;
  22413. }
  22414. /*
  22415. ** Obtain or release the mutex needed to access global data structures.
  22416. */
  22417. static void memsys5Enter(void){
  22418. sqlite3_mutex_enter(mem5.mutex);
  22419. }
  22420. static void memsys5Leave(void){
  22421. sqlite3_mutex_leave(mem5.mutex);
  22422. }
  22423. /*
  22424. ** Return the size of an outstanding allocation, in bytes.
  22425. ** This only works for chunks that are currently checked out.
  22426. */
  22427. static int memsys5Size(void *p){
  22428. int iSize, i;
  22429. assert( p!=0 );
  22430. i = (int)(((u8 *)p-mem5.zPool)/mem5.szAtom);
  22431. assert( i>=0 && i<mem5.nBlock );
  22432. iSize = mem5.szAtom * (1 << (mem5.aCtrl[i]&CTRL_LOGSIZE));
  22433. return iSize;
  22434. }
  22435. /*
  22436. ** Return a block of memory of at least nBytes in size.
  22437. ** Return NULL if unable. Return NULL if nBytes==0.
  22438. **
  22439. ** The caller guarantees that nByte is positive.
  22440. **
  22441. ** The caller has obtained a mutex prior to invoking this
  22442. ** routine so there is never any chance that two or more
  22443. ** threads can be in this routine at the same time.
  22444. */
  22445. static void *memsys5MallocUnsafe(int nByte){
  22446. int i; /* Index of a mem5.aPool[] slot */
  22447. int iBin; /* Index into mem5.aiFreelist[] */
  22448. int iFullSz; /* Size of allocation rounded up to power of 2 */
  22449. int iLogsize; /* Log2 of iFullSz/POW2_MIN */
  22450. /* nByte must be a positive */
  22451. assert( nByte>0 );
  22452. /* No more than 1GiB per allocation */
  22453. if( nByte > 0x40000000 ) return 0;
  22454. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22455. /* Keep track of the maximum allocation request. Even unfulfilled
  22456. ** requests are counted */
  22457. if( (u32)nByte>mem5.maxRequest ){
  22458. mem5.maxRequest = nByte;
  22459. }
  22460. #endif
  22461. /* Round nByte up to the next valid power of two */
  22462. for(iFullSz=mem5.szAtom,iLogsize=0; iFullSz<nByte; iFullSz*=2,iLogsize++){}
  22463. /* Make sure mem5.aiFreelist[iLogsize] contains at least one free
  22464. ** block. If not, then split a block of the next larger power of
  22465. ** two in order to create a new free block of size iLogsize.
  22466. */
  22467. for(iBin=iLogsize; iBin<=LOGMAX && mem5.aiFreelist[iBin]<0; iBin++){}
  22468. if( iBin>LOGMAX ){
  22469. testcase( sqlite3GlobalConfig.xLog!=0 );
  22470. sqlite3_log(SQLITE_NOMEM, "failed to allocate %u bytes", nByte);
  22471. return 0;
  22472. }
  22473. i = mem5.aiFreelist[iBin];
  22474. memsys5Unlink(i, iBin);
  22475. while( iBin>iLogsize ){
  22476. int newSize;
  22477. iBin--;
  22478. newSize = 1 << iBin;
  22479. mem5.aCtrl[i+newSize] = CTRL_FREE | iBin;
  22480. memsys5Link(i+newSize, iBin);
  22481. }
  22482. mem5.aCtrl[i] = iLogsize;
  22483. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22484. /* Update allocator performance statistics. */
  22485. mem5.nAlloc++;
  22486. mem5.totalAlloc += iFullSz;
  22487. mem5.totalExcess += iFullSz - nByte;
  22488. mem5.currentCount++;
  22489. mem5.currentOut += iFullSz;
  22490. if( mem5.maxCount<mem5.currentCount ) mem5.maxCount = mem5.currentCount;
  22491. if( mem5.maxOut<mem5.currentOut ) mem5.maxOut = mem5.currentOut;
  22492. #endif
  22493. #ifdef SQLITE_DEBUG
  22494. /* Make sure the allocated memory does not assume that it is set to zero
  22495. ** or retains a value from a previous allocation */
  22496. memset(&mem5.zPool[i*mem5.szAtom], 0xAA, iFullSz);
  22497. #endif
  22498. /* Return a pointer to the allocated memory. */
  22499. return (void*)&mem5.zPool[i*mem5.szAtom];
  22500. }
  22501. /*
  22502. ** Free an outstanding memory allocation.
  22503. */
  22504. static void memsys5FreeUnsafe(void *pOld){
  22505. u32 size, iLogsize;
  22506. int iBlock;
  22507. /* Set iBlock to the index of the block pointed to by pOld in
  22508. ** the array of mem5.szAtom byte blocks pointed to by mem5.zPool.
  22509. */
  22510. iBlock = (int)(((u8 *)pOld-mem5.zPool)/mem5.szAtom);
  22511. /* Check that the pointer pOld points to a valid, non-free block. */
  22512. assert( iBlock>=0 && iBlock<mem5.nBlock );
  22513. assert( ((u8 *)pOld-mem5.zPool)%mem5.szAtom==0 );
  22514. assert( (mem5.aCtrl[iBlock] & CTRL_FREE)==0 );
  22515. iLogsize = mem5.aCtrl[iBlock] & CTRL_LOGSIZE;
  22516. size = 1<<iLogsize;
  22517. assert( iBlock+size-1<(u32)mem5.nBlock );
  22518. mem5.aCtrl[iBlock] |= CTRL_FREE;
  22519. mem5.aCtrl[iBlock+size-1] |= CTRL_FREE;
  22520. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  22521. assert( mem5.currentCount>0 );
  22522. assert( mem5.currentOut>=(size*mem5.szAtom) );
  22523. mem5.currentCount--;
  22524. mem5.currentOut -= size*mem5.szAtom;
  22525. assert( mem5.currentOut>0 || mem5.currentCount==0 );
  22526. assert( mem5.currentCount>0 || mem5.currentOut==0 );
  22527. #endif
  22528. mem5.aCtrl[iBlock] = CTRL_FREE | iLogsize;
  22529. while( ALWAYS(iLogsize<LOGMAX) ){
  22530. int iBuddy;
  22531. if( (iBlock>>iLogsize) & 1 ){
  22532. iBuddy = iBlock - size;
  22533. assert( iBuddy>=0 );
  22534. }else{
  22535. iBuddy = iBlock + size;
  22536. if( iBuddy>=mem5.nBlock ) break;
  22537. }
  22538. if( mem5.aCtrl[iBuddy]!=(CTRL_FREE | iLogsize) ) break;
  22539. memsys5Unlink(iBuddy, iLogsize);
  22540. iLogsize++;
  22541. if( iBuddy<iBlock ){
  22542. mem5.aCtrl[iBuddy] = CTRL_FREE | iLogsize;
  22543. mem5.aCtrl[iBlock] = 0;
  22544. iBlock = iBuddy;
  22545. }else{
  22546. mem5.aCtrl[iBlock] = CTRL_FREE | iLogsize;
  22547. mem5.aCtrl[iBuddy] = 0;
  22548. }
  22549. size *= 2;
  22550. }
  22551. #ifdef SQLITE_DEBUG
  22552. /* Overwrite freed memory with the 0x55 bit pattern to verify that it is
  22553. ** not used after being freed */
  22554. memset(&mem5.zPool[iBlock*mem5.szAtom], 0x55, size);
  22555. #endif
  22556. memsys5Link(iBlock, iLogsize);
  22557. }
  22558. /*
  22559. ** Allocate nBytes of memory.
  22560. */
  22561. static void *memsys5Malloc(int nBytes){
  22562. sqlite3_int64 *p = 0;
  22563. if( nBytes>0 ){
  22564. memsys5Enter();
  22565. p = memsys5MallocUnsafe(nBytes);
  22566. memsys5Leave();
  22567. }
  22568. return (void*)p;
  22569. }
  22570. /*
  22571. ** Free memory.
  22572. **
  22573. ** The outer layer memory allocator prevents this routine from
  22574. ** being called with pPrior==0.
  22575. */
  22576. static void memsys5Free(void *pPrior){
  22577. assert( pPrior!=0 );
  22578. memsys5Enter();
  22579. memsys5FreeUnsafe(pPrior);
  22580. memsys5Leave();
  22581. }
  22582. /*
  22583. ** Change the size of an existing memory allocation.
  22584. **
  22585. ** The outer layer memory allocator prevents this routine from
  22586. ** being called with pPrior==0.
  22587. **
  22588. ** nBytes is always a value obtained from a prior call to
  22589. ** memsys5Round(). Hence nBytes is always a non-negative power
  22590. ** of two. If nBytes==0 that means that an oversize allocation
  22591. ** (an allocation larger than 0x40000000) was requested and this
  22592. ** routine should return 0 without freeing pPrior.
  22593. */
  22594. static void *memsys5Realloc(void *pPrior, int nBytes){
  22595. int nOld;
  22596. void *p;
  22597. assert( pPrior!=0 );
  22598. assert( (nBytes&(nBytes-1))==0 ); /* EV: R-46199-30249 */
  22599. assert( nBytes>=0 );
  22600. if( nBytes==0 ){
  22601. return 0;
  22602. }
  22603. nOld = memsys5Size(pPrior);
  22604. if( nBytes<=nOld ){
  22605. return pPrior;
  22606. }
  22607. p = memsys5Malloc(nBytes);
  22608. if( p ){
  22609. memcpy(p, pPrior, nOld);
  22610. memsys5Free(pPrior);
  22611. }
  22612. return p;
  22613. }
  22614. /*
  22615. ** Round up a request size to the next valid allocation size. If
  22616. ** the allocation is too large to be handled by this allocation system,
  22617. ** return 0.
  22618. **
  22619. ** All allocations must be a power of two and must be expressed by a
  22620. ** 32-bit signed integer. Hence the largest allocation is 0x40000000
  22621. ** or 1073741824 bytes.
  22622. */
  22623. static int memsys5Roundup(int n){
  22624. int iFullSz;
  22625. if( n > 0x40000000 ) return 0;
  22626. for(iFullSz=mem5.szAtom; iFullSz<n; iFullSz *= 2);
  22627. return iFullSz;
  22628. }
  22629. /*
  22630. ** Return the ceiling of the logarithm base 2 of iValue.
  22631. **
  22632. ** Examples: memsys5Log(1) -> 0
  22633. ** memsys5Log(2) -> 1
  22634. ** memsys5Log(4) -> 2
  22635. ** memsys5Log(5) -> 3
  22636. ** memsys5Log(8) -> 3
  22637. ** memsys5Log(9) -> 4
  22638. */
  22639. static int memsys5Log(int iValue){
  22640. int iLog;
  22641. for(iLog=0; (iLog<(int)((sizeof(int)*8)-1)) && (1<<iLog)<iValue; iLog++);
  22642. return iLog;
  22643. }
  22644. /*
  22645. ** Initialize the memory allocator.
  22646. **
  22647. ** This routine is not threadsafe. The caller must be holding a mutex
  22648. ** to prevent multiple threads from entering at the same time.
  22649. */
  22650. static int memsys5Init(void *NotUsed){
  22651. int ii; /* Loop counter */
  22652. int nByte; /* Number of bytes of memory available to this allocator */
  22653. u8 *zByte; /* Memory usable by this allocator */
  22654. int nMinLog; /* Log base 2 of minimum allocation size in bytes */
  22655. int iOffset; /* An offset into mem5.aCtrl[] */
  22656. UNUSED_PARAMETER(NotUsed);
  22657. /* For the purposes of this routine, disable the mutex */
  22658. mem5.mutex = 0;
  22659. /* The size of a Mem5Link object must be a power of two. Verify that
  22660. ** this is case.
  22661. */
  22662. assert( (sizeof(Mem5Link)&(sizeof(Mem5Link)-1))==0 );
  22663. nByte = sqlite3GlobalConfig.nHeap;
  22664. zByte = (u8*)sqlite3GlobalConfig.pHeap;
  22665. assert( zByte!=0 ); /* sqlite3_config() does not allow otherwise */
  22666. /* boundaries on sqlite3GlobalConfig.mnReq are enforced in sqlite3_config() */
  22667. nMinLog = memsys5Log(sqlite3GlobalConfig.mnReq);
  22668. mem5.szAtom = (1<<nMinLog);
  22669. while( (int)sizeof(Mem5Link)>mem5.szAtom ){
  22670. mem5.szAtom = mem5.szAtom << 1;
  22671. }
  22672. mem5.nBlock = (nByte / (mem5.szAtom+sizeof(u8)));
  22673. mem5.zPool = zByte;
  22674. mem5.aCtrl = (u8 *)&mem5.zPool[mem5.nBlock*mem5.szAtom];
  22675. for(ii=0; ii<=LOGMAX; ii++){
  22676. mem5.aiFreelist[ii] = -1;
  22677. }
  22678. iOffset = 0;
  22679. for(ii=LOGMAX; ii>=0; ii--){
  22680. int nAlloc = (1<<ii);
  22681. if( (iOffset+nAlloc)<=mem5.nBlock ){
  22682. mem5.aCtrl[iOffset] = ii | CTRL_FREE;
  22683. memsys5Link(iOffset, ii);
  22684. iOffset += nAlloc;
  22685. }
  22686. assert((iOffset+nAlloc)>mem5.nBlock);
  22687. }
  22688. /* If a mutex is required for normal operation, allocate one */
  22689. if( sqlite3GlobalConfig.bMemstat==0 ){
  22690. mem5.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  22691. }
  22692. return SQLITE_OK;
  22693. }
  22694. /*
  22695. ** Deinitialize this module.
  22696. */
  22697. static void memsys5Shutdown(void *NotUsed){
  22698. UNUSED_PARAMETER(NotUsed);
  22699. mem5.mutex = 0;
  22700. return;
  22701. }
  22702. #ifdef SQLITE_TEST
  22703. /*
  22704. ** Open the file indicated and write a log of all unfreed memory
  22705. ** allocations into that log.
  22706. */
  22707. SQLITE_PRIVATE void sqlite3Memsys5Dump(const char *zFilename){
  22708. FILE *out;
  22709. int i, j, n;
  22710. int nMinLog;
  22711. if( zFilename==0 || zFilename[0]==0 ){
  22712. out = stdout;
  22713. }else{
  22714. out = fopen(zFilename, "w");
  22715. if( out==0 ){
  22716. fprintf(stderr, "** Unable to output memory debug output log: %s **\n",
  22717. zFilename);
  22718. return;
  22719. }
  22720. }
  22721. memsys5Enter();
  22722. nMinLog = memsys5Log(mem5.szAtom);
  22723. for(i=0; i<=LOGMAX && i+nMinLog<32; i++){
  22724. for(n=0, j=mem5.aiFreelist[i]; j>=0; j = MEM5LINK(j)->next, n++){}
  22725. fprintf(out, "freelist items of size %d: %d\n", mem5.szAtom << i, n);
  22726. }
  22727. fprintf(out, "mem5.nAlloc = %llu\n", mem5.nAlloc);
  22728. fprintf(out, "mem5.totalAlloc = %llu\n", mem5.totalAlloc);
  22729. fprintf(out, "mem5.totalExcess = %llu\n", mem5.totalExcess);
  22730. fprintf(out, "mem5.currentOut = %u\n", mem5.currentOut);
  22731. fprintf(out, "mem5.currentCount = %u\n", mem5.currentCount);
  22732. fprintf(out, "mem5.maxOut = %u\n", mem5.maxOut);
  22733. fprintf(out, "mem5.maxCount = %u\n", mem5.maxCount);
  22734. fprintf(out, "mem5.maxRequest = %u\n", mem5.maxRequest);
  22735. memsys5Leave();
  22736. if( out==stdout ){
  22737. fflush(stdout);
  22738. }else{
  22739. fclose(out);
  22740. }
  22741. }
  22742. #endif
  22743. /*
  22744. ** This routine is the only routine in this file with external
  22745. ** linkage. It returns a pointer to a static sqlite3_mem_methods
  22746. ** struct populated with the memsys5 methods.
  22747. */
  22748. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetMemsys5(void){
  22749. static const sqlite3_mem_methods memsys5Methods = {
  22750. memsys5Malloc,
  22751. memsys5Free,
  22752. memsys5Realloc,
  22753. memsys5Size,
  22754. memsys5Roundup,
  22755. memsys5Init,
  22756. memsys5Shutdown,
  22757. 0
  22758. };
  22759. return &memsys5Methods;
  22760. }
  22761. #endif /* SQLITE_ENABLE_MEMSYS5 */
  22762. /************** End of mem5.c ************************************************/
  22763. /************** Begin file mutex.c *******************************************/
  22764. /*
  22765. ** 2007 August 14
  22766. **
  22767. ** The author disclaims copyright to this source code. In place of
  22768. ** a legal notice, here is a blessing:
  22769. **
  22770. ** May you do good and not evil.
  22771. ** May you find forgiveness for yourself and forgive others.
  22772. ** May you share freely, never taking more than you give.
  22773. **
  22774. *************************************************************************
  22775. ** This file contains the C functions that implement mutexes.
  22776. **
  22777. ** This file contains code that is common across all mutex implementations.
  22778. */
  22779. /* #include "sqliteInt.h" */
  22780. #if defined(SQLITE_DEBUG) && !defined(SQLITE_MUTEX_OMIT)
  22781. /*
  22782. ** For debugging purposes, record when the mutex subsystem is initialized
  22783. ** and uninitialized so that we can assert() if there is an attempt to
  22784. ** allocate a mutex while the system is uninitialized.
  22785. */
  22786. static SQLITE_WSD int mutexIsInit = 0;
  22787. #endif /* SQLITE_DEBUG && !defined(SQLITE_MUTEX_OMIT) */
  22788. #ifndef SQLITE_MUTEX_OMIT
  22789. #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
  22790. /*
  22791. ** This block (enclosed by SQLITE_ENABLE_MULTITHREADED_CHECKS) contains
  22792. ** the implementation of a wrapper around the system default mutex
  22793. ** implementation (sqlite3DefaultMutex()).
  22794. **
  22795. ** Most calls are passed directly through to the underlying default
  22796. ** mutex implementation. Except, if a mutex is configured by calling
  22797. ** sqlite3MutexWarnOnContention() on it, then if contention is ever
  22798. ** encountered within xMutexEnter() a warning is emitted via sqlite3_log().
  22799. **
  22800. ** This type of mutex is used as the database handle mutex when testing
  22801. ** apps that usually use SQLITE_CONFIG_MULTITHREAD mode.
  22802. */
  22803. /*
  22804. ** Type for all mutexes used when SQLITE_ENABLE_MULTITHREADED_CHECKS
  22805. ** is defined. Variable CheckMutex.mutex is a pointer to the real mutex
  22806. ** allocated by the system mutex implementation. Variable iType is usually set
  22807. ** to the type of mutex requested - SQLITE_MUTEX_RECURSIVE, SQLITE_MUTEX_FAST
  22808. ** or one of the static mutex identifiers. Or, if this is a recursive mutex
  22809. ** that has been configured using sqlite3MutexWarnOnContention(), it is
  22810. ** set to SQLITE_MUTEX_WARNONCONTENTION.
  22811. */
  22812. typedef struct CheckMutex CheckMutex;
  22813. struct CheckMutex {
  22814. int iType;
  22815. sqlite3_mutex *mutex;
  22816. };
  22817. #define SQLITE_MUTEX_WARNONCONTENTION (-1)
  22818. /*
  22819. ** Pointer to real mutex methods object used by the CheckMutex
  22820. ** implementation. Set by checkMutexInit().
  22821. */
  22822. static SQLITE_WSD const sqlite3_mutex_methods *pGlobalMutexMethods;
  22823. #ifdef SQLITE_DEBUG
  22824. static int checkMutexHeld(sqlite3_mutex *p){
  22825. return pGlobalMutexMethods->xMutexHeld(((CheckMutex*)p)->mutex);
  22826. }
  22827. static int checkMutexNotheld(sqlite3_mutex *p){
  22828. return pGlobalMutexMethods->xMutexNotheld(((CheckMutex*)p)->mutex);
  22829. }
  22830. #endif
  22831. /*
  22832. ** Initialize and deinitialize the mutex subsystem.
  22833. */
  22834. static int checkMutexInit(void){
  22835. pGlobalMutexMethods = sqlite3DefaultMutex();
  22836. return SQLITE_OK;
  22837. }
  22838. static int checkMutexEnd(void){
  22839. pGlobalMutexMethods = 0;
  22840. return SQLITE_OK;
  22841. }
  22842. /*
  22843. ** Allocate a mutex.
  22844. */
  22845. static sqlite3_mutex *checkMutexAlloc(int iType){
  22846. static CheckMutex staticMutexes[] = {
  22847. {2, 0}, {3, 0}, {4, 0}, {5, 0},
  22848. {6, 0}, {7, 0}, {8, 0}, {9, 0},
  22849. {10, 0}, {11, 0}, {12, 0}, {13, 0}
  22850. };
  22851. CheckMutex *p = 0;
  22852. assert( SQLITE_MUTEX_RECURSIVE==1 && SQLITE_MUTEX_FAST==0 );
  22853. if( iType<2 ){
  22854. p = sqlite3MallocZero(sizeof(CheckMutex));
  22855. if( p==0 ) return 0;
  22856. p->iType = iType;
  22857. }else{
  22858. #ifdef SQLITE_ENABLE_API_ARMOR
  22859. if( iType-2>=ArraySize(staticMutexes) ){
  22860. (void)SQLITE_MISUSE_BKPT;
  22861. return 0;
  22862. }
  22863. #endif
  22864. p = &staticMutexes[iType-2];
  22865. }
  22866. if( p->mutex==0 ){
  22867. p->mutex = pGlobalMutexMethods->xMutexAlloc(iType);
  22868. if( p->mutex==0 ){
  22869. if( iType<2 ){
  22870. sqlite3_free(p);
  22871. }
  22872. p = 0;
  22873. }
  22874. }
  22875. return (sqlite3_mutex*)p;
  22876. }
  22877. /*
  22878. ** Free a mutex.
  22879. */
  22880. static void checkMutexFree(sqlite3_mutex *p){
  22881. assert( SQLITE_MUTEX_RECURSIVE<2 );
  22882. assert( SQLITE_MUTEX_FAST<2 );
  22883. assert( SQLITE_MUTEX_WARNONCONTENTION<2 );
  22884. #if SQLITE_ENABLE_API_ARMOR
  22885. if( ((CheckMutex*)p)->iType<2 )
  22886. #endif
  22887. {
  22888. CheckMutex *pCheck = (CheckMutex*)p;
  22889. pGlobalMutexMethods->xMutexFree(pCheck->mutex);
  22890. sqlite3_free(pCheck);
  22891. }
  22892. #ifdef SQLITE_ENABLE_API_ARMOR
  22893. else{
  22894. (void)SQLITE_MISUSE_BKPT;
  22895. }
  22896. #endif
  22897. }
  22898. /*
  22899. ** Enter the mutex.
  22900. */
  22901. static void checkMutexEnter(sqlite3_mutex *p){
  22902. CheckMutex *pCheck = (CheckMutex*)p;
  22903. if( pCheck->iType==SQLITE_MUTEX_WARNONCONTENTION ){
  22904. if( SQLITE_OK==pGlobalMutexMethods->xMutexTry(pCheck->mutex) ){
  22905. return;
  22906. }
  22907. sqlite3_log(SQLITE_MISUSE,
  22908. "illegal multi-threaded access to database connection"
  22909. );
  22910. }
  22911. pGlobalMutexMethods->xMutexEnter(pCheck->mutex);
  22912. }
  22913. /*
  22914. ** Enter the mutex (do not block).
  22915. */
  22916. static int checkMutexTry(sqlite3_mutex *p){
  22917. CheckMutex *pCheck = (CheckMutex*)p;
  22918. return pGlobalMutexMethods->xMutexTry(pCheck->mutex);
  22919. }
  22920. /*
  22921. ** Leave the mutex.
  22922. */
  22923. static void checkMutexLeave(sqlite3_mutex *p){
  22924. CheckMutex *pCheck = (CheckMutex*)p;
  22925. pGlobalMutexMethods->xMutexLeave(pCheck->mutex);
  22926. }
  22927. sqlite3_mutex_methods const *multiThreadedCheckMutex(void){
  22928. static const sqlite3_mutex_methods sMutex = {
  22929. checkMutexInit,
  22930. checkMutexEnd,
  22931. checkMutexAlloc,
  22932. checkMutexFree,
  22933. checkMutexEnter,
  22934. checkMutexTry,
  22935. checkMutexLeave,
  22936. #ifdef SQLITE_DEBUG
  22937. checkMutexHeld,
  22938. checkMutexNotheld
  22939. #else
  22940. 0,
  22941. 0
  22942. #endif
  22943. };
  22944. return &sMutex;
  22945. }
  22946. /*
  22947. ** Mark the SQLITE_MUTEX_RECURSIVE mutex passed as the only argument as
  22948. ** one on which there should be no contention.
  22949. */
  22950. SQLITE_PRIVATE void sqlite3MutexWarnOnContention(sqlite3_mutex *p){
  22951. if( sqlite3GlobalConfig.mutex.xMutexAlloc==checkMutexAlloc ){
  22952. CheckMutex *pCheck = (CheckMutex*)p;
  22953. assert( pCheck->iType==SQLITE_MUTEX_RECURSIVE );
  22954. pCheck->iType = SQLITE_MUTEX_WARNONCONTENTION;
  22955. }
  22956. }
  22957. #endif /* ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS */
  22958. /*
  22959. ** Initialize the mutex system.
  22960. */
  22961. SQLITE_PRIVATE int sqlite3MutexInit(void){
  22962. int rc = SQLITE_OK;
  22963. if( !sqlite3GlobalConfig.mutex.xMutexAlloc ){
  22964. /* If the xMutexAlloc method has not been set, then the user did not
  22965. ** install a mutex implementation via sqlite3_config() prior to
  22966. ** sqlite3_initialize() being called. This block copies pointers to
  22967. ** the default implementation into the sqlite3GlobalConfig structure.
  22968. */
  22969. sqlite3_mutex_methods const *pFrom;
  22970. sqlite3_mutex_methods *pTo = &sqlite3GlobalConfig.mutex;
  22971. if( sqlite3GlobalConfig.bCoreMutex ){
  22972. #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
  22973. pFrom = multiThreadedCheckMutex();
  22974. #else
  22975. pFrom = sqlite3DefaultMutex();
  22976. #endif
  22977. }else{
  22978. pFrom = sqlite3NoopMutex();
  22979. }
  22980. pTo->xMutexInit = pFrom->xMutexInit;
  22981. pTo->xMutexEnd = pFrom->xMutexEnd;
  22982. pTo->xMutexFree = pFrom->xMutexFree;
  22983. pTo->xMutexEnter = pFrom->xMutexEnter;
  22984. pTo->xMutexTry = pFrom->xMutexTry;
  22985. pTo->xMutexLeave = pFrom->xMutexLeave;
  22986. pTo->xMutexHeld = pFrom->xMutexHeld;
  22987. pTo->xMutexNotheld = pFrom->xMutexNotheld;
  22988. sqlite3MemoryBarrier();
  22989. pTo->xMutexAlloc = pFrom->xMutexAlloc;
  22990. }
  22991. assert( sqlite3GlobalConfig.mutex.xMutexInit );
  22992. rc = sqlite3GlobalConfig.mutex.xMutexInit();
  22993. #ifdef SQLITE_DEBUG
  22994. GLOBAL(int, mutexIsInit) = 1;
  22995. #endif
  22996. return rc;
  22997. }
  22998. /*
  22999. ** Shutdown the mutex system. This call frees resources allocated by
  23000. ** sqlite3MutexInit().
  23001. */
  23002. SQLITE_PRIVATE int sqlite3MutexEnd(void){
  23003. int rc = SQLITE_OK;
  23004. if( sqlite3GlobalConfig.mutex.xMutexEnd ){
  23005. rc = sqlite3GlobalConfig.mutex.xMutexEnd();
  23006. }
  23007. #ifdef SQLITE_DEBUG
  23008. GLOBAL(int, mutexIsInit) = 0;
  23009. #endif
  23010. return rc;
  23011. }
  23012. /*
  23013. ** Retrieve a pointer to a static mutex or allocate a new dynamic one.
  23014. */
  23015. SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int id){
  23016. #ifndef SQLITE_OMIT_AUTOINIT
  23017. if( id<=SQLITE_MUTEX_RECURSIVE && sqlite3_initialize() ) return 0;
  23018. if( id>SQLITE_MUTEX_RECURSIVE && sqlite3MutexInit() ) return 0;
  23019. #endif
  23020. assert( sqlite3GlobalConfig.mutex.xMutexAlloc );
  23021. return sqlite3GlobalConfig.mutex.xMutexAlloc(id);
  23022. }
  23023. SQLITE_PRIVATE sqlite3_mutex *sqlite3MutexAlloc(int id){
  23024. if( !sqlite3GlobalConfig.bCoreMutex ){
  23025. return 0;
  23026. }
  23027. assert( GLOBAL(int, mutexIsInit) );
  23028. assert( sqlite3GlobalConfig.mutex.xMutexAlloc );
  23029. return sqlite3GlobalConfig.mutex.xMutexAlloc(id);
  23030. }
  23031. /*
  23032. ** Free a dynamic mutex.
  23033. */
  23034. SQLITE_API void sqlite3_mutex_free(sqlite3_mutex *p){
  23035. if( p ){
  23036. assert( sqlite3GlobalConfig.mutex.xMutexFree );
  23037. sqlite3GlobalConfig.mutex.xMutexFree(p);
  23038. }
  23039. }
  23040. /*
  23041. ** Obtain the mutex p. If some other thread already has the mutex, block
  23042. ** until it can be obtained.
  23043. */
  23044. SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex *p){
  23045. if( p ){
  23046. assert( sqlite3GlobalConfig.mutex.xMutexEnter );
  23047. sqlite3GlobalConfig.mutex.xMutexEnter(p);
  23048. }
  23049. }
  23050. /*
  23051. ** Obtain the mutex p. If successful, return SQLITE_OK. Otherwise, if another
  23052. ** thread holds the mutex and it cannot be obtained, return SQLITE_BUSY.
  23053. */
  23054. SQLITE_API int sqlite3_mutex_try(sqlite3_mutex *p){
  23055. int rc = SQLITE_OK;
  23056. if( p ){
  23057. assert( sqlite3GlobalConfig.mutex.xMutexTry );
  23058. return sqlite3GlobalConfig.mutex.xMutexTry(p);
  23059. }
  23060. return rc;
  23061. }
  23062. /*
  23063. ** The sqlite3_mutex_leave() routine exits a mutex that was previously
  23064. ** entered by the same thread. The behavior is undefined if the mutex
  23065. ** is not currently entered. If a NULL pointer is passed as an argument
  23066. ** this function is a no-op.
  23067. */
  23068. SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex *p){
  23069. if( p ){
  23070. assert( sqlite3GlobalConfig.mutex.xMutexLeave );
  23071. sqlite3GlobalConfig.mutex.xMutexLeave(p);
  23072. }
  23073. }
  23074. #ifndef NDEBUG
  23075. /*
  23076. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  23077. ** intended for use inside assert() statements.
  23078. */
  23079. SQLITE_API int sqlite3_mutex_held(sqlite3_mutex *p){
  23080. assert( p==0 || sqlite3GlobalConfig.mutex.xMutexHeld );
  23081. return p==0 || sqlite3GlobalConfig.mutex.xMutexHeld(p);
  23082. }
  23083. SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex *p){
  23084. assert( p==0 || sqlite3GlobalConfig.mutex.xMutexNotheld );
  23085. return p==0 || sqlite3GlobalConfig.mutex.xMutexNotheld(p);
  23086. }
  23087. #endif
  23088. #endif /* !defined(SQLITE_MUTEX_OMIT) */
  23089. /************** End of mutex.c ***********************************************/
  23090. /************** Begin file mutex_noop.c **************************************/
  23091. /*
  23092. ** 2008 October 07
  23093. **
  23094. ** The author disclaims copyright to this source code. In place of
  23095. ** a legal notice, here is a blessing:
  23096. **
  23097. ** May you do good and not evil.
  23098. ** May you find forgiveness for yourself and forgive others.
  23099. ** May you share freely, never taking more than you give.
  23100. **
  23101. *************************************************************************
  23102. ** This file contains the C functions that implement mutexes.
  23103. **
  23104. ** This implementation in this file does not provide any mutual
  23105. ** exclusion and is thus suitable for use only in applications
  23106. ** that use SQLite in a single thread. The routines defined
  23107. ** here are place-holders. Applications can substitute working
  23108. ** mutex routines at start-time using the
  23109. **
  23110. ** sqlite3_config(SQLITE_CONFIG_MUTEX,...)
  23111. **
  23112. ** interface.
  23113. **
  23114. ** If compiled with SQLITE_DEBUG, then additional logic is inserted
  23115. ** that does error checking on mutexes to make sure they are being
  23116. ** called correctly.
  23117. */
  23118. /* #include "sqliteInt.h" */
  23119. #ifndef SQLITE_MUTEX_OMIT
  23120. #ifndef SQLITE_DEBUG
  23121. /*
  23122. ** Stub routines for all mutex methods.
  23123. **
  23124. ** This routines provide no mutual exclusion or error checking.
  23125. */
  23126. static int noopMutexInit(void){ return SQLITE_OK; }
  23127. static int noopMutexEnd(void){ return SQLITE_OK; }
  23128. static sqlite3_mutex *noopMutexAlloc(int id){
  23129. UNUSED_PARAMETER(id);
  23130. return (sqlite3_mutex*)8;
  23131. }
  23132. static void noopMutexFree(sqlite3_mutex *p){ UNUSED_PARAMETER(p); return; }
  23133. static void noopMutexEnter(sqlite3_mutex *p){ UNUSED_PARAMETER(p); return; }
  23134. static int noopMutexTry(sqlite3_mutex *p){
  23135. UNUSED_PARAMETER(p);
  23136. return SQLITE_OK;
  23137. }
  23138. static void noopMutexLeave(sqlite3_mutex *p){ UNUSED_PARAMETER(p); return; }
  23139. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3NoopMutex(void){
  23140. static const sqlite3_mutex_methods sMutex = {
  23141. noopMutexInit,
  23142. noopMutexEnd,
  23143. noopMutexAlloc,
  23144. noopMutexFree,
  23145. noopMutexEnter,
  23146. noopMutexTry,
  23147. noopMutexLeave,
  23148. 0,
  23149. 0,
  23150. };
  23151. return &sMutex;
  23152. }
  23153. #endif /* !SQLITE_DEBUG */
  23154. #ifdef SQLITE_DEBUG
  23155. /*
  23156. ** In this implementation, error checking is provided for testing
  23157. ** and debugging purposes. The mutexes still do not provide any
  23158. ** mutual exclusion.
  23159. */
  23160. /*
  23161. ** The mutex object
  23162. */
  23163. typedef struct sqlite3_debug_mutex {
  23164. int id; /* The mutex type */
  23165. int cnt; /* Number of entries without a matching leave */
  23166. } sqlite3_debug_mutex;
  23167. /*
  23168. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  23169. ** intended for use inside assert() statements.
  23170. */
  23171. static int debugMutexHeld(sqlite3_mutex *pX){
  23172. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  23173. return p==0 || p->cnt>0;
  23174. }
  23175. static int debugMutexNotheld(sqlite3_mutex *pX){
  23176. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  23177. return p==0 || p->cnt==0;
  23178. }
  23179. /*
  23180. ** Initialize and deinitialize the mutex subsystem.
  23181. */
  23182. static int debugMutexInit(void){ return SQLITE_OK; }
  23183. static int debugMutexEnd(void){ return SQLITE_OK; }
  23184. /*
  23185. ** The sqlite3_mutex_alloc() routine allocates a new
  23186. ** mutex and returns a pointer to it. If it returns NULL
  23187. ** that means that a mutex could not be allocated.
  23188. */
  23189. static sqlite3_mutex *debugMutexAlloc(int id){
  23190. static sqlite3_debug_mutex aStatic[SQLITE_MUTEX_STATIC_VFS3 - 1];
  23191. sqlite3_debug_mutex *pNew = 0;
  23192. switch( id ){
  23193. case SQLITE_MUTEX_FAST:
  23194. case SQLITE_MUTEX_RECURSIVE: {
  23195. pNew = sqlite3Malloc(sizeof(*pNew));
  23196. if( pNew ){
  23197. pNew->id = id;
  23198. pNew->cnt = 0;
  23199. }
  23200. break;
  23201. }
  23202. default: {
  23203. #ifdef SQLITE_ENABLE_API_ARMOR
  23204. if( id-2<0 || id-2>=ArraySize(aStatic) ){
  23205. (void)SQLITE_MISUSE_BKPT;
  23206. return 0;
  23207. }
  23208. #endif
  23209. pNew = &aStatic[id-2];
  23210. pNew->id = id;
  23211. break;
  23212. }
  23213. }
  23214. return (sqlite3_mutex*)pNew;
  23215. }
  23216. /*
  23217. ** This routine deallocates a previously allocated mutex.
  23218. */
  23219. static void debugMutexFree(sqlite3_mutex *pX){
  23220. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  23221. assert( p->cnt==0 );
  23222. if( p->id==SQLITE_MUTEX_RECURSIVE || p->id==SQLITE_MUTEX_FAST ){
  23223. sqlite3_free(p);
  23224. }else{
  23225. #ifdef SQLITE_ENABLE_API_ARMOR
  23226. (void)SQLITE_MISUSE_BKPT;
  23227. #endif
  23228. }
  23229. }
  23230. /*
  23231. ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  23232. ** to enter a mutex. If another thread is already within the mutex,
  23233. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  23234. ** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
  23235. ** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
  23236. ** be entered multiple times by the same thread. In such cases the,
  23237. ** mutex must be exited an equal number of times before another thread
  23238. ** can enter. If the same thread tries to enter any other kind of mutex
  23239. ** more than once, the behavior is undefined.
  23240. */
  23241. static void debugMutexEnter(sqlite3_mutex *pX){
  23242. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  23243. assert( p->id==SQLITE_MUTEX_RECURSIVE || debugMutexNotheld(pX) );
  23244. p->cnt++;
  23245. }
  23246. static int debugMutexTry(sqlite3_mutex *pX){
  23247. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  23248. assert( p->id==SQLITE_MUTEX_RECURSIVE || debugMutexNotheld(pX) );
  23249. p->cnt++;
  23250. return SQLITE_OK;
  23251. }
  23252. /*
  23253. ** The sqlite3_mutex_leave() routine exits a mutex that was
  23254. ** previously entered by the same thread. The behavior
  23255. ** is undefined if the mutex is not currently entered or
  23256. ** is not currently allocated. SQLite will never do either.
  23257. */
  23258. static void debugMutexLeave(sqlite3_mutex *pX){
  23259. sqlite3_debug_mutex *p = (sqlite3_debug_mutex*)pX;
  23260. assert( debugMutexHeld(pX) );
  23261. p->cnt--;
  23262. assert( p->id==SQLITE_MUTEX_RECURSIVE || debugMutexNotheld(pX) );
  23263. }
  23264. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3NoopMutex(void){
  23265. static const sqlite3_mutex_methods sMutex = {
  23266. debugMutexInit,
  23267. debugMutexEnd,
  23268. debugMutexAlloc,
  23269. debugMutexFree,
  23270. debugMutexEnter,
  23271. debugMutexTry,
  23272. debugMutexLeave,
  23273. debugMutexHeld,
  23274. debugMutexNotheld
  23275. };
  23276. return &sMutex;
  23277. }
  23278. #endif /* SQLITE_DEBUG */
  23279. /*
  23280. ** If compiled with SQLITE_MUTEX_NOOP, then the no-op mutex implementation
  23281. ** is used regardless of the run-time threadsafety setting.
  23282. */
  23283. #ifdef SQLITE_MUTEX_NOOP
  23284. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void){
  23285. return sqlite3NoopMutex();
  23286. }
  23287. #endif /* defined(SQLITE_MUTEX_NOOP) */
  23288. #endif /* !defined(SQLITE_MUTEX_OMIT) */
  23289. /************** End of mutex_noop.c ******************************************/
  23290. /************** Begin file mutex_unix.c **************************************/
  23291. /*
  23292. ** 2007 August 28
  23293. **
  23294. ** The author disclaims copyright to this source code. In place of
  23295. ** a legal notice, here is a blessing:
  23296. **
  23297. ** May you do good and not evil.
  23298. ** May you find forgiveness for yourself and forgive others.
  23299. ** May you share freely, never taking more than you give.
  23300. **
  23301. *************************************************************************
  23302. ** This file contains the C functions that implement mutexes for pthreads
  23303. */
  23304. /* #include "sqliteInt.h" */
  23305. /*
  23306. ** The code in this file is only used if we are compiling threadsafe
  23307. ** under unix with pthreads.
  23308. **
  23309. ** Note that this implementation requires a version of pthreads that
  23310. ** supports recursive mutexes.
  23311. */
  23312. #ifdef SQLITE_MUTEX_PTHREADS
  23313. #include <pthread.h>
  23314. /*
  23315. ** The sqlite3_mutex.id, sqlite3_mutex.nRef, and sqlite3_mutex.owner fields
  23316. ** are necessary under two condidtions: (1) Debug builds and (2) using
  23317. ** home-grown mutexes. Encapsulate these conditions into a single #define.
  23318. */
  23319. #if defined(SQLITE_DEBUG) || defined(SQLITE_HOMEGROWN_RECURSIVE_MUTEX)
  23320. # define SQLITE_MUTEX_NREF 1
  23321. #else
  23322. # define SQLITE_MUTEX_NREF 0
  23323. #endif
  23324. /*
  23325. ** Each recursive mutex is an instance of the following structure.
  23326. */
  23327. struct sqlite3_mutex {
  23328. pthread_mutex_t mutex; /* Mutex controlling the lock */
  23329. #if SQLITE_MUTEX_NREF || defined(SQLITE_ENABLE_API_ARMOR)
  23330. int id; /* Mutex type */
  23331. #endif
  23332. #if SQLITE_MUTEX_NREF
  23333. volatile int nRef; /* Number of entrances */
  23334. volatile pthread_t owner; /* Thread that is within this mutex */
  23335. int trace; /* True to trace changes */
  23336. #endif
  23337. };
  23338. #if SQLITE_MUTEX_NREF
  23339. # define SQLITE3_MUTEX_INITIALIZER(id) \
  23340. {PTHREAD_MUTEX_INITIALIZER,id,0,(pthread_t)0,0}
  23341. #elif defined(SQLITE_ENABLE_API_ARMOR)
  23342. # define SQLITE3_MUTEX_INITIALIZER(id) { PTHREAD_MUTEX_INITIALIZER, id }
  23343. #else
  23344. #define SQLITE3_MUTEX_INITIALIZER(id) { PTHREAD_MUTEX_INITIALIZER }
  23345. #endif
  23346. /*
  23347. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  23348. ** intended for use only inside assert() statements. On some platforms,
  23349. ** there might be race conditions that can cause these routines to
  23350. ** deliver incorrect results. In particular, if pthread_equal() is
  23351. ** not an atomic operation, then these routines might delivery
  23352. ** incorrect results. On most platforms, pthread_equal() is a
  23353. ** comparison of two integers and is therefore atomic. But we are
  23354. ** told that HPUX is not such a platform. If so, then these routines
  23355. ** will not always work correctly on HPUX.
  23356. **
  23357. ** On those platforms where pthread_equal() is not atomic, SQLite
  23358. ** should be compiled without -DSQLITE_DEBUG and with -DNDEBUG to
  23359. ** make sure no assert() statements are evaluated and hence these
  23360. ** routines are never called.
  23361. */
  23362. #if !defined(NDEBUG) || defined(SQLITE_DEBUG)
  23363. static int pthreadMutexHeld(sqlite3_mutex *p){
  23364. return (p->nRef!=0 && pthread_equal(p->owner, pthread_self()));
  23365. }
  23366. static int pthreadMutexNotheld(sqlite3_mutex *p){
  23367. return p->nRef==0 || pthread_equal(p->owner, pthread_self())==0;
  23368. }
  23369. #endif
  23370. /*
  23371. ** Try to provide a memory barrier operation, needed for initialization
  23372. ** and also for the implementation of xShmBarrier in the VFS in cases
  23373. ** where SQLite is compiled without mutexes.
  23374. */
  23375. SQLITE_PRIVATE void sqlite3MemoryBarrier(void){
  23376. #if defined(SQLITE_MEMORY_BARRIER)
  23377. SQLITE_MEMORY_BARRIER;
  23378. #elif defined(__GNUC__) && GCC_VERSION>=4001000
  23379. __sync_synchronize();
  23380. #endif
  23381. }
  23382. /*
  23383. ** Initialize and deinitialize the mutex subsystem.
  23384. */
  23385. static int pthreadMutexInit(void){ return SQLITE_OK; }
  23386. static int pthreadMutexEnd(void){ return SQLITE_OK; }
  23387. /*
  23388. ** The sqlite3_mutex_alloc() routine allocates a new
  23389. ** mutex and returns a pointer to it. If it returns NULL
  23390. ** that means that a mutex could not be allocated. SQLite
  23391. ** will unwind its stack and return an error. The argument
  23392. ** to sqlite3_mutex_alloc() is one of these integer constants:
  23393. **
  23394. ** <ul>
  23395. ** <li> SQLITE_MUTEX_FAST
  23396. ** <li> SQLITE_MUTEX_RECURSIVE
  23397. ** <li> SQLITE_MUTEX_STATIC_MASTER
  23398. ** <li> SQLITE_MUTEX_STATIC_MEM
  23399. ** <li> SQLITE_MUTEX_STATIC_OPEN
  23400. ** <li> SQLITE_MUTEX_STATIC_PRNG
  23401. ** <li> SQLITE_MUTEX_STATIC_LRU
  23402. ** <li> SQLITE_MUTEX_STATIC_PMEM
  23403. ** <li> SQLITE_MUTEX_STATIC_APP1
  23404. ** <li> SQLITE_MUTEX_STATIC_APP2
  23405. ** <li> SQLITE_MUTEX_STATIC_APP3
  23406. ** <li> SQLITE_MUTEX_STATIC_VFS1
  23407. ** <li> SQLITE_MUTEX_STATIC_VFS2
  23408. ** <li> SQLITE_MUTEX_STATIC_VFS3
  23409. ** </ul>
  23410. **
  23411. ** The first two constants cause sqlite3_mutex_alloc() to create
  23412. ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
  23413. ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
  23414. ** The mutex implementation does not need to make a distinction
  23415. ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
  23416. ** not want to. But SQLite will only request a recursive mutex in
  23417. ** cases where it really needs one. If a faster non-recursive mutex
  23418. ** implementation is available on the host platform, the mutex subsystem
  23419. ** might return such a mutex in response to SQLITE_MUTEX_FAST.
  23420. **
  23421. ** The other allowed parameters to sqlite3_mutex_alloc() each return
  23422. ** a pointer to a static preexisting mutex. Six static mutexes are
  23423. ** used by the current version of SQLite. Future versions of SQLite
  23424. ** may add additional static mutexes. Static mutexes are for internal
  23425. ** use by SQLite only. Applications that use SQLite mutexes should
  23426. ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
  23427. ** SQLITE_MUTEX_RECURSIVE.
  23428. **
  23429. ** Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
  23430. ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
  23431. ** returns a different mutex on every call. But for the static
  23432. ** mutex types, the same mutex is returned on every call that has
  23433. ** the same type number.
  23434. */
  23435. static sqlite3_mutex *pthreadMutexAlloc(int iType){
  23436. static sqlite3_mutex staticMutexes[] = {
  23437. SQLITE3_MUTEX_INITIALIZER(2),
  23438. SQLITE3_MUTEX_INITIALIZER(3),
  23439. SQLITE3_MUTEX_INITIALIZER(4),
  23440. SQLITE3_MUTEX_INITIALIZER(5),
  23441. SQLITE3_MUTEX_INITIALIZER(6),
  23442. SQLITE3_MUTEX_INITIALIZER(7),
  23443. SQLITE3_MUTEX_INITIALIZER(8),
  23444. SQLITE3_MUTEX_INITIALIZER(9),
  23445. SQLITE3_MUTEX_INITIALIZER(10),
  23446. SQLITE3_MUTEX_INITIALIZER(11),
  23447. SQLITE3_MUTEX_INITIALIZER(12),
  23448. SQLITE3_MUTEX_INITIALIZER(13)
  23449. };
  23450. sqlite3_mutex *p;
  23451. switch( iType ){
  23452. case SQLITE_MUTEX_RECURSIVE: {
  23453. p = sqlite3MallocZero( sizeof(*p) );
  23454. if( p ){
  23455. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  23456. /* If recursive mutexes are not available, we will have to
  23457. ** build our own. See below. */
  23458. pthread_mutex_init(&p->mutex, 0);
  23459. #else
  23460. /* Use a recursive mutex if it is available */
  23461. pthread_mutexattr_t recursiveAttr;
  23462. pthread_mutexattr_init(&recursiveAttr);
  23463. pthread_mutexattr_settype(&recursiveAttr, PTHREAD_MUTEX_RECURSIVE);
  23464. pthread_mutex_init(&p->mutex, &recursiveAttr);
  23465. pthread_mutexattr_destroy(&recursiveAttr);
  23466. #endif
  23467. #if SQLITE_MUTEX_NREF || defined(SQLITE_ENABLE_API_ARMOR)
  23468. p->id = SQLITE_MUTEX_RECURSIVE;
  23469. #endif
  23470. }
  23471. break;
  23472. }
  23473. case SQLITE_MUTEX_FAST: {
  23474. p = sqlite3MallocZero( sizeof(*p) );
  23475. if( p ){
  23476. pthread_mutex_init(&p->mutex, 0);
  23477. #if SQLITE_MUTEX_NREF || defined(SQLITE_ENABLE_API_ARMOR)
  23478. p->id = SQLITE_MUTEX_FAST;
  23479. #endif
  23480. }
  23481. break;
  23482. }
  23483. default: {
  23484. #ifdef SQLITE_ENABLE_API_ARMOR
  23485. if( iType-2<0 || iType-2>=ArraySize(staticMutexes) ){
  23486. (void)SQLITE_MISUSE_BKPT;
  23487. return 0;
  23488. }
  23489. #endif
  23490. p = &staticMutexes[iType-2];
  23491. break;
  23492. }
  23493. }
  23494. #if SQLITE_MUTEX_NREF || defined(SQLITE_ENABLE_API_ARMOR)
  23495. assert( p==0 || p->id==iType );
  23496. #endif
  23497. return p;
  23498. }
  23499. /*
  23500. ** This routine deallocates a previously
  23501. ** allocated mutex. SQLite is careful to deallocate every
  23502. ** mutex that it allocates.
  23503. */
  23504. static void pthreadMutexFree(sqlite3_mutex *p){
  23505. assert( p->nRef==0 );
  23506. #if SQLITE_ENABLE_API_ARMOR
  23507. if( p->id==SQLITE_MUTEX_FAST || p->id==SQLITE_MUTEX_RECURSIVE )
  23508. #endif
  23509. {
  23510. pthread_mutex_destroy(&p->mutex);
  23511. sqlite3_free(p);
  23512. }
  23513. #ifdef SQLITE_ENABLE_API_ARMOR
  23514. else{
  23515. (void)SQLITE_MISUSE_BKPT;
  23516. }
  23517. #endif
  23518. }
  23519. /*
  23520. ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  23521. ** to enter a mutex. If another thread is already within the mutex,
  23522. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  23523. ** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
  23524. ** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
  23525. ** be entered multiple times by the same thread. In such cases the,
  23526. ** mutex must be exited an equal number of times before another thread
  23527. ** can enter. If the same thread tries to enter any other kind of mutex
  23528. ** more than once, the behavior is undefined.
  23529. */
  23530. static void pthreadMutexEnter(sqlite3_mutex *p){
  23531. assert( p->id==SQLITE_MUTEX_RECURSIVE || pthreadMutexNotheld(p) );
  23532. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  23533. /* If recursive mutexes are not available, then we have to grow
  23534. ** our own. This implementation assumes that pthread_equal()
  23535. ** is atomic - that it cannot be deceived into thinking self
  23536. ** and p->owner are equal if p->owner changes between two values
  23537. ** that are not equal to self while the comparison is taking place.
  23538. ** This implementation also assumes a coherent cache - that
  23539. ** separate processes cannot read different values from the same
  23540. ** address at the same time. If either of these two conditions
  23541. ** are not met, then the mutexes will fail and problems will result.
  23542. */
  23543. {
  23544. pthread_t self = pthread_self();
  23545. if( p->nRef>0 && pthread_equal(p->owner, self) ){
  23546. p->nRef++;
  23547. }else{
  23548. pthread_mutex_lock(&p->mutex);
  23549. assert( p->nRef==0 );
  23550. p->owner = self;
  23551. p->nRef = 1;
  23552. }
  23553. }
  23554. #else
  23555. /* Use the built-in recursive mutexes if they are available.
  23556. */
  23557. pthread_mutex_lock(&p->mutex);
  23558. #if SQLITE_MUTEX_NREF
  23559. assert( p->nRef>0 || p->owner==0 );
  23560. p->owner = pthread_self();
  23561. p->nRef++;
  23562. #endif
  23563. #endif
  23564. #ifdef SQLITE_DEBUG
  23565. if( p->trace ){
  23566. printf("enter mutex %p (%d) with nRef=%d\n", p, p->trace, p->nRef);
  23567. }
  23568. #endif
  23569. }
  23570. static int pthreadMutexTry(sqlite3_mutex *p){
  23571. int rc;
  23572. assert( p->id==SQLITE_MUTEX_RECURSIVE || pthreadMutexNotheld(p) );
  23573. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  23574. /* If recursive mutexes are not available, then we have to grow
  23575. ** our own. This implementation assumes that pthread_equal()
  23576. ** is atomic - that it cannot be deceived into thinking self
  23577. ** and p->owner are equal if p->owner changes between two values
  23578. ** that are not equal to self while the comparison is taking place.
  23579. ** This implementation also assumes a coherent cache - that
  23580. ** separate processes cannot read different values from the same
  23581. ** address at the same time. If either of these two conditions
  23582. ** are not met, then the mutexes will fail and problems will result.
  23583. */
  23584. {
  23585. pthread_t self = pthread_self();
  23586. if( p->nRef>0 && pthread_equal(p->owner, self) ){
  23587. p->nRef++;
  23588. rc = SQLITE_OK;
  23589. }else if( pthread_mutex_trylock(&p->mutex)==0 ){
  23590. assert( p->nRef==0 );
  23591. p->owner = self;
  23592. p->nRef = 1;
  23593. rc = SQLITE_OK;
  23594. }else{
  23595. rc = SQLITE_BUSY;
  23596. }
  23597. }
  23598. #else
  23599. /* Use the built-in recursive mutexes if they are available.
  23600. */
  23601. if( pthread_mutex_trylock(&p->mutex)==0 ){
  23602. #if SQLITE_MUTEX_NREF
  23603. p->owner = pthread_self();
  23604. p->nRef++;
  23605. #endif
  23606. rc = SQLITE_OK;
  23607. }else{
  23608. rc = SQLITE_BUSY;
  23609. }
  23610. #endif
  23611. #ifdef SQLITE_DEBUG
  23612. if( rc==SQLITE_OK && p->trace ){
  23613. printf("enter mutex %p (%d) with nRef=%d\n", p, p->trace, p->nRef);
  23614. }
  23615. #endif
  23616. return rc;
  23617. }
  23618. /*
  23619. ** The sqlite3_mutex_leave() routine exits a mutex that was
  23620. ** previously entered by the same thread. The behavior
  23621. ** is undefined if the mutex is not currently entered or
  23622. ** is not currently allocated. SQLite will never do either.
  23623. */
  23624. static void pthreadMutexLeave(sqlite3_mutex *p){
  23625. assert( pthreadMutexHeld(p) );
  23626. #if SQLITE_MUTEX_NREF
  23627. p->nRef--;
  23628. if( p->nRef==0 ) p->owner = 0;
  23629. #endif
  23630. assert( p->nRef==0 || p->id==SQLITE_MUTEX_RECURSIVE );
  23631. #ifdef SQLITE_HOMEGROWN_RECURSIVE_MUTEX
  23632. if( p->nRef==0 ){
  23633. pthread_mutex_unlock(&p->mutex);
  23634. }
  23635. #else
  23636. pthread_mutex_unlock(&p->mutex);
  23637. #endif
  23638. #ifdef SQLITE_DEBUG
  23639. if( p->trace ){
  23640. printf("leave mutex %p (%d) with nRef=%d\n", p, p->trace, p->nRef);
  23641. }
  23642. #endif
  23643. }
  23644. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void){
  23645. static const sqlite3_mutex_methods sMutex = {
  23646. pthreadMutexInit,
  23647. pthreadMutexEnd,
  23648. pthreadMutexAlloc,
  23649. pthreadMutexFree,
  23650. pthreadMutexEnter,
  23651. pthreadMutexTry,
  23652. pthreadMutexLeave,
  23653. #ifdef SQLITE_DEBUG
  23654. pthreadMutexHeld,
  23655. pthreadMutexNotheld
  23656. #else
  23657. 0,
  23658. 0
  23659. #endif
  23660. };
  23661. return &sMutex;
  23662. }
  23663. #endif /* SQLITE_MUTEX_PTHREADS */
  23664. /************** End of mutex_unix.c ******************************************/
  23665. /************** Begin file mutex_w32.c ***************************************/
  23666. /*
  23667. ** 2007 August 14
  23668. **
  23669. ** The author disclaims copyright to this source code. In place of
  23670. ** a legal notice, here is a blessing:
  23671. **
  23672. ** May you do good and not evil.
  23673. ** May you find forgiveness for yourself and forgive others.
  23674. ** May you share freely, never taking more than you give.
  23675. **
  23676. *************************************************************************
  23677. ** This file contains the C functions that implement mutexes for Win32.
  23678. */
  23679. /* #include "sqliteInt.h" */
  23680. #if SQLITE_OS_WIN
  23681. /*
  23682. ** Include code that is common to all os_*.c files
  23683. */
  23684. /************** Include os_common.h in the middle of mutex_w32.c *************/
  23685. /************** Begin file os_common.h ***************************************/
  23686. /*
  23687. ** 2004 May 22
  23688. **
  23689. ** The author disclaims copyright to this source code. In place of
  23690. ** a legal notice, here is a blessing:
  23691. **
  23692. ** May you do good and not evil.
  23693. ** May you find forgiveness for yourself and forgive others.
  23694. ** May you share freely, never taking more than you give.
  23695. **
  23696. ******************************************************************************
  23697. **
  23698. ** This file contains macros and a little bit of code that is common to
  23699. ** all of the platform-specific files (os_*.c) and is #included into those
  23700. ** files.
  23701. **
  23702. ** This file should be #included by the os_*.c files only. It is not a
  23703. ** general purpose header file.
  23704. */
  23705. #ifndef _OS_COMMON_H_
  23706. #define _OS_COMMON_H_
  23707. /*
  23708. ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
  23709. ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
  23710. ** switch. The following code should catch this problem at compile-time.
  23711. */
  23712. #ifdef MEMORY_DEBUG
  23713. # error "The MEMORY_DEBUG macro is obsolete. Use SQLITE_DEBUG instead."
  23714. #endif
  23715. /*
  23716. ** Macros for performance tracing. Normally turned off. Only works
  23717. ** on i486 hardware.
  23718. */
  23719. #ifdef SQLITE_PERFORMANCE_TRACE
  23720. /*
  23721. ** hwtime.h contains inline assembler code for implementing
  23722. ** high-performance timing routines.
  23723. */
  23724. /************** Include hwtime.h in the middle of os_common.h ****************/
  23725. /************** Begin file hwtime.h ******************************************/
  23726. /*
  23727. ** 2008 May 27
  23728. **
  23729. ** The author disclaims copyright to this source code. In place of
  23730. ** a legal notice, here is a blessing:
  23731. **
  23732. ** May you do good and not evil.
  23733. ** May you find forgiveness for yourself and forgive others.
  23734. ** May you share freely, never taking more than you give.
  23735. **
  23736. ******************************************************************************
  23737. **
  23738. ** This file contains inline asm code for retrieving "high-performance"
  23739. ** counters for x86 class CPUs.
  23740. */
  23741. #ifndef SQLITE_HWTIME_H
  23742. #define SQLITE_HWTIME_H
  23743. /*
  23744. ** The following routine only works on pentium-class (or newer) processors.
  23745. ** It uses the RDTSC opcode to read the cycle count value out of the
  23746. ** processor and returns that value. This can be used for high-res
  23747. ** profiling.
  23748. */
  23749. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  23750. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  23751. #if defined(__GNUC__)
  23752. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  23753. unsigned int lo, hi;
  23754. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  23755. return (sqlite_uint64)hi << 32 | lo;
  23756. }
  23757. #elif defined(_MSC_VER)
  23758. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  23759. __asm {
  23760. rdtsc
  23761. ret ; return value at EDX:EAX
  23762. }
  23763. }
  23764. #endif
  23765. #elif (defined(__GNUC__) && defined(__x86_64__))
  23766. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  23767. unsigned long val;
  23768. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  23769. return val;
  23770. }
  23771. #elif (defined(__GNUC__) && defined(__ppc__))
  23772. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  23773. unsigned long long retval;
  23774. unsigned long junk;
  23775. __asm__ __volatile__ ("\n\
  23776. 1: mftbu %1\n\
  23777. mftb %L0\n\
  23778. mftbu %0\n\
  23779. cmpw %0,%1\n\
  23780. bne 1b"
  23781. : "=r" (retval), "=r" (junk));
  23782. return retval;
  23783. }
  23784. #else
  23785. #error Need implementation of sqlite3Hwtime() for your platform.
  23786. /*
  23787. ** To compile without implementing sqlite3Hwtime() for your platform,
  23788. ** you can remove the above #error and use the following
  23789. ** stub function. You will lose timing support for many
  23790. ** of the debugging and testing utilities, but it should at
  23791. ** least compile and run.
  23792. */
  23793. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  23794. #endif
  23795. #endif /* !defined(SQLITE_HWTIME_H) */
  23796. /************** End of hwtime.h **********************************************/
  23797. /************** Continuing where we left off in os_common.h ******************/
  23798. static sqlite_uint64 g_start;
  23799. static sqlite_uint64 g_elapsed;
  23800. #define TIMER_START g_start=sqlite3Hwtime()
  23801. #define TIMER_END g_elapsed=sqlite3Hwtime()-g_start
  23802. #define TIMER_ELAPSED g_elapsed
  23803. #else
  23804. #define TIMER_START
  23805. #define TIMER_END
  23806. #define TIMER_ELAPSED ((sqlite_uint64)0)
  23807. #endif
  23808. /*
  23809. ** If we compile with the SQLITE_TEST macro set, then the following block
  23810. ** of code will give us the ability to simulate a disk I/O error. This
  23811. ** is used for testing the I/O recovery logic.
  23812. */
  23813. #if defined(SQLITE_TEST)
  23814. SQLITE_API extern int sqlite3_io_error_hit;
  23815. SQLITE_API extern int sqlite3_io_error_hardhit;
  23816. SQLITE_API extern int sqlite3_io_error_pending;
  23817. SQLITE_API extern int sqlite3_io_error_persist;
  23818. SQLITE_API extern int sqlite3_io_error_benign;
  23819. SQLITE_API extern int sqlite3_diskfull_pending;
  23820. SQLITE_API extern int sqlite3_diskfull;
  23821. #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
  23822. #define SimulateIOError(CODE) \
  23823. if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
  23824. || sqlite3_io_error_pending-- == 1 ) \
  23825. { local_ioerr(); CODE; }
  23826. static void local_ioerr(){
  23827. IOTRACE(("IOERR\n"));
  23828. sqlite3_io_error_hit++;
  23829. if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
  23830. }
  23831. #define SimulateDiskfullError(CODE) \
  23832. if( sqlite3_diskfull_pending ){ \
  23833. if( sqlite3_diskfull_pending == 1 ){ \
  23834. local_ioerr(); \
  23835. sqlite3_diskfull = 1; \
  23836. sqlite3_io_error_hit = 1; \
  23837. CODE; \
  23838. }else{ \
  23839. sqlite3_diskfull_pending--; \
  23840. } \
  23841. }
  23842. #else
  23843. #define SimulateIOErrorBenign(X)
  23844. #define SimulateIOError(A)
  23845. #define SimulateDiskfullError(A)
  23846. #endif /* defined(SQLITE_TEST) */
  23847. /*
  23848. ** When testing, keep a count of the number of open files.
  23849. */
  23850. #if defined(SQLITE_TEST)
  23851. SQLITE_API extern int sqlite3_open_file_count;
  23852. #define OpenCounter(X) sqlite3_open_file_count+=(X)
  23853. #else
  23854. #define OpenCounter(X)
  23855. #endif /* defined(SQLITE_TEST) */
  23856. #endif /* !defined(_OS_COMMON_H_) */
  23857. /************** End of os_common.h *******************************************/
  23858. /************** Continuing where we left off in mutex_w32.c ******************/
  23859. /*
  23860. ** Include the header file for the Windows VFS.
  23861. */
  23862. /************** Include os_win.h in the middle of mutex_w32.c ****************/
  23863. /************** Begin file os_win.h ******************************************/
  23864. /*
  23865. ** 2013 November 25
  23866. **
  23867. ** The author disclaims copyright to this source code. In place of
  23868. ** a legal notice, here is a blessing:
  23869. **
  23870. ** May you do good and not evil.
  23871. ** May you find forgiveness for yourself and forgive others.
  23872. ** May you share freely, never taking more than you give.
  23873. **
  23874. ******************************************************************************
  23875. **
  23876. ** This file contains code that is specific to Windows.
  23877. */
  23878. #ifndef SQLITE_OS_WIN_H
  23879. #define SQLITE_OS_WIN_H
  23880. /*
  23881. ** Include the primary Windows SDK header file.
  23882. */
  23883. #include "windows.h"
  23884. #ifdef __CYGWIN__
  23885. # include <sys/cygwin.h>
  23886. # include <errno.h> /* amalgamator: dontcache */
  23887. #endif
  23888. /*
  23889. ** Determine if we are dealing with Windows NT.
  23890. **
  23891. ** We ought to be able to determine if we are compiling for Windows 9x or
  23892. ** Windows NT using the _WIN32_WINNT macro as follows:
  23893. **
  23894. ** #if defined(_WIN32_WINNT)
  23895. ** # define SQLITE_OS_WINNT 1
  23896. ** #else
  23897. ** # define SQLITE_OS_WINNT 0
  23898. ** #endif
  23899. **
  23900. ** However, Visual Studio 2005 does not set _WIN32_WINNT by default, as
  23901. ** it ought to, so the above test does not work. We'll just assume that
  23902. ** everything is Windows NT unless the programmer explicitly says otherwise
  23903. ** by setting SQLITE_OS_WINNT to 0.
  23904. */
  23905. #if SQLITE_OS_WIN && !defined(SQLITE_OS_WINNT)
  23906. # define SQLITE_OS_WINNT 1
  23907. #endif
  23908. /*
  23909. ** Determine if we are dealing with Windows CE - which has a much reduced
  23910. ** API.
  23911. */
  23912. #if defined(_WIN32_WCE)
  23913. # define SQLITE_OS_WINCE 1
  23914. #else
  23915. # define SQLITE_OS_WINCE 0
  23916. #endif
  23917. /*
  23918. ** Determine if we are dealing with WinRT, which provides only a subset of
  23919. ** the full Win32 API.
  23920. */
  23921. #if !defined(SQLITE_OS_WINRT)
  23922. # define SQLITE_OS_WINRT 0
  23923. #endif
  23924. /*
  23925. ** For WinCE, some API function parameters do not appear to be declared as
  23926. ** volatile.
  23927. */
  23928. #if SQLITE_OS_WINCE
  23929. # define SQLITE_WIN32_VOLATILE
  23930. #else
  23931. # define SQLITE_WIN32_VOLATILE volatile
  23932. #endif
  23933. /*
  23934. ** For some Windows sub-platforms, the _beginthreadex() / _endthreadex()
  23935. ** functions are not available (e.g. those not using MSVC, Cygwin, etc).
  23936. */
  23937. #if SQLITE_OS_WIN && !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && \
  23938. SQLITE_THREADSAFE>0 && !defined(__CYGWIN__)
  23939. # define SQLITE_OS_WIN_THREADS 1
  23940. #else
  23941. # define SQLITE_OS_WIN_THREADS 0
  23942. #endif
  23943. #endif /* SQLITE_OS_WIN_H */
  23944. /************** End of os_win.h **********************************************/
  23945. /************** Continuing where we left off in mutex_w32.c ******************/
  23946. #endif
  23947. /*
  23948. ** The code in this file is only used if we are compiling multithreaded
  23949. ** on a Win32 system.
  23950. */
  23951. #ifdef SQLITE_MUTEX_W32
  23952. /*
  23953. ** Each recursive mutex is an instance of the following structure.
  23954. */
  23955. struct sqlite3_mutex {
  23956. CRITICAL_SECTION mutex; /* Mutex controlling the lock */
  23957. int id; /* Mutex type */
  23958. #ifdef SQLITE_DEBUG
  23959. volatile int nRef; /* Number of enterances */
  23960. volatile DWORD owner; /* Thread holding this mutex */
  23961. volatile LONG trace; /* True to trace changes */
  23962. #endif
  23963. };
  23964. /*
  23965. ** These are the initializer values used when declaring a "static" mutex
  23966. ** on Win32. It should be noted that all mutexes require initialization
  23967. ** on the Win32 platform.
  23968. */
  23969. #define SQLITE_W32_MUTEX_INITIALIZER { 0 }
  23970. #ifdef SQLITE_DEBUG
  23971. #define SQLITE3_MUTEX_INITIALIZER(id) { SQLITE_W32_MUTEX_INITIALIZER, id, \
  23972. 0L, (DWORD)0, 0 }
  23973. #else
  23974. #define SQLITE3_MUTEX_INITIALIZER(id) { SQLITE_W32_MUTEX_INITIALIZER, id }
  23975. #endif
  23976. #ifdef SQLITE_DEBUG
  23977. /*
  23978. ** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routine are
  23979. ** intended for use only inside assert() statements.
  23980. */
  23981. static int winMutexHeld(sqlite3_mutex *p){
  23982. return p->nRef!=0 && p->owner==GetCurrentThreadId();
  23983. }
  23984. static int winMutexNotheld2(sqlite3_mutex *p, DWORD tid){
  23985. return p->nRef==0 || p->owner!=tid;
  23986. }
  23987. static int winMutexNotheld(sqlite3_mutex *p){
  23988. DWORD tid = GetCurrentThreadId();
  23989. return winMutexNotheld2(p, tid);
  23990. }
  23991. #endif
  23992. /*
  23993. ** Try to provide a memory barrier operation, needed for initialization
  23994. ** and also for the xShmBarrier method of the VFS in cases when SQLite is
  23995. ** compiled without mutexes (SQLITE_THREADSAFE=0).
  23996. */
  23997. SQLITE_PRIVATE void sqlite3MemoryBarrier(void){
  23998. #if defined(SQLITE_MEMORY_BARRIER)
  23999. SQLITE_MEMORY_BARRIER;
  24000. #elif defined(__GNUC__)
  24001. __sync_synchronize();
  24002. #elif MSVC_VERSION>=1300
  24003. _ReadWriteBarrier();
  24004. #elif defined(MemoryBarrier)
  24005. MemoryBarrier();
  24006. #endif
  24007. }
  24008. /*
  24009. ** Initialize and deinitialize the mutex subsystem.
  24010. */
  24011. static sqlite3_mutex winMutex_staticMutexes[] = {
  24012. SQLITE3_MUTEX_INITIALIZER(2),
  24013. SQLITE3_MUTEX_INITIALIZER(3),
  24014. SQLITE3_MUTEX_INITIALIZER(4),
  24015. SQLITE3_MUTEX_INITIALIZER(5),
  24016. SQLITE3_MUTEX_INITIALIZER(6),
  24017. SQLITE3_MUTEX_INITIALIZER(7),
  24018. SQLITE3_MUTEX_INITIALIZER(8),
  24019. SQLITE3_MUTEX_INITIALIZER(9),
  24020. SQLITE3_MUTEX_INITIALIZER(10),
  24021. SQLITE3_MUTEX_INITIALIZER(11),
  24022. SQLITE3_MUTEX_INITIALIZER(12),
  24023. SQLITE3_MUTEX_INITIALIZER(13)
  24024. };
  24025. static int winMutex_isInit = 0;
  24026. static int winMutex_isNt = -1; /* <0 means "need to query" */
  24027. /* As the winMutexInit() and winMutexEnd() functions are called as part
  24028. ** of the sqlite3_initialize() and sqlite3_shutdown() processing, the
  24029. ** "interlocked" magic used here is probably not strictly necessary.
  24030. */
  24031. static LONG SQLITE_WIN32_VOLATILE winMutex_lock = 0;
  24032. SQLITE_API int sqlite3_win32_is_nt(void); /* os_win.c */
  24033. SQLITE_API void sqlite3_win32_sleep(DWORD milliseconds); /* os_win.c */
  24034. static int winMutexInit(void){
  24035. /* The first to increment to 1 does actual initialization */
  24036. if( InterlockedCompareExchange(&winMutex_lock, 1, 0)==0 ){
  24037. int i;
  24038. for(i=0; i<ArraySize(winMutex_staticMutexes); i++){
  24039. #if SQLITE_OS_WINRT
  24040. InitializeCriticalSectionEx(&winMutex_staticMutexes[i].mutex, 0, 0);
  24041. #else
  24042. InitializeCriticalSection(&winMutex_staticMutexes[i].mutex);
  24043. #endif
  24044. }
  24045. winMutex_isInit = 1;
  24046. }else{
  24047. /* Another thread is (in the process of) initializing the static
  24048. ** mutexes */
  24049. while( !winMutex_isInit ){
  24050. sqlite3_win32_sleep(1);
  24051. }
  24052. }
  24053. return SQLITE_OK;
  24054. }
  24055. static int winMutexEnd(void){
  24056. /* The first to decrement to 0 does actual shutdown
  24057. ** (which should be the last to shutdown.) */
  24058. if( InterlockedCompareExchange(&winMutex_lock, 0, 1)==1 ){
  24059. if( winMutex_isInit==1 ){
  24060. int i;
  24061. for(i=0; i<ArraySize(winMutex_staticMutexes); i++){
  24062. DeleteCriticalSection(&winMutex_staticMutexes[i].mutex);
  24063. }
  24064. winMutex_isInit = 0;
  24065. }
  24066. }
  24067. return SQLITE_OK;
  24068. }
  24069. /*
  24070. ** The sqlite3_mutex_alloc() routine allocates a new
  24071. ** mutex and returns a pointer to it. If it returns NULL
  24072. ** that means that a mutex could not be allocated. SQLite
  24073. ** will unwind its stack and return an error. The argument
  24074. ** to sqlite3_mutex_alloc() is one of these integer constants:
  24075. **
  24076. ** <ul>
  24077. ** <li> SQLITE_MUTEX_FAST
  24078. ** <li> SQLITE_MUTEX_RECURSIVE
  24079. ** <li> SQLITE_MUTEX_STATIC_MASTER
  24080. ** <li> SQLITE_MUTEX_STATIC_MEM
  24081. ** <li> SQLITE_MUTEX_STATIC_OPEN
  24082. ** <li> SQLITE_MUTEX_STATIC_PRNG
  24083. ** <li> SQLITE_MUTEX_STATIC_LRU
  24084. ** <li> SQLITE_MUTEX_STATIC_PMEM
  24085. ** <li> SQLITE_MUTEX_STATIC_APP1
  24086. ** <li> SQLITE_MUTEX_STATIC_APP2
  24087. ** <li> SQLITE_MUTEX_STATIC_APP3
  24088. ** <li> SQLITE_MUTEX_STATIC_VFS1
  24089. ** <li> SQLITE_MUTEX_STATIC_VFS2
  24090. ** <li> SQLITE_MUTEX_STATIC_VFS3
  24091. ** </ul>
  24092. **
  24093. ** The first two constants cause sqlite3_mutex_alloc() to create
  24094. ** a new mutex. The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
  24095. ** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
  24096. ** The mutex implementation does not need to make a distinction
  24097. ** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
  24098. ** not want to. But SQLite will only request a recursive mutex in
  24099. ** cases where it really needs one. If a faster non-recursive mutex
  24100. ** implementation is available on the host platform, the mutex subsystem
  24101. ** might return such a mutex in response to SQLITE_MUTEX_FAST.
  24102. **
  24103. ** The other allowed parameters to sqlite3_mutex_alloc() each return
  24104. ** a pointer to a static preexisting mutex. Six static mutexes are
  24105. ** used by the current version of SQLite. Future versions of SQLite
  24106. ** may add additional static mutexes. Static mutexes are for internal
  24107. ** use by SQLite only. Applications that use SQLite mutexes should
  24108. ** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
  24109. ** SQLITE_MUTEX_RECURSIVE.
  24110. **
  24111. ** Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
  24112. ** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
  24113. ** returns a different mutex on every call. But for the static
  24114. ** mutex types, the same mutex is returned on every call that has
  24115. ** the same type number.
  24116. */
  24117. static sqlite3_mutex *winMutexAlloc(int iType){
  24118. sqlite3_mutex *p;
  24119. switch( iType ){
  24120. case SQLITE_MUTEX_FAST:
  24121. case SQLITE_MUTEX_RECURSIVE: {
  24122. p = sqlite3MallocZero( sizeof(*p) );
  24123. if( p ){
  24124. p->id = iType;
  24125. #ifdef SQLITE_DEBUG
  24126. #ifdef SQLITE_WIN32_MUTEX_TRACE_DYNAMIC
  24127. p->trace = 1;
  24128. #endif
  24129. #endif
  24130. #if SQLITE_OS_WINRT
  24131. InitializeCriticalSectionEx(&p->mutex, 0, 0);
  24132. #else
  24133. InitializeCriticalSection(&p->mutex);
  24134. #endif
  24135. }
  24136. break;
  24137. }
  24138. default: {
  24139. #ifdef SQLITE_ENABLE_API_ARMOR
  24140. if( iType-2<0 || iType-2>=ArraySize(winMutex_staticMutexes) ){
  24141. (void)SQLITE_MISUSE_BKPT;
  24142. return 0;
  24143. }
  24144. #endif
  24145. p = &winMutex_staticMutexes[iType-2];
  24146. #ifdef SQLITE_DEBUG
  24147. #ifdef SQLITE_WIN32_MUTEX_TRACE_STATIC
  24148. InterlockedCompareExchange(&p->trace, 1, 0);
  24149. #endif
  24150. #endif
  24151. break;
  24152. }
  24153. }
  24154. assert( p==0 || p->id==iType );
  24155. return p;
  24156. }
  24157. /*
  24158. ** This routine deallocates a previously
  24159. ** allocated mutex. SQLite is careful to deallocate every
  24160. ** mutex that it allocates.
  24161. */
  24162. static void winMutexFree(sqlite3_mutex *p){
  24163. assert( p );
  24164. assert( p->nRef==0 && p->owner==0 );
  24165. if( p->id==SQLITE_MUTEX_FAST || p->id==SQLITE_MUTEX_RECURSIVE ){
  24166. DeleteCriticalSection(&p->mutex);
  24167. sqlite3_free(p);
  24168. }else{
  24169. #ifdef SQLITE_ENABLE_API_ARMOR
  24170. (void)SQLITE_MISUSE_BKPT;
  24171. #endif
  24172. }
  24173. }
  24174. /*
  24175. ** The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
  24176. ** to enter a mutex. If another thread is already within the mutex,
  24177. ** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
  24178. ** SQLITE_BUSY. The sqlite3_mutex_try() interface returns SQLITE_OK
  24179. ** upon successful entry. Mutexes created using SQLITE_MUTEX_RECURSIVE can
  24180. ** be entered multiple times by the same thread. In such cases the,
  24181. ** mutex must be exited an equal number of times before another thread
  24182. ** can enter. If the same thread tries to enter any other kind of mutex
  24183. ** more than once, the behavior is undefined.
  24184. */
  24185. static void winMutexEnter(sqlite3_mutex *p){
  24186. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  24187. DWORD tid = GetCurrentThreadId();
  24188. #endif
  24189. #ifdef SQLITE_DEBUG
  24190. assert( p );
  24191. assert( p->id==SQLITE_MUTEX_RECURSIVE || winMutexNotheld2(p, tid) );
  24192. #else
  24193. assert( p );
  24194. #endif
  24195. assert( winMutex_isInit==1 );
  24196. EnterCriticalSection(&p->mutex);
  24197. #ifdef SQLITE_DEBUG
  24198. assert( p->nRef>0 || p->owner==0 );
  24199. p->owner = tid;
  24200. p->nRef++;
  24201. if( p->trace ){
  24202. OSTRACE(("ENTER-MUTEX tid=%lu, mutex(%d)=%p (%d), nRef=%d\n",
  24203. tid, p->id, p, p->trace, p->nRef));
  24204. }
  24205. #endif
  24206. }
  24207. static int winMutexTry(sqlite3_mutex *p){
  24208. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  24209. DWORD tid = GetCurrentThreadId();
  24210. #endif
  24211. int rc = SQLITE_BUSY;
  24212. assert( p );
  24213. assert( p->id==SQLITE_MUTEX_RECURSIVE || winMutexNotheld2(p, tid) );
  24214. /*
  24215. ** The sqlite3_mutex_try() routine is very rarely used, and when it
  24216. ** is used it is merely an optimization. So it is OK for it to always
  24217. ** fail.
  24218. **
  24219. ** The TryEnterCriticalSection() interface is only available on WinNT.
  24220. ** And some windows compilers complain if you try to use it without
  24221. ** first doing some #defines that prevent SQLite from building on Win98.
  24222. ** For that reason, we will omit this optimization for now. See
  24223. ** ticket #2685.
  24224. */
  24225. #if defined(_WIN32_WINNT) && _WIN32_WINNT >= 0x0400
  24226. assert( winMutex_isInit==1 );
  24227. assert( winMutex_isNt>=-1 && winMutex_isNt<=1 );
  24228. if( winMutex_isNt<0 ){
  24229. winMutex_isNt = sqlite3_win32_is_nt();
  24230. }
  24231. assert( winMutex_isNt==0 || winMutex_isNt==1 );
  24232. if( winMutex_isNt && TryEnterCriticalSection(&p->mutex) ){
  24233. #ifdef SQLITE_DEBUG
  24234. p->owner = tid;
  24235. p->nRef++;
  24236. #endif
  24237. rc = SQLITE_OK;
  24238. }
  24239. #else
  24240. UNUSED_PARAMETER(p);
  24241. #endif
  24242. #ifdef SQLITE_DEBUG
  24243. if( p->trace ){
  24244. OSTRACE(("TRY-MUTEX tid=%lu, mutex(%d)=%p (%d), owner=%lu, nRef=%d, rc=%s\n",
  24245. tid, p->id, p, p->trace, p->owner, p->nRef, sqlite3ErrName(rc)));
  24246. }
  24247. #endif
  24248. return rc;
  24249. }
  24250. /*
  24251. ** The sqlite3_mutex_leave() routine exits a mutex that was
  24252. ** previously entered by the same thread. The behavior
  24253. ** is undefined if the mutex is not currently entered or
  24254. ** is not currently allocated. SQLite will never do either.
  24255. */
  24256. static void winMutexLeave(sqlite3_mutex *p){
  24257. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  24258. DWORD tid = GetCurrentThreadId();
  24259. #endif
  24260. assert( p );
  24261. #ifdef SQLITE_DEBUG
  24262. assert( p->nRef>0 );
  24263. assert( p->owner==tid );
  24264. p->nRef--;
  24265. if( p->nRef==0 ) p->owner = 0;
  24266. assert( p->nRef==0 || p->id==SQLITE_MUTEX_RECURSIVE );
  24267. #endif
  24268. assert( winMutex_isInit==1 );
  24269. LeaveCriticalSection(&p->mutex);
  24270. #ifdef SQLITE_DEBUG
  24271. if( p->trace ){
  24272. OSTRACE(("LEAVE-MUTEX tid=%lu, mutex(%d)=%p (%d), nRef=%d\n",
  24273. tid, p->id, p, p->trace, p->nRef));
  24274. }
  24275. #endif
  24276. }
  24277. SQLITE_PRIVATE sqlite3_mutex_methods const *sqlite3DefaultMutex(void){
  24278. static const sqlite3_mutex_methods sMutex = {
  24279. winMutexInit,
  24280. winMutexEnd,
  24281. winMutexAlloc,
  24282. winMutexFree,
  24283. winMutexEnter,
  24284. winMutexTry,
  24285. winMutexLeave,
  24286. #ifdef SQLITE_DEBUG
  24287. winMutexHeld,
  24288. winMutexNotheld
  24289. #else
  24290. 0,
  24291. 0
  24292. #endif
  24293. };
  24294. return &sMutex;
  24295. }
  24296. #endif /* SQLITE_MUTEX_W32 */
  24297. /************** End of mutex_w32.c *******************************************/
  24298. /************** Begin file malloc.c ******************************************/
  24299. /*
  24300. ** 2001 September 15
  24301. **
  24302. ** The author disclaims copyright to this source code. In place of
  24303. ** a legal notice, here is a blessing:
  24304. **
  24305. ** May you do good and not evil.
  24306. ** May you find forgiveness for yourself and forgive others.
  24307. ** May you share freely, never taking more than you give.
  24308. **
  24309. *************************************************************************
  24310. **
  24311. ** Memory allocation functions used throughout sqlite.
  24312. */
  24313. /* #include "sqliteInt.h" */
  24314. /* #include <stdarg.h> */
  24315. /*
  24316. ** Attempt to release up to n bytes of non-essential memory currently
  24317. ** held by SQLite. An example of non-essential memory is memory used to
  24318. ** cache database pages that are not currently in use.
  24319. */
  24320. SQLITE_API int sqlite3_release_memory(int n){
  24321. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  24322. return sqlite3PcacheReleaseMemory(n);
  24323. #else
  24324. /* IMPLEMENTATION-OF: R-34391-24921 The sqlite3_release_memory() routine
  24325. ** is a no-op returning zero if SQLite is not compiled with
  24326. ** SQLITE_ENABLE_MEMORY_MANAGEMENT. */
  24327. UNUSED_PARAMETER(n);
  24328. return 0;
  24329. #endif
  24330. }
  24331. /*
  24332. ** State information local to the memory allocation subsystem.
  24333. */
  24334. static SQLITE_WSD struct Mem0Global {
  24335. sqlite3_mutex *mutex; /* Mutex to serialize access */
  24336. sqlite3_int64 alarmThreshold; /* The soft heap limit */
  24337. /*
  24338. ** True if heap is nearly "full" where "full" is defined by the
  24339. ** sqlite3_soft_heap_limit() setting.
  24340. */
  24341. int nearlyFull;
  24342. } mem0 = { 0, 0, 0 };
  24343. #define mem0 GLOBAL(struct Mem0Global, mem0)
  24344. /*
  24345. ** Return the memory allocator mutex. sqlite3_status() needs it.
  24346. */
  24347. SQLITE_PRIVATE sqlite3_mutex *sqlite3MallocMutex(void){
  24348. return mem0.mutex;
  24349. }
  24350. #ifndef SQLITE_OMIT_DEPRECATED
  24351. /*
  24352. ** Deprecated external interface. It used to set an alarm callback
  24353. ** that was invoked when memory usage grew too large. Now it is a
  24354. ** no-op.
  24355. */
  24356. SQLITE_API int sqlite3_memory_alarm(
  24357. void(*xCallback)(void *pArg, sqlite3_int64 used,int N),
  24358. void *pArg,
  24359. sqlite3_int64 iThreshold
  24360. ){
  24361. (void)xCallback;
  24362. (void)pArg;
  24363. (void)iThreshold;
  24364. return SQLITE_OK;
  24365. }
  24366. #endif
  24367. /*
  24368. ** Set the soft heap-size limit for the library. Passing a zero or
  24369. ** negative value indicates no limit.
  24370. */
  24371. SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 n){
  24372. sqlite3_int64 priorLimit;
  24373. sqlite3_int64 excess;
  24374. sqlite3_int64 nUsed;
  24375. #ifndef SQLITE_OMIT_AUTOINIT
  24376. int rc = sqlite3_initialize();
  24377. if( rc ) return -1;
  24378. #endif
  24379. sqlite3_mutex_enter(mem0.mutex);
  24380. priorLimit = mem0.alarmThreshold;
  24381. if( n<0 ){
  24382. sqlite3_mutex_leave(mem0.mutex);
  24383. return priorLimit;
  24384. }
  24385. mem0.alarmThreshold = n;
  24386. nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
  24387. mem0.nearlyFull = (n>0 && n<=nUsed);
  24388. sqlite3_mutex_leave(mem0.mutex);
  24389. excess = sqlite3_memory_used() - n;
  24390. if( excess>0 ) sqlite3_release_memory((int)(excess & 0x7fffffff));
  24391. return priorLimit;
  24392. }
  24393. SQLITE_API void sqlite3_soft_heap_limit(int n){
  24394. if( n<0 ) n = 0;
  24395. sqlite3_soft_heap_limit64(n);
  24396. }
  24397. /*
  24398. ** Initialize the memory allocation subsystem.
  24399. */
  24400. SQLITE_PRIVATE int sqlite3MallocInit(void){
  24401. int rc;
  24402. if( sqlite3GlobalConfig.m.xMalloc==0 ){
  24403. sqlite3MemSetDefault();
  24404. }
  24405. memset(&mem0, 0, sizeof(mem0));
  24406. mem0.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM);
  24407. if( sqlite3GlobalConfig.pPage==0 || sqlite3GlobalConfig.szPage<512
  24408. || sqlite3GlobalConfig.nPage<=0 ){
  24409. sqlite3GlobalConfig.pPage = 0;
  24410. sqlite3GlobalConfig.szPage = 0;
  24411. }
  24412. rc = sqlite3GlobalConfig.m.xInit(sqlite3GlobalConfig.m.pAppData);
  24413. if( rc!=SQLITE_OK ) memset(&mem0, 0, sizeof(mem0));
  24414. return rc;
  24415. }
  24416. /*
  24417. ** Return true if the heap is currently under memory pressure - in other
  24418. ** words if the amount of heap used is close to the limit set by
  24419. ** sqlite3_soft_heap_limit().
  24420. */
  24421. SQLITE_PRIVATE int sqlite3HeapNearlyFull(void){
  24422. return mem0.nearlyFull;
  24423. }
  24424. /*
  24425. ** Deinitialize the memory allocation subsystem.
  24426. */
  24427. SQLITE_PRIVATE void sqlite3MallocEnd(void){
  24428. if( sqlite3GlobalConfig.m.xShutdown ){
  24429. sqlite3GlobalConfig.m.xShutdown(sqlite3GlobalConfig.m.pAppData);
  24430. }
  24431. memset(&mem0, 0, sizeof(mem0));
  24432. }
  24433. /*
  24434. ** Return the amount of memory currently checked out.
  24435. */
  24436. SQLITE_API sqlite3_int64 sqlite3_memory_used(void){
  24437. sqlite3_int64 res, mx;
  24438. sqlite3_status64(SQLITE_STATUS_MEMORY_USED, &res, &mx, 0);
  24439. return res;
  24440. }
  24441. /*
  24442. ** Return the maximum amount of memory that has ever been
  24443. ** checked out since either the beginning of this process
  24444. ** or since the most recent reset.
  24445. */
  24446. SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag){
  24447. sqlite3_int64 res, mx;
  24448. sqlite3_status64(SQLITE_STATUS_MEMORY_USED, &res, &mx, resetFlag);
  24449. return mx;
  24450. }
  24451. /*
  24452. ** Trigger the alarm
  24453. */
  24454. static void sqlite3MallocAlarm(int nByte){
  24455. if( mem0.alarmThreshold<=0 ) return;
  24456. sqlite3_mutex_leave(mem0.mutex);
  24457. sqlite3_release_memory(nByte);
  24458. sqlite3_mutex_enter(mem0.mutex);
  24459. }
  24460. /*
  24461. ** Do a memory allocation with statistics and alarms. Assume the
  24462. ** lock is already held.
  24463. */
  24464. static void mallocWithAlarm(int n, void **pp){
  24465. void *p;
  24466. int nFull;
  24467. assert( sqlite3_mutex_held(mem0.mutex) );
  24468. assert( n>0 );
  24469. /* In Firefox (circa 2017-02-08), xRoundup() is remapped to an internal
  24470. ** implementation of malloc_good_size(), which must be called in debug
  24471. ** mode and specifically when the DMD "Dark Matter Detector" is enabled
  24472. ** or else a crash results. Hence, do not attempt to optimize out the
  24473. ** following xRoundup() call. */
  24474. nFull = sqlite3GlobalConfig.m.xRoundup(n);
  24475. #ifdef SQLITE_MAX_MEMORY
  24476. if( sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED)+nFull>SQLITE_MAX_MEMORY ){
  24477. *pp = 0;
  24478. return;
  24479. }
  24480. #endif
  24481. sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, n);
  24482. if( mem0.alarmThreshold>0 ){
  24483. sqlite3_int64 nUsed = sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED);
  24484. if( nUsed >= mem0.alarmThreshold - nFull ){
  24485. mem0.nearlyFull = 1;
  24486. sqlite3MallocAlarm(nFull);
  24487. }else{
  24488. mem0.nearlyFull = 0;
  24489. }
  24490. }
  24491. p = sqlite3GlobalConfig.m.xMalloc(nFull);
  24492. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  24493. if( p==0 && mem0.alarmThreshold>0 ){
  24494. sqlite3MallocAlarm(nFull);
  24495. p = sqlite3GlobalConfig.m.xMalloc(nFull);
  24496. }
  24497. #endif
  24498. if( p ){
  24499. nFull = sqlite3MallocSize(p);
  24500. sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nFull);
  24501. sqlite3StatusUp(SQLITE_STATUS_MALLOC_COUNT, 1);
  24502. }
  24503. *pp = p;
  24504. }
  24505. /*
  24506. ** Allocate memory. This routine is like sqlite3_malloc() except that it
  24507. ** assumes the memory subsystem has already been initialized.
  24508. */
  24509. SQLITE_PRIVATE void *sqlite3Malloc(u64 n){
  24510. void *p;
  24511. if( n==0 || n>=0x7fffff00 ){
  24512. /* A memory allocation of a number of bytes which is near the maximum
  24513. ** signed integer value might cause an integer overflow inside of the
  24514. ** xMalloc(). Hence we limit the maximum size to 0x7fffff00, giving
  24515. ** 255 bytes of overhead. SQLite itself will never use anything near
  24516. ** this amount. The only way to reach the limit is with sqlite3_malloc() */
  24517. p = 0;
  24518. }else if( sqlite3GlobalConfig.bMemstat ){
  24519. sqlite3_mutex_enter(mem0.mutex);
  24520. mallocWithAlarm((int)n, &p);
  24521. sqlite3_mutex_leave(mem0.mutex);
  24522. }else{
  24523. p = sqlite3GlobalConfig.m.xMalloc((int)n);
  24524. }
  24525. assert( EIGHT_BYTE_ALIGNMENT(p) ); /* IMP: R-11148-40995 */
  24526. return p;
  24527. }
  24528. /*
  24529. ** This version of the memory allocation is for use by the application.
  24530. ** First make sure the memory subsystem is initialized, then do the
  24531. ** allocation.
  24532. */
  24533. SQLITE_API void *sqlite3_malloc(int n){
  24534. #ifndef SQLITE_OMIT_AUTOINIT
  24535. if( sqlite3_initialize() ) return 0;
  24536. #endif
  24537. return n<=0 ? 0 : sqlite3Malloc(n);
  24538. }
  24539. SQLITE_API void *sqlite3_malloc64(sqlite3_uint64 n){
  24540. #ifndef SQLITE_OMIT_AUTOINIT
  24541. if( sqlite3_initialize() ) return 0;
  24542. #endif
  24543. return sqlite3Malloc(n);
  24544. }
  24545. /*
  24546. ** TRUE if p is a lookaside memory allocation from db
  24547. */
  24548. #ifndef SQLITE_OMIT_LOOKASIDE
  24549. static int isLookaside(sqlite3 *db, void *p){
  24550. return SQLITE_WITHIN(p, db->lookaside.pStart, db->lookaside.pEnd);
  24551. }
  24552. #else
  24553. #define isLookaside(A,B) 0
  24554. #endif
  24555. /*
  24556. ** Return the size of a memory allocation previously obtained from
  24557. ** sqlite3Malloc() or sqlite3_malloc().
  24558. */
  24559. SQLITE_PRIVATE int sqlite3MallocSize(void *p){
  24560. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  24561. return sqlite3GlobalConfig.m.xSize(p);
  24562. }
  24563. SQLITE_PRIVATE int sqlite3DbMallocSize(sqlite3 *db, void *p){
  24564. assert( p!=0 );
  24565. if( db==0 || !isLookaside(db,p) ){
  24566. #ifdef SQLITE_DEBUG
  24567. if( db==0 ){
  24568. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
  24569. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  24570. }else{
  24571. assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  24572. assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  24573. }
  24574. #endif
  24575. return sqlite3GlobalConfig.m.xSize(p);
  24576. }else{
  24577. assert( sqlite3_mutex_held(db->mutex) );
  24578. return db->lookaside.sz;
  24579. }
  24580. }
  24581. SQLITE_API sqlite3_uint64 sqlite3_msize(void *p){
  24582. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
  24583. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  24584. return p ? sqlite3GlobalConfig.m.xSize(p) : 0;
  24585. }
  24586. /*
  24587. ** Free memory previously obtained from sqlite3Malloc().
  24588. */
  24589. SQLITE_API void sqlite3_free(void *p){
  24590. if( p==0 ) return; /* IMP: R-49053-54554 */
  24591. assert( sqlite3MemdebugHasType(p, MEMTYPE_HEAP) );
  24592. assert( sqlite3MemdebugNoType(p, (u8)~MEMTYPE_HEAP) );
  24593. if( sqlite3GlobalConfig.bMemstat ){
  24594. sqlite3_mutex_enter(mem0.mutex);
  24595. sqlite3StatusDown(SQLITE_STATUS_MEMORY_USED, sqlite3MallocSize(p));
  24596. sqlite3StatusDown(SQLITE_STATUS_MALLOC_COUNT, 1);
  24597. sqlite3GlobalConfig.m.xFree(p);
  24598. sqlite3_mutex_leave(mem0.mutex);
  24599. }else{
  24600. sqlite3GlobalConfig.m.xFree(p);
  24601. }
  24602. }
  24603. /*
  24604. ** Add the size of memory allocation "p" to the count in
  24605. ** *db->pnBytesFreed.
  24606. */
  24607. static SQLITE_NOINLINE void measureAllocationSize(sqlite3 *db, void *p){
  24608. *db->pnBytesFreed += sqlite3DbMallocSize(db,p);
  24609. }
  24610. /*
  24611. ** Free memory that might be associated with a particular database
  24612. ** connection. Calling sqlite3DbFree(D,X) for X==0 is a harmless no-op.
  24613. ** The sqlite3DbFreeNN(D,X) version requires that X be non-NULL.
  24614. */
  24615. SQLITE_PRIVATE void sqlite3DbFreeNN(sqlite3 *db, void *p){
  24616. assert( db==0 || sqlite3_mutex_held(db->mutex) );
  24617. assert( p!=0 );
  24618. if( db ){
  24619. if( db->pnBytesFreed ){
  24620. measureAllocationSize(db, p);
  24621. return;
  24622. }
  24623. if( isLookaside(db, p) ){
  24624. LookasideSlot *pBuf = (LookasideSlot*)p;
  24625. #ifdef SQLITE_DEBUG
  24626. /* Trash all content in the buffer being freed */
  24627. memset(p, 0xaa, db->lookaside.sz);
  24628. #endif
  24629. pBuf->pNext = db->lookaside.pFree;
  24630. db->lookaside.pFree = pBuf;
  24631. return;
  24632. }
  24633. }
  24634. assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  24635. assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  24636. assert( db!=0 || sqlite3MemdebugNoType(p, MEMTYPE_LOOKASIDE) );
  24637. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  24638. sqlite3_free(p);
  24639. }
  24640. SQLITE_PRIVATE void sqlite3DbFree(sqlite3 *db, void *p){
  24641. assert( db==0 || sqlite3_mutex_held(db->mutex) );
  24642. if( p ) sqlite3DbFreeNN(db, p);
  24643. }
  24644. /*
  24645. ** Change the size of an existing memory allocation
  24646. */
  24647. SQLITE_PRIVATE void *sqlite3Realloc(void *pOld, u64 nBytes){
  24648. int nOld, nNew, nDiff;
  24649. void *pNew;
  24650. assert( sqlite3MemdebugHasType(pOld, MEMTYPE_HEAP) );
  24651. assert( sqlite3MemdebugNoType(pOld, (u8)~MEMTYPE_HEAP) );
  24652. if( pOld==0 ){
  24653. return sqlite3Malloc(nBytes); /* IMP: R-04300-56712 */
  24654. }
  24655. if( nBytes==0 ){
  24656. sqlite3_free(pOld); /* IMP: R-26507-47431 */
  24657. return 0;
  24658. }
  24659. if( nBytes>=0x7fffff00 ){
  24660. /* The 0x7ffff00 limit term is explained in comments on sqlite3Malloc() */
  24661. return 0;
  24662. }
  24663. nOld = sqlite3MallocSize(pOld);
  24664. /* IMPLEMENTATION-OF: R-46199-30249 SQLite guarantees that the second
  24665. ** argument to xRealloc is always a value returned by a prior call to
  24666. ** xRoundup. */
  24667. nNew = sqlite3GlobalConfig.m.xRoundup((int)nBytes);
  24668. if( nOld==nNew ){
  24669. pNew = pOld;
  24670. }else if( sqlite3GlobalConfig.bMemstat ){
  24671. sqlite3_mutex_enter(mem0.mutex);
  24672. sqlite3StatusHighwater(SQLITE_STATUS_MALLOC_SIZE, (int)nBytes);
  24673. nDiff = nNew - nOld;
  24674. if( nDiff>0 && sqlite3StatusValue(SQLITE_STATUS_MEMORY_USED) >=
  24675. mem0.alarmThreshold-nDiff ){
  24676. sqlite3MallocAlarm(nDiff);
  24677. }
  24678. pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
  24679. if( pNew==0 && mem0.alarmThreshold>0 ){
  24680. sqlite3MallocAlarm((int)nBytes);
  24681. pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
  24682. }
  24683. if( pNew ){
  24684. nNew = sqlite3MallocSize(pNew);
  24685. sqlite3StatusUp(SQLITE_STATUS_MEMORY_USED, nNew-nOld);
  24686. }
  24687. sqlite3_mutex_leave(mem0.mutex);
  24688. }else{
  24689. pNew = sqlite3GlobalConfig.m.xRealloc(pOld, nNew);
  24690. }
  24691. assert( EIGHT_BYTE_ALIGNMENT(pNew) ); /* IMP: R-11148-40995 */
  24692. return pNew;
  24693. }
  24694. /*
  24695. ** The public interface to sqlite3Realloc. Make sure that the memory
  24696. ** subsystem is initialized prior to invoking sqliteRealloc.
  24697. */
  24698. SQLITE_API void *sqlite3_realloc(void *pOld, int n){
  24699. #ifndef SQLITE_OMIT_AUTOINIT
  24700. if( sqlite3_initialize() ) return 0;
  24701. #endif
  24702. if( n<0 ) n = 0; /* IMP: R-26507-47431 */
  24703. return sqlite3Realloc(pOld, n);
  24704. }
  24705. SQLITE_API void *sqlite3_realloc64(void *pOld, sqlite3_uint64 n){
  24706. #ifndef SQLITE_OMIT_AUTOINIT
  24707. if( sqlite3_initialize() ) return 0;
  24708. #endif
  24709. return sqlite3Realloc(pOld, n);
  24710. }
  24711. /*
  24712. ** Allocate and zero memory.
  24713. */
  24714. SQLITE_PRIVATE void *sqlite3MallocZero(u64 n){
  24715. void *p = sqlite3Malloc(n);
  24716. if( p ){
  24717. memset(p, 0, (size_t)n);
  24718. }
  24719. return p;
  24720. }
  24721. /*
  24722. ** Allocate and zero memory. If the allocation fails, make
  24723. ** the mallocFailed flag in the connection pointer.
  24724. */
  24725. SQLITE_PRIVATE void *sqlite3DbMallocZero(sqlite3 *db, u64 n){
  24726. void *p;
  24727. testcase( db==0 );
  24728. p = sqlite3DbMallocRaw(db, n);
  24729. if( p ) memset(p, 0, (size_t)n);
  24730. return p;
  24731. }
  24732. /* Finish the work of sqlite3DbMallocRawNN for the unusual and
  24733. ** slower case when the allocation cannot be fulfilled using lookaside.
  24734. */
  24735. static SQLITE_NOINLINE void *dbMallocRawFinish(sqlite3 *db, u64 n){
  24736. void *p;
  24737. assert( db!=0 );
  24738. p = sqlite3Malloc(n);
  24739. if( !p ) sqlite3OomFault(db);
  24740. sqlite3MemdebugSetType(p,
  24741. (db->lookaside.bDisable==0) ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP);
  24742. return p;
  24743. }
  24744. /*
  24745. ** Allocate memory, either lookaside (if possible) or heap.
  24746. ** If the allocation fails, set the mallocFailed flag in
  24747. ** the connection pointer.
  24748. **
  24749. ** If db!=0 and db->mallocFailed is true (indicating a prior malloc
  24750. ** failure on the same database connection) then always return 0.
  24751. ** Hence for a particular database connection, once malloc starts
  24752. ** failing, it fails consistently until mallocFailed is reset.
  24753. ** This is an important assumption. There are many places in the
  24754. ** code that do things like this:
  24755. **
  24756. ** int *a = (int*)sqlite3DbMallocRaw(db, 100);
  24757. ** int *b = (int*)sqlite3DbMallocRaw(db, 200);
  24758. ** if( b ) a[10] = 9;
  24759. **
  24760. ** In other words, if a subsequent malloc (ex: "b") worked, it is assumed
  24761. ** that all prior mallocs (ex: "a") worked too.
  24762. **
  24763. ** The sqlite3MallocRawNN() variant guarantees that the "db" parameter is
  24764. ** not a NULL pointer.
  24765. */
  24766. SQLITE_PRIVATE void *sqlite3DbMallocRaw(sqlite3 *db, u64 n){
  24767. void *p;
  24768. if( db ) return sqlite3DbMallocRawNN(db, n);
  24769. p = sqlite3Malloc(n);
  24770. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  24771. return p;
  24772. }
  24773. SQLITE_PRIVATE void *sqlite3DbMallocRawNN(sqlite3 *db, u64 n){
  24774. #ifndef SQLITE_OMIT_LOOKASIDE
  24775. LookasideSlot *pBuf;
  24776. assert( db!=0 );
  24777. assert( sqlite3_mutex_held(db->mutex) );
  24778. assert( db->pnBytesFreed==0 );
  24779. if( db->lookaside.bDisable==0 ){
  24780. assert( db->mallocFailed==0 );
  24781. if( n>db->lookaside.sz ){
  24782. db->lookaside.anStat[1]++;
  24783. }else if( (pBuf = db->lookaside.pFree)!=0 ){
  24784. db->lookaside.pFree = pBuf->pNext;
  24785. db->lookaside.anStat[0]++;
  24786. return (void*)pBuf;
  24787. }else if( (pBuf = db->lookaside.pInit)!=0 ){
  24788. db->lookaside.pInit = pBuf->pNext;
  24789. db->lookaside.anStat[0]++;
  24790. return (void*)pBuf;
  24791. }else{
  24792. db->lookaside.anStat[2]++;
  24793. }
  24794. }else if( db->mallocFailed ){
  24795. return 0;
  24796. }
  24797. #else
  24798. assert( db!=0 );
  24799. assert( sqlite3_mutex_held(db->mutex) );
  24800. assert( db->pnBytesFreed==0 );
  24801. if( db->mallocFailed ){
  24802. return 0;
  24803. }
  24804. #endif
  24805. return dbMallocRawFinish(db, n);
  24806. }
  24807. /* Forward declaration */
  24808. static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n);
  24809. /*
  24810. ** Resize the block of memory pointed to by p to n bytes. If the
  24811. ** resize fails, set the mallocFailed flag in the connection object.
  24812. */
  24813. SQLITE_PRIVATE void *sqlite3DbRealloc(sqlite3 *db, void *p, u64 n){
  24814. assert( db!=0 );
  24815. if( p==0 ) return sqlite3DbMallocRawNN(db, n);
  24816. assert( sqlite3_mutex_held(db->mutex) );
  24817. if( isLookaside(db,p) && n<=db->lookaside.sz ) return p;
  24818. return dbReallocFinish(db, p, n);
  24819. }
  24820. static SQLITE_NOINLINE void *dbReallocFinish(sqlite3 *db, void *p, u64 n){
  24821. void *pNew = 0;
  24822. assert( db!=0 );
  24823. assert( p!=0 );
  24824. if( db->mallocFailed==0 ){
  24825. if( isLookaside(db, p) ){
  24826. pNew = sqlite3DbMallocRawNN(db, n);
  24827. if( pNew ){
  24828. memcpy(pNew, p, db->lookaside.sz);
  24829. sqlite3DbFree(db, p);
  24830. }
  24831. }else{
  24832. assert( sqlite3MemdebugHasType(p, (MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  24833. assert( sqlite3MemdebugNoType(p, (u8)~(MEMTYPE_LOOKASIDE|MEMTYPE_HEAP)) );
  24834. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  24835. pNew = sqlite3_realloc64(p, n);
  24836. if( !pNew ){
  24837. sqlite3OomFault(db);
  24838. }
  24839. sqlite3MemdebugSetType(pNew,
  24840. (db->lookaside.bDisable==0 ? MEMTYPE_LOOKASIDE : MEMTYPE_HEAP));
  24841. }
  24842. }
  24843. return pNew;
  24844. }
  24845. /*
  24846. ** Attempt to reallocate p. If the reallocation fails, then free p
  24847. ** and set the mallocFailed flag in the database connection.
  24848. */
  24849. SQLITE_PRIVATE void *sqlite3DbReallocOrFree(sqlite3 *db, void *p, u64 n){
  24850. void *pNew;
  24851. pNew = sqlite3DbRealloc(db, p, n);
  24852. if( !pNew ){
  24853. sqlite3DbFree(db, p);
  24854. }
  24855. return pNew;
  24856. }
  24857. /*
  24858. ** Make a copy of a string in memory obtained from sqliteMalloc(). These
  24859. ** functions call sqlite3MallocRaw() directly instead of sqliteMalloc(). This
  24860. ** is because when memory debugging is turned on, these two functions are
  24861. ** called via macros that record the current file and line number in the
  24862. ** ThreadData structure.
  24863. */
  24864. SQLITE_PRIVATE char *sqlite3DbStrDup(sqlite3 *db, const char *z){
  24865. char *zNew;
  24866. size_t n;
  24867. if( z==0 ){
  24868. return 0;
  24869. }
  24870. n = strlen(z) + 1;
  24871. zNew = sqlite3DbMallocRaw(db, n);
  24872. if( zNew ){
  24873. memcpy(zNew, z, n);
  24874. }
  24875. return zNew;
  24876. }
  24877. SQLITE_PRIVATE char *sqlite3DbStrNDup(sqlite3 *db, const char *z, u64 n){
  24878. char *zNew;
  24879. assert( db!=0 );
  24880. if( z==0 ){
  24881. return 0;
  24882. }
  24883. assert( (n&0x7fffffff)==n );
  24884. zNew = sqlite3DbMallocRawNN(db, n+1);
  24885. if( zNew ){
  24886. memcpy(zNew, z, (size_t)n);
  24887. zNew[n] = 0;
  24888. }
  24889. return zNew;
  24890. }
  24891. /*
  24892. ** The text between zStart and zEnd represents a phrase within a larger
  24893. ** SQL statement. Make a copy of this phrase in space obtained form
  24894. ** sqlite3DbMalloc(). Omit leading and trailing whitespace.
  24895. */
  24896. SQLITE_PRIVATE char *sqlite3DbSpanDup(sqlite3 *db, const char *zStart, const char *zEnd){
  24897. int n;
  24898. while( sqlite3Isspace(zStart[0]) ) zStart++;
  24899. n = (int)(zEnd - zStart);
  24900. while( ALWAYS(n>0) && sqlite3Isspace(zStart[n-1]) ) n--;
  24901. return sqlite3DbStrNDup(db, zStart, n);
  24902. }
  24903. /*
  24904. ** Free any prior content in *pz and replace it with a copy of zNew.
  24905. */
  24906. SQLITE_PRIVATE void sqlite3SetString(char **pz, sqlite3 *db, const char *zNew){
  24907. sqlite3DbFree(db, *pz);
  24908. *pz = sqlite3DbStrDup(db, zNew);
  24909. }
  24910. /*
  24911. ** Call this routine to record the fact that an OOM (out-of-memory) error
  24912. ** has happened. This routine will set db->mallocFailed, and also
  24913. ** temporarily disable the lookaside memory allocator and interrupt
  24914. ** any running VDBEs.
  24915. */
  24916. SQLITE_PRIVATE void sqlite3OomFault(sqlite3 *db){
  24917. if( db->mallocFailed==0 && db->bBenignMalloc==0 ){
  24918. db->mallocFailed = 1;
  24919. if( db->nVdbeExec>0 ){
  24920. db->u1.isInterrupted = 1;
  24921. }
  24922. db->lookaside.bDisable++;
  24923. }
  24924. }
  24925. /*
  24926. ** This routine reactivates the memory allocator and clears the
  24927. ** db->mallocFailed flag as necessary.
  24928. **
  24929. ** The memory allocator is not restarted if there are running
  24930. ** VDBEs.
  24931. */
  24932. SQLITE_PRIVATE void sqlite3OomClear(sqlite3 *db){
  24933. if( db->mallocFailed && db->nVdbeExec==0 ){
  24934. db->mallocFailed = 0;
  24935. db->u1.isInterrupted = 0;
  24936. assert( db->lookaside.bDisable>0 );
  24937. db->lookaside.bDisable--;
  24938. }
  24939. }
  24940. /*
  24941. ** Take actions at the end of an API call to indicate an OOM error
  24942. */
  24943. static SQLITE_NOINLINE int apiOomError(sqlite3 *db){
  24944. sqlite3OomClear(db);
  24945. sqlite3Error(db, SQLITE_NOMEM);
  24946. return SQLITE_NOMEM_BKPT;
  24947. }
  24948. /*
  24949. ** This function must be called before exiting any API function (i.e.
  24950. ** returning control to the user) that has called sqlite3_malloc or
  24951. ** sqlite3_realloc.
  24952. **
  24953. ** The returned value is normally a copy of the second argument to this
  24954. ** function. However, if a malloc() failure has occurred since the previous
  24955. ** invocation SQLITE_NOMEM is returned instead.
  24956. **
  24957. ** If an OOM as occurred, then the connection error-code (the value
  24958. ** returned by sqlite3_errcode()) is set to SQLITE_NOMEM.
  24959. */
  24960. SQLITE_PRIVATE int sqlite3ApiExit(sqlite3* db, int rc){
  24961. /* If the db handle must hold the connection handle mutex here.
  24962. ** Otherwise the read (and possible write) of db->mallocFailed
  24963. ** is unsafe, as is the call to sqlite3Error().
  24964. */
  24965. assert( db!=0 );
  24966. assert( sqlite3_mutex_held(db->mutex) );
  24967. if( db->mallocFailed || rc==SQLITE_IOERR_NOMEM ){
  24968. return apiOomError(db);
  24969. }
  24970. return rc & db->errMask;
  24971. }
  24972. /************** End of malloc.c **********************************************/
  24973. /************** Begin file printf.c ******************************************/
  24974. /*
  24975. ** The "printf" code that follows dates from the 1980's. It is in
  24976. ** the public domain.
  24977. **
  24978. **************************************************************************
  24979. **
  24980. ** This file contains code for a set of "printf"-like routines. These
  24981. ** routines format strings much like the printf() from the standard C
  24982. ** library, though the implementation here has enhancements to support
  24983. ** SQLite.
  24984. */
  24985. /* #include "sqliteInt.h" */
  24986. /*
  24987. ** Conversion types fall into various categories as defined by the
  24988. ** following enumeration.
  24989. */
  24990. #define etRADIX 0 /* non-decimal integer types. %x %o */
  24991. #define etFLOAT 1 /* Floating point. %f */
  24992. #define etEXP 2 /* Exponentional notation. %e and %E */
  24993. #define etGENERIC 3 /* Floating or exponential, depending on exponent. %g */
  24994. #define etSIZE 4 /* Return number of characters processed so far. %n */
  24995. #define etSTRING 5 /* Strings. %s */
  24996. #define etDYNSTRING 6 /* Dynamically allocated strings. %z */
  24997. #define etPERCENT 7 /* Percent symbol. %% */
  24998. #define etCHARX 8 /* Characters. %c */
  24999. /* The rest are extensions, not normally found in printf() */
  25000. #define etSQLESCAPE 9 /* Strings with '\'' doubled. %q */
  25001. #define etSQLESCAPE2 10 /* Strings with '\'' doubled and enclosed in '',
  25002. NULL pointers replaced by SQL NULL. %Q */
  25003. #define etTOKEN 11 /* a pointer to a Token structure */
  25004. #define etSRCLIST 12 /* a pointer to a SrcList */
  25005. #define etPOINTER 13 /* The %p conversion */
  25006. #define etSQLESCAPE3 14 /* %w -> Strings with '\"' doubled */
  25007. #define etORDINAL 15 /* %r -> 1st, 2nd, 3rd, 4th, etc. English only */
  25008. #define etDECIMAL 16 /* %d or %u, but not %x, %o */
  25009. #define etINVALID 17 /* Any unrecognized conversion type */
  25010. /*
  25011. ** An "etByte" is an 8-bit unsigned value.
  25012. */
  25013. typedef unsigned char etByte;
  25014. /*
  25015. ** Each builtin conversion character (ex: the 'd' in "%d") is described
  25016. ** by an instance of the following structure
  25017. */
  25018. typedef struct et_info { /* Information about each format field */
  25019. char fmttype; /* The format field code letter */
  25020. etByte base; /* The base for radix conversion */
  25021. etByte flags; /* One or more of FLAG_ constants below */
  25022. etByte type; /* Conversion paradigm */
  25023. etByte charset; /* Offset into aDigits[] of the digits string */
  25024. etByte prefix; /* Offset into aPrefix[] of the prefix string */
  25025. } et_info;
  25026. /*
  25027. ** Allowed values for et_info.flags
  25028. */
  25029. #define FLAG_SIGNED 1 /* True if the value to convert is signed */
  25030. #define FLAG_STRING 4 /* Allow infinite precision */
  25031. /*
  25032. ** The following table is searched linearly, so it is good to put the
  25033. ** most frequently used conversion types first.
  25034. */
  25035. static const char aDigits[] = "0123456789ABCDEF0123456789abcdef";
  25036. static const char aPrefix[] = "-x0\000X0";
  25037. static const et_info fmtinfo[] = {
  25038. { 'd', 10, 1, etDECIMAL, 0, 0 },
  25039. { 's', 0, 4, etSTRING, 0, 0 },
  25040. { 'g', 0, 1, etGENERIC, 30, 0 },
  25041. { 'z', 0, 4, etDYNSTRING, 0, 0 },
  25042. { 'q', 0, 4, etSQLESCAPE, 0, 0 },
  25043. { 'Q', 0, 4, etSQLESCAPE2, 0, 0 },
  25044. { 'w', 0, 4, etSQLESCAPE3, 0, 0 },
  25045. { 'c', 0, 0, etCHARX, 0, 0 },
  25046. { 'o', 8, 0, etRADIX, 0, 2 },
  25047. { 'u', 10, 0, etDECIMAL, 0, 0 },
  25048. { 'x', 16, 0, etRADIX, 16, 1 },
  25049. { 'X', 16, 0, etRADIX, 0, 4 },
  25050. #ifndef SQLITE_OMIT_FLOATING_POINT
  25051. { 'f', 0, 1, etFLOAT, 0, 0 },
  25052. { 'e', 0, 1, etEXP, 30, 0 },
  25053. { 'E', 0, 1, etEXP, 14, 0 },
  25054. { 'G', 0, 1, etGENERIC, 14, 0 },
  25055. #endif
  25056. { 'i', 10, 1, etDECIMAL, 0, 0 },
  25057. { 'n', 0, 0, etSIZE, 0, 0 },
  25058. { '%', 0, 0, etPERCENT, 0, 0 },
  25059. { 'p', 16, 0, etPOINTER, 0, 1 },
  25060. /* All the rest are undocumented and are for internal use only */
  25061. { 'T', 0, 0, etTOKEN, 0, 0 },
  25062. { 'S', 0, 0, etSRCLIST, 0, 0 },
  25063. { 'r', 10, 1, etORDINAL, 0, 0 },
  25064. };
  25065. /*
  25066. ** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point
  25067. ** conversions will work.
  25068. */
  25069. #ifndef SQLITE_OMIT_FLOATING_POINT
  25070. /*
  25071. ** "*val" is a double such that 0.1 <= *val < 10.0
  25072. ** Return the ascii code for the leading digit of *val, then
  25073. ** multiply "*val" by 10.0 to renormalize.
  25074. **
  25075. ** Example:
  25076. ** input: *val = 3.14159
  25077. ** output: *val = 1.4159 function return = '3'
  25078. **
  25079. ** The counter *cnt is incremented each time. After counter exceeds
  25080. ** 16 (the number of significant digits in a 64-bit float) '0' is
  25081. ** always returned.
  25082. */
  25083. static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){
  25084. int digit;
  25085. LONGDOUBLE_TYPE d;
  25086. if( (*cnt)<=0 ) return '0';
  25087. (*cnt)--;
  25088. digit = (int)*val;
  25089. d = digit;
  25090. digit += '0';
  25091. *val = (*val - d)*10.0;
  25092. return (char)digit;
  25093. }
  25094. #endif /* SQLITE_OMIT_FLOATING_POINT */
  25095. /*
  25096. ** Set the StrAccum object to an error mode.
  25097. */
  25098. static void setStrAccumError(StrAccum *p, u8 eError){
  25099. assert( eError==STRACCUM_NOMEM || eError==STRACCUM_TOOBIG );
  25100. p->accError = eError;
  25101. p->nAlloc = 0;
  25102. }
  25103. /*
  25104. ** Extra argument values from a PrintfArguments object
  25105. */
  25106. static sqlite3_int64 getIntArg(PrintfArguments *p){
  25107. if( p->nArg<=p->nUsed ) return 0;
  25108. return sqlite3_value_int64(p->apArg[p->nUsed++]);
  25109. }
  25110. static double getDoubleArg(PrintfArguments *p){
  25111. if( p->nArg<=p->nUsed ) return 0.0;
  25112. return sqlite3_value_double(p->apArg[p->nUsed++]);
  25113. }
  25114. static char *getTextArg(PrintfArguments *p){
  25115. if( p->nArg<=p->nUsed ) return 0;
  25116. return (char*)sqlite3_value_text(p->apArg[p->nUsed++]);
  25117. }
  25118. /*
  25119. ** On machines with a small stack size, you can redefine the
  25120. ** SQLITE_PRINT_BUF_SIZE to be something smaller, if desired.
  25121. */
  25122. #ifndef SQLITE_PRINT_BUF_SIZE
  25123. # define SQLITE_PRINT_BUF_SIZE 70
  25124. #endif
  25125. #define etBUFSIZE SQLITE_PRINT_BUF_SIZE /* Size of the output buffer */
  25126. /*
  25127. ** Render a string given by "fmt" into the StrAccum object.
  25128. */
  25129. SQLITE_PRIVATE void sqlite3VXPrintf(
  25130. StrAccum *pAccum, /* Accumulate results here */
  25131. const char *fmt, /* Format string */
  25132. va_list ap /* arguments */
  25133. ){
  25134. int c; /* Next character in the format string */
  25135. char *bufpt; /* Pointer to the conversion buffer */
  25136. int precision; /* Precision of the current field */
  25137. int length; /* Length of the field */
  25138. int idx; /* A general purpose loop counter */
  25139. int width; /* Width of the current field */
  25140. etByte flag_leftjustify; /* True if "-" flag is present */
  25141. etByte flag_prefix; /* '+' or ' ' or 0 for prefix */
  25142. etByte flag_alternateform; /* True if "#" flag is present */
  25143. etByte flag_altform2; /* True if "!" flag is present */
  25144. etByte flag_zeropad; /* True if field width constant starts with zero */
  25145. etByte flag_long; /* 1 for the "l" flag, 2 for "ll", 0 by default */
  25146. etByte done; /* Loop termination flag */
  25147. etByte cThousand; /* Thousands separator for %d and %u */
  25148. etByte xtype = etINVALID; /* Conversion paradigm */
  25149. u8 bArgList; /* True for SQLITE_PRINTF_SQLFUNC */
  25150. char prefix; /* Prefix character. "+" or "-" or " " or '\0'. */
  25151. sqlite_uint64 longvalue; /* Value for integer types */
  25152. LONGDOUBLE_TYPE realvalue; /* Value for real types */
  25153. const et_info *infop; /* Pointer to the appropriate info structure */
  25154. char *zOut; /* Rendering buffer */
  25155. int nOut; /* Size of the rendering buffer */
  25156. char *zExtra = 0; /* Malloced memory used by some conversion */
  25157. #ifndef SQLITE_OMIT_FLOATING_POINT
  25158. int exp, e2; /* exponent of real numbers */
  25159. int nsd; /* Number of significant digits returned */
  25160. double rounder; /* Used for rounding floating point values */
  25161. etByte flag_dp; /* True if decimal point should be shown */
  25162. etByte flag_rtz; /* True if trailing zeros should be removed */
  25163. #endif
  25164. PrintfArguments *pArgList = 0; /* Arguments for SQLITE_PRINTF_SQLFUNC */
  25165. char buf[etBUFSIZE]; /* Conversion buffer */
  25166. /* pAccum never starts out with an empty buffer that was obtained from
  25167. ** malloc(). This precondition is required by the mprintf("%z...")
  25168. ** optimization. */
  25169. assert( pAccum->nChar>0 || (pAccum->printfFlags&SQLITE_PRINTF_MALLOCED)==0 );
  25170. bufpt = 0;
  25171. if( (pAccum->printfFlags & SQLITE_PRINTF_SQLFUNC)!=0 ){
  25172. pArgList = va_arg(ap, PrintfArguments*);
  25173. bArgList = 1;
  25174. }else{
  25175. bArgList = 0;
  25176. }
  25177. for(; (c=(*fmt))!=0; ++fmt){
  25178. if( c!='%' ){
  25179. bufpt = (char *)fmt;
  25180. #if HAVE_STRCHRNUL
  25181. fmt = strchrnul(fmt, '%');
  25182. #else
  25183. do{ fmt++; }while( *fmt && *fmt != '%' );
  25184. #endif
  25185. sqlite3StrAccumAppend(pAccum, bufpt, (int)(fmt - bufpt));
  25186. if( *fmt==0 ) break;
  25187. }
  25188. if( (c=(*++fmt))==0 ){
  25189. sqlite3StrAccumAppend(pAccum, "%", 1);
  25190. break;
  25191. }
  25192. /* Find out what flags are present */
  25193. flag_leftjustify = flag_prefix = cThousand =
  25194. flag_alternateform = flag_altform2 = flag_zeropad = 0;
  25195. done = 0;
  25196. do{
  25197. switch( c ){
  25198. case '-': flag_leftjustify = 1; break;
  25199. case '+': flag_prefix = '+'; break;
  25200. case ' ': flag_prefix = ' '; break;
  25201. case '#': flag_alternateform = 1; break;
  25202. case '!': flag_altform2 = 1; break;
  25203. case '0': flag_zeropad = 1; break;
  25204. case ',': cThousand = ','; break;
  25205. default: done = 1; break;
  25206. }
  25207. }while( !done && (c=(*++fmt))!=0 );
  25208. /* Get the field width */
  25209. if( c=='*' ){
  25210. if( bArgList ){
  25211. width = (int)getIntArg(pArgList);
  25212. }else{
  25213. width = va_arg(ap,int);
  25214. }
  25215. if( width<0 ){
  25216. flag_leftjustify = 1;
  25217. width = width >= -2147483647 ? -width : 0;
  25218. }
  25219. c = *++fmt;
  25220. }else{
  25221. unsigned wx = 0;
  25222. while( c>='0' && c<='9' ){
  25223. wx = wx*10 + c - '0';
  25224. c = *++fmt;
  25225. }
  25226. testcase( wx>0x7fffffff );
  25227. width = wx & 0x7fffffff;
  25228. }
  25229. assert( width>=0 );
  25230. #ifdef SQLITE_PRINTF_PRECISION_LIMIT
  25231. if( width>SQLITE_PRINTF_PRECISION_LIMIT ){
  25232. width = SQLITE_PRINTF_PRECISION_LIMIT;
  25233. }
  25234. #endif
  25235. /* Get the precision */
  25236. if( c=='.' ){
  25237. c = *++fmt;
  25238. if( c=='*' ){
  25239. if( bArgList ){
  25240. precision = (int)getIntArg(pArgList);
  25241. }else{
  25242. precision = va_arg(ap,int);
  25243. }
  25244. c = *++fmt;
  25245. if( precision<0 ){
  25246. precision = precision >= -2147483647 ? -precision : -1;
  25247. }
  25248. }else{
  25249. unsigned px = 0;
  25250. while( c>='0' && c<='9' ){
  25251. px = px*10 + c - '0';
  25252. c = *++fmt;
  25253. }
  25254. testcase( px>0x7fffffff );
  25255. precision = px & 0x7fffffff;
  25256. }
  25257. }else{
  25258. precision = -1;
  25259. }
  25260. assert( precision>=(-1) );
  25261. #ifdef SQLITE_PRINTF_PRECISION_LIMIT
  25262. if( precision>SQLITE_PRINTF_PRECISION_LIMIT ){
  25263. precision = SQLITE_PRINTF_PRECISION_LIMIT;
  25264. }
  25265. #endif
  25266. /* Get the conversion type modifier */
  25267. if( c=='l' ){
  25268. flag_long = 1;
  25269. c = *++fmt;
  25270. if( c=='l' ){
  25271. flag_long = 2;
  25272. c = *++fmt;
  25273. }
  25274. }else{
  25275. flag_long = 0;
  25276. }
  25277. /* Fetch the info entry for the field */
  25278. infop = &fmtinfo[0];
  25279. xtype = etINVALID;
  25280. for(idx=0; idx<ArraySize(fmtinfo); idx++){
  25281. if( c==fmtinfo[idx].fmttype ){
  25282. infop = &fmtinfo[idx];
  25283. xtype = infop->type;
  25284. break;
  25285. }
  25286. }
  25287. /*
  25288. ** At this point, variables are initialized as follows:
  25289. **
  25290. ** flag_alternateform TRUE if a '#' is present.
  25291. ** flag_altform2 TRUE if a '!' is present.
  25292. ** flag_prefix '+' or ' ' or zero
  25293. ** flag_leftjustify TRUE if a '-' is present or if the
  25294. ** field width was negative.
  25295. ** flag_zeropad TRUE if the width began with 0.
  25296. ** flag_long 1 for "l", 2 for "ll"
  25297. ** width The specified field width. This is
  25298. ** always non-negative. Zero is the default.
  25299. ** precision The specified precision. The default
  25300. ** is -1.
  25301. ** xtype The class of the conversion.
  25302. ** infop Pointer to the appropriate info struct.
  25303. */
  25304. switch( xtype ){
  25305. case etPOINTER:
  25306. flag_long = sizeof(char*)==sizeof(i64) ? 2 :
  25307. sizeof(char*)==sizeof(long int) ? 1 : 0;
  25308. /* Fall through into the next case */
  25309. case etORDINAL:
  25310. case etRADIX:
  25311. cThousand = 0;
  25312. /* Fall through into the next case */
  25313. case etDECIMAL:
  25314. if( infop->flags & FLAG_SIGNED ){
  25315. i64 v;
  25316. if( bArgList ){
  25317. v = getIntArg(pArgList);
  25318. }else if( flag_long ){
  25319. if( flag_long==2 ){
  25320. v = va_arg(ap,i64) ;
  25321. }else{
  25322. v = va_arg(ap,long int);
  25323. }
  25324. }else{
  25325. v = va_arg(ap,int);
  25326. }
  25327. if( v<0 ){
  25328. if( v==SMALLEST_INT64 ){
  25329. longvalue = ((u64)1)<<63;
  25330. }else{
  25331. longvalue = -v;
  25332. }
  25333. prefix = '-';
  25334. }else{
  25335. longvalue = v;
  25336. prefix = flag_prefix;
  25337. }
  25338. }else{
  25339. if( bArgList ){
  25340. longvalue = (u64)getIntArg(pArgList);
  25341. }else if( flag_long ){
  25342. if( flag_long==2 ){
  25343. longvalue = va_arg(ap,u64);
  25344. }else{
  25345. longvalue = va_arg(ap,unsigned long int);
  25346. }
  25347. }else{
  25348. longvalue = va_arg(ap,unsigned int);
  25349. }
  25350. prefix = 0;
  25351. }
  25352. if( longvalue==0 ) flag_alternateform = 0;
  25353. if( flag_zeropad && precision<width-(prefix!=0) ){
  25354. precision = width-(prefix!=0);
  25355. }
  25356. if( precision<etBUFSIZE-10-etBUFSIZE/3 ){
  25357. nOut = etBUFSIZE;
  25358. zOut = buf;
  25359. }else{
  25360. u64 n = (u64)precision + 10 + precision/3;
  25361. zOut = zExtra = sqlite3Malloc( n );
  25362. if( zOut==0 ){
  25363. setStrAccumError(pAccum, STRACCUM_NOMEM);
  25364. return;
  25365. }
  25366. nOut = (int)n;
  25367. }
  25368. bufpt = &zOut[nOut-1];
  25369. if( xtype==etORDINAL ){
  25370. static const char zOrd[] = "thstndrd";
  25371. int x = (int)(longvalue % 10);
  25372. if( x>=4 || (longvalue/10)%10==1 ){
  25373. x = 0;
  25374. }
  25375. *(--bufpt) = zOrd[x*2+1];
  25376. *(--bufpt) = zOrd[x*2];
  25377. }
  25378. {
  25379. const char *cset = &aDigits[infop->charset];
  25380. u8 base = infop->base;
  25381. do{ /* Convert to ascii */
  25382. *(--bufpt) = cset[longvalue%base];
  25383. longvalue = longvalue/base;
  25384. }while( longvalue>0 );
  25385. }
  25386. length = (int)(&zOut[nOut-1]-bufpt);
  25387. while( precision>length ){
  25388. *(--bufpt) = '0'; /* Zero pad */
  25389. length++;
  25390. }
  25391. if( cThousand ){
  25392. int nn = (length - 1)/3; /* Number of "," to insert */
  25393. int ix = (length - 1)%3 + 1;
  25394. bufpt -= nn;
  25395. for(idx=0; nn>0; idx++){
  25396. bufpt[idx] = bufpt[idx+nn];
  25397. ix--;
  25398. if( ix==0 ){
  25399. bufpt[++idx] = cThousand;
  25400. nn--;
  25401. ix = 3;
  25402. }
  25403. }
  25404. }
  25405. if( prefix ) *(--bufpt) = prefix; /* Add sign */
  25406. if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */
  25407. const char *pre;
  25408. char x;
  25409. pre = &aPrefix[infop->prefix];
  25410. for(; (x=(*pre))!=0; pre++) *(--bufpt) = x;
  25411. }
  25412. length = (int)(&zOut[nOut-1]-bufpt);
  25413. break;
  25414. case etFLOAT:
  25415. case etEXP:
  25416. case etGENERIC:
  25417. if( bArgList ){
  25418. realvalue = getDoubleArg(pArgList);
  25419. }else{
  25420. realvalue = va_arg(ap,double);
  25421. }
  25422. #ifdef SQLITE_OMIT_FLOATING_POINT
  25423. length = 0;
  25424. #else
  25425. if( precision<0 ) precision = 6; /* Set default precision */
  25426. if( realvalue<0.0 ){
  25427. realvalue = -realvalue;
  25428. prefix = '-';
  25429. }else{
  25430. prefix = flag_prefix;
  25431. }
  25432. if( xtype==etGENERIC && precision>0 ) precision--;
  25433. testcase( precision>0xfff );
  25434. for(idx=precision&0xfff, rounder=0.5; idx>0; idx--, rounder*=0.1){}
  25435. if( xtype==etFLOAT ) realvalue += rounder;
  25436. /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */
  25437. exp = 0;
  25438. if( sqlite3IsNaN((double)realvalue) ){
  25439. bufpt = "NaN";
  25440. length = 3;
  25441. break;
  25442. }
  25443. if( realvalue>0.0 ){
  25444. LONGDOUBLE_TYPE scale = 1.0;
  25445. while( realvalue>=1e100*scale && exp<=350 ){ scale *= 1e100;exp+=100;}
  25446. while( realvalue>=1e10*scale && exp<=350 ){ scale *= 1e10; exp+=10; }
  25447. while( realvalue>=10.0*scale && exp<=350 ){ scale *= 10.0; exp++; }
  25448. realvalue /= scale;
  25449. while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; }
  25450. while( realvalue<1.0 ){ realvalue *= 10.0; exp--; }
  25451. if( exp>350 ){
  25452. bufpt = buf;
  25453. buf[0] = prefix;
  25454. memcpy(buf+(prefix!=0),"Inf",4);
  25455. length = 3+(prefix!=0);
  25456. break;
  25457. }
  25458. }
  25459. bufpt = buf;
  25460. /*
  25461. ** If the field type is etGENERIC, then convert to either etEXP
  25462. ** or etFLOAT, as appropriate.
  25463. */
  25464. if( xtype!=etFLOAT ){
  25465. realvalue += rounder;
  25466. if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; }
  25467. }
  25468. if( xtype==etGENERIC ){
  25469. flag_rtz = !flag_alternateform;
  25470. if( exp<-4 || exp>precision ){
  25471. xtype = etEXP;
  25472. }else{
  25473. precision = precision - exp;
  25474. xtype = etFLOAT;
  25475. }
  25476. }else{
  25477. flag_rtz = flag_altform2;
  25478. }
  25479. if( xtype==etEXP ){
  25480. e2 = 0;
  25481. }else{
  25482. e2 = exp;
  25483. }
  25484. if( MAX(e2,0)+(i64)precision+(i64)width > etBUFSIZE - 15 ){
  25485. bufpt = zExtra
  25486. = sqlite3Malloc( MAX(e2,0)+(i64)precision+(i64)width+15 );
  25487. if( bufpt==0 ){
  25488. setStrAccumError(pAccum, STRACCUM_NOMEM);
  25489. return;
  25490. }
  25491. }
  25492. zOut = bufpt;
  25493. nsd = 16 + flag_altform2*10;
  25494. flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2;
  25495. /* The sign in front of the number */
  25496. if( prefix ){
  25497. *(bufpt++) = prefix;
  25498. }
  25499. /* Digits prior to the decimal point */
  25500. if( e2<0 ){
  25501. *(bufpt++) = '0';
  25502. }else{
  25503. for(; e2>=0; e2--){
  25504. *(bufpt++) = et_getdigit(&realvalue,&nsd);
  25505. }
  25506. }
  25507. /* The decimal point */
  25508. if( flag_dp ){
  25509. *(bufpt++) = '.';
  25510. }
  25511. /* "0" digits after the decimal point but before the first
  25512. ** significant digit of the number */
  25513. for(e2++; e2<0; precision--, e2++){
  25514. assert( precision>0 );
  25515. *(bufpt++) = '0';
  25516. }
  25517. /* Significant digits after the decimal point */
  25518. while( (precision--)>0 ){
  25519. *(bufpt++) = et_getdigit(&realvalue,&nsd);
  25520. }
  25521. /* Remove trailing zeros and the "." if no digits follow the "." */
  25522. if( flag_rtz && flag_dp ){
  25523. while( bufpt[-1]=='0' ) *(--bufpt) = 0;
  25524. assert( bufpt>zOut );
  25525. if( bufpt[-1]=='.' ){
  25526. if( flag_altform2 ){
  25527. *(bufpt++) = '0';
  25528. }else{
  25529. *(--bufpt) = 0;
  25530. }
  25531. }
  25532. }
  25533. /* Add the "eNNN" suffix */
  25534. if( xtype==etEXP ){
  25535. *(bufpt++) = aDigits[infop->charset];
  25536. if( exp<0 ){
  25537. *(bufpt++) = '-'; exp = -exp;
  25538. }else{
  25539. *(bufpt++) = '+';
  25540. }
  25541. if( exp>=100 ){
  25542. *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */
  25543. exp %= 100;
  25544. }
  25545. *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */
  25546. *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */
  25547. }
  25548. *bufpt = 0;
  25549. /* The converted number is in buf[] and zero terminated. Output it.
  25550. ** Note that the number is in the usual order, not reversed as with
  25551. ** integer conversions. */
  25552. length = (int)(bufpt-zOut);
  25553. bufpt = zOut;
  25554. /* Special case: Add leading zeros if the flag_zeropad flag is
  25555. ** set and we are not left justified */
  25556. if( flag_zeropad && !flag_leftjustify && length < width){
  25557. int i;
  25558. int nPad = width - length;
  25559. for(i=width; i>=nPad; i--){
  25560. bufpt[i] = bufpt[i-nPad];
  25561. }
  25562. i = prefix!=0;
  25563. while( nPad-- ) bufpt[i++] = '0';
  25564. length = width;
  25565. }
  25566. #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */
  25567. break;
  25568. case etSIZE:
  25569. if( !bArgList ){
  25570. *(va_arg(ap,int*)) = pAccum->nChar;
  25571. }
  25572. length = width = 0;
  25573. break;
  25574. case etPERCENT:
  25575. buf[0] = '%';
  25576. bufpt = buf;
  25577. length = 1;
  25578. break;
  25579. case etCHARX:
  25580. if( bArgList ){
  25581. bufpt = getTextArg(pArgList);
  25582. length = 1;
  25583. if( bufpt ){
  25584. buf[0] = c = *(bufpt++);
  25585. if( (c&0xc0)==0xc0 ){
  25586. while( length<4 && (bufpt[0]&0xc0)==0x80 ){
  25587. buf[length++] = *(bufpt++);
  25588. }
  25589. }
  25590. }else{
  25591. buf[0] = 0;
  25592. }
  25593. }else{
  25594. unsigned int ch = va_arg(ap,unsigned int);
  25595. if( ch<0x00080 ){
  25596. buf[0] = ch & 0xff;
  25597. length = 1;
  25598. }else if( ch<0x00800 ){
  25599. buf[0] = 0xc0 + (u8)((ch>>6)&0x1f);
  25600. buf[1] = 0x80 + (u8)(ch & 0x3f);
  25601. length = 2;
  25602. }else if( ch<0x10000 ){
  25603. buf[0] = 0xe0 + (u8)((ch>>12)&0x0f);
  25604. buf[1] = 0x80 + (u8)((ch>>6) & 0x3f);
  25605. buf[2] = 0x80 + (u8)(ch & 0x3f);
  25606. length = 3;
  25607. }else{
  25608. buf[0] = 0xf0 + (u8)((ch>>18) & 0x07);
  25609. buf[1] = 0x80 + (u8)((ch>>12) & 0x3f);
  25610. buf[2] = 0x80 + (u8)((ch>>6) & 0x3f);
  25611. buf[3] = 0x80 + (u8)(ch & 0x3f);
  25612. length = 4;
  25613. }
  25614. }
  25615. if( precision>1 ){
  25616. width -= precision-1;
  25617. if( width>1 && !flag_leftjustify ){
  25618. sqlite3AppendChar(pAccum, width-1, ' ');
  25619. width = 0;
  25620. }
  25621. while( precision-- > 1 ){
  25622. sqlite3StrAccumAppend(pAccum, buf, length);
  25623. }
  25624. }
  25625. bufpt = buf;
  25626. flag_altform2 = 1;
  25627. goto adjust_width_for_utf8;
  25628. case etSTRING:
  25629. case etDYNSTRING:
  25630. if( bArgList ){
  25631. bufpt = getTextArg(pArgList);
  25632. xtype = etSTRING;
  25633. }else{
  25634. bufpt = va_arg(ap,char*);
  25635. }
  25636. if( bufpt==0 ){
  25637. bufpt = "";
  25638. }else if( xtype==etDYNSTRING ){
  25639. if( pAccum->nChar==0 && pAccum->mxAlloc && width==0 && precision<0 ){
  25640. /* Special optimization for sqlite3_mprintf("%z..."):
  25641. ** Extend an existing memory allocation rather than creating
  25642. ** a new one. */
  25643. assert( (pAccum->printfFlags&SQLITE_PRINTF_MALLOCED)==0 );
  25644. pAccum->zText = bufpt;
  25645. pAccum->nAlloc = sqlite3DbMallocSize(pAccum->db, bufpt);
  25646. pAccum->nChar = 0x7fffffff & (int)strlen(bufpt);
  25647. pAccum->printfFlags |= SQLITE_PRINTF_MALLOCED;
  25648. length = 0;
  25649. break;
  25650. }
  25651. zExtra = bufpt;
  25652. }
  25653. if( precision>=0 ){
  25654. if( flag_altform2 ){
  25655. /* Set length to the number of bytes needed in order to display
  25656. ** precision characters */
  25657. unsigned char *z = (unsigned char*)bufpt;
  25658. while( precision-- > 0 && z[0] ){
  25659. SQLITE_SKIP_UTF8(z);
  25660. }
  25661. length = (int)(z - (unsigned char*)bufpt);
  25662. }else{
  25663. for(length=0; length<precision && bufpt[length]; length++){}
  25664. }
  25665. }else{
  25666. length = 0x7fffffff & (int)strlen(bufpt);
  25667. }
  25668. adjust_width_for_utf8:
  25669. if( flag_altform2 && width>0 ){
  25670. /* Adjust width to account for extra bytes in UTF-8 characters */
  25671. int ii = length - 1;
  25672. while( ii>=0 ) if( (bufpt[ii--] & 0xc0)==0x80 ) width++;
  25673. }
  25674. break;
  25675. case etSQLESCAPE: /* %q: Escape ' characters */
  25676. case etSQLESCAPE2: /* %Q: Escape ' and enclose in '...' */
  25677. case etSQLESCAPE3: { /* %w: Escape " characters */
  25678. int i, j, k, n, isnull;
  25679. int needQuote;
  25680. char ch;
  25681. char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */
  25682. char *escarg;
  25683. if( bArgList ){
  25684. escarg = getTextArg(pArgList);
  25685. }else{
  25686. escarg = va_arg(ap,char*);
  25687. }
  25688. isnull = escarg==0;
  25689. if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)");
  25690. /* For %q, %Q, and %w, the precision is the number of byte (or
  25691. ** characters if the ! flags is present) to use from the input.
  25692. ** Because of the extra quoting characters inserted, the number
  25693. ** of output characters may be larger than the precision.
  25694. */
  25695. k = precision;
  25696. for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){
  25697. if( ch==q ) n++;
  25698. if( flag_altform2 && (ch&0xc0)==0xc0 ){
  25699. while( (escarg[i+1]&0xc0)==0x80 ){ i++; }
  25700. }
  25701. }
  25702. needQuote = !isnull && xtype==etSQLESCAPE2;
  25703. n += i + 3;
  25704. if( n>etBUFSIZE ){
  25705. bufpt = zExtra = sqlite3Malloc( n );
  25706. if( bufpt==0 ){
  25707. setStrAccumError(pAccum, STRACCUM_NOMEM);
  25708. return;
  25709. }
  25710. }else{
  25711. bufpt = buf;
  25712. }
  25713. j = 0;
  25714. if( needQuote ) bufpt[j++] = q;
  25715. k = i;
  25716. for(i=0; i<k; i++){
  25717. bufpt[j++] = ch = escarg[i];
  25718. if( ch==q ) bufpt[j++] = ch;
  25719. }
  25720. if( needQuote ) bufpt[j++] = q;
  25721. bufpt[j] = 0;
  25722. length = j;
  25723. goto adjust_width_for_utf8;
  25724. }
  25725. case etTOKEN: {
  25726. Token *pToken;
  25727. if( (pAccum->printfFlags & SQLITE_PRINTF_INTERNAL)==0 ) return;
  25728. pToken = va_arg(ap, Token*);
  25729. assert( bArgList==0 );
  25730. if( pToken && pToken->n ){
  25731. sqlite3StrAccumAppend(pAccum, (const char*)pToken->z, pToken->n);
  25732. }
  25733. length = width = 0;
  25734. break;
  25735. }
  25736. case etSRCLIST: {
  25737. SrcList *pSrc;
  25738. int k;
  25739. struct SrcList_item *pItem;
  25740. if( (pAccum->printfFlags & SQLITE_PRINTF_INTERNAL)==0 ) return;
  25741. pSrc = va_arg(ap, SrcList*);
  25742. k = va_arg(ap, int);
  25743. pItem = &pSrc->a[k];
  25744. assert( bArgList==0 );
  25745. assert( k>=0 && k<pSrc->nSrc );
  25746. if( pItem->zDatabase ){
  25747. sqlite3StrAccumAppendAll(pAccum, pItem->zDatabase);
  25748. sqlite3StrAccumAppend(pAccum, ".", 1);
  25749. }
  25750. sqlite3StrAccumAppendAll(pAccum, pItem->zName);
  25751. length = width = 0;
  25752. break;
  25753. }
  25754. default: {
  25755. assert( xtype==etINVALID );
  25756. return;
  25757. }
  25758. }/* End switch over the format type */
  25759. /*
  25760. ** The text of the conversion is pointed to by "bufpt" and is
  25761. ** "length" characters long. The field width is "width". Do
  25762. ** the output. Both length and width are in bytes, not characters,
  25763. ** at this point. If the "!" flag was present on string conversions
  25764. ** indicating that width and precision should be expressed in characters,
  25765. ** then the values have been translated prior to reaching this point.
  25766. */
  25767. width -= length;
  25768. if( width>0 ){
  25769. if( !flag_leftjustify ) sqlite3AppendChar(pAccum, width, ' ');
  25770. sqlite3StrAccumAppend(pAccum, bufpt, length);
  25771. if( flag_leftjustify ) sqlite3AppendChar(pAccum, width, ' ');
  25772. }else{
  25773. sqlite3StrAccumAppend(pAccum, bufpt, length);
  25774. }
  25775. if( zExtra ){
  25776. sqlite3DbFree(pAccum->db, zExtra);
  25777. zExtra = 0;
  25778. }
  25779. }/* End for loop over the format string */
  25780. } /* End of function */
  25781. /*
  25782. ** Enlarge the memory allocation on a StrAccum object so that it is
  25783. ** able to accept at least N more bytes of text.
  25784. **
  25785. ** Return the number of bytes of text that StrAccum is able to accept
  25786. ** after the attempted enlargement. The value returned might be zero.
  25787. */
  25788. static int sqlite3StrAccumEnlarge(StrAccum *p, int N){
  25789. char *zNew;
  25790. assert( p->nChar+(i64)N >= p->nAlloc ); /* Only called if really needed */
  25791. if( p->accError ){
  25792. testcase(p->accError==STRACCUM_TOOBIG);
  25793. testcase(p->accError==STRACCUM_NOMEM);
  25794. return 0;
  25795. }
  25796. if( p->mxAlloc==0 ){
  25797. N = p->nAlloc - p->nChar - 1;
  25798. setStrAccumError(p, STRACCUM_TOOBIG);
  25799. return N;
  25800. }else{
  25801. char *zOld = isMalloced(p) ? p->zText : 0;
  25802. i64 szNew = p->nChar;
  25803. szNew += N + 1;
  25804. if( szNew+p->nChar<=p->mxAlloc ){
  25805. /* Force exponential buffer size growth as long as it does not overflow,
  25806. ** to avoid having to call this routine too often */
  25807. szNew += p->nChar;
  25808. }
  25809. if( szNew > p->mxAlloc ){
  25810. sqlite3StrAccumReset(p);
  25811. setStrAccumError(p, STRACCUM_TOOBIG);
  25812. return 0;
  25813. }else{
  25814. p->nAlloc = (int)szNew;
  25815. }
  25816. if( p->db ){
  25817. zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc);
  25818. }else{
  25819. zNew = sqlite3_realloc64(zOld, p->nAlloc);
  25820. }
  25821. if( zNew ){
  25822. assert( p->zText!=0 || p->nChar==0 );
  25823. if( !isMalloced(p) && p->nChar>0 ) memcpy(zNew, p->zText, p->nChar);
  25824. p->zText = zNew;
  25825. p->nAlloc = sqlite3DbMallocSize(p->db, zNew);
  25826. p->printfFlags |= SQLITE_PRINTF_MALLOCED;
  25827. }else{
  25828. sqlite3StrAccumReset(p);
  25829. setStrAccumError(p, STRACCUM_NOMEM);
  25830. return 0;
  25831. }
  25832. }
  25833. return N;
  25834. }
  25835. /*
  25836. ** Append N copies of character c to the given string buffer.
  25837. */
  25838. SQLITE_PRIVATE void sqlite3AppendChar(StrAccum *p, int N, char c){
  25839. testcase( p->nChar + (i64)N > 0x7fffffff );
  25840. if( p->nChar+(i64)N >= p->nAlloc && (N = sqlite3StrAccumEnlarge(p, N))<=0 ){
  25841. return;
  25842. }
  25843. while( (N--)>0 ) p->zText[p->nChar++] = c;
  25844. }
  25845. /*
  25846. ** The StrAccum "p" is not large enough to accept N new bytes of z[].
  25847. ** So enlarge if first, then do the append.
  25848. **
  25849. ** This is a helper routine to sqlite3StrAccumAppend() that does special-case
  25850. ** work (enlarging the buffer) using tail recursion, so that the
  25851. ** sqlite3StrAccumAppend() routine can use fast calling semantics.
  25852. */
  25853. static void SQLITE_NOINLINE enlargeAndAppend(StrAccum *p, const char *z, int N){
  25854. N = sqlite3StrAccumEnlarge(p, N);
  25855. if( N>0 ){
  25856. memcpy(&p->zText[p->nChar], z, N);
  25857. p->nChar += N;
  25858. }
  25859. }
  25860. /*
  25861. ** Append N bytes of text from z to the StrAccum object. Increase the
  25862. ** size of the memory allocation for StrAccum if necessary.
  25863. */
  25864. SQLITE_PRIVATE void sqlite3StrAccumAppend(StrAccum *p, const char *z, int N){
  25865. assert( z!=0 || N==0 );
  25866. assert( p->zText!=0 || p->nChar==0 || p->accError );
  25867. assert( N>=0 );
  25868. assert( p->accError==0 || p->nAlloc==0 );
  25869. if( p->nChar+N >= p->nAlloc ){
  25870. enlargeAndAppend(p,z,N);
  25871. }else if( N ){
  25872. assert( p->zText );
  25873. p->nChar += N;
  25874. memcpy(&p->zText[p->nChar-N], z, N);
  25875. }
  25876. }
  25877. /*
  25878. ** Append the complete text of zero-terminated string z[] to the p string.
  25879. */
  25880. SQLITE_PRIVATE void sqlite3StrAccumAppendAll(StrAccum *p, const char *z){
  25881. sqlite3StrAccumAppend(p, z, sqlite3Strlen30(z));
  25882. }
  25883. /*
  25884. ** Finish off a string by making sure it is zero-terminated.
  25885. ** Return a pointer to the resulting string. Return a NULL
  25886. ** pointer if any kind of error was encountered.
  25887. */
  25888. static SQLITE_NOINLINE char *strAccumFinishRealloc(StrAccum *p){
  25889. char *zText;
  25890. assert( p->mxAlloc>0 && !isMalloced(p) );
  25891. zText = sqlite3DbMallocRaw(p->db, p->nChar+1 );
  25892. if( zText ){
  25893. memcpy(zText, p->zText, p->nChar+1);
  25894. p->printfFlags |= SQLITE_PRINTF_MALLOCED;
  25895. }else{
  25896. setStrAccumError(p, STRACCUM_NOMEM);
  25897. }
  25898. p->zText = zText;
  25899. return zText;
  25900. }
  25901. SQLITE_PRIVATE char *sqlite3StrAccumFinish(StrAccum *p){
  25902. if( p->zText ){
  25903. p->zText[p->nChar] = 0;
  25904. if( p->mxAlloc>0 && !isMalloced(p) ){
  25905. return strAccumFinishRealloc(p);
  25906. }
  25907. }
  25908. return p->zText;
  25909. }
  25910. /*
  25911. ** Reset an StrAccum string. Reclaim all malloced memory.
  25912. */
  25913. SQLITE_PRIVATE void sqlite3StrAccumReset(StrAccum *p){
  25914. if( isMalloced(p) ){
  25915. sqlite3DbFree(p->db, p->zText);
  25916. p->printfFlags &= ~SQLITE_PRINTF_MALLOCED;
  25917. }
  25918. p->zText = 0;
  25919. }
  25920. /*
  25921. ** Initialize a string accumulator.
  25922. **
  25923. ** p: The accumulator to be initialized.
  25924. ** db: Pointer to a database connection. May be NULL. Lookaside
  25925. ** memory is used if not NULL. db->mallocFailed is set appropriately
  25926. ** when not NULL.
  25927. ** zBase: An initial buffer. May be NULL in which case the initial buffer
  25928. ** is malloced.
  25929. ** n: Size of zBase in bytes. If total space requirements never exceed
  25930. ** n then no memory allocations ever occur.
  25931. ** mx: Maximum number of bytes to accumulate. If mx==0 then no memory
  25932. ** allocations will ever occur.
  25933. */
  25934. SQLITE_PRIVATE void sqlite3StrAccumInit(StrAccum *p, sqlite3 *db, char *zBase, int n, int mx){
  25935. p->zText = zBase;
  25936. p->db = db;
  25937. p->nAlloc = n;
  25938. p->mxAlloc = mx;
  25939. p->nChar = 0;
  25940. p->accError = 0;
  25941. p->printfFlags = 0;
  25942. }
  25943. /*
  25944. ** Print into memory obtained from sqliteMalloc(). Use the internal
  25945. ** %-conversion extensions.
  25946. */
  25947. SQLITE_PRIVATE char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){
  25948. char *z;
  25949. char zBase[SQLITE_PRINT_BUF_SIZE];
  25950. StrAccum acc;
  25951. assert( db!=0 );
  25952. sqlite3StrAccumInit(&acc, db, zBase, sizeof(zBase),
  25953. db->aLimit[SQLITE_LIMIT_LENGTH]);
  25954. acc.printfFlags = SQLITE_PRINTF_INTERNAL;
  25955. sqlite3VXPrintf(&acc, zFormat, ap);
  25956. z = sqlite3StrAccumFinish(&acc);
  25957. if( acc.accError==STRACCUM_NOMEM ){
  25958. sqlite3OomFault(db);
  25959. }
  25960. return z;
  25961. }
  25962. /*
  25963. ** Print into memory obtained from sqliteMalloc(). Use the internal
  25964. ** %-conversion extensions.
  25965. */
  25966. SQLITE_PRIVATE char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){
  25967. va_list ap;
  25968. char *z;
  25969. va_start(ap, zFormat);
  25970. z = sqlite3VMPrintf(db, zFormat, ap);
  25971. va_end(ap);
  25972. return z;
  25973. }
  25974. /*
  25975. ** Print into memory obtained from sqlite3_malloc(). Omit the internal
  25976. ** %-conversion extensions.
  25977. */
  25978. SQLITE_API char *sqlite3_vmprintf(const char *zFormat, va_list ap){
  25979. char *z;
  25980. char zBase[SQLITE_PRINT_BUF_SIZE];
  25981. StrAccum acc;
  25982. #ifdef SQLITE_ENABLE_API_ARMOR
  25983. if( zFormat==0 ){
  25984. (void)SQLITE_MISUSE_BKPT;
  25985. return 0;
  25986. }
  25987. #endif
  25988. #ifndef SQLITE_OMIT_AUTOINIT
  25989. if( sqlite3_initialize() ) return 0;
  25990. #endif
  25991. sqlite3StrAccumInit(&acc, 0, zBase, sizeof(zBase), SQLITE_MAX_LENGTH);
  25992. sqlite3VXPrintf(&acc, zFormat, ap);
  25993. z = sqlite3StrAccumFinish(&acc);
  25994. return z;
  25995. }
  25996. /*
  25997. ** Print into memory obtained from sqlite3_malloc()(). Omit the internal
  25998. ** %-conversion extensions.
  25999. */
  26000. SQLITE_API char *sqlite3_mprintf(const char *zFormat, ...){
  26001. va_list ap;
  26002. char *z;
  26003. #ifndef SQLITE_OMIT_AUTOINIT
  26004. if( sqlite3_initialize() ) return 0;
  26005. #endif
  26006. va_start(ap, zFormat);
  26007. z = sqlite3_vmprintf(zFormat, ap);
  26008. va_end(ap);
  26009. return z;
  26010. }
  26011. /*
  26012. ** sqlite3_snprintf() works like snprintf() except that it ignores the
  26013. ** current locale settings. This is important for SQLite because we
  26014. ** are not able to use a "," as the decimal point in place of "." as
  26015. ** specified by some locales.
  26016. **
  26017. ** Oops: The first two arguments of sqlite3_snprintf() are backwards
  26018. ** from the snprintf() standard. Unfortunately, it is too late to change
  26019. ** this without breaking compatibility, so we just have to live with the
  26020. ** mistake.
  26021. **
  26022. ** sqlite3_vsnprintf() is the varargs version.
  26023. */
  26024. SQLITE_API char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){
  26025. StrAccum acc;
  26026. if( n<=0 ) return zBuf;
  26027. #ifdef SQLITE_ENABLE_API_ARMOR
  26028. if( zBuf==0 || zFormat==0 ) {
  26029. (void)SQLITE_MISUSE_BKPT;
  26030. if( zBuf ) zBuf[0] = 0;
  26031. return zBuf;
  26032. }
  26033. #endif
  26034. sqlite3StrAccumInit(&acc, 0, zBuf, n, 0);
  26035. sqlite3VXPrintf(&acc, zFormat, ap);
  26036. zBuf[acc.nChar] = 0;
  26037. return zBuf;
  26038. }
  26039. SQLITE_API char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){
  26040. char *z;
  26041. va_list ap;
  26042. va_start(ap,zFormat);
  26043. z = sqlite3_vsnprintf(n, zBuf, zFormat, ap);
  26044. va_end(ap);
  26045. return z;
  26046. }
  26047. /*
  26048. ** This is the routine that actually formats the sqlite3_log() message.
  26049. ** We house it in a separate routine from sqlite3_log() to avoid using
  26050. ** stack space on small-stack systems when logging is disabled.
  26051. **
  26052. ** sqlite3_log() must render into a static buffer. It cannot dynamically
  26053. ** allocate memory because it might be called while the memory allocator
  26054. ** mutex is held.
  26055. **
  26056. ** sqlite3VXPrintf() might ask for *temporary* memory allocations for
  26057. ** certain format characters (%q) or for very large precisions or widths.
  26058. ** Care must be taken that any sqlite3_log() calls that occur while the
  26059. ** memory mutex is held do not use these mechanisms.
  26060. */
  26061. static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){
  26062. StrAccum acc; /* String accumulator */
  26063. char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */
  26064. sqlite3StrAccumInit(&acc, 0, zMsg, sizeof(zMsg), 0);
  26065. sqlite3VXPrintf(&acc, zFormat, ap);
  26066. sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode,
  26067. sqlite3StrAccumFinish(&acc));
  26068. }
  26069. /*
  26070. ** Format and write a message to the log if logging is enabled.
  26071. */
  26072. SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...){
  26073. va_list ap; /* Vararg list */
  26074. if( sqlite3GlobalConfig.xLog ){
  26075. va_start(ap, zFormat);
  26076. renderLogMsg(iErrCode, zFormat, ap);
  26077. va_end(ap);
  26078. }
  26079. }
  26080. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  26081. /*
  26082. ** A version of printf() that understands %lld. Used for debugging.
  26083. ** The printf() built into some versions of windows does not understand %lld
  26084. ** and segfaults if you give it a long long int.
  26085. */
  26086. SQLITE_PRIVATE void sqlite3DebugPrintf(const char *zFormat, ...){
  26087. va_list ap;
  26088. StrAccum acc;
  26089. char zBuf[500];
  26090. sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
  26091. va_start(ap,zFormat);
  26092. sqlite3VXPrintf(&acc, zFormat, ap);
  26093. va_end(ap);
  26094. sqlite3StrAccumFinish(&acc);
  26095. #ifdef SQLITE_OS_TRACE_PROC
  26096. {
  26097. extern void SQLITE_OS_TRACE_PROC(const char *zBuf, int nBuf);
  26098. SQLITE_OS_TRACE_PROC(zBuf, sizeof(zBuf));
  26099. }
  26100. #else
  26101. fprintf(stdout,"%s", zBuf);
  26102. fflush(stdout);
  26103. #endif
  26104. }
  26105. #endif
  26106. /*
  26107. ** variable-argument wrapper around sqlite3VXPrintf(). The bFlags argument
  26108. ** can contain the bit SQLITE_PRINTF_INTERNAL enable internal formats.
  26109. */
  26110. SQLITE_PRIVATE void sqlite3XPrintf(StrAccum *p, const char *zFormat, ...){
  26111. va_list ap;
  26112. va_start(ap,zFormat);
  26113. sqlite3VXPrintf(p, zFormat, ap);
  26114. va_end(ap);
  26115. }
  26116. /************** End of printf.c **********************************************/
  26117. /************** Begin file treeview.c ****************************************/
  26118. /*
  26119. ** 2015-06-08
  26120. **
  26121. ** The author disclaims copyright to this source code. In place of
  26122. ** a legal notice, here is a blessing:
  26123. **
  26124. ** May you do good and not evil.
  26125. ** May you find forgiveness for yourself and forgive others.
  26126. ** May you share freely, never taking more than you give.
  26127. **
  26128. *************************************************************************
  26129. **
  26130. ** This file contains C code to implement the TreeView debugging routines.
  26131. ** These routines print a parse tree to standard output for debugging and
  26132. ** analysis.
  26133. **
  26134. ** The interfaces in this file is only available when compiling
  26135. ** with SQLITE_DEBUG.
  26136. */
  26137. /* #include "sqliteInt.h" */
  26138. #ifdef SQLITE_DEBUG
  26139. /*
  26140. ** Add a new subitem to the tree. The moreToFollow flag indicates that this
  26141. ** is not the last item in the tree.
  26142. */
  26143. static TreeView *sqlite3TreeViewPush(TreeView *p, u8 moreToFollow){
  26144. if( p==0 ){
  26145. p = sqlite3_malloc64( sizeof(*p) );
  26146. if( p==0 ) return 0;
  26147. memset(p, 0, sizeof(*p));
  26148. }else{
  26149. p->iLevel++;
  26150. }
  26151. assert( moreToFollow==0 || moreToFollow==1 );
  26152. if( p->iLevel<sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow;
  26153. return p;
  26154. }
  26155. /*
  26156. ** Finished with one layer of the tree
  26157. */
  26158. static void sqlite3TreeViewPop(TreeView *p){
  26159. if( p==0 ) return;
  26160. p->iLevel--;
  26161. if( p->iLevel<0 ) sqlite3_free(p);
  26162. }
  26163. /*
  26164. ** Generate a single line of output for the tree, with a prefix that contains
  26165. ** all the appropriate tree lines
  26166. */
  26167. static void sqlite3TreeViewLine(TreeView *p, const char *zFormat, ...){
  26168. va_list ap;
  26169. int i;
  26170. StrAccum acc;
  26171. char zBuf[500];
  26172. sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
  26173. if( p ){
  26174. for(i=0; i<p->iLevel && i<sizeof(p->bLine)-1; i++){
  26175. sqlite3StrAccumAppend(&acc, p->bLine[i] ? "| " : " ", 4);
  26176. }
  26177. sqlite3StrAccumAppend(&acc, p->bLine[i] ? "|-- " : "'-- ", 4);
  26178. }
  26179. va_start(ap, zFormat);
  26180. sqlite3VXPrintf(&acc, zFormat, ap);
  26181. va_end(ap);
  26182. assert( acc.nChar>0 );
  26183. if( zBuf[acc.nChar-1]!='\n' ) sqlite3StrAccumAppend(&acc, "\n", 1);
  26184. sqlite3StrAccumFinish(&acc);
  26185. fprintf(stdout,"%s", zBuf);
  26186. fflush(stdout);
  26187. }
  26188. /*
  26189. ** Shorthand for starting a new tree item that consists of a single label
  26190. */
  26191. static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){
  26192. p = sqlite3TreeViewPush(p, moreFollows);
  26193. sqlite3TreeViewLine(p, "%s", zLabel);
  26194. }
  26195. /*
  26196. ** Generate a human-readable description of a WITH clause.
  26197. */
  26198. SQLITE_PRIVATE void sqlite3TreeViewWith(TreeView *pView, const With *pWith, u8 moreToFollow){
  26199. int i;
  26200. if( pWith==0 ) return;
  26201. if( pWith->nCte==0 ) return;
  26202. if( pWith->pOuter ){
  26203. sqlite3TreeViewLine(pView, "WITH (0x%p, pOuter=0x%p)",pWith,pWith->pOuter);
  26204. }else{
  26205. sqlite3TreeViewLine(pView, "WITH (0x%p)", pWith);
  26206. }
  26207. if( pWith->nCte>0 ){
  26208. pView = sqlite3TreeViewPush(pView, 1);
  26209. for(i=0; i<pWith->nCte; i++){
  26210. StrAccum x;
  26211. char zLine[1000];
  26212. const struct Cte *pCte = &pWith->a[i];
  26213. sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
  26214. sqlite3XPrintf(&x, "%s", pCte->zName);
  26215. if( pCte->pCols && pCte->pCols->nExpr>0 ){
  26216. char cSep = '(';
  26217. int j;
  26218. for(j=0; j<pCte->pCols->nExpr; j++){
  26219. sqlite3XPrintf(&x, "%c%s", cSep, pCte->pCols->a[j].zName);
  26220. cSep = ',';
  26221. }
  26222. sqlite3XPrintf(&x, ")");
  26223. }
  26224. sqlite3XPrintf(&x, " AS");
  26225. sqlite3StrAccumFinish(&x);
  26226. sqlite3TreeViewItem(pView, zLine, i<pWith->nCte-1);
  26227. sqlite3TreeViewSelect(pView, pCte->pSelect, 0);
  26228. sqlite3TreeViewPop(pView);
  26229. }
  26230. sqlite3TreeViewPop(pView);
  26231. }
  26232. }
  26233. /*
  26234. ** Generate a human-readable description of a Select object.
  26235. */
  26236. SQLITE_PRIVATE void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
  26237. int n = 0;
  26238. int cnt = 0;
  26239. if( p==0 ){
  26240. sqlite3TreeViewLine(pView, "nil-SELECT");
  26241. return;
  26242. }
  26243. pView = sqlite3TreeViewPush(pView, moreToFollow);
  26244. if( p->pWith ){
  26245. sqlite3TreeViewWith(pView, p->pWith, 1);
  26246. cnt = 1;
  26247. sqlite3TreeViewPush(pView, 1);
  26248. }
  26249. do{
  26250. #if SELECTTRACE_ENABLED
  26251. sqlite3TreeViewLine(pView,
  26252. "SELECT%s%s (%s/%p) selFlags=0x%x nSelectRow=%d",
  26253. ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
  26254. ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""),
  26255. p->zSelName, p, p->selFlags,
  26256. (int)p->nSelectRow
  26257. );
  26258. #else
  26259. sqlite3TreeViewLine(pView, "SELECT%s%s (0x%p) selFlags=0x%x nSelectRow=%d",
  26260. ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
  26261. ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""), p, p->selFlags,
  26262. (int)p->nSelectRow
  26263. );
  26264. #endif
  26265. if( cnt++ ) sqlite3TreeViewPop(pView);
  26266. if( p->pPrior ){
  26267. n = 1000;
  26268. }else{
  26269. n = 0;
  26270. if( p->pSrc && p->pSrc->nSrc ) n++;
  26271. if( p->pWhere ) n++;
  26272. if( p->pGroupBy ) n++;
  26273. if( p->pHaving ) n++;
  26274. if( p->pOrderBy ) n++;
  26275. if( p->pLimit ) n++;
  26276. }
  26277. sqlite3TreeViewExprList(pView, p->pEList, (n--)>0, "result-set");
  26278. if( p->pSrc && p->pSrc->nSrc ){
  26279. int i;
  26280. pView = sqlite3TreeViewPush(pView, (n--)>0);
  26281. sqlite3TreeViewLine(pView, "FROM");
  26282. for(i=0; i<p->pSrc->nSrc; i++){
  26283. struct SrcList_item *pItem = &p->pSrc->a[i];
  26284. StrAccum x;
  26285. char zLine[100];
  26286. sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
  26287. sqlite3XPrintf(&x, "{%d,*}", pItem->iCursor);
  26288. if( pItem->zDatabase ){
  26289. sqlite3XPrintf(&x, " %s.%s", pItem->zDatabase, pItem->zName);
  26290. }else if( pItem->zName ){
  26291. sqlite3XPrintf(&x, " %s", pItem->zName);
  26292. }
  26293. if( pItem->pTab ){
  26294. sqlite3XPrintf(&x, " tabname=%Q", pItem->pTab->zName);
  26295. }
  26296. if( pItem->zAlias ){
  26297. sqlite3XPrintf(&x, " (AS %s)", pItem->zAlias);
  26298. }
  26299. if( pItem->fg.jointype & JT_LEFT ){
  26300. sqlite3XPrintf(&x, " LEFT-JOIN");
  26301. }
  26302. sqlite3StrAccumFinish(&x);
  26303. sqlite3TreeViewItem(pView, zLine, i<p->pSrc->nSrc-1);
  26304. if( pItem->pSelect ){
  26305. sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
  26306. }
  26307. if( pItem->fg.isTabFunc ){
  26308. sqlite3TreeViewExprList(pView, pItem->u1.pFuncArg, 0, "func-args:");
  26309. }
  26310. sqlite3TreeViewPop(pView);
  26311. }
  26312. sqlite3TreeViewPop(pView);
  26313. }
  26314. if( p->pWhere ){
  26315. sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
  26316. sqlite3TreeViewExpr(pView, p->pWhere, 0);
  26317. sqlite3TreeViewPop(pView);
  26318. }
  26319. if( p->pGroupBy ){
  26320. sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
  26321. }
  26322. if( p->pHaving ){
  26323. sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
  26324. sqlite3TreeViewExpr(pView, p->pHaving, 0);
  26325. sqlite3TreeViewPop(pView);
  26326. }
  26327. if( p->pOrderBy ){
  26328. sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
  26329. }
  26330. if( p->pLimit ){
  26331. sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
  26332. sqlite3TreeViewExpr(pView, p->pLimit->pLeft, p->pLimit->pRight!=0);
  26333. if( p->pLimit->pRight ){
  26334. sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
  26335. sqlite3TreeViewExpr(pView, p->pLimit->pRight, 0);
  26336. sqlite3TreeViewPop(pView);
  26337. }
  26338. sqlite3TreeViewPop(pView);
  26339. }
  26340. if( p->pPrior ){
  26341. const char *zOp = "UNION";
  26342. switch( p->op ){
  26343. case TK_ALL: zOp = "UNION ALL"; break;
  26344. case TK_INTERSECT: zOp = "INTERSECT"; break;
  26345. case TK_EXCEPT: zOp = "EXCEPT"; break;
  26346. }
  26347. sqlite3TreeViewItem(pView, zOp, 1);
  26348. }
  26349. p = p->pPrior;
  26350. }while( p!=0 );
  26351. sqlite3TreeViewPop(pView);
  26352. }
  26353. /*
  26354. ** Generate a human-readable explanation of an expression tree.
  26355. */
  26356. SQLITE_PRIVATE void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){
  26357. const char *zBinOp = 0; /* Binary operator */
  26358. const char *zUniOp = 0; /* Unary operator */
  26359. char zFlgs[60];
  26360. pView = sqlite3TreeViewPush(pView, moreToFollow);
  26361. if( pExpr==0 ){
  26362. sqlite3TreeViewLine(pView, "nil");
  26363. sqlite3TreeViewPop(pView);
  26364. return;
  26365. }
  26366. if( pExpr->flags ){
  26367. if( ExprHasProperty(pExpr, EP_FromJoin) ){
  26368. sqlite3_snprintf(sizeof(zFlgs),zFlgs," flags=0x%x iRJT=%d",
  26369. pExpr->flags, pExpr->iRightJoinTable);
  26370. }else{
  26371. sqlite3_snprintf(sizeof(zFlgs),zFlgs," flags=0x%x",pExpr->flags);
  26372. }
  26373. }else{
  26374. zFlgs[0] = 0;
  26375. }
  26376. switch( pExpr->op ){
  26377. case TK_AGG_COLUMN: {
  26378. sqlite3TreeViewLine(pView, "AGG{%d:%d}%s",
  26379. pExpr->iTable, pExpr->iColumn, zFlgs);
  26380. break;
  26381. }
  26382. case TK_COLUMN: {
  26383. if( pExpr->iTable<0 ){
  26384. /* This only happens when coding check constraints */
  26385. sqlite3TreeViewLine(pView, "COLUMN(%d)%s", pExpr->iColumn, zFlgs);
  26386. }else{
  26387. sqlite3TreeViewLine(pView, "{%d:%d}%s",
  26388. pExpr->iTable, pExpr->iColumn, zFlgs);
  26389. }
  26390. break;
  26391. }
  26392. case TK_INTEGER: {
  26393. if( pExpr->flags & EP_IntValue ){
  26394. sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue);
  26395. }else{
  26396. sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken);
  26397. }
  26398. break;
  26399. }
  26400. #ifndef SQLITE_OMIT_FLOATING_POINT
  26401. case TK_FLOAT: {
  26402. sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
  26403. break;
  26404. }
  26405. #endif
  26406. case TK_STRING: {
  26407. sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken);
  26408. break;
  26409. }
  26410. case TK_NULL: {
  26411. sqlite3TreeViewLine(pView,"NULL");
  26412. break;
  26413. }
  26414. case TK_TRUEFALSE: {
  26415. sqlite3TreeViewLine(pView,
  26416. sqlite3ExprTruthValue(pExpr) ? "TRUE" : "FALSE");
  26417. break;
  26418. }
  26419. #ifndef SQLITE_OMIT_BLOB_LITERAL
  26420. case TK_BLOB: {
  26421. sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
  26422. break;
  26423. }
  26424. #endif
  26425. case TK_VARIABLE: {
  26426. sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)",
  26427. pExpr->u.zToken, pExpr->iColumn);
  26428. break;
  26429. }
  26430. case TK_REGISTER: {
  26431. sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable);
  26432. break;
  26433. }
  26434. case TK_ID: {
  26435. sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken);
  26436. break;
  26437. }
  26438. #ifndef SQLITE_OMIT_CAST
  26439. case TK_CAST: {
  26440. /* Expressions of the form: CAST(pLeft AS token) */
  26441. sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken);
  26442. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  26443. break;
  26444. }
  26445. #endif /* SQLITE_OMIT_CAST */
  26446. case TK_LT: zBinOp = "LT"; break;
  26447. case TK_LE: zBinOp = "LE"; break;
  26448. case TK_GT: zBinOp = "GT"; break;
  26449. case TK_GE: zBinOp = "GE"; break;
  26450. case TK_NE: zBinOp = "NE"; break;
  26451. case TK_EQ: zBinOp = "EQ"; break;
  26452. case TK_IS: zBinOp = "IS"; break;
  26453. case TK_ISNOT: zBinOp = "ISNOT"; break;
  26454. case TK_AND: zBinOp = "AND"; break;
  26455. case TK_OR: zBinOp = "OR"; break;
  26456. case TK_PLUS: zBinOp = "ADD"; break;
  26457. case TK_STAR: zBinOp = "MUL"; break;
  26458. case TK_MINUS: zBinOp = "SUB"; break;
  26459. case TK_REM: zBinOp = "REM"; break;
  26460. case TK_BITAND: zBinOp = "BITAND"; break;
  26461. case TK_BITOR: zBinOp = "BITOR"; break;
  26462. case TK_SLASH: zBinOp = "DIV"; break;
  26463. case TK_LSHIFT: zBinOp = "LSHIFT"; break;
  26464. case TK_RSHIFT: zBinOp = "RSHIFT"; break;
  26465. case TK_CONCAT: zBinOp = "CONCAT"; break;
  26466. case TK_DOT: zBinOp = "DOT"; break;
  26467. case TK_UMINUS: zUniOp = "UMINUS"; break;
  26468. case TK_UPLUS: zUniOp = "UPLUS"; break;
  26469. case TK_BITNOT: zUniOp = "BITNOT"; break;
  26470. case TK_NOT: zUniOp = "NOT"; break;
  26471. case TK_ISNULL: zUniOp = "ISNULL"; break;
  26472. case TK_NOTNULL: zUniOp = "NOTNULL"; break;
  26473. case TK_TRUTH: {
  26474. int x;
  26475. const char *azOp[] = {
  26476. "IS-FALSE", "IS-TRUE", "IS-NOT-FALSE", "IS-NOT-TRUE"
  26477. };
  26478. assert( pExpr->op2==TK_IS || pExpr->op2==TK_ISNOT );
  26479. assert( pExpr->pRight );
  26480. assert( pExpr->pRight->op==TK_TRUEFALSE );
  26481. x = (pExpr->op2==TK_ISNOT)*2 + sqlite3ExprTruthValue(pExpr->pRight);
  26482. zUniOp = azOp[x];
  26483. break;
  26484. }
  26485. case TK_SPAN: {
  26486. sqlite3TreeViewLine(pView, "SPAN %Q", pExpr->u.zToken);
  26487. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  26488. break;
  26489. }
  26490. case TK_COLLATE: {
  26491. sqlite3TreeViewLine(pView, "COLLATE %Q", pExpr->u.zToken);
  26492. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  26493. break;
  26494. }
  26495. case TK_AGG_FUNCTION:
  26496. case TK_FUNCTION: {
  26497. ExprList *pFarg; /* List of function arguments */
  26498. if( ExprHasProperty(pExpr, EP_TokenOnly) ){
  26499. pFarg = 0;
  26500. }else{
  26501. pFarg = pExpr->x.pList;
  26502. }
  26503. if( pExpr->op==TK_AGG_FUNCTION ){
  26504. sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q",
  26505. pExpr->op2, pExpr->u.zToken);
  26506. }else{
  26507. sqlite3TreeViewLine(pView, "FUNCTION %Q", pExpr->u.zToken);
  26508. }
  26509. if( pFarg ){
  26510. sqlite3TreeViewExprList(pView, pFarg, 0, 0);
  26511. }
  26512. break;
  26513. }
  26514. #ifndef SQLITE_OMIT_SUBQUERY
  26515. case TK_EXISTS: {
  26516. sqlite3TreeViewLine(pView, "EXISTS-expr flags=0x%x", pExpr->flags);
  26517. sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
  26518. break;
  26519. }
  26520. case TK_SELECT: {
  26521. sqlite3TreeViewLine(pView, "SELECT-expr flags=0x%x", pExpr->flags);
  26522. sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
  26523. break;
  26524. }
  26525. case TK_IN: {
  26526. sqlite3TreeViewLine(pView, "IN flags=0x%x", pExpr->flags);
  26527. sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
  26528. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  26529. sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
  26530. }else{
  26531. sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
  26532. }
  26533. break;
  26534. }
  26535. #endif /* SQLITE_OMIT_SUBQUERY */
  26536. /*
  26537. ** x BETWEEN y AND z
  26538. **
  26539. ** This is equivalent to
  26540. **
  26541. ** x>=y AND x<=z
  26542. **
  26543. ** X is stored in pExpr->pLeft.
  26544. ** Y is stored in pExpr->pList->a[0].pExpr.
  26545. ** Z is stored in pExpr->pList->a[1].pExpr.
  26546. */
  26547. case TK_BETWEEN: {
  26548. Expr *pX = pExpr->pLeft;
  26549. Expr *pY = pExpr->x.pList->a[0].pExpr;
  26550. Expr *pZ = pExpr->x.pList->a[1].pExpr;
  26551. sqlite3TreeViewLine(pView, "BETWEEN");
  26552. sqlite3TreeViewExpr(pView, pX, 1);
  26553. sqlite3TreeViewExpr(pView, pY, 1);
  26554. sqlite3TreeViewExpr(pView, pZ, 0);
  26555. break;
  26556. }
  26557. case TK_TRIGGER: {
  26558. /* If the opcode is TK_TRIGGER, then the expression is a reference
  26559. ** to a column in the new.* or old.* pseudo-tables available to
  26560. ** trigger programs. In this case Expr.iTable is set to 1 for the
  26561. ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
  26562. ** is set to the column of the pseudo-table to read, or to -1 to
  26563. ** read the rowid field.
  26564. */
  26565. sqlite3TreeViewLine(pView, "%s(%d)",
  26566. pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
  26567. break;
  26568. }
  26569. case TK_CASE: {
  26570. sqlite3TreeViewLine(pView, "CASE");
  26571. sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
  26572. sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
  26573. break;
  26574. }
  26575. #ifndef SQLITE_OMIT_TRIGGER
  26576. case TK_RAISE: {
  26577. const char *zType = "unk";
  26578. switch( pExpr->affinity ){
  26579. case OE_Rollback: zType = "rollback"; break;
  26580. case OE_Abort: zType = "abort"; break;
  26581. case OE_Fail: zType = "fail"; break;
  26582. case OE_Ignore: zType = "ignore"; break;
  26583. }
  26584. sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken);
  26585. break;
  26586. }
  26587. #endif
  26588. case TK_MATCH: {
  26589. sqlite3TreeViewLine(pView, "MATCH {%d:%d}%s",
  26590. pExpr->iTable, pExpr->iColumn, zFlgs);
  26591. sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
  26592. break;
  26593. }
  26594. case TK_VECTOR: {
  26595. sqlite3TreeViewBareExprList(pView, pExpr->x.pList, "VECTOR");
  26596. break;
  26597. }
  26598. case TK_SELECT_COLUMN: {
  26599. sqlite3TreeViewLine(pView, "SELECT-COLUMN %d", pExpr->iColumn);
  26600. sqlite3TreeViewSelect(pView, pExpr->pLeft->x.pSelect, 0);
  26601. break;
  26602. }
  26603. case TK_IF_NULL_ROW: {
  26604. sqlite3TreeViewLine(pView, "IF-NULL-ROW %d", pExpr->iTable);
  26605. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  26606. break;
  26607. }
  26608. default: {
  26609. sqlite3TreeViewLine(pView, "op=%d", pExpr->op);
  26610. break;
  26611. }
  26612. }
  26613. if( zBinOp ){
  26614. sqlite3TreeViewLine(pView, "%s%s", zBinOp, zFlgs);
  26615. sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
  26616. sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
  26617. }else if( zUniOp ){
  26618. sqlite3TreeViewLine(pView, "%s%s", zUniOp, zFlgs);
  26619. sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
  26620. }
  26621. sqlite3TreeViewPop(pView);
  26622. }
  26623. /*
  26624. ** Generate a human-readable explanation of an expression list.
  26625. */
  26626. SQLITE_PRIVATE void sqlite3TreeViewBareExprList(
  26627. TreeView *pView,
  26628. const ExprList *pList,
  26629. const char *zLabel
  26630. ){
  26631. if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
  26632. if( pList==0 ){
  26633. sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
  26634. }else{
  26635. int i;
  26636. sqlite3TreeViewLine(pView, "%s", zLabel);
  26637. for(i=0; i<pList->nExpr; i++){
  26638. int j = pList->a[i].u.x.iOrderByCol;
  26639. char *zName = pList->a[i].zName;
  26640. if( j || zName ){
  26641. sqlite3TreeViewPush(pView, 0);
  26642. }
  26643. if( zName ){
  26644. sqlite3TreeViewLine(pView, "AS %s", zName);
  26645. }
  26646. if( j ){
  26647. sqlite3TreeViewLine(pView, "iOrderByCol=%d", j);
  26648. }
  26649. sqlite3TreeViewExpr(pView, pList->a[i].pExpr, i<pList->nExpr-1);
  26650. if( j || zName ){
  26651. sqlite3TreeViewPop(pView);
  26652. }
  26653. }
  26654. }
  26655. }
  26656. SQLITE_PRIVATE void sqlite3TreeViewExprList(
  26657. TreeView *pView,
  26658. const ExprList *pList,
  26659. u8 moreToFollow,
  26660. const char *zLabel
  26661. ){
  26662. pView = sqlite3TreeViewPush(pView, moreToFollow);
  26663. sqlite3TreeViewBareExprList(pView, pList, zLabel);
  26664. sqlite3TreeViewPop(pView);
  26665. }
  26666. #endif /* SQLITE_DEBUG */
  26667. /************** End of treeview.c ********************************************/
  26668. /************** Begin file random.c ******************************************/
  26669. /*
  26670. ** 2001 September 15
  26671. **
  26672. ** The author disclaims copyright to this source code. In place of
  26673. ** a legal notice, here is a blessing:
  26674. **
  26675. ** May you do good and not evil.
  26676. ** May you find forgiveness for yourself and forgive others.
  26677. ** May you share freely, never taking more than you give.
  26678. **
  26679. *************************************************************************
  26680. ** This file contains code to implement a pseudo-random number
  26681. ** generator (PRNG) for SQLite.
  26682. **
  26683. ** Random numbers are used by some of the database backends in order
  26684. ** to generate random integer keys for tables or random filenames.
  26685. */
  26686. /* #include "sqliteInt.h" */
  26687. /* All threads share a single random number generator.
  26688. ** This structure is the current state of the generator.
  26689. */
  26690. static SQLITE_WSD struct sqlite3PrngType {
  26691. unsigned char isInit; /* True if initialized */
  26692. unsigned char i, j; /* State variables */
  26693. unsigned char s[256]; /* State variables */
  26694. } sqlite3Prng;
  26695. /*
  26696. ** Return N random bytes.
  26697. */
  26698. SQLITE_API void sqlite3_randomness(int N, void *pBuf){
  26699. unsigned char t;
  26700. unsigned char *zBuf = pBuf;
  26701. /* The "wsdPrng" macro will resolve to the pseudo-random number generator
  26702. ** state vector. If writable static data is unsupported on the target,
  26703. ** we have to locate the state vector at run-time. In the more common
  26704. ** case where writable static data is supported, wsdPrng can refer directly
  26705. ** to the "sqlite3Prng" state vector declared above.
  26706. */
  26707. #ifdef SQLITE_OMIT_WSD
  26708. struct sqlite3PrngType *p = &GLOBAL(struct sqlite3PrngType, sqlite3Prng);
  26709. # define wsdPrng p[0]
  26710. #else
  26711. # define wsdPrng sqlite3Prng
  26712. #endif
  26713. #if SQLITE_THREADSAFE
  26714. sqlite3_mutex *mutex;
  26715. #endif
  26716. #ifndef SQLITE_OMIT_AUTOINIT
  26717. if( sqlite3_initialize() ) return;
  26718. #endif
  26719. #if SQLITE_THREADSAFE
  26720. mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_PRNG);
  26721. #endif
  26722. sqlite3_mutex_enter(mutex);
  26723. if( N<=0 || pBuf==0 ){
  26724. wsdPrng.isInit = 0;
  26725. sqlite3_mutex_leave(mutex);
  26726. return;
  26727. }
  26728. /* Initialize the state of the random number generator once,
  26729. ** the first time this routine is called. The seed value does
  26730. ** not need to contain a lot of randomness since we are not
  26731. ** trying to do secure encryption or anything like that...
  26732. **
  26733. ** Nothing in this file or anywhere else in SQLite does any kind of
  26734. ** encryption. The RC4 algorithm is being used as a PRNG (pseudo-random
  26735. ** number generator) not as an encryption device.
  26736. */
  26737. if( !wsdPrng.isInit ){
  26738. int i;
  26739. char k[256];
  26740. wsdPrng.j = 0;
  26741. wsdPrng.i = 0;
  26742. sqlite3OsRandomness(sqlite3_vfs_find(0), 256, k);
  26743. for(i=0; i<256; i++){
  26744. wsdPrng.s[i] = (u8)i;
  26745. }
  26746. for(i=0; i<256; i++){
  26747. wsdPrng.j += wsdPrng.s[i] + k[i];
  26748. t = wsdPrng.s[wsdPrng.j];
  26749. wsdPrng.s[wsdPrng.j] = wsdPrng.s[i];
  26750. wsdPrng.s[i] = t;
  26751. }
  26752. wsdPrng.isInit = 1;
  26753. }
  26754. assert( N>0 );
  26755. do{
  26756. wsdPrng.i++;
  26757. t = wsdPrng.s[wsdPrng.i];
  26758. wsdPrng.j += t;
  26759. wsdPrng.s[wsdPrng.i] = wsdPrng.s[wsdPrng.j];
  26760. wsdPrng.s[wsdPrng.j] = t;
  26761. t += wsdPrng.s[wsdPrng.i];
  26762. *(zBuf++) = wsdPrng.s[t];
  26763. }while( --N );
  26764. sqlite3_mutex_leave(mutex);
  26765. }
  26766. #ifndef SQLITE_UNTESTABLE
  26767. /*
  26768. ** For testing purposes, we sometimes want to preserve the state of
  26769. ** PRNG and restore the PRNG to its saved state at a later time, or
  26770. ** to reset the PRNG to its initial state. These routines accomplish
  26771. ** those tasks.
  26772. **
  26773. ** The sqlite3_test_control() interface calls these routines to
  26774. ** control the PRNG.
  26775. */
  26776. static SQLITE_WSD struct sqlite3PrngType sqlite3SavedPrng;
  26777. SQLITE_PRIVATE void sqlite3PrngSaveState(void){
  26778. memcpy(
  26779. &GLOBAL(struct sqlite3PrngType, sqlite3SavedPrng),
  26780. &GLOBAL(struct sqlite3PrngType, sqlite3Prng),
  26781. sizeof(sqlite3Prng)
  26782. );
  26783. }
  26784. SQLITE_PRIVATE void sqlite3PrngRestoreState(void){
  26785. memcpy(
  26786. &GLOBAL(struct sqlite3PrngType, sqlite3Prng),
  26787. &GLOBAL(struct sqlite3PrngType, sqlite3SavedPrng),
  26788. sizeof(sqlite3Prng)
  26789. );
  26790. }
  26791. #endif /* SQLITE_UNTESTABLE */
  26792. /************** End of random.c **********************************************/
  26793. /************** Begin file threads.c *****************************************/
  26794. /*
  26795. ** 2012 July 21
  26796. **
  26797. ** The author disclaims copyright to this source code. In place of
  26798. ** a legal notice, here is a blessing:
  26799. **
  26800. ** May you do good and not evil.
  26801. ** May you find forgiveness for yourself and forgive others.
  26802. ** May you share freely, never taking more than you give.
  26803. **
  26804. ******************************************************************************
  26805. **
  26806. ** This file presents a simple cross-platform threading interface for
  26807. ** use internally by SQLite.
  26808. **
  26809. ** A "thread" can be created using sqlite3ThreadCreate(). This thread
  26810. ** runs independently of its creator until it is joined using
  26811. ** sqlite3ThreadJoin(), at which point it terminates.
  26812. **
  26813. ** Threads do not have to be real. It could be that the work of the
  26814. ** "thread" is done by the main thread at either the sqlite3ThreadCreate()
  26815. ** or sqlite3ThreadJoin() call. This is, in fact, what happens in
  26816. ** single threaded systems. Nothing in SQLite requires multiple threads.
  26817. ** This interface exists so that applications that want to take advantage
  26818. ** of multiple cores can do so, while also allowing applications to stay
  26819. ** single-threaded if desired.
  26820. */
  26821. /* #include "sqliteInt.h" */
  26822. #if SQLITE_OS_WIN
  26823. /* # include "os_win.h" */
  26824. #endif
  26825. #if SQLITE_MAX_WORKER_THREADS>0
  26826. /********************************* Unix Pthreads ****************************/
  26827. #if SQLITE_OS_UNIX && defined(SQLITE_MUTEX_PTHREADS) && SQLITE_THREADSAFE>0
  26828. #define SQLITE_THREADS_IMPLEMENTED 1 /* Prevent the single-thread code below */
  26829. /* #include <pthread.h> */
  26830. /* A running thread */
  26831. struct SQLiteThread {
  26832. pthread_t tid; /* Thread ID */
  26833. int done; /* Set to true when thread finishes */
  26834. void *pOut; /* Result returned by the thread */
  26835. void *(*xTask)(void*); /* The thread routine */
  26836. void *pIn; /* Argument to the thread */
  26837. };
  26838. /* Create a new thread */
  26839. SQLITE_PRIVATE int sqlite3ThreadCreate(
  26840. SQLiteThread **ppThread, /* OUT: Write the thread object here */
  26841. void *(*xTask)(void*), /* Routine to run in a separate thread */
  26842. void *pIn /* Argument passed into xTask() */
  26843. ){
  26844. SQLiteThread *p;
  26845. int rc;
  26846. assert( ppThread!=0 );
  26847. assert( xTask!=0 );
  26848. /* This routine is never used in single-threaded mode */
  26849. assert( sqlite3GlobalConfig.bCoreMutex!=0 );
  26850. *ppThread = 0;
  26851. p = sqlite3Malloc(sizeof(*p));
  26852. if( p==0 ) return SQLITE_NOMEM_BKPT;
  26853. memset(p, 0, sizeof(*p));
  26854. p->xTask = xTask;
  26855. p->pIn = pIn;
  26856. /* If the SQLITE_TESTCTRL_FAULT_INSTALL callback is registered to a
  26857. ** function that returns SQLITE_ERROR when passed the argument 200, that
  26858. ** forces worker threads to run sequentially and deterministically
  26859. ** for testing purposes. */
  26860. if( sqlite3FaultSim(200) ){
  26861. rc = 1;
  26862. }else{
  26863. rc = pthread_create(&p->tid, 0, xTask, pIn);
  26864. }
  26865. if( rc ){
  26866. p->done = 1;
  26867. p->pOut = xTask(pIn);
  26868. }
  26869. *ppThread = p;
  26870. return SQLITE_OK;
  26871. }
  26872. /* Get the results of the thread */
  26873. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread *p, void **ppOut){
  26874. int rc;
  26875. assert( ppOut!=0 );
  26876. if( NEVER(p==0) ) return SQLITE_NOMEM_BKPT;
  26877. if( p->done ){
  26878. *ppOut = p->pOut;
  26879. rc = SQLITE_OK;
  26880. }else{
  26881. rc = pthread_join(p->tid, ppOut) ? SQLITE_ERROR : SQLITE_OK;
  26882. }
  26883. sqlite3_free(p);
  26884. return rc;
  26885. }
  26886. #endif /* SQLITE_OS_UNIX && defined(SQLITE_MUTEX_PTHREADS) */
  26887. /******************************** End Unix Pthreads *************************/
  26888. /********************************* Win32 Threads ****************************/
  26889. #if SQLITE_OS_WIN_THREADS
  26890. #define SQLITE_THREADS_IMPLEMENTED 1 /* Prevent the single-thread code below */
  26891. #include <process.h>
  26892. /* A running thread */
  26893. struct SQLiteThread {
  26894. void *tid; /* The thread handle */
  26895. unsigned id; /* The thread identifier */
  26896. void *(*xTask)(void*); /* The routine to run as a thread */
  26897. void *pIn; /* Argument to xTask */
  26898. void *pResult; /* Result of xTask */
  26899. };
  26900. /* Thread procedure Win32 compatibility shim */
  26901. static unsigned __stdcall sqlite3ThreadProc(
  26902. void *pArg /* IN: Pointer to the SQLiteThread structure */
  26903. ){
  26904. SQLiteThread *p = (SQLiteThread *)pArg;
  26905. assert( p!=0 );
  26906. #if 0
  26907. /*
  26908. ** This assert appears to trigger spuriously on certain
  26909. ** versions of Windows, possibly due to _beginthreadex()
  26910. ** and/or CreateThread() not fully setting their thread
  26911. ** ID parameter before starting the thread.
  26912. */
  26913. assert( p->id==GetCurrentThreadId() );
  26914. #endif
  26915. assert( p->xTask!=0 );
  26916. p->pResult = p->xTask(p->pIn);
  26917. _endthreadex(0);
  26918. return 0; /* NOT REACHED */
  26919. }
  26920. /* Create a new thread */
  26921. SQLITE_PRIVATE int sqlite3ThreadCreate(
  26922. SQLiteThread **ppThread, /* OUT: Write the thread object here */
  26923. void *(*xTask)(void*), /* Routine to run in a separate thread */
  26924. void *pIn /* Argument passed into xTask() */
  26925. ){
  26926. SQLiteThread *p;
  26927. assert( ppThread!=0 );
  26928. assert( xTask!=0 );
  26929. *ppThread = 0;
  26930. p = sqlite3Malloc(sizeof(*p));
  26931. if( p==0 ) return SQLITE_NOMEM_BKPT;
  26932. /* If the SQLITE_TESTCTRL_FAULT_INSTALL callback is registered to a
  26933. ** function that returns SQLITE_ERROR when passed the argument 200, that
  26934. ** forces worker threads to run sequentially and deterministically
  26935. ** (via the sqlite3FaultSim() term of the conditional) for testing
  26936. ** purposes. */
  26937. if( sqlite3GlobalConfig.bCoreMutex==0 || sqlite3FaultSim(200) ){
  26938. memset(p, 0, sizeof(*p));
  26939. }else{
  26940. p->xTask = xTask;
  26941. p->pIn = pIn;
  26942. p->tid = (void*)_beginthreadex(0, 0, sqlite3ThreadProc, p, 0, &p->id);
  26943. if( p->tid==0 ){
  26944. memset(p, 0, sizeof(*p));
  26945. }
  26946. }
  26947. if( p->xTask==0 ){
  26948. p->id = GetCurrentThreadId();
  26949. p->pResult = xTask(pIn);
  26950. }
  26951. *ppThread = p;
  26952. return SQLITE_OK;
  26953. }
  26954. SQLITE_PRIVATE DWORD sqlite3Win32Wait(HANDLE hObject); /* os_win.c */
  26955. /* Get the results of the thread */
  26956. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread *p, void **ppOut){
  26957. DWORD rc;
  26958. BOOL bRc;
  26959. assert( ppOut!=0 );
  26960. if( NEVER(p==0) ) return SQLITE_NOMEM_BKPT;
  26961. if( p->xTask==0 ){
  26962. /* assert( p->id==GetCurrentThreadId() ); */
  26963. rc = WAIT_OBJECT_0;
  26964. assert( p->tid==0 );
  26965. }else{
  26966. assert( p->id!=0 && p->id!=GetCurrentThreadId() );
  26967. rc = sqlite3Win32Wait((HANDLE)p->tid);
  26968. assert( rc!=WAIT_IO_COMPLETION );
  26969. bRc = CloseHandle((HANDLE)p->tid);
  26970. assert( bRc );
  26971. }
  26972. if( rc==WAIT_OBJECT_0 ) *ppOut = p->pResult;
  26973. sqlite3_free(p);
  26974. return (rc==WAIT_OBJECT_0) ? SQLITE_OK : SQLITE_ERROR;
  26975. }
  26976. #endif /* SQLITE_OS_WIN_THREADS */
  26977. /******************************** End Win32 Threads *************************/
  26978. /********************************* Single-Threaded **************************/
  26979. #ifndef SQLITE_THREADS_IMPLEMENTED
  26980. /*
  26981. ** This implementation does not actually create a new thread. It does the
  26982. ** work of the thread in the main thread, when either the thread is created
  26983. ** or when it is joined
  26984. */
  26985. /* A running thread */
  26986. struct SQLiteThread {
  26987. void *(*xTask)(void*); /* The routine to run as a thread */
  26988. void *pIn; /* Argument to xTask */
  26989. void *pResult; /* Result of xTask */
  26990. };
  26991. /* Create a new thread */
  26992. SQLITE_PRIVATE int sqlite3ThreadCreate(
  26993. SQLiteThread **ppThread, /* OUT: Write the thread object here */
  26994. void *(*xTask)(void*), /* Routine to run in a separate thread */
  26995. void *pIn /* Argument passed into xTask() */
  26996. ){
  26997. SQLiteThread *p;
  26998. assert( ppThread!=0 );
  26999. assert( xTask!=0 );
  27000. *ppThread = 0;
  27001. p = sqlite3Malloc(sizeof(*p));
  27002. if( p==0 ) return SQLITE_NOMEM_BKPT;
  27003. if( (SQLITE_PTR_TO_INT(p)/17)&1 ){
  27004. p->xTask = xTask;
  27005. p->pIn = pIn;
  27006. }else{
  27007. p->xTask = 0;
  27008. p->pResult = xTask(pIn);
  27009. }
  27010. *ppThread = p;
  27011. return SQLITE_OK;
  27012. }
  27013. /* Get the results of the thread */
  27014. SQLITE_PRIVATE int sqlite3ThreadJoin(SQLiteThread *p, void **ppOut){
  27015. assert( ppOut!=0 );
  27016. if( NEVER(p==0) ) return SQLITE_NOMEM_BKPT;
  27017. if( p->xTask ){
  27018. *ppOut = p->xTask(p->pIn);
  27019. }else{
  27020. *ppOut = p->pResult;
  27021. }
  27022. sqlite3_free(p);
  27023. #if defined(SQLITE_TEST)
  27024. {
  27025. void *pTstAlloc = sqlite3Malloc(10);
  27026. if (!pTstAlloc) return SQLITE_NOMEM_BKPT;
  27027. sqlite3_free(pTstAlloc);
  27028. }
  27029. #endif
  27030. return SQLITE_OK;
  27031. }
  27032. #endif /* !defined(SQLITE_THREADS_IMPLEMENTED) */
  27033. /****************************** End Single-Threaded *************************/
  27034. #endif /* SQLITE_MAX_WORKER_THREADS>0 */
  27035. /************** End of threads.c *********************************************/
  27036. /************** Begin file utf.c *********************************************/
  27037. /*
  27038. ** 2004 April 13
  27039. **
  27040. ** The author disclaims copyright to this source code. In place of
  27041. ** a legal notice, here is a blessing:
  27042. **
  27043. ** May you do good and not evil.
  27044. ** May you find forgiveness for yourself and forgive others.
  27045. ** May you share freely, never taking more than you give.
  27046. **
  27047. *************************************************************************
  27048. ** This file contains routines used to translate between UTF-8,
  27049. ** UTF-16, UTF-16BE, and UTF-16LE.
  27050. **
  27051. ** Notes on UTF-8:
  27052. **
  27053. ** Byte-0 Byte-1 Byte-2 Byte-3 Value
  27054. ** 0xxxxxxx 00000000 00000000 0xxxxxxx
  27055. ** 110yyyyy 10xxxxxx 00000000 00000yyy yyxxxxxx
  27056. ** 1110zzzz 10yyyyyy 10xxxxxx 00000000 zzzzyyyy yyxxxxxx
  27057. ** 11110uuu 10uuzzzz 10yyyyyy 10xxxxxx 000uuuuu zzzzyyyy yyxxxxxx
  27058. **
  27059. **
  27060. ** Notes on UTF-16: (with wwww+1==uuuuu)
  27061. **
  27062. ** Word-0 Word-1 Value
  27063. ** 110110ww wwzzzzyy 110111yy yyxxxxxx 000uuuuu zzzzyyyy yyxxxxxx
  27064. ** zzzzyyyy yyxxxxxx 00000000 zzzzyyyy yyxxxxxx
  27065. **
  27066. **
  27067. ** BOM or Byte Order Mark:
  27068. ** 0xff 0xfe little-endian utf-16 follows
  27069. ** 0xfe 0xff big-endian utf-16 follows
  27070. **
  27071. */
  27072. /* #include "sqliteInt.h" */
  27073. /* #include <assert.h> */
  27074. /* #include "vdbeInt.h" */
  27075. #if !defined(SQLITE_AMALGAMATION) && SQLITE_BYTEORDER==0
  27076. /*
  27077. ** The following constant value is used by the SQLITE_BIGENDIAN and
  27078. ** SQLITE_LITTLEENDIAN macros.
  27079. */
  27080. SQLITE_PRIVATE const int sqlite3one = 1;
  27081. #endif /* SQLITE_AMALGAMATION && SQLITE_BYTEORDER==0 */
  27082. /*
  27083. ** This lookup table is used to help decode the first byte of
  27084. ** a multi-byte UTF8 character.
  27085. */
  27086. static const unsigned char sqlite3Utf8Trans1[] = {
  27087. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  27088. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  27089. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  27090. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  27091. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  27092. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  27093. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  27094. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  27095. };
  27096. #define WRITE_UTF8(zOut, c) { \
  27097. if( c<0x00080 ){ \
  27098. *zOut++ = (u8)(c&0xFF); \
  27099. } \
  27100. else if( c<0x00800 ){ \
  27101. *zOut++ = 0xC0 + (u8)((c>>6)&0x1F); \
  27102. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  27103. } \
  27104. else if( c<0x10000 ){ \
  27105. *zOut++ = 0xE0 + (u8)((c>>12)&0x0F); \
  27106. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  27107. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  27108. }else{ \
  27109. *zOut++ = 0xF0 + (u8)((c>>18) & 0x07); \
  27110. *zOut++ = 0x80 + (u8)((c>>12) & 0x3F); \
  27111. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  27112. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  27113. } \
  27114. }
  27115. #define WRITE_UTF16LE(zOut, c) { \
  27116. if( c<=0xFFFF ){ \
  27117. *zOut++ = (u8)(c&0x00FF); \
  27118. *zOut++ = (u8)((c>>8)&0x00FF); \
  27119. }else{ \
  27120. *zOut++ = (u8)(((c>>10)&0x003F) + (((c-0x10000)>>10)&0x00C0)); \
  27121. *zOut++ = (u8)(0x00D8 + (((c-0x10000)>>18)&0x03)); \
  27122. *zOut++ = (u8)(c&0x00FF); \
  27123. *zOut++ = (u8)(0x00DC + ((c>>8)&0x03)); \
  27124. } \
  27125. }
  27126. #define WRITE_UTF16BE(zOut, c) { \
  27127. if( c<=0xFFFF ){ \
  27128. *zOut++ = (u8)((c>>8)&0x00FF); \
  27129. *zOut++ = (u8)(c&0x00FF); \
  27130. }else{ \
  27131. *zOut++ = (u8)(0x00D8 + (((c-0x10000)>>18)&0x03)); \
  27132. *zOut++ = (u8)(((c>>10)&0x003F) + (((c-0x10000)>>10)&0x00C0)); \
  27133. *zOut++ = (u8)(0x00DC + ((c>>8)&0x03)); \
  27134. *zOut++ = (u8)(c&0x00FF); \
  27135. } \
  27136. }
  27137. #define READ_UTF16LE(zIn, TERM, c){ \
  27138. c = (*zIn++); \
  27139. c += ((*zIn++)<<8); \
  27140. if( c>=0xD800 && c<0xE000 && TERM ){ \
  27141. int c2 = (*zIn++); \
  27142. c2 += ((*zIn++)<<8); \
  27143. c = (c2&0x03FF) + ((c&0x003F)<<10) + (((c&0x03C0)+0x0040)<<10); \
  27144. } \
  27145. }
  27146. #define READ_UTF16BE(zIn, TERM, c){ \
  27147. c = ((*zIn++)<<8); \
  27148. c += (*zIn++); \
  27149. if( c>=0xD800 && c<0xE000 && TERM ){ \
  27150. int c2 = ((*zIn++)<<8); \
  27151. c2 += (*zIn++); \
  27152. c = (c2&0x03FF) + ((c&0x003F)<<10) + (((c&0x03C0)+0x0040)<<10); \
  27153. } \
  27154. }
  27155. /*
  27156. ** Translate a single UTF-8 character. Return the unicode value.
  27157. **
  27158. ** During translation, assume that the byte that zTerm points
  27159. ** is a 0x00.
  27160. **
  27161. ** Write a pointer to the next unread byte back into *pzNext.
  27162. **
  27163. ** Notes On Invalid UTF-8:
  27164. **
  27165. ** * This routine never allows a 7-bit character (0x00 through 0x7f) to
  27166. ** be encoded as a multi-byte character. Any multi-byte character that
  27167. ** attempts to encode a value between 0x00 and 0x7f is rendered as 0xfffd.
  27168. **
  27169. ** * This routine never allows a UTF16 surrogate value to be encoded.
  27170. ** If a multi-byte character attempts to encode a value between
  27171. ** 0xd800 and 0xe000 then it is rendered as 0xfffd.
  27172. **
  27173. ** * Bytes in the range of 0x80 through 0xbf which occur as the first
  27174. ** byte of a character are interpreted as single-byte characters
  27175. ** and rendered as themselves even though they are technically
  27176. ** invalid characters.
  27177. **
  27178. ** * This routine accepts over-length UTF8 encodings
  27179. ** for unicode values 0x80 and greater. It does not change over-length
  27180. ** encodings to 0xfffd as some systems recommend.
  27181. */
  27182. #define READ_UTF8(zIn, zTerm, c) \
  27183. c = *(zIn++); \
  27184. if( c>=0xc0 ){ \
  27185. c = sqlite3Utf8Trans1[c-0xc0]; \
  27186. while( zIn!=zTerm && (*zIn & 0xc0)==0x80 ){ \
  27187. c = (c<<6) + (0x3f & *(zIn++)); \
  27188. } \
  27189. if( c<0x80 \
  27190. || (c&0xFFFFF800)==0xD800 \
  27191. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } \
  27192. }
  27193. SQLITE_PRIVATE u32 sqlite3Utf8Read(
  27194. const unsigned char **pz /* Pointer to string from which to read char */
  27195. ){
  27196. unsigned int c;
  27197. /* Same as READ_UTF8() above but without the zTerm parameter.
  27198. ** For this routine, we assume the UTF8 string is always zero-terminated.
  27199. */
  27200. c = *((*pz)++);
  27201. if( c>=0xc0 ){
  27202. c = sqlite3Utf8Trans1[c-0xc0];
  27203. while( (*(*pz) & 0xc0)==0x80 ){
  27204. c = (c<<6) + (0x3f & *((*pz)++));
  27205. }
  27206. if( c<0x80
  27207. || (c&0xFFFFF800)==0xD800
  27208. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; }
  27209. }
  27210. return c;
  27211. }
  27212. /*
  27213. ** If the TRANSLATE_TRACE macro is defined, the value of each Mem is
  27214. ** printed on stderr on the way into and out of sqlite3VdbeMemTranslate().
  27215. */
  27216. /* #define TRANSLATE_TRACE 1 */
  27217. #ifndef SQLITE_OMIT_UTF16
  27218. /*
  27219. ** This routine transforms the internal text encoding used by pMem to
  27220. ** desiredEnc. It is an error if the string is already of the desired
  27221. ** encoding, or if *pMem does not contain a string value.
  27222. */
  27223. SQLITE_PRIVATE SQLITE_NOINLINE int sqlite3VdbeMemTranslate(Mem *pMem, u8 desiredEnc){
  27224. int len; /* Maximum length of output string in bytes */
  27225. unsigned char *zOut; /* Output buffer */
  27226. unsigned char *zIn; /* Input iterator */
  27227. unsigned char *zTerm; /* End of input */
  27228. unsigned char *z; /* Output iterator */
  27229. unsigned int c;
  27230. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  27231. assert( pMem->flags&MEM_Str );
  27232. assert( pMem->enc!=desiredEnc );
  27233. assert( pMem->enc!=0 );
  27234. assert( pMem->n>=0 );
  27235. #if defined(TRANSLATE_TRACE) && defined(SQLITE_DEBUG)
  27236. {
  27237. char zBuf[100];
  27238. sqlite3VdbeMemPrettyPrint(pMem, zBuf);
  27239. fprintf(stderr, "INPUT: %s\n", zBuf);
  27240. }
  27241. #endif
  27242. /* If the translation is between UTF-16 little and big endian, then
  27243. ** all that is required is to swap the byte order. This case is handled
  27244. ** differently from the others.
  27245. */
  27246. if( pMem->enc!=SQLITE_UTF8 && desiredEnc!=SQLITE_UTF8 ){
  27247. u8 temp;
  27248. int rc;
  27249. rc = sqlite3VdbeMemMakeWriteable(pMem);
  27250. if( rc!=SQLITE_OK ){
  27251. assert( rc==SQLITE_NOMEM );
  27252. return SQLITE_NOMEM_BKPT;
  27253. }
  27254. zIn = (u8*)pMem->z;
  27255. zTerm = &zIn[pMem->n&~1];
  27256. while( zIn<zTerm ){
  27257. temp = *zIn;
  27258. *zIn = *(zIn+1);
  27259. zIn++;
  27260. *zIn++ = temp;
  27261. }
  27262. pMem->enc = desiredEnc;
  27263. goto translate_out;
  27264. }
  27265. /* Set len to the maximum number of bytes required in the output buffer. */
  27266. if( desiredEnc==SQLITE_UTF8 ){
  27267. /* When converting from UTF-16, the maximum growth results from
  27268. ** translating a 2-byte character to a 4-byte UTF-8 character.
  27269. ** A single byte is required for the output string
  27270. ** nul-terminator.
  27271. */
  27272. pMem->n &= ~1;
  27273. len = pMem->n * 2 + 1;
  27274. }else{
  27275. /* When converting from UTF-8 to UTF-16 the maximum growth is caused
  27276. ** when a 1-byte UTF-8 character is translated into a 2-byte UTF-16
  27277. ** character. Two bytes are required in the output buffer for the
  27278. ** nul-terminator.
  27279. */
  27280. len = pMem->n * 2 + 2;
  27281. }
  27282. /* Set zIn to point at the start of the input buffer and zTerm to point 1
  27283. ** byte past the end.
  27284. **
  27285. ** Variable zOut is set to point at the output buffer, space obtained
  27286. ** from sqlite3_malloc().
  27287. */
  27288. zIn = (u8*)pMem->z;
  27289. zTerm = &zIn[pMem->n];
  27290. zOut = sqlite3DbMallocRaw(pMem->db, len);
  27291. if( !zOut ){
  27292. return SQLITE_NOMEM_BKPT;
  27293. }
  27294. z = zOut;
  27295. if( pMem->enc==SQLITE_UTF8 ){
  27296. if( desiredEnc==SQLITE_UTF16LE ){
  27297. /* UTF-8 -> UTF-16 Little-endian */
  27298. while( zIn<zTerm ){
  27299. READ_UTF8(zIn, zTerm, c);
  27300. WRITE_UTF16LE(z, c);
  27301. }
  27302. }else{
  27303. assert( desiredEnc==SQLITE_UTF16BE );
  27304. /* UTF-8 -> UTF-16 Big-endian */
  27305. while( zIn<zTerm ){
  27306. READ_UTF8(zIn, zTerm, c);
  27307. WRITE_UTF16BE(z, c);
  27308. }
  27309. }
  27310. pMem->n = (int)(z - zOut);
  27311. *z++ = 0;
  27312. }else{
  27313. assert( desiredEnc==SQLITE_UTF8 );
  27314. if( pMem->enc==SQLITE_UTF16LE ){
  27315. /* UTF-16 Little-endian -> UTF-8 */
  27316. while( zIn<zTerm ){
  27317. READ_UTF16LE(zIn, zIn<zTerm, c);
  27318. WRITE_UTF8(z, c);
  27319. }
  27320. }else{
  27321. /* UTF-16 Big-endian -> UTF-8 */
  27322. while( zIn<zTerm ){
  27323. READ_UTF16BE(zIn, zIn<zTerm, c);
  27324. WRITE_UTF8(z, c);
  27325. }
  27326. }
  27327. pMem->n = (int)(z - zOut);
  27328. }
  27329. *z = 0;
  27330. assert( (pMem->n+(desiredEnc==SQLITE_UTF8?1:2))<=len );
  27331. c = pMem->flags;
  27332. sqlite3VdbeMemRelease(pMem);
  27333. pMem->flags = MEM_Str|MEM_Term|(c&(MEM_AffMask|MEM_Subtype));
  27334. pMem->enc = desiredEnc;
  27335. pMem->z = (char*)zOut;
  27336. pMem->zMalloc = pMem->z;
  27337. pMem->szMalloc = sqlite3DbMallocSize(pMem->db, pMem->z);
  27338. translate_out:
  27339. #if defined(TRANSLATE_TRACE) && defined(SQLITE_DEBUG)
  27340. {
  27341. char zBuf[100];
  27342. sqlite3VdbeMemPrettyPrint(pMem, zBuf);
  27343. fprintf(stderr, "OUTPUT: %s\n", zBuf);
  27344. }
  27345. #endif
  27346. return SQLITE_OK;
  27347. }
  27348. #endif /* SQLITE_OMIT_UTF16 */
  27349. #ifndef SQLITE_OMIT_UTF16
  27350. /*
  27351. ** This routine checks for a byte-order mark at the beginning of the
  27352. ** UTF-16 string stored in *pMem. If one is present, it is removed and
  27353. ** the encoding of the Mem adjusted. This routine does not do any
  27354. ** byte-swapping, it just sets Mem.enc appropriately.
  27355. **
  27356. ** The allocation (static, dynamic etc.) and encoding of the Mem may be
  27357. ** changed by this function.
  27358. */
  27359. SQLITE_PRIVATE int sqlite3VdbeMemHandleBom(Mem *pMem){
  27360. int rc = SQLITE_OK;
  27361. u8 bom = 0;
  27362. assert( pMem->n>=0 );
  27363. if( pMem->n>1 ){
  27364. u8 b1 = *(u8 *)pMem->z;
  27365. u8 b2 = *(((u8 *)pMem->z) + 1);
  27366. if( b1==0xFE && b2==0xFF ){
  27367. bom = SQLITE_UTF16BE;
  27368. }
  27369. if( b1==0xFF && b2==0xFE ){
  27370. bom = SQLITE_UTF16LE;
  27371. }
  27372. }
  27373. if( bom ){
  27374. rc = sqlite3VdbeMemMakeWriteable(pMem);
  27375. if( rc==SQLITE_OK ){
  27376. pMem->n -= 2;
  27377. memmove(pMem->z, &pMem->z[2], pMem->n);
  27378. pMem->z[pMem->n] = '\0';
  27379. pMem->z[pMem->n+1] = '\0';
  27380. pMem->flags |= MEM_Term;
  27381. pMem->enc = bom;
  27382. }
  27383. }
  27384. return rc;
  27385. }
  27386. #endif /* SQLITE_OMIT_UTF16 */
  27387. /*
  27388. ** pZ is a UTF-8 encoded unicode string. If nByte is less than zero,
  27389. ** return the number of unicode characters in pZ up to (but not including)
  27390. ** the first 0x00 byte. If nByte is not less than zero, return the
  27391. ** number of unicode characters in the first nByte of pZ (or up to
  27392. ** the first 0x00, whichever comes first).
  27393. */
  27394. SQLITE_PRIVATE int sqlite3Utf8CharLen(const char *zIn, int nByte){
  27395. int r = 0;
  27396. const u8 *z = (const u8*)zIn;
  27397. const u8 *zTerm;
  27398. if( nByte>=0 ){
  27399. zTerm = &z[nByte];
  27400. }else{
  27401. zTerm = (const u8*)(-1);
  27402. }
  27403. assert( z<=zTerm );
  27404. while( *z!=0 && z<zTerm ){
  27405. SQLITE_SKIP_UTF8(z);
  27406. r++;
  27407. }
  27408. return r;
  27409. }
  27410. /* This test function is not currently used by the automated test-suite.
  27411. ** Hence it is only available in debug builds.
  27412. */
  27413. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  27414. /*
  27415. ** Translate UTF-8 to UTF-8.
  27416. **
  27417. ** This has the effect of making sure that the string is well-formed
  27418. ** UTF-8. Miscoded characters are removed.
  27419. **
  27420. ** The translation is done in-place and aborted if the output
  27421. ** overruns the input.
  27422. */
  27423. SQLITE_PRIVATE int sqlite3Utf8To8(unsigned char *zIn){
  27424. unsigned char *zOut = zIn;
  27425. unsigned char *zStart = zIn;
  27426. u32 c;
  27427. while( zIn[0] && zOut<=zIn ){
  27428. c = sqlite3Utf8Read((const u8**)&zIn);
  27429. if( c!=0xfffd ){
  27430. WRITE_UTF8(zOut, c);
  27431. }
  27432. }
  27433. *zOut = 0;
  27434. return (int)(zOut - zStart);
  27435. }
  27436. #endif
  27437. #ifndef SQLITE_OMIT_UTF16
  27438. /*
  27439. ** Convert a UTF-16 string in the native encoding into a UTF-8 string.
  27440. ** Memory to hold the UTF-8 string is obtained from sqlite3_malloc and must
  27441. ** be freed by the calling function.
  27442. **
  27443. ** NULL is returned if there is an allocation error.
  27444. */
  27445. SQLITE_PRIVATE char *sqlite3Utf16to8(sqlite3 *db, const void *z, int nByte, u8 enc){
  27446. Mem m;
  27447. memset(&m, 0, sizeof(m));
  27448. m.db = db;
  27449. sqlite3VdbeMemSetStr(&m, z, nByte, enc, SQLITE_STATIC);
  27450. sqlite3VdbeChangeEncoding(&m, SQLITE_UTF8);
  27451. if( db->mallocFailed ){
  27452. sqlite3VdbeMemRelease(&m);
  27453. m.z = 0;
  27454. }
  27455. assert( (m.flags & MEM_Term)!=0 || db->mallocFailed );
  27456. assert( (m.flags & MEM_Str)!=0 || db->mallocFailed );
  27457. assert( m.z || db->mallocFailed );
  27458. return m.z;
  27459. }
  27460. /*
  27461. ** zIn is a UTF-16 encoded unicode string at least nChar characters long.
  27462. ** Return the number of bytes in the first nChar unicode characters
  27463. ** in pZ. nChar must be non-negative.
  27464. */
  27465. SQLITE_PRIVATE int sqlite3Utf16ByteLen(const void *zIn, int nChar){
  27466. int c;
  27467. unsigned char const *z = zIn;
  27468. int n = 0;
  27469. if( SQLITE_UTF16NATIVE==SQLITE_UTF16BE ){
  27470. while( n<nChar ){
  27471. READ_UTF16BE(z, 1, c);
  27472. n++;
  27473. }
  27474. }else{
  27475. while( n<nChar ){
  27476. READ_UTF16LE(z, 1, c);
  27477. n++;
  27478. }
  27479. }
  27480. return (int)(z-(unsigned char const *)zIn);
  27481. }
  27482. #if defined(SQLITE_TEST)
  27483. /*
  27484. ** This routine is called from the TCL test function "translate_selftest".
  27485. ** It checks that the primitives for serializing and deserializing
  27486. ** characters in each encoding are inverses of each other.
  27487. */
  27488. SQLITE_PRIVATE void sqlite3UtfSelfTest(void){
  27489. unsigned int i, t;
  27490. unsigned char zBuf[20];
  27491. unsigned char *z;
  27492. int n;
  27493. unsigned int c;
  27494. for(i=0; i<0x00110000; i++){
  27495. z = zBuf;
  27496. WRITE_UTF8(z, i);
  27497. n = (int)(z-zBuf);
  27498. assert( n>0 && n<=4 );
  27499. z[0] = 0;
  27500. z = zBuf;
  27501. c = sqlite3Utf8Read((const u8**)&z);
  27502. t = i;
  27503. if( i>=0xD800 && i<=0xDFFF ) t = 0xFFFD;
  27504. if( (i&0xFFFFFFFE)==0xFFFE ) t = 0xFFFD;
  27505. assert( c==t );
  27506. assert( (z-zBuf)==n );
  27507. }
  27508. for(i=0; i<0x00110000; i++){
  27509. if( i>=0xD800 && i<0xE000 ) continue;
  27510. z = zBuf;
  27511. WRITE_UTF16LE(z, i);
  27512. n = (int)(z-zBuf);
  27513. assert( n>0 && n<=4 );
  27514. z[0] = 0;
  27515. z = zBuf;
  27516. READ_UTF16LE(z, 1, c);
  27517. assert( c==i );
  27518. assert( (z-zBuf)==n );
  27519. }
  27520. for(i=0; i<0x00110000; i++){
  27521. if( i>=0xD800 && i<0xE000 ) continue;
  27522. z = zBuf;
  27523. WRITE_UTF16BE(z, i);
  27524. n = (int)(z-zBuf);
  27525. assert( n>0 && n<=4 );
  27526. z[0] = 0;
  27527. z = zBuf;
  27528. READ_UTF16BE(z, 1, c);
  27529. assert( c==i );
  27530. assert( (z-zBuf)==n );
  27531. }
  27532. }
  27533. #endif /* SQLITE_TEST */
  27534. #endif /* SQLITE_OMIT_UTF16 */
  27535. /************** End of utf.c *************************************************/
  27536. /************** Begin file util.c ********************************************/
  27537. /*
  27538. ** 2001 September 15
  27539. **
  27540. ** The author disclaims copyright to this source code. In place of
  27541. ** a legal notice, here is a blessing:
  27542. **
  27543. ** May you do good and not evil.
  27544. ** May you find forgiveness for yourself and forgive others.
  27545. ** May you share freely, never taking more than you give.
  27546. **
  27547. *************************************************************************
  27548. ** Utility functions used throughout sqlite.
  27549. **
  27550. ** This file contains functions for allocating memory, comparing
  27551. ** strings, and stuff like that.
  27552. **
  27553. */
  27554. /* #include "sqliteInt.h" */
  27555. /* #include <stdarg.h> */
  27556. #if HAVE_ISNAN || SQLITE_HAVE_ISNAN
  27557. # include <math.h>
  27558. #endif
  27559. /*
  27560. ** Routine needed to support the testcase() macro.
  27561. */
  27562. #ifdef SQLITE_COVERAGE_TEST
  27563. SQLITE_PRIVATE void sqlite3Coverage(int x){
  27564. static unsigned dummy = 0;
  27565. dummy += (unsigned)x;
  27566. }
  27567. #endif
  27568. /*
  27569. ** Give a callback to the test harness that can be used to simulate faults
  27570. ** in places where it is difficult or expensive to do so purely by means
  27571. ** of inputs.
  27572. **
  27573. ** The intent of the integer argument is to let the fault simulator know
  27574. ** which of multiple sqlite3FaultSim() calls has been hit.
  27575. **
  27576. ** Return whatever integer value the test callback returns, or return
  27577. ** SQLITE_OK if no test callback is installed.
  27578. */
  27579. #ifndef SQLITE_UNTESTABLE
  27580. SQLITE_PRIVATE int sqlite3FaultSim(int iTest){
  27581. int (*xCallback)(int) = sqlite3GlobalConfig.xTestCallback;
  27582. return xCallback ? xCallback(iTest) : SQLITE_OK;
  27583. }
  27584. #endif
  27585. #ifndef SQLITE_OMIT_FLOATING_POINT
  27586. /*
  27587. ** Return true if the floating point value is Not a Number (NaN).
  27588. **
  27589. ** Use the math library isnan() function if compiled with SQLITE_HAVE_ISNAN.
  27590. ** Otherwise, we have our own implementation that works on most systems.
  27591. */
  27592. SQLITE_PRIVATE int sqlite3IsNaN(double x){
  27593. int rc; /* The value return */
  27594. #if !SQLITE_HAVE_ISNAN && !HAVE_ISNAN
  27595. /*
  27596. ** Systems that support the isnan() library function should probably
  27597. ** make use of it by compiling with -DSQLITE_HAVE_ISNAN. But we have
  27598. ** found that many systems do not have a working isnan() function so
  27599. ** this implementation is provided as an alternative.
  27600. **
  27601. ** This NaN test sometimes fails if compiled on GCC with -ffast-math.
  27602. ** On the other hand, the use of -ffast-math comes with the following
  27603. ** warning:
  27604. **
  27605. ** This option [-ffast-math] should never be turned on by any
  27606. ** -O option since it can result in incorrect output for programs
  27607. ** which depend on an exact implementation of IEEE or ISO
  27608. ** rules/specifications for math functions.
  27609. **
  27610. ** Under MSVC, this NaN test may fail if compiled with a floating-
  27611. ** point precision mode other than /fp:precise. From the MSDN
  27612. ** documentation:
  27613. **
  27614. ** The compiler [with /fp:precise] will properly handle comparisons
  27615. ** involving NaN. For example, x != x evaluates to true if x is NaN
  27616. ** ...
  27617. */
  27618. #ifdef __FAST_MATH__
  27619. # error SQLite will not work correctly with the -ffast-math option of GCC.
  27620. #endif
  27621. volatile double y = x;
  27622. volatile double z = y;
  27623. rc = (y!=z);
  27624. #else /* if HAVE_ISNAN */
  27625. rc = isnan(x);
  27626. #endif /* HAVE_ISNAN */
  27627. testcase( rc );
  27628. return rc;
  27629. }
  27630. #endif /* SQLITE_OMIT_FLOATING_POINT */
  27631. /*
  27632. ** Compute a string length that is limited to what can be stored in
  27633. ** lower 30 bits of a 32-bit signed integer.
  27634. **
  27635. ** The value returned will never be negative. Nor will it ever be greater
  27636. ** than the actual length of the string. For very long strings (greater
  27637. ** than 1GiB) the value returned might be less than the true string length.
  27638. */
  27639. SQLITE_PRIVATE int sqlite3Strlen30(const char *z){
  27640. if( z==0 ) return 0;
  27641. return 0x3fffffff & (int)strlen(z);
  27642. }
  27643. /*
  27644. ** Return the declared type of a column. Or return zDflt if the column
  27645. ** has no declared type.
  27646. **
  27647. ** The column type is an extra string stored after the zero-terminator on
  27648. ** the column name if and only if the COLFLAG_HASTYPE flag is set.
  27649. */
  27650. SQLITE_PRIVATE char *sqlite3ColumnType(Column *pCol, char *zDflt){
  27651. if( (pCol->colFlags & COLFLAG_HASTYPE)==0 ) return zDflt;
  27652. return pCol->zName + strlen(pCol->zName) + 1;
  27653. }
  27654. /*
  27655. ** Helper function for sqlite3Error() - called rarely. Broken out into
  27656. ** a separate routine to avoid unnecessary register saves on entry to
  27657. ** sqlite3Error().
  27658. */
  27659. static SQLITE_NOINLINE void sqlite3ErrorFinish(sqlite3 *db, int err_code){
  27660. if( db->pErr ) sqlite3ValueSetNull(db->pErr);
  27661. sqlite3SystemError(db, err_code);
  27662. }
  27663. /*
  27664. ** Set the current error code to err_code and clear any prior error message.
  27665. ** Also set iSysErrno (by calling sqlite3System) if the err_code indicates
  27666. ** that would be appropriate.
  27667. */
  27668. SQLITE_PRIVATE void sqlite3Error(sqlite3 *db, int err_code){
  27669. assert( db!=0 );
  27670. db->errCode = err_code;
  27671. if( err_code || db->pErr ) sqlite3ErrorFinish(db, err_code);
  27672. }
  27673. /*
  27674. ** Load the sqlite3.iSysErrno field if that is an appropriate thing
  27675. ** to do based on the SQLite error code in rc.
  27676. */
  27677. SQLITE_PRIVATE void sqlite3SystemError(sqlite3 *db, int rc){
  27678. if( rc==SQLITE_IOERR_NOMEM ) return;
  27679. rc &= 0xff;
  27680. if( rc==SQLITE_CANTOPEN || rc==SQLITE_IOERR ){
  27681. db->iSysErrno = sqlite3OsGetLastError(db->pVfs);
  27682. }
  27683. }
  27684. /*
  27685. ** Set the most recent error code and error string for the sqlite
  27686. ** handle "db". The error code is set to "err_code".
  27687. **
  27688. ** If it is not NULL, string zFormat specifies the format of the
  27689. ** error string in the style of the printf functions: The following
  27690. ** format characters are allowed:
  27691. **
  27692. ** %s Insert a string
  27693. ** %z A string that should be freed after use
  27694. ** %d Insert an integer
  27695. ** %T Insert a token
  27696. ** %S Insert the first element of a SrcList
  27697. **
  27698. ** zFormat and any string tokens that follow it are assumed to be
  27699. ** encoded in UTF-8.
  27700. **
  27701. ** To clear the most recent error for sqlite handle "db", sqlite3Error
  27702. ** should be called with err_code set to SQLITE_OK and zFormat set
  27703. ** to NULL.
  27704. */
  27705. SQLITE_PRIVATE void sqlite3ErrorWithMsg(sqlite3 *db, int err_code, const char *zFormat, ...){
  27706. assert( db!=0 );
  27707. db->errCode = err_code;
  27708. sqlite3SystemError(db, err_code);
  27709. if( zFormat==0 ){
  27710. sqlite3Error(db, err_code);
  27711. }else if( db->pErr || (db->pErr = sqlite3ValueNew(db))!=0 ){
  27712. char *z;
  27713. va_list ap;
  27714. va_start(ap, zFormat);
  27715. z = sqlite3VMPrintf(db, zFormat, ap);
  27716. va_end(ap);
  27717. sqlite3ValueSetStr(db->pErr, -1, z, SQLITE_UTF8, SQLITE_DYNAMIC);
  27718. }
  27719. }
  27720. /*
  27721. ** Add an error message to pParse->zErrMsg and increment pParse->nErr.
  27722. ** The following formatting characters are allowed:
  27723. **
  27724. ** %s Insert a string
  27725. ** %z A string that should be freed after use
  27726. ** %d Insert an integer
  27727. ** %T Insert a token
  27728. ** %S Insert the first element of a SrcList
  27729. **
  27730. ** This function should be used to report any error that occurs while
  27731. ** compiling an SQL statement (i.e. within sqlite3_prepare()). The
  27732. ** last thing the sqlite3_prepare() function does is copy the error
  27733. ** stored by this function into the database handle using sqlite3Error().
  27734. ** Functions sqlite3Error() or sqlite3ErrorWithMsg() should be used
  27735. ** during statement execution (sqlite3_step() etc.).
  27736. */
  27737. SQLITE_PRIVATE void sqlite3ErrorMsg(Parse *pParse, const char *zFormat, ...){
  27738. char *zMsg;
  27739. va_list ap;
  27740. sqlite3 *db = pParse->db;
  27741. va_start(ap, zFormat);
  27742. zMsg = sqlite3VMPrintf(db, zFormat, ap);
  27743. va_end(ap);
  27744. if( db->suppressErr ){
  27745. sqlite3DbFree(db, zMsg);
  27746. }else{
  27747. pParse->nErr++;
  27748. sqlite3DbFree(db, pParse->zErrMsg);
  27749. pParse->zErrMsg = zMsg;
  27750. pParse->rc = SQLITE_ERROR;
  27751. }
  27752. }
  27753. /*
  27754. ** Convert an SQL-style quoted string into a normal string by removing
  27755. ** the quote characters. The conversion is done in-place. If the
  27756. ** input does not begin with a quote character, then this routine
  27757. ** is a no-op.
  27758. **
  27759. ** The input string must be zero-terminated. A new zero-terminator
  27760. ** is added to the dequoted string.
  27761. **
  27762. ** The return value is -1 if no dequoting occurs or the length of the
  27763. ** dequoted string, exclusive of the zero terminator, if dequoting does
  27764. ** occur.
  27765. **
  27766. ** 2002-Feb-14: This routine is extended to remove MS-Access style
  27767. ** brackets from around identifiers. For example: "[a-b-c]" becomes
  27768. ** "a-b-c".
  27769. */
  27770. SQLITE_PRIVATE void sqlite3Dequote(char *z){
  27771. char quote;
  27772. int i, j;
  27773. if( z==0 ) return;
  27774. quote = z[0];
  27775. if( !sqlite3Isquote(quote) ) return;
  27776. if( quote=='[' ) quote = ']';
  27777. for(i=1, j=0;; i++){
  27778. assert( z[i] );
  27779. if( z[i]==quote ){
  27780. if( z[i+1]==quote ){
  27781. z[j++] = quote;
  27782. i++;
  27783. }else{
  27784. break;
  27785. }
  27786. }else{
  27787. z[j++] = z[i];
  27788. }
  27789. }
  27790. z[j] = 0;
  27791. }
  27792. /*
  27793. ** Generate a Token object from a string
  27794. */
  27795. SQLITE_PRIVATE void sqlite3TokenInit(Token *p, char *z){
  27796. p->z = z;
  27797. p->n = sqlite3Strlen30(z);
  27798. }
  27799. /* Convenient short-hand */
  27800. #define UpperToLower sqlite3UpperToLower
  27801. /*
  27802. ** Some systems have stricmp(). Others have strcasecmp(). Because
  27803. ** there is no consistency, we will define our own.
  27804. **
  27805. ** IMPLEMENTATION-OF: R-30243-02494 The sqlite3_stricmp() and
  27806. ** sqlite3_strnicmp() APIs allow applications and extensions to compare
  27807. ** the contents of two buffers containing UTF-8 strings in a
  27808. ** case-independent fashion, using the same definition of "case
  27809. ** independence" that SQLite uses internally when comparing identifiers.
  27810. */
  27811. SQLITE_API int sqlite3_stricmp(const char *zLeft, const char *zRight){
  27812. if( zLeft==0 ){
  27813. return zRight ? -1 : 0;
  27814. }else if( zRight==0 ){
  27815. return 1;
  27816. }
  27817. return sqlite3StrICmp(zLeft, zRight);
  27818. }
  27819. SQLITE_PRIVATE int sqlite3StrICmp(const char *zLeft, const char *zRight){
  27820. unsigned char *a, *b;
  27821. int c;
  27822. a = (unsigned char *)zLeft;
  27823. b = (unsigned char *)zRight;
  27824. for(;;){
  27825. c = (int)UpperToLower[*a] - (int)UpperToLower[*b];
  27826. if( c || *a==0 ) break;
  27827. a++;
  27828. b++;
  27829. }
  27830. return c;
  27831. }
  27832. SQLITE_API int sqlite3_strnicmp(const char *zLeft, const char *zRight, int N){
  27833. register unsigned char *a, *b;
  27834. if( zLeft==0 ){
  27835. return zRight ? -1 : 0;
  27836. }else if( zRight==0 ){
  27837. return 1;
  27838. }
  27839. a = (unsigned char *)zLeft;
  27840. b = (unsigned char *)zRight;
  27841. while( N-- > 0 && *a!=0 && UpperToLower[*a]==UpperToLower[*b]){ a++; b++; }
  27842. return N<0 ? 0 : UpperToLower[*a] - UpperToLower[*b];
  27843. }
  27844. /*
  27845. ** Compute 10 to the E-th power. Examples: E==1 results in 10.
  27846. ** E==2 results in 100. E==50 results in 1.0e50.
  27847. **
  27848. ** This routine only works for values of E between 1 and 341.
  27849. */
  27850. static LONGDOUBLE_TYPE sqlite3Pow10(int E){
  27851. #if defined(_MSC_VER)
  27852. static const LONGDOUBLE_TYPE x[] = {
  27853. 1.0e+001,
  27854. 1.0e+002,
  27855. 1.0e+004,
  27856. 1.0e+008,
  27857. 1.0e+016,
  27858. 1.0e+032,
  27859. 1.0e+064,
  27860. 1.0e+128,
  27861. 1.0e+256
  27862. };
  27863. LONGDOUBLE_TYPE r = 1.0;
  27864. int i;
  27865. assert( E>=0 && E<=307 );
  27866. for(i=0; E!=0; i++, E >>=1){
  27867. if( E & 1 ) r *= x[i];
  27868. }
  27869. return r;
  27870. #else
  27871. LONGDOUBLE_TYPE x = 10.0;
  27872. LONGDOUBLE_TYPE r = 1.0;
  27873. while(1){
  27874. if( E & 1 ) r *= x;
  27875. E >>= 1;
  27876. if( E==0 ) break;
  27877. x *= x;
  27878. }
  27879. return r;
  27880. #endif
  27881. }
  27882. /*
  27883. ** The string z[] is an text representation of a real number.
  27884. ** Convert this string to a double and write it into *pResult.
  27885. **
  27886. ** The string z[] is length bytes in length (bytes, not characters) and
  27887. ** uses the encoding enc. The string is not necessarily zero-terminated.
  27888. **
  27889. ** Return TRUE if the result is a valid real number (or integer) and FALSE
  27890. ** if the string is empty or contains extraneous text. Valid numbers
  27891. ** are in one of these formats:
  27892. **
  27893. ** [+-]digits[E[+-]digits]
  27894. ** [+-]digits.[digits][E[+-]digits]
  27895. ** [+-].digits[E[+-]digits]
  27896. **
  27897. ** Leading and trailing whitespace is ignored for the purpose of determining
  27898. ** validity.
  27899. **
  27900. ** If some prefix of the input string is a valid number, this routine
  27901. ** returns FALSE but it still converts the prefix and writes the result
  27902. ** into *pResult.
  27903. */
  27904. SQLITE_PRIVATE int sqlite3AtoF(const char *z, double *pResult, int length, u8 enc){
  27905. #ifndef SQLITE_OMIT_FLOATING_POINT
  27906. int incr;
  27907. const char *zEnd = z + length;
  27908. /* sign * significand * (10 ^ (esign * exponent)) */
  27909. int sign = 1; /* sign of significand */
  27910. i64 s = 0; /* significand */
  27911. int d = 0; /* adjust exponent for shifting decimal point */
  27912. int esign = 1; /* sign of exponent */
  27913. int e = 0; /* exponent */
  27914. int eValid = 1; /* True exponent is either not used or is well-formed */
  27915. double result;
  27916. int nDigits = 0;
  27917. int nonNum = 0; /* True if input contains UTF16 with high byte non-zero */
  27918. assert( enc==SQLITE_UTF8 || enc==SQLITE_UTF16LE || enc==SQLITE_UTF16BE );
  27919. *pResult = 0.0; /* Default return value, in case of an error */
  27920. if( enc==SQLITE_UTF8 ){
  27921. incr = 1;
  27922. }else{
  27923. int i;
  27924. incr = 2;
  27925. assert( SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
  27926. for(i=3-enc; i<length && z[i]==0; i+=2){}
  27927. nonNum = i<length;
  27928. zEnd = &z[i^1];
  27929. z += (enc&1);
  27930. }
  27931. /* skip leading spaces */
  27932. while( z<zEnd && sqlite3Isspace(*z) ) z+=incr;
  27933. if( z>=zEnd ) return 0;
  27934. /* get sign of significand */
  27935. if( *z=='-' ){
  27936. sign = -1;
  27937. z+=incr;
  27938. }else if( *z=='+' ){
  27939. z+=incr;
  27940. }
  27941. /* copy max significant digits to significand */
  27942. while( z<zEnd && sqlite3Isdigit(*z) && s<((LARGEST_INT64-9)/10) ){
  27943. s = s*10 + (*z - '0');
  27944. z+=incr; nDigits++;
  27945. }
  27946. /* skip non-significant significand digits
  27947. ** (increase exponent by d to shift decimal left) */
  27948. while( z<zEnd && sqlite3Isdigit(*z) ){ z+=incr; nDigits++; d++; }
  27949. if( z>=zEnd ) goto do_atof_calc;
  27950. /* if decimal point is present */
  27951. if( *z=='.' ){
  27952. z+=incr;
  27953. /* copy digits from after decimal to significand
  27954. ** (decrease exponent by d to shift decimal right) */
  27955. while( z<zEnd && sqlite3Isdigit(*z) ){
  27956. if( s<((LARGEST_INT64-9)/10) ){
  27957. s = s*10 + (*z - '0');
  27958. d--;
  27959. }
  27960. z+=incr; nDigits++;
  27961. }
  27962. }
  27963. if( z>=zEnd ) goto do_atof_calc;
  27964. /* if exponent is present */
  27965. if( *z=='e' || *z=='E' ){
  27966. z+=incr;
  27967. eValid = 0;
  27968. /* This branch is needed to avoid a (harmless) buffer overread. The
  27969. ** special comment alerts the mutation tester that the correct answer
  27970. ** is obtained even if the branch is omitted */
  27971. if( z>=zEnd ) goto do_atof_calc; /*PREVENTS-HARMLESS-OVERREAD*/
  27972. /* get sign of exponent */
  27973. if( *z=='-' ){
  27974. esign = -1;
  27975. z+=incr;
  27976. }else if( *z=='+' ){
  27977. z+=incr;
  27978. }
  27979. /* copy digits to exponent */
  27980. while( z<zEnd && sqlite3Isdigit(*z) ){
  27981. e = e<10000 ? (e*10 + (*z - '0')) : 10000;
  27982. z+=incr;
  27983. eValid = 1;
  27984. }
  27985. }
  27986. /* skip trailing spaces */
  27987. while( z<zEnd && sqlite3Isspace(*z) ) z+=incr;
  27988. do_atof_calc:
  27989. /* adjust exponent by d, and update sign */
  27990. e = (e*esign) + d;
  27991. if( e<0 ) {
  27992. esign = -1;
  27993. e *= -1;
  27994. } else {
  27995. esign = 1;
  27996. }
  27997. if( s==0 ) {
  27998. /* In the IEEE 754 standard, zero is signed. */
  27999. result = sign<0 ? -(double)0 : (double)0;
  28000. } else {
  28001. /* Attempt to reduce exponent.
  28002. **
  28003. ** Branches that are not required for the correct answer but which only
  28004. ** help to obtain the correct answer faster are marked with special
  28005. ** comments, as a hint to the mutation tester.
  28006. */
  28007. while( e>0 ){ /*OPTIMIZATION-IF-TRUE*/
  28008. if( esign>0 ){
  28009. if( s>=(LARGEST_INT64/10) ) break; /*OPTIMIZATION-IF-FALSE*/
  28010. s *= 10;
  28011. }else{
  28012. if( s%10!=0 ) break; /*OPTIMIZATION-IF-FALSE*/
  28013. s /= 10;
  28014. }
  28015. e--;
  28016. }
  28017. /* adjust the sign of significand */
  28018. s = sign<0 ? -s : s;
  28019. if( e==0 ){ /*OPTIMIZATION-IF-TRUE*/
  28020. result = (double)s;
  28021. }else{
  28022. /* attempt to handle extremely small/large numbers better */
  28023. if( e>307 ){ /*OPTIMIZATION-IF-TRUE*/
  28024. if( e<342 ){ /*OPTIMIZATION-IF-TRUE*/
  28025. LONGDOUBLE_TYPE scale = sqlite3Pow10(e-308);
  28026. if( esign<0 ){
  28027. result = s / scale;
  28028. result /= 1.0e+308;
  28029. }else{
  28030. result = s * scale;
  28031. result *= 1.0e+308;
  28032. }
  28033. }else{ assert( e>=342 );
  28034. if( esign<0 ){
  28035. result = 0.0*s;
  28036. }else{
  28037. #ifdef INFINITY
  28038. result = INFINITY*s;
  28039. #else
  28040. result = 1e308*1e308*s; /* Infinity */
  28041. #endif
  28042. }
  28043. }
  28044. }else{
  28045. LONGDOUBLE_TYPE scale = sqlite3Pow10(e);
  28046. if( esign<0 ){
  28047. result = s / scale;
  28048. }else{
  28049. result = s * scale;
  28050. }
  28051. }
  28052. }
  28053. }
  28054. /* store the result */
  28055. *pResult = result;
  28056. /* return true if number and no extra non-whitespace chracters after */
  28057. return z==zEnd && nDigits>0 && eValid && nonNum==0;
  28058. #else
  28059. return !sqlite3Atoi64(z, pResult, length, enc);
  28060. #endif /* SQLITE_OMIT_FLOATING_POINT */
  28061. }
  28062. /*
  28063. ** Compare the 19-character string zNum against the text representation
  28064. ** value 2^63: 9223372036854775808. Return negative, zero, or positive
  28065. ** if zNum is less than, equal to, or greater than the string.
  28066. ** Note that zNum must contain exactly 19 characters.
  28067. **
  28068. ** Unlike memcmp() this routine is guaranteed to return the difference
  28069. ** in the values of the last digit if the only difference is in the
  28070. ** last digit. So, for example,
  28071. **
  28072. ** compare2pow63("9223372036854775800", 1)
  28073. **
  28074. ** will return -8.
  28075. */
  28076. static int compare2pow63(const char *zNum, int incr){
  28077. int c = 0;
  28078. int i;
  28079. /* 012345678901234567 */
  28080. const char *pow63 = "922337203685477580";
  28081. for(i=0; c==0 && i<18; i++){
  28082. c = (zNum[i*incr]-pow63[i])*10;
  28083. }
  28084. if( c==0 ){
  28085. c = zNum[18*incr] - '8';
  28086. testcase( c==(-1) );
  28087. testcase( c==0 );
  28088. testcase( c==(+1) );
  28089. }
  28090. return c;
  28091. }
  28092. /*
  28093. ** Convert zNum to a 64-bit signed integer. zNum must be decimal. This
  28094. ** routine does *not* accept hexadecimal notation.
  28095. **
  28096. ** Returns:
  28097. **
  28098. ** 0 Successful transformation. Fits in a 64-bit signed integer.
  28099. ** 1 Excess non-space text after the integer value
  28100. ** 2 Integer too large for a 64-bit signed integer or is malformed
  28101. ** 3 Special case of 9223372036854775808
  28102. **
  28103. ** length is the number of bytes in the string (bytes, not characters).
  28104. ** The string is not necessarily zero-terminated. The encoding is
  28105. ** given by enc.
  28106. */
  28107. SQLITE_PRIVATE int sqlite3Atoi64(const char *zNum, i64 *pNum, int length, u8 enc){
  28108. int incr;
  28109. u64 u = 0;
  28110. int neg = 0; /* assume positive */
  28111. int i;
  28112. int c = 0;
  28113. int nonNum = 0; /* True if input contains UTF16 with high byte non-zero */
  28114. int rc; /* Baseline return code */
  28115. const char *zStart;
  28116. const char *zEnd = zNum + length;
  28117. assert( enc==SQLITE_UTF8 || enc==SQLITE_UTF16LE || enc==SQLITE_UTF16BE );
  28118. if( enc==SQLITE_UTF8 ){
  28119. incr = 1;
  28120. }else{
  28121. incr = 2;
  28122. assert( SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
  28123. for(i=3-enc; i<length && zNum[i]==0; i+=2){}
  28124. nonNum = i<length;
  28125. zEnd = &zNum[i^1];
  28126. zNum += (enc&1);
  28127. }
  28128. while( zNum<zEnd && sqlite3Isspace(*zNum) ) zNum+=incr;
  28129. if( zNum<zEnd ){
  28130. if( *zNum=='-' ){
  28131. neg = 1;
  28132. zNum+=incr;
  28133. }else if( *zNum=='+' ){
  28134. zNum+=incr;
  28135. }
  28136. }
  28137. zStart = zNum;
  28138. while( zNum<zEnd && zNum[0]=='0' ){ zNum+=incr; } /* Skip leading zeros. */
  28139. for(i=0; &zNum[i]<zEnd && (c=zNum[i])>='0' && c<='9'; i+=incr){
  28140. u = u*10 + c - '0';
  28141. }
  28142. testcase( i==18*incr );
  28143. testcase( i==19*incr );
  28144. testcase( i==20*incr );
  28145. if( u>LARGEST_INT64 ){
  28146. /* This test and assignment is needed only to suppress UB warnings
  28147. ** from clang and -fsanitize=undefined. This test and assignment make
  28148. ** the code a little larger and slower, and no harm comes from omitting
  28149. ** them, but we must appaise the undefined-behavior pharisees. */
  28150. *pNum = neg ? SMALLEST_INT64 : LARGEST_INT64;
  28151. }else if( neg ){
  28152. *pNum = -(i64)u;
  28153. }else{
  28154. *pNum = (i64)u;
  28155. }
  28156. rc = 0;
  28157. if( (i==0 && zStart==zNum) /* No digits */
  28158. || nonNum /* UTF16 with high-order bytes non-zero */
  28159. ){
  28160. rc = 1;
  28161. }else if( &zNum[i]<zEnd ){ /* Extra bytes at the end */
  28162. int jj = i;
  28163. do{
  28164. if( !sqlite3Isspace(zNum[jj]) ){
  28165. rc = 1; /* Extra non-space text after the integer */
  28166. break;
  28167. }
  28168. jj += incr;
  28169. }while( &zNum[jj]<zEnd );
  28170. }
  28171. if( i<19*incr ){
  28172. /* Less than 19 digits, so we know that it fits in 64 bits */
  28173. assert( u<=LARGEST_INT64 );
  28174. return rc;
  28175. }else{
  28176. /* zNum is a 19-digit numbers. Compare it against 9223372036854775808. */
  28177. c = i>19*incr ? 1 : compare2pow63(zNum, incr);
  28178. if( c<0 ){
  28179. /* zNum is less than 9223372036854775808 so it fits */
  28180. assert( u<=LARGEST_INT64 );
  28181. return rc;
  28182. }else{
  28183. *pNum = neg ? SMALLEST_INT64 : LARGEST_INT64;
  28184. if( c>0 ){
  28185. /* zNum is greater than 9223372036854775808 so it overflows */
  28186. return 2;
  28187. }else{
  28188. /* zNum is exactly 9223372036854775808. Fits if negative. The
  28189. ** special case 2 overflow if positive */
  28190. assert( u-1==LARGEST_INT64 );
  28191. return neg ? rc : 3;
  28192. }
  28193. }
  28194. }
  28195. }
  28196. /*
  28197. ** Transform a UTF-8 integer literal, in either decimal or hexadecimal,
  28198. ** into a 64-bit signed integer. This routine accepts hexadecimal literals,
  28199. ** whereas sqlite3Atoi64() does not.
  28200. **
  28201. ** Returns:
  28202. **
  28203. ** 0 Successful transformation. Fits in a 64-bit signed integer.
  28204. ** 1 Excess text after the integer value
  28205. ** 2 Integer too large for a 64-bit signed integer or is malformed
  28206. ** 3 Special case of 9223372036854775808
  28207. */
  28208. SQLITE_PRIVATE int sqlite3DecOrHexToI64(const char *z, i64 *pOut){
  28209. #ifndef SQLITE_OMIT_HEX_INTEGER
  28210. if( z[0]=='0'
  28211. && (z[1]=='x' || z[1]=='X')
  28212. ){
  28213. u64 u = 0;
  28214. int i, k;
  28215. for(i=2; z[i]=='0'; i++){}
  28216. for(k=i; sqlite3Isxdigit(z[k]); k++){
  28217. u = u*16 + sqlite3HexToInt(z[k]);
  28218. }
  28219. memcpy(pOut, &u, 8);
  28220. return (z[k]==0 && k-i<=16) ? 0 : 2;
  28221. }else
  28222. #endif /* SQLITE_OMIT_HEX_INTEGER */
  28223. {
  28224. return sqlite3Atoi64(z, pOut, sqlite3Strlen30(z), SQLITE_UTF8);
  28225. }
  28226. }
  28227. /*
  28228. ** If zNum represents an integer that will fit in 32-bits, then set
  28229. ** *pValue to that integer and return true. Otherwise return false.
  28230. **
  28231. ** This routine accepts both decimal and hexadecimal notation for integers.
  28232. **
  28233. ** Any non-numeric characters that following zNum are ignored.
  28234. ** This is different from sqlite3Atoi64() which requires the
  28235. ** input number to be zero-terminated.
  28236. */
  28237. SQLITE_PRIVATE int sqlite3GetInt32(const char *zNum, int *pValue){
  28238. sqlite_int64 v = 0;
  28239. int i, c;
  28240. int neg = 0;
  28241. if( zNum[0]=='-' ){
  28242. neg = 1;
  28243. zNum++;
  28244. }else if( zNum[0]=='+' ){
  28245. zNum++;
  28246. }
  28247. #ifndef SQLITE_OMIT_HEX_INTEGER
  28248. else if( zNum[0]=='0'
  28249. && (zNum[1]=='x' || zNum[1]=='X')
  28250. && sqlite3Isxdigit(zNum[2])
  28251. ){
  28252. u32 u = 0;
  28253. zNum += 2;
  28254. while( zNum[0]=='0' ) zNum++;
  28255. for(i=0; sqlite3Isxdigit(zNum[i]) && i<8; i++){
  28256. u = u*16 + sqlite3HexToInt(zNum[i]);
  28257. }
  28258. if( (u&0x80000000)==0 && sqlite3Isxdigit(zNum[i])==0 ){
  28259. memcpy(pValue, &u, 4);
  28260. return 1;
  28261. }else{
  28262. return 0;
  28263. }
  28264. }
  28265. #endif
  28266. if( !sqlite3Isdigit(zNum[0]) ) return 0;
  28267. while( zNum[0]=='0' ) zNum++;
  28268. for(i=0; i<11 && (c = zNum[i] - '0')>=0 && c<=9; i++){
  28269. v = v*10 + c;
  28270. }
  28271. /* The longest decimal representation of a 32 bit integer is 10 digits:
  28272. **
  28273. ** 1234567890
  28274. ** 2^31 -> 2147483648
  28275. */
  28276. testcase( i==10 );
  28277. if( i>10 ){
  28278. return 0;
  28279. }
  28280. testcase( v-neg==2147483647 );
  28281. if( v-neg>2147483647 ){
  28282. return 0;
  28283. }
  28284. if( neg ){
  28285. v = -v;
  28286. }
  28287. *pValue = (int)v;
  28288. return 1;
  28289. }
  28290. /*
  28291. ** Return a 32-bit integer value extracted from a string. If the
  28292. ** string is not an integer, just return 0.
  28293. */
  28294. SQLITE_PRIVATE int sqlite3Atoi(const char *z){
  28295. int x = 0;
  28296. if( z ) sqlite3GetInt32(z, &x);
  28297. return x;
  28298. }
  28299. /*
  28300. ** The variable-length integer encoding is as follows:
  28301. **
  28302. ** KEY:
  28303. ** A = 0xxxxxxx 7 bits of data and one flag bit
  28304. ** B = 1xxxxxxx 7 bits of data and one flag bit
  28305. ** C = xxxxxxxx 8 bits of data
  28306. **
  28307. ** 7 bits - A
  28308. ** 14 bits - BA
  28309. ** 21 bits - BBA
  28310. ** 28 bits - BBBA
  28311. ** 35 bits - BBBBA
  28312. ** 42 bits - BBBBBA
  28313. ** 49 bits - BBBBBBA
  28314. ** 56 bits - BBBBBBBA
  28315. ** 64 bits - BBBBBBBBC
  28316. */
  28317. /*
  28318. ** Write a 64-bit variable-length integer to memory starting at p[0].
  28319. ** The length of data write will be between 1 and 9 bytes. The number
  28320. ** of bytes written is returned.
  28321. **
  28322. ** A variable-length integer consists of the lower 7 bits of each byte
  28323. ** for all bytes that have the 8th bit set and one byte with the 8th
  28324. ** bit clear. Except, if we get to the 9th byte, it stores the full
  28325. ** 8 bits and is the last byte.
  28326. */
  28327. static int SQLITE_NOINLINE putVarint64(unsigned char *p, u64 v){
  28328. int i, j, n;
  28329. u8 buf[10];
  28330. if( v & (((u64)0xff000000)<<32) ){
  28331. p[8] = (u8)v;
  28332. v >>= 8;
  28333. for(i=7; i>=0; i--){
  28334. p[i] = (u8)((v & 0x7f) | 0x80);
  28335. v >>= 7;
  28336. }
  28337. return 9;
  28338. }
  28339. n = 0;
  28340. do{
  28341. buf[n++] = (u8)((v & 0x7f) | 0x80);
  28342. v >>= 7;
  28343. }while( v!=0 );
  28344. buf[0] &= 0x7f;
  28345. assert( n<=9 );
  28346. for(i=0, j=n-1; j>=0; j--, i++){
  28347. p[i] = buf[j];
  28348. }
  28349. return n;
  28350. }
  28351. SQLITE_PRIVATE int sqlite3PutVarint(unsigned char *p, u64 v){
  28352. if( v<=0x7f ){
  28353. p[0] = v&0x7f;
  28354. return 1;
  28355. }
  28356. if( v<=0x3fff ){
  28357. p[0] = ((v>>7)&0x7f)|0x80;
  28358. p[1] = v&0x7f;
  28359. return 2;
  28360. }
  28361. return putVarint64(p,v);
  28362. }
  28363. /*
  28364. ** Bitmasks used by sqlite3GetVarint(). These precomputed constants
  28365. ** are defined here rather than simply putting the constant expressions
  28366. ** inline in order to work around bugs in the RVT compiler.
  28367. **
  28368. ** SLOT_2_0 A mask for (0x7f<<14) | 0x7f
  28369. **
  28370. ** SLOT_4_2_0 A mask for (0x7f<<28) | SLOT_2_0
  28371. */
  28372. #define SLOT_2_0 0x001fc07f
  28373. #define SLOT_4_2_0 0xf01fc07f
  28374. /*
  28375. ** Read a 64-bit variable-length integer from memory starting at p[0].
  28376. ** Return the number of bytes read. The value is stored in *v.
  28377. */
  28378. SQLITE_PRIVATE u8 sqlite3GetVarint(const unsigned char *p, u64 *v){
  28379. u32 a,b,s;
  28380. a = *p;
  28381. /* a: p0 (unmasked) */
  28382. if (!(a&0x80))
  28383. {
  28384. *v = a;
  28385. return 1;
  28386. }
  28387. p++;
  28388. b = *p;
  28389. /* b: p1 (unmasked) */
  28390. if (!(b&0x80))
  28391. {
  28392. a &= 0x7f;
  28393. a = a<<7;
  28394. a |= b;
  28395. *v = a;
  28396. return 2;
  28397. }
  28398. /* Verify that constants are precomputed correctly */
  28399. assert( SLOT_2_0 == ((0x7f<<14) | (0x7f)) );
  28400. assert( SLOT_4_2_0 == ((0xfU<<28) | (0x7f<<14) | (0x7f)) );
  28401. p++;
  28402. a = a<<14;
  28403. a |= *p;
  28404. /* a: p0<<14 | p2 (unmasked) */
  28405. if (!(a&0x80))
  28406. {
  28407. a &= SLOT_2_0;
  28408. b &= 0x7f;
  28409. b = b<<7;
  28410. a |= b;
  28411. *v = a;
  28412. return 3;
  28413. }
  28414. /* CSE1 from below */
  28415. a &= SLOT_2_0;
  28416. p++;
  28417. b = b<<14;
  28418. b |= *p;
  28419. /* b: p1<<14 | p3 (unmasked) */
  28420. if (!(b&0x80))
  28421. {
  28422. b &= SLOT_2_0;
  28423. /* moved CSE1 up */
  28424. /* a &= (0x7f<<14)|(0x7f); */
  28425. a = a<<7;
  28426. a |= b;
  28427. *v = a;
  28428. return 4;
  28429. }
  28430. /* a: p0<<14 | p2 (masked) */
  28431. /* b: p1<<14 | p3 (unmasked) */
  28432. /* 1:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  28433. /* moved CSE1 up */
  28434. /* a &= (0x7f<<14)|(0x7f); */
  28435. b &= SLOT_2_0;
  28436. s = a;
  28437. /* s: p0<<14 | p2 (masked) */
  28438. p++;
  28439. a = a<<14;
  28440. a |= *p;
  28441. /* a: p0<<28 | p2<<14 | p4 (unmasked) */
  28442. if (!(a&0x80))
  28443. {
  28444. /* we can skip these cause they were (effectively) done above
  28445. ** while calculating s */
  28446. /* a &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  28447. /* b &= (0x7f<<14)|(0x7f); */
  28448. b = b<<7;
  28449. a |= b;
  28450. s = s>>18;
  28451. *v = ((u64)s)<<32 | a;
  28452. return 5;
  28453. }
  28454. /* 2:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  28455. s = s<<7;
  28456. s |= b;
  28457. /* s: p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  28458. p++;
  28459. b = b<<14;
  28460. b |= *p;
  28461. /* b: p1<<28 | p3<<14 | p5 (unmasked) */
  28462. if (!(b&0x80))
  28463. {
  28464. /* we can skip this cause it was (effectively) done above in calc'ing s */
  28465. /* b &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  28466. a &= SLOT_2_0;
  28467. a = a<<7;
  28468. a |= b;
  28469. s = s>>18;
  28470. *v = ((u64)s)<<32 | a;
  28471. return 6;
  28472. }
  28473. p++;
  28474. a = a<<14;
  28475. a |= *p;
  28476. /* a: p2<<28 | p4<<14 | p6 (unmasked) */
  28477. if (!(a&0x80))
  28478. {
  28479. a &= SLOT_4_2_0;
  28480. b &= SLOT_2_0;
  28481. b = b<<7;
  28482. a |= b;
  28483. s = s>>11;
  28484. *v = ((u64)s)<<32 | a;
  28485. return 7;
  28486. }
  28487. /* CSE2 from below */
  28488. a &= SLOT_2_0;
  28489. p++;
  28490. b = b<<14;
  28491. b |= *p;
  28492. /* b: p3<<28 | p5<<14 | p7 (unmasked) */
  28493. if (!(b&0x80))
  28494. {
  28495. b &= SLOT_4_2_0;
  28496. /* moved CSE2 up */
  28497. /* a &= (0x7f<<14)|(0x7f); */
  28498. a = a<<7;
  28499. a |= b;
  28500. s = s>>4;
  28501. *v = ((u64)s)<<32 | a;
  28502. return 8;
  28503. }
  28504. p++;
  28505. a = a<<15;
  28506. a |= *p;
  28507. /* a: p4<<29 | p6<<15 | p8 (unmasked) */
  28508. /* moved CSE2 up */
  28509. /* a &= (0x7f<<29)|(0x7f<<15)|(0xff); */
  28510. b &= SLOT_2_0;
  28511. b = b<<8;
  28512. a |= b;
  28513. s = s<<4;
  28514. b = p[-4];
  28515. b &= 0x7f;
  28516. b = b>>3;
  28517. s |= b;
  28518. *v = ((u64)s)<<32 | a;
  28519. return 9;
  28520. }
  28521. /*
  28522. ** Read a 32-bit variable-length integer from memory starting at p[0].
  28523. ** Return the number of bytes read. The value is stored in *v.
  28524. **
  28525. ** If the varint stored in p[0] is larger than can fit in a 32-bit unsigned
  28526. ** integer, then set *v to 0xffffffff.
  28527. **
  28528. ** A MACRO version, getVarint32, is provided which inlines the
  28529. ** single-byte case. All code should use the MACRO version as
  28530. ** this function assumes the single-byte case has already been handled.
  28531. */
  28532. SQLITE_PRIVATE u8 sqlite3GetVarint32(const unsigned char *p, u32 *v){
  28533. u32 a,b;
  28534. /* The 1-byte case. Overwhelmingly the most common. Handled inline
  28535. ** by the getVarin32() macro */
  28536. a = *p;
  28537. /* a: p0 (unmasked) */
  28538. #ifndef getVarint32
  28539. if (!(a&0x80))
  28540. {
  28541. /* Values between 0 and 127 */
  28542. *v = a;
  28543. return 1;
  28544. }
  28545. #endif
  28546. /* The 2-byte case */
  28547. p++;
  28548. b = *p;
  28549. /* b: p1 (unmasked) */
  28550. if (!(b&0x80))
  28551. {
  28552. /* Values between 128 and 16383 */
  28553. a &= 0x7f;
  28554. a = a<<7;
  28555. *v = a | b;
  28556. return 2;
  28557. }
  28558. /* The 3-byte case */
  28559. p++;
  28560. a = a<<14;
  28561. a |= *p;
  28562. /* a: p0<<14 | p2 (unmasked) */
  28563. if (!(a&0x80))
  28564. {
  28565. /* Values between 16384 and 2097151 */
  28566. a &= (0x7f<<14)|(0x7f);
  28567. b &= 0x7f;
  28568. b = b<<7;
  28569. *v = a | b;
  28570. return 3;
  28571. }
  28572. /* A 32-bit varint is used to store size information in btrees.
  28573. ** Objects are rarely larger than 2MiB limit of a 3-byte varint.
  28574. ** A 3-byte varint is sufficient, for example, to record the size
  28575. ** of a 1048569-byte BLOB or string.
  28576. **
  28577. ** We only unroll the first 1-, 2-, and 3- byte cases. The very
  28578. ** rare larger cases can be handled by the slower 64-bit varint
  28579. ** routine.
  28580. */
  28581. #if 1
  28582. {
  28583. u64 v64;
  28584. u8 n;
  28585. p -= 2;
  28586. n = sqlite3GetVarint(p, &v64);
  28587. assert( n>3 && n<=9 );
  28588. if( (v64 & SQLITE_MAX_U32)!=v64 ){
  28589. *v = 0xffffffff;
  28590. }else{
  28591. *v = (u32)v64;
  28592. }
  28593. return n;
  28594. }
  28595. #else
  28596. /* For following code (kept for historical record only) shows an
  28597. ** unrolling for the 3- and 4-byte varint cases. This code is
  28598. ** slightly faster, but it is also larger and much harder to test.
  28599. */
  28600. p++;
  28601. b = b<<14;
  28602. b |= *p;
  28603. /* b: p1<<14 | p3 (unmasked) */
  28604. if (!(b&0x80))
  28605. {
  28606. /* Values between 2097152 and 268435455 */
  28607. b &= (0x7f<<14)|(0x7f);
  28608. a &= (0x7f<<14)|(0x7f);
  28609. a = a<<7;
  28610. *v = a | b;
  28611. return 4;
  28612. }
  28613. p++;
  28614. a = a<<14;
  28615. a |= *p;
  28616. /* a: p0<<28 | p2<<14 | p4 (unmasked) */
  28617. if (!(a&0x80))
  28618. {
  28619. /* Values between 268435456 and 34359738367 */
  28620. a &= SLOT_4_2_0;
  28621. b &= SLOT_4_2_0;
  28622. b = b<<7;
  28623. *v = a | b;
  28624. return 5;
  28625. }
  28626. /* We can only reach this point when reading a corrupt database
  28627. ** file. In that case we are not in any hurry. Use the (relatively
  28628. ** slow) general-purpose sqlite3GetVarint() routine to extract the
  28629. ** value. */
  28630. {
  28631. u64 v64;
  28632. u8 n;
  28633. p -= 4;
  28634. n = sqlite3GetVarint(p, &v64);
  28635. assert( n>5 && n<=9 );
  28636. *v = (u32)v64;
  28637. return n;
  28638. }
  28639. #endif
  28640. }
  28641. /*
  28642. ** Return the number of bytes that will be needed to store the given
  28643. ** 64-bit integer.
  28644. */
  28645. SQLITE_PRIVATE int sqlite3VarintLen(u64 v){
  28646. int i;
  28647. for(i=1; (v >>= 7)!=0; i++){ assert( i<10 ); }
  28648. return i;
  28649. }
  28650. /*
  28651. ** Read or write a four-byte big-endian integer value.
  28652. */
  28653. SQLITE_PRIVATE u32 sqlite3Get4byte(const u8 *p){
  28654. #if SQLITE_BYTEORDER==4321
  28655. u32 x;
  28656. memcpy(&x,p,4);
  28657. return x;
  28658. #elif SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  28659. u32 x;
  28660. memcpy(&x,p,4);
  28661. return __builtin_bswap32(x);
  28662. #elif SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  28663. u32 x;
  28664. memcpy(&x,p,4);
  28665. return _byteswap_ulong(x);
  28666. #else
  28667. testcase( p[0]&0x80 );
  28668. return ((unsigned)p[0]<<24) | (p[1]<<16) | (p[2]<<8) | p[3];
  28669. #endif
  28670. }
  28671. SQLITE_PRIVATE void sqlite3Put4byte(unsigned char *p, u32 v){
  28672. #if SQLITE_BYTEORDER==4321
  28673. memcpy(p,&v,4);
  28674. #elif SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  28675. u32 x = __builtin_bswap32(v);
  28676. memcpy(p,&x,4);
  28677. #elif SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  28678. u32 x = _byteswap_ulong(v);
  28679. memcpy(p,&x,4);
  28680. #else
  28681. p[0] = (u8)(v>>24);
  28682. p[1] = (u8)(v>>16);
  28683. p[2] = (u8)(v>>8);
  28684. p[3] = (u8)v;
  28685. #endif
  28686. }
  28687. /*
  28688. ** Translate a single byte of Hex into an integer.
  28689. ** This routine only works if h really is a valid hexadecimal
  28690. ** character: 0..9a..fA..F
  28691. */
  28692. SQLITE_PRIVATE u8 sqlite3HexToInt(int h){
  28693. assert( (h>='0' && h<='9') || (h>='a' && h<='f') || (h>='A' && h<='F') );
  28694. #ifdef SQLITE_ASCII
  28695. h += 9*(1&(h>>6));
  28696. #endif
  28697. #ifdef SQLITE_EBCDIC
  28698. h += 9*(1&~(h>>4));
  28699. #endif
  28700. return (u8)(h & 0xf);
  28701. }
  28702. #if !defined(SQLITE_OMIT_BLOB_LITERAL) || defined(SQLITE_HAS_CODEC)
  28703. /*
  28704. ** Convert a BLOB literal of the form "x'hhhhhh'" into its binary
  28705. ** value. Return a pointer to its binary value. Space to hold the
  28706. ** binary value has been obtained from malloc and must be freed by
  28707. ** the calling routine.
  28708. */
  28709. SQLITE_PRIVATE void *sqlite3HexToBlob(sqlite3 *db, const char *z, int n){
  28710. char *zBlob;
  28711. int i;
  28712. zBlob = (char *)sqlite3DbMallocRawNN(db, n/2 + 1);
  28713. n--;
  28714. if( zBlob ){
  28715. for(i=0; i<n; i+=2){
  28716. zBlob[i/2] = (sqlite3HexToInt(z[i])<<4) | sqlite3HexToInt(z[i+1]);
  28717. }
  28718. zBlob[i/2] = 0;
  28719. }
  28720. return zBlob;
  28721. }
  28722. #endif /* !SQLITE_OMIT_BLOB_LITERAL || SQLITE_HAS_CODEC */
  28723. /*
  28724. ** Log an error that is an API call on a connection pointer that should
  28725. ** not have been used. The "type" of connection pointer is given as the
  28726. ** argument. The zType is a word like "NULL" or "closed" or "invalid".
  28727. */
  28728. static void logBadConnection(const char *zType){
  28729. sqlite3_log(SQLITE_MISUSE,
  28730. "API call with %s database connection pointer",
  28731. zType
  28732. );
  28733. }
  28734. /*
  28735. ** Check to make sure we have a valid db pointer. This test is not
  28736. ** foolproof but it does provide some measure of protection against
  28737. ** misuse of the interface such as passing in db pointers that are
  28738. ** NULL or which have been previously closed. If this routine returns
  28739. ** 1 it means that the db pointer is valid and 0 if it should not be
  28740. ** dereferenced for any reason. The calling function should invoke
  28741. ** SQLITE_MISUSE immediately.
  28742. **
  28743. ** sqlite3SafetyCheckOk() requires that the db pointer be valid for
  28744. ** use. sqlite3SafetyCheckSickOrOk() allows a db pointer that failed to
  28745. ** open properly and is not fit for general use but which can be
  28746. ** used as an argument to sqlite3_errmsg() or sqlite3_close().
  28747. */
  28748. SQLITE_PRIVATE int sqlite3SafetyCheckOk(sqlite3 *db){
  28749. u32 magic;
  28750. if( db==0 ){
  28751. logBadConnection("NULL");
  28752. return 0;
  28753. }
  28754. magic = db->magic;
  28755. if( magic!=SQLITE_MAGIC_OPEN ){
  28756. if( sqlite3SafetyCheckSickOrOk(db) ){
  28757. testcase( sqlite3GlobalConfig.xLog!=0 );
  28758. logBadConnection("unopened");
  28759. }
  28760. return 0;
  28761. }else{
  28762. return 1;
  28763. }
  28764. }
  28765. SQLITE_PRIVATE int sqlite3SafetyCheckSickOrOk(sqlite3 *db){
  28766. u32 magic;
  28767. magic = db->magic;
  28768. if( magic!=SQLITE_MAGIC_SICK &&
  28769. magic!=SQLITE_MAGIC_OPEN &&
  28770. magic!=SQLITE_MAGIC_BUSY ){
  28771. testcase( sqlite3GlobalConfig.xLog!=0 );
  28772. logBadConnection("invalid");
  28773. return 0;
  28774. }else{
  28775. return 1;
  28776. }
  28777. }
  28778. /*
  28779. ** Attempt to add, substract, or multiply the 64-bit signed value iB against
  28780. ** the other 64-bit signed integer at *pA and store the result in *pA.
  28781. ** Return 0 on success. Or if the operation would have resulted in an
  28782. ** overflow, leave *pA unchanged and return 1.
  28783. */
  28784. SQLITE_PRIVATE int sqlite3AddInt64(i64 *pA, i64 iB){
  28785. #if GCC_VERSION>=5004000 && !defined(__INTEL_COMPILER)
  28786. return __builtin_add_overflow(*pA, iB, pA);
  28787. #else
  28788. i64 iA = *pA;
  28789. testcase( iA==0 ); testcase( iA==1 );
  28790. testcase( iB==-1 ); testcase( iB==0 );
  28791. if( iB>=0 ){
  28792. testcase( iA>0 && LARGEST_INT64 - iA == iB );
  28793. testcase( iA>0 && LARGEST_INT64 - iA == iB - 1 );
  28794. if( iA>0 && LARGEST_INT64 - iA < iB ) return 1;
  28795. }else{
  28796. testcase( iA<0 && -(iA + LARGEST_INT64) == iB + 1 );
  28797. testcase( iA<0 && -(iA + LARGEST_INT64) == iB + 2 );
  28798. if( iA<0 && -(iA + LARGEST_INT64) > iB + 1 ) return 1;
  28799. }
  28800. *pA += iB;
  28801. return 0;
  28802. #endif
  28803. }
  28804. SQLITE_PRIVATE int sqlite3SubInt64(i64 *pA, i64 iB){
  28805. #if GCC_VERSION>=5004000 && !defined(__INTEL_COMPILER)
  28806. return __builtin_sub_overflow(*pA, iB, pA);
  28807. #else
  28808. testcase( iB==SMALLEST_INT64+1 );
  28809. if( iB==SMALLEST_INT64 ){
  28810. testcase( (*pA)==(-1) ); testcase( (*pA)==0 );
  28811. if( (*pA)>=0 ) return 1;
  28812. *pA -= iB;
  28813. return 0;
  28814. }else{
  28815. return sqlite3AddInt64(pA, -iB);
  28816. }
  28817. #endif
  28818. }
  28819. SQLITE_PRIVATE int sqlite3MulInt64(i64 *pA, i64 iB){
  28820. #if GCC_VERSION>=5004000 && !defined(__INTEL_COMPILER)
  28821. return __builtin_mul_overflow(*pA, iB, pA);
  28822. #else
  28823. i64 iA = *pA;
  28824. if( iB>0 ){
  28825. if( iA>LARGEST_INT64/iB ) return 1;
  28826. if( iA<SMALLEST_INT64/iB ) return 1;
  28827. }else if( iB<0 ){
  28828. if( iA>0 ){
  28829. if( iB<SMALLEST_INT64/iA ) return 1;
  28830. }else if( iA<0 ){
  28831. if( iB==SMALLEST_INT64 ) return 1;
  28832. if( iA==SMALLEST_INT64 ) return 1;
  28833. if( -iA>LARGEST_INT64/-iB ) return 1;
  28834. }
  28835. }
  28836. *pA = iA*iB;
  28837. return 0;
  28838. #endif
  28839. }
  28840. /*
  28841. ** Compute the absolute value of a 32-bit signed integer, of possible. Or
  28842. ** if the integer has a value of -2147483648, return +2147483647
  28843. */
  28844. SQLITE_PRIVATE int sqlite3AbsInt32(int x){
  28845. if( x>=0 ) return x;
  28846. if( x==(int)0x80000000 ) return 0x7fffffff;
  28847. return -x;
  28848. }
  28849. #ifdef SQLITE_ENABLE_8_3_NAMES
  28850. /*
  28851. ** If SQLITE_ENABLE_8_3_NAMES is set at compile-time and if the database
  28852. ** filename in zBaseFilename is a URI with the "8_3_names=1" parameter and
  28853. ** if filename in z[] has a suffix (a.k.a. "extension") that is longer than
  28854. ** three characters, then shorten the suffix on z[] to be the last three
  28855. ** characters of the original suffix.
  28856. **
  28857. ** If SQLITE_ENABLE_8_3_NAMES is set to 2 at compile-time, then always
  28858. ** do the suffix shortening regardless of URI parameter.
  28859. **
  28860. ** Examples:
  28861. **
  28862. ** test.db-journal => test.nal
  28863. ** test.db-wal => test.wal
  28864. ** test.db-shm => test.shm
  28865. ** test.db-mj7f3319fa => test.9fa
  28866. */
  28867. SQLITE_PRIVATE void sqlite3FileSuffix3(const char *zBaseFilename, char *z){
  28868. #if SQLITE_ENABLE_8_3_NAMES<2
  28869. if( sqlite3_uri_boolean(zBaseFilename, "8_3_names", 0) )
  28870. #endif
  28871. {
  28872. int i, sz;
  28873. sz = sqlite3Strlen30(z);
  28874. for(i=sz-1; i>0 && z[i]!='/' && z[i]!='.'; i--){}
  28875. if( z[i]=='.' && ALWAYS(sz>i+4) ) memmove(&z[i+1], &z[sz-3], 4);
  28876. }
  28877. }
  28878. #endif
  28879. /*
  28880. ** Find (an approximate) sum of two LogEst values. This computation is
  28881. ** not a simple "+" operator because LogEst is stored as a logarithmic
  28882. ** value.
  28883. **
  28884. */
  28885. SQLITE_PRIVATE LogEst sqlite3LogEstAdd(LogEst a, LogEst b){
  28886. static const unsigned char x[] = {
  28887. 10, 10, /* 0,1 */
  28888. 9, 9, /* 2,3 */
  28889. 8, 8, /* 4,5 */
  28890. 7, 7, 7, /* 6,7,8 */
  28891. 6, 6, 6, /* 9,10,11 */
  28892. 5, 5, 5, /* 12-14 */
  28893. 4, 4, 4, 4, /* 15-18 */
  28894. 3, 3, 3, 3, 3, 3, /* 19-24 */
  28895. 2, 2, 2, 2, 2, 2, 2, /* 25-31 */
  28896. };
  28897. if( a>=b ){
  28898. if( a>b+49 ) return a;
  28899. if( a>b+31 ) return a+1;
  28900. return a+x[a-b];
  28901. }else{
  28902. if( b>a+49 ) return b;
  28903. if( b>a+31 ) return b+1;
  28904. return b+x[b-a];
  28905. }
  28906. }
  28907. /*
  28908. ** Convert an integer into a LogEst. In other words, compute an
  28909. ** approximation for 10*log2(x).
  28910. */
  28911. SQLITE_PRIVATE LogEst sqlite3LogEst(u64 x){
  28912. static LogEst a[] = { 0, 2, 3, 5, 6, 7, 8, 9 };
  28913. LogEst y = 40;
  28914. if( x<8 ){
  28915. if( x<2 ) return 0;
  28916. while( x<8 ){ y -= 10; x <<= 1; }
  28917. }else{
  28918. #if GCC_VERSION>=5004000
  28919. int i = 60 - __builtin_clzll(x);
  28920. y += i*10;
  28921. x >>= i;
  28922. #else
  28923. while( x>255 ){ y += 40; x >>= 4; } /*OPTIMIZATION-IF-TRUE*/
  28924. while( x>15 ){ y += 10; x >>= 1; }
  28925. #endif
  28926. }
  28927. return a[x&7] + y - 10;
  28928. }
  28929. #ifndef SQLITE_OMIT_VIRTUALTABLE
  28930. /*
  28931. ** Convert a double into a LogEst
  28932. ** In other words, compute an approximation for 10*log2(x).
  28933. */
  28934. SQLITE_PRIVATE LogEst sqlite3LogEstFromDouble(double x){
  28935. u64 a;
  28936. LogEst e;
  28937. assert( sizeof(x)==8 && sizeof(a)==8 );
  28938. if( x<=1 ) return 0;
  28939. if( x<=2000000000 ) return sqlite3LogEst((u64)x);
  28940. memcpy(&a, &x, 8);
  28941. e = (a>>52) - 1022;
  28942. return e*10;
  28943. }
  28944. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  28945. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
  28946. defined(SQLITE_ENABLE_STAT3_OR_STAT4) || \
  28947. defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
  28948. /*
  28949. ** Convert a LogEst into an integer.
  28950. **
  28951. ** Note that this routine is only used when one or more of various
  28952. ** non-standard compile-time options is enabled.
  28953. */
  28954. SQLITE_PRIVATE u64 sqlite3LogEstToInt(LogEst x){
  28955. u64 n;
  28956. n = x%10;
  28957. x /= 10;
  28958. if( n>=5 ) n -= 2;
  28959. else if( n>=1 ) n -= 1;
  28960. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS) || \
  28961. defined(SQLITE_EXPLAIN_ESTIMATED_ROWS)
  28962. if( x>60 ) return (u64)LARGEST_INT64;
  28963. #else
  28964. /* If only SQLITE_ENABLE_STAT3_OR_STAT4 is on, then the largest input
  28965. ** possible to this routine is 310, resulting in a maximum x of 31 */
  28966. assert( x<=60 );
  28967. #endif
  28968. return x>=3 ? (n+8)<<(x-3) : (n+8)>>(3-x);
  28969. }
  28970. #endif /* defined SCANSTAT or STAT4 or ESTIMATED_ROWS */
  28971. /*
  28972. ** Add a new name/number pair to a VList. This might require that the
  28973. ** VList object be reallocated, so return the new VList. If an OOM
  28974. ** error occurs, the original VList returned and the
  28975. ** db->mallocFailed flag is set.
  28976. **
  28977. ** A VList is really just an array of integers. To destroy a VList,
  28978. ** simply pass it to sqlite3DbFree().
  28979. **
  28980. ** The first integer is the number of integers allocated for the whole
  28981. ** VList. The second integer is the number of integers actually used.
  28982. ** Each name/number pair is encoded by subsequent groups of 3 or more
  28983. ** integers.
  28984. **
  28985. ** Each name/number pair starts with two integers which are the numeric
  28986. ** value for the pair and the size of the name/number pair, respectively.
  28987. ** The text name overlays one or more following integers. The text name
  28988. ** is always zero-terminated.
  28989. **
  28990. ** Conceptually:
  28991. **
  28992. ** struct VList {
  28993. ** int nAlloc; // Number of allocated slots
  28994. ** int nUsed; // Number of used slots
  28995. ** struct VListEntry {
  28996. ** int iValue; // Value for this entry
  28997. ** int nSlot; // Slots used by this entry
  28998. ** // ... variable name goes here
  28999. ** } a[0];
  29000. ** }
  29001. **
  29002. ** During code generation, pointers to the variable names within the
  29003. ** VList are taken. When that happens, nAlloc is set to zero as an
  29004. ** indication that the VList may never again be enlarged, since the
  29005. ** accompanying realloc() would invalidate the pointers.
  29006. */
  29007. SQLITE_PRIVATE VList *sqlite3VListAdd(
  29008. sqlite3 *db, /* The database connection used for malloc() */
  29009. VList *pIn, /* The input VList. Might be NULL */
  29010. const char *zName, /* Name of symbol to add */
  29011. int nName, /* Bytes of text in zName */
  29012. int iVal /* Value to associate with zName */
  29013. ){
  29014. int nInt; /* number of sizeof(int) objects needed for zName */
  29015. char *z; /* Pointer to where zName will be stored */
  29016. int i; /* Index in pIn[] where zName is stored */
  29017. nInt = nName/4 + 3;
  29018. assert( pIn==0 || pIn[0]>=3 ); /* Verify ok to add new elements */
  29019. if( pIn==0 || pIn[1]+nInt > pIn[0] ){
  29020. /* Enlarge the allocation */
  29021. int nAlloc = (pIn ? pIn[0]*2 : 10) + nInt;
  29022. VList *pOut = sqlite3DbRealloc(db, pIn, nAlloc*sizeof(int));
  29023. if( pOut==0 ) return pIn;
  29024. if( pIn==0 ) pOut[1] = 2;
  29025. pIn = pOut;
  29026. pIn[0] = nAlloc;
  29027. }
  29028. i = pIn[1];
  29029. pIn[i] = iVal;
  29030. pIn[i+1] = nInt;
  29031. z = (char*)&pIn[i+2];
  29032. pIn[1] = i+nInt;
  29033. assert( pIn[1]<=pIn[0] );
  29034. memcpy(z, zName, nName);
  29035. z[nName] = 0;
  29036. return pIn;
  29037. }
  29038. /*
  29039. ** Return a pointer to the name of a variable in the given VList that
  29040. ** has the value iVal. Or return a NULL if there is no such variable in
  29041. ** the list
  29042. */
  29043. SQLITE_PRIVATE const char *sqlite3VListNumToName(VList *pIn, int iVal){
  29044. int i, mx;
  29045. if( pIn==0 ) return 0;
  29046. mx = pIn[1];
  29047. i = 2;
  29048. do{
  29049. if( pIn[i]==iVal ) return (char*)&pIn[i+2];
  29050. i += pIn[i+1];
  29051. }while( i<mx );
  29052. return 0;
  29053. }
  29054. /*
  29055. ** Return the number of the variable named zName, if it is in VList.
  29056. ** or return 0 if there is no such variable.
  29057. */
  29058. SQLITE_PRIVATE int sqlite3VListNameToNum(VList *pIn, const char *zName, int nName){
  29059. int i, mx;
  29060. if( pIn==0 ) return 0;
  29061. mx = pIn[1];
  29062. i = 2;
  29063. do{
  29064. const char *z = (const char*)&pIn[i+2];
  29065. if( strncmp(z,zName,nName)==0 && z[nName]==0 ) return pIn[i];
  29066. i += pIn[i+1];
  29067. }while( i<mx );
  29068. return 0;
  29069. }
  29070. /************** End of util.c ************************************************/
  29071. /************** Begin file hash.c ********************************************/
  29072. /*
  29073. ** 2001 September 22
  29074. **
  29075. ** The author disclaims copyright to this source code. In place of
  29076. ** a legal notice, here is a blessing:
  29077. **
  29078. ** May you do good and not evil.
  29079. ** May you find forgiveness for yourself and forgive others.
  29080. ** May you share freely, never taking more than you give.
  29081. **
  29082. *************************************************************************
  29083. ** This is the implementation of generic hash-tables
  29084. ** used in SQLite.
  29085. */
  29086. /* #include "sqliteInt.h" */
  29087. /* #include <assert.h> */
  29088. /* Turn bulk memory into a hash table object by initializing the
  29089. ** fields of the Hash structure.
  29090. **
  29091. ** "pNew" is a pointer to the hash table that is to be initialized.
  29092. */
  29093. SQLITE_PRIVATE void sqlite3HashInit(Hash *pNew){
  29094. assert( pNew!=0 );
  29095. pNew->first = 0;
  29096. pNew->count = 0;
  29097. pNew->htsize = 0;
  29098. pNew->ht = 0;
  29099. }
  29100. /* Remove all entries from a hash table. Reclaim all memory.
  29101. ** Call this routine to delete a hash table or to reset a hash table
  29102. ** to the empty state.
  29103. */
  29104. SQLITE_PRIVATE void sqlite3HashClear(Hash *pH){
  29105. HashElem *elem; /* For looping over all elements of the table */
  29106. assert( pH!=0 );
  29107. elem = pH->first;
  29108. pH->first = 0;
  29109. sqlite3_free(pH->ht);
  29110. pH->ht = 0;
  29111. pH->htsize = 0;
  29112. while( elem ){
  29113. HashElem *next_elem = elem->next;
  29114. sqlite3_free(elem);
  29115. elem = next_elem;
  29116. }
  29117. pH->count = 0;
  29118. }
  29119. /*
  29120. ** The hashing function.
  29121. */
  29122. static unsigned int strHash(const char *z){
  29123. unsigned int h = 0;
  29124. unsigned char c;
  29125. while( (c = (unsigned char)*z++)!=0 ){ /*OPTIMIZATION-IF-TRUE*/
  29126. /* Knuth multiplicative hashing. (Sorting & Searching, p. 510).
  29127. ** 0x9e3779b1 is 2654435761 which is the closest prime number to
  29128. ** (2**32)*golden_ratio, where golden_ratio = (sqrt(5) - 1)/2. */
  29129. h += sqlite3UpperToLower[c];
  29130. h *= 0x9e3779b1;
  29131. }
  29132. return h;
  29133. }
  29134. /* Link pNew element into the hash table pH. If pEntry!=0 then also
  29135. ** insert pNew into the pEntry hash bucket.
  29136. */
  29137. static void insertElement(
  29138. Hash *pH, /* The complete hash table */
  29139. struct _ht *pEntry, /* The entry into which pNew is inserted */
  29140. HashElem *pNew /* The element to be inserted */
  29141. ){
  29142. HashElem *pHead; /* First element already in pEntry */
  29143. if( pEntry ){
  29144. pHead = pEntry->count ? pEntry->chain : 0;
  29145. pEntry->count++;
  29146. pEntry->chain = pNew;
  29147. }else{
  29148. pHead = 0;
  29149. }
  29150. if( pHead ){
  29151. pNew->next = pHead;
  29152. pNew->prev = pHead->prev;
  29153. if( pHead->prev ){ pHead->prev->next = pNew; }
  29154. else { pH->first = pNew; }
  29155. pHead->prev = pNew;
  29156. }else{
  29157. pNew->next = pH->first;
  29158. if( pH->first ){ pH->first->prev = pNew; }
  29159. pNew->prev = 0;
  29160. pH->first = pNew;
  29161. }
  29162. }
  29163. /* Resize the hash table so that it cantains "new_size" buckets.
  29164. **
  29165. ** The hash table might fail to resize if sqlite3_malloc() fails or
  29166. ** if the new size is the same as the prior size.
  29167. ** Return TRUE if the resize occurs and false if not.
  29168. */
  29169. static int rehash(Hash *pH, unsigned int new_size){
  29170. struct _ht *new_ht; /* The new hash table */
  29171. HashElem *elem, *next_elem; /* For looping over existing elements */
  29172. #if SQLITE_MALLOC_SOFT_LIMIT>0
  29173. if( new_size*sizeof(struct _ht)>SQLITE_MALLOC_SOFT_LIMIT ){
  29174. new_size = SQLITE_MALLOC_SOFT_LIMIT/sizeof(struct _ht);
  29175. }
  29176. if( new_size==pH->htsize ) return 0;
  29177. #endif
  29178. /* The inability to allocates space for a larger hash table is
  29179. ** a performance hit but it is not a fatal error. So mark the
  29180. ** allocation as a benign. Use sqlite3Malloc()/memset(0) instead of
  29181. ** sqlite3MallocZero() to make the allocation, as sqlite3MallocZero()
  29182. ** only zeroes the requested number of bytes whereas this module will
  29183. ** use the actual amount of space allocated for the hash table (which
  29184. ** may be larger than the requested amount).
  29185. */
  29186. sqlite3BeginBenignMalloc();
  29187. new_ht = (struct _ht *)sqlite3Malloc( new_size*sizeof(struct _ht) );
  29188. sqlite3EndBenignMalloc();
  29189. if( new_ht==0 ) return 0;
  29190. sqlite3_free(pH->ht);
  29191. pH->ht = new_ht;
  29192. pH->htsize = new_size = sqlite3MallocSize(new_ht)/sizeof(struct _ht);
  29193. memset(new_ht, 0, new_size*sizeof(struct _ht));
  29194. for(elem=pH->first, pH->first=0; elem; elem = next_elem){
  29195. unsigned int h = strHash(elem->pKey) % new_size;
  29196. next_elem = elem->next;
  29197. insertElement(pH, &new_ht[h], elem);
  29198. }
  29199. return 1;
  29200. }
  29201. /* This function (for internal use only) locates an element in an
  29202. ** hash table that matches the given key. If no element is found,
  29203. ** a pointer to a static null element with HashElem.data==0 is returned.
  29204. ** If pH is not NULL, then the hash for this key is written to *pH.
  29205. */
  29206. static HashElem *findElementWithHash(
  29207. const Hash *pH, /* The pH to be searched */
  29208. const char *pKey, /* The key we are searching for */
  29209. unsigned int *pHash /* Write the hash value here */
  29210. ){
  29211. HashElem *elem; /* Used to loop thru the element list */
  29212. int count; /* Number of elements left to test */
  29213. unsigned int h; /* The computed hash */
  29214. static HashElem nullElement = { 0, 0, 0, 0 };
  29215. if( pH->ht ){ /*OPTIMIZATION-IF-TRUE*/
  29216. struct _ht *pEntry;
  29217. h = strHash(pKey) % pH->htsize;
  29218. pEntry = &pH->ht[h];
  29219. elem = pEntry->chain;
  29220. count = pEntry->count;
  29221. }else{
  29222. h = 0;
  29223. elem = pH->first;
  29224. count = pH->count;
  29225. }
  29226. if( pHash ) *pHash = h;
  29227. while( count-- ){
  29228. assert( elem!=0 );
  29229. if( sqlite3StrICmp(elem->pKey,pKey)==0 ){
  29230. return elem;
  29231. }
  29232. elem = elem->next;
  29233. }
  29234. return &nullElement;
  29235. }
  29236. /* Remove a single entry from the hash table given a pointer to that
  29237. ** element and a hash on the element's key.
  29238. */
  29239. static void removeElementGivenHash(
  29240. Hash *pH, /* The pH containing "elem" */
  29241. HashElem* elem, /* The element to be removed from the pH */
  29242. unsigned int h /* Hash value for the element */
  29243. ){
  29244. struct _ht *pEntry;
  29245. if( elem->prev ){
  29246. elem->prev->next = elem->next;
  29247. }else{
  29248. pH->first = elem->next;
  29249. }
  29250. if( elem->next ){
  29251. elem->next->prev = elem->prev;
  29252. }
  29253. if( pH->ht ){
  29254. pEntry = &pH->ht[h];
  29255. if( pEntry->chain==elem ){
  29256. pEntry->chain = elem->next;
  29257. }
  29258. pEntry->count--;
  29259. assert( pEntry->count>=0 );
  29260. }
  29261. sqlite3_free( elem );
  29262. pH->count--;
  29263. if( pH->count==0 ){
  29264. assert( pH->first==0 );
  29265. assert( pH->count==0 );
  29266. sqlite3HashClear(pH);
  29267. }
  29268. }
  29269. /* Attempt to locate an element of the hash table pH with a key
  29270. ** that matches pKey. Return the data for this element if it is
  29271. ** found, or NULL if there is no match.
  29272. */
  29273. SQLITE_PRIVATE void *sqlite3HashFind(const Hash *pH, const char *pKey){
  29274. assert( pH!=0 );
  29275. assert( pKey!=0 );
  29276. return findElementWithHash(pH, pKey, 0)->data;
  29277. }
  29278. /* Insert an element into the hash table pH. The key is pKey
  29279. ** and the data is "data".
  29280. **
  29281. ** If no element exists with a matching key, then a new
  29282. ** element is created and NULL is returned.
  29283. **
  29284. ** If another element already exists with the same key, then the
  29285. ** new data replaces the old data and the old data is returned.
  29286. ** The key is not copied in this instance. If a malloc fails, then
  29287. ** the new data is returned and the hash table is unchanged.
  29288. **
  29289. ** If the "data" parameter to this function is NULL, then the
  29290. ** element corresponding to "key" is removed from the hash table.
  29291. */
  29292. SQLITE_PRIVATE void *sqlite3HashInsert(Hash *pH, const char *pKey, void *data){
  29293. unsigned int h; /* the hash of the key modulo hash table size */
  29294. HashElem *elem; /* Used to loop thru the element list */
  29295. HashElem *new_elem; /* New element added to the pH */
  29296. assert( pH!=0 );
  29297. assert( pKey!=0 );
  29298. elem = findElementWithHash(pH,pKey,&h);
  29299. if( elem->data ){
  29300. void *old_data = elem->data;
  29301. if( data==0 ){
  29302. removeElementGivenHash(pH,elem,h);
  29303. }else{
  29304. elem->data = data;
  29305. elem->pKey = pKey;
  29306. }
  29307. return old_data;
  29308. }
  29309. if( data==0 ) return 0;
  29310. new_elem = (HashElem*)sqlite3Malloc( sizeof(HashElem) );
  29311. if( new_elem==0 ) return data;
  29312. new_elem->pKey = pKey;
  29313. new_elem->data = data;
  29314. pH->count++;
  29315. if( pH->count>=10 && pH->count > 2*pH->htsize ){
  29316. if( rehash(pH, pH->count*2) ){
  29317. assert( pH->htsize>0 );
  29318. h = strHash(pKey) % pH->htsize;
  29319. }
  29320. }
  29321. insertElement(pH, pH->ht ? &pH->ht[h] : 0, new_elem);
  29322. return 0;
  29323. }
  29324. /************** End of hash.c ************************************************/
  29325. /************** Begin file opcodes.c *****************************************/
  29326. /* Automatically generated. Do not edit */
  29327. /* See the tool/mkopcodec.tcl script for details. */
  29328. #if !defined(SQLITE_OMIT_EXPLAIN) \
  29329. || defined(VDBE_PROFILE) \
  29330. || defined(SQLITE_DEBUG)
  29331. #if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS) || defined(SQLITE_DEBUG)
  29332. # define OpHelp(X) "\0" X
  29333. #else
  29334. # define OpHelp(X)
  29335. #endif
  29336. SQLITE_PRIVATE const char *sqlite3OpcodeName(int i){
  29337. static const char *const azName[] = {
  29338. /* 0 */ "Savepoint" OpHelp(""),
  29339. /* 1 */ "AutoCommit" OpHelp(""),
  29340. /* 2 */ "Transaction" OpHelp(""),
  29341. /* 3 */ "SorterNext" OpHelp(""),
  29342. /* 4 */ "PrevIfOpen" OpHelp(""),
  29343. /* 5 */ "NextIfOpen" OpHelp(""),
  29344. /* 6 */ "Prev" OpHelp(""),
  29345. /* 7 */ "Next" OpHelp(""),
  29346. /* 8 */ "Checkpoint" OpHelp(""),
  29347. /* 9 */ "JournalMode" OpHelp(""),
  29348. /* 10 */ "Vacuum" OpHelp(""),
  29349. /* 11 */ "VFilter" OpHelp("iplan=r[P3] zplan='P4'"),
  29350. /* 12 */ "VUpdate" OpHelp("data=r[P3@P2]"),
  29351. /* 13 */ "Goto" OpHelp(""),
  29352. /* 14 */ "Gosub" OpHelp(""),
  29353. /* 15 */ "InitCoroutine" OpHelp(""),
  29354. /* 16 */ "Yield" OpHelp(""),
  29355. /* 17 */ "MustBeInt" OpHelp(""),
  29356. /* 18 */ "Jump" OpHelp(""),
  29357. /* 19 */ "Not" OpHelp("r[P2]= !r[P1]"),
  29358. /* 20 */ "Once" OpHelp(""),
  29359. /* 21 */ "If" OpHelp(""),
  29360. /* 22 */ "IfNot" OpHelp(""),
  29361. /* 23 */ "IfNullRow" OpHelp("if P1.nullRow then r[P3]=NULL, goto P2"),
  29362. /* 24 */ "SeekLT" OpHelp("key=r[P3@P4]"),
  29363. /* 25 */ "SeekLE" OpHelp("key=r[P3@P4]"),
  29364. /* 26 */ "SeekGE" OpHelp("key=r[P3@P4]"),
  29365. /* 27 */ "SeekGT" OpHelp("key=r[P3@P4]"),
  29366. /* 28 */ "NoConflict" OpHelp("key=r[P3@P4]"),
  29367. /* 29 */ "NotFound" OpHelp("key=r[P3@P4]"),
  29368. /* 30 */ "Found" OpHelp("key=r[P3@P4]"),
  29369. /* 31 */ "SeekRowid" OpHelp("intkey=r[P3]"),
  29370. /* 32 */ "NotExists" OpHelp("intkey=r[P3]"),
  29371. /* 33 */ "Last" OpHelp(""),
  29372. /* 34 */ "IfSmaller" OpHelp(""),
  29373. /* 35 */ "SorterSort" OpHelp(""),
  29374. /* 36 */ "Sort" OpHelp(""),
  29375. /* 37 */ "Rewind" OpHelp(""),
  29376. /* 38 */ "IdxLE" OpHelp("key=r[P3@P4]"),
  29377. /* 39 */ "IdxGT" OpHelp("key=r[P3@P4]"),
  29378. /* 40 */ "IdxLT" OpHelp("key=r[P3@P4]"),
  29379. /* 41 */ "IdxGE" OpHelp("key=r[P3@P4]"),
  29380. /* 42 */ "RowSetRead" OpHelp("r[P3]=rowset(P1)"),
  29381. /* 43 */ "Or" OpHelp("r[P3]=(r[P1] || r[P2])"),
  29382. /* 44 */ "And" OpHelp("r[P3]=(r[P1] && r[P2])"),
  29383. /* 45 */ "RowSetTest" OpHelp("if r[P3] in rowset(P1) goto P2"),
  29384. /* 46 */ "Program" OpHelp(""),
  29385. /* 47 */ "FkIfZero" OpHelp("if fkctr[P1]==0 goto P2"),
  29386. /* 48 */ "IfPos" OpHelp("if r[P1]>0 then r[P1]-=P3, goto P2"),
  29387. /* 49 */ "IfNotZero" OpHelp("if r[P1]!=0 then r[P1]--, goto P2"),
  29388. /* 50 */ "IsNull" OpHelp("if r[P1]==NULL goto P2"),
  29389. /* 51 */ "NotNull" OpHelp("if r[P1]!=NULL goto P2"),
  29390. /* 52 */ "Ne" OpHelp("IF r[P3]!=r[P1]"),
  29391. /* 53 */ "Eq" OpHelp("IF r[P3]==r[P1]"),
  29392. /* 54 */ "Gt" OpHelp("IF r[P3]>r[P1]"),
  29393. /* 55 */ "Le" OpHelp("IF r[P3]<=r[P1]"),
  29394. /* 56 */ "Lt" OpHelp("IF r[P3]<r[P1]"),
  29395. /* 57 */ "Ge" OpHelp("IF r[P3]>=r[P1]"),
  29396. /* 58 */ "ElseNotEq" OpHelp(""),
  29397. /* 59 */ "DecrJumpZero" OpHelp("if (--r[P1])==0 goto P2"),
  29398. /* 60 */ "IncrVacuum" OpHelp(""),
  29399. /* 61 */ "VNext" OpHelp(""),
  29400. /* 62 */ "Init" OpHelp("Start at P2"),
  29401. /* 63 */ "Return" OpHelp(""),
  29402. /* 64 */ "EndCoroutine" OpHelp(""),
  29403. /* 65 */ "HaltIfNull" OpHelp("if r[P3]=null halt"),
  29404. /* 66 */ "Halt" OpHelp(""),
  29405. /* 67 */ "Integer" OpHelp("r[P2]=P1"),
  29406. /* 68 */ "Int64" OpHelp("r[P2]=P4"),
  29407. /* 69 */ "String" OpHelp("r[P2]='P4' (len=P1)"),
  29408. /* 70 */ "Null" OpHelp("r[P2..P3]=NULL"),
  29409. /* 71 */ "SoftNull" OpHelp("r[P1]=NULL"),
  29410. /* 72 */ "Blob" OpHelp("r[P2]=P4 (len=P1)"),
  29411. /* 73 */ "Variable" OpHelp("r[P2]=parameter(P1,P4)"),
  29412. /* 74 */ "Move" OpHelp("r[P2@P3]=r[P1@P3]"),
  29413. /* 75 */ "Copy" OpHelp("r[P2@P3+1]=r[P1@P3+1]"),
  29414. /* 76 */ "SCopy" OpHelp("r[P2]=r[P1]"),
  29415. /* 77 */ "IntCopy" OpHelp("r[P2]=r[P1]"),
  29416. /* 78 */ "ResultRow" OpHelp("output=r[P1@P2]"),
  29417. /* 79 */ "CollSeq" OpHelp(""),
  29418. /* 80 */ "AddImm" OpHelp("r[P1]=r[P1]+P2"),
  29419. /* 81 */ "RealAffinity" OpHelp(""),
  29420. /* 82 */ "Cast" OpHelp("affinity(r[P1])"),
  29421. /* 83 */ "Permutation" OpHelp(""),
  29422. /* 84 */ "BitAnd" OpHelp("r[P3]=r[P1]&r[P2]"),
  29423. /* 85 */ "BitOr" OpHelp("r[P3]=r[P1]|r[P2]"),
  29424. /* 86 */ "ShiftLeft" OpHelp("r[P3]=r[P2]<<r[P1]"),
  29425. /* 87 */ "ShiftRight" OpHelp("r[P3]=r[P2]>>r[P1]"),
  29426. /* 88 */ "Add" OpHelp("r[P3]=r[P1]+r[P2]"),
  29427. /* 89 */ "Subtract" OpHelp("r[P3]=r[P2]-r[P1]"),
  29428. /* 90 */ "Multiply" OpHelp("r[P3]=r[P1]*r[P2]"),
  29429. /* 91 */ "Divide" OpHelp("r[P3]=r[P2]/r[P1]"),
  29430. /* 92 */ "Remainder" OpHelp("r[P3]=r[P2]%r[P1]"),
  29431. /* 93 */ "Concat" OpHelp("r[P3]=r[P2]+r[P1]"),
  29432. /* 94 */ "Compare" OpHelp("r[P1@P3] <-> r[P2@P3]"),
  29433. /* 95 */ "BitNot" OpHelp("r[P1]= ~r[P1]"),
  29434. /* 96 */ "IsTrue" OpHelp("r[P2] = coalesce(r[P1]==TRUE,P3) ^ P4"),
  29435. /* 97 */ "String8" OpHelp("r[P2]='P4'"),
  29436. /* 98 */ "Offset" OpHelp("r[P3] = sqlite_offset(P1)"),
  29437. /* 99 */ "Column" OpHelp("r[P3]=PX"),
  29438. /* 100 */ "Affinity" OpHelp("affinity(r[P1@P2])"),
  29439. /* 101 */ "MakeRecord" OpHelp("r[P3]=mkrec(r[P1@P2])"),
  29440. /* 102 */ "Count" OpHelp("r[P2]=count()"),
  29441. /* 103 */ "ReadCookie" OpHelp(""),
  29442. /* 104 */ "SetCookie" OpHelp(""),
  29443. /* 105 */ "ReopenIdx" OpHelp("root=P2 iDb=P3"),
  29444. /* 106 */ "OpenRead" OpHelp("root=P2 iDb=P3"),
  29445. /* 107 */ "OpenWrite" OpHelp("root=P2 iDb=P3"),
  29446. /* 108 */ "OpenDup" OpHelp(""),
  29447. /* 109 */ "OpenAutoindex" OpHelp("nColumn=P2"),
  29448. /* 110 */ "OpenEphemeral" OpHelp("nColumn=P2"),
  29449. /* 111 */ "SorterOpen" OpHelp(""),
  29450. /* 112 */ "SequenceTest" OpHelp("if( cursor[P1].ctr++ ) pc = P2"),
  29451. /* 113 */ "OpenPseudo" OpHelp("P3 columns in r[P2]"),
  29452. /* 114 */ "Close" OpHelp(""),
  29453. /* 115 */ "ColumnsUsed" OpHelp(""),
  29454. /* 116 */ "Sequence" OpHelp("r[P2]=cursor[P1].ctr++"),
  29455. /* 117 */ "NewRowid" OpHelp("r[P2]=rowid"),
  29456. /* 118 */ "Insert" OpHelp("intkey=r[P3] data=r[P2]"),
  29457. /* 119 */ "InsertInt" OpHelp("intkey=P3 data=r[P2]"),
  29458. /* 120 */ "Delete" OpHelp(""),
  29459. /* 121 */ "ResetCount" OpHelp(""),
  29460. /* 122 */ "SorterCompare" OpHelp("if key(P1)!=trim(r[P3],P4) goto P2"),
  29461. /* 123 */ "SorterData" OpHelp("r[P2]=data"),
  29462. /* 124 */ "RowData" OpHelp("r[P2]=data"),
  29463. /* 125 */ "Rowid" OpHelp("r[P2]=rowid"),
  29464. /* 126 */ "NullRow" OpHelp(""),
  29465. /* 127 */ "SeekEnd" OpHelp(""),
  29466. /* 128 */ "SorterInsert" OpHelp("key=r[P2]"),
  29467. /* 129 */ "IdxInsert" OpHelp("key=r[P2]"),
  29468. /* 130 */ "IdxDelete" OpHelp("key=r[P2@P3]"),
  29469. /* 131 */ "DeferredSeek" OpHelp("Move P3 to P1.rowid if needed"),
  29470. /* 132 */ "Real" OpHelp("r[P2]=P4"),
  29471. /* 133 */ "IdxRowid" OpHelp("r[P2]=rowid"),
  29472. /* 134 */ "Destroy" OpHelp(""),
  29473. /* 135 */ "Clear" OpHelp(""),
  29474. /* 136 */ "ResetSorter" OpHelp(""),
  29475. /* 137 */ "CreateBtree" OpHelp("r[P2]=root iDb=P1 flags=P3"),
  29476. /* 138 */ "SqlExec" OpHelp(""),
  29477. /* 139 */ "ParseSchema" OpHelp(""),
  29478. /* 140 */ "LoadAnalysis" OpHelp(""),
  29479. /* 141 */ "DropTable" OpHelp(""),
  29480. /* 142 */ "DropIndex" OpHelp(""),
  29481. /* 143 */ "DropTrigger" OpHelp(""),
  29482. /* 144 */ "IntegrityCk" OpHelp(""),
  29483. /* 145 */ "RowSetAdd" OpHelp("rowset(P1)=r[P2]"),
  29484. /* 146 */ "Param" OpHelp(""),
  29485. /* 147 */ "FkCounter" OpHelp("fkctr[P1]+=P2"),
  29486. /* 148 */ "MemMax" OpHelp("r[P1]=max(r[P1],r[P2])"),
  29487. /* 149 */ "OffsetLimit" OpHelp("if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)"),
  29488. /* 150 */ "AggStep0" OpHelp("accum=r[P3] step(r[P2@P5])"),
  29489. /* 151 */ "AggStep" OpHelp("accum=r[P3] step(r[P2@P5])"),
  29490. /* 152 */ "AggFinal" OpHelp("accum=r[P1] N=P2"),
  29491. /* 153 */ "Expire" OpHelp(""),
  29492. /* 154 */ "TableLock" OpHelp("iDb=P1 root=P2 write=P3"),
  29493. /* 155 */ "VBegin" OpHelp(""),
  29494. /* 156 */ "VCreate" OpHelp(""),
  29495. /* 157 */ "VDestroy" OpHelp(""),
  29496. /* 158 */ "VOpen" OpHelp(""),
  29497. /* 159 */ "VColumn" OpHelp("r[P3]=vcolumn(P2)"),
  29498. /* 160 */ "VRename" OpHelp(""),
  29499. /* 161 */ "Pagecount" OpHelp(""),
  29500. /* 162 */ "MaxPgcnt" OpHelp(""),
  29501. /* 163 */ "PureFunc0" OpHelp(""),
  29502. /* 164 */ "Function0" OpHelp("r[P3]=func(r[P2@P5])"),
  29503. /* 165 */ "PureFunc" OpHelp(""),
  29504. /* 166 */ "Function" OpHelp("r[P3]=func(r[P2@P5])"),
  29505. /* 167 */ "Trace" OpHelp(""),
  29506. /* 168 */ "CursorHint" OpHelp(""),
  29507. /* 169 */ "Noop" OpHelp(""),
  29508. /* 170 */ "Explain" OpHelp(""),
  29509. };
  29510. return azName[i];
  29511. }
  29512. #endif
  29513. /************** End of opcodes.c *********************************************/
  29514. /************** Begin file os_unix.c *****************************************/
  29515. /*
  29516. ** 2004 May 22
  29517. **
  29518. ** The author disclaims copyright to this source code. In place of
  29519. ** a legal notice, here is a blessing:
  29520. **
  29521. ** May you do good and not evil.
  29522. ** May you find forgiveness for yourself and forgive others.
  29523. ** May you share freely, never taking more than you give.
  29524. **
  29525. ******************************************************************************
  29526. **
  29527. ** This file contains the VFS implementation for unix-like operating systems
  29528. ** include Linux, MacOSX, *BSD, QNX, VxWorks, AIX, HPUX, and others.
  29529. **
  29530. ** There are actually several different VFS implementations in this file.
  29531. ** The differences are in the way that file locking is done. The default
  29532. ** implementation uses Posix Advisory Locks. Alternative implementations
  29533. ** use flock(), dot-files, various proprietary locking schemas, or simply
  29534. ** skip locking all together.
  29535. **
  29536. ** This source file is organized into divisions where the logic for various
  29537. ** subfunctions is contained within the appropriate division. PLEASE
  29538. ** KEEP THE STRUCTURE OF THIS FILE INTACT. New code should be placed
  29539. ** in the correct division and should be clearly labeled.
  29540. **
  29541. ** The layout of divisions is as follows:
  29542. **
  29543. ** * General-purpose declarations and utility functions.
  29544. ** * Unique file ID logic used by VxWorks.
  29545. ** * Various locking primitive implementations (all except proxy locking):
  29546. ** + for Posix Advisory Locks
  29547. ** + for no-op locks
  29548. ** + for dot-file locks
  29549. ** + for flock() locking
  29550. ** + for named semaphore locks (VxWorks only)
  29551. ** + for AFP filesystem locks (MacOSX only)
  29552. ** * sqlite3_file methods not associated with locking.
  29553. ** * Definitions of sqlite3_io_methods objects for all locking
  29554. ** methods plus "finder" functions for each locking method.
  29555. ** * sqlite3_vfs method implementations.
  29556. ** * Locking primitives for the proxy uber-locking-method. (MacOSX only)
  29557. ** * Definitions of sqlite3_vfs objects for all locking methods
  29558. ** plus implementations of sqlite3_os_init() and sqlite3_os_end().
  29559. */
  29560. /* #include "sqliteInt.h" */
  29561. #if SQLITE_OS_UNIX /* This file is used on unix only */
  29562. /*
  29563. ** There are various methods for file locking used for concurrency
  29564. ** control:
  29565. **
  29566. ** 1. POSIX locking (the default),
  29567. ** 2. No locking,
  29568. ** 3. Dot-file locking,
  29569. ** 4. flock() locking,
  29570. ** 5. AFP locking (OSX only),
  29571. ** 6. Named POSIX semaphores (VXWorks only),
  29572. ** 7. proxy locking. (OSX only)
  29573. **
  29574. ** Styles 4, 5, and 7 are only available of SQLITE_ENABLE_LOCKING_STYLE
  29575. ** is defined to 1. The SQLITE_ENABLE_LOCKING_STYLE also enables automatic
  29576. ** selection of the appropriate locking style based on the filesystem
  29577. ** where the database is located.
  29578. */
  29579. #if !defined(SQLITE_ENABLE_LOCKING_STYLE)
  29580. # if defined(__APPLE__)
  29581. # define SQLITE_ENABLE_LOCKING_STYLE 1
  29582. # else
  29583. # define SQLITE_ENABLE_LOCKING_STYLE 0
  29584. # endif
  29585. #endif
  29586. /* Use pread() and pwrite() if they are available */
  29587. #if defined(__APPLE__)
  29588. # define HAVE_PREAD 1
  29589. # define HAVE_PWRITE 1
  29590. #endif
  29591. #if defined(HAVE_PREAD64) && defined(HAVE_PWRITE64)
  29592. # undef USE_PREAD
  29593. # define USE_PREAD64 1
  29594. #elif defined(HAVE_PREAD) && defined(HAVE_PWRITE)
  29595. # undef USE_PREAD64
  29596. # define USE_PREAD 1
  29597. #endif
  29598. /*
  29599. ** standard include files.
  29600. */
  29601. #include <sys/types.h>
  29602. #include <sys/stat.h>
  29603. #include <fcntl.h>
  29604. #include <sys/ioctl.h>
  29605. #include <unistd.h>
  29606. /* #include <time.h> */
  29607. #include <sys/time.h>
  29608. #include <errno.h>
  29609. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  29610. # include <sys/mman.h>
  29611. #endif
  29612. #if SQLITE_ENABLE_LOCKING_STYLE
  29613. /* # include <sys/ioctl.h> */
  29614. # include <sys/file.h>
  29615. # include <sys/param.h>
  29616. #endif /* SQLITE_ENABLE_LOCKING_STYLE */
  29617. #if defined(__APPLE__) && ((__MAC_OS_X_VERSION_MIN_REQUIRED > 1050) || \
  29618. (__IPHONE_OS_VERSION_MIN_REQUIRED > 2000))
  29619. # if (!defined(TARGET_OS_EMBEDDED) || (TARGET_OS_EMBEDDED==0)) \
  29620. && (!defined(TARGET_IPHONE_SIMULATOR) || (TARGET_IPHONE_SIMULATOR==0))
  29621. # define HAVE_GETHOSTUUID 1
  29622. # else
  29623. # warning "gethostuuid() is disabled."
  29624. # endif
  29625. #endif
  29626. #if OS_VXWORKS
  29627. /* # include <sys/ioctl.h> */
  29628. # include <semaphore.h>
  29629. # include <limits.h>
  29630. #endif /* OS_VXWORKS */
  29631. #if defined(__APPLE__) || SQLITE_ENABLE_LOCKING_STYLE
  29632. # include <sys/mount.h>
  29633. #endif
  29634. #ifdef HAVE_UTIME
  29635. # include <utime.h>
  29636. #endif
  29637. /*
  29638. ** Allowed values of unixFile.fsFlags
  29639. */
  29640. #define SQLITE_FSFLAGS_IS_MSDOS 0x1
  29641. /*
  29642. ** If we are to be thread-safe, include the pthreads header and define
  29643. ** the SQLITE_UNIX_THREADS macro.
  29644. */
  29645. #if SQLITE_THREADSAFE
  29646. /* # include <pthread.h> */
  29647. # define SQLITE_UNIX_THREADS 1
  29648. #endif
  29649. /*
  29650. ** Default permissions when creating a new file
  29651. */
  29652. #ifndef SQLITE_DEFAULT_FILE_PERMISSIONS
  29653. # define SQLITE_DEFAULT_FILE_PERMISSIONS 0644
  29654. #endif
  29655. /*
  29656. ** Default permissions when creating auto proxy dir
  29657. */
  29658. #ifndef SQLITE_DEFAULT_PROXYDIR_PERMISSIONS
  29659. # define SQLITE_DEFAULT_PROXYDIR_PERMISSIONS 0755
  29660. #endif
  29661. /*
  29662. ** Maximum supported path-length.
  29663. */
  29664. #define MAX_PATHNAME 512
  29665. /*
  29666. ** Maximum supported symbolic links
  29667. */
  29668. #define SQLITE_MAX_SYMLINKS 100
  29669. /* Always cast the getpid() return type for compatibility with
  29670. ** kernel modules in VxWorks. */
  29671. #define osGetpid(X) (pid_t)getpid()
  29672. /*
  29673. ** Only set the lastErrno if the error code is a real error and not
  29674. ** a normal expected return code of SQLITE_BUSY or SQLITE_OK
  29675. */
  29676. #define IS_LOCK_ERROR(x) ((x != SQLITE_OK) && (x != SQLITE_BUSY))
  29677. /* Forward references */
  29678. typedef struct unixShm unixShm; /* Connection shared memory */
  29679. typedef struct unixShmNode unixShmNode; /* Shared memory instance */
  29680. typedef struct unixInodeInfo unixInodeInfo; /* An i-node */
  29681. typedef struct UnixUnusedFd UnixUnusedFd; /* An unused file descriptor */
  29682. /*
  29683. ** Sometimes, after a file handle is closed by SQLite, the file descriptor
  29684. ** cannot be closed immediately. In these cases, instances of the following
  29685. ** structure are used to store the file descriptor while waiting for an
  29686. ** opportunity to either close or reuse it.
  29687. */
  29688. struct UnixUnusedFd {
  29689. int fd; /* File descriptor to close */
  29690. int flags; /* Flags this file descriptor was opened with */
  29691. UnixUnusedFd *pNext; /* Next unused file descriptor on same file */
  29692. };
  29693. /*
  29694. ** The unixFile structure is subclass of sqlite3_file specific to the unix
  29695. ** VFS implementations.
  29696. */
  29697. typedef struct unixFile unixFile;
  29698. struct unixFile {
  29699. sqlite3_io_methods const *pMethod; /* Always the first entry */
  29700. sqlite3_vfs *pVfs; /* The VFS that created this unixFile */
  29701. unixInodeInfo *pInode; /* Info about locks on this inode */
  29702. int h; /* The file descriptor */
  29703. unsigned char eFileLock; /* The type of lock held on this fd */
  29704. unsigned short int ctrlFlags; /* Behavioral bits. UNIXFILE_* flags */
  29705. int lastErrno; /* The unix errno from last I/O error */
  29706. void *lockingContext; /* Locking style specific state */
  29707. UnixUnusedFd *pPreallocatedUnused; /* Pre-allocated UnixUnusedFd */
  29708. const char *zPath; /* Name of the file */
  29709. unixShm *pShm; /* Shared memory segment information */
  29710. int szChunk; /* Configured by FCNTL_CHUNK_SIZE */
  29711. #if SQLITE_MAX_MMAP_SIZE>0
  29712. int nFetchOut; /* Number of outstanding xFetch refs */
  29713. sqlite3_int64 mmapSize; /* Usable size of mapping at pMapRegion */
  29714. sqlite3_int64 mmapSizeActual; /* Actual size of mapping at pMapRegion */
  29715. sqlite3_int64 mmapSizeMax; /* Configured FCNTL_MMAP_SIZE value */
  29716. void *pMapRegion; /* Memory mapped region */
  29717. #endif
  29718. int sectorSize; /* Device sector size */
  29719. int deviceCharacteristics; /* Precomputed device characteristics */
  29720. #if SQLITE_ENABLE_LOCKING_STYLE
  29721. int openFlags; /* The flags specified at open() */
  29722. #endif
  29723. #if SQLITE_ENABLE_LOCKING_STYLE || defined(__APPLE__)
  29724. unsigned fsFlags; /* cached details from statfs() */
  29725. #endif
  29726. #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
  29727. unsigned iBusyTimeout; /* Wait this many millisec on locks */
  29728. #endif
  29729. #if OS_VXWORKS
  29730. struct vxworksFileId *pId; /* Unique file ID */
  29731. #endif
  29732. #ifdef SQLITE_DEBUG
  29733. /* The next group of variables are used to track whether or not the
  29734. ** transaction counter in bytes 24-27 of database files are updated
  29735. ** whenever any part of the database changes. An assertion fault will
  29736. ** occur if a file is updated without also updating the transaction
  29737. ** counter. This test is made to avoid new problems similar to the
  29738. ** one described by ticket #3584.
  29739. */
  29740. unsigned char transCntrChng; /* True if the transaction counter changed */
  29741. unsigned char dbUpdate; /* True if any part of database file changed */
  29742. unsigned char inNormalWrite; /* True if in a normal write operation */
  29743. #endif
  29744. #ifdef SQLITE_TEST
  29745. /* In test mode, increase the size of this structure a bit so that
  29746. ** it is larger than the struct CrashFile defined in test6.c.
  29747. */
  29748. char aPadding[32];
  29749. #endif
  29750. };
  29751. /* This variable holds the process id (pid) from when the xRandomness()
  29752. ** method was called. If xOpen() is called from a different process id,
  29753. ** indicating that a fork() has occurred, the PRNG will be reset.
  29754. */
  29755. static pid_t randomnessPid = 0;
  29756. /*
  29757. ** Allowed values for the unixFile.ctrlFlags bitmask:
  29758. */
  29759. #define UNIXFILE_EXCL 0x01 /* Connections from one process only */
  29760. #define UNIXFILE_RDONLY 0x02 /* Connection is read only */
  29761. #define UNIXFILE_PERSIST_WAL 0x04 /* Persistent WAL mode */
  29762. #ifndef SQLITE_DISABLE_DIRSYNC
  29763. # define UNIXFILE_DIRSYNC 0x08 /* Directory sync needed */
  29764. #else
  29765. # define UNIXFILE_DIRSYNC 0x00
  29766. #endif
  29767. #define UNIXFILE_PSOW 0x10 /* SQLITE_IOCAP_POWERSAFE_OVERWRITE */
  29768. #define UNIXFILE_DELETE 0x20 /* Delete on close */
  29769. #define UNIXFILE_URI 0x40 /* Filename might have query parameters */
  29770. #define UNIXFILE_NOLOCK 0x80 /* Do no file locking */
  29771. /*
  29772. ** Include code that is common to all os_*.c files
  29773. */
  29774. /************** Include os_common.h in the middle of os_unix.c ***************/
  29775. /************** Begin file os_common.h ***************************************/
  29776. /*
  29777. ** 2004 May 22
  29778. **
  29779. ** The author disclaims copyright to this source code. In place of
  29780. ** a legal notice, here is a blessing:
  29781. **
  29782. ** May you do good and not evil.
  29783. ** May you find forgiveness for yourself and forgive others.
  29784. ** May you share freely, never taking more than you give.
  29785. **
  29786. ******************************************************************************
  29787. **
  29788. ** This file contains macros and a little bit of code that is common to
  29789. ** all of the platform-specific files (os_*.c) and is #included into those
  29790. ** files.
  29791. **
  29792. ** This file should be #included by the os_*.c files only. It is not a
  29793. ** general purpose header file.
  29794. */
  29795. #ifndef _OS_COMMON_H_
  29796. #define _OS_COMMON_H_
  29797. /*
  29798. ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
  29799. ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
  29800. ** switch. The following code should catch this problem at compile-time.
  29801. */
  29802. #ifdef MEMORY_DEBUG
  29803. # error "The MEMORY_DEBUG macro is obsolete. Use SQLITE_DEBUG instead."
  29804. #endif
  29805. /*
  29806. ** Macros for performance tracing. Normally turned off. Only works
  29807. ** on i486 hardware.
  29808. */
  29809. #ifdef SQLITE_PERFORMANCE_TRACE
  29810. /*
  29811. ** hwtime.h contains inline assembler code for implementing
  29812. ** high-performance timing routines.
  29813. */
  29814. /************** Include hwtime.h in the middle of os_common.h ****************/
  29815. /************** Begin file hwtime.h ******************************************/
  29816. /*
  29817. ** 2008 May 27
  29818. **
  29819. ** The author disclaims copyright to this source code. In place of
  29820. ** a legal notice, here is a blessing:
  29821. **
  29822. ** May you do good and not evil.
  29823. ** May you find forgiveness for yourself and forgive others.
  29824. ** May you share freely, never taking more than you give.
  29825. **
  29826. ******************************************************************************
  29827. **
  29828. ** This file contains inline asm code for retrieving "high-performance"
  29829. ** counters for x86 class CPUs.
  29830. */
  29831. #ifndef SQLITE_HWTIME_H
  29832. #define SQLITE_HWTIME_H
  29833. /*
  29834. ** The following routine only works on pentium-class (or newer) processors.
  29835. ** It uses the RDTSC opcode to read the cycle count value out of the
  29836. ** processor and returns that value. This can be used for high-res
  29837. ** profiling.
  29838. */
  29839. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  29840. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  29841. #if defined(__GNUC__)
  29842. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  29843. unsigned int lo, hi;
  29844. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  29845. return (sqlite_uint64)hi << 32 | lo;
  29846. }
  29847. #elif defined(_MSC_VER)
  29848. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  29849. __asm {
  29850. rdtsc
  29851. ret ; return value at EDX:EAX
  29852. }
  29853. }
  29854. #endif
  29855. #elif (defined(__GNUC__) && defined(__x86_64__))
  29856. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  29857. unsigned long val;
  29858. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  29859. return val;
  29860. }
  29861. #elif (defined(__GNUC__) && defined(__ppc__))
  29862. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  29863. unsigned long long retval;
  29864. unsigned long junk;
  29865. __asm__ __volatile__ ("\n\
  29866. 1: mftbu %1\n\
  29867. mftb %L0\n\
  29868. mftbu %0\n\
  29869. cmpw %0,%1\n\
  29870. bne 1b"
  29871. : "=r" (retval), "=r" (junk));
  29872. return retval;
  29873. }
  29874. #else
  29875. #error Need implementation of sqlite3Hwtime() for your platform.
  29876. /*
  29877. ** To compile without implementing sqlite3Hwtime() for your platform,
  29878. ** you can remove the above #error and use the following
  29879. ** stub function. You will lose timing support for many
  29880. ** of the debugging and testing utilities, but it should at
  29881. ** least compile and run.
  29882. */
  29883. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  29884. #endif
  29885. #endif /* !defined(SQLITE_HWTIME_H) */
  29886. /************** End of hwtime.h **********************************************/
  29887. /************** Continuing where we left off in os_common.h ******************/
  29888. static sqlite_uint64 g_start;
  29889. static sqlite_uint64 g_elapsed;
  29890. #define TIMER_START g_start=sqlite3Hwtime()
  29891. #define TIMER_END g_elapsed=sqlite3Hwtime()-g_start
  29892. #define TIMER_ELAPSED g_elapsed
  29893. #else
  29894. #define TIMER_START
  29895. #define TIMER_END
  29896. #define TIMER_ELAPSED ((sqlite_uint64)0)
  29897. #endif
  29898. /*
  29899. ** If we compile with the SQLITE_TEST macro set, then the following block
  29900. ** of code will give us the ability to simulate a disk I/O error. This
  29901. ** is used for testing the I/O recovery logic.
  29902. */
  29903. #if defined(SQLITE_TEST)
  29904. SQLITE_API extern int sqlite3_io_error_hit;
  29905. SQLITE_API extern int sqlite3_io_error_hardhit;
  29906. SQLITE_API extern int sqlite3_io_error_pending;
  29907. SQLITE_API extern int sqlite3_io_error_persist;
  29908. SQLITE_API extern int sqlite3_io_error_benign;
  29909. SQLITE_API extern int sqlite3_diskfull_pending;
  29910. SQLITE_API extern int sqlite3_diskfull;
  29911. #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
  29912. #define SimulateIOError(CODE) \
  29913. if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
  29914. || sqlite3_io_error_pending-- == 1 ) \
  29915. { local_ioerr(); CODE; }
  29916. static void local_ioerr(){
  29917. IOTRACE(("IOERR\n"));
  29918. sqlite3_io_error_hit++;
  29919. if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
  29920. }
  29921. #define SimulateDiskfullError(CODE) \
  29922. if( sqlite3_diskfull_pending ){ \
  29923. if( sqlite3_diskfull_pending == 1 ){ \
  29924. local_ioerr(); \
  29925. sqlite3_diskfull = 1; \
  29926. sqlite3_io_error_hit = 1; \
  29927. CODE; \
  29928. }else{ \
  29929. sqlite3_diskfull_pending--; \
  29930. } \
  29931. }
  29932. #else
  29933. #define SimulateIOErrorBenign(X)
  29934. #define SimulateIOError(A)
  29935. #define SimulateDiskfullError(A)
  29936. #endif /* defined(SQLITE_TEST) */
  29937. /*
  29938. ** When testing, keep a count of the number of open files.
  29939. */
  29940. #if defined(SQLITE_TEST)
  29941. SQLITE_API extern int sqlite3_open_file_count;
  29942. #define OpenCounter(X) sqlite3_open_file_count+=(X)
  29943. #else
  29944. #define OpenCounter(X)
  29945. #endif /* defined(SQLITE_TEST) */
  29946. #endif /* !defined(_OS_COMMON_H_) */
  29947. /************** End of os_common.h *******************************************/
  29948. /************** Continuing where we left off in os_unix.c ********************/
  29949. /*
  29950. ** Define various macros that are missing from some systems.
  29951. */
  29952. #ifndef O_LARGEFILE
  29953. # define O_LARGEFILE 0
  29954. #endif
  29955. #ifdef SQLITE_DISABLE_LFS
  29956. # undef O_LARGEFILE
  29957. # define O_LARGEFILE 0
  29958. #endif
  29959. #ifndef O_NOFOLLOW
  29960. # define O_NOFOLLOW 0
  29961. #endif
  29962. #ifndef O_BINARY
  29963. # define O_BINARY 0
  29964. #endif
  29965. /*
  29966. ** The threadid macro resolves to the thread-id or to 0. Used for
  29967. ** testing and debugging only.
  29968. */
  29969. #if SQLITE_THREADSAFE
  29970. #define threadid pthread_self()
  29971. #else
  29972. #define threadid 0
  29973. #endif
  29974. /*
  29975. ** HAVE_MREMAP defaults to true on Linux and false everywhere else.
  29976. */
  29977. #if !defined(HAVE_MREMAP)
  29978. # if defined(__linux__) && defined(_GNU_SOURCE)
  29979. # define HAVE_MREMAP 1
  29980. # else
  29981. # define HAVE_MREMAP 0
  29982. # endif
  29983. #endif
  29984. /*
  29985. ** Explicitly call the 64-bit version of lseek() on Android. Otherwise, lseek()
  29986. ** is the 32-bit version, even if _FILE_OFFSET_BITS=64 is defined.
  29987. */
  29988. #ifdef __ANDROID__
  29989. # define lseek lseek64
  29990. #endif
  29991. #ifdef __linux__
  29992. /*
  29993. ** Linux-specific IOCTL magic numbers used for controlling F2FS
  29994. */
  29995. #define F2FS_IOCTL_MAGIC 0xf5
  29996. #define F2FS_IOC_START_ATOMIC_WRITE _IO(F2FS_IOCTL_MAGIC, 1)
  29997. #define F2FS_IOC_COMMIT_ATOMIC_WRITE _IO(F2FS_IOCTL_MAGIC, 2)
  29998. #define F2FS_IOC_START_VOLATILE_WRITE _IO(F2FS_IOCTL_MAGIC, 3)
  29999. #define F2FS_IOC_ABORT_VOLATILE_WRITE _IO(F2FS_IOCTL_MAGIC, 5)
  30000. #define F2FS_IOC_GET_FEATURES _IOR(F2FS_IOCTL_MAGIC, 12, u32)
  30001. #define F2FS_FEATURE_ATOMIC_WRITE 0x0004
  30002. #endif /* __linux__ */
  30003. /*
  30004. ** Different Unix systems declare open() in different ways. Same use
  30005. ** open(const char*,int,mode_t). Others use open(const char*,int,...).
  30006. ** The difference is important when using a pointer to the function.
  30007. **
  30008. ** The safest way to deal with the problem is to always use this wrapper
  30009. ** which always has the same well-defined interface.
  30010. */
  30011. static int posixOpen(const char *zFile, int flags, int mode){
  30012. return open(zFile, flags, mode);
  30013. }
  30014. /* Forward reference */
  30015. static int openDirectory(const char*, int*);
  30016. static int unixGetpagesize(void);
  30017. /*
  30018. ** Many system calls are accessed through pointer-to-functions so that
  30019. ** they may be overridden at runtime to facilitate fault injection during
  30020. ** testing and sandboxing. The following array holds the names and pointers
  30021. ** to all overrideable system calls.
  30022. */
  30023. static struct unix_syscall {
  30024. const char *zName; /* Name of the system call */
  30025. sqlite3_syscall_ptr pCurrent; /* Current value of the system call */
  30026. sqlite3_syscall_ptr pDefault; /* Default value */
  30027. } aSyscall[] = {
  30028. { "open", (sqlite3_syscall_ptr)posixOpen, 0 },
  30029. #define osOpen ((int(*)(const char*,int,int))aSyscall[0].pCurrent)
  30030. { "close", (sqlite3_syscall_ptr)close, 0 },
  30031. #define osClose ((int(*)(int))aSyscall[1].pCurrent)
  30032. { "access", (sqlite3_syscall_ptr)access, 0 },
  30033. #define osAccess ((int(*)(const char*,int))aSyscall[2].pCurrent)
  30034. { "getcwd", (sqlite3_syscall_ptr)getcwd, 0 },
  30035. #define osGetcwd ((char*(*)(char*,size_t))aSyscall[3].pCurrent)
  30036. { "stat", (sqlite3_syscall_ptr)stat, 0 },
  30037. #define osStat ((int(*)(const char*,struct stat*))aSyscall[4].pCurrent)
  30038. /*
  30039. ** The DJGPP compiler environment looks mostly like Unix, but it
  30040. ** lacks the fcntl() system call. So redefine fcntl() to be something
  30041. ** that always succeeds. This means that locking does not occur under
  30042. ** DJGPP. But it is DOS - what did you expect?
  30043. */
  30044. #ifdef __DJGPP__
  30045. { "fstat", 0, 0 },
  30046. #define osFstat(a,b,c) 0
  30047. #else
  30048. { "fstat", (sqlite3_syscall_ptr)fstat, 0 },
  30049. #define osFstat ((int(*)(int,struct stat*))aSyscall[5].pCurrent)
  30050. #endif
  30051. { "ftruncate", (sqlite3_syscall_ptr)ftruncate, 0 },
  30052. #define osFtruncate ((int(*)(int,off_t))aSyscall[6].pCurrent)
  30053. { "fcntl", (sqlite3_syscall_ptr)fcntl, 0 },
  30054. #define osFcntl ((int(*)(int,int,...))aSyscall[7].pCurrent)
  30055. { "read", (sqlite3_syscall_ptr)read, 0 },
  30056. #define osRead ((ssize_t(*)(int,void*,size_t))aSyscall[8].pCurrent)
  30057. #if defined(USE_PREAD) || SQLITE_ENABLE_LOCKING_STYLE
  30058. { "pread", (sqlite3_syscall_ptr)pread, 0 },
  30059. #else
  30060. { "pread", (sqlite3_syscall_ptr)0, 0 },
  30061. #endif
  30062. #define osPread ((ssize_t(*)(int,void*,size_t,off_t))aSyscall[9].pCurrent)
  30063. #if defined(USE_PREAD64)
  30064. { "pread64", (sqlite3_syscall_ptr)pread64, 0 },
  30065. #else
  30066. { "pread64", (sqlite3_syscall_ptr)0, 0 },
  30067. #endif
  30068. #define osPread64 ((ssize_t(*)(int,void*,size_t,off64_t))aSyscall[10].pCurrent)
  30069. { "write", (sqlite3_syscall_ptr)write, 0 },
  30070. #define osWrite ((ssize_t(*)(int,const void*,size_t))aSyscall[11].pCurrent)
  30071. #if defined(USE_PREAD) || SQLITE_ENABLE_LOCKING_STYLE
  30072. { "pwrite", (sqlite3_syscall_ptr)pwrite, 0 },
  30073. #else
  30074. { "pwrite", (sqlite3_syscall_ptr)0, 0 },
  30075. #endif
  30076. #define osPwrite ((ssize_t(*)(int,const void*,size_t,off_t))\
  30077. aSyscall[12].pCurrent)
  30078. #if defined(USE_PREAD64)
  30079. { "pwrite64", (sqlite3_syscall_ptr)pwrite64, 0 },
  30080. #else
  30081. { "pwrite64", (sqlite3_syscall_ptr)0, 0 },
  30082. #endif
  30083. #define osPwrite64 ((ssize_t(*)(int,const void*,size_t,off64_t))\
  30084. aSyscall[13].pCurrent)
  30085. { "fchmod", (sqlite3_syscall_ptr)fchmod, 0 },
  30086. #define osFchmod ((int(*)(int,mode_t))aSyscall[14].pCurrent)
  30087. #if defined(HAVE_POSIX_FALLOCATE) && HAVE_POSIX_FALLOCATE
  30088. { "fallocate", (sqlite3_syscall_ptr)posix_fallocate, 0 },
  30089. #else
  30090. { "fallocate", (sqlite3_syscall_ptr)0, 0 },
  30091. #endif
  30092. #define osFallocate ((int(*)(int,off_t,off_t))aSyscall[15].pCurrent)
  30093. { "unlink", (sqlite3_syscall_ptr)unlink, 0 },
  30094. #define osUnlink ((int(*)(const char*))aSyscall[16].pCurrent)
  30095. { "openDirectory", (sqlite3_syscall_ptr)openDirectory, 0 },
  30096. #define osOpenDirectory ((int(*)(const char*,int*))aSyscall[17].pCurrent)
  30097. { "mkdir", (sqlite3_syscall_ptr)mkdir, 0 },
  30098. #define osMkdir ((int(*)(const char*,mode_t))aSyscall[18].pCurrent)
  30099. { "rmdir", (sqlite3_syscall_ptr)rmdir, 0 },
  30100. #define osRmdir ((int(*)(const char*))aSyscall[19].pCurrent)
  30101. #if defined(HAVE_FCHOWN)
  30102. { "fchown", (sqlite3_syscall_ptr)fchown, 0 },
  30103. #else
  30104. { "fchown", (sqlite3_syscall_ptr)0, 0 },
  30105. #endif
  30106. #define osFchown ((int(*)(int,uid_t,gid_t))aSyscall[20].pCurrent)
  30107. #if defined(HAVE_FCHOWN)
  30108. { "geteuid", (sqlite3_syscall_ptr)geteuid, 0 },
  30109. #else
  30110. { "geteuid", (sqlite3_syscall_ptr)0, 0 },
  30111. #endif
  30112. #define osGeteuid ((uid_t(*)(void))aSyscall[21].pCurrent)
  30113. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  30114. { "mmap", (sqlite3_syscall_ptr)mmap, 0 },
  30115. #else
  30116. { "mmap", (sqlite3_syscall_ptr)0, 0 },
  30117. #endif
  30118. #define osMmap ((void*(*)(void*,size_t,int,int,int,off_t))aSyscall[22].pCurrent)
  30119. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  30120. { "munmap", (sqlite3_syscall_ptr)munmap, 0 },
  30121. #else
  30122. { "munmap", (sqlite3_syscall_ptr)0, 0 },
  30123. #endif
  30124. #define osMunmap ((int(*)(void*,size_t))aSyscall[23].pCurrent)
  30125. #if HAVE_MREMAP && (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  30126. { "mremap", (sqlite3_syscall_ptr)mremap, 0 },
  30127. #else
  30128. { "mremap", (sqlite3_syscall_ptr)0, 0 },
  30129. #endif
  30130. #define osMremap ((void*(*)(void*,size_t,size_t,int,...))aSyscall[24].pCurrent)
  30131. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  30132. { "getpagesize", (sqlite3_syscall_ptr)unixGetpagesize, 0 },
  30133. #else
  30134. { "getpagesize", (sqlite3_syscall_ptr)0, 0 },
  30135. #endif
  30136. #define osGetpagesize ((int(*)(void))aSyscall[25].pCurrent)
  30137. #if defined(HAVE_READLINK)
  30138. { "readlink", (sqlite3_syscall_ptr)readlink, 0 },
  30139. #else
  30140. { "readlink", (sqlite3_syscall_ptr)0, 0 },
  30141. #endif
  30142. #define osReadlink ((ssize_t(*)(const char*,char*,size_t))aSyscall[26].pCurrent)
  30143. #if defined(HAVE_LSTAT)
  30144. { "lstat", (sqlite3_syscall_ptr)lstat, 0 },
  30145. #else
  30146. { "lstat", (sqlite3_syscall_ptr)0, 0 },
  30147. #endif
  30148. #define osLstat ((int(*)(const char*,struct stat*))aSyscall[27].pCurrent)
  30149. #if defined(__linux__) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  30150. { "ioctl", (sqlite3_syscall_ptr)ioctl, 0 },
  30151. #else
  30152. { "ioctl", (sqlite3_syscall_ptr)0, 0 },
  30153. #endif
  30154. #define osIoctl ((int(*)(int,int,...))aSyscall[28].pCurrent)
  30155. }; /* End of the overrideable system calls */
  30156. /*
  30157. ** On some systems, calls to fchown() will trigger a message in a security
  30158. ** log if they come from non-root processes. So avoid calling fchown() if
  30159. ** we are not running as root.
  30160. */
  30161. static int robustFchown(int fd, uid_t uid, gid_t gid){
  30162. #if defined(HAVE_FCHOWN)
  30163. return osGeteuid() ? 0 : osFchown(fd,uid,gid);
  30164. #else
  30165. return 0;
  30166. #endif
  30167. }
  30168. /*
  30169. ** This is the xSetSystemCall() method of sqlite3_vfs for all of the
  30170. ** "unix" VFSes. Return SQLITE_OK opon successfully updating the
  30171. ** system call pointer, or SQLITE_NOTFOUND if there is no configurable
  30172. ** system call named zName.
  30173. */
  30174. static int unixSetSystemCall(
  30175. sqlite3_vfs *pNotUsed, /* The VFS pointer. Not used */
  30176. const char *zName, /* Name of system call to override */
  30177. sqlite3_syscall_ptr pNewFunc /* Pointer to new system call value */
  30178. ){
  30179. unsigned int i;
  30180. int rc = SQLITE_NOTFOUND;
  30181. UNUSED_PARAMETER(pNotUsed);
  30182. if( zName==0 ){
  30183. /* If no zName is given, restore all system calls to their default
  30184. ** settings and return NULL
  30185. */
  30186. rc = SQLITE_OK;
  30187. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  30188. if( aSyscall[i].pDefault ){
  30189. aSyscall[i].pCurrent = aSyscall[i].pDefault;
  30190. }
  30191. }
  30192. }else{
  30193. /* If zName is specified, operate on only the one system call
  30194. ** specified.
  30195. */
  30196. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  30197. if( strcmp(zName, aSyscall[i].zName)==0 ){
  30198. if( aSyscall[i].pDefault==0 ){
  30199. aSyscall[i].pDefault = aSyscall[i].pCurrent;
  30200. }
  30201. rc = SQLITE_OK;
  30202. if( pNewFunc==0 ) pNewFunc = aSyscall[i].pDefault;
  30203. aSyscall[i].pCurrent = pNewFunc;
  30204. break;
  30205. }
  30206. }
  30207. }
  30208. return rc;
  30209. }
  30210. /*
  30211. ** Return the value of a system call. Return NULL if zName is not a
  30212. ** recognized system call name. NULL is also returned if the system call
  30213. ** is currently undefined.
  30214. */
  30215. static sqlite3_syscall_ptr unixGetSystemCall(
  30216. sqlite3_vfs *pNotUsed,
  30217. const char *zName
  30218. ){
  30219. unsigned int i;
  30220. UNUSED_PARAMETER(pNotUsed);
  30221. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  30222. if( strcmp(zName, aSyscall[i].zName)==0 ) return aSyscall[i].pCurrent;
  30223. }
  30224. return 0;
  30225. }
  30226. /*
  30227. ** Return the name of the first system call after zName. If zName==NULL
  30228. ** then return the name of the first system call. Return NULL if zName
  30229. ** is the last system call or if zName is not the name of a valid
  30230. ** system call.
  30231. */
  30232. static const char *unixNextSystemCall(sqlite3_vfs *p, const char *zName){
  30233. int i = -1;
  30234. UNUSED_PARAMETER(p);
  30235. if( zName ){
  30236. for(i=0; i<ArraySize(aSyscall)-1; i++){
  30237. if( strcmp(zName, aSyscall[i].zName)==0 ) break;
  30238. }
  30239. }
  30240. for(i++; i<ArraySize(aSyscall); i++){
  30241. if( aSyscall[i].pCurrent!=0 ) return aSyscall[i].zName;
  30242. }
  30243. return 0;
  30244. }
  30245. /*
  30246. ** Do not accept any file descriptor less than this value, in order to avoid
  30247. ** opening database file using file descriptors that are commonly used for
  30248. ** standard input, output, and error.
  30249. */
  30250. #ifndef SQLITE_MINIMUM_FILE_DESCRIPTOR
  30251. # define SQLITE_MINIMUM_FILE_DESCRIPTOR 3
  30252. #endif
  30253. /*
  30254. ** Invoke open(). Do so multiple times, until it either succeeds or
  30255. ** fails for some reason other than EINTR.
  30256. **
  30257. ** If the file creation mode "m" is 0 then set it to the default for
  30258. ** SQLite. The default is SQLITE_DEFAULT_FILE_PERMISSIONS (normally
  30259. ** 0644) as modified by the system umask. If m is not 0, then
  30260. ** make the file creation mode be exactly m ignoring the umask.
  30261. **
  30262. ** The m parameter will be non-zero only when creating -wal, -journal,
  30263. ** and -shm files. We want those files to have *exactly* the same
  30264. ** permissions as their original database, unadulterated by the umask.
  30265. ** In that way, if a database file is -rw-rw-rw or -rw-rw-r-, and a
  30266. ** transaction crashes and leaves behind hot journals, then any
  30267. ** process that is able to write to the database will also be able to
  30268. ** recover the hot journals.
  30269. */
  30270. static int robust_open(const char *z, int f, mode_t m){
  30271. int fd;
  30272. mode_t m2 = m ? m : SQLITE_DEFAULT_FILE_PERMISSIONS;
  30273. while(1){
  30274. #if defined(O_CLOEXEC)
  30275. fd = osOpen(z,f|O_CLOEXEC,m2);
  30276. #else
  30277. fd = osOpen(z,f,m2);
  30278. #endif
  30279. if( fd<0 ){
  30280. if( errno==EINTR ) continue;
  30281. break;
  30282. }
  30283. if( fd>=SQLITE_MINIMUM_FILE_DESCRIPTOR ) break;
  30284. osClose(fd);
  30285. sqlite3_log(SQLITE_WARNING,
  30286. "attempt to open \"%s\" as file descriptor %d", z, fd);
  30287. fd = -1;
  30288. if( osOpen("/dev/null", f, m)<0 ) break;
  30289. }
  30290. if( fd>=0 ){
  30291. if( m!=0 ){
  30292. struct stat statbuf;
  30293. if( osFstat(fd, &statbuf)==0
  30294. && statbuf.st_size==0
  30295. && (statbuf.st_mode&0777)!=m
  30296. ){
  30297. osFchmod(fd, m);
  30298. }
  30299. }
  30300. #if defined(FD_CLOEXEC) && (!defined(O_CLOEXEC) || O_CLOEXEC==0)
  30301. osFcntl(fd, F_SETFD, osFcntl(fd, F_GETFD, 0) | FD_CLOEXEC);
  30302. #endif
  30303. }
  30304. return fd;
  30305. }
  30306. /*
  30307. ** Helper functions to obtain and relinquish the global mutex. The
  30308. ** global mutex is used to protect the unixInodeInfo and
  30309. ** vxworksFileId objects used by this file, all of which may be
  30310. ** shared by multiple threads.
  30311. **
  30312. ** Function unixMutexHeld() is used to assert() that the global mutex
  30313. ** is held when required. This function is only used as part of assert()
  30314. ** statements. e.g.
  30315. **
  30316. ** unixEnterMutex()
  30317. ** assert( unixMutexHeld() );
  30318. ** unixEnterLeave()
  30319. */
  30320. static sqlite3_mutex *unixBigLock = 0;
  30321. static void unixEnterMutex(void){
  30322. sqlite3_mutex_enter(unixBigLock);
  30323. }
  30324. static void unixLeaveMutex(void){
  30325. sqlite3_mutex_leave(unixBigLock);
  30326. }
  30327. #ifdef SQLITE_DEBUG
  30328. static int unixMutexHeld(void) {
  30329. return sqlite3_mutex_held(unixBigLock);
  30330. }
  30331. #endif
  30332. #ifdef SQLITE_HAVE_OS_TRACE
  30333. /*
  30334. ** Helper function for printing out trace information from debugging
  30335. ** binaries. This returns the string representation of the supplied
  30336. ** integer lock-type.
  30337. */
  30338. static const char *azFileLock(int eFileLock){
  30339. switch( eFileLock ){
  30340. case NO_LOCK: return "NONE";
  30341. case SHARED_LOCK: return "SHARED";
  30342. case RESERVED_LOCK: return "RESERVED";
  30343. case PENDING_LOCK: return "PENDING";
  30344. case EXCLUSIVE_LOCK: return "EXCLUSIVE";
  30345. }
  30346. return "ERROR";
  30347. }
  30348. #endif
  30349. #ifdef SQLITE_LOCK_TRACE
  30350. /*
  30351. ** Print out information about all locking operations.
  30352. **
  30353. ** This routine is used for troubleshooting locks on multithreaded
  30354. ** platforms. Enable by compiling with the -DSQLITE_LOCK_TRACE
  30355. ** command-line option on the compiler. This code is normally
  30356. ** turned off.
  30357. */
  30358. static int lockTrace(int fd, int op, struct flock *p){
  30359. char *zOpName, *zType;
  30360. int s;
  30361. int savedErrno;
  30362. if( op==F_GETLK ){
  30363. zOpName = "GETLK";
  30364. }else if( op==F_SETLK ){
  30365. zOpName = "SETLK";
  30366. }else{
  30367. s = osFcntl(fd, op, p);
  30368. sqlite3DebugPrintf("fcntl unknown %d %d %d\n", fd, op, s);
  30369. return s;
  30370. }
  30371. if( p->l_type==F_RDLCK ){
  30372. zType = "RDLCK";
  30373. }else if( p->l_type==F_WRLCK ){
  30374. zType = "WRLCK";
  30375. }else if( p->l_type==F_UNLCK ){
  30376. zType = "UNLCK";
  30377. }else{
  30378. assert( 0 );
  30379. }
  30380. assert( p->l_whence==SEEK_SET );
  30381. s = osFcntl(fd, op, p);
  30382. savedErrno = errno;
  30383. sqlite3DebugPrintf("fcntl %d %d %s %s %d %d %d %d\n",
  30384. threadid, fd, zOpName, zType, (int)p->l_start, (int)p->l_len,
  30385. (int)p->l_pid, s);
  30386. if( s==(-1) && op==F_SETLK && (p->l_type==F_RDLCK || p->l_type==F_WRLCK) ){
  30387. struct flock l2;
  30388. l2 = *p;
  30389. osFcntl(fd, F_GETLK, &l2);
  30390. if( l2.l_type==F_RDLCK ){
  30391. zType = "RDLCK";
  30392. }else if( l2.l_type==F_WRLCK ){
  30393. zType = "WRLCK";
  30394. }else if( l2.l_type==F_UNLCK ){
  30395. zType = "UNLCK";
  30396. }else{
  30397. assert( 0 );
  30398. }
  30399. sqlite3DebugPrintf("fcntl-failure-reason: %s %d %d %d\n",
  30400. zType, (int)l2.l_start, (int)l2.l_len, (int)l2.l_pid);
  30401. }
  30402. errno = savedErrno;
  30403. return s;
  30404. }
  30405. #undef osFcntl
  30406. #define osFcntl lockTrace
  30407. #endif /* SQLITE_LOCK_TRACE */
  30408. /*
  30409. ** Retry ftruncate() calls that fail due to EINTR
  30410. **
  30411. ** All calls to ftruncate() within this file should be made through
  30412. ** this wrapper. On the Android platform, bypassing the logic below
  30413. ** could lead to a corrupt database.
  30414. */
  30415. static int robust_ftruncate(int h, sqlite3_int64 sz){
  30416. int rc;
  30417. #ifdef __ANDROID__
  30418. /* On Android, ftruncate() always uses 32-bit offsets, even if
  30419. ** _FILE_OFFSET_BITS=64 is defined. This means it is unsafe to attempt to
  30420. ** truncate a file to any size larger than 2GiB. Silently ignore any
  30421. ** such attempts. */
  30422. if( sz>(sqlite3_int64)0x7FFFFFFF ){
  30423. rc = SQLITE_OK;
  30424. }else
  30425. #endif
  30426. do{ rc = osFtruncate(h,sz); }while( rc<0 && errno==EINTR );
  30427. return rc;
  30428. }
  30429. /*
  30430. ** This routine translates a standard POSIX errno code into something
  30431. ** useful to the clients of the sqlite3 functions. Specifically, it is
  30432. ** intended to translate a variety of "try again" errors into SQLITE_BUSY
  30433. ** and a variety of "please close the file descriptor NOW" errors into
  30434. ** SQLITE_IOERR
  30435. **
  30436. ** Errors during initialization of locks, or file system support for locks,
  30437. ** should handle ENOLCK, ENOTSUP, EOPNOTSUPP separately.
  30438. */
  30439. static int sqliteErrorFromPosixError(int posixError, int sqliteIOErr) {
  30440. assert( (sqliteIOErr == SQLITE_IOERR_LOCK) ||
  30441. (sqliteIOErr == SQLITE_IOERR_UNLOCK) ||
  30442. (sqliteIOErr == SQLITE_IOERR_RDLOCK) ||
  30443. (sqliteIOErr == SQLITE_IOERR_CHECKRESERVEDLOCK) );
  30444. switch (posixError) {
  30445. case EACCES:
  30446. case EAGAIN:
  30447. case ETIMEDOUT:
  30448. case EBUSY:
  30449. case EINTR:
  30450. case ENOLCK:
  30451. /* random NFS retry error, unless during file system support
  30452. * introspection, in which it actually means what it says */
  30453. return SQLITE_BUSY;
  30454. case EPERM:
  30455. return SQLITE_PERM;
  30456. default:
  30457. return sqliteIOErr;
  30458. }
  30459. }
  30460. /******************************************************************************
  30461. ****************** Begin Unique File ID Utility Used By VxWorks ***************
  30462. **
  30463. ** On most versions of unix, we can get a unique ID for a file by concatenating
  30464. ** the device number and the inode number. But this does not work on VxWorks.
  30465. ** On VxWorks, a unique file id must be based on the canonical filename.
  30466. **
  30467. ** A pointer to an instance of the following structure can be used as a
  30468. ** unique file ID in VxWorks. Each instance of this structure contains
  30469. ** a copy of the canonical filename. There is also a reference count.
  30470. ** The structure is reclaimed when the number of pointers to it drops to
  30471. ** zero.
  30472. **
  30473. ** There are never very many files open at one time and lookups are not
  30474. ** a performance-critical path, so it is sufficient to put these
  30475. ** structures on a linked list.
  30476. */
  30477. struct vxworksFileId {
  30478. struct vxworksFileId *pNext; /* Next in a list of them all */
  30479. int nRef; /* Number of references to this one */
  30480. int nName; /* Length of the zCanonicalName[] string */
  30481. char *zCanonicalName; /* Canonical filename */
  30482. };
  30483. #if OS_VXWORKS
  30484. /*
  30485. ** All unique filenames are held on a linked list headed by this
  30486. ** variable:
  30487. */
  30488. static struct vxworksFileId *vxworksFileList = 0;
  30489. /*
  30490. ** Simplify a filename into its canonical form
  30491. ** by making the following changes:
  30492. **
  30493. ** * removing any trailing and duplicate /
  30494. ** * convert /./ into just /
  30495. ** * convert /A/../ where A is any simple name into just /
  30496. **
  30497. ** Changes are made in-place. Return the new name length.
  30498. **
  30499. ** The original filename is in z[0..n-1]. Return the number of
  30500. ** characters in the simplified name.
  30501. */
  30502. static int vxworksSimplifyName(char *z, int n){
  30503. int i, j;
  30504. while( n>1 && z[n-1]=='/' ){ n--; }
  30505. for(i=j=0; i<n; i++){
  30506. if( z[i]=='/' ){
  30507. if( z[i+1]=='/' ) continue;
  30508. if( z[i+1]=='.' && i+2<n && z[i+2]=='/' ){
  30509. i += 1;
  30510. continue;
  30511. }
  30512. if( z[i+1]=='.' && i+3<n && z[i+2]=='.' && z[i+3]=='/' ){
  30513. while( j>0 && z[j-1]!='/' ){ j--; }
  30514. if( j>0 ){ j--; }
  30515. i += 2;
  30516. continue;
  30517. }
  30518. }
  30519. z[j++] = z[i];
  30520. }
  30521. z[j] = 0;
  30522. return j;
  30523. }
  30524. /*
  30525. ** Find a unique file ID for the given absolute pathname. Return
  30526. ** a pointer to the vxworksFileId object. This pointer is the unique
  30527. ** file ID.
  30528. **
  30529. ** The nRef field of the vxworksFileId object is incremented before
  30530. ** the object is returned. A new vxworksFileId object is created
  30531. ** and added to the global list if necessary.
  30532. **
  30533. ** If a memory allocation error occurs, return NULL.
  30534. */
  30535. static struct vxworksFileId *vxworksFindFileId(const char *zAbsoluteName){
  30536. struct vxworksFileId *pNew; /* search key and new file ID */
  30537. struct vxworksFileId *pCandidate; /* For looping over existing file IDs */
  30538. int n; /* Length of zAbsoluteName string */
  30539. assert( zAbsoluteName[0]=='/' );
  30540. n = (int)strlen(zAbsoluteName);
  30541. pNew = sqlite3_malloc64( sizeof(*pNew) + (n+1) );
  30542. if( pNew==0 ) return 0;
  30543. pNew->zCanonicalName = (char*)&pNew[1];
  30544. memcpy(pNew->zCanonicalName, zAbsoluteName, n+1);
  30545. n = vxworksSimplifyName(pNew->zCanonicalName, n);
  30546. /* Search for an existing entry that matching the canonical name.
  30547. ** If found, increment the reference count and return a pointer to
  30548. ** the existing file ID.
  30549. */
  30550. unixEnterMutex();
  30551. for(pCandidate=vxworksFileList; pCandidate; pCandidate=pCandidate->pNext){
  30552. if( pCandidate->nName==n
  30553. && memcmp(pCandidate->zCanonicalName, pNew->zCanonicalName, n)==0
  30554. ){
  30555. sqlite3_free(pNew);
  30556. pCandidate->nRef++;
  30557. unixLeaveMutex();
  30558. return pCandidate;
  30559. }
  30560. }
  30561. /* No match was found. We will make a new file ID */
  30562. pNew->nRef = 1;
  30563. pNew->nName = n;
  30564. pNew->pNext = vxworksFileList;
  30565. vxworksFileList = pNew;
  30566. unixLeaveMutex();
  30567. return pNew;
  30568. }
  30569. /*
  30570. ** Decrement the reference count on a vxworksFileId object. Free
  30571. ** the object when the reference count reaches zero.
  30572. */
  30573. static void vxworksReleaseFileId(struct vxworksFileId *pId){
  30574. unixEnterMutex();
  30575. assert( pId->nRef>0 );
  30576. pId->nRef--;
  30577. if( pId->nRef==0 ){
  30578. struct vxworksFileId **pp;
  30579. for(pp=&vxworksFileList; *pp && *pp!=pId; pp = &((*pp)->pNext)){}
  30580. assert( *pp==pId );
  30581. *pp = pId->pNext;
  30582. sqlite3_free(pId);
  30583. }
  30584. unixLeaveMutex();
  30585. }
  30586. #endif /* OS_VXWORKS */
  30587. /*************** End of Unique File ID Utility Used By VxWorks ****************
  30588. ******************************************************************************/
  30589. /******************************************************************************
  30590. *************************** Posix Advisory Locking ****************************
  30591. **
  30592. ** POSIX advisory locks are broken by design. ANSI STD 1003.1 (1996)
  30593. ** section 6.5.2.2 lines 483 through 490 specify that when a process
  30594. ** sets or clears a lock, that operation overrides any prior locks set
  30595. ** by the same process. It does not explicitly say so, but this implies
  30596. ** that it overrides locks set by the same process using a different
  30597. ** file descriptor. Consider this test case:
  30598. **
  30599. ** int fd1 = open("./file1", O_RDWR|O_CREAT, 0644);
  30600. ** int fd2 = open("./file2", O_RDWR|O_CREAT, 0644);
  30601. **
  30602. ** Suppose ./file1 and ./file2 are really the same file (because
  30603. ** one is a hard or symbolic link to the other) then if you set
  30604. ** an exclusive lock on fd1, then try to get an exclusive lock
  30605. ** on fd2, it works. I would have expected the second lock to
  30606. ** fail since there was already a lock on the file due to fd1.
  30607. ** But not so. Since both locks came from the same process, the
  30608. ** second overrides the first, even though they were on different
  30609. ** file descriptors opened on different file names.
  30610. **
  30611. ** This means that we cannot use POSIX locks to synchronize file access
  30612. ** among competing threads of the same process. POSIX locks will work fine
  30613. ** to synchronize access for threads in separate processes, but not
  30614. ** threads within the same process.
  30615. **
  30616. ** To work around the problem, SQLite has to manage file locks internally
  30617. ** on its own. Whenever a new database is opened, we have to find the
  30618. ** specific inode of the database file (the inode is determined by the
  30619. ** st_dev and st_ino fields of the stat structure that fstat() fills in)
  30620. ** and check for locks already existing on that inode. When locks are
  30621. ** created or removed, we have to look at our own internal record of the
  30622. ** locks to see if another thread has previously set a lock on that same
  30623. ** inode.
  30624. **
  30625. ** (Aside: The use of inode numbers as unique IDs does not work on VxWorks.
  30626. ** For VxWorks, we have to use the alternative unique ID system based on
  30627. ** canonical filename and implemented in the previous division.)
  30628. **
  30629. ** The sqlite3_file structure for POSIX is no longer just an integer file
  30630. ** descriptor. It is now a structure that holds the integer file
  30631. ** descriptor and a pointer to a structure that describes the internal
  30632. ** locks on the corresponding inode. There is one locking structure
  30633. ** per inode, so if the same inode is opened twice, both unixFile structures
  30634. ** point to the same locking structure. The locking structure keeps
  30635. ** a reference count (so we will know when to delete it) and a "cnt"
  30636. ** field that tells us its internal lock status. cnt==0 means the
  30637. ** file is unlocked. cnt==-1 means the file has an exclusive lock.
  30638. ** cnt>0 means there are cnt shared locks on the file.
  30639. **
  30640. ** Any attempt to lock or unlock a file first checks the locking
  30641. ** structure. The fcntl() system call is only invoked to set a
  30642. ** POSIX lock if the internal lock structure transitions between
  30643. ** a locked and an unlocked state.
  30644. **
  30645. ** But wait: there are yet more problems with POSIX advisory locks.
  30646. **
  30647. ** If you close a file descriptor that points to a file that has locks,
  30648. ** all locks on that file that are owned by the current process are
  30649. ** released. To work around this problem, each unixInodeInfo object
  30650. ** maintains a count of the number of pending locks on tha inode.
  30651. ** When an attempt is made to close an unixFile, if there are
  30652. ** other unixFile open on the same inode that are holding locks, the call
  30653. ** to close() the file descriptor is deferred until all of the locks clear.
  30654. ** The unixInodeInfo structure keeps a list of file descriptors that need to
  30655. ** be closed and that list is walked (and cleared) when the last lock
  30656. ** clears.
  30657. **
  30658. ** Yet another problem: LinuxThreads do not play well with posix locks.
  30659. **
  30660. ** Many older versions of linux use the LinuxThreads library which is
  30661. ** not posix compliant. Under LinuxThreads, a lock created by thread
  30662. ** A cannot be modified or overridden by a different thread B.
  30663. ** Only thread A can modify the lock. Locking behavior is correct
  30664. ** if the appliation uses the newer Native Posix Thread Library (NPTL)
  30665. ** on linux - with NPTL a lock created by thread A can override locks
  30666. ** in thread B. But there is no way to know at compile-time which
  30667. ** threading library is being used. So there is no way to know at
  30668. ** compile-time whether or not thread A can override locks on thread B.
  30669. ** One has to do a run-time check to discover the behavior of the
  30670. ** current process.
  30671. **
  30672. ** SQLite used to support LinuxThreads. But support for LinuxThreads
  30673. ** was dropped beginning with version 3.7.0. SQLite will still work with
  30674. ** LinuxThreads provided that (1) there is no more than one connection
  30675. ** per database file in the same process and (2) database connections
  30676. ** do not move across threads.
  30677. */
  30678. /*
  30679. ** An instance of the following structure serves as the key used
  30680. ** to locate a particular unixInodeInfo object.
  30681. */
  30682. struct unixFileId {
  30683. dev_t dev; /* Device number */
  30684. #if OS_VXWORKS
  30685. struct vxworksFileId *pId; /* Unique file ID for vxworks. */
  30686. #else
  30687. /* We are told that some versions of Android contain a bug that
  30688. ** sizes ino_t at only 32-bits instead of 64-bits. (See
  30689. ** https://android-review.googlesource.com/#/c/115351/3/dist/sqlite3.c)
  30690. ** To work around this, always allocate 64-bits for the inode number.
  30691. ** On small machines that only have 32-bit inodes, this wastes 4 bytes,
  30692. ** but that should not be a big deal. */
  30693. /* WAS: ino_t ino; */
  30694. u64 ino; /* Inode number */
  30695. #endif
  30696. };
  30697. /*
  30698. ** An instance of the following structure is allocated for each open
  30699. ** inode. Or, on LinuxThreads, there is one of these structures for
  30700. ** each inode opened by each thread.
  30701. **
  30702. ** A single inode can have multiple file descriptors, so each unixFile
  30703. ** structure contains a pointer to an instance of this object and this
  30704. ** object keeps a count of the number of unixFile pointing to it.
  30705. */
  30706. struct unixInodeInfo {
  30707. struct unixFileId fileId; /* The lookup key */
  30708. int nShared; /* Number of SHARED locks held */
  30709. unsigned char eFileLock; /* One of SHARED_LOCK, RESERVED_LOCK etc. */
  30710. unsigned char bProcessLock; /* An exclusive process lock is held */
  30711. int nRef; /* Number of pointers to this structure */
  30712. unixShmNode *pShmNode; /* Shared memory associated with this inode */
  30713. int nLock; /* Number of outstanding file locks */
  30714. UnixUnusedFd *pUnused; /* Unused file descriptors to close */
  30715. unixInodeInfo *pNext; /* List of all unixInodeInfo objects */
  30716. unixInodeInfo *pPrev; /* .... doubly linked */
  30717. #if SQLITE_ENABLE_LOCKING_STYLE
  30718. unsigned long long sharedByte; /* for AFP simulated shared lock */
  30719. #endif
  30720. #if OS_VXWORKS
  30721. sem_t *pSem; /* Named POSIX semaphore */
  30722. char aSemName[MAX_PATHNAME+2]; /* Name of that semaphore */
  30723. #endif
  30724. };
  30725. /*
  30726. ** A lists of all unixInodeInfo objects.
  30727. */
  30728. static unixInodeInfo *inodeList = 0; /* All unixInodeInfo objects */
  30729. static unsigned int nUnusedFd = 0; /* Total unused file descriptors */
  30730. /*
  30731. **
  30732. ** This function - unixLogErrorAtLine(), is only ever called via the macro
  30733. ** unixLogError().
  30734. **
  30735. ** It is invoked after an error occurs in an OS function and errno has been
  30736. ** set. It logs a message using sqlite3_log() containing the current value of
  30737. ** errno and, if possible, the human-readable equivalent from strerror() or
  30738. ** strerror_r().
  30739. **
  30740. ** The first argument passed to the macro should be the error code that
  30741. ** will be returned to SQLite (e.g. SQLITE_IOERR_DELETE, SQLITE_CANTOPEN).
  30742. ** The two subsequent arguments should be the name of the OS function that
  30743. ** failed (e.g. "unlink", "open") and the associated file-system path,
  30744. ** if any.
  30745. */
  30746. #define unixLogError(a,b,c) unixLogErrorAtLine(a,b,c,__LINE__)
  30747. static int unixLogErrorAtLine(
  30748. int errcode, /* SQLite error code */
  30749. const char *zFunc, /* Name of OS function that failed */
  30750. const char *zPath, /* File path associated with error */
  30751. int iLine /* Source line number where error occurred */
  30752. ){
  30753. char *zErr; /* Message from strerror() or equivalent */
  30754. int iErrno = errno; /* Saved syscall error number */
  30755. /* If this is not a threadsafe build (SQLITE_THREADSAFE==0), then use
  30756. ** the strerror() function to obtain the human-readable error message
  30757. ** equivalent to errno. Otherwise, use strerror_r().
  30758. */
  30759. #if SQLITE_THREADSAFE && defined(HAVE_STRERROR_R)
  30760. char aErr[80];
  30761. memset(aErr, 0, sizeof(aErr));
  30762. zErr = aErr;
  30763. /* If STRERROR_R_CHAR_P (set by autoconf scripts) or __USE_GNU is defined,
  30764. ** assume that the system provides the GNU version of strerror_r() that
  30765. ** returns a pointer to a buffer containing the error message. That pointer
  30766. ** may point to aErr[], or it may point to some static storage somewhere.
  30767. ** Otherwise, assume that the system provides the POSIX version of
  30768. ** strerror_r(), which always writes an error message into aErr[].
  30769. **
  30770. ** If the code incorrectly assumes that it is the POSIX version that is
  30771. ** available, the error message will often be an empty string. Not a
  30772. ** huge problem. Incorrectly concluding that the GNU version is available
  30773. ** could lead to a segfault though.
  30774. */
  30775. #if defined(STRERROR_R_CHAR_P) || defined(__USE_GNU)
  30776. zErr =
  30777. # endif
  30778. strerror_r(iErrno, aErr, sizeof(aErr)-1);
  30779. #elif SQLITE_THREADSAFE
  30780. /* This is a threadsafe build, but strerror_r() is not available. */
  30781. zErr = "";
  30782. #else
  30783. /* Non-threadsafe build, use strerror(). */
  30784. zErr = strerror(iErrno);
  30785. #endif
  30786. if( zPath==0 ) zPath = "";
  30787. sqlite3_log(errcode,
  30788. "os_unix.c:%d: (%d) %s(%s) - %s",
  30789. iLine, iErrno, zFunc, zPath, zErr
  30790. );
  30791. return errcode;
  30792. }
  30793. /*
  30794. ** Close a file descriptor.
  30795. **
  30796. ** We assume that close() almost always works, since it is only in a
  30797. ** very sick application or on a very sick platform that it might fail.
  30798. ** If it does fail, simply leak the file descriptor, but do log the
  30799. ** error.
  30800. **
  30801. ** Note that it is not safe to retry close() after EINTR since the
  30802. ** file descriptor might have already been reused by another thread.
  30803. ** So we don't even try to recover from an EINTR. Just log the error
  30804. ** and move on.
  30805. */
  30806. static void robust_close(unixFile *pFile, int h, int lineno){
  30807. if( osClose(h) ){
  30808. unixLogErrorAtLine(SQLITE_IOERR_CLOSE, "close",
  30809. pFile ? pFile->zPath : 0, lineno);
  30810. }
  30811. }
  30812. /*
  30813. ** Set the pFile->lastErrno. Do this in a subroutine as that provides
  30814. ** a convenient place to set a breakpoint.
  30815. */
  30816. static void storeLastErrno(unixFile *pFile, int error){
  30817. pFile->lastErrno = error;
  30818. }
  30819. /*
  30820. ** Close all file descriptors accumuated in the unixInodeInfo->pUnused list.
  30821. */
  30822. static void closePendingFds(unixFile *pFile){
  30823. unixInodeInfo *pInode = pFile->pInode;
  30824. UnixUnusedFd *p;
  30825. UnixUnusedFd *pNext;
  30826. for(p=pInode->pUnused; p; p=pNext){
  30827. pNext = p->pNext;
  30828. robust_close(pFile, p->fd, __LINE__);
  30829. sqlite3_free(p);
  30830. nUnusedFd--;
  30831. }
  30832. pInode->pUnused = 0;
  30833. }
  30834. /*
  30835. ** Release a unixInodeInfo structure previously allocated by findInodeInfo().
  30836. **
  30837. ** The mutex entered using the unixEnterMutex() function must be held
  30838. ** when this function is called.
  30839. */
  30840. static void releaseInodeInfo(unixFile *pFile){
  30841. unixInodeInfo *pInode = pFile->pInode;
  30842. assert( unixMutexHeld() );
  30843. if( ALWAYS(pInode) ){
  30844. pInode->nRef--;
  30845. if( pInode->nRef==0 ){
  30846. assert( pInode->pShmNode==0 );
  30847. closePendingFds(pFile);
  30848. if( pInode->pPrev ){
  30849. assert( pInode->pPrev->pNext==pInode );
  30850. pInode->pPrev->pNext = pInode->pNext;
  30851. }else{
  30852. assert( inodeList==pInode );
  30853. inodeList = pInode->pNext;
  30854. }
  30855. if( pInode->pNext ){
  30856. assert( pInode->pNext->pPrev==pInode );
  30857. pInode->pNext->pPrev = pInode->pPrev;
  30858. }
  30859. sqlite3_free(pInode);
  30860. }
  30861. }
  30862. assert( inodeList!=0 || nUnusedFd==0 );
  30863. }
  30864. /*
  30865. ** Given a file descriptor, locate the unixInodeInfo object that
  30866. ** describes that file descriptor. Create a new one if necessary. The
  30867. ** return value might be uninitialized if an error occurs.
  30868. **
  30869. ** The mutex entered using the unixEnterMutex() function must be held
  30870. ** when this function is called.
  30871. **
  30872. ** Return an appropriate error code.
  30873. */
  30874. static int findInodeInfo(
  30875. unixFile *pFile, /* Unix file with file desc used in the key */
  30876. unixInodeInfo **ppInode /* Return the unixInodeInfo object here */
  30877. ){
  30878. int rc; /* System call return code */
  30879. int fd; /* The file descriptor for pFile */
  30880. struct unixFileId fileId; /* Lookup key for the unixInodeInfo */
  30881. struct stat statbuf; /* Low-level file information */
  30882. unixInodeInfo *pInode = 0; /* Candidate unixInodeInfo object */
  30883. assert( unixMutexHeld() );
  30884. /* Get low-level information about the file that we can used to
  30885. ** create a unique name for the file.
  30886. */
  30887. fd = pFile->h;
  30888. rc = osFstat(fd, &statbuf);
  30889. if( rc!=0 ){
  30890. storeLastErrno(pFile, errno);
  30891. #if defined(EOVERFLOW) && defined(SQLITE_DISABLE_LFS)
  30892. if( pFile->lastErrno==EOVERFLOW ) return SQLITE_NOLFS;
  30893. #endif
  30894. return SQLITE_IOERR;
  30895. }
  30896. #ifdef __APPLE__
  30897. /* On OS X on an msdos filesystem, the inode number is reported
  30898. ** incorrectly for zero-size files. See ticket #3260. To work
  30899. ** around this problem (we consider it a bug in OS X, not SQLite)
  30900. ** we always increase the file size to 1 by writing a single byte
  30901. ** prior to accessing the inode number. The one byte written is
  30902. ** an ASCII 'S' character which also happens to be the first byte
  30903. ** in the header of every SQLite database. In this way, if there
  30904. ** is a race condition such that another thread has already populated
  30905. ** the first page of the database, no damage is done.
  30906. */
  30907. if( statbuf.st_size==0 && (pFile->fsFlags & SQLITE_FSFLAGS_IS_MSDOS)!=0 ){
  30908. do{ rc = osWrite(fd, "S", 1); }while( rc<0 && errno==EINTR );
  30909. if( rc!=1 ){
  30910. storeLastErrno(pFile, errno);
  30911. return SQLITE_IOERR;
  30912. }
  30913. rc = osFstat(fd, &statbuf);
  30914. if( rc!=0 ){
  30915. storeLastErrno(pFile, errno);
  30916. return SQLITE_IOERR;
  30917. }
  30918. }
  30919. #endif
  30920. memset(&fileId, 0, sizeof(fileId));
  30921. fileId.dev = statbuf.st_dev;
  30922. #if OS_VXWORKS
  30923. fileId.pId = pFile->pId;
  30924. #else
  30925. fileId.ino = (u64)statbuf.st_ino;
  30926. #endif
  30927. assert( inodeList!=0 || nUnusedFd==0 );
  30928. pInode = inodeList;
  30929. while( pInode && memcmp(&fileId, &pInode->fileId, sizeof(fileId)) ){
  30930. pInode = pInode->pNext;
  30931. }
  30932. if( pInode==0 ){
  30933. pInode = sqlite3_malloc64( sizeof(*pInode) );
  30934. if( pInode==0 ){
  30935. return SQLITE_NOMEM_BKPT;
  30936. }
  30937. memset(pInode, 0, sizeof(*pInode));
  30938. memcpy(&pInode->fileId, &fileId, sizeof(fileId));
  30939. pInode->nRef = 1;
  30940. pInode->pNext = inodeList;
  30941. pInode->pPrev = 0;
  30942. if( inodeList ) inodeList->pPrev = pInode;
  30943. inodeList = pInode;
  30944. }else{
  30945. pInode->nRef++;
  30946. }
  30947. *ppInode = pInode;
  30948. return SQLITE_OK;
  30949. }
  30950. /*
  30951. ** Return TRUE if pFile has been renamed or unlinked since it was first opened.
  30952. */
  30953. static int fileHasMoved(unixFile *pFile){
  30954. #if OS_VXWORKS
  30955. return pFile->pInode!=0 && pFile->pId!=pFile->pInode->fileId.pId;
  30956. #else
  30957. struct stat buf;
  30958. return pFile->pInode!=0 &&
  30959. (osStat(pFile->zPath, &buf)!=0
  30960. || (u64)buf.st_ino!=pFile->pInode->fileId.ino);
  30961. #endif
  30962. }
  30963. /*
  30964. ** Check a unixFile that is a database. Verify the following:
  30965. **
  30966. ** (1) There is exactly one hard link on the file
  30967. ** (2) The file is not a symbolic link
  30968. ** (3) The file has not been renamed or unlinked
  30969. **
  30970. ** Issue sqlite3_log(SQLITE_WARNING,...) messages if anything is not right.
  30971. */
  30972. static void verifyDbFile(unixFile *pFile){
  30973. struct stat buf;
  30974. int rc;
  30975. /* These verifications occurs for the main database only */
  30976. if( pFile->ctrlFlags & UNIXFILE_NOLOCK ) return;
  30977. rc = osFstat(pFile->h, &buf);
  30978. if( rc!=0 ){
  30979. sqlite3_log(SQLITE_WARNING, "cannot fstat db file %s", pFile->zPath);
  30980. return;
  30981. }
  30982. if( buf.st_nlink==0 ){
  30983. sqlite3_log(SQLITE_WARNING, "file unlinked while open: %s", pFile->zPath);
  30984. return;
  30985. }
  30986. if( buf.st_nlink>1 ){
  30987. sqlite3_log(SQLITE_WARNING, "multiple links to file: %s", pFile->zPath);
  30988. return;
  30989. }
  30990. if( fileHasMoved(pFile) ){
  30991. sqlite3_log(SQLITE_WARNING, "file renamed while open: %s", pFile->zPath);
  30992. return;
  30993. }
  30994. }
  30995. /*
  30996. ** This routine checks if there is a RESERVED lock held on the specified
  30997. ** file by this or any other process. If such a lock is held, set *pResOut
  30998. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  30999. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  31000. */
  31001. static int unixCheckReservedLock(sqlite3_file *id, int *pResOut){
  31002. int rc = SQLITE_OK;
  31003. int reserved = 0;
  31004. unixFile *pFile = (unixFile*)id;
  31005. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  31006. assert( pFile );
  31007. assert( pFile->eFileLock<=SHARED_LOCK );
  31008. unixEnterMutex(); /* Because pFile->pInode is shared across threads */
  31009. /* Check if a thread in this process holds such a lock */
  31010. if( pFile->pInode->eFileLock>SHARED_LOCK ){
  31011. reserved = 1;
  31012. }
  31013. /* Otherwise see if some other process holds it.
  31014. */
  31015. #ifndef __DJGPP__
  31016. if( !reserved && !pFile->pInode->bProcessLock ){
  31017. struct flock lock;
  31018. lock.l_whence = SEEK_SET;
  31019. lock.l_start = RESERVED_BYTE;
  31020. lock.l_len = 1;
  31021. lock.l_type = F_WRLCK;
  31022. if( osFcntl(pFile->h, F_GETLK, &lock) ){
  31023. rc = SQLITE_IOERR_CHECKRESERVEDLOCK;
  31024. storeLastErrno(pFile, errno);
  31025. } else if( lock.l_type!=F_UNLCK ){
  31026. reserved = 1;
  31027. }
  31028. }
  31029. #endif
  31030. unixLeaveMutex();
  31031. OSTRACE(("TEST WR-LOCK %d %d %d (unix)\n", pFile->h, rc, reserved));
  31032. *pResOut = reserved;
  31033. return rc;
  31034. }
  31035. /*
  31036. ** Set a posix-advisory-lock.
  31037. **
  31038. ** There are two versions of this routine. If compiled with
  31039. ** SQLITE_ENABLE_SETLK_TIMEOUT then the routine has an extra parameter
  31040. ** which is a pointer to a unixFile. If the unixFile->iBusyTimeout
  31041. ** value is set, then it is the number of milliseconds to wait before
  31042. ** failing the lock. The iBusyTimeout value is always reset back to
  31043. ** zero on each call.
  31044. **
  31045. ** If SQLITE_ENABLE_SETLK_TIMEOUT is not defined, then do a non-blocking
  31046. ** attempt to set the lock.
  31047. */
  31048. #ifndef SQLITE_ENABLE_SETLK_TIMEOUT
  31049. # define osSetPosixAdvisoryLock(h,x,t) osFcntl(h,F_SETLK,x)
  31050. #else
  31051. static int osSetPosixAdvisoryLock(
  31052. int h, /* The file descriptor on which to take the lock */
  31053. struct flock *pLock, /* The description of the lock */
  31054. unixFile *pFile /* Structure holding timeout value */
  31055. ){
  31056. int rc = osFcntl(h,F_SETLK,pLock);
  31057. while( rc<0 && pFile->iBusyTimeout>0 ){
  31058. /* On systems that support some kind of blocking file lock with a timeout,
  31059. ** make appropriate changes here to invoke that blocking file lock. On
  31060. ** generic posix, however, there is no such API. So we simply try the
  31061. ** lock once every millisecond until either the timeout expires, or until
  31062. ** the lock is obtained. */
  31063. usleep(1000);
  31064. rc = osFcntl(h,F_SETLK,pLock);
  31065. pFile->iBusyTimeout--;
  31066. }
  31067. return rc;
  31068. }
  31069. #endif /* SQLITE_ENABLE_SETLK_TIMEOUT */
  31070. /*
  31071. ** Attempt to set a system-lock on the file pFile. The lock is
  31072. ** described by pLock.
  31073. **
  31074. ** If the pFile was opened read/write from unix-excl, then the only lock
  31075. ** ever obtained is an exclusive lock, and it is obtained exactly once
  31076. ** the first time any lock is attempted. All subsequent system locking
  31077. ** operations become no-ops. Locking operations still happen internally,
  31078. ** in order to coordinate access between separate database connections
  31079. ** within this process, but all of that is handled in memory and the
  31080. ** operating system does not participate.
  31081. **
  31082. ** This function is a pass-through to fcntl(F_SETLK) if pFile is using
  31083. ** any VFS other than "unix-excl" or if pFile is opened on "unix-excl"
  31084. ** and is read-only.
  31085. **
  31086. ** Zero is returned if the call completes successfully, or -1 if a call
  31087. ** to fcntl() fails. In this case, errno is set appropriately (by fcntl()).
  31088. */
  31089. static int unixFileLock(unixFile *pFile, struct flock *pLock){
  31090. int rc;
  31091. unixInodeInfo *pInode = pFile->pInode;
  31092. assert( unixMutexHeld() );
  31093. assert( pInode!=0 );
  31094. if( (pFile->ctrlFlags & (UNIXFILE_EXCL|UNIXFILE_RDONLY))==UNIXFILE_EXCL ){
  31095. if( pInode->bProcessLock==0 ){
  31096. struct flock lock;
  31097. assert( pInode->nLock==0 );
  31098. lock.l_whence = SEEK_SET;
  31099. lock.l_start = SHARED_FIRST;
  31100. lock.l_len = SHARED_SIZE;
  31101. lock.l_type = F_WRLCK;
  31102. rc = osSetPosixAdvisoryLock(pFile->h, &lock, pFile);
  31103. if( rc<0 ) return rc;
  31104. pInode->bProcessLock = 1;
  31105. pInode->nLock++;
  31106. }else{
  31107. rc = 0;
  31108. }
  31109. }else{
  31110. rc = osSetPosixAdvisoryLock(pFile->h, pLock, pFile);
  31111. }
  31112. return rc;
  31113. }
  31114. /*
  31115. ** Lock the file with the lock specified by parameter eFileLock - one
  31116. ** of the following:
  31117. **
  31118. ** (1) SHARED_LOCK
  31119. ** (2) RESERVED_LOCK
  31120. ** (3) PENDING_LOCK
  31121. ** (4) EXCLUSIVE_LOCK
  31122. **
  31123. ** Sometimes when requesting one lock state, additional lock states
  31124. ** are inserted in between. The locking might fail on one of the later
  31125. ** transitions leaving the lock state different from what it started but
  31126. ** still short of its goal. The following chart shows the allowed
  31127. ** transitions and the inserted intermediate states:
  31128. **
  31129. ** UNLOCKED -> SHARED
  31130. ** SHARED -> RESERVED
  31131. ** SHARED -> (PENDING) -> EXCLUSIVE
  31132. ** RESERVED -> (PENDING) -> EXCLUSIVE
  31133. ** PENDING -> EXCLUSIVE
  31134. **
  31135. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  31136. ** routine to lower a locking level.
  31137. */
  31138. static int unixLock(sqlite3_file *id, int eFileLock){
  31139. /* The following describes the implementation of the various locks and
  31140. ** lock transitions in terms of the POSIX advisory shared and exclusive
  31141. ** lock primitives (called read-locks and write-locks below, to avoid
  31142. ** confusion with SQLite lock names). The algorithms are complicated
  31143. ** slightly in order to be compatible with Windows95 systems simultaneously
  31144. ** accessing the same database file, in case that is ever required.
  31145. **
  31146. ** Symbols defined in os.h indentify the 'pending byte' and the 'reserved
  31147. ** byte', each single bytes at well known offsets, and the 'shared byte
  31148. ** range', a range of 510 bytes at a well known offset.
  31149. **
  31150. ** To obtain a SHARED lock, a read-lock is obtained on the 'pending
  31151. ** byte'. If this is successful, 'shared byte range' is read-locked
  31152. ** and the lock on the 'pending byte' released. (Legacy note: When
  31153. ** SQLite was first developed, Windows95 systems were still very common,
  31154. ** and Widnows95 lacks a shared-lock capability. So on Windows95, a
  31155. ** single randomly selected by from the 'shared byte range' is locked.
  31156. ** Windows95 is now pretty much extinct, but this work-around for the
  31157. ** lack of shared-locks on Windows95 lives on, for backwards
  31158. ** compatibility.)
  31159. **
  31160. ** A process may only obtain a RESERVED lock after it has a SHARED lock.
  31161. ** A RESERVED lock is implemented by grabbing a write-lock on the
  31162. ** 'reserved byte'.
  31163. **
  31164. ** A process may only obtain a PENDING lock after it has obtained a
  31165. ** SHARED lock. A PENDING lock is implemented by obtaining a write-lock
  31166. ** on the 'pending byte'. This ensures that no new SHARED locks can be
  31167. ** obtained, but existing SHARED locks are allowed to persist. A process
  31168. ** does not have to obtain a RESERVED lock on the way to a PENDING lock.
  31169. ** This property is used by the algorithm for rolling back a journal file
  31170. ** after a crash.
  31171. **
  31172. ** An EXCLUSIVE lock, obtained after a PENDING lock is held, is
  31173. ** implemented by obtaining a write-lock on the entire 'shared byte
  31174. ** range'. Since all other locks require a read-lock on one of the bytes
  31175. ** within this range, this ensures that no other locks are held on the
  31176. ** database.
  31177. */
  31178. int rc = SQLITE_OK;
  31179. unixFile *pFile = (unixFile*)id;
  31180. unixInodeInfo *pInode;
  31181. struct flock lock;
  31182. int tErrno = 0;
  31183. assert( pFile );
  31184. OSTRACE(("LOCK %d %s was %s(%s,%d) pid=%d (unix)\n", pFile->h,
  31185. azFileLock(eFileLock), azFileLock(pFile->eFileLock),
  31186. azFileLock(pFile->pInode->eFileLock), pFile->pInode->nShared,
  31187. osGetpid(0)));
  31188. /* If there is already a lock of this type or more restrictive on the
  31189. ** unixFile, do nothing. Don't use the end_lock: exit path, as
  31190. ** unixEnterMutex() hasn't been called yet.
  31191. */
  31192. if( pFile->eFileLock>=eFileLock ){
  31193. OSTRACE(("LOCK %d %s ok (already held) (unix)\n", pFile->h,
  31194. azFileLock(eFileLock)));
  31195. return SQLITE_OK;
  31196. }
  31197. /* Make sure the locking sequence is correct.
  31198. ** (1) We never move from unlocked to anything higher than shared lock.
  31199. ** (2) SQLite never explicitly requests a pendig lock.
  31200. ** (3) A shared lock is always held when a reserve lock is requested.
  31201. */
  31202. assert( pFile->eFileLock!=NO_LOCK || eFileLock==SHARED_LOCK );
  31203. assert( eFileLock!=PENDING_LOCK );
  31204. assert( eFileLock!=RESERVED_LOCK || pFile->eFileLock==SHARED_LOCK );
  31205. /* This mutex is needed because pFile->pInode is shared across threads
  31206. */
  31207. unixEnterMutex();
  31208. pInode = pFile->pInode;
  31209. /* If some thread using this PID has a lock via a different unixFile*
  31210. ** handle that precludes the requested lock, return BUSY.
  31211. */
  31212. if( (pFile->eFileLock!=pInode->eFileLock &&
  31213. (pInode->eFileLock>=PENDING_LOCK || eFileLock>SHARED_LOCK))
  31214. ){
  31215. rc = SQLITE_BUSY;
  31216. goto end_lock;
  31217. }
  31218. /* If a SHARED lock is requested, and some thread using this PID already
  31219. ** has a SHARED or RESERVED lock, then increment reference counts and
  31220. ** return SQLITE_OK.
  31221. */
  31222. if( eFileLock==SHARED_LOCK &&
  31223. (pInode->eFileLock==SHARED_LOCK || pInode->eFileLock==RESERVED_LOCK) ){
  31224. assert( eFileLock==SHARED_LOCK );
  31225. assert( pFile->eFileLock==0 );
  31226. assert( pInode->nShared>0 );
  31227. pFile->eFileLock = SHARED_LOCK;
  31228. pInode->nShared++;
  31229. pInode->nLock++;
  31230. goto end_lock;
  31231. }
  31232. /* A PENDING lock is needed before acquiring a SHARED lock and before
  31233. ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
  31234. ** be released.
  31235. */
  31236. lock.l_len = 1L;
  31237. lock.l_whence = SEEK_SET;
  31238. if( eFileLock==SHARED_LOCK
  31239. || (eFileLock==EXCLUSIVE_LOCK && pFile->eFileLock<PENDING_LOCK)
  31240. ){
  31241. lock.l_type = (eFileLock==SHARED_LOCK?F_RDLCK:F_WRLCK);
  31242. lock.l_start = PENDING_BYTE;
  31243. if( unixFileLock(pFile, &lock) ){
  31244. tErrno = errno;
  31245. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  31246. if( rc!=SQLITE_BUSY ){
  31247. storeLastErrno(pFile, tErrno);
  31248. }
  31249. goto end_lock;
  31250. }
  31251. }
  31252. /* If control gets to this point, then actually go ahead and make
  31253. ** operating system calls for the specified lock.
  31254. */
  31255. if( eFileLock==SHARED_LOCK ){
  31256. assert( pInode->nShared==0 );
  31257. assert( pInode->eFileLock==0 );
  31258. assert( rc==SQLITE_OK );
  31259. /* Now get the read-lock */
  31260. lock.l_start = SHARED_FIRST;
  31261. lock.l_len = SHARED_SIZE;
  31262. if( unixFileLock(pFile, &lock) ){
  31263. tErrno = errno;
  31264. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  31265. }
  31266. /* Drop the temporary PENDING lock */
  31267. lock.l_start = PENDING_BYTE;
  31268. lock.l_len = 1L;
  31269. lock.l_type = F_UNLCK;
  31270. if( unixFileLock(pFile, &lock) && rc==SQLITE_OK ){
  31271. /* This could happen with a network mount */
  31272. tErrno = errno;
  31273. rc = SQLITE_IOERR_UNLOCK;
  31274. }
  31275. if( rc ){
  31276. if( rc!=SQLITE_BUSY ){
  31277. storeLastErrno(pFile, tErrno);
  31278. }
  31279. goto end_lock;
  31280. }else{
  31281. pFile->eFileLock = SHARED_LOCK;
  31282. pInode->nLock++;
  31283. pInode->nShared = 1;
  31284. }
  31285. }else if( eFileLock==EXCLUSIVE_LOCK && pInode->nShared>1 ){
  31286. /* We are trying for an exclusive lock but another thread in this
  31287. ** same process is still holding a shared lock. */
  31288. rc = SQLITE_BUSY;
  31289. }else{
  31290. /* The request was for a RESERVED or EXCLUSIVE lock. It is
  31291. ** assumed that there is a SHARED or greater lock on the file
  31292. ** already.
  31293. */
  31294. assert( 0!=pFile->eFileLock );
  31295. lock.l_type = F_WRLCK;
  31296. assert( eFileLock==RESERVED_LOCK || eFileLock==EXCLUSIVE_LOCK );
  31297. if( eFileLock==RESERVED_LOCK ){
  31298. lock.l_start = RESERVED_BYTE;
  31299. lock.l_len = 1L;
  31300. }else{
  31301. lock.l_start = SHARED_FIRST;
  31302. lock.l_len = SHARED_SIZE;
  31303. }
  31304. if( unixFileLock(pFile, &lock) ){
  31305. tErrno = errno;
  31306. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  31307. if( rc!=SQLITE_BUSY ){
  31308. storeLastErrno(pFile, tErrno);
  31309. }
  31310. }
  31311. }
  31312. #ifdef SQLITE_DEBUG
  31313. /* Set up the transaction-counter change checking flags when
  31314. ** transitioning from a SHARED to a RESERVED lock. The change
  31315. ** from SHARED to RESERVED marks the beginning of a normal
  31316. ** write operation (not a hot journal rollback).
  31317. */
  31318. if( rc==SQLITE_OK
  31319. && pFile->eFileLock<=SHARED_LOCK
  31320. && eFileLock==RESERVED_LOCK
  31321. ){
  31322. pFile->transCntrChng = 0;
  31323. pFile->dbUpdate = 0;
  31324. pFile->inNormalWrite = 1;
  31325. }
  31326. #endif
  31327. if( rc==SQLITE_OK ){
  31328. pFile->eFileLock = eFileLock;
  31329. pInode->eFileLock = eFileLock;
  31330. }else if( eFileLock==EXCLUSIVE_LOCK ){
  31331. pFile->eFileLock = PENDING_LOCK;
  31332. pInode->eFileLock = PENDING_LOCK;
  31333. }
  31334. end_lock:
  31335. unixLeaveMutex();
  31336. OSTRACE(("LOCK %d %s %s (unix)\n", pFile->h, azFileLock(eFileLock),
  31337. rc==SQLITE_OK ? "ok" : "failed"));
  31338. return rc;
  31339. }
  31340. /*
  31341. ** Add the file descriptor used by file handle pFile to the corresponding
  31342. ** pUnused list.
  31343. */
  31344. static void setPendingFd(unixFile *pFile){
  31345. unixInodeInfo *pInode = pFile->pInode;
  31346. UnixUnusedFd *p = pFile->pPreallocatedUnused;
  31347. p->pNext = pInode->pUnused;
  31348. pInode->pUnused = p;
  31349. pFile->h = -1;
  31350. pFile->pPreallocatedUnused = 0;
  31351. nUnusedFd++;
  31352. }
  31353. /*
  31354. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  31355. ** must be either NO_LOCK or SHARED_LOCK.
  31356. **
  31357. ** If the locking level of the file descriptor is already at or below
  31358. ** the requested locking level, this routine is a no-op.
  31359. **
  31360. ** If handleNFSUnlock is true, then on downgrading an EXCLUSIVE_LOCK to SHARED
  31361. ** the byte range is divided into 2 parts and the first part is unlocked then
  31362. ** set to a read lock, then the other part is simply unlocked. This works
  31363. ** around a bug in BSD NFS lockd (also seen on MacOSX 10.3+) that fails to
  31364. ** remove the write lock on a region when a read lock is set.
  31365. */
  31366. static int posixUnlock(sqlite3_file *id, int eFileLock, int handleNFSUnlock){
  31367. unixFile *pFile = (unixFile*)id;
  31368. unixInodeInfo *pInode;
  31369. struct flock lock;
  31370. int rc = SQLITE_OK;
  31371. assert( pFile );
  31372. OSTRACE(("UNLOCK %d %d was %d(%d,%d) pid=%d (unix)\n", pFile->h, eFileLock,
  31373. pFile->eFileLock, pFile->pInode->eFileLock, pFile->pInode->nShared,
  31374. osGetpid(0)));
  31375. assert( eFileLock<=SHARED_LOCK );
  31376. if( pFile->eFileLock<=eFileLock ){
  31377. return SQLITE_OK;
  31378. }
  31379. unixEnterMutex();
  31380. pInode = pFile->pInode;
  31381. assert( pInode->nShared!=0 );
  31382. if( pFile->eFileLock>SHARED_LOCK ){
  31383. assert( pInode->eFileLock==pFile->eFileLock );
  31384. #ifdef SQLITE_DEBUG
  31385. /* When reducing a lock such that other processes can start
  31386. ** reading the database file again, make sure that the
  31387. ** transaction counter was updated if any part of the database
  31388. ** file changed. If the transaction counter is not updated,
  31389. ** other connections to the same file might not realize that
  31390. ** the file has changed and hence might not know to flush their
  31391. ** cache. The use of a stale cache can lead to database corruption.
  31392. */
  31393. pFile->inNormalWrite = 0;
  31394. #endif
  31395. /* downgrading to a shared lock on NFS involves clearing the write lock
  31396. ** before establishing the readlock - to avoid a race condition we downgrade
  31397. ** the lock in 2 blocks, so that part of the range will be covered by a
  31398. ** write lock until the rest is covered by a read lock:
  31399. ** 1: [WWWWW]
  31400. ** 2: [....W]
  31401. ** 3: [RRRRW]
  31402. ** 4: [RRRR.]
  31403. */
  31404. if( eFileLock==SHARED_LOCK ){
  31405. #if !defined(__APPLE__) || !SQLITE_ENABLE_LOCKING_STYLE
  31406. (void)handleNFSUnlock;
  31407. assert( handleNFSUnlock==0 );
  31408. #endif
  31409. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  31410. if( handleNFSUnlock ){
  31411. int tErrno; /* Error code from system call errors */
  31412. off_t divSize = SHARED_SIZE - 1;
  31413. lock.l_type = F_UNLCK;
  31414. lock.l_whence = SEEK_SET;
  31415. lock.l_start = SHARED_FIRST;
  31416. lock.l_len = divSize;
  31417. if( unixFileLock(pFile, &lock)==(-1) ){
  31418. tErrno = errno;
  31419. rc = SQLITE_IOERR_UNLOCK;
  31420. storeLastErrno(pFile, tErrno);
  31421. goto end_unlock;
  31422. }
  31423. lock.l_type = F_RDLCK;
  31424. lock.l_whence = SEEK_SET;
  31425. lock.l_start = SHARED_FIRST;
  31426. lock.l_len = divSize;
  31427. if( unixFileLock(pFile, &lock)==(-1) ){
  31428. tErrno = errno;
  31429. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_RDLOCK);
  31430. if( IS_LOCK_ERROR(rc) ){
  31431. storeLastErrno(pFile, tErrno);
  31432. }
  31433. goto end_unlock;
  31434. }
  31435. lock.l_type = F_UNLCK;
  31436. lock.l_whence = SEEK_SET;
  31437. lock.l_start = SHARED_FIRST+divSize;
  31438. lock.l_len = SHARED_SIZE-divSize;
  31439. if( unixFileLock(pFile, &lock)==(-1) ){
  31440. tErrno = errno;
  31441. rc = SQLITE_IOERR_UNLOCK;
  31442. storeLastErrno(pFile, tErrno);
  31443. goto end_unlock;
  31444. }
  31445. }else
  31446. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  31447. {
  31448. lock.l_type = F_RDLCK;
  31449. lock.l_whence = SEEK_SET;
  31450. lock.l_start = SHARED_FIRST;
  31451. lock.l_len = SHARED_SIZE;
  31452. if( unixFileLock(pFile, &lock) ){
  31453. /* In theory, the call to unixFileLock() cannot fail because another
  31454. ** process is holding an incompatible lock. If it does, this
  31455. ** indicates that the other process is not following the locking
  31456. ** protocol. If this happens, return SQLITE_IOERR_RDLOCK. Returning
  31457. ** SQLITE_BUSY would confuse the upper layer (in practice it causes
  31458. ** an assert to fail). */
  31459. rc = SQLITE_IOERR_RDLOCK;
  31460. storeLastErrno(pFile, errno);
  31461. goto end_unlock;
  31462. }
  31463. }
  31464. }
  31465. lock.l_type = F_UNLCK;
  31466. lock.l_whence = SEEK_SET;
  31467. lock.l_start = PENDING_BYTE;
  31468. lock.l_len = 2L; assert( PENDING_BYTE+1==RESERVED_BYTE );
  31469. if( unixFileLock(pFile, &lock)==0 ){
  31470. pInode->eFileLock = SHARED_LOCK;
  31471. }else{
  31472. rc = SQLITE_IOERR_UNLOCK;
  31473. storeLastErrno(pFile, errno);
  31474. goto end_unlock;
  31475. }
  31476. }
  31477. if( eFileLock==NO_LOCK ){
  31478. /* Decrement the shared lock counter. Release the lock using an
  31479. ** OS call only when all threads in this same process have released
  31480. ** the lock.
  31481. */
  31482. pInode->nShared--;
  31483. if( pInode->nShared==0 ){
  31484. lock.l_type = F_UNLCK;
  31485. lock.l_whence = SEEK_SET;
  31486. lock.l_start = lock.l_len = 0L;
  31487. if( unixFileLock(pFile, &lock)==0 ){
  31488. pInode->eFileLock = NO_LOCK;
  31489. }else{
  31490. rc = SQLITE_IOERR_UNLOCK;
  31491. storeLastErrno(pFile, errno);
  31492. pInode->eFileLock = NO_LOCK;
  31493. pFile->eFileLock = NO_LOCK;
  31494. }
  31495. }
  31496. /* Decrement the count of locks against this same file. When the
  31497. ** count reaches zero, close any other file descriptors whose close
  31498. ** was deferred because of outstanding locks.
  31499. */
  31500. pInode->nLock--;
  31501. assert( pInode->nLock>=0 );
  31502. if( pInode->nLock==0 ){
  31503. closePendingFds(pFile);
  31504. }
  31505. }
  31506. end_unlock:
  31507. unixLeaveMutex();
  31508. if( rc==SQLITE_OK ) pFile->eFileLock = eFileLock;
  31509. return rc;
  31510. }
  31511. /*
  31512. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  31513. ** must be either NO_LOCK or SHARED_LOCK.
  31514. **
  31515. ** If the locking level of the file descriptor is already at or below
  31516. ** the requested locking level, this routine is a no-op.
  31517. */
  31518. static int unixUnlock(sqlite3_file *id, int eFileLock){
  31519. #if SQLITE_MAX_MMAP_SIZE>0
  31520. assert( eFileLock==SHARED_LOCK || ((unixFile *)id)->nFetchOut==0 );
  31521. #endif
  31522. return posixUnlock(id, eFileLock, 0);
  31523. }
  31524. #if SQLITE_MAX_MMAP_SIZE>0
  31525. static int unixMapfile(unixFile *pFd, i64 nByte);
  31526. static void unixUnmapfile(unixFile *pFd);
  31527. #endif
  31528. /*
  31529. ** This function performs the parts of the "close file" operation
  31530. ** common to all locking schemes. It closes the directory and file
  31531. ** handles, if they are valid, and sets all fields of the unixFile
  31532. ** structure to 0.
  31533. **
  31534. ** It is *not* necessary to hold the mutex when this routine is called,
  31535. ** even on VxWorks. A mutex will be acquired on VxWorks by the
  31536. ** vxworksReleaseFileId() routine.
  31537. */
  31538. static int closeUnixFile(sqlite3_file *id){
  31539. unixFile *pFile = (unixFile*)id;
  31540. #if SQLITE_MAX_MMAP_SIZE>0
  31541. unixUnmapfile(pFile);
  31542. #endif
  31543. if( pFile->h>=0 ){
  31544. robust_close(pFile, pFile->h, __LINE__);
  31545. pFile->h = -1;
  31546. }
  31547. #if OS_VXWORKS
  31548. if( pFile->pId ){
  31549. if( pFile->ctrlFlags & UNIXFILE_DELETE ){
  31550. osUnlink(pFile->pId->zCanonicalName);
  31551. }
  31552. vxworksReleaseFileId(pFile->pId);
  31553. pFile->pId = 0;
  31554. }
  31555. #endif
  31556. #ifdef SQLITE_UNLINK_AFTER_CLOSE
  31557. if( pFile->ctrlFlags & UNIXFILE_DELETE ){
  31558. osUnlink(pFile->zPath);
  31559. sqlite3_free(*(char**)&pFile->zPath);
  31560. pFile->zPath = 0;
  31561. }
  31562. #endif
  31563. OSTRACE(("CLOSE %-3d\n", pFile->h));
  31564. OpenCounter(-1);
  31565. sqlite3_free(pFile->pPreallocatedUnused);
  31566. memset(pFile, 0, sizeof(unixFile));
  31567. return SQLITE_OK;
  31568. }
  31569. /*
  31570. ** Close a file.
  31571. */
  31572. static int unixClose(sqlite3_file *id){
  31573. int rc = SQLITE_OK;
  31574. unixFile *pFile = (unixFile *)id;
  31575. verifyDbFile(pFile);
  31576. unixUnlock(id, NO_LOCK);
  31577. unixEnterMutex();
  31578. /* unixFile.pInode is always valid here. Otherwise, a different close
  31579. ** routine (e.g. nolockClose()) would be called instead.
  31580. */
  31581. assert( pFile->pInode->nLock>0 || pFile->pInode->bProcessLock==0 );
  31582. if( ALWAYS(pFile->pInode) && pFile->pInode->nLock ){
  31583. /* If there are outstanding locks, do not actually close the file just
  31584. ** yet because that would clear those locks. Instead, add the file
  31585. ** descriptor to pInode->pUnused list. It will be automatically closed
  31586. ** when the last lock is cleared.
  31587. */
  31588. setPendingFd(pFile);
  31589. }
  31590. releaseInodeInfo(pFile);
  31591. rc = closeUnixFile(id);
  31592. unixLeaveMutex();
  31593. return rc;
  31594. }
  31595. /************** End of the posix advisory lock implementation *****************
  31596. ******************************************************************************/
  31597. /******************************************************************************
  31598. ****************************** No-op Locking **********************************
  31599. **
  31600. ** Of the various locking implementations available, this is by far the
  31601. ** simplest: locking is ignored. No attempt is made to lock the database
  31602. ** file for reading or writing.
  31603. **
  31604. ** This locking mode is appropriate for use on read-only databases
  31605. ** (ex: databases that are burned into CD-ROM, for example.) It can
  31606. ** also be used if the application employs some external mechanism to
  31607. ** prevent simultaneous access of the same database by two or more
  31608. ** database connections. But there is a serious risk of database
  31609. ** corruption if this locking mode is used in situations where multiple
  31610. ** database connections are accessing the same database file at the same
  31611. ** time and one or more of those connections are writing.
  31612. */
  31613. static int nolockCheckReservedLock(sqlite3_file *NotUsed, int *pResOut){
  31614. UNUSED_PARAMETER(NotUsed);
  31615. *pResOut = 0;
  31616. return SQLITE_OK;
  31617. }
  31618. static int nolockLock(sqlite3_file *NotUsed, int NotUsed2){
  31619. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  31620. return SQLITE_OK;
  31621. }
  31622. static int nolockUnlock(sqlite3_file *NotUsed, int NotUsed2){
  31623. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  31624. return SQLITE_OK;
  31625. }
  31626. /*
  31627. ** Close the file.
  31628. */
  31629. static int nolockClose(sqlite3_file *id) {
  31630. return closeUnixFile(id);
  31631. }
  31632. /******************* End of the no-op lock implementation *********************
  31633. ******************************************************************************/
  31634. /******************************************************************************
  31635. ************************* Begin dot-file Locking ******************************
  31636. **
  31637. ** The dotfile locking implementation uses the existence of separate lock
  31638. ** files (really a directory) to control access to the database. This works
  31639. ** on just about every filesystem imaginable. But there are serious downsides:
  31640. **
  31641. ** (1) There is zero concurrency. A single reader blocks all other
  31642. ** connections from reading or writing the database.
  31643. **
  31644. ** (2) An application crash or power loss can leave stale lock files
  31645. ** sitting around that need to be cleared manually.
  31646. **
  31647. ** Nevertheless, a dotlock is an appropriate locking mode for use if no
  31648. ** other locking strategy is available.
  31649. **
  31650. ** Dotfile locking works by creating a subdirectory in the same directory as
  31651. ** the database and with the same name but with a ".lock" extension added.
  31652. ** The existence of a lock directory implies an EXCLUSIVE lock. All other
  31653. ** lock types (SHARED, RESERVED, PENDING) are mapped into EXCLUSIVE.
  31654. */
  31655. /*
  31656. ** The file suffix added to the data base filename in order to create the
  31657. ** lock directory.
  31658. */
  31659. #define DOTLOCK_SUFFIX ".lock"
  31660. /*
  31661. ** This routine checks if there is a RESERVED lock held on the specified
  31662. ** file by this or any other process. If such a lock is held, set *pResOut
  31663. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  31664. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  31665. **
  31666. ** In dotfile locking, either a lock exists or it does not. So in this
  31667. ** variation of CheckReservedLock(), *pResOut is set to true if any lock
  31668. ** is held on the file and false if the file is unlocked.
  31669. */
  31670. static int dotlockCheckReservedLock(sqlite3_file *id, int *pResOut) {
  31671. int rc = SQLITE_OK;
  31672. int reserved = 0;
  31673. unixFile *pFile = (unixFile*)id;
  31674. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  31675. assert( pFile );
  31676. reserved = osAccess((const char*)pFile->lockingContext, 0)==0;
  31677. OSTRACE(("TEST WR-LOCK %d %d %d (dotlock)\n", pFile->h, rc, reserved));
  31678. *pResOut = reserved;
  31679. return rc;
  31680. }
  31681. /*
  31682. ** Lock the file with the lock specified by parameter eFileLock - one
  31683. ** of the following:
  31684. **
  31685. ** (1) SHARED_LOCK
  31686. ** (2) RESERVED_LOCK
  31687. ** (3) PENDING_LOCK
  31688. ** (4) EXCLUSIVE_LOCK
  31689. **
  31690. ** Sometimes when requesting one lock state, additional lock states
  31691. ** are inserted in between. The locking might fail on one of the later
  31692. ** transitions leaving the lock state different from what it started but
  31693. ** still short of its goal. The following chart shows the allowed
  31694. ** transitions and the inserted intermediate states:
  31695. **
  31696. ** UNLOCKED -> SHARED
  31697. ** SHARED -> RESERVED
  31698. ** SHARED -> (PENDING) -> EXCLUSIVE
  31699. ** RESERVED -> (PENDING) -> EXCLUSIVE
  31700. ** PENDING -> EXCLUSIVE
  31701. **
  31702. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  31703. ** routine to lower a locking level.
  31704. **
  31705. ** With dotfile locking, we really only support state (4): EXCLUSIVE.
  31706. ** But we track the other locking levels internally.
  31707. */
  31708. static int dotlockLock(sqlite3_file *id, int eFileLock) {
  31709. unixFile *pFile = (unixFile*)id;
  31710. char *zLockFile = (char *)pFile->lockingContext;
  31711. int rc = SQLITE_OK;
  31712. /* If we have any lock, then the lock file already exists. All we have
  31713. ** to do is adjust our internal record of the lock level.
  31714. */
  31715. if( pFile->eFileLock > NO_LOCK ){
  31716. pFile->eFileLock = eFileLock;
  31717. /* Always update the timestamp on the old file */
  31718. #ifdef HAVE_UTIME
  31719. utime(zLockFile, NULL);
  31720. #else
  31721. utimes(zLockFile, NULL);
  31722. #endif
  31723. return SQLITE_OK;
  31724. }
  31725. /* grab an exclusive lock */
  31726. rc = osMkdir(zLockFile, 0777);
  31727. if( rc<0 ){
  31728. /* failed to open/create the lock directory */
  31729. int tErrno = errno;
  31730. if( EEXIST == tErrno ){
  31731. rc = SQLITE_BUSY;
  31732. } else {
  31733. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  31734. if( rc!=SQLITE_BUSY ){
  31735. storeLastErrno(pFile, tErrno);
  31736. }
  31737. }
  31738. return rc;
  31739. }
  31740. /* got it, set the type and return ok */
  31741. pFile->eFileLock = eFileLock;
  31742. return rc;
  31743. }
  31744. /*
  31745. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  31746. ** must be either NO_LOCK or SHARED_LOCK.
  31747. **
  31748. ** If the locking level of the file descriptor is already at or below
  31749. ** the requested locking level, this routine is a no-op.
  31750. **
  31751. ** When the locking level reaches NO_LOCK, delete the lock file.
  31752. */
  31753. static int dotlockUnlock(sqlite3_file *id, int eFileLock) {
  31754. unixFile *pFile = (unixFile*)id;
  31755. char *zLockFile = (char *)pFile->lockingContext;
  31756. int rc;
  31757. assert( pFile );
  31758. OSTRACE(("UNLOCK %d %d was %d pid=%d (dotlock)\n", pFile->h, eFileLock,
  31759. pFile->eFileLock, osGetpid(0)));
  31760. assert( eFileLock<=SHARED_LOCK );
  31761. /* no-op if possible */
  31762. if( pFile->eFileLock==eFileLock ){
  31763. return SQLITE_OK;
  31764. }
  31765. /* To downgrade to shared, simply update our internal notion of the
  31766. ** lock state. No need to mess with the file on disk.
  31767. */
  31768. if( eFileLock==SHARED_LOCK ){
  31769. pFile->eFileLock = SHARED_LOCK;
  31770. return SQLITE_OK;
  31771. }
  31772. /* To fully unlock the database, delete the lock file */
  31773. assert( eFileLock==NO_LOCK );
  31774. rc = osRmdir(zLockFile);
  31775. if( rc<0 ){
  31776. int tErrno = errno;
  31777. if( tErrno==ENOENT ){
  31778. rc = SQLITE_OK;
  31779. }else{
  31780. rc = SQLITE_IOERR_UNLOCK;
  31781. storeLastErrno(pFile, tErrno);
  31782. }
  31783. return rc;
  31784. }
  31785. pFile->eFileLock = NO_LOCK;
  31786. return SQLITE_OK;
  31787. }
  31788. /*
  31789. ** Close a file. Make sure the lock has been released before closing.
  31790. */
  31791. static int dotlockClose(sqlite3_file *id) {
  31792. unixFile *pFile = (unixFile*)id;
  31793. assert( id!=0 );
  31794. dotlockUnlock(id, NO_LOCK);
  31795. sqlite3_free(pFile->lockingContext);
  31796. return closeUnixFile(id);
  31797. }
  31798. /****************** End of the dot-file lock implementation *******************
  31799. ******************************************************************************/
  31800. /******************************************************************************
  31801. ************************** Begin flock Locking ********************************
  31802. **
  31803. ** Use the flock() system call to do file locking.
  31804. **
  31805. ** flock() locking is like dot-file locking in that the various
  31806. ** fine-grain locking levels supported by SQLite are collapsed into
  31807. ** a single exclusive lock. In other words, SHARED, RESERVED, and
  31808. ** PENDING locks are the same thing as an EXCLUSIVE lock. SQLite
  31809. ** still works when you do this, but concurrency is reduced since
  31810. ** only a single process can be reading the database at a time.
  31811. **
  31812. ** Omit this section if SQLITE_ENABLE_LOCKING_STYLE is turned off
  31813. */
  31814. #if SQLITE_ENABLE_LOCKING_STYLE
  31815. /*
  31816. ** Retry flock() calls that fail with EINTR
  31817. */
  31818. #ifdef EINTR
  31819. static int robust_flock(int fd, int op){
  31820. int rc;
  31821. do{ rc = flock(fd,op); }while( rc<0 && errno==EINTR );
  31822. return rc;
  31823. }
  31824. #else
  31825. # define robust_flock(a,b) flock(a,b)
  31826. #endif
  31827. /*
  31828. ** This routine checks if there is a RESERVED lock held on the specified
  31829. ** file by this or any other process. If such a lock is held, set *pResOut
  31830. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  31831. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  31832. */
  31833. static int flockCheckReservedLock(sqlite3_file *id, int *pResOut){
  31834. int rc = SQLITE_OK;
  31835. int reserved = 0;
  31836. unixFile *pFile = (unixFile*)id;
  31837. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  31838. assert( pFile );
  31839. /* Check if a thread in this process holds such a lock */
  31840. if( pFile->eFileLock>SHARED_LOCK ){
  31841. reserved = 1;
  31842. }
  31843. /* Otherwise see if some other process holds it. */
  31844. if( !reserved ){
  31845. /* attempt to get the lock */
  31846. int lrc = robust_flock(pFile->h, LOCK_EX | LOCK_NB);
  31847. if( !lrc ){
  31848. /* got the lock, unlock it */
  31849. lrc = robust_flock(pFile->h, LOCK_UN);
  31850. if ( lrc ) {
  31851. int tErrno = errno;
  31852. /* unlock failed with an error */
  31853. lrc = SQLITE_IOERR_UNLOCK;
  31854. storeLastErrno(pFile, tErrno);
  31855. rc = lrc;
  31856. }
  31857. } else {
  31858. int tErrno = errno;
  31859. reserved = 1;
  31860. /* someone else might have it reserved */
  31861. lrc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  31862. if( IS_LOCK_ERROR(lrc) ){
  31863. storeLastErrno(pFile, tErrno);
  31864. rc = lrc;
  31865. }
  31866. }
  31867. }
  31868. OSTRACE(("TEST WR-LOCK %d %d %d (flock)\n", pFile->h, rc, reserved));
  31869. #ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  31870. if( (rc & 0xff) == SQLITE_IOERR ){
  31871. rc = SQLITE_OK;
  31872. reserved=1;
  31873. }
  31874. #endif /* SQLITE_IGNORE_FLOCK_LOCK_ERRORS */
  31875. *pResOut = reserved;
  31876. return rc;
  31877. }
  31878. /*
  31879. ** Lock the file with the lock specified by parameter eFileLock - one
  31880. ** of the following:
  31881. **
  31882. ** (1) SHARED_LOCK
  31883. ** (2) RESERVED_LOCK
  31884. ** (3) PENDING_LOCK
  31885. ** (4) EXCLUSIVE_LOCK
  31886. **
  31887. ** Sometimes when requesting one lock state, additional lock states
  31888. ** are inserted in between. The locking might fail on one of the later
  31889. ** transitions leaving the lock state different from what it started but
  31890. ** still short of its goal. The following chart shows the allowed
  31891. ** transitions and the inserted intermediate states:
  31892. **
  31893. ** UNLOCKED -> SHARED
  31894. ** SHARED -> RESERVED
  31895. ** SHARED -> (PENDING) -> EXCLUSIVE
  31896. ** RESERVED -> (PENDING) -> EXCLUSIVE
  31897. ** PENDING -> EXCLUSIVE
  31898. **
  31899. ** flock() only really support EXCLUSIVE locks. We track intermediate
  31900. ** lock states in the sqlite3_file structure, but all locks SHARED or
  31901. ** above are really EXCLUSIVE locks and exclude all other processes from
  31902. ** access the file.
  31903. **
  31904. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  31905. ** routine to lower a locking level.
  31906. */
  31907. static int flockLock(sqlite3_file *id, int eFileLock) {
  31908. int rc = SQLITE_OK;
  31909. unixFile *pFile = (unixFile*)id;
  31910. assert( pFile );
  31911. /* if we already have a lock, it is exclusive.
  31912. ** Just adjust level and punt on outta here. */
  31913. if (pFile->eFileLock > NO_LOCK) {
  31914. pFile->eFileLock = eFileLock;
  31915. return SQLITE_OK;
  31916. }
  31917. /* grab an exclusive lock */
  31918. if (robust_flock(pFile->h, LOCK_EX | LOCK_NB)) {
  31919. int tErrno = errno;
  31920. /* didn't get, must be busy */
  31921. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_LOCK);
  31922. if( IS_LOCK_ERROR(rc) ){
  31923. storeLastErrno(pFile, tErrno);
  31924. }
  31925. } else {
  31926. /* got it, set the type and return ok */
  31927. pFile->eFileLock = eFileLock;
  31928. }
  31929. OSTRACE(("LOCK %d %s %s (flock)\n", pFile->h, azFileLock(eFileLock),
  31930. rc==SQLITE_OK ? "ok" : "failed"));
  31931. #ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  31932. if( (rc & 0xff) == SQLITE_IOERR ){
  31933. rc = SQLITE_BUSY;
  31934. }
  31935. #endif /* SQLITE_IGNORE_FLOCK_LOCK_ERRORS */
  31936. return rc;
  31937. }
  31938. /*
  31939. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  31940. ** must be either NO_LOCK or SHARED_LOCK.
  31941. **
  31942. ** If the locking level of the file descriptor is already at or below
  31943. ** the requested locking level, this routine is a no-op.
  31944. */
  31945. static int flockUnlock(sqlite3_file *id, int eFileLock) {
  31946. unixFile *pFile = (unixFile*)id;
  31947. assert( pFile );
  31948. OSTRACE(("UNLOCK %d %d was %d pid=%d (flock)\n", pFile->h, eFileLock,
  31949. pFile->eFileLock, osGetpid(0)));
  31950. assert( eFileLock<=SHARED_LOCK );
  31951. /* no-op if possible */
  31952. if( pFile->eFileLock==eFileLock ){
  31953. return SQLITE_OK;
  31954. }
  31955. /* shared can just be set because we always have an exclusive */
  31956. if (eFileLock==SHARED_LOCK) {
  31957. pFile->eFileLock = eFileLock;
  31958. return SQLITE_OK;
  31959. }
  31960. /* no, really, unlock. */
  31961. if( robust_flock(pFile->h, LOCK_UN) ){
  31962. #ifdef SQLITE_IGNORE_FLOCK_LOCK_ERRORS
  31963. return SQLITE_OK;
  31964. #endif /* SQLITE_IGNORE_FLOCK_LOCK_ERRORS */
  31965. return SQLITE_IOERR_UNLOCK;
  31966. }else{
  31967. pFile->eFileLock = NO_LOCK;
  31968. return SQLITE_OK;
  31969. }
  31970. }
  31971. /*
  31972. ** Close a file.
  31973. */
  31974. static int flockClose(sqlite3_file *id) {
  31975. assert( id!=0 );
  31976. flockUnlock(id, NO_LOCK);
  31977. return closeUnixFile(id);
  31978. }
  31979. #endif /* SQLITE_ENABLE_LOCKING_STYLE && !OS_VXWORK */
  31980. /******************* End of the flock lock implementation *********************
  31981. ******************************************************************************/
  31982. /******************************************************************************
  31983. ************************ Begin Named Semaphore Locking ************************
  31984. **
  31985. ** Named semaphore locking is only supported on VxWorks.
  31986. **
  31987. ** Semaphore locking is like dot-lock and flock in that it really only
  31988. ** supports EXCLUSIVE locking. Only a single process can read or write
  31989. ** the database file at a time. This reduces potential concurrency, but
  31990. ** makes the lock implementation much easier.
  31991. */
  31992. #if OS_VXWORKS
  31993. /*
  31994. ** This routine checks if there is a RESERVED lock held on the specified
  31995. ** file by this or any other process. If such a lock is held, set *pResOut
  31996. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  31997. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  31998. */
  31999. static int semXCheckReservedLock(sqlite3_file *id, int *pResOut) {
  32000. int rc = SQLITE_OK;
  32001. int reserved = 0;
  32002. unixFile *pFile = (unixFile*)id;
  32003. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  32004. assert( pFile );
  32005. /* Check if a thread in this process holds such a lock */
  32006. if( pFile->eFileLock>SHARED_LOCK ){
  32007. reserved = 1;
  32008. }
  32009. /* Otherwise see if some other process holds it. */
  32010. if( !reserved ){
  32011. sem_t *pSem = pFile->pInode->pSem;
  32012. if( sem_trywait(pSem)==-1 ){
  32013. int tErrno = errno;
  32014. if( EAGAIN != tErrno ){
  32015. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_CHECKRESERVEDLOCK);
  32016. storeLastErrno(pFile, tErrno);
  32017. } else {
  32018. /* someone else has the lock when we are in NO_LOCK */
  32019. reserved = (pFile->eFileLock < SHARED_LOCK);
  32020. }
  32021. }else{
  32022. /* we could have it if we want it */
  32023. sem_post(pSem);
  32024. }
  32025. }
  32026. OSTRACE(("TEST WR-LOCK %d %d %d (sem)\n", pFile->h, rc, reserved));
  32027. *pResOut = reserved;
  32028. return rc;
  32029. }
  32030. /*
  32031. ** Lock the file with the lock specified by parameter eFileLock - one
  32032. ** of the following:
  32033. **
  32034. ** (1) SHARED_LOCK
  32035. ** (2) RESERVED_LOCK
  32036. ** (3) PENDING_LOCK
  32037. ** (4) EXCLUSIVE_LOCK
  32038. **
  32039. ** Sometimes when requesting one lock state, additional lock states
  32040. ** are inserted in between. The locking might fail on one of the later
  32041. ** transitions leaving the lock state different from what it started but
  32042. ** still short of its goal. The following chart shows the allowed
  32043. ** transitions and the inserted intermediate states:
  32044. **
  32045. ** UNLOCKED -> SHARED
  32046. ** SHARED -> RESERVED
  32047. ** SHARED -> (PENDING) -> EXCLUSIVE
  32048. ** RESERVED -> (PENDING) -> EXCLUSIVE
  32049. ** PENDING -> EXCLUSIVE
  32050. **
  32051. ** Semaphore locks only really support EXCLUSIVE locks. We track intermediate
  32052. ** lock states in the sqlite3_file structure, but all locks SHARED or
  32053. ** above are really EXCLUSIVE locks and exclude all other processes from
  32054. ** access the file.
  32055. **
  32056. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  32057. ** routine to lower a locking level.
  32058. */
  32059. static int semXLock(sqlite3_file *id, int eFileLock) {
  32060. unixFile *pFile = (unixFile*)id;
  32061. sem_t *pSem = pFile->pInode->pSem;
  32062. int rc = SQLITE_OK;
  32063. /* if we already have a lock, it is exclusive.
  32064. ** Just adjust level and punt on outta here. */
  32065. if (pFile->eFileLock > NO_LOCK) {
  32066. pFile->eFileLock = eFileLock;
  32067. rc = SQLITE_OK;
  32068. goto sem_end_lock;
  32069. }
  32070. /* lock semaphore now but bail out when already locked. */
  32071. if( sem_trywait(pSem)==-1 ){
  32072. rc = SQLITE_BUSY;
  32073. goto sem_end_lock;
  32074. }
  32075. /* got it, set the type and return ok */
  32076. pFile->eFileLock = eFileLock;
  32077. sem_end_lock:
  32078. return rc;
  32079. }
  32080. /*
  32081. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  32082. ** must be either NO_LOCK or SHARED_LOCK.
  32083. **
  32084. ** If the locking level of the file descriptor is already at or below
  32085. ** the requested locking level, this routine is a no-op.
  32086. */
  32087. static int semXUnlock(sqlite3_file *id, int eFileLock) {
  32088. unixFile *pFile = (unixFile*)id;
  32089. sem_t *pSem = pFile->pInode->pSem;
  32090. assert( pFile );
  32091. assert( pSem );
  32092. OSTRACE(("UNLOCK %d %d was %d pid=%d (sem)\n", pFile->h, eFileLock,
  32093. pFile->eFileLock, osGetpid(0)));
  32094. assert( eFileLock<=SHARED_LOCK );
  32095. /* no-op if possible */
  32096. if( pFile->eFileLock==eFileLock ){
  32097. return SQLITE_OK;
  32098. }
  32099. /* shared can just be set because we always have an exclusive */
  32100. if (eFileLock==SHARED_LOCK) {
  32101. pFile->eFileLock = eFileLock;
  32102. return SQLITE_OK;
  32103. }
  32104. /* no, really unlock. */
  32105. if ( sem_post(pSem)==-1 ) {
  32106. int rc, tErrno = errno;
  32107. rc = sqliteErrorFromPosixError(tErrno, SQLITE_IOERR_UNLOCK);
  32108. if( IS_LOCK_ERROR(rc) ){
  32109. storeLastErrno(pFile, tErrno);
  32110. }
  32111. return rc;
  32112. }
  32113. pFile->eFileLock = NO_LOCK;
  32114. return SQLITE_OK;
  32115. }
  32116. /*
  32117. ** Close a file.
  32118. */
  32119. static int semXClose(sqlite3_file *id) {
  32120. if( id ){
  32121. unixFile *pFile = (unixFile*)id;
  32122. semXUnlock(id, NO_LOCK);
  32123. assert( pFile );
  32124. unixEnterMutex();
  32125. releaseInodeInfo(pFile);
  32126. unixLeaveMutex();
  32127. closeUnixFile(id);
  32128. }
  32129. return SQLITE_OK;
  32130. }
  32131. #endif /* OS_VXWORKS */
  32132. /*
  32133. ** Named semaphore locking is only available on VxWorks.
  32134. **
  32135. *************** End of the named semaphore lock implementation ****************
  32136. ******************************************************************************/
  32137. /******************************************************************************
  32138. *************************** Begin AFP Locking *********************************
  32139. **
  32140. ** AFP is the Apple Filing Protocol. AFP is a network filesystem found
  32141. ** on Apple Macintosh computers - both OS9 and OSX.
  32142. **
  32143. ** Third-party implementations of AFP are available. But this code here
  32144. ** only works on OSX.
  32145. */
  32146. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32147. /*
  32148. ** The afpLockingContext structure contains all afp lock specific state
  32149. */
  32150. typedef struct afpLockingContext afpLockingContext;
  32151. struct afpLockingContext {
  32152. int reserved;
  32153. const char *dbPath; /* Name of the open file */
  32154. };
  32155. struct ByteRangeLockPB2
  32156. {
  32157. unsigned long long offset; /* offset to first byte to lock */
  32158. unsigned long long length; /* nbr of bytes to lock */
  32159. unsigned long long retRangeStart; /* nbr of 1st byte locked if successful */
  32160. unsigned char unLockFlag; /* 1 = unlock, 0 = lock */
  32161. unsigned char startEndFlag; /* 1=rel to end of fork, 0=rel to start */
  32162. int fd; /* file desc to assoc this lock with */
  32163. };
  32164. #define afpfsByteRangeLock2FSCTL _IOWR('z', 23, struct ByteRangeLockPB2)
  32165. /*
  32166. ** This is a utility for setting or clearing a bit-range lock on an
  32167. ** AFP filesystem.
  32168. **
  32169. ** Return SQLITE_OK on success, SQLITE_BUSY on failure.
  32170. */
  32171. static int afpSetLock(
  32172. const char *path, /* Name of the file to be locked or unlocked */
  32173. unixFile *pFile, /* Open file descriptor on path */
  32174. unsigned long long offset, /* First byte to be locked */
  32175. unsigned long long length, /* Number of bytes to lock */
  32176. int setLockFlag /* True to set lock. False to clear lock */
  32177. ){
  32178. struct ByteRangeLockPB2 pb;
  32179. int err;
  32180. pb.unLockFlag = setLockFlag ? 0 : 1;
  32181. pb.startEndFlag = 0;
  32182. pb.offset = offset;
  32183. pb.length = length;
  32184. pb.fd = pFile->h;
  32185. OSTRACE(("AFPSETLOCK [%s] for %d%s in range %llx:%llx\n",
  32186. (setLockFlag?"ON":"OFF"), pFile->h, (pb.fd==-1?"[testval-1]":""),
  32187. offset, length));
  32188. err = fsctl(path, afpfsByteRangeLock2FSCTL, &pb, 0);
  32189. if ( err==-1 ) {
  32190. int rc;
  32191. int tErrno = errno;
  32192. OSTRACE(("AFPSETLOCK failed to fsctl() '%s' %d %s\n",
  32193. path, tErrno, strerror(tErrno)));
  32194. #ifdef SQLITE_IGNORE_AFP_LOCK_ERRORS
  32195. rc = SQLITE_BUSY;
  32196. #else
  32197. rc = sqliteErrorFromPosixError(tErrno,
  32198. setLockFlag ? SQLITE_IOERR_LOCK : SQLITE_IOERR_UNLOCK);
  32199. #endif /* SQLITE_IGNORE_AFP_LOCK_ERRORS */
  32200. if( IS_LOCK_ERROR(rc) ){
  32201. storeLastErrno(pFile, tErrno);
  32202. }
  32203. return rc;
  32204. } else {
  32205. return SQLITE_OK;
  32206. }
  32207. }
  32208. /*
  32209. ** This routine checks if there is a RESERVED lock held on the specified
  32210. ** file by this or any other process. If such a lock is held, set *pResOut
  32211. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  32212. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  32213. */
  32214. static int afpCheckReservedLock(sqlite3_file *id, int *pResOut){
  32215. int rc = SQLITE_OK;
  32216. int reserved = 0;
  32217. unixFile *pFile = (unixFile*)id;
  32218. afpLockingContext *context;
  32219. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  32220. assert( pFile );
  32221. context = (afpLockingContext *) pFile->lockingContext;
  32222. if( context->reserved ){
  32223. *pResOut = 1;
  32224. return SQLITE_OK;
  32225. }
  32226. unixEnterMutex(); /* Because pFile->pInode is shared across threads */
  32227. /* Check if a thread in this process holds such a lock */
  32228. if( pFile->pInode->eFileLock>SHARED_LOCK ){
  32229. reserved = 1;
  32230. }
  32231. /* Otherwise see if some other process holds it.
  32232. */
  32233. if( !reserved ){
  32234. /* lock the RESERVED byte */
  32235. int lrc = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1,1);
  32236. if( SQLITE_OK==lrc ){
  32237. /* if we succeeded in taking the reserved lock, unlock it to restore
  32238. ** the original state */
  32239. lrc = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1, 0);
  32240. } else {
  32241. /* if we failed to get the lock then someone else must have it */
  32242. reserved = 1;
  32243. }
  32244. if( IS_LOCK_ERROR(lrc) ){
  32245. rc=lrc;
  32246. }
  32247. }
  32248. unixLeaveMutex();
  32249. OSTRACE(("TEST WR-LOCK %d %d %d (afp)\n", pFile->h, rc, reserved));
  32250. *pResOut = reserved;
  32251. return rc;
  32252. }
  32253. /*
  32254. ** Lock the file with the lock specified by parameter eFileLock - one
  32255. ** of the following:
  32256. **
  32257. ** (1) SHARED_LOCK
  32258. ** (2) RESERVED_LOCK
  32259. ** (3) PENDING_LOCK
  32260. ** (4) EXCLUSIVE_LOCK
  32261. **
  32262. ** Sometimes when requesting one lock state, additional lock states
  32263. ** are inserted in between. The locking might fail on one of the later
  32264. ** transitions leaving the lock state different from what it started but
  32265. ** still short of its goal. The following chart shows the allowed
  32266. ** transitions and the inserted intermediate states:
  32267. **
  32268. ** UNLOCKED -> SHARED
  32269. ** SHARED -> RESERVED
  32270. ** SHARED -> (PENDING) -> EXCLUSIVE
  32271. ** RESERVED -> (PENDING) -> EXCLUSIVE
  32272. ** PENDING -> EXCLUSIVE
  32273. **
  32274. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  32275. ** routine to lower a locking level.
  32276. */
  32277. static int afpLock(sqlite3_file *id, int eFileLock){
  32278. int rc = SQLITE_OK;
  32279. unixFile *pFile = (unixFile*)id;
  32280. unixInodeInfo *pInode = pFile->pInode;
  32281. afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
  32282. assert( pFile );
  32283. OSTRACE(("LOCK %d %s was %s(%s,%d) pid=%d (afp)\n", pFile->h,
  32284. azFileLock(eFileLock), azFileLock(pFile->eFileLock),
  32285. azFileLock(pInode->eFileLock), pInode->nShared , osGetpid(0)));
  32286. /* If there is already a lock of this type or more restrictive on the
  32287. ** unixFile, do nothing. Don't use the afp_end_lock: exit path, as
  32288. ** unixEnterMutex() hasn't been called yet.
  32289. */
  32290. if( pFile->eFileLock>=eFileLock ){
  32291. OSTRACE(("LOCK %d %s ok (already held) (afp)\n", pFile->h,
  32292. azFileLock(eFileLock)));
  32293. return SQLITE_OK;
  32294. }
  32295. /* Make sure the locking sequence is correct
  32296. ** (1) We never move from unlocked to anything higher than shared lock.
  32297. ** (2) SQLite never explicitly requests a pendig lock.
  32298. ** (3) A shared lock is always held when a reserve lock is requested.
  32299. */
  32300. assert( pFile->eFileLock!=NO_LOCK || eFileLock==SHARED_LOCK );
  32301. assert( eFileLock!=PENDING_LOCK );
  32302. assert( eFileLock!=RESERVED_LOCK || pFile->eFileLock==SHARED_LOCK );
  32303. /* This mutex is needed because pFile->pInode is shared across threads
  32304. */
  32305. unixEnterMutex();
  32306. pInode = pFile->pInode;
  32307. /* If some thread using this PID has a lock via a different unixFile*
  32308. ** handle that precludes the requested lock, return BUSY.
  32309. */
  32310. if( (pFile->eFileLock!=pInode->eFileLock &&
  32311. (pInode->eFileLock>=PENDING_LOCK || eFileLock>SHARED_LOCK))
  32312. ){
  32313. rc = SQLITE_BUSY;
  32314. goto afp_end_lock;
  32315. }
  32316. /* If a SHARED lock is requested, and some thread using this PID already
  32317. ** has a SHARED or RESERVED lock, then increment reference counts and
  32318. ** return SQLITE_OK.
  32319. */
  32320. if( eFileLock==SHARED_LOCK &&
  32321. (pInode->eFileLock==SHARED_LOCK || pInode->eFileLock==RESERVED_LOCK) ){
  32322. assert( eFileLock==SHARED_LOCK );
  32323. assert( pFile->eFileLock==0 );
  32324. assert( pInode->nShared>0 );
  32325. pFile->eFileLock = SHARED_LOCK;
  32326. pInode->nShared++;
  32327. pInode->nLock++;
  32328. goto afp_end_lock;
  32329. }
  32330. /* A PENDING lock is needed before acquiring a SHARED lock and before
  32331. ** acquiring an EXCLUSIVE lock. For the SHARED lock, the PENDING will
  32332. ** be released.
  32333. */
  32334. if( eFileLock==SHARED_LOCK
  32335. || (eFileLock==EXCLUSIVE_LOCK && pFile->eFileLock<PENDING_LOCK)
  32336. ){
  32337. int failed;
  32338. failed = afpSetLock(context->dbPath, pFile, PENDING_BYTE, 1, 1);
  32339. if (failed) {
  32340. rc = failed;
  32341. goto afp_end_lock;
  32342. }
  32343. }
  32344. /* If control gets to this point, then actually go ahead and make
  32345. ** operating system calls for the specified lock.
  32346. */
  32347. if( eFileLock==SHARED_LOCK ){
  32348. int lrc1, lrc2, lrc1Errno = 0;
  32349. long lk, mask;
  32350. assert( pInode->nShared==0 );
  32351. assert( pInode->eFileLock==0 );
  32352. mask = (sizeof(long)==8) ? LARGEST_INT64 : 0x7fffffff;
  32353. /* Now get the read-lock SHARED_LOCK */
  32354. /* note that the quality of the randomness doesn't matter that much */
  32355. lk = random();
  32356. pInode->sharedByte = (lk & mask)%(SHARED_SIZE - 1);
  32357. lrc1 = afpSetLock(context->dbPath, pFile,
  32358. SHARED_FIRST+pInode->sharedByte, 1, 1);
  32359. if( IS_LOCK_ERROR(lrc1) ){
  32360. lrc1Errno = pFile->lastErrno;
  32361. }
  32362. /* Drop the temporary PENDING lock */
  32363. lrc2 = afpSetLock(context->dbPath, pFile, PENDING_BYTE, 1, 0);
  32364. if( IS_LOCK_ERROR(lrc1) ) {
  32365. storeLastErrno(pFile, lrc1Errno);
  32366. rc = lrc1;
  32367. goto afp_end_lock;
  32368. } else if( IS_LOCK_ERROR(lrc2) ){
  32369. rc = lrc2;
  32370. goto afp_end_lock;
  32371. } else if( lrc1 != SQLITE_OK ) {
  32372. rc = lrc1;
  32373. } else {
  32374. pFile->eFileLock = SHARED_LOCK;
  32375. pInode->nLock++;
  32376. pInode->nShared = 1;
  32377. }
  32378. }else if( eFileLock==EXCLUSIVE_LOCK && pInode->nShared>1 ){
  32379. /* We are trying for an exclusive lock but another thread in this
  32380. ** same process is still holding a shared lock. */
  32381. rc = SQLITE_BUSY;
  32382. }else{
  32383. /* The request was for a RESERVED or EXCLUSIVE lock. It is
  32384. ** assumed that there is a SHARED or greater lock on the file
  32385. ** already.
  32386. */
  32387. int failed = 0;
  32388. assert( 0!=pFile->eFileLock );
  32389. if (eFileLock >= RESERVED_LOCK && pFile->eFileLock < RESERVED_LOCK) {
  32390. /* Acquire a RESERVED lock */
  32391. failed = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1,1);
  32392. if( !failed ){
  32393. context->reserved = 1;
  32394. }
  32395. }
  32396. if (!failed && eFileLock == EXCLUSIVE_LOCK) {
  32397. /* Acquire an EXCLUSIVE lock */
  32398. /* Remove the shared lock before trying the range. we'll need to
  32399. ** reestablish the shared lock if we can't get the afpUnlock
  32400. */
  32401. if( !(failed = afpSetLock(context->dbPath, pFile, SHARED_FIRST +
  32402. pInode->sharedByte, 1, 0)) ){
  32403. int failed2 = SQLITE_OK;
  32404. /* now attemmpt to get the exclusive lock range */
  32405. failed = afpSetLock(context->dbPath, pFile, SHARED_FIRST,
  32406. SHARED_SIZE, 1);
  32407. if( failed && (failed2 = afpSetLock(context->dbPath, pFile,
  32408. SHARED_FIRST + pInode->sharedByte, 1, 1)) ){
  32409. /* Can't reestablish the shared lock. Sqlite can't deal, this is
  32410. ** a critical I/O error
  32411. */
  32412. rc = ((failed & 0xff) == SQLITE_IOERR) ? failed2 :
  32413. SQLITE_IOERR_LOCK;
  32414. goto afp_end_lock;
  32415. }
  32416. }else{
  32417. rc = failed;
  32418. }
  32419. }
  32420. if( failed ){
  32421. rc = failed;
  32422. }
  32423. }
  32424. if( rc==SQLITE_OK ){
  32425. pFile->eFileLock = eFileLock;
  32426. pInode->eFileLock = eFileLock;
  32427. }else if( eFileLock==EXCLUSIVE_LOCK ){
  32428. pFile->eFileLock = PENDING_LOCK;
  32429. pInode->eFileLock = PENDING_LOCK;
  32430. }
  32431. afp_end_lock:
  32432. unixLeaveMutex();
  32433. OSTRACE(("LOCK %d %s %s (afp)\n", pFile->h, azFileLock(eFileLock),
  32434. rc==SQLITE_OK ? "ok" : "failed"));
  32435. return rc;
  32436. }
  32437. /*
  32438. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  32439. ** must be either NO_LOCK or SHARED_LOCK.
  32440. **
  32441. ** If the locking level of the file descriptor is already at or below
  32442. ** the requested locking level, this routine is a no-op.
  32443. */
  32444. static int afpUnlock(sqlite3_file *id, int eFileLock) {
  32445. int rc = SQLITE_OK;
  32446. unixFile *pFile = (unixFile*)id;
  32447. unixInodeInfo *pInode;
  32448. afpLockingContext *context = (afpLockingContext *) pFile->lockingContext;
  32449. int skipShared = 0;
  32450. #ifdef SQLITE_TEST
  32451. int h = pFile->h;
  32452. #endif
  32453. assert( pFile );
  32454. OSTRACE(("UNLOCK %d %d was %d(%d,%d) pid=%d (afp)\n", pFile->h, eFileLock,
  32455. pFile->eFileLock, pFile->pInode->eFileLock, pFile->pInode->nShared,
  32456. osGetpid(0)));
  32457. assert( eFileLock<=SHARED_LOCK );
  32458. if( pFile->eFileLock<=eFileLock ){
  32459. return SQLITE_OK;
  32460. }
  32461. unixEnterMutex();
  32462. pInode = pFile->pInode;
  32463. assert( pInode->nShared!=0 );
  32464. if( pFile->eFileLock>SHARED_LOCK ){
  32465. assert( pInode->eFileLock==pFile->eFileLock );
  32466. SimulateIOErrorBenign(1);
  32467. SimulateIOError( h=(-1) )
  32468. SimulateIOErrorBenign(0);
  32469. #ifdef SQLITE_DEBUG
  32470. /* When reducing a lock such that other processes can start
  32471. ** reading the database file again, make sure that the
  32472. ** transaction counter was updated if any part of the database
  32473. ** file changed. If the transaction counter is not updated,
  32474. ** other connections to the same file might not realize that
  32475. ** the file has changed and hence might not know to flush their
  32476. ** cache. The use of a stale cache can lead to database corruption.
  32477. */
  32478. assert( pFile->inNormalWrite==0
  32479. || pFile->dbUpdate==0
  32480. || pFile->transCntrChng==1 );
  32481. pFile->inNormalWrite = 0;
  32482. #endif
  32483. if( pFile->eFileLock==EXCLUSIVE_LOCK ){
  32484. rc = afpSetLock(context->dbPath, pFile, SHARED_FIRST, SHARED_SIZE, 0);
  32485. if( rc==SQLITE_OK && (eFileLock==SHARED_LOCK || pInode->nShared>1) ){
  32486. /* only re-establish the shared lock if necessary */
  32487. int sharedLockByte = SHARED_FIRST+pInode->sharedByte;
  32488. rc = afpSetLock(context->dbPath, pFile, sharedLockByte, 1, 1);
  32489. } else {
  32490. skipShared = 1;
  32491. }
  32492. }
  32493. if( rc==SQLITE_OK && pFile->eFileLock>=PENDING_LOCK ){
  32494. rc = afpSetLock(context->dbPath, pFile, PENDING_BYTE, 1, 0);
  32495. }
  32496. if( rc==SQLITE_OK && pFile->eFileLock>=RESERVED_LOCK && context->reserved ){
  32497. rc = afpSetLock(context->dbPath, pFile, RESERVED_BYTE, 1, 0);
  32498. if( !rc ){
  32499. context->reserved = 0;
  32500. }
  32501. }
  32502. if( rc==SQLITE_OK && (eFileLock==SHARED_LOCK || pInode->nShared>1)){
  32503. pInode->eFileLock = SHARED_LOCK;
  32504. }
  32505. }
  32506. if( rc==SQLITE_OK && eFileLock==NO_LOCK ){
  32507. /* Decrement the shared lock counter. Release the lock using an
  32508. ** OS call only when all threads in this same process have released
  32509. ** the lock.
  32510. */
  32511. unsigned long long sharedLockByte = SHARED_FIRST+pInode->sharedByte;
  32512. pInode->nShared--;
  32513. if( pInode->nShared==0 ){
  32514. SimulateIOErrorBenign(1);
  32515. SimulateIOError( h=(-1) )
  32516. SimulateIOErrorBenign(0);
  32517. if( !skipShared ){
  32518. rc = afpSetLock(context->dbPath, pFile, sharedLockByte, 1, 0);
  32519. }
  32520. if( !rc ){
  32521. pInode->eFileLock = NO_LOCK;
  32522. pFile->eFileLock = NO_LOCK;
  32523. }
  32524. }
  32525. if( rc==SQLITE_OK ){
  32526. pInode->nLock--;
  32527. assert( pInode->nLock>=0 );
  32528. if( pInode->nLock==0 ){
  32529. closePendingFds(pFile);
  32530. }
  32531. }
  32532. }
  32533. unixLeaveMutex();
  32534. if( rc==SQLITE_OK ) pFile->eFileLock = eFileLock;
  32535. return rc;
  32536. }
  32537. /*
  32538. ** Close a file & cleanup AFP specific locking context
  32539. */
  32540. static int afpClose(sqlite3_file *id) {
  32541. int rc = SQLITE_OK;
  32542. unixFile *pFile = (unixFile*)id;
  32543. assert( id!=0 );
  32544. afpUnlock(id, NO_LOCK);
  32545. unixEnterMutex();
  32546. if( pFile->pInode && pFile->pInode->nLock ){
  32547. /* If there are outstanding locks, do not actually close the file just
  32548. ** yet because that would clear those locks. Instead, add the file
  32549. ** descriptor to pInode->aPending. It will be automatically closed when
  32550. ** the last lock is cleared.
  32551. */
  32552. setPendingFd(pFile);
  32553. }
  32554. releaseInodeInfo(pFile);
  32555. sqlite3_free(pFile->lockingContext);
  32556. rc = closeUnixFile(id);
  32557. unixLeaveMutex();
  32558. return rc;
  32559. }
  32560. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  32561. /*
  32562. ** The code above is the AFP lock implementation. The code is specific
  32563. ** to MacOSX and does not work on other unix platforms. No alternative
  32564. ** is available. If you don't compile for a mac, then the "unix-afp"
  32565. ** VFS is not available.
  32566. **
  32567. ********************* End of the AFP lock implementation **********************
  32568. ******************************************************************************/
  32569. /******************************************************************************
  32570. *************************** Begin NFS Locking ********************************/
  32571. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  32572. /*
  32573. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  32574. ** must be either NO_LOCK or SHARED_LOCK.
  32575. **
  32576. ** If the locking level of the file descriptor is already at or below
  32577. ** the requested locking level, this routine is a no-op.
  32578. */
  32579. static int nfsUnlock(sqlite3_file *id, int eFileLock){
  32580. return posixUnlock(id, eFileLock, 1);
  32581. }
  32582. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  32583. /*
  32584. ** The code above is the NFS lock implementation. The code is specific
  32585. ** to MacOSX and does not work on other unix platforms. No alternative
  32586. ** is available.
  32587. **
  32588. ********************* End of the NFS lock implementation **********************
  32589. ******************************************************************************/
  32590. /******************************************************************************
  32591. **************** Non-locking sqlite3_file methods *****************************
  32592. **
  32593. ** The next division contains implementations for all methods of the
  32594. ** sqlite3_file object other than the locking methods. The locking
  32595. ** methods were defined in divisions above (one locking method per
  32596. ** division). Those methods that are common to all locking modes
  32597. ** are gather together into this division.
  32598. */
  32599. /*
  32600. ** Seek to the offset passed as the second argument, then read cnt
  32601. ** bytes into pBuf. Return the number of bytes actually read.
  32602. **
  32603. ** NB: If you define USE_PREAD or USE_PREAD64, then it might also
  32604. ** be necessary to define _XOPEN_SOURCE to be 500. This varies from
  32605. ** one system to another. Since SQLite does not define USE_PREAD
  32606. ** in any form by default, we will not attempt to define _XOPEN_SOURCE.
  32607. ** See tickets #2741 and #2681.
  32608. **
  32609. ** To avoid stomping the errno value on a failed read the lastErrno value
  32610. ** is set before returning.
  32611. */
  32612. static int seekAndRead(unixFile *id, sqlite3_int64 offset, void *pBuf, int cnt){
  32613. int got;
  32614. int prior = 0;
  32615. #if (!defined(USE_PREAD) && !defined(USE_PREAD64))
  32616. i64 newOffset;
  32617. #endif
  32618. TIMER_START;
  32619. assert( cnt==(cnt&0x1ffff) );
  32620. assert( id->h>2 );
  32621. do{
  32622. #if defined(USE_PREAD)
  32623. got = osPread(id->h, pBuf, cnt, offset);
  32624. SimulateIOError( got = -1 );
  32625. #elif defined(USE_PREAD64)
  32626. got = osPread64(id->h, pBuf, cnt, offset);
  32627. SimulateIOError( got = -1 );
  32628. #else
  32629. newOffset = lseek(id->h, offset, SEEK_SET);
  32630. SimulateIOError( newOffset = -1 );
  32631. if( newOffset<0 ){
  32632. storeLastErrno((unixFile*)id, errno);
  32633. return -1;
  32634. }
  32635. got = osRead(id->h, pBuf, cnt);
  32636. #endif
  32637. if( got==cnt ) break;
  32638. if( got<0 ){
  32639. if( errno==EINTR ){ got = 1; continue; }
  32640. prior = 0;
  32641. storeLastErrno((unixFile*)id, errno);
  32642. break;
  32643. }else if( got>0 ){
  32644. cnt -= got;
  32645. offset += got;
  32646. prior += got;
  32647. pBuf = (void*)(got + (char*)pBuf);
  32648. }
  32649. }while( got>0 );
  32650. TIMER_END;
  32651. OSTRACE(("READ %-3d %5d %7lld %llu\n",
  32652. id->h, got+prior, offset-prior, TIMER_ELAPSED));
  32653. return got+prior;
  32654. }
  32655. /*
  32656. ** Read data from a file into a buffer. Return SQLITE_OK if all
  32657. ** bytes were read successfully and SQLITE_IOERR if anything goes
  32658. ** wrong.
  32659. */
  32660. static int unixRead(
  32661. sqlite3_file *id,
  32662. void *pBuf,
  32663. int amt,
  32664. sqlite3_int64 offset
  32665. ){
  32666. unixFile *pFile = (unixFile *)id;
  32667. int got;
  32668. assert( id );
  32669. assert( offset>=0 );
  32670. assert( amt>0 );
  32671. /* If this is a database file (not a journal, master-journal or temp
  32672. ** file), the bytes in the locking range should never be read or written. */
  32673. #if 0
  32674. assert( pFile->pPreallocatedUnused==0
  32675. || offset>=PENDING_BYTE+512
  32676. || offset+amt<=PENDING_BYTE
  32677. );
  32678. #endif
  32679. #if SQLITE_MAX_MMAP_SIZE>0
  32680. /* Deal with as much of this read request as possible by transfering
  32681. ** data from the memory mapping using memcpy(). */
  32682. if( offset<pFile->mmapSize ){
  32683. if( offset+amt <= pFile->mmapSize ){
  32684. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], amt);
  32685. return SQLITE_OK;
  32686. }else{
  32687. int nCopy = pFile->mmapSize - offset;
  32688. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], nCopy);
  32689. pBuf = &((u8 *)pBuf)[nCopy];
  32690. amt -= nCopy;
  32691. offset += nCopy;
  32692. }
  32693. }
  32694. #endif
  32695. got = seekAndRead(pFile, offset, pBuf, amt);
  32696. if( got==amt ){
  32697. return SQLITE_OK;
  32698. }else if( got<0 ){
  32699. /* lastErrno set by seekAndRead */
  32700. return SQLITE_IOERR_READ;
  32701. }else{
  32702. storeLastErrno(pFile, 0); /* not a system error */
  32703. /* Unread parts of the buffer must be zero-filled */
  32704. memset(&((char*)pBuf)[got], 0, amt-got);
  32705. return SQLITE_IOERR_SHORT_READ;
  32706. }
  32707. }
  32708. /*
  32709. ** Attempt to seek the file-descriptor passed as the first argument to
  32710. ** absolute offset iOff, then attempt to write nBuf bytes of data from
  32711. ** pBuf to it. If an error occurs, return -1 and set *piErrno. Otherwise,
  32712. ** return the actual number of bytes written (which may be less than
  32713. ** nBuf).
  32714. */
  32715. static int seekAndWriteFd(
  32716. int fd, /* File descriptor to write to */
  32717. i64 iOff, /* File offset to begin writing at */
  32718. const void *pBuf, /* Copy data from this buffer to the file */
  32719. int nBuf, /* Size of buffer pBuf in bytes */
  32720. int *piErrno /* OUT: Error number if error occurs */
  32721. ){
  32722. int rc = 0; /* Value returned by system call */
  32723. assert( nBuf==(nBuf&0x1ffff) );
  32724. assert( fd>2 );
  32725. assert( piErrno!=0 );
  32726. nBuf &= 0x1ffff;
  32727. TIMER_START;
  32728. #if defined(USE_PREAD)
  32729. do{ rc = (int)osPwrite(fd, pBuf, nBuf, iOff); }while( rc<0 && errno==EINTR );
  32730. #elif defined(USE_PREAD64)
  32731. do{ rc = (int)osPwrite64(fd, pBuf, nBuf, iOff);}while( rc<0 && errno==EINTR);
  32732. #else
  32733. do{
  32734. i64 iSeek = lseek(fd, iOff, SEEK_SET);
  32735. SimulateIOError( iSeek = -1 );
  32736. if( iSeek<0 ){
  32737. rc = -1;
  32738. break;
  32739. }
  32740. rc = osWrite(fd, pBuf, nBuf);
  32741. }while( rc<0 && errno==EINTR );
  32742. #endif
  32743. TIMER_END;
  32744. OSTRACE(("WRITE %-3d %5d %7lld %llu\n", fd, rc, iOff, TIMER_ELAPSED));
  32745. if( rc<0 ) *piErrno = errno;
  32746. return rc;
  32747. }
  32748. /*
  32749. ** Seek to the offset in id->offset then read cnt bytes into pBuf.
  32750. ** Return the number of bytes actually read. Update the offset.
  32751. **
  32752. ** To avoid stomping the errno value on a failed write the lastErrno value
  32753. ** is set before returning.
  32754. */
  32755. static int seekAndWrite(unixFile *id, i64 offset, const void *pBuf, int cnt){
  32756. return seekAndWriteFd(id->h, offset, pBuf, cnt, &id->lastErrno);
  32757. }
  32758. /*
  32759. ** Write data from a buffer into a file. Return SQLITE_OK on success
  32760. ** or some other error code on failure.
  32761. */
  32762. static int unixWrite(
  32763. sqlite3_file *id,
  32764. const void *pBuf,
  32765. int amt,
  32766. sqlite3_int64 offset
  32767. ){
  32768. unixFile *pFile = (unixFile*)id;
  32769. int wrote = 0;
  32770. assert( id );
  32771. assert( amt>0 );
  32772. /* If this is a database file (not a journal, master-journal or temp
  32773. ** file), the bytes in the locking range should never be read or written. */
  32774. #if 0
  32775. assert( pFile->pPreallocatedUnused==0
  32776. || offset>=PENDING_BYTE+512
  32777. || offset+amt<=PENDING_BYTE
  32778. );
  32779. #endif
  32780. #ifdef SQLITE_DEBUG
  32781. /* If we are doing a normal write to a database file (as opposed to
  32782. ** doing a hot-journal rollback or a write to some file other than a
  32783. ** normal database file) then record the fact that the database
  32784. ** has changed. If the transaction counter is modified, record that
  32785. ** fact too.
  32786. */
  32787. if( pFile->inNormalWrite ){
  32788. pFile->dbUpdate = 1; /* The database has been modified */
  32789. if( offset<=24 && offset+amt>=27 ){
  32790. int rc;
  32791. char oldCntr[4];
  32792. SimulateIOErrorBenign(1);
  32793. rc = seekAndRead(pFile, 24, oldCntr, 4);
  32794. SimulateIOErrorBenign(0);
  32795. if( rc!=4 || memcmp(oldCntr, &((char*)pBuf)[24-offset], 4)!=0 ){
  32796. pFile->transCntrChng = 1; /* The transaction counter has changed */
  32797. }
  32798. }
  32799. }
  32800. #endif
  32801. #if defined(SQLITE_MMAP_READWRITE) && SQLITE_MAX_MMAP_SIZE>0
  32802. /* Deal with as much of this write request as possible by transfering
  32803. ** data from the memory mapping using memcpy(). */
  32804. if( offset<pFile->mmapSize ){
  32805. if( offset+amt <= pFile->mmapSize ){
  32806. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, amt);
  32807. return SQLITE_OK;
  32808. }else{
  32809. int nCopy = pFile->mmapSize - offset;
  32810. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, nCopy);
  32811. pBuf = &((u8 *)pBuf)[nCopy];
  32812. amt -= nCopy;
  32813. offset += nCopy;
  32814. }
  32815. }
  32816. #endif
  32817. while( (wrote = seekAndWrite(pFile, offset, pBuf, amt))<amt && wrote>0 ){
  32818. amt -= wrote;
  32819. offset += wrote;
  32820. pBuf = &((char*)pBuf)[wrote];
  32821. }
  32822. SimulateIOError(( wrote=(-1), amt=1 ));
  32823. SimulateDiskfullError(( wrote=0, amt=1 ));
  32824. if( amt>wrote ){
  32825. if( wrote<0 && pFile->lastErrno!=ENOSPC ){
  32826. /* lastErrno set by seekAndWrite */
  32827. return SQLITE_IOERR_WRITE;
  32828. }else{
  32829. storeLastErrno(pFile, 0); /* not a system error */
  32830. return SQLITE_FULL;
  32831. }
  32832. }
  32833. return SQLITE_OK;
  32834. }
  32835. #ifdef SQLITE_TEST
  32836. /*
  32837. ** Count the number of fullsyncs and normal syncs. This is used to test
  32838. ** that syncs and fullsyncs are occurring at the right times.
  32839. */
  32840. SQLITE_API int sqlite3_sync_count = 0;
  32841. SQLITE_API int sqlite3_fullsync_count = 0;
  32842. #endif
  32843. /*
  32844. ** We do not trust systems to provide a working fdatasync(). Some do.
  32845. ** Others do no. To be safe, we will stick with the (slightly slower)
  32846. ** fsync(). If you know that your system does support fdatasync() correctly,
  32847. ** then simply compile with -Dfdatasync=fdatasync or -DHAVE_FDATASYNC
  32848. */
  32849. #if !defined(fdatasync) && !HAVE_FDATASYNC
  32850. # define fdatasync fsync
  32851. #endif
  32852. /*
  32853. ** Define HAVE_FULLFSYNC to 0 or 1 depending on whether or not
  32854. ** the F_FULLFSYNC macro is defined. F_FULLFSYNC is currently
  32855. ** only available on Mac OS X. But that could change.
  32856. */
  32857. #ifdef F_FULLFSYNC
  32858. # define HAVE_FULLFSYNC 1
  32859. #else
  32860. # define HAVE_FULLFSYNC 0
  32861. #endif
  32862. /*
  32863. ** The fsync() system call does not work as advertised on many
  32864. ** unix systems. The following procedure is an attempt to make
  32865. ** it work better.
  32866. **
  32867. ** The SQLITE_NO_SYNC macro disables all fsync()s. This is useful
  32868. ** for testing when we want to run through the test suite quickly.
  32869. ** You are strongly advised *not* to deploy with SQLITE_NO_SYNC
  32870. ** enabled, however, since with SQLITE_NO_SYNC enabled, an OS crash
  32871. ** or power failure will likely corrupt the database file.
  32872. **
  32873. ** SQLite sets the dataOnly flag if the size of the file is unchanged.
  32874. ** The idea behind dataOnly is that it should only write the file content
  32875. ** to disk, not the inode. We only set dataOnly if the file size is
  32876. ** unchanged since the file size is part of the inode. However,
  32877. ** Ted Ts'o tells us that fdatasync() will also write the inode if the
  32878. ** file size has changed. The only real difference between fdatasync()
  32879. ** and fsync(), Ted tells us, is that fdatasync() will not flush the
  32880. ** inode if the mtime or owner or other inode attributes have changed.
  32881. ** We only care about the file size, not the other file attributes, so
  32882. ** as far as SQLite is concerned, an fdatasync() is always adequate.
  32883. ** So, we always use fdatasync() if it is available, regardless of
  32884. ** the value of the dataOnly flag.
  32885. */
  32886. static int full_fsync(int fd, int fullSync, int dataOnly){
  32887. int rc;
  32888. /* The following "ifdef/elif/else/" block has the same structure as
  32889. ** the one below. It is replicated here solely to avoid cluttering
  32890. ** up the real code with the UNUSED_PARAMETER() macros.
  32891. */
  32892. #ifdef SQLITE_NO_SYNC
  32893. UNUSED_PARAMETER(fd);
  32894. UNUSED_PARAMETER(fullSync);
  32895. UNUSED_PARAMETER(dataOnly);
  32896. #elif HAVE_FULLFSYNC
  32897. UNUSED_PARAMETER(dataOnly);
  32898. #else
  32899. UNUSED_PARAMETER(fullSync);
  32900. UNUSED_PARAMETER(dataOnly);
  32901. #endif
  32902. /* Record the number of times that we do a normal fsync() and
  32903. ** FULLSYNC. This is used during testing to verify that this procedure
  32904. ** gets called with the correct arguments.
  32905. */
  32906. #ifdef SQLITE_TEST
  32907. if( fullSync ) sqlite3_fullsync_count++;
  32908. sqlite3_sync_count++;
  32909. #endif
  32910. /* If we compiled with the SQLITE_NO_SYNC flag, then syncing is a
  32911. ** no-op. But go ahead and call fstat() to validate the file
  32912. ** descriptor as we need a method to provoke a failure during
  32913. ** coverate testing.
  32914. */
  32915. #ifdef SQLITE_NO_SYNC
  32916. {
  32917. struct stat buf;
  32918. rc = osFstat(fd, &buf);
  32919. }
  32920. #elif HAVE_FULLFSYNC
  32921. if( fullSync ){
  32922. rc = osFcntl(fd, F_FULLFSYNC, 0);
  32923. }else{
  32924. rc = 1;
  32925. }
  32926. /* If the FULLFSYNC failed, fall back to attempting an fsync().
  32927. ** It shouldn't be possible for fullfsync to fail on the local
  32928. ** file system (on OSX), so failure indicates that FULLFSYNC
  32929. ** isn't supported for this file system. So, attempt an fsync
  32930. ** and (for now) ignore the overhead of a superfluous fcntl call.
  32931. ** It'd be better to detect fullfsync support once and avoid
  32932. ** the fcntl call every time sync is called.
  32933. */
  32934. if( rc ) rc = fsync(fd);
  32935. #elif defined(__APPLE__)
  32936. /* fdatasync() on HFS+ doesn't yet flush the file size if it changed correctly
  32937. ** so currently we default to the macro that redefines fdatasync to fsync
  32938. */
  32939. rc = fsync(fd);
  32940. #else
  32941. rc = fdatasync(fd);
  32942. #if OS_VXWORKS
  32943. if( rc==-1 && errno==ENOTSUP ){
  32944. rc = fsync(fd);
  32945. }
  32946. #endif /* OS_VXWORKS */
  32947. #endif /* ifdef SQLITE_NO_SYNC elif HAVE_FULLFSYNC */
  32948. if( OS_VXWORKS && rc!= -1 ){
  32949. rc = 0;
  32950. }
  32951. return rc;
  32952. }
  32953. /*
  32954. ** Open a file descriptor to the directory containing file zFilename.
  32955. ** If successful, *pFd is set to the opened file descriptor and
  32956. ** SQLITE_OK is returned. If an error occurs, either SQLITE_NOMEM
  32957. ** or SQLITE_CANTOPEN is returned and *pFd is set to an undefined
  32958. ** value.
  32959. **
  32960. ** The directory file descriptor is used for only one thing - to
  32961. ** fsync() a directory to make sure file creation and deletion events
  32962. ** are flushed to disk. Such fsyncs are not needed on newer
  32963. ** journaling filesystems, but are required on older filesystems.
  32964. **
  32965. ** This routine can be overridden using the xSetSysCall interface.
  32966. ** The ability to override this routine was added in support of the
  32967. ** chromium sandbox. Opening a directory is a security risk (we are
  32968. ** told) so making it overrideable allows the chromium sandbox to
  32969. ** replace this routine with a harmless no-op. To make this routine
  32970. ** a no-op, replace it with a stub that returns SQLITE_OK but leaves
  32971. ** *pFd set to a negative number.
  32972. **
  32973. ** If SQLITE_OK is returned, the caller is responsible for closing
  32974. ** the file descriptor *pFd using close().
  32975. */
  32976. static int openDirectory(const char *zFilename, int *pFd){
  32977. int ii;
  32978. int fd = -1;
  32979. char zDirname[MAX_PATHNAME+1];
  32980. sqlite3_snprintf(MAX_PATHNAME, zDirname, "%s", zFilename);
  32981. for(ii=(int)strlen(zDirname); ii>0 && zDirname[ii]!='/'; ii--);
  32982. if( ii>0 ){
  32983. zDirname[ii] = '\0';
  32984. }else{
  32985. if( zDirname[0]!='/' ) zDirname[0] = '.';
  32986. zDirname[1] = 0;
  32987. }
  32988. fd = robust_open(zDirname, O_RDONLY|O_BINARY, 0);
  32989. if( fd>=0 ){
  32990. OSTRACE(("OPENDIR %-3d %s\n", fd, zDirname));
  32991. }
  32992. *pFd = fd;
  32993. if( fd>=0 ) return SQLITE_OK;
  32994. return unixLogError(SQLITE_CANTOPEN_BKPT, "openDirectory", zDirname);
  32995. }
  32996. /*
  32997. ** Make sure all writes to a particular file are committed to disk.
  32998. **
  32999. ** If dataOnly==0 then both the file itself and its metadata (file
  33000. ** size, access time, etc) are synced. If dataOnly!=0 then only the
  33001. ** file data is synced.
  33002. **
  33003. ** Under Unix, also make sure that the directory entry for the file
  33004. ** has been created by fsync-ing the directory that contains the file.
  33005. ** If we do not do this and we encounter a power failure, the directory
  33006. ** entry for the journal might not exist after we reboot. The next
  33007. ** SQLite to access the file will not know that the journal exists (because
  33008. ** the directory entry for the journal was never created) and the transaction
  33009. ** will not roll back - possibly leading to database corruption.
  33010. */
  33011. static int unixSync(sqlite3_file *id, int flags){
  33012. int rc;
  33013. unixFile *pFile = (unixFile*)id;
  33014. int isDataOnly = (flags&SQLITE_SYNC_DATAONLY);
  33015. int isFullsync = (flags&0x0F)==SQLITE_SYNC_FULL;
  33016. /* Check that one of SQLITE_SYNC_NORMAL or FULL was passed */
  33017. assert((flags&0x0F)==SQLITE_SYNC_NORMAL
  33018. || (flags&0x0F)==SQLITE_SYNC_FULL
  33019. );
  33020. /* Unix cannot, but some systems may return SQLITE_FULL from here. This
  33021. ** line is to test that doing so does not cause any problems.
  33022. */
  33023. SimulateDiskfullError( return SQLITE_FULL );
  33024. assert( pFile );
  33025. OSTRACE(("SYNC %-3d\n", pFile->h));
  33026. rc = full_fsync(pFile->h, isFullsync, isDataOnly);
  33027. SimulateIOError( rc=1 );
  33028. if( rc ){
  33029. storeLastErrno(pFile, errno);
  33030. return unixLogError(SQLITE_IOERR_FSYNC, "full_fsync", pFile->zPath);
  33031. }
  33032. /* Also fsync the directory containing the file if the DIRSYNC flag
  33033. ** is set. This is a one-time occurrence. Many systems (examples: AIX)
  33034. ** are unable to fsync a directory, so ignore errors on the fsync.
  33035. */
  33036. if( pFile->ctrlFlags & UNIXFILE_DIRSYNC ){
  33037. int dirfd;
  33038. OSTRACE(("DIRSYNC %s (have_fullfsync=%d fullsync=%d)\n", pFile->zPath,
  33039. HAVE_FULLFSYNC, isFullsync));
  33040. rc = osOpenDirectory(pFile->zPath, &dirfd);
  33041. if( rc==SQLITE_OK ){
  33042. full_fsync(dirfd, 0, 0);
  33043. robust_close(pFile, dirfd, __LINE__);
  33044. }else{
  33045. assert( rc==SQLITE_CANTOPEN );
  33046. rc = SQLITE_OK;
  33047. }
  33048. pFile->ctrlFlags &= ~UNIXFILE_DIRSYNC;
  33049. }
  33050. return rc;
  33051. }
  33052. /*
  33053. ** Truncate an open file to a specified size
  33054. */
  33055. static int unixTruncate(sqlite3_file *id, i64 nByte){
  33056. unixFile *pFile = (unixFile *)id;
  33057. int rc;
  33058. assert( pFile );
  33059. SimulateIOError( return SQLITE_IOERR_TRUNCATE );
  33060. /* If the user has configured a chunk-size for this file, truncate the
  33061. ** file so that it consists of an integer number of chunks (i.e. the
  33062. ** actual file size after the operation may be larger than the requested
  33063. ** size).
  33064. */
  33065. if( pFile->szChunk>0 ){
  33066. nByte = ((nByte + pFile->szChunk - 1)/pFile->szChunk) * pFile->szChunk;
  33067. }
  33068. rc = robust_ftruncate(pFile->h, nByte);
  33069. if( rc ){
  33070. storeLastErrno(pFile, errno);
  33071. return unixLogError(SQLITE_IOERR_TRUNCATE, "ftruncate", pFile->zPath);
  33072. }else{
  33073. #ifdef SQLITE_DEBUG
  33074. /* If we are doing a normal write to a database file (as opposed to
  33075. ** doing a hot-journal rollback or a write to some file other than a
  33076. ** normal database file) and we truncate the file to zero length,
  33077. ** that effectively updates the change counter. This might happen
  33078. ** when restoring a database using the backup API from a zero-length
  33079. ** source.
  33080. */
  33081. if( pFile->inNormalWrite && nByte==0 ){
  33082. pFile->transCntrChng = 1;
  33083. }
  33084. #endif
  33085. #if SQLITE_MAX_MMAP_SIZE>0
  33086. /* If the file was just truncated to a size smaller than the currently
  33087. ** mapped region, reduce the effective mapping size as well. SQLite will
  33088. ** use read() and write() to access data beyond this point from now on.
  33089. */
  33090. if( nByte<pFile->mmapSize ){
  33091. pFile->mmapSize = nByte;
  33092. }
  33093. #endif
  33094. return SQLITE_OK;
  33095. }
  33096. }
  33097. /*
  33098. ** Determine the current size of a file in bytes
  33099. */
  33100. static int unixFileSize(sqlite3_file *id, i64 *pSize){
  33101. int rc;
  33102. struct stat buf;
  33103. assert( id );
  33104. rc = osFstat(((unixFile*)id)->h, &buf);
  33105. SimulateIOError( rc=1 );
  33106. if( rc!=0 ){
  33107. storeLastErrno((unixFile*)id, errno);
  33108. return SQLITE_IOERR_FSTAT;
  33109. }
  33110. *pSize = buf.st_size;
  33111. /* When opening a zero-size database, the findInodeInfo() procedure
  33112. ** writes a single byte into that file in order to work around a bug
  33113. ** in the OS-X msdos filesystem. In order to avoid problems with upper
  33114. ** layers, we need to report this file size as zero even though it is
  33115. ** really 1. Ticket #3260.
  33116. */
  33117. if( *pSize==1 ) *pSize = 0;
  33118. return SQLITE_OK;
  33119. }
  33120. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  33121. /*
  33122. ** Handler for proxy-locking file-control verbs. Defined below in the
  33123. ** proxying locking division.
  33124. */
  33125. static int proxyFileControl(sqlite3_file*,int,void*);
  33126. #endif
  33127. /*
  33128. ** This function is called to handle the SQLITE_FCNTL_SIZE_HINT
  33129. ** file-control operation. Enlarge the database to nBytes in size
  33130. ** (rounded up to the next chunk-size). If the database is already
  33131. ** nBytes or larger, this routine is a no-op.
  33132. */
  33133. static int fcntlSizeHint(unixFile *pFile, i64 nByte){
  33134. if( pFile->szChunk>0 ){
  33135. i64 nSize; /* Required file size */
  33136. struct stat buf; /* Used to hold return values of fstat() */
  33137. if( osFstat(pFile->h, &buf) ){
  33138. return SQLITE_IOERR_FSTAT;
  33139. }
  33140. nSize = ((nByte+pFile->szChunk-1) / pFile->szChunk) * pFile->szChunk;
  33141. if( nSize>(i64)buf.st_size ){
  33142. #if defined(HAVE_POSIX_FALLOCATE) && HAVE_POSIX_FALLOCATE
  33143. /* The code below is handling the return value of osFallocate()
  33144. ** correctly. posix_fallocate() is defined to "returns zero on success,
  33145. ** or an error number on failure". See the manpage for details. */
  33146. int err;
  33147. do{
  33148. err = osFallocate(pFile->h, buf.st_size, nSize-buf.st_size);
  33149. }while( err==EINTR );
  33150. if( err ) return SQLITE_IOERR_WRITE;
  33151. #else
  33152. /* If the OS does not have posix_fallocate(), fake it. Write a
  33153. ** single byte to the last byte in each block that falls entirely
  33154. ** within the extended region. Then, if required, a single byte
  33155. ** at offset (nSize-1), to set the size of the file correctly.
  33156. ** This is a similar technique to that used by glibc on systems
  33157. ** that do not have a real fallocate() call.
  33158. */
  33159. int nBlk = buf.st_blksize; /* File-system block size */
  33160. int nWrite = 0; /* Number of bytes written by seekAndWrite */
  33161. i64 iWrite; /* Next offset to write to */
  33162. iWrite = (buf.st_size/nBlk)*nBlk + nBlk - 1;
  33163. assert( iWrite>=buf.st_size );
  33164. assert( ((iWrite+1)%nBlk)==0 );
  33165. for(/*no-op*/; iWrite<nSize+nBlk-1; iWrite+=nBlk ){
  33166. if( iWrite>=nSize ) iWrite = nSize - 1;
  33167. nWrite = seekAndWrite(pFile, iWrite, "", 1);
  33168. if( nWrite!=1 ) return SQLITE_IOERR_WRITE;
  33169. }
  33170. #endif
  33171. }
  33172. }
  33173. #if SQLITE_MAX_MMAP_SIZE>0
  33174. if( pFile->mmapSizeMax>0 && nByte>pFile->mmapSize ){
  33175. int rc;
  33176. if( pFile->szChunk<=0 ){
  33177. if( robust_ftruncate(pFile->h, nByte) ){
  33178. storeLastErrno(pFile, errno);
  33179. return unixLogError(SQLITE_IOERR_TRUNCATE, "ftruncate", pFile->zPath);
  33180. }
  33181. }
  33182. rc = unixMapfile(pFile, nByte);
  33183. return rc;
  33184. }
  33185. #endif
  33186. return SQLITE_OK;
  33187. }
  33188. /*
  33189. ** If *pArg is initially negative then this is a query. Set *pArg to
  33190. ** 1 or 0 depending on whether or not bit mask of pFile->ctrlFlags is set.
  33191. **
  33192. ** If *pArg is 0 or 1, then clear or set the mask bit of pFile->ctrlFlags.
  33193. */
  33194. static void unixModeBit(unixFile *pFile, unsigned char mask, int *pArg){
  33195. if( *pArg<0 ){
  33196. *pArg = (pFile->ctrlFlags & mask)!=0;
  33197. }else if( (*pArg)==0 ){
  33198. pFile->ctrlFlags &= ~mask;
  33199. }else{
  33200. pFile->ctrlFlags |= mask;
  33201. }
  33202. }
  33203. /* Forward declaration */
  33204. static int unixGetTempname(int nBuf, char *zBuf);
  33205. /*
  33206. ** Information and control of an open file handle.
  33207. */
  33208. static int unixFileControl(sqlite3_file *id, int op, void *pArg){
  33209. unixFile *pFile = (unixFile*)id;
  33210. switch( op ){
  33211. #if defined(__linux__) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  33212. case SQLITE_FCNTL_BEGIN_ATOMIC_WRITE: {
  33213. int rc = osIoctl(pFile->h, F2FS_IOC_START_ATOMIC_WRITE);
  33214. return rc ? SQLITE_IOERR_BEGIN_ATOMIC : SQLITE_OK;
  33215. }
  33216. case SQLITE_FCNTL_COMMIT_ATOMIC_WRITE: {
  33217. int rc = osIoctl(pFile->h, F2FS_IOC_COMMIT_ATOMIC_WRITE);
  33218. return rc ? SQLITE_IOERR_COMMIT_ATOMIC : SQLITE_OK;
  33219. }
  33220. case SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE: {
  33221. int rc = osIoctl(pFile->h, F2FS_IOC_ABORT_VOLATILE_WRITE);
  33222. return rc ? SQLITE_IOERR_ROLLBACK_ATOMIC : SQLITE_OK;
  33223. }
  33224. #endif /* __linux__ && SQLITE_ENABLE_BATCH_ATOMIC_WRITE */
  33225. case SQLITE_FCNTL_LOCKSTATE: {
  33226. *(int*)pArg = pFile->eFileLock;
  33227. return SQLITE_OK;
  33228. }
  33229. case SQLITE_FCNTL_LAST_ERRNO: {
  33230. *(int*)pArg = pFile->lastErrno;
  33231. return SQLITE_OK;
  33232. }
  33233. case SQLITE_FCNTL_CHUNK_SIZE: {
  33234. pFile->szChunk = *(int *)pArg;
  33235. return SQLITE_OK;
  33236. }
  33237. case SQLITE_FCNTL_SIZE_HINT: {
  33238. int rc;
  33239. SimulateIOErrorBenign(1);
  33240. rc = fcntlSizeHint(pFile, *(i64 *)pArg);
  33241. SimulateIOErrorBenign(0);
  33242. return rc;
  33243. }
  33244. case SQLITE_FCNTL_PERSIST_WAL: {
  33245. unixModeBit(pFile, UNIXFILE_PERSIST_WAL, (int*)pArg);
  33246. return SQLITE_OK;
  33247. }
  33248. case SQLITE_FCNTL_POWERSAFE_OVERWRITE: {
  33249. unixModeBit(pFile, UNIXFILE_PSOW, (int*)pArg);
  33250. return SQLITE_OK;
  33251. }
  33252. case SQLITE_FCNTL_VFSNAME: {
  33253. *(char**)pArg = sqlite3_mprintf("%s", pFile->pVfs->zName);
  33254. return SQLITE_OK;
  33255. }
  33256. case SQLITE_FCNTL_TEMPFILENAME: {
  33257. char *zTFile = sqlite3_malloc64( pFile->pVfs->mxPathname );
  33258. if( zTFile ){
  33259. unixGetTempname(pFile->pVfs->mxPathname, zTFile);
  33260. *(char**)pArg = zTFile;
  33261. }
  33262. return SQLITE_OK;
  33263. }
  33264. case SQLITE_FCNTL_HAS_MOVED: {
  33265. *(int*)pArg = fileHasMoved(pFile);
  33266. return SQLITE_OK;
  33267. }
  33268. #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
  33269. case SQLITE_FCNTL_LOCK_TIMEOUT: {
  33270. pFile->iBusyTimeout = *(int*)pArg;
  33271. return SQLITE_OK;
  33272. }
  33273. #endif
  33274. #if SQLITE_MAX_MMAP_SIZE>0
  33275. case SQLITE_FCNTL_MMAP_SIZE: {
  33276. i64 newLimit = *(i64*)pArg;
  33277. int rc = SQLITE_OK;
  33278. if( newLimit>sqlite3GlobalConfig.mxMmap ){
  33279. newLimit = sqlite3GlobalConfig.mxMmap;
  33280. }
  33281. /* The value of newLimit may be eventually cast to (size_t) and passed
  33282. ** to mmap(). Restrict its value to 2GB if (size_t) is not at least a
  33283. ** 64-bit type. */
  33284. if( newLimit>0 && sizeof(size_t)<8 ){
  33285. newLimit = (newLimit & 0x7FFFFFFF);
  33286. }
  33287. *(i64*)pArg = pFile->mmapSizeMax;
  33288. if( newLimit>=0 && newLimit!=pFile->mmapSizeMax && pFile->nFetchOut==0 ){
  33289. pFile->mmapSizeMax = newLimit;
  33290. if( pFile->mmapSize>0 ){
  33291. unixUnmapfile(pFile);
  33292. rc = unixMapfile(pFile, -1);
  33293. }
  33294. }
  33295. return rc;
  33296. }
  33297. #endif
  33298. #ifdef SQLITE_DEBUG
  33299. /* The pager calls this method to signal that it has done
  33300. ** a rollback and that the database is therefore unchanged and
  33301. ** it hence it is OK for the transaction change counter to be
  33302. ** unchanged.
  33303. */
  33304. case SQLITE_FCNTL_DB_UNCHANGED: {
  33305. ((unixFile*)id)->dbUpdate = 0;
  33306. return SQLITE_OK;
  33307. }
  33308. #endif
  33309. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  33310. case SQLITE_FCNTL_SET_LOCKPROXYFILE:
  33311. case SQLITE_FCNTL_GET_LOCKPROXYFILE: {
  33312. return proxyFileControl(id,op,pArg);
  33313. }
  33314. #endif /* SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__) */
  33315. }
  33316. return SQLITE_NOTFOUND;
  33317. }
  33318. /*
  33319. ** If pFd->sectorSize is non-zero when this function is called, it is a
  33320. ** no-op. Otherwise, the values of pFd->sectorSize and
  33321. ** pFd->deviceCharacteristics are set according to the file-system
  33322. ** characteristics.
  33323. **
  33324. ** There are two versions of this function. One for QNX and one for all
  33325. ** other systems.
  33326. */
  33327. #ifndef __QNXNTO__
  33328. static void setDeviceCharacteristics(unixFile *pFd){
  33329. assert( pFd->deviceCharacteristics==0 || pFd->sectorSize!=0 );
  33330. if( pFd->sectorSize==0 ){
  33331. #if defined(__linux__) && defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  33332. int res;
  33333. u32 f = 0;
  33334. /* Check for support for F2FS atomic batch writes. */
  33335. res = osIoctl(pFd->h, F2FS_IOC_GET_FEATURES, &f);
  33336. if( res==0 && (f & F2FS_FEATURE_ATOMIC_WRITE) ){
  33337. pFd->deviceCharacteristics = SQLITE_IOCAP_BATCH_ATOMIC;
  33338. }
  33339. #endif /* __linux__ && SQLITE_ENABLE_BATCH_ATOMIC_WRITE */
  33340. /* Set the POWERSAFE_OVERWRITE flag if requested. */
  33341. if( pFd->ctrlFlags & UNIXFILE_PSOW ){
  33342. pFd->deviceCharacteristics |= SQLITE_IOCAP_POWERSAFE_OVERWRITE;
  33343. }
  33344. pFd->sectorSize = SQLITE_DEFAULT_SECTOR_SIZE;
  33345. }
  33346. }
  33347. #else
  33348. #include <sys/dcmd_blk.h>
  33349. #include <sys/statvfs.h>
  33350. static void setDeviceCharacteristics(unixFile *pFile){
  33351. if( pFile->sectorSize == 0 ){
  33352. struct statvfs fsInfo;
  33353. /* Set defaults for non-supported filesystems */
  33354. pFile->sectorSize = SQLITE_DEFAULT_SECTOR_SIZE;
  33355. pFile->deviceCharacteristics = 0;
  33356. if( fstatvfs(pFile->h, &fsInfo) == -1 ) {
  33357. return;
  33358. }
  33359. if( !strcmp(fsInfo.f_basetype, "tmp") ) {
  33360. pFile->sectorSize = fsInfo.f_bsize;
  33361. pFile->deviceCharacteristics =
  33362. SQLITE_IOCAP_ATOMIC4K | /* All ram filesystem writes are atomic */
  33363. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  33364. ** the write succeeds */
  33365. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  33366. ** so it is ordered */
  33367. 0;
  33368. }else if( strstr(fsInfo.f_basetype, "etfs") ){
  33369. pFile->sectorSize = fsInfo.f_bsize;
  33370. pFile->deviceCharacteristics =
  33371. /* etfs cluster size writes are atomic */
  33372. (pFile->sectorSize / 512 * SQLITE_IOCAP_ATOMIC512) |
  33373. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  33374. ** the write succeeds */
  33375. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  33376. ** so it is ordered */
  33377. 0;
  33378. }else if( !strcmp(fsInfo.f_basetype, "qnx6") ){
  33379. pFile->sectorSize = fsInfo.f_bsize;
  33380. pFile->deviceCharacteristics =
  33381. SQLITE_IOCAP_ATOMIC | /* All filesystem writes are atomic */
  33382. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  33383. ** the write succeeds */
  33384. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  33385. ** so it is ordered */
  33386. 0;
  33387. }else if( !strcmp(fsInfo.f_basetype, "qnx4") ){
  33388. pFile->sectorSize = fsInfo.f_bsize;
  33389. pFile->deviceCharacteristics =
  33390. /* full bitset of atomics from max sector size and smaller */
  33391. ((pFile->sectorSize / 512 * SQLITE_IOCAP_ATOMIC512) << 1) - 2 |
  33392. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  33393. ** so it is ordered */
  33394. 0;
  33395. }else if( strstr(fsInfo.f_basetype, "dos") ){
  33396. pFile->sectorSize = fsInfo.f_bsize;
  33397. pFile->deviceCharacteristics =
  33398. /* full bitset of atomics from max sector size and smaller */
  33399. ((pFile->sectorSize / 512 * SQLITE_IOCAP_ATOMIC512) << 1) - 2 |
  33400. SQLITE_IOCAP_SEQUENTIAL | /* The ram filesystem has no write behind
  33401. ** so it is ordered */
  33402. 0;
  33403. }else{
  33404. pFile->deviceCharacteristics =
  33405. SQLITE_IOCAP_ATOMIC512 | /* blocks are atomic */
  33406. SQLITE_IOCAP_SAFE_APPEND | /* growing the file does not occur until
  33407. ** the write succeeds */
  33408. 0;
  33409. }
  33410. }
  33411. /* Last chance verification. If the sector size isn't a multiple of 512
  33412. ** then it isn't valid.*/
  33413. if( pFile->sectorSize % 512 != 0 ){
  33414. pFile->deviceCharacteristics = 0;
  33415. pFile->sectorSize = SQLITE_DEFAULT_SECTOR_SIZE;
  33416. }
  33417. }
  33418. #endif
  33419. /*
  33420. ** Return the sector size in bytes of the underlying block device for
  33421. ** the specified file. This is almost always 512 bytes, but may be
  33422. ** larger for some devices.
  33423. **
  33424. ** SQLite code assumes this function cannot fail. It also assumes that
  33425. ** if two files are created in the same file-system directory (i.e.
  33426. ** a database and its journal file) that the sector size will be the
  33427. ** same for both.
  33428. */
  33429. static int unixSectorSize(sqlite3_file *id){
  33430. unixFile *pFd = (unixFile*)id;
  33431. setDeviceCharacteristics(pFd);
  33432. return pFd->sectorSize;
  33433. }
  33434. /*
  33435. ** Return the device characteristics for the file.
  33436. **
  33437. ** This VFS is set up to return SQLITE_IOCAP_POWERSAFE_OVERWRITE by default.
  33438. ** However, that choice is controversial since technically the underlying
  33439. ** file system does not always provide powersafe overwrites. (In other
  33440. ** words, after a power-loss event, parts of the file that were never
  33441. ** written might end up being altered.) However, non-PSOW behavior is very,
  33442. ** very rare. And asserting PSOW makes a large reduction in the amount
  33443. ** of required I/O for journaling, since a lot of padding is eliminated.
  33444. ** Hence, while POWERSAFE_OVERWRITE is on by default, there is a file-control
  33445. ** available to turn it off and URI query parameter available to turn it off.
  33446. */
  33447. static int unixDeviceCharacteristics(sqlite3_file *id){
  33448. unixFile *pFd = (unixFile*)id;
  33449. setDeviceCharacteristics(pFd);
  33450. return pFd->deviceCharacteristics;
  33451. }
  33452. #if !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  33453. /*
  33454. ** Return the system page size.
  33455. **
  33456. ** This function should not be called directly by other code in this file.
  33457. ** Instead, it should be called via macro osGetpagesize().
  33458. */
  33459. static int unixGetpagesize(void){
  33460. #if OS_VXWORKS
  33461. return 1024;
  33462. #elif defined(_BSD_SOURCE)
  33463. return getpagesize();
  33464. #else
  33465. return (int)sysconf(_SC_PAGESIZE);
  33466. #endif
  33467. }
  33468. #endif /* !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0 */
  33469. #ifndef SQLITE_OMIT_WAL
  33470. /*
  33471. ** Object used to represent an shared memory buffer.
  33472. **
  33473. ** When multiple threads all reference the same wal-index, each thread
  33474. ** has its own unixShm object, but they all point to a single instance
  33475. ** of this unixShmNode object. In other words, each wal-index is opened
  33476. ** only once per process.
  33477. **
  33478. ** Each unixShmNode object is connected to a single unixInodeInfo object.
  33479. ** We could coalesce this object into unixInodeInfo, but that would mean
  33480. ** every open file that does not use shared memory (in other words, most
  33481. ** open files) would have to carry around this extra information. So
  33482. ** the unixInodeInfo object contains a pointer to this unixShmNode object
  33483. ** and the unixShmNode object is created only when needed.
  33484. **
  33485. ** unixMutexHeld() must be true when creating or destroying
  33486. ** this object or while reading or writing the following fields:
  33487. **
  33488. ** nRef
  33489. **
  33490. ** The following fields are read-only after the object is created:
  33491. **
  33492. ** fid
  33493. ** zFilename
  33494. **
  33495. ** Either unixShmNode.mutex must be held or unixShmNode.nRef==0 and
  33496. ** unixMutexHeld() is true when reading or writing any other field
  33497. ** in this structure.
  33498. */
  33499. struct unixShmNode {
  33500. unixInodeInfo *pInode; /* unixInodeInfo that owns this SHM node */
  33501. sqlite3_mutex *mutex; /* Mutex to access this object */
  33502. char *zFilename; /* Name of the mmapped file */
  33503. int h; /* Open file descriptor */
  33504. int szRegion; /* Size of shared-memory regions */
  33505. u16 nRegion; /* Size of array apRegion */
  33506. u8 isReadonly; /* True if read-only */
  33507. u8 isUnlocked; /* True if no DMS lock held */
  33508. char **apRegion; /* Array of mapped shared-memory regions */
  33509. int nRef; /* Number of unixShm objects pointing to this */
  33510. unixShm *pFirst; /* All unixShm objects pointing to this */
  33511. #ifdef SQLITE_DEBUG
  33512. u8 exclMask; /* Mask of exclusive locks held */
  33513. u8 sharedMask; /* Mask of shared locks held */
  33514. u8 nextShmId; /* Next available unixShm.id value */
  33515. #endif
  33516. };
  33517. /*
  33518. ** Structure used internally by this VFS to record the state of an
  33519. ** open shared memory connection.
  33520. **
  33521. ** The following fields are initialized when this object is created and
  33522. ** are read-only thereafter:
  33523. **
  33524. ** unixShm.pFile
  33525. ** unixShm.id
  33526. **
  33527. ** All other fields are read/write. The unixShm.pFile->mutex must be held
  33528. ** while accessing any read/write fields.
  33529. */
  33530. struct unixShm {
  33531. unixShmNode *pShmNode; /* The underlying unixShmNode object */
  33532. unixShm *pNext; /* Next unixShm with the same unixShmNode */
  33533. u8 hasMutex; /* True if holding the unixShmNode mutex */
  33534. u8 id; /* Id of this connection within its unixShmNode */
  33535. u16 sharedMask; /* Mask of shared locks held */
  33536. u16 exclMask; /* Mask of exclusive locks held */
  33537. };
  33538. /*
  33539. ** Constants used for locking
  33540. */
  33541. #define UNIX_SHM_BASE ((22+SQLITE_SHM_NLOCK)*4) /* first lock byte */
  33542. #define UNIX_SHM_DMS (UNIX_SHM_BASE+SQLITE_SHM_NLOCK) /* deadman switch */
  33543. /*
  33544. ** Apply posix advisory locks for all bytes from ofst through ofst+n-1.
  33545. **
  33546. ** Locks block if the mask is exactly UNIX_SHM_C and are non-blocking
  33547. ** otherwise.
  33548. */
  33549. static int unixShmSystemLock(
  33550. unixFile *pFile, /* Open connection to the WAL file */
  33551. int lockType, /* F_UNLCK, F_RDLCK, or F_WRLCK */
  33552. int ofst, /* First byte of the locking range */
  33553. int n /* Number of bytes to lock */
  33554. ){
  33555. unixShmNode *pShmNode; /* Apply locks to this open shared-memory segment */
  33556. struct flock f; /* The posix advisory locking structure */
  33557. int rc = SQLITE_OK; /* Result code form fcntl() */
  33558. /* Access to the unixShmNode object is serialized by the caller */
  33559. pShmNode = pFile->pInode->pShmNode;
  33560. assert( pShmNode->nRef==0 || sqlite3_mutex_held(pShmNode->mutex) );
  33561. /* Shared locks never span more than one byte */
  33562. assert( n==1 || lockType!=F_RDLCK );
  33563. /* Locks are within range */
  33564. assert( n>=1 && n<=SQLITE_SHM_NLOCK );
  33565. if( pShmNode->h>=0 ){
  33566. /* Initialize the locking parameters */
  33567. f.l_type = lockType;
  33568. f.l_whence = SEEK_SET;
  33569. f.l_start = ofst;
  33570. f.l_len = n;
  33571. rc = osSetPosixAdvisoryLock(pShmNode->h, &f, pFile);
  33572. rc = (rc!=(-1)) ? SQLITE_OK : SQLITE_BUSY;
  33573. }
  33574. /* Update the global lock state and do debug tracing */
  33575. #ifdef SQLITE_DEBUG
  33576. { u16 mask;
  33577. OSTRACE(("SHM-LOCK "));
  33578. mask = ofst>31 ? 0xffff : (1<<(ofst+n)) - (1<<ofst);
  33579. if( rc==SQLITE_OK ){
  33580. if( lockType==F_UNLCK ){
  33581. OSTRACE(("unlock %d ok", ofst));
  33582. pShmNode->exclMask &= ~mask;
  33583. pShmNode->sharedMask &= ~mask;
  33584. }else if( lockType==F_RDLCK ){
  33585. OSTRACE(("read-lock %d ok", ofst));
  33586. pShmNode->exclMask &= ~mask;
  33587. pShmNode->sharedMask |= mask;
  33588. }else{
  33589. assert( lockType==F_WRLCK );
  33590. OSTRACE(("write-lock %d ok", ofst));
  33591. pShmNode->exclMask |= mask;
  33592. pShmNode->sharedMask &= ~mask;
  33593. }
  33594. }else{
  33595. if( lockType==F_UNLCK ){
  33596. OSTRACE(("unlock %d failed", ofst));
  33597. }else if( lockType==F_RDLCK ){
  33598. OSTRACE(("read-lock failed"));
  33599. }else{
  33600. assert( lockType==F_WRLCK );
  33601. OSTRACE(("write-lock %d failed", ofst));
  33602. }
  33603. }
  33604. OSTRACE((" - afterwards %03x,%03x\n",
  33605. pShmNode->sharedMask, pShmNode->exclMask));
  33606. }
  33607. #endif
  33608. return rc;
  33609. }
  33610. /*
  33611. ** Return the minimum number of 32KB shm regions that should be mapped at
  33612. ** a time, assuming that each mapping must be an integer multiple of the
  33613. ** current system page-size.
  33614. **
  33615. ** Usually, this is 1. The exception seems to be systems that are configured
  33616. ** to use 64KB pages - in this case each mapping must cover at least two
  33617. ** shm regions.
  33618. */
  33619. static int unixShmRegionPerMap(void){
  33620. int shmsz = 32*1024; /* SHM region size */
  33621. int pgsz = osGetpagesize(); /* System page size */
  33622. assert( ((pgsz-1)&pgsz)==0 ); /* Page size must be a power of 2 */
  33623. if( pgsz<shmsz ) return 1;
  33624. return pgsz/shmsz;
  33625. }
  33626. /*
  33627. ** Purge the unixShmNodeList list of all entries with unixShmNode.nRef==0.
  33628. **
  33629. ** This is not a VFS shared-memory method; it is a utility function called
  33630. ** by VFS shared-memory methods.
  33631. */
  33632. static void unixShmPurge(unixFile *pFd){
  33633. unixShmNode *p = pFd->pInode->pShmNode;
  33634. assert( unixMutexHeld() );
  33635. if( p && ALWAYS(p->nRef==0) ){
  33636. int nShmPerMap = unixShmRegionPerMap();
  33637. int i;
  33638. assert( p->pInode==pFd->pInode );
  33639. sqlite3_mutex_free(p->mutex);
  33640. for(i=0; i<p->nRegion; i+=nShmPerMap){
  33641. if( p->h>=0 ){
  33642. osMunmap(p->apRegion[i], p->szRegion);
  33643. }else{
  33644. sqlite3_free(p->apRegion[i]);
  33645. }
  33646. }
  33647. sqlite3_free(p->apRegion);
  33648. if( p->h>=0 ){
  33649. robust_close(pFd, p->h, __LINE__);
  33650. p->h = -1;
  33651. }
  33652. p->pInode->pShmNode = 0;
  33653. sqlite3_free(p);
  33654. }
  33655. }
  33656. /*
  33657. ** The DMS lock has not yet been taken on shm file pShmNode. Attempt to
  33658. ** take it now. Return SQLITE_OK if successful, or an SQLite error
  33659. ** code otherwise.
  33660. **
  33661. ** If the DMS cannot be locked because this is a readonly_shm=1
  33662. ** connection and no other process already holds a lock, return
  33663. ** SQLITE_READONLY_CANTINIT and set pShmNode->isUnlocked=1.
  33664. */
  33665. static int unixLockSharedMemory(unixFile *pDbFd, unixShmNode *pShmNode){
  33666. struct flock lock;
  33667. int rc = SQLITE_OK;
  33668. /* Use F_GETLK to determine the locks other processes are holding
  33669. ** on the DMS byte. If it indicates that another process is holding
  33670. ** a SHARED lock, then this process may also take a SHARED lock
  33671. ** and proceed with opening the *-shm file.
  33672. **
  33673. ** Or, if no other process is holding any lock, then this process
  33674. ** is the first to open it. In this case take an EXCLUSIVE lock on the
  33675. ** DMS byte and truncate the *-shm file to zero bytes in size. Then
  33676. ** downgrade to a SHARED lock on the DMS byte.
  33677. **
  33678. ** If another process is holding an EXCLUSIVE lock on the DMS byte,
  33679. ** return SQLITE_BUSY to the caller (it will try again). An earlier
  33680. ** version of this code attempted the SHARED lock at this point. But
  33681. ** this introduced a subtle race condition: if the process holding
  33682. ** EXCLUSIVE failed just before truncating the *-shm file, then this
  33683. ** process might open and use the *-shm file without truncating it.
  33684. ** And if the *-shm file has been corrupted by a power failure or
  33685. ** system crash, the database itself may also become corrupt. */
  33686. lock.l_whence = SEEK_SET;
  33687. lock.l_start = UNIX_SHM_DMS;
  33688. lock.l_len = 1;
  33689. lock.l_type = F_WRLCK;
  33690. if( osFcntl(pShmNode->h, F_GETLK, &lock)!=0 ) {
  33691. rc = SQLITE_IOERR_LOCK;
  33692. }else if( lock.l_type==F_UNLCK ){
  33693. if( pShmNode->isReadonly ){
  33694. pShmNode->isUnlocked = 1;
  33695. rc = SQLITE_READONLY_CANTINIT;
  33696. }else{
  33697. rc = unixShmSystemLock(pDbFd, F_WRLCK, UNIX_SHM_DMS, 1);
  33698. if( rc==SQLITE_OK && robust_ftruncate(pShmNode->h, 0) ){
  33699. rc = unixLogError(SQLITE_IOERR_SHMOPEN,"ftruncate",pShmNode->zFilename);
  33700. }
  33701. }
  33702. }else if( lock.l_type==F_WRLCK ){
  33703. rc = SQLITE_BUSY;
  33704. }
  33705. if( rc==SQLITE_OK ){
  33706. assert( lock.l_type==F_UNLCK || lock.l_type==F_RDLCK );
  33707. rc = unixShmSystemLock(pDbFd, F_RDLCK, UNIX_SHM_DMS, 1);
  33708. }
  33709. return rc;
  33710. }
  33711. /*
  33712. ** Open a shared-memory area associated with open database file pDbFd.
  33713. ** This particular implementation uses mmapped files.
  33714. **
  33715. ** The file used to implement shared-memory is in the same directory
  33716. ** as the open database file and has the same name as the open database
  33717. ** file with the "-shm" suffix added. For example, if the database file
  33718. ** is "/home/user1/config.db" then the file that is created and mmapped
  33719. ** for shared memory will be called "/home/user1/config.db-shm".
  33720. **
  33721. ** Another approach to is to use files in /dev/shm or /dev/tmp or an
  33722. ** some other tmpfs mount. But if a file in a different directory
  33723. ** from the database file is used, then differing access permissions
  33724. ** or a chroot() might cause two different processes on the same
  33725. ** database to end up using different files for shared memory -
  33726. ** meaning that their memory would not really be shared - resulting
  33727. ** in database corruption. Nevertheless, this tmpfs file usage
  33728. ** can be enabled at compile-time using -DSQLITE_SHM_DIRECTORY="/dev/shm"
  33729. ** or the equivalent. The use of the SQLITE_SHM_DIRECTORY compile-time
  33730. ** option results in an incompatible build of SQLite; builds of SQLite
  33731. ** that with differing SQLITE_SHM_DIRECTORY settings attempt to use the
  33732. ** same database file at the same time, database corruption will likely
  33733. ** result. The SQLITE_SHM_DIRECTORY compile-time option is considered
  33734. ** "unsupported" and may go away in a future SQLite release.
  33735. **
  33736. ** When opening a new shared-memory file, if no other instances of that
  33737. ** file are currently open, in this process or in other processes, then
  33738. ** the file must be truncated to zero length or have its header cleared.
  33739. **
  33740. ** If the original database file (pDbFd) is using the "unix-excl" VFS
  33741. ** that means that an exclusive lock is held on the database file and
  33742. ** that no other processes are able to read or write the database. In
  33743. ** that case, we do not really need shared memory. No shared memory
  33744. ** file is created. The shared memory will be simulated with heap memory.
  33745. */
  33746. static int unixOpenSharedMemory(unixFile *pDbFd){
  33747. struct unixShm *p = 0; /* The connection to be opened */
  33748. struct unixShmNode *pShmNode; /* The underlying mmapped file */
  33749. int rc = SQLITE_OK; /* Result code */
  33750. unixInodeInfo *pInode; /* The inode of fd */
  33751. char *zShm; /* Name of the file used for SHM */
  33752. int nShmFilename; /* Size of the SHM filename in bytes */
  33753. /* Allocate space for the new unixShm object. */
  33754. p = sqlite3_malloc64( sizeof(*p) );
  33755. if( p==0 ) return SQLITE_NOMEM_BKPT;
  33756. memset(p, 0, sizeof(*p));
  33757. assert( pDbFd->pShm==0 );
  33758. /* Check to see if a unixShmNode object already exists. Reuse an existing
  33759. ** one if present. Create a new one if necessary.
  33760. */
  33761. unixEnterMutex();
  33762. pInode = pDbFd->pInode;
  33763. pShmNode = pInode->pShmNode;
  33764. if( pShmNode==0 ){
  33765. struct stat sStat; /* fstat() info for database file */
  33766. #ifndef SQLITE_SHM_DIRECTORY
  33767. const char *zBasePath = pDbFd->zPath;
  33768. #endif
  33769. /* Call fstat() to figure out the permissions on the database file. If
  33770. ** a new *-shm file is created, an attempt will be made to create it
  33771. ** with the same permissions.
  33772. */
  33773. if( osFstat(pDbFd->h, &sStat) ){
  33774. rc = SQLITE_IOERR_FSTAT;
  33775. goto shm_open_err;
  33776. }
  33777. #ifdef SQLITE_SHM_DIRECTORY
  33778. nShmFilename = sizeof(SQLITE_SHM_DIRECTORY) + 31;
  33779. #else
  33780. nShmFilename = 6 + (int)strlen(zBasePath);
  33781. #endif
  33782. pShmNode = sqlite3_malloc64( sizeof(*pShmNode) + nShmFilename );
  33783. if( pShmNode==0 ){
  33784. rc = SQLITE_NOMEM_BKPT;
  33785. goto shm_open_err;
  33786. }
  33787. memset(pShmNode, 0, sizeof(*pShmNode)+nShmFilename);
  33788. zShm = pShmNode->zFilename = (char*)&pShmNode[1];
  33789. #ifdef SQLITE_SHM_DIRECTORY
  33790. sqlite3_snprintf(nShmFilename, zShm,
  33791. SQLITE_SHM_DIRECTORY "/sqlite-shm-%x-%x",
  33792. (u32)sStat.st_ino, (u32)sStat.st_dev);
  33793. #else
  33794. sqlite3_snprintf(nShmFilename, zShm, "%s-shm", zBasePath);
  33795. sqlite3FileSuffix3(pDbFd->zPath, zShm);
  33796. #endif
  33797. pShmNode->h = -1;
  33798. pDbFd->pInode->pShmNode = pShmNode;
  33799. pShmNode->pInode = pDbFd->pInode;
  33800. if( sqlite3GlobalConfig.bCoreMutex ){
  33801. pShmNode->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_FAST);
  33802. if( pShmNode->mutex==0 ){
  33803. rc = SQLITE_NOMEM_BKPT;
  33804. goto shm_open_err;
  33805. }
  33806. }
  33807. if( pInode->bProcessLock==0 ){
  33808. if( 0==sqlite3_uri_boolean(pDbFd->zPath, "readonly_shm", 0) ){
  33809. pShmNode->h = robust_open(zShm, O_RDWR|O_CREAT, (sStat.st_mode&0777));
  33810. }
  33811. if( pShmNode->h<0 ){
  33812. pShmNode->h = robust_open(zShm, O_RDONLY, (sStat.st_mode&0777));
  33813. if( pShmNode->h<0 ){
  33814. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "open", zShm);
  33815. goto shm_open_err;
  33816. }
  33817. pShmNode->isReadonly = 1;
  33818. }
  33819. /* If this process is running as root, make sure that the SHM file
  33820. ** is owned by the same user that owns the original database. Otherwise,
  33821. ** the original owner will not be able to connect.
  33822. */
  33823. robustFchown(pShmNode->h, sStat.st_uid, sStat.st_gid);
  33824. rc = unixLockSharedMemory(pDbFd, pShmNode);
  33825. if( rc!=SQLITE_OK && rc!=SQLITE_READONLY_CANTINIT ) goto shm_open_err;
  33826. }
  33827. }
  33828. /* Make the new connection a child of the unixShmNode */
  33829. p->pShmNode = pShmNode;
  33830. #ifdef SQLITE_DEBUG
  33831. p->id = pShmNode->nextShmId++;
  33832. #endif
  33833. pShmNode->nRef++;
  33834. pDbFd->pShm = p;
  33835. unixLeaveMutex();
  33836. /* The reference count on pShmNode has already been incremented under
  33837. ** the cover of the unixEnterMutex() mutex and the pointer from the
  33838. ** new (struct unixShm) object to the pShmNode has been set. All that is
  33839. ** left to do is to link the new object into the linked list starting
  33840. ** at pShmNode->pFirst. This must be done while holding the pShmNode->mutex
  33841. ** mutex.
  33842. */
  33843. sqlite3_mutex_enter(pShmNode->mutex);
  33844. p->pNext = pShmNode->pFirst;
  33845. pShmNode->pFirst = p;
  33846. sqlite3_mutex_leave(pShmNode->mutex);
  33847. return rc;
  33848. /* Jump here on any error */
  33849. shm_open_err:
  33850. unixShmPurge(pDbFd); /* This call frees pShmNode if required */
  33851. sqlite3_free(p);
  33852. unixLeaveMutex();
  33853. return rc;
  33854. }
  33855. /*
  33856. ** This function is called to obtain a pointer to region iRegion of the
  33857. ** shared-memory associated with the database file fd. Shared-memory regions
  33858. ** are numbered starting from zero. Each shared-memory region is szRegion
  33859. ** bytes in size.
  33860. **
  33861. ** If an error occurs, an error code is returned and *pp is set to NULL.
  33862. **
  33863. ** Otherwise, if the bExtend parameter is 0 and the requested shared-memory
  33864. ** region has not been allocated (by any client, including one running in a
  33865. ** separate process), then *pp is set to NULL and SQLITE_OK returned. If
  33866. ** bExtend is non-zero and the requested shared-memory region has not yet
  33867. ** been allocated, it is allocated by this function.
  33868. **
  33869. ** If the shared-memory region has already been allocated or is allocated by
  33870. ** this call as described above, then it is mapped into this processes
  33871. ** address space (if it is not already), *pp is set to point to the mapped
  33872. ** memory and SQLITE_OK returned.
  33873. */
  33874. static int unixShmMap(
  33875. sqlite3_file *fd, /* Handle open on database file */
  33876. int iRegion, /* Region to retrieve */
  33877. int szRegion, /* Size of regions */
  33878. int bExtend, /* True to extend file if necessary */
  33879. void volatile **pp /* OUT: Mapped memory */
  33880. ){
  33881. unixFile *pDbFd = (unixFile*)fd;
  33882. unixShm *p;
  33883. unixShmNode *pShmNode;
  33884. int rc = SQLITE_OK;
  33885. int nShmPerMap = unixShmRegionPerMap();
  33886. int nReqRegion;
  33887. /* If the shared-memory file has not yet been opened, open it now. */
  33888. if( pDbFd->pShm==0 ){
  33889. rc = unixOpenSharedMemory(pDbFd);
  33890. if( rc!=SQLITE_OK ) return rc;
  33891. }
  33892. p = pDbFd->pShm;
  33893. pShmNode = p->pShmNode;
  33894. sqlite3_mutex_enter(pShmNode->mutex);
  33895. if( pShmNode->isUnlocked ){
  33896. rc = unixLockSharedMemory(pDbFd, pShmNode);
  33897. if( rc!=SQLITE_OK ) goto shmpage_out;
  33898. pShmNode->isUnlocked = 0;
  33899. }
  33900. assert( szRegion==pShmNode->szRegion || pShmNode->nRegion==0 );
  33901. assert( pShmNode->pInode==pDbFd->pInode );
  33902. assert( pShmNode->h>=0 || pDbFd->pInode->bProcessLock==1 );
  33903. assert( pShmNode->h<0 || pDbFd->pInode->bProcessLock==0 );
  33904. /* Minimum number of regions required to be mapped. */
  33905. nReqRegion = ((iRegion+nShmPerMap) / nShmPerMap) * nShmPerMap;
  33906. if( pShmNode->nRegion<nReqRegion ){
  33907. char **apNew; /* New apRegion[] array */
  33908. int nByte = nReqRegion*szRegion; /* Minimum required file size */
  33909. struct stat sStat; /* Used by fstat() */
  33910. pShmNode->szRegion = szRegion;
  33911. if( pShmNode->h>=0 ){
  33912. /* The requested region is not mapped into this processes address space.
  33913. ** Check to see if it has been allocated (i.e. if the wal-index file is
  33914. ** large enough to contain the requested region).
  33915. */
  33916. if( osFstat(pShmNode->h, &sStat) ){
  33917. rc = SQLITE_IOERR_SHMSIZE;
  33918. goto shmpage_out;
  33919. }
  33920. if( sStat.st_size<nByte ){
  33921. /* The requested memory region does not exist. If bExtend is set to
  33922. ** false, exit early. *pp will be set to NULL and SQLITE_OK returned.
  33923. */
  33924. if( !bExtend ){
  33925. goto shmpage_out;
  33926. }
  33927. /* Alternatively, if bExtend is true, extend the file. Do this by
  33928. ** writing a single byte to the end of each (OS) page being
  33929. ** allocated or extended. Technically, we need only write to the
  33930. ** last page in order to extend the file. But writing to all new
  33931. ** pages forces the OS to allocate them immediately, which reduces
  33932. ** the chances of SIGBUS while accessing the mapped region later on.
  33933. */
  33934. else{
  33935. static const int pgsz = 4096;
  33936. int iPg;
  33937. /* Write to the last byte of each newly allocated or extended page */
  33938. assert( (nByte % pgsz)==0 );
  33939. for(iPg=(sStat.st_size/pgsz); iPg<(nByte/pgsz); iPg++){
  33940. int x = 0;
  33941. if( seekAndWriteFd(pShmNode->h, iPg*pgsz + pgsz-1, "", 1, &x)!=1 ){
  33942. const char *zFile = pShmNode->zFilename;
  33943. rc = unixLogError(SQLITE_IOERR_SHMSIZE, "write", zFile);
  33944. goto shmpage_out;
  33945. }
  33946. }
  33947. }
  33948. }
  33949. }
  33950. /* Map the requested memory region into this processes address space. */
  33951. apNew = (char **)sqlite3_realloc(
  33952. pShmNode->apRegion, nReqRegion*sizeof(char *)
  33953. );
  33954. if( !apNew ){
  33955. rc = SQLITE_IOERR_NOMEM_BKPT;
  33956. goto shmpage_out;
  33957. }
  33958. pShmNode->apRegion = apNew;
  33959. while( pShmNode->nRegion<nReqRegion ){
  33960. int nMap = szRegion*nShmPerMap;
  33961. int i;
  33962. void *pMem;
  33963. if( pShmNode->h>=0 ){
  33964. pMem = osMmap(0, nMap,
  33965. pShmNode->isReadonly ? PROT_READ : PROT_READ|PROT_WRITE,
  33966. MAP_SHARED, pShmNode->h, szRegion*(i64)pShmNode->nRegion
  33967. );
  33968. if( pMem==MAP_FAILED ){
  33969. rc = unixLogError(SQLITE_IOERR_SHMMAP, "mmap", pShmNode->zFilename);
  33970. goto shmpage_out;
  33971. }
  33972. }else{
  33973. pMem = sqlite3_malloc64(szRegion);
  33974. if( pMem==0 ){
  33975. rc = SQLITE_NOMEM_BKPT;
  33976. goto shmpage_out;
  33977. }
  33978. memset(pMem, 0, szRegion);
  33979. }
  33980. for(i=0; i<nShmPerMap; i++){
  33981. pShmNode->apRegion[pShmNode->nRegion+i] = &((char*)pMem)[szRegion*i];
  33982. }
  33983. pShmNode->nRegion += nShmPerMap;
  33984. }
  33985. }
  33986. shmpage_out:
  33987. if( pShmNode->nRegion>iRegion ){
  33988. *pp = pShmNode->apRegion[iRegion];
  33989. }else{
  33990. *pp = 0;
  33991. }
  33992. if( pShmNode->isReadonly && rc==SQLITE_OK ) rc = SQLITE_READONLY;
  33993. sqlite3_mutex_leave(pShmNode->mutex);
  33994. return rc;
  33995. }
  33996. /*
  33997. ** Change the lock state for a shared-memory segment.
  33998. **
  33999. ** Note that the relationship between SHAREd and EXCLUSIVE locks is a little
  34000. ** different here than in posix. In xShmLock(), one can go from unlocked
  34001. ** to shared and back or from unlocked to exclusive and back. But one may
  34002. ** not go from shared to exclusive or from exclusive to shared.
  34003. */
  34004. static int unixShmLock(
  34005. sqlite3_file *fd, /* Database file holding the shared memory */
  34006. int ofst, /* First lock to acquire or release */
  34007. int n, /* Number of locks to acquire or release */
  34008. int flags /* What to do with the lock */
  34009. ){
  34010. unixFile *pDbFd = (unixFile*)fd; /* Connection holding shared memory */
  34011. unixShm *p = pDbFd->pShm; /* The shared memory being locked */
  34012. unixShm *pX; /* For looping over all siblings */
  34013. unixShmNode *pShmNode = p->pShmNode; /* The underlying file iNode */
  34014. int rc = SQLITE_OK; /* Result code */
  34015. u16 mask; /* Mask of locks to take or release */
  34016. assert( pShmNode==pDbFd->pInode->pShmNode );
  34017. assert( pShmNode->pInode==pDbFd->pInode );
  34018. assert( ofst>=0 && ofst+n<=SQLITE_SHM_NLOCK );
  34019. assert( n>=1 );
  34020. assert( flags==(SQLITE_SHM_LOCK | SQLITE_SHM_SHARED)
  34021. || flags==(SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE)
  34022. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED)
  34023. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE) );
  34024. assert( n==1 || (flags & SQLITE_SHM_EXCLUSIVE)!=0 );
  34025. assert( pShmNode->h>=0 || pDbFd->pInode->bProcessLock==1 );
  34026. assert( pShmNode->h<0 || pDbFd->pInode->bProcessLock==0 );
  34027. mask = (1<<(ofst+n)) - (1<<ofst);
  34028. assert( n>1 || mask==(1<<ofst) );
  34029. sqlite3_mutex_enter(pShmNode->mutex);
  34030. if( flags & SQLITE_SHM_UNLOCK ){
  34031. u16 allMask = 0; /* Mask of locks held by siblings */
  34032. /* See if any siblings hold this same lock */
  34033. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  34034. if( pX==p ) continue;
  34035. assert( (pX->exclMask & (p->exclMask|p->sharedMask))==0 );
  34036. allMask |= pX->sharedMask;
  34037. }
  34038. /* Unlock the system-level locks */
  34039. if( (mask & allMask)==0 ){
  34040. rc = unixShmSystemLock(pDbFd, F_UNLCK, ofst+UNIX_SHM_BASE, n);
  34041. }else{
  34042. rc = SQLITE_OK;
  34043. }
  34044. /* Undo the local locks */
  34045. if( rc==SQLITE_OK ){
  34046. p->exclMask &= ~mask;
  34047. p->sharedMask &= ~mask;
  34048. }
  34049. }else if( flags & SQLITE_SHM_SHARED ){
  34050. u16 allShared = 0; /* Union of locks held by connections other than "p" */
  34051. /* Find out which shared locks are already held by sibling connections.
  34052. ** If any sibling already holds an exclusive lock, go ahead and return
  34053. ** SQLITE_BUSY.
  34054. */
  34055. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  34056. if( (pX->exclMask & mask)!=0 ){
  34057. rc = SQLITE_BUSY;
  34058. break;
  34059. }
  34060. allShared |= pX->sharedMask;
  34061. }
  34062. /* Get shared locks at the system level, if necessary */
  34063. if( rc==SQLITE_OK ){
  34064. if( (allShared & mask)==0 ){
  34065. rc = unixShmSystemLock(pDbFd, F_RDLCK, ofst+UNIX_SHM_BASE, n);
  34066. }else{
  34067. rc = SQLITE_OK;
  34068. }
  34069. }
  34070. /* Get the local shared locks */
  34071. if( rc==SQLITE_OK ){
  34072. p->sharedMask |= mask;
  34073. }
  34074. }else{
  34075. /* Make sure no sibling connections hold locks that will block this
  34076. ** lock. If any do, return SQLITE_BUSY right away.
  34077. */
  34078. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  34079. if( (pX->exclMask & mask)!=0 || (pX->sharedMask & mask)!=0 ){
  34080. rc = SQLITE_BUSY;
  34081. break;
  34082. }
  34083. }
  34084. /* Get the exclusive locks at the system level. Then if successful
  34085. ** also mark the local connection as being locked.
  34086. */
  34087. if( rc==SQLITE_OK ){
  34088. rc = unixShmSystemLock(pDbFd, F_WRLCK, ofst+UNIX_SHM_BASE, n);
  34089. if( rc==SQLITE_OK ){
  34090. assert( (p->sharedMask & mask)==0 );
  34091. p->exclMask |= mask;
  34092. }
  34093. }
  34094. }
  34095. sqlite3_mutex_leave(pShmNode->mutex);
  34096. OSTRACE(("SHM-LOCK shmid-%d, pid-%d got %03x,%03x\n",
  34097. p->id, osGetpid(0), p->sharedMask, p->exclMask));
  34098. return rc;
  34099. }
  34100. /*
  34101. ** Implement a memory barrier or memory fence on shared memory.
  34102. **
  34103. ** All loads and stores begun before the barrier must complete before
  34104. ** any load or store begun after the barrier.
  34105. */
  34106. static void unixShmBarrier(
  34107. sqlite3_file *fd /* Database file holding the shared memory */
  34108. ){
  34109. UNUSED_PARAMETER(fd);
  34110. sqlite3MemoryBarrier(); /* compiler-defined memory barrier */
  34111. unixEnterMutex(); /* Also mutex, for redundancy */
  34112. unixLeaveMutex();
  34113. }
  34114. /*
  34115. ** Close a connection to shared-memory. Delete the underlying
  34116. ** storage if deleteFlag is true.
  34117. **
  34118. ** If there is no shared memory associated with the connection then this
  34119. ** routine is a harmless no-op.
  34120. */
  34121. static int unixShmUnmap(
  34122. sqlite3_file *fd, /* The underlying database file */
  34123. int deleteFlag /* Delete shared-memory if true */
  34124. ){
  34125. unixShm *p; /* The connection to be closed */
  34126. unixShmNode *pShmNode; /* The underlying shared-memory file */
  34127. unixShm **pp; /* For looping over sibling connections */
  34128. unixFile *pDbFd; /* The underlying database file */
  34129. pDbFd = (unixFile*)fd;
  34130. p = pDbFd->pShm;
  34131. if( p==0 ) return SQLITE_OK;
  34132. pShmNode = p->pShmNode;
  34133. assert( pShmNode==pDbFd->pInode->pShmNode );
  34134. assert( pShmNode->pInode==pDbFd->pInode );
  34135. /* Remove connection p from the set of connections associated
  34136. ** with pShmNode */
  34137. sqlite3_mutex_enter(pShmNode->mutex);
  34138. for(pp=&pShmNode->pFirst; (*pp)!=p; pp = &(*pp)->pNext){}
  34139. *pp = p->pNext;
  34140. /* Free the connection p */
  34141. sqlite3_free(p);
  34142. pDbFd->pShm = 0;
  34143. sqlite3_mutex_leave(pShmNode->mutex);
  34144. /* If pShmNode->nRef has reached 0, then close the underlying
  34145. ** shared-memory file, too */
  34146. unixEnterMutex();
  34147. assert( pShmNode->nRef>0 );
  34148. pShmNode->nRef--;
  34149. if( pShmNode->nRef==0 ){
  34150. if( deleteFlag && pShmNode->h>=0 ){
  34151. osUnlink(pShmNode->zFilename);
  34152. }
  34153. unixShmPurge(pDbFd);
  34154. }
  34155. unixLeaveMutex();
  34156. return SQLITE_OK;
  34157. }
  34158. #else
  34159. # define unixShmMap 0
  34160. # define unixShmLock 0
  34161. # define unixShmBarrier 0
  34162. # define unixShmUnmap 0
  34163. #endif /* #ifndef SQLITE_OMIT_WAL */
  34164. #if SQLITE_MAX_MMAP_SIZE>0
  34165. /*
  34166. ** If it is currently memory mapped, unmap file pFd.
  34167. */
  34168. static void unixUnmapfile(unixFile *pFd){
  34169. assert( pFd->nFetchOut==0 );
  34170. if( pFd->pMapRegion ){
  34171. osMunmap(pFd->pMapRegion, pFd->mmapSizeActual);
  34172. pFd->pMapRegion = 0;
  34173. pFd->mmapSize = 0;
  34174. pFd->mmapSizeActual = 0;
  34175. }
  34176. }
  34177. /*
  34178. ** Attempt to set the size of the memory mapping maintained by file
  34179. ** descriptor pFd to nNew bytes. Any existing mapping is discarded.
  34180. **
  34181. ** If successful, this function sets the following variables:
  34182. **
  34183. ** unixFile.pMapRegion
  34184. ** unixFile.mmapSize
  34185. ** unixFile.mmapSizeActual
  34186. **
  34187. ** If unsuccessful, an error message is logged via sqlite3_log() and
  34188. ** the three variables above are zeroed. In this case SQLite should
  34189. ** continue accessing the database using the xRead() and xWrite()
  34190. ** methods.
  34191. */
  34192. static void unixRemapfile(
  34193. unixFile *pFd, /* File descriptor object */
  34194. i64 nNew /* Required mapping size */
  34195. ){
  34196. const char *zErr = "mmap";
  34197. int h = pFd->h; /* File descriptor open on db file */
  34198. u8 *pOrig = (u8 *)pFd->pMapRegion; /* Pointer to current file mapping */
  34199. i64 nOrig = pFd->mmapSizeActual; /* Size of pOrig region in bytes */
  34200. u8 *pNew = 0; /* Location of new mapping */
  34201. int flags = PROT_READ; /* Flags to pass to mmap() */
  34202. assert( pFd->nFetchOut==0 );
  34203. assert( nNew>pFd->mmapSize );
  34204. assert( nNew<=pFd->mmapSizeMax );
  34205. assert( nNew>0 );
  34206. assert( pFd->mmapSizeActual>=pFd->mmapSize );
  34207. assert( MAP_FAILED!=0 );
  34208. #ifdef SQLITE_MMAP_READWRITE
  34209. if( (pFd->ctrlFlags & UNIXFILE_RDONLY)==0 ) flags |= PROT_WRITE;
  34210. #endif
  34211. if( pOrig ){
  34212. #if HAVE_MREMAP
  34213. i64 nReuse = pFd->mmapSize;
  34214. #else
  34215. const int szSyspage = osGetpagesize();
  34216. i64 nReuse = (pFd->mmapSize & ~(szSyspage-1));
  34217. #endif
  34218. u8 *pReq = &pOrig[nReuse];
  34219. /* Unmap any pages of the existing mapping that cannot be reused. */
  34220. if( nReuse!=nOrig ){
  34221. osMunmap(pReq, nOrig-nReuse);
  34222. }
  34223. #if HAVE_MREMAP
  34224. pNew = osMremap(pOrig, nReuse, nNew, MREMAP_MAYMOVE);
  34225. zErr = "mremap";
  34226. #else
  34227. pNew = osMmap(pReq, nNew-nReuse, flags, MAP_SHARED, h, nReuse);
  34228. if( pNew!=MAP_FAILED ){
  34229. if( pNew!=pReq ){
  34230. osMunmap(pNew, nNew - nReuse);
  34231. pNew = 0;
  34232. }else{
  34233. pNew = pOrig;
  34234. }
  34235. }
  34236. #endif
  34237. /* The attempt to extend the existing mapping failed. Free it. */
  34238. if( pNew==MAP_FAILED || pNew==0 ){
  34239. osMunmap(pOrig, nReuse);
  34240. }
  34241. }
  34242. /* If pNew is still NULL, try to create an entirely new mapping. */
  34243. if( pNew==0 ){
  34244. pNew = osMmap(0, nNew, flags, MAP_SHARED, h, 0);
  34245. }
  34246. if( pNew==MAP_FAILED ){
  34247. pNew = 0;
  34248. nNew = 0;
  34249. unixLogError(SQLITE_OK, zErr, pFd->zPath);
  34250. /* If the mmap() above failed, assume that all subsequent mmap() calls
  34251. ** will probably fail too. Fall back to using xRead/xWrite exclusively
  34252. ** in this case. */
  34253. pFd->mmapSizeMax = 0;
  34254. }
  34255. pFd->pMapRegion = (void *)pNew;
  34256. pFd->mmapSize = pFd->mmapSizeActual = nNew;
  34257. }
  34258. /*
  34259. ** Memory map or remap the file opened by file-descriptor pFd (if the file
  34260. ** is already mapped, the existing mapping is replaced by the new). Or, if
  34261. ** there already exists a mapping for this file, and there are still
  34262. ** outstanding xFetch() references to it, this function is a no-op.
  34263. **
  34264. ** If parameter nByte is non-negative, then it is the requested size of
  34265. ** the mapping to create. Otherwise, if nByte is less than zero, then the
  34266. ** requested size is the size of the file on disk. The actual size of the
  34267. ** created mapping is either the requested size or the value configured
  34268. ** using SQLITE_FCNTL_MMAP_LIMIT, whichever is smaller.
  34269. **
  34270. ** SQLITE_OK is returned if no error occurs (even if the mapping is not
  34271. ** recreated as a result of outstanding references) or an SQLite error
  34272. ** code otherwise.
  34273. */
  34274. static int unixMapfile(unixFile *pFd, i64 nMap){
  34275. assert( nMap>=0 || pFd->nFetchOut==0 );
  34276. assert( nMap>0 || (pFd->mmapSize==0 && pFd->pMapRegion==0) );
  34277. if( pFd->nFetchOut>0 ) return SQLITE_OK;
  34278. if( nMap<0 ){
  34279. struct stat statbuf; /* Low-level file information */
  34280. if( osFstat(pFd->h, &statbuf) ){
  34281. return SQLITE_IOERR_FSTAT;
  34282. }
  34283. nMap = statbuf.st_size;
  34284. }
  34285. if( nMap>pFd->mmapSizeMax ){
  34286. nMap = pFd->mmapSizeMax;
  34287. }
  34288. assert( nMap>0 || (pFd->mmapSize==0 && pFd->pMapRegion==0) );
  34289. if( nMap!=pFd->mmapSize ){
  34290. unixRemapfile(pFd, nMap);
  34291. }
  34292. return SQLITE_OK;
  34293. }
  34294. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  34295. /*
  34296. ** If possible, return a pointer to a mapping of file fd starting at offset
  34297. ** iOff. The mapping must be valid for at least nAmt bytes.
  34298. **
  34299. ** If such a pointer can be obtained, store it in *pp and return SQLITE_OK.
  34300. ** Or, if one cannot but no error occurs, set *pp to 0 and return SQLITE_OK.
  34301. ** Finally, if an error does occur, return an SQLite error code. The final
  34302. ** value of *pp is undefined in this case.
  34303. **
  34304. ** If this function does return a pointer, the caller must eventually
  34305. ** release the reference by calling unixUnfetch().
  34306. */
  34307. static int unixFetch(sqlite3_file *fd, i64 iOff, int nAmt, void **pp){
  34308. #if SQLITE_MAX_MMAP_SIZE>0
  34309. unixFile *pFd = (unixFile *)fd; /* The underlying database file */
  34310. #endif
  34311. *pp = 0;
  34312. #if SQLITE_MAX_MMAP_SIZE>0
  34313. if( pFd->mmapSizeMax>0 ){
  34314. if( pFd->pMapRegion==0 ){
  34315. int rc = unixMapfile(pFd, -1);
  34316. if( rc!=SQLITE_OK ) return rc;
  34317. }
  34318. if( pFd->mmapSize >= iOff+nAmt ){
  34319. *pp = &((u8 *)pFd->pMapRegion)[iOff];
  34320. pFd->nFetchOut++;
  34321. }
  34322. }
  34323. #endif
  34324. return SQLITE_OK;
  34325. }
  34326. /*
  34327. ** If the third argument is non-NULL, then this function releases a
  34328. ** reference obtained by an earlier call to unixFetch(). The second
  34329. ** argument passed to this function must be the same as the corresponding
  34330. ** argument that was passed to the unixFetch() invocation.
  34331. **
  34332. ** Or, if the third argument is NULL, then this function is being called
  34333. ** to inform the VFS layer that, according to POSIX, any existing mapping
  34334. ** may now be invalid and should be unmapped.
  34335. */
  34336. static int unixUnfetch(sqlite3_file *fd, i64 iOff, void *p){
  34337. #if SQLITE_MAX_MMAP_SIZE>0
  34338. unixFile *pFd = (unixFile *)fd; /* The underlying database file */
  34339. UNUSED_PARAMETER(iOff);
  34340. /* If p==0 (unmap the entire file) then there must be no outstanding
  34341. ** xFetch references. Or, if p!=0 (meaning it is an xFetch reference),
  34342. ** then there must be at least one outstanding. */
  34343. assert( (p==0)==(pFd->nFetchOut==0) );
  34344. /* If p!=0, it must match the iOff value. */
  34345. assert( p==0 || p==&((u8 *)pFd->pMapRegion)[iOff] );
  34346. if( p ){
  34347. pFd->nFetchOut--;
  34348. }else{
  34349. unixUnmapfile(pFd);
  34350. }
  34351. assert( pFd->nFetchOut>=0 );
  34352. #else
  34353. UNUSED_PARAMETER(fd);
  34354. UNUSED_PARAMETER(p);
  34355. UNUSED_PARAMETER(iOff);
  34356. #endif
  34357. return SQLITE_OK;
  34358. }
  34359. /*
  34360. ** Here ends the implementation of all sqlite3_file methods.
  34361. **
  34362. ********************** End sqlite3_file Methods *******************************
  34363. ******************************************************************************/
  34364. /*
  34365. ** This division contains definitions of sqlite3_io_methods objects that
  34366. ** implement various file locking strategies. It also contains definitions
  34367. ** of "finder" functions. A finder-function is used to locate the appropriate
  34368. ** sqlite3_io_methods object for a particular database file. The pAppData
  34369. ** field of the sqlite3_vfs VFS objects are initialized to be pointers to
  34370. ** the correct finder-function for that VFS.
  34371. **
  34372. ** Most finder functions return a pointer to a fixed sqlite3_io_methods
  34373. ** object. The only interesting finder-function is autolockIoFinder, which
  34374. ** looks at the filesystem type and tries to guess the best locking
  34375. ** strategy from that.
  34376. **
  34377. ** For finder-function F, two objects are created:
  34378. **
  34379. ** (1) The real finder-function named "FImpt()".
  34380. **
  34381. ** (2) A constant pointer to this function named just "F".
  34382. **
  34383. **
  34384. ** A pointer to the F pointer is used as the pAppData value for VFS
  34385. ** objects. We have to do this instead of letting pAppData point
  34386. ** directly at the finder-function since C90 rules prevent a void*
  34387. ** from be cast into a function pointer.
  34388. **
  34389. **
  34390. ** Each instance of this macro generates two objects:
  34391. **
  34392. ** * A constant sqlite3_io_methods object call METHOD that has locking
  34393. ** methods CLOSE, LOCK, UNLOCK, CKRESLOCK.
  34394. **
  34395. ** * An I/O method finder function called FINDER that returns a pointer
  34396. ** to the METHOD object in the previous bullet.
  34397. */
  34398. #define IOMETHODS(FINDER,METHOD,VERSION,CLOSE,LOCK,UNLOCK,CKLOCK,SHMMAP) \
  34399. static const sqlite3_io_methods METHOD = { \
  34400. VERSION, /* iVersion */ \
  34401. CLOSE, /* xClose */ \
  34402. unixRead, /* xRead */ \
  34403. unixWrite, /* xWrite */ \
  34404. unixTruncate, /* xTruncate */ \
  34405. unixSync, /* xSync */ \
  34406. unixFileSize, /* xFileSize */ \
  34407. LOCK, /* xLock */ \
  34408. UNLOCK, /* xUnlock */ \
  34409. CKLOCK, /* xCheckReservedLock */ \
  34410. unixFileControl, /* xFileControl */ \
  34411. unixSectorSize, /* xSectorSize */ \
  34412. unixDeviceCharacteristics, /* xDeviceCapabilities */ \
  34413. SHMMAP, /* xShmMap */ \
  34414. unixShmLock, /* xShmLock */ \
  34415. unixShmBarrier, /* xShmBarrier */ \
  34416. unixShmUnmap, /* xShmUnmap */ \
  34417. unixFetch, /* xFetch */ \
  34418. unixUnfetch, /* xUnfetch */ \
  34419. }; \
  34420. static const sqlite3_io_methods *FINDER##Impl(const char *z, unixFile *p){ \
  34421. UNUSED_PARAMETER(z); UNUSED_PARAMETER(p); \
  34422. return &METHOD; \
  34423. } \
  34424. static const sqlite3_io_methods *(*const FINDER)(const char*,unixFile *p) \
  34425. = FINDER##Impl;
  34426. /*
  34427. ** Here are all of the sqlite3_io_methods objects for each of the
  34428. ** locking strategies. Functions that return pointers to these methods
  34429. ** are also created.
  34430. */
  34431. IOMETHODS(
  34432. posixIoFinder, /* Finder function name */
  34433. posixIoMethods, /* sqlite3_io_methods object name */
  34434. 3, /* shared memory and mmap are enabled */
  34435. unixClose, /* xClose method */
  34436. unixLock, /* xLock method */
  34437. unixUnlock, /* xUnlock method */
  34438. unixCheckReservedLock, /* xCheckReservedLock method */
  34439. unixShmMap /* xShmMap method */
  34440. )
  34441. IOMETHODS(
  34442. nolockIoFinder, /* Finder function name */
  34443. nolockIoMethods, /* sqlite3_io_methods object name */
  34444. 3, /* shared memory is disabled */
  34445. nolockClose, /* xClose method */
  34446. nolockLock, /* xLock method */
  34447. nolockUnlock, /* xUnlock method */
  34448. nolockCheckReservedLock, /* xCheckReservedLock method */
  34449. 0 /* xShmMap method */
  34450. )
  34451. IOMETHODS(
  34452. dotlockIoFinder, /* Finder function name */
  34453. dotlockIoMethods, /* sqlite3_io_methods object name */
  34454. 1, /* shared memory is disabled */
  34455. dotlockClose, /* xClose method */
  34456. dotlockLock, /* xLock method */
  34457. dotlockUnlock, /* xUnlock method */
  34458. dotlockCheckReservedLock, /* xCheckReservedLock method */
  34459. 0 /* xShmMap method */
  34460. )
  34461. #if SQLITE_ENABLE_LOCKING_STYLE
  34462. IOMETHODS(
  34463. flockIoFinder, /* Finder function name */
  34464. flockIoMethods, /* sqlite3_io_methods object name */
  34465. 1, /* shared memory is disabled */
  34466. flockClose, /* xClose method */
  34467. flockLock, /* xLock method */
  34468. flockUnlock, /* xUnlock method */
  34469. flockCheckReservedLock, /* xCheckReservedLock method */
  34470. 0 /* xShmMap method */
  34471. )
  34472. #endif
  34473. #if OS_VXWORKS
  34474. IOMETHODS(
  34475. semIoFinder, /* Finder function name */
  34476. semIoMethods, /* sqlite3_io_methods object name */
  34477. 1, /* shared memory is disabled */
  34478. semXClose, /* xClose method */
  34479. semXLock, /* xLock method */
  34480. semXUnlock, /* xUnlock method */
  34481. semXCheckReservedLock, /* xCheckReservedLock method */
  34482. 0 /* xShmMap method */
  34483. )
  34484. #endif
  34485. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  34486. IOMETHODS(
  34487. afpIoFinder, /* Finder function name */
  34488. afpIoMethods, /* sqlite3_io_methods object name */
  34489. 1, /* shared memory is disabled */
  34490. afpClose, /* xClose method */
  34491. afpLock, /* xLock method */
  34492. afpUnlock, /* xUnlock method */
  34493. afpCheckReservedLock, /* xCheckReservedLock method */
  34494. 0 /* xShmMap method */
  34495. )
  34496. #endif
  34497. /*
  34498. ** The proxy locking method is a "super-method" in the sense that it
  34499. ** opens secondary file descriptors for the conch and lock files and
  34500. ** it uses proxy, dot-file, AFP, and flock() locking methods on those
  34501. ** secondary files. For this reason, the division that implements
  34502. ** proxy locking is located much further down in the file. But we need
  34503. ** to go ahead and define the sqlite3_io_methods and finder function
  34504. ** for proxy locking here. So we forward declare the I/O methods.
  34505. */
  34506. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  34507. static int proxyClose(sqlite3_file*);
  34508. static int proxyLock(sqlite3_file*, int);
  34509. static int proxyUnlock(sqlite3_file*, int);
  34510. static int proxyCheckReservedLock(sqlite3_file*, int*);
  34511. IOMETHODS(
  34512. proxyIoFinder, /* Finder function name */
  34513. proxyIoMethods, /* sqlite3_io_methods object name */
  34514. 1, /* shared memory is disabled */
  34515. proxyClose, /* xClose method */
  34516. proxyLock, /* xLock method */
  34517. proxyUnlock, /* xUnlock method */
  34518. proxyCheckReservedLock, /* xCheckReservedLock method */
  34519. 0 /* xShmMap method */
  34520. )
  34521. #endif
  34522. /* nfs lockd on OSX 10.3+ doesn't clear write locks when a read lock is set */
  34523. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  34524. IOMETHODS(
  34525. nfsIoFinder, /* Finder function name */
  34526. nfsIoMethods, /* sqlite3_io_methods object name */
  34527. 1, /* shared memory is disabled */
  34528. unixClose, /* xClose method */
  34529. unixLock, /* xLock method */
  34530. nfsUnlock, /* xUnlock method */
  34531. unixCheckReservedLock, /* xCheckReservedLock method */
  34532. 0 /* xShmMap method */
  34533. )
  34534. #endif
  34535. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  34536. /*
  34537. ** This "finder" function attempts to determine the best locking strategy
  34538. ** for the database file "filePath". It then returns the sqlite3_io_methods
  34539. ** object that implements that strategy.
  34540. **
  34541. ** This is for MacOSX only.
  34542. */
  34543. static const sqlite3_io_methods *autolockIoFinderImpl(
  34544. const char *filePath, /* name of the database file */
  34545. unixFile *pNew /* open file object for the database file */
  34546. ){
  34547. static const struct Mapping {
  34548. const char *zFilesystem; /* Filesystem type name */
  34549. const sqlite3_io_methods *pMethods; /* Appropriate locking method */
  34550. } aMap[] = {
  34551. { "hfs", &posixIoMethods },
  34552. { "ufs", &posixIoMethods },
  34553. { "afpfs", &afpIoMethods },
  34554. { "smbfs", &afpIoMethods },
  34555. { "webdav", &nolockIoMethods },
  34556. { 0, 0 }
  34557. };
  34558. int i;
  34559. struct statfs fsInfo;
  34560. struct flock lockInfo;
  34561. if( !filePath ){
  34562. /* If filePath==NULL that means we are dealing with a transient file
  34563. ** that does not need to be locked. */
  34564. return &nolockIoMethods;
  34565. }
  34566. if( statfs(filePath, &fsInfo) != -1 ){
  34567. if( fsInfo.f_flags & MNT_RDONLY ){
  34568. return &nolockIoMethods;
  34569. }
  34570. for(i=0; aMap[i].zFilesystem; i++){
  34571. if( strcmp(fsInfo.f_fstypename, aMap[i].zFilesystem)==0 ){
  34572. return aMap[i].pMethods;
  34573. }
  34574. }
  34575. }
  34576. /* Default case. Handles, amongst others, "nfs".
  34577. ** Test byte-range lock using fcntl(). If the call succeeds,
  34578. ** assume that the file-system supports POSIX style locks.
  34579. */
  34580. lockInfo.l_len = 1;
  34581. lockInfo.l_start = 0;
  34582. lockInfo.l_whence = SEEK_SET;
  34583. lockInfo.l_type = F_RDLCK;
  34584. if( osFcntl(pNew->h, F_GETLK, &lockInfo)!=-1 ) {
  34585. if( strcmp(fsInfo.f_fstypename, "nfs")==0 ){
  34586. return &nfsIoMethods;
  34587. } else {
  34588. return &posixIoMethods;
  34589. }
  34590. }else{
  34591. return &dotlockIoMethods;
  34592. }
  34593. }
  34594. static const sqlite3_io_methods
  34595. *(*const autolockIoFinder)(const char*,unixFile*) = autolockIoFinderImpl;
  34596. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  34597. #if OS_VXWORKS
  34598. /*
  34599. ** This "finder" function for VxWorks checks to see if posix advisory
  34600. ** locking works. If it does, then that is what is used. If it does not
  34601. ** work, then fallback to named semaphore locking.
  34602. */
  34603. static const sqlite3_io_methods *vxworksIoFinderImpl(
  34604. const char *filePath, /* name of the database file */
  34605. unixFile *pNew /* the open file object */
  34606. ){
  34607. struct flock lockInfo;
  34608. if( !filePath ){
  34609. /* If filePath==NULL that means we are dealing with a transient file
  34610. ** that does not need to be locked. */
  34611. return &nolockIoMethods;
  34612. }
  34613. /* Test if fcntl() is supported and use POSIX style locks.
  34614. ** Otherwise fall back to the named semaphore method.
  34615. */
  34616. lockInfo.l_len = 1;
  34617. lockInfo.l_start = 0;
  34618. lockInfo.l_whence = SEEK_SET;
  34619. lockInfo.l_type = F_RDLCK;
  34620. if( osFcntl(pNew->h, F_GETLK, &lockInfo)!=-1 ) {
  34621. return &posixIoMethods;
  34622. }else{
  34623. return &semIoMethods;
  34624. }
  34625. }
  34626. static const sqlite3_io_methods
  34627. *(*const vxworksIoFinder)(const char*,unixFile*) = vxworksIoFinderImpl;
  34628. #endif /* OS_VXWORKS */
  34629. /*
  34630. ** An abstract type for a pointer to an IO method finder function:
  34631. */
  34632. typedef const sqlite3_io_methods *(*finder_type)(const char*,unixFile*);
  34633. /****************************************************************************
  34634. **************************** sqlite3_vfs methods ****************************
  34635. **
  34636. ** This division contains the implementation of methods on the
  34637. ** sqlite3_vfs object.
  34638. */
  34639. /*
  34640. ** Initialize the contents of the unixFile structure pointed to by pId.
  34641. */
  34642. static int fillInUnixFile(
  34643. sqlite3_vfs *pVfs, /* Pointer to vfs object */
  34644. int h, /* Open file descriptor of file being opened */
  34645. sqlite3_file *pId, /* Write to the unixFile structure here */
  34646. const char *zFilename, /* Name of the file being opened */
  34647. int ctrlFlags /* Zero or more UNIXFILE_* values */
  34648. ){
  34649. const sqlite3_io_methods *pLockingStyle;
  34650. unixFile *pNew = (unixFile *)pId;
  34651. int rc = SQLITE_OK;
  34652. assert( pNew->pInode==NULL );
  34653. /* No locking occurs in temporary files */
  34654. assert( zFilename!=0 || (ctrlFlags & UNIXFILE_NOLOCK)!=0 );
  34655. OSTRACE(("OPEN %-3d %s\n", h, zFilename));
  34656. pNew->h = h;
  34657. pNew->pVfs = pVfs;
  34658. pNew->zPath = zFilename;
  34659. pNew->ctrlFlags = (u8)ctrlFlags;
  34660. #if SQLITE_MAX_MMAP_SIZE>0
  34661. pNew->mmapSizeMax = sqlite3GlobalConfig.szMmap;
  34662. #endif
  34663. if( sqlite3_uri_boolean(((ctrlFlags & UNIXFILE_URI) ? zFilename : 0),
  34664. "psow", SQLITE_POWERSAFE_OVERWRITE) ){
  34665. pNew->ctrlFlags |= UNIXFILE_PSOW;
  34666. }
  34667. if( strcmp(pVfs->zName,"unix-excl")==0 ){
  34668. pNew->ctrlFlags |= UNIXFILE_EXCL;
  34669. }
  34670. #if OS_VXWORKS
  34671. pNew->pId = vxworksFindFileId(zFilename);
  34672. if( pNew->pId==0 ){
  34673. ctrlFlags |= UNIXFILE_NOLOCK;
  34674. rc = SQLITE_NOMEM_BKPT;
  34675. }
  34676. #endif
  34677. if( ctrlFlags & UNIXFILE_NOLOCK ){
  34678. pLockingStyle = &nolockIoMethods;
  34679. }else{
  34680. pLockingStyle = (**(finder_type*)pVfs->pAppData)(zFilename, pNew);
  34681. #if SQLITE_ENABLE_LOCKING_STYLE
  34682. /* Cache zFilename in the locking context (AFP and dotlock override) for
  34683. ** proxyLock activation is possible (remote proxy is based on db name)
  34684. ** zFilename remains valid until file is closed, to support */
  34685. pNew->lockingContext = (void*)zFilename;
  34686. #endif
  34687. }
  34688. if( pLockingStyle == &posixIoMethods
  34689. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  34690. || pLockingStyle == &nfsIoMethods
  34691. #endif
  34692. ){
  34693. unixEnterMutex();
  34694. rc = findInodeInfo(pNew, &pNew->pInode);
  34695. if( rc!=SQLITE_OK ){
  34696. /* If an error occurred in findInodeInfo(), close the file descriptor
  34697. ** immediately, before releasing the mutex. findInodeInfo() may fail
  34698. ** in two scenarios:
  34699. **
  34700. ** (a) A call to fstat() failed.
  34701. ** (b) A malloc failed.
  34702. **
  34703. ** Scenario (b) may only occur if the process is holding no other
  34704. ** file descriptors open on the same file. If there were other file
  34705. ** descriptors on this file, then no malloc would be required by
  34706. ** findInodeInfo(). If this is the case, it is quite safe to close
  34707. ** handle h - as it is guaranteed that no posix locks will be released
  34708. ** by doing so.
  34709. **
  34710. ** If scenario (a) caused the error then things are not so safe. The
  34711. ** implicit assumption here is that if fstat() fails, things are in
  34712. ** such bad shape that dropping a lock or two doesn't matter much.
  34713. */
  34714. robust_close(pNew, h, __LINE__);
  34715. h = -1;
  34716. }
  34717. unixLeaveMutex();
  34718. }
  34719. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  34720. else if( pLockingStyle == &afpIoMethods ){
  34721. /* AFP locking uses the file path so it needs to be included in
  34722. ** the afpLockingContext.
  34723. */
  34724. afpLockingContext *pCtx;
  34725. pNew->lockingContext = pCtx = sqlite3_malloc64( sizeof(*pCtx) );
  34726. if( pCtx==0 ){
  34727. rc = SQLITE_NOMEM_BKPT;
  34728. }else{
  34729. /* NB: zFilename exists and remains valid until the file is closed
  34730. ** according to requirement F11141. So we do not need to make a
  34731. ** copy of the filename. */
  34732. pCtx->dbPath = zFilename;
  34733. pCtx->reserved = 0;
  34734. srandomdev();
  34735. unixEnterMutex();
  34736. rc = findInodeInfo(pNew, &pNew->pInode);
  34737. if( rc!=SQLITE_OK ){
  34738. sqlite3_free(pNew->lockingContext);
  34739. robust_close(pNew, h, __LINE__);
  34740. h = -1;
  34741. }
  34742. unixLeaveMutex();
  34743. }
  34744. }
  34745. #endif
  34746. else if( pLockingStyle == &dotlockIoMethods ){
  34747. /* Dotfile locking uses the file path so it needs to be included in
  34748. ** the dotlockLockingContext
  34749. */
  34750. char *zLockFile;
  34751. int nFilename;
  34752. assert( zFilename!=0 );
  34753. nFilename = (int)strlen(zFilename) + 6;
  34754. zLockFile = (char *)sqlite3_malloc64(nFilename);
  34755. if( zLockFile==0 ){
  34756. rc = SQLITE_NOMEM_BKPT;
  34757. }else{
  34758. sqlite3_snprintf(nFilename, zLockFile, "%s" DOTLOCK_SUFFIX, zFilename);
  34759. }
  34760. pNew->lockingContext = zLockFile;
  34761. }
  34762. #if OS_VXWORKS
  34763. else if( pLockingStyle == &semIoMethods ){
  34764. /* Named semaphore locking uses the file path so it needs to be
  34765. ** included in the semLockingContext
  34766. */
  34767. unixEnterMutex();
  34768. rc = findInodeInfo(pNew, &pNew->pInode);
  34769. if( (rc==SQLITE_OK) && (pNew->pInode->pSem==NULL) ){
  34770. char *zSemName = pNew->pInode->aSemName;
  34771. int n;
  34772. sqlite3_snprintf(MAX_PATHNAME, zSemName, "/%s.sem",
  34773. pNew->pId->zCanonicalName);
  34774. for( n=1; zSemName[n]; n++ )
  34775. if( zSemName[n]=='/' ) zSemName[n] = '_';
  34776. pNew->pInode->pSem = sem_open(zSemName, O_CREAT, 0666, 1);
  34777. if( pNew->pInode->pSem == SEM_FAILED ){
  34778. rc = SQLITE_NOMEM_BKPT;
  34779. pNew->pInode->aSemName[0] = '\0';
  34780. }
  34781. }
  34782. unixLeaveMutex();
  34783. }
  34784. #endif
  34785. storeLastErrno(pNew, 0);
  34786. #if OS_VXWORKS
  34787. if( rc!=SQLITE_OK ){
  34788. if( h>=0 ) robust_close(pNew, h, __LINE__);
  34789. h = -1;
  34790. osUnlink(zFilename);
  34791. pNew->ctrlFlags |= UNIXFILE_DELETE;
  34792. }
  34793. #endif
  34794. if( rc!=SQLITE_OK ){
  34795. if( h>=0 ) robust_close(pNew, h, __LINE__);
  34796. }else{
  34797. pNew->pMethod = pLockingStyle;
  34798. OpenCounter(+1);
  34799. verifyDbFile(pNew);
  34800. }
  34801. return rc;
  34802. }
  34803. /*
  34804. ** Return the name of a directory in which to put temporary files.
  34805. ** If no suitable temporary file directory can be found, return NULL.
  34806. */
  34807. static const char *unixTempFileDir(void){
  34808. static const char *azDirs[] = {
  34809. 0,
  34810. 0,
  34811. "/var/tmp",
  34812. "/usr/tmp",
  34813. "/tmp",
  34814. "."
  34815. };
  34816. unsigned int i = 0;
  34817. struct stat buf;
  34818. const char *zDir = sqlite3_temp_directory;
  34819. if( !azDirs[0] ) azDirs[0] = getenv("SQLITE_TMPDIR");
  34820. if( !azDirs[1] ) azDirs[1] = getenv("TMPDIR");
  34821. while(1){
  34822. if( zDir!=0
  34823. && osStat(zDir, &buf)==0
  34824. && S_ISDIR(buf.st_mode)
  34825. && osAccess(zDir, 03)==0
  34826. ){
  34827. return zDir;
  34828. }
  34829. if( i>=sizeof(azDirs)/sizeof(azDirs[0]) ) break;
  34830. zDir = azDirs[i++];
  34831. }
  34832. return 0;
  34833. }
  34834. /*
  34835. ** Create a temporary file name in zBuf. zBuf must be allocated
  34836. ** by the calling process and must be big enough to hold at least
  34837. ** pVfs->mxPathname bytes.
  34838. */
  34839. static int unixGetTempname(int nBuf, char *zBuf){
  34840. const char *zDir;
  34841. int iLimit = 0;
  34842. /* It's odd to simulate an io-error here, but really this is just
  34843. ** using the io-error infrastructure to test that SQLite handles this
  34844. ** function failing.
  34845. */
  34846. zBuf[0] = 0;
  34847. SimulateIOError( return SQLITE_IOERR );
  34848. zDir = unixTempFileDir();
  34849. if( zDir==0 ) return SQLITE_IOERR_GETTEMPPATH;
  34850. do{
  34851. u64 r;
  34852. sqlite3_randomness(sizeof(r), &r);
  34853. assert( nBuf>2 );
  34854. zBuf[nBuf-2] = 0;
  34855. sqlite3_snprintf(nBuf, zBuf, "%s/"SQLITE_TEMP_FILE_PREFIX"%llx%c",
  34856. zDir, r, 0);
  34857. if( zBuf[nBuf-2]!=0 || (iLimit++)>10 ) return SQLITE_ERROR;
  34858. }while( osAccess(zBuf,0)==0 );
  34859. return SQLITE_OK;
  34860. }
  34861. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  34862. /*
  34863. ** Routine to transform a unixFile into a proxy-locking unixFile.
  34864. ** Implementation in the proxy-lock division, but used by unixOpen()
  34865. ** if SQLITE_PREFER_PROXY_LOCKING is defined.
  34866. */
  34867. static int proxyTransformUnixFile(unixFile*, const char*);
  34868. #endif
  34869. /*
  34870. ** Search for an unused file descriptor that was opened on the database
  34871. ** file (not a journal or master-journal file) identified by pathname
  34872. ** zPath with SQLITE_OPEN_XXX flags matching those passed as the second
  34873. ** argument to this function.
  34874. **
  34875. ** Such a file descriptor may exist if a database connection was closed
  34876. ** but the associated file descriptor could not be closed because some
  34877. ** other file descriptor open on the same file is holding a file-lock.
  34878. ** Refer to comments in the unixClose() function and the lengthy comment
  34879. ** describing "Posix Advisory Locking" at the start of this file for
  34880. ** further details. Also, ticket #4018.
  34881. **
  34882. ** If a suitable file descriptor is found, then it is returned. If no
  34883. ** such file descriptor is located, -1 is returned.
  34884. */
  34885. static UnixUnusedFd *findReusableFd(const char *zPath, int flags){
  34886. UnixUnusedFd *pUnused = 0;
  34887. /* Do not search for an unused file descriptor on vxworks. Not because
  34888. ** vxworks would not benefit from the change (it might, we're not sure),
  34889. ** but because no way to test it is currently available. It is better
  34890. ** not to risk breaking vxworks support for the sake of such an obscure
  34891. ** feature. */
  34892. #if !OS_VXWORKS
  34893. struct stat sStat; /* Results of stat() call */
  34894. unixEnterMutex();
  34895. /* A stat() call may fail for various reasons. If this happens, it is
  34896. ** almost certain that an open() call on the same path will also fail.
  34897. ** For this reason, if an error occurs in the stat() call here, it is
  34898. ** ignored and -1 is returned. The caller will try to open a new file
  34899. ** descriptor on the same path, fail, and return an error to SQLite.
  34900. **
  34901. ** Even if a subsequent open() call does succeed, the consequences of
  34902. ** not searching for a reusable file descriptor are not dire. */
  34903. if( nUnusedFd>0 && 0==osStat(zPath, &sStat) ){
  34904. unixInodeInfo *pInode;
  34905. pInode = inodeList;
  34906. while( pInode && (pInode->fileId.dev!=sStat.st_dev
  34907. || pInode->fileId.ino!=(u64)sStat.st_ino) ){
  34908. pInode = pInode->pNext;
  34909. }
  34910. if( pInode ){
  34911. UnixUnusedFd **pp;
  34912. for(pp=&pInode->pUnused; *pp && (*pp)->flags!=flags; pp=&((*pp)->pNext));
  34913. pUnused = *pp;
  34914. if( pUnused ){
  34915. nUnusedFd--;
  34916. *pp = pUnused->pNext;
  34917. }
  34918. }
  34919. }
  34920. unixLeaveMutex();
  34921. #endif /* if !OS_VXWORKS */
  34922. return pUnused;
  34923. }
  34924. /*
  34925. ** Find the mode, uid and gid of file zFile.
  34926. */
  34927. static int getFileMode(
  34928. const char *zFile, /* File name */
  34929. mode_t *pMode, /* OUT: Permissions of zFile */
  34930. uid_t *pUid, /* OUT: uid of zFile. */
  34931. gid_t *pGid /* OUT: gid of zFile. */
  34932. ){
  34933. struct stat sStat; /* Output of stat() on database file */
  34934. int rc = SQLITE_OK;
  34935. if( 0==osStat(zFile, &sStat) ){
  34936. *pMode = sStat.st_mode & 0777;
  34937. *pUid = sStat.st_uid;
  34938. *pGid = sStat.st_gid;
  34939. }else{
  34940. rc = SQLITE_IOERR_FSTAT;
  34941. }
  34942. return rc;
  34943. }
  34944. /*
  34945. ** This function is called by unixOpen() to determine the unix permissions
  34946. ** to create new files with. If no error occurs, then SQLITE_OK is returned
  34947. ** and a value suitable for passing as the third argument to open(2) is
  34948. ** written to *pMode. If an IO error occurs, an SQLite error code is
  34949. ** returned and the value of *pMode is not modified.
  34950. **
  34951. ** In most cases, this routine sets *pMode to 0, which will become
  34952. ** an indication to robust_open() to create the file using
  34953. ** SQLITE_DEFAULT_FILE_PERMISSIONS adjusted by the umask.
  34954. ** But if the file being opened is a WAL or regular journal file, then
  34955. ** this function queries the file-system for the permissions on the
  34956. ** corresponding database file and sets *pMode to this value. Whenever
  34957. ** possible, WAL and journal files are created using the same permissions
  34958. ** as the associated database file.
  34959. **
  34960. ** If the SQLITE_ENABLE_8_3_NAMES option is enabled, then the
  34961. ** original filename is unavailable. But 8_3_NAMES is only used for
  34962. ** FAT filesystems and permissions do not matter there, so just use
  34963. ** the default permissions.
  34964. */
  34965. static int findCreateFileMode(
  34966. const char *zPath, /* Path of file (possibly) being created */
  34967. int flags, /* Flags passed as 4th argument to xOpen() */
  34968. mode_t *pMode, /* OUT: Permissions to open file with */
  34969. uid_t *pUid, /* OUT: uid to set on the file */
  34970. gid_t *pGid /* OUT: gid to set on the file */
  34971. ){
  34972. int rc = SQLITE_OK; /* Return Code */
  34973. *pMode = 0;
  34974. *pUid = 0;
  34975. *pGid = 0;
  34976. if( flags & (SQLITE_OPEN_WAL|SQLITE_OPEN_MAIN_JOURNAL) ){
  34977. char zDb[MAX_PATHNAME+1]; /* Database file path */
  34978. int nDb; /* Number of valid bytes in zDb */
  34979. /* zPath is a path to a WAL or journal file. The following block derives
  34980. ** the path to the associated database file from zPath. This block handles
  34981. ** the following naming conventions:
  34982. **
  34983. ** "<path to db>-journal"
  34984. ** "<path to db>-wal"
  34985. ** "<path to db>-journalNN"
  34986. ** "<path to db>-walNN"
  34987. **
  34988. ** where NN is a decimal number. The NN naming schemes are
  34989. ** used by the test_multiplex.c module.
  34990. */
  34991. nDb = sqlite3Strlen30(zPath) - 1;
  34992. while( zPath[nDb]!='-' ){
  34993. /* In normal operation, the journal file name will always contain
  34994. ** a '-' character. However in 8+3 filename mode, or if a corrupt
  34995. ** rollback journal specifies a master journal with a goofy name, then
  34996. ** the '-' might be missing. */
  34997. if( nDb==0 || zPath[nDb]=='.' ) return SQLITE_OK;
  34998. nDb--;
  34999. }
  35000. memcpy(zDb, zPath, nDb);
  35001. zDb[nDb] = '\0';
  35002. rc = getFileMode(zDb, pMode, pUid, pGid);
  35003. }else if( flags & SQLITE_OPEN_DELETEONCLOSE ){
  35004. *pMode = 0600;
  35005. }else if( flags & SQLITE_OPEN_URI ){
  35006. /* If this is a main database file and the file was opened using a URI
  35007. ** filename, check for the "modeof" parameter. If present, interpret
  35008. ** its value as a filename and try to copy the mode, uid and gid from
  35009. ** that file. */
  35010. const char *z = sqlite3_uri_parameter(zPath, "modeof");
  35011. if( z ){
  35012. rc = getFileMode(z, pMode, pUid, pGid);
  35013. }
  35014. }
  35015. return rc;
  35016. }
  35017. /*
  35018. ** Open the file zPath.
  35019. **
  35020. ** Previously, the SQLite OS layer used three functions in place of this
  35021. ** one:
  35022. **
  35023. ** sqlite3OsOpenReadWrite();
  35024. ** sqlite3OsOpenReadOnly();
  35025. ** sqlite3OsOpenExclusive();
  35026. **
  35027. ** These calls correspond to the following combinations of flags:
  35028. **
  35029. ** ReadWrite() -> (READWRITE | CREATE)
  35030. ** ReadOnly() -> (READONLY)
  35031. ** OpenExclusive() -> (READWRITE | CREATE | EXCLUSIVE)
  35032. **
  35033. ** The old OpenExclusive() accepted a boolean argument - "delFlag". If
  35034. ** true, the file was configured to be automatically deleted when the
  35035. ** file handle closed. To achieve the same effect using this new
  35036. ** interface, add the DELETEONCLOSE flag to those specified above for
  35037. ** OpenExclusive().
  35038. */
  35039. static int unixOpen(
  35040. sqlite3_vfs *pVfs, /* The VFS for which this is the xOpen method */
  35041. const char *zPath, /* Pathname of file to be opened */
  35042. sqlite3_file *pFile, /* The file descriptor to be filled in */
  35043. int flags, /* Input flags to control the opening */
  35044. int *pOutFlags /* Output flags returned to SQLite core */
  35045. ){
  35046. unixFile *p = (unixFile *)pFile;
  35047. int fd = -1; /* File descriptor returned by open() */
  35048. int openFlags = 0; /* Flags to pass to open() */
  35049. int eType = flags&0xFFFFFF00; /* Type of file to open */
  35050. int noLock; /* True to omit locking primitives */
  35051. int rc = SQLITE_OK; /* Function Return Code */
  35052. int ctrlFlags = 0; /* UNIXFILE_* flags */
  35053. int isExclusive = (flags & SQLITE_OPEN_EXCLUSIVE);
  35054. int isDelete = (flags & SQLITE_OPEN_DELETEONCLOSE);
  35055. int isCreate = (flags & SQLITE_OPEN_CREATE);
  35056. int isReadonly = (flags & SQLITE_OPEN_READONLY);
  35057. int isReadWrite = (flags & SQLITE_OPEN_READWRITE);
  35058. #if SQLITE_ENABLE_LOCKING_STYLE
  35059. int isAutoProxy = (flags & SQLITE_OPEN_AUTOPROXY);
  35060. #endif
  35061. #if defined(__APPLE__) || SQLITE_ENABLE_LOCKING_STYLE
  35062. struct statfs fsInfo;
  35063. #endif
  35064. /* If creating a master or main-file journal, this function will open
  35065. ** a file-descriptor on the directory too. The first time unixSync()
  35066. ** is called the directory file descriptor will be fsync()ed and close()d.
  35067. */
  35068. int isNewJrnl = (isCreate && (
  35069. eType==SQLITE_OPEN_MASTER_JOURNAL
  35070. || eType==SQLITE_OPEN_MAIN_JOURNAL
  35071. || eType==SQLITE_OPEN_WAL
  35072. ));
  35073. /* If argument zPath is a NULL pointer, this function is required to open
  35074. ** a temporary file. Use this buffer to store the file name in.
  35075. */
  35076. char zTmpname[MAX_PATHNAME+2];
  35077. const char *zName = zPath;
  35078. /* Check the following statements are true:
  35079. **
  35080. ** (a) Exactly one of the READWRITE and READONLY flags must be set, and
  35081. ** (b) if CREATE is set, then READWRITE must also be set, and
  35082. ** (c) if EXCLUSIVE is set, then CREATE must also be set.
  35083. ** (d) if DELETEONCLOSE is set, then CREATE must also be set.
  35084. */
  35085. assert((isReadonly==0 || isReadWrite==0) && (isReadWrite || isReadonly));
  35086. assert(isCreate==0 || isReadWrite);
  35087. assert(isExclusive==0 || isCreate);
  35088. assert(isDelete==0 || isCreate);
  35089. /* The main DB, main journal, WAL file and master journal are never
  35090. ** automatically deleted. Nor are they ever temporary files. */
  35091. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_DB );
  35092. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_JOURNAL );
  35093. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MASTER_JOURNAL );
  35094. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_WAL );
  35095. /* Assert that the upper layer has set one of the "file-type" flags. */
  35096. assert( eType==SQLITE_OPEN_MAIN_DB || eType==SQLITE_OPEN_TEMP_DB
  35097. || eType==SQLITE_OPEN_MAIN_JOURNAL || eType==SQLITE_OPEN_TEMP_JOURNAL
  35098. || eType==SQLITE_OPEN_SUBJOURNAL || eType==SQLITE_OPEN_MASTER_JOURNAL
  35099. || eType==SQLITE_OPEN_TRANSIENT_DB || eType==SQLITE_OPEN_WAL
  35100. );
  35101. /* Detect a pid change and reset the PRNG. There is a race condition
  35102. ** here such that two or more threads all trying to open databases at
  35103. ** the same instant might all reset the PRNG. But multiple resets
  35104. ** are harmless.
  35105. */
  35106. if( randomnessPid!=osGetpid(0) ){
  35107. randomnessPid = osGetpid(0);
  35108. sqlite3_randomness(0,0);
  35109. }
  35110. memset(p, 0, sizeof(unixFile));
  35111. if( eType==SQLITE_OPEN_MAIN_DB ){
  35112. UnixUnusedFd *pUnused;
  35113. pUnused = findReusableFd(zName, flags);
  35114. if( pUnused ){
  35115. fd = pUnused->fd;
  35116. }else{
  35117. pUnused = sqlite3_malloc64(sizeof(*pUnused));
  35118. if( !pUnused ){
  35119. return SQLITE_NOMEM_BKPT;
  35120. }
  35121. }
  35122. p->pPreallocatedUnused = pUnused;
  35123. /* Database filenames are double-zero terminated if they are not
  35124. ** URIs with parameters. Hence, they can always be passed into
  35125. ** sqlite3_uri_parameter(). */
  35126. assert( (flags & SQLITE_OPEN_URI) || zName[strlen(zName)+1]==0 );
  35127. }else if( !zName ){
  35128. /* If zName is NULL, the upper layer is requesting a temp file. */
  35129. assert(isDelete && !isNewJrnl);
  35130. rc = unixGetTempname(pVfs->mxPathname, zTmpname);
  35131. if( rc!=SQLITE_OK ){
  35132. return rc;
  35133. }
  35134. zName = zTmpname;
  35135. /* Generated temporary filenames are always double-zero terminated
  35136. ** for use by sqlite3_uri_parameter(). */
  35137. assert( zName[strlen(zName)+1]==0 );
  35138. }
  35139. /* Determine the value of the flags parameter passed to POSIX function
  35140. ** open(). These must be calculated even if open() is not called, as
  35141. ** they may be stored as part of the file handle and used by the
  35142. ** 'conch file' locking functions later on. */
  35143. if( isReadonly ) openFlags |= O_RDONLY;
  35144. if( isReadWrite ) openFlags |= O_RDWR;
  35145. if( isCreate ) openFlags |= O_CREAT;
  35146. if( isExclusive ) openFlags |= (O_EXCL|O_NOFOLLOW);
  35147. openFlags |= (O_LARGEFILE|O_BINARY);
  35148. if( fd<0 ){
  35149. mode_t openMode; /* Permissions to create file with */
  35150. uid_t uid; /* Userid for the file */
  35151. gid_t gid; /* Groupid for the file */
  35152. rc = findCreateFileMode(zName, flags, &openMode, &uid, &gid);
  35153. if( rc!=SQLITE_OK ){
  35154. assert( !p->pPreallocatedUnused );
  35155. assert( eType==SQLITE_OPEN_WAL || eType==SQLITE_OPEN_MAIN_JOURNAL );
  35156. return rc;
  35157. }
  35158. fd = robust_open(zName, openFlags, openMode);
  35159. OSTRACE(("OPENX %-3d %s 0%o\n", fd, zName, openFlags));
  35160. assert( !isExclusive || (openFlags & O_CREAT)!=0 );
  35161. if( fd<0 ){
  35162. if( isNewJrnl && errno==EACCES && osAccess(zName, F_OK) ){
  35163. /* If unable to create a journal because the directory is not
  35164. ** writable, change the error code to indicate that. */
  35165. rc = SQLITE_READONLY_DIRECTORY;
  35166. }else if( errno!=EISDIR && isReadWrite ){
  35167. /* Failed to open the file for read/write access. Try read-only. */
  35168. flags &= ~(SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE);
  35169. openFlags &= ~(O_RDWR|O_CREAT);
  35170. flags |= SQLITE_OPEN_READONLY;
  35171. openFlags |= O_RDONLY;
  35172. isReadonly = 1;
  35173. fd = robust_open(zName, openFlags, openMode);
  35174. }
  35175. }
  35176. if( fd<0 ){
  35177. int rc2 = unixLogError(SQLITE_CANTOPEN_BKPT, "open", zName);
  35178. if( rc==SQLITE_OK ) rc = rc2;
  35179. goto open_finished;
  35180. }
  35181. /* If this process is running as root and if creating a new rollback
  35182. ** journal or WAL file, set the ownership of the journal or WAL to be
  35183. ** the same as the original database.
  35184. */
  35185. if( flags & (SQLITE_OPEN_WAL|SQLITE_OPEN_MAIN_JOURNAL) ){
  35186. robustFchown(fd, uid, gid);
  35187. }
  35188. }
  35189. assert( fd>=0 );
  35190. if( pOutFlags ){
  35191. *pOutFlags = flags;
  35192. }
  35193. if( p->pPreallocatedUnused ){
  35194. p->pPreallocatedUnused->fd = fd;
  35195. p->pPreallocatedUnused->flags = flags;
  35196. }
  35197. if( isDelete ){
  35198. #if OS_VXWORKS
  35199. zPath = zName;
  35200. #elif defined(SQLITE_UNLINK_AFTER_CLOSE)
  35201. zPath = sqlite3_mprintf("%s", zName);
  35202. if( zPath==0 ){
  35203. robust_close(p, fd, __LINE__);
  35204. return SQLITE_NOMEM_BKPT;
  35205. }
  35206. #else
  35207. osUnlink(zName);
  35208. #endif
  35209. }
  35210. #if SQLITE_ENABLE_LOCKING_STYLE
  35211. else{
  35212. p->openFlags = openFlags;
  35213. }
  35214. #endif
  35215. #if defined(__APPLE__) || SQLITE_ENABLE_LOCKING_STYLE
  35216. if( fstatfs(fd, &fsInfo) == -1 ){
  35217. storeLastErrno(p, errno);
  35218. robust_close(p, fd, __LINE__);
  35219. return SQLITE_IOERR_ACCESS;
  35220. }
  35221. if (0 == strncmp("msdos", fsInfo.f_fstypename, 5)) {
  35222. ((unixFile*)pFile)->fsFlags |= SQLITE_FSFLAGS_IS_MSDOS;
  35223. }
  35224. if (0 == strncmp("exfat", fsInfo.f_fstypename, 5)) {
  35225. ((unixFile*)pFile)->fsFlags |= SQLITE_FSFLAGS_IS_MSDOS;
  35226. }
  35227. #endif
  35228. /* Set up appropriate ctrlFlags */
  35229. if( isDelete ) ctrlFlags |= UNIXFILE_DELETE;
  35230. if( isReadonly ) ctrlFlags |= UNIXFILE_RDONLY;
  35231. noLock = eType!=SQLITE_OPEN_MAIN_DB;
  35232. if( noLock ) ctrlFlags |= UNIXFILE_NOLOCK;
  35233. if( isNewJrnl ) ctrlFlags |= UNIXFILE_DIRSYNC;
  35234. if( flags & SQLITE_OPEN_URI ) ctrlFlags |= UNIXFILE_URI;
  35235. #if SQLITE_ENABLE_LOCKING_STYLE
  35236. #if SQLITE_PREFER_PROXY_LOCKING
  35237. isAutoProxy = 1;
  35238. #endif
  35239. if( isAutoProxy && (zPath!=NULL) && (!noLock) && pVfs->xOpen ){
  35240. char *envforce = getenv("SQLITE_FORCE_PROXY_LOCKING");
  35241. int useProxy = 0;
  35242. /* SQLITE_FORCE_PROXY_LOCKING==1 means force always use proxy, 0 means
  35243. ** never use proxy, NULL means use proxy for non-local files only. */
  35244. if( envforce!=NULL ){
  35245. useProxy = atoi(envforce)>0;
  35246. }else{
  35247. useProxy = !(fsInfo.f_flags&MNT_LOCAL);
  35248. }
  35249. if( useProxy ){
  35250. rc = fillInUnixFile(pVfs, fd, pFile, zPath, ctrlFlags);
  35251. if( rc==SQLITE_OK ){
  35252. rc = proxyTransformUnixFile((unixFile*)pFile, ":auto:");
  35253. if( rc!=SQLITE_OK ){
  35254. /* Use unixClose to clean up the resources added in fillInUnixFile
  35255. ** and clear all the structure's references. Specifically,
  35256. ** pFile->pMethods will be NULL so sqlite3OsClose will be a no-op
  35257. */
  35258. unixClose(pFile);
  35259. return rc;
  35260. }
  35261. }
  35262. goto open_finished;
  35263. }
  35264. }
  35265. #endif
  35266. assert( zPath==0 || zPath[0]=='/'
  35267. || eType==SQLITE_OPEN_MASTER_JOURNAL || eType==SQLITE_OPEN_MAIN_JOURNAL
  35268. );
  35269. rc = fillInUnixFile(pVfs, fd, pFile, zPath, ctrlFlags);
  35270. open_finished:
  35271. if( rc!=SQLITE_OK ){
  35272. sqlite3_free(p->pPreallocatedUnused);
  35273. }
  35274. return rc;
  35275. }
  35276. /*
  35277. ** Delete the file at zPath. If the dirSync argument is true, fsync()
  35278. ** the directory after deleting the file.
  35279. */
  35280. static int unixDelete(
  35281. sqlite3_vfs *NotUsed, /* VFS containing this as the xDelete method */
  35282. const char *zPath, /* Name of file to be deleted */
  35283. int dirSync /* If true, fsync() directory after deleting file */
  35284. ){
  35285. int rc = SQLITE_OK;
  35286. UNUSED_PARAMETER(NotUsed);
  35287. SimulateIOError(return SQLITE_IOERR_DELETE);
  35288. if( osUnlink(zPath)==(-1) ){
  35289. if( errno==ENOENT
  35290. #if OS_VXWORKS
  35291. || osAccess(zPath,0)!=0
  35292. #endif
  35293. ){
  35294. rc = SQLITE_IOERR_DELETE_NOENT;
  35295. }else{
  35296. rc = unixLogError(SQLITE_IOERR_DELETE, "unlink", zPath);
  35297. }
  35298. return rc;
  35299. }
  35300. #ifndef SQLITE_DISABLE_DIRSYNC
  35301. if( (dirSync & 1)!=0 ){
  35302. int fd;
  35303. rc = osOpenDirectory(zPath, &fd);
  35304. if( rc==SQLITE_OK ){
  35305. if( full_fsync(fd,0,0) ){
  35306. rc = unixLogError(SQLITE_IOERR_DIR_FSYNC, "fsync", zPath);
  35307. }
  35308. robust_close(0, fd, __LINE__);
  35309. }else{
  35310. assert( rc==SQLITE_CANTOPEN );
  35311. rc = SQLITE_OK;
  35312. }
  35313. }
  35314. #endif
  35315. return rc;
  35316. }
  35317. /*
  35318. ** Test the existence of or access permissions of file zPath. The
  35319. ** test performed depends on the value of flags:
  35320. **
  35321. ** SQLITE_ACCESS_EXISTS: Return 1 if the file exists
  35322. ** SQLITE_ACCESS_READWRITE: Return 1 if the file is read and writable.
  35323. ** SQLITE_ACCESS_READONLY: Return 1 if the file is readable.
  35324. **
  35325. ** Otherwise return 0.
  35326. */
  35327. static int unixAccess(
  35328. sqlite3_vfs *NotUsed, /* The VFS containing this xAccess method */
  35329. const char *zPath, /* Path of the file to examine */
  35330. int flags, /* What do we want to learn about the zPath file? */
  35331. int *pResOut /* Write result boolean here */
  35332. ){
  35333. UNUSED_PARAMETER(NotUsed);
  35334. SimulateIOError( return SQLITE_IOERR_ACCESS; );
  35335. assert( pResOut!=0 );
  35336. /* The spec says there are three possible values for flags. But only
  35337. ** two of them are actually used */
  35338. assert( flags==SQLITE_ACCESS_EXISTS || flags==SQLITE_ACCESS_READWRITE );
  35339. if( flags==SQLITE_ACCESS_EXISTS ){
  35340. struct stat buf;
  35341. *pResOut = (0==osStat(zPath, &buf) && buf.st_size>0);
  35342. }else{
  35343. *pResOut = osAccess(zPath, W_OK|R_OK)==0;
  35344. }
  35345. return SQLITE_OK;
  35346. }
  35347. /*
  35348. **
  35349. */
  35350. static int mkFullPathname(
  35351. const char *zPath, /* Input path */
  35352. char *zOut, /* Output buffer */
  35353. int nOut /* Allocated size of buffer zOut */
  35354. ){
  35355. int nPath = sqlite3Strlen30(zPath);
  35356. int iOff = 0;
  35357. if( zPath[0]!='/' ){
  35358. if( osGetcwd(zOut, nOut-2)==0 ){
  35359. return unixLogError(SQLITE_CANTOPEN_BKPT, "getcwd", zPath);
  35360. }
  35361. iOff = sqlite3Strlen30(zOut);
  35362. zOut[iOff++] = '/';
  35363. }
  35364. if( (iOff+nPath+1)>nOut ){
  35365. /* SQLite assumes that xFullPathname() nul-terminates the output buffer
  35366. ** even if it returns an error. */
  35367. zOut[iOff] = '\0';
  35368. return SQLITE_CANTOPEN_BKPT;
  35369. }
  35370. sqlite3_snprintf(nOut-iOff, &zOut[iOff], "%s", zPath);
  35371. return SQLITE_OK;
  35372. }
  35373. /*
  35374. ** Turn a relative pathname into a full pathname. The relative path
  35375. ** is stored as a nul-terminated string in the buffer pointed to by
  35376. ** zPath.
  35377. **
  35378. ** zOut points to a buffer of at least sqlite3_vfs.mxPathname bytes
  35379. ** (in this case, MAX_PATHNAME bytes). The full-path is written to
  35380. ** this buffer before returning.
  35381. */
  35382. static int unixFullPathname(
  35383. sqlite3_vfs *pVfs, /* Pointer to vfs object */
  35384. const char *zPath, /* Possibly relative input path */
  35385. int nOut, /* Size of output buffer in bytes */
  35386. char *zOut /* Output buffer */
  35387. ){
  35388. #if !defined(HAVE_READLINK) || !defined(HAVE_LSTAT)
  35389. return mkFullPathname(zPath, zOut, nOut);
  35390. #else
  35391. int rc = SQLITE_OK;
  35392. int nByte;
  35393. int nLink = 1; /* Number of symbolic links followed so far */
  35394. const char *zIn = zPath; /* Input path for each iteration of loop */
  35395. char *zDel = 0;
  35396. assert( pVfs->mxPathname==MAX_PATHNAME );
  35397. UNUSED_PARAMETER(pVfs);
  35398. /* It's odd to simulate an io-error here, but really this is just
  35399. ** using the io-error infrastructure to test that SQLite handles this
  35400. ** function failing. This function could fail if, for example, the
  35401. ** current working directory has been unlinked.
  35402. */
  35403. SimulateIOError( return SQLITE_ERROR );
  35404. do {
  35405. /* Call stat() on path zIn. Set bLink to true if the path is a symbolic
  35406. ** link, or false otherwise. */
  35407. int bLink = 0;
  35408. struct stat buf;
  35409. if( osLstat(zIn, &buf)!=0 ){
  35410. if( errno!=ENOENT ){
  35411. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "lstat", zIn);
  35412. }
  35413. }else{
  35414. bLink = S_ISLNK(buf.st_mode);
  35415. }
  35416. if( bLink ){
  35417. if( zDel==0 ){
  35418. zDel = sqlite3_malloc(nOut);
  35419. if( zDel==0 ) rc = SQLITE_NOMEM_BKPT;
  35420. }else if( ++nLink>SQLITE_MAX_SYMLINKS ){
  35421. rc = SQLITE_CANTOPEN_BKPT;
  35422. }
  35423. if( rc==SQLITE_OK ){
  35424. nByte = osReadlink(zIn, zDel, nOut-1);
  35425. if( nByte<0 ){
  35426. rc = unixLogError(SQLITE_CANTOPEN_BKPT, "readlink", zIn);
  35427. }else{
  35428. if( zDel[0]!='/' ){
  35429. int n;
  35430. for(n = sqlite3Strlen30(zIn); n>0 && zIn[n-1]!='/'; n--);
  35431. if( nByte+n+1>nOut ){
  35432. rc = SQLITE_CANTOPEN_BKPT;
  35433. }else{
  35434. memmove(&zDel[n], zDel, nByte+1);
  35435. memcpy(zDel, zIn, n);
  35436. nByte += n;
  35437. }
  35438. }
  35439. zDel[nByte] = '\0';
  35440. }
  35441. }
  35442. zIn = zDel;
  35443. }
  35444. assert( rc!=SQLITE_OK || zIn!=zOut || zIn[0]=='/' );
  35445. if( rc==SQLITE_OK && zIn!=zOut ){
  35446. rc = mkFullPathname(zIn, zOut, nOut);
  35447. }
  35448. if( bLink==0 ) break;
  35449. zIn = zOut;
  35450. }while( rc==SQLITE_OK );
  35451. sqlite3_free(zDel);
  35452. return rc;
  35453. #endif /* HAVE_READLINK && HAVE_LSTAT */
  35454. }
  35455. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  35456. /*
  35457. ** Interfaces for opening a shared library, finding entry points
  35458. ** within the shared library, and closing the shared library.
  35459. */
  35460. #include <dlfcn.h>
  35461. static void *unixDlOpen(sqlite3_vfs *NotUsed, const char *zFilename){
  35462. UNUSED_PARAMETER(NotUsed);
  35463. return dlopen(zFilename, RTLD_NOW | RTLD_GLOBAL);
  35464. }
  35465. /*
  35466. ** SQLite calls this function immediately after a call to unixDlSym() or
  35467. ** unixDlOpen() fails (returns a null pointer). If a more detailed error
  35468. ** message is available, it is written to zBufOut. If no error message
  35469. ** is available, zBufOut is left unmodified and SQLite uses a default
  35470. ** error message.
  35471. */
  35472. static void unixDlError(sqlite3_vfs *NotUsed, int nBuf, char *zBufOut){
  35473. const char *zErr;
  35474. UNUSED_PARAMETER(NotUsed);
  35475. unixEnterMutex();
  35476. zErr = dlerror();
  35477. if( zErr ){
  35478. sqlite3_snprintf(nBuf, zBufOut, "%s", zErr);
  35479. }
  35480. unixLeaveMutex();
  35481. }
  35482. static void (*unixDlSym(sqlite3_vfs *NotUsed, void *p, const char*zSym))(void){
  35483. /*
  35484. ** GCC with -pedantic-errors says that C90 does not allow a void* to be
  35485. ** cast into a pointer to a function. And yet the library dlsym() routine
  35486. ** returns a void* which is really a pointer to a function. So how do we
  35487. ** use dlsym() with -pedantic-errors?
  35488. **
  35489. ** Variable x below is defined to be a pointer to a function taking
  35490. ** parameters void* and const char* and returning a pointer to a function.
  35491. ** We initialize x by assigning it a pointer to the dlsym() function.
  35492. ** (That assignment requires a cast.) Then we call the function that
  35493. ** x points to.
  35494. **
  35495. ** This work-around is unlikely to work correctly on any system where
  35496. ** you really cannot cast a function pointer into void*. But then, on the
  35497. ** other hand, dlsym() will not work on such a system either, so we have
  35498. ** not really lost anything.
  35499. */
  35500. void (*(*x)(void*,const char*))(void);
  35501. UNUSED_PARAMETER(NotUsed);
  35502. x = (void(*(*)(void*,const char*))(void))dlsym;
  35503. return (*x)(p, zSym);
  35504. }
  35505. static void unixDlClose(sqlite3_vfs *NotUsed, void *pHandle){
  35506. UNUSED_PARAMETER(NotUsed);
  35507. dlclose(pHandle);
  35508. }
  35509. #else /* if SQLITE_OMIT_LOAD_EXTENSION is defined: */
  35510. #define unixDlOpen 0
  35511. #define unixDlError 0
  35512. #define unixDlSym 0
  35513. #define unixDlClose 0
  35514. #endif
  35515. /*
  35516. ** Write nBuf bytes of random data to the supplied buffer zBuf.
  35517. */
  35518. static int unixRandomness(sqlite3_vfs *NotUsed, int nBuf, char *zBuf){
  35519. UNUSED_PARAMETER(NotUsed);
  35520. assert((size_t)nBuf>=(sizeof(time_t)+sizeof(int)));
  35521. /* We have to initialize zBuf to prevent valgrind from reporting
  35522. ** errors. The reports issued by valgrind are incorrect - we would
  35523. ** prefer that the randomness be increased by making use of the
  35524. ** uninitialized space in zBuf - but valgrind errors tend to worry
  35525. ** some users. Rather than argue, it seems easier just to initialize
  35526. ** the whole array and silence valgrind, even if that means less randomness
  35527. ** in the random seed.
  35528. **
  35529. ** When testing, initializing zBuf[] to zero is all we do. That means
  35530. ** that we always use the same random number sequence. This makes the
  35531. ** tests repeatable.
  35532. */
  35533. memset(zBuf, 0, nBuf);
  35534. randomnessPid = osGetpid(0);
  35535. #if !defined(SQLITE_TEST) && !defined(SQLITE_OMIT_RANDOMNESS)
  35536. {
  35537. int fd, got;
  35538. fd = robust_open("/dev/urandom", O_RDONLY, 0);
  35539. if( fd<0 ){
  35540. time_t t;
  35541. time(&t);
  35542. memcpy(zBuf, &t, sizeof(t));
  35543. memcpy(&zBuf[sizeof(t)], &randomnessPid, sizeof(randomnessPid));
  35544. assert( sizeof(t)+sizeof(randomnessPid)<=(size_t)nBuf );
  35545. nBuf = sizeof(t) + sizeof(randomnessPid);
  35546. }else{
  35547. do{ got = osRead(fd, zBuf, nBuf); }while( got<0 && errno==EINTR );
  35548. robust_close(0, fd, __LINE__);
  35549. }
  35550. }
  35551. #endif
  35552. return nBuf;
  35553. }
  35554. /*
  35555. ** Sleep for a little while. Return the amount of time slept.
  35556. ** The argument is the number of microseconds we want to sleep.
  35557. ** The return value is the number of microseconds of sleep actually
  35558. ** requested from the underlying operating system, a number which
  35559. ** might be greater than or equal to the argument, but not less
  35560. ** than the argument.
  35561. */
  35562. static int unixSleep(sqlite3_vfs *NotUsed, int microseconds){
  35563. #if OS_VXWORKS
  35564. struct timespec sp;
  35565. sp.tv_sec = microseconds / 1000000;
  35566. sp.tv_nsec = (microseconds % 1000000) * 1000;
  35567. nanosleep(&sp, NULL);
  35568. UNUSED_PARAMETER(NotUsed);
  35569. return microseconds;
  35570. #elif defined(HAVE_USLEEP) && HAVE_USLEEP
  35571. usleep(microseconds);
  35572. UNUSED_PARAMETER(NotUsed);
  35573. return microseconds;
  35574. #else
  35575. int seconds = (microseconds+999999)/1000000;
  35576. sleep(seconds);
  35577. UNUSED_PARAMETER(NotUsed);
  35578. return seconds*1000000;
  35579. #endif
  35580. }
  35581. /*
  35582. ** The following variable, if set to a non-zero value, is interpreted as
  35583. ** the number of seconds since 1970 and is used to set the result of
  35584. ** sqlite3OsCurrentTime() during testing.
  35585. */
  35586. #ifdef SQLITE_TEST
  35587. SQLITE_API int sqlite3_current_time = 0; /* Fake system time in seconds since 1970. */
  35588. #endif
  35589. /*
  35590. ** Find the current time (in Universal Coordinated Time). Write into *piNow
  35591. ** the current time and date as a Julian Day number times 86_400_000. In
  35592. ** other words, write into *piNow the number of milliseconds since the Julian
  35593. ** epoch of noon in Greenwich on November 24, 4714 B.C according to the
  35594. ** proleptic Gregorian calendar.
  35595. **
  35596. ** On success, return SQLITE_OK. Return SQLITE_ERROR if the time and date
  35597. ** cannot be found.
  35598. */
  35599. static int unixCurrentTimeInt64(sqlite3_vfs *NotUsed, sqlite3_int64 *piNow){
  35600. static const sqlite3_int64 unixEpoch = 24405875*(sqlite3_int64)8640000;
  35601. int rc = SQLITE_OK;
  35602. #if defined(NO_GETTOD)
  35603. time_t t;
  35604. time(&t);
  35605. *piNow = ((sqlite3_int64)t)*1000 + unixEpoch;
  35606. #elif OS_VXWORKS
  35607. struct timespec sNow;
  35608. clock_gettime(CLOCK_REALTIME, &sNow);
  35609. *piNow = unixEpoch + 1000*(sqlite3_int64)sNow.tv_sec + sNow.tv_nsec/1000000;
  35610. #else
  35611. struct timeval sNow;
  35612. (void)gettimeofday(&sNow, 0); /* Cannot fail given valid arguments */
  35613. *piNow = unixEpoch + 1000*(sqlite3_int64)sNow.tv_sec + sNow.tv_usec/1000;
  35614. #endif
  35615. #ifdef SQLITE_TEST
  35616. if( sqlite3_current_time ){
  35617. *piNow = 1000*(sqlite3_int64)sqlite3_current_time + unixEpoch;
  35618. }
  35619. #endif
  35620. UNUSED_PARAMETER(NotUsed);
  35621. return rc;
  35622. }
  35623. #ifndef SQLITE_OMIT_DEPRECATED
  35624. /*
  35625. ** Find the current time (in Universal Coordinated Time). Write the
  35626. ** current time and date as a Julian Day number into *prNow and
  35627. ** return 0. Return 1 if the time and date cannot be found.
  35628. */
  35629. static int unixCurrentTime(sqlite3_vfs *NotUsed, double *prNow){
  35630. sqlite3_int64 i = 0;
  35631. int rc;
  35632. UNUSED_PARAMETER(NotUsed);
  35633. rc = unixCurrentTimeInt64(0, &i);
  35634. *prNow = i/86400000.0;
  35635. return rc;
  35636. }
  35637. #else
  35638. # define unixCurrentTime 0
  35639. #endif
  35640. /*
  35641. ** The xGetLastError() method is designed to return a better
  35642. ** low-level error message when operating-system problems come up
  35643. ** during SQLite operation. Only the integer return code is currently
  35644. ** used.
  35645. */
  35646. static int unixGetLastError(sqlite3_vfs *NotUsed, int NotUsed2, char *NotUsed3){
  35647. UNUSED_PARAMETER(NotUsed);
  35648. UNUSED_PARAMETER(NotUsed2);
  35649. UNUSED_PARAMETER(NotUsed3);
  35650. return errno;
  35651. }
  35652. /*
  35653. ************************ End of sqlite3_vfs methods ***************************
  35654. ******************************************************************************/
  35655. /******************************************************************************
  35656. ************************** Begin Proxy Locking ********************************
  35657. **
  35658. ** Proxy locking is a "uber-locking-method" in this sense: It uses the
  35659. ** other locking methods on secondary lock files. Proxy locking is a
  35660. ** meta-layer over top of the primitive locking implemented above. For
  35661. ** this reason, the division that implements of proxy locking is deferred
  35662. ** until late in the file (here) after all of the other I/O methods have
  35663. ** been defined - so that the primitive locking methods are available
  35664. ** as services to help with the implementation of proxy locking.
  35665. **
  35666. ****
  35667. **
  35668. ** The default locking schemes in SQLite use byte-range locks on the
  35669. ** database file to coordinate safe, concurrent access by multiple readers
  35670. ** and writers [http://sqlite.org/lockingv3.html]. The five file locking
  35671. ** states (UNLOCKED, PENDING, SHARED, RESERVED, EXCLUSIVE) are implemented
  35672. ** as POSIX read & write locks over fixed set of locations (via fsctl),
  35673. ** on AFP and SMB only exclusive byte-range locks are available via fsctl
  35674. ** with _IOWR('z', 23, struct ByteRangeLockPB2) to track the same 5 states.
  35675. ** To simulate a F_RDLCK on the shared range, on AFP a randomly selected
  35676. ** address in the shared range is taken for a SHARED lock, the entire
  35677. ** shared range is taken for an EXCLUSIVE lock):
  35678. **
  35679. ** PENDING_BYTE 0x40000000
  35680. ** RESERVED_BYTE 0x40000001
  35681. ** SHARED_RANGE 0x40000002 -> 0x40000200
  35682. **
  35683. ** This works well on the local file system, but shows a nearly 100x
  35684. ** slowdown in read performance on AFP because the AFP client disables
  35685. ** the read cache when byte-range locks are present. Enabling the read
  35686. ** cache exposes a cache coherency problem that is present on all OS X
  35687. ** supported network file systems. NFS and AFP both observe the
  35688. ** close-to-open semantics for ensuring cache coherency
  35689. ** [http://nfs.sourceforge.net/#faq_a8], which does not effectively
  35690. ** address the requirements for concurrent database access by multiple
  35691. ** readers and writers
  35692. ** [http://www.nabble.com/SQLite-on-NFS-cache-coherency-td15655701.html].
  35693. **
  35694. ** To address the performance and cache coherency issues, proxy file locking
  35695. ** changes the way database access is controlled by limiting access to a
  35696. ** single host at a time and moving file locks off of the database file
  35697. ** and onto a proxy file on the local file system.
  35698. **
  35699. **
  35700. ** Using proxy locks
  35701. ** -----------------
  35702. **
  35703. ** C APIs
  35704. **
  35705. ** sqlite3_file_control(db, dbname, SQLITE_FCNTL_SET_LOCKPROXYFILE,
  35706. ** <proxy_path> | ":auto:");
  35707. ** sqlite3_file_control(db, dbname, SQLITE_FCNTL_GET_LOCKPROXYFILE,
  35708. ** &<proxy_path>);
  35709. **
  35710. **
  35711. ** SQL pragmas
  35712. **
  35713. ** PRAGMA [database.]lock_proxy_file=<proxy_path> | :auto:
  35714. ** PRAGMA [database.]lock_proxy_file
  35715. **
  35716. ** Specifying ":auto:" means that if there is a conch file with a matching
  35717. ** host ID in it, the proxy path in the conch file will be used, otherwise
  35718. ** a proxy path based on the user's temp dir
  35719. ** (via confstr(_CS_DARWIN_USER_TEMP_DIR,...)) will be used and the
  35720. ** actual proxy file name is generated from the name and path of the
  35721. ** database file. For example:
  35722. **
  35723. ** For database path "/Users/me/foo.db"
  35724. ** The lock path will be "<tmpdir>/sqliteplocks/_Users_me_foo.db:auto:")
  35725. **
  35726. ** Once a lock proxy is configured for a database connection, it can not
  35727. ** be removed, however it may be switched to a different proxy path via
  35728. ** the above APIs (assuming the conch file is not being held by another
  35729. ** connection or process).
  35730. **
  35731. **
  35732. ** How proxy locking works
  35733. ** -----------------------
  35734. **
  35735. ** Proxy file locking relies primarily on two new supporting files:
  35736. **
  35737. ** * conch file to limit access to the database file to a single host
  35738. ** at a time
  35739. **
  35740. ** * proxy file to act as a proxy for the advisory locks normally
  35741. ** taken on the database
  35742. **
  35743. ** The conch file - to use a proxy file, sqlite must first "hold the conch"
  35744. ** by taking an sqlite-style shared lock on the conch file, reading the
  35745. ** contents and comparing the host's unique host ID (see below) and lock
  35746. ** proxy path against the values stored in the conch. The conch file is
  35747. ** stored in the same directory as the database file and the file name
  35748. ** is patterned after the database file name as ".<databasename>-conch".
  35749. ** If the conch file does not exist, or its contents do not match the
  35750. ** host ID and/or proxy path, then the lock is escalated to an exclusive
  35751. ** lock and the conch file contents is updated with the host ID and proxy
  35752. ** path and the lock is downgraded to a shared lock again. If the conch
  35753. ** is held by another process (with a shared lock), the exclusive lock
  35754. ** will fail and SQLITE_BUSY is returned.
  35755. **
  35756. ** The proxy file - a single-byte file used for all advisory file locks
  35757. ** normally taken on the database file. This allows for safe sharing
  35758. ** of the database file for multiple readers and writers on the same
  35759. ** host (the conch ensures that they all use the same local lock file).
  35760. **
  35761. ** Requesting the lock proxy does not immediately take the conch, it is
  35762. ** only taken when the first request to lock database file is made.
  35763. ** This matches the semantics of the traditional locking behavior, where
  35764. ** opening a connection to a database file does not take a lock on it.
  35765. ** The shared lock and an open file descriptor are maintained until
  35766. ** the connection to the database is closed.
  35767. **
  35768. ** The proxy file and the lock file are never deleted so they only need
  35769. ** to be created the first time they are used.
  35770. **
  35771. ** Configuration options
  35772. ** ---------------------
  35773. **
  35774. ** SQLITE_PREFER_PROXY_LOCKING
  35775. **
  35776. ** Database files accessed on non-local file systems are
  35777. ** automatically configured for proxy locking, lock files are
  35778. ** named automatically using the same logic as
  35779. ** PRAGMA lock_proxy_file=":auto:"
  35780. **
  35781. ** SQLITE_PROXY_DEBUG
  35782. **
  35783. ** Enables the logging of error messages during host id file
  35784. ** retrieval and creation
  35785. **
  35786. ** LOCKPROXYDIR
  35787. **
  35788. ** Overrides the default directory used for lock proxy files that
  35789. ** are named automatically via the ":auto:" setting
  35790. **
  35791. ** SQLITE_DEFAULT_PROXYDIR_PERMISSIONS
  35792. **
  35793. ** Permissions to use when creating a directory for storing the
  35794. ** lock proxy files, only used when LOCKPROXYDIR is not set.
  35795. **
  35796. **
  35797. ** As mentioned above, when compiled with SQLITE_PREFER_PROXY_LOCKING,
  35798. ** setting the environment variable SQLITE_FORCE_PROXY_LOCKING to 1 will
  35799. ** force proxy locking to be used for every database file opened, and 0
  35800. ** will force automatic proxy locking to be disabled for all database
  35801. ** files (explicitly calling the SQLITE_FCNTL_SET_LOCKPROXYFILE pragma or
  35802. ** sqlite_file_control API is not affected by SQLITE_FORCE_PROXY_LOCKING).
  35803. */
  35804. /*
  35805. ** Proxy locking is only available on MacOSX
  35806. */
  35807. #if defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE
  35808. /*
  35809. ** The proxyLockingContext has the path and file structures for the remote
  35810. ** and local proxy files in it
  35811. */
  35812. typedef struct proxyLockingContext proxyLockingContext;
  35813. struct proxyLockingContext {
  35814. unixFile *conchFile; /* Open conch file */
  35815. char *conchFilePath; /* Name of the conch file */
  35816. unixFile *lockProxy; /* Open proxy lock file */
  35817. char *lockProxyPath; /* Name of the proxy lock file */
  35818. char *dbPath; /* Name of the open file */
  35819. int conchHeld; /* 1 if the conch is held, -1 if lockless */
  35820. int nFails; /* Number of conch taking failures */
  35821. void *oldLockingContext; /* Original lockingcontext to restore on close */
  35822. sqlite3_io_methods const *pOldMethod; /* Original I/O methods for close */
  35823. };
  35824. /*
  35825. ** The proxy lock file path for the database at dbPath is written into lPath,
  35826. ** which must point to valid, writable memory large enough for a maxLen length
  35827. ** file path.
  35828. */
  35829. static int proxyGetLockPath(const char *dbPath, char *lPath, size_t maxLen){
  35830. int len;
  35831. int dbLen;
  35832. int i;
  35833. #ifdef LOCKPROXYDIR
  35834. len = strlcpy(lPath, LOCKPROXYDIR, maxLen);
  35835. #else
  35836. # ifdef _CS_DARWIN_USER_TEMP_DIR
  35837. {
  35838. if( !confstr(_CS_DARWIN_USER_TEMP_DIR, lPath, maxLen) ){
  35839. OSTRACE(("GETLOCKPATH failed %s errno=%d pid=%d\n",
  35840. lPath, errno, osGetpid(0)));
  35841. return SQLITE_IOERR_LOCK;
  35842. }
  35843. len = strlcat(lPath, "sqliteplocks", maxLen);
  35844. }
  35845. # else
  35846. len = strlcpy(lPath, "/tmp/", maxLen);
  35847. # endif
  35848. #endif
  35849. if( lPath[len-1]!='/' ){
  35850. len = strlcat(lPath, "/", maxLen);
  35851. }
  35852. /* transform the db path to a unique cache name */
  35853. dbLen = (int)strlen(dbPath);
  35854. for( i=0; i<dbLen && (i+len+7)<(int)maxLen; i++){
  35855. char c = dbPath[i];
  35856. lPath[i+len] = (c=='/')?'_':c;
  35857. }
  35858. lPath[i+len]='\0';
  35859. strlcat(lPath, ":auto:", maxLen);
  35860. OSTRACE(("GETLOCKPATH proxy lock path=%s pid=%d\n", lPath, osGetpid(0)));
  35861. return SQLITE_OK;
  35862. }
  35863. /*
  35864. ** Creates the lock file and any missing directories in lockPath
  35865. */
  35866. static int proxyCreateLockPath(const char *lockPath){
  35867. int i, len;
  35868. char buf[MAXPATHLEN];
  35869. int start = 0;
  35870. assert(lockPath!=NULL);
  35871. /* try to create all the intermediate directories */
  35872. len = (int)strlen(lockPath);
  35873. buf[0] = lockPath[0];
  35874. for( i=1; i<len; i++ ){
  35875. if( lockPath[i] == '/' && (i - start > 0) ){
  35876. /* only mkdir if leaf dir != "." or "/" or ".." */
  35877. if( i-start>2 || (i-start==1 && buf[start] != '.' && buf[start] != '/')
  35878. || (i-start==2 && buf[start] != '.' && buf[start+1] != '.') ){
  35879. buf[i]='\0';
  35880. if( osMkdir(buf, SQLITE_DEFAULT_PROXYDIR_PERMISSIONS) ){
  35881. int err=errno;
  35882. if( err!=EEXIST ) {
  35883. OSTRACE(("CREATELOCKPATH FAILED creating %s, "
  35884. "'%s' proxy lock path=%s pid=%d\n",
  35885. buf, strerror(err), lockPath, osGetpid(0)));
  35886. return err;
  35887. }
  35888. }
  35889. }
  35890. start=i+1;
  35891. }
  35892. buf[i] = lockPath[i];
  35893. }
  35894. OSTRACE(("CREATELOCKPATH proxy lock path=%s pid=%d\n",lockPath,osGetpid(0)));
  35895. return 0;
  35896. }
  35897. /*
  35898. ** Create a new VFS file descriptor (stored in memory obtained from
  35899. ** sqlite3_malloc) and open the file named "path" in the file descriptor.
  35900. **
  35901. ** The caller is responsible not only for closing the file descriptor
  35902. ** but also for freeing the memory associated with the file descriptor.
  35903. */
  35904. static int proxyCreateUnixFile(
  35905. const char *path, /* path for the new unixFile */
  35906. unixFile **ppFile, /* unixFile created and returned by ref */
  35907. int islockfile /* if non zero missing dirs will be created */
  35908. ) {
  35909. int fd = -1;
  35910. unixFile *pNew;
  35911. int rc = SQLITE_OK;
  35912. int openFlags = O_RDWR | O_CREAT;
  35913. sqlite3_vfs dummyVfs;
  35914. int terrno = 0;
  35915. UnixUnusedFd *pUnused = NULL;
  35916. /* 1. first try to open/create the file
  35917. ** 2. if that fails, and this is a lock file (not-conch), try creating
  35918. ** the parent directories and then try again.
  35919. ** 3. if that fails, try to open the file read-only
  35920. ** otherwise return BUSY (if lock file) or CANTOPEN for the conch file
  35921. */
  35922. pUnused = findReusableFd(path, openFlags);
  35923. if( pUnused ){
  35924. fd = pUnused->fd;
  35925. }else{
  35926. pUnused = sqlite3_malloc64(sizeof(*pUnused));
  35927. if( !pUnused ){
  35928. return SQLITE_NOMEM_BKPT;
  35929. }
  35930. }
  35931. if( fd<0 ){
  35932. fd = robust_open(path, openFlags, 0);
  35933. terrno = errno;
  35934. if( fd<0 && errno==ENOENT && islockfile ){
  35935. if( proxyCreateLockPath(path) == SQLITE_OK ){
  35936. fd = robust_open(path, openFlags, 0);
  35937. }
  35938. }
  35939. }
  35940. if( fd<0 ){
  35941. openFlags = O_RDONLY;
  35942. fd = robust_open(path, openFlags, 0);
  35943. terrno = errno;
  35944. }
  35945. if( fd<0 ){
  35946. if( islockfile ){
  35947. return SQLITE_BUSY;
  35948. }
  35949. switch (terrno) {
  35950. case EACCES:
  35951. return SQLITE_PERM;
  35952. case EIO:
  35953. return SQLITE_IOERR_LOCK; /* even though it is the conch */
  35954. default:
  35955. return SQLITE_CANTOPEN_BKPT;
  35956. }
  35957. }
  35958. pNew = (unixFile *)sqlite3_malloc64(sizeof(*pNew));
  35959. if( pNew==NULL ){
  35960. rc = SQLITE_NOMEM_BKPT;
  35961. goto end_create_proxy;
  35962. }
  35963. memset(pNew, 0, sizeof(unixFile));
  35964. pNew->openFlags = openFlags;
  35965. memset(&dummyVfs, 0, sizeof(dummyVfs));
  35966. dummyVfs.pAppData = (void*)&autolockIoFinder;
  35967. dummyVfs.zName = "dummy";
  35968. pUnused->fd = fd;
  35969. pUnused->flags = openFlags;
  35970. pNew->pPreallocatedUnused = pUnused;
  35971. rc = fillInUnixFile(&dummyVfs, fd, (sqlite3_file*)pNew, path, 0);
  35972. if( rc==SQLITE_OK ){
  35973. *ppFile = pNew;
  35974. return SQLITE_OK;
  35975. }
  35976. end_create_proxy:
  35977. robust_close(pNew, fd, __LINE__);
  35978. sqlite3_free(pNew);
  35979. sqlite3_free(pUnused);
  35980. return rc;
  35981. }
  35982. #ifdef SQLITE_TEST
  35983. /* simulate multiple hosts by creating unique hostid file paths */
  35984. SQLITE_API int sqlite3_hostid_num = 0;
  35985. #endif
  35986. #define PROXY_HOSTIDLEN 16 /* conch file host id length */
  35987. #ifdef HAVE_GETHOSTUUID
  35988. /* Not always defined in the headers as it ought to be */
  35989. extern int gethostuuid(uuid_t id, const struct timespec *wait);
  35990. #endif
  35991. /* get the host ID via gethostuuid(), pHostID must point to PROXY_HOSTIDLEN
  35992. ** bytes of writable memory.
  35993. */
  35994. static int proxyGetHostID(unsigned char *pHostID, int *pError){
  35995. assert(PROXY_HOSTIDLEN == sizeof(uuid_t));
  35996. memset(pHostID, 0, PROXY_HOSTIDLEN);
  35997. #ifdef HAVE_GETHOSTUUID
  35998. {
  35999. struct timespec timeout = {1, 0}; /* 1 sec timeout */
  36000. if( gethostuuid(pHostID, &timeout) ){
  36001. int err = errno;
  36002. if( pError ){
  36003. *pError = err;
  36004. }
  36005. return SQLITE_IOERR;
  36006. }
  36007. }
  36008. #else
  36009. UNUSED_PARAMETER(pError);
  36010. #endif
  36011. #ifdef SQLITE_TEST
  36012. /* simulate multiple hosts by creating unique hostid file paths */
  36013. if( sqlite3_hostid_num != 0){
  36014. pHostID[0] = (char)(pHostID[0] + (char)(sqlite3_hostid_num & 0xFF));
  36015. }
  36016. #endif
  36017. return SQLITE_OK;
  36018. }
  36019. /* The conch file contains the header, host id and lock file path
  36020. */
  36021. #define PROXY_CONCHVERSION 2 /* 1-byte header, 16-byte host id, path */
  36022. #define PROXY_HEADERLEN 1 /* conch file header length */
  36023. #define PROXY_PATHINDEX (PROXY_HEADERLEN+PROXY_HOSTIDLEN)
  36024. #define PROXY_MAXCONCHLEN (PROXY_HEADERLEN+PROXY_HOSTIDLEN+MAXPATHLEN)
  36025. /*
  36026. ** Takes an open conch file, copies the contents to a new path and then moves
  36027. ** it back. The newly created file's file descriptor is assigned to the
  36028. ** conch file structure and finally the original conch file descriptor is
  36029. ** closed. Returns zero if successful.
  36030. */
  36031. static int proxyBreakConchLock(unixFile *pFile, uuid_t myHostID){
  36032. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36033. unixFile *conchFile = pCtx->conchFile;
  36034. char tPath[MAXPATHLEN];
  36035. char buf[PROXY_MAXCONCHLEN];
  36036. char *cPath = pCtx->conchFilePath;
  36037. size_t readLen = 0;
  36038. size_t pathLen = 0;
  36039. char errmsg[64] = "";
  36040. int fd = -1;
  36041. int rc = -1;
  36042. UNUSED_PARAMETER(myHostID);
  36043. /* create a new path by replace the trailing '-conch' with '-break' */
  36044. pathLen = strlcpy(tPath, cPath, MAXPATHLEN);
  36045. if( pathLen>MAXPATHLEN || pathLen<6 ||
  36046. (strlcpy(&tPath[pathLen-5], "break", 6) != 5) ){
  36047. sqlite3_snprintf(sizeof(errmsg),errmsg,"path error (len %d)",(int)pathLen);
  36048. goto end_breaklock;
  36049. }
  36050. /* read the conch content */
  36051. readLen = osPread(conchFile->h, buf, PROXY_MAXCONCHLEN, 0);
  36052. if( readLen<PROXY_PATHINDEX ){
  36053. sqlite3_snprintf(sizeof(errmsg),errmsg,"read error (len %d)",(int)readLen);
  36054. goto end_breaklock;
  36055. }
  36056. /* write it out to the temporary break file */
  36057. fd = robust_open(tPath, (O_RDWR|O_CREAT|O_EXCL), 0);
  36058. if( fd<0 ){
  36059. sqlite3_snprintf(sizeof(errmsg), errmsg, "create failed (%d)", errno);
  36060. goto end_breaklock;
  36061. }
  36062. if( osPwrite(fd, buf, readLen, 0) != (ssize_t)readLen ){
  36063. sqlite3_snprintf(sizeof(errmsg), errmsg, "write failed (%d)", errno);
  36064. goto end_breaklock;
  36065. }
  36066. if( rename(tPath, cPath) ){
  36067. sqlite3_snprintf(sizeof(errmsg), errmsg, "rename failed (%d)", errno);
  36068. goto end_breaklock;
  36069. }
  36070. rc = 0;
  36071. fprintf(stderr, "broke stale lock on %s\n", cPath);
  36072. robust_close(pFile, conchFile->h, __LINE__);
  36073. conchFile->h = fd;
  36074. conchFile->openFlags = O_RDWR | O_CREAT;
  36075. end_breaklock:
  36076. if( rc ){
  36077. if( fd>=0 ){
  36078. osUnlink(tPath);
  36079. robust_close(pFile, fd, __LINE__);
  36080. }
  36081. fprintf(stderr, "failed to break stale lock on %s, %s\n", cPath, errmsg);
  36082. }
  36083. return rc;
  36084. }
  36085. /* Take the requested lock on the conch file and break a stale lock if the
  36086. ** host id matches.
  36087. */
  36088. static int proxyConchLock(unixFile *pFile, uuid_t myHostID, int lockType){
  36089. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36090. unixFile *conchFile = pCtx->conchFile;
  36091. int rc = SQLITE_OK;
  36092. int nTries = 0;
  36093. struct timespec conchModTime;
  36094. memset(&conchModTime, 0, sizeof(conchModTime));
  36095. do {
  36096. rc = conchFile->pMethod->xLock((sqlite3_file*)conchFile, lockType);
  36097. nTries ++;
  36098. if( rc==SQLITE_BUSY ){
  36099. /* If the lock failed (busy):
  36100. * 1st try: get the mod time of the conch, wait 0.5s and try again.
  36101. * 2nd try: fail if the mod time changed or host id is different, wait
  36102. * 10 sec and try again
  36103. * 3rd try: break the lock unless the mod time has changed.
  36104. */
  36105. struct stat buf;
  36106. if( osFstat(conchFile->h, &buf) ){
  36107. storeLastErrno(pFile, errno);
  36108. return SQLITE_IOERR_LOCK;
  36109. }
  36110. if( nTries==1 ){
  36111. conchModTime = buf.st_mtimespec;
  36112. usleep(500000); /* wait 0.5 sec and try the lock again*/
  36113. continue;
  36114. }
  36115. assert( nTries>1 );
  36116. if( conchModTime.tv_sec != buf.st_mtimespec.tv_sec ||
  36117. conchModTime.tv_nsec != buf.st_mtimespec.tv_nsec ){
  36118. return SQLITE_BUSY;
  36119. }
  36120. if( nTries==2 ){
  36121. char tBuf[PROXY_MAXCONCHLEN];
  36122. int len = osPread(conchFile->h, tBuf, PROXY_MAXCONCHLEN, 0);
  36123. if( len<0 ){
  36124. storeLastErrno(pFile, errno);
  36125. return SQLITE_IOERR_LOCK;
  36126. }
  36127. if( len>PROXY_PATHINDEX && tBuf[0]==(char)PROXY_CONCHVERSION){
  36128. /* don't break the lock if the host id doesn't match */
  36129. if( 0!=memcmp(&tBuf[PROXY_HEADERLEN], myHostID, PROXY_HOSTIDLEN) ){
  36130. return SQLITE_BUSY;
  36131. }
  36132. }else{
  36133. /* don't break the lock on short read or a version mismatch */
  36134. return SQLITE_BUSY;
  36135. }
  36136. usleep(10000000); /* wait 10 sec and try the lock again */
  36137. continue;
  36138. }
  36139. assert( nTries==3 );
  36140. if( 0==proxyBreakConchLock(pFile, myHostID) ){
  36141. rc = SQLITE_OK;
  36142. if( lockType==EXCLUSIVE_LOCK ){
  36143. rc = conchFile->pMethod->xLock((sqlite3_file*)conchFile, SHARED_LOCK);
  36144. }
  36145. if( !rc ){
  36146. rc = conchFile->pMethod->xLock((sqlite3_file*)conchFile, lockType);
  36147. }
  36148. }
  36149. }
  36150. } while( rc==SQLITE_BUSY && nTries<3 );
  36151. return rc;
  36152. }
  36153. /* Takes the conch by taking a shared lock and read the contents conch, if
  36154. ** lockPath is non-NULL, the host ID and lock file path must match. A NULL
  36155. ** lockPath means that the lockPath in the conch file will be used if the
  36156. ** host IDs match, or a new lock path will be generated automatically
  36157. ** and written to the conch file.
  36158. */
  36159. static int proxyTakeConch(unixFile *pFile){
  36160. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36161. if( pCtx->conchHeld!=0 ){
  36162. return SQLITE_OK;
  36163. }else{
  36164. unixFile *conchFile = pCtx->conchFile;
  36165. uuid_t myHostID;
  36166. int pError = 0;
  36167. char readBuf[PROXY_MAXCONCHLEN];
  36168. char lockPath[MAXPATHLEN];
  36169. char *tempLockPath = NULL;
  36170. int rc = SQLITE_OK;
  36171. int createConch = 0;
  36172. int hostIdMatch = 0;
  36173. int readLen = 0;
  36174. int tryOldLockPath = 0;
  36175. int forceNewLockPath = 0;
  36176. OSTRACE(("TAKECONCH %d for %s pid=%d\n", conchFile->h,
  36177. (pCtx->lockProxyPath ? pCtx->lockProxyPath : ":auto:"),
  36178. osGetpid(0)));
  36179. rc = proxyGetHostID(myHostID, &pError);
  36180. if( (rc&0xff)==SQLITE_IOERR ){
  36181. storeLastErrno(pFile, pError);
  36182. goto end_takeconch;
  36183. }
  36184. rc = proxyConchLock(pFile, myHostID, SHARED_LOCK);
  36185. if( rc!=SQLITE_OK ){
  36186. goto end_takeconch;
  36187. }
  36188. /* read the existing conch file */
  36189. readLen = seekAndRead((unixFile*)conchFile, 0, readBuf, PROXY_MAXCONCHLEN);
  36190. if( readLen<0 ){
  36191. /* I/O error: lastErrno set by seekAndRead */
  36192. storeLastErrno(pFile, conchFile->lastErrno);
  36193. rc = SQLITE_IOERR_READ;
  36194. goto end_takeconch;
  36195. }else if( readLen<=(PROXY_HEADERLEN+PROXY_HOSTIDLEN) ||
  36196. readBuf[0]!=(char)PROXY_CONCHVERSION ){
  36197. /* a short read or version format mismatch means we need to create a new
  36198. ** conch file.
  36199. */
  36200. createConch = 1;
  36201. }
  36202. /* if the host id matches and the lock path already exists in the conch
  36203. ** we'll try to use the path there, if we can't open that path, we'll
  36204. ** retry with a new auto-generated path
  36205. */
  36206. do { /* in case we need to try again for an :auto: named lock file */
  36207. if( !createConch && !forceNewLockPath ){
  36208. hostIdMatch = !memcmp(&readBuf[PROXY_HEADERLEN], myHostID,
  36209. PROXY_HOSTIDLEN);
  36210. /* if the conch has data compare the contents */
  36211. if( !pCtx->lockProxyPath ){
  36212. /* for auto-named local lock file, just check the host ID and we'll
  36213. ** use the local lock file path that's already in there
  36214. */
  36215. if( hostIdMatch ){
  36216. size_t pathLen = (readLen - PROXY_PATHINDEX);
  36217. if( pathLen>=MAXPATHLEN ){
  36218. pathLen=MAXPATHLEN-1;
  36219. }
  36220. memcpy(lockPath, &readBuf[PROXY_PATHINDEX], pathLen);
  36221. lockPath[pathLen] = 0;
  36222. tempLockPath = lockPath;
  36223. tryOldLockPath = 1;
  36224. /* create a copy of the lock path if the conch is taken */
  36225. goto end_takeconch;
  36226. }
  36227. }else if( hostIdMatch
  36228. && !strncmp(pCtx->lockProxyPath, &readBuf[PROXY_PATHINDEX],
  36229. readLen-PROXY_PATHINDEX)
  36230. ){
  36231. /* conch host and lock path match */
  36232. goto end_takeconch;
  36233. }
  36234. }
  36235. /* if the conch isn't writable and doesn't match, we can't take it */
  36236. if( (conchFile->openFlags&O_RDWR) == 0 ){
  36237. rc = SQLITE_BUSY;
  36238. goto end_takeconch;
  36239. }
  36240. /* either the conch didn't match or we need to create a new one */
  36241. if( !pCtx->lockProxyPath ){
  36242. proxyGetLockPath(pCtx->dbPath, lockPath, MAXPATHLEN);
  36243. tempLockPath = lockPath;
  36244. /* create a copy of the lock path _only_ if the conch is taken */
  36245. }
  36246. /* update conch with host and path (this will fail if other process
  36247. ** has a shared lock already), if the host id matches, use the big
  36248. ** stick.
  36249. */
  36250. futimes(conchFile->h, NULL);
  36251. if( hostIdMatch && !createConch ){
  36252. if( conchFile->pInode && conchFile->pInode->nShared>1 ){
  36253. /* We are trying for an exclusive lock but another thread in this
  36254. ** same process is still holding a shared lock. */
  36255. rc = SQLITE_BUSY;
  36256. } else {
  36257. rc = proxyConchLock(pFile, myHostID, EXCLUSIVE_LOCK);
  36258. }
  36259. }else{
  36260. rc = proxyConchLock(pFile, myHostID, EXCLUSIVE_LOCK);
  36261. }
  36262. if( rc==SQLITE_OK ){
  36263. char writeBuffer[PROXY_MAXCONCHLEN];
  36264. int writeSize = 0;
  36265. writeBuffer[0] = (char)PROXY_CONCHVERSION;
  36266. memcpy(&writeBuffer[PROXY_HEADERLEN], myHostID, PROXY_HOSTIDLEN);
  36267. if( pCtx->lockProxyPath!=NULL ){
  36268. strlcpy(&writeBuffer[PROXY_PATHINDEX], pCtx->lockProxyPath,
  36269. MAXPATHLEN);
  36270. }else{
  36271. strlcpy(&writeBuffer[PROXY_PATHINDEX], tempLockPath, MAXPATHLEN);
  36272. }
  36273. writeSize = PROXY_PATHINDEX + strlen(&writeBuffer[PROXY_PATHINDEX]);
  36274. robust_ftruncate(conchFile->h, writeSize);
  36275. rc = unixWrite((sqlite3_file *)conchFile, writeBuffer, writeSize, 0);
  36276. full_fsync(conchFile->h,0,0);
  36277. /* If we created a new conch file (not just updated the contents of a
  36278. ** valid conch file), try to match the permissions of the database
  36279. */
  36280. if( rc==SQLITE_OK && createConch ){
  36281. struct stat buf;
  36282. int err = osFstat(pFile->h, &buf);
  36283. if( err==0 ){
  36284. mode_t cmode = buf.st_mode&(S_IRUSR|S_IWUSR | S_IRGRP|S_IWGRP |
  36285. S_IROTH|S_IWOTH);
  36286. /* try to match the database file R/W permissions, ignore failure */
  36287. #ifndef SQLITE_PROXY_DEBUG
  36288. osFchmod(conchFile->h, cmode);
  36289. #else
  36290. do{
  36291. rc = osFchmod(conchFile->h, cmode);
  36292. }while( rc==(-1) && errno==EINTR );
  36293. if( rc!=0 ){
  36294. int code = errno;
  36295. fprintf(stderr, "fchmod %o FAILED with %d %s\n",
  36296. cmode, code, strerror(code));
  36297. } else {
  36298. fprintf(stderr, "fchmod %o SUCCEDED\n",cmode);
  36299. }
  36300. }else{
  36301. int code = errno;
  36302. fprintf(stderr, "STAT FAILED[%d] with %d %s\n",
  36303. err, code, strerror(code));
  36304. #endif
  36305. }
  36306. }
  36307. }
  36308. conchFile->pMethod->xUnlock((sqlite3_file*)conchFile, SHARED_LOCK);
  36309. end_takeconch:
  36310. OSTRACE(("TRANSPROXY: CLOSE %d\n", pFile->h));
  36311. if( rc==SQLITE_OK && pFile->openFlags ){
  36312. int fd;
  36313. if( pFile->h>=0 ){
  36314. robust_close(pFile, pFile->h, __LINE__);
  36315. }
  36316. pFile->h = -1;
  36317. fd = robust_open(pCtx->dbPath, pFile->openFlags, 0);
  36318. OSTRACE(("TRANSPROXY: OPEN %d\n", fd));
  36319. if( fd>=0 ){
  36320. pFile->h = fd;
  36321. }else{
  36322. rc=SQLITE_CANTOPEN_BKPT; /* SQLITE_BUSY? proxyTakeConch called
  36323. during locking */
  36324. }
  36325. }
  36326. if( rc==SQLITE_OK && !pCtx->lockProxy ){
  36327. char *path = tempLockPath ? tempLockPath : pCtx->lockProxyPath;
  36328. rc = proxyCreateUnixFile(path, &pCtx->lockProxy, 1);
  36329. if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM && tryOldLockPath ){
  36330. /* we couldn't create the proxy lock file with the old lock file path
  36331. ** so try again via auto-naming
  36332. */
  36333. forceNewLockPath = 1;
  36334. tryOldLockPath = 0;
  36335. continue; /* go back to the do {} while start point, try again */
  36336. }
  36337. }
  36338. if( rc==SQLITE_OK ){
  36339. /* Need to make a copy of path if we extracted the value
  36340. ** from the conch file or the path was allocated on the stack
  36341. */
  36342. if( tempLockPath ){
  36343. pCtx->lockProxyPath = sqlite3DbStrDup(0, tempLockPath);
  36344. if( !pCtx->lockProxyPath ){
  36345. rc = SQLITE_NOMEM_BKPT;
  36346. }
  36347. }
  36348. }
  36349. if( rc==SQLITE_OK ){
  36350. pCtx->conchHeld = 1;
  36351. if( pCtx->lockProxy->pMethod == &afpIoMethods ){
  36352. afpLockingContext *afpCtx;
  36353. afpCtx = (afpLockingContext *)pCtx->lockProxy->lockingContext;
  36354. afpCtx->dbPath = pCtx->lockProxyPath;
  36355. }
  36356. } else {
  36357. conchFile->pMethod->xUnlock((sqlite3_file*)conchFile, NO_LOCK);
  36358. }
  36359. OSTRACE(("TAKECONCH %d %s\n", conchFile->h,
  36360. rc==SQLITE_OK?"ok":"failed"));
  36361. return rc;
  36362. } while (1); /* in case we need to retry the :auto: lock file -
  36363. ** we should never get here except via the 'continue' call. */
  36364. }
  36365. }
  36366. /*
  36367. ** If pFile holds a lock on a conch file, then release that lock.
  36368. */
  36369. static int proxyReleaseConch(unixFile *pFile){
  36370. int rc = SQLITE_OK; /* Subroutine return code */
  36371. proxyLockingContext *pCtx; /* The locking context for the proxy lock */
  36372. unixFile *conchFile; /* Name of the conch file */
  36373. pCtx = (proxyLockingContext *)pFile->lockingContext;
  36374. conchFile = pCtx->conchFile;
  36375. OSTRACE(("RELEASECONCH %d for %s pid=%d\n", conchFile->h,
  36376. (pCtx->lockProxyPath ? pCtx->lockProxyPath : ":auto:"),
  36377. osGetpid(0)));
  36378. if( pCtx->conchHeld>0 ){
  36379. rc = conchFile->pMethod->xUnlock((sqlite3_file*)conchFile, NO_LOCK);
  36380. }
  36381. pCtx->conchHeld = 0;
  36382. OSTRACE(("RELEASECONCH %d %s\n", conchFile->h,
  36383. (rc==SQLITE_OK ? "ok" : "failed")));
  36384. return rc;
  36385. }
  36386. /*
  36387. ** Given the name of a database file, compute the name of its conch file.
  36388. ** Store the conch filename in memory obtained from sqlite3_malloc64().
  36389. ** Make *pConchPath point to the new name. Return SQLITE_OK on success
  36390. ** or SQLITE_NOMEM if unable to obtain memory.
  36391. **
  36392. ** The caller is responsible for ensuring that the allocated memory
  36393. ** space is eventually freed.
  36394. **
  36395. ** *pConchPath is set to NULL if a memory allocation error occurs.
  36396. */
  36397. static int proxyCreateConchPathname(char *dbPath, char **pConchPath){
  36398. int i; /* Loop counter */
  36399. int len = (int)strlen(dbPath); /* Length of database filename - dbPath */
  36400. char *conchPath; /* buffer in which to construct conch name */
  36401. /* Allocate space for the conch filename and initialize the name to
  36402. ** the name of the original database file. */
  36403. *pConchPath = conchPath = (char *)sqlite3_malloc64(len + 8);
  36404. if( conchPath==0 ){
  36405. return SQLITE_NOMEM_BKPT;
  36406. }
  36407. memcpy(conchPath, dbPath, len+1);
  36408. /* now insert a "." before the last / character */
  36409. for( i=(len-1); i>=0; i-- ){
  36410. if( conchPath[i]=='/' ){
  36411. i++;
  36412. break;
  36413. }
  36414. }
  36415. conchPath[i]='.';
  36416. while ( i<len ){
  36417. conchPath[i+1]=dbPath[i];
  36418. i++;
  36419. }
  36420. /* append the "-conch" suffix to the file */
  36421. memcpy(&conchPath[i+1], "-conch", 7);
  36422. assert( (int)strlen(conchPath) == len+7 );
  36423. return SQLITE_OK;
  36424. }
  36425. /* Takes a fully configured proxy locking-style unix file and switches
  36426. ** the local lock file path
  36427. */
  36428. static int switchLockProxyPath(unixFile *pFile, const char *path) {
  36429. proxyLockingContext *pCtx = (proxyLockingContext*)pFile->lockingContext;
  36430. char *oldPath = pCtx->lockProxyPath;
  36431. int rc = SQLITE_OK;
  36432. if( pFile->eFileLock!=NO_LOCK ){
  36433. return SQLITE_BUSY;
  36434. }
  36435. /* nothing to do if the path is NULL, :auto: or matches the existing path */
  36436. if( !path || path[0]=='\0' || !strcmp(path, ":auto:") ||
  36437. (oldPath && !strncmp(oldPath, path, MAXPATHLEN)) ){
  36438. return SQLITE_OK;
  36439. }else{
  36440. unixFile *lockProxy = pCtx->lockProxy;
  36441. pCtx->lockProxy=NULL;
  36442. pCtx->conchHeld = 0;
  36443. if( lockProxy!=NULL ){
  36444. rc=lockProxy->pMethod->xClose((sqlite3_file *)lockProxy);
  36445. if( rc ) return rc;
  36446. sqlite3_free(lockProxy);
  36447. }
  36448. sqlite3_free(oldPath);
  36449. pCtx->lockProxyPath = sqlite3DbStrDup(0, path);
  36450. }
  36451. return rc;
  36452. }
  36453. /*
  36454. ** pFile is a file that has been opened by a prior xOpen call. dbPath
  36455. ** is a string buffer at least MAXPATHLEN+1 characters in size.
  36456. **
  36457. ** This routine find the filename associated with pFile and writes it
  36458. ** int dbPath.
  36459. */
  36460. static int proxyGetDbPathForUnixFile(unixFile *pFile, char *dbPath){
  36461. #if defined(__APPLE__)
  36462. if( pFile->pMethod == &afpIoMethods ){
  36463. /* afp style keeps a reference to the db path in the filePath field
  36464. ** of the struct */
  36465. assert( (int)strlen((char*)pFile->lockingContext)<=MAXPATHLEN );
  36466. strlcpy(dbPath, ((afpLockingContext *)pFile->lockingContext)->dbPath,
  36467. MAXPATHLEN);
  36468. } else
  36469. #endif
  36470. if( pFile->pMethod == &dotlockIoMethods ){
  36471. /* dot lock style uses the locking context to store the dot lock
  36472. ** file path */
  36473. int len = strlen((char *)pFile->lockingContext) - strlen(DOTLOCK_SUFFIX);
  36474. memcpy(dbPath, (char *)pFile->lockingContext, len + 1);
  36475. }else{
  36476. /* all other styles use the locking context to store the db file path */
  36477. assert( strlen((char*)pFile->lockingContext)<=MAXPATHLEN );
  36478. strlcpy(dbPath, (char *)pFile->lockingContext, MAXPATHLEN);
  36479. }
  36480. return SQLITE_OK;
  36481. }
  36482. /*
  36483. ** Takes an already filled in unix file and alters it so all file locking
  36484. ** will be performed on the local proxy lock file. The following fields
  36485. ** are preserved in the locking context so that they can be restored and
  36486. ** the unix structure properly cleaned up at close time:
  36487. ** ->lockingContext
  36488. ** ->pMethod
  36489. */
  36490. static int proxyTransformUnixFile(unixFile *pFile, const char *path) {
  36491. proxyLockingContext *pCtx;
  36492. char dbPath[MAXPATHLEN+1]; /* Name of the database file */
  36493. char *lockPath=NULL;
  36494. int rc = SQLITE_OK;
  36495. if( pFile->eFileLock!=NO_LOCK ){
  36496. return SQLITE_BUSY;
  36497. }
  36498. proxyGetDbPathForUnixFile(pFile, dbPath);
  36499. if( !path || path[0]=='\0' || !strcmp(path, ":auto:") ){
  36500. lockPath=NULL;
  36501. }else{
  36502. lockPath=(char *)path;
  36503. }
  36504. OSTRACE(("TRANSPROXY %d for %s pid=%d\n", pFile->h,
  36505. (lockPath ? lockPath : ":auto:"), osGetpid(0)));
  36506. pCtx = sqlite3_malloc64( sizeof(*pCtx) );
  36507. if( pCtx==0 ){
  36508. return SQLITE_NOMEM_BKPT;
  36509. }
  36510. memset(pCtx, 0, sizeof(*pCtx));
  36511. rc = proxyCreateConchPathname(dbPath, &pCtx->conchFilePath);
  36512. if( rc==SQLITE_OK ){
  36513. rc = proxyCreateUnixFile(pCtx->conchFilePath, &pCtx->conchFile, 0);
  36514. if( rc==SQLITE_CANTOPEN && ((pFile->openFlags&O_RDWR) == 0) ){
  36515. /* if (a) the open flags are not O_RDWR, (b) the conch isn't there, and
  36516. ** (c) the file system is read-only, then enable no-locking access.
  36517. ** Ugh, since O_RDONLY==0x0000 we test for !O_RDWR since unixOpen asserts
  36518. ** that openFlags will have only one of O_RDONLY or O_RDWR.
  36519. */
  36520. struct statfs fsInfo;
  36521. struct stat conchInfo;
  36522. int goLockless = 0;
  36523. if( osStat(pCtx->conchFilePath, &conchInfo) == -1 ) {
  36524. int err = errno;
  36525. if( (err==ENOENT) && (statfs(dbPath, &fsInfo) != -1) ){
  36526. goLockless = (fsInfo.f_flags&MNT_RDONLY) == MNT_RDONLY;
  36527. }
  36528. }
  36529. if( goLockless ){
  36530. pCtx->conchHeld = -1; /* read only FS/ lockless */
  36531. rc = SQLITE_OK;
  36532. }
  36533. }
  36534. }
  36535. if( rc==SQLITE_OK && lockPath ){
  36536. pCtx->lockProxyPath = sqlite3DbStrDup(0, lockPath);
  36537. }
  36538. if( rc==SQLITE_OK ){
  36539. pCtx->dbPath = sqlite3DbStrDup(0, dbPath);
  36540. if( pCtx->dbPath==NULL ){
  36541. rc = SQLITE_NOMEM_BKPT;
  36542. }
  36543. }
  36544. if( rc==SQLITE_OK ){
  36545. /* all memory is allocated, proxys are created and assigned,
  36546. ** switch the locking context and pMethod then return.
  36547. */
  36548. pCtx->oldLockingContext = pFile->lockingContext;
  36549. pFile->lockingContext = pCtx;
  36550. pCtx->pOldMethod = pFile->pMethod;
  36551. pFile->pMethod = &proxyIoMethods;
  36552. }else{
  36553. if( pCtx->conchFile ){
  36554. pCtx->conchFile->pMethod->xClose((sqlite3_file *)pCtx->conchFile);
  36555. sqlite3_free(pCtx->conchFile);
  36556. }
  36557. sqlite3DbFree(0, pCtx->lockProxyPath);
  36558. sqlite3_free(pCtx->conchFilePath);
  36559. sqlite3_free(pCtx);
  36560. }
  36561. OSTRACE(("TRANSPROXY %d %s\n", pFile->h,
  36562. (rc==SQLITE_OK ? "ok" : "failed")));
  36563. return rc;
  36564. }
  36565. /*
  36566. ** This routine handles sqlite3_file_control() calls that are specific
  36567. ** to proxy locking.
  36568. */
  36569. static int proxyFileControl(sqlite3_file *id, int op, void *pArg){
  36570. switch( op ){
  36571. case SQLITE_FCNTL_GET_LOCKPROXYFILE: {
  36572. unixFile *pFile = (unixFile*)id;
  36573. if( pFile->pMethod == &proxyIoMethods ){
  36574. proxyLockingContext *pCtx = (proxyLockingContext*)pFile->lockingContext;
  36575. proxyTakeConch(pFile);
  36576. if( pCtx->lockProxyPath ){
  36577. *(const char **)pArg = pCtx->lockProxyPath;
  36578. }else{
  36579. *(const char **)pArg = ":auto: (not held)";
  36580. }
  36581. } else {
  36582. *(const char **)pArg = NULL;
  36583. }
  36584. return SQLITE_OK;
  36585. }
  36586. case SQLITE_FCNTL_SET_LOCKPROXYFILE: {
  36587. unixFile *pFile = (unixFile*)id;
  36588. int rc = SQLITE_OK;
  36589. int isProxyStyle = (pFile->pMethod == &proxyIoMethods);
  36590. if( pArg==NULL || (const char *)pArg==0 ){
  36591. if( isProxyStyle ){
  36592. /* turn off proxy locking - not supported. If support is added for
  36593. ** switching proxy locking mode off then it will need to fail if
  36594. ** the journal mode is WAL mode.
  36595. */
  36596. rc = SQLITE_ERROR /*SQLITE_PROTOCOL? SQLITE_MISUSE?*/;
  36597. }else{
  36598. /* turn off proxy locking - already off - NOOP */
  36599. rc = SQLITE_OK;
  36600. }
  36601. }else{
  36602. const char *proxyPath = (const char *)pArg;
  36603. if( isProxyStyle ){
  36604. proxyLockingContext *pCtx =
  36605. (proxyLockingContext*)pFile->lockingContext;
  36606. if( !strcmp(pArg, ":auto:")
  36607. || (pCtx->lockProxyPath &&
  36608. !strncmp(pCtx->lockProxyPath, proxyPath, MAXPATHLEN))
  36609. ){
  36610. rc = SQLITE_OK;
  36611. }else{
  36612. rc = switchLockProxyPath(pFile, proxyPath);
  36613. }
  36614. }else{
  36615. /* turn on proxy file locking */
  36616. rc = proxyTransformUnixFile(pFile, proxyPath);
  36617. }
  36618. }
  36619. return rc;
  36620. }
  36621. default: {
  36622. assert( 0 ); /* The call assures that only valid opcodes are sent */
  36623. }
  36624. }
  36625. /*NOTREACHED*/
  36626. return SQLITE_ERROR;
  36627. }
  36628. /*
  36629. ** Within this division (the proxying locking implementation) the procedures
  36630. ** above this point are all utilities. The lock-related methods of the
  36631. ** proxy-locking sqlite3_io_method object follow.
  36632. */
  36633. /*
  36634. ** This routine checks if there is a RESERVED lock held on the specified
  36635. ** file by this or any other process. If such a lock is held, set *pResOut
  36636. ** to a non-zero value otherwise *pResOut is set to zero. The return value
  36637. ** is set to SQLITE_OK unless an I/O error occurs during lock checking.
  36638. */
  36639. static int proxyCheckReservedLock(sqlite3_file *id, int *pResOut) {
  36640. unixFile *pFile = (unixFile*)id;
  36641. int rc = proxyTakeConch(pFile);
  36642. if( rc==SQLITE_OK ){
  36643. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36644. if( pCtx->conchHeld>0 ){
  36645. unixFile *proxy = pCtx->lockProxy;
  36646. return proxy->pMethod->xCheckReservedLock((sqlite3_file*)proxy, pResOut);
  36647. }else{ /* conchHeld < 0 is lockless */
  36648. pResOut=0;
  36649. }
  36650. }
  36651. return rc;
  36652. }
  36653. /*
  36654. ** Lock the file with the lock specified by parameter eFileLock - one
  36655. ** of the following:
  36656. **
  36657. ** (1) SHARED_LOCK
  36658. ** (2) RESERVED_LOCK
  36659. ** (3) PENDING_LOCK
  36660. ** (4) EXCLUSIVE_LOCK
  36661. **
  36662. ** Sometimes when requesting one lock state, additional lock states
  36663. ** are inserted in between. The locking might fail on one of the later
  36664. ** transitions leaving the lock state different from what it started but
  36665. ** still short of its goal. The following chart shows the allowed
  36666. ** transitions and the inserted intermediate states:
  36667. **
  36668. ** UNLOCKED -> SHARED
  36669. ** SHARED -> RESERVED
  36670. ** SHARED -> (PENDING) -> EXCLUSIVE
  36671. ** RESERVED -> (PENDING) -> EXCLUSIVE
  36672. ** PENDING -> EXCLUSIVE
  36673. **
  36674. ** This routine will only increase a lock. Use the sqlite3OsUnlock()
  36675. ** routine to lower a locking level.
  36676. */
  36677. static int proxyLock(sqlite3_file *id, int eFileLock) {
  36678. unixFile *pFile = (unixFile*)id;
  36679. int rc = proxyTakeConch(pFile);
  36680. if( rc==SQLITE_OK ){
  36681. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36682. if( pCtx->conchHeld>0 ){
  36683. unixFile *proxy = pCtx->lockProxy;
  36684. rc = proxy->pMethod->xLock((sqlite3_file*)proxy, eFileLock);
  36685. pFile->eFileLock = proxy->eFileLock;
  36686. }else{
  36687. /* conchHeld < 0 is lockless */
  36688. }
  36689. }
  36690. return rc;
  36691. }
  36692. /*
  36693. ** Lower the locking level on file descriptor pFile to eFileLock. eFileLock
  36694. ** must be either NO_LOCK or SHARED_LOCK.
  36695. **
  36696. ** If the locking level of the file descriptor is already at or below
  36697. ** the requested locking level, this routine is a no-op.
  36698. */
  36699. static int proxyUnlock(sqlite3_file *id, int eFileLock) {
  36700. unixFile *pFile = (unixFile*)id;
  36701. int rc = proxyTakeConch(pFile);
  36702. if( rc==SQLITE_OK ){
  36703. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36704. if( pCtx->conchHeld>0 ){
  36705. unixFile *proxy = pCtx->lockProxy;
  36706. rc = proxy->pMethod->xUnlock((sqlite3_file*)proxy, eFileLock);
  36707. pFile->eFileLock = proxy->eFileLock;
  36708. }else{
  36709. /* conchHeld < 0 is lockless */
  36710. }
  36711. }
  36712. return rc;
  36713. }
  36714. /*
  36715. ** Close a file that uses proxy locks.
  36716. */
  36717. static int proxyClose(sqlite3_file *id) {
  36718. if( ALWAYS(id) ){
  36719. unixFile *pFile = (unixFile*)id;
  36720. proxyLockingContext *pCtx = (proxyLockingContext *)pFile->lockingContext;
  36721. unixFile *lockProxy = pCtx->lockProxy;
  36722. unixFile *conchFile = pCtx->conchFile;
  36723. int rc = SQLITE_OK;
  36724. if( lockProxy ){
  36725. rc = lockProxy->pMethod->xUnlock((sqlite3_file*)lockProxy, NO_LOCK);
  36726. if( rc ) return rc;
  36727. rc = lockProxy->pMethod->xClose((sqlite3_file*)lockProxy);
  36728. if( rc ) return rc;
  36729. sqlite3_free(lockProxy);
  36730. pCtx->lockProxy = 0;
  36731. }
  36732. if( conchFile ){
  36733. if( pCtx->conchHeld ){
  36734. rc = proxyReleaseConch(pFile);
  36735. if( rc ) return rc;
  36736. }
  36737. rc = conchFile->pMethod->xClose((sqlite3_file*)conchFile);
  36738. if( rc ) return rc;
  36739. sqlite3_free(conchFile);
  36740. }
  36741. sqlite3DbFree(0, pCtx->lockProxyPath);
  36742. sqlite3_free(pCtx->conchFilePath);
  36743. sqlite3DbFree(0, pCtx->dbPath);
  36744. /* restore the original locking context and pMethod then close it */
  36745. pFile->lockingContext = pCtx->oldLockingContext;
  36746. pFile->pMethod = pCtx->pOldMethod;
  36747. sqlite3_free(pCtx);
  36748. return pFile->pMethod->xClose(id);
  36749. }
  36750. return SQLITE_OK;
  36751. }
  36752. #endif /* defined(__APPLE__) && SQLITE_ENABLE_LOCKING_STYLE */
  36753. /*
  36754. ** The proxy locking style is intended for use with AFP filesystems.
  36755. ** And since AFP is only supported on MacOSX, the proxy locking is also
  36756. ** restricted to MacOSX.
  36757. **
  36758. **
  36759. ******************* End of the proxy lock implementation **********************
  36760. ******************************************************************************/
  36761. /*
  36762. ** Initialize the operating system interface.
  36763. **
  36764. ** This routine registers all VFS implementations for unix-like operating
  36765. ** systems. This routine, and the sqlite3_os_end() routine that follows,
  36766. ** should be the only routines in this file that are visible from other
  36767. ** files.
  36768. **
  36769. ** This routine is called once during SQLite initialization and by a
  36770. ** single thread. The memory allocation and mutex subsystems have not
  36771. ** necessarily been initialized when this routine is called, and so they
  36772. ** should not be used.
  36773. */
  36774. SQLITE_API int sqlite3_os_init(void){
  36775. /*
  36776. ** The following macro defines an initializer for an sqlite3_vfs object.
  36777. ** The name of the VFS is NAME. The pAppData is a pointer to a pointer
  36778. ** to the "finder" function. (pAppData is a pointer to a pointer because
  36779. ** silly C90 rules prohibit a void* from being cast to a function pointer
  36780. ** and so we have to go through the intermediate pointer to avoid problems
  36781. ** when compiling with -pedantic-errors on GCC.)
  36782. **
  36783. ** The FINDER parameter to this macro is the name of the pointer to the
  36784. ** finder-function. The finder-function returns a pointer to the
  36785. ** sqlite_io_methods object that implements the desired locking
  36786. ** behaviors. See the division above that contains the IOMETHODS
  36787. ** macro for addition information on finder-functions.
  36788. **
  36789. ** Most finders simply return a pointer to a fixed sqlite3_io_methods
  36790. ** object. But the "autolockIoFinder" available on MacOSX does a little
  36791. ** more than that; it looks at the filesystem type that hosts the
  36792. ** database file and tries to choose an locking method appropriate for
  36793. ** that filesystem time.
  36794. */
  36795. #define UNIXVFS(VFSNAME, FINDER) { \
  36796. 3, /* iVersion */ \
  36797. sizeof(unixFile), /* szOsFile */ \
  36798. MAX_PATHNAME, /* mxPathname */ \
  36799. 0, /* pNext */ \
  36800. VFSNAME, /* zName */ \
  36801. (void*)&FINDER, /* pAppData */ \
  36802. unixOpen, /* xOpen */ \
  36803. unixDelete, /* xDelete */ \
  36804. unixAccess, /* xAccess */ \
  36805. unixFullPathname, /* xFullPathname */ \
  36806. unixDlOpen, /* xDlOpen */ \
  36807. unixDlError, /* xDlError */ \
  36808. unixDlSym, /* xDlSym */ \
  36809. unixDlClose, /* xDlClose */ \
  36810. unixRandomness, /* xRandomness */ \
  36811. unixSleep, /* xSleep */ \
  36812. unixCurrentTime, /* xCurrentTime */ \
  36813. unixGetLastError, /* xGetLastError */ \
  36814. unixCurrentTimeInt64, /* xCurrentTimeInt64 */ \
  36815. unixSetSystemCall, /* xSetSystemCall */ \
  36816. unixGetSystemCall, /* xGetSystemCall */ \
  36817. unixNextSystemCall, /* xNextSystemCall */ \
  36818. }
  36819. /*
  36820. ** All default VFSes for unix are contained in the following array.
  36821. **
  36822. ** Note that the sqlite3_vfs.pNext field of the VFS object is modified
  36823. ** by the SQLite core when the VFS is registered. So the following
  36824. ** array cannot be const.
  36825. */
  36826. static sqlite3_vfs aVfs[] = {
  36827. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  36828. UNIXVFS("unix", autolockIoFinder ),
  36829. #elif OS_VXWORKS
  36830. UNIXVFS("unix", vxworksIoFinder ),
  36831. #else
  36832. UNIXVFS("unix", posixIoFinder ),
  36833. #endif
  36834. UNIXVFS("unix-none", nolockIoFinder ),
  36835. UNIXVFS("unix-dotfile", dotlockIoFinder ),
  36836. UNIXVFS("unix-excl", posixIoFinder ),
  36837. #if OS_VXWORKS
  36838. UNIXVFS("unix-namedsem", semIoFinder ),
  36839. #endif
  36840. #if SQLITE_ENABLE_LOCKING_STYLE || OS_VXWORKS
  36841. UNIXVFS("unix-posix", posixIoFinder ),
  36842. #endif
  36843. #if SQLITE_ENABLE_LOCKING_STYLE
  36844. UNIXVFS("unix-flock", flockIoFinder ),
  36845. #endif
  36846. #if SQLITE_ENABLE_LOCKING_STYLE && defined(__APPLE__)
  36847. UNIXVFS("unix-afp", afpIoFinder ),
  36848. UNIXVFS("unix-nfs", nfsIoFinder ),
  36849. UNIXVFS("unix-proxy", proxyIoFinder ),
  36850. #endif
  36851. };
  36852. unsigned int i; /* Loop counter */
  36853. /* Double-check that the aSyscall[] array has been constructed
  36854. ** correctly. See ticket [bb3a86e890c8e96ab] */
  36855. assert( ArraySize(aSyscall)==29 );
  36856. /* Register all VFSes defined in the aVfs[] array */
  36857. for(i=0; i<(sizeof(aVfs)/sizeof(sqlite3_vfs)); i++){
  36858. sqlite3_vfs_register(&aVfs[i], i==0);
  36859. }
  36860. unixBigLock = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1);
  36861. return SQLITE_OK;
  36862. }
  36863. /*
  36864. ** Shutdown the operating system interface.
  36865. **
  36866. ** Some operating systems might need to do some cleanup in this routine,
  36867. ** to release dynamically allocated objects. But not on unix.
  36868. ** This routine is a no-op for unix.
  36869. */
  36870. SQLITE_API int sqlite3_os_end(void){
  36871. unixBigLock = 0;
  36872. return SQLITE_OK;
  36873. }
  36874. #endif /* SQLITE_OS_UNIX */
  36875. /************** End of os_unix.c *********************************************/
  36876. /************** Begin file os_win.c ******************************************/
  36877. /*
  36878. ** 2004 May 22
  36879. **
  36880. ** The author disclaims copyright to this source code. In place of
  36881. ** a legal notice, here is a blessing:
  36882. **
  36883. ** May you do good and not evil.
  36884. ** May you find forgiveness for yourself and forgive others.
  36885. ** May you share freely, never taking more than you give.
  36886. **
  36887. ******************************************************************************
  36888. **
  36889. ** This file contains code that is specific to Windows.
  36890. */
  36891. /* #include "sqliteInt.h" */
  36892. #if SQLITE_OS_WIN /* This file is used for Windows only */
  36893. /*
  36894. ** Include code that is common to all os_*.c files
  36895. */
  36896. /************** Include os_common.h in the middle of os_win.c ****************/
  36897. /************** Begin file os_common.h ***************************************/
  36898. /*
  36899. ** 2004 May 22
  36900. **
  36901. ** The author disclaims copyright to this source code. In place of
  36902. ** a legal notice, here is a blessing:
  36903. **
  36904. ** May you do good and not evil.
  36905. ** May you find forgiveness for yourself and forgive others.
  36906. ** May you share freely, never taking more than you give.
  36907. **
  36908. ******************************************************************************
  36909. **
  36910. ** This file contains macros and a little bit of code that is common to
  36911. ** all of the platform-specific files (os_*.c) and is #included into those
  36912. ** files.
  36913. **
  36914. ** This file should be #included by the os_*.c files only. It is not a
  36915. ** general purpose header file.
  36916. */
  36917. #ifndef _OS_COMMON_H_
  36918. #define _OS_COMMON_H_
  36919. /*
  36920. ** At least two bugs have slipped in because we changed the MEMORY_DEBUG
  36921. ** macro to SQLITE_DEBUG and some older makefiles have not yet made the
  36922. ** switch. The following code should catch this problem at compile-time.
  36923. */
  36924. #ifdef MEMORY_DEBUG
  36925. # error "The MEMORY_DEBUG macro is obsolete. Use SQLITE_DEBUG instead."
  36926. #endif
  36927. /*
  36928. ** Macros for performance tracing. Normally turned off. Only works
  36929. ** on i486 hardware.
  36930. */
  36931. #ifdef SQLITE_PERFORMANCE_TRACE
  36932. /*
  36933. ** hwtime.h contains inline assembler code for implementing
  36934. ** high-performance timing routines.
  36935. */
  36936. /************** Include hwtime.h in the middle of os_common.h ****************/
  36937. /************** Begin file hwtime.h ******************************************/
  36938. /*
  36939. ** 2008 May 27
  36940. **
  36941. ** The author disclaims copyright to this source code. In place of
  36942. ** a legal notice, here is a blessing:
  36943. **
  36944. ** May you do good and not evil.
  36945. ** May you find forgiveness for yourself and forgive others.
  36946. ** May you share freely, never taking more than you give.
  36947. **
  36948. ******************************************************************************
  36949. **
  36950. ** This file contains inline asm code for retrieving "high-performance"
  36951. ** counters for x86 class CPUs.
  36952. */
  36953. #ifndef SQLITE_HWTIME_H
  36954. #define SQLITE_HWTIME_H
  36955. /*
  36956. ** The following routine only works on pentium-class (or newer) processors.
  36957. ** It uses the RDTSC opcode to read the cycle count value out of the
  36958. ** processor and returns that value. This can be used for high-res
  36959. ** profiling.
  36960. */
  36961. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  36962. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  36963. #if defined(__GNUC__)
  36964. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  36965. unsigned int lo, hi;
  36966. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  36967. return (sqlite_uint64)hi << 32 | lo;
  36968. }
  36969. #elif defined(_MSC_VER)
  36970. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  36971. __asm {
  36972. rdtsc
  36973. ret ; return value at EDX:EAX
  36974. }
  36975. }
  36976. #endif
  36977. #elif (defined(__GNUC__) && defined(__x86_64__))
  36978. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  36979. unsigned long val;
  36980. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  36981. return val;
  36982. }
  36983. #elif (defined(__GNUC__) && defined(__ppc__))
  36984. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  36985. unsigned long long retval;
  36986. unsigned long junk;
  36987. __asm__ __volatile__ ("\n\
  36988. 1: mftbu %1\n\
  36989. mftb %L0\n\
  36990. mftbu %0\n\
  36991. cmpw %0,%1\n\
  36992. bne 1b"
  36993. : "=r" (retval), "=r" (junk));
  36994. return retval;
  36995. }
  36996. #else
  36997. #error Need implementation of sqlite3Hwtime() for your platform.
  36998. /*
  36999. ** To compile without implementing sqlite3Hwtime() for your platform,
  37000. ** you can remove the above #error and use the following
  37001. ** stub function. You will lose timing support for many
  37002. ** of the debugging and testing utilities, but it should at
  37003. ** least compile and run.
  37004. */
  37005. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  37006. #endif
  37007. #endif /* !defined(SQLITE_HWTIME_H) */
  37008. /************** End of hwtime.h **********************************************/
  37009. /************** Continuing where we left off in os_common.h ******************/
  37010. static sqlite_uint64 g_start;
  37011. static sqlite_uint64 g_elapsed;
  37012. #define TIMER_START g_start=sqlite3Hwtime()
  37013. #define TIMER_END g_elapsed=sqlite3Hwtime()-g_start
  37014. #define TIMER_ELAPSED g_elapsed
  37015. #else
  37016. #define TIMER_START
  37017. #define TIMER_END
  37018. #define TIMER_ELAPSED ((sqlite_uint64)0)
  37019. #endif
  37020. /*
  37021. ** If we compile with the SQLITE_TEST macro set, then the following block
  37022. ** of code will give us the ability to simulate a disk I/O error. This
  37023. ** is used for testing the I/O recovery logic.
  37024. */
  37025. #if defined(SQLITE_TEST)
  37026. SQLITE_API extern int sqlite3_io_error_hit;
  37027. SQLITE_API extern int sqlite3_io_error_hardhit;
  37028. SQLITE_API extern int sqlite3_io_error_pending;
  37029. SQLITE_API extern int sqlite3_io_error_persist;
  37030. SQLITE_API extern int sqlite3_io_error_benign;
  37031. SQLITE_API extern int sqlite3_diskfull_pending;
  37032. SQLITE_API extern int sqlite3_diskfull;
  37033. #define SimulateIOErrorBenign(X) sqlite3_io_error_benign=(X)
  37034. #define SimulateIOError(CODE) \
  37035. if( (sqlite3_io_error_persist && sqlite3_io_error_hit) \
  37036. || sqlite3_io_error_pending-- == 1 ) \
  37037. { local_ioerr(); CODE; }
  37038. static void local_ioerr(){
  37039. IOTRACE(("IOERR\n"));
  37040. sqlite3_io_error_hit++;
  37041. if( !sqlite3_io_error_benign ) sqlite3_io_error_hardhit++;
  37042. }
  37043. #define SimulateDiskfullError(CODE) \
  37044. if( sqlite3_diskfull_pending ){ \
  37045. if( sqlite3_diskfull_pending == 1 ){ \
  37046. local_ioerr(); \
  37047. sqlite3_diskfull = 1; \
  37048. sqlite3_io_error_hit = 1; \
  37049. CODE; \
  37050. }else{ \
  37051. sqlite3_diskfull_pending--; \
  37052. } \
  37053. }
  37054. #else
  37055. #define SimulateIOErrorBenign(X)
  37056. #define SimulateIOError(A)
  37057. #define SimulateDiskfullError(A)
  37058. #endif /* defined(SQLITE_TEST) */
  37059. /*
  37060. ** When testing, keep a count of the number of open files.
  37061. */
  37062. #if defined(SQLITE_TEST)
  37063. SQLITE_API extern int sqlite3_open_file_count;
  37064. #define OpenCounter(X) sqlite3_open_file_count+=(X)
  37065. #else
  37066. #define OpenCounter(X)
  37067. #endif /* defined(SQLITE_TEST) */
  37068. #endif /* !defined(_OS_COMMON_H_) */
  37069. /************** End of os_common.h *******************************************/
  37070. /************** Continuing where we left off in os_win.c *********************/
  37071. /*
  37072. ** Include the header file for the Windows VFS.
  37073. */
  37074. /* #include "os_win.h" */
  37075. /*
  37076. ** Compiling and using WAL mode requires several APIs that are only
  37077. ** available in Windows platforms based on the NT kernel.
  37078. */
  37079. #if !SQLITE_OS_WINNT && !defined(SQLITE_OMIT_WAL)
  37080. # error "WAL mode requires support from the Windows NT kernel, compile\
  37081. with SQLITE_OMIT_WAL."
  37082. #endif
  37083. #if !SQLITE_OS_WINNT && SQLITE_MAX_MMAP_SIZE>0
  37084. # error "Memory mapped files require support from the Windows NT kernel,\
  37085. compile with SQLITE_MAX_MMAP_SIZE=0."
  37086. #endif
  37087. /*
  37088. ** Are most of the Win32 ANSI APIs available (i.e. with certain exceptions
  37089. ** based on the sub-platform)?
  37090. */
  37091. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && !defined(SQLITE_WIN32_NO_ANSI)
  37092. # define SQLITE_WIN32_HAS_ANSI
  37093. #endif
  37094. /*
  37095. ** Are most of the Win32 Unicode APIs available (i.e. with certain exceptions
  37096. ** based on the sub-platform)?
  37097. */
  37098. #if (SQLITE_OS_WINCE || SQLITE_OS_WINNT || SQLITE_OS_WINRT) && \
  37099. !defined(SQLITE_WIN32_NO_WIDE)
  37100. # define SQLITE_WIN32_HAS_WIDE
  37101. #endif
  37102. /*
  37103. ** Make sure at least one set of Win32 APIs is available.
  37104. */
  37105. #if !defined(SQLITE_WIN32_HAS_ANSI) && !defined(SQLITE_WIN32_HAS_WIDE)
  37106. # error "At least one of SQLITE_WIN32_HAS_ANSI and SQLITE_WIN32_HAS_WIDE\
  37107. must be defined."
  37108. #endif
  37109. /*
  37110. ** Define the required Windows SDK version constants if they are not
  37111. ** already available.
  37112. */
  37113. #ifndef NTDDI_WIN8
  37114. # define NTDDI_WIN8 0x06020000
  37115. #endif
  37116. #ifndef NTDDI_WINBLUE
  37117. # define NTDDI_WINBLUE 0x06030000
  37118. #endif
  37119. #ifndef NTDDI_WINTHRESHOLD
  37120. # define NTDDI_WINTHRESHOLD 0x06040000
  37121. #endif
  37122. /*
  37123. ** Check to see if the GetVersionEx[AW] functions are deprecated on the
  37124. ** target system. GetVersionEx was first deprecated in Win8.1.
  37125. */
  37126. #ifndef SQLITE_WIN32_GETVERSIONEX
  37127. # if defined(NTDDI_VERSION) && NTDDI_VERSION >= NTDDI_WINBLUE
  37128. # define SQLITE_WIN32_GETVERSIONEX 0 /* GetVersionEx() is deprecated */
  37129. # else
  37130. # define SQLITE_WIN32_GETVERSIONEX 1 /* GetVersionEx() is current */
  37131. # endif
  37132. #endif
  37133. /*
  37134. ** Check to see if the CreateFileMappingA function is supported on the
  37135. ** target system. It is unavailable when using "mincore.lib" on Win10.
  37136. ** When compiling for Windows 10, always assume "mincore.lib" is in use.
  37137. */
  37138. #ifndef SQLITE_WIN32_CREATEFILEMAPPINGA
  37139. # if defined(NTDDI_VERSION) && NTDDI_VERSION >= NTDDI_WINTHRESHOLD
  37140. # define SQLITE_WIN32_CREATEFILEMAPPINGA 0
  37141. # else
  37142. # define SQLITE_WIN32_CREATEFILEMAPPINGA 1
  37143. # endif
  37144. #endif
  37145. /*
  37146. ** This constant should already be defined (in the "WinDef.h" SDK file).
  37147. */
  37148. #ifndef MAX_PATH
  37149. # define MAX_PATH (260)
  37150. #endif
  37151. /*
  37152. ** Maximum pathname length (in chars) for Win32. This should normally be
  37153. ** MAX_PATH.
  37154. */
  37155. #ifndef SQLITE_WIN32_MAX_PATH_CHARS
  37156. # define SQLITE_WIN32_MAX_PATH_CHARS (MAX_PATH)
  37157. #endif
  37158. /*
  37159. ** This constant should already be defined (in the "WinNT.h" SDK file).
  37160. */
  37161. #ifndef UNICODE_STRING_MAX_CHARS
  37162. # define UNICODE_STRING_MAX_CHARS (32767)
  37163. #endif
  37164. /*
  37165. ** Maximum pathname length (in chars) for WinNT. This should normally be
  37166. ** UNICODE_STRING_MAX_CHARS.
  37167. */
  37168. #ifndef SQLITE_WINNT_MAX_PATH_CHARS
  37169. # define SQLITE_WINNT_MAX_PATH_CHARS (UNICODE_STRING_MAX_CHARS)
  37170. #endif
  37171. /*
  37172. ** Maximum pathname length (in bytes) for Win32. The MAX_PATH macro is in
  37173. ** characters, so we allocate 4 bytes per character assuming worst-case of
  37174. ** 4-bytes-per-character for UTF8.
  37175. */
  37176. #ifndef SQLITE_WIN32_MAX_PATH_BYTES
  37177. # define SQLITE_WIN32_MAX_PATH_BYTES (SQLITE_WIN32_MAX_PATH_CHARS*4)
  37178. #endif
  37179. /*
  37180. ** Maximum pathname length (in bytes) for WinNT. This should normally be
  37181. ** UNICODE_STRING_MAX_CHARS * sizeof(WCHAR).
  37182. */
  37183. #ifndef SQLITE_WINNT_MAX_PATH_BYTES
  37184. # define SQLITE_WINNT_MAX_PATH_BYTES \
  37185. (sizeof(WCHAR) * SQLITE_WINNT_MAX_PATH_CHARS)
  37186. #endif
  37187. /*
  37188. ** Maximum error message length (in chars) for WinRT.
  37189. */
  37190. #ifndef SQLITE_WIN32_MAX_ERRMSG_CHARS
  37191. # define SQLITE_WIN32_MAX_ERRMSG_CHARS (1024)
  37192. #endif
  37193. /*
  37194. ** Returns non-zero if the character should be treated as a directory
  37195. ** separator.
  37196. */
  37197. #ifndef winIsDirSep
  37198. # define winIsDirSep(a) (((a) == '/') || ((a) == '\\'))
  37199. #endif
  37200. /*
  37201. ** This macro is used when a local variable is set to a value that is
  37202. ** [sometimes] not used by the code (e.g. via conditional compilation).
  37203. */
  37204. #ifndef UNUSED_VARIABLE_VALUE
  37205. # define UNUSED_VARIABLE_VALUE(x) (void)(x)
  37206. #endif
  37207. /*
  37208. ** Returns the character that should be used as the directory separator.
  37209. */
  37210. #ifndef winGetDirSep
  37211. # define winGetDirSep() '\\'
  37212. #endif
  37213. /*
  37214. ** Do we need to manually define the Win32 file mapping APIs for use with WAL
  37215. ** mode or memory mapped files (e.g. these APIs are available in the Windows
  37216. ** CE SDK; however, they are not present in the header file)?
  37217. */
  37218. #if SQLITE_WIN32_FILEMAPPING_API && \
  37219. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  37220. /*
  37221. ** Two of the file mapping APIs are different under WinRT. Figure out which
  37222. ** set we need.
  37223. */
  37224. #if SQLITE_OS_WINRT
  37225. WINBASEAPI HANDLE WINAPI CreateFileMappingFromApp(HANDLE, \
  37226. LPSECURITY_ATTRIBUTES, ULONG, ULONG64, LPCWSTR);
  37227. WINBASEAPI LPVOID WINAPI MapViewOfFileFromApp(HANDLE, ULONG, ULONG64, SIZE_T);
  37228. #else
  37229. #if defined(SQLITE_WIN32_HAS_ANSI)
  37230. WINBASEAPI HANDLE WINAPI CreateFileMappingA(HANDLE, LPSECURITY_ATTRIBUTES, \
  37231. DWORD, DWORD, DWORD, LPCSTR);
  37232. #endif /* defined(SQLITE_WIN32_HAS_ANSI) */
  37233. #if defined(SQLITE_WIN32_HAS_WIDE)
  37234. WINBASEAPI HANDLE WINAPI CreateFileMappingW(HANDLE, LPSECURITY_ATTRIBUTES, \
  37235. DWORD, DWORD, DWORD, LPCWSTR);
  37236. #endif /* defined(SQLITE_WIN32_HAS_WIDE) */
  37237. WINBASEAPI LPVOID WINAPI MapViewOfFile(HANDLE, DWORD, DWORD, DWORD, SIZE_T);
  37238. #endif /* SQLITE_OS_WINRT */
  37239. /*
  37240. ** These file mapping APIs are common to both Win32 and WinRT.
  37241. */
  37242. WINBASEAPI BOOL WINAPI FlushViewOfFile(LPCVOID, SIZE_T);
  37243. WINBASEAPI BOOL WINAPI UnmapViewOfFile(LPCVOID);
  37244. #endif /* SQLITE_WIN32_FILEMAPPING_API */
  37245. /*
  37246. ** Some Microsoft compilers lack this definition.
  37247. */
  37248. #ifndef INVALID_FILE_ATTRIBUTES
  37249. # define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
  37250. #endif
  37251. #ifndef FILE_FLAG_MASK
  37252. # define FILE_FLAG_MASK (0xFF3C0000)
  37253. #endif
  37254. #ifndef FILE_ATTRIBUTE_MASK
  37255. # define FILE_ATTRIBUTE_MASK (0x0003FFF7)
  37256. #endif
  37257. #ifndef SQLITE_OMIT_WAL
  37258. /* Forward references to structures used for WAL */
  37259. typedef struct winShm winShm; /* A connection to shared-memory */
  37260. typedef struct winShmNode winShmNode; /* A region of shared-memory */
  37261. #endif
  37262. /*
  37263. ** WinCE lacks native support for file locking so we have to fake it
  37264. ** with some code of our own.
  37265. */
  37266. #if SQLITE_OS_WINCE
  37267. typedef struct winceLock {
  37268. int nReaders; /* Number of reader locks obtained */
  37269. BOOL bPending; /* Indicates a pending lock has been obtained */
  37270. BOOL bReserved; /* Indicates a reserved lock has been obtained */
  37271. BOOL bExclusive; /* Indicates an exclusive lock has been obtained */
  37272. } winceLock;
  37273. #endif
  37274. /*
  37275. ** The winFile structure is a subclass of sqlite3_file* specific to the win32
  37276. ** portability layer.
  37277. */
  37278. typedef struct winFile winFile;
  37279. struct winFile {
  37280. const sqlite3_io_methods *pMethod; /*** Must be first ***/
  37281. sqlite3_vfs *pVfs; /* The VFS used to open this file */
  37282. HANDLE h; /* Handle for accessing the file */
  37283. u8 locktype; /* Type of lock currently held on this file */
  37284. short sharedLockByte; /* Randomly chosen byte used as a shared lock */
  37285. u8 ctrlFlags; /* Flags. See WINFILE_* below */
  37286. DWORD lastErrno; /* The Windows errno from the last I/O error */
  37287. #ifndef SQLITE_OMIT_WAL
  37288. winShm *pShm; /* Instance of shared memory on this file */
  37289. #endif
  37290. const char *zPath; /* Full pathname of this file */
  37291. int szChunk; /* Chunk size configured by FCNTL_CHUNK_SIZE */
  37292. #if SQLITE_OS_WINCE
  37293. LPWSTR zDeleteOnClose; /* Name of file to delete when closing */
  37294. HANDLE hMutex; /* Mutex used to control access to shared lock */
  37295. HANDLE hShared; /* Shared memory segment used for locking */
  37296. winceLock local; /* Locks obtained by this instance of winFile */
  37297. winceLock *shared; /* Global shared lock memory for the file */
  37298. #endif
  37299. #if SQLITE_MAX_MMAP_SIZE>0
  37300. int nFetchOut; /* Number of outstanding xFetch references */
  37301. HANDLE hMap; /* Handle for accessing memory mapping */
  37302. void *pMapRegion; /* Area memory mapped */
  37303. sqlite3_int64 mmapSize; /* Usable size of mapped region */
  37304. sqlite3_int64 mmapSizeActual; /* Actual size of mapped region */
  37305. sqlite3_int64 mmapSizeMax; /* Configured FCNTL_MMAP_SIZE value */
  37306. #endif
  37307. };
  37308. /*
  37309. ** The winVfsAppData structure is used for the pAppData member for all of the
  37310. ** Win32 VFS variants.
  37311. */
  37312. typedef struct winVfsAppData winVfsAppData;
  37313. struct winVfsAppData {
  37314. const sqlite3_io_methods *pMethod; /* The file I/O methods to use. */
  37315. void *pAppData; /* The extra pAppData, if any. */
  37316. BOOL bNoLock; /* Non-zero if locking is disabled. */
  37317. };
  37318. /*
  37319. ** Allowed values for winFile.ctrlFlags
  37320. */
  37321. #define WINFILE_RDONLY 0x02 /* Connection is read only */
  37322. #define WINFILE_PERSIST_WAL 0x04 /* Persistent WAL mode */
  37323. #define WINFILE_PSOW 0x10 /* SQLITE_IOCAP_POWERSAFE_OVERWRITE */
  37324. /*
  37325. * The size of the buffer used by sqlite3_win32_write_debug().
  37326. */
  37327. #ifndef SQLITE_WIN32_DBG_BUF_SIZE
  37328. # define SQLITE_WIN32_DBG_BUF_SIZE ((int)(4096-sizeof(DWORD)))
  37329. #endif
  37330. /*
  37331. * The value used with sqlite3_win32_set_directory() to specify that
  37332. * the data directory should be changed.
  37333. */
  37334. #ifndef SQLITE_WIN32_DATA_DIRECTORY_TYPE
  37335. # define SQLITE_WIN32_DATA_DIRECTORY_TYPE (1)
  37336. #endif
  37337. /*
  37338. * The value used with sqlite3_win32_set_directory() to specify that
  37339. * the temporary directory should be changed.
  37340. */
  37341. #ifndef SQLITE_WIN32_TEMP_DIRECTORY_TYPE
  37342. # define SQLITE_WIN32_TEMP_DIRECTORY_TYPE (2)
  37343. #endif
  37344. /*
  37345. * If compiled with SQLITE_WIN32_MALLOC on Windows, we will use the
  37346. * various Win32 API heap functions instead of our own.
  37347. */
  37348. #ifdef SQLITE_WIN32_MALLOC
  37349. /*
  37350. * If this is non-zero, an isolated heap will be created by the native Win32
  37351. * allocator subsystem; otherwise, the default process heap will be used. This
  37352. * setting has no effect when compiling for WinRT. By default, this is enabled
  37353. * and an isolated heap will be created to store all allocated data.
  37354. *
  37355. ******************************************************************************
  37356. * WARNING: It is important to note that when this setting is non-zero and the
  37357. * winMemShutdown function is called (e.g. by the sqlite3_shutdown
  37358. * function), all data that was allocated using the isolated heap will
  37359. * be freed immediately and any attempt to access any of that freed
  37360. * data will almost certainly result in an immediate access violation.
  37361. ******************************************************************************
  37362. */
  37363. #ifndef SQLITE_WIN32_HEAP_CREATE
  37364. # define SQLITE_WIN32_HEAP_CREATE (TRUE)
  37365. #endif
  37366. /*
  37367. * This is the maximum possible initial size of the Win32-specific heap, in
  37368. * bytes.
  37369. */
  37370. #ifndef SQLITE_WIN32_HEAP_MAX_INIT_SIZE
  37371. # define SQLITE_WIN32_HEAP_MAX_INIT_SIZE (4294967295U)
  37372. #endif
  37373. /*
  37374. * This is the extra space for the initial size of the Win32-specific heap,
  37375. * in bytes. This value may be zero.
  37376. */
  37377. #ifndef SQLITE_WIN32_HEAP_INIT_EXTRA
  37378. # define SQLITE_WIN32_HEAP_INIT_EXTRA (4194304)
  37379. #endif
  37380. /*
  37381. * Calculate the maximum legal cache size, in pages, based on the maximum
  37382. * possible initial heap size and the default page size, setting aside the
  37383. * needed extra space.
  37384. */
  37385. #ifndef SQLITE_WIN32_MAX_CACHE_SIZE
  37386. # define SQLITE_WIN32_MAX_CACHE_SIZE (((SQLITE_WIN32_HEAP_MAX_INIT_SIZE) - \
  37387. (SQLITE_WIN32_HEAP_INIT_EXTRA)) / \
  37388. (SQLITE_DEFAULT_PAGE_SIZE))
  37389. #endif
  37390. /*
  37391. * This is cache size used in the calculation of the initial size of the
  37392. * Win32-specific heap. It cannot be negative.
  37393. */
  37394. #ifndef SQLITE_WIN32_CACHE_SIZE
  37395. # if SQLITE_DEFAULT_CACHE_SIZE>=0
  37396. # define SQLITE_WIN32_CACHE_SIZE (SQLITE_DEFAULT_CACHE_SIZE)
  37397. # else
  37398. # define SQLITE_WIN32_CACHE_SIZE (-(SQLITE_DEFAULT_CACHE_SIZE))
  37399. # endif
  37400. #endif
  37401. /*
  37402. * Make sure that the calculated cache size, in pages, cannot cause the
  37403. * initial size of the Win32-specific heap to exceed the maximum amount
  37404. * of memory that can be specified in the call to HeapCreate.
  37405. */
  37406. #if SQLITE_WIN32_CACHE_SIZE>SQLITE_WIN32_MAX_CACHE_SIZE
  37407. # undef SQLITE_WIN32_CACHE_SIZE
  37408. # define SQLITE_WIN32_CACHE_SIZE (2000)
  37409. #endif
  37410. /*
  37411. * The initial size of the Win32-specific heap. This value may be zero.
  37412. */
  37413. #ifndef SQLITE_WIN32_HEAP_INIT_SIZE
  37414. # define SQLITE_WIN32_HEAP_INIT_SIZE ((SQLITE_WIN32_CACHE_SIZE) * \
  37415. (SQLITE_DEFAULT_PAGE_SIZE) + \
  37416. (SQLITE_WIN32_HEAP_INIT_EXTRA))
  37417. #endif
  37418. /*
  37419. * The maximum size of the Win32-specific heap. This value may be zero.
  37420. */
  37421. #ifndef SQLITE_WIN32_HEAP_MAX_SIZE
  37422. # define SQLITE_WIN32_HEAP_MAX_SIZE (0)
  37423. #endif
  37424. /*
  37425. * The extra flags to use in calls to the Win32 heap APIs. This value may be
  37426. * zero for the default behavior.
  37427. */
  37428. #ifndef SQLITE_WIN32_HEAP_FLAGS
  37429. # define SQLITE_WIN32_HEAP_FLAGS (0)
  37430. #endif
  37431. /*
  37432. ** The winMemData structure stores information required by the Win32-specific
  37433. ** sqlite3_mem_methods implementation.
  37434. */
  37435. typedef struct winMemData winMemData;
  37436. struct winMemData {
  37437. #ifndef NDEBUG
  37438. u32 magic1; /* Magic number to detect structure corruption. */
  37439. #endif
  37440. HANDLE hHeap; /* The handle to our heap. */
  37441. BOOL bOwned; /* Do we own the heap (i.e. destroy it on shutdown)? */
  37442. #ifndef NDEBUG
  37443. u32 magic2; /* Magic number to detect structure corruption. */
  37444. #endif
  37445. };
  37446. #ifndef NDEBUG
  37447. #define WINMEM_MAGIC1 0x42b2830b
  37448. #define WINMEM_MAGIC2 0xbd4d7cf4
  37449. #endif
  37450. static struct winMemData win_mem_data = {
  37451. #ifndef NDEBUG
  37452. WINMEM_MAGIC1,
  37453. #endif
  37454. NULL, FALSE
  37455. #ifndef NDEBUG
  37456. ,WINMEM_MAGIC2
  37457. #endif
  37458. };
  37459. #ifndef NDEBUG
  37460. #define winMemAssertMagic1() assert( win_mem_data.magic1==WINMEM_MAGIC1 )
  37461. #define winMemAssertMagic2() assert( win_mem_data.magic2==WINMEM_MAGIC2 )
  37462. #define winMemAssertMagic() winMemAssertMagic1(); winMemAssertMagic2();
  37463. #else
  37464. #define winMemAssertMagic()
  37465. #endif
  37466. #define winMemGetDataPtr() &win_mem_data
  37467. #define winMemGetHeap() win_mem_data.hHeap
  37468. #define winMemGetOwned() win_mem_data.bOwned
  37469. static void *winMemMalloc(int nBytes);
  37470. static void winMemFree(void *pPrior);
  37471. static void *winMemRealloc(void *pPrior, int nBytes);
  37472. static int winMemSize(void *p);
  37473. static int winMemRoundup(int n);
  37474. static int winMemInit(void *pAppData);
  37475. static void winMemShutdown(void *pAppData);
  37476. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetWin32(void);
  37477. #endif /* SQLITE_WIN32_MALLOC */
  37478. /*
  37479. ** The following variable is (normally) set once and never changes
  37480. ** thereafter. It records whether the operating system is Win9x
  37481. ** or WinNT.
  37482. **
  37483. ** 0: Operating system unknown.
  37484. ** 1: Operating system is Win9x.
  37485. ** 2: Operating system is WinNT.
  37486. **
  37487. ** In order to facilitate testing on a WinNT system, the test fixture
  37488. ** can manually set this value to 1 to emulate Win98 behavior.
  37489. */
  37490. #ifdef SQLITE_TEST
  37491. SQLITE_API LONG SQLITE_WIN32_VOLATILE sqlite3_os_type = 0;
  37492. #else
  37493. static LONG SQLITE_WIN32_VOLATILE sqlite3_os_type = 0;
  37494. #endif
  37495. #ifndef SYSCALL
  37496. # define SYSCALL sqlite3_syscall_ptr
  37497. #endif
  37498. /*
  37499. ** This function is not available on Windows CE or WinRT.
  37500. */
  37501. #if SQLITE_OS_WINCE || SQLITE_OS_WINRT
  37502. # define osAreFileApisANSI() 1
  37503. #endif
  37504. /*
  37505. ** Many system calls are accessed through pointer-to-functions so that
  37506. ** they may be overridden at runtime to facilitate fault injection during
  37507. ** testing and sandboxing. The following array holds the names and pointers
  37508. ** to all overrideable system calls.
  37509. */
  37510. static struct win_syscall {
  37511. const char *zName; /* Name of the system call */
  37512. sqlite3_syscall_ptr pCurrent; /* Current value of the system call */
  37513. sqlite3_syscall_ptr pDefault; /* Default value */
  37514. } aSyscall[] = {
  37515. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  37516. { "AreFileApisANSI", (SYSCALL)AreFileApisANSI, 0 },
  37517. #else
  37518. { "AreFileApisANSI", (SYSCALL)0, 0 },
  37519. #endif
  37520. #ifndef osAreFileApisANSI
  37521. #define osAreFileApisANSI ((BOOL(WINAPI*)(VOID))aSyscall[0].pCurrent)
  37522. #endif
  37523. #if SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_WIDE)
  37524. { "CharLowerW", (SYSCALL)CharLowerW, 0 },
  37525. #else
  37526. { "CharLowerW", (SYSCALL)0, 0 },
  37527. #endif
  37528. #define osCharLowerW ((LPWSTR(WINAPI*)(LPWSTR))aSyscall[1].pCurrent)
  37529. #if SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_WIDE)
  37530. { "CharUpperW", (SYSCALL)CharUpperW, 0 },
  37531. #else
  37532. { "CharUpperW", (SYSCALL)0, 0 },
  37533. #endif
  37534. #define osCharUpperW ((LPWSTR(WINAPI*)(LPWSTR))aSyscall[2].pCurrent)
  37535. { "CloseHandle", (SYSCALL)CloseHandle, 0 },
  37536. #define osCloseHandle ((BOOL(WINAPI*)(HANDLE))aSyscall[3].pCurrent)
  37537. #if defined(SQLITE_WIN32_HAS_ANSI)
  37538. { "CreateFileA", (SYSCALL)CreateFileA, 0 },
  37539. #else
  37540. { "CreateFileA", (SYSCALL)0, 0 },
  37541. #endif
  37542. #define osCreateFileA ((HANDLE(WINAPI*)(LPCSTR,DWORD,DWORD, \
  37543. LPSECURITY_ATTRIBUTES,DWORD,DWORD,HANDLE))aSyscall[4].pCurrent)
  37544. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  37545. { "CreateFileW", (SYSCALL)CreateFileW, 0 },
  37546. #else
  37547. { "CreateFileW", (SYSCALL)0, 0 },
  37548. #endif
  37549. #define osCreateFileW ((HANDLE(WINAPI*)(LPCWSTR,DWORD,DWORD, \
  37550. LPSECURITY_ATTRIBUTES,DWORD,DWORD,HANDLE))aSyscall[5].pCurrent)
  37551. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_ANSI) && \
  37552. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0) && \
  37553. SQLITE_WIN32_CREATEFILEMAPPINGA
  37554. { "CreateFileMappingA", (SYSCALL)CreateFileMappingA, 0 },
  37555. #else
  37556. { "CreateFileMappingA", (SYSCALL)0, 0 },
  37557. #endif
  37558. #define osCreateFileMappingA ((HANDLE(WINAPI*)(HANDLE,LPSECURITY_ATTRIBUTES, \
  37559. DWORD,DWORD,DWORD,LPCSTR))aSyscall[6].pCurrent)
  37560. #if SQLITE_OS_WINCE || (!SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE) && \
  37561. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0))
  37562. { "CreateFileMappingW", (SYSCALL)CreateFileMappingW, 0 },
  37563. #else
  37564. { "CreateFileMappingW", (SYSCALL)0, 0 },
  37565. #endif
  37566. #define osCreateFileMappingW ((HANDLE(WINAPI*)(HANDLE,LPSECURITY_ATTRIBUTES, \
  37567. DWORD,DWORD,DWORD,LPCWSTR))aSyscall[7].pCurrent)
  37568. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  37569. { "CreateMutexW", (SYSCALL)CreateMutexW, 0 },
  37570. #else
  37571. { "CreateMutexW", (SYSCALL)0, 0 },
  37572. #endif
  37573. #define osCreateMutexW ((HANDLE(WINAPI*)(LPSECURITY_ATTRIBUTES,BOOL, \
  37574. LPCWSTR))aSyscall[8].pCurrent)
  37575. #if defined(SQLITE_WIN32_HAS_ANSI)
  37576. { "DeleteFileA", (SYSCALL)DeleteFileA, 0 },
  37577. #else
  37578. { "DeleteFileA", (SYSCALL)0, 0 },
  37579. #endif
  37580. #define osDeleteFileA ((BOOL(WINAPI*)(LPCSTR))aSyscall[9].pCurrent)
  37581. #if defined(SQLITE_WIN32_HAS_WIDE)
  37582. { "DeleteFileW", (SYSCALL)DeleteFileW, 0 },
  37583. #else
  37584. { "DeleteFileW", (SYSCALL)0, 0 },
  37585. #endif
  37586. #define osDeleteFileW ((BOOL(WINAPI*)(LPCWSTR))aSyscall[10].pCurrent)
  37587. #if SQLITE_OS_WINCE
  37588. { "FileTimeToLocalFileTime", (SYSCALL)FileTimeToLocalFileTime, 0 },
  37589. #else
  37590. { "FileTimeToLocalFileTime", (SYSCALL)0, 0 },
  37591. #endif
  37592. #define osFileTimeToLocalFileTime ((BOOL(WINAPI*)(CONST FILETIME*, \
  37593. LPFILETIME))aSyscall[11].pCurrent)
  37594. #if SQLITE_OS_WINCE
  37595. { "FileTimeToSystemTime", (SYSCALL)FileTimeToSystemTime, 0 },
  37596. #else
  37597. { "FileTimeToSystemTime", (SYSCALL)0, 0 },
  37598. #endif
  37599. #define osFileTimeToSystemTime ((BOOL(WINAPI*)(CONST FILETIME*, \
  37600. LPSYSTEMTIME))aSyscall[12].pCurrent)
  37601. { "FlushFileBuffers", (SYSCALL)FlushFileBuffers, 0 },
  37602. #define osFlushFileBuffers ((BOOL(WINAPI*)(HANDLE))aSyscall[13].pCurrent)
  37603. #if defined(SQLITE_WIN32_HAS_ANSI)
  37604. { "FormatMessageA", (SYSCALL)FormatMessageA, 0 },
  37605. #else
  37606. { "FormatMessageA", (SYSCALL)0, 0 },
  37607. #endif
  37608. #define osFormatMessageA ((DWORD(WINAPI*)(DWORD,LPCVOID,DWORD,DWORD,LPSTR, \
  37609. DWORD,va_list*))aSyscall[14].pCurrent)
  37610. #if defined(SQLITE_WIN32_HAS_WIDE)
  37611. { "FormatMessageW", (SYSCALL)FormatMessageW, 0 },
  37612. #else
  37613. { "FormatMessageW", (SYSCALL)0, 0 },
  37614. #endif
  37615. #define osFormatMessageW ((DWORD(WINAPI*)(DWORD,LPCVOID,DWORD,DWORD,LPWSTR, \
  37616. DWORD,va_list*))aSyscall[15].pCurrent)
  37617. #if !defined(SQLITE_OMIT_LOAD_EXTENSION)
  37618. { "FreeLibrary", (SYSCALL)FreeLibrary, 0 },
  37619. #else
  37620. { "FreeLibrary", (SYSCALL)0, 0 },
  37621. #endif
  37622. #define osFreeLibrary ((BOOL(WINAPI*)(HMODULE))aSyscall[16].pCurrent)
  37623. { "GetCurrentProcessId", (SYSCALL)GetCurrentProcessId, 0 },
  37624. #define osGetCurrentProcessId ((DWORD(WINAPI*)(VOID))aSyscall[17].pCurrent)
  37625. #if !SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_ANSI)
  37626. { "GetDiskFreeSpaceA", (SYSCALL)GetDiskFreeSpaceA, 0 },
  37627. #else
  37628. { "GetDiskFreeSpaceA", (SYSCALL)0, 0 },
  37629. #endif
  37630. #define osGetDiskFreeSpaceA ((BOOL(WINAPI*)(LPCSTR,LPDWORD,LPDWORD,LPDWORD, \
  37631. LPDWORD))aSyscall[18].pCurrent)
  37632. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  37633. { "GetDiskFreeSpaceW", (SYSCALL)GetDiskFreeSpaceW, 0 },
  37634. #else
  37635. { "GetDiskFreeSpaceW", (SYSCALL)0, 0 },
  37636. #endif
  37637. #define osGetDiskFreeSpaceW ((BOOL(WINAPI*)(LPCWSTR,LPDWORD,LPDWORD,LPDWORD, \
  37638. LPDWORD))aSyscall[19].pCurrent)
  37639. #if defined(SQLITE_WIN32_HAS_ANSI)
  37640. { "GetFileAttributesA", (SYSCALL)GetFileAttributesA, 0 },
  37641. #else
  37642. { "GetFileAttributesA", (SYSCALL)0, 0 },
  37643. #endif
  37644. #define osGetFileAttributesA ((DWORD(WINAPI*)(LPCSTR))aSyscall[20].pCurrent)
  37645. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  37646. { "GetFileAttributesW", (SYSCALL)GetFileAttributesW, 0 },
  37647. #else
  37648. { "GetFileAttributesW", (SYSCALL)0, 0 },
  37649. #endif
  37650. #define osGetFileAttributesW ((DWORD(WINAPI*)(LPCWSTR))aSyscall[21].pCurrent)
  37651. #if defined(SQLITE_WIN32_HAS_WIDE)
  37652. { "GetFileAttributesExW", (SYSCALL)GetFileAttributesExW, 0 },
  37653. #else
  37654. { "GetFileAttributesExW", (SYSCALL)0, 0 },
  37655. #endif
  37656. #define osGetFileAttributesExW ((BOOL(WINAPI*)(LPCWSTR,GET_FILEEX_INFO_LEVELS, \
  37657. LPVOID))aSyscall[22].pCurrent)
  37658. #if !SQLITE_OS_WINRT
  37659. { "GetFileSize", (SYSCALL)GetFileSize, 0 },
  37660. #else
  37661. { "GetFileSize", (SYSCALL)0, 0 },
  37662. #endif
  37663. #define osGetFileSize ((DWORD(WINAPI*)(HANDLE,LPDWORD))aSyscall[23].pCurrent)
  37664. #if !SQLITE_OS_WINCE && defined(SQLITE_WIN32_HAS_ANSI)
  37665. { "GetFullPathNameA", (SYSCALL)GetFullPathNameA, 0 },
  37666. #else
  37667. { "GetFullPathNameA", (SYSCALL)0, 0 },
  37668. #endif
  37669. #define osGetFullPathNameA ((DWORD(WINAPI*)(LPCSTR,DWORD,LPSTR, \
  37670. LPSTR*))aSyscall[24].pCurrent)
  37671. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  37672. { "GetFullPathNameW", (SYSCALL)GetFullPathNameW, 0 },
  37673. #else
  37674. { "GetFullPathNameW", (SYSCALL)0, 0 },
  37675. #endif
  37676. #define osGetFullPathNameW ((DWORD(WINAPI*)(LPCWSTR,DWORD,LPWSTR, \
  37677. LPWSTR*))aSyscall[25].pCurrent)
  37678. { "GetLastError", (SYSCALL)GetLastError, 0 },
  37679. #define osGetLastError ((DWORD(WINAPI*)(VOID))aSyscall[26].pCurrent)
  37680. #if !defined(SQLITE_OMIT_LOAD_EXTENSION)
  37681. #if SQLITE_OS_WINCE
  37682. /* The GetProcAddressA() routine is only available on Windows CE. */
  37683. { "GetProcAddressA", (SYSCALL)GetProcAddressA, 0 },
  37684. #else
  37685. /* All other Windows platforms expect GetProcAddress() to take
  37686. ** an ANSI string regardless of the _UNICODE setting */
  37687. { "GetProcAddressA", (SYSCALL)GetProcAddress, 0 },
  37688. #endif
  37689. #else
  37690. { "GetProcAddressA", (SYSCALL)0, 0 },
  37691. #endif
  37692. #define osGetProcAddressA ((FARPROC(WINAPI*)(HMODULE, \
  37693. LPCSTR))aSyscall[27].pCurrent)
  37694. #if !SQLITE_OS_WINRT
  37695. { "GetSystemInfo", (SYSCALL)GetSystemInfo, 0 },
  37696. #else
  37697. { "GetSystemInfo", (SYSCALL)0, 0 },
  37698. #endif
  37699. #define osGetSystemInfo ((VOID(WINAPI*)(LPSYSTEM_INFO))aSyscall[28].pCurrent)
  37700. { "GetSystemTime", (SYSCALL)GetSystemTime, 0 },
  37701. #define osGetSystemTime ((VOID(WINAPI*)(LPSYSTEMTIME))aSyscall[29].pCurrent)
  37702. #if !SQLITE_OS_WINCE
  37703. { "GetSystemTimeAsFileTime", (SYSCALL)GetSystemTimeAsFileTime, 0 },
  37704. #else
  37705. { "GetSystemTimeAsFileTime", (SYSCALL)0, 0 },
  37706. #endif
  37707. #define osGetSystemTimeAsFileTime ((VOID(WINAPI*)( \
  37708. LPFILETIME))aSyscall[30].pCurrent)
  37709. #if defined(SQLITE_WIN32_HAS_ANSI)
  37710. { "GetTempPathA", (SYSCALL)GetTempPathA, 0 },
  37711. #else
  37712. { "GetTempPathA", (SYSCALL)0, 0 },
  37713. #endif
  37714. #define osGetTempPathA ((DWORD(WINAPI*)(DWORD,LPSTR))aSyscall[31].pCurrent)
  37715. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE)
  37716. { "GetTempPathW", (SYSCALL)GetTempPathW, 0 },
  37717. #else
  37718. { "GetTempPathW", (SYSCALL)0, 0 },
  37719. #endif
  37720. #define osGetTempPathW ((DWORD(WINAPI*)(DWORD,LPWSTR))aSyscall[32].pCurrent)
  37721. #if !SQLITE_OS_WINRT
  37722. { "GetTickCount", (SYSCALL)GetTickCount, 0 },
  37723. #else
  37724. { "GetTickCount", (SYSCALL)0, 0 },
  37725. #endif
  37726. #define osGetTickCount ((DWORD(WINAPI*)(VOID))aSyscall[33].pCurrent)
  37727. #if defined(SQLITE_WIN32_HAS_ANSI) && SQLITE_WIN32_GETVERSIONEX
  37728. { "GetVersionExA", (SYSCALL)GetVersionExA, 0 },
  37729. #else
  37730. { "GetVersionExA", (SYSCALL)0, 0 },
  37731. #endif
  37732. #define osGetVersionExA ((BOOL(WINAPI*)( \
  37733. LPOSVERSIONINFOA))aSyscall[34].pCurrent)
  37734. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE) && \
  37735. SQLITE_WIN32_GETVERSIONEX
  37736. { "GetVersionExW", (SYSCALL)GetVersionExW, 0 },
  37737. #else
  37738. { "GetVersionExW", (SYSCALL)0, 0 },
  37739. #endif
  37740. #define osGetVersionExW ((BOOL(WINAPI*)( \
  37741. LPOSVERSIONINFOW))aSyscall[35].pCurrent)
  37742. { "HeapAlloc", (SYSCALL)HeapAlloc, 0 },
  37743. #define osHeapAlloc ((LPVOID(WINAPI*)(HANDLE,DWORD, \
  37744. SIZE_T))aSyscall[36].pCurrent)
  37745. #if !SQLITE_OS_WINRT
  37746. { "HeapCreate", (SYSCALL)HeapCreate, 0 },
  37747. #else
  37748. { "HeapCreate", (SYSCALL)0, 0 },
  37749. #endif
  37750. #define osHeapCreate ((HANDLE(WINAPI*)(DWORD,SIZE_T, \
  37751. SIZE_T))aSyscall[37].pCurrent)
  37752. #if !SQLITE_OS_WINRT
  37753. { "HeapDestroy", (SYSCALL)HeapDestroy, 0 },
  37754. #else
  37755. { "HeapDestroy", (SYSCALL)0, 0 },
  37756. #endif
  37757. #define osHeapDestroy ((BOOL(WINAPI*)(HANDLE))aSyscall[38].pCurrent)
  37758. { "HeapFree", (SYSCALL)HeapFree, 0 },
  37759. #define osHeapFree ((BOOL(WINAPI*)(HANDLE,DWORD,LPVOID))aSyscall[39].pCurrent)
  37760. { "HeapReAlloc", (SYSCALL)HeapReAlloc, 0 },
  37761. #define osHeapReAlloc ((LPVOID(WINAPI*)(HANDLE,DWORD,LPVOID, \
  37762. SIZE_T))aSyscall[40].pCurrent)
  37763. { "HeapSize", (SYSCALL)HeapSize, 0 },
  37764. #define osHeapSize ((SIZE_T(WINAPI*)(HANDLE,DWORD, \
  37765. LPCVOID))aSyscall[41].pCurrent)
  37766. #if !SQLITE_OS_WINRT
  37767. { "HeapValidate", (SYSCALL)HeapValidate, 0 },
  37768. #else
  37769. { "HeapValidate", (SYSCALL)0, 0 },
  37770. #endif
  37771. #define osHeapValidate ((BOOL(WINAPI*)(HANDLE,DWORD, \
  37772. LPCVOID))aSyscall[42].pCurrent)
  37773. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  37774. { "HeapCompact", (SYSCALL)HeapCompact, 0 },
  37775. #else
  37776. { "HeapCompact", (SYSCALL)0, 0 },
  37777. #endif
  37778. #define osHeapCompact ((UINT(WINAPI*)(HANDLE,DWORD))aSyscall[43].pCurrent)
  37779. #if defined(SQLITE_WIN32_HAS_ANSI) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  37780. { "LoadLibraryA", (SYSCALL)LoadLibraryA, 0 },
  37781. #else
  37782. { "LoadLibraryA", (SYSCALL)0, 0 },
  37783. #endif
  37784. #define osLoadLibraryA ((HMODULE(WINAPI*)(LPCSTR))aSyscall[44].pCurrent)
  37785. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_HAS_WIDE) && \
  37786. !defined(SQLITE_OMIT_LOAD_EXTENSION)
  37787. { "LoadLibraryW", (SYSCALL)LoadLibraryW, 0 },
  37788. #else
  37789. { "LoadLibraryW", (SYSCALL)0, 0 },
  37790. #endif
  37791. #define osLoadLibraryW ((HMODULE(WINAPI*)(LPCWSTR))aSyscall[45].pCurrent)
  37792. #if !SQLITE_OS_WINRT
  37793. { "LocalFree", (SYSCALL)LocalFree, 0 },
  37794. #else
  37795. { "LocalFree", (SYSCALL)0, 0 },
  37796. #endif
  37797. #define osLocalFree ((HLOCAL(WINAPI*)(HLOCAL))aSyscall[46].pCurrent)
  37798. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  37799. { "LockFile", (SYSCALL)LockFile, 0 },
  37800. #else
  37801. { "LockFile", (SYSCALL)0, 0 },
  37802. #endif
  37803. #ifndef osLockFile
  37804. #define osLockFile ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  37805. DWORD))aSyscall[47].pCurrent)
  37806. #endif
  37807. #if !SQLITE_OS_WINCE
  37808. { "LockFileEx", (SYSCALL)LockFileEx, 0 },
  37809. #else
  37810. { "LockFileEx", (SYSCALL)0, 0 },
  37811. #endif
  37812. #ifndef osLockFileEx
  37813. #define osLockFileEx ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD,DWORD, \
  37814. LPOVERLAPPED))aSyscall[48].pCurrent)
  37815. #endif
  37816. #if SQLITE_OS_WINCE || (!SQLITE_OS_WINRT && \
  37817. (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0))
  37818. { "MapViewOfFile", (SYSCALL)MapViewOfFile, 0 },
  37819. #else
  37820. { "MapViewOfFile", (SYSCALL)0, 0 },
  37821. #endif
  37822. #define osMapViewOfFile ((LPVOID(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  37823. SIZE_T))aSyscall[49].pCurrent)
  37824. { "MultiByteToWideChar", (SYSCALL)MultiByteToWideChar, 0 },
  37825. #define osMultiByteToWideChar ((int(WINAPI*)(UINT,DWORD,LPCSTR,int,LPWSTR, \
  37826. int))aSyscall[50].pCurrent)
  37827. { "QueryPerformanceCounter", (SYSCALL)QueryPerformanceCounter, 0 },
  37828. #define osQueryPerformanceCounter ((BOOL(WINAPI*)( \
  37829. LARGE_INTEGER*))aSyscall[51].pCurrent)
  37830. { "ReadFile", (SYSCALL)ReadFile, 0 },
  37831. #define osReadFile ((BOOL(WINAPI*)(HANDLE,LPVOID,DWORD,LPDWORD, \
  37832. LPOVERLAPPED))aSyscall[52].pCurrent)
  37833. { "SetEndOfFile", (SYSCALL)SetEndOfFile, 0 },
  37834. #define osSetEndOfFile ((BOOL(WINAPI*)(HANDLE))aSyscall[53].pCurrent)
  37835. #if !SQLITE_OS_WINRT
  37836. { "SetFilePointer", (SYSCALL)SetFilePointer, 0 },
  37837. #else
  37838. { "SetFilePointer", (SYSCALL)0, 0 },
  37839. #endif
  37840. #define osSetFilePointer ((DWORD(WINAPI*)(HANDLE,LONG,PLONG, \
  37841. DWORD))aSyscall[54].pCurrent)
  37842. #if !SQLITE_OS_WINRT
  37843. { "Sleep", (SYSCALL)Sleep, 0 },
  37844. #else
  37845. { "Sleep", (SYSCALL)0, 0 },
  37846. #endif
  37847. #define osSleep ((VOID(WINAPI*)(DWORD))aSyscall[55].pCurrent)
  37848. { "SystemTimeToFileTime", (SYSCALL)SystemTimeToFileTime, 0 },
  37849. #define osSystemTimeToFileTime ((BOOL(WINAPI*)(CONST SYSTEMTIME*, \
  37850. LPFILETIME))aSyscall[56].pCurrent)
  37851. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  37852. { "UnlockFile", (SYSCALL)UnlockFile, 0 },
  37853. #else
  37854. { "UnlockFile", (SYSCALL)0, 0 },
  37855. #endif
  37856. #ifndef osUnlockFile
  37857. #define osUnlockFile ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  37858. DWORD))aSyscall[57].pCurrent)
  37859. #endif
  37860. #if !SQLITE_OS_WINCE
  37861. { "UnlockFileEx", (SYSCALL)UnlockFileEx, 0 },
  37862. #else
  37863. { "UnlockFileEx", (SYSCALL)0, 0 },
  37864. #endif
  37865. #define osUnlockFileEx ((BOOL(WINAPI*)(HANDLE,DWORD,DWORD,DWORD, \
  37866. LPOVERLAPPED))aSyscall[58].pCurrent)
  37867. #if SQLITE_OS_WINCE || !defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0
  37868. { "UnmapViewOfFile", (SYSCALL)UnmapViewOfFile, 0 },
  37869. #else
  37870. { "UnmapViewOfFile", (SYSCALL)0, 0 },
  37871. #endif
  37872. #define osUnmapViewOfFile ((BOOL(WINAPI*)(LPCVOID))aSyscall[59].pCurrent)
  37873. { "WideCharToMultiByte", (SYSCALL)WideCharToMultiByte, 0 },
  37874. #define osWideCharToMultiByte ((int(WINAPI*)(UINT,DWORD,LPCWSTR,int,LPSTR,int, \
  37875. LPCSTR,LPBOOL))aSyscall[60].pCurrent)
  37876. { "WriteFile", (SYSCALL)WriteFile, 0 },
  37877. #define osWriteFile ((BOOL(WINAPI*)(HANDLE,LPCVOID,DWORD,LPDWORD, \
  37878. LPOVERLAPPED))aSyscall[61].pCurrent)
  37879. #if SQLITE_OS_WINRT
  37880. { "CreateEventExW", (SYSCALL)CreateEventExW, 0 },
  37881. #else
  37882. { "CreateEventExW", (SYSCALL)0, 0 },
  37883. #endif
  37884. #define osCreateEventExW ((HANDLE(WINAPI*)(LPSECURITY_ATTRIBUTES,LPCWSTR, \
  37885. DWORD,DWORD))aSyscall[62].pCurrent)
  37886. #if !SQLITE_OS_WINRT
  37887. { "WaitForSingleObject", (SYSCALL)WaitForSingleObject, 0 },
  37888. #else
  37889. { "WaitForSingleObject", (SYSCALL)0, 0 },
  37890. #endif
  37891. #define osWaitForSingleObject ((DWORD(WINAPI*)(HANDLE, \
  37892. DWORD))aSyscall[63].pCurrent)
  37893. #if !SQLITE_OS_WINCE
  37894. { "WaitForSingleObjectEx", (SYSCALL)WaitForSingleObjectEx, 0 },
  37895. #else
  37896. { "WaitForSingleObjectEx", (SYSCALL)0, 0 },
  37897. #endif
  37898. #define osWaitForSingleObjectEx ((DWORD(WINAPI*)(HANDLE,DWORD, \
  37899. BOOL))aSyscall[64].pCurrent)
  37900. #if SQLITE_OS_WINRT
  37901. { "SetFilePointerEx", (SYSCALL)SetFilePointerEx, 0 },
  37902. #else
  37903. { "SetFilePointerEx", (SYSCALL)0, 0 },
  37904. #endif
  37905. #define osSetFilePointerEx ((BOOL(WINAPI*)(HANDLE,LARGE_INTEGER, \
  37906. PLARGE_INTEGER,DWORD))aSyscall[65].pCurrent)
  37907. #if SQLITE_OS_WINRT
  37908. { "GetFileInformationByHandleEx", (SYSCALL)GetFileInformationByHandleEx, 0 },
  37909. #else
  37910. { "GetFileInformationByHandleEx", (SYSCALL)0, 0 },
  37911. #endif
  37912. #define osGetFileInformationByHandleEx ((BOOL(WINAPI*)(HANDLE, \
  37913. FILE_INFO_BY_HANDLE_CLASS,LPVOID,DWORD))aSyscall[66].pCurrent)
  37914. #if SQLITE_OS_WINRT && (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  37915. { "MapViewOfFileFromApp", (SYSCALL)MapViewOfFileFromApp, 0 },
  37916. #else
  37917. { "MapViewOfFileFromApp", (SYSCALL)0, 0 },
  37918. #endif
  37919. #define osMapViewOfFileFromApp ((LPVOID(WINAPI*)(HANDLE,ULONG,ULONG64, \
  37920. SIZE_T))aSyscall[67].pCurrent)
  37921. #if SQLITE_OS_WINRT
  37922. { "CreateFile2", (SYSCALL)CreateFile2, 0 },
  37923. #else
  37924. { "CreateFile2", (SYSCALL)0, 0 },
  37925. #endif
  37926. #define osCreateFile2 ((HANDLE(WINAPI*)(LPCWSTR,DWORD,DWORD,DWORD, \
  37927. LPCREATEFILE2_EXTENDED_PARAMETERS))aSyscall[68].pCurrent)
  37928. #if SQLITE_OS_WINRT && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  37929. { "LoadPackagedLibrary", (SYSCALL)LoadPackagedLibrary, 0 },
  37930. #else
  37931. { "LoadPackagedLibrary", (SYSCALL)0, 0 },
  37932. #endif
  37933. #define osLoadPackagedLibrary ((HMODULE(WINAPI*)(LPCWSTR, \
  37934. DWORD))aSyscall[69].pCurrent)
  37935. #if SQLITE_OS_WINRT
  37936. { "GetTickCount64", (SYSCALL)GetTickCount64, 0 },
  37937. #else
  37938. { "GetTickCount64", (SYSCALL)0, 0 },
  37939. #endif
  37940. #define osGetTickCount64 ((ULONGLONG(WINAPI*)(VOID))aSyscall[70].pCurrent)
  37941. #if SQLITE_OS_WINRT
  37942. { "GetNativeSystemInfo", (SYSCALL)GetNativeSystemInfo, 0 },
  37943. #else
  37944. { "GetNativeSystemInfo", (SYSCALL)0, 0 },
  37945. #endif
  37946. #define osGetNativeSystemInfo ((VOID(WINAPI*)( \
  37947. LPSYSTEM_INFO))aSyscall[71].pCurrent)
  37948. #if defined(SQLITE_WIN32_HAS_ANSI)
  37949. { "OutputDebugStringA", (SYSCALL)OutputDebugStringA, 0 },
  37950. #else
  37951. { "OutputDebugStringA", (SYSCALL)0, 0 },
  37952. #endif
  37953. #define osOutputDebugStringA ((VOID(WINAPI*)(LPCSTR))aSyscall[72].pCurrent)
  37954. #if defined(SQLITE_WIN32_HAS_WIDE)
  37955. { "OutputDebugStringW", (SYSCALL)OutputDebugStringW, 0 },
  37956. #else
  37957. { "OutputDebugStringW", (SYSCALL)0, 0 },
  37958. #endif
  37959. #define osOutputDebugStringW ((VOID(WINAPI*)(LPCWSTR))aSyscall[73].pCurrent)
  37960. { "GetProcessHeap", (SYSCALL)GetProcessHeap, 0 },
  37961. #define osGetProcessHeap ((HANDLE(WINAPI*)(VOID))aSyscall[74].pCurrent)
  37962. #if SQLITE_OS_WINRT && (!defined(SQLITE_OMIT_WAL) || SQLITE_MAX_MMAP_SIZE>0)
  37963. { "CreateFileMappingFromApp", (SYSCALL)CreateFileMappingFromApp, 0 },
  37964. #else
  37965. { "CreateFileMappingFromApp", (SYSCALL)0, 0 },
  37966. #endif
  37967. #define osCreateFileMappingFromApp ((HANDLE(WINAPI*)(HANDLE, \
  37968. LPSECURITY_ATTRIBUTES,ULONG,ULONG64,LPCWSTR))aSyscall[75].pCurrent)
  37969. /*
  37970. ** NOTE: On some sub-platforms, the InterlockedCompareExchange "function"
  37971. ** is really just a macro that uses a compiler intrinsic (e.g. x64).
  37972. ** So do not try to make this is into a redefinable interface.
  37973. */
  37974. #if defined(InterlockedCompareExchange)
  37975. { "InterlockedCompareExchange", (SYSCALL)0, 0 },
  37976. #define osInterlockedCompareExchange InterlockedCompareExchange
  37977. #else
  37978. { "InterlockedCompareExchange", (SYSCALL)InterlockedCompareExchange, 0 },
  37979. #define osInterlockedCompareExchange ((LONG(WINAPI*)(LONG \
  37980. SQLITE_WIN32_VOLATILE*, LONG,LONG))aSyscall[76].pCurrent)
  37981. #endif /* defined(InterlockedCompareExchange) */
  37982. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID
  37983. { "UuidCreate", (SYSCALL)UuidCreate, 0 },
  37984. #else
  37985. { "UuidCreate", (SYSCALL)0, 0 },
  37986. #endif
  37987. #define osUuidCreate ((RPC_STATUS(RPC_ENTRY*)(UUID*))aSyscall[77].pCurrent)
  37988. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID
  37989. { "UuidCreateSequential", (SYSCALL)UuidCreateSequential, 0 },
  37990. #else
  37991. { "UuidCreateSequential", (SYSCALL)0, 0 },
  37992. #endif
  37993. #define osUuidCreateSequential \
  37994. ((RPC_STATUS(RPC_ENTRY*)(UUID*))aSyscall[78].pCurrent)
  37995. #if !defined(SQLITE_NO_SYNC) && SQLITE_MAX_MMAP_SIZE>0
  37996. { "FlushViewOfFile", (SYSCALL)FlushViewOfFile, 0 },
  37997. #else
  37998. { "FlushViewOfFile", (SYSCALL)0, 0 },
  37999. #endif
  38000. #define osFlushViewOfFile \
  38001. ((BOOL(WINAPI*)(LPCVOID,SIZE_T))aSyscall[79].pCurrent)
  38002. }; /* End of the overrideable system calls */
  38003. /*
  38004. ** This is the xSetSystemCall() method of sqlite3_vfs for all of the
  38005. ** "win32" VFSes. Return SQLITE_OK opon successfully updating the
  38006. ** system call pointer, or SQLITE_NOTFOUND if there is no configurable
  38007. ** system call named zName.
  38008. */
  38009. static int winSetSystemCall(
  38010. sqlite3_vfs *pNotUsed, /* The VFS pointer. Not used */
  38011. const char *zName, /* Name of system call to override */
  38012. sqlite3_syscall_ptr pNewFunc /* Pointer to new system call value */
  38013. ){
  38014. unsigned int i;
  38015. int rc = SQLITE_NOTFOUND;
  38016. UNUSED_PARAMETER(pNotUsed);
  38017. if( zName==0 ){
  38018. /* If no zName is given, restore all system calls to their default
  38019. ** settings and return NULL
  38020. */
  38021. rc = SQLITE_OK;
  38022. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  38023. if( aSyscall[i].pDefault ){
  38024. aSyscall[i].pCurrent = aSyscall[i].pDefault;
  38025. }
  38026. }
  38027. }else{
  38028. /* If zName is specified, operate on only the one system call
  38029. ** specified.
  38030. */
  38031. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  38032. if( strcmp(zName, aSyscall[i].zName)==0 ){
  38033. if( aSyscall[i].pDefault==0 ){
  38034. aSyscall[i].pDefault = aSyscall[i].pCurrent;
  38035. }
  38036. rc = SQLITE_OK;
  38037. if( pNewFunc==0 ) pNewFunc = aSyscall[i].pDefault;
  38038. aSyscall[i].pCurrent = pNewFunc;
  38039. break;
  38040. }
  38041. }
  38042. }
  38043. return rc;
  38044. }
  38045. /*
  38046. ** Return the value of a system call. Return NULL if zName is not a
  38047. ** recognized system call name. NULL is also returned if the system call
  38048. ** is currently undefined.
  38049. */
  38050. static sqlite3_syscall_ptr winGetSystemCall(
  38051. sqlite3_vfs *pNotUsed,
  38052. const char *zName
  38053. ){
  38054. unsigned int i;
  38055. UNUSED_PARAMETER(pNotUsed);
  38056. for(i=0; i<sizeof(aSyscall)/sizeof(aSyscall[0]); i++){
  38057. if( strcmp(zName, aSyscall[i].zName)==0 ) return aSyscall[i].pCurrent;
  38058. }
  38059. return 0;
  38060. }
  38061. /*
  38062. ** Return the name of the first system call after zName. If zName==NULL
  38063. ** then return the name of the first system call. Return NULL if zName
  38064. ** is the last system call or if zName is not the name of a valid
  38065. ** system call.
  38066. */
  38067. static const char *winNextSystemCall(sqlite3_vfs *p, const char *zName){
  38068. int i = -1;
  38069. UNUSED_PARAMETER(p);
  38070. if( zName ){
  38071. for(i=0; i<ArraySize(aSyscall)-1; i++){
  38072. if( strcmp(zName, aSyscall[i].zName)==0 ) break;
  38073. }
  38074. }
  38075. for(i++; i<ArraySize(aSyscall); i++){
  38076. if( aSyscall[i].pCurrent!=0 ) return aSyscall[i].zName;
  38077. }
  38078. return 0;
  38079. }
  38080. #ifdef SQLITE_WIN32_MALLOC
  38081. /*
  38082. ** If a Win32 native heap has been configured, this function will attempt to
  38083. ** compact it. Upon success, SQLITE_OK will be returned. Upon failure, one
  38084. ** of SQLITE_NOMEM, SQLITE_ERROR, or SQLITE_NOTFOUND will be returned. The
  38085. ** "pnLargest" argument, if non-zero, will be used to return the size of the
  38086. ** largest committed free block in the heap, in bytes.
  38087. */
  38088. SQLITE_API int sqlite3_win32_compact_heap(LPUINT pnLargest){
  38089. int rc = SQLITE_OK;
  38090. UINT nLargest = 0;
  38091. HANDLE hHeap;
  38092. winMemAssertMagic();
  38093. hHeap = winMemGetHeap();
  38094. assert( hHeap!=0 );
  38095. assert( hHeap!=INVALID_HANDLE_VALUE );
  38096. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38097. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  38098. #endif
  38099. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT
  38100. if( (nLargest=osHeapCompact(hHeap, SQLITE_WIN32_HEAP_FLAGS))==0 ){
  38101. DWORD lastErrno = osGetLastError();
  38102. if( lastErrno==NO_ERROR ){
  38103. sqlite3_log(SQLITE_NOMEM, "failed to HeapCompact (no space), heap=%p",
  38104. (void*)hHeap);
  38105. rc = SQLITE_NOMEM_BKPT;
  38106. }else{
  38107. sqlite3_log(SQLITE_ERROR, "failed to HeapCompact (%lu), heap=%p",
  38108. osGetLastError(), (void*)hHeap);
  38109. rc = SQLITE_ERROR;
  38110. }
  38111. }
  38112. #else
  38113. sqlite3_log(SQLITE_NOTFOUND, "failed to HeapCompact, heap=%p",
  38114. (void*)hHeap);
  38115. rc = SQLITE_NOTFOUND;
  38116. #endif
  38117. if( pnLargest ) *pnLargest = nLargest;
  38118. return rc;
  38119. }
  38120. /*
  38121. ** If a Win32 native heap has been configured, this function will attempt to
  38122. ** destroy and recreate it. If the Win32 native heap is not isolated and/or
  38123. ** the sqlite3_memory_used() function does not return zero, SQLITE_BUSY will
  38124. ** be returned and no changes will be made to the Win32 native heap.
  38125. */
  38126. SQLITE_API int sqlite3_win32_reset_heap(){
  38127. int rc;
  38128. MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
  38129. MUTEX_LOGIC( sqlite3_mutex *pMem; ) /* The memsys static mutex */
  38130. MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  38131. MUTEX_LOGIC( pMem = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MEM); )
  38132. sqlite3_mutex_enter(pMaster);
  38133. sqlite3_mutex_enter(pMem);
  38134. winMemAssertMagic();
  38135. if( winMemGetHeap()!=NULL && winMemGetOwned() && sqlite3_memory_used()==0 ){
  38136. /*
  38137. ** At this point, there should be no outstanding memory allocations on
  38138. ** the heap. Also, since both the master and memsys locks are currently
  38139. ** being held by us, no other function (i.e. from another thread) should
  38140. ** be able to even access the heap. Attempt to destroy and recreate our
  38141. ** isolated Win32 native heap now.
  38142. */
  38143. assert( winMemGetHeap()!=NULL );
  38144. assert( winMemGetOwned() );
  38145. assert( sqlite3_memory_used()==0 );
  38146. winMemShutdown(winMemGetDataPtr());
  38147. assert( winMemGetHeap()==NULL );
  38148. assert( !winMemGetOwned() );
  38149. assert( sqlite3_memory_used()==0 );
  38150. rc = winMemInit(winMemGetDataPtr());
  38151. assert( rc!=SQLITE_OK || winMemGetHeap()!=NULL );
  38152. assert( rc!=SQLITE_OK || winMemGetOwned() );
  38153. assert( rc!=SQLITE_OK || sqlite3_memory_used()==0 );
  38154. }else{
  38155. /*
  38156. ** The Win32 native heap cannot be modified because it may be in use.
  38157. */
  38158. rc = SQLITE_BUSY;
  38159. }
  38160. sqlite3_mutex_leave(pMem);
  38161. sqlite3_mutex_leave(pMaster);
  38162. return rc;
  38163. }
  38164. #endif /* SQLITE_WIN32_MALLOC */
  38165. /*
  38166. ** This function outputs the specified (ANSI) string to the Win32 debugger
  38167. ** (if available).
  38168. */
  38169. SQLITE_API void sqlite3_win32_write_debug(const char *zBuf, int nBuf){
  38170. char zDbgBuf[SQLITE_WIN32_DBG_BUF_SIZE];
  38171. int nMin = MIN(nBuf, (SQLITE_WIN32_DBG_BUF_SIZE - 1)); /* may be negative. */
  38172. if( nMin<-1 ) nMin = -1; /* all negative values become -1. */
  38173. assert( nMin==-1 || nMin==0 || nMin<SQLITE_WIN32_DBG_BUF_SIZE );
  38174. #ifdef SQLITE_ENABLE_API_ARMOR
  38175. if( !zBuf ){
  38176. (void)SQLITE_MISUSE_BKPT;
  38177. return;
  38178. }
  38179. #endif
  38180. #if defined(SQLITE_WIN32_HAS_ANSI)
  38181. if( nMin>0 ){
  38182. memset(zDbgBuf, 0, SQLITE_WIN32_DBG_BUF_SIZE);
  38183. memcpy(zDbgBuf, zBuf, nMin);
  38184. osOutputDebugStringA(zDbgBuf);
  38185. }else{
  38186. osOutputDebugStringA(zBuf);
  38187. }
  38188. #elif defined(SQLITE_WIN32_HAS_WIDE)
  38189. memset(zDbgBuf, 0, SQLITE_WIN32_DBG_BUF_SIZE);
  38190. if ( osMultiByteToWideChar(
  38191. osAreFileApisANSI() ? CP_ACP : CP_OEMCP, 0, zBuf,
  38192. nMin, (LPWSTR)zDbgBuf, SQLITE_WIN32_DBG_BUF_SIZE/sizeof(WCHAR))<=0 ){
  38193. return;
  38194. }
  38195. osOutputDebugStringW((LPCWSTR)zDbgBuf);
  38196. #else
  38197. if( nMin>0 ){
  38198. memset(zDbgBuf, 0, SQLITE_WIN32_DBG_BUF_SIZE);
  38199. memcpy(zDbgBuf, zBuf, nMin);
  38200. fprintf(stderr, "%s", zDbgBuf);
  38201. }else{
  38202. fprintf(stderr, "%s", zBuf);
  38203. }
  38204. #endif
  38205. }
  38206. /*
  38207. ** The following routine suspends the current thread for at least ms
  38208. ** milliseconds. This is equivalent to the Win32 Sleep() interface.
  38209. */
  38210. #if SQLITE_OS_WINRT
  38211. static HANDLE sleepObj = NULL;
  38212. #endif
  38213. SQLITE_API void sqlite3_win32_sleep(DWORD milliseconds){
  38214. #if SQLITE_OS_WINRT
  38215. if ( sleepObj==NULL ){
  38216. sleepObj = osCreateEventExW(NULL, NULL, CREATE_EVENT_MANUAL_RESET,
  38217. SYNCHRONIZE);
  38218. }
  38219. assert( sleepObj!=NULL );
  38220. osWaitForSingleObjectEx(sleepObj, milliseconds, FALSE);
  38221. #else
  38222. osSleep(milliseconds);
  38223. #endif
  38224. }
  38225. #if SQLITE_MAX_WORKER_THREADS>0 && !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && \
  38226. SQLITE_THREADSAFE>0
  38227. SQLITE_PRIVATE DWORD sqlite3Win32Wait(HANDLE hObject){
  38228. DWORD rc;
  38229. while( (rc = osWaitForSingleObjectEx(hObject, INFINITE,
  38230. TRUE))==WAIT_IO_COMPLETION ){}
  38231. return rc;
  38232. }
  38233. #endif
  38234. /*
  38235. ** Return true (non-zero) if we are running under WinNT, Win2K, WinXP,
  38236. ** or WinCE. Return false (zero) for Win95, Win98, or WinME.
  38237. **
  38238. ** Here is an interesting observation: Win95, Win98, and WinME lack
  38239. ** the LockFileEx() API. But we can still statically link against that
  38240. ** API as long as we don't call it when running Win95/98/ME. A call to
  38241. ** this routine is used to determine if the host is Win95/98/ME or
  38242. ** WinNT/2K/XP so that we will know whether or not we can safely call
  38243. ** the LockFileEx() API.
  38244. */
  38245. #if !SQLITE_WIN32_GETVERSIONEX
  38246. # define osIsNT() (1)
  38247. #elif SQLITE_OS_WINCE || SQLITE_OS_WINRT || !defined(SQLITE_WIN32_HAS_ANSI)
  38248. # define osIsNT() (1)
  38249. #elif !defined(SQLITE_WIN32_HAS_WIDE)
  38250. # define osIsNT() (0)
  38251. #else
  38252. # define osIsNT() ((sqlite3_os_type==2) || sqlite3_win32_is_nt())
  38253. #endif
  38254. /*
  38255. ** This function determines if the machine is running a version of Windows
  38256. ** based on the NT kernel.
  38257. */
  38258. SQLITE_API int sqlite3_win32_is_nt(void){
  38259. #if SQLITE_OS_WINRT
  38260. /*
  38261. ** NOTE: The WinRT sub-platform is always assumed to be based on the NT
  38262. ** kernel.
  38263. */
  38264. return 1;
  38265. #elif SQLITE_WIN32_GETVERSIONEX
  38266. if( osInterlockedCompareExchange(&sqlite3_os_type, 0, 0)==0 ){
  38267. #if defined(SQLITE_WIN32_HAS_ANSI)
  38268. OSVERSIONINFOA sInfo;
  38269. sInfo.dwOSVersionInfoSize = sizeof(sInfo);
  38270. osGetVersionExA(&sInfo);
  38271. osInterlockedCompareExchange(&sqlite3_os_type,
  38272. (sInfo.dwPlatformId == VER_PLATFORM_WIN32_NT) ? 2 : 1, 0);
  38273. #elif defined(SQLITE_WIN32_HAS_WIDE)
  38274. OSVERSIONINFOW sInfo;
  38275. sInfo.dwOSVersionInfoSize = sizeof(sInfo);
  38276. osGetVersionExW(&sInfo);
  38277. osInterlockedCompareExchange(&sqlite3_os_type,
  38278. (sInfo.dwPlatformId == VER_PLATFORM_WIN32_NT) ? 2 : 1, 0);
  38279. #endif
  38280. }
  38281. return osInterlockedCompareExchange(&sqlite3_os_type, 2, 2)==2;
  38282. #elif SQLITE_TEST
  38283. return osInterlockedCompareExchange(&sqlite3_os_type, 2, 2)==2;
  38284. #else
  38285. /*
  38286. ** NOTE: All sub-platforms where the GetVersionEx[AW] functions are
  38287. ** deprecated are always assumed to be based on the NT kernel.
  38288. */
  38289. return 1;
  38290. #endif
  38291. }
  38292. #ifdef SQLITE_WIN32_MALLOC
  38293. /*
  38294. ** Allocate nBytes of memory.
  38295. */
  38296. static void *winMemMalloc(int nBytes){
  38297. HANDLE hHeap;
  38298. void *p;
  38299. winMemAssertMagic();
  38300. hHeap = winMemGetHeap();
  38301. assert( hHeap!=0 );
  38302. assert( hHeap!=INVALID_HANDLE_VALUE );
  38303. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38304. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  38305. #endif
  38306. assert( nBytes>=0 );
  38307. p = osHeapAlloc(hHeap, SQLITE_WIN32_HEAP_FLAGS, (SIZE_T)nBytes);
  38308. if( !p ){
  38309. sqlite3_log(SQLITE_NOMEM, "failed to HeapAlloc %u bytes (%lu), heap=%p",
  38310. nBytes, osGetLastError(), (void*)hHeap);
  38311. }
  38312. return p;
  38313. }
  38314. /*
  38315. ** Free memory.
  38316. */
  38317. static void winMemFree(void *pPrior){
  38318. HANDLE hHeap;
  38319. winMemAssertMagic();
  38320. hHeap = winMemGetHeap();
  38321. assert( hHeap!=0 );
  38322. assert( hHeap!=INVALID_HANDLE_VALUE );
  38323. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38324. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior) );
  38325. #endif
  38326. if( !pPrior ) return; /* Passing NULL to HeapFree is undefined. */
  38327. if( !osHeapFree(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior) ){
  38328. sqlite3_log(SQLITE_NOMEM, "failed to HeapFree block %p (%lu), heap=%p",
  38329. pPrior, osGetLastError(), (void*)hHeap);
  38330. }
  38331. }
  38332. /*
  38333. ** Change the size of an existing memory allocation
  38334. */
  38335. static void *winMemRealloc(void *pPrior, int nBytes){
  38336. HANDLE hHeap;
  38337. void *p;
  38338. winMemAssertMagic();
  38339. hHeap = winMemGetHeap();
  38340. assert( hHeap!=0 );
  38341. assert( hHeap!=INVALID_HANDLE_VALUE );
  38342. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38343. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior) );
  38344. #endif
  38345. assert( nBytes>=0 );
  38346. if( !pPrior ){
  38347. p = osHeapAlloc(hHeap, SQLITE_WIN32_HEAP_FLAGS, (SIZE_T)nBytes);
  38348. }else{
  38349. p = osHeapReAlloc(hHeap, SQLITE_WIN32_HEAP_FLAGS, pPrior, (SIZE_T)nBytes);
  38350. }
  38351. if( !p ){
  38352. sqlite3_log(SQLITE_NOMEM, "failed to %s %u bytes (%lu), heap=%p",
  38353. pPrior ? "HeapReAlloc" : "HeapAlloc", nBytes, osGetLastError(),
  38354. (void*)hHeap);
  38355. }
  38356. return p;
  38357. }
  38358. /*
  38359. ** Return the size of an outstanding allocation, in bytes.
  38360. */
  38361. static int winMemSize(void *p){
  38362. HANDLE hHeap;
  38363. SIZE_T n;
  38364. winMemAssertMagic();
  38365. hHeap = winMemGetHeap();
  38366. assert( hHeap!=0 );
  38367. assert( hHeap!=INVALID_HANDLE_VALUE );
  38368. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38369. assert( osHeapValidate(hHeap, SQLITE_WIN32_HEAP_FLAGS, p) );
  38370. #endif
  38371. if( !p ) return 0;
  38372. n = osHeapSize(hHeap, SQLITE_WIN32_HEAP_FLAGS, p);
  38373. if( n==(SIZE_T)-1 ){
  38374. sqlite3_log(SQLITE_NOMEM, "failed to HeapSize block %p (%lu), heap=%p",
  38375. p, osGetLastError(), (void*)hHeap);
  38376. return 0;
  38377. }
  38378. return (int)n;
  38379. }
  38380. /*
  38381. ** Round up a request size to the next valid allocation size.
  38382. */
  38383. static int winMemRoundup(int n){
  38384. return n;
  38385. }
  38386. /*
  38387. ** Initialize this module.
  38388. */
  38389. static int winMemInit(void *pAppData){
  38390. winMemData *pWinMemData = (winMemData *)pAppData;
  38391. if( !pWinMemData ) return SQLITE_ERROR;
  38392. assert( pWinMemData->magic1==WINMEM_MAGIC1 );
  38393. assert( pWinMemData->magic2==WINMEM_MAGIC2 );
  38394. #if !SQLITE_OS_WINRT && SQLITE_WIN32_HEAP_CREATE
  38395. if( !pWinMemData->hHeap ){
  38396. DWORD dwInitialSize = SQLITE_WIN32_HEAP_INIT_SIZE;
  38397. DWORD dwMaximumSize = (DWORD)sqlite3GlobalConfig.nHeap;
  38398. if( dwMaximumSize==0 ){
  38399. dwMaximumSize = SQLITE_WIN32_HEAP_MAX_SIZE;
  38400. }else if( dwInitialSize>dwMaximumSize ){
  38401. dwInitialSize = dwMaximumSize;
  38402. }
  38403. pWinMemData->hHeap = osHeapCreate(SQLITE_WIN32_HEAP_FLAGS,
  38404. dwInitialSize, dwMaximumSize);
  38405. if( !pWinMemData->hHeap ){
  38406. sqlite3_log(SQLITE_NOMEM,
  38407. "failed to HeapCreate (%lu), flags=%u, initSize=%lu, maxSize=%lu",
  38408. osGetLastError(), SQLITE_WIN32_HEAP_FLAGS, dwInitialSize,
  38409. dwMaximumSize);
  38410. return SQLITE_NOMEM_BKPT;
  38411. }
  38412. pWinMemData->bOwned = TRUE;
  38413. assert( pWinMemData->bOwned );
  38414. }
  38415. #else
  38416. pWinMemData->hHeap = osGetProcessHeap();
  38417. if( !pWinMemData->hHeap ){
  38418. sqlite3_log(SQLITE_NOMEM,
  38419. "failed to GetProcessHeap (%lu)", osGetLastError());
  38420. return SQLITE_NOMEM_BKPT;
  38421. }
  38422. pWinMemData->bOwned = FALSE;
  38423. assert( !pWinMemData->bOwned );
  38424. #endif
  38425. assert( pWinMemData->hHeap!=0 );
  38426. assert( pWinMemData->hHeap!=INVALID_HANDLE_VALUE );
  38427. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38428. assert( osHeapValidate(pWinMemData->hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  38429. #endif
  38430. return SQLITE_OK;
  38431. }
  38432. /*
  38433. ** Deinitialize this module.
  38434. */
  38435. static void winMemShutdown(void *pAppData){
  38436. winMemData *pWinMemData = (winMemData *)pAppData;
  38437. if( !pWinMemData ) return;
  38438. assert( pWinMemData->magic1==WINMEM_MAGIC1 );
  38439. assert( pWinMemData->magic2==WINMEM_MAGIC2 );
  38440. if( pWinMemData->hHeap ){
  38441. assert( pWinMemData->hHeap!=INVALID_HANDLE_VALUE );
  38442. #if !SQLITE_OS_WINRT && defined(SQLITE_WIN32_MALLOC_VALIDATE)
  38443. assert( osHeapValidate(pWinMemData->hHeap, SQLITE_WIN32_HEAP_FLAGS, NULL) );
  38444. #endif
  38445. if( pWinMemData->bOwned ){
  38446. if( !osHeapDestroy(pWinMemData->hHeap) ){
  38447. sqlite3_log(SQLITE_NOMEM, "failed to HeapDestroy (%lu), heap=%p",
  38448. osGetLastError(), (void*)pWinMemData->hHeap);
  38449. }
  38450. pWinMemData->bOwned = FALSE;
  38451. }
  38452. pWinMemData->hHeap = NULL;
  38453. }
  38454. }
  38455. /*
  38456. ** Populate the low-level memory allocation function pointers in
  38457. ** sqlite3GlobalConfig.m with pointers to the routines in this file. The
  38458. ** arguments specify the block of memory to manage.
  38459. **
  38460. ** This routine is only called by sqlite3_config(), and therefore
  38461. ** is not required to be threadsafe (it is not).
  38462. */
  38463. SQLITE_PRIVATE const sqlite3_mem_methods *sqlite3MemGetWin32(void){
  38464. static const sqlite3_mem_methods winMemMethods = {
  38465. winMemMalloc,
  38466. winMemFree,
  38467. winMemRealloc,
  38468. winMemSize,
  38469. winMemRoundup,
  38470. winMemInit,
  38471. winMemShutdown,
  38472. &win_mem_data
  38473. };
  38474. return &winMemMethods;
  38475. }
  38476. SQLITE_PRIVATE void sqlite3MemSetDefault(void){
  38477. sqlite3_config(SQLITE_CONFIG_MALLOC, sqlite3MemGetWin32());
  38478. }
  38479. #endif /* SQLITE_WIN32_MALLOC */
  38480. /*
  38481. ** Convert a UTF-8 string to Microsoft Unicode.
  38482. **
  38483. ** Space to hold the returned string is obtained from sqlite3_malloc().
  38484. */
  38485. static LPWSTR winUtf8ToUnicode(const char *zText){
  38486. int nChar;
  38487. LPWSTR zWideText;
  38488. nChar = osMultiByteToWideChar(CP_UTF8, 0, zText, -1, NULL, 0);
  38489. if( nChar==0 ){
  38490. return 0;
  38491. }
  38492. zWideText = sqlite3MallocZero( nChar*sizeof(WCHAR) );
  38493. if( zWideText==0 ){
  38494. return 0;
  38495. }
  38496. nChar = osMultiByteToWideChar(CP_UTF8, 0, zText, -1, zWideText,
  38497. nChar);
  38498. if( nChar==0 ){
  38499. sqlite3_free(zWideText);
  38500. zWideText = 0;
  38501. }
  38502. return zWideText;
  38503. }
  38504. /*
  38505. ** Convert a Microsoft Unicode string to UTF-8.
  38506. **
  38507. ** Space to hold the returned string is obtained from sqlite3_malloc().
  38508. */
  38509. static char *winUnicodeToUtf8(LPCWSTR zWideText){
  38510. int nByte;
  38511. char *zText;
  38512. nByte = osWideCharToMultiByte(CP_UTF8, 0, zWideText, -1, 0, 0, 0, 0);
  38513. if( nByte == 0 ){
  38514. return 0;
  38515. }
  38516. zText = sqlite3MallocZero( nByte );
  38517. if( zText==0 ){
  38518. return 0;
  38519. }
  38520. nByte = osWideCharToMultiByte(CP_UTF8, 0, zWideText, -1, zText, nByte,
  38521. 0, 0);
  38522. if( nByte == 0 ){
  38523. sqlite3_free(zText);
  38524. zText = 0;
  38525. }
  38526. return zText;
  38527. }
  38528. /*
  38529. ** Convert an ANSI string to Microsoft Unicode, using the ANSI or OEM
  38530. ** code page.
  38531. **
  38532. ** Space to hold the returned string is obtained from sqlite3_malloc().
  38533. */
  38534. static LPWSTR winMbcsToUnicode(const char *zText, int useAnsi){
  38535. int nByte;
  38536. LPWSTR zMbcsText;
  38537. int codepage = useAnsi ? CP_ACP : CP_OEMCP;
  38538. nByte = osMultiByteToWideChar(codepage, 0, zText, -1, NULL,
  38539. 0)*sizeof(WCHAR);
  38540. if( nByte==0 ){
  38541. return 0;
  38542. }
  38543. zMbcsText = sqlite3MallocZero( nByte*sizeof(WCHAR) );
  38544. if( zMbcsText==0 ){
  38545. return 0;
  38546. }
  38547. nByte = osMultiByteToWideChar(codepage, 0, zText, -1, zMbcsText,
  38548. nByte);
  38549. if( nByte==0 ){
  38550. sqlite3_free(zMbcsText);
  38551. zMbcsText = 0;
  38552. }
  38553. return zMbcsText;
  38554. }
  38555. /*
  38556. ** Convert a Microsoft Unicode string to a multi-byte character string,
  38557. ** using the ANSI or OEM code page.
  38558. **
  38559. ** Space to hold the returned string is obtained from sqlite3_malloc().
  38560. */
  38561. static char *winUnicodeToMbcs(LPCWSTR zWideText, int useAnsi){
  38562. int nByte;
  38563. char *zText;
  38564. int codepage = useAnsi ? CP_ACP : CP_OEMCP;
  38565. nByte = osWideCharToMultiByte(codepage, 0, zWideText, -1, 0, 0, 0, 0);
  38566. if( nByte == 0 ){
  38567. return 0;
  38568. }
  38569. zText = sqlite3MallocZero( nByte );
  38570. if( zText==0 ){
  38571. return 0;
  38572. }
  38573. nByte = osWideCharToMultiByte(codepage, 0, zWideText, -1, zText,
  38574. nByte, 0, 0);
  38575. if( nByte == 0 ){
  38576. sqlite3_free(zText);
  38577. zText = 0;
  38578. }
  38579. return zText;
  38580. }
  38581. /*
  38582. ** Convert a multi-byte character string to UTF-8.
  38583. **
  38584. ** Space to hold the returned string is obtained from sqlite3_malloc().
  38585. */
  38586. static char *winMbcsToUtf8(const char *zText, int useAnsi){
  38587. char *zTextUtf8;
  38588. LPWSTR zTmpWide;
  38589. zTmpWide = winMbcsToUnicode(zText, useAnsi);
  38590. if( zTmpWide==0 ){
  38591. return 0;
  38592. }
  38593. zTextUtf8 = winUnicodeToUtf8(zTmpWide);
  38594. sqlite3_free(zTmpWide);
  38595. return zTextUtf8;
  38596. }
  38597. /*
  38598. ** Convert a UTF-8 string to a multi-byte character string.
  38599. **
  38600. ** Space to hold the returned string is obtained from sqlite3_malloc().
  38601. */
  38602. static char *winUtf8ToMbcs(const char *zText, int useAnsi){
  38603. char *zTextMbcs;
  38604. LPWSTR zTmpWide;
  38605. zTmpWide = winUtf8ToUnicode(zText);
  38606. if( zTmpWide==0 ){
  38607. return 0;
  38608. }
  38609. zTextMbcs = winUnicodeToMbcs(zTmpWide, useAnsi);
  38610. sqlite3_free(zTmpWide);
  38611. return zTextMbcs;
  38612. }
  38613. /*
  38614. ** This is a public wrapper for the winUtf8ToUnicode() function.
  38615. */
  38616. SQLITE_API LPWSTR sqlite3_win32_utf8_to_unicode(const char *zText){
  38617. #ifdef SQLITE_ENABLE_API_ARMOR
  38618. if( !zText ){
  38619. (void)SQLITE_MISUSE_BKPT;
  38620. return 0;
  38621. }
  38622. #endif
  38623. #ifndef SQLITE_OMIT_AUTOINIT
  38624. if( sqlite3_initialize() ) return 0;
  38625. #endif
  38626. return winUtf8ToUnicode(zText);
  38627. }
  38628. /*
  38629. ** This is a public wrapper for the winUnicodeToUtf8() function.
  38630. */
  38631. SQLITE_API char *sqlite3_win32_unicode_to_utf8(LPCWSTR zWideText){
  38632. #ifdef SQLITE_ENABLE_API_ARMOR
  38633. if( !zWideText ){
  38634. (void)SQLITE_MISUSE_BKPT;
  38635. return 0;
  38636. }
  38637. #endif
  38638. #ifndef SQLITE_OMIT_AUTOINIT
  38639. if( sqlite3_initialize() ) return 0;
  38640. #endif
  38641. return winUnicodeToUtf8(zWideText);
  38642. }
  38643. /*
  38644. ** This is a public wrapper for the winMbcsToUtf8() function.
  38645. */
  38646. SQLITE_API char *sqlite3_win32_mbcs_to_utf8(const char *zText){
  38647. #ifdef SQLITE_ENABLE_API_ARMOR
  38648. if( !zText ){
  38649. (void)SQLITE_MISUSE_BKPT;
  38650. return 0;
  38651. }
  38652. #endif
  38653. #ifndef SQLITE_OMIT_AUTOINIT
  38654. if( sqlite3_initialize() ) return 0;
  38655. #endif
  38656. return winMbcsToUtf8(zText, osAreFileApisANSI());
  38657. }
  38658. /*
  38659. ** This is a public wrapper for the winMbcsToUtf8() function.
  38660. */
  38661. SQLITE_API char *sqlite3_win32_mbcs_to_utf8_v2(const char *zText, int useAnsi){
  38662. #ifdef SQLITE_ENABLE_API_ARMOR
  38663. if( !zText ){
  38664. (void)SQLITE_MISUSE_BKPT;
  38665. return 0;
  38666. }
  38667. #endif
  38668. #ifndef SQLITE_OMIT_AUTOINIT
  38669. if( sqlite3_initialize() ) return 0;
  38670. #endif
  38671. return winMbcsToUtf8(zText, useAnsi);
  38672. }
  38673. /*
  38674. ** This is a public wrapper for the winUtf8ToMbcs() function.
  38675. */
  38676. SQLITE_API char *sqlite3_win32_utf8_to_mbcs(const char *zText){
  38677. #ifdef SQLITE_ENABLE_API_ARMOR
  38678. if( !zText ){
  38679. (void)SQLITE_MISUSE_BKPT;
  38680. return 0;
  38681. }
  38682. #endif
  38683. #ifndef SQLITE_OMIT_AUTOINIT
  38684. if( sqlite3_initialize() ) return 0;
  38685. #endif
  38686. return winUtf8ToMbcs(zText, osAreFileApisANSI());
  38687. }
  38688. /*
  38689. ** This is a public wrapper for the winUtf8ToMbcs() function.
  38690. */
  38691. SQLITE_API char *sqlite3_win32_utf8_to_mbcs_v2(const char *zText, int useAnsi){
  38692. #ifdef SQLITE_ENABLE_API_ARMOR
  38693. if( !zText ){
  38694. (void)SQLITE_MISUSE_BKPT;
  38695. return 0;
  38696. }
  38697. #endif
  38698. #ifndef SQLITE_OMIT_AUTOINIT
  38699. if( sqlite3_initialize() ) return 0;
  38700. #endif
  38701. return winUtf8ToMbcs(zText, useAnsi);
  38702. }
  38703. /*
  38704. ** This function sets the data directory or the temporary directory based on
  38705. ** the provided arguments. The type argument must be 1 in order to set the
  38706. ** data directory or 2 in order to set the temporary directory. The zValue
  38707. ** argument is the name of the directory to use. The return value will be
  38708. ** SQLITE_OK if successful.
  38709. */
  38710. SQLITE_API int sqlite3_win32_set_directory(DWORD type, LPCWSTR zValue){
  38711. char **ppDirectory = 0;
  38712. #ifndef SQLITE_OMIT_AUTOINIT
  38713. int rc = sqlite3_initialize();
  38714. if( rc ) return rc;
  38715. #endif
  38716. if( type==SQLITE_WIN32_DATA_DIRECTORY_TYPE ){
  38717. ppDirectory = &sqlite3_data_directory;
  38718. }else if( type==SQLITE_WIN32_TEMP_DIRECTORY_TYPE ){
  38719. ppDirectory = &sqlite3_temp_directory;
  38720. }
  38721. assert( !ppDirectory || type==SQLITE_WIN32_DATA_DIRECTORY_TYPE
  38722. || type==SQLITE_WIN32_TEMP_DIRECTORY_TYPE
  38723. );
  38724. assert( !ppDirectory || sqlite3MemdebugHasType(*ppDirectory, MEMTYPE_HEAP) );
  38725. if( ppDirectory ){
  38726. char *zValueUtf8 = 0;
  38727. if( zValue && zValue[0] ){
  38728. zValueUtf8 = winUnicodeToUtf8(zValue);
  38729. if ( zValueUtf8==0 ){
  38730. return SQLITE_NOMEM_BKPT;
  38731. }
  38732. }
  38733. sqlite3_free(*ppDirectory);
  38734. *ppDirectory = zValueUtf8;
  38735. return SQLITE_OK;
  38736. }
  38737. return SQLITE_ERROR;
  38738. }
  38739. /*
  38740. ** The return value of winGetLastErrorMsg
  38741. ** is zero if the error message fits in the buffer, or non-zero
  38742. ** otherwise (if the message was truncated).
  38743. */
  38744. static int winGetLastErrorMsg(DWORD lastErrno, int nBuf, char *zBuf){
  38745. /* FormatMessage returns 0 on failure. Otherwise it
  38746. ** returns the number of TCHARs written to the output
  38747. ** buffer, excluding the terminating null char.
  38748. */
  38749. DWORD dwLen = 0;
  38750. char *zOut = 0;
  38751. if( osIsNT() ){
  38752. #if SQLITE_OS_WINRT
  38753. WCHAR zTempWide[SQLITE_WIN32_MAX_ERRMSG_CHARS+1];
  38754. dwLen = osFormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM |
  38755. FORMAT_MESSAGE_IGNORE_INSERTS,
  38756. NULL,
  38757. lastErrno,
  38758. 0,
  38759. zTempWide,
  38760. SQLITE_WIN32_MAX_ERRMSG_CHARS,
  38761. 0);
  38762. #else
  38763. LPWSTR zTempWide = NULL;
  38764. dwLen = osFormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER |
  38765. FORMAT_MESSAGE_FROM_SYSTEM |
  38766. FORMAT_MESSAGE_IGNORE_INSERTS,
  38767. NULL,
  38768. lastErrno,
  38769. 0,
  38770. (LPWSTR) &zTempWide,
  38771. 0,
  38772. 0);
  38773. #endif
  38774. if( dwLen > 0 ){
  38775. /* allocate a buffer and convert to UTF8 */
  38776. sqlite3BeginBenignMalloc();
  38777. zOut = winUnicodeToUtf8(zTempWide);
  38778. sqlite3EndBenignMalloc();
  38779. #if !SQLITE_OS_WINRT
  38780. /* free the system buffer allocated by FormatMessage */
  38781. osLocalFree(zTempWide);
  38782. #endif
  38783. }
  38784. }
  38785. #ifdef SQLITE_WIN32_HAS_ANSI
  38786. else{
  38787. char *zTemp = NULL;
  38788. dwLen = osFormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER |
  38789. FORMAT_MESSAGE_FROM_SYSTEM |
  38790. FORMAT_MESSAGE_IGNORE_INSERTS,
  38791. NULL,
  38792. lastErrno,
  38793. 0,
  38794. (LPSTR) &zTemp,
  38795. 0,
  38796. 0);
  38797. if( dwLen > 0 ){
  38798. /* allocate a buffer and convert to UTF8 */
  38799. sqlite3BeginBenignMalloc();
  38800. zOut = winMbcsToUtf8(zTemp, osAreFileApisANSI());
  38801. sqlite3EndBenignMalloc();
  38802. /* free the system buffer allocated by FormatMessage */
  38803. osLocalFree(zTemp);
  38804. }
  38805. }
  38806. #endif
  38807. if( 0 == dwLen ){
  38808. sqlite3_snprintf(nBuf, zBuf, "OsError 0x%lx (%lu)", lastErrno, lastErrno);
  38809. }else{
  38810. /* copy a maximum of nBuf chars to output buffer */
  38811. sqlite3_snprintf(nBuf, zBuf, "%s", zOut);
  38812. /* free the UTF8 buffer */
  38813. sqlite3_free(zOut);
  38814. }
  38815. return 0;
  38816. }
  38817. /*
  38818. **
  38819. ** This function - winLogErrorAtLine() - is only ever called via the macro
  38820. ** winLogError().
  38821. **
  38822. ** This routine is invoked after an error occurs in an OS function.
  38823. ** It logs a message using sqlite3_log() containing the current value of
  38824. ** error code and, if possible, the human-readable equivalent from
  38825. ** FormatMessage.
  38826. **
  38827. ** The first argument passed to the macro should be the error code that
  38828. ** will be returned to SQLite (e.g. SQLITE_IOERR_DELETE, SQLITE_CANTOPEN).
  38829. ** The two subsequent arguments should be the name of the OS function that
  38830. ** failed and the associated file-system path, if any.
  38831. */
  38832. #define winLogError(a,b,c,d) winLogErrorAtLine(a,b,c,d,__LINE__)
  38833. static int winLogErrorAtLine(
  38834. int errcode, /* SQLite error code */
  38835. DWORD lastErrno, /* Win32 last error */
  38836. const char *zFunc, /* Name of OS function that failed */
  38837. const char *zPath, /* File path associated with error */
  38838. int iLine /* Source line number where error occurred */
  38839. ){
  38840. char zMsg[500]; /* Human readable error text */
  38841. int i; /* Loop counter */
  38842. zMsg[0] = 0;
  38843. winGetLastErrorMsg(lastErrno, sizeof(zMsg), zMsg);
  38844. assert( errcode!=SQLITE_OK );
  38845. if( zPath==0 ) zPath = "";
  38846. for(i=0; zMsg[i] && zMsg[i]!='\r' && zMsg[i]!='\n'; i++){}
  38847. zMsg[i] = 0;
  38848. sqlite3_log(errcode,
  38849. "os_win.c:%d: (%lu) %s(%s) - %s",
  38850. iLine, lastErrno, zFunc, zPath, zMsg
  38851. );
  38852. return errcode;
  38853. }
  38854. /*
  38855. ** The number of times that a ReadFile(), WriteFile(), and DeleteFile()
  38856. ** will be retried following a locking error - probably caused by
  38857. ** antivirus software. Also the initial delay before the first retry.
  38858. ** The delay increases linearly with each retry.
  38859. */
  38860. #ifndef SQLITE_WIN32_IOERR_RETRY
  38861. # define SQLITE_WIN32_IOERR_RETRY 10
  38862. #endif
  38863. #ifndef SQLITE_WIN32_IOERR_RETRY_DELAY
  38864. # define SQLITE_WIN32_IOERR_RETRY_DELAY 25
  38865. #endif
  38866. static int winIoerrRetry = SQLITE_WIN32_IOERR_RETRY;
  38867. static int winIoerrRetryDelay = SQLITE_WIN32_IOERR_RETRY_DELAY;
  38868. /*
  38869. ** The "winIoerrCanRetry1" macro is used to determine if a particular I/O
  38870. ** error code obtained via GetLastError() is eligible to be retried. It
  38871. ** must accept the error code DWORD as its only argument and should return
  38872. ** non-zero if the error code is transient in nature and the operation
  38873. ** responsible for generating the original error might succeed upon being
  38874. ** retried. The argument to this macro should be a variable.
  38875. **
  38876. ** Additionally, a macro named "winIoerrCanRetry2" may be defined. If it
  38877. ** is defined, it will be consulted only when the macro "winIoerrCanRetry1"
  38878. ** returns zero. The "winIoerrCanRetry2" macro is completely optional and
  38879. ** may be used to include additional error codes in the set that should
  38880. ** result in the failing I/O operation being retried by the caller. If
  38881. ** defined, the "winIoerrCanRetry2" macro must exhibit external semantics
  38882. ** identical to those of the "winIoerrCanRetry1" macro.
  38883. */
  38884. #if !defined(winIoerrCanRetry1)
  38885. #define winIoerrCanRetry1(a) (((a)==ERROR_ACCESS_DENIED) || \
  38886. ((a)==ERROR_SHARING_VIOLATION) || \
  38887. ((a)==ERROR_LOCK_VIOLATION) || \
  38888. ((a)==ERROR_DEV_NOT_EXIST) || \
  38889. ((a)==ERROR_NETNAME_DELETED) || \
  38890. ((a)==ERROR_SEM_TIMEOUT) || \
  38891. ((a)==ERROR_NETWORK_UNREACHABLE))
  38892. #endif
  38893. /*
  38894. ** If a ReadFile() or WriteFile() error occurs, invoke this routine
  38895. ** to see if it should be retried. Return TRUE to retry. Return FALSE
  38896. ** to give up with an error.
  38897. */
  38898. static int winRetryIoerr(int *pnRetry, DWORD *pError){
  38899. DWORD e = osGetLastError();
  38900. if( *pnRetry>=winIoerrRetry ){
  38901. if( pError ){
  38902. *pError = e;
  38903. }
  38904. return 0;
  38905. }
  38906. if( winIoerrCanRetry1(e) ){
  38907. sqlite3_win32_sleep(winIoerrRetryDelay*(1+*pnRetry));
  38908. ++*pnRetry;
  38909. return 1;
  38910. }
  38911. #if defined(winIoerrCanRetry2)
  38912. else if( winIoerrCanRetry2(e) ){
  38913. sqlite3_win32_sleep(winIoerrRetryDelay*(1+*pnRetry));
  38914. ++*pnRetry;
  38915. return 1;
  38916. }
  38917. #endif
  38918. if( pError ){
  38919. *pError = e;
  38920. }
  38921. return 0;
  38922. }
  38923. /*
  38924. ** Log a I/O error retry episode.
  38925. */
  38926. static void winLogIoerr(int nRetry, int lineno){
  38927. if( nRetry ){
  38928. sqlite3_log(SQLITE_NOTICE,
  38929. "delayed %dms for lock/sharing conflict at line %d",
  38930. winIoerrRetryDelay*nRetry*(nRetry+1)/2, lineno
  38931. );
  38932. }
  38933. }
  38934. /*
  38935. ** This #if does not rely on the SQLITE_OS_WINCE define because the
  38936. ** corresponding section in "date.c" cannot use it.
  38937. */
  38938. #if !defined(SQLITE_OMIT_LOCALTIME) && defined(_WIN32_WCE) && \
  38939. (!defined(SQLITE_MSVC_LOCALTIME_API) || !SQLITE_MSVC_LOCALTIME_API)
  38940. /*
  38941. ** The MSVC CRT on Windows CE may not have a localtime() function.
  38942. ** So define a substitute.
  38943. */
  38944. /* # include <time.h> */
  38945. struct tm *__cdecl localtime(const time_t *t)
  38946. {
  38947. static struct tm y;
  38948. FILETIME uTm, lTm;
  38949. SYSTEMTIME pTm;
  38950. sqlite3_int64 t64;
  38951. t64 = *t;
  38952. t64 = (t64 + 11644473600)*10000000;
  38953. uTm.dwLowDateTime = (DWORD)(t64 & 0xFFFFFFFF);
  38954. uTm.dwHighDateTime= (DWORD)(t64 >> 32);
  38955. osFileTimeToLocalFileTime(&uTm,&lTm);
  38956. osFileTimeToSystemTime(&lTm,&pTm);
  38957. y.tm_year = pTm.wYear - 1900;
  38958. y.tm_mon = pTm.wMonth - 1;
  38959. y.tm_wday = pTm.wDayOfWeek;
  38960. y.tm_mday = pTm.wDay;
  38961. y.tm_hour = pTm.wHour;
  38962. y.tm_min = pTm.wMinute;
  38963. y.tm_sec = pTm.wSecond;
  38964. return &y;
  38965. }
  38966. #endif
  38967. #if SQLITE_OS_WINCE
  38968. /*************************************************************************
  38969. ** This section contains code for WinCE only.
  38970. */
  38971. #define HANDLE_TO_WINFILE(a) (winFile*)&((char*)a)[-(int)offsetof(winFile,h)]
  38972. /*
  38973. ** Acquire a lock on the handle h
  38974. */
  38975. static void winceMutexAcquire(HANDLE h){
  38976. DWORD dwErr;
  38977. do {
  38978. dwErr = osWaitForSingleObject(h, INFINITE);
  38979. } while (dwErr != WAIT_OBJECT_0 && dwErr != WAIT_ABANDONED);
  38980. }
  38981. /*
  38982. ** Release a lock acquired by winceMutexAcquire()
  38983. */
  38984. #define winceMutexRelease(h) ReleaseMutex(h)
  38985. /*
  38986. ** Create the mutex and shared memory used for locking in the file
  38987. ** descriptor pFile
  38988. */
  38989. static int winceCreateLock(const char *zFilename, winFile *pFile){
  38990. LPWSTR zTok;
  38991. LPWSTR zName;
  38992. DWORD lastErrno;
  38993. BOOL bLogged = FALSE;
  38994. BOOL bInit = TRUE;
  38995. zName = winUtf8ToUnicode(zFilename);
  38996. if( zName==0 ){
  38997. /* out of memory */
  38998. return SQLITE_IOERR_NOMEM_BKPT;
  38999. }
  39000. /* Initialize the local lockdata */
  39001. memset(&pFile->local, 0, sizeof(pFile->local));
  39002. /* Replace the backslashes from the filename and lowercase it
  39003. ** to derive a mutex name. */
  39004. zTok = osCharLowerW(zName);
  39005. for (;*zTok;zTok++){
  39006. if (*zTok == '\\') *zTok = '_';
  39007. }
  39008. /* Create/open the named mutex */
  39009. pFile->hMutex = osCreateMutexW(NULL, FALSE, zName);
  39010. if (!pFile->hMutex){
  39011. pFile->lastErrno = osGetLastError();
  39012. sqlite3_free(zName);
  39013. return winLogError(SQLITE_IOERR, pFile->lastErrno,
  39014. "winceCreateLock1", zFilename);
  39015. }
  39016. /* Acquire the mutex before continuing */
  39017. winceMutexAcquire(pFile->hMutex);
  39018. /* Since the names of named mutexes, semaphores, file mappings etc are
  39019. ** case-sensitive, take advantage of that by uppercasing the mutex name
  39020. ** and using that as the shared filemapping name.
  39021. */
  39022. osCharUpperW(zName);
  39023. pFile->hShared = osCreateFileMappingW(INVALID_HANDLE_VALUE, NULL,
  39024. PAGE_READWRITE, 0, sizeof(winceLock),
  39025. zName);
  39026. /* Set a flag that indicates we're the first to create the memory so it
  39027. ** must be zero-initialized */
  39028. lastErrno = osGetLastError();
  39029. if (lastErrno == ERROR_ALREADY_EXISTS){
  39030. bInit = FALSE;
  39031. }
  39032. sqlite3_free(zName);
  39033. /* If we succeeded in making the shared memory handle, map it. */
  39034. if( pFile->hShared ){
  39035. pFile->shared = (winceLock*)osMapViewOfFile(pFile->hShared,
  39036. FILE_MAP_READ|FILE_MAP_WRITE, 0, 0, sizeof(winceLock));
  39037. /* If mapping failed, close the shared memory handle and erase it */
  39038. if( !pFile->shared ){
  39039. pFile->lastErrno = osGetLastError();
  39040. winLogError(SQLITE_IOERR, pFile->lastErrno,
  39041. "winceCreateLock2", zFilename);
  39042. bLogged = TRUE;
  39043. osCloseHandle(pFile->hShared);
  39044. pFile->hShared = NULL;
  39045. }
  39046. }
  39047. /* If shared memory could not be created, then close the mutex and fail */
  39048. if( pFile->hShared==NULL ){
  39049. if( !bLogged ){
  39050. pFile->lastErrno = lastErrno;
  39051. winLogError(SQLITE_IOERR, pFile->lastErrno,
  39052. "winceCreateLock3", zFilename);
  39053. bLogged = TRUE;
  39054. }
  39055. winceMutexRelease(pFile->hMutex);
  39056. osCloseHandle(pFile->hMutex);
  39057. pFile->hMutex = NULL;
  39058. return SQLITE_IOERR;
  39059. }
  39060. /* Initialize the shared memory if we're supposed to */
  39061. if( bInit ){
  39062. memset(pFile->shared, 0, sizeof(winceLock));
  39063. }
  39064. winceMutexRelease(pFile->hMutex);
  39065. return SQLITE_OK;
  39066. }
  39067. /*
  39068. ** Destroy the part of winFile that deals with wince locks
  39069. */
  39070. static void winceDestroyLock(winFile *pFile){
  39071. if (pFile->hMutex){
  39072. /* Acquire the mutex */
  39073. winceMutexAcquire(pFile->hMutex);
  39074. /* The following blocks should probably assert in debug mode, but they
  39075. are to cleanup in case any locks remained open */
  39076. if (pFile->local.nReaders){
  39077. pFile->shared->nReaders --;
  39078. }
  39079. if (pFile->local.bReserved){
  39080. pFile->shared->bReserved = FALSE;
  39081. }
  39082. if (pFile->local.bPending){
  39083. pFile->shared->bPending = FALSE;
  39084. }
  39085. if (pFile->local.bExclusive){
  39086. pFile->shared->bExclusive = FALSE;
  39087. }
  39088. /* De-reference and close our copy of the shared memory handle */
  39089. osUnmapViewOfFile(pFile->shared);
  39090. osCloseHandle(pFile->hShared);
  39091. /* Done with the mutex */
  39092. winceMutexRelease(pFile->hMutex);
  39093. osCloseHandle(pFile->hMutex);
  39094. pFile->hMutex = NULL;
  39095. }
  39096. }
  39097. /*
  39098. ** An implementation of the LockFile() API of Windows for CE
  39099. */
  39100. static BOOL winceLockFile(
  39101. LPHANDLE phFile,
  39102. DWORD dwFileOffsetLow,
  39103. DWORD dwFileOffsetHigh,
  39104. DWORD nNumberOfBytesToLockLow,
  39105. DWORD nNumberOfBytesToLockHigh
  39106. ){
  39107. winFile *pFile = HANDLE_TO_WINFILE(phFile);
  39108. BOOL bReturn = FALSE;
  39109. UNUSED_PARAMETER(dwFileOffsetHigh);
  39110. UNUSED_PARAMETER(nNumberOfBytesToLockHigh);
  39111. if (!pFile->hMutex) return TRUE;
  39112. winceMutexAcquire(pFile->hMutex);
  39113. /* Wanting an exclusive lock? */
  39114. if (dwFileOffsetLow == (DWORD)SHARED_FIRST
  39115. && nNumberOfBytesToLockLow == (DWORD)SHARED_SIZE){
  39116. if (pFile->shared->nReaders == 0 && pFile->shared->bExclusive == 0){
  39117. pFile->shared->bExclusive = TRUE;
  39118. pFile->local.bExclusive = TRUE;
  39119. bReturn = TRUE;
  39120. }
  39121. }
  39122. /* Want a read-only lock? */
  39123. else if (dwFileOffsetLow == (DWORD)SHARED_FIRST &&
  39124. nNumberOfBytesToLockLow == 1){
  39125. if (pFile->shared->bExclusive == 0){
  39126. pFile->local.nReaders ++;
  39127. if (pFile->local.nReaders == 1){
  39128. pFile->shared->nReaders ++;
  39129. }
  39130. bReturn = TRUE;
  39131. }
  39132. }
  39133. /* Want a pending lock? */
  39134. else if (dwFileOffsetLow == (DWORD)PENDING_BYTE
  39135. && nNumberOfBytesToLockLow == 1){
  39136. /* If no pending lock has been acquired, then acquire it */
  39137. if (pFile->shared->bPending == 0) {
  39138. pFile->shared->bPending = TRUE;
  39139. pFile->local.bPending = TRUE;
  39140. bReturn = TRUE;
  39141. }
  39142. }
  39143. /* Want a reserved lock? */
  39144. else if (dwFileOffsetLow == (DWORD)RESERVED_BYTE
  39145. && nNumberOfBytesToLockLow == 1){
  39146. if (pFile->shared->bReserved == 0) {
  39147. pFile->shared->bReserved = TRUE;
  39148. pFile->local.bReserved = TRUE;
  39149. bReturn = TRUE;
  39150. }
  39151. }
  39152. winceMutexRelease(pFile->hMutex);
  39153. return bReturn;
  39154. }
  39155. /*
  39156. ** An implementation of the UnlockFile API of Windows for CE
  39157. */
  39158. static BOOL winceUnlockFile(
  39159. LPHANDLE phFile,
  39160. DWORD dwFileOffsetLow,
  39161. DWORD dwFileOffsetHigh,
  39162. DWORD nNumberOfBytesToUnlockLow,
  39163. DWORD nNumberOfBytesToUnlockHigh
  39164. ){
  39165. winFile *pFile = HANDLE_TO_WINFILE(phFile);
  39166. BOOL bReturn = FALSE;
  39167. UNUSED_PARAMETER(dwFileOffsetHigh);
  39168. UNUSED_PARAMETER(nNumberOfBytesToUnlockHigh);
  39169. if (!pFile->hMutex) return TRUE;
  39170. winceMutexAcquire(pFile->hMutex);
  39171. /* Releasing a reader lock or an exclusive lock */
  39172. if (dwFileOffsetLow == (DWORD)SHARED_FIRST){
  39173. /* Did we have an exclusive lock? */
  39174. if (pFile->local.bExclusive){
  39175. assert(nNumberOfBytesToUnlockLow == (DWORD)SHARED_SIZE);
  39176. pFile->local.bExclusive = FALSE;
  39177. pFile->shared->bExclusive = FALSE;
  39178. bReturn = TRUE;
  39179. }
  39180. /* Did we just have a reader lock? */
  39181. else if (pFile->local.nReaders){
  39182. assert(nNumberOfBytesToUnlockLow == (DWORD)SHARED_SIZE
  39183. || nNumberOfBytesToUnlockLow == 1);
  39184. pFile->local.nReaders --;
  39185. if (pFile->local.nReaders == 0)
  39186. {
  39187. pFile->shared->nReaders --;
  39188. }
  39189. bReturn = TRUE;
  39190. }
  39191. }
  39192. /* Releasing a pending lock */
  39193. else if (dwFileOffsetLow == (DWORD)PENDING_BYTE
  39194. && nNumberOfBytesToUnlockLow == 1){
  39195. if (pFile->local.bPending){
  39196. pFile->local.bPending = FALSE;
  39197. pFile->shared->bPending = FALSE;
  39198. bReturn = TRUE;
  39199. }
  39200. }
  39201. /* Releasing a reserved lock */
  39202. else if (dwFileOffsetLow == (DWORD)RESERVED_BYTE
  39203. && nNumberOfBytesToUnlockLow == 1){
  39204. if (pFile->local.bReserved) {
  39205. pFile->local.bReserved = FALSE;
  39206. pFile->shared->bReserved = FALSE;
  39207. bReturn = TRUE;
  39208. }
  39209. }
  39210. winceMutexRelease(pFile->hMutex);
  39211. return bReturn;
  39212. }
  39213. /*
  39214. ** End of the special code for wince
  39215. *****************************************************************************/
  39216. #endif /* SQLITE_OS_WINCE */
  39217. /*
  39218. ** Lock a file region.
  39219. */
  39220. static BOOL winLockFile(
  39221. LPHANDLE phFile,
  39222. DWORD flags,
  39223. DWORD offsetLow,
  39224. DWORD offsetHigh,
  39225. DWORD numBytesLow,
  39226. DWORD numBytesHigh
  39227. ){
  39228. #if SQLITE_OS_WINCE
  39229. /*
  39230. ** NOTE: Windows CE is handled differently here due its lack of the Win32
  39231. ** API LockFile.
  39232. */
  39233. return winceLockFile(phFile, offsetLow, offsetHigh,
  39234. numBytesLow, numBytesHigh);
  39235. #else
  39236. if( osIsNT() ){
  39237. OVERLAPPED ovlp;
  39238. memset(&ovlp, 0, sizeof(OVERLAPPED));
  39239. ovlp.Offset = offsetLow;
  39240. ovlp.OffsetHigh = offsetHigh;
  39241. return osLockFileEx(*phFile, flags, 0, numBytesLow, numBytesHigh, &ovlp);
  39242. }else{
  39243. return osLockFile(*phFile, offsetLow, offsetHigh, numBytesLow,
  39244. numBytesHigh);
  39245. }
  39246. #endif
  39247. }
  39248. /*
  39249. ** Unlock a file region.
  39250. */
  39251. static BOOL winUnlockFile(
  39252. LPHANDLE phFile,
  39253. DWORD offsetLow,
  39254. DWORD offsetHigh,
  39255. DWORD numBytesLow,
  39256. DWORD numBytesHigh
  39257. ){
  39258. #if SQLITE_OS_WINCE
  39259. /*
  39260. ** NOTE: Windows CE is handled differently here due its lack of the Win32
  39261. ** API UnlockFile.
  39262. */
  39263. return winceUnlockFile(phFile, offsetLow, offsetHigh,
  39264. numBytesLow, numBytesHigh);
  39265. #else
  39266. if( osIsNT() ){
  39267. OVERLAPPED ovlp;
  39268. memset(&ovlp, 0, sizeof(OVERLAPPED));
  39269. ovlp.Offset = offsetLow;
  39270. ovlp.OffsetHigh = offsetHigh;
  39271. return osUnlockFileEx(*phFile, 0, numBytesLow, numBytesHigh, &ovlp);
  39272. }else{
  39273. return osUnlockFile(*phFile, offsetLow, offsetHigh, numBytesLow,
  39274. numBytesHigh);
  39275. }
  39276. #endif
  39277. }
  39278. /*****************************************************************************
  39279. ** The next group of routines implement the I/O methods specified
  39280. ** by the sqlite3_io_methods object.
  39281. ******************************************************************************/
  39282. /*
  39283. ** Some Microsoft compilers lack this definition.
  39284. */
  39285. #ifndef INVALID_SET_FILE_POINTER
  39286. # define INVALID_SET_FILE_POINTER ((DWORD)-1)
  39287. #endif
  39288. /*
  39289. ** Move the current position of the file handle passed as the first
  39290. ** argument to offset iOffset within the file. If successful, return 0.
  39291. ** Otherwise, set pFile->lastErrno and return non-zero.
  39292. */
  39293. static int winSeekFile(winFile *pFile, sqlite3_int64 iOffset){
  39294. #if !SQLITE_OS_WINRT
  39295. LONG upperBits; /* Most sig. 32 bits of new offset */
  39296. LONG lowerBits; /* Least sig. 32 bits of new offset */
  39297. DWORD dwRet; /* Value returned by SetFilePointer() */
  39298. DWORD lastErrno; /* Value returned by GetLastError() */
  39299. OSTRACE(("SEEK file=%p, offset=%lld\n", pFile->h, iOffset));
  39300. upperBits = (LONG)((iOffset>>32) & 0x7fffffff);
  39301. lowerBits = (LONG)(iOffset & 0xffffffff);
  39302. /* API oddity: If successful, SetFilePointer() returns a dword
  39303. ** containing the lower 32-bits of the new file-offset. Or, if it fails,
  39304. ** it returns INVALID_SET_FILE_POINTER. However according to MSDN,
  39305. ** INVALID_SET_FILE_POINTER may also be a valid new offset. So to determine
  39306. ** whether an error has actually occurred, it is also necessary to call
  39307. ** GetLastError().
  39308. */
  39309. dwRet = osSetFilePointer(pFile->h, lowerBits, &upperBits, FILE_BEGIN);
  39310. if( (dwRet==INVALID_SET_FILE_POINTER
  39311. && ((lastErrno = osGetLastError())!=NO_ERROR)) ){
  39312. pFile->lastErrno = lastErrno;
  39313. winLogError(SQLITE_IOERR_SEEK, pFile->lastErrno,
  39314. "winSeekFile", pFile->zPath);
  39315. OSTRACE(("SEEK file=%p, rc=SQLITE_IOERR_SEEK\n", pFile->h));
  39316. return 1;
  39317. }
  39318. OSTRACE(("SEEK file=%p, rc=SQLITE_OK\n", pFile->h));
  39319. return 0;
  39320. #else
  39321. /*
  39322. ** Same as above, except that this implementation works for WinRT.
  39323. */
  39324. LARGE_INTEGER x; /* The new offset */
  39325. BOOL bRet; /* Value returned by SetFilePointerEx() */
  39326. x.QuadPart = iOffset;
  39327. bRet = osSetFilePointerEx(pFile->h, x, 0, FILE_BEGIN);
  39328. if(!bRet){
  39329. pFile->lastErrno = osGetLastError();
  39330. winLogError(SQLITE_IOERR_SEEK, pFile->lastErrno,
  39331. "winSeekFile", pFile->zPath);
  39332. OSTRACE(("SEEK file=%p, rc=SQLITE_IOERR_SEEK\n", pFile->h));
  39333. return 1;
  39334. }
  39335. OSTRACE(("SEEK file=%p, rc=SQLITE_OK\n", pFile->h));
  39336. return 0;
  39337. #endif
  39338. }
  39339. #if SQLITE_MAX_MMAP_SIZE>0
  39340. /* Forward references to VFS helper methods used for memory mapped files */
  39341. static int winMapfile(winFile*, sqlite3_int64);
  39342. static int winUnmapfile(winFile*);
  39343. #endif
  39344. /*
  39345. ** Close a file.
  39346. **
  39347. ** It is reported that an attempt to close a handle might sometimes
  39348. ** fail. This is a very unreasonable result, but Windows is notorious
  39349. ** for being unreasonable so I do not doubt that it might happen. If
  39350. ** the close fails, we pause for 100 milliseconds and try again. As
  39351. ** many as MX_CLOSE_ATTEMPT attempts to close the handle are made before
  39352. ** giving up and returning an error.
  39353. */
  39354. #define MX_CLOSE_ATTEMPT 3
  39355. static int winClose(sqlite3_file *id){
  39356. int rc, cnt = 0;
  39357. winFile *pFile = (winFile*)id;
  39358. assert( id!=0 );
  39359. #ifndef SQLITE_OMIT_WAL
  39360. assert( pFile->pShm==0 );
  39361. #endif
  39362. assert( pFile->h!=NULL && pFile->h!=INVALID_HANDLE_VALUE );
  39363. OSTRACE(("CLOSE pid=%lu, pFile=%p, file=%p\n",
  39364. osGetCurrentProcessId(), pFile, pFile->h));
  39365. #if SQLITE_MAX_MMAP_SIZE>0
  39366. winUnmapfile(pFile);
  39367. #endif
  39368. do{
  39369. rc = osCloseHandle(pFile->h);
  39370. /* SimulateIOError( rc=0; cnt=MX_CLOSE_ATTEMPT; ); */
  39371. }while( rc==0 && ++cnt < MX_CLOSE_ATTEMPT && (sqlite3_win32_sleep(100), 1) );
  39372. #if SQLITE_OS_WINCE
  39373. #define WINCE_DELETION_ATTEMPTS 3
  39374. {
  39375. winVfsAppData *pAppData = (winVfsAppData*)pFile->pVfs->pAppData;
  39376. if( pAppData==NULL || !pAppData->bNoLock ){
  39377. winceDestroyLock(pFile);
  39378. }
  39379. }
  39380. if( pFile->zDeleteOnClose ){
  39381. int cnt = 0;
  39382. while(
  39383. osDeleteFileW(pFile->zDeleteOnClose)==0
  39384. && osGetFileAttributesW(pFile->zDeleteOnClose)!=0xffffffff
  39385. && cnt++ < WINCE_DELETION_ATTEMPTS
  39386. ){
  39387. sqlite3_win32_sleep(100); /* Wait a little before trying again */
  39388. }
  39389. sqlite3_free(pFile->zDeleteOnClose);
  39390. }
  39391. #endif
  39392. if( rc ){
  39393. pFile->h = NULL;
  39394. }
  39395. OpenCounter(-1);
  39396. OSTRACE(("CLOSE pid=%lu, pFile=%p, file=%p, rc=%s\n",
  39397. osGetCurrentProcessId(), pFile, pFile->h, rc ? "ok" : "failed"));
  39398. return rc ? SQLITE_OK
  39399. : winLogError(SQLITE_IOERR_CLOSE, osGetLastError(),
  39400. "winClose", pFile->zPath);
  39401. }
  39402. /*
  39403. ** Read data from a file into a buffer. Return SQLITE_OK if all
  39404. ** bytes were read successfully and SQLITE_IOERR if anything goes
  39405. ** wrong.
  39406. */
  39407. static int winRead(
  39408. sqlite3_file *id, /* File to read from */
  39409. void *pBuf, /* Write content into this buffer */
  39410. int amt, /* Number of bytes to read */
  39411. sqlite3_int64 offset /* Begin reading at this offset */
  39412. ){
  39413. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  39414. OVERLAPPED overlapped; /* The offset for ReadFile. */
  39415. #endif
  39416. winFile *pFile = (winFile*)id; /* file handle */
  39417. DWORD nRead; /* Number of bytes actually read from file */
  39418. int nRetry = 0; /* Number of retrys */
  39419. assert( id!=0 );
  39420. assert( amt>0 );
  39421. assert( offset>=0 );
  39422. SimulateIOError(return SQLITE_IOERR_READ);
  39423. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, buffer=%p, amount=%d, "
  39424. "offset=%lld, lock=%d\n", osGetCurrentProcessId(), pFile,
  39425. pFile->h, pBuf, amt, offset, pFile->locktype));
  39426. #if SQLITE_MAX_MMAP_SIZE>0
  39427. /* Deal with as much of this read request as possible by transfering
  39428. ** data from the memory mapping using memcpy(). */
  39429. if( offset<pFile->mmapSize ){
  39430. if( offset+amt <= pFile->mmapSize ){
  39431. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], amt);
  39432. OSTRACE(("READ-MMAP pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  39433. osGetCurrentProcessId(), pFile, pFile->h));
  39434. return SQLITE_OK;
  39435. }else{
  39436. int nCopy = (int)(pFile->mmapSize - offset);
  39437. memcpy(pBuf, &((u8 *)(pFile->pMapRegion))[offset], nCopy);
  39438. pBuf = &((u8 *)pBuf)[nCopy];
  39439. amt -= nCopy;
  39440. offset += nCopy;
  39441. }
  39442. }
  39443. #endif
  39444. #if SQLITE_OS_WINCE || defined(SQLITE_WIN32_NO_OVERLAPPED)
  39445. if( winSeekFile(pFile, offset) ){
  39446. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_FULL\n",
  39447. osGetCurrentProcessId(), pFile, pFile->h));
  39448. return SQLITE_FULL;
  39449. }
  39450. while( !osReadFile(pFile->h, pBuf, amt, &nRead, 0) ){
  39451. #else
  39452. memset(&overlapped, 0, sizeof(OVERLAPPED));
  39453. overlapped.Offset = (LONG)(offset & 0xffffffff);
  39454. overlapped.OffsetHigh = (LONG)((offset>>32) & 0x7fffffff);
  39455. while( !osReadFile(pFile->h, pBuf, amt, &nRead, &overlapped) &&
  39456. osGetLastError()!=ERROR_HANDLE_EOF ){
  39457. #endif
  39458. DWORD lastErrno;
  39459. if( winRetryIoerr(&nRetry, &lastErrno) ) continue;
  39460. pFile->lastErrno = lastErrno;
  39461. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_READ\n",
  39462. osGetCurrentProcessId(), pFile, pFile->h));
  39463. return winLogError(SQLITE_IOERR_READ, pFile->lastErrno,
  39464. "winRead", pFile->zPath);
  39465. }
  39466. winLogIoerr(nRetry, __LINE__);
  39467. if( nRead<(DWORD)amt ){
  39468. /* Unread parts of the buffer must be zero-filled */
  39469. memset(&((char*)pBuf)[nRead], 0, amt-nRead);
  39470. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_SHORT_READ\n",
  39471. osGetCurrentProcessId(), pFile, pFile->h));
  39472. return SQLITE_IOERR_SHORT_READ;
  39473. }
  39474. OSTRACE(("READ pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  39475. osGetCurrentProcessId(), pFile, pFile->h));
  39476. return SQLITE_OK;
  39477. }
  39478. /*
  39479. ** Write data from a buffer into a file. Return SQLITE_OK on success
  39480. ** or some other error code on failure.
  39481. */
  39482. static int winWrite(
  39483. sqlite3_file *id, /* File to write into */
  39484. const void *pBuf, /* The bytes to be written */
  39485. int amt, /* Number of bytes to write */
  39486. sqlite3_int64 offset /* Offset into the file to begin writing at */
  39487. ){
  39488. int rc = 0; /* True if error has occurred, else false */
  39489. winFile *pFile = (winFile*)id; /* File handle */
  39490. int nRetry = 0; /* Number of retries */
  39491. assert( amt>0 );
  39492. assert( pFile );
  39493. SimulateIOError(return SQLITE_IOERR_WRITE);
  39494. SimulateDiskfullError(return SQLITE_FULL);
  39495. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, buffer=%p, amount=%d, "
  39496. "offset=%lld, lock=%d\n", osGetCurrentProcessId(), pFile,
  39497. pFile->h, pBuf, amt, offset, pFile->locktype));
  39498. #if defined(SQLITE_MMAP_READWRITE) && SQLITE_MAX_MMAP_SIZE>0
  39499. /* Deal with as much of this write request as possible by transfering
  39500. ** data from the memory mapping using memcpy(). */
  39501. if( offset<pFile->mmapSize ){
  39502. if( offset+amt <= pFile->mmapSize ){
  39503. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, amt);
  39504. OSTRACE(("WRITE-MMAP pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  39505. osGetCurrentProcessId(), pFile, pFile->h));
  39506. return SQLITE_OK;
  39507. }else{
  39508. int nCopy = (int)(pFile->mmapSize - offset);
  39509. memcpy(&((u8 *)(pFile->pMapRegion))[offset], pBuf, nCopy);
  39510. pBuf = &((u8 *)pBuf)[nCopy];
  39511. amt -= nCopy;
  39512. offset += nCopy;
  39513. }
  39514. }
  39515. #endif
  39516. #if SQLITE_OS_WINCE || defined(SQLITE_WIN32_NO_OVERLAPPED)
  39517. rc = winSeekFile(pFile, offset);
  39518. if( rc==0 ){
  39519. #else
  39520. {
  39521. #endif
  39522. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  39523. OVERLAPPED overlapped; /* The offset for WriteFile. */
  39524. #endif
  39525. u8 *aRem = (u8 *)pBuf; /* Data yet to be written */
  39526. int nRem = amt; /* Number of bytes yet to be written */
  39527. DWORD nWrite; /* Bytes written by each WriteFile() call */
  39528. DWORD lastErrno = NO_ERROR; /* Value returned by GetLastError() */
  39529. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  39530. memset(&overlapped, 0, sizeof(OVERLAPPED));
  39531. overlapped.Offset = (LONG)(offset & 0xffffffff);
  39532. overlapped.OffsetHigh = (LONG)((offset>>32) & 0x7fffffff);
  39533. #endif
  39534. while( nRem>0 ){
  39535. #if SQLITE_OS_WINCE || defined(SQLITE_WIN32_NO_OVERLAPPED)
  39536. if( !osWriteFile(pFile->h, aRem, nRem, &nWrite, 0) ){
  39537. #else
  39538. if( !osWriteFile(pFile->h, aRem, nRem, &nWrite, &overlapped) ){
  39539. #endif
  39540. if( winRetryIoerr(&nRetry, &lastErrno) ) continue;
  39541. break;
  39542. }
  39543. assert( nWrite==0 || nWrite<=(DWORD)nRem );
  39544. if( nWrite==0 || nWrite>(DWORD)nRem ){
  39545. lastErrno = osGetLastError();
  39546. break;
  39547. }
  39548. #if !SQLITE_OS_WINCE && !defined(SQLITE_WIN32_NO_OVERLAPPED)
  39549. offset += nWrite;
  39550. overlapped.Offset = (LONG)(offset & 0xffffffff);
  39551. overlapped.OffsetHigh = (LONG)((offset>>32) & 0x7fffffff);
  39552. #endif
  39553. aRem += nWrite;
  39554. nRem -= nWrite;
  39555. }
  39556. if( nRem>0 ){
  39557. pFile->lastErrno = lastErrno;
  39558. rc = 1;
  39559. }
  39560. }
  39561. if( rc ){
  39562. if( ( pFile->lastErrno==ERROR_HANDLE_DISK_FULL )
  39563. || ( pFile->lastErrno==ERROR_DISK_FULL )){
  39564. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, rc=SQLITE_FULL\n",
  39565. osGetCurrentProcessId(), pFile, pFile->h));
  39566. return winLogError(SQLITE_FULL, pFile->lastErrno,
  39567. "winWrite1", pFile->zPath);
  39568. }
  39569. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_WRITE\n",
  39570. osGetCurrentProcessId(), pFile, pFile->h));
  39571. return winLogError(SQLITE_IOERR_WRITE, pFile->lastErrno,
  39572. "winWrite2", pFile->zPath);
  39573. }else{
  39574. winLogIoerr(nRetry, __LINE__);
  39575. }
  39576. OSTRACE(("WRITE pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  39577. osGetCurrentProcessId(), pFile, pFile->h));
  39578. return SQLITE_OK;
  39579. }
  39580. /*
  39581. ** Truncate an open file to a specified size
  39582. */
  39583. static int winTruncate(sqlite3_file *id, sqlite3_int64 nByte){
  39584. winFile *pFile = (winFile*)id; /* File handle object */
  39585. int rc = SQLITE_OK; /* Return code for this function */
  39586. DWORD lastErrno;
  39587. assert( pFile );
  39588. SimulateIOError(return SQLITE_IOERR_TRUNCATE);
  39589. OSTRACE(("TRUNCATE pid=%lu, pFile=%p, file=%p, size=%lld, lock=%d\n",
  39590. osGetCurrentProcessId(), pFile, pFile->h, nByte, pFile->locktype));
  39591. /* If the user has configured a chunk-size for this file, truncate the
  39592. ** file so that it consists of an integer number of chunks (i.e. the
  39593. ** actual file size after the operation may be larger than the requested
  39594. ** size).
  39595. */
  39596. if( pFile->szChunk>0 ){
  39597. nByte = ((nByte + pFile->szChunk - 1)/pFile->szChunk) * pFile->szChunk;
  39598. }
  39599. /* SetEndOfFile() returns non-zero when successful, or zero when it fails. */
  39600. if( winSeekFile(pFile, nByte) ){
  39601. rc = winLogError(SQLITE_IOERR_TRUNCATE, pFile->lastErrno,
  39602. "winTruncate1", pFile->zPath);
  39603. }else if( 0==osSetEndOfFile(pFile->h) &&
  39604. ((lastErrno = osGetLastError())!=ERROR_USER_MAPPED_FILE) ){
  39605. pFile->lastErrno = lastErrno;
  39606. rc = winLogError(SQLITE_IOERR_TRUNCATE, pFile->lastErrno,
  39607. "winTruncate2", pFile->zPath);
  39608. }
  39609. #if SQLITE_MAX_MMAP_SIZE>0
  39610. /* If the file was truncated to a size smaller than the currently
  39611. ** mapped region, reduce the effective mapping size as well. SQLite will
  39612. ** use read() and write() to access data beyond this point from now on.
  39613. */
  39614. if( pFile->pMapRegion && nByte<pFile->mmapSize ){
  39615. pFile->mmapSize = nByte;
  39616. }
  39617. #endif
  39618. OSTRACE(("TRUNCATE pid=%lu, pFile=%p, file=%p, rc=%s\n",
  39619. osGetCurrentProcessId(), pFile, pFile->h, sqlite3ErrName(rc)));
  39620. return rc;
  39621. }
  39622. #ifdef SQLITE_TEST
  39623. /*
  39624. ** Count the number of fullsyncs and normal syncs. This is used to test
  39625. ** that syncs and fullsyncs are occuring at the right times.
  39626. */
  39627. SQLITE_API int sqlite3_sync_count = 0;
  39628. SQLITE_API int sqlite3_fullsync_count = 0;
  39629. #endif
  39630. /*
  39631. ** Make sure all writes to a particular file are committed to disk.
  39632. */
  39633. static int winSync(sqlite3_file *id, int flags){
  39634. #ifndef SQLITE_NO_SYNC
  39635. /*
  39636. ** Used only when SQLITE_NO_SYNC is not defined.
  39637. */
  39638. BOOL rc;
  39639. #endif
  39640. #if !defined(NDEBUG) || !defined(SQLITE_NO_SYNC) || \
  39641. defined(SQLITE_HAVE_OS_TRACE)
  39642. /*
  39643. ** Used when SQLITE_NO_SYNC is not defined and by the assert() and/or
  39644. ** OSTRACE() macros.
  39645. */
  39646. winFile *pFile = (winFile*)id;
  39647. #else
  39648. UNUSED_PARAMETER(id);
  39649. #endif
  39650. assert( pFile );
  39651. /* Check that one of SQLITE_SYNC_NORMAL or FULL was passed */
  39652. assert((flags&0x0F)==SQLITE_SYNC_NORMAL
  39653. || (flags&0x0F)==SQLITE_SYNC_FULL
  39654. );
  39655. /* Unix cannot, but some systems may return SQLITE_FULL from here. This
  39656. ** line is to test that doing so does not cause any problems.
  39657. */
  39658. SimulateDiskfullError( return SQLITE_FULL );
  39659. OSTRACE(("SYNC pid=%lu, pFile=%p, file=%p, flags=%x, lock=%d\n",
  39660. osGetCurrentProcessId(), pFile, pFile->h, flags,
  39661. pFile->locktype));
  39662. #ifndef SQLITE_TEST
  39663. UNUSED_PARAMETER(flags);
  39664. #else
  39665. if( (flags&0x0F)==SQLITE_SYNC_FULL ){
  39666. sqlite3_fullsync_count++;
  39667. }
  39668. sqlite3_sync_count++;
  39669. #endif
  39670. /* If we compiled with the SQLITE_NO_SYNC flag, then syncing is a
  39671. ** no-op
  39672. */
  39673. #ifdef SQLITE_NO_SYNC
  39674. OSTRACE(("SYNC-NOP pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  39675. osGetCurrentProcessId(), pFile, pFile->h));
  39676. return SQLITE_OK;
  39677. #else
  39678. #if SQLITE_MAX_MMAP_SIZE>0
  39679. if( pFile->pMapRegion ){
  39680. if( osFlushViewOfFile(pFile->pMapRegion, 0) ){
  39681. OSTRACE(("SYNC-MMAP pid=%lu, pFile=%p, pMapRegion=%p, "
  39682. "rc=SQLITE_OK\n", osGetCurrentProcessId(),
  39683. pFile, pFile->pMapRegion));
  39684. }else{
  39685. pFile->lastErrno = osGetLastError();
  39686. OSTRACE(("SYNC-MMAP pid=%lu, pFile=%p, pMapRegion=%p, "
  39687. "rc=SQLITE_IOERR_MMAP\n", osGetCurrentProcessId(),
  39688. pFile, pFile->pMapRegion));
  39689. return winLogError(SQLITE_IOERR_MMAP, pFile->lastErrno,
  39690. "winSync1", pFile->zPath);
  39691. }
  39692. }
  39693. #endif
  39694. rc = osFlushFileBuffers(pFile->h);
  39695. SimulateIOError( rc=FALSE );
  39696. if( rc ){
  39697. OSTRACE(("SYNC pid=%lu, pFile=%p, file=%p, rc=SQLITE_OK\n",
  39698. osGetCurrentProcessId(), pFile, pFile->h));
  39699. return SQLITE_OK;
  39700. }else{
  39701. pFile->lastErrno = osGetLastError();
  39702. OSTRACE(("SYNC pid=%lu, pFile=%p, file=%p, rc=SQLITE_IOERR_FSYNC\n",
  39703. osGetCurrentProcessId(), pFile, pFile->h));
  39704. return winLogError(SQLITE_IOERR_FSYNC, pFile->lastErrno,
  39705. "winSync2", pFile->zPath);
  39706. }
  39707. #endif
  39708. }
  39709. /*
  39710. ** Determine the current size of a file in bytes
  39711. */
  39712. static int winFileSize(sqlite3_file *id, sqlite3_int64 *pSize){
  39713. winFile *pFile = (winFile*)id;
  39714. int rc = SQLITE_OK;
  39715. assert( id!=0 );
  39716. assert( pSize!=0 );
  39717. SimulateIOError(return SQLITE_IOERR_FSTAT);
  39718. OSTRACE(("SIZE file=%p, pSize=%p\n", pFile->h, pSize));
  39719. #if SQLITE_OS_WINRT
  39720. {
  39721. FILE_STANDARD_INFO info;
  39722. if( osGetFileInformationByHandleEx(pFile->h, FileStandardInfo,
  39723. &info, sizeof(info)) ){
  39724. *pSize = info.EndOfFile.QuadPart;
  39725. }else{
  39726. pFile->lastErrno = osGetLastError();
  39727. rc = winLogError(SQLITE_IOERR_FSTAT, pFile->lastErrno,
  39728. "winFileSize", pFile->zPath);
  39729. }
  39730. }
  39731. #else
  39732. {
  39733. DWORD upperBits;
  39734. DWORD lowerBits;
  39735. DWORD lastErrno;
  39736. lowerBits = osGetFileSize(pFile->h, &upperBits);
  39737. *pSize = (((sqlite3_int64)upperBits)<<32) + lowerBits;
  39738. if( (lowerBits == INVALID_FILE_SIZE)
  39739. && ((lastErrno = osGetLastError())!=NO_ERROR) ){
  39740. pFile->lastErrno = lastErrno;
  39741. rc = winLogError(SQLITE_IOERR_FSTAT, pFile->lastErrno,
  39742. "winFileSize", pFile->zPath);
  39743. }
  39744. }
  39745. #endif
  39746. OSTRACE(("SIZE file=%p, pSize=%p, *pSize=%lld, rc=%s\n",
  39747. pFile->h, pSize, *pSize, sqlite3ErrName(rc)));
  39748. return rc;
  39749. }
  39750. /*
  39751. ** LOCKFILE_FAIL_IMMEDIATELY is undefined on some Windows systems.
  39752. */
  39753. #ifndef LOCKFILE_FAIL_IMMEDIATELY
  39754. # define LOCKFILE_FAIL_IMMEDIATELY 1
  39755. #endif
  39756. #ifndef LOCKFILE_EXCLUSIVE_LOCK
  39757. # define LOCKFILE_EXCLUSIVE_LOCK 2
  39758. #endif
  39759. /*
  39760. ** Historically, SQLite has used both the LockFile and LockFileEx functions.
  39761. ** When the LockFile function was used, it was always expected to fail
  39762. ** immediately if the lock could not be obtained. Also, it always expected to
  39763. ** obtain an exclusive lock. These flags are used with the LockFileEx function
  39764. ** and reflect those expectations; therefore, they should not be changed.
  39765. */
  39766. #ifndef SQLITE_LOCKFILE_FLAGS
  39767. # define SQLITE_LOCKFILE_FLAGS (LOCKFILE_FAIL_IMMEDIATELY | \
  39768. LOCKFILE_EXCLUSIVE_LOCK)
  39769. #endif
  39770. /*
  39771. ** Currently, SQLite never calls the LockFileEx function without wanting the
  39772. ** call to fail immediately if the lock cannot be obtained.
  39773. */
  39774. #ifndef SQLITE_LOCKFILEEX_FLAGS
  39775. # define SQLITE_LOCKFILEEX_FLAGS (LOCKFILE_FAIL_IMMEDIATELY)
  39776. #endif
  39777. /*
  39778. ** Acquire a reader lock.
  39779. ** Different API routines are called depending on whether or not this
  39780. ** is Win9x or WinNT.
  39781. */
  39782. static int winGetReadLock(winFile *pFile){
  39783. int res;
  39784. OSTRACE(("READ-LOCK file=%p, lock=%d\n", pFile->h, pFile->locktype));
  39785. if( osIsNT() ){
  39786. #if SQLITE_OS_WINCE
  39787. /*
  39788. ** NOTE: Windows CE is handled differently here due its lack of the Win32
  39789. ** API LockFileEx.
  39790. */
  39791. res = winceLockFile(&pFile->h, SHARED_FIRST, 0, 1, 0);
  39792. #else
  39793. res = winLockFile(&pFile->h, SQLITE_LOCKFILEEX_FLAGS, SHARED_FIRST, 0,
  39794. SHARED_SIZE, 0);
  39795. #endif
  39796. }
  39797. #ifdef SQLITE_WIN32_HAS_ANSI
  39798. else{
  39799. int lk;
  39800. sqlite3_randomness(sizeof(lk), &lk);
  39801. pFile->sharedLockByte = (short)((lk & 0x7fffffff)%(SHARED_SIZE - 1));
  39802. res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS,
  39803. SHARED_FIRST+pFile->sharedLockByte, 0, 1, 0);
  39804. }
  39805. #endif
  39806. if( res == 0 ){
  39807. pFile->lastErrno = osGetLastError();
  39808. /* No need to log a failure to lock */
  39809. }
  39810. OSTRACE(("READ-LOCK file=%p, result=%d\n", pFile->h, res));
  39811. return res;
  39812. }
  39813. /*
  39814. ** Undo a readlock
  39815. */
  39816. static int winUnlockReadLock(winFile *pFile){
  39817. int res;
  39818. DWORD lastErrno;
  39819. OSTRACE(("READ-UNLOCK file=%p, lock=%d\n", pFile->h, pFile->locktype));
  39820. if( osIsNT() ){
  39821. res = winUnlockFile(&pFile->h, SHARED_FIRST, 0, SHARED_SIZE, 0);
  39822. }
  39823. #ifdef SQLITE_WIN32_HAS_ANSI
  39824. else{
  39825. res = winUnlockFile(&pFile->h, SHARED_FIRST+pFile->sharedLockByte, 0, 1, 0);
  39826. }
  39827. #endif
  39828. if( res==0 && ((lastErrno = osGetLastError())!=ERROR_NOT_LOCKED) ){
  39829. pFile->lastErrno = lastErrno;
  39830. winLogError(SQLITE_IOERR_UNLOCK, pFile->lastErrno,
  39831. "winUnlockReadLock", pFile->zPath);
  39832. }
  39833. OSTRACE(("READ-UNLOCK file=%p, result=%d\n", pFile->h, res));
  39834. return res;
  39835. }
  39836. /*
  39837. ** Lock the file with the lock specified by parameter locktype - one
  39838. ** of the following:
  39839. **
  39840. ** (1) SHARED_LOCK
  39841. ** (2) RESERVED_LOCK
  39842. ** (3) PENDING_LOCK
  39843. ** (4) EXCLUSIVE_LOCK
  39844. **
  39845. ** Sometimes when requesting one lock state, additional lock states
  39846. ** are inserted in between. The locking might fail on one of the later
  39847. ** transitions leaving the lock state different from what it started but
  39848. ** still short of its goal. The following chart shows the allowed
  39849. ** transitions and the inserted intermediate states:
  39850. **
  39851. ** UNLOCKED -> SHARED
  39852. ** SHARED -> RESERVED
  39853. ** SHARED -> (PENDING) -> EXCLUSIVE
  39854. ** RESERVED -> (PENDING) -> EXCLUSIVE
  39855. ** PENDING -> EXCLUSIVE
  39856. **
  39857. ** This routine will only increase a lock. The winUnlock() routine
  39858. ** erases all locks at once and returns us immediately to locking level 0.
  39859. ** It is not possible to lower the locking level one step at a time. You
  39860. ** must go straight to locking level 0.
  39861. */
  39862. static int winLock(sqlite3_file *id, int locktype){
  39863. int rc = SQLITE_OK; /* Return code from subroutines */
  39864. int res = 1; /* Result of a Windows lock call */
  39865. int newLocktype; /* Set pFile->locktype to this value before exiting */
  39866. int gotPendingLock = 0;/* True if we acquired a PENDING lock this time */
  39867. winFile *pFile = (winFile*)id;
  39868. DWORD lastErrno = NO_ERROR;
  39869. assert( id!=0 );
  39870. OSTRACE(("LOCK file=%p, oldLock=%d(%d), newLock=%d\n",
  39871. pFile->h, pFile->locktype, pFile->sharedLockByte, locktype));
  39872. /* If there is already a lock of this type or more restrictive on the
  39873. ** OsFile, do nothing. Don't use the end_lock: exit path, as
  39874. ** sqlite3OsEnterMutex() hasn't been called yet.
  39875. */
  39876. if( pFile->locktype>=locktype ){
  39877. OSTRACE(("LOCK-HELD file=%p, rc=SQLITE_OK\n", pFile->h));
  39878. return SQLITE_OK;
  39879. }
  39880. /* Do not allow any kind of write-lock on a read-only database
  39881. */
  39882. if( (pFile->ctrlFlags & WINFILE_RDONLY)!=0 && locktype>=RESERVED_LOCK ){
  39883. return SQLITE_IOERR_LOCK;
  39884. }
  39885. /* Make sure the locking sequence is correct
  39886. */
  39887. assert( pFile->locktype!=NO_LOCK || locktype==SHARED_LOCK );
  39888. assert( locktype!=PENDING_LOCK );
  39889. assert( locktype!=RESERVED_LOCK || pFile->locktype==SHARED_LOCK );
  39890. /* Lock the PENDING_LOCK byte if we need to acquire a PENDING lock or
  39891. ** a SHARED lock. If we are acquiring a SHARED lock, the acquisition of
  39892. ** the PENDING_LOCK byte is temporary.
  39893. */
  39894. newLocktype = pFile->locktype;
  39895. if( pFile->locktype==NO_LOCK
  39896. || (locktype==EXCLUSIVE_LOCK && pFile->locktype<=RESERVED_LOCK)
  39897. ){
  39898. int cnt = 3;
  39899. while( cnt-->0 && (res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS,
  39900. PENDING_BYTE, 0, 1, 0))==0 ){
  39901. /* Try 3 times to get the pending lock. This is needed to work
  39902. ** around problems caused by indexing and/or anti-virus software on
  39903. ** Windows systems.
  39904. ** If you are using this code as a model for alternative VFSes, do not
  39905. ** copy this retry logic. It is a hack intended for Windows only.
  39906. */
  39907. lastErrno = osGetLastError();
  39908. OSTRACE(("LOCK-PENDING-FAIL file=%p, count=%d, result=%d\n",
  39909. pFile->h, cnt, res));
  39910. if( lastErrno==ERROR_INVALID_HANDLE ){
  39911. pFile->lastErrno = lastErrno;
  39912. rc = SQLITE_IOERR_LOCK;
  39913. OSTRACE(("LOCK-FAIL file=%p, count=%d, rc=%s\n",
  39914. pFile->h, cnt, sqlite3ErrName(rc)));
  39915. return rc;
  39916. }
  39917. if( cnt ) sqlite3_win32_sleep(1);
  39918. }
  39919. gotPendingLock = res;
  39920. if( !res ){
  39921. lastErrno = osGetLastError();
  39922. }
  39923. }
  39924. /* Acquire a shared lock
  39925. */
  39926. if( locktype==SHARED_LOCK && res ){
  39927. assert( pFile->locktype==NO_LOCK );
  39928. res = winGetReadLock(pFile);
  39929. if( res ){
  39930. newLocktype = SHARED_LOCK;
  39931. }else{
  39932. lastErrno = osGetLastError();
  39933. }
  39934. }
  39935. /* Acquire a RESERVED lock
  39936. */
  39937. if( locktype==RESERVED_LOCK && res ){
  39938. assert( pFile->locktype==SHARED_LOCK );
  39939. res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS, RESERVED_BYTE, 0, 1, 0);
  39940. if( res ){
  39941. newLocktype = RESERVED_LOCK;
  39942. }else{
  39943. lastErrno = osGetLastError();
  39944. }
  39945. }
  39946. /* Acquire a PENDING lock
  39947. */
  39948. if( locktype==EXCLUSIVE_LOCK && res ){
  39949. newLocktype = PENDING_LOCK;
  39950. gotPendingLock = 0;
  39951. }
  39952. /* Acquire an EXCLUSIVE lock
  39953. */
  39954. if( locktype==EXCLUSIVE_LOCK && res ){
  39955. assert( pFile->locktype>=SHARED_LOCK );
  39956. res = winUnlockReadLock(pFile);
  39957. res = winLockFile(&pFile->h, SQLITE_LOCKFILE_FLAGS, SHARED_FIRST, 0,
  39958. SHARED_SIZE, 0);
  39959. if( res ){
  39960. newLocktype = EXCLUSIVE_LOCK;
  39961. }else{
  39962. lastErrno = osGetLastError();
  39963. winGetReadLock(pFile);
  39964. }
  39965. }
  39966. /* If we are holding a PENDING lock that ought to be released, then
  39967. ** release it now.
  39968. */
  39969. if( gotPendingLock && locktype==SHARED_LOCK ){
  39970. winUnlockFile(&pFile->h, PENDING_BYTE, 0, 1, 0);
  39971. }
  39972. /* Update the state of the lock has held in the file descriptor then
  39973. ** return the appropriate result code.
  39974. */
  39975. if( res ){
  39976. rc = SQLITE_OK;
  39977. }else{
  39978. pFile->lastErrno = lastErrno;
  39979. rc = SQLITE_BUSY;
  39980. OSTRACE(("LOCK-FAIL file=%p, wanted=%d, got=%d\n",
  39981. pFile->h, locktype, newLocktype));
  39982. }
  39983. pFile->locktype = (u8)newLocktype;
  39984. OSTRACE(("LOCK file=%p, lock=%d, rc=%s\n",
  39985. pFile->h, pFile->locktype, sqlite3ErrName(rc)));
  39986. return rc;
  39987. }
  39988. /*
  39989. ** This routine checks if there is a RESERVED lock held on the specified
  39990. ** file by this or any other process. If such a lock is held, return
  39991. ** non-zero, otherwise zero.
  39992. */
  39993. static int winCheckReservedLock(sqlite3_file *id, int *pResOut){
  39994. int res;
  39995. winFile *pFile = (winFile*)id;
  39996. SimulateIOError( return SQLITE_IOERR_CHECKRESERVEDLOCK; );
  39997. OSTRACE(("TEST-WR-LOCK file=%p, pResOut=%p\n", pFile->h, pResOut));
  39998. assert( id!=0 );
  39999. if( pFile->locktype>=RESERVED_LOCK ){
  40000. res = 1;
  40001. OSTRACE(("TEST-WR-LOCK file=%p, result=%d (local)\n", pFile->h, res));
  40002. }else{
  40003. res = winLockFile(&pFile->h, SQLITE_LOCKFILEEX_FLAGS,RESERVED_BYTE,0,1,0);
  40004. if( res ){
  40005. winUnlockFile(&pFile->h, RESERVED_BYTE, 0, 1, 0);
  40006. }
  40007. res = !res;
  40008. OSTRACE(("TEST-WR-LOCK file=%p, result=%d (remote)\n", pFile->h, res));
  40009. }
  40010. *pResOut = res;
  40011. OSTRACE(("TEST-WR-LOCK file=%p, pResOut=%p, *pResOut=%d, rc=SQLITE_OK\n",
  40012. pFile->h, pResOut, *pResOut));
  40013. return SQLITE_OK;
  40014. }
  40015. /*
  40016. ** Lower the locking level on file descriptor id to locktype. locktype
  40017. ** must be either NO_LOCK or SHARED_LOCK.
  40018. **
  40019. ** If the locking level of the file descriptor is already at or below
  40020. ** the requested locking level, this routine is a no-op.
  40021. **
  40022. ** It is not possible for this routine to fail if the second argument
  40023. ** is NO_LOCK. If the second argument is SHARED_LOCK then this routine
  40024. ** might return SQLITE_IOERR;
  40025. */
  40026. static int winUnlock(sqlite3_file *id, int locktype){
  40027. int type;
  40028. winFile *pFile = (winFile*)id;
  40029. int rc = SQLITE_OK;
  40030. assert( pFile!=0 );
  40031. assert( locktype<=SHARED_LOCK );
  40032. OSTRACE(("UNLOCK file=%p, oldLock=%d(%d), newLock=%d\n",
  40033. pFile->h, pFile->locktype, pFile->sharedLockByte, locktype));
  40034. type = pFile->locktype;
  40035. if( type>=EXCLUSIVE_LOCK ){
  40036. winUnlockFile(&pFile->h, SHARED_FIRST, 0, SHARED_SIZE, 0);
  40037. if( locktype==SHARED_LOCK && !winGetReadLock(pFile) ){
  40038. /* This should never happen. We should always be able to
  40039. ** reacquire the read lock */
  40040. rc = winLogError(SQLITE_IOERR_UNLOCK, osGetLastError(),
  40041. "winUnlock", pFile->zPath);
  40042. }
  40043. }
  40044. if( type>=RESERVED_LOCK ){
  40045. winUnlockFile(&pFile->h, RESERVED_BYTE, 0, 1, 0);
  40046. }
  40047. if( locktype==NO_LOCK && type>=SHARED_LOCK ){
  40048. winUnlockReadLock(pFile);
  40049. }
  40050. if( type>=PENDING_LOCK ){
  40051. winUnlockFile(&pFile->h, PENDING_BYTE, 0, 1, 0);
  40052. }
  40053. pFile->locktype = (u8)locktype;
  40054. OSTRACE(("UNLOCK file=%p, lock=%d, rc=%s\n",
  40055. pFile->h, pFile->locktype, sqlite3ErrName(rc)));
  40056. return rc;
  40057. }
  40058. /******************************************************************************
  40059. ****************************** No-op Locking **********************************
  40060. **
  40061. ** Of the various locking implementations available, this is by far the
  40062. ** simplest: locking is ignored. No attempt is made to lock the database
  40063. ** file for reading or writing.
  40064. **
  40065. ** This locking mode is appropriate for use on read-only databases
  40066. ** (ex: databases that are burned into CD-ROM, for example.) It can
  40067. ** also be used if the application employs some external mechanism to
  40068. ** prevent simultaneous access of the same database by two or more
  40069. ** database connections. But there is a serious risk of database
  40070. ** corruption if this locking mode is used in situations where multiple
  40071. ** database connections are accessing the same database file at the same
  40072. ** time and one or more of those connections are writing.
  40073. */
  40074. static int winNolockLock(sqlite3_file *id, int locktype){
  40075. UNUSED_PARAMETER(id);
  40076. UNUSED_PARAMETER(locktype);
  40077. return SQLITE_OK;
  40078. }
  40079. static int winNolockCheckReservedLock(sqlite3_file *id, int *pResOut){
  40080. UNUSED_PARAMETER(id);
  40081. UNUSED_PARAMETER(pResOut);
  40082. return SQLITE_OK;
  40083. }
  40084. static int winNolockUnlock(sqlite3_file *id, int locktype){
  40085. UNUSED_PARAMETER(id);
  40086. UNUSED_PARAMETER(locktype);
  40087. return SQLITE_OK;
  40088. }
  40089. /******************* End of the no-op lock implementation *********************
  40090. ******************************************************************************/
  40091. /*
  40092. ** If *pArg is initially negative then this is a query. Set *pArg to
  40093. ** 1 or 0 depending on whether or not bit mask of pFile->ctrlFlags is set.
  40094. **
  40095. ** If *pArg is 0 or 1, then clear or set the mask bit of pFile->ctrlFlags.
  40096. */
  40097. static void winModeBit(winFile *pFile, unsigned char mask, int *pArg){
  40098. if( *pArg<0 ){
  40099. *pArg = (pFile->ctrlFlags & mask)!=0;
  40100. }else if( (*pArg)==0 ){
  40101. pFile->ctrlFlags &= ~mask;
  40102. }else{
  40103. pFile->ctrlFlags |= mask;
  40104. }
  40105. }
  40106. /* Forward references to VFS helper methods used for temporary files */
  40107. static int winGetTempname(sqlite3_vfs *, char **);
  40108. static int winIsDir(const void *);
  40109. static BOOL winIsDriveLetterAndColon(const char *);
  40110. /*
  40111. ** Control and query of the open file handle.
  40112. */
  40113. static int winFileControl(sqlite3_file *id, int op, void *pArg){
  40114. winFile *pFile = (winFile*)id;
  40115. OSTRACE(("FCNTL file=%p, op=%d, pArg=%p\n", pFile->h, op, pArg));
  40116. switch( op ){
  40117. case SQLITE_FCNTL_LOCKSTATE: {
  40118. *(int*)pArg = pFile->locktype;
  40119. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40120. return SQLITE_OK;
  40121. }
  40122. case SQLITE_FCNTL_LAST_ERRNO: {
  40123. *(int*)pArg = (int)pFile->lastErrno;
  40124. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40125. return SQLITE_OK;
  40126. }
  40127. case SQLITE_FCNTL_CHUNK_SIZE: {
  40128. pFile->szChunk = *(int *)pArg;
  40129. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40130. return SQLITE_OK;
  40131. }
  40132. case SQLITE_FCNTL_SIZE_HINT: {
  40133. if( pFile->szChunk>0 ){
  40134. sqlite3_int64 oldSz;
  40135. int rc = winFileSize(id, &oldSz);
  40136. if( rc==SQLITE_OK ){
  40137. sqlite3_int64 newSz = *(sqlite3_int64*)pArg;
  40138. if( newSz>oldSz ){
  40139. SimulateIOErrorBenign(1);
  40140. rc = winTruncate(id, newSz);
  40141. SimulateIOErrorBenign(0);
  40142. }
  40143. }
  40144. OSTRACE(("FCNTL file=%p, rc=%s\n", pFile->h, sqlite3ErrName(rc)));
  40145. return rc;
  40146. }
  40147. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40148. return SQLITE_OK;
  40149. }
  40150. case SQLITE_FCNTL_PERSIST_WAL: {
  40151. winModeBit(pFile, WINFILE_PERSIST_WAL, (int*)pArg);
  40152. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40153. return SQLITE_OK;
  40154. }
  40155. case SQLITE_FCNTL_POWERSAFE_OVERWRITE: {
  40156. winModeBit(pFile, WINFILE_PSOW, (int*)pArg);
  40157. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40158. return SQLITE_OK;
  40159. }
  40160. case SQLITE_FCNTL_VFSNAME: {
  40161. *(char**)pArg = sqlite3_mprintf("%s", pFile->pVfs->zName);
  40162. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40163. return SQLITE_OK;
  40164. }
  40165. case SQLITE_FCNTL_WIN32_AV_RETRY: {
  40166. int *a = (int*)pArg;
  40167. if( a[0]>0 ){
  40168. winIoerrRetry = a[0];
  40169. }else{
  40170. a[0] = winIoerrRetry;
  40171. }
  40172. if( a[1]>0 ){
  40173. winIoerrRetryDelay = a[1];
  40174. }else{
  40175. a[1] = winIoerrRetryDelay;
  40176. }
  40177. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40178. return SQLITE_OK;
  40179. }
  40180. case SQLITE_FCNTL_WIN32_GET_HANDLE: {
  40181. LPHANDLE phFile = (LPHANDLE)pArg;
  40182. *phFile = pFile->h;
  40183. OSTRACE(("FCNTL file=%p, rc=SQLITE_OK\n", pFile->h));
  40184. return SQLITE_OK;
  40185. }
  40186. #ifdef SQLITE_TEST
  40187. case SQLITE_FCNTL_WIN32_SET_HANDLE: {
  40188. LPHANDLE phFile = (LPHANDLE)pArg;
  40189. HANDLE hOldFile = pFile->h;
  40190. pFile->h = *phFile;
  40191. *phFile = hOldFile;
  40192. OSTRACE(("FCNTL oldFile=%p, newFile=%p, rc=SQLITE_OK\n",
  40193. hOldFile, pFile->h));
  40194. return SQLITE_OK;
  40195. }
  40196. #endif
  40197. case SQLITE_FCNTL_TEMPFILENAME: {
  40198. char *zTFile = 0;
  40199. int rc = winGetTempname(pFile->pVfs, &zTFile);
  40200. if( rc==SQLITE_OK ){
  40201. *(char**)pArg = zTFile;
  40202. }
  40203. OSTRACE(("FCNTL file=%p, rc=%s\n", pFile->h, sqlite3ErrName(rc)));
  40204. return rc;
  40205. }
  40206. #if SQLITE_MAX_MMAP_SIZE>0
  40207. case SQLITE_FCNTL_MMAP_SIZE: {
  40208. i64 newLimit = *(i64*)pArg;
  40209. int rc = SQLITE_OK;
  40210. if( newLimit>sqlite3GlobalConfig.mxMmap ){
  40211. newLimit = sqlite3GlobalConfig.mxMmap;
  40212. }
  40213. /* The value of newLimit may be eventually cast to (SIZE_T) and passed
  40214. ** to MapViewOfFile(). Restrict its value to 2GB if (SIZE_T) is not at
  40215. ** least a 64-bit type. */
  40216. if( newLimit>0 && sizeof(SIZE_T)<8 ){
  40217. newLimit = (newLimit & 0x7FFFFFFF);
  40218. }
  40219. *(i64*)pArg = pFile->mmapSizeMax;
  40220. if( newLimit>=0 && newLimit!=pFile->mmapSizeMax && pFile->nFetchOut==0 ){
  40221. pFile->mmapSizeMax = newLimit;
  40222. if( pFile->mmapSize>0 ){
  40223. winUnmapfile(pFile);
  40224. rc = winMapfile(pFile, -1);
  40225. }
  40226. }
  40227. OSTRACE(("FCNTL file=%p, rc=%s\n", pFile->h, sqlite3ErrName(rc)));
  40228. return rc;
  40229. }
  40230. #endif
  40231. }
  40232. OSTRACE(("FCNTL file=%p, rc=SQLITE_NOTFOUND\n", pFile->h));
  40233. return SQLITE_NOTFOUND;
  40234. }
  40235. /*
  40236. ** Return the sector size in bytes of the underlying block device for
  40237. ** the specified file. This is almost always 512 bytes, but may be
  40238. ** larger for some devices.
  40239. **
  40240. ** SQLite code assumes this function cannot fail. It also assumes that
  40241. ** if two files are created in the same file-system directory (i.e.
  40242. ** a database and its journal file) that the sector size will be the
  40243. ** same for both.
  40244. */
  40245. static int winSectorSize(sqlite3_file *id){
  40246. (void)id;
  40247. return SQLITE_DEFAULT_SECTOR_SIZE;
  40248. }
  40249. /*
  40250. ** Return a vector of device characteristics.
  40251. */
  40252. static int winDeviceCharacteristics(sqlite3_file *id){
  40253. winFile *p = (winFile*)id;
  40254. return SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN |
  40255. ((p->ctrlFlags & WINFILE_PSOW)?SQLITE_IOCAP_POWERSAFE_OVERWRITE:0);
  40256. }
  40257. /*
  40258. ** Windows will only let you create file view mappings
  40259. ** on allocation size granularity boundaries.
  40260. ** During sqlite3_os_init() we do a GetSystemInfo()
  40261. ** to get the granularity size.
  40262. */
  40263. static SYSTEM_INFO winSysInfo;
  40264. #ifndef SQLITE_OMIT_WAL
  40265. /*
  40266. ** Helper functions to obtain and relinquish the global mutex. The
  40267. ** global mutex is used to protect the winLockInfo objects used by
  40268. ** this file, all of which may be shared by multiple threads.
  40269. **
  40270. ** Function winShmMutexHeld() is used to assert() that the global mutex
  40271. ** is held when required. This function is only used as part of assert()
  40272. ** statements. e.g.
  40273. **
  40274. ** winShmEnterMutex()
  40275. ** assert( winShmMutexHeld() );
  40276. ** winShmLeaveMutex()
  40277. */
  40278. static sqlite3_mutex *winBigLock = 0;
  40279. static void winShmEnterMutex(void){
  40280. sqlite3_mutex_enter(winBigLock);
  40281. }
  40282. static void winShmLeaveMutex(void){
  40283. sqlite3_mutex_leave(winBigLock);
  40284. }
  40285. #ifndef NDEBUG
  40286. static int winShmMutexHeld(void) {
  40287. return sqlite3_mutex_held(winBigLock);
  40288. }
  40289. #endif
  40290. /*
  40291. ** Object used to represent a single file opened and mmapped to provide
  40292. ** shared memory. When multiple threads all reference the same
  40293. ** log-summary, each thread has its own winFile object, but they all
  40294. ** point to a single instance of this object. In other words, each
  40295. ** log-summary is opened only once per process.
  40296. **
  40297. ** winShmMutexHeld() must be true when creating or destroying
  40298. ** this object or while reading or writing the following fields:
  40299. **
  40300. ** nRef
  40301. ** pNext
  40302. **
  40303. ** The following fields are read-only after the object is created:
  40304. **
  40305. ** fid
  40306. ** zFilename
  40307. **
  40308. ** Either winShmNode.mutex must be held or winShmNode.nRef==0 and
  40309. ** winShmMutexHeld() is true when reading or writing any other field
  40310. ** in this structure.
  40311. **
  40312. */
  40313. struct winShmNode {
  40314. sqlite3_mutex *mutex; /* Mutex to access this object */
  40315. char *zFilename; /* Name of the file */
  40316. winFile hFile; /* File handle from winOpen */
  40317. int szRegion; /* Size of shared-memory regions */
  40318. int nRegion; /* Size of array apRegion */
  40319. u8 isReadonly; /* True if read-only */
  40320. u8 isUnlocked; /* True if no DMS lock held */
  40321. struct ShmRegion {
  40322. HANDLE hMap; /* File handle from CreateFileMapping */
  40323. void *pMap;
  40324. } *aRegion;
  40325. DWORD lastErrno; /* The Windows errno from the last I/O error */
  40326. int nRef; /* Number of winShm objects pointing to this */
  40327. winShm *pFirst; /* All winShm objects pointing to this */
  40328. winShmNode *pNext; /* Next in list of all winShmNode objects */
  40329. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  40330. u8 nextShmId; /* Next available winShm.id value */
  40331. #endif
  40332. };
  40333. /*
  40334. ** A global array of all winShmNode objects.
  40335. **
  40336. ** The winShmMutexHeld() must be true while reading or writing this list.
  40337. */
  40338. static winShmNode *winShmNodeList = 0;
  40339. /*
  40340. ** Structure used internally by this VFS to record the state of an
  40341. ** open shared memory connection.
  40342. **
  40343. ** The following fields are initialized when this object is created and
  40344. ** are read-only thereafter:
  40345. **
  40346. ** winShm.pShmNode
  40347. ** winShm.id
  40348. **
  40349. ** All other fields are read/write. The winShm.pShmNode->mutex must be held
  40350. ** while accessing any read/write fields.
  40351. */
  40352. struct winShm {
  40353. winShmNode *pShmNode; /* The underlying winShmNode object */
  40354. winShm *pNext; /* Next winShm with the same winShmNode */
  40355. u8 hasMutex; /* True if holding the winShmNode mutex */
  40356. u16 sharedMask; /* Mask of shared locks held */
  40357. u16 exclMask; /* Mask of exclusive locks held */
  40358. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  40359. u8 id; /* Id of this connection with its winShmNode */
  40360. #endif
  40361. };
  40362. /*
  40363. ** Constants used for locking
  40364. */
  40365. #define WIN_SHM_BASE ((22+SQLITE_SHM_NLOCK)*4) /* first lock byte */
  40366. #define WIN_SHM_DMS (WIN_SHM_BASE+SQLITE_SHM_NLOCK) /* deadman switch */
  40367. /*
  40368. ** Apply advisory locks for all n bytes beginning at ofst.
  40369. */
  40370. #define WINSHM_UNLCK 1
  40371. #define WINSHM_RDLCK 2
  40372. #define WINSHM_WRLCK 3
  40373. static int winShmSystemLock(
  40374. winShmNode *pFile, /* Apply locks to this open shared-memory segment */
  40375. int lockType, /* WINSHM_UNLCK, WINSHM_RDLCK, or WINSHM_WRLCK */
  40376. int ofst, /* Offset to first byte to be locked/unlocked */
  40377. int nByte /* Number of bytes to lock or unlock */
  40378. ){
  40379. int rc = 0; /* Result code form Lock/UnlockFileEx() */
  40380. /* Access to the winShmNode object is serialized by the caller */
  40381. assert( pFile->nRef==0 || sqlite3_mutex_held(pFile->mutex) );
  40382. OSTRACE(("SHM-LOCK file=%p, lock=%d, offset=%d, size=%d\n",
  40383. pFile->hFile.h, lockType, ofst, nByte));
  40384. /* Release/Acquire the system-level lock */
  40385. if( lockType==WINSHM_UNLCK ){
  40386. rc = winUnlockFile(&pFile->hFile.h, ofst, 0, nByte, 0);
  40387. }else{
  40388. /* Initialize the locking parameters */
  40389. DWORD dwFlags = LOCKFILE_FAIL_IMMEDIATELY;
  40390. if( lockType == WINSHM_WRLCK ) dwFlags |= LOCKFILE_EXCLUSIVE_LOCK;
  40391. rc = winLockFile(&pFile->hFile.h, dwFlags, ofst, 0, nByte, 0);
  40392. }
  40393. if( rc!= 0 ){
  40394. rc = SQLITE_OK;
  40395. }else{
  40396. pFile->lastErrno = osGetLastError();
  40397. rc = SQLITE_BUSY;
  40398. }
  40399. OSTRACE(("SHM-LOCK file=%p, func=%s, errno=%lu, rc=%s\n",
  40400. pFile->hFile.h, (lockType == WINSHM_UNLCK) ? "winUnlockFile" :
  40401. "winLockFile", pFile->lastErrno, sqlite3ErrName(rc)));
  40402. return rc;
  40403. }
  40404. /* Forward references to VFS methods */
  40405. static int winOpen(sqlite3_vfs*,const char*,sqlite3_file*,int,int*);
  40406. static int winDelete(sqlite3_vfs *,const char*,int);
  40407. /*
  40408. ** Purge the winShmNodeList list of all entries with winShmNode.nRef==0.
  40409. **
  40410. ** This is not a VFS shared-memory method; it is a utility function called
  40411. ** by VFS shared-memory methods.
  40412. */
  40413. static void winShmPurge(sqlite3_vfs *pVfs, int deleteFlag){
  40414. winShmNode **pp;
  40415. winShmNode *p;
  40416. assert( winShmMutexHeld() );
  40417. OSTRACE(("SHM-PURGE pid=%lu, deleteFlag=%d\n",
  40418. osGetCurrentProcessId(), deleteFlag));
  40419. pp = &winShmNodeList;
  40420. while( (p = *pp)!=0 ){
  40421. if( p->nRef==0 ){
  40422. int i;
  40423. if( p->mutex ){ sqlite3_mutex_free(p->mutex); }
  40424. for(i=0; i<p->nRegion; i++){
  40425. BOOL bRc = osUnmapViewOfFile(p->aRegion[i].pMap);
  40426. OSTRACE(("SHM-PURGE-UNMAP pid=%lu, region=%d, rc=%s\n",
  40427. osGetCurrentProcessId(), i, bRc ? "ok" : "failed"));
  40428. UNUSED_VARIABLE_VALUE(bRc);
  40429. bRc = osCloseHandle(p->aRegion[i].hMap);
  40430. OSTRACE(("SHM-PURGE-CLOSE pid=%lu, region=%d, rc=%s\n",
  40431. osGetCurrentProcessId(), i, bRc ? "ok" : "failed"));
  40432. UNUSED_VARIABLE_VALUE(bRc);
  40433. }
  40434. if( p->hFile.h!=NULL && p->hFile.h!=INVALID_HANDLE_VALUE ){
  40435. SimulateIOErrorBenign(1);
  40436. winClose((sqlite3_file *)&p->hFile);
  40437. SimulateIOErrorBenign(0);
  40438. }
  40439. if( deleteFlag ){
  40440. SimulateIOErrorBenign(1);
  40441. sqlite3BeginBenignMalloc();
  40442. winDelete(pVfs, p->zFilename, 0);
  40443. sqlite3EndBenignMalloc();
  40444. SimulateIOErrorBenign(0);
  40445. }
  40446. *pp = p->pNext;
  40447. sqlite3_free(p->aRegion);
  40448. sqlite3_free(p);
  40449. }else{
  40450. pp = &p->pNext;
  40451. }
  40452. }
  40453. }
  40454. /*
  40455. ** The DMS lock has not yet been taken on shm file pShmNode. Attempt to
  40456. ** take it now. Return SQLITE_OK if successful, or an SQLite error
  40457. ** code otherwise.
  40458. **
  40459. ** If the DMS cannot be locked because this is a readonly_shm=1
  40460. ** connection and no other process already holds a lock, return
  40461. ** SQLITE_READONLY_CANTINIT and set pShmNode->isUnlocked=1.
  40462. */
  40463. static int winLockSharedMemory(winShmNode *pShmNode){
  40464. int rc = winShmSystemLock(pShmNode, WINSHM_WRLCK, WIN_SHM_DMS, 1);
  40465. if( rc==SQLITE_OK ){
  40466. if( pShmNode->isReadonly ){
  40467. pShmNode->isUnlocked = 1;
  40468. winShmSystemLock(pShmNode, WINSHM_UNLCK, WIN_SHM_DMS, 1);
  40469. return SQLITE_READONLY_CANTINIT;
  40470. }else if( winTruncate((sqlite3_file*)&pShmNode->hFile, 0) ){
  40471. winShmSystemLock(pShmNode, WINSHM_UNLCK, WIN_SHM_DMS, 1);
  40472. return winLogError(SQLITE_IOERR_SHMOPEN, osGetLastError(),
  40473. "winLockSharedMemory", pShmNode->zFilename);
  40474. }
  40475. }
  40476. if( rc==SQLITE_OK ){
  40477. winShmSystemLock(pShmNode, WINSHM_UNLCK, WIN_SHM_DMS, 1);
  40478. }
  40479. return winShmSystemLock(pShmNode, WINSHM_RDLCK, WIN_SHM_DMS, 1);
  40480. }
  40481. /*
  40482. ** Open the shared-memory area associated with database file pDbFd.
  40483. **
  40484. ** When opening a new shared-memory file, if no other instances of that
  40485. ** file are currently open, in this process or in other processes, then
  40486. ** the file must be truncated to zero length or have its header cleared.
  40487. */
  40488. static int winOpenSharedMemory(winFile *pDbFd){
  40489. struct winShm *p; /* The connection to be opened */
  40490. winShmNode *pShmNode = 0; /* The underlying mmapped file */
  40491. int rc = SQLITE_OK; /* Result code */
  40492. winShmNode *pNew; /* Newly allocated winShmNode */
  40493. int nName; /* Size of zName in bytes */
  40494. assert( pDbFd->pShm==0 ); /* Not previously opened */
  40495. /* Allocate space for the new sqlite3_shm object. Also speculatively
  40496. ** allocate space for a new winShmNode and filename.
  40497. */
  40498. p = sqlite3MallocZero( sizeof(*p) );
  40499. if( p==0 ) return SQLITE_IOERR_NOMEM_BKPT;
  40500. nName = sqlite3Strlen30(pDbFd->zPath);
  40501. pNew = sqlite3MallocZero( sizeof(*pShmNode) + nName + 17 );
  40502. if( pNew==0 ){
  40503. sqlite3_free(p);
  40504. return SQLITE_IOERR_NOMEM_BKPT;
  40505. }
  40506. pNew->zFilename = (char*)&pNew[1];
  40507. sqlite3_snprintf(nName+15, pNew->zFilename, "%s-shm", pDbFd->zPath);
  40508. sqlite3FileSuffix3(pDbFd->zPath, pNew->zFilename);
  40509. /* Look to see if there is an existing winShmNode that can be used.
  40510. ** If no matching winShmNode currently exists, create a new one.
  40511. */
  40512. winShmEnterMutex();
  40513. for(pShmNode = winShmNodeList; pShmNode; pShmNode=pShmNode->pNext){
  40514. /* TBD need to come up with better match here. Perhaps
  40515. ** use FILE_ID_BOTH_DIR_INFO Structure.
  40516. */
  40517. if( sqlite3StrICmp(pShmNode->zFilename, pNew->zFilename)==0 ) break;
  40518. }
  40519. if( pShmNode ){
  40520. sqlite3_free(pNew);
  40521. }else{
  40522. int inFlags = SQLITE_OPEN_WAL;
  40523. int outFlags = 0;
  40524. pShmNode = pNew;
  40525. pNew = 0;
  40526. ((winFile*)(&pShmNode->hFile))->h = INVALID_HANDLE_VALUE;
  40527. pShmNode->pNext = winShmNodeList;
  40528. winShmNodeList = pShmNode;
  40529. if( sqlite3GlobalConfig.bCoreMutex ){
  40530. pShmNode->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_FAST);
  40531. if( pShmNode->mutex==0 ){
  40532. rc = SQLITE_IOERR_NOMEM_BKPT;
  40533. goto shm_open_err;
  40534. }
  40535. }
  40536. if( 0==sqlite3_uri_boolean(pDbFd->zPath, "readonly_shm", 0) ){
  40537. inFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
  40538. }else{
  40539. inFlags |= SQLITE_OPEN_READONLY;
  40540. }
  40541. rc = winOpen(pDbFd->pVfs, pShmNode->zFilename,
  40542. (sqlite3_file*)&pShmNode->hFile,
  40543. inFlags, &outFlags);
  40544. if( rc!=SQLITE_OK ){
  40545. rc = winLogError(rc, osGetLastError(), "winOpenShm",
  40546. pShmNode->zFilename);
  40547. goto shm_open_err;
  40548. }
  40549. if( outFlags==SQLITE_OPEN_READONLY ) pShmNode->isReadonly = 1;
  40550. rc = winLockSharedMemory(pShmNode);
  40551. if( rc!=SQLITE_OK && rc!=SQLITE_READONLY_CANTINIT ) goto shm_open_err;
  40552. }
  40553. /* Make the new connection a child of the winShmNode */
  40554. p->pShmNode = pShmNode;
  40555. #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
  40556. p->id = pShmNode->nextShmId++;
  40557. #endif
  40558. pShmNode->nRef++;
  40559. pDbFd->pShm = p;
  40560. winShmLeaveMutex();
  40561. /* The reference count on pShmNode has already been incremented under
  40562. ** the cover of the winShmEnterMutex() mutex and the pointer from the
  40563. ** new (struct winShm) object to the pShmNode has been set. All that is
  40564. ** left to do is to link the new object into the linked list starting
  40565. ** at pShmNode->pFirst. This must be done while holding the pShmNode->mutex
  40566. ** mutex.
  40567. */
  40568. sqlite3_mutex_enter(pShmNode->mutex);
  40569. p->pNext = pShmNode->pFirst;
  40570. pShmNode->pFirst = p;
  40571. sqlite3_mutex_leave(pShmNode->mutex);
  40572. return rc;
  40573. /* Jump here on any error */
  40574. shm_open_err:
  40575. winShmSystemLock(pShmNode, WINSHM_UNLCK, WIN_SHM_DMS, 1);
  40576. winShmPurge(pDbFd->pVfs, 0); /* This call frees pShmNode if required */
  40577. sqlite3_free(p);
  40578. sqlite3_free(pNew);
  40579. winShmLeaveMutex();
  40580. return rc;
  40581. }
  40582. /*
  40583. ** Close a connection to shared-memory. Delete the underlying
  40584. ** storage if deleteFlag is true.
  40585. */
  40586. static int winShmUnmap(
  40587. sqlite3_file *fd, /* Database holding shared memory */
  40588. int deleteFlag /* Delete after closing if true */
  40589. ){
  40590. winFile *pDbFd; /* Database holding shared-memory */
  40591. winShm *p; /* The connection to be closed */
  40592. winShmNode *pShmNode; /* The underlying shared-memory file */
  40593. winShm **pp; /* For looping over sibling connections */
  40594. pDbFd = (winFile*)fd;
  40595. p = pDbFd->pShm;
  40596. if( p==0 ) return SQLITE_OK;
  40597. pShmNode = p->pShmNode;
  40598. /* Remove connection p from the set of connections associated
  40599. ** with pShmNode */
  40600. sqlite3_mutex_enter(pShmNode->mutex);
  40601. for(pp=&pShmNode->pFirst; (*pp)!=p; pp = &(*pp)->pNext){}
  40602. *pp = p->pNext;
  40603. /* Free the connection p */
  40604. sqlite3_free(p);
  40605. pDbFd->pShm = 0;
  40606. sqlite3_mutex_leave(pShmNode->mutex);
  40607. /* If pShmNode->nRef has reached 0, then close the underlying
  40608. ** shared-memory file, too */
  40609. winShmEnterMutex();
  40610. assert( pShmNode->nRef>0 );
  40611. pShmNode->nRef--;
  40612. if( pShmNode->nRef==0 ){
  40613. winShmPurge(pDbFd->pVfs, deleteFlag);
  40614. }
  40615. winShmLeaveMutex();
  40616. return SQLITE_OK;
  40617. }
  40618. /*
  40619. ** Change the lock state for a shared-memory segment.
  40620. */
  40621. static int winShmLock(
  40622. sqlite3_file *fd, /* Database file holding the shared memory */
  40623. int ofst, /* First lock to acquire or release */
  40624. int n, /* Number of locks to acquire or release */
  40625. int flags /* What to do with the lock */
  40626. ){
  40627. winFile *pDbFd = (winFile*)fd; /* Connection holding shared memory */
  40628. winShm *p = pDbFd->pShm; /* The shared memory being locked */
  40629. winShm *pX; /* For looping over all siblings */
  40630. winShmNode *pShmNode = p->pShmNode;
  40631. int rc = SQLITE_OK; /* Result code */
  40632. u16 mask; /* Mask of locks to take or release */
  40633. assert( ofst>=0 && ofst+n<=SQLITE_SHM_NLOCK );
  40634. assert( n>=1 );
  40635. assert( flags==(SQLITE_SHM_LOCK | SQLITE_SHM_SHARED)
  40636. || flags==(SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE)
  40637. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED)
  40638. || flags==(SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE) );
  40639. assert( n==1 || (flags & SQLITE_SHM_EXCLUSIVE)!=0 );
  40640. mask = (u16)((1U<<(ofst+n)) - (1U<<ofst));
  40641. assert( n>1 || mask==(1<<ofst) );
  40642. sqlite3_mutex_enter(pShmNode->mutex);
  40643. if( flags & SQLITE_SHM_UNLOCK ){
  40644. u16 allMask = 0; /* Mask of locks held by siblings */
  40645. /* See if any siblings hold this same lock */
  40646. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  40647. if( pX==p ) continue;
  40648. assert( (pX->exclMask & (p->exclMask|p->sharedMask))==0 );
  40649. allMask |= pX->sharedMask;
  40650. }
  40651. /* Unlock the system-level locks */
  40652. if( (mask & allMask)==0 ){
  40653. rc = winShmSystemLock(pShmNode, WINSHM_UNLCK, ofst+WIN_SHM_BASE, n);
  40654. }else{
  40655. rc = SQLITE_OK;
  40656. }
  40657. /* Undo the local locks */
  40658. if( rc==SQLITE_OK ){
  40659. p->exclMask &= ~mask;
  40660. p->sharedMask &= ~mask;
  40661. }
  40662. }else if( flags & SQLITE_SHM_SHARED ){
  40663. u16 allShared = 0; /* Union of locks held by connections other than "p" */
  40664. /* Find out which shared locks are already held by sibling connections.
  40665. ** If any sibling already holds an exclusive lock, go ahead and return
  40666. ** SQLITE_BUSY.
  40667. */
  40668. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  40669. if( (pX->exclMask & mask)!=0 ){
  40670. rc = SQLITE_BUSY;
  40671. break;
  40672. }
  40673. allShared |= pX->sharedMask;
  40674. }
  40675. /* Get shared locks at the system level, if necessary */
  40676. if( rc==SQLITE_OK ){
  40677. if( (allShared & mask)==0 ){
  40678. rc = winShmSystemLock(pShmNode, WINSHM_RDLCK, ofst+WIN_SHM_BASE, n);
  40679. }else{
  40680. rc = SQLITE_OK;
  40681. }
  40682. }
  40683. /* Get the local shared locks */
  40684. if( rc==SQLITE_OK ){
  40685. p->sharedMask |= mask;
  40686. }
  40687. }else{
  40688. /* Make sure no sibling connections hold locks that will block this
  40689. ** lock. If any do, return SQLITE_BUSY right away.
  40690. */
  40691. for(pX=pShmNode->pFirst; pX; pX=pX->pNext){
  40692. if( (pX->exclMask & mask)!=0 || (pX->sharedMask & mask)!=0 ){
  40693. rc = SQLITE_BUSY;
  40694. break;
  40695. }
  40696. }
  40697. /* Get the exclusive locks at the system level. Then if successful
  40698. ** also mark the local connection as being locked.
  40699. */
  40700. if( rc==SQLITE_OK ){
  40701. rc = winShmSystemLock(pShmNode, WINSHM_WRLCK, ofst+WIN_SHM_BASE, n);
  40702. if( rc==SQLITE_OK ){
  40703. assert( (p->sharedMask & mask)==0 );
  40704. p->exclMask |= mask;
  40705. }
  40706. }
  40707. }
  40708. sqlite3_mutex_leave(pShmNode->mutex);
  40709. OSTRACE(("SHM-LOCK pid=%lu, id=%d, sharedMask=%03x, exclMask=%03x, rc=%s\n",
  40710. osGetCurrentProcessId(), p->id, p->sharedMask, p->exclMask,
  40711. sqlite3ErrName(rc)));
  40712. return rc;
  40713. }
  40714. /*
  40715. ** Implement a memory barrier or memory fence on shared memory.
  40716. **
  40717. ** All loads and stores begun before the barrier must complete before
  40718. ** any load or store begun after the barrier.
  40719. */
  40720. static void winShmBarrier(
  40721. sqlite3_file *fd /* Database holding the shared memory */
  40722. ){
  40723. UNUSED_PARAMETER(fd);
  40724. sqlite3MemoryBarrier(); /* compiler-defined memory barrier */
  40725. winShmEnterMutex(); /* Also mutex, for redundancy */
  40726. winShmLeaveMutex();
  40727. }
  40728. /*
  40729. ** This function is called to obtain a pointer to region iRegion of the
  40730. ** shared-memory associated with the database file fd. Shared-memory regions
  40731. ** are numbered starting from zero. Each shared-memory region is szRegion
  40732. ** bytes in size.
  40733. **
  40734. ** If an error occurs, an error code is returned and *pp is set to NULL.
  40735. **
  40736. ** Otherwise, if the isWrite parameter is 0 and the requested shared-memory
  40737. ** region has not been allocated (by any client, including one running in a
  40738. ** separate process), then *pp is set to NULL and SQLITE_OK returned. If
  40739. ** isWrite is non-zero and the requested shared-memory region has not yet
  40740. ** been allocated, it is allocated by this function.
  40741. **
  40742. ** If the shared-memory region has already been allocated or is allocated by
  40743. ** this call as described above, then it is mapped into this processes
  40744. ** address space (if it is not already), *pp is set to point to the mapped
  40745. ** memory and SQLITE_OK returned.
  40746. */
  40747. static int winShmMap(
  40748. sqlite3_file *fd, /* Handle open on database file */
  40749. int iRegion, /* Region to retrieve */
  40750. int szRegion, /* Size of regions */
  40751. int isWrite, /* True to extend file if necessary */
  40752. void volatile **pp /* OUT: Mapped memory */
  40753. ){
  40754. winFile *pDbFd = (winFile*)fd;
  40755. winShm *pShm = pDbFd->pShm;
  40756. winShmNode *pShmNode;
  40757. DWORD protect = PAGE_READWRITE;
  40758. DWORD flags = FILE_MAP_WRITE | FILE_MAP_READ;
  40759. int rc = SQLITE_OK;
  40760. if( !pShm ){
  40761. rc = winOpenSharedMemory(pDbFd);
  40762. if( rc!=SQLITE_OK ) return rc;
  40763. pShm = pDbFd->pShm;
  40764. }
  40765. pShmNode = pShm->pShmNode;
  40766. sqlite3_mutex_enter(pShmNode->mutex);
  40767. if( pShmNode->isUnlocked ){
  40768. rc = winLockSharedMemory(pShmNode);
  40769. if( rc!=SQLITE_OK ) goto shmpage_out;
  40770. pShmNode->isUnlocked = 0;
  40771. }
  40772. assert( szRegion==pShmNode->szRegion || pShmNode->nRegion==0 );
  40773. if( pShmNode->nRegion<=iRegion ){
  40774. struct ShmRegion *apNew; /* New aRegion[] array */
  40775. int nByte = (iRegion+1)*szRegion; /* Minimum required file size */
  40776. sqlite3_int64 sz; /* Current size of wal-index file */
  40777. pShmNode->szRegion = szRegion;
  40778. /* The requested region is not mapped into this processes address space.
  40779. ** Check to see if it has been allocated (i.e. if the wal-index file is
  40780. ** large enough to contain the requested region).
  40781. */
  40782. rc = winFileSize((sqlite3_file *)&pShmNode->hFile, &sz);
  40783. if( rc!=SQLITE_OK ){
  40784. rc = winLogError(SQLITE_IOERR_SHMSIZE, osGetLastError(),
  40785. "winShmMap1", pDbFd->zPath);
  40786. goto shmpage_out;
  40787. }
  40788. if( sz<nByte ){
  40789. /* The requested memory region does not exist. If isWrite is set to
  40790. ** zero, exit early. *pp will be set to NULL and SQLITE_OK returned.
  40791. **
  40792. ** Alternatively, if isWrite is non-zero, use ftruncate() to allocate
  40793. ** the requested memory region.
  40794. */
  40795. if( !isWrite ) goto shmpage_out;
  40796. rc = winTruncate((sqlite3_file *)&pShmNode->hFile, nByte);
  40797. if( rc!=SQLITE_OK ){
  40798. rc = winLogError(SQLITE_IOERR_SHMSIZE, osGetLastError(),
  40799. "winShmMap2", pDbFd->zPath);
  40800. goto shmpage_out;
  40801. }
  40802. }
  40803. /* Map the requested memory region into this processes address space. */
  40804. apNew = (struct ShmRegion *)sqlite3_realloc64(
  40805. pShmNode->aRegion, (iRegion+1)*sizeof(apNew[0])
  40806. );
  40807. if( !apNew ){
  40808. rc = SQLITE_IOERR_NOMEM_BKPT;
  40809. goto shmpage_out;
  40810. }
  40811. pShmNode->aRegion = apNew;
  40812. if( pShmNode->isReadonly ){
  40813. protect = PAGE_READONLY;
  40814. flags = FILE_MAP_READ;
  40815. }
  40816. while( pShmNode->nRegion<=iRegion ){
  40817. HANDLE hMap = NULL; /* file-mapping handle */
  40818. void *pMap = 0; /* Mapped memory region */
  40819. #if SQLITE_OS_WINRT
  40820. hMap = osCreateFileMappingFromApp(pShmNode->hFile.h,
  40821. NULL, protect, nByte, NULL
  40822. );
  40823. #elif defined(SQLITE_WIN32_HAS_WIDE)
  40824. hMap = osCreateFileMappingW(pShmNode->hFile.h,
  40825. NULL, protect, 0, nByte, NULL
  40826. );
  40827. #elif defined(SQLITE_WIN32_HAS_ANSI) && SQLITE_WIN32_CREATEFILEMAPPINGA
  40828. hMap = osCreateFileMappingA(pShmNode->hFile.h,
  40829. NULL, protect, 0, nByte, NULL
  40830. );
  40831. #endif
  40832. OSTRACE(("SHM-MAP-CREATE pid=%lu, region=%d, size=%d, rc=%s\n",
  40833. osGetCurrentProcessId(), pShmNode->nRegion, nByte,
  40834. hMap ? "ok" : "failed"));
  40835. if( hMap ){
  40836. int iOffset = pShmNode->nRegion*szRegion;
  40837. int iOffsetShift = iOffset % winSysInfo.dwAllocationGranularity;
  40838. #if SQLITE_OS_WINRT
  40839. pMap = osMapViewOfFileFromApp(hMap, flags,
  40840. iOffset - iOffsetShift, szRegion + iOffsetShift
  40841. );
  40842. #else
  40843. pMap = osMapViewOfFile(hMap, flags,
  40844. 0, iOffset - iOffsetShift, szRegion + iOffsetShift
  40845. );
  40846. #endif
  40847. OSTRACE(("SHM-MAP-MAP pid=%lu, region=%d, offset=%d, size=%d, rc=%s\n",
  40848. osGetCurrentProcessId(), pShmNode->nRegion, iOffset,
  40849. szRegion, pMap ? "ok" : "failed"));
  40850. }
  40851. if( !pMap ){
  40852. pShmNode->lastErrno = osGetLastError();
  40853. rc = winLogError(SQLITE_IOERR_SHMMAP, pShmNode->lastErrno,
  40854. "winShmMap3", pDbFd->zPath);
  40855. if( hMap ) osCloseHandle(hMap);
  40856. goto shmpage_out;
  40857. }
  40858. pShmNode->aRegion[pShmNode->nRegion].pMap = pMap;
  40859. pShmNode->aRegion[pShmNode->nRegion].hMap = hMap;
  40860. pShmNode->nRegion++;
  40861. }
  40862. }
  40863. shmpage_out:
  40864. if( pShmNode->nRegion>iRegion ){
  40865. int iOffset = iRegion*szRegion;
  40866. int iOffsetShift = iOffset % winSysInfo.dwAllocationGranularity;
  40867. char *p = (char *)pShmNode->aRegion[iRegion].pMap;
  40868. *pp = (void *)&p[iOffsetShift];
  40869. }else{
  40870. *pp = 0;
  40871. }
  40872. if( pShmNode->isReadonly && rc==SQLITE_OK ) rc = SQLITE_READONLY;
  40873. sqlite3_mutex_leave(pShmNode->mutex);
  40874. return rc;
  40875. }
  40876. #else
  40877. # define winShmMap 0
  40878. # define winShmLock 0
  40879. # define winShmBarrier 0
  40880. # define winShmUnmap 0
  40881. #endif /* #ifndef SQLITE_OMIT_WAL */
  40882. /*
  40883. ** Cleans up the mapped region of the specified file, if any.
  40884. */
  40885. #if SQLITE_MAX_MMAP_SIZE>0
  40886. static int winUnmapfile(winFile *pFile){
  40887. assert( pFile!=0 );
  40888. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, hMap=%p, pMapRegion=%p, "
  40889. "mmapSize=%lld, mmapSizeActual=%lld, mmapSizeMax=%lld\n",
  40890. osGetCurrentProcessId(), pFile, pFile->hMap, pFile->pMapRegion,
  40891. pFile->mmapSize, pFile->mmapSizeActual, pFile->mmapSizeMax));
  40892. if( pFile->pMapRegion ){
  40893. if( !osUnmapViewOfFile(pFile->pMapRegion) ){
  40894. pFile->lastErrno = osGetLastError();
  40895. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, pMapRegion=%p, "
  40896. "rc=SQLITE_IOERR_MMAP\n", osGetCurrentProcessId(), pFile,
  40897. pFile->pMapRegion));
  40898. return winLogError(SQLITE_IOERR_MMAP, pFile->lastErrno,
  40899. "winUnmapfile1", pFile->zPath);
  40900. }
  40901. pFile->pMapRegion = 0;
  40902. pFile->mmapSize = 0;
  40903. pFile->mmapSizeActual = 0;
  40904. }
  40905. if( pFile->hMap!=NULL ){
  40906. if( !osCloseHandle(pFile->hMap) ){
  40907. pFile->lastErrno = osGetLastError();
  40908. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, hMap=%p, rc=SQLITE_IOERR_MMAP\n",
  40909. osGetCurrentProcessId(), pFile, pFile->hMap));
  40910. return winLogError(SQLITE_IOERR_MMAP, pFile->lastErrno,
  40911. "winUnmapfile2", pFile->zPath);
  40912. }
  40913. pFile->hMap = NULL;
  40914. }
  40915. OSTRACE(("UNMAP-FILE pid=%lu, pFile=%p, rc=SQLITE_OK\n",
  40916. osGetCurrentProcessId(), pFile));
  40917. return SQLITE_OK;
  40918. }
  40919. /*
  40920. ** Memory map or remap the file opened by file-descriptor pFd (if the file
  40921. ** is already mapped, the existing mapping is replaced by the new). Or, if
  40922. ** there already exists a mapping for this file, and there are still
  40923. ** outstanding xFetch() references to it, this function is a no-op.
  40924. **
  40925. ** If parameter nByte is non-negative, then it is the requested size of
  40926. ** the mapping to create. Otherwise, if nByte is less than zero, then the
  40927. ** requested size is the size of the file on disk. The actual size of the
  40928. ** created mapping is either the requested size or the value configured
  40929. ** using SQLITE_FCNTL_MMAP_SIZE, whichever is smaller.
  40930. **
  40931. ** SQLITE_OK is returned if no error occurs (even if the mapping is not
  40932. ** recreated as a result of outstanding references) or an SQLite error
  40933. ** code otherwise.
  40934. */
  40935. static int winMapfile(winFile *pFd, sqlite3_int64 nByte){
  40936. sqlite3_int64 nMap = nByte;
  40937. int rc;
  40938. assert( nMap>=0 || pFd->nFetchOut==0 );
  40939. OSTRACE(("MAP-FILE pid=%lu, pFile=%p, size=%lld\n",
  40940. osGetCurrentProcessId(), pFd, nByte));
  40941. if( pFd->nFetchOut>0 ) return SQLITE_OK;
  40942. if( nMap<0 ){
  40943. rc = winFileSize((sqlite3_file*)pFd, &nMap);
  40944. if( rc ){
  40945. OSTRACE(("MAP-FILE pid=%lu, pFile=%p, rc=SQLITE_IOERR_FSTAT\n",
  40946. osGetCurrentProcessId(), pFd));
  40947. return SQLITE_IOERR_FSTAT;
  40948. }
  40949. }
  40950. if( nMap>pFd->mmapSizeMax ){
  40951. nMap = pFd->mmapSizeMax;
  40952. }
  40953. nMap &= ~(sqlite3_int64)(winSysInfo.dwPageSize - 1);
  40954. if( nMap==0 && pFd->mmapSize>0 ){
  40955. winUnmapfile(pFd);
  40956. }
  40957. if( nMap!=pFd->mmapSize ){
  40958. void *pNew = 0;
  40959. DWORD protect = PAGE_READONLY;
  40960. DWORD flags = FILE_MAP_READ;
  40961. winUnmapfile(pFd);
  40962. #ifdef SQLITE_MMAP_READWRITE
  40963. if( (pFd->ctrlFlags & WINFILE_RDONLY)==0 ){
  40964. protect = PAGE_READWRITE;
  40965. flags |= FILE_MAP_WRITE;
  40966. }
  40967. #endif
  40968. #if SQLITE_OS_WINRT
  40969. pFd->hMap = osCreateFileMappingFromApp(pFd->h, NULL, protect, nMap, NULL);
  40970. #elif defined(SQLITE_WIN32_HAS_WIDE)
  40971. pFd->hMap = osCreateFileMappingW(pFd->h, NULL, protect,
  40972. (DWORD)((nMap>>32) & 0xffffffff),
  40973. (DWORD)(nMap & 0xffffffff), NULL);
  40974. #elif defined(SQLITE_WIN32_HAS_ANSI) && SQLITE_WIN32_CREATEFILEMAPPINGA
  40975. pFd->hMap = osCreateFileMappingA(pFd->h, NULL, protect,
  40976. (DWORD)((nMap>>32) & 0xffffffff),
  40977. (DWORD)(nMap & 0xffffffff), NULL);
  40978. #endif
  40979. if( pFd->hMap==NULL ){
  40980. pFd->lastErrno = osGetLastError();
  40981. rc = winLogError(SQLITE_IOERR_MMAP, pFd->lastErrno,
  40982. "winMapfile1", pFd->zPath);
  40983. /* Log the error, but continue normal operation using xRead/xWrite */
  40984. OSTRACE(("MAP-FILE-CREATE pid=%lu, pFile=%p, rc=%s\n",
  40985. osGetCurrentProcessId(), pFd, sqlite3ErrName(rc)));
  40986. return SQLITE_OK;
  40987. }
  40988. assert( (nMap % winSysInfo.dwPageSize)==0 );
  40989. assert( sizeof(SIZE_T)==sizeof(sqlite3_int64) || nMap<=0xffffffff );
  40990. #if SQLITE_OS_WINRT
  40991. pNew = osMapViewOfFileFromApp(pFd->hMap, flags, 0, (SIZE_T)nMap);
  40992. #else
  40993. pNew = osMapViewOfFile(pFd->hMap, flags, 0, 0, (SIZE_T)nMap);
  40994. #endif
  40995. if( pNew==NULL ){
  40996. osCloseHandle(pFd->hMap);
  40997. pFd->hMap = NULL;
  40998. pFd->lastErrno = osGetLastError();
  40999. rc = winLogError(SQLITE_IOERR_MMAP, pFd->lastErrno,
  41000. "winMapfile2", pFd->zPath);
  41001. /* Log the error, but continue normal operation using xRead/xWrite */
  41002. OSTRACE(("MAP-FILE-MAP pid=%lu, pFile=%p, rc=%s\n",
  41003. osGetCurrentProcessId(), pFd, sqlite3ErrName(rc)));
  41004. return SQLITE_OK;
  41005. }
  41006. pFd->pMapRegion = pNew;
  41007. pFd->mmapSize = nMap;
  41008. pFd->mmapSizeActual = nMap;
  41009. }
  41010. OSTRACE(("MAP-FILE pid=%lu, pFile=%p, rc=SQLITE_OK\n",
  41011. osGetCurrentProcessId(), pFd));
  41012. return SQLITE_OK;
  41013. }
  41014. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  41015. /*
  41016. ** If possible, return a pointer to a mapping of file fd starting at offset
  41017. ** iOff. The mapping must be valid for at least nAmt bytes.
  41018. **
  41019. ** If such a pointer can be obtained, store it in *pp and return SQLITE_OK.
  41020. ** Or, if one cannot but no error occurs, set *pp to 0 and return SQLITE_OK.
  41021. ** Finally, if an error does occur, return an SQLite error code. The final
  41022. ** value of *pp is undefined in this case.
  41023. **
  41024. ** If this function does return a pointer, the caller must eventually
  41025. ** release the reference by calling winUnfetch().
  41026. */
  41027. static int winFetch(sqlite3_file *fd, i64 iOff, int nAmt, void **pp){
  41028. #if SQLITE_MAX_MMAP_SIZE>0
  41029. winFile *pFd = (winFile*)fd; /* The underlying database file */
  41030. #endif
  41031. *pp = 0;
  41032. OSTRACE(("FETCH pid=%lu, pFile=%p, offset=%lld, amount=%d, pp=%p\n",
  41033. osGetCurrentProcessId(), fd, iOff, nAmt, pp));
  41034. #if SQLITE_MAX_MMAP_SIZE>0
  41035. if( pFd->mmapSizeMax>0 ){
  41036. if( pFd->pMapRegion==0 ){
  41037. int rc = winMapfile(pFd, -1);
  41038. if( rc!=SQLITE_OK ){
  41039. OSTRACE(("FETCH pid=%lu, pFile=%p, rc=%s\n",
  41040. osGetCurrentProcessId(), pFd, sqlite3ErrName(rc)));
  41041. return rc;
  41042. }
  41043. }
  41044. if( pFd->mmapSize >= iOff+nAmt ){
  41045. *pp = &((u8 *)pFd->pMapRegion)[iOff];
  41046. pFd->nFetchOut++;
  41047. }
  41048. }
  41049. #endif
  41050. OSTRACE(("FETCH pid=%lu, pFile=%p, pp=%p, *pp=%p, rc=SQLITE_OK\n",
  41051. osGetCurrentProcessId(), fd, pp, *pp));
  41052. return SQLITE_OK;
  41053. }
  41054. /*
  41055. ** If the third argument is non-NULL, then this function releases a
  41056. ** reference obtained by an earlier call to winFetch(). The second
  41057. ** argument passed to this function must be the same as the corresponding
  41058. ** argument that was passed to the winFetch() invocation.
  41059. **
  41060. ** Or, if the third argument is NULL, then this function is being called
  41061. ** to inform the VFS layer that, according to POSIX, any existing mapping
  41062. ** may now be invalid and should be unmapped.
  41063. */
  41064. static int winUnfetch(sqlite3_file *fd, i64 iOff, void *p){
  41065. #if SQLITE_MAX_MMAP_SIZE>0
  41066. winFile *pFd = (winFile*)fd; /* The underlying database file */
  41067. /* If p==0 (unmap the entire file) then there must be no outstanding
  41068. ** xFetch references. Or, if p!=0 (meaning it is an xFetch reference),
  41069. ** then there must be at least one outstanding. */
  41070. assert( (p==0)==(pFd->nFetchOut==0) );
  41071. /* If p!=0, it must match the iOff value. */
  41072. assert( p==0 || p==&((u8 *)pFd->pMapRegion)[iOff] );
  41073. OSTRACE(("UNFETCH pid=%lu, pFile=%p, offset=%lld, p=%p\n",
  41074. osGetCurrentProcessId(), pFd, iOff, p));
  41075. if( p ){
  41076. pFd->nFetchOut--;
  41077. }else{
  41078. /* FIXME: If Windows truly always prevents truncating or deleting a
  41079. ** file while a mapping is held, then the following winUnmapfile() call
  41080. ** is unnecessary can be omitted - potentially improving
  41081. ** performance. */
  41082. winUnmapfile(pFd);
  41083. }
  41084. assert( pFd->nFetchOut>=0 );
  41085. #endif
  41086. OSTRACE(("UNFETCH pid=%lu, pFile=%p, rc=SQLITE_OK\n",
  41087. osGetCurrentProcessId(), fd));
  41088. return SQLITE_OK;
  41089. }
  41090. /*
  41091. ** Here ends the implementation of all sqlite3_file methods.
  41092. **
  41093. ********************** End sqlite3_file Methods *******************************
  41094. ******************************************************************************/
  41095. /*
  41096. ** This vector defines all the methods that can operate on an
  41097. ** sqlite3_file for win32.
  41098. */
  41099. static const sqlite3_io_methods winIoMethod = {
  41100. 3, /* iVersion */
  41101. winClose, /* xClose */
  41102. winRead, /* xRead */
  41103. winWrite, /* xWrite */
  41104. winTruncate, /* xTruncate */
  41105. winSync, /* xSync */
  41106. winFileSize, /* xFileSize */
  41107. winLock, /* xLock */
  41108. winUnlock, /* xUnlock */
  41109. winCheckReservedLock, /* xCheckReservedLock */
  41110. winFileControl, /* xFileControl */
  41111. winSectorSize, /* xSectorSize */
  41112. winDeviceCharacteristics, /* xDeviceCharacteristics */
  41113. winShmMap, /* xShmMap */
  41114. winShmLock, /* xShmLock */
  41115. winShmBarrier, /* xShmBarrier */
  41116. winShmUnmap, /* xShmUnmap */
  41117. winFetch, /* xFetch */
  41118. winUnfetch /* xUnfetch */
  41119. };
  41120. /*
  41121. ** This vector defines all the methods that can operate on an
  41122. ** sqlite3_file for win32 without performing any locking.
  41123. */
  41124. static const sqlite3_io_methods winIoNolockMethod = {
  41125. 3, /* iVersion */
  41126. winClose, /* xClose */
  41127. winRead, /* xRead */
  41128. winWrite, /* xWrite */
  41129. winTruncate, /* xTruncate */
  41130. winSync, /* xSync */
  41131. winFileSize, /* xFileSize */
  41132. winNolockLock, /* xLock */
  41133. winNolockUnlock, /* xUnlock */
  41134. winNolockCheckReservedLock, /* xCheckReservedLock */
  41135. winFileControl, /* xFileControl */
  41136. winSectorSize, /* xSectorSize */
  41137. winDeviceCharacteristics, /* xDeviceCharacteristics */
  41138. winShmMap, /* xShmMap */
  41139. winShmLock, /* xShmLock */
  41140. winShmBarrier, /* xShmBarrier */
  41141. winShmUnmap, /* xShmUnmap */
  41142. winFetch, /* xFetch */
  41143. winUnfetch /* xUnfetch */
  41144. };
  41145. static winVfsAppData winAppData = {
  41146. &winIoMethod, /* pMethod */
  41147. 0, /* pAppData */
  41148. 0 /* bNoLock */
  41149. };
  41150. static winVfsAppData winNolockAppData = {
  41151. &winIoNolockMethod, /* pMethod */
  41152. 0, /* pAppData */
  41153. 1 /* bNoLock */
  41154. };
  41155. /****************************************************************************
  41156. **************************** sqlite3_vfs methods ****************************
  41157. **
  41158. ** This division contains the implementation of methods on the
  41159. ** sqlite3_vfs object.
  41160. */
  41161. #if defined(__CYGWIN__)
  41162. /*
  41163. ** Convert a filename from whatever the underlying operating system
  41164. ** supports for filenames into UTF-8. Space to hold the result is
  41165. ** obtained from malloc and must be freed by the calling function.
  41166. */
  41167. static char *winConvertToUtf8Filename(const void *zFilename){
  41168. char *zConverted = 0;
  41169. if( osIsNT() ){
  41170. zConverted = winUnicodeToUtf8(zFilename);
  41171. }
  41172. #ifdef SQLITE_WIN32_HAS_ANSI
  41173. else{
  41174. zConverted = winMbcsToUtf8(zFilename, osAreFileApisANSI());
  41175. }
  41176. #endif
  41177. /* caller will handle out of memory */
  41178. return zConverted;
  41179. }
  41180. #endif
  41181. /*
  41182. ** Convert a UTF-8 filename into whatever form the underlying
  41183. ** operating system wants filenames in. Space to hold the result
  41184. ** is obtained from malloc and must be freed by the calling
  41185. ** function.
  41186. */
  41187. static void *winConvertFromUtf8Filename(const char *zFilename){
  41188. void *zConverted = 0;
  41189. if( osIsNT() ){
  41190. zConverted = winUtf8ToUnicode(zFilename);
  41191. }
  41192. #ifdef SQLITE_WIN32_HAS_ANSI
  41193. else{
  41194. zConverted = winUtf8ToMbcs(zFilename, osAreFileApisANSI());
  41195. }
  41196. #endif
  41197. /* caller will handle out of memory */
  41198. return zConverted;
  41199. }
  41200. /*
  41201. ** This function returns non-zero if the specified UTF-8 string buffer
  41202. ** ends with a directory separator character or one was successfully
  41203. ** added to it.
  41204. */
  41205. static int winMakeEndInDirSep(int nBuf, char *zBuf){
  41206. if( zBuf ){
  41207. int nLen = sqlite3Strlen30(zBuf);
  41208. if( nLen>0 ){
  41209. if( winIsDirSep(zBuf[nLen-1]) ){
  41210. return 1;
  41211. }else if( nLen+1<nBuf ){
  41212. zBuf[nLen] = winGetDirSep();
  41213. zBuf[nLen+1] = '\0';
  41214. return 1;
  41215. }
  41216. }
  41217. }
  41218. return 0;
  41219. }
  41220. /*
  41221. ** Create a temporary file name and store the resulting pointer into pzBuf.
  41222. ** The pointer returned in pzBuf must be freed via sqlite3_free().
  41223. */
  41224. static int winGetTempname(sqlite3_vfs *pVfs, char **pzBuf){
  41225. static char zChars[] =
  41226. "abcdefghijklmnopqrstuvwxyz"
  41227. "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
  41228. "0123456789";
  41229. size_t i, j;
  41230. int nPre = sqlite3Strlen30(SQLITE_TEMP_FILE_PREFIX);
  41231. int nMax, nBuf, nDir, nLen;
  41232. char *zBuf;
  41233. /* It's odd to simulate an io-error here, but really this is just
  41234. ** using the io-error infrastructure to test that SQLite handles this
  41235. ** function failing.
  41236. */
  41237. SimulateIOError( return SQLITE_IOERR );
  41238. /* Allocate a temporary buffer to store the fully qualified file
  41239. ** name for the temporary file. If this fails, we cannot continue.
  41240. */
  41241. nMax = pVfs->mxPathname; nBuf = nMax + 2;
  41242. zBuf = sqlite3MallocZero( nBuf );
  41243. if( !zBuf ){
  41244. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41245. return SQLITE_IOERR_NOMEM_BKPT;
  41246. }
  41247. /* Figure out the effective temporary directory. First, check if one
  41248. ** has been explicitly set by the application; otherwise, use the one
  41249. ** configured by the operating system.
  41250. */
  41251. nDir = nMax - (nPre + 15);
  41252. assert( nDir>0 );
  41253. if( sqlite3_temp_directory ){
  41254. int nDirLen = sqlite3Strlen30(sqlite3_temp_directory);
  41255. if( nDirLen>0 ){
  41256. if( !winIsDirSep(sqlite3_temp_directory[nDirLen-1]) ){
  41257. nDirLen++;
  41258. }
  41259. if( nDirLen>nDir ){
  41260. sqlite3_free(zBuf);
  41261. OSTRACE(("TEMP-FILENAME rc=SQLITE_ERROR\n"));
  41262. return winLogError(SQLITE_ERROR, 0, "winGetTempname1", 0);
  41263. }
  41264. sqlite3_snprintf(nMax, zBuf, "%s", sqlite3_temp_directory);
  41265. }
  41266. }
  41267. #if defined(__CYGWIN__)
  41268. else{
  41269. static const char *azDirs[] = {
  41270. 0, /* getenv("SQLITE_TMPDIR") */
  41271. 0, /* getenv("TMPDIR") */
  41272. 0, /* getenv("TMP") */
  41273. 0, /* getenv("TEMP") */
  41274. 0, /* getenv("USERPROFILE") */
  41275. "/var/tmp",
  41276. "/usr/tmp",
  41277. "/tmp",
  41278. ".",
  41279. 0 /* List terminator */
  41280. };
  41281. unsigned int i;
  41282. const char *zDir = 0;
  41283. if( !azDirs[0] ) azDirs[0] = getenv("SQLITE_TMPDIR");
  41284. if( !azDirs[1] ) azDirs[1] = getenv("TMPDIR");
  41285. if( !azDirs[2] ) azDirs[2] = getenv("TMP");
  41286. if( !azDirs[3] ) azDirs[3] = getenv("TEMP");
  41287. if( !azDirs[4] ) azDirs[4] = getenv("USERPROFILE");
  41288. for(i=0; i<sizeof(azDirs)/sizeof(azDirs[0]); zDir=azDirs[i++]){
  41289. void *zConverted;
  41290. if( zDir==0 ) continue;
  41291. /* If the path starts with a drive letter followed by the colon
  41292. ** character, assume it is already a native Win32 path; otherwise,
  41293. ** it must be converted to a native Win32 path via the Cygwin API
  41294. ** prior to using it.
  41295. */
  41296. if( winIsDriveLetterAndColon(zDir) ){
  41297. zConverted = winConvertFromUtf8Filename(zDir);
  41298. if( !zConverted ){
  41299. sqlite3_free(zBuf);
  41300. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41301. return SQLITE_IOERR_NOMEM_BKPT;
  41302. }
  41303. if( winIsDir(zConverted) ){
  41304. sqlite3_snprintf(nMax, zBuf, "%s", zDir);
  41305. sqlite3_free(zConverted);
  41306. break;
  41307. }
  41308. sqlite3_free(zConverted);
  41309. }else{
  41310. zConverted = sqlite3MallocZero( nMax+1 );
  41311. if( !zConverted ){
  41312. sqlite3_free(zBuf);
  41313. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41314. return SQLITE_IOERR_NOMEM_BKPT;
  41315. }
  41316. if( cygwin_conv_path(
  41317. osIsNT() ? CCP_POSIX_TO_WIN_W : CCP_POSIX_TO_WIN_A, zDir,
  41318. zConverted, nMax+1)<0 ){
  41319. sqlite3_free(zConverted);
  41320. sqlite3_free(zBuf);
  41321. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_CONVPATH\n"));
  41322. return winLogError(SQLITE_IOERR_CONVPATH, (DWORD)errno,
  41323. "winGetTempname2", zDir);
  41324. }
  41325. if( winIsDir(zConverted) ){
  41326. /* At this point, we know the candidate directory exists and should
  41327. ** be used. However, we may need to convert the string containing
  41328. ** its name into UTF-8 (i.e. if it is UTF-16 right now).
  41329. */
  41330. char *zUtf8 = winConvertToUtf8Filename(zConverted);
  41331. if( !zUtf8 ){
  41332. sqlite3_free(zConverted);
  41333. sqlite3_free(zBuf);
  41334. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41335. return SQLITE_IOERR_NOMEM_BKPT;
  41336. }
  41337. sqlite3_snprintf(nMax, zBuf, "%s", zUtf8);
  41338. sqlite3_free(zUtf8);
  41339. sqlite3_free(zConverted);
  41340. break;
  41341. }
  41342. sqlite3_free(zConverted);
  41343. }
  41344. }
  41345. }
  41346. #elif !SQLITE_OS_WINRT && !defined(__CYGWIN__)
  41347. else if( osIsNT() ){
  41348. char *zMulti;
  41349. LPWSTR zWidePath = sqlite3MallocZero( nMax*sizeof(WCHAR) );
  41350. if( !zWidePath ){
  41351. sqlite3_free(zBuf);
  41352. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41353. return SQLITE_IOERR_NOMEM_BKPT;
  41354. }
  41355. if( osGetTempPathW(nMax, zWidePath)==0 ){
  41356. sqlite3_free(zWidePath);
  41357. sqlite3_free(zBuf);
  41358. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_GETTEMPPATH\n"));
  41359. return winLogError(SQLITE_IOERR_GETTEMPPATH, osGetLastError(),
  41360. "winGetTempname2", 0);
  41361. }
  41362. zMulti = winUnicodeToUtf8(zWidePath);
  41363. if( zMulti ){
  41364. sqlite3_snprintf(nMax, zBuf, "%s", zMulti);
  41365. sqlite3_free(zMulti);
  41366. sqlite3_free(zWidePath);
  41367. }else{
  41368. sqlite3_free(zWidePath);
  41369. sqlite3_free(zBuf);
  41370. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41371. return SQLITE_IOERR_NOMEM_BKPT;
  41372. }
  41373. }
  41374. #ifdef SQLITE_WIN32_HAS_ANSI
  41375. else{
  41376. char *zUtf8;
  41377. char *zMbcsPath = sqlite3MallocZero( nMax );
  41378. if( !zMbcsPath ){
  41379. sqlite3_free(zBuf);
  41380. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41381. return SQLITE_IOERR_NOMEM_BKPT;
  41382. }
  41383. if( osGetTempPathA(nMax, zMbcsPath)==0 ){
  41384. sqlite3_free(zBuf);
  41385. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_GETTEMPPATH\n"));
  41386. return winLogError(SQLITE_IOERR_GETTEMPPATH, osGetLastError(),
  41387. "winGetTempname3", 0);
  41388. }
  41389. zUtf8 = winMbcsToUtf8(zMbcsPath, osAreFileApisANSI());
  41390. if( zUtf8 ){
  41391. sqlite3_snprintf(nMax, zBuf, "%s", zUtf8);
  41392. sqlite3_free(zUtf8);
  41393. }else{
  41394. sqlite3_free(zBuf);
  41395. OSTRACE(("TEMP-FILENAME rc=SQLITE_IOERR_NOMEM\n"));
  41396. return SQLITE_IOERR_NOMEM_BKPT;
  41397. }
  41398. }
  41399. #endif /* SQLITE_WIN32_HAS_ANSI */
  41400. #endif /* !SQLITE_OS_WINRT */
  41401. /*
  41402. ** Check to make sure the temporary directory ends with an appropriate
  41403. ** separator. If it does not and there is not enough space left to add
  41404. ** one, fail.
  41405. */
  41406. if( !winMakeEndInDirSep(nDir+1, zBuf) ){
  41407. sqlite3_free(zBuf);
  41408. OSTRACE(("TEMP-FILENAME rc=SQLITE_ERROR\n"));
  41409. return winLogError(SQLITE_ERROR, 0, "winGetTempname4", 0);
  41410. }
  41411. /*
  41412. ** Check that the output buffer is large enough for the temporary file
  41413. ** name in the following format:
  41414. **
  41415. ** "<temporary_directory>/etilqs_XXXXXXXXXXXXXXX\0\0"
  41416. **
  41417. ** If not, return SQLITE_ERROR. The number 17 is used here in order to
  41418. ** account for the space used by the 15 character random suffix and the
  41419. ** two trailing NUL characters. The final directory separator character
  41420. ** has already added if it was not already present.
  41421. */
  41422. nLen = sqlite3Strlen30(zBuf);
  41423. if( (nLen + nPre + 17) > nBuf ){
  41424. sqlite3_free(zBuf);
  41425. OSTRACE(("TEMP-FILENAME rc=SQLITE_ERROR\n"));
  41426. return winLogError(SQLITE_ERROR, 0, "winGetTempname5", 0);
  41427. }
  41428. sqlite3_snprintf(nBuf-16-nLen, zBuf+nLen, SQLITE_TEMP_FILE_PREFIX);
  41429. j = sqlite3Strlen30(zBuf);
  41430. sqlite3_randomness(15, &zBuf[j]);
  41431. for(i=0; i<15; i++, j++){
  41432. zBuf[j] = (char)zChars[ ((unsigned char)zBuf[j])%(sizeof(zChars)-1) ];
  41433. }
  41434. zBuf[j] = 0;
  41435. zBuf[j+1] = 0;
  41436. *pzBuf = zBuf;
  41437. OSTRACE(("TEMP-FILENAME name=%s, rc=SQLITE_OK\n", zBuf));
  41438. return SQLITE_OK;
  41439. }
  41440. /*
  41441. ** Return TRUE if the named file is really a directory. Return false if
  41442. ** it is something other than a directory, or if there is any kind of memory
  41443. ** allocation failure.
  41444. */
  41445. static int winIsDir(const void *zConverted){
  41446. DWORD attr;
  41447. int rc = 0;
  41448. DWORD lastErrno;
  41449. if( osIsNT() ){
  41450. int cnt = 0;
  41451. WIN32_FILE_ATTRIBUTE_DATA sAttrData;
  41452. memset(&sAttrData, 0, sizeof(sAttrData));
  41453. while( !(rc = osGetFileAttributesExW((LPCWSTR)zConverted,
  41454. GetFileExInfoStandard,
  41455. &sAttrData)) && winRetryIoerr(&cnt, &lastErrno) ){}
  41456. if( !rc ){
  41457. return 0; /* Invalid name? */
  41458. }
  41459. attr = sAttrData.dwFileAttributes;
  41460. #if SQLITE_OS_WINCE==0
  41461. }else{
  41462. attr = osGetFileAttributesA((char*)zConverted);
  41463. #endif
  41464. }
  41465. return (attr!=INVALID_FILE_ATTRIBUTES) && (attr&FILE_ATTRIBUTE_DIRECTORY);
  41466. }
  41467. /* forward reference */
  41468. static int winAccess(
  41469. sqlite3_vfs *pVfs, /* Not used on win32 */
  41470. const char *zFilename, /* Name of file to check */
  41471. int flags, /* Type of test to make on this file */
  41472. int *pResOut /* OUT: Result */
  41473. );
  41474. /*
  41475. ** Open a file.
  41476. */
  41477. static int winOpen(
  41478. sqlite3_vfs *pVfs, /* Used to get maximum path length and AppData */
  41479. const char *zName, /* Name of the file (UTF-8) */
  41480. sqlite3_file *id, /* Write the SQLite file handle here */
  41481. int flags, /* Open mode flags */
  41482. int *pOutFlags /* Status return flags */
  41483. ){
  41484. HANDLE h;
  41485. DWORD lastErrno = 0;
  41486. DWORD dwDesiredAccess;
  41487. DWORD dwShareMode;
  41488. DWORD dwCreationDisposition;
  41489. DWORD dwFlagsAndAttributes = 0;
  41490. #if SQLITE_OS_WINCE
  41491. int isTemp = 0;
  41492. #endif
  41493. winVfsAppData *pAppData;
  41494. winFile *pFile = (winFile*)id;
  41495. void *zConverted; /* Filename in OS encoding */
  41496. const char *zUtf8Name = zName; /* Filename in UTF-8 encoding */
  41497. int cnt = 0;
  41498. /* If argument zPath is a NULL pointer, this function is required to open
  41499. ** a temporary file. Use this buffer to store the file name in.
  41500. */
  41501. char *zTmpname = 0; /* For temporary filename, if necessary. */
  41502. int rc = SQLITE_OK; /* Function Return Code */
  41503. #if !defined(NDEBUG) || SQLITE_OS_WINCE
  41504. int eType = flags&0xFFFFFF00; /* Type of file to open */
  41505. #endif
  41506. int isExclusive = (flags & SQLITE_OPEN_EXCLUSIVE);
  41507. int isDelete = (flags & SQLITE_OPEN_DELETEONCLOSE);
  41508. int isCreate = (flags & SQLITE_OPEN_CREATE);
  41509. int isReadonly = (flags & SQLITE_OPEN_READONLY);
  41510. int isReadWrite = (flags & SQLITE_OPEN_READWRITE);
  41511. #ifndef NDEBUG
  41512. int isOpenJournal = (isCreate && (
  41513. eType==SQLITE_OPEN_MASTER_JOURNAL
  41514. || eType==SQLITE_OPEN_MAIN_JOURNAL
  41515. || eType==SQLITE_OPEN_WAL
  41516. ));
  41517. #endif
  41518. OSTRACE(("OPEN name=%s, pFile=%p, flags=%x, pOutFlags=%p\n",
  41519. zUtf8Name, id, flags, pOutFlags));
  41520. /* Check the following statements are true:
  41521. **
  41522. ** (a) Exactly one of the READWRITE and READONLY flags must be set, and
  41523. ** (b) if CREATE is set, then READWRITE must also be set, and
  41524. ** (c) if EXCLUSIVE is set, then CREATE must also be set.
  41525. ** (d) if DELETEONCLOSE is set, then CREATE must also be set.
  41526. */
  41527. assert((isReadonly==0 || isReadWrite==0) && (isReadWrite || isReadonly));
  41528. assert(isCreate==0 || isReadWrite);
  41529. assert(isExclusive==0 || isCreate);
  41530. assert(isDelete==0 || isCreate);
  41531. /* The main DB, main journal, WAL file and master journal are never
  41532. ** automatically deleted. Nor are they ever temporary files. */
  41533. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_DB );
  41534. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MAIN_JOURNAL );
  41535. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_MASTER_JOURNAL );
  41536. assert( (!isDelete && zName) || eType!=SQLITE_OPEN_WAL );
  41537. /* Assert that the upper layer has set one of the "file-type" flags. */
  41538. assert( eType==SQLITE_OPEN_MAIN_DB || eType==SQLITE_OPEN_TEMP_DB
  41539. || eType==SQLITE_OPEN_MAIN_JOURNAL || eType==SQLITE_OPEN_TEMP_JOURNAL
  41540. || eType==SQLITE_OPEN_SUBJOURNAL || eType==SQLITE_OPEN_MASTER_JOURNAL
  41541. || eType==SQLITE_OPEN_TRANSIENT_DB || eType==SQLITE_OPEN_WAL
  41542. );
  41543. assert( pFile!=0 );
  41544. memset(pFile, 0, sizeof(winFile));
  41545. pFile->h = INVALID_HANDLE_VALUE;
  41546. #if SQLITE_OS_WINRT
  41547. if( !zUtf8Name && !sqlite3_temp_directory ){
  41548. sqlite3_log(SQLITE_ERROR,
  41549. "sqlite3_temp_directory variable should be set for WinRT");
  41550. }
  41551. #endif
  41552. /* If the second argument to this function is NULL, generate a
  41553. ** temporary file name to use
  41554. */
  41555. if( !zUtf8Name ){
  41556. assert( isDelete && !isOpenJournal );
  41557. rc = winGetTempname(pVfs, &zTmpname);
  41558. if( rc!=SQLITE_OK ){
  41559. OSTRACE(("OPEN name=%s, rc=%s", zUtf8Name, sqlite3ErrName(rc)));
  41560. return rc;
  41561. }
  41562. zUtf8Name = zTmpname;
  41563. }
  41564. /* Database filenames are double-zero terminated if they are not
  41565. ** URIs with parameters. Hence, they can always be passed into
  41566. ** sqlite3_uri_parameter().
  41567. */
  41568. assert( (eType!=SQLITE_OPEN_MAIN_DB) || (flags & SQLITE_OPEN_URI) ||
  41569. zUtf8Name[sqlite3Strlen30(zUtf8Name)+1]==0 );
  41570. /* Convert the filename to the system encoding. */
  41571. zConverted = winConvertFromUtf8Filename(zUtf8Name);
  41572. if( zConverted==0 ){
  41573. sqlite3_free(zTmpname);
  41574. OSTRACE(("OPEN name=%s, rc=SQLITE_IOERR_NOMEM", zUtf8Name));
  41575. return SQLITE_IOERR_NOMEM_BKPT;
  41576. }
  41577. if( winIsDir(zConverted) ){
  41578. sqlite3_free(zConverted);
  41579. sqlite3_free(zTmpname);
  41580. OSTRACE(("OPEN name=%s, rc=SQLITE_CANTOPEN_ISDIR", zUtf8Name));
  41581. return SQLITE_CANTOPEN_ISDIR;
  41582. }
  41583. if( isReadWrite ){
  41584. dwDesiredAccess = GENERIC_READ | GENERIC_WRITE;
  41585. }else{
  41586. dwDesiredAccess = GENERIC_READ;
  41587. }
  41588. /* SQLITE_OPEN_EXCLUSIVE is used to make sure that a new file is
  41589. ** created. SQLite doesn't use it to indicate "exclusive access"
  41590. ** as it is usually understood.
  41591. */
  41592. if( isExclusive ){
  41593. /* Creates a new file, only if it does not already exist. */
  41594. /* If the file exists, it fails. */
  41595. dwCreationDisposition = CREATE_NEW;
  41596. }else if( isCreate ){
  41597. /* Open existing file, or create if it doesn't exist */
  41598. dwCreationDisposition = OPEN_ALWAYS;
  41599. }else{
  41600. /* Opens a file, only if it exists. */
  41601. dwCreationDisposition = OPEN_EXISTING;
  41602. }
  41603. dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE;
  41604. if( isDelete ){
  41605. #if SQLITE_OS_WINCE
  41606. dwFlagsAndAttributes = FILE_ATTRIBUTE_HIDDEN;
  41607. isTemp = 1;
  41608. #else
  41609. dwFlagsAndAttributes = FILE_ATTRIBUTE_TEMPORARY
  41610. | FILE_ATTRIBUTE_HIDDEN
  41611. | FILE_FLAG_DELETE_ON_CLOSE;
  41612. #endif
  41613. }else{
  41614. dwFlagsAndAttributes = FILE_ATTRIBUTE_NORMAL;
  41615. }
  41616. /* Reports from the internet are that performance is always
  41617. ** better if FILE_FLAG_RANDOM_ACCESS is used. Ticket #2699. */
  41618. #if SQLITE_OS_WINCE
  41619. dwFlagsAndAttributes |= FILE_FLAG_RANDOM_ACCESS;
  41620. #endif
  41621. if( osIsNT() ){
  41622. #if SQLITE_OS_WINRT
  41623. CREATEFILE2_EXTENDED_PARAMETERS extendedParameters;
  41624. extendedParameters.dwSize = sizeof(CREATEFILE2_EXTENDED_PARAMETERS);
  41625. extendedParameters.dwFileAttributes =
  41626. dwFlagsAndAttributes & FILE_ATTRIBUTE_MASK;
  41627. extendedParameters.dwFileFlags = dwFlagsAndAttributes & FILE_FLAG_MASK;
  41628. extendedParameters.dwSecurityQosFlags = SECURITY_ANONYMOUS;
  41629. extendedParameters.lpSecurityAttributes = NULL;
  41630. extendedParameters.hTemplateFile = NULL;
  41631. do{
  41632. h = osCreateFile2((LPCWSTR)zConverted,
  41633. dwDesiredAccess,
  41634. dwShareMode,
  41635. dwCreationDisposition,
  41636. &extendedParameters);
  41637. if( h!=INVALID_HANDLE_VALUE ) break;
  41638. if( isReadWrite ){
  41639. int rc2, isRO = 0;
  41640. sqlite3BeginBenignMalloc();
  41641. rc2 = winAccess(pVfs, zName, SQLITE_ACCESS_READ, &isRO);
  41642. sqlite3EndBenignMalloc();
  41643. if( rc2==SQLITE_OK && isRO ) break;
  41644. }
  41645. }while( winRetryIoerr(&cnt, &lastErrno) );
  41646. #else
  41647. do{
  41648. h = osCreateFileW((LPCWSTR)zConverted,
  41649. dwDesiredAccess,
  41650. dwShareMode, NULL,
  41651. dwCreationDisposition,
  41652. dwFlagsAndAttributes,
  41653. NULL);
  41654. if( h!=INVALID_HANDLE_VALUE ) break;
  41655. if( isReadWrite ){
  41656. int rc2, isRO = 0;
  41657. sqlite3BeginBenignMalloc();
  41658. rc2 = winAccess(pVfs, zName, SQLITE_ACCESS_READ, &isRO);
  41659. sqlite3EndBenignMalloc();
  41660. if( rc2==SQLITE_OK && isRO ) break;
  41661. }
  41662. }while( winRetryIoerr(&cnt, &lastErrno) );
  41663. #endif
  41664. }
  41665. #ifdef SQLITE_WIN32_HAS_ANSI
  41666. else{
  41667. do{
  41668. h = osCreateFileA((LPCSTR)zConverted,
  41669. dwDesiredAccess,
  41670. dwShareMode, NULL,
  41671. dwCreationDisposition,
  41672. dwFlagsAndAttributes,
  41673. NULL);
  41674. if( h!=INVALID_HANDLE_VALUE ) break;
  41675. if( isReadWrite ){
  41676. int rc2, isRO = 0;
  41677. sqlite3BeginBenignMalloc();
  41678. rc2 = winAccess(pVfs, zName, SQLITE_ACCESS_READ, &isRO);
  41679. sqlite3EndBenignMalloc();
  41680. if( rc2==SQLITE_OK && isRO ) break;
  41681. }
  41682. }while( winRetryIoerr(&cnt, &lastErrno) );
  41683. }
  41684. #endif
  41685. winLogIoerr(cnt, __LINE__);
  41686. OSTRACE(("OPEN file=%p, name=%s, access=%lx, rc=%s\n", h, zUtf8Name,
  41687. dwDesiredAccess, (h==INVALID_HANDLE_VALUE) ? "failed" : "ok"));
  41688. if( h==INVALID_HANDLE_VALUE ){
  41689. sqlite3_free(zConverted);
  41690. sqlite3_free(zTmpname);
  41691. if( isReadWrite && !isExclusive ){
  41692. return winOpen(pVfs, zName, id,
  41693. ((flags|SQLITE_OPEN_READONLY) &
  41694. ~(SQLITE_OPEN_CREATE|SQLITE_OPEN_READWRITE)),
  41695. pOutFlags);
  41696. }else{
  41697. pFile->lastErrno = lastErrno;
  41698. winLogError(SQLITE_CANTOPEN, pFile->lastErrno, "winOpen", zUtf8Name);
  41699. return SQLITE_CANTOPEN_BKPT;
  41700. }
  41701. }
  41702. if( pOutFlags ){
  41703. if( isReadWrite ){
  41704. *pOutFlags = SQLITE_OPEN_READWRITE;
  41705. }else{
  41706. *pOutFlags = SQLITE_OPEN_READONLY;
  41707. }
  41708. }
  41709. OSTRACE(("OPEN file=%p, name=%s, access=%lx, pOutFlags=%p, *pOutFlags=%d, "
  41710. "rc=%s\n", h, zUtf8Name, dwDesiredAccess, pOutFlags, pOutFlags ?
  41711. *pOutFlags : 0, (h==INVALID_HANDLE_VALUE) ? "failed" : "ok"));
  41712. pAppData = (winVfsAppData*)pVfs->pAppData;
  41713. #if SQLITE_OS_WINCE
  41714. {
  41715. if( isReadWrite && eType==SQLITE_OPEN_MAIN_DB
  41716. && ((pAppData==NULL) || !pAppData->bNoLock)
  41717. && (rc = winceCreateLock(zName, pFile))!=SQLITE_OK
  41718. ){
  41719. osCloseHandle(h);
  41720. sqlite3_free(zConverted);
  41721. sqlite3_free(zTmpname);
  41722. OSTRACE(("OPEN-CE-LOCK name=%s, rc=%s\n", zName, sqlite3ErrName(rc)));
  41723. return rc;
  41724. }
  41725. }
  41726. if( isTemp ){
  41727. pFile->zDeleteOnClose = zConverted;
  41728. }else
  41729. #endif
  41730. {
  41731. sqlite3_free(zConverted);
  41732. }
  41733. sqlite3_free(zTmpname);
  41734. pFile->pMethod = pAppData ? pAppData->pMethod : &winIoMethod;
  41735. pFile->pVfs = pVfs;
  41736. pFile->h = h;
  41737. if( isReadonly ){
  41738. pFile->ctrlFlags |= WINFILE_RDONLY;
  41739. }
  41740. if( sqlite3_uri_boolean(zName, "psow", SQLITE_POWERSAFE_OVERWRITE) ){
  41741. pFile->ctrlFlags |= WINFILE_PSOW;
  41742. }
  41743. pFile->lastErrno = NO_ERROR;
  41744. pFile->zPath = zName;
  41745. #if SQLITE_MAX_MMAP_SIZE>0
  41746. pFile->hMap = NULL;
  41747. pFile->pMapRegion = 0;
  41748. pFile->mmapSize = 0;
  41749. pFile->mmapSizeActual = 0;
  41750. pFile->mmapSizeMax = sqlite3GlobalConfig.szMmap;
  41751. #endif
  41752. OpenCounter(+1);
  41753. return rc;
  41754. }
  41755. /*
  41756. ** Delete the named file.
  41757. **
  41758. ** Note that Windows does not allow a file to be deleted if some other
  41759. ** process has it open. Sometimes a virus scanner or indexing program
  41760. ** will open a journal file shortly after it is created in order to do
  41761. ** whatever it does. While this other process is holding the
  41762. ** file open, we will be unable to delete it. To work around this
  41763. ** problem, we delay 100 milliseconds and try to delete again. Up
  41764. ** to MX_DELETION_ATTEMPTs deletion attempts are run before giving
  41765. ** up and returning an error.
  41766. */
  41767. static int winDelete(
  41768. sqlite3_vfs *pVfs, /* Not used on win32 */
  41769. const char *zFilename, /* Name of file to delete */
  41770. int syncDir /* Not used on win32 */
  41771. ){
  41772. int cnt = 0;
  41773. int rc;
  41774. DWORD attr;
  41775. DWORD lastErrno = 0;
  41776. void *zConverted;
  41777. UNUSED_PARAMETER(pVfs);
  41778. UNUSED_PARAMETER(syncDir);
  41779. SimulateIOError(return SQLITE_IOERR_DELETE);
  41780. OSTRACE(("DELETE name=%s, syncDir=%d\n", zFilename, syncDir));
  41781. zConverted = winConvertFromUtf8Filename(zFilename);
  41782. if( zConverted==0 ){
  41783. OSTRACE(("DELETE name=%s, rc=SQLITE_IOERR_NOMEM\n", zFilename));
  41784. return SQLITE_IOERR_NOMEM_BKPT;
  41785. }
  41786. if( osIsNT() ){
  41787. do {
  41788. #if SQLITE_OS_WINRT
  41789. WIN32_FILE_ATTRIBUTE_DATA sAttrData;
  41790. memset(&sAttrData, 0, sizeof(sAttrData));
  41791. if ( osGetFileAttributesExW(zConverted, GetFileExInfoStandard,
  41792. &sAttrData) ){
  41793. attr = sAttrData.dwFileAttributes;
  41794. }else{
  41795. lastErrno = osGetLastError();
  41796. if( lastErrno==ERROR_FILE_NOT_FOUND
  41797. || lastErrno==ERROR_PATH_NOT_FOUND ){
  41798. rc = SQLITE_IOERR_DELETE_NOENT; /* Already gone? */
  41799. }else{
  41800. rc = SQLITE_ERROR;
  41801. }
  41802. break;
  41803. }
  41804. #else
  41805. attr = osGetFileAttributesW(zConverted);
  41806. #endif
  41807. if ( attr==INVALID_FILE_ATTRIBUTES ){
  41808. lastErrno = osGetLastError();
  41809. if( lastErrno==ERROR_FILE_NOT_FOUND
  41810. || lastErrno==ERROR_PATH_NOT_FOUND ){
  41811. rc = SQLITE_IOERR_DELETE_NOENT; /* Already gone? */
  41812. }else{
  41813. rc = SQLITE_ERROR;
  41814. }
  41815. break;
  41816. }
  41817. if ( attr&FILE_ATTRIBUTE_DIRECTORY ){
  41818. rc = SQLITE_ERROR; /* Files only. */
  41819. break;
  41820. }
  41821. if ( osDeleteFileW(zConverted) ){
  41822. rc = SQLITE_OK; /* Deleted OK. */
  41823. break;
  41824. }
  41825. if ( !winRetryIoerr(&cnt, &lastErrno) ){
  41826. rc = SQLITE_ERROR; /* No more retries. */
  41827. break;
  41828. }
  41829. } while(1);
  41830. }
  41831. #ifdef SQLITE_WIN32_HAS_ANSI
  41832. else{
  41833. do {
  41834. attr = osGetFileAttributesA(zConverted);
  41835. if ( attr==INVALID_FILE_ATTRIBUTES ){
  41836. lastErrno = osGetLastError();
  41837. if( lastErrno==ERROR_FILE_NOT_FOUND
  41838. || lastErrno==ERROR_PATH_NOT_FOUND ){
  41839. rc = SQLITE_IOERR_DELETE_NOENT; /* Already gone? */
  41840. }else{
  41841. rc = SQLITE_ERROR;
  41842. }
  41843. break;
  41844. }
  41845. if ( attr&FILE_ATTRIBUTE_DIRECTORY ){
  41846. rc = SQLITE_ERROR; /* Files only. */
  41847. break;
  41848. }
  41849. if ( osDeleteFileA(zConverted) ){
  41850. rc = SQLITE_OK; /* Deleted OK. */
  41851. break;
  41852. }
  41853. if ( !winRetryIoerr(&cnt, &lastErrno) ){
  41854. rc = SQLITE_ERROR; /* No more retries. */
  41855. break;
  41856. }
  41857. } while(1);
  41858. }
  41859. #endif
  41860. if( rc && rc!=SQLITE_IOERR_DELETE_NOENT ){
  41861. rc = winLogError(SQLITE_IOERR_DELETE, lastErrno, "winDelete", zFilename);
  41862. }else{
  41863. winLogIoerr(cnt, __LINE__);
  41864. }
  41865. sqlite3_free(zConverted);
  41866. OSTRACE(("DELETE name=%s, rc=%s\n", zFilename, sqlite3ErrName(rc)));
  41867. return rc;
  41868. }
  41869. /*
  41870. ** Check the existence and status of a file.
  41871. */
  41872. static int winAccess(
  41873. sqlite3_vfs *pVfs, /* Not used on win32 */
  41874. const char *zFilename, /* Name of file to check */
  41875. int flags, /* Type of test to make on this file */
  41876. int *pResOut /* OUT: Result */
  41877. ){
  41878. DWORD attr;
  41879. int rc = 0;
  41880. DWORD lastErrno = 0;
  41881. void *zConverted;
  41882. UNUSED_PARAMETER(pVfs);
  41883. SimulateIOError( return SQLITE_IOERR_ACCESS; );
  41884. OSTRACE(("ACCESS name=%s, flags=%x, pResOut=%p\n",
  41885. zFilename, flags, pResOut));
  41886. zConverted = winConvertFromUtf8Filename(zFilename);
  41887. if( zConverted==0 ){
  41888. OSTRACE(("ACCESS name=%s, rc=SQLITE_IOERR_NOMEM\n", zFilename));
  41889. return SQLITE_IOERR_NOMEM_BKPT;
  41890. }
  41891. if( osIsNT() ){
  41892. int cnt = 0;
  41893. WIN32_FILE_ATTRIBUTE_DATA sAttrData;
  41894. memset(&sAttrData, 0, sizeof(sAttrData));
  41895. while( !(rc = osGetFileAttributesExW((LPCWSTR)zConverted,
  41896. GetFileExInfoStandard,
  41897. &sAttrData)) && winRetryIoerr(&cnt, &lastErrno) ){}
  41898. if( rc ){
  41899. /* For an SQLITE_ACCESS_EXISTS query, treat a zero-length file
  41900. ** as if it does not exist.
  41901. */
  41902. if( flags==SQLITE_ACCESS_EXISTS
  41903. && sAttrData.nFileSizeHigh==0
  41904. && sAttrData.nFileSizeLow==0 ){
  41905. attr = INVALID_FILE_ATTRIBUTES;
  41906. }else{
  41907. attr = sAttrData.dwFileAttributes;
  41908. }
  41909. }else{
  41910. winLogIoerr(cnt, __LINE__);
  41911. if( lastErrno!=ERROR_FILE_NOT_FOUND && lastErrno!=ERROR_PATH_NOT_FOUND ){
  41912. sqlite3_free(zConverted);
  41913. return winLogError(SQLITE_IOERR_ACCESS, lastErrno, "winAccess",
  41914. zFilename);
  41915. }else{
  41916. attr = INVALID_FILE_ATTRIBUTES;
  41917. }
  41918. }
  41919. }
  41920. #ifdef SQLITE_WIN32_HAS_ANSI
  41921. else{
  41922. attr = osGetFileAttributesA((char*)zConverted);
  41923. }
  41924. #endif
  41925. sqlite3_free(zConverted);
  41926. switch( flags ){
  41927. case SQLITE_ACCESS_READ:
  41928. case SQLITE_ACCESS_EXISTS:
  41929. rc = attr!=INVALID_FILE_ATTRIBUTES;
  41930. break;
  41931. case SQLITE_ACCESS_READWRITE:
  41932. rc = attr!=INVALID_FILE_ATTRIBUTES &&
  41933. (attr & FILE_ATTRIBUTE_READONLY)==0;
  41934. break;
  41935. default:
  41936. assert(!"Invalid flags argument");
  41937. }
  41938. *pResOut = rc;
  41939. OSTRACE(("ACCESS name=%s, pResOut=%p, *pResOut=%d, rc=SQLITE_OK\n",
  41940. zFilename, pResOut, *pResOut));
  41941. return SQLITE_OK;
  41942. }
  41943. /*
  41944. ** Returns non-zero if the specified path name starts with a drive letter
  41945. ** followed by a colon character.
  41946. */
  41947. static BOOL winIsDriveLetterAndColon(
  41948. const char *zPathname
  41949. ){
  41950. return ( sqlite3Isalpha(zPathname[0]) && zPathname[1]==':' );
  41951. }
  41952. /*
  41953. ** Returns non-zero if the specified path name should be used verbatim. If
  41954. ** non-zero is returned from this function, the calling function must simply
  41955. ** use the provided path name verbatim -OR- resolve it into a full path name
  41956. ** using the GetFullPathName Win32 API function (if available).
  41957. */
  41958. static BOOL winIsVerbatimPathname(
  41959. const char *zPathname
  41960. ){
  41961. /*
  41962. ** If the path name starts with a forward slash or a backslash, it is either
  41963. ** a legal UNC name, a volume relative path, or an absolute path name in the
  41964. ** "Unix" format on Windows. There is no easy way to differentiate between
  41965. ** the final two cases; therefore, we return the safer return value of TRUE
  41966. ** so that callers of this function will simply use it verbatim.
  41967. */
  41968. if ( winIsDirSep(zPathname[0]) ){
  41969. return TRUE;
  41970. }
  41971. /*
  41972. ** If the path name starts with a letter and a colon it is either a volume
  41973. ** relative path or an absolute path. Callers of this function must not
  41974. ** attempt to treat it as a relative path name (i.e. they should simply use
  41975. ** it verbatim).
  41976. */
  41977. if ( winIsDriveLetterAndColon(zPathname) ){
  41978. return TRUE;
  41979. }
  41980. /*
  41981. ** If we get to this point, the path name should almost certainly be a purely
  41982. ** relative one (i.e. not a UNC name, not absolute, and not volume relative).
  41983. */
  41984. return FALSE;
  41985. }
  41986. /*
  41987. ** Turn a relative pathname into a full pathname. Write the full
  41988. ** pathname into zOut[]. zOut[] will be at least pVfs->mxPathname
  41989. ** bytes in size.
  41990. */
  41991. static int winFullPathname(
  41992. sqlite3_vfs *pVfs, /* Pointer to vfs object */
  41993. const char *zRelative, /* Possibly relative input path */
  41994. int nFull, /* Size of output buffer in bytes */
  41995. char *zFull /* Output buffer */
  41996. ){
  41997. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && !defined(__CYGWIN__)
  41998. DWORD nByte;
  41999. void *zConverted;
  42000. char *zOut;
  42001. #endif
  42002. /* If this path name begins with "/X:", where "X" is any alphabetic
  42003. ** character, discard the initial "/" from the pathname.
  42004. */
  42005. if( zRelative[0]=='/' && winIsDriveLetterAndColon(zRelative+1) ){
  42006. zRelative++;
  42007. }
  42008. #if defined(__CYGWIN__)
  42009. SimulateIOError( return SQLITE_ERROR );
  42010. UNUSED_PARAMETER(nFull);
  42011. assert( nFull>=pVfs->mxPathname );
  42012. if ( sqlite3_data_directory && !winIsVerbatimPathname(zRelative) ){
  42013. /*
  42014. ** NOTE: We are dealing with a relative path name and the data
  42015. ** directory has been set. Therefore, use it as the basis
  42016. ** for converting the relative path name to an absolute
  42017. ** one by prepending the data directory and a slash.
  42018. */
  42019. char *zOut = sqlite3MallocZero( pVfs->mxPathname+1 );
  42020. if( !zOut ){
  42021. return SQLITE_IOERR_NOMEM_BKPT;
  42022. }
  42023. if( cygwin_conv_path(
  42024. (osIsNT() ? CCP_POSIX_TO_WIN_W : CCP_POSIX_TO_WIN_A) |
  42025. CCP_RELATIVE, zRelative, zOut, pVfs->mxPathname+1)<0 ){
  42026. sqlite3_free(zOut);
  42027. return winLogError(SQLITE_CANTOPEN_CONVPATH, (DWORD)errno,
  42028. "winFullPathname1", zRelative);
  42029. }else{
  42030. char *zUtf8 = winConvertToUtf8Filename(zOut);
  42031. if( !zUtf8 ){
  42032. sqlite3_free(zOut);
  42033. return SQLITE_IOERR_NOMEM_BKPT;
  42034. }
  42035. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s%c%s",
  42036. sqlite3_data_directory, winGetDirSep(), zUtf8);
  42037. sqlite3_free(zUtf8);
  42038. sqlite3_free(zOut);
  42039. }
  42040. }else{
  42041. char *zOut = sqlite3MallocZero( pVfs->mxPathname+1 );
  42042. if( !zOut ){
  42043. return SQLITE_IOERR_NOMEM_BKPT;
  42044. }
  42045. if( cygwin_conv_path(
  42046. (osIsNT() ? CCP_POSIX_TO_WIN_W : CCP_POSIX_TO_WIN_A),
  42047. zRelative, zOut, pVfs->mxPathname+1)<0 ){
  42048. sqlite3_free(zOut);
  42049. return winLogError(SQLITE_CANTOPEN_CONVPATH, (DWORD)errno,
  42050. "winFullPathname2", zRelative);
  42051. }else{
  42052. char *zUtf8 = winConvertToUtf8Filename(zOut);
  42053. if( !zUtf8 ){
  42054. sqlite3_free(zOut);
  42055. return SQLITE_IOERR_NOMEM_BKPT;
  42056. }
  42057. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s", zUtf8);
  42058. sqlite3_free(zUtf8);
  42059. sqlite3_free(zOut);
  42060. }
  42061. }
  42062. return SQLITE_OK;
  42063. #endif
  42064. #if (SQLITE_OS_WINCE || SQLITE_OS_WINRT) && !defined(__CYGWIN__)
  42065. SimulateIOError( return SQLITE_ERROR );
  42066. /* WinCE has no concept of a relative pathname, or so I am told. */
  42067. /* WinRT has no way to convert a relative path to an absolute one. */
  42068. if ( sqlite3_data_directory && !winIsVerbatimPathname(zRelative) ){
  42069. /*
  42070. ** NOTE: We are dealing with a relative path name and the data
  42071. ** directory has been set. Therefore, use it as the basis
  42072. ** for converting the relative path name to an absolute
  42073. ** one by prepending the data directory and a backslash.
  42074. */
  42075. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s%c%s",
  42076. sqlite3_data_directory, winGetDirSep(), zRelative);
  42077. }else{
  42078. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s", zRelative);
  42079. }
  42080. return SQLITE_OK;
  42081. #endif
  42082. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && !defined(__CYGWIN__)
  42083. /* It's odd to simulate an io-error here, but really this is just
  42084. ** using the io-error infrastructure to test that SQLite handles this
  42085. ** function failing. This function could fail if, for example, the
  42086. ** current working directory has been unlinked.
  42087. */
  42088. SimulateIOError( return SQLITE_ERROR );
  42089. if ( sqlite3_data_directory && !winIsVerbatimPathname(zRelative) ){
  42090. /*
  42091. ** NOTE: We are dealing with a relative path name and the data
  42092. ** directory has been set. Therefore, use it as the basis
  42093. ** for converting the relative path name to an absolute
  42094. ** one by prepending the data directory and a backslash.
  42095. */
  42096. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s%c%s",
  42097. sqlite3_data_directory, winGetDirSep(), zRelative);
  42098. return SQLITE_OK;
  42099. }
  42100. zConverted = winConvertFromUtf8Filename(zRelative);
  42101. if( zConverted==0 ){
  42102. return SQLITE_IOERR_NOMEM_BKPT;
  42103. }
  42104. if( osIsNT() ){
  42105. LPWSTR zTemp;
  42106. nByte = osGetFullPathNameW((LPCWSTR)zConverted, 0, 0, 0);
  42107. if( nByte==0 ){
  42108. sqlite3_free(zConverted);
  42109. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  42110. "winFullPathname1", zRelative);
  42111. }
  42112. nByte += 3;
  42113. zTemp = sqlite3MallocZero( nByte*sizeof(zTemp[0]) );
  42114. if( zTemp==0 ){
  42115. sqlite3_free(zConverted);
  42116. return SQLITE_IOERR_NOMEM_BKPT;
  42117. }
  42118. nByte = osGetFullPathNameW((LPCWSTR)zConverted, nByte, zTemp, 0);
  42119. if( nByte==0 ){
  42120. sqlite3_free(zConverted);
  42121. sqlite3_free(zTemp);
  42122. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  42123. "winFullPathname2", zRelative);
  42124. }
  42125. sqlite3_free(zConverted);
  42126. zOut = winUnicodeToUtf8(zTemp);
  42127. sqlite3_free(zTemp);
  42128. }
  42129. #ifdef SQLITE_WIN32_HAS_ANSI
  42130. else{
  42131. char *zTemp;
  42132. nByte = osGetFullPathNameA((char*)zConverted, 0, 0, 0);
  42133. if( nByte==0 ){
  42134. sqlite3_free(zConverted);
  42135. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  42136. "winFullPathname3", zRelative);
  42137. }
  42138. nByte += 3;
  42139. zTemp = sqlite3MallocZero( nByte*sizeof(zTemp[0]) );
  42140. if( zTemp==0 ){
  42141. sqlite3_free(zConverted);
  42142. return SQLITE_IOERR_NOMEM_BKPT;
  42143. }
  42144. nByte = osGetFullPathNameA((char*)zConverted, nByte, zTemp, 0);
  42145. if( nByte==0 ){
  42146. sqlite3_free(zConverted);
  42147. sqlite3_free(zTemp);
  42148. return winLogError(SQLITE_CANTOPEN_FULLPATH, osGetLastError(),
  42149. "winFullPathname4", zRelative);
  42150. }
  42151. sqlite3_free(zConverted);
  42152. zOut = winMbcsToUtf8(zTemp, osAreFileApisANSI());
  42153. sqlite3_free(zTemp);
  42154. }
  42155. #endif
  42156. if( zOut ){
  42157. sqlite3_snprintf(MIN(nFull, pVfs->mxPathname), zFull, "%s", zOut);
  42158. sqlite3_free(zOut);
  42159. return SQLITE_OK;
  42160. }else{
  42161. return SQLITE_IOERR_NOMEM_BKPT;
  42162. }
  42163. #endif
  42164. }
  42165. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  42166. /*
  42167. ** Interfaces for opening a shared library, finding entry points
  42168. ** within the shared library, and closing the shared library.
  42169. */
  42170. static void *winDlOpen(sqlite3_vfs *pVfs, const char *zFilename){
  42171. HANDLE h;
  42172. #if defined(__CYGWIN__)
  42173. int nFull = pVfs->mxPathname+1;
  42174. char *zFull = sqlite3MallocZero( nFull );
  42175. void *zConverted = 0;
  42176. if( zFull==0 ){
  42177. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)0));
  42178. return 0;
  42179. }
  42180. if( winFullPathname(pVfs, zFilename, nFull, zFull)!=SQLITE_OK ){
  42181. sqlite3_free(zFull);
  42182. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)0));
  42183. return 0;
  42184. }
  42185. zConverted = winConvertFromUtf8Filename(zFull);
  42186. sqlite3_free(zFull);
  42187. #else
  42188. void *zConverted = winConvertFromUtf8Filename(zFilename);
  42189. UNUSED_PARAMETER(pVfs);
  42190. #endif
  42191. if( zConverted==0 ){
  42192. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)0));
  42193. return 0;
  42194. }
  42195. if( osIsNT() ){
  42196. #if SQLITE_OS_WINRT
  42197. h = osLoadPackagedLibrary((LPCWSTR)zConverted, 0);
  42198. #else
  42199. h = osLoadLibraryW((LPCWSTR)zConverted);
  42200. #endif
  42201. }
  42202. #ifdef SQLITE_WIN32_HAS_ANSI
  42203. else{
  42204. h = osLoadLibraryA((char*)zConverted);
  42205. }
  42206. #endif
  42207. OSTRACE(("DLOPEN name=%s, handle=%p\n", zFilename, (void*)h));
  42208. sqlite3_free(zConverted);
  42209. return (void*)h;
  42210. }
  42211. static void winDlError(sqlite3_vfs *pVfs, int nBuf, char *zBufOut){
  42212. UNUSED_PARAMETER(pVfs);
  42213. winGetLastErrorMsg(osGetLastError(), nBuf, zBufOut);
  42214. }
  42215. static void (*winDlSym(sqlite3_vfs *pVfs,void *pH,const char *zSym))(void){
  42216. FARPROC proc;
  42217. UNUSED_PARAMETER(pVfs);
  42218. proc = osGetProcAddressA((HANDLE)pH, zSym);
  42219. OSTRACE(("DLSYM handle=%p, symbol=%s, address=%p\n",
  42220. (void*)pH, zSym, (void*)proc));
  42221. return (void(*)(void))proc;
  42222. }
  42223. static void winDlClose(sqlite3_vfs *pVfs, void *pHandle){
  42224. UNUSED_PARAMETER(pVfs);
  42225. osFreeLibrary((HANDLE)pHandle);
  42226. OSTRACE(("DLCLOSE handle=%p\n", (void*)pHandle));
  42227. }
  42228. #else /* if SQLITE_OMIT_LOAD_EXTENSION is defined: */
  42229. #define winDlOpen 0
  42230. #define winDlError 0
  42231. #define winDlSym 0
  42232. #define winDlClose 0
  42233. #endif
  42234. /* State information for the randomness gatherer. */
  42235. typedef struct EntropyGatherer EntropyGatherer;
  42236. struct EntropyGatherer {
  42237. unsigned char *a; /* Gather entropy into this buffer */
  42238. int na; /* Size of a[] in bytes */
  42239. int i; /* XOR next input into a[i] */
  42240. int nXor; /* Number of XOR operations done */
  42241. };
  42242. #if !defined(SQLITE_TEST) && !defined(SQLITE_OMIT_RANDOMNESS)
  42243. /* Mix sz bytes of entropy into p. */
  42244. static void xorMemory(EntropyGatherer *p, unsigned char *x, int sz){
  42245. int j, k;
  42246. for(j=0, k=p->i; j<sz; j++){
  42247. p->a[k++] ^= x[j];
  42248. if( k>=p->na ) k = 0;
  42249. }
  42250. p->i = k;
  42251. p->nXor += sz;
  42252. }
  42253. #endif /* !defined(SQLITE_TEST) && !defined(SQLITE_OMIT_RANDOMNESS) */
  42254. /*
  42255. ** Write up to nBuf bytes of randomness into zBuf.
  42256. */
  42257. static int winRandomness(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
  42258. #if defined(SQLITE_TEST) || defined(SQLITE_OMIT_RANDOMNESS)
  42259. UNUSED_PARAMETER(pVfs);
  42260. memset(zBuf, 0, nBuf);
  42261. return nBuf;
  42262. #else
  42263. EntropyGatherer e;
  42264. UNUSED_PARAMETER(pVfs);
  42265. memset(zBuf, 0, nBuf);
  42266. e.a = (unsigned char*)zBuf;
  42267. e.na = nBuf;
  42268. e.nXor = 0;
  42269. e.i = 0;
  42270. {
  42271. SYSTEMTIME x;
  42272. osGetSystemTime(&x);
  42273. xorMemory(&e, (unsigned char*)&x, sizeof(SYSTEMTIME));
  42274. }
  42275. {
  42276. DWORD pid = osGetCurrentProcessId();
  42277. xorMemory(&e, (unsigned char*)&pid, sizeof(DWORD));
  42278. }
  42279. #if SQLITE_OS_WINRT
  42280. {
  42281. ULONGLONG cnt = osGetTickCount64();
  42282. xorMemory(&e, (unsigned char*)&cnt, sizeof(ULONGLONG));
  42283. }
  42284. #else
  42285. {
  42286. DWORD cnt = osGetTickCount();
  42287. xorMemory(&e, (unsigned char*)&cnt, sizeof(DWORD));
  42288. }
  42289. #endif /* SQLITE_OS_WINRT */
  42290. {
  42291. LARGE_INTEGER i;
  42292. osQueryPerformanceCounter(&i);
  42293. xorMemory(&e, (unsigned char*)&i, sizeof(LARGE_INTEGER));
  42294. }
  42295. #if !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID
  42296. {
  42297. UUID id;
  42298. memset(&id, 0, sizeof(UUID));
  42299. osUuidCreate(&id);
  42300. xorMemory(&e, (unsigned char*)&id, sizeof(UUID));
  42301. memset(&id, 0, sizeof(UUID));
  42302. osUuidCreateSequential(&id);
  42303. xorMemory(&e, (unsigned char*)&id, sizeof(UUID));
  42304. }
  42305. #endif /* !SQLITE_OS_WINCE && !SQLITE_OS_WINRT && SQLITE_WIN32_USE_UUID */
  42306. return e.nXor>nBuf ? nBuf : e.nXor;
  42307. #endif /* defined(SQLITE_TEST) || defined(SQLITE_OMIT_RANDOMNESS) */
  42308. }
  42309. /*
  42310. ** Sleep for a little while. Return the amount of time slept.
  42311. */
  42312. static int winSleep(sqlite3_vfs *pVfs, int microsec){
  42313. sqlite3_win32_sleep((microsec+999)/1000);
  42314. UNUSED_PARAMETER(pVfs);
  42315. return ((microsec+999)/1000)*1000;
  42316. }
  42317. /*
  42318. ** The following variable, if set to a non-zero value, is interpreted as
  42319. ** the number of seconds since 1970 and is used to set the result of
  42320. ** sqlite3OsCurrentTime() during testing.
  42321. */
  42322. #ifdef SQLITE_TEST
  42323. SQLITE_API int sqlite3_current_time = 0; /* Fake system time in seconds since 1970. */
  42324. #endif
  42325. /*
  42326. ** Find the current time (in Universal Coordinated Time). Write into *piNow
  42327. ** the current time and date as a Julian Day number times 86_400_000. In
  42328. ** other words, write into *piNow the number of milliseconds since the Julian
  42329. ** epoch of noon in Greenwich on November 24, 4714 B.C according to the
  42330. ** proleptic Gregorian calendar.
  42331. **
  42332. ** On success, return SQLITE_OK. Return SQLITE_ERROR if the time and date
  42333. ** cannot be found.
  42334. */
  42335. static int winCurrentTimeInt64(sqlite3_vfs *pVfs, sqlite3_int64 *piNow){
  42336. /* FILETIME structure is a 64-bit value representing the number of
  42337. 100-nanosecond intervals since January 1, 1601 (= JD 2305813.5).
  42338. */
  42339. FILETIME ft;
  42340. static const sqlite3_int64 winFiletimeEpoch = 23058135*(sqlite3_int64)8640000;
  42341. #ifdef SQLITE_TEST
  42342. static const sqlite3_int64 unixEpoch = 24405875*(sqlite3_int64)8640000;
  42343. #endif
  42344. /* 2^32 - to avoid use of LL and warnings in gcc */
  42345. static const sqlite3_int64 max32BitValue =
  42346. (sqlite3_int64)2000000000 + (sqlite3_int64)2000000000 +
  42347. (sqlite3_int64)294967296;
  42348. #if SQLITE_OS_WINCE
  42349. SYSTEMTIME time;
  42350. osGetSystemTime(&time);
  42351. /* if SystemTimeToFileTime() fails, it returns zero. */
  42352. if (!osSystemTimeToFileTime(&time,&ft)){
  42353. return SQLITE_ERROR;
  42354. }
  42355. #else
  42356. osGetSystemTimeAsFileTime( &ft );
  42357. #endif
  42358. *piNow = winFiletimeEpoch +
  42359. ((((sqlite3_int64)ft.dwHighDateTime)*max32BitValue) +
  42360. (sqlite3_int64)ft.dwLowDateTime)/(sqlite3_int64)10000;
  42361. #ifdef SQLITE_TEST
  42362. if( sqlite3_current_time ){
  42363. *piNow = 1000*(sqlite3_int64)sqlite3_current_time + unixEpoch;
  42364. }
  42365. #endif
  42366. UNUSED_PARAMETER(pVfs);
  42367. return SQLITE_OK;
  42368. }
  42369. /*
  42370. ** Find the current time (in Universal Coordinated Time). Write the
  42371. ** current time and date as a Julian Day number into *prNow and
  42372. ** return 0. Return 1 if the time and date cannot be found.
  42373. */
  42374. static int winCurrentTime(sqlite3_vfs *pVfs, double *prNow){
  42375. int rc;
  42376. sqlite3_int64 i;
  42377. rc = winCurrentTimeInt64(pVfs, &i);
  42378. if( !rc ){
  42379. *prNow = i/86400000.0;
  42380. }
  42381. return rc;
  42382. }
  42383. /*
  42384. ** The idea is that this function works like a combination of
  42385. ** GetLastError() and FormatMessage() on Windows (or errno and
  42386. ** strerror_r() on Unix). After an error is returned by an OS
  42387. ** function, SQLite calls this function with zBuf pointing to
  42388. ** a buffer of nBuf bytes. The OS layer should populate the
  42389. ** buffer with a nul-terminated UTF-8 encoded error message
  42390. ** describing the last IO error to have occurred within the calling
  42391. ** thread.
  42392. **
  42393. ** If the error message is too large for the supplied buffer,
  42394. ** it should be truncated. The return value of xGetLastError
  42395. ** is zero if the error message fits in the buffer, or non-zero
  42396. ** otherwise (if the message was truncated). If non-zero is returned,
  42397. ** then it is not necessary to include the nul-terminator character
  42398. ** in the output buffer.
  42399. **
  42400. ** Not supplying an error message will have no adverse effect
  42401. ** on SQLite. It is fine to have an implementation that never
  42402. ** returns an error message:
  42403. **
  42404. ** int xGetLastError(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
  42405. ** assert(zBuf[0]=='\0');
  42406. ** return 0;
  42407. ** }
  42408. **
  42409. ** However if an error message is supplied, it will be incorporated
  42410. ** by sqlite into the error message available to the user using
  42411. ** sqlite3_errmsg(), possibly making IO errors easier to debug.
  42412. */
  42413. static int winGetLastError(sqlite3_vfs *pVfs, int nBuf, char *zBuf){
  42414. DWORD e = osGetLastError();
  42415. UNUSED_PARAMETER(pVfs);
  42416. if( nBuf>0 ) winGetLastErrorMsg(e, nBuf, zBuf);
  42417. return e;
  42418. }
  42419. /*
  42420. ** Initialize and deinitialize the operating system interface.
  42421. */
  42422. SQLITE_API int sqlite3_os_init(void){
  42423. static sqlite3_vfs winVfs = {
  42424. 3, /* iVersion */
  42425. sizeof(winFile), /* szOsFile */
  42426. SQLITE_WIN32_MAX_PATH_BYTES, /* mxPathname */
  42427. 0, /* pNext */
  42428. "win32", /* zName */
  42429. &winAppData, /* pAppData */
  42430. winOpen, /* xOpen */
  42431. winDelete, /* xDelete */
  42432. winAccess, /* xAccess */
  42433. winFullPathname, /* xFullPathname */
  42434. winDlOpen, /* xDlOpen */
  42435. winDlError, /* xDlError */
  42436. winDlSym, /* xDlSym */
  42437. winDlClose, /* xDlClose */
  42438. winRandomness, /* xRandomness */
  42439. winSleep, /* xSleep */
  42440. winCurrentTime, /* xCurrentTime */
  42441. winGetLastError, /* xGetLastError */
  42442. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  42443. winSetSystemCall, /* xSetSystemCall */
  42444. winGetSystemCall, /* xGetSystemCall */
  42445. winNextSystemCall, /* xNextSystemCall */
  42446. };
  42447. #if defined(SQLITE_WIN32_HAS_WIDE)
  42448. static sqlite3_vfs winLongPathVfs = {
  42449. 3, /* iVersion */
  42450. sizeof(winFile), /* szOsFile */
  42451. SQLITE_WINNT_MAX_PATH_BYTES, /* mxPathname */
  42452. 0, /* pNext */
  42453. "win32-longpath", /* zName */
  42454. &winAppData, /* pAppData */
  42455. winOpen, /* xOpen */
  42456. winDelete, /* xDelete */
  42457. winAccess, /* xAccess */
  42458. winFullPathname, /* xFullPathname */
  42459. winDlOpen, /* xDlOpen */
  42460. winDlError, /* xDlError */
  42461. winDlSym, /* xDlSym */
  42462. winDlClose, /* xDlClose */
  42463. winRandomness, /* xRandomness */
  42464. winSleep, /* xSleep */
  42465. winCurrentTime, /* xCurrentTime */
  42466. winGetLastError, /* xGetLastError */
  42467. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  42468. winSetSystemCall, /* xSetSystemCall */
  42469. winGetSystemCall, /* xGetSystemCall */
  42470. winNextSystemCall, /* xNextSystemCall */
  42471. };
  42472. #endif
  42473. static sqlite3_vfs winNolockVfs = {
  42474. 3, /* iVersion */
  42475. sizeof(winFile), /* szOsFile */
  42476. SQLITE_WIN32_MAX_PATH_BYTES, /* mxPathname */
  42477. 0, /* pNext */
  42478. "win32-none", /* zName */
  42479. &winNolockAppData, /* pAppData */
  42480. winOpen, /* xOpen */
  42481. winDelete, /* xDelete */
  42482. winAccess, /* xAccess */
  42483. winFullPathname, /* xFullPathname */
  42484. winDlOpen, /* xDlOpen */
  42485. winDlError, /* xDlError */
  42486. winDlSym, /* xDlSym */
  42487. winDlClose, /* xDlClose */
  42488. winRandomness, /* xRandomness */
  42489. winSleep, /* xSleep */
  42490. winCurrentTime, /* xCurrentTime */
  42491. winGetLastError, /* xGetLastError */
  42492. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  42493. winSetSystemCall, /* xSetSystemCall */
  42494. winGetSystemCall, /* xGetSystemCall */
  42495. winNextSystemCall, /* xNextSystemCall */
  42496. };
  42497. #if defined(SQLITE_WIN32_HAS_WIDE)
  42498. static sqlite3_vfs winLongPathNolockVfs = {
  42499. 3, /* iVersion */
  42500. sizeof(winFile), /* szOsFile */
  42501. SQLITE_WINNT_MAX_PATH_BYTES, /* mxPathname */
  42502. 0, /* pNext */
  42503. "win32-longpath-none", /* zName */
  42504. &winNolockAppData, /* pAppData */
  42505. winOpen, /* xOpen */
  42506. winDelete, /* xDelete */
  42507. winAccess, /* xAccess */
  42508. winFullPathname, /* xFullPathname */
  42509. winDlOpen, /* xDlOpen */
  42510. winDlError, /* xDlError */
  42511. winDlSym, /* xDlSym */
  42512. winDlClose, /* xDlClose */
  42513. winRandomness, /* xRandomness */
  42514. winSleep, /* xSleep */
  42515. winCurrentTime, /* xCurrentTime */
  42516. winGetLastError, /* xGetLastError */
  42517. winCurrentTimeInt64, /* xCurrentTimeInt64 */
  42518. winSetSystemCall, /* xSetSystemCall */
  42519. winGetSystemCall, /* xGetSystemCall */
  42520. winNextSystemCall, /* xNextSystemCall */
  42521. };
  42522. #endif
  42523. /* Double-check that the aSyscall[] array has been constructed
  42524. ** correctly. See ticket [bb3a86e890c8e96ab] */
  42525. assert( ArraySize(aSyscall)==80 );
  42526. /* get memory map allocation granularity */
  42527. memset(&winSysInfo, 0, sizeof(SYSTEM_INFO));
  42528. #if SQLITE_OS_WINRT
  42529. osGetNativeSystemInfo(&winSysInfo);
  42530. #else
  42531. osGetSystemInfo(&winSysInfo);
  42532. #endif
  42533. assert( winSysInfo.dwAllocationGranularity>0 );
  42534. assert( winSysInfo.dwPageSize>0 );
  42535. sqlite3_vfs_register(&winVfs, 1);
  42536. #if defined(SQLITE_WIN32_HAS_WIDE)
  42537. sqlite3_vfs_register(&winLongPathVfs, 0);
  42538. #endif
  42539. sqlite3_vfs_register(&winNolockVfs, 0);
  42540. #if defined(SQLITE_WIN32_HAS_WIDE)
  42541. sqlite3_vfs_register(&winLongPathNolockVfs, 0);
  42542. #endif
  42543. #ifndef SQLITE_OMIT_WAL
  42544. winBigLock = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_VFS1);
  42545. #endif
  42546. return SQLITE_OK;
  42547. }
  42548. SQLITE_API int sqlite3_os_end(void){
  42549. #if SQLITE_OS_WINRT
  42550. if( sleepObj!=NULL ){
  42551. osCloseHandle(sleepObj);
  42552. sleepObj = NULL;
  42553. }
  42554. #endif
  42555. #ifndef SQLITE_OMIT_WAL
  42556. winBigLock = 0;
  42557. #endif
  42558. return SQLITE_OK;
  42559. }
  42560. #endif /* SQLITE_OS_WIN */
  42561. /************** End of os_win.c **********************************************/
  42562. /************** Begin file memdb.c *******************************************/
  42563. /*
  42564. ** 2016-09-07
  42565. **
  42566. ** The author disclaims copyright to this source code. In place of
  42567. ** a legal notice, here is a blessing:
  42568. **
  42569. ** May you do good and not evil.
  42570. ** May you find forgiveness for yourself and forgive others.
  42571. ** May you share freely, never taking more than you give.
  42572. **
  42573. ******************************************************************************
  42574. **
  42575. ** This file implements an in-memory VFS. A database is held as a contiguous
  42576. ** block of memory.
  42577. **
  42578. ** This file also implements interface sqlite3_serialize() and
  42579. ** sqlite3_deserialize().
  42580. */
  42581. #ifdef SQLITE_ENABLE_DESERIALIZE
  42582. /* #include "sqliteInt.h" */
  42583. /*
  42584. ** Forward declaration of objects used by this utility
  42585. */
  42586. typedef struct sqlite3_vfs MemVfs;
  42587. typedef struct MemFile MemFile;
  42588. /* Access to a lower-level VFS that (might) implement dynamic loading,
  42589. ** access to randomness, etc.
  42590. */
  42591. #define ORIGVFS(p) ((sqlite3_vfs*)((p)->pAppData))
  42592. /* An open file */
  42593. struct MemFile {
  42594. sqlite3_file base; /* IO methods */
  42595. sqlite3_int64 sz; /* Size of the file */
  42596. sqlite3_int64 szMax; /* Space allocated to aData */
  42597. unsigned char *aData; /* content of the file */
  42598. int nMmap; /* Number of memory mapped pages */
  42599. unsigned mFlags; /* Flags */
  42600. int eLock; /* Most recent lock against this file */
  42601. };
  42602. /*
  42603. ** Methods for MemFile
  42604. */
  42605. static int memdbClose(sqlite3_file*);
  42606. static int memdbRead(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
  42607. static int memdbWrite(sqlite3_file*,const void*,int iAmt, sqlite3_int64 iOfst);
  42608. static int memdbTruncate(sqlite3_file*, sqlite3_int64 size);
  42609. static int memdbSync(sqlite3_file*, int flags);
  42610. static int memdbFileSize(sqlite3_file*, sqlite3_int64 *pSize);
  42611. static int memdbLock(sqlite3_file*, int);
  42612. /* static int memdbCheckReservedLock(sqlite3_file*, int *pResOut);// not used */
  42613. static int memdbFileControl(sqlite3_file*, int op, void *pArg);
  42614. /* static int memdbSectorSize(sqlite3_file*); // not used */
  42615. static int memdbDeviceCharacteristics(sqlite3_file*);
  42616. static int memdbFetch(sqlite3_file*, sqlite3_int64 iOfst, int iAmt, void **pp);
  42617. static int memdbUnfetch(sqlite3_file*, sqlite3_int64 iOfst, void *p);
  42618. /*
  42619. ** Methods for MemVfs
  42620. */
  42621. static int memdbOpen(sqlite3_vfs*, const char *, sqlite3_file*, int , int *);
  42622. /* static int memdbDelete(sqlite3_vfs*, const char *zName, int syncDir); */
  42623. static int memdbAccess(sqlite3_vfs*, const char *zName, int flags, int *);
  42624. static int memdbFullPathname(sqlite3_vfs*, const char *zName, int, char *zOut);
  42625. static void *memdbDlOpen(sqlite3_vfs*, const char *zFilename);
  42626. static void memdbDlError(sqlite3_vfs*, int nByte, char *zErrMsg);
  42627. static void (*memdbDlSym(sqlite3_vfs *pVfs, void *p, const char*zSym))(void);
  42628. static void memdbDlClose(sqlite3_vfs*, void*);
  42629. static int memdbRandomness(sqlite3_vfs*, int nByte, char *zOut);
  42630. static int memdbSleep(sqlite3_vfs*, int microseconds);
  42631. /* static int memdbCurrentTime(sqlite3_vfs*, double*); */
  42632. static int memdbGetLastError(sqlite3_vfs*, int, char *);
  42633. static int memdbCurrentTimeInt64(sqlite3_vfs*, sqlite3_int64*);
  42634. static sqlite3_vfs memdb_vfs = {
  42635. 2, /* iVersion */
  42636. 0, /* szOsFile (set when registered) */
  42637. 1024, /* mxPathname */
  42638. 0, /* pNext */
  42639. "memdb", /* zName */
  42640. 0, /* pAppData (set when registered) */
  42641. memdbOpen, /* xOpen */
  42642. 0, /* memdbDelete, */ /* xDelete */
  42643. memdbAccess, /* xAccess */
  42644. memdbFullPathname, /* xFullPathname */
  42645. memdbDlOpen, /* xDlOpen */
  42646. memdbDlError, /* xDlError */
  42647. memdbDlSym, /* xDlSym */
  42648. memdbDlClose, /* xDlClose */
  42649. memdbRandomness, /* xRandomness */
  42650. memdbSleep, /* xSleep */
  42651. 0, /* memdbCurrentTime, */ /* xCurrentTime */
  42652. memdbGetLastError, /* xGetLastError */
  42653. memdbCurrentTimeInt64 /* xCurrentTimeInt64 */
  42654. };
  42655. static const sqlite3_io_methods memdb_io_methods = {
  42656. 3, /* iVersion */
  42657. memdbClose, /* xClose */
  42658. memdbRead, /* xRead */
  42659. memdbWrite, /* xWrite */
  42660. memdbTruncate, /* xTruncate */
  42661. memdbSync, /* xSync */
  42662. memdbFileSize, /* xFileSize */
  42663. memdbLock, /* xLock */
  42664. memdbLock, /* xUnlock - same as xLock in this case */
  42665. 0, /* memdbCheckReservedLock, */ /* xCheckReservedLock */
  42666. memdbFileControl, /* xFileControl */
  42667. 0, /* memdbSectorSize,*/ /* xSectorSize */
  42668. memdbDeviceCharacteristics, /* xDeviceCharacteristics */
  42669. 0, /* xShmMap */
  42670. 0, /* xShmLock */
  42671. 0, /* xShmBarrier */
  42672. 0, /* xShmUnmap */
  42673. memdbFetch, /* xFetch */
  42674. memdbUnfetch /* xUnfetch */
  42675. };
  42676. /*
  42677. ** Close an memdb-file.
  42678. **
  42679. ** The pData pointer is owned by the application, so there is nothing
  42680. ** to free.
  42681. */
  42682. static int memdbClose(sqlite3_file *pFile){
  42683. MemFile *p = (MemFile *)pFile;
  42684. if( p->mFlags & SQLITE_DESERIALIZE_FREEONCLOSE ) sqlite3_free(p->aData);
  42685. return SQLITE_OK;
  42686. }
  42687. /*
  42688. ** Read data from an memdb-file.
  42689. */
  42690. static int memdbRead(
  42691. sqlite3_file *pFile,
  42692. void *zBuf,
  42693. int iAmt,
  42694. sqlite_int64 iOfst
  42695. ){
  42696. MemFile *p = (MemFile *)pFile;
  42697. if( iOfst+iAmt>p->sz ){
  42698. memset(zBuf, 0, iAmt);
  42699. if( iOfst<p->sz ) memcpy(zBuf, p->aData+iOfst, p->sz - iOfst);
  42700. return SQLITE_IOERR_SHORT_READ;
  42701. }
  42702. memcpy(zBuf, p->aData+iOfst, iAmt);
  42703. return SQLITE_OK;
  42704. }
  42705. /*
  42706. ** Try to enlarge the memory allocation to hold at least sz bytes
  42707. */
  42708. static int memdbEnlarge(MemFile *p, sqlite3_int64 newSz){
  42709. unsigned char *pNew;
  42710. if( (p->mFlags & SQLITE_DESERIALIZE_RESIZEABLE)==0 || p->nMmap>0 ){
  42711. return SQLITE_FULL;
  42712. }
  42713. pNew = sqlite3_realloc64(p->aData, newSz);
  42714. if( pNew==0 ) return SQLITE_NOMEM;
  42715. p->aData = pNew;
  42716. p->szMax = newSz;
  42717. return SQLITE_OK;
  42718. }
  42719. /*
  42720. ** Write data to an memdb-file.
  42721. */
  42722. static int memdbWrite(
  42723. sqlite3_file *pFile,
  42724. const void *z,
  42725. int iAmt,
  42726. sqlite_int64 iOfst
  42727. ){
  42728. MemFile *p = (MemFile *)pFile;
  42729. if( iOfst+iAmt>p->sz ){
  42730. int rc;
  42731. if( iOfst+iAmt>p->szMax
  42732. && (rc = memdbEnlarge(p, (iOfst+iAmt)*2))!=SQLITE_OK
  42733. ){
  42734. return rc;
  42735. }
  42736. if( iOfst>p->sz ) memset(p->aData+p->sz, 0, iOfst-p->sz);
  42737. p->sz = iOfst+iAmt;
  42738. }
  42739. memcpy(p->aData+iOfst, z, iAmt);
  42740. return SQLITE_OK;
  42741. }
  42742. /*
  42743. ** Truncate an memdb-file.
  42744. **
  42745. ** In rollback mode (which is always the case for memdb, as it does not
  42746. ** support WAL mode) the truncate() method is only used to reduce
  42747. ** the size of a file, never to increase the size.
  42748. */
  42749. static int memdbTruncate(sqlite3_file *pFile, sqlite_int64 size){
  42750. MemFile *p = (MemFile *)pFile;
  42751. if( NEVER(size>p->sz) ) return SQLITE_FULL;
  42752. p->sz = size;
  42753. return SQLITE_OK;
  42754. }
  42755. /*
  42756. ** Sync an memdb-file.
  42757. */
  42758. static int memdbSync(sqlite3_file *pFile, int flags){
  42759. return SQLITE_OK;
  42760. }
  42761. /*
  42762. ** Return the current file-size of an memdb-file.
  42763. */
  42764. static int memdbFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
  42765. MemFile *p = (MemFile *)pFile;
  42766. *pSize = p->sz;
  42767. return SQLITE_OK;
  42768. }
  42769. /*
  42770. ** Lock an memdb-file.
  42771. */
  42772. static int memdbLock(sqlite3_file *pFile, int eLock){
  42773. MemFile *p = (MemFile *)pFile;
  42774. p->eLock = eLock;
  42775. return SQLITE_OK;
  42776. }
  42777. #if 0 /* Never used because memdbAccess() always returns false */
  42778. /*
  42779. ** Check if another file-handle holds a RESERVED lock on an memdb-file.
  42780. */
  42781. static int memdbCheckReservedLock(sqlite3_file *pFile, int *pResOut){
  42782. *pResOut = 0;
  42783. return SQLITE_OK;
  42784. }
  42785. #endif
  42786. /*
  42787. ** File control method. For custom operations on an memdb-file.
  42788. */
  42789. static int memdbFileControl(sqlite3_file *pFile, int op, void *pArg){
  42790. MemFile *p = (MemFile *)pFile;
  42791. int rc = SQLITE_NOTFOUND;
  42792. if( op==SQLITE_FCNTL_VFSNAME ){
  42793. *(char**)pArg = sqlite3_mprintf("memdb(%p,%lld)", p->aData, p->sz);
  42794. rc = SQLITE_OK;
  42795. }
  42796. return rc;
  42797. }
  42798. #if 0 /* Not used because of SQLITE_IOCAP_POWERSAFE_OVERWRITE */
  42799. /*
  42800. ** Return the sector-size in bytes for an memdb-file.
  42801. */
  42802. static int memdbSectorSize(sqlite3_file *pFile){
  42803. return 1024;
  42804. }
  42805. #endif
  42806. /*
  42807. ** Return the device characteristic flags supported by an memdb-file.
  42808. */
  42809. static int memdbDeviceCharacteristics(sqlite3_file *pFile){
  42810. return SQLITE_IOCAP_ATOMIC |
  42811. SQLITE_IOCAP_POWERSAFE_OVERWRITE |
  42812. SQLITE_IOCAP_SAFE_APPEND |
  42813. SQLITE_IOCAP_SEQUENTIAL;
  42814. }
  42815. /* Fetch a page of a memory-mapped file */
  42816. static int memdbFetch(
  42817. sqlite3_file *pFile,
  42818. sqlite3_int64 iOfst,
  42819. int iAmt,
  42820. void **pp
  42821. ){
  42822. MemFile *p = (MemFile *)pFile;
  42823. p->nMmap++;
  42824. *pp = (void*)(p->aData + iOfst);
  42825. return SQLITE_OK;
  42826. }
  42827. /* Release a memory-mapped page */
  42828. static int memdbUnfetch(sqlite3_file *pFile, sqlite3_int64 iOfst, void *pPage){
  42829. MemFile *p = (MemFile *)pFile;
  42830. p->nMmap--;
  42831. return SQLITE_OK;
  42832. }
  42833. /*
  42834. ** Open an mem file handle.
  42835. */
  42836. static int memdbOpen(
  42837. sqlite3_vfs *pVfs,
  42838. const char *zName,
  42839. sqlite3_file *pFile,
  42840. int flags,
  42841. int *pOutFlags
  42842. ){
  42843. MemFile *p = (MemFile*)pFile;
  42844. if( (flags & SQLITE_OPEN_MAIN_DB)==0 ){
  42845. return ORIGVFS(pVfs)->xOpen(ORIGVFS(pVfs), zName, pFile, flags, pOutFlags);
  42846. }
  42847. memset(p, 0, sizeof(*p));
  42848. p->mFlags = SQLITE_DESERIALIZE_RESIZEABLE | SQLITE_DESERIALIZE_FREEONCLOSE;
  42849. assert( pOutFlags!=0 ); /* True because flags==SQLITE_OPEN_MAIN_DB */
  42850. *pOutFlags = flags | SQLITE_OPEN_MEMORY;
  42851. p->base.pMethods = &memdb_io_methods;
  42852. return SQLITE_OK;
  42853. }
  42854. #if 0 /* Only used to delete rollback journals, master journals, and WAL
  42855. ** files, none of which exist in memdb. So this routine is never used */
  42856. /*
  42857. ** Delete the file located at zPath. If the dirSync argument is true,
  42858. ** ensure the file-system modifications are synced to disk before
  42859. ** returning.
  42860. */
  42861. static int memdbDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
  42862. return SQLITE_IOERR_DELETE;
  42863. }
  42864. #endif
  42865. /*
  42866. ** Test for access permissions. Return true if the requested permission
  42867. ** is available, or false otherwise.
  42868. **
  42869. ** With memdb, no files ever exist on disk. So always return false.
  42870. */
  42871. static int memdbAccess(
  42872. sqlite3_vfs *pVfs,
  42873. const char *zPath,
  42874. int flags,
  42875. int *pResOut
  42876. ){
  42877. *pResOut = 0;
  42878. return SQLITE_OK;
  42879. }
  42880. /*
  42881. ** Populate buffer zOut with the full canonical pathname corresponding
  42882. ** to the pathname in zPath. zOut is guaranteed to point to a buffer
  42883. ** of at least (INST_MAX_PATHNAME+1) bytes.
  42884. */
  42885. static int memdbFullPathname(
  42886. sqlite3_vfs *pVfs,
  42887. const char *zPath,
  42888. int nOut,
  42889. char *zOut
  42890. ){
  42891. sqlite3_snprintf(nOut, zOut, "%s", zPath);
  42892. return SQLITE_OK;
  42893. }
  42894. /*
  42895. ** Open the dynamic library located at zPath and return a handle.
  42896. */
  42897. static void *memdbDlOpen(sqlite3_vfs *pVfs, const char *zPath){
  42898. return ORIGVFS(pVfs)->xDlOpen(ORIGVFS(pVfs), zPath);
  42899. }
  42900. /*
  42901. ** Populate the buffer zErrMsg (size nByte bytes) with a human readable
  42902. ** utf-8 string describing the most recent error encountered associated
  42903. ** with dynamic libraries.
  42904. */
  42905. static void memdbDlError(sqlite3_vfs *pVfs, int nByte, char *zErrMsg){
  42906. ORIGVFS(pVfs)->xDlError(ORIGVFS(pVfs), nByte, zErrMsg);
  42907. }
  42908. /*
  42909. ** Return a pointer to the symbol zSymbol in the dynamic library pHandle.
  42910. */
  42911. static void (*memdbDlSym(sqlite3_vfs *pVfs, void *p, const char *zSym))(void){
  42912. return ORIGVFS(pVfs)->xDlSym(ORIGVFS(pVfs), p, zSym);
  42913. }
  42914. /*
  42915. ** Close the dynamic library handle pHandle.
  42916. */
  42917. static void memdbDlClose(sqlite3_vfs *pVfs, void *pHandle){
  42918. ORIGVFS(pVfs)->xDlClose(ORIGVFS(pVfs), pHandle);
  42919. }
  42920. /*
  42921. ** Populate the buffer pointed to by zBufOut with nByte bytes of
  42922. ** random data.
  42923. */
  42924. static int memdbRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  42925. return ORIGVFS(pVfs)->xRandomness(ORIGVFS(pVfs), nByte, zBufOut);
  42926. }
  42927. /*
  42928. ** Sleep for nMicro microseconds. Return the number of microseconds
  42929. ** actually slept.
  42930. */
  42931. static int memdbSleep(sqlite3_vfs *pVfs, int nMicro){
  42932. return ORIGVFS(pVfs)->xSleep(ORIGVFS(pVfs), nMicro);
  42933. }
  42934. #if 0 /* Never used. Modern cores only call xCurrentTimeInt64() */
  42935. /*
  42936. ** Return the current time as a Julian Day number in *pTimeOut.
  42937. */
  42938. static int memdbCurrentTime(sqlite3_vfs *pVfs, double *pTimeOut){
  42939. return ORIGVFS(pVfs)->xCurrentTime(ORIGVFS(pVfs), pTimeOut);
  42940. }
  42941. #endif
  42942. static int memdbGetLastError(sqlite3_vfs *pVfs, int a, char *b){
  42943. return ORIGVFS(pVfs)->xGetLastError(ORIGVFS(pVfs), a, b);
  42944. }
  42945. static int memdbCurrentTimeInt64(sqlite3_vfs *pVfs, sqlite3_int64 *p){
  42946. return ORIGVFS(pVfs)->xCurrentTimeInt64(ORIGVFS(pVfs), p);
  42947. }
  42948. /*
  42949. ** Translate a database connection pointer and schema name into a
  42950. ** MemFile pointer.
  42951. */
  42952. static MemFile *memdbFromDbSchema(sqlite3 *db, const char *zSchema){
  42953. MemFile *p = 0;
  42954. int rc = sqlite3_file_control(db, zSchema, SQLITE_FCNTL_FILE_POINTER, &p);
  42955. if( rc ) return 0;
  42956. if( p->base.pMethods!=&memdb_io_methods ) return 0;
  42957. return p;
  42958. }
  42959. /*
  42960. ** Return the serialization of a database
  42961. */
  42962. SQLITE_API unsigned char *sqlite3_serialize(
  42963. sqlite3 *db, /* The database connection */
  42964. const char *zSchema, /* Which database within the connection */
  42965. sqlite3_int64 *piSize, /* Write size here, if not NULL */
  42966. unsigned int mFlags /* Maybe SQLITE_SERIALIZE_NOCOPY */
  42967. ){
  42968. MemFile *p;
  42969. int iDb;
  42970. Btree *pBt;
  42971. sqlite3_int64 sz;
  42972. int szPage = 0;
  42973. sqlite3_stmt *pStmt = 0;
  42974. unsigned char *pOut;
  42975. char *zSql;
  42976. int rc;
  42977. #ifdef SQLITE_ENABLE_API_ARMOR
  42978. if( !sqlite3SafetyCheckOk(db) ){
  42979. (void)SQLITE_MISUSE_BKPT;
  42980. return 0;
  42981. }
  42982. #endif
  42983. if( zSchema==0 ) zSchema = db->aDb[0].zDbSName;
  42984. p = memdbFromDbSchema(db, zSchema);
  42985. iDb = sqlite3FindDbName(db, zSchema);
  42986. if( piSize ) *piSize = -1;
  42987. if( iDb<0 ) return 0;
  42988. if( p ){
  42989. if( piSize ) *piSize = p->sz;
  42990. if( mFlags & SQLITE_SERIALIZE_NOCOPY ){
  42991. pOut = p->aData;
  42992. }else{
  42993. pOut = sqlite3_malloc64( p->sz );
  42994. if( pOut ) memcpy(pOut, p->aData, p->sz);
  42995. }
  42996. return pOut;
  42997. }
  42998. pBt = db->aDb[iDb].pBt;
  42999. if( pBt==0 ) return 0;
  43000. szPage = sqlite3BtreeGetPageSize(pBt);
  43001. zSql = sqlite3_mprintf("PRAGMA \"%w\".page_count", zSchema);
  43002. rc = zSql ? sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0) : SQLITE_NOMEM;
  43003. sqlite3_free(zSql);
  43004. if( rc ) return 0;
  43005. rc = sqlite3_step(pStmt);
  43006. if( rc!=SQLITE_ROW ){
  43007. pOut = 0;
  43008. }else{
  43009. sz = sqlite3_column_int64(pStmt, 0)*szPage;
  43010. if( piSize ) *piSize = sz;
  43011. if( mFlags & SQLITE_SERIALIZE_NOCOPY ){
  43012. pOut = 0;
  43013. }else{
  43014. pOut = sqlite3_malloc64( sz );
  43015. if( pOut ){
  43016. int nPage = sqlite3_column_int(pStmt, 0);
  43017. Pager *pPager = sqlite3BtreePager(pBt);
  43018. int pgno;
  43019. for(pgno=1; pgno<=nPage; pgno++){
  43020. DbPage *pPage = 0;
  43021. unsigned char *pTo = pOut + szPage*(sqlite3_int64)(pgno-1);
  43022. rc = sqlite3PagerGet(pPager, pgno, (DbPage**)&pPage, 0);
  43023. if( rc==SQLITE_OK ){
  43024. memcpy(pTo, sqlite3PagerGetData(pPage), szPage);
  43025. }else{
  43026. memset(pTo, 0, szPage);
  43027. }
  43028. sqlite3PagerUnref(pPage);
  43029. }
  43030. }
  43031. }
  43032. }
  43033. sqlite3_finalize(pStmt);
  43034. return pOut;
  43035. }
  43036. /* Convert zSchema to a MemDB and initialize its content.
  43037. */
  43038. SQLITE_API int sqlite3_deserialize(
  43039. sqlite3 *db, /* The database connection */
  43040. const char *zSchema, /* Which DB to reopen with the deserialization */
  43041. unsigned char *pData, /* The serialized database content */
  43042. sqlite3_int64 szDb, /* Number bytes in the deserialization */
  43043. sqlite3_int64 szBuf, /* Total size of buffer pData[] */
  43044. unsigned mFlags /* Zero or more SQLITE_DESERIALIZE_* flags */
  43045. ){
  43046. MemFile *p;
  43047. char *zSql;
  43048. sqlite3_stmt *pStmt = 0;
  43049. int rc;
  43050. int iDb;
  43051. #ifdef SQLITE_ENABLE_API_ARMOR
  43052. if( !sqlite3SafetyCheckOk(db) ){
  43053. return SQLITE_MISUSE_BKPT;
  43054. }
  43055. if( szDb<0 ) return SQLITE_MISUSE_BKPT;
  43056. if( szBuf<0 ) return SQLITE_MISUSE_BKPT;
  43057. #endif
  43058. sqlite3_mutex_enter(db->mutex);
  43059. if( zSchema==0 ) zSchema = db->aDb[0].zDbSName;
  43060. iDb = sqlite3FindDbName(db, zSchema);
  43061. if( iDb<0 ){
  43062. rc = SQLITE_ERROR;
  43063. goto end_deserialize;
  43064. }
  43065. zSql = sqlite3_mprintf("ATTACH x AS %Q", zSchema);
  43066. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  43067. sqlite3_free(zSql);
  43068. if( rc ) goto end_deserialize;
  43069. db->init.iDb = (u8)iDb;
  43070. db->init.reopenMemdb = 1;
  43071. rc = sqlite3_step(pStmt);
  43072. db->init.reopenMemdb = 0;
  43073. if( rc!=SQLITE_DONE ){
  43074. rc = SQLITE_ERROR;
  43075. goto end_deserialize;
  43076. }
  43077. p = memdbFromDbSchema(db, zSchema);
  43078. if( p==0 ){
  43079. rc = SQLITE_ERROR;
  43080. }else{
  43081. p->aData = pData;
  43082. p->sz = szDb;
  43083. p->szMax = szBuf;
  43084. p->mFlags = mFlags;
  43085. rc = SQLITE_OK;
  43086. }
  43087. end_deserialize:
  43088. sqlite3_finalize(pStmt);
  43089. sqlite3_mutex_leave(db->mutex);
  43090. return rc;
  43091. }
  43092. /*
  43093. ** This routine is called when the extension is loaded.
  43094. ** Register the new VFS.
  43095. */
  43096. SQLITE_PRIVATE int sqlite3MemdbInit(void){
  43097. sqlite3_vfs *pLower = sqlite3_vfs_find(0);
  43098. int sz = pLower->szOsFile;
  43099. memdb_vfs.pAppData = pLower;
  43100. /* In all known configurations of SQLite, the size of a default
  43101. ** sqlite3_file is greater than the size of a memdb sqlite3_file.
  43102. ** Should that ever change, remove the following NEVER() */
  43103. if( NEVER(sz<sizeof(MemFile)) ) sz = sizeof(MemFile);
  43104. memdb_vfs.szOsFile = sz;
  43105. return sqlite3_vfs_register(&memdb_vfs, 0);
  43106. }
  43107. #endif /* SQLITE_ENABLE_DESERIALIZE */
  43108. /************** End of memdb.c ***********************************************/
  43109. /************** Begin file bitvec.c ******************************************/
  43110. /*
  43111. ** 2008 February 16
  43112. **
  43113. ** The author disclaims copyright to this source code. In place of
  43114. ** a legal notice, here is a blessing:
  43115. **
  43116. ** May you do good and not evil.
  43117. ** May you find forgiveness for yourself and forgive others.
  43118. ** May you share freely, never taking more than you give.
  43119. **
  43120. *************************************************************************
  43121. ** This file implements an object that represents a fixed-length
  43122. ** bitmap. Bits are numbered starting with 1.
  43123. **
  43124. ** A bitmap is used to record which pages of a database file have been
  43125. ** journalled during a transaction, or which pages have the "dont-write"
  43126. ** property. Usually only a few pages are meet either condition.
  43127. ** So the bitmap is usually sparse and has low cardinality.
  43128. ** But sometimes (for example when during a DROP of a large table) most
  43129. ** or all of the pages in a database can get journalled. In those cases,
  43130. ** the bitmap becomes dense with high cardinality. The algorithm needs
  43131. ** to handle both cases well.
  43132. **
  43133. ** The size of the bitmap is fixed when the object is created.
  43134. **
  43135. ** All bits are clear when the bitmap is created. Individual bits
  43136. ** may be set or cleared one at a time.
  43137. **
  43138. ** Test operations are about 100 times more common that set operations.
  43139. ** Clear operations are exceedingly rare. There are usually between
  43140. ** 5 and 500 set operations per Bitvec object, though the number of sets can
  43141. ** sometimes grow into tens of thousands or larger. The size of the
  43142. ** Bitvec object is the number of pages in the database file at the
  43143. ** start of a transaction, and is thus usually less than a few thousand,
  43144. ** but can be as large as 2 billion for a really big database.
  43145. */
  43146. /* #include "sqliteInt.h" */
  43147. /* Size of the Bitvec structure in bytes. */
  43148. #define BITVEC_SZ 512
  43149. /* Round the union size down to the nearest pointer boundary, since that's how
  43150. ** it will be aligned within the Bitvec struct. */
  43151. #define BITVEC_USIZE \
  43152. (((BITVEC_SZ-(3*sizeof(u32)))/sizeof(Bitvec*))*sizeof(Bitvec*))
  43153. /* Type of the array "element" for the bitmap representation.
  43154. ** Should be a power of 2, and ideally, evenly divide into BITVEC_USIZE.
  43155. ** Setting this to the "natural word" size of your CPU may improve
  43156. ** performance. */
  43157. #define BITVEC_TELEM u8
  43158. /* Size, in bits, of the bitmap element. */
  43159. #define BITVEC_SZELEM 8
  43160. /* Number of elements in a bitmap array. */
  43161. #define BITVEC_NELEM (BITVEC_USIZE/sizeof(BITVEC_TELEM))
  43162. /* Number of bits in the bitmap array. */
  43163. #define BITVEC_NBIT (BITVEC_NELEM*BITVEC_SZELEM)
  43164. /* Number of u32 values in hash table. */
  43165. #define BITVEC_NINT (BITVEC_USIZE/sizeof(u32))
  43166. /* Maximum number of entries in hash table before
  43167. ** sub-dividing and re-hashing. */
  43168. #define BITVEC_MXHASH (BITVEC_NINT/2)
  43169. /* Hashing function for the aHash representation.
  43170. ** Empirical testing showed that the *37 multiplier
  43171. ** (an arbitrary prime)in the hash function provided
  43172. ** no fewer collisions than the no-op *1. */
  43173. #define BITVEC_HASH(X) (((X)*1)%BITVEC_NINT)
  43174. #define BITVEC_NPTR (BITVEC_USIZE/sizeof(Bitvec *))
  43175. /*
  43176. ** A bitmap is an instance of the following structure.
  43177. **
  43178. ** This bitmap records the existence of zero or more bits
  43179. ** with values between 1 and iSize, inclusive.
  43180. **
  43181. ** There are three possible representations of the bitmap.
  43182. ** If iSize<=BITVEC_NBIT, then Bitvec.u.aBitmap[] is a straight
  43183. ** bitmap. The least significant bit is bit 1.
  43184. **
  43185. ** If iSize>BITVEC_NBIT and iDivisor==0 then Bitvec.u.aHash[] is
  43186. ** a hash table that will hold up to BITVEC_MXHASH distinct values.
  43187. **
  43188. ** Otherwise, the value i is redirected into one of BITVEC_NPTR
  43189. ** sub-bitmaps pointed to by Bitvec.u.apSub[]. Each subbitmap
  43190. ** handles up to iDivisor separate values of i. apSub[0] holds
  43191. ** values between 1 and iDivisor. apSub[1] holds values between
  43192. ** iDivisor+1 and 2*iDivisor. apSub[N] holds values between
  43193. ** N*iDivisor+1 and (N+1)*iDivisor. Each subbitmap is normalized
  43194. ** to hold deal with values between 1 and iDivisor.
  43195. */
  43196. struct Bitvec {
  43197. u32 iSize; /* Maximum bit index. Max iSize is 4,294,967,296. */
  43198. u32 nSet; /* Number of bits that are set - only valid for aHash
  43199. ** element. Max is BITVEC_NINT. For BITVEC_SZ of 512,
  43200. ** this would be 125. */
  43201. u32 iDivisor; /* Number of bits handled by each apSub[] entry. */
  43202. /* Should >=0 for apSub element. */
  43203. /* Max iDivisor is max(u32) / BITVEC_NPTR + 1. */
  43204. /* For a BITVEC_SZ of 512, this would be 34,359,739. */
  43205. union {
  43206. BITVEC_TELEM aBitmap[BITVEC_NELEM]; /* Bitmap representation */
  43207. u32 aHash[BITVEC_NINT]; /* Hash table representation */
  43208. Bitvec *apSub[BITVEC_NPTR]; /* Recursive representation */
  43209. } u;
  43210. };
  43211. /*
  43212. ** Create a new bitmap object able to handle bits between 0 and iSize,
  43213. ** inclusive. Return a pointer to the new object. Return NULL if
  43214. ** malloc fails.
  43215. */
  43216. SQLITE_PRIVATE Bitvec *sqlite3BitvecCreate(u32 iSize){
  43217. Bitvec *p;
  43218. assert( sizeof(*p)==BITVEC_SZ );
  43219. p = sqlite3MallocZero( sizeof(*p) );
  43220. if( p ){
  43221. p->iSize = iSize;
  43222. }
  43223. return p;
  43224. }
  43225. /*
  43226. ** Check to see if the i-th bit is set. Return true or false.
  43227. ** If p is NULL (if the bitmap has not been created) or if
  43228. ** i is out of range, then return false.
  43229. */
  43230. SQLITE_PRIVATE int sqlite3BitvecTestNotNull(Bitvec *p, u32 i){
  43231. assert( p!=0 );
  43232. i--;
  43233. if( i>=p->iSize ) return 0;
  43234. while( p->iDivisor ){
  43235. u32 bin = i/p->iDivisor;
  43236. i = i%p->iDivisor;
  43237. p = p->u.apSub[bin];
  43238. if (!p) {
  43239. return 0;
  43240. }
  43241. }
  43242. if( p->iSize<=BITVEC_NBIT ){
  43243. return (p->u.aBitmap[i/BITVEC_SZELEM] & (1<<(i&(BITVEC_SZELEM-1))))!=0;
  43244. } else{
  43245. u32 h = BITVEC_HASH(i++);
  43246. while( p->u.aHash[h] ){
  43247. if( p->u.aHash[h]==i ) return 1;
  43248. h = (h+1) % BITVEC_NINT;
  43249. }
  43250. return 0;
  43251. }
  43252. }
  43253. SQLITE_PRIVATE int sqlite3BitvecTest(Bitvec *p, u32 i){
  43254. return p!=0 && sqlite3BitvecTestNotNull(p,i);
  43255. }
  43256. /*
  43257. ** Set the i-th bit. Return 0 on success and an error code if
  43258. ** anything goes wrong.
  43259. **
  43260. ** This routine might cause sub-bitmaps to be allocated. Failing
  43261. ** to get the memory needed to hold the sub-bitmap is the only
  43262. ** that can go wrong with an insert, assuming p and i are valid.
  43263. **
  43264. ** The calling function must ensure that p is a valid Bitvec object
  43265. ** and that the value for "i" is within range of the Bitvec object.
  43266. ** Otherwise the behavior is undefined.
  43267. */
  43268. SQLITE_PRIVATE int sqlite3BitvecSet(Bitvec *p, u32 i){
  43269. u32 h;
  43270. if( p==0 ) return SQLITE_OK;
  43271. assert( i>0 );
  43272. assert( i<=p->iSize );
  43273. i--;
  43274. while((p->iSize > BITVEC_NBIT) && p->iDivisor) {
  43275. u32 bin = i/p->iDivisor;
  43276. i = i%p->iDivisor;
  43277. if( p->u.apSub[bin]==0 ){
  43278. p->u.apSub[bin] = sqlite3BitvecCreate( p->iDivisor );
  43279. if( p->u.apSub[bin]==0 ) return SQLITE_NOMEM_BKPT;
  43280. }
  43281. p = p->u.apSub[bin];
  43282. }
  43283. if( p->iSize<=BITVEC_NBIT ){
  43284. p->u.aBitmap[i/BITVEC_SZELEM] |= 1 << (i&(BITVEC_SZELEM-1));
  43285. return SQLITE_OK;
  43286. }
  43287. h = BITVEC_HASH(i++);
  43288. /* if there wasn't a hash collision, and this doesn't */
  43289. /* completely fill the hash, then just add it without */
  43290. /* worring about sub-dividing and re-hashing. */
  43291. if( !p->u.aHash[h] ){
  43292. if (p->nSet<(BITVEC_NINT-1)) {
  43293. goto bitvec_set_end;
  43294. } else {
  43295. goto bitvec_set_rehash;
  43296. }
  43297. }
  43298. /* there was a collision, check to see if it's already */
  43299. /* in hash, if not, try to find a spot for it */
  43300. do {
  43301. if( p->u.aHash[h]==i ) return SQLITE_OK;
  43302. h++;
  43303. if( h>=BITVEC_NINT ) h = 0;
  43304. } while( p->u.aHash[h] );
  43305. /* we didn't find it in the hash. h points to the first */
  43306. /* available free spot. check to see if this is going to */
  43307. /* make our hash too "full". */
  43308. bitvec_set_rehash:
  43309. if( p->nSet>=BITVEC_MXHASH ){
  43310. unsigned int j;
  43311. int rc;
  43312. u32 *aiValues = sqlite3StackAllocRaw(0, sizeof(p->u.aHash));
  43313. if( aiValues==0 ){
  43314. return SQLITE_NOMEM_BKPT;
  43315. }else{
  43316. memcpy(aiValues, p->u.aHash, sizeof(p->u.aHash));
  43317. memset(p->u.apSub, 0, sizeof(p->u.apSub));
  43318. p->iDivisor = (p->iSize + BITVEC_NPTR - 1)/BITVEC_NPTR;
  43319. rc = sqlite3BitvecSet(p, i);
  43320. for(j=0; j<BITVEC_NINT; j++){
  43321. if( aiValues[j] ) rc |= sqlite3BitvecSet(p, aiValues[j]);
  43322. }
  43323. sqlite3StackFree(0, aiValues);
  43324. return rc;
  43325. }
  43326. }
  43327. bitvec_set_end:
  43328. p->nSet++;
  43329. p->u.aHash[h] = i;
  43330. return SQLITE_OK;
  43331. }
  43332. /*
  43333. ** Clear the i-th bit.
  43334. **
  43335. ** pBuf must be a pointer to at least BITVEC_SZ bytes of temporary storage
  43336. ** that BitvecClear can use to rebuilt its hash table.
  43337. */
  43338. SQLITE_PRIVATE void sqlite3BitvecClear(Bitvec *p, u32 i, void *pBuf){
  43339. if( p==0 ) return;
  43340. assert( i>0 );
  43341. i--;
  43342. while( p->iDivisor ){
  43343. u32 bin = i/p->iDivisor;
  43344. i = i%p->iDivisor;
  43345. p = p->u.apSub[bin];
  43346. if (!p) {
  43347. return;
  43348. }
  43349. }
  43350. if( p->iSize<=BITVEC_NBIT ){
  43351. p->u.aBitmap[i/BITVEC_SZELEM] &= ~(1 << (i&(BITVEC_SZELEM-1)));
  43352. }else{
  43353. unsigned int j;
  43354. u32 *aiValues = pBuf;
  43355. memcpy(aiValues, p->u.aHash, sizeof(p->u.aHash));
  43356. memset(p->u.aHash, 0, sizeof(p->u.aHash));
  43357. p->nSet = 0;
  43358. for(j=0; j<BITVEC_NINT; j++){
  43359. if( aiValues[j] && aiValues[j]!=(i+1) ){
  43360. u32 h = BITVEC_HASH(aiValues[j]-1);
  43361. p->nSet++;
  43362. while( p->u.aHash[h] ){
  43363. h++;
  43364. if( h>=BITVEC_NINT ) h = 0;
  43365. }
  43366. p->u.aHash[h] = aiValues[j];
  43367. }
  43368. }
  43369. }
  43370. }
  43371. /*
  43372. ** Destroy a bitmap object. Reclaim all memory used.
  43373. */
  43374. SQLITE_PRIVATE void sqlite3BitvecDestroy(Bitvec *p){
  43375. if( p==0 ) return;
  43376. if( p->iDivisor ){
  43377. unsigned int i;
  43378. for(i=0; i<BITVEC_NPTR; i++){
  43379. sqlite3BitvecDestroy(p->u.apSub[i]);
  43380. }
  43381. }
  43382. sqlite3_free(p);
  43383. }
  43384. /*
  43385. ** Return the value of the iSize parameter specified when Bitvec *p
  43386. ** was created.
  43387. */
  43388. SQLITE_PRIVATE u32 sqlite3BitvecSize(Bitvec *p){
  43389. return p->iSize;
  43390. }
  43391. #ifndef SQLITE_UNTESTABLE
  43392. /*
  43393. ** Let V[] be an array of unsigned characters sufficient to hold
  43394. ** up to N bits. Let I be an integer between 0 and N. 0<=I<N.
  43395. ** Then the following macros can be used to set, clear, or test
  43396. ** individual bits within V.
  43397. */
  43398. #define SETBIT(V,I) V[I>>3] |= (1<<(I&7))
  43399. #define CLEARBIT(V,I) V[I>>3] &= ~(1<<(I&7))
  43400. #define TESTBIT(V,I) (V[I>>3]&(1<<(I&7)))!=0
  43401. /*
  43402. ** This routine runs an extensive test of the Bitvec code.
  43403. **
  43404. ** The input is an array of integers that acts as a program
  43405. ** to test the Bitvec. The integers are opcodes followed
  43406. ** by 0, 1, or 3 operands, depending on the opcode. Another
  43407. ** opcode follows immediately after the last operand.
  43408. **
  43409. ** There are 6 opcodes numbered from 0 through 5. 0 is the
  43410. ** "halt" opcode and causes the test to end.
  43411. **
  43412. ** 0 Halt and return the number of errors
  43413. ** 1 N S X Set N bits beginning with S and incrementing by X
  43414. ** 2 N S X Clear N bits beginning with S and incrementing by X
  43415. ** 3 N Set N randomly chosen bits
  43416. ** 4 N Clear N randomly chosen bits
  43417. ** 5 N S X Set N bits from S increment X in array only, not in bitvec
  43418. **
  43419. ** The opcodes 1 through 4 perform set and clear operations are performed
  43420. ** on both a Bitvec object and on a linear array of bits obtained from malloc.
  43421. ** Opcode 5 works on the linear array only, not on the Bitvec.
  43422. ** Opcode 5 is used to deliberately induce a fault in order to
  43423. ** confirm that error detection works.
  43424. **
  43425. ** At the conclusion of the test the linear array is compared
  43426. ** against the Bitvec object. If there are any differences,
  43427. ** an error is returned. If they are the same, zero is returned.
  43428. **
  43429. ** If a memory allocation error occurs, return -1.
  43430. */
  43431. SQLITE_PRIVATE int sqlite3BitvecBuiltinTest(int sz, int *aOp){
  43432. Bitvec *pBitvec = 0;
  43433. unsigned char *pV = 0;
  43434. int rc = -1;
  43435. int i, nx, pc, op;
  43436. void *pTmpSpace;
  43437. /* Allocate the Bitvec to be tested and a linear array of
  43438. ** bits to act as the reference */
  43439. pBitvec = sqlite3BitvecCreate( sz );
  43440. pV = sqlite3MallocZero( (sz+7)/8 + 1 );
  43441. pTmpSpace = sqlite3_malloc64(BITVEC_SZ);
  43442. if( pBitvec==0 || pV==0 || pTmpSpace==0 ) goto bitvec_end;
  43443. /* NULL pBitvec tests */
  43444. sqlite3BitvecSet(0, 1);
  43445. sqlite3BitvecClear(0, 1, pTmpSpace);
  43446. /* Run the program */
  43447. pc = 0;
  43448. while( (op = aOp[pc])!=0 ){
  43449. switch( op ){
  43450. case 1:
  43451. case 2:
  43452. case 5: {
  43453. nx = 4;
  43454. i = aOp[pc+2] - 1;
  43455. aOp[pc+2] += aOp[pc+3];
  43456. break;
  43457. }
  43458. case 3:
  43459. case 4:
  43460. default: {
  43461. nx = 2;
  43462. sqlite3_randomness(sizeof(i), &i);
  43463. break;
  43464. }
  43465. }
  43466. if( (--aOp[pc+1]) > 0 ) nx = 0;
  43467. pc += nx;
  43468. i = (i & 0x7fffffff)%sz;
  43469. if( (op & 1)!=0 ){
  43470. SETBIT(pV, (i+1));
  43471. if( op!=5 ){
  43472. if( sqlite3BitvecSet(pBitvec, i+1) ) goto bitvec_end;
  43473. }
  43474. }else{
  43475. CLEARBIT(pV, (i+1));
  43476. sqlite3BitvecClear(pBitvec, i+1, pTmpSpace);
  43477. }
  43478. }
  43479. /* Test to make sure the linear array exactly matches the
  43480. ** Bitvec object. Start with the assumption that they do
  43481. ** match (rc==0). Change rc to non-zero if a discrepancy
  43482. ** is found.
  43483. */
  43484. rc = sqlite3BitvecTest(0,0) + sqlite3BitvecTest(pBitvec, sz+1)
  43485. + sqlite3BitvecTest(pBitvec, 0)
  43486. + (sqlite3BitvecSize(pBitvec) - sz);
  43487. for(i=1; i<=sz; i++){
  43488. if( (TESTBIT(pV,i))!=sqlite3BitvecTest(pBitvec,i) ){
  43489. rc = i;
  43490. break;
  43491. }
  43492. }
  43493. /* Free allocated structure */
  43494. bitvec_end:
  43495. sqlite3_free(pTmpSpace);
  43496. sqlite3_free(pV);
  43497. sqlite3BitvecDestroy(pBitvec);
  43498. return rc;
  43499. }
  43500. #endif /* SQLITE_UNTESTABLE */
  43501. /************** End of bitvec.c **********************************************/
  43502. /************** Begin file pcache.c ******************************************/
  43503. /*
  43504. ** 2008 August 05
  43505. **
  43506. ** The author disclaims copyright to this source code. In place of
  43507. ** a legal notice, here is a blessing:
  43508. **
  43509. ** May you do good and not evil.
  43510. ** May you find forgiveness for yourself and forgive others.
  43511. ** May you share freely, never taking more than you give.
  43512. **
  43513. *************************************************************************
  43514. ** This file implements that page cache.
  43515. */
  43516. /* #include "sqliteInt.h" */
  43517. /*
  43518. ** A complete page cache is an instance of this structure. Every
  43519. ** entry in the cache holds a single page of the database file. The
  43520. ** btree layer only operates on the cached copy of the database pages.
  43521. **
  43522. ** A page cache entry is "clean" if it exactly matches what is currently
  43523. ** on disk. A page is "dirty" if it has been modified and needs to be
  43524. ** persisted to disk.
  43525. **
  43526. ** pDirty, pDirtyTail, pSynced:
  43527. ** All dirty pages are linked into the doubly linked list using
  43528. ** PgHdr.pDirtyNext and pDirtyPrev. The list is maintained in LRU order
  43529. ** such that p was added to the list more recently than p->pDirtyNext.
  43530. ** PCache.pDirty points to the first (newest) element in the list and
  43531. ** pDirtyTail to the last (oldest).
  43532. **
  43533. ** The PCache.pSynced variable is used to optimize searching for a dirty
  43534. ** page to eject from the cache mid-transaction. It is better to eject
  43535. ** a page that does not require a journal sync than one that does.
  43536. ** Therefore, pSynced is maintained to that it *almost* always points
  43537. ** to either the oldest page in the pDirty/pDirtyTail list that has a
  43538. ** clear PGHDR_NEED_SYNC flag or to a page that is older than this one
  43539. ** (so that the right page to eject can be found by following pDirtyPrev
  43540. ** pointers).
  43541. */
  43542. struct PCache {
  43543. PgHdr *pDirty, *pDirtyTail; /* List of dirty pages in LRU order */
  43544. PgHdr *pSynced; /* Last synced page in dirty page list */
  43545. int nRefSum; /* Sum of ref counts over all pages */
  43546. int szCache; /* Configured cache size */
  43547. int szSpill; /* Size before spilling occurs */
  43548. int szPage; /* Size of every page in this cache */
  43549. int szExtra; /* Size of extra space for each page */
  43550. u8 bPurgeable; /* True if pages are on backing store */
  43551. u8 eCreate; /* eCreate value for for xFetch() */
  43552. int (*xStress)(void*,PgHdr*); /* Call to try make a page clean */
  43553. void *pStress; /* Argument to xStress */
  43554. sqlite3_pcache *pCache; /* Pluggable cache module */
  43555. };
  43556. /********************************** Test and Debug Logic **********************/
  43557. /*
  43558. ** Debug tracing macros. Enable by by changing the "0" to "1" and
  43559. ** recompiling.
  43560. **
  43561. ** When sqlite3PcacheTrace is 1, single line trace messages are issued.
  43562. ** When sqlite3PcacheTrace is 2, a dump of the pcache showing all cache entries
  43563. ** is displayed for many operations, resulting in a lot of output.
  43564. */
  43565. #if defined(SQLITE_DEBUG) && 0
  43566. int sqlite3PcacheTrace = 2; /* 0: off 1: simple 2: cache dumps */
  43567. int sqlite3PcacheMxDump = 9999; /* Max cache entries for pcacheDump() */
  43568. # define pcacheTrace(X) if(sqlite3PcacheTrace){sqlite3DebugPrintf X;}
  43569. void pcacheDump(PCache *pCache){
  43570. int N;
  43571. int i, j;
  43572. sqlite3_pcache_page *pLower;
  43573. PgHdr *pPg;
  43574. unsigned char *a;
  43575. if( sqlite3PcacheTrace<2 ) return;
  43576. if( pCache->pCache==0 ) return;
  43577. N = sqlite3PcachePagecount(pCache);
  43578. if( N>sqlite3PcacheMxDump ) N = sqlite3PcacheMxDump;
  43579. for(i=1; i<=N; i++){
  43580. pLower = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache, i, 0);
  43581. if( pLower==0 ) continue;
  43582. pPg = (PgHdr*)pLower->pExtra;
  43583. printf("%3d: nRef %2d flgs %02x data ", i, pPg->nRef, pPg->flags);
  43584. a = (unsigned char *)pLower->pBuf;
  43585. for(j=0; j<12; j++) printf("%02x", a[j]);
  43586. printf("\n");
  43587. if( pPg->pPage==0 ){
  43588. sqlite3GlobalConfig.pcache2.xUnpin(pCache->pCache, pLower, 0);
  43589. }
  43590. }
  43591. }
  43592. #else
  43593. # define pcacheTrace(X)
  43594. # define pcacheDump(X)
  43595. #endif
  43596. /*
  43597. ** Check invariants on a PgHdr entry. Return true if everything is OK.
  43598. ** Return false if any invariant is violated.
  43599. **
  43600. ** This routine is for use inside of assert() statements only. For
  43601. ** example:
  43602. **
  43603. ** assert( sqlite3PcachePageSanity(pPg) );
  43604. */
  43605. #ifdef SQLITE_DEBUG
  43606. SQLITE_PRIVATE int sqlite3PcachePageSanity(PgHdr *pPg){
  43607. PCache *pCache;
  43608. assert( pPg!=0 );
  43609. assert( pPg->pgno>0 || pPg->pPager==0 ); /* Page number is 1 or more */
  43610. pCache = pPg->pCache;
  43611. assert( pCache!=0 ); /* Every page has an associated PCache */
  43612. if( pPg->flags & PGHDR_CLEAN ){
  43613. assert( (pPg->flags & PGHDR_DIRTY)==0 );/* Cannot be both CLEAN and DIRTY */
  43614. assert( pCache->pDirty!=pPg ); /* CLEAN pages not on dirty list */
  43615. assert( pCache->pDirtyTail!=pPg );
  43616. }
  43617. /* WRITEABLE pages must also be DIRTY */
  43618. if( pPg->flags & PGHDR_WRITEABLE ){
  43619. assert( pPg->flags & PGHDR_DIRTY ); /* WRITEABLE implies DIRTY */
  43620. }
  43621. /* NEED_SYNC can be set independently of WRITEABLE. This can happen,
  43622. ** for example, when using the sqlite3PagerDontWrite() optimization:
  43623. ** (1) Page X is journalled, and gets WRITEABLE and NEED_SEEK.
  43624. ** (2) Page X moved to freelist, WRITEABLE is cleared
  43625. ** (3) Page X reused, WRITEABLE is set again
  43626. ** If NEED_SYNC had been cleared in step 2, then it would not be reset
  43627. ** in step 3, and page might be written into the database without first
  43628. ** syncing the rollback journal, which might cause corruption on a power
  43629. ** loss.
  43630. **
  43631. ** Another example is when the database page size is smaller than the
  43632. ** disk sector size. When any page of a sector is journalled, all pages
  43633. ** in that sector are marked NEED_SYNC even if they are still CLEAN, just
  43634. ** in case they are later modified, since all pages in the same sector
  43635. ** must be journalled and synced before any of those pages can be safely
  43636. ** written.
  43637. */
  43638. return 1;
  43639. }
  43640. #endif /* SQLITE_DEBUG */
  43641. /********************************** Linked List Management ********************/
  43642. /* Allowed values for second argument to pcacheManageDirtyList() */
  43643. #define PCACHE_DIRTYLIST_REMOVE 1 /* Remove pPage from dirty list */
  43644. #define PCACHE_DIRTYLIST_ADD 2 /* Add pPage to the dirty list */
  43645. #define PCACHE_DIRTYLIST_FRONT 3 /* Move pPage to the front of the list */
  43646. /*
  43647. ** Manage pPage's participation on the dirty list. Bits of the addRemove
  43648. ** argument determines what operation to do. The 0x01 bit means first
  43649. ** remove pPage from the dirty list. The 0x02 means add pPage back to
  43650. ** the dirty list. Doing both moves pPage to the front of the dirty list.
  43651. */
  43652. static void pcacheManageDirtyList(PgHdr *pPage, u8 addRemove){
  43653. PCache *p = pPage->pCache;
  43654. pcacheTrace(("%p.DIRTYLIST.%s %d\n", p,
  43655. addRemove==1 ? "REMOVE" : addRemove==2 ? "ADD" : "FRONT",
  43656. pPage->pgno));
  43657. if( addRemove & PCACHE_DIRTYLIST_REMOVE ){
  43658. assert( pPage->pDirtyNext || pPage==p->pDirtyTail );
  43659. assert( pPage->pDirtyPrev || pPage==p->pDirty );
  43660. /* Update the PCache1.pSynced variable if necessary. */
  43661. if( p->pSynced==pPage ){
  43662. p->pSynced = pPage->pDirtyPrev;
  43663. }
  43664. if( pPage->pDirtyNext ){
  43665. pPage->pDirtyNext->pDirtyPrev = pPage->pDirtyPrev;
  43666. }else{
  43667. assert( pPage==p->pDirtyTail );
  43668. p->pDirtyTail = pPage->pDirtyPrev;
  43669. }
  43670. if( pPage->pDirtyPrev ){
  43671. pPage->pDirtyPrev->pDirtyNext = pPage->pDirtyNext;
  43672. }else{
  43673. /* If there are now no dirty pages in the cache, set eCreate to 2.
  43674. ** This is an optimization that allows sqlite3PcacheFetch() to skip
  43675. ** searching for a dirty page to eject from the cache when it might
  43676. ** otherwise have to. */
  43677. assert( pPage==p->pDirty );
  43678. p->pDirty = pPage->pDirtyNext;
  43679. assert( p->bPurgeable || p->eCreate==2 );
  43680. if( p->pDirty==0 ){ /*OPTIMIZATION-IF-TRUE*/
  43681. assert( p->bPurgeable==0 || p->eCreate==1 );
  43682. p->eCreate = 2;
  43683. }
  43684. }
  43685. }
  43686. if( addRemove & PCACHE_DIRTYLIST_ADD ){
  43687. pPage->pDirtyPrev = 0;
  43688. pPage->pDirtyNext = p->pDirty;
  43689. if( pPage->pDirtyNext ){
  43690. assert( pPage->pDirtyNext->pDirtyPrev==0 );
  43691. pPage->pDirtyNext->pDirtyPrev = pPage;
  43692. }else{
  43693. p->pDirtyTail = pPage;
  43694. if( p->bPurgeable ){
  43695. assert( p->eCreate==2 );
  43696. p->eCreate = 1;
  43697. }
  43698. }
  43699. p->pDirty = pPage;
  43700. /* If pSynced is NULL and this page has a clear NEED_SYNC flag, set
  43701. ** pSynced to point to it. Checking the NEED_SYNC flag is an
  43702. ** optimization, as if pSynced points to a page with the NEED_SYNC
  43703. ** flag set sqlite3PcacheFetchStress() searches through all newer
  43704. ** entries of the dirty-list for a page with NEED_SYNC clear anyway. */
  43705. if( !p->pSynced
  43706. && 0==(pPage->flags&PGHDR_NEED_SYNC) /*OPTIMIZATION-IF-FALSE*/
  43707. ){
  43708. p->pSynced = pPage;
  43709. }
  43710. }
  43711. pcacheDump(p);
  43712. }
  43713. /*
  43714. ** Wrapper around the pluggable caches xUnpin method. If the cache is
  43715. ** being used for an in-memory database, this function is a no-op.
  43716. */
  43717. static void pcacheUnpin(PgHdr *p){
  43718. if( p->pCache->bPurgeable ){
  43719. pcacheTrace(("%p.UNPIN %d\n", p->pCache, p->pgno));
  43720. sqlite3GlobalConfig.pcache2.xUnpin(p->pCache->pCache, p->pPage, 0);
  43721. pcacheDump(p->pCache);
  43722. }
  43723. }
  43724. /*
  43725. ** Compute the number of pages of cache requested. p->szCache is the
  43726. ** cache size requested by the "PRAGMA cache_size" statement.
  43727. */
  43728. static int numberOfCachePages(PCache *p){
  43729. if( p->szCache>=0 ){
  43730. /* IMPLEMENTATION-OF: R-42059-47211 If the argument N is positive then the
  43731. ** suggested cache size is set to N. */
  43732. return p->szCache;
  43733. }else{
  43734. /* IMPLEMENTATION-OF: R-61436-13639 If the argument N is negative, then
  43735. ** the number of cache pages is adjusted to use approximately abs(N*1024)
  43736. ** bytes of memory. */
  43737. return (int)((-1024*(i64)p->szCache)/(p->szPage+p->szExtra));
  43738. }
  43739. }
  43740. /*************************************************** General Interfaces ******
  43741. **
  43742. ** Initialize and shutdown the page cache subsystem. Neither of these
  43743. ** functions are threadsafe.
  43744. */
  43745. SQLITE_PRIVATE int sqlite3PcacheInitialize(void){
  43746. if( sqlite3GlobalConfig.pcache2.xInit==0 ){
  43747. /* IMPLEMENTATION-OF: R-26801-64137 If the xInit() method is NULL, then the
  43748. ** built-in default page cache is used instead of the application defined
  43749. ** page cache. */
  43750. sqlite3PCacheSetDefault();
  43751. }
  43752. return sqlite3GlobalConfig.pcache2.xInit(sqlite3GlobalConfig.pcache2.pArg);
  43753. }
  43754. SQLITE_PRIVATE void sqlite3PcacheShutdown(void){
  43755. if( sqlite3GlobalConfig.pcache2.xShutdown ){
  43756. /* IMPLEMENTATION-OF: R-26000-56589 The xShutdown() method may be NULL. */
  43757. sqlite3GlobalConfig.pcache2.xShutdown(sqlite3GlobalConfig.pcache2.pArg);
  43758. }
  43759. }
  43760. /*
  43761. ** Return the size in bytes of a PCache object.
  43762. */
  43763. SQLITE_PRIVATE int sqlite3PcacheSize(void){ return sizeof(PCache); }
  43764. /*
  43765. ** Create a new PCache object. Storage space to hold the object
  43766. ** has already been allocated and is passed in as the p pointer.
  43767. ** The caller discovers how much space needs to be allocated by
  43768. ** calling sqlite3PcacheSize().
  43769. **
  43770. ** szExtra is some extra space allocated for each page. The first
  43771. ** 8 bytes of the extra space will be zeroed as the page is allocated,
  43772. ** but remaining content will be uninitialized. Though it is opaque
  43773. ** to this module, the extra space really ends up being the MemPage
  43774. ** structure in the pager.
  43775. */
  43776. SQLITE_PRIVATE int sqlite3PcacheOpen(
  43777. int szPage, /* Size of every page */
  43778. int szExtra, /* Extra space associated with each page */
  43779. int bPurgeable, /* True if pages are on backing store */
  43780. int (*xStress)(void*,PgHdr*),/* Call to try to make pages clean */
  43781. void *pStress, /* Argument to xStress */
  43782. PCache *p /* Preallocated space for the PCache */
  43783. ){
  43784. memset(p, 0, sizeof(PCache));
  43785. p->szPage = 1;
  43786. p->szExtra = szExtra;
  43787. assert( szExtra>=8 ); /* First 8 bytes will be zeroed */
  43788. p->bPurgeable = bPurgeable;
  43789. p->eCreate = 2;
  43790. p->xStress = xStress;
  43791. p->pStress = pStress;
  43792. p->szCache = 100;
  43793. p->szSpill = 1;
  43794. pcacheTrace(("%p.OPEN szPage %d bPurgeable %d\n",p,szPage,bPurgeable));
  43795. return sqlite3PcacheSetPageSize(p, szPage);
  43796. }
  43797. /*
  43798. ** Change the page size for PCache object. The caller must ensure that there
  43799. ** are no outstanding page references when this function is called.
  43800. */
  43801. SQLITE_PRIVATE int sqlite3PcacheSetPageSize(PCache *pCache, int szPage){
  43802. assert( pCache->nRefSum==0 && pCache->pDirty==0 );
  43803. if( pCache->szPage ){
  43804. sqlite3_pcache *pNew;
  43805. pNew = sqlite3GlobalConfig.pcache2.xCreate(
  43806. szPage, pCache->szExtra + ROUND8(sizeof(PgHdr)),
  43807. pCache->bPurgeable
  43808. );
  43809. if( pNew==0 ) return SQLITE_NOMEM_BKPT;
  43810. sqlite3GlobalConfig.pcache2.xCachesize(pNew, numberOfCachePages(pCache));
  43811. if( pCache->pCache ){
  43812. sqlite3GlobalConfig.pcache2.xDestroy(pCache->pCache);
  43813. }
  43814. pCache->pCache = pNew;
  43815. pCache->szPage = szPage;
  43816. pcacheTrace(("%p.PAGESIZE %d\n",pCache,szPage));
  43817. }
  43818. return SQLITE_OK;
  43819. }
  43820. /*
  43821. ** Try to obtain a page from the cache.
  43822. **
  43823. ** This routine returns a pointer to an sqlite3_pcache_page object if
  43824. ** such an object is already in cache, or if a new one is created.
  43825. ** This routine returns a NULL pointer if the object was not in cache
  43826. ** and could not be created.
  43827. **
  43828. ** The createFlags should be 0 to check for existing pages and should
  43829. ** be 3 (not 1, but 3) to try to create a new page.
  43830. **
  43831. ** If the createFlag is 0, then NULL is always returned if the page
  43832. ** is not already in the cache. If createFlag is 1, then a new page
  43833. ** is created only if that can be done without spilling dirty pages
  43834. ** and without exceeding the cache size limit.
  43835. **
  43836. ** The caller needs to invoke sqlite3PcacheFetchFinish() to properly
  43837. ** initialize the sqlite3_pcache_page object and convert it into a
  43838. ** PgHdr object. The sqlite3PcacheFetch() and sqlite3PcacheFetchFinish()
  43839. ** routines are split this way for performance reasons. When separated
  43840. ** they can both (usually) operate without having to push values to
  43841. ** the stack on entry and pop them back off on exit, which saves a
  43842. ** lot of pushing and popping.
  43843. */
  43844. SQLITE_PRIVATE sqlite3_pcache_page *sqlite3PcacheFetch(
  43845. PCache *pCache, /* Obtain the page from this cache */
  43846. Pgno pgno, /* Page number to obtain */
  43847. int createFlag /* If true, create page if it does not exist already */
  43848. ){
  43849. int eCreate;
  43850. sqlite3_pcache_page *pRes;
  43851. assert( pCache!=0 );
  43852. assert( pCache->pCache!=0 );
  43853. assert( createFlag==3 || createFlag==0 );
  43854. assert( pCache->eCreate==((pCache->bPurgeable && pCache->pDirty) ? 1 : 2) );
  43855. /* eCreate defines what to do if the page does not exist.
  43856. ** 0 Do not allocate a new page. (createFlag==0)
  43857. ** 1 Allocate a new page if doing so is inexpensive.
  43858. ** (createFlag==1 AND bPurgeable AND pDirty)
  43859. ** 2 Allocate a new page even it doing so is difficult.
  43860. ** (createFlag==1 AND !(bPurgeable AND pDirty)
  43861. */
  43862. eCreate = createFlag & pCache->eCreate;
  43863. assert( eCreate==0 || eCreate==1 || eCreate==2 );
  43864. assert( createFlag==0 || pCache->eCreate==eCreate );
  43865. assert( createFlag==0 || eCreate==1+(!pCache->bPurgeable||!pCache->pDirty) );
  43866. pRes = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache, pgno, eCreate);
  43867. pcacheTrace(("%p.FETCH %d%s (result: %p)\n",pCache,pgno,
  43868. createFlag?" create":"",pRes));
  43869. return pRes;
  43870. }
  43871. /*
  43872. ** If the sqlite3PcacheFetch() routine is unable to allocate a new
  43873. ** page because no clean pages are available for reuse and the cache
  43874. ** size limit has been reached, then this routine can be invoked to
  43875. ** try harder to allocate a page. This routine might invoke the stress
  43876. ** callback to spill dirty pages to the journal. It will then try to
  43877. ** allocate the new page and will only fail to allocate a new page on
  43878. ** an OOM error.
  43879. **
  43880. ** This routine should be invoked only after sqlite3PcacheFetch() fails.
  43881. */
  43882. SQLITE_PRIVATE int sqlite3PcacheFetchStress(
  43883. PCache *pCache, /* Obtain the page from this cache */
  43884. Pgno pgno, /* Page number to obtain */
  43885. sqlite3_pcache_page **ppPage /* Write result here */
  43886. ){
  43887. PgHdr *pPg;
  43888. if( pCache->eCreate==2 ) return 0;
  43889. if( sqlite3PcachePagecount(pCache)>pCache->szSpill ){
  43890. /* Find a dirty page to write-out and recycle. First try to find a
  43891. ** page that does not require a journal-sync (one with PGHDR_NEED_SYNC
  43892. ** cleared), but if that is not possible settle for any other
  43893. ** unreferenced dirty page.
  43894. **
  43895. ** If the LRU page in the dirty list that has a clear PGHDR_NEED_SYNC
  43896. ** flag is currently referenced, then the following may leave pSynced
  43897. ** set incorrectly (pointing to other than the LRU page with NEED_SYNC
  43898. ** cleared). This is Ok, as pSynced is just an optimization. */
  43899. for(pPg=pCache->pSynced;
  43900. pPg && (pPg->nRef || (pPg->flags&PGHDR_NEED_SYNC));
  43901. pPg=pPg->pDirtyPrev
  43902. );
  43903. pCache->pSynced = pPg;
  43904. if( !pPg ){
  43905. for(pPg=pCache->pDirtyTail; pPg && pPg->nRef; pPg=pPg->pDirtyPrev);
  43906. }
  43907. if( pPg ){
  43908. int rc;
  43909. #ifdef SQLITE_LOG_CACHE_SPILL
  43910. sqlite3_log(SQLITE_FULL,
  43911. "spill page %d making room for %d - cache used: %d/%d",
  43912. pPg->pgno, pgno,
  43913. sqlite3GlobalConfig.pcache2.xPagecount(pCache->pCache),
  43914. numberOfCachePages(pCache));
  43915. #endif
  43916. pcacheTrace(("%p.SPILL %d\n",pCache,pPg->pgno));
  43917. rc = pCache->xStress(pCache->pStress, pPg);
  43918. pcacheDump(pCache);
  43919. if( rc!=SQLITE_OK && rc!=SQLITE_BUSY ){
  43920. return rc;
  43921. }
  43922. }
  43923. }
  43924. *ppPage = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache, pgno, 2);
  43925. return *ppPage==0 ? SQLITE_NOMEM_BKPT : SQLITE_OK;
  43926. }
  43927. /*
  43928. ** This is a helper routine for sqlite3PcacheFetchFinish()
  43929. **
  43930. ** In the uncommon case where the page being fetched has not been
  43931. ** initialized, this routine is invoked to do the initialization.
  43932. ** This routine is broken out into a separate function since it
  43933. ** requires extra stack manipulation that can be avoided in the common
  43934. ** case.
  43935. */
  43936. static SQLITE_NOINLINE PgHdr *pcacheFetchFinishWithInit(
  43937. PCache *pCache, /* Obtain the page from this cache */
  43938. Pgno pgno, /* Page number obtained */
  43939. sqlite3_pcache_page *pPage /* Page obtained by prior PcacheFetch() call */
  43940. ){
  43941. PgHdr *pPgHdr;
  43942. assert( pPage!=0 );
  43943. pPgHdr = (PgHdr*)pPage->pExtra;
  43944. assert( pPgHdr->pPage==0 );
  43945. memset(&pPgHdr->pDirty, 0, sizeof(PgHdr) - offsetof(PgHdr,pDirty));
  43946. pPgHdr->pPage = pPage;
  43947. pPgHdr->pData = pPage->pBuf;
  43948. pPgHdr->pExtra = (void *)&pPgHdr[1];
  43949. memset(pPgHdr->pExtra, 0, 8);
  43950. pPgHdr->pCache = pCache;
  43951. pPgHdr->pgno = pgno;
  43952. pPgHdr->flags = PGHDR_CLEAN;
  43953. return sqlite3PcacheFetchFinish(pCache,pgno,pPage);
  43954. }
  43955. /*
  43956. ** This routine converts the sqlite3_pcache_page object returned by
  43957. ** sqlite3PcacheFetch() into an initialized PgHdr object. This routine
  43958. ** must be called after sqlite3PcacheFetch() in order to get a usable
  43959. ** result.
  43960. */
  43961. SQLITE_PRIVATE PgHdr *sqlite3PcacheFetchFinish(
  43962. PCache *pCache, /* Obtain the page from this cache */
  43963. Pgno pgno, /* Page number obtained */
  43964. sqlite3_pcache_page *pPage /* Page obtained by prior PcacheFetch() call */
  43965. ){
  43966. PgHdr *pPgHdr;
  43967. assert( pPage!=0 );
  43968. pPgHdr = (PgHdr *)pPage->pExtra;
  43969. if( !pPgHdr->pPage ){
  43970. return pcacheFetchFinishWithInit(pCache, pgno, pPage);
  43971. }
  43972. pCache->nRefSum++;
  43973. pPgHdr->nRef++;
  43974. assert( sqlite3PcachePageSanity(pPgHdr) );
  43975. return pPgHdr;
  43976. }
  43977. /*
  43978. ** Decrement the reference count on a page. If the page is clean and the
  43979. ** reference count drops to 0, then it is made eligible for recycling.
  43980. */
  43981. SQLITE_PRIVATE void SQLITE_NOINLINE sqlite3PcacheRelease(PgHdr *p){
  43982. assert( p->nRef>0 );
  43983. p->pCache->nRefSum--;
  43984. if( (--p->nRef)==0 ){
  43985. if( p->flags&PGHDR_CLEAN ){
  43986. pcacheUnpin(p);
  43987. }else{
  43988. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_FRONT);
  43989. }
  43990. }
  43991. }
  43992. /*
  43993. ** Increase the reference count of a supplied page by 1.
  43994. */
  43995. SQLITE_PRIVATE void sqlite3PcacheRef(PgHdr *p){
  43996. assert(p->nRef>0);
  43997. assert( sqlite3PcachePageSanity(p) );
  43998. p->nRef++;
  43999. p->pCache->nRefSum++;
  44000. }
  44001. /*
  44002. ** Drop a page from the cache. There must be exactly one reference to the
  44003. ** page. This function deletes that reference, so after it returns the
  44004. ** page pointed to by p is invalid.
  44005. */
  44006. SQLITE_PRIVATE void sqlite3PcacheDrop(PgHdr *p){
  44007. assert( p->nRef==1 );
  44008. assert( sqlite3PcachePageSanity(p) );
  44009. if( p->flags&PGHDR_DIRTY ){
  44010. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_REMOVE);
  44011. }
  44012. p->pCache->nRefSum--;
  44013. sqlite3GlobalConfig.pcache2.xUnpin(p->pCache->pCache, p->pPage, 1);
  44014. }
  44015. /*
  44016. ** Make sure the page is marked as dirty. If it isn't dirty already,
  44017. ** make it so.
  44018. */
  44019. SQLITE_PRIVATE void sqlite3PcacheMakeDirty(PgHdr *p){
  44020. assert( p->nRef>0 );
  44021. assert( sqlite3PcachePageSanity(p) );
  44022. if( p->flags & (PGHDR_CLEAN|PGHDR_DONT_WRITE) ){ /*OPTIMIZATION-IF-FALSE*/
  44023. p->flags &= ~PGHDR_DONT_WRITE;
  44024. if( p->flags & PGHDR_CLEAN ){
  44025. p->flags ^= (PGHDR_DIRTY|PGHDR_CLEAN);
  44026. pcacheTrace(("%p.DIRTY %d\n",p->pCache,p->pgno));
  44027. assert( (p->flags & (PGHDR_DIRTY|PGHDR_CLEAN))==PGHDR_DIRTY );
  44028. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_ADD);
  44029. }
  44030. assert( sqlite3PcachePageSanity(p) );
  44031. }
  44032. }
  44033. /*
  44034. ** Make sure the page is marked as clean. If it isn't clean already,
  44035. ** make it so.
  44036. */
  44037. SQLITE_PRIVATE void sqlite3PcacheMakeClean(PgHdr *p){
  44038. assert( sqlite3PcachePageSanity(p) );
  44039. assert( (p->flags & PGHDR_DIRTY)!=0 );
  44040. assert( (p->flags & PGHDR_CLEAN)==0 );
  44041. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_REMOVE);
  44042. p->flags &= ~(PGHDR_DIRTY|PGHDR_NEED_SYNC|PGHDR_WRITEABLE);
  44043. p->flags |= PGHDR_CLEAN;
  44044. pcacheTrace(("%p.CLEAN %d\n",p->pCache,p->pgno));
  44045. assert( sqlite3PcachePageSanity(p) );
  44046. if( p->nRef==0 ){
  44047. pcacheUnpin(p);
  44048. }
  44049. }
  44050. /*
  44051. ** Make every page in the cache clean.
  44052. */
  44053. SQLITE_PRIVATE void sqlite3PcacheCleanAll(PCache *pCache){
  44054. PgHdr *p;
  44055. pcacheTrace(("%p.CLEAN-ALL\n",pCache));
  44056. while( (p = pCache->pDirty)!=0 ){
  44057. sqlite3PcacheMakeClean(p);
  44058. }
  44059. }
  44060. /*
  44061. ** Clear the PGHDR_NEED_SYNC and PGHDR_WRITEABLE flag from all dirty pages.
  44062. */
  44063. SQLITE_PRIVATE void sqlite3PcacheClearWritable(PCache *pCache){
  44064. PgHdr *p;
  44065. pcacheTrace(("%p.CLEAR-WRITEABLE\n",pCache));
  44066. for(p=pCache->pDirty; p; p=p->pDirtyNext){
  44067. p->flags &= ~(PGHDR_NEED_SYNC|PGHDR_WRITEABLE);
  44068. }
  44069. pCache->pSynced = pCache->pDirtyTail;
  44070. }
  44071. /*
  44072. ** Clear the PGHDR_NEED_SYNC flag from all dirty pages.
  44073. */
  44074. SQLITE_PRIVATE void sqlite3PcacheClearSyncFlags(PCache *pCache){
  44075. PgHdr *p;
  44076. for(p=pCache->pDirty; p; p=p->pDirtyNext){
  44077. p->flags &= ~PGHDR_NEED_SYNC;
  44078. }
  44079. pCache->pSynced = pCache->pDirtyTail;
  44080. }
  44081. /*
  44082. ** Change the page number of page p to newPgno.
  44083. */
  44084. SQLITE_PRIVATE void sqlite3PcacheMove(PgHdr *p, Pgno newPgno){
  44085. PCache *pCache = p->pCache;
  44086. assert( p->nRef>0 );
  44087. assert( newPgno>0 );
  44088. assert( sqlite3PcachePageSanity(p) );
  44089. pcacheTrace(("%p.MOVE %d -> %d\n",pCache,p->pgno,newPgno));
  44090. sqlite3GlobalConfig.pcache2.xRekey(pCache->pCache, p->pPage, p->pgno,newPgno);
  44091. p->pgno = newPgno;
  44092. if( (p->flags&PGHDR_DIRTY) && (p->flags&PGHDR_NEED_SYNC) ){
  44093. pcacheManageDirtyList(p, PCACHE_DIRTYLIST_FRONT);
  44094. }
  44095. }
  44096. /*
  44097. ** Drop every cache entry whose page number is greater than "pgno". The
  44098. ** caller must ensure that there are no outstanding references to any pages
  44099. ** other than page 1 with a page number greater than pgno.
  44100. **
  44101. ** If there is a reference to page 1 and the pgno parameter passed to this
  44102. ** function is 0, then the data area associated with page 1 is zeroed, but
  44103. ** the page object is not dropped.
  44104. */
  44105. SQLITE_PRIVATE void sqlite3PcacheTruncate(PCache *pCache, Pgno pgno){
  44106. if( pCache->pCache ){
  44107. PgHdr *p;
  44108. PgHdr *pNext;
  44109. pcacheTrace(("%p.TRUNCATE %d\n",pCache,pgno));
  44110. for(p=pCache->pDirty; p; p=pNext){
  44111. pNext = p->pDirtyNext;
  44112. /* This routine never gets call with a positive pgno except right
  44113. ** after sqlite3PcacheCleanAll(). So if there are dirty pages,
  44114. ** it must be that pgno==0.
  44115. */
  44116. assert( p->pgno>0 );
  44117. if( p->pgno>pgno ){
  44118. assert( p->flags&PGHDR_DIRTY );
  44119. sqlite3PcacheMakeClean(p);
  44120. }
  44121. }
  44122. if( pgno==0 && pCache->nRefSum ){
  44123. sqlite3_pcache_page *pPage1;
  44124. pPage1 = sqlite3GlobalConfig.pcache2.xFetch(pCache->pCache,1,0);
  44125. if( ALWAYS(pPage1) ){ /* Page 1 is always available in cache, because
  44126. ** pCache->nRefSum>0 */
  44127. memset(pPage1->pBuf, 0, pCache->szPage);
  44128. pgno = 1;
  44129. }
  44130. }
  44131. sqlite3GlobalConfig.pcache2.xTruncate(pCache->pCache, pgno+1);
  44132. }
  44133. }
  44134. /*
  44135. ** Close a cache.
  44136. */
  44137. SQLITE_PRIVATE void sqlite3PcacheClose(PCache *pCache){
  44138. assert( pCache->pCache!=0 );
  44139. pcacheTrace(("%p.CLOSE\n",pCache));
  44140. sqlite3GlobalConfig.pcache2.xDestroy(pCache->pCache);
  44141. }
  44142. /*
  44143. ** Discard the contents of the cache.
  44144. */
  44145. SQLITE_PRIVATE void sqlite3PcacheClear(PCache *pCache){
  44146. sqlite3PcacheTruncate(pCache, 0);
  44147. }
  44148. /*
  44149. ** Merge two lists of pages connected by pDirty and in pgno order.
  44150. ** Do not bother fixing the pDirtyPrev pointers.
  44151. */
  44152. static PgHdr *pcacheMergeDirtyList(PgHdr *pA, PgHdr *pB){
  44153. PgHdr result, *pTail;
  44154. pTail = &result;
  44155. assert( pA!=0 && pB!=0 );
  44156. for(;;){
  44157. if( pA->pgno<pB->pgno ){
  44158. pTail->pDirty = pA;
  44159. pTail = pA;
  44160. pA = pA->pDirty;
  44161. if( pA==0 ){
  44162. pTail->pDirty = pB;
  44163. break;
  44164. }
  44165. }else{
  44166. pTail->pDirty = pB;
  44167. pTail = pB;
  44168. pB = pB->pDirty;
  44169. if( pB==0 ){
  44170. pTail->pDirty = pA;
  44171. break;
  44172. }
  44173. }
  44174. }
  44175. return result.pDirty;
  44176. }
  44177. /*
  44178. ** Sort the list of pages in accending order by pgno. Pages are
  44179. ** connected by pDirty pointers. The pDirtyPrev pointers are
  44180. ** corrupted by this sort.
  44181. **
  44182. ** Since there cannot be more than 2^31 distinct pages in a database,
  44183. ** there cannot be more than 31 buckets required by the merge sorter.
  44184. ** One extra bucket is added to catch overflow in case something
  44185. ** ever changes to make the previous sentence incorrect.
  44186. */
  44187. #define N_SORT_BUCKET 32
  44188. static PgHdr *pcacheSortDirtyList(PgHdr *pIn){
  44189. PgHdr *a[N_SORT_BUCKET], *p;
  44190. int i;
  44191. memset(a, 0, sizeof(a));
  44192. while( pIn ){
  44193. p = pIn;
  44194. pIn = p->pDirty;
  44195. p->pDirty = 0;
  44196. for(i=0; ALWAYS(i<N_SORT_BUCKET-1); i++){
  44197. if( a[i]==0 ){
  44198. a[i] = p;
  44199. break;
  44200. }else{
  44201. p = pcacheMergeDirtyList(a[i], p);
  44202. a[i] = 0;
  44203. }
  44204. }
  44205. if( NEVER(i==N_SORT_BUCKET-1) ){
  44206. /* To get here, there need to be 2^(N_SORT_BUCKET) elements in
  44207. ** the input list. But that is impossible.
  44208. */
  44209. a[i] = pcacheMergeDirtyList(a[i], p);
  44210. }
  44211. }
  44212. p = a[0];
  44213. for(i=1; i<N_SORT_BUCKET; i++){
  44214. if( a[i]==0 ) continue;
  44215. p = p ? pcacheMergeDirtyList(p, a[i]) : a[i];
  44216. }
  44217. return p;
  44218. }
  44219. /*
  44220. ** Return a list of all dirty pages in the cache, sorted by page number.
  44221. */
  44222. SQLITE_PRIVATE PgHdr *sqlite3PcacheDirtyList(PCache *pCache){
  44223. PgHdr *p;
  44224. for(p=pCache->pDirty; p; p=p->pDirtyNext){
  44225. p->pDirty = p->pDirtyNext;
  44226. }
  44227. return pcacheSortDirtyList(pCache->pDirty);
  44228. }
  44229. /*
  44230. ** Return the total number of references to all pages held by the cache.
  44231. **
  44232. ** This is not the total number of pages referenced, but the sum of the
  44233. ** reference count for all pages.
  44234. */
  44235. SQLITE_PRIVATE int sqlite3PcacheRefCount(PCache *pCache){
  44236. return pCache->nRefSum;
  44237. }
  44238. /*
  44239. ** Return the number of references to the page supplied as an argument.
  44240. */
  44241. SQLITE_PRIVATE int sqlite3PcachePageRefcount(PgHdr *p){
  44242. return p->nRef;
  44243. }
  44244. /*
  44245. ** Return the total number of pages in the cache.
  44246. */
  44247. SQLITE_PRIVATE int sqlite3PcachePagecount(PCache *pCache){
  44248. assert( pCache->pCache!=0 );
  44249. return sqlite3GlobalConfig.pcache2.xPagecount(pCache->pCache);
  44250. }
  44251. #ifdef SQLITE_TEST
  44252. /*
  44253. ** Get the suggested cache-size value.
  44254. */
  44255. SQLITE_PRIVATE int sqlite3PcacheGetCachesize(PCache *pCache){
  44256. return numberOfCachePages(pCache);
  44257. }
  44258. #endif
  44259. /*
  44260. ** Set the suggested cache-size value.
  44261. */
  44262. SQLITE_PRIVATE void sqlite3PcacheSetCachesize(PCache *pCache, int mxPage){
  44263. assert( pCache->pCache!=0 );
  44264. pCache->szCache = mxPage;
  44265. sqlite3GlobalConfig.pcache2.xCachesize(pCache->pCache,
  44266. numberOfCachePages(pCache));
  44267. }
  44268. /*
  44269. ** Set the suggested cache-spill value. Make no changes if if the
  44270. ** argument is zero. Return the effective cache-spill size, which will
  44271. ** be the larger of the szSpill and szCache.
  44272. */
  44273. SQLITE_PRIVATE int sqlite3PcacheSetSpillsize(PCache *p, int mxPage){
  44274. int res;
  44275. assert( p->pCache!=0 );
  44276. if( mxPage ){
  44277. if( mxPage<0 ){
  44278. mxPage = (int)((-1024*(i64)mxPage)/(p->szPage+p->szExtra));
  44279. }
  44280. p->szSpill = mxPage;
  44281. }
  44282. res = numberOfCachePages(p);
  44283. if( res<p->szSpill ) res = p->szSpill;
  44284. return res;
  44285. }
  44286. /*
  44287. ** Free up as much memory as possible from the page cache.
  44288. */
  44289. SQLITE_PRIVATE void sqlite3PcacheShrink(PCache *pCache){
  44290. assert( pCache->pCache!=0 );
  44291. sqlite3GlobalConfig.pcache2.xShrink(pCache->pCache);
  44292. }
  44293. /*
  44294. ** Return the size of the header added by this middleware layer
  44295. ** in the page-cache hierarchy.
  44296. */
  44297. SQLITE_PRIVATE int sqlite3HeaderSizePcache(void){ return ROUND8(sizeof(PgHdr)); }
  44298. /*
  44299. ** Return the number of dirty pages currently in the cache, as a percentage
  44300. ** of the configured cache size.
  44301. */
  44302. SQLITE_PRIVATE int sqlite3PCachePercentDirty(PCache *pCache){
  44303. PgHdr *pDirty;
  44304. int nDirty = 0;
  44305. int nCache = numberOfCachePages(pCache);
  44306. for(pDirty=pCache->pDirty; pDirty; pDirty=pDirty->pDirtyNext) nDirty++;
  44307. return nCache ? (int)(((i64)nDirty * 100) / nCache) : 0;
  44308. }
  44309. #if defined(SQLITE_CHECK_PAGES) || defined(SQLITE_DEBUG)
  44310. /*
  44311. ** For all dirty pages currently in the cache, invoke the specified
  44312. ** callback. This is only used if the SQLITE_CHECK_PAGES macro is
  44313. ** defined.
  44314. */
  44315. SQLITE_PRIVATE void sqlite3PcacheIterateDirty(PCache *pCache, void (*xIter)(PgHdr *)){
  44316. PgHdr *pDirty;
  44317. for(pDirty=pCache->pDirty; pDirty; pDirty=pDirty->pDirtyNext){
  44318. xIter(pDirty);
  44319. }
  44320. }
  44321. #endif
  44322. /************** End of pcache.c **********************************************/
  44323. /************** Begin file pcache1.c *****************************************/
  44324. /*
  44325. ** 2008 November 05
  44326. **
  44327. ** The author disclaims copyright to this source code. In place of
  44328. ** a legal notice, here is a blessing:
  44329. **
  44330. ** May you do good and not evil.
  44331. ** May you find forgiveness for yourself and forgive others.
  44332. ** May you share freely, never taking more than you give.
  44333. **
  44334. *************************************************************************
  44335. **
  44336. ** This file implements the default page cache implementation (the
  44337. ** sqlite3_pcache interface). It also contains part of the implementation
  44338. ** of the SQLITE_CONFIG_PAGECACHE and sqlite3_release_memory() features.
  44339. ** If the default page cache implementation is overridden, then neither of
  44340. ** these two features are available.
  44341. **
  44342. ** A Page cache line looks like this:
  44343. **
  44344. ** -------------------------------------------------------------
  44345. ** | database page content | PgHdr1 | MemPage | PgHdr |
  44346. ** -------------------------------------------------------------
  44347. **
  44348. ** The database page content is up front (so that buffer overreads tend to
  44349. ** flow harmlessly into the PgHdr1, MemPage, and PgHdr extensions). MemPage
  44350. ** is the extension added by the btree.c module containing information such
  44351. ** as the database page number and how that database page is used. PgHdr
  44352. ** is added by the pcache.c layer and contains information used to keep track
  44353. ** of which pages are "dirty". PgHdr1 is an extension added by this
  44354. ** module (pcache1.c). The PgHdr1 header is a subclass of sqlite3_pcache_page.
  44355. ** PgHdr1 contains information needed to look up a page by its page number.
  44356. ** The superclass sqlite3_pcache_page.pBuf points to the start of the
  44357. ** database page content and sqlite3_pcache_page.pExtra points to PgHdr.
  44358. **
  44359. ** The size of the extension (MemPage+PgHdr+PgHdr1) can be determined at
  44360. ** runtime using sqlite3_config(SQLITE_CONFIG_PCACHE_HDRSZ, &size). The
  44361. ** sizes of the extensions sum to 272 bytes on x64 for 3.8.10, but this
  44362. ** size can vary according to architecture, compile-time options, and
  44363. ** SQLite library version number.
  44364. **
  44365. ** If SQLITE_PCACHE_SEPARATE_HEADER is defined, then the extension is obtained
  44366. ** using a separate memory allocation from the database page content. This
  44367. ** seeks to overcome the "clownshoe" problem (also called "internal
  44368. ** fragmentation" in academic literature) of allocating a few bytes more
  44369. ** than a power of two with the memory allocator rounding up to the next
  44370. ** power of two, and leaving the rounded-up space unused.
  44371. **
  44372. ** This module tracks pointers to PgHdr1 objects. Only pcache.c communicates
  44373. ** with this module. Information is passed back and forth as PgHdr1 pointers.
  44374. **
  44375. ** The pcache.c and pager.c modules deal pointers to PgHdr objects.
  44376. ** The btree.c module deals with pointers to MemPage objects.
  44377. **
  44378. ** SOURCE OF PAGE CACHE MEMORY:
  44379. **
  44380. ** Memory for a page might come from any of three sources:
  44381. **
  44382. ** (1) The general-purpose memory allocator - sqlite3Malloc()
  44383. ** (2) Global page-cache memory provided using sqlite3_config() with
  44384. ** SQLITE_CONFIG_PAGECACHE.
  44385. ** (3) PCache-local bulk allocation.
  44386. **
  44387. ** The third case is a chunk of heap memory (defaulting to 100 pages worth)
  44388. ** that is allocated when the page cache is created. The size of the local
  44389. ** bulk allocation can be adjusted using
  44390. **
  44391. ** sqlite3_config(SQLITE_CONFIG_PAGECACHE, (void*)0, 0, N).
  44392. **
  44393. ** If N is positive, then N pages worth of memory are allocated using a single
  44394. ** sqlite3Malloc() call and that memory is used for the first N pages allocated.
  44395. ** Or if N is negative, then -1024*N bytes of memory are allocated and used
  44396. ** for as many pages as can be accomodated.
  44397. **
  44398. ** Only one of (2) or (3) can be used. Once the memory available to (2) or
  44399. ** (3) is exhausted, subsequent allocations fail over to the general-purpose
  44400. ** memory allocator (1).
  44401. **
  44402. ** Earlier versions of SQLite used only methods (1) and (2). But experiments
  44403. ** show that method (3) with N==100 provides about a 5% performance boost for
  44404. ** common workloads.
  44405. */
  44406. /* #include "sqliteInt.h" */
  44407. typedef struct PCache1 PCache1;
  44408. typedef struct PgHdr1 PgHdr1;
  44409. typedef struct PgFreeslot PgFreeslot;
  44410. typedef struct PGroup PGroup;
  44411. /*
  44412. ** Each cache entry is represented by an instance of the following
  44413. ** structure. Unless SQLITE_PCACHE_SEPARATE_HEADER is defined, a buffer of
  44414. ** PgHdr1.pCache->szPage bytes is allocated directly before this structure
  44415. ** in memory.
  44416. */
  44417. struct PgHdr1 {
  44418. sqlite3_pcache_page page; /* Base class. Must be first. pBuf & pExtra */
  44419. unsigned int iKey; /* Key value (page number) */
  44420. u8 isBulkLocal; /* This page from bulk local storage */
  44421. u8 isAnchor; /* This is the PGroup.lru element */
  44422. PgHdr1 *pNext; /* Next in hash table chain */
  44423. PCache1 *pCache; /* Cache that currently owns this page */
  44424. PgHdr1 *pLruNext; /* Next in LRU list of unpinned pages */
  44425. PgHdr1 *pLruPrev; /* Previous in LRU list of unpinned pages */
  44426. };
  44427. /*
  44428. ** A page is pinned if it is no on the LRU list
  44429. */
  44430. #define PAGE_IS_PINNED(p) ((p)->pLruNext==0)
  44431. #define PAGE_IS_UNPINNED(p) ((p)->pLruNext!=0)
  44432. /* Each page cache (or PCache) belongs to a PGroup. A PGroup is a set
  44433. ** of one or more PCaches that are able to recycle each other's unpinned
  44434. ** pages when they are under memory pressure. A PGroup is an instance of
  44435. ** the following object.
  44436. **
  44437. ** This page cache implementation works in one of two modes:
  44438. **
  44439. ** (1) Every PCache is the sole member of its own PGroup. There is
  44440. ** one PGroup per PCache.
  44441. **
  44442. ** (2) There is a single global PGroup that all PCaches are a member
  44443. ** of.
  44444. **
  44445. ** Mode 1 uses more memory (since PCache instances are not able to rob
  44446. ** unused pages from other PCaches) but it also operates without a mutex,
  44447. ** and is therefore often faster. Mode 2 requires a mutex in order to be
  44448. ** threadsafe, but recycles pages more efficiently.
  44449. **
  44450. ** For mode (1), PGroup.mutex is NULL. For mode (2) there is only a single
  44451. ** PGroup which is the pcache1.grp global variable and its mutex is
  44452. ** SQLITE_MUTEX_STATIC_LRU.
  44453. */
  44454. struct PGroup {
  44455. sqlite3_mutex *mutex; /* MUTEX_STATIC_LRU or NULL */
  44456. unsigned int nMaxPage; /* Sum of nMax for purgeable caches */
  44457. unsigned int nMinPage; /* Sum of nMin for purgeable caches */
  44458. unsigned int mxPinned; /* nMaxpage + 10 - nMinPage */
  44459. unsigned int nPurgeable; /* Number of purgeable pages allocated */
  44460. PgHdr1 lru; /* The beginning and end of the LRU list */
  44461. };
  44462. /* Each page cache is an instance of the following object. Every
  44463. ** open database file (including each in-memory database and each
  44464. ** temporary or transient database) has a single page cache which
  44465. ** is an instance of this object.
  44466. **
  44467. ** Pointers to structures of this type are cast and returned as
  44468. ** opaque sqlite3_pcache* handles.
  44469. */
  44470. struct PCache1 {
  44471. /* Cache configuration parameters. Page size (szPage) and the purgeable
  44472. ** flag (bPurgeable) and the pnPurgeable pointer are all set when the
  44473. ** cache is created and are never changed thereafter. nMax may be
  44474. ** modified at any time by a call to the pcache1Cachesize() method.
  44475. ** The PGroup mutex must be held when accessing nMax.
  44476. */
  44477. PGroup *pGroup; /* PGroup this cache belongs to */
  44478. unsigned int *pnPurgeable; /* Pointer to pGroup->nPurgeable */
  44479. int szPage; /* Size of database content section */
  44480. int szExtra; /* sizeof(MemPage)+sizeof(PgHdr) */
  44481. int szAlloc; /* Total size of one pcache line */
  44482. int bPurgeable; /* True if cache is purgeable */
  44483. unsigned int nMin; /* Minimum number of pages reserved */
  44484. unsigned int nMax; /* Configured "cache_size" value */
  44485. unsigned int n90pct; /* nMax*9/10 */
  44486. unsigned int iMaxKey; /* Largest key seen since xTruncate() */
  44487. /* Hash table of all pages. The following variables may only be accessed
  44488. ** when the accessor is holding the PGroup mutex.
  44489. */
  44490. unsigned int nRecyclable; /* Number of pages in the LRU list */
  44491. unsigned int nPage; /* Total number of pages in apHash */
  44492. unsigned int nHash; /* Number of slots in apHash[] */
  44493. PgHdr1 **apHash; /* Hash table for fast lookup by key */
  44494. PgHdr1 *pFree; /* List of unused pcache-local pages */
  44495. void *pBulk; /* Bulk memory used by pcache-local */
  44496. };
  44497. /*
  44498. ** Free slots in the allocator used to divide up the global page cache
  44499. ** buffer provided using the SQLITE_CONFIG_PAGECACHE mechanism.
  44500. */
  44501. struct PgFreeslot {
  44502. PgFreeslot *pNext; /* Next free slot */
  44503. };
  44504. /*
  44505. ** Global data used by this cache.
  44506. */
  44507. static SQLITE_WSD struct PCacheGlobal {
  44508. PGroup grp; /* The global PGroup for mode (2) */
  44509. /* Variables related to SQLITE_CONFIG_PAGECACHE settings. The
  44510. ** szSlot, nSlot, pStart, pEnd, nReserve, and isInit values are all
  44511. ** fixed at sqlite3_initialize() time and do not require mutex protection.
  44512. ** The nFreeSlot and pFree values do require mutex protection.
  44513. */
  44514. int isInit; /* True if initialized */
  44515. int separateCache; /* Use a new PGroup for each PCache */
  44516. int nInitPage; /* Initial bulk allocation size */
  44517. int szSlot; /* Size of each free slot */
  44518. int nSlot; /* The number of pcache slots */
  44519. int nReserve; /* Try to keep nFreeSlot above this */
  44520. void *pStart, *pEnd; /* Bounds of global page cache memory */
  44521. /* Above requires no mutex. Use mutex below for variable that follow. */
  44522. sqlite3_mutex *mutex; /* Mutex for accessing the following: */
  44523. PgFreeslot *pFree; /* Free page blocks */
  44524. int nFreeSlot; /* Number of unused pcache slots */
  44525. /* The following value requires a mutex to change. We skip the mutex on
  44526. ** reading because (1) most platforms read a 32-bit integer atomically and
  44527. ** (2) even if an incorrect value is read, no great harm is done since this
  44528. ** is really just an optimization. */
  44529. int bUnderPressure; /* True if low on PAGECACHE memory */
  44530. } pcache1_g;
  44531. /*
  44532. ** All code in this file should access the global structure above via the
  44533. ** alias "pcache1". This ensures that the WSD emulation is used when
  44534. ** compiling for systems that do not support real WSD.
  44535. */
  44536. #define pcache1 (GLOBAL(struct PCacheGlobal, pcache1_g))
  44537. /*
  44538. ** Macros to enter and leave the PCache LRU mutex.
  44539. */
  44540. #if !defined(SQLITE_ENABLE_MEMORY_MANAGEMENT) || SQLITE_THREADSAFE==0
  44541. # define pcache1EnterMutex(X) assert((X)->mutex==0)
  44542. # define pcache1LeaveMutex(X) assert((X)->mutex==0)
  44543. # define PCACHE1_MIGHT_USE_GROUP_MUTEX 0
  44544. #else
  44545. # define pcache1EnterMutex(X) sqlite3_mutex_enter((X)->mutex)
  44546. # define pcache1LeaveMutex(X) sqlite3_mutex_leave((X)->mutex)
  44547. # define PCACHE1_MIGHT_USE_GROUP_MUTEX 1
  44548. #endif
  44549. /******************************************************************************/
  44550. /******** Page Allocation/SQLITE_CONFIG_PCACHE Related Functions **************/
  44551. /*
  44552. ** This function is called during initialization if a static buffer is
  44553. ** supplied to use for the page-cache by passing the SQLITE_CONFIG_PAGECACHE
  44554. ** verb to sqlite3_config(). Parameter pBuf points to an allocation large
  44555. ** enough to contain 'n' buffers of 'sz' bytes each.
  44556. **
  44557. ** This routine is called from sqlite3_initialize() and so it is guaranteed
  44558. ** to be serialized already. There is no need for further mutexing.
  44559. */
  44560. SQLITE_PRIVATE void sqlite3PCacheBufferSetup(void *pBuf, int sz, int n){
  44561. if( pcache1.isInit ){
  44562. PgFreeslot *p;
  44563. if( pBuf==0 ) sz = n = 0;
  44564. if( n==0 ) sz = 0;
  44565. sz = ROUNDDOWN8(sz);
  44566. pcache1.szSlot = sz;
  44567. pcache1.nSlot = pcache1.nFreeSlot = n;
  44568. pcache1.nReserve = n>90 ? 10 : (n/10 + 1);
  44569. pcache1.pStart = pBuf;
  44570. pcache1.pFree = 0;
  44571. pcache1.bUnderPressure = 0;
  44572. while( n-- ){
  44573. p = (PgFreeslot*)pBuf;
  44574. p->pNext = pcache1.pFree;
  44575. pcache1.pFree = p;
  44576. pBuf = (void*)&((char*)pBuf)[sz];
  44577. }
  44578. pcache1.pEnd = pBuf;
  44579. }
  44580. }
  44581. /*
  44582. ** Try to initialize the pCache->pFree and pCache->pBulk fields. Return
  44583. ** true if pCache->pFree ends up containing one or more free pages.
  44584. */
  44585. static int pcache1InitBulk(PCache1 *pCache){
  44586. i64 szBulk;
  44587. char *zBulk;
  44588. if( pcache1.nInitPage==0 ) return 0;
  44589. /* Do not bother with a bulk allocation if the cache size very small */
  44590. if( pCache->nMax<3 ) return 0;
  44591. sqlite3BeginBenignMalloc();
  44592. if( pcache1.nInitPage>0 ){
  44593. szBulk = pCache->szAlloc * (i64)pcache1.nInitPage;
  44594. }else{
  44595. szBulk = -1024 * (i64)pcache1.nInitPage;
  44596. }
  44597. if( szBulk > pCache->szAlloc*(i64)pCache->nMax ){
  44598. szBulk = pCache->szAlloc*(i64)pCache->nMax;
  44599. }
  44600. zBulk = pCache->pBulk = sqlite3Malloc( szBulk );
  44601. sqlite3EndBenignMalloc();
  44602. if( zBulk ){
  44603. int nBulk = sqlite3MallocSize(zBulk)/pCache->szAlloc;
  44604. do{
  44605. PgHdr1 *pX = (PgHdr1*)&zBulk[pCache->szPage];
  44606. pX->page.pBuf = zBulk;
  44607. pX->page.pExtra = &pX[1];
  44608. pX->isBulkLocal = 1;
  44609. pX->isAnchor = 0;
  44610. pX->pNext = pCache->pFree;
  44611. pCache->pFree = pX;
  44612. zBulk += pCache->szAlloc;
  44613. }while( --nBulk );
  44614. }
  44615. return pCache->pFree!=0;
  44616. }
  44617. /*
  44618. ** Malloc function used within this file to allocate space from the buffer
  44619. ** configured using sqlite3_config(SQLITE_CONFIG_PAGECACHE) option. If no
  44620. ** such buffer exists or there is no space left in it, this function falls
  44621. ** back to sqlite3Malloc().
  44622. **
  44623. ** Multiple threads can run this routine at the same time. Global variables
  44624. ** in pcache1 need to be protected via mutex.
  44625. */
  44626. static void *pcache1Alloc(int nByte){
  44627. void *p = 0;
  44628. assert( sqlite3_mutex_notheld(pcache1.grp.mutex) );
  44629. if( nByte<=pcache1.szSlot ){
  44630. sqlite3_mutex_enter(pcache1.mutex);
  44631. p = (PgHdr1 *)pcache1.pFree;
  44632. if( p ){
  44633. pcache1.pFree = pcache1.pFree->pNext;
  44634. pcache1.nFreeSlot--;
  44635. pcache1.bUnderPressure = pcache1.nFreeSlot<pcache1.nReserve;
  44636. assert( pcache1.nFreeSlot>=0 );
  44637. sqlite3StatusHighwater(SQLITE_STATUS_PAGECACHE_SIZE, nByte);
  44638. sqlite3StatusUp(SQLITE_STATUS_PAGECACHE_USED, 1);
  44639. }
  44640. sqlite3_mutex_leave(pcache1.mutex);
  44641. }
  44642. if( p==0 ){
  44643. /* Memory is not available in the SQLITE_CONFIG_PAGECACHE pool. Get
  44644. ** it from sqlite3Malloc instead.
  44645. */
  44646. p = sqlite3Malloc(nByte);
  44647. #ifndef SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS
  44648. if( p ){
  44649. int sz = sqlite3MallocSize(p);
  44650. sqlite3_mutex_enter(pcache1.mutex);
  44651. sqlite3StatusHighwater(SQLITE_STATUS_PAGECACHE_SIZE, nByte);
  44652. sqlite3StatusUp(SQLITE_STATUS_PAGECACHE_OVERFLOW, sz);
  44653. sqlite3_mutex_leave(pcache1.mutex);
  44654. }
  44655. #endif
  44656. sqlite3MemdebugSetType(p, MEMTYPE_PCACHE);
  44657. }
  44658. return p;
  44659. }
  44660. /*
  44661. ** Free an allocated buffer obtained from pcache1Alloc().
  44662. */
  44663. static void pcache1Free(void *p){
  44664. if( p==0 ) return;
  44665. if( SQLITE_WITHIN(p, pcache1.pStart, pcache1.pEnd) ){
  44666. PgFreeslot *pSlot;
  44667. sqlite3_mutex_enter(pcache1.mutex);
  44668. sqlite3StatusDown(SQLITE_STATUS_PAGECACHE_USED, 1);
  44669. pSlot = (PgFreeslot*)p;
  44670. pSlot->pNext = pcache1.pFree;
  44671. pcache1.pFree = pSlot;
  44672. pcache1.nFreeSlot++;
  44673. pcache1.bUnderPressure = pcache1.nFreeSlot<pcache1.nReserve;
  44674. assert( pcache1.nFreeSlot<=pcache1.nSlot );
  44675. sqlite3_mutex_leave(pcache1.mutex);
  44676. }else{
  44677. assert( sqlite3MemdebugHasType(p, MEMTYPE_PCACHE) );
  44678. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  44679. #ifndef SQLITE_DISABLE_PAGECACHE_OVERFLOW_STATS
  44680. {
  44681. int nFreed = 0;
  44682. nFreed = sqlite3MallocSize(p);
  44683. sqlite3_mutex_enter(pcache1.mutex);
  44684. sqlite3StatusDown(SQLITE_STATUS_PAGECACHE_OVERFLOW, nFreed);
  44685. sqlite3_mutex_leave(pcache1.mutex);
  44686. }
  44687. #endif
  44688. sqlite3_free(p);
  44689. }
  44690. }
  44691. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  44692. /*
  44693. ** Return the size of a pcache allocation
  44694. */
  44695. static int pcache1MemSize(void *p){
  44696. if( p>=pcache1.pStart && p<pcache1.pEnd ){
  44697. return pcache1.szSlot;
  44698. }else{
  44699. int iSize;
  44700. assert( sqlite3MemdebugHasType(p, MEMTYPE_PCACHE) );
  44701. sqlite3MemdebugSetType(p, MEMTYPE_HEAP);
  44702. iSize = sqlite3MallocSize(p);
  44703. sqlite3MemdebugSetType(p, MEMTYPE_PCACHE);
  44704. return iSize;
  44705. }
  44706. }
  44707. #endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
  44708. /*
  44709. ** Allocate a new page object initially associated with cache pCache.
  44710. */
  44711. static PgHdr1 *pcache1AllocPage(PCache1 *pCache, int benignMalloc){
  44712. PgHdr1 *p = 0;
  44713. void *pPg;
  44714. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  44715. if( pCache->pFree || (pCache->nPage==0 && pcache1InitBulk(pCache)) ){
  44716. p = pCache->pFree;
  44717. pCache->pFree = p->pNext;
  44718. p->pNext = 0;
  44719. }else{
  44720. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  44721. /* The group mutex must be released before pcache1Alloc() is called. This
  44722. ** is because it might call sqlite3_release_memory(), which assumes that
  44723. ** this mutex is not held. */
  44724. assert( pcache1.separateCache==0 );
  44725. assert( pCache->pGroup==&pcache1.grp );
  44726. pcache1LeaveMutex(pCache->pGroup);
  44727. #endif
  44728. if( benignMalloc ){ sqlite3BeginBenignMalloc(); }
  44729. #ifdef SQLITE_PCACHE_SEPARATE_HEADER
  44730. pPg = pcache1Alloc(pCache->szPage);
  44731. p = sqlite3Malloc(sizeof(PgHdr1) + pCache->szExtra);
  44732. if( !pPg || !p ){
  44733. pcache1Free(pPg);
  44734. sqlite3_free(p);
  44735. pPg = 0;
  44736. }
  44737. #else
  44738. pPg = pcache1Alloc(pCache->szAlloc);
  44739. p = (PgHdr1 *)&((u8 *)pPg)[pCache->szPage];
  44740. #endif
  44741. if( benignMalloc ){ sqlite3EndBenignMalloc(); }
  44742. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  44743. pcache1EnterMutex(pCache->pGroup);
  44744. #endif
  44745. if( pPg==0 ) return 0;
  44746. p->page.pBuf = pPg;
  44747. p->page.pExtra = &p[1];
  44748. p->isBulkLocal = 0;
  44749. p->isAnchor = 0;
  44750. }
  44751. (*pCache->pnPurgeable)++;
  44752. return p;
  44753. }
  44754. /*
  44755. ** Free a page object allocated by pcache1AllocPage().
  44756. */
  44757. static void pcache1FreePage(PgHdr1 *p){
  44758. PCache1 *pCache;
  44759. assert( p!=0 );
  44760. pCache = p->pCache;
  44761. assert( sqlite3_mutex_held(p->pCache->pGroup->mutex) );
  44762. if( p->isBulkLocal ){
  44763. p->pNext = pCache->pFree;
  44764. pCache->pFree = p;
  44765. }else{
  44766. pcache1Free(p->page.pBuf);
  44767. #ifdef SQLITE_PCACHE_SEPARATE_HEADER
  44768. sqlite3_free(p);
  44769. #endif
  44770. }
  44771. (*pCache->pnPurgeable)--;
  44772. }
  44773. /*
  44774. ** Malloc function used by SQLite to obtain space from the buffer configured
  44775. ** using sqlite3_config(SQLITE_CONFIG_PAGECACHE) option. If no such buffer
  44776. ** exists, this function falls back to sqlite3Malloc().
  44777. */
  44778. SQLITE_PRIVATE void *sqlite3PageMalloc(int sz){
  44779. return pcache1Alloc(sz);
  44780. }
  44781. /*
  44782. ** Free an allocated buffer obtained from sqlite3PageMalloc().
  44783. */
  44784. SQLITE_PRIVATE void sqlite3PageFree(void *p){
  44785. pcache1Free(p);
  44786. }
  44787. /*
  44788. ** Return true if it desirable to avoid allocating a new page cache
  44789. ** entry.
  44790. **
  44791. ** If memory was allocated specifically to the page cache using
  44792. ** SQLITE_CONFIG_PAGECACHE but that memory has all been used, then
  44793. ** it is desirable to avoid allocating a new page cache entry because
  44794. ** presumably SQLITE_CONFIG_PAGECACHE was suppose to be sufficient
  44795. ** for all page cache needs and we should not need to spill the
  44796. ** allocation onto the heap.
  44797. **
  44798. ** Or, the heap is used for all page cache memory but the heap is
  44799. ** under memory pressure, then again it is desirable to avoid
  44800. ** allocating a new page cache entry in order to avoid stressing
  44801. ** the heap even further.
  44802. */
  44803. static int pcache1UnderMemoryPressure(PCache1 *pCache){
  44804. if( pcache1.nSlot && (pCache->szPage+pCache->szExtra)<=pcache1.szSlot ){
  44805. return pcache1.bUnderPressure;
  44806. }else{
  44807. return sqlite3HeapNearlyFull();
  44808. }
  44809. }
  44810. /******************************************************************************/
  44811. /******** General Implementation Functions ************************************/
  44812. /*
  44813. ** This function is used to resize the hash table used by the cache passed
  44814. ** as the first argument.
  44815. **
  44816. ** The PCache mutex must be held when this function is called.
  44817. */
  44818. static void pcache1ResizeHash(PCache1 *p){
  44819. PgHdr1 **apNew;
  44820. unsigned int nNew;
  44821. unsigned int i;
  44822. assert( sqlite3_mutex_held(p->pGroup->mutex) );
  44823. nNew = p->nHash*2;
  44824. if( nNew<256 ){
  44825. nNew = 256;
  44826. }
  44827. pcache1LeaveMutex(p->pGroup);
  44828. if( p->nHash ){ sqlite3BeginBenignMalloc(); }
  44829. apNew = (PgHdr1 **)sqlite3MallocZero(sizeof(PgHdr1 *)*nNew);
  44830. if( p->nHash ){ sqlite3EndBenignMalloc(); }
  44831. pcache1EnterMutex(p->pGroup);
  44832. if( apNew ){
  44833. for(i=0; i<p->nHash; i++){
  44834. PgHdr1 *pPage;
  44835. PgHdr1 *pNext = p->apHash[i];
  44836. while( (pPage = pNext)!=0 ){
  44837. unsigned int h = pPage->iKey % nNew;
  44838. pNext = pPage->pNext;
  44839. pPage->pNext = apNew[h];
  44840. apNew[h] = pPage;
  44841. }
  44842. }
  44843. sqlite3_free(p->apHash);
  44844. p->apHash = apNew;
  44845. p->nHash = nNew;
  44846. }
  44847. }
  44848. /*
  44849. ** This function is used internally to remove the page pPage from the
  44850. ** PGroup LRU list, if is part of it. If pPage is not part of the PGroup
  44851. ** LRU list, then this function is a no-op.
  44852. **
  44853. ** The PGroup mutex must be held when this function is called.
  44854. */
  44855. static PgHdr1 *pcache1PinPage(PgHdr1 *pPage){
  44856. assert( pPage!=0 );
  44857. assert( PAGE_IS_UNPINNED(pPage) );
  44858. assert( pPage->pLruNext );
  44859. assert( pPage->pLruPrev );
  44860. assert( sqlite3_mutex_held(pPage->pCache->pGroup->mutex) );
  44861. pPage->pLruPrev->pLruNext = pPage->pLruNext;
  44862. pPage->pLruNext->pLruPrev = pPage->pLruPrev;
  44863. pPage->pLruNext = 0;
  44864. pPage->pLruPrev = 0;
  44865. assert( pPage->isAnchor==0 );
  44866. assert( pPage->pCache->pGroup->lru.isAnchor==1 );
  44867. pPage->pCache->nRecyclable--;
  44868. return pPage;
  44869. }
  44870. /*
  44871. ** Remove the page supplied as an argument from the hash table
  44872. ** (PCache1.apHash structure) that it is currently stored in.
  44873. ** Also free the page if freePage is true.
  44874. **
  44875. ** The PGroup mutex must be held when this function is called.
  44876. */
  44877. static void pcache1RemoveFromHash(PgHdr1 *pPage, int freeFlag){
  44878. unsigned int h;
  44879. PCache1 *pCache = pPage->pCache;
  44880. PgHdr1 **pp;
  44881. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  44882. h = pPage->iKey % pCache->nHash;
  44883. for(pp=&pCache->apHash[h]; (*pp)!=pPage; pp=&(*pp)->pNext);
  44884. *pp = (*pp)->pNext;
  44885. pCache->nPage--;
  44886. if( freeFlag ) pcache1FreePage(pPage);
  44887. }
  44888. /*
  44889. ** If there are currently more than nMaxPage pages allocated, try
  44890. ** to recycle pages to reduce the number allocated to nMaxPage.
  44891. */
  44892. static void pcache1EnforceMaxPage(PCache1 *pCache){
  44893. PGroup *pGroup = pCache->pGroup;
  44894. PgHdr1 *p;
  44895. assert( sqlite3_mutex_held(pGroup->mutex) );
  44896. while( pGroup->nPurgeable>pGroup->nMaxPage
  44897. && (p=pGroup->lru.pLruPrev)->isAnchor==0
  44898. ){
  44899. assert( p->pCache->pGroup==pGroup );
  44900. assert( PAGE_IS_UNPINNED(p) );
  44901. pcache1PinPage(p);
  44902. pcache1RemoveFromHash(p, 1);
  44903. }
  44904. if( pCache->nPage==0 && pCache->pBulk ){
  44905. sqlite3_free(pCache->pBulk);
  44906. pCache->pBulk = pCache->pFree = 0;
  44907. }
  44908. }
  44909. /*
  44910. ** Discard all pages from cache pCache with a page number (key value)
  44911. ** greater than or equal to iLimit. Any pinned pages that meet this
  44912. ** criteria are unpinned before they are discarded.
  44913. **
  44914. ** The PCache mutex must be held when this function is called.
  44915. */
  44916. static void pcache1TruncateUnsafe(
  44917. PCache1 *pCache, /* The cache to truncate */
  44918. unsigned int iLimit /* Drop pages with this pgno or larger */
  44919. ){
  44920. TESTONLY( int nPage = 0; ) /* To assert pCache->nPage is correct */
  44921. unsigned int h, iStop;
  44922. assert( sqlite3_mutex_held(pCache->pGroup->mutex) );
  44923. assert( pCache->iMaxKey >= iLimit );
  44924. assert( pCache->nHash > 0 );
  44925. if( pCache->iMaxKey - iLimit < pCache->nHash ){
  44926. /* If we are just shaving the last few pages off the end of the
  44927. ** cache, then there is no point in scanning the entire hash table.
  44928. ** Only scan those hash slots that might contain pages that need to
  44929. ** be removed. */
  44930. h = iLimit % pCache->nHash;
  44931. iStop = pCache->iMaxKey % pCache->nHash;
  44932. TESTONLY( nPage = -10; ) /* Disable the pCache->nPage validity check */
  44933. }else{
  44934. /* This is the general case where many pages are being removed.
  44935. ** It is necessary to scan the entire hash table */
  44936. h = pCache->nHash/2;
  44937. iStop = h - 1;
  44938. }
  44939. for(;;){
  44940. PgHdr1 **pp;
  44941. PgHdr1 *pPage;
  44942. assert( h<pCache->nHash );
  44943. pp = &pCache->apHash[h];
  44944. while( (pPage = *pp)!=0 ){
  44945. if( pPage->iKey>=iLimit ){
  44946. pCache->nPage--;
  44947. *pp = pPage->pNext;
  44948. if( PAGE_IS_UNPINNED(pPage) ) pcache1PinPage(pPage);
  44949. pcache1FreePage(pPage);
  44950. }else{
  44951. pp = &pPage->pNext;
  44952. TESTONLY( if( nPage>=0 ) nPage++; )
  44953. }
  44954. }
  44955. if( h==iStop ) break;
  44956. h = (h+1) % pCache->nHash;
  44957. }
  44958. assert( nPage<0 || pCache->nPage==(unsigned)nPage );
  44959. }
  44960. /******************************************************************************/
  44961. /******** sqlite3_pcache Methods **********************************************/
  44962. /*
  44963. ** Implementation of the sqlite3_pcache.xInit method.
  44964. */
  44965. static int pcache1Init(void *NotUsed){
  44966. UNUSED_PARAMETER(NotUsed);
  44967. assert( pcache1.isInit==0 );
  44968. memset(&pcache1, 0, sizeof(pcache1));
  44969. /*
  44970. ** The pcache1.separateCache variable is true if each PCache has its own
  44971. ** private PGroup (mode-1). pcache1.separateCache is false if the single
  44972. ** PGroup in pcache1.grp is used for all page caches (mode-2).
  44973. **
  44974. ** * Always use a unified cache (mode-2) if ENABLE_MEMORY_MANAGEMENT
  44975. **
  44976. ** * Use a unified cache in single-threaded applications that have
  44977. ** configured a start-time buffer for use as page-cache memory using
  44978. ** sqlite3_config(SQLITE_CONFIG_PAGECACHE, pBuf, sz, N) with non-NULL
  44979. ** pBuf argument.
  44980. **
  44981. ** * Otherwise use separate caches (mode-1)
  44982. */
  44983. #if defined(SQLITE_ENABLE_MEMORY_MANAGEMENT)
  44984. pcache1.separateCache = 0;
  44985. #elif SQLITE_THREADSAFE
  44986. pcache1.separateCache = sqlite3GlobalConfig.pPage==0
  44987. || sqlite3GlobalConfig.bCoreMutex>0;
  44988. #else
  44989. pcache1.separateCache = sqlite3GlobalConfig.pPage==0;
  44990. #endif
  44991. #if SQLITE_THREADSAFE
  44992. if( sqlite3GlobalConfig.bCoreMutex ){
  44993. pcache1.grp.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_LRU);
  44994. pcache1.mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_PMEM);
  44995. }
  44996. #endif
  44997. if( pcache1.separateCache
  44998. && sqlite3GlobalConfig.nPage!=0
  44999. && sqlite3GlobalConfig.pPage==0
  45000. ){
  45001. pcache1.nInitPage = sqlite3GlobalConfig.nPage;
  45002. }else{
  45003. pcache1.nInitPage = 0;
  45004. }
  45005. pcache1.grp.mxPinned = 10;
  45006. pcache1.isInit = 1;
  45007. return SQLITE_OK;
  45008. }
  45009. /*
  45010. ** Implementation of the sqlite3_pcache.xShutdown method.
  45011. ** Note that the static mutex allocated in xInit does
  45012. ** not need to be freed.
  45013. */
  45014. static void pcache1Shutdown(void *NotUsed){
  45015. UNUSED_PARAMETER(NotUsed);
  45016. assert( pcache1.isInit!=0 );
  45017. memset(&pcache1, 0, sizeof(pcache1));
  45018. }
  45019. /* forward declaration */
  45020. static void pcache1Destroy(sqlite3_pcache *p);
  45021. /*
  45022. ** Implementation of the sqlite3_pcache.xCreate method.
  45023. **
  45024. ** Allocate a new cache.
  45025. */
  45026. static sqlite3_pcache *pcache1Create(int szPage, int szExtra, int bPurgeable){
  45027. PCache1 *pCache; /* The newly created page cache */
  45028. PGroup *pGroup; /* The group the new page cache will belong to */
  45029. int sz; /* Bytes of memory required to allocate the new cache */
  45030. assert( (szPage & (szPage-1))==0 && szPage>=512 && szPage<=65536 );
  45031. assert( szExtra < 300 );
  45032. sz = sizeof(PCache1) + sizeof(PGroup)*pcache1.separateCache;
  45033. pCache = (PCache1 *)sqlite3MallocZero(sz);
  45034. if( pCache ){
  45035. if( pcache1.separateCache ){
  45036. pGroup = (PGroup*)&pCache[1];
  45037. pGroup->mxPinned = 10;
  45038. }else{
  45039. pGroup = &pcache1.grp;
  45040. }
  45041. if( pGroup->lru.isAnchor==0 ){
  45042. pGroup->lru.isAnchor = 1;
  45043. pGroup->lru.pLruPrev = pGroup->lru.pLruNext = &pGroup->lru;
  45044. }
  45045. pCache->pGroup = pGroup;
  45046. pCache->szPage = szPage;
  45047. pCache->szExtra = szExtra;
  45048. pCache->szAlloc = szPage + szExtra + ROUND8(sizeof(PgHdr1));
  45049. pCache->bPurgeable = (bPurgeable ? 1 : 0);
  45050. pcache1EnterMutex(pGroup);
  45051. pcache1ResizeHash(pCache);
  45052. if( bPurgeable ){
  45053. pCache->nMin = 10;
  45054. pGroup->nMinPage += pCache->nMin;
  45055. pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage;
  45056. pCache->pnPurgeable = &pGroup->nPurgeable;
  45057. }else{
  45058. static unsigned int dummyCurrentPage;
  45059. pCache->pnPurgeable = &dummyCurrentPage;
  45060. }
  45061. pcache1LeaveMutex(pGroup);
  45062. if( pCache->nHash==0 ){
  45063. pcache1Destroy((sqlite3_pcache*)pCache);
  45064. pCache = 0;
  45065. }
  45066. }
  45067. return (sqlite3_pcache *)pCache;
  45068. }
  45069. /*
  45070. ** Implementation of the sqlite3_pcache.xCachesize method.
  45071. **
  45072. ** Configure the cache_size limit for a cache.
  45073. */
  45074. static void pcache1Cachesize(sqlite3_pcache *p, int nMax){
  45075. PCache1 *pCache = (PCache1 *)p;
  45076. if( pCache->bPurgeable ){
  45077. PGroup *pGroup = pCache->pGroup;
  45078. pcache1EnterMutex(pGroup);
  45079. pGroup->nMaxPage += (nMax - pCache->nMax);
  45080. pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage;
  45081. pCache->nMax = nMax;
  45082. pCache->n90pct = pCache->nMax*9/10;
  45083. pcache1EnforceMaxPage(pCache);
  45084. pcache1LeaveMutex(pGroup);
  45085. }
  45086. }
  45087. /*
  45088. ** Implementation of the sqlite3_pcache.xShrink method.
  45089. **
  45090. ** Free up as much memory as possible.
  45091. */
  45092. static void pcache1Shrink(sqlite3_pcache *p){
  45093. PCache1 *pCache = (PCache1*)p;
  45094. if( pCache->bPurgeable ){
  45095. PGroup *pGroup = pCache->pGroup;
  45096. int savedMaxPage;
  45097. pcache1EnterMutex(pGroup);
  45098. savedMaxPage = pGroup->nMaxPage;
  45099. pGroup->nMaxPage = 0;
  45100. pcache1EnforceMaxPage(pCache);
  45101. pGroup->nMaxPage = savedMaxPage;
  45102. pcache1LeaveMutex(pGroup);
  45103. }
  45104. }
  45105. /*
  45106. ** Implementation of the sqlite3_pcache.xPagecount method.
  45107. */
  45108. static int pcache1Pagecount(sqlite3_pcache *p){
  45109. int n;
  45110. PCache1 *pCache = (PCache1*)p;
  45111. pcache1EnterMutex(pCache->pGroup);
  45112. n = pCache->nPage;
  45113. pcache1LeaveMutex(pCache->pGroup);
  45114. return n;
  45115. }
  45116. /*
  45117. ** Implement steps 3, 4, and 5 of the pcache1Fetch() algorithm described
  45118. ** in the header of the pcache1Fetch() procedure.
  45119. **
  45120. ** This steps are broken out into a separate procedure because they are
  45121. ** usually not needed, and by avoiding the stack initialization required
  45122. ** for these steps, the main pcache1Fetch() procedure can run faster.
  45123. */
  45124. static SQLITE_NOINLINE PgHdr1 *pcache1FetchStage2(
  45125. PCache1 *pCache,
  45126. unsigned int iKey,
  45127. int createFlag
  45128. ){
  45129. unsigned int nPinned;
  45130. PGroup *pGroup = pCache->pGroup;
  45131. PgHdr1 *pPage = 0;
  45132. /* Step 3: Abort if createFlag is 1 but the cache is nearly full */
  45133. assert( pCache->nPage >= pCache->nRecyclable );
  45134. nPinned = pCache->nPage - pCache->nRecyclable;
  45135. assert( pGroup->mxPinned == pGroup->nMaxPage + 10 - pGroup->nMinPage );
  45136. assert( pCache->n90pct == pCache->nMax*9/10 );
  45137. if( createFlag==1 && (
  45138. nPinned>=pGroup->mxPinned
  45139. || nPinned>=pCache->n90pct
  45140. || (pcache1UnderMemoryPressure(pCache) && pCache->nRecyclable<nPinned)
  45141. )){
  45142. return 0;
  45143. }
  45144. if( pCache->nPage>=pCache->nHash ) pcache1ResizeHash(pCache);
  45145. assert( pCache->nHash>0 && pCache->apHash );
  45146. /* Step 4. Try to recycle a page. */
  45147. if( pCache->bPurgeable
  45148. && !pGroup->lru.pLruPrev->isAnchor
  45149. && ((pCache->nPage+1>=pCache->nMax) || pcache1UnderMemoryPressure(pCache))
  45150. ){
  45151. PCache1 *pOther;
  45152. pPage = pGroup->lru.pLruPrev;
  45153. assert( PAGE_IS_UNPINNED(pPage) );
  45154. pcache1RemoveFromHash(pPage, 0);
  45155. pcache1PinPage(pPage);
  45156. pOther = pPage->pCache;
  45157. if( pOther->szAlloc != pCache->szAlloc ){
  45158. pcache1FreePage(pPage);
  45159. pPage = 0;
  45160. }else{
  45161. pGroup->nPurgeable -= (pOther->bPurgeable - pCache->bPurgeable);
  45162. }
  45163. }
  45164. /* Step 5. If a usable page buffer has still not been found,
  45165. ** attempt to allocate a new one.
  45166. */
  45167. if( !pPage ){
  45168. pPage = pcache1AllocPage(pCache, createFlag==1);
  45169. }
  45170. if( pPage ){
  45171. unsigned int h = iKey % pCache->nHash;
  45172. pCache->nPage++;
  45173. pPage->iKey = iKey;
  45174. pPage->pNext = pCache->apHash[h];
  45175. pPage->pCache = pCache;
  45176. pPage->pLruPrev = 0;
  45177. pPage->pLruNext = 0;
  45178. *(void **)pPage->page.pExtra = 0;
  45179. pCache->apHash[h] = pPage;
  45180. if( iKey>pCache->iMaxKey ){
  45181. pCache->iMaxKey = iKey;
  45182. }
  45183. }
  45184. return pPage;
  45185. }
  45186. /*
  45187. ** Implementation of the sqlite3_pcache.xFetch method.
  45188. **
  45189. ** Fetch a page by key value.
  45190. **
  45191. ** Whether or not a new page may be allocated by this function depends on
  45192. ** the value of the createFlag argument. 0 means do not allocate a new
  45193. ** page. 1 means allocate a new page if space is easily available. 2
  45194. ** means to try really hard to allocate a new page.
  45195. **
  45196. ** For a non-purgeable cache (a cache used as the storage for an in-memory
  45197. ** database) there is really no difference between createFlag 1 and 2. So
  45198. ** the calling function (pcache.c) will never have a createFlag of 1 on
  45199. ** a non-purgeable cache.
  45200. **
  45201. ** There are three different approaches to obtaining space for a page,
  45202. ** depending on the value of parameter createFlag (which may be 0, 1 or 2).
  45203. **
  45204. ** 1. Regardless of the value of createFlag, the cache is searched for a
  45205. ** copy of the requested page. If one is found, it is returned.
  45206. **
  45207. ** 2. If createFlag==0 and the page is not already in the cache, NULL is
  45208. ** returned.
  45209. **
  45210. ** 3. If createFlag is 1, and the page is not already in the cache, then
  45211. ** return NULL (do not allocate a new page) if any of the following
  45212. ** conditions are true:
  45213. **
  45214. ** (a) the number of pages pinned by the cache is greater than
  45215. ** PCache1.nMax, or
  45216. **
  45217. ** (b) the number of pages pinned by the cache is greater than
  45218. ** the sum of nMax for all purgeable caches, less the sum of
  45219. ** nMin for all other purgeable caches, or
  45220. **
  45221. ** 4. If none of the first three conditions apply and the cache is marked
  45222. ** as purgeable, and if one of the following is true:
  45223. **
  45224. ** (a) The number of pages allocated for the cache is already
  45225. ** PCache1.nMax, or
  45226. **
  45227. ** (b) The number of pages allocated for all purgeable caches is
  45228. ** already equal to or greater than the sum of nMax for all
  45229. ** purgeable caches,
  45230. **
  45231. ** (c) The system is under memory pressure and wants to avoid
  45232. ** unnecessary pages cache entry allocations
  45233. **
  45234. ** then attempt to recycle a page from the LRU list. If it is the right
  45235. ** size, return the recycled buffer. Otherwise, free the buffer and
  45236. ** proceed to step 5.
  45237. **
  45238. ** 5. Otherwise, allocate and return a new page buffer.
  45239. **
  45240. ** There are two versions of this routine. pcache1FetchWithMutex() is
  45241. ** the general case. pcache1FetchNoMutex() is a faster implementation for
  45242. ** the common case where pGroup->mutex is NULL. The pcache1Fetch() wrapper
  45243. ** invokes the appropriate routine.
  45244. */
  45245. static PgHdr1 *pcache1FetchNoMutex(
  45246. sqlite3_pcache *p,
  45247. unsigned int iKey,
  45248. int createFlag
  45249. ){
  45250. PCache1 *pCache = (PCache1 *)p;
  45251. PgHdr1 *pPage = 0;
  45252. /* Step 1: Search the hash table for an existing entry. */
  45253. pPage = pCache->apHash[iKey % pCache->nHash];
  45254. while( pPage && pPage->iKey!=iKey ){ pPage = pPage->pNext; }
  45255. /* Step 2: If the page was found in the hash table, then return it.
  45256. ** If the page was not in the hash table and createFlag is 0, abort.
  45257. ** Otherwise (page not in hash and createFlag!=0) continue with
  45258. ** subsequent steps to try to create the page. */
  45259. if( pPage ){
  45260. if( PAGE_IS_UNPINNED(pPage) ){
  45261. return pcache1PinPage(pPage);
  45262. }else{
  45263. return pPage;
  45264. }
  45265. }else if( createFlag ){
  45266. /* Steps 3, 4, and 5 implemented by this subroutine */
  45267. return pcache1FetchStage2(pCache, iKey, createFlag);
  45268. }else{
  45269. return 0;
  45270. }
  45271. }
  45272. #if PCACHE1_MIGHT_USE_GROUP_MUTEX
  45273. static PgHdr1 *pcache1FetchWithMutex(
  45274. sqlite3_pcache *p,
  45275. unsigned int iKey,
  45276. int createFlag
  45277. ){
  45278. PCache1 *pCache = (PCache1 *)p;
  45279. PgHdr1 *pPage;
  45280. pcache1EnterMutex(pCache->pGroup);
  45281. pPage = pcache1FetchNoMutex(p, iKey, createFlag);
  45282. assert( pPage==0 || pCache->iMaxKey>=iKey );
  45283. pcache1LeaveMutex(pCache->pGroup);
  45284. return pPage;
  45285. }
  45286. #endif
  45287. static sqlite3_pcache_page *pcache1Fetch(
  45288. sqlite3_pcache *p,
  45289. unsigned int iKey,
  45290. int createFlag
  45291. ){
  45292. #if PCACHE1_MIGHT_USE_GROUP_MUTEX || defined(SQLITE_DEBUG)
  45293. PCache1 *pCache = (PCache1 *)p;
  45294. #endif
  45295. assert( offsetof(PgHdr1,page)==0 );
  45296. assert( pCache->bPurgeable || createFlag!=1 );
  45297. assert( pCache->bPurgeable || pCache->nMin==0 );
  45298. assert( pCache->bPurgeable==0 || pCache->nMin==10 );
  45299. assert( pCache->nMin==0 || pCache->bPurgeable );
  45300. assert( pCache->nHash>0 );
  45301. #if PCACHE1_MIGHT_USE_GROUP_MUTEX
  45302. if( pCache->pGroup->mutex ){
  45303. return (sqlite3_pcache_page*)pcache1FetchWithMutex(p, iKey, createFlag);
  45304. }else
  45305. #endif
  45306. {
  45307. return (sqlite3_pcache_page*)pcache1FetchNoMutex(p, iKey, createFlag);
  45308. }
  45309. }
  45310. /*
  45311. ** Implementation of the sqlite3_pcache.xUnpin method.
  45312. **
  45313. ** Mark a page as unpinned (eligible for asynchronous recycling).
  45314. */
  45315. static void pcache1Unpin(
  45316. sqlite3_pcache *p,
  45317. sqlite3_pcache_page *pPg,
  45318. int reuseUnlikely
  45319. ){
  45320. PCache1 *pCache = (PCache1 *)p;
  45321. PgHdr1 *pPage = (PgHdr1 *)pPg;
  45322. PGroup *pGroup = pCache->pGroup;
  45323. assert( pPage->pCache==pCache );
  45324. pcache1EnterMutex(pGroup);
  45325. /* It is an error to call this function if the page is already
  45326. ** part of the PGroup LRU list.
  45327. */
  45328. assert( pPage->pLruPrev==0 && pPage->pLruNext==0 );
  45329. assert( PAGE_IS_PINNED(pPage) );
  45330. if( reuseUnlikely || pGroup->nPurgeable>pGroup->nMaxPage ){
  45331. pcache1RemoveFromHash(pPage, 1);
  45332. }else{
  45333. /* Add the page to the PGroup LRU list. */
  45334. PgHdr1 **ppFirst = &pGroup->lru.pLruNext;
  45335. pPage->pLruPrev = &pGroup->lru;
  45336. (pPage->pLruNext = *ppFirst)->pLruPrev = pPage;
  45337. *ppFirst = pPage;
  45338. pCache->nRecyclable++;
  45339. }
  45340. pcache1LeaveMutex(pCache->pGroup);
  45341. }
  45342. /*
  45343. ** Implementation of the sqlite3_pcache.xRekey method.
  45344. */
  45345. static void pcache1Rekey(
  45346. sqlite3_pcache *p,
  45347. sqlite3_pcache_page *pPg,
  45348. unsigned int iOld,
  45349. unsigned int iNew
  45350. ){
  45351. PCache1 *pCache = (PCache1 *)p;
  45352. PgHdr1 *pPage = (PgHdr1 *)pPg;
  45353. PgHdr1 **pp;
  45354. unsigned int h;
  45355. assert( pPage->iKey==iOld );
  45356. assert( pPage->pCache==pCache );
  45357. pcache1EnterMutex(pCache->pGroup);
  45358. h = iOld%pCache->nHash;
  45359. pp = &pCache->apHash[h];
  45360. while( (*pp)!=pPage ){
  45361. pp = &(*pp)->pNext;
  45362. }
  45363. *pp = pPage->pNext;
  45364. h = iNew%pCache->nHash;
  45365. pPage->iKey = iNew;
  45366. pPage->pNext = pCache->apHash[h];
  45367. pCache->apHash[h] = pPage;
  45368. if( iNew>pCache->iMaxKey ){
  45369. pCache->iMaxKey = iNew;
  45370. }
  45371. pcache1LeaveMutex(pCache->pGroup);
  45372. }
  45373. /*
  45374. ** Implementation of the sqlite3_pcache.xTruncate method.
  45375. **
  45376. ** Discard all unpinned pages in the cache with a page number equal to
  45377. ** or greater than parameter iLimit. Any pinned pages with a page number
  45378. ** equal to or greater than iLimit are implicitly unpinned.
  45379. */
  45380. static void pcache1Truncate(sqlite3_pcache *p, unsigned int iLimit){
  45381. PCache1 *pCache = (PCache1 *)p;
  45382. pcache1EnterMutex(pCache->pGroup);
  45383. if( iLimit<=pCache->iMaxKey ){
  45384. pcache1TruncateUnsafe(pCache, iLimit);
  45385. pCache->iMaxKey = iLimit-1;
  45386. }
  45387. pcache1LeaveMutex(pCache->pGroup);
  45388. }
  45389. /*
  45390. ** Implementation of the sqlite3_pcache.xDestroy method.
  45391. **
  45392. ** Destroy a cache allocated using pcache1Create().
  45393. */
  45394. static void pcache1Destroy(sqlite3_pcache *p){
  45395. PCache1 *pCache = (PCache1 *)p;
  45396. PGroup *pGroup = pCache->pGroup;
  45397. assert( pCache->bPurgeable || (pCache->nMax==0 && pCache->nMin==0) );
  45398. pcache1EnterMutex(pGroup);
  45399. if( pCache->nPage ) pcache1TruncateUnsafe(pCache, 0);
  45400. assert( pGroup->nMaxPage >= pCache->nMax );
  45401. pGroup->nMaxPage -= pCache->nMax;
  45402. assert( pGroup->nMinPage >= pCache->nMin );
  45403. pGroup->nMinPage -= pCache->nMin;
  45404. pGroup->mxPinned = pGroup->nMaxPage + 10 - pGroup->nMinPage;
  45405. pcache1EnforceMaxPage(pCache);
  45406. pcache1LeaveMutex(pGroup);
  45407. sqlite3_free(pCache->pBulk);
  45408. sqlite3_free(pCache->apHash);
  45409. sqlite3_free(pCache);
  45410. }
  45411. /*
  45412. ** This function is called during initialization (sqlite3_initialize()) to
  45413. ** install the default pluggable cache module, assuming the user has not
  45414. ** already provided an alternative.
  45415. */
  45416. SQLITE_PRIVATE void sqlite3PCacheSetDefault(void){
  45417. static const sqlite3_pcache_methods2 defaultMethods = {
  45418. 1, /* iVersion */
  45419. 0, /* pArg */
  45420. pcache1Init, /* xInit */
  45421. pcache1Shutdown, /* xShutdown */
  45422. pcache1Create, /* xCreate */
  45423. pcache1Cachesize, /* xCachesize */
  45424. pcache1Pagecount, /* xPagecount */
  45425. pcache1Fetch, /* xFetch */
  45426. pcache1Unpin, /* xUnpin */
  45427. pcache1Rekey, /* xRekey */
  45428. pcache1Truncate, /* xTruncate */
  45429. pcache1Destroy, /* xDestroy */
  45430. pcache1Shrink /* xShrink */
  45431. };
  45432. sqlite3_config(SQLITE_CONFIG_PCACHE2, &defaultMethods);
  45433. }
  45434. /*
  45435. ** Return the size of the header on each page of this PCACHE implementation.
  45436. */
  45437. SQLITE_PRIVATE int sqlite3HeaderSizePcache1(void){ return ROUND8(sizeof(PgHdr1)); }
  45438. /*
  45439. ** Return the global mutex used by this PCACHE implementation. The
  45440. ** sqlite3_status() routine needs access to this mutex.
  45441. */
  45442. SQLITE_PRIVATE sqlite3_mutex *sqlite3Pcache1Mutex(void){
  45443. return pcache1.mutex;
  45444. }
  45445. #ifdef SQLITE_ENABLE_MEMORY_MANAGEMENT
  45446. /*
  45447. ** This function is called to free superfluous dynamically allocated memory
  45448. ** held by the pager system. Memory in use by any SQLite pager allocated
  45449. ** by the current thread may be sqlite3_free()ed.
  45450. **
  45451. ** nReq is the number of bytes of memory required. Once this much has
  45452. ** been released, the function returns. The return value is the total number
  45453. ** of bytes of memory released.
  45454. */
  45455. SQLITE_PRIVATE int sqlite3PcacheReleaseMemory(int nReq){
  45456. int nFree = 0;
  45457. assert( sqlite3_mutex_notheld(pcache1.grp.mutex) );
  45458. assert( sqlite3_mutex_notheld(pcache1.mutex) );
  45459. if( sqlite3GlobalConfig.pPage==0 ){
  45460. PgHdr1 *p;
  45461. pcache1EnterMutex(&pcache1.grp);
  45462. while( (nReq<0 || nFree<nReq)
  45463. && (p=pcache1.grp.lru.pLruPrev)!=0
  45464. && p->isAnchor==0
  45465. ){
  45466. nFree += pcache1MemSize(p->page.pBuf);
  45467. #ifdef SQLITE_PCACHE_SEPARATE_HEADER
  45468. nFree += sqlite3MemSize(p);
  45469. #endif
  45470. assert( PAGE_IS_UNPINNED(p) );
  45471. pcache1PinPage(p);
  45472. pcache1RemoveFromHash(p, 1);
  45473. }
  45474. pcache1LeaveMutex(&pcache1.grp);
  45475. }
  45476. return nFree;
  45477. }
  45478. #endif /* SQLITE_ENABLE_MEMORY_MANAGEMENT */
  45479. #ifdef SQLITE_TEST
  45480. /*
  45481. ** This function is used by test procedures to inspect the internal state
  45482. ** of the global cache.
  45483. */
  45484. SQLITE_PRIVATE void sqlite3PcacheStats(
  45485. int *pnCurrent, /* OUT: Total number of pages cached */
  45486. int *pnMax, /* OUT: Global maximum cache size */
  45487. int *pnMin, /* OUT: Sum of PCache1.nMin for purgeable caches */
  45488. int *pnRecyclable /* OUT: Total number of pages available for recycling */
  45489. ){
  45490. PgHdr1 *p;
  45491. int nRecyclable = 0;
  45492. for(p=pcache1.grp.lru.pLruNext; p && !p->isAnchor; p=p->pLruNext){
  45493. assert( PAGE_IS_UNPINNED(p) );
  45494. nRecyclable++;
  45495. }
  45496. *pnCurrent = pcache1.grp.nPurgeable;
  45497. *pnMax = (int)pcache1.grp.nMaxPage;
  45498. *pnMin = (int)pcache1.grp.nMinPage;
  45499. *pnRecyclable = nRecyclable;
  45500. }
  45501. #endif
  45502. /************** End of pcache1.c *********************************************/
  45503. /************** Begin file rowset.c ******************************************/
  45504. /*
  45505. ** 2008 December 3
  45506. **
  45507. ** The author disclaims copyright to this source code. In place of
  45508. ** a legal notice, here is a blessing:
  45509. **
  45510. ** May you do good and not evil.
  45511. ** May you find forgiveness for yourself and forgive others.
  45512. ** May you share freely, never taking more than you give.
  45513. **
  45514. *************************************************************************
  45515. **
  45516. ** This module implements an object we call a "RowSet".
  45517. **
  45518. ** The RowSet object is a collection of rowids. Rowids
  45519. ** are inserted into the RowSet in an arbitrary order. Inserts
  45520. ** can be intermixed with tests to see if a given rowid has been
  45521. ** previously inserted into the RowSet.
  45522. **
  45523. ** After all inserts are finished, it is possible to extract the
  45524. ** elements of the RowSet in sorted order. Once this extraction
  45525. ** process has started, no new elements may be inserted.
  45526. **
  45527. ** Hence, the primitive operations for a RowSet are:
  45528. **
  45529. ** CREATE
  45530. ** INSERT
  45531. ** TEST
  45532. ** SMALLEST
  45533. ** DESTROY
  45534. **
  45535. ** The CREATE and DESTROY primitives are the constructor and destructor,
  45536. ** obviously. The INSERT primitive adds a new element to the RowSet.
  45537. ** TEST checks to see if an element is already in the RowSet. SMALLEST
  45538. ** extracts the least value from the RowSet.
  45539. **
  45540. ** The INSERT primitive might allocate additional memory. Memory is
  45541. ** allocated in chunks so most INSERTs do no allocation. There is an
  45542. ** upper bound on the size of allocated memory. No memory is freed
  45543. ** until DESTROY.
  45544. **
  45545. ** The TEST primitive includes a "batch" number. The TEST primitive
  45546. ** will only see elements that were inserted before the last change
  45547. ** in the batch number. In other words, if an INSERT occurs between
  45548. ** two TESTs where the TESTs have the same batch nubmer, then the
  45549. ** value added by the INSERT will not be visible to the second TEST.
  45550. ** The initial batch number is zero, so if the very first TEST contains
  45551. ** a non-zero batch number, it will see all prior INSERTs.
  45552. **
  45553. ** No INSERTs may occurs after a SMALLEST. An assertion will fail if
  45554. ** that is attempted.
  45555. **
  45556. ** The cost of an INSERT is roughly constant. (Sometimes new memory
  45557. ** has to be allocated on an INSERT.) The cost of a TEST with a new
  45558. ** batch number is O(NlogN) where N is the number of elements in the RowSet.
  45559. ** The cost of a TEST using the same batch number is O(logN). The cost
  45560. ** of the first SMALLEST is O(NlogN). Second and subsequent SMALLEST
  45561. ** primitives are constant time. The cost of DESTROY is O(N).
  45562. **
  45563. ** TEST and SMALLEST may not be used by the same RowSet. This used to
  45564. ** be possible, but the feature was not used, so it was removed in order
  45565. ** to simplify the code.
  45566. */
  45567. /* #include "sqliteInt.h" */
  45568. /*
  45569. ** Target size for allocation chunks.
  45570. */
  45571. #define ROWSET_ALLOCATION_SIZE 1024
  45572. /*
  45573. ** The number of rowset entries per allocation chunk.
  45574. */
  45575. #define ROWSET_ENTRY_PER_CHUNK \
  45576. ((ROWSET_ALLOCATION_SIZE-8)/sizeof(struct RowSetEntry))
  45577. /*
  45578. ** Each entry in a RowSet is an instance of the following object.
  45579. **
  45580. ** This same object is reused to store a linked list of trees of RowSetEntry
  45581. ** objects. In that alternative use, pRight points to the next entry
  45582. ** in the list, pLeft points to the tree, and v is unused. The
  45583. ** RowSet.pForest value points to the head of this forest list.
  45584. */
  45585. struct RowSetEntry {
  45586. i64 v; /* ROWID value for this entry */
  45587. struct RowSetEntry *pRight; /* Right subtree (larger entries) or list */
  45588. struct RowSetEntry *pLeft; /* Left subtree (smaller entries) */
  45589. };
  45590. /*
  45591. ** RowSetEntry objects are allocated in large chunks (instances of the
  45592. ** following structure) to reduce memory allocation overhead. The
  45593. ** chunks are kept on a linked list so that they can be deallocated
  45594. ** when the RowSet is destroyed.
  45595. */
  45596. struct RowSetChunk {
  45597. struct RowSetChunk *pNextChunk; /* Next chunk on list of them all */
  45598. struct RowSetEntry aEntry[ROWSET_ENTRY_PER_CHUNK]; /* Allocated entries */
  45599. };
  45600. /*
  45601. ** A RowSet in an instance of the following structure.
  45602. **
  45603. ** A typedef of this structure if found in sqliteInt.h.
  45604. */
  45605. struct RowSet {
  45606. struct RowSetChunk *pChunk; /* List of all chunk allocations */
  45607. sqlite3 *db; /* The database connection */
  45608. struct RowSetEntry *pEntry; /* List of entries using pRight */
  45609. struct RowSetEntry *pLast; /* Last entry on the pEntry list */
  45610. struct RowSetEntry *pFresh; /* Source of new entry objects */
  45611. struct RowSetEntry *pForest; /* List of binary trees of entries */
  45612. u16 nFresh; /* Number of objects on pFresh */
  45613. u16 rsFlags; /* Various flags */
  45614. int iBatch; /* Current insert batch */
  45615. };
  45616. /*
  45617. ** Allowed values for RowSet.rsFlags
  45618. */
  45619. #define ROWSET_SORTED 0x01 /* True if RowSet.pEntry is sorted */
  45620. #define ROWSET_NEXT 0x02 /* True if sqlite3RowSetNext() has been called */
  45621. /*
  45622. ** Turn bulk memory into a RowSet object. N bytes of memory
  45623. ** are available at pSpace. The db pointer is used as a memory context
  45624. ** for any subsequent allocations that need to occur.
  45625. ** Return a pointer to the new RowSet object.
  45626. **
  45627. ** It must be the case that N is sufficient to make a Rowset. If not
  45628. ** an assertion fault occurs.
  45629. **
  45630. ** If N is larger than the minimum, use the surplus as an initial
  45631. ** allocation of entries available to be filled.
  45632. */
  45633. SQLITE_PRIVATE RowSet *sqlite3RowSetInit(sqlite3 *db, void *pSpace, unsigned int N){
  45634. RowSet *p;
  45635. assert( N >= ROUND8(sizeof(*p)) );
  45636. p = pSpace;
  45637. p->pChunk = 0;
  45638. p->db = db;
  45639. p->pEntry = 0;
  45640. p->pLast = 0;
  45641. p->pForest = 0;
  45642. p->pFresh = (struct RowSetEntry*)(ROUND8(sizeof(*p)) + (char*)p);
  45643. p->nFresh = (u16)((N - ROUND8(sizeof(*p)))/sizeof(struct RowSetEntry));
  45644. p->rsFlags = ROWSET_SORTED;
  45645. p->iBatch = 0;
  45646. return p;
  45647. }
  45648. /*
  45649. ** Deallocate all chunks from a RowSet. This frees all memory that
  45650. ** the RowSet has allocated over its lifetime. This routine is
  45651. ** the destructor for the RowSet.
  45652. */
  45653. SQLITE_PRIVATE void sqlite3RowSetClear(RowSet *p){
  45654. struct RowSetChunk *pChunk, *pNextChunk;
  45655. for(pChunk=p->pChunk; pChunk; pChunk = pNextChunk){
  45656. pNextChunk = pChunk->pNextChunk;
  45657. sqlite3DbFree(p->db, pChunk);
  45658. }
  45659. p->pChunk = 0;
  45660. p->nFresh = 0;
  45661. p->pEntry = 0;
  45662. p->pLast = 0;
  45663. p->pForest = 0;
  45664. p->rsFlags = ROWSET_SORTED;
  45665. }
  45666. /*
  45667. ** Allocate a new RowSetEntry object that is associated with the
  45668. ** given RowSet. Return a pointer to the new and completely uninitialized
  45669. ** objected.
  45670. **
  45671. ** In an OOM situation, the RowSet.db->mallocFailed flag is set and this
  45672. ** routine returns NULL.
  45673. */
  45674. static struct RowSetEntry *rowSetEntryAlloc(RowSet *p){
  45675. assert( p!=0 );
  45676. if( p->nFresh==0 ){ /*OPTIMIZATION-IF-FALSE*/
  45677. /* We could allocate a fresh RowSetEntry each time one is needed, but it
  45678. ** is more efficient to pull a preallocated entry from the pool */
  45679. struct RowSetChunk *pNew;
  45680. pNew = sqlite3DbMallocRawNN(p->db, sizeof(*pNew));
  45681. if( pNew==0 ){
  45682. return 0;
  45683. }
  45684. pNew->pNextChunk = p->pChunk;
  45685. p->pChunk = pNew;
  45686. p->pFresh = pNew->aEntry;
  45687. p->nFresh = ROWSET_ENTRY_PER_CHUNK;
  45688. }
  45689. p->nFresh--;
  45690. return p->pFresh++;
  45691. }
  45692. /*
  45693. ** Insert a new value into a RowSet.
  45694. **
  45695. ** The mallocFailed flag of the database connection is set if a
  45696. ** memory allocation fails.
  45697. */
  45698. SQLITE_PRIVATE void sqlite3RowSetInsert(RowSet *p, i64 rowid){
  45699. struct RowSetEntry *pEntry; /* The new entry */
  45700. struct RowSetEntry *pLast; /* The last prior entry */
  45701. /* This routine is never called after sqlite3RowSetNext() */
  45702. assert( p!=0 && (p->rsFlags & ROWSET_NEXT)==0 );
  45703. pEntry = rowSetEntryAlloc(p);
  45704. if( pEntry==0 ) return;
  45705. pEntry->v = rowid;
  45706. pEntry->pRight = 0;
  45707. pLast = p->pLast;
  45708. if( pLast ){
  45709. if( rowid<=pLast->v ){ /*OPTIMIZATION-IF-FALSE*/
  45710. /* Avoid unnecessary sorts by preserving the ROWSET_SORTED flags
  45711. ** where possible */
  45712. p->rsFlags &= ~ROWSET_SORTED;
  45713. }
  45714. pLast->pRight = pEntry;
  45715. }else{
  45716. p->pEntry = pEntry;
  45717. }
  45718. p->pLast = pEntry;
  45719. }
  45720. /*
  45721. ** Merge two lists of RowSetEntry objects. Remove duplicates.
  45722. **
  45723. ** The input lists are connected via pRight pointers and are
  45724. ** assumed to each already be in sorted order.
  45725. */
  45726. static struct RowSetEntry *rowSetEntryMerge(
  45727. struct RowSetEntry *pA, /* First sorted list to be merged */
  45728. struct RowSetEntry *pB /* Second sorted list to be merged */
  45729. ){
  45730. struct RowSetEntry head;
  45731. struct RowSetEntry *pTail;
  45732. pTail = &head;
  45733. assert( pA!=0 && pB!=0 );
  45734. for(;;){
  45735. assert( pA->pRight==0 || pA->v<=pA->pRight->v );
  45736. assert( pB->pRight==0 || pB->v<=pB->pRight->v );
  45737. if( pA->v<=pB->v ){
  45738. if( pA->v<pB->v ) pTail = pTail->pRight = pA;
  45739. pA = pA->pRight;
  45740. if( pA==0 ){
  45741. pTail->pRight = pB;
  45742. break;
  45743. }
  45744. }else{
  45745. pTail = pTail->pRight = pB;
  45746. pB = pB->pRight;
  45747. if( pB==0 ){
  45748. pTail->pRight = pA;
  45749. break;
  45750. }
  45751. }
  45752. }
  45753. return head.pRight;
  45754. }
  45755. /*
  45756. ** Sort all elements on the list of RowSetEntry objects into order of
  45757. ** increasing v.
  45758. */
  45759. static struct RowSetEntry *rowSetEntrySort(struct RowSetEntry *pIn){
  45760. unsigned int i;
  45761. struct RowSetEntry *pNext, *aBucket[40];
  45762. memset(aBucket, 0, sizeof(aBucket));
  45763. while( pIn ){
  45764. pNext = pIn->pRight;
  45765. pIn->pRight = 0;
  45766. for(i=0; aBucket[i]; i++){
  45767. pIn = rowSetEntryMerge(aBucket[i], pIn);
  45768. aBucket[i] = 0;
  45769. }
  45770. aBucket[i] = pIn;
  45771. pIn = pNext;
  45772. }
  45773. pIn = aBucket[0];
  45774. for(i=1; i<sizeof(aBucket)/sizeof(aBucket[0]); i++){
  45775. if( aBucket[i]==0 ) continue;
  45776. pIn = pIn ? rowSetEntryMerge(pIn, aBucket[i]) : aBucket[i];
  45777. }
  45778. return pIn;
  45779. }
  45780. /*
  45781. ** The input, pIn, is a binary tree (or subtree) of RowSetEntry objects.
  45782. ** Convert this tree into a linked list connected by the pRight pointers
  45783. ** and return pointers to the first and last elements of the new list.
  45784. */
  45785. static void rowSetTreeToList(
  45786. struct RowSetEntry *pIn, /* Root of the input tree */
  45787. struct RowSetEntry **ppFirst, /* Write head of the output list here */
  45788. struct RowSetEntry **ppLast /* Write tail of the output list here */
  45789. ){
  45790. assert( pIn!=0 );
  45791. if( pIn->pLeft ){
  45792. struct RowSetEntry *p;
  45793. rowSetTreeToList(pIn->pLeft, ppFirst, &p);
  45794. p->pRight = pIn;
  45795. }else{
  45796. *ppFirst = pIn;
  45797. }
  45798. if( pIn->pRight ){
  45799. rowSetTreeToList(pIn->pRight, &pIn->pRight, ppLast);
  45800. }else{
  45801. *ppLast = pIn;
  45802. }
  45803. assert( (*ppLast)->pRight==0 );
  45804. }
  45805. /*
  45806. ** Convert a sorted list of elements (connected by pRight) into a binary
  45807. ** tree with depth of iDepth. A depth of 1 means the tree contains a single
  45808. ** node taken from the head of *ppList. A depth of 2 means a tree with
  45809. ** three nodes. And so forth.
  45810. **
  45811. ** Use as many entries from the input list as required and update the
  45812. ** *ppList to point to the unused elements of the list. If the input
  45813. ** list contains too few elements, then construct an incomplete tree
  45814. ** and leave *ppList set to NULL.
  45815. **
  45816. ** Return a pointer to the root of the constructed binary tree.
  45817. */
  45818. static struct RowSetEntry *rowSetNDeepTree(
  45819. struct RowSetEntry **ppList,
  45820. int iDepth
  45821. ){
  45822. struct RowSetEntry *p; /* Root of the new tree */
  45823. struct RowSetEntry *pLeft; /* Left subtree */
  45824. if( *ppList==0 ){ /*OPTIMIZATION-IF-TRUE*/
  45825. /* Prevent unnecessary deep recursion when we run out of entries */
  45826. return 0;
  45827. }
  45828. if( iDepth>1 ){ /*OPTIMIZATION-IF-TRUE*/
  45829. /* This branch causes a *balanced* tree to be generated. A valid tree
  45830. ** is still generated without this branch, but the tree is wildly
  45831. ** unbalanced and inefficient. */
  45832. pLeft = rowSetNDeepTree(ppList, iDepth-1);
  45833. p = *ppList;
  45834. if( p==0 ){ /*OPTIMIZATION-IF-FALSE*/
  45835. /* It is safe to always return here, but the resulting tree
  45836. ** would be unbalanced */
  45837. return pLeft;
  45838. }
  45839. p->pLeft = pLeft;
  45840. *ppList = p->pRight;
  45841. p->pRight = rowSetNDeepTree(ppList, iDepth-1);
  45842. }else{
  45843. p = *ppList;
  45844. *ppList = p->pRight;
  45845. p->pLeft = p->pRight = 0;
  45846. }
  45847. return p;
  45848. }
  45849. /*
  45850. ** Convert a sorted list of elements into a binary tree. Make the tree
  45851. ** as deep as it needs to be in order to contain the entire list.
  45852. */
  45853. static struct RowSetEntry *rowSetListToTree(struct RowSetEntry *pList){
  45854. int iDepth; /* Depth of the tree so far */
  45855. struct RowSetEntry *p; /* Current tree root */
  45856. struct RowSetEntry *pLeft; /* Left subtree */
  45857. assert( pList!=0 );
  45858. p = pList;
  45859. pList = p->pRight;
  45860. p->pLeft = p->pRight = 0;
  45861. for(iDepth=1; pList; iDepth++){
  45862. pLeft = p;
  45863. p = pList;
  45864. pList = p->pRight;
  45865. p->pLeft = pLeft;
  45866. p->pRight = rowSetNDeepTree(&pList, iDepth);
  45867. }
  45868. return p;
  45869. }
  45870. /*
  45871. ** Extract the smallest element from the RowSet.
  45872. ** Write the element into *pRowid. Return 1 on success. Return
  45873. ** 0 if the RowSet is already empty.
  45874. **
  45875. ** After this routine has been called, the sqlite3RowSetInsert()
  45876. ** routine may not be called again.
  45877. **
  45878. ** This routine may not be called after sqlite3RowSetTest() has
  45879. ** been used. Older versions of RowSet allowed that, but as the
  45880. ** capability was not used by the code generator, it was removed
  45881. ** for code economy.
  45882. */
  45883. SQLITE_PRIVATE int sqlite3RowSetNext(RowSet *p, i64 *pRowid){
  45884. assert( p!=0 );
  45885. assert( p->pForest==0 ); /* Cannot be used with sqlite3RowSetText() */
  45886. /* Merge the forest into a single sorted list on first call */
  45887. if( (p->rsFlags & ROWSET_NEXT)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  45888. if( (p->rsFlags & ROWSET_SORTED)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  45889. p->pEntry = rowSetEntrySort(p->pEntry);
  45890. }
  45891. p->rsFlags |= ROWSET_SORTED|ROWSET_NEXT;
  45892. }
  45893. /* Return the next entry on the list */
  45894. if( p->pEntry ){
  45895. *pRowid = p->pEntry->v;
  45896. p->pEntry = p->pEntry->pRight;
  45897. if( p->pEntry==0 ){ /*OPTIMIZATION-IF-TRUE*/
  45898. /* Free memory immediately, rather than waiting on sqlite3_finalize() */
  45899. sqlite3RowSetClear(p);
  45900. }
  45901. return 1;
  45902. }else{
  45903. return 0;
  45904. }
  45905. }
  45906. /*
  45907. ** Check to see if element iRowid was inserted into the rowset as
  45908. ** part of any insert batch prior to iBatch. Return 1 or 0.
  45909. **
  45910. ** If this is the first test of a new batch and if there exist entries
  45911. ** on pRowSet->pEntry, then sort those entries into the forest at
  45912. ** pRowSet->pForest so that they can be tested.
  45913. */
  45914. SQLITE_PRIVATE int sqlite3RowSetTest(RowSet *pRowSet, int iBatch, sqlite3_int64 iRowid){
  45915. struct RowSetEntry *p, *pTree;
  45916. /* This routine is never called after sqlite3RowSetNext() */
  45917. assert( pRowSet!=0 && (pRowSet->rsFlags & ROWSET_NEXT)==0 );
  45918. /* Sort entries into the forest on the first test of a new batch.
  45919. ** To save unnecessary work, only do this when the batch number changes.
  45920. */
  45921. if( iBatch!=pRowSet->iBatch ){ /*OPTIMIZATION-IF-FALSE*/
  45922. p = pRowSet->pEntry;
  45923. if( p ){
  45924. struct RowSetEntry **ppPrevTree = &pRowSet->pForest;
  45925. if( (pRowSet->rsFlags & ROWSET_SORTED)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  45926. /* Only sort the current set of entiries if they need it */
  45927. p = rowSetEntrySort(p);
  45928. }
  45929. for(pTree = pRowSet->pForest; pTree; pTree=pTree->pRight){
  45930. ppPrevTree = &pTree->pRight;
  45931. if( pTree->pLeft==0 ){
  45932. pTree->pLeft = rowSetListToTree(p);
  45933. break;
  45934. }else{
  45935. struct RowSetEntry *pAux, *pTail;
  45936. rowSetTreeToList(pTree->pLeft, &pAux, &pTail);
  45937. pTree->pLeft = 0;
  45938. p = rowSetEntryMerge(pAux, p);
  45939. }
  45940. }
  45941. if( pTree==0 ){
  45942. *ppPrevTree = pTree = rowSetEntryAlloc(pRowSet);
  45943. if( pTree ){
  45944. pTree->v = 0;
  45945. pTree->pRight = 0;
  45946. pTree->pLeft = rowSetListToTree(p);
  45947. }
  45948. }
  45949. pRowSet->pEntry = 0;
  45950. pRowSet->pLast = 0;
  45951. pRowSet->rsFlags |= ROWSET_SORTED;
  45952. }
  45953. pRowSet->iBatch = iBatch;
  45954. }
  45955. /* Test to see if the iRowid value appears anywhere in the forest.
  45956. ** Return 1 if it does and 0 if not.
  45957. */
  45958. for(pTree = pRowSet->pForest; pTree; pTree=pTree->pRight){
  45959. p = pTree->pLeft;
  45960. while( p ){
  45961. if( p->v<iRowid ){
  45962. p = p->pRight;
  45963. }else if( p->v>iRowid ){
  45964. p = p->pLeft;
  45965. }else{
  45966. return 1;
  45967. }
  45968. }
  45969. }
  45970. return 0;
  45971. }
  45972. /************** End of rowset.c **********************************************/
  45973. /************** Begin file pager.c *******************************************/
  45974. /*
  45975. ** 2001 September 15
  45976. **
  45977. ** The author disclaims copyright to this source code. In place of
  45978. ** a legal notice, here is a blessing:
  45979. **
  45980. ** May you do good and not evil.
  45981. ** May you find forgiveness for yourself and forgive others.
  45982. ** May you share freely, never taking more than you give.
  45983. **
  45984. *************************************************************************
  45985. ** This is the implementation of the page cache subsystem or "pager".
  45986. **
  45987. ** The pager is used to access a database disk file. It implements
  45988. ** atomic commit and rollback through the use of a journal file that
  45989. ** is separate from the database file. The pager also implements file
  45990. ** locking to prevent two processes from writing the same database
  45991. ** file simultaneously, or one process from reading the database while
  45992. ** another is writing.
  45993. */
  45994. #ifndef SQLITE_OMIT_DISKIO
  45995. /* #include "sqliteInt.h" */
  45996. /************** Include wal.h in the middle of pager.c ***********************/
  45997. /************** Begin file wal.h *********************************************/
  45998. /*
  45999. ** 2010 February 1
  46000. **
  46001. ** The author disclaims copyright to this source code. In place of
  46002. ** a legal notice, here is a blessing:
  46003. **
  46004. ** May you do good and not evil.
  46005. ** May you find forgiveness for yourself and forgive others.
  46006. ** May you share freely, never taking more than you give.
  46007. **
  46008. *************************************************************************
  46009. ** This header file defines the interface to the write-ahead logging
  46010. ** system. Refer to the comments below and the header comment attached to
  46011. ** the implementation of each function in log.c for further details.
  46012. */
  46013. #ifndef SQLITE_WAL_H
  46014. #define SQLITE_WAL_H
  46015. /* #include "sqliteInt.h" */
  46016. /* Macros for extracting appropriate sync flags for either transaction
  46017. ** commits (WAL_SYNC_FLAGS(X)) or for checkpoint ops (CKPT_SYNC_FLAGS(X)):
  46018. */
  46019. #define WAL_SYNC_FLAGS(X) ((X)&0x03)
  46020. #define CKPT_SYNC_FLAGS(X) (((X)>>2)&0x03)
  46021. #ifdef SQLITE_OMIT_WAL
  46022. # define sqlite3WalOpen(x,y,z) 0
  46023. # define sqlite3WalLimit(x,y)
  46024. # define sqlite3WalClose(v,w,x,y,z) 0
  46025. # define sqlite3WalBeginReadTransaction(y,z) 0
  46026. # define sqlite3WalEndReadTransaction(z)
  46027. # define sqlite3WalDbsize(y) 0
  46028. # define sqlite3WalBeginWriteTransaction(y) 0
  46029. # define sqlite3WalEndWriteTransaction(x) 0
  46030. # define sqlite3WalUndo(x,y,z) 0
  46031. # define sqlite3WalSavepoint(y,z)
  46032. # define sqlite3WalSavepointUndo(y,z) 0
  46033. # define sqlite3WalFrames(u,v,w,x,y,z) 0
  46034. # define sqlite3WalCheckpoint(q,r,s,t,u,v,w,x,y,z) 0
  46035. # define sqlite3WalCallback(z) 0
  46036. # define sqlite3WalExclusiveMode(y,z) 0
  46037. # define sqlite3WalHeapMemory(z) 0
  46038. # define sqlite3WalFramesize(z) 0
  46039. # define sqlite3WalFindFrame(x,y,z) 0
  46040. # define sqlite3WalFile(x) 0
  46041. #else
  46042. #define WAL_SAVEPOINT_NDATA 4
  46043. /* Connection to a write-ahead log (WAL) file.
  46044. ** There is one object of this type for each pager.
  46045. */
  46046. typedef struct Wal Wal;
  46047. /* Open and close a connection to a write-ahead log. */
  46048. SQLITE_PRIVATE int sqlite3WalOpen(sqlite3_vfs*, sqlite3_file*, const char *, int, i64, Wal**);
  46049. SQLITE_PRIVATE int sqlite3WalClose(Wal *pWal, sqlite3*, int sync_flags, int, u8 *);
  46050. /* Set the limiting size of a WAL file. */
  46051. SQLITE_PRIVATE void sqlite3WalLimit(Wal*, i64);
  46052. /* Used by readers to open (lock) and close (unlock) a snapshot. A
  46053. ** snapshot is like a read-transaction. It is the state of the database
  46054. ** at an instant in time. sqlite3WalOpenSnapshot gets a read lock and
  46055. ** preserves the current state even if the other threads or processes
  46056. ** write to or checkpoint the WAL. sqlite3WalCloseSnapshot() closes the
  46057. ** transaction and releases the lock.
  46058. */
  46059. SQLITE_PRIVATE int sqlite3WalBeginReadTransaction(Wal *pWal, int *);
  46060. SQLITE_PRIVATE void sqlite3WalEndReadTransaction(Wal *pWal);
  46061. /* Read a page from the write-ahead log, if it is present. */
  46062. SQLITE_PRIVATE int sqlite3WalFindFrame(Wal *, Pgno, u32 *);
  46063. SQLITE_PRIVATE int sqlite3WalReadFrame(Wal *, u32, int, u8 *);
  46064. /* If the WAL is not empty, return the size of the database. */
  46065. SQLITE_PRIVATE Pgno sqlite3WalDbsize(Wal *pWal);
  46066. /* Obtain or release the WRITER lock. */
  46067. SQLITE_PRIVATE int sqlite3WalBeginWriteTransaction(Wal *pWal);
  46068. SQLITE_PRIVATE int sqlite3WalEndWriteTransaction(Wal *pWal);
  46069. /* Undo any frames written (but not committed) to the log */
  46070. SQLITE_PRIVATE int sqlite3WalUndo(Wal *pWal, int (*xUndo)(void *, Pgno), void *pUndoCtx);
  46071. /* Return an integer that records the current (uncommitted) write
  46072. ** position in the WAL */
  46073. SQLITE_PRIVATE void sqlite3WalSavepoint(Wal *pWal, u32 *aWalData);
  46074. /* Move the write position of the WAL back to iFrame. Called in
  46075. ** response to a ROLLBACK TO command. */
  46076. SQLITE_PRIVATE int sqlite3WalSavepointUndo(Wal *pWal, u32 *aWalData);
  46077. /* Write a frame or frames to the log. */
  46078. SQLITE_PRIVATE int sqlite3WalFrames(Wal *pWal, int, PgHdr *, Pgno, int, int);
  46079. /* Copy pages from the log to the database file */
  46080. SQLITE_PRIVATE int sqlite3WalCheckpoint(
  46081. Wal *pWal, /* Write-ahead log connection */
  46082. sqlite3 *db, /* Check this handle's interrupt flag */
  46083. int eMode, /* One of PASSIVE, FULL and RESTART */
  46084. int (*xBusy)(void*), /* Function to call when busy */
  46085. void *pBusyArg, /* Context argument for xBusyHandler */
  46086. int sync_flags, /* Flags to sync db file with (or 0) */
  46087. int nBuf, /* Size of buffer nBuf */
  46088. u8 *zBuf, /* Temporary buffer to use */
  46089. int *pnLog, /* OUT: Number of frames in WAL */
  46090. int *pnCkpt /* OUT: Number of backfilled frames in WAL */
  46091. );
  46092. /* Return the value to pass to a sqlite3_wal_hook callback, the
  46093. ** number of frames in the WAL at the point of the last commit since
  46094. ** sqlite3WalCallback() was called. If no commits have occurred since
  46095. ** the last call, then return 0.
  46096. */
  46097. SQLITE_PRIVATE int sqlite3WalCallback(Wal *pWal);
  46098. /* Tell the wal layer that an EXCLUSIVE lock has been obtained (or released)
  46099. ** by the pager layer on the database file.
  46100. */
  46101. SQLITE_PRIVATE int sqlite3WalExclusiveMode(Wal *pWal, int op);
  46102. /* Return true if the argument is non-NULL and the WAL module is using
  46103. ** heap-memory for the wal-index. Otherwise, if the argument is NULL or the
  46104. ** WAL module is using shared-memory, return false.
  46105. */
  46106. SQLITE_PRIVATE int sqlite3WalHeapMemory(Wal *pWal);
  46107. #ifdef SQLITE_ENABLE_SNAPSHOT
  46108. SQLITE_PRIVATE int sqlite3WalSnapshotGet(Wal *pWal, sqlite3_snapshot **ppSnapshot);
  46109. SQLITE_PRIVATE void sqlite3WalSnapshotOpen(Wal *pWal, sqlite3_snapshot *pSnapshot);
  46110. SQLITE_PRIVATE int sqlite3WalSnapshotRecover(Wal *pWal);
  46111. #endif
  46112. #ifdef SQLITE_ENABLE_ZIPVFS
  46113. /* If the WAL file is not empty, return the number of bytes of content
  46114. ** stored in each frame (i.e. the db page-size when the WAL was created).
  46115. */
  46116. SQLITE_PRIVATE int sqlite3WalFramesize(Wal *pWal);
  46117. #endif
  46118. /* Return the sqlite3_file object for the WAL file */
  46119. SQLITE_PRIVATE sqlite3_file *sqlite3WalFile(Wal *pWal);
  46120. #endif /* ifndef SQLITE_OMIT_WAL */
  46121. #endif /* SQLITE_WAL_H */
  46122. /************** End of wal.h *************************************************/
  46123. /************** Continuing where we left off in pager.c **********************/
  46124. /******************* NOTES ON THE DESIGN OF THE PAGER ************************
  46125. **
  46126. ** This comment block describes invariants that hold when using a rollback
  46127. ** journal. These invariants do not apply for journal_mode=WAL,
  46128. ** journal_mode=MEMORY, or journal_mode=OFF.
  46129. **
  46130. ** Within this comment block, a page is deemed to have been synced
  46131. ** automatically as soon as it is written when PRAGMA synchronous=OFF.
  46132. ** Otherwise, the page is not synced until the xSync method of the VFS
  46133. ** is called successfully on the file containing the page.
  46134. **
  46135. ** Definition: A page of the database file is said to be "overwriteable" if
  46136. ** one or more of the following are true about the page:
  46137. **
  46138. ** (a) The original content of the page as it was at the beginning of
  46139. ** the transaction has been written into the rollback journal and
  46140. ** synced.
  46141. **
  46142. ** (b) The page was a freelist leaf page at the start of the transaction.
  46143. **
  46144. ** (c) The page number is greater than the largest page that existed in
  46145. ** the database file at the start of the transaction.
  46146. **
  46147. ** (1) A page of the database file is never overwritten unless one of the
  46148. ** following are true:
  46149. **
  46150. ** (a) The page and all other pages on the same sector are overwriteable.
  46151. **
  46152. ** (b) The atomic page write optimization is enabled, and the entire
  46153. ** transaction other than the update of the transaction sequence
  46154. ** number consists of a single page change.
  46155. **
  46156. ** (2) The content of a page written into the rollback journal exactly matches
  46157. ** both the content in the database when the rollback journal was written
  46158. ** and the content in the database at the beginning of the current
  46159. ** transaction.
  46160. **
  46161. ** (3) Writes to the database file are an integer multiple of the page size
  46162. ** in length and are aligned on a page boundary.
  46163. **
  46164. ** (4) Reads from the database file are either aligned on a page boundary and
  46165. ** an integer multiple of the page size in length or are taken from the
  46166. ** first 100 bytes of the database file.
  46167. **
  46168. ** (5) All writes to the database file are synced prior to the rollback journal
  46169. ** being deleted, truncated, or zeroed.
  46170. **
  46171. ** (6) If a master journal file is used, then all writes to the database file
  46172. ** are synced prior to the master journal being deleted.
  46173. **
  46174. ** Definition: Two databases (or the same database at two points it time)
  46175. ** are said to be "logically equivalent" if they give the same answer to
  46176. ** all queries. Note in particular the content of freelist leaf
  46177. ** pages can be changed arbitrarily without affecting the logical equivalence
  46178. ** of the database.
  46179. **
  46180. ** (7) At any time, if any subset, including the empty set and the total set,
  46181. ** of the unsynced changes to a rollback journal are removed and the
  46182. ** journal is rolled back, the resulting database file will be logically
  46183. ** equivalent to the database file at the beginning of the transaction.
  46184. **
  46185. ** (8) When a transaction is rolled back, the xTruncate method of the VFS
  46186. ** is called to restore the database file to the same size it was at
  46187. ** the beginning of the transaction. (In some VFSes, the xTruncate
  46188. ** method is a no-op, but that does not change the fact the SQLite will
  46189. ** invoke it.)
  46190. **
  46191. ** (9) Whenever the database file is modified, at least one bit in the range
  46192. ** of bytes from 24 through 39 inclusive will be changed prior to releasing
  46193. ** the EXCLUSIVE lock, thus signaling other connections on the same
  46194. ** database to flush their caches.
  46195. **
  46196. ** (10) The pattern of bits in bytes 24 through 39 shall not repeat in less
  46197. ** than one billion transactions.
  46198. **
  46199. ** (11) A database file is well-formed at the beginning and at the conclusion
  46200. ** of every transaction.
  46201. **
  46202. ** (12) An EXCLUSIVE lock is held on the database file when writing to
  46203. ** the database file.
  46204. **
  46205. ** (13) A SHARED lock is held on the database file while reading any
  46206. ** content out of the database file.
  46207. **
  46208. ******************************************************************************/
  46209. /*
  46210. ** Macros for troubleshooting. Normally turned off
  46211. */
  46212. #if 0
  46213. int sqlite3PagerTrace=1; /* True to enable tracing */
  46214. #define sqlite3DebugPrintf printf
  46215. #define PAGERTRACE(X) if( sqlite3PagerTrace ){ sqlite3DebugPrintf X; }
  46216. #else
  46217. #define PAGERTRACE(X)
  46218. #endif
  46219. /*
  46220. ** The following two macros are used within the PAGERTRACE() macros above
  46221. ** to print out file-descriptors.
  46222. **
  46223. ** PAGERID() takes a pointer to a Pager struct as its argument. The
  46224. ** associated file-descriptor is returned. FILEHANDLEID() takes an sqlite3_file
  46225. ** struct as its argument.
  46226. */
  46227. #define PAGERID(p) (SQLITE_PTR_TO_INT(p->fd))
  46228. #define FILEHANDLEID(fd) (SQLITE_PTR_TO_INT(fd))
  46229. /*
  46230. ** The Pager.eState variable stores the current 'state' of a pager. A
  46231. ** pager may be in any one of the seven states shown in the following
  46232. ** state diagram.
  46233. **
  46234. ** OPEN <------+------+
  46235. ** | | |
  46236. ** V | |
  46237. ** +---------> READER-------+ |
  46238. ** | | |
  46239. ** | V |
  46240. ** |<-------WRITER_LOCKED------> ERROR
  46241. ** | | ^
  46242. ** | V |
  46243. ** |<------WRITER_CACHEMOD-------->|
  46244. ** | | |
  46245. ** | V |
  46246. ** |<-------WRITER_DBMOD---------->|
  46247. ** | | |
  46248. ** | V |
  46249. ** +<------WRITER_FINISHED-------->+
  46250. **
  46251. **
  46252. ** List of state transitions and the C [function] that performs each:
  46253. **
  46254. ** OPEN -> READER [sqlite3PagerSharedLock]
  46255. ** READER -> OPEN [pager_unlock]
  46256. **
  46257. ** READER -> WRITER_LOCKED [sqlite3PagerBegin]
  46258. ** WRITER_LOCKED -> WRITER_CACHEMOD [pager_open_journal]
  46259. ** WRITER_CACHEMOD -> WRITER_DBMOD [syncJournal]
  46260. ** WRITER_DBMOD -> WRITER_FINISHED [sqlite3PagerCommitPhaseOne]
  46261. ** WRITER_*** -> READER [pager_end_transaction]
  46262. **
  46263. ** WRITER_*** -> ERROR [pager_error]
  46264. ** ERROR -> OPEN [pager_unlock]
  46265. **
  46266. **
  46267. ** OPEN:
  46268. **
  46269. ** The pager starts up in this state. Nothing is guaranteed in this
  46270. ** state - the file may or may not be locked and the database size is
  46271. ** unknown. The database may not be read or written.
  46272. **
  46273. ** * No read or write transaction is active.
  46274. ** * Any lock, or no lock at all, may be held on the database file.
  46275. ** * The dbSize, dbOrigSize and dbFileSize variables may not be trusted.
  46276. **
  46277. ** READER:
  46278. **
  46279. ** In this state all the requirements for reading the database in
  46280. ** rollback (non-WAL) mode are met. Unless the pager is (or recently
  46281. ** was) in exclusive-locking mode, a user-level read transaction is
  46282. ** open. The database size is known in this state.
  46283. **
  46284. ** A connection running with locking_mode=normal enters this state when
  46285. ** it opens a read-transaction on the database and returns to state
  46286. ** OPEN after the read-transaction is completed. However a connection
  46287. ** running in locking_mode=exclusive (including temp databases) remains in
  46288. ** this state even after the read-transaction is closed. The only way
  46289. ** a locking_mode=exclusive connection can transition from READER to OPEN
  46290. ** is via the ERROR state (see below).
  46291. **
  46292. ** * A read transaction may be active (but a write-transaction cannot).
  46293. ** * A SHARED or greater lock is held on the database file.
  46294. ** * The dbSize variable may be trusted (even if a user-level read
  46295. ** transaction is not active). The dbOrigSize and dbFileSize variables
  46296. ** may not be trusted at this point.
  46297. ** * If the database is a WAL database, then the WAL connection is open.
  46298. ** * Even if a read-transaction is not open, it is guaranteed that
  46299. ** there is no hot-journal in the file-system.
  46300. **
  46301. ** WRITER_LOCKED:
  46302. **
  46303. ** The pager moves to this state from READER when a write-transaction
  46304. ** is first opened on the database. In WRITER_LOCKED state, all locks
  46305. ** required to start a write-transaction are held, but no actual
  46306. ** modifications to the cache or database have taken place.
  46307. **
  46308. ** In rollback mode, a RESERVED or (if the transaction was opened with
  46309. ** BEGIN EXCLUSIVE) EXCLUSIVE lock is obtained on the database file when
  46310. ** moving to this state, but the journal file is not written to or opened
  46311. ** to in this state. If the transaction is committed or rolled back while
  46312. ** in WRITER_LOCKED state, all that is required is to unlock the database
  46313. ** file.
  46314. **
  46315. ** IN WAL mode, WalBeginWriteTransaction() is called to lock the log file.
  46316. ** If the connection is running with locking_mode=exclusive, an attempt
  46317. ** is made to obtain an EXCLUSIVE lock on the database file.
  46318. **
  46319. ** * A write transaction is active.
  46320. ** * If the connection is open in rollback-mode, a RESERVED or greater
  46321. ** lock is held on the database file.
  46322. ** * If the connection is open in WAL-mode, a WAL write transaction
  46323. ** is open (i.e. sqlite3WalBeginWriteTransaction() has been successfully
  46324. ** called).
  46325. ** * The dbSize, dbOrigSize and dbFileSize variables are all valid.
  46326. ** * The contents of the pager cache have not been modified.
  46327. ** * The journal file may or may not be open.
  46328. ** * Nothing (not even the first header) has been written to the journal.
  46329. **
  46330. ** WRITER_CACHEMOD:
  46331. **
  46332. ** A pager moves from WRITER_LOCKED state to this state when a page is
  46333. ** first modified by the upper layer. In rollback mode the journal file
  46334. ** is opened (if it is not already open) and a header written to the
  46335. ** start of it. The database file on disk has not been modified.
  46336. **
  46337. ** * A write transaction is active.
  46338. ** * A RESERVED or greater lock is held on the database file.
  46339. ** * The journal file is open and the first header has been written
  46340. ** to it, but the header has not been synced to disk.
  46341. ** * The contents of the page cache have been modified.
  46342. **
  46343. ** WRITER_DBMOD:
  46344. **
  46345. ** The pager transitions from WRITER_CACHEMOD into WRITER_DBMOD state
  46346. ** when it modifies the contents of the database file. WAL connections
  46347. ** never enter this state (since they do not modify the database file,
  46348. ** just the log file).
  46349. **
  46350. ** * A write transaction is active.
  46351. ** * An EXCLUSIVE or greater lock is held on the database file.
  46352. ** * The journal file is open and the first header has been written
  46353. ** and synced to disk.
  46354. ** * The contents of the page cache have been modified (and possibly
  46355. ** written to disk).
  46356. **
  46357. ** WRITER_FINISHED:
  46358. **
  46359. ** It is not possible for a WAL connection to enter this state.
  46360. **
  46361. ** A rollback-mode pager changes to WRITER_FINISHED state from WRITER_DBMOD
  46362. ** state after the entire transaction has been successfully written into the
  46363. ** database file. In this state the transaction may be committed simply
  46364. ** by finalizing the journal file. Once in WRITER_FINISHED state, it is
  46365. ** not possible to modify the database further. At this point, the upper
  46366. ** layer must either commit or rollback the transaction.
  46367. **
  46368. ** * A write transaction is active.
  46369. ** * An EXCLUSIVE or greater lock is held on the database file.
  46370. ** * All writing and syncing of journal and database data has finished.
  46371. ** If no error occurred, all that remains is to finalize the journal to
  46372. ** commit the transaction. If an error did occur, the caller will need
  46373. ** to rollback the transaction.
  46374. **
  46375. ** ERROR:
  46376. **
  46377. ** The ERROR state is entered when an IO or disk-full error (including
  46378. ** SQLITE_IOERR_NOMEM) occurs at a point in the code that makes it
  46379. ** difficult to be sure that the in-memory pager state (cache contents,
  46380. ** db size etc.) are consistent with the contents of the file-system.
  46381. **
  46382. ** Temporary pager files may enter the ERROR state, but in-memory pagers
  46383. ** cannot.
  46384. **
  46385. ** For example, if an IO error occurs while performing a rollback,
  46386. ** the contents of the page-cache may be left in an inconsistent state.
  46387. ** At this point it would be dangerous to change back to READER state
  46388. ** (as usually happens after a rollback). Any subsequent readers might
  46389. ** report database corruption (due to the inconsistent cache), and if
  46390. ** they upgrade to writers, they may inadvertently corrupt the database
  46391. ** file. To avoid this hazard, the pager switches into the ERROR state
  46392. ** instead of READER following such an error.
  46393. **
  46394. ** Once it has entered the ERROR state, any attempt to use the pager
  46395. ** to read or write data returns an error. Eventually, once all
  46396. ** outstanding transactions have been abandoned, the pager is able to
  46397. ** transition back to OPEN state, discarding the contents of the
  46398. ** page-cache and any other in-memory state at the same time. Everything
  46399. ** is reloaded from disk (and, if necessary, hot-journal rollback peformed)
  46400. ** when a read-transaction is next opened on the pager (transitioning
  46401. ** the pager into READER state). At that point the system has recovered
  46402. ** from the error.
  46403. **
  46404. ** Specifically, the pager jumps into the ERROR state if:
  46405. **
  46406. ** 1. An error occurs while attempting a rollback. This happens in
  46407. ** function sqlite3PagerRollback().
  46408. **
  46409. ** 2. An error occurs while attempting to finalize a journal file
  46410. ** following a commit in function sqlite3PagerCommitPhaseTwo().
  46411. **
  46412. ** 3. An error occurs while attempting to write to the journal or
  46413. ** database file in function pagerStress() in order to free up
  46414. ** memory.
  46415. **
  46416. ** In other cases, the error is returned to the b-tree layer. The b-tree
  46417. ** layer then attempts a rollback operation. If the error condition
  46418. ** persists, the pager enters the ERROR state via condition (1) above.
  46419. **
  46420. ** Condition (3) is necessary because it can be triggered by a read-only
  46421. ** statement executed within a transaction. In this case, if the error
  46422. ** code were simply returned to the user, the b-tree layer would not
  46423. ** automatically attempt a rollback, as it assumes that an error in a
  46424. ** read-only statement cannot leave the pager in an internally inconsistent
  46425. ** state.
  46426. **
  46427. ** * The Pager.errCode variable is set to something other than SQLITE_OK.
  46428. ** * There are one or more outstanding references to pages (after the
  46429. ** last reference is dropped the pager should move back to OPEN state).
  46430. ** * The pager is not an in-memory pager.
  46431. **
  46432. **
  46433. ** Notes:
  46434. **
  46435. ** * A pager is never in WRITER_DBMOD or WRITER_FINISHED state if the
  46436. ** connection is open in WAL mode. A WAL connection is always in one
  46437. ** of the first four states.
  46438. **
  46439. ** * Normally, a connection open in exclusive mode is never in PAGER_OPEN
  46440. ** state. There are two exceptions: immediately after exclusive-mode has
  46441. ** been turned on (and before any read or write transactions are
  46442. ** executed), and when the pager is leaving the "error state".
  46443. **
  46444. ** * See also: assert_pager_state().
  46445. */
  46446. #define PAGER_OPEN 0
  46447. #define PAGER_READER 1
  46448. #define PAGER_WRITER_LOCKED 2
  46449. #define PAGER_WRITER_CACHEMOD 3
  46450. #define PAGER_WRITER_DBMOD 4
  46451. #define PAGER_WRITER_FINISHED 5
  46452. #define PAGER_ERROR 6
  46453. /*
  46454. ** The Pager.eLock variable is almost always set to one of the
  46455. ** following locking-states, according to the lock currently held on
  46456. ** the database file: NO_LOCK, SHARED_LOCK, RESERVED_LOCK or EXCLUSIVE_LOCK.
  46457. ** This variable is kept up to date as locks are taken and released by
  46458. ** the pagerLockDb() and pagerUnlockDb() wrappers.
  46459. **
  46460. ** If the VFS xLock() or xUnlock() returns an error other than SQLITE_BUSY
  46461. ** (i.e. one of the SQLITE_IOERR subtypes), it is not clear whether or not
  46462. ** the operation was successful. In these circumstances pagerLockDb() and
  46463. ** pagerUnlockDb() take a conservative approach - eLock is always updated
  46464. ** when unlocking the file, and only updated when locking the file if the
  46465. ** VFS call is successful. This way, the Pager.eLock variable may be set
  46466. ** to a less exclusive (lower) value than the lock that is actually held
  46467. ** at the system level, but it is never set to a more exclusive value.
  46468. **
  46469. ** This is usually safe. If an xUnlock fails or appears to fail, there may
  46470. ** be a few redundant xLock() calls or a lock may be held for longer than
  46471. ** required, but nothing really goes wrong.
  46472. **
  46473. ** The exception is when the database file is unlocked as the pager moves
  46474. ** from ERROR to OPEN state. At this point there may be a hot-journal file
  46475. ** in the file-system that needs to be rolled back (as part of an OPEN->SHARED
  46476. ** transition, by the same pager or any other). If the call to xUnlock()
  46477. ** fails at this point and the pager is left holding an EXCLUSIVE lock, this
  46478. ** can confuse the call to xCheckReservedLock() call made later as part
  46479. ** of hot-journal detection.
  46480. **
  46481. ** xCheckReservedLock() is defined as returning true "if there is a RESERVED
  46482. ** lock held by this process or any others". So xCheckReservedLock may
  46483. ** return true because the caller itself is holding an EXCLUSIVE lock (but
  46484. ** doesn't know it because of a previous error in xUnlock). If this happens
  46485. ** a hot-journal may be mistaken for a journal being created by an active
  46486. ** transaction in another process, causing SQLite to read from the database
  46487. ** without rolling it back.
  46488. **
  46489. ** To work around this, if a call to xUnlock() fails when unlocking the
  46490. ** database in the ERROR state, Pager.eLock is set to UNKNOWN_LOCK. It
  46491. ** is only changed back to a real locking state after a successful call
  46492. ** to xLock(EXCLUSIVE). Also, the code to do the OPEN->SHARED state transition
  46493. ** omits the check for a hot-journal if Pager.eLock is set to UNKNOWN_LOCK
  46494. ** lock. Instead, it assumes a hot-journal exists and obtains an EXCLUSIVE
  46495. ** lock on the database file before attempting to roll it back. See function
  46496. ** PagerSharedLock() for more detail.
  46497. **
  46498. ** Pager.eLock may only be set to UNKNOWN_LOCK when the pager is in
  46499. ** PAGER_OPEN state.
  46500. */
  46501. #define UNKNOWN_LOCK (EXCLUSIVE_LOCK+1)
  46502. /*
  46503. ** A macro used for invoking the codec if there is one
  46504. */
  46505. #ifdef SQLITE_HAS_CODEC
  46506. # define CODEC1(P,D,N,X,E) \
  46507. if( P->xCodec && P->xCodec(P->pCodec,D,N,X)==0 ){ E; }
  46508. # define CODEC2(P,D,N,X,E,O) \
  46509. if( P->xCodec==0 ){ O=(char*)D; }else \
  46510. if( (O=(char*)(P->xCodec(P->pCodec,D,N,X)))==0 ){ E; }
  46511. #else
  46512. # define CODEC1(P,D,N,X,E) /* NO-OP */
  46513. # define CODEC2(P,D,N,X,E,O) O=(char*)D
  46514. #endif
  46515. /*
  46516. ** The maximum allowed sector size. 64KiB. If the xSectorsize() method
  46517. ** returns a value larger than this, then MAX_SECTOR_SIZE is used instead.
  46518. ** This could conceivably cause corruption following a power failure on
  46519. ** such a system. This is currently an undocumented limit.
  46520. */
  46521. #define MAX_SECTOR_SIZE 0x10000
  46522. /*
  46523. ** An instance of the following structure is allocated for each active
  46524. ** savepoint and statement transaction in the system. All such structures
  46525. ** are stored in the Pager.aSavepoint[] array, which is allocated and
  46526. ** resized using sqlite3Realloc().
  46527. **
  46528. ** When a savepoint is created, the PagerSavepoint.iHdrOffset field is
  46529. ** set to 0. If a journal-header is written into the main journal while
  46530. ** the savepoint is active, then iHdrOffset is set to the byte offset
  46531. ** immediately following the last journal record written into the main
  46532. ** journal before the journal-header. This is required during savepoint
  46533. ** rollback (see pagerPlaybackSavepoint()).
  46534. */
  46535. typedef struct PagerSavepoint PagerSavepoint;
  46536. struct PagerSavepoint {
  46537. i64 iOffset; /* Starting offset in main journal */
  46538. i64 iHdrOffset; /* See above */
  46539. Bitvec *pInSavepoint; /* Set of pages in this savepoint */
  46540. Pgno nOrig; /* Original number of pages in file */
  46541. Pgno iSubRec; /* Index of first record in sub-journal */
  46542. #ifndef SQLITE_OMIT_WAL
  46543. u32 aWalData[WAL_SAVEPOINT_NDATA]; /* WAL savepoint context */
  46544. #endif
  46545. };
  46546. /*
  46547. ** Bits of the Pager.doNotSpill flag. See further description below.
  46548. */
  46549. #define SPILLFLAG_OFF 0x01 /* Never spill cache. Set via pragma */
  46550. #define SPILLFLAG_ROLLBACK 0x02 /* Current rolling back, so do not spill */
  46551. #define SPILLFLAG_NOSYNC 0x04 /* Spill is ok, but do not sync */
  46552. /*
  46553. ** An open page cache is an instance of struct Pager. A description of
  46554. ** some of the more important member variables follows:
  46555. **
  46556. ** eState
  46557. **
  46558. ** The current 'state' of the pager object. See the comment and state
  46559. ** diagram above for a description of the pager state.
  46560. **
  46561. ** eLock
  46562. **
  46563. ** For a real on-disk database, the current lock held on the database file -
  46564. ** NO_LOCK, SHARED_LOCK, RESERVED_LOCK or EXCLUSIVE_LOCK.
  46565. **
  46566. ** For a temporary or in-memory database (neither of which require any
  46567. ** locks), this variable is always set to EXCLUSIVE_LOCK. Since such
  46568. ** databases always have Pager.exclusiveMode==1, this tricks the pager
  46569. ** logic into thinking that it already has all the locks it will ever
  46570. ** need (and no reason to release them).
  46571. **
  46572. ** In some (obscure) circumstances, this variable may also be set to
  46573. ** UNKNOWN_LOCK. See the comment above the #define of UNKNOWN_LOCK for
  46574. ** details.
  46575. **
  46576. ** changeCountDone
  46577. **
  46578. ** This boolean variable is used to make sure that the change-counter
  46579. ** (the 4-byte header field at byte offset 24 of the database file) is
  46580. ** not updated more often than necessary.
  46581. **
  46582. ** It is set to true when the change-counter field is updated, which
  46583. ** can only happen if an exclusive lock is held on the database file.
  46584. ** It is cleared (set to false) whenever an exclusive lock is
  46585. ** relinquished on the database file. Each time a transaction is committed,
  46586. ** The changeCountDone flag is inspected. If it is true, the work of
  46587. ** updating the change-counter is omitted for the current transaction.
  46588. **
  46589. ** This mechanism means that when running in exclusive mode, a connection
  46590. ** need only update the change-counter once, for the first transaction
  46591. ** committed.
  46592. **
  46593. ** setMaster
  46594. **
  46595. ** When PagerCommitPhaseOne() is called to commit a transaction, it may
  46596. ** (or may not) specify a master-journal name to be written into the
  46597. ** journal file before it is synced to disk.
  46598. **
  46599. ** Whether or not a journal file contains a master-journal pointer affects
  46600. ** the way in which the journal file is finalized after the transaction is
  46601. ** committed or rolled back when running in "journal_mode=PERSIST" mode.
  46602. ** If a journal file does not contain a master-journal pointer, it is
  46603. ** finalized by overwriting the first journal header with zeroes. If
  46604. ** it does contain a master-journal pointer the journal file is finalized
  46605. ** by truncating it to zero bytes, just as if the connection were
  46606. ** running in "journal_mode=truncate" mode.
  46607. **
  46608. ** Journal files that contain master journal pointers cannot be finalized
  46609. ** simply by overwriting the first journal-header with zeroes, as the
  46610. ** master journal pointer could interfere with hot-journal rollback of any
  46611. ** subsequently interrupted transaction that reuses the journal file.
  46612. **
  46613. ** The flag is cleared as soon as the journal file is finalized (either
  46614. ** by PagerCommitPhaseTwo or PagerRollback). If an IO error prevents the
  46615. ** journal file from being successfully finalized, the setMaster flag
  46616. ** is cleared anyway (and the pager will move to ERROR state).
  46617. **
  46618. ** doNotSpill
  46619. **
  46620. ** This variables control the behavior of cache-spills (calls made by
  46621. ** the pcache module to the pagerStress() routine to write cached data
  46622. ** to the file-system in order to free up memory).
  46623. **
  46624. ** When bits SPILLFLAG_OFF or SPILLFLAG_ROLLBACK of doNotSpill are set,
  46625. ** writing to the database from pagerStress() is disabled altogether.
  46626. ** The SPILLFLAG_ROLLBACK case is done in a very obscure case that
  46627. ** comes up during savepoint rollback that requires the pcache module
  46628. ** to allocate a new page to prevent the journal file from being written
  46629. ** while it is being traversed by code in pager_playback(). The SPILLFLAG_OFF
  46630. ** case is a user preference.
  46631. **
  46632. ** If the SPILLFLAG_NOSYNC bit is set, writing to the database from
  46633. ** pagerStress() is permitted, but syncing the journal file is not.
  46634. ** This flag is set by sqlite3PagerWrite() when the file-system sector-size
  46635. ** is larger than the database page-size in order to prevent a journal sync
  46636. ** from happening in between the journalling of two pages on the same sector.
  46637. **
  46638. ** subjInMemory
  46639. **
  46640. ** This is a boolean variable. If true, then any required sub-journal
  46641. ** is opened as an in-memory journal file. If false, then in-memory
  46642. ** sub-journals are only used for in-memory pager files.
  46643. **
  46644. ** This variable is updated by the upper layer each time a new
  46645. ** write-transaction is opened.
  46646. **
  46647. ** dbSize, dbOrigSize, dbFileSize
  46648. **
  46649. ** Variable dbSize is set to the number of pages in the database file.
  46650. ** It is valid in PAGER_READER and higher states (all states except for
  46651. ** OPEN and ERROR).
  46652. **
  46653. ** dbSize is set based on the size of the database file, which may be
  46654. ** larger than the size of the database (the value stored at offset
  46655. ** 28 of the database header by the btree). If the size of the file
  46656. ** is not an integer multiple of the page-size, the value stored in
  46657. ** dbSize is rounded down (i.e. a 5KB file with 2K page-size has dbSize==2).
  46658. ** Except, any file that is greater than 0 bytes in size is considered
  46659. ** to have at least one page. (i.e. a 1KB file with 2K page-size leads
  46660. ** to dbSize==1).
  46661. **
  46662. ** During a write-transaction, if pages with page-numbers greater than
  46663. ** dbSize are modified in the cache, dbSize is updated accordingly.
  46664. ** Similarly, if the database is truncated using PagerTruncateImage(),
  46665. ** dbSize is updated.
  46666. **
  46667. ** Variables dbOrigSize and dbFileSize are valid in states
  46668. ** PAGER_WRITER_LOCKED and higher. dbOrigSize is a copy of the dbSize
  46669. ** variable at the start of the transaction. It is used during rollback,
  46670. ** and to determine whether or not pages need to be journalled before
  46671. ** being modified.
  46672. **
  46673. ** Throughout a write-transaction, dbFileSize contains the size of
  46674. ** the file on disk in pages. It is set to a copy of dbSize when the
  46675. ** write-transaction is first opened, and updated when VFS calls are made
  46676. ** to write or truncate the database file on disk.
  46677. **
  46678. ** The only reason the dbFileSize variable is required is to suppress
  46679. ** unnecessary calls to xTruncate() after committing a transaction. If,
  46680. ** when a transaction is committed, the dbFileSize variable indicates
  46681. ** that the database file is larger than the database image (Pager.dbSize),
  46682. ** pager_truncate() is called. The pager_truncate() call uses xFilesize()
  46683. ** to measure the database file on disk, and then truncates it if required.
  46684. ** dbFileSize is not used when rolling back a transaction. In this case
  46685. ** pager_truncate() is called unconditionally (which means there may be
  46686. ** a call to xFilesize() that is not strictly required). In either case,
  46687. ** pager_truncate() may cause the file to become smaller or larger.
  46688. **
  46689. ** dbHintSize
  46690. **
  46691. ** The dbHintSize variable is used to limit the number of calls made to
  46692. ** the VFS xFileControl(FCNTL_SIZE_HINT) method.
  46693. **
  46694. ** dbHintSize is set to a copy of the dbSize variable when a
  46695. ** write-transaction is opened (at the same time as dbFileSize and
  46696. ** dbOrigSize). If the xFileControl(FCNTL_SIZE_HINT) method is called,
  46697. ** dbHintSize is increased to the number of pages that correspond to the
  46698. ** size-hint passed to the method call. See pager_write_pagelist() for
  46699. ** details.
  46700. **
  46701. ** errCode
  46702. **
  46703. ** The Pager.errCode variable is only ever used in PAGER_ERROR state. It
  46704. ** is set to zero in all other states. In PAGER_ERROR state, Pager.errCode
  46705. ** is always set to SQLITE_FULL, SQLITE_IOERR or one of the SQLITE_IOERR_XXX
  46706. ** sub-codes.
  46707. **
  46708. ** syncFlags, walSyncFlags
  46709. **
  46710. ** syncFlags is either SQLITE_SYNC_NORMAL (0x02) or SQLITE_SYNC_FULL (0x03).
  46711. ** syncFlags is used for rollback mode. walSyncFlags is used for WAL mode
  46712. ** and contains the flags used to sync the checkpoint operations in the
  46713. ** lower two bits, and sync flags used for transaction commits in the WAL
  46714. ** file in bits 0x04 and 0x08. In other words, to get the correct sync flags
  46715. ** for checkpoint operations, use (walSyncFlags&0x03) and to get the correct
  46716. ** sync flags for transaction commit, use ((walSyncFlags>>2)&0x03). Note
  46717. ** that with synchronous=NORMAL in WAL mode, transaction commit is not synced
  46718. ** meaning that the 0x04 and 0x08 bits are both zero.
  46719. */
  46720. struct Pager {
  46721. sqlite3_vfs *pVfs; /* OS functions to use for IO */
  46722. u8 exclusiveMode; /* Boolean. True if locking_mode==EXCLUSIVE */
  46723. u8 journalMode; /* One of the PAGER_JOURNALMODE_* values */
  46724. u8 useJournal; /* Use a rollback journal on this file */
  46725. u8 noSync; /* Do not sync the journal if true */
  46726. u8 fullSync; /* Do extra syncs of the journal for robustness */
  46727. u8 extraSync; /* sync directory after journal delete */
  46728. u8 syncFlags; /* SYNC_NORMAL or SYNC_FULL otherwise */
  46729. u8 walSyncFlags; /* See description above */
  46730. u8 tempFile; /* zFilename is a temporary or immutable file */
  46731. u8 noLock; /* Do not lock (except in WAL mode) */
  46732. u8 readOnly; /* True for a read-only database */
  46733. u8 memDb; /* True to inhibit all file I/O */
  46734. /**************************************************************************
  46735. ** The following block contains those class members that change during
  46736. ** routine operation. Class members not in this block are either fixed
  46737. ** when the pager is first created or else only change when there is a
  46738. ** significant mode change (such as changing the page_size, locking_mode,
  46739. ** or the journal_mode). From another view, these class members describe
  46740. ** the "state" of the pager, while other class members describe the
  46741. ** "configuration" of the pager.
  46742. */
  46743. u8 eState; /* Pager state (OPEN, READER, WRITER_LOCKED..) */
  46744. u8 eLock; /* Current lock held on database file */
  46745. u8 changeCountDone; /* Set after incrementing the change-counter */
  46746. u8 setMaster; /* True if a m-j name has been written to jrnl */
  46747. u8 doNotSpill; /* Do not spill the cache when non-zero */
  46748. u8 subjInMemory; /* True to use in-memory sub-journals */
  46749. u8 bUseFetch; /* True to use xFetch() */
  46750. u8 hasHeldSharedLock; /* True if a shared lock has ever been held */
  46751. Pgno dbSize; /* Number of pages in the database */
  46752. Pgno dbOrigSize; /* dbSize before the current transaction */
  46753. Pgno dbFileSize; /* Number of pages in the database file */
  46754. Pgno dbHintSize; /* Value passed to FCNTL_SIZE_HINT call */
  46755. int errCode; /* One of several kinds of errors */
  46756. int nRec; /* Pages journalled since last j-header written */
  46757. u32 cksumInit; /* Quasi-random value added to every checksum */
  46758. u32 nSubRec; /* Number of records written to sub-journal */
  46759. Bitvec *pInJournal; /* One bit for each page in the database file */
  46760. sqlite3_file *fd; /* File descriptor for database */
  46761. sqlite3_file *jfd; /* File descriptor for main journal */
  46762. sqlite3_file *sjfd; /* File descriptor for sub-journal */
  46763. i64 journalOff; /* Current write offset in the journal file */
  46764. i64 journalHdr; /* Byte offset to previous journal header */
  46765. sqlite3_backup *pBackup; /* Pointer to list of ongoing backup processes */
  46766. PagerSavepoint *aSavepoint; /* Array of active savepoints */
  46767. int nSavepoint; /* Number of elements in aSavepoint[] */
  46768. u32 iDataVersion; /* Changes whenever database content changes */
  46769. char dbFileVers[16]; /* Changes whenever database file changes */
  46770. int nMmapOut; /* Number of mmap pages currently outstanding */
  46771. sqlite3_int64 szMmap; /* Desired maximum mmap size */
  46772. PgHdr *pMmapFreelist; /* List of free mmap page headers (pDirty) */
  46773. /*
  46774. ** End of the routinely-changing class members
  46775. ***************************************************************************/
  46776. u16 nExtra; /* Add this many bytes to each in-memory page */
  46777. i16 nReserve; /* Number of unused bytes at end of each page */
  46778. u32 vfsFlags; /* Flags for sqlite3_vfs.xOpen() */
  46779. u32 sectorSize; /* Assumed sector size during rollback */
  46780. int pageSize; /* Number of bytes in a page */
  46781. Pgno mxPgno; /* Maximum allowed size of the database */
  46782. i64 journalSizeLimit; /* Size limit for persistent journal files */
  46783. char *zFilename; /* Name of the database file */
  46784. char *zJournal; /* Name of the journal file */
  46785. int (*xBusyHandler)(void*); /* Function to call when busy */
  46786. void *pBusyHandlerArg; /* Context argument for xBusyHandler */
  46787. int aStat[4]; /* Total cache hits, misses, writes, spills */
  46788. #ifdef SQLITE_TEST
  46789. int nRead; /* Database pages read */
  46790. #endif
  46791. void (*xReiniter)(DbPage*); /* Call this routine when reloading pages */
  46792. int (*xGet)(Pager*,Pgno,DbPage**,int); /* Routine to fetch a patch */
  46793. #ifdef SQLITE_HAS_CODEC
  46794. void *(*xCodec)(void*,void*,Pgno,int); /* Routine for en/decoding data */
  46795. void (*xCodecSizeChng)(void*,int,int); /* Notify of page size changes */
  46796. void (*xCodecFree)(void*); /* Destructor for the codec */
  46797. void *pCodec; /* First argument to xCodec... methods */
  46798. #endif
  46799. char *pTmpSpace; /* Pager.pageSize bytes of space for tmp use */
  46800. PCache *pPCache; /* Pointer to page cache object */
  46801. #ifndef SQLITE_OMIT_WAL
  46802. Wal *pWal; /* Write-ahead log used by "journal_mode=wal" */
  46803. char *zWal; /* File name for write-ahead log */
  46804. #endif
  46805. };
  46806. /*
  46807. ** Indexes for use with Pager.aStat[]. The Pager.aStat[] array contains
  46808. ** the values accessed by passing SQLITE_DBSTATUS_CACHE_HIT, CACHE_MISS
  46809. ** or CACHE_WRITE to sqlite3_db_status().
  46810. */
  46811. #define PAGER_STAT_HIT 0
  46812. #define PAGER_STAT_MISS 1
  46813. #define PAGER_STAT_WRITE 2
  46814. #define PAGER_STAT_SPILL 3
  46815. /*
  46816. ** The following global variables hold counters used for
  46817. ** testing purposes only. These variables do not exist in
  46818. ** a non-testing build. These variables are not thread-safe.
  46819. */
  46820. #ifdef SQLITE_TEST
  46821. SQLITE_API int sqlite3_pager_readdb_count = 0; /* Number of full pages read from DB */
  46822. SQLITE_API int sqlite3_pager_writedb_count = 0; /* Number of full pages written to DB */
  46823. SQLITE_API int sqlite3_pager_writej_count = 0; /* Number of pages written to journal */
  46824. # define PAGER_INCR(v) v++
  46825. #else
  46826. # define PAGER_INCR(v)
  46827. #endif
  46828. /*
  46829. ** Journal files begin with the following magic string. The data
  46830. ** was obtained from /dev/random. It is used only as a sanity check.
  46831. **
  46832. ** Since version 2.8.0, the journal format contains additional sanity
  46833. ** checking information. If the power fails while the journal is being
  46834. ** written, semi-random garbage data might appear in the journal
  46835. ** file after power is restored. If an attempt is then made
  46836. ** to roll the journal back, the database could be corrupted. The additional
  46837. ** sanity checking data is an attempt to discover the garbage in the
  46838. ** journal and ignore it.
  46839. **
  46840. ** The sanity checking information for the new journal format consists
  46841. ** of a 32-bit checksum on each page of data. The checksum covers both
  46842. ** the page number and the pPager->pageSize bytes of data for the page.
  46843. ** This cksum is initialized to a 32-bit random value that appears in the
  46844. ** journal file right after the header. The random initializer is important,
  46845. ** because garbage data that appears at the end of a journal is likely
  46846. ** data that was once in other files that have now been deleted. If the
  46847. ** garbage data came from an obsolete journal file, the checksums might
  46848. ** be correct. But by initializing the checksum to random value which
  46849. ** is different for every journal, we minimize that risk.
  46850. */
  46851. static const unsigned char aJournalMagic[] = {
  46852. 0xd9, 0xd5, 0x05, 0xf9, 0x20, 0xa1, 0x63, 0xd7,
  46853. };
  46854. /*
  46855. ** The size of the of each page record in the journal is given by
  46856. ** the following macro.
  46857. */
  46858. #define JOURNAL_PG_SZ(pPager) ((pPager->pageSize) + 8)
  46859. /*
  46860. ** The journal header size for this pager. This is usually the same
  46861. ** size as a single disk sector. See also setSectorSize().
  46862. */
  46863. #define JOURNAL_HDR_SZ(pPager) (pPager->sectorSize)
  46864. /*
  46865. ** The macro MEMDB is true if we are dealing with an in-memory database.
  46866. ** We do this as a macro so that if the SQLITE_OMIT_MEMORYDB macro is set,
  46867. ** the value of MEMDB will be a constant and the compiler will optimize
  46868. ** out code that would never execute.
  46869. */
  46870. #ifdef SQLITE_OMIT_MEMORYDB
  46871. # define MEMDB 0
  46872. #else
  46873. # define MEMDB pPager->memDb
  46874. #endif
  46875. /*
  46876. ** The macro USEFETCH is true if we are allowed to use the xFetch and xUnfetch
  46877. ** interfaces to access the database using memory-mapped I/O.
  46878. */
  46879. #if SQLITE_MAX_MMAP_SIZE>0
  46880. # define USEFETCH(x) ((x)->bUseFetch)
  46881. #else
  46882. # define USEFETCH(x) 0
  46883. #endif
  46884. /*
  46885. ** The maximum legal page number is (2^31 - 1).
  46886. */
  46887. #define PAGER_MAX_PGNO 2147483647
  46888. /*
  46889. ** The argument to this macro is a file descriptor (type sqlite3_file*).
  46890. ** Return 0 if it is not open, or non-zero (but not 1) if it is.
  46891. **
  46892. ** This is so that expressions can be written as:
  46893. **
  46894. ** if( isOpen(pPager->jfd) ){ ...
  46895. **
  46896. ** instead of
  46897. **
  46898. ** if( pPager->jfd->pMethods ){ ...
  46899. */
  46900. #define isOpen(pFd) ((pFd)->pMethods!=0)
  46901. /*
  46902. ** Return true if this pager uses a write-ahead log to read page pgno.
  46903. ** Return false if the pager reads pgno directly from the database.
  46904. */
  46905. #if !defined(SQLITE_OMIT_WAL) && defined(SQLITE_DIRECT_OVERFLOW_READ)
  46906. SQLITE_PRIVATE int sqlite3PagerUseWal(Pager *pPager, Pgno pgno){
  46907. u32 iRead = 0;
  46908. int rc;
  46909. if( pPager->pWal==0 ) return 0;
  46910. rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iRead);
  46911. return rc || iRead;
  46912. }
  46913. #endif
  46914. #ifndef SQLITE_OMIT_WAL
  46915. # define pagerUseWal(x) ((x)->pWal!=0)
  46916. #else
  46917. # define pagerUseWal(x) 0
  46918. # define pagerRollbackWal(x) 0
  46919. # define pagerWalFrames(v,w,x,y) 0
  46920. # define pagerOpenWalIfPresent(z) SQLITE_OK
  46921. # define pagerBeginReadTransaction(z) SQLITE_OK
  46922. #endif
  46923. #ifndef NDEBUG
  46924. /*
  46925. ** Usage:
  46926. **
  46927. ** assert( assert_pager_state(pPager) );
  46928. **
  46929. ** This function runs many asserts to try to find inconsistencies in
  46930. ** the internal state of the Pager object.
  46931. */
  46932. static int assert_pager_state(Pager *p){
  46933. Pager *pPager = p;
  46934. /* State must be valid. */
  46935. assert( p->eState==PAGER_OPEN
  46936. || p->eState==PAGER_READER
  46937. || p->eState==PAGER_WRITER_LOCKED
  46938. || p->eState==PAGER_WRITER_CACHEMOD
  46939. || p->eState==PAGER_WRITER_DBMOD
  46940. || p->eState==PAGER_WRITER_FINISHED
  46941. || p->eState==PAGER_ERROR
  46942. );
  46943. /* Regardless of the current state, a temp-file connection always behaves
  46944. ** as if it has an exclusive lock on the database file. It never updates
  46945. ** the change-counter field, so the changeCountDone flag is always set.
  46946. */
  46947. assert( p->tempFile==0 || p->eLock==EXCLUSIVE_LOCK );
  46948. assert( p->tempFile==0 || pPager->changeCountDone );
  46949. /* If the useJournal flag is clear, the journal-mode must be "OFF".
  46950. ** And if the journal-mode is "OFF", the journal file must not be open.
  46951. */
  46952. assert( p->journalMode==PAGER_JOURNALMODE_OFF || p->useJournal );
  46953. assert( p->journalMode!=PAGER_JOURNALMODE_OFF || !isOpen(p->jfd) );
  46954. /* Check that MEMDB implies noSync. And an in-memory journal. Since
  46955. ** this means an in-memory pager performs no IO at all, it cannot encounter
  46956. ** either SQLITE_IOERR or SQLITE_FULL during rollback or while finalizing
  46957. ** a journal file. (although the in-memory journal implementation may
  46958. ** return SQLITE_IOERR_NOMEM while the journal file is being written). It
  46959. ** is therefore not possible for an in-memory pager to enter the ERROR
  46960. ** state.
  46961. */
  46962. if( MEMDB ){
  46963. assert( !isOpen(p->fd) );
  46964. assert( p->noSync );
  46965. assert( p->journalMode==PAGER_JOURNALMODE_OFF
  46966. || p->journalMode==PAGER_JOURNALMODE_MEMORY
  46967. );
  46968. assert( p->eState!=PAGER_ERROR && p->eState!=PAGER_OPEN );
  46969. assert( pagerUseWal(p)==0 );
  46970. }
  46971. /* If changeCountDone is set, a RESERVED lock or greater must be held
  46972. ** on the file.
  46973. */
  46974. assert( pPager->changeCountDone==0 || pPager->eLock>=RESERVED_LOCK );
  46975. assert( p->eLock!=PENDING_LOCK );
  46976. switch( p->eState ){
  46977. case PAGER_OPEN:
  46978. assert( !MEMDB );
  46979. assert( pPager->errCode==SQLITE_OK );
  46980. assert( sqlite3PcacheRefCount(pPager->pPCache)==0 || pPager->tempFile );
  46981. break;
  46982. case PAGER_READER:
  46983. assert( pPager->errCode==SQLITE_OK );
  46984. assert( p->eLock!=UNKNOWN_LOCK );
  46985. assert( p->eLock>=SHARED_LOCK );
  46986. break;
  46987. case PAGER_WRITER_LOCKED:
  46988. assert( p->eLock!=UNKNOWN_LOCK );
  46989. assert( pPager->errCode==SQLITE_OK );
  46990. if( !pagerUseWal(pPager) ){
  46991. assert( p->eLock>=RESERVED_LOCK );
  46992. }
  46993. assert( pPager->dbSize==pPager->dbOrigSize );
  46994. assert( pPager->dbOrigSize==pPager->dbFileSize );
  46995. assert( pPager->dbOrigSize==pPager->dbHintSize );
  46996. assert( pPager->setMaster==0 );
  46997. break;
  46998. case PAGER_WRITER_CACHEMOD:
  46999. assert( p->eLock!=UNKNOWN_LOCK );
  47000. assert( pPager->errCode==SQLITE_OK );
  47001. if( !pagerUseWal(pPager) ){
  47002. /* It is possible that if journal_mode=wal here that neither the
  47003. ** journal file nor the WAL file are open. This happens during
  47004. ** a rollback transaction that switches from journal_mode=off
  47005. ** to journal_mode=wal.
  47006. */
  47007. assert( p->eLock>=RESERVED_LOCK );
  47008. assert( isOpen(p->jfd)
  47009. || p->journalMode==PAGER_JOURNALMODE_OFF
  47010. || p->journalMode==PAGER_JOURNALMODE_WAL
  47011. );
  47012. }
  47013. assert( pPager->dbOrigSize==pPager->dbFileSize );
  47014. assert( pPager->dbOrigSize==pPager->dbHintSize );
  47015. break;
  47016. case PAGER_WRITER_DBMOD:
  47017. assert( p->eLock==EXCLUSIVE_LOCK );
  47018. assert( pPager->errCode==SQLITE_OK );
  47019. assert( !pagerUseWal(pPager) );
  47020. assert( p->eLock>=EXCLUSIVE_LOCK );
  47021. assert( isOpen(p->jfd)
  47022. || p->journalMode==PAGER_JOURNALMODE_OFF
  47023. || p->journalMode==PAGER_JOURNALMODE_WAL
  47024. || (sqlite3OsDeviceCharacteristics(p->fd)&SQLITE_IOCAP_BATCH_ATOMIC)
  47025. );
  47026. assert( pPager->dbOrigSize<=pPager->dbHintSize );
  47027. break;
  47028. case PAGER_WRITER_FINISHED:
  47029. assert( p->eLock==EXCLUSIVE_LOCK );
  47030. assert( pPager->errCode==SQLITE_OK );
  47031. assert( !pagerUseWal(pPager) );
  47032. assert( isOpen(p->jfd)
  47033. || p->journalMode==PAGER_JOURNALMODE_OFF
  47034. || p->journalMode==PAGER_JOURNALMODE_WAL
  47035. || (sqlite3OsDeviceCharacteristics(p->fd)&SQLITE_IOCAP_BATCH_ATOMIC)
  47036. );
  47037. break;
  47038. case PAGER_ERROR:
  47039. /* There must be at least one outstanding reference to the pager if
  47040. ** in ERROR state. Otherwise the pager should have already dropped
  47041. ** back to OPEN state.
  47042. */
  47043. assert( pPager->errCode!=SQLITE_OK );
  47044. assert( sqlite3PcacheRefCount(pPager->pPCache)>0 || pPager->tempFile );
  47045. break;
  47046. }
  47047. return 1;
  47048. }
  47049. #endif /* ifndef NDEBUG */
  47050. #ifdef SQLITE_DEBUG
  47051. /*
  47052. ** Return a pointer to a human readable string in a static buffer
  47053. ** containing the state of the Pager object passed as an argument. This
  47054. ** is intended to be used within debuggers. For example, as an alternative
  47055. ** to "print *pPager" in gdb:
  47056. **
  47057. ** (gdb) printf "%s", print_pager_state(pPager)
  47058. */
  47059. static char *print_pager_state(Pager *p){
  47060. static char zRet[1024];
  47061. sqlite3_snprintf(1024, zRet,
  47062. "Filename: %s\n"
  47063. "State: %s errCode=%d\n"
  47064. "Lock: %s\n"
  47065. "Locking mode: locking_mode=%s\n"
  47066. "Journal mode: journal_mode=%s\n"
  47067. "Backing store: tempFile=%d memDb=%d useJournal=%d\n"
  47068. "Journal: journalOff=%lld journalHdr=%lld\n"
  47069. "Size: dbsize=%d dbOrigSize=%d dbFileSize=%d\n"
  47070. , p->zFilename
  47071. , p->eState==PAGER_OPEN ? "OPEN" :
  47072. p->eState==PAGER_READER ? "READER" :
  47073. p->eState==PAGER_WRITER_LOCKED ? "WRITER_LOCKED" :
  47074. p->eState==PAGER_WRITER_CACHEMOD ? "WRITER_CACHEMOD" :
  47075. p->eState==PAGER_WRITER_DBMOD ? "WRITER_DBMOD" :
  47076. p->eState==PAGER_WRITER_FINISHED ? "WRITER_FINISHED" :
  47077. p->eState==PAGER_ERROR ? "ERROR" : "?error?"
  47078. , (int)p->errCode
  47079. , p->eLock==NO_LOCK ? "NO_LOCK" :
  47080. p->eLock==RESERVED_LOCK ? "RESERVED" :
  47081. p->eLock==EXCLUSIVE_LOCK ? "EXCLUSIVE" :
  47082. p->eLock==SHARED_LOCK ? "SHARED" :
  47083. p->eLock==UNKNOWN_LOCK ? "UNKNOWN" : "?error?"
  47084. , p->exclusiveMode ? "exclusive" : "normal"
  47085. , p->journalMode==PAGER_JOURNALMODE_MEMORY ? "memory" :
  47086. p->journalMode==PAGER_JOURNALMODE_OFF ? "off" :
  47087. p->journalMode==PAGER_JOURNALMODE_DELETE ? "delete" :
  47088. p->journalMode==PAGER_JOURNALMODE_PERSIST ? "persist" :
  47089. p->journalMode==PAGER_JOURNALMODE_TRUNCATE ? "truncate" :
  47090. p->journalMode==PAGER_JOURNALMODE_WAL ? "wal" : "?error?"
  47091. , (int)p->tempFile, (int)p->memDb, (int)p->useJournal
  47092. , p->journalOff, p->journalHdr
  47093. , (int)p->dbSize, (int)p->dbOrigSize, (int)p->dbFileSize
  47094. );
  47095. return zRet;
  47096. }
  47097. #endif
  47098. /* Forward references to the various page getters */
  47099. static int getPageNormal(Pager*,Pgno,DbPage**,int);
  47100. static int getPageError(Pager*,Pgno,DbPage**,int);
  47101. #if SQLITE_MAX_MMAP_SIZE>0
  47102. static int getPageMMap(Pager*,Pgno,DbPage**,int);
  47103. #endif
  47104. /*
  47105. ** Set the Pager.xGet method for the appropriate routine used to fetch
  47106. ** content from the pager.
  47107. */
  47108. static void setGetterMethod(Pager *pPager){
  47109. if( pPager->errCode ){
  47110. pPager->xGet = getPageError;
  47111. #if SQLITE_MAX_MMAP_SIZE>0
  47112. }else if( USEFETCH(pPager)
  47113. #ifdef SQLITE_HAS_CODEC
  47114. && pPager->xCodec==0
  47115. #endif
  47116. ){
  47117. pPager->xGet = getPageMMap;
  47118. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  47119. }else{
  47120. pPager->xGet = getPageNormal;
  47121. }
  47122. }
  47123. /*
  47124. ** Return true if it is necessary to write page *pPg into the sub-journal.
  47125. ** A page needs to be written into the sub-journal if there exists one
  47126. ** or more open savepoints for which:
  47127. **
  47128. ** * The page-number is less than or equal to PagerSavepoint.nOrig, and
  47129. ** * The bit corresponding to the page-number is not set in
  47130. ** PagerSavepoint.pInSavepoint.
  47131. */
  47132. static int subjRequiresPage(PgHdr *pPg){
  47133. Pager *pPager = pPg->pPager;
  47134. PagerSavepoint *p;
  47135. Pgno pgno = pPg->pgno;
  47136. int i;
  47137. for(i=0; i<pPager->nSavepoint; i++){
  47138. p = &pPager->aSavepoint[i];
  47139. if( p->nOrig>=pgno && 0==sqlite3BitvecTestNotNull(p->pInSavepoint, pgno) ){
  47140. return 1;
  47141. }
  47142. }
  47143. return 0;
  47144. }
  47145. #ifdef SQLITE_DEBUG
  47146. /*
  47147. ** Return true if the page is already in the journal file.
  47148. */
  47149. static int pageInJournal(Pager *pPager, PgHdr *pPg){
  47150. return sqlite3BitvecTest(pPager->pInJournal, pPg->pgno);
  47151. }
  47152. #endif
  47153. /*
  47154. ** Read a 32-bit integer from the given file descriptor. Store the integer
  47155. ** that is read in *pRes. Return SQLITE_OK if everything worked, or an
  47156. ** error code is something goes wrong.
  47157. **
  47158. ** All values are stored on disk as big-endian.
  47159. */
  47160. static int read32bits(sqlite3_file *fd, i64 offset, u32 *pRes){
  47161. unsigned char ac[4];
  47162. int rc = sqlite3OsRead(fd, ac, sizeof(ac), offset);
  47163. if( rc==SQLITE_OK ){
  47164. *pRes = sqlite3Get4byte(ac);
  47165. }
  47166. return rc;
  47167. }
  47168. /*
  47169. ** Write a 32-bit integer into a string buffer in big-endian byte order.
  47170. */
  47171. #define put32bits(A,B) sqlite3Put4byte((u8*)A,B)
  47172. /*
  47173. ** Write a 32-bit integer into the given file descriptor. Return SQLITE_OK
  47174. ** on success or an error code is something goes wrong.
  47175. */
  47176. static int write32bits(sqlite3_file *fd, i64 offset, u32 val){
  47177. char ac[4];
  47178. put32bits(ac, val);
  47179. return sqlite3OsWrite(fd, ac, 4, offset);
  47180. }
  47181. /*
  47182. ** Unlock the database file to level eLock, which must be either NO_LOCK
  47183. ** or SHARED_LOCK. Regardless of whether or not the call to xUnlock()
  47184. ** succeeds, set the Pager.eLock variable to match the (attempted) new lock.
  47185. **
  47186. ** Except, if Pager.eLock is set to UNKNOWN_LOCK when this function is
  47187. ** called, do not modify it. See the comment above the #define of
  47188. ** UNKNOWN_LOCK for an explanation of this.
  47189. */
  47190. static int pagerUnlockDb(Pager *pPager, int eLock){
  47191. int rc = SQLITE_OK;
  47192. assert( !pPager->exclusiveMode || pPager->eLock==eLock );
  47193. assert( eLock==NO_LOCK || eLock==SHARED_LOCK );
  47194. assert( eLock!=NO_LOCK || pagerUseWal(pPager)==0 );
  47195. if( isOpen(pPager->fd) ){
  47196. assert( pPager->eLock>=eLock );
  47197. rc = pPager->noLock ? SQLITE_OK : sqlite3OsUnlock(pPager->fd, eLock);
  47198. if( pPager->eLock!=UNKNOWN_LOCK ){
  47199. pPager->eLock = (u8)eLock;
  47200. }
  47201. IOTRACE(("UNLOCK %p %d\n", pPager, eLock))
  47202. }
  47203. return rc;
  47204. }
  47205. /*
  47206. ** Lock the database file to level eLock, which must be either SHARED_LOCK,
  47207. ** RESERVED_LOCK or EXCLUSIVE_LOCK. If the caller is successful, set the
  47208. ** Pager.eLock variable to the new locking state.
  47209. **
  47210. ** Except, if Pager.eLock is set to UNKNOWN_LOCK when this function is
  47211. ** called, do not modify it unless the new locking state is EXCLUSIVE_LOCK.
  47212. ** See the comment above the #define of UNKNOWN_LOCK for an explanation
  47213. ** of this.
  47214. */
  47215. static int pagerLockDb(Pager *pPager, int eLock){
  47216. int rc = SQLITE_OK;
  47217. assert( eLock==SHARED_LOCK || eLock==RESERVED_LOCK || eLock==EXCLUSIVE_LOCK );
  47218. if( pPager->eLock<eLock || pPager->eLock==UNKNOWN_LOCK ){
  47219. rc = pPager->noLock ? SQLITE_OK : sqlite3OsLock(pPager->fd, eLock);
  47220. if( rc==SQLITE_OK && (pPager->eLock!=UNKNOWN_LOCK||eLock==EXCLUSIVE_LOCK) ){
  47221. pPager->eLock = (u8)eLock;
  47222. IOTRACE(("LOCK %p %d\n", pPager, eLock))
  47223. }
  47224. }
  47225. return rc;
  47226. }
  47227. /*
  47228. ** This function determines whether or not the atomic-write or
  47229. ** atomic-batch-write optimizations can be used with this pager. The
  47230. ** atomic-write optimization can be used if:
  47231. **
  47232. ** (a) the value returned by OsDeviceCharacteristics() indicates that
  47233. ** a database page may be written atomically, and
  47234. ** (b) the value returned by OsSectorSize() is less than or equal
  47235. ** to the page size.
  47236. **
  47237. ** If it can be used, then the value returned is the size of the journal
  47238. ** file when it contains rollback data for exactly one page.
  47239. **
  47240. ** The atomic-batch-write optimization can be used if OsDeviceCharacteristics()
  47241. ** returns a value with the SQLITE_IOCAP_BATCH_ATOMIC bit set. -1 is
  47242. ** returned in this case.
  47243. **
  47244. ** If neither optimization can be used, 0 is returned.
  47245. */
  47246. static int jrnlBufferSize(Pager *pPager){
  47247. assert( !MEMDB );
  47248. #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
  47249. || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  47250. int dc; /* Device characteristics */
  47251. assert( isOpen(pPager->fd) );
  47252. dc = sqlite3OsDeviceCharacteristics(pPager->fd);
  47253. #else
  47254. UNUSED_PARAMETER(pPager);
  47255. #endif
  47256. #ifdef SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  47257. if( pPager->dbSize>0 && (dc&SQLITE_IOCAP_BATCH_ATOMIC) ){
  47258. return -1;
  47259. }
  47260. #endif
  47261. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  47262. {
  47263. int nSector = pPager->sectorSize;
  47264. int szPage = pPager->pageSize;
  47265. assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
  47266. assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
  47267. if( 0==(dc&(SQLITE_IOCAP_ATOMIC|(szPage>>8)) || nSector>szPage) ){
  47268. return 0;
  47269. }
  47270. }
  47271. return JOURNAL_HDR_SZ(pPager) + JOURNAL_PG_SZ(pPager);
  47272. #endif
  47273. return 0;
  47274. }
  47275. /*
  47276. ** If SQLITE_CHECK_PAGES is defined then we do some sanity checking
  47277. ** on the cache using a hash function. This is used for testing
  47278. ** and debugging only.
  47279. */
  47280. #ifdef SQLITE_CHECK_PAGES
  47281. /*
  47282. ** Return a 32-bit hash of the page data for pPage.
  47283. */
  47284. static u32 pager_datahash(int nByte, unsigned char *pData){
  47285. u32 hash = 0;
  47286. int i;
  47287. for(i=0; i<nByte; i++){
  47288. hash = (hash*1039) + pData[i];
  47289. }
  47290. return hash;
  47291. }
  47292. static u32 pager_pagehash(PgHdr *pPage){
  47293. return pager_datahash(pPage->pPager->pageSize, (unsigned char *)pPage->pData);
  47294. }
  47295. static void pager_set_pagehash(PgHdr *pPage){
  47296. pPage->pageHash = pager_pagehash(pPage);
  47297. }
  47298. /*
  47299. ** The CHECK_PAGE macro takes a PgHdr* as an argument. If SQLITE_CHECK_PAGES
  47300. ** is defined, and NDEBUG is not defined, an assert() statement checks
  47301. ** that the page is either dirty or still matches the calculated page-hash.
  47302. */
  47303. #define CHECK_PAGE(x) checkPage(x)
  47304. static void checkPage(PgHdr *pPg){
  47305. Pager *pPager = pPg->pPager;
  47306. assert( pPager->eState!=PAGER_ERROR );
  47307. assert( (pPg->flags&PGHDR_DIRTY) || pPg->pageHash==pager_pagehash(pPg) );
  47308. }
  47309. #else
  47310. #define pager_datahash(X,Y) 0
  47311. #define pager_pagehash(X) 0
  47312. #define pager_set_pagehash(X)
  47313. #define CHECK_PAGE(x)
  47314. #endif /* SQLITE_CHECK_PAGES */
  47315. /*
  47316. ** When this is called the journal file for pager pPager must be open.
  47317. ** This function attempts to read a master journal file name from the
  47318. ** end of the file and, if successful, copies it into memory supplied
  47319. ** by the caller. See comments above writeMasterJournal() for the format
  47320. ** used to store a master journal file name at the end of a journal file.
  47321. **
  47322. ** zMaster must point to a buffer of at least nMaster bytes allocated by
  47323. ** the caller. This should be sqlite3_vfs.mxPathname+1 (to ensure there is
  47324. ** enough space to write the master journal name). If the master journal
  47325. ** name in the journal is longer than nMaster bytes (including a
  47326. ** nul-terminator), then this is handled as if no master journal name
  47327. ** were present in the journal.
  47328. **
  47329. ** If a master journal file name is present at the end of the journal
  47330. ** file, then it is copied into the buffer pointed to by zMaster. A
  47331. ** nul-terminator byte is appended to the buffer following the master
  47332. ** journal file name.
  47333. **
  47334. ** If it is determined that no master journal file name is present
  47335. ** zMaster[0] is set to 0 and SQLITE_OK returned.
  47336. **
  47337. ** If an error occurs while reading from the journal file, an SQLite
  47338. ** error code is returned.
  47339. */
  47340. static int readMasterJournal(sqlite3_file *pJrnl, char *zMaster, u32 nMaster){
  47341. int rc; /* Return code */
  47342. u32 len; /* Length in bytes of master journal name */
  47343. i64 szJ; /* Total size in bytes of journal file pJrnl */
  47344. u32 cksum; /* MJ checksum value read from journal */
  47345. u32 u; /* Unsigned loop counter */
  47346. unsigned char aMagic[8]; /* A buffer to hold the magic header */
  47347. zMaster[0] = '\0';
  47348. if( SQLITE_OK!=(rc = sqlite3OsFileSize(pJrnl, &szJ))
  47349. || szJ<16
  47350. || SQLITE_OK!=(rc = read32bits(pJrnl, szJ-16, &len))
  47351. || len>=nMaster
  47352. || len>szJ-16
  47353. || len==0
  47354. || SQLITE_OK!=(rc = read32bits(pJrnl, szJ-12, &cksum))
  47355. || SQLITE_OK!=(rc = sqlite3OsRead(pJrnl, aMagic, 8, szJ-8))
  47356. || memcmp(aMagic, aJournalMagic, 8)
  47357. || SQLITE_OK!=(rc = sqlite3OsRead(pJrnl, zMaster, len, szJ-16-len))
  47358. ){
  47359. return rc;
  47360. }
  47361. /* See if the checksum matches the master journal name */
  47362. for(u=0; u<len; u++){
  47363. cksum -= zMaster[u];
  47364. }
  47365. if( cksum ){
  47366. /* If the checksum doesn't add up, then one or more of the disk sectors
  47367. ** containing the master journal filename is corrupted. This means
  47368. ** definitely roll back, so just return SQLITE_OK and report a (nul)
  47369. ** master-journal filename.
  47370. */
  47371. len = 0;
  47372. }
  47373. zMaster[len] = '\0';
  47374. return SQLITE_OK;
  47375. }
  47376. /*
  47377. ** Return the offset of the sector boundary at or immediately
  47378. ** following the value in pPager->journalOff, assuming a sector
  47379. ** size of pPager->sectorSize bytes.
  47380. **
  47381. ** i.e for a sector size of 512:
  47382. **
  47383. ** Pager.journalOff Return value
  47384. ** ---------------------------------------
  47385. ** 0 0
  47386. ** 512 512
  47387. ** 100 512
  47388. ** 2000 2048
  47389. **
  47390. */
  47391. static i64 journalHdrOffset(Pager *pPager){
  47392. i64 offset = 0;
  47393. i64 c = pPager->journalOff;
  47394. if( c ){
  47395. offset = ((c-1)/JOURNAL_HDR_SZ(pPager) + 1) * JOURNAL_HDR_SZ(pPager);
  47396. }
  47397. assert( offset%JOURNAL_HDR_SZ(pPager)==0 );
  47398. assert( offset>=c );
  47399. assert( (offset-c)<JOURNAL_HDR_SZ(pPager) );
  47400. return offset;
  47401. }
  47402. /*
  47403. ** The journal file must be open when this function is called.
  47404. **
  47405. ** This function is a no-op if the journal file has not been written to
  47406. ** within the current transaction (i.e. if Pager.journalOff==0).
  47407. **
  47408. ** If doTruncate is non-zero or the Pager.journalSizeLimit variable is
  47409. ** set to 0, then truncate the journal file to zero bytes in size. Otherwise,
  47410. ** zero the 28-byte header at the start of the journal file. In either case,
  47411. ** if the pager is not in no-sync mode, sync the journal file immediately
  47412. ** after writing or truncating it.
  47413. **
  47414. ** If Pager.journalSizeLimit is set to a positive, non-zero value, and
  47415. ** following the truncation or zeroing described above the size of the
  47416. ** journal file in bytes is larger than this value, then truncate the
  47417. ** journal file to Pager.journalSizeLimit bytes. The journal file does
  47418. ** not need to be synced following this operation.
  47419. **
  47420. ** If an IO error occurs, abandon processing and return the IO error code.
  47421. ** Otherwise, return SQLITE_OK.
  47422. */
  47423. static int zeroJournalHdr(Pager *pPager, int doTruncate){
  47424. int rc = SQLITE_OK; /* Return code */
  47425. assert( isOpen(pPager->jfd) );
  47426. assert( !sqlite3JournalIsInMemory(pPager->jfd) );
  47427. if( pPager->journalOff ){
  47428. const i64 iLimit = pPager->journalSizeLimit; /* Local cache of jsl */
  47429. IOTRACE(("JZEROHDR %p\n", pPager))
  47430. if( doTruncate || iLimit==0 ){
  47431. rc = sqlite3OsTruncate(pPager->jfd, 0);
  47432. }else{
  47433. static const char zeroHdr[28] = {0};
  47434. rc = sqlite3OsWrite(pPager->jfd, zeroHdr, sizeof(zeroHdr), 0);
  47435. }
  47436. if( rc==SQLITE_OK && !pPager->noSync ){
  47437. rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_DATAONLY|pPager->syncFlags);
  47438. }
  47439. /* At this point the transaction is committed but the write lock
  47440. ** is still held on the file. If there is a size limit configured for
  47441. ** the persistent journal and the journal file currently consumes more
  47442. ** space than that limit allows for, truncate it now. There is no need
  47443. ** to sync the file following this operation.
  47444. */
  47445. if( rc==SQLITE_OK && iLimit>0 ){
  47446. i64 sz;
  47447. rc = sqlite3OsFileSize(pPager->jfd, &sz);
  47448. if( rc==SQLITE_OK && sz>iLimit ){
  47449. rc = sqlite3OsTruncate(pPager->jfd, iLimit);
  47450. }
  47451. }
  47452. }
  47453. return rc;
  47454. }
  47455. /*
  47456. ** The journal file must be open when this routine is called. A journal
  47457. ** header (JOURNAL_HDR_SZ bytes) is written into the journal file at the
  47458. ** current location.
  47459. **
  47460. ** The format for the journal header is as follows:
  47461. ** - 8 bytes: Magic identifying journal format.
  47462. ** - 4 bytes: Number of records in journal, or -1 no-sync mode is on.
  47463. ** - 4 bytes: Random number used for page hash.
  47464. ** - 4 bytes: Initial database page count.
  47465. ** - 4 bytes: Sector size used by the process that wrote this journal.
  47466. ** - 4 bytes: Database page size.
  47467. **
  47468. ** Followed by (JOURNAL_HDR_SZ - 28) bytes of unused space.
  47469. */
  47470. static int writeJournalHdr(Pager *pPager){
  47471. int rc = SQLITE_OK; /* Return code */
  47472. char *zHeader = pPager->pTmpSpace; /* Temporary space used to build header */
  47473. u32 nHeader = (u32)pPager->pageSize;/* Size of buffer pointed to by zHeader */
  47474. u32 nWrite; /* Bytes of header sector written */
  47475. int ii; /* Loop counter */
  47476. assert( isOpen(pPager->jfd) ); /* Journal file must be open. */
  47477. if( nHeader>JOURNAL_HDR_SZ(pPager) ){
  47478. nHeader = JOURNAL_HDR_SZ(pPager);
  47479. }
  47480. /* If there are active savepoints and any of them were created
  47481. ** since the most recent journal header was written, update the
  47482. ** PagerSavepoint.iHdrOffset fields now.
  47483. */
  47484. for(ii=0; ii<pPager->nSavepoint; ii++){
  47485. if( pPager->aSavepoint[ii].iHdrOffset==0 ){
  47486. pPager->aSavepoint[ii].iHdrOffset = pPager->journalOff;
  47487. }
  47488. }
  47489. pPager->journalHdr = pPager->journalOff = journalHdrOffset(pPager);
  47490. /*
  47491. ** Write the nRec Field - the number of page records that follow this
  47492. ** journal header. Normally, zero is written to this value at this time.
  47493. ** After the records are added to the journal (and the journal synced,
  47494. ** if in full-sync mode), the zero is overwritten with the true number
  47495. ** of records (see syncJournal()).
  47496. **
  47497. ** A faster alternative is to write 0xFFFFFFFF to the nRec field. When
  47498. ** reading the journal this value tells SQLite to assume that the
  47499. ** rest of the journal file contains valid page records. This assumption
  47500. ** is dangerous, as if a failure occurred whilst writing to the journal
  47501. ** file it may contain some garbage data. There are two scenarios
  47502. ** where this risk can be ignored:
  47503. **
  47504. ** * When the pager is in no-sync mode. Corruption can follow a
  47505. ** power failure in this case anyway.
  47506. **
  47507. ** * When the SQLITE_IOCAP_SAFE_APPEND flag is set. This guarantees
  47508. ** that garbage data is never appended to the journal file.
  47509. */
  47510. assert( isOpen(pPager->fd) || pPager->noSync );
  47511. if( pPager->noSync || (pPager->journalMode==PAGER_JOURNALMODE_MEMORY)
  47512. || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_SAFE_APPEND)
  47513. ){
  47514. memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
  47515. put32bits(&zHeader[sizeof(aJournalMagic)], 0xffffffff);
  47516. }else{
  47517. memset(zHeader, 0, sizeof(aJournalMagic)+4);
  47518. }
  47519. /* The random check-hash initializer */
  47520. sqlite3_randomness(sizeof(pPager->cksumInit), &pPager->cksumInit);
  47521. put32bits(&zHeader[sizeof(aJournalMagic)+4], pPager->cksumInit);
  47522. /* The initial database size */
  47523. put32bits(&zHeader[sizeof(aJournalMagic)+8], pPager->dbOrigSize);
  47524. /* The assumed sector size for this process */
  47525. put32bits(&zHeader[sizeof(aJournalMagic)+12], pPager->sectorSize);
  47526. /* The page size */
  47527. put32bits(&zHeader[sizeof(aJournalMagic)+16], pPager->pageSize);
  47528. /* Initializing the tail of the buffer is not necessary. Everything
  47529. ** works find if the following memset() is omitted. But initializing
  47530. ** the memory prevents valgrind from complaining, so we are willing to
  47531. ** take the performance hit.
  47532. */
  47533. memset(&zHeader[sizeof(aJournalMagic)+20], 0,
  47534. nHeader-(sizeof(aJournalMagic)+20));
  47535. /* In theory, it is only necessary to write the 28 bytes that the
  47536. ** journal header consumes to the journal file here. Then increment the
  47537. ** Pager.journalOff variable by JOURNAL_HDR_SZ so that the next
  47538. ** record is written to the following sector (leaving a gap in the file
  47539. ** that will be implicitly filled in by the OS).
  47540. **
  47541. ** However it has been discovered that on some systems this pattern can
  47542. ** be significantly slower than contiguously writing data to the file,
  47543. ** even if that means explicitly writing data to the block of
  47544. ** (JOURNAL_HDR_SZ - 28) bytes that will not be used. So that is what
  47545. ** is done.
  47546. **
  47547. ** The loop is required here in case the sector-size is larger than the
  47548. ** database page size. Since the zHeader buffer is only Pager.pageSize
  47549. ** bytes in size, more than one call to sqlite3OsWrite() may be required
  47550. ** to populate the entire journal header sector.
  47551. */
  47552. for(nWrite=0; rc==SQLITE_OK&&nWrite<JOURNAL_HDR_SZ(pPager); nWrite+=nHeader){
  47553. IOTRACE(("JHDR %p %lld %d\n", pPager, pPager->journalHdr, nHeader))
  47554. rc = sqlite3OsWrite(pPager->jfd, zHeader, nHeader, pPager->journalOff);
  47555. assert( pPager->journalHdr <= pPager->journalOff );
  47556. pPager->journalOff += nHeader;
  47557. }
  47558. return rc;
  47559. }
  47560. /*
  47561. ** The journal file must be open when this is called. A journal header file
  47562. ** (JOURNAL_HDR_SZ bytes) is read from the current location in the journal
  47563. ** file. The current location in the journal file is given by
  47564. ** pPager->journalOff. See comments above function writeJournalHdr() for
  47565. ** a description of the journal header format.
  47566. **
  47567. ** If the header is read successfully, *pNRec is set to the number of
  47568. ** page records following this header and *pDbSize is set to the size of the
  47569. ** database before the transaction began, in pages. Also, pPager->cksumInit
  47570. ** is set to the value read from the journal header. SQLITE_OK is returned
  47571. ** in this case.
  47572. **
  47573. ** If the journal header file appears to be corrupted, SQLITE_DONE is
  47574. ** returned and *pNRec and *PDbSize are undefined. If JOURNAL_HDR_SZ bytes
  47575. ** cannot be read from the journal file an error code is returned.
  47576. */
  47577. static int readJournalHdr(
  47578. Pager *pPager, /* Pager object */
  47579. int isHot,
  47580. i64 journalSize, /* Size of the open journal file in bytes */
  47581. u32 *pNRec, /* OUT: Value read from the nRec field */
  47582. u32 *pDbSize /* OUT: Value of original database size field */
  47583. ){
  47584. int rc; /* Return code */
  47585. unsigned char aMagic[8]; /* A buffer to hold the magic header */
  47586. i64 iHdrOff; /* Offset of journal header being read */
  47587. assert( isOpen(pPager->jfd) ); /* Journal file must be open. */
  47588. /* Advance Pager.journalOff to the start of the next sector. If the
  47589. ** journal file is too small for there to be a header stored at this
  47590. ** point, return SQLITE_DONE.
  47591. */
  47592. pPager->journalOff = journalHdrOffset(pPager);
  47593. if( pPager->journalOff+JOURNAL_HDR_SZ(pPager) > journalSize ){
  47594. return SQLITE_DONE;
  47595. }
  47596. iHdrOff = pPager->journalOff;
  47597. /* Read in the first 8 bytes of the journal header. If they do not match
  47598. ** the magic string found at the start of each journal header, return
  47599. ** SQLITE_DONE. If an IO error occurs, return an error code. Otherwise,
  47600. ** proceed.
  47601. */
  47602. if( isHot || iHdrOff!=pPager->journalHdr ){
  47603. rc = sqlite3OsRead(pPager->jfd, aMagic, sizeof(aMagic), iHdrOff);
  47604. if( rc ){
  47605. return rc;
  47606. }
  47607. if( memcmp(aMagic, aJournalMagic, sizeof(aMagic))!=0 ){
  47608. return SQLITE_DONE;
  47609. }
  47610. }
  47611. /* Read the first three 32-bit fields of the journal header: The nRec
  47612. ** field, the checksum-initializer and the database size at the start
  47613. ** of the transaction. Return an error code if anything goes wrong.
  47614. */
  47615. if( SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+8, pNRec))
  47616. || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+12, &pPager->cksumInit))
  47617. || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+16, pDbSize))
  47618. ){
  47619. return rc;
  47620. }
  47621. if( pPager->journalOff==0 ){
  47622. u32 iPageSize; /* Page-size field of journal header */
  47623. u32 iSectorSize; /* Sector-size field of journal header */
  47624. /* Read the page-size and sector-size journal header fields. */
  47625. if( SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+20, &iSectorSize))
  47626. || SQLITE_OK!=(rc = read32bits(pPager->jfd, iHdrOff+24, &iPageSize))
  47627. ){
  47628. return rc;
  47629. }
  47630. /* Versions of SQLite prior to 3.5.8 set the page-size field of the
  47631. ** journal header to zero. In this case, assume that the Pager.pageSize
  47632. ** variable is already set to the correct page size.
  47633. */
  47634. if( iPageSize==0 ){
  47635. iPageSize = pPager->pageSize;
  47636. }
  47637. /* Check that the values read from the page-size and sector-size fields
  47638. ** are within range. To be 'in range', both values need to be a power
  47639. ** of two greater than or equal to 512 or 32, and not greater than their
  47640. ** respective compile time maximum limits.
  47641. */
  47642. if( iPageSize<512 || iSectorSize<32
  47643. || iPageSize>SQLITE_MAX_PAGE_SIZE || iSectorSize>MAX_SECTOR_SIZE
  47644. || ((iPageSize-1)&iPageSize)!=0 || ((iSectorSize-1)&iSectorSize)!=0
  47645. ){
  47646. /* If the either the page-size or sector-size in the journal-header is
  47647. ** invalid, then the process that wrote the journal-header must have
  47648. ** crashed before the header was synced. In this case stop reading
  47649. ** the journal file here.
  47650. */
  47651. return SQLITE_DONE;
  47652. }
  47653. /* Update the page-size to match the value read from the journal.
  47654. ** Use a testcase() macro to make sure that malloc failure within
  47655. ** PagerSetPagesize() is tested.
  47656. */
  47657. rc = sqlite3PagerSetPagesize(pPager, &iPageSize, -1);
  47658. testcase( rc!=SQLITE_OK );
  47659. /* Update the assumed sector-size to match the value used by
  47660. ** the process that created this journal. If this journal was
  47661. ** created by a process other than this one, then this routine
  47662. ** is being called from within pager_playback(). The local value
  47663. ** of Pager.sectorSize is restored at the end of that routine.
  47664. */
  47665. pPager->sectorSize = iSectorSize;
  47666. }
  47667. pPager->journalOff += JOURNAL_HDR_SZ(pPager);
  47668. return rc;
  47669. }
  47670. /*
  47671. ** Write the supplied master journal name into the journal file for pager
  47672. ** pPager at the current location. The master journal name must be the last
  47673. ** thing written to a journal file. If the pager is in full-sync mode, the
  47674. ** journal file descriptor is advanced to the next sector boundary before
  47675. ** anything is written. The format is:
  47676. **
  47677. ** + 4 bytes: PAGER_MJ_PGNO.
  47678. ** + N bytes: Master journal filename in utf-8.
  47679. ** + 4 bytes: N (length of master journal name in bytes, no nul-terminator).
  47680. ** + 4 bytes: Master journal name checksum.
  47681. ** + 8 bytes: aJournalMagic[].
  47682. **
  47683. ** The master journal page checksum is the sum of the bytes in the master
  47684. ** journal name, where each byte is interpreted as a signed 8-bit integer.
  47685. **
  47686. ** If zMaster is a NULL pointer (occurs for a single database transaction),
  47687. ** this call is a no-op.
  47688. */
  47689. static int writeMasterJournal(Pager *pPager, const char *zMaster){
  47690. int rc; /* Return code */
  47691. int nMaster; /* Length of string zMaster */
  47692. i64 iHdrOff; /* Offset of header in journal file */
  47693. i64 jrnlSize; /* Size of journal file on disk */
  47694. u32 cksum = 0; /* Checksum of string zMaster */
  47695. assert( pPager->setMaster==0 );
  47696. assert( !pagerUseWal(pPager) );
  47697. if( !zMaster
  47698. || pPager->journalMode==PAGER_JOURNALMODE_MEMORY
  47699. || !isOpen(pPager->jfd)
  47700. ){
  47701. return SQLITE_OK;
  47702. }
  47703. pPager->setMaster = 1;
  47704. assert( pPager->journalHdr <= pPager->journalOff );
  47705. /* Calculate the length in bytes and the checksum of zMaster */
  47706. for(nMaster=0; zMaster[nMaster]; nMaster++){
  47707. cksum += zMaster[nMaster];
  47708. }
  47709. /* If in full-sync mode, advance to the next disk sector before writing
  47710. ** the master journal name. This is in case the previous page written to
  47711. ** the journal has already been synced.
  47712. */
  47713. if( pPager->fullSync ){
  47714. pPager->journalOff = journalHdrOffset(pPager);
  47715. }
  47716. iHdrOff = pPager->journalOff;
  47717. /* Write the master journal data to the end of the journal file. If
  47718. ** an error occurs, return the error code to the caller.
  47719. */
  47720. if( (0 != (rc = write32bits(pPager->jfd, iHdrOff, PAGER_MJ_PGNO(pPager))))
  47721. || (0 != (rc = sqlite3OsWrite(pPager->jfd, zMaster, nMaster, iHdrOff+4)))
  47722. || (0 != (rc = write32bits(pPager->jfd, iHdrOff+4+nMaster, nMaster)))
  47723. || (0 != (rc = write32bits(pPager->jfd, iHdrOff+4+nMaster+4, cksum)))
  47724. || (0 != (rc = sqlite3OsWrite(pPager->jfd, aJournalMagic, 8,
  47725. iHdrOff+4+nMaster+8)))
  47726. ){
  47727. return rc;
  47728. }
  47729. pPager->journalOff += (nMaster+20);
  47730. /* If the pager is in peristent-journal mode, then the physical
  47731. ** journal-file may extend past the end of the master-journal name
  47732. ** and 8 bytes of magic data just written to the file. This is
  47733. ** dangerous because the code to rollback a hot-journal file
  47734. ** will not be able to find the master-journal name to determine
  47735. ** whether or not the journal is hot.
  47736. **
  47737. ** Easiest thing to do in this scenario is to truncate the journal
  47738. ** file to the required size.
  47739. */
  47740. if( SQLITE_OK==(rc = sqlite3OsFileSize(pPager->jfd, &jrnlSize))
  47741. && jrnlSize>pPager->journalOff
  47742. ){
  47743. rc = sqlite3OsTruncate(pPager->jfd, pPager->journalOff);
  47744. }
  47745. return rc;
  47746. }
  47747. /*
  47748. ** Discard the entire contents of the in-memory page-cache.
  47749. */
  47750. static void pager_reset(Pager *pPager){
  47751. pPager->iDataVersion++;
  47752. sqlite3BackupRestart(pPager->pBackup);
  47753. sqlite3PcacheClear(pPager->pPCache);
  47754. }
  47755. /*
  47756. ** Return the pPager->iDataVersion value
  47757. */
  47758. SQLITE_PRIVATE u32 sqlite3PagerDataVersion(Pager *pPager){
  47759. assert( pPager->eState>PAGER_OPEN );
  47760. return pPager->iDataVersion;
  47761. }
  47762. /*
  47763. ** Free all structures in the Pager.aSavepoint[] array and set both
  47764. ** Pager.aSavepoint and Pager.nSavepoint to zero. Close the sub-journal
  47765. ** if it is open and the pager is not in exclusive mode.
  47766. */
  47767. static void releaseAllSavepoints(Pager *pPager){
  47768. int ii; /* Iterator for looping through Pager.aSavepoint */
  47769. for(ii=0; ii<pPager->nSavepoint; ii++){
  47770. sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
  47771. }
  47772. if( !pPager->exclusiveMode || sqlite3JournalIsInMemory(pPager->sjfd) ){
  47773. sqlite3OsClose(pPager->sjfd);
  47774. }
  47775. sqlite3_free(pPager->aSavepoint);
  47776. pPager->aSavepoint = 0;
  47777. pPager->nSavepoint = 0;
  47778. pPager->nSubRec = 0;
  47779. }
  47780. /*
  47781. ** Set the bit number pgno in the PagerSavepoint.pInSavepoint
  47782. ** bitvecs of all open savepoints. Return SQLITE_OK if successful
  47783. ** or SQLITE_NOMEM if a malloc failure occurs.
  47784. */
  47785. static int addToSavepointBitvecs(Pager *pPager, Pgno pgno){
  47786. int ii; /* Loop counter */
  47787. int rc = SQLITE_OK; /* Result code */
  47788. for(ii=0; ii<pPager->nSavepoint; ii++){
  47789. PagerSavepoint *p = &pPager->aSavepoint[ii];
  47790. if( pgno<=p->nOrig ){
  47791. rc |= sqlite3BitvecSet(p->pInSavepoint, pgno);
  47792. testcase( rc==SQLITE_NOMEM );
  47793. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  47794. }
  47795. }
  47796. return rc;
  47797. }
  47798. /*
  47799. ** This function is a no-op if the pager is in exclusive mode and not
  47800. ** in the ERROR state. Otherwise, it switches the pager to PAGER_OPEN
  47801. ** state.
  47802. **
  47803. ** If the pager is not in exclusive-access mode, the database file is
  47804. ** completely unlocked. If the file is unlocked and the file-system does
  47805. ** not exhibit the UNDELETABLE_WHEN_OPEN property, the journal file is
  47806. ** closed (if it is open).
  47807. **
  47808. ** If the pager is in ERROR state when this function is called, the
  47809. ** contents of the pager cache are discarded before switching back to
  47810. ** the OPEN state. Regardless of whether the pager is in exclusive-mode
  47811. ** or not, any journal file left in the file-system will be treated
  47812. ** as a hot-journal and rolled back the next time a read-transaction
  47813. ** is opened (by this or by any other connection).
  47814. */
  47815. static void pager_unlock(Pager *pPager){
  47816. assert( pPager->eState==PAGER_READER
  47817. || pPager->eState==PAGER_OPEN
  47818. || pPager->eState==PAGER_ERROR
  47819. );
  47820. sqlite3BitvecDestroy(pPager->pInJournal);
  47821. pPager->pInJournal = 0;
  47822. releaseAllSavepoints(pPager);
  47823. if( pagerUseWal(pPager) ){
  47824. assert( !isOpen(pPager->jfd) );
  47825. sqlite3WalEndReadTransaction(pPager->pWal);
  47826. pPager->eState = PAGER_OPEN;
  47827. }else if( !pPager->exclusiveMode ){
  47828. int rc; /* Error code returned by pagerUnlockDb() */
  47829. int iDc = isOpen(pPager->fd)?sqlite3OsDeviceCharacteristics(pPager->fd):0;
  47830. /* If the operating system support deletion of open files, then
  47831. ** close the journal file when dropping the database lock. Otherwise
  47832. ** another connection with journal_mode=delete might delete the file
  47833. ** out from under us.
  47834. */
  47835. assert( (PAGER_JOURNALMODE_MEMORY & 5)!=1 );
  47836. assert( (PAGER_JOURNALMODE_OFF & 5)!=1 );
  47837. assert( (PAGER_JOURNALMODE_WAL & 5)!=1 );
  47838. assert( (PAGER_JOURNALMODE_DELETE & 5)!=1 );
  47839. assert( (PAGER_JOURNALMODE_TRUNCATE & 5)==1 );
  47840. assert( (PAGER_JOURNALMODE_PERSIST & 5)==1 );
  47841. if( 0==(iDc & SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN)
  47842. || 1!=(pPager->journalMode & 5)
  47843. ){
  47844. sqlite3OsClose(pPager->jfd);
  47845. }
  47846. /* If the pager is in the ERROR state and the call to unlock the database
  47847. ** file fails, set the current lock to UNKNOWN_LOCK. See the comment
  47848. ** above the #define for UNKNOWN_LOCK for an explanation of why this
  47849. ** is necessary.
  47850. */
  47851. rc = pagerUnlockDb(pPager, NO_LOCK);
  47852. if( rc!=SQLITE_OK && pPager->eState==PAGER_ERROR ){
  47853. pPager->eLock = UNKNOWN_LOCK;
  47854. }
  47855. /* The pager state may be changed from PAGER_ERROR to PAGER_OPEN here
  47856. ** without clearing the error code. This is intentional - the error
  47857. ** code is cleared and the cache reset in the block below.
  47858. */
  47859. assert( pPager->errCode || pPager->eState!=PAGER_ERROR );
  47860. pPager->changeCountDone = 0;
  47861. pPager->eState = PAGER_OPEN;
  47862. }
  47863. /* If Pager.errCode is set, the contents of the pager cache cannot be
  47864. ** trusted. Now that there are no outstanding references to the pager,
  47865. ** it can safely move back to PAGER_OPEN state. This happens in both
  47866. ** normal and exclusive-locking mode.
  47867. */
  47868. assert( pPager->errCode==SQLITE_OK || !MEMDB );
  47869. if( pPager->errCode ){
  47870. if( pPager->tempFile==0 ){
  47871. pager_reset(pPager);
  47872. pPager->changeCountDone = 0;
  47873. pPager->eState = PAGER_OPEN;
  47874. }else{
  47875. pPager->eState = (isOpen(pPager->jfd) ? PAGER_OPEN : PAGER_READER);
  47876. }
  47877. if( USEFETCH(pPager) ) sqlite3OsUnfetch(pPager->fd, 0, 0);
  47878. pPager->errCode = SQLITE_OK;
  47879. setGetterMethod(pPager);
  47880. }
  47881. pPager->journalOff = 0;
  47882. pPager->journalHdr = 0;
  47883. pPager->setMaster = 0;
  47884. }
  47885. /*
  47886. ** This function is called whenever an IOERR or FULL error that requires
  47887. ** the pager to transition into the ERROR state may ahve occurred.
  47888. ** The first argument is a pointer to the pager structure, the second
  47889. ** the error-code about to be returned by a pager API function. The
  47890. ** value returned is a copy of the second argument to this function.
  47891. **
  47892. ** If the second argument is SQLITE_FULL, SQLITE_IOERR or one of the
  47893. ** IOERR sub-codes, the pager enters the ERROR state and the error code
  47894. ** is stored in Pager.errCode. While the pager remains in the ERROR state,
  47895. ** all major API calls on the Pager will immediately return Pager.errCode.
  47896. **
  47897. ** The ERROR state indicates that the contents of the pager-cache
  47898. ** cannot be trusted. This state can be cleared by completely discarding
  47899. ** the contents of the pager-cache. If a transaction was active when
  47900. ** the persistent error occurred, then the rollback journal may need
  47901. ** to be replayed to restore the contents of the database file (as if
  47902. ** it were a hot-journal).
  47903. */
  47904. static int pager_error(Pager *pPager, int rc){
  47905. int rc2 = rc & 0xff;
  47906. assert( rc==SQLITE_OK || !MEMDB );
  47907. assert(
  47908. pPager->errCode==SQLITE_FULL ||
  47909. pPager->errCode==SQLITE_OK ||
  47910. (pPager->errCode & 0xff)==SQLITE_IOERR
  47911. );
  47912. if( rc2==SQLITE_FULL || rc2==SQLITE_IOERR ){
  47913. pPager->errCode = rc;
  47914. pPager->eState = PAGER_ERROR;
  47915. setGetterMethod(pPager);
  47916. }
  47917. return rc;
  47918. }
  47919. static int pager_truncate(Pager *pPager, Pgno nPage);
  47920. /*
  47921. ** The write transaction open on pPager is being committed (bCommit==1)
  47922. ** or rolled back (bCommit==0).
  47923. **
  47924. ** Return TRUE if and only if all dirty pages should be flushed to disk.
  47925. **
  47926. ** Rules:
  47927. **
  47928. ** * For non-TEMP databases, always sync to disk. This is necessary
  47929. ** for transactions to be durable.
  47930. **
  47931. ** * Sync TEMP database only on a COMMIT (not a ROLLBACK) when the backing
  47932. ** file has been created already (via a spill on pagerStress()) and
  47933. ** when the number of dirty pages in memory exceeds 25% of the total
  47934. ** cache size.
  47935. */
  47936. static int pagerFlushOnCommit(Pager *pPager, int bCommit){
  47937. if( pPager->tempFile==0 ) return 1;
  47938. if( !bCommit ) return 0;
  47939. if( !isOpen(pPager->fd) ) return 0;
  47940. return (sqlite3PCachePercentDirty(pPager->pPCache)>=25);
  47941. }
  47942. /*
  47943. ** This routine ends a transaction. A transaction is usually ended by
  47944. ** either a COMMIT or a ROLLBACK operation. This routine may be called
  47945. ** after rollback of a hot-journal, or if an error occurs while opening
  47946. ** the journal file or writing the very first journal-header of a
  47947. ** database transaction.
  47948. **
  47949. ** This routine is never called in PAGER_ERROR state. If it is called
  47950. ** in PAGER_NONE or PAGER_SHARED state and the lock held is less
  47951. ** exclusive than a RESERVED lock, it is a no-op.
  47952. **
  47953. ** Otherwise, any active savepoints are released.
  47954. **
  47955. ** If the journal file is open, then it is "finalized". Once a journal
  47956. ** file has been finalized it is not possible to use it to roll back a
  47957. ** transaction. Nor will it be considered to be a hot-journal by this
  47958. ** or any other database connection. Exactly how a journal is finalized
  47959. ** depends on whether or not the pager is running in exclusive mode and
  47960. ** the current journal-mode (Pager.journalMode value), as follows:
  47961. **
  47962. ** journalMode==MEMORY
  47963. ** Journal file descriptor is simply closed. This destroys an
  47964. ** in-memory journal.
  47965. **
  47966. ** journalMode==TRUNCATE
  47967. ** Journal file is truncated to zero bytes in size.
  47968. **
  47969. ** journalMode==PERSIST
  47970. ** The first 28 bytes of the journal file are zeroed. This invalidates
  47971. ** the first journal header in the file, and hence the entire journal
  47972. ** file. An invalid journal file cannot be rolled back.
  47973. **
  47974. ** journalMode==DELETE
  47975. ** The journal file is closed and deleted using sqlite3OsDelete().
  47976. **
  47977. ** If the pager is running in exclusive mode, this method of finalizing
  47978. ** the journal file is never used. Instead, if the journalMode is
  47979. ** DELETE and the pager is in exclusive mode, the method described under
  47980. ** journalMode==PERSIST is used instead.
  47981. **
  47982. ** After the journal is finalized, the pager moves to PAGER_READER state.
  47983. ** If running in non-exclusive rollback mode, the lock on the file is
  47984. ** downgraded to a SHARED_LOCK.
  47985. **
  47986. ** SQLITE_OK is returned if no error occurs. If an error occurs during
  47987. ** any of the IO operations to finalize the journal file or unlock the
  47988. ** database then the IO error code is returned to the user. If the
  47989. ** operation to finalize the journal file fails, then the code still
  47990. ** tries to unlock the database file if not in exclusive mode. If the
  47991. ** unlock operation fails as well, then the first error code related
  47992. ** to the first error encountered (the journal finalization one) is
  47993. ** returned.
  47994. */
  47995. static int pager_end_transaction(Pager *pPager, int hasMaster, int bCommit){
  47996. int rc = SQLITE_OK; /* Error code from journal finalization operation */
  47997. int rc2 = SQLITE_OK; /* Error code from db file unlock operation */
  47998. /* Do nothing if the pager does not have an open write transaction
  47999. ** or at least a RESERVED lock. This function may be called when there
  48000. ** is no write-transaction active but a RESERVED or greater lock is
  48001. ** held under two circumstances:
  48002. **
  48003. ** 1. After a successful hot-journal rollback, it is called with
  48004. ** eState==PAGER_NONE and eLock==EXCLUSIVE_LOCK.
  48005. **
  48006. ** 2. If a connection with locking_mode=exclusive holding an EXCLUSIVE
  48007. ** lock switches back to locking_mode=normal and then executes a
  48008. ** read-transaction, this function is called with eState==PAGER_READER
  48009. ** and eLock==EXCLUSIVE_LOCK when the read-transaction is closed.
  48010. */
  48011. assert( assert_pager_state(pPager) );
  48012. assert( pPager->eState!=PAGER_ERROR );
  48013. if( pPager->eState<PAGER_WRITER_LOCKED && pPager->eLock<RESERVED_LOCK ){
  48014. return SQLITE_OK;
  48015. }
  48016. releaseAllSavepoints(pPager);
  48017. assert( isOpen(pPager->jfd) || pPager->pInJournal==0
  48018. || (sqlite3OsDeviceCharacteristics(pPager->fd)&SQLITE_IOCAP_BATCH_ATOMIC)
  48019. );
  48020. if( isOpen(pPager->jfd) ){
  48021. assert( !pagerUseWal(pPager) );
  48022. /* Finalize the journal file. */
  48023. if( sqlite3JournalIsInMemory(pPager->jfd) ){
  48024. /* assert( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ); */
  48025. sqlite3OsClose(pPager->jfd);
  48026. }else if( pPager->journalMode==PAGER_JOURNALMODE_TRUNCATE ){
  48027. if( pPager->journalOff==0 ){
  48028. rc = SQLITE_OK;
  48029. }else{
  48030. rc = sqlite3OsTruncate(pPager->jfd, 0);
  48031. if( rc==SQLITE_OK && pPager->fullSync ){
  48032. /* Make sure the new file size is written into the inode right away.
  48033. ** Otherwise the journal might resurrect following a power loss and
  48034. ** cause the last transaction to roll back. See
  48035. ** https://bugzilla.mozilla.org/show_bug.cgi?id=1072773
  48036. */
  48037. rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags);
  48038. }
  48039. }
  48040. pPager->journalOff = 0;
  48041. }else if( pPager->journalMode==PAGER_JOURNALMODE_PERSIST
  48042. || (pPager->exclusiveMode && pPager->journalMode!=PAGER_JOURNALMODE_WAL)
  48043. ){
  48044. rc = zeroJournalHdr(pPager, hasMaster||pPager->tempFile);
  48045. pPager->journalOff = 0;
  48046. }else{
  48047. /* This branch may be executed with Pager.journalMode==MEMORY if
  48048. ** a hot-journal was just rolled back. In this case the journal
  48049. ** file should be closed and deleted. If this connection writes to
  48050. ** the database file, it will do so using an in-memory journal.
  48051. */
  48052. int bDelete = !pPager->tempFile;
  48053. assert( sqlite3JournalIsInMemory(pPager->jfd)==0 );
  48054. assert( pPager->journalMode==PAGER_JOURNALMODE_DELETE
  48055. || pPager->journalMode==PAGER_JOURNALMODE_MEMORY
  48056. || pPager->journalMode==PAGER_JOURNALMODE_WAL
  48057. );
  48058. sqlite3OsClose(pPager->jfd);
  48059. if( bDelete ){
  48060. rc = sqlite3OsDelete(pPager->pVfs, pPager->zJournal, pPager->extraSync);
  48061. }
  48062. }
  48063. }
  48064. #ifdef SQLITE_CHECK_PAGES
  48065. sqlite3PcacheIterateDirty(pPager->pPCache, pager_set_pagehash);
  48066. if( pPager->dbSize==0 && sqlite3PcacheRefCount(pPager->pPCache)>0 ){
  48067. PgHdr *p = sqlite3PagerLookup(pPager, 1);
  48068. if( p ){
  48069. p->pageHash = 0;
  48070. sqlite3PagerUnrefNotNull(p);
  48071. }
  48072. }
  48073. #endif
  48074. sqlite3BitvecDestroy(pPager->pInJournal);
  48075. pPager->pInJournal = 0;
  48076. pPager->nRec = 0;
  48077. if( rc==SQLITE_OK ){
  48078. if( MEMDB || pagerFlushOnCommit(pPager, bCommit) ){
  48079. sqlite3PcacheCleanAll(pPager->pPCache);
  48080. }else{
  48081. sqlite3PcacheClearWritable(pPager->pPCache);
  48082. }
  48083. sqlite3PcacheTruncate(pPager->pPCache, pPager->dbSize);
  48084. }
  48085. if( pagerUseWal(pPager) ){
  48086. /* Drop the WAL write-lock, if any. Also, if the connection was in
  48087. ** locking_mode=exclusive mode but is no longer, drop the EXCLUSIVE
  48088. ** lock held on the database file.
  48089. */
  48090. rc2 = sqlite3WalEndWriteTransaction(pPager->pWal);
  48091. assert( rc2==SQLITE_OK );
  48092. }else if( rc==SQLITE_OK && bCommit && pPager->dbFileSize>pPager->dbSize ){
  48093. /* This branch is taken when committing a transaction in rollback-journal
  48094. ** mode if the database file on disk is larger than the database image.
  48095. ** At this point the journal has been finalized and the transaction
  48096. ** successfully committed, but the EXCLUSIVE lock is still held on the
  48097. ** file. So it is safe to truncate the database file to its minimum
  48098. ** required size. */
  48099. assert( pPager->eLock==EXCLUSIVE_LOCK );
  48100. rc = pager_truncate(pPager, pPager->dbSize);
  48101. }
  48102. if( rc==SQLITE_OK && bCommit ){
  48103. rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_COMMIT_PHASETWO, 0);
  48104. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  48105. }
  48106. if( !pPager->exclusiveMode
  48107. && (!pagerUseWal(pPager) || sqlite3WalExclusiveMode(pPager->pWal, 0))
  48108. ){
  48109. rc2 = pagerUnlockDb(pPager, SHARED_LOCK);
  48110. pPager->changeCountDone = 0;
  48111. }
  48112. pPager->eState = PAGER_READER;
  48113. pPager->setMaster = 0;
  48114. return (rc==SQLITE_OK?rc2:rc);
  48115. }
  48116. /*
  48117. ** Execute a rollback if a transaction is active and unlock the
  48118. ** database file.
  48119. **
  48120. ** If the pager has already entered the ERROR state, do not attempt
  48121. ** the rollback at this time. Instead, pager_unlock() is called. The
  48122. ** call to pager_unlock() will discard all in-memory pages, unlock
  48123. ** the database file and move the pager back to OPEN state. If this
  48124. ** means that there is a hot-journal left in the file-system, the next
  48125. ** connection to obtain a shared lock on the pager (which may be this one)
  48126. ** will roll it back.
  48127. **
  48128. ** If the pager has not already entered the ERROR state, but an IO or
  48129. ** malloc error occurs during a rollback, then this will itself cause
  48130. ** the pager to enter the ERROR state. Which will be cleared by the
  48131. ** call to pager_unlock(), as described above.
  48132. */
  48133. static void pagerUnlockAndRollback(Pager *pPager){
  48134. if( pPager->eState!=PAGER_ERROR && pPager->eState!=PAGER_OPEN ){
  48135. assert( assert_pager_state(pPager) );
  48136. if( pPager->eState>=PAGER_WRITER_LOCKED ){
  48137. sqlite3BeginBenignMalloc();
  48138. sqlite3PagerRollback(pPager);
  48139. sqlite3EndBenignMalloc();
  48140. }else if( !pPager->exclusiveMode ){
  48141. assert( pPager->eState==PAGER_READER );
  48142. pager_end_transaction(pPager, 0, 0);
  48143. }
  48144. }
  48145. pager_unlock(pPager);
  48146. }
  48147. /*
  48148. ** Parameter aData must point to a buffer of pPager->pageSize bytes
  48149. ** of data. Compute and return a checksum based ont the contents of the
  48150. ** page of data and the current value of pPager->cksumInit.
  48151. **
  48152. ** This is not a real checksum. It is really just the sum of the
  48153. ** random initial value (pPager->cksumInit) and every 200th byte
  48154. ** of the page data, starting with byte offset (pPager->pageSize%200).
  48155. ** Each byte is interpreted as an 8-bit unsigned integer.
  48156. **
  48157. ** Changing the formula used to compute this checksum results in an
  48158. ** incompatible journal file format.
  48159. **
  48160. ** If journal corruption occurs due to a power failure, the most likely
  48161. ** scenario is that one end or the other of the record will be changed.
  48162. ** It is much less likely that the two ends of the journal record will be
  48163. ** correct and the middle be corrupt. Thus, this "checksum" scheme,
  48164. ** though fast and simple, catches the mostly likely kind of corruption.
  48165. */
  48166. static u32 pager_cksum(Pager *pPager, const u8 *aData){
  48167. u32 cksum = pPager->cksumInit; /* Checksum value to return */
  48168. int i = pPager->pageSize-200; /* Loop counter */
  48169. while( i>0 ){
  48170. cksum += aData[i];
  48171. i -= 200;
  48172. }
  48173. return cksum;
  48174. }
  48175. /*
  48176. ** Report the current page size and number of reserved bytes back
  48177. ** to the codec.
  48178. */
  48179. #ifdef SQLITE_HAS_CODEC
  48180. static void pagerReportSize(Pager *pPager){
  48181. if( pPager->xCodecSizeChng ){
  48182. pPager->xCodecSizeChng(pPager->pCodec, pPager->pageSize,
  48183. (int)pPager->nReserve);
  48184. }
  48185. }
  48186. #else
  48187. # define pagerReportSize(X) /* No-op if we do not support a codec */
  48188. #endif
  48189. #ifdef SQLITE_HAS_CODEC
  48190. /*
  48191. ** Make sure the number of reserved bits is the same in the destination
  48192. ** pager as it is in the source. This comes up when a VACUUM changes the
  48193. ** number of reserved bits to the "optimal" amount.
  48194. */
  48195. SQLITE_PRIVATE void sqlite3PagerAlignReserve(Pager *pDest, Pager *pSrc){
  48196. if( pDest->nReserve!=pSrc->nReserve ){
  48197. pDest->nReserve = pSrc->nReserve;
  48198. pagerReportSize(pDest);
  48199. }
  48200. }
  48201. #endif
  48202. /*
  48203. ** Read a single page from either the journal file (if isMainJrnl==1) or
  48204. ** from the sub-journal (if isMainJrnl==0) and playback that page.
  48205. ** The page begins at offset *pOffset into the file. The *pOffset
  48206. ** value is increased to the start of the next page in the journal.
  48207. **
  48208. ** The main rollback journal uses checksums - the statement journal does
  48209. ** not.
  48210. **
  48211. ** If the page number of the page record read from the (sub-)journal file
  48212. ** is greater than the current value of Pager.dbSize, then playback is
  48213. ** skipped and SQLITE_OK is returned.
  48214. **
  48215. ** If pDone is not NULL, then it is a record of pages that have already
  48216. ** been played back. If the page at *pOffset has already been played back
  48217. ** (if the corresponding pDone bit is set) then skip the playback.
  48218. ** Make sure the pDone bit corresponding to the *pOffset page is set
  48219. ** prior to returning.
  48220. **
  48221. ** If the page record is successfully read from the (sub-)journal file
  48222. ** and played back, then SQLITE_OK is returned. If an IO error occurs
  48223. ** while reading the record from the (sub-)journal file or while writing
  48224. ** to the database file, then the IO error code is returned. If data
  48225. ** is successfully read from the (sub-)journal file but appears to be
  48226. ** corrupted, SQLITE_DONE is returned. Data is considered corrupted in
  48227. ** two circumstances:
  48228. **
  48229. ** * If the record page-number is illegal (0 or PAGER_MJ_PGNO), or
  48230. ** * If the record is being rolled back from the main journal file
  48231. ** and the checksum field does not match the record content.
  48232. **
  48233. ** Neither of these two scenarios are possible during a savepoint rollback.
  48234. **
  48235. ** If this is a savepoint rollback, then memory may have to be dynamically
  48236. ** allocated by this function. If this is the case and an allocation fails,
  48237. ** SQLITE_NOMEM is returned.
  48238. */
  48239. static int pager_playback_one_page(
  48240. Pager *pPager, /* The pager being played back */
  48241. i64 *pOffset, /* Offset of record to playback */
  48242. Bitvec *pDone, /* Bitvec of pages already played back */
  48243. int isMainJrnl, /* 1 -> main journal. 0 -> sub-journal. */
  48244. int isSavepnt /* True for a savepoint rollback */
  48245. ){
  48246. int rc;
  48247. PgHdr *pPg; /* An existing page in the cache */
  48248. Pgno pgno; /* The page number of a page in journal */
  48249. u32 cksum; /* Checksum used for sanity checking */
  48250. char *aData; /* Temporary storage for the page */
  48251. sqlite3_file *jfd; /* The file descriptor for the journal file */
  48252. int isSynced; /* True if journal page is synced */
  48253. #ifdef SQLITE_HAS_CODEC
  48254. /* The jrnlEnc flag is true if Journal pages should be passed through
  48255. ** the codec. It is false for pure in-memory journals. */
  48256. const int jrnlEnc = (isMainJrnl || pPager->subjInMemory==0);
  48257. #endif
  48258. assert( (isMainJrnl&~1)==0 ); /* isMainJrnl is 0 or 1 */
  48259. assert( (isSavepnt&~1)==0 ); /* isSavepnt is 0 or 1 */
  48260. assert( isMainJrnl || pDone ); /* pDone always used on sub-journals */
  48261. assert( isSavepnt || pDone==0 ); /* pDone never used on non-savepoint */
  48262. aData = pPager->pTmpSpace;
  48263. assert( aData ); /* Temp storage must have already been allocated */
  48264. assert( pagerUseWal(pPager)==0 || (!isMainJrnl && isSavepnt) );
  48265. /* Either the state is greater than PAGER_WRITER_CACHEMOD (a transaction
  48266. ** or savepoint rollback done at the request of the caller) or this is
  48267. ** a hot-journal rollback. If it is a hot-journal rollback, the pager
  48268. ** is in state OPEN and holds an EXCLUSIVE lock. Hot-journal rollback
  48269. ** only reads from the main journal, not the sub-journal.
  48270. */
  48271. assert( pPager->eState>=PAGER_WRITER_CACHEMOD
  48272. || (pPager->eState==PAGER_OPEN && pPager->eLock==EXCLUSIVE_LOCK)
  48273. );
  48274. assert( pPager->eState>=PAGER_WRITER_CACHEMOD || isMainJrnl );
  48275. /* Read the page number and page data from the journal or sub-journal
  48276. ** file. Return an error code to the caller if an IO error occurs.
  48277. */
  48278. jfd = isMainJrnl ? pPager->jfd : pPager->sjfd;
  48279. rc = read32bits(jfd, *pOffset, &pgno);
  48280. if( rc!=SQLITE_OK ) return rc;
  48281. rc = sqlite3OsRead(jfd, (u8*)aData, pPager->pageSize, (*pOffset)+4);
  48282. if( rc!=SQLITE_OK ) return rc;
  48283. *pOffset += pPager->pageSize + 4 + isMainJrnl*4;
  48284. /* Sanity checking on the page. This is more important that I originally
  48285. ** thought. If a power failure occurs while the journal is being written,
  48286. ** it could cause invalid data to be written into the journal. We need to
  48287. ** detect this invalid data (with high probability) and ignore it.
  48288. */
  48289. if( pgno==0 || pgno==PAGER_MJ_PGNO(pPager) ){
  48290. assert( !isSavepnt );
  48291. return SQLITE_DONE;
  48292. }
  48293. if( pgno>(Pgno)pPager->dbSize || sqlite3BitvecTest(pDone, pgno) ){
  48294. return SQLITE_OK;
  48295. }
  48296. if( isMainJrnl ){
  48297. rc = read32bits(jfd, (*pOffset)-4, &cksum);
  48298. if( rc ) return rc;
  48299. if( !isSavepnt && pager_cksum(pPager, (u8*)aData)!=cksum ){
  48300. return SQLITE_DONE;
  48301. }
  48302. }
  48303. /* If this page has already been played back before during the current
  48304. ** rollback, then don't bother to play it back again.
  48305. */
  48306. if( pDone && (rc = sqlite3BitvecSet(pDone, pgno))!=SQLITE_OK ){
  48307. return rc;
  48308. }
  48309. /* When playing back page 1, restore the nReserve setting
  48310. */
  48311. if( pgno==1 && pPager->nReserve!=((u8*)aData)[20] ){
  48312. pPager->nReserve = ((u8*)aData)[20];
  48313. pagerReportSize(pPager);
  48314. }
  48315. /* If the pager is in CACHEMOD state, then there must be a copy of this
  48316. ** page in the pager cache. In this case just update the pager cache,
  48317. ** not the database file. The page is left marked dirty in this case.
  48318. **
  48319. ** An exception to the above rule: If the database is in no-sync mode
  48320. ** and a page is moved during an incremental vacuum then the page may
  48321. ** not be in the pager cache. Later: if a malloc() or IO error occurs
  48322. ** during a Movepage() call, then the page may not be in the cache
  48323. ** either. So the condition described in the above paragraph is not
  48324. ** assert()able.
  48325. **
  48326. ** If in WRITER_DBMOD, WRITER_FINISHED or OPEN state, then we update the
  48327. ** pager cache if it exists and the main file. The page is then marked
  48328. ** not dirty. Since this code is only executed in PAGER_OPEN state for
  48329. ** a hot-journal rollback, it is guaranteed that the page-cache is empty
  48330. ** if the pager is in OPEN state.
  48331. **
  48332. ** Ticket #1171: The statement journal might contain page content that is
  48333. ** different from the page content at the start of the transaction.
  48334. ** This occurs when a page is changed prior to the start of a statement
  48335. ** then changed again within the statement. When rolling back such a
  48336. ** statement we must not write to the original database unless we know
  48337. ** for certain that original page contents are synced into the main rollback
  48338. ** journal. Otherwise, a power loss might leave modified data in the
  48339. ** database file without an entry in the rollback journal that can
  48340. ** restore the database to its original form. Two conditions must be
  48341. ** met before writing to the database files. (1) the database must be
  48342. ** locked. (2) we know that the original page content is fully synced
  48343. ** in the main journal either because the page is not in cache or else
  48344. ** the page is marked as needSync==0.
  48345. **
  48346. ** 2008-04-14: When attempting to vacuum a corrupt database file, it
  48347. ** is possible to fail a statement on a database that does not yet exist.
  48348. ** Do not attempt to write if database file has never been opened.
  48349. */
  48350. if( pagerUseWal(pPager) ){
  48351. pPg = 0;
  48352. }else{
  48353. pPg = sqlite3PagerLookup(pPager, pgno);
  48354. }
  48355. assert( pPg || !MEMDB );
  48356. assert( pPager->eState!=PAGER_OPEN || pPg==0 || pPager->tempFile );
  48357. PAGERTRACE(("PLAYBACK %d page %d hash(%08x) %s\n",
  48358. PAGERID(pPager), pgno, pager_datahash(pPager->pageSize, (u8*)aData),
  48359. (isMainJrnl?"main-journal":"sub-journal")
  48360. ));
  48361. if( isMainJrnl ){
  48362. isSynced = pPager->noSync || (*pOffset <= pPager->journalHdr);
  48363. }else{
  48364. isSynced = (pPg==0 || 0==(pPg->flags & PGHDR_NEED_SYNC));
  48365. }
  48366. if( isOpen(pPager->fd)
  48367. && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
  48368. && isSynced
  48369. ){
  48370. i64 ofst = (pgno-1)*(i64)pPager->pageSize;
  48371. testcase( !isSavepnt && pPg!=0 && (pPg->flags&PGHDR_NEED_SYNC)!=0 );
  48372. assert( !pagerUseWal(pPager) );
  48373. /* Write the data read from the journal back into the database file.
  48374. ** This is usually safe even for an encrypted database - as the data
  48375. ** was encrypted before it was written to the journal file. The exception
  48376. ** is if the data was just read from an in-memory sub-journal. In that
  48377. ** case it must be encrypted here before it is copied into the database
  48378. ** file. */
  48379. #ifdef SQLITE_HAS_CODEC
  48380. if( !jrnlEnc ){
  48381. CODEC2(pPager, aData, pgno, 7, rc=SQLITE_NOMEM_BKPT, aData);
  48382. rc = sqlite3OsWrite(pPager->fd, (u8 *)aData, pPager->pageSize, ofst);
  48383. CODEC1(pPager, aData, pgno, 3, rc=SQLITE_NOMEM_BKPT);
  48384. }else
  48385. #endif
  48386. rc = sqlite3OsWrite(pPager->fd, (u8 *)aData, pPager->pageSize, ofst);
  48387. if( pgno>pPager->dbFileSize ){
  48388. pPager->dbFileSize = pgno;
  48389. }
  48390. if( pPager->pBackup ){
  48391. #ifdef SQLITE_HAS_CODEC
  48392. if( jrnlEnc ){
  48393. CODEC1(pPager, aData, pgno, 3, rc=SQLITE_NOMEM_BKPT);
  48394. sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)aData);
  48395. CODEC2(pPager, aData, pgno, 7, rc=SQLITE_NOMEM_BKPT,aData);
  48396. }else
  48397. #endif
  48398. sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)aData);
  48399. }
  48400. }else if( !isMainJrnl && pPg==0 ){
  48401. /* If this is a rollback of a savepoint and data was not written to
  48402. ** the database and the page is not in-memory, there is a potential
  48403. ** problem. When the page is next fetched by the b-tree layer, it
  48404. ** will be read from the database file, which may or may not be
  48405. ** current.
  48406. **
  48407. ** There are a couple of different ways this can happen. All are quite
  48408. ** obscure. When running in synchronous mode, this can only happen
  48409. ** if the page is on the free-list at the start of the transaction, then
  48410. ** populated, then moved using sqlite3PagerMovepage().
  48411. **
  48412. ** The solution is to add an in-memory page to the cache containing
  48413. ** the data just read from the sub-journal. Mark the page as dirty
  48414. ** and if the pager requires a journal-sync, then mark the page as
  48415. ** requiring a journal-sync before it is written.
  48416. */
  48417. assert( isSavepnt );
  48418. assert( (pPager->doNotSpill & SPILLFLAG_ROLLBACK)==0 );
  48419. pPager->doNotSpill |= SPILLFLAG_ROLLBACK;
  48420. rc = sqlite3PagerGet(pPager, pgno, &pPg, 1);
  48421. assert( (pPager->doNotSpill & SPILLFLAG_ROLLBACK)!=0 );
  48422. pPager->doNotSpill &= ~SPILLFLAG_ROLLBACK;
  48423. if( rc!=SQLITE_OK ) return rc;
  48424. sqlite3PcacheMakeDirty(pPg);
  48425. }
  48426. if( pPg ){
  48427. /* No page should ever be explicitly rolled back that is in use, except
  48428. ** for page 1 which is held in use in order to keep the lock on the
  48429. ** database active. However such a page may be rolled back as a result
  48430. ** of an internal error resulting in an automatic call to
  48431. ** sqlite3PagerRollback().
  48432. */
  48433. void *pData;
  48434. pData = pPg->pData;
  48435. memcpy(pData, (u8*)aData, pPager->pageSize);
  48436. pPager->xReiniter(pPg);
  48437. /* It used to be that sqlite3PcacheMakeClean(pPg) was called here. But
  48438. ** that call was dangerous and had no detectable benefit since the cache
  48439. ** is normally cleaned by sqlite3PcacheCleanAll() after rollback and so
  48440. ** has been removed. */
  48441. pager_set_pagehash(pPg);
  48442. /* If this was page 1, then restore the value of Pager.dbFileVers.
  48443. ** Do this before any decoding. */
  48444. if( pgno==1 ){
  48445. memcpy(&pPager->dbFileVers, &((u8*)pData)[24],sizeof(pPager->dbFileVers));
  48446. }
  48447. /* Decode the page just read from disk */
  48448. #if SQLITE_HAS_CODEC
  48449. if( jrnlEnc ){ CODEC1(pPager, pData, pPg->pgno, 3, rc=SQLITE_NOMEM_BKPT); }
  48450. #endif
  48451. sqlite3PcacheRelease(pPg);
  48452. }
  48453. return rc;
  48454. }
  48455. /*
  48456. ** Parameter zMaster is the name of a master journal file. A single journal
  48457. ** file that referred to the master journal file has just been rolled back.
  48458. ** This routine checks if it is possible to delete the master journal file,
  48459. ** and does so if it is.
  48460. **
  48461. ** Argument zMaster may point to Pager.pTmpSpace. So that buffer is not
  48462. ** available for use within this function.
  48463. **
  48464. ** When a master journal file is created, it is populated with the names
  48465. ** of all of its child journals, one after another, formatted as utf-8
  48466. ** encoded text. The end of each child journal file is marked with a
  48467. ** nul-terminator byte (0x00). i.e. the entire contents of a master journal
  48468. ** file for a transaction involving two databases might be:
  48469. **
  48470. ** "/home/bill/a.db-journal\x00/home/bill/b.db-journal\x00"
  48471. **
  48472. ** A master journal file may only be deleted once all of its child
  48473. ** journals have been rolled back.
  48474. **
  48475. ** This function reads the contents of the master-journal file into
  48476. ** memory and loops through each of the child journal names. For
  48477. ** each child journal, it checks if:
  48478. **
  48479. ** * if the child journal exists, and if so
  48480. ** * if the child journal contains a reference to master journal
  48481. ** file zMaster
  48482. **
  48483. ** If a child journal can be found that matches both of the criteria
  48484. ** above, this function returns without doing anything. Otherwise, if
  48485. ** no such child journal can be found, file zMaster is deleted from
  48486. ** the file-system using sqlite3OsDelete().
  48487. **
  48488. ** If an IO error within this function, an error code is returned. This
  48489. ** function allocates memory by calling sqlite3Malloc(). If an allocation
  48490. ** fails, SQLITE_NOMEM is returned. Otherwise, if no IO or malloc errors
  48491. ** occur, SQLITE_OK is returned.
  48492. **
  48493. ** TODO: This function allocates a single block of memory to load
  48494. ** the entire contents of the master journal file. This could be
  48495. ** a couple of kilobytes or so - potentially larger than the page
  48496. ** size.
  48497. */
  48498. static int pager_delmaster(Pager *pPager, const char *zMaster){
  48499. sqlite3_vfs *pVfs = pPager->pVfs;
  48500. int rc; /* Return code */
  48501. sqlite3_file *pMaster; /* Malloc'd master-journal file descriptor */
  48502. sqlite3_file *pJournal; /* Malloc'd child-journal file descriptor */
  48503. char *zMasterJournal = 0; /* Contents of master journal file */
  48504. i64 nMasterJournal; /* Size of master journal file */
  48505. char *zJournal; /* Pointer to one journal within MJ file */
  48506. char *zMasterPtr; /* Space to hold MJ filename from a journal file */
  48507. int nMasterPtr; /* Amount of space allocated to zMasterPtr[] */
  48508. /* Allocate space for both the pJournal and pMaster file descriptors.
  48509. ** If successful, open the master journal file for reading.
  48510. */
  48511. pMaster = (sqlite3_file *)sqlite3MallocZero(pVfs->szOsFile * 2);
  48512. pJournal = (sqlite3_file *)(((u8 *)pMaster) + pVfs->szOsFile);
  48513. if( !pMaster ){
  48514. rc = SQLITE_NOMEM_BKPT;
  48515. }else{
  48516. const int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MASTER_JOURNAL);
  48517. rc = sqlite3OsOpen(pVfs, zMaster, pMaster, flags, 0);
  48518. }
  48519. if( rc!=SQLITE_OK ) goto delmaster_out;
  48520. /* Load the entire master journal file into space obtained from
  48521. ** sqlite3_malloc() and pointed to by zMasterJournal. Also obtain
  48522. ** sufficient space (in zMasterPtr) to hold the names of master
  48523. ** journal files extracted from regular rollback-journals.
  48524. */
  48525. rc = sqlite3OsFileSize(pMaster, &nMasterJournal);
  48526. if( rc!=SQLITE_OK ) goto delmaster_out;
  48527. nMasterPtr = pVfs->mxPathname+1;
  48528. zMasterJournal = sqlite3Malloc(nMasterJournal + nMasterPtr + 1);
  48529. if( !zMasterJournal ){
  48530. rc = SQLITE_NOMEM_BKPT;
  48531. goto delmaster_out;
  48532. }
  48533. zMasterPtr = &zMasterJournal[nMasterJournal+1];
  48534. rc = sqlite3OsRead(pMaster, zMasterJournal, (int)nMasterJournal, 0);
  48535. if( rc!=SQLITE_OK ) goto delmaster_out;
  48536. zMasterJournal[nMasterJournal] = 0;
  48537. zJournal = zMasterJournal;
  48538. while( (zJournal-zMasterJournal)<nMasterJournal ){
  48539. int exists;
  48540. rc = sqlite3OsAccess(pVfs, zJournal, SQLITE_ACCESS_EXISTS, &exists);
  48541. if( rc!=SQLITE_OK ){
  48542. goto delmaster_out;
  48543. }
  48544. if( exists ){
  48545. /* One of the journals pointed to by the master journal exists.
  48546. ** Open it and check if it points at the master journal. If
  48547. ** so, return without deleting the master journal file.
  48548. */
  48549. int c;
  48550. int flags = (SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL);
  48551. rc = sqlite3OsOpen(pVfs, zJournal, pJournal, flags, 0);
  48552. if( rc!=SQLITE_OK ){
  48553. goto delmaster_out;
  48554. }
  48555. rc = readMasterJournal(pJournal, zMasterPtr, nMasterPtr);
  48556. sqlite3OsClose(pJournal);
  48557. if( rc!=SQLITE_OK ){
  48558. goto delmaster_out;
  48559. }
  48560. c = zMasterPtr[0]!=0 && strcmp(zMasterPtr, zMaster)==0;
  48561. if( c ){
  48562. /* We have a match. Do not delete the master journal file. */
  48563. goto delmaster_out;
  48564. }
  48565. }
  48566. zJournal += (sqlite3Strlen30(zJournal)+1);
  48567. }
  48568. sqlite3OsClose(pMaster);
  48569. rc = sqlite3OsDelete(pVfs, zMaster, 0);
  48570. delmaster_out:
  48571. sqlite3_free(zMasterJournal);
  48572. if( pMaster ){
  48573. sqlite3OsClose(pMaster);
  48574. assert( !isOpen(pJournal) );
  48575. sqlite3_free(pMaster);
  48576. }
  48577. return rc;
  48578. }
  48579. /*
  48580. ** This function is used to change the actual size of the database
  48581. ** file in the file-system. This only happens when committing a transaction,
  48582. ** or rolling back a transaction (including rolling back a hot-journal).
  48583. **
  48584. ** If the main database file is not open, or the pager is not in either
  48585. ** DBMOD or OPEN state, this function is a no-op. Otherwise, the size
  48586. ** of the file is changed to nPage pages (nPage*pPager->pageSize bytes).
  48587. ** If the file on disk is currently larger than nPage pages, then use the VFS
  48588. ** xTruncate() method to truncate it.
  48589. **
  48590. ** Or, it might be the case that the file on disk is smaller than
  48591. ** nPage pages. Some operating system implementations can get confused if
  48592. ** you try to truncate a file to some size that is larger than it
  48593. ** currently is, so detect this case and write a single zero byte to
  48594. ** the end of the new file instead.
  48595. **
  48596. ** If successful, return SQLITE_OK. If an IO error occurs while modifying
  48597. ** the database file, return the error code to the caller.
  48598. */
  48599. static int pager_truncate(Pager *pPager, Pgno nPage){
  48600. int rc = SQLITE_OK;
  48601. assert( pPager->eState!=PAGER_ERROR );
  48602. assert( pPager->eState!=PAGER_READER );
  48603. if( isOpen(pPager->fd)
  48604. && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
  48605. ){
  48606. i64 currentSize, newSize;
  48607. int szPage = pPager->pageSize;
  48608. assert( pPager->eLock==EXCLUSIVE_LOCK );
  48609. /* TODO: Is it safe to use Pager.dbFileSize here? */
  48610. rc = sqlite3OsFileSize(pPager->fd, &currentSize);
  48611. newSize = szPage*(i64)nPage;
  48612. if( rc==SQLITE_OK && currentSize!=newSize ){
  48613. if( currentSize>newSize ){
  48614. rc = sqlite3OsTruncate(pPager->fd, newSize);
  48615. }else if( (currentSize+szPage)<=newSize ){
  48616. char *pTmp = pPager->pTmpSpace;
  48617. memset(pTmp, 0, szPage);
  48618. testcase( (newSize-szPage) == currentSize );
  48619. testcase( (newSize-szPage) > currentSize );
  48620. rc = sqlite3OsWrite(pPager->fd, pTmp, szPage, newSize-szPage);
  48621. }
  48622. if( rc==SQLITE_OK ){
  48623. pPager->dbFileSize = nPage;
  48624. }
  48625. }
  48626. }
  48627. return rc;
  48628. }
  48629. /*
  48630. ** Return a sanitized version of the sector-size of OS file pFile. The
  48631. ** return value is guaranteed to lie between 32 and MAX_SECTOR_SIZE.
  48632. */
  48633. SQLITE_PRIVATE int sqlite3SectorSize(sqlite3_file *pFile){
  48634. int iRet = sqlite3OsSectorSize(pFile);
  48635. if( iRet<32 ){
  48636. iRet = 512;
  48637. }else if( iRet>MAX_SECTOR_SIZE ){
  48638. assert( MAX_SECTOR_SIZE>=512 );
  48639. iRet = MAX_SECTOR_SIZE;
  48640. }
  48641. return iRet;
  48642. }
  48643. /*
  48644. ** Set the value of the Pager.sectorSize variable for the given
  48645. ** pager based on the value returned by the xSectorSize method
  48646. ** of the open database file. The sector size will be used
  48647. ** to determine the size and alignment of journal header and
  48648. ** master journal pointers within created journal files.
  48649. **
  48650. ** For temporary files the effective sector size is always 512 bytes.
  48651. **
  48652. ** Otherwise, for non-temporary files, the effective sector size is
  48653. ** the value returned by the xSectorSize() method rounded up to 32 if
  48654. ** it is less than 32, or rounded down to MAX_SECTOR_SIZE if it
  48655. ** is greater than MAX_SECTOR_SIZE.
  48656. **
  48657. ** If the file has the SQLITE_IOCAP_POWERSAFE_OVERWRITE property, then set
  48658. ** the effective sector size to its minimum value (512). The purpose of
  48659. ** pPager->sectorSize is to define the "blast radius" of bytes that
  48660. ** might change if a crash occurs while writing to a single byte in
  48661. ** that range. But with POWERSAFE_OVERWRITE, the blast radius is zero
  48662. ** (that is what POWERSAFE_OVERWRITE means), so we minimize the sector
  48663. ** size. For backwards compatibility of the rollback journal file format,
  48664. ** we cannot reduce the effective sector size below 512.
  48665. */
  48666. static void setSectorSize(Pager *pPager){
  48667. assert( isOpen(pPager->fd) || pPager->tempFile );
  48668. if( pPager->tempFile
  48669. || (sqlite3OsDeviceCharacteristics(pPager->fd) &
  48670. SQLITE_IOCAP_POWERSAFE_OVERWRITE)!=0
  48671. ){
  48672. /* Sector size doesn't matter for temporary files. Also, the file
  48673. ** may not have been opened yet, in which case the OsSectorSize()
  48674. ** call will segfault. */
  48675. pPager->sectorSize = 512;
  48676. }else{
  48677. pPager->sectorSize = sqlite3SectorSize(pPager->fd);
  48678. }
  48679. }
  48680. /*
  48681. ** Playback the journal and thus restore the database file to
  48682. ** the state it was in before we started making changes.
  48683. **
  48684. ** The journal file format is as follows:
  48685. **
  48686. ** (1) 8 byte prefix. A copy of aJournalMagic[].
  48687. ** (2) 4 byte big-endian integer which is the number of valid page records
  48688. ** in the journal. If this value is 0xffffffff, then compute the
  48689. ** number of page records from the journal size.
  48690. ** (3) 4 byte big-endian integer which is the initial value for the
  48691. ** sanity checksum.
  48692. ** (4) 4 byte integer which is the number of pages to truncate the
  48693. ** database to during a rollback.
  48694. ** (5) 4 byte big-endian integer which is the sector size. The header
  48695. ** is this many bytes in size.
  48696. ** (6) 4 byte big-endian integer which is the page size.
  48697. ** (7) zero padding out to the next sector size.
  48698. ** (8) Zero or more pages instances, each as follows:
  48699. ** + 4 byte page number.
  48700. ** + pPager->pageSize bytes of data.
  48701. ** + 4 byte checksum
  48702. **
  48703. ** When we speak of the journal header, we mean the first 7 items above.
  48704. ** Each entry in the journal is an instance of the 8th item.
  48705. **
  48706. ** Call the value from the second bullet "nRec". nRec is the number of
  48707. ** valid page entries in the journal. In most cases, you can compute the
  48708. ** value of nRec from the size of the journal file. But if a power
  48709. ** failure occurred while the journal was being written, it could be the
  48710. ** case that the size of the journal file had already been increased but
  48711. ** the extra entries had not yet made it safely to disk. In such a case,
  48712. ** the value of nRec computed from the file size would be too large. For
  48713. ** that reason, we always use the nRec value in the header.
  48714. **
  48715. ** If the nRec value is 0xffffffff it means that nRec should be computed
  48716. ** from the file size. This value is used when the user selects the
  48717. ** no-sync option for the journal. A power failure could lead to corruption
  48718. ** in this case. But for things like temporary table (which will be
  48719. ** deleted when the power is restored) we don't care.
  48720. **
  48721. ** If the file opened as the journal file is not a well-formed
  48722. ** journal file then all pages up to the first corrupted page are rolled
  48723. ** back (or no pages if the journal header is corrupted). The journal file
  48724. ** is then deleted and SQLITE_OK returned, just as if no corruption had
  48725. ** been encountered.
  48726. **
  48727. ** If an I/O or malloc() error occurs, the journal-file is not deleted
  48728. ** and an error code is returned.
  48729. **
  48730. ** The isHot parameter indicates that we are trying to rollback a journal
  48731. ** that might be a hot journal. Or, it could be that the journal is
  48732. ** preserved because of JOURNALMODE_PERSIST or JOURNALMODE_TRUNCATE.
  48733. ** If the journal really is hot, reset the pager cache prior rolling
  48734. ** back any content. If the journal is merely persistent, no reset is
  48735. ** needed.
  48736. */
  48737. static int pager_playback(Pager *pPager, int isHot){
  48738. sqlite3_vfs *pVfs = pPager->pVfs;
  48739. i64 szJ; /* Size of the journal file in bytes */
  48740. u32 nRec; /* Number of Records in the journal */
  48741. u32 u; /* Unsigned loop counter */
  48742. Pgno mxPg = 0; /* Size of the original file in pages */
  48743. int rc; /* Result code of a subroutine */
  48744. int res = 1; /* Value returned by sqlite3OsAccess() */
  48745. char *zMaster = 0; /* Name of master journal file if any */
  48746. int needPagerReset; /* True to reset page prior to first page rollback */
  48747. int nPlayback = 0; /* Total number of pages restored from journal */
  48748. u32 savedPageSize = pPager->pageSize;
  48749. /* Figure out how many records are in the journal. Abort early if
  48750. ** the journal is empty.
  48751. */
  48752. assert( isOpen(pPager->jfd) );
  48753. rc = sqlite3OsFileSize(pPager->jfd, &szJ);
  48754. if( rc!=SQLITE_OK ){
  48755. goto end_playback;
  48756. }
  48757. /* Read the master journal name from the journal, if it is present.
  48758. ** If a master journal file name is specified, but the file is not
  48759. ** present on disk, then the journal is not hot and does not need to be
  48760. ** played back.
  48761. **
  48762. ** TODO: Technically the following is an error because it assumes that
  48763. ** buffer Pager.pTmpSpace is (mxPathname+1) bytes or larger. i.e. that
  48764. ** (pPager->pageSize >= pPager->pVfs->mxPathname+1). Using os_unix.c,
  48765. ** mxPathname is 512, which is the same as the minimum allowable value
  48766. ** for pageSize.
  48767. */
  48768. zMaster = pPager->pTmpSpace;
  48769. rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
  48770. if( rc==SQLITE_OK && zMaster[0] ){
  48771. rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
  48772. }
  48773. zMaster = 0;
  48774. if( rc!=SQLITE_OK || !res ){
  48775. goto end_playback;
  48776. }
  48777. pPager->journalOff = 0;
  48778. needPagerReset = isHot;
  48779. /* This loop terminates either when a readJournalHdr() or
  48780. ** pager_playback_one_page() call returns SQLITE_DONE or an IO error
  48781. ** occurs.
  48782. */
  48783. while( 1 ){
  48784. /* Read the next journal header from the journal file. If there are
  48785. ** not enough bytes left in the journal file for a complete header, or
  48786. ** it is corrupted, then a process must have failed while writing it.
  48787. ** This indicates nothing more needs to be rolled back.
  48788. */
  48789. rc = readJournalHdr(pPager, isHot, szJ, &nRec, &mxPg);
  48790. if( rc!=SQLITE_OK ){
  48791. if( rc==SQLITE_DONE ){
  48792. rc = SQLITE_OK;
  48793. }
  48794. goto end_playback;
  48795. }
  48796. /* If nRec is 0xffffffff, then this journal was created by a process
  48797. ** working in no-sync mode. This means that the rest of the journal
  48798. ** file consists of pages, there are no more journal headers. Compute
  48799. ** the value of nRec based on this assumption.
  48800. */
  48801. if( nRec==0xffffffff ){
  48802. assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) );
  48803. nRec = (int)((szJ - JOURNAL_HDR_SZ(pPager))/JOURNAL_PG_SZ(pPager));
  48804. }
  48805. /* If nRec is 0 and this rollback is of a transaction created by this
  48806. ** process and if this is the final header in the journal, then it means
  48807. ** that this part of the journal was being filled but has not yet been
  48808. ** synced to disk. Compute the number of pages based on the remaining
  48809. ** size of the file.
  48810. **
  48811. ** The third term of the test was added to fix ticket #2565.
  48812. ** When rolling back a hot journal, nRec==0 always means that the next
  48813. ** chunk of the journal contains zero pages to be rolled back. But
  48814. ** when doing a ROLLBACK and the nRec==0 chunk is the last chunk in
  48815. ** the journal, it means that the journal might contain additional
  48816. ** pages that need to be rolled back and that the number of pages
  48817. ** should be computed based on the journal file size.
  48818. */
  48819. if( nRec==0 && !isHot &&
  48820. pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff ){
  48821. nRec = (int)((szJ - pPager->journalOff) / JOURNAL_PG_SZ(pPager));
  48822. }
  48823. /* If this is the first header read from the journal, truncate the
  48824. ** database file back to its original size.
  48825. */
  48826. if( pPager->journalOff==JOURNAL_HDR_SZ(pPager) ){
  48827. rc = pager_truncate(pPager, mxPg);
  48828. if( rc!=SQLITE_OK ){
  48829. goto end_playback;
  48830. }
  48831. pPager->dbSize = mxPg;
  48832. }
  48833. /* Copy original pages out of the journal and back into the
  48834. ** database file and/or page cache.
  48835. */
  48836. for(u=0; u<nRec; u++){
  48837. if( needPagerReset ){
  48838. pager_reset(pPager);
  48839. needPagerReset = 0;
  48840. }
  48841. rc = pager_playback_one_page(pPager,&pPager->journalOff,0,1,0);
  48842. if( rc==SQLITE_OK ){
  48843. nPlayback++;
  48844. }else{
  48845. if( rc==SQLITE_DONE ){
  48846. pPager->journalOff = szJ;
  48847. break;
  48848. }else if( rc==SQLITE_IOERR_SHORT_READ ){
  48849. /* If the journal has been truncated, simply stop reading and
  48850. ** processing the journal. This might happen if the journal was
  48851. ** not completely written and synced prior to a crash. In that
  48852. ** case, the database should have never been written in the
  48853. ** first place so it is OK to simply abandon the rollback. */
  48854. rc = SQLITE_OK;
  48855. goto end_playback;
  48856. }else{
  48857. /* If we are unable to rollback, quit and return the error
  48858. ** code. This will cause the pager to enter the error state
  48859. ** so that no further harm will be done. Perhaps the next
  48860. ** process to come along will be able to rollback the database.
  48861. */
  48862. goto end_playback;
  48863. }
  48864. }
  48865. }
  48866. }
  48867. /*NOTREACHED*/
  48868. assert( 0 );
  48869. end_playback:
  48870. if( rc==SQLITE_OK ){
  48871. rc = sqlite3PagerSetPagesize(pPager, &savedPageSize, -1);
  48872. }
  48873. /* Following a rollback, the database file should be back in its original
  48874. ** state prior to the start of the transaction, so invoke the
  48875. ** SQLITE_FCNTL_DB_UNCHANGED file-control method to disable the
  48876. ** assertion that the transaction counter was modified.
  48877. */
  48878. #ifdef SQLITE_DEBUG
  48879. sqlite3OsFileControlHint(pPager->fd,SQLITE_FCNTL_DB_UNCHANGED,0);
  48880. #endif
  48881. /* If this playback is happening automatically as a result of an IO or
  48882. ** malloc error that occurred after the change-counter was updated but
  48883. ** before the transaction was committed, then the change-counter
  48884. ** modification may just have been reverted. If this happens in exclusive
  48885. ** mode, then subsequent transactions performed by the connection will not
  48886. ** update the change-counter at all. This may lead to cache inconsistency
  48887. ** problems for other processes at some point in the future. So, just
  48888. ** in case this has happened, clear the changeCountDone flag now.
  48889. */
  48890. pPager->changeCountDone = pPager->tempFile;
  48891. if( rc==SQLITE_OK ){
  48892. zMaster = pPager->pTmpSpace;
  48893. rc = readMasterJournal(pPager->jfd, zMaster, pPager->pVfs->mxPathname+1);
  48894. testcase( rc!=SQLITE_OK );
  48895. }
  48896. if( rc==SQLITE_OK
  48897. && (pPager->eState>=PAGER_WRITER_DBMOD || pPager->eState==PAGER_OPEN)
  48898. ){
  48899. rc = sqlite3PagerSync(pPager, 0);
  48900. }
  48901. if( rc==SQLITE_OK ){
  48902. rc = pager_end_transaction(pPager, zMaster[0]!='\0', 0);
  48903. testcase( rc!=SQLITE_OK );
  48904. }
  48905. if( rc==SQLITE_OK && zMaster[0] && res ){
  48906. /* If there was a master journal and this routine will return success,
  48907. ** see if it is possible to delete the master journal.
  48908. */
  48909. rc = pager_delmaster(pPager, zMaster);
  48910. testcase( rc!=SQLITE_OK );
  48911. }
  48912. if( isHot && nPlayback ){
  48913. sqlite3_log(SQLITE_NOTICE_RECOVER_ROLLBACK, "recovered %d pages from %s",
  48914. nPlayback, pPager->zJournal);
  48915. }
  48916. /* The Pager.sectorSize variable may have been updated while rolling
  48917. ** back a journal created by a process with a different sector size
  48918. ** value. Reset it to the correct value for this process.
  48919. */
  48920. setSectorSize(pPager);
  48921. return rc;
  48922. }
  48923. /*
  48924. ** Read the content for page pPg out of the database file (or out of
  48925. ** the WAL if that is where the most recent copy if found) into
  48926. ** pPg->pData. A shared lock or greater must be held on the database
  48927. ** file before this function is called.
  48928. **
  48929. ** If page 1 is read, then the value of Pager.dbFileVers[] is set to
  48930. ** the value read from the database file.
  48931. **
  48932. ** If an IO error occurs, then the IO error is returned to the caller.
  48933. ** Otherwise, SQLITE_OK is returned.
  48934. */
  48935. static int readDbPage(PgHdr *pPg){
  48936. Pager *pPager = pPg->pPager; /* Pager object associated with page pPg */
  48937. int rc = SQLITE_OK; /* Return code */
  48938. #ifndef SQLITE_OMIT_WAL
  48939. u32 iFrame = 0; /* Frame of WAL containing pgno */
  48940. assert( pPager->eState>=PAGER_READER && !MEMDB );
  48941. assert( isOpen(pPager->fd) );
  48942. if( pagerUseWal(pPager) ){
  48943. rc = sqlite3WalFindFrame(pPager->pWal, pPg->pgno, &iFrame);
  48944. if( rc ) return rc;
  48945. }
  48946. if( iFrame ){
  48947. rc = sqlite3WalReadFrame(pPager->pWal, iFrame,pPager->pageSize,pPg->pData);
  48948. }else
  48949. #endif
  48950. {
  48951. i64 iOffset = (pPg->pgno-1)*(i64)pPager->pageSize;
  48952. rc = sqlite3OsRead(pPager->fd, pPg->pData, pPager->pageSize, iOffset);
  48953. if( rc==SQLITE_IOERR_SHORT_READ ){
  48954. rc = SQLITE_OK;
  48955. }
  48956. }
  48957. if( pPg->pgno==1 ){
  48958. if( rc ){
  48959. /* If the read is unsuccessful, set the dbFileVers[] to something
  48960. ** that will never be a valid file version. dbFileVers[] is a copy
  48961. ** of bytes 24..39 of the database. Bytes 28..31 should always be
  48962. ** zero or the size of the database in page. Bytes 32..35 and 35..39
  48963. ** should be page numbers which are never 0xffffffff. So filling
  48964. ** pPager->dbFileVers[] with all 0xff bytes should suffice.
  48965. **
  48966. ** For an encrypted database, the situation is more complex: bytes
  48967. ** 24..39 of the database are white noise. But the probability of
  48968. ** white noise equaling 16 bytes of 0xff is vanishingly small so
  48969. ** we should still be ok.
  48970. */
  48971. memset(pPager->dbFileVers, 0xff, sizeof(pPager->dbFileVers));
  48972. }else{
  48973. u8 *dbFileVers = &((u8*)pPg->pData)[24];
  48974. memcpy(&pPager->dbFileVers, dbFileVers, sizeof(pPager->dbFileVers));
  48975. }
  48976. }
  48977. CODEC1(pPager, pPg->pData, pPg->pgno, 3, rc = SQLITE_NOMEM_BKPT);
  48978. PAGER_INCR(sqlite3_pager_readdb_count);
  48979. PAGER_INCR(pPager->nRead);
  48980. IOTRACE(("PGIN %p %d\n", pPager, pPg->pgno));
  48981. PAGERTRACE(("FETCH %d page %d hash(%08x)\n",
  48982. PAGERID(pPager), pPg->pgno, pager_pagehash(pPg)));
  48983. return rc;
  48984. }
  48985. /*
  48986. ** Update the value of the change-counter at offsets 24 and 92 in
  48987. ** the header and the sqlite version number at offset 96.
  48988. **
  48989. ** This is an unconditional update. See also the pager_incr_changecounter()
  48990. ** routine which only updates the change-counter if the update is actually
  48991. ** needed, as determined by the pPager->changeCountDone state variable.
  48992. */
  48993. static void pager_write_changecounter(PgHdr *pPg){
  48994. u32 change_counter;
  48995. /* Increment the value just read and write it back to byte 24. */
  48996. change_counter = sqlite3Get4byte((u8*)pPg->pPager->dbFileVers)+1;
  48997. put32bits(((char*)pPg->pData)+24, change_counter);
  48998. /* Also store the SQLite version number in bytes 96..99 and in
  48999. ** bytes 92..95 store the change counter for which the version number
  49000. ** is valid. */
  49001. put32bits(((char*)pPg->pData)+92, change_counter);
  49002. put32bits(((char*)pPg->pData)+96, SQLITE_VERSION_NUMBER);
  49003. }
  49004. #ifndef SQLITE_OMIT_WAL
  49005. /*
  49006. ** This function is invoked once for each page that has already been
  49007. ** written into the log file when a WAL transaction is rolled back.
  49008. ** Parameter iPg is the page number of said page. The pCtx argument
  49009. ** is actually a pointer to the Pager structure.
  49010. **
  49011. ** If page iPg is present in the cache, and has no outstanding references,
  49012. ** it is discarded. Otherwise, if there are one or more outstanding
  49013. ** references, the page content is reloaded from the database. If the
  49014. ** attempt to reload content from the database is required and fails,
  49015. ** return an SQLite error code. Otherwise, SQLITE_OK.
  49016. */
  49017. static int pagerUndoCallback(void *pCtx, Pgno iPg){
  49018. int rc = SQLITE_OK;
  49019. Pager *pPager = (Pager *)pCtx;
  49020. PgHdr *pPg;
  49021. assert( pagerUseWal(pPager) );
  49022. pPg = sqlite3PagerLookup(pPager, iPg);
  49023. if( pPg ){
  49024. if( sqlite3PcachePageRefcount(pPg)==1 ){
  49025. sqlite3PcacheDrop(pPg);
  49026. }else{
  49027. rc = readDbPage(pPg);
  49028. if( rc==SQLITE_OK ){
  49029. pPager->xReiniter(pPg);
  49030. }
  49031. sqlite3PagerUnrefNotNull(pPg);
  49032. }
  49033. }
  49034. /* Normally, if a transaction is rolled back, any backup processes are
  49035. ** updated as data is copied out of the rollback journal and into the
  49036. ** database. This is not generally possible with a WAL database, as
  49037. ** rollback involves simply truncating the log file. Therefore, if one
  49038. ** or more frames have already been written to the log (and therefore
  49039. ** also copied into the backup databases) as part of this transaction,
  49040. ** the backups must be restarted.
  49041. */
  49042. sqlite3BackupRestart(pPager->pBackup);
  49043. return rc;
  49044. }
  49045. /*
  49046. ** This function is called to rollback a transaction on a WAL database.
  49047. */
  49048. static int pagerRollbackWal(Pager *pPager){
  49049. int rc; /* Return Code */
  49050. PgHdr *pList; /* List of dirty pages to revert */
  49051. /* For all pages in the cache that are currently dirty or have already
  49052. ** been written (but not committed) to the log file, do one of the
  49053. ** following:
  49054. **
  49055. ** + Discard the cached page (if refcount==0), or
  49056. ** + Reload page content from the database (if refcount>0).
  49057. */
  49058. pPager->dbSize = pPager->dbOrigSize;
  49059. rc = sqlite3WalUndo(pPager->pWal, pagerUndoCallback, (void *)pPager);
  49060. pList = sqlite3PcacheDirtyList(pPager->pPCache);
  49061. while( pList && rc==SQLITE_OK ){
  49062. PgHdr *pNext = pList->pDirty;
  49063. rc = pagerUndoCallback((void *)pPager, pList->pgno);
  49064. pList = pNext;
  49065. }
  49066. return rc;
  49067. }
  49068. /*
  49069. ** This function is a wrapper around sqlite3WalFrames(). As well as logging
  49070. ** the contents of the list of pages headed by pList (connected by pDirty),
  49071. ** this function notifies any active backup processes that the pages have
  49072. ** changed.
  49073. **
  49074. ** The list of pages passed into this routine is always sorted by page number.
  49075. ** Hence, if page 1 appears anywhere on the list, it will be the first page.
  49076. */
  49077. static int pagerWalFrames(
  49078. Pager *pPager, /* Pager object */
  49079. PgHdr *pList, /* List of frames to log */
  49080. Pgno nTruncate, /* Database size after this commit */
  49081. int isCommit /* True if this is a commit */
  49082. ){
  49083. int rc; /* Return code */
  49084. int nList; /* Number of pages in pList */
  49085. PgHdr *p; /* For looping over pages */
  49086. assert( pPager->pWal );
  49087. assert( pList );
  49088. #ifdef SQLITE_DEBUG
  49089. /* Verify that the page list is in accending order */
  49090. for(p=pList; p && p->pDirty; p=p->pDirty){
  49091. assert( p->pgno < p->pDirty->pgno );
  49092. }
  49093. #endif
  49094. assert( pList->pDirty==0 || isCommit );
  49095. if( isCommit ){
  49096. /* If a WAL transaction is being committed, there is no point in writing
  49097. ** any pages with page numbers greater than nTruncate into the WAL file.
  49098. ** They will never be read by any client. So remove them from the pDirty
  49099. ** list here. */
  49100. PgHdr **ppNext = &pList;
  49101. nList = 0;
  49102. for(p=pList; (*ppNext = p)!=0; p=p->pDirty){
  49103. if( p->pgno<=nTruncate ){
  49104. ppNext = &p->pDirty;
  49105. nList++;
  49106. }
  49107. }
  49108. assert( pList );
  49109. }else{
  49110. nList = 1;
  49111. }
  49112. pPager->aStat[PAGER_STAT_WRITE] += nList;
  49113. if( pList->pgno==1 ) pager_write_changecounter(pList);
  49114. rc = sqlite3WalFrames(pPager->pWal,
  49115. pPager->pageSize, pList, nTruncate, isCommit, pPager->walSyncFlags
  49116. );
  49117. if( rc==SQLITE_OK && pPager->pBackup ){
  49118. for(p=pList; p; p=p->pDirty){
  49119. sqlite3BackupUpdate(pPager->pBackup, p->pgno, (u8 *)p->pData);
  49120. }
  49121. }
  49122. #ifdef SQLITE_CHECK_PAGES
  49123. pList = sqlite3PcacheDirtyList(pPager->pPCache);
  49124. for(p=pList; p; p=p->pDirty){
  49125. pager_set_pagehash(p);
  49126. }
  49127. #endif
  49128. return rc;
  49129. }
  49130. /*
  49131. ** Begin a read transaction on the WAL.
  49132. **
  49133. ** This routine used to be called "pagerOpenSnapshot()" because it essentially
  49134. ** makes a snapshot of the database at the current point in time and preserves
  49135. ** that snapshot for use by the reader in spite of concurrently changes by
  49136. ** other writers or checkpointers.
  49137. */
  49138. static int pagerBeginReadTransaction(Pager *pPager){
  49139. int rc; /* Return code */
  49140. int changed = 0; /* True if cache must be reset */
  49141. assert( pagerUseWal(pPager) );
  49142. assert( pPager->eState==PAGER_OPEN || pPager->eState==PAGER_READER );
  49143. /* sqlite3WalEndReadTransaction() was not called for the previous
  49144. ** transaction in locking_mode=EXCLUSIVE. So call it now. If we
  49145. ** are in locking_mode=NORMAL and EndRead() was previously called,
  49146. ** the duplicate call is harmless.
  49147. */
  49148. sqlite3WalEndReadTransaction(pPager->pWal);
  49149. rc = sqlite3WalBeginReadTransaction(pPager->pWal, &changed);
  49150. if( rc!=SQLITE_OK || changed ){
  49151. pager_reset(pPager);
  49152. if( USEFETCH(pPager) ) sqlite3OsUnfetch(pPager->fd, 0, 0);
  49153. }
  49154. return rc;
  49155. }
  49156. #endif
  49157. /*
  49158. ** This function is called as part of the transition from PAGER_OPEN
  49159. ** to PAGER_READER state to determine the size of the database file
  49160. ** in pages (assuming the page size currently stored in Pager.pageSize).
  49161. **
  49162. ** If no error occurs, SQLITE_OK is returned and the size of the database
  49163. ** in pages is stored in *pnPage. Otherwise, an error code (perhaps
  49164. ** SQLITE_IOERR_FSTAT) is returned and *pnPage is left unmodified.
  49165. */
  49166. static int pagerPagecount(Pager *pPager, Pgno *pnPage){
  49167. Pgno nPage; /* Value to return via *pnPage */
  49168. /* Query the WAL sub-system for the database size. The WalDbsize()
  49169. ** function returns zero if the WAL is not open (i.e. Pager.pWal==0), or
  49170. ** if the database size is not available. The database size is not
  49171. ** available from the WAL sub-system if the log file is empty or
  49172. ** contains no valid committed transactions.
  49173. */
  49174. assert( pPager->eState==PAGER_OPEN );
  49175. assert( pPager->eLock>=SHARED_LOCK );
  49176. assert( isOpen(pPager->fd) );
  49177. assert( pPager->tempFile==0 );
  49178. nPage = sqlite3WalDbsize(pPager->pWal);
  49179. /* If the number of pages in the database is not available from the
  49180. ** WAL sub-system, determine the page count based on the size of
  49181. ** the database file. If the size of the database file is not an
  49182. ** integer multiple of the page-size, round up the result.
  49183. */
  49184. if( nPage==0 && ALWAYS(isOpen(pPager->fd)) ){
  49185. i64 n = 0; /* Size of db file in bytes */
  49186. int rc = sqlite3OsFileSize(pPager->fd, &n);
  49187. if( rc!=SQLITE_OK ){
  49188. return rc;
  49189. }
  49190. nPage = (Pgno)((n+pPager->pageSize-1) / pPager->pageSize);
  49191. }
  49192. /* If the current number of pages in the file is greater than the
  49193. ** configured maximum pager number, increase the allowed limit so
  49194. ** that the file can be read.
  49195. */
  49196. if( nPage>pPager->mxPgno ){
  49197. pPager->mxPgno = (Pgno)nPage;
  49198. }
  49199. *pnPage = nPage;
  49200. return SQLITE_OK;
  49201. }
  49202. #ifndef SQLITE_OMIT_WAL
  49203. /*
  49204. ** Check if the *-wal file that corresponds to the database opened by pPager
  49205. ** exists if the database is not empy, or verify that the *-wal file does
  49206. ** not exist (by deleting it) if the database file is empty.
  49207. **
  49208. ** If the database is not empty and the *-wal file exists, open the pager
  49209. ** in WAL mode. If the database is empty or if no *-wal file exists and
  49210. ** if no error occurs, make sure Pager.journalMode is not set to
  49211. ** PAGER_JOURNALMODE_WAL.
  49212. **
  49213. ** Return SQLITE_OK or an error code.
  49214. **
  49215. ** The caller must hold a SHARED lock on the database file to call this
  49216. ** function. Because an EXCLUSIVE lock on the db file is required to delete
  49217. ** a WAL on a none-empty database, this ensures there is no race condition
  49218. ** between the xAccess() below and an xDelete() being executed by some
  49219. ** other connection.
  49220. */
  49221. static int pagerOpenWalIfPresent(Pager *pPager){
  49222. int rc = SQLITE_OK;
  49223. assert( pPager->eState==PAGER_OPEN );
  49224. assert( pPager->eLock>=SHARED_LOCK );
  49225. if( !pPager->tempFile ){
  49226. int isWal; /* True if WAL file exists */
  49227. rc = sqlite3OsAccess(
  49228. pPager->pVfs, pPager->zWal, SQLITE_ACCESS_EXISTS, &isWal
  49229. );
  49230. if( rc==SQLITE_OK ){
  49231. if( isWal ){
  49232. Pgno nPage; /* Size of the database file */
  49233. rc = pagerPagecount(pPager, &nPage);
  49234. if( rc ) return rc;
  49235. if( nPage==0 ){
  49236. rc = sqlite3OsDelete(pPager->pVfs, pPager->zWal, 0);
  49237. }else{
  49238. testcase( sqlite3PcachePagecount(pPager->pPCache)==0 );
  49239. rc = sqlite3PagerOpenWal(pPager, 0);
  49240. }
  49241. }else if( pPager->journalMode==PAGER_JOURNALMODE_WAL ){
  49242. pPager->journalMode = PAGER_JOURNALMODE_DELETE;
  49243. }
  49244. }
  49245. }
  49246. return rc;
  49247. }
  49248. #endif
  49249. /*
  49250. ** Playback savepoint pSavepoint. Or, if pSavepoint==NULL, then playback
  49251. ** the entire master journal file. The case pSavepoint==NULL occurs when
  49252. ** a ROLLBACK TO command is invoked on a SAVEPOINT that is a transaction
  49253. ** savepoint.
  49254. **
  49255. ** When pSavepoint is not NULL (meaning a non-transaction savepoint is
  49256. ** being rolled back), then the rollback consists of up to three stages,
  49257. ** performed in the order specified:
  49258. **
  49259. ** * Pages are played back from the main journal starting at byte
  49260. ** offset PagerSavepoint.iOffset and continuing to
  49261. ** PagerSavepoint.iHdrOffset, or to the end of the main journal
  49262. ** file if PagerSavepoint.iHdrOffset is zero.
  49263. **
  49264. ** * If PagerSavepoint.iHdrOffset is not zero, then pages are played
  49265. ** back starting from the journal header immediately following
  49266. ** PagerSavepoint.iHdrOffset to the end of the main journal file.
  49267. **
  49268. ** * Pages are then played back from the sub-journal file, starting
  49269. ** with the PagerSavepoint.iSubRec and continuing to the end of
  49270. ** the journal file.
  49271. **
  49272. ** Throughout the rollback process, each time a page is rolled back, the
  49273. ** corresponding bit is set in a bitvec structure (variable pDone in the
  49274. ** implementation below). This is used to ensure that a page is only
  49275. ** rolled back the first time it is encountered in either journal.
  49276. **
  49277. ** If pSavepoint is NULL, then pages are only played back from the main
  49278. ** journal file. There is no need for a bitvec in this case.
  49279. **
  49280. ** In either case, before playback commences the Pager.dbSize variable
  49281. ** is reset to the value that it held at the start of the savepoint
  49282. ** (or transaction). No page with a page-number greater than this value
  49283. ** is played back. If one is encountered it is simply skipped.
  49284. */
  49285. static int pagerPlaybackSavepoint(Pager *pPager, PagerSavepoint *pSavepoint){
  49286. i64 szJ; /* Effective size of the main journal */
  49287. i64 iHdrOff; /* End of first segment of main-journal records */
  49288. int rc = SQLITE_OK; /* Return code */
  49289. Bitvec *pDone = 0; /* Bitvec to ensure pages played back only once */
  49290. assert( pPager->eState!=PAGER_ERROR );
  49291. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  49292. /* Allocate a bitvec to use to store the set of pages rolled back */
  49293. if( pSavepoint ){
  49294. pDone = sqlite3BitvecCreate(pSavepoint->nOrig);
  49295. if( !pDone ){
  49296. return SQLITE_NOMEM_BKPT;
  49297. }
  49298. }
  49299. /* Set the database size back to the value it was before the savepoint
  49300. ** being reverted was opened.
  49301. */
  49302. pPager->dbSize = pSavepoint ? pSavepoint->nOrig : pPager->dbOrigSize;
  49303. pPager->changeCountDone = pPager->tempFile;
  49304. if( !pSavepoint && pagerUseWal(pPager) ){
  49305. return pagerRollbackWal(pPager);
  49306. }
  49307. /* Use pPager->journalOff as the effective size of the main rollback
  49308. ** journal. The actual file might be larger than this in
  49309. ** PAGER_JOURNALMODE_TRUNCATE or PAGER_JOURNALMODE_PERSIST. But anything
  49310. ** past pPager->journalOff is off-limits to us.
  49311. */
  49312. szJ = pPager->journalOff;
  49313. assert( pagerUseWal(pPager)==0 || szJ==0 );
  49314. /* Begin by rolling back records from the main journal starting at
  49315. ** PagerSavepoint.iOffset and continuing to the next journal header.
  49316. ** There might be records in the main journal that have a page number
  49317. ** greater than the current database size (pPager->dbSize) but those
  49318. ** will be skipped automatically. Pages are added to pDone as they
  49319. ** are played back.
  49320. */
  49321. if( pSavepoint && !pagerUseWal(pPager) ){
  49322. iHdrOff = pSavepoint->iHdrOffset ? pSavepoint->iHdrOffset : szJ;
  49323. pPager->journalOff = pSavepoint->iOffset;
  49324. while( rc==SQLITE_OK && pPager->journalOff<iHdrOff ){
  49325. rc = pager_playback_one_page(pPager, &pPager->journalOff, pDone, 1, 1);
  49326. }
  49327. assert( rc!=SQLITE_DONE );
  49328. }else{
  49329. pPager->journalOff = 0;
  49330. }
  49331. /* Continue rolling back records out of the main journal starting at
  49332. ** the first journal header seen and continuing until the effective end
  49333. ** of the main journal file. Continue to skip out-of-range pages and
  49334. ** continue adding pages rolled back to pDone.
  49335. */
  49336. while( rc==SQLITE_OK && pPager->journalOff<szJ ){
  49337. u32 ii; /* Loop counter */
  49338. u32 nJRec = 0; /* Number of Journal Records */
  49339. u32 dummy;
  49340. rc = readJournalHdr(pPager, 0, szJ, &nJRec, &dummy);
  49341. assert( rc!=SQLITE_DONE );
  49342. /*
  49343. ** The "pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff"
  49344. ** test is related to ticket #2565. See the discussion in the
  49345. ** pager_playback() function for additional information.
  49346. */
  49347. if( nJRec==0
  49348. && pPager->journalHdr+JOURNAL_HDR_SZ(pPager)==pPager->journalOff
  49349. ){
  49350. nJRec = (u32)((szJ - pPager->journalOff)/JOURNAL_PG_SZ(pPager));
  49351. }
  49352. for(ii=0; rc==SQLITE_OK && ii<nJRec && pPager->journalOff<szJ; ii++){
  49353. rc = pager_playback_one_page(pPager, &pPager->journalOff, pDone, 1, 1);
  49354. }
  49355. assert( rc!=SQLITE_DONE );
  49356. }
  49357. assert( rc!=SQLITE_OK || pPager->journalOff>=szJ );
  49358. /* Finally, rollback pages from the sub-journal. Page that were
  49359. ** previously rolled back out of the main journal (and are hence in pDone)
  49360. ** will be skipped. Out-of-range pages are also skipped.
  49361. */
  49362. if( pSavepoint ){
  49363. u32 ii; /* Loop counter */
  49364. i64 offset = (i64)pSavepoint->iSubRec*(4+pPager->pageSize);
  49365. if( pagerUseWal(pPager) ){
  49366. rc = sqlite3WalSavepointUndo(pPager->pWal, pSavepoint->aWalData);
  49367. }
  49368. for(ii=pSavepoint->iSubRec; rc==SQLITE_OK && ii<pPager->nSubRec; ii++){
  49369. assert( offset==(i64)ii*(4+pPager->pageSize) );
  49370. rc = pager_playback_one_page(pPager, &offset, pDone, 0, 1);
  49371. }
  49372. assert( rc!=SQLITE_DONE );
  49373. }
  49374. sqlite3BitvecDestroy(pDone);
  49375. if( rc==SQLITE_OK ){
  49376. pPager->journalOff = szJ;
  49377. }
  49378. return rc;
  49379. }
  49380. /*
  49381. ** Change the maximum number of in-memory pages that are allowed
  49382. ** before attempting to recycle clean and unused pages.
  49383. */
  49384. SQLITE_PRIVATE void sqlite3PagerSetCachesize(Pager *pPager, int mxPage){
  49385. sqlite3PcacheSetCachesize(pPager->pPCache, mxPage);
  49386. }
  49387. /*
  49388. ** Change the maximum number of in-memory pages that are allowed
  49389. ** before attempting to spill pages to journal.
  49390. */
  49391. SQLITE_PRIVATE int sqlite3PagerSetSpillsize(Pager *pPager, int mxPage){
  49392. return sqlite3PcacheSetSpillsize(pPager->pPCache, mxPage);
  49393. }
  49394. /*
  49395. ** Invoke SQLITE_FCNTL_MMAP_SIZE based on the current value of szMmap.
  49396. */
  49397. static void pagerFixMaplimit(Pager *pPager){
  49398. #if SQLITE_MAX_MMAP_SIZE>0
  49399. sqlite3_file *fd = pPager->fd;
  49400. if( isOpen(fd) && fd->pMethods->iVersion>=3 ){
  49401. sqlite3_int64 sz;
  49402. sz = pPager->szMmap;
  49403. pPager->bUseFetch = (sz>0);
  49404. setGetterMethod(pPager);
  49405. sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_MMAP_SIZE, &sz);
  49406. }
  49407. #endif
  49408. }
  49409. /*
  49410. ** Change the maximum size of any memory mapping made of the database file.
  49411. */
  49412. SQLITE_PRIVATE void sqlite3PagerSetMmapLimit(Pager *pPager, sqlite3_int64 szMmap){
  49413. pPager->szMmap = szMmap;
  49414. pagerFixMaplimit(pPager);
  49415. }
  49416. /*
  49417. ** Free as much memory as possible from the pager.
  49418. */
  49419. SQLITE_PRIVATE void sqlite3PagerShrink(Pager *pPager){
  49420. sqlite3PcacheShrink(pPager->pPCache);
  49421. }
  49422. /*
  49423. ** Adjust settings of the pager to those specified in the pgFlags parameter.
  49424. **
  49425. ** The "level" in pgFlags & PAGER_SYNCHRONOUS_MASK sets the robustness
  49426. ** of the database to damage due to OS crashes or power failures by
  49427. ** changing the number of syncs()s when writing the journals.
  49428. ** There are four levels:
  49429. **
  49430. ** OFF sqlite3OsSync() is never called. This is the default
  49431. ** for temporary and transient files.
  49432. **
  49433. ** NORMAL The journal is synced once before writes begin on the
  49434. ** database. This is normally adequate protection, but
  49435. ** it is theoretically possible, though very unlikely,
  49436. ** that an inopertune power failure could leave the journal
  49437. ** in a state which would cause damage to the database
  49438. ** when it is rolled back.
  49439. **
  49440. ** FULL The journal is synced twice before writes begin on the
  49441. ** database (with some additional information - the nRec field
  49442. ** of the journal header - being written in between the two
  49443. ** syncs). If we assume that writing a
  49444. ** single disk sector is atomic, then this mode provides
  49445. ** assurance that the journal will not be corrupted to the
  49446. ** point of causing damage to the database during rollback.
  49447. **
  49448. ** EXTRA This is like FULL except that is also syncs the directory
  49449. ** that contains the rollback journal after the rollback
  49450. ** journal is unlinked.
  49451. **
  49452. ** The above is for a rollback-journal mode. For WAL mode, OFF continues
  49453. ** to mean that no syncs ever occur. NORMAL means that the WAL is synced
  49454. ** prior to the start of checkpoint and that the database file is synced
  49455. ** at the conclusion of the checkpoint if the entire content of the WAL
  49456. ** was written back into the database. But no sync operations occur for
  49457. ** an ordinary commit in NORMAL mode with WAL. FULL means that the WAL
  49458. ** file is synced following each commit operation, in addition to the
  49459. ** syncs associated with NORMAL. There is no difference between FULL
  49460. ** and EXTRA for WAL mode.
  49461. **
  49462. ** Do not confuse synchronous=FULL with SQLITE_SYNC_FULL. The
  49463. ** SQLITE_SYNC_FULL macro means to use the MacOSX-style full-fsync
  49464. ** using fcntl(F_FULLFSYNC). SQLITE_SYNC_NORMAL means to do an
  49465. ** ordinary fsync() call. There is no difference between SQLITE_SYNC_FULL
  49466. ** and SQLITE_SYNC_NORMAL on platforms other than MacOSX. But the
  49467. ** synchronous=FULL versus synchronous=NORMAL setting determines when
  49468. ** the xSync primitive is called and is relevant to all platforms.
  49469. **
  49470. ** Numeric values associated with these states are OFF==1, NORMAL=2,
  49471. ** and FULL=3.
  49472. */
  49473. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  49474. SQLITE_PRIVATE void sqlite3PagerSetFlags(
  49475. Pager *pPager, /* The pager to set safety level for */
  49476. unsigned pgFlags /* Various flags */
  49477. ){
  49478. unsigned level = pgFlags & PAGER_SYNCHRONOUS_MASK;
  49479. if( pPager->tempFile ){
  49480. pPager->noSync = 1;
  49481. pPager->fullSync = 0;
  49482. pPager->extraSync = 0;
  49483. }else{
  49484. pPager->noSync = level==PAGER_SYNCHRONOUS_OFF ?1:0;
  49485. pPager->fullSync = level>=PAGER_SYNCHRONOUS_FULL ?1:0;
  49486. pPager->extraSync = level==PAGER_SYNCHRONOUS_EXTRA ?1:0;
  49487. }
  49488. if( pPager->noSync ){
  49489. pPager->syncFlags = 0;
  49490. }else if( pgFlags & PAGER_FULLFSYNC ){
  49491. pPager->syncFlags = SQLITE_SYNC_FULL;
  49492. }else{
  49493. pPager->syncFlags = SQLITE_SYNC_NORMAL;
  49494. }
  49495. pPager->walSyncFlags = (pPager->syncFlags<<2);
  49496. if( pPager->fullSync ){
  49497. pPager->walSyncFlags |= pPager->syncFlags;
  49498. }
  49499. if( (pgFlags & PAGER_CKPT_FULLFSYNC) && !pPager->noSync ){
  49500. pPager->walSyncFlags |= (SQLITE_SYNC_FULL<<2);
  49501. }
  49502. if( pgFlags & PAGER_CACHESPILL ){
  49503. pPager->doNotSpill &= ~SPILLFLAG_OFF;
  49504. }else{
  49505. pPager->doNotSpill |= SPILLFLAG_OFF;
  49506. }
  49507. }
  49508. #endif
  49509. /*
  49510. ** The following global variable is incremented whenever the library
  49511. ** attempts to open a temporary file. This information is used for
  49512. ** testing and analysis only.
  49513. */
  49514. #ifdef SQLITE_TEST
  49515. SQLITE_API int sqlite3_opentemp_count = 0;
  49516. #endif
  49517. /*
  49518. ** Open a temporary file.
  49519. **
  49520. ** Write the file descriptor into *pFile. Return SQLITE_OK on success
  49521. ** or some other error code if we fail. The OS will automatically
  49522. ** delete the temporary file when it is closed.
  49523. **
  49524. ** The flags passed to the VFS layer xOpen() call are those specified
  49525. ** by parameter vfsFlags ORed with the following:
  49526. **
  49527. ** SQLITE_OPEN_READWRITE
  49528. ** SQLITE_OPEN_CREATE
  49529. ** SQLITE_OPEN_EXCLUSIVE
  49530. ** SQLITE_OPEN_DELETEONCLOSE
  49531. */
  49532. static int pagerOpentemp(
  49533. Pager *pPager, /* The pager object */
  49534. sqlite3_file *pFile, /* Write the file descriptor here */
  49535. int vfsFlags /* Flags passed through to the VFS */
  49536. ){
  49537. int rc; /* Return code */
  49538. #ifdef SQLITE_TEST
  49539. sqlite3_opentemp_count++; /* Used for testing and analysis only */
  49540. #endif
  49541. vfsFlags |= SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
  49542. SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
  49543. rc = sqlite3OsOpen(pPager->pVfs, 0, pFile, vfsFlags, 0);
  49544. assert( rc!=SQLITE_OK || isOpen(pFile) );
  49545. return rc;
  49546. }
  49547. /*
  49548. ** Set the busy handler function.
  49549. **
  49550. ** The pager invokes the busy-handler if sqlite3OsLock() returns
  49551. ** SQLITE_BUSY when trying to upgrade from no-lock to a SHARED lock,
  49552. ** or when trying to upgrade from a RESERVED lock to an EXCLUSIVE
  49553. ** lock. It does *not* invoke the busy handler when upgrading from
  49554. ** SHARED to RESERVED, or when upgrading from SHARED to EXCLUSIVE
  49555. ** (which occurs during hot-journal rollback). Summary:
  49556. **
  49557. ** Transition | Invokes xBusyHandler
  49558. ** --------------------------------------------------------
  49559. ** NO_LOCK -> SHARED_LOCK | Yes
  49560. ** SHARED_LOCK -> RESERVED_LOCK | No
  49561. ** SHARED_LOCK -> EXCLUSIVE_LOCK | No
  49562. ** RESERVED_LOCK -> EXCLUSIVE_LOCK | Yes
  49563. **
  49564. ** If the busy-handler callback returns non-zero, the lock is
  49565. ** retried. If it returns zero, then the SQLITE_BUSY error is
  49566. ** returned to the caller of the pager API function.
  49567. */
  49568. SQLITE_PRIVATE void sqlite3PagerSetBusyHandler(
  49569. Pager *pPager, /* Pager object */
  49570. int (*xBusyHandler)(void *), /* Pointer to busy-handler function */
  49571. void *pBusyHandlerArg /* Argument to pass to xBusyHandler */
  49572. ){
  49573. void **ap;
  49574. pPager->xBusyHandler = xBusyHandler;
  49575. pPager->pBusyHandlerArg = pBusyHandlerArg;
  49576. ap = (void **)&pPager->xBusyHandler;
  49577. assert( ((int(*)(void *))(ap[0]))==xBusyHandler );
  49578. assert( ap[1]==pBusyHandlerArg );
  49579. sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_BUSYHANDLER, (void *)ap);
  49580. }
  49581. /*
  49582. ** Change the page size used by the Pager object. The new page size
  49583. ** is passed in *pPageSize.
  49584. **
  49585. ** If the pager is in the error state when this function is called, it
  49586. ** is a no-op. The value returned is the error state error code (i.e.
  49587. ** one of SQLITE_IOERR, an SQLITE_IOERR_xxx sub-code or SQLITE_FULL).
  49588. **
  49589. ** Otherwise, if all of the following are true:
  49590. **
  49591. ** * the new page size (value of *pPageSize) is valid (a power
  49592. ** of two between 512 and SQLITE_MAX_PAGE_SIZE, inclusive), and
  49593. **
  49594. ** * there are no outstanding page references, and
  49595. **
  49596. ** * the database is either not an in-memory database or it is
  49597. ** an in-memory database that currently consists of zero pages.
  49598. **
  49599. ** then the pager object page size is set to *pPageSize.
  49600. **
  49601. ** If the page size is changed, then this function uses sqlite3PagerMalloc()
  49602. ** to obtain a new Pager.pTmpSpace buffer. If this allocation attempt
  49603. ** fails, SQLITE_NOMEM is returned and the page size remains unchanged.
  49604. ** In all other cases, SQLITE_OK is returned.
  49605. **
  49606. ** If the page size is not changed, either because one of the enumerated
  49607. ** conditions above is not true, the pager was in error state when this
  49608. ** function was called, or because the memory allocation attempt failed,
  49609. ** then *pPageSize is set to the old, retained page size before returning.
  49610. */
  49611. SQLITE_PRIVATE int sqlite3PagerSetPagesize(Pager *pPager, u32 *pPageSize, int nReserve){
  49612. int rc = SQLITE_OK;
  49613. /* It is not possible to do a full assert_pager_state() here, as this
  49614. ** function may be called from within PagerOpen(), before the state
  49615. ** of the Pager object is internally consistent.
  49616. **
  49617. ** At one point this function returned an error if the pager was in
  49618. ** PAGER_ERROR state. But since PAGER_ERROR state guarantees that
  49619. ** there is at least one outstanding page reference, this function
  49620. ** is a no-op for that case anyhow.
  49621. */
  49622. u32 pageSize = *pPageSize;
  49623. assert( pageSize==0 || (pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE) );
  49624. if( (pPager->memDb==0 || pPager->dbSize==0)
  49625. && sqlite3PcacheRefCount(pPager->pPCache)==0
  49626. && pageSize && pageSize!=(u32)pPager->pageSize
  49627. ){
  49628. char *pNew = NULL; /* New temp space */
  49629. i64 nByte = 0;
  49630. if( pPager->eState>PAGER_OPEN && isOpen(pPager->fd) ){
  49631. rc = sqlite3OsFileSize(pPager->fd, &nByte);
  49632. }
  49633. if( rc==SQLITE_OK ){
  49634. pNew = (char *)sqlite3PageMalloc(pageSize);
  49635. if( !pNew ) rc = SQLITE_NOMEM_BKPT;
  49636. }
  49637. if( rc==SQLITE_OK ){
  49638. pager_reset(pPager);
  49639. rc = sqlite3PcacheSetPageSize(pPager->pPCache, pageSize);
  49640. }
  49641. if( rc==SQLITE_OK ){
  49642. sqlite3PageFree(pPager->pTmpSpace);
  49643. pPager->pTmpSpace = pNew;
  49644. pPager->dbSize = (Pgno)((nByte+pageSize-1)/pageSize);
  49645. pPager->pageSize = pageSize;
  49646. }else{
  49647. sqlite3PageFree(pNew);
  49648. }
  49649. }
  49650. *pPageSize = pPager->pageSize;
  49651. if( rc==SQLITE_OK ){
  49652. if( nReserve<0 ) nReserve = pPager->nReserve;
  49653. assert( nReserve>=0 && nReserve<1000 );
  49654. pPager->nReserve = (i16)nReserve;
  49655. pagerReportSize(pPager);
  49656. pagerFixMaplimit(pPager);
  49657. }
  49658. return rc;
  49659. }
  49660. /*
  49661. ** Return a pointer to the "temporary page" buffer held internally
  49662. ** by the pager. This is a buffer that is big enough to hold the
  49663. ** entire content of a database page. This buffer is used internally
  49664. ** during rollback and will be overwritten whenever a rollback
  49665. ** occurs. But other modules are free to use it too, as long as
  49666. ** no rollbacks are happening.
  49667. */
  49668. SQLITE_PRIVATE void *sqlite3PagerTempSpace(Pager *pPager){
  49669. return pPager->pTmpSpace;
  49670. }
  49671. /*
  49672. ** Attempt to set the maximum database page count if mxPage is positive.
  49673. ** Make no changes if mxPage is zero or negative. And never reduce the
  49674. ** maximum page count below the current size of the database.
  49675. **
  49676. ** Regardless of mxPage, return the current maximum page count.
  49677. */
  49678. SQLITE_PRIVATE int sqlite3PagerMaxPageCount(Pager *pPager, int mxPage){
  49679. if( mxPage>0 ){
  49680. pPager->mxPgno = mxPage;
  49681. }
  49682. assert( pPager->eState!=PAGER_OPEN ); /* Called only by OP_MaxPgcnt */
  49683. assert( pPager->mxPgno>=pPager->dbSize ); /* OP_MaxPgcnt enforces this */
  49684. return pPager->mxPgno;
  49685. }
  49686. /*
  49687. ** The following set of routines are used to disable the simulated
  49688. ** I/O error mechanism. These routines are used to avoid simulated
  49689. ** errors in places where we do not care about errors.
  49690. **
  49691. ** Unless -DSQLITE_TEST=1 is used, these routines are all no-ops
  49692. ** and generate no code.
  49693. */
  49694. #ifdef SQLITE_TEST
  49695. SQLITE_API extern int sqlite3_io_error_pending;
  49696. SQLITE_API extern int sqlite3_io_error_hit;
  49697. static int saved_cnt;
  49698. void disable_simulated_io_errors(void){
  49699. saved_cnt = sqlite3_io_error_pending;
  49700. sqlite3_io_error_pending = -1;
  49701. }
  49702. void enable_simulated_io_errors(void){
  49703. sqlite3_io_error_pending = saved_cnt;
  49704. }
  49705. #else
  49706. # define disable_simulated_io_errors()
  49707. # define enable_simulated_io_errors()
  49708. #endif
  49709. /*
  49710. ** Read the first N bytes from the beginning of the file into memory
  49711. ** that pDest points to.
  49712. **
  49713. ** If the pager was opened on a transient file (zFilename==""), or
  49714. ** opened on a file less than N bytes in size, the output buffer is
  49715. ** zeroed and SQLITE_OK returned. The rationale for this is that this
  49716. ** function is used to read database headers, and a new transient or
  49717. ** zero sized database has a header than consists entirely of zeroes.
  49718. **
  49719. ** If any IO error apart from SQLITE_IOERR_SHORT_READ is encountered,
  49720. ** the error code is returned to the caller and the contents of the
  49721. ** output buffer undefined.
  49722. */
  49723. SQLITE_PRIVATE int sqlite3PagerReadFileheader(Pager *pPager, int N, unsigned char *pDest){
  49724. int rc = SQLITE_OK;
  49725. memset(pDest, 0, N);
  49726. assert( isOpen(pPager->fd) || pPager->tempFile );
  49727. /* This routine is only called by btree immediately after creating
  49728. ** the Pager object. There has not been an opportunity to transition
  49729. ** to WAL mode yet.
  49730. */
  49731. assert( !pagerUseWal(pPager) );
  49732. if( isOpen(pPager->fd) ){
  49733. IOTRACE(("DBHDR %p 0 %d\n", pPager, N))
  49734. rc = sqlite3OsRead(pPager->fd, pDest, N, 0);
  49735. if( rc==SQLITE_IOERR_SHORT_READ ){
  49736. rc = SQLITE_OK;
  49737. }
  49738. }
  49739. return rc;
  49740. }
  49741. /*
  49742. ** This function may only be called when a read-transaction is open on
  49743. ** the pager. It returns the total number of pages in the database.
  49744. **
  49745. ** However, if the file is between 1 and <page-size> bytes in size, then
  49746. ** this is considered a 1 page file.
  49747. */
  49748. SQLITE_PRIVATE void sqlite3PagerPagecount(Pager *pPager, int *pnPage){
  49749. assert( pPager->eState>=PAGER_READER );
  49750. assert( pPager->eState!=PAGER_WRITER_FINISHED );
  49751. *pnPage = (int)pPager->dbSize;
  49752. }
  49753. /*
  49754. ** Try to obtain a lock of type locktype on the database file. If
  49755. ** a similar or greater lock is already held, this function is a no-op
  49756. ** (returning SQLITE_OK immediately).
  49757. **
  49758. ** Otherwise, attempt to obtain the lock using sqlite3OsLock(). Invoke
  49759. ** the busy callback if the lock is currently not available. Repeat
  49760. ** until the busy callback returns false or until the attempt to
  49761. ** obtain the lock succeeds.
  49762. **
  49763. ** Return SQLITE_OK on success and an error code if we cannot obtain
  49764. ** the lock. If the lock is obtained successfully, set the Pager.state
  49765. ** variable to locktype before returning.
  49766. */
  49767. static int pager_wait_on_lock(Pager *pPager, int locktype){
  49768. int rc; /* Return code */
  49769. /* Check that this is either a no-op (because the requested lock is
  49770. ** already held), or one of the transitions that the busy-handler
  49771. ** may be invoked during, according to the comment above
  49772. ** sqlite3PagerSetBusyhandler().
  49773. */
  49774. assert( (pPager->eLock>=locktype)
  49775. || (pPager->eLock==NO_LOCK && locktype==SHARED_LOCK)
  49776. || (pPager->eLock==RESERVED_LOCK && locktype==EXCLUSIVE_LOCK)
  49777. );
  49778. do {
  49779. rc = pagerLockDb(pPager, locktype);
  49780. }while( rc==SQLITE_BUSY && pPager->xBusyHandler(pPager->pBusyHandlerArg) );
  49781. return rc;
  49782. }
  49783. /*
  49784. ** Function assertTruncateConstraint(pPager) checks that one of the
  49785. ** following is true for all dirty pages currently in the page-cache:
  49786. **
  49787. ** a) The page number is less than or equal to the size of the
  49788. ** current database image, in pages, OR
  49789. **
  49790. ** b) if the page content were written at this time, it would not
  49791. ** be necessary to write the current content out to the sub-journal
  49792. ** (as determined by function subjRequiresPage()).
  49793. **
  49794. ** If the condition asserted by this function were not true, and the
  49795. ** dirty page were to be discarded from the cache via the pagerStress()
  49796. ** routine, pagerStress() would not write the current page content to
  49797. ** the database file. If a savepoint transaction were rolled back after
  49798. ** this happened, the correct behavior would be to restore the current
  49799. ** content of the page. However, since this content is not present in either
  49800. ** the database file or the portion of the rollback journal and
  49801. ** sub-journal rolled back the content could not be restored and the
  49802. ** database image would become corrupt. It is therefore fortunate that
  49803. ** this circumstance cannot arise.
  49804. */
  49805. #if defined(SQLITE_DEBUG)
  49806. static void assertTruncateConstraintCb(PgHdr *pPg){
  49807. assert( pPg->flags&PGHDR_DIRTY );
  49808. assert( !subjRequiresPage(pPg) || pPg->pgno<=pPg->pPager->dbSize );
  49809. }
  49810. static void assertTruncateConstraint(Pager *pPager){
  49811. sqlite3PcacheIterateDirty(pPager->pPCache, assertTruncateConstraintCb);
  49812. }
  49813. #else
  49814. # define assertTruncateConstraint(pPager)
  49815. #endif
  49816. /*
  49817. ** Truncate the in-memory database file image to nPage pages. This
  49818. ** function does not actually modify the database file on disk. It
  49819. ** just sets the internal state of the pager object so that the
  49820. ** truncation will be done when the current transaction is committed.
  49821. **
  49822. ** This function is only called right before committing a transaction.
  49823. ** Once this function has been called, the transaction must either be
  49824. ** rolled back or committed. It is not safe to call this function and
  49825. ** then continue writing to the database.
  49826. */
  49827. SQLITE_PRIVATE void sqlite3PagerTruncateImage(Pager *pPager, Pgno nPage){
  49828. assert( pPager->dbSize>=nPage );
  49829. assert( pPager->eState>=PAGER_WRITER_CACHEMOD );
  49830. pPager->dbSize = nPage;
  49831. /* At one point the code here called assertTruncateConstraint() to
  49832. ** ensure that all pages being truncated away by this operation are,
  49833. ** if one or more savepoints are open, present in the savepoint
  49834. ** journal so that they can be restored if the savepoint is rolled
  49835. ** back. This is no longer necessary as this function is now only
  49836. ** called right before committing a transaction. So although the
  49837. ** Pager object may still have open savepoints (Pager.nSavepoint!=0),
  49838. ** they cannot be rolled back. So the assertTruncateConstraint() call
  49839. ** is no longer correct. */
  49840. }
  49841. /*
  49842. ** This function is called before attempting a hot-journal rollback. It
  49843. ** syncs the journal file to disk, then sets pPager->journalHdr to the
  49844. ** size of the journal file so that the pager_playback() routine knows
  49845. ** that the entire journal file has been synced.
  49846. **
  49847. ** Syncing a hot-journal to disk before attempting to roll it back ensures
  49848. ** that if a power-failure occurs during the rollback, the process that
  49849. ** attempts rollback following system recovery sees the same journal
  49850. ** content as this process.
  49851. **
  49852. ** If everything goes as planned, SQLITE_OK is returned. Otherwise,
  49853. ** an SQLite error code.
  49854. */
  49855. static int pagerSyncHotJournal(Pager *pPager){
  49856. int rc = SQLITE_OK;
  49857. if( !pPager->noSync ){
  49858. rc = sqlite3OsSync(pPager->jfd, SQLITE_SYNC_NORMAL);
  49859. }
  49860. if( rc==SQLITE_OK ){
  49861. rc = sqlite3OsFileSize(pPager->jfd, &pPager->journalHdr);
  49862. }
  49863. return rc;
  49864. }
  49865. #if SQLITE_MAX_MMAP_SIZE>0
  49866. /*
  49867. ** Obtain a reference to a memory mapped page object for page number pgno.
  49868. ** The new object will use the pointer pData, obtained from xFetch().
  49869. ** If successful, set *ppPage to point to the new page reference
  49870. ** and return SQLITE_OK. Otherwise, return an SQLite error code and set
  49871. ** *ppPage to zero.
  49872. **
  49873. ** Page references obtained by calling this function should be released
  49874. ** by calling pagerReleaseMapPage().
  49875. */
  49876. static int pagerAcquireMapPage(
  49877. Pager *pPager, /* Pager object */
  49878. Pgno pgno, /* Page number */
  49879. void *pData, /* xFetch()'d data for this page */
  49880. PgHdr **ppPage /* OUT: Acquired page object */
  49881. ){
  49882. PgHdr *p; /* Memory mapped page to return */
  49883. if( pPager->pMmapFreelist ){
  49884. *ppPage = p = pPager->pMmapFreelist;
  49885. pPager->pMmapFreelist = p->pDirty;
  49886. p->pDirty = 0;
  49887. assert( pPager->nExtra>=8 );
  49888. memset(p->pExtra, 0, 8);
  49889. }else{
  49890. *ppPage = p = (PgHdr *)sqlite3MallocZero(sizeof(PgHdr) + pPager->nExtra);
  49891. if( p==0 ){
  49892. sqlite3OsUnfetch(pPager->fd, (i64)(pgno-1) * pPager->pageSize, pData);
  49893. return SQLITE_NOMEM_BKPT;
  49894. }
  49895. p->pExtra = (void *)&p[1];
  49896. p->flags = PGHDR_MMAP;
  49897. p->nRef = 1;
  49898. p->pPager = pPager;
  49899. }
  49900. assert( p->pExtra==(void *)&p[1] );
  49901. assert( p->pPage==0 );
  49902. assert( p->flags==PGHDR_MMAP );
  49903. assert( p->pPager==pPager );
  49904. assert( p->nRef==1 );
  49905. p->pgno = pgno;
  49906. p->pData = pData;
  49907. pPager->nMmapOut++;
  49908. return SQLITE_OK;
  49909. }
  49910. #endif
  49911. /*
  49912. ** Release a reference to page pPg. pPg must have been returned by an
  49913. ** earlier call to pagerAcquireMapPage().
  49914. */
  49915. static void pagerReleaseMapPage(PgHdr *pPg){
  49916. Pager *pPager = pPg->pPager;
  49917. pPager->nMmapOut--;
  49918. pPg->pDirty = pPager->pMmapFreelist;
  49919. pPager->pMmapFreelist = pPg;
  49920. assert( pPager->fd->pMethods->iVersion>=3 );
  49921. sqlite3OsUnfetch(pPager->fd, (i64)(pPg->pgno-1)*pPager->pageSize, pPg->pData);
  49922. }
  49923. /*
  49924. ** Free all PgHdr objects stored in the Pager.pMmapFreelist list.
  49925. */
  49926. static void pagerFreeMapHdrs(Pager *pPager){
  49927. PgHdr *p;
  49928. PgHdr *pNext;
  49929. for(p=pPager->pMmapFreelist; p; p=pNext){
  49930. pNext = p->pDirty;
  49931. sqlite3_free(p);
  49932. }
  49933. }
  49934. /* Verify that the database file has not be deleted or renamed out from
  49935. ** under the pager. Return SQLITE_OK if the database is still where it ought
  49936. ** to be on disk. Return non-zero (SQLITE_READONLY_DBMOVED or some other error
  49937. ** code from sqlite3OsAccess()) if the database has gone missing.
  49938. */
  49939. static int databaseIsUnmoved(Pager *pPager){
  49940. int bHasMoved = 0;
  49941. int rc;
  49942. if( pPager->tempFile ) return SQLITE_OK;
  49943. if( pPager->dbSize==0 ) return SQLITE_OK;
  49944. assert( pPager->zFilename && pPager->zFilename[0] );
  49945. rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_HAS_MOVED, &bHasMoved);
  49946. if( rc==SQLITE_NOTFOUND ){
  49947. /* If the HAS_MOVED file-control is unimplemented, assume that the file
  49948. ** has not been moved. That is the historical behavior of SQLite: prior to
  49949. ** version 3.8.3, it never checked */
  49950. rc = SQLITE_OK;
  49951. }else if( rc==SQLITE_OK && bHasMoved ){
  49952. rc = SQLITE_READONLY_DBMOVED;
  49953. }
  49954. return rc;
  49955. }
  49956. /*
  49957. ** Shutdown the page cache. Free all memory and close all files.
  49958. **
  49959. ** If a transaction was in progress when this routine is called, that
  49960. ** transaction is rolled back. All outstanding pages are invalidated
  49961. ** and their memory is freed. Any attempt to use a page associated
  49962. ** with this page cache after this function returns will likely
  49963. ** result in a coredump.
  49964. **
  49965. ** This function always succeeds. If a transaction is active an attempt
  49966. ** is made to roll it back. If an error occurs during the rollback
  49967. ** a hot journal may be left in the filesystem but no error is returned
  49968. ** to the caller.
  49969. */
  49970. SQLITE_PRIVATE int sqlite3PagerClose(Pager *pPager, sqlite3 *db){
  49971. u8 *pTmp = (u8*)pPager->pTmpSpace;
  49972. assert( db || pagerUseWal(pPager)==0 );
  49973. assert( assert_pager_state(pPager) );
  49974. disable_simulated_io_errors();
  49975. sqlite3BeginBenignMalloc();
  49976. pagerFreeMapHdrs(pPager);
  49977. /* pPager->errCode = 0; */
  49978. pPager->exclusiveMode = 0;
  49979. #ifndef SQLITE_OMIT_WAL
  49980. {
  49981. u8 *a = 0;
  49982. assert( db || pPager->pWal==0 );
  49983. if( db && 0==(db->flags & SQLITE_NoCkptOnClose)
  49984. && SQLITE_OK==databaseIsUnmoved(pPager)
  49985. ){
  49986. a = pTmp;
  49987. }
  49988. sqlite3WalClose(pPager->pWal, db, pPager->walSyncFlags, pPager->pageSize,a);
  49989. pPager->pWal = 0;
  49990. }
  49991. #endif
  49992. pager_reset(pPager);
  49993. if( MEMDB ){
  49994. pager_unlock(pPager);
  49995. }else{
  49996. /* If it is open, sync the journal file before calling UnlockAndRollback.
  49997. ** If this is not done, then an unsynced portion of the open journal
  49998. ** file may be played back into the database. If a power failure occurs
  49999. ** while this is happening, the database could become corrupt.
  50000. **
  50001. ** If an error occurs while trying to sync the journal, shift the pager
  50002. ** into the ERROR state. This causes UnlockAndRollback to unlock the
  50003. ** database and close the journal file without attempting to roll it
  50004. ** back or finalize it. The next database user will have to do hot-journal
  50005. ** rollback before accessing the database file.
  50006. */
  50007. if( isOpen(pPager->jfd) ){
  50008. pager_error(pPager, pagerSyncHotJournal(pPager));
  50009. }
  50010. pagerUnlockAndRollback(pPager);
  50011. }
  50012. sqlite3EndBenignMalloc();
  50013. enable_simulated_io_errors();
  50014. PAGERTRACE(("CLOSE %d\n", PAGERID(pPager)));
  50015. IOTRACE(("CLOSE %p\n", pPager))
  50016. sqlite3OsClose(pPager->jfd);
  50017. sqlite3OsClose(pPager->fd);
  50018. sqlite3PageFree(pTmp);
  50019. sqlite3PcacheClose(pPager->pPCache);
  50020. #ifdef SQLITE_HAS_CODEC
  50021. if( pPager->xCodecFree ) pPager->xCodecFree(pPager->pCodec);
  50022. #endif
  50023. assert( !pPager->aSavepoint && !pPager->pInJournal );
  50024. assert( !isOpen(pPager->jfd) && !isOpen(pPager->sjfd) );
  50025. sqlite3_free(pPager);
  50026. return SQLITE_OK;
  50027. }
  50028. #if !defined(NDEBUG) || defined(SQLITE_TEST)
  50029. /*
  50030. ** Return the page number for page pPg.
  50031. */
  50032. SQLITE_PRIVATE Pgno sqlite3PagerPagenumber(DbPage *pPg){
  50033. return pPg->pgno;
  50034. }
  50035. #endif
  50036. /*
  50037. ** Increment the reference count for page pPg.
  50038. */
  50039. SQLITE_PRIVATE void sqlite3PagerRef(DbPage *pPg){
  50040. sqlite3PcacheRef(pPg);
  50041. }
  50042. /*
  50043. ** Sync the journal. In other words, make sure all the pages that have
  50044. ** been written to the journal have actually reached the surface of the
  50045. ** disk and can be restored in the event of a hot-journal rollback.
  50046. **
  50047. ** If the Pager.noSync flag is set, then this function is a no-op.
  50048. ** Otherwise, the actions required depend on the journal-mode and the
  50049. ** device characteristics of the file-system, as follows:
  50050. **
  50051. ** * If the journal file is an in-memory journal file, no action need
  50052. ** be taken.
  50053. **
  50054. ** * Otherwise, if the device does not support the SAFE_APPEND property,
  50055. ** then the nRec field of the most recently written journal header
  50056. ** is updated to contain the number of journal records that have
  50057. ** been written following it. If the pager is operating in full-sync
  50058. ** mode, then the journal file is synced before this field is updated.
  50059. **
  50060. ** * If the device does not support the SEQUENTIAL property, then
  50061. ** journal file is synced.
  50062. **
  50063. ** Or, in pseudo-code:
  50064. **
  50065. ** if( NOT <in-memory journal> ){
  50066. ** if( NOT SAFE_APPEND ){
  50067. ** if( <full-sync mode> ) xSync(<journal file>);
  50068. ** <update nRec field>
  50069. ** }
  50070. ** if( NOT SEQUENTIAL ) xSync(<journal file>);
  50071. ** }
  50072. **
  50073. ** If successful, this routine clears the PGHDR_NEED_SYNC flag of every
  50074. ** page currently held in memory before returning SQLITE_OK. If an IO
  50075. ** error is encountered, then the IO error code is returned to the caller.
  50076. */
  50077. static int syncJournal(Pager *pPager, int newHdr){
  50078. int rc; /* Return code */
  50079. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  50080. || pPager->eState==PAGER_WRITER_DBMOD
  50081. );
  50082. assert( assert_pager_state(pPager) );
  50083. assert( !pagerUseWal(pPager) );
  50084. rc = sqlite3PagerExclusiveLock(pPager);
  50085. if( rc!=SQLITE_OK ) return rc;
  50086. if( !pPager->noSync ){
  50087. assert( !pPager->tempFile );
  50088. if( isOpen(pPager->jfd) && pPager->journalMode!=PAGER_JOURNALMODE_MEMORY ){
  50089. const int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
  50090. assert( isOpen(pPager->jfd) );
  50091. if( 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
  50092. /* This block deals with an obscure problem. If the last connection
  50093. ** that wrote to this database was operating in persistent-journal
  50094. ** mode, then the journal file may at this point actually be larger
  50095. ** than Pager.journalOff bytes. If the next thing in the journal
  50096. ** file happens to be a journal-header (written as part of the
  50097. ** previous connection's transaction), and a crash or power-failure
  50098. ** occurs after nRec is updated but before this connection writes
  50099. ** anything else to the journal file (or commits/rolls back its
  50100. ** transaction), then SQLite may become confused when doing the
  50101. ** hot-journal rollback following recovery. It may roll back all
  50102. ** of this connections data, then proceed to rolling back the old,
  50103. ** out-of-date data that follows it. Database corruption.
  50104. **
  50105. ** To work around this, if the journal file does appear to contain
  50106. ** a valid header following Pager.journalOff, then write a 0x00
  50107. ** byte to the start of it to prevent it from being recognized.
  50108. **
  50109. ** Variable iNextHdrOffset is set to the offset at which this
  50110. ** problematic header will occur, if it exists. aMagic is used
  50111. ** as a temporary buffer to inspect the first couple of bytes of
  50112. ** the potential journal header.
  50113. */
  50114. i64 iNextHdrOffset;
  50115. u8 aMagic[8];
  50116. u8 zHeader[sizeof(aJournalMagic)+4];
  50117. memcpy(zHeader, aJournalMagic, sizeof(aJournalMagic));
  50118. put32bits(&zHeader[sizeof(aJournalMagic)], pPager->nRec);
  50119. iNextHdrOffset = journalHdrOffset(pPager);
  50120. rc = sqlite3OsRead(pPager->jfd, aMagic, 8, iNextHdrOffset);
  50121. if( rc==SQLITE_OK && 0==memcmp(aMagic, aJournalMagic, 8) ){
  50122. static const u8 zerobyte = 0;
  50123. rc = sqlite3OsWrite(pPager->jfd, &zerobyte, 1, iNextHdrOffset);
  50124. }
  50125. if( rc!=SQLITE_OK && rc!=SQLITE_IOERR_SHORT_READ ){
  50126. return rc;
  50127. }
  50128. /* Write the nRec value into the journal file header. If in
  50129. ** full-synchronous mode, sync the journal first. This ensures that
  50130. ** all data has really hit the disk before nRec is updated to mark
  50131. ** it as a candidate for rollback.
  50132. **
  50133. ** This is not required if the persistent media supports the
  50134. ** SAFE_APPEND property. Because in this case it is not possible
  50135. ** for garbage data to be appended to the file, the nRec field
  50136. ** is populated with 0xFFFFFFFF when the journal header is written
  50137. ** and never needs to be updated.
  50138. */
  50139. if( pPager->fullSync && 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
  50140. PAGERTRACE(("SYNC journal of %d\n", PAGERID(pPager)));
  50141. IOTRACE(("JSYNC %p\n", pPager))
  50142. rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags);
  50143. if( rc!=SQLITE_OK ) return rc;
  50144. }
  50145. IOTRACE(("JHDR %p %lld\n", pPager, pPager->journalHdr));
  50146. rc = sqlite3OsWrite(
  50147. pPager->jfd, zHeader, sizeof(zHeader), pPager->journalHdr
  50148. );
  50149. if( rc!=SQLITE_OK ) return rc;
  50150. }
  50151. if( 0==(iDc&SQLITE_IOCAP_SEQUENTIAL) ){
  50152. PAGERTRACE(("SYNC journal of %d\n", PAGERID(pPager)));
  50153. IOTRACE(("JSYNC %p\n", pPager))
  50154. rc = sqlite3OsSync(pPager->jfd, pPager->syncFlags|
  50155. (pPager->syncFlags==SQLITE_SYNC_FULL?SQLITE_SYNC_DATAONLY:0)
  50156. );
  50157. if( rc!=SQLITE_OK ) return rc;
  50158. }
  50159. pPager->journalHdr = pPager->journalOff;
  50160. if( newHdr && 0==(iDc&SQLITE_IOCAP_SAFE_APPEND) ){
  50161. pPager->nRec = 0;
  50162. rc = writeJournalHdr(pPager);
  50163. if( rc!=SQLITE_OK ) return rc;
  50164. }
  50165. }else{
  50166. pPager->journalHdr = pPager->journalOff;
  50167. }
  50168. }
  50169. /* Unless the pager is in noSync mode, the journal file was just
  50170. ** successfully synced. Either way, clear the PGHDR_NEED_SYNC flag on
  50171. ** all pages.
  50172. */
  50173. sqlite3PcacheClearSyncFlags(pPager->pPCache);
  50174. pPager->eState = PAGER_WRITER_DBMOD;
  50175. assert( assert_pager_state(pPager) );
  50176. return SQLITE_OK;
  50177. }
  50178. /*
  50179. ** The argument is the first in a linked list of dirty pages connected
  50180. ** by the PgHdr.pDirty pointer. This function writes each one of the
  50181. ** in-memory pages in the list to the database file. The argument may
  50182. ** be NULL, representing an empty list. In this case this function is
  50183. ** a no-op.
  50184. **
  50185. ** The pager must hold at least a RESERVED lock when this function
  50186. ** is called. Before writing anything to the database file, this lock
  50187. ** is upgraded to an EXCLUSIVE lock. If the lock cannot be obtained,
  50188. ** SQLITE_BUSY is returned and no data is written to the database file.
  50189. **
  50190. ** If the pager is a temp-file pager and the actual file-system file
  50191. ** is not yet open, it is created and opened before any data is
  50192. ** written out.
  50193. **
  50194. ** Once the lock has been upgraded and, if necessary, the file opened,
  50195. ** the pages are written out to the database file in list order. Writing
  50196. ** a page is skipped if it meets either of the following criteria:
  50197. **
  50198. ** * The page number is greater than Pager.dbSize, or
  50199. ** * The PGHDR_DONT_WRITE flag is set on the page.
  50200. **
  50201. ** If writing out a page causes the database file to grow, Pager.dbFileSize
  50202. ** is updated accordingly. If page 1 is written out, then the value cached
  50203. ** in Pager.dbFileVers[] is updated to match the new value stored in
  50204. ** the database file.
  50205. **
  50206. ** If everything is successful, SQLITE_OK is returned. If an IO error
  50207. ** occurs, an IO error code is returned. Or, if the EXCLUSIVE lock cannot
  50208. ** be obtained, SQLITE_BUSY is returned.
  50209. */
  50210. static int pager_write_pagelist(Pager *pPager, PgHdr *pList){
  50211. int rc = SQLITE_OK; /* Return code */
  50212. /* This function is only called for rollback pagers in WRITER_DBMOD state. */
  50213. assert( !pagerUseWal(pPager) );
  50214. assert( pPager->tempFile || pPager->eState==PAGER_WRITER_DBMOD );
  50215. assert( pPager->eLock==EXCLUSIVE_LOCK );
  50216. assert( isOpen(pPager->fd) || pList->pDirty==0 );
  50217. /* If the file is a temp-file has not yet been opened, open it now. It
  50218. ** is not possible for rc to be other than SQLITE_OK if this branch
  50219. ** is taken, as pager_wait_on_lock() is a no-op for temp-files.
  50220. */
  50221. if( !isOpen(pPager->fd) ){
  50222. assert( pPager->tempFile && rc==SQLITE_OK );
  50223. rc = pagerOpentemp(pPager, pPager->fd, pPager->vfsFlags);
  50224. }
  50225. /* Before the first write, give the VFS a hint of what the final
  50226. ** file size will be.
  50227. */
  50228. assert( rc!=SQLITE_OK || isOpen(pPager->fd) );
  50229. if( rc==SQLITE_OK
  50230. && pPager->dbHintSize<pPager->dbSize
  50231. && (pList->pDirty || pList->pgno>pPager->dbHintSize)
  50232. ){
  50233. sqlite3_int64 szFile = pPager->pageSize * (sqlite3_int64)pPager->dbSize;
  50234. sqlite3OsFileControlHint(pPager->fd, SQLITE_FCNTL_SIZE_HINT, &szFile);
  50235. pPager->dbHintSize = pPager->dbSize;
  50236. }
  50237. while( rc==SQLITE_OK && pList ){
  50238. Pgno pgno = pList->pgno;
  50239. /* If there are dirty pages in the page cache with page numbers greater
  50240. ** than Pager.dbSize, this means sqlite3PagerTruncateImage() was called to
  50241. ** make the file smaller (presumably by auto-vacuum code). Do not write
  50242. ** any such pages to the file.
  50243. **
  50244. ** Also, do not write out any page that has the PGHDR_DONT_WRITE flag
  50245. ** set (set by sqlite3PagerDontWrite()).
  50246. */
  50247. if( pgno<=pPager->dbSize && 0==(pList->flags&PGHDR_DONT_WRITE) ){
  50248. i64 offset = (pgno-1)*(i64)pPager->pageSize; /* Offset to write */
  50249. char *pData; /* Data to write */
  50250. assert( (pList->flags&PGHDR_NEED_SYNC)==0 );
  50251. if( pList->pgno==1 ) pager_write_changecounter(pList);
  50252. /* Encode the database */
  50253. CODEC2(pPager, pList->pData, pgno, 6, return SQLITE_NOMEM_BKPT, pData);
  50254. /* Write out the page data. */
  50255. rc = sqlite3OsWrite(pPager->fd, pData, pPager->pageSize, offset);
  50256. /* If page 1 was just written, update Pager.dbFileVers to match
  50257. ** the value now stored in the database file. If writing this
  50258. ** page caused the database file to grow, update dbFileSize.
  50259. */
  50260. if( pgno==1 ){
  50261. memcpy(&pPager->dbFileVers, &pData[24], sizeof(pPager->dbFileVers));
  50262. }
  50263. if( pgno>pPager->dbFileSize ){
  50264. pPager->dbFileSize = pgno;
  50265. }
  50266. pPager->aStat[PAGER_STAT_WRITE]++;
  50267. /* Update any backup objects copying the contents of this pager. */
  50268. sqlite3BackupUpdate(pPager->pBackup, pgno, (u8*)pList->pData);
  50269. PAGERTRACE(("STORE %d page %d hash(%08x)\n",
  50270. PAGERID(pPager), pgno, pager_pagehash(pList)));
  50271. IOTRACE(("PGOUT %p %d\n", pPager, pgno));
  50272. PAGER_INCR(sqlite3_pager_writedb_count);
  50273. }else{
  50274. PAGERTRACE(("NOSTORE %d page %d\n", PAGERID(pPager), pgno));
  50275. }
  50276. pager_set_pagehash(pList);
  50277. pList = pList->pDirty;
  50278. }
  50279. return rc;
  50280. }
  50281. /*
  50282. ** Ensure that the sub-journal file is open. If it is already open, this
  50283. ** function is a no-op.
  50284. **
  50285. ** SQLITE_OK is returned if everything goes according to plan. An
  50286. ** SQLITE_IOERR_XXX error code is returned if a call to sqlite3OsOpen()
  50287. ** fails.
  50288. */
  50289. static int openSubJournal(Pager *pPager){
  50290. int rc = SQLITE_OK;
  50291. if( !isOpen(pPager->sjfd) ){
  50292. const int flags = SQLITE_OPEN_SUBJOURNAL | SQLITE_OPEN_READWRITE
  50293. | SQLITE_OPEN_CREATE | SQLITE_OPEN_EXCLUSIVE
  50294. | SQLITE_OPEN_DELETEONCLOSE;
  50295. int nStmtSpill = sqlite3Config.nStmtSpill;
  50296. if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY || pPager->subjInMemory ){
  50297. nStmtSpill = -1;
  50298. }
  50299. rc = sqlite3JournalOpen(pPager->pVfs, 0, pPager->sjfd, flags, nStmtSpill);
  50300. }
  50301. return rc;
  50302. }
  50303. /*
  50304. ** Append a record of the current state of page pPg to the sub-journal.
  50305. **
  50306. ** If successful, set the bit corresponding to pPg->pgno in the bitvecs
  50307. ** for all open savepoints before returning.
  50308. **
  50309. ** This function returns SQLITE_OK if everything is successful, an IO
  50310. ** error code if the attempt to write to the sub-journal fails, or
  50311. ** SQLITE_NOMEM if a malloc fails while setting a bit in a savepoint
  50312. ** bitvec.
  50313. */
  50314. static int subjournalPage(PgHdr *pPg){
  50315. int rc = SQLITE_OK;
  50316. Pager *pPager = pPg->pPager;
  50317. if( pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
  50318. /* Open the sub-journal, if it has not already been opened */
  50319. assert( pPager->useJournal );
  50320. assert( isOpen(pPager->jfd) || pagerUseWal(pPager) );
  50321. assert( isOpen(pPager->sjfd) || pPager->nSubRec==0 );
  50322. assert( pagerUseWal(pPager)
  50323. || pageInJournal(pPager, pPg)
  50324. || pPg->pgno>pPager->dbOrigSize
  50325. );
  50326. rc = openSubJournal(pPager);
  50327. /* If the sub-journal was opened successfully (or was already open),
  50328. ** write the journal record into the file. */
  50329. if( rc==SQLITE_OK ){
  50330. void *pData = pPg->pData;
  50331. i64 offset = (i64)pPager->nSubRec*(4+pPager->pageSize);
  50332. char *pData2;
  50333. #if SQLITE_HAS_CODEC
  50334. if( !pPager->subjInMemory ){
  50335. CODEC2(pPager, pData, pPg->pgno, 7, return SQLITE_NOMEM_BKPT, pData2);
  50336. }else
  50337. #endif
  50338. pData2 = pData;
  50339. PAGERTRACE(("STMT-JOURNAL %d page %d\n", PAGERID(pPager), pPg->pgno));
  50340. rc = write32bits(pPager->sjfd, offset, pPg->pgno);
  50341. if( rc==SQLITE_OK ){
  50342. rc = sqlite3OsWrite(pPager->sjfd, pData2, pPager->pageSize, offset+4);
  50343. }
  50344. }
  50345. }
  50346. if( rc==SQLITE_OK ){
  50347. pPager->nSubRec++;
  50348. assert( pPager->nSavepoint>0 );
  50349. rc = addToSavepointBitvecs(pPager, pPg->pgno);
  50350. }
  50351. return rc;
  50352. }
  50353. static int subjournalPageIfRequired(PgHdr *pPg){
  50354. if( subjRequiresPage(pPg) ){
  50355. return subjournalPage(pPg);
  50356. }else{
  50357. return SQLITE_OK;
  50358. }
  50359. }
  50360. /*
  50361. ** This function is called by the pcache layer when it has reached some
  50362. ** soft memory limit. The first argument is a pointer to a Pager object
  50363. ** (cast as a void*). The pager is always 'purgeable' (not an in-memory
  50364. ** database). The second argument is a reference to a page that is
  50365. ** currently dirty but has no outstanding references. The page
  50366. ** is always associated with the Pager object passed as the first
  50367. ** argument.
  50368. **
  50369. ** The job of this function is to make pPg clean by writing its contents
  50370. ** out to the database file, if possible. This may involve syncing the
  50371. ** journal file.
  50372. **
  50373. ** If successful, sqlite3PcacheMakeClean() is called on the page and
  50374. ** SQLITE_OK returned. If an IO error occurs while trying to make the
  50375. ** page clean, the IO error code is returned. If the page cannot be
  50376. ** made clean for some other reason, but no error occurs, then SQLITE_OK
  50377. ** is returned by sqlite3PcacheMakeClean() is not called.
  50378. */
  50379. static int pagerStress(void *p, PgHdr *pPg){
  50380. Pager *pPager = (Pager *)p;
  50381. int rc = SQLITE_OK;
  50382. assert( pPg->pPager==pPager );
  50383. assert( pPg->flags&PGHDR_DIRTY );
  50384. /* The doNotSpill NOSYNC bit is set during times when doing a sync of
  50385. ** journal (and adding a new header) is not allowed. This occurs
  50386. ** during calls to sqlite3PagerWrite() while trying to journal multiple
  50387. ** pages belonging to the same sector.
  50388. **
  50389. ** The doNotSpill ROLLBACK and OFF bits inhibits all cache spilling
  50390. ** regardless of whether or not a sync is required. This is set during
  50391. ** a rollback or by user request, respectively.
  50392. **
  50393. ** Spilling is also prohibited when in an error state since that could
  50394. ** lead to database corruption. In the current implementation it
  50395. ** is impossible for sqlite3PcacheFetch() to be called with createFlag==3
  50396. ** while in the error state, hence it is impossible for this routine to
  50397. ** be called in the error state. Nevertheless, we include a NEVER()
  50398. ** test for the error state as a safeguard against future changes.
  50399. */
  50400. if( NEVER(pPager->errCode) ) return SQLITE_OK;
  50401. testcase( pPager->doNotSpill & SPILLFLAG_ROLLBACK );
  50402. testcase( pPager->doNotSpill & SPILLFLAG_OFF );
  50403. testcase( pPager->doNotSpill & SPILLFLAG_NOSYNC );
  50404. if( pPager->doNotSpill
  50405. && ((pPager->doNotSpill & (SPILLFLAG_ROLLBACK|SPILLFLAG_OFF))!=0
  50406. || (pPg->flags & PGHDR_NEED_SYNC)!=0)
  50407. ){
  50408. return SQLITE_OK;
  50409. }
  50410. pPager->aStat[PAGER_STAT_SPILL]++;
  50411. pPg->pDirty = 0;
  50412. if( pagerUseWal(pPager) ){
  50413. /* Write a single frame for this page to the log. */
  50414. rc = subjournalPageIfRequired(pPg);
  50415. if( rc==SQLITE_OK ){
  50416. rc = pagerWalFrames(pPager, pPg, 0, 0);
  50417. }
  50418. }else{
  50419. #ifdef SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  50420. if( pPager->tempFile==0 ){
  50421. rc = sqlite3JournalCreate(pPager->jfd);
  50422. if( rc!=SQLITE_OK ) return pager_error(pPager, rc);
  50423. }
  50424. #endif
  50425. /* Sync the journal file if required. */
  50426. if( pPg->flags&PGHDR_NEED_SYNC
  50427. || pPager->eState==PAGER_WRITER_CACHEMOD
  50428. ){
  50429. rc = syncJournal(pPager, 1);
  50430. }
  50431. /* Write the contents of the page out to the database file. */
  50432. if( rc==SQLITE_OK ){
  50433. assert( (pPg->flags&PGHDR_NEED_SYNC)==0 );
  50434. rc = pager_write_pagelist(pPager, pPg);
  50435. }
  50436. }
  50437. /* Mark the page as clean. */
  50438. if( rc==SQLITE_OK ){
  50439. PAGERTRACE(("STRESS %d page %d\n", PAGERID(pPager), pPg->pgno));
  50440. sqlite3PcacheMakeClean(pPg);
  50441. }
  50442. return pager_error(pPager, rc);
  50443. }
  50444. /*
  50445. ** Flush all unreferenced dirty pages to disk.
  50446. */
  50447. SQLITE_PRIVATE int sqlite3PagerFlush(Pager *pPager){
  50448. int rc = pPager->errCode;
  50449. if( !MEMDB ){
  50450. PgHdr *pList = sqlite3PcacheDirtyList(pPager->pPCache);
  50451. assert( assert_pager_state(pPager) );
  50452. while( rc==SQLITE_OK && pList ){
  50453. PgHdr *pNext = pList->pDirty;
  50454. if( pList->nRef==0 ){
  50455. rc = pagerStress((void*)pPager, pList);
  50456. }
  50457. pList = pNext;
  50458. }
  50459. }
  50460. return rc;
  50461. }
  50462. /*
  50463. ** Allocate and initialize a new Pager object and put a pointer to it
  50464. ** in *ppPager. The pager should eventually be freed by passing it
  50465. ** to sqlite3PagerClose().
  50466. **
  50467. ** The zFilename argument is the path to the database file to open.
  50468. ** If zFilename is NULL then a randomly-named temporary file is created
  50469. ** and used as the file to be cached. Temporary files are be deleted
  50470. ** automatically when they are closed. If zFilename is ":memory:" then
  50471. ** all information is held in cache. It is never written to disk.
  50472. ** This can be used to implement an in-memory database.
  50473. **
  50474. ** The nExtra parameter specifies the number of bytes of space allocated
  50475. ** along with each page reference. This space is available to the user
  50476. ** via the sqlite3PagerGetExtra() API. When a new page is allocated, the
  50477. ** first 8 bytes of this space are zeroed but the remainder is uninitialized.
  50478. ** (The extra space is used by btree as the MemPage object.)
  50479. **
  50480. ** The flags argument is used to specify properties that affect the
  50481. ** operation of the pager. It should be passed some bitwise combination
  50482. ** of the PAGER_* flags.
  50483. **
  50484. ** The vfsFlags parameter is a bitmask to pass to the flags parameter
  50485. ** of the xOpen() method of the supplied VFS when opening files.
  50486. **
  50487. ** If the pager object is allocated and the specified file opened
  50488. ** successfully, SQLITE_OK is returned and *ppPager set to point to
  50489. ** the new pager object. If an error occurs, *ppPager is set to NULL
  50490. ** and error code returned. This function may return SQLITE_NOMEM
  50491. ** (sqlite3Malloc() is used to allocate memory), SQLITE_CANTOPEN or
  50492. ** various SQLITE_IO_XXX errors.
  50493. */
  50494. SQLITE_PRIVATE int sqlite3PagerOpen(
  50495. sqlite3_vfs *pVfs, /* The virtual file system to use */
  50496. Pager **ppPager, /* OUT: Return the Pager structure here */
  50497. const char *zFilename, /* Name of the database file to open */
  50498. int nExtra, /* Extra bytes append to each in-memory page */
  50499. int flags, /* flags controlling this file */
  50500. int vfsFlags, /* flags passed through to sqlite3_vfs.xOpen() */
  50501. void (*xReinit)(DbPage*) /* Function to reinitialize pages */
  50502. ){
  50503. u8 *pPtr;
  50504. Pager *pPager = 0; /* Pager object to allocate and return */
  50505. int rc = SQLITE_OK; /* Return code */
  50506. int tempFile = 0; /* True for temp files (incl. in-memory files) */
  50507. int memDb = 0; /* True if this is an in-memory file */
  50508. #ifdef SQLITE_ENABLE_DESERIALIZE
  50509. int memJM = 0; /* Memory journal mode */
  50510. #else
  50511. # define memJM 0
  50512. #endif
  50513. int readOnly = 0; /* True if this is a read-only file */
  50514. int journalFileSize; /* Bytes to allocate for each journal fd */
  50515. char *zPathname = 0; /* Full path to database file */
  50516. int nPathname = 0; /* Number of bytes in zPathname */
  50517. int useJournal = (flags & PAGER_OMIT_JOURNAL)==0; /* False to omit journal */
  50518. int pcacheSize = sqlite3PcacheSize(); /* Bytes to allocate for PCache */
  50519. u32 szPageDflt = SQLITE_DEFAULT_PAGE_SIZE; /* Default page size */
  50520. const char *zUri = 0; /* URI args to copy */
  50521. int nUri = 0; /* Number of bytes of URI args at *zUri */
  50522. /* Figure out how much space is required for each journal file-handle
  50523. ** (there are two of them, the main journal and the sub-journal). */
  50524. journalFileSize = ROUND8(sqlite3JournalSize(pVfs));
  50525. /* Set the output variable to NULL in case an error occurs. */
  50526. *ppPager = 0;
  50527. #ifndef SQLITE_OMIT_MEMORYDB
  50528. if( flags & PAGER_MEMORY ){
  50529. memDb = 1;
  50530. if( zFilename && zFilename[0] ){
  50531. zPathname = sqlite3DbStrDup(0, zFilename);
  50532. if( zPathname==0 ) return SQLITE_NOMEM_BKPT;
  50533. nPathname = sqlite3Strlen30(zPathname);
  50534. zFilename = 0;
  50535. }
  50536. }
  50537. #endif
  50538. /* Compute and store the full pathname in an allocated buffer pointed
  50539. ** to by zPathname, length nPathname. Or, if this is a temporary file,
  50540. ** leave both nPathname and zPathname set to 0.
  50541. */
  50542. if( zFilename && zFilename[0] ){
  50543. const char *z;
  50544. nPathname = pVfs->mxPathname+1;
  50545. zPathname = sqlite3DbMallocRaw(0, nPathname*2);
  50546. if( zPathname==0 ){
  50547. return SQLITE_NOMEM_BKPT;
  50548. }
  50549. zPathname[0] = 0; /* Make sure initialized even if FullPathname() fails */
  50550. rc = sqlite3OsFullPathname(pVfs, zFilename, nPathname, zPathname);
  50551. nPathname = sqlite3Strlen30(zPathname);
  50552. z = zUri = &zFilename[sqlite3Strlen30(zFilename)+1];
  50553. while( *z ){
  50554. z += sqlite3Strlen30(z)+1;
  50555. z += sqlite3Strlen30(z)+1;
  50556. }
  50557. nUri = (int)(&z[1] - zUri);
  50558. assert( nUri>=0 );
  50559. if( rc==SQLITE_OK && nPathname+8>pVfs->mxPathname ){
  50560. /* This branch is taken when the journal path required by
  50561. ** the database being opened will be more than pVfs->mxPathname
  50562. ** bytes in length. This means the database cannot be opened,
  50563. ** as it will not be possible to open the journal file or even
  50564. ** check for a hot-journal before reading.
  50565. */
  50566. rc = SQLITE_CANTOPEN_BKPT;
  50567. }
  50568. if( rc!=SQLITE_OK ){
  50569. sqlite3DbFree(0, zPathname);
  50570. return rc;
  50571. }
  50572. }
  50573. /* Allocate memory for the Pager structure, PCache object, the
  50574. ** three file descriptors, the database file name and the journal
  50575. ** file name. The layout in memory is as follows:
  50576. **
  50577. ** Pager object (sizeof(Pager) bytes)
  50578. ** PCache object (sqlite3PcacheSize() bytes)
  50579. ** Database file handle (pVfs->szOsFile bytes)
  50580. ** Sub-journal file handle (journalFileSize bytes)
  50581. ** Main journal file handle (journalFileSize bytes)
  50582. ** Database file name (nPathname+1 bytes)
  50583. ** Journal file name (nPathname+8+1 bytes)
  50584. */
  50585. pPtr = (u8 *)sqlite3MallocZero(
  50586. ROUND8(sizeof(*pPager)) + /* Pager structure */
  50587. ROUND8(pcacheSize) + /* PCache object */
  50588. ROUND8(pVfs->szOsFile) + /* The main db file */
  50589. journalFileSize * 2 + /* The two journal files */
  50590. nPathname + 1 + nUri + /* zFilename */
  50591. nPathname + 8 + 2 /* zJournal */
  50592. #ifndef SQLITE_OMIT_WAL
  50593. + nPathname + 4 + 2 /* zWal */
  50594. #endif
  50595. );
  50596. assert( EIGHT_BYTE_ALIGNMENT(SQLITE_INT_TO_PTR(journalFileSize)) );
  50597. if( !pPtr ){
  50598. sqlite3DbFree(0, zPathname);
  50599. return SQLITE_NOMEM_BKPT;
  50600. }
  50601. pPager = (Pager*)(pPtr);
  50602. pPager->pPCache = (PCache*)(pPtr += ROUND8(sizeof(*pPager)));
  50603. pPager->fd = (sqlite3_file*)(pPtr += ROUND8(pcacheSize));
  50604. pPager->sjfd = (sqlite3_file*)(pPtr += ROUND8(pVfs->szOsFile));
  50605. pPager->jfd = (sqlite3_file*)(pPtr += journalFileSize);
  50606. pPager->zFilename = (char*)(pPtr += journalFileSize);
  50607. assert( EIGHT_BYTE_ALIGNMENT(pPager->jfd) );
  50608. /* Fill in the Pager.zFilename and Pager.zJournal buffers, if required. */
  50609. if( zPathname ){
  50610. assert( nPathname>0 );
  50611. pPager->zJournal = (char*)(pPtr += nPathname + 1 + nUri);
  50612. memcpy(pPager->zFilename, zPathname, nPathname);
  50613. if( nUri ) memcpy(&pPager->zFilename[nPathname+1], zUri, nUri);
  50614. memcpy(pPager->zJournal, zPathname, nPathname);
  50615. memcpy(&pPager->zJournal[nPathname], "-journal\000", 8+2);
  50616. sqlite3FileSuffix3(pPager->zFilename, pPager->zJournal);
  50617. #ifndef SQLITE_OMIT_WAL
  50618. pPager->zWal = &pPager->zJournal[nPathname+8+1];
  50619. memcpy(pPager->zWal, zPathname, nPathname);
  50620. memcpy(&pPager->zWal[nPathname], "-wal\000", 4+1);
  50621. sqlite3FileSuffix3(pPager->zFilename, pPager->zWal);
  50622. #endif
  50623. sqlite3DbFree(0, zPathname);
  50624. }
  50625. pPager->pVfs = pVfs;
  50626. pPager->vfsFlags = vfsFlags;
  50627. /* Open the pager file.
  50628. */
  50629. if( zFilename && zFilename[0] ){
  50630. int fout = 0; /* VFS flags returned by xOpen() */
  50631. rc = sqlite3OsOpen(pVfs, pPager->zFilename, pPager->fd, vfsFlags, &fout);
  50632. assert( !memDb );
  50633. #ifdef SQLITE_ENABLE_DESERIALIZE
  50634. memJM = (fout&SQLITE_OPEN_MEMORY)!=0;
  50635. #endif
  50636. readOnly = (fout&SQLITE_OPEN_READONLY)!=0;
  50637. /* If the file was successfully opened for read/write access,
  50638. ** choose a default page size in case we have to create the
  50639. ** database file. The default page size is the maximum of:
  50640. **
  50641. ** + SQLITE_DEFAULT_PAGE_SIZE,
  50642. ** + The value returned by sqlite3OsSectorSize()
  50643. ** + The largest page size that can be written atomically.
  50644. */
  50645. if( rc==SQLITE_OK ){
  50646. int iDc = sqlite3OsDeviceCharacteristics(pPager->fd);
  50647. if( !readOnly ){
  50648. setSectorSize(pPager);
  50649. assert(SQLITE_DEFAULT_PAGE_SIZE<=SQLITE_MAX_DEFAULT_PAGE_SIZE);
  50650. if( szPageDflt<pPager->sectorSize ){
  50651. if( pPager->sectorSize>SQLITE_MAX_DEFAULT_PAGE_SIZE ){
  50652. szPageDflt = SQLITE_MAX_DEFAULT_PAGE_SIZE;
  50653. }else{
  50654. szPageDflt = (u32)pPager->sectorSize;
  50655. }
  50656. }
  50657. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  50658. {
  50659. int ii;
  50660. assert(SQLITE_IOCAP_ATOMIC512==(512>>8));
  50661. assert(SQLITE_IOCAP_ATOMIC64K==(65536>>8));
  50662. assert(SQLITE_MAX_DEFAULT_PAGE_SIZE<=65536);
  50663. for(ii=szPageDflt; ii<=SQLITE_MAX_DEFAULT_PAGE_SIZE; ii=ii*2){
  50664. if( iDc&(SQLITE_IOCAP_ATOMIC|(ii>>8)) ){
  50665. szPageDflt = ii;
  50666. }
  50667. }
  50668. }
  50669. #endif
  50670. }
  50671. pPager->noLock = sqlite3_uri_boolean(zFilename, "nolock", 0);
  50672. if( (iDc & SQLITE_IOCAP_IMMUTABLE)!=0
  50673. || sqlite3_uri_boolean(zFilename, "immutable", 0) ){
  50674. vfsFlags |= SQLITE_OPEN_READONLY;
  50675. goto act_like_temp_file;
  50676. }
  50677. }
  50678. }else{
  50679. /* If a temporary file is requested, it is not opened immediately.
  50680. ** In this case we accept the default page size and delay actually
  50681. ** opening the file until the first call to OsWrite().
  50682. **
  50683. ** This branch is also run for an in-memory database. An in-memory
  50684. ** database is the same as a temp-file that is never written out to
  50685. ** disk and uses an in-memory rollback journal.
  50686. **
  50687. ** This branch also runs for files marked as immutable.
  50688. */
  50689. act_like_temp_file:
  50690. tempFile = 1;
  50691. pPager->eState = PAGER_READER; /* Pretend we already have a lock */
  50692. pPager->eLock = EXCLUSIVE_LOCK; /* Pretend we are in EXCLUSIVE mode */
  50693. pPager->noLock = 1; /* Do no locking */
  50694. readOnly = (vfsFlags&SQLITE_OPEN_READONLY);
  50695. }
  50696. /* The following call to PagerSetPagesize() serves to set the value of
  50697. ** Pager.pageSize and to allocate the Pager.pTmpSpace buffer.
  50698. */
  50699. if( rc==SQLITE_OK ){
  50700. assert( pPager->memDb==0 );
  50701. rc = sqlite3PagerSetPagesize(pPager, &szPageDflt, -1);
  50702. testcase( rc!=SQLITE_OK );
  50703. }
  50704. /* Initialize the PCache object. */
  50705. if( rc==SQLITE_OK ){
  50706. nExtra = ROUND8(nExtra);
  50707. assert( nExtra>=8 && nExtra<1000 );
  50708. rc = sqlite3PcacheOpen(szPageDflt, nExtra, !memDb,
  50709. !memDb?pagerStress:0, (void *)pPager, pPager->pPCache);
  50710. }
  50711. /* If an error occurred above, free the Pager structure and close the file.
  50712. */
  50713. if( rc!=SQLITE_OK ){
  50714. sqlite3OsClose(pPager->fd);
  50715. sqlite3PageFree(pPager->pTmpSpace);
  50716. sqlite3_free(pPager);
  50717. return rc;
  50718. }
  50719. PAGERTRACE(("OPEN %d %s\n", FILEHANDLEID(pPager->fd), pPager->zFilename));
  50720. IOTRACE(("OPEN %p %s\n", pPager, pPager->zFilename))
  50721. pPager->useJournal = (u8)useJournal;
  50722. /* pPager->stmtOpen = 0; */
  50723. /* pPager->stmtInUse = 0; */
  50724. /* pPager->nRef = 0; */
  50725. /* pPager->stmtSize = 0; */
  50726. /* pPager->stmtJSize = 0; */
  50727. /* pPager->nPage = 0; */
  50728. pPager->mxPgno = SQLITE_MAX_PAGE_COUNT;
  50729. /* pPager->state = PAGER_UNLOCK; */
  50730. /* pPager->errMask = 0; */
  50731. pPager->tempFile = (u8)tempFile;
  50732. assert( tempFile==PAGER_LOCKINGMODE_NORMAL
  50733. || tempFile==PAGER_LOCKINGMODE_EXCLUSIVE );
  50734. assert( PAGER_LOCKINGMODE_EXCLUSIVE==1 );
  50735. pPager->exclusiveMode = (u8)tempFile;
  50736. pPager->changeCountDone = pPager->tempFile;
  50737. pPager->memDb = (u8)memDb;
  50738. pPager->readOnly = (u8)readOnly;
  50739. assert( useJournal || pPager->tempFile );
  50740. pPager->noSync = pPager->tempFile;
  50741. if( pPager->noSync ){
  50742. assert( pPager->fullSync==0 );
  50743. assert( pPager->extraSync==0 );
  50744. assert( pPager->syncFlags==0 );
  50745. assert( pPager->walSyncFlags==0 );
  50746. }else{
  50747. pPager->fullSync = 1;
  50748. pPager->extraSync = 0;
  50749. pPager->syncFlags = SQLITE_SYNC_NORMAL;
  50750. pPager->walSyncFlags = SQLITE_SYNC_NORMAL | (SQLITE_SYNC_NORMAL<<2);
  50751. }
  50752. /* pPager->pFirst = 0; */
  50753. /* pPager->pFirstSynced = 0; */
  50754. /* pPager->pLast = 0; */
  50755. pPager->nExtra = (u16)nExtra;
  50756. pPager->journalSizeLimit = SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT;
  50757. assert( isOpen(pPager->fd) || tempFile );
  50758. setSectorSize(pPager);
  50759. if( !useJournal ){
  50760. pPager->journalMode = PAGER_JOURNALMODE_OFF;
  50761. }else if( memDb || memJM ){
  50762. pPager->journalMode = PAGER_JOURNALMODE_MEMORY;
  50763. }
  50764. /* pPager->xBusyHandler = 0; */
  50765. /* pPager->pBusyHandlerArg = 0; */
  50766. pPager->xReiniter = xReinit;
  50767. setGetterMethod(pPager);
  50768. /* memset(pPager->aHash, 0, sizeof(pPager->aHash)); */
  50769. /* pPager->szMmap = SQLITE_DEFAULT_MMAP_SIZE // will be set by btree.c */
  50770. *ppPager = pPager;
  50771. return SQLITE_OK;
  50772. }
  50773. /*
  50774. ** This function is called after transitioning from PAGER_UNLOCK to
  50775. ** PAGER_SHARED state. It tests if there is a hot journal present in
  50776. ** the file-system for the given pager. A hot journal is one that
  50777. ** needs to be played back. According to this function, a hot-journal
  50778. ** file exists if the following criteria are met:
  50779. **
  50780. ** * The journal file exists in the file system, and
  50781. ** * No process holds a RESERVED or greater lock on the database file, and
  50782. ** * The database file itself is greater than 0 bytes in size, and
  50783. ** * The first byte of the journal file exists and is not 0x00.
  50784. **
  50785. ** If the current size of the database file is 0 but a journal file
  50786. ** exists, that is probably an old journal left over from a prior
  50787. ** database with the same name. In this case the journal file is
  50788. ** just deleted using OsDelete, *pExists is set to 0 and SQLITE_OK
  50789. ** is returned.
  50790. **
  50791. ** This routine does not check if there is a master journal filename
  50792. ** at the end of the file. If there is, and that master journal file
  50793. ** does not exist, then the journal file is not really hot. In this
  50794. ** case this routine will return a false-positive. The pager_playback()
  50795. ** routine will discover that the journal file is not really hot and
  50796. ** will not roll it back.
  50797. **
  50798. ** If a hot-journal file is found to exist, *pExists is set to 1 and
  50799. ** SQLITE_OK returned. If no hot-journal file is present, *pExists is
  50800. ** set to 0 and SQLITE_OK returned. If an IO error occurs while trying
  50801. ** to determine whether or not a hot-journal file exists, the IO error
  50802. ** code is returned and the value of *pExists is undefined.
  50803. */
  50804. static int hasHotJournal(Pager *pPager, int *pExists){
  50805. sqlite3_vfs * const pVfs = pPager->pVfs;
  50806. int rc = SQLITE_OK; /* Return code */
  50807. int exists = 1; /* True if a journal file is present */
  50808. int jrnlOpen = !!isOpen(pPager->jfd);
  50809. assert( pPager->useJournal );
  50810. assert( isOpen(pPager->fd) );
  50811. assert( pPager->eState==PAGER_OPEN );
  50812. assert( jrnlOpen==0 || ( sqlite3OsDeviceCharacteristics(pPager->jfd) &
  50813. SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN
  50814. ));
  50815. *pExists = 0;
  50816. if( !jrnlOpen ){
  50817. rc = sqlite3OsAccess(pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &exists);
  50818. }
  50819. if( rc==SQLITE_OK && exists ){
  50820. int locked = 0; /* True if some process holds a RESERVED lock */
  50821. /* Race condition here: Another process might have been holding the
  50822. ** the RESERVED lock and have a journal open at the sqlite3OsAccess()
  50823. ** call above, but then delete the journal and drop the lock before
  50824. ** we get to the following sqlite3OsCheckReservedLock() call. If that
  50825. ** is the case, this routine might think there is a hot journal when
  50826. ** in fact there is none. This results in a false-positive which will
  50827. ** be dealt with by the playback routine. Ticket #3883.
  50828. */
  50829. rc = sqlite3OsCheckReservedLock(pPager->fd, &locked);
  50830. if( rc==SQLITE_OK && !locked ){
  50831. Pgno nPage; /* Number of pages in database file */
  50832. assert( pPager->tempFile==0 );
  50833. rc = pagerPagecount(pPager, &nPage);
  50834. if( rc==SQLITE_OK ){
  50835. /* If the database is zero pages in size, that means that either (1) the
  50836. ** journal is a remnant from a prior database with the same name where
  50837. ** the database file but not the journal was deleted, or (2) the initial
  50838. ** transaction that populates a new database is being rolled back.
  50839. ** In either case, the journal file can be deleted. However, take care
  50840. ** not to delete the journal file if it is already open due to
  50841. ** journal_mode=PERSIST.
  50842. */
  50843. if( nPage==0 && !jrnlOpen ){
  50844. sqlite3BeginBenignMalloc();
  50845. if( pagerLockDb(pPager, RESERVED_LOCK)==SQLITE_OK ){
  50846. sqlite3OsDelete(pVfs, pPager->zJournal, 0);
  50847. if( !pPager->exclusiveMode ) pagerUnlockDb(pPager, SHARED_LOCK);
  50848. }
  50849. sqlite3EndBenignMalloc();
  50850. }else{
  50851. /* The journal file exists and no other connection has a reserved
  50852. ** or greater lock on the database file. Now check that there is
  50853. ** at least one non-zero bytes at the start of the journal file.
  50854. ** If there is, then we consider this journal to be hot. If not,
  50855. ** it can be ignored.
  50856. */
  50857. if( !jrnlOpen ){
  50858. int f = SQLITE_OPEN_READONLY|SQLITE_OPEN_MAIN_JOURNAL;
  50859. rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &f);
  50860. }
  50861. if( rc==SQLITE_OK ){
  50862. u8 first = 0;
  50863. rc = sqlite3OsRead(pPager->jfd, (void *)&first, 1, 0);
  50864. if( rc==SQLITE_IOERR_SHORT_READ ){
  50865. rc = SQLITE_OK;
  50866. }
  50867. if( !jrnlOpen ){
  50868. sqlite3OsClose(pPager->jfd);
  50869. }
  50870. *pExists = (first!=0);
  50871. }else if( rc==SQLITE_CANTOPEN ){
  50872. /* If we cannot open the rollback journal file in order to see if
  50873. ** it has a zero header, that might be due to an I/O error, or
  50874. ** it might be due to the race condition described above and in
  50875. ** ticket #3883. Either way, assume that the journal is hot.
  50876. ** This might be a false positive. But if it is, then the
  50877. ** automatic journal playback and recovery mechanism will deal
  50878. ** with it under an EXCLUSIVE lock where we do not need to
  50879. ** worry so much with race conditions.
  50880. */
  50881. *pExists = 1;
  50882. rc = SQLITE_OK;
  50883. }
  50884. }
  50885. }
  50886. }
  50887. }
  50888. return rc;
  50889. }
  50890. /*
  50891. ** This function is called to obtain a shared lock on the database file.
  50892. ** It is illegal to call sqlite3PagerGet() until after this function
  50893. ** has been successfully called. If a shared-lock is already held when
  50894. ** this function is called, it is a no-op.
  50895. **
  50896. ** The following operations are also performed by this function.
  50897. **
  50898. ** 1) If the pager is currently in PAGER_OPEN state (no lock held
  50899. ** on the database file), then an attempt is made to obtain a
  50900. ** SHARED lock on the database file. Immediately after obtaining
  50901. ** the SHARED lock, the file-system is checked for a hot-journal,
  50902. ** which is played back if present. Following any hot-journal
  50903. ** rollback, the contents of the cache are validated by checking
  50904. ** the 'change-counter' field of the database file header and
  50905. ** discarded if they are found to be invalid.
  50906. **
  50907. ** 2) If the pager is running in exclusive-mode, and there are currently
  50908. ** no outstanding references to any pages, and is in the error state,
  50909. ** then an attempt is made to clear the error state by discarding
  50910. ** the contents of the page cache and rolling back any open journal
  50911. ** file.
  50912. **
  50913. ** If everything is successful, SQLITE_OK is returned. If an IO error
  50914. ** occurs while locking the database, checking for a hot-journal file or
  50915. ** rolling back a journal file, the IO error code is returned.
  50916. */
  50917. SQLITE_PRIVATE int sqlite3PagerSharedLock(Pager *pPager){
  50918. int rc = SQLITE_OK; /* Return code */
  50919. /* This routine is only called from b-tree and only when there are no
  50920. ** outstanding pages. This implies that the pager state should either
  50921. ** be OPEN or READER. READER is only possible if the pager is or was in
  50922. ** exclusive access mode. */
  50923. assert( sqlite3PcacheRefCount(pPager->pPCache)==0 );
  50924. assert( assert_pager_state(pPager) );
  50925. assert( pPager->eState==PAGER_OPEN || pPager->eState==PAGER_READER );
  50926. assert( pPager->errCode==SQLITE_OK );
  50927. if( !pagerUseWal(pPager) && pPager->eState==PAGER_OPEN ){
  50928. int bHotJournal = 1; /* True if there exists a hot journal-file */
  50929. assert( !MEMDB );
  50930. assert( pPager->tempFile==0 || pPager->eLock==EXCLUSIVE_LOCK );
  50931. rc = pager_wait_on_lock(pPager, SHARED_LOCK);
  50932. if( rc!=SQLITE_OK ){
  50933. assert( pPager->eLock==NO_LOCK || pPager->eLock==UNKNOWN_LOCK );
  50934. goto failed;
  50935. }
  50936. /* If a journal file exists, and there is no RESERVED lock on the
  50937. ** database file, then it either needs to be played back or deleted.
  50938. */
  50939. if( pPager->eLock<=SHARED_LOCK ){
  50940. rc = hasHotJournal(pPager, &bHotJournal);
  50941. }
  50942. if( rc!=SQLITE_OK ){
  50943. goto failed;
  50944. }
  50945. if( bHotJournal ){
  50946. if( pPager->readOnly ){
  50947. rc = SQLITE_READONLY_ROLLBACK;
  50948. goto failed;
  50949. }
  50950. /* Get an EXCLUSIVE lock on the database file. At this point it is
  50951. ** important that a RESERVED lock is not obtained on the way to the
  50952. ** EXCLUSIVE lock. If it were, another process might open the
  50953. ** database file, detect the RESERVED lock, and conclude that the
  50954. ** database is safe to read while this process is still rolling the
  50955. ** hot-journal back.
  50956. **
  50957. ** Because the intermediate RESERVED lock is not requested, any
  50958. ** other process attempting to access the database file will get to
  50959. ** this point in the code and fail to obtain its own EXCLUSIVE lock
  50960. ** on the database file.
  50961. **
  50962. ** Unless the pager is in locking_mode=exclusive mode, the lock is
  50963. ** downgraded to SHARED_LOCK before this function returns.
  50964. */
  50965. rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
  50966. if( rc!=SQLITE_OK ){
  50967. goto failed;
  50968. }
  50969. /* If it is not already open and the file exists on disk, open the
  50970. ** journal for read/write access. Write access is required because
  50971. ** in exclusive-access mode the file descriptor will be kept open
  50972. ** and possibly used for a transaction later on. Also, write-access
  50973. ** is usually required to finalize the journal in journal_mode=persist
  50974. ** mode (and also for journal_mode=truncate on some systems).
  50975. **
  50976. ** If the journal does not exist, it usually means that some
  50977. ** other connection managed to get in and roll it back before
  50978. ** this connection obtained the exclusive lock above. Or, it
  50979. ** may mean that the pager was in the error-state when this
  50980. ** function was called and the journal file does not exist.
  50981. */
  50982. if( !isOpen(pPager->jfd) ){
  50983. sqlite3_vfs * const pVfs = pPager->pVfs;
  50984. int bExists; /* True if journal file exists */
  50985. rc = sqlite3OsAccess(
  50986. pVfs, pPager->zJournal, SQLITE_ACCESS_EXISTS, &bExists);
  50987. if( rc==SQLITE_OK && bExists ){
  50988. int fout = 0;
  50989. int f = SQLITE_OPEN_READWRITE|SQLITE_OPEN_MAIN_JOURNAL;
  50990. assert( !pPager->tempFile );
  50991. rc = sqlite3OsOpen(pVfs, pPager->zJournal, pPager->jfd, f, &fout);
  50992. assert( rc!=SQLITE_OK || isOpen(pPager->jfd) );
  50993. if( rc==SQLITE_OK && fout&SQLITE_OPEN_READONLY ){
  50994. rc = SQLITE_CANTOPEN_BKPT;
  50995. sqlite3OsClose(pPager->jfd);
  50996. }
  50997. }
  50998. }
  50999. /* Playback and delete the journal. Drop the database write
  51000. ** lock and reacquire the read lock. Purge the cache before
  51001. ** playing back the hot-journal so that we don't end up with
  51002. ** an inconsistent cache. Sync the hot journal before playing
  51003. ** it back since the process that crashed and left the hot journal
  51004. ** probably did not sync it and we are required to always sync
  51005. ** the journal before playing it back.
  51006. */
  51007. if( isOpen(pPager->jfd) ){
  51008. assert( rc==SQLITE_OK );
  51009. rc = pagerSyncHotJournal(pPager);
  51010. if( rc==SQLITE_OK ){
  51011. rc = pager_playback(pPager, !pPager->tempFile);
  51012. pPager->eState = PAGER_OPEN;
  51013. }
  51014. }else if( !pPager->exclusiveMode ){
  51015. pagerUnlockDb(pPager, SHARED_LOCK);
  51016. }
  51017. if( rc!=SQLITE_OK ){
  51018. /* This branch is taken if an error occurs while trying to open
  51019. ** or roll back a hot-journal while holding an EXCLUSIVE lock. The
  51020. ** pager_unlock() routine will be called before returning to unlock
  51021. ** the file. If the unlock attempt fails, then Pager.eLock must be
  51022. ** set to UNKNOWN_LOCK (see the comment above the #define for
  51023. ** UNKNOWN_LOCK above for an explanation).
  51024. **
  51025. ** In order to get pager_unlock() to do this, set Pager.eState to
  51026. ** PAGER_ERROR now. This is not actually counted as a transition
  51027. ** to ERROR state in the state diagram at the top of this file,
  51028. ** since we know that the same call to pager_unlock() will very
  51029. ** shortly transition the pager object to the OPEN state. Calling
  51030. ** assert_pager_state() would fail now, as it should not be possible
  51031. ** to be in ERROR state when there are zero outstanding page
  51032. ** references.
  51033. */
  51034. pager_error(pPager, rc);
  51035. goto failed;
  51036. }
  51037. assert( pPager->eState==PAGER_OPEN );
  51038. assert( (pPager->eLock==SHARED_LOCK)
  51039. || (pPager->exclusiveMode && pPager->eLock>SHARED_LOCK)
  51040. );
  51041. }
  51042. if( !pPager->tempFile && pPager->hasHeldSharedLock ){
  51043. /* The shared-lock has just been acquired then check to
  51044. ** see if the database has been modified. If the database has changed,
  51045. ** flush the cache. The hasHeldSharedLock flag prevents this from
  51046. ** occurring on the very first access to a file, in order to save a
  51047. ** single unnecessary sqlite3OsRead() call at the start-up.
  51048. **
  51049. ** Database changes are detected by looking at 15 bytes beginning
  51050. ** at offset 24 into the file. The first 4 of these 16 bytes are
  51051. ** a 32-bit counter that is incremented with each change. The
  51052. ** other bytes change randomly with each file change when
  51053. ** a codec is in use.
  51054. **
  51055. ** There is a vanishingly small chance that a change will not be
  51056. ** detected. The chance of an undetected change is so small that
  51057. ** it can be neglected.
  51058. */
  51059. char dbFileVers[sizeof(pPager->dbFileVers)];
  51060. IOTRACE(("CKVERS %p %d\n", pPager, sizeof(dbFileVers)));
  51061. rc = sqlite3OsRead(pPager->fd, &dbFileVers, sizeof(dbFileVers), 24);
  51062. if( rc!=SQLITE_OK ){
  51063. if( rc!=SQLITE_IOERR_SHORT_READ ){
  51064. goto failed;
  51065. }
  51066. memset(dbFileVers, 0, sizeof(dbFileVers));
  51067. }
  51068. if( memcmp(pPager->dbFileVers, dbFileVers, sizeof(dbFileVers))!=0 ){
  51069. pager_reset(pPager);
  51070. /* Unmap the database file. It is possible that external processes
  51071. ** may have truncated the database file and then extended it back
  51072. ** to its original size while this process was not holding a lock.
  51073. ** In this case there may exist a Pager.pMap mapping that appears
  51074. ** to be the right size but is not actually valid. Avoid this
  51075. ** possibility by unmapping the db here. */
  51076. if( USEFETCH(pPager) ){
  51077. sqlite3OsUnfetch(pPager->fd, 0, 0);
  51078. }
  51079. }
  51080. }
  51081. /* If there is a WAL file in the file-system, open this database in WAL
  51082. ** mode. Otherwise, the following function call is a no-op.
  51083. */
  51084. rc = pagerOpenWalIfPresent(pPager);
  51085. #ifndef SQLITE_OMIT_WAL
  51086. assert( pPager->pWal==0 || rc==SQLITE_OK );
  51087. #endif
  51088. }
  51089. if( pagerUseWal(pPager) ){
  51090. assert( rc==SQLITE_OK );
  51091. rc = pagerBeginReadTransaction(pPager);
  51092. }
  51093. if( pPager->tempFile==0 && pPager->eState==PAGER_OPEN && rc==SQLITE_OK ){
  51094. rc = pagerPagecount(pPager, &pPager->dbSize);
  51095. }
  51096. failed:
  51097. if( rc!=SQLITE_OK ){
  51098. assert( !MEMDB );
  51099. pager_unlock(pPager);
  51100. assert( pPager->eState==PAGER_OPEN );
  51101. }else{
  51102. pPager->eState = PAGER_READER;
  51103. pPager->hasHeldSharedLock = 1;
  51104. }
  51105. return rc;
  51106. }
  51107. /*
  51108. ** If the reference count has reached zero, rollback any active
  51109. ** transaction and unlock the pager.
  51110. **
  51111. ** Except, in locking_mode=EXCLUSIVE when there is nothing to in
  51112. ** the rollback journal, the unlock is not performed and there is
  51113. ** nothing to rollback, so this routine is a no-op.
  51114. */
  51115. static void pagerUnlockIfUnused(Pager *pPager){
  51116. if( sqlite3PcacheRefCount(pPager->pPCache)==0 ){
  51117. assert( pPager->nMmapOut==0 ); /* because page1 is never memory mapped */
  51118. pagerUnlockAndRollback(pPager);
  51119. }
  51120. }
  51121. /*
  51122. ** The page getter methods each try to acquire a reference to a
  51123. ** page with page number pgno. If the requested reference is
  51124. ** successfully obtained, it is copied to *ppPage and SQLITE_OK returned.
  51125. **
  51126. ** There are different implementations of the getter method depending
  51127. ** on the current state of the pager.
  51128. **
  51129. ** getPageNormal() -- The normal getter
  51130. ** getPageError() -- Used if the pager is in an error state
  51131. ** getPageMmap() -- Used if memory-mapped I/O is enabled
  51132. **
  51133. ** If the requested page is already in the cache, it is returned.
  51134. ** Otherwise, a new page object is allocated and populated with data
  51135. ** read from the database file. In some cases, the pcache module may
  51136. ** choose not to allocate a new page object and may reuse an existing
  51137. ** object with no outstanding references.
  51138. **
  51139. ** The extra data appended to a page is always initialized to zeros the
  51140. ** first time a page is loaded into memory. If the page requested is
  51141. ** already in the cache when this function is called, then the extra
  51142. ** data is left as it was when the page object was last used.
  51143. **
  51144. ** If the database image is smaller than the requested page or if
  51145. ** the flags parameter contains the PAGER_GET_NOCONTENT bit and the
  51146. ** requested page is not already stored in the cache, then no
  51147. ** actual disk read occurs. In this case the memory image of the
  51148. ** page is initialized to all zeros.
  51149. **
  51150. ** If PAGER_GET_NOCONTENT is true, it means that we do not care about
  51151. ** the contents of the page. This occurs in two scenarios:
  51152. **
  51153. ** a) When reading a free-list leaf page from the database, and
  51154. **
  51155. ** b) When a savepoint is being rolled back and we need to load
  51156. ** a new page into the cache to be filled with the data read
  51157. ** from the savepoint journal.
  51158. **
  51159. ** If PAGER_GET_NOCONTENT is true, then the data returned is zeroed instead
  51160. ** of being read from the database. Additionally, the bits corresponding
  51161. ** to pgno in Pager.pInJournal (bitvec of pages already written to the
  51162. ** journal file) and the PagerSavepoint.pInSavepoint bitvecs of any open
  51163. ** savepoints are set. This means if the page is made writable at any
  51164. ** point in the future, using a call to sqlite3PagerWrite(), its contents
  51165. ** will not be journaled. This saves IO.
  51166. **
  51167. ** The acquisition might fail for several reasons. In all cases,
  51168. ** an appropriate error code is returned and *ppPage is set to NULL.
  51169. **
  51170. ** See also sqlite3PagerLookup(). Both this routine and Lookup() attempt
  51171. ** to find a page in the in-memory cache first. If the page is not already
  51172. ** in memory, this routine goes to disk to read it in whereas Lookup()
  51173. ** just returns 0. This routine acquires a read-lock the first time it
  51174. ** has to go to disk, and could also playback an old journal if necessary.
  51175. ** Since Lookup() never goes to disk, it never has to deal with locks
  51176. ** or journal files.
  51177. */
  51178. static int getPageNormal(
  51179. Pager *pPager, /* The pager open on the database file */
  51180. Pgno pgno, /* Page number to fetch */
  51181. DbPage **ppPage, /* Write a pointer to the page here */
  51182. int flags /* PAGER_GET_XXX flags */
  51183. ){
  51184. int rc = SQLITE_OK;
  51185. PgHdr *pPg;
  51186. u8 noContent; /* True if PAGER_GET_NOCONTENT is set */
  51187. sqlite3_pcache_page *pBase;
  51188. assert( pPager->errCode==SQLITE_OK );
  51189. assert( pPager->eState>=PAGER_READER );
  51190. assert( assert_pager_state(pPager) );
  51191. assert( pPager->hasHeldSharedLock==1 );
  51192. if( pgno==0 ) return SQLITE_CORRUPT_BKPT;
  51193. pBase = sqlite3PcacheFetch(pPager->pPCache, pgno, 3);
  51194. if( pBase==0 ){
  51195. pPg = 0;
  51196. rc = sqlite3PcacheFetchStress(pPager->pPCache, pgno, &pBase);
  51197. if( rc!=SQLITE_OK ) goto pager_acquire_err;
  51198. if( pBase==0 ){
  51199. rc = SQLITE_NOMEM_BKPT;
  51200. goto pager_acquire_err;
  51201. }
  51202. }
  51203. pPg = *ppPage = sqlite3PcacheFetchFinish(pPager->pPCache, pgno, pBase);
  51204. assert( pPg==(*ppPage) );
  51205. assert( pPg->pgno==pgno );
  51206. assert( pPg->pPager==pPager || pPg->pPager==0 );
  51207. noContent = (flags & PAGER_GET_NOCONTENT)!=0;
  51208. if( pPg->pPager && !noContent ){
  51209. /* In this case the pcache already contains an initialized copy of
  51210. ** the page. Return without further ado. */
  51211. assert( pgno<=PAGER_MAX_PGNO && pgno!=PAGER_MJ_PGNO(pPager) );
  51212. pPager->aStat[PAGER_STAT_HIT]++;
  51213. return SQLITE_OK;
  51214. }else{
  51215. /* The pager cache has created a new page. Its content needs to
  51216. ** be initialized. But first some error checks:
  51217. **
  51218. ** (1) The maximum page number is 2^31
  51219. ** (2) Never try to fetch the locking page
  51220. */
  51221. if( pgno>PAGER_MAX_PGNO || pgno==PAGER_MJ_PGNO(pPager) ){
  51222. rc = SQLITE_CORRUPT_BKPT;
  51223. goto pager_acquire_err;
  51224. }
  51225. pPg->pPager = pPager;
  51226. assert( !isOpen(pPager->fd) || !MEMDB );
  51227. if( !isOpen(pPager->fd) || pPager->dbSize<pgno || noContent ){
  51228. if( pgno>pPager->mxPgno ){
  51229. rc = SQLITE_FULL;
  51230. goto pager_acquire_err;
  51231. }
  51232. if( noContent ){
  51233. /* Failure to set the bits in the InJournal bit-vectors is benign.
  51234. ** It merely means that we might do some extra work to journal a
  51235. ** page that does not need to be journaled. Nevertheless, be sure
  51236. ** to test the case where a malloc error occurs while trying to set
  51237. ** a bit in a bit vector.
  51238. */
  51239. sqlite3BeginBenignMalloc();
  51240. if( pgno<=pPager->dbOrigSize ){
  51241. TESTONLY( rc = ) sqlite3BitvecSet(pPager->pInJournal, pgno);
  51242. testcase( rc==SQLITE_NOMEM );
  51243. }
  51244. TESTONLY( rc = ) addToSavepointBitvecs(pPager, pgno);
  51245. testcase( rc==SQLITE_NOMEM );
  51246. sqlite3EndBenignMalloc();
  51247. }
  51248. memset(pPg->pData, 0, pPager->pageSize);
  51249. IOTRACE(("ZERO %p %d\n", pPager, pgno));
  51250. }else{
  51251. assert( pPg->pPager==pPager );
  51252. pPager->aStat[PAGER_STAT_MISS]++;
  51253. rc = readDbPage(pPg);
  51254. if( rc!=SQLITE_OK ){
  51255. goto pager_acquire_err;
  51256. }
  51257. }
  51258. pager_set_pagehash(pPg);
  51259. }
  51260. return SQLITE_OK;
  51261. pager_acquire_err:
  51262. assert( rc!=SQLITE_OK );
  51263. if( pPg ){
  51264. sqlite3PcacheDrop(pPg);
  51265. }
  51266. pagerUnlockIfUnused(pPager);
  51267. *ppPage = 0;
  51268. return rc;
  51269. }
  51270. #if SQLITE_MAX_MMAP_SIZE>0
  51271. /* The page getter for when memory-mapped I/O is enabled */
  51272. static int getPageMMap(
  51273. Pager *pPager, /* The pager open on the database file */
  51274. Pgno pgno, /* Page number to fetch */
  51275. DbPage **ppPage, /* Write a pointer to the page here */
  51276. int flags /* PAGER_GET_XXX flags */
  51277. ){
  51278. int rc = SQLITE_OK;
  51279. PgHdr *pPg = 0;
  51280. u32 iFrame = 0; /* Frame to read from WAL file */
  51281. /* It is acceptable to use a read-only (mmap) page for any page except
  51282. ** page 1 if there is no write-transaction open or the ACQUIRE_READONLY
  51283. ** flag was specified by the caller. And so long as the db is not a
  51284. ** temporary or in-memory database. */
  51285. const int bMmapOk = (pgno>1
  51286. && (pPager->eState==PAGER_READER || (flags & PAGER_GET_READONLY))
  51287. );
  51288. assert( USEFETCH(pPager) );
  51289. #ifdef SQLITE_HAS_CODEC
  51290. assert( pPager->xCodec==0 );
  51291. #endif
  51292. /* Optimization note: Adding the "pgno<=1" term before "pgno==0" here
  51293. ** allows the compiler optimizer to reuse the results of the "pgno>1"
  51294. ** test in the previous statement, and avoid testing pgno==0 in the
  51295. ** common case where pgno is large. */
  51296. if( pgno<=1 && pgno==0 ){
  51297. return SQLITE_CORRUPT_BKPT;
  51298. }
  51299. assert( pPager->eState>=PAGER_READER );
  51300. assert( assert_pager_state(pPager) );
  51301. assert( pPager->hasHeldSharedLock==1 );
  51302. assert( pPager->errCode==SQLITE_OK );
  51303. if( bMmapOk && pagerUseWal(pPager) ){
  51304. rc = sqlite3WalFindFrame(pPager->pWal, pgno, &iFrame);
  51305. if( rc!=SQLITE_OK ){
  51306. *ppPage = 0;
  51307. return rc;
  51308. }
  51309. }
  51310. if( bMmapOk && iFrame==0 ){
  51311. void *pData = 0;
  51312. rc = sqlite3OsFetch(pPager->fd,
  51313. (i64)(pgno-1) * pPager->pageSize, pPager->pageSize, &pData
  51314. );
  51315. if( rc==SQLITE_OK && pData ){
  51316. if( pPager->eState>PAGER_READER || pPager->tempFile ){
  51317. pPg = sqlite3PagerLookup(pPager, pgno);
  51318. }
  51319. if( pPg==0 ){
  51320. rc = pagerAcquireMapPage(pPager, pgno, pData, &pPg);
  51321. }else{
  51322. sqlite3OsUnfetch(pPager->fd, (i64)(pgno-1)*pPager->pageSize, pData);
  51323. }
  51324. if( pPg ){
  51325. assert( rc==SQLITE_OK );
  51326. *ppPage = pPg;
  51327. return SQLITE_OK;
  51328. }
  51329. }
  51330. if( rc!=SQLITE_OK ){
  51331. *ppPage = 0;
  51332. return rc;
  51333. }
  51334. }
  51335. return getPageNormal(pPager, pgno, ppPage, flags);
  51336. }
  51337. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  51338. /* The page getter method for when the pager is an error state */
  51339. static int getPageError(
  51340. Pager *pPager, /* The pager open on the database file */
  51341. Pgno pgno, /* Page number to fetch */
  51342. DbPage **ppPage, /* Write a pointer to the page here */
  51343. int flags /* PAGER_GET_XXX flags */
  51344. ){
  51345. UNUSED_PARAMETER(pgno);
  51346. UNUSED_PARAMETER(flags);
  51347. assert( pPager->errCode!=SQLITE_OK );
  51348. *ppPage = 0;
  51349. return pPager->errCode;
  51350. }
  51351. /* Dispatch all page fetch requests to the appropriate getter method.
  51352. */
  51353. SQLITE_PRIVATE int sqlite3PagerGet(
  51354. Pager *pPager, /* The pager open on the database file */
  51355. Pgno pgno, /* Page number to fetch */
  51356. DbPage **ppPage, /* Write a pointer to the page here */
  51357. int flags /* PAGER_GET_XXX flags */
  51358. ){
  51359. return pPager->xGet(pPager, pgno, ppPage, flags);
  51360. }
  51361. /*
  51362. ** Acquire a page if it is already in the in-memory cache. Do
  51363. ** not read the page from disk. Return a pointer to the page,
  51364. ** or 0 if the page is not in cache.
  51365. **
  51366. ** See also sqlite3PagerGet(). The difference between this routine
  51367. ** and sqlite3PagerGet() is that _get() will go to the disk and read
  51368. ** in the page if the page is not already in cache. This routine
  51369. ** returns NULL if the page is not in cache or if a disk I/O error
  51370. ** has ever happened.
  51371. */
  51372. SQLITE_PRIVATE DbPage *sqlite3PagerLookup(Pager *pPager, Pgno pgno){
  51373. sqlite3_pcache_page *pPage;
  51374. assert( pPager!=0 );
  51375. assert( pgno!=0 );
  51376. assert( pPager->pPCache!=0 );
  51377. pPage = sqlite3PcacheFetch(pPager->pPCache, pgno, 0);
  51378. assert( pPage==0 || pPager->hasHeldSharedLock );
  51379. if( pPage==0 ) return 0;
  51380. return sqlite3PcacheFetchFinish(pPager->pPCache, pgno, pPage);
  51381. }
  51382. /*
  51383. ** Release a page reference.
  51384. **
  51385. ** The sqlite3PagerUnref() and sqlite3PagerUnrefNotNull() may only be
  51386. ** used if we know that the page being released is not the last page.
  51387. ** The btree layer always holds page1 open until the end, so these first
  51388. ** to routines can be used to release any page other than BtShared.pPage1.
  51389. **
  51390. ** Use sqlite3PagerUnrefPageOne() to release page1. This latter routine
  51391. ** checks the total number of outstanding pages and if the number of
  51392. ** pages reaches zero it drops the database lock.
  51393. */
  51394. SQLITE_PRIVATE void sqlite3PagerUnrefNotNull(DbPage *pPg){
  51395. TESTONLY( Pager *pPager = pPg->pPager; )
  51396. assert( pPg!=0 );
  51397. if( pPg->flags & PGHDR_MMAP ){
  51398. assert( pPg->pgno!=1 ); /* Page1 is never memory mapped */
  51399. pagerReleaseMapPage(pPg);
  51400. }else{
  51401. sqlite3PcacheRelease(pPg);
  51402. }
  51403. /* Do not use this routine to release the last reference to page1 */
  51404. assert( sqlite3PcacheRefCount(pPager->pPCache)>0 );
  51405. }
  51406. SQLITE_PRIVATE void sqlite3PagerUnref(DbPage *pPg){
  51407. if( pPg ) sqlite3PagerUnrefNotNull(pPg);
  51408. }
  51409. SQLITE_PRIVATE void sqlite3PagerUnrefPageOne(DbPage *pPg){
  51410. Pager *pPager;
  51411. assert( pPg!=0 );
  51412. assert( pPg->pgno==1 );
  51413. assert( (pPg->flags & PGHDR_MMAP)==0 ); /* Page1 is never memory mapped */
  51414. pPager = pPg->pPager;
  51415. sqlite3PagerResetLockTimeout(pPager);
  51416. sqlite3PcacheRelease(pPg);
  51417. pagerUnlockIfUnused(pPager);
  51418. }
  51419. /*
  51420. ** This function is called at the start of every write transaction.
  51421. ** There must already be a RESERVED or EXCLUSIVE lock on the database
  51422. ** file when this routine is called.
  51423. **
  51424. ** Open the journal file for pager pPager and write a journal header
  51425. ** to the start of it. If there are active savepoints, open the sub-journal
  51426. ** as well. This function is only used when the journal file is being
  51427. ** opened to write a rollback log for a transaction. It is not used
  51428. ** when opening a hot journal file to roll it back.
  51429. **
  51430. ** If the journal file is already open (as it may be in exclusive mode),
  51431. ** then this function just writes a journal header to the start of the
  51432. ** already open file.
  51433. **
  51434. ** Whether or not the journal file is opened by this function, the
  51435. ** Pager.pInJournal bitvec structure is allocated.
  51436. **
  51437. ** Return SQLITE_OK if everything is successful. Otherwise, return
  51438. ** SQLITE_NOMEM if the attempt to allocate Pager.pInJournal fails, or
  51439. ** an IO error code if opening or writing the journal file fails.
  51440. */
  51441. static int pager_open_journal(Pager *pPager){
  51442. int rc = SQLITE_OK; /* Return code */
  51443. sqlite3_vfs * const pVfs = pPager->pVfs; /* Local cache of vfs pointer */
  51444. assert( pPager->eState==PAGER_WRITER_LOCKED );
  51445. assert( assert_pager_state(pPager) );
  51446. assert( pPager->pInJournal==0 );
  51447. /* If already in the error state, this function is a no-op. But on
  51448. ** the other hand, this routine is never called if we are already in
  51449. ** an error state. */
  51450. if( NEVER(pPager->errCode) ) return pPager->errCode;
  51451. if( !pagerUseWal(pPager) && pPager->journalMode!=PAGER_JOURNALMODE_OFF ){
  51452. pPager->pInJournal = sqlite3BitvecCreate(pPager->dbSize);
  51453. if( pPager->pInJournal==0 ){
  51454. return SQLITE_NOMEM_BKPT;
  51455. }
  51456. /* Open the journal file if it is not already open. */
  51457. if( !isOpen(pPager->jfd) ){
  51458. if( pPager->journalMode==PAGER_JOURNALMODE_MEMORY ){
  51459. sqlite3MemJournalOpen(pPager->jfd);
  51460. }else{
  51461. int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE;
  51462. int nSpill;
  51463. if( pPager->tempFile ){
  51464. flags |= (SQLITE_OPEN_DELETEONCLOSE|SQLITE_OPEN_TEMP_JOURNAL);
  51465. nSpill = sqlite3Config.nStmtSpill;
  51466. }else{
  51467. flags |= SQLITE_OPEN_MAIN_JOURNAL;
  51468. nSpill = jrnlBufferSize(pPager);
  51469. }
  51470. /* Verify that the database still has the same name as it did when
  51471. ** it was originally opened. */
  51472. rc = databaseIsUnmoved(pPager);
  51473. if( rc==SQLITE_OK ){
  51474. rc = sqlite3JournalOpen (
  51475. pVfs, pPager->zJournal, pPager->jfd, flags, nSpill
  51476. );
  51477. }
  51478. }
  51479. assert( rc!=SQLITE_OK || isOpen(pPager->jfd) );
  51480. }
  51481. /* Write the first journal header to the journal file and open
  51482. ** the sub-journal if necessary.
  51483. */
  51484. if( rc==SQLITE_OK ){
  51485. /* TODO: Check if all of these are really required. */
  51486. pPager->nRec = 0;
  51487. pPager->journalOff = 0;
  51488. pPager->setMaster = 0;
  51489. pPager->journalHdr = 0;
  51490. rc = writeJournalHdr(pPager);
  51491. }
  51492. }
  51493. if( rc!=SQLITE_OK ){
  51494. sqlite3BitvecDestroy(pPager->pInJournal);
  51495. pPager->pInJournal = 0;
  51496. }else{
  51497. assert( pPager->eState==PAGER_WRITER_LOCKED );
  51498. pPager->eState = PAGER_WRITER_CACHEMOD;
  51499. }
  51500. return rc;
  51501. }
  51502. /*
  51503. ** Begin a write-transaction on the specified pager object. If a
  51504. ** write-transaction has already been opened, this function is a no-op.
  51505. **
  51506. ** If the exFlag argument is false, then acquire at least a RESERVED
  51507. ** lock on the database file. If exFlag is true, then acquire at least
  51508. ** an EXCLUSIVE lock. If such a lock is already held, no locking
  51509. ** functions need be called.
  51510. **
  51511. ** If the subjInMemory argument is non-zero, then any sub-journal opened
  51512. ** within this transaction will be opened as an in-memory file. This
  51513. ** has no effect if the sub-journal is already opened (as it may be when
  51514. ** running in exclusive mode) or if the transaction does not require a
  51515. ** sub-journal. If the subjInMemory argument is zero, then any required
  51516. ** sub-journal is implemented in-memory if pPager is an in-memory database,
  51517. ** or using a temporary file otherwise.
  51518. */
  51519. SQLITE_PRIVATE int sqlite3PagerBegin(Pager *pPager, int exFlag, int subjInMemory){
  51520. int rc = SQLITE_OK;
  51521. if( pPager->errCode ) return pPager->errCode;
  51522. assert( pPager->eState>=PAGER_READER && pPager->eState<PAGER_ERROR );
  51523. pPager->subjInMemory = (u8)subjInMemory;
  51524. if( ALWAYS(pPager->eState==PAGER_READER) ){
  51525. assert( pPager->pInJournal==0 );
  51526. if( pagerUseWal(pPager) ){
  51527. /* If the pager is configured to use locking_mode=exclusive, and an
  51528. ** exclusive lock on the database is not already held, obtain it now.
  51529. */
  51530. if( pPager->exclusiveMode && sqlite3WalExclusiveMode(pPager->pWal, -1) ){
  51531. rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
  51532. if( rc!=SQLITE_OK ){
  51533. return rc;
  51534. }
  51535. (void)sqlite3WalExclusiveMode(pPager->pWal, 1);
  51536. }
  51537. /* Grab the write lock on the log file. If successful, upgrade to
  51538. ** PAGER_RESERVED state. Otherwise, return an error code to the caller.
  51539. ** The busy-handler is not invoked if another connection already
  51540. ** holds the write-lock. If possible, the upper layer will call it.
  51541. */
  51542. rc = sqlite3WalBeginWriteTransaction(pPager->pWal);
  51543. }else{
  51544. /* Obtain a RESERVED lock on the database file. If the exFlag parameter
  51545. ** is true, then immediately upgrade this to an EXCLUSIVE lock. The
  51546. ** busy-handler callback can be used when upgrading to the EXCLUSIVE
  51547. ** lock, but not when obtaining the RESERVED lock.
  51548. */
  51549. rc = pagerLockDb(pPager, RESERVED_LOCK);
  51550. if( rc==SQLITE_OK && exFlag ){
  51551. rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
  51552. }
  51553. }
  51554. if( rc==SQLITE_OK ){
  51555. /* Change to WRITER_LOCKED state.
  51556. **
  51557. ** WAL mode sets Pager.eState to PAGER_WRITER_LOCKED or CACHEMOD
  51558. ** when it has an open transaction, but never to DBMOD or FINISHED.
  51559. ** This is because in those states the code to roll back savepoint
  51560. ** transactions may copy data from the sub-journal into the database
  51561. ** file as well as into the page cache. Which would be incorrect in
  51562. ** WAL mode.
  51563. */
  51564. pPager->eState = PAGER_WRITER_LOCKED;
  51565. pPager->dbHintSize = pPager->dbSize;
  51566. pPager->dbFileSize = pPager->dbSize;
  51567. pPager->dbOrigSize = pPager->dbSize;
  51568. pPager->journalOff = 0;
  51569. }
  51570. assert( rc==SQLITE_OK || pPager->eState==PAGER_READER );
  51571. assert( rc!=SQLITE_OK || pPager->eState==PAGER_WRITER_LOCKED );
  51572. assert( assert_pager_state(pPager) );
  51573. }
  51574. PAGERTRACE(("TRANSACTION %d\n", PAGERID(pPager)));
  51575. return rc;
  51576. }
  51577. /*
  51578. ** Write page pPg onto the end of the rollback journal.
  51579. */
  51580. static SQLITE_NOINLINE int pagerAddPageToRollbackJournal(PgHdr *pPg){
  51581. Pager *pPager = pPg->pPager;
  51582. int rc;
  51583. u32 cksum;
  51584. char *pData2;
  51585. i64 iOff = pPager->journalOff;
  51586. /* We should never write to the journal file the page that
  51587. ** contains the database locks. The following assert verifies
  51588. ** that we do not. */
  51589. assert( pPg->pgno!=PAGER_MJ_PGNO(pPager) );
  51590. assert( pPager->journalHdr<=pPager->journalOff );
  51591. CODEC2(pPager, pPg->pData, pPg->pgno, 7, return SQLITE_NOMEM_BKPT, pData2);
  51592. cksum = pager_cksum(pPager, (u8*)pData2);
  51593. /* Even if an IO or diskfull error occurs while journalling the
  51594. ** page in the block above, set the need-sync flag for the page.
  51595. ** Otherwise, when the transaction is rolled back, the logic in
  51596. ** playback_one_page() will think that the page needs to be restored
  51597. ** in the database file. And if an IO error occurs while doing so,
  51598. ** then corruption may follow.
  51599. */
  51600. pPg->flags |= PGHDR_NEED_SYNC;
  51601. rc = write32bits(pPager->jfd, iOff, pPg->pgno);
  51602. if( rc!=SQLITE_OK ) return rc;
  51603. rc = sqlite3OsWrite(pPager->jfd, pData2, pPager->pageSize, iOff+4);
  51604. if( rc!=SQLITE_OK ) return rc;
  51605. rc = write32bits(pPager->jfd, iOff+pPager->pageSize+4, cksum);
  51606. if( rc!=SQLITE_OK ) return rc;
  51607. IOTRACE(("JOUT %p %d %lld %d\n", pPager, pPg->pgno,
  51608. pPager->journalOff, pPager->pageSize));
  51609. PAGER_INCR(sqlite3_pager_writej_count);
  51610. PAGERTRACE(("JOURNAL %d page %d needSync=%d hash(%08x)\n",
  51611. PAGERID(pPager), pPg->pgno,
  51612. ((pPg->flags&PGHDR_NEED_SYNC)?1:0), pager_pagehash(pPg)));
  51613. pPager->journalOff += 8 + pPager->pageSize;
  51614. pPager->nRec++;
  51615. assert( pPager->pInJournal!=0 );
  51616. rc = sqlite3BitvecSet(pPager->pInJournal, pPg->pgno);
  51617. testcase( rc==SQLITE_NOMEM );
  51618. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  51619. rc |= addToSavepointBitvecs(pPager, pPg->pgno);
  51620. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  51621. return rc;
  51622. }
  51623. /*
  51624. ** Mark a single data page as writeable. The page is written into the
  51625. ** main journal or sub-journal as required. If the page is written into
  51626. ** one of the journals, the corresponding bit is set in the
  51627. ** Pager.pInJournal bitvec and the PagerSavepoint.pInSavepoint bitvecs
  51628. ** of any open savepoints as appropriate.
  51629. */
  51630. static int pager_write(PgHdr *pPg){
  51631. Pager *pPager = pPg->pPager;
  51632. int rc = SQLITE_OK;
  51633. /* This routine is not called unless a write-transaction has already
  51634. ** been started. The journal file may or may not be open at this point.
  51635. ** It is never called in the ERROR state.
  51636. */
  51637. assert( pPager->eState==PAGER_WRITER_LOCKED
  51638. || pPager->eState==PAGER_WRITER_CACHEMOD
  51639. || pPager->eState==PAGER_WRITER_DBMOD
  51640. );
  51641. assert( assert_pager_state(pPager) );
  51642. assert( pPager->errCode==0 );
  51643. assert( pPager->readOnly==0 );
  51644. CHECK_PAGE(pPg);
  51645. /* The journal file needs to be opened. Higher level routines have already
  51646. ** obtained the necessary locks to begin the write-transaction, but the
  51647. ** rollback journal might not yet be open. Open it now if this is the case.
  51648. **
  51649. ** This is done before calling sqlite3PcacheMakeDirty() on the page.
  51650. ** Otherwise, if it were done after calling sqlite3PcacheMakeDirty(), then
  51651. ** an error might occur and the pager would end up in WRITER_LOCKED state
  51652. ** with pages marked as dirty in the cache.
  51653. */
  51654. if( pPager->eState==PAGER_WRITER_LOCKED ){
  51655. rc = pager_open_journal(pPager);
  51656. if( rc!=SQLITE_OK ) return rc;
  51657. }
  51658. assert( pPager->eState>=PAGER_WRITER_CACHEMOD );
  51659. assert( assert_pager_state(pPager) );
  51660. /* Mark the page that is about to be modified as dirty. */
  51661. sqlite3PcacheMakeDirty(pPg);
  51662. /* If a rollback journal is in use, them make sure the page that is about
  51663. ** to change is in the rollback journal, or if the page is a new page off
  51664. ** then end of the file, make sure it is marked as PGHDR_NEED_SYNC.
  51665. */
  51666. assert( (pPager->pInJournal!=0) == isOpen(pPager->jfd) );
  51667. if( pPager->pInJournal!=0
  51668. && sqlite3BitvecTestNotNull(pPager->pInJournal, pPg->pgno)==0
  51669. ){
  51670. assert( pagerUseWal(pPager)==0 );
  51671. if( pPg->pgno<=pPager->dbOrigSize ){
  51672. rc = pagerAddPageToRollbackJournal(pPg);
  51673. if( rc!=SQLITE_OK ){
  51674. return rc;
  51675. }
  51676. }else{
  51677. if( pPager->eState!=PAGER_WRITER_DBMOD ){
  51678. pPg->flags |= PGHDR_NEED_SYNC;
  51679. }
  51680. PAGERTRACE(("APPEND %d page %d needSync=%d\n",
  51681. PAGERID(pPager), pPg->pgno,
  51682. ((pPg->flags&PGHDR_NEED_SYNC)?1:0)));
  51683. }
  51684. }
  51685. /* The PGHDR_DIRTY bit is set above when the page was added to the dirty-list
  51686. ** and before writing the page into the rollback journal. Wait until now,
  51687. ** after the page has been successfully journalled, before setting the
  51688. ** PGHDR_WRITEABLE bit that indicates that the page can be safely modified.
  51689. */
  51690. pPg->flags |= PGHDR_WRITEABLE;
  51691. /* If the statement journal is open and the page is not in it,
  51692. ** then write the page into the statement journal.
  51693. */
  51694. if( pPager->nSavepoint>0 ){
  51695. rc = subjournalPageIfRequired(pPg);
  51696. }
  51697. /* Update the database size and return. */
  51698. if( pPager->dbSize<pPg->pgno ){
  51699. pPager->dbSize = pPg->pgno;
  51700. }
  51701. return rc;
  51702. }
  51703. /*
  51704. ** This is a variant of sqlite3PagerWrite() that runs when the sector size
  51705. ** is larger than the page size. SQLite makes the (reasonable) assumption that
  51706. ** all bytes of a sector are written together by hardware. Hence, all bytes of
  51707. ** a sector need to be journalled in case of a power loss in the middle of
  51708. ** a write.
  51709. **
  51710. ** Usually, the sector size is less than or equal to the page size, in which
  51711. ** case pages can be individually written. This routine only runs in the
  51712. ** exceptional case where the page size is smaller than the sector size.
  51713. */
  51714. static SQLITE_NOINLINE int pagerWriteLargeSector(PgHdr *pPg){
  51715. int rc = SQLITE_OK; /* Return code */
  51716. Pgno nPageCount; /* Total number of pages in database file */
  51717. Pgno pg1; /* First page of the sector pPg is located on. */
  51718. int nPage = 0; /* Number of pages starting at pg1 to journal */
  51719. int ii; /* Loop counter */
  51720. int needSync = 0; /* True if any page has PGHDR_NEED_SYNC */
  51721. Pager *pPager = pPg->pPager; /* The pager that owns pPg */
  51722. Pgno nPagePerSector = (pPager->sectorSize/pPager->pageSize);
  51723. /* Set the doNotSpill NOSYNC bit to 1. This is because we cannot allow
  51724. ** a journal header to be written between the pages journaled by
  51725. ** this function.
  51726. */
  51727. assert( !MEMDB );
  51728. assert( (pPager->doNotSpill & SPILLFLAG_NOSYNC)==0 );
  51729. pPager->doNotSpill |= SPILLFLAG_NOSYNC;
  51730. /* This trick assumes that both the page-size and sector-size are
  51731. ** an integer power of 2. It sets variable pg1 to the identifier
  51732. ** of the first page of the sector pPg is located on.
  51733. */
  51734. pg1 = ((pPg->pgno-1) & ~(nPagePerSector-1)) + 1;
  51735. nPageCount = pPager->dbSize;
  51736. if( pPg->pgno>nPageCount ){
  51737. nPage = (pPg->pgno - pg1)+1;
  51738. }else if( (pg1+nPagePerSector-1)>nPageCount ){
  51739. nPage = nPageCount+1-pg1;
  51740. }else{
  51741. nPage = nPagePerSector;
  51742. }
  51743. assert(nPage>0);
  51744. assert(pg1<=pPg->pgno);
  51745. assert((pg1+nPage)>pPg->pgno);
  51746. for(ii=0; ii<nPage && rc==SQLITE_OK; ii++){
  51747. Pgno pg = pg1+ii;
  51748. PgHdr *pPage;
  51749. if( pg==pPg->pgno || !sqlite3BitvecTest(pPager->pInJournal, pg) ){
  51750. if( pg!=PAGER_MJ_PGNO(pPager) ){
  51751. rc = sqlite3PagerGet(pPager, pg, &pPage, 0);
  51752. if( rc==SQLITE_OK ){
  51753. rc = pager_write(pPage);
  51754. if( pPage->flags&PGHDR_NEED_SYNC ){
  51755. needSync = 1;
  51756. }
  51757. sqlite3PagerUnrefNotNull(pPage);
  51758. }
  51759. }
  51760. }else if( (pPage = sqlite3PagerLookup(pPager, pg))!=0 ){
  51761. if( pPage->flags&PGHDR_NEED_SYNC ){
  51762. needSync = 1;
  51763. }
  51764. sqlite3PagerUnrefNotNull(pPage);
  51765. }
  51766. }
  51767. /* If the PGHDR_NEED_SYNC flag is set for any of the nPage pages
  51768. ** starting at pg1, then it needs to be set for all of them. Because
  51769. ** writing to any of these nPage pages may damage the others, the
  51770. ** journal file must contain sync()ed copies of all of them
  51771. ** before any of them can be written out to the database file.
  51772. */
  51773. if( rc==SQLITE_OK && needSync ){
  51774. assert( !MEMDB );
  51775. for(ii=0; ii<nPage; ii++){
  51776. PgHdr *pPage = sqlite3PagerLookup(pPager, pg1+ii);
  51777. if( pPage ){
  51778. pPage->flags |= PGHDR_NEED_SYNC;
  51779. sqlite3PagerUnrefNotNull(pPage);
  51780. }
  51781. }
  51782. }
  51783. assert( (pPager->doNotSpill & SPILLFLAG_NOSYNC)!=0 );
  51784. pPager->doNotSpill &= ~SPILLFLAG_NOSYNC;
  51785. return rc;
  51786. }
  51787. /*
  51788. ** Mark a data page as writeable. This routine must be called before
  51789. ** making changes to a page. The caller must check the return value
  51790. ** of this function and be careful not to change any page data unless
  51791. ** this routine returns SQLITE_OK.
  51792. **
  51793. ** The difference between this function and pager_write() is that this
  51794. ** function also deals with the special case where 2 or more pages
  51795. ** fit on a single disk sector. In this case all co-resident pages
  51796. ** must have been written to the journal file before returning.
  51797. **
  51798. ** If an error occurs, SQLITE_NOMEM or an IO error code is returned
  51799. ** as appropriate. Otherwise, SQLITE_OK.
  51800. */
  51801. SQLITE_PRIVATE int sqlite3PagerWrite(PgHdr *pPg){
  51802. Pager *pPager = pPg->pPager;
  51803. assert( (pPg->flags & PGHDR_MMAP)==0 );
  51804. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  51805. assert( assert_pager_state(pPager) );
  51806. if( (pPg->flags & PGHDR_WRITEABLE)!=0 && pPager->dbSize>=pPg->pgno ){
  51807. if( pPager->nSavepoint ) return subjournalPageIfRequired(pPg);
  51808. return SQLITE_OK;
  51809. }else if( pPager->errCode ){
  51810. return pPager->errCode;
  51811. }else if( pPager->sectorSize > (u32)pPager->pageSize ){
  51812. assert( pPager->tempFile==0 );
  51813. return pagerWriteLargeSector(pPg);
  51814. }else{
  51815. return pager_write(pPg);
  51816. }
  51817. }
  51818. /*
  51819. ** Return TRUE if the page given in the argument was previously passed
  51820. ** to sqlite3PagerWrite(). In other words, return TRUE if it is ok
  51821. ** to change the content of the page.
  51822. */
  51823. #ifndef NDEBUG
  51824. SQLITE_PRIVATE int sqlite3PagerIswriteable(DbPage *pPg){
  51825. return pPg->flags & PGHDR_WRITEABLE;
  51826. }
  51827. #endif
  51828. /*
  51829. ** A call to this routine tells the pager that it is not necessary to
  51830. ** write the information on page pPg back to the disk, even though
  51831. ** that page might be marked as dirty. This happens, for example, when
  51832. ** the page has been added as a leaf of the freelist and so its
  51833. ** content no longer matters.
  51834. **
  51835. ** The overlying software layer calls this routine when all of the data
  51836. ** on the given page is unused. The pager marks the page as clean so
  51837. ** that it does not get written to disk.
  51838. **
  51839. ** Tests show that this optimization can quadruple the speed of large
  51840. ** DELETE operations.
  51841. **
  51842. ** This optimization cannot be used with a temp-file, as the page may
  51843. ** have been dirty at the start of the transaction. In that case, if
  51844. ** memory pressure forces page pPg out of the cache, the data does need
  51845. ** to be written out to disk so that it may be read back in if the
  51846. ** current transaction is rolled back.
  51847. */
  51848. SQLITE_PRIVATE void sqlite3PagerDontWrite(PgHdr *pPg){
  51849. Pager *pPager = pPg->pPager;
  51850. if( !pPager->tempFile && (pPg->flags&PGHDR_DIRTY) && pPager->nSavepoint==0 ){
  51851. PAGERTRACE(("DONT_WRITE page %d of %d\n", pPg->pgno, PAGERID(pPager)));
  51852. IOTRACE(("CLEAN %p %d\n", pPager, pPg->pgno))
  51853. pPg->flags |= PGHDR_DONT_WRITE;
  51854. pPg->flags &= ~PGHDR_WRITEABLE;
  51855. testcase( pPg->flags & PGHDR_NEED_SYNC );
  51856. pager_set_pagehash(pPg);
  51857. }
  51858. }
  51859. /*
  51860. ** This routine is called to increment the value of the database file
  51861. ** change-counter, stored as a 4-byte big-endian integer starting at
  51862. ** byte offset 24 of the pager file. The secondary change counter at
  51863. ** 92 is also updated, as is the SQLite version number at offset 96.
  51864. **
  51865. ** But this only happens if the pPager->changeCountDone flag is false.
  51866. ** To avoid excess churning of page 1, the update only happens once.
  51867. ** See also the pager_write_changecounter() routine that does an
  51868. ** unconditional update of the change counters.
  51869. **
  51870. ** If the isDirectMode flag is zero, then this is done by calling
  51871. ** sqlite3PagerWrite() on page 1, then modifying the contents of the
  51872. ** page data. In this case the file will be updated when the current
  51873. ** transaction is committed.
  51874. **
  51875. ** The isDirectMode flag may only be non-zero if the library was compiled
  51876. ** with the SQLITE_ENABLE_ATOMIC_WRITE macro defined. In this case,
  51877. ** if isDirect is non-zero, then the database file is updated directly
  51878. ** by writing an updated version of page 1 using a call to the
  51879. ** sqlite3OsWrite() function.
  51880. */
  51881. static int pager_incr_changecounter(Pager *pPager, int isDirectMode){
  51882. int rc = SQLITE_OK;
  51883. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  51884. || pPager->eState==PAGER_WRITER_DBMOD
  51885. );
  51886. assert( assert_pager_state(pPager) );
  51887. /* Declare and initialize constant integer 'isDirect'. If the
  51888. ** atomic-write optimization is enabled in this build, then isDirect
  51889. ** is initialized to the value passed as the isDirectMode parameter
  51890. ** to this function. Otherwise, it is always set to zero.
  51891. **
  51892. ** The idea is that if the atomic-write optimization is not
  51893. ** enabled at compile time, the compiler can omit the tests of
  51894. ** 'isDirect' below, as well as the block enclosed in the
  51895. ** "if( isDirect )" condition.
  51896. */
  51897. #ifndef SQLITE_ENABLE_ATOMIC_WRITE
  51898. # define DIRECT_MODE 0
  51899. assert( isDirectMode==0 );
  51900. UNUSED_PARAMETER(isDirectMode);
  51901. #else
  51902. # define DIRECT_MODE isDirectMode
  51903. #endif
  51904. if( !pPager->changeCountDone && ALWAYS(pPager->dbSize>0) ){
  51905. PgHdr *pPgHdr; /* Reference to page 1 */
  51906. assert( !pPager->tempFile && isOpen(pPager->fd) );
  51907. /* Open page 1 of the file for writing. */
  51908. rc = sqlite3PagerGet(pPager, 1, &pPgHdr, 0);
  51909. assert( pPgHdr==0 || rc==SQLITE_OK );
  51910. /* If page one was fetched successfully, and this function is not
  51911. ** operating in direct-mode, make page 1 writable. When not in
  51912. ** direct mode, page 1 is always held in cache and hence the PagerGet()
  51913. ** above is always successful - hence the ALWAYS on rc==SQLITE_OK.
  51914. */
  51915. if( !DIRECT_MODE && ALWAYS(rc==SQLITE_OK) ){
  51916. rc = sqlite3PagerWrite(pPgHdr);
  51917. }
  51918. if( rc==SQLITE_OK ){
  51919. /* Actually do the update of the change counter */
  51920. pager_write_changecounter(pPgHdr);
  51921. /* If running in direct mode, write the contents of page 1 to the file. */
  51922. if( DIRECT_MODE ){
  51923. const void *zBuf;
  51924. assert( pPager->dbFileSize>0 );
  51925. CODEC2(pPager, pPgHdr->pData, 1, 6, rc=SQLITE_NOMEM_BKPT, zBuf);
  51926. if( rc==SQLITE_OK ){
  51927. rc = sqlite3OsWrite(pPager->fd, zBuf, pPager->pageSize, 0);
  51928. pPager->aStat[PAGER_STAT_WRITE]++;
  51929. }
  51930. if( rc==SQLITE_OK ){
  51931. /* Update the pager's copy of the change-counter. Otherwise, the
  51932. ** next time a read transaction is opened the cache will be
  51933. ** flushed (as the change-counter values will not match). */
  51934. const void *pCopy = (const void *)&((const char *)zBuf)[24];
  51935. memcpy(&pPager->dbFileVers, pCopy, sizeof(pPager->dbFileVers));
  51936. pPager->changeCountDone = 1;
  51937. }
  51938. }else{
  51939. pPager->changeCountDone = 1;
  51940. }
  51941. }
  51942. /* Release the page reference. */
  51943. sqlite3PagerUnref(pPgHdr);
  51944. }
  51945. return rc;
  51946. }
  51947. /*
  51948. ** Sync the database file to disk. This is a no-op for in-memory databases
  51949. ** or pages with the Pager.noSync flag set.
  51950. **
  51951. ** If successful, or if called on a pager for which it is a no-op, this
  51952. ** function returns SQLITE_OK. Otherwise, an IO error code is returned.
  51953. */
  51954. SQLITE_PRIVATE int sqlite3PagerSync(Pager *pPager, const char *zMaster){
  51955. int rc = SQLITE_OK;
  51956. void *pArg = (void*)zMaster;
  51957. rc = sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_SYNC, pArg);
  51958. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  51959. if( rc==SQLITE_OK && !pPager->noSync ){
  51960. assert( !MEMDB );
  51961. rc = sqlite3OsSync(pPager->fd, pPager->syncFlags);
  51962. }
  51963. return rc;
  51964. }
  51965. /*
  51966. ** This function may only be called while a write-transaction is active in
  51967. ** rollback. If the connection is in WAL mode, this call is a no-op.
  51968. ** Otherwise, if the connection does not already have an EXCLUSIVE lock on
  51969. ** the database file, an attempt is made to obtain one.
  51970. **
  51971. ** If the EXCLUSIVE lock is already held or the attempt to obtain it is
  51972. ** successful, or the connection is in WAL mode, SQLITE_OK is returned.
  51973. ** Otherwise, either SQLITE_BUSY or an SQLITE_IOERR_XXX error code is
  51974. ** returned.
  51975. */
  51976. SQLITE_PRIVATE int sqlite3PagerExclusiveLock(Pager *pPager){
  51977. int rc = pPager->errCode;
  51978. assert( assert_pager_state(pPager) );
  51979. if( rc==SQLITE_OK ){
  51980. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  51981. || pPager->eState==PAGER_WRITER_DBMOD
  51982. || pPager->eState==PAGER_WRITER_LOCKED
  51983. );
  51984. assert( assert_pager_state(pPager) );
  51985. if( 0==pagerUseWal(pPager) ){
  51986. rc = pager_wait_on_lock(pPager, EXCLUSIVE_LOCK);
  51987. }
  51988. }
  51989. return rc;
  51990. }
  51991. /*
  51992. ** Sync the database file for the pager pPager. zMaster points to the name
  51993. ** of a master journal file that should be written into the individual
  51994. ** journal file. zMaster may be NULL, which is interpreted as no master
  51995. ** journal (a single database transaction).
  51996. **
  51997. ** This routine ensures that:
  51998. **
  51999. ** * The database file change-counter is updated,
  52000. ** * the journal is synced (unless the atomic-write optimization is used),
  52001. ** * all dirty pages are written to the database file,
  52002. ** * the database file is truncated (if required), and
  52003. ** * the database file synced.
  52004. **
  52005. ** The only thing that remains to commit the transaction is to finalize
  52006. ** (delete, truncate or zero the first part of) the journal file (or
  52007. ** delete the master journal file if specified).
  52008. **
  52009. ** Note that if zMaster==NULL, this does not overwrite a previous value
  52010. ** passed to an sqlite3PagerCommitPhaseOne() call.
  52011. **
  52012. ** If the final parameter - noSync - is true, then the database file itself
  52013. ** is not synced. The caller must call sqlite3PagerSync() directly to
  52014. ** sync the database file before calling CommitPhaseTwo() to delete the
  52015. ** journal file in this case.
  52016. */
  52017. SQLITE_PRIVATE int sqlite3PagerCommitPhaseOne(
  52018. Pager *pPager, /* Pager object */
  52019. const char *zMaster, /* If not NULL, the master journal name */
  52020. int noSync /* True to omit the xSync on the db file */
  52021. ){
  52022. int rc = SQLITE_OK; /* Return code */
  52023. assert( pPager->eState==PAGER_WRITER_LOCKED
  52024. || pPager->eState==PAGER_WRITER_CACHEMOD
  52025. || pPager->eState==PAGER_WRITER_DBMOD
  52026. || pPager->eState==PAGER_ERROR
  52027. );
  52028. assert( assert_pager_state(pPager) );
  52029. /* If a prior error occurred, report that error again. */
  52030. if( NEVER(pPager->errCode) ) return pPager->errCode;
  52031. /* Provide the ability to easily simulate an I/O error during testing */
  52032. if( sqlite3FaultSim(400) ) return SQLITE_IOERR;
  52033. PAGERTRACE(("DATABASE SYNC: File=%s zMaster=%s nSize=%d\n",
  52034. pPager->zFilename, zMaster, pPager->dbSize));
  52035. /* If no database changes have been made, return early. */
  52036. if( pPager->eState<PAGER_WRITER_CACHEMOD ) return SQLITE_OK;
  52037. assert( MEMDB==0 || pPager->tempFile );
  52038. assert( isOpen(pPager->fd) || pPager->tempFile );
  52039. if( 0==pagerFlushOnCommit(pPager, 1) ){
  52040. /* If this is an in-memory db, or no pages have been written to, or this
  52041. ** function has already been called, it is mostly a no-op. However, any
  52042. ** backup in progress needs to be restarted. */
  52043. sqlite3BackupRestart(pPager->pBackup);
  52044. }else{
  52045. if( pagerUseWal(pPager) ){
  52046. PgHdr *pList = sqlite3PcacheDirtyList(pPager->pPCache);
  52047. PgHdr *pPageOne = 0;
  52048. if( pList==0 ){
  52049. /* Must have at least one page for the WAL commit flag.
  52050. ** Ticket [2d1a5c67dfc2363e44f29d9bbd57f] 2011-05-18 */
  52051. rc = sqlite3PagerGet(pPager, 1, &pPageOne, 0);
  52052. pList = pPageOne;
  52053. pList->pDirty = 0;
  52054. }
  52055. assert( rc==SQLITE_OK );
  52056. if( ALWAYS(pList) ){
  52057. rc = pagerWalFrames(pPager, pList, pPager->dbSize, 1);
  52058. }
  52059. sqlite3PagerUnref(pPageOne);
  52060. if( rc==SQLITE_OK ){
  52061. sqlite3PcacheCleanAll(pPager->pPCache);
  52062. }
  52063. }else{
  52064. /* The bBatch boolean is true if the batch-atomic-write commit method
  52065. ** should be used. No rollback journal is created if batch-atomic-write
  52066. ** is enabled.
  52067. */
  52068. sqlite3_file *fd = pPager->fd;
  52069. #ifdef SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  52070. const int bBatch = zMaster==0 /* An SQLITE_IOCAP_BATCH_ATOMIC commit */
  52071. && (sqlite3OsDeviceCharacteristics(fd) & SQLITE_IOCAP_BATCH_ATOMIC)
  52072. && !pPager->noSync
  52073. && sqlite3JournalIsInMemory(pPager->jfd);
  52074. #else
  52075. # define bBatch 0
  52076. #endif
  52077. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  52078. /* The following block updates the change-counter. Exactly how it
  52079. ** does this depends on whether or not the atomic-update optimization
  52080. ** was enabled at compile time, and if this transaction meets the
  52081. ** runtime criteria to use the operation:
  52082. **
  52083. ** * The file-system supports the atomic-write property for
  52084. ** blocks of size page-size, and
  52085. ** * This commit is not part of a multi-file transaction, and
  52086. ** * Exactly one page has been modified and store in the journal file.
  52087. **
  52088. ** If the optimization was not enabled at compile time, then the
  52089. ** pager_incr_changecounter() function is called to update the change
  52090. ** counter in 'indirect-mode'. If the optimization is compiled in but
  52091. ** is not applicable to this transaction, call sqlite3JournalCreate()
  52092. ** to make sure the journal file has actually been created, then call
  52093. ** pager_incr_changecounter() to update the change-counter in indirect
  52094. ** mode.
  52095. **
  52096. ** Otherwise, if the optimization is both enabled and applicable,
  52097. ** then call pager_incr_changecounter() to update the change-counter
  52098. ** in 'direct' mode. In this case the journal file will never be
  52099. ** created for this transaction.
  52100. */
  52101. if( bBatch==0 ){
  52102. PgHdr *pPg;
  52103. assert( isOpen(pPager->jfd)
  52104. || pPager->journalMode==PAGER_JOURNALMODE_OFF
  52105. || pPager->journalMode==PAGER_JOURNALMODE_WAL
  52106. );
  52107. if( !zMaster && isOpen(pPager->jfd)
  52108. && pPager->journalOff==jrnlBufferSize(pPager)
  52109. && pPager->dbSize>=pPager->dbOrigSize
  52110. && (!(pPg = sqlite3PcacheDirtyList(pPager->pPCache)) || 0==pPg->pDirty)
  52111. ){
  52112. /* Update the db file change counter via the direct-write method. The
  52113. ** following call will modify the in-memory representation of page 1
  52114. ** to include the updated change counter and then write page 1
  52115. ** directly to the database file. Because of the atomic-write
  52116. ** property of the host file-system, this is safe.
  52117. */
  52118. rc = pager_incr_changecounter(pPager, 1);
  52119. }else{
  52120. rc = sqlite3JournalCreate(pPager->jfd);
  52121. if( rc==SQLITE_OK ){
  52122. rc = pager_incr_changecounter(pPager, 0);
  52123. }
  52124. }
  52125. }
  52126. #else
  52127. #ifdef SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  52128. if( zMaster ){
  52129. rc = sqlite3JournalCreate(pPager->jfd);
  52130. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  52131. }
  52132. #endif
  52133. rc = pager_incr_changecounter(pPager, 0);
  52134. #endif
  52135. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  52136. /* Write the master journal name into the journal file. If a master
  52137. ** journal file name has already been written to the journal file,
  52138. ** or if zMaster is NULL (no master journal), then this call is a no-op.
  52139. */
  52140. rc = writeMasterJournal(pPager, zMaster);
  52141. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  52142. /* Sync the journal file and write all dirty pages to the database.
  52143. ** If the atomic-update optimization is being used, this sync will not
  52144. ** create the journal file or perform any real IO.
  52145. **
  52146. ** Because the change-counter page was just modified, unless the
  52147. ** atomic-update optimization is used it is almost certain that the
  52148. ** journal requires a sync here. However, in locking_mode=exclusive
  52149. ** on a system under memory pressure it is just possible that this is
  52150. ** not the case. In this case it is likely enough that the redundant
  52151. ** xSync() call will be changed to a no-op by the OS anyhow.
  52152. */
  52153. rc = syncJournal(pPager, 0);
  52154. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  52155. if( bBatch ){
  52156. /* The pager is now in DBMOD state. But regardless of what happens
  52157. ** next, attempting to play the journal back into the database would
  52158. ** be unsafe. Close it now to make sure that does not happen. */
  52159. sqlite3OsClose(pPager->jfd);
  52160. rc = sqlite3OsFileControl(fd, SQLITE_FCNTL_BEGIN_ATOMIC_WRITE, 0);
  52161. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  52162. }
  52163. rc = pager_write_pagelist(pPager,sqlite3PcacheDirtyList(pPager->pPCache));
  52164. if( bBatch ){
  52165. if( rc==SQLITE_OK ){
  52166. rc = sqlite3OsFileControl(fd, SQLITE_FCNTL_COMMIT_ATOMIC_WRITE, 0);
  52167. }
  52168. if( rc!=SQLITE_OK ){
  52169. sqlite3OsFileControlHint(fd, SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE, 0);
  52170. }
  52171. }
  52172. if( rc!=SQLITE_OK ){
  52173. assert( rc!=SQLITE_IOERR_BLOCKED );
  52174. goto commit_phase_one_exit;
  52175. }
  52176. sqlite3PcacheCleanAll(pPager->pPCache);
  52177. /* If the file on disk is smaller than the database image, use
  52178. ** pager_truncate to grow the file here. This can happen if the database
  52179. ** image was extended as part of the current transaction and then the
  52180. ** last page in the db image moved to the free-list. In this case the
  52181. ** last page is never written out to disk, leaving the database file
  52182. ** undersized. Fix this now if it is the case. */
  52183. if( pPager->dbSize>pPager->dbFileSize ){
  52184. Pgno nNew = pPager->dbSize - (pPager->dbSize==PAGER_MJ_PGNO(pPager));
  52185. assert( pPager->eState==PAGER_WRITER_DBMOD );
  52186. rc = pager_truncate(pPager, nNew);
  52187. if( rc!=SQLITE_OK ) goto commit_phase_one_exit;
  52188. }
  52189. /* Finally, sync the database file. */
  52190. if( !noSync ){
  52191. rc = sqlite3PagerSync(pPager, zMaster);
  52192. }
  52193. IOTRACE(("DBSYNC %p\n", pPager))
  52194. }
  52195. }
  52196. commit_phase_one_exit:
  52197. if( rc==SQLITE_OK && !pagerUseWal(pPager) ){
  52198. pPager->eState = PAGER_WRITER_FINISHED;
  52199. }
  52200. return rc;
  52201. }
  52202. /*
  52203. ** When this function is called, the database file has been completely
  52204. ** updated to reflect the changes made by the current transaction and
  52205. ** synced to disk. The journal file still exists in the file-system
  52206. ** though, and if a failure occurs at this point it will eventually
  52207. ** be used as a hot-journal and the current transaction rolled back.
  52208. **
  52209. ** This function finalizes the journal file, either by deleting,
  52210. ** truncating or partially zeroing it, so that it cannot be used
  52211. ** for hot-journal rollback. Once this is done the transaction is
  52212. ** irrevocably committed.
  52213. **
  52214. ** If an error occurs, an IO error code is returned and the pager
  52215. ** moves into the error state. Otherwise, SQLITE_OK is returned.
  52216. */
  52217. SQLITE_PRIVATE int sqlite3PagerCommitPhaseTwo(Pager *pPager){
  52218. int rc = SQLITE_OK; /* Return code */
  52219. /* This routine should not be called if a prior error has occurred.
  52220. ** But if (due to a coding error elsewhere in the system) it does get
  52221. ** called, just return the same error code without doing anything. */
  52222. if( NEVER(pPager->errCode) ) return pPager->errCode;
  52223. assert( pPager->eState==PAGER_WRITER_LOCKED
  52224. || pPager->eState==PAGER_WRITER_FINISHED
  52225. || (pagerUseWal(pPager) && pPager->eState==PAGER_WRITER_CACHEMOD)
  52226. );
  52227. assert( assert_pager_state(pPager) );
  52228. /* An optimization. If the database was not actually modified during
  52229. ** this transaction, the pager is running in exclusive-mode and is
  52230. ** using persistent journals, then this function is a no-op.
  52231. **
  52232. ** The start of the journal file currently contains a single journal
  52233. ** header with the nRec field set to 0. If such a journal is used as
  52234. ** a hot-journal during hot-journal rollback, 0 changes will be made
  52235. ** to the database file. So there is no need to zero the journal
  52236. ** header. Since the pager is in exclusive mode, there is no need
  52237. ** to drop any locks either.
  52238. */
  52239. if( pPager->eState==PAGER_WRITER_LOCKED
  52240. && pPager->exclusiveMode
  52241. && pPager->journalMode==PAGER_JOURNALMODE_PERSIST
  52242. ){
  52243. assert( pPager->journalOff==JOURNAL_HDR_SZ(pPager) || !pPager->journalOff );
  52244. pPager->eState = PAGER_READER;
  52245. return SQLITE_OK;
  52246. }
  52247. PAGERTRACE(("COMMIT %d\n", PAGERID(pPager)));
  52248. pPager->iDataVersion++;
  52249. rc = pager_end_transaction(pPager, pPager->setMaster, 1);
  52250. return pager_error(pPager, rc);
  52251. }
  52252. /*
  52253. ** If a write transaction is open, then all changes made within the
  52254. ** transaction are reverted and the current write-transaction is closed.
  52255. ** The pager falls back to PAGER_READER state if successful, or PAGER_ERROR
  52256. ** state if an error occurs.
  52257. **
  52258. ** If the pager is already in PAGER_ERROR state when this function is called,
  52259. ** it returns Pager.errCode immediately. No work is performed in this case.
  52260. **
  52261. ** Otherwise, in rollback mode, this function performs two functions:
  52262. **
  52263. ** 1) It rolls back the journal file, restoring all database file and
  52264. ** in-memory cache pages to the state they were in when the transaction
  52265. ** was opened, and
  52266. **
  52267. ** 2) It finalizes the journal file, so that it is not used for hot
  52268. ** rollback at any point in the future.
  52269. **
  52270. ** Finalization of the journal file (task 2) is only performed if the
  52271. ** rollback is successful.
  52272. **
  52273. ** In WAL mode, all cache-entries containing data modified within the
  52274. ** current transaction are either expelled from the cache or reverted to
  52275. ** their pre-transaction state by re-reading data from the database or
  52276. ** WAL files. The WAL transaction is then closed.
  52277. */
  52278. SQLITE_PRIVATE int sqlite3PagerRollback(Pager *pPager){
  52279. int rc = SQLITE_OK; /* Return code */
  52280. PAGERTRACE(("ROLLBACK %d\n", PAGERID(pPager)));
  52281. /* PagerRollback() is a no-op if called in READER or OPEN state. If
  52282. ** the pager is already in the ERROR state, the rollback is not
  52283. ** attempted here. Instead, the error code is returned to the caller.
  52284. */
  52285. assert( assert_pager_state(pPager) );
  52286. if( pPager->eState==PAGER_ERROR ) return pPager->errCode;
  52287. if( pPager->eState<=PAGER_READER ) return SQLITE_OK;
  52288. if( pagerUseWal(pPager) ){
  52289. int rc2;
  52290. rc = sqlite3PagerSavepoint(pPager, SAVEPOINT_ROLLBACK, -1);
  52291. rc2 = pager_end_transaction(pPager, pPager->setMaster, 0);
  52292. if( rc==SQLITE_OK ) rc = rc2;
  52293. }else if( !isOpen(pPager->jfd) || pPager->eState==PAGER_WRITER_LOCKED ){
  52294. int eState = pPager->eState;
  52295. rc = pager_end_transaction(pPager, 0, 0);
  52296. if( !MEMDB && eState>PAGER_WRITER_LOCKED ){
  52297. /* This can happen using journal_mode=off. Move the pager to the error
  52298. ** state to indicate that the contents of the cache may not be trusted.
  52299. ** Any active readers will get SQLITE_ABORT.
  52300. */
  52301. pPager->errCode = SQLITE_ABORT;
  52302. pPager->eState = PAGER_ERROR;
  52303. setGetterMethod(pPager);
  52304. return rc;
  52305. }
  52306. }else{
  52307. rc = pager_playback(pPager, 0);
  52308. }
  52309. assert( pPager->eState==PAGER_READER || rc!=SQLITE_OK );
  52310. assert( rc==SQLITE_OK || rc==SQLITE_FULL || rc==SQLITE_CORRUPT
  52311. || rc==SQLITE_NOMEM || (rc&0xFF)==SQLITE_IOERR
  52312. || rc==SQLITE_CANTOPEN
  52313. );
  52314. /* If an error occurs during a ROLLBACK, we can no longer trust the pager
  52315. ** cache. So call pager_error() on the way out to make any error persistent.
  52316. */
  52317. return pager_error(pPager, rc);
  52318. }
  52319. /*
  52320. ** Return TRUE if the database file is opened read-only. Return FALSE
  52321. ** if the database is (in theory) writable.
  52322. */
  52323. SQLITE_PRIVATE u8 sqlite3PagerIsreadonly(Pager *pPager){
  52324. return pPager->readOnly;
  52325. }
  52326. #ifdef SQLITE_DEBUG
  52327. /*
  52328. ** Return the sum of the reference counts for all pages held by pPager.
  52329. */
  52330. SQLITE_PRIVATE int sqlite3PagerRefcount(Pager *pPager){
  52331. return sqlite3PcacheRefCount(pPager->pPCache);
  52332. }
  52333. #endif
  52334. /*
  52335. ** Return the approximate number of bytes of memory currently
  52336. ** used by the pager and its associated cache.
  52337. */
  52338. SQLITE_PRIVATE int sqlite3PagerMemUsed(Pager *pPager){
  52339. int perPageSize = pPager->pageSize + pPager->nExtra + sizeof(PgHdr)
  52340. + 5*sizeof(void*);
  52341. return perPageSize*sqlite3PcachePagecount(pPager->pPCache)
  52342. + sqlite3MallocSize(pPager)
  52343. + pPager->pageSize;
  52344. }
  52345. /*
  52346. ** Return the number of references to the specified page.
  52347. */
  52348. SQLITE_PRIVATE int sqlite3PagerPageRefcount(DbPage *pPage){
  52349. return sqlite3PcachePageRefcount(pPage);
  52350. }
  52351. #ifdef SQLITE_TEST
  52352. /*
  52353. ** This routine is used for testing and analysis only.
  52354. */
  52355. SQLITE_PRIVATE int *sqlite3PagerStats(Pager *pPager){
  52356. static int a[11];
  52357. a[0] = sqlite3PcacheRefCount(pPager->pPCache);
  52358. a[1] = sqlite3PcachePagecount(pPager->pPCache);
  52359. a[2] = sqlite3PcacheGetCachesize(pPager->pPCache);
  52360. a[3] = pPager->eState==PAGER_OPEN ? -1 : (int) pPager->dbSize;
  52361. a[4] = pPager->eState;
  52362. a[5] = pPager->errCode;
  52363. a[6] = pPager->aStat[PAGER_STAT_HIT];
  52364. a[7] = pPager->aStat[PAGER_STAT_MISS];
  52365. a[8] = 0; /* Used to be pPager->nOvfl */
  52366. a[9] = pPager->nRead;
  52367. a[10] = pPager->aStat[PAGER_STAT_WRITE];
  52368. return a;
  52369. }
  52370. #endif
  52371. /*
  52372. ** Parameter eStat must be one of SQLITE_DBSTATUS_CACHE_HIT, _MISS, _WRITE,
  52373. ** or _WRITE+1. The SQLITE_DBSTATUS_CACHE_WRITE+1 case is a translation
  52374. ** of SQLITE_DBSTATUS_CACHE_SPILL. The _SPILL case is not contiguous because
  52375. ** it was added later.
  52376. **
  52377. ** Before returning, *pnVal is incremented by the
  52378. ** current cache hit or miss count, according to the value of eStat. If the
  52379. ** reset parameter is non-zero, the cache hit or miss count is zeroed before
  52380. ** returning.
  52381. */
  52382. SQLITE_PRIVATE void sqlite3PagerCacheStat(Pager *pPager, int eStat, int reset, int *pnVal){
  52383. assert( eStat==SQLITE_DBSTATUS_CACHE_HIT
  52384. || eStat==SQLITE_DBSTATUS_CACHE_MISS
  52385. || eStat==SQLITE_DBSTATUS_CACHE_WRITE
  52386. || eStat==SQLITE_DBSTATUS_CACHE_WRITE+1
  52387. );
  52388. assert( SQLITE_DBSTATUS_CACHE_HIT+1==SQLITE_DBSTATUS_CACHE_MISS );
  52389. assert( SQLITE_DBSTATUS_CACHE_HIT+2==SQLITE_DBSTATUS_CACHE_WRITE );
  52390. assert( PAGER_STAT_HIT==0 && PAGER_STAT_MISS==1
  52391. && PAGER_STAT_WRITE==2 && PAGER_STAT_SPILL==3 );
  52392. eStat -= SQLITE_DBSTATUS_CACHE_HIT;
  52393. *pnVal += pPager->aStat[eStat];
  52394. if( reset ){
  52395. pPager->aStat[eStat] = 0;
  52396. }
  52397. }
  52398. /*
  52399. ** Return true if this is an in-memory or temp-file backed pager.
  52400. */
  52401. SQLITE_PRIVATE int sqlite3PagerIsMemdb(Pager *pPager){
  52402. return pPager->tempFile;
  52403. }
  52404. /*
  52405. ** Check that there are at least nSavepoint savepoints open. If there are
  52406. ** currently less than nSavepoints open, then open one or more savepoints
  52407. ** to make up the difference. If the number of savepoints is already
  52408. ** equal to nSavepoint, then this function is a no-op.
  52409. **
  52410. ** If a memory allocation fails, SQLITE_NOMEM is returned. If an error
  52411. ** occurs while opening the sub-journal file, then an IO error code is
  52412. ** returned. Otherwise, SQLITE_OK.
  52413. */
  52414. static SQLITE_NOINLINE int pagerOpenSavepoint(Pager *pPager, int nSavepoint){
  52415. int rc = SQLITE_OK; /* Return code */
  52416. int nCurrent = pPager->nSavepoint; /* Current number of savepoints */
  52417. int ii; /* Iterator variable */
  52418. PagerSavepoint *aNew; /* New Pager.aSavepoint array */
  52419. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  52420. assert( assert_pager_state(pPager) );
  52421. assert( nSavepoint>nCurrent && pPager->useJournal );
  52422. /* Grow the Pager.aSavepoint array using realloc(). Return SQLITE_NOMEM
  52423. ** if the allocation fails. Otherwise, zero the new portion in case a
  52424. ** malloc failure occurs while populating it in the for(...) loop below.
  52425. */
  52426. aNew = (PagerSavepoint *)sqlite3Realloc(
  52427. pPager->aSavepoint, sizeof(PagerSavepoint)*nSavepoint
  52428. );
  52429. if( !aNew ){
  52430. return SQLITE_NOMEM_BKPT;
  52431. }
  52432. memset(&aNew[nCurrent], 0, (nSavepoint-nCurrent) * sizeof(PagerSavepoint));
  52433. pPager->aSavepoint = aNew;
  52434. /* Populate the PagerSavepoint structures just allocated. */
  52435. for(ii=nCurrent; ii<nSavepoint; ii++){
  52436. aNew[ii].nOrig = pPager->dbSize;
  52437. if( isOpen(pPager->jfd) && pPager->journalOff>0 ){
  52438. aNew[ii].iOffset = pPager->journalOff;
  52439. }else{
  52440. aNew[ii].iOffset = JOURNAL_HDR_SZ(pPager);
  52441. }
  52442. aNew[ii].iSubRec = pPager->nSubRec;
  52443. aNew[ii].pInSavepoint = sqlite3BitvecCreate(pPager->dbSize);
  52444. if( !aNew[ii].pInSavepoint ){
  52445. return SQLITE_NOMEM_BKPT;
  52446. }
  52447. if( pagerUseWal(pPager) ){
  52448. sqlite3WalSavepoint(pPager->pWal, aNew[ii].aWalData);
  52449. }
  52450. pPager->nSavepoint = ii+1;
  52451. }
  52452. assert( pPager->nSavepoint==nSavepoint );
  52453. assertTruncateConstraint(pPager);
  52454. return rc;
  52455. }
  52456. SQLITE_PRIVATE int sqlite3PagerOpenSavepoint(Pager *pPager, int nSavepoint){
  52457. assert( pPager->eState>=PAGER_WRITER_LOCKED );
  52458. assert( assert_pager_state(pPager) );
  52459. if( nSavepoint>pPager->nSavepoint && pPager->useJournal ){
  52460. return pagerOpenSavepoint(pPager, nSavepoint);
  52461. }else{
  52462. return SQLITE_OK;
  52463. }
  52464. }
  52465. /*
  52466. ** This function is called to rollback or release (commit) a savepoint.
  52467. ** The savepoint to release or rollback need not be the most recently
  52468. ** created savepoint.
  52469. **
  52470. ** Parameter op is always either SAVEPOINT_ROLLBACK or SAVEPOINT_RELEASE.
  52471. ** If it is SAVEPOINT_RELEASE, then release and destroy the savepoint with
  52472. ** index iSavepoint. If it is SAVEPOINT_ROLLBACK, then rollback all changes
  52473. ** that have occurred since the specified savepoint was created.
  52474. **
  52475. ** The savepoint to rollback or release is identified by parameter
  52476. ** iSavepoint. A value of 0 means to operate on the outermost savepoint
  52477. ** (the first created). A value of (Pager.nSavepoint-1) means operate
  52478. ** on the most recently created savepoint. If iSavepoint is greater than
  52479. ** (Pager.nSavepoint-1), then this function is a no-op.
  52480. **
  52481. ** If a negative value is passed to this function, then the current
  52482. ** transaction is rolled back. This is different to calling
  52483. ** sqlite3PagerRollback() because this function does not terminate
  52484. ** the transaction or unlock the database, it just restores the
  52485. ** contents of the database to its original state.
  52486. **
  52487. ** In any case, all savepoints with an index greater than iSavepoint
  52488. ** are destroyed. If this is a release operation (op==SAVEPOINT_RELEASE),
  52489. ** then savepoint iSavepoint is also destroyed.
  52490. **
  52491. ** This function may return SQLITE_NOMEM if a memory allocation fails,
  52492. ** or an IO error code if an IO error occurs while rolling back a
  52493. ** savepoint. If no errors occur, SQLITE_OK is returned.
  52494. */
  52495. SQLITE_PRIVATE int sqlite3PagerSavepoint(Pager *pPager, int op, int iSavepoint){
  52496. int rc = pPager->errCode;
  52497. #ifdef SQLITE_ENABLE_ZIPVFS
  52498. if( op==SAVEPOINT_RELEASE ) rc = SQLITE_OK;
  52499. #endif
  52500. assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
  52501. assert( iSavepoint>=0 || op==SAVEPOINT_ROLLBACK );
  52502. if( rc==SQLITE_OK && iSavepoint<pPager->nSavepoint ){
  52503. int ii; /* Iterator variable */
  52504. int nNew; /* Number of remaining savepoints after this op. */
  52505. /* Figure out how many savepoints will still be active after this
  52506. ** operation. Store this value in nNew. Then free resources associated
  52507. ** with any savepoints that are destroyed by this operation.
  52508. */
  52509. nNew = iSavepoint + (( op==SAVEPOINT_RELEASE ) ? 0 : 1);
  52510. for(ii=nNew; ii<pPager->nSavepoint; ii++){
  52511. sqlite3BitvecDestroy(pPager->aSavepoint[ii].pInSavepoint);
  52512. }
  52513. pPager->nSavepoint = nNew;
  52514. /* If this is a release of the outermost savepoint, truncate
  52515. ** the sub-journal to zero bytes in size. */
  52516. if( op==SAVEPOINT_RELEASE ){
  52517. if( nNew==0 && isOpen(pPager->sjfd) ){
  52518. /* Only truncate if it is an in-memory sub-journal. */
  52519. if( sqlite3JournalIsInMemory(pPager->sjfd) ){
  52520. rc = sqlite3OsTruncate(pPager->sjfd, 0);
  52521. assert( rc==SQLITE_OK );
  52522. }
  52523. pPager->nSubRec = 0;
  52524. }
  52525. }
  52526. /* Else this is a rollback operation, playback the specified savepoint.
  52527. ** If this is a temp-file, it is possible that the journal file has
  52528. ** not yet been opened. In this case there have been no changes to
  52529. ** the database file, so the playback operation can be skipped.
  52530. */
  52531. else if( pagerUseWal(pPager) || isOpen(pPager->jfd) ){
  52532. PagerSavepoint *pSavepoint = (nNew==0)?0:&pPager->aSavepoint[nNew-1];
  52533. rc = pagerPlaybackSavepoint(pPager, pSavepoint);
  52534. assert(rc!=SQLITE_DONE);
  52535. }
  52536. #ifdef SQLITE_ENABLE_ZIPVFS
  52537. /* If the cache has been modified but the savepoint cannot be rolled
  52538. ** back journal_mode=off, put the pager in the error state. This way,
  52539. ** if the VFS used by this pager includes ZipVFS, the entire transaction
  52540. ** can be rolled back at the ZipVFS level. */
  52541. else if(
  52542. pPager->journalMode==PAGER_JOURNALMODE_OFF
  52543. && pPager->eState>=PAGER_WRITER_CACHEMOD
  52544. ){
  52545. pPager->errCode = SQLITE_ABORT;
  52546. pPager->eState = PAGER_ERROR;
  52547. setGetterMethod(pPager);
  52548. }
  52549. #endif
  52550. }
  52551. return rc;
  52552. }
  52553. /*
  52554. ** Return the full pathname of the database file.
  52555. **
  52556. ** Except, if the pager is in-memory only, then return an empty string if
  52557. ** nullIfMemDb is true. This routine is called with nullIfMemDb==1 when
  52558. ** used to report the filename to the user, for compatibility with legacy
  52559. ** behavior. But when the Btree needs to know the filename for matching to
  52560. ** shared cache, it uses nullIfMemDb==0 so that in-memory databases can
  52561. ** participate in shared-cache.
  52562. */
  52563. SQLITE_PRIVATE const char *sqlite3PagerFilename(Pager *pPager, int nullIfMemDb){
  52564. return (nullIfMemDb && pPager->memDb) ? "" : pPager->zFilename;
  52565. }
  52566. /*
  52567. ** Return the VFS structure for the pager.
  52568. */
  52569. SQLITE_PRIVATE sqlite3_vfs *sqlite3PagerVfs(Pager *pPager){
  52570. return pPager->pVfs;
  52571. }
  52572. /*
  52573. ** Return the file handle for the database file associated
  52574. ** with the pager. This might return NULL if the file has
  52575. ** not yet been opened.
  52576. */
  52577. SQLITE_PRIVATE sqlite3_file *sqlite3PagerFile(Pager *pPager){
  52578. return pPager->fd;
  52579. }
  52580. #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
  52581. /*
  52582. ** Reset the lock timeout for pager.
  52583. */
  52584. SQLITE_PRIVATE void sqlite3PagerResetLockTimeout(Pager *pPager){
  52585. int x = 0;
  52586. sqlite3OsFileControl(pPager->fd, SQLITE_FCNTL_LOCK_TIMEOUT, &x);
  52587. }
  52588. #endif
  52589. /*
  52590. ** Return the file handle for the journal file (if it exists).
  52591. ** This will be either the rollback journal or the WAL file.
  52592. */
  52593. SQLITE_PRIVATE sqlite3_file *sqlite3PagerJrnlFile(Pager *pPager){
  52594. #if SQLITE_OMIT_WAL
  52595. return pPager->jfd;
  52596. #else
  52597. return pPager->pWal ? sqlite3WalFile(pPager->pWal) : pPager->jfd;
  52598. #endif
  52599. }
  52600. /*
  52601. ** Return the full pathname of the journal file.
  52602. */
  52603. SQLITE_PRIVATE const char *sqlite3PagerJournalname(Pager *pPager){
  52604. return pPager->zJournal;
  52605. }
  52606. #ifdef SQLITE_HAS_CODEC
  52607. /*
  52608. ** Set or retrieve the codec for this pager
  52609. */
  52610. SQLITE_PRIVATE void sqlite3PagerSetCodec(
  52611. Pager *pPager,
  52612. void *(*xCodec)(void*,void*,Pgno,int),
  52613. void (*xCodecSizeChng)(void*,int,int),
  52614. void (*xCodecFree)(void*),
  52615. void *pCodec
  52616. ){
  52617. if( pPager->xCodecFree ) pPager->xCodecFree(pPager->pCodec);
  52618. pPager->xCodec = pPager->memDb ? 0 : xCodec;
  52619. pPager->xCodecSizeChng = xCodecSizeChng;
  52620. pPager->xCodecFree = xCodecFree;
  52621. pPager->pCodec = pCodec;
  52622. setGetterMethod(pPager);
  52623. pagerReportSize(pPager);
  52624. }
  52625. SQLITE_PRIVATE void *sqlite3PagerGetCodec(Pager *pPager){
  52626. return pPager->pCodec;
  52627. }
  52628. /*
  52629. ** This function is called by the wal module when writing page content
  52630. ** into the log file.
  52631. **
  52632. ** This function returns a pointer to a buffer containing the encrypted
  52633. ** page content. If a malloc fails, this function may return NULL.
  52634. */
  52635. SQLITE_PRIVATE void *sqlite3PagerCodec(PgHdr *pPg){
  52636. void *aData = 0;
  52637. CODEC2(pPg->pPager, pPg->pData, pPg->pgno, 6, return 0, aData);
  52638. return aData;
  52639. }
  52640. /*
  52641. ** Return the current pager state
  52642. */
  52643. SQLITE_PRIVATE int sqlite3PagerState(Pager *pPager){
  52644. return pPager->eState;
  52645. }
  52646. #endif /* SQLITE_HAS_CODEC */
  52647. #ifndef SQLITE_OMIT_AUTOVACUUM
  52648. /*
  52649. ** Move the page pPg to location pgno in the file.
  52650. **
  52651. ** There must be no references to the page previously located at
  52652. ** pgno (which we call pPgOld) though that page is allowed to be
  52653. ** in cache. If the page previously located at pgno is not already
  52654. ** in the rollback journal, it is not put there by by this routine.
  52655. **
  52656. ** References to the page pPg remain valid. Updating any
  52657. ** meta-data associated with pPg (i.e. data stored in the nExtra bytes
  52658. ** allocated along with the page) is the responsibility of the caller.
  52659. **
  52660. ** A transaction must be active when this routine is called. It used to be
  52661. ** required that a statement transaction was not active, but this restriction
  52662. ** has been removed (CREATE INDEX needs to move a page when a statement
  52663. ** transaction is active).
  52664. **
  52665. ** If the fourth argument, isCommit, is non-zero, then this page is being
  52666. ** moved as part of a database reorganization just before the transaction
  52667. ** is being committed. In this case, it is guaranteed that the database page
  52668. ** pPg refers to will not be written to again within this transaction.
  52669. **
  52670. ** This function may return SQLITE_NOMEM or an IO error code if an error
  52671. ** occurs. Otherwise, it returns SQLITE_OK.
  52672. */
  52673. SQLITE_PRIVATE int sqlite3PagerMovepage(Pager *pPager, DbPage *pPg, Pgno pgno, int isCommit){
  52674. PgHdr *pPgOld; /* The page being overwritten. */
  52675. Pgno needSyncPgno = 0; /* Old value of pPg->pgno, if sync is required */
  52676. int rc; /* Return code */
  52677. Pgno origPgno; /* The original page number */
  52678. assert( pPg->nRef>0 );
  52679. assert( pPager->eState==PAGER_WRITER_CACHEMOD
  52680. || pPager->eState==PAGER_WRITER_DBMOD
  52681. );
  52682. assert( assert_pager_state(pPager) );
  52683. /* In order to be able to rollback, an in-memory database must journal
  52684. ** the page we are moving from.
  52685. */
  52686. assert( pPager->tempFile || !MEMDB );
  52687. if( pPager->tempFile ){
  52688. rc = sqlite3PagerWrite(pPg);
  52689. if( rc ) return rc;
  52690. }
  52691. /* If the page being moved is dirty and has not been saved by the latest
  52692. ** savepoint, then save the current contents of the page into the
  52693. ** sub-journal now. This is required to handle the following scenario:
  52694. **
  52695. ** BEGIN;
  52696. ** <journal page X, then modify it in memory>
  52697. ** SAVEPOINT one;
  52698. ** <Move page X to location Y>
  52699. ** ROLLBACK TO one;
  52700. **
  52701. ** If page X were not written to the sub-journal here, it would not
  52702. ** be possible to restore its contents when the "ROLLBACK TO one"
  52703. ** statement were is processed.
  52704. **
  52705. ** subjournalPage() may need to allocate space to store pPg->pgno into
  52706. ** one or more savepoint bitvecs. This is the reason this function
  52707. ** may return SQLITE_NOMEM.
  52708. */
  52709. if( (pPg->flags & PGHDR_DIRTY)!=0
  52710. && SQLITE_OK!=(rc = subjournalPageIfRequired(pPg))
  52711. ){
  52712. return rc;
  52713. }
  52714. PAGERTRACE(("MOVE %d page %d (needSync=%d) moves to %d\n",
  52715. PAGERID(pPager), pPg->pgno, (pPg->flags&PGHDR_NEED_SYNC)?1:0, pgno));
  52716. IOTRACE(("MOVE %p %d %d\n", pPager, pPg->pgno, pgno))
  52717. /* If the journal needs to be sync()ed before page pPg->pgno can
  52718. ** be written to, store pPg->pgno in local variable needSyncPgno.
  52719. **
  52720. ** If the isCommit flag is set, there is no need to remember that
  52721. ** the journal needs to be sync()ed before database page pPg->pgno
  52722. ** can be written to. The caller has already promised not to write to it.
  52723. */
  52724. if( (pPg->flags&PGHDR_NEED_SYNC) && !isCommit ){
  52725. needSyncPgno = pPg->pgno;
  52726. assert( pPager->journalMode==PAGER_JOURNALMODE_OFF ||
  52727. pageInJournal(pPager, pPg) || pPg->pgno>pPager->dbOrigSize );
  52728. assert( pPg->flags&PGHDR_DIRTY );
  52729. }
  52730. /* If the cache contains a page with page-number pgno, remove it
  52731. ** from its hash chain. Also, if the PGHDR_NEED_SYNC flag was set for
  52732. ** page pgno before the 'move' operation, it needs to be retained
  52733. ** for the page moved there.
  52734. */
  52735. pPg->flags &= ~PGHDR_NEED_SYNC;
  52736. pPgOld = sqlite3PagerLookup(pPager, pgno);
  52737. assert( !pPgOld || pPgOld->nRef==1 );
  52738. if( pPgOld ){
  52739. pPg->flags |= (pPgOld->flags&PGHDR_NEED_SYNC);
  52740. if( pPager->tempFile ){
  52741. /* Do not discard pages from an in-memory database since we might
  52742. ** need to rollback later. Just move the page out of the way. */
  52743. sqlite3PcacheMove(pPgOld, pPager->dbSize+1);
  52744. }else{
  52745. sqlite3PcacheDrop(pPgOld);
  52746. }
  52747. }
  52748. origPgno = pPg->pgno;
  52749. sqlite3PcacheMove(pPg, pgno);
  52750. sqlite3PcacheMakeDirty(pPg);
  52751. /* For an in-memory database, make sure the original page continues
  52752. ** to exist, in case the transaction needs to roll back. Use pPgOld
  52753. ** as the original page since it has already been allocated.
  52754. */
  52755. if( pPager->tempFile && pPgOld ){
  52756. sqlite3PcacheMove(pPgOld, origPgno);
  52757. sqlite3PagerUnrefNotNull(pPgOld);
  52758. }
  52759. if( needSyncPgno ){
  52760. /* If needSyncPgno is non-zero, then the journal file needs to be
  52761. ** sync()ed before any data is written to database file page needSyncPgno.
  52762. ** Currently, no such page exists in the page-cache and the
  52763. ** "is journaled" bitvec flag has been set. This needs to be remedied by
  52764. ** loading the page into the pager-cache and setting the PGHDR_NEED_SYNC
  52765. ** flag.
  52766. **
  52767. ** If the attempt to load the page into the page-cache fails, (due
  52768. ** to a malloc() or IO failure), clear the bit in the pInJournal[]
  52769. ** array. Otherwise, if the page is loaded and written again in
  52770. ** this transaction, it may be written to the database file before
  52771. ** it is synced into the journal file. This way, it may end up in
  52772. ** the journal file twice, but that is not a problem.
  52773. */
  52774. PgHdr *pPgHdr;
  52775. rc = sqlite3PagerGet(pPager, needSyncPgno, &pPgHdr, 0);
  52776. if( rc!=SQLITE_OK ){
  52777. if( needSyncPgno<=pPager->dbOrigSize ){
  52778. assert( pPager->pTmpSpace!=0 );
  52779. sqlite3BitvecClear(pPager->pInJournal, needSyncPgno, pPager->pTmpSpace);
  52780. }
  52781. return rc;
  52782. }
  52783. pPgHdr->flags |= PGHDR_NEED_SYNC;
  52784. sqlite3PcacheMakeDirty(pPgHdr);
  52785. sqlite3PagerUnrefNotNull(pPgHdr);
  52786. }
  52787. return SQLITE_OK;
  52788. }
  52789. #endif
  52790. /*
  52791. ** The page handle passed as the first argument refers to a dirty page
  52792. ** with a page number other than iNew. This function changes the page's
  52793. ** page number to iNew and sets the value of the PgHdr.flags field to
  52794. ** the value passed as the third parameter.
  52795. */
  52796. SQLITE_PRIVATE void sqlite3PagerRekey(DbPage *pPg, Pgno iNew, u16 flags){
  52797. assert( pPg->pgno!=iNew );
  52798. pPg->flags = flags;
  52799. sqlite3PcacheMove(pPg, iNew);
  52800. }
  52801. /*
  52802. ** Return a pointer to the data for the specified page.
  52803. */
  52804. SQLITE_PRIVATE void *sqlite3PagerGetData(DbPage *pPg){
  52805. assert( pPg->nRef>0 || pPg->pPager->memDb );
  52806. return pPg->pData;
  52807. }
  52808. /*
  52809. ** Return a pointer to the Pager.nExtra bytes of "extra" space
  52810. ** allocated along with the specified page.
  52811. */
  52812. SQLITE_PRIVATE void *sqlite3PagerGetExtra(DbPage *pPg){
  52813. return pPg->pExtra;
  52814. }
  52815. /*
  52816. ** Get/set the locking-mode for this pager. Parameter eMode must be one
  52817. ** of PAGER_LOCKINGMODE_QUERY, PAGER_LOCKINGMODE_NORMAL or
  52818. ** PAGER_LOCKINGMODE_EXCLUSIVE. If the parameter is not _QUERY, then
  52819. ** the locking-mode is set to the value specified.
  52820. **
  52821. ** The returned value is either PAGER_LOCKINGMODE_NORMAL or
  52822. ** PAGER_LOCKINGMODE_EXCLUSIVE, indicating the current (possibly updated)
  52823. ** locking-mode.
  52824. */
  52825. SQLITE_PRIVATE int sqlite3PagerLockingMode(Pager *pPager, int eMode){
  52826. assert( eMode==PAGER_LOCKINGMODE_QUERY
  52827. || eMode==PAGER_LOCKINGMODE_NORMAL
  52828. || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
  52829. assert( PAGER_LOCKINGMODE_QUERY<0 );
  52830. assert( PAGER_LOCKINGMODE_NORMAL>=0 && PAGER_LOCKINGMODE_EXCLUSIVE>=0 );
  52831. assert( pPager->exclusiveMode || 0==sqlite3WalHeapMemory(pPager->pWal) );
  52832. if( eMode>=0 && !pPager->tempFile && !sqlite3WalHeapMemory(pPager->pWal) ){
  52833. pPager->exclusiveMode = (u8)eMode;
  52834. }
  52835. return (int)pPager->exclusiveMode;
  52836. }
  52837. /*
  52838. ** Set the journal-mode for this pager. Parameter eMode must be one of:
  52839. **
  52840. ** PAGER_JOURNALMODE_DELETE
  52841. ** PAGER_JOURNALMODE_TRUNCATE
  52842. ** PAGER_JOURNALMODE_PERSIST
  52843. ** PAGER_JOURNALMODE_OFF
  52844. ** PAGER_JOURNALMODE_MEMORY
  52845. ** PAGER_JOURNALMODE_WAL
  52846. **
  52847. ** The journalmode is set to the value specified if the change is allowed.
  52848. ** The change may be disallowed for the following reasons:
  52849. **
  52850. ** * An in-memory database can only have its journal_mode set to _OFF
  52851. ** or _MEMORY.
  52852. **
  52853. ** * Temporary databases cannot have _WAL journalmode.
  52854. **
  52855. ** The returned indicate the current (possibly updated) journal-mode.
  52856. */
  52857. SQLITE_PRIVATE int sqlite3PagerSetJournalMode(Pager *pPager, int eMode){
  52858. u8 eOld = pPager->journalMode; /* Prior journalmode */
  52859. #ifdef SQLITE_DEBUG
  52860. /* The print_pager_state() routine is intended to be used by the debugger
  52861. ** only. We invoke it once here to suppress a compiler warning. */
  52862. print_pager_state(pPager);
  52863. #endif
  52864. /* The eMode parameter is always valid */
  52865. assert( eMode==PAGER_JOURNALMODE_DELETE
  52866. || eMode==PAGER_JOURNALMODE_TRUNCATE
  52867. || eMode==PAGER_JOURNALMODE_PERSIST
  52868. || eMode==PAGER_JOURNALMODE_OFF
  52869. || eMode==PAGER_JOURNALMODE_WAL
  52870. || eMode==PAGER_JOURNALMODE_MEMORY );
  52871. /* This routine is only called from the OP_JournalMode opcode, and
  52872. ** the logic there will never allow a temporary file to be changed
  52873. ** to WAL mode.
  52874. */
  52875. assert( pPager->tempFile==0 || eMode!=PAGER_JOURNALMODE_WAL );
  52876. /* Do allow the journalmode of an in-memory database to be set to
  52877. ** anything other than MEMORY or OFF
  52878. */
  52879. if( MEMDB ){
  52880. assert( eOld==PAGER_JOURNALMODE_MEMORY || eOld==PAGER_JOURNALMODE_OFF );
  52881. if( eMode!=PAGER_JOURNALMODE_MEMORY && eMode!=PAGER_JOURNALMODE_OFF ){
  52882. eMode = eOld;
  52883. }
  52884. }
  52885. if( eMode!=eOld ){
  52886. /* Change the journal mode. */
  52887. assert( pPager->eState!=PAGER_ERROR );
  52888. pPager->journalMode = (u8)eMode;
  52889. /* When transistioning from TRUNCATE or PERSIST to any other journal
  52890. ** mode except WAL, unless the pager is in locking_mode=exclusive mode,
  52891. ** delete the journal file.
  52892. */
  52893. assert( (PAGER_JOURNALMODE_TRUNCATE & 5)==1 );
  52894. assert( (PAGER_JOURNALMODE_PERSIST & 5)==1 );
  52895. assert( (PAGER_JOURNALMODE_DELETE & 5)==0 );
  52896. assert( (PAGER_JOURNALMODE_MEMORY & 5)==4 );
  52897. assert( (PAGER_JOURNALMODE_OFF & 5)==0 );
  52898. assert( (PAGER_JOURNALMODE_WAL & 5)==5 );
  52899. assert( isOpen(pPager->fd) || pPager->exclusiveMode );
  52900. if( !pPager->exclusiveMode && (eOld & 5)==1 && (eMode & 1)==0 ){
  52901. /* In this case we would like to delete the journal file. If it is
  52902. ** not possible, then that is not a problem. Deleting the journal file
  52903. ** here is an optimization only.
  52904. **
  52905. ** Before deleting the journal file, obtain a RESERVED lock on the
  52906. ** database file. This ensures that the journal file is not deleted
  52907. ** while it is in use by some other client.
  52908. */
  52909. sqlite3OsClose(pPager->jfd);
  52910. if( pPager->eLock>=RESERVED_LOCK ){
  52911. sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
  52912. }else{
  52913. int rc = SQLITE_OK;
  52914. int state = pPager->eState;
  52915. assert( state==PAGER_OPEN || state==PAGER_READER );
  52916. if( state==PAGER_OPEN ){
  52917. rc = sqlite3PagerSharedLock(pPager);
  52918. }
  52919. if( pPager->eState==PAGER_READER ){
  52920. assert( rc==SQLITE_OK );
  52921. rc = pagerLockDb(pPager, RESERVED_LOCK);
  52922. }
  52923. if( rc==SQLITE_OK ){
  52924. sqlite3OsDelete(pPager->pVfs, pPager->zJournal, 0);
  52925. }
  52926. if( rc==SQLITE_OK && state==PAGER_READER ){
  52927. pagerUnlockDb(pPager, SHARED_LOCK);
  52928. }else if( state==PAGER_OPEN ){
  52929. pager_unlock(pPager);
  52930. }
  52931. assert( state==pPager->eState );
  52932. }
  52933. }else if( eMode==PAGER_JOURNALMODE_OFF ){
  52934. sqlite3OsClose(pPager->jfd);
  52935. }
  52936. }
  52937. /* Return the new journal mode */
  52938. return (int)pPager->journalMode;
  52939. }
  52940. /*
  52941. ** Return the current journal mode.
  52942. */
  52943. SQLITE_PRIVATE int sqlite3PagerGetJournalMode(Pager *pPager){
  52944. return (int)pPager->journalMode;
  52945. }
  52946. /*
  52947. ** Return TRUE if the pager is in a state where it is OK to change the
  52948. ** journalmode. Journalmode changes can only happen when the database
  52949. ** is unmodified.
  52950. */
  52951. SQLITE_PRIVATE int sqlite3PagerOkToChangeJournalMode(Pager *pPager){
  52952. assert( assert_pager_state(pPager) );
  52953. if( pPager->eState>=PAGER_WRITER_CACHEMOD ) return 0;
  52954. if( NEVER(isOpen(pPager->jfd) && pPager->journalOff>0) ) return 0;
  52955. return 1;
  52956. }
  52957. /*
  52958. ** Get/set the size-limit used for persistent journal files.
  52959. **
  52960. ** Setting the size limit to -1 means no limit is enforced.
  52961. ** An attempt to set a limit smaller than -1 is a no-op.
  52962. */
  52963. SQLITE_PRIVATE i64 sqlite3PagerJournalSizeLimit(Pager *pPager, i64 iLimit){
  52964. if( iLimit>=-1 ){
  52965. pPager->journalSizeLimit = iLimit;
  52966. sqlite3WalLimit(pPager->pWal, iLimit);
  52967. }
  52968. return pPager->journalSizeLimit;
  52969. }
  52970. /*
  52971. ** Return a pointer to the pPager->pBackup variable. The backup module
  52972. ** in backup.c maintains the content of this variable. This module
  52973. ** uses it opaquely as an argument to sqlite3BackupRestart() and
  52974. ** sqlite3BackupUpdate() only.
  52975. */
  52976. SQLITE_PRIVATE sqlite3_backup **sqlite3PagerBackupPtr(Pager *pPager){
  52977. return &pPager->pBackup;
  52978. }
  52979. #ifndef SQLITE_OMIT_VACUUM
  52980. /*
  52981. ** Unless this is an in-memory or temporary database, clear the pager cache.
  52982. */
  52983. SQLITE_PRIVATE void sqlite3PagerClearCache(Pager *pPager){
  52984. assert( MEMDB==0 || pPager->tempFile );
  52985. if( pPager->tempFile==0 ) pager_reset(pPager);
  52986. }
  52987. #endif
  52988. #ifndef SQLITE_OMIT_WAL
  52989. /*
  52990. ** This function is called when the user invokes "PRAGMA wal_checkpoint",
  52991. ** "PRAGMA wal_blocking_checkpoint" or calls the sqlite3_wal_checkpoint()
  52992. ** or wal_blocking_checkpoint() API functions.
  52993. **
  52994. ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
  52995. */
  52996. SQLITE_PRIVATE int sqlite3PagerCheckpoint(
  52997. Pager *pPager, /* Checkpoint on this pager */
  52998. sqlite3 *db, /* Db handle used to check for interrupts */
  52999. int eMode, /* Type of checkpoint */
  53000. int *pnLog, /* OUT: Final number of frames in log */
  53001. int *pnCkpt /* OUT: Final number of checkpointed frames */
  53002. ){
  53003. int rc = SQLITE_OK;
  53004. if( pPager->pWal ){
  53005. rc = sqlite3WalCheckpoint(pPager->pWal, db, eMode,
  53006. (eMode==SQLITE_CHECKPOINT_PASSIVE ? 0 : pPager->xBusyHandler),
  53007. pPager->pBusyHandlerArg,
  53008. pPager->walSyncFlags, pPager->pageSize, (u8 *)pPager->pTmpSpace,
  53009. pnLog, pnCkpt
  53010. );
  53011. sqlite3PagerResetLockTimeout(pPager);
  53012. }
  53013. return rc;
  53014. }
  53015. SQLITE_PRIVATE int sqlite3PagerWalCallback(Pager *pPager){
  53016. return sqlite3WalCallback(pPager->pWal);
  53017. }
  53018. /*
  53019. ** Return true if the underlying VFS for the given pager supports the
  53020. ** primitives necessary for write-ahead logging.
  53021. */
  53022. SQLITE_PRIVATE int sqlite3PagerWalSupported(Pager *pPager){
  53023. const sqlite3_io_methods *pMethods = pPager->fd->pMethods;
  53024. if( pPager->noLock ) return 0;
  53025. return pPager->exclusiveMode || (pMethods->iVersion>=2 && pMethods->xShmMap);
  53026. }
  53027. /*
  53028. ** Attempt to take an exclusive lock on the database file. If a PENDING lock
  53029. ** is obtained instead, immediately release it.
  53030. */
  53031. static int pagerExclusiveLock(Pager *pPager){
  53032. int rc; /* Return code */
  53033. assert( pPager->eLock==SHARED_LOCK || pPager->eLock==EXCLUSIVE_LOCK );
  53034. rc = pagerLockDb(pPager, EXCLUSIVE_LOCK);
  53035. if( rc!=SQLITE_OK ){
  53036. /* If the attempt to grab the exclusive lock failed, release the
  53037. ** pending lock that may have been obtained instead. */
  53038. pagerUnlockDb(pPager, SHARED_LOCK);
  53039. }
  53040. return rc;
  53041. }
  53042. /*
  53043. ** Call sqlite3WalOpen() to open the WAL handle. If the pager is in
  53044. ** exclusive-locking mode when this function is called, take an EXCLUSIVE
  53045. ** lock on the database file and use heap-memory to store the wal-index
  53046. ** in. Otherwise, use the normal shared-memory.
  53047. */
  53048. static int pagerOpenWal(Pager *pPager){
  53049. int rc = SQLITE_OK;
  53050. assert( pPager->pWal==0 && pPager->tempFile==0 );
  53051. assert( pPager->eLock==SHARED_LOCK || pPager->eLock==EXCLUSIVE_LOCK );
  53052. /* If the pager is already in exclusive-mode, the WAL module will use
  53053. ** heap-memory for the wal-index instead of the VFS shared-memory
  53054. ** implementation. Take the exclusive lock now, before opening the WAL
  53055. ** file, to make sure this is safe.
  53056. */
  53057. if( pPager->exclusiveMode ){
  53058. rc = pagerExclusiveLock(pPager);
  53059. }
  53060. /* Open the connection to the log file. If this operation fails,
  53061. ** (e.g. due to malloc() failure), return an error code.
  53062. */
  53063. if( rc==SQLITE_OK ){
  53064. rc = sqlite3WalOpen(pPager->pVfs,
  53065. pPager->fd, pPager->zWal, pPager->exclusiveMode,
  53066. pPager->journalSizeLimit, &pPager->pWal
  53067. );
  53068. }
  53069. pagerFixMaplimit(pPager);
  53070. return rc;
  53071. }
  53072. /*
  53073. ** The caller must be holding a SHARED lock on the database file to call
  53074. ** this function.
  53075. **
  53076. ** If the pager passed as the first argument is open on a real database
  53077. ** file (not a temp file or an in-memory database), and the WAL file
  53078. ** is not already open, make an attempt to open it now. If successful,
  53079. ** return SQLITE_OK. If an error occurs or the VFS used by the pager does
  53080. ** not support the xShmXXX() methods, return an error code. *pbOpen is
  53081. ** not modified in either case.
  53082. **
  53083. ** If the pager is open on a temp-file (or in-memory database), or if
  53084. ** the WAL file is already open, set *pbOpen to 1 and return SQLITE_OK
  53085. ** without doing anything.
  53086. */
  53087. SQLITE_PRIVATE int sqlite3PagerOpenWal(
  53088. Pager *pPager, /* Pager object */
  53089. int *pbOpen /* OUT: Set to true if call is a no-op */
  53090. ){
  53091. int rc = SQLITE_OK; /* Return code */
  53092. assert( assert_pager_state(pPager) );
  53093. assert( pPager->eState==PAGER_OPEN || pbOpen );
  53094. assert( pPager->eState==PAGER_READER || !pbOpen );
  53095. assert( pbOpen==0 || *pbOpen==0 );
  53096. assert( pbOpen!=0 || (!pPager->tempFile && !pPager->pWal) );
  53097. if( !pPager->tempFile && !pPager->pWal ){
  53098. if( !sqlite3PagerWalSupported(pPager) ) return SQLITE_CANTOPEN;
  53099. /* Close any rollback journal previously open */
  53100. sqlite3OsClose(pPager->jfd);
  53101. rc = pagerOpenWal(pPager);
  53102. if( rc==SQLITE_OK ){
  53103. pPager->journalMode = PAGER_JOURNALMODE_WAL;
  53104. pPager->eState = PAGER_OPEN;
  53105. }
  53106. }else{
  53107. *pbOpen = 1;
  53108. }
  53109. return rc;
  53110. }
  53111. /*
  53112. ** This function is called to close the connection to the log file prior
  53113. ** to switching from WAL to rollback mode.
  53114. **
  53115. ** Before closing the log file, this function attempts to take an
  53116. ** EXCLUSIVE lock on the database file. If this cannot be obtained, an
  53117. ** error (SQLITE_BUSY) is returned and the log connection is not closed.
  53118. ** If successful, the EXCLUSIVE lock is not released before returning.
  53119. */
  53120. SQLITE_PRIVATE int sqlite3PagerCloseWal(Pager *pPager, sqlite3 *db){
  53121. int rc = SQLITE_OK;
  53122. assert( pPager->journalMode==PAGER_JOURNALMODE_WAL );
  53123. /* If the log file is not already open, but does exist in the file-system,
  53124. ** it may need to be checkpointed before the connection can switch to
  53125. ** rollback mode. Open it now so this can happen.
  53126. */
  53127. if( !pPager->pWal ){
  53128. int logexists = 0;
  53129. rc = pagerLockDb(pPager, SHARED_LOCK);
  53130. if( rc==SQLITE_OK ){
  53131. rc = sqlite3OsAccess(
  53132. pPager->pVfs, pPager->zWal, SQLITE_ACCESS_EXISTS, &logexists
  53133. );
  53134. }
  53135. if( rc==SQLITE_OK && logexists ){
  53136. rc = pagerOpenWal(pPager);
  53137. }
  53138. }
  53139. /* Checkpoint and close the log. Because an EXCLUSIVE lock is held on
  53140. ** the database file, the log and log-summary files will be deleted.
  53141. */
  53142. if( rc==SQLITE_OK && pPager->pWal ){
  53143. rc = pagerExclusiveLock(pPager);
  53144. if( rc==SQLITE_OK ){
  53145. rc = sqlite3WalClose(pPager->pWal, db, pPager->walSyncFlags,
  53146. pPager->pageSize, (u8*)pPager->pTmpSpace);
  53147. pPager->pWal = 0;
  53148. pagerFixMaplimit(pPager);
  53149. if( rc && !pPager->exclusiveMode ) pagerUnlockDb(pPager, SHARED_LOCK);
  53150. }
  53151. }
  53152. return rc;
  53153. }
  53154. #ifdef SQLITE_ENABLE_SNAPSHOT
  53155. /*
  53156. ** If this is a WAL database, obtain a snapshot handle for the snapshot
  53157. ** currently open. Otherwise, return an error.
  53158. */
  53159. SQLITE_PRIVATE int sqlite3PagerSnapshotGet(Pager *pPager, sqlite3_snapshot **ppSnapshot){
  53160. int rc = SQLITE_ERROR;
  53161. if( pPager->pWal ){
  53162. rc = sqlite3WalSnapshotGet(pPager->pWal, ppSnapshot);
  53163. }
  53164. return rc;
  53165. }
  53166. /*
  53167. ** If this is a WAL database, store a pointer to pSnapshot. Next time a
  53168. ** read transaction is opened, attempt to read from the snapshot it
  53169. ** identifies. If this is not a WAL database, return an error.
  53170. */
  53171. SQLITE_PRIVATE int sqlite3PagerSnapshotOpen(Pager *pPager, sqlite3_snapshot *pSnapshot){
  53172. int rc = SQLITE_OK;
  53173. if( pPager->pWal ){
  53174. sqlite3WalSnapshotOpen(pPager->pWal, pSnapshot);
  53175. }else{
  53176. rc = SQLITE_ERROR;
  53177. }
  53178. return rc;
  53179. }
  53180. /*
  53181. ** If this is a WAL database, call sqlite3WalSnapshotRecover(). If this
  53182. ** is not a WAL database, return an error.
  53183. */
  53184. SQLITE_PRIVATE int sqlite3PagerSnapshotRecover(Pager *pPager){
  53185. int rc;
  53186. if( pPager->pWal ){
  53187. rc = sqlite3WalSnapshotRecover(pPager->pWal);
  53188. }else{
  53189. rc = SQLITE_ERROR;
  53190. }
  53191. return rc;
  53192. }
  53193. #endif /* SQLITE_ENABLE_SNAPSHOT */
  53194. #endif /* !SQLITE_OMIT_WAL */
  53195. #ifdef SQLITE_ENABLE_ZIPVFS
  53196. /*
  53197. ** A read-lock must be held on the pager when this function is called. If
  53198. ** the pager is in WAL mode and the WAL file currently contains one or more
  53199. ** frames, return the size in bytes of the page images stored within the
  53200. ** WAL frames. Otherwise, if this is not a WAL database or the WAL file
  53201. ** is empty, return 0.
  53202. */
  53203. SQLITE_PRIVATE int sqlite3PagerWalFramesize(Pager *pPager){
  53204. assert( pPager->eState>=PAGER_READER );
  53205. return sqlite3WalFramesize(pPager->pWal);
  53206. }
  53207. #endif
  53208. #endif /* SQLITE_OMIT_DISKIO */
  53209. /************** End of pager.c ***********************************************/
  53210. /************** Begin file wal.c *********************************************/
  53211. /*
  53212. ** 2010 February 1
  53213. **
  53214. ** The author disclaims copyright to this source code. In place of
  53215. ** a legal notice, here is a blessing:
  53216. **
  53217. ** May you do good and not evil.
  53218. ** May you find forgiveness for yourself and forgive others.
  53219. ** May you share freely, never taking more than you give.
  53220. **
  53221. *************************************************************************
  53222. **
  53223. ** This file contains the implementation of a write-ahead log (WAL) used in
  53224. ** "journal_mode=WAL" mode.
  53225. **
  53226. ** WRITE-AHEAD LOG (WAL) FILE FORMAT
  53227. **
  53228. ** A WAL file consists of a header followed by zero or more "frames".
  53229. ** Each frame records the revised content of a single page from the
  53230. ** database file. All changes to the database are recorded by writing
  53231. ** frames into the WAL. Transactions commit when a frame is written that
  53232. ** contains a commit marker. A single WAL can and usually does record
  53233. ** multiple transactions. Periodically, the content of the WAL is
  53234. ** transferred back into the database file in an operation called a
  53235. ** "checkpoint".
  53236. **
  53237. ** A single WAL file can be used multiple times. In other words, the
  53238. ** WAL can fill up with frames and then be checkpointed and then new
  53239. ** frames can overwrite the old ones. A WAL always grows from beginning
  53240. ** toward the end. Checksums and counters attached to each frame are
  53241. ** used to determine which frames within the WAL are valid and which
  53242. ** are leftovers from prior checkpoints.
  53243. **
  53244. ** The WAL header is 32 bytes in size and consists of the following eight
  53245. ** big-endian 32-bit unsigned integer values:
  53246. **
  53247. ** 0: Magic number. 0x377f0682 or 0x377f0683
  53248. ** 4: File format version. Currently 3007000
  53249. ** 8: Database page size. Example: 1024
  53250. ** 12: Checkpoint sequence number
  53251. ** 16: Salt-1, random integer incremented with each checkpoint
  53252. ** 20: Salt-2, a different random integer changing with each ckpt
  53253. ** 24: Checksum-1 (first part of checksum for first 24 bytes of header).
  53254. ** 28: Checksum-2 (second part of checksum for first 24 bytes of header).
  53255. **
  53256. ** Immediately following the wal-header are zero or more frames. Each
  53257. ** frame consists of a 24-byte frame-header followed by a <page-size> bytes
  53258. ** of page data. The frame-header is six big-endian 32-bit unsigned
  53259. ** integer values, as follows:
  53260. **
  53261. ** 0: Page number.
  53262. ** 4: For commit records, the size of the database image in pages
  53263. ** after the commit. For all other records, zero.
  53264. ** 8: Salt-1 (copied from the header)
  53265. ** 12: Salt-2 (copied from the header)
  53266. ** 16: Checksum-1.
  53267. ** 20: Checksum-2.
  53268. **
  53269. ** A frame is considered valid if and only if the following conditions are
  53270. ** true:
  53271. **
  53272. ** (1) The salt-1 and salt-2 values in the frame-header match
  53273. ** salt values in the wal-header
  53274. **
  53275. ** (2) The checksum values in the final 8 bytes of the frame-header
  53276. ** exactly match the checksum computed consecutively on the
  53277. ** WAL header and the first 8 bytes and the content of all frames
  53278. ** up to and including the current frame.
  53279. **
  53280. ** The checksum is computed using 32-bit big-endian integers if the
  53281. ** magic number in the first 4 bytes of the WAL is 0x377f0683 and it
  53282. ** is computed using little-endian if the magic number is 0x377f0682.
  53283. ** The checksum values are always stored in the frame header in a
  53284. ** big-endian format regardless of which byte order is used to compute
  53285. ** the checksum. The checksum is computed by interpreting the input as
  53286. ** an even number of unsigned 32-bit integers: x[0] through x[N]. The
  53287. ** algorithm used for the checksum is as follows:
  53288. **
  53289. ** for i from 0 to n-1 step 2:
  53290. ** s0 += x[i] + s1;
  53291. ** s1 += x[i+1] + s0;
  53292. ** endfor
  53293. **
  53294. ** Note that s0 and s1 are both weighted checksums using fibonacci weights
  53295. ** in reverse order (the largest fibonacci weight occurs on the first element
  53296. ** of the sequence being summed.) The s1 value spans all 32-bit
  53297. ** terms of the sequence whereas s0 omits the final term.
  53298. **
  53299. ** On a checkpoint, the WAL is first VFS.xSync-ed, then valid content of the
  53300. ** WAL is transferred into the database, then the database is VFS.xSync-ed.
  53301. ** The VFS.xSync operations serve as write barriers - all writes launched
  53302. ** before the xSync must complete before any write that launches after the
  53303. ** xSync begins.
  53304. **
  53305. ** After each checkpoint, the salt-1 value is incremented and the salt-2
  53306. ** value is randomized. This prevents old and new frames in the WAL from
  53307. ** being considered valid at the same time and being checkpointing together
  53308. ** following a crash.
  53309. **
  53310. ** READER ALGORITHM
  53311. **
  53312. ** To read a page from the database (call it page number P), a reader
  53313. ** first checks the WAL to see if it contains page P. If so, then the
  53314. ** last valid instance of page P that is a followed by a commit frame
  53315. ** or is a commit frame itself becomes the value read. If the WAL
  53316. ** contains no copies of page P that are valid and which are a commit
  53317. ** frame or are followed by a commit frame, then page P is read from
  53318. ** the database file.
  53319. **
  53320. ** To start a read transaction, the reader records the index of the last
  53321. ** valid frame in the WAL. The reader uses this recorded "mxFrame" value
  53322. ** for all subsequent read operations. New transactions can be appended
  53323. ** to the WAL, but as long as the reader uses its original mxFrame value
  53324. ** and ignores the newly appended content, it will see a consistent snapshot
  53325. ** of the database from a single point in time. This technique allows
  53326. ** multiple concurrent readers to view different versions of the database
  53327. ** content simultaneously.
  53328. **
  53329. ** The reader algorithm in the previous paragraphs works correctly, but
  53330. ** because frames for page P can appear anywhere within the WAL, the
  53331. ** reader has to scan the entire WAL looking for page P frames. If the
  53332. ** WAL is large (multiple megabytes is typical) that scan can be slow,
  53333. ** and read performance suffers. To overcome this problem, a separate
  53334. ** data structure called the wal-index is maintained to expedite the
  53335. ** search for frames of a particular page.
  53336. **
  53337. ** WAL-INDEX FORMAT
  53338. **
  53339. ** Conceptually, the wal-index is shared memory, though VFS implementations
  53340. ** might choose to implement the wal-index using a mmapped file. Because
  53341. ** the wal-index is shared memory, SQLite does not support journal_mode=WAL
  53342. ** on a network filesystem. All users of the database must be able to
  53343. ** share memory.
  53344. **
  53345. ** In the default unix and windows implementation, the wal-index is a mmapped
  53346. ** file whose name is the database name with a "-shm" suffix added. For that
  53347. ** reason, the wal-index is sometimes called the "shm" file.
  53348. **
  53349. ** The wal-index is transient. After a crash, the wal-index can (and should
  53350. ** be) reconstructed from the original WAL file. In fact, the VFS is required
  53351. ** to either truncate or zero the header of the wal-index when the last
  53352. ** connection to it closes. Because the wal-index is transient, it can
  53353. ** use an architecture-specific format; it does not have to be cross-platform.
  53354. ** Hence, unlike the database and WAL file formats which store all values
  53355. ** as big endian, the wal-index can store multi-byte values in the native
  53356. ** byte order of the host computer.
  53357. **
  53358. ** The purpose of the wal-index is to answer this question quickly: Given
  53359. ** a page number P and a maximum frame index M, return the index of the
  53360. ** last frame in the wal before frame M for page P in the WAL, or return
  53361. ** NULL if there are no frames for page P in the WAL prior to M.
  53362. **
  53363. ** The wal-index consists of a header region, followed by an one or
  53364. ** more index blocks.
  53365. **
  53366. ** The wal-index header contains the total number of frames within the WAL
  53367. ** in the mxFrame field.
  53368. **
  53369. ** Each index block except for the first contains information on
  53370. ** HASHTABLE_NPAGE frames. The first index block contains information on
  53371. ** HASHTABLE_NPAGE_ONE frames. The values of HASHTABLE_NPAGE_ONE and
  53372. ** HASHTABLE_NPAGE are selected so that together the wal-index header and
  53373. ** first index block are the same size as all other index blocks in the
  53374. ** wal-index.
  53375. **
  53376. ** Each index block contains two sections, a page-mapping that contains the
  53377. ** database page number associated with each wal frame, and a hash-table
  53378. ** that allows readers to query an index block for a specific page number.
  53379. ** The page-mapping is an array of HASHTABLE_NPAGE (or HASHTABLE_NPAGE_ONE
  53380. ** for the first index block) 32-bit page numbers. The first entry in the
  53381. ** first index-block contains the database page number corresponding to the
  53382. ** first frame in the WAL file. The first entry in the second index block
  53383. ** in the WAL file corresponds to the (HASHTABLE_NPAGE_ONE+1)th frame in
  53384. ** the log, and so on.
  53385. **
  53386. ** The last index block in a wal-index usually contains less than the full
  53387. ** complement of HASHTABLE_NPAGE (or HASHTABLE_NPAGE_ONE) page-numbers,
  53388. ** depending on the contents of the WAL file. This does not change the
  53389. ** allocated size of the page-mapping array - the page-mapping array merely
  53390. ** contains unused entries.
  53391. **
  53392. ** Even without using the hash table, the last frame for page P
  53393. ** can be found by scanning the page-mapping sections of each index block
  53394. ** starting with the last index block and moving toward the first, and
  53395. ** within each index block, starting at the end and moving toward the
  53396. ** beginning. The first entry that equals P corresponds to the frame
  53397. ** holding the content for that page.
  53398. **
  53399. ** The hash table consists of HASHTABLE_NSLOT 16-bit unsigned integers.
  53400. ** HASHTABLE_NSLOT = 2*HASHTABLE_NPAGE, and there is one entry in the
  53401. ** hash table for each page number in the mapping section, so the hash
  53402. ** table is never more than half full. The expected number of collisions
  53403. ** prior to finding a match is 1. Each entry of the hash table is an
  53404. ** 1-based index of an entry in the mapping section of the same
  53405. ** index block. Let K be the 1-based index of the largest entry in
  53406. ** the mapping section. (For index blocks other than the last, K will
  53407. ** always be exactly HASHTABLE_NPAGE (4096) and for the last index block
  53408. ** K will be (mxFrame%HASHTABLE_NPAGE).) Unused slots of the hash table
  53409. ** contain a value of 0.
  53410. **
  53411. ** To look for page P in the hash table, first compute a hash iKey on
  53412. ** P as follows:
  53413. **
  53414. ** iKey = (P * 383) % HASHTABLE_NSLOT
  53415. **
  53416. ** Then start scanning entries of the hash table, starting with iKey
  53417. ** (wrapping around to the beginning when the end of the hash table is
  53418. ** reached) until an unused hash slot is found. Let the first unused slot
  53419. ** be at index iUnused. (iUnused might be less than iKey if there was
  53420. ** wrap-around.) Because the hash table is never more than half full,
  53421. ** the search is guaranteed to eventually hit an unused entry. Let
  53422. ** iMax be the value between iKey and iUnused, closest to iUnused,
  53423. ** where aHash[iMax]==P. If there is no iMax entry (if there exists
  53424. ** no hash slot such that aHash[i]==p) then page P is not in the
  53425. ** current index block. Otherwise the iMax-th mapping entry of the
  53426. ** current index block corresponds to the last entry that references
  53427. ** page P.
  53428. **
  53429. ** A hash search begins with the last index block and moves toward the
  53430. ** first index block, looking for entries corresponding to page P. On
  53431. ** average, only two or three slots in each index block need to be
  53432. ** examined in order to either find the last entry for page P, or to
  53433. ** establish that no such entry exists in the block. Each index block
  53434. ** holds over 4000 entries. So two or three index blocks are sufficient
  53435. ** to cover a typical 10 megabyte WAL file, assuming 1K pages. 8 or 10
  53436. ** comparisons (on average) suffice to either locate a frame in the
  53437. ** WAL or to establish that the frame does not exist in the WAL. This
  53438. ** is much faster than scanning the entire 10MB WAL.
  53439. **
  53440. ** Note that entries are added in order of increasing K. Hence, one
  53441. ** reader might be using some value K0 and a second reader that started
  53442. ** at a later time (after additional transactions were added to the WAL
  53443. ** and to the wal-index) might be using a different value K1, where K1>K0.
  53444. ** Both readers can use the same hash table and mapping section to get
  53445. ** the correct result. There may be entries in the hash table with
  53446. ** K>K0 but to the first reader, those entries will appear to be unused
  53447. ** slots in the hash table and so the first reader will get an answer as
  53448. ** if no values greater than K0 had ever been inserted into the hash table
  53449. ** in the first place - which is what reader one wants. Meanwhile, the
  53450. ** second reader using K1 will see additional values that were inserted
  53451. ** later, which is exactly what reader two wants.
  53452. **
  53453. ** When a rollback occurs, the value of K is decreased. Hash table entries
  53454. ** that correspond to frames greater than the new K value are removed
  53455. ** from the hash table at this point.
  53456. */
  53457. #ifndef SQLITE_OMIT_WAL
  53458. /* #include "wal.h" */
  53459. /*
  53460. ** Trace output macros
  53461. */
  53462. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  53463. SQLITE_PRIVATE int sqlite3WalTrace = 0;
  53464. # define WALTRACE(X) if(sqlite3WalTrace) sqlite3DebugPrintf X
  53465. #else
  53466. # define WALTRACE(X)
  53467. #endif
  53468. /*
  53469. ** The maximum (and only) versions of the wal and wal-index formats
  53470. ** that may be interpreted by this version of SQLite.
  53471. **
  53472. ** If a client begins recovering a WAL file and finds that (a) the checksum
  53473. ** values in the wal-header are correct and (b) the version field is not
  53474. ** WAL_MAX_VERSION, recovery fails and SQLite returns SQLITE_CANTOPEN.
  53475. **
  53476. ** Similarly, if a client successfully reads a wal-index header (i.e. the
  53477. ** checksum test is successful) and finds that the version field is not
  53478. ** WALINDEX_MAX_VERSION, then no read-transaction is opened and SQLite
  53479. ** returns SQLITE_CANTOPEN.
  53480. */
  53481. #define WAL_MAX_VERSION 3007000
  53482. #define WALINDEX_MAX_VERSION 3007000
  53483. /*
  53484. ** Index numbers for various locking bytes. WAL_NREADER is the number
  53485. ** of available reader locks and should be at least 3. The default
  53486. ** is SQLITE_SHM_NLOCK==8 and WAL_NREADER==5.
  53487. **
  53488. ** Technically, the various VFSes are free to implement these locks however
  53489. ** they see fit. However, compatibility is encouraged so that VFSes can
  53490. ** interoperate. The standard implemention used on both unix and windows
  53491. ** is for the index number to indicate a byte offset into the
  53492. ** WalCkptInfo.aLock[] array in the wal-index header. In other words, all
  53493. ** locks are on the shm file. The WALINDEX_LOCK_OFFSET constant (which
  53494. ** should be 120) is the location in the shm file for the first locking
  53495. ** byte.
  53496. */
  53497. #define WAL_WRITE_LOCK 0
  53498. #define WAL_ALL_BUT_WRITE 1
  53499. #define WAL_CKPT_LOCK 1
  53500. #define WAL_RECOVER_LOCK 2
  53501. #define WAL_READ_LOCK(I) (3+(I))
  53502. #define WAL_NREADER (SQLITE_SHM_NLOCK-3)
  53503. /* Object declarations */
  53504. typedef struct WalIndexHdr WalIndexHdr;
  53505. typedef struct WalIterator WalIterator;
  53506. typedef struct WalCkptInfo WalCkptInfo;
  53507. /*
  53508. ** The following object holds a copy of the wal-index header content.
  53509. **
  53510. ** The actual header in the wal-index consists of two copies of this
  53511. ** object followed by one instance of the WalCkptInfo object.
  53512. ** For all versions of SQLite through 3.10.0 and probably beyond,
  53513. ** the locking bytes (WalCkptInfo.aLock) start at offset 120 and
  53514. ** the total header size is 136 bytes.
  53515. **
  53516. ** The szPage value can be any power of 2 between 512 and 32768, inclusive.
  53517. ** Or it can be 1 to represent a 65536-byte page. The latter case was
  53518. ** added in 3.7.1 when support for 64K pages was added.
  53519. */
  53520. struct WalIndexHdr {
  53521. u32 iVersion; /* Wal-index version */
  53522. u32 unused; /* Unused (padding) field */
  53523. u32 iChange; /* Counter incremented each transaction */
  53524. u8 isInit; /* 1 when initialized */
  53525. u8 bigEndCksum; /* True if checksums in WAL are big-endian */
  53526. u16 szPage; /* Database page size in bytes. 1==64K */
  53527. u32 mxFrame; /* Index of last valid frame in the WAL */
  53528. u32 nPage; /* Size of database in pages */
  53529. u32 aFrameCksum[2]; /* Checksum of last frame in log */
  53530. u32 aSalt[2]; /* Two salt values copied from WAL header */
  53531. u32 aCksum[2]; /* Checksum over all prior fields */
  53532. };
  53533. /*
  53534. ** A copy of the following object occurs in the wal-index immediately
  53535. ** following the second copy of the WalIndexHdr. This object stores
  53536. ** information used by checkpoint.
  53537. **
  53538. ** nBackfill is the number of frames in the WAL that have been written
  53539. ** back into the database. (We call the act of moving content from WAL to
  53540. ** database "backfilling".) The nBackfill number is never greater than
  53541. ** WalIndexHdr.mxFrame. nBackfill can only be increased by threads
  53542. ** holding the WAL_CKPT_LOCK lock (which includes a recovery thread).
  53543. ** However, a WAL_WRITE_LOCK thread can move the value of nBackfill from
  53544. ** mxFrame back to zero when the WAL is reset.
  53545. **
  53546. ** nBackfillAttempted is the largest value of nBackfill that a checkpoint
  53547. ** has attempted to achieve. Normally nBackfill==nBackfillAtempted, however
  53548. ** the nBackfillAttempted is set before any backfilling is done and the
  53549. ** nBackfill is only set after all backfilling completes. So if a checkpoint
  53550. ** crashes, nBackfillAttempted might be larger than nBackfill. The
  53551. ** WalIndexHdr.mxFrame must never be less than nBackfillAttempted.
  53552. **
  53553. ** The aLock[] field is a set of bytes used for locking. These bytes should
  53554. ** never be read or written.
  53555. **
  53556. ** There is one entry in aReadMark[] for each reader lock. If a reader
  53557. ** holds read-lock K, then the value in aReadMark[K] is no greater than
  53558. ** the mxFrame for that reader. The value READMARK_NOT_USED (0xffffffff)
  53559. ** for any aReadMark[] means that entry is unused. aReadMark[0] is
  53560. ** a special case; its value is never used and it exists as a place-holder
  53561. ** to avoid having to offset aReadMark[] indexs by one. Readers holding
  53562. ** WAL_READ_LOCK(0) always ignore the entire WAL and read all content
  53563. ** directly from the database.
  53564. **
  53565. ** The value of aReadMark[K] may only be changed by a thread that
  53566. ** is holding an exclusive lock on WAL_READ_LOCK(K). Thus, the value of
  53567. ** aReadMark[K] cannot changed while there is a reader is using that mark
  53568. ** since the reader will be holding a shared lock on WAL_READ_LOCK(K).
  53569. **
  53570. ** The checkpointer may only transfer frames from WAL to database where
  53571. ** the frame numbers are less than or equal to every aReadMark[] that is
  53572. ** in use (that is, every aReadMark[j] for which there is a corresponding
  53573. ** WAL_READ_LOCK(j)). New readers (usually) pick the aReadMark[] with the
  53574. ** largest value and will increase an unused aReadMark[] to mxFrame if there
  53575. ** is not already an aReadMark[] equal to mxFrame. The exception to the
  53576. ** previous sentence is when nBackfill equals mxFrame (meaning that everything
  53577. ** in the WAL has been backfilled into the database) then new readers
  53578. ** will choose aReadMark[0] which has value 0 and hence such reader will
  53579. ** get all their all content directly from the database file and ignore
  53580. ** the WAL.
  53581. **
  53582. ** Writers normally append new frames to the end of the WAL. However,
  53583. ** if nBackfill equals mxFrame (meaning that all WAL content has been
  53584. ** written back into the database) and if no readers are using the WAL
  53585. ** (in other words, if there are no WAL_READ_LOCK(i) where i>0) then
  53586. ** the writer will first "reset" the WAL back to the beginning and start
  53587. ** writing new content beginning at frame 1.
  53588. **
  53589. ** We assume that 32-bit loads are atomic and so no locks are needed in
  53590. ** order to read from any aReadMark[] entries.
  53591. */
  53592. struct WalCkptInfo {
  53593. u32 nBackfill; /* Number of WAL frames backfilled into DB */
  53594. u32 aReadMark[WAL_NREADER]; /* Reader marks */
  53595. u8 aLock[SQLITE_SHM_NLOCK]; /* Reserved space for locks */
  53596. u32 nBackfillAttempted; /* WAL frames perhaps written, or maybe not */
  53597. u32 notUsed0; /* Available for future enhancements */
  53598. };
  53599. #define READMARK_NOT_USED 0xffffffff
  53600. /* A block of WALINDEX_LOCK_RESERVED bytes beginning at
  53601. ** WALINDEX_LOCK_OFFSET is reserved for locks. Since some systems
  53602. ** only support mandatory file-locks, we do not read or write data
  53603. ** from the region of the file on which locks are applied.
  53604. */
  53605. #define WALINDEX_LOCK_OFFSET (sizeof(WalIndexHdr)*2+offsetof(WalCkptInfo,aLock))
  53606. #define WALINDEX_HDR_SIZE (sizeof(WalIndexHdr)*2+sizeof(WalCkptInfo))
  53607. /* Size of header before each frame in wal */
  53608. #define WAL_FRAME_HDRSIZE 24
  53609. /* Size of write ahead log header, including checksum. */
  53610. #define WAL_HDRSIZE 32
  53611. /* WAL magic value. Either this value, or the same value with the least
  53612. ** significant bit also set (WAL_MAGIC | 0x00000001) is stored in 32-bit
  53613. ** big-endian format in the first 4 bytes of a WAL file.
  53614. **
  53615. ** If the LSB is set, then the checksums for each frame within the WAL
  53616. ** file are calculated by treating all data as an array of 32-bit
  53617. ** big-endian words. Otherwise, they are calculated by interpreting
  53618. ** all data as 32-bit little-endian words.
  53619. */
  53620. #define WAL_MAGIC 0x377f0682
  53621. /*
  53622. ** Return the offset of frame iFrame in the write-ahead log file,
  53623. ** assuming a database page size of szPage bytes. The offset returned
  53624. ** is to the start of the write-ahead log frame-header.
  53625. */
  53626. #define walFrameOffset(iFrame, szPage) ( \
  53627. WAL_HDRSIZE + ((iFrame)-1)*(i64)((szPage)+WAL_FRAME_HDRSIZE) \
  53628. )
  53629. /*
  53630. ** An open write-ahead log file is represented by an instance of the
  53631. ** following object.
  53632. */
  53633. struct Wal {
  53634. sqlite3_vfs *pVfs; /* The VFS used to create pDbFd */
  53635. sqlite3_file *pDbFd; /* File handle for the database file */
  53636. sqlite3_file *pWalFd; /* File handle for WAL file */
  53637. u32 iCallback; /* Value to pass to log callback (or 0) */
  53638. i64 mxWalSize; /* Truncate WAL to this size upon reset */
  53639. int nWiData; /* Size of array apWiData */
  53640. int szFirstBlock; /* Size of first block written to WAL file */
  53641. volatile u32 **apWiData; /* Pointer to wal-index content in memory */
  53642. u32 szPage; /* Database page size */
  53643. i16 readLock; /* Which read lock is being held. -1 for none */
  53644. u8 syncFlags; /* Flags to use to sync header writes */
  53645. u8 exclusiveMode; /* Non-zero if connection is in exclusive mode */
  53646. u8 writeLock; /* True if in a write transaction */
  53647. u8 ckptLock; /* True if holding a checkpoint lock */
  53648. u8 readOnly; /* WAL_RDWR, WAL_RDONLY, or WAL_SHM_RDONLY */
  53649. u8 truncateOnCommit; /* True to truncate WAL file on commit */
  53650. u8 syncHeader; /* Fsync the WAL header if true */
  53651. u8 padToSectorBoundary; /* Pad transactions out to the next sector */
  53652. u8 bShmUnreliable; /* SHM content is read-only and unreliable */
  53653. WalIndexHdr hdr; /* Wal-index header for current transaction */
  53654. u32 minFrame; /* Ignore wal frames before this one */
  53655. u32 iReCksum; /* On commit, recalculate checksums from here */
  53656. const char *zWalName; /* Name of WAL file */
  53657. u32 nCkpt; /* Checkpoint sequence counter in the wal-header */
  53658. #ifdef SQLITE_DEBUG
  53659. u8 lockError; /* True if a locking error has occurred */
  53660. #endif
  53661. #ifdef SQLITE_ENABLE_SNAPSHOT
  53662. WalIndexHdr *pSnapshot; /* Start transaction here if not NULL */
  53663. #endif
  53664. };
  53665. /*
  53666. ** Candidate values for Wal.exclusiveMode.
  53667. */
  53668. #define WAL_NORMAL_MODE 0
  53669. #define WAL_EXCLUSIVE_MODE 1
  53670. #define WAL_HEAPMEMORY_MODE 2
  53671. /*
  53672. ** Possible values for WAL.readOnly
  53673. */
  53674. #define WAL_RDWR 0 /* Normal read/write connection */
  53675. #define WAL_RDONLY 1 /* The WAL file is readonly */
  53676. #define WAL_SHM_RDONLY 2 /* The SHM file is readonly */
  53677. /*
  53678. ** Each page of the wal-index mapping contains a hash-table made up of
  53679. ** an array of HASHTABLE_NSLOT elements of the following type.
  53680. */
  53681. typedef u16 ht_slot;
  53682. /*
  53683. ** This structure is used to implement an iterator that loops through
  53684. ** all frames in the WAL in database page order. Where two or more frames
  53685. ** correspond to the same database page, the iterator visits only the
  53686. ** frame most recently written to the WAL (in other words, the frame with
  53687. ** the largest index).
  53688. **
  53689. ** The internals of this structure are only accessed by:
  53690. **
  53691. ** walIteratorInit() - Create a new iterator,
  53692. ** walIteratorNext() - Step an iterator,
  53693. ** walIteratorFree() - Free an iterator.
  53694. **
  53695. ** This functionality is used by the checkpoint code (see walCheckpoint()).
  53696. */
  53697. struct WalIterator {
  53698. int iPrior; /* Last result returned from the iterator */
  53699. int nSegment; /* Number of entries in aSegment[] */
  53700. struct WalSegment {
  53701. int iNext; /* Next slot in aIndex[] not yet returned */
  53702. ht_slot *aIndex; /* i0, i1, i2... such that aPgno[iN] ascend */
  53703. u32 *aPgno; /* Array of page numbers. */
  53704. int nEntry; /* Nr. of entries in aPgno[] and aIndex[] */
  53705. int iZero; /* Frame number associated with aPgno[0] */
  53706. } aSegment[1]; /* One for every 32KB page in the wal-index */
  53707. };
  53708. /*
  53709. ** Define the parameters of the hash tables in the wal-index file. There
  53710. ** is a hash-table following every HASHTABLE_NPAGE page numbers in the
  53711. ** wal-index.
  53712. **
  53713. ** Changing any of these constants will alter the wal-index format and
  53714. ** create incompatibilities.
  53715. */
  53716. #define HASHTABLE_NPAGE 4096 /* Must be power of 2 */
  53717. #define HASHTABLE_HASH_1 383 /* Should be prime */
  53718. #define HASHTABLE_NSLOT (HASHTABLE_NPAGE*2) /* Must be a power of 2 */
  53719. /*
  53720. ** The block of page numbers associated with the first hash-table in a
  53721. ** wal-index is smaller than usual. This is so that there is a complete
  53722. ** hash-table on each aligned 32KB page of the wal-index.
  53723. */
  53724. #define HASHTABLE_NPAGE_ONE (HASHTABLE_NPAGE - (WALINDEX_HDR_SIZE/sizeof(u32)))
  53725. /* The wal-index is divided into pages of WALINDEX_PGSZ bytes each. */
  53726. #define WALINDEX_PGSZ ( \
  53727. sizeof(ht_slot)*HASHTABLE_NSLOT + HASHTABLE_NPAGE*sizeof(u32) \
  53728. )
  53729. /*
  53730. ** Obtain a pointer to the iPage'th page of the wal-index. The wal-index
  53731. ** is broken into pages of WALINDEX_PGSZ bytes. Wal-index pages are
  53732. ** numbered from zero.
  53733. **
  53734. ** If the wal-index is currently smaller the iPage pages then the size
  53735. ** of the wal-index might be increased, but only if it is safe to do
  53736. ** so. It is safe to enlarge the wal-index if pWal->writeLock is true
  53737. ** or pWal->exclusiveMode==WAL_HEAPMEMORY_MODE.
  53738. **
  53739. ** If this call is successful, *ppPage is set to point to the wal-index
  53740. ** page and SQLITE_OK is returned. If an error (an OOM or VFS error) occurs,
  53741. ** then an SQLite error code is returned and *ppPage is set to 0.
  53742. */
  53743. static SQLITE_NOINLINE int walIndexPageRealloc(
  53744. Wal *pWal, /* The WAL context */
  53745. int iPage, /* The page we seek */
  53746. volatile u32 **ppPage /* Write the page pointer here */
  53747. ){
  53748. int rc = SQLITE_OK;
  53749. /* Enlarge the pWal->apWiData[] array if required */
  53750. if( pWal->nWiData<=iPage ){
  53751. int nByte = sizeof(u32*)*(iPage+1);
  53752. volatile u32 **apNew;
  53753. apNew = (volatile u32 **)sqlite3_realloc64((void *)pWal->apWiData, nByte);
  53754. if( !apNew ){
  53755. *ppPage = 0;
  53756. return SQLITE_NOMEM_BKPT;
  53757. }
  53758. memset((void*)&apNew[pWal->nWiData], 0,
  53759. sizeof(u32*)*(iPage+1-pWal->nWiData));
  53760. pWal->apWiData = apNew;
  53761. pWal->nWiData = iPage+1;
  53762. }
  53763. /* Request a pointer to the required page from the VFS */
  53764. assert( pWal->apWiData[iPage]==0 );
  53765. if( pWal->exclusiveMode==WAL_HEAPMEMORY_MODE ){
  53766. pWal->apWiData[iPage] = (u32 volatile *)sqlite3MallocZero(WALINDEX_PGSZ);
  53767. if( !pWal->apWiData[iPage] ) rc = SQLITE_NOMEM_BKPT;
  53768. }else{
  53769. rc = sqlite3OsShmMap(pWal->pDbFd, iPage, WALINDEX_PGSZ,
  53770. pWal->writeLock, (void volatile **)&pWal->apWiData[iPage]
  53771. );
  53772. assert( pWal->apWiData[iPage]!=0 || rc!=SQLITE_OK || pWal->writeLock==0 );
  53773. testcase( pWal->apWiData[iPage]==0 && rc==SQLITE_OK );
  53774. if( (rc&0xff)==SQLITE_READONLY ){
  53775. pWal->readOnly |= WAL_SHM_RDONLY;
  53776. if( rc==SQLITE_READONLY ){
  53777. rc = SQLITE_OK;
  53778. }
  53779. }
  53780. }
  53781. *ppPage = pWal->apWiData[iPage];
  53782. assert( iPage==0 || *ppPage || rc!=SQLITE_OK );
  53783. return rc;
  53784. }
  53785. static int walIndexPage(
  53786. Wal *pWal, /* The WAL context */
  53787. int iPage, /* The page we seek */
  53788. volatile u32 **ppPage /* Write the page pointer here */
  53789. ){
  53790. if( pWal->nWiData<=iPage || (*ppPage = pWal->apWiData[iPage])==0 ){
  53791. return walIndexPageRealloc(pWal, iPage, ppPage);
  53792. }
  53793. return SQLITE_OK;
  53794. }
  53795. /*
  53796. ** Return a pointer to the WalCkptInfo structure in the wal-index.
  53797. */
  53798. static volatile WalCkptInfo *walCkptInfo(Wal *pWal){
  53799. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  53800. return (volatile WalCkptInfo*)&(pWal->apWiData[0][sizeof(WalIndexHdr)/2]);
  53801. }
  53802. /*
  53803. ** Return a pointer to the WalIndexHdr structure in the wal-index.
  53804. */
  53805. static volatile WalIndexHdr *walIndexHdr(Wal *pWal){
  53806. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  53807. return (volatile WalIndexHdr*)pWal->apWiData[0];
  53808. }
  53809. /*
  53810. ** The argument to this macro must be of type u32. On a little-endian
  53811. ** architecture, it returns the u32 value that results from interpreting
  53812. ** the 4 bytes as a big-endian value. On a big-endian architecture, it
  53813. ** returns the value that would be produced by interpreting the 4 bytes
  53814. ** of the input value as a little-endian integer.
  53815. */
  53816. #define BYTESWAP32(x) ( \
  53817. (((x)&0x000000FF)<<24) + (((x)&0x0000FF00)<<8) \
  53818. + (((x)&0x00FF0000)>>8) + (((x)&0xFF000000)>>24) \
  53819. )
  53820. /*
  53821. ** Generate or extend an 8 byte checksum based on the data in
  53822. ** array aByte[] and the initial values of aIn[0] and aIn[1] (or
  53823. ** initial values of 0 and 0 if aIn==NULL).
  53824. **
  53825. ** The checksum is written back into aOut[] before returning.
  53826. **
  53827. ** nByte must be a positive multiple of 8.
  53828. */
  53829. static void walChecksumBytes(
  53830. int nativeCksum, /* True for native byte-order, false for non-native */
  53831. u8 *a, /* Content to be checksummed */
  53832. int nByte, /* Bytes of content in a[]. Must be a multiple of 8. */
  53833. const u32 *aIn, /* Initial checksum value input */
  53834. u32 *aOut /* OUT: Final checksum value output */
  53835. ){
  53836. u32 s1, s2;
  53837. u32 *aData = (u32 *)a;
  53838. u32 *aEnd = (u32 *)&a[nByte];
  53839. if( aIn ){
  53840. s1 = aIn[0];
  53841. s2 = aIn[1];
  53842. }else{
  53843. s1 = s2 = 0;
  53844. }
  53845. assert( nByte>=8 );
  53846. assert( (nByte&0x00000007)==0 );
  53847. if( nativeCksum ){
  53848. do {
  53849. s1 += *aData++ + s2;
  53850. s2 += *aData++ + s1;
  53851. }while( aData<aEnd );
  53852. }else{
  53853. do {
  53854. s1 += BYTESWAP32(aData[0]) + s2;
  53855. s2 += BYTESWAP32(aData[1]) + s1;
  53856. aData += 2;
  53857. }while( aData<aEnd );
  53858. }
  53859. aOut[0] = s1;
  53860. aOut[1] = s2;
  53861. }
  53862. static void walShmBarrier(Wal *pWal){
  53863. if( pWal->exclusiveMode!=WAL_HEAPMEMORY_MODE ){
  53864. sqlite3OsShmBarrier(pWal->pDbFd);
  53865. }
  53866. }
  53867. /*
  53868. ** Write the header information in pWal->hdr into the wal-index.
  53869. **
  53870. ** The checksum on pWal->hdr is updated before it is written.
  53871. */
  53872. static void walIndexWriteHdr(Wal *pWal){
  53873. volatile WalIndexHdr *aHdr = walIndexHdr(pWal);
  53874. const int nCksum = offsetof(WalIndexHdr, aCksum);
  53875. assert( pWal->writeLock );
  53876. pWal->hdr.isInit = 1;
  53877. pWal->hdr.iVersion = WALINDEX_MAX_VERSION;
  53878. walChecksumBytes(1, (u8*)&pWal->hdr, nCksum, 0, pWal->hdr.aCksum);
  53879. memcpy((void*)&aHdr[1], (const void*)&pWal->hdr, sizeof(WalIndexHdr));
  53880. walShmBarrier(pWal);
  53881. memcpy((void*)&aHdr[0], (const void*)&pWal->hdr, sizeof(WalIndexHdr));
  53882. }
  53883. /*
  53884. ** This function encodes a single frame header and writes it to a buffer
  53885. ** supplied by the caller. A frame-header is made up of a series of
  53886. ** 4-byte big-endian integers, as follows:
  53887. **
  53888. ** 0: Page number.
  53889. ** 4: For commit records, the size of the database image in pages
  53890. ** after the commit. For all other records, zero.
  53891. ** 8: Salt-1 (copied from the wal-header)
  53892. ** 12: Salt-2 (copied from the wal-header)
  53893. ** 16: Checksum-1.
  53894. ** 20: Checksum-2.
  53895. */
  53896. static void walEncodeFrame(
  53897. Wal *pWal, /* The write-ahead log */
  53898. u32 iPage, /* Database page number for frame */
  53899. u32 nTruncate, /* New db size (or 0 for non-commit frames) */
  53900. u8 *aData, /* Pointer to page data */
  53901. u8 *aFrame /* OUT: Write encoded frame here */
  53902. ){
  53903. int nativeCksum; /* True for native byte-order checksums */
  53904. u32 *aCksum = pWal->hdr.aFrameCksum;
  53905. assert( WAL_FRAME_HDRSIZE==24 );
  53906. sqlite3Put4byte(&aFrame[0], iPage);
  53907. sqlite3Put4byte(&aFrame[4], nTruncate);
  53908. if( pWal->iReCksum==0 ){
  53909. memcpy(&aFrame[8], pWal->hdr.aSalt, 8);
  53910. nativeCksum = (pWal->hdr.bigEndCksum==SQLITE_BIGENDIAN);
  53911. walChecksumBytes(nativeCksum, aFrame, 8, aCksum, aCksum);
  53912. walChecksumBytes(nativeCksum, aData, pWal->szPage, aCksum, aCksum);
  53913. sqlite3Put4byte(&aFrame[16], aCksum[0]);
  53914. sqlite3Put4byte(&aFrame[20], aCksum[1]);
  53915. }else{
  53916. memset(&aFrame[8], 0, 16);
  53917. }
  53918. }
  53919. /*
  53920. ** Check to see if the frame with header in aFrame[] and content
  53921. ** in aData[] is valid. If it is a valid frame, fill *piPage and
  53922. ** *pnTruncate and return true. Return if the frame is not valid.
  53923. */
  53924. static int walDecodeFrame(
  53925. Wal *pWal, /* The write-ahead log */
  53926. u32 *piPage, /* OUT: Database page number for frame */
  53927. u32 *pnTruncate, /* OUT: New db size (or 0 if not commit) */
  53928. u8 *aData, /* Pointer to page data (for checksum) */
  53929. u8 *aFrame /* Frame data */
  53930. ){
  53931. int nativeCksum; /* True for native byte-order checksums */
  53932. u32 *aCksum = pWal->hdr.aFrameCksum;
  53933. u32 pgno; /* Page number of the frame */
  53934. assert( WAL_FRAME_HDRSIZE==24 );
  53935. /* A frame is only valid if the salt values in the frame-header
  53936. ** match the salt values in the wal-header.
  53937. */
  53938. if( memcmp(&pWal->hdr.aSalt, &aFrame[8], 8)!=0 ){
  53939. return 0;
  53940. }
  53941. /* A frame is only valid if the page number is creater than zero.
  53942. */
  53943. pgno = sqlite3Get4byte(&aFrame[0]);
  53944. if( pgno==0 ){
  53945. return 0;
  53946. }
  53947. /* A frame is only valid if a checksum of the WAL header,
  53948. ** all prior frams, the first 16 bytes of this frame-header,
  53949. ** and the frame-data matches the checksum in the last 8
  53950. ** bytes of this frame-header.
  53951. */
  53952. nativeCksum = (pWal->hdr.bigEndCksum==SQLITE_BIGENDIAN);
  53953. walChecksumBytes(nativeCksum, aFrame, 8, aCksum, aCksum);
  53954. walChecksumBytes(nativeCksum, aData, pWal->szPage, aCksum, aCksum);
  53955. if( aCksum[0]!=sqlite3Get4byte(&aFrame[16])
  53956. || aCksum[1]!=sqlite3Get4byte(&aFrame[20])
  53957. ){
  53958. /* Checksum failed. */
  53959. return 0;
  53960. }
  53961. /* If we reach this point, the frame is valid. Return the page number
  53962. ** and the new database size.
  53963. */
  53964. *piPage = pgno;
  53965. *pnTruncate = sqlite3Get4byte(&aFrame[4]);
  53966. return 1;
  53967. }
  53968. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  53969. /*
  53970. ** Names of locks. This routine is used to provide debugging output and is not
  53971. ** a part of an ordinary build.
  53972. */
  53973. static const char *walLockName(int lockIdx){
  53974. if( lockIdx==WAL_WRITE_LOCK ){
  53975. return "WRITE-LOCK";
  53976. }else if( lockIdx==WAL_CKPT_LOCK ){
  53977. return "CKPT-LOCK";
  53978. }else if( lockIdx==WAL_RECOVER_LOCK ){
  53979. return "RECOVER-LOCK";
  53980. }else{
  53981. static char zName[15];
  53982. sqlite3_snprintf(sizeof(zName), zName, "READ-LOCK[%d]",
  53983. lockIdx-WAL_READ_LOCK(0));
  53984. return zName;
  53985. }
  53986. }
  53987. #endif /*defined(SQLITE_TEST) || defined(SQLITE_DEBUG) */
  53988. /*
  53989. ** Set or release locks on the WAL. Locks are either shared or exclusive.
  53990. ** A lock cannot be moved directly between shared and exclusive - it must go
  53991. ** through the unlocked state first.
  53992. **
  53993. ** In locking_mode=EXCLUSIVE, all of these routines become no-ops.
  53994. */
  53995. static int walLockShared(Wal *pWal, int lockIdx){
  53996. int rc;
  53997. if( pWal->exclusiveMode ) return SQLITE_OK;
  53998. rc = sqlite3OsShmLock(pWal->pDbFd, lockIdx, 1,
  53999. SQLITE_SHM_LOCK | SQLITE_SHM_SHARED);
  54000. WALTRACE(("WAL%p: acquire SHARED-%s %s\n", pWal,
  54001. walLockName(lockIdx), rc ? "failed" : "ok"));
  54002. VVA_ONLY( pWal->lockError = (u8)(rc!=SQLITE_OK && rc!=SQLITE_BUSY); )
  54003. return rc;
  54004. }
  54005. static void walUnlockShared(Wal *pWal, int lockIdx){
  54006. if( pWal->exclusiveMode ) return;
  54007. (void)sqlite3OsShmLock(pWal->pDbFd, lockIdx, 1,
  54008. SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED);
  54009. WALTRACE(("WAL%p: release SHARED-%s\n", pWal, walLockName(lockIdx)));
  54010. }
  54011. static int walLockExclusive(Wal *pWal, int lockIdx, int n){
  54012. int rc;
  54013. if( pWal->exclusiveMode ) return SQLITE_OK;
  54014. rc = sqlite3OsShmLock(pWal->pDbFd, lockIdx, n,
  54015. SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE);
  54016. WALTRACE(("WAL%p: acquire EXCLUSIVE-%s cnt=%d %s\n", pWal,
  54017. walLockName(lockIdx), n, rc ? "failed" : "ok"));
  54018. VVA_ONLY( pWal->lockError = (u8)(rc!=SQLITE_OK && rc!=SQLITE_BUSY); )
  54019. return rc;
  54020. }
  54021. static void walUnlockExclusive(Wal *pWal, int lockIdx, int n){
  54022. if( pWal->exclusiveMode ) return;
  54023. (void)sqlite3OsShmLock(pWal->pDbFd, lockIdx, n,
  54024. SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE);
  54025. WALTRACE(("WAL%p: release EXCLUSIVE-%s cnt=%d\n", pWal,
  54026. walLockName(lockIdx), n));
  54027. }
  54028. /*
  54029. ** Compute a hash on a page number. The resulting hash value must land
  54030. ** between 0 and (HASHTABLE_NSLOT-1). The walHashNext() function advances
  54031. ** the hash to the next value in the event of a collision.
  54032. */
  54033. static int walHash(u32 iPage){
  54034. assert( iPage>0 );
  54035. assert( (HASHTABLE_NSLOT & (HASHTABLE_NSLOT-1))==0 );
  54036. return (iPage*HASHTABLE_HASH_1) & (HASHTABLE_NSLOT-1);
  54037. }
  54038. static int walNextHash(int iPriorHash){
  54039. return (iPriorHash+1)&(HASHTABLE_NSLOT-1);
  54040. }
  54041. /*
  54042. ** Return pointers to the hash table and page number array stored on
  54043. ** page iHash of the wal-index. The wal-index is broken into 32KB pages
  54044. ** numbered starting from 0.
  54045. **
  54046. ** Set output variable *paHash to point to the start of the hash table
  54047. ** in the wal-index file. Set *piZero to one less than the frame
  54048. ** number of the first frame indexed by this hash table. If a
  54049. ** slot in the hash table is set to N, it refers to frame number
  54050. ** (*piZero+N) in the log.
  54051. **
  54052. ** Finally, set *paPgno so that *paPgno[1] is the page number of the
  54053. ** first frame indexed by the hash table, frame (*piZero+1).
  54054. */
  54055. static int walHashGet(
  54056. Wal *pWal, /* WAL handle */
  54057. int iHash, /* Find the iHash'th table */
  54058. volatile ht_slot **paHash, /* OUT: Pointer to hash index */
  54059. volatile u32 **paPgno, /* OUT: Pointer to page number array */
  54060. u32 *piZero /* OUT: Frame associated with *paPgno[0] */
  54061. ){
  54062. int rc; /* Return code */
  54063. volatile u32 *aPgno;
  54064. rc = walIndexPage(pWal, iHash, &aPgno);
  54065. assert( rc==SQLITE_OK || iHash>0 );
  54066. if( rc==SQLITE_OK ){
  54067. u32 iZero;
  54068. volatile ht_slot *aHash;
  54069. aHash = (volatile ht_slot *)&aPgno[HASHTABLE_NPAGE];
  54070. if( iHash==0 ){
  54071. aPgno = &aPgno[WALINDEX_HDR_SIZE/sizeof(u32)];
  54072. iZero = 0;
  54073. }else{
  54074. iZero = HASHTABLE_NPAGE_ONE + (iHash-1)*HASHTABLE_NPAGE;
  54075. }
  54076. *paPgno = &aPgno[-1];
  54077. *paHash = aHash;
  54078. *piZero = iZero;
  54079. }
  54080. return rc;
  54081. }
  54082. /*
  54083. ** Return the number of the wal-index page that contains the hash-table
  54084. ** and page-number array that contain entries corresponding to WAL frame
  54085. ** iFrame. The wal-index is broken up into 32KB pages. Wal-index pages
  54086. ** are numbered starting from 0.
  54087. */
  54088. static int walFramePage(u32 iFrame){
  54089. int iHash = (iFrame+HASHTABLE_NPAGE-HASHTABLE_NPAGE_ONE-1) / HASHTABLE_NPAGE;
  54090. assert( (iHash==0 || iFrame>HASHTABLE_NPAGE_ONE)
  54091. && (iHash>=1 || iFrame<=HASHTABLE_NPAGE_ONE)
  54092. && (iHash<=1 || iFrame>(HASHTABLE_NPAGE_ONE+HASHTABLE_NPAGE))
  54093. && (iHash>=2 || iFrame<=HASHTABLE_NPAGE_ONE+HASHTABLE_NPAGE)
  54094. && (iHash<=2 || iFrame>(HASHTABLE_NPAGE_ONE+2*HASHTABLE_NPAGE))
  54095. );
  54096. return iHash;
  54097. }
  54098. /*
  54099. ** Return the page number associated with frame iFrame in this WAL.
  54100. */
  54101. static u32 walFramePgno(Wal *pWal, u32 iFrame){
  54102. int iHash = walFramePage(iFrame);
  54103. if( iHash==0 ){
  54104. return pWal->apWiData[0][WALINDEX_HDR_SIZE/sizeof(u32) + iFrame - 1];
  54105. }
  54106. return pWal->apWiData[iHash][(iFrame-1-HASHTABLE_NPAGE_ONE)%HASHTABLE_NPAGE];
  54107. }
  54108. /*
  54109. ** Remove entries from the hash table that point to WAL slots greater
  54110. ** than pWal->hdr.mxFrame.
  54111. **
  54112. ** This function is called whenever pWal->hdr.mxFrame is decreased due
  54113. ** to a rollback or savepoint.
  54114. **
  54115. ** At most only the hash table containing pWal->hdr.mxFrame needs to be
  54116. ** updated. Any later hash tables will be automatically cleared when
  54117. ** pWal->hdr.mxFrame advances to the point where those hash tables are
  54118. ** actually needed.
  54119. */
  54120. static void walCleanupHash(Wal *pWal){
  54121. volatile ht_slot *aHash = 0; /* Pointer to hash table to clear */
  54122. volatile u32 *aPgno = 0; /* Page number array for hash table */
  54123. u32 iZero = 0; /* frame == (aHash[x]+iZero) */
  54124. int iLimit = 0; /* Zero values greater than this */
  54125. int nByte; /* Number of bytes to zero in aPgno[] */
  54126. int i; /* Used to iterate through aHash[] */
  54127. assert( pWal->writeLock );
  54128. testcase( pWal->hdr.mxFrame==HASHTABLE_NPAGE_ONE-1 );
  54129. testcase( pWal->hdr.mxFrame==HASHTABLE_NPAGE_ONE );
  54130. testcase( pWal->hdr.mxFrame==HASHTABLE_NPAGE_ONE+1 );
  54131. if( pWal->hdr.mxFrame==0 ) return;
  54132. /* Obtain pointers to the hash-table and page-number array containing
  54133. ** the entry that corresponds to frame pWal->hdr.mxFrame. It is guaranteed
  54134. ** that the page said hash-table and array reside on is already mapped.
  54135. */
  54136. assert( pWal->nWiData>walFramePage(pWal->hdr.mxFrame) );
  54137. assert( pWal->apWiData[walFramePage(pWal->hdr.mxFrame)] );
  54138. walHashGet(pWal, walFramePage(pWal->hdr.mxFrame), &aHash, &aPgno, &iZero);
  54139. /* Zero all hash-table entries that correspond to frame numbers greater
  54140. ** than pWal->hdr.mxFrame.
  54141. */
  54142. iLimit = pWal->hdr.mxFrame - iZero;
  54143. assert( iLimit>0 );
  54144. for(i=0; i<HASHTABLE_NSLOT; i++){
  54145. if( aHash[i]>iLimit ){
  54146. aHash[i] = 0;
  54147. }
  54148. }
  54149. /* Zero the entries in the aPgno array that correspond to frames with
  54150. ** frame numbers greater than pWal->hdr.mxFrame.
  54151. */
  54152. nByte = (int)((char *)aHash - (char *)&aPgno[iLimit+1]);
  54153. memset((void *)&aPgno[iLimit+1], 0, nByte);
  54154. #ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
  54155. /* Verify that the every entry in the mapping region is still reachable
  54156. ** via the hash table even after the cleanup.
  54157. */
  54158. if( iLimit ){
  54159. int j; /* Loop counter */
  54160. int iKey; /* Hash key */
  54161. for(j=1; j<=iLimit; j++){
  54162. for(iKey=walHash(aPgno[j]); aHash[iKey]; iKey=walNextHash(iKey)){
  54163. if( aHash[iKey]==j ) break;
  54164. }
  54165. assert( aHash[iKey]==j );
  54166. }
  54167. }
  54168. #endif /* SQLITE_ENABLE_EXPENSIVE_ASSERT */
  54169. }
  54170. /*
  54171. ** Set an entry in the wal-index that will map database page number
  54172. ** pPage into WAL frame iFrame.
  54173. */
  54174. static int walIndexAppend(Wal *pWal, u32 iFrame, u32 iPage){
  54175. int rc; /* Return code */
  54176. u32 iZero = 0; /* One less than frame number of aPgno[1] */
  54177. volatile u32 *aPgno = 0; /* Page number array */
  54178. volatile ht_slot *aHash = 0; /* Hash table */
  54179. rc = walHashGet(pWal, walFramePage(iFrame), &aHash, &aPgno, &iZero);
  54180. /* Assuming the wal-index file was successfully mapped, populate the
  54181. ** page number array and hash table entry.
  54182. */
  54183. if( rc==SQLITE_OK ){
  54184. int iKey; /* Hash table key */
  54185. int idx; /* Value to write to hash-table slot */
  54186. int nCollide; /* Number of hash collisions */
  54187. idx = iFrame - iZero;
  54188. assert( idx <= HASHTABLE_NSLOT/2 + 1 );
  54189. /* If this is the first entry to be added to this hash-table, zero the
  54190. ** entire hash table and aPgno[] array before proceeding.
  54191. */
  54192. if( idx==1 ){
  54193. int nByte = (int)((u8 *)&aHash[HASHTABLE_NSLOT] - (u8 *)&aPgno[1]);
  54194. memset((void*)&aPgno[1], 0, nByte);
  54195. }
  54196. /* If the entry in aPgno[] is already set, then the previous writer
  54197. ** must have exited unexpectedly in the middle of a transaction (after
  54198. ** writing one or more dirty pages to the WAL to free up memory).
  54199. ** Remove the remnants of that writers uncommitted transaction from
  54200. ** the hash-table before writing any new entries.
  54201. */
  54202. if( aPgno[idx] ){
  54203. walCleanupHash(pWal);
  54204. assert( !aPgno[idx] );
  54205. }
  54206. /* Write the aPgno[] array entry and the hash-table slot. */
  54207. nCollide = idx;
  54208. for(iKey=walHash(iPage); aHash[iKey]; iKey=walNextHash(iKey)){
  54209. if( (nCollide--)==0 ) return SQLITE_CORRUPT_BKPT;
  54210. }
  54211. aPgno[idx] = iPage;
  54212. aHash[iKey] = (ht_slot)idx;
  54213. #ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
  54214. /* Verify that the number of entries in the hash table exactly equals
  54215. ** the number of entries in the mapping region.
  54216. */
  54217. {
  54218. int i; /* Loop counter */
  54219. int nEntry = 0; /* Number of entries in the hash table */
  54220. for(i=0; i<HASHTABLE_NSLOT; i++){ if( aHash[i] ) nEntry++; }
  54221. assert( nEntry==idx );
  54222. }
  54223. /* Verify that the every entry in the mapping region is reachable
  54224. ** via the hash table. This turns out to be a really, really expensive
  54225. ** thing to check, so only do this occasionally - not on every
  54226. ** iteration.
  54227. */
  54228. if( (idx&0x3ff)==0 ){
  54229. int i; /* Loop counter */
  54230. for(i=1; i<=idx; i++){
  54231. for(iKey=walHash(aPgno[i]); aHash[iKey]; iKey=walNextHash(iKey)){
  54232. if( aHash[iKey]==i ) break;
  54233. }
  54234. assert( aHash[iKey]==i );
  54235. }
  54236. }
  54237. #endif /* SQLITE_ENABLE_EXPENSIVE_ASSERT */
  54238. }
  54239. return rc;
  54240. }
  54241. /*
  54242. ** Recover the wal-index by reading the write-ahead log file.
  54243. **
  54244. ** This routine first tries to establish an exclusive lock on the
  54245. ** wal-index to prevent other threads/processes from doing anything
  54246. ** with the WAL or wal-index while recovery is running. The
  54247. ** WAL_RECOVER_LOCK is also held so that other threads will know
  54248. ** that this thread is running recovery. If unable to establish
  54249. ** the necessary locks, this routine returns SQLITE_BUSY.
  54250. */
  54251. static int walIndexRecover(Wal *pWal){
  54252. int rc; /* Return Code */
  54253. i64 nSize; /* Size of log file */
  54254. u32 aFrameCksum[2] = {0, 0};
  54255. int iLock; /* Lock offset to lock for checkpoint */
  54256. /* Obtain an exclusive lock on all byte in the locking range not already
  54257. ** locked by the caller. The caller is guaranteed to have locked the
  54258. ** WAL_WRITE_LOCK byte, and may have also locked the WAL_CKPT_LOCK byte.
  54259. ** If successful, the same bytes that are locked here are unlocked before
  54260. ** this function returns.
  54261. */
  54262. assert( pWal->ckptLock==1 || pWal->ckptLock==0 );
  54263. assert( WAL_ALL_BUT_WRITE==WAL_WRITE_LOCK+1 );
  54264. assert( WAL_CKPT_LOCK==WAL_ALL_BUT_WRITE );
  54265. assert( pWal->writeLock );
  54266. iLock = WAL_ALL_BUT_WRITE + pWal->ckptLock;
  54267. rc = walLockExclusive(pWal, iLock, WAL_READ_LOCK(0)-iLock);
  54268. if( rc==SQLITE_OK ){
  54269. rc = walLockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  54270. if( rc!=SQLITE_OK ){
  54271. walUnlockExclusive(pWal, iLock, WAL_READ_LOCK(0)-iLock);
  54272. }
  54273. }
  54274. if( rc ){
  54275. return rc;
  54276. }
  54277. WALTRACE(("WAL%p: recovery begin...\n", pWal));
  54278. memset(&pWal->hdr, 0, sizeof(WalIndexHdr));
  54279. rc = sqlite3OsFileSize(pWal->pWalFd, &nSize);
  54280. if( rc!=SQLITE_OK ){
  54281. goto recovery_error;
  54282. }
  54283. if( nSize>WAL_HDRSIZE ){
  54284. u8 aBuf[WAL_HDRSIZE]; /* Buffer to load WAL header into */
  54285. u8 *aFrame = 0; /* Malloc'd buffer to load entire frame */
  54286. int szFrame; /* Number of bytes in buffer aFrame[] */
  54287. u8 *aData; /* Pointer to data part of aFrame buffer */
  54288. int iFrame; /* Index of last frame read */
  54289. i64 iOffset; /* Next offset to read from log file */
  54290. int szPage; /* Page size according to the log */
  54291. u32 magic; /* Magic value read from WAL header */
  54292. u32 version; /* Magic value read from WAL header */
  54293. int isValid; /* True if this frame is valid */
  54294. /* Read in the WAL header. */
  54295. rc = sqlite3OsRead(pWal->pWalFd, aBuf, WAL_HDRSIZE, 0);
  54296. if( rc!=SQLITE_OK ){
  54297. goto recovery_error;
  54298. }
  54299. /* If the database page size is not a power of two, or is greater than
  54300. ** SQLITE_MAX_PAGE_SIZE, conclude that the WAL file contains no valid
  54301. ** data. Similarly, if the 'magic' value is invalid, ignore the whole
  54302. ** WAL file.
  54303. */
  54304. magic = sqlite3Get4byte(&aBuf[0]);
  54305. szPage = sqlite3Get4byte(&aBuf[8]);
  54306. if( (magic&0xFFFFFFFE)!=WAL_MAGIC
  54307. || szPage&(szPage-1)
  54308. || szPage>SQLITE_MAX_PAGE_SIZE
  54309. || szPage<512
  54310. ){
  54311. goto finished;
  54312. }
  54313. pWal->hdr.bigEndCksum = (u8)(magic&0x00000001);
  54314. pWal->szPage = szPage;
  54315. pWal->nCkpt = sqlite3Get4byte(&aBuf[12]);
  54316. memcpy(&pWal->hdr.aSalt, &aBuf[16], 8);
  54317. /* Verify that the WAL header checksum is correct */
  54318. walChecksumBytes(pWal->hdr.bigEndCksum==SQLITE_BIGENDIAN,
  54319. aBuf, WAL_HDRSIZE-2*4, 0, pWal->hdr.aFrameCksum
  54320. );
  54321. if( pWal->hdr.aFrameCksum[0]!=sqlite3Get4byte(&aBuf[24])
  54322. || pWal->hdr.aFrameCksum[1]!=sqlite3Get4byte(&aBuf[28])
  54323. ){
  54324. goto finished;
  54325. }
  54326. /* Verify that the version number on the WAL format is one that
  54327. ** are able to understand */
  54328. version = sqlite3Get4byte(&aBuf[4]);
  54329. if( version!=WAL_MAX_VERSION ){
  54330. rc = SQLITE_CANTOPEN_BKPT;
  54331. goto finished;
  54332. }
  54333. /* Malloc a buffer to read frames into. */
  54334. szFrame = szPage + WAL_FRAME_HDRSIZE;
  54335. aFrame = (u8 *)sqlite3_malloc64(szFrame);
  54336. if( !aFrame ){
  54337. rc = SQLITE_NOMEM_BKPT;
  54338. goto recovery_error;
  54339. }
  54340. aData = &aFrame[WAL_FRAME_HDRSIZE];
  54341. /* Read all frames from the log file. */
  54342. iFrame = 0;
  54343. for(iOffset=WAL_HDRSIZE; (iOffset+szFrame)<=nSize; iOffset+=szFrame){
  54344. u32 pgno; /* Database page number for frame */
  54345. u32 nTruncate; /* dbsize field from frame header */
  54346. /* Read and decode the next log frame. */
  54347. iFrame++;
  54348. rc = sqlite3OsRead(pWal->pWalFd, aFrame, szFrame, iOffset);
  54349. if( rc!=SQLITE_OK ) break;
  54350. isValid = walDecodeFrame(pWal, &pgno, &nTruncate, aData, aFrame);
  54351. if( !isValid ) break;
  54352. rc = walIndexAppend(pWal, iFrame, pgno);
  54353. if( rc!=SQLITE_OK ) break;
  54354. /* If nTruncate is non-zero, this is a commit record. */
  54355. if( nTruncate ){
  54356. pWal->hdr.mxFrame = iFrame;
  54357. pWal->hdr.nPage = nTruncate;
  54358. pWal->hdr.szPage = (u16)((szPage&0xff00) | (szPage>>16));
  54359. testcase( szPage<=32768 );
  54360. testcase( szPage>=65536 );
  54361. aFrameCksum[0] = pWal->hdr.aFrameCksum[0];
  54362. aFrameCksum[1] = pWal->hdr.aFrameCksum[1];
  54363. }
  54364. }
  54365. sqlite3_free(aFrame);
  54366. }
  54367. finished:
  54368. if( rc==SQLITE_OK ){
  54369. volatile WalCkptInfo *pInfo;
  54370. int i;
  54371. pWal->hdr.aFrameCksum[0] = aFrameCksum[0];
  54372. pWal->hdr.aFrameCksum[1] = aFrameCksum[1];
  54373. walIndexWriteHdr(pWal);
  54374. /* Reset the checkpoint-header. This is safe because this thread is
  54375. ** currently holding locks that exclude all other readers, writers and
  54376. ** checkpointers.
  54377. */
  54378. pInfo = walCkptInfo(pWal);
  54379. pInfo->nBackfill = 0;
  54380. pInfo->nBackfillAttempted = pWal->hdr.mxFrame;
  54381. pInfo->aReadMark[0] = 0;
  54382. for(i=1; i<WAL_NREADER; i++) pInfo->aReadMark[i] = READMARK_NOT_USED;
  54383. if( pWal->hdr.mxFrame ) pInfo->aReadMark[1] = pWal->hdr.mxFrame;
  54384. /* If more than one frame was recovered from the log file, report an
  54385. ** event via sqlite3_log(). This is to help with identifying performance
  54386. ** problems caused by applications routinely shutting down without
  54387. ** checkpointing the log file.
  54388. */
  54389. if( pWal->hdr.nPage ){
  54390. sqlite3_log(SQLITE_NOTICE_RECOVER_WAL,
  54391. "recovered %d frames from WAL file %s",
  54392. pWal->hdr.mxFrame, pWal->zWalName
  54393. );
  54394. }
  54395. }
  54396. recovery_error:
  54397. WALTRACE(("WAL%p: recovery %s\n", pWal, rc ? "failed" : "ok"));
  54398. walUnlockExclusive(pWal, iLock, WAL_READ_LOCK(0)-iLock);
  54399. walUnlockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  54400. return rc;
  54401. }
  54402. /*
  54403. ** Close an open wal-index.
  54404. */
  54405. static void walIndexClose(Wal *pWal, int isDelete){
  54406. if( pWal->exclusiveMode==WAL_HEAPMEMORY_MODE || pWal->bShmUnreliable ){
  54407. int i;
  54408. for(i=0; i<pWal->nWiData; i++){
  54409. sqlite3_free((void *)pWal->apWiData[i]);
  54410. pWal->apWiData[i] = 0;
  54411. }
  54412. }
  54413. if( pWal->exclusiveMode!=WAL_HEAPMEMORY_MODE ){
  54414. sqlite3OsShmUnmap(pWal->pDbFd, isDelete);
  54415. }
  54416. }
  54417. /*
  54418. ** Open a connection to the WAL file zWalName. The database file must
  54419. ** already be opened on connection pDbFd. The buffer that zWalName points
  54420. ** to must remain valid for the lifetime of the returned Wal* handle.
  54421. **
  54422. ** A SHARED lock should be held on the database file when this function
  54423. ** is called. The purpose of this SHARED lock is to prevent any other
  54424. ** client from unlinking the WAL or wal-index file. If another process
  54425. ** were to do this just after this client opened one of these files, the
  54426. ** system would be badly broken.
  54427. **
  54428. ** If the log file is successfully opened, SQLITE_OK is returned and
  54429. ** *ppWal is set to point to a new WAL handle. If an error occurs,
  54430. ** an SQLite error code is returned and *ppWal is left unmodified.
  54431. */
  54432. SQLITE_PRIVATE int sqlite3WalOpen(
  54433. sqlite3_vfs *pVfs, /* vfs module to open wal and wal-index */
  54434. sqlite3_file *pDbFd, /* The open database file */
  54435. const char *zWalName, /* Name of the WAL file */
  54436. int bNoShm, /* True to run in heap-memory mode */
  54437. i64 mxWalSize, /* Truncate WAL to this size on reset */
  54438. Wal **ppWal /* OUT: Allocated Wal handle */
  54439. ){
  54440. int rc; /* Return Code */
  54441. Wal *pRet; /* Object to allocate and return */
  54442. int flags; /* Flags passed to OsOpen() */
  54443. assert( zWalName && zWalName[0] );
  54444. assert( pDbFd );
  54445. /* In the amalgamation, the os_unix.c and os_win.c source files come before
  54446. ** this source file. Verify that the #defines of the locking byte offsets
  54447. ** in os_unix.c and os_win.c agree with the WALINDEX_LOCK_OFFSET value.
  54448. ** For that matter, if the lock offset ever changes from its initial design
  54449. ** value of 120, we need to know that so there is an assert() to check it.
  54450. */
  54451. assert( 120==WALINDEX_LOCK_OFFSET );
  54452. assert( 136==WALINDEX_HDR_SIZE );
  54453. #ifdef WIN_SHM_BASE
  54454. assert( WIN_SHM_BASE==WALINDEX_LOCK_OFFSET );
  54455. #endif
  54456. #ifdef UNIX_SHM_BASE
  54457. assert( UNIX_SHM_BASE==WALINDEX_LOCK_OFFSET );
  54458. #endif
  54459. /* Allocate an instance of struct Wal to return. */
  54460. *ppWal = 0;
  54461. pRet = (Wal*)sqlite3MallocZero(sizeof(Wal) + pVfs->szOsFile);
  54462. if( !pRet ){
  54463. return SQLITE_NOMEM_BKPT;
  54464. }
  54465. pRet->pVfs = pVfs;
  54466. pRet->pWalFd = (sqlite3_file *)&pRet[1];
  54467. pRet->pDbFd = pDbFd;
  54468. pRet->readLock = -1;
  54469. pRet->mxWalSize = mxWalSize;
  54470. pRet->zWalName = zWalName;
  54471. pRet->syncHeader = 1;
  54472. pRet->padToSectorBoundary = 1;
  54473. pRet->exclusiveMode = (bNoShm ? WAL_HEAPMEMORY_MODE: WAL_NORMAL_MODE);
  54474. /* Open file handle on the write-ahead log file. */
  54475. flags = (SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_WAL);
  54476. rc = sqlite3OsOpen(pVfs, zWalName, pRet->pWalFd, flags, &flags);
  54477. if( rc==SQLITE_OK && flags&SQLITE_OPEN_READONLY ){
  54478. pRet->readOnly = WAL_RDONLY;
  54479. }
  54480. if( rc!=SQLITE_OK ){
  54481. walIndexClose(pRet, 0);
  54482. sqlite3OsClose(pRet->pWalFd);
  54483. sqlite3_free(pRet);
  54484. }else{
  54485. int iDC = sqlite3OsDeviceCharacteristics(pDbFd);
  54486. if( iDC & SQLITE_IOCAP_SEQUENTIAL ){ pRet->syncHeader = 0; }
  54487. if( iDC & SQLITE_IOCAP_POWERSAFE_OVERWRITE ){
  54488. pRet->padToSectorBoundary = 0;
  54489. }
  54490. *ppWal = pRet;
  54491. WALTRACE(("WAL%d: opened\n", pRet));
  54492. }
  54493. return rc;
  54494. }
  54495. /*
  54496. ** Change the size to which the WAL file is trucated on each reset.
  54497. */
  54498. SQLITE_PRIVATE void sqlite3WalLimit(Wal *pWal, i64 iLimit){
  54499. if( pWal ) pWal->mxWalSize = iLimit;
  54500. }
  54501. /*
  54502. ** Find the smallest page number out of all pages held in the WAL that
  54503. ** has not been returned by any prior invocation of this method on the
  54504. ** same WalIterator object. Write into *piFrame the frame index where
  54505. ** that page was last written into the WAL. Write into *piPage the page
  54506. ** number.
  54507. **
  54508. ** Return 0 on success. If there are no pages in the WAL with a page
  54509. ** number larger than *piPage, then return 1.
  54510. */
  54511. static int walIteratorNext(
  54512. WalIterator *p, /* Iterator */
  54513. u32 *piPage, /* OUT: The page number of the next page */
  54514. u32 *piFrame /* OUT: Wal frame index of next page */
  54515. ){
  54516. u32 iMin; /* Result pgno must be greater than iMin */
  54517. u32 iRet = 0xFFFFFFFF; /* 0xffffffff is never a valid page number */
  54518. int i; /* For looping through segments */
  54519. iMin = p->iPrior;
  54520. assert( iMin<0xffffffff );
  54521. for(i=p->nSegment-1; i>=0; i--){
  54522. struct WalSegment *pSegment = &p->aSegment[i];
  54523. while( pSegment->iNext<pSegment->nEntry ){
  54524. u32 iPg = pSegment->aPgno[pSegment->aIndex[pSegment->iNext]];
  54525. if( iPg>iMin ){
  54526. if( iPg<iRet ){
  54527. iRet = iPg;
  54528. *piFrame = pSegment->iZero + pSegment->aIndex[pSegment->iNext];
  54529. }
  54530. break;
  54531. }
  54532. pSegment->iNext++;
  54533. }
  54534. }
  54535. *piPage = p->iPrior = iRet;
  54536. return (iRet==0xFFFFFFFF);
  54537. }
  54538. /*
  54539. ** This function merges two sorted lists into a single sorted list.
  54540. **
  54541. ** aLeft[] and aRight[] are arrays of indices. The sort key is
  54542. ** aContent[aLeft[]] and aContent[aRight[]]. Upon entry, the following
  54543. ** is guaranteed for all J<K:
  54544. **
  54545. ** aContent[aLeft[J]] < aContent[aLeft[K]]
  54546. ** aContent[aRight[J]] < aContent[aRight[K]]
  54547. **
  54548. ** This routine overwrites aRight[] with a new (probably longer) sequence
  54549. ** of indices such that the aRight[] contains every index that appears in
  54550. ** either aLeft[] or the old aRight[] and such that the second condition
  54551. ** above is still met.
  54552. **
  54553. ** The aContent[aLeft[X]] values will be unique for all X. And the
  54554. ** aContent[aRight[X]] values will be unique too. But there might be
  54555. ** one or more combinations of X and Y such that
  54556. **
  54557. ** aLeft[X]!=aRight[Y] && aContent[aLeft[X]] == aContent[aRight[Y]]
  54558. **
  54559. ** When that happens, omit the aLeft[X] and use the aRight[Y] index.
  54560. */
  54561. static void walMerge(
  54562. const u32 *aContent, /* Pages in wal - keys for the sort */
  54563. ht_slot *aLeft, /* IN: Left hand input list */
  54564. int nLeft, /* IN: Elements in array *paLeft */
  54565. ht_slot **paRight, /* IN/OUT: Right hand input list */
  54566. int *pnRight, /* IN/OUT: Elements in *paRight */
  54567. ht_slot *aTmp /* Temporary buffer */
  54568. ){
  54569. int iLeft = 0; /* Current index in aLeft */
  54570. int iRight = 0; /* Current index in aRight */
  54571. int iOut = 0; /* Current index in output buffer */
  54572. int nRight = *pnRight;
  54573. ht_slot *aRight = *paRight;
  54574. assert( nLeft>0 && nRight>0 );
  54575. while( iRight<nRight || iLeft<nLeft ){
  54576. ht_slot logpage;
  54577. Pgno dbpage;
  54578. if( (iLeft<nLeft)
  54579. && (iRight>=nRight || aContent[aLeft[iLeft]]<aContent[aRight[iRight]])
  54580. ){
  54581. logpage = aLeft[iLeft++];
  54582. }else{
  54583. logpage = aRight[iRight++];
  54584. }
  54585. dbpage = aContent[logpage];
  54586. aTmp[iOut++] = logpage;
  54587. if( iLeft<nLeft && aContent[aLeft[iLeft]]==dbpage ) iLeft++;
  54588. assert( iLeft>=nLeft || aContent[aLeft[iLeft]]>dbpage );
  54589. assert( iRight>=nRight || aContent[aRight[iRight]]>dbpage );
  54590. }
  54591. *paRight = aLeft;
  54592. *pnRight = iOut;
  54593. memcpy(aLeft, aTmp, sizeof(aTmp[0])*iOut);
  54594. }
  54595. /*
  54596. ** Sort the elements in list aList using aContent[] as the sort key.
  54597. ** Remove elements with duplicate keys, preferring to keep the
  54598. ** larger aList[] values.
  54599. **
  54600. ** The aList[] entries are indices into aContent[]. The values in
  54601. ** aList[] are to be sorted so that for all J<K:
  54602. **
  54603. ** aContent[aList[J]] < aContent[aList[K]]
  54604. **
  54605. ** For any X and Y such that
  54606. **
  54607. ** aContent[aList[X]] == aContent[aList[Y]]
  54608. **
  54609. ** Keep the larger of the two values aList[X] and aList[Y] and discard
  54610. ** the smaller.
  54611. */
  54612. static void walMergesort(
  54613. const u32 *aContent, /* Pages in wal */
  54614. ht_slot *aBuffer, /* Buffer of at least *pnList items to use */
  54615. ht_slot *aList, /* IN/OUT: List to sort */
  54616. int *pnList /* IN/OUT: Number of elements in aList[] */
  54617. ){
  54618. struct Sublist {
  54619. int nList; /* Number of elements in aList */
  54620. ht_slot *aList; /* Pointer to sub-list content */
  54621. };
  54622. const int nList = *pnList; /* Size of input list */
  54623. int nMerge = 0; /* Number of elements in list aMerge */
  54624. ht_slot *aMerge = 0; /* List to be merged */
  54625. int iList; /* Index into input list */
  54626. u32 iSub = 0; /* Index into aSub array */
  54627. struct Sublist aSub[13]; /* Array of sub-lists */
  54628. memset(aSub, 0, sizeof(aSub));
  54629. assert( nList<=HASHTABLE_NPAGE && nList>0 );
  54630. assert( HASHTABLE_NPAGE==(1<<(ArraySize(aSub)-1)) );
  54631. for(iList=0; iList<nList; iList++){
  54632. nMerge = 1;
  54633. aMerge = &aList[iList];
  54634. for(iSub=0; iList & (1<<iSub); iSub++){
  54635. struct Sublist *p;
  54636. assert( iSub<ArraySize(aSub) );
  54637. p = &aSub[iSub];
  54638. assert( p->aList && p->nList<=(1<<iSub) );
  54639. assert( p->aList==&aList[iList&~((2<<iSub)-1)] );
  54640. walMerge(aContent, p->aList, p->nList, &aMerge, &nMerge, aBuffer);
  54641. }
  54642. aSub[iSub].aList = aMerge;
  54643. aSub[iSub].nList = nMerge;
  54644. }
  54645. for(iSub++; iSub<ArraySize(aSub); iSub++){
  54646. if( nList & (1<<iSub) ){
  54647. struct Sublist *p;
  54648. assert( iSub<ArraySize(aSub) );
  54649. p = &aSub[iSub];
  54650. assert( p->nList<=(1<<iSub) );
  54651. assert( p->aList==&aList[nList&~((2<<iSub)-1)] );
  54652. walMerge(aContent, p->aList, p->nList, &aMerge, &nMerge, aBuffer);
  54653. }
  54654. }
  54655. assert( aMerge==aList );
  54656. *pnList = nMerge;
  54657. #ifdef SQLITE_DEBUG
  54658. {
  54659. int i;
  54660. for(i=1; i<*pnList; i++){
  54661. assert( aContent[aList[i]] > aContent[aList[i-1]] );
  54662. }
  54663. }
  54664. #endif
  54665. }
  54666. /*
  54667. ** Free an iterator allocated by walIteratorInit().
  54668. */
  54669. static void walIteratorFree(WalIterator *p){
  54670. sqlite3_free(p);
  54671. }
  54672. /*
  54673. ** Construct a WalInterator object that can be used to loop over all
  54674. ** pages in the WAL following frame nBackfill in ascending order. Frames
  54675. ** nBackfill or earlier may be included - excluding them is an optimization
  54676. ** only. The caller must hold the checkpoint lock.
  54677. **
  54678. ** On success, make *pp point to the newly allocated WalInterator object
  54679. ** return SQLITE_OK. Otherwise, return an error code. If this routine
  54680. ** returns an error, the value of *pp is undefined.
  54681. **
  54682. ** The calling routine should invoke walIteratorFree() to destroy the
  54683. ** WalIterator object when it has finished with it.
  54684. */
  54685. static int walIteratorInit(Wal *pWal, u32 nBackfill, WalIterator **pp){
  54686. WalIterator *p; /* Return value */
  54687. int nSegment; /* Number of segments to merge */
  54688. u32 iLast; /* Last frame in log */
  54689. int nByte; /* Number of bytes to allocate */
  54690. int i; /* Iterator variable */
  54691. ht_slot *aTmp; /* Temp space used by merge-sort */
  54692. int rc = SQLITE_OK; /* Return Code */
  54693. /* This routine only runs while holding the checkpoint lock. And
  54694. ** it only runs if there is actually content in the log (mxFrame>0).
  54695. */
  54696. assert( pWal->ckptLock && pWal->hdr.mxFrame>0 );
  54697. iLast = pWal->hdr.mxFrame;
  54698. /* Allocate space for the WalIterator object. */
  54699. nSegment = walFramePage(iLast) + 1;
  54700. nByte = sizeof(WalIterator)
  54701. + (nSegment-1)*sizeof(struct WalSegment)
  54702. + iLast*sizeof(ht_slot);
  54703. p = (WalIterator *)sqlite3_malloc64(nByte);
  54704. if( !p ){
  54705. return SQLITE_NOMEM_BKPT;
  54706. }
  54707. memset(p, 0, nByte);
  54708. p->nSegment = nSegment;
  54709. /* Allocate temporary space used by the merge-sort routine. This block
  54710. ** of memory will be freed before this function returns.
  54711. */
  54712. aTmp = (ht_slot *)sqlite3_malloc64(
  54713. sizeof(ht_slot) * (iLast>HASHTABLE_NPAGE?HASHTABLE_NPAGE:iLast)
  54714. );
  54715. if( !aTmp ){
  54716. rc = SQLITE_NOMEM_BKPT;
  54717. }
  54718. for(i=walFramePage(nBackfill+1); rc==SQLITE_OK && i<nSegment; i++){
  54719. volatile ht_slot *aHash;
  54720. u32 iZero;
  54721. volatile u32 *aPgno;
  54722. rc = walHashGet(pWal, i, &aHash, &aPgno, &iZero);
  54723. if( rc==SQLITE_OK ){
  54724. int j; /* Counter variable */
  54725. int nEntry; /* Number of entries in this segment */
  54726. ht_slot *aIndex; /* Sorted index for this segment */
  54727. aPgno++;
  54728. if( (i+1)==nSegment ){
  54729. nEntry = (int)(iLast - iZero);
  54730. }else{
  54731. nEntry = (int)((u32*)aHash - (u32*)aPgno);
  54732. }
  54733. aIndex = &((ht_slot *)&p->aSegment[p->nSegment])[iZero];
  54734. iZero++;
  54735. for(j=0; j<nEntry; j++){
  54736. aIndex[j] = (ht_slot)j;
  54737. }
  54738. walMergesort((u32 *)aPgno, aTmp, aIndex, &nEntry);
  54739. p->aSegment[i].iZero = iZero;
  54740. p->aSegment[i].nEntry = nEntry;
  54741. p->aSegment[i].aIndex = aIndex;
  54742. p->aSegment[i].aPgno = (u32 *)aPgno;
  54743. }
  54744. }
  54745. sqlite3_free(aTmp);
  54746. if( rc!=SQLITE_OK ){
  54747. walIteratorFree(p);
  54748. p = 0;
  54749. }
  54750. *pp = p;
  54751. return rc;
  54752. }
  54753. /*
  54754. ** Attempt to obtain the exclusive WAL lock defined by parameters lockIdx and
  54755. ** n. If the attempt fails and parameter xBusy is not NULL, then it is a
  54756. ** busy-handler function. Invoke it and retry the lock until either the
  54757. ** lock is successfully obtained or the busy-handler returns 0.
  54758. */
  54759. static int walBusyLock(
  54760. Wal *pWal, /* WAL connection */
  54761. int (*xBusy)(void*), /* Function to call when busy */
  54762. void *pBusyArg, /* Context argument for xBusyHandler */
  54763. int lockIdx, /* Offset of first byte to lock */
  54764. int n /* Number of bytes to lock */
  54765. ){
  54766. int rc;
  54767. do {
  54768. rc = walLockExclusive(pWal, lockIdx, n);
  54769. }while( xBusy && rc==SQLITE_BUSY && xBusy(pBusyArg) );
  54770. return rc;
  54771. }
  54772. /*
  54773. ** The cache of the wal-index header must be valid to call this function.
  54774. ** Return the page-size in bytes used by the database.
  54775. */
  54776. static int walPagesize(Wal *pWal){
  54777. return (pWal->hdr.szPage&0xfe00) + ((pWal->hdr.szPage&0x0001)<<16);
  54778. }
  54779. /*
  54780. ** The following is guaranteed when this function is called:
  54781. **
  54782. ** a) the WRITER lock is held,
  54783. ** b) the entire log file has been checkpointed, and
  54784. ** c) any existing readers are reading exclusively from the database
  54785. ** file - there are no readers that may attempt to read a frame from
  54786. ** the log file.
  54787. **
  54788. ** This function updates the shared-memory structures so that the next
  54789. ** client to write to the database (which may be this one) does so by
  54790. ** writing frames into the start of the log file.
  54791. **
  54792. ** The value of parameter salt1 is used as the aSalt[1] value in the
  54793. ** new wal-index header. It should be passed a pseudo-random value (i.e.
  54794. ** one obtained from sqlite3_randomness()).
  54795. */
  54796. static void walRestartHdr(Wal *pWal, u32 salt1){
  54797. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  54798. int i; /* Loop counter */
  54799. u32 *aSalt = pWal->hdr.aSalt; /* Big-endian salt values */
  54800. pWal->nCkpt++;
  54801. pWal->hdr.mxFrame = 0;
  54802. sqlite3Put4byte((u8*)&aSalt[0], 1 + sqlite3Get4byte((u8*)&aSalt[0]));
  54803. memcpy(&pWal->hdr.aSalt[1], &salt1, 4);
  54804. walIndexWriteHdr(pWal);
  54805. pInfo->nBackfill = 0;
  54806. pInfo->nBackfillAttempted = 0;
  54807. pInfo->aReadMark[1] = 0;
  54808. for(i=2; i<WAL_NREADER; i++) pInfo->aReadMark[i] = READMARK_NOT_USED;
  54809. assert( pInfo->aReadMark[0]==0 );
  54810. }
  54811. /*
  54812. ** Copy as much content as we can from the WAL back into the database file
  54813. ** in response to an sqlite3_wal_checkpoint() request or the equivalent.
  54814. **
  54815. ** The amount of information copies from WAL to database might be limited
  54816. ** by active readers. This routine will never overwrite a database page
  54817. ** that a concurrent reader might be using.
  54818. **
  54819. ** All I/O barrier operations (a.k.a fsyncs) occur in this routine when
  54820. ** SQLite is in WAL-mode in synchronous=NORMAL. That means that if
  54821. ** checkpoints are always run by a background thread or background
  54822. ** process, foreground threads will never block on a lengthy fsync call.
  54823. **
  54824. ** Fsync is called on the WAL before writing content out of the WAL and
  54825. ** into the database. This ensures that if the new content is persistent
  54826. ** in the WAL and can be recovered following a power-loss or hard reset.
  54827. **
  54828. ** Fsync is also called on the database file if (and only if) the entire
  54829. ** WAL content is copied into the database file. This second fsync makes
  54830. ** it safe to delete the WAL since the new content will persist in the
  54831. ** database file.
  54832. **
  54833. ** This routine uses and updates the nBackfill field of the wal-index header.
  54834. ** This is the only routine that will increase the value of nBackfill.
  54835. ** (A WAL reset or recovery will revert nBackfill to zero, but not increase
  54836. ** its value.)
  54837. **
  54838. ** The caller must be holding sufficient locks to ensure that no other
  54839. ** checkpoint is running (in any other thread or process) at the same
  54840. ** time.
  54841. */
  54842. static int walCheckpoint(
  54843. Wal *pWal, /* Wal connection */
  54844. sqlite3 *db, /* Check for interrupts on this handle */
  54845. int eMode, /* One of PASSIVE, FULL or RESTART */
  54846. int (*xBusy)(void*), /* Function to call when busy */
  54847. void *pBusyArg, /* Context argument for xBusyHandler */
  54848. int sync_flags, /* Flags for OsSync() (or 0) */
  54849. u8 *zBuf /* Temporary buffer to use */
  54850. ){
  54851. int rc = SQLITE_OK; /* Return code */
  54852. int szPage; /* Database page-size */
  54853. WalIterator *pIter = 0; /* Wal iterator context */
  54854. u32 iDbpage = 0; /* Next database page to write */
  54855. u32 iFrame = 0; /* Wal frame containing data for iDbpage */
  54856. u32 mxSafeFrame; /* Max frame that can be backfilled */
  54857. u32 mxPage; /* Max database page to write */
  54858. int i; /* Loop counter */
  54859. volatile WalCkptInfo *pInfo; /* The checkpoint status information */
  54860. szPage = walPagesize(pWal);
  54861. testcase( szPage<=32768 );
  54862. testcase( szPage>=65536 );
  54863. pInfo = walCkptInfo(pWal);
  54864. if( pInfo->nBackfill<pWal->hdr.mxFrame ){
  54865. /* EVIDENCE-OF: R-62920-47450 The busy-handler callback is never invoked
  54866. ** in the SQLITE_CHECKPOINT_PASSIVE mode. */
  54867. assert( eMode!=SQLITE_CHECKPOINT_PASSIVE || xBusy==0 );
  54868. /* Compute in mxSafeFrame the index of the last frame of the WAL that is
  54869. ** safe to write into the database. Frames beyond mxSafeFrame might
  54870. ** overwrite database pages that are in use by active readers and thus
  54871. ** cannot be backfilled from the WAL.
  54872. */
  54873. mxSafeFrame = pWal->hdr.mxFrame;
  54874. mxPage = pWal->hdr.nPage;
  54875. for(i=1; i<WAL_NREADER; i++){
  54876. /* Thread-sanitizer reports that the following is an unsafe read,
  54877. ** as some other thread may be in the process of updating the value
  54878. ** of the aReadMark[] slot. The assumption here is that if that is
  54879. ** happening, the other client may only be increasing the value,
  54880. ** not decreasing it. So assuming either that either the "old" or
  54881. ** "new" version of the value is read, and not some arbitrary value
  54882. ** that would never be written by a real client, things are still
  54883. ** safe. */
  54884. u32 y = pInfo->aReadMark[i];
  54885. if( mxSafeFrame>y ){
  54886. assert( y<=pWal->hdr.mxFrame );
  54887. rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_READ_LOCK(i), 1);
  54888. if( rc==SQLITE_OK ){
  54889. pInfo->aReadMark[i] = (i==1 ? mxSafeFrame : READMARK_NOT_USED);
  54890. walUnlockExclusive(pWal, WAL_READ_LOCK(i), 1);
  54891. }else if( rc==SQLITE_BUSY ){
  54892. mxSafeFrame = y;
  54893. xBusy = 0;
  54894. }else{
  54895. goto walcheckpoint_out;
  54896. }
  54897. }
  54898. }
  54899. /* Allocate the iterator */
  54900. if( pInfo->nBackfill<mxSafeFrame ){
  54901. rc = walIteratorInit(pWal, pInfo->nBackfill, &pIter);
  54902. assert( rc==SQLITE_OK || pIter==0 );
  54903. }
  54904. if( pIter
  54905. && (rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_READ_LOCK(0),1))==SQLITE_OK
  54906. ){
  54907. i64 nSize; /* Current size of database file */
  54908. u32 nBackfill = pInfo->nBackfill;
  54909. pInfo->nBackfillAttempted = mxSafeFrame;
  54910. /* Sync the WAL to disk */
  54911. rc = sqlite3OsSync(pWal->pWalFd, CKPT_SYNC_FLAGS(sync_flags));
  54912. /* If the database may grow as a result of this checkpoint, hint
  54913. ** about the eventual size of the db file to the VFS layer.
  54914. */
  54915. if( rc==SQLITE_OK ){
  54916. i64 nReq = ((i64)mxPage * szPage);
  54917. rc = sqlite3OsFileSize(pWal->pDbFd, &nSize);
  54918. if( rc==SQLITE_OK && nSize<nReq ){
  54919. sqlite3OsFileControlHint(pWal->pDbFd, SQLITE_FCNTL_SIZE_HINT, &nReq);
  54920. }
  54921. }
  54922. /* Iterate through the contents of the WAL, copying data to the db file */
  54923. while( rc==SQLITE_OK && 0==walIteratorNext(pIter, &iDbpage, &iFrame) ){
  54924. i64 iOffset;
  54925. assert( walFramePgno(pWal, iFrame)==iDbpage );
  54926. if( db->u1.isInterrupted ){
  54927. rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_INTERRUPT;
  54928. break;
  54929. }
  54930. if( iFrame<=nBackfill || iFrame>mxSafeFrame || iDbpage>mxPage ){
  54931. continue;
  54932. }
  54933. iOffset = walFrameOffset(iFrame, szPage) + WAL_FRAME_HDRSIZE;
  54934. /* testcase( IS_BIG_INT(iOffset) ); // requires a 4GiB WAL file */
  54935. rc = sqlite3OsRead(pWal->pWalFd, zBuf, szPage, iOffset);
  54936. if( rc!=SQLITE_OK ) break;
  54937. iOffset = (iDbpage-1)*(i64)szPage;
  54938. testcase( IS_BIG_INT(iOffset) );
  54939. rc = sqlite3OsWrite(pWal->pDbFd, zBuf, szPage, iOffset);
  54940. if( rc!=SQLITE_OK ) break;
  54941. }
  54942. /* If work was actually accomplished... */
  54943. if( rc==SQLITE_OK ){
  54944. if( mxSafeFrame==walIndexHdr(pWal)->mxFrame ){
  54945. i64 szDb = pWal->hdr.nPage*(i64)szPage;
  54946. testcase( IS_BIG_INT(szDb) );
  54947. rc = sqlite3OsTruncate(pWal->pDbFd, szDb);
  54948. if( rc==SQLITE_OK ){
  54949. rc = sqlite3OsSync(pWal->pDbFd, CKPT_SYNC_FLAGS(sync_flags));
  54950. }
  54951. }
  54952. if( rc==SQLITE_OK ){
  54953. pInfo->nBackfill = mxSafeFrame;
  54954. }
  54955. }
  54956. /* Release the reader lock held while backfilling */
  54957. walUnlockExclusive(pWal, WAL_READ_LOCK(0), 1);
  54958. }
  54959. if( rc==SQLITE_BUSY ){
  54960. /* Reset the return code so as not to report a checkpoint failure
  54961. ** just because there are active readers. */
  54962. rc = SQLITE_OK;
  54963. }
  54964. }
  54965. /* If this is an SQLITE_CHECKPOINT_RESTART or TRUNCATE operation, and the
  54966. ** entire wal file has been copied into the database file, then block
  54967. ** until all readers have finished using the wal file. This ensures that
  54968. ** the next process to write to the database restarts the wal file.
  54969. */
  54970. if( rc==SQLITE_OK && eMode!=SQLITE_CHECKPOINT_PASSIVE ){
  54971. assert( pWal->writeLock );
  54972. if( pInfo->nBackfill<pWal->hdr.mxFrame ){
  54973. rc = SQLITE_BUSY;
  54974. }else if( eMode>=SQLITE_CHECKPOINT_RESTART ){
  54975. u32 salt1;
  54976. sqlite3_randomness(4, &salt1);
  54977. assert( pInfo->nBackfill==pWal->hdr.mxFrame );
  54978. rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_READ_LOCK(1), WAL_NREADER-1);
  54979. if( rc==SQLITE_OK ){
  54980. if( eMode==SQLITE_CHECKPOINT_TRUNCATE ){
  54981. /* IMPLEMENTATION-OF: R-44699-57140 This mode works the same way as
  54982. ** SQLITE_CHECKPOINT_RESTART with the addition that it also
  54983. ** truncates the log file to zero bytes just prior to a
  54984. ** successful return.
  54985. **
  54986. ** In theory, it might be safe to do this without updating the
  54987. ** wal-index header in shared memory, as all subsequent reader or
  54988. ** writer clients should see that the entire log file has been
  54989. ** checkpointed and behave accordingly. This seems unsafe though,
  54990. ** as it would leave the system in a state where the contents of
  54991. ** the wal-index header do not match the contents of the
  54992. ** file-system. To avoid this, update the wal-index header to
  54993. ** indicate that the log file contains zero valid frames. */
  54994. walRestartHdr(pWal, salt1);
  54995. rc = sqlite3OsTruncate(pWal->pWalFd, 0);
  54996. }
  54997. walUnlockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  54998. }
  54999. }
  55000. }
  55001. walcheckpoint_out:
  55002. walIteratorFree(pIter);
  55003. return rc;
  55004. }
  55005. /*
  55006. ** If the WAL file is currently larger than nMax bytes in size, truncate
  55007. ** it to exactly nMax bytes. If an error occurs while doing so, ignore it.
  55008. */
  55009. static void walLimitSize(Wal *pWal, i64 nMax){
  55010. i64 sz;
  55011. int rx;
  55012. sqlite3BeginBenignMalloc();
  55013. rx = sqlite3OsFileSize(pWal->pWalFd, &sz);
  55014. if( rx==SQLITE_OK && (sz > nMax ) ){
  55015. rx = sqlite3OsTruncate(pWal->pWalFd, nMax);
  55016. }
  55017. sqlite3EndBenignMalloc();
  55018. if( rx ){
  55019. sqlite3_log(rx, "cannot limit WAL size: %s", pWal->zWalName);
  55020. }
  55021. }
  55022. /*
  55023. ** Close a connection to a log file.
  55024. */
  55025. SQLITE_PRIVATE int sqlite3WalClose(
  55026. Wal *pWal, /* Wal to close */
  55027. sqlite3 *db, /* For interrupt flag */
  55028. int sync_flags, /* Flags to pass to OsSync() (or 0) */
  55029. int nBuf,
  55030. u8 *zBuf /* Buffer of at least nBuf bytes */
  55031. ){
  55032. int rc = SQLITE_OK;
  55033. if( pWal ){
  55034. int isDelete = 0; /* True to unlink wal and wal-index files */
  55035. /* If an EXCLUSIVE lock can be obtained on the database file (using the
  55036. ** ordinary, rollback-mode locking methods, this guarantees that the
  55037. ** connection associated with this log file is the only connection to
  55038. ** the database. In this case checkpoint the database and unlink both
  55039. ** the wal and wal-index files.
  55040. **
  55041. ** The EXCLUSIVE lock is not released before returning.
  55042. */
  55043. if( zBuf!=0
  55044. && SQLITE_OK==(rc = sqlite3OsLock(pWal->pDbFd, SQLITE_LOCK_EXCLUSIVE))
  55045. ){
  55046. if( pWal->exclusiveMode==WAL_NORMAL_MODE ){
  55047. pWal->exclusiveMode = WAL_EXCLUSIVE_MODE;
  55048. }
  55049. rc = sqlite3WalCheckpoint(pWal, db,
  55050. SQLITE_CHECKPOINT_PASSIVE, 0, 0, sync_flags, nBuf, zBuf, 0, 0
  55051. );
  55052. if( rc==SQLITE_OK ){
  55053. int bPersist = -1;
  55054. sqlite3OsFileControlHint(
  55055. pWal->pDbFd, SQLITE_FCNTL_PERSIST_WAL, &bPersist
  55056. );
  55057. if( bPersist!=1 ){
  55058. /* Try to delete the WAL file if the checkpoint completed and
  55059. ** fsyned (rc==SQLITE_OK) and if we are not in persistent-wal
  55060. ** mode (!bPersist) */
  55061. isDelete = 1;
  55062. }else if( pWal->mxWalSize>=0 ){
  55063. /* Try to truncate the WAL file to zero bytes if the checkpoint
  55064. ** completed and fsynced (rc==SQLITE_OK) and we are in persistent
  55065. ** WAL mode (bPersist) and if the PRAGMA journal_size_limit is a
  55066. ** non-negative value (pWal->mxWalSize>=0). Note that we truncate
  55067. ** to zero bytes as truncating to the journal_size_limit might
  55068. ** leave a corrupt WAL file on disk. */
  55069. walLimitSize(pWal, 0);
  55070. }
  55071. }
  55072. }
  55073. walIndexClose(pWal, isDelete);
  55074. sqlite3OsClose(pWal->pWalFd);
  55075. if( isDelete ){
  55076. sqlite3BeginBenignMalloc();
  55077. sqlite3OsDelete(pWal->pVfs, pWal->zWalName, 0);
  55078. sqlite3EndBenignMalloc();
  55079. }
  55080. WALTRACE(("WAL%p: closed\n", pWal));
  55081. sqlite3_free((void *)pWal->apWiData);
  55082. sqlite3_free(pWal);
  55083. }
  55084. return rc;
  55085. }
  55086. /*
  55087. ** Try to read the wal-index header. Return 0 on success and 1 if
  55088. ** there is a problem.
  55089. **
  55090. ** The wal-index is in shared memory. Another thread or process might
  55091. ** be writing the header at the same time this procedure is trying to
  55092. ** read it, which might result in inconsistency. A dirty read is detected
  55093. ** by verifying that both copies of the header are the same and also by
  55094. ** a checksum on the header.
  55095. **
  55096. ** If and only if the read is consistent and the header is different from
  55097. ** pWal->hdr, then pWal->hdr is updated to the content of the new header
  55098. ** and *pChanged is set to 1.
  55099. **
  55100. ** If the checksum cannot be verified return non-zero. If the header
  55101. ** is read successfully and the checksum verified, return zero.
  55102. */
  55103. static int walIndexTryHdr(Wal *pWal, int *pChanged){
  55104. u32 aCksum[2]; /* Checksum on the header content */
  55105. WalIndexHdr h1, h2; /* Two copies of the header content */
  55106. WalIndexHdr volatile *aHdr; /* Header in shared memory */
  55107. /* The first page of the wal-index must be mapped at this point. */
  55108. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  55109. /* Read the header. This might happen concurrently with a write to the
  55110. ** same area of shared memory on a different CPU in a SMP,
  55111. ** meaning it is possible that an inconsistent snapshot is read
  55112. ** from the file. If this happens, return non-zero.
  55113. **
  55114. ** There are two copies of the header at the beginning of the wal-index.
  55115. ** When reading, read [0] first then [1]. Writes are in the reverse order.
  55116. ** Memory barriers are used to prevent the compiler or the hardware from
  55117. ** reordering the reads and writes.
  55118. */
  55119. aHdr = walIndexHdr(pWal);
  55120. memcpy(&h1, (void *)&aHdr[0], sizeof(h1));
  55121. walShmBarrier(pWal);
  55122. memcpy(&h2, (void *)&aHdr[1], sizeof(h2));
  55123. if( memcmp(&h1, &h2, sizeof(h1))!=0 ){
  55124. return 1; /* Dirty read */
  55125. }
  55126. if( h1.isInit==0 ){
  55127. return 1; /* Malformed header - probably all zeros */
  55128. }
  55129. walChecksumBytes(1, (u8*)&h1, sizeof(h1)-sizeof(h1.aCksum), 0, aCksum);
  55130. if( aCksum[0]!=h1.aCksum[0] || aCksum[1]!=h1.aCksum[1] ){
  55131. return 1; /* Checksum does not match */
  55132. }
  55133. if( memcmp(&pWal->hdr, &h1, sizeof(WalIndexHdr)) ){
  55134. *pChanged = 1;
  55135. memcpy(&pWal->hdr, &h1, sizeof(WalIndexHdr));
  55136. pWal->szPage = (pWal->hdr.szPage&0xfe00) + ((pWal->hdr.szPage&0x0001)<<16);
  55137. testcase( pWal->szPage<=32768 );
  55138. testcase( pWal->szPage>=65536 );
  55139. }
  55140. /* The header was successfully read. Return zero. */
  55141. return 0;
  55142. }
  55143. /*
  55144. ** This is the value that walTryBeginRead returns when it needs to
  55145. ** be retried.
  55146. */
  55147. #define WAL_RETRY (-1)
  55148. /*
  55149. ** Read the wal-index header from the wal-index and into pWal->hdr.
  55150. ** If the wal-header appears to be corrupt, try to reconstruct the
  55151. ** wal-index from the WAL before returning.
  55152. **
  55153. ** Set *pChanged to 1 if the wal-index header value in pWal->hdr is
  55154. ** changed by this operation. If pWal->hdr is unchanged, set *pChanged
  55155. ** to 0.
  55156. **
  55157. ** If the wal-index header is successfully read, return SQLITE_OK.
  55158. ** Otherwise an SQLite error code.
  55159. */
  55160. static int walIndexReadHdr(Wal *pWal, int *pChanged){
  55161. int rc; /* Return code */
  55162. int badHdr; /* True if a header read failed */
  55163. volatile u32 *page0; /* Chunk of wal-index containing header */
  55164. /* Ensure that page 0 of the wal-index (the page that contains the
  55165. ** wal-index header) is mapped. Return early if an error occurs here.
  55166. */
  55167. assert( pChanged );
  55168. rc = walIndexPage(pWal, 0, &page0);
  55169. if( rc!=SQLITE_OK ){
  55170. assert( rc!=SQLITE_READONLY ); /* READONLY changed to OK in walIndexPage */
  55171. if( rc==SQLITE_READONLY_CANTINIT ){
  55172. /* The SQLITE_READONLY_CANTINIT return means that the shared-memory
  55173. ** was openable but is not writable, and this thread is unable to
  55174. ** confirm that another write-capable connection has the shared-memory
  55175. ** open, and hence the content of the shared-memory is unreliable,
  55176. ** since the shared-memory might be inconsistent with the WAL file
  55177. ** and there is no writer on hand to fix it. */
  55178. assert( page0==0 );
  55179. assert( pWal->writeLock==0 );
  55180. assert( pWal->readOnly & WAL_SHM_RDONLY );
  55181. pWal->bShmUnreliable = 1;
  55182. pWal->exclusiveMode = WAL_HEAPMEMORY_MODE;
  55183. *pChanged = 1;
  55184. }else{
  55185. return rc; /* Any other non-OK return is just an error */
  55186. }
  55187. }else{
  55188. /* page0 can be NULL if the SHM is zero bytes in size and pWal->writeLock
  55189. ** is zero, which prevents the SHM from growing */
  55190. testcase( page0!=0 );
  55191. }
  55192. assert( page0!=0 || pWal->writeLock==0 );
  55193. /* If the first page of the wal-index has been mapped, try to read the
  55194. ** wal-index header immediately, without holding any lock. This usually
  55195. ** works, but may fail if the wal-index header is corrupt or currently
  55196. ** being modified by another thread or process.
  55197. */
  55198. badHdr = (page0 ? walIndexTryHdr(pWal, pChanged) : 1);
  55199. /* If the first attempt failed, it might have been due to a race
  55200. ** with a writer. So get a WRITE lock and try again.
  55201. */
  55202. assert( badHdr==0 || pWal->writeLock==0 );
  55203. if( badHdr ){
  55204. if( pWal->bShmUnreliable==0 && (pWal->readOnly & WAL_SHM_RDONLY) ){
  55205. if( SQLITE_OK==(rc = walLockShared(pWal, WAL_WRITE_LOCK)) ){
  55206. walUnlockShared(pWal, WAL_WRITE_LOCK);
  55207. rc = SQLITE_READONLY_RECOVERY;
  55208. }
  55209. }else if( SQLITE_OK==(rc = walLockExclusive(pWal, WAL_WRITE_LOCK, 1)) ){
  55210. pWal->writeLock = 1;
  55211. if( SQLITE_OK==(rc = walIndexPage(pWal, 0, &page0)) ){
  55212. badHdr = walIndexTryHdr(pWal, pChanged);
  55213. if( badHdr ){
  55214. /* If the wal-index header is still malformed even while holding
  55215. ** a WRITE lock, it can only mean that the header is corrupted and
  55216. ** needs to be reconstructed. So run recovery to do exactly that.
  55217. */
  55218. rc = walIndexRecover(pWal);
  55219. *pChanged = 1;
  55220. }
  55221. }
  55222. pWal->writeLock = 0;
  55223. walUnlockExclusive(pWal, WAL_WRITE_LOCK, 1);
  55224. }
  55225. }
  55226. /* If the header is read successfully, check the version number to make
  55227. ** sure the wal-index was not constructed with some future format that
  55228. ** this version of SQLite cannot understand.
  55229. */
  55230. if( badHdr==0 && pWal->hdr.iVersion!=WALINDEX_MAX_VERSION ){
  55231. rc = SQLITE_CANTOPEN_BKPT;
  55232. }
  55233. if( pWal->bShmUnreliable ){
  55234. if( rc!=SQLITE_OK ){
  55235. walIndexClose(pWal, 0);
  55236. pWal->bShmUnreliable = 0;
  55237. assert( pWal->nWiData>0 && pWal->apWiData[0]==0 );
  55238. /* walIndexRecover() might have returned SHORT_READ if a concurrent
  55239. ** writer truncated the WAL out from under it. If that happens, it
  55240. ** indicates that a writer has fixed the SHM file for us, so retry */
  55241. if( rc==SQLITE_IOERR_SHORT_READ ) rc = WAL_RETRY;
  55242. }
  55243. pWal->exclusiveMode = WAL_NORMAL_MODE;
  55244. }
  55245. return rc;
  55246. }
  55247. /*
  55248. ** Open a transaction in a connection where the shared-memory is read-only
  55249. ** and where we cannot verify that there is a separate write-capable connection
  55250. ** on hand to keep the shared-memory up-to-date with the WAL file.
  55251. **
  55252. ** This can happen, for example, when the shared-memory is implemented by
  55253. ** memory-mapping a *-shm file, where a prior writer has shut down and
  55254. ** left the *-shm file on disk, and now the present connection is trying
  55255. ** to use that database but lacks write permission on the *-shm file.
  55256. ** Other scenarios are also possible, depending on the VFS implementation.
  55257. **
  55258. ** Precondition:
  55259. **
  55260. ** The *-wal file has been read and an appropriate wal-index has been
  55261. ** constructed in pWal->apWiData[] using heap memory instead of shared
  55262. ** memory.
  55263. **
  55264. ** If this function returns SQLITE_OK, then the read transaction has
  55265. ** been successfully opened. In this case output variable (*pChanged)
  55266. ** is set to true before returning if the caller should discard the
  55267. ** contents of the page cache before proceeding. Or, if it returns
  55268. ** WAL_RETRY, then the heap memory wal-index has been discarded and
  55269. ** the caller should retry opening the read transaction from the
  55270. ** beginning (including attempting to map the *-shm file).
  55271. **
  55272. ** If an error occurs, an SQLite error code is returned.
  55273. */
  55274. static int walBeginShmUnreliable(Wal *pWal, int *pChanged){
  55275. i64 szWal; /* Size of wal file on disk in bytes */
  55276. i64 iOffset; /* Current offset when reading wal file */
  55277. u8 aBuf[WAL_HDRSIZE]; /* Buffer to load WAL header into */
  55278. u8 *aFrame = 0; /* Malloc'd buffer to load entire frame */
  55279. int szFrame; /* Number of bytes in buffer aFrame[] */
  55280. u8 *aData; /* Pointer to data part of aFrame buffer */
  55281. volatile void *pDummy; /* Dummy argument for xShmMap */
  55282. int rc; /* Return code */
  55283. u32 aSaveCksum[2]; /* Saved copy of pWal->hdr.aFrameCksum */
  55284. assert( pWal->bShmUnreliable );
  55285. assert( pWal->readOnly & WAL_SHM_RDONLY );
  55286. assert( pWal->nWiData>0 && pWal->apWiData[0] );
  55287. /* Take WAL_READ_LOCK(0). This has the effect of preventing any
  55288. ** writers from running a checkpoint, but does not stop them
  55289. ** from running recovery. */
  55290. rc = walLockShared(pWal, WAL_READ_LOCK(0));
  55291. if( rc!=SQLITE_OK ){
  55292. if( rc==SQLITE_BUSY ) rc = WAL_RETRY;
  55293. goto begin_unreliable_shm_out;
  55294. }
  55295. pWal->readLock = 0;
  55296. /* Check to see if a separate writer has attached to the shared-memory area,
  55297. ** thus making the shared-memory "reliable" again. Do this by invoking
  55298. ** the xShmMap() routine of the VFS and looking to see if the return
  55299. ** is SQLITE_READONLY instead of SQLITE_READONLY_CANTINIT.
  55300. **
  55301. ** If the shared-memory is now "reliable" return WAL_RETRY, which will
  55302. ** cause the heap-memory WAL-index to be discarded and the actual
  55303. ** shared memory to be used in its place.
  55304. **
  55305. ** This step is important because, even though this connection is holding
  55306. ** the WAL_READ_LOCK(0) which prevents a checkpoint, a writer might
  55307. ** have already checkpointed the WAL file and, while the current
  55308. ** is active, wrap the WAL and start overwriting frames that this
  55309. ** process wants to use.
  55310. **
  55311. ** Once sqlite3OsShmMap() has been called for an sqlite3_file and has
  55312. ** returned any SQLITE_READONLY value, it must return only SQLITE_READONLY
  55313. ** or SQLITE_READONLY_CANTINIT or some error for all subsequent invocations,
  55314. ** even if some external agent does a "chmod" to make the shared-memory
  55315. ** writable by us, until sqlite3OsShmUnmap() has been called.
  55316. ** This is a requirement on the VFS implementation.
  55317. */
  55318. rc = sqlite3OsShmMap(pWal->pDbFd, 0, WALINDEX_PGSZ, 0, &pDummy);
  55319. assert( rc!=SQLITE_OK ); /* SQLITE_OK not possible for read-only connection */
  55320. if( rc!=SQLITE_READONLY_CANTINIT ){
  55321. rc = (rc==SQLITE_READONLY ? WAL_RETRY : rc);
  55322. goto begin_unreliable_shm_out;
  55323. }
  55324. /* We reach this point only if the real shared-memory is still unreliable.
  55325. ** Assume the in-memory WAL-index substitute is correct and load it
  55326. ** into pWal->hdr.
  55327. */
  55328. memcpy(&pWal->hdr, (void*)walIndexHdr(pWal), sizeof(WalIndexHdr));
  55329. /* Make sure some writer hasn't come in and changed the WAL file out
  55330. ** from under us, then disconnected, while we were not looking.
  55331. */
  55332. rc = sqlite3OsFileSize(pWal->pWalFd, &szWal);
  55333. if( rc!=SQLITE_OK ){
  55334. goto begin_unreliable_shm_out;
  55335. }
  55336. if( szWal<WAL_HDRSIZE ){
  55337. /* If the wal file is too small to contain a wal-header and the
  55338. ** wal-index header has mxFrame==0, then it must be safe to proceed
  55339. ** reading the database file only. However, the page cache cannot
  55340. ** be trusted, as a read/write connection may have connected, written
  55341. ** the db, run a checkpoint, truncated the wal file and disconnected
  55342. ** since this client's last read transaction. */
  55343. *pChanged = 1;
  55344. rc = (pWal->hdr.mxFrame==0 ? SQLITE_OK : WAL_RETRY);
  55345. goto begin_unreliable_shm_out;
  55346. }
  55347. /* Check the salt keys at the start of the wal file still match. */
  55348. rc = sqlite3OsRead(pWal->pWalFd, aBuf, WAL_HDRSIZE, 0);
  55349. if( rc!=SQLITE_OK ){
  55350. goto begin_unreliable_shm_out;
  55351. }
  55352. if( memcmp(&pWal->hdr.aSalt, &aBuf[16], 8) ){
  55353. /* Some writer has wrapped the WAL file while we were not looking.
  55354. ** Return WAL_RETRY which will cause the in-memory WAL-index to be
  55355. ** rebuilt. */
  55356. rc = WAL_RETRY;
  55357. goto begin_unreliable_shm_out;
  55358. }
  55359. /* Allocate a buffer to read frames into */
  55360. szFrame = pWal->hdr.szPage + WAL_FRAME_HDRSIZE;
  55361. aFrame = (u8 *)sqlite3_malloc64(szFrame);
  55362. if( aFrame==0 ){
  55363. rc = SQLITE_NOMEM_BKPT;
  55364. goto begin_unreliable_shm_out;
  55365. }
  55366. aData = &aFrame[WAL_FRAME_HDRSIZE];
  55367. /* Check to see if a complete transaction has been appended to the
  55368. ** wal file since the heap-memory wal-index was created. If so, the
  55369. ** heap-memory wal-index is discarded and WAL_RETRY returned to
  55370. ** the caller. */
  55371. aSaveCksum[0] = pWal->hdr.aFrameCksum[0];
  55372. aSaveCksum[1] = pWal->hdr.aFrameCksum[1];
  55373. for(iOffset=walFrameOffset(pWal->hdr.mxFrame+1, pWal->hdr.szPage);
  55374. iOffset+szFrame<=szWal;
  55375. iOffset+=szFrame
  55376. ){
  55377. u32 pgno; /* Database page number for frame */
  55378. u32 nTruncate; /* dbsize field from frame header */
  55379. /* Read and decode the next log frame. */
  55380. rc = sqlite3OsRead(pWal->pWalFd, aFrame, szFrame, iOffset);
  55381. if( rc!=SQLITE_OK ) break;
  55382. if( !walDecodeFrame(pWal, &pgno, &nTruncate, aData, aFrame) ) break;
  55383. /* If nTruncate is non-zero, then a complete transaction has been
  55384. ** appended to this wal file. Set rc to WAL_RETRY and break out of
  55385. ** the loop. */
  55386. if( nTruncate ){
  55387. rc = WAL_RETRY;
  55388. break;
  55389. }
  55390. }
  55391. pWal->hdr.aFrameCksum[0] = aSaveCksum[0];
  55392. pWal->hdr.aFrameCksum[1] = aSaveCksum[1];
  55393. begin_unreliable_shm_out:
  55394. sqlite3_free(aFrame);
  55395. if( rc!=SQLITE_OK ){
  55396. int i;
  55397. for(i=0; i<pWal->nWiData; i++){
  55398. sqlite3_free((void*)pWal->apWiData[i]);
  55399. pWal->apWiData[i] = 0;
  55400. }
  55401. pWal->bShmUnreliable = 0;
  55402. sqlite3WalEndReadTransaction(pWal);
  55403. *pChanged = 1;
  55404. }
  55405. return rc;
  55406. }
  55407. /*
  55408. ** Attempt to start a read transaction. This might fail due to a race or
  55409. ** other transient condition. When that happens, it returns WAL_RETRY to
  55410. ** indicate to the caller that it is safe to retry immediately.
  55411. **
  55412. ** On success return SQLITE_OK. On a permanent failure (such an
  55413. ** I/O error or an SQLITE_BUSY because another process is running
  55414. ** recovery) return a positive error code.
  55415. **
  55416. ** The useWal parameter is true to force the use of the WAL and disable
  55417. ** the case where the WAL is bypassed because it has been completely
  55418. ** checkpointed. If useWal==0 then this routine calls walIndexReadHdr()
  55419. ** to make a copy of the wal-index header into pWal->hdr. If the
  55420. ** wal-index header has changed, *pChanged is set to 1 (as an indication
  55421. ** to the caller that the local page cache is obsolete and needs to be
  55422. ** flushed.) When useWal==1, the wal-index header is assumed to already
  55423. ** be loaded and the pChanged parameter is unused.
  55424. **
  55425. ** The caller must set the cnt parameter to the number of prior calls to
  55426. ** this routine during the current read attempt that returned WAL_RETRY.
  55427. ** This routine will start taking more aggressive measures to clear the
  55428. ** race conditions after multiple WAL_RETRY returns, and after an excessive
  55429. ** number of errors will ultimately return SQLITE_PROTOCOL. The
  55430. ** SQLITE_PROTOCOL return indicates that some other process has gone rogue
  55431. ** and is not honoring the locking protocol. There is a vanishingly small
  55432. ** chance that SQLITE_PROTOCOL could be returned because of a run of really
  55433. ** bad luck when there is lots of contention for the wal-index, but that
  55434. ** possibility is so small that it can be safely neglected, we believe.
  55435. **
  55436. ** On success, this routine obtains a read lock on
  55437. ** WAL_READ_LOCK(pWal->readLock). The pWal->readLock integer is
  55438. ** in the range 0 <= pWal->readLock < WAL_NREADER. If pWal->readLock==(-1)
  55439. ** that means the Wal does not hold any read lock. The reader must not
  55440. ** access any database page that is modified by a WAL frame up to and
  55441. ** including frame number aReadMark[pWal->readLock]. The reader will
  55442. ** use WAL frames up to and including pWal->hdr.mxFrame if pWal->readLock>0
  55443. ** Or if pWal->readLock==0, then the reader will ignore the WAL
  55444. ** completely and get all content directly from the database file.
  55445. ** If the useWal parameter is 1 then the WAL will never be ignored and
  55446. ** this routine will always set pWal->readLock>0 on success.
  55447. ** When the read transaction is completed, the caller must release the
  55448. ** lock on WAL_READ_LOCK(pWal->readLock) and set pWal->readLock to -1.
  55449. **
  55450. ** This routine uses the nBackfill and aReadMark[] fields of the header
  55451. ** to select a particular WAL_READ_LOCK() that strives to let the
  55452. ** checkpoint process do as much work as possible. This routine might
  55453. ** update values of the aReadMark[] array in the header, but if it does
  55454. ** so it takes care to hold an exclusive lock on the corresponding
  55455. ** WAL_READ_LOCK() while changing values.
  55456. */
  55457. static int walTryBeginRead(Wal *pWal, int *pChanged, int useWal, int cnt){
  55458. volatile WalCkptInfo *pInfo; /* Checkpoint information in wal-index */
  55459. u32 mxReadMark; /* Largest aReadMark[] value */
  55460. int mxI; /* Index of largest aReadMark[] value */
  55461. int i; /* Loop counter */
  55462. int rc = SQLITE_OK; /* Return code */
  55463. u32 mxFrame; /* Wal frame to lock to */
  55464. assert( pWal->readLock<0 ); /* Not currently locked */
  55465. /* useWal may only be set for read/write connections */
  55466. assert( (pWal->readOnly & WAL_SHM_RDONLY)==0 || useWal==0 );
  55467. /* Take steps to avoid spinning forever if there is a protocol error.
  55468. **
  55469. ** Circumstances that cause a RETRY should only last for the briefest
  55470. ** instances of time. No I/O or other system calls are done while the
  55471. ** locks are held, so the locks should not be held for very long. But
  55472. ** if we are unlucky, another process that is holding a lock might get
  55473. ** paged out or take a page-fault that is time-consuming to resolve,
  55474. ** during the few nanoseconds that it is holding the lock. In that case,
  55475. ** it might take longer than normal for the lock to free.
  55476. **
  55477. ** After 5 RETRYs, we begin calling sqlite3OsSleep(). The first few
  55478. ** calls to sqlite3OsSleep() have a delay of 1 microsecond. Really this
  55479. ** is more of a scheduler yield than an actual delay. But on the 10th
  55480. ** an subsequent retries, the delays start becoming longer and longer,
  55481. ** so that on the 100th (and last) RETRY we delay for 323 milliseconds.
  55482. ** The total delay time before giving up is less than 10 seconds.
  55483. */
  55484. if( cnt>5 ){
  55485. int nDelay = 1; /* Pause time in microseconds */
  55486. if( cnt>100 ){
  55487. VVA_ONLY( pWal->lockError = 1; )
  55488. return SQLITE_PROTOCOL;
  55489. }
  55490. if( cnt>=10 ) nDelay = (cnt-9)*(cnt-9)*39;
  55491. sqlite3OsSleep(pWal->pVfs, nDelay);
  55492. }
  55493. if( !useWal ){
  55494. assert( rc==SQLITE_OK );
  55495. if( pWal->bShmUnreliable==0 ){
  55496. rc = walIndexReadHdr(pWal, pChanged);
  55497. }
  55498. if( rc==SQLITE_BUSY ){
  55499. /* If there is not a recovery running in another thread or process
  55500. ** then convert BUSY errors to WAL_RETRY. If recovery is known to
  55501. ** be running, convert BUSY to BUSY_RECOVERY. There is a race here
  55502. ** which might cause WAL_RETRY to be returned even if BUSY_RECOVERY
  55503. ** would be technically correct. But the race is benign since with
  55504. ** WAL_RETRY this routine will be called again and will probably be
  55505. ** right on the second iteration.
  55506. */
  55507. if( pWal->apWiData[0]==0 ){
  55508. /* This branch is taken when the xShmMap() method returns SQLITE_BUSY.
  55509. ** We assume this is a transient condition, so return WAL_RETRY. The
  55510. ** xShmMap() implementation used by the default unix and win32 VFS
  55511. ** modules may return SQLITE_BUSY due to a race condition in the
  55512. ** code that determines whether or not the shared-memory region
  55513. ** must be zeroed before the requested page is returned.
  55514. */
  55515. rc = WAL_RETRY;
  55516. }else if( SQLITE_OK==(rc = walLockShared(pWal, WAL_RECOVER_LOCK)) ){
  55517. walUnlockShared(pWal, WAL_RECOVER_LOCK);
  55518. rc = WAL_RETRY;
  55519. }else if( rc==SQLITE_BUSY ){
  55520. rc = SQLITE_BUSY_RECOVERY;
  55521. }
  55522. }
  55523. if( rc!=SQLITE_OK ){
  55524. return rc;
  55525. }
  55526. else if( pWal->bShmUnreliable ){
  55527. return walBeginShmUnreliable(pWal, pChanged);
  55528. }
  55529. }
  55530. assert( pWal->nWiData>0 );
  55531. assert( pWal->apWiData[0]!=0 );
  55532. pInfo = walCkptInfo(pWal);
  55533. if( !useWal && pInfo->nBackfill==pWal->hdr.mxFrame
  55534. #ifdef SQLITE_ENABLE_SNAPSHOT
  55535. && (pWal->pSnapshot==0 || pWal->hdr.mxFrame==0)
  55536. #endif
  55537. ){
  55538. /* The WAL has been completely backfilled (or it is empty).
  55539. ** and can be safely ignored.
  55540. */
  55541. rc = walLockShared(pWal, WAL_READ_LOCK(0));
  55542. walShmBarrier(pWal);
  55543. if( rc==SQLITE_OK ){
  55544. if( memcmp((void *)walIndexHdr(pWal), &pWal->hdr, sizeof(WalIndexHdr)) ){
  55545. /* It is not safe to allow the reader to continue here if frames
  55546. ** may have been appended to the log before READ_LOCK(0) was obtained.
  55547. ** When holding READ_LOCK(0), the reader ignores the entire log file,
  55548. ** which implies that the database file contains a trustworthy
  55549. ** snapshot. Since holding READ_LOCK(0) prevents a checkpoint from
  55550. ** happening, this is usually correct.
  55551. **
  55552. ** However, if frames have been appended to the log (or if the log
  55553. ** is wrapped and written for that matter) before the READ_LOCK(0)
  55554. ** is obtained, that is not necessarily true. A checkpointer may
  55555. ** have started to backfill the appended frames but crashed before
  55556. ** it finished. Leaving a corrupt image in the database file.
  55557. */
  55558. walUnlockShared(pWal, WAL_READ_LOCK(0));
  55559. return WAL_RETRY;
  55560. }
  55561. pWal->readLock = 0;
  55562. return SQLITE_OK;
  55563. }else if( rc!=SQLITE_BUSY ){
  55564. return rc;
  55565. }
  55566. }
  55567. /* If we get this far, it means that the reader will want to use
  55568. ** the WAL to get at content from recent commits. The job now is
  55569. ** to select one of the aReadMark[] entries that is closest to
  55570. ** but not exceeding pWal->hdr.mxFrame and lock that entry.
  55571. */
  55572. mxReadMark = 0;
  55573. mxI = 0;
  55574. mxFrame = pWal->hdr.mxFrame;
  55575. #ifdef SQLITE_ENABLE_SNAPSHOT
  55576. if( pWal->pSnapshot && pWal->pSnapshot->mxFrame<mxFrame ){
  55577. mxFrame = pWal->pSnapshot->mxFrame;
  55578. }
  55579. #endif
  55580. for(i=1; i<WAL_NREADER; i++){
  55581. u32 thisMark = pInfo->aReadMark[i];
  55582. if( mxReadMark<=thisMark && thisMark<=mxFrame ){
  55583. assert( thisMark!=READMARK_NOT_USED );
  55584. mxReadMark = thisMark;
  55585. mxI = i;
  55586. }
  55587. }
  55588. if( (pWal->readOnly & WAL_SHM_RDONLY)==0
  55589. && (mxReadMark<mxFrame || mxI==0)
  55590. ){
  55591. for(i=1; i<WAL_NREADER; i++){
  55592. rc = walLockExclusive(pWal, WAL_READ_LOCK(i), 1);
  55593. if( rc==SQLITE_OK ){
  55594. mxReadMark = pInfo->aReadMark[i] = mxFrame;
  55595. mxI = i;
  55596. walUnlockExclusive(pWal, WAL_READ_LOCK(i), 1);
  55597. break;
  55598. }else if( rc!=SQLITE_BUSY ){
  55599. return rc;
  55600. }
  55601. }
  55602. }
  55603. if( mxI==0 ){
  55604. assert( rc==SQLITE_BUSY || (pWal->readOnly & WAL_SHM_RDONLY)!=0 );
  55605. return rc==SQLITE_BUSY ? WAL_RETRY : SQLITE_READONLY_CANTINIT;
  55606. }
  55607. rc = walLockShared(pWal, WAL_READ_LOCK(mxI));
  55608. if( rc ){
  55609. return rc==SQLITE_BUSY ? WAL_RETRY : rc;
  55610. }
  55611. /* Now that the read-lock has been obtained, check that neither the
  55612. ** value in the aReadMark[] array or the contents of the wal-index
  55613. ** header have changed.
  55614. **
  55615. ** It is necessary to check that the wal-index header did not change
  55616. ** between the time it was read and when the shared-lock was obtained
  55617. ** on WAL_READ_LOCK(mxI) was obtained to account for the possibility
  55618. ** that the log file may have been wrapped by a writer, or that frames
  55619. ** that occur later in the log than pWal->hdr.mxFrame may have been
  55620. ** copied into the database by a checkpointer. If either of these things
  55621. ** happened, then reading the database with the current value of
  55622. ** pWal->hdr.mxFrame risks reading a corrupted snapshot. So, retry
  55623. ** instead.
  55624. **
  55625. ** Before checking that the live wal-index header has not changed
  55626. ** since it was read, set Wal.minFrame to the first frame in the wal
  55627. ** file that has not yet been checkpointed. This client will not need
  55628. ** to read any frames earlier than minFrame from the wal file - they
  55629. ** can be safely read directly from the database file.
  55630. **
  55631. ** Because a ShmBarrier() call is made between taking the copy of
  55632. ** nBackfill and checking that the wal-header in shared-memory still
  55633. ** matches the one cached in pWal->hdr, it is guaranteed that the
  55634. ** checkpointer that set nBackfill was not working with a wal-index
  55635. ** header newer than that cached in pWal->hdr. If it were, that could
  55636. ** cause a problem. The checkpointer could omit to checkpoint
  55637. ** a version of page X that lies before pWal->minFrame (call that version
  55638. ** A) on the basis that there is a newer version (version B) of the same
  55639. ** page later in the wal file. But if version B happens to like past
  55640. ** frame pWal->hdr.mxFrame - then the client would incorrectly assume
  55641. ** that it can read version A from the database file. However, since
  55642. ** we can guarantee that the checkpointer that set nBackfill could not
  55643. ** see any pages past pWal->hdr.mxFrame, this problem does not come up.
  55644. */
  55645. pWal->minFrame = pInfo->nBackfill+1;
  55646. walShmBarrier(pWal);
  55647. if( pInfo->aReadMark[mxI]!=mxReadMark
  55648. || memcmp((void *)walIndexHdr(pWal), &pWal->hdr, sizeof(WalIndexHdr))
  55649. ){
  55650. walUnlockShared(pWal, WAL_READ_LOCK(mxI));
  55651. return WAL_RETRY;
  55652. }else{
  55653. assert( mxReadMark<=pWal->hdr.mxFrame );
  55654. pWal->readLock = (i16)mxI;
  55655. }
  55656. return rc;
  55657. }
  55658. #ifdef SQLITE_ENABLE_SNAPSHOT
  55659. /*
  55660. ** Attempt to reduce the value of the WalCkptInfo.nBackfillAttempted
  55661. ** variable so that older snapshots can be accessed. To do this, loop
  55662. ** through all wal frames from nBackfillAttempted to (nBackfill+1),
  55663. ** comparing their content to the corresponding page with the database
  55664. ** file, if any. Set nBackfillAttempted to the frame number of the
  55665. ** first frame for which the wal file content matches the db file.
  55666. **
  55667. ** This is only really safe if the file-system is such that any page
  55668. ** writes made by earlier checkpointers were atomic operations, which
  55669. ** is not always true. It is also possible that nBackfillAttempted
  55670. ** may be left set to a value larger than expected, if a wal frame
  55671. ** contains content that duplicate of an earlier version of the same
  55672. ** page.
  55673. **
  55674. ** SQLITE_OK is returned if successful, or an SQLite error code if an
  55675. ** error occurs. It is not an error if nBackfillAttempted cannot be
  55676. ** decreased at all.
  55677. */
  55678. SQLITE_PRIVATE int sqlite3WalSnapshotRecover(Wal *pWal){
  55679. int rc;
  55680. assert( pWal->readLock>=0 );
  55681. rc = walLockExclusive(pWal, WAL_CKPT_LOCK, 1);
  55682. if( rc==SQLITE_OK ){
  55683. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  55684. int szPage = (int)pWal->szPage;
  55685. i64 szDb; /* Size of db file in bytes */
  55686. rc = sqlite3OsFileSize(pWal->pDbFd, &szDb);
  55687. if( rc==SQLITE_OK ){
  55688. void *pBuf1 = sqlite3_malloc(szPage);
  55689. void *pBuf2 = sqlite3_malloc(szPage);
  55690. if( pBuf1==0 || pBuf2==0 ){
  55691. rc = SQLITE_NOMEM;
  55692. }else{
  55693. u32 i = pInfo->nBackfillAttempted;
  55694. for(i=pInfo->nBackfillAttempted; i>pInfo->nBackfill; i--){
  55695. volatile ht_slot *dummy;
  55696. volatile u32 *aPgno; /* Array of page numbers */
  55697. u32 iZero; /* Frame corresponding to aPgno[0] */
  55698. u32 pgno; /* Page number in db file */
  55699. i64 iDbOff; /* Offset of db file entry */
  55700. i64 iWalOff; /* Offset of wal file entry */
  55701. rc = walHashGet(pWal, walFramePage(i), &dummy, &aPgno, &iZero);
  55702. if( rc!=SQLITE_OK ) break;
  55703. pgno = aPgno[i-iZero];
  55704. iDbOff = (i64)(pgno-1) * szPage;
  55705. if( iDbOff+szPage<=szDb ){
  55706. iWalOff = walFrameOffset(i, szPage) + WAL_FRAME_HDRSIZE;
  55707. rc = sqlite3OsRead(pWal->pWalFd, pBuf1, szPage, iWalOff);
  55708. if( rc==SQLITE_OK ){
  55709. rc = sqlite3OsRead(pWal->pDbFd, pBuf2, szPage, iDbOff);
  55710. }
  55711. if( rc!=SQLITE_OK || 0==memcmp(pBuf1, pBuf2, szPage) ){
  55712. break;
  55713. }
  55714. }
  55715. pInfo->nBackfillAttempted = i-1;
  55716. }
  55717. }
  55718. sqlite3_free(pBuf1);
  55719. sqlite3_free(pBuf2);
  55720. }
  55721. walUnlockExclusive(pWal, WAL_CKPT_LOCK, 1);
  55722. }
  55723. return rc;
  55724. }
  55725. #endif /* SQLITE_ENABLE_SNAPSHOT */
  55726. /*
  55727. ** Begin a read transaction on the database.
  55728. **
  55729. ** This routine used to be called sqlite3OpenSnapshot() and with good reason:
  55730. ** it takes a snapshot of the state of the WAL and wal-index for the current
  55731. ** instant in time. The current thread will continue to use this snapshot.
  55732. ** Other threads might append new content to the WAL and wal-index but
  55733. ** that extra content is ignored by the current thread.
  55734. **
  55735. ** If the database contents have changes since the previous read
  55736. ** transaction, then *pChanged is set to 1 before returning. The
  55737. ** Pager layer will use this to know that is cache is stale and
  55738. ** needs to be flushed.
  55739. */
  55740. SQLITE_PRIVATE int sqlite3WalBeginReadTransaction(Wal *pWal, int *pChanged){
  55741. int rc; /* Return code */
  55742. int cnt = 0; /* Number of TryBeginRead attempts */
  55743. #ifdef SQLITE_ENABLE_SNAPSHOT
  55744. int bChanged = 0;
  55745. WalIndexHdr *pSnapshot = pWal->pSnapshot;
  55746. if( pSnapshot && memcmp(pSnapshot, &pWal->hdr, sizeof(WalIndexHdr))!=0 ){
  55747. bChanged = 1;
  55748. }
  55749. #endif
  55750. do{
  55751. rc = walTryBeginRead(pWal, pChanged, 0, ++cnt);
  55752. }while( rc==WAL_RETRY );
  55753. testcase( (rc&0xff)==SQLITE_BUSY );
  55754. testcase( (rc&0xff)==SQLITE_IOERR );
  55755. testcase( rc==SQLITE_PROTOCOL );
  55756. testcase( rc==SQLITE_OK );
  55757. #ifdef SQLITE_ENABLE_SNAPSHOT
  55758. if( rc==SQLITE_OK ){
  55759. if( pSnapshot && memcmp(pSnapshot, &pWal->hdr, sizeof(WalIndexHdr))!=0 ){
  55760. /* At this point the client has a lock on an aReadMark[] slot holding
  55761. ** a value equal to or smaller than pSnapshot->mxFrame, but pWal->hdr
  55762. ** is populated with the wal-index header corresponding to the head
  55763. ** of the wal file. Verify that pSnapshot is still valid before
  55764. ** continuing. Reasons why pSnapshot might no longer be valid:
  55765. **
  55766. ** (1) The WAL file has been reset since the snapshot was taken.
  55767. ** In this case, the salt will have changed.
  55768. **
  55769. ** (2) A checkpoint as been attempted that wrote frames past
  55770. ** pSnapshot->mxFrame into the database file. Note that the
  55771. ** checkpoint need not have completed for this to cause problems.
  55772. */
  55773. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  55774. assert( pWal->readLock>0 || pWal->hdr.mxFrame==0 );
  55775. assert( pInfo->aReadMark[pWal->readLock]<=pSnapshot->mxFrame );
  55776. /* It is possible that there is a checkpointer thread running
  55777. ** concurrent with this code. If this is the case, it may be that the
  55778. ** checkpointer has already determined that it will checkpoint
  55779. ** snapshot X, where X is later in the wal file than pSnapshot, but
  55780. ** has not yet set the pInfo->nBackfillAttempted variable to indicate
  55781. ** its intent. To avoid the race condition this leads to, ensure that
  55782. ** there is no checkpointer process by taking a shared CKPT lock
  55783. ** before checking pInfo->nBackfillAttempted.
  55784. **
  55785. ** TODO: Does the aReadMark[] lock prevent a checkpointer from doing
  55786. ** this already?
  55787. */
  55788. rc = walLockShared(pWal, WAL_CKPT_LOCK);
  55789. if( rc==SQLITE_OK ){
  55790. /* Check that the wal file has not been wrapped. Assuming that it has
  55791. ** not, also check that no checkpointer has attempted to checkpoint any
  55792. ** frames beyond pSnapshot->mxFrame. If either of these conditions are
  55793. ** true, return SQLITE_BUSY_SNAPSHOT. Otherwise, overwrite pWal->hdr
  55794. ** with *pSnapshot and set *pChanged as appropriate for opening the
  55795. ** snapshot. */
  55796. if( !memcmp(pSnapshot->aSalt, pWal->hdr.aSalt, sizeof(pWal->hdr.aSalt))
  55797. && pSnapshot->mxFrame>=pInfo->nBackfillAttempted
  55798. ){
  55799. assert( pWal->readLock>0 );
  55800. memcpy(&pWal->hdr, pSnapshot, sizeof(WalIndexHdr));
  55801. *pChanged = bChanged;
  55802. }else{
  55803. rc = SQLITE_BUSY_SNAPSHOT;
  55804. }
  55805. /* Release the shared CKPT lock obtained above. */
  55806. walUnlockShared(pWal, WAL_CKPT_LOCK);
  55807. }
  55808. if( rc!=SQLITE_OK ){
  55809. sqlite3WalEndReadTransaction(pWal);
  55810. }
  55811. }
  55812. }
  55813. #endif
  55814. return rc;
  55815. }
  55816. /*
  55817. ** Finish with a read transaction. All this does is release the
  55818. ** read-lock.
  55819. */
  55820. SQLITE_PRIVATE void sqlite3WalEndReadTransaction(Wal *pWal){
  55821. sqlite3WalEndWriteTransaction(pWal);
  55822. if( pWal->readLock>=0 ){
  55823. walUnlockShared(pWal, WAL_READ_LOCK(pWal->readLock));
  55824. pWal->readLock = -1;
  55825. }
  55826. }
  55827. /*
  55828. ** Search the wal file for page pgno. If found, set *piRead to the frame that
  55829. ** contains the page. Otherwise, if pgno is not in the wal file, set *piRead
  55830. ** to zero.
  55831. **
  55832. ** Return SQLITE_OK if successful, or an error code if an error occurs. If an
  55833. ** error does occur, the final value of *piRead is undefined.
  55834. */
  55835. SQLITE_PRIVATE int sqlite3WalFindFrame(
  55836. Wal *pWal, /* WAL handle */
  55837. Pgno pgno, /* Database page number to read data for */
  55838. u32 *piRead /* OUT: Frame number (or zero) */
  55839. ){
  55840. u32 iRead = 0; /* If !=0, WAL frame to return data from */
  55841. u32 iLast = pWal->hdr.mxFrame; /* Last page in WAL for this reader */
  55842. int iHash; /* Used to loop through N hash tables */
  55843. int iMinHash;
  55844. /* This routine is only be called from within a read transaction. */
  55845. assert( pWal->readLock>=0 || pWal->lockError );
  55846. /* If the "last page" field of the wal-index header snapshot is 0, then
  55847. ** no data will be read from the wal under any circumstances. Return early
  55848. ** in this case as an optimization. Likewise, if pWal->readLock==0,
  55849. ** then the WAL is ignored by the reader so return early, as if the
  55850. ** WAL were empty.
  55851. */
  55852. if( iLast==0 || (pWal->readLock==0 && pWal->bShmUnreliable==0) ){
  55853. *piRead = 0;
  55854. return SQLITE_OK;
  55855. }
  55856. /* Search the hash table or tables for an entry matching page number
  55857. ** pgno. Each iteration of the following for() loop searches one
  55858. ** hash table (each hash table indexes up to HASHTABLE_NPAGE frames).
  55859. **
  55860. ** This code might run concurrently to the code in walIndexAppend()
  55861. ** that adds entries to the wal-index (and possibly to this hash
  55862. ** table). This means the value just read from the hash
  55863. ** slot (aHash[iKey]) may have been added before or after the
  55864. ** current read transaction was opened. Values added after the
  55865. ** read transaction was opened may have been written incorrectly -
  55866. ** i.e. these slots may contain garbage data. However, we assume
  55867. ** that any slots written before the current read transaction was
  55868. ** opened remain unmodified.
  55869. **
  55870. ** For the reasons above, the if(...) condition featured in the inner
  55871. ** loop of the following block is more stringent that would be required
  55872. ** if we had exclusive access to the hash-table:
  55873. **
  55874. ** (aPgno[iFrame]==pgno):
  55875. ** This condition filters out normal hash-table collisions.
  55876. **
  55877. ** (iFrame<=iLast):
  55878. ** This condition filters out entries that were added to the hash
  55879. ** table after the current read-transaction had started.
  55880. */
  55881. iMinHash = walFramePage(pWal->minFrame);
  55882. for(iHash=walFramePage(iLast); iHash>=iMinHash; iHash--){
  55883. volatile ht_slot *aHash; /* Pointer to hash table */
  55884. volatile u32 *aPgno; /* Pointer to array of page numbers */
  55885. u32 iZero; /* Frame number corresponding to aPgno[0] */
  55886. int iKey; /* Hash slot index */
  55887. int nCollide; /* Number of hash collisions remaining */
  55888. int rc; /* Error code */
  55889. rc = walHashGet(pWal, iHash, &aHash, &aPgno, &iZero);
  55890. if( rc!=SQLITE_OK ){
  55891. return rc;
  55892. }
  55893. nCollide = HASHTABLE_NSLOT;
  55894. for(iKey=walHash(pgno); aHash[iKey]; iKey=walNextHash(iKey)){
  55895. u32 iFrame = aHash[iKey] + iZero;
  55896. if( iFrame<=iLast && iFrame>=pWal->minFrame && aPgno[aHash[iKey]]==pgno ){
  55897. assert( iFrame>iRead || CORRUPT_DB );
  55898. iRead = iFrame;
  55899. }
  55900. if( (nCollide--)==0 ){
  55901. return SQLITE_CORRUPT_BKPT;
  55902. }
  55903. }
  55904. if( iRead ) break;
  55905. }
  55906. #ifdef SQLITE_ENABLE_EXPENSIVE_ASSERT
  55907. /* If expensive assert() statements are available, do a linear search
  55908. ** of the wal-index file content. Make sure the results agree with the
  55909. ** result obtained using the hash indexes above. */
  55910. {
  55911. u32 iRead2 = 0;
  55912. u32 iTest;
  55913. assert( pWal->bShmUnreliable || pWal->minFrame>0 );
  55914. for(iTest=iLast; iTest>=pWal->minFrame && iTest>0; iTest--){
  55915. if( walFramePgno(pWal, iTest)==pgno ){
  55916. iRead2 = iTest;
  55917. break;
  55918. }
  55919. }
  55920. assert( iRead==iRead2 );
  55921. }
  55922. #endif
  55923. *piRead = iRead;
  55924. return SQLITE_OK;
  55925. }
  55926. /*
  55927. ** Read the contents of frame iRead from the wal file into buffer pOut
  55928. ** (which is nOut bytes in size). Return SQLITE_OK if successful, or an
  55929. ** error code otherwise.
  55930. */
  55931. SQLITE_PRIVATE int sqlite3WalReadFrame(
  55932. Wal *pWal, /* WAL handle */
  55933. u32 iRead, /* Frame to read */
  55934. int nOut, /* Size of buffer pOut in bytes */
  55935. u8 *pOut /* Buffer to write page data to */
  55936. ){
  55937. int sz;
  55938. i64 iOffset;
  55939. sz = pWal->hdr.szPage;
  55940. sz = (sz&0xfe00) + ((sz&0x0001)<<16);
  55941. testcase( sz<=32768 );
  55942. testcase( sz>=65536 );
  55943. iOffset = walFrameOffset(iRead, sz) + WAL_FRAME_HDRSIZE;
  55944. /* testcase( IS_BIG_INT(iOffset) ); // requires a 4GiB WAL */
  55945. return sqlite3OsRead(pWal->pWalFd, pOut, (nOut>sz ? sz : nOut), iOffset);
  55946. }
  55947. /*
  55948. ** Return the size of the database in pages (or zero, if unknown).
  55949. */
  55950. SQLITE_PRIVATE Pgno sqlite3WalDbsize(Wal *pWal){
  55951. if( pWal && ALWAYS(pWal->readLock>=0) ){
  55952. return pWal->hdr.nPage;
  55953. }
  55954. return 0;
  55955. }
  55956. /*
  55957. ** This function starts a write transaction on the WAL.
  55958. **
  55959. ** A read transaction must have already been started by a prior call
  55960. ** to sqlite3WalBeginReadTransaction().
  55961. **
  55962. ** If another thread or process has written into the database since
  55963. ** the read transaction was started, then it is not possible for this
  55964. ** thread to write as doing so would cause a fork. So this routine
  55965. ** returns SQLITE_BUSY in that case and no write transaction is started.
  55966. **
  55967. ** There can only be a single writer active at a time.
  55968. */
  55969. SQLITE_PRIVATE int sqlite3WalBeginWriteTransaction(Wal *pWal){
  55970. int rc;
  55971. /* Cannot start a write transaction without first holding a read
  55972. ** transaction. */
  55973. assert( pWal->readLock>=0 );
  55974. assert( pWal->writeLock==0 && pWal->iReCksum==0 );
  55975. if( pWal->readOnly ){
  55976. return SQLITE_READONLY;
  55977. }
  55978. /* Only one writer allowed at a time. Get the write lock. Return
  55979. ** SQLITE_BUSY if unable.
  55980. */
  55981. rc = walLockExclusive(pWal, WAL_WRITE_LOCK, 1);
  55982. if( rc ){
  55983. return rc;
  55984. }
  55985. pWal->writeLock = 1;
  55986. /* If another connection has written to the database file since the
  55987. ** time the read transaction on this connection was started, then
  55988. ** the write is disallowed.
  55989. */
  55990. if( memcmp(&pWal->hdr, (void *)walIndexHdr(pWal), sizeof(WalIndexHdr))!=0 ){
  55991. walUnlockExclusive(pWal, WAL_WRITE_LOCK, 1);
  55992. pWal->writeLock = 0;
  55993. rc = SQLITE_BUSY_SNAPSHOT;
  55994. }
  55995. return rc;
  55996. }
  55997. /*
  55998. ** End a write transaction. The commit has already been done. This
  55999. ** routine merely releases the lock.
  56000. */
  56001. SQLITE_PRIVATE int sqlite3WalEndWriteTransaction(Wal *pWal){
  56002. if( pWal->writeLock ){
  56003. walUnlockExclusive(pWal, WAL_WRITE_LOCK, 1);
  56004. pWal->writeLock = 0;
  56005. pWal->iReCksum = 0;
  56006. pWal->truncateOnCommit = 0;
  56007. }
  56008. return SQLITE_OK;
  56009. }
  56010. /*
  56011. ** If any data has been written (but not committed) to the log file, this
  56012. ** function moves the write-pointer back to the start of the transaction.
  56013. **
  56014. ** Additionally, the callback function is invoked for each frame written
  56015. ** to the WAL since the start of the transaction. If the callback returns
  56016. ** other than SQLITE_OK, it is not invoked again and the error code is
  56017. ** returned to the caller.
  56018. **
  56019. ** Otherwise, if the callback function does not return an error, this
  56020. ** function returns SQLITE_OK.
  56021. */
  56022. SQLITE_PRIVATE int sqlite3WalUndo(Wal *pWal, int (*xUndo)(void *, Pgno), void *pUndoCtx){
  56023. int rc = SQLITE_OK;
  56024. if( ALWAYS(pWal->writeLock) ){
  56025. Pgno iMax = pWal->hdr.mxFrame;
  56026. Pgno iFrame;
  56027. /* Restore the clients cache of the wal-index header to the state it
  56028. ** was in before the client began writing to the database.
  56029. */
  56030. memcpy(&pWal->hdr, (void *)walIndexHdr(pWal), sizeof(WalIndexHdr));
  56031. for(iFrame=pWal->hdr.mxFrame+1;
  56032. ALWAYS(rc==SQLITE_OK) && iFrame<=iMax;
  56033. iFrame++
  56034. ){
  56035. /* This call cannot fail. Unless the page for which the page number
  56036. ** is passed as the second argument is (a) in the cache and
  56037. ** (b) has an outstanding reference, then xUndo is either a no-op
  56038. ** (if (a) is false) or simply expels the page from the cache (if (b)
  56039. ** is false).
  56040. **
  56041. ** If the upper layer is doing a rollback, it is guaranteed that there
  56042. ** are no outstanding references to any page other than page 1. And
  56043. ** page 1 is never written to the log until the transaction is
  56044. ** committed. As a result, the call to xUndo may not fail.
  56045. */
  56046. assert( walFramePgno(pWal, iFrame)!=1 );
  56047. rc = xUndo(pUndoCtx, walFramePgno(pWal, iFrame));
  56048. }
  56049. if( iMax!=pWal->hdr.mxFrame ) walCleanupHash(pWal);
  56050. }
  56051. return rc;
  56052. }
  56053. /*
  56054. ** Argument aWalData must point to an array of WAL_SAVEPOINT_NDATA u32
  56055. ** values. This function populates the array with values required to
  56056. ** "rollback" the write position of the WAL handle back to the current
  56057. ** point in the event of a savepoint rollback (via WalSavepointUndo()).
  56058. */
  56059. SQLITE_PRIVATE void sqlite3WalSavepoint(Wal *pWal, u32 *aWalData){
  56060. assert( pWal->writeLock );
  56061. aWalData[0] = pWal->hdr.mxFrame;
  56062. aWalData[1] = pWal->hdr.aFrameCksum[0];
  56063. aWalData[2] = pWal->hdr.aFrameCksum[1];
  56064. aWalData[3] = pWal->nCkpt;
  56065. }
  56066. /*
  56067. ** Move the write position of the WAL back to the point identified by
  56068. ** the values in the aWalData[] array. aWalData must point to an array
  56069. ** of WAL_SAVEPOINT_NDATA u32 values that has been previously populated
  56070. ** by a call to WalSavepoint().
  56071. */
  56072. SQLITE_PRIVATE int sqlite3WalSavepointUndo(Wal *pWal, u32 *aWalData){
  56073. int rc = SQLITE_OK;
  56074. assert( pWal->writeLock );
  56075. assert( aWalData[3]!=pWal->nCkpt || aWalData[0]<=pWal->hdr.mxFrame );
  56076. if( aWalData[3]!=pWal->nCkpt ){
  56077. /* This savepoint was opened immediately after the write-transaction
  56078. ** was started. Right after that, the writer decided to wrap around
  56079. ** to the start of the log. Update the savepoint values to match.
  56080. */
  56081. aWalData[0] = 0;
  56082. aWalData[3] = pWal->nCkpt;
  56083. }
  56084. if( aWalData[0]<pWal->hdr.mxFrame ){
  56085. pWal->hdr.mxFrame = aWalData[0];
  56086. pWal->hdr.aFrameCksum[0] = aWalData[1];
  56087. pWal->hdr.aFrameCksum[1] = aWalData[2];
  56088. walCleanupHash(pWal);
  56089. }
  56090. return rc;
  56091. }
  56092. /*
  56093. ** This function is called just before writing a set of frames to the log
  56094. ** file (see sqlite3WalFrames()). It checks to see if, instead of appending
  56095. ** to the current log file, it is possible to overwrite the start of the
  56096. ** existing log file with the new frames (i.e. "reset" the log). If so,
  56097. ** it sets pWal->hdr.mxFrame to 0. Otherwise, pWal->hdr.mxFrame is left
  56098. ** unchanged.
  56099. **
  56100. ** SQLITE_OK is returned if no error is encountered (regardless of whether
  56101. ** or not pWal->hdr.mxFrame is modified). An SQLite error code is returned
  56102. ** if an error occurs.
  56103. */
  56104. static int walRestartLog(Wal *pWal){
  56105. int rc = SQLITE_OK;
  56106. int cnt;
  56107. if( pWal->readLock==0 ){
  56108. volatile WalCkptInfo *pInfo = walCkptInfo(pWal);
  56109. assert( pInfo->nBackfill==pWal->hdr.mxFrame );
  56110. if( pInfo->nBackfill>0 ){
  56111. u32 salt1;
  56112. sqlite3_randomness(4, &salt1);
  56113. rc = walLockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  56114. if( rc==SQLITE_OK ){
  56115. /* If all readers are using WAL_READ_LOCK(0) (in other words if no
  56116. ** readers are currently using the WAL), then the transactions
  56117. ** frames will overwrite the start of the existing log. Update the
  56118. ** wal-index header to reflect this.
  56119. **
  56120. ** In theory it would be Ok to update the cache of the header only
  56121. ** at this point. But updating the actual wal-index header is also
  56122. ** safe and means there is no special case for sqlite3WalUndo()
  56123. ** to handle if this transaction is rolled back. */
  56124. walRestartHdr(pWal, salt1);
  56125. walUnlockExclusive(pWal, WAL_READ_LOCK(1), WAL_NREADER-1);
  56126. }else if( rc!=SQLITE_BUSY ){
  56127. return rc;
  56128. }
  56129. }
  56130. walUnlockShared(pWal, WAL_READ_LOCK(0));
  56131. pWal->readLock = -1;
  56132. cnt = 0;
  56133. do{
  56134. int notUsed;
  56135. rc = walTryBeginRead(pWal, &notUsed, 1, ++cnt);
  56136. }while( rc==WAL_RETRY );
  56137. assert( (rc&0xff)!=SQLITE_BUSY ); /* BUSY not possible when useWal==1 */
  56138. testcase( (rc&0xff)==SQLITE_IOERR );
  56139. testcase( rc==SQLITE_PROTOCOL );
  56140. testcase( rc==SQLITE_OK );
  56141. }
  56142. return rc;
  56143. }
  56144. /*
  56145. ** Information about the current state of the WAL file and where
  56146. ** the next fsync should occur - passed from sqlite3WalFrames() into
  56147. ** walWriteToLog().
  56148. */
  56149. typedef struct WalWriter {
  56150. Wal *pWal; /* The complete WAL information */
  56151. sqlite3_file *pFd; /* The WAL file to which we write */
  56152. sqlite3_int64 iSyncPoint; /* Fsync at this offset */
  56153. int syncFlags; /* Flags for the fsync */
  56154. int szPage; /* Size of one page */
  56155. } WalWriter;
  56156. /*
  56157. ** Write iAmt bytes of content into the WAL file beginning at iOffset.
  56158. ** Do a sync when crossing the p->iSyncPoint boundary.
  56159. **
  56160. ** In other words, if iSyncPoint is in between iOffset and iOffset+iAmt,
  56161. ** first write the part before iSyncPoint, then sync, then write the
  56162. ** rest.
  56163. */
  56164. static int walWriteToLog(
  56165. WalWriter *p, /* WAL to write to */
  56166. void *pContent, /* Content to be written */
  56167. int iAmt, /* Number of bytes to write */
  56168. sqlite3_int64 iOffset /* Start writing at this offset */
  56169. ){
  56170. int rc;
  56171. if( iOffset<p->iSyncPoint && iOffset+iAmt>=p->iSyncPoint ){
  56172. int iFirstAmt = (int)(p->iSyncPoint - iOffset);
  56173. rc = sqlite3OsWrite(p->pFd, pContent, iFirstAmt, iOffset);
  56174. if( rc ) return rc;
  56175. iOffset += iFirstAmt;
  56176. iAmt -= iFirstAmt;
  56177. pContent = (void*)(iFirstAmt + (char*)pContent);
  56178. assert( WAL_SYNC_FLAGS(p->syncFlags)!=0 );
  56179. rc = sqlite3OsSync(p->pFd, WAL_SYNC_FLAGS(p->syncFlags));
  56180. if( iAmt==0 || rc ) return rc;
  56181. }
  56182. rc = sqlite3OsWrite(p->pFd, pContent, iAmt, iOffset);
  56183. return rc;
  56184. }
  56185. /*
  56186. ** Write out a single frame of the WAL
  56187. */
  56188. static int walWriteOneFrame(
  56189. WalWriter *p, /* Where to write the frame */
  56190. PgHdr *pPage, /* The page of the frame to be written */
  56191. int nTruncate, /* The commit flag. Usually 0. >0 for commit */
  56192. sqlite3_int64 iOffset /* Byte offset at which to write */
  56193. ){
  56194. int rc; /* Result code from subfunctions */
  56195. void *pData; /* Data actually written */
  56196. u8 aFrame[WAL_FRAME_HDRSIZE]; /* Buffer to assemble frame-header in */
  56197. #if defined(SQLITE_HAS_CODEC)
  56198. if( (pData = sqlite3PagerCodec(pPage))==0 ) return SQLITE_NOMEM_BKPT;
  56199. #else
  56200. pData = pPage->pData;
  56201. #endif
  56202. walEncodeFrame(p->pWal, pPage->pgno, nTruncate, pData, aFrame);
  56203. rc = walWriteToLog(p, aFrame, sizeof(aFrame), iOffset);
  56204. if( rc ) return rc;
  56205. /* Write the page data */
  56206. rc = walWriteToLog(p, pData, p->szPage, iOffset+sizeof(aFrame));
  56207. return rc;
  56208. }
  56209. /*
  56210. ** This function is called as part of committing a transaction within which
  56211. ** one or more frames have been overwritten. It updates the checksums for
  56212. ** all frames written to the wal file by the current transaction starting
  56213. ** with the earliest to have been overwritten.
  56214. **
  56215. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  56216. */
  56217. static int walRewriteChecksums(Wal *pWal, u32 iLast){
  56218. const int szPage = pWal->szPage;/* Database page size */
  56219. int rc = SQLITE_OK; /* Return code */
  56220. u8 *aBuf; /* Buffer to load data from wal file into */
  56221. u8 aFrame[WAL_FRAME_HDRSIZE]; /* Buffer to assemble frame-headers in */
  56222. u32 iRead; /* Next frame to read from wal file */
  56223. i64 iCksumOff;
  56224. aBuf = sqlite3_malloc(szPage + WAL_FRAME_HDRSIZE);
  56225. if( aBuf==0 ) return SQLITE_NOMEM_BKPT;
  56226. /* Find the checksum values to use as input for the recalculating the
  56227. ** first checksum. If the first frame is frame 1 (implying that the current
  56228. ** transaction restarted the wal file), these values must be read from the
  56229. ** wal-file header. Otherwise, read them from the frame header of the
  56230. ** previous frame. */
  56231. assert( pWal->iReCksum>0 );
  56232. if( pWal->iReCksum==1 ){
  56233. iCksumOff = 24;
  56234. }else{
  56235. iCksumOff = walFrameOffset(pWal->iReCksum-1, szPage) + 16;
  56236. }
  56237. rc = sqlite3OsRead(pWal->pWalFd, aBuf, sizeof(u32)*2, iCksumOff);
  56238. pWal->hdr.aFrameCksum[0] = sqlite3Get4byte(aBuf);
  56239. pWal->hdr.aFrameCksum[1] = sqlite3Get4byte(&aBuf[sizeof(u32)]);
  56240. iRead = pWal->iReCksum;
  56241. pWal->iReCksum = 0;
  56242. for(; rc==SQLITE_OK && iRead<=iLast; iRead++){
  56243. i64 iOff = walFrameOffset(iRead, szPage);
  56244. rc = sqlite3OsRead(pWal->pWalFd, aBuf, szPage+WAL_FRAME_HDRSIZE, iOff);
  56245. if( rc==SQLITE_OK ){
  56246. u32 iPgno, nDbSize;
  56247. iPgno = sqlite3Get4byte(aBuf);
  56248. nDbSize = sqlite3Get4byte(&aBuf[4]);
  56249. walEncodeFrame(pWal, iPgno, nDbSize, &aBuf[WAL_FRAME_HDRSIZE], aFrame);
  56250. rc = sqlite3OsWrite(pWal->pWalFd, aFrame, sizeof(aFrame), iOff);
  56251. }
  56252. }
  56253. sqlite3_free(aBuf);
  56254. return rc;
  56255. }
  56256. /*
  56257. ** Write a set of frames to the log. The caller must hold the write-lock
  56258. ** on the log file (obtained using sqlite3WalBeginWriteTransaction()).
  56259. */
  56260. SQLITE_PRIVATE int sqlite3WalFrames(
  56261. Wal *pWal, /* Wal handle to write to */
  56262. int szPage, /* Database page-size in bytes */
  56263. PgHdr *pList, /* List of dirty pages to write */
  56264. Pgno nTruncate, /* Database size after this commit */
  56265. int isCommit, /* True if this is a commit */
  56266. int sync_flags /* Flags to pass to OsSync() (or 0) */
  56267. ){
  56268. int rc; /* Used to catch return codes */
  56269. u32 iFrame; /* Next frame address */
  56270. PgHdr *p; /* Iterator to run through pList with. */
  56271. PgHdr *pLast = 0; /* Last frame in list */
  56272. int nExtra = 0; /* Number of extra copies of last page */
  56273. int szFrame; /* The size of a single frame */
  56274. i64 iOffset; /* Next byte to write in WAL file */
  56275. WalWriter w; /* The writer */
  56276. u32 iFirst = 0; /* First frame that may be overwritten */
  56277. WalIndexHdr *pLive; /* Pointer to shared header */
  56278. assert( pList );
  56279. assert( pWal->writeLock );
  56280. /* If this frame set completes a transaction, then nTruncate>0. If
  56281. ** nTruncate==0 then this frame set does not complete the transaction. */
  56282. assert( (isCommit!=0)==(nTruncate!=0) );
  56283. #if defined(SQLITE_TEST) && defined(SQLITE_DEBUG)
  56284. { int cnt; for(cnt=0, p=pList; p; p=p->pDirty, cnt++){}
  56285. WALTRACE(("WAL%p: frame write begin. %d frames. mxFrame=%d. %s\n",
  56286. pWal, cnt, pWal->hdr.mxFrame, isCommit ? "Commit" : "Spill"));
  56287. }
  56288. #endif
  56289. pLive = (WalIndexHdr*)walIndexHdr(pWal);
  56290. if( memcmp(&pWal->hdr, (void *)pLive, sizeof(WalIndexHdr))!=0 ){
  56291. iFirst = pLive->mxFrame+1;
  56292. }
  56293. /* See if it is possible to write these frames into the start of the
  56294. ** log file, instead of appending to it at pWal->hdr.mxFrame.
  56295. */
  56296. if( SQLITE_OK!=(rc = walRestartLog(pWal)) ){
  56297. return rc;
  56298. }
  56299. /* If this is the first frame written into the log, write the WAL
  56300. ** header to the start of the WAL file. See comments at the top of
  56301. ** this source file for a description of the WAL header format.
  56302. */
  56303. iFrame = pWal->hdr.mxFrame;
  56304. if( iFrame==0 ){
  56305. u8 aWalHdr[WAL_HDRSIZE]; /* Buffer to assemble wal-header in */
  56306. u32 aCksum[2]; /* Checksum for wal-header */
  56307. sqlite3Put4byte(&aWalHdr[0], (WAL_MAGIC | SQLITE_BIGENDIAN));
  56308. sqlite3Put4byte(&aWalHdr[4], WAL_MAX_VERSION);
  56309. sqlite3Put4byte(&aWalHdr[8], szPage);
  56310. sqlite3Put4byte(&aWalHdr[12], pWal->nCkpt);
  56311. if( pWal->nCkpt==0 ) sqlite3_randomness(8, pWal->hdr.aSalt);
  56312. memcpy(&aWalHdr[16], pWal->hdr.aSalt, 8);
  56313. walChecksumBytes(1, aWalHdr, WAL_HDRSIZE-2*4, 0, aCksum);
  56314. sqlite3Put4byte(&aWalHdr[24], aCksum[0]);
  56315. sqlite3Put4byte(&aWalHdr[28], aCksum[1]);
  56316. pWal->szPage = szPage;
  56317. pWal->hdr.bigEndCksum = SQLITE_BIGENDIAN;
  56318. pWal->hdr.aFrameCksum[0] = aCksum[0];
  56319. pWal->hdr.aFrameCksum[1] = aCksum[1];
  56320. pWal->truncateOnCommit = 1;
  56321. rc = sqlite3OsWrite(pWal->pWalFd, aWalHdr, sizeof(aWalHdr), 0);
  56322. WALTRACE(("WAL%p: wal-header write %s\n", pWal, rc ? "failed" : "ok"));
  56323. if( rc!=SQLITE_OK ){
  56324. return rc;
  56325. }
  56326. /* Sync the header (unless SQLITE_IOCAP_SEQUENTIAL is true or unless
  56327. ** all syncing is turned off by PRAGMA synchronous=OFF). Otherwise
  56328. ** an out-of-order write following a WAL restart could result in
  56329. ** database corruption. See the ticket:
  56330. **
  56331. ** https://sqlite.org/src/info/ff5be73dee
  56332. */
  56333. if( pWal->syncHeader ){
  56334. rc = sqlite3OsSync(pWal->pWalFd, CKPT_SYNC_FLAGS(sync_flags));
  56335. if( rc ) return rc;
  56336. }
  56337. }
  56338. assert( (int)pWal->szPage==szPage );
  56339. /* Setup information needed to write frames into the WAL */
  56340. w.pWal = pWal;
  56341. w.pFd = pWal->pWalFd;
  56342. w.iSyncPoint = 0;
  56343. w.syncFlags = sync_flags;
  56344. w.szPage = szPage;
  56345. iOffset = walFrameOffset(iFrame+1, szPage);
  56346. szFrame = szPage + WAL_FRAME_HDRSIZE;
  56347. /* Write all frames into the log file exactly once */
  56348. for(p=pList; p; p=p->pDirty){
  56349. int nDbSize; /* 0 normally. Positive == commit flag */
  56350. /* Check if this page has already been written into the wal file by
  56351. ** the current transaction. If so, overwrite the existing frame and
  56352. ** set Wal.writeLock to WAL_WRITELOCK_RECKSUM - indicating that
  56353. ** checksums must be recomputed when the transaction is committed. */
  56354. if( iFirst && (p->pDirty || isCommit==0) ){
  56355. u32 iWrite = 0;
  56356. VVA_ONLY(rc =) sqlite3WalFindFrame(pWal, p->pgno, &iWrite);
  56357. assert( rc==SQLITE_OK || iWrite==0 );
  56358. if( iWrite>=iFirst ){
  56359. i64 iOff = walFrameOffset(iWrite, szPage) + WAL_FRAME_HDRSIZE;
  56360. void *pData;
  56361. if( pWal->iReCksum==0 || iWrite<pWal->iReCksum ){
  56362. pWal->iReCksum = iWrite;
  56363. }
  56364. #if defined(SQLITE_HAS_CODEC)
  56365. if( (pData = sqlite3PagerCodec(p))==0 ) return SQLITE_NOMEM;
  56366. #else
  56367. pData = p->pData;
  56368. #endif
  56369. rc = sqlite3OsWrite(pWal->pWalFd, pData, szPage, iOff);
  56370. if( rc ) return rc;
  56371. p->flags &= ~PGHDR_WAL_APPEND;
  56372. continue;
  56373. }
  56374. }
  56375. iFrame++;
  56376. assert( iOffset==walFrameOffset(iFrame, szPage) );
  56377. nDbSize = (isCommit && p->pDirty==0) ? nTruncate : 0;
  56378. rc = walWriteOneFrame(&w, p, nDbSize, iOffset);
  56379. if( rc ) return rc;
  56380. pLast = p;
  56381. iOffset += szFrame;
  56382. p->flags |= PGHDR_WAL_APPEND;
  56383. }
  56384. /* Recalculate checksums within the wal file if required. */
  56385. if( isCommit && pWal->iReCksum ){
  56386. rc = walRewriteChecksums(pWal, iFrame);
  56387. if( rc ) return rc;
  56388. }
  56389. /* If this is the end of a transaction, then we might need to pad
  56390. ** the transaction and/or sync the WAL file.
  56391. **
  56392. ** Padding and syncing only occur if this set of frames complete a
  56393. ** transaction and if PRAGMA synchronous=FULL. If synchronous==NORMAL
  56394. ** or synchronous==OFF, then no padding or syncing are needed.
  56395. **
  56396. ** If SQLITE_IOCAP_POWERSAFE_OVERWRITE is defined, then padding is not
  56397. ** needed and only the sync is done. If padding is needed, then the
  56398. ** final frame is repeated (with its commit mark) until the next sector
  56399. ** boundary is crossed. Only the part of the WAL prior to the last
  56400. ** sector boundary is synced; the part of the last frame that extends
  56401. ** past the sector boundary is written after the sync.
  56402. */
  56403. if( isCommit && WAL_SYNC_FLAGS(sync_flags)!=0 ){
  56404. int bSync = 1;
  56405. if( pWal->padToSectorBoundary ){
  56406. int sectorSize = sqlite3SectorSize(pWal->pWalFd);
  56407. w.iSyncPoint = ((iOffset+sectorSize-1)/sectorSize)*sectorSize;
  56408. bSync = (w.iSyncPoint==iOffset);
  56409. testcase( bSync );
  56410. while( iOffset<w.iSyncPoint ){
  56411. rc = walWriteOneFrame(&w, pLast, nTruncate, iOffset);
  56412. if( rc ) return rc;
  56413. iOffset += szFrame;
  56414. nExtra++;
  56415. }
  56416. }
  56417. if( bSync ){
  56418. assert( rc==SQLITE_OK );
  56419. rc = sqlite3OsSync(w.pFd, WAL_SYNC_FLAGS(sync_flags));
  56420. }
  56421. }
  56422. /* If this frame set completes the first transaction in the WAL and
  56423. ** if PRAGMA journal_size_limit is set, then truncate the WAL to the
  56424. ** journal size limit, if possible.
  56425. */
  56426. if( isCommit && pWal->truncateOnCommit && pWal->mxWalSize>=0 ){
  56427. i64 sz = pWal->mxWalSize;
  56428. if( walFrameOffset(iFrame+nExtra+1, szPage)>pWal->mxWalSize ){
  56429. sz = walFrameOffset(iFrame+nExtra+1, szPage);
  56430. }
  56431. walLimitSize(pWal, sz);
  56432. pWal->truncateOnCommit = 0;
  56433. }
  56434. /* Append data to the wal-index. It is not necessary to lock the
  56435. ** wal-index to do this as the SQLITE_SHM_WRITE lock held on the wal-index
  56436. ** guarantees that there are no other writers, and no data that may
  56437. ** be in use by existing readers is being overwritten.
  56438. */
  56439. iFrame = pWal->hdr.mxFrame;
  56440. for(p=pList; p && rc==SQLITE_OK; p=p->pDirty){
  56441. if( (p->flags & PGHDR_WAL_APPEND)==0 ) continue;
  56442. iFrame++;
  56443. rc = walIndexAppend(pWal, iFrame, p->pgno);
  56444. }
  56445. while( rc==SQLITE_OK && nExtra>0 ){
  56446. iFrame++;
  56447. nExtra--;
  56448. rc = walIndexAppend(pWal, iFrame, pLast->pgno);
  56449. }
  56450. if( rc==SQLITE_OK ){
  56451. /* Update the private copy of the header. */
  56452. pWal->hdr.szPage = (u16)((szPage&0xff00) | (szPage>>16));
  56453. testcase( szPage<=32768 );
  56454. testcase( szPage>=65536 );
  56455. pWal->hdr.mxFrame = iFrame;
  56456. if( isCommit ){
  56457. pWal->hdr.iChange++;
  56458. pWal->hdr.nPage = nTruncate;
  56459. }
  56460. /* If this is a commit, update the wal-index header too. */
  56461. if( isCommit ){
  56462. walIndexWriteHdr(pWal);
  56463. pWal->iCallback = iFrame;
  56464. }
  56465. }
  56466. WALTRACE(("WAL%p: frame write %s\n", pWal, rc ? "failed" : "ok"));
  56467. return rc;
  56468. }
  56469. /*
  56470. ** This routine is called to implement sqlite3_wal_checkpoint() and
  56471. ** related interfaces.
  56472. **
  56473. ** Obtain a CHECKPOINT lock and then backfill as much information as
  56474. ** we can from WAL into the database.
  56475. **
  56476. ** If parameter xBusy is not NULL, it is a pointer to a busy-handler
  56477. ** callback. In this case this function runs a blocking checkpoint.
  56478. */
  56479. SQLITE_PRIVATE int sqlite3WalCheckpoint(
  56480. Wal *pWal, /* Wal connection */
  56481. sqlite3 *db, /* Check this handle's interrupt flag */
  56482. int eMode, /* PASSIVE, FULL, RESTART, or TRUNCATE */
  56483. int (*xBusy)(void*), /* Function to call when busy */
  56484. void *pBusyArg, /* Context argument for xBusyHandler */
  56485. int sync_flags, /* Flags to sync db file with (or 0) */
  56486. int nBuf, /* Size of temporary buffer */
  56487. u8 *zBuf, /* Temporary buffer to use */
  56488. int *pnLog, /* OUT: Number of frames in WAL */
  56489. int *pnCkpt /* OUT: Number of backfilled frames in WAL */
  56490. ){
  56491. int rc; /* Return code */
  56492. int isChanged = 0; /* True if a new wal-index header is loaded */
  56493. int eMode2 = eMode; /* Mode to pass to walCheckpoint() */
  56494. int (*xBusy2)(void*) = xBusy; /* Busy handler for eMode2 */
  56495. assert( pWal->ckptLock==0 );
  56496. assert( pWal->writeLock==0 );
  56497. /* EVIDENCE-OF: R-62920-47450 The busy-handler callback is never invoked
  56498. ** in the SQLITE_CHECKPOINT_PASSIVE mode. */
  56499. assert( eMode!=SQLITE_CHECKPOINT_PASSIVE || xBusy==0 );
  56500. if( pWal->readOnly ) return SQLITE_READONLY;
  56501. WALTRACE(("WAL%p: checkpoint begins\n", pWal));
  56502. /* IMPLEMENTATION-OF: R-62028-47212 All calls obtain an exclusive
  56503. ** "checkpoint" lock on the database file. */
  56504. rc = walLockExclusive(pWal, WAL_CKPT_LOCK, 1);
  56505. if( rc ){
  56506. /* EVIDENCE-OF: R-10421-19736 If any other process is running a
  56507. ** checkpoint operation at the same time, the lock cannot be obtained and
  56508. ** SQLITE_BUSY is returned.
  56509. ** EVIDENCE-OF: R-53820-33897 Even if there is a busy-handler configured,
  56510. ** it will not be invoked in this case.
  56511. */
  56512. testcase( rc==SQLITE_BUSY );
  56513. testcase( xBusy!=0 );
  56514. return rc;
  56515. }
  56516. pWal->ckptLock = 1;
  56517. /* IMPLEMENTATION-OF: R-59782-36818 The SQLITE_CHECKPOINT_FULL, RESTART and
  56518. ** TRUNCATE modes also obtain the exclusive "writer" lock on the database
  56519. ** file.
  56520. **
  56521. ** EVIDENCE-OF: R-60642-04082 If the writer lock cannot be obtained
  56522. ** immediately, and a busy-handler is configured, it is invoked and the
  56523. ** writer lock retried until either the busy-handler returns 0 or the
  56524. ** lock is successfully obtained.
  56525. */
  56526. if( eMode!=SQLITE_CHECKPOINT_PASSIVE ){
  56527. rc = walBusyLock(pWal, xBusy, pBusyArg, WAL_WRITE_LOCK, 1);
  56528. if( rc==SQLITE_OK ){
  56529. pWal->writeLock = 1;
  56530. }else if( rc==SQLITE_BUSY ){
  56531. eMode2 = SQLITE_CHECKPOINT_PASSIVE;
  56532. xBusy2 = 0;
  56533. rc = SQLITE_OK;
  56534. }
  56535. }
  56536. /* Read the wal-index header. */
  56537. if( rc==SQLITE_OK ){
  56538. rc = walIndexReadHdr(pWal, &isChanged);
  56539. if( isChanged && pWal->pDbFd->pMethods->iVersion>=3 ){
  56540. sqlite3OsUnfetch(pWal->pDbFd, 0, 0);
  56541. }
  56542. }
  56543. /* Copy data from the log to the database file. */
  56544. if( rc==SQLITE_OK ){
  56545. if( pWal->hdr.mxFrame && walPagesize(pWal)!=nBuf ){
  56546. rc = SQLITE_CORRUPT_BKPT;
  56547. }else{
  56548. rc = walCheckpoint(pWal, db, eMode2, xBusy2, pBusyArg, sync_flags, zBuf);
  56549. }
  56550. /* If no error occurred, set the output variables. */
  56551. if( rc==SQLITE_OK || rc==SQLITE_BUSY ){
  56552. if( pnLog ) *pnLog = (int)pWal->hdr.mxFrame;
  56553. if( pnCkpt ) *pnCkpt = (int)(walCkptInfo(pWal)->nBackfill);
  56554. }
  56555. }
  56556. if( isChanged ){
  56557. /* If a new wal-index header was loaded before the checkpoint was
  56558. ** performed, then the pager-cache associated with pWal is now
  56559. ** out of date. So zero the cached wal-index header to ensure that
  56560. ** next time the pager opens a snapshot on this database it knows that
  56561. ** the cache needs to be reset.
  56562. */
  56563. memset(&pWal->hdr, 0, sizeof(WalIndexHdr));
  56564. }
  56565. /* Release the locks. */
  56566. sqlite3WalEndWriteTransaction(pWal);
  56567. walUnlockExclusive(pWal, WAL_CKPT_LOCK, 1);
  56568. pWal->ckptLock = 0;
  56569. WALTRACE(("WAL%p: checkpoint %s\n", pWal, rc ? "failed" : "ok"));
  56570. return (rc==SQLITE_OK && eMode!=eMode2 ? SQLITE_BUSY : rc);
  56571. }
  56572. /* Return the value to pass to a sqlite3_wal_hook callback, the
  56573. ** number of frames in the WAL at the point of the last commit since
  56574. ** sqlite3WalCallback() was called. If no commits have occurred since
  56575. ** the last call, then return 0.
  56576. */
  56577. SQLITE_PRIVATE int sqlite3WalCallback(Wal *pWal){
  56578. u32 ret = 0;
  56579. if( pWal ){
  56580. ret = pWal->iCallback;
  56581. pWal->iCallback = 0;
  56582. }
  56583. return (int)ret;
  56584. }
  56585. /*
  56586. ** This function is called to change the WAL subsystem into or out
  56587. ** of locking_mode=EXCLUSIVE.
  56588. **
  56589. ** If op is zero, then attempt to change from locking_mode=EXCLUSIVE
  56590. ** into locking_mode=NORMAL. This means that we must acquire a lock
  56591. ** on the pWal->readLock byte. If the WAL is already in locking_mode=NORMAL
  56592. ** or if the acquisition of the lock fails, then return 0. If the
  56593. ** transition out of exclusive-mode is successful, return 1. This
  56594. ** operation must occur while the pager is still holding the exclusive
  56595. ** lock on the main database file.
  56596. **
  56597. ** If op is one, then change from locking_mode=NORMAL into
  56598. ** locking_mode=EXCLUSIVE. This means that the pWal->readLock must
  56599. ** be released. Return 1 if the transition is made and 0 if the
  56600. ** WAL is already in exclusive-locking mode - meaning that this
  56601. ** routine is a no-op. The pager must already hold the exclusive lock
  56602. ** on the main database file before invoking this operation.
  56603. **
  56604. ** If op is negative, then do a dry-run of the op==1 case but do
  56605. ** not actually change anything. The pager uses this to see if it
  56606. ** should acquire the database exclusive lock prior to invoking
  56607. ** the op==1 case.
  56608. */
  56609. SQLITE_PRIVATE int sqlite3WalExclusiveMode(Wal *pWal, int op){
  56610. int rc;
  56611. assert( pWal->writeLock==0 );
  56612. assert( pWal->exclusiveMode!=WAL_HEAPMEMORY_MODE || op==-1 );
  56613. /* pWal->readLock is usually set, but might be -1 if there was a
  56614. ** prior error while attempting to acquire are read-lock. This cannot
  56615. ** happen if the connection is actually in exclusive mode (as no xShmLock
  56616. ** locks are taken in this case). Nor should the pager attempt to
  56617. ** upgrade to exclusive-mode following such an error.
  56618. */
  56619. assert( pWal->readLock>=0 || pWal->lockError );
  56620. assert( pWal->readLock>=0 || (op<=0 && pWal->exclusiveMode==0) );
  56621. if( op==0 ){
  56622. if( pWal->exclusiveMode!=WAL_NORMAL_MODE ){
  56623. pWal->exclusiveMode = WAL_NORMAL_MODE;
  56624. if( walLockShared(pWal, WAL_READ_LOCK(pWal->readLock))!=SQLITE_OK ){
  56625. pWal->exclusiveMode = WAL_EXCLUSIVE_MODE;
  56626. }
  56627. rc = pWal->exclusiveMode==WAL_NORMAL_MODE;
  56628. }else{
  56629. /* Already in locking_mode=NORMAL */
  56630. rc = 0;
  56631. }
  56632. }else if( op>0 ){
  56633. assert( pWal->exclusiveMode==WAL_NORMAL_MODE );
  56634. assert( pWal->readLock>=0 );
  56635. walUnlockShared(pWal, WAL_READ_LOCK(pWal->readLock));
  56636. pWal->exclusiveMode = WAL_EXCLUSIVE_MODE;
  56637. rc = 1;
  56638. }else{
  56639. rc = pWal->exclusiveMode==WAL_NORMAL_MODE;
  56640. }
  56641. return rc;
  56642. }
  56643. /*
  56644. ** Return true if the argument is non-NULL and the WAL module is using
  56645. ** heap-memory for the wal-index. Otherwise, if the argument is NULL or the
  56646. ** WAL module is using shared-memory, return false.
  56647. */
  56648. SQLITE_PRIVATE int sqlite3WalHeapMemory(Wal *pWal){
  56649. return (pWal && pWal->exclusiveMode==WAL_HEAPMEMORY_MODE );
  56650. }
  56651. #ifdef SQLITE_ENABLE_SNAPSHOT
  56652. /* Create a snapshot object. The content of a snapshot is opaque to
  56653. ** every other subsystem, so the WAL module can put whatever it needs
  56654. ** in the object.
  56655. */
  56656. SQLITE_PRIVATE int sqlite3WalSnapshotGet(Wal *pWal, sqlite3_snapshot **ppSnapshot){
  56657. int rc = SQLITE_OK;
  56658. WalIndexHdr *pRet;
  56659. static const u32 aZero[4] = { 0, 0, 0, 0 };
  56660. assert( pWal->readLock>=0 && pWal->writeLock==0 );
  56661. if( memcmp(&pWal->hdr.aFrameCksum[0],aZero,16)==0 ){
  56662. *ppSnapshot = 0;
  56663. return SQLITE_ERROR;
  56664. }
  56665. pRet = (WalIndexHdr*)sqlite3_malloc(sizeof(WalIndexHdr));
  56666. if( pRet==0 ){
  56667. rc = SQLITE_NOMEM_BKPT;
  56668. }else{
  56669. memcpy(pRet, &pWal->hdr, sizeof(WalIndexHdr));
  56670. *ppSnapshot = (sqlite3_snapshot*)pRet;
  56671. }
  56672. return rc;
  56673. }
  56674. /* Try to open on pSnapshot when the next read-transaction starts
  56675. */
  56676. SQLITE_PRIVATE void sqlite3WalSnapshotOpen(Wal *pWal, sqlite3_snapshot *pSnapshot){
  56677. pWal->pSnapshot = (WalIndexHdr*)pSnapshot;
  56678. }
  56679. /*
  56680. ** Return a +ve value if snapshot p1 is newer than p2. A -ve value if
  56681. ** p1 is older than p2 and zero if p1 and p2 are the same snapshot.
  56682. */
  56683. SQLITE_API int sqlite3_snapshot_cmp(sqlite3_snapshot *p1, sqlite3_snapshot *p2){
  56684. WalIndexHdr *pHdr1 = (WalIndexHdr*)p1;
  56685. WalIndexHdr *pHdr2 = (WalIndexHdr*)p2;
  56686. /* aSalt[0] is a copy of the value stored in the wal file header. It
  56687. ** is incremented each time the wal file is restarted. */
  56688. if( pHdr1->aSalt[0]<pHdr2->aSalt[0] ) return -1;
  56689. if( pHdr1->aSalt[0]>pHdr2->aSalt[0] ) return +1;
  56690. if( pHdr1->mxFrame<pHdr2->mxFrame ) return -1;
  56691. if( pHdr1->mxFrame>pHdr2->mxFrame ) return +1;
  56692. return 0;
  56693. }
  56694. #endif /* SQLITE_ENABLE_SNAPSHOT */
  56695. #ifdef SQLITE_ENABLE_ZIPVFS
  56696. /*
  56697. ** If the argument is not NULL, it points to a Wal object that holds a
  56698. ** read-lock. This function returns the database page-size if it is known,
  56699. ** or zero if it is not (or if pWal is NULL).
  56700. */
  56701. SQLITE_PRIVATE int sqlite3WalFramesize(Wal *pWal){
  56702. assert( pWal==0 || pWal->readLock>=0 );
  56703. return (pWal ? pWal->szPage : 0);
  56704. }
  56705. #endif
  56706. /* Return the sqlite3_file object for the WAL file
  56707. */
  56708. SQLITE_PRIVATE sqlite3_file *sqlite3WalFile(Wal *pWal){
  56709. return pWal->pWalFd;
  56710. }
  56711. #endif /* #ifndef SQLITE_OMIT_WAL */
  56712. /************** End of wal.c *************************************************/
  56713. /************** Begin file btmutex.c *****************************************/
  56714. /*
  56715. ** 2007 August 27
  56716. **
  56717. ** The author disclaims copyright to this source code. In place of
  56718. ** a legal notice, here is a blessing:
  56719. **
  56720. ** May you do good and not evil.
  56721. ** May you find forgiveness for yourself and forgive others.
  56722. ** May you share freely, never taking more than you give.
  56723. **
  56724. *************************************************************************
  56725. **
  56726. ** This file contains code used to implement mutexes on Btree objects.
  56727. ** This code really belongs in btree.c. But btree.c is getting too
  56728. ** big and we want to break it down some. This packaged seemed like
  56729. ** a good breakout.
  56730. */
  56731. /************** Include btreeInt.h in the middle of btmutex.c ****************/
  56732. /************** Begin file btreeInt.h ****************************************/
  56733. /*
  56734. ** 2004 April 6
  56735. **
  56736. ** The author disclaims copyright to this source code. In place of
  56737. ** a legal notice, here is a blessing:
  56738. **
  56739. ** May you do good and not evil.
  56740. ** May you find forgiveness for yourself and forgive others.
  56741. ** May you share freely, never taking more than you give.
  56742. **
  56743. *************************************************************************
  56744. ** This file implements an external (disk-based) database using BTrees.
  56745. ** For a detailed discussion of BTrees, refer to
  56746. **
  56747. ** Donald E. Knuth, THE ART OF COMPUTER PROGRAMMING, Volume 3:
  56748. ** "Sorting And Searching", pages 473-480. Addison-Wesley
  56749. ** Publishing Company, Reading, Massachusetts.
  56750. **
  56751. ** The basic idea is that each page of the file contains N database
  56752. ** entries and N+1 pointers to subpages.
  56753. **
  56754. ** ----------------------------------------------------------------
  56755. ** | Ptr(0) | Key(0) | Ptr(1) | Key(1) | ... | Key(N-1) | Ptr(N) |
  56756. ** ----------------------------------------------------------------
  56757. **
  56758. ** All of the keys on the page that Ptr(0) points to have values less
  56759. ** than Key(0). All of the keys on page Ptr(1) and its subpages have
  56760. ** values greater than Key(0) and less than Key(1). All of the keys
  56761. ** on Ptr(N) and its subpages have values greater than Key(N-1). And
  56762. ** so forth.
  56763. **
  56764. ** Finding a particular key requires reading O(log(M)) pages from the
  56765. ** disk where M is the number of entries in the tree.
  56766. **
  56767. ** In this implementation, a single file can hold one or more separate
  56768. ** BTrees. Each BTree is identified by the index of its root page. The
  56769. ** key and data for any entry are combined to form the "payload". A
  56770. ** fixed amount of payload can be carried directly on the database
  56771. ** page. If the payload is larger than the preset amount then surplus
  56772. ** bytes are stored on overflow pages. The payload for an entry
  56773. ** and the preceding pointer are combined to form a "Cell". Each
  56774. ** page has a small header which contains the Ptr(N) pointer and other
  56775. ** information such as the size of key and data.
  56776. **
  56777. ** FORMAT DETAILS
  56778. **
  56779. ** The file is divided into pages. The first page is called page 1,
  56780. ** the second is page 2, and so forth. A page number of zero indicates
  56781. ** "no such page". The page size can be any power of 2 between 512 and 65536.
  56782. ** Each page can be either a btree page, a freelist page, an overflow
  56783. ** page, or a pointer-map page.
  56784. **
  56785. ** The first page is always a btree page. The first 100 bytes of the first
  56786. ** page contain a special header (the "file header") that describes the file.
  56787. ** The format of the file header is as follows:
  56788. **
  56789. ** OFFSET SIZE DESCRIPTION
  56790. ** 0 16 Header string: "SQLite format 3\000"
  56791. ** 16 2 Page size in bytes. (1 means 65536)
  56792. ** 18 1 File format write version
  56793. ** 19 1 File format read version
  56794. ** 20 1 Bytes of unused space at the end of each page
  56795. ** 21 1 Max embedded payload fraction (must be 64)
  56796. ** 22 1 Min embedded payload fraction (must be 32)
  56797. ** 23 1 Min leaf payload fraction (must be 32)
  56798. ** 24 4 File change counter
  56799. ** 28 4 Reserved for future use
  56800. ** 32 4 First freelist page
  56801. ** 36 4 Number of freelist pages in the file
  56802. ** 40 60 15 4-byte meta values passed to higher layers
  56803. **
  56804. ** 40 4 Schema cookie
  56805. ** 44 4 File format of schema layer
  56806. ** 48 4 Size of page cache
  56807. ** 52 4 Largest root-page (auto/incr_vacuum)
  56808. ** 56 4 1=UTF-8 2=UTF16le 3=UTF16be
  56809. ** 60 4 User version
  56810. ** 64 4 Incremental vacuum mode
  56811. ** 68 4 Application-ID
  56812. ** 72 20 unused
  56813. ** 92 4 The version-valid-for number
  56814. ** 96 4 SQLITE_VERSION_NUMBER
  56815. **
  56816. ** All of the integer values are big-endian (most significant byte first).
  56817. **
  56818. ** The file change counter is incremented when the database is changed
  56819. ** This counter allows other processes to know when the file has changed
  56820. ** and thus when they need to flush their cache.
  56821. **
  56822. ** The max embedded payload fraction is the amount of the total usable
  56823. ** space in a page that can be consumed by a single cell for standard
  56824. ** B-tree (non-LEAFDATA) tables. A value of 255 means 100%. The default
  56825. ** is to limit the maximum cell size so that at least 4 cells will fit
  56826. ** on one page. Thus the default max embedded payload fraction is 64.
  56827. **
  56828. ** If the payload for a cell is larger than the max payload, then extra
  56829. ** payload is spilled to overflow pages. Once an overflow page is allocated,
  56830. ** as many bytes as possible are moved into the overflow pages without letting
  56831. ** the cell size drop below the min embedded payload fraction.
  56832. **
  56833. ** The min leaf payload fraction is like the min embedded payload fraction
  56834. ** except that it applies to leaf nodes in a LEAFDATA tree. The maximum
  56835. ** payload fraction for a LEAFDATA tree is always 100% (or 255) and it
  56836. ** not specified in the header.
  56837. **
  56838. ** Each btree pages is divided into three sections: The header, the
  56839. ** cell pointer array, and the cell content area. Page 1 also has a 100-byte
  56840. ** file header that occurs before the page header.
  56841. **
  56842. ** |----------------|
  56843. ** | file header | 100 bytes. Page 1 only.
  56844. ** |----------------|
  56845. ** | page header | 8 bytes for leaves. 12 bytes for interior nodes
  56846. ** |----------------|
  56847. ** | cell pointer | | 2 bytes per cell. Sorted order.
  56848. ** | array | | Grows downward
  56849. ** | | v
  56850. ** |----------------|
  56851. ** | unallocated |
  56852. ** | space |
  56853. ** |----------------| ^ Grows upwards
  56854. ** | cell content | | Arbitrary order interspersed with freeblocks.
  56855. ** | area | | and free space fragments.
  56856. ** |----------------|
  56857. **
  56858. ** The page headers looks like this:
  56859. **
  56860. ** OFFSET SIZE DESCRIPTION
  56861. ** 0 1 Flags. 1: intkey, 2: zerodata, 4: leafdata, 8: leaf
  56862. ** 1 2 byte offset to the first freeblock
  56863. ** 3 2 number of cells on this page
  56864. ** 5 2 first byte of the cell content area
  56865. ** 7 1 number of fragmented free bytes
  56866. ** 8 4 Right child (the Ptr(N) value). Omitted on leaves.
  56867. **
  56868. ** The flags define the format of this btree page. The leaf flag means that
  56869. ** this page has no children. The zerodata flag means that this page carries
  56870. ** only keys and no data. The intkey flag means that the key is an integer
  56871. ** which is stored in the key size entry of the cell header rather than in
  56872. ** the payload area.
  56873. **
  56874. ** The cell pointer array begins on the first byte after the page header.
  56875. ** The cell pointer array contains zero or more 2-byte numbers which are
  56876. ** offsets from the beginning of the page to the cell content in the cell
  56877. ** content area. The cell pointers occur in sorted order. The system strives
  56878. ** to keep free space after the last cell pointer so that new cells can
  56879. ** be easily added without having to defragment the page.
  56880. **
  56881. ** Cell content is stored at the very end of the page and grows toward the
  56882. ** beginning of the page.
  56883. **
  56884. ** Unused space within the cell content area is collected into a linked list of
  56885. ** freeblocks. Each freeblock is at least 4 bytes in size. The byte offset
  56886. ** to the first freeblock is given in the header. Freeblocks occur in
  56887. ** increasing order. Because a freeblock must be at least 4 bytes in size,
  56888. ** any group of 3 or fewer unused bytes in the cell content area cannot
  56889. ** exist on the freeblock chain. A group of 3 or fewer free bytes is called
  56890. ** a fragment. The total number of bytes in all fragments is recorded.
  56891. ** in the page header at offset 7.
  56892. **
  56893. ** SIZE DESCRIPTION
  56894. ** 2 Byte offset of the next freeblock
  56895. ** 2 Bytes in this freeblock
  56896. **
  56897. ** Cells are of variable length. Cells are stored in the cell content area at
  56898. ** the end of the page. Pointers to the cells are in the cell pointer array
  56899. ** that immediately follows the page header. Cells is not necessarily
  56900. ** contiguous or in order, but cell pointers are contiguous and in order.
  56901. **
  56902. ** Cell content makes use of variable length integers. A variable
  56903. ** length integer is 1 to 9 bytes where the lower 7 bits of each
  56904. ** byte are used. The integer consists of all bytes that have bit 8 set and
  56905. ** the first byte with bit 8 clear. The most significant byte of the integer
  56906. ** appears first. A variable-length integer may not be more than 9 bytes long.
  56907. ** As a special case, all 8 bytes of the 9th byte are used as data. This
  56908. ** allows a 64-bit integer to be encoded in 9 bytes.
  56909. **
  56910. ** 0x00 becomes 0x00000000
  56911. ** 0x7f becomes 0x0000007f
  56912. ** 0x81 0x00 becomes 0x00000080
  56913. ** 0x82 0x00 becomes 0x00000100
  56914. ** 0x80 0x7f becomes 0x0000007f
  56915. ** 0x8a 0x91 0xd1 0xac 0x78 becomes 0x12345678
  56916. ** 0x81 0x81 0x81 0x81 0x01 becomes 0x10204081
  56917. **
  56918. ** Variable length integers are used for rowids and to hold the number of
  56919. ** bytes of key and data in a btree cell.
  56920. **
  56921. ** The content of a cell looks like this:
  56922. **
  56923. ** SIZE DESCRIPTION
  56924. ** 4 Page number of the left child. Omitted if leaf flag is set.
  56925. ** var Number of bytes of data. Omitted if the zerodata flag is set.
  56926. ** var Number of bytes of key. Or the key itself if intkey flag is set.
  56927. ** * Payload
  56928. ** 4 First page of the overflow chain. Omitted if no overflow
  56929. **
  56930. ** Overflow pages form a linked list. Each page except the last is completely
  56931. ** filled with data (pagesize - 4 bytes). The last page can have as little
  56932. ** as 1 byte of data.
  56933. **
  56934. ** SIZE DESCRIPTION
  56935. ** 4 Page number of next overflow page
  56936. ** * Data
  56937. **
  56938. ** Freelist pages come in two subtypes: trunk pages and leaf pages. The
  56939. ** file header points to the first in a linked list of trunk page. Each trunk
  56940. ** page points to multiple leaf pages. The content of a leaf page is
  56941. ** unspecified. A trunk page looks like this:
  56942. **
  56943. ** SIZE DESCRIPTION
  56944. ** 4 Page number of next trunk page
  56945. ** 4 Number of leaf pointers on this page
  56946. ** * zero or more pages numbers of leaves
  56947. */
  56948. /* #include "sqliteInt.h" */
  56949. /* The following value is the maximum cell size assuming a maximum page
  56950. ** size give above.
  56951. */
  56952. #define MX_CELL_SIZE(pBt) ((int)(pBt->pageSize-8))
  56953. /* The maximum number of cells on a single page of the database. This
  56954. ** assumes a minimum cell size of 6 bytes (4 bytes for the cell itself
  56955. ** plus 2 bytes for the index to the cell in the page header). Such
  56956. ** small cells will be rare, but they are possible.
  56957. */
  56958. #define MX_CELL(pBt) ((pBt->pageSize-8)/6)
  56959. /* Forward declarations */
  56960. typedef struct MemPage MemPage;
  56961. typedef struct BtLock BtLock;
  56962. typedef struct CellInfo CellInfo;
  56963. /*
  56964. ** This is a magic string that appears at the beginning of every
  56965. ** SQLite database in order to identify the file as a real database.
  56966. **
  56967. ** You can change this value at compile-time by specifying a
  56968. ** -DSQLITE_FILE_HEADER="..." on the compiler command-line. The
  56969. ** header must be exactly 16 bytes including the zero-terminator so
  56970. ** the string itself should be 15 characters long. If you change
  56971. ** the header, then your custom library will not be able to read
  56972. ** databases generated by the standard tools and the standard tools
  56973. ** will not be able to read databases created by your custom library.
  56974. */
  56975. #ifndef SQLITE_FILE_HEADER /* 123456789 123456 */
  56976. # define SQLITE_FILE_HEADER "SQLite format 3"
  56977. #endif
  56978. /*
  56979. ** Page type flags. An ORed combination of these flags appear as the
  56980. ** first byte of on-disk image of every BTree page.
  56981. */
  56982. #define PTF_INTKEY 0x01
  56983. #define PTF_ZERODATA 0x02
  56984. #define PTF_LEAFDATA 0x04
  56985. #define PTF_LEAF 0x08
  56986. /*
  56987. ** An instance of this object stores information about each a single database
  56988. ** page that has been loaded into memory. The information in this object
  56989. ** is derived from the raw on-disk page content.
  56990. **
  56991. ** As each database page is loaded into memory, the pager allocats an
  56992. ** instance of this object and zeros the first 8 bytes. (This is the
  56993. ** "extra" information associated with each page of the pager.)
  56994. **
  56995. ** Access to all fields of this structure is controlled by the mutex
  56996. ** stored in MemPage.pBt->mutex.
  56997. */
  56998. struct MemPage {
  56999. u8 isInit; /* True if previously initialized. MUST BE FIRST! */
  57000. u8 bBusy; /* Prevent endless loops on corrupt database files */
  57001. u8 intKey; /* True if table b-trees. False for index b-trees */
  57002. u8 intKeyLeaf; /* True if the leaf of an intKey table */
  57003. Pgno pgno; /* Page number for this page */
  57004. /* Only the first 8 bytes (above) are zeroed by pager.c when a new page
  57005. ** is allocated. All fields that follow must be initialized before use */
  57006. u8 leaf; /* True if a leaf page */
  57007. u8 hdrOffset; /* 100 for page 1. 0 otherwise */
  57008. u8 childPtrSize; /* 0 if leaf==1. 4 if leaf==0 */
  57009. u8 max1bytePayload; /* min(maxLocal,127) */
  57010. u8 nOverflow; /* Number of overflow cell bodies in aCell[] */
  57011. u16 maxLocal; /* Copy of BtShared.maxLocal or BtShared.maxLeaf */
  57012. u16 minLocal; /* Copy of BtShared.minLocal or BtShared.minLeaf */
  57013. u16 cellOffset; /* Index in aData of first cell pointer */
  57014. u16 nFree; /* Number of free bytes on the page */
  57015. u16 nCell; /* Number of cells on this page, local and ovfl */
  57016. u16 maskPage; /* Mask for page offset */
  57017. u16 aiOvfl[4]; /* Insert the i-th overflow cell before the aiOvfl-th
  57018. ** non-overflow cell */
  57019. u8 *apOvfl[4]; /* Pointers to the body of overflow cells */
  57020. BtShared *pBt; /* Pointer to BtShared that this page is part of */
  57021. u8 *aData; /* Pointer to disk image of the page data */
  57022. u8 *aDataEnd; /* One byte past the end of usable data */
  57023. u8 *aCellIdx; /* The cell index area */
  57024. u8 *aDataOfst; /* Same as aData for leaves. aData+4 for interior */
  57025. DbPage *pDbPage; /* Pager page handle */
  57026. u16 (*xCellSize)(MemPage*,u8*); /* cellSizePtr method */
  57027. void (*xParseCell)(MemPage*,u8*,CellInfo*); /* btreeParseCell method */
  57028. };
  57029. /*
  57030. ** A linked list of the following structures is stored at BtShared.pLock.
  57031. ** Locks are added (or upgraded from READ_LOCK to WRITE_LOCK) when a cursor
  57032. ** is opened on the table with root page BtShared.iTable. Locks are removed
  57033. ** from this list when a transaction is committed or rolled back, or when
  57034. ** a btree handle is closed.
  57035. */
  57036. struct BtLock {
  57037. Btree *pBtree; /* Btree handle holding this lock */
  57038. Pgno iTable; /* Root page of table */
  57039. u8 eLock; /* READ_LOCK or WRITE_LOCK */
  57040. BtLock *pNext; /* Next in BtShared.pLock list */
  57041. };
  57042. /* Candidate values for BtLock.eLock */
  57043. #define READ_LOCK 1
  57044. #define WRITE_LOCK 2
  57045. /* A Btree handle
  57046. **
  57047. ** A database connection contains a pointer to an instance of
  57048. ** this object for every database file that it has open. This structure
  57049. ** is opaque to the database connection. The database connection cannot
  57050. ** see the internals of this structure and only deals with pointers to
  57051. ** this structure.
  57052. **
  57053. ** For some database files, the same underlying database cache might be
  57054. ** shared between multiple connections. In that case, each connection
  57055. ** has it own instance of this object. But each instance of this object
  57056. ** points to the same BtShared object. The database cache and the
  57057. ** schema associated with the database file are all contained within
  57058. ** the BtShared object.
  57059. **
  57060. ** All fields in this structure are accessed under sqlite3.mutex.
  57061. ** The pBt pointer itself may not be changed while there exists cursors
  57062. ** in the referenced BtShared that point back to this Btree since those
  57063. ** cursors have to go through this Btree to find their BtShared and
  57064. ** they often do so without holding sqlite3.mutex.
  57065. */
  57066. struct Btree {
  57067. sqlite3 *db; /* The database connection holding this btree */
  57068. BtShared *pBt; /* Sharable content of this btree */
  57069. u8 inTrans; /* TRANS_NONE, TRANS_READ or TRANS_WRITE */
  57070. u8 sharable; /* True if we can share pBt with another db */
  57071. u8 locked; /* True if db currently has pBt locked */
  57072. u8 hasIncrblobCur; /* True if there are one or more Incrblob cursors */
  57073. int wantToLock; /* Number of nested calls to sqlite3BtreeEnter() */
  57074. int nBackup; /* Number of backup operations reading this btree */
  57075. u32 iDataVersion; /* Combines with pBt->pPager->iDataVersion */
  57076. Btree *pNext; /* List of other sharable Btrees from the same db */
  57077. Btree *pPrev; /* Back pointer of the same list */
  57078. #ifndef SQLITE_OMIT_SHARED_CACHE
  57079. BtLock lock; /* Object used to lock page 1 */
  57080. #endif
  57081. };
  57082. /*
  57083. ** Btree.inTrans may take one of the following values.
  57084. **
  57085. ** If the shared-data extension is enabled, there may be multiple users
  57086. ** of the Btree structure. At most one of these may open a write transaction,
  57087. ** but any number may have active read transactions.
  57088. */
  57089. #define TRANS_NONE 0
  57090. #define TRANS_READ 1
  57091. #define TRANS_WRITE 2
  57092. /*
  57093. ** An instance of this object represents a single database file.
  57094. **
  57095. ** A single database file can be in use at the same time by two
  57096. ** or more database connections. When two or more connections are
  57097. ** sharing the same database file, each connection has it own
  57098. ** private Btree object for the file and each of those Btrees points
  57099. ** to this one BtShared object. BtShared.nRef is the number of
  57100. ** connections currently sharing this database file.
  57101. **
  57102. ** Fields in this structure are accessed under the BtShared.mutex
  57103. ** mutex, except for nRef and pNext which are accessed under the
  57104. ** global SQLITE_MUTEX_STATIC_MASTER mutex. The pPager field
  57105. ** may not be modified once it is initially set as long as nRef>0.
  57106. ** The pSchema field may be set once under BtShared.mutex and
  57107. ** thereafter is unchanged as long as nRef>0.
  57108. **
  57109. ** isPending:
  57110. **
  57111. ** If a BtShared client fails to obtain a write-lock on a database
  57112. ** table (because there exists one or more read-locks on the table),
  57113. ** the shared-cache enters 'pending-lock' state and isPending is
  57114. ** set to true.
  57115. **
  57116. ** The shared-cache leaves the 'pending lock' state when either of
  57117. ** the following occur:
  57118. **
  57119. ** 1) The current writer (BtShared.pWriter) concludes its transaction, OR
  57120. ** 2) The number of locks held by other connections drops to zero.
  57121. **
  57122. ** while in the 'pending-lock' state, no connection may start a new
  57123. ** transaction.
  57124. **
  57125. ** This feature is included to help prevent writer-starvation.
  57126. */
  57127. struct BtShared {
  57128. Pager *pPager; /* The page cache */
  57129. sqlite3 *db; /* Database connection currently using this Btree */
  57130. BtCursor *pCursor; /* A list of all open cursors */
  57131. MemPage *pPage1; /* First page of the database */
  57132. u8 openFlags; /* Flags to sqlite3BtreeOpen() */
  57133. #ifndef SQLITE_OMIT_AUTOVACUUM
  57134. u8 autoVacuum; /* True if auto-vacuum is enabled */
  57135. u8 incrVacuum; /* True if incr-vacuum is enabled */
  57136. u8 bDoTruncate; /* True to truncate db on commit */
  57137. #endif
  57138. u8 inTransaction; /* Transaction state */
  57139. u8 max1bytePayload; /* Maximum first byte of cell for a 1-byte payload */
  57140. #ifdef SQLITE_HAS_CODEC
  57141. u8 optimalReserve; /* Desired amount of reserved space per page */
  57142. #endif
  57143. u16 btsFlags; /* Boolean parameters. See BTS_* macros below */
  57144. u16 maxLocal; /* Maximum local payload in non-LEAFDATA tables */
  57145. u16 minLocal; /* Minimum local payload in non-LEAFDATA tables */
  57146. u16 maxLeaf; /* Maximum local payload in a LEAFDATA table */
  57147. u16 minLeaf; /* Minimum local payload in a LEAFDATA table */
  57148. u32 pageSize; /* Total number of bytes on a page */
  57149. u32 usableSize; /* Number of usable bytes on each page */
  57150. int nTransaction; /* Number of open transactions (read + write) */
  57151. u32 nPage; /* Number of pages in the database */
  57152. void *pSchema; /* Pointer to space allocated by sqlite3BtreeSchema() */
  57153. void (*xFreeSchema)(void*); /* Destructor for BtShared.pSchema */
  57154. sqlite3_mutex *mutex; /* Non-recursive mutex required to access this object */
  57155. Bitvec *pHasContent; /* Set of pages moved to free-list this transaction */
  57156. #ifndef SQLITE_OMIT_SHARED_CACHE
  57157. int nRef; /* Number of references to this structure */
  57158. BtShared *pNext; /* Next on a list of sharable BtShared structs */
  57159. BtLock *pLock; /* List of locks held on this shared-btree struct */
  57160. Btree *pWriter; /* Btree with currently open write transaction */
  57161. #endif
  57162. u8 *pTmpSpace; /* Temp space sufficient to hold a single cell */
  57163. };
  57164. /*
  57165. ** Allowed values for BtShared.btsFlags
  57166. */
  57167. #define BTS_READ_ONLY 0x0001 /* Underlying file is readonly */
  57168. #define BTS_PAGESIZE_FIXED 0x0002 /* Page size can no longer be changed */
  57169. #define BTS_SECURE_DELETE 0x0004 /* PRAGMA secure_delete is enabled */
  57170. #define BTS_OVERWRITE 0x0008 /* Overwrite deleted content with zeros */
  57171. #define BTS_FAST_SECURE 0x000c /* Combination of the previous two */
  57172. #define BTS_INITIALLY_EMPTY 0x0010 /* Database was empty at trans start */
  57173. #define BTS_NO_WAL 0x0020 /* Do not open write-ahead-log files */
  57174. #define BTS_EXCLUSIVE 0x0040 /* pWriter has an exclusive lock */
  57175. #define BTS_PENDING 0x0080 /* Waiting for read-locks to clear */
  57176. /*
  57177. ** An instance of the following structure is used to hold information
  57178. ** about a cell. The parseCellPtr() function fills in this structure
  57179. ** based on information extract from the raw disk page.
  57180. */
  57181. struct CellInfo {
  57182. i64 nKey; /* The key for INTKEY tables, or nPayload otherwise */
  57183. u8 *pPayload; /* Pointer to the start of payload */
  57184. u32 nPayload; /* Bytes of payload */
  57185. u16 nLocal; /* Amount of payload held locally, not on overflow */
  57186. u16 nSize; /* Size of the cell content on the main b-tree page */
  57187. };
  57188. /*
  57189. ** Maximum depth of an SQLite B-Tree structure. Any B-Tree deeper than
  57190. ** this will be declared corrupt. This value is calculated based on a
  57191. ** maximum database size of 2^31 pages a minimum fanout of 2 for a
  57192. ** root-node and 3 for all other internal nodes.
  57193. **
  57194. ** If a tree that appears to be taller than this is encountered, it is
  57195. ** assumed that the database is corrupt.
  57196. */
  57197. #define BTCURSOR_MAX_DEPTH 20
  57198. /*
  57199. ** A cursor is a pointer to a particular entry within a particular
  57200. ** b-tree within a database file.
  57201. **
  57202. ** The entry is identified by its MemPage and the index in
  57203. ** MemPage.aCell[] of the entry.
  57204. **
  57205. ** A single database file can be shared by two more database connections,
  57206. ** but cursors cannot be shared. Each cursor is associated with a
  57207. ** particular database connection identified BtCursor.pBtree.db.
  57208. **
  57209. ** Fields in this structure are accessed under the BtShared.mutex
  57210. ** found at self->pBt->mutex.
  57211. **
  57212. ** skipNext meaning:
  57213. ** eState==SKIPNEXT && skipNext>0: Next sqlite3BtreeNext() is no-op.
  57214. ** eState==SKIPNEXT && skipNext<0: Next sqlite3BtreePrevious() is no-op.
  57215. ** eState==FAULT: Cursor fault with skipNext as error code.
  57216. */
  57217. struct BtCursor {
  57218. u8 eState; /* One of the CURSOR_XXX constants (see below) */
  57219. u8 curFlags; /* zero or more BTCF_* flags defined below */
  57220. u8 curPagerFlags; /* Flags to send to sqlite3PagerGet() */
  57221. u8 hints; /* As configured by CursorSetHints() */
  57222. int skipNext; /* Prev() is noop if negative. Next() is noop if positive.
  57223. ** Error code if eState==CURSOR_FAULT */
  57224. Btree *pBtree; /* The Btree to which this cursor belongs */
  57225. Pgno *aOverflow; /* Cache of overflow page locations */
  57226. void *pKey; /* Saved key that was cursor last known position */
  57227. /* All fields above are zeroed when the cursor is allocated. See
  57228. ** sqlite3BtreeCursorZero(). Fields that follow must be manually
  57229. ** initialized. */
  57230. #define BTCURSOR_FIRST_UNINIT pBt /* Name of first uninitialized field */
  57231. BtShared *pBt; /* The BtShared this cursor points to */
  57232. BtCursor *pNext; /* Forms a linked list of all cursors */
  57233. CellInfo info; /* A parse of the cell we are pointing at */
  57234. i64 nKey; /* Size of pKey, or last integer key */
  57235. Pgno pgnoRoot; /* The root page of this tree */
  57236. i8 iPage; /* Index of current page in apPage */
  57237. u8 curIntKey; /* Value of apPage[0]->intKey */
  57238. u16 ix; /* Current index for apPage[iPage] */
  57239. u16 aiIdx[BTCURSOR_MAX_DEPTH-1]; /* Current index in apPage[i] */
  57240. struct KeyInfo *pKeyInfo; /* Arg passed to comparison function */
  57241. MemPage *pPage; /* Current page */
  57242. MemPage *apPage[BTCURSOR_MAX_DEPTH-1]; /* Stack of parents of current page */
  57243. };
  57244. /*
  57245. ** Legal values for BtCursor.curFlags
  57246. */
  57247. #define BTCF_WriteFlag 0x01 /* True if a write cursor */
  57248. #define BTCF_ValidNKey 0x02 /* True if info.nKey is valid */
  57249. #define BTCF_ValidOvfl 0x04 /* True if aOverflow is valid */
  57250. #define BTCF_AtLast 0x08 /* Cursor is pointing ot the last entry */
  57251. #define BTCF_Incrblob 0x10 /* True if an incremental I/O handle */
  57252. #define BTCF_Multiple 0x20 /* Maybe another cursor on the same btree */
  57253. /*
  57254. ** Potential values for BtCursor.eState.
  57255. **
  57256. ** CURSOR_INVALID:
  57257. ** Cursor does not point to a valid entry. This can happen (for example)
  57258. ** because the table is empty or because BtreeCursorFirst() has not been
  57259. ** called.
  57260. **
  57261. ** CURSOR_VALID:
  57262. ** Cursor points to a valid entry. getPayload() etc. may be called.
  57263. **
  57264. ** CURSOR_SKIPNEXT:
  57265. ** Cursor is valid except that the Cursor.skipNext field is non-zero
  57266. ** indicating that the next sqlite3BtreeNext() or sqlite3BtreePrevious()
  57267. ** operation should be a no-op.
  57268. **
  57269. ** CURSOR_REQUIRESEEK:
  57270. ** The table that this cursor was opened on still exists, but has been
  57271. ** modified since the cursor was last used. The cursor position is saved
  57272. ** in variables BtCursor.pKey and BtCursor.nKey. When a cursor is in
  57273. ** this state, restoreCursorPosition() can be called to attempt to
  57274. ** seek the cursor to the saved position.
  57275. **
  57276. ** CURSOR_FAULT:
  57277. ** An unrecoverable error (an I/O error or a malloc failure) has occurred
  57278. ** on a different connection that shares the BtShared cache with this
  57279. ** cursor. The error has left the cache in an inconsistent state.
  57280. ** Do nothing else with this cursor. Any attempt to use the cursor
  57281. ** should return the error code stored in BtCursor.skipNext
  57282. */
  57283. #define CURSOR_VALID 0
  57284. #define CURSOR_INVALID 1
  57285. #define CURSOR_SKIPNEXT 2
  57286. #define CURSOR_REQUIRESEEK 3
  57287. #define CURSOR_FAULT 4
  57288. /*
  57289. ** The database page the PENDING_BYTE occupies. This page is never used.
  57290. */
  57291. # define PENDING_BYTE_PAGE(pBt) PAGER_MJ_PGNO(pBt)
  57292. /*
  57293. ** These macros define the location of the pointer-map entry for a
  57294. ** database page. The first argument to each is the number of usable
  57295. ** bytes on each page of the database (often 1024). The second is the
  57296. ** page number to look up in the pointer map.
  57297. **
  57298. ** PTRMAP_PAGENO returns the database page number of the pointer-map
  57299. ** page that stores the required pointer. PTRMAP_PTROFFSET returns
  57300. ** the offset of the requested map entry.
  57301. **
  57302. ** If the pgno argument passed to PTRMAP_PAGENO is a pointer-map page,
  57303. ** then pgno is returned. So (pgno==PTRMAP_PAGENO(pgsz, pgno)) can be
  57304. ** used to test if pgno is a pointer-map page. PTRMAP_ISPAGE implements
  57305. ** this test.
  57306. */
  57307. #define PTRMAP_PAGENO(pBt, pgno) ptrmapPageno(pBt, pgno)
  57308. #define PTRMAP_PTROFFSET(pgptrmap, pgno) (5*(pgno-pgptrmap-1))
  57309. #define PTRMAP_ISPAGE(pBt, pgno) (PTRMAP_PAGENO((pBt),(pgno))==(pgno))
  57310. /*
  57311. ** The pointer map is a lookup table that identifies the parent page for
  57312. ** each child page in the database file. The parent page is the page that
  57313. ** contains a pointer to the child. Every page in the database contains
  57314. ** 0 or 1 parent pages. (In this context 'database page' refers
  57315. ** to any page that is not part of the pointer map itself.) Each pointer map
  57316. ** entry consists of a single byte 'type' and a 4 byte parent page number.
  57317. ** The PTRMAP_XXX identifiers below are the valid types.
  57318. **
  57319. ** The purpose of the pointer map is to facility moving pages from one
  57320. ** position in the file to another as part of autovacuum. When a page
  57321. ** is moved, the pointer in its parent must be updated to point to the
  57322. ** new location. The pointer map is used to locate the parent page quickly.
  57323. **
  57324. ** PTRMAP_ROOTPAGE: The database page is a root-page. The page-number is not
  57325. ** used in this case.
  57326. **
  57327. ** PTRMAP_FREEPAGE: The database page is an unused (free) page. The page-number
  57328. ** is not used in this case.
  57329. **
  57330. ** PTRMAP_OVERFLOW1: The database page is the first page in a list of
  57331. ** overflow pages. The page number identifies the page that
  57332. ** contains the cell with a pointer to this overflow page.
  57333. **
  57334. ** PTRMAP_OVERFLOW2: The database page is the second or later page in a list of
  57335. ** overflow pages. The page-number identifies the previous
  57336. ** page in the overflow page list.
  57337. **
  57338. ** PTRMAP_BTREE: The database page is a non-root btree page. The page number
  57339. ** identifies the parent page in the btree.
  57340. */
  57341. #define PTRMAP_ROOTPAGE 1
  57342. #define PTRMAP_FREEPAGE 2
  57343. #define PTRMAP_OVERFLOW1 3
  57344. #define PTRMAP_OVERFLOW2 4
  57345. #define PTRMAP_BTREE 5
  57346. /* A bunch of assert() statements to check the transaction state variables
  57347. ** of handle p (type Btree*) are internally consistent.
  57348. */
  57349. #define btreeIntegrity(p) \
  57350. assert( p->pBt->inTransaction!=TRANS_NONE || p->pBt->nTransaction==0 ); \
  57351. assert( p->pBt->inTransaction>=p->inTrans );
  57352. /*
  57353. ** The ISAUTOVACUUM macro is used within balance_nonroot() to determine
  57354. ** if the database supports auto-vacuum or not. Because it is used
  57355. ** within an expression that is an argument to another macro
  57356. ** (sqliteMallocRaw), it is not possible to use conditional compilation.
  57357. ** So, this macro is defined instead.
  57358. */
  57359. #ifndef SQLITE_OMIT_AUTOVACUUM
  57360. #define ISAUTOVACUUM (pBt->autoVacuum)
  57361. #else
  57362. #define ISAUTOVACUUM 0
  57363. #endif
  57364. /*
  57365. ** This structure is passed around through all the sanity checking routines
  57366. ** in order to keep track of some global state information.
  57367. **
  57368. ** The aRef[] array is allocated so that there is 1 bit for each page in
  57369. ** the database. As the integrity-check proceeds, for each page used in
  57370. ** the database the corresponding bit is set. This allows integrity-check to
  57371. ** detect pages that are used twice and orphaned pages (both of which
  57372. ** indicate corruption).
  57373. */
  57374. typedef struct IntegrityCk IntegrityCk;
  57375. struct IntegrityCk {
  57376. BtShared *pBt; /* The tree being checked out */
  57377. Pager *pPager; /* The associated pager. Also accessible by pBt->pPager */
  57378. u8 *aPgRef; /* 1 bit per page in the db (see above) */
  57379. Pgno nPage; /* Number of pages in the database */
  57380. int mxErr; /* Stop accumulating errors when this reaches zero */
  57381. int nErr; /* Number of messages written to zErrMsg so far */
  57382. int mallocFailed; /* A memory allocation error has occurred */
  57383. const char *zPfx; /* Error message prefix */
  57384. int v1, v2; /* Values for up to two %d fields in zPfx */
  57385. StrAccum errMsg; /* Accumulate the error message text here */
  57386. u32 *heap; /* Min-heap used for analyzing cell coverage */
  57387. };
  57388. /*
  57389. ** Routines to read or write a two- and four-byte big-endian integer values.
  57390. */
  57391. #define get2byte(x) ((x)[0]<<8 | (x)[1])
  57392. #define put2byte(p,v) ((p)[0] = (u8)((v)>>8), (p)[1] = (u8)(v))
  57393. #define get4byte sqlite3Get4byte
  57394. #define put4byte sqlite3Put4byte
  57395. /*
  57396. ** get2byteAligned(), unlike get2byte(), requires that its argument point to a
  57397. ** two-byte aligned address. get2bytea() is only used for accessing the
  57398. ** cell addresses in a btree header.
  57399. */
  57400. #if SQLITE_BYTEORDER==4321
  57401. # define get2byteAligned(x) (*(u16*)(x))
  57402. #elif SQLITE_BYTEORDER==1234 && GCC_VERSION>=4008000
  57403. # define get2byteAligned(x) __builtin_bswap16(*(u16*)(x))
  57404. #elif SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  57405. # define get2byteAligned(x) _byteswap_ushort(*(u16*)(x))
  57406. #else
  57407. # define get2byteAligned(x) ((x)[0]<<8 | (x)[1])
  57408. #endif
  57409. /************** End of btreeInt.h ********************************************/
  57410. /************** Continuing where we left off in btmutex.c ********************/
  57411. #ifndef SQLITE_OMIT_SHARED_CACHE
  57412. #if SQLITE_THREADSAFE
  57413. /*
  57414. ** Obtain the BtShared mutex associated with B-Tree handle p. Also,
  57415. ** set BtShared.db to the database handle associated with p and the
  57416. ** p->locked boolean to true.
  57417. */
  57418. static void lockBtreeMutex(Btree *p){
  57419. assert( p->locked==0 );
  57420. assert( sqlite3_mutex_notheld(p->pBt->mutex) );
  57421. assert( sqlite3_mutex_held(p->db->mutex) );
  57422. sqlite3_mutex_enter(p->pBt->mutex);
  57423. p->pBt->db = p->db;
  57424. p->locked = 1;
  57425. }
  57426. /*
  57427. ** Release the BtShared mutex associated with B-Tree handle p and
  57428. ** clear the p->locked boolean.
  57429. */
  57430. static void SQLITE_NOINLINE unlockBtreeMutex(Btree *p){
  57431. BtShared *pBt = p->pBt;
  57432. assert( p->locked==1 );
  57433. assert( sqlite3_mutex_held(pBt->mutex) );
  57434. assert( sqlite3_mutex_held(p->db->mutex) );
  57435. assert( p->db==pBt->db );
  57436. sqlite3_mutex_leave(pBt->mutex);
  57437. p->locked = 0;
  57438. }
  57439. /* Forward reference */
  57440. static void SQLITE_NOINLINE btreeLockCarefully(Btree *p);
  57441. /*
  57442. ** Enter a mutex on the given BTree object.
  57443. **
  57444. ** If the object is not sharable, then no mutex is ever required
  57445. ** and this routine is a no-op. The underlying mutex is non-recursive.
  57446. ** But we keep a reference count in Btree.wantToLock so the behavior
  57447. ** of this interface is recursive.
  57448. **
  57449. ** To avoid deadlocks, multiple Btrees are locked in the same order
  57450. ** by all database connections. The p->pNext is a list of other
  57451. ** Btrees belonging to the same database connection as the p Btree
  57452. ** which need to be locked after p. If we cannot get a lock on
  57453. ** p, then first unlock all of the others on p->pNext, then wait
  57454. ** for the lock to become available on p, then relock all of the
  57455. ** subsequent Btrees that desire a lock.
  57456. */
  57457. SQLITE_PRIVATE void sqlite3BtreeEnter(Btree *p){
  57458. /* Some basic sanity checking on the Btree. The list of Btrees
  57459. ** connected by pNext and pPrev should be in sorted order by
  57460. ** Btree.pBt value. All elements of the list should belong to
  57461. ** the same connection. Only shared Btrees are on the list. */
  57462. assert( p->pNext==0 || p->pNext->pBt>p->pBt );
  57463. assert( p->pPrev==0 || p->pPrev->pBt<p->pBt );
  57464. assert( p->pNext==0 || p->pNext->db==p->db );
  57465. assert( p->pPrev==0 || p->pPrev->db==p->db );
  57466. assert( p->sharable || (p->pNext==0 && p->pPrev==0) );
  57467. /* Check for locking consistency */
  57468. assert( !p->locked || p->wantToLock>0 );
  57469. assert( p->sharable || p->wantToLock==0 );
  57470. /* We should already hold a lock on the database connection */
  57471. assert( sqlite3_mutex_held(p->db->mutex) );
  57472. /* Unless the database is sharable and unlocked, then BtShared.db
  57473. ** should already be set correctly. */
  57474. assert( (p->locked==0 && p->sharable) || p->pBt->db==p->db );
  57475. if( !p->sharable ) return;
  57476. p->wantToLock++;
  57477. if( p->locked ) return;
  57478. btreeLockCarefully(p);
  57479. }
  57480. /* This is a helper function for sqlite3BtreeLock(). By moving
  57481. ** complex, but seldom used logic, out of sqlite3BtreeLock() and
  57482. ** into this routine, we avoid unnecessary stack pointer changes
  57483. ** and thus help the sqlite3BtreeLock() routine to run much faster
  57484. ** in the common case.
  57485. */
  57486. static void SQLITE_NOINLINE btreeLockCarefully(Btree *p){
  57487. Btree *pLater;
  57488. /* In most cases, we should be able to acquire the lock we
  57489. ** want without having to go through the ascending lock
  57490. ** procedure that follows. Just be sure not to block.
  57491. */
  57492. if( sqlite3_mutex_try(p->pBt->mutex)==SQLITE_OK ){
  57493. p->pBt->db = p->db;
  57494. p->locked = 1;
  57495. return;
  57496. }
  57497. /* To avoid deadlock, first release all locks with a larger
  57498. ** BtShared address. Then acquire our lock. Then reacquire
  57499. ** the other BtShared locks that we used to hold in ascending
  57500. ** order.
  57501. */
  57502. for(pLater=p->pNext; pLater; pLater=pLater->pNext){
  57503. assert( pLater->sharable );
  57504. assert( pLater->pNext==0 || pLater->pNext->pBt>pLater->pBt );
  57505. assert( !pLater->locked || pLater->wantToLock>0 );
  57506. if( pLater->locked ){
  57507. unlockBtreeMutex(pLater);
  57508. }
  57509. }
  57510. lockBtreeMutex(p);
  57511. for(pLater=p->pNext; pLater; pLater=pLater->pNext){
  57512. if( pLater->wantToLock ){
  57513. lockBtreeMutex(pLater);
  57514. }
  57515. }
  57516. }
  57517. /*
  57518. ** Exit the recursive mutex on a Btree.
  57519. */
  57520. SQLITE_PRIVATE void sqlite3BtreeLeave(Btree *p){
  57521. assert( sqlite3_mutex_held(p->db->mutex) );
  57522. if( p->sharable ){
  57523. assert( p->wantToLock>0 );
  57524. p->wantToLock--;
  57525. if( p->wantToLock==0 ){
  57526. unlockBtreeMutex(p);
  57527. }
  57528. }
  57529. }
  57530. #ifndef NDEBUG
  57531. /*
  57532. ** Return true if the BtShared mutex is held on the btree, or if the
  57533. ** B-Tree is not marked as sharable.
  57534. **
  57535. ** This routine is used only from within assert() statements.
  57536. */
  57537. SQLITE_PRIVATE int sqlite3BtreeHoldsMutex(Btree *p){
  57538. assert( p->sharable==0 || p->locked==0 || p->wantToLock>0 );
  57539. assert( p->sharable==0 || p->locked==0 || p->db==p->pBt->db );
  57540. assert( p->sharable==0 || p->locked==0 || sqlite3_mutex_held(p->pBt->mutex) );
  57541. assert( p->sharable==0 || p->locked==0 || sqlite3_mutex_held(p->db->mutex) );
  57542. return (p->sharable==0 || p->locked);
  57543. }
  57544. #endif
  57545. /*
  57546. ** Enter the mutex on every Btree associated with a database
  57547. ** connection. This is needed (for example) prior to parsing
  57548. ** a statement since we will be comparing table and column names
  57549. ** against all schemas and we do not want those schemas being
  57550. ** reset out from under us.
  57551. **
  57552. ** There is a corresponding leave-all procedures.
  57553. **
  57554. ** Enter the mutexes in accending order by BtShared pointer address
  57555. ** to avoid the possibility of deadlock when two threads with
  57556. ** two or more btrees in common both try to lock all their btrees
  57557. ** at the same instant.
  57558. */
  57559. static void SQLITE_NOINLINE btreeEnterAll(sqlite3 *db){
  57560. int i;
  57561. int skipOk = 1;
  57562. Btree *p;
  57563. assert( sqlite3_mutex_held(db->mutex) );
  57564. for(i=0; i<db->nDb; i++){
  57565. p = db->aDb[i].pBt;
  57566. if( p && p->sharable ){
  57567. sqlite3BtreeEnter(p);
  57568. skipOk = 0;
  57569. }
  57570. }
  57571. db->skipBtreeMutex = skipOk;
  57572. }
  57573. SQLITE_PRIVATE void sqlite3BtreeEnterAll(sqlite3 *db){
  57574. if( db->skipBtreeMutex==0 ) btreeEnterAll(db);
  57575. }
  57576. static void SQLITE_NOINLINE btreeLeaveAll(sqlite3 *db){
  57577. int i;
  57578. Btree *p;
  57579. assert( sqlite3_mutex_held(db->mutex) );
  57580. for(i=0; i<db->nDb; i++){
  57581. p = db->aDb[i].pBt;
  57582. if( p ) sqlite3BtreeLeave(p);
  57583. }
  57584. }
  57585. SQLITE_PRIVATE void sqlite3BtreeLeaveAll(sqlite3 *db){
  57586. if( db->skipBtreeMutex==0 ) btreeLeaveAll(db);
  57587. }
  57588. #ifndef NDEBUG
  57589. /*
  57590. ** Return true if the current thread holds the database connection
  57591. ** mutex and all required BtShared mutexes.
  57592. **
  57593. ** This routine is used inside assert() statements only.
  57594. */
  57595. SQLITE_PRIVATE int sqlite3BtreeHoldsAllMutexes(sqlite3 *db){
  57596. int i;
  57597. if( !sqlite3_mutex_held(db->mutex) ){
  57598. return 0;
  57599. }
  57600. for(i=0; i<db->nDb; i++){
  57601. Btree *p;
  57602. p = db->aDb[i].pBt;
  57603. if( p && p->sharable &&
  57604. (p->wantToLock==0 || !sqlite3_mutex_held(p->pBt->mutex)) ){
  57605. return 0;
  57606. }
  57607. }
  57608. return 1;
  57609. }
  57610. #endif /* NDEBUG */
  57611. #ifndef NDEBUG
  57612. /*
  57613. ** Return true if the correct mutexes are held for accessing the
  57614. ** db->aDb[iDb].pSchema structure. The mutexes required for schema
  57615. ** access are:
  57616. **
  57617. ** (1) The mutex on db
  57618. ** (2) if iDb!=1, then the mutex on db->aDb[iDb].pBt.
  57619. **
  57620. ** If pSchema is not NULL, then iDb is computed from pSchema and
  57621. ** db using sqlite3SchemaToIndex().
  57622. */
  57623. SQLITE_PRIVATE int sqlite3SchemaMutexHeld(sqlite3 *db, int iDb, Schema *pSchema){
  57624. Btree *p;
  57625. assert( db!=0 );
  57626. if( pSchema ) iDb = sqlite3SchemaToIndex(db, pSchema);
  57627. assert( iDb>=0 && iDb<db->nDb );
  57628. if( !sqlite3_mutex_held(db->mutex) ) return 0;
  57629. if( iDb==1 ) return 1;
  57630. p = db->aDb[iDb].pBt;
  57631. assert( p!=0 );
  57632. return p->sharable==0 || p->locked==1;
  57633. }
  57634. #endif /* NDEBUG */
  57635. #else /* SQLITE_THREADSAFE>0 above. SQLITE_THREADSAFE==0 below */
  57636. /*
  57637. ** The following are special cases for mutex enter routines for use
  57638. ** in single threaded applications that use shared cache. Except for
  57639. ** these two routines, all mutex operations are no-ops in that case and
  57640. ** are null #defines in btree.h.
  57641. **
  57642. ** If shared cache is disabled, then all btree mutex routines, including
  57643. ** the ones below, are no-ops and are null #defines in btree.h.
  57644. */
  57645. SQLITE_PRIVATE void sqlite3BtreeEnter(Btree *p){
  57646. p->pBt->db = p->db;
  57647. }
  57648. SQLITE_PRIVATE void sqlite3BtreeEnterAll(sqlite3 *db){
  57649. int i;
  57650. for(i=0; i<db->nDb; i++){
  57651. Btree *p = db->aDb[i].pBt;
  57652. if( p ){
  57653. p->pBt->db = p->db;
  57654. }
  57655. }
  57656. }
  57657. #endif /* if SQLITE_THREADSAFE */
  57658. #ifndef SQLITE_OMIT_INCRBLOB
  57659. /*
  57660. ** Enter a mutex on a Btree given a cursor owned by that Btree.
  57661. **
  57662. ** These entry points are used by incremental I/O only. Enter() is required
  57663. ** any time OMIT_SHARED_CACHE is not defined, regardless of whether or not
  57664. ** the build is threadsafe. Leave() is only required by threadsafe builds.
  57665. */
  57666. SQLITE_PRIVATE void sqlite3BtreeEnterCursor(BtCursor *pCur){
  57667. sqlite3BtreeEnter(pCur->pBtree);
  57668. }
  57669. # if SQLITE_THREADSAFE
  57670. SQLITE_PRIVATE void sqlite3BtreeLeaveCursor(BtCursor *pCur){
  57671. sqlite3BtreeLeave(pCur->pBtree);
  57672. }
  57673. # endif
  57674. #endif /* ifndef SQLITE_OMIT_INCRBLOB */
  57675. #endif /* ifndef SQLITE_OMIT_SHARED_CACHE */
  57676. /************** End of btmutex.c *********************************************/
  57677. /************** Begin file btree.c *******************************************/
  57678. /*
  57679. ** 2004 April 6
  57680. **
  57681. ** The author disclaims copyright to this source code. In place of
  57682. ** a legal notice, here is a blessing:
  57683. **
  57684. ** May you do good and not evil.
  57685. ** May you find forgiveness for yourself and forgive others.
  57686. ** May you share freely, never taking more than you give.
  57687. **
  57688. *************************************************************************
  57689. ** This file implements an external (disk-based) database using BTrees.
  57690. ** See the header comment on "btreeInt.h" for additional information.
  57691. ** Including a description of file format and an overview of operation.
  57692. */
  57693. /* #include "btreeInt.h" */
  57694. /*
  57695. ** The header string that appears at the beginning of every
  57696. ** SQLite database.
  57697. */
  57698. static const char zMagicHeader[] = SQLITE_FILE_HEADER;
  57699. /*
  57700. ** Set this global variable to 1 to enable tracing using the TRACE
  57701. ** macro.
  57702. */
  57703. #if 0
  57704. int sqlite3BtreeTrace=1; /* True to enable tracing */
  57705. # define TRACE(X) if(sqlite3BtreeTrace){printf X;fflush(stdout);}
  57706. #else
  57707. # define TRACE(X)
  57708. #endif
  57709. /*
  57710. ** Extract a 2-byte big-endian integer from an array of unsigned bytes.
  57711. ** But if the value is zero, make it 65536.
  57712. **
  57713. ** This routine is used to extract the "offset to cell content area" value
  57714. ** from the header of a btree page. If the page size is 65536 and the page
  57715. ** is empty, the offset should be 65536, but the 2-byte value stores zero.
  57716. ** This routine makes the necessary adjustment to 65536.
  57717. */
  57718. #define get2byteNotZero(X) (((((int)get2byte(X))-1)&0xffff)+1)
  57719. /*
  57720. ** Values passed as the 5th argument to allocateBtreePage()
  57721. */
  57722. #define BTALLOC_ANY 0 /* Allocate any page */
  57723. #define BTALLOC_EXACT 1 /* Allocate exact page if possible */
  57724. #define BTALLOC_LE 2 /* Allocate any page <= the parameter */
  57725. /*
  57726. ** Macro IfNotOmitAV(x) returns (x) if SQLITE_OMIT_AUTOVACUUM is not
  57727. ** defined, or 0 if it is. For example:
  57728. **
  57729. ** bIncrVacuum = IfNotOmitAV(pBtShared->incrVacuum);
  57730. */
  57731. #ifndef SQLITE_OMIT_AUTOVACUUM
  57732. #define IfNotOmitAV(expr) (expr)
  57733. #else
  57734. #define IfNotOmitAV(expr) 0
  57735. #endif
  57736. #ifndef SQLITE_OMIT_SHARED_CACHE
  57737. /*
  57738. ** A list of BtShared objects that are eligible for participation
  57739. ** in shared cache. This variable has file scope during normal builds,
  57740. ** but the test harness needs to access it so we make it global for
  57741. ** test builds.
  57742. **
  57743. ** Access to this variable is protected by SQLITE_MUTEX_STATIC_MASTER.
  57744. */
  57745. #ifdef SQLITE_TEST
  57746. SQLITE_PRIVATE BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
  57747. #else
  57748. static BtShared *SQLITE_WSD sqlite3SharedCacheList = 0;
  57749. #endif
  57750. #endif /* SQLITE_OMIT_SHARED_CACHE */
  57751. #ifndef SQLITE_OMIT_SHARED_CACHE
  57752. /*
  57753. ** Enable or disable the shared pager and schema features.
  57754. **
  57755. ** This routine has no effect on existing database connections.
  57756. ** The shared cache setting effects only future calls to
  57757. ** sqlite3_open(), sqlite3_open16(), or sqlite3_open_v2().
  57758. */
  57759. SQLITE_API int sqlite3_enable_shared_cache(int enable){
  57760. sqlite3GlobalConfig.sharedCacheEnabled = enable;
  57761. return SQLITE_OK;
  57762. }
  57763. #endif
  57764. #ifdef SQLITE_OMIT_SHARED_CACHE
  57765. /*
  57766. ** The functions querySharedCacheTableLock(), setSharedCacheTableLock(),
  57767. ** and clearAllSharedCacheTableLocks()
  57768. ** manipulate entries in the BtShared.pLock linked list used to store
  57769. ** shared-cache table level locks. If the library is compiled with the
  57770. ** shared-cache feature disabled, then there is only ever one user
  57771. ** of each BtShared structure and so this locking is not necessary.
  57772. ** So define the lock related functions as no-ops.
  57773. */
  57774. #define querySharedCacheTableLock(a,b,c) SQLITE_OK
  57775. #define setSharedCacheTableLock(a,b,c) SQLITE_OK
  57776. #define clearAllSharedCacheTableLocks(a)
  57777. #define downgradeAllSharedCacheTableLocks(a)
  57778. #define hasSharedCacheTableLock(a,b,c,d) 1
  57779. #define hasReadConflicts(a, b) 0
  57780. #endif
  57781. /*
  57782. ** Implementation of the SQLITE_CORRUPT_PAGE() macro. Takes a single
  57783. ** (MemPage*) as an argument. The (MemPage*) must not be NULL.
  57784. **
  57785. ** If SQLITE_DEBUG is not defined, then this macro is equivalent to
  57786. ** SQLITE_CORRUPT_BKPT. Or, if SQLITE_DEBUG is set, then the log message
  57787. ** normally produced as a side-effect of SQLITE_CORRUPT_BKPT is augmented
  57788. ** with the page number and filename associated with the (MemPage*).
  57789. */
  57790. #ifdef SQLITE_DEBUG
  57791. int corruptPageError(int lineno, MemPage *p){
  57792. char *zMsg;
  57793. sqlite3BeginBenignMalloc();
  57794. zMsg = sqlite3_mprintf("database corruption page %d of %s",
  57795. (int)p->pgno, sqlite3PagerFilename(p->pBt->pPager, 0)
  57796. );
  57797. sqlite3EndBenignMalloc();
  57798. if( zMsg ){
  57799. sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
  57800. }
  57801. sqlite3_free(zMsg);
  57802. return SQLITE_CORRUPT_BKPT;
  57803. }
  57804. # define SQLITE_CORRUPT_PAGE(pMemPage) corruptPageError(__LINE__, pMemPage)
  57805. #else
  57806. # define SQLITE_CORRUPT_PAGE(pMemPage) SQLITE_CORRUPT_PGNO(pMemPage->pgno)
  57807. #endif
  57808. #ifndef SQLITE_OMIT_SHARED_CACHE
  57809. #ifdef SQLITE_DEBUG
  57810. /*
  57811. **** This function is only used as part of an assert() statement. ***
  57812. **
  57813. ** Check to see if pBtree holds the required locks to read or write to the
  57814. ** table with root page iRoot. Return 1 if it does and 0 if not.
  57815. **
  57816. ** For example, when writing to a table with root-page iRoot via
  57817. ** Btree connection pBtree:
  57818. **
  57819. ** assert( hasSharedCacheTableLock(pBtree, iRoot, 0, WRITE_LOCK) );
  57820. **
  57821. ** When writing to an index that resides in a sharable database, the
  57822. ** caller should have first obtained a lock specifying the root page of
  57823. ** the corresponding table. This makes things a bit more complicated,
  57824. ** as this module treats each table as a separate structure. To determine
  57825. ** the table corresponding to the index being written, this
  57826. ** function has to search through the database schema.
  57827. **
  57828. ** Instead of a lock on the table/index rooted at page iRoot, the caller may
  57829. ** hold a write-lock on the schema table (root page 1). This is also
  57830. ** acceptable.
  57831. */
  57832. static int hasSharedCacheTableLock(
  57833. Btree *pBtree, /* Handle that must hold lock */
  57834. Pgno iRoot, /* Root page of b-tree */
  57835. int isIndex, /* True if iRoot is the root of an index b-tree */
  57836. int eLockType /* Required lock type (READ_LOCK or WRITE_LOCK) */
  57837. ){
  57838. Schema *pSchema = (Schema *)pBtree->pBt->pSchema;
  57839. Pgno iTab = 0;
  57840. BtLock *pLock;
  57841. /* If this database is not shareable, or if the client is reading
  57842. ** and has the read-uncommitted flag set, then no lock is required.
  57843. ** Return true immediately.
  57844. */
  57845. if( (pBtree->sharable==0)
  57846. || (eLockType==READ_LOCK && (pBtree->db->flags & SQLITE_ReadUncommit))
  57847. ){
  57848. return 1;
  57849. }
  57850. /* If the client is reading or writing an index and the schema is
  57851. ** not loaded, then it is too difficult to actually check to see if
  57852. ** the correct locks are held. So do not bother - just return true.
  57853. ** This case does not come up very often anyhow.
  57854. */
  57855. if( isIndex && (!pSchema || (pSchema->schemaFlags&DB_SchemaLoaded)==0) ){
  57856. return 1;
  57857. }
  57858. /* Figure out the root-page that the lock should be held on. For table
  57859. ** b-trees, this is just the root page of the b-tree being read or
  57860. ** written. For index b-trees, it is the root page of the associated
  57861. ** table. */
  57862. if( isIndex ){
  57863. HashElem *p;
  57864. for(p=sqliteHashFirst(&pSchema->idxHash); p; p=sqliteHashNext(p)){
  57865. Index *pIdx = (Index *)sqliteHashData(p);
  57866. if( pIdx->tnum==(int)iRoot ){
  57867. if( iTab ){
  57868. /* Two or more indexes share the same root page. There must
  57869. ** be imposter tables. So just return true. The assert is not
  57870. ** useful in that case. */
  57871. return 1;
  57872. }
  57873. iTab = pIdx->pTable->tnum;
  57874. }
  57875. }
  57876. }else{
  57877. iTab = iRoot;
  57878. }
  57879. /* Search for the required lock. Either a write-lock on root-page iTab, a
  57880. ** write-lock on the schema table, or (if the client is reading) a
  57881. ** read-lock on iTab will suffice. Return 1 if any of these are found. */
  57882. for(pLock=pBtree->pBt->pLock; pLock; pLock=pLock->pNext){
  57883. if( pLock->pBtree==pBtree
  57884. && (pLock->iTable==iTab || (pLock->eLock==WRITE_LOCK && pLock->iTable==1))
  57885. && pLock->eLock>=eLockType
  57886. ){
  57887. return 1;
  57888. }
  57889. }
  57890. /* Failed to find the required lock. */
  57891. return 0;
  57892. }
  57893. #endif /* SQLITE_DEBUG */
  57894. #ifdef SQLITE_DEBUG
  57895. /*
  57896. **** This function may be used as part of assert() statements only. ****
  57897. **
  57898. ** Return true if it would be illegal for pBtree to write into the
  57899. ** table or index rooted at iRoot because other shared connections are
  57900. ** simultaneously reading that same table or index.
  57901. **
  57902. ** It is illegal for pBtree to write if some other Btree object that
  57903. ** shares the same BtShared object is currently reading or writing
  57904. ** the iRoot table. Except, if the other Btree object has the
  57905. ** read-uncommitted flag set, then it is OK for the other object to
  57906. ** have a read cursor.
  57907. **
  57908. ** For example, before writing to any part of the table or index
  57909. ** rooted at page iRoot, one should call:
  57910. **
  57911. ** assert( !hasReadConflicts(pBtree, iRoot) );
  57912. */
  57913. static int hasReadConflicts(Btree *pBtree, Pgno iRoot){
  57914. BtCursor *p;
  57915. for(p=pBtree->pBt->pCursor; p; p=p->pNext){
  57916. if( p->pgnoRoot==iRoot
  57917. && p->pBtree!=pBtree
  57918. && 0==(p->pBtree->db->flags & SQLITE_ReadUncommit)
  57919. ){
  57920. return 1;
  57921. }
  57922. }
  57923. return 0;
  57924. }
  57925. #endif /* #ifdef SQLITE_DEBUG */
  57926. /*
  57927. ** Query to see if Btree handle p may obtain a lock of type eLock
  57928. ** (READ_LOCK or WRITE_LOCK) on the table with root-page iTab. Return
  57929. ** SQLITE_OK if the lock may be obtained (by calling
  57930. ** setSharedCacheTableLock()), or SQLITE_LOCKED if not.
  57931. */
  57932. static int querySharedCacheTableLock(Btree *p, Pgno iTab, u8 eLock){
  57933. BtShared *pBt = p->pBt;
  57934. BtLock *pIter;
  57935. assert( sqlite3BtreeHoldsMutex(p) );
  57936. assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
  57937. assert( p->db!=0 );
  57938. assert( !(p->db->flags&SQLITE_ReadUncommit)||eLock==WRITE_LOCK||iTab==1 );
  57939. /* If requesting a write-lock, then the Btree must have an open write
  57940. ** transaction on this file. And, obviously, for this to be so there
  57941. ** must be an open write transaction on the file itself.
  57942. */
  57943. assert( eLock==READ_LOCK || (p==pBt->pWriter && p->inTrans==TRANS_WRITE) );
  57944. assert( eLock==READ_LOCK || pBt->inTransaction==TRANS_WRITE );
  57945. /* This routine is a no-op if the shared-cache is not enabled */
  57946. if( !p->sharable ){
  57947. return SQLITE_OK;
  57948. }
  57949. /* If some other connection is holding an exclusive lock, the
  57950. ** requested lock may not be obtained.
  57951. */
  57952. if( pBt->pWriter!=p && (pBt->btsFlags & BTS_EXCLUSIVE)!=0 ){
  57953. sqlite3ConnectionBlocked(p->db, pBt->pWriter->db);
  57954. return SQLITE_LOCKED_SHAREDCACHE;
  57955. }
  57956. for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
  57957. /* The condition (pIter->eLock!=eLock) in the following if(...)
  57958. ** statement is a simplification of:
  57959. **
  57960. ** (eLock==WRITE_LOCK || pIter->eLock==WRITE_LOCK)
  57961. **
  57962. ** since we know that if eLock==WRITE_LOCK, then no other connection
  57963. ** may hold a WRITE_LOCK on any table in this file (since there can
  57964. ** only be a single writer).
  57965. */
  57966. assert( pIter->eLock==READ_LOCK || pIter->eLock==WRITE_LOCK );
  57967. assert( eLock==READ_LOCK || pIter->pBtree==p || pIter->eLock==READ_LOCK);
  57968. if( pIter->pBtree!=p && pIter->iTable==iTab && pIter->eLock!=eLock ){
  57969. sqlite3ConnectionBlocked(p->db, pIter->pBtree->db);
  57970. if( eLock==WRITE_LOCK ){
  57971. assert( p==pBt->pWriter );
  57972. pBt->btsFlags |= BTS_PENDING;
  57973. }
  57974. return SQLITE_LOCKED_SHAREDCACHE;
  57975. }
  57976. }
  57977. return SQLITE_OK;
  57978. }
  57979. #endif /* !SQLITE_OMIT_SHARED_CACHE */
  57980. #ifndef SQLITE_OMIT_SHARED_CACHE
  57981. /*
  57982. ** Add a lock on the table with root-page iTable to the shared-btree used
  57983. ** by Btree handle p. Parameter eLock must be either READ_LOCK or
  57984. ** WRITE_LOCK.
  57985. **
  57986. ** This function assumes the following:
  57987. **
  57988. ** (a) The specified Btree object p is connected to a sharable
  57989. ** database (one with the BtShared.sharable flag set), and
  57990. **
  57991. ** (b) No other Btree objects hold a lock that conflicts
  57992. ** with the requested lock (i.e. querySharedCacheTableLock() has
  57993. ** already been called and returned SQLITE_OK).
  57994. **
  57995. ** SQLITE_OK is returned if the lock is added successfully. SQLITE_NOMEM
  57996. ** is returned if a malloc attempt fails.
  57997. */
  57998. static int setSharedCacheTableLock(Btree *p, Pgno iTable, u8 eLock){
  57999. BtShared *pBt = p->pBt;
  58000. BtLock *pLock = 0;
  58001. BtLock *pIter;
  58002. assert( sqlite3BtreeHoldsMutex(p) );
  58003. assert( eLock==READ_LOCK || eLock==WRITE_LOCK );
  58004. assert( p->db!=0 );
  58005. /* A connection with the read-uncommitted flag set will never try to
  58006. ** obtain a read-lock using this function. The only read-lock obtained
  58007. ** by a connection in read-uncommitted mode is on the sqlite_master
  58008. ** table, and that lock is obtained in BtreeBeginTrans(). */
  58009. assert( 0==(p->db->flags&SQLITE_ReadUncommit) || eLock==WRITE_LOCK );
  58010. /* This function should only be called on a sharable b-tree after it
  58011. ** has been determined that no other b-tree holds a conflicting lock. */
  58012. assert( p->sharable );
  58013. assert( SQLITE_OK==querySharedCacheTableLock(p, iTable, eLock) );
  58014. /* First search the list for an existing lock on this table. */
  58015. for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
  58016. if( pIter->iTable==iTable && pIter->pBtree==p ){
  58017. pLock = pIter;
  58018. break;
  58019. }
  58020. }
  58021. /* If the above search did not find a BtLock struct associating Btree p
  58022. ** with table iTable, allocate one and link it into the list.
  58023. */
  58024. if( !pLock ){
  58025. pLock = (BtLock *)sqlite3MallocZero(sizeof(BtLock));
  58026. if( !pLock ){
  58027. return SQLITE_NOMEM_BKPT;
  58028. }
  58029. pLock->iTable = iTable;
  58030. pLock->pBtree = p;
  58031. pLock->pNext = pBt->pLock;
  58032. pBt->pLock = pLock;
  58033. }
  58034. /* Set the BtLock.eLock variable to the maximum of the current lock
  58035. ** and the requested lock. This means if a write-lock was already held
  58036. ** and a read-lock requested, we don't incorrectly downgrade the lock.
  58037. */
  58038. assert( WRITE_LOCK>READ_LOCK );
  58039. if( eLock>pLock->eLock ){
  58040. pLock->eLock = eLock;
  58041. }
  58042. return SQLITE_OK;
  58043. }
  58044. #endif /* !SQLITE_OMIT_SHARED_CACHE */
  58045. #ifndef SQLITE_OMIT_SHARED_CACHE
  58046. /*
  58047. ** Release all the table locks (locks obtained via calls to
  58048. ** the setSharedCacheTableLock() procedure) held by Btree object p.
  58049. **
  58050. ** This function assumes that Btree p has an open read or write
  58051. ** transaction. If it does not, then the BTS_PENDING flag
  58052. ** may be incorrectly cleared.
  58053. */
  58054. static void clearAllSharedCacheTableLocks(Btree *p){
  58055. BtShared *pBt = p->pBt;
  58056. BtLock **ppIter = &pBt->pLock;
  58057. assert( sqlite3BtreeHoldsMutex(p) );
  58058. assert( p->sharable || 0==*ppIter );
  58059. assert( p->inTrans>0 );
  58060. while( *ppIter ){
  58061. BtLock *pLock = *ppIter;
  58062. assert( (pBt->btsFlags & BTS_EXCLUSIVE)==0 || pBt->pWriter==pLock->pBtree );
  58063. assert( pLock->pBtree->inTrans>=pLock->eLock );
  58064. if( pLock->pBtree==p ){
  58065. *ppIter = pLock->pNext;
  58066. assert( pLock->iTable!=1 || pLock==&p->lock );
  58067. if( pLock->iTable!=1 ){
  58068. sqlite3_free(pLock);
  58069. }
  58070. }else{
  58071. ppIter = &pLock->pNext;
  58072. }
  58073. }
  58074. assert( (pBt->btsFlags & BTS_PENDING)==0 || pBt->pWriter );
  58075. if( pBt->pWriter==p ){
  58076. pBt->pWriter = 0;
  58077. pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
  58078. }else if( pBt->nTransaction==2 ){
  58079. /* This function is called when Btree p is concluding its
  58080. ** transaction. If there currently exists a writer, and p is not
  58081. ** that writer, then the number of locks held by connections other
  58082. ** than the writer must be about to drop to zero. In this case
  58083. ** set the BTS_PENDING flag to 0.
  58084. **
  58085. ** If there is not currently a writer, then BTS_PENDING must
  58086. ** be zero already. So this next line is harmless in that case.
  58087. */
  58088. pBt->btsFlags &= ~BTS_PENDING;
  58089. }
  58090. }
  58091. /*
  58092. ** This function changes all write-locks held by Btree p into read-locks.
  58093. */
  58094. static void downgradeAllSharedCacheTableLocks(Btree *p){
  58095. BtShared *pBt = p->pBt;
  58096. if( pBt->pWriter==p ){
  58097. BtLock *pLock;
  58098. pBt->pWriter = 0;
  58099. pBt->btsFlags &= ~(BTS_EXCLUSIVE|BTS_PENDING);
  58100. for(pLock=pBt->pLock; pLock; pLock=pLock->pNext){
  58101. assert( pLock->eLock==READ_LOCK || pLock->pBtree==p );
  58102. pLock->eLock = READ_LOCK;
  58103. }
  58104. }
  58105. }
  58106. #endif /* SQLITE_OMIT_SHARED_CACHE */
  58107. static void releasePage(MemPage *pPage); /* Forward reference */
  58108. static void releasePageOne(MemPage *pPage); /* Forward reference */
  58109. static void releasePageNotNull(MemPage *pPage); /* Forward reference */
  58110. /*
  58111. ***** This routine is used inside of assert() only ****
  58112. **
  58113. ** Verify that the cursor holds the mutex on its BtShared
  58114. */
  58115. #ifdef SQLITE_DEBUG
  58116. static int cursorHoldsMutex(BtCursor *p){
  58117. return sqlite3_mutex_held(p->pBt->mutex);
  58118. }
  58119. /* Verify that the cursor and the BtShared agree about what is the current
  58120. ** database connetion. This is important in shared-cache mode. If the database
  58121. ** connection pointers get out-of-sync, it is possible for routines like
  58122. ** btreeInitPage() to reference an stale connection pointer that references a
  58123. ** a connection that has already closed. This routine is used inside assert()
  58124. ** statements only and for the purpose of double-checking that the btree code
  58125. ** does keep the database connection pointers up-to-date.
  58126. */
  58127. static int cursorOwnsBtShared(BtCursor *p){
  58128. assert( cursorHoldsMutex(p) );
  58129. return (p->pBtree->db==p->pBt->db);
  58130. }
  58131. #endif
  58132. /*
  58133. ** Invalidate the overflow cache of the cursor passed as the first argument.
  58134. ** on the shared btree structure pBt.
  58135. */
  58136. #define invalidateOverflowCache(pCur) (pCur->curFlags &= ~BTCF_ValidOvfl)
  58137. /*
  58138. ** Invalidate the overflow page-list cache for all cursors opened
  58139. ** on the shared btree structure pBt.
  58140. */
  58141. static void invalidateAllOverflowCache(BtShared *pBt){
  58142. BtCursor *p;
  58143. assert( sqlite3_mutex_held(pBt->mutex) );
  58144. for(p=pBt->pCursor; p; p=p->pNext){
  58145. invalidateOverflowCache(p);
  58146. }
  58147. }
  58148. #ifndef SQLITE_OMIT_INCRBLOB
  58149. /*
  58150. ** This function is called before modifying the contents of a table
  58151. ** to invalidate any incrblob cursors that are open on the
  58152. ** row or one of the rows being modified.
  58153. **
  58154. ** If argument isClearTable is true, then the entire contents of the
  58155. ** table is about to be deleted. In this case invalidate all incrblob
  58156. ** cursors open on any row within the table with root-page pgnoRoot.
  58157. **
  58158. ** Otherwise, if argument isClearTable is false, then the row with
  58159. ** rowid iRow is being replaced or deleted. In this case invalidate
  58160. ** only those incrblob cursors open on that specific row.
  58161. */
  58162. static void invalidateIncrblobCursors(
  58163. Btree *pBtree, /* The database file to check */
  58164. Pgno pgnoRoot, /* The table that might be changing */
  58165. i64 iRow, /* The rowid that might be changing */
  58166. int isClearTable /* True if all rows are being deleted */
  58167. ){
  58168. BtCursor *p;
  58169. if( pBtree->hasIncrblobCur==0 ) return;
  58170. assert( sqlite3BtreeHoldsMutex(pBtree) );
  58171. pBtree->hasIncrblobCur = 0;
  58172. for(p=pBtree->pBt->pCursor; p; p=p->pNext){
  58173. if( (p->curFlags & BTCF_Incrblob)!=0 ){
  58174. pBtree->hasIncrblobCur = 1;
  58175. if( p->pgnoRoot==pgnoRoot && (isClearTable || p->info.nKey==iRow) ){
  58176. p->eState = CURSOR_INVALID;
  58177. }
  58178. }
  58179. }
  58180. }
  58181. #else
  58182. /* Stub function when INCRBLOB is omitted */
  58183. #define invalidateIncrblobCursors(w,x,y,z)
  58184. #endif /* SQLITE_OMIT_INCRBLOB */
  58185. /*
  58186. ** Set bit pgno of the BtShared.pHasContent bitvec. This is called
  58187. ** when a page that previously contained data becomes a free-list leaf
  58188. ** page.
  58189. **
  58190. ** The BtShared.pHasContent bitvec exists to work around an obscure
  58191. ** bug caused by the interaction of two useful IO optimizations surrounding
  58192. ** free-list leaf pages:
  58193. **
  58194. ** 1) When all data is deleted from a page and the page becomes
  58195. ** a free-list leaf page, the page is not written to the database
  58196. ** (as free-list leaf pages contain no meaningful data). Sometimes
  58197. ** such a page is not even journalled (as it will not be modified,
  58198. ** why bother journalling it?).
  58199. **
  58200. ** 2) When a free-list leaf page is reused, its content is not read
  58201. ** from the database or written to the journal file (why should it
  58202. ** be, if it is not at all meaningful?).
  58203. **
  58204. ** By themselves, these optimizations work fine and provide a handy
  58205. ** performance boost to bulk delete or insert operations. However, if
  58206. ** a page is moved to the free-list and then reused within the same
  58207. ** transaction, a problem comes up. If the page is not journalled when
  58208. ** it is moved to the free-list and it is also not journalled when it
  58209. ** is extracted from the free-list and reused, then the original data
  58210. ** may be lost. In the event of a rollback, it may not be possible
  58211. ** to restore the database to its original configuration.
  58212. **
  58213. ** The solution is the BtShared.pHasContent bitvec. Whenever a page is
  58214. ** moved to become a free-list leaf page, the corresponding bit is
  58215. ** set in the bitvec. Whenever a leaf page is extracted from the free-list,
  58216. ** optimization 2 above is omitted if the corresponding bit is already
  58217. ** set in BtShared.pHasContent. The contents of the bitvec are cleared
  58218. ** at the end of every transaction.
  58219. */
  58220. static int btreeSetHasContent(BtShared *pBt, Pgno pgno){
  58221. int rc = SQLITE_OK;
  58222. if( !pBt->pHasContent ){
  58223. assert( pgno<=pBt->nPage );
  58224. pBt->pHasContent = sqlite3BitvecCreate(pBt->nPage);
  58225. if( !pBt->pHasContent ){
  58226. rc = SQLITE_NOMEM_BKPT;
  58227. }
  58228. }
  58229. if( rc==SQLITE_OK && pgno<=sqlite3BitvecSize(pBt->pHasContent) ){
  58230. rc = sqlite3BitvecSet(pBt->pHasContent, pgno);
  58231. }
  58232. return rc;
  58233. }
  58234. /*
  58235. ** Query the BtShared.pHasContent vector.
  58236. **
  58237. ** This function is called when a free-list leaf page is removed from the
  58238. ** free-list for reuse. It returns false if it is safe to retrieve the
  58239. ** page from the pager layer with the 'no-content' flag set. True otherwise.
  58240. */
  58241. static int btreeGetHasContent(BtShared *pBt, Pgno pgno){
  58242. Bitvec *p = pBt->pHasContent;
  58243. return (p && (pgno>sqlite3BitvecSize(p) || sqlite3BitvecTest(p, pgno)));
  58244. }
  58245. /*
  58246. ** Clear (destroy) the BtShared.pHasContent bitvec. This should be
  58247. ** invoked at the conclusion of each write-transaction.
  58248. */
  58249. static void btreeClearHasContent(BtShared *pBt){
  58250. sqlite3BitvecDestroy(pBt->pHasContent);
  58251. pBt->pHasContent = 0;
  58252. }
  58253. /*
  58254. ** Release all of the apPage[] pages for a cursor.
  58255. */
  58256. static void btreeReleaseAllCursorPages(BtCursor *pCur){
  58257. int i;
  58258. if( pCur->iPage>=0 ){
  58259. for(i=0; i<pCur->iPage; i++){
  58260. releasePageNotNull(pCur->apPage[i]);
  58261. }
  58262. releasePageNotNull(pCur->pPage);
  58263. pCur->iPage = -1;
  58264. }
  58265. }
  58266. /*
  58267. ** The cursor passed as the only argument must point to a valid entry
  58268. ** when this function is called (i.e. have eState==CURSOR_VALID). This
  58269. ** function saves the current cursor key in variables pCur->nKey and
  58270. ** pCur->pKey. SQLITE_OK is returned if successful or an SQLite error
  58271. ** code otherwise.
  58272. **
  58273. ** If the cursor is open on an intkey table, then the integer key
  58274. ** (the rowid) is stored in pCur->nKey and pCur->pKey is left set to
  58275. ** NULL. If the cursor is open on a non-intkey table, then pCur->pKey is
  58276. ** set to point to a malloced buffer pCur->nKey bytes in size containing
  58277. ** the key.
  58278. */
  58279. static int saveCursorKey(BtCursor *pCur){
  58280. int rc = SQLITE_OK;
  58281. assert( CURSOR_VALID==pCur->eState );
  58282. assert( 0==pCur->pKey );
  58283. assert( cursorHoldsMutex(pCur) );
  58284. if( pCur->curIntKey ){
  58285. /* Only the rowid is required for a table btree */
  58286. pCur->nKey = sqlite3BtreeIntegerKey(pCur);
  58287. }else{
  58288. /* For an index btree, save the complete key content */
  58289. void *pKey;
  58290. pCur->nKey = sqlite3BtreePayloadSize(pCur);
  58291. pKey = sqlite3Malloc( pCur->nKey );
  58292. if( pKey ){
  58293. rc = sqlite3BtreePayload(pCur, 0, (int)pCur->nKey, pKey);
  58294. if( rc==SQLITE_OK ){
  58295. pCur->pKey = pKey;
  58296. }else{
  58297. sqlite3_free(pKey);
  58298. }
  58299. }else{
  58300. rc = SQLITE_NOMEM_BKPT;
  58301. }
  58302. }
  58303. assert( !pCur->curIntKey || !pCur->pKey );
  58304. return rc;
  58305. }
  58306. /*
  58307. ** Save the current cursor position in the variables BtCursor.nKey
  58308. ** and BtCursor.pKey. The cursor's state is set to CURSOR_REQUIRESEEK.
  58309. **
  58310. ** The caller must ensure that the cursor is valid (has eState==CURSOR_VALID)
  58311. ** prior to calling this routine.
  58312. */
  58313. static int saveCursorPosition(BtCursor *pCur){
  58314. int rc;
  58315. assert( CURSOR_VALID==pCur->eState || CURSOR_SKIPNEXT==pCur->eState );
  58316. assert( 0==pCur->pKey );
  58317. assert( cursorHoldsMutex(pCur) );
  58318. if( pCur->eState==CURSOR_SKIPNEXT ){
  58319. pCur->eState = CURSOR_VALID;
  58320. }else{
  58321. pCur->skipNext = 0;
  58322. }
  58323. rc = saveCursorKey(pCur);
  58324. if( rc==SQLITE_OK ){
  58325. btreeReleaseAllCursorPages(pCur);
  58326. pCur->eState = CURSOR_REQUIRESEEK;
  58327. }
  58328. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl|BTCF_AtLast);
  58329. return rc;
  58330. }
  58331. /* Forward reference */
  58332. static int SQLITE_NOINLINE saveCursorsOnList(BtCursor*,Pgno,BtCursor*);
  58333. /*
  58334. ** Save the positions of all cursors (except pExcept) that are open on
  58335. ** the table with root-page iRoot. "Saving the cursor position" means that
  58336. ** the location in the btree is remembered in such a way that it can be
  58337. ** moved back to the same spot after the btree has been modified. This
  58338. ** routine is called just before cursor pExcept is used to modify the
  58339. ** table, for example in BtreeDelete() or BtreeInsert().
  58340. **
  58341. ** If there are two or more cursors on the same btree, then all such
  58342. ** cursors should have their BTCF_Multiple flag set. The btreeCursor()
  58343. ** routine enforces that rule. This routine only needs to be called in
  58344. ** the uncommon case when pExpect has the BTCF_Multiple flag set.
  58345. **
  58346. ** If pExpect!=NULL and if no other cursors are found on the same root-page,
  58347. ** then the BTCF_Multiple flag on pExpect is cleared, to avoid another
  58348. ** pointless call to this routine.
  58349. **
  58350. ** Implementation note: This routine merely checks to see if any cursors
  58351. ** need to be saved. It calls out to saveCursorsOnList() in the (unusual)
  58352. ** event that cursors are in need to being saved.
  58353. */
  58354. static int saveAllCursors(BtShared *pBt, Pgno iRoot, BtCursor *pExcept){
  58355. BtCursor *p;
  58356. assert( sqlite3_mutex_held(pBt->mutex) );
  58357. assert( pExcept==0 || pExcept->pBt==pBt );
  58358. for(p=pBt->pCursor; p; p=p->pNext){
  58359. if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ) break;
  58360. }
  58361. if( p ) return saveCursorsOnList(p, iRoot, pExcept);
  58362. if( pExcept ) pExcept->curFlags &= ~BTCF_Multiple;
  58363. return SQLITE_OK;
  58364. }
  58365. /* This helper routine to saveAllCursors does the actual work of saving
  58366. ** the cursors if and when a cursor is found that actually requires saving.
  58367. ** The common case is that no cursors need to be saved, so this routine is
  58368. ** broken out from its caller to avoid unnecessary stack pointer movement.
  58369. */
  58370. static int SQLITE_NOINLINE saveCursorsOnList(
  58371. BtCursor *p, /* The first cursor that needs saving */
  58372. Pgno iRoot, /* Only save cursor with this iRoot. Save all if zero */
  58373. BtCursor *pExcept /* Do not save this cursor */
  58374. ){
  58375. do{
  58376. if( p!=pExcept && (0==iRoot || p->pgnoRoot==iRoot) ){
  58377. if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
  58378. int rc = saveCursorPosition(p);
  58379. if( SQLITE_OK!=rc ){
  58380. return rc;
  58381. }
  58382. }else{
  58383. testcase( p->iPage>=0 );
  58384. btreeReleaseAllCursorPages(p);
  58385. }
  58386. }
  58387. p = p->pNext;
  58388. }while( p );
  58389. return SQLITE_OK;
  58390. }
  58391. /*
  58392. ** Clear the current cursor position.
  58393. */
  58394. SQLITE_PRIVATE void sqlite3BtreeClearCursor(BtCursor *pCur){
  58395. assert( cursorHoldsMutex(pCur) );
  58396. sqlite3_free(pCur->pKey);
  58397. pCur->pKey = 0;
  58398. pCur->eState = CURSOR_INVALID;
  58399. }
  58400. /*
  58401. ** In this version of BtreeMoveto, pKey is a packed index record
  58402. ** such as is generated by the OP_MakeRecord opcode. Unpack the
  58403. ** record and then call BtreeMovetoUnpacked() to do the work.
  58404. */
  58405. static int btreeMoveto(
  58406. BtCursor *pCur, /* Cursor open on the btree to be searched */
  58407. const void *pKey, /* Packed key if the btree is an index */
  58408. i64 nKey, /* Integer key for tables. Size of pKey for indices */
  58409. int bias, /* Bias search to the high end */
  58410. int *pRes /* Write search results here */
  58411. ){
  58412. int rc; /* Status code */
  58413. UnpackedRecord *pIdxKey; /* Unpacked index key */
  58414. if( pKey ){
  58415. assert( nKey==(i64)(int)nKey );
  58416. pIdxKey = sqlite3VdbeAllocUnpackedRecord(pCur->pKeyInfo);
  58417. if( pIdxKey==0 ) return SQLITE_NOMEM_BKPT;
  58418. sqlite3VdbeRecordUnpack(pCur->pKeyInfo, (int)nKey, pKey, pIdxKey);
  58419. if( pIdxKey->nField==0 ){
  58420. rc = SQLITE_CORRUPT_BKPT;
  58421. goto moveto_done;
  58422. }
  58423. }else{
  58424. pIdxKey = 0;
  58425. }
  58426. rc = sqlite3BtreeMovetoUnpacked(pCur, pIdxKey, nKey, bias, pRes);
  58427. moveto_done:
  58428. if( pIdxKey ){
  58429. sqlite3DbFree(pCur->pKeyInfo->db, pIdxKey);
  58430. }
  58431. return rc;
  58432. }
  58433. /*
  58434. ** Restore the cursor to the position it was in (or as close to as possible)
  58435. ** when saveCursorPosition() was called. Note that this call deletes the
  58436. ** saved position info stored by saveCursorPosition(), so there can be
  58437. ** at most one effective restoreCursorPosition() call after each
  58438. ** saveCursorPosition().
  58439. */
  58440. static int btreeRestoreCursorPosition(BtCursor *pCur){
  58441. int rc;
  58442. int skipNext;
  58443. assert( cursorOwnsBtShared(pCur) );
  58444. assert( pCur->eState>=CURSOR_REQUIRESEEK );
  58445. if( pCur->eState==CURSOR_FAULT ){
  58446. return pCur->skipNext;
  58447. }
  58448. pCur->eState = CURSOR_INVALID;
  58449. rc = btreeMoveto(pCur, pCur->pKey, pCur->nKey, 0, &skipNext);
  58450. if( rc==SQLITE_OK ){
  58451. sqlite3_free(pCur->pKey);
  58452. pCur->pKey = 0;
  58453. assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_INVALID );
  58454. pCur->skipNext |= skipNext;
  58455. if( pCur->skipNext && pCur->eState==CURSOR_VALID ){
  58456. pCur->eState = CURSOR_SKIPNEXT;
  58457. }
  58458. }
  58459. return rc;
  58460. }
  58461. #define restoreCursorPosition(p) \
  58462. (p->eState>=CURSOR_REQUIRESEEK ? \
  58463. btreeRestoreCursorPosition(p) : \
  58464. SQLITE_OK)
  58465. /*
  58466. ** Determine whether or not a cursor has moved from the position where
  58467. ** it was last placed, or has been invalidated for any other reason.
  58468. ** Cursors can move when the row they are pointing at is deleted out
  58469. ** from under them, for example. Cursor might also move if a btree
  58470. ** is rebalanced.
  58471. **
  58472. ** Calling this routine with a NULL cursor pointer returns false.
  58473. **
  58474. ** Use the separate sqlite3BtreeCursorRestore() routine to restore a cursor
  58475. ** back to where it ought to be if this routine returns true.
  58476. */
  58477. SQLITE_PRIVATE int sqlite3BtreeCursorHasMoved(BtCursor *pCur){
  58478. return pCur->eState!=CURSOR_VALID;
  58479. }
  58480. /*
  58481. ** Return a pointer to a fake BtCursor object that will always answer
  58482. ** false to the sqlite3BtreeCursorHasMoved() routine above. The fake
  58483. ** cursor returned must not be used with any other Btree interface.
  58484. */
  58485. SQLITE_PRIVATE BtCursor *sqlite3BtreeFakeValidCursor(void){
  58486. static u8 fakeCursor = CURSOR_VALID;
  58487. assert( offsetof(BtCursor, eState)==0 );
  58488. return (BtCursor*)&fakeCursor;
  58489. }
  58490. /*
  58491. ** This routine restores a cursor back to its original position after it
  58492. ** has been moved by some outside activity (such as a btree rebalance or
  58493. ** a row having been deleted out from under the cursor).
  58494. **
  58495. ** On success, the *pDifferentRow parameter is false if the cursor is left
  58496. ** pointing at exactly the same row. *pDifferntRow is the row the cursor
  58497. ** was pointing to has been deleted, forcing the cursor to point to some
  58498. ** nearby row.
  58499. **
  58500. ** This routine should only be called for a cursor that just returned
  58501. ** TRUE from sqlite3BtreeCursorHasMoved().
  58502. */
  58503. SQLITE_PRIVATE int sqlite3BtreeCursorRestore(BtCursor *pCur, int *pDifferentRow){
  58504. int rc;
  58505. assert( pCur!=0 );
  58506. assert( pCur->eState!=CURSOR_VALID );
  58507. rc = restoreCursorPosition(pCur);
  58508. if( rc ){
  58509. *pDifferentRow = 1;
  58510. return rc;
  58511. }
  58512. if( pCur->eState!=CURSOR_VALID ){
  58513. *pDifferentRow = 1;
  58514. }else{
  58515. assert( pCur->skipNext==0 );
  58516. *pDifferentRow = 0;
  58517. }
  58518. return SQLITE_OK;
  58519. }
  58520. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  58521. /*
  58522. ** Provide hints to the cursor. The particular hint given (and the type
  58523. ** and number of the varargs parameters) is determined by the eHintType
  58524. ** parameter. See the definitions of the BTREE_HINT_* macros for details.
  58525. */
  58526. SQLITE_PRIVATE void sqlite3BtreeCursorHint(BtCursor *pCur, int eHintType, ...){
  58527. /* Used only by system that substitute their own storage engine */
  58528. }
  58529. #endif
  58530. /*
  58531. ** Provide flag hints to the cursor.
  58532. */
  58533. SQLITE_PRIVATE void sqlite3BtreeCursorHintFlags(BtCursor *pCur, unsigned x){
  58534. assert( x==BTREE_SEEK_EQ || x==BTREE_BULKLOAD || x==0 );
  58535. pCur->hints = x;
  58536. }
  58537. #ifndef SQLITE_OMIT_AUTOVACUUM
  58538. /*
  58539. ** Given a page number of a regular database page, return the page
  58540. ** number for the pointer-map page that contains the entry for the
  58541. ** input page number.
  58542. **
  58543. ** Return 0 (not a valid page) for pgno==1 since there is
  58544. ** no pointer map associated with page 1. The integrity_check logic
  58545. ** requires that ptrmapPageno(*,1)!=1.
  58546. */
  58547. static Pgno ptrmapPageno(BtShared *pBt, Pgno pgno){
  58548. int nPagesPerMapPage;
  58549. Pgno iPtrMap, ret;
  58550. assert( sqlite3_mutex_held(pBt->mutex) );
  58551. if( pgno<2 ) return 0;
  58552. nPagesPerMapPage = (pBt->usableSize/5)+1;
  58553. iPtrMap = (pgno-2)/nPagesPerMapPage;
  58554. ret = (iPtrMap*nPagesPerMapPage) + 2;
  58555. if( ret==PENDING_BYTE_PAGE(pBt) ){
  58556. ret++;
  58557. }
  58558. return ret;
  58559. }
  58560. /*
  58561. ** Write an entry into the pointer map.
  58562. **
  58563. ** This routine updates the pointer map entry for page number 'key'
  58564. ** so that it maps to type 'eType' and parent page number 'pgno'.
  58565. **
  58566. ** If *pRC is initially non-zero (non-SQLITE_OK) then this routine is
  58567. ** a no-op. If an error occurs, the appropriate error code is written
  58568. ** into *pRC.
  58569. */
  58570. static void ptrmapPut(BtShared *pBt, Pgno key, u8 eType, Pgno parent, int *pRC){
  58571. DbPage *pDbPage; /* The pointer map page */
  58572. u8 *pPtrmap; /* The pointer map data */
  58573. Pgno iPtrmap; /* The pointer map page number */
  58574. int offset; /* Offset in pointer map page */
  58575. int rc; /* Return code from subfunctions */
  58576. if( *pRC ) return;
  58577. assert( sqlite3_mutex_held(pBt->mutex) );
  58578. /* The master-journal page number must never be used as a pointer map page */
  58579. assert( 0==PTRMAP_ISPAGE(pBt, PENDING_BYTE_PAGE(pBt)) );
  58580. assert( pBt->autoVacuum );
  58581. if( key==0 ){
  58582. *pRC = SQLITE_CORRUPT_BKPT;
  58583. return;
  58584. }
  58585. iPtrmap = PTRMAP_PAGENO(pBt, key);
  58586. rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
  58587. if( rc!=SQLITE_OK ){
  58588. *pRC = rc;
  58589. return;
  58590. }
  58591. offset = PTRMAP_PTROFFSET(iPtrmap, key);
  58592. if( offset<0 ){
  58593. *pRC = SQLITE_CORRUPT_BKPT;
  58594. goto ptrmap_exit;
  58595. }
  58596. assert( offset <= (int)pBt->usableSize-5 );
  58597. pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
  58598. if( eType!=pPtrmap[offset] || get4byte(&pPtrmap[offset+1])!=parent ){
  58599. TRACE(("PTRMAP_UPDATE: %d->(%d,%d)\n", key, eType, parent));
  58600. *pRC= rc = sqlite3PagerWrite(pDbPage);
  58601. if( rc==SQLITE_OK ){
  58602. pPtrmap[offset] = eType;
  58603. put4byte(&pPtrmap[offset+1], parent);
  58604. }
  58605. }
  58606. ptrmap_exit:
  58607. sqlite3PagerUnref(pDbPage);
  58608. }
  58609. /*
  58610. ** Read an entry from the pointer map.
  58611. **
  58612. ** This routine retrieves the pointer map entry for page 'key', writing
  58613. ** the type and parent page number to *pEType and *pPgno respectively.
  58614. ** An error code is returned if something goes wrong, otherwise SQLITE_OK.
  58615. */
  58616. static int ptrmapGet(BtShared *pBt, Pgno key, u8 *pEType, Pgno *pPgno){
  58617. DbPage *pDbPage; /* The pointer map page */
  58618. int iPtrmap; /* Pointer map page index */
  58619. u8 *pPtrmap; /* Pointer map page data */
  58620. int offset; /* Offset of entry in pointer map */
  58621. int rc;
  58622. assert( sqlite3_mutex_held(pBt->mutex) );
  58623. iPtrmap = PTRMAP_PAGENO(pBt, key);
  58624. rc = sqlite3PagerGet(pBt->pPager, iPtrmap, &pDbPage, 0);
  58625. if( rc!=0 ){
  58626. return rc;
  58627. }
  58628. pPtrmap = (u8 *)sqlite3PagerGetData(pDbPage);
  58629. offset = PTRMAP_PTROFFSET(iPtrmap, key);
  58630. if( offset<0 ){
  58631. sqlite3PagerUnref(pDbPage);
  58632. return SQLITE_CORRUPT_BKPT;
  58633. }
  58634. assert( offset <= (int)pBt->usableSize-5 );
  58635. assert( pEType!=0 );
  58636. *pEType = pPtrmap[offset];
  58637. if( pPgno ) *pPgno = get4byte(&pPtrmap[offset+1]);
  58638. sqlite3PagerUnref(pDbPage);
  58639. if( *pEType<1 || *pEType>5 ) return SQLITE_CORRUPT_PGNO(iPtrmap);
  58640. return SQLITE_OK;
  58641. }
  58642. #else /* if defined SQLITE_OMIT_AUTOVACUUM */
  58643. #define ptrmapPut(w,x,y,z,rc)
  58644. #define ptrmapGet(w,x,y,z) SQLITE_OK
  58645. #define ptrmapPutOvflPtr(x, y, rc)
  58646. #endif
  58647. /*
  58648. ** Given a btree page and a cell index (0 means the first cell on
  58649. ** the page, 1 means the second cell, and so forth) return a pointer
  58650. ** to the cell content.
  58651. **
  58652. ** findCellPastPtr() does the same except it skips past the initial
  58653. ** 4-byte child pointer found on interior pages, if there is one.
  58654. **
  58655. ** This routine works only for pages that do not contain overflow cells.
  58656. */
  58657. #define findCell(P,I) \
  58658. ((P)->aData + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
  58659. #define findCellPastPtr(P,I) \
  58660. ((P)->aDataOfst + ((P)->maskPage & get2byteAligned(&(P)->aCellIdx[2*(I)])))
  58661. /*
  58662. ** This is common tail processing for btreeParseCellPtr() and
  58663. ** btreeParseCellPtrIndex() for the case when the cell does not fit entirely
  58664. ** on a single B-tree page. Make necessary adjustments to the CellInfo
  58665. ** structure.
  58666. */
  58667. static SQLITE_NOINLINE void btreeParseCellAdjustSizeForOverflow(
  58668. MemPage *pPage, /* Page containing the cell */
  58669. u8 *pCell, /* Pointer to the cell text. */
  58670. CellInfo *pInfo /* Fill in this structure */
  58671. ){
  58672. /* If the payload will not fit completely on the local page, we have
  58673. ** to decide how much to store locally and how much to spill onto
  58674. ** overflow pages. The strategy is to minimize the amount of unused
  58675. ** space on overflow pages while keeping the amount of local storage
  58676. ** in between minLocal and maxLocal.
  58677. **
  58678. ** Warning: changing the way overflow payload is distributed in any
  58679. ** way will result in an incompatible file format.
  58680. */
  58681. int minLocal; /* Minimum amount of payload held locally */
  58682. int maxLocal; /* Maximum amount of payload held locally */
  58683. int surplus; /* Overflow payload available for local storage */
  58684. minLocal = pPage->minLocal;
  58685. maxLocal = pPage->maxLocal;
  58686. surplus = minLocal + (pInfo->nPayload - minLocal)%(pPage->pBt->usableSize-4);
  58687. testcase( surplus==maxLocal );
  58688. testcase( surplus==maxLocal+1 );
  58689. if( surplus <= maxLocal ){
  58690. pInfo->nLocal = (u16)surplus;
  58691. }else{
  58692. pInfo->nLocal = (u16)minLocal;
  58693. }
  58694. pInfo->nSize = (u16)(&pInfo->pPayload[pInfo->nLocal] - pCell) + 4;
  58695. }
  58696. /*
  58697. ** The following routines are implementations of the MemPage.xParseCell()
  58698. ** method.
  58699. **
  58700. ** Parse a cell content block and fill in the CellInfo structure.
  58701. **
  58702. ** btreeParseCellPtr() => table btree leaf nodes
  58703. ** btreeParseCellNoPayload() => table btree internal nodes
  58704. ** btreeParseCellPtrIndex() => index btree nodes
  58705. **
  58706. ** There is also a wrapper function btreeParseCell() that works for
  58707. ** all MemPage types and that references the cell by index rather than
  58708. ** by pointer.
  58709. */
  58710. static void btreeParseCellPtrNoPayload(
  58711. MemPage *pPage, /* Page containing the cell */
  58712. u8 *pCell, /* Pointer to the cell text. */
  58713. CellInfo *pInfo /* Fill in this structure */
  58714. ){
  58715. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  58716. assert( pPage->leaf==0 );
  58717. assert( pPage->childPtrSize==4 );
  58718. #ifndef SQLITE_DEBUG
  58719. UNUSED_PARAMETER(pPage);
  58720. #endif
  58721. pInfo->nSize = 4 + getVarint(&pCell[4], (u64*)&pInfo->nKey);
  58722. pInfo->nPayload = 0;
  58723. pInfo->nLocal = 0;
  58724. pInfo->pPayload = 0;
  58725. return;
  58726. }
  58727. static void btreeParseCellPtr(
  58728. MemPage *pPage, /* Page containing the cell */
  58729. u8 *pCell, /* Pointer to the cell text. */
  58730. CellInfo *pInfo /* Fill in this structure */
  58731. ){
  58732. u8 *pIter; /* For scanning through pCell */
  58733. u32 nPayload; /* Number of bytes of cell payload */
  58734. u64 iKey; /* Extracted Key value */
  58735. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  58736. assert( pPage->leaf==0 || pPage->leaf==1 );
  58737. assert( pPage->intKeyLeaf );
  58738. assert( pPage->childPtrSize==0 );
  58739. pIter = pCell;
  58740. /* The next block of code is equivalent to:
  58741. **
  58742. ** pIter += getVarint32(pIter, nPayload);
  58743. **
  58744. ** The code is inlined to avoid a function call.
  58745. */
  58746. nPayload = *pIter;
  58747. if( nPayload>=0x80 ){
  58748. u8 *pEnd = &pIter[8];
  58749. nPayload &= 0x7f;
  58750. do{
  58751. nPayload = (nPayload<<7) | (*++pIter & 0x7f);
  58752. }while( (*pIter)>=0x80 && pIter<pEnd );
  58753. }
  58754. pIter++;
  58755. /* The next block of code is equivalent to:
  58756. **
  58757. ** pIter += getVarint(pIter, (u64*)&pInfo->nKey);
  58758. **
  58759. ** The code is inlined to avoid a function call.
  58760. */
  58761. iKey = *pIter;
  58762. if( iKey>=0x80 ){
  58763. u8 *pEnd = &pIter[7];
  58764. iKey &= 0x7f;
  58765. while(1){
  58766. iKey = (iKey<<7) | (*++pIter & 0x7f);
  58767. if( (*pIter)<0x80 ) break;
  58768. if( pIter>=pEnd ){
  58769. iKey = (iKey<<8) | *++pIter;
  58770. break;
  58771. }
  58772. }
  58773. }
  58774. pIter++;
  58775. pInfo->nKey = *(i64*)&iKey;
  58776. pInfo->nPayload = nPayload;
  58777. pInfo->pPayload = pIter;
  58778. testcase( nPayload==pPage->maxLocal );
  58779. testcase( nPayload==pPage->maxLocal+1 );
  58780. if( nPayload<=pPage->maxLocal ){
  58781. /* This is the (easy) common case where the entire payload fits
  58782. ** on the local page. No overflow is required.
  58783. */
  58784. pInfo->nSize = nPayload + (u16)(pIter - pCell);
  58785. if( pInfo->nSize<4 ) pInfo->nSize = 4;
  58786. pInfo->nLocal = (u16)nPayload;
  58787. }else{
  58788. btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
  58789. }
  58790. }
  58791. static void btreeParseCellPtrIndex(
  58792. MemPage *pPage, /* Page containing the cell */
  58793. u8 *pCell, /* Pointer to the cell text. */
  58794. CellInfo *pInfo /* Fill in this structure */
  58795. ){
  58796. u8 *pIter; /* For scanning through pCell */
  58797. u32 nPayload; /* Number of bytes of cell payload */
  58798. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  58799. assert( pPage->leaf==0 || pPage->leaf==1 );
  58800. assert( pPage->intKeyLeaf==0 );
  58801. pIter = pCell + pPage->childPtrSize;
  58802. nPayload = *pIter;
  58803. if( nPayload>=0x80 ){
  58804. u8 *pEnd = &pIter[8];
  58805. nPayload &= 0x7f;
  58806. do{
  58807. nPayload = (nPayload<<7) | (*++pIter & 0x7f);
  58808. }while( *(pIter)>=0x80 && pIter<pEnd );
  58809. }
  58810. pIter++;
  58811. pInfo->nKey = nPayload;
  58812. pInfo->nPayload = nPayload;
  58813. pInfo->pPayload = pIter;
  58814. testcase( nPayload==pPage->maxLocal );
  58815. testcase( nPayload==pPage->maxLocal+1 );
  58816. if( nPayload<=pPage->maxLocal ){
  58817. /* This is the (easy) common case where the entire payload fits
  58818. ** on the local page. No overflow is required.
  58819. */
  58820. pInfo->nSize = nPayload + (u16)(pIter - pCell);
  58821. if( pInfo->nSize<4 ) pInfo->nSize = 4;
  58822. pInfo->nLocal = (u16)nPayload;
  58823. }else{
  58824. btreeParseCellAdjustSizeForOverflow(pPage, pCell, pInfo);
  58825. }
  58826. }
  58827. static void btreeParseCell(
  58828. MemPage *pPage, /* Page containing the cell */
  58829. int iCell, /* The cell index. First cell is 0 */
  58830. CellInfo *pInfo /* Fill in this structure */
  58831. ){
  58832. pPage->xParseCell(pPage, findCell(pPage, iCell), pInfo);
  58833. }
  58834. /*
  58835. ** The following routines are implementations of the MemPage.xCellSize
  58836. ** method.
  58837. **
  58838. ** Compute the total number of bytes that a Cell needs in the cell
  58839. ** data area of the btree-page. The return number includes the cell
  58840. ** data header and the local payload, but not any overflow page or
  58841. ** the space used by the cell pointer.
  58842. **
  58843. ** cellSizePtrNoPayload() => table internal nodes
  58844. ** cellSizePtr() => all index nodes & table leaf nodes
  58845. */
  58846. static u16 cellSizePtr(MemPage *pPage, u8 *pCell){
  58847. u8 *pIter = pCell + pPage->childPtrSize; /* For looping over bytes of pCell */
  58848. u8 *pEnd; /* End mark for a varint */
  58849. u32 nSize; /* Size value to return */
  58850. #ifdef SQLITE_DEBUG
  58851. /* The value returned by this function should always be the same as
  58852. ** the (CellInfo.nSize) value found by doing a full parse of the
  58853. ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
  58854. ** this function verifies that this invariant is not violated. */
  58855. CellInfo debuginfo;
  58856. pPage->xParseCell(pPage, pCell, &debuginfo);
  58857. #endif
  58858. nSize = *pIter;
  58859. if( nSize>=0x80 ){
  58860. pEnd = &pIter[8];
  58861. nSize &= 0x7f;
  58862. do{
  58863. nSize = (nSize<<7) | (*++pIter & 0x7f);
  58864. }while( *(pIter)>=0x80 && pIter<pEnd );
  58865. }
  58866. pIter++;
  58867. if( pPage->intKey ){
  58868. /* pIter now points at the 64-bit integer key value, a variable length
  58869. ** integer. The following block moves pIter to point at the first byte
  58870. ** past the end of the key value. */
  58871. pEnd = &pIter[9];
  58872. while( (*pIter++)&0x80 && pIter<pEnd );
  58873. }
  58874. testcase( nSize==pPage->maxLocal );
  58875. testcase( nSize==pPage->maxLocal+1 );
  58876. if( nSize<=pPage->maxLocal ){
  58877. nSize += (u32)(pIter - pCell);
  58878. if( nSize<4 ) nSize = 4;
  58879. }else{
  58880. int minLocal = pPage->minLocal;
  58881. nSize = minLocal + (nSize - minLocal) % (pPage->pBt->usableSize - 4);
  58882. testcase( nSize==pPage->maxLocal );
  58883. testcase( nSize==pPage->maxLocal+1 );
  58884. if( nSize>pPage->maxLocal ){
  58885. nSize = minLocal;
  58886. }
  58887. nSize += 4 + (u16)(pIter - pCell);
  58888. }
  58889. assert( nSize==debuginfo.nSize || CORRUPT_DB );
  58890. return (u16)nSize;
  58891. }
  58892. static u16 cellSizePtrNoPayload(MemPage *pPage, u8 *pCell){
  58893. u8 *pIter = pCell + 4; /* For looping over bytes of pCell */
  58894. u8 *pEnd; /* End mark for a varint */
  58895. #ifdef SQLITE_DEBUG
  58896. /* The value returned by this function should always be the same as
  58897. ** the (CellInfo.nSize) value found by doing a full parse of the
  58898. ** cell. If SQLITE_DEBUG is defined, an assert() at the bottom of
  58899. ** this function verifies that this invariant is not violated. */
  58900. CellInfo debuginfo;
  58901. pPage->xParseCell(pPage, pCell, &debuginfo);
  58902. #else
  58903. UNUSED_PARAMETER(pPage);
  58904. #endif
  58905. assert( pPage->childPtrSize==4 );
  58906. pEnd = pIter + 9;
  58907. while( (*pIter++)&0x80 && pIter<pEnd );
  58908. assert( debuginfo.nSize==(u16)(pIter - pCell) || CORRUPT_DB );
  58909. return (u16)(pIter - pCell);
  58910. }
  58911. #ifdef SQLITE_DEBUG
  58912. /* This variation on cellSizePtr() is used inside of assert() statements
  58913. ** only. */
  58914. static u16 cellSize(MemPage *pPage, int iCell){
  58915. return pPage->xCellSize(pPage, findCell(pPage, iCell));
  58916. }
  58917. #endif
  58918. #ifndef SQLITE_OMIT_AUTOVACUUM
  58919. /*
  58920. ** If the cell pCell, part of page pPage contains a pointer
  58921. ** to an overflow page, insert an entry into the pointer-map
  58922. ** for the overflow page.
  58923. */
  58924. static void ptrmapPutOvflPtr(MemPage *pPage, u8 *pCell, int *pRC){
  58925. CellInfo info;
  58926. if( *pRC ) return;
  58927. assert( pCell!=0 );
  58928. pPage->xParseCell(pPage, pCell, &info);
  58929. if( info.nLocal<info.nPayload ){
  58930. Pgno ovfl = get4byte(&pCell[info.nSize-4]);
  58931. ptrmapPut(pPage->pBt, ovfl, PTRMAP_OVERFLOW1, pPage->pgno, pRC);
  58932. }
  58933. }
  58934. #endif
  58935. /*
  58936. ** Defragment the page given. This routine reorganizes cells within the
  58937. ** page so that there are no free-blocks on the free-block list.
  58938. **
  58939. ** Parameter nMaxFrag is the maximum amount of fragmented space that may be
  58940. ** present in the page after this routine returns.
  58941. **
  58942. ** EVIDENCE-OF: R-44582-60138 SQLite may from time to time reorganize a
  58943. ** b-tree page so that there are no freeblocks or fragment bytes, all
  58944. ** unused bytes are contained in the unallocated space region, and all
  58945. ** cells are packed tightly at the end of the page.
  58946. */
  58947. static int defragmentPage(MemPage *pPage, int nMaxFrag){
  58948. int i; /* Loop counter */
  58949. int pc; /* Address of the i-th cell */
  58950. int hdr; /* Offset to the page header */
  58951. int size; /* Size of a cell */
  58952. int usableSize; /* Number of usable bytes on a page */
  58953. int cellOffset; /* Offset to the cell pointer array */
  58954. int cbrk; /* Offset to the cell content area */
  58955. int nCell; /* Number of cells on the page */
  58956. unsigned char *data; /* The page data */
  58957. unsigned char *temp; /* Temp area for cell content */
  58958. unsigned char *src; /* Source of content */
  58959. int iCellFirst; /* First allowable cell index */
  58960. int iCellLast; /* Last possible cell index */
  58961. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  58962. assert( pPage->pBt!=0 );
  58963. assert( pPage->pBt->usableSize <= SQLITE_MAX_PAGE_SIZE );
  58964. assert( pPage->nOverflow==0 );
  58965. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  58966. temp = 0;
  58967. src = data = pPage->aData;
  58968. hdr = pPage->hdrOffset;
  58969. cellOffset = pPage->cellOffset;
  58970. nCell = pPage->nCell;
  58971. assert( nCell==get2byte(&data[hdr+3]) );
  58972. iCellFirst = cellOffset + 2*nCell;
  58973. usableSize = pPage->pBt->usableSize;
  58974. /* This block handles pages with two or fewer free blocks and nMaxFrag
  58975. ** or fewer fragmented bytes. In this case it is faster to move the
  58976. ** two (or one) blocks of cells using memmove() and add the required
  58977. ** offsets to each pointer in the cell-pointer array than it is to
  58978. ** reconstruct the entire page. */
  58979. if( (int)data[hdr+7]<=nMaxFrag ){
  58980. int iFree = get2byte(&data[hdr+1]);
  58981. if( iFree ){
  58982. int iFree2 = get2byte(&data[iFree]);
  58983. /* pageFindSlot() has already verified that free blocks are sorted
  58984. ** in order of offset within the page, and that no block extends
  58985. ** past the end of the page. Provided the two free slots do not
  58986. ** overlap, this guarantees that the memmove() calls below will not
  58987. ** overwrite the usableSize byte buffer, even if the database page
  58988. ** is corrupt. */
  58989. assert( iFree2==0 || iFree2>iFree );
  58990. assert( iFree+get2byte(&data[iFree+2]) <= usableSize );
  58991. assert( iFree2==0 || iFree2+get2byte(&data[iFree2+2]) <= usableSize );
  58992. if( 0==iFree2 || (data[iFree2]==0 && data[iFree2+1]==0) ){
  58993. u8 *pEnd = &data[cellOffset + nCell*2];
  58994. u8 *pAddr;
  58995. int sz2 = 0;
  58996. int sz = get2byte(&data[iFree+2]);
  58997. int top = get2byte(&data[hdr+5]);
  58998. if( top>=iFree ){
  58999. return SQLITE_CORRUPT_PAGE(pPage);
  59000. }
  59001. if( iFree2 ){
  59002. assert( iFree+sz<=iFree2 ); /* Verified by pageFindSlot() */
  59003. sz2 = get2byte(&data[iFree2+2]);
  59004. assert( iFree+sz+sz2+iFree2-(iFree+sz) <= usableSize );
  59005. memmove(&data[iFree+sz+sz2], &data[iFree+sz], iFree2-(iFree+sz));
  59006. sz += sz2;
  59007. }
  59008. cbrk = top+sz;
  59009. assert( cbrk+(iFree-top) <= usableSize );
  59010. memmove(&data[cbrk], &data[top], iFree-top);
  59011. for(pAddr=&data[cellOffset]; pAddr<pEnd; pAddr+=2){
  59012. pc = get2byte(pAddr);
  59013. if( pc<iFree ){ put2byte(pAddr, pc+sz); }
  59014. else if( pc<iFree2 ){ put2byte(pAddr, pc+sz2); }
  59015. }
  59016. goto defragment_out;
  59017. }
  59018. }
  59019. }
  59020. cbrk = usableSize;
  59021. iCellLast = usableSize - 4;
  59022. for(i=0; i<nCell; i++){
  59023. u8 *pAddr; /* The i-th cell pointer */
  59024. pAddr = &data[cellOffset + i*2];
  59025. pc = get2byte(pAddr);
  59026. testcase( pc==iCellFirst );
  59027. testcase( pc==iCellLast );
  59028. /* These conditions have already been verified in btreeInitPage()
  59029. ** if PRAGMA cell_size_check=ON.
  59030. */
  59031. if( pc<iCellFirst || pc>iCellLast ){
  59032. return SQLITE_CORRUPT_PAGE(pPage);
  59033. }
  59034. assert( pc>=iCellFirst && pc<=iCellLast );
  59035. size = pPage->xCellSize(pPage, &src[pc]);
  59036. cbrk -= size;
  59037. if( cbrk<iCellFirst || pc+size>usableSize ){
  59038. return SQLITE_CORRUPT_PAGE(pPage);
  59039. }
  59040. assert( cbrk+size<=usableSize && cbrk>=iCellFirst );
  59041. testcase( cbrk+size==usableSize );
  59042. testcase( pc+size==usableSize );
  59043. put2byte(pAddr, cbrk);
  59044. if( temp==0 ){
  59045. int x;
  59046. if( cbrk==pc ) continue;
  59047. temp = sqlite3PagerTempSpace(pPage->pBt->pPager);
  59048. x = get2byte(&data[hdr+5]);
  59049. memcpy(&temp[x], &data[x], (cbrk+size) - x);
  59050. src = temp;
  59051. }
  59052. memcpy(&data[cbrk], &src[pc], size);
  59053. }
  59054. data[hdr+7] = 0;
  59055. defragment_out:
  59056. if( data[hdr+7]+cbrk-iCellFirst!=pPage->nFree ){
  59057. return SQLITE_CORRUPT_PAGE(pPage);
  59058. }
  59059. assert( cbrk>=iCellFirst );
  59060. put2byte(&data[hdr+5], cbrk);
  59061. data[hdr+1] = 0;
  59062. data[hdr+2] = 0;
  59063. memset(&data[iCellFirst], 0, cbrk-iCellFirst);
  59064. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  59065. return SQLITE_OK;
  59066. }
  59067. /*
  59068. ** Search the free-list on page pPg for space to store a cell nByte bytes in
  59069. ** size. If one can be found, return a pointer to the space and remove it
  59070. ** from the free-list.
  59071. **
  59072. ** If no suitable space can be found on the free-list, return NULL.
  59073. **
  59074. ** This function may detect corruption within pPg. If corruption is
  59075. ** detected then *pRc is set to SQLITE_CORRUPT and NULL is returned.
  59076. **
  59077. ** Slots on the free list that are between 1 and 3 bytes larger than nByte
  59078. ** will be ignored if adding the extra space to the fragmentation count
  59079. ** causes the fragmentation count to exceed 60.
  59080. */
  59081. static u8 *pageFindSlot(MemPage *pPg, int nByte, int *pRc){
  59082. const int hdr = pPg->hdrOffset;
  59083. u8 * const aData = pPg->aData;
  59084. int iAddr = hdr + 1;
  59085. int pc = get2byte(&aData[iAddr]);
  59086. int x;
  59087. int usableSize = pPg->pBt->usableSize;
  59088. int size; /* Size of the free slot */
  59089. assert( pc>0 );
  59090. while( pc<=usableSize-4 ){
  59091. /* EVIDENCE-OF: R-22710-53328 The third and fourth bytes of each
  59092. ** freeblock form a big-endian integer which is the size of the freeblock
  59093. ** in bytes, including the 4-byte header. */
  59094. size = get2byte(&aData[pc+2]);
  59095. if( (x = size - nByte)>=0 ){
  59096. testcase( x==4 );
  59097. testcase( x==3 );
  59098. if( size+pc > usableSize ){
  59099. *pRc = SQLITE_CORRUPT_PAGE(pPg);
  59100. return 0;
  59101. }else if( x<4 ){
  59102. /* EVIDENCE-OF: R-11498-58022 In a well-formed b-tree page, the total
  59103. ** number of bytes in fragments may not exceed 60. */
  59104. if( aData[hdr+7]>57 ) return 0;
  59105. /* Remove the slot from the free-list. Update the number of
  59106. ** fragmented bytes within the page. */
  59107. memcpy(&aData[iAddr], &aData[pc], 2);
  59108. aData[hdr+7] += (u8)x;
  59109. }else{
  59110. /* The slot remains on the free-list. Reduce its size to account
  59111. ** for the portion used by the new allocation. */
  59112. put2byte(&aData[pc+2], x);
  59113. }
  59114. return &aData[pc + x];
  59115. }
  59116. iAddr = pc;
  59117. pc = get2byte(&aData[pc]);
  59118. if( pc<iAddr+size ) break;
  59119. }
  59120. if( pc ){
  59121. *pRc = SQLITE_CORRUPT_PAGE(pPg);
  59122. }
  59123. return 0;
  59124. }
  59125. /*
  59126. ** Allocate nByte bytes of space from within the B-Tree page passed
  59127. ** as the first argument. Write into *pIdx the index into pPage->aData[]
  59128. ** of the first byte of allocated space. Return either SQLITE_OK or
  59129. ** an error code (usually SQLITE_CORRUPT).
  59130. **
  59131. ** The caller guarantees that there is sufficient space to make the
  59132. ** allocation. This routine might need to defragment in order to bring
  59133. ** all the space together, however. This routine will avoid using
  59134. ** the first two bytes past the cell pointer area since presumably this
  59135. ** allocation is being made in order to insert a new cell, so we will
  59136. ** also end up needing a new cell pointer.
  59137. */
  59138. static int allocateSpace(MemPage *pPage, int nByte, int *pIdx){
  59139. const int hdr = pPage->hdrOffset; /* Local cache of pPage->hdrOffset */
  59140. u8 * const data = pPage->aData; /* Local cache of pPage->aData */
  59141. int top; /* First byte of cell content area */
  59142. int rc = SQLITE_OK; /* Integer return code */
  59143. int gap; /* First byte of gap between cell pointers and cell content */
  59144. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  59145. assert( pPage->pBt );
  59146. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59147. assert( nByte>=0 ); /* Minimum cell size is 4 */
  59148. assert( pPage->nFree>=nByte );
  59149. assert( pPage->nOverflow==0 );
  59150. assert( nByte < (int)(pPage->pBt->usableSize-8) );
  59151. assert( pPage->cellOffset == hdr + 12 - 4*pPage->leaf );
  59152. gap = pPage->cellOffset + 2*pPage->nCell;
  59153. assert( gap<=65536 );
  59154. /* EVIDENCE-OF: R-29356-02391 If the database uses a 65536-byte page size
  59155. ** and the reserved space is zero (the usual value for reserved space)
  59156. ** then the cell content offset of an empty page wants to be 65536.
  59157. ** However, that integer is too large to be stored in a 2-byte unsigned
  59158. ** integer, so a value of 0 is used in its place. */
  59159. top = get2byte(&data[hdr+5]);
  59160. assert( top<=(int)pPage->pBt->usableSize ); /* Prevent by getAndInitPage() */
  59161. if( gap>top ){
  59162. if( top==0 && pPage->pBt->usableSize==65536 ){
  59163. top = 65536;
  59164. }else{
  59165. return SQLITE_CORRUPT_PAGE(pPage);
  59166. }
  59167. }
  59168. /* If there is enough space between gap and top for one more cell pointer
  59169. ** array entry offset, and if the freelist is not empty, then search the
  59170. ** freelist looking for a free slot big enough to satisfy the request.
  59171. */
  59172. testcase( gap+2==top );
  59173. testcase( gap+1==top );
  59174. testcase( gap==top );
  59175. if( (data[hdr+2] || data[hdr+1]) && gap+2<=top ){
  59176. u8 *pSpace = pageFindSlot(pPage, nByte, &rc);
  59177. if( pSpace ){
  59178. assert( pSpace>=data && (pSpace - data)<65536 );
  59179. *pIdx = (int)(pSpace - data);
  59180. return SQLITE_OK;
  59181. }else if( rc ){
  59182. return rc;
  59183. }
  59184. }
  59185. /* The request could not be fulfilled using a freelist slot. Check
  59186. ** to see if defragmentation is necessary.
  59187. */
  59188. testcase( gap+2+nByte==top );
  59189. if( gap+2+nByte>top ){
  59190. assert( pPage->nCell>0 || CORRUPT_DB );
  59191. rc = defragmentPage(pPage, MIN(4, pPage->nFree - (2+nByte)));
  59192. if( rc ) return rc;
  59193. top = get2byteNotZero(&data[hdr+5]);
  59194. assert( gap+2+nByte<=top );
  59195. }
  59196. /* Allocate memory from the gap in between the cell pointer array
  59197. ** and the cell content area. The btreeInitPage() call has already
  59198. ** validated the freelist. Given that the freelist is valid, there
  59199. ** is no way that the allocation can extend off the end of the page.
  59200. ** The assert() below verifies the previous sentence.
  59201. */
  59202. top -= nByte;
  59203. put2byte(&data[hdr+5], top);
  59204. assert( top+nByte <= (int)pPage->pBt->usableSize );
  59205. *pIdx = top;
  59206. return SQLITE_OK;
  59207. }
  59208. /*
  59209. ** Return a section of the pPage->aData to the freelist.
  59210. ** The first byte of the new free block is pPage->aData[iStart]
  59211. ** and the size of the block is iSize bytes.
  59212. **
  59213. ** Adjacent freeblocks are coalesced.
  59214. **
  59215. ** Note that even though the freeblock list was checked by btreeInitPage(),
  59216. ** that routine will not detect overlap between cells or freeblocks. Nor
  59217. ** does it detect cells or freeblocks that encrouch into the reserved bytes
  59218. ** at the end of the page. So do additional corruption checks inside this
  59219. ** routine and return SQLITE_CORRUPT if any problems are found.
  59220. */
  59221. static int freeSpace(MemPage *pPage, u16 iStart, u16 iSize){
  59222. u16 iPtr; /* Address of ptr to next freeblock */
  59223. u16 iFreeBlk; /* Address of the next freeblock */
  59224. u8 hdr; /* Page header size. 0 or 100 */
  59225. u8 nFrag = 0; /* Reduction in fragmentation */
  59226. u16 iOrigSize = iSize; /* Original value of iSize */
  59227. u16 x; /* Offset to cell content area */
  59228. u32 iEnd = iStart + iSize; /* First byte past the iStart buffer */
  59229. unsigned char *data = pPage->aData; /* Page content */
  59230. assert( pPage->pBt!=0 );
  59231. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  59232. assert( CORRUPT_DB || iStart>=pPage->hdrOffset+6+pPage->childPtrSize );
  59233. assert( CORRUPT_DB || iEnd <= pPage->pBt->usableSize );
  59234. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59235. assert( iSize>=4 ); /* Minimum cell size is 4 */
  59236. assert( iStart<=pPage->pBt->usableSize-4 );
  59237. /* The list of freeblocks must be in ascending order. Find the
  59238. ** spot on the list where iStart should be inserted.
  59239. */
  59240. hdr = pPage->hdrOffset;
  59241. iPtr = hdr + 1;
  59242. if( data[iPtr+1]==0 && data[iPtr]==0 ){
  59243. iFreeBlk = 0; /* Shortcut for the case when the freelist is empty */
  59244. }else{
  59245. while( (iFreeBlk = get2byte(&data[iPtr]))<iStart ){
  59246. if( iFreeBlk<iPtr+4 ){
  59247. if( iFreeBlk==0 ) break;
  59248. return SQLITE_CORRUPT_PAGE(pPage);
  59249. }
  59250. iPtr = iFreeBlk;
  59251. }
  59252. if( iFreeBlk>pPage->pBt->usableSize-4 ){
  59253. return SQLITE_CORRUPT_PAGE(pPage);
  59254. }
  59255. assert( iFreeBlk>iPtr || iFreeBlk==0 );
  59256. /* At this point:
  59257. ** iFreeBlk: First freeblock after iStart, or zero if none
  59258. ** iPtr: The address of a pointer to iFreeBlk
  59259. **
  59260. ** Check to see if iFreeBlk should be coalesced onto the end of iStart.
  59261. */
  59262. if( iFreeBlk && iEnd+3>=iFreeBlk ){
  59263. nFrag = iFreeBlk - iEnd;
  59264. if( iEnd>iFreeBlk ) return SQLITE_CORRUPT_PAGE(pPage);
  59265. iEnd = iFreeBlk + get2byte(&data[iFreeBlk+2]);
  59266. if( iEnd > pPage->pBt->usableSize ){
  59267. return SQLITE_CORRUPT_PAGE(pPage);
  59268. }
  59269. iSize = iEnd - iStart;
  59270. iFreeBlk = get2byte(&data[iFreeBlk]);
  59271. }
  59272. /* If iPtr is another freeblock (that is, if iPtr is not the freelist
  59273. ** pointer in the page header) then check to see if iStart should be
  59274. ** coalesced onto the end of iPtr.
  59275. */
  59276. if( iPtr>hdr+1 ){
  59277. int iPtrEnd = iPtr + get2byte(&data[iPtr+2]);
  59278. if( iPtrEnd+3>=iStart ){
  59279. if( iPtrEnd>iStart ) return SQLITE_CORRUPT_PAGE(pPage);
  59280. nFrag += iStart - iPtrEnd;
  59281. iSize = iEnd - iPtr;
  59282. iStart = iPtr;
  59283. }
  59284. }
  59285. if( nFrag>data[hdr+7] ) return SQLITE_CORRUPT_PAGE(pPage);
  59286. data[hdr+7] -= nFrag;
  59287. }
  59288. x = get2byte(&data[hdr+5]);
  59289. if( iStart<=x ){
  59290. /* The new freeblock is at the beginning of the cell content area,
  59291. ** so just extend the cell content area rather than create another
  59292. ** freelist entry */
  59293. if( iStart<x || iPtr!=hdr+1 ) return SQLITE_CORRUPT_PAGE(pPage);
  59294. put2byte(&data[hdr+1], iFreeBlk);
  59295. put2byte(&data[hdr+5], iEnd);
  59296. }else{
  59297. /* Insert the new freeblock into the freelist */
  59298. put2byte(&data[iPtr], iStart);
  59299. }
  59300. if( pPage->pBt->btsFlags & BTS_FAST_SECURE ){
  59301. /* Overwrite deleted information with zeros when the secure_delete
  59302. ** option is enabled */
  59303. memset(&data[iStart], 0, iSize);
  59304. }
  59305. put2byte(&data[iStart], iFreeBlk);
  59306. put2byte(&data[iStart+2], iSize);
  59307. pPage->nFree += iOrigSize;
  59308. return SQLITE_OK;
  59309. }
  59310. /*
  59311. ** Decode the flags byte (the first byte of the header) for a page
  59312. ** and initialize fields of the MemPage structure accordingly.
  59313. **
  59314. ** Only the following combinations are supported. Anything different
  59315. ** indicates a corrupt database files:
  59316. **
  59317. ** PTF_ZERODATA
  59318. ** PTF_ZERODATA | PTF_LEAF
  59319. ** PTF_LEAFDATA | PTF_INTKEY
  59320. ** PTF_LEAFDATA | PTF_INTKEY | PTF_LEAF
  59321. */
  59322. static int decodeFlags(MemPage *pPage, int flagByte){
  59323. BtShared *pBt; /* A copy of pPage->pBt */
  59324. assert( pPage->hdrOffset==(pPage->pgno==1 ? 100 : 0) );
  59325. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59326. pPage->leaf = (u8)(flagByte>>3); assert( PTF_LEAF == 1<<3 );
  59327. flagByte &= ~PTF_LEAF;
  59328. pPage->childPtrSize = 4-4*pPage->leaf;
  59329. pPage->xCellSize = cellSizePtr;
  59330. pBt = pPage->pBt;
  59331. if( flagByte==(PTF_LEAFDATA | PTF_INTKEY) ){
  59332. /* EVIDENCE-OF: R-07291-35328 A value of 5 (0x05) means the page is an
  59333. ** interior table b-tree page. */
  59334. assert( (PTF_LEAFDATA|PTF_INTKEY)==5 );
  59335. /* EVIDENCE-OF: R-26900-09176 A value of 13 (0x0d) means the page is a
  59336. ** leaf table b-tree page. */
  59337. assert( (PTF_LEAFDATA|PTF_INTKEY|PTF_LEAF)==13 );
  59338. pPage->intKey = 1;
  59339. if( pPage->leaf ){
  59340. pPage->intKeyLeaf = 1;
  59341. pPage->xParseCell = btreeParseCellPtr;
  59342. }else{
  59343. pPage->intKeyLeaf = 0;
  59344. pPage->xCellSize = cellSizePtrNoPayload;
  59345. pPage->xParseCell = btreeParseCellPtrNoPayload;
  59346. }
  59347. pPage->maxLocal = pBt->maxLeaf;
  59348. pPage->minLocal = pBt->minLeaf;
  59349. }else if( flagByte==PTF_ZERODATA ){
  59350. /* EVIDENCE-OF: R-43316-37308 A value of 2 (0x02) means the page is an
  59351. ** interior index b-tree page. */
  59352. assert( (PTF_ZERODATA)==2 );
  59353. /* EVIDENCE-OF: R-59615-42828 A value of 10 (0x0a) means the page is a
  59354. ** leaf index b-tree page. */
  59355. assert( (PTF_ZERODATA|PTF_LEAF)==10 );
  59356. pPage->intKey = 0;
  59357. pPage->intKeyLeaf = 0;
  59358. pPage->xParseCell = btreeParseCellPtrIndex;
  59359. pPage->maxLocal = pBt->maxLocal;
  59360. pPage->minLocal = pBt->minLocal;
  59361. }else{
  59362. /* EVIDENCE-OF: R-47608-56469 Any other value for the b-tree page type is
  59363. ** an error. */
  59364. return SQLITE_CORRUPT_PAGE(pPage);
  59365. }
  59366. pPage->max1bytePayload = pBt->max1bytePayload;
  59367. return SQLITE_OK;
  59368. }
  59369. /*
  59370. ** Initialize the auxiliary information for a disk block.
  59371. **
  59372. ** Return SQLITE_OK on success. If we see that the page does
  59373. ** not contain a well-formed database page, then return
  59374. ** SQLITE_CORRUPT. Note that a return of SQLITE_OK does not
  59375. ** guarantee that the page is well-formed. It only shows that
  59376. ** we failed to detect any corruption.
  59377. */
  59378. static int btreeInitPage(MemPage *pPage){
  59379. int pc; /* Address of a freeblock within pPage->aData[] */
  59380. u8 hdr; /* Offset to beginning of page header */
  59381. u8 *data; /* Equal to pPage->aData */
  59382. BtShared *pBt; /* The main btree structure */
  59383. int usableSize; /* Amount of usable space on each page */
  59384. u16 cellOffset; /* Offset from start of page to first cell pointer */
  59385. int nFree; /* Number of unused bytes on the page */
  59386. int top; /* First byte of the cell content area */
  59387. int iCellFirst; /* First allowable cell or freeblock offset */
  59388. int iCellLast; /* Last possible cell or freeblock offset */
  59389. assert( pPage->pBt!=0 );
  59390. assert( pPage->pBt->db!=0 );
  59391. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59392. assert( pPage->pgno==sqlite3PagerPagenumber(pPage->pDbPage) );
  59393. assert( pPage == sqlite3PagerGetExtra(pPage->pDbPage) );
  59394. assert( pPage->aData == sqlite3PagerGetData(pPage->pDbPage) );
  59395. assert( pPage->isInit==0 );
  59396. pBt = pPage->pBt;
  59397. hdr = pPage->hdrOffset;
  59398. data = pPage->aData;
  59399. /* EVIDENCE-OF: R-28594-02890 The one-byte flag at offset 0 indicating
  59400. ** the b-tree page type. */
  59401. if( decodeFlags(pPage, data[hdr]) ){
  59402. return SQLITE_CORRUPT_PAGE(pPage);
  59403. }
  59404. assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
  59405. pPage->maskPage = (u16)(pBt->pageSize - 1);
  59406. pPage->nOverflow = 0;
  59407. usableSize = pBt->usableSize;
  59408. pPage->cellOffset = cellOffset = hdr + 8 + pPage->childPtrSize;
  59409. pPage->aDataEnd = &data[usableSize];
  59410. pPage->aCellIdx = &data[cellOffset];
  59411. pPage->aDataOfst = &data[pPage->childPtrSize];
  59412. /* EVIDENCE-OF: R-58015-48175 The two-byte integer at offset 5 designates
  59413. ** the start of the cell content area. A zero value for this integer is
  59414. ** interpreted as 65536. */
  59415. top = get2byteNotZero(&data[hdr+5]);
  59416. /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
  59417. ** number of cells on the page. */
  59418. pPage->nCell = get2byte(&data[hdr+3]);
  59419. if( pPage->nCell>MX_CELL(pBt) ){
  59420. /* To many cells for a single page. The page must be corrupt */
  59421. return SQLITE_CORRUPT_PAGE(pPage);
  59422. }
  59423. testcase( pPage->nCell==MX_CELL(pBt) );
  59424. /* EVIDENCE-OF: R-24089-57979 If a page contains no cells (which is only
  59425. ** possible for a root page of a table that contains no rows) then the
  59426. ** offset to the cell content area will equal the page size minus the
  59427. ** bytes of reserved space. */
  59428. assert( pPage->nCell>0 || top==usableSize || CORRUPT_DB );
  59429. /* A malformed database page might cause us to read past the end
  59430. ** of page when parsing a cell.
  59431. **
  59432. ** The following block of code checks early to see if a cell extends
  59433. ** past the end of a page boundary and causes SQLITE_CORRUPT to be
  59434. ** returned if it does.
  59435. */
  59436. iCellFirst = cellOffset + 2*pPage->nCell;
  59437. iCellLast = usableSize - 4;
  59438. if( pBt->db->flags & SQLITE_CellSizeCk ){
  59439. int i; /* Index into the cell pointer array */
  59440. int sz; /* Size of a cell */
  59441. if( !pPage->leaf ) iCellLast--;
  59442. for(i=0; i<pPage->nCell; i++){
  59443. pc = get2byteAligned(&data[cellOffset+i*2]);
  59444. testcase( pc==iCellFirst );
  59445. testcase( pc==iCellLast );
  59446. if( pc<iCellFirst || pc>iCellLast ){
  59447. return SQLITE_CORRUPT_PAGE(pPage);
  59448. }
  59449. sz = pPage->xCellSize(pPage, &data[pc]);
  59450. testcase( pc+sz==usableSize );
  59451. if( pc+sz>usableSize ){
  59452. return SQLITE_CORRUPT_PAGE(pPage);
  59453. }
  59454. }
  59455. if( !pPage->leaf ) iCellLast++;
  59456. }
  59457. /* Compute the total free space on the page
  59458. ** EVIDENCE-OF: R-23588-34450 The two-byte integer at offset 1 gives the
  59459. ** start of the first freeblock on the page, or is zero if there are no
  59460. ** freeblocks. */
  59461. pc = get2byte(&data[hdr+1]);
  59462. nFree = data[hdr+7] + top; /* Init nFree to non-freeblock free space */
  59463. if( pc>0 ){
  59464. u32 next, size;
  59465. if( pc<iCellFirst ){
  59466. /* EVIDENCE-OF: R-55530-52930 In a well-formed b-tree page, there will
  59467. ** always be at least one cell before the first freeblock.
  59468. */
  59469. return SQLITE_CORRUPT_PAGE(pPage);
  59470. }
  59471. while( 1 ){
  59472. if( pc>iCellLast ){
  59473. /* Freeblock off the end of the page */
  59474. return SQLITE_CORRUPT_PAGE(pPage);
  59475. }
  59476. next = get2byte(&data[pc]);
  59477. size = get2byte(&data[pc+2]);
  59478. nFree = nFree + size;
  59479. if( next<=pc+size+3 ) break;
  59480. pc = next;
  59481. }
  59482. if( next>0 ){
  59483. /* Freeblock not in ascending order */
  59484. return SQLITE_CORRUPT_PAGE(pPage);
  59485. }
  59486. if( pc+size>(unsigned int)usableSize ){
  59487. /* Last freeblock extends past page end */
  59488. return SQLITE_CORRUPT_PAGE(pPage);
  59489. }
  59490. }
  59491. /* At this point, nFree contains the sum of the offset to the start
  59492. ** of the cell-content area plus the number of free bytes within
  59493. ** the cell-content area. If this is greater than the usable-size
  59494. ** of the page, then the page must be corrupted. This check also
  59495. ** serves to verify that the offset to the start of the cell-content
  59496. ** area, according to the page header, lies within the page.
  59497. */
  59498. if( nFree>usableSize ){
  59499. return SQLITE_CORRUPT_PAGE(pPage);
  59500. }
  59501. pPage->nFree = (u16)(nFree - iCellFirst);
  59502. pPage->isInit = 1;
  59503. return SQLITE_OK;
  59504. }
  59505. /*
  59506. ** Set up a raw page so that it looks like a database page holding
  59507. ** no entries.
  59508. */
  59509. static void zeroPage(MemPage *pPage, int flags){
  59510. unsigned char *data = pPage->aData;
  59511. BtShared *pBt = pPage->pBt;
  59512. u8 hdr = pPage->hdrOffset;
  59513. u16 first;
  59514. assert( sqlite3PagerPagenumber(pPage->pDbPage)==pPage->pgno );
  59515. assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
  59516. assert( sqlite3PagerGetData(pPage->pDbPage) == data );
  59517. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  59518. assert( sqlite3_mutex_held(pBt->mutex) );
  59519. if( pBt->btsFlags & BTS_FAST_SECURE ){
  59520. memset(&data[hdr], 0, pBt->usableSize - hdr);
  59521. }
  59522. data[hdr] = (char)flags;
  59523. first = hdr + ((flags&PTF_LEAF)==0 ? 12 : 8);
  59524. memset(&data[hdr+1], 0, 4);
  59525. data[hdr+7] = 0;
  59526. put2byte(&data[hdr+5], pBt->usableSize);
  59527. pPage->nFree = (u16)(pBt->usableSize - first);
  59528. decodeFlags(pPage, flags);
  59529. pPage->cellOffset = first;
  59530. pPage->aDataEnd = &data[pBt->usableSize];
  59531. pPage->aCellIdx = &data[first];
  59532. pPage->aDataOfst = &data[pPage->childPtrSize];
  59533. pPage->nOverflow = 0;
  59534. assert( pBt->pageSize>=512 && pBt->pageSize<=65536 );
  59535. pPage->maskPage = (u16)(pBt->pageSize - 1);
  59536. pPage->nCell = 0;
  59537. pPage->isInit = 1;
  59538. }
  59539. /*
  59540. ** Convert a DbPage obtained from the pager into a MemPage used by
  59541. ** the btree layer.
  59542. */
  59543. static MemPage *btreePageFromDbPage(DbPage *pDbPage, Pgno pgno, BtShared *pBt){
  59544. MemPage *pPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
  59545. if( pgno!=pPage->pgno ){
  59546. pPage->aData = sqlite3PagerGetData(pDbPage);
  59547. pPage->pDbPage = pDbPage;
  59548. pPage->pBt = pBt;
  59549. pPage->pgno = pgno;
  59550. pPage->hdrOffset = pgno==1 ? 100 : 0;
  59551. }
  59552. assert( pPage->aData==sqlite3PagerGetData(pDbPage) );
  59553. return pPage;
  59554. }
  59555. /*
  59556. ** Get a page from the pager. Initialize the MemPage.pBt and
  59557. ** MemPage.aData elements if needed. See also: btreeGetUnusedPage().
  59558. **
  59559. ** If the PAGER_GET_NOCONTENT flag is set, it means that we do not care
  59560. ** about the content of the page at this time. So do not go to the disk
  59561. ** to fetch the content. Just fill in the content with zeros for now.
  59562. ** If in the future we call sqlite3PagerWrite() on this page, that
  59563. ** means we have started to be concerned about content and the disk
  59564. ** read should occur at that point.
  59565. */
  59566. static int btreeGetPage(
  59567. BtShared *pBt, /* The btree */
  59568. Pgno pgno, /* Number of the page to fetch */
  59569. MemPage **ppPage, /* Return the page in this parameter */
  59570. int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
  59571. ){
  59572. int rc;
  59573. DbPage *pDbPage;
  59574. assert( flags==0 || flags==PAGER_GET_NOCONTENT || flags==PAGER_GET_READONLY );
  59575. assert( sqlite3_mutex_held(pBt->mutex) );
  59576. rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, flags);
  59577. if( rc ) return rc;
  59578. *ppPage = btreePageFromDbPage(pDbPage, pgno, pBt);
  59579. return SQLITE_OK;
  59580. }
  59581. /*
  59582. ** Retrieve a page from the pager cache. If the requested page is not
  59583. ** already in the pager cache return NULL. Initialize the MemPage.pBt and
  59584. ** MemPage.aData elements if needed.
  59585. */
  59586. static MemPage *btreePageLookup(BtShared *pBt, Pgno pgno){
  59587. DbPage *pDbPage;
  59588. assert( sqlite3_mutex_held(pBt->mutex) );
  59589. pDbPage = sqlite3PagerLookup(pBt->pPager, pgno);
  59590. if( pDbPage ){
  59591. return btreePageFromDbPage(pDbPage, pgno, pBt);
  59592. }
  59593. return 0;
  59594. }
  59595. /*
  59596. ** Return the size of the database file in pages. If there is any kind of
  59597. ** error, return ((unsigned int)-1).
  59598. */
  59599. static Pgno btreePagecount(BtShared *pBt){
  59600. return pBt->nPage;
  59601. }
  59602. SQLITE_PRIVATE u32 sqlite3BtreeLastPage(Btree *p){
  59603. assert( sqlite3BtreeHoldsMutex(p) );
  59604. assert( ((p->pBt->nPage)&0x80000000)==0 );
  59605. return btreePagecount(p->pBt);
  59606. }
  59607. /*
  59608. ** Get a page from the pager and initialize it.
  59609. **
  59610. ** If pCur!=0 then the page is being fetched as part of a moveToChild()
  59611. ** call. Do additional sanity checking on the page in this case.
  59612. ** And if the fetch fails, this routine must decrement pCur->iPage.
  59613. **
  59614. ** The page is fetched as read-write unless pCur is not NULL and is
  59615. ** a read-only cursor.
  59616. **
  59617. ** If an error occurs, then *ppPage is undefined. It
  59618. ** may remain unchanged, or it may be set to an invalid value.
  59619. */
  59620. static int getAndInitPage(
  59621. BtShared *pBt, /* The database file */
  59622. Pgno pgno, /* Number of the page to get */
  59623. MemPage **ppPage, /* Write the page pointer here */
  59624. BtCursor *pCur, /* Cursor to receive the page, or NULL */
  59625. int bReadOnly /* True for a read-only page */
  59626. ){
  59627. int rc;
  59628. DbPage *pDbPage;
  59629. assert( sqlite3_mutex_held(pBt->mutex) );
  59630. assert( pCur==0 || ppPage==&pCur->pPage );
  59631. assert( pCur==0 || bReadOnly==pCur->curPagerFlags );
  59632. assert( pCur==0 || pCur->iPage>0 );
  59633. if( pgno>btreePagecount(pBt) ){
  59634. rc = SQLITE_CORRUPT_BKPT;
  59635. goto getAndInitPage_error;
  59636. }
  59637. rc = sqlite3PagerGet(pBt->pPager, pgno, (DbPage**)&pDbPage, bReadOnly);
  59638. if( rc ){
  59639. goto getAndInitPage_error;
  59640. }
  59641. *ppPage = (MemPage*)sqlite3PagerGetExtra(pDbPage);
  59642. if( (*ppPage)->isInit==0 ){
  59643. btreePageFromDbPage(pDbPage, pgno, pBt);
  59644. rc = btreeInitPage(*ppPage);
  59645. if( rc!=SQLITE_OK ){
  59646. releasePage(*ppPage);
  59647. goto getAndInitPage_error;
  59648. }
  59649. }
  59650. assert( (*ppPage)->pgno==pgno );
  59651. assert( (*ppPage)->aData==sqlite3PagerGetData(pDbPage) );
  59652. /* If obtaining a child page for a cursor, we must verify that the page is
  59653. ** compatible with the root page. */
  59654. if( pCur && ((*ppPage)->nCell<1 || (*ppPage)->intKey!=pCur->curIntKey) ){
  59655. rc = SQLITE_CORRUPT_PGNO(pgno);
  59656. releasePage(*ppPage);
  59657. goto getAndInitPage_error;
  59658. }
  59659. return SQLITE_OK;
  59660. getAndInitPage_error:
  59661. if( pCur ){
  59662. pCur->iPage--;
  59663. pCur->pPage = pCur->apPage[pCur->iPage];
  59664. }
  59665. testcase( pgno==0 );
  59666. assert( pgno!=0 || rc==SQLITE_CORRUPT );
  59667. return rc;
  59668. }
  59669. /*
  59670. ** Release a MemPage. This should be called once for each prior
  59671. ** call to btreeGetPage.
  59672. **
  59673. ** Page1 is a special case and must be released using releasePageOne().
  59674. */
  59675. static void releasePageNotNull(MemPage *pPage){
  59676. assert( pPage->aData );
  59677. assert( pPage->pBt );
  59678. assert( pPage->pDbPage!=0 );
  59679. assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
  59680. assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
  59681. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59682. sqlite3PagerUnrefNotNull(pPage->pDbPage);
  59683. }
  59684. static void releasePage(MemPage *pPage){
  59685. if( pPage ) releasePageNotNull(pPage);
  59686. }
  59687. static void releasePageOne(MemPage *pPage){
  59688. assert( pPage!=0 );
  59689. assert( pPage->aData );
  59690. assert( pPage->pBt );
  59691. assert( pPage->pDbPage!=0 );
  59692. assert( sqlite3PagerGetExtra(pPage->pDbPage) == (void*)pPage );
  59693. assert( sqlite3PagerGetData(pPage->pDbPage)==pPage->aData );
  59694. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59695. sqlite3PagerUnrefPageOne(pPage->pDbPage);
  59696. }
  59697. /*
  59698. ** Get an unused page.
  59699. **
  59700. ** This works just like btreeGetPage() with the addition:
  59701. **
  59702. ** * If the page is already in use for some other purpose, immediately
  59703. ** release it and return an SQLITE_CURRUPT error.
  59704. ** * Make sure the isInit flag is clear
  59705. */
  59706. static int btreeGetUnusedPage(
  59707. BtShared *pBt, /* The btree */
  59708. Pgno pgno, /* Number of the page to fetch */
  59709. MemPage **ppPage, /* Return the page in this parameter */
  59710. int flags /* PAGER_GET_NOCONTENT or PAGER_GET_READONLY */
  59711. ){
  59712. int rc = btreeGetPage(pBt, pgno, ppPage, flags);
  59713. if( rc==SQLITE_OK ){
  59714. if( sqlite3PagerPageRefcount((*ppPage)->pDbPage)>1 ){
  59715. releasePage(*ppPage);
  59716. *ppPage = 0;
  59717. return SQLITE_CORRUPT_BKPT;
  59718. }
  59719. (*ppPage)->isInit = 0;
  59720. }else{
  59721. *ppPage = 0;
  59722. }
  59723. return rc;
  59724. }
  59725. /*
  59726. ** During a rollback, when the pager reloads information into the cache
  59727. ** so that the cache is restored to its original state at the start of
  59728. ** the transaction, for each page restored this routine is called.
  59729. **
  59730. ** This routine needs to reset the extra data section at the end of the
  59731. ** page to agree with the restored data.
  59732. */
  59733. static void pageReinit(DbPage *pData){
  59734. MemPage *pPage;
  59735. pPage = (MemPage *)sqlite3PagerGetExtra(pData);
  59736. assert( sqlite3PagerPageRefcount(pData)>0 );
  59737. if( pPage->isInit ){
  59738. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  59739. pPage->isInit = 0;
  59740. if( sqlite3PagerPageRefcount(pData)>1 ){
  59741. /* pPage might not be a btree page; it might be an overflow page
  59742. ** or ptrmap page or a free page. In those cases, the following
  59743. ** call to btreeInitPage() will likely return SQLITE_CORRUPT.
  59744. ** But no harm is done by this. And it is very important that
  59745. ** btreeInitPage() be called on every btree page so we make
  59746. ** the call for every page that comes in for re-initing. */
  59747. btreeInitPage(pPage);
  59748. }
  59749. }
  59750. }
  59751. /*
  59752. ** Invoke the busy handler for a btree.
  59753. */
  59754. static int btreeInvokeBusyHandler(void *pArg){
  59755. BtShared *pBt = (BtShared*)pArg;
  59756. assert( pBt->db );
  59757. assert( sqlite3_mutex_held(pBt->db->mutex) );
  59758. return sqlite3InvokeBusyHandler(&pBt->db->busyHandler,
  59759. sqlite3PagerFile(pBt->pPager));
  59760. }
  59761. /*
  59762. ** Open a database file.
  59763. **
  59764. ** zFilename is the name of the database file. If zFilename is NULL
  59765. ** then an ephemeral database is created. The ephemeral database might
  59766. ** be exclusively in memory, or it might use a disk-based memory cache.
  59767. ** Either way, the ephemeral database will be automatically deleted
  59768. ** when sqlite3BtreeClose() is called.
  59769. **
  59770. ** If zFilename is ":memory:" then an in-memory database is created
  59771. ** that is automatically destroyed when it is closed.
  59772. **
  59773. ** The "flags" parameter is a bitmask that might contain bits like
  59774. ** BTREE_OMIT_JOURNAL and/or BTREE_MEMORY.
  59775. **
  59776. ** If the database is already opened in the same database connection
  59777. ** and we are in shared cache mode, then the open will fail with an
  59778. ** SQLITE_CONSTRAINT error. We cannot allow two or more BtShared
  59779. ** objects in the same database connection since doing so will lead
  59780. ** to problems with locking.
  59781. */
  59782. SQLITE_PRIVATE int sqlite3BtreeOpen(
  59783. sqlite3_vfs *pVfs, /* VFS to use for this b-tree */
  59784. const char *zFilename, /* Name of the file containing the BTree database */
  59785. sqlite3 *db, /* Associated database handle */
  59786. Btree **ppBtree, /* Pointer to new Btree object written here */
  59787. int flags, /* Options */
  59788. int vfsFlags /* Flags passed through to sqlite3_vfs.xOpen() */
  59789. ){
  59790. BtShared *pBt = 0; /* Shared part of btree structure */
  59791. Btree *p; /* Handle to return */
  59792. sqlite3_mutex *mutexOpen = 0; /* Prevents a race condition. Ticket #3537 */
  59793. int rc = SQLITE_OK; /* Result code from this function */
  59794. u8 nReserve; /* Byte of unused space on each page */
  59795. unsigned char zDbHeader[100]; /* Database header content */
  59796. /* True if opening an ephemeral, temporary database */
  59797. const int isTempDb = zFilename==0 || zFilename[0]==0;
  59798. /* Set the variable isMemdb to true for an in-memory database, or
  59799. ** false for a file-based database.
  59800. */
  59801. #ifdef SQLITE_OMIT_MEMORYDB
  59802. const int isMemdb = 0;
  59803. #else
  59804. const int isMemdb = (zFilename && strcmp(zFilename, ":memory:")==0)
  59805. || (isTempDb && sqlite3TempInMemory(db))
  59806. || (vfsFlags & SQLITE_OPEN_MEMORY)!=0;
  59807. #endif
  59808. assert( db!=0 );
  59809. assert( pVfs!=0 );
  59810. assert( sqlite3_mutex_held(db->mutex) );
  59811. assert( (flags&0xff)==flags ); /* flags fit in 8 bits */
  59812. /* Only a BTREE_SINGLE database can be BTREE_UNORDERED */
  59813. assert( (flags & BTREE_UNORDERED)==0 || (flags & BTREE_SINGLE)!=0 );
  59814. /* A BTREE_SINGLE database is always a temporary and/or ephemeral */
  59815. assert( (flags & BTREE_SINGLE)==0 || isTempDb );
  59816. if( isMemdb ){
  59817. flags |= BTREE_MEMORY;
  59818. }
  59819. if( (vfsFlags & SQLITE_OPEN_MAIN_DB)!=0 && (isMemdb || isTempDb) ){
  59820. vfsFlags = (vfsFlags & ~SQLITE_OPEN_MAIN_DB) | SQLITE_OPEN_TEMP_DB;
  59821. }
  59822. p = sqlite3MallocZero(sizeof(Btree));
  59823. if( !p ){
  59824. return SQLITE_NOMEM_BKPT;
  59825. }
  59826. p->inTrans = TRANS_NONE;
  59827. p->db = db;
  59828. #ifndef SQLITE_OMIT_SHARED_CACHE
  59829. p->lock.pBtree = p;
  59830. p->lock.iTable = 1;
  59831. #endif
  59832. #if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
  59833. /*
  59834. ** If this Btree is a candidate for shared cache, try to find an
  59835. ** existing BtShared object that we can share with
  59836. */
  59837. if( isTempDb==0 && (isMemdb==0 || (vfsFlags&SQLITE_OPEN_URI)!=0) ){
  59838. if( vfsFlags & SQLITE_OPEN_SHAREDCACHE ){
  59839. int nFilename = sqlite3Strlen30(zFilename)+1;
  59840. int nFullPathname = pVfs->mxPathname+1;
  59841. char *zFullPathname = sqlite3Malloc(MAX(nFullPathname,nFilename));
  59842. MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
  59843. p->sharable = 1;
  59844. if( !zFullPathname ){
  59845. sqlite3_free(p);
  59846. return SQLITE_NOMEM_BKPT;
  59847. }
  59848. if( isMemdb ){
  59849. memcpy(zFullPathname, zFilename, nFilename);
  59850. }else{
  59851. rc = sqlite3OsFullPathname(pVfs, zFilename,
  59852. nFullPathname, zFullPathname);
  59853. if( rc ){
  59854. sqlite3_free(zFullPathname);
  59855. sqlite3_free(p);
  59856. return rc;
  59857. }
  59858. }
  59859. #if SQLITE_THREADSAFE
  59860. mutexOpen = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_OPEN);
  59861. sqlite3_mutex_enter(mutexOpen);
  59862. mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  59863. sqlite3_mutex_enter(mutexShared);
  59864. #endif
  59865. for(pBt=GLOBAL(BtShared*,sqlite3SharedCacheList); pBt; pBt=pBt->pNext){
  59866. assert( pBt->nRef>0 );
  59867. if( 0==strcmp(zFullPathname, sqlite3PagerFilename(pBt->pPager, 0))
  59868. && sqlite3PagerVfs(pBt->pPager)==pVfs ){
  59869. int iDb;
  59870. for(iDb=db->nDb-1; iDb>=0; iDb--){
  59871. Btree *pExisting = db->aDb[iDb].pBt;
  59872. if( pExisting && pExisting->pBt==pBt ){
  59873. sqlite3_mutex_leave(mutexShared);
  59874. sqlite3_mutex_leave(mutexOpen);
  59875. sqlite3_free(zFullPathname);
  59876. sqlite3_free(p);
  59877. return SQLITE_CONSTRAINT;
  59878. }
  59879. }
  59880. p->pBt = pBt;
  59881. pBt->nRef++;
  59882. break;
  59883. }
  59884. }
  59885. sqlite3_mutex_leave(mutexShared);
  59886. sqlite3_free(zFullPathname);
  59887. }
  59888. #ifdef SQLITE_DEBUG
  59889. else{
  59890. /* In debug mode, we mark all persistent databases as sharable
  59891. ** even when they are not. This exercises the locking code and
  59892. ** gives more opportunity for asserts(sqlite3_mutex_held())
  59893. ** statements to find locking problems.
  59894. */
  59895. p->sharable = 1;
  59896. }
  59897. #endif
  59898. }
  59899. #endif
  59900. if( pBt==0 ){
  59901. /*
  59902. ** The following asserts make sure that structures used by the btree are
  59903. ** the right size. This is to guard against size changes that result
  59904. ** when compiling on a different architecture.
  59905. */
  59906. assert( sizeof(i64)==8 );
  59907. assert( sizeof(u64)==8 );
  59908. assert( sizeof(u32)==4 );
  59909. assert( sizeof(u16)==2 );
  59910. assert( sizeof(Pgno)==4 );
  59911. pBt = sqlite3MallocZero( sizeof(*pBt) );
  59912. if( pBt==0 ){
  59913. rc = SQLITE_NOMEM_BKPT;
  59914. goto btree_open_out;
  59915. }
  59916. rc = sqlite3PagerOpen(pVfs, &pBt->pPager, zFilename,
  59917. sizeof(MemPage), flags, vfsFlags, pageReinit);
  59918. if( rc==SQLITE_OK ){
  59919. sqlite3PagerSetMmapLimit(pBt->pPager, db->szMmap);
  59920. rc = sqlite3PagerReadFileheader(pBt->pPager,sizeof(zDbHeader),zDbHeader);
  59921. }
  59922. if( rc!=SQLITE_OK ){
  59923. goto btree_open_out;
  59924. }
  59925. pBt->openFlags = (u8)flags;
  59926. pBt->db = db;
  59927. sqlite3PagerSetBusyHandler(pBt->pPager, btreeInvokeBusyHandler, pBt);
  59928. p->pBt = pBt;
  59929. pBt->pCursor = 0;
  59930. pBt->pPage1 = 0;
  59931. if( sqlite3PagerIsreadonly(pBt->pPager) ) pBt->btsFlags |= BTS_READ_ONLY;
  59932. #if defined(SQLITE_SECURE_DELETE)
  59933. pBt->btsFlags |= BTS_SECURE_DELETE;
  59934. #elif defined(SQLITE_FAST_SECURE_DELETE)
  59935. pBt->btsFlags |= BTS_OVERWRITE;
  59936. #endif
  59937. /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
  59938. ** determined by the 2-byte integer located at an offset of 16 bytes from
  59939. ** the beginning of the database file. */
  59940. pBt->pageSize = (zDbHeader[16]<<8) | (zDbHeader[17]<<16);
  59941. if( pBt->pageSize<512 || pBt->pageSize>SQLITE_MAX_PAGE_SIZE
  59942. || ((pBt->pageSize-1)&pBt->pageSize)!=0 ){
  59943. pBt->pageSize = 0;
  59944. #ifndef SQLITE_OMIT_AUTOVACUUM
  59945. /* If the magic name ":memory:" will create an in-memory database, then
  59946. ** leave the autoVacuum mode at 0 (do not auto-vacuum), even if
  59947. ** SQLITE_DEFAULT_AUTOVACUUM is true. On the other hand, if
  59948. ** SQLITE_OMIT_MEMORYDB has been defined, then ":memory:" is just a
  59949. ** regular file-name. In this case the auto-vacuum applies as per normal.
  59950. */
  59951. if( zFilename && !isMemdb ){
  59952. pBt->autoVacuum = (SQLITE_DEFAULT_AUTOVACUUM ? 1 : 0);
  59953. pBt->incrVacuum = (SQLITE_DEFAULT_AUTOVACUUM==2 ? 1 : 0);
  59954. }
  59955. #endif
  59956. nReserve = 0;
  59957. }else{
  59958. /* EVIDENCE-OF: R-37497-42412 The size of the reserved region is
  59959. ** determined by the one-byte unsigned integer found at an offset of 20
  59960. ** into the database file header. */
  59961. nReserve = zDbHeader[20];
  59962. pBt->btsFlags |= BTS_PAGESIZE_FIXED;
  59963. #ifndef SQLITE_OMIT_AUTOVACUUM
  59964. pBt->autoVacuum = (get4byte(&zDbHeader[36 + 4*4])?1:0);
  59965. pBt->incrVacuum = (get4byte(&zDbHeader[36 + 7*4])?1:0);
  59966. #endif
  59967. }
  59968. rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
  59969. if( rc ) goto btree_open_out;
  59970. pBt->usableSize = pBt->pageSize - nReserve;
  59971. assert( (pBt->pageSize & 7)==0 ); /* 8-byte alignment of pageSize */
  59972. #if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
  59973. /* Add the new BtShared object to the linked list sharable BtShareds.
  59974. */
  59975. pBt->nRef = 1;
  59976. if( p->sharable ){
  59977. MUTEX_LOGIC( sqlite3_mutex *mutexShared; )
  59978. MUTEX_LOGIC( mutexShared = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);)
  59979. if( SQLITE_THREADSAFE && sqlite3GlobalConfig.bCoreMutex ){
  59980. pBt->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_FAST);
  59981. if( pBt->mutex==0 ){
  59982. rc = SQLITE_NOMEM_BKPT;
  59983. goto btree_open_out;
  59984. }
  59985. }
  59986. sqlite3_mutex_enter(mutexShared);
  59987. pBt->pNext = GLOBAL(BtShared*,sqlite3SharedCacheList);
  59988. GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt;
  59989. sqlite3_mutex_leave(mutexShared);
  59990. }
  59991. #endif
  59992. }
  59993. #if !defined(SQLITE_OMIT_SHARED_CACHE) && !defined(SQLITE_OMIT_DISKIO)
  59994. /* If the new Btree uses a sharable pBtShared, then link the new
  59995. ** Btree into the list of all sharable Btrees for the same connection.
  59996. ** The list is kept in ascending order by pBt address.
  59997. */
  59998. if( p->sharable ){
  59999. int i;
  60000. Btree *pSib;
  60001. for(i=0; i<db->nDb; i++){
  60002. if( (pSib = db->aDb[i].pBt)!=0 && pSib->sharable ){
  60003. while( pSib->pPrev ){ pSib = pSib->pPrev; }
  60004. if( (uptr)p->pBt<(uptr)pSib->pBt ){
  60005. p->pNext = pSib;
  60006. p->pPrev = 0;
  60007. pSib->pPrev = p;
  60008. }else{
  60009. while( pSib->pNext && (uptr)pSib->pNext->pBt<(uptr)p->pBt ){
  60010. pSib = pSib->pNext;
  60011. }
  60012. p->pNext = pSib->pNext;
  60013. p->pPrev = pSib;
  60014. if( p->pNext ){
  60015. p->pNext->pPrev = p;
  60016. }
  60017. pSib->pNext = p;
  60018. }
  60019. break;
  60020. }
  60021. }
  60022. }
  60023. #endif
  60024. *ppBtree = p;
  60025. btree_open_out:
  60026. if( rc!=SQLITE_OK ){
  60027. if( pBt && pBt->pPager ){
  60028. sqlite3PagerClose(pBt->pPager, 0);
  60029. }
  60030. sqlite3_free(pBt);
  60031. sqlite3_free(p);
  60032. *ppBtree = 0;
  60033. }else{
  60034. sqlite3_file *pFile;
  60035. /* If the B-Tree was successfully opened, set the pager-cache size to the
  60036. ** default value. Except, when opening on an existing shared pager-cache,
  60037. ** do not change the pager-cache size.
  60038. */
  60039. if( sqlite3BtreeSchema(p, 0, 0)==0 ){
  60040. sqlite3PagerSetCachesize(p->pBt->pPager, SQLITE_DEFAULT_CACHE_SIZE);
  60041. }
  60042. pFile = sqlite3PagerFile(pBt->pPager);
  60043. if( pFile->pMethods ){
  60044. sqlite3OsFileControlHint(pFile, SQLITE_FCNTL_PDB, (void*)&pBt->db);
  60045. }
  60046. }
  60047. if( mutexOpen ){
  60048. assert( sqlite3_mutex_held(mutexOpen) );
  60049. sqlite3_mutex_leave(mutexOpen);
  60050. }
  60051. assert( rc!=SQLITE_OK || sqlite3BtreeConnectionCount(*ppBtree)>0 );
  60052. return rc;
  60053. }
  60054. /*
  60055. ** Decrement the BtShared.nRef counter. When it reaches zero,
  60056. ** remove the BtShared structure from the sharing list. Return
  60057. ** true if the BtShared.nRef counter reaches zero and return
  60058. ** false if it is still positive.
  60059. */
  60060. static int removeFromSharingList(BtShared *pBt){
  60061. #ifndef SQLITE_OMIT_SHARED_CACHE
  60062. MUTEX_LOGIC( sqlite3_mutex *pMaster; )
  60063. BtShared *pList;
  60064. int removed = 0;
  60065. assert( sqlite3_mutex_notheld(pBt->mutex) );
  60066. MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  60067. sqlite3_mutex_enter(pMaster);
  60068. pBt->nRef--;
  60069. if( pBt->nRef<=0 ){
  60070. if( GLOBAL(BtShared*,sqlite3SharedCacheList)==pBt ){
  60071. GLOBAL(BtShared*,sqlite3SharedCacheList) = pBt->pNext;
  60072. }else{
  60073. pList = GLOBAL(BtShared*,sqlite3SharedCacheList);
  60074. while( ALWAYS(pList) && pList->pNext!=pBt ){
  60075. pList=pList->pNext;
  60076. }
  60077. if( ALWAYS(pList) ){
  60078. pList->pNext = pBt->pNext;
  60079. }
  60080. }
  60081. if( SQLITE_THREADSAFE ){
  60082. sqlite3_mutex_free(pBt->mutex);
  60083. }
  60084. removed = 1;
  60085. }
  60086. sqlite3_mutex_leave(pMaster);
  60087. return removed;
  60088. #else
  60089. return 1;
  60090. #endif
  60091. }
  60092. /*
  60093. ** Make sure pBt->pTmpSpace points to an allocation of
  60094. ** MX_CELL_SIZE(pBt) bytes with a 4-byte prefix for a left-child
  60095. ** pointer.
  60096. */
  60097. static void allocateTempSpace(BtShared *pBt){
  60098. if( !pBt->pTmpSpace ){
  60099. pBt->pTmpSpace = sqlite3PageMalloc( pBt->pageSize );
  60100. /* One of the uses of pBt->pTmpSpace is to format cells before
  60101. ** inserting them into a leaf page (function fillInCell()). If
  60102. ** a cell is less than 4 bytes in size, it is rounded up to 4 bytes
  60103. ** by the various routines that manipulate binary cells. Which
  60104. ** can mean that fillInCell() only initializes the first 2 or 3
  60105. ** bytes of pTmpSpace, but that the first 4 bytes are copied from
  60106. ** it into a database page. This is not actually a problem, but it
  60107. ** does cause a valgrind error when the 1 or 2 bytes of unitialized
  60108. ** data is passed to system call write(). So to avoid this error,
  60109. ** zero the first 4 bytes of temp space here.
  60110. **
  60111. ** Also: Provide four bytes of initialized space before the
  60112. ** beginning of pTmpSpace as an area available to prepend the
  60113. ** left-child pointer to the beginning of a cell.
  60114. */
  60115. if( pBt->pTmpSpace ){
  60116. memset(pBt->pTmpSpace, 0, 8);
  60117. pBt->pTmpSpace += 4;
  60118. }
  60119. }
  60120. }
  60121. /*
  60122. ** Free the pBt->pTmpSpace allocation
  60123. */
  60124. static void freeTempSpace(BtShared *pBt){
  60125. if( pBt->pTmpSpace ){
  60126. pBt->pTmpSpace -= 4;
  60127. sqlite3PageFree(pBt->pTmpSpace);
  60128. pBt->pTmpSpace = 0;
  60129. }
  60130. }
  60131. /*
  60132. ** Close an open database and invalidate all cursors.
  60133. */
  60134. SQLITE_PRIVATE int sqlite3BtreeClose(Btree *p){
  60135. BtShared *pBt = p->pBt;
  60136. BtCursor *pCur;
  60137. /* Close all cursors opened via this handle. */
  60138. assert( sqlite3_mutex_held(p->db->mutex) );
  60139. sqlite3BtreeEnter(p);
  60140. pCur = pBt->pCursor;
  60141. while( pCur ){
  60142. BtCursor *pTmp = pCur;
  60143. pCur = pCur->pNext;
  60144. if( pTmp->pBtree==p ){
  60145. sqlite3BtreeCloseCursor(pTmp);
  60146. }
  60147. }
  60148. /* Rollback any active transaction and free the handle structure.
  60149. ** The call to sqlite3BtreeRollback() drops any table-locks held by
  60150. ** this handle.
  60151. */
  60152. sqlite3BtreeRollback(p, SQLITE_OK, 0);
  60153. sqlite3BtreeLeave(p);
  60154. /* If there are still other outstanding references to the shared-btree
  60155. ** structure, return now. The remainder of this procedure cleans
  60156. ** up the shared-btree.
  60157. */
  60158. assert( p->wantToLock==0 && p->locked==0 );
  60159. if( !p->sharable || removeFromSharingList(pBt) ){
  60160. /* The pBt is no longer on the sharing list, so we can access
  60161. ** it without having to hold the mutex.
  60162. **
  60163. ** Clean out and delete the BtShared object.
  60164. */
  60165. assert( !pBt->pCursor );
  60166. sqlite3PagerClose(pBt->pPager, p->db);
  60167. if( pBt->xFreeSchema && pBt->pSchema ){
  60168. pBt->xFreeSchema(pBt->pSchema);
  60169. }
  60170. sqlite3DbFree(0, pBt->pSchema);
  60171. freeTempSpace(pBt);
  60172. sqlite3_free(pBt);
  60173. }
  60174. #ifndef SQLITE_OMIT_SHARED_CACHE
  60175. assert( p->wantToLock==0 );
  60176. assert( p->locked==0 );
  60177. if( p->pPrev ) p->pPrev->pNext = p->pNext;
  60178. if( p->pNext ) p->pNext->pPrev = p->pPrev;
  60179. #endif
  60180. sqlite3_free(p);
  60181. return SQLITE_OK;
  60182. }
  60183. /*
  60184. ** Change the "soft" limit on the number of pages in the cache.
  60185. ** Unused and unmodified pages will be recycled when the number of
  60186. ** pages in the cache exceeds this soft limit. But the size of the
  60187. ** cache is allowed to grow larger than this limit if it contains
  60188. ** dirty pages or pages still in active use.
  60189. */
  60190. SQLITE_PRIVATE int sqlite3BtreeSetCacheSize(Btree *p, int mxPage){
  60191. BtShared *pBt = p->pBt;
  60192. assert( sqlite3_mutex_held(p->db->mutex) );
  60193. sqlite3BtreeEnter(p);
  60194. sqlite3PagerSetCachesize(pBt->pPager, mxPage);
  60195. sqlite3BtreeLeave(p);
  60196. return SQLITE_OK;
  60197. }
  60198. /*
  60199. ** Change the "spill" limit on the number of pages in the cache.
  60200. ** If the number of pages exceeds this limit during a write transaction,
  60201. ** the pager might attempt to "spill" pages to the journal early in
  60202. ** order to free up memory.
  60203. **
  60204. ** The value returned is the current spill size. If zero is passed
  60205. ** as an argument, no changes are made to the spill size setting, so
  60206. ** using mxPage of 0 is a way to query the current spill size.
  60207. */
  60208. SQLITE_PRIVATE int sqlite3BtreeSetSpillSize(Btree *p, int mxPage){
  60209. BtShared *pBt = p->pBt;
  60210. int res;
  60211. assert( sqlite3_mutex_held(p->db->mutex) );
  60212. sqlite3BtreeEnter(p);
  60213. res = sqlite3PagerSetSpillsize(pBt->pPager, mxPage);
  60214. sqlite3BtreeLeave(p);
  60215. return res;
  60216. }
  60217. #if SQLITE_MAX_MMAP_SIZE>0
  60218. /*
  60219. ** Change the limit on the amount of the database file that may be
  60220. ** memory mapped.
  60221. */
  60222. SQLITE_PRIVATE int sqlite3BtreeSetMmapLimit(Btree *p, sqlite3_int64 szMmap){
  60223. BtShared *pBt = p->pBt;
  60224. assert( sqlite3_mutex_held(p->db->mutex) );
  60225. sqlite3BtreeEnter(p);
  60226. sqlite3PagerSetMmapLimit(pBt->pPager, szMmap);
  60227. sqlite3BtreeLeave(p);
  60228. return SQLITE_OK;
  60229. }
  60230. #endif /* SQLITE_MAX_MMAP_SIZE>0 */
  60231. /*
  60232. ** Change the way data is synced to disk in order to increase or decrease
  60233. ** how well the database resists damage due to OS crashes and power
  60234. ** failures. Level 1 is the same as asynchronous (no syncs() occur and
  60235. ** there is a high probability of damage) Level 2 is the default. There
  60236. ** is a very low but non-zero probability of damage. Level 3 reduces the
  60237. ** probability of damage to near zero but with a write performance reduction.
  60238. */
  60239. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  60240. SQLITE_PRIVATE int sqlite3BtreeSetPagerFlags(
  60241. Btree *p, /* The btree to set the safety level on */
  60242. unsigned pgFlags /* Various PAGER_* flags */
  60243. ){
  60244. BtShared *pBt = p->pBt;
  60245. assert( sqlite3_mutex_held(p->db->mutex) );
  60246. sqlite3BtreeEnter(p);
  60247. sqlite3PagerSetFlags(pBt->pPager, pgFlags);
  60248. sqlite3BtreeLeave(p);
  60249. return SQLITE_OK;
  60250. }
  60251. #endif
  60252. /*
  60253. ** Change the default pages size and the number of reserved bytes per page.
  60254. ** Or, if the page size has already been fixed, return SQLITE_READONLY
  60255. ** without changing anything.
  60256. **
  60257. ** The page size must be a power of 2 between 512 and 65536. If the page
  60258. ** size supplied does not meet this constraint then the page size is not
  60259. ** changed.
  60260. **
  60261. ** Page sizes are constrained to be a power of two so that the region
  60262. ** of the database file used for locking (beginning at PENDING_BYTE,
  60263. ** the first byte past the 1GB boundary, 0x40000000) needs to occur
  60264. ** at the beginning of a page.
  60265. **
  60266. ** If parameter nReserve is less than zero, then the number of reserved
  60267. ** bytes per page is left unchanged.
  60268. **
  60269. ** If the iFix!=0 then the BTS_PAGESIZE_FIXED flag is set so that the page size
  60270. ** and autovacuum mode can no longer be changed.
  60271. */
  60272. SQLITE_PRIVATE int sqlite3BtreeSetPageSize(Btree *p, int pageSize, int nReserve, int iFix){
  60273. int rc = SQLITE_OK;
  60274. BtShared *pBt = p->pBt;
  60275. assert( nReserve>=-1 && nReserve<=255 );
  60276. sqlite3BtreeEnter(p);
  60277. #if SQLITE_HAS_CODEC
  60278. if( nReserve>pBt->optimalReserve ) pBt->optimalReserve = (u8)nReserve;
  60279. #endif
  60280. if( pBt->btsFlags & BTS_PAGESIZE_FIXED ){
  60281. sqlite3BtreeLeave(p);
  60282. return SQLITE_READONLY;
  60283. }
  60284. if( nReserve<0 ){
  60285. nReserve = pBt->pageSize - pBt->usableSize;
  60286. }
  60287. assert( nReserve>=0 && nReserve<=255 );
  60288. if( pageSize>=512 && pageSize<=SQLITE_MAX_PAGE_SIZE &&
  60289. ((pageSize-1)&pageSize)==0 ){
  60290. assert( (pageSize & 7)==0 );
  60291. assert( !pBt->pCursor );
  60292. pBt->pageSize = (u32)pageSize;
  60293. freeTempSpace(pBt);
  60294. }
  60295. rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize, nReserve);
  60296. pBt->usableSize = pBt->pageSize - (u16)nReserve;
  60297. if( iFix ) pBt->btsFlags |= BTS_PAGESIZE_FIXED;
  60298. sqlite3BtreeLeave(p);
  60299. return rc;
  60300. }
  60301. /*
  60302. ** Return the currently defined page size
  60303. */
  60304. SQLITE_PRIVATE int sqlite3BtreeGetPageSize(Btree *p){
  60305. return p->pBt->pageSize;
  60306. }
  60307. /*
  60308. ** This function is similar to sqlite3BtreeGetReserve(), except that it
  60309. ** may only be called if it is guaranteed that the b-tree mutex is already
  60310. ** held.
  60311. **
  60312. ** This is useful in one special case in the backup API code where it is
  60313. ** known that the shared b-tree mutex is held, but the mutex on the
  60314. ** database handle that owns *p is not. In this case if sqlite3BtreeEnter()
  60315. ** were to be called, it might collide with some other operation on the
  60316. ** database handle that owns *p, causing undefined behavior.
  60317. */
  60318. SQLITE_PRIVATE int sqlite3BtreeGetReserveNoMutex(Btree *p){
  60319. int n;
  60320. assert( sqlite3_mutex_held(p->pBt->mutex) );
  60321. n = p->pBt->pageSize - p->pBt->usableSize;
  60322. return n;
  60323. }
  60324. /*
  60325. ** Return the number of bytes of space at the end of every page that
  60326. ** are intentually left unused. This is the "reserved" space that is
  60327. ** sometimes used by extensions.
  60328. **
  60329. ** If SQLITE_HAS_MUTEX is defined then the number returned is the
  60330. ** greater of the current reserved space and the maximum requested
  60331. ** reserve space.
  60332. */
  60333. SQLITE_PRIVATE int sqlite3BtreeGetOptimalReserve(Btree *p){
  60334. int n;
  60335. sqlite3BtreeEnter(p);
  60336. n = sqlite3BtreeGetReserveNoMutex(p);
  60337. #ifdef SQLITE_HAS_CODEC
  60338. if( n<p->pBt->optimalReserve ) n = p->pBt->optimalReserve;
  60339. #endif
  60340. sqlite3BtreeLeave(p);
  60341. return n;
  60342. }
  60343. /*
  60344. ** Set the maximum page count for a database if mxPage is positive.
  60345. ** No changes are made if mxPage is 0 or negative.
  60346. ** Regardless of the value of mxPage, return the maximum page count.
  60347. */
  60348. SQLITE_PRIVATE int sqlite3BtreeMaxPageCount(Btree *p, int mxPage){
  60349. int n;
  60350. sqlite3BtreeEnter(p);
  60351. n = sqlite3PagerMaxPageCount(p->pBt->pPager, mxPage);
  60352. sqlite3BtreeLeave(p);
  60353. return n;
  60354. }
  60355. /*
  60356. ** Change the values for the BTS_SECURE_DELETE and BTS_OVERWRITE flags:
  60357. **
  60358. ** newFlag==0 Both BTS_SECURE_DELETE and BTS_OVERWRITE are cleared
  60359. ** newFlag==1 BTS_SECURE_DELETE set and BTS_OVERWRITE is cleared
  60360. ** newFlag==2 BTS_SECURE_DELETE cleared and BTS_OVERWRITE is set
  60361. ** newFlag==(-1) No changes
  60362. **
  60363. ** This routine acts as a query if newFlag is less than zero
  60364. **
  60365. ** With BTS_OVERWRITE set, deleted content is overwritten by zeros, but
  60366. ** freelist leaf pages are not written back to the database. Thus in-page
  60367. ** deleted content is cleared, but freelist deleted content is not.
  60368. **
  60369. ** With BTS_SECURE_DELETE, operation is like BTS_OVERWRITE with the addition
  60370. ** that freelist leaf pages are written back into the database, increasing
  60371. ** the amount of disk I/O.
  60372. */
  60373. SQLITE_PRIVATE int sqlite3BtreeSecureDelete(Btree *p, int newFlag){
  60374. int b;
  60375. if( p==0 ) return 0;
  60376. sqlite3BtreeEnter(p);
  60377. assert( BTS_OVERWRITE==BTS_SECURE_DELETE*2 );
  60378. assert( BTS_FAST_SECURE==(BTS_OVERWRITE|BTS_SECURE_DELETE) );
  60379. if( newFlag>=0 ){
  60380. p->pBt->btsFlags &= ~BTS_FAST_SECURE;
  60381. p->pBt->btsFlags |= BTS_SECURE_DELETE*newFlag;
  60382. }
  60383. b = (p->pBt->btsFlags & BTS_FAST_SECURE)/BTS_SECURE_DELETE;
  60384. sqlite3BtreeLeave(p);
  60385. return b;
  60386. }
  60387. /*
  60388. ** Change the 'auto-vacuum' property of the database. If the 'autoVacuum'
  60389. ** parameter is non-zero, then auto-vacuum mode is enabled. If zero, it
  60390. ** is disabled. The default value for the auto-vacuum property is
  60391. ** determined by the SQLITE_DEFAULT_AUTOVACUUM macro.
  60392. */
  60393. SQLITE_PRIVATE int sqlite3BtreeSetAutoVacuum(Btree *p, int autoVacuum){
  60394. #ifdef SQLITE_OMIT_AUTOVACUUM
  60395. return SQLITE_READONLY;
  60396. #else
  60397. BtShared *pBt = p->pBt;
  60398. int rc = SQLITE_OK;
  60399. u8 av = (u8)autoVacuum;
  60400. sqlite3BtreeEnter(p);
  60401. if( (pBt->btsFlags & BTS_PAGESIZE_FIXED)!=0 && (av ?1:0)!=pBt->autoVacuum ){
  60402. rc = SQLITE_READONLY;
  60403. }else{
  60404. pBt->autoVacuum = av ?1:0;
  60405. pBt->incrVacuum = av==2 ?1:0;
  60406. }
  60407. sqlite3BtreeLeave(p);
  60408. return rc;
  60409. #endif
  60410. }
  60411. /*
  60412. ** Return the value of the 'auto-vacuum' property. If auto-vacuum is
  60413. ** enabled 1 is returned. Otherwise 0.
  60414. */
  60415. SQLITE_PRIVATE int sqlite3BtreeGetAutoVacuum(Btree *p){
  60416. #ifdef SQLITE_OMIT_AUTOVACUUM
  60417. return BTREE_AUTOVACUUM_NONE;
  60418. #else
  60419. int rc;
  60420. sqlite3BtreeEnter(p);
  60421. rc = (
  60422. (!p->pBt->autoVacuum)?BTREE_AUTOVACUUM_NONE:
  60423. (!p->pBt->incrVacuum)?BTREE_AUTOVACUUM_FULL:
  60424. BTREE_AUTOVACUUM_INCR
  60425. );
  60426. sqlite3BtreeLeave(p);
  60427. return rc;
  60428. #endif
  60429. }
  60430. /*
  60431. ** If the user has not set the safety-level for this database connection
  60432. ** using "PRAGMA synchronous", and if the safety-level is not already
  60433. ** set to the value passed to this function as the second parameter,
  60434. ** set it so.
  60435. */
  60436. #if SQLITE_DEFAULT_SYNCHRONOUS!=SQLITE_DEFAULT_WAL_SYNCHRONOUS \
  60437. && !defined(SQLITE_OMIT_WAL)
  60438. static void setDefaultSyncFlag(BtShared *pBt, u8 safety_level){
  60439. sqlite3 *db;
  60440. Db *pDb;
  60441. if( (db=pBt->db)!=0 && (pDb=db->aDb)!=0 ){
  60442. while( pDb->pBt==0 || pDb->pBt->pBt!=pBt ){ pDb++; }
  60443. if( pDb->bSyncSet==0
  60444. && pDb->safety_level!=safety_level
  60445. && pDb!=&db->aDb[1]
  60446. ){
  60447. pDb->safety_level = safety_level;
  60448. sqlite3PagerSetFlags(pBt->pPager,
  60449. pDb->safety_level | (db->flags & PAGER_FLAGS_MASK));
  60450. }
  60451. }
  60452. }
  60453. #else
  60454. # define setDefaultSyncFlag(pBt,safety_level)
  60455. #endif
  60456. /*
  60457. ** Get a reference to pPage1 of the database file. This will
  60458. ** also acquire a readlock on that file.
  60459. **
  60460. ** SQLITE_OK is returned on success. If the file is not a
  60461. ** well-formed database file, then SQLITE_CORRUPT is returned.
  60462. ** SQLITE_BUSY is returned if the database is locked. SQLITE_NOMEM
  60463. ** is returned if we run out of memory.
  60464. */
  60465. static int lockBtree(BtShared *pBt){
  60466. int rc; /* Result code from subfunctions */
  60467. MemPage *pPage1; /* Page 1 of the database file */
  60468. int nPage; /* Number of pages in the database */
  60469. int nPageFile = 0; /* Number of pages in the database file */
  60470. int nPageHeader; /* Number of pages in the database according to hdr */
  60471. assert( sqlite3_mutex_held(pBt->mutex) );
  60472. assert( pBt->pPage1==0 );
  60473. rc = sqlite3PagerSharedLock(pBt->pPager);
  60474. if( rc!=SQLITE_OK ) return rc;
  60475. rc = btreeGetPage(pBt, 1, &pPage1, 0);
  60476. if( rc!=SQLITE_OK ) return rc;
  60477. /* Do some checking to help insure the file we opened really is
  60478. ** a valid database file.
  60479. */
  60480. nPage = nPageHeader = get4byte(28+(u8*)pPage1->aData);
  60481. sqlite3PagerPagecount(pBt->pPager, &nPageFile);
  60482. if( nPage==0 || memcmp(24+(u8*)pPage1->aData, 92+(u8*)pPage1->aData,4)!=0 ){
  60483. nPage = nPageFile;
  60484. }
  60485. if( nPage>0 ){
  60486. u32 pageSize;
  60487. u32 usableSize;
  60488. u8 *page1 = pPage1->aData;
  60489. rc = SQLITE_NOTADB;
  60490. /* EVIDENCE-OF: R-43737-39999 Every valid SQLite database file begins
  60491. ** with the following 16 bytes (in hex): 53 51 4c 69 74 65 20 66 6f 72 6d
  60492. ** 61 74 20 33 00. */
  60493. if( memcmp(page1, zMagicHeader, 16)!=0 ){
  60494. goto page1_init_failed;
  60495. }
  60496. #ifdef SQLITE_OMIT_WAL
  60497. if( page1[18]>1 ){
  60498. pBt->btsFlags |= BTS_READ_ONLY;
  60499. }
  60500. if( page1[19]>1 ){
  60501. goto page1_init_failed;
  60502. }
  60503. #else
  60504. if( page1[18]>2 ){
  60505. pBt->btsFlags |= BTS_READ_ONLY;
  60506. }
  60507. if( page1[19]>2 ){
  60508. goto page1_init_failed;
  60509. }
  60510. /* If the write version is set to 2, this database should be accessed
  60511. ** in WAL mode. If the log is not already open, open it now. Then
  60512. ** return SQLITE_OK and return without populating BtShared.pPage1.
  60513. ** The caller detects this and calls this function again. This is
  60514. ** required as the version of page 1 currently in the page1 buffer
  60515. ** may not be the latest version - there may be a newer one in the log
  60516. ** file.
  60517. */
  60518. if( page1[19]==2 && (pBt->btsFlags & BTS_NO_WAL)==0 ){
  60519. int isOpen = 0;
  60520. rc = sqlite3PagerOpenWal(pBt->pPager, &isOpen);
  60521. if( rc!=SQLITE_OK ){
  60522. goto page1_init_failed;
  60523. }else{
  60524. setDefaultSyncFlag(pBt, SQLITE_DEFAULT_WAL_SYNCHRONOUS+1);
  60525. if( isOpen==0 ){
  60526. releasePageOne(pPage1);
  60527. return SQLITE_OK;
  60528. }
  60529. }
  60530. rc = SQLITE_NOTADB;
  60531. }else{
  60532. setDefaultSyncFlag(pBt, SQLITE_DEFAULT_SYNCHRONOUS+1);
  60533. }
  60534. #endif
  60535. /* EVIDENCE-OF: R-15465-20813 The maximum and minimum embedded payload
  60536. ** fractions and the leaf payload fraction values must be 64, 32, and 32.
  60537. **
  60538. ** The original design allowed these amounts to vary, but as of
  60539. ** version 3.6.0, we require them to be fixed.
  60540. */
  60541. if( memcmp(&page1[21], "\100\040\040",3)!=0 ){
  60542. goto page1_init_failed;
  60543. }
  60544. /* EVIDENCE-OF: R-51873-39618 The page size for a database file is
  60545. ** determined by the 2-byte integer located at an offset of 16 bytes from
  60546. ** the beginning of the database file. */
  60547. pageSize = (page1[16]<<8) | (page1[17]<<16);
  60548. /* EVIDENCE-OF: R-25008-21688 The size of a page is a power of two
  60549. ** between 512 and 65536 inclusive. */
  60550. if( ((pageSize-1)&pageSize)!=0
  60551. || pageSize>SQLITE_MAX_PAGE_SIZE
  60552. || pageSize<=256
  60553. ){
  60554. goto page1_init_failed;
  60555. }
  60556. assert( (pageSize & 7)==0 );
  60557. /* EVIDENCE-OF: R-59310-51205 The "reserved space" size in the 1-byte
  60558. ** integer at offset 20 is the number of bytes of space at the end of
  60559. ** each page to reserve for extensions.
  60560. **
  60561. ** EVIDENCE-OF: R-37497-42412 The size of the reserved region is
  60562. ** determined by the one-byte unsigned integer found at an offset of 20
  60563. ** into the database file header. */
  60564. usableSize = pageSize - page1[20];
  60565. if( (u32)pageSize!=pBt->pageSize ){
  60566. /* After reading the first page of the database assuming a page size
  60567. ** of BtShared.pageSize, we have discovered that the page-size is
  60568. ** actually pageSize. Unlock the database, leave pBt->pPage1 at
  60569. ** zero and return SQLITE_OK. The caller will call this function
  60570. ** again with the correct page-size.
  60571. */
  60572. releasePageOne(pPage1);
  60573. pBt->usableSize = usableSize;
  60574. pBt->pageSize = pageSize;
  60575. freeTempSpace(pBt);
  60576. rc = sqlite3PagerSetPagesize(pBt->pPager, &pBt->pageSize,
  60577. pageSize-usableSize);
  60578. return rc;
  60579. }
  60580. if( (pBt->db->flags & SQLITE_WriteSchema)==0 && nPage>nPageFile ){
  60581. rc = SQLITE_CORRUPT_BKPT;
  60582. goto page1_init_failed;
  60583. }
  60584. /* EVIDENCE-OF: R-28312-64704 However, the usable size is not allowed to
  60585. ** be less than 480. In other words, if the page size is 512, then the
  60586. ** reserved space size cannot exceed 32. */
  60587. if( usableSize<480 ){
  60588. goto page1_init_failed;
  60589. }
  60590. pBt->pageSize = pageSize;
  60591. pBt->usableSize = usableSize;
  60592. #ifndef SQLITE_OMIT_AUTOVACUUM
  60593. pBt->autoVacuum = (get4byte(&page1[36 + 4*4])?1:0);
  60594. pBt->incrVacuum = (get4byte(&page1[36 + 7*4])?1:0);
  60595. #endif
  60596. }
  60597. /* maxLocal is the maximum amount of payload to store locally for
  60598. ** a cell. Make sure it is small enough so that at least minFanout
  60599. ** cells can will fit on one page. We assume a 10-byte page header.
  60600. ** Besides the payload, the cell must store:
  60601. ** 2-byte pointer to the cell
  60602. ** 4-byte child pointer
  60603. ** 9-byte nKey value
  60604. ** 4-byte nData value
  60605. ** 4-byte overflow page pointer
  60606. ** So a cell consists of a 2-byte pointer, a header which is as much as
  60607. ** 17 bytes long, 0 to N bytes of payload, and an optional 4 byte overflow
  60608. ** page pointer.
  60609. */
  60610. pBt->maxLocal = (u16)((pBt->usableSize-12)*64/255 - 23);
  60611. pBt->minLocal = (u16)((pBt->usableSize-12)*32/255 - 23);
  60612. pBt->maxLeaf = (u16)(pBt->usableSize - 35);
  60613. pBt->minLeaf = (u16)((pBt->usableSize-12)*32/255 - 23);
  60614. if( pBt->maxLocal>127 ){
  60615. pBt->max1bytePayload = 127;
  60616. }else{
  60617. pBt->max1bytePayload = (u8)pBt->maxLocal;
  60618. }
  60619. assert( pBt->maxLeaf + 23 <= MX_CELL_SIZE(pBt) );
  60620. pBt->pPage1 = pPage1;
  60621. pBt->nPage = nPage;
  60622. return SQLITE_OK;
  60623. page1_init_failed:
  60624. releasePageOne(pPage1);
  60625. pBt->pPage1 = 0;
  60626. return rc;
  60627. }
  60628. #ifndef NDEBUG
  60629. /*
  60630. ** Return the number of cursors open on pBt. This is for use
  60631. ** in assert() expressions, so it is only compiled if NDEBUG is not
  60632. ** defined.
  60633. **
  60634. ** Only write cursors are counted if wrOnly is true. If wrOnly is
  60635. ** false then all cursors are counted.
  60636. **
  60637. ** For the purposes of this routine, a cursor is any cursor that
  60638. ** is capable of reading or writing to the database. Cursors that
  60639. ** have been tripped into the CURSOR_FAULT state are not counted.
  60640. */
  60641. static int countValidCursors(BtShared *pBt, int wrOnly){
  60642. BtCursor *pCur;
  60643. int r = 0;
  60644. for(pCur=pBt->pCursor; pCur; pCur=pCur->pNext){
  60645. if( (wrOnly==0 || (pCur->curFlags & BTCF_WriteFlag)!=0)
  60646. && pCur->eState!=CURSOR_FAULT ) r++;
  60647. }
  60648. return r;
  60649. }
  60650. #endif
  60651. /*
  60652. ** If there are no outstanding cursors and we are not in the middle
  60653. ** of a transaction but there is a read lock on the database, then
  60654. ** this routine unrefs the first page of the database file which
  60655. ** has the effect of releasing the read lock.
  60656. **
  60657. ** If there is a transaction in progress, this routine is a no-op.
  60658. */
  60659. static void unlockBtreeIfUnused(BtShared *pBt){
  60660. assert( sqlite3_mutex_held(pBt->mutex) );
  60661. assert( countValidCursors(pBt,0)==0 || pBt->inTransaction>TRANS_NONE );
  60662. if( pBt->inTransaction==TRANS_NONE && pBt->pPage1!=0 ){
  60663. MemPage *pPage1 = pBt->pPage1;
  60664. assert( pPage1->aData );
  60665. assert( sqlite3PagerRefcount(pBt->pPager)==1 );
  60666. pBt->pPage1 = 0;
  60667. releasePageOne(pPage1);
  60668. }
  60669. }
  60670. /*
  60671. ** If pBt points to an empty file then convert that empty file
  60672. ** into a new empty database by initializing the first page of
  60673. ** the database.
  60674. */
  60675. static int newDatabase(BtShared *pBt){
  60676. MemPage *pP1;
  60677. unsigned char *data;
  60678. int rc;
  60679. assert( sqlite3_mutex_held(pBt->mutex) );
  60680. if( pBt->nPage>0 ){
  60681. return SQLITE_OK;
  60682. }
  60683. pP1 = pBt->pPage1;
  60684. assert( pP1!=0 );
  60685. data = pP1->aData;
  60686. rc = sqlite3PagerWrite(pP1->pDbPage);
  60687. if( rc ) return rc;
  60688. memcpy(data, zMagicHeader, sizeof(zMagicHeader));
  60689. assert( sizeof(zMagicHeader)==16 );
  60690. data[16] = (u8)((pBt->pageSize>>8)&0xff);
  60691. data[17] = (u8)((pBt->pageSize>>16)&0xff);
  60692. data[18] = 1;
  60693. data[19] = 1;
  60694. assert( pBt->usableSize<=pBt->pageSize && pBt->usableSize+255>=pBt->pageSize);
  60695. data[20] = (u8)(pBt->pageSize - pBt->usableSize);
  60696. data[21] = 64;
  60697. data[22] = 32;
  60698. data[23] = 32;
  60699. memset(&data[24], 0, 100-24);
  60700. zeroPage(pP1, PTF_INTKEY|PTF_LEAF|PTF_LEAFDATA );
  60701. pBt->btsFlags |= BTS_PAGESIZE_FIXED;
  60702. #ifndef SQLITE_OMIT_AUTOVACUUM
  60703. assert( pBt->autoVacuum==1 || pBt->autoVacuum==0 );
  60704. assert( pBt->incrVacuum==1 || pBt->incrVacuum==0 );
  60705. put4byte(&data[36 + 4*4], pBt->autoVacuum);
  60706. put4byte(&data[36 + 7*4], pBt->incrVacuum);
  60707. #endif
  60708. pBt->nPage = 1;
  60709. data[31] = 1;
  60710. return SQLITE_OK;
  60711. }
  60712. /*
  60713. ** Initialize the first page of the database file (creating a database
  60714. ** consisting of a single page and no schema objects). Return SQLITE_OK
  60715. ** if successful, or an SQLite error code otherwise.
  60716. */
  60717. SQLITE_PRIVATE int sqlite3BtreeNewDb(Btree *p){
  60718. int rc;
  60719. sqlite3BtreeEnter(p);
  60720. p->pBt->nPage = 0;
  60721. rc = newDatabase(p->pBt);
  60722. sqlite3BtreeLeave(p);
  60723. return rc;
  60724. }
  60725. /*
  60726. ** Attempt to start a new transaction. A write-transaction
  60727. ** is started if the second argument is nonzero, otherwise a read-
  60728. ** transaction. If the second argument is 2 or more and exclusive
  60729. ** transaction is started, meaning that no other process is allowed
  60730. ** to access the database. A preexisting transaction may not be
  60731. ** upgraded to exclusive by calling this routine a second time - the
  60732. ** exclusivity flag only works for a new transaction.
  60733. **
  60734. ** A write-transaction must be started before attempting any
  60735. ** changes to the database. None of the following routines
  60736. ** will work unless a transaction is started first:
  60737. **
  60738. ** sqlite3BtreeCreateTable()
  60739. ** sqlite3BtreeCreateIndex()
  60740. ** sqlite3BtreeClearTable()
  60741. ** sqlite3BtreeDropTable()
  60742. ** sqlite3BtreeInsert()
  60743. ** sqlite3BtreeDelete()
  60744. ** sqlite3BtreeUpdateMeta()
  60745. **
  60746. ** If an initial attempt to acquire the lock fails because of lock contention
  60747. ** and the database was previously unlocked, then invoke the busy handler
  60748. ** if there is one. But if there was previously a read-lock, do not
  60749. ** invoke the busy handler - just return SQLITE_BUSY. SQLITE_BUSY is
  60750. ** returned when there is already a read-lock in order to avoid a deadlock.
  60751. **
  60752. ** Suppose there are two processes A and B. A has a read lock and B has
  60753. ** a reserved lock. B tries to promote to exclusive but is blocked because
  60754. ** of A's read lock. A tries to promote to reserved but is blocked by B.
  60755. ** One or the other of the two processes must give way or there can be
  60756. ** no progress. By returning SQLITE_BUSY and not invoking the busy callback
  60757. ** when A already has a read lock, we encourage A to give up and let B
  60758. ** proceed.
  60759. */
  60760. SQLITE_PRIVATE int sqlite3BtreeBeginTrans(Btree *p, int wrflag){
  60761. BtShared *pBt = p->pBt;
  60762. int rc = SQLITE_OK;
  60763. sqlite3BtreeEnter(p);
  60764. btreeIntegrity(p);
  60765. /* If the btree is already in a write-transaction, or it
  60766. ** is already in a read-transaction and a read-transaction
  60767. ** is requested, this is a no-op.
  60768. */
  60769. if( p->inTrans==TRANS_WRITE || (p->inTrans==TRANS_READ && !wrflag) ){
  60770. goto trans_begun;
  60771. }
  60772. assert( pBt->inTransaction==TRANS_WRITE || IfNotOmitAV(pBt->bDoTruncate)==0 );
  60773. /* Write transactions are not possible on a read-only database */
  60774. if( (pBt->btsFlags & BTS_READ_ONLY)!=0 && wrflag ){
  60775. rc = SQLITE_READONLY;
  60776. goto trans_begun;
  60777. }
  60778. #ifndef SQLITE_OMIT_SHARED_CACHE
  60779. {
  60780. sqlite3 *pBlock = 0;
  60781. /* If another database handle has already opened a write transaction
  60782. ** on this shared-btree structure and a second write transaction is
  60783. ** requested, return SQLITE_LOCKED.
  60784. */
  60785. if( (wrflag && pBt->inTransaction==TRANS_WRITE)
  60786. || (pBt->btsFlags & BTS_PENDING)!=0
  60787. ){
  60788. pBlock = pBt->pWriter->db;
  60789. }else if( wrflag>1 ){
  60790. BtLock *pIter;
  60791. for(pIter=pBt->pLock; pIter; pIter=pIter->pNext){
  60792. if( pIter->pBtree!=p ){
  60793. pBlock = pIter->pBtree->db;
  60794. break;
  60795. }
  60796. }
  60797. }
  60798. if( pBlock ){
  60799. sqlite3ConnectionBlocked(p->db, pBlock);
  60800. rc = SQLITE_LOCKED_SHAREDCACHE;
  60801. goto trans_begun;
  60802. }
  60803. }
  60804. #endif
  60805. /* Any read-only or read-write transaction implies a read-lock on
  60806. ** page 1. So if some other shared-cache client already has a write-lock
  60807. ** on page 1, the transaction cannot be opened. */
  60808. rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
  60809. if( SQLITE_OK!=rc ) goto trans_begun;
  60810. pBt->btsFlags &= ~BTS_INITIALLY_EMPTY;
  60811. if( pBt->nPage==0 ) pBt->btsFlags |= BTS_INITIALLY_EMPTY;
  60812. do {
  60813. /* Call lockBtree() until either pBt->pPage1 is populated or
  60814. ** lockBtree() returns something other than SQLITE_OK. lockBtree()
  60815. ** may return SQLITE_OK but leave pBt->pPage1 set to 0 if after
  60816. ** reading page 1 it discovers that the page-size of the database
  60817. ** file is not pBt->pageSize. In this case lockBtree() will update
  60818. ** pBt->pageSize to the page-size of the file on disk.
  60819. */
  60820. while( pBt->pPage1==0 && SQLITE_OK==(rc = lockBtree(pBt)) );
  60821. if( rc==SQLITE_OK && wrflag ){
  60822. if( (pBt->btsFlags & BTS_READ_ONLY)!=0 ){
  60823. rc = SQLITE_READONLY;
  60824. }else{
  60825. rc = sqlite3PagerBegin(pBt->pPager,wrflag>1,sqlite3TempInMemory(p->db));
  60826. if( rc==SQLITE_OK ){
  60827. rc = newDatabase(pBt);
  60828. }
  60829. }
  60830. }
  60831. if( rc!=SQLITE_OK ){
  60832. unlockBtreeIfUnused(pBt);
  60833. }
  60834. }while( (rc&0xFF)==SQLITE_BUSY && pBt->inTransaction==TRANS_NONE &&
  60835. btreeInvokeBusyHandler(pBt) );
  60836. sqlite3PagerResetLockTimeout(pBt->pPager);
  60837. if( rc==SQLITE_OK ){
  60838. if( p->inTrans==TRANS_NONE ){
  60839. pBt->nTransaction++;
  60840. #ifndef SQLITE_OMIT_SHARED_CACHE
  60841. if( p->sharable ){
  60842. assert( p->lock.pBtree==p && p->lock.iTable==1 );
  60843. p->lock.eLock = READ_LOCK;
  60844. p->lock.pNext = pBt->pLock;
  60845. pBt->pLock = &p->lock;
  60846. }
  60847. #endif
  60848. }
  60849. p->inTrans = (wrflag?TRANS_WRITE:TRANS_READ);
  60850. if( p->inTrans>pBt->inTransaction ){
  60851. pBt->inTransaction = p->inTrans;
  60852. }
  60853. if( wrflag ){
  60854. MemPage *pPage1 = pBt->pPage1;
  60855. #ifndef SQLITE_OMIT_SHARED_CACHE
  60856. assert( !pBt->pWriter );
  60857. pBt->pWriter = p;
  60858. pBt->btsFlags &= ~BTS_EXCLUSIVE;
  60859. if( wrflag>1 ) pBt->btsFlags |= BTS_EXCLUSIVE;
  60860. #endif
  60861. /* If the db-size header field is incorrect (as it may be if an old
  60862. ** client has been writing the database file), update it now. Doing
  60863. ** this sooner rather than later means the database size can safely
  60864. ** re-read the database size from page 1 if a savepoint or transaction
  60865. ** rollback occurs within the transaction.
  60866. */
  60867. if( pBt->nPage!=get4byte(&pPage1->aData[28]) ){
  60868. rc = sqlite3PagerWrite(pPage1->pDbPage);
  60869. if( rc==SQLITE_OK ){
  60870. put4byte(&pPage1->aData[28], pBt->nPage);
  60871. }
  60872. }
  60873. }
  60874. }
  60875. trans_begun:
  60876. if( rc==SQLITE_OK && wrflag ){
  60877. /* This call makes sure that the pager has the correct number of
  60878. ** open savepoints. If the second parameter is greater than 0 and
  60879. ** the sub-journal is not already open, then it will be opened here.
  60880. */
  60881. rc = sqlite3PagerOpenSavepoint(pBt->pPager, p->db->nSavepoint);
  60882. }
  60883. btreeIntegrity(p);
  60884. sqlite3BtreeLeave(p);
  60885. return rc;
  60886. }
  60887. #ifndef SQLITE_OMIT_AUTOVACUUM
  60888. /*
  60889. ** Set the pointer-map entries for all children of page pPage. Also, if
  60890. ** pPage contains cells that point to overflow pages, set the pointer
  60891. ** map entries for the overflow pages as well.
  60892. */
  60893. static int setChildPtrmaps(MemPage *pPage){
  60894. int i; /* Counter variable */
  60895. int nCell; /* Number of cells in page pPage */
  60896. int rc; /* Return code */
  60897. BtShared *pBt = pPage->pBt;
  60898. Pgno pgno = pPage->pgno;
  60899. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60900. rc = pPage->isInit ? SQLITE_OK : btreeInitPage(pPage);
  60901. if( rc!=SQLITE_OK ) return rc;
  60902. nCell = pPage->nCell;
  60903. for(i=0; i<nCell; i++){
  60904. u8 *pCell = findCell(pPage, i);
  60905. ptrmapPutOvflPtr(pPage, pCell, &rc);
  60906. if( !pPage->leaf ){
  60907. Pgno childPgno = get4byte(pCell);
  60908. ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
  60909. }
  60910. }
  60911. if( !pPage->leaf ){
  60912. Pgno childPgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  60913. ptrmapPut(pBt, childPgno, PTRMAP_BTREE, pgno, &rc);
  60914. }
  60915. return rc;
  60916. }
  60917. /*
  60918. ** Somewhere on pPage is a pointer to page iFrom. Modify this pointer so
  60919. ** that it points to iTo. Parameter eType describes the type of pointer to
  60920. ** be modified, as follows:
  60921. **
  60922. ** PTRMAP_BTREE: pPage is a btree-page. The pointer points at a child
  60923. ** page of pPage.
  60924. **
  60925. ** PTRMAP_OVERFLOW1: pPage is a btree-page. The pointer points at an overflow
  60926. ** page pointed to by one of the cells on pPage.
  60927. **
  60928. ** PTRMAP_OVERFLOW2: pPage is an overflow-page. The pointer points at the next
  60929. ** overflow page in the list.
  60930. */
  60931. static int modifyPagePointer(MemPage *pPage, Pgno iFrom, Pgno iTo, u8 eType){
  60932. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  60933. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  60934. if( eType==PTRMAP_OVERFLOW2 ){
  60935. /* The pointer is always the first 4 bytes of the page in this case. */
  60936. if( get4byte(pPage->aData)!=iFrom ){
  60937. return SQLITE_CORRUPT_PAGE(pPage);
  60938. }
  60939. put4byte(pPage->aData, iTo);
  60940. }else{
  60941. int i;
  60942. int nCell;
  60943. int rc;
  60944. rc = pPage->isInit ? SQLITE_OK : btreeInitPage(pPage);
  60945. if( rc ) return rc;
  60946. nCell = pPage->nCell;
  60947. for(i=0; i<nCell; i++){
  60948. u8 *pCell = findCell(pPage, i);
  60949. if( eType==PTRMAP_OVERFLOW1 ){
  60950. CellInfo info;
  60951. pPage->xParseCell(pPage, pCell, &info);
  60952. if( info.nLocal<info.nPayload ){
  60953. if( pCell+info.nSize > pPage->aData+pPage->pBt->usableSize ){
  60954. return SQLITE_CORRUPT_PAGE(pPage);
  60955. }
  60956. if( iFrom==get4byte(pCell+info.nSize-4) ){
  60957. put4byte(pCell+info.nSize-4, iTo);
  60958. break;
  60959. }
  60960. }
  60961. }else{
  60962. if( get4byte(pCell)==iFrom ){
  60963. put4byte(pCell, iTo);
  60964. break;
  60965. }
  60966. }
  60967. }
  60968. if( i==nCell ){
  60969. if( eType!=PTRMAP_BTREE ||
  60970. get4byte(&pPage->aData[pPage->hdrOffset+8])!=iFrom ){
  60971. return SQLITE_CORRUPT_PAGE(pPage);
  60972. }
  60973. put4byte(&pPage->aData[pPage->hdrOffset+8], iTo);
  60974. }
  60975. }
  60976. return SQLITE_OK;
  60977. }
  60978. /*
  60979. ** Move the open database page pDbPage to location iFreePage in the
  60980. ** database. The pDbPage reference remains valid.
  60981. **
  60982. ** The isCommit flag indicates that there is no need to remember that
  60983. ** the journal needs to be sync()ed before database page pDbPage->pgno
  60984. ** can be written to. The caller has already promised not to write to that
  60985. ** page.
  60986. */
  60987. static int relocatePage(
  60988. BtShared *pBt, /* Btree */
  60989. MemPage *pDbPage, /* Open page to move */
  60990. u8 eType, /* Pointer map 'type' entry for pDbPage */
  60991. Pgno iPtrPage, /* Pointer map 'page-no' entry for pDbPage */
  60992. Pgno iFreePage, /* The location to move pDbPage to */
  60993. int isCommit /* isCommit flag passed to sqlite3PagerMovepage */
  60994. ){
  60995. MemPage *pPtrPage; /* The page that contains a pointer to pDbPage */
  60996. Pgno iDbPage = pDbPage->pgno;
  60997. Pager *pPager = pBt->pPager;
  60998. int rc;
  60999. assert( eType==PTRMAP_OVERFLOW2 || eType==PTRMAP_OVERFLOW1 ||
  61000. eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE );
  61001. assert( sqlite3_mutex_held(pBt->mutex) );
  61002. assert( pDbPage->pBt==pBt );
  61003. /* Move page iDbPage from its current location to page number iFreePage */
  61004. TRACE(("AUTOVACUUM: Moving %d to free page %d (ptr page %d type %d)\n",
  61005. iDbPage, iFreePage, iPtrPage, eType));
  61006. rc = sqlite3PagerMovepage(pPager, pDbPage->pDbPage, iFreePage, isCommit);
  61007. if( rc!=SQLITE_OK ){
  61008. return rc;
  61009. }
  61010. pDbPage->pgno = iFreePage;
  61011. /* If pDbPage was a btree-page, then it may have child pages and/or cells
  61012. ** that point to overflow pages. The pointer map entries for all these
  61013. ** pages need to be changed.
  61014. **
  61015. ** If pDbPage is an overflow page, then the first 4 bytes may store a
  61016. ** pointer to a subsequent overflow page. If this is the case, then
  61017. ** the pointer map needs to be updated for the subsequent overflow page.
  61018. */
  61019. if( eType==PTRMAP_BTREE || eType==PTRMAP_ROOTPAGE ){
  61020. rc = setChildPtrmaps(pDbPage);
  61021. if( rc!=SQLITE_OK ){
  61022. return rc;
  61023. }
  61024. }else{
  61025. Pgno nextOvfl = get4byte(pDbPage->aData);
  61026. if( nextOvfl!=0 ){
  61027. ptrmapPut(pBt, nextOvfl, PTRMAP_OVERFLOW2, iFreePage, &rc);
  61028. if( rc!=SQLITE_OK ){
  61029. return rc;
  61030. }
  61031. }
  61032. }
  61033. /* Fix the database pointer on page iPtrPage that pointed at iDbPage so
  61034. ** that it points at iFreePage. Also fix the pointer map entry for
  61035. ** iPtrPage.
  61036. */
  61037. if( eType!=PTRMAP_ROOTPAGE ){
  61038. rc = btreeGetPage(pBt, iPtrPage, &pPtrPage, 0);
  61039. if( rc!=SQLITE_OK ){
  61040. return rc;
  61041. }
  61042. rc = sqlite3PagerWrite(pPtrPage->pDbPage);
  61043. if( rc!=SQLITE_OK ){
  61044. releasePage(pPtrPage);
  61045. return rc;
  61046. }
  61047. rc = modifyPagePointer(pPtrPage, iDbPage, iFreePage, eType);
  61048. releasePage(pPtrPage);
  61049. if( rc==SQLITE_OK ){
  61050. ptrmapPut(pBt, iFreePage, eType, iPtrPage, &rc);
  61051. }
  61052. }
  61053. return rc;
  61054. }
  61055. /* Forward declaration required by incrVacuumStep(). */
  61056. static int allocateBtreePage(BtShared *, MemPage **, Pgno *, Pgno, u8);
  61057. /*
  61058. ** Perform a single step of an incremental-vacuum. If successful, return
  61059. ** SQLITE_OK. If there is no work to do (and therefore no point in
  61060. ** calling this function again), return SQLITE_DONE. Or, if an error
  61061. ** occurs, return some other error code.
  61062. **
  61063. ** More specifically, this function attempts to re-organize the database so
  61064. ** that the last page of the file currently in use is no longer in use.
  61065. **
  61066. ** Parameter nFin is the number of pages that this database would contain
  61067. ** were this function called until it returns SQLITE_DONE.
  61068. **
  61069. ** If the bCommit parameter is non-zero, this function assumes that the
  61070. ** caller will keep calling incrVacuumStep() until it returns SQLITE_DONE
  61071. ** or an error. bCommit is passed true for an auto-vacuum-on-commit
  61072. ** operation, or false for an incremental vacuum.
  61073. */
  61074. static int incrVacuumStep(BtShared *pBt, Pgno nFin, Pgno iLastPg, int bCommit){
  61075. Pgno nFreeList; /* Number of pages still on the free-list */
  61076. int rc;
  61077. assert( sqlite3_mutex_held(pBt->mutex) );
  61078. assert( iLastPg>nFin );
  61079. if( !PTRMAP_ISPAGE(pBt, iLastPg) && iLastPg!=PENDING_BYTE_PAGE(pBt) ){
  61080. u8 eType;
  61081. Pgno iPtrPage;
  61082. nFreeList = get4byte(&pBt->pPage1->aData[36]);
  61083. if( nFreeList==0 ){
  61084. return SQLITE_DONE;
  61085. }
  61086. rc = ptrmapGet(pBt, iLastPg, &eType, &iPtrPage);
  61087. if( rc!=SQLITE_OK ){
  61088. return rc;
  61089. }
  61090. if( eType==PTRMAP_ROOTPAGE ){
  61091. return SQLITE_CORRUPT_BKPT;
  61092. }
  61093. if( eType==PTRMAP_FREEPAGE ){
  61094. if( bCommit==0 ){
  61095. /* Remove the page from the files free-list. This is not required
  61096. ** if bCommit is non-zero. In that case, the free-list will be
  61097. ** truncated to zero after this function returns, so it doesn't
  61098. ** matter if it still contains some garbage entries.
  61099. */
  61100. Pgno iFreePg;
  61101. MemPage *pFreePg;
  61102. rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iLastPg, BTALLOC_EXACT);
  61103. if( rc!=SQLITE_OK ){
  61104. return rc;
  61105. }
  61106. assert( iFreePg==iLastPg );
  61107. releasePage(pFreePg);
  61108. }
  61109. } else {
  61110. Pgno iFreePg; /* Index of free page to move pLastPg to */
  61111. MemPage *pLastPg;
  61112. u8 eMode = BTALLOC_ANY; /* Mode parameter for allocateBtreePage() */
  61113. Pgno iNear = 0; /* nearby parameter for allocateBtreePage() */
  61114. rc = btreeGetPage(pBt, iLastPg, &pLastPg, 0);
  61115. if( rc!=SQLITE_OK ){
  61116. return rc;
  61117. }
  61118. /* If bCommit is zero, this loop runs exactly once and page pLastPg
  61119. ** is swapped with the first free page pulled off the free list.
  61120. **
  61121. ** On the other hand, if bCommit is greater than zero, then keep
  61122. ** looping until a free-page located within the first nFin pages
  61123. ** of the file is found.
  61124. */
  61125. if( bCommit==0 ){
  61126. eMode = BTALLOC_LE;
  61127. iNear = nFin;
  61128. }
  61129. do {
  61130. MemPage *pFreePg;
  61131. rc = allocateBtreePage(pBt, &pFreePg, &iFreePg, iNear, eMode);
  61132. if( rc!=SQLITE_OK ){
  61133. releasePage(pLastPg);
  61134. return rc;
  61135. }
  61136. releasePage(pFreePg);
  61137. }while( bCommit && iFreePg>nFin );
  61138. assert( iFreePg<iLastPg );
  61139. rc = relocatePage(pBt, pLastPg, eType, iPtrPage, iFreePg, bCommit);
  61140. releasePage(pLastPg);
  61141. if( rc!=SQLITE_OK ){
  61142. return rc;
  61143. }
  61144. }
  61145. }
  61146. if( bCommit==0 ){
  61147. do {
  61148. iLastPg--;
  61149. }while( iLastPg==PENDING_BYTE_PAGE(pBt) || PTRMAP_ISPAGE(pBt, iLastPg) );
  61150. pBt->bDoTruncate = 1;
  61151. pBt->nPage = iLastPg;
  61152. }
  61153. return SQLITE_OK;
  61154. }
  61155. /*
  61156. ** The database opened by the first argument is an auto-vacuum database
  61157. ** nOrig pages in size containing nFree free pages. Return the expected
  61158. ** size of the database in pages following an auto-vacuum operation.
  61159. */
  61160. static Pgno finalDbSize(BtShared *pBt, Pgno nOrig, Pgno nFree){
  61161. int nEntry; /* Number of entries on one ptrmap page */
  61162. Pgno nPtrmap; /* Number of PtrMap pages to be freed */
  61163. Pgno nFin; /* Return value */
  61164. nEntry = pBt->usableSize/5;
  61165. nPtrmap = (nFree-nOrig+PTRMAP_PAGENO(pBt, nOrig)+nEntry)/nEntry;
  61166. nFin = nOrig - nFree - nPtrmap;
  61167. if( nOrig>PENDING_BYTE_PAGE(pBt) && nFin<PENDING_BYTE_PAGE(pBt) ){
  61168. nFin--;
  61169. }
  61170. while( PTRMAP_ISPAGE(pBt, nFin) || nFin==PENDING_BYTE_PAGE(pBt) ){
  61171. nFin--;
  61172. }
  61173. return nFin;
  61174. }
  61175. /*
  61176. ** A write-transaction must be opened before calling this function.
  61177. ** It performs a single unit of work towards an incremental vacuum.
  61178. **
  61179. ** If the incremental vacuum is finished after this function has run,
  61180. ** SQLITE_DONE is returned. If it is not finished, but no error occurred,
  61181. ** SQLITE_OK is returned. Otherwise an SQLite error code.
  61182. */
  61183. SQLITE_PRIVATE int sqlite3BtreeIncrVacuum(Btree *p){
  61184. int rc;
  61185. BtShared *pBt = p->pBt;
  61186. sqlite3BtreeEnter(p);
  61187. assert( pBt->inTransaction==TRANS_WRITE && p->inTrans==TRANS_WRITE );
  61188. if( !pBt->autoVacuum ){
  61189. rc = SQLITE_DONE;
  61190. }else{
  61191. Pgno nOrig = btreePagecount(pBt);
  61192. Pgno nFree = get4byte(&pBt->pPage1->aData[36]);
  61193. Pgno nFin = finalDbSize(pBt, nOrig, nFree);
  61194. if( nOrig<nFin ){
  61195. rc = SQLITE_CORRUPT_BKPT;
  61196. }else if( nFree>0 ){
  61197. rc = saveAllCursors(pBt, 0, 0);
  61198. if( rc==SQLITE_OK ){
  61199. invalidateAllOverflowCache(pBt);
  61200. rc = incrVacuumStep(pBt, nFin, nOrig, 0);
  61201. }
  61202. if( rc==SQLITE_OK ){
  61203. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  61204. put4byte(&pBt->pPage1->aData[28], pBt->nPage);
  61205. }
  61206. }else{
  61207. rc = SQLITE_DONE;
  61208. }
  61209. }
  61210. sqlite3BtreeLeave(p);
  61211. return rc;
  61212. }
  61213. /*
  61214. ** This routine is called prior to sqlite3PagerCommit when a transaction
  61215. ** is committed for an auto-vacuum database.
  61216. **
  61217. ** If SQLITE_OK is returned, then *pnTrunc is set to the number of pages
  61218. ** the database file should be truncated to during the commit process.
  61219. ** i.e. the database has been reorganized so that only the first *pnTrunc
  61220. ** pages are in use.
  61221. */
  61222. static int autoVacuumCommit(BtShared *pBt){
  61223. int rc = SQLITE_OK;
  61224. Pager *pPager = pBt->pPager;
  61225. VVA_ONLY( int nRef = sqlite3PagerRefcount(pPager); )
  61226. assert( sqlite3_mutex_held(pBt->mutex) );
  61227. invalidateAllOverflowCache(pBt);
  61228. assert(pBt->autoVacuum);
  61229. if( !pBt->incrVacuum ){
  61230. Pgno nFin; /* Number of pages in database after autovacuuming */
  61231. Pgno nFree; /* Number of pages on the freelist initially */
  61232. Pgno iFree; /* The next page to be freed */
  61233. Pgno nOrig; /* Database size before freeing */
  61234. nOrig = btreePagecount(pBt);
  61235. if( PTRMAP_ISPAGE(pBt, nOrig) || nOrig==PENDING_BYTE_PAGE(pBt) ){
  61236. /* It is not possible to create a database for which the final page
  61237. ** is either a pointer-map page or the pending-byte page. If one
  61238. ** is encountered, this indicates corruption.
  61239. */
  61240. return SQLITE_CORRUPT_BKPT;
  61241. }
  61242. nFree = get4byte(&pBt->pPage1->aData[36]);
  61243. nFin = finalDbSize(pBt, nOrig, nFree);
  61244. if( nFin>nOrig ) return SQLITE_CORRUPT_BKPT;
  61245. if( nFin<nOrig ){
  61246. rc = saveAllCursors(pBt, 0, 0);
  61247. }
  61248. for(iFree=nOrig; iFree>nFin && rc==SQLITE_OK; iFree--){
  61249. rc = incrVacuumStep(pBt, nFin, iFree, 1);
  61250. }
  61251. if( (rc==SQLITE_DONE || rc==SQLITE_OK) && nFree>0 ){
  61252. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  61253. put4byte(&pBt->pPage1->aData[32], 0);
  61254. put4byte(&pBt->pPage1->aData[36], 0);
  61255. put4byte(&pBt->pPage1->aData[28], nFin);
  61256. pBt->bDoTruncate = 1;
  61257. pBt->nPage = nFin;
  61258. }
  61259. if( rc!=SQLITE_OK ){
  61260. sqlite3PagerRollback(pPager);
  61261. }
  61262. }
  61263. assert( nRef>=sqlite3PagerRefcount(pPager) );
  61264. return rc;
  61265. }
  61266. #else /* ifndef SQLITE_OMIT_AUTOVACUUM */
  61267. # define setChildPtrmaps(x) SQLITE_OK
  61268. #endif
  61269. /*
  61270. ** This routine does the first phase of a two-phase commit. This routine
  61271. ** causes a rollback journal to be created (if it does not already exist)
  61272. ** and populated with enough information so that if a power loss occurs
  61273. ** the database can be restored to its original state by playing back
  61274. ** the journal. Then the contents of the journal are flushed out to
  61275. ** the disk. After the journal is safely on oxide, the changes to the
  61276. ** database are written into the database file and flushed to oxide.
  61277. ** At the end of this call, the rollback journal still exists on the
  61278. ** disk and we are still holding all locks, so the transaction has not
  61279. ** committed. See sqlite3BtreeCommitPhaseTwo() for the second phase of the
  61280. ** commit process.
  61281. **
  61282. ** This call is a no-op if no write-transaction is currently active on pBt.
  61283. **
  61284. ** Otherwise, sync the database file for the btree pBt. zMaster points to
  61285. ** the name of a master journal file that should be written into the
  61286. ** individual journal file, or is NULL, indicating no master journal file
  61287. ** (single database transaction).
  61288. **
  61289. ** When this is called, the master journal should already have been
  61290. ** created, populated with this journal pointer and synced to disk.
  61291. **
  61292. ** Once this is routine has returned, the only thing required to commit
  61293. ** the write-transaction for this database file is to delete the journal.
  61294. */
  61295. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseOne(Btree *p, const char *zMaster){
  61296. int rc = SQLITE_OK;
  61297. if( p->inTrans==TRANS_WRITE ){
  61298. BtShared *pBt = p->pBt;
  61299. sqlite3BtreeEnter(p);
  61300. #ifndef SQLITE_OMIT_AUTOVACUUM
  61301. if( pBt->autoVacuum ){
  61302. rc = autoVacuumCommit(pBt);
  61303. if( rc!=SQLITE_OK ){
  61304. sqlite3BtreeLeave(p);
  61305. return rc;
  61306. }
  61307. }
  61308. if( pBt->bDoTruncate ){
  61309. sqlite3PagerTruncateImage(pBt->pPager, pBt->nPage);
  61310. }
  61311. #endif
  61312. rc = sqlite3PagerCommitPhaseOne(pBt->pPager, zMaster, 0);
  61313. sqlite3BtreeLeave(p);
  61314. }
  61315. return rc;
  61316. }
  61317. /*
  61318. ** This function is called from both BtreeCommitPhaseTwo() and BtreeRollback()
  61319. ** at the conclusion of a transaction.
  61320. */
  61321. static void btreeEndTransaction(Btree *p){
  61322. BtShared *pBt = p->pBt;
  61323. sqlite3 *db = p->db;
  61324. assert( sqlite3BtreeHoldsMutex(p) );
  61325. #ifndef SQLITE_OMIT_AUTOVACUUM
  61326. pBt->bDoTruncate = 0;
  61327. #endif
  61328. if( p->inTrans>TRANS_NONE && db->nVdbeRead>1 ){
  61329. /* If there are other active statements that belong to this database
  61330. ** handle, downgrade to a read-only transaction. The other statements
  61331. ** may still be reading from the database. */
  61332. downgradeAllSharedCacheTableLocks(p);
  61333. p->inTrans = TRANS_READ;
  61334. }else{
  61335. /* If the handle had any kind of transaction open, decrement the
  61336. ** transaction count of the shared btree. If the transaction count
  61337. ** reaches 0, set the shared state to TRANS_NONE. The unlockBtreeIfUnused()
  61338. ** call below will unlock the pager. */
  61339. if( p->inTrans!=TRANS_NONE ){
  61340. clearAllSharedCacheTableLocks(p);
  61341. pBt->nTransaction--;
  61342. if( 0==pBt->nTransaction ){
  61343. pBt->inTransaction = TRANS_NONE;
  61344. }
  61345. }
  61346. /* Set the current transaction state to TRANS_NONE and unlock the
  61347. ** pager if this call closed the only read or write transaction. */
  61348. p->inTrans = TRANS_NONE;
  61349. unlockBtreeIfUnused(pBt);
  61350. }
  61351. btreeIntegrity(p);
  61352. }
  61353. /*
  61354. ** Commit the transaction currently in progress.
  61355. **
  61356. ** This routine implements the second phase of a 2-phase commit. The
  61357. ** sqlite3BtreeCommitPhaseOne() routine does the first phase and should
  61358. ** be invoked prior to calling this routine. The sqlite3BtreeCommitPhaseOne()
  61359. ** routine did all the work of writing information out to disk and flushing the
  61360. ** contents so that they are written onto the disk platter. All this
  61361. ** routine has to do is delete or truncate or zero the header in the
  61362. ** the rollback journal (which causes the transaction to commit) and
  61363. ** drop locks.
  61364. **
  61365. ** Normally, if an error occurs while the pager layer is attempting to
  61366. ** finalize the underlying journal file, this function returns an error and
  61367. ** the upper layer will attempt a rollback. However, if the second argument
  61368. ** is non-zero then this b-tree transaction is part of a multi-file
  61369. ** transaction. In this case, the transaction has already been committed
  61370. ** (by deleting a master journal file) and the caller will ignore this
  61371. ** functions return code. So, even if an error occurs in the pager layer,
  61372. ** reset the b-tree objects internal state to indicate that the write
  61373. ** transaction has been closed. This is quite safe, as the pager will have
  61374. ** transitioned to the error state.
  61375. **
  61376. ** This will release the write lock on the database file. If there
  61377. ** are no active cursors, it also releases the read lock.
  61378. */
  61379. SQLITE_PRIVATE int sqlite3BtreeCommitPhaseTwo(Btree *p, int bCleanup){
  61380. if( p->inTrans==TRANS_NONE ) return SQLITE_OK;
  61381. sqlite3BtreeEnter(p);
  61382. btreeIntegrity(p);
  61383. /* If the handle has a write-transaction open, commit the shared-btrees
  61384. ** transaction and set the shared state to TRANS_READ.
  61385. */
  61386. if( p->inTrans==TRANS_WRITE ){
  61387. int rc;
  61388. BtShared *pBt = p->pBt;
  61389. assert( pBt->inTransaction==TRANS_WRITE );
  61390. assert( pBt->nTransaction>0 );
  61391. rc = sqlite3PagerCommitPhaseTwo(pBt->pPager);
  61392. if( rc!=SQLITE_OK && bCleanup==0 ){
  61393. sqlite3BtreeLeave(p);
  61394. return rc;
  61395. }
  61396. p->iDataVersion--; /* Compensate for pPager->iDataVersion++; */
  61397. pBt->inTransaction = TRANS_READ;
  61398. btreeClearHasContent(pBt);
  61399. }
  61400. btreeEndTransaction(p);
  61401. sqlite3BtreeLeave(p);
  61402. return SQLITE_OK;
  61403. }
  61404. /*
  61405. ** Do both phases of a commit.
  61406. */
  61407. SQLITE_PRIVATE int sqlite3BtreeCommit(Btree *p){
  61408. int rc;
  61409. sqlite3BtreeEnter(p);
  61410. rc = sqlite3BtreeCommitPhaseOne(p, 0);
  61411. if( rc==SQLITE_OK ){
  61412. rc = sqlite3BtreeCommitPhaseTwo(p, 0);
  61413. }
  61414. sqlite3BtreeLeave(p);
  61415. return rc;
  61416. }
  61417. /*
  61418. ** This routine sets the state to CURSOR_FAULT and the error
  61419. ** code to errCode for every cursor on any BtShared that pBtree
  61420. ** references. Or if the writeOnly flag is set to 1, then only
  61421. ** trip write cursors and leave read cursors unchanged.
  61422. **
  61423. ** Every cursor is a candidate to be tripped, including cursors
  61424. ** that belong to other database connections that happen to be
  61425. ** sharing the cache with pBtree.
  61426. **
  61427. ** This routine gets called when a rollback occurs. If the writeOnly
  61428. ** flag is true, then only write-cursors need be tripped - read-only
  61429. ** cursors save their current positions so that they may continue
  61430. ** following the rollback. Or, if writeOnly is false, all cursors are
  61431. ** tripped. In general, writeOnly is false if the transaction being
  61432. ** rolled back modified the database schema. In this case b-tree root
  61433. ** pages may be moved or deleted from the database altogether, making
  61434. ** it unsafe for read cursors to continue.
  61435. **
  61436. ** If the writeOnly flag is true and an error is encountered while
  61437. ** saving the current position of a read-only cursor, all cursors,
  61438. ** including all read-cursors are tripped.
  61439. **
  61440. ** SQLITE_OK is returned if successful, or if an error occurs while
  61441. ** saving a cursor position, an SQLite error code.
  61442. */
  61443. SQLITE_PRIVATE int sqlite3BtreeTripAllCursors(Btree *pBtree, int errCode, int writeOnly){
  61444. BtCursor *p;
  61445. int rc = SQLITE_OK;
  61446. assert( (writeOnly==0 || writeOnly==1) && BTCF_WriteFlag==1 );
  61447. if( pBtree ){
  61448. sqlite3BtreeEnter(pBtree);
  61449. for(p=pBtree->pBt->pCursor; p; p=p->pNext){
  61450. if( writeOnly && (p->curFlags & BTCF_WriteFlag)==0 ){
  61451. if( p->eState==CURSOR_VALID || p->eState==CURSOR_SKIPNEXT ){
  61452. rc = saveCursorPosition(p);
  61453. if( rc!=SQLITE_OK ){
  61454. (void)sqlite3BtreeTripAllCursors(pBtree, rc, 0);
  61455. break;
  61456. }
  61457. }
  61458. }else{
  61459. sqlite3BtreeClearCursor(p);
  61460. p->eState = CURSOR_FAULT;
  61461. p->skipNext = errCode;
  61462. }
  61463. btreeReleaseAllCursorPages(p);
  61464. }
  61465. sqlite3BtreeLeave(pBtree);
  61466. }
  61467. return rc;
  61468. }
  61469. /*
  61470. ** Rollback the transaction in progress.
  61471. **
  61472. ** If tripCode is not SQLITE_OK then cursors will be invalidated (tripped).
  61473. ** Only write cursors are tripped if writeOnly is true but all cursors are
  61474. ** tripped if writeOnly is false. Any attempt to use
  61475. ** a tripped cursor will result in an error.
  61476. **
  61477. ** This will release the write lock on the database file. If there
  61478. ** are no active cursors, it also releases the read lock.
  61479. */
  61480. SQLITE_PRIVATE int sqlite3BtreeRollback(Btree *p, int tripCode, int writeOnly){
  61481. int rc;
  61482. BtShared *pBt = p->pBt;
  61483. MemPage *pPage1;
  61484. assert( writeOnly==1 || writeOnly==0 );
  61485. assert( tripCode==SQLITE_ABORT_ROLLBACK || tripCode==SQLITE_OK );
  61486. sqlite3BtreeEnter(p);
  61487. if( tripCode==SQLITE_OK ){
  61488. rc = tripCode = saveAllCursors(pBt, 0, 0);
  61489. if( rc ) writeOnly = 0;
  61490. }else{
  61491. rc = SQLITE_OK;
  61492. }
  61493. if( tripCode ){
  61494. int rc2 = sqlite3BtreeTripAllCursors(p, tripCode, writeOnly);
  61495. assert( rc==SQLITE_OK || (writeOnly==0 && rc2==SQLITE_OK) );
  61496. if( rc2!=SQLITE_OK ) rc = rc2;
  61497. }
  61498. btreeIntegrity(p);
  61499. if( p->inTrans==TRANS_WRITE ){
  61500. int rc2;
  61501. assert( TRANS_WRITE==pBt->inTransaction );
  61502. rc2 = sqlite3PagerRollback(pBt->pPager);
  61503. if( rc2!=SQLITE_OK ){
  61504. rc = rc2;
  61505. }
  61506. /* The rollback may have destroyed the pPage1->aData value. So
  61507. ** call btreeGetPage() on page 1 again to make
  61508. ** sure pPage1->aData is set correctly. */
  61509. if( btreeGetPage(pBt, 1, &pPage1, 0)==SQLITE_OK ){
  61510. int nPage = get4byte(28+(u8*)pPage1->aData);
  61511. testcase( nPage==0 );
  61512. if( nPage==0 ) sqlite3PagerPagecount(pBt->pPager, &nPage);
  61513. testcase( pBt->nPage!=nPage );
  61514. pBt->nPage = nPage;
  61515. releasePageOne(pPage1);
  61516. }
  61517. assert( countValidCursors(pBt, 1)==0 );
  61518. pBt->inTransaction = TRANS_READ;
  61519. btreeClearHasContent(pBt);
  61520. }
  61521. btreeEndTransaction(p);
  61522. sqlite3BtreeLeave(p);
  61523. return rc;
  61524. }
  61525. /*
  61526. ** Start a statement subtransaction. The subtransaction can be rolled
  61527. ** back independently of the main transaction. You must start a transaction
  61528. ** before starting a subtransaction. The subtransaction is ended automatically
  61529. ** if the main transaction commits or rolls back.
  61530. **
  61531. ** Statement subtransactions are used around individual SQL statements
  61532. ** that are contained within a BEGIN...COMMIT block. If a constraint
  61533. ** error occurs within the statement, the effect of that one statement
  61534. ** can be rolled back without having to rollback the entire transaction.
  61535. **
  61536. ** A statement sub-transaction is implemented as an anonymous savepoint. The
  61537. ** value passed as the second parameter is the total number of savepoints,
  61538. ** including the new anonymous savepoint, open on the B-Tree. i.e. if there
  61539. ** are no active savepoints and no other statement-transactions open,
  61540. ** iStatement is 1. This anonymous savepoint can be released or rolled back
  61541. ** using the sqlite3BtreeSavepoint() function.
  61542. */
  61543. SQLITE_PRIVATE int sqlite3BtreeBeginStmt(Btree *p, int iStatement){
  61544. int rc;
  61545. BtShared *pBt = p->pBt;
  61546. sqlite3BtreeEnter(p);
  61547. assert( p->inTrans==TRANS_WRITE );
  61548. assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
  61549. assert( iStatement>0 );
  61550. assert( iStatement>p->db->nSavepoint );
  61551. assert( pBt->inTransaction==TRANS_WRITE );
  61552. /* At the pager level, a statement transaction is a savepoint with
  61553. ** an index greater than all savepoints created explicitly using
  61554. ** SQL statements. It is illegal to open, release or rollback any
  61555. ** such savepoints while the statement transaction savepoint is active.
  61556. */
  61557. rc = sqlite3PagerOpenSavepoint(pBt->pPager, iStatement);
  61558. sqlite3BtreeLeave(p);
  61559. return rc;
  61560. }
  61561. /*
  61562. ** The second argument to this function, op, is always SAVEPOINT_ROLLBACK
  61563. ** or SAVEPOINT_RELEASE. This function either releases or rolls back the
  61564. ** savepoint identified by parameter iSavepoint, depending on the value
  61565. ** of op.
  61566. **
  61567. ** Normally, iSavepoint is greater than or equal to zero. However, if op is
  61568. ** SAVEPOINT_ROLLBACK, then iSavepoint may also be -1. In this case the
  61569. ** contents of the entire transaction are rolled back. This is different
  61570. ** from a normal transaction rollback, as no locks are released and the
  61571. ** transaction remains open.
  61572. */
  61573. SQLITE_PRIVATE int sqlite3BtreeSavepoint(Btree *p, int op, int iSavepoint){
  61574. int rc = SQLITE_OK;
  61575. if( p && p->inTrans==TRANS_WRITE ){
  61576. BtShared *pBt = p->pBt;
  61577. assert( op==SAVEPOINT_RELEASE || op==SAVEPOINT_ROLLBACK );
  61578. assert( iSavepoint>=0 || (iSavepoint==-1 && op==SAVEPOINT_ROLLBACK) );
  61579. sqlite3BtreeEnter(p);
  61580. if( op==SAVEPOINT_ROLLBACK ){
  61581. rc = saveAllCursors(pBt, 0, 0);
  61582. }
  61583. if( rc==SQLITE_OK ){
  61584. rc = sqlite3PagerSavepoint(pBt->pPager, op, iSavepoint);
  61585. }
  61586. if( rc==SQLITE_OK ){
  61587. if( iSavepoint<0 && (pBt->btsFlags & BTS_INITIALLY_EMPTY)!=0 ){
  61588. pBt->nPage = 0;
  61589. }
  61590. rc = newDatabase(pBt);
  61591. pBt->nPage = get4byte(28 + pBt->pPage1->aData);
  61592. /* The database size was written into the offset 28 of the header
  61593. ** when the transaction started, so we know that the value at offset
  61594. ** 28 is nonzero. */
  61595. assert( pBt->nPage>0 );
  61596. }
  61597. sqlite3BtreeLeave(p);
  61598. }
  61599. return rc;
  61600. }
  61601. /*
  61602. ** Create a new cursor for the BTree whose root is on the page
  61603. ** iTable. If a read-only cursor is requested, it is assumed that
  61604. ** the caller already has at least a read-only transaction open
  61605. ** on the database already. If a write-cursor is requested, then
  61606. ** the caller is assumed to have an open write transaction.
  61607. **
  61608. ** If the BTREE_WRCSR bit of wrFlag is clear, then the cursor can only
  61609. ** be used for reading. If the BTREE_WRCSR bit is set, then the cursor
  61610. ** can be used for reading or for writing if other conditions for writing
  61611. ** are also met. These are the conditions that must be met in order
  61612. ** for writing to be allowed:
  61613. **
  61614. ** 1: The cursor must have been opened with wrFlag containing BTREE_WRCSR
  61615. **
  61616. ** 2: Other database connections that share the same pager cache
  61617. ** but which are not in the READ_UNCOMMITTED state may not have
  61618. ** cursors open with wrFlag==0 on the same table. Otherwise
  61619. ** the changes made by this write cursor would be visible to
  61620. ** the read cursors in the other database connection.
  61621. **
  61622. ** 3: The database must be writable (not on read-only media)
  61623. **
  61624. ** 4: There must be an active transaction.
  61625. **
  61626. ** The BTREE_FORDELETE bit of wrFlag may optionally be set if BTREE_WRCSR
  61627. ** is set. If FORDELETE is set, that is a hint to the implementation that
  61628. ** this cursor will only be used to seek to and delete entries of an index
  61629. ** as part of a larger DELETE statement. The FORDELETE hint is not used by
  61630. ** this implementation. But in a hypothetical alternative storage engine
  61631. ** in which index entries are automatically deleted when corresponding table
  61632. ** rows are deleted, the FORDELETE flag is a hint that all SEEK and DELETE
  61633. ** operations on this cursor can be no-ops and all READ operations can
  61634. ** return a null row (2-bytes: 0x01 0x00).
  61635. **
  61636. ** No checking is done to make sure that page iTable really is the
  61637. ** root page of a b-tree. If it is not, then the cursor acquired
  61638. ** will not work correctly.
  61639. **
  61640. ** It is assumed that the sqlite3BtreeCursorZero() has been called
  61641. ** on pCur to initialize the memory space prior to invoking this routine.
  61642. */
  61643. static int btreeCursor(
  61644. Btree *p, /* The btree */
  61645. int iTable, /* Root page of table to open */
  61646. int wrFlag, /* 1 to write. 0 read-only */
  61647. struct KeyInfo *pKeyInfo, /* First arg to comparison function */
  61648. BtCursor *pCur /* Space for new cursor */
  61649. ){
  61650. BtShared *pBt = p->pBt; /* Shared b-tree handle */
  61651. BtCursor *pX; /* Looping over other all cursors */
  61652. assert( sqlite3BtreeHoldsMutex(p) );
  61653. assert( wrFlag==0
  61654. || wrFlag==BTREE_WRCSR
  61655. || wrFlag==(BTREE_WRCSR|BTREE_FORDELETE)
  61656. );
  61657. /* The following assert statements verify that if this is a sharable
  61658. ** b-tree database, the connection is holding the required table locks,
  61659. ** and that no other connection has any open cursor that conflicts with
  61660. ** this lock. */
  61661. assert( hasSharedCacheTableLock(p, iTable, pKeyInfo!=0, (wrFlag?2:1)) );
  61662. assert( wrFlag==0 || !hasReadConflicts(p, iTable) );
  61663. /* Assert that the caller has opened the required transaction. */
  61664. assert( p->inTrans>TRANS_NONE );
  61665. assert( wrFlag==0 || p->inTrans==TRANS_WRITE );
  61666. assert( pBt->pPage1 && pBt->pPage1->aData );
  61667. assert( wrFlag==0 || (pBt->btsFlags & BTS_READ_ONLY)==0 );
  61668. if( wrFlag ){
  61669. allocateTempSpace(pBt);
  61670. if( pBt->pTmpSpace==0 ) return SQLITE_NOMEM_BKPT;
  61671. }
  61672. if( iTable==1 && btreePagecount(pBt)==0 ){
  61673. assert( wrFlag==0 );
  61674. iTable = 0;
  61675. }
  61676. /* Now that no other errors can occur, finish filling in the BtCursor
  61677. ** variables and link the cursor into the BtShared list. */
  61678. pCur->pgnoRoot = (Pgno)iTable;
  61679. pCur->iPage = -1;
  61680. pCur->pKeyInfo = pKeyInfo;
  61681. pCur->pBtree = p;
  61682. pCur->pBt = pBt;
  61683. pCur->curFlags = wrFlag ? BTCF_WriteFlag : 0;
  61684. pCur->curPagerFlags = wrFlag ? 0 : PAGER_GET_READONLY;
  61685. /* If there are two or more cursors on the same btree, then all such
  61686. ** cursors *must* have the BTCF_Multiple flag set. */
  61687. for(pX=pBt->pCursor; pX; pX=pX->pNext){
  61688. if( pX->pgnoRoot==(Pgno)iTable ){
  61689. pX->curFlags |= BTCF_Multiple;
  61690. pCur->curFlags |= BTCF_Multiple;
  61691. }
  61692. }
  61693. pCur->pNext = pBt->pCursor;
  61694. pBt->pCursor = pCur;
  61695. pCur->eState = CURSOR_INVALID;
  61696. return SQLITE_OK;
  61697. }
  61698. SQLITE_PRIVATE int sqlite3BtreeCursor(
  61699. Btree *p, /* The btree */
  61700. int iTable, /* Root page of table to open */
  61701. int wrFlag, /* 1 to write. 0 read-only */
  61702. struct KeyInfo *pKeyInfo, /* First arg to xCompare() */
  61703. BtCursor *pCur /* Write new cursor here */
  61704. ){
  61705. int rc;
  61706. if( iTable<1 ){
  61707. rc = SQLITE_CORRUPT_BKPT;
  61708. }else{
  61709. sqlite3BtreeEnter(p);
  61710. rc = btreeCursor(p, iTable, wrFlag, pKeyInfo, pCur);
  61711. sqlite3BtreeLeave(p);
  61712. }
  61713. return rc;
  61714. }
  61715. /*
  61716. ** Return the size of a BtCursor object in bytes.
  61717. **
  61718. ** This interfaces is needed so that users of cursors can preallocate
  61719. ** sufficient storage to hold a cursor. The BtCursor object is opaque
  61720. ** to users so they cannot do the sizeof() themselves - they must call
  61721. ** this routine.
  61722. */
  61723. SQLITE_PRIVATE int sqlite3BtreeCursorSize(void){
  61724. return ROUND8(sizeof(BtCursor));
  61725. }
  61726. /*
  61727. ** Initialize memory that will be converted into a BtCursor object.
  61728. **
  61729. ** The simple approach here would be to memset() the entire object
  61730. ** to zero. But it turns out that the apPage[] and aiIdx[] arrays
  61731. ** do not need to be zeroed and they are large, so we can save a lot
  61732. ** of run-time by skipping the initialization of those elements.
  61733. */
  61734. SQLITE_PRIVATE void sqlite3BtreeCursorZero(BtCursor *p){
  61735. memset(p, 0, offsetof(BtCursor, BTCURSOR_FIRST_UNINIT));
  61736. }
  61737. /*
  61738. ** Close a cursor. The read lock on the database file is released
  61739. ** when the last cursor is closed.
  61740. */
  61741. SQLITE_PRIVATE int sqlite3BtreeCloseCursor(BtCursor *pCur){
  61742. Btree *pBtree = pCur->pBtree;
  61743. if( pBtree ){
  61744. BtShared *pBt = pCur->pBt;
  61745. sqlite3BtreeEnter(pBtree);
  61746. assert( pBt->pCursor!=0 );
  61747. if( pBt->pCursor==pCur ){
  61748. pBt->pCursor = pCur->pNext;
  61749. }else{
  61750. BtCursor *pPrev = pBt->pCursor;
  61751. do{
  61752. if( pPrev->pNext==pCur ){
  61753. pPrev->pNext = pCur->pNext;
  61754. break;
  61755. }
  61756. pPrev = pPrev->pNext;
  61757. }while( ALWAYS(pPrev) );
  61758. }
  61759. btreeReleaseAllCursorPages(pCur);
  61760. unlockBtreeIfUnused(pBt);
  61761. sqlite3_free(pCur->aOverflow);
  61762. sqlite3_free(pCur->pKey);
  61763. sqlite3BtreeLeave(pBtree);
  61764. }
  61765. return SQLITE_OK;
  61766. }
  61767. /*
  61768. ** Make sure the BtCursor* given in the argument has a valid
  61769. ** BtCursor.info structure. If it is not already valid, call
  61770. ** btreeParseCell() to fill it in.
  61771. **
  61772. ** BtCursor.info is a cache of the information in the current cell.
  61773. ** Using this cache reduces the number of calls to btreeParseCell().
  61774. */
  61775. #ifndef NDEBUG
  61776. static int cellInfoEqual(CellInfo *a, CellInfo *b){
  61777. if( a->nKey!=b->nKey ) return 0;
  61778. if( a->pPayload!=b->pPayload ) return 0;
  61779. if( a->nPayload!=b->nPayload ) return 0;
  61780. if( a->nLocal!=b->nLocal ) return 0;
  61781. if( a->nSize!=b->nSize ) return 0;
  61782. return 1;
  61783. }
  61784. static void assertCellInfo(BtCursor *pCur){
  61785. CellInfo info;
  61786. memset(&info, 0, sizeof(info));
  61787. btreeParseCell(pCur->pPage, pCur->ix, &info);
  61788. assert( CORRUPT_DB || cellInfoEqual(&info, &pCur->info) );
  61789. }
  61790. #else
  61791. #define assertCellInfo(x)
  61792. #endif
  61793. static SQLITE_NOINLINE void getCellInfo(BtCursor *pCur){
  61794. if( pCur->info.nSize==0 ){
  61795. pCur->curFlags |= BTCF_ValidNKey;
  61796. btreeParseCell(pCur->pPage,pCur->ix,&pCur->info);
  61797. }else{
  61798. assertCellInfo(pCur);
  61799. }
  61800. }
  61801. #ifndef NDEBUG /* The next routine used only within assert() statements */
  61802. /*
  61803. ** Return true if the given BtCursor is valid. A valid cursor is one
  61804. ** that is currently pointing to a row in a (non-empty) table.
  61805. ** This is a verification routine is used only within assert() statements.
  61806. */
  61807. SQLITE_PRIVATE int sqlite3BtreeCursorIsValid(BtCursor *pCur){
  61808. return pCur && pCur->eState==CURSOR_VALID;
  61809. }
  61810. #endif /* NDEBUG */
  61811. SQLITE_PRIVATE int sqlite3BtreeCursorIsValidNN(BtCursor *pCur){
  61812. assert( pCur!=0 );
  61813. return pCur->eState==CURSOR_VALID;
  61814. }
  61815. /*
  61816. ** Return the value of the integer key or "rowid" for a table btree.
  61817. ** This routine is only valid for a cursor that is pointing into a
  61818. ** ordinary table btree. If the cursor points to an index btree or
  61819. ** is invalid, the result of this routine is undefined.
  61820. */
  61821. SQLITE_PRIVATE i64 sqlite3BtreeIntegerKey(BtCursor *pCur){
  61822. assert( cursorHoldsMutex(pCur) );
  61823. assert( pCur->eState==CURSOR_VALID );
  61824. assert( pCur->curIntKey );
  61825. getCellInfo(pCur);
  61826. return pCur->info.nKey;
  61827. }
  61828. #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
  61829. /*
  61830. ** Return the offset into the database file for the start of the
  61831. ** payload to which the cursor is pointing.
  61832. */
  61833. SQLITE_PRIVATE i64 sqlite3BtreeOffset(BtCursor *pCur){
  61834. assert( cursorHoldsMutex(pCur) );
  61835. assert( pCur->eState==CURSOR_VALID );
  61836. getCellInfo(pCur);
  61837. return (i64)pCur->pBt->pageSize*((i64)pCur->pPage->pgno - 1) +
  61838. (i64)(pCur->info.pPayload - pCur->pPage->aData);
  61839. }
  61840. #endif /* SQLITE_ENABLE_OFFSET_SQL_FUNC */
  61841. /*
  61842. ** Return the number of bytes of payload for the entry that pCur is
  61843. ** currently pointing to. For table btrees, this will be the amount
  61844. ** of data. For index btrees, this will be the size of the key.
  61845. **
  61846. ** The caller must guarantee that the cursor is pointing to a non-NULL
  61847. ** valid entry. In other words, the calling procedure must guarantee
  61848. ** that the cursor has Cursor.eState==CURSOR_VALID.
  61849. */
  61850. SQLITE_PRIVATE u32 sqlite3BtreePayloadSize(BtCursor *pCur){
  61851. assert( cursorHoldsMutex(pCur) );
  61852. assert( pCur->eState==CURSOR_VALID );
  61853. getCellInfo(pCur);
  61854. return pCur->info.nPayload;
  61855. }
  61856. /*
  61857. ** Given the page number of an overflow page in the database (parameter
  61858. ** ovfl), this function finds the page number of the next page in the
  61859. ** linked list of overflow pages. If possible, it uses the auto-vacuum
  61860. ** pointer-map data instead of reading the content of page ovfl to do so.
  61861. **
  61862. ** If an error occurs an SQLite error code is returned. Otherwise:
  61863. **
  61864. ** The page number of the next overflow page in the linked list is
  61865. ** written to *pPgnoNext. If page ovfl is the last page in its linked
  61866. ** list, *pPgnoNext is set to zero.
  61867. **
  61868. ** If ppPage is not NULL, and a reference to the MemPage object corresponding
  61869. ** to page number pOvfl was obtained, then *ppPage is set to point to that
  61870. ** reference. It is the responsibility of the caller to call releasePage()
  61871. ** on *ppPage to free the reference. In no reference was obtained (because
  61872. ** the pointer-map was used to obtain the value for *pPgnoNext), then
  61873. ** *ppPage is set to zero.
  61874. */
  61875. static int getOverflowPage(
  61876. BtShared *pBt, /* The database file */
  61877. Pgno ovfl, /* Current overflow page number */
  61878. MemPage **ppPage, /* OUT: MemPage handle (may be NULL) */
  61879. Pgno *pPgnoNext /* OUT: Next overflow page number */
  61880. ){
  61881. Pgno next = 0;
  61882. MemPage *pPage = 0;
  61883. int rc = SQLITE_OK;
  61884. assert( sqlite3_mutex_held(pBt->mutex) );
  61885. assert(pPgnoNext);
  61886. #ifndef SQLITE_OMIT_AUTOVACUUM
  61887. /* Try to find the next page in the overflow list using the
  61888. ** autovacuum pointer-map pages. Guess that the next page in
  61889. ** the overflow list is page number (ovfl+1). If that guess turns
  61890. ** out to be wrong, fall back to loading the data of page
  61891. ** number ovfl to determine the next page number.
  61892. */
  61893. if( pBt->autoVacuum ){
  61894. Pgno pgno;
  61895. Pgno iGuess = ovfl+1;
  61896. u8 eType;
  61897. while( PTRMAP_ISPAGE(pBt, iGuess) || iGuess==PENDING_BYTE_PAGE(pBt) ){
  61898. iGuess++;
  61899. }
  61900. if( iGuess<=btreePagecount(pBt) ){
  61901. rc = ptrmapGet(pBt, iGuess, &eType, &pgno);
  61902. if( rc==SQLITE_OK && eType==PTRMAP_OVERFLOW2 && pgno==ovfl ){
  61903. next = iGuess;
  61904. rc = SQLITE_DONE;
  61905. }
  61906. }
  61907. }
  61908. #endif
  61909. assert( next==0 || rc==SQLITE_DONE );
  61910. if( rc==SQLITE_OK ){
  61911. rc = btreeGetPage(pBt, ovfl, &pPage, (ppPage==0) ? PAGER_GET_READONLY : 0);
  61912. assert( rc==SQLITE_OK || pPage==0 );
  61913. if( rc==SQLITE_OK ){
  61914. next = get4byte(pPage->aData);
  61915. }
  61916. }
  61917. *pPgnoNext = next;
  61918. if( ppPage ){
  61919. *ppPage = pPage;
  61920. }else{
  61921. releasePage(pPage);
  61922. }
  61923. return (rc==SQLITE_DONE ? SQLITE_OK : rc);
  61924. }
  61925. /*
  61926. ** Copy data from a buffer to a page, or from a page to a buffer.
  61927. **
  61928. ** pPayload is a pointer to data stored on database page pDbPage.
  61929. ** If argument eOp is false, then nByte bytes of data are copied
  61930. ** from pPayload to the buffer pointed at by pBuf. If eOp is true,
  61931. ** then sqlite3PagerWrite() is called on pDbPage and nByte bytes
  61932. ** of data are copied from the buffer pBuf to pPayload.
  61933. **
  61934. ** SQLITE_OK is returned on success, otherwise an error code.
  61935. */
  61936. static int copyPayload(
  61937. void *pPayload, /* Pointer to page data */
  61938. void *pBuf, /* Pointer to buffer */
  61939. int nByte, /* Number of bytes to copy */
  61940. int eOp, /* 0 -> copy from page, 1 -> copy to page */
  61941. DbPage *pDbPage /* Page containing pPayload */
  61942. ){
  61943. if( eOp ){
  61944. /* Copy data from buffer to page (a write operation) */
  61945. int rc = sqlite3PagerWrite(pDbPage);
  61946. if( rc!=SQLITE_OK ){
  61947. return rc;
  61948. }
  61949. memcpy(pPayload, pBuf, nByte);
  61950. }else{
  61951. /* Copy data from page to buffer (a read operation) */
  61952. memcpy(pBuf, pPayload, nByte);
  61953. }
  61954. return SQLITE_OK;
  61955. }
  61956. /*
  61957. ** This function is used to read or overwrite payload information
  61958. ** for the entry that the pCur cursor is pointing to. The eOp
  61959. ** argument is interpreted as follows:
  61960. **
  61961. ** 0: The operation is a read. Populate the overflow cache.
  61962. ** 1: The operation is a write. Populate the overflow cache.
  61963. **
  61964. ** A total of "amt" bytes are read or written beginning at "offset".
  61965. ** Data is read to or from the buffer pBuf.
  61966. **
  61967. ** The content being read or written might appear on the main page
  61968. ** or be scattered out on multiple overflow pages.
  61969. **
  61970. ** If the current cursor entry uses one or more overflow pages
  61971. ** this function may allocate space for and lazily populate
  61972. ** the overflow page-list cache array (BtCursor.aOverflow).
  61973. ** Subsequent calls use this cache to make seeking to the supplied offset
  61974. ** more efficient.
  61975. **
  61976. ** Once an overflow page-list cache has been allocated, it must be
  61977. ** invalidated if some other cursor writes to the same table, or if
  61978. ** the cursor is moved to a different row. Additionally, in auto-vacuum
  61979. ** mode, the following events may invalidate an overflow page-list cache.
  61980. **
  61981. ** * An incremental vacuum,
  61982. ** * A commit in auto_vacuum="full" mode,
  61983. ** * Creating a table (may require moving an overflow page).
  61984. */
  61985. static int accessPayload(
  61986. BtCursor *pCur, /* Cursor pointing to entry to read from */
  61987. u32 offset, /* Begin reading this far into payload */
  61988. u32 amt, /* Read this many bytes */
  61989. unsigned char *pBuf, /* Write the bytes into this buffer */
  61990. int eOp /* zero to read. non-zero to write. */
  61991. ){
  61992. unsigned char *aPayload;
  61993. int rc = SQLITE_OK;
  61994. int iIdx = 0;
  61995. MemPage *pPage = pCur->pPage; /* Btree page of current entry */
  61996. BtShared *pBt = pCur->pBt; /* Btree this cursor belongs to */
  61997. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  61998. unsigned char * const pBufStart = pBuf; /* Start of original out buffer */
  61999. #endif
  62000. assert( pPage );
  62001. assert( eOp==0 || eOp==1 );
  62002. assert( pCur->eState==CURSOR_VALID );
  62003. assert( pCur->ix<pPage->nCell );
  62004. assert( cursorHoldsMutex(pCur) );
  62005. getCellInfo(pCur);
  62006. aPayload = pCur->info.pPayload;
  62007. assert( offset+amt <= pCur->info.nPayload );
  62008. assert( aPayload > pPage->aData );
  62009. if( (uptr)(aPayload - pPage->aData) > (pBt->usableSize - pCur->info.nLocal) ){
  62010. /* Trying to read or write past the end of the data is an error. The
  62011. ** conditional above is really:
  62012. ** &aPayload[pCur->info.nLocal] > &pPage->aData[pBt->usableSize]
  62013. ** but is recast into its current form to avoid integer overflow problems
  62014. */
  62015. return SQLITE_CORRUPT_PAGE(pPage);
  62016. }
  62017. /* Check if data must be read/written to/from the btree page itself. */
  62018. if( offset<pCur->info.nLocal ){
  62019. int a = amt;
  62020. if( a+offset>pCur->info.nLocal ){
  62021. a = pCur->info.nLocal - offset;
  62022. }
  62023. rc = copyPayload(&aPayload[offset], pBuf, a, eOp, pPage->pDbPage);
  62024. offset = 0;
  62025. pBuf += a;
  62026. amt -= a;
  62027. }else{
  62028. offset -= pCur->info.nLocal;
  62029. }
  62030. if( rc==SQLITE_OK && amt>0 ){
  62031. const u32 ovflSize = pBt->usableSize - 4; /* Bytes content per ovfl page */
  62032. Pgno nextPage;
  62033. nextPage = get4byte(&aPayload[pCur->info.nLocal]);
  62034. /* If the BtCursor.aOverflow[] has not been allocated, allocate it now.
  62035. **
  62036. ** The aOverflow[] array is sized at one entry for each overflow page
  62037. ** in the overflow chain. The page number of the first overflow page is
  62038. ** stored in aOverflow[0], etc. A value of 0 in the aOverflow[] array
  62039. ** means "not yet known" (the cache is lazily populated).
  62040. */
  62041. if( (pCur->curFlags & BTCF_ValidOvfl)==0 ){
  62042. int nOvfl = (pCur->info.nPayload-pCur->info.nLocal+ovflSize-1)/ovflSize;
  62043. if( pCur->aOverflow==0
  62044. || nOvfl*(int)sizeof(Pgno) > sqlite3MallocSize(pCur->aOverflow)
  62045. ){
  62046. Pgno *aNew = (Pgno*)sqlite3Realloc(
  62047. pCur->aOverflow, nOvfl*2*sizeof(Pgno)
  62048. );
  62049. if( aNew==0 ){
  62050. return SQLITE_NOMEM_BKPT;
  62051. }else{
  62052. pCur->aOverflow = aNew;
  62053. }
  62054. }
  62055. memset(pCur->aOverflow, 0, nOvfl*sizeof(Pgno));
  62056. pCur->curFlags |= BTCF_ValidOvfl;
  62057. }else{
  62058. /* If the overflow page-list cache has been allocated and the
  62059. ** entry for the first required overflow page is valid, skip
  62060. ** directly to it.
  62061. */
  62062. if( pCur->aOverflow[offset/ovflSize] ){
  62063. iIdx = (offset/ovflSize);
  62064. nextPage = pCur->aOverflow[iIdx];
  62065. offset = (offset%ovflSize);
  62066. }
  62067. }
  62068. assert( rc==SQLITE_OK && amt>0 );
  62069. while( nextPage ){
  62070. /* If required, populate the overflow page-list cache. */
  62071. assert( pCur->aOverflow[iIdx]==0
  62072. || pCur->aOverflow[iIdx]==nextPage
  62073. || CORRUPT_DB );
  62074. pCur->aOverflow[iIdx] = nextPage;
  62075. if( offset>=ovflSize ){
  62076. /* The only reason to read this page is to obtain the page
  62077. ** number for the next page in the overflow chain. The page
  62078. ** data is not required. So first try to lookup the overflow
  62079. ** page-list cache, if any, then fall back to the getOverflowPage()
  62080. ** function.
  62081. */
  62082. assert( pCur->curFlags & BTCF_ValidOvfl );
  62083. assert( pCur->pBtree->db==pBt->db );
  62084. if( pCur->aOverflow[iIdx+1] ){
  62085. nextPage = pCur->aOverflow[iIdx+1];
  62086. }else{
  62087. rc = getOverflowPage(pBt, nextPage, 0, &nextPage);
  62088. }
  62089. offset -= ovflSize;
  62090. }else{
  62091. /* Need to read this page properly. It contains some of the
  62092. ** range of data that is being read (eOp==0) or written (eOp!=0).
  62093. */
  62094. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  62095. sqlite3_file *fd; /* File from which to do direct overflow read */
  62096. #endif
  62097. int a = amt;
  62098. if( a + offset > ovflSize ){
  62099. a = ovflSize - offset;
  62100. }
  62101. #ifdef SQLITE_DIRECT_OVERFLOW_READ
  62102. /* If all the following are true:
  62103. **
  62104. ** 1) this is a read operation, and
  62105. ** 2) data is required from the start of this overflow page, and
  62106. ** 3) there is no open write-transaction, and
  62107. ** 4) the database is file-backed, and
  62108. ** 5) the page is not in the WAL file
  62109. ** 6) at least 4 bytes have already been read into the output buffer
  62110. **
  62111. ** then data can be read directly from the database file into the
  62112. ** output buffer, bypassing the page-cache altogether. This speeds
  62113. ** up loading large records that span many overflow pages.
  62114. */
  62115. if( eOp==0 /* (1) */
  62116. && offset==0 /* (2) */
  62117. && pBt->inTransaction==TRANS_READ /* (3) */
  62118. && (fd = sqlite3PagerFile(pBt->pPager))->pMethods /* (4) */
  62119. && 0==sqlite3PagerUseWal(pBt->pPager, nextPage) /* (5) */
  62120. && &pBuf[-4]>=pBufStart /* (6) */
  62121. ){
  62122. u8 aSave[4];
  62123. u8 *aWrite = &pBuf[-4];
  62124. assert( aWrite>=pBufStart ); /* due to (6) */
  62125. memcpy(aSave, aWrite, 4);
  62126. rc = sqlite3OsRead(fd, aWrite, a+4, (i64)pBt->pageSize*(nextPage-1));
  62127. nextPage = get4byte(aWrite);
  62128. memcpy(aWrite, aSave, 4);
  62129. }else
  62130. #endif
  62131. {
  62132. DbPage *pDbPage;
  62133. rc = sqlite3PagerGet(pBt->pPager, nextPage, &pDbPage,
  62134. (eOp==0 ? PAGER_GET_READONLY : 0)
  62135. );
  62136. if( rc==SQLITE_OK ){
  62137. aPayload = sqlite3PagerGetData(pDbPage);
  62138. nextPage = get4byte(aPayload);
  62139. rc = copyPayload(&aPayload[offset+4], pBuf, a, eOp, pDbPage);
  62140. sqlite3PagerUnref(pDbPage);
  62141. offset = 0;
  62142. }
  62143. }
  62144. amt -= a;
  62145. if( amt==0 ) return rc;
  62146. pBuf += a;
  62147. }
  62148. if( rc ) break;
  62149. iIdx++;
  62150. }
  62151. }
  62152. if( rc==SQLITE_OK && amt>0 ){
  62153. /* Overflow chain ends prematurely */
  62154. return SQLITE_CORRUPT_PAGE(pPage);
  62155. }
  62156. return rc;
  62157. }
  62158. /*
  62159. ** Read part of the payload for the row at which that cursor pCur is currently
  62160. ** pointing. "amt" bytes will be transferred into pBuf[]. The transfer
  62161. ** begins at "offset".
  62162. **
  62163. ** pCur can be pointing to either a table or an index b-tree.
  62164. ** If pointing to a table btree, then the content section is read. If
  62165. ** pCur is pointing to an index b-tree then the key section is read.
  62166. **
  62167. ** For sqlite3BtreePayload(), the caller must ensure that pCur is pointing
  62168. ** to a valid row in the table. For sqlite3BtreePayloadChecked(), the
  62169. ** cursor might be invalid or might need to be restored before being read.
  62170. **
  62171. ** Return SQLITE_OK on success or an error code if anything goes
  62172. ** wrong. An error is returned if "offset+amt" is larger than
  62173. ** the available payload.
  62174. */
  62175. SQLITE_PRIVATE int sqlite3BtreePayload(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
  62176. assert( cursorHoldsMutex(pCur) );
  62177. assert( pCur->eState==CURSOR_VALID );
  62178. assert( pCur->iPage>=0 && pCur->pPage );
  62179. assert( pCur->ix<pCur->pPage->nCell );
  62180. return accessPayload(pCur, offset, amt, (unsigned char*)pBuf, 0);
  62181. }
  62182. /*
  62183. ** This variant of sqlite3BtreePayload() works even if the cursor has not
  62184. ** in the CURSOR_VALID state. It is only used by the sqlite3_blob_read()
  62185. ** interface.
  62186. */
  62187. #ifndef SQLITE_OMIT_INCRBLOB
  62188. static SQLITE_NOINLINE int accessPayloadChecked(
  62189. BtCursor *pCur,
  62190. u32 offset,
  62191. u32 amt,
  62192. void *pBuf
  62193. ){
  62194. int rc;
  62195. if ( pCur->eState==CURSOR_INVALID ){
  62196. return SQLITE_ABORT;
  62197. }
  62198. assert( cursorOwnsBtShared(pCur) );
  62199. rc = btreeRestoreCursorPosition(pCur);
  62200. return rc ? rc : accessPayload(pCur, offset, amt, pBuf, 0);
  62201. }
  62202. SQLITE_PRIVATE int sqlite3BtreePayloadChecked(BtCursor *pCur, u32 offset, u32 amt, void *pBuf){
  62203. if( pCur->eState==CURSOR_VALID ){
  62204. assert( cursorOwnsBtShared(pCur) );
  62205. return accessPayload(pCur, offset, amt, pBuf, 0);
  62206. }else{
  62207. return accessPayloadChecked(pCur, offset, amt, pBuf);
  62208. }
  62209. }
  62210. #endif /* SQLITE_OMIT_INCRBLOB */
  62211. /*
  62212. ** Return a pointer to payload information from the entry that the
  62213. ** pCur cursor is pointing to. The pointer is to the beginning of
  62214. ** the key if index btrees (pPage->intKey==0) and is the data for
  62215. ** table btrees (pPage->intKey==1). The number of bytes of available
  62216. ** key/data is written into *pAmt. If *pAmt==0, then the value
  62217. ** returned will not be a valid pointer.
  62218. **
  62219. ** This routine is an optimization. It is common for the entire key
  62220. ** and data to fit on the local page and for there to be no overflow
  62221. ** pages. When that is so, this routine can be used to access the
  62222. ** key and data without making a copy. If the key and/or data spills
  62223. ** onto overflow pages, then accessPayload() must be used to reassemble
  62224. ** the key/data and copy it into a preallocated buffer.
  62225. **
  62226. ** The pointer returned by this routine looks directly into the cached
  62227. ** page of the database. The data might change or move the next time
  62228. ** any btree routine is called.
  62229. */
  62230. static const void *fetchPayload(
  62231. BtCursor *pCur, /* Cursor pointing to entry to read from */
  62232. u32 *pAmt /* Write the number of available bytes here */
  62233. ){
  62234. int amt;
  62235. assert( pCur!=0 && pCur->iPage>=0 && pCur->pPage);
  62236. assert( pCur->eState==CURSOR_VALID );
  62237. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  62238. assert( cursorOwnsBtShared(pCur) );
  62239. assert( pCur->ix<pCur->pPage->nCell );
  62240. assert( pCur->info.nSize>0 );
  62241. assert( pCur->info.pPayload>pCur->pPage->aData || CORRUPT_DB );
  62242. assert( pCur->info.pPayload<pCur->pPage->aDataEnd ||CORRUPT_DB);
  62243. amt = pCur->info.nLocal;
  62244. if( amt>(int)(pCur->pPage->aDataEnd - pCur->info.pPayload) ){
  62245. /* There is too little space on the page for the expected amount
  62246. ** of local content. Database must be corrupt. */
  62247. assert( CORRUPT_DB );
  62248. amt = MAX(0, (int)(pCur->pPage->aDataEnd - pCur->info.pPayload));
  62249. }
  62250. *pAmt = (u32)amt;
  62251. return (void*)pCur->info.pPayload;
  62252. }
  62253. /*
  62254. ** For the entry that cursor pCur is point to, return as
  62255. ** many bytes of the key or data as are available on the local
  62256. ** b-tree page. Write the number of available bytes into *pAmt.
  62257. **
  62258. ** The pointer returned is ephemeral. The key/data may move
  62259. ** or be destroyed on the next call to any Btree routine,
  62260. ** including calls from other threads against the same cache.
  62261. ** Hence, a mutex on the BtShared should be held prior to calling
  62262. ** this routine.
  62263. **
  62264. ** These routines is used to get quick access to key and data
  62265. ** in the common case where no overflow pages are used.
  62266. */
  62267. SQLITE_PRIVATE const void *sqlite3BtreePayloadFetch(BtCursor *pCur, u32 *pAmt){
  62268. return fetchPayload(pCur, pAmt);
  62269. }
  62270. /*
  62271. ** Move the cursor down to a new child page. The newPgno argument is the
  62272. ** page number of the child page to move to.
  62273. **
  62274. ** This function returns SQLITE_CORRUPT if the page-header flags field of
  62275. ** the new child page does not match the flags field of the parent (i.e.
  62276. ** if an intkey page appears to be the parent of a non-intkey page, or
  62277. ** vice-versa).
  62278. */
  62279. static int moveToChild(BtCursor *pCur, u32 newPgno){
  62280. BtShared *pBt = pCur->pBt;
  62281. assert( cursorOwnsBtShared(pCur) );
  62282. assert( pCur->eState==CURSOR_VALID );
  62283. assert( pCur->iPage<BTCURSOR_MAX_DEPTH );
  62284. assert( pCur->iPage>=0 );
  62285. if( pCur->iPage>=(BTCURSOR_MAX_DEPTH-1) ){
  62286. return SQLITE_CORRUPT_BKPT;
  62287. }
  62288. pCur->info.nSize = 0;
  62289. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  62290. pCur->aiIdx[pCur->iPage] = pCur->ix;
  62291. pCur->apPage[pCur->iPage] = pCur->pPage;
  62292. pCur->ix = 0;
  62293. pCur->iPage++;
  62294. return getAndInitPage(pBt, newPgno, &pCur->pPage, pCur, pCur->curPagerFlags);
  62295. }
  62296. #ifdef SQLITE_DEBUG
  62297. /*
  62298. ** Page pParent is an internal (non-leaf) tree page. This function
  62299. ** asserts that page number iChild is the left-child if the iIdx'th
  62300. ** cell in page pParent. Or, if iIdx is equal to the total number of
  62301. ** cells in pParent, that page number iChild is the right-child of
  62302. ** the page.
  62303. */
  62304. static void assertParentIndex(MemPage *pParent, int iIdx, Pgno iChild){
  62305. if( CORRUPT_DB ) return; /* The conditions tested below might not be true
  62306. ** in a corrupt database */
  62307. assert( iIdx<=pParent->nCell );
  62308. if( iIdx==pParent->nCell ){
  62309. assert( get4byte(&pParent->aData[pParent->hdrOffset+8])==iChild );
  62310. }else{
  62311. assert( get4byte(findCell(pParent, iIdx))==iChild );
  62312. }
  62313. }
  62314. #else
  62315. # define assertParentIndex(x,y,z)
  62316. #endif
  62317. /*
  62318. ** Move the cursor up to the parent page.
  62319. **
  62320. ** pCur->idx is set to the cell index that contains the pointer
  62321. ** to the page we are coming from. If we are coming from the
  62322. ** right-most child page then pCur->idx is set to one more than
  62323. ** the largest cell index.
  62324. */
  62325. static void moveToParent(BtCursor *pCur){
  62326. MemPage *pLeaf;
  62327. assert( cursorOwnsBtShared(pCur) );
  62328. assert( pCur->eState==CURSOR_VALID );
  62329. assert( pCur->iPage>0 );
  62330. assert( pCur->pPage );
  62331. assertParentIndex(
  62332. pCur->apPage[pCur->iPage-1],
  62333. pCur->aiIdx[pCur->iPage-1],
  62334. pCur->pPage->pgno
  62335. );
  62336. testcase( pCur->aiIdx[pCur->iPage-1] > pCur->apPage[pCur->iPage-1]->nCell );
  62337. pCur->info.nSize = 0;
  62338. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  62339. pCur->ix = pCur->aiIdx[pCur->iPage-1];
  62340. pLeaf = pCur->pPage;
  62341. pCur->pPage = pCur->apPage[--pCur->iPage];
  62342. releasePageNotNull(pLeaf);
  62343. }
  62344. /*
  62345. ** Move the cursor to point to the root page of its b-tree structure.
  62346. **
  62347. ** If the table has a virtual root page, then the cursor is moved to point
  62348. ** to the virtual root page instead of the actual root page. A table has a
  62349. ** virtual root page when the actual root page contains no cells and a
  62350. ** single child page. This can only happen with the table rooted at page 1.
  62351. **
  62352. ** If the b-tree structure is empty, the cursor state is set to
  62353. ** CURSOR_INVALID and this routine returns SQLITE_EMPTY. Otherwise,
  62354. ** the cursor is set to point to the first cell located on the root
  62355. ** (or virtual root) page and the cursor state is set to CURSOR_VALID.
  62356. **
  62357. ** If this function returns successfully, it may be assumed that the
  62358. ** page-header flags indicate that the [virtual] root-page is the expected
  62359. ** kind of b-tree page (i.e. if when opening the cursor the caller did not
  62360. ** specify a KeyInfo structure the flags byte is set to 0x05 or 0x0D,
  62361. ** indicating a table b-tree, or if the caller did specify a KeyInfo
  62362. ** structure the flags byte is set to 0x02 or 0x0A, indicating an index
  62363. ** b-tree).
  62364. */
  62365. static int moveToRoot(BtCursor *pCur){
  62366. MemPage *pRoot;
  62367. int rc = SQLITE_OK;
  62368. assert( cursorOwnsBtShared(pCur) );
  62369. assert( CURSOR_INVALID < CURSOR_REQUIRESEEK );
  62370. assert( CURSOR_VALID < CURSOR_REQUIRESEEK );
  62371. assert( CURSOR_FAULT > CURSOR_REQUIRESEEK );
  62372. assert( pCur->eState < CURSOR_REQUIRESEEK || pCur->iPage<0 );
  62373. assert( pCur->pgnoRoot>0 || pCur->iPage<0 );
  62374. if( pCur->iPage>=0 ){
  62375. if( pCur->iPage ){
  62376. releasePageNotNull(pCur->pPage);
  62377. while( --pCur->iPage ){
  62378. releasePageNotNull(pCur->apPage[pCur->iPage]);
  62379. }
  62380. pCur->pPage = pCur->apPage[0];
  62381. goto skip_init;
  62382. }
  62383. }else if( pCur->pgnoRoot==0 ){
  62384. pCur->eState = CURSOR_INVALID;
  62385. return SQLITE_EMPTY;
  62386. }else{
  62387. assert( pCur->iPage==(-1) );
  62388. if( pCur->eState>=CURSOR_REQUIRESEEK ){
  62389. if( pCur->eState==CURSOR_FAULT ){
  62390. assert( pCur->skipNext!=SQLITE_OK );
  62391. return pCur->skipNext;
  62392. }
  62393. sqlite3BtreeClearCursor(pCur);
  62394. }
  62395. rc = getAndInitPage(pCur->pBtree->pBt, pCur->pgnoRoot, &pCur->pPage,
  62396. 0, pCur->curPagerFlags);
  62397. if( rc!=SQLITE_OK ){
  62398. pCur->eState = CURSOR_INVALID;
  62399. return rc;
  62400. }
  62401. pCur->iPage = 0;
  62402. pCur->curIntKey = pCur->pPage->intKey;
  62403. }
  62404. pRoot = pCur->pPage;
  62405. assert( pRoot->pgno==pCur->pgnoRoot );
  62406. /* If pCur->pKeyInfo is not NULL, then the caller that opened this cursor
  62407. ** expected to open it on an index b-tree. Otherwise, if pKeyInfo is
  62408. ** NULL, the caller expects a table b-tree. If this is not the case,
  62409. ** return an SQLITE_CORRUPT error.
  62410. **
  62411. ** Earlier versions of SQLite assumed that this test could not fail
  62412. ** if the root page was already loaded when this function was called (i.e.
  62413. ** if pCur->iPage>=0). But this is not so if the database is corrupted
  62414. ** in such a way that page pRoot is linked into a second b-tree table
  62415. ** (or the freelist). */
  62416. assert( pRoot->intKey==1 || pRoot->intKey==0 );
  62417. if( pRoot->isInit==0 || (pCur->pKeyInfo==0)!=pRoot->intKey ){
  62418. return SQLITE_CORRUPT_PAGE(pCur->pPage);
  62419. }
  62420. skip_init:
  62421. pCur->ix = 0;
  62422. pCur->info.nSize = 0;
  62423. pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidNKey|BTCF_ValidOvfl);
  62424. pRoot = pCur->pPage;
  62425. if( pRoot->nCell>0 ){
  62426. pCur->eState = CURSOR_VALID;
  62427. }else if( !pRoot->leaf ){
  62428. Pgno subpage;
  62429. if( pRoot->pgno!=1 ) return SQLITE_CORRUPT_BKPT;
  62430. subpage = get4byte(&pRoot->aData[pRoot->hdrOffset+8]);
  62431. pCur->eState = CURSOR_VALID;
  62432. rc = moveToChild(pCur, subpage);
  62433. }else{
  62434. pCur->eState = CURSOR_INVALID;
  62435. rc = SQLITE_EMPTY;
  62436. }
  62437. return rc;
  62438. }
  62439. /*
  62440. ** Move the cursor down to the left-most leaf entry beneath the
  62441. ** entry to which it is currently pointing.
  62442. **
  62443. ** The left-most leaf is the one with the smallest key - the first
  62444. ** in ascending order.
  62445. */
  62446. static int moveToLeftmost(BtCursor *pCur){
  62447. Pgno pgno;
  62448. int rc = SQLITE_OK;
  62449. MemPage *pPage;
  62450. assert( cursorOwnsBtShared(pCur) );
  62451. assert( pCur->eState==CURSOR_VALID );
  62452. while( rc==SQLITE_OK && !(pPage = pCur->pPage)->leaf ){
  62453. assert( pCur->ix<pPage->nCell );
  62454. pgno = get4byte(findCell(pPage, pCur->ix));
  62455. rc = moveToChild(pCur, pgno);
  62456. }
  62457. return rc;
  62458. }
  62459. /*
  62460. ** Move the cursor down to the right-most leaf entry beneath the
  62461. ** page to which it is currently pointing. Notice the difference
  62462. ** between moveToLeftmost() and moveToRightmost(). moveToLeftmost()
  62463. ** finds the left-most entry beneath the *entry* whereas moveToRightmost()
  62464. ** finds the right-most entry beneath the *page*.
  62465. **
  62466. ** The right-most entry is the one with the largest key - the last
  62467. ** key in ascending order.
  62468. */
  62469. static int moveToRightmost(BtCursor *pCur){
  62470. Pgno pgno;
  62471. int rc = SQLITE_OK;
  62472. MemPage *pPage = 0;
  62473. assert( cursorOwnsBtShared(pCur) );
  62474. assert( pCur->eState==CURSOR_VALID );
  62475. while( !(pPage = pCur->pPage)->leaf ){
  62476. pgno = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  62477. pCur->ix = pPage->nCell;
  62478. rc = moveToChild(pCur, pgno);
  62479. if( rc ) return rc;
  62480. }
  62481. pCur->ix = pPage->nCell-1;
  62482. assert( pCur->info.nSize==0 );
  62483. assert( (pCur->curFlags & BTCF_ValidNKey)==0 );
  62484. return SQLITE_OK;
  62485. }
  62486. /* Move the cursor to the first entry in the table. Return SQLITE_OK
  62487. ** on success. Set *pRes to 0 if the cursor actually points to something
  62488. ** or set *pRes to 1 if the table is empty.
  62489. */
  62490. SQLITE_PRIVATE int sqlite3BtreeFirst(BtCursor *pCur, int *pRes){
  62491. int rc;
  62492. assert( cursorOwnsBtShared(pCur) );
  62493. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  62494. rc = moveToRoot(pCur);
  62495. if( rc==SQLITE_OK ){
  62496. assert( pCur->pPage->nCell>0 );
  62497. *pRes = 0;
  62498. rc = moveToLeftmost(pCur);
  62499. }else if( rc==SQLITE_EMPTY ){
  62500. assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
  62501. *pRes = 1;
  62502. rc = SQLITE_OK;
  62503. }
  62504. return rc;
  62505. }
  62506. /* Move the cursor to the last entry in the table. Return SQLITE_OK
  62507. ** on success. Set *pRes to 0 if the cursor actually points to something
  62508. ** or set *pRes to 1 if the table is empty.
  62509. */
  62510. SQLITE_PRIVATE int sqlite3BtreeLast(BtCursor *pCur, int *pRes){
  62511. int rc;
  62512. assert( cursorOwnsBtShared(pCur) );
  62513. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  62514. /* If the cursor already points to the last entry, this is a no-op. */
  62515. if( CURSOR_VALID==pCur->eState && (pCur->curFlags & BTCF_AtLast)!=0 ){
  62516. #ifdef SQLITE_DEBUG
  62517. /* This block serves to assert() that the cursor really does point
  62518. ** to the last entry in the b-tree. */
  62519. int ii;
  62520. for(ii=0; ii<pCur->iPage; ii++){
  62521. assert( pCur->aiIdx[ii]==pCur->apPage[ii]->nCell );
  62522. }
  62523. assert( pCur->ix==pCur->pPage->nCell-1 );
  62524. assert( pCur->pPage->leaf );
  62525. #endif
  62526. return SQLITE_OK;
  62527. }
  62528. rc = moveToRoot(pCur);
  62529. if( rc==SQLITE_OK ){
  62530. assert( pCur->eState==CURSOR_VALID );
  62531. *pRes = 0;
  62532. rc = moveToRightmost(pCur);
  62533. if( rc==SQLITE_OK ){
  62534. pCur->curFlags |= BTCF_AtLast;
  62535. }else{
  62536. pCur->curFlags &= ~BTCF_AtLast;
  62537. }
  62538. }else if( rc==SQLITE_EMPTY ){
  62539. assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
  62540. *pRes = 1;
  62541. rc = SQLITE_OK;
  62542. }
  62543. return rc;
  62544. }
  62545. /* Move the cursor so that it points to an entry near the key
  62546. ** specified by pIdxKey or intKey. Return a success code.
  62547. **
  62548. ** For INTKEY tables, the intKey parameter is used. pIdxKey
  62549. ** must be NULL. For index tables, pIdxKey is used and intKey
  62550. ** is ignored.
  62551. **
  62552. ** If an exact match is not found, then the cursor is always
  62553. ** left pointing at a leaf page which would hold the entry if it
  62554. ** were present. The cursor might point to an entry that comes
  62555. ** before or after the key.
  62556. **
  62557. ** An integer is written into *pRes which is the result of
  62558. ** comparing the key with the entry to which the cursor is
  62559. ** pointing. The meaning of the integer written into
  62560. ** *pRes is as follows:
  62561. **
  62562. ** *pRes<0 The cursor is left pointing at an entry that
  62563. ** is smaller than intKey/pIdxKey or if the table is empty
  62564. ** and the cursor is therefore left point to nothing.
  62565. **
  62566. ** *pRes==0 The cursor is left pointing at an entry that
  62567. ** exactly matches intKey/pIdxKey.
  62568. **
  62569. ** *pRes>0 The cursor is left pointing at an entry that
  62570. ** is larger than intKey/pIdxKey.
  62571. **
  62572. ** For index tables, the pIdxKey->eqSeen field is set to 1 if there
  62573. ** exists an entry in the table that exactly matches pIdxKey.
  62574. */
  62575. SQLITE_PRIVATE int sqlite3BtreeMovetoUnpacked(
  62576. BtCursor *pCur, /* The cursor to be moved */
  62577. UnpackedRecord *pIdxKey, /* Unpacked index key */
  62578. i64 intKey, /* The table key */
  62579. int biasRight, /* If true, bias the search to the high end */
  62580. int *pRes /* Write search results here */
  62581. ){
  62582. int rc;
  62583. RecordCompare xRecordCompare;
  62584. assert( cursorOwnsBtShared(pCur) );
  62585. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  62586. assert( pRes );
  62587. assert( (pIdxKey==0)==(pCur->pKeyInfo==0) );
  62588. assert( pCur->eState!=CURSOR_VALID || (pIdxKey==0)==(pCur->curIntKey!=0) );
  62589. /* If the cursor is already positioned at the point we are trying
  62590. ** to move to, then just return without doing any work */
  62591. if( pIdxKey==0
  62592. && pCur->eState==CURSOR_VALID && (pCur->curFlags & BTCF_ValidNKey)!=0
  62593. ){
  62594. if( pCur->info.nKey==intKey ){
  62595. *pRes = 0;
  62596. return SQLITE_OK;
  62597. }
  62598. if( pCur->info.nKey<intKey ){
  62599. if( (pCur->curFlags & BTCF_AtLast)!=0 ){
  62600. *pRes = -1;
  62601. return SQLITE_OK;
  62602. }
  62603. /* If the requested key is one more than the previous key, then
  62604. ** try to get there using sqlite3BtreeNext() rather than a full
  62605. ** binary search. This is an optimization only. The correct answer
  62606. ** is still obtained without this case, only a little more slowely */
  62607. if( pCur->info.nKey+1==intKey && !pCur->skipNext ){
  62608. *pRes = 0;
  62609. rc = sqlite3BtreeNext(pCur, 0);
  62610. if( rc==SQLITE_OK ){
  62611. getCellInfo(pCur);
  62612. if( pCur->info.nKey==intKey ){
  62613. return SQLITE_OK;
  62614. }
  62615. }else if( rc==SQLITE_DONE ){
  62616. rc = SQLITE_OK;
  62617. }else{
  62618. return rc;
  62619. }
  62620. }
  62621. }
  62622. }
  62623. if( pIdxKey ){
  62624. xRecordCompare = sqlite3VdbeFindCompare(pIdxKey);
  62625. pIdxKey->errCode = 0;
  62626. assert( pIdxKey->default_rc==1
  62627. || pIdxKey->default_rc==0
  62628. || pIdxKey->default_rc==-1
  62629. );
  62630. }else{
  62631. xRecordCompare = 0; /* All keys are integers */
  62632. }
  62633. rc = moveToRoot(pCur);
  62634. if( rc ){
  62635. if( rc==SQLITE_EMPTY ){
  62636. assert( pCur->pgnoRoot==0 || pCur->pPage->nCell==0 );
  62637. *pRes = -1;
  62638. return SQLITE_OK;
  62639. }
  62640. return rc;
  62641. }
  62642. assert( pCur->pPage );
  62643. assert( pCur->pPage->isInit );
  62644. assert( pCur->eState==CURSOR_VALID );
  62645. assert( pCur->pPage->nCell > 0 );
  62646. assert( pCur->iPage==0 || pCur->apPage[0]->intKey==pCur->curIntKey );
  62647. assert( pCur->curIntKey || pIdxKey );
  62648. for(;;){
  62649. int lwr, upr, idx, c;
  62650. Pgno chldPg;
  62651. MemPage *pPage = pCur->pPage;
  62652. u8 *pCell; /* Pointer to current cell in pPage */
  62653. /* pPage->nCell must be greater than zero. If this is the root-page
  62654. ** the cursor would have been INVALID above and this for(;;) loop
  62655. ** not run. If this is not the root-page, then the moveToChild() routine
  62656. ** would have already detected db corruption. Similarly, pPage must
  62657. ** be the right kind (index or table) of b-tree page. Otherwise
  62658. ** a moveToChild() or moveToRoot() call would have detected corruption. */
  62659. assert( pPage->nCell>0 );
  62660. assert( pPage->intKey==(pIdxKey==0) );
  62661. lwr = 0;
  62662. upr = pPage->nCell-1;
  62663. assert( biasRight==0 || biasRight==1 );
  62664. idx = upr>>(1-biasRight); /* idx = biasRight ? upr : (lwr+upr)/2; */
  62665. pCur->ix = (u16)idx;
  62666. if( xRecordCompare==0 ){
  62667. for(;;){
  62668. i64 nCellKey;
  62669. pCell = findCellPastPtr(pPage, idx);
  62670. if( pPage->intKeyLeaf ){
  62671. while( 0x80 <= *(pCell++) ){
  62672. if( pCell>=pPage->aDataEnd ){
  62673. return SQLITE_CORRUPT_PAGE(pPage);
  62674. }
  62675. }
  62676. }
  62677. getVarint(pCell, (u64*)&nCellKey);
  62678. if( nCellKey<intKey ){
  62679. lwr = idx+1;
  62680. if( lwr>upr ){ c = -1; break; }
  62681. }else if( nCellKey>intKey ){
  62682. upr = idx-1;
  62683. if( lwr>upr ){ c = +1; break; }
  62684. }else{
  62685. assert( nCellKey==intKey );
  62686. pCur->ix = (u16)idx;
  62687. if( !pPage->leaf ){
  62688. lwr = idx;
  62689. goto moveto_next_layer;
  62690. }else{
  62691. pCur->curFlags |= BTCF_ValidNKey;
  62692. pCur->info.nKey = nCellKey;
  62693. pCur->info.nSize = 0;
  62694. *pRes = 0;
  62695. return SQLITE_OK;
  62696. }
  62697. }
  62698. assert( lwr+upr>=0 );
  62699. idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2; */
  62700. }
  62701. }else{
  62702. for(;;){
  62703. int nCell; /* Size of the pCell cell in bytes */
  62704. pCell = findCellPastPtr(pPage, idx);
  62705. /* The maximum supported page-size is 65536 bytes. This means that
  62706. ** the maximum number of record bytes stored on an index B-Tree
  62707. ** page is less than 16384 bytes and may be stored as a 2-byte
  62708. ** varint. This information is used to attempt to avoid parsing
  62709. ** the entire cell by checking for the cases where the record is
  62710. ** stored entirely within the b-tree page by inspecting the first
  62711. ** 2 bytes of the cell.
  62712. */
  62713. nCell = pCell[0];
  62714. if( nCell<=pPage->max1bytePayload ){
  62715. /* This branch runs if the record-size field of the cell is a
  62716. ** single byte varint and the record fits entirely on the main
  62717. ** b-tree page. */
  62718. testcase( pCell+nCell+1==pPage->aDataEnd );
  62719. c = xRecordCompare(nCell, (void*)&pCell[1], pIdxKey);
  62720. }else if( !(pCell[1] & 0x80)
  62721. && (nCell = ((nCell&0x7f)<<7) + pCell[1])<=pPage->maxLocal
  62722. ){
  62723. /* The record-size field is a 2 byte varint and the record
  62724. ** fits entirely on the main b-tree page. */
  62725. testcase( pCell+nCell+2==pPage->aDataEnd );
  62726. c = xRecordCompare(nCell, (void*)&pCell[2], pIdxKey);
  62727. }else{
  62728. /* The record flows over onto one or more overflow pages. In
  62729. ** this case the whole cell needs to be parsed, a buffer allocated
  62730. ** and accessPayload() used to retrieve the record into the
  62731. ** buffer before VdbeRecordCompare() can be called.
  62732. **
  62733. ** If the record is corrupt, the xRecordCompare routine may read
  62734. ** up to two varints past the end of the buffer. An extra 18
  62735. ** bytes of padding is allocated at the end of the buffer in
  62736. ** case this happens. */
  62737. void *pCellKey;
  62738. u8 * const pCellBody = pCell - pPage->childPtrSize;
  62739. pPage->xParseCell(pPage, pCellBody, &pCur->info);
  62740. nCell = (int)pCur->info.nKey;
  62741. testcase( nCell<0 ); /* True if key size is 2^32 or more */
  62742. testcase( nCell==0 ); /* Invalid key size: 0x80 0x80 0x00 */
  62743. testcase( nCell==1 ); /* Invalid key size: 0x80 0x80 0x01 */
  62744. testcase( nCell==2 ); /* Minimum legal index key size */
  62745. if( nCell<2 ){
  62746. rc = SQLITE_CORRUPT_PAGE(pPage);
  62747. goto moveto_finish;
  62748. }
  62749. pCellKey = sqlite3Malloc( nCell+18 );
  62750. if( pCellKey==0 ){
  62751. rc = SQLITE_NOMEM_BKPT;
  62752. goto moveto_finish;
  62753. }
  62754. pCur->ix = (u16)idx;
  62755. rc = accessPayload(pCur, 0, nCell, (unsigned char*)pCellKey, 0);
  62756. pCur->curFlags &= ~BTCF_ValidOvfl;
  62757. if( rc ){
  62758. sqlite3_free(pCellKey);
  62759. goto moveto_finish;
  62760. }
  62761. c = xRecordCompare(nCell, pCellKey, pIdxKey);
  62762. sqlite3_free(pCellKey);
  62763. }
  62764. assert(
  62765. (pIdxKey->errCode!=SQLITE_CORRUPT || c==0)
  62766. && (pIdxKey->errCode!=SQLITE_NOMEM || pCur->pBtree->db->mallocFailed)
  62767. );
  62768. if( c<0 ){
  62769. lwr = idx+1;
  62770. }else if( c>0 ){
  62771. upr = idx-1;
  62772. }else{
  62773. assert( c==0 );
  62774. *pRes = 0;
  62775. rc = SQLITE_OK;
  62776. pCur->ix = (u16)idx;
  62777. if( pIdxKey->errCode ) rc = SQLITE_CORRUPT_BKPT;
  62778. goto moveto_finish;
  62779. }
  62780. if( lwr>upr ) break;
  62781. assert( lwr+upr>=0 );
  62782. idx = (lwr+upr)>>1; /* idx = (lwr+upr)/2 */
  62783. }
  62784. }
  62785. assert( lwr==upr+1 || (pPage->intKey && !pPage->leaf) );
  62786. assert( pPage->isInit );
  62787. if( pPage->leaf ){
  62788. assert( pCur->ix<pCur->pPage->nCell );
  62789. pCur->ix = (u16)idx;
  62790. *pRes = c;
  62791. rc = SQLITE_OK;
  62792. goto moveto_finish;
  62793. }
  62794. moveto_next_layer:
  62795. if( lwr>=pPage->nCell ){
  62796. chldPg = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  62797. }else{
  62798. chldPg = get4byte(findCell(pPage, lwr));
  62799. }
  62800. pCur->ix = (u16)lwr;
  62801. rc = moveToChild(pCur, chldPg);
  62802. if( rc ) break;
  62803. }
  62804. moveto_finish:
  62805. pCur->info.nSize = 0;
  62806. assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
  62807. return rc;
  62808. }
  62809. /*
  62810. ** Return TRUE if the cursor is not pointing at an entry of the table.
  62811. **
  62812. ** TRUE will be returned after a call to sqlite3BtreeNext() moves
  62813. ** past the last entry in the table or sqlite3BtreePrev() moves past
  62814. ** the first entry. TRUE is also returned if the table is empty.
  62815. */
  62816. SQLITE_PRIVATE int sqlite3BtreeEof(BtCursor *pCur){
  62817. /* TODO: What if the cursor is in CURSOR_REQUIRESEEK but all table entries
  62818. ** have been deleted? This API will need to change to return an error code
  62819. ** as well as the boolean result value.
  62820. */
  62821. return (CURSOR_VALID!=pCur->eState);
  62822. }
  62823. /*
  62824. ** Return an estimate for the number of rows in the table that pCur is
  62825. ** pointing to. Return a negative number if no estimate is currently
  62826. ** available.
  62827. */
  62828. SQLITE_PRIVATE i64 sqlite3BtreeRowCountEst(BtCursor *pCur){
  62829. i64 n;
  62830. u8 i;
  62831. assert( cursorOwnsBtShared(pCur) );
  62832. assert( sqlite3_mutex_held(pCur->pBtree->db->mutex) );
  62833. /* Currently this interface is only called by the OP_IfSmaller
  62834. ** opcode, and it that case the cursor will always be valid and
  62835. ** will always point to a leaf node. */
  62836. if( NEVER(pCur->eState!=CURSOR_VALID) ) return -1;
  62837. if( NEVER(pCur->pPage->leaf==0) ) return -1;
  62838. n = pCur->pPage->nCell;
  62839. for(i=0; i<pCur->iPage; i++){
  62840. n *= pCur->apPage[i]->nCell;
  62841. }
  62842. return n;
  62843. }
  62844. /*
  62845. ** Advance the cursor to the next entry in the database.
  62846. ** Return value:
  62847. **
  62848. ** SQLITE_OK success
  62849. ** SQLITE_DONE cursor is already pointing at the last element
  62850. ** otherwise some kind of error occurred
  62851. **
  62852. ** The main entry point is sqlite3BtreeNext(). That routine is optimized
  62853. ** for the common case of merely incrementing the cell counter BtCursor.aiIdx
  62854. ** to the next cell on the current page. The (slower) btreeNext() helper
  62855. ** routine is called when it is necessary to move to a different page or
  62856. ** to restore the cursor.
  62857. **
  62858. ** If bit 0x01 of the F argument in sqlite3BtreeNext(C,F) is 1, then the
  62859. ** cursor corresponds to an SQL index and this routine could have been
  62860. ** skipped if the SQL index had been a unique index. The F argument
  62861. ** is a hint to the implement. SQLite btree implementation does not use
  62862. ** this hint, but COMDB2 does.
  62863. */
  62864. static SQLITE_NOINLINE int btreeNext(BtCursor *pCur){
  62865. int rc;
  62866. int idx;
  62867. MemPage *pPage;
  62868. assert( cursorOwnsBtShared(pCur) );
  62869. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  62870. if( pCur->eState!=CURSOR_VALID ){
  62871. assert( (pCur->curFlags & BTCF_ValidOvfl)==0 );
  62872. rc = restoreCursorPosition(pCur);
  62873. if( rc!=SQLITE_OK ){
  62874. return rc;
  62875. }
  62876. if( CURSOR_INVALID==pCur->eState ){
  62877. return SQLITE_DONE;
  62878. }
  62879. if( pCur->skipNext ){
  62880. assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_SKIPNEXT );
  62881. pCur->eState = CURSOR_VALID;
  62882. if( pCur->skipNext>0 ){
  62883. pCur->skipNext = 0;
  62884. return SQLITE_OK;
  62885. }
  62886. pCur->skipNext = 0;
  62887. }
  62888. }
  62889. pPage = pCur->pPage;
  62890. idx = ++pCur->ix;
  62891. assert( pPage->isInit );
  62892. /* If the database file is corrupt, it is possible for the value of idx
  62893. ** to be invalid here. This can only occur if a second cursor modifies
  62894. ** the page while cursor pCur is holding a reference to it. Which can
  62895. ** only happen if the database is corrupt in such a way as to link the
  62896. ** page into more than one b-tree structure. */
  62897. testcase( idx>pPage->nCell );
  62898. if( idx>=pPage->nCell ){
  62899. if( !pPage->leaf ){
  62900. rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
  62901. if( rc ) return rc;
  62902. return moveToLeftmost(pCur);
  62903. }
  62904. do{
  62905. if( pCur->iPage==0 ){
  62906. pCur->eState = CURSOR_INVALID;
  62907. return SQLITE_DONE;
  62908. }
  62909. moveToParent(pCur);
  62910. pPage = pCur->pPage;
  62911. }while( pCur->ix>=pPage->nCell );
  62912. if( pPage->intKey ){
  62913. return sqlite3BtreeNext(pCur, 0);
  62914. }else{
  62915. return SQLITE_OK;
  62916. }
  62917. }
  62918. if( pPage->leaf ){
  62919. return SQLITE_OK;
  62920. }else{
  62921. return moveToLeftmost(pCur);
  62922. }
  62923. }
  62924. SQLITE_PRIVATE int sqlite3BtreeNext(BtCursor *pCur, int flags){
  62925. MemPage *pPage;
  62926. UNUSED_PARAMETER( flags ); /* Used in COMDB2 but not native SQLite */
  62927. assert( cursorOwnsBtShared(pCur) );
  62928. assert( flags==0 || flags==1 );
  62929. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  62930. pCur->info.nSize = 0;
  62931. pCur->curFlags &= ~(BTCF_ValidNKey|BTCF_ValidOvfl);
  62932. if( pCur->eState!=CURSOR_VALID ) return btreeNext(pCur);
  62933. pPage = pCur->pPage;
  62934. if( (++pCur->ix)>=pPage->nCell ){
  62935. pCur->ix--;
  62936. return btreeNext(pCur);
  62937. }
  62938. if( pPage->leaf ){
  62939. return SQLITE_OK;
  62940. }else{
  62941. return moveToLeftmost(pCur);
  62942. }
  62943. }
  62944. /*
  62945. ** Step the cursor to the back to the previous entry in the database.
  62946. ** Return values:
  62947. **
  62948. ** SQLITE_OK success
  62949. ** SQLITE_DONE the cursor is already on the first element of the table
  62950. ** otherwise some kind of error occurred
  62951. **
  62952. ** The main entry point is sqlite3BtreePrevious(). That routine is optimized
  62953. ** for the common case of merely decrementing the cell counter BtCursor.aiIdx
  62954. ** to the previous cell on the current page. The (slower) btreePrevious()
  62955. ** helper routine is called when it is necessary to move to a different page
  62956. ** or to restore the cursor.
  62957. **
  62958. ** If bit 0x01 of the F argument to sqlite3BtreePrevious(C,F) is 1, then
  62959. ** the cursor corresponds to an SQL index and this routine could have been
  62960. ** skipped if the SQL index had been a unique index. The F argument is a
  62961. ** hint to the implement. The native SQLite btree implementation does not
  62962. ** use this hint, but COMDB2 does.
  62963. */
  62964. static SQLITE_NOINLINE int btreePrevious(BtCursor *pCur){
  62965. int rc;
  62966. MemPage *pPage;
  62967. assert( cursorOwnsBtShared(pCur) );
  62968. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  62969. assert( (pCur->curFlags & (BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey))==0 );
  62970. assert( pCur->info.nSize==0 );
  62971. if( pCur->eState!=CURSOR_VALID ){
  62972. rc = restoreCursorPosition(pCur);
  62973. if( rc!=SQLITE_OK ){
  62974. return rc;
  62975. }
  62976. if( CURSOR_INVALID==pCur->eState ){
  62977. return SQLITE_DONE;
  62978. }
  62979. if( pCur->skipNext ){
  62980. assert( pCur->eState==CURSOR_VALID || pCur->eState==CURSOR_SKIPNEXT );
  62981. pCur->eState = CURSOR_VALID;
  62982. if( pCur->skipNext<0 ){
  62983. pCur->skipNext = 0;
  62984. return SQLITE_OK;
  62985. }
  62986. pCur->skipNext = 0;
  62987. }
  62988. }
  62989. pPage = pCur->pPage;
  62990. assert( pPage->isInit );
  62991. if( !pPage->leaf ){
  62992. int idx = pCur->ix;
  62993. rc = moveToChild(pCur, get4byte(findCell(pPage, idx)));
  62994. if( rc ) return rc;
  62995. rc = moveToRightmost(pCur);
  62996. }else{
  62997. while( pCur->ix==0 ){
  62998. if( pCur->iPage==0 ){
  62999. pCur->eState = CURSOR_INVALID;
  63000. return SQLITE_DONE;
  63001. }
  63002. moveToParent(pCur);
  63003. }
  63004. assert( pCur->info.nSize==0 );
  63005. assert( (pCur->curFlags & (BTCF_ValidOvfl))==0 );
  63006. pCur->ix--;
  63007. pPage = pCur->pPage;
  63008. if( pPage->intKey && !pPage->leaf ){
  63009. rc = sqlite3BtreePrevious(pCur, 0);
  63010. }else{
  63011. rc = SQLITE_OK;
  63012. }
  63013. }
  63014. return rc;
  63015. }
  63016. SQLITE_PRIVATE int sqlite3BtreePrevious(BtCursor *pCur, int flags){
  63017. assert( cursorOwnsBtShared(pCur) );
  63018. assert( flags==0 || flags==1 );
  63019. assert( pCur->skipNext==0 || pCur->eState!=CURSOR_VALID );
  63020. UNUSED_PARAMETER( flags ); /* Used in COMDB2 but not native SQLite */
  63021. pCur->curFlags &= ~(BTCF_AtLast|BTCF_ValidOvfl|BTCF_ValidNKey);
  63022. pCur->info.nSize = 0;
  63023. if( pCur->eState!=CURSOR_VALID
  63024. || pCur->ix==0
  63025. || pCur->pPage->leaf==0
  63026. ){
  63027. return btreePrevious(pCur);
  63028. }
  63029. pCur->ix--;
  63030. return SQLITE_OK;
  63031. }
  63032. /*
  63033. ** Allocate a new page from the database file.
  63034. **
  63035. ** The new page is marked as dirty. (In other words, sqlite3PagerWrite()
  63036. ** has already been called on the new page.) The new page has also
  63037. ** been referenced and the calling routine is responsible for calling
  63038. ** sqlite3PagerUnref() on the new page when it is done.
  63039. **
  63040. ** SQLITE_OK is returned on success. Any other return value indicates
  63041. ** an error. *ppPage is set to NULL in the event of an error.
  63042. **
  63043. ** If the "nearby" parameter is not 0, then an effort is made to
  63044. ** locate a page close to the page number "nearby". This can be used in an
  63045. ** attempt to keep related pages close to each other in the database file,
  63046. ** which in turn can make database access faster.
  63047. **
  63048. ** If the eMode parameter is BTALLOC_EXACT and the nearby page exists
  63049. ** anywhere on the free-list, then it is guaranteed to be returned. If
  63050. ** eMode is BTALLOC_LT then the page returned will be less than or equal
  63051. ** to nearby if any such page exists. If eMode is BTALLOC_ANY then there
  63052. ** are no restrictions on which page is returned.
  63053. */
  63054. static int allocateBtreePage(
  63055. BtShared *pBt, /* The btree */
  63056. MemPage **ppPage, /* Store pointer to the allocated page here */
  63057. Pgno *pPgno, /* Store the page number here */
  63058. Pgno nearby, /* Search for a page near this one */
  63059. u8 eMode /* BTALLOC_EXACT, BTALLOC_LT, or BTALLOC_ANY */
  63060. ){
  63061. MemPage *pPage1;
  63062. int rc;
  63063. u32 n; /* Number of pages on the freelist */
  63064. u32 k; /* Number of leaves on the trunk of the freelist */
  63065. MemPage *pTrunk = 0;
  63066. MemPage *pPrevTrunk = 0;
  63067. Pgno mxPage; /* Total size of the database file */
  63068. assert( sqlite3_mutex_held(pBt->mutex) );
  63069. assert( eMode==BTALLOC_ANY || (nearby>0 && IfNotOmitAV(pBt->autoVacuum)) );
  63070. pPage1 = pBt->pPage1;
  63071. mxPage = btreePagecount(pBt);
  63072. /* EVIDENCE-OF: R-05119-02637 The 4-byte big-endian integer at offset 36
  63073. ** stores stores the total number of pages on the freelist. */
  63074. n = get4byte(&pPage1->aData[36]);
  63075. testcase( n==mxPage-1 );
  63076. if( n>=mxPage ){
  63077. return SQLITE_CORRUPT_BKPT;
  63078. }
  63079. if( n>0 ){
  63080. /* There are pages on the freelist. Reuse one of those pages. */
  63081. Pgno iTrunk;
  63082. u8 searchList = 0; /* If the free-list must be searched for 'nearby' */
  63083. u32 nSearch = 0; /* Count of the number of search attempts */
  63084. /* If eMode==BTALLOC_EXACT and a query of the pointer-map
  63085. ** shows that the page 'nearby' is somewhere on the free-list, then
  63086. ** the entire-list will be searched for that page.
  63087. */
  63088. #ifndef SQLITE_OMIT_AUTOVACUUM
  63089. if( eMode==BTALLOC_EXACT ){
  63090. if( nearby<=mxPage ){
  63091. u8 eType;
  63092. assert( nearby>0 );
  63093. assert( pBt->autoVacuum );
  63094. rc = ptrmapGet(pBt, nearby, &eType, 0);
  63095. if( rc ) return rc;
  63096. if( eType==PTRMAP_FREEPAGE ){
  63097. searchList = 1;
  63098. }
  63099. }
  63100. }else if( eMode==BTALLOC_LE ){
  63101. searchList = 1;
  63102. }
  63103. #endif
  63104. /* Decrement the free-list count by 1. Set iTrunk to the index of the
  63105. ** first free-list trunk page. iPrevTrunk is initially 1.
  63106. */
  63107. rc = sqlite3PagerWrite(pPage1->pDbPage);
  63108. if( rc ) return rc;
  63109. put4byte(&pPage1->aData[36], n-1);
  63110. /* The code within this loop is run only once if the 'searchList' variable
  63111. ** is not true. Otherwise, it runs once for each trunk-page on the
  63112. ** free-list until the page 'nearby' is located (eMode==BTALLOC_EXACT)
  63113. ** or until a page less than 'nearby' is located (eMode==BTALLOC_LT)
  63114. */
  63115. do {
  63116. pPrevTrunk = pTrunk;
  63117. if( pPrevTrunk ){
  63118. /* EVIDENCE-OF: R-01506-11053 The first integer on a freelist trunk page
  63119. ** is the page number of the next freelist trunk page in the list or
  63120. ** zero if this is the last freelist trunk page. */
  63121. iTrunk = get4byte(&pPrevTrunk->aData[0]);
  63122. }else{
  63123. /* EVIDENCE-OF: R-59841-13798 The 4-byte big-endian integer at offset 32
  63124. ** stores the page number of the first page of the freelist, or zero if
  63125. ** the freelist is empty. */
  63126. iTrunk = get4byte(&pPage1->aData[32]);
  63127. }
  63128. testcase( iTrunk==mxPage );
  63129. if( iTrunk>mxPage || nSearch++ > n ){
  63130. rc = SQLITE_CORRUPT_PGNO(pPrevTrunk ? pPrevTrunk->pgno : 1);
  63131. }else{
  63132. rc = btreeGetUnusedPage(pBt, iTrunk, &pTrunk, 0);
  63133. }
  63134. if( rc ){
  63135. pTrunk = 0;
  63136. goto end_allocate_page;
  63137. }
  63138. assert( pTrunk!=0 );
  63139. assert( pTrunk->aData!=0 );
  63140. /* EVIDENCE-OF: R-13523-04394 The second integer on a freelist trunk page
  63141. ** is the number of leaf page pointers to follow. */
  63142. k = get4byte(&pTrunk->aData[4]);
  63143. if( k==0 && !searchList ){
  63144. /* The trunk has no leaves and the list is not being searched.
  63145. ** So extract the trunk page itself and use it as the newly
  63146. ** allocated page */
  63147. assert( pPrevTrunk==0 );
  63148. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  63149. if( rc ){
  63150. goto end_allocate_page;
  63151. }
  63152. *pPgno = iTrunk;
  63153. memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
  63154. *ppPage = pTrunk;
  63155. pTrunk = 0;
  63156. TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
  63157. }else if( k>(u32)(pBt->usableSize/4 - 2) ){
  63158. /* Value of k is out of range. Database corruption */
  63159. rc = SQLITE_CORRUPT_PGNO(iTrunk);
  63160. goto end_allocate_page;
  63161. #ifndef SQLITE_OMIT_AUTOVACUUM
  63162. }else if( searchList
  63163. && (nearby==iTrunk || (iTrunk<nearby && eMode==BTALLOC_LE))
  63164. ){
  63165. /* The list is being searched and this trunk page is the page
  63166. ** to allocate, regardless of whether it has leaves.
  63167. */
  63168. *pPgno = iTrunk;
  63169. *ppPage = pTrunk;
  63170. searchList = 0;
  63171. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  63172. if( rc ){
  63173. goto end_allocate_page;
  63174. }
  63175. if( k==0 ){
  63176. if( !pPrevTrunk ){
  63177. memcpy(&pPage1->aData[32], &pTrunk->aData[0], 4);
  63178. }else{
  63179. rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
  63180. if( rc!=SQLITE_OK ){
  63181. goto end_allocate_page;
  63182. }
  63183. memcpy(&pPrevTrunk->aData[0], &pTrunk->aData[0], 4);
  63184. }
  63185. }else{
  63186. /* The trunk page is required by the caller but it contains
  63187. ** pointers to free-list leaves. The first leaf becomes a trunk
  63188. ** page in this case.
  63189. */
  63190. MemPage *pNewTrunk;
  63191. Pgno iNewTrunk = get4byte(&pTrunk->aData[8]);
  63192. if( iNewTrunk>mxPage ){
  63193. rc = SQLITE_CORRUPT_PGNO(iTrunk);
  63194. goto end_allocate_page;
  63195. }
  63196. testcase( iNewTrunk==mxPage );
  63197. rc = btreeGetUnusedPage(pBt, iNewTrunk, &pNewTrunk, 0);
  63198. if( rc!=SQLITE_OK ){
  63199. goto end_allocate_page;
  63200. }
  63201. rc = sqlite3PagerWrite(pNewTrunk->pDbPage);
  63202. if( rc!=SQLITE_OK ){
  63203. releasePage(pNewTrunk);
  63204. goto end_allocate_page;
  63205. }
  63206. memcpy(&pNewTrunk->aData[0], &pTrunk->aData[0], 4);
  63207. put4byte(&pNewTrunk->aData[4], k-1);
  63208. memcpy(&pNewTrunk->aData[8], &pTrunk->aData[12], (k-1)*4);
  63209. releasePage(pNewTrunk);
  63210. if( !pPrevTrunk ){
  63211. assert( sqlite3PagerIswriteable(pPage1->pDbPage) );
  63212. put4byte(&pPage1->aData[32], iNewTrunk);
  63213. }else{
  63214. rc = sqlite3PagerWrite(pPrevTrunk->pDbPage);
  63215. if( rc ){
  63216. goto end_allocate_page;
  63217. }
  63218. put4byte(&pPrevTrunk->aData[0], iNewTrunk);
  63219. }
  63220. }
  63221. pTrunk = 0;
  63222. TRACE(("ALLOCATE: %d trunk - %d free pages left\n", *pPgno, n-1));
  63223. #endif
  63224. }else if( k>0 ){
  63225. /* Extract a leaf from the trunk */
  63226. u32 closest;
  63227. Pgno iPage;
  63228. unsigned char *aData = pTrunk->aData;
  63229. if( nearby>0 ){
  63230. u32 i;
  63231. closest = 0;
  63232. if( eMode==BTALLOC_LE ){
  63233. for(i=0; i<k; i++){
  63234. iPage = get4byte(&aData[8+i*4]);
  63235. if( iPage<=nearby ){
  63236. closest = i;
  63237. break;
  63238. }
  63239. }
  63240. }else{
  63241. int dist;
  63242. dist = sqlite3AbsInt32(get4byte(&aData[8]) - nearby);
  63243. for(i=1; i<k; i++){
  63244. int d2 = sqlite3AbsInt32(get4byte(&aData[8+i*4]) - nearby);
  63245. if( d2<dist ){
  63246. closest = i;
  63247. dist = d2;
  63248. }
  63249. }
  63250. }
  63251. }else{
  63252. closest = 0;
  63253. }
  63254. iPage = get4byte(&aData[8+closest*4]);
  63255. testcase( iPage==mxPage );
  63256. if( iPage>mxPage ){
  63257. rc = SQLITE_CORRUPT_PGNO(iTrunk);
  63258. goto end_allocate_page;
  63259. }
  63260. testcase( iPage==mxPage );
  63261. if( !searchList
  63262. || (iPage==nearby || (iPage<nearby && eMode==BTALLOC_LE))
  63263. ){
  63264. int noContent;
  63265. *pPgno = iPage;
  63266. TRACE(("ALLOCATE: %d was leaf %d of %d on trunk %d"
  63267. ": %d more free pages\n",
  63268. *pPgno, closest+1, k, pTrunk->pgno, n-1));
  63269. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  63270. if( rc ) goto end_allocate_page;
  63271. if( closest<k-1 ){
  63272. memcpy(&aData[8+closest*4], &aData[4+k*4], 4);
  63273. }
  63274. put4byte(&aData[4], k-1);
  63275. noContent = !btreeGetHasContent(pBt, *pPgno)? PAGER_GET_NOCONTENT : 0;
  63276. rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, noContent);
  63277. if( rc==SQLITE_OK ){
  63278. rc = sqlite3PagerWrite((*ppPage)->pDbPage);
  63279. if( rc!=SQLITE_OK ){
  63280. releasePage(*ppPage);
  63281. *ppPage = 0;
  63282. }
  63283. }
  63284. searchList = 0;
  63285. }
  63286. }
  63287. releasePage(pPrevTrunk);
  63288. pPrevTrunk = 0;
  63289. }while( searchList );
  63290. }else{
  63291. /* There are no pages on the freelist, so append a new page to the
  63292. ** database image.
  63293. **
  63294. ** Normally, new pages allocated by this block can be requested from the
  63295. ** pager layer with the 'no-content' flag set. This prevents the pager
  63296. ** from trying to read the pages content from disk. However, if the
  63297. ** current transaction has already run one or more incremental-vacuum
  63298. ** steps, then the page we are about to allocate may contain content
  63299. ** that is required in the event of a rollback. In this case, do
  63300. ** not set the no-content flag. This causes the pager to load and journal
  63301. ** the current page content before overwriting it.
  63302. **
  63303. ** Note that the pager will not actually attempt to load or journal
  63304. ** content for any page that really does lie past the end of the database
  63305. ** file on disk. So the effects of disabling the no-content optimization
  63306. ** here are confined to those pages that lie between the end of the
  63307. ** database image and the end of the database file.
  63308. */
  63309. int bNoContent = (0==IfNotOmitAV(pBt->bDoTruncate))? PAGER_GET_NOCONTENT:0;
  63310. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  63311. if( rc ) return rc;
  63312. pBt->nPage++;
  63313. if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ) pBt->nPage++;
  63314. #ifndef SQLITE_OMIT_AUTOVACUUM
  63315. if( pBt->autoVacuum && PTRMAP_ISPAGE(pBt, pBt->nPage) ){
  63316. /* If *pPgno refers to a pointer-map page, allocate two new pages
  63317. ** at the end of the file instead of one. The first allocated page
  63318. ** becomes a new pointer-map page, the second is used by the caller.
  63319. */
  63320. MemPage *pPg = 0;
  63321. TRACE(("ALLOCATE: %d from end of file (pointer-map page)\n", pBt->nPage));
  63322. assert( pBt->nPage!=PENDING_BYTE_PAGE(pBt) );
  63323. rc = btreeGetUnusedPage(pBt, pBt->nPage, &pPg, bNoContent);
  63324. if( rc==SQLITE_OK ){
  63325. rc = sqlite3PagerWrite(pPg->pDbPage);
  63326. releasePage(pPg);
  63327. }
  63328. if( rc ) return rc;
  63329. pBt->nPage++;
  63330. if( pBt->nPage==PENDING_BYTE_PAGE(pBt) ){ pBt->nPage++; }
  63331. }
  63332. #endif
  63333. put4byte(28 + (u8*)pBt->pPage1->aData, pBt->nPage);
  63334. *pPgno = pBt->nPage;
  63335. assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
  63336. rc = btreeGetUnusedPage(pBt, *pPgno, ppPage, bNoContent);
  63337. if( rc ) return rc;
  63338. rc = sqlite3PagerWrite((*ppPage)->pDbPage);
  63339. if( rc!=SQLITE_OK ){
  63340. releasePage(*ppPage);
  63341. *ppPage = 0;
  63342. }
  63343. TRACE(("ALLOCATE: %d from end of file\n", *pPgno));
  63344. }
  63345. assert( *pPgno!=PENDING_BYTE_PAGE(pBt) );
  63346. end_allocate_page:
  63347. releasePage(pTrunk);
  63348. releasePage(pPrevTrunk);
  63349. assert( rc!=SQLITE_OK || sqlite3PagerPageRefcount((*ppPage)->pDbPage)<=1 );
  63350. assert( rc!=SQLITE_OK || (*ppPage)->isInit==0 );
  63351. return rc;
  63352. }
  63353. /*
  63354. ** This function is used to add page iPage to the database file free-list.
  63355. ** It is assumed that the page is not already a part of the free-list.
  63356. **
  63357. ** The value passed as the second argument to this function is optional.
  63358. ** If the caller happens to have a pointer to the MemPage object
  63359. ** corresponding to page iPage handy, it may pass it as the second value.
  63360. ** Otherwise, it may pass NULL.
  63361. **
  63362. ** If a pointer to a MemPage object is passed as the second argument,
  63363. ** its reference count is not altered by this function.
  63364. */
  63365. static int freePage2(BtShared *pBt, MemPage *pMemPage, Pgno iPage){
  63366. MemPage *pTrunk = 0; /* Free-list trunk page */
  63367. Pgno iTrunk = 0; /* Page number of free-list trunk page */
  63368. MemPage *pPage1 = pBt->pPage1; /* Local reference to page 1 */
  63369. MemPage *pPage; /* Page being freed. May be NULL. */
  63370. int rc; /* Return Code */
  63371. int nFree; /* Initial number of pages on free-list */
  63372. assert( sqlite3_mutex_held(pBt->mutex) );
  63373. assert( CORRUPT_DB || iPage>1 );
  63374. assert( !pMemPage || pMemPage->pgno==iPage );
  63375. if( iPage<2 ) return SQLITE_CORRUPT_BKPT;
  63376. if( pMemPage ){
  63377. pPage = pMemPage;
  63378. sqlite3PagerRef(pPage->pDbPage);
  63379. }else{
  63380. pPage = btreePageLookup(pBt, iPage);
  63381. }
  63382. /* Increment the free page count on pPage1 */
  63383. rc = sqlite3PagerWrite(pPage1->pDbPage);
  63384. if( rc ) goto freepage_out;
  63385. nFree = get4byte(&pPage1->aData[36]);
  63386. put4byte(&pPage1->aData[36], nFree+1);
  63387. if( pBt->btsFlags & BTS_SECURE_DELETE ){
  63388. /* If the secure_delete option is enabled, then
  63389. ** always fully overwrite deleted information with zeros.
  63390. */
  63391. if( (!pPage && ((rc = btreeGetPage(pBt, iPage, &pPage, 0))!=0) )
  63392. || ((rc = sqlite3PagerWrite(pPage->pDbPage))!=0)
  63393. ){
  63394. goto freepage_out;
  63395. }
  63396. memset(pPage->aData, 0, pPage->pBt->pageSize);
  63397. }
  63398. /* If the database supports auto-vacuum, write an entry in the pointer-map
  63399. ** to indicate that the page is free.
  63400. */
  63401. if( ISAUTOVACUUM ){
  63402. ptrmapPut(pBt, iPage, PTRMAP_FREEPAGE, 0, &rc);
  63403. if( rc ) goto freepage_out;
  63404. }
  63405. /* Now manipulate the actual database free-list structure. There are two
  63406. ** possibilities. If the free-list is currently empty, or if the first
  63407. ** trunk page in the free-list is full, then this page will become a
  63408. ** new free-list trunk page. Otherwise, it will become a leaf of the
  63409. ** first trunk page in the current free-list. This block tests if it
  63410. ** is possible to add the page as a new free-list leaf.
  63411. */
  63412. if( nFree!=0 ){
  63413. u32 nLeaf; /* Initial number of leaf cells on trunk page */
  63414. iTrunk = get4byte(&pPage1->aData[32]);
  63415. rc = btreeGetPage(pBt, iTrunk, &pTrunk, 0);
  63416. if( rc!=SQLITE_OK ){
  63417. goto freepage_out;
  63418. }
  63419. nLeaf = get4byte(&pTrunk->aData[4]);
  63420. assert( pBt->usableSize>32 );
  63421. if( nLeaf > (u32)pBt->usableSize/4 - 2 ){
  63422. rc = SQLITE_CORRUPT_BKPT;
  63423. goto freepage_out;
  63424. }
  63425. if( nLeaf < (u32)pBt->usableSize/4 - 8 ){
  63426. /* In this case there is room on the trunk page to insert the page
  63427. ** being freed as a new leaf.
  63428. **
  63429. ** Note that the trunk page is not really full until it contains
  63430. ** usableSize/4 - 2 entries, not usableSize/4 - 8 entries as we have
  63431. ** coded. But due to a coding error in versions of SQLite prior to
  63432. ** 3.6.0, databases with freelist trunk pages holding more than
  63433. ** usableSize/4 - 8 entries will be reported as corrupt. In order
  63434. ** to maintain backwards compatibility with older versions of SQLite,
  63435. ** we will continue to restrict the number of entries to usableSize/4 - 8
  63436. ** for now. At some point in the future (once everyone has upgraded
  63437. ** to 3.6.0 or later) we should consider fixing the conditional above
  63438. ** to read "usableSize/4-2" instead of "usableSize/4-8".
  63439. **
  63440. ** EVIDENCE-OF: R-19920-11576 However, newer versions of SQLite still
  63441. ** avoid using the last six entries in the freelist trunk page array in
  63442. ** order that database files created by newer versions of SQLite can be
  63443. ** read by older versions of SQLite.
  63444. */
  63445. rc = sqlite3PagerWrite(pTrunk->pDbPage);
  63446. if( rc==SQLITE_OK ){
  63447. put4byte(&pTrunk->aData[4], nLeaf+1);
  63448. put4byte(&pTrunk->aData[8+nLeaf*4], iPage);
  63449. if( pPage && (pBt->btsFlags & BTS_SECURE_DELETE)==0 ){
  63450. sqlite3PagerDontWrite(pPage->pDbPage);
  63451. }
  63452. rc = btreeSetHasContent(pBt, iPage);
  63453. }
  63454. TRACE(("FREE-PAGE: %d leaf on trunk page %d\n",pPage->pgno,pTrunk->pgno));
  63455. goto freepage_out;
  63456. }
  63457. }
  63458. /* If control flows to this point, then it was not possible to add the
  63459. ** the page being freed as a leaf page of the first trunk in the free-list.
  63460. ** Possibly because the free-list is empty, or possibly because the
  63461. ** first trunk in the free-list is full. Either way, the page being freed
  63462. ** will become the new first trunk page in the free-list.
  63463. */
  63464. if( pPage==0 && SQLITE_OK!=(rc = btreeGetPage(pBt, iPage, &pPage, 0)) ){
  63465. goto freepage_out;
  63466. }
  63467. rc = sqlite3PagerWrite(pPage->pDbPage);
  63468. if( rc!=SQLITE_OK ){
  63469. goto freepage_out;
  63470. }
  63471. put4byte(pPage->aData, iTrunk);
  63472. put4byte(&pPage->aData[4], 0);
  63473. put4byte(&pPage1->aData[32], iPage);
  63474. TRACE(("FREE-PAGE: %d new trunk page replacing %d\n", pPage->pgno, iTrunk));
  63475. freepage_out:
  63476. if( pPage ){
  63477. pPage->isInit = 0;
  63478. }
  63479. releasePage(pPage);
  63480. releasePage(pTrunk);
  63481. return rc;
  63482. }
  63483. static void freePage(MemPage *pPage, int *pRC){
  63484. if( (*pRC)==SQLITE_OK ){
  63485. *pRC = freePage2(pPage->pBt, pPage, pPage->pgno);
  63486. }
  63487. }
  63488. /*
  63489. ** Free any overflow pages associated with the given Cell. Store
  63490. ** size information about the cell in pInfo.
  63491. */
  63492. static int clearCell(
  63493. MemPage *pPage, /* The page that contains the Cell */
  63494. unsigned char *pCell, /* First byte of the Cell */
  63495. CellInfo *pInfo /* Size information about the cell */
  63496. ){
  63497. BtShared *pBt;
  63498. Pgno ovflPgno;
  63499. int rc;
  63500. int nOvfl;
  63501. u32 ovflPageSize;
  63502. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  63503. pPage->xParseCell(pPage, pCell, pInfo);
  63504. if( pInfo->nLocal==pInfo->nPayload ){
  63505. return SQLITE_OK; /* No overflow pages. Return without doing anything */
  63506. }
  63507. if( pCell+pInfo->nSize-1 > pPage->aData+pPage->maskPage ){
  63508. /* Cell extends past end of page */
  63509. return SQLITE_CORRUPT_PAGE(pPage);
  63510. }
  63511. ovflPgno = get4byte(pCell + pInfo->nSize - 4);
  63512. pBt = pPage->pBt;
  63513. assert( pBt->usableSize > 4 );
  63514. ovflPageSize = pBt->usableSize - 4;
  63515. nOvfl = (pInfo->nPayload - pInfo->nLocal + ovflPageSize - 1)/ovflPageSize;
  63516. assert( nOvfl>0 ||
  63517. (CORRUPT_DB && (pInfo->nPayload + ovflPageSize)<ovflPageSize)
  63518. );
  63519. while( nOvfl-- ){
  63520. Pgno iNext = 0;
  63521. MemPage *pOvfl = 0;
  63522. if( ovflPgno<2 || ovflPgno>btreePagecount(pBt) ){
  63523. /* 0 is not a legal page number and page 1 cannot be an
  63524. ** overflow page. Therefore if ovflPgno<2 or past the end of the
  63525. ** file the database must be corrupt. */
  63526. return SQLITE_CORRUPT_BKPT;
  63527. }
  63528. if( nOvfl ){
  63529. rc = getOverflowPage(pBt, ovflPgno, &pOvfl, &iNext);
  63530. if( rc ) return rc;
  63531. }
  63532. if( ( pOvfl || ((pOvfl = btreePageLookup(pBt, ovflPgno))!=0) )
  63533. && sqlite3PagerPageRefcount(pOvfl->pDbPage)!=1
  63534. ){
  63535. /* There is no reason any cursor should have an outstanding reference
  63536. ** to an overflow page belonging to a cell that is being deleted/updated.
  63537. ** So if there exists more than one reference to this page, then it
  63538. ** must not really be an overflow page and the database must be corrupt.
  63539. ** It is helpful to detect this before calling freePage2(), as
  63540. ** freePage2() may zero the page contents if secure-delete mode is
  63541. ** enabled. If this 'overflow' page happens to be a page that the
  63542. ** caller is iterating through or using in some other way, this
  63543. ** can be problematic.
  63544. */
  63545. rc = SQLITE_CORRUPT_BKPT;
  63546. }else{
  63547. rc = freePage2(pBt, pOvfl, ovflPgno);
  63548. }
  63549. if( pOvfl ){
  63550. sqlite3PagerUnref(pOvfl->pDbPage);
  63551. }
  63552. if( rc ) return rc;
  63553. ovflPgno = iNext;
  63554. }
  63555. return SQLITE_OK;
  63556. }
  63557. /*
  63558. ** Create the byte sequence used to represent a cell on page pPage
  63559. ** and write that byte sequence into pCell[]. Overflow pages are
  63560. ** allocated and filled in as necessary. The calling procedure
  63561. ** is responsible for making sure sufficient space has been allocated
  63562. ** for pCell[].
  63563. **
  63564. ** Note that pCell does not necessary need to point to the pPage->aData
  63565. ** area. pCell might point to some temporary storage. The cell will
  63566. ** be constructed in this temporary area then copied into pPage->aData
  63567. ** later.
  63568. */
  63569. static int fillInCell(
  63570. MemPage *pPage, /* The page that contains the cell */
  63571. unsigned char *pCell, /* Complete text of the cell */
  63572. const BtreePayload *pX, /* Payload with which to construct the cell */
  63573. int *pnSize /* Write cell size here */
  63574. ){
  63575. int nPayload;
  63576. const u8 *pSrc;
  63577. int nSrc, n, rc, mn;
  63578. int spaceLeft;
  63579. MemPage *pToRelease;
  63580. unsigned char *pPrior;
  63581. unsigned char *pPayload;
  63582. BtShared *pBt;
  63583. Pgno pgnoOvfl;
  63584. int nHeader;
  63585. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  63586. /* pPage is not necessarily writeable since pCell might be auxiliary
  63587. ** buffer space that is separate from the pPage buffer area */
  63588. assert( pCell<pPage->aData || pCell>=&pPage->aData[pPage->pBt->pageSize]
  63589. || sqlite3PagerIswriteable(pPage->pDbPage) );
  63590. /* Fill in the header. */
  63591. nHeader = pPage->childPtrSize;
  63592. if( pPage->intKey ){
  63593. nPayload = pX->nData + pX->nZero;
  63594. pSrc = pX->pData;
  63595. nSrc = pX->nData;
  63596. assert( pPage->intKeyLeaf ); /* fillInCell() only called for leaves */
  63597. nHeader += putVarint32(&pCell[nHeader], nPayload);
  63598. nHeader += putVarint(&pCell[nHeader], *(u64*)&pX->nKey);
  63599. }else{
  63600. assert( pX->nKey<=0x7fffffff && pX->pKey!=0 );
  63601. nSrc = nPayload = (int)pX->nKey;
  63602. pSrc = pX->pKey;
  63603. nHeader += putVarint32(&pCell[nHeader], nPayload);
  63604. }
  63605. /* Fill in the payload */
  63606. pPayload = &pCell[nHeader];
  63607. if( nPayload<=pPage->maxLocal ){
  63608. /* This is the common case where everything fits on the btree page
  63609. ** and no overflow pages are required. */
  63610. n = nHeader + nPayload;
  63611. testcase( n==3 );
  63612. testcase( n==4 );
  63613. if( n<4 ) n = 4;
  63614. *pnSize = n;
  63615. assert( nSrc<=nPayload );
  63616. testcase( nSrc<nPayload );
  63617. memcpy(pPayload, pSrc, nSrc);
  63618. memset(pPayload+nSrc, 0, nPayload-nSrc);
  63619. return SQLITE_OK;
  63620. }
  63621. /* If we reach this point, it means that some of the content will need
  63622. ** to spill onto overflow pages.
  63623. */
  63624. mn = pPage->minLocal;
  63625. n = mn + (nPayload - mn) % (pPage->pBt->usableSize - 4);
  63626. testcase( n==pPage->maxLocal );
  63627. testcase( n==pPage->maxLocal+1 );
  63628. if( n > pPage->maxLocal ) n = mn;
  63629. spaceLeft = n;
  63630. *pnSize = n + nHeader + 4;
  63631. pPrior = &pCell[nHeader+n];
  63632. pToRelease = 0;
  63633. pgnoOvfl = 0;
  63634. pBt = pPage->pBt;
  63635. /* At this point variables should be set as follows:
  63636. **
  63637. ** nPayload Total payload size in bytes
  63638. ** pPayload Begin writing payload here
  63639. ** spaceLeft Space available at pPayload. If nPayload>spaceLeft,
  63640. ** that means content must spill into overflow pages.
  63641. ** *pnSize Size of the local cell (not counting overflow pages)
  63642. ** pPrior Where to write the pgno of the first overflow page
  63643. **
  63644. ** Use a call to btreeParseCellPtr() to verify that the values above
  63645. ** were computed correctly.
  63646. */
  63647. #ifdef SQLITE_DEBUG
  63648. {
  63649. CellInfo info;
  63650. pPage->xParseCell(pPage, pCell, &info);
  63651. assert( nHeader==(int)(info.pPayload - pCell) );
  63652. assert( info.nKey==pX->nKey );
  63653. assert( *pnSize == info.nSize );
  63654. assert( spaceLeft == info.nLocal );
  63655. }
  63656. #endif
  63657. /* Write the payload into the local Cell and any extra into overflow pages */
  63658. while( 1 ){
  63659. n = nPayload;
  63660. if( n>spaceLeft ) n = spaceLeft;
  63661. /* If pToRelease is not zero than pPayload points into the data area
  63662. ** of pToRelease. Make sure pToRelease is still writeable. */
  63663. assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
  63664. /* If pPayload is part of the data area of pPage, then make sure pPage
  63665. ** is still writeable */
  63666. assert( pPayload<pPage->aData || pPayload>=&pPage->aData[pBt->pageSize]
  63667. || sqlite3PagerIswriteable(pPage->pDbPage) );
  63668. if( nSrc>=n ){
  63669. memcpy(pPayload, pSrc, n);
  63670. }else if( nSrc>0 ){
  63671. n = nSrc;
  63672. memcpy(pPayload, pSrc, n);
  63673. }else{
  63674. memset(pPayload, 0, n);
  63675. }
  63676. nPayload -= n;
  63677. if( nPayload<=0 ) break;
  63678. pPayload += n;
  63679. pSrc += n;
  63680. nSrc -= n;
  63681. spaceLeft -= n;
  63682. if( spaceLeft==0 ){
  63683. MemPage *pOvfl = 0;
  63684. #ifndef SQLITE_OMIT_AUTOVACUUM
  63685. Pgno pgnoPtrmap = pgnoOvfl; /* Overflow page pointer-map entry page */
  63686. if( pBt->autoVacuum ){
  63687. do{
  63688. pgnoOvfl++;
  63689. } while(
  63690. PTRMAP_ISPAGE(pBt, pgnoOvfl) || pgnoOvfl==PENDING_BYTE_PAGE(pBt)
  63691. );
  63692. }
  63693. #endif
  63694. rc = allocateBtreePage(pBt, &pOvfl, &pgnoOvfl, pgnoOvfl, 0);
  63695. #ifndef SQLITE_OMIT_AUTOVACUUM
  63696. /* If the database supports auto-vacuum, and the second or subsequent
  63697. ** overflow page is being allocated, add an entry to the pointer-map
  63698. ** for that page now.
  63699. **
  63700. ** If this is the first overflow page, then write a partial entry
  63701. ** to the pointer-map. If we write nothing to this pointer-map slot,
  63702. ** then the optimistic overflow chain processing in clearCell()
  63703. ** may misinterpret the uninitialized values and delete the
  63704. ** wrong pages from the database.
  63705. */
  63706. if( pBt->autoVacuum && rc==SQLITE_OK ){
  63707. u8 eType = (pgnoPtrmap?PTRMAP_OVERFLOW2:PTRMAP_OVERFLOW1);
  63708. ptrmapPut(pBt, pgnoOvfl, eType, pgnoPtrmap, &rc);
  63709. if( rc ){
  63710. releasePage(pOvfl);
  63711. }
  63712. }
  63713. #endif
  63714. if( rc ){
  63715. releasePage(pToRelease);
  63716. return rc;
  63717. }
  63718. /* If pToRelease is not zero than pPrior points into the data area
  63719. ** of pToRelease. Make sure pToRelease is still writeable. */
  63720. assert( pToRelease==0 || sqlite3PagerIswriteable(pToRelease->pDbPage) );
  63721. /* If pPrior is part of the data area of pPage, then make sure pPage
  63722. ** is still writeable */
  63723. assert( pPrior<pPage->aData || pPrior>=&pPage->aData[pBt->pageSize]
  63724. || sqlite3PagerIswriteable(pPage->pDbPage) );
  63725. put4byte(pPrior, pgnoOvfl);
  63726. releasePage(pToRelease);
  63727. pToRelease = pOvfl;
  63728. pPrior = pOvfl->aData;
  63729. put4byte(pPrior, 0);
  63730. pPayload = &pOvfl->aData[4];
  63731. spaceLeft = pBt->usableSize - 4;
  63732. }
  63733. }
  63734. releasePage(pToRelease);
  63735. return SQLITE_OK;
  63736. }
  63737. /*
  63738. ** Remove the i-th cell from pPage. This routine effects pPage only.
  63739. ** The cell content is not freed or deallocated. It is assumed that
  63740. ** the cell content has been copied someplace else. This routine just
  63741. ** removes the reference to the cell from pPage.
  63742. **
  63743. ** "sz" must be the number of bytes in the cell.
  63744. */
  63745. static void dropCell(MemPage *pPage, int idx, int sz, int *pRC){
  63746. u32 pc; /* Offset to cell content of cell being deleted */
  63747. u8 *data; /* pPage->aData */
  63748. u8 *ptr; /* Used to move bytes around within data[] */
  63749. int rc; /* The return code */
  63750. int hdr; /* Beginning of the header. 0 most pages. 100 page 1 */
  63751. if( *pRC ) return;
  63752. assert( idx>=0 && idx<pPage->nCell );
  63753. assert( CORRUPT_DB || sz==cellSize(pPage, idx) );
  63754. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  63755. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  63756. data = pPage->aData;
  63757. ptr = &pPage->aCellIdx[2*idx];
  63758. pc = get2byte(ptr);
  63759. hdr = pPage->hdrOffset;
  63760. testcase( pc==get2byte(&data[hdr+5]) );
  63761. testcase( pc+sz==pPage->pBt->usableSize );
  63762. if( pc+sz > pPage->pBt->usableSize ){
  63763. *pRC = SQLITE_CORRUPT_BKPT;
  63764. return;
  63765. }
  63766. rc = freeSpace(pPage, pc, sz);
  63767. if( rc ){
  63768. *pRC = rc;
  63769. return;
  63770. }
  63771. pPage->nCell--;
  63772. if( pPage->nCell==0 ){
  63773. memset(&data[hdr+1], 0, 4);
  63774. data[hdr+7] = 0;
  63775. put2byte(&data[hdr+5], pPage->pBt->usableSize);
  63776. pPage->nFree = pPage->pBt->usableSize - pPage->hdrOffset
  63777. - pPage->childPtrSize - 8;
  63778. }else{
  63779. memmove(ptr, ptr+2, 2*(pPage->nCell - idx));
  63780. put2byte(&data[hdr+3], pPage->nCell);
  63781. pPage->nFree += 2;
  63782. }
  63783. }
  63784. /*
  63785. ** Insert a new cell on pPage at cell index "i". pCell points to the
  63786. ** content of the cell.
  63787. **
  63788. ** If the cell content will fit on the page, then put it there. If it
  63789. ** will not fit, then make a copy of the cell content into pTemp if
  63790. ** pTemp is not null. Regardless of pTemp, allocate a new entry
  63791. ** in pPage->apOvfl[] and make it point to the cell content (either
  63792. ** in pTemp or the original pCell) and also record its index.
  63793. ** Allocating a new entry in pPage->aCell[] implies that
  63794. ** pPage->nOverflow is incremented.
  63795. **
  63796. ** *pRC must be SQLITE_OK when this routine is called.
  63797. */
  63798. static void insertCell(
  63799. MemPage *pPage, /* Page into which we are copying */
  63800. int i, /* New cell becomes the i-th cell of the page */
  63801. u8 *pCell, /* Content of the new cell */
  63802. int sz, /* Bytes of content in pCell */
  63803. u8 *pTemp, /* Temp storage space for pCell, if needed */
  63804. Pgno iChild, /* If non-zero, replace first 4 bytes with this value */
  63805. int *pRC /* Read and write return code from here */
  63806. ){
  63807. int idx = 0; /* Where to write new cell content in data[] */
  63808. int j; /* Loop counter */
  63809. u8 *data; /* The content of the whole page */
  63810. u8 *pIns; /* The point in pPage->aCellIdx[] where no cell inserted */
  63811. assert( *pRC==SQLITE_OK );
  63812. assert( i>=0 && i<=pPage->nCell+pPage->nOverflow );
  63813. assert( MX_CELL(pPage->pBt)<=10921 );
  63814. assert( pPage->nCell<=MX_CELL(pPage->pBt) || CORRUPT_DB );
  63815. assert( pPage->nOverflow<=ArraySize(pPage->apOvfl) );
  63816. assert( ArraySize(pPage->apOvfl)==ArraySize(pPage->aiOvfl) );
  63817. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  63818. /* The cell should normally be sized correctly. However, when moving a
  63819. ** malformed cell from a leaf page to an interior page, if the cell size
  63820. ** wanted to be less than 4 but got rounded up to 4 on the leaf, then size
  63821. ** might be less than 8 (leaf-size + pointer) on the interior node. Hence
  63822. ** the term after the || in the following assert(). */
  63823. assert( sz==pPage->xCellSize(pPage, pCell) || (sz==8 && iChild>0) );
  63824. if( pPage->nOverflow || sz+2>pPage->nFree ){
  63825. if( pTemp ){
  63826. memcpy(pTemp, pCell, sz);
  63827. pCell = pTemp;
  63828. }
  63829. if( iChild ){
  63830. put4byte(pCell, iChild);
  63831. }
  63832. j = pPage->nOverflow++;
  63833. /* Comparison against ArraySize-1 since we hold back one extra slot
  63834. ** as a contingency. In other words, never need more than 3 overflow
  63835. ** slots but 4 are allocated, just to be safe. */
  63836. assert( j < ArraySize(pPage->apOvfl)-1 );
  63837. pPage->apOvfl[j] = pCell;
  63838. pPage->aiOvfl[j] = (u16)i;
  63839. /* When multiple overflows occur, they are always sequential and in
  63840. ** sorted order. This invariants arise because multiple overflows can
  63841. ** only occur when inserting divider cells into the parent page during
  63842. ** balancing, and the dividers are adjacent and sorted.
  63843. */
  63844. assert( j==0 || pPage->aiOvfl[j-1]<(u16)i ); /* Overflows in sorted order */
  63845. assert( j==0 || i==pPage->aiOvfl[j-1]+1 ); /* Overflows are sequential */
  63846. }else{
  63847. int rc = sqlite3PagerWrite(pPage->pDbPage);
  63848. if( rc!=SQLITE_OK ){
  63849. *pRC = rc;
  63850. return;
  63851. }
  63852. assert( sqlite3PagerIswriteable(pPage->pDbPage) );
  63853. data = pPage->aData;
  63854. assert( &data[pPage->cellOffset]==pPage->aCellIdx );
  63855. rc = allocateSpace(pPage, sz, &idx);
  63856. if( rc ){ *pRC = rc; return; }
  63857. /* The allocateSpace() routine guarantees the following properties
  63858. ** if it returns successfully */
  63859. assert( idx >= 0 );
  63860. assert( idx >= pPage->cellOffset+2*pPage->nCell+2 || CORRUPT_DB );
  63861. assert( idx+sz <= (int)pPage->pBt->usableSize );
  63862. pPage->nFree -= (u16)(2 + sz);
  63863. memcpy(&data[idx], pCell, sz);
  63864. if( iChild ){
  63865. put4byte(&data[idx], iChild);
  63866. }
  63867. pIns = pPage->aCellIdx + i*2;
  63868. memmove(pIns+2, pIns, 2*(pPage->nCell - i));
  63869. put2byte(pIns, idx);
  63870. pPage->nCell++;
  63871. /* increment the cell count */
  63872. if( (++data[pPage->hdrOffset+4])==0 ) data[pPage->hdrOffset+3]++;
  63873. assert( get2byte(&data[pPage->hdrOffset+3])==pPage->nCell );
  63874. #ifndef SQLITE_OMIT_AUTOVACUUM
  63875. if( pPage->pBt->autoVacuum ){
  63876. /* The cell may contain a pointer to an overflow page. If so, write
  63877. ** the entry for the overflow page into the pointer map.
  63878. */
  63879. ptrmapPutOvflPtr(pPage, pCell, pRC);
  63880. }
  63881. #endif
  63882. }
  63883. }
  63884. /*
  63885. ** A CellArray object contains a cache of pointers and sizes for a
  63886. ** consecutive sequence of cells that might be held on multiple pages.
  63887. */
  63888. typedef struct CellArray CellArray;
  63889. struct CellArray {
  63890. int nCell; /* Number of cells in apCell[] */
  63891. MemPage *pRef; /* Reference page */
  63892. u8 **apCell; /* All cells begin balanced */
  63893. u16 *szCell; /* Local size of all cells in apCell[] */
  63894. };
  63895. /*
  63896. ** Make sure the cell sizes at idx, idx+1, ..., idx+N-1 have been
  63897. ** computed.
  63898. */
  63899. static void populateCellCache(CellArray *p, int idx, int N){
  63900. assert( idx>=0 && idx+N<=p->nCell );
  63901. while( N>0 ){
  63902. assert( p->apCell[idx]!=0 );
  63903. if( p->szCell[idx]==0 ){
  63904. p->szCell[idx] = p->pRef->xCellSize(p->pRef, p->apCell[idx]);
  63905. }else{
  63906. assert( CORRUPT_DB ||
  63907. p->szCell[idx]==p->pRef->xCellSize(p->pRef, p->apCell[idx]) );
  63908. }
  63909. idx++;
  63910. N--;
  63911. }
  63912. }
  63913. /*
  63914. ** Return the size of the Nth element of the cell array
  63915. */
  63916. static SQLITE_NOINLINE u16 computeCellSize(CellArray *p, int N){
  63917. assert( N>=0 && N<p->nCell );
  63918. assert( p->szCell[N]==0 );
  63919. p->szCell[N] = p->pRef->xCellSize(p->pRef, p->apCell[N]);
  63920. return p->szCell[N];
  63921. }
  63922. static u16 cachedCellSize(CellArray *p, int N){
  63923. assert( N>=0 && N<p->nCell );
  63924. if( p->szCell[N] ) return p->szCell[N];
  63925. return computeCellSize(p, N);
  63926. }
  63927. /*
  63928. ** Array apCell[] contains pointers to nCell b-tree page cells. The
  63929. ** szCell[] array contains the size in bytes of each cell. This function
  63930. ** replaces the current contents of page pPg with the contents of the cell
  63931. ** array.
  63932. **
  63933. ** Some of the cells in apCell[] may currently be stored in pPg. This
  63934. ** function works around problems caused by this by making a copy of any
  63935. ** such cells before overwriting the page data.
  63936. **
  63937. ** The MemPage.nFree field is invalidated by this function. It is the
  63938. ** responsibility of the caller to set it correctly.
  63939. */
  63940. static int rebuildPage(
  63941. MemPage *pPg, /* Edit this page */
  63942. int nCell, /* Final number of cells on page */
  63943. u8 **apCell, /* Array of cells */
  63944. u16 *szCell /* Array of cell sizes */
  63945. ){
  63946. const int hdr = pPg->hdrOffset; /* Offset of header on pPg */
  63947. u8 * const aData = pPg->aData; /* Pointer to data for pPg */
  63948. const int usableSize = pPg->pBt->usableSize;
  63949. u8 * const pEnd = &aData[usableSize];
  63950. int i;
  63951. u8 *pCellptr = pPg->aCellIdx;
  63952. u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
  63953. u8 *pData;
  63954. i = get2byte(&aData[hdr+5]);
  63955. memcpy(&pTmp[i], &aData[i], usableSize - i);
  63956. pData = pEnd;
  63957. for(i=0; i<nCell; i++){
  63958. u8 *pCell = apCell[i];
  63959. if( SQLITE_WITHIN(pCell,aData,pEnd) ){
  63960. pCell = &pTmp[pCell - aData];
  63961. }
  63962. pData -= szCell[i];
  63963. put2byte(pCellptr, (pData - aData));
  63964. pCellptr += 2;
  63965. if( pData < pCellptr ) return SQLITE_CORRUPT_BKPT;
  63966. memcpy(pData, pCell, szCell[i]);
  63967. assert( szCell[i]==pPg->xCellSize(pPg, pCell) || CORRUPT_DB );
  63968. testcase( szCell[i]!=pPg->xCellSize(pPg,pCell) );
  63969. }
  63970. /* The pPg->nFree field is now set incorrectly. The caller will fix it. */
  63971. pPg->nCell = nCell;
  63972. pPg->nOverflow = 0;
  63973. put2byte(&aData[hdr+1], 0);
  63974. put2byte(&aData[hdr+3], pPg->nCell);
  63975. put2byte(&aData[hdr+5], pData - aData);
  63976. aData[hdr+7] = 0x00;
  63977. return SQLITE_OK;
  63978. }
  63979. /*
  63980. ** Array apCell[] contains nCell pointers to b-tree cells. Array szCell
  63981. ** contains the size in bytes of each such cell. This function attempts to
  63982. ** add the cells stored in the array to page pPg. If it cannot (because
  63983. ** the page needs to be defragmented before the cells will fit), non-zero
  63984. ** is returned. Otherwise, if the cells are added successfully, zero is
  63985. ** returned.
  63986. **
  63987. ** Argument pCellptr points to the first entry in the cell-pointer array
  63988. ** (part of page pPg) to populate. After cell apCell[0] is written to the
  63989. ** page body, a 16-bit offset is written to pCellptr. And so on, for each
  63990. ** cell in the array. It is the responsibility of the caller to ensure
  63991. ** that it is safe to overwrite this part of the cell-pointer array.
  63992. **
  63993. ** When this function is called, *ppData points to the start of the
  63994. ** content area on page pPg. If the size of the content area is extended,
  63995. ** *ppData is updated to point to the new start of the content area
  63996. ** before returning.
  63997. **
  63998. ** Finally, argument pBegin points to the byte immediately following the
  63999. ** end of the space required by this page for the cell-pointer area (for
  64000. ** all cells - not just those inserted by the current call). If the content
  64001. ** area must be extended to before this point in order to accomodate all
  64002. ** cells in apCell[], then the cells do not fit and non-zero is returned.
  64003. */
  64004. static int pageInsertArray(
  64005. MemPage *pPg, /* Page to add cells to */
  64006. u8 *pBegin, /* End of cell-pointer array */
  64007. u8 **ppData, /* IN/OUT: Page content -area pointer */
  64008. u8 *pCellptr, /* Pointer to cell-pointer area */
  64009. int iFirst, /* Index of first cell to add */
  64010. int nCell, /* Number of cells to add to pPg */
  64011. CellArray *pCArray /* Array of cells */
  64012. ){
  64013. int i;
  64014. u8 *aData = pPg->aData;
  64015. u8 *pData = *ppData;
  64016. int iEnd = iFirst + nCell;
  64017. assert( CORRUPT_DB || pPg->hdrOffset==0 ); /* Never called on page 1 */
  64018. for(i=iFirst; i<iEnd; i++){
  64019. int sz, rc;
  64020. u8 *pSlot;
  64021. sz = cachedCellSize(pCArray, i);
  64022. if( (aData[1]==0 && aData[2]==0) || (pSlot = pageFindSlot(pPg,sz,&rc))==0 ){
  64023. if( (pData - pBegin)<sz ) return 1;
  64024. pData -= sz;
  64025. pSlot = pData;
  64026. }
  64027. /* pSlot and pCArray->apCell[i] will never overlap on a well-formed
  64028. ** database. But they might for a corrupt database. Hence use memmove()
  64029. ** since memcpy() sends SIGABORT with overlapping buffers on OpenBSD */
  64030. assert( (pSlot+sz)<=pCArray->apCell[i]
  64031. || pSlot>=(pCArray->apCell[i]+sz)
  64032. || CORRUPT_DB );
  64033. memmove(pSlot, pCArray->apCell[i], sz);
  64034. put2byte(pCellptr, (pSlot - aData));
  64035. pCellptr += 2;
  64036. }
  64037. *ppData = pData;
  64038. return 0;
  64039. }
  64040. /*
  64041. ** Array apCell[] contains nCell pointers to b-tree cells. Array szCell
  64042. ** contains the size in bytes of each such cell. This function adds the
  64043. ** space associated with each cell in the array that is currently stored
  64044. ** within the body of pPg to the pPg free-list. The cell-pointers and other
  64045. ** fields of the page are not updated.
  64046. **
  64047. ** This function returns the total number of cells added to the free-list.
  64048. */
  64049. static int pageFreeArray(
  64050. MemPage *pPg, /* Page to edit */
  64051. int iFirst, /* First cell to delete */
  64052. int nCell, /* Cells to delete */
  64053. CellArray *pCArray /* Array of cells */
  64054. ){
  64055. u8 * const aData = pPg->aData;
  64056. u8 * const pEnd = &aData[pPg->pBt->usableSize];
  64057. u8 * const pStart = &aData[pPg->hdrOffset + 8 + pPg->childPtrSize];
  64058. int nRet = 0;
  64059. int i;
  64060. int iEnd = iFirst + nCell;
  64061. u8 *pFree = 0;
  64062. int szFree = 0;
  64063. for(i=iFirst; i<iEnd; i++){
  64064. u8 *pCell = pCArray->apCell[i];
  64065. if( SQLITE_WITHIN(pCell, pStart, pEnd) ){
  64066. int sz;
  64067. /* No need to use cachedCellSize() here. The sizes of all cells that
  64068. ** are to be freed have already been computing while deciding which
  64069. ** cells need freeing */
  64070. sz = pCArray->szCell[i]; assert( sz>0 );
  64071. if( pFree!=(pCell + sz) ){
  64072. if( pFree ){
  64073. assert( pFree>aData && (pFree - aData)<65536 );
  64074. freeSpace(pPg, (u16)(pFree - aData), szFree);
  64075. }
  64076. pFree = pCell;
  64077. szFree = sz;
  64078. if( pFree+sz>pEnd ) return 0;
  64079. }else{
  64080. pFree = pCell;
  64081. szFree += sz;
  64082. }
  64083. nRet++;
  64084. }
  64085. }
  64086. if( pFree ){
  64087. assert( pFree>aData && (pFree - aData)<65536 );
  64088. freeSpace(pPg, (u16)(pFree - aData), szFree);
  64089. }
  64090. return nRet;
  64091. }
  64092. /*
  64093. ** apCell[] and szCell[] contains pointers to and sizes of all cells in the
  64094. ** pages being balanced. The current page, pPg, has pPg->nCell cells starting
  64095. ** with apCell[iOld]. After balancing, this page should hold nNew cells
  64096. ** starting at apCell[iNew].
  64097. **
  64098. ** This routine makes the necessary adjustments to pPg so that it contains
  64099. ** the correct cells after being balanced.
  64100. **
  64101. ** The pPg->nFree field is invalid when this function returns. It is the
  64102. ** responsibility of the caller to set it correctly.
  64103. */
  64104. static int editPage(
  64105. MemPage *pPg, /* Edit this page */
  64106. int iOld, /* Index of first cell currently on page */
  64107. int iNew, /* Index of new first cell on page */
  64108. int nNew, /* Final number of cells on page */
  64109. CellArray *pCArray /* Array of cells and sizes */
  64110. ){
  64111. u8 * const aData = pPg->aData;
  64112. const int hdr = pPg->hdrOffset;
  64113. u8 *pBegin = &pPg->aCellIdx[nNew * 2];
  64114. int nCell = pPg->nCell; /* Cells stored on pPg */
  64115. u8 *pData;
  64116. u8 *pCellptr;
  64117. int i;
  64118. int iOldEnd = iOld + pPg->nCell + pPg->nOverflow;
  64119. int iNewEnd = iNew + nNew;
  64120. #ifdef SQLITE_DEBUG
  64121. u8 *pTmp = sqlite3PagerTempSpace(pPg->pBt->pPager);
  64122. memcpy(pTmp, aData, pPg->pBt->usableSize);
  64123. #endif
  64124. /* Remove cells from the start and end of the page */
  64125. if( iOld<iNew ){
  64126. int nShift = pageFreeArray(pPg, iOld, iNew-iOld, pCArray);
  64127. memmove(pPg->aCellIdx, &pPg->aCellIdx[nShift*2], nCell*2);
  64128. nCell -= nShift;
  64129. }
  64130. if( iNewEnd < iOldEnd ){
  64131. nCell -= pageFreeArray(pPg, iNewEnd, iOldEnd - iNewEnd, pCArray);
  64132. }
  64133. pData = &aData[get2byteNotZero(&aData[hdr+5])];
  64134. if( pData<pBegin ) goto editpage_fail;
  64135. /* Add cells to the start of the page */
  64136. if( iNew<iOld ){
  64137. int nAdd = MIN(nNew,iOld-iNew);
  64138. assert( (iOld-iNew)<nNew || nCell==0 || CORRUPT_DB );
  64139. pCellptr = pPg->aCellIdx;
  64140. memmove(&pCellptr[nAdd*2], pCellptr, nCell*2);
  64141. if( pageInsertArray(
  64142. pPg, pBegin, &pData, pCellptr,
  64143. iNew, nAdd, pCArray
  64144. ) ) goto editpage_fail;
  64145. nCell += nAdd;
  64146. }
  64147. /* Add any overflow cells */
  64148. for(i=0; i<pPg->nOverflow; i++){
  64149. int iCell = (iOld + pPg->aiOvfl[i]) - iNew;
  64150. if( iCell>=0 && iCell<nNew ){
  64151. pCellptr = &pPg->aCellIdx[iCell * 2];
  64152. memmove(&pCellptr[2], pCellptr, (nCell - iCell) * 2);
  64153. nCell++;
  64154. if( pageInsertArray(
  64155. pPg, pBegin, &pData, pCellptr,
  64156. iCell+iNew, 1, pCArray
  64157. ) ) goto editpage_fail;
  64158. }
  64159. }
  64160. /* Append cells to the end of the page */
  64161. pCellptr = &pPg->aCellIdx[nCell*2];
  64162. if( pageInsertArray(
  64163. pPg, pBegin, &pData, pCellptr,
  64164. iNew+nCell, nNew-nCell, pCArray
  64165. ) ) goto editpage_fail;
  64166. pPg->nCell = nNew;
  64167. pPg->nOverflow = 0;
  64168. put2byte(&aData[hdr+3], pPg->nCell);
  64169. put2byte(&aData[hdr+5], pData - aData);
  64170. #ifdef SQLITE_DEBUG
  64171. for(i=0; i<nNew && !CORRUPT_DB; i++){
  64172. u8 *pCell = pCArray->apCell[i+iNew];
  64173. int iOff = get2byteAligned(&pPg->aCellIdx[i*2]);
  64174. if( SQLITE_WITHIN(pCell, aData, &aData[pPg->pBt->usableSize]) ){
  64175. pCell = &pTmp[pCell - aData];
  64176. }
  64177. assert( 0==memcmp(pCell, &aData[iOff],
  64178. pCArray->pRef->xCellSize(pCArray->pRef, pCArray->apCell[i+iNew])) );
  64179. }
  64180. #endif
  64181. return SQLITE_OK;
  64182. editpage_fail:
  64183. /* Unable to edit this page. Rebuild it from scratch instead. */
  64184. populateCellCache(pCArray, iNew, nNew);
  64185. return rebuildPage(pPg, nNew, &pCArray->apCell[iNew], &pCArray->szCell[iNew]);
  64186. }
  64187. /*
  64188. ** The following parameters determine how many adjacent pages get involved
  64189. ** in a balancing operation. NN is the number of neighbors on either side
  64190. ** of the page that participate in the balancing operation. NB is the
  64191. ** total number of pages that participate, including the target page and
  64192. ** NN neighbors on either side.
  64193. **
  64194. ** The minimum value of NN is 1 (of course). Increasing NN above 1
  64195. ** (to 2 or 3) gives a modest improvement in SELECT and DELETE performance
  64196. ** in exchange for a larger degradation in INSERT and UPDATE performance.
  64197. ** The value of NN appears to give the best results overall.
  64198. */
  64199. #define NN 1 /* Number of neighbors on either side of pPage */
  64200. #define NB (NN*2+1) /* Total pages involved in the balance */
  64201. #ifndef SQLITE_OMIT_QUICKBALANCE
  64202. /*
  64203. ** This version of balance() handles the common special case where
  64204. ** a new entry is being inserted on the extreme right-end of the
  64205. ** tree, in other words, when the new entry will become the largest
  64206. ** entry in the tree.
  64207. **
  64208. ** Instead of trying to balance the 3 right-most leaf pages, just add
  64209. ** a new page to the right-hand side and put the one new entry in
  64210. ** that page. This leaves the right side of the tree somewhat
  64211. ** unbalanced. But odds are that we will be inserting new entries
  64212. ** at the end soon afterwards so the nearly empty page will quickly
  64213. ** fill up. On average.
  64214. **
  64215. ** pPage is the leaf page which is the right-most page in the tree.
  64216. ** pParent is its parent. pPage must have a single overflow entry
  64217. ** which is also the right-most entry on the page.
  64218. **
  64219. ** The pSpace buffer is used to store a temporary copy of the divider
  64220. ** cell that will be inserted into pParent. Such a cell consists of a 4
  64221. ** byte page number followed by a variable length integer. In other
  64222. ** words, at most 13 bytes. Hence the pSpace buffer must be at
  64223. ** least 13 bytes in size.
  64224. */
  64225. static int balance_quick(MemPage *pParent, MemPage *pPage, u8 *pSpace){
  64226. BtShared *const pBt = pPage->pBt; /* B-Tree Database */
  64227. MemPage *pNew; /* Newly allocated page */
  64228. int rc; /* Return Code */
  64229. Pgno pgnoNew; /* Page number of pNew */
  64230. assert( sqlite3_mutex_held(pPage->pBt->mutex) );
  64231. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  64232. assert( pPage->nOverflow==1 );
  64233. /* This error condition is now caught prior to reaching this function */
  64234. if( NEVER(pPage->nCell==0) ) return SQLITE_CORRUPT_BKPT;
  64235. /* Allocate a new page. This page will become the right-sibling of
  64236. ** pPage. Make the parent page writable, so that the new divider cell
  64237. ** may be inserted. If both these operations are successful, proceed.
  64238. */
  64239. rc = allocateBtreePage(pBt, &pNew, &pgnoNew, 0, 0);
  64240. if( rc==SQLITE_OK ){
  64241. u8 *pOut = &pSpace[4];
  64242. u8 *pCell = pPage->apOvfl[0];
  64243. u16 szCell = pPage->xCellSize(pPage, pCell);
  64244. u8 *pStop;
  64245. assert( sqlite3PagerIswriteable(pNew->pDbPage) );
  64246. assert( pPage->aData[0]==(PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF) );
  64247. zeroPage(pNew, PTF_INTKEY|PTF_LEAFDATA|PTF_LEAF);
  64248. rc = rebuildPage(pNew, 1, &pCell, &szCell);
  64249. if( NEVER(rc) ) return rc;
  64250. pNew->nFree = pBt->usableSize - pNew->cellOffset - 2 - szCell;
  64251. /* If this is an auto-vacuum database, update the pointer map
  64252. ** with entries for the new page, and any pointer from the
  64253. ** cell on the page to an overflow page. If either of these
  64254. ** operations fails, the return code is set, but the contents
  64255. ** of the parent page are still manipulated by thh code below.
  64256. ** That is Ok, at this point the parent page is guaranteed to
  64257. ** be marked as dirty. Returning an error code will cause a
  64258. ** rollback, undoing any changes made to the parent page.
  64259. */
  64260. if( ISAUTOVACUUM ){
  64261. ptrmapPut(pBt, pgnoNew, PTRMAP_BTREE, pParent->pgno, &rc);
  64262. if( szCell>pNew->minLocal ){
  64263. ptrmapPutOvflPtr(pNew, pCell, &rc);
  64264. }
  64265. }
  64266. /* Create a divider cell to insert into pParent. The divider cell
  64267. ** consists of a 4-byte page number (the page number of pPage) and
  64268. ** a variable length key value (which must be the same value as the
  64269. ** largest key on pPage).
  64270. **
  64271. ** To find the largest key value on pPage, first find the right-most
  64272. ** cell on pPage. The first two fields of this cell are the
  64273. ** record-length (a variable length integer at most 32-bits in size)
  64274. ** and the key value (a variable length integer, may have any value).
  64275. ** The first of the while(...) loops below skips over the record-length
  64276. ** field. The second while(...) loop copies the key value from the
  64277. ** cell on pPage into the pSpace buffer.
  64278. */
  64279. pCell = findCell(pPage, pPage->nCell-1);
  64280. pStop = &pCell[9];
  64281. while( (*(pCell++)&0x80) && pCell<pStop );
  64282. pStop = &pCell[9];
  64283. while( ((*(pOut++) = *(pCell++))&0x80) && pCell<pStop );
  64284. /* Insert the new divider cell into pParent. */
  64285. if( rc==SQLITE_OK ){
  64286. insertCell(pParent, pParent->nCell, pSpace, (int)(pOut-pSpace),
  64287. 0, pPage->pgno, &rc);
  64288. }
  64289. /* Set the right-child pointer of pParent to point to the new page. */
  64290. put4byte(&pParent->aData[pParent->hdrOffset+8], pgnoNew);
  64291. /* Release the reference to the new page. */
  64292. releasePage(pNew);
  64293. }
  64294. return rc;
  64295. }
  64296. #endif /* SQLITE_OMIT_QUICKBALANCE */
  64297. #if 0
  64298. /*
  64299. ** This function does not contribute anything to the operation of SQLite.
  64300. ** it is sometimes activated temporarily while debugging code responsible
  64301. ** for setting pointer-map entries.
  64302. */
  64303. static int ptrmapCheckPages(MemPage **apPage, int nPage){
  64304. int i, j;
  64305. for(i=0; i<nPage; i++){
  64306. Pgno n;
  64307. u8 e;
  64308. MemPage *pPage = apPage[i];
  64309. BtShared *pBt = pPage->pBt;
  64310. assert( pPage->isInit );
  64311. for(j=0; j<pPage->nCell; j++){
  64312. CellInfo info;
  64313. u8 *z;
  64314. z = findCell(pPage, j);
  64315. pPage->xParseCell(pPage, z, &info);
  64316. if( info.nLocal<info.nPayload ){
  64317. Pgno ovfl = get4byte(&z[info.nSize-4]);
  64318. ptrmapGet(pBt, ovfl, &e, &n);
  64319. assert( n==pPage->pgno && e==PTRMAP_OVERFLOW1 );
  64320. }
  64321. if( !pPage->leaf ){
  64322. Pgno child = get4byte(z);
  64323. ptrmapGet(pBt, child, &e, &n);
  64324. assert( n==pPage->pgno && e==PTRMAP_BTREE );
  64325. }
  64326. }
  64327. if( !pPage->leaf ){
  64328. Pgno child = get4byte(&pPage->aData[pPage->hdrOffset+8]);
  64329. ptrmapGet(pBt, child, &e, &n);
  64330. assert( n==pPage->pgno && e==PTRMAP_BTREE );
  64331. }
  64332. }
  64333. return 1;
  64334. }
  64335. #endif
  64336. /*
  64337. ** This function is used to copy the contents of the b-tree node stored
  64338. ** on page pFrom to page pTo. If page pFrom was not a leaf page, then
  64339. ** the pointer-map entries for each child page are updated so that the
  64340. ** parent page stored in the pointer map is page pTo. If pFrom contained
  64341. ** any cells with overflow page pointers, then the corresponding pointer
  64342. ** map entries are also updated so that the parent page is page pTo.
  64343. **
  64344. ** If pFrom is currently carrying any overflow cells (entries in the
  64345. ** MemPage.apOvfl[] array), they are not copied to pTo.
  64346. **
  64347. ** Before returning, page pTo is reinitialized using btreeInitPage().
  64348. **
  64349. ** The performance of this function is not critical. It is only used by
  64350. ** the balance_shallower() and balance_deeper() procedures, neither of
  64351. ** which are called often under normal circumstances.
  64352. */
  64353. static void copyNodeContent(MemPage *pFrom, MemPage *pTo, int *pRC){
  64354. if( (*pRC)==SQLITE_OK ){
  64355. BtShared * const pBt = pFrom->pBt;
  64356. u8 * const aFrom = pFrom->aData;
  64357. u8 * const aTo = pTo->aData;
  64358. int const iFromHdr = pFrom->hdrOffset;
  64359. int const iToHdr = ((pTo->pgno==1) ? 100 : 0);
  64360. int rc;
  64361. int iData;
  64362. assert( pFrom->isInit );
  64363. assert( pFrom->nFree>=iToHdr );
  64364. assert( get2byte(&aFrom[iFromHdr+5]) <= (int)pBt->usableSize );
  64365. /* Copy the b-tree node content from page pFrom to page pTo. */
  64366. iData = get2byte(&aFrom[iFromHdr+5]);
  64367. memcpy(&aTo[iData], &aFrom[iData], pBt->usableSize-iData);
  64368. memcpy(&aTo[iToHdr], &aFrom[iFromHdr], pFrom->cellOffset + 2*pFrom->nCell);
  64369. /* Reinitialize page pTo so that the contents of the MemPage structure
  64370. ** match the new data. The initialization of pTo can actually fail under
  64371. ** fairly obscure circumstances, even though it is a copy of initialized
  64372. ** page pFrom.
  64373. */
  64374. pTo->isInit = 0;
  64375. rc = btreeInitPage(pTo);
  64376. if( rc!=SQLITE_OK ){
  64377. *pRC = rc;
  64378. return;
  64379. }
  64380. /* If this is an auto-vacuum database, update the pointer-map entries
  64381. ** for any b-tree or overflow pages that pTo now contains the pointers to.
  64382. */
  64383. if( ISAUTOVACUUM ){
  64384. *pRC = setChildPtrmaps(pTo);
  64385. }
  64386. }
  64387. }
  64388. /*
  64389. ** This routine redistributes cells on the iParentIdx'th child of pParent
  64390. ** (hereafter "the page") and up to 2 siblings so that all pages have about the
  64391. ** same amount of free space. Usually a single sibling on either side of the
  64392. ** page are used in the balancing, though both siblings might come from one
  64393. ** side if the page is the first or last child of its parent. If the page
  64394. ** has fewer than 2 siblings (something which can only happen if the page
  64395. ** is a root page or a child of a root page) then all available siblings
  64396. ** participate in the balancing.
  64397. **
  64398. ** The number of siblings of the page might be increased or decreased by
  64399. ** one or two in an effort to keep pages nearly full but not over full.
  64400. **
  64401. ** Note that when this routine is called, some of the cells on the page
  64402. ** might not actually be stored in MemPage.aData[]. This can happen
  64403. ** if the page is overfull. This routine ensures that all cells allocated
  64404. ** to the page and its siblings fit into MemPage.aData[] before returning.
  64405. **
  64406. ** In the course of balancing the page and its siblings, cells may be
  64407. ** inserted into or removed from the parent page (pParent). Doing so
  64408. ** may cause the parent page to become overfull or underfull. If this
  64409. ** happens, it is the responsibility of the caller to invoke the correct
  64410. ** balancing routine to fix this problem (see the balance() routine).
  64411. **
  64412. ** If this routine fails for any reason, it might leave the database
  64413. ** in a corrupted state. So if this routine fails, the database should
  64414. ** be rolled back.
  64415. **
  64416. ** The third argument to this function, aOvflSpace, is a pointer to a
  64417. ** buffer big enough to hold one page. If while inserting cells into the parent
  64418. ** page (pParent) the parent page becomes overfull, this buffer is
  64419. ** used to store the parent's overflow cells. Because this function inserts
  64420. ** a maximum of four divider cells into the parent page, and the maximum
  64421. ** size of a cell stored within an internal node is always less than 1/4
  64422. ** of the page-size, the aOvflSpace[] buffer is guaranteed to be large
  64423. ** enough for all overflow cells.
  64424. **
  64425. ** If aOvflSpace is set to a null pointer, this function returns
  64426. ** SQLITE_NOMEM.
  64427. */
  64428. static int balance_nonroot(
  64429. MemPage *pParent, /* Parent page of siblings being balanced */
  64430. int iParentIdx, /* Index of "the page" in pParent */
  64431. u8 *aOvflSpace, /* page-size bytes of space for parent ovfl */
  64432. int isRoot, /* True if pParent is a root-page */
  64433. int bBulk /* True if this call is part of a bulk load */
  64434. ){
  64435. BtShared *pBt; /* The whole database */
  64436. int nMaxCells = 0; /* Allocated size of apCell, szCell, aFrom. */
  64437. int nNew = 0; /* Number of pages in apNew[] */
  64438. int nOld; /* Number of pages in apOld[] */
  64439. int i, j, k; /* Loop counters */
  64440. int nxDiv; /* Next divider slot in pParent->aCell[] */
  64441. int rc = SQLITE_OK; /* The return code */
  64442. u16 leafCorrection; /* 4 if pPage is a leaf. 0 if not */
  64443. int leafData; /* True if pPage is a leaf of a LEAFDATA tree */
  64444. int usableSpace; /* Bytes in pPage beyond the header */
  64445. int pageFlags; /* Value of pPage->aData[0] */
  64446. int iSpace1 = 0; /* First unused byte of aSpace1[] */
  64447. int iOvflSpace = 0; /* First unused byte of aOvflSpace[] */
  64448. int szScratch; /* Size of scratch memory requested */
  64449. MemPage *apOld[NB]; /* pPage and up to two siblings */
  64450. MemPage *apNew[NB+2]; /* pPage and up to NB siblings after balancing */
  64451. u8 *pRight; /* Location in parent of right-sibling pointer */
  64452. u8 *apDiv[NB-1]; /* Divider cells in pParent */
  64453. int cntNew[NB+2]; /* Index in b.paCell[] of cell after i-th page */
  64454. int cntOld[NB+2]; /* Old index in b.apCell[] */
  64455. int szNew[NB+2]; /* Combined size of cells placed on i-th page */
  64456. u8 *aSpace1; /* Space for copies of dividers cells */
  64457. Pgno pgno; /* Temp var to store a page number in */
  64458. u8 abDone[NB+2]; /* True after i'th new page is populated */
  64459. Pgno aPgno[NB+2]; /* Page numbers of new pages before shuffling */
  64460. Pgno aPgOrder[NB+2]; /* Copy of aPgno[] used for sorting pages */
  64461. u16 aPgFlags[NB+2]; /* flags field of new pages before shuffling */
  64462. CellArray b; /* Parsed information on cells being balanced */
  64463. memset(abDone, 0, sizeof(abDone));
  64464. b.nCell = 0;
  64465. b.apCell = 0;
  64466. pBt = pParent->pBt;
  64467. assert( sqlite3_mutex_held(pBt->mutex) );
  64468. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  64469. #if 0
  64470. TRACE(("BALANCE: begin page %d child of %d\n", pPage->pgno, pParent->pgno));
  64471. #endif
  64472. /* At this point pParent may have at most one overflow cell. And if
  64473. ** this overflow cell is present, it must be the cell with
  64474. ** index iParentIdx. This scenario comes about when this function
  64475. ** is called (indirectly) from sqlite3BtreeDelete().
  64476. */
  64477. assert( pParent->nOverflow==0 || pParent->nOverflow==1 );
  64478. assert( pParent->nOverflow==0 || pParent->aiOvfl[0]==iParentIdx );
  64479. if( !aOvflSpace ){
  64480. return SQLITE_NOMEM_BKPT;
  64481. }
  64482. /* Find the sibling pages to balance. Also locate the cells in pParent
  64483. ** that divide the siblings. An attempt is made to find NN siblings on
  64484. ** either side of pPage. More siblings are taken from one side, however,
  64485. ** if there are fewer than NN siblings on the other side. If pParent
  64486. ** has NB or fewer children then all children of pParent are taken.
  64487. **
  64488. ** This loop also drops the divider cells from the parent page. This
  64489. ** way, the remainder of the function does not have to deal with any
  64490. ** overflow cells in the parent page, since if any existed they will
  64491. ** have already been removed.
  64492. */
  64493. i = pParent->nOverflow + pParent->nCell;
  64494. if( i<2 ){
  64495. nxDiv = 0;
  64496. }else{
  64497. assert( bBulk==0 || bBulk==1 );
  64498. if( iParentIdx==0 ){
  64499. nxDiv = 0;
  64500. }else if( iParentIdx==i ){
  64501. nxDiv = i-2+bBulk;
  64502. }else{
  64503. nxDiv = iParentIdx-1;
  64504. }
  64505. i = 2-bBulk;
  64506. }
  64507. nOld = i+1;
  64508. if( (i+nxDiv-pParent->nOverflow)==pParent->nCell ){
  64509. pRight = &pParent->aData[pParent->hdrOffset+8];
  64510. }else{
  64511. pRight = findCell(pParent, i+nxDiv-pParent->nOverflow);
  64512. }
  64513. pgno = get4byte(pRight);
  64514. while( 1 ){
  64515. rc = getAndInitPage(pBt, pgno, &apOld[i], 0, 0);
  64516. if( rc ){
  64517. memset(apOld, 0, (i+1)*sizeof(MemPage*));
  64518. goto balance_cleanup;
  64519. }
  64520. nMaxCells += 1+apOld[i]->nCell+apOld[i]->nOverflow;
  64521. if( (i--)==0 ) break;
  64522. if( pParent->nOverflow && i+nxDiv==pParent->aiOvfl[0] ){
  64523. apDiv[i] = pParent->apOvfl[0];
  64524. pgno = get4byte(apDiv[i]);
  64525. szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
  64526. pParent->nOverflow = 0;
  64527. }else{
  64528. apDiv[i] = findCell(pParent, i+nxDiv-pParent->nOverflow);
  64529. pgno = get4byte(apDiv[i]);
  64530. szNew[i] = pParent->xCellSize(pParent, apDiv[i]);
  64531. /* Drop the cell from the parent page. apDiv[i] still points to
  64532. ** the cell within the parent, even though it has been dropped.
  64533. ** This is safe because dropping a cell only overwrites the first
  64534. ** four bytes of it, and this function does not need the first
  64535. ** four bytes of the divider cell. So the pointer is safe to use
  64536. ** later on.
  64537. **
  64538. ** But not if we are in secure-delete mode. In secure-delete mode,
  64539. ** the dropCell() routine will overwrite the entire cell with zeroes.
  64540. ** In this case, temporarily copy the cell into the aOvflSpace[]
  64541. ** buffer. It will be copied out again as soon as the aSpace[] buffer
  64542. ** is allocated. */
  64543. if( pBt->btsFlags & BTS_FAST_SECURE ){
  64544. int iOff;
  64545. iOff = SQLITE_PTR_TO_INT(apDiv[i]) - SQLITE_PTR_TO_INT(pParent->aData);
  64546. if( (iOff+szNew[i])>(int)pBt->usableSize ){
  64547. rc = SQLITE_CORRUPT_BKPT;
  64548. memset(apOld, 0, (i+1)*sizeof(MemPage*));
  64549. goto balance_cleanup;
  64550. }else{
  64551. memcpy(&aOvflSpace[iOff], apDiv[i], szNew[i]);
  64552. apDiv[i] = &aOvflSpace[apDiv[i]-pParent->aData];
  64553. }
  64554. }
  64555. dropCell(pParent, i+nxDiv-pParent->nOverflow, szNew[i], &rc);
  64556. }
  64557. }
  64558. /* Make nMaxCells a multiple of 4 in order to preserve 8-byte
  64559. ** alignment */
  64560. nMaxCells = (nMaxCells + 3)&~3;
  64561. /*
  64562. ** Allocate space for memory structures
  64563. */
  64564. szScratch =
  64565. nMaxCells*sizeof(u8*) /* b.apCell */
  64566. + nMaxCells*sizeof(u16) /* b.szCell */
  64567. + pBt->pageSize; /* aSpace1 */
  64568. assert( szScratch<=6*(int)pBt->pageSize );
  64569. b.apCell = sqlite3StackAllocRaw(0, szScratch );
  64570. if( b.apCell==0 ){
  64571. rc = SQLITE_NOMEM_BKPT;
  64572. goto balance_cleanup;
  64573. }
  64574. b.szCell = (u16*)&b.apCell[nMaxCells];
  64575. aSpace1 = (u8*)&b.szCell[nMaxCells];
  64576. assert( EIGHT_BYTE_ALIGNMENT(aSpace1) );
  64577. /*
  64578. ** Load pointers to all cells on sibling pages and the divider cells
  64579. ** into the local b.apCell[] array. Make copies of the divider cells
  64580. ** into space obtained from aSpace1[]. The divider cells have already
  64581. ** been removed from pParent.
  64582. **
  64583. ** If the siblings are on leaf pages, then the child pointers of the
  64584. ** divider cells are stripped from the cells before they are copied
  64585. ** into aSpace1[]. In this way, all cells in b.apCell[] are without
  64586. ** child pointers. If siblings are not leaves, then all cell in
  64587. ** b.apCell[] include child pointers. Either way, all cells in b.apCell[]
  64588. ** are alike.
  64589. **
  64590. ** leafCorrection: 4 if pPage is a leaf. 0 if pPage is not a leaf.
  64591. ** leafData: 1 if pPage holds key+data and pParent holds only keys.
  64592. */
  64593. b.pRef = apOld[0];
  64594. leafCorrection = b.pRef->leaf*4;
  64595. leafData = b.pRef->intKeyLeaf;
  64596. for(i=0; i<nOld; i++){
  64597. MemPage *pOld = apOld[i];
  64598. int limit = pOld->nCell;
  64599. u8 *aData = pOld->aData;
  64600. u16 maskPage = pOld->maskPage;
  64601. u8 *piCell = aData + pOld->cellOffset;
  64602. u8 *piEnd;
  64603. /* Verify that all sibling pages are of the same "type" (table-leaf,
  64604. ** table-interior, index-leaf, or index-interior).
  64605. */
  64606. if( pOld->aData[0]!=apOld[0]->aData[0] ){
  64607. rc = SQLITE_CORRUPT_BKPT;
  64608. goto balance_cleanup;
  64609. }
  64610. /* Load b.apCell[] with pointers to all cells in pOld. If pOld
  64611. ** contains overflow cells, include them in the b.apCell[] array
  64612. ** in the correct spot.
  64613. **
  64614. ** Note that when there are multiple overflow cells, it is always the
  64615. ** case that they are sequential and adjacent. This invariant arises
  64616. ** because multiple overflows can only occurs when inserting divider
  64617. ** cells into a parent on a prior balance, and divider cells are always
  64618. ** adjacent and are inserted in order. There is an assert() tagged
  64619. ** with "NOTE 1" in the overflow cell insertion loop to prove this
  64620. ** invariant.
  64621. **
  64622. ** This must be done in advance. Once the balance starts, the cell
  64623. ** offset section of the btree page will be overwritten and we will no
  64624. ** long be able to find the cells if a pointer to each cell is not saved
  64625. ** first.
  64626. */
  64627. memset(&b.szCell[b.nCell], 0, sizeof(b.szCell[0])*(limit+pOld->nOverflow));
  64628. if( pOld->nOverflow>0 ){
  64629. limit = pOld->aiOvfl[0];
  64630. for(j=0; j<limit; j++){
  64631. b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
  64632. piCell += 2;
  64633. b.nCell++;
  64634. }
  64635. for(k=0; k<pOld->nOverflow; k++){
  64636. assert( k==0 || pOld->aiOvfl[k-1]+1==pOld->aiOvfl[k] );/* NOTE 1 */
  64637. b.apCell[b.nCell] = pOld->apOvfl[k];
  64638. b.nCell++;
  64639. }
  64640. }
  64641. piEnd = aData + pOld->cellOffset + 2*pOld->nCell;
  64642. while( piCell<piEnd ){
  64643. assert( b.nCell<nMaxCells );
  64644. b.apCell[b.nCell] = aData + (maskPage & get2byteAligned(piCell));
  64645. piCell += 2;
  64646. b.nCell++;
  64647. }
  64648. cntOld[i] = b.nCell;
  64649. if( i<nOld-1 && !leafData){
  64650. u16 sz = (u16)szNew[i];
  64651. u8 *pTemp;
  64652. assert( b.nCell<nMaxCells );
  64653. b.szCell[b.nCell] = sz;
  64654. pTemp = &aSpace1[iSpace1];
  64655. iSpace1 += sz;
  64656. assert( sz<=pBt->maxLocal+23 );
  64657. assert( iSpace1 <= (int)pBt->pageSize );
  64658. memcpy(pTemp, apDiv[i], sz);
  64659. b.apCell[b.nCell] = pTemp+leafCorrection;
  64660. assert( leafCorrection==0 || leafCorrection==4 );
  64661. b.szCell[b.nCell] = b.szCell[b.nCell] - leafCorrection;
  64662. if( !pOld->leaf ){
  64663. assert( leafCorrection==0 );
  64664. assert( pOld->hdrOffset==0 );
  64665. /* The right pointer of the child page pOld becomes the left
  64666. ** pointer of the divider cell */
  64667. memcpy(b.apCell[b.nCell], &pOld->aData[8], 4);
  64668. }else{
  64669. assert( leafCorrection==4 );
  64670. while( b.szCell[b.nCell]<4 ){
  64671. /* Do not allow any cells smaller than 4 bytes. If a smaller cell
  64672. ** does exist, pad it with 0x00 bytes. */
  64673. assert( b.szCell[b.nCell]==3 || CORRUPT_DB );
  64674. assert( b.apCell[b.nCell]==&aSpace1[iSpace1-3] || CORRUPT_DB );
  64675. aSpace1[iSpace1++] = 0x00;
  64676. b.szCell[b.nCell]++;
  64677. }
  64678. }
  64679. b.nCell++;
  64680. }
  64681. }
  64682. /*
  64683. ** Figure out the number of pages needed to hold all b.nCell cells.
  64684. ** Store this number in "k". Also compute szNew[] which is the total
  64685. ** size of all cells on the i-th page and cntNew[] which is the index
  64686. ** in b.apCell[] of the cell that divides page i from page i+1.
  64687. ** cntNew[k] should equal b.nCell.
  64688. **
  64689. ** Values computed by this block:
  64690. **
  64691. ** k: The total number of sibling pages
  64692. ** szNew[i]: Spaced used on the i-th sibling page.
  64693. ** cntNew[i]: Index in b.apCell[] and b.szCell[] for the first cell to
  64694. ** the right of the i-th sibling page.
  64695. ** usableSpace: Number of bytes of space available on each sibling.
  64696. **
  64697. */
  64698. usableSpace = pBt->usableSize - 12 + leafCorrection;
  64699. for(i=0; i<nOld; i++){
  64700. MemPage *p = apOld[i];
  64701. szNew[i] = usableSpace - p->nFree;
  64702. for(j=0; j<p->nOverflow; j++){
  64703. szNew[i] += 2 + p->xCellSize(p, p->apOvfl[j]);
  64704. }
  64705. cntNew[i] = cntOld[i];
  64706. }
  64707. k = nOld;
  64708. for(i=0; i<k; i++){
  64709. int sz;
  64710. while( szNew[i]>usableSpace ){
  64711. if( i+1>=k ){
  64712. k = i+2;
  64713. if( k>NB+2 ){ rc = SQLITE_CORRUPT_BKPT; goto balance_cleanup; }
  64714. szNew[k-1] = 0;
  64715. cntNew[k-1] = b.nCell;
  64716. }
  64717. sz = 2 + cachedCellSize(&b, cntNew[i]-1);
  64718. szNew[i] -= sz;
  64719. if( !leafData ){
  64720. if( cntNew[i]<b.nCell ){
  64721. sz = 2 + cachedCellSize(&b, cntNew[i]);
  64722. }else{
  64723. sz = 0;
  64724. }
  64725. }
  64726. szNew[i+1] += sz;
  64727. cntNew[i]--;
  64728. }
  64729. while( cntNew[i]<b.nCell ){
  64730. sz = 2 + cachedCellSize(&b, cntNew[i]);
  64731. if( szNew[i]+sz>usableSpace ) break;
  64732. szNew[i] += sz;
  64733. cntNew[i]++;
  64734. if( !leafData ){
  64735. if( cntNew[i]<b.nCell ){
  64736. sz = 2 + cachedCellSize(&b, cntNew[i]);
  64737. }else{
  64738. sz = 0;
  64739. }
  64740. }
  64741. szNew[i+1] -= sz;
  64742. }
  64743. if( cntNew[i]>=b.nCell ){
  64744. k = i+1;
  64745. }else if( cntNew[i] <= (i>0 ? cntNew[i-1] : 0) ){
  64746. rc = SQLITE_CORRUPT_BKPT;
  64747. goto balance_cleanup;
  64748. }
  64749. }
  64750. /*
  64751. ** The packing computed by the previous block is biased toward the siblings
  64752. ** on the left side (siblings with smaller keys). The left siblings are
  64753. ** always nearly full, while the right-most sibling might be nearly empty.
  64754. ** The next block of code attempts to adjust the packing of siblings to
  64755. ** get a better balance.
  64756. **
  64757. ** This adjustment is more than an optimization. The packing above might
  64758. ** be so out of balance as to be illegal. For example, the right-most
  64759. ** sibling might be completely empty. This adjustment is not optional.
  64760. */
  64761. for(i=k-1; i>0; i--){
  64762. int szRight = szNew[i]; /* Size of sibling on the right */
  64763. int szLeft = szNew[i-1]; /* Size of sibling on the left */
  64764. int r; /* Index of right-most cell in left sibling */
  64765. int d; /* Index of first cell to the left of right sibling */
  64766. r = cntNew[i-1] - 1;
  64767. d = r + 1 - leafData;
  64768. (void)cachedCellSize(&b, d);
  64769. do{
  64770. assert( d<nMaxCells );
  64771. assert( r<nMaxCells );
  64772. (void)cachedCellSize(&b, r);
  64773. if( szRight!=0
  64774. && (bBulk || szRight+b.szCell[d]+2 > szLeft-(b.szCell[r]+(i==k-1?0:2)))){
  64775. break;
  64776. }
  64777. szRight += b.szCell[d] + 2;
  64778. szLeft -= b.szCell[r] + 2;
  64779. cntNew[i-1] = r;
  64780. r--;
  64781. d--;
  64782. }while( r>=0 );
  64783. szNew[i] = szRight;
  64784. szNew[i-1] = szLeft;
  64785. if( cntNew[i-1] <= (i>1 ? cntNew[i-2] : 0) ){
  64786. rc = SQLITE_CORRUPT_BKPT;
  64787. goto balance_cleanup;
  64788. }
  64789. }
  64790. /* Sanity check: For a non-corrupt database file one of the follwing
  64791. ** must be true:
  64792. ** (1) We found one or more cells (cntNew[0])>0), or
  64793. ** (2) pPage is a virtual root page. A virtual root page is when
  64794. ** the real root page is page 1 and we are the only child of
  64795. ** that page.
  64796. */
  64797. assert( cntNew[0]>0 || (pParent->pgno==1 && pParent->nCell==0) || CORRUPT_DB);
  64798. TRACE(("BALANCE: old: %d(nc=%d) %d(nc=%d) %d(nc=%d)\n",
  64799. apOld[0]->pgno, apOld[0]->nCell,
  64800. nOld>=2 ? apOld[1]->pgno : 0, nOld>=2 ? apOld[1]->nCell : 0,
  64801. nOld>=3 ? apOld[2]->pgno : 0, nOld>=3 ? apOld[2]->nCell : 0
  64802. ));
  64803. /*
  64804. ** Allocate k new pages. Reuse old pages where possible.
  64805. */
  64806. pageFlags = apOld[0]->aData[0];
  64807. for(i=0; i<k; i++){
  64808. MemPage *pNew;
  64809. if( i<nOld ){
  64810. pNew = apNew[i] = apOld[i];
  64811. apOld[i] = 0;
  64812. rc = sqlite3PagerWrite(pNew->pDbPage);
  64813. nNew++;
  64814. if( rc ) goto balance_cleanup;
  64815. }else{
  64816. assert( i>0 );
  64817. rc = allocateBtreePage(pBt, &pNew, &pgno, (bBulk ? 1 : pgno), 0);
  64818. if( rc ) goto balance_cleanup;
  64819. zeroPage(pNew, pageFlags);
  64820. apNew[i] = pNew;
  64821. nNew++;
  64822. cntOld[i] = b.nCell;
  64823. /* Set the pointer-map entry for the new sibling page. */
  64824. if( ISAUTOVACUUM ){
  64825. ptrmapPut(pBt, pNew->pgno, PTRMAP_BTREE, pParent->pgno, &rc);
  64826. if( rc!=SQLITE_OK ){
  64827. goto balance_cleanup;
  64828. }
  64829. }
  64830. }
  64831. }
  64832. /*
  64833. ** Reassign page numbers so that the new pages are in ascending order.
  64834. ** This helps to keep entries in the disk file in order so that a scan
  64835. ** of the table is closer to a linear scan through the file. That in turn
  64836. ** helps the operating system to deliver pages from the disk more rapidly.
  64837. **
  64838. ** An O(n^2) insertion sort algorithm is used, but since n is never more
  64839. ** than (NB+2) (a small constant), that should not be a problem.
  64840. **
  64841. ** When NB==3, this one optimization makes the database about 25% faster
  64842. ** for large insertions and deletions.
  64843. */
  64844. for(i=0; i<nNew; i++){
  64845. aPgOrder[i] = aPgno[i] = apNew[i]->pgno;
  64846. aPgFlags[i] = apNew[i]->pDbPage->flags;
  64847. for(j=0; j<i; j++){
  64848. if( aPgno[j]==aPgno[i] ){
  64849. /* This branch is taken if the set of sibling pages somehow contains
  64850. ** duplicate entries. This can happen if the database is corrupt.
  64851. ** It would be simpler to detect this as part of the loop below, but
  64852. ** we do the detection here in order to avoid populating the pager
  64853. ** cache with two separate objects associated with the same
  64854. ** page number. */
  64855. assert( CORRUPT_DB );
  64856. rc = SQLITE_CORRUPT_BKPT;
  64857. goto balance_cleanup;
  64858. }
  64859. }
  64860. }
  64861. for(i=0; i<nNew; i++){
  64862. int iBest = 0; /* aPgno[] index of page number to use */
  64863. for(j=1; j<nNew; j++){
  64864. if( aPgOrder[j]<aPgOrder[iBest] ) iBest = j;
  64865. }
  64866. pgno = aPgOrder[iBest];
  64867. aPgOrder[iBest] = 0xffffffff;
  64868. if( iBest!=i ){
  64869. if( iBest>i ){
  64870. sqlite3PagerRekey(apNew[iBest]->pDbPage, pBt->nPage+iBest+1, 0);
  64871. }
  64872. sqlite3PagerRekey(apNew[i]->pDbPage, pgno, aPgFlags[iBest]);
  64873. apNew[i]->pgno = pgno;
  64874. }
  64875. }
  64876. TRACE(("BALANCE: new: %d(%d nc=%d) %d(%d nc=%d) %d(%d nc=%d) "
  64877. "%d(%d nc=%d) %d(%d nc=%d)\n",
  64878. apNew[0]->pgno, szNew[0], cntNew[0],
  64879. nNew>=2 ? apNew[1]->pgno : 0, nNew>=2 ? szNew[1] : 0,
  64880. nNew>=2 ? cntNew[1] - cntNew[0] - !leafData : 0,
  64881. nNew>=3 ? apNew[2]->pgno : 0, nNew>=3 ? szNew[2] : 0,
  64882. nNew>=3 ? cntNew[2] - cntNew[1] - !leafData : 0,
  64883. nNew>=4 ? apNew[3]->pgno : 0, nNew>=4 ? szNew[3] : 0,
  64884. nNew>=4 ? cntNew[3] - cntNew[2] - !leafData : 0,
  64885. nNew>=5 ? apNew[4]->pgno : 0, nNew>=5 ? szNew[4] : 0,
  64886. nNew>=5 ? cntNew[4] - cntNew[3] - !leafData : 0
  64887. ));
  64888. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  64889. put4byte(pRight, apNew[nNew-1]->pgno);
  64890. /* If the sibling pages are not leaves, ensure that the right-child pointer
  64891. ** of the right-most new sibling page is set to the value that was
  64892. ** originally in the same field of the right-most old sibling page. */
  64893. if( (pageFlags & PTF_LEAF)==0 && nOld!=nNew ){
  64894. MemPage *pOld = (nNew>nOld ? apNew : apOld)[nOld-1];
  64895. memcpy(&apNew[nNew-1]->aData[8], &pOld->aData[8], 4);
  64896. }
  64897. /* Make any required updates to pointer map entries associated with
  64898. ** cells stored on sibling pages following the balance operation. Pointer
  64899. ** map entries associated with divider cells are set by the insertCell()
  64900. ** routine. The associated pointer map entries are:
  64901. **
  64902. ** a) if the cell contains a reference to an overflow chain, the
  64903. ** entry associated with the first page in the overflow chain, and
  64904. **
  64905. ** b) if the sibling pages are not leaves, the child page associated
  64906. ** with the cell.
  64907. **
  64908. ** If the sibling pages are not leaves, then the pointer map entry
  64909. ** associated with the right-child of each sibling may also need to be
  64910. ** updated. This happens below, after the sibling pages have been
  64911. ** populated, not here.
  64912. */
  64913. if( ISAUTOVACUUM ){
  64914. MemPage *pNew = apNew[0];
  64915. u8 *aOld = pNew->aData;
  64916. int cntOldNext = pNew->nCell + pNew->nOverflow;
  64917. int usableSize = pBt->usableSize;
  64918. int iNew = 0;
  64919. int iOld = 0;
  64920. for(i=0; i<b.nCell; i++){
  64921. u8 *pCell = b.apCell[i];
  64922. if( i==cntOldNext ){
  64923. MemPage *pOld = (++iOld)<nNew ? apNew[iOld] : apOld[iOld];
  64924. cntOldNext += pOld->nCell + pOld->nOverflow + !leafData;
  64925. aOld = pOld->aData;
  64926. }
  64927. if( i==cntNew[iNew] ){
  64928. pNew = apNew[++iNew];
  64929. if( !leafData ) continue;
  64930. }
  64931. /* Cell pCell is destined for new sibling page pNew. Originally, it
  64932. ** was either part of sibling page iOld (possibly an overflow cell),
  64933. ** or else the divider cell to the left of sibling page iOld. So,
  64934. ** if sibling page iOld had the same page number as pNew, and if
  64935. ** pCell really was a part of sibling page iOld (not a divider or
  64936. ** overflow cell), we can skip updating the pointer map entries. */
  64937. if( iOld>=nNew
  64938. || pNew->pgno!=aPgno[iOld]
  64939. || !SQLITE_WITHIN(pCell,aOld,&aOld[usableSize])
  64940. ){
  64941. if( !leafCorrection ){
  64942. ptrmapPut(pBt, get4byte(pCell), PTRMAP_BTREE, pNew->pgno, &rc);
  64943. }
  64944. if( cachedCellSize(&b,i)>pNew->minLocal ){
  64945. ptrmapPutOvflPtr(pNew, pCell, &rc);
  64946. }
  64947. if( rc ) goto balance_cleanup;
  64948. }
  64949. }
  64950. }
  64951. /* Insert new divider cells into pParent. */
  64952. for(i=0; i<nNew-1; i++){
  64953. u8 *pCell;
  64954. u8 *pTemp;
  64955. int sz;
  64956. MemPage *pNew = apNew[i];
  64957. j = cntNew[i];
  64958. assert( j<nMaxCells );
  64959. assert( b.apCell[j]!=0 );
  64960. pCell = b.apCell[j];
  64961. sz = b.szCell[j] + leafCorrection;
  64962. pTemp = &aOvflSpace[iOvflSpace];
  64963. if( !pNew->leaf ){
  64964. memcpy(&pNew->aData[8], pCell, 4);
  64965. }else if( leafData ){
  64966. /* If the tree is a leaf-data tree, and the siblings are leaves,
  64967. ** then there is no divider cell in b.apCell[]. Instead, the divider
  64968. ** cell consists of the integer key for the right-most cell of
  64969. ** the sibling-page assembled above only.
  64970. */
  64971. CellInfo info;
  64972. j--;
  64973. pNew->xParseCell(pNew, b.apCell[j], &info);
  64974. pCell = pTemp;
  64975. sz = 4 + putVarint(&pCell[4], info.nKey);
  64976. pTemp = 0;
  64977. }else{
  64978. pCell -= 4;
  64979. /* Obscure case for non-leaf-data trees: If the cell at pCell was
  64980. ** previously stored on a leaf node, and its reported size was 4
  64981. ** bytes, then it may actually be smaller than this
  64982. ** (see btreeParseCellPtr(), 4 bytes is the minimum size of
  64983. ** any cell). But it is important to pass the correct size to
  64984. ** insertCell(), so reparse the cell now.
  64985. **
  64986. ** This can only happen for b-trees used to evaluate "IN (SELECT ...)"
  64987. ** and WITHOUT ROWID tables with exactly one column which is the
  64988. ** primary key.
  64989. */
  64990. if( b.szCell[j]==4 ){
  64991. assert(leafCorrection==4);
  64992. sz = pParent->xCellSize(pParent, pCell);
  64993. }
  64994. }
  64995. iOvflSpace += sz;
  64996. assert( sz<=pBt->maxLocal+23 );
  64997. assert( iOvflSpace <= (int)pBt->pageSize );
  64998. insertCell(pParent, nxDiv+i, pCell, sz, pTemp, pNew->pgno, &rc);
  64999. if( rc!=SQLITE_OK ) goto balance_cleanup;
  65000. assert( sqlite3PagerIswriteable(pParent->pDbPage) );
  65001. }
  65002. /* Now update the actual sibling pages. The order in which they are updated
  65003. ** is important, as this code needs to avoid disrupting any page from which
  65004. ** cells may still to be read. In practice, this means:
  65005. **
  65006. ** (1) If cells are moving left (from apNew[iPg] to apNew[iPg-1])
  65007. ** then it is not safe to update page apNew[iPg] until after
  65008. ** the left-hand sibling apNew[iPg-1] has been updated.
  65009. **
  65010. ** (2) If cells are moving right (from apNew[iPg] to apNew[iPg+1])
  65011. ** then it is not safe to update page apNew[iPg] until after
  65012. ** the right-hand sibling apNew[iPg+1] has been updated.
  65013. **
  65014. ** If neither of the above apply, the page is safe to update.
  65015. **
  65016. ** The iPg value in the following loop starts at nNew-1 goes down
  65017. ** to 0, then back up to nNew-1 again, thus making two passes over
  65018. ** the pages. On the initial downward pass, only condition (1) above
  65019. ** needs to be tested because (2) will always be true from the previous
  65020. ** step. On the upward pass, both conditions are always true, so the
  65021. ** upwards pass simply processes pages that were missed on the downward
  65022. ** pass.
  65023. */
  65024. for(i=1-nNew; i<nNew; i++){
  65025. int iPg = i<0 ? -i : i;
  65026. assert( iPg>=0 && iPg<nNew );
  65027. if( abDone[iPg] ) continue; /* Skip pages already processed */
  65028. if( i>=0 /* On the upwards pass, or... */
  65029. || cntOld[iPg-1]>=cntNew[iPg-1] /* Condition (1) is true */
  65030. ){
  65031. int iNew;
  65032. int iOld;
  65033. int nNewCell;
  65034. /* Verify condition (1): If cells are moving left, update iPg
  65035. ** only after iPg-1 has already been updated. */
  65036. assert( iPg==0 || cntOld[iPg-1]>=cntNew[iPg-1] || abDone[iPg-1] );
  65037. /* Verify condition (2): If cells are moving right, update iPg
  65038. ** only after iPg+1 has already been updated. */
  65039. assert( cntNew[iPg]>=cntOld[iPg] || abDone[iPg+1] );
  65040. if( iPg==0 ){
  65041. iNew = iOld = 0;
  65042. nNewCell = cntNew[0];
  65043. }else{
  65044. iOld = iPg<nOld ? (cntOld[iPg-1] + !leafData) : b.nCell;
  65045. iNew = cntNew[iPg-1] + !leafData;
  65046. nNewCell = cntNew[iPg] - iNew;
  65047. }
  65048. rc = editPage(apNew[iPg], iOld, iNew, nNewCell, &b);
  65049. if( rc ) goto balance_cleanup;
  65050. abDone[iPg]++;
  65051. apNew[iPg]->nFree = usableSpace-szNew[iPg];
  65052. assert( apNew[iPg]->nOverflow==0 );
  65053. assert( apNew[iPg]->nCell==nNewCell );
  65054. }
  65055. }
  65056. /* All pages have been processed exactly once */
  65057. assert( memcmp(abDone, "\01\01\01\01\01", nNew)==0 );
  65058. assert( nOld>0 );
  65059. assert( nNew>0 );
  65060. if( isRoot && pParent->nCell==0 && pParent->hdrOffset<=apNew[0]->nFree ){
  65061. /* The root page of the b-tree now contains no cells. The only sibling
  65062. ** page is the right-child of the parent. Copy the contents of the
  65063. ** child page into the parent, decreasing the overall height of the
  65064. ** b-tree structure by one. This is described as the "balance-shallower"
  65065. ** sub-algorithm in some documentation.
  65066. **
  65067. ** If this is an auto-vacuum database, the call to copyNodeContent()
  65068. ** sets all pointer-map entries corresponding to database image pages
  65069. ** for which the pointer is stored within the content being copied.
  65070. **
  65071. ** It is critical that the child page be defragmented before being
  65072. ** copied into the parent, because if the parent is page 1 then it will
  65073. ** by smaller than the child due to the database header, and so all the
  65074. ** free space needs to be up front.
  65075. */
  65076. assert( nNew==1 || CORRUPT_DB );
  65077. rc = defragmentPage(apNew[0], -1);
  65078. testcase( rc!=SQLITE_OK );
  65079. assert( apNew[0]->nFree ==
  65080. (get2byte(&apNew[0]->aData[5])-apNew[0]->cellOffset-apNew[0]->nCell*2)
  65081. || rc!=SQLITE_OK
  65082. );
  65083. copyNodeContent(apNew[0], pParent, &rc);
  65084. freePage(apNew[0], &rc);
  65085. }else if( ISAUTOVACUUM && !leafCorrection ){
  65086. /* Fix the pointer map entries associated with the right-child of each
  65087. ** sibling page. All other pointer map entries have already been taken
  65088. ** care of. */
  65089. for(i=0; i<nNew; i++){
  65090. u32 key = get4byte(&apNew[i]->aData[8]);
  65091. ptrmapPut(pBt, key, PTRMAP_BTREE, apNew[i]->pgno, &rc);
  65092. }
  65093. }
  65094. assert( pParent->isInit );
  65095. TRACE(("BALANCE: finished: old=%d new=%d cells=%d\n",
  65096. nOld, nNew, b.nCell));
  65097. /* Free any old pages that were not reused as new pages.
  65098. */
  65099. for(i=nNew; i<nOld; i++){
  65100. freePage(apOld[i], &rc);
  65101. }
  65102. #if 0
  65103. if( ISAUTOVACUUM && rc==SQLITE_OK && apNew[0]->isInit ){
  65104. /* The ptrmapCheckPages() contains assert() statements that verify that
  65105. ** all pointer map pages are set correctly. This is helpful while
  65106. ** debugging. This is usually disabled because a corrupt database may
  65107. ** cause an assert() statement to fail. */
  65108. ptrmapCheckPages(apNew, nNew);
  65109. ptrmapCheckPages(&pParent, 1);
  65110. }
  65111. #endif
  65112. /*
  65113. ** Cleanup before returning.
  65114. */
  65115. balance_cleanup:
  65116. sqlite3StackFree(0, b.apCell);
  65117. for(i=0; i<nOld; i++){
  65118. releasePage(apOld[i]);
  65119. }
  65120. for(i=0; i<nNew; i++){
  65121. releasePage(apNew[i]);
  65122. }
  65123. return rc;
  65124. }
  65125. /*
  65126. ** This function is called when the root page of a b-tree structure is
  65127. ** overfull (has one or more overflow pages).
  65128. **
  65129. ** A new child page is allocated and the contents of the current root
  65130. ** page, including overflow cells, are copied into the child. The root
  65131. ** page is then overwritten to make it an empty page with the right-child
  65132. ** pointer pointing to the new page.
  65133. **
  65134. ** Before returning, all pointer-map entries corresponding to pages
  65135. ** that the new child-page now contains pointers to are updated. The
  65136. ** entry corresponding to the new right-child pointer of the root
  65137. ** page is also updated.
  65138. **
  65139. ** If successful, *ppChild is set to contain a reference to the child
  65140. ** page and SQLITE_OK is returned. In this case the caller is required
  65141. ** to call releasePage() on *ppChild exactly once. If an error occurs,
  65142. ** an error code is returned and *ppChild is set to 0.
  65143. */
  65144. static int balance_deeper(MemPage *pRoot, MemPage **ppChild){
  65145. int rc; /* Return value from subprocedures */
  65146. MemPage *pChild = 0; /* Pointer to a new child page */
  65147. Pgno pgnoChild = 0; /* Page number of the new child page */
  65148. BtShared *pBt = pRoot->pBt; /* The BTree */
  65149. assert( pRoot->nOverflow>0 );
  65150. assert( sqlite3_mutex_held(pBt->mutex) );
  65151. /* Make pRoot, the root page of the b-tree, writable. Allocate a new
  65152. ** page that will become the new right-child of pPage. Copy the contents
  65153. ** of the node stored on pRoot into the new child page.
  65154. */
  65155. rc = sqlite3PagerWrite(pRoot->pDbPage);
  65156. if( rc==SQLITE_OK ){
  65157. rc = allocateBtreePage(pBt,&pChild,&pgnoChild,pRoot->pgno,0);
  65158. copyNodeContent(pRoot, pChild, &rc);
  65159. if( ISAUTOVACUUM ){
  65160. ptrmapPut(pBt, pgnoChild, PTRMAP_BTREE, pRoot->pgno, &rc);
  65161. }
  65162. }
  65163. if( rc ){
  65164. *ppChild = 0;
  65165. releasePage(pChild);
  65166. return rc;
  65167. }
  65168. assert( sqlite3PagerIswriteable(pChild->pDbPage) );
  65169. assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
  65170. assert( pChild->nCell==pRoot->nCell );
  65171. TRACE(("BALANCE: copy root %d into %d\n", pRoot->pgno, pChild->pgno));
  65172. /* Copy the overflow cells from pRoot to pChild */
  65173. memcpy(pChild->aiOvfl, pRoot->aiOvfl,
  65174. pRoot->nOverflow*sizeof(pRoot->aiOvfl[0]));
  65175. memcpy(pChild->apOvfl, pRoot->apOvfl,
  65176. pRoot->nOverflow*sizeof(pRoot->apOvfl[0]));
  65177. pChild->nOverflow = pRoot->nOverflow;
  65178. /* Zero the contents of pRoot. Then install pChild as the right-child. */
  65179. zeroPage(pRoot, pChild->aData[0] & ~PTF_LEAF);
  65180. put4byte(&pRoot->aData[pRoot->hdrOffset+8], pgnoChild);
  65181. *ppChild = pChild;
  65182. return SQLITE_OK;
  65183. }
  65184. /*
  65185. ** The page that pCur currently points to has just been modified in
  65186. ** some way. This function figures out if this modification means the
  65187. ** tree needs to be balanced, and if so calls the appropriate balancing
  65188. ** routine. Balancing routines are:
  65189. **
  65190. ** balance_quick()
  65191. ** balance_deeper()
  65192. ** balance_nonroot()
  65193. */
  65194. static int balance(BtCursor *pCur){
  65195. int rc = SQLITE_OK;
  65196. const int nMin = pCur->pBt->usableSize * 2 / 3;
  65197. u8 aBalanceQuickSpace[13];
  65198. u8 *pFree = 0;
  65199. VVA_ONLY( int balance_quick_called = 0 );
  65200. VVA_ONLY( int balance_deeper_called = 0 );
  65201. do {
  65202. int iPage = pCur->iPage;
  65203. MemPage *pPage = pCur->pPage;
  65204. if( iPage==0 ){
  65205. if( pPage->nOverflow ){
  65206. /* The root page of the b-tree is overfull. In this case call the
  65207. ** balance_deeper() function to create a new child for the root-page
  65208. ** and copy the current contents of the root-page to it. The
  65209. ** next iteration of the do-loop will balance the child page.
  65210. */
  65211. assert( balance_deeper_called==0 );
  65212. VVA_ONLY( balance_deeper_called++ );
  65213. rc = balance_deeper(pPage, &pCur->apPage[1]);
  65214. if( rc==SQLITE_OK ){
  65215. pCur->iPage = 1;
  65216. pCur->ix = 0;
  65217. pCur->aiIdx[0] = 0;
  65218. pCur->apPage[0] = pPage;
  65219. pCur->pPage = pCur->apPage[1];
  65220. assert( pCur->pPage->nOverflow );
  65221. }
  65222. }else{
  65223. break;
  65224. }
  65225. }else if( pPage->nOverflow==0 && pPage->nFree<=nMin ){
  65226. break;
  65227. }else{
  65228. MemPage * const pParent = pCur->apPage[iPage-1];
  65229. int const iIdx = pCur->aiIdx[iPage-1];
  65230. rc = sqlite3PagerWrite(pParent->pDbPage);
  65231. if( rc==SQLITE_OK ){
  65232. #ifndef SQLITE_OMIT_QUICKBALANCE
  65233. if( pPage->intKeyLeaf
  65234. && pPage->nOverflow==1
  65235. && pPage->aiOvfl[0]==pPage->nCell
  65236. && pParent->pgno!=1
  65237. && pParent->nCell==iIdx
  65238. ){
  65239. /* Call balance_quick() to create a new sibling of pPage on which
  65240. ** to store the overflow cell. balance_quick() inserts a new cell
  65241. ** into pParent, which may cause pParent overflow. If this
  65242. ** happens, the next iteration of the do-loop will balance pParent
  65243. ** use either balance_nonroot() or balance_deeper(). Until this
  65244. ** happens, the overflow cell is stored in the aBalanceQuickSpace[]
  65245. ** buffer.
  65246. **
  65247. ** The purpose of the following assert() is to check that only a
  65248. ** single call to balance_quick() is made for each call to this
  65249. ** function. If this were not verified, a subtle bug involving reuse
  65250. ** of the aBalanceQuickSpace[] might sneak in.
  65251. */
  65252. assert( balance_quick_called==0 );
  65253. VVA_ONLY( balance_quick_called++ );
  65254. rc = balance_quick(pParent, pPage, aBalanceQuickSpace);
  65255. }else
  65256. #endif
  65257. {
  65258. /* In this case, call balance_nonroot() to redistribute cells
  65259. ** between pPage and up to 2 of its sibling pages. This involves
  65260. ** modifying the contents of pParent, which may cause pParent to
  65261. ** become overfull or underfull. The next iteration of the do-loop
  65262. ** will balance the parent page to correct this.
  65263. **
  65264. ** If the parent page becomes overfull, the overflow cell or cells
  65265. ** are stored in the pSpace buffer allocated immediately below.
  65266. ** A subsequent iteration of the do-loop will deal with this by
  65267. ** calling balance_nonroot() (balance_deeper() may be called first,
  65268. ** but it doesn't deal with overflow cells - just moves them to a
  65269. ** different page). Once this subsequent call to balance_nonroot()
  65270. ** has completed, it is safe to release the pSpace buffer used by
  65271. ** the previous call, as the overflow cell data will have been
  65272. ** copied either into the body of a database page or into the new
  65273. ** pSpace buffer passed to the latter call to balance_nonroot().
  65274. */
  65275. u8 *pSpace = sqlite3PageMalloc(pCur->pBt->pageSize);
  65276. rc = balance_nonroot(pParent, iIdx, pSpace, iPage==1,
  65277. pCur->hints&BTREE_BULKLOAD);
  65278. if( pFree ){
  65279. /* If pFree is not NULL, it points to the pSpace buffer used
  65280. ** by a previous call to balance_nonroot(). Its contents are
  65281. ** now stored either on real database pages or within the
  65282. ** new pSpace buffer, so it may be safely freed here. */
  65283. sqlite3PageFree(pFree);
  65284. }
  65285. /* The pSpace buffer will be freed after the next call to
  65286. ** balance_nonroot(), or just before this function returns, whichever
  65287. ** comes first. */
  65288. pFree = pSpace;
  65289. }
  65290. }
  65291. pPage->nOverflow = 0;
  65292. /* The next iteration of the do-loop balances the parent page. */
  65293. releasePage(pPage);
  65294. pCur->iPage--;
  65295. assert( pCur->iPage>=0 );
  65296. pCur->pPage = pCur->apPage[pCur->iPage];
  65297. }
  65298. }while( rc==SQLITE_OK );
  65299. if( pFree ){
  65300. sqlite3PageFree(pFree);
  65301. }
  65302. return rc;
  65303. }
  65304. /*
  65305. ** Insert a new record into the BTree. The content of the new record
  65306. ** is described by the pX object. The pCur cursor is used only to
  65307. ** define what table the record should be inserted into, and is left
  65308. ** pointing at a random location.
  65309. **
  65310. ** For a table btree (used for rowid tables), only the pX.nKey value of
  65311. ** the key is used. The pX.pKey value must be NULL. The pX.nKey is the
  65312. ** rowid or INTEGER PRIMARY KEY of the row. The pX.nData,pData,nZero fields
  65313. ** hold the content of the row.
  65314. **
  65315. ** For an index btree (used for indexes and WITHOUT ROWID tables), the
  65316. ** key is an arbitrary byte sequence stored in pX.pKey,nKey. The
  65317. ** pX.pData,nData,nZero fields must be zero.
  65318. **
  65319. ** If the seekResult parameter is non-zero, then a successful call to
  65320. ** MovetoUnpacked() to seek cursor pCur to (pKey,nKey) has already
  65321. ** been performed. In other words, if seekResult!=0 then the cursor
  65322. ** is currently pointing to a cell that will be adjacent to the cell
  65323. ** to be inserted. If seekResult<0 then pCur points to a cell that is
  65324. ** smaller then (pKey,nKey). If seekResult>0 then pCur points to a cell
  65325. ** that is larger than (pKey,nKey).
  65326. **
  65327. ** If seekResult==0, that means pCur is pointing at some unknown location.
  65328. ** In that case, this routine must seek the cursor to the correct insertion
  65329. ** point for (pKey,nKey) before doing the insertion. For index btrees,
  65330. ** if pX->nMem is non-zero, then pX->aMem contains pointers to the unpacked
  65331. ** key values and pX->aMem can be used instead of pX->pKey to avoid having
  65332. ** to decode the key.
  65333. */
  65334. SQLITE_PRIVATE int sqlite3BtreeInsert(
  65335. BtCursor *pCur, /* Insert data into the table of this cursor */
  65336. const BtreePayload *pX, /* Content of the row to be inserted */
  65337. int flags, /* True if this is likely an append */
  65338. int seekResult /* Result of prior MovetoUnpacked() call */
  65339. ){
  65340. int rc;
  65341. int loc = seekResult; /* -1: before desired location +1: after */
  65342. int szNew = 0;
  65343. int idx;
  65344. MemPage *pPage;
  65345. Btree *p = pCur->pBtree;
  65346. BtShared *pBt = p->pBt;
  65347. unsigned char *oldCell;
  65348. unsigned char *newCell = 0;
  65349. assert( (flags & (BTREE_SAVEPOSITION|BTREE_APPEND))==flags );
  65350. if( pCur->eState==CURSOR_FAULT ){
  65351. assert( pCur->skipNext!=SQLITE_OK );
  65352. return pCur->skipNext;
  65353. }
  65354. assert( cursorOwnsBtShared(pCur) );
  65355. assert( (pCur->curFlags & BTCF_WriteFlag)!=0
  65356. && pBt->inTransaction==TRANS_WRITE
  65357. && (pBt->btsFlags & BTS_READ_ONLY)==0 );
  65358. assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
  65359. /* Assert that the caller has been consistent. If this cursor was opened
  65360. ** expecting an index b-tree, then the caller should be inserting blob
  65361. ** keys with no associated data. If the cursor was opened expecting an
  65362. ** intkey table, the caller should be inserting integer keys with a
  65363. ** blob of associated data. */
  65364. assert( (pX->pKey==0)==(pCur->pKeyInfo==0) );
  65365. /* Save the positions of any other cursors open on this table.
  65366. **
  65367. ** In some cases, the call to btreeMoveto() below is a no-op. For
  65368. ** example, when inserting data into a table with auto-generated integer
  65369. ** keys, the VDBE layer invokes sqlite3BtreeLast() to figure out the
  65370. ** integer key to use. It then calls this function to actually insert the
  65371. ** data into the intkey B-Tree. In this case btreeMoveto() recognizes
  65372. ** that the cursor is already where it needs to be and returns without
  65373. ** doing any work. To avoid thwarting these optimizations, it is important
  65374. ** not to clear the cursor here.
  65375. */
  65376. if( pCur->curFlags & BTCF_Multiple ){
  65377. rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
  65378. if( rc ) return rc;
  65379. }
  65380. if( pCur->pKeyInfo==0 ){
  65381. assert( pX->pKey==0 );
  65382. /* If this is an insert into a table b-tree, invalidate any incrblob
  65383. ** cursors open on the row being replaced */
  65384. invalidateIncrblobCursors(p, pCur->pgnoRoot, pX->nKey, 0);
  65385. /* If BTREE_SAVEPOSITION is set, the cursor must already be pointing
  65386. ** to a row with the same key as the new entry being inserted. */
  65387. assert( (flags & BTREE_SAVEPOSITION)==0 ||
  65388. ((pCur->curFlags&BTCF_ValidNKey)!=0 && pX->nKey==pCur->info.nKey) );
  65389. /* If the cursor is currently on the last row and we are appending a
  65390. ** new row onto the end, set the "loc" to avoid an unnecessary
  65391. ** btreeMoveto() call */
  65392. if( (pCur->curFlags&BTCF_ValidNKey)!=0 && pX->nKey==pCur->info.nKey ){
  65393. loc = 0;
  65394. }else if( loc==0 ){
  65395. rc = sqlite3BtreeMovetoUnpacked(pCur, 0, pX->nKey, flags!=0, &loc);
  65396. if( rc ) return rc;
  65397. }
  65398. }else if( loc==0 && (flags & BTREE_SAVEPOSITION)==0 ){
  65399. if( pX->nMem ){
  65400. UnpackedRecord r;
  65401. r.pKeyInfo = pCur->pKeyInfo;
  65402. r.aMem = pX->aMem;
  65403. r.nField = pX->nMem;
  65404. r.default_rc = 0;
  65405. r.errCode = 0;
  65406. r.r1 = 0;
  65407. r.r2 = 0;
  65408. r.eqSeen = 0;
  65409. rc = sqlite3BtreeMovetoUnpacked(pCur, &r, 0, flags!=0, &loc);
  65410. }else{
  65411. rc = btreeMoveto(pCur, pX->pKey, pX->nKey, flags!=0, &loc);
  65412. }
  65413. if( rc ) return rc;
  65414. }
  65415. assert( pCur->eState==CURSOR_VALID || (pCur->eState==CURSOR_INVALID && loc) );
  65416. pPage = pCur->pPage;
  65417. assert( pPage->intKey || pX->nKey>=0 );
  65418. assert( pPage->leaf || !pPage->intKey );
  65419. TRACE(("INSERT: table=%d nkey=%lld ndata=%d page=%d %s\n",
  65420. pCur->pgnoRoot, pX->nKey, pX->nData, pPage->pgno,
  65421. loc==0 ? "overwrite" : "new entry"));
  65422. assert( pPage->isInit );
  65423. newCell = pBt->pTmpSpace;
  65424. assert( newCell!=0 );
  65425. rc = fillInCell(pPage, newCell, pX, &szNew);
  65426. if( rc ) goto end_insert;
  65427. assert( szNew==pPage->xCellSize(pPage, newCell) );
  65428. assert( szNew <= MX_CELL_SIZE(pBt) );
  65429. idx = pCur->ix;
  65430. if( loc==0 ){
  65431. CellInfo info;
  65432. assert( idx<pPage->nCell );
  65433. rc = sqlite3PagerWrite(pPage->pDbPage);
  65434. if( rc ){
  65435. goto end_insert;
  65436. }
  65437. oldCell = findCell(pPage, idx);
  65438. if( !pPage->leaf ){
  65439. memcpy(newCell, oldCell, 4);
  65440. }
  65441. rc = clearCell(pPage, oldCell, &info);
  65442. if( info.nSize==szNew && info.nLocal==info.nPayload
  65443. && (!ISAUTOVACUUM || szNew<pPage->minLocal)
  65444. ){
  65445. /* Overwrite the old cell with the new if they are the same size.
  65446. ** We could also try to do this if the old cell is smaller, then add
  65447. ** the leftover space to the free list. But experiments show that
  65448. ** doing that is no faster then skipping this optimization and just
  65449. ** calling dropCell() and insertCell().
  65450. **
  65451. ** This optimization cannot be used on an autovacuum database if the
  65452. ** new entry uses overflow pages, as the insertCell() call below is
  65453. ** necessary to add the PTRMAP_OVERFLOW1 pointer-map entry. */
  65454. assert( rc==SQLITE_OK ); /* clearCell never fails when nLocal==nPayload */
  65455. if( oldCell+szNew > pPage->aDataEnd ) return SQLITE_CORRUPT_BKPT;
  65456. memcpy(oldCell, newCell, szNew);
  65457. return SQLITE_OK;
  65458. }
  65459. dropCell(pPage, idx, info.nSize, &rc);
  65460. if( rc ) goto end_insert;
  65461. }else if( loc<0 && pPage->nCell>0 ){
  65462. assert( pPage->leaf );
  65463. idx = ++pCur->ix;
  65464. pCur->curFlags &= ~BTCF_ValidNKey;
  65465. }else{
  65466. assert( pPage->leaf );
  65467. }
  65468. insertCell(pPage, idx, newCell, szNew, 0, 0, &rc);
  65469. assert( pPage->nOverflow==0 || rc==SQLITE_OK );
  65470. assert( rc!=SQLITE_OK || pPage->nCell>0 || pPage->nOverflow>0 );
  65471. /* If no error has occurred and pPage has an overflow cell, call balance()
  65472. ** to redistribute the cells within the tree. Since balance() may move
  65473. ** the cursor, zero the BtCursor.info.nSize and BTCF_ValidNKey
  65474. ** variables.
  65475. **
  65476. ** Previous versions of SQLite called moveToRoot() to move the cursor
  65477. ** back to the root page as balance() used to invalidate the contents
  65478. ** of BtCursor.apPage[] and BtCursor.aiIdx[]. Instead of doing that,
  65479. ** set the cursor state to "invalid". This makes common insert operations
  65480. ** slightly faster.
  65481. **
  65482. ** There is a subtle but important optimization here too. When inserting
  65483. ** multiple records into an intkey b-tree using a single cursor (as can
  65484. ** happen while processing an "INSERT INTO ... SELECT" statement), it
  65485. ** is advantageous to leave the cursor pointing to the last entry in
  65486. ** the b-tree if possible. If the cursor is left pointing to the last
  65487. ** entry in the table, and the next row inserted has an integer key
  65488. ** larger than the largest existing key, it is possible to insert the
  65489. ** row without seeking the cursor. This can be a big performance boost.
  65490. */
  65491. pCur->info.nSize = 0;
  65492. if( pPage->nOverflow ){
  65493. assert( rc==SQLITE_OK );
  65494. pCur->curFlags &= ~(BTCF_ValidNKey);
  65495. rc = balance(pCur);
  65496. /* Must make sure nOverflow is reset to zero even if the balance()
  65497. ** fails. Internal data structure corruption will result otherwise.
  65498. ** Also, set the cursor state to invalid. This stops saveCursorPosition()
  65499. ** from trying to save the current position of the cursor. */
  65500. pCur->pPage->nOverflow = 0;
  65501. pCur->eState = CURSOR_INVALID;
  65502. if( (flags & BTREE_SAVEPOSITION) && rc==SQLITE_OK ){
  65503. btreeReleaseAllCursorPages(pCur);
  65504. if( pCur->pKeyInfo ){
  65505. assert( pCur->pKey==0 );
  65506. pCur->pKey = sqlite3Malloc( pX->nKey );
  65507. if( pCur->pKey==0 ){
  65508. rc = SQLITE_NOMEM;
  65509. }else{
  65510. memcpy(pCur->pKey, pX->pKey, pX->nKey);
  65511. }
  65512. }
  65513. pCur->eState = CURSOR_REQUIRESEEK;
  65514. pCur->nKey = pX->nKey;
  65515. }
  65516. }
  65517. assert( pCur->iPage<0 || pCur->pPage->nOverflow==0 );
  65518. end_insert:
  65519. return rc;
  65520. }
  65521. /*
  65522. ** Delete the entry that the cursor is pointing to.
  65523. **
  65524. ** If the BTREE_SAVEPOSITION bit of the flags parameter is zero, then
  65525. ** the cursor is left pointing at an arbitrary location after the delete.
  65526. ** But if that bit is set, then the cursor is left in a state such that
  65527. ** the next call to BtreeNext() or BtreePrev() moves it to the same row
  65528. ** as it would have been on if the call to BtreeDelete() had been omitted.
  65529. **
  65530. ** The BTREE_AUXDELETE bit of flags indicates that is one of several deletes
  65531. ** associated with a single table entry and its indexes. Only one of those
  65532. ** deletes is considered the "primary" delete. The primary delete occurs
  65533. ** on a cursor that is not a BTREE_FORDELETE cursor. All but one delete
  65534. ** operation on non-FORDELETE cursors is tagged with the AUXDELETE flag.
  65535. ** The BTREE_AUXDELETE bit is a hint that is not used by this implementation,
  65536. ** but which might be used by alternative storage engines.
  65537. */
  65538. SQLITE_PRIVATE int sqlite3BtreeDelete(BtCursor *pCur, u8 flags){
  65539. Btree *p = pCur->pBtree;
  65540. BtShared *pBt = p->pBt;
  65541. int rc; /* Return code */
  65542. MemPage *pPage; /* Page to delete cell from */
  65543. unsigned char *pCell; /* Pointer to cell to delete */
  65544. int iCellIdx; /* Index of cell to delete */
  65545. int iCellDepth; /* Depth of node containing pCell */
  65546. CellInfo info; /* Size of the cell being deleted */
  65547. int bSkipnext = 0; /* Leaf cursor in SKIPNEXT state */
  65548. u8 bPreserve = flags & BTREE_SAVEPOSITION; /* Keep cursor valid */
  65549. assert( cursorOwnsBtShared(pCur) );
  65550. assert( pBt->inTransaction==TRANS_WRITE );
  65551. assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
  65552. assert( pCur->curFlags & BTCF_WriteFlag );
  65553. assert( hasSharedCacheTableLock(p, pCur->pgnoRoot, pCur->pKeyInfo!=0, 2) );
  65554. assert( !hasReadConflicts(p, pCur->pgnoRoot) );
  65555. assert( pCur->ix<pCur->pPage->nCell );
  65556. assert( pCur->eState==CURSOR_VALID );
  65557. assert( (flags & ~(BTREE_SAVEPOSITION | BTREE_AUXDELETE))==0 );
  65558. iCellDepth = pCur->iPage;
  65559. iCellIdx = pCur->ix;
  65560. pPage = pCur->pPage;
  65561. pCell = findCell(pPage, iCellIdx);
  65562. /* If the bPreserve flag is set to true, then the cursor position must
  65563. ** be preserved following this delete operation. If the current delete
  65564. ** will cause a b-tree rebalance, then this is done by saving the cursor
  65565. ** key and leaving the cursor in CURSOR_REQUIRESEEK state before
  65566. ** returning.
  65567. **
  65568. ** Or, if the current delete will not cause a rebalance, then the cursor
  65569. ** will be left in CURSOR_SKIPNEXT state pointing to the entry immediately
  65570. ** before or after the deleted entry. In this case set bSkipnext to true. */
  65571. if( bPreserve ){
  65572. if( !pPage->leaf
  65573. || (pPage->nFree+cellSizePtr(pPage,pCell)+2)>(int)(pBt->usableSize*2/3)
  65574. ){
  65575. /* A b-tree rebalance will be required after deleting this entry.
  65576. ** Save the cursor key. */
  65577. rc = saveCursorKey(pCur);
  65578. if( rc ) return rc;
  65579. }else{
  65580. bSkipnext = 1;
  65581. }
  65582. }
  65583. /* If the page containing the entry to delete is not a leaf page, move
  65584. ** the cursor to the largest entry in the tree that is smaller than
  65585. ** the entry being deleted. This cell will replace the cell being deleted
  65586. ** from the internal node. The 'previous' entry is used for this instead
  65587. ** of the 'next' entry, as the previous entry is always a part of the
  65588. ** sub-tree headed by the child page of the cell being deleted. This makes
  65589. ** balancing the tree following the delete operation easier. */
  65590. if( !pPage->leaf ){
  65591. rc = sqlite3BtreePrevious(pCur, 0);
  65592. assert( rc!=SQLITE_DONE );
  65593. if( rc ) return rc;
  65594. }
  65595. /* Save the positions of any other cursors open on this table before
  65596. ** making any modifications. */
  65597. if( pCur->curFlags & BTCF_Multiple ){
  65598. rc = saveAllCursors(pBt, pCur->pgnoRoot, pCur);
  65599. if( rc ) return rc;
  65600. }
  65601. /* If this is a delete operation to remove a row from a table b-tree,
  65602. ** invalidate any incrblob cursors open on the row being deleted. */
  65603. if( pCur->pKeyInfo==0 ){
  65604. invalidateIncrblobCursors(p, pCur->pgnoRoot, pCur->info.nKey, 0);
  65605. }
  65606. /* Make the page containing the entry to be deleted writable. Then free any
  65607. ** overflow pages associated with the entry and finally remove the cell
  65608. ** itself from within the page. */
  65609. rc = sqlite3PagerWrite(pPage->pDbPage);
  65610. if( rc ) return rc;
  65611. rc = clearCell(pPage, pCell, &info);
  65612. dropCell(pPage, iCellIdx, info.nSize, &rc);
  65613. if( rc ) return rc;
  65614. /* If the cell deleted was not located on a leaf page, then the cursor
  65615. ** is currently pointing to the largest entry in the sub-tree headed
  65616. ** by the child-page of the cell that was just deleted from an internal
  65617. ** node. The cell from the leaf node needs to be moved to the internal
  65618. ** node to replace the deleted cell. */
  65619. if( !pPage->leaf ){
  65620. MemPage *pLeaf = pCur->pPage;
  65621. int nCell;
  65622. Pgno n;
  65623. unsigned char *pTmp;
  65624. if( iCellDepth<pCur->iPage-1 ){
  65625. n = pCur->apPage[iCellDepth+1]->pgno;
  65626. }else{
  65627. n = pCur->pPage->pgno;
  65628. }
  65629. pCell = findCell(pLeaf, pLeaf->nCell-1);
  65630. if( pCell<&pLeaf->aData[4] ) return SQLITE_CORRUPT_BKPT;
  65631. nCell = pLeaf->xCellSize(pLeaf, pCell);
  65632. assert( MX_CELL_SIZE(pBt) >= nCell );
  65633. pTmp = pBt->pTmpSpace;
  65634. assert( pTmp!=0 );
  65635. rc = sqlite3PagerWrite(pLeaf->pDbPage);
  65636. if( rc==SQLITE_OK ){
  65637. insertCell(pPage, iCellIdx, pCell-4, nCell+4, pTmp, n, &rc);
  65638. }
  65639. dropCell(pLeaf, pLeaf->nCell-1, nCell, &rc);
  65640. if( rc ) return rc;
  65641. }
  65642. /* Balance the tree. If the entry deleted was located on a leaf page,
  65643. ** then the cursor still points to that page. In this case the first
  65644. ** call to balance() repairs the tree, and the if(...) condition is
  65645. ** never true.
  65646. **
  65647. ** Otherwise, if the entry deleted was on an internal node page, then
  65648. ** pCur is pointing to the leaf page from which a cell was removed to
  65649. ** replace the cell deleted from the internal node. This is slightly
  65650. ** tricky as the leaf node may be underfull, and the internal node may
  65651. ** be either under or overfull. In this case run the balancing algorithm
  65652. ** on the leaf node first. If the balance proceeds far enough up the
  65653. ** tree that we can be sure that any problem in the internal node has
  65654. ** been corrected, so be it. Otherwise, after balancing the leaf node,
  65655. ** walk the cursor up the tree to the internal node and balance it as
  65656. ** well. */
  65657. rc = balance(pCur);
  65658. if( rc==SQLITE_OK && pCur->iPage>iCellDepth ){
  65659. releasePageNotNull(pCur->pPage);
  65660. pCur->iPage--;
  65661. while( pCur->iPage>iCellDepth ){
  65662. releasePage(pCur->apPage[pCur->iPage--]);
  65663. }
  65664. pCur->pPage = pCur->apPage[pCur->iPage];
  65665. rc = balance(pCur);
  65666. }
  65667. if( rc==SQLITE_OK ){
  65668. if( bSkipnext ){
  65669. assert( bPreserve && (pCur->iPage==iCellDepth || CORRUPT_DB) );
  65670. assert( pPage==pCur->pPage || CORRUPT_DB );
  65671. assert( (pPage->nCell>0 || CORRUPT_DB) && iCellIdx<=pPage->nCell );
  65672. pCur->eState = CURSOR_SKIPNEXT;
  65673. if( iCellIdx>=pPage->nCell ){
  65674. pCur->skipNext = -1;
  65675. pCur->ix = pPage->nCell-1;
  65676. }else{
  65677. pCur->skipNext = 1;
  65678. }
  65679. }else{
  65680. rc = moveToRoot(pCur);
  65681. if( bPreserve ){
  65682. btreeReleaseAllCursorPages(pCur);
  65683. pCur->eState = CURSOR_REQUIRESEEK;
  65684. }
  65685. if( rc==SQLITE_EMPTY ) rc = SQLITE_OK;
  65686. }
  65687. }
  65688. return rc;
  65689. }
  65690. /*
  65691. ** Create a new BTree table. Write into *piTable the page
  65692. ** number for the root page of the new table.
  65693. **
  65694. ** The type of type is determined by the flags parameter. Only the
  65695. ** following values of flags are currently in use. Other values for
  65696. ** flags might not work:
  65697. **
  65698. ** BTREE_INTKEY|BTREE_LEAFDATA Used for SQL tables with rowid keys
  65699. ** BTREE_ZERODATA Used for SQL indices
  65700. */
  65701. static int btreeCreateTable(Btree *p, int *piTable, int createTabFlags){
  65702. BtShared *pBt = p->pBt;
  65703. MemPage *pRoot;
  65704. Pgno pgnoRoot;
  65705. int rc;
  65706. int ptfFlags; /* Page-type flage for the root page of new table */
  65707. assert( sqlite3BtreeHoldsMutex(p) );
  65708. assert( pBt->inTransaction==TRANS_WRITE );
  65709. assert( (pBt->btsFlags & BTS_READ_ONLY)==0 );
  65710. #ifdef SQLITE_OMIT_AUTOVACUUM
  65711. rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
  65712. if( rc ){
  65713. return rc;
  65714. }
  65715. #else
  65716. if( pBt->autoVacuum ){
  65717. Pgno pgnoMove; /* Move a page here to make room for the root-page */
  65718. MemPage *pPageMove; /* The page to move to. */
  65719. /* Creating a new table may probably require moving an existing database
  65720. ** to make room for the new tables root page. In case this page turns
  65721. ** out to be an overflow page, delete all overflow page-map caches
  65722. ** held by open cursors.
  65723. */
  65724. invalidateAllOverflowCache(pBt);
  65725. /* Read the value of meta[3] from the database to determine where the
  65726. ** root page of the new table should go. meta[3] is the largest root-page
  65727. ** created so far, so the new root-page is (meta[3]+1).
  65728. */
  65729. sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &pgnoRoot);
  65730. pgnoRoot++;
  65731. /* The new root-page may not be allocated on a pointer-map page, or the
  65732. ** PENDING_BYTE page.
  65733. */
  65734. while( pgnoRoot==PTRMAP_PAGENO(pBt, pgnoRoot) ||
  65735. pgnoRoot==PENDING_BYTE_PAGE(pBt) ){
  65736. pgnoRoot++;
  65737. }
  65738. assert( pgnoRoot>=3 || CORRUPT_DB );
  65739. testcase( pgnoRoot<3 );
  65740. /* Allocate a page. The page that currently resides at pgnoRoot will
  65741. ** be moved to the allocated page (unless the allocated page happens
  65742. ** to reside at pgnoRoot).
  65743. */
  65744. rc = allocateBtreePage(pBt, &pPageMove, &pgnoMove, pgnoRoot, BTALLOC_EXACT);
  65745. if( rc!=SQLITE_OK ){
  65746. return rc;
  65747. }
  65748. if( pgnoMove!=pgnoRoot ){
  65749. /* pgnoRoot is the page that will be used for the root-page of
  65750. ** the new table (assuming an error did not occur). But we were
  65751. ** allocated pgnoMove. If required (i.e. if it was not allocated
  65752. ** by extending the file), the current page at position pgnoMove
  65753. ** is already journaled.
  65754. */
  65755. u8 eType = 0;
  65756. Pgno iPtrPage = 0;
  65757. /* Save the positions of any open cursors. This is required in
  65758. ** case they are holding a reference to an xFetch reference
  65759. ** corresponding to page pgnoRoot. */
  65760. rc = saveAllCursors(pBt, 0, 0);
  65761. releasePage(pPageMove);
  65762. if( rc!=SQLITE_OK ){
  65763. return rc;
  65764. }
  65765. /* Move the page currently at pgnoRoot to pgnoMove. */
  65766. rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
  65767. if( rc!=SQLITE_OK ){
  65768. return rc;
  65769. }
  65770. rc = ptrmapGet(pBt, pgnoRoot, &eType, &iPtrPage);
  65771. if( eType==PTRMAP_ROOTPAGE || eType==PTRMAP_FREEPAGE ){
  65772. rc = SQLITE_CORRUPT_BKPT;
  65773. }
  65774. if( rc!=SQLITE_OK ){
  65775. releasePage(pRoot);
  65776. return rc;
  65777. }
  65778. assert( eType!=PTRMAP_ROOTPAGE );
  65779. assert( eType!=PTRMAP_FREEPAGE );
  65780. rc = relocatePage(pBt, pRoot, eType, iPtrPage, pgnoMove, 0);
  65781. releasePage(pRoot);
  65782. /* Obtain the page at pgnoRoot */
  65783. if( rc!=SQLITE_OK ){
  65784. return rc;
  65785. }
  65786. rc = btreeGetPage(pBt, pgnoRoot, &pRoot, 0);
  65787. if( rc!=SQLITE_OK ){
  65788. return rc;
  65789. }
  65790. rc = sqlite3PagerWrite(pRoot->pDbPage);
  65791. if( rc!=SQLITE_OK ){
  65792. releasePage(pRoot);
  65793. return rc;
  65794. }
  65795. }else{
  65796. pRoot = pPageMove;
  65797. }
  65798. /* Update the pointer-map and meta-data with the new root-page number. */
  65799. ptrmapPut(pBt, pgnoRoot, PTRMAP_ROOTPAGE, 0, &rc);
  65800. if( rc ){
  65801. releasePage(pRoot);
  65802. return rc;
  65803. }
  65804. /* When the new root page was allocated, page 1 was made writable in
  65805. ** order either to increase the database filesize, or to decrement the
  65806. ** freelist count. Hence, the sqlite3BtreeUpdateMeta() call cannot fail.
  65807. */
  65808. assert( sqlite3PagerIswriteable(pBt->pPage1->pDbPage) );
  65809. rc = sqlite3BtreeUpdateMeta(p, 4, pgnoRoot);
  65810. if( NEVER(rc) ){
  65811. releasePage(pRoot);
  65812. return rc;
  65813. }
  65814. }else{
  65815. rc = allocateBtreePage(pBt, &pRoot, &pgnoRoot, 1, 0);
  65816. if( rc ) return rc;
  65817. }
  65818. #endif
  65819. assert( sqlite3PagerIswriteable(pRoot->pDbPage) );
  65820. if( createTabFlags & BTREE_INTKEY ){
  65821. ptfFlags = PTF_INTKEY | PTF_LEAFDATA | PTF_LEAF;
  65822. }else{
  65823. ptfFlags = PTF_ZERODATA | PTF_LEAF;
  65824. }
  65825. zeroPage(pRoot, ptfFlags);
  65826. sqlite3PagerUnref(pRoot->pDbPage);
  65827. assert( (pBt->openFlags & BTREE_SINGLE)==0 || pgnoRoot==2 );
  65828. *piTable = (int)pgnoRoot;
  65829. return SQLITE_OK;
  65830. }
  65831. SQLITE_PRIVATE int sqlite3BtreeCreateTable(Btree *p, int *piTable, int flags){
  65832. int rc;
  65833. sqlite3BtreeEnter(p);
  65834. rc = btreeCreateTable(p, piTable, flags);
  65835. sqlite3BtreeLeave(p);
  65836. return rc;
  65837. }
  65838. /*
  65839. ** Erase the given database page and all its children. Return
  65840. ** the page to the freelist.
  65841. */
  65842. static int clearDatabasePage(
  65843. BtShared *pBt, /* The BTree that contains the table */
  65844. Pgno pgno, /* Page number to clear */
  65845. int freePageFlag, /* Deallocate page if true */
  65846. int *pnChange /* Add number of Cells freed to this counter */
  65847. ){
  65848. MemPage *pPage;
  65849. int rc;
  65850. unsigned char *pCell;
  65851. int i;
  65852. int hdr;
  65853. CellInfo info;
  65854. assert( sqlite3_mutex_held(pBt->mutex) );
  65855. if( pgno>btreePagecount(pBt) ){
  65856. return SQLITE_CORRUPT_BKPT;
  65857. }
  65858. rc = getAndInitPage(pBt, pgno, &pPage, 0, 0);
  65859. if( rc ) return rc;
  65860. if( pPage->bBusy ){
  65861. rc = SQLITE_CORRUPT_BKPT;
  65862. goto cleardatabasepage_out;
  65863. }
  65864. pPage->bBusy = 1;
  65865. hdr = pPage->hdrOffset;
  65866. for(i=0; i<pPage->nCell; i++){
  65867. pCell = findCell(pPage, i);
  65868. if( !pPage->leaf ){
  65869. rc = clearDatabasePage(pBt, get4byte(pCell), 1, pnChange);
  65870. if( rc ) goto cleardatabasepage_out;
  65871. }
  65872. rc = clearCell(pPage, pCell, &info);
  65873. if( rc ) goto cleardatabasepage_out;
  65874. }
  65875. if( !pPage->leaf ){
  65876. rc = clearDatabasePage(pBt, get4byte(&pPage->aData[hdr+8]), 1, pnChange);
  65877. if( rc ) goto cleardatabasepage_out;
  65878. }else if( pnChange ){
  65879. assert( pPage->intKey || CORRUPT_DB );
  65880. testcase( !pPage->intKey );
  65881. *pnChange += pPage->nCell;
  65882. }
  65883. if( freePageFlag ){
  65884. freePage(pPage, &rc);
  65885. }else if( (rc = sqlite3PagerWrite(pPage->pDbPage))==0 ){
  65886. zeroPage(pPage, pPage->aData[hdr] | PTF_LEAF);
  65887. }
  65888. cleardatabasepage_out:
  65889. pPage->bBusy = 0;
  65890. releasePage(pPage);
  65891. return rc;
  65892. }
  65893. /*
  65894. ** Delete all information from a single table in the database. iTable is
  65895. ** the page number of the root of the table. After this routine returns,
  65896. ** the root page is empty, but still exists.
  65897. **
  65898. ** This routine will fail with SQLITE_LOCKED if there are any open
  65899. ** read cursors on the table. Open write cursors are moved to the
  65900. ** root of the table.
  65901. **
  65902. ** If pnChange is not NULL, then table iTable must be an intkey table. The
  65903. ** integer value pointed to by pnChange is incremented by the number of
  65904. ** entries in the table.
  65905. */
  65906. SQLITE_PRIVATE int sqlite3BtreeClearTable(Btree *p, int iTable, int *pnChange){
  65907. int rc;
  65908. BtShared *pBt = p->pBt;
  65909. sqlite3BtreeEnter(p);
  65910. assert( p->inTrans==TRANS_WRITE );
  65911. rc = saveAllCursors(pBt, (Pgno)iTable, 0);
  65912. if( SQLITE_OK==rc ){
  65913. /* Invalidate all incrblob cursors open on table iTable (assuming iTable
  65914. ** is the root of a table b-tree - if it is not, the following call is
  65915. ** a no-op). */
  65916. invalidateIncrblobCursors(p, (Pgno)iTable, 0, 1);
  65917. rc = clearDatabasePage(pBt, (Pgno)iTable, 0, pnChange);
  65918. }
  65919. sqlite3BtreeLeave(p);
  65920. return rc;
  65921. }
  65922. /*
  65923. ** Delete all information from the single table that pCur is open on.
  65924. **
  65925. ** This routine only work for pCur on an ephemeral table.
  65926. */
  65927. SQLITE_PRIVATE int sqlite3BtreeClearTableOfCursor(BtCursor *pCur){
  65928. return sqlite3BtreeClearTable(pCur->pBtree, pCur->pgnoRoot, 0);
  65929. }
  65930. /*
  65931. ** Erase all information in a table and add the root of the table to
  65932. ** the freelist. Except, the root of the principle table (the one on
  65933. ** page 1) is never added to the freelist.
  65934. **
  65935. ** This routine will fail with SQLITE_LOCKED if there are any open
  65936. ** cursors on the table.
  65937. **
  65938. ** If AUTOVACUUM is enabled and the page at iTable is not the last
  65939. ** root page in the database file, then the last root page
  65940. ** in the database file is moved into the slot formerly occupied by
  65941. ** iTable and that last slot formerly occupied by the last root page
  65942. ** is added to the freelist instead of iTable. In this say, all
  65943. ** root pages are kept at the beginning of the database file, which
  65944. ** is necessary for AUTOVACUUM to work right. *piMoved is set to the
  65945. ** page number that used to be the last root page in the file before
  65946. ** the move. If no page gets moved, *piMoved is set to 0.
  65947. ** The last root page is recorded in meta[3] and the value of
  65948. ** meta[3] is updated by this procedure.
  65949. */
  65950. static int btreeDropTable(Btree *p, Pgno iTable, int *piMoved){
  65951. int rc;
  65952. MemPage *pPage = 0;
  65953. BtShared *pBt = p->pBt;
  65954. assert( sqlite3BtreeHoldsMutex(p) );
  65955. assert( p->inTrans==TRANS_WRITE );
  65956. assert( iTable>=2 );
  65957. rc = btreeGetPage(pBt, (Pgno)iTable, &pPage, 0);
  65958. if( rc ) return rc;
  65959. rc = sqlite3BtreeClearTable(p, iTable, 0);
  65960. if( rc ){
  65961. releasePage(pPage);
  65962. return rc;
  65963. }
  65964. *piMoved = 0;
  65965. #ifdef SQLITE_OMIT_AUTOVACUUM
  65966. freePage(pPage, &rc);
  65967. releasePage(pPage);
  65968. #else
  65969. if( pBt->autoVacuum ){
  65970. Pgno maxRootPgno;
  65971. sqlite3BtreeGetMeta(p, BTREE_LARGEST_ROOT_PAGE, &maxRootPgno);
  65972. if( iTable==maxRootPgno ){
  65973. /* If the table being dropped is the table with the largest root-page
  65974. ** number in the database, put the root page on the free list.
  65975. */
  65976. freePage(pPage, &rc);
  65977. releasePage(pPage);
  65978. if( rc!=SQLITE_OK ){
  65979. return rc;
  65980. }
  65981. }else{
  65982. /* The table being dropped does not have the largest root-page
  65983. ** number in the database. So move the page that does into the
  65984. ** gap left by the deleted root-page.
  65985. */
  65986. MemPage *pMove;
  65987. releasePage(pPage);
  65988. rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
  65989. if( rc!=SQLITE_OK ){
  65990. return rc;
  65991. }
  65992. rc = relocatePage(pBt, pMove, PTRMAP_ROOTPAGE, 0, iTable, 0);
  65993. releasePage(pMove);
  65994. if( rc!=SQLITE_OK ){
  65995. return rc;
  65996. }
  65997. pMove = 0;
  65998. rc = btreeGetPage(pBt, maxRootPgno, &pMove, 0);
  65999. freePage(pMove, &rc);
  66000. releasePage(pMove);
  66001. if( rc!=SQLITE_OK ){
  66002. return rc;
  66003. }
  66004. *piMoved = maxRootPgno;
  66005. }
  66006. /* Set the new 'max-root-page' value in the database header. This
  66007. ** is the old value less one, less one more if that happens to
  66008. ** be a root-page number, less one again if that is the
  66009. ** PENDING_BYTE_PAGE.
  66010. */
  66011. maxRootPgno--;
  66012. while( maxRootPgno==PENDING_BYTE_PAGE(pBt)
  66013. || PTRMAP_ISPAGE(pBt, maxRootPgno) ){
  66014. maxRootPgno--;
  66015. }
  66016. assert( maxRootPgno!=PENDING_BYTE_PAGE(pBt) );
  66017. rc = sqlite3BtreeUpdateMeta(p, 4, maxRootPgno);
  66018. }else{
  66019. freePage(pPage, &rc);
  66020. releasePage(pPage);
  66021. }
  66022. #endif
  66023. return rc;
  66024. }
  66025. SQLITE_PRIVATE int sqlite3BtreeDropTable(Btree *p, int iTable, int *piMoved){
  66026. int rc;
  66027. sqlite3BtreeEnter(p);
  66028. rc = btreeDropTable(p, iTable, piMoved);
  66029. sqlite3BtreeLeave(p);
  66030. return rc;
  66031. }
  66032. /*
  66033. ** This function may only be called if the b-tree connection already
  66034. ** has a read or write transaction open on the database.
  66035. **
  66036. ** Read the meta-information out of a database file. Meta[0]
  66037. ** is the number of free pages currently in the database. Meta[1]
  66038. ** through meta[15] are available for use by higher layers. Meta[0]
  66039. ** is read-only, the others are read/write.
  66040. **
  66041. ** The schema layer numbers meta values differently. At the schema
  66042. ** layer (and the SetCookie and ReadCookie opcodes) the number of
  66043. ** free pages is not visible. So Cookie[0] is the same as Meta[1].
  66044. **
  66045. ** This routine treats Meta[BTREE_DATA_VERSION] as a special case. Instead
  66046. ** of reading the value out of the header, it instead loads the "DataVersion"
  66047. ** from the pager. The BTREE_DATA_VERSION value is not actually stored in the
  66048. ** database file. It is a number computed by the pager. But its access
  66049. ** pattern is the same as header meta values, and so it is convenient to
  66050. ** read it from this routine.
  66051. */
  66052. SQLITE_PRIVATE void sqlite3BtreeGetMeta(Btree *p, int idx, u32 *pMeta){
  66053. BtShared *pBt = p->pBt;
  66054. sqlite3BtreeEnter(p);
  66055. assert( p->inTrans>TRANS_NONE );
  66056. assert( SQLITE_OK==querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK) );
  66057. assert( pBt->pPage1 );
  66058. assert( idx>=0 && idx<=15 );
  66059. if( idx==BTREE_DATA_VERSION ){
  66060. *pMeta = sqlite3PagerDataVersion(pBt->pPager) + p->iDataVersion;
  66061. }else{
  66062. *pMeta = get4byte(&pBt->pPage1->aData[36 + idx*4]);
  66063. }
  66064. /* If auto-vacuum is disabled in this build and this is an auto-vacuum
  66065. ** database, mark the database as read-only. */
  66066. #ifdef SQLITE_OMIT_AUTOVACUUM
  66067. if( idx==BTREE_LARGEST_ROOT_PAGE && *pMeta>0 ){
  66068. pBt->btsFlags |= BTS_READ_ONLY;
  66069. }
  66070. #endif
  66071. sqlite3BtreeLeave(p);
  66072. }
  66073. /*
  66074. ** Write meta-information back into the database. Meta[0] is
  66075. ** read-only and may not be written.
  66076. */
  66077. SQLITE_PRIVATE int sqlite3BtreeUpdateMeta(Btree *p, int idx, u32 iMeta){
  66078. BtShared *pBt = p->pBt;
  66079. unsigned char *pP1;
  66080. int rc;
  66081. assert( idx>=1 && idx<=15 );
  66082. sqlite3BtreeEnter(p);
  66083. assert( p->inTrans==TRANS_WRITE );
  66084. assert( pBt->pPage1!=0 );
  66085. pP1 = pBt->pPage1->aData;
  66086. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  66087. if( rc==SQLITE_OK ){
  66088. put4byte(&pP1[36 + idx*4], iMeta);
  66089. #ifndef SQLITE_OMIT_AUTOVACUUM
  66090. if( idx==BTREE_INCR_VACUUM ){
  66091. assert( pBt->autoVacuum || iMeta==0 );
  66092. assert( iMeta==0 || iMeta==1 );
  66093. pBt->incrVacuum = (u8)iMeta;
  66094. }
  66095. #endif
  66096. }
  66097. sqlite3BtreeLeave(p);
  66098. return rc;
  66099. }
  66100. #ifndef SQLITE_OMIT_BTREECOUNT
  66101. /*
  66102. ** The first argument, pCur, is a cursor opened on some b-tree. Count the
  66103. ** number of entries in the b-tree and write the result to *pnEntry.
  66104. **
  66105. ** SQLITE_OK is returned if the operation is successfully executed.
  66106. ** Otherwise, if an error is encountered (i.e. an IO error or database
  66107. ** corruption) an SQLite error code is returned.
  66108. */
  66109. SQLITE_PRIVATE int sqlite3BtreeCount(BtCursor *pCur, i64 *pnEntry){
  66110. i64 nEntry = 0; /* Value to return in *pnEntry */
  66111. int rc; /* Return code */
  66112. rc = moveToRoot(pCur);
  66113. if( rc==SQLITE_EMPTY ){
  66114. *pnEntry = 0;
  66115. return SQLITE_OK;
  66116. }
  66117. /* Unless an error occurs, the following loop runs one iteration for each
  66118. ** page in the B-Tree structure (not including overflow pages).
  66119. */
  66120. while( rc==SQLITE_OK ){
  66121. int iIdx; /* Index of child node in parent */
  66122. MemPage *pPage; /* Current page of the b-tree */
  66123. /* If this is a leaf page or the tree is not an int-key tree, then
  66124. ** this page contains countable entries. Increment the entry counter
  66125. ** accordingly.
  66126. */
  66127. pPage = pCur->pPage;
  66128. if( pPage->leaf || !pPage->intKey ){
  66129. nEntry += pPage->nCell;
  66130. }
  66131. /* pPage is a leaf node. This loop navigates the cursor so that it
  66132. ** points to the first interior cell that it points to the parent of
  66133. ** the next page in the tree that has not yet been visited. The
  66134. ** pCur->aiIdx[pCur->iPage] value is set to the index of the parent cell
  66135. ** of the page, or to the number of cells in the page if the next page
  66136. ** to visit is the right-child of its parent.
  66137. **
  66138. ** If all pages in the tree have been visited, return SQLITE_OK to the
  66139. ** caller.
  66140. */
  66141. if( pPage->leaf ){
  66142. do {
  66143. if( pCur->iPage==0 ){
  66144. /* All pages of the b-tree have been visited. Return successfully. */
  66145. *pnEntry = nEntry;
  66146. return moveToRoot(pCur);
  66147. }
  66148. moveToParent(pCur);
  66149. }while ( pCur->ix>=pCur->pPage->nCell );
  66150. pCur->ix++;
  66151. pPage = pCur->pPage;
  66152. }
  66153. /* Descend to the child node of the cell that the cursor currently
  66154. ** points at. This is the right-child if (iIdx==pPage->nCell).
  66155. */
  66156. iIdx = pCur->ix;
  66157. if( iIdx==pPage->nCell ){
  66158. rc = moveToChild(pCur, get4byte(&pPage->aData[pPage->hdrOffset+8]));
  66159. }else{
  66160. rc = moveToChild(pCur, get4byte(findCell(pPage, iIdx)));
  66161. }
  66162. }
  66163. /* An error has occurred. Return an error code. */
  66164. return rc;
  66165. }
  66166. #endif
  66167. /*
  66168. ** Return the pager associated with a BTree. This routine is used for
  66169. ** testing and debugging only.
  66170. */
  66171. SQLITE_PRIVATE Pager *sqlite3BtreePager(Btree *p){
  66172. return p->pBt->pPager;
  66173. }
  66174. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  66175. /*
  66176. ** Append a message to the error message string.
  66177. */
  66178. static void checkAppendMsg(
  66179. IntegrityCk *pCheck,
  66180. const char *zFormat,
  66181. ...
  66182. ){
  66183. va_list ap;
  66184. if( !pCheck->mxErr ) return;
  66185. pCheck->mxErr--;
  66186. pCheck->nErr++;
  66187. va_start(ap, zFormat);
  66188. if( pCheck->errMsg.nChar ){
  66189. sqlite3StrAccumAppend(&pCheck->errMsg, "\n", 1);
  66190. }
  66191. if( pCheck->zPfx ){
  66192. sqlite3XPrintf(&pCheck->errMsg, pCheck->zPfx, pCheck->v1, pCheck->v2);
  66193. }
  66194. sqlite3VXPrintf(&pCheck->errMsg, zFormat, ap);
  66195. va_end(ap);
  66196. if( pCheck->errMsg.accError==STRACCUM_NOMEM ){
  66197. pCheck->mallocFailed = 1;
  66198. }
  66199. }
  66200. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  66201. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  66202. /*
  66203. ** Return non-zero if the bit in the IntegrityCk.aPgRef[] array that
  66204. ** corresponds to page iPg is already set.
  66205. */
  66206. static int getPageReferenced(IntegrityCk *pCheck, Pgno iPg){
  66207. assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
  66208. return (pCheck->aPgRef[iPg/8] & (1 << (iPg & 0x07)));
  66209. }
  66210. /*
  66211. ** Set the bit in the IntegrityCk.aPgRef[] array that corresponds to page iPg.
  66212. */
  66213. static void setPageReferenced(IntegrityCk *pCheck, Pgno iPg){
  66214. assert( iPg<=pCheck->nPage && sizeof(pCheck->aPgRef[0])==1 );
  66215. pCheck->aPgRef[iPg/8] |= (1 << (iPg & 0x07));
  66216. }
  66217. /*
  66218. ** Add 1 to the reference count for page iPage. If this is the second
  66219. ** reference to the page, add an error message to pCheck->zErrMsg.
  66220. ** Return 1 if there are 2 or more references to the page and 0 if
  66221. ** if this is the first reference to the page.
  66222. **
  66223. ** Also check that the page number is in bounds.
  66224. */
  66225. static int checkRef(IntegrityCk *pCheck, Pgno iPage){
  66226. if( iPage==0 ) return 1;
  66227. if( iPage>pCheck->nPage ){
  66228. checkAppendMsg(pCheck, "invalid page number %d", iPage);
  66229. return 1;
  66230. }
  66231. if( getPageReferenced(pCheck, iPage) ){
  66232. checkAppendMsg(pCheck, "2nd reference to page %d", iPage);
  66233. return 1;
  66234. }
  66235. setPageReferenced(pCheck, iPage);
  66236. return 0;
  66237. }
  66238. #ifndef SQLITE_OMIT_AUTOVACUUM
  66239. /*
  66240. ** Check that the entry in the pointer-map for page iChild maps to
  66241. ** page iParent, pointer type ptrType. If not, append an error message
  66242. ** to pCheck.
  66243. */
  66244. static void checkPtrmap(
  66245. IntegrityCk *pCheck, /* Integrity check context */
  66246. Pgno iChild, /* Child page number */
  66247. u8 eType, /* Expected pointer map type */
  66248. Pgno iParent /* Expected pointer map parent page number */
  66249. ){
  66250. int rc;
  66251. u8 ePtrmapType;
  66252. Pgno iPtrmapParent;
  66253. rc = ptrmapGet(pCheck->pBt, iChild, &ePtrmapType, &iPtrmapParent);
  66254. if( rc!=SQLITE_OK ){
  66255. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ) pCheck->mallocFailed = 1;
  66256. checkAppendMsg(pCheck, "Failed to read ptrmap key=%d", iChild);
  66257. return;
  66258. }
  66259. if( ePtrmapType!=eType || iPtrmapParent!=iParent ){
  66260. checkAppendMsg(pCheck,
  66261. "Bad ptr map entry key=%d expected=(%d,%d) got=(%d,%d)",
  66262. iChild, eType, iParent, ePtrmapType, iPtrmapParent);
  66263. }
  66264. }
  66265. #endif
  66266. /*
  66267. ** Check the integrity of the freelist or of an overflow page list.
  66268. ** Verify that the number of pages on the list is N.
  66269. */
  66270. static void checkList(
  66271. IntegrityCk *pCheck, /* Integrity checking context */
  66272. int isFreeList, /* True for a freelist. False for overflow page list */
  66273. int iPage, /* Page number for first page in the list */
  66274. int N /* Expected number of pages in the list */
  66275. ){
  66276. int i;
  66277. int expected = N;
  66278. int iFirst = iPage;
  66279. while( N-- > 0 && pCheck->mxErr ){
  66280. DbPage *pOvflPage;
  66281. unsigned char *pOvflData;
  66282. if( iPage<1 ){
  66283. checkAppendMsg(pCheck,
  66284. "%d of %d pages missing from overflow list starting at %d",
  66285. N+1, expected, iFirst);
  66286. break;
  66287. }
  66288. if( checkRef(pCheck, iPage) ) break;
  66289. if( sqlite3PagerGet(pCheck->pPager, (Pgno)iPage, &pOvflPage, 0) ){
  66290. checkAppendMsg(pCheck, "failed to get page %d", iPage);
  66291. break;
  66292. }
  66293. pOvflData = (unsigned char *)sqlite3PagerGetData(pOvflPage);
  66294. if( isFreeList ){
  66295. int n = get4byte(&pOvflData[4]);
  66296. #ifndef SQLITE_OMIT_AUTOVACUUM
  66297. if( pCheck->pBt->autoVacuum ){
  66298. checkPtrmap(pCheck, iPage, PTRMAP_FREEPAGE, 0);
  66299. }
  66300. #endif
  66301. if( n>(int)pCheck->pBt->usableSize/4-2 ){
  66302. checkAppendMsg(pCheck,
  66303. "freelist leaf count too big on page %d", iPage);
  66304. N--;
  66305. }else{
  66306. for(i=0; i<n; i++){
  66307. Pgno iFreePage = get4byte(&pOvflData[8+i*4]);
  66308. #ifndef SQLITE_OMIT_AUTOVACUUM
  66309. if( pCheck->pBt->autoVacuum ){
  66310. checkPtrmap(pCheck, iFreePage, PTRMAP_FREEPAGE, 0);
  66311. }
  66312. #endif
  66313. checkRef(pCheck, iFreePage);
  66314. }
  66315. N -= n;
  66316. }
  66317. }
  66318. #ifndef SQLITE_OMIT_AUTOVACUUM
  66319. else{
  66320. /* If this database supports auto-vacuum and iPage is not the last
  66321. ** page in this overflow list, check that the pointer-map entry for
  66322. ** the following page matches iPage.
  66323. */
  66324. if( pCheck->pBt->autoVacuum && N>0 ){
  66325. i = get4byte(pOvflData);
  66326. checkPtrmap(pCheck, i, PTRMAP_OVERFLOW2, iPage);
  66327. }
  66328. }
  66329. #endif
  66330. iPage = get4byte(pOvflData);
  66331. sqlite3PagerUnref(pOvflPage);
  66332. if( isFreeList && N<(iPage!=0) ){
  66333. checkAppendMsg(pCheck, "free-page count in header is too small");
  66334. }
  66335. }
  66336. }
  66337. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  66338. /*
  66339. ** An implementation of a min-heap.
  66340. **
  66341. ** aHeap[0] is the number of elements on the heap. aHeap[1] is the
  66342. ** root element. The daughter nodes of aHeap[N] are aHeap[N*2]
  66343. ** and aHeap[N*2+1].
  66344. **
  66345. ** The heap property is this: Every node is less than or equal to both
  66346. ** of its daughter nodes. A consequence of the heap property is that the
  66347. ** root node aHeap[1] is always the minimum value currently in the heap.
  66348. **
  66349. ** The btreeHeapInsert() routine inserts an unsigned 32-bit number onto
  66350. ** the heap, preserving the heap property. The btreeHeapPull() routine
  66351. ** removes the root element from the heap (the minimum value in the heap)
  66352. ** and then moves other nodes around as necessary to preserve the heap
  66353. ** property.
  66354. **
  66355. ** This heap is used for cell overlap and coverage testing. Each u32
  66356. ** entry represents the span of a cell or freeblock on a btree page.
  66357. ** The upper 16 bits are the index of the first byte of a range and the
  66358. ** lower 16 bits are the index of the last byte of that range.
  66359. */
  66360. static void btreeHeapInsert(u32 *aHeap, u32 x){
  66361. u32 j, i = ++aHeap[0];
  66362. aHeap[i] = x;
  66363. while( (j = i/2)>0 && aHeap[j]>aHeap[i] ){
  66364. x = aHeap[j];
  66365. aHeap[j] = aHeap[i];
  66366. aHeap[i] = x;
  66367. i = j;
  66368. }
  66369. }
  66370. static int btreeHeapPull(u32 *aHeap, u32 *pOut){
  66371. u32 j, i, x;
  66372. if( (x = aHeap[0])==0 ) return 0;
  66373. *pOut = aHeap[1];
  66374. aHeap[1] = aHeap[x];
  66375. aHeap[x] = 0xffffffff;
  66376. aHeap[0]--;
  66377. i = 1;
  66378. while( (j = i*2)<=aHeap[0] ){
  66379. if( aHeap[j]>aHeap[j+1] ) j++;
  66380. if( aHeap[i]<aHeap[j] ) break;
  66381. x = aHeap[i];
  66382. aHeap[i] = aHeap[j];
  66383. aHeap[j] = x;
  66384. i = j;
  66385. }
  66386. return 1;
  66387. }
  66388. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  66389. /*
  66390. ** Do various sanity checks on a single page of a tree. Return
  66391. ** the tree depth. Root pages return 0. Parents of root pages
  66392. ** return 1, and so forth.
  66393. **
  66394. ** These checks are done:
  66395. **
  66396. ** 1. Make sure that cells and freeblocks do not overlap
  66397. ** but combine to completely cover the page.
  66398. ** 2. Make sure integer cell keys are in order.
  66399. ** 3. Check the integrity of overflow pages.
  66400. ** 4. Recursively call checkTreePage on all children.
  66401. ** 5. Verify that the depth of all children is the same.
  66402. */
  66403. static int checkTreePage(
  66404. IntegrityCk *pCheck, /* Context for the sanity check */
  66405. int iPage, /* Page number of the page to check */
  66406. i64 *piMinKey, /* Write minimum integer primary key here */
  66407. i64 maxKey /* Error if integer primary key greater than this */
  66408. ){
  66409. MemPage *pPage = 0; /* The page being analyzed */
  66410. int i; /* Loop counter */
  66411. int rc; /* Result code from subroutine call */
  66412. int depth = -1, d2; /* Depth of a subtree */
  66413. int pgno; /* Page number */
  66414. int nFrag; /* Number of fragmented bytes on the page */
  66415. int hdr; /* Offset to the page header */
  66416. int cellStart; /* Offset to the start of the cell pointer array */
  66417. int nCell; /* Number of cells */
  66418. int doCoverageCheck = 1; /* True if cell coverage checking should be done */
  66419. int keyCanBeEqual = 1; /* True if IPK can be equal to maxKey
  66420. ** False if IPK must be strictly less than maxKey */
  66421. u8 *data; /* Page content */
  66422. u8 *pCell; /* Cell content */
  66423. u8 *pCellIdx; /* Next element of the cell pointer array */
  66424. BtShared *pBt; /* The BtShared object that owns pPage */
  66425. u32 pc; /* Address of a cell */
  66426. u32 usableSize; /* Usable size of the page */
  66427. u32 contentOffset; /* Offset to the start of the cell content area */
  66428. u32 *heap = 0; /* Min-heap used for checking cell coverage */
  66429. u32 x, prev = 0; /* Next and previous entry on the min-heap */
  66430. const char *saved_zPfx = pCheck->zPfx;
  66431. int saved_v1 = pCheck->v1;
  66432. int saved_v2 = pCheck->v2;
  66433. u8 savedIsInit = 0;
  66434. /* Check that the page exists
  66435. */
  66436. pBt = pCheck->pBt;
  66437. usableSize = pBt->usableSize;
  66438. if( iPage==0 ) return 0;
  66439. if( checkRef(pCheck, iPage) ) return 0;
  66440. pCheck->zPfx = "Page %d: ";
  66441. pCheck->v1 = iPage;
  66442. if( (rc = btreeGetPage(pBt, (Pgno)iPage, &pPage, 0))!=0 ){
  66443. checkAppendMsg(pCheck,
  66444. "unable to get the page. error code=%d", rc);
  66445. goto end_of_check;
  66446. }
  66447. /* Clear MemPage.isInit to make sure the corruption detection code in
  66448. ** btreeInitPage() is executed. */
  66449. savedIsInit = pPage->isInit;
  66450. pPage->isInit = 0;
  66451. if( (rc = btreeInitPage(pPage))!=0 ){
  66452. assert( rc==SQLITE_CORRUPT ); /* The only possible error from InitPage */
  66453. checkAppendMsg(pCheck,
  66454. "btreeInitPage() returns error code %d", rc);
  66455. goto end_of_check;
  66456. }
  66457. data = pPage->aData;
  66458. hdr = pPage->hdrOffset;
  66459. /* Set up for cell analysis */
  66460. pCheck->zPfx = "On tree page %d cell %d: ";
  66461. contentOffset = get2byteNotZero(&data[hdr+5]);
  66462. assert( contentOffset<=usableSize ); /* Enforced by btreeInitPage() */
  66463. /* EVIDENCE-OF: R-37002-32774 The two-byte integer at offset 3 gives the
  66464. ** number of cells on the page. */
  66465. nCell = get2byte(&data[hdr+3]);
  66466. assert( pPage->nCell==nCell );
  66467. /* EVIDENCE-OF: R-23882-45353 The cell pointer array of a b-tree page
  66468. ** immediately follows the b-tree page header. */
  66469. cellStart = hdr + 12 - 4*pPage->leaf;
  66470. assert( pPage->aCellIdx==&data[cellStart] );
  66471. pCellIdx = &data[cellStart + 2*(nCell-1)];
  66472. if( !pPage->leaf ){
  66473. /* Analyze the right-child page of internal pages */
  66474. pgno = get4byte(&data[hdr+8]);
  66475. #ifndef SQLITE_OMIT_AUTOVACUUM
  66476. if( pBt->autoVacuum ){
  66477. pCheck->zPfx = "On page %d at right child: ";
  66478. checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
  66479. }
  66480. #endif
  66481. depth = checkTreePage(pCheck, pgno, &maxKey, maxKey);
  66482. keyCanBeEqual = 0;
  66483. }else{
  66484. /* For leaf pages, the coverage check will occur in the same loop
  66485. ** as the other cell checks, so initialize the heap. */
  66486. heap = pCheck->heap;
  66487. heap[0] = 0;
  66488. }
  66489. /* EVIDENCE-OF: R-02776-14802 The cell pointer array consists of K 2-byte
  66490. ** integer offsets to the cell contents. */
  66491. for(i=nCell-1; i>=0 && pCheck->mxErr; i--){
  66492. CellInfo info;
  66493. /* Check cell size */
  66494. pCheck->v2 = i;
  66495. assert( pCellIdx==&data[cellStart + i*2] );
  66496. pc = get2byteAligned(pCellIdx);
  66497. pCellIdx -= 2;
  66498. if( pc<contentOffset || pc>usableSize-4 ){
  66499. checkAppendMsg(pCheck, "Offset %d out of range %d..%d",
  66500. pc, contentOffset, usableSize-4);
  66501. doCoverageCheck = 0;
  66502. continue;
  66503. }
  66504. pCell = &data[pc];
  66505. pPage->xParseCell(pPage, pCell, &info);
  66506. if( pc+info.nSize>usableSize ){
  66507. checkAppendMsg(pCheck, "Extends off end of page");
  66508. doCoverageCheck = 0;
  66509. continue;
  66510. }
  66511. /* Check for integer primary key out of range */
  66512. if( pPage->intKey ){
  66513. if( keyCanBeEqual ? (info.nKey > maxKey) : (info.nKey >= maxKey) ){
  66514. checkAppendMsg(pCheck, "Rowid %lld out of order", info.nKey);
  66515. }
  66516. maxKey = info.nKey;
  66517. keyCanBeEqual = 0; /* Only the first key on the page may ==maxKey */
  66518. }
  66519. /* Check the content overflow list */
  66520. if( info.nPayload>info.nLocal ){
  66521. int nPage; /* Number of pages on the overflow chain */
  66522. Pgno pgnoOvfl; /* First page of the overflow chain */
  66523. assert( pc + info.nSize - 4 <= usableSize );
  66524. nPage = (info.nPayload - info.nLocal + usableSize - 5)/(usableSize - 4);
  66525. pgnoOvfl = get4byte(&pCell[info.nSize - 4]);
  66526. #ifndef SQLITE_OMIT_AUTOVACUUM
  66527. if( pBt->autoVacuum ){
  66528. checkPtrmap(pCheck, pgnoOvfl, PTRMAP_OVERFLOW1, iPage);
  66529. }
  66530. #endif
  66531. checkList(pCheck, 0, pgnoOvfl, nPage);
  66532. }
  66533. if( !pPage->leaf ){
  66534. /* Check sanity of left child page for internal pages */
  66535. pgno = get4byte(pCell);
  66536. #ifndef SQLITE_OMIT_AUTOVACUUM
  66537. if( pBt->autoVacuum ){
  66538. checkPtrmap(pCheck, pgno, PTRMAP_BTREE, iPage);
  66539. }
  66540. #endif
  66541. d2 = checkTreePage(pCheck, pgno, &maxKey, maxKey);
  66542. keyCanBeEqual = 0;
  66543. if( d2!=depth ){
  66544. checkAppendMsg(pCheck, "Child page depth differs");
  66545. depth = d2;
  66546. }
  66547. }else{
  66548. /* Populate the coverage-checking heap for leaf pages */
  66549. btreeHeapInsert(heap, (pc<<16)|(pc+info.nSize-1));
  66550. }
  66551. }
  66552. *piMinKey = maxKey;
  66553. /* Check for complete coverage of the page
  66554. */
  66555. pCheck->zPfx = 0;
  66556. if( doCoverageCheck && pCheck->mxErr>0 ){
  66557. /* For leaf pages, the min-heap has already been initialized and the
  66558. ** cells have already been inserted. But for internal pages, that has
  66559. ** not yet been done, so do it now */
  66560. if( !pPage->leaf ){
  66561. heap = pCheck->heap;
  66562. heap[0] = 0;
  66563. for(i=nCell-1; i>=0; i--){
  66564. u32 size;
  66565. pc = get2byteAligned(&data[cellStart+i*2]);
  66566. size = pPage->xCellSize(pPage, &data[pc]);
  66567. btreeHeapInsert(heap, (pc<<16)|(pc+size-1));
  66568. }
  66569. }
  66570. /* Add the freeblocks to the min-heap
  66571. **
  66572. ** EVIDENCE-OF: R-20690-50594 The second field of the b-tree page header
  66573. ** is the offset of the first freeblock, or zero if there are no
  66574. ** freeblocks on the page.
  66575. */
  66576. i = get2byte(&data[hdr+1]);
  66577. while( i>0 ){
  66578. int size, j;
  66579. assert( (u32)i<=usableSize-4 ); /* Enforced by btreeInitPage() */
  66580. size = get2byte(&data[i+2]);
  66581. assert( (u32)(i+size)<=usableSize ); /* Enforced by btreeInitPage() */
  66582. btreeHeapInsert(heap, (((u32)i)<<16)|(i+size-1));
  66583. /* EVIDENCE-OF: R-58208-19414 The first 2 bytes of a freeblock are a
  66584. ** big-endian integer which is the offset in the b-tree page of the next
  66585. ** freeblock in the chain, or zero if the freeblock is the last on the
  66586. ** chain. */
  66587. j = get2byte(&data[i]);
  66588. /* EVIDENCE-OF: R-06866-39125 Freeblocks are always connected in order of
  66589. ** increasing offset. */
  66590. assert( j==0 || j>i+size ); /* Enforced by btreeInitPage() */
  66591. assert( (u32)j<=usableSize-4 ); /* Enforced by btreeInitPage() */
  66592. i = j;
  66593. }
  66594. /* Analyze the min-heap looking for overlap between cells and/or
  66595. ** freeblocks, and counting the number of untracked bytes in nFrag.
  66596. **
  66597. ** Each min-heap entry is of the form: (start_address<<16)|end_address.
  66598. ** There is an implied first entry the covers the page header, the cell
  66599. ** pointer index, and the gap between the cell pointer index and the start
  66600. ** of cell content.
  66601. **
  66602. ** The loop below pulls entries from the min-heap in order and compares
  66603. ** the start_address against the previous end_address. If there is an
  66604. ** overlap, that means bytes are used multiple times. If there is a gap,
  66605. ** that gap is added to the fragmentation count.
  66606. */
  66607. nFrag = 0;
  66608. prev = contentOffset - 1; /* Implied first min-heap entry */
  66609. while( btreeHeapPull(heap,&x) ){
  66610. if( (prev&0xffff)>=(x>>16) ){
  66611. checkAppendMsg(pCheck,
  66612. "Multiple uses for byte %u of page %d", x>>16, iPage);
  66613. break;
  66614. }else{
  66615. nFrag += (x>>16) - (prev&0xffff) - 1;
  66616. prev = x;
  66617. }
  66618. }
  66619. nFrag += usableSize - (prev&0xffff) - 1;
  66620. /* EVIDENCE-OF: R-43263-13491 The total number of bytes in all fragments
  66621. ** is stored in the fifth field of the b-tree page header.
  66622. ** EVIDENCE-OF: R-07161-27322 The one-byte integer at offset 7 gives the
  66623. ** number of fragmented free bytes within the cell content area.
  66624. */
  66625. if( heap[0]==0 && nFrag!=data[hdr+7] ){
  66626. checkAppendMsg(pCheck,
  66627. "Fragmentation of %d bytes reported as %d on page %d",
  66628. nFrag, data[hdr+7], iPage);
  66629. }
  66630. }
  66631. end_of_check:
  66632. if( !doCoverageCheck ) pPage->isInit = savedIsInit;
  66633. releasePage(pPage);
  66634. pCheck->zPfx = saved_zPfx;
  66635. pCheck->v1 = saved_v1;
  66636. pCheck->v2 = saved_v2;
  66637. return depth+1;
  66638. }
  66639. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  66640. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  66641. /*
  66642. ** This routine does a complete check of the given BTree file. aRoot[] is
  66643. ** an array of pages numbers were each page number is the root page of
  66644. ** a table. nRoot is the number of entries in aRoot.
  66645. **
  66646. ** A read-only or read-write transaction must be opened before calling
  66647. ** this function.
  66648. **
  66649. ** Write the number of error seen in *pnErr. Except for some memory
  66650. ** allocation errors, an error message held in memory obtained from
  66651. ** malloc is returned if *pnErr is non-zero. If *pnErr==0 then NULL is
  66652. ** returned. If a memory allocation error occurs, NULL is returned.
  66653. */
  66654. SQLITE_PRIVATE char *sqlite3BtreeIntegrityCheck(
  66655. Btree *p, /* The btree to be checked */
  66656. int *aRoot, /* An array of root pages numbers for individual trees */
  66657. int nRoot, /* Number of entries in aRoot[] */
  66658. int mxErr, /* Stop reporting errors after this many */
  66659. int *pnErr /* Write number of errors seen to this variable */
  66660. ){
  66661. Pgno i;
  66662. IntegrityCk sCheck;
  66663. BtShared *pBt = p->pBt;
  66664. int savedDbFlags = pBt->db->flags;
  66665. char zErr[100];
  66666. VVA_ONLY( int nRef );
  66667. sqlite3BtreeEnter(p);
  66668. assert( p->inTrans>TRANS_NONE && pBt->inTransaction>TRANS_NONE );
  66669. VVA_ONLY( nRef = sqlite3PagerRefcount(pBt->pPager) );
  66670. assert( nRef>=0 );
  66671. sCheck.pBt = pBt;
  66672. sCheck.pPager = pBt->pPager;
  66673. sCheck.nPage = btreePagecount(sCheck.pBt);
  66674. sCheck.mxErr = mxErr;
  66675. sCheck.nErr = 0;
  66676. sCheck.mallocFailed = 0;
  66677. sCheck.zPfx = 0;
  66678. sCheck.v1 = 0;
  66679. sCheck.v2 = 0;
  66680. sCheck.aPgRef = 0;
  66681. sCheck.heap = 0;
  66682. sqlite3StrAccumInit(&sCheck.errMsg, 0, zErr, sizeof(zErr), SQLITE_MAX_LENGTH);
  66683. sCheck.errMsg.printfFlags = SQLITE_PRINTF_INTERNAL;
  66684. if( sCheck.nPage==0 ){
  66685. goto integrity_ck_cleanup;
  66686. }
  66687. sCheck.aPgRef = sqlite3MallocZero((sCheck.nPage / 8)+ 1);
  66688. if( !sCheck.aPgRef ){
  66689. sCheck.mallocFailed = 1;
  66690. goto integrity_ck_cleanup;
  66691. }
  66692. sCheck.heap = (u32*)sqlite3PageMalloc( pBt->pageSize );
  66693. if( sCheck.heap==0 ){
  66694. sCheck.mallocFailed = 1;
  66695. goto integrity_ck_cleanup;
  66696. }
  66697. i = PENDING_BYTE_PAGE(pBt);
  66698. if( i<=sCheck.nPage ) setPageReferenced(&sCheck, i);
  66699. /* Check the integrity of the freelist
  66700. */
  66701. sCheck.zPfx = "Main freelist: ";
  66702. checkList(&sCheck, 1, get4byte(&pBt->pPage1->aData[32]),
  66703. get4byte(&pBt->pPage1->aData[36]));
  66704. sCheck.zPfx = 0;
  66705. /* Check all the tables.
  66706. */
  66707. testcase( pBt->db->flags & SQLITE_CellSizeCk );
  66708. pBt->db->flags &= ~SQLITE_CellSizeCk;
  66709. for(i=0; (int)i<nRoot && sCheck.mxErr; i++){
  66710. i64 notUsed;
  66711. if( aRoot[i]==0 ) continue;
  66712. #ifndef SQLITE_OMIT_AUTOVACUUM
  66713. if( pBt->autoVacuum && aRoot[i]>1 ){
  66714. checkPtrmap(&sCheck, aRoot[i], PTRMAP_ROOTPAGE, 0);
  66715. }
  66716. #endif
  66717. checkTreePage(&sCheck, aRoot[i], &notUsed, LARGEST_INT64);
  66718. }
  66719. pBt->db->flags = savedDbFlags;
  66720. /* Make sure every page in the file is referenced
  66721. */
  66722. for(i=1; i<=sCheck.nPage && sCheck.mxErr; i++){
  66723. #ifdef SQLITE_OMIT_AUTOVACUUM
  66724. if( getPageReferenced(&sCheck, i)==0 ){
  66725. checkAppendMsg(&sCheck, "Page %d is never used", i);
  66726. }
  66727. #else
  66728. /* If the database supports auto-vacuum, make sure no tables contain
  66729. ** references to pointer-map pages.
  66730. */
  66731. if( getPageReferenced(&sCheck, i)==0 &&
  66732. (PTRMAP_PAGENO(pBt, i)!=i || !pBt->autoVacuum) ){
  66733. checkAppendMsg(&sCheck, "Page %d is never used", i);
  66734. }
  66735. if( getPageReferenced(&sCheck, i)!=0 &&
  66736. (PTRMAP_PAGENO(pBt, i)==i && pBt->autoVacuum) ){
  66737. checkAppendMsg(&sCheck, "Pointer map page %d is referenced", i);
  66738. }
  66739. #endif
  66740. }
  66741. /* Clean up and report errors.
  66742. */
  66743. integrity_ck_cleanup:
  66744. sqlite3PageFree(sCheck.heap);
  66745. sqlite3_free(sCheck.aPgRef);
  66746. if( sCheck.mallocFailed ){
  66747. sqlite3StrAccumReset(&sCheck.errMsg);
  66748. sCheck.nErr++;
  66749. }
  66750. *pnErr = sCheck.nErr;
  66751. if( sCheck.nErr==0 ) sqlite3StrAccumReset(&sCheck.errMsg);
  66752. /* Make sure this analysis did not leave any unref() pages. */
  66753. assert( nRef==sqlite3PagerRefcount(pBt->pPager) );
  66754. sqlite3BtreeLeave(p);
  66755. return sqlite3StrAccumFinish(&sCheck.errMsg);
  66756. }
  66757. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  66758. /*
  66759. ** Return the full pathname of the underlying database file. Return
  66760. ** an empty string if the database is in-memory or a TEMP database.
  66761. **
  66762. ** The pager filename is invariant as long as the pager is
  66763. ** open so it is safe to access without the BtShared mutex.
  66764. */
  66765. SQLITE_PRIVATE const char *sqlite3BtreeGetFilename(Btree *p){
  66766. assert( p->pBt->pPager!=0 );
  66767. return sqlite3PagerFilename(p->pBt->pPager, 1);
  66768. }
  66769. /*
  66770. ** Return the pathname of the journal file for this database. The return
  66771. ** value of this routine is the same regardless of whether the journal file
  66772. ** has been created or not.
  66773. **
  66774. ** The pager journal filename is invariant as long as the pager is
  66775. ** open so it is safe to access without the BtShared mutex.
  66776. */
  66777. SQLITE_PRIVATE const char *sqlite3BtreeGetJournalname(Btree *p){
  66778. assert( p->pBt->pPager!=0 );
  66779. return sqlite3PagerJournalname(p->pBt->pPager);
  66780. }
  66781. /*
  66782. ** Return non-zero if a transaction is active.
  66783. */
  66784. SQLITE_PRIVATE int sqlite3BtreeIsInTrans(Btree *p){
  66785. assert( p==0 || sqlite3_mutex_held(p->db->mutex) );
  66786. return (p && (p->inTrans==TRANS_WRITE));
  66787. }
  66788. #ifndef SQLITE_OMIT_WAL
  66789. /*
  66790. ** Run a checkpoint on the Btree passed as the first argument.
  66791. **
  66792. ** Return SQLITE_LOCKED if this or any other connection has an open
  66793. ** transaction on the shared-cache the argument Btree is connected to.
  66794. **
  66795. ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL or RESTART.
  66796. */
  66797. SQLITE_PRIVATE int sqlite3BtreeCheckpoint(Btree *p, int eMode, int *pnLog, int *pnCkpt){
  66798. int rc = SQLITE_OK;
  66799. if( p ){
  66800. BtShared *pBt = p->pBt;
  66801. sqlite3BtreeEnter(p);
  66802. if( pBt->inTransaction!=TRANS_NONE ){
  66803. rc = SQLITE_LOCKED;
  66804. }else{
  66805. rc = sqlite3PagerCheckpoint(pBt->pPager, p->db, eMode, pnLog, pnCkpt);
  66806. }
  66807. sqlite3BtreeLeave(p);
  66808. }
  66809. return rc;
  66810. }
  66811. #endif
  66812. /*
  66813. ** Return non-zero if a read (or write) transaction is active.
  66814. */
  66815. SQLITE_PRIVATE int sqlite3BtreeIsInReadTrans(Btree *p){
  66816. assert( p );
  66817. assert( sqlite3_mutex_held(p->db->mutex) );
  66818. return p->inTrans!=TRANS_NONE;
  66819. }
  66820. SQLITE_PRIVATE int sqlite3BtreeIsInBackup(Btree *p){
  66821. assert( p );
  66822. assert( sqlite3_mutex_held(p->db->mutex) );
  66823. return p->nBackup!=0;
  66824. }
  66825. /*
  66826. ** This function returns a pointer to a blob of memory associated with
  66827. ** a single shared-btree. The memory is used by client code for its own
  66828. ** purposes (for example, to store a high-level schema associated with
  66829. ** the shared-btree). The btree layer manages reference counting issues.
  66830. **
  66831. ** The first time this is called on a shared-btree, nBytes bytes of memory
  66832. ** are allocated, zeroed, and returned to the caller. For each subsequent
  66833. ** call the nBytes parameter is ignored and a pointer to the same blob
  66834. ** of memory returned.
  66835. **
  66836. ** If the nBytes parameter is 0 and the blob of memory has not yet been
  66837. ** allocated, a null pointer is returned. If the blob has already been
  66838. ** allocated, it is returned as normal.
  66839. **
  66840. ** Just before the shared-btree is closed, the function passed as the
  66841. ** xFree argument when the memory allocation was made is invoked on the
  66842. ** blob of allocated memory. The xFree function should not call sqlite3_free()
  66843. ** on the memory, the btree layer does that.
  66844. */
  66845. SQLITE_PRIVATE void *sqlite3BtreeSchema(Btree *p, int nBytes, void(*xFree)(void *)){
  66846. BtShared *pBt = p->pBt;
  66847. sqlite3BtreeEnter(p);
  66848. if( !pBt->pSchema && nBytes ){
  66849. pBt->pSchema = sqlite3DbMallocZero(0, nBytes);
  66850. pBt->xFreeSchema = xFree;
  66851. }
  66852. sqlite3BtreeLeave(p);
  66853. return pBt->pSchema;
  66854. }
  66855. /*
  66856. ** Return SQLITE_LOCKED_SHAREDCACHE if another user of the same shared
  66857. ** btree as the argument handle holds an exclusive lock on the
  66858. ** sqlite_master table. Otherwise SQLITE_OK.
  66859. */
  66860. SQLITE_PRIVATE int sqlite3BtreeSchemaLocked(Btree *p){
  66861. int rc;
  66862. assert( sqlite3_mutex_held(p->db->mutex) );
  66863. sqlite3BtreeEnter(p);
  66864. rc = querySharedCacheTableLock(p, MASTER_ROOT, READ_LOCK);
  66865. assert( rc==SQLITE_OK || rc==SQLITE_LOCKED_SHAREDCACHE );
  66866. sqlite3BtreeLeave(p);
  66867. return rc;
  66868. }
  66869. #ifndef SQLITE_OMIT_SHARED_CACHE
  66870. /*
  66871. ** Obtain a lock on the table whose root page is iTab. The
  66872. ** lock is a write lock if isWritelock is true or a read lock
  66873. ** if it is false.
  66874. */
  66875. SQLITE_PRIVATE int sqlite3BtreeLockTable(Btree *p, int iTab, u8 isWriteLock){
  66876. int rc = SQLITE_OK;
  66877. assert( p->inTrans!=TRANS_NONE );
  66878. if( p->sharable ){
  66879. u8 lockType = READ_LOCK + isWriteLock;
  66880. assert( READ_LOCK+1==WRITE_LOCK );
  66881. assert( isWriteLock==0 || isWriteLock==1 );
  66882. sqlite3BtreeEnter(p);
  66883. rc = querySharedCacheTableLock(p, iTab, lockType);
  66884. if( rc==SQLITE_OK ){
  66885. rc = setSharedCacheTableLock(p, iTab, lockType);
  66886. }
  66887. sqlite3BtreeLeave(p);
  66888. }
  66889. return rc;
  66890. }
  66891. #endif
  66892. #ifndef SQLITE_OMIT_INCRBLOB
  66893. /*
  66894. ** Argument pCsr must be a cursor opened for writing on an
  66895. ** INTKEY table currently pointing at a valid table entry.
  66896. ** This function modifies the data stored as part of that entry.
  66897. **
  66898. ** Only the data content may only be modified, it is not possible to
  66899. ** change the length of the data stored. If this function is called with
  66900. ** parameters that attempt to write past the end of the existing data,
  66901. ** no modifications are made and SQLITE_CORRUPT is returned.
  66902. */
  66903. SQLITE_PRIVATE int sqlite3BtreePutData(BtCursor *pCsr, u32 offset, u32 amt, void *z){
  66904. int rc;
  66905. assert( cursorOwnsBtShared(pCsr) );
  66906. assert( sqlite3_mutex_held(pCsr->pBtree->db->mutex) );
  66907. assert( pCsr->curFlags & BTCF_Incrblob );
  66908. rc = restoreCursorPosition(pCsr);
  66909. if( rc!=SQLITE_OK ){
  66910. return rc;
  66911. }
  66912. assert( pCsr->eState!=CURSOR_REQUIRESEEK );
  66913. if( pCsr->eState!=CURSOR_VALID ){
  66914. return SQLITE_ABORT;
  66915. }
  66916. /* Save the positions of all other cursors open on this table. This is
  66917. ** required in case any of them are holding references to an xFetch
  66918. ** version of the b-tree page modified by the accessPayload call below.
  66919. **
  66920. ** Note that pCsr must be open on a INTKEY table and saveCursorPosition()
  66921. ** and hence saveAllCursors() cannot fail on a BTREE_INTKEY table, hence
  66922. ** saveAllCursors can only return SQLITE_OK.
  66923. */
  66924. VVA_ONLY(rc =) saveAllCursors(pCsr->pBt, pCsr->pgnoRoot, pCsr);
  66925. assert( rc==SQLITE_OK );
  66926. /* Check some assumptions:
  66927. ** (a) the cursor is open for writing,
  66928. ** (b) there is a read/write transaction open,
  66929. ** (c) the connection holds a write-lock on the table (if required),
  66930. ** (d) there are no conflicting read-locks, and
  66931. ** (e) the cursor points at a valid row of an intKey table.
  66932. */
  66933. if( (pCsr->curFlags & BTCF_WriteFlag)==0 ){
  66934. return SQLITE_READONLY;
  66935. }
  66936. assert( (pCsr->pBt->btsFlags & BTS_READ_ONLY)==0
  66937. && pCsr->pBt->inTransaction==TRANS_WRITE );
  66938. assert( hasSharedCacheTableLock(pCsr->pBtree, pCsr->pgnoRoot, 0, 2) );
  66939. assert( !hasReadConflicts(pCsr->pBtree, pCsr->pgnoRoot) );
  66940. assert( pCsr->pPage->intKey );
  66941. return accessPayload(pCsr, offset, amt, (unsigned char *)z, 1);
  66942. }
  66943. /*
  66944. ** Mark this cursor as an incremental blob cursor.
  66945. */
  66946. SQLITE_PRIVATE void sqlite3BtreeIncrblobCursor(BtCursor *pCur){
  66947. pCur->curFlags |= BTCF_Incrblob;
  66948. pCur->pBtree->hasIncrblobCur = 1;
  66949. }
  66950. #endif
  66951. /*
  66952. ** Set both the "read version" (single byte at byte offset 18) and
  66953. ** "write version" (single byte at byte offset 19) fields in the database
  66954. ** header to iVersion.
  66955. */
  66956. SQLITE_PRIVATE int sqlite3BtreeSetVersion(Btree *pBtree, int iVersion){
  66957. BtShared *pBt = pBtree->pBt;
  66958. int rc; /* Return code */
  66959. assert( iVersion==1 || iVersion==2 );
  66960. /* If setting the version fields to 1, do not automatically open the
  66961. ** WAL connection, even if the version fields are currently set to 2.
  66962. */
  66963. pBt->btsFlags &= ~BTS_NO_WAL;
  66964. if( iVersion==1 ) pBt->btsFlags |= BTS_NO_WAL;
  66965. rc = sqlite3BtreeBeginTrans(pBtree, 0);
  66966. if( rc==SQLITE_OK ){
  66967. u8 *aData = pBt->pPage1->aData;
  66968. if( aData[18]!=(u8)iVersion || aData[19]!=(u8)iVersion ){
  66969. rc = sqlite3BtreeBeginTrans(pBtree, 2);
  66970. if( rc==SQLITE_OK ){
  66971. rc = sqlite3PagerWrite(pBt->pPage1->pDbPage);
  66972. if( rc==SQLITE_OK ){
  66973. aData[18] = (u8)iVersion;
  66974. aData[19] = (u8)iVersion;
  66975. }
  66976. }
  66977. }
  66978. }
  66979. pBt->btsFlags &= ~BTS_NO_WAL;
  66980. return rc;
  66981. }
  66982. /*
  66983. ** Return true if the cursor has a hint specified. This routine is
  66984. ** only used from within assert() statements
  66985. */
  66986. SQLITE_PRIVATE int sqlite3BtreeCursorHasHint(BtCursor *pCsr, unsigned int mask){
  66987. return (pCsr->hints & mask)!=0;
  66988. }
  66989. /*
  66990. ** Return true if the given Btree is read-only.
  66991. */
  66992. SQLITE_PRIVATE int sqlite3BtreeIsReadonly(Btree *p){
  66993. return (p->pBt->btsFlags & BTS_READ_ONLY)!=0;
  66994. }
  66995. /*
  66996. ** Return the size of the header added to each page by this module.
  66997. */
  66998. SQLITE_PRIVATE int sqlite3HeaderSizeBtree(void){ return ROUND8(sizeof(MemPage)); }
  66999. #if !defined(SQLITE_OMIT_SHARED_CACHE)
  67000. /*
  67001. ** Return true if the Btree passed as the only argument is sharable.
  67002. */
  67003. SQLITE_PRIVATE int sqlite3BtreeSharable(Btree *p){
  67004. return p->sharable;
  67005. }
  67006. /*
  67007. ** Return the number of connections to the BtShared object accessed by
  67008. ** the Btree handle passed as the only argument. For private caches
  67009. ** this is always 1. For shared caches it may be 1 or greater.
  67010. */
  67011. SQLITE_PRIVATE int sqlite3BtreeConnectionCount(Btree *p){
  67012. testcase( p->sharable );
  67013. return p->pBt->nRef;
  67014. }
  67015. #endif
  67016. /************** End of btree.c ***********************************************/
  67017. /************** Begin file backup.c ******************************************/
  67018. /*
  67019. ** 2009 January 28
  67020. **
  67021. ** The author disclaims copyright to this source code. In place of
  67022. ** a legal notice, here is a blessing:
  67023. **
  67024. ** May you do good and not evil.
  67025. ** May you find forgiveness for yourself and forgive others.
  67026. ** May you share freely, never taking more than you give.
  67027. **
  67028. *************************************************************************
  67029. ** This file contains the implementation of the sqlite3_backup_XXX()
  67030. ** API functions and the related features.
  67031. */
  67032. /* #include "sqliteInt.h" */
  67033. /* #include "btreeInt.h" */
  67034. /*
  67035. ** Structure allocated for each backup operation.
  67036. */
  67037. struct sqlite3_backup {
  67038. sqlite3* pDestDb; /* Destination database handle */
  67039. Btree *pDest; /* Destination b-tree file */
  67040. u32 iDestSchema; /* Original schema cookie in destination */
  67041. int bDestLocked; /* True once a write-transaction is open on pDest */
  67042. Pgno iNext; /* Page number of the next source page to copy */
  67043. sqlite3* pSrcDb; /* Source database handle */
  67044. Btree *pSrc; /* Source b-tree file */
  67045. int rc; /* Backup process error code */
  67046. /* These two variables are set by every call to backup_step(). They are
  67047. ** read by calls to backup_remaining() and backup_pagecount().
  67048. */
  67049. Pgno nRemaining; /* Number of pages left to copy */
  67050. Pgno nPagecount; /* Total number of pages to copy */
  67051. int isAttached; /* True once backup has been registered with pager */
  67052. sqlite3_backup *pNext; /* Next backup associated with source pager */
  67053. };
  67054. /*
  67055. ** THREAD SAFETY NOTES:
  67056. **
  67057. ** Once it has been created using backup_init(), a single sqlite3_backup
  67058. ** structure may be accessed via two groups of thread-safe entry points:
  67059. **
  67060. ** * Via the sqlite3_backup_XXX() API function backup_step() and
  67061. ** backup_finish(). Both these functions obtain the source database
  67062. ** handle mutex and the mutex associated with the source BtShared
  67063. ** structure, in that order.
  67064. **
  67065. ** * Via the BackupUpdate() and BackupRestart() functions, which are
  67066. ** invoked by the pager layer to report various state changes in
  67067. ** the page cache associated with the source database. The mutex
  67068. ** associated with the source database BtShared structure will always
  67069. ** be held when either of these functions are invoked.
  67070. **
  67071. ** The other sqlite3_backup_XXX() API functions, backup_remaining() and
  67072. ** backup_pagecount() are not thread-safe functions. If they are called
  67073. ** while some other thread is calling backup_step() or backup_finish(),
  67074. ** the values returned may be invalid. There is no way for a call to
  67075. ** BackupUpdate() or BackupRestart() to interfere with backup_remaining()
  67076. ** or backup_pagecount().
  67077. **
  67078. ** Depending on the SQLite configuration, the database handles and/or
  67079. ** the Btree objects may have their own mutexes that require locking.
  67080. ** Non-sharable Btrees (in-memory databases for example), do not have
  67081. ** associated mutexes.
  67082. */
  67083. /*
  67084. ** Return a pointer corresponding to database zDb (i.e. "main", "temp")
  67085. ** in connection handle pDb. If such a database cannot be found, return
  67086. ** a NULL pointer and write an error message to pErrorDb.
  67087. **
  67088. ** If the "temp" database is requested, it may need to be opened by this
  67089. ** function. If an error occurs while doing so, return 0 and write an
  67090. ** error message to pErrorDb.
  67091. */
  67092. static Btree *findBtree(sqlite3 *pErrorDb, sqlite3 *pDb, const char *zDb){
  67093. int i = sqlite3FindDbName(pDb, zDb);
  67094. if( i==1 ){
  67095. Parse sParse;
  67096. int rc = 0;
  67097. memset(&sParse, 0, sizeof(sParse));
  67098. sParse.db = pDb;
  67099. if( sqlite3OpenTempDatabase(&sParse) ){
  67100. sqlite3ErrorWithMsg(pErrorDb, sParse.rc, "%s", sParse.zErrMsg);
  67101. rc = SQLITE_ERROR;
  67102. }
  67103. sqlite3DbFree(pErrorDb, sParse.zErrMsg);
  67104. sqlite3ParserReset(&sParse);
  67105. if( rc ){
  67106. return 0;
  67107. }
  67108. }
  67109. if( i<0 ){
  67110. sqlite3ErrorWithMsg(pErrorDb, SQLITE_ERROR, "unknown database %s", zDb);
  67111. return 0;
  67112. }
  67113. return pDb->aDb[i].pBt;
  67114. }
  67115. /*
  67116. ** Attempt to set the page size of the destination to match the page size
  67117. ** of the source.
  67118. */
  67119. static int setDestPgsz(sqlite3_backup *p){
  67120. int rc;
  67121. rc = sqlite3BtreeSetPageSize(p->pDest,sqlite3BtreeGetPageSize(p->pSrc),-1,0);
  67122. return rc;
  67123. }
  67124. /*
  67125. ** Check that there is no open read-transaction on the b-tree passed as the
  67126. ** second argument. If there is not, return SQLITE_OK. Otherwise, if there
  67127. ** is an open read-transaction, return SQLITE_ERROR and leave an error
  67128. ** message in database handle db.
  67129. */
  67130. static int checkReadTransaction(sqlite3 *db, Btree *p){
  67131. if( sqlite3BtreeIsInReadTrans(p) ){
  67132. sqlite3ErrorWithMsg(db, SQLITE_ERROR, "destination database is in use");
  67133. return SQLITE_ERROR;
  67134. }
  67135. return SQLITE_OK;
  67136. }
  67137. /*
  67138. ** Create an sqlite3_backup process to copy the contents of zSrcDb from
  67139. ** connection handle pSrcDb to zDestDb in pDestDb. If successful, return
  67140. ** a pointer to the new sqlite3_backup object.
  67141. **
  67142. ** If an error occurs, NULL is returned and an error code and error message
  67143. ** stored in database handle pDestDb.
  67144. */
  67145. SQLITE_API sqlite3_backup *sqlite3_backup_init(
  67146. sqlite3* pDestDb, /* Database to write to */
  67147. const char *zDestDb, /* Name of database within pDestDb */
  67148. sqlite3* pSrcDb, /* Database connection to read from */
  67149. const char *zSrcDb /* Name of database within pSrcDb */
  67150. ){
  67151. sqlite3_backup *p; /* Value to return */
  67152. #ifdef SQLITE_ENABLE_API_ARMOR
  67153. if( !sqlite3SafetyCheckOk(pSrcDb)||!sqlite3SafetyCheckOk(pDestDb) ){
  67154. (void)SQLITE_MISUSE_BKPT;
  67155. return 0;
  67156. }
  67157. #endif
  67158. /* Lock the source database handle. The destination database
  67159. ** handle is not locked in this routine, but it is locked in
  67160. ** sqlite3_backup_step(). The user is required to ensure that no
  67161. ** other thread accesses the destination handle for the duration
  67162. ** of the backup operation. Any attempt to use the destination
  67163. ** database connection while a backup is in progress may cause
  67164. ** a malfunction or a deadlock.
  67165. */
  67166. sqlite3_mutex_enter(pSrcDb->mutex);
  67167. sqlite3_mutex_enter(pDestDb->mutex);
  67168. if( pSrcDb==pDestDb ){
  67169. sqlite3ErrorWithMsg(
  67170. pDestDb, SQLITE_ERROR, "source and destination must be distinct"
  67171. );
  67172. p = 0;
  67173. }else {
  67174. /* Allocate space for a new sqlite3_backup object...
  67175. ** EVIDENCE-OF: R-64852-21591 The sqlite3_backup object is created by a
  67176. ** call to sqlite3_backup_init() and is destroyed by a call to
  67177. ** sqlite3_backup_finish(). */
  67178. p = (sqlite3_backup *)sqlite3MallocZero(sizeof(sqlite3_backup));
  67179. if( !p ){
  67180. sqlite3Error(pDestDb, SQLITE_NOMEM_BKPT);
  67181. }
  67182. }
  67183. /* If the allocation succeeded, populate the new object. */
  67184. if( p ){
  67185. p->pSrc = findBtree(pDestDb, pSrcDb, zSrcDb);
  67186. p->pDest = findBtree(pDestDb, pDestDb, zDestDb);
  67187. p->pDestDb = pDestDb;
  67188. p->pSrcDb = pSrcDb;
  67189. p->iNext = 1;
  67190. p->isAttached = 0;
  67191. if( 0==p->pSrc || 0==p->pDest
  67192. || checkReadTransaction(pDestDb, p->pDest)!=SQLITE_OK
  67193. ){
  67194. /* One (or both) of the named databases did not exist or an OOM
  67195. ** error was hit. Or there is a transaction open on the destination
  67196. ** database. The error has already been written into the pDestDb
  67197. ** handle. All that is left to do here is free the sqlite3_backup
  67198. ** structure. */
  67199. sqlite3_free(p);
  67200. p = 0;
  67201. }
  67202. }
  67203. if( p ){
  67204. p->pSrc->nBackup++;
  67205. }
  67206. sqlite3_mutex_leave(pDestDb->mutex);
  67207. sqlite3_mutex_leave(pSrcDb->mutex);
  67208. return p;
  67209. }
  67210. /*
  67211. ** Argument rc is an SQLite error code. Return true if this error is
  67212. ** considered fatal if encountered during a backup operation. All errors
  67213. ** are considered fatal except for SQLITE_BUSY and SQLITE_LOCKED.
  67214. */
  67215. static int isFatalError(int rc){
  67216. return (rc!=SQLITE_OK && rc!=SQLITE_BUSY && ALWAYS(rc!=SQLITE_LOCKED));
  67217. }
  67218. /*
  67219. ** Parameter zSrcData points to a buffer containing the data for
  67220. ** page iSrcPg from the source database. Copy this data into the
  67221. ** destination database.
  67222. */
  67223. static int backupOnePage(
  67224. sqlite3_backup *p, /* Backup handle */
  67225. Pgno iSrcPg, /* Source database page to backup */
  67226. const u8 *zSrcData, /* Source database page data */
  67227. int bUpdate /* True for an update, false otherwise */
  67228. ){
  67229. Pager * const pDestPager = sqlite3BtreePager(p->pDest);
  67230. const int nSrcPgsz = sqlite3BtreeGetPageSize(p->pSrc);
  67231. int nDestPgsz = sqlite3BtreeGetPageSize(p->pDest);
  67232. const int nCopy = MIN(nSrcPgsz, nDestPgsz);
  67233. const i64 iEnd = (i64)iSrcPg*(i64)nSrcPgsz;
  67234. #ifdef SQLITE_HAS_CODEC
  67235. /* Use BtreeGetReserveNoMutex() for the source b-tree, as although it is
  67236. ** guaranteed that the shared-mutex is held by this thread, handle
  67237. ** p->pSrc may not actually be the owner. */
  67238. int nSrcReserve = sqlite3BtreeGetReserveNoMutex(p->pSrc);
  67239. int nDestReserve = sqlite3BtreeGetOptimalReserve(p->pDest);
  67240. #endif
  67241. int rc = SQLITE_OK;
  67242. i64 iOff;
  67243. assert( sqlite3BtreeGetReserveNoMutex(p->pSrc)>=0 );
  67244. assert( p->bDestLocked );
  67245. assert( !isFatalError(p->rc) );
  67246. assert( iSrcPg!=PENDING_BYTE_PAGE(p->pSrc->pBt) );
  67247. assert( zSrcData );
  67248. /* Catch the case where the destination is an in-memory database and the
  67249. ** page sizes of the source and destination differ.
  67250. */
  67251. if( nSrcPgsz!=nDestPgsz && sqlite3PagerIsMemdb(pDestPager) ){
  67252. rc = SQLITE_READONLY;
  67253. }
  67254. #ifdef SQLITE_HAS_CODEC
  67255. /* Backup is not possible if the page size of the destination is changing
  67256. ** and a codec is in use.
  67257. */
  67258. if( nSrcPgsz!=nDestPgsz && sqlite3PagerGetCodec(pDestPager)!=0 ){
  67259. rc = SQLITE_READONLY;
  67260. }
  67261. /* Backup is not possible if the number of bytes of reserve space differ
  67262. ** between source and destination. If there is a difference, try to
  67263. ** fix the destination to agree with the source. If that is not possible,
  67264. ** then the backup cannot proceed.
  67265. */
  67266. if( nSrcReserve!=nDestReserve ){
  67267. u32 newPgsz = nSrcPgsz;
  67268. rc = sqlite3PagerSetPagesize(pDestPager, &newPgsz, nSrcReserve);
  67269. if( rc==SQLITE_OK && newPgsz!=nSrcPgsz ) rc = SQLITE_READONLY;
  67270. }
  67271. #endif
  67272. /* This loop runs once for each destination page spanned by the source
  67273. ** page. For each iteration, variable iOff is set to the byte offset
  67274. ** of the destination page.
  67275. */
  67276. for(iOff=iEnd-(i64)nSrcPgsz; rc==SQLITE_OK && iOff<iEnd; iOff+=nDestPgsz){
  67277. DbPage *pDestPg = 0;
  67278. Pgno iDest = (Pgno)(iOff/nDestPgsz)+1;
  67279. if( iDest==PENDING_BYTE_PAGE(p->pDest->pBt) ) continue;
  67280. if( SQLITE_OK==(rc = sqlite3PagerGet(pDestPager, iDest, &pDestPg, 0))
  67281. && SQLITE_OK==(rc = sqlite3PagerWrite(pDestPg))
  67282. ){
  67283. const u8 *zIn = &zSrcData[iOff%nSrcPgsz];
  67284. u8 *zDestData = sqlite3PagerGetData(pDestPg);
  67285. u8 *zOut = &zDestData[iOff%nDestPgsz];
  67286. /* Copy the data from the source page into the destination page.
  67287. ** Then clear the Btree layer MemPage.isInit flag. Both this module
  67288. ** and the pager code use this trick (clearing the first byte
  67289. ** of the page 'extra' space to invalidate the Btree layers
  67290. ** cached parse of the page). MemPage.isInit is marked
  67291. ** "MUST BE FIRST" for this purpose.
  67292. */
  67293. memcpy(zOut, zIn, nCopy);
  67294. ((u8 *)sqlite3PagerGetExtra(pDestPg))[0] = 0;
  67295. if( iOff==0 && bUpdate==0 ){
  67296. sqlite3Put4byte(&zOut[28], sqlite3BtreeLastPage(p->pSrc));
  67297. }
  67298. }
  67299. sqlite3PagerUnref(pDestPg);
  67300. }
  67301. return rc;
  67302. }
  67303. /*
  67304. ** If pFile is currently larger than iSize bytes, then truncate it to
  67305. ** exactly iSize bytes. If pFile is not larger than iSize bytes, then
  67306. ** this function is a no-op.
  67307. **
  67308. ** Return SQLITE_OK if everything is successful, or an SQLite error
  67309. ** code if an error occurs.
  67310. */
  67311. static int backupTruncateFile(sqlite3_file *pFile, i64 iSize){
  67312. i64 iCurrent;
  67313. int rc = sqlite3OsFileSize(pFile, &iCurrent);
  67314. if( rc==SQLITE_OK && iCurrent>iSize ){
  67315. rc = sqlite3OsTruncate(pFile, iSize);
  67316. }
  67317. return rc;
  67318. }
  67319. /*
  67320. ** Register this backup object with the associated source pager for
  67321. ** callbacks when pages are changed or the cache invalidated.
  67322. */
  67323. static void attachBackupObject(sqlite3_backup *p){
  67324. sqlite3_backup **pp;
  67325. assert( sqlite3BtreeHoldsMutex(p->pSrc) );
  67326. pp = sqlite3PagerBackupPtr(sqlite3BtreePager(p->pSrc));
  67327. p->pNext = *pp;
  67328. *pp = p;
  67329. p->isAttached = 1;
  67330. }
  67331. /*
  67332. ** Copy nPage pages from the source b-tree to the destination.
  67333. */
  67334. SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage){
  67335. int rc;
  67336. int destMode; /* Destination journal mode */
  67337. int pgszSrc = 0; /* Source page size */
  67338. int pgszDest = 0; /* Destination page size */
  67339. #ifdef SQLITE_ENABLE_API_ARMOR
  67340. if( p==0 ) return SQLITE_MISUSE_BKPT;
  67341. #endif
  67342. sqlite3_mutex_enter(p->pSrcDb->mutex);
  67343. sqlite3BtreeEnter(p->pSrc);
  67344. if( p->pDestDb ){
  67345. sqlite3_mutex_enter(p->pDestDb->mutex);
  67346. }
  67347. rc = p->rc;
  67348. if( !isFatalError(rc) ){
  67349. Pager * const pSrcPager = sqlite3BtreePager(p->pSrc); /* Source pager */
  67350. Pager * const pDestPager = sqlite3BtreePager(p->pDest); /* Dest pager */
  67351. int ii; /* Iterator variable */
  67352. int nSrcPage = -1; /* Size of source db in pages */
  67353. int bCloseTrans = 0; /* True if src db requires unlocking */
  67354. /* If the source pager is currently in a write-transaction, return
  67355. ** SQLITE_BUSY immediately.
  67356. */
  67357. if( p->pDestDb && p->pSrc->pBt->inTransaction==TRANS_WRITE ){
  67358. rc = SQLITE_BUSY;
  67359. }else{
  67360. rc = SQLITE_OK;
  67361. }
  67362. /* If there is no open read-transaction on the source database, open
  67363. ** one now. If a transaction is opened here, then it will be closed
  67364. ** before this function exits.
  67365. */
  67366. if( rc==SQLITE_OK && 0==sqlite3BtreeIsInReadTrans(p->pSrc) ){
  67367. rc = sqlite3BtreeBeginTrans(p->pSrc, 0);
  67368. bCloseTrans = 1;
  67369. }
  67370. /* If the destination database has not yet been locked (i.e. if this
  67371. ** is the first call to backup_step() for the current backup operation),
  67372. ** try to set its page size to the same as the source database. This
  67373. ** is especially important on ZipVFS systems, as in that case it is
  67374. ** not possible to create a database file that uses one page size by
  67375. ** writing to it with another. */
  67376. if( p->bDestLocked==0 && rc==SQLITE_OK && setDestPgsz(p)==SQLITE_NOMEM ){
  67377. rc = SQLITE_NOMEM;
  67378. }
  67379. /* Lock the destination database, if it is not locked already. */
  67380. if( SQLITE_OK==rc && p->bDestLocked==0
  67381. && SQLITE_OK==(rc = sqlite3BtreeBeginTrans(p->pDest, 2))
  67382. ){
  67383. p->bDestLocked = 1;
  67384. sqlite3BtreeGetMeta(p->pDest, BTREE_SCHEMA_VERSION, &p->iDestSchema);
  67385. }
  67386. /* Do not allow backup if the destination database is in WAL mode
  67387. ** and the page sizes are different between source and destination */
  67388. pgszSrc = sqlite3BtreeGetPageSize(p->pSrc);
  67389. pgszDest = sqlite3BtreeGetPageSize(p->pDest);
  67390. destMode = sqlite3PagerGetJournalMode(sqlite3BtreePager(p->pDest));
  67391. if( SQLITE_OK==rc && destMode==PAGER_JOURNALMODE_WAL && pgszSrc!=pgszDest ){
  67392. rc = SQLITE_READONLY;
  67393. }
  67394. /* Now that there is a read-lock on the source database, query the
  67395. ** source pager for the number of pages in the database.
  67396. */
  67397. nSrcPage = (int)sqlite3BtreeLastPage(p->pSrc);
  67398. assert( nSrcPage>=0 );
  67399. for(ii=0; (nPage<0 || ii<nPage) && p->iNext<=(Pgno)nSrcPage && !rc; ii++){
  67400. const Pgno iSrcPg = p->iNext; /* Source page number */
  67401. if( iSrcPg!=PENDING_BYTE_PAGE(p->pSrc->pBt) ){
  67402. DbPage *pSrcPg; /* Source page object */
  67403. rc = sqlite3PagerGet(pSrcPager, iSrcPg, &pSrcPg,PAGER_GET_READONLY);
  67404. if( rc==SQLITE_OK ){
  67405. rc = backupOnePage(p, iSrcPg, sqlite3PagerGetData(pSrcPg), 0);
  67406. sqlite3PagerUnref(pSrcPg);
  67407. }
  67408. }
  67409. p->iNext++;
  67410. }
  67411. if( rc==SQLITE_OK ){
  67412. p->nPagecount = nSrcPage;
  67413. p->nRemaining = nSrcPage+1-p->iNext;
  67414. if( p->iNext>(Pgno)nSrcPage ){
  67415. rc = SQLITE_DONE;
  67416. }else if( !p->isAttached ){
  67417. attachBackupObject(p);
  67418. }
  67419. }
  67420. /* Update the schema version field in the destination database. This
  67421. ** is to make sure that the schema-version really does change in
  67422. ** the case where the source and destination databases have the
  67423. ** same schema version.
  67424. */
  67425. if( rc==SQLITE_DONE ){
  67426. if( nSrcPage==0 ){
  67427. rc = sqlite3BtreeNewDb(p->pDest);
  67428. nSrcPage = 1;
  67429. }
  67430. if( rc==SQLITE_OK || rc==SQLITE_DONE ){
  67431. rc = sqlite3BtreeUpdateMeta(p->pDest,1,p->iDestSchema+1);
  67432. }
  67433. if( rc==SQLITE_OK ){
  67434. if( p->pDestDb ){
  67435. sqlite3ResetAllSchemasOfConnection(p->pDestDb);
  67436. }
  67437. if( destMode==PAGER_JOURNALMODE_WAL ){
  67438. rc = sqlite3BtreeSetVersion(p->pDest, 2);
  67439. }
  67440. }
  67441. if( rc==SQLITE_OK ){
  67442. int nDestTruncate;
  67443. /* Set nDestTruncate to the final number of pages in the destination
  67444. ** database. The complication here is that the destination page
  67445. ** size may be different to the source page size.
  67446. **
  67447. ** If the source page size is smaller than the destination page size,
  67448. ** round up. In this case the call to sqlite3OsTruncate() below will
  67449. ** fix the size of the file. However it is important to call
  67450. ** sqlite3PagerTruncateImage() here so that any pages in the
  67451. ** destination file that lie beyond the nDestTruncate page mark are
  67452. ** journalled by PagerCommitPhaseOne() before they are destroyed
  67453. ** by the file truncation.
  67454. */
  67455. assert( pgszSrc==sqlite3BtreeGetPageSize(p->pSrc) );
  67456. assert( pgszDest==sqlite3BtreeGetPageSize(p->pDest) );
  67457. if( pgszSrc<pgszDest ){
  67458. int ratio = pgszDest/pgszSrc;
  67459. nDestTruncate = (nSrcPage+ratio-1)/ratio;
  67460. if( nDestTruncate==(int)PENDING_BYTE_PAGE(p->pDest->pBt) ){
  67461. nDestTruncate--;
  67462. }
  67463. }else{
  67464. nDestTruncate = nSrcPage * (pgszSrc/pgszDest);
  67465. }
  67466. assert( nDestTruncate>0 );
  67467. if( pgszSrc<pgszDest ){
  67468. /* If the source page-size is smaller than the destination page-size,
  67469. ** two extra things may need to happen:
  67470. **
  67471. ** * The destination may need to be truncated, and
  67472. **
  67473. ** * Data stored on the pages immediately following the
  67474. ** pending-byte page in the source database may need to be
  67475. ** copied into the destination database.
  67476. */
  67477. const i64 iSize = (i64)pgszSrc * (i64)nSrcPage;
  67478. sqlite3_file * const pFile = sqlite3PagerFile(pDestPager);
  67479. Pgno iPg;
  67480. int nDstPage;
  67481. i64 iOff;
  67482. i64 iEnd;
  67483. assert( pFile );
  67484. assert( nDestTruncate==0
  67485. || (i64)nDestTruncate*(i64)pgszDest >= iSize || (
  67486. nDestTruncate==(int)(PENDING_BYTE_PAGE(p->pDest->pBt)-1)
  67487. && iSize>=PENDING_BYTE && iSize<=PENDING_BYTE+pgszDest
  67488. ));
  67489. /* This block ensures that all data required to recreate the original
  67490. ** database has been stored in the journal for pDestPager and the
  67491. ** journal synced to disk. So at this point we may safely modify
  67492. ** the database file in any way, knowing that if a power failure
  67493. ** occurs, the original database will be reconstructed from the
  67494. ** journal file. */
  67495. sqlite3PagerPagecount(pDestPager, &nDstPage);
  67496. for(iPg=nDestTruncate; rc==SQLITE_OK && iPg<=(Pgno)nDstPage; iPg++){
  67497. if( iPg!=PENDING_BYTE_PAGE(p->pDest->pBt) ){
  67498. DbPage *pPg;
  67499. rc = sqlite3PagerGet(pDestPager, iPg, &pPg, 0);
  67500. if( rc==SQLITE_OK ){
  67501. rc = sqlite3PagerWrite(pPg);
  67502. sqlite3PagerUnref(pPg);
  67503. }
  67504. }
  67505. }
  67506. if( rc==SQLITE_OK ){
  67507. rc = sqlite3PagerCommitPhaseOne(pDestPager, 0, 1);
  67508. }
  67509. /* Write the extra pages and truncate the database file as required */
  67510. iEnd = MIN(PENDING_BYTE + pgszDest, iSize);
  67511. for(
  67512. iOff=PENDING_BYTE+pgszSrc;
  67513. rc==SQLITE_OK && iOff<iEnd;
  67514. iOff+=pgszSrc
  67515. ){
  67516. PgHdr *pSrcPg = 0;
  67517. const Pgno iSrcPg = (Pgno)((iOff/pgszSrc)+1);
  67518. rc = sqlite3PagerGet(pSrcPager, iSrcPg, &pSrcPg, 0);
  67519. if( rc==SQLITE_OK ){
  67520. u8 *zData = sqlite3PagerGetData(pSrcPg);
  67521. rc = sqlite3OsWrite(pFile, zData, pgszSrc, iOff);
  67522. }
  67523. sqlite3PagerUnref(pSrcPg);
  67524. }
  67525. if( rc==SQLITE_OK ){
  67526. rc = backupTruncateFile(pFile, iSize);
  67527. }
  67528. /* Sync the database file to disk. */
  67529. if( rc==SQLITE_OK ){
  67530. rc = sqlite3PagerSync(pDestPager, 0);
  67531. }
  67532. }else{
  67533. sqlite3PagerTruncateImage(pDestPager, nDestTruncate);
  67534. rc = sqlite3PagerCommitPhaseOne(pDestPager, 0, 0);
  67535. }
  67536. /* Finish committing the transaction to the destination database. */
  67537. if( SQLITE_OK==rc
  67538. && SQLITE_OK==(rc = sqlite3BtreeCommitPhaseTwo(p->pDest, 0))
  67539. ){
  67540. rc = SQLITE_DONE;
  67541. }
  67542. }
  67543. }
  67544. /* If bCloseTrans is true, then this function opened a read transaction
  67545. ** on the source database. Close the read transaction here. There is
  67546. ** no need to check the return values of the btree methods here, as
  67547. ** "committing" a read-only transaction cannot fail.
  67548. */
  67549. if( bCloseTrans ){
  67550. TESTONLY( int rc2 );
  67551. TESTONLY( rc2 = ) sqlite3BtreeCommitPhaseOne(p->pSrc, 0);
  67552. TESTONLY( rc2 |= ) sqlite3BtreeCommitPhaseTwo(p->pSrc, 0);
  67553. assert( rc2==SQLITE_OK );
  67554. }
  67555. if( rc==SQLITE_IOERR_NOMEM ){
  67556. rc = SQLITE_NOMEM_BKPT;
  67557. }
  67558. p->rc = rc;
  67559. }
  67560. if( p->pDestDb ){
  67561. sqlite3_mutex_leave(p->pDestDb->mutex);
  67562. }
  67563. sqlite3BtreeLeave(p->pSrc);
  67564. sqlite3_mutex_leave(p->pSrcDb->mutex);
  67565. return rc;
  67566. }
  67567. /*
  67568. ** Release all resources associated with an sqlite3_backup* handle.
  67569. */
  67570. SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p){
  67571. sqlite3_backup **pp; /* Ptr to head of pagers backup list */
  67572. sqlite3 *pSrcDb; /* Source database connection */
  67573. int rc; /* Value to return */
  67574. /* Enter the mutexes */
  67575. if( p==0 ) return SQLITE_OK;
  67576. pSrcDb = p->pSrcDb;
  67577. sqlite3_mutex_enter(pSrcDb->mutex);
  67578. sqlite3BtreeEnter(p->pSrc);
  67579. if( p->pDestDb ){
  67580. sqlite3_mutex_enter(p->pDestDb->mutex);
  67581. }
  67582. /* Detach this backup from the source pager. */
  67583. if( p->pDestDb ){
  67584. p->pSrc->nBackup--;
  67585. }
  67586. if( p->isAttached ){
  67587. pp = sqlite3PagerBackupPtr(sqlite3BtreePager(p->pSrc));
  67588. while( *pp!=p ){
  67589. pp = &(*pp)->pNext;
  67590. }
  67591. *pp = p->pNext;
  67592. }
  67593. /* If a transaction is still open on the Btree, roll it back. */
  67594. sqlite3BtreeRollback(p->pDest, SQLITE_OK, 0);
  67595. /* Set the error code of the destination database handle. */
  67596. rc = (p->rc==SQLITE_DONE) ? SQLITE_OK : p->rc;
  67597. if( p->pDestDb ){
  67598. sqlite3Error(p->pDestDb, rc);
  67599. /* Exit the mutexes and free the backup context structure. */
  67600. sqlite3LeaveMutexAndCloseZombie(p->pDestDb);
  67601. }
  67602. sqlite3BtreeLeave(p->pSrc);
  67603. if( p->pDestDb ){
  67604. /* EVIDENCE-OF: R-64852-21591 The sqlite3_backup object is created by a
  67605. ** call to sqlite3_backup_init() and is destroyed by a call to
  67606. ** sqlite3_backup_finish(). */
  67607. sqlite3_free(p);
  67608. }
  67609. sqlite3LeaveMutexAndCloseZombie(pSrcDb);
  67610. return rc;
  67611. }
  67612. /*
  67613. ** Return the number of pages still to be backed up as of the most recent
  67614. ** call to sqlite3_backup_step().
  67615. */
  67616. SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p){
  67617. #ifdef SQLITE_ENABLE_API_ARMOR
  67618. if( p==0 ){
  67619. (void)SQLITE_MISUSE_BKPT;
  67620. return 0;
  67621. }
  67622. #endif
  67623. return p->nRemaining;
  67624. }
  67625. /*
  67626. ** Return the total number of pages in the source database as of the most
  67627. ** recent call to sqlite3_backup_step().
  67628. */
  67629. SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p){
  67630. #ifdef SQLITE_ENABLE_API_ARMOR
  67631. if( p==0 ){
  67632. (void)SQLITE_MISUSE_BKPT;
  67633. return 0;
  67634. }
  67635. #endif
  67636. return p->nPagecount;
  67637. }
  67638. /*
  67639. ** This function is called after the contents of page iPage of the
  67640. ** source database have been modified. If page iPage has already been
  67641. ** copied into the destination database, then the data written to the
  67642. ** destination is now invalidated. The destination copy of iPage needs
  67643. ** to be updated with the new data before the backup operation is
  67644. ** complete.
  67645. **
  67646. ** It is assumed that the mutex associated with the BtShared object
  67647. ** corresponding to the source database is held when this function is
  67648. ** called.
  67649. */
  67650. static SQLITE_NOINLINE void backupUpdate(
  67651. sqlite3_backup *p,
  67652. Pgno iPage,
  67653. const u8 *aData
  67654. ){
  67655. assert( p!=0 );
  67656. do{
  67657. assert( sqlite3_mutex_held(p->pSrc->pBt->mutex) );
  67658. if( !isFatalError(p->rc) && iPage<p->iNext ){
  67659. /* The backup process p has already copied page iPage. But now it
  67660. ** has been modified by a transaction on the source pager. Copy
  67661. ** the new data into the backup.
  67662. */
  67663. int rc;
  67664. assert( p->pDestDb );
  67665. sqlite3_mutex_enter(p->pDestDb->mutex);
  67666. rc = backupOnePage(p, iPage, aData, 1);
  67667. sqlite3_mutex_leave(p->pDestDb->mutex);
  67668. assert( rc!=SQLITE_BUSY && rc!=SQLITE_LOCKED );
  67669. if( rc!=SQLITE_OK ){
  67670. p->rc = rc;
  67671. }
  67672. }
  67673. }while( (p = p->pNext)!=0 );
  67674. }
  67675. SQLITE_PRIVATE void sqlite3BackupUpdate(sqlite3_backup *pBackup, Pgno iPage, const u8 *aData){
  67676. if( pBackup ) backupUpdate(pBackup, iPage, aData);
  67677. }
  67678. /*
  67679. ** Restart the backup process. This is called when the pager layer
  67680. ** detects that the database has been modified by an external database
  67681. ** connection. In this case there is no way of knowing which of the
  67682. ** pages that have been copied into the destination database are still
  67683. ** valid and which are not, so the entire process needs to be restarted.
  67684. **
  67685. ** It is assumed that the mutex associated with the BtShared object
  67686. ** corresponding to the source database is held when this function is
  67687. ** called.
  67688. */
  67689. SQLITE_PRIVATE void sqlite3BackupRestart(sqlite3_backup *pBackup){
  67690. sqlite3_backup *p; /* Iterator variable */
  67691. for(p=pBackup; p; p=p->pNext){
  67692. assert( sqlite3_mutex_held(p->pSrc->pBt->mutex) );
  67693. p->iNext = 1;
  67694. }
  67695. }
  67696. #ifndef SQLITE_OMIT_VACUUM
  67697. /*
  67698. ** Copy the complete content of pBtFrom into pBtTo. A transaction
  67699. ** must be active for both files.
  67700. **
  67701. ** The size of file pTo may be reduced by this operation. If anything
  67702. ** goes wrong, the transaction on pTo is rolled back. If successful, the
  67703. ** transaction is committed before returning.
  67704. */
  67705. SQLITE_PRIVATE int sqlite3BtreeCopyFile(Btree *pTo, Btree *pFrom){
  67706. int rc;
  67707. sqlite3_file *pFd; /* File descriptor for database pTo */
  67708. sqlite3_backup b;
  67709. sqlite3BtreeEnter(pTo);
  67710. sqlite3BtreeEnter(pFrom);
  67711. assert( sqlite3BtreeIsInTrans(pTo) );
  67712. pFd = sqlite3PagerFile(sqlite3BtreePager(pTo));
  67713. if( pFd->pMethods ){
  67714. i64 nByte = sqlite3BtreeGetPageSize(pFrom)*(i64)sqlite3BtreeLastPage(pFrom);
  67715. rc = sqlite3OsFileControl(pFd, SQLITE_FCNTL_OVERWRITE, &nByte);
  67716. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  67717. if( rc ) goto copy_finished;
  67718. }
  67719. /* Set up an sqlite3_backup object. sqlite3_backup.pDestDb must be set
  67720. ** to 0. This is used by the implementations of sqlite3_backup_step()
  67721. ** and sqlite3_backup_finish() to detect that they are being called
  67722. ** from this function, not directly by the user.
  67723. */
  67724. memset(&b, 0, sizeof(b));
  67725. b.pSrcDb = pFrom->db;
  67726. b.pSrc = pFrom;
  67727. b.pDest = pTo;
  67728. b.iNext = 1;
  67729. #ifdef SQLITE_HAS_CODEC
  67730. sqlite3PagerAlignReserve(sqlite3BtreePager(pTo), sqlite3BtreePager(pFrom));
  67731. #endif
  67732. /* 0x7FFFFFFF is the hard limit for the number of pages in a database
  67733. ** file. By passing this as the number of pages to copy to
  67734. ** sqlite3_backup_step(), we can guarantee that the copy finishes
  67735. ** within a single call (unless an error occurs). The assert() statement
  67736. ** checks this assumption - (p->rc) should be set to either SQLITE_DONE
  67737. ** or an error code. */
  67738. sqlite3_backup_step(&b, 0x7FFFFFFF);
  67739. assert( b.rc!=SQLITE_OK );
  67740. rc = sqlite3_backup_finish(&b);
  67741. if( rc==SQLITE_OK ){
  67742. pTo->pBt->btsFlags &= ~BTS_PAGESIZE_FIXED;
  67743. }else{
  67744. sqlite3PagerClearCache(sqlite3BtreePager(b.pDest));
  67745. }
  67746. assert( sqlite3BtreeIsInTrans(pTo)==0 );
  67747. copy_finished:
  67748. sqlite3BtreeLeave(pFrom);
  67749. sqlite3BtreeLeave(pTo);
  67750. return rc;
  67751. }
  67752. #endif /* SQLITE_OMIT_VACUUM */
  67753. /************** End of backup.c **********************************************/
  67754. /************** Begin file vdbemem.c *****************************************/
  67755. /*
  67756. ** 2004 May 26
  67757. **
  67758. ** The author disclaims copyright to this source code. In place of
  67759. ** a legal notice, here is a blessing:
  67760. **
  67761. ** May you do good and not evil.
  67762. ** May you find forgiveness for yourself and forgive others.
  67763. ** May you share freely, never taking more than you give.
  67764. **
  67765. *************************************************************************
  67766. **
  67767. ** This file contains code use to manipulate "Mem" structure. A "Mem"
  67768. ** stores a single value in the VDBE. Mem is an opaque structure visible
  67769. ** only within the VDBE. Interface routines refer to a Mem using the
  67770. ** name sqlite_value
  67771. */
  67772. /* #include "sqliteInt.h" */
  67773. /* #include "vdbeInt.h" */
  67774. #ifdef SQLITE_DEBUG
  67775. /*
  67776. ** Check invariants on a Mem object.
  67777. **
  67778. ** This routine is intended for use inside of assert() statements, like
  67779. ** this: assert( sqlite3VdbeCheckMemInvariants(pMem) );
  67780. */
  67781. SQLITE_PRIVATE int sqlite3VdbeCheckMemInvariants(Mem *p){
  67782. /* If MEM_Dyn is set then Mem.xDel!=0.
  67783. ** Mem.xDel might not be initialized if MEM_Dyn is clear.
  67784. */
  67785. assert( (p->flags & MEM_Dyn)==0 || p->xDel!=0 );
  67786. /* MEM_Dyn may only be set if Mem.szMalloc==0. In this way we
  67787. ** ensure that if Mem.szMalloc>0 then it is safe to do
  67788. ** Mem.z = Mem.zMalloc without having to check Mem.flags&MEM_Dyn.
  67789. ** That saves a few cycles in inner loops. */
  67790. assert( (p->flags & MEM_Dyn)==0 || p->szMalloc==0 );
  67791. /* Cannot be both MEM_Int and MEM_Real at the same time */
  67792. assert( (p->flags & (MEM_Int|MEM_Real))!=(MEM_Int|MEM_Real) );
  67793. if( p->flags & MEM_Null ){
  67794. /* Cannot be both MEM_Null and some other type */
  67795. assert( (p->flags & (MEM_Int|MEM_Real|MEM_Str|MEM_Blob
  67796. |MEM_RowSet|MEM_Frame|MEM_Agg))==0 );
  67797. /* If MEM_Null is set, then either the value is a pure NULL (the usual
  67798. ** case) or it is a pointer set using sqlite3_bind_pointer() or
  67799. ** sqlite3_result_pointer(). If a pointer, then MEM_Term must also be
  67800. ** set.
  67801. */
  67802. if( (p->flags & (MEM_Term|MEM_Subtype))==(MEM_Term|MEM_Subtype) ){
  67803. /* This is a pointer type. There may be a flag to indicate what to
  67804. ** do with the pointer. */
  67805. assert( ((p->flags&MEM_Dyn)!=0 ? 1 : 0) +
  67806. ((p->flags&MEM_Ephem)!=0 ? 1 : 0) +
  67807. ((p->flags&MEM_Static)!=0 ? 1 : 0) <= 1 );
  67808. /* No other bits set */
  67809. assert( (p->flags & ~(MEM_Null|MEM_Term|MEM_Subtype
  67810. |MEM_Dyn|MEM_Ephem|MEM_Static))==0 );
  67811. }else{
  67812. /* A pure NULL might have other flags, such as MEM_Static, MEM_Dyn,
  67813. ** MEM_Ephem, MEM_Cleared, or MEM_Subtype */
  67814. }
  67815. }else{
  67816. /* The MEM_Cleared bit is only allowed on NULLs */
  67817. assert( (p->flags & MEM_Cleared)==0 );
  67818. }
  67819. /* The szMalloc field holds the correct memory allocation size */
  67820. assert( p->szMalloc==0
  67821. || p->szMalloc==sqlite3DbMallocSize(p->db,p->zMalloc) );
  67822. /* If p holds a string or blob, the Mem.z must point to exactly
  67823. ** one of the following:
  67824. **
  67825. ** (1) Memory in Mem.zMalloc and managed by the Mem object
  67826. ** (2) Memory to be freed using Mem.xDel
  67827. ** (3) An ephemeral string or blob
  67828. ** (4) A static string or blob
  67829. */
  67830. if( (p->flags & (MEM_Str|MEM_Blob)) && p->n>0 ){
  67831. assert(
  67832. ((p->szMalloc>0 && p->z==p->zMalloc)? 1 : 0) +
  67833. ((p->flags&MEM_Dyn)!=0 ? 1 : 0) +
  67834. ((p->flags&MEM_Ephem)!=0 ? 1 : 0) +
  67835. ((p->flags&MEM_Static)!=0 ? 1 : 0) == 1
  67836. );
  67837. }
  67838. return 1;
  67839. }
  67840. #endif
  67841. #ifdef SQLITE_DEBUG
  67842. /*
  67843. ** Check that string value of pMem agrees with its integer or real value.
  67844. **
  67845. ** A single int or real value always converts to the same strings. But
  67846. ** many different strings can be converted into the same int or real.
  67847. ** If a table contains a numeric value and an index is based on the
  67848. ** corresponding string value, then it is important that the string be
  67849. ** derived from the numeric value, not the other way around, to ensure
  67850. ** that the index and table are consistent. See ticket
  67851. ** https://www.sqlite.org/src/info/343634942dd54ab (2018-01-31) for
  67852. ** an example.
  67853. **
  67854. ** This routine looks at pMem to verify that if it has both a numeric
  67855. ** representation and a string representation then the string rep has
  67856. ** been derived from the numeric and not the other way around. It returns
  67857. ** true if everything is ok and false if there is a problem.
  67858. **
  67859. ** This routine is for use inside of assert() statements only.
  67860. */
  67861. SQLITE_PRIVATE int sqlite3VdbeMemConsistentDualRep(Mem *p){
  67862. char zBuf[100];
  67863. char *z;
  67864. int i, j, incr;
  67865. if( (p->flags & MEM_Str)==0 ) return 1;
  67866. if( (p->flags & (MEM_Int|MEM_Real))==0 ) return 1;
  67867. if( p->flags & MEM_Int ){
  67868. sqlite3_snprintf(sizeof(zBuf),zBuf,"%lld",p->u.i);
  67869. }else{
  67870. sqlite3_snprintf(sizeof(zBuf),zBuf,"%!.15g",p->u.r);
  67871. }
  67872. z = p->z;
  67873. i = j = 0;
  67874. incr = 1;
  67875. if( p->enc!=SQLITE_UTF8 ){
  67876. incr = 2;
  67877. if( p->enc==SQLITE_UTF16BE ) z++;
  67878. }
  67879. while( zBuf[j] ){
  67880. if( zBuf[j++]!=z[i] ) return 0;
  67881. i += incr;
  67882. }
  67883. return 1;
  67884. }
  67885. #endif /* SQLITE_DEBUG */
  67886. /*
  67887. ** If pMem is an object with a valid string representation, this routine
  67888. ** ensures the internal encoding for the string representation is
  67889. ** 'desiredEnc', one of SQLITE_UTF8, SQLITE_UTF16LE or SQLITE_UTF16BE.
  67890. **
  67891. ** If pMem is not a string object, or the encoding of the string
  67892. ** representation is already stored using the requested encoding, then this
  67893. ** routine is a no-op.
  67894. **
  67895. ** SQLITE_OK is returned if the conversion is successful (or not required).
  67896. ** SQLITE_NOMEM may be returned if a malloc() fails during conversion
  67897. ** between formats.
  67898. */
  67899. SQLITE_PRIVATE int sqlite3VdbeChangeEncoding(Mem *pMem, int desiredEnc){
  67900. #ifndef SQLITE_OMIT_UTF16
  67901. int rc;
  67902. #endif
  67903. assert( (pMem->flags&MEM_RowSet)==0 );
  67904. assert( desiredEnc==SQLITE_UTF8 || desiredEnc==SQLITE_UTF16LE
  67905. || desiredEnc==SQLITE_UTF16BE );
  67906. if( !(pMem->flags&MEM_Str) || pMem->enc==desiredEnc ){
  67907. return SQLITE_OK;
  67908. }
  67909. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  67910. #ifdef SQLITE_OMIT_UTF16
  67911. return SQLITE_ERROR;
  67912. #else
  67913. /* MemTranslate() may return SQLITE_OK or SQLITE_NOMEM. If NOMEM is returned,
  67914. ** then the encoding of the value may not have changed.
  67915. */
  67916. rc = sqlite3VdbeMemTranslate(pMem, (u8)desiredEnc);
  67917. assert(rc==SQLITE_OK || rc==SQLITE_NOMEM);
  67918. assert(rc==SQLITE_OK || pMem->enc!=desiredEnc);
  67919. assert(rc==SQLITE_NOMEM || pMem->enc==desiredEnc);
  67920. return rc;
  67921. #endif
  67922. }
  67923. /*
  67924. ** Make sure pMem->z points to a writable allocation of at least
  67925. ** min(n,32) bytes.
  67926. **
  67927. ** If the bPreserve argument is true, then copy of the content of
  67928. ** pMem->z into the new allocation. pMem must be either a string or
  67929. ** blob if bPreserve is true. If bPreserve is false, any prior content
  67930. ** in pMem->z is discarded.
  67931. */
  67932. SQLITE_PRIVATE SQLITE_NOINLINE int sqlite3VdbeMemGrow(Mem *pMem, int n, int bPreserve){
  67933. assert( sqlite3VdbeCheckMemInvariants(pMem) );
  67934. assert( (pMem->flags&MEM_RowSet)==0 );
  67935. testcase( pMem->db==0 );
  67936. /* If the bPreserve flag is set to true, then the memory cell must already
  67937. ** contain a valid string or blob value. */
  67938. assert( bPreserve==0 || pMem->flags&(MEM_Blob|MEM_Str) );
  67939. testcase( bPreserve && pMem->z==0 );
  67940. assert( pMem->szMalloc==0
  67941. || pMem->szMalloc==sqlite3DbMallocSize(pMem->db, pMem->zMalloc) );
  67942. if( n<32 ) n = 32;
  67943. if( pMem->szMalloc>0 && bPreserve && pMem->z==pMem->zMalloc ){
  67944. pMem->z = pMem->zMalloc = sqlite3DbReallocOrFree(pMem->db, pMem->z, n);
  67945. bPreserve = 0;
  67946. }else{
  67947. if( pMem->szMalloc>0 ) sqlite3DbFreeNN(pMem->db, pMem->zMalloc);
  67948. pMem->zMalloc = sqlite3DbMallocRaw(pMem->db, n);
  67949. }
  67950. if( pMem->zMalloc==0 ){
  67951. sqlite3VdbeMemSetNull(pMem);
  67952. pMem->z = 0;
  67953. pMem->szMalloc = 0;
  67954. return SQLITE_NOMEM_BKPT;
  67955. }else{
  67956. pMem->szMalloc = sqlite3DbMallocSize(pMem->db, pMem->zMalloc);
  67957. }
  67958. if( bPreserve && pMem->z ){
  67959. assert( pMem->z!=pMem->zMalloc );
  67960. memcpy(pMem->zMalloc, pMem->z, pMem->n);
  67961. }
  67962. if( (pMem->flags&MEM_Dyn)!=0 ){
  67963. assert( pMem->xDel!=0 && pMem->xDel!=SQLITE_DYNAMIC );
  67964. pMem->xDel((void *)(pMem->z));
  67965. }
  67966. pMem->z = pMem->zMalloc;
  67967. pMem->flags &= ~(MEM_Dyn|MEM_Ephem|MEM_Static);
  67968. return SQLITE_OK;
  67969. }
  67970. /*
  67971. ** Change the pMem->zMalloc allocation to be at least szNew bytes.
  67972. ** If pMem->zMalloc already meets or exceeds the requested size, this
  67973. ** routine is a no-op.
  67974. **
  67975. ** Any prior string or blob content in the pMem object may be discarded.
  67976. ** The pMem->xDel destructor is called, if it exists. Though MEM_Str
  67977. ** and MEM_Blob values may be discarded, MEM_Int, MEM_Real, and MEM_Null
  67978. ** values are preserved.
  67979. **
  67980. ** Return SQLITE_OK on success or an error code (probably SQLITE_NOMEM)
  67981. ** if unable to complete the resizing.
  67982. */
  67983. SQLITE_PRIVATE int sqlite3VdbeMemClearAndResize(Mem *pMem, int szNew){
  67984. assert( szNew>0 );
  67985. assert( (pMem->flags & MEM_Dyn)==0 || pMem->szMalloc==0 );
  67986. if( pMem->szMalloc<szNew ){
  67987. return sqlite3VdbeMemGrow(pMem, szNew, 0);
  67988. }
  67989. assert( (pMem->flags & MEM_Dyn)==0 );
  67990. pMem->z = pMem->zMalloc;
  67991. pMem->flags &= (MEM_Null|MEM_Int|MEM_Real);
  67992. return SQLITE_OK;
  67993. }
  67994. /*
  67995. ** It is already known that pMem contains an unterminated string.
  67996. ** Add the zero terminator.
  67997. */
  67998. static SQLITE_NOINLINE int vdbeMemAddTerminator(Mem *pMem){
  67999. if( sqlite3VdbeMemGrow(pMem, pMem->n+2, 1) ){
  68000. return SQLITE_NOMEM_BKPT;
  68001. }
  68002. pMem->z[pMem->n] = 0;
  68003. pMem->z[pMem->n+1] = 0;
  68004. pMem->flags |= MEM_Term;
  68005. return SQLITE_OK;
  68006. }
  68007. /*
  68008. ** Change pMem so that its MEM_Str or MEM_Blob value is stored in
  68009. ** MEM.zMalloc, where it can be safely written.
  68010. **
  68011. ** Return SQLITE_OK on success or SQLITE_NOMEM if malloc fails.
  68012. */
  68013. SQLITE_PRIVATE int sqlite3VdbeMemMakeWriteable(Mem *pMem){
  68014. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68015. assert( (pMem->flags&MEM_RowSet)==0 );
  68016. if( (pMem->flags & (MEM_Str|MEM_Blob))!=0 ){
  68017. if( ExpandBlob(pMem) ) return SQLITE_NOMEM;
  68018. if( pMem->szMalloc==0 || pMem->z!=pMem->zMalloc ){
  68019. int rc = vdbeMemAddTerminator(pMem);
  68020. if( rc ) return rc;
  68021. }
  68022. }
  68023. pMem->flags &= ~MEM_Ephem;
  68024. #ifdef SQLITE_DEBUG
  68025. pMem->pScopyFrom = 0;
  68026. #endif
  68027. return SQLITE_OK;
  68028. }
  68029. /*
  68030. ** If the given Mem* has a zero-filled tail, turn it into an ordinary
  68031. ** blob stored in dynamically allocated space.
  68032. */
  68033. #ifndef SQLITE_OMIT_INCRBLOB
  68034. SQLITE_PRIVATE int sqlite3VdbeMemExpandBlob(Mem *pMem){
  68035. int nByte;
  68036. assert( pMem->flags & MEM_Zero );
  68037. assert( pMem->flags&MEM_Blob );
  68038. assert( (pMem->flags&MEM_RowSet)==0 );
  68039. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68040. /* Set nByte to the number of bytes required to store the expanded blob. */
  68041. nByte = pMem->n + pMem->u.nZero;
  68042. if( nByte<=0 ){
  68043. nByte = 1;
  68044. }
  68045. if( sqlite3VdbeMemGrow(pMem, nByte, 1) ){
  68046. return SQLITE_NOMEM_BKPT;
  68047. }
  68048. memset(&pMem->z[pMem->n], 0, pMem->u.nZero);
  68049. pMem->n += pMem->u.nZero;
  68050. pMem->flags &= ~(MEM_Zero|MEM_Term);
  68051. return SQLITE_OK;
  68052. }
  68053. #endif
  68054. /*
  68055. ** Make sure the given Mem is \u0000 terminated.
  68056. */
  68057. SQLITE_PRIVATE int sqlite3VdbeMemNulTerminate(Mem *pMem){
  68058. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68059. testcase( (pMem->flags & (MEM_Term|MEM_Str))==(MEM_Term|MEM_Str) );
  68060. testcase( (pMem->flags & (MEM_Term|MEM_Str))==0 );
  68061. if( (pMem->flags & (MEM_Term|MEM_Str))!=MEM_Str ){
  68062. return SQLITE_OK; /* Nothing to do */
  68063. }else{
  68064. return vdbeMemAddTerminator(pMem);
  68065. }
  68066. }
  68067. /*
  68068. ** Add MEM_Str to the set of representations for the given Mem. Numbers
  68069. ** are converted using sqlite3_snprintf(). Converting a BLOB to a string
  68070. ** is a no-op.
  68071. **
  68072. ** Existing representations MEM_Int and MEM_Real are invalidated if
  68073. ** bForce is true but are retained if bForce is false.
  68074. **
  68075. ** A MEM_Null value will never be passed to this function. This function is
  68076. ** used for converting values to text for returning to the user (i.e. via
  68077. ** sqlite3_value_text()), or for ensuring that values to be used as btree
  68078. ** keys are strings. In the former case a NULL pointer is returned the
  68079. ** user and the latter is an internal programming error.
  68080. */
  68081. SQLITE_PRIVATE int sqlite3VdbeMemStringify(Mem *pMem, u8 enc, u8 bForce){
  68082. int fg = pMem->flags;
  68083. const int nByte = 32;
  68084. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68085. assert( !(fg&MEM_Zero) );
  68086. assert( !(fg&(MEM_Str|MEM_Blob)) );
  68087. assert( fg&(MEM_Int|MEM_Real) );
  68088. assert( (pMem->flags&MEM_RowSet)==0 );
  68089. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  68090. if( sqlite3VdbeMemClearAndResize(pMem, nByte) ){
  68091. pMem->enc = 0;
  68092. return SQLITE_NOMEM_BKPT;
  68093. }
  68094. /* For a Real or Integer, use sqlite3_snprintf() to produce the UTF-8
  68095. ** string representation of the value. Then, if the required encoding
  68096. ** is UTF-16le or UTF-16be do a translation.
  68097. **
  68098. ** FIX ME: It would be better if sqlite3_snprintf() could do UTF-16.
  68099. */
  68100. if( fg & MEM_Int ){
  68101. sqlite3_snprintf(nByte, pMem->z, "%lld", pMem->u.i);
  68102. }else{
  68103. assert( fg & MEM_Real );
  68104. sqlite3_snprintf(nByte, pMem->z, "%!.15g", pMem->u.r);
  68105. }
  68106. pMem->n = sqlite3Strlen30(pMem->z);
  68107. pMem->enc = SQLITE_UTF8;
  68108. pMem->flags |= MEM_Str|MEM_Term;
  68109. if( bForce ) pMem->flags &= ~(MEM_Int|MEM_Real);
  68110. sqlite3VdbeChangeEncoding(pMem, enc);
  68111. return SQLITE_OK;
  68112. }
  68113. /*
  68114. ** Memory cell pMem contains the context of an aggregate function.
  68115. ** This routine calls the finalize method for that function. The
  68116. ** result of the aggregate is stored back into pMem.
  68117. **
  68118. ** Return SQLITE_ERROR if the finalizer reports an error. SQLITE_OK
  68119. ** otherwise.
  68120. */
  68121. SQLITE_PRIVATE int sqlite3VdbeMemFinalize(Mem *pMem, FuncDef *pFunc){
  68122. sqlite3_context ctx;
  68123. Mem t;
  68124. assert( pFunc!=0 );
  68125. assert( pFunc->xFinalize!=0 );
  68126. assert( (pMem->flags & MEM_Null)!=0 || pFunc==pMem->u.pDef );
  68127. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68128. memset(&ctx, 0, sizeof(ctx));
  68129. memset(&t, 0, sizeof(t));
  68130. t.flags = MEM_Null;
  68131. t.db = pMem->db;
  68132. ctx.pOut = &t;
  68133. ctx.pMem = pMem;
  68134. ctx.pFunc = pFunc;
  68135. pFunc->xFinalize(&ctx); /* IMP: R-24505-23230 */
  68136. assert( (pMem->flags & MEM_Dyn)==0 );
  68137. if( pMem->szMalloc>0 ) sqlite3DbFreeNN(pMem->db, pMem->zMalloc);
  68138. memcpy(pMem, &t, sizeof(t));
  68139. return ctx.isError;
  68140. }
  68141. /*
  68142. ** If the memory cell contains a value that must be freed by
  68143. ** invoking the external callback in Mem.xDel, then this routine
  68144. ** will free that value. It also sets Mem.flags to MEM_Null.
  68145. **
  68146. ** This is a helper routine for sqlite3VdbeMemSetNull() and
  68147. ** for sqlite3VdbeMemRelease(). Use those other routines as the
  68148. ** entry point for releasing Mem resources.
  68149. */
  68150. static SQLITE_NOINLINE void vdbeMemClearExternAndSetNull(Mem *p){
  68151. assert( p->db==0 || sqlite3_mutex_held(p->db->mutex) );
  68152. assert( VdbeMemDynamic(p) );
  68153. if( p->flags&MEM_Agg ){
  68154. sqlite3VdbeMemFinalize(p, p->u.pDef);
  68155. assert( (p->flags & MEM_Agg)==0 );
  68156. testcase( p->flags & MEM_Dyn );
  68157. }
  68158. if( p->flags&MEM_Dyn ){
  68159. assert( (p->flags&MEM_RowSet)==0 );
  68160. assert( p->xDel!=SQLITE_DYNAMIC && p->xDel!=0 );
  68161. p->xDel((void *)p->z);
  68162. }else if( p->flags&MEM_RowSet ){
  68163. sqlite3RowSetClear(p->u.pRowSet);
  68164. }else if( p->flags&MEM_Frame ){
  68165. VdbeFrame *pFrame = p->u.pFrame;
  68166. pFrame->pParent = pFrame->v->pDelFrame;
  68167. pFrame->v->pDelFrame = pFrame;
  68168. }
  68169. p->flags = MEM_Null;
  68170. }
  68171. /*
  68172. ** Release memory held by the Mem p, both external memory cleared
  68173. ** by p->xDel and memory in p->zMalloc.
  68174. **
  68175. ** This is a helper routine invoked by sqlite3VdbeMemRelease() in
  68176. ** the unusual case where there really is memory in p that needs
  68177. ** to be freed.
  68178. */
  68179. static SQLITE_NOINLINE void vdbeMemClear(Mem *p){
  68180. if( VdbeMemDynamic(p) ){
  68181. vdbeMemClearExternAndSetNull(p);
  68182. }
  68183. if( p->szMalloc ){
  68184. sqlite3DbFreeNN(p->db, p->zMalloc);
  68185. p->szMalloc = 0;
  68186. }
  68187. p->z = 0;
  68188. }
  68189. /*
  68190. ** Release any memory resources held by the Mem. Both the memory that is
  68191. ** free by Mem.xDel and the Mem.zMalloc allocation are freed.
  68192. **
  68193. ** Use this routine prior to clean up prior to abandoning a Mem, or to
  68194. ** reset a Mem back to its minimum memory utilization.
  68195. **
  68196. ** Use sqlite3VdbeMemSetNull() to release just the Mem.xDel space
  68197. ** prior to inserting new content into the Mem.
  68198. */
  68199. SQLITE_PRIVATE void sqlite3VdbeMemRelease(Mem *p){
  68200. assert( sqlite3VdbeCheckMemInvariants(p) );
  68201. if( VdbeMemDynamic(p) || p->szMalloc ){
  68202. vdbeMemClear(p);
  68203. }
  68204. }
  68205. /*
  68206. ** Convert a 64-bit IEEE double into a 64-bit signed integer.
  68207. ** If the double is out of range of a 64-bit signed integer then
  68208. ** return the closest available 64-bit signed integer.
  68209. */
  68210. static SQLITE_NOINLINE i64 doubleToInt64(double r){
  68211. #ifdef SQLITE_OMIT_FLOATING_POINT
  68212. /* When floating-point is omitted, double and int64 are the same thing */
  68213. return r;
  68214. #else
  68215. /*
  68216. ** Many compilers we encounter do not define constants for the
  68217. ** minimum and maximum 64-bit integers, or they define them
  68218. ** inconsistently. And many do not understand the "LL" notation.
  68219. ** So we define our own static constants here using nothing
  68220. ** larger than a 32-bit integer constant.
  68221. */
  68222. static const i64 maxInt = LARGEST_INT64;
  68223. static const i64 minInt = SMALLEST_INT64;
  68224. if( r<=(double)minInt ){
  68225. return minInt;
  68226. }else if( r>=(double)maxInt ){
  68227. return maxInt;
  68228. }else{
  68229. return (i64)r;
  68230. }
  68231. #endif
  68232. }
  68233. /*
  68234. ** Return some kind of integer value which is the best we can do
  68235. ** at representing the value that *pMem describes as an integer.
  68236. ** If pMem is an integer, then the value is exact. If pMem is
  68237. ** a floating-point then the value returned is the integer part.
  68238. ** If pMem is a string or blob, then we make an attempt to convert
  68239. ** it into an integer and return that. If pMem represents an
  68240. ** an SQL-NULL value, return 0.
  68241. **
  68242. ** If pMem represents a string value, its encoding might be changed.
  68243. */
  68244. static SQLITE_NOINLINE i64 memIntValue(Mem *pMem){
  68245. i64 value = 0;
  68246. sqlite3Atoi64(pMem->z, &value, pMem->n, pMem->enc);
  68247. return value;
  68248. }
  68249. SQLITE_PRIVATE i64 sqlite3VdbeIntValue(Mem *pMem){
  68250. int flags;
  68251. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68252. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  68253. flags = pMem->flags;
  68254. if( flags & MEM_Int ){
  68255. return pMem->u.i;
  68256. }else if( flags & MEM_Real ){
  68257. return doubleToInt64(pMem->u.r);
  68258. }else if( flags & (MEM_Str|MEM_Blob) ){
  68259. assert( pMem->z || pMem->n==0 );
  68260. return memIntValue(pMem);
  68261. }else{
  68262. return 0;
  68263. }
  68264. }
  68265. /*
  68266. ** Return the best representation of pMem that we can get into a
  68267. ** double. If pMem is already a double or an integer, return its
  68268. ** value. If it is a string or blob, try to convert it to a double.
  68269. ** If it is a NULL, return 0.0.
  68270. */
  68271. static SQLITE_NOINLINE double memRealValue(Mem *pMem){
  68272. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  68273. double val = (double)0;
  68274. sqlite3AtoF(pMem->z, &val, pMem->n, pMem->enc);
  68275. return val;
  68276. }
  68277. SQLITE_PRIVATE double sqlite3VdbeRealValue(Mem *pMem){
  68278. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68279. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  68280. if( pMem->flags & MEM_Real ){
  68281. return pMem->u.r;
  68282. }else if( pMem->flags & MEM_Int ){
  68283. return (double)pMem->u.i;
  68284. }else if( pMem->flags & (MEM_Str|MEM_Blob) ){
  68285. return memRealValue(pMem);
  68286. }else{
  68287. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  68288. return (double)0;
  68289. }
  68290. }
  68291. /*
  68292. ** Return 1 if pMem represents true, and return 0 if pMem represents false.
  68293. ** Return the value ifNull if pMem is NULL.
  68294. */
  68295. SQLITE_PRIVATE int sqlite3VdbeBooleanValue(Mem *pMem, int ifNull){
  68296. if( pMem->flags & MEM_Int ) return pMem->u.i!=0;
  68297. if( pMem->flags & MEM_Null ) return ifNull;
  68298. return sqlite3VdbeRealValue(pMem)!=0.0;
  68299. }
  68300. /*
  68301. ** The MEM structure is already a MEM_Real. Try to also make it a
  68302. ** MEM_Int if we can.
  68303. */
  68304. SQLITE_PRIVATE void sqlite3VdbeIntegerAffinity(Mem *pMem){
  68305. i64 ix;
  68306. assert( pMem->flags & MEM_Real );
  68307. assert( (pMem->flags & MEM_RowSet)==0 );
  68308. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68309. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  68310. ix = doubleToInt64(pMem->u.r);
  68311. /* Only mark the value as an integer if
  68312. **
  68313. ** (1) the round-trip conversion real->int->real is a no-op, and
  68314. ** (2) The integer is neither the largest nor the smallest
  68315. ** possible integer (ticket #3922)
  68316. **
  68317. ** The second and third terms in the following conditional enforces
  68318. ** the second condition under the assumption that addition overflow causes
  68319. ** values to wrap around.
  68320. */
  68321. if( pMem->u.r==ix && ix>SMALLEST_INT64 && ix<LARGEST_INT64 ){
  68322. pMem->u.i = ix;
  68323. MemSetTypeFlag(pMem, MEM_Int);
  68324. }
  68325. }
  68326. /*
  68327. ** Convert pMem to type integer. Invalidate any prior representations.
  68328. */
  68329. SQLITE_PRIVATE int sqlite3VdbeMemIntegerify(Mem *pMem){
  68330. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68331. assert( (pMem->flags & MEM_RowSet)==0 );
  68332. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  68333. pMem->u.i = sqlite3VdbeIntValue(pMem);
  68334. MemSetTypeFlag(pMem, MEM_Int);
  68335. return SQLITE_OK;
  68336. }
  68337. /*
  68338. ** Convert pMem so that it is of type MEM_Real.
  68339. ** Invalidate any prior representations.
  68340. */
  68341. SQLITE_PRIVATE int sqlite3VdbeMemRealify(Mem *pMem){
  68342. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68343. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  68344. pMem->u.r = sqlite3VdbeRealValue(pMem);
  68345. MemSetTypeFlag(pMem, MEM_Real);
  68346. return SQLITE_OK;
  68347. }
  68348. /* Compare a floating point value to an integer. Return true if the two
  68349. ** values are the same within the precision of the floating point value.
  68350. **
  68351. ** For some versions of GCC on 32-bit machines, if you do the more obvious
  68352. ** comparison of "r1==(double)i" you sometimes get an answer of false even
  68353. ** though the r1 and (double)i values are bit-for-bit the same.
  68354. */
  68355. static int sqlite3RealSameAsInt(double r1, sqlite3_int64 i){
  68356. double r2 = (double)i;
  68357. return memcmp(&r1, &r2, sizeof(r1))==0;
  68358. }
  68359. /*
  68360. ** Convert pMem so that it has types MEM_Real or MEM_Int or both.
  68361. ** Invalidate any prior representations.
  68362. **
  68363. ** Every effort is made to force the conversion, even if the input
  68364. ** is a string that does not look completely like a number. Convert
  68365. ** as much of the string as we can and ignore the rest.
  68366. */
  68367. SQLITE_PRIVATE int sqlite3VdbeMemNumerify(Mem *pMem){
  68368. if( (pMem->flags & (MEM_Int|MEM_Real|MEM_Null))==0 ){
  68369. int rc;
  68370. assert( (pMem->flags & (MEM_Blob|MEM_Str))!=0 );
  68371. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68372. rc = sqlite3Atoi64(pMem->z, &pMem->u.i, pMem->n, pMem->enc);
  68373. if( rc==0 ){
  68374. MemSetTypeFlag(pMem, MEM_Int);
  68375. }else{
  68376. i64 i = pMem->u.i;
  68377. sqlite3AtoF(pMem->z, &pMem->u.r, pMem->n, pMem->enc);
  68378. if( rc==1 && sqlite3RealSameAsInt(pMem->u.r, i) ){
  68379. pMem->u.i = i;
  68380. MemSetTypeFlag(pMem, MEM_Int);
  68381. }else{
  68382. MemSetTypeFlag(pMem, MEM_Real);
  68383. }
  68384. }
  68385. }
  68386. assert( (pMem->flags & (MEM_Int|MEM_Real|MEM_Null))!=0 );
  68387. pMem->flags &= ~(MEM_Str|MEM_Blob|MEM_Zero);
  68388. return SQLITE_OK;
  68389. }
  68390. /*
  68391. ** Cast the datatype of the value in pMem according to the affinity
  68392. ** "aff". Casting is different from applying affinity in that a cast
  68393. ** is forced. In other words, the value is converted into the desired
  68394. ** affinity even if that results in loss of data. This routine is
  68395. ** used (for example) to implement the SQL "cast()" operator.
  68396. */
  68397. SQLITE_PRIVATE void sqlite3VdbeMemCast(Mem *pMem, u8 aff, u8 encoding){
  68398. if( pMem->flags & MEM_Null ) return;
  68399. switch( aff ){
  68400. case SQLITE_AFF_BLOB: { /* Really a cast to BLOB */
  68401. if( (pMem->flags & MEM_Blob)==0 ){
  68402. sqlite3ValueApplyAffinity(pMem, SQLITE_AFF_TEXT, encoding);
  68403. assert( pMem->flags & MEM_Str || pMem->db->mallocFailed );
  68404. if( pMem->flags & MEM_Str ) MemSetTypeFlag(pMem, MEM_Blob);
  68405. }else{
  68406. pMem->flags &= ~(MEM_TypeMask&~MEM_Blob);
  68407. }
  68408. break;
  68409. }
  68410. case SQLITE_AFF_NUMERIC: {
  68411. sqlite3VdbeMemNumerify(pMem);
  68412. break;
  68413. }
  68414. case SQLITE_AFF_INTEGER: {
  68415. sqlite3VdbeMemIntegerify(pMem);
  68416. break;
  68417. }
  68418. case SQLITE_AFF_REAL: {
  68419. sqlite3VdbeMemRealify(pMem);
  68420. break;
  68421. }
  68422. default: {
  68423. assert( aff==SQLITE_AFF_TEXT );
  68424. assert( MEM_Str==(MEM_Blob>>3) );
  68425. pMem->flags |= (pMem->flags&MEM_Blob)>>3;
  68426. sqlite3ValueApplyAffinity(pMem, SQLITE_AFF_TEXT, encoding);
  68427. assert( pMem->flags & MEM_Str || pMem->db->mallocFailed );
  68428. pMem->flags &= ~(MEM_Int|MEM_Real|MEM_Blob|MEM_Zero);
  68429. break;
  68430. }
  68431. }
  68432. }
  68433. /*
  68434. ** Initialize bulk memory to be a consistent Mem object.
  68435. **
  68436. ** The minimum amount of initialization feasible is performed.
  68437. */
  68438. SQLITE_PRIVATE void sqlite3VdbeMemInit(Mem *pMem, sqlite3 *db, u16 flags){
  68439. assert( (flags & ~MEM_TypeMask)==0 );
  68440. pMem->flags = flags;
  68441. pMem->db = db;
  68442. pMem->szMalloc = 0;
  68443. }
  68444. /*
  68445. ** Delete any previous value and set the value stored in *pMem to NULL.
  68446. **
  68447. ** This routine calls the Mem.xDel destructor to dispose of values that
  68448. ** require the destructor. But it preserves the Mem.zMalloc memory allocation.
  68449. ** To free all resources, use sqlite3VdbeMemRelease(), which both calls this
  68450. ** routine to invoke the destructor and deallocates Mem.zMalloc.
  68451. **
  68452. ** Use this routine to reset the Mem prior to insert a new value.
  68453. **
  68454. ** Use sqlite3VdbeMemRelease() to complete erase the Mem prior to abandoning it.
  68455. */
  68456. SQLITE_PRIVATE void sqlite3VdbeMemSetNull(Mem *pMem){
  68457. if( VdbeMemDynamic(pMem) ){
  68458. vdbeMemClearExternAndSetNull(pMem);
  68459. }else{
  68460. pMem->flags = MEM_Null;
  68461. }
  68462. }
  68463. SQLITE_PRIVATE void sqlite3ValueSetNull(sqlite3_value *p){
  68464. sqlite3VdbeMemSetNull((Mem*)p);
  68465. }
  68466. /*
  68467. ** Delete any previous value and set the value to be a BLOB of length
  68468. ** n containing all zeros.
  68469. */
  68470. SQLITE_PRIVATE void sqlite3VdbeMemSetZeroBlob(Mem *pMem, int n){
  68471. sqlite3VdbeMemRelease(pMem);
  68472. pMem->flags = MEM_Blob|MEM_Zero;
  68473. pMem->n = 0;
  68474. if( n<0 ) n = 0;
  68475. pMem->u.nZero = n;
  68476. pMem->enc = SQLITE_UTF8;
  68477. pMem->z = 0;
  68478. }
  68479. /*
  68480. ** The pMem is known to contain content that needs to be destroyed prior
  68481. ** to a value change. So invoke the destructor, then set the value to
  68482. ** a 64-bit integer.
  68483. */
  68484. static SQLITE_NOINLINE void vdbeReleaseAndSetInt64(Mem *pMem, i64 val){
  68485. sqlite3VdbeMemSetNull(pMem);
  68486. pMem->u.i = val;
  68487. pMem->flags = MEM_Int;
  68488. }
  68489. /*
  68490. ** Delete any previous value and set the value stored in *pMem to val,
  68491. ** manifest type INTEGER.
  68492. */
  68493. SQLITE_PRIVATE void sqlite3VdbeMemSetInt64(Mem *pMem, i64 val){
  68494. if( VdbeMemDynamic(pMem) ){
  68495. vdbeReleaseAndSetInt64(pMem, val);
  68496. }else{
  68497. pMem->u.i = val;
  68498. pMem->flags = MEM_Int;
  68499. }
  68500. }
  68501. /* A no-op destructor */
  68502. static void sqlite3NoopDestructor(void *p){ UNUSED_PARAMETER(p); }
  68503. /*
  68504. ** Set the value stored in *pMem should already be a NULL.
  68505. ** Also store a pointer to go with it.
  68506. */
  68507. SQLITE_PRIVATE void sqlite3VdbeMemSetPointer(
  68508. Mem *pMem,
  68509. void *pPtr,
  68510. const char *zPType,
  68511. void (*xDestructor)(void*)
  68512. ){
  68513. assert( pMem->flags==MEM_Null );
  68514. pMem->u.zPType = zPType ? zPType : "";
  68515. pMem->z = pPtr;
  68516. pMem->flags = MEM_Null|MEM_Dyn|MEM_Subtype|MEM_Term;
  68517. pMem->eSubtype = 'p';
  68518. pMem->xDel = xDestructor ? xDestructor : sqlite3NoopDestructor;
  68519. }
  68520. #ifndef SQLITE_OMIT_FLOATING_POINT
  68521. /*
  68522. ** Delete any previous value and set the value stored in *pMem to val,
  68523. ** manifest type REAL.
  68524. */
  68525. SQLITE_PRIVATE void sqlite3VdbeMemSetDouble(Mem *pMem, double val){
  68526. sqlite3VdbeMemSetNull(pMem);
  68527. if( !sqlite3IsNaN(val) ){
  68528. pMem->u.r = val;
  68529. pMem->flags = MEM_Real;
  68530. }
  68531. }
  68532. #endif
  68533. /*
  68534. ** Delete any previous value and set the value of pMem to be an
  68535. ** empty boolean index.
  68536. */
  68537. SQLITE_PRIVATE void sqlite3VdbeMemSetRowSet(Mem *pMem){
  68538. sqlite3 *db = pMem->db;
  68539. assert( db!=0 );
  68540. assert( (pMem->flags & MEM_RowSet)==0 );
  68541. sqlite3VdbeMemRelease(pMem);
  68542. pMem->zMalloc = sqlite3DbMallocRawNN(db, 64);
  68543. if( db->mallocFailed ){
  68544. pMem->flags = MEM_Null;
  68545. pMem->szMalloc = 0;
  68546. }else{
  68547. assert( pMem->zMalloc );
  68548. pMem->szMalloc = sqlite3DbMallocSize(db, pMem->zMalloc);
  68549. pMem->u.pRowSet = sqlite3RowSetInit(db, pMem->zMalloc, pMem->szMalloc);
  68550. assert( pMem->u.pRowSet!=0 );
  68551. pMem->flags = MEM_RowSet;
  68552. }
  68553. }
  68554. /*
  68555. ** Return true if the Mem object contains a TEXT or BLOB that is
  68556. ** too large - whose size exceeds SQLITE_MAX_LENGTH.
  68557. */
  68558. SQLITE_PRIVATE int sqlite3VdbeMemTooBig(Mem *p){
  68559. assert( p->db!=0 );
  68560. if( p->flags & (MEM_Str|MEM_Blob) ){
  68561. int n = p->n;
  68562. if( p->flags & MEM_Zero ){
  68563. n += p->u.nZero;
  68564. }
  68565. return n>p->db->aLimit[SQLITE_LIMIT_LENGTH];
  68566. }
  68567. return 0;
  68568. }
  68569. #ifdef SQLITE_DEBUG
  68570. /*
  68571. ** This routine prepares a memory cell for modification by breaking
  68572. ** its link to a shallow copy and by marking any current shallow
  68573. ** copies of this cell as invalid.
  68574. **
  68575. ** This is used for testing and debugging only - to make sure shallow
  68576. ** copies are not misused.
  68577. */
  68578. SQLITE_PRIVATE void sqlite3VdbeMemAboutToChange(Vdbe *pVdbe, Mem *pMem){
  68579. int i;
  68580. Mem *pX;
  68581. for(i=0, pX=pVdbe->aMem; i<pVdbe->nMem; i++, pX++){
  68582. if( pX->pScopyFrom==pMem ){
  68583. pX->flags |= MEM_Undefined;
  68584. pX->pScopyFrom = 0;
  68585. }
  68586. }
  68587. pMem->pScopyFrom = 0;
  68588. }
  68589. #endif /* SQLITE_DEBUG */
  68590. /*
  68591. ** Make an shallow copy of pFrom into pTo. Prior contents of
  68592. ** pTo are freed. The pFrom->z field is not duplicated. If
  68593. ** pFrom->z is used, then pTo->z points to the same thing as pFrom->z
  68594. ** and flags gets srcType (either MEM_Ephem or MEM_Static).
  68595. */
  68596. static SQLITE_NOINLINE void vdbeClrCopy(Mem *pTo, const Mem *pFrom, int eType){
  68597. vdbeMemClearExternAndSetNull(pTo);
  68598. assert( !VdbeMemDynamic(pTo) );
  68599. sqlite3VdbeMemShallowCopy(pTo, pFrom, eType);
  68600. }
  68601. SQLITE_PRIVATE void sqlite3VdbeMemShallowCopy(Mem *pTo, const Mem *pFrom, int srcType){
  68602. assert( (pFrom->flags & MEM_RowSet)==0 );
  68603. assert( pTo->db==pFrom->db );
  68604. if( VdbeMemDynamic(pTo) ){ vdbeClrCopy(pTo,pFrom,srcType); return; }
  68605. memcpy(pTo, pFrom, MEMCELLSIZE);
  68606. if( (pFrom->flags&MEM_Static)==0 ){
  68607. pTo->flags &= ~(MEM_Dyn|MEM_Static|MEM_Ephem);
  68608. assert( srcType==MEM_Ephem || srcType==MEM_Static );
  68609. pTo->flags |= srcType;
  68610. }
  68611. }
  68612. /*
  68613. ** Make a full copy of pFrom into pTo. Prior contents of pTo are
  68614. ** freed before the copy is made.
  68615. */
  68616. SQLITE_PRIVATE int sqlite3VdbeMemCopy(Mem *pTo, const Mem *pFrom){
  68617. int rc = SQLITE_OK;
  68618. assert( (pFrom->flags & MEM_RowSet)==0 );
  68619. if( VdbeMemDynamic(pTo) ) vdbeMemClearExternAndSetNull(pTo);
  68620. memcpy(pTo, pFrom, MEMCELLSIZE);
  68621. pTo->flags &= ~MEM_Dyn;
  68622. if( pTo->flags&(MEM_Str|MEM_Blob) ){
  68623. if( 0==(pFrom->flags&MEM_Static) ){
  68624. pTo->flags |= MEM_Ephem;
  68625. rc = sqlite3VdbeMemMakeWriteable(pTo);
  68626. }
  68627. }
  68628. return rc;
  68629. }
  68630. /*
  68631. ** Transfer the contents of pFrom to pTo. Any existing value in pTo is
  68632. ** freed. If pFrom contains ephemeral data, a copy is made.
  68633. **
  68634. ** pFrom contains an SQL NULL when this routine returns.
  68635. */
  68636. SQLITE_PRIVATE void sqlite3VdbeMemMove(Mem *pTo, Mem *pFrom){
  68637. assert( pFrom->db==0 || sqlite3_mutex_held(pFrom->db->mutex) );
  68638. assert( pTo->db==0 || sqlite3_mutex_held(pTo->db->mutex) );
  68639. assert( pFrom->db==0 || pTo->db==0 || pFrom->db==pTo->db );
  68640. sqlite3VdbeMemRelease(pTo);
  68641. memcpy(pTo, pFrom, sizeof(Mem));
  68642. pFrom->flags = MEM_Null;
  68643. pFrom->szMalloc = 0;
  68644. }
  68645. /*
  68646. ** Change the value of a Mem to be a string or a BLOB.
  68647. **
  68648. ** The memory management strategy depends on the value of the xDel
  68649. ** parameter. If the value passed is SQLITE_TRANSIENT, then the
  68650. ** string is copied into a (possibly existing) buffer managed by the
  68651. ** Mem structure. Otherwise, any existing buffer is freed and the
  68652. ** pointer copied.
  68653. **
  68654. ** If the string is too large (if it exceeds the SQLITE_LIMIT_LENGTH
  68655. ** size limit) then no memory allocation occurs. If the string can be
  68656. ** stored without allocating memory, then it is. If a memory allocation
  68657. ** is required to store the string, then value of pMem is unchanged. In
  68658. ** either case, SQLITE_TOOBIG is returned.
  68659. */
  68660. SQLITE_PRIVATE int sqlite3VdbeMemSetStr(
  68661. Mem *pMem, /* Memory cell to set to string value */
  68662. const char *z, /* String pointer */
  68663. int n, /* Bytes in string, or negative */
  68664. u8 enc, /* Encoding of z. 0 for BLOBs */
  68665. void (*xDel)(void*) /* Destructor function */
  68666. ){
  68667. int nByte = n; /* New value for pMem->n */
  68668. int iLimit; /* Maximum allowed string or blob size */
  68669. u16 flags = 0; /* New value for pMem->flags */
  68670. assert( pMem->db==0 || sqlite3_mutex_held(pMem->db->mutex) );
  68671. assert( (pMem->flags & MEM_RowSet)==0 );
  68672. /* If z is a NULL pointer, set pMem to contain an SQL NULL. */
  68673. if( !z ){
  68674. sqlite3VdbeMemSetNull(pMem);
  68675. return SQLITE_OK;
  68676. }
  68677. if( pMem->db ){
  68678. iLimit = pMem->db->aLimit[SQLITE_LIMIT_LENGTH];
  68679. }else{
  68680. iLimit = SQLITE_MAX_LENGTH;
  68681. }
  68682. flags = (enc==0?MEM_Blob:MEM_Str);
  68683. if( nByte<0 ){
  68684. assert( enc!=0 );
  68685. if( enc==SQLITE_UTF8 ){
  68686. nByte = 0x7fffffff & (int)strlen(z);
  68687. if( nByte>iLimit ) nByte = iLimit+1;
  68688. }else{
  68689. for(nByte=0; nByte<=iLimit && (z[nByte] | z[nByte+1]); nByte+=2){}
  68690. }
  68691. flags |= MEM_Term;
  68692. }
  68693. /* The following block sets the new values of Mem.z and Mem.xDel. It
  68694. ** also sets a flag in local variable "flags" to indicate the memory
  68695. ** management (one of MEM_Dyn or MEM_Static).
  68696. */
  68697. if( xDel==SQLITE_TRANSIENT ){
  68698. int nAlloc = nByte;
  68699. if( flags&MEM_Term ){
  68700. nAlloc += (enc==SQLITE_UTF8?1:2);
  68701. }
  68702. if( nByte>iLimit ){
  68703. return SQLITE_TOOBIG;
  68704. }
  68705. testcase( nAlloc==0 );
  68706. testcase( nAlloc==31 );
  68707. testcase( nAlloc==32 );
  68708. if( sqlite3VdbeMemClearAndResize(pMem, MAX(nAlloc,32)) ){
  68709. return SQLITE_NOMEM_BKPT;
  68710. }
  68711. memcpy(pMem->z, z, nAlloc);
  68712. }else if( xDel==SQLITE_DYNAMIC ){
  68713. sqlite3VdbeMemRelease(pMem);
  68714. pMem->zMalloc = pMem->z = (char *)z;
  68715. pMem->szMalloc = sqlite3DbMallocSize(pMem->db, pMem->zMalloc);
  68716. }else{
  68717. sqlite3VdbeMemRelease(pMem);
  68718. pMem->z = (char *)z;
  68719. pMem->xDel = xDel;
  68720. flags |= ((xDel==SQLITE_STATIC)?MEM_Static:MEM_Dyn);
  68721. }
  68722. pMem->n = nByte;
  68723. pMem->flags = flags;
  68724. pMem->enc = (enc==0 ? SQLITE_UTF8 : enc);
  68725. #ifndef SQLITE_OMIT_UTF16
  68726. if( pMem->enc!=SQLITE_UTF8 && sqlite3VdbeMemHandleBom(pMem) ){
  68727. return SQLITE_NOMEM_BKPT;
  68728. }
  68729. #endif
  68730. if( nByte>iLimit ){
  68731. return SQLITE_TOOBIG;
  68732. }
  68733. return SQLITE_OK;
  68734. }
  68735. /*
  68736. ** Move data out of a btree key or data field and into a Mem structure.
  68737. ** The data is payload from the entry that pCur is currently pointing
  68738. ** to. offset and amt determine what portion of the data or key to retrieve.
  68739. ** The result is written into the pMem element.
  68740. **
  68741. ** The pMem object must have been initialized. This routine will use
  68742. ** pMem->zMalloc to hold the content from the btree, if possible. New
  68743. ** pMem->zMalloc space will be allocated if necessary. The calling routine
  68744. ** is responsible for making sure that the pMem object is eventually
  68745. ** destroyed.
  68746. **
  68747. ** If this routine fails for any reason (malloc returns NULL or unable
  68748. ** to read from the disk) then the pMem is left in an inconsistent state.
  68749. */
  68750. static SQLITE_NOINLINE int vdbeMemFromBtreeResize(
  68751. BtCursor *pCur, /* Cursor pointing at record to retrieve. */
  68752. u32 offset, /* Offset from the start of data to return bytes from. */
  68753. u32 amt, /* Number of bytes to return. */
  68754. Mem *pMem /* OUT: Return data in this Mem structure. */
  68755. ){
  68756. int rc;
  68757. pMem->flags = MEM_Null;
  68758. if( SQLITE_OK==(rc = sqlite3VdbeMemClearAndResize(pMem, amt+1)) ){
  68759. rc = sqlite3BtreePayload(pCur, offset, amt, pMem->z);
  68760. if( rc==SQLITE_OK ){
  68761. pMem->z[amt] = 0; /* Overrun area used when reading malformed records */
  68762. pMem->flags = MEM_Blob;
  68763. pMem->n = (int)amt;
  68764. }else{
  68765. sqlite3VdbeMemRelease(pMem);
  68766. }
  68767. }
  68768. return rc;
  68769. }
  68770. SQLITE_PRIVATE int sqlite3VdbeMemFromBtree(
  68771. BtCursor *pCur, /* Cursor pointing at record to retrieve. */
  68772. u32 offset, /* Offset from the start of data to return bytes from. */
  68773. u32 amt, /* Number of bytes to return. */
  68774. Mem *pMem /* OUT: Return data in this Mem structure. */
  68775. ){
  68776. char *zData; /* Data from the btree layer */
  68777. u32 available = 0; /* Number of bytes available on the local btree page */
  68778. int rc = SQLITE_OK; /* Return code */
  68779. assert( sqlite3BtreeCursorIsValid(pCur) );
  68780. assert( !VdbeMemDynamic(pMem) );
  68781. /* Note: the calls to BtreeKeyFetch() and DataFetch() below assert()
  68782. ** that both the BtShared and database handle mutexes are held. */
  68783. assert( (pMem->flags & MEM_RowSet)==0 );
  68784. zData = (char *)sqlite3BtreePayloadFetch(pCur, &available);
  68785. assert( zData!=0 );
  68786. if( offset+amt<=available ){
  68787. pMem->z = &zData[offset];
  68788. pMem->flags = MEM_Blob|MEM_Ephem;
  68789. pMem->n = (int)amt;
  68790. }else{
  68791. rc = vdbeMemFromBtreeResize(pCur, offset, amt, pMem);
  68792. }
  68793. return rc;
  68794. }
  68795. /*
  68796. ** The pVal argument is known to be a value other than NULL.
  68797. ** Convert it into a string with encoding enc and return a pointer
  68798. ** to a zero-terminated version of that string.
  68799. */
  68800. static SQLITE_NOINLINE const void *valueToText(sqlite3_value* pVal, u8 enc){
  68801. assert( pVal!=0 );
  68802. assert( pVal->db==0 || sqlite3_mutex_held(pVal->db->mutex) );
  68803. assert( (enc&3)==(enc&~SQLITE_UTF16_ALIGNED) );
  68804. assert( (pVal->flags & MEM_RowSet)==0 );
  68805. assert( (pVal->flags & (MEM_Null))==0 );
  68806. if( pVal->flags & (MEM_Blob|MEM_Str) ){
  68807. if( ExpandBlob(pVal) ) return 0;
  68808. pVal->flags |= MEM_Str;
  68809. if( pVal->enc != (enc & ~SQLITE_UTF16_ALIGNED) ){
  68810. sqlite3VdbeChangeEncoding(pVal, enc & ~SQLITE_UTF16_ALIGNED);
  68811. }
  68812. if( (enc & SQLITE_UTF16_ALIGNED)!=0 && 1==(1&SQLITE_PTR_TO_INT(pVal->z)) ){
  68813. assert( (pVal->flags & (MEM_Ephem|MEM_Static))!=0 );
  68814. if( sqlite3VdbeMemMakeWriteable(pVal)!=SQLITE_OK ){
  68815. return 0;
  68816. }
  68817. }
  68818. sqlite3VdbeMemNulTerminate(pVal); /* IMP: R-31275-44060 */
  68819. }else{
  68820. sqlite3VdbeMemStringify(pVal, enc, 0);
  68821. assert( 0==(1&SQLITE_PTR_TO_INT(pVal->z)) );
  68822. }
  68823. assert(pVal->enc==(enc & ~SQLITE_UTF16_ALIGNED) || pVal->db==0
  68824. || pVal->db->mallocFailed );
  68825. if( pVal->enc==(enc & ~SQLITE_UTF16_ALIGNED) ){
  68826. assert( sqlite3VdbeMemConsistentDualRep(pVal) );
  68827. return pVal->z;
  68828. }else{
  68829. return 0;
  68830. }
  68831. }
  68832. /* This function is only available internally, it is not part of the
  68833. ** external API. It works in a similar way to sqlite3_value_text(),
  68834. ** except the data returned is in the encoding specified by the second
  68835. ** parameter, which must be one of SQLITE_UTF16BE, SQLITE_UTF16LE or
  68836. ** SQLITE_UTF8.
  68837. **
  68838. ** (2006-02-16:) The enc value can be or-ed with SQLITE_UTF16_ALIGNED.
  68839. ** If that is the case, then the result must be aligned on an even byte
  68840. ** boundary.
  68841. */
  68842. SQLITE_PRIVATE const void *sqlite3ValueText(sqlite3_value* pVal, u8 enc){
  68843. if( !pVal ) return 0;
  68844. assert( pVal->db==0 || sqlite3_mutex_held(pVal->db->mutex) );
  68845. assert( (enc&3)==(enc&~SQLITE_UTF16_ALIGNED) );
  68846. assert( (pVal->flags & MEM_RowSet)==0 );
  68847. if( (pVal->flags&(MEM_Str|MEM_Term))==(MEM_Str|MEM_Term) && pVal->enc==enc ){
  68848. assert( sqlite3VdbeMemConsistentDualRep(pVal) );
  68849. return pVal->z;
  68850. }
  68851. if( pVal->flags&MEM_Null ){
  68852. return 0;
  68853. }
  68854. return valueToText(pVal, enc);
  68855. }
  68856. /*
  68857. ** Create a new sqlite3_value object.
  68858. */
  68859. SQLITE_PRIVATE sqlite3_value *sqlite3ValueNew(sqlite3 *db){
  68860. Mem *p = sqlite3DbMallocZero(db, sizeof(*p));
  68861. if( p ){
  68862. p->flags = MEM_Null;
  68863. p->db = db;
  68864. }
  68865. return p;
  68866. }
  68867. /*
  68868. ** Context object passed by sqlite3Stat4ProbeSetValue() through to
  68869. ** valueNew(). See comments above valueNew() for details.
  68870. */
  68871. struct ValueNewStat4Ctx {
  68872. Parse *pParse;
  68873. Index *pIdx;
  68874. UnpackedRecord **ppRec;
  68875. int iVal;
  68876. };
  68877. /*
  68878. ** Allocate and return a pointer to a new sqlite3_value object. If
  68879. ** the second argument to this function is NULL, the object is allocated
  68880. ** by calling sqlite3ValueNew().
  68881. **
  68882. ** Otherwise, if the second argument is non-zero, then this function is
  68883. ** being called indirectly by sqlite3Stat4ProbeSetValue(). If it has not
  68884. ** already been allocated, allocate the UnpackedRecord structure that
  68885. ** that function will return to its caller here. Then return a pointer to
  68886. ** an sqlite3_value within the UnpackedRecord.a[] array.
  68887. */
  68888. static sqlite3_value *valueNew(sqlite3 *db, struct ValueNewStat4Ctx *p){
  68889. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  68890. if( p ){
  68891. UnpackedRecord *pRec = p->ppRec[0];
  68892. if( pRec==0 ){
  68893. Index *pIdx = p->pIdx; /* Index being probed */
  68894. int nByte; /* Bytes of space to allocate */
  68895. int i; /* Counter variable */
  68896. int nCol = pIdx->nColumn; /* Number of index columns including rowid */
  68897. nByte = sizeof(Mem) * nCol + ROUND8(sizeof(UnpackedRecord));
  68898. pRec = (UnpackedRecord*)sqlite3DbMallocZero(db, nByte);
  68899. if( pRec ){
  68900. pRec->pKeyInfo = sqlite3KeyInfoOfIndex(p->pParse, pIdx);
  68901. if( pRec->pKeyInfo ){
  68902. assert( pRec->pKeyInfo->nAllField==nCol );
  68903. assert( pRec->pKeyInfo->enc==ENC(db) );
  68904. pRec->aMem = (Mem *)((u8*)pRec + ROUND8(sizeof(UnpackedRecord)));
  68905. for(i=0; i<nCol; i++){
  68906. pRec->aMem[i].flags = MEM_Null;
  68907. pRec->aMem[i].db = db;
  68908. }
  68909. }else{
  68910. sqlite3DbFreeNN(db, pRec);
  68911. pRec = 0;
  68912. }
  68913. }
  68914. if( pRec==0 ) return 0;
  68915. p->ppRec[0] = pRec;
  68916. }
  68917. pRec->nField = p->iVal+1;
  68918. return &pRec->aMem[p->iVal];
  68919. }
  68920. #else
  68921. UNUSED_PARAMETER(p);
  68922. #endif /* defined(SQLITE_ENABLE_STAT3_OR_STAT4) */
  68923. return sqlite3ValueNew(db);
  68924. }
  68925. /*
  68926. ** The expression object indicated by the second argument is guaranteed
  68927. ** to be a scalar SQL function. If
  68928. **
  68929. ** * all function arguments are SQL literals,
  68930. ** * one of the SQLITE_FUNC_CONSTANT or _SLOCHNG function flags is set, and
  68931. ** * the SQLITE_FUNC_NEEDCOLL function flag is not set,
  68932. **
  68933. ** then this routine attempts to invoke the SQL function. Assuming no
  68934. ** error occurs, output parameter (*ppVal) is set to point to a value
  68935. ** object containing the result before returning SQLITE_OK.
  68936. **
  68937. ** Affinity aff is applied to the result of the function before returning.
  68938. ** If the result is a text value, the sqlite3_value object uses encoding
  68939. ** enc.
  68940. **
  68941. ** If the conditions above are not met, this function returns SQLITE_OK
  68942. ** and sets (*ppVal) to NULL. Or, if an error occurs, (*ppVal) is set to
  68943. ** NULL and an SQLite error code returned.
  68944. */
  68945. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  68946. static int valueFromFunction(
  68947. sqlite3 *db, /* The database connection */
  68948. Expr *p, /* The expression to evaluate */
  68949. u8 enc, /* Encoding to use */
  68950. u8 aff, /* Affinity to use */
  68951. sqlite3_value **ppVal, /* Write the new value here */
  68952. struct ValueNewStat4Ctx *pCtx /* Second argument for valueNew() */
  68953. ){
  68954. sqlite3_context ctx; /* Context object for function invocation */
  68955. sqlite3_value **apVal = 0; /* Function arguments */
  68956. int nVal = 0; /* Size of apVal[] array */
  68957. FuncDef *pFunc = 0; /* Function definition */
  68958. sqlite3_value *pVal = 0; /* New value */
  68959. int rc = SQLITE_OK; /* Return code */
  68960. ExprList *pList = 0; /* Function arguments */
  68961. int i; /* Iterator variable */
  68962. assert( pCtx!=0 );
  68963. assert( (p->flags & EP_TokenOnly)==0 );
  68964. pList = p->x.pList;
  68965. if( pList ) nVal = pList->nExpr;
  68966. pFunc = sqlite3FindFunction(db, p->u.zToken, nVal, enc, 0);
  68967. assert( pFunc );
  68968. if( (pFunc->funcFlags & (SQLITE_FUNC_CONSTANT|SQLITE_FUNC_SLOCHNG))==0
  68969. || (pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
  68970. ){
  68971. return SQLITE_OK;
  68972. }
  68973. if( pList ){
  68974. apVal = (sqlite3_value**)sqlite3DbMallocZero(db, sizeof(apVal[0]) * nVal);
  68975. if( apVal==0 ){
  68976. rc = SQLITE_NOMEM_BKPT;
  68977. goto value_from_function_out;
  68978. }
  68979. for(i=0; i<nVal; i++){
  68980. rc = sqlite3ValueFromExpr(db, pList->a[i].pExpr, enc, aff, &apVal[i]);
  68981. if( apVal[i]==0 || rc!=SQLITE_OK ) goto value_from_function_out;
  68982. }
  68983. }
  68984. pVal = valueNew(db, pCtx);
  68985. if( pVal==0 ){
  68986. rc = SQLITE_NOMEM_BKPT;
  68987. goto value_from_function_out;
  68988. }
  68989. assert( pCtx->pParse->rc==SQLITE_OK );
  68990. memset(&ctx, 0, sizeof(ctx));
  68991. ctx.pOut = pVal;
  68992. ctx.pFunc = pFunc;
  68993. pFunc->xSFunc(&ctx, nVal, apVal);
  68994. if( ctx.isError ){
  68995. rc = ctx.isError;
  68996. sqlite3ErrorMsg(pCtx->pParse, "%s", sqlite3_value_text(pVal));
  68997. }else{
  68998. sqlite3ValueApplyAffinity(pVal, aff, SQLITE_UTF8);
  68999. assert( rc==SQLITE_OK );
  69000. rc = sqlite3VdbeChangeEncoding(pVal, enc);
  69001. if( rc==SQLITE_OK && sqlite3VdbeMemTooBig(pVal) ){
  69002. rc = SQLITE_TOOBIG;
  69003. pCtx->pParse->nErr++;
  69004. }
  69005. }
  69006. pCtx->pParse->rc = rc;
  69007. value_from_function_out:
  69008. if( rc!=SQLITE_OK ){
  69009. pVal = 0;
  69010. }
  69011. if( apVal ){
  69012. for(i=0; i<nVal; i++){
  69013. sqlite3ValueFree(apVal[i]);
  69014. }
  69015. sqlite3DbFreeNN(db, apVal);
  69016. }
  69017. *ppVal = pVal;
  69018. return rc;
  69019. }
  69020. #else
  69021. # define valueFromFunction(a,b,c,d,e,f) SQLITE_OK
  69022. #endif /* defined(SQLITE_ENABLE_STAT3_OR_STAT4) */
  69023. /*
  69024. ** Extract a value from the supplied expression in the manner described
  69025. ** above sqlite3ValueFromExpr(). Allocate the sqlite3_value object
  69026. ** using valueNew().
  69027. **
  69028. ** If pCtx is NULL and an error occurs after the sqlite3_value object
  69029. ** has been allocated, it is freed before returning. Or, if pCtx is not
  69030. ** NULL, it is assumed that the caller will free any allocated object
  69031. ** in all cases.
  69032. */
  69033. static int valueFromExpr(
  69034. sqlite3 *db, /* The database connection */
  69035. Expr *pExpr, /* The expression to evaluate */
  69036. u8 enc, /* Encoding to use */
  69037. u8 affinity, /* Affinity to use */
  69038. sqlite3_value **ppVal, /* Write the new value here */
  69039. struct ValueNewStat4Ctx *pCtx /* Second argument for valueNew() */
  69040. ){
  69041. int op;
  69042. char *zVal = 0;
  69043. sqlite3_value *pVal = 0;
  69044. int negInt = 1;
  69045. const char *zNeg = "";
  69046. int rc = SQLITE_OK;
  69047. assert( pExpr!=0 );
  69048. while( (op = pExpr->op)==TK_UPLUS || op==TK_SPAN ) pExpr = pExpr->pLeft;
  69049. #if defined(SQLITE_ENABLE_STAT3_OR_STAT4)
  69050. if( op==TK_REGISTER ) op = pExpr->op2;
  69051. #else
  69052. if( NEVER(op==TK_REGISTER) ) op = pExpr->op2;
  69053. #endif
  69054. /* Compressed expressions only appear when parsing the DEFAULT clause
  69055. ** on a table column definition, and hence only when pCtx==0. This
  69056. ** check ensures that an EP_TokenOnly expression is never passed down
  69057. ** into valueFromFunction(). */
  69058. assert( (pExpr->flags & EP_TokenOnly)==0 || pCtx==0 );
  69059. if( op==TK_CAST ){
  69060. u8 aff = sqlite3AffinityType(pExpr->u.zToken,0);
  69061. rc = valueFromExpr(db, pExpr->pLeft, enc, aff, ppVal, pCtx);
  69062. testcase( rc!=SQLITE_OK );
  69063. if( *ppVal ){
  69064. sqlite3VdbeMemCast(*ppVal, aff, SQLITE_UTF8);
  69065. sqlite3ValueApplyAffinity(*ppVal, affinity, SQLITE_UTF8);
  69066. }
  69067. return rc;
  69068. }
  69069. /* Handle negative integers in a single step. This is needed in the
  69070. ** case when the value is -9223372036854775808.
  69071. */
  69072. if( op==TK_UMINUS
  69073. && (pExpr->pLeft->op==TK_INTEGER || pExpr->pLeft->op==TK_FLOAT) ){
  69074. pExpr = pExpr->pLeft;
  69075. op = pExpr->op;
  69076. negInt = -1;
  69077. zNeg = "-";
  69078. }
  69079. if( op==TK_STRING || op==TK_FLOAT || op==TK_INTEGER ){
  69080. pVal = valueNew(db, pCtx);
  69081. if( pVal==0 ) goto no_mem;
  69082. if( ExprHasProperty(pExpr, EP_IntValue) ){
  69083. sqlite3VdbeMemSetInt64(pVal, (i64)pExpr->u.iValue*negInt);
  69084. }else{
  69085. zVal = sqlite3MPrintf(db, "%s%s", zNeg, pExpr->u.zToken);
  69086. if( zVal==0 ) goto no_mem;
  69087. sqlite3ValueSetStr(pVal, -1, zVal, SQLITE_UTF8, SQLITE_DYNAMIC);
  69088. }
  69089. if( (op==TK_INTEGER || op==TK_FLOAT ) && affinity==SQLITE_AFF_BLOB ){
  69090. sqlite3ValueApplyAffinity(pVal, SQLITE_AFF_NUMERIC, SQLITE_UTF8);
  69091. }else{
  69092. sqlite3ValueApplyAffinity(pVal, affinity, SQLITE_UTF8);
  69093. }
  69094. if( pVal->flags & (MEM_Int|MEM_Real) ) pVal->flags &= ~MEM_Str;
  69095. if( enc!=SQLITE_UTF8 ){
  69096. rc = sqlite3VdbeChangeEncoding(pVal, enc);
  69097. }
  69098. }else if( op==TK_UMINUS ) {
  69099. /* This branch happens for multiple negative signs. Ex: -(-5) */
  69100. if( SQLITE_OK==valueFromExpr(db,pExpr->pLeft,enc,affinity,&pVal,pCtx)
  69101. && pVal!=0
  69102. ){
  69103. sqlite3VdbeMemNumerify(pVal);
  69104. if( pVal->flags & MEM_Real ){
  69105. pVal->u.r = -pVal->u.r;
  69106. }else if( pVal->u.i==SMALLEST_INT64 ){
  69107. pVal->u.r = -(double)SMALLEST_INT64;
  69108. MemSetTypeFlag(pVal, MEM_Real);
  69109. }else{
  69110. pVal->u.i = -pVal->u.i;
  69111. }
  69112. sqlite3ValueApplyAffinity(pVal, affinity, enc);
  69113. }
  69114. }else if( op==TK_NULL ){
  69115. pVal = valueNew(db, pCtx);
  69116. if( pVal==0 ) goto no_mem;
  69117. sqlite3VdbeMemNumerify(pVal);
  69118. }
  69119. #ifndef SQLITE_OMIT_BLOB_LITERAL
  69120. else if( op==TK_BLOB ){
  69121. int nVal;
  69122. assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
  69123. assert( pExpr->u.zToken[1]=='\'' );
  69124. pVal = valueNew(db, pCtx);
  69125. if( !pVal ) goto no_mem;
  69126. zVal = &pExpr->u.zToken[2];
  69127. nVal = sqlite3Strlen30(zVal)-1;
  69128. assert( zVal[nVal]=='\'' );
  69129. sqlite3VdbeMemSetStr(pVal, sqlite3HexToBlob(db, zVal, nVal), nVal/2,
  69130. 0, SQLITE_DYNAMIC);
  69131. }
  69132. #endif
  69133. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  69134. else if( op==TK_FUNCTION && pCtx!=0 ){
  69135. rc = valueFromFunction(db, pExpr, enc, affinity, &pVal, pCtx);
  69136. }
  69137. #endif
  69138. *ppVal = pVal;
  69139. return rc;
  69140. no_mem:
  69141. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  69142. if( pCtx==0 || pCtx->pParse->nErr==0 )
  69143. #endif
  69144. sqlite3OomFault(db);
  69145. sqlite3DbFree(db, zVal);
  69146. assert( *ppVal==0 );
  69147. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  69148. if( pCtx==0 ) sqlite3ValueFree(pVal);
  69149. #else
  69150. assert( pCtx==0 ); sqlite3ValueFree(pVal);
  69151. #endif
  69152. return SQLITE_NOMEM_BKPT;
  69153. }
  69154. /*
  69155. ** Create a new sqlite3_value object, containing the value of pExpr.
  69156. **
  69157. ** This only works for very simple expressions that consist of one constant
  69158. ** token (i.e. "5", "5.1", "'a string'"). If the expression can
  69159. ** be converted directly into a value, then the value is allocated and
  69160. ** a pointer written to *ppVal. The caller is responsible for deallocating
  69161. ** the value by passing it to sqlite3ValueFree() later on. If the expression
  69162. ** cannot be converted to a value, then *ppVal is set to NULL.
  69163. */
  69164. SQLITE_PRIVATE int sqlite3ValueFromExpr(
  69165. sqlite3 *db, /* The database connection */
  69166. Expr *pExpr, /* The expression to evaluate */
  69167. u8 enc, /* Encoding to use */
  69168. u8 affinity, /* Affinity to use */
  69169. sqlite3_value **ppVal /* Write the new value here */
  69170. ){
  69171. return pExpr ? valueFromExpr(db, pExpr, enc, affinity, ppVal, 0) : 0;
  69172. }
  69173. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  69174. /*
  69175. ** The implementation of the sqlite_record() function. This function accepts
  69176. ** a single argument of any type. The return value is a formatted database
  69177. ** record (a blob) containing the argument value.
  69178. **
  69179. ** This is used to convert the value stored in the 'sample' column of the
  69180. ** sqlite_stat3 table to the record format SQLite uses internally.
  69181. */
  69182. static void recordFunc(
  69183. sqlite3_context *context,
  69184. int argc,
  69185. sqlite3_value **argv
  69186. ){
  69187. const int file_format = 1;
  69188. u32 iSerial; /* Serial type */
  69189. int nSerial; /* Bytes of space for iSerial as varint */
  69190. u32 nVal; /* Bytes of space required for argv[0] */
  69191. int nRet;
  69192. sqlite3 *db;
  69193. u8 *aRet;
  69194. UNUSED_PARAMETER( argc );
  69195. iSerial = sqlite3VdbeSerialType(argv[0], file_format, &nVal);
  69196. nSerial = sqlite3VarintLen(iSerial);
  69197. db = sqlite3_context_db_handle(context);
  69198. nRet = 1 + nSerial + nVal;
  69199. aRet = sqlite3DbMallocRawNN(db, nRet);
  69200. if( aRet==0 ){
  69201. sqlite3_result_error_nomem(context);
  69202. }else{
  69203. aRet[0] = nSerial+1;
  69204. putVarint32(&aRet[1], iSerial);
  69205. sqlite3VdbeSerialPut(&aRet[1+nSerial], argv[0], iSerial);
  69206. sqlite3_result_blob(context, aRet, nRet, SQLITE_TRANSIENT);
  69207. sqlite3DbFreeNN(db, aRet);
  69208. }
  69209. }
  69210. /*
  69211. ** Register built-in functions used to help read ANALYZE data.
  69212. */
  69213. SQLITE_PRIVATE void sqlite3AnalyzeFunctions(void){
  69214. static FuncDef aAnalyzeTableFuncs[] = {
  69215. FUNCTION(sqlite_record, 1, 0, 0, recordFunc),
  69216. };
  69217. sqlite3InsertBuiltinFuncs(aAnalyzeTableFuncs, ArraySize(aAnalyzeTableFuncs));
  69218. }
  69219. /*
  69220. ** Attempt to extract a value from pExpr and use it to construct *ppVal.
  69221. **
  69222. ** If pAlloc is not NULL, then an UnpackedRecord object is created for
  69223. ** pAlloc if one does not exist and the new value is added to the
  69224. ** UnpackedRecord object.
  69225. **
  69226. ** A value is extracted in the following cases:
  69227. **
  69228. ** * (pExpr==0). In this case the value is assumed to be an SQL NULL,
  69229. **
  69230. ** * The expression is a bound variable, and this is a reprepare, or
  69231. **
  69232. ** * The expression is a literal value.
  69233. **
  69234. ** On success, *ppVal is made to point to the extracted value. The caller
  69235. ** is responsible for ensuring that the value is eventually freed.
  69236. */
  69237. static int stat4ValueFromExpr(
  69238. Parse *pParse, /* Parse context */
  69239. Expr *pExpr, /* The expression to extract a value from */
  69240. u8 affinity, /* Affinity to use */
  69241. struct ValueNewStat4Ctx *pAlloc,/* How to allocate space. Or NULL */
  69242. sqlite3_value **ppVal /* OUT: New value object (or NULL) */
  69243. ){
  69244. int rc = SQLITE_OK;
  69245. sqlite3_value *pVal = 0;
  69246. sqlite3 *db = pParse->db;
  69247. /* Skip over any TK_COLLATE nodes */
  69248. pExpr = sqlite3ExprSkipCollate(pExpr);
  69249. assert( pExpr==0 || pExpr->op!=TK_REGISTER || pExpr->op2!=TK_VARIABLE );
  69250. if( !pExpr ){
  69251. pVal = valueNew(db, pAlloc);
  69252. if( pVal ){
  69253. sqlite3VdbeMemSetNull((Mem*)pVal);
  69254. }
  69255. }else if( pExpr->op==TK_VARIABLE && (db->flags & SQLITE_EnableQPSG)==0 ){
  69256. Vdbe *v;
  69257. int iBindVar = pExpr->iColumn;
  69258. sqlite3VdbeSetVarmask(pParse->pVdbe, iBindVar);
  69259. if( (v = pParse->pReprepare)!=0 ){
  69260. pVal = valueNew(db, pAlloc);
  69261. if( pVal ){
  69262. rc = sqlite3VdbeMemCopy((Mem*)pVal, &v->aVar[iBindVar-1]);
  69263. sqlite3ValueApplyAffinity(pVal, affinity, ENC(db));
  69264. pVal->db = pParse->db;
  69265. }
  69266. }
  69267. }else{
  69268. rc = valueFromExpr(db, pExpr, ENC(db), affinity, &pVal, pAlloc);
  69269. }
  69270. assert( pVal==0 || pVal->db==db );
  69271. *ppVal = pVal;
  69272. return rc;
  69273. }
  69274. /*
  69275. ** This function is used to allocate and populate UnpackedRecord
  69276. ** structures intended to be compared against sample index keys stored
  69277. ** in the sqlite_stat4 table.
  69278. **
  69279. ** A single call to this function populates zero or more fields of the
  69280. ** record starting with field iVal (fields are numbered from left to
  69281. ** right starting with 0). A single field is populated if:
  69282. **
  69283. ** * (pExpr==0). In this case the value is assumed to be an SQL NULL,
  69284. **
  69285. ** * The expression is a bound variable, and this is a reprepare, or
  69286. **
  69287. ** * The sqlite3ValueFromExpr() function is able to extract a value
  69288. ** from the expression (i.e. the expression is a literal value).
  69289. **
  69290. ** Or, if pExpr is a TK_VECTOR, one field is populated for each of the
  69291. ** vector components that match either of the two latter criteria listed
  69292. ** above.
  69293. **
  69294. ** Before any value is appended to the record, the affinity of the
  69295. ** corresponding column within index pIdx is applied to it. Before
  69296. ** this function returns, output parameter *pnExtract is set to the
  69297. ** number of values appended to the record.
  69298. **
  69299. ** When this function is called, *ppRec must either point to an object
  69300. ** allocated by an earlier call to this function, or must be NULL. If it
  69301. ** is NULL and a value can be successfully extracted, a new UnpackedRecord
  69302. ** is allocated (and *ppRec set to point to it) before returning.
  69303. **
  69304. ** Unless an error is encountered, SQLITE_OK is returned. It is not an
  69305. ** error if a value cannot be extracted from pExpr. If an error does
  69306. ** occur, an SQLite error code is returned.
  69307. */
  69308. SQLITE_PRIVATE int sqlite3Stat4ProbeSetValue(
  69309. Parse *pParse, /* Parse context */
  69310. Index *pIdx, /* Index being probed */
  69311. UnpackedRecord **ppRec, /* IN/OUT: Probe record */
  69312. Expr *pExpr, /* The expression to extract a value from */
  69313. int nElem, /* Maximum number of values to append */
  69314. int iVal, /* Array element to populate */
  69315. int *pnExtract /* OUT: Values appended to the record */
  69316. ){
  69317. int rc = SQLITE_OK;
  69318. int nExtract = 0;
  69319. if( pExpr==0 || pExpr->op!=TK_SELECT ){
  69320. int i;
  69321. struct ValueNewStat4Ctx alloc;
  69322. alloc.pParse = pParse;
  69323. alloc.pIdx = pIdx;
  69324. alloc.ppRec = ppRec;
  69325. for(i=0; i<nElem; i++){
  69326. sqlite3_value *pVal = 0;
  69327. Expr *pElem = (pExpr ? sqlite3VectorFieldSubexpr(pExpr, i) : 0);
  69328. u8 aff = sqlite3IndexColumnAffinity(pParse->db, pIdx, iVal+i);
  69329. alloc.iVal = iVal+i;
  69330. rc = stat4ValueFromExpr(pParse, pElem, aff, &alloc, &pVal);
  69331. if( !pVal ) break;
  69332. nExtract++;
  69333. }
  69334. }
  69335. *pnExtract = nExtract;
  69336. return rc;
  69337. }
  69338. /*
  69339. ** Attempt to extract a value from expression pExpr using the methods
  69340. ** as described for sqlite3Stat4ProbeSetValue() above.
  69341. **
  69342. ** If successful, set *ppVal to point to a new value object and return
  69343. ** SQLITE_OK. If no value can be extracted, but no other error occurs
  69344. ** (e.g. OOM), return SQLITE_OK and set *ppVal to NULL. Or, if an error
  69345. ** does occur, return an SQLite error code. The final value of *ppVal
  69346. ** is undefined in this case.
  69347. */
  69348. SQLITE_PRIVATE int sqlite3Stat4ValueFromExpr(
  69349. Parse *pParse, /* Parse context */
  69350. Expr *pExpr, /* The expression to extract a value from */
  69351. u8 affinity, /* Affinity to use */
  69352. sqlite3_value **ppVal /* OUT: New value object (or NULL) */
  69353. ){
  69354. return stat4ValueFromExpr(pParse, pExpr, affinity, 0, ppVal);
  69355. }
  69356. /*
  69357. ** Extract the iCol-th column from the nRec-byte record in pRec. Write
  69358. ** the column value into *ppVal. If *ppVal is initially NULL then a new
  69359. ** sqlite3_value object is allocated.
  69360. **
  69361. ** If *ppVal is initially NULL then the caller is responsible for
  69362. ** ensuring that the value written into *ppVal is eventually freed.
  69363. */
  69364. SQLITE_PRIVATE int sqlite3Stat4Column(
  69365. sqlite3 *db, /* Database handle */
  69366. const void *pRec, /* Pointer to buffer containing record */
  69367. int nRec, /* Size of buffer pRec in bytes */
  69368. int iCol, /* Column to extract */
  69369. sqlite3_value **ppVal /* OUT: Extracted value */
  69370. ){
  69371. u32 t; /* a column type code */
  69372. int nHdr; /* Size of the header in the record */
  69373. int iHdr; /* Next unread header byte */
  69374. int iField; /* Next unread data byte */
  69375. int szField; /* Size of the current data field */
  69376. int i; /* Column index */
  69377. u8 *a = (u8*)pRec; /* Typecast byte array */
  69378. Mem *pMem = *ppVal; /* Write result into this Mem object */
  69379. assert( iCol>0 );
  69380. iHdr = getVarint32(a, nHdr);
  69381. if( nHdr>nRec || iHdr>=nHdr ) return SQLITE_CORRUPT_BKPT;
  69382. iField = nHdr;
  69383. for(i=0; i<=iCol; i++){
  69384. iHdr += getVarint32(&a[iHdr], t);
  69385. testcase( iHdr==nHdr );
  69386. testcase( iHdr==nHdr+1 );
  69387. if( iHdr>nHdr ) return SQLITE_CORRUPT_BKPT;
  69388. szField = sqlite3VdbeSerialTypeLen(t);
  69389. iField += szField;
  69390. }
  69391. testcase( iField==nRec );
  69392. testcase( iField==nRec+1 );
  69393. if( iField>nRec ) return SQLITE_CORRUPT_BKPT;
  69394. if( pMem==0 ){
  69395. pMem = *ppVal = sqlite3ValueNew(db);
  69396. if( pMem==0 ) return SQLITE_NOMEM_BKPT;
  69397. }
  69398. sqlite3VdbeSerialGet(&a[iField-szField], t, pMem);
  69399. pMem->enc = ENC(db);
  69400. return SQLITE_OK;
  69401. }
  69402. /*
  69403. ** Unless it is NULL, the argument must be an UnpackedRecord object returned
  69404. ** by an earlier call to sqlite3Stat4ProbeSetValue(). This call deletes
  69405. ** the object.
  69406. */
  69407. SQLITE_PRIVATE void sqlite3Stat4ProbeFree(UnpackedRecord *pRec){
  69408. if( pRec ){
  69409. int i;
  69410. int nCol = pRec->pKeyInfo->nAllField;
  69411. Mem *aMem = pRec->aMem;
  69412. sqlite3 *db = aMem[0].db;
  69413. for(i=0; i<nCol; i++){
  69414. sqlite3VdbeMemRelease(&aMem[i]);
  69415. }
  69416. sqlite3KeyInfoUnref(pRec->pKeyInfo);
  69417. sqlite3DbFreeNN(db, pRec);
  69418. }
  69419. }
  69420. #endif /* ifdef SQLITE_ENABLE_STAT4 */
  69421. /*
  69422. ** Change the string value of an sqlite3_value object
  69423. */
  69424. SQLITE_PRIVATE void sqlite3ValueSetStr(
  69425. sqlite3_value *v, /* Value to be set */
  69426. int n, /* Length of string z */
  69427. const void *z, /* Text of the new string */
  69428. u8 enc, /* Encoding to use */
  69429. void (*xDel)(void*) /* Destructor for the string */
  69430. ){
  69431. if( v ) sqlite3VdbeMemSetStr((Mem *)v, z, n, enc, xDel);
  69432. }
  69433. /*
  69434. ** Free an sqlite3_value object
  69435. */
  69436. SQLITE_PRIVATE void sqlite3ValueFree(sqlite3_value *v){
  69437. if( !v ) return;
  69438. sqlite3VdbeMemRelease((Mem *)v);
  69439. sqlite3DbFreeNN(((Mem*)v)->db, v);
  69440. }
  69441. /*
  69442. ** The sqlite3ValueBytes() routine returns the number of bytes in the
  69443. ** sqlite3_value object assuming that it uses the encoding "enc".
  69444. ** The valueBytes() routine is a helper function.
  69445. */
  69446. static SQLITE_NOINLINE int valueBytes(sqlite3_value *pVal, u8 enc){
  69447. return valueToText(pVal, enc)!=0 ? pVal->n : 0;
  69448. }
  69449. SQLITE_PRIVATE int sqlite3ValueBytes(sqlite3_value *pVal, u8 enc){
  69450. Mem *p = (Mem*)pVal;
  69451. assert( (p->flags & MEM_Null)==0 || (p->flags & (MEM_Str|MEM_Blob))==0 );
  69452. if( (p->flags & MEM_Str)!=0 && pVal->enc==enc ){
  69453. return p->n;
  69454. }
  69455. if( (p->flags & MEM_Blob)!=0 ){
  69456. if( p->flags & MEM_Zero ){
  69457. return p->n + p->u.nZero;
  69458. }else{
  69459. return p->n;
  69460. }
  69461. }
  69462. if( p->flags & MEM_Null ) return 0;
  69463. return valueBytes(pVal, enc);
  69464. }
  69465. /************** End of vdbemem.c *********************************************/
  69466. /************** Begin file vdbeaux.c *****************************************/
  69467. /*
  69468. ** 2003 September 6
  69469. **
  69470. ** The author disclaims copyright to this source code. In place of
  69471. ** a legal notice, here is a blessing:
  69472. **
  69473. ** May you do good and not evil.
  69474. ** May you find forgiveness for yourself and forgive others.
  69475. ** May you share freely, never taking more than you give.
  69476. **
  69477. *************************************************************************
  69478. ** This file contains code used for creating, destroying, and populating
  69479. ** a VDBE (or an "sqlite3_stmt" as it is known to the outside world.)
  69480. */
  69481. /* #include "sqliteInt.h" */
  69482. /* #include "vdbeInt.h" */
  69483. /*
  69484. ** Create a new virtual database engine.
  69485. */
  69486. SQLITE_PRIVATE Vdbe *sqlite3VdbeCreate(Parse *pParse){
  69487. sqlite3 *db = pParse->db;
  69488. Vdbe *p;
  69489. p = sqlite3DbMallocRawNN(db, sizeof(Vdbe) );
  69490. if( p==0 ) return 0;
  69491. memset(&p->aOp, 0, sizeof(Vdbe)-offsetof(Vdbe,aOp));
  69492. p->db = db;
  69493. if( db->pVdbe ){
  69494. db->pVdbe->pPrev = p;
  69495. }
  69496. p->pNext = db->pVdbe;
  69497. p->pPrev = 0;
  69498. db->pVdbe = p;
  69499. p->magic = VDBE_MAGIC_INIT;
  69500. p->pParse = pParse;
  69501. pParse->pVdbe = p;
  69502. assert( pParse->aLabel==0 );
  69503. assert( pParse->nLabel==0 );
  69504. assert( pParse->nOpAlloc==0 );
  69505. assert( pParse->szOpAlloc==0 );
  69506. sqlite3VdbeAddOp2(p, OP_Init, 0, 1);
  69507. return p;
  69508. }
  69509. /*
  69510. ** Change the error string stored in Vdbe.zErrMsg
  69511. */
  69512. SQLITE_PRIVATE void sqlite3VdbeError(Vdbe *p, const char *zFormat, ...){
  69513. va_list ap;
  69514. sqlite3DbFree(p->db, p->zErrMsg);
  69515. va_start(ap, zFormat);
  69516. p->zErrMsg = sqlite3VMPrintf(p->db, zFormat, ap);
  69517. va_end(ap);
  69518. }
  69519. /*
  69520. ** Remember the SQL string for a prepared statement.
  69521. */
  69522. SQLITE_PRIVATE void sqlite3VdbeSetSql(Vdbe *p, const char *z, int n, u8 prepFlags){
  69523. if( p==0 ) return;
  69524. p->prepFlags = prepFlags;
  69525. if( (prepFlags & SQLITE_PREPARE_SAVESQL)==0 ){
  69526. p->expmask = 0;
  69527. }
  69528. assert( p->zSql==0 );
  69529. p->zSql = sqlite3DbStrNDup(p->db, z, n);
  69530. }
  69531. /*
  69532. ** Swap all content between two VDBE structures.
  69533. */
  69534. SQLITE_PRIVATE void sqlite3VdbeSwap(Vdbe *pA, Vdbe *pB){
  69535. Vdbe tmp, *pTmp;
  69536. char *zTmp;
  69537. assert( pA->db==pB->db );
  69538. tmp = *pA;
  69539. *pA = *pB;
  69540. *pB = tmp;
  69541. pTmp = pA->pNext;
  69542. pA->pNext = pB->pNext;
  69543. pB->pNext = pTmp;
  69544. pTmp = pA->pPrev;
  69545. pA->pPrev = pB->pPrev;
  69546. pB->pPrev = pTmp;
  69547. zTmp = pA->zSql;
  69548. pA->zSql = pB->zSql;
  69549. pB->zSql = zTmp;
  69550. pB->expmask = pA->expmask;
  69551. pB->prepFlags = pA->prepFlags;
  69552. memcpy(pB->aCounter, pA->aCounter, sizeof(pB->aCounter));
  69553. pB->aCounter[SQLITE_STMTSTATUS_REPREPARE]++;
  69554. }
  69555. /*
  69556. ** Resize the Vdbe.aOp array so that it is at least nOp elements larger
  69557. ** than its current size. nOp is guaranteed to be less than or equal
  69558. ** to 1024/sizeof(Op).
  69559. **
  69560. ** If an out-of-memory error occurs while resizing the array, return
  69561. ** SQLITE_NOMEM. In this case Vdbe.aOp and Parse.nOpAlloc remain
  69562. ** unchanged (this is so that any opcodes already allocated can be
  69563. ** correctly deallocated along with the rest of the Vdbe).
  69564. */
  69565. static int growOpArray(Vdbe *v, int nOp){
  69566. VdbeOp *pNew;
  69567. Parse *p = v->pParse;
  69568. /* The SQLITE_TEST_REALLOC_STRESS compile-time option is designed to force
  69569. ** more frequent reallocs and hence provide more opportunities for
  69570. ** simulated OOM faults. SQLITE_TEST_REALLOC_STRESS is generally used
  69571. ** during testing only. With SQLITE_TEST_REALLOC_STRESS grow the op array
  69572. ** by the minimum* amount required until the size reaches 512. Normal
  69573. ** operation (without SQLITE_TEST_REALLOC_STRESS) is to double the current
  69574. ** size of the op array or add 1KB of space, whichever is smaller. */
  69575. #ifdef SQLITE_TEST_REALLOC_STRESS
  69576. int nNew = (p->nOpAlloc>=512 ? p->nOpAlloc*2 : p->nOpAlloc+nOp);
  69577. #else
  69578. int nNew = (p->nOpAlloc ? p->nOpAlloc*2 : (int)(1024/sizeof(Op)));
  69579. UNUSED_PARAMETER(nOp);
  69580. #endif
  69581. /* Ensure that the size of a VDBE does not grow too large */
  69582. if( nNew > p->db->aLimit[SQLITE_LIMIT_VDBE_OP] ){
  69583. sqlite3OomFault(p->db);
  69584. return SQLITE_NOMEM;
  69585. }
  69586. assert( nOp<=(1024/sizeof(Op)) );
  69587. assert( nNew>=(p->nOpAlloc+nOp) );
  69588. pNew = sqlite3DbRealloc(p->db, v->aOp, nNew*sizeof(Op));
  69589. if( pNew ){
  69590. p->szOpAlloc = sqlite3DbMallocSize(p->db, pNew);
  69591. p->nOpAlloc = p->szOpAlloc/sizeof(Op);
  69592. v->aOp = pNew;
  69593. }
  69594. return (pNew ? SQLITE_OK : SQLITE_NOMEM_BKPT);
  69595. }
  69596. #ifdef SQLITE_DEBUG
  69597. /* This routine is just a convenient place to set a breakpoint that will
  69598. ** fire after each opcode is inserted and displayed using
  69599. ** "PRAGMA vdbe_addoptrace=on".
  69600. */
  69601. static void test_addop_breakpoint(void){
  69602. static int n = 0;
  69603. n++;
  69604. }
  69605. #endif
  69606. /*
  69607. ** Add a new instruction to the list of instructions current in the
  69608. ** VDBE. Return the address of the new instruction.
  69609. **
  69610. ** Parameters:
  69611. **
  69612. ** p Pointer to the VDBE
  69613. **
  69614. ** op The opcode for this instruction
  69615. **
  69616. ** p1, p2, p3 Operands
  69617. **
  69618. ** Use the sqlite3VdbeResolveLabel() function to fix an address and
  69619. ** the sqlite3VdbeChangeP4() function to change the value of the P4
  69620. ** operand.
  69621. */
  69622. static SQLITE_NOINLINE int growOp3(Vdbe *p, int op, int p1, int p2, int p3){
  69623. assert( p->pParse->nOpAlloc<=p->nOp );
  69624. if( growOpArray(p, 1) ) return 1;
  69625. assert( p->pParse->nOpAlloc>p->nOp );
  69626. return sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  69627. }
  69628. SQLITE_PRIVATE int sqlite3VdbeAddOp3(Vdbe *p, int op, int p1, int p2, int p3){
  69629. int i;
  69630. VdbeOp *pOp;
  69631. i = p->nOp;
  69632. assert( p->magic==VDBE_MAGIC_INIT );
  69633. assert( op>=0 && op<0xff );
  69634. if( p->pParse->nOpAlloc<=i ){
  69635. return growOp3(p, op, p1, p2, p3);
  69636. }
  69637. p->nOp++;
  69638. pOp = &p->aOp[i];
  69639. pOp->opcode = (u8)op;
  69640. pOp->p5 = 0;
  69641. pOp->p1 = p1;
  69642. pOp->p2 = p2;
  69643. pOp->p3 = p3;
  69644. pOp->p4.p = 0;
  69645. pOp->p4type = P4_NOTUSED;
  69646. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  69647. pOp->zComment = 0;
  69648. #endif
  69649. #ifdef SQLITE_DEBUG
  69650. if( p->db->flags & SQLITE_VdbeAddopTrace ){
  69651. int jj, kk;
  69652. Parse *pParse = p->pParse;
  69653. for(jj=kk=0; jj<pParse->nColCache; jj++){
  69654. struct yColCache *x = pParse->aColCache + jj;
  69655. printf(" r[%d]={%d:%d}", x->iReg, x->iTable, x->iColumn);
  69656. kk++;
  69657. }
  69658. if( kk ) printf("\n");
  69659. sqlite3VdbePrintOp(0, i, &p->aOp[i]);
  69660. test_addop_breakpoint();
  69661. }
  69662. #endif
  69663. #ifdef VDBE_PROFILE
  69664. pOp->cycles = 0;
  69665. pOp->cnt = 0;
  69666. #endif
  69667. #ifdef SQLITE_VDBE_COVERAGE
  69668. pOp->iSrcLine = 0;
  69669. #endif
  69670. return i;
  69671. }
  69672. SQLITE_PRIVATE int sqlite3VdbeAddOp0(Vdbe *p, int op){
  69673. return sqlite3VdbeAddOp3(p, op, 0, 0, 0);
  69674. }
  69675. SQLITE_PRIVATE int sqlite3VdbeAddOp1(Vdbe *p, int op, int p1){
  69676. return sqlite3VdbeAddOp3(p, op, p1, 0, 0);
  69677. }
  69678. SQLITE_PRIVATE int sqlite3VdbeAddOp2(Vdbe *p, int op, int p1, int p2){
  69679. return sqlite3VdbeAddOp3(p, op, p1, p2, 0);
  69680. }
  69681. /* Generate code for an unconditional jump to instruction iDest
  69682. */
  69683. SQLITE_PRIVATE int sqlite3VdbeGoto(Vdbe *p, int iDest){
  69684. return sqlite3VdbeAddOp3(p, OP_Goto, 0, iDest, 0);
  69685. }
  69686. /* Generate code to cause the string zStr to be loaded into
  69687. ** register iDest
  69688. */
  69689. SQLITE_PRIVATE int sqlite3VdbeLoadString(Vdbe *p, int iDest, const char *zStr){
  69690. return sqlite3VdbeAddOp4(p, OP_String8, 0, iDest, 0, zStr, 0);
  69691. }
  69692. /*
  69693. ** Generate code that initializes multiple registers to string or integer
  69694. ** constants. The registers begin with iDest and increase consecutively.
  69695. ** One register is initialized for each characgter in zTypes[]. For each
  69696. ** "s" character in zTypes[], the register is a string if the argument is
  69697. ** not NULL, or OP_Null if the value is a null pointer. For each "i" character
  69698. ** in zTypes[], the register is initialized to an integer.
  69699. **
  69700. ** If the input string does not end with "X" then an OP_ResultRow instruction
  69701. ** is generated for the values inserted.
  69702. */
  69703. SQLITE_PRIVATE void sqlite3VdbeMultiLoad(Vdbe *p, int iDest, const char *zTypes, ...){
  69704. va_list ap;
  69705. int i;
  69706. char c;
  69707. va_start(ap, zTypes);
  69708. for(i=0; (c = zTypes[i])!=0; i++){
  69709. if( c=='s' ){
  69710. const char *z = va_arg(ap, const char*);
  69711. sqlite3VdbeAddOp4(p, z==0 ? OP_Null : OP_String8, 0, iDest+i, 0, z, 0);
  69712. }else if( c=='i' ){
  69713. sqlite3VdbeAddOp2(p, OP_Integer, va_arg(ap, int), iDest+i);
  69714. }else{
  69715. goto skip_op_resultrow;
  69716. }
  69717. }
  69718. sqlite3VdbeAddOp2(p, OP_ResultRow, iDest, i);
  69719. skip_op_resultrow:
  69720. va_end(ap);
  69721. }
  69722. /*
  69723. ** Add an opcode that includes the p4 value as a pointer.
  69724. */
  69725. SQLITE_PRIVATE int sqlite3VdbeAddOp4(
  69726. Vdbe *p, /* Add the opcode to this VM */
  69727. int op, /* The new opcode */
  69728. int p1, /* The P1 operand */
  69729. int p2, /* The P2 operand */
  69730. int p3, /* The P3 operand */
  69731. const char *zP4, /* The P4 operand */
  69732. int p4type /* P4 operand type */
  69733. ){
  69734. int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  69735. sqlite3VdbeChangeP4(p, addr, zP4, p4type);
  69736. return addr;
  69737. }
  69738. /*
  69739. ** Add an opcode that includes the p4 value with a P4_INT64 or
  69740. ** P4_REAL type.
  69741. */
  69742. SQLITE_PRIVATE int sqlite3VdbeAddOp4Dup8(
  69743. Vdbe *p, /* Add the opcode to this VM */
  69744. int op, /* The new opcode */
  69745. int p1, /* The P1 operand */
  69746. int p2, /* The P2 operand */
  69747. int p3, /* The P3 operand */
  69748. const u8 *zP4, /* The P4 operand */
  69749. int p4type /* P4 operand type */
  69750. ){
  69751. char *p4copy = sqlite3DbMallocRawNN(sqlite3VdbeDb(p), 8);
  69752. if( p4copy ) memcpy(p4copy, zP4, 8);
  69753. return sqlite3VdbeAddOp4(p, op, p1, p2, p3, p4copy, p4type);
  69754. }
  69755. /*
  69756. ** Add an OP_ParseSchema opcode. This routine is broken out from
  69757. ** sqlite3VdbeAddOp4() since it needs to also needs to mark all btrees
  69758. ** as having been used.
  69759. **
  69760. ** The zWhere string must have been obtained from sqlite3_malloc().
  69761. ** This routine will take ownership of the allocated memory.
  69762. */
  69763. SQLITE_PRIVATE void sqlite3VdbeAddParseSchemaOp(Vdbe *p, int iDb, char *zWhere){
  69764. int j;
  69765. sqlite3VdbeAddOp4(p, OP_ParseSchema, iDb, 0, 0, zWhere, P4_DYNAMIC);
  69766. for(j=0; j<p->db->nDb; j++) sqlite3VdbeUsesBtree(p, j);
  69767. }
  69768. /*
  69769. ** Add an opcode that includes the p4 value as an integer.
  69770. */
  69771. SQLITE_PRIVATE int sqlite3VdbeAddOp4Int(
  69772. Vdbe *p, /* Add the opcode to this VM */
  69773. int op, /* The new opcode */
  69774. int p1, /* The P1 operand */
  69775. int p2, /* The P2 operand */
  69776. int p3, /* The P3 operand */
  69777. int p4 /* The P4 operand as an integer */
  69778. ){
  69779. int addr = sqlite3VdbeAddOp3(p, op, p1, p2, p3);
  69780. if( p->db->mallocFailed==0 ){
  69781. VdbeOp *pOp = &p->aOp[addr];
  69782. pOp->p4type = P4_INT32;
  69783. pOp->p4.i = p4;
  69784. }
  69785. return addr;
  69786. }
  69787. /* Insert the end of a co-routine
  69788. */
  69789. SQLITE_PRIVATE void sqlite3VdbeEndCoroutine(Vdbe *v, int regYield){
  69790. sqlite3VdbeAddOp1(v, OP_EndCoroutine, regYield);
  69791. /* Clear the temporary register cache, thereby ensuring that each
  69792. ** co-routine has its own independent set of registers, because co-routines
  69793. ** might expect their registers to be preserved across an OP_Yield, and
  69794. ** that could cause problems if two or more co-routines are using the same
  69795. ** temporary register.
  69796. */
  69797. v->pParse->nTempReg = 0;
  69798. v->pParse->nRangeReg = 0;
  69799. }
  69800. /*
  69801. ** Create a new symbolic label for an instruction that has yet to be
  69802. ** coded. The symbolic label is really just a negative number. The
  69803. ** label can be used as the P2 value of an operation. Later, when
  69804. ** the label is resolved to a specific address, the VDBE will scan
  69805. ** through its operation list and change all values of P2 which match
  69806. ** the label into the resolved address.
  69807. **
  69808. ** The VDBE knows that a P2 value is a label because labels are
  69809. ** always negative and P2 values are suppose to be non-negative.
  69810. ** Hence, a negative P2 value is a label that has yet to be resolved.
  69811. **
  69812. ** Zero is returned if a malloc() fails.
  69813. */
  69814. SQLITE_PRIVATE int sqlite3VdbeMakeLabel(Vdbe *v){
  69815. Parse *p = v->pParse;
  69816. int i = p->nLabel++;
  69817. assert( v->magic==VDBE_MAGIC_INIT );
  69818. if( (i & (i-1))==0 ){
  69819. p->aLabel = sqlite3DbReallocOrFree(p->db, p->aLabel,
  69820. (i*2+1)*sizeof(p->aLabel[0]));
  69821. }
  69822. if( p->aLabel ){
  69823. p->aLabel[i] = -1;
  69824. }
  69825. return ADDR(i);
  69826. }
  69827. /*
  69828. ** Resolve label "x" to be the address of the next instruction to
  69829. ** be inserted. The parameter "x" must have been obtained from
  69830. ** a prior call to sqlite3VdbeMakeLabel().
  69831. */
  69832. SQLITE_PRIVATE void sqlite3VdbeResolveLabel(Vdbe *v, int x){
  69833. Parse *p = v->pParse;
  69834. int j = ADDR(x);
  69835. assert( v->magic==VDBE_MAGIC_INIT );
  69836. assert( j<p->nLabel );
  69837. assert( j>=0 );
  69838. if( p->aLabel ){
  69839. p->aLabel[j] = v->nOp;
  69840. }
  69841. }
  69842. /*
  69843. ** Mark the VDBE as one that can only be run one time.
  69844. */
  69845. SQLITE_PRIVATE void sqlite3VdbeRunOnlyOnce(Vdbe *p){
  69846. p->runOnlyOnce = 1;
  69847. }
  69848. /*
  69849. ** Mark the VDBE as one that can only be run multiple times.
  69850. */
  69851. SQLITE_PRIVATE void sqlite3VdbeReusable(Vdbe *p){
  69852. p->runOnlyOnce = 0;
  69853. }
  69854. #ifdef SQLITE_DEBUG /* sqlite3AssertMayAbort() logic */
  69855. /*
  69856. ** The following type and function are used to iterate through all opcodes
  69857. ** in a Vdbe main program and each of the sub-programs (triggers) it may
  69858. ** invoke directly or indirectly. It should be used as follows:
  69859. **
  69860. ** Op *pOp;
  69861. ** VdbeOpIter sIter;
  69862. **
  69863. ** memset(&sIter, 0, sizeof(sIter));
  69864. ** sIter.v = v; // v is of type Vdbe*
  69865. ** while( (pOp = opIterNext(&sIter)) ){
  69866. ** // Do something with pOp
  69867. ** }
  69868. ** sqlite3DbFree(v->db, sIter.apSub);
  69869. **
  69870. */
  69871. typedef struct VdbeOpIter VdbeOpIter;
  69872. struct VdbeOpIter {
  69873. Vdbe *v; /* Vdbe to iterate through the opcodes of */
  69874. SubProgram **apSub; /* Array of subprograms */
  69875. int nSub; /* Number of entries in apSub */
  69876. int iAddr; /* Address of next instruction to return */
  69877. int iSub; /* 0 = main program, 1 = first sub-program etc. */
  69878. };
  69879. static Op *opIterNext(VdbeOpIter *p){
  69880. Vdbe *v = p->v;
  69881. Op *pRet = 0;
  69882. Op *aOp;
  69883. int nOp;
  69884. if( p->iSub<=p->nSub ){
  69885. if( p->iSub==0 ){
  69886. aOp = v->aOp;
  69887. nOp = v->nOp;
  69888. }else{
  69889. aOp = p->apSub[p->iSub-1]->aOp;
  69890. nOp = p->apSub[p->iSub-1]->nOp;
  69891. }
  69892. assert( p->iAddr<nOp );
  69893. pRet = &aOp[p->iAddr];
  69894. p->iAddr++;
  69895. if( p->iAddr==nOp ){
  69896. p->iSub++;
  69897. p->iAddr = 0;
  69898. }
  69899. if( pRet->p4type==P4_SUBPROGRAM ){
  69900. int nByte = (p->nSub+1)*sizeof(SubProgram*);
  69901. int j;
  69902. for(j=0; j<p->nSub; j++){
  69903. if( p->apSub[j]==pRet->p4.pProgram ) break;
  69904. }
  69905. if( j==p->nSub ){
  69906. p->apSub = sqlite3DbReallocOrFree(v->db, p->apSub, nByte);
  69907. if( !p->apSub ){
  69908. pRet = 0;
  69909. }else{
  69910. p->apSub[p->nSub++] = pRet->p4.pProgram;
  69911. }
  69912. }
  69913. }
  69914. }
  69915. return pRet;
  69916. }
  69917. /*
  69918. ** Check if the program stored in the VM associated with pParse may
  69919. ** throw an ABORT exception (causing the statement, but not entire transaction
  69920. ** to be rolled back). This condition is true if the main program or any
  69921. ** sub-programs contains any of the following:
  69922. **
  69923. ** * OP_Halt with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
  69924. ** * OP_HaltIfNull with P1=SQLITE_CONSTRAINT and P2=OE_Abort.
  69925. ** * OP_Destroy
  69926. ** * OP_VUpdate
  69927. ** * OP_VRename
  69928. ** * OP_FkCounter with P2==0 (immediate foreign key constraint)
  69929. ** * OP_CreateBtree/BTREE_INTKEY and OP_InitCoroutine
  69930. ** (for CREATE TABLE AS SELECT ...)
  69931. **
  69932. ** Then check that the value of Parse.mayAbort is true if an
  69933. ** ABORT may be thrown, or false otherwise. Return true if it does
  69934. ** match, or false otherwise. This function is intended to be used as
  69935. ** part of an assert statement in the compiler. Similar to:
  69936. **
  69937. ** assert( sqlite3VdbeAssertMayAbort(pParse->pVdbe, pParse->mayAbort) );
  69938. */
  69939. SQLITE_PRIVATE int sqlite3VdbeAssertMayAbort(Vdbe *v, int mayAbort){
  69940. int hasAbort = 0;
  69941. int hasFkCounter = 0;
  69942. int hasCreateTable = 0;
  69943. int hasInitCoroutine = 0;
  69944. Op *pOp;
  69945. VdbeOpIter sIter;
  69946. memset(&sIter, 0, sizeof(sIter));
  69947. sIter.v = v;
  69948. while( (pOp = opIterNext(&sIter))!=0 ){
  69949. int opcode = pOp->opcode;
  69950. if( opcode==OP_Destroy || opcode==OP_VUpdate || opcode==OP_VRename
  69951. || ((opcode==OP_Halt || opcode==OP_HaltIfNull)
  69952. && ((pOp->p1&0xff)==SQLITE_CONSTRAINT && pOp->p2==OE_Abort))
  69953. ){
  69954. hasAbort = 1;
  69955. break;
  69956. }
  69957. if( opcode==OP_CreateBtree && pOp->p3==BTREE_INTKEY ) hasCreateTable = 1;
  69958. if( opcode==OP_InitCoroutine ) hasInitCoroutine = 1;
  69959. #ifndef SQLITE_OMIT_FOREIGN_KEY
  69960. if( opcode==OP_FkCounter && pOp->p1==0 && pOp->p2==1 ){
  69961. hasFkCounter = 1;
  69962. }
  69963. #endif
  69964. }
  69965. sqlite3DbFree(v->db, sIter.apSub);
  69966. /* Return true if hasAbort==mayAbort. Or if a malloc failure occurred.
  69967. ** If malloc failed, then the while() loop above may not have iterated
  69968. ** through all opcodes and hasAbort may be set incorrectly. Return
  69969. ** true for this case to prevent the assert() in the callers frame
  69970. ** from failing. */
  69971. return ( v->db->mallocFailed || hasAbort==mayAbort || hasFkCounter
  69972. || (hasCreateTable && hasInitCoroutine) );
  69973. }
  69974. #endif /* SQLITE_DEBUG - the sqlite3AssertMayAbort() function */
  69975. /*
  69976. ** This routine is called after all opcodes have been inserted. It loops
  69977. ** through all the opcodes and fixes up some details.
  69978. **
  69979. ** (1) For each jump instruction with a negative P2 value (a label)
  69980. ** resolve the P2 value to an actual address.
  69981. **
  69982. ** (2) Compute the maximum number of arguments used by any SQL function
  69983. ** and store that value in *pMaxFuncArgs.
  69984. **
  69985. ** (3) Update the Vdbe.readOnly and Vdbe.bIsReader flags to accurately
  69986. ** indicate what the prepared statement actually does.
  69987. **
  69988. ** (4) Initialize the p4.xAdvance pointer on opcodes that use it.
  69989. **
  69990. ** (5) Reclaim the memory allocated for storing labels.
  69991. **
  69992. ** This routine will only function correctly if the mkopcodeh.tcl generator
  69993. ** script numbers the opcodes correctly. Changes to this routine must be
  69994. ** coordinated with changes to mkopcodeh.tcl.
  69995. */
  69996. static void resolveP2Values(Vdbe *p, int *pMaxFuncArgs){
  69997. int nMaxArgs = *pMaxFuncArgs;
  69998. Op *pOp;
  69999. Parse *pParse = p->pParse;
  70000. int *aLabel = pParse->aLabel;
  70001. p->readOnly = 1;
  70002. p->bIsReader = 0;
  70003. pOp = &p->aOp[p->nOp-1];
  70004. while(1){
  70005. /* Only JUMP opcodes and the short list of special opcodes in the switch
  70006. ** below need to be considered. The mkopcodeh.tcl generator script groups
  70007. ** all these opcodes together near the front of the opcode list. Skip
  70008. ** any opcode that does not need processing by virtual of the fact that
  70009. ** it is larger than SQLITE_MX_JUMP_OPCODE, as a performance optimization.
  70010. */
  70011. if( pOp->opcode<=SQLITE_MX_JUMP_OPCODE ){
  70012. /* NOTE: Be sure to update mkopcodeh.tcl when adding or removing
  70013. ** cases from this switch! */
  70014. switch( pOp->opcode ){
  70015. case OP_Transaction: {
  70016. if( pOp->p2!=0 ) p->readOnly = 0;
  70017. /* fall thru */
  70018. }
  70019. case OP_AutoCommit:
  70020. case OP_Savepoint: {
  70021. p->bIsReader = 1;
  70022. break;
  70023. }
  70024. #ifndef SQLITE_OMIT_WAL
  70025. case OP_Checkpoint:
  70026. #endif
  70027. case OP_Vacuum:
  70028. case OP_JournalMode: {
  70029. p->readOnly = 0;
  70030. p->bIsReader = 1;
  70031. break;
  70032. }
  70033. case OP_Next:
  70034. case OP_NextIfOpen:
  70035. case OP_SorterNext: {
  70036. pOp->p4.xAdvance = sqlite3BtreeNext;
  70037. pOp->p4type = P4_ADVANCE;
  70038. /* The code generator never codes any of these opcodes as a jump
  70039. ** to a label. They are always coded as a jump backwards to a
  70040. ** known address */
  70041. assert( pOp->p2>=0 );
  70042. break;
  70043. }
  70044. case OP_Prev:
  70045. case OP_PrevIfOpen: {
  70046. pOp->p4.xAdvance = sqlite3BtreePrevious;
  70047. pOp->p4type = P4_ADVANCE;
  70048. /* The code generator never codes any of these opcodes as a jump
  70049. ** to a label. They are always coded as a jump backwards to a
  70050. ** known address */
  70051. assert( pOp->p2>=0 );
  70052. break;
  70053. }
  70054. #ifndef SQLITE_OMIT_VIRTUALTABLE
  70055. case OP_VUpdate: {
  70056. if( pOp->p2>nMaxArgs ) nMaxArgs = pOp->p2;
  70057. break;
  70058. }
  70059. case OP_VFilter: {
  70060. int n;
  70061. assert( (pOp - p->aOp) >= 3 );
  70062. assert( pOp[-1].opcode==OP_Integer );
  70063. n = pOp[-1].p1;
  70064. if( n>nMaxArgs ) nMaxArgs = n;
  70065. /* Fall through into the default case */
  70066. }
  70067. #endif
  70068. default: {
  70069. if( pOp->p2<0 ){
  70070. /* The mkopcodeh.tcl script has so arranged things that the only
  70071. ** non-jump opcodes less than SQLITE_MX_JUMP_CODE are guaranteed to
  70072. ** have non-negative values for P2. */
  70073. assert( (sqlite3OpcodeProperty[pOp->opcode] & OPFLG_JUMP)!=0 );
  70074. assert( ADDR(pOp->p2)<pParse->nLabel );
  70075. pOp->p2 = aLabel[ADDR(pOp->p2)];
  70076. }
  70077. break;
  70078. }
  70079. }
  70080. /* The mkopcodeh.tcl script has so arranged things that the only
  70081. ** non-jump opcodes less than SQLITE_MX_JUMP_CODE are guaranteed to
  70082. ** have non-negative values for P2. */
  70083. assert( (sqlite3OpcodeProperty[pOp->opcode]&OPFLG_JUMP)==0 || pOp->p2>=0);
  70084. }
  70085. if( pOp==p->aOp ) break;
  70086. pOp--;
  70087. }
  70088. sqlite3DbFree(p->db, pParse->aLabel);
  70089. pParse->aLabel = 0;
  70090. pParse->nLabel = 0;
  70091. *pMaxFuncArgs = nMaxArgs;
  70092. assert( p->bIsReader!=0 || DbMaskAllZero(p->btreeMask) );
  70093. }
  70094. /*
  70095. ** Return the address of the next instruction to be inserted.
  70096. */
  70097. SQLITE_PRIVATE int sqlite3VdbeCurrentAddr(Vdbe *p){
  70098. assert( p->magic==VDBE_MAGIC_INIT );
  70099. return p->nOp;
  70100. }
  70101. /*
  70102. ** Verify that at least N opcode slots are available in p without
  70103. ** having to malloc for more space (except when compiled using
  70104. ** SQLITE_TEST_REALLOC_STRESS). This interface is used during testing
  70105. ** to verify that certain calls to sqlite3VdbeAddOpList() can never
  70106. ** fail due to a OOM fault and hence that the return value from
  70107. ** sqlite3VdbeAddOpList() will always be non-NULL.
  70108. */
  70109. #if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
  70110. SQLITE_PRIVATE void sqlite3VdbeVerifyNoMallocRequired(Vdbe *p, int N){
  70111. assert( p->nOp + N <= p->pParse->nOpAlloc );
  70112. }
  70113. #endif
  70114. /*
  70115. ** Verify that the VM passed as the only argument does not contain
  70116. ** an OP_ResultRow opcode. Fail an assert() if it does. This is used
  70117. ** by code in pragma.c to ensure that the implementation of certain
  70118. ** pragmas comports with the flags specified in the mkpragmatab.tcl
  70119. ** script.
  70120. */
  70121. #if defined(SQLITE_DEBUG) && !defined(SQLITE_TEST_REALLOC_STRESS)
  70122. SQLITE_PRIVATE void sqlite3VdbeVerifyNoResultRow(Vdbe *p){
  70123. int i;
  70124. for(i=0; i<p->nOp; i++){
  70125. assert( p->aOp[i].opcode!=OP_ResultRow );
  70126. }
  70127. }
  70128. #endif
  70129. /*
  70130. ** This function returns a pointer to the array of opcodes associated with
  70131. ** the Vdbe passed as the first argument. It is the callers responsibility
  70132. ** to arrange for the returned array to be eventually freed using the
  70133. ** vdbeFreeOpArray() function.
  70134. **
  70135. ** Before returning, *pnOp is set to the number of entries in the returned
  70136. ** array. Also, *pnMaxArg is set to the larger of its current value and
  70137. ** the number of entries in the Vdbe.apArg[] array required to execute the
  70138. ** returned program.
  70139. */
  70140. SQLITE_PRIVATE VdbeOp *sqlite3VdbeTakeOpArray(Vdbe *p, int *pnOp, int *pnMaxArg){
  70141. VdbeOp *aOp = p->aOp;
  70142. assert( aOp && !p->db->mallocFailed );
  70143. /* Check that sqlite3VdbeUsesBtree() was not called on this VM */
  70144. assert( DbMaskAllZero(p->btreeMask) );
  70145. resolveP2Values(p, pnMaxArg);
  70146. *pnOp = p->nOp;
  70147. p->aOp = 0;
  70148. return aOp;
  70149. }
  70150. /*
  70151. ** Add a whole list of operations to the operation stack. Return a
  70152. ** pointer to the first operation inserted.
  70153. **
  70154. ** Non-zero P2 arguments to jump instructions are automatically adjusted
  70155. ** so that the jump target is relative to the first operation inserted.
  70156. */
  70157. SQLITE_PRIVATE VdbeOp *sqlite3VdbeAddOpList(
  70158. Vdbe *p, /* Add opcodes to the prepared statement */
  70159. int nOp, /* Number of opcodes to add */
  70160. VdbeOpList const *aOp, /* The opcodes to be added */
  70161. int iLineno /* Source-file line number of first opcode */
  70162. ){
  70163. int i;
  70164. VdbeOp *pOut, *pFirst;
  70165. assert( nOp>0 );
  70166. assert( p->magic==VDBE_MAGIC_INIT );
  70167. if( p->nOp + nOp > p->pParse->nOpAlloc && growOpArray(p, nOp) ){
  70168. return 0;
  70169. }
  70170. pFirst = pOut = &p->aOp[p->nOp];
  70171. for(i=0; i<nOp; i++, aOp++, pOut++){
  70172. pOut->opcode = aOp->opcode;
  70173. pOut->p1 = aOp->p1;
  70174. pOut->p2 = aOp->p2;
  70175. assert( aOp->p2>=0 );
  70176. if( (sqlite3OpcodeProperty[aOp->opcode] & OPFLG_JUMP)!=0 && aOp->p2>0 ){
  70177. pOut->p2 += p->nOp;
  70178. }
  70179. pOut->p3 = aOp->p3;
  70180. pOut->p4type = P4_NOTUSED;
  70181. pOut->p4.p = 0;
  70182. pOut->p5 = 0;
  70183. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  70184. pOut->zComment = 0;
  70185. #endif
  70186. #ifdef SQLITE_VDBE_COVERAGE
  70187. pOut->iSrcLine = iLineno+i;
  70188. #else
  70189. (void)iLineno;
  70190. #endif
  70191. #ifdef SQLITE_DEBUG
  70192. if( p->db->flags & SQLITE_VdbeAddopTrace ){
  70193. sqlite3VdbePrintOp(0, i+p->nOp, &p->aOp[i+p->nOp]);
  70194. }
  70195. #endif
  70196. }
  70197. p->nOp += nOp;
  70198. return pFirst;
  70199. }
  70200. #if defined(SQLITE_ENABLE_STMT_SCANSTATUS)
  70201. /*
  70202. ** Add an entry to the array of counters managed by sqlite3_stmt_scanstatus().
  70203. */
  70204. SQLITE_PRIVATE void sqlite3VdbeScanStatus(
  70205. Vdbe *p, /* VM to add scanstatus() to */
  70206. int addrExplain, /* Address of OP_Explain (or 0) */
  70207. int addrLoop, /* Address of loop counter */
  70208. int addrVisit, /* Address of rows visited counter */
  70209. LogEst nEst, /* Estimated number of output rows */
  70210. const char *zName /* Name of table or index being scanned */
  70211. ){
  70212. int nByte = (p->nScan+1) * sizeof(ScanStatus);
  70213. ScanStatus *aNew;
  70214. aNew = (ScanStatus*)sqlite3DbRealloc(p->db, p->aScan, nByte);
  70215. if( aNew ){
  70216. ScanStatus *pNew = &aNew[p->nScan++];
  70217. pNew->addrExplain = addrExplain;
  70218. pNew->addrLoop = addrLoop;
  70219. pNew->addrVisit = addrVisit;
  70220. pNew->nEst = nEst;
  70221. pNew->zName = sqlite3DbStrDup(p->db, zName);
  70222. p->aScan = aNew;
  70223. }
  70224. }
  70225. #endif
  70226. /*
  70227. ** Change the value of the opcode, or P1, P2, P3, or P5 operands
  70228. ** for a specific instruction.
  70229. */
  70230. SQLITE_PRIVATE void sqlite3VdbeChangeOpcode(Vdbe *p, u32 addr, u8 iNewOpcode){
  70231. sqlite3VdbeGetOp(p,addr)->opcode = iNewOpcode;
  70232. }
  70233. SQLITE_PRIVATE void sqlite3VdbeChangeP1(Vdbe *p, u32 addr, int val){
  70234. sqlite3VdbeGetOp(p,addr)->p1 = val;
  70235. }
  70236. SQLITE_PRIVATE void sqlite3VdbeChangeP2(Vdbe *p, u32 addr, int val){
  70237. sqlite3VdbeGetOp(p,addr)->p2 = val;
  70238. }
  70239. SQLITE_PRIVATE void sqlite3VdbeChangeP3(Vdbe *p, u32 addr, int val){
  70240. sqlite3VdbeGetOp(p,addr)->p3 = val;
  70241. }
  70242. SQLITE_PRIVATE void sqlite3VdbeChangeP5(Vdbe *p, u16 p5){
  70243. assert( p->nOp>0 || p->db->mallocFailed );
  70244. if( p->nOp>0 ) p->aOp[p->nOp-1].p5 = p5;
  70245. }
  70246. /*
  70247. ** Change the P2 operand of instruction addr so that it points to
  70248. ** the address of the next instruction to be coded.
  70249. */
  70250. SQLITE_PRIVATE void sqlite3VdbeJumpHere(Vdbe *p, int addr){
  70251. sqlite3VdbeChangeP2(p, addr, p->nOp);
  70252. }
  70253. /*
  70254. ** If the input FuncDef structure is ephemeral, then free it. If
  70255. ** the FuncDef is not ephermal, then do nothing.
  70256. */
  70257. static void freeEphemeralFunction(sqlite3 *db, FuncDef *pDef){
  70258. if( (pDef->funcFlags & SQLITE_FUNC_EPHEM)!=0 ){
  70259. sqlite3DbFreeNN(db, pDef);
  70260. }
  70261. }
  70262. static void vdbeFreeOpArray(sqlite3 *, Op *, int);
  70263. /*
  70264. ** Delete a P4 value if necessary.
  70265. */
  70266. static SQLITE_NOINLINE void freeP4Mem(sqlite3 *db, Mem *p){
  70267. if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
  70268. sqlite3DbFreeNN(db, p);
  70269. }
  70270. static SQLITE_NOINLINE void freeP4FuncCtx(sqlite3 *db, sqlite3_context *p){
  70271. freeEphemeralFunction(db, p->pFunc);
  70272. sqlite3DbFreeNN(db, p);
  70273. }
  70274. static void freeP4(sqlite3 *db, int p4type, void *p4){
  70275. assert( db );
  70276. switch( p4type ){
  70277. case P4_FUNCCTX: {
  70278. freeP4FuncCtx(db, (sqlite3_context*)p4);
  70279. break;
  70280. }
  70281. case P4_REAL:
  70282. case P4_INT64:
  70283. case P4_DYNAMIC:
  70284. case P4_DYNBLOB:
  70285. case P4_INTARRAY: {
  70286. sqlite3DbFree(db, p4);
  70287. break;
  70288. }
  70289. case P4_KEYINFO: {
  70290. if( db->pnBytesFreed==0 ) sqlite3KeyInfoUnref((KeyInfo*)p4);
  70291. break;
  70292. }
  70293. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  70294. case P4_EXPR: {
  70295. sqlite3ExprDelete(db, (Expr*)p4);
  70296. break;
  70297. }
  70298. #endif
  70299. case P4_FUNCDEF: {
  70300. freeEphemeralFunction(db, (FuncDef*)p4);
  70301. break;
  70302. }
  70303. case P4_MEM: {
  70304. if( db->pnBytesFreed==0 ){
  70305. sqlite3ValueFree((sqlite3_value*)p4);
  70306. }else{
  70307. freeP4Mem(db, (Mem*)p4);
  70308. }
  70309. break;
  70310. }
  70311. case P4_VTAB : {
  70312. if( db->pnBytesFreed==0 ) sqlite3VtabUnlock((VTable *)p4);
  70313. break;
  70314. }
  70315. }
  70316. }
  70317. /*
  70318. ** Free the space allocated for aOp and any p4 values allocated for the
  70319. ** opcodes contained within. If aOp is not NULL it is assumed to contain
  70320. ** nOp entries.
  70321. */
  70322. static void vdbeFreeOpArray(sqlite3 *db, Op *aOp, int nOp){
  70323. if( aOp ){
  70324. Op *pOp;
  70325. for(pOp=&aOp[nOp-1]; pOp>=aOp; pOp--){
  70326. if( pOp->p4type <= P4_FREE_IF_LE ) freeP4(db, pOp->p4type, pOp->p4.p);
  70327. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  70328. sqlite3DbFree(db, pOp->zComment);
  70329. #endif
  70330. }
  70331. sqlite3DbFreeNN(db, aOp);
  70332. }
  70333. }
  70334. /*
  70335. ** Link the SubProgram object passed as the second argument into the linked
  70336. ** list at Vdbe.pSubProgram. This list is used to delete all sub-program
  70337. ** objects when the VM is no longer required.
  70338. */
  70339. SQLITE_PRIVATE void sqlite3VdbeLinkSubProgram(Vdbe *pVdbe, SubProgram *p){
  70340. p->pNext = pVdbe->pProgram;
  70341. pVdbe->pProgram = p;
  70342. }
  70343. /*
  70344. ** Change the opcode at addr into OP_Noop
  70345. */
  70346. SQLITE_PRIVATE int sqlite3VdbeChangeToNoop(Vdbe *p, int addr){
  70347. VdbeOp *pOp;
  70348. if( p->db->mallocFailed ) return 0;
  70349. assert( addr>=0 && addr<p->nOp );
  70350. pOp = &p->aOp[addr];
  70351. freeP4(p->db, pOp->p4type, pOp->p4.p);
  70352. pOp->p4type = P4_NOTUSED;
  70353. pOp->p4.z = 0;
  70354. pOp->opcode = OP_Noop;
  70355. return 1;
  70356. }
  70357. /*
  70358. ** If the last opcode is "op" and it is not a jump destination,
  70359. ** then remove it. Return true if and only if an opcode was removed.
  70360. */
  70361. SQLITE_PRIVATE int sqlite3VdbeDeletePriorOpcode(Vdbe *p, u8 op){
  70362. if( p->nOp>0 && p->aOp[p->nOp-1].opcode==op ){
  70363. return sqlite3VdbeChangeToNoop(p, p->nOp-1);
  70364. }else{
  70365. return 0;
  70366. }
  70367. }
  70368. /*
  70369. ** Change the value of the P4 operand for a specific instruction.
  70370. ** This routine is useful when a large program is loaded from a
  70371. ** static array using sqlite3VdbeAddOpList but we want to make a
  70372. ** few minor changes to the program.
  70373. **
  70374. ** If n>=0 then the P4 operand is dynamic, meaning that a copy of
  70375. ** the string is made into memory obtained from sqlite3_malloc().
  70376. ** A value of n==0 means copy bytes of zP4 up to and including the
  70377. ** first null byte. If n>0 then copy n+1 bytes of zP4.
  70378. **
  70379. ** Other values of n (P4_STATIC, P4_COLLSEQ etc.) indicate that zP4 points
  70380. ** to a string or structure that is guaranteed to exist for the lifetime of
  70381. ** the Vdbe. In these cases we can just copy the pointer.
  70382. **
  70383. ** If addr<0 then change P4 on the most recently inserted instruction.
  70384. */
  70385. static void SQLITE_NOINLINE vdbeChangeP4Full(
  70386. Vdbe *p,
  70387. Op *pOp,
  70388. const char *zP4,
  70389. int n
  70390. ){
  70391. if( pOp->p4type ){
  70392. freeP4(p->db, pOp->p4type, pOp->p4.p);
  70393. pOp->p4type = 0;
  70394. pOp->p4.p = 0;
  70395. }
  70396. if( n<0 ){
  70397. sqlite3VdbeChangeP4(p, (int)(pOp - p->aOp), zP4, n);
  70398. }else{
  70399. if( n==0 ) n = sqlite3Strlen30(zP4);
  70400. pOp->p4.z = sqlite3DbStrNDup(p->db, zP4, n);
  70401. pOp->p4type = P4_DYNAMIC;
  70402. }
  70403. }
  70404. SQLITE_PRIVATE void sqlite3VdbeChangeP4(Vdbe *p, int addr, const char *zP4, int n){
  70405. Op *pOp;
  70406. sqlite3 *db;
  70407. assert( p!=0 );
  70408. db = p->db;
  70409. assert( p->magic==VDBE_MAGIC_INIT );
  70410. assert( p->aOp!=0 || db->mallocFailed );
  70411. if( db->mallocFailed ){
  70412. if( n!=P4_VTAB ) freeP4(db, n, (void*)*(char**)&zP4);
  70413. return;
  70414. }
  70415. assert( p->nOp>0 );
  70416. assert( addr<p->nOp );
  70417. if( addr<0 ){
  70418. addr = p->nOp - 1;
  70419. }
  70420. pOp = &p->aOp[addr];
  70421. if( n>=0 || pOp->p4type ){
  70422. vdbeChangeP4Full(p, pOp, zP4, n);
  70423. return;
  70424. }
  70425. if( n==P4_INT32 ){
  70426. /* Note: this cast is safe, because the origin data point was an int
  70427. ** that was cast to a (const char *). */
  70428. pOp->p4.i = SQLITE_PTR_TO_INT(zP4);
  70429. pOp->p4type = P4_INT32;
  70430. }else if( zP4!=0 ){
  70431. assert( n<0 );
  70432. pOp->p4.p = (void*)zP4;
  70433. pOp->p4type = (signed char)n;
  70434. if( n==P4_VTAB ) sqlite3VtabLock((VTable*)zP4);
  70435. }
  70436. }
  70437. /*
  70438. ** Change the P4 operand of the most recently coded instruction
  70439. ** to the value defined by the arguments. This is a high-speed
  70440. ** version of sqlite3VdbeChangeP4().
  70441. **
  70442. ** The P4 operand must not have been previously defined. And the new
  70443. ** P4 must not be P4_INT32. Use sqlite3VdbeChangeP4() in either of
  70444. ** those cases.
  70445. */
  70446. SQLITE_PRIVATE void sqlite3VdbeAppendP4(Vdbe *p, void *pP4, int n){
  70447. VdbeOp *pOp;
  70448. assert( n!=P4_INT32 && n!=P4_VTAB );
  70449. assert( n<=0 );
  70450. if( p->db->mallocFailed ){
  70451. freeP4(p->db, n, pP4);
  70452. }else{
  70453. assert( pP4!=0 );
  70454. assert( p->nOp>0 );
  70455. pOp = &p->aOp[p->nOp-1];
  70456. assert( pOp->p4type==P4_NOTUSED );
  70457. pOp->p4type = n;
  70458. pOp->p4.p = pP4;
  70459. }
  70460. }
  70461. /*
  70462. ** Set the P4 on the most recently added opcode to the KeyInfo for the
  70463. ** index given.
  70464. */
  70465. SQLITE_PRIVATE void sqlite3VdbeSetP4KeyInfo(Parse *pParse, Index *pIdx){
  70466. Vdbe *v = pParse->pVdbe;
  70467. KeyInfo *pKeyInfo;
  70468. assert( v!=0 );
  70469. assert( pIdx!=0 );
  70470. pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pIdx);
  70471. if( pKeyInfo ) sqlite3VdbeAppendP4(v, pKeyInfo, P4_KEYINFO);
  70472. }
  70473. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  70474. /*
  70475. ** Change the comment on the most recently coded instruction. Or
  70476. ** insert a No-op and add the comment to that new instruction. This
  70477. ** makes the code easier to read during debugging. None of this happens
  70478. ** in a production build.
  70479. */
  70480. static void vdbeVComment(Vdbe *p, const char *zFormat, va_list ap){
  70481. assert( p->nOp>0 || p->aOp==0 );
  70482. assert( p->aOp==0 || p->aOp[p->nOp-1].zComment==0 || p->db->mallocFailed );
  70483. if( p->nOp ){
  70484. assert( p->aOp );
  70485. sqlite3DbFree(p->db, p->aOp[p->nOp-1].zComment);
  70486. p->aOp[p->nOp-1].zComment = sqlite3VMPrintf(p->db, zFormat, ap);
  70487. }
  70488. }
  70489. SQLITE_PRIVATE void sqlite3VdbeComment(Vdbe *p, const char *zFormat, ...){
  70490. va_list ap;
  70491. if( p ){
  70492. va_start(ap, zFormat);
  70493. vdbeVComment(p, zFormat, ap);
  70494. va_end(ap);
  70495. }
  70496. }
  70497. SQLITE_PRIVATE void sqlite3VdbeNoopComment(Vdbe *p, const char *zFormat, ...){
  70498. va_list ap;
  70499. if( p ){
  70500. sqlite3VdbeAddOp0(p, OP_Noop);
  70501. va_start(ap, zFormat);
  70502. vdbeVComment(p, zFormat, ap);
  70503. va_end(ap);
  70504. }
  70505. }
  70506. #endif /* NDEBUG */
  70507. #ifdef SQLITE_VDBE_COVERAGE
  70508. /*
  70509. ** Set the value if the iSrcLine field for the previously coded instruction.
  70510. */
  70511. SQLITE_PRIVATE void sqlite3VdbeSetLineNumber(Vdbe *v, int iLine){
  70512. sqlite3VdbeGetOp(v,-1)->iSrcLine = iLine;
  70513. }
  70514. #endif /* SQLITE_VDBE_COVERAGE */
  70515. /*
  70516. ** Return the opcode for a given address. If the address is -1, then
  70517. ** return the most recently inserted opcode.
  70518. **
  70519. ** If a memory allocation error has occurred prior to the calling of this
  70520. ** routine, then a pointer to a dummy VdbeOp will be returned. That opcode
  70521. ** is readable but not writable, though it is cast to a writable value.
  70522. ** The return of a dummy opcode allows the call to continue functioning
  70523. ** after an OOM fault without having to check to see if the return from
  70524. ** this routine is a valid pointer. But because the dummy.opcode is 0,
  70525. ** dummy will never be written to. This is verified by code inspection and
  70526. ** by running with Valgrind.
  70527. */
  70528. SQLITE_PRIVATE VdbeOp *sqlite3VdbeGetOp(Vdbe *p, int addr){
  70529. /* C89 specifies that the constant "dummy" will be initialized to all
  70530. ** zeros, which is correct. MSVC generates a warning, nevertheless. */
  70531. static VdbeOp dummy; /* Ignore the MSVC warning about no initializer */
  70532. assert( p->magic==VDBE_MAGIC_INIT );
  70533. if( addr<0 ){
  70534. addr = p->nOp - 1;
  70535. }
  70536. assert( (addr>=0 && addr<p->nOp) || p->db->mallocFailed );
  70537. if( p->db->mallocFailed ){
  70538. return (VdbeOp*)&dummy;
  70539. }else{
  70540. return &p->aOp[addr];
  70541. }
  70542. }
  70543. #if defined(SQLITE_ENABLE_EXPLAIN_COMMENTS)
  70544. /*
  70545. ** Return an integer value for one of the parameters to the opcode pOp
  70546. ** determined by character c.
  70547. */
  70548. static int translateP(char c, const Op *pOp){
  70549. if( c=='1' ) return pOp->p1;
  70550. if( c=='2' ) return pOp->p2;
  70551. if( c=='3' ) return pOp->p3;
  70552. if( c=='4' ) return pOp->p4.i;
  70553. return pOp->p5;
  70554. }
  70555. /*
  70556. ** Compute a string for the "comment" field of a VDBE opcode listing.
  70557. **
  70558. ** The Synopsis: field in comments in the vdbe.c source file gets converted
  70559. ** to an extra string that is appended to the sqlite3OpcodeName(). In the
  70560. ** absence of other comments, this synopsis becomes the comment on the opcode.
  70561. ** Some translation occurs:
  70562. **
  70563. ** "PX" -> "r[X]"
  70564. ** "PX@PY" -> "r[X..X+Y-1]" or "r[x]" if y is 0 or 1
  70565. ** "PX@PY+1" -> "r[X..X+Y]" or "r[x]" if y is 0
  70566. ** "PY..PY" -> "r[X..Y]" or "r[x]" if y<=x
  70567. */
  70568. static int displayComment(
  70569. const Op *pOp, /* The opcode to be commented */
  70570. const char *zP4, /* Previously obtained value for P4 */
  70571. char *zTemp, /* Write result here */
  70572. int nTemp /* Space available in zTemp[] */
  70573. ){
  70574. const char *zOpName;
  70575. const char *zSynopsis;
  70576. int nOpName;
  70577. int ii, jj;
  70578. char zAlt[50];
  70579. zOpName = sqlite3OpcodeName(pOp->opcode);
  70580. nOpName = sqlite3Strlen30(zOpName);
  70581. if( zOpName[nOpName+1] ){
  70582. int seenCom = 0;
  70583. char c;
  70584. zSynopsis = zOpName += nOpName + 1;
  70585. if( strncmp(zSynopsis,"IF ",3)==0 ){
  70586. if( pOp->p5 & SQLITE_STOREP2 ){
  70587. sqlite3_snprintf(sizeof(zAlt), zAlt, "r[P2] = (%s)", zSynopsis+3);
  70588. }else{
  70589. sqlite3_snprintf(sizeof(zAlt), zAlt, "if %s goto P2", zSynopsis+3);
  70590. }
  70591. zSynopsis = zAlt;
  70592. }
  70593. for(ii=jj=0; jj<nTemp-1 && (c = zSynopsis[ii])!=0; ii++){
  70594. if( c=='P' ){
  70595. c = zSynopsis[++ii];
  70596. if( c=='4' ){
  70597. sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", zP4);
  70598. }else if( c=='X' ){
  70599. sqlite3_snprintf(nTemp-jj, zTemp+jj, "%s", pOp->zComment);
  70600. seenCom = 1;
  70601. }else{
  70602. int v1 = translateP(c, pOp);
  70603. int v2;
  70604. sqlite3_snprintf(nTemp-jj, zTemp+jj, "%d", v1);
  70605. if( strncmp(zSynopsis+ii+1, "@P", 2)==0 ){
  70606. ii += 3;
  70607. jj += sqlite3Strlen30(zTemp+jj);
  70608. v2 = translateP(zSynopsis[ii], pOp);
  70609. if( strncmp(zSynopsis+ii+1,"+1",2)==0 ){
  70610. ii += 2;
  70611. v2++;
  70612. }
  70613. if( v2>1 ){
  70614. sqlite3_snprintf(nTemp-jj, zTemp+jj, "..%d", v1+v2-1);
  70615. }
  70616. }else if( strncmp(zSynopsis+ii+1, "..P3", 4)==0 && pOp->p3==0 ){
  70617. ii += 4;
  70618. }
  70619. }
  70620. jj += sqlite3Strlen30(zTemp+jj);
  70621. }else{
  70622. zTemp[jj++] = c;
  70623. }
  70624. }
  70625. if( !seenCom && jj<nTemp-5 && pOp->zComment ){
  70626. sqlite3_snprintf(nTemp-jj, zTemp+jj, "; %s", pOp->zComment);
  70627. jj += sqlite3Strlen30(zTemp+jj);
  70628. }
  70629. if( jj<nTemp ) zTemp[jj] = 0;
  70630. }else if( pOp->zComment ){
  70631. sqlite3_snprintf(nTemp, zTemp, "%s", pOp->zComment);
  70632. jj = sqlite3Strlen30(zTemp);
  70633. }else{
  70634. zTemp[0] = 0;
  70635. jj = 0;
  70636. }
  70637. return jj;
  70638. }
  70639. #endif /* SQLITE_DEBUG */
  70640. #if VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS)
  70641. /*
  70642. ** Translate the P4.pExpr value for an OP_CursorHint opcode into text
  70643. ** that can be displayed in the P4 column of EXPLAIN output.
  70644. */
  70645. static void displayP4Expr(StrAccum *p, Expr *pExpr){
  70646. const char *zOp = 0;
  70647. switch( pExpr->op ){
  70648. case TK_STRING:
  70649. sqlite3XPrintf(p, "%Q", pExpr->u.zToken);
  70650. break;
  70651. case TK_INTEGER:
  70652. sqlite3XPrintf(p, "%d", pExpr->u.iValue);
  70653. break;
  70654. case TK_NULL:
  70655. sqlite3XPrintf(p, "NULL");
  70656. break;
  70657. case TK_REGISTER: {
  70658. sqlite3XPrintf(p, "r[%d]", pExpr->iTable);
  70659. break;
  70660. }
  70661. case TK_COLUMN: {
  70662. if( pExpr->iColumn<0 ){
  70663. sqlite3XPrintf(p, "rowid");
  70664. }else{
  70665. sqlite3XPrintf(p, "c%d", (int)pExpr->iColumn);
  70666. }
  70667. break;
  70668. }
  70669. case TK_LT: zOp = "LT"; break;
  70670. case TK_LE: zOp = "LE"; break;
  70671. case TK_GT: zOp = "GT"; break;
  70672. case TK_GE: zOp = "GE"; break;
  70673. case TK_NE: zOp = "NE"; break;
  70674. case TK_EQ: zOp = "EQ"; break;
  70675. case TK_IS: zOp = "IS"; break;
  70676. case TK_ISNOT: zOp = "ISNOT"; break;
  70677. case TK_AND: zOp = "AND"; break;
  70678. case TK_OR: zOp = "OR"; break;
  70679. case TK_PLUS: zOp = "ADD"; break;
  70680. case TK_STAR: zOp = "MUL"; break;
  70681. case TK_MINUS: zOp = "SUB"; break;
  70682. case TK_REM: zOp = "REM"; break;
  70683. case TK_BITAND: zOp = "BITAND"; break;
  70684. case TK_BITOR: zOp = "BITOR"; break;
  70685. case TK_SLASH: zOp = "DIV"; break;
  70686. case TK_LSHIFT: zOp = "LSHIFT"; break;
  70687. case TK_RSHIFT: zOp = "RSHIFT"; break;
  70688. case TK_CONCAT: zOp = "CONCAT"; break;
  70689. case TK_UMINUS: zOp = "MINUS"; break;
  70690. case TK_UPLUS: zOp = "PLUS"; break;
  70691. case TK_BITNOT: zOp = "BITNOT"; break;
  70692. case TK_NOT: zOp = "NOT"; break;
  70693. case TK_ISNULL: zOp = "ISNULL"; break;
  70694. case TK_NOTNULL: zOp = "NOTNULL"; break;
  70695. default:
  70696. sqlite3XPrintf(p, "%s", "expr");
  70697. break;
  70698. }
  70699. if( zOp ){
  70700. sqlite3XPrintf(p, "%s(", zOp);
  70701. displayP4Expr(p, pExpr->pLeft);
  70702. if( pExpr->pRight ){
  70703. sqlite3StrAccumAppend(p, ",", 1);
  70704. displayP4Expr(p, pExpr->pRight);
  70705. }
  70706. sqlite3StrAccumAppend(p, ")", 1);
  70707. }
  70708. }
  70709. #endif /* VDBE_DISPLAY_P4 && defined(SQLITE_ENABLE_CURSOR_HINTS) */
  70710. #if VDBE_DISPLAY_P4
  70711. /*
  70712. ** Compute a string that describes the P4 parameter for an opcode.
  70713. ** Use zTemp for any required temporary buffer space.
  70714. */
  70715. static char *displayP4(Op *pOp, char *zTemp, int nTemp){
  70716. char *zP4 = zTemp;
  70717. StrAccum x;
  70718. assert( nTemp>=20 );
  70719. sqlite3StrAccumInit(&x, 0, zTemp, nTemp, 0);
  70720. switch( pOp->p4type ){
  70721. case P4_KEYINFO: {
  70722. int j;
  70723. KeyInfo *pKeyInfo = pOp->p4.pKeyInfo;
  70724. assert( pKeyInfo->aSortOrder!=0 );
  70725. sqlite3XPrintf(&x, "k(%d", pKeyInfo->nKeyField);
  70726. for(j=0; j<pKeyInfo->nKeyField; j++){
  70727. CollSeq *pColl = pKeyInfo->aColl[j];
  70728. const char *zColl = pColl ? pColl->zName : "";
  70729. if( strcmp(zColl, "BINARY")==0 ) zColl = "B";
  70730. sqlite3XPrintf(&x, ",%s%s", pKeyInfo->aSortOrder[j] ? "-" : "", zColl);
  70731. }
  70732. sqlite3StrAccumAppend(&x, ")", 1);
  70733. break;
  70734. }
  70735. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  70736. case P4_EXPR: {
  70737. displayP4Expr(&x, pOp->p4.pExpr);
  70738. break;
  70739. }
  70740. #endif
  70741. case P4_COLLSEQ: {
  70742. CollSeq *pColl = pOp->p4.pColl;
  70743. sqlite3XPrintf(&x, "(%.20s)", pColl->zName);
  70744. break;
  70745. }
  70746. case P4_FUNCDEF: {
  70747. FuncDef *pDef = pOp->p4.pFunc;
  70748. sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
  70749. break;
  70750. }
  70751. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  70752. case P4_FUNCCTX: {
  70753. FuncDef *pDef = pOp->p4.pCtx->pFunc;
  70754. sqlite3XPrintf(&x, "%s(%d)", pDef->zName, pDef->nArg);
  70755. break;
  70756. }
  70757. #endif
  70758. case P4_INT64: {
  70759. sqlite3XPrintf(&x, "%lld", *pOp->p4.pI64);
  70760. break;
  70761. }
  70762. case P4_INT32: {
  70763. sqlite3XPrintf(&x, "%d", pOp->p4.i);
  70764. break;
  70765. }
  70766. case P4_REAL: {
  70767. sqlite3XPrintf(&x, "%.16g", *pOp->p4.pReal);
  70768. break;
  70769. }
  70770. case P4_MEM: {
  70771. Mem *pMem = pOp->p4.pMem;
  70772. if( pMem->flags & MEM_Str ){
  70773. zP4 = pMem->z;
  70774. }else if( pMem->flags & MEM_Int ){
  70775. sqlite3XPrintf(&x, "%lld", pMem->u.i);
  70776. }else if( pMem->flags & MEM_Real ){
  70777. sqlite3XPrintf(&x, "%.16g", pMem->u.r);
  70778. }else if( pMem->flags & MEM_Null ){
  70779. zP4 = "NULL";
  70780. }else{
  70781. assert( pMem->flags & MEM_Blob );
  70782. zP4 = "(blob)";
  70783. }
  70784. break;
  70785. }
  70786. #ifndef SQLITE_OMIT_VIRTUALTABLE
  70787. case P4_VTAB: {
  70788. sqlite3_vtab *pVtab = pOp->p4.pVtab->pVtab;
  70789. sqlite3XPrintf(&x, "vtab:%p", pVtab);
  70790. break;
  70791. }
  70792. #endif
  70793. case P4_INTARRAY: {
  70794. int i;
  70795. int *ai = pOp->p4.ai;
  70796. int n = ai[0]; /* The first element of an INTARRAY is always the
  70797. ** count of the number of elements to follow */
  70798. for(i=1; i<=n; i++){
  70799. sqlite3XPrintf(&x, ",%d", ai[i]);
  70800. }
  70801. zTemp[0] = '[';
  70802. sqlite3StrAccumAppend(&x, "]", 1);
  70803. break;
  70804. }
  70805. case P4_SUBPROGRAM: {
  70806. sqlite3XPrintf(&x, "program");
  70807. break;
  70808. }
  70809. case P4_DYNBLOB:
  70810. case P4_ADVANCE: {
  70811. zTemp[0] = 0;
  70812. break;
  70813. }
  70814. case P4_TABLE: {
  70815. sqlite3XPrintf(&x, "%s", pOp->p4.pTab->zName);
  70816. break;
  70817. }
  70818. default: {
  70819. zP4 = pOp->p4.z;
  70820. if( zP4==0 ){
  70821. zP4 = zTemp;
  70822. zTemp[0] = 0;
  70823. }
  70824. }
  70825. }
  70826. sqlite3StrAccumFinish(&x);
  70827. assert( zP4!=0 );
  70828. return zP4;
  70829. }
  70830. #endif /* VDBE_DISPLAY_P4 */
  70831. /*
  70832. ** Declare to the Vdbe that the BTree object at db->aDb[i] is used.
  70833. **
  70834. ** The prepared statements need to know in advance the complete set of
  70835. ** attached databases that will be use. A mask of these databases
  70836. ** is maintained in p->btreeMask. The p->lockMask value is the subset of
  70837. ** p->btreeMask of databases that will require a lock.
  70838. */
  70839. SQLITE_PRIVATE void sqlite3VdbeUsesBtree(Vdbe *p, int i){
  70840. assert( i>=0 && i<p->db->nDb && i<(int)sizeof(yDbMask)*8 );
  70841. assert( i<(int)sizeof(p->btreeMask)*8 );
  70842. DbMaskSet(p->btreeMask, i);
  70843. if( i!=1 && sqlite3BtreeSharable(p->db->aDb[i].pBt) ){
  70844. DbMaskSet(p->lockMask, i);
  70845. }
  70846. }
  70847. #if !defined(SQLITE_OMIT_SHARED_CACHE)
  70848. /*
  70849. ** If SQLite is compiled to support shared-cache mode and to be threadsafe,
  70850. ** this routine obtains the mutex associated with each BtShared structure
  70851. ** that may be accessed by the VM passed as an argument. In doing so it also
  70852. ** sets the BtShared.db member of each of the BtShared structures, ensuring
  70853. ** that the correct busy-handler callback is invoked if required.
  70854. **
  70855. ** If SQLite is not threadsafe but does support shared-cache mode, then
  70856. ** sqlite3BtreeEnter() is invoked to set the BtShared.db variables
  70857. ** of all of BtShared structures accessible via the database handle
  70858. ** associated with the VM.
  70859. **
  70860. ** If SQLite is not threadsafe and does not support shared-cache mode, this
  70861. ** function is a no-op.
  70862. **
  70863. ** The p->btreeMask field is a bitmask of all btrees that the prepared
  70864. ** statement p will ever use. Let N be the number of bits in p->btreeMask
  70865. ** corresponding to btrees that use shared cache. Then the runtime of
  70866. ** this routine is N*N. But as N is rarely more than 1, this should not
  70867. ** be a problem.
  70868. */
  70869. SQLITE_PRIVATE void sqlite3VdbeEnter(Vdbe *p){
  70870. int i;
  70871. sqlite3 *db;
  70872. Db *aDb;
  70873. int nDb;
  70874. if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
  70875. db = p->db;
  70876. aDb = db->aDb;
  70877. nDb = db->nDb;
  70878. for(i=0; i<nDb; i++){
  70879. if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
  70880. sqlite3BtreeEnter(aDb[i].pBt);
  70881. }
  70882. }
  70883. }
  70884. #endif
  70885. #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE>0
  70886. /*
  70887. ** Unlock all of the btrees previously locked by a call to sqlite3VdbeEnter().
  70888. */
  70889. static SQLITE_NOINLINE void vdbeLeave(Vdbe *p){
  70890. int i;
  70891. sqlite3 *db;
  70892. Db *aDb;
  70893. int nDb;
  70894. db = p->db;
  70895. aDb = db->aDb;
  70896. nDb = db->nDb;
  70897. for(i=0; i<nDb; i++){
  70898. if( i!=1 && DbMaskTest(p->lockMask,i) && ALWAYS(aDb[i].pBt!=0) ){
  70899. sqlite3BtreeLeave(aDb[i].pBt);
  70900. }
  70901. }
  70902. }
  70903. SQLITE_PRIVATE void sqlite3VdbeLeave(Vdbe *p){
  70904. if( DbMaskAllZero(p->lockMask) ) return; /* The common case */
  70905. vdbeLeave(p);
  70906. }
  70907. #endif
  70908. #if defined(VDBE_PROFILE) || defined(SQLITE_DEBUG)
  70909. /*
  70910. ** Print a single opcode. This routine is used for debugging only.
  70911. */
  70912. SQLITE_PRIVATE void sqlite3VdbePrintOp(FILE *pOut, int pc, Op *pOp){
  70913. char *zP4;
  70914. char zPtr[50];
  70915. char zCom[100];
  70916. static const char *zFormat1 = "%4d %-13s %4d %4d %4d %-13s %.2X %s\n";
  70917. if( pOut==0 ) pOut = stdout;
  70918. zP4 = displayP4(pOp, zPtr, sizeof(zPtr));
  70919. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  70920. displayComment(pOp, zP4, zCom, sizeof(zCom));
  70921. #else
  70922. zCom[0] = 0;
  70923. #endif
  70924. /* NB: The sqlite3OpcodeName() function is implemented by code created
  70925. ** by the mkopcodeh.awk and mkopcodec.awk scripts which extract the
  70926. ** information from the vdbe.c source text */
  70927. fprintf(pOut, zFormat1, pc,
  70928. sqlite3OpcodeName(pOp->opcode), pOp->p1, pOp->p2, pOp->p3, zP4, pOp->p5,
  70929. zCom
  70930. );
  70931. fflush(pOut);
  70932. }
  70933. #endif
  70934. /*
  70935. ** Initialize an array of N Mem element.
  70936. */
  70937. static void initMemArray(Mem *p, int N, sqlite3 *db, u16 flags){
  70938. while( (N--)>0 ){
  70939. p->db = db;
  70940. p->flags = flags;
  70941. p->szMalloc = 0;
  70942. #ifdef SQLITE_DEBUG
  70943. p->pScopyFrom = 0;
  70944. #endif
  70945. p++;
  70946. }
  70947. }
  70948. /*
  70949. ** Release an array of N Mem elements
  70950. */
  70951. static void releaseMemArray(Mem *p, int N){
  70952. if( p && N ){
  70953. Mem *pEnd = &p[N];
  70954. sqlite3 *db = p->db;
  70955. if( db->pnBytesFreed ){
  70956. do{
  70957. if( p->szMalloc ) sqlite3DbFree(db, p->zMalloc);
  70958. }while( (++p)<pEnd );
  70959. return;
  70960. }
  70961. do{
  70962. assert( (&p[1])==pEnd || p[0].db==p[1].db );
  70963. assert( sqlite3VdbeCheckMemInvariants(p) );
  70964. /* This block is really an inlined version of sqlite3VdbeMemRelease()
  70965. ** that takes advantage of the fact that the memory cell value is
  70966. ** being set to NULL after releasing any dynamic resources.
  70967. **
  70968. ** The justification for duplicating code is that according to
  70969. ** callgrind, this causes a certain test case to hit the CPU 4.7
  70970. ** percent less (x86 linux, gcc version 4.1.2, -O6) than if
  70971. ** sqlite3MemRelease() were called from here. With -O2, this jumps
  70972. ** to 6.6 percent. The test case is inserting 1000 rows into a table
  70973. ** with no indexes using a single prepared INSERT statement, bind()
  70974. ** and reset(). Inserts are grouped into a transaction.
  70975. */
  70976. testcase( p->flags & MEM_Agg );
  70977. testcase( p->flags & MEM_Dyn );
  70978. testcase( p->flags & MEM_Frame );
  70979. testcase( p->flags & MEM_RowSet );
  70980. if( p->flags&(MEM_Agg|MEM_Dyn|MEM_Frame|MEM_RowSet) ){
  70981. sqlite3VdbeMemRelease(p);
  70982. }else if( p->szMalloc ){
  70983. sqlite3DbFreeNN(db, p->zMalloc);
  70984. p->szMalloc = 0;
  70985. }
  70986. p->flags = MEM_Undefined;
  70987. }while( (++p)<pEnd );
  70988. }
  70989. }
  70990. /*
  70991. ** Delete a VdbeFrame object and its contents. VdbeFrame objects are
  70992. ** allocated by the OP_Program opcode in sqlite3VdbeExec().
  70993. */
  70994. SQLITE_PRIVATE void sqlite3VdbeFrameDelete(VdbeFrame *p){
  70995. int i;
  70996. Mem *aMem = VdbeFrameMem(p);
  70997. VdbeCursor **apCsr = (VdbeCursor **)&aMem[p->nChildMem];
  70998. for(i=0; i<p->nChildCsr; i++){
  70999. sqlite3VdbeFreeCursor(p->v, apCsr[i]);
  71000. }
  71001. releaseMemArray(aMem, p->nChildMem);
  71002. sqlite3VdbeDeleteAuxData(p->v->db, &p->pAuxData, -1, 0);
  71003. sqlite3DbFree(p->v->db, p);
  71004. }
  71005. #ifndef SQLITE_OMIT_EXPLAIN
  71006. /*
  71007. ** Give a listing of the program in the virtual machine.
  71008. **
  71009. ** The interface is the same as sqlite3VdbeExec(). But instead of
  71010. ** running the code, it invokes the callback once for each instruction.
  71011. ** This feature is used to implement "EXPLAIN".
  71012. **
  71013. ** When p->explain==1, each instruction is listed. When
  71014. ** p->explain==2, only OP_Explain instructions are listed and these
  71015. ** are shown in a different format. p->explain==2 is used to implement
  71016. ** EXPLAIN QUERY PLAN.
  71017. **
  71018. ** When p->explain==1, first the main program is listed, then each of
  71019. ** the trigger subprograms are listed one by one.
  71020. */
  71021. SQLITE_PRIVATE int sqlite3VdbeList(
  71022. Vdbe *p /* The VDBE */
  71023. ){
  71024. int nRow; /* Stop when row count reaches this */
  71025. int nSub = 0; /* Number of sub-vdbes seen so far */
  71026. SubProgram **apSub = 0; /* Array of sub-vdbes */
  71027. Mem *pSub = 0; /* Memory cell hold array of subprogs */
  71028. sqlite3 *db = p->db; /* The database connection */
  71029. int i; /* Loop counter */
  71030. int rc = SQLITE_OK; /* Return code */
  71031. Mem *pMem = &p->aMem[1]; /* First Mem of result set */
  71032. int bListSubprogs = (p->explain==1 || (db->flags & SQLITE_TriggerEQP)!=0);
  71033. Op *pOp = 0;
  71034. assert( p->explain );
  71035. assert( p->magic==VDBE_MAGIC_RUN );
  71036. assert( p->rc==SQLITE_OK || p->rc==SQLITE_BUSY || p->rc==SQLITE_NOMEM );
  71037. /* Even though this opcode does not use dynamic strings for
  71038. ** the result, result columns may become dynamic if the user calls
  71039. ** sqlite3_column_text16(), causing a translation to UTF-16 encoding.
  71040. */
  71041. releaseMemArray(pMem, 8);
  71042. p->pResultSet = 0;
  71043. if( p->rc==SQLITE_NOMEM ){
  71044. /* This happens if a malloc() inside a call to sqlite3_column_text() or
  71045. ** sqlite3_column_text16() failed. */
  71046. sqlite3OomFault(db);
  71047. return SQLITE_ERROR;
  71048. }
  71049. /* When the number of output rows reaches nRow, that means the
  71050. ** listing has finished and sqlite3_step() should return SQLITE_DONE.
  71051. ** nRow is the sum of the number of rows in the main program, plus
  71052. ** the sum of the number of rows in all trigger subprograms encountered
  71053. ** so far. The nRow value will increase as new trigger subprograms are
  71054. ** encountered, but p->pc will eventually catch up to nRow.
  71055. */
  71056. nRow = p->nOp;
  71057. if( bListSubprogs ){
  71058. /* The first 8 memory cells are used for the result set. So we will
  71059. ** commandeer the 9th cell to use as storage for an array of pointers
  71060. ** to trigger subprograms. The VDBE is guaranteed to have at least 9
  71061. ** cells. */
  71062. assert( p->nMem>9 );
  71063. pSub = &p->aMem[9];
  71064. if( pSub->flags&MEM_Blob ){
  71065. /* On the first call to sqlite3_step(), pSub will hold a NULL. It is
  71066. ** initialized to a BLOB by the P4_SUBPROGRAM processing logic below */
  71067. nSub = pSub->n/sizeof(Vdbe*);
  71068. apSub = (SubProgram **)pSub->z;
  71069. }
  71070. for(i=0; i<nSub; i++){
  71071. nRow += apSub[i]->nOp;
  71072. }
  71073. }
  71074. do{
  71075. i = p->pc++;
  71076. if( i>=nRow ){
  71077. p->rc = SQLITE_OK;
  71078. rc = SQLITE_DONE;
  71079. break;
  71080. }
  71081. if( i<p->nOp ){
  71082. /* The output line number is small enough that we are still in the
  71083. ** main program. */
  71084. pOp = &p->aOp[i];
  71085. }else{
  71086. /* We are currently listing subprograms. Figure out which one and
  71087. ** pick up the appropriate opcode. */
  71088. int j;
  71089. i -= p->nOp;
  71090. for(j=0; i>=apSub[j]->nOp; j++){
  71091. i -= apSub[j]->nOp;
  71092. }
  71093. pOp = &apSub[j]->aOp[i];
  71094. }
  71095. /* When an OP_Program opcode is encounter (the only opcode that has
  71096. ** a P4_SUBPROGRAM argument), expand the size of the array of subprograms
  71097. ** kept in p->aMem[9].z to hold the new program - assuming this subprogram
  71098. ** has not already been seen.
  71099. */
  71100. if( bListSubprogs && pOp->p4type==P4_SUBPROGRAM ){
  71101. int nByte = (nSub+1)*sizeof(SubProgram*);
  71102. int j;
  71103. for(j=0; j<nSub; j++){
  71104. if( apSub[j]==pOp->p4.pProgram ) break;
  71105. }
  71106. if( j==nSub ){
  71107. p->rc = sqlite3VdbeMemGrow(pSub, nByte, nSub!=0);
  71108. if( p->rc!=SQLITE_OK ){
  71109. rc = SQLITE_ERROR;
  71110. break;
  71111. }
  71112. apSub = (SubProgram **)pSub->z;
  71113. apSub[nSub++] = pOp->p4.pProgram;
  71114. pSub->flags |= MEM_Blob;
  71115. pSub->n = nSub*sizeof(SubProgram*);
  71116. nRow += pOp->p4.pProgram->nOp;
  71117. }
  71118. }
  71119. }while( p->explain==2 && pOp->opcode!=OP_Explain );
  71120. if( rc==SQLITE_OK ){
  71121. if( db->u1.isInterrupted ){
  71122. p->rc = SQLITE_INTERRUPT;
  71123. rc = SQLITE_ERROR;
  71124. sqlite3VdbeError(p, sqlite3ErrStr(p->rc));
  71125. }else{
  71126. char *zP4;
  71127. if( p->explain==1 ){
  71128. pMem->flags = MEM_Int;
  71129. pMem->u.i = i; /* Program counter */
  71130. pMem++;
  71131. pMem->flags = MEM_Static|MEM_Str|MEM_Term;
  71132. pMem->z = (char*)sqlite3OpcodeName(pOp->opcode); /* Opcode */
  71133. assert( pMem->z!=0 );
  71134. pMem->n = sqlite3Strlen30(pMem->z);
  71135. pMem->enc = SQLITE_UTF8;
  71136. pMem++;
  71137. }
  71138. pMem->flags = MEM_Int;
  71139. pMem->u.i = pOp->p1; /* P1 */
  71140. pMem++;
  71141. pMem->flags = MEM_Int;
  71142. pMem->u.i = pOp->p2; /* P2 */
  71143. pMem++;
  71144. pMem->flags = MEM_Int;
  71145. pMem->u.i = pOp->p3; /* P3 */
  71146. pMem++;
  71147. if( sqlite3VdbeMemClearAndResize(pMem, 100) ){ /* P4 */
  71148. assert( p->db->mallocFailed );
  71149. return SQLITE_ERROR;
  71150. }
  71151. pMem->flags = MEM_Str|MEM_Term;
  71152. zP4 = displayP4(pOp, pMem->z, pMem->szMalloc);
  71153. if( zP4!=pMem->z ){
  71154. pMem->n = 0;
  71155. sqlite3VdbeMemSetStr(pMem, zP4, -1, SQLITE_UTF8, 0);
  71156. }else{
  71157. assert( pMem->z!=0 );
  71158. pMem->n = sqlite3Strlen30(pMem->z);
  71159. pMem->enc = SQLITE_UTF8;
  71160. }
  71161. pMem++;
  71162. if( p->explain==1 ){
  71163. if( sqlite3VdbeMemClearAndResize(pMem, 4) ){
  71164. assert( p->db->mallocFailed );
  71165. return SQLITE_ERROR;
  71166. }
  71167. pMem->flags = MEM_Str|MEM_Term;
  71168. pMem->n = 2;
  71169. sqlite3_snprintf(3, pMem->z, "%.2x", pOp->p5); /* P5 */
  71170. pMem->enc = SQLITE_UTF8;
  71171. pMem++;
  71172. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  71173. if( sqlite3VdbeMemClearAndResize(pMem, 500) ){
  71174. assert( p->db->mallocFailed );
  71175. return SQLITE_ERROR;
  71176. }
  71177. pMem->flags = MEM_Str|MEM_Term;
  71178. pMem->n = displayComment(pOp, zP4, pMem->z, 500);
  71179. pMem->enc = SQLITE_UTF8;
  71180. #else
  71181. pMem->flags = MEM_Null; /* Comment */
  71182. #endif
  71183. }
  71184. p->nResColumn = 8 - 4*(p->explain-1);
  71185. p->pResultSet = &p->aMem[1];
  71186. p->rc = SQLITE_OK;
  71187. rc = SQLITE_ROW;
  71188. }
  71189. }
  71190. return rc;
  71191. }
  71192. #endif /* SQLITE_OMIT_EXPLAIN */
  71193. #ifdef SQLITE_DEBUG
  71194. /*
  71195. ** Print the SQL that was used to generate a VDBE program.
  71196. */
  71197. SQLITE_PRIVATE void sqlite3VdbePrintSql(Vdbe *p){
  71198. const char *z = 0;
  71199. if( p->zSql ){
  71200. z = p->zSql;
  71201. }else if( p->nOp>=1 ){
  71202. const VdbeOp *pOp = &p->aOp[0];
  71203. if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
  71204. z = pOp->p4.z;
  71205. while( sqlite3Isspace(*z) ) z++;
  71206. }
  71207. }
  71208. if( z ) printf("SQL: [%s]\n", z);
  71209. }
  71210. #endif
  71211. #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
  71212. /*
  71213. ** Print an IOTRACE message showing SQL content.
  71214. */
  71215. SQLITE_PRIVATE void sqlite3VdbeIOTraceSql(Vdbe *p){
  71216. int nOp = p->nOp;
  71217. VdbeOp *pOp;
  71218. if( sqlite3IoTrace==0 ) return;
  71219. if( nOp<1 ) return;
  71220. pOp = &p->aOp[0];
  71221. if( pOp->opcode==OP_Init && pOp->p4.z!=0 ){
  71222. int i, j;
  71223. char z[1000];
  71224. sqlite3_snprintf(sizeof(z), z, "%s", pOp->p4.z);
  71225. for(i=0; sqlite3Isspace(z[i]); i++){}
  71226. for(j=0; z[i]; i++){
  71227. if( sqlite3Isspace(z[i]) ){
  71228. if( z[i-1]!=' ' ){
  71229. z[j++] = ' ';
  71230. }
  71231. }else{
  71232. z[j++] = z[i];
  71233. }
  71234. }
  71235. z[j] = 0;
  71236. sqlite3IoTrace("SQL %s\n", z);
  71237. }
  71238. }
  71239. #endif /* !SQLITE_OMIT_TRACE && SQLITE_ENABLE_IOTRACE */
  71240. /* An instance of this object describes bulk memory available for use
  71241. ** by subcomponents of a prepared statement. Space is allocated out
  71242. ** of a ReusableSpace object by the allocSpace() routine below.
  71243. */
  71244. struct ReusableSpace {
  71245. u8 *pSpace; /* Available memory */
  71246. int nFree; /* Bytes of available memory */
  71247. int nNeeded; /* Total bytes that could not be allocated */
  71248. };
  71249. /* Try to allocate nByte bytes of 8-byte aligned bulk memory for pBuf
  71250. ** from the ReusableSpace object. Return a pointer to the allocated
  71251. ** memory on success. If insufficient memory is available in the
  71252. ** ReusableSpace object, increase the ReusableSpace.nNeeded
  71253. ** value by the amount needed and return NULL.
  71254. **
  71255. ** If pBuf is not initially NULL, that means that the memory has already
  71256. ** been allocated by a prior call to this routine, so just return a copy
  71257. ** of pBuf and leave ReusableSpace unchanged.
  71258. **
  71259. ** This allocator is employed to repurpose unused slots at the end of the
  71260. ** opcode array of prepared state for other memory needs of the prepared
  71261. ** statement.
  71262. */
  71263. static void *allocSpace(
  71264. struct ReusableSpace *p, /* Bulk memory available for allocation */
  71265. void *pBuf, /* Pointer to a prior allocation */
  71266. int nByte /* Bytes of memory needed */
  71267. ){
  71268. assert( EIGHT_BYTE_ALIGNMENT(p->pSpace) );
  71269. if( pBuf==0 ){
  71270. nByte = ROUND8(nByte);
  71271. if( nByte <= p->nFree ){
  71272. p->nFree -= nByte;
  71273. pBuf = &p->pSpace[p->nFree];
  71274. }else{
  71275. p->nNeeded += nByte;
  71276. }
  71277. }
  71278. assert( EIGHT_BYTE_ALIGNMENT(pBuf) );
  71279. return pBuf;
  71280. }
  71281. /*
  71282. ** Rewind the VDBE back to the beginning in preparation for
  71283. ** running it.
  71284. */
  71285. SQLITE_PRIVATE void sqlite3VdbeRewind(Vdbe *p){
  71286. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  71287. int i;
  71288. #endif
  71289. assert( p!=0 );
  71290. assert( p->magic==VDBE_MAGIC_INIT || p->magic==VDBE_MAGIC_RESET );
  71291. /* There should be at least one opcode.
  71292. */
  71293. assert( p->nOp>0 );
  71294. /* Set the magic to VDBE_MAGIC_RUN sooner rather than later. */
  71295. p->magic = VDBE_MAGIC_RUN;
  71296. #ifdef SQLITE_DEBUG
  71297. for(i=0; i<p->nMem; i++){
  71298. assert( p->aMem[i].db==p->db );
  71299. }
  71300. #endif
  71301. p->pc = -1;
  71302. p->rc = SQLITE_OK;
  71303. p->errorAction = OE_Abort;
  71304. p->nChange = 0;
  71305. p->cacheCtr = 1;
  71306. p->minWriteFileFormat = 255;
  71307. p->iStatement = 0;
  71308. p->nFkConstraint = 0;
  71309. #ifdef VDBE_PROFILE
  71310. for(i=0; i<p->nOp; i++){
  71311. p->aOp[i].cnt = 0;
  71312. p->aOp[i].cycles = 0;
  71313. }
  71314. #endif
  71315. }
  71316. /*
  71317. ** Prepare a virtual machine for execution for the first time after
  71318. ** creating the virtual machine. This involves things such
  71319. ** as allocating registers and initializing the program counter.
  71320. ** After the VDBE has be prepped, it can be executed by one or more
  71321. ** calls to sqlite3VdbeExec().
  71322. **
  71323. ** This function may be called exactly once on each virtual machine.
  71324. ** After this routine is called the VM has been "packaged" and is ready
  71325. ** to run. After this routine is called, further calls to
  71326. ** sqlite3VdbeAddOp() functions are prohibited. This routine disconnects
  71327. ** the Vdbe from the Parse object that helped generate it so that the
  71328. ** the Vdbe becomes an independent entity and the Parse object can be
  71329. ** destroyed.
  71330. **
  71331. ** Use the sqlite3VdbeRewind() procedure to restore a virtual machine back
  71332. ** to its initial state after it has been run.
  71333. */
  71334. SQLITE_PRIVATE void sqlite3VdbeMakeReady(
  71335. Vdbe *p, /* The VDBE */
  71336. Parse *pParse /* Parsing context */
  71337. ){
  71338. sqlite3 *db; /* The database connection */
  71339. int nVar; /* Number of parameters */
  71340. int nMem; /* Number of VM memory registers */
  71341. int nCursor; /* Number of cursors required */
  71342. int nArg; /* Number of arguments in subprograms */
  71343. int n; /* Loop counter */
  71344. struct ReusableSpace x; /* Reusable bulk memory */
  71345. assert( p!=0 );
  71346. assert( p->nOp>0 );
  71347. assert( pParse!=0 );
  71348. assert( p->magic==VDBE_MAGIC_INIT );
  71349. assert( pParse==p->pParse );
  71350. db = p->db;
  71351. assert( db->mallocFailed==0 );
  71352. nVar = pParse->nVar;
  71353. nMem = pParse->nMem;
  71354. nCursor = pParse->nTab;
  71355. nArg = pParse->nMaxArg;
  71356. /* Each cursor uses a memory cell. The first cursor (cursor 0) can
  71357. ** use aMem[0] which is not otherwise used by the VDBE program. Allocate
  71358. ** space at the end of aMem[] for cursors 1 and greater.
  71359. ** See also: allocateCursor().
  71360. */
  71361. nMem += nCursor;
  71362. if( nCursor==0 && nMem>0 ) nMem++; /* Space for aMem[0] even if not used */
  71363. /* Figure out how much reusable memory is available at the end of the
  71364. ** opcode array. This extra memory will be reallocated for other elements
  71365. ** of the prepared statement.
  71366. */
  71367. n = ROUND8(sizeof(Op)*p->nOp); /* Bytes of opcode memory used */
  71368. x.pSpace = &((u8*)p->aOp)[n]; /* Unused opcode memory */
  71369. assert( EIGHT_BYTE_ALIGNMENT(x.pSpace) );
  71370. x.nFree = ROUNDDOWN8(pParse->szOpAlloc - n); /* Bytes of unused memory */
  71371. assert( x.nFree>=0 );
  71372. assert( EIGHT_BYTE_ALIGNMENT(&x.pSpace[x.nFree]) );
  71373. resolveP2Values(p, &nArg);
  71374. p->usesStmtJournal = (u8)(pParse->isMultiWrite && pParse->mayAbort);
  71375. if( pParse->explain && nMem<10 ){
  71376. nMem = 10;
  71377. }
  71378. p->expired = 0;
  71379. /* Memory for registers, parameters, cursor, etc, is allocated in one or two
  71380. ** passes. On the first pass, we try to reuse unused memory at the
  71381. ** end of the opcode array. If we are unable to satisfy all memory
  71382. ** requirements by reusing the opcode array tail, then the second
  71383. ** pass will fill in the remainder using a fresh memory allocation.
  71384. **
  71385. ** This two-pass approach that reuses as much memory as possible from
  71386. ** the leftover memory at the end of the opcode array. This can significantly
  71387. ** reduce the amount of memory held by a prepared statement.
  71388. */
  71389. do {
  71390. x.nNeeded = 0;
  71391. p->aMem = allocSpace(&x, p->aMem, nMem*sizeof(Mem));
  71392. p->aVar = allocSpace(&x, p->aVar, nVar*sizeof(Mem));
  71393. p->apArg = allocSpace(&x, p->apArg, nArg*sizeof(Mem*));
  71394. p->apCsr = allocSpace(&x, p->apCsr, nCursor*sizeof(VdbeCursor*));
  71395. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  71396. p->anExec = allocSpace(&x, p->anExec, p->nOp*sizeof(i64));
  71397. #endif
  71398. if( x.nNeeded==0 ) break;
  71399. x.pSpace = p->pFree = sqlite3DbMallocRawNN(db, x.nNeeded);
  71400. x.nFree = x.nNeeded;
  71401. }while( !db->mallocFailed );
  71402. p->pVList = pParse->pVList;
  71403. pParse->pVList = 0;
  71404. p->explain = pParse->explain;
  71405. if( db->mallocFailed ){
  71406. p->nVar = 0;
  71407. p->nCursor = 0;
  71408. p->nMem = 0;
  71409. }else{
  71410. p->nCursor = nCursor;
  71411. p->nVar = (ynVar)nVar;
  71412. initMemArray(p->aVar, nVar, db, MEM_Null);
  71413. p->nMem = nMem;
  71414. initMemArray(p->aMem, nMem, db, MEM_Undefined);
  71415. memset(p->apCsr, 0, nCursor*sizeof(VdbeCursor*));
  71416. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  71417. memset(p->anExec, 0, p->nOp*sizeof(i64));
  71418. #endif
  71419. }
  71420. sqlite3VdbeRewind(p);
  71421. }
  71422. /*
  71423. ** Close a VDBE cursor and release all the resources that cursor
  71424. ** happens to hold.
  71425. */
  71426. SQLITE_PRIVATE void sqlite3VdbeFreeCursor(Vdbe *p, VdbeCursor *pCx){
  71427. if( pCx==0 ){
  71428. return;
  71429. }
  71430. assert( pCx->pBtx==0 || pCx->eCurType==CURTYPE_BTREE );
  71431. switch( pCx->eCurType ){
  71432. case CURTYPE_SORTER: {
  71433. sqlite3VdbeSorterClose(p->db, pCx);
  71434. break;
  71435. }
  71436. case CURTYPE_BTREE: {
  71437. if( pCx->isEphemeral ){
  71438. if( pCx->pBtx ) sqlite3BtreeClose(pCx->pBtx);
  71439. /* The pCx->pCursor will be close automatically, if it exists, by
  71440. ** the call above. */
  71441. }else{
  71442. assert( pCx->uc.pCursor!=0 );
  71443. sqlite3BtreeCloseCursor(pCx->uc.pCursor);
  71444. }
  71445. break;
  71446. }
  71447. #ifndef SQLITE_OMIT_VIRTUALTABLE
  71448. case CURTYPE_VTAB: {
  71449. sqlite3_vtab_cursor *pVCur = pCx->uc.pVCur;
  71450. const sqlite3_module *pModule = pVCur->pVtab->pModule;
  71451. assert( pVCur->pVtab->nRef>0 );
  71452. pVCur->pVtab->nRef--;
  71453. pModule->xClose(pVCur);
  71454. break;
  71455. }
  71456. #endif
  71457. }
  71458. }
  71459. /*
  71460. ** Close all cursors in the current frame.
  71461. */
  71462. static void closeCursorsInFrame(Vdbe *p){
  71463. if( p->apCsr ){
  71464. int i;
  71465. for(i=0; i<p->nCursor; i++){
  71466. VdbeCursor *pC = p->apCsr[i];
  71467. if( pC ){
  71468. sqlite3VdbeFreeCursor(p, pC);
  71469. p->apCsr[i] = 0;
  71470. }
  71471. }
  71472. }
  71473. }
  71474. /*
  71475. ** Copy the values stored in the VdbeFrame structure to its Vdbe. This
  71476. ** is used, for example, when a trigger sub-program is halted to restore
  71477. ** control to the main program.
  71478. */
  71479. SQLITE_PRIVATE int sqlite3VdbeFrameRestore(VdbeFrame *pFrame){
  71480. Vdbe *v = pFrame->v;
  71481. closeCursorsInFrame(v);
  71482. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  71483. v->anExec = pFrame->anExec;
  71484. #endif
  71485. v->aOp = pFrame->aOp;
  71486. v->nOp = pFrame->nOp;
  71487. v->aMem = pFrame->aMem;
  71488. v->nMem = pFrame->nMem;
  71489. v->apCsr = pFrame->apCsr;
  71490. v->nCursor = pFrame->nCursor;
  71491. v->db->lastRowid = pFrame->lastRowid;
  71492. v->nChange = pFrame->nChange;
  71493. v->db->nChange = pFrame->nDbChange;
  71494. sqlite3VdbeDeleteAuxData(v->db, &v->pAuxData, -1, 0);
  71495. v->pAuxData = pFrame->pAuxData;
  71496. pFrame->pAuxData = 0;
  71497. return pFrame->pc;
  71498. }
  71499. /*
  71500. ** Close all cursors.
  71501. **
  71502. ** Also release any dynamic memory held by the VM in the Vdbe.aMem memory
  71503. ** cell array. This is necessary as the memory cell array may contain
  71504. ** pointers to VdbeFrame objects, which may in turn contain pointers to
  71505. ** open cursors.
  71506. */
  71507. static void closeAllCursors(Vdbe *p){
  71508. if( p->pFrame ){
  71509. VdbeFrame *pFrame;
  71510. for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
  71511. sqlite3VdbeFrameRestore(pFrame);
  71512. p->pFrame = 0;
  71513. p->nFrame = 0;
  71514. }
  71515. assert( p->nFrame==0 );
  71516. closeCursorsInFrame(p);
  71517. if( p->aMem ){
  71518. releaseMemArray(p->aMem, p->nMem);
  71519. }
  71520. while( p->pDelFrame ){
  71521. VdbeFrame *pDel = p->pDelFrame;
  71522. p->pDelFrame = pDel->pParent;
  71523. sqlite3VdbeFrameDelete(pDel);
  71524. }
  71525. /* Delete any auxdata allocations made by the VM */
  71526. if( p->pAuxData ) sqlite3VdbeDeleteAuxData(p->db, &p->pAuxData, -1, 0);
  71527. assert( p->pAuxData==0 );
  71528. }
  71529. /*
  71530. ** Set the number of result columns that will be returned by this SQL
  71531. ** statement. This is now set at compile time, rather than during
  71532. ** execution of the vdbe program so that sqlite3_column_count() can
  71533. ** be called on an SQL statement before sqlite3_step().
  71534. */
  71535. SQLITE_PRIVATE void sqlite3VdbeSetNumCols(Vdbe *p, int nResColumn){
  71536. int n;
  71537. sqlite3 *db = p->db;
  71538. if( p->nResColumn ){
  71539. releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
  71540. sqlite3DbFree(db, p->aColName);
  71541. }
  71542. n = nResColumn*COLNAME_N;
  71543. p->nResColumn = (u16)nResColumn;
  71544. p->aColName = (Mem*)sqlite3DbMallocRawNN(db, sizeof(Mem)*n );
  71545. if( p->aColName==0 ) return;
  71546. initMemArray(p->aColName, n, db, MEM_Null);
  71547. }
  71548. /*
  71549. ** Set the name of the idx'th column to be returned by the SQL statement.
  71550. ** zName must be a pointer to a nul terminated string.
  71551. **
  71552. ** This call must be made after a call to sqlite3VdbeSetNumCols().
  71553. **
  71554. ** The final parameter, xDel, must be one of SQLITE_DYNAMIC, SQLITE_STATIC
  71555. ** or SQLITE_TRANSIENT. If it is SQLITE_DYNAMIC, then the buffer pointed
  71556. ** to by zName will be freed by sqlite3DbFree() when the vdbe is destroyed.
  71557. */
  71558. SQLITE_PRIVATE int sqlite3VdbeSetColName(
  71559. Vdbe *p, /* Vdbe being configured */
  71560. int idx, /* Index of column zName applies to */
  71561. int var, /* One of the COLNAME_* constants */
  71562. const char *zName, /* Pointer to buffer containing name */
  71563. void (*xDel)(void*) /* Memory management strategy for zName */
  71564. ){
  71565. int rc;
  71566. Mem *pColName;
  71567. assert( idx<p->nResColumn );
  71568. assert( var<COLNAME_N );
  71569. if( p->db->mallocFailed ){
  71570. assert( !zName || xDel!=SQLITE_DYNAMIC );
  71571. return SQLITE_NOMEM_BKPT;
  71572. }
  71573. assert( p->aColName!=0 );
  71574. pColName = &(p->aColName[idx+var*p->nResColumn]);
  71575. rc = sqlite3VdbeMemSetStr(pColName, zName, -1, SQLITE_UTF8, xDel);
  71576. assert( rc!=0 || !zName || (pColName->flags&MEM_Term)!=0 );
  71577. return rc;
  71578. }
  71579. /*
  71580. ** A read or write transaction may or may not be active on database handle
  71581. ** db. If a transaction is active, commit it. If there is a
  71582. ** write-transaction spanning more than one database file, this routine
  71583. ** takes care of the master journal trickery.
  71584. */
  71585. static int vdbeCommit(sqlite3 *db, Vdbe *p){
  71586. int i;
  71587. int nTrans = 0; /* Number of databases with an active write-transaction
  71588. ** that are candidates for a two-phase commit using a
  71589. ** master-journal */
  71590. int rc = SQLITE_OK;
  71591. int needXcommit = 0;
  71592. #ifdef SQLITE_OMIT_VIRTUALTABLE
  71593. /* With this option, sqlite3VtabSync() is defined to be simply
  71594. ** SQLITE_OK so p is not used.
  71595. */
  71596. UNUSED_PARAMETER(p);
  71597. #endif
  71598. /* Before doing anything else, call the xSync() callback for any
  71599. ** virtual module tables written in this transaction. This has to
  71600. ** be done before determining whether a master journal file is
  71601. ** required, as an xSync() callback may add an attached database
  71602. ** to the transaction.
  71603. */
  71604. rc = sqlite3VtabSync(db, p);
  71605. /* This loop determines (a) if the commit hook should be invoked and
  71606. ** (b) how many database files have open write transactions, not
  71607. ** including the temp database. (b) is important because if more than
  71608. ** one database file has an open write transaction, a master journal
  71609. ** file is required for an atomic commit.
  71610. */
  71611. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  71612. Btree *pBt = db->aDb[i].pBt;
  71613. if( sqlite3BtreeIsInTrans(pBt) ){
  71614. /* Whether or not a database might need a master journal depends upon
  71615. ** its journal mode (among other things). This matrix determines which
  71616. ** journal modes use a master journal and which do not */
  71617. static const u8 aMJNeeded[] = {
  71618. /* DELETE */ 1,
  71619. /* PERSIST */ 1,
  71620. /* OFF */ 0,
  71621. /* TRUNCATE */ 1,
  71622. /* MEMORY */ 0,
  71623. /* WAL */ 0
  71624. };
  71625. Pager *pPager; /* Pager associated with pBt */
  71626. needXcommit = 1;
  71627. sqlite3BtreeEnter(pBt);
  71628. pPager = sqlite3BtreePager(pBt);
  71629. if( db->aDb[i].safety_level!=PAGER_SYNCHRONOUS_OFF
  71630. && aMJNeeded[sqlite3PagerGetJournalMode(pPager)]
  71631. && sqlite3PagerIsMemdb(pPager)==0
  71632. ){
  71633. assert( i!=1 );
  71634. nTrans++;
  71635. }
  71636. rc = sqlite3PagerExclusiveLock(pPager);
  71637. sqlite3BtreeLeave(pBt);
  71638. }
  71639. }
  71640. if( rc!=SQLITE_OK ){
  71641. return rc;
  71642. }
  71643. /* If there are any write-transactions at all, invoke the commit hook */
  71644. if( needXcommit && db->xCommitCallback ){
  71645. rc = db->xCommitCallback(db->pCommitArg);
  71646. if( rc ){
  71647. return SQLITE_CONSTRAINT_COMMITHOOK;
  71648. }
  71649. }
  71650. /* The simple case - no more than one database file (not counting the
  71651. ** TEMP database) has a transaction active. There is no need for the
  71652. ** master-journal.
  71653. **
  71654. ** If the return value of sqlite3BtreeGetFilename() is a zero length
  71655. ** string, it means the main database is :memory: or a temp file. In
  71656. ** that case we do not support atomic multi-file commits, so use the
  71657. ** simple case then too.
  71658. */
  71659. if( 0==sqlite3Strlen30(sqlite3BtreeGetFilename(db->aDb[0].pBt))
  71660. || nTrans<=1
  71661. ){
  71662. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  71663. Btree *pBt = db->aDb[i].pBt;
  71664. if( pBt ){
  71665. rc = sqlite3BtreeCommitPhaseOne(pBt, 0);
  71666. }
  71667. }
  71668. /* Do the commit only if all databases successfully complete phase 1.
  71669. ** If one of the BtreeCommitPhaseOne() calls fails, this indicates an
  71670. ** IO error while deleting or truncating a journal file. It is unlikely,
  71671. ** but could happen. In this case abandon processing and return the error.
  71672. */
  71673. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  71674. Btree *pBt = db->aDb[i].pBt;
  71675. if( pBt ){
  71676. rc = sqlite3BtreeCommitPhaseTwo(pBt, 0);
  71677. }
  71678. }
  71679. if( rc==SQLITE_OK ){
  71680. sqlite3VtabCommit(db);
  71681. }
  71682. }
  71683. /* The complex case - There is a multi-file write-transaction active.
  71684. ** This requires a master journal file to ensure the transaction is
  71685. ** committed atomically.
  71686. */
  71687. #ifndef SQLITE_OMIT_DISKIO
  71688. else{
  71689. sqlite3_vfs *pVfs = db->pVfs;
  71690. char *zMaster = 0; /* File-name for the master journal */
  71691. char const *zMainFile = sqlite3BtreeGetFilename(db->aDb[0].pBt);
  71692. sqlite3_file *pMaster = 0;
  71693. i64 offset = 0;
  71694. int res;
  71695. int retryCount = 0;
  71696. int nMainFile;
  71697. /* Select a master journal file name */
  71698. nMainFile = sqlite3Strlen30(zMainFile);
  71699. zMaster = sqlite3MPrintf(db, "%s-mjXXXXXX9XXz", zMainFile);
  71700. if( zMaster==0 ) return SQLITE_NOMEM_BKPT;
  71701. do {
  71702. u32 iRandom;
  71703. if( retryCount ){
  71704. if( retryCount>100 ){
  71705. sqlite3_log(SQLITE_FULL, "MJ delete: %s", zMaster);
  71706. sqlite3OsDelete(pVfs, zMaster, 0);
  71707. break;
  71708. }else if( retryCount==1 ){
  71709. sqlite3_log(SQLITE_FULL, "MJ collide: %s", zMaster);
  71710. }
  71711. }
  71712. retryCount++;
  71713. sqlite3_randomness(sizeof(iRandom), &iRandom);
  71714. sqlite3_snprintf(13, &zMaster[nMainFile], "-mj%06X9%02X",
  71715. (iRandom>>8)&0xffffff, iRandom&0xff);
  71716. /* The antipenultimate character of the master journal name must
  71717. ** be "9" to avoid name collisions when using 8+3 filenames. */
  71718. assert( zMaster[sqlite3Strlen30(zMaster)-3]=='9' );
  71719. sqlite3FileSuffix3(zMainFile, zMaster);
  71720. rc = sqlite3OsAccess(pVfs, zMaster, SQLITE_ACCESS_EXISTS, &res);
  71721. }while( rc==SQLITE_OK && res );
  71722. if( rc==SQLITE_OK ){
  71723. /* Open the master journal. */
  71724. rc = sqlite3OsOpenMalloc(pVfs, zMaster, &pMaster,
  71725. SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|
  71726. SQLITE_OPEN_EXCLUSIVE|SQLITE_OPEN_MASTER_JOURNAL, 0
  71727. );
  71728. }
  71729. if( rc!=SQLITE_OK ){
  71730. sqlite3DbFree(db, zMaster);
  71731. return rc;
  71732. }
  71733. /* Write the name of each database file in the transaction into the new
  71734. ** master journal file. If an error occurs at this point close
  71735. ** and delete the master journal file. All the individual journal files
  71736. ** still have 'null' as the master journal pointer, so they will roll
  71737. ** back independently if a failure occurs.
  71738. */
  71739. for(i=0; i<db->nDb; i++){
  71740. Btree *pBt = db->aDb[i].pBt;
  71741. if( sqlite3BtreeIsInTrans(pBt) ){
  71742. char const *zFile = sqlite3BtreeGetJournalname(pBt);
  71743. if( zFile==0 ){
  71744. continue; /* Ignore TEMP and :memory: databases */
  71745. }
  71746. assert( zFile[0]!=0 );
  71747. rc = sqlite3OsWrite(pMaster, zFile, sqlite3Strlen30(zFile)+1, offset);
  71748. offset += sqlite3Strlen30(zFile)+1;
  71749. if( rc!=SQLITE_OK ){
  71750. sqlite3OsCloseFree(pMaster);
  71751. sqlite3OsDelete(pVfs, zMaster, 0);
  71752. sqlite3DbFree(db, zMaster);
  71753. return rc;
  71754. }
  71755. }
  71756. }
  71757. /* Sync the master journal file. If the IOCAP_SEQUENTIAL device
  71758. ** flag is set this is not required.
  71759. */
  71760. if( 0==(sqlite3OsDeviceCharacteristics(pMaster)&SQLITE_IOCAP_SEQUENTIAL)
  71761. && SQLITE_OK!=(rc = sqlite3OsSync(pMaster, SQLITE_SYNC_NORMAL))
  71762. ){
  71763. sqlite3OsCloseFree(pMaster);
  71764. sqlite3OsDelete(pVfs, zMaster, 0);
  71765. sqlite3DbFree(db, zMaster);
  71766. return rc;
  71767. }
  71768. /* Sync all the db files involved in the transaction. The same call
  71769. ** sets the master journal pointer in each individual journal. If
  71770. ** an error occurs here, do not delete the master journal file.
  71771. **
  71772. ** If the error occurs during the first call to
  71773. ** sqlite3BtreeCommitPhaseOne(), then there is a chance that the
  71774. ** master journal file will be orphaned. But we cannot delete it,
  71775. ** in case the master journal file name was written into the journal
  71776. ** file before the failure occurred.
  71777. */
  71778. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  71779. Btree *pBt = db->aDb[i].pBt;
  71780. if( pBt ){
  71781. rc = sqlite3BtreeCommitPhaseOne(pBt, zMaster);
  71782. }
  71783. }
  71784. sqlite3OsCloseFree(pMaster);
  71785. assert( rc!=SQLITE_BUSY );
  71786. if( rc!=SQLITE_OK ){
  71787. sqlite3DbFree(db, zMaster);
  71788. return rc;
  71789. }
  71790. /* Delete the master journal file. This commits the transaction. After
  71791. ** doing this the directory is synced again before any individual
  71792. ** transaction files are deleted.
  71793. */
  71794. rc = sqlite3OsDelete(pVfs, zMaster, 1);
  71795. sqlite3DbFree(db, zMaster);
  71796. zMaster = 0;
  71797. if( rc ){
  71798. return rc;
  71799. }
  71800. /* All files and directories have already been synced, so the following
  71801. ** calls to sqlite3BtreeCommitPhaseTwo() are only closing files and
  71802. ** deleting or truncating journals. If something goes wrong while
  71803. ** this is happening we don't really care. The integrity of the
  71804. ** transaction is already guaranteed, but some stray 'cold' journals
  71805. ** may be lying around. Returning an error code won't help matters.
  71806. */
  71807. disable_simulated_io_errors();
  71808. sqlite3BeginBenignMalloc();
  71809. for(i=0; i<db->nDb; i++){
  71810. Btree *pBt = db->aDb[i].pBt;
  71811. if( pBt ){
  71812. sqlite3BtreeCommitPhaseTwo(pBt, 1);
  71813. }
  71814. }
  71815. sqlite3EndBenignMalloc();
  71816. enable_simulated_io_errors();
  71817. sqlite3VtabCommit(db);
  71818. }
  71819. #endif
  71820. return rc;
  71821. }
  71822. /*
  71823. ** This routine checks that the sqlite3.nVdbeActive count variable
  71824. ** matches the number of vdbe's in the list sqlite3.pVdbe that are
  71825. ** currently active. An assertion fails if the two counts do not match.
  71826. ** This is an internal self-check only - it is not an essential processing
  71827. ** step.
  71828. **
  71829. ** This is a no-op if NDEBUG is defined.
  71830. */
  71831. #ifndef NDEBUG
  71832. static void checkActiveVdbeCnt(sqlite3 *db){
  71833. Vdbe *p;
  71834. int cnt = 0;
  71835. int nWrite = 0;
  71836. int nRead = 0;
  71837. p = db->pVdbe;
  71838. while( p ){
  71839. if( sqlite3_stmt_busy((sqlite3_stmt*)p) ){
  71840. cnt++;
  71841. if( p->readOnly==0 ) nWrite++;
  71842. if( p->bIsReader ) nRead++;
  71843. }
  71844. p = p->pNext;
  71845. }
  71846. assert( cnt==db->nVdbeActive );
  71847. assert( nWrite==db->nVdbeWrite );
  71848. assert( nRead==db->nVdbeRead );
  71849. }
  71850. #else
  71851. #define checkActiveVdbeCnt(x)
  71852. #endif
  71853. /*
  71854. ** If the Vdbe passed as the first argument opened a statement-transaction,
  71855. ** close it now. Argument eOp must be either SAVEPOINT_ROLLBACK or
  71856. ** SAVEPOINT_RELEASE. If it is SAVEPOINT_ROLLBACK, then the statement
  71857. ** transaction is rolled back. If eOp is SAVEPOINT_RELEASE, then the
  71858. ** statement transaction is committed.
  71859. **
  71860. ** If an IO error occurs, an SQLITE_IOERR_XXX error code is returned.
  71861. ** Otherwise SQLITE_OK.
  71862. */
  71863. static SQLITE_NOINLINE int vdbeCloseStatement(Vdbe *p, int eOp){
  71864. sqlite3 *const db = p->db;
  71865. int rc = SQLITE_OK;
  71866. int i;
  71867. const int iSavepoint = p->iStatement-1;
  71868. assert( eOp==SAVEPOINT_ROLLBACK || eOp==SAVEPOINT_RELEASE);
  71869. assert( db->nStatement>0 );
  71870. assert( p->iStatement==(db->nStatement+db->nSavepoint) );
  71871. for(i=0; i<db->nDb; i++){
  71872. int rc2 = SQLITE_OK;
  71873. Btree *pBt = db->aDb[i].pBt;
  71874. if( pBt ){
  71875. if( eOp==SAVEPOINT_ROLLBACK ){
  71876. rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_ROLLBACK, iSavepoint);
  71877. }
  71878. if( rc2==SQLITE_OK ){
  71879. rc2 = sqlite3BtreeSavepoint(pBt, SAVEPOINT_RELEASE, iSavepoint);
  71880. }
  71881. if( rc==SQLITE_OK ){
  71882. rc = rc2;
  71883. }
  71884. }
  71885. }
  71886. db->nStatement--;
  71887. p->iStatement = 0;
  71888. if( rc==SQLITE_OK ){
  71889. if( eOp==SAVEPOINT_ROLLBACK ){
  71890. rc = sqlite3VtabSavepoint(db, SAVEPOINT_ROLLBACK, iSavepoint);
  71891. }
  71892. if( rc==SQLITE_OK ){
  71893. rc = sqlite3VtabSavepoint(db, SAVEPOINT_RELEASE, iSavepoint);
  71894. }
  71895. }
  71896. /* If the statement transaction is being rolled back, also restore the
  71897. ** database handles deferred constraint counter to the value it had when
  71898. ** the statement transaction was opened. */
  71899. if( eOp==SAVEPOINT_ROLLBACK ){
  71900. db->nDeferredCons = p->nStmtDefCons;
  71901. db->nDeferredImmCons = p->nStmtDefImmCons;
  71902. }
  71903. return rc;
  71904. }
  71905. SQLITE_PRIVATE int sqlite3VdbeCloseStatement(Vdbe *p, int eOp){
  71906. if( p->db->nStatement && p->iStatement ){
  71907. return vdbeCloseStatement(p, eOp);
  71908. }
  71909. return SQLITE_OK;
  71910. }
  71911. /*
  71912. ** This function is called when a transaction opened by the database
  71913. ** handle associated with the VM passed as an argument is about to be
  71914. ** committed. If there are outstanding deferred foreign key constraint
  71915. ** violations, return SQLITE_ERROR. Otherwise, SQLITE_OK.
  71916. **
  71917. ** If there are outstanding FK violations and this function returns
  71918. ** SQLITE_ERROR, set the result of the VM to SQLITE_CONSTRAINT_FOREIGNKEY
  71919. ** and write an error message to it. Then return SQLITE_ERROR.
  71920. */
  71921. #ifndef SQLITE_OMIT_FOREIGN_KEY
  71922. SQLITE_PRIVATE int sqlite3VdbeCheckFk(Vdbe *p, int deferred){
  71923. sqlite3 *db = p->db;
  71924. if( (deferred && (db->nDeferredCons+db->nDeferredImmCons)>0)
  71925. || (!deferred && p->nFkConstraint>0)
  71926. ){
  71927. p->rc = SQLITE_CONSTRAINT_FOREIGNKEY;
  71928. p->errorAction = OE_Abort;
  71929. sqlite3VdbeError(p, "FOREIGN KEY constraint failed");
  71930. return SQLITE_ERROR;
  71931. }
  71932. return SQLITE_OK;
  71933. }
  71934. #endif
  71935. /*
  71936. ** This routine is called the when a VDBE tries to halt. If the VDBE
  71937. ** has made changes and is in autocommit mode, then commit those
  71938. ** changes. If a rollback is needed, then do the rollback.
  71939. **
  71940. ** This routine is the only way to move the state of a VM from
  71941. ** SQLITE_MAGIC_RUN to SQLITE_MAGIC_HALT. It is harmless to
  71942. ** call this on a VM that is in the SQLITE_MAGIC_HALT state.
  71943. **
  71944. ** Return an error code. If the commit could not complete because of
  71945. ** lock contention, return SQLITE_BUSY. If SQLITE_BUSY is returned, it
  71946. ** means the close did not happen and needs to be repeated.
  71947. */
  71948. SQLITE_PRIVATE int sqlite3VdbeHalt(Vdbe *p){
  71949. int rc; /* Used to store transient return codes */
  71950. sqlite3 *db = p->db;
  71951. /* This function contains the logic that determines if a statement or
  71952. ** transaction will be committed or rolled back as a result of the
  71953. ** execution of this virtual machine.
  71954. **
  71955. ** If any of the following errors occur:
  71956. **
  71957. ** SQLITE_NOMEM
  71958. ** SQLITE_IOERR
  71959. ** SQLITE_FULL
  71960. ** SQLITE_INTERRUPT
  71961. **
  71962. ** Then the internal cache might have been left in an inconsistent
  71963. ** state. We need to rollback the statement transaction, if there is
  71964. ** one, or the complete transaction if there is no statement transaction.
  71965. */
  71966. if( p->magic!=VDBE_MAGIC_RUN ){
  71967. return SQLITE_OK;
  71968. }
  71969. if( db->mallocFailed ){
  71970. p->rc = SQLITE_NOMEM_BKPT;
  71971. }
  71972. closeAllCursors(p);
  71973. checkActiveVdbeCnt(db);
  71974. /* No commit or rollback needed if the program never started or if the
  71975. ** SQL statement does not read or write a database file. */
  71976. if( p->pc>=0 && p->bIsReader ){
  71977. int mrc; /* Primary error code from p->rc */
  71978. int eStatementOp = 0;
  71979. int isSpecialError; /* Set to true if a 'special' error */
  71980. /* Lock all btrees used by the statement */
  71981. sqlite3VdbeEnter(p);
  71982. /* Check for one of the special errors */
  71983. mrc = p->rc & 0xff;
  71984. isSpecialError = mrc==SQLITE_NOMEM || mrc==SQLITE_IOERR
  71985. || mrc==SQLITE_INTERRUPT || mrc==SQLITE_FULL;
  71986. if( isSpecialError ){
  71987. /* If the query was read-only and the error code is SQLITE_INTERRUPT,
  71988. ** no rollback is necessary. Otherwise, at least a savepoint
  71989. ** transaction must be rolled back to restore the database to a
  71990. ** consistent state.
  71991. **
  71992. ** Even if the statement is read-only, it is important to perform
  71993. ** a statement or transaction rollback operation. If the error
  71994. ** occurred while writing to the journal, sub-journal or database
  71995. ** file as part of an effort to free up cache space (see function
  71996. ** pagerStress() in pager.c), the rollback is required to restore
  71997. ** the pager to a consistent state.
  71998. */
  71999. if( !p->readOnly || mrc!=SQLITE_INTERRUPT ){
  72000. if( (mrc==SQLITE_NOMEM || mrc==SQLITE_FULL) && p->usesStmtJournal ){
  72001. eStatementOp = SAVEPOINT_ROLLBACK;
  72002. }else{
  72003. /* We are forced to roll back the active transaction. Before doing
  72004. ** so, abort any other statements this handle currently has active.
  72005. */
  72006. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  72007. sqlite3CloseSavepoints(db);
  72008. db->autoCommit = 1;
  72009. p->nChange = 0;
  72010. }
  72011. }
  72012. }
  72013. /* Check for immediate foreign key violations. */
  72014. if( p->rc==SQLITE_OK ){
  72015. sqlite3VdbeCheckFk(p, 0);
  72016. }
  72017. /* If the auto-commit flag is set and this is the only active writer
  72018. ** VM, then we do either a commit or rollback of the current transaction.
  72019. **
  72020. ** Note: This block also runs if one of the special errors handled
  72021. ** above has occurred.
  72022. */
  72023. if( !sqlite3VtabInSync(db)
  72024. && db->autoCommit
  72025. && db->nVdbeWrite==(p->readOnly==0)
  72026. ){
  72027. if( p->rc==SQLITE_OK || (p->errorAction==OE_Fail && !isSpecialError) ){
  72028. rc = sqlite3VdbeCheckFk(p, 1);
  72029. if( rc!=SQLITE_OK ){
  72030. if( NEVER(p->readOnly) ){
  72031. sqlite3VdbeLeave(p);
  72032. return SQLITE_ERROR;
  72033. }
  72034. rc = SQLITE_CONSTRAINT_FOREIGNKEY;
  72035. }else{
  72036. /* The auto-commit flag is true, the vdbe program was successful
  72037. ** or hit an 'OR FAIL' constraint and there are no deferred foreign
  72038. ** key constraints to hold up the transaction. This means a commit
  72039. ** is required. */
  72040. rc = vdbeCommit(db, p);
  72041. }
  72042. if( rc==SQLITE_BUSY && p->readOnly ){
  72043. sqlite3VdbeLeave(p);
  72044. return SQLITE_BUSY;
  72045. }else if( rc!=SQLITE_OK ){
  72046. p->rc = rc;
  72047. sqlite3RollbackAll(db, SQLITE_OK);
  72048. p->nChange = 0;
  72049. }else{
  72050. db->nDeferredCons = 0;
  72051. db->nDeferredImmCons = 0;
  72052. db->flags &= ~SQLITE_DeferFKs;
  72053. sqlite3CommitInternalChanges(db);
  72054. }
  72055. }else{
  72056. sqlite3RollbackAll(db, SQLITE_OK);
  72057. p->nChange = 0;
  72058. }
  72059. db->nStatement = 0;
  72060. }else if( eStatementOp==0 ){
  72061. if( p->rc==SQLITE_OK || p->errorAction==OE_Fail ){
  72062. eStatementOp = SAVEPOINT_RELEASE;
  72063. }else if( p->errorAction==OE_Abort ){
  72064. eStatementOp = SAVEPOINT_ROLLBACK;
  72065. }else{
  72066. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  72067. sqlite3CloseSavepoints(db);
  72068. db->autoCommit = 1;
  72069. p->nChange = 0;
  72070. }
  72071. }
  72072. /* If eStatementOp is non-zero, then a statement transaction needs to
  72073. ** be committed or rolled back. Call sqlite3VdbeCloseStatement() to
  72074. ** do so. If this operation returns an error, and the current statement
  72075. ** error code is SQLITE_OK or SQLITE_CONSTRAINT, then promote the
  72076. ** current statement error code.
  72077. */
  72078. if( eStatementOp ){
  72079. rc = sqlite3VdbeCloseStatement(p, eStatementOp);
  72080. if( rc ){
  72081. if( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT ){
  72082. p->rc = rc;
  72083. sqlite3DbFree(db, p->zErrMsg);
  72084. p->zErrMsg = 0;
  72085. }
  72086. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  72087. sqlite3CloseSavepoints(db);
  72088. db->autoCommit = 1;
  72089. p->nChange = 0;
  72090. }
  72091. }
  72092. /* If this was an INSERT, UPDATE or DELETE and no statement transaction
  72093. ** has been rolled back, update the database connection change-counter.
  72094. */
  72095. if( p->changeCntOn ){
  72096. if( eStatementOp!=SAVEPOINT_ROLLBACK ){
  72097. sqlite3VdbeSetChanges(db, p->nChange);
  72098. }else{
  72099. sqlite3VdbeSetChanges(db, 0);
  72100. }
  72101. p->nChange = 0;
  72102. }
  72103. /* Release the locks */
  72104. sqlite3VdbeLeave(p);
  72105. }
  72106. /* We have successfully halted and closed the VM. Record this fact. */
  72107. if( p->pc>=0 ){
  72108. db->nVdbeActive--;
  72109. if( !p->readOnly ) db->nVdbeWrite--;
  72110. if( p->bIsReader ) db->nVdbeRead--;
  72111. assert( db->nVdbeActive>=db->nVdbeRead );
  72112. assert( db->nVdbeRead>=db->nVdbeWrite );
  72113. assert( db->nVdbeWrite>=0 );
  72114. }
  72115. p->magic = VDBE_MAGIC_HALT;
  72116. checkActiveVdbeCnt(db);
  72117. if( db->mallocFailed ){
  72118. p->rc = SQLITE_NOMEM_BKPT;
  72119. }
  72120. /* If the auto-commit flag is set to true, then any locks that were held
  72121. ** by connection db have now been released. Call sqlite3ConnectionUnlocked()
  72122. ** to invoke any required unlock-notify callbacks.
  72123. */
  72124. if( db->autoCommit ){
  72125. sqlite3ConnectionUnlocked(db);
  72126. }
  72127. assert( db->nVdbeActive>0 || db->autoCommit==0 || db->nStatement==0 );
  72128. return (p->rc==SQLITE_BUSY ? SQLITE_BUSY : SQLITE_OK);
  72129. }
  72130. /*
  72131. ** Each VDBE holds the result of the most recent sqlite3_step() call
  72132. ** in p->rc. This routine sets that result back to SQLITE_OK.
  72133. */
  72134. SQLITE_PRIVATE void sqlite3VdbeResetStepResult(Vdbe *p){
  72135. p->rc = SQLITE_OK;
  72136. }
  72137. /*
  72138. ** Copy the error code and error message belonging to the VDBE passed
  72139. ** as the first argument to its database handle (so that they will be
  72140. ** returned by calls to sqlite3_errcode() and sqlite3_errmsg()).
  72141. **
  72142. ** This function does not clear the VDBE error code or message, just
  72143. ** copies them to the database handle.
  72144. */
  72145. SQLITE_PRIVATE int sqlite3VdbeTransferError(Vdbe *p){
  72146. sqlite3 *db = p->db;
  72147. int rc = p->rc;
  72148. if( p->zErrMsg ){
  72149. db->bBenignMalloc++;
  72150. sqlite3BeginBenignMalloc();
  72151. if( db->pErr==0 ) db->pErr = sqlite3ValueNew(db);
  72152. sqlite3ValueSetStr(db->pErr, -1, p->zErrMsg, SQLITE_UTF8, SQLITE_TRANSIENT);
  72153. sqlite3EndBenignMalloc();
  72154. db->bBenignMalloc--;
  72155. }else if( db->pErr ){
  72156. sqlite3ValueSetNull(db->pErr);
  72157. }
  72158. db->errCode = rc;
  72159. return rc;
  72160. }
  72161. #ifdef SQLITE_ENABLE_SQLLOG
  72162. /*
  72163. ** If an SQLITE_CONFIG_SQLLOG hook is registered and the VM has been run,
  72164. ** invoke it.
  72165. */
  72166. static void vdbeInvokeSqllog(Vdbe *v){
  72167. if( sqlite3GlobalConfig.xSqllog && v->rc==SQLITE_OK && v->zSql && v->pc>=0 ){
  72168. char *zExpanded = sqlite3VdbeExpandSql(v, v->zSql);
  72169. assert( v->db->init.busy==0 );
  72170. if( zExpanded ){
  72171. sqlite3GlobalConfig.xSqllog(
  72172. sqlite3GlobalConfig.pSqllogArg, v->db, zExpanded, 1
  72173. );
  72174. sqlite3DbFree(v->db, zExpanded);
  72175. }
  72176. }
  72177. }
  72178. #else
  72179. # define vdbeInvokeSqllog(x)
  72180. #endif
  72181. /*
  72182. ** Clean up a VDBE after execution but do not delete the VDBE just yet.
  72183. ** Write any error messages into *pzErrMsg. Return the result code.
  72184. **
  72185. ** After this routine is run, the VDBE should be ready to be executed
  72186. ** again.
  72187. **
  72188. ** To look at it another way, this routine resets the state of the
  72189. ** virtual machine from VDBE_MAGIC_RUN or VDBE_MAGIC_HALT back to
  72190. ** VDBE_MAGIC_INIT.
  72191. */
  72192. SQLITE_PRIVATE int sqlite3VdbeReset(Vdbe *p){
  72193. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  72194. int i;
  72195. #endif
  72196. sqlite3 *db;
  72197. db = p->db;
  72198. /* If the VM did not run to completion or if it encountered an
  72199. ** error, then it might not have been halted properly. So halt
  72200. ** it now.
  72201. */
  72202. sqlite3VdbeHalt(p);
  72203. /* If the VDBE has be run even partially, then transfer the error code
  72204. ** and error message from the VDBE into the main database structure. But
  72205. ** if the VDBE has just been set to run but has not actually executed any
  72206. ** instructions yet, leave the main database error information unchanged.
  72207. */
  72208. if( p->pc>=0 ){
  72209. vdbeInvokeSqllog(p);
  72210. sqlite3VdbeTransferError(p);
  72211. if( p->runOnlyOnce ) p->expired = 1;
  72212. }else if( p->rc && p->expired ){
  72213. /* The expired flag was set on the VDBE before the first call
  72214. ** to sqlite3_step(). For consistency (since sqlite3_step() was
  72215. ** called), set the database error in this case as well.
  72216. */
  72217. sqlite3ErrorWithMsg(db, p->rc, p->zErrMsg ? "%s" : 0, p->zErrMsg);
  72218. }
  72219. /* Reset register contents and reclaim error message memory.
  72220. */
  72221. #ifdef SQLITE_DEBUG
  72222. /* Execute assert() statements to ensure that the Vdbe.apCsr[] and
  72223. ** Vdbe.aMem[] arrays have already been cleaned up. */
  72224. if( p->apCsr ) for(i=0; i<p->nCursor; i++) assert( p->apCsr[i]==0 );
  72225. if( p->aMem ){
  72226. for(i=0; i<p->nMem; i++) assert( p->aMem[i].flags==MEM_Undefined );
  72227. }
  72228. #endif
  72229. sqlite3DbFree(db, p->zErrMsg);
  72230. p->zErrMsg = 0;
  72231. p->pResultSet = 0;
  72232. /* Save profiling information from this VDBE run.
  72233. */
  72234. #ifdef VDBE_PROFILE
  72235. {
  72236. FILE *out = fopen("vdbe_profile.out", "a");
  72237. if( out ){
  72238. fprintf(out, "---- ");
  72239. for(i=0; i<p->nOp; i++){
  72240. fprintf(out, "%02x", p->aOp[i].opcode);
  72241. }
  72242. fprintf(out, "\n");
  72243. if( p->zSql ){
  72244. char c, pc = 0;
  72245. fprintf(out, "-- ");
  72246. for(i=0; (c = p->zSql[i])!=0; i++){
  72247. if( pc=='\n' ) fprintf(out, "-- ");
  72248. putc(c, out);
  72249. pc = c;
  72250. }
  72251. if( pc!='\n' ) fprintf(out, "\n");
  72252. }
  72253. for(i=0; i<p->nOp; i++){
  72254. char zHdr[100];
  72255. sqlite3_snprintf(sizeof(zHdr), zHdr, "%6u %12llu %8llu ",
  72256. p->aOp[i].cnt,
  72257. p->aOp[i].cycles,
  72258. p->aOp[i].cnt>0 ? p->aOp[i].cycles/p->aOp[i].cnt : 0
  72259. );
  72260. fprintf(out, "%s", zHdr);
  72261. sqlite3VdbePrintOp(out, i, &p->aOp[i]);
  72262. }
  72263. fclose(out);
  72264. }
  72265. }
  72266. #endif
  72267. p->magic = VDBE_MAGIC_RESET;
  72268. return p->rc & db->errMask;
  72269. }
  72270. /*
  72271. ** Clean up and delete a VDBE after execution. Return an integer which is
  72272. ** the result code. Write any error message text into *pzErrMsg.
  72273. */
  72274. SQLITE_PRIVATE int sqlite3VdbeFinalize(Vdbe *p){
  72275. int rc = SQLITE_OK;
  72276. if( p->magic==VDBE_MAGIC_RUN || p->magic==VDBE_MAGIC_HALT ){
  72277. rc = sqlite3VdbeReset(p);
  72278. assert( (rc & p->db->errMask)==rc );
  72279. }
  72280. sqlite3VdbeDelete(p);
  72281. return rc;
  72282. }
  72283. /*
  72284. ** If parameter iOp is less than zero, then invoke the destructor for
  72285. ** all auxiliary data pointers currently cached by the VM passed as
  72286. ** the first argument.
  72287. **
  72288. ** Or, if iOp is greater than or equal to zero, then the destructor is
  72289. ** only invoked for those auxiliary data pointers created by the user
  72290. ** function invoked by the OP_Function opcode at instruction iOp of
  72291. ** VM pVdbe, and only then if:
  72292. **
  72293. ** * the associated function parameter is the 32nd or later (counting
  72294. ** from left to right), or
  72295. **
  72296. ** * the corresponding bit in argument mask is clear (where the first
  72297. ** function parameter corresponds to bit 0 etc.).
  72298. */
  72299. SQLITE_PRIVATE void sqlite3VdbeDeleteAuxData(sqlite3 *db, AuxData **pp, int iOp, int mask){
  72300. while( *pp ){
  72301. AuxData *pAux = *pp;
  72302. if( (iOp<0)
  72303. || (pAux->iAuxOp==iOp
  72304. && pAux->iAuxArg>=0
  72305. && (pAux->iAuxArg>31 || !(mask & MASKBIT32(pAux->iAuxArg))))
  72306. ){
  72307. testcase( pAux->iAuxArg==31 );
  72308. if( pAux->xDeleteAux ){
  72309. pAux->xDeleteAux(pAux->pAux);
  72310. }
  72311. *pp = pAux->pNextAux;
  72312. sqlite3DbFree(db, pAux);
  72313. }else{
  72314. pp= &pAux->pNextAux;
  72315. }
  72316. }
  72317. }
  72318. /*
  72319. ** Free all memory associated with the Vdbe passed as the second argument,
  72320. ** except for object itself, which is preserved.
  72321. **
  72322. ** The difference between this function and sqlite3VdbeDelete() is that
  72323. ** VdbeDelete() also unlinks the Vdbe from the list of VMs associated with
  72324. ** the database connection and frees the object itself.
  72325. */
  72326. SQLITE_PRIVATE void sqlite3VdbeClearObject(sqlite3 *db, Vdbe *p){
  72327. SubProgram *pSub, *pNext;
  72328. assert( p->db==0 || p->db==db );
  72329. releaseMemArray(p->aColName, p->nResColumn*COLNAME_N);
  72330. for(pSub=p->pProgram; pSub; pSub=pNext){
  72331. pNext = pSub->pNext;
  72332. vdbeFreeOpArray(db, pSub->aOp, pSub->nOp);
  72333. sqlite3DbFree(db, pSub);
  72334. }
  72335. if( p->magic!=VDBE_MAGIC_INIT ){
  72336. releaseMemArray(p->aVar, p->nVar);
  72337. sqlite3DbFree(db, p->pVList);
  72338. sqlite3DbFree(db, p->pFree);
  72339. }
  72340. vdbeFreeOpArray(db, p->aOp, p->nOp);
  72341. sqlite3DbFree(db, p->aColName);
  72342. sqlite3DbFree(db, p->zSql);
  72343. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  72344. {
  72345. int i;
  72346. for(i=0; i<p->nScan; i++){
  72347. sqlite3DbFree(db, p->aScan[i].zName);
  72348. }
  72349. sqlite3DbFree(db, p->aScan);
  72350. }
  72351. #endif
  72352. }
  72353. /*
  72354. ** Delete an entire VDBE.
  72355. */
  72356. SQLITE_PRIVATE void sqlite3VdbeDelete(Vdbe *p){
  72357. sqlite3 *db;
  72358. assert( p!=0 );
  72359. db = p->db;
  72360. assert( sqlite3_mutex_held(db->mutex) );
  72361. sqlite3VdbeClearObject(db, p);
  72362. if( p->pPrev ){
  72363. p->pPrev->pNext = p->pNext;
  72364. }else{
  72365. assert( db->pVdbe==p );
  72366. db->pVdbe = p->pNext;
  72367. }
  72368. if( p->pNext ){
  72369. p->pNext->pPrev = p->pPrev;
  72370. }
  72371. p->magic = VDBE_MAGIC_DEAD;
  72372. p->db = 0;
  72373. sqlite3DbFreeNN(db, p);
  72374. }
  72375. /*
  72376. ** The cursor "p" has a pending seek operation that has not yet been
  72377. ** carried out. Seek the cursor now. If an error occurs, return
  72378. ** the appropriate error code.
  72379. */
  72380. static int SQLITE_NOINLINE handleDeferredMoveto(VdbeCursor *p){
  72381. int res, rc;
  72382. #ifdef SQLITE_TEST
  72383. extern int sqlite3_search_count;
  72384. #endif
  72385. assert( p->deferredMoveto );
  72386. assert( p->isTable );
  72387. assert( p->eCurType==CURTYPE_BTREE );
  72388. rc = sqlite3BtreeMovetoUnpacked(p->uc.pCursor, 0, p->movetoTarget, 0, &res);
  72389. if( rc ) return rc;
  72390. if( res!=0 ) return SQLITE_CORRUPT_BKPT;
  72391. #ifdef SQLITE_TEST
  72392. sqlite3_search_count++;
  72393. #endif
  72394. p->deferredMoveto = 0;
  72395. p->cacheStatus = CACHE_STALE;
  72396. return SQLITE_OK;
  72397. }
  72398. /*
  72399. ** Something has moved cursor "p" out of place. Maybe the row it was
  72400. ** pointed to was deleted out from under it. Or maybe the btree was
  72401. ** rebalanced. Whatever the cause, try to restore "p" to the place it
  72402. ** is supposed to be pointing. If the row was deleted out from under the
  72403. ** cursor, set the cursor to point to a NULL row.
  72404. */
  72405. static int SQLITE_NOINLINE handleMovedCursor(VdbeCursor *p){
  72406. int isDifferentRow, rc;
  72407. assert( p->eCurType==CURTYPE_BTREE );
  72408. assert( p->uc.pCursor!=0 );
  72409. assert( sqlite3BtreeCursorHasMoved(p->uc.pCursor) );
  72410. rc = sqlite3BtreeCursorRestore(p->uc.pCursor, &isDifferentRow);
  72411. p->cacheStatus = CACHE_STALE;
  72412. if( isDifferentRow ) p->nullRow = 1;
  72413. return rc;
  72414. }
  72415. /*
  72416. ** Check to ensure that the cursor is valid. Restore the cursor
  72417. ** if need be. Return any I/O error from the restore operation.
  72418. */
  72419. SQLITE_PRIVATE int sqlite3VdbeCursorRestore(VdbeCursor *p){
  72420. assert( p->eCurType==CURTYPE_BTREE );
  72421. if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
  72422. return handleMovedCursor(p);
  72423. }
  72424. return SQLITE_OK;
  72425. }
  72426. /*
  72427. ** Make sure the cursor p is ready to read or write the row to which it
  72428. ** was last positioned. Return an error code if an OOM fault or I/O error
  72429. ** prevents us from positioning the cursor to its correct position.
  72430. **
  72431. ** If a MoveTo operation is pending on the given cursor, then do that
  72432. ** MoveTo now. If no move is pending, check to see if the row has been
  72433. ** deleted out from under the cursor and if it has, mark the row as
  72434. ** a NULL row.
  72435. **
  72436. ** If the cursor is already pointing to the correct row and that row has
  72437. ** not been deleted out from under the cursor, then this routine is a no-op.
  72438. */
  72439. SQLITE_PRIVATE int sqlite3VdbeCursorMoveto(VdbeCursor **pp, int *piCol){
  72440. VdbeCursor *p = *pp;
  72441. assert( p->eCurType==CURTYPE_BTREE || p->eCurType==CURTYPE_PSEUDO );
  72442. if( p->deferredMoveto ){
  72443. int iMap;
  72444. if( p->aAltMap && (iMap = p->aAltMap[1+*piCol])>0 ){
  72445. *pp = p->pAltCursor;
  72446. *piCol = iMap - 1;
  72447. return SQLITE_OK;
  72448. }
  72449. return handleDeferredMoveto(p);
  72450. }
  72451. if( sqlite3BtreeCursorHasMoved(p->uc.pCursor) ){
  72452. return handleMovedCursor(p);
  72453. }
  72454. return SQLITE_OK;
  72455. }
  72456. /*
  72457. ** The following functions:
  72458. **
  72459. ** sqlite3VdbeSerialType()
  72460. ** sqlite3VdbeSerialTypeLen()
  72461. ** sqlite3VdbeSerialLen()
  72462. ** sqlite3VdbeSerialPut()
  72463. ** sqlite3VdbeSerialGet()
  72464. **
  72465. ** encapsulate the code that serializes values for storage in SQLite
  72466. ** data and index records. Each serialized value consists of a
  72467. ** 'serial-type' and a blob of data. The serial type is an 8-byte unsigned
  72468. ** integer, stored as a varint.
  72469. **
  72470. ** In an SQLite index record, the serial type is stored directly before
  72471. ** the blob of data that it corresponds to. In a table record, all serial
  72472. ** types are stored at the start of the record, and the blobs of data at
  72473. ** the end. Hence these functions allow the caller to handle the
  72474. ** serial-type and data blob separately.
  72475. **
  72476. ** The following table describes the various storage classes for data:
  72477. **
  72478. ** serial type bytes of data type
  72479. ** -------------- --------------- ---------------
  72480. ** 0 0 NULL
  72481. ** 1 1 signed integer
  72482. ** 2 2 signed integer
  72483. ** 3 3 signed integer
  72484. ** 4 4 signed integer
  72485. ** 5 6 signed integer
  72486. ** 6 8 signed integer
  72487. ** 7 8 IEEE float
  72488. ** 8 0 Integer constant 0
  72489. ** 9 0 Integer constant 1
  72490. ** 10,11 reserved for expansion
  72491. ** N>=12 and even (N-12)/2 BLOB
  72492. ** N>=13 and odd (N-13)/2 text
  72493. **
  72494. ** The 8 and 9 types were added in 3.3.0, file format 4. Prior versions
  72495. ** of SQLite will not understand those serial types.
  72496. */
  72497. /*
  72498. ** Return the serial-type for the value stored in pMem.
  72499. */
  72500. SQLITE_PRIVATE u32 sqlite3VdbeSerialType(Mem *pMem, int file_format, u32 *pLen){
  72501. int flags = pMem->flags;
  72502. u32 n;
  72503. assert( pLen!=0 );
  72504. if( flags&MEM_Null ){
  72505. *pLen = 0;
  72506. return 0;
  72507. }
  72508. if( flags&MEM_Int ){
  72509. /* Figure out whether to use 1, 2, 4, 6 or 8 bytes. */
  72510. # define MAX_6BYTE ((((i64)0x00008000)<<32)-1)
  72511. i64 i = pMem->u.i;
  72512. u64 u;
  72513. if( i<0 ){
  72514. u = ~i;
  72515. }else{
  72516. u = i;
  72517. }
  72518. if( u<=127 ){
  72519. if( (i&1)==i && file_format>=4 ){
  72520. *pLen = 0;
  72521. return 8+(u32)u;
  72522. }else{
  72523. *pLen = 1;
  72524. return 1;
  72525. }
  72526. }
  72527. if( u<=32767 ){ *pLen = 2; return 2; }
  72528. if( u<=8388607 ){ *pLen = 3; return 3; }
  72529. if( u<=2147483647 ){ *pLen = 4; return 4; }
  72530. if( u<=MAX_6BYTE ){ *pLen = 6; return 5; }
  72531. *pLen = 8;
  72532. return 6;
  72533. }
  72534. if( flags&MEM_Real ){
  72535. *pLen = 8;
  72536. return 7;
  72537. }
  72538. assert( pMem->db->mallocFailed || flags&(MEM_Str|MEM_Blob) );
  72539. assert( pMem->n>=0 );
  72540. n = (u32)pMem->n;
  72541. if( flags & MEM_Zero ){
  72542. n += pMem->u.nZero;
  72543. }
  72544. *pLen = n;
  72545. return ((n*2) + 12 + ((flags&MEM_Str)!=0));
  72546. }
  72547. /*
  72548. ** The sizes for serial types less than 128
  72549. */
  72550. static const u8 sqlite3SmallTypeSizes[] = {
  72551. /* 0 1 2 3 4 5 6 7 8 9 */
  72552. /* 0 */ 0, 1, 2, 3, 4, 6, 8, 8, 0, 0,
  72553. /* 10 */ 0, 0, 0, 0, 1, 1, 2, 2, 3, 3,
  72554. /* 20 */ 4, 4, 5, 5, 6, 6, 7, 7, 8, 8,
  72555. /* 30 */ 9, 9, 10, 10, 11, 11, 12, 12, 13, 13,
  72556. /* 40 */ 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,
  72557. /* 50 */ 19, 19, 20, 20, 21, 21, 22, 22, 23, 23,
  72558. /* 60 */ 24, 24, 25, 25, 26, 26, 27, 27, 28, 28,
  72559. /* 70 */ 29, 29, 30, 30, 31, 31, 32, 32, 33, 33,
  72560. /* 80 */ 34, 34, 35, 35, 36, 36, 37, 37, 38, 38,
  72561. /* 90 */ 39, 39, 40, 40, 41, 41, 42, 42, 43, 43,
  72562. /* 100 */ 44, 44, 45, 45, 46, 46, 47, 47, 48, 48,
  72563. /* 110 */ 49, 49, 50, 50, 51, 51, 52, 52, 53, 53,
  72564. /* 120 */ 54, 54, 55, 55, 56, 56, 57, 57
  72565. };
  72566. /*
  72567. ** Return the length of the data corresponding to the supplied serial-type.
  72568. */
  72569. SQLITE_PRIVATE u32 sqlite3VdbeSerialTypeLen(u32 serial_type){
  72570. if( serial_type>=128 ){
  72571. return (serial_type-12)/2;
  72572. }else{
  72573. assert( serial_type<12
  72574. || sqlite3SmallTypeSizes[serial_type]==(serial_type - 12)/2 );
  72575. return sqlite3SmallTypeSizes[serial_type];
  72576. }
  72577. }
  72578. SQLITE_PRIVATE u8 sqlite3VdbeOneByteSerialTypeLen(u8 serial_type){
  72579. assert( serial_type<128 );
  72580. return sqlite3SmallTypeSizes[serial_type];
  72581. }
  72582. /*
  72583. ** If we are on an architecture with mixed-endian floating
  72584. ** points (ex: ARM7) then swap the lower 4 bytes with the
  72585. ** upper 4 bytes. Return the result.
  72586. **
  72587. ** For most architectures, this is a no-op.
  72588. **
  72589. ** (later): It is reported to me that the mixed-endian problem
  72590. ** on ARM7 is an issue with GCC, not with the ARM7 chip. It seems
  72591. ** that early versions of GCC stored the two words of a 64-bit
  72592. ** float in the wrong order. And that error has been propagated
  72593. ** ever since. The blame is not necessarily with GCC, though.
  72594. ** GCC might have just copying the problem from a prior compiler.
  72595. ** I am also told that newer versions of GCC that follow a different
  72596. ** ABI get the byte order right.
  72597. **
  72598. ** Developers using SQLite on an ARM7 should compile and run their
  72599. ** application using -DSQLITE_DEBUG=1 at least once. With DEBUG
  72600. ** enabled, some asserts below will ensure that the byte order of
  72601. ** floating point values is correct.
  72602. **
  72603. ** (2007-08-30) Frank van Vugt has studied this problem closely
  72604. ** and has send his findings to the SQLite developers. Frank
  72605. ** writes that some Linux kernels offer floating point hardware
  72606. ** emulation that uses only 32-bit mantissas instead of a full
  72607. ** 48-bits as required by the IEEE standard. (This is the
  72608. ** CONFIG_FPE_FASTFPE option.) On such systems, floating point
  72609. ** byte swapping becomes very complicated. To avoid problems,
  72610. ** the necessary byte swapping is carried out using a 64-bit integer
  72611. ** rather than a 64-bit float. Frank assures us that the code here
  72612. ** works for him. We, the developers, have no way to independently
  72613. ** verify this, but Frank seems to know what he is talking about
  72614. ** so we trust him.
  72615. */
  72616. #ifdef SQLITE_MIXED_ENDIAN_64BIT_FLOAT
  72617. static u64 floatSwap(u64 in){
  72618. union {
  72619. u64 r;
  72620. u32 i[2];
  72621. } u;
  72622. u32 t;
  72623. u.r = in;
  72624. t = u.i[0];
  72625. u.i[0] = u.i[1];
  72626. u.i[1] = t;
  72627. return u.r;
  72628. }
  72629. # define swapMixedEndianFloat(X) X = floatSwap(X)
  72630. #else
  72631. # define swapMixedEndianFloat(X)
  72632. #endif
  72633. /*
  72634. ** Write the serialized data blob for the value stored in pMem into
  72635. ** buf. It is assumed that the caller has allocated sufficient space.
  72636. ** Return the number of bytes written.
  72637. **
  72638. ** nBuf is the amount of space left in buf[]. The caller is responsible
  72639. ** for allocating enough space to buf[] to hold the entire field, exclusive
  72640. ** of the pMem->u.nZero bytes for a MEM_Zero value.
  72641. **
  72642. ** Return the number of bytes actually written into buf[]. The number
  72643. ** of bytes in the zero-filled tail is included in the return value only
  72644. ** if those bytes were zeroed in buf[].
  72645. */
  72646. SQLITE_PRIVATE u32 sqlite3VdbeSerialPut(u8 *buf, Mem *pMem, u32 serial_type){
  72647. u32 len;
  72648. /* Integer and Real */
  72649. if( serial_type<=7 && serial_type>0 ){
  72650. u64 v;
  72651. u32 i;
  72652. if( serial_type==7 ){
  72653. assert( sizeof(v)==sizeof(pMem->u.r) );
  72654. memcpy(&v, &pMem->u.r, sizeof(v));
  72655. swapMixedEndianFloat(v);
  72656. }else{
  72657. v = pMem->u.i;
  72658. }
  72659. len = i = sqlite3SmallTypeSizes[serial_type];
  72660. assert( i>0 );
  72661. do{
  72662. buf[--i] = (u8)(v&0xFF);
  72663. v >>= 8;
  72664. }while( i );
  72665. return len;
  72666. }
  72667. /* String or blob */
  72668. if( serial_type>=12 ){
  72669. assert( pMem->n + ((pMem->flags & MEM_Zero)?pMem->u.nZero:0)
  72670. == (int)sqlite3VdbeSerialTypeLen(serial_type) );
  72671. len = pMem->n;
  72672. if( len>0 ) memcpy(buf, pMem->z, len);
  72673. return len;
  72674. }
  72675. /* NULL or constants 0 or 1 */
  72676. return 0;
  72677. }
  72678. /* Input "x" is a sequence of unsigned characters that represent a
  72679. ** big-endian integer. Return the equivalent native integer
  72680. */
  72681. #define ONE_BYTE_INT(x) ((i8)(x)[0])
  72682. #define TWO_BYTE_INT(x) (256*(i8)((x)[0])|(x)[1])
  72683. #define THREE_BYTE_INT(x) (65536*(i8)((x)[0])|((x)[1]<<8)|(x)[2])
  72684. #define FOUR_BYTE_UINT(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
  72685. #define FOUR_BYTE_INT(x) (16777216*(i8)((x)[0])|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
  72686. /*
  72687. ** Deserialize the data blob pointed to by buf as serial type serial_type
  72688. ** and store the result in pMem. Return the number of bytes read.
  72689. **
  72690. ** This function is implemented as two separate routines for performance.
  72691. ** The few cases that require local variables are broken out into a separate
  72692. ** routine so that in most cases the overhead of moving the stack pointer
  72693. ** is avoided.
  72694. */
  72695. static u32 SQLITE_NOINLINE serialGet(
  72696. const unsigned char *buf, /* Buffer to deserialize from */
  72697. u32 serial_type, /* Serial type to deserialize */
  72698. Mem *pMem /* Memory cell to write value into */
  72699. ){
  72700. u64 x = FOUR_BYTE_UINT(buf);
  72701. u32 y = FOUR_BYTE_UINT(buf+4);
  72702. x = (x<<32) + y;
  72703. if( serial_type==6 ){
  72704. /* EVIDENCE-OF: R-29851-52272 Value is a big-endian 64-bit
  72705. ** twos-complement integer. */
  72706. pMem->u.i = *(i64*)&x;
  72707. pMem->flags = MEM_Int;
  72708. testcase( pMem->u.i<0 );
  72709. }else{
  72710. /* EVIDENCE-OF: R-57343-49114 Value is a big-endian IEEE 754-2008 64-bit
  72711. ** floating point number. */
  72712. #if !defined(NDEBUG) && !defined(SQLITE_OMIT_FLOATING_POINT)
  72713. /* Verify that integers and floating point values use the same
  72714. ** byte order. Or, that if SQLITE_MIXED_ENDIAN_64BIT_FLOAT is
  72715. ** defined that 64-bit floating point values really are mixed
  72716. ** endian.
  72717. */
  72718. static const u64 t1 = ((u64)0x3ff00000)<<32;
  72719. static const double r1 = 1.0;
  72720. u64 t2 = t1;
  72721. swapMixedEndianFloat(t2);
  72722. assert( sizeof(r1)==sizeof(t2) && memcmp(&r1, &t2, sizeof(r1))==0 );
  72723. #endif
  72724. assert( sizeof(x)==8 && sizeof(pMem->u.r)==8 );
  72725. swapMixedEndianFloat(x);
  72726. memcpy(&pMem->u.r, &x, sizeof(x));
  72727. pMem->flags = sqlite3IsNaN(pMem->u.r) ? MEM_Null : MEM_Real;
  72728. }
  72729. return 8;
  72730. }
  72731. SQLITE_PRIVATE u32 sqlite3VdbeSerialGet(
  72732. const unsigned char *buf, /* Buffer to deserialize from */
  72733. u32 serial_type, /* Serial type to deserialize */
  72734. Mem *pMem /* Memory cell to write value into */
  72735. ){
  72736. switch( serial_type ){
  72737. case 10: { /* Internal use only: NULL with virtual table
  72738. ** UPDATE no-change flag set */
  72739. pMem->flags = MEM_Null|MEM_Zero;
  72740. pMem->n = 0;
  72741. pMem->u.nZero = 0;
  72742. break;
  72743. }
  72744. case 11: /* Reserved for future use */
  72745. case 0: { /* Null */
  72746. /* EVIDENCE-OF: R-24078-09375 Value is a NULL. */
  72747. pMem->flags = MEM_Null;
  72748. break;
  72749. }
  72750. case 1: {
  72751. /* EVIDENCE-OF: R-44885-25196 Value is an 8-bit twos-complement
  72752. ** integer. */
  72753. pMem->u.i = ONE_BYTE_INT(buf);
  72754. pMem->flags = MEM_Int;
  72755. testcase( pMem->u.i<0 );
  72756. return 1;
  72757. }
  72758. case 2: { /* 2-byte signed integer */
  72759. /* EVIDENCE-OF: R-49794-35026 Value is a big-endian 16-bit
  72760. ** twos-complement integer. */
  72761. pMem->u.i = TWO_BYTE_INT(buf);
  72762. pMem->flags = MEM_Int;
  72763. testcase( pMem->u.i<0 );
  72764. return 2;
  72765. }
  72766. case 3: { /* 3-byte signed integer */
  72767. /* EVIDENCE-OF: R-37839-54301 Value is a big-endian 24-bit
  72768. ** twos-complement integer. */
  72769. pMem->u.i = THREE_BYTE_INT(buf);
  72770. pMem->flags = MEM_Int;
  72771. testcase( pMem->u.i<0 );
  72772. return 3;
  72773. }
  72774. case 4: { /* 4-byte signed integer */
  72775. /* EVIDENCE-OF: R-01849-26079 Value is a big-endian 32-bit
  72776. ** twos-complement integer. */
  72777. pMem->u.i = FOUR_BYTE_INT(buf);
  72778. #ifdef __HP_cc
  72779. /* Work around a sign-extension bug in the HP compiler for HP/UX */
  72780. if( buf[0]&0x80 ) pMem->u.i |= 0xffffffff80000000LL;
  72781. #endif
  72782. pMem->flags = MEM_Int;
  72783. testcase( pMem->u.i<0 );
  72784. return 4;
  72785. }
  72786. case 5: { /* 6-byte signed integer */
  72787. /* EVIDENCE-OF: R-50385-09674 Value is a big-endian 48-bit
  72788. ** twos-complement integer. */
  72789. pMem->u.i = FOUR_BYTE_UINT(buf+2) + (((i64)1)<<32)*TWO_BYTE_INT(buf);
  72790. pMem->flags = MEM_Int;
  72791. testcase( pMem->u.i<0 );
  72792. return 6;
  72793. }
  72794. case 6: /* 8-byte signed integer */
  72795. case 7: { /* IEEE floating point */
  72796. /* These use local variables, so do them in a separate routine
  72797. ** to avoid having to move the frame pointer in the common case */
  72798. return serialGet(buf,serial_type,pMem);
  72799. }
  72800. case 8: /* Integer 0 */
  72801. case 9: { /* Integer 1 */
  72802. /* EVIDENCE-OF: R-12976-22893 Value is the integer 0. */
  72803. /* EVIDENCE-OF: R-18143-12121 Value is the integer 1. */
  72804. pMem->u.i = serial_type-8;
  72805. pMem->flags = MEM_Int;
  72806. return 0;
  72807. }
  72808. default: {
  72809. /* EVIDENCE-OF: R-14606-31564 Value is a BLOB that is (N-12)/2 bytes in
  72810. ** length.
  72811. ** EVIDENCE-OF: R-28401-00140 Value is a string in the text encoding and
  72812. ** (N-13)/2 bytes in length. */
  72813. static const u16 aFlag[] = { MEM_Blob|MEM_Ephem, MEM_Str|MEM_Ephem };
  72814. pMem->z = (char *)buf;
  72815. pMem->n = (serial_type-12)/2;
  72816. pMem->flags = aFlag[serial_type&1];
  72817. return pMem->n;
  72818. }
  72819. }
  72820. return 0;
  72821. }
  72822. /*
  72823. ** This routine is used to allocate sufficient space for an UnpackedRecord
  72824. ** structure large enough to be used with sqlite3VdbeRecordUnpack() if
  72825. ** the first argument is a pointer to KeyInfo structure pKeyInfo.
  72826. **
  72827. ** The space is either allocated using sqlite3DbMallocRaw() or from within
  72828. ** the unaligned buffer passed via the second and third arguments (presumably
  72829. ** stack space). If the former, then *ppFree is set to a pointer that should
  72830. ** be eventually freed by the caller using sqlite3DbFree(). Or, if the
  72831. ** allocation comes from the pSpace/szSpace buffer, *ppFree is set to NULL
  72832. ** before returning.
  72833. **
  72834. ** If an OOM error occurs, NULL is returned.
  72835. */
  72836. SQLITE_PRIVATE UnpackedRecord *sqlite3VdbeAllocUnpackedRecord(
  72837. KeyInfo *pKeyInfo /* Description of the record */
  72838. ){
  72839. UnpackedRecord *p; /* Unpacked record to return */
  72840. int nByte; /* Number of bytes required for *p */
  72841. nByte = ROUND8(sizeof(UnpackedRecord)) + sizeof(Mem)*(pKeyInfo->nKeyField+1);
  72842. p = (UnpackedRecord *)sqlite3DbMallocRaw(pKeyInfo->db, nByte);
  72843. if( !p ) return 0;
  72844. p->aMem = (Mem*)&((char*)p)[ROUND8(sizeof(UnpackedRecord))];
  72845. assert( pKeyInfo->aSortOrder!=0 );
  72846. p->pKeyInfo = pKeyInfo;
  72847. p->nField = pKeyInfo->nKeyField + 1;
  72848. return p;
  72849. }
  72850. /*
  72851. ** Given the nKey-byte encoding of a record in pKey[], populate the
  72852. ** UnpackedRecord structure indicated by the fourth argument with the
  72853. ** contents of the decoded record.
  72854. */
  72855. SQLITE_PRIVATE void sqlite3VdbeRecordUnpack(
  72856. KeyInfo *pKeyInfo, /* Information about the record format */
  72857. int nKey, /* Size of the binary record */
  72858. const void *pKey, /* The binary record */
  72859. UnpackedRecord *p /* Populate this structure before returning. */
  72860. ){
  72861. const unsigned char *aKey = (const unsigned char *)pKey;
  72862. int d;
  72863. u32 idx; /* Offset in aKey[] to read from */
  72864. u16 u; /* Unsigned loop counter */
  72865. u32 szHdr;
  72866. Mem *pMem = p->aMem;
  72867. p->default_rc = 0;
  72868. assert( EIGHT_BYTE_ALIGNMENT(pMem) );
  72869. idx = getVarint32(aKey, szHdr);
  72870. d = szHdr;
  72871. u = 0;
  72872. while( idx<szHdr && d<=nKey ){
  72873. u32 serial_type;
  72874. idx += getVarint32(&aKey[idx], serial_type);
  72875. pMem->enc = pKeyInfo->enc;
  72876. pMem->db = pKeyInfo->db;
  72877. /* pMem->flags = 0; // sqlite3VdbeSerialGet() will set this for us */
  72878. pMem->szMalloc = 0;
  72879. pMem->z = 0;
  72880. d += sqlite3VdbeSerialGet(&aKey[d], serial_type, pMem);
  72881. pMem++;
  72882. if( (++u)>=p->nField ) break;
  72883. }
  72884. assert( u<=pKeyInfo->nKeyField + 1 );
  72885. p->nField = u;
  72886. }
  72887. #ifdef SQLITE_DEBUG
  72888. /*
  72889. ** This function compares two index or table record keys in the same way
  72890. ** as the sqlite3VdbeRecordCompare() routine. Unlike VdbeRecordCompare(),
  72891. ** this function deserializes and compares values using the
  72892. ** sqlite3VdbeSerialGet() and sqlite3MemCompare() functions. It is used
  72893. ** in assert() statements to ensure that the optimized code in
  72894. ** sqlite3VdbeRecordCompare() returns results with these two primitives.
  72895. **
  72896. ** Return true if the result of comparison is equivalent to desiredResult.
  72897. ** Return false if there is a disagreement.
  72898. */
  72899. static int vdbeRecordCompareDebug(
  72900. int nKey1, const void *pKey1, /* Left key */
  72901. const UnpackedRecord *pPKey2, /* Right key */
  72902. int desiredResult /* Correct answer */
  72903. ){
  72904. u32 d1; /* Offset into aKey[] of next data element */
  72905. u32 idx1; /* Offset into aKey[] of next header element */
  72906. u32 szHdr1; /* Number of bytes in header */
  72907. int i = 0;
  72908. int rc = 0;
  72909. const unsigned char *aKey1 = (const unsigned char *)pKey1;
  72910. KeyInfo *pKeyInfo;
  72911. Mem mem1;
  72912. pKeyInfo = pPKey2->pKeyInfo;
  72913. if( pKeyInfo->db==0 ) return 1;
  72914. mem1.enc = pKeyInfo->enc;
  72915. mem1.db = pKeyInfo->db;
  72916. /* mem1.flags = 0; // Will be initialized by sqlite3VdbeSerialGet() */
  72917. VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
  72918. /* Compilers may complain that mem1.u.i is potentially uninitialized.
  72919. ** We could initialize it, as shown here, to silence those complaints.
  72920. ** But in fact, mem1.u.i will never actually be used uninitialized, and doing
  72921. ** the unnecessary initialization has a measurable negative performance
  72922. ** impact, since this routine is a very high runner. And so, we choose
  72923. ** to ignore the compiler warnings and leave this variable uninitialized.
  72924. */
  72925. /* mem1.u.i = 0; // not needed, here to silence compiler warning */
  72926. idx1 = getVarint32(aKey1, szHdr1);
  72927. if( szHdr1>98307 ) return SQLITE_CORRUPT;
  72928. d1 = szHdr1;
  72929. assert( pKeyInfo->nAllField>=pPKey2->nField || CORRUPT_DB );
  72930. assert( pKeyInfo->aSortOrder!=0 );
  72931. assert( pKeyInfo->nKeyField>0 );
  72932. assert( idx1<=szHdr1 || CORRUPT_DB );
  72933. do{
  72934. u32 serial_type1;
  72935. /* Read the serial types for the next element in each key. */
  72936. idx1 += getVarint32( aKey1+idx1, serial_type1 );
  72937. /* Verify that there is enough key space remaining to avoid
  72938. ** a buffer overread. The "d1+serial_type1+2" subexpression will
  72939. ** always be greater than or equal to the amount of required key space.
  72940. ** Use that approximation to avoid the more expensive call to
  72941. ** sqlite3VdbeSerialTypeLen() in the common case.
  72942. */
  72943. if( d1+serial_type1+2>(u32)nKey1
  72944. && d1+sqlite3VdbeSerialTypeLen(serial_type1)>(u32)nKey1
  72945. ){
  72946. break;
  72947. }
  72948. /* Extract the values to be compared.
  72949. */
  72950. d1 += sqlite3VdbeSerialGet(&aKey1[d1], serial_type1, &mem1);
  72951. /* Do the comparison
  72952. */
  72953. rc = sqlite3MemCompare(&mem1, &pPKey2->aMem[i], pKeyInfo->aColl[i]);
  72954. if( rc!=0 ){
  72955. assert( mem1.szMalloc==0 ); /* See comment below */
  72956. if( pKeyInfo->aSortOrder[i] ){
  72957. rc = -rc; /* Invert the result for DESC sort order. */
  72958. }
  72959. goto debugCompareEnd;
  72960. }
  72961. i++;
  72962. }while( idx1<szHdr1 && i<pPKey2->nField );
  72963. /* No memory allocation is ever used on mem1. Prove this using
  72964. ** the following assert(). If the assert() fails, it indicates a
  72965. ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1).
  72966. */
  72967. assert( mem1.szMalloc==0 );
  72968. /* rc==0 here means that one of the keys ran out of fields and
  72969. ** all the fields up to that point were equal. Return the default_rc
  72970. ** value. */
  72971. rc = pPKey2->default_rc;
  72972. debugCompareEnd:
  72973. if( desiredResult==0 && rc==0 ) return 1;
  72974. if( desiredResult<0 && rc<0 ) return 1;
  72975. if( desiredResult>0 && rc>0 ) return 1;
  72976. if( CORRUPT_DB ) return 1;
  72977. if( pKeyInfo->db->mallocFailed ) return 1;
  72978. return 0;
  72979. }
  72980. #endif
  72981. #ifdef SQLITE_DEBUG
  72982. /*
  72983. ** Count the number of fields (a.k.a. columns) in the record given by
  72984. ** pKey,nKey. The verify that this count is less than or equal to the
  72985. ** limit given by pKeyInfo->nAllField.
  72986. **
  72987. ** If this constraint is not satisfied, it means that the high-speed
  72988. ** vdbeRecordCompareInt() and vdbeRecordCompareString() routines will
  72989. ** not work correctly. If this assert() ever fires, it probably means
  72990. ** that the KeyInfo.nKeyField or KeyInfo.nAllField values were computed
  72991. ** incorrectly.
  72992. */
  72993. static void vdbeAssertFieldCountWithinLimits(
  72994. int nKey, const void *pKey, /* The record to verify */
  72995. const KeyInfo *pKeyInfo /* Compare size with this KeyInfo */
  72996. ){
  72997. int nField = 0;
  72998. u32 szHdr;
  72999. u32 idx;
  73000. u32 notUsed;
  73001. const unsigned char *aKey = (const unsigned char*)pKey;
  73002. if( CORRUPT_DB ) return;
  73003. idx = getVarint32(aKey, szHdr);
  73004. assert( nKey>=0 );
  73005. assert( szHdr<=(u32)nKey );
  73006. while( idx<szHdr ){
  73007. idx += getVarint32(aKey+idx, notUsed);
  73008. nField++;
  73009. }
  73010. assert( nField <= pKeyInfo->nAllField );
  73011. }
  73012. #else
  73013. # define vdbeAssertFieldCountWithinLimits(A,B,C)
  73014. #endif
  73015. /*
  73016. ** Both *pMem1 and *pMem2 contain string values. Compare the two values
  73017. ** using the collation sequence pColl. As usual, return a negative , zero
  73018. ** or positive value if *pMem1 is less than, equal to or greater than
  73019. ** *pMem2, respectively. Similar in spirit to "rc = (*pMem1) - (*pMem2);".
  73020. */
  73021. static int vdbeCompareMemString(
  73022. const Mem *pMem1,
  73023. const Mem *pMem2,
  73024. const CollSeq *pColl,
  73025. u8 *prcErr /* If an OOM occurs, set to SQLITE_NOMEM */
  73026. ){
  73027. if( pMem1->enc==pColl->enc ){
  73028. /* The strings are already in the correct encoding. Call the
  73029. ** comparison function directly */
  73030. return pColl->xCmp(pColl->pUser,pMem1->n,pMem1->z,pMem2->n,pMem2->z);
  73031. }else{
  73032. int rc;
  73033. const void *v1, *v2;
  73034. Mem c1;
  73035. Mem c2;
  73036. sqlite3VdbeMemInit(&c1, pMem1->db, MEM_Null);
  73037. sqlite3VdbeMemInit(&c2, pMem1->db, MEM_Null);
  73038. sqlite3VdbeMemShallowCopy(&c1, pMem1, MEM_Ephem);
  73039. sqlite3VdbeMemShallowCopy(&c2, pMem2, MEM_Ephem);
  73040. v1 = sqlite3ValueText((sqlite3_value*)&c1, pColl->enc);
  73041. v2 = sqlite3ValueText((sqlite3_value*)&c2, pColl->enc);
  73042. if( (v1==0 || v2==0) ){
  73043. if( prcErr ) *prcErr = SQLITE_NOMEM_BKPT;
  73044. rc = 0;
  73045. }else{
  73046. rc = pColl->xCmp(pColl->pUser, c1.n, v1, c2.n, v2);
  73047. }
  73048. sqlite3VdbeMemRelease(&c1);
  73049. sqlite3VdbeMemRelease(&c2);
  73050. return rc;
  73051. }
  73052. }
  73053. /*
  73054. ** The input pBlob is guaranteed to be a Blob that is not marked
  73055. ** with MEM_Zero. Return true if it could be a zero-blob.
  73056. */
  73057. static int isAllZero(const char *z, int n){
  73058. int i;
  73059. for(i=0; i<n; i++){
  73060. if( z[i] ) return 0;
  73061. }
  73062. return 1;
  73063. }
  73064. /*
  73065. ** Compare two blobs. Return negative, zero, or positive if the first
  73066. ** is less than, equal to, or greater than the second, respectively.
  73067. ** If one blob is a prefix of the other, then the shorter is the lessor.
  73068. */
  73069. static SQLITE_NOINLINE int sqlite3BlobCompare(const Mem *pB1, const Mem *pB2){
  73070. int c;
  73071. int n1 = pB1->n;
  73072. int n2 = pB2->n;
  73073. /* It is possible to have a Blob value that has some non-zero content
  73074. ** followed by zero content. But that only comes up for Blobs formed
  73075. ** by the OP_MakeRecord opcode, and such Blobs never get passed into
  73076. ** sqlite3MemCompare(). */
  73077. assert( (pB1->flags & MEM_Zero)==0 || n1==0 );
  73078. assert( (pB2->flags & MEM_Zero)==0 || n2==0 );
  73079. if( (pB1->flags|pB2->flags) & MEM_Zero ){
  73080. if( pB1->flags & pB2->flags & MEM_Zero ){
  73081. return pB1->u.nZero - pB2->u.nZero;
  73082. }else if( pB1->flags & MEM_Zero ){
  73083. if( !isAllZero(pB2->z, pB2->n) ) return -1;
  73084. return pB1->u.nZero - n2;
  73085. }else{
  73086. if( !isAllZero(pB1->z, pB1->n) ) return +1;
  73087. return n1 - pB2->u.nZero;
  73088. }
  73089. }
  73090. c = memcmp(pB1->z, pB2->z, n1>n2 ? n2 : n1);
  73091. if( c ) return c;
  73092. return n1 - n2;
  73093. }
  73094. /*
  73095. ** Do a comparison between a 64-bit signed integer and a 64-bit floating-point
  73096. ** number. Return negative, zero, or positive if the first (i64) is less than,
  73097. ** equal to, or greater than the second (double).
  73098. */
  73099. static int sqlite3IntFloatCompare(i64 i, double r){
  73100. if( sizeof(LONGDOUBLE_TYPE)>8 ){
  73101. LONGDOUBLE_TYPE x = (LONGDOUBLE_TYPE)i;
  73102. if( x<r ) return -1;
  73103. if( x>r ) return +1;
  73104. return 0;
  73105. }else{
  73106. i64 y;
  73107. double s;
  73108. if( r<-9223372036854775808.0 ) return +1;
  73109. if( r>9223372036854775807.0 ) return -1;
  73110. y = (i64)r;
  73111. if( i<y ) return -1;
  73112. if( i>y ){
  73113. if( y==SMALLEST_INT64 && r>0.0 ) return -1;
  73114. return +1;
  73115. }
  73116. s = (double)i;
  73117. if( s<r ) return -1;
  73118. if( s>r ) return +1;
  73119. return 0;
  73120. }
  73121. }
  73122. /*
  73123. ** Compare the values contained by the two memory cells, returning
  73124. ** negative, zero or positive if pMem1 is less than, equal to, or greater
  73125. ** than pMem2. Sorting order is NULL's first, followed by numbers (integers
  73126. ** and reals) sorted numerically, followed by text ordered by the collating
  73127. ** sequence pColl and finally blob's ordered by memcmp().
  73128. **
  73129. ** Two NULL values are considered equal by this function.
  73130. */
  73131. SQLITE_PRIVATE int sqlite3MemCompare(const Mem *pMem1, const Mem *pMem2, const CollSeq *pColl){
  73132. int f1, f2;
  73133. int combined_flags;
  73134. f1 = pMem1->flags;
  73135. f2 = pMem2->flags;
  73136. combined_flags = f1|f2;
  73137. assert( (combined_flags & MEM_RowSet)==0 );
  73138. /* If one value is NULL, it is less than the other. If both values
  73139. ** are NULL, return 0.
  73140. */
  73141. if( combined_flags&MEM_Null ){
  73142. return (f2&MEM_Null) - (f1&MEM_Null);
  73143. }
  73144. /* At least one of the two values is a number
  73145. */
  73146. if( combined_flags&(MEM_Int|MEM_Real) ){
  73147. if( (f1 & f2 & MEM_Int)!=0 ){
  73148. if( pMem1->u.i < pMem2->u.i ) return -1;
  73149. if( pMem1->u.i > pMem2->u.i ) return +1;
  73150. return 0;
  73151. }
  73152. if( (f1 & f2 & MEM_Real)!=0 ){
  73153. if( pMem1->u.r < pMem2->u.r ) return -1;
  73154. if( pMem1->u.r > pMem2->u.r ) return +1;
  73155. return 0;
  73156. }
  73157. if( (f1&MEM_Int)!=0 ){
  73158. if( (f2&MEM_Real)!=0 ){
  73159. return sqlite3IntFloatCompare(pMem1->u.i, pMem2->u.r);
  73160. }else{
  73161. return -1;
  73162. }
  73163. }
  73164. if( (f1&MEM_Real)!=0 ){
  73165. if( (f2&MEM_Int)!=0 ){
  73166. return -sqlite3IntFloatCompare(pMem2->u.i, pMem1->u.r);
  73167. }else{
  73168. return -1;
  73169. }
  73170. }
  73171. return +1;
  73172. }
  73173. /* If one value is a string and the other is a blob, the string is less.
  73174. ** If both are strings, compare using the collating functions.
  73175. */
  73176. if( combined_flags&MEM_Str ){
  73177. if( (f1 & MEM_Str)==0 ){
  73178. return 1;
  73179. }
  73180. if( (f2 & MEM_Str)==0 ){
  73181. return -1;
  73182. }
  73183. assert( pMem1->enc==pMem2->enc || pMem1->db->mallocFailed );
  73184. assert( pMem1->enc==SQLITE_UTF8 ||
  73185. pMem1->enc==SQLITE_UTF16LE || pMem1->enc==SQLITE_UTF16BE );
  73186. /* The collation sequence must be defined at this point, even if
  73187. ** the user deletes the collation sequence after the vdbe program is
  73188. ** compiled (this was not always the case).
  73189. */
  73190. assert( !pColl || pColl->xCmp );
  73191. if( pColl ){
  73192. return vdbeCompareMemString(pMem1, pMem2, pColl, 0);
  73193. }
  73194. /* If a NULL pointer was passed as the collate function, fall through
  73195. ** to the blob case and use memcmp(). */
  73196. }
  73197. /* Both values must be blobs. Compare using memcmp(). */
  73198. return sqlite3BlobCompare(pMem1, pMem2);
  73199. }
  73200. /*
  73201. ** The first argument passed to this function is a serial-type that
  73202. ** corresponds to an integer - all values between 1 and 9 inclusive
  73203. ** except 7. The second points to a buffer containing an integer value
  73204. ** serialized according to serial_type. This function deserializes
  73205. ** and returns the value.
  73206. */
  73207. static i64 vdbeRecordDecodeInt(u32 serial_type, const u8 *aKey){
  73208. u32 y;
  73209. assert( CORRUPT_DB || (serial_type>=1 && serial_type<=9 && serial_type!=7) );
  73210. switch( serial_type ){
  73211. case 0:
  73212. case 1:
  73213. testcase( aKey[0]&0x80 );
  73214. return ONE_BYTE_INT(aKey);
  73215. case 2:
  73216. testcase( aKey[0]&0x80 );
  73217. return TWO_BYTE_INT(aKey);
  73218. case 3:
  73219. testcase( aKey[0]&0x80 );
  73220. return THREE_BYTE_INT(aKey);
  73221. case 4: {
  73222. testcase( aKey[0]&0x80 );
  73223. y = FOUR_BYTE_UINT(aKey);
  73224. return (i64)*(int*)&y;
  73225. }
  73226. case 5: {
  73227. testcase( aKey[0]&0x80 );
  73228. return FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
  73229. }
  73230. case 6: {
  73231. u64 x = FOUR_BYTE_UINT(aKey);
  73232. testcase( aKey[0]&0x80 );
  73233. x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
  73234. return (i64)*(i64*)&x;
  73235. }
  73236. }
  73237. return (serial_type - 8);
  73238. }
  73239. /*
  73240. ** This function compares the two table rows or index records
  73241. ** specified by {nKey1, pKey1} and pPKey2. It returns a negative, zero
  73242. ** or positive integer if key1 is less than, equal to or
  73243. ** greater than key2. The {nKey1, pKey1} key must be a blob
  73244. ** created by the OP_MakeRecord opcode of the VDBE. The pPKey2
  73245. ** key must be a parsed key such as obtained from
  73246. ** sqlite3VdbeParseRecord.
  73247. **
  73248. ** If argument bSkip is non-zero, it is assumed that the caller has already
  73249. ** determined that the first fields of the keys are equal.
  73250. **
  73251. ** Key1 and Key2 do not have to contain the same number of fields. If all
  73252. ** fields that appear in both keys are equal, then pPKey2->default_rc is
  73253. ** returned.
  73254. **
  73255. ** If database corruption is discovered, set pPKey2->errCode to
  73256. ** SQLITE_CORRUPT and return 0. If an OOM error is encountered,
  73257. ** pPKey2->errCode is set to SQLITE_NOMEM and, if it is not NULL, the
  73258. ** malloc-failed flag set on database handle (pPKey2->pKeyInfo->db).
  73259. */
  73260. SQLITE_PRIVATE int sqlite3VdbeRecordCompareWithSkip(
  73261. int nKey1, const void *pKey1, /* Left key */
  73262. UnpackedRecord *pPKey2, /* Right key */
  73263. int bSkip /* If true, skip the first field */
  73264. ){
  73265. u32 d1; /* Offset into aKey[] of next data element */
  73266. int i; /* Index of next field to compare */
  73267. u32 szHdr1; /* Size of record header in bytes */
  73268. u32 idx1; /* Offset of first type in header */
  73269. int rc = 0; /* Return value */
  73270. Mem *pRhs = pPKey2->aMem; /* Next field of pPKey2 to compare */
  73271. KeyInfo *pKeyInfo = pPKey2->pKeyInfo;
  73272. const unsigned char *aKey1 = (const unsigned char *)pKey1;
  73273. Mem mem1;
  73274. /* If bSkip is true, then the caller has already determined that the first
  73275. ** two elements in the keys are equal. Fix the various stack variables so
  73276. ** that this routine begins comparing at the second field. */
  73277. if( bSkip ){
  73278. u32 s1;
  73279. idx1 = 1 + getVarint32(&aKey1[1], s1);
  73280. szHdr1 = aKey1[0];
  73281. d1 = szHdr1 + sqlite3VdbeSerialTypeLen(s1);
  73282. i = 1;
  73283. pRhs++;
  73284. }else{
  73285. idx1 = getVarint32(aKey1, szHdr1);
  73286. d1 = szHdr1;
  73287. if( d1>(unsigned)nKey1 ){
  73288. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  73289. return 0; /* Corruption */
  73290. }
  73291. i = 0;
  73292. }
  73293. VVA_ONLY( mem1.szMalloc = 0; ) /* Only needed by assert() statements */
  73294. assert( pPKey2->pKeyInfo->nAllField>=pPKey2->nField
  73295. || CORRUPT_DB );
  73296. assert( pPKey2->pKeyInfo->aSortOrder!=0 );
  73297. assert( pPKey2->pKeyInfo->nKeyField>0 );
  73298. assert( idx1<=szHdr1 || CORRUPT_DB );
  73299. do{
  73300. u32 serial_type;
  73301. /* RHS is an integer */
  73302. if( pRhs->flags & MEM_Int ){
  73303. serial_type = aKey1[idx1];
  73304. testcase( serial_type==12 );
  73305. if( serial_type>=10 ){
  73306. rc = +1;
  73307. }else if( serial_type==0 ){
  73308. rc = -1;
  73309. }else if( serial_type==7 ){
  73310. sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
  73311. rc = -sqlite3IntFloatCompare(pRhs->u.i, mem1.u.r);
  73312. }else{
  73313. i64 lhs = vdbeRecordDecodeInt(serial_type, &aKey1[d1]);
  73314. i64 rhs = pRhs->u.i;
  73315. if( lhs<rhs ){
  73316. rc = -1;
  73317. }else if( lhs>rhs ){
  73318. rc = +1;
  73319. }
  73320. }
  73321. }
  73322. /* RHS is real */
  73323. else if( pRhs->flags & MEM_Real ){
  73324. serial_type = aKey1[idx1];
  73325. if( serial_type>=10 ){
  73326. /* Serial types 12 or greater are strings and blobs (greater than
  73327. ** numbers). Types 10 and 11 are currently "reserved for future
  73328. ** use", so it doesn't really matter what the results of comparing
  73329. ** them to numberic values are. */
  73330. rc = +1;
  73331. }else if( serial_type==0 ){
  73332. rc = -1;
  73333. }else{
  73334. sqlite3VdbeSerialGet(&aKey1[d1], serial_type, &mem1);
  73335. if( serial_type==7 ){
  73336. if( mem1.u.r<pRhs->u.r ){
  73337. rc = -1;
  73338. }else if( mem1.u.r>pRhs->u.r ){
  73339. rc = +1;
  73340. }
  73341. }else{
  73342. rc = sqlite3IntFloatCompare(mem1.u.i, pRhs->u.r);
  73343. }
  73344. }
  73345. }
  73346. /* RHS is a string */
  73347. else if( pRhs->flags & MEM_Str ){
  73348. getVarint32(&aKey1[idx1], serial_type);
  73349. testcase( serial_type==12 );
  73350. if( serial_type<12 ){
  73351. rc = -1;
  73352. }else if( !(serial_type & 0x01) ){
  73353. rc = +1;
  73354. }else{
  73355. mem1.n = (serial_type - 12) / 2;
  73356. testcase( (d1+mem1.n)==(unsigned)nKey1 );
  73357. testcase( (d1+mem1.n+1)==(unsigned)nKey1 );
  73358. if( (d1+mem1.n) > (unsigned)nKey1 ){
  73359. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  73360. return 0; /* Corruption */
  73361. }else if( pKeyInfo->aColl[i] ){
  73362. mem1.enc = pKeyInfo->enc;
  73363. mem1.db = pKeyInfo->db;
  73364. mem1.flags = MEM_Str;
  73365. mem1.z = (char*)&aKey1[d1];
  73366. rc = vdbeCompareMemString(
  73367. &mem1, pRhs, pKeyInfo->aColl[i], &pPKey2->errCode
  73368. );
  73369. }else{
  73370. int nCmp = MIN(mem1.n, pRhs->n);
  73371. rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
  73372. if( rc==0 ) rc = mem1.n - pRhs->n;
  73373. }
  73374. }
  73375. }
  73376. /* RHS is a blob */
  73377. else if( pRhs->flags & MEM_Blob ){
  73378. assert( (pRhs->flags & MEM_Zero)==0 || pRhs->n==0 );
  73379. getVarint32(&aKey1[idx1], serial_type);
  73380. testcase( serial_type==12 );
  73381. if( serial_type<12 || (serial_type & 0x01) ){
  73382. rc = -1;
  73383. }else{
  73384. int nStr = (serial_type - 12) / 2;
  73385. testcase( (d1+nStr)==(unsigned)nKey1 );
  73386. testcase( (d1+nStr+1)==(unsigned)nKey1 );
  73387. if( (d1+nStr) > (unsigned)nKey1 ){
  73388. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  73389. return 0; /* Corruption */
  73390. }else if( pRhs->flags & MEM_Zero ){
  73391. if( !isAllZero((const char*)&aKey1[d1],nStr) ){
  73392. rc = 1;
  73393. }else{
  73394. rc = nStr - pRhs->u.nZero;
  73395. }
  73396. }else{
  73397. int nCmp = MIN(nStr, pRhs->n);
  73398. rc = memcmp(&aKey1[d1], pRhs->z, nCmp);
  73399. if( rc==0 ) rc = nStr - pRhs->n;
  73400. }
  73401. }
  73402. }
  73403. /* RHS is null */
  73404. else{
  73405. serial_type = aKey1[idx1];
  73406. rc = (serial_type!=0);
  73407. }
  73408. if( rc!=0 ){
  73409. if( pKeyInfo->aSortOrder[i] ){
  73410. rc = -rc;
  73411. }
  73412. assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, rc) );
  73413. assert( mem1.szMalloc==0 ); /* See comment below */
  73414. return rc;
  73415. }
  73416. i++;
  73417. pRhs++;
  73418. d1 += sqlite3VdbeSerialTypeLen(serial_type);
  73419. idx1 += sqlite3VarintLen(serial_type);
  73420. }while( idx1<(unsigned)szHdr1 && i<pPKey2->nField && d1<=(unsigned)nKey1 );
  73421. /* No memory allocation is ever used on mem1. Prove this using
  73422. ** the following assert(). If the assert() fails, it indicates a
  73423. ** memory leak and a need to call sqlite3VdbeMemRelease(&mem1). */
  73424. assert( mem1.szMalloc==0 );
  73425. /* rc==0 here means that one or both of the keys ran out of fields and
  73426. ** all the fields up to that point were equal. Return the default_rc
  73427. ** value. */
  73428. assert( CORRUPT_DB
  73429. || vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, pPKey2->default_rc)
  73430. || pKeyInfo->db->mallocFailed
  73431. );
  73432. pPKey2->eqSeen = 1;
  73433. return pPKey2->default_rc;
  73434. }
  73435. SQLITE_PRIVATE int sqlite3VdbeRecordCompare(
  73436. int nKey1, const void *pKey1, /* Left key */
  73437. UnpackedRecord *pPKey2 /* Right key */
  73438. ){
  73439. return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 0);
  73440. }
  73441. /*
  73442. ** This function is an optimized version of sqlite3VdbeRecordCompare()
  73443. ** that (a) the first field of pPKey2 is an integer, and (b) the
  73444. ** size-of-header varint at the start of (pKey1/nKey1) fits in a single
  73445. ** byte (i.e. is less than 128).
  73446. **
  73447. ** To avoid concerns about buffer overreads, this routine is only used
  73448. ** on schemas where the maximum valid header size is 63 bytes or less.
  73449. */
  73450. static int vdbeRecordCompareInt(
  73451. int nKey1, const void *pKey1, /* Left key */
  73452. UnpackedRecord *pPKey2 /* Right key */
  73453. ){
  73454. const u8 *aKey = &((const u8*)pKey1)[*(const u8*)pKey1 & 0x3F];
  73455. int serial_type = ((const u8*)pKey1)[1];
  73456. int res;
  73457. u32 y;
  73458. u64 x;
  73459. i64 v;
  73460. i64 lhs;
  73461. vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
  73462. assert( (*(u8*)pKey1)<=0x3F || CORRUPT_DB );
  73463. switch( serial_type ){
  73464. case 1: { /* 1-byte signed integer */
  73465. lhs = ONE_BYTE_INT(aKey);
  73466. testcase( lhs<0 );
  73467. break;
  73468. }
  73469. case 2: { /* 2-byte signed integer */
  73470. lhs = TWO_BYTE_INT(aKey);
  73471. testcase( lhs<0 );
  73472. break;
  73473. }
  73474. case 3: { /* 3-byte signed integer */
  73475. lhs = THREE_BYTE_INT(aKey);
  73476. testcase( lhs<0 );
  73477. break;
  73478. }
  73479. case 4: { /* 4-byte signed integer */
  73480. y = FOUR_BYTE_UINT(aKey);
  73481. lhs = (i64)*(int*)&y;
  73482. testcase( lhs<0 );
  73483. break;
  73484. }
  73485. case 5: { /* 6-byte signed integer */
  73486. lhs = FOUR_BYTE_UINT(aKey+2) + (((i64)1)<<32)*TWO_BYTE_INT(aKey);
  73487. testcase( lhs<0 );
  73488. break;
  73489. }
  73490. case 6: { /* 8-byte signed integer */
  73491. x = FOUR_BYTE_UINT(aKey);
  73492. x = (x<<32) | FOUR_BYTE_UINT(aKey+4);
  73493. lhs = *(i64*)&x;
  73494. testcase( lhs<0 );
  73495. break;
  73496. }
  73497. case 8:
  73498. lhs = 0;
  73499. break;
  73500. case 9:
  73501. lhs = 1;
  73502. break;
  73503. /* This case could be removed without changing the results of running
  73504. ** this code. Including it causes gcc to generate a faster switch
  73505. ** statement (since the range of switch targets now starts at zero and
  73506. ** is contiguous) but does not cause any duplicate code to be generated
  73507. ** (as gcc is clever enough to combine the two like cases). Other
  73508. ** compilers might be similar. */
  73509. case 0: case 7:
  73510. return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
  73511. default:
  73512. return sqlite3VdbeRecordCompare(nKey1, pKey1, pPKey2);
  73513. }
  73514. v = pPKey2->aMem[0].u.i;
  73515. if( v>lhs ){
  73516. res = pPKey2->r1;
  73517. }else if( v<lhs ){
  73518. res = pPKey2->r2;
  73519. }else if( pPKey2->nField>1 ){
  73520. /* The first fields of the two keys are equal. Compare the trailing
  73521. ** fields. */
  73522. res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
  73523. }else{
  73524. /* The first fields of the two keys are equal and there are no trailing
  73525. ** fields. Return pPKey2->default_rc in this case. */
  73526. res = pPKey2->default_rc;
  73527. pPKey2->eqSeen = 1;
  73528. }
  73529. assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res) );
  73530. return res;
  73531. }
  73532. /*
  73533. ** This function is an optimized version of sqlite3VdbeRecordCompare()
  73534. ** that (a) the first field of pPKey2 is a string, that (b) the first field
  73535. ** uses the collation sequence BINARY and (c) that the size-of-header varint
  73536. ** at the start of (pKey1/nKey1) fits in a single byte.
  73537. */
  73538. static int vdbeRecordCompareString(
  73539. int nKey1, const void *pKey1, /* Left key */
  73540. UnpackedRecord *pPKey2 /* Right key */
  73541. ){
  73542. const u8 *aKey1 = (const u8*)pKey1;
  73543. int serial_type;
  73544. int res;
  73545. assert( pPKey2->aMem[0].flags & MEM_Str );
  73546. vdbeAssertFieldCountWithinLimits(nKey1, pKey1, pPKey2->pKeyInfo);
  73547. getVarint32(&aKey1[1], serial_type);
  73548. if( serial_type<12 ){
  73549. res = pPKey2->r1; /* (pKey1/nKey1) is a number or a null */
  73550. }else if( !(serial_type & 0x01) ){
  73551. res = pPKey2->r2; /* (pKey1/nKey1) is a blob */
  73552. }else{
  73553. int nCmp;
  73554. int nStr;
  73555. int szHdr = aKey1[0];
  73556. nStr = (serial_type-12) / 2;
  73557. if( (szHdr + nStr) > nKey1 ){
  73558. pPKey2->errCode = (u8)SQLITE_CORRUPT_BKPT;
  73559. return 0; /* Corruption */
  73560. }
  73561. nCmp = MIN( pPKey2->aMem[0].n, nStr );
  73562. res = memcmp(&aKey1[szHdr], pPKey2->aMem[0].z, nCmp);
  73563. if( res==0 ){
  73564. res = nStr - pPKey2->aMem[0].n;
  73565. if( res==0 ){
  73566. if( pPKey2->nField>1 ){
  73567. res = sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, pPKey2, 1);
  73568. }else{
  73569. res = pPKey2->default_rc;
  73570. pPKey2->eqSeen = 1;
  73571. }
  73572. }else if( res>0 ){
  73573. res = pPKey2->r2;
  73574. }else{
  73575. res = pPKey2->r1;
  73576. }
  73577. }else if( res>0 ){
  73578. res = pPKey2->r2;
  73579. }else{
  73580. res = pPKey2->r1;
  73581. }
  73582. }
  73583. assert( vdbeRecordCompareDebug(nKey1, pKey1, pPKey2, res)
  73584. || CORRUPT_DB
  73585. || pPKey2->pKeyInfo->db->mallocFailed
  73586. );
  73587. return res;
  73588. }
  73589. /*
  73590. ** Return a pointer to an sqlite3VdbeRecordCompare() compatible function
  73591. ** suitable for comparing serialized records to the unpacked record passed
  73592. ** as the only argument.
  73593. */
  73594. SQLITE_PRIVATE RecordCompare sqlite3VdbeFindCompare(UnpackedRecord *p){
  73595. /* varintRecordCompareInt() and varintRecordCompareString() both assume
  73596. ** that the size-of-header varint that occurs at the start of each record
  73597. ** fits in a single byte (i.e. is 127 or less). varintRecordCompareInt()
  73598. ** also assumes that it is safe to overread a buffer by at least the
  73599. ** maximum possible legal header size plus 8 bytes. Because there is
  73600. ** guaranteed to be at least 74 (but not 136) bytes of padding following each
  73601. ** buffer passed to varintRecordCompareInt() this makes it convenient to
  73602. ** limit the size of the header to 64 bytes in cases where the first field
  73603. ** is an integer.
  73604. **
  73605. ** The easiest way to enforce this limit is to consider only records with
  73606. ** 13 fields or less. If the first field is an integer, the maximum legal
  73607. ** header size is (12*5 + 1 + 1) bytes. */
  73608. if( p->pKeyInfo->nAllField<=13 ){
  73609. int flags = p->aMem[0].flags;
  73610. if( p->pKeyInfo->aSortOrder[0] ){
  73611. p->r1 = 1;
  73612. p->r2 = -1;
  73613. }else{
  73614. p->r1 = -1;
  73615. p->r2 = 1;
  73616. }
  73617. if( (flags & MEM_Int) ){
  73618. return vdbeRecordCompareInt;
  73619. }
  73620. testcase( flags & MEM_Real );
  73621. testcase( flags & MEM_Null );
  73622. testcase( flags & MEM_Blob );
  73623. if( (flags & (MEM_Real|MEM_Null|MEM_Blob))==0 && p->pKeyInfo->aColl[0]==0 ){
  73624. assert( flags & MEM_Str );
  73625. return vdbeRecordCompareString;
  73626. }
  73627. }
  73628. return sqlite3VdbeRecordCompare;
  73629. }
  73630. /*
  73631. ** pCur points at an index entry created using the OP_MakeRecord opcode.
  73632. ** Read the rowid (the last field in the record) and store it in *rowid.
  73633. ** Return SQLITE_OK if everything works, or an error code otherwise.
  73634. **
  73635. ** pCur might be pointing to text obtained from a corrupt database file.
  73636. ** So the content cannot be trusted. Do appropriate checks on the content.
  73637. */
  73638. SQLITE_PRIVATE int sqlite3VdbeIdxRowid(sqlite3 *db, BtCursor *pCur, i64 *rowid){
  73639. i64 nCellKey = 0;
  73640. int rc;
  73641. u32 szHdr; /* Size of the header */
  73642. u32 typeRowid; /* Serial type of the rowid */
  73643. u32 lenRowid; /* Size of the rowid */
  73644. Mem m, v;
  73645. /* Get the size of the index entry. Only indices entries of less
  73646. ** than 2GiB are support - anything large must be database corruption.
  73647. ** Any corruption is detected in sqlite3BtreeParseCellPtr(), though, so
  73648. ** this code can safely assume that nCellKey is 32-bits
  73649. */
  73650. assert( sqlite3BtreeCursorIsValid(pCur) );
  73651. nCellKey = sqlite3BtreePayloadSize(pCur);
  73652. assert( (nCellKey & SQLITE_MAX_U32)==(u64)nCellKey );
  73653. /* Read in the complete content of the index entry */
  73654. sqlite3VdbeMemInit(&m, db, 0);
  73655. rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, &m);
  73656. if( rc ){
  73657. return rc;
  73658. }
  73659. /* The index entry must begin with a header size */
  73660. (void)getVarint32((u8*)m.z, szHdr);
  73661. testcase( szHdr==3 );
  73662. testcase( szHdr==m.n );
  73663. if( unlikely(szHdr<3 || (int)szHdr>m.n) ){
  73664. goto idx_rowid_corruption;
  73665. }
  73666. /* The last field of the index should be an integer - the ROWID.
  73667. ** Verify that the last entry really is an integer. */
  73668. (void)getVarint32((u8*)&m.z[szHdr-1], typeRowid);
  73669. testcase( typeRowid==1 );
  73670. testcase( typeRowid==2 );
  73671. testcase( typeRowid==3 );
  73672. testcase( typeRowid==4 );
  73673. testcase( typeRowid==5 );
  73674. testcase( typeRowid==6 );
  73675. testcase( typeRowid==8 );
  73676. testcase( typeRowid==9 );
  73677. if( unlikely(typeRowid<1 || typeRowid>9 || typeRowid==7) ){
  73678. goto idx_rowid_corruption;
  73679. }
  73680. lenRowid = sqlite3SmallTypeSizes[typeRowid];
  73681. testcase( (u32)m.n==szHdr+lenRowid );
  73682. if( unlikely((u32)m.n<szHdr+lenRowid) ){
  73683. goto idx_rowid_corruption;
  73684. }
  73685. /* Fetch the integer off the end of the index record */
  73686. sqlite3VdbeSerialGet((u8*)&m.z[m.n-lenRowid], typeRowid, &v);
  73687. *rowid = v.u.i;
  73688. sqlite3VdbeMemRelease(&m);
  73689. return SQLITE_OK;
  73690. /* Jump here if database corruption is detected after m has been
  73691. ** allocated. Free the m object and return SQLITE_CORRUPT. */
  73692. idx_rowid_corruption:
  73693. testcase( m.szMalloc!=0 );
  73694. sqlite3VdbeMemRelease(&m);
  73695. return SQLITE_CORRUPT_BKPT;
  73696. }
  73697. /*
  73698. ** Compare the key of the index entry that cursor pC is pointing to against
  73699. ** the key string in pUnpacked. Write into *pRes a number
  73700. ** that is negative, zero, or positive if pC is less than, equal to,
  73701. ** or greater than pUnpacked. Return SQLITE_OK on success.
  73702. **
  73703. ** pUnpacked is either created without a rowid or is truncated so that it
  73704. ** omits the rowid at the end. The rowid at the end of the index entry
  73705. ** is ignored as well. Hence, this routine only compares the prefixes
  73706. ** of the keys prior to the final rowid, not the entire key.
  73707. */
  73708. SQLITE_PRIVATE int sqlite3VdbeIdxKeyCompare(
  73709. sqlite3 *db, /* Database connection */
  73710. VdbeCursor *pC, /* The cursor to compare against */
  73711. UnpackedRecord *pUnpacked, /* Unpacked version of key */
  73712. int *res /* Write the comparison result here */
  73713. ){
  73714. i64 nCellKey = 0;
  73715. int rc;
  73716. BtCursor *pCur;
  73717. Mem m;
  73718. assert( pC->eCurType==CURTYPE_BTREE );
  73719. pCur = pC->uc.pCursor;
  73720. assert( sqlite3BtreeCursorIsValid(pCur) );
  73721. nCellKey = sqlite3BtreePayloadSize(pCur);
  73722. /* nCellKey will always be between 0 and 0xffffffff because of the way
  73723. ** that btreeParseCellPtr() and sqlite3GetVarint32() are implemented */
  73724. if( nCellKey<=0 || nCellKey>0x7fffffff ){
  73725. *res = 0;
  73726. return SQLITE_CORRUPT_BKPT;
  73727. }
  73728. sqlite3VdbeMemInit(&m, db, 0);
  73729. rc = sqlite3VdbeMemFromBtree(pCur, 0, (u32)nCellKey, &m);
  73730. if( rc ){
  73731. return rc;
  73732. }
  73733. *res = sqlite3VdbeRecordCompare(m.n, m.z, pUnpacked);
  73734. sqlite3VdbeMemRelease(&m);
  73735. return SQLITE_OK;
  73736. }
  73737. /*
  73738. ** This routine sets the value to be returned by subsequent calls to
  73739. ** sqlite3_changes() on the database handle 'db'.
  73740. */
  73741. SQLITE_PRIVATE void sqlite3VdbeSetChanges(sqlite3 *db, int nChange){
  73742. assert( sqlite3_mutex_held(db->mutex) );
  73743. db->nChange = nChange;
  73744. db->nTotalChange += nChange;
  73745. }
  73746. /*
  73747. ** Set a flag in the vdbe to update the change counter when it is finalised
  73748. ** or reset.
  73749. */
  73750. SQLITE_PRIVATE void sqlite3VdbeCountChanges(Vdbe *v){
  73751. v->changeCntOn = 1;
  73752. }
  73753. /*
  73754. ** Mark every prepared statement associated with a database connection
  73755. ** as expired.
  73756. **
  73757. ** An expired statement means that recompilation of the statement is
  73758. ** recommend. Statements expire when things happen that make their
  73759. ** programs obsolete. Removing user-defined functions or collating
  73760. ** sequences, or changing an authorization function are the types of
  73761. ** things that make prepared statements obsolete.
  73762. */
  73763. SQLITE_PRIVATE void sqlite3ExpirePreparedStatements(sqlite3 *db){
  73764. Vdbe *p;
  73765. for(p = db->pVdbe; p; p=p->pNext){
  73766. p->expired = 1;
  73767. }
  73768. }
  73769. /*
  73770. ** Return the database associated with the Vdbe.
  73771. */
  73772. SQLITE_PRIVATE sqlite3 *sqlite3VdbeDb(Vdbe *v){
  73773. return v->db;
  73774. }
  73775. /*
  73776. ** Return the SQLITE_PREPARE flags for a Vdbe.
  73777. */
  73778. SQLITE_PRIVATE u8 sqlite3VdbePrepareFlags(Vdbe *v){
  73779. return v->prepFlags;
  73780. }
  73781. /*
  73782. ** Return a pointer to an sqlite3_value structure containing the value bound
  73783. ** parameter iVar of VM v. Except, if the value is an SQL NULL, return
  73784. ** 0 instead. Unless it is NULL, apply affinity aff (one of the SQLITE_AFF_*
  73785. ** constants) to the value before returning it.
  73786. **
  73787. ** The returned value must be freed by the caller using sqlite3ValueFree().
  73788. */
  73789. SQLITE_PRIVATE sqlite3_value *sqlite3VdbeGetBoundValue(Vdbe *v, int iVar, u8 aff){
  73790. assert( iVar>0 );
  73791. if( v ){
  73792. Mem *pMem = &v->aVar[iVar-1];
  73793. assert( (v->db->flags & SQLITE_EnableQPSG)==0 );
  73794. if( 0==(pMem->flags & MEM_Null) ){
  73795. sqlite3_value *pRet = sqlite3ValueNew(v->db);
  73796. if( pRet ){
  73797. sqlite3VdbeMemCopy((Mem *)pRet, pMem);
  73798. sqlite3ValueApplyAffinity(pRet, aff, SQLITE_UTF8);
  73799. }
  73800. return pRet;
  73801. }
  73802. }
  73803. return 0;
  73804. }
  73805. /*
  73806. ** Configure SQL variable iVar so that binding a new value to it signals
  73807. ** to sqlite3_reoptimize() that re-preparing the statement may result
  73808. ** in a better query plan.
  73809. */
  73810. SQLITE_PRIVATE void sqlite3VdbeSetVarmask(Vdbe *v, int iVar){
  73811. assert( iVar>0 );
  73812. assert( (v->db->flags & SQLITE_EnableQPSG)==0 );
  73813. if( iVar>=32 ){
  73814. v->expmask |= 0x80000000;
  73815. }else{
  73816. v->expmask |= ((u32)1 << (iVar-1));
  73817. }
  73818. }
  73819. /*
  73820. ** Cause a function to throw an error if it was call from OP_PureFunc
  73821. ** rather than OP_Function.
  73822. **
  73823. ** OP_PureFunc means that the function must be deterministic, and should
  73824. ** throw an error if it is given inputs that would make it non-deterministic.
  73825. ** This routine is invoked by date/time functions that use non-deterministic
  73826. ** features such as 'now'.
  73827. */
  73828. SQLITE_PRIVATE int sqlite3NotPureFunc(sqlite3_context *pCtx){
  73829. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  73830. if( pCtx->pVdbe==0 ) return 1;
  73831. #endif
  73832. if( pCtx->pVdbe->aOp[pCtx->iOp].opcode==OP_PureFunc ){
  73833. sqlite3_result_error(pCtx,
  73834. "non-deterministic function in index expression or CHECK constraint",
  73835. -1);
  73836. return 0;
  73837. }
  73838. return 1;
  73839. }
  73840. #ifndef SQLITE_OMIT_VIRTUALTABLE
  73841. /*
  73842. ** Transfer error message text from an sqlite3_vtab.zErrMsg (text stored
  73843. ** in memory obtained from sqlite3_malloc) into a Vdbe.zErrMsg (text stored
  73844. ** in memory obtained from sqlite3DbMalloc).
  73845. */
  73846. SQLITE_PRIVATE void sqlite3VtabImportErrmsg(Vdbe *p, sqlite3_vtab *pVtab){
  73847. if( pVtab->zErrMsg ){
  73848. sqlite3 *db = p->db;
  73849. sqlite3DbFree(db, p->zErrMsg);
  73850. p->zErrMsg = sqlite3DbStrDup(db, pVtab->zErrMsg);
  73851. sqlite3_free(pVtab->zErrMsg);
  73852. pVtab->zErrMsg = 0;
  73853. }
  73854. }
  73855. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  73856. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  73857. /*
  73858. ** If the second argument is not NULL, release any allocations associated
  73859. ** with the memory cells in the p->aMem[] array. Also free the UnpackedRecord
  73860. ** structure itself, using sqlite3DbFree().
  73861. **
  73862. ** This function is used to free UnpackedRecord structures allocated by
  73863. ** the vdbeUnpackRecord() function found in vdbeapi.c.
  73864. */
  73865. static void vdbeFreeUnpacked(sqlite3 *db, int nField, UnpackedRecord *p){
  73866. if( p ){
  73867. int i;
  73868. for(i=0; i<nField; i++){
  73869. Mem *pMem = &p->aMem[i];
  73870. if( pMem->zMalloc ) sqlite3VdbeMemRelease(pMem);
  73871. }
  73872. sqlite3DbFreeNN(db, p);
  73873. }
  73874. }
  73875. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  73876. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  73877. /*
  73878. ** Invoke the pre-update hook. If this is an UPDATE or DELETE pre-update call,
  73879. ** then cursor passed as the second argument should point to the row about
  73880. ** to be update or deleted. If the application calls sqlite3_preupdate_old(),
  73881. ** the required value will be read from the row the cursor points to.
  73882. */
  73883. SQLITE_PRIVATE void sqlite3VdbePreUpdateHook(
  73884. Vdbe *v, /* Vdbe pre-update hook is invoked by */
  73885. VdbeCursor *pCsr, /* Cursor to grab old.* values from */
  73886. int op, /* SQLITE_INSERT, UPDATE or DELETE */
  73887. const char *zDb, /* Database name */
  73888. Table *pTab, /* Modified table */
  73889. i64 iKey1, /* Initial key value */
  73890. int iReg /* Register for new.* record */
  73891. ){
  73892. sqlite3 *db = v->db;
  73893. i64 iKey2;
  73894. PreUpdate preupdate;
  73895. const char *zTbl = pTab->zName;
  73896. static const u8 fakeSortOrder = 0;
  73897. assert( db->pPreUpdate==0 );
  73898. memset(&preupdate, 0, sizeof(PreUpdate));
  73899. if( HasRowid(pTab)==0 ){
  73900. iKey1 = iKey2 = 0;
  73901. preupdate.pPk = sqlite3PrimaryKeyIndex(pTab);
  73902. }else{
  73903. if( op==SQLITE_UPDATE ){
  73904. iKey2 = v->aMem[iReg].u.i;
  73905. }else{
  73906. iKey2 = iKey1;
  73907. }
  73908. }
  73909. assert( pCsr->nField==pTab->nCol
  73910. || (pCsr->nField==pTab->nCol+1 && op==SQLITE_DELETE && iReg==-1)
  73911. );
  73912. preupdate.v = v;
  73913. preupdate.pCsr = pCsr;
  73914. preupdate.op = op;
  73915. preupdate.iNewReg = iReg;
  73916. preupdate.keyinfo.db = db;
  73917. preupdate.keyinfo.enc = ENC(db);
  73918. preupdate.keyinfo.nKeyField = pTab->nCol;
  73919. preupdate.keyinfo.aSortOrder = (u8*)&fakeSortOrder;
  73920. preupdate.iKey1 = iKey1;
  73921. preupdate.iKey2 = iKey2;
  73922. preupdate.pTab = pTab;
  73923. db->pPreUpdate = &preupdate;
  73924. db->xPreUpdateCallback(db->pPreUpdateArg, db, op, zDb, zTbl, iKey1, iKey2);
  73925. db->pPreUpdate = 0;
  73926. sqlite3DbFree(db, preupdate.aRecord);
  73927. vdbeFreeUnpacked(db, preupdate.keyinfo.nKeyField+1, preupdate.pUnpacked);
  73928. vdbeFreeUnpacked(db, preupdate.keyinfo.nKeyField+1, preupdate.pNewUnpacked);
  73929. if( preupdate.aNew ){
  73930. int i;
  73931. for(i=0; i<pCsr->nField; i++){
  73932. sqlite3VdbeMemRelease(&preupdate.aNew[i]);
  73933. }
  73934. sqlite3DbFreeNN(db, preupdate.aNew);
  73935. }
  73936. }
  73937. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  73938. /************** End of vdbeaux.c *********************************************/
  73939. /************** Begin file vdbeapi.c *****************************************/
  73940. /*
  73941. ** 2004 May 26
  73942. **
  73943. ** The author disclaims copyright to this source code. In place of
  73944. ** a legal notice, here is a blessing:
  73945. **
  73946. ** May you do good and not evil.
  73947. ** May you find forgiveness for yourself and forgive others.
  73948. ** May you share freely, never taking more than you give.
  73949. **
  73950. *************************************************************************
  73951. **
  73952. ** This file contains code use to implement APIs that are part of the
  73953. ** VDBE.
  73954. */
  73955. /* #include "sqliteInt.h" */
  73956. /* #include "vdbeInt.h" */
  73957. #ifndef SQLITE_OMIT_DEPRECATED
  73958. /*
  73959. ** Return TRUE (non-zero) of the statement supplied as an argument needs
  73960. ** to be recompiled. A statement needs to be recompiled whenever the
  73961. ** execution environment changes in a way that would alter the program
  73962. ** that sqlite3_prepare() generates. For example, if new functions or
  73963. ** collating sequences are registered or if an authorizer function is
  73964. ** added or changed.
  73965. */
  73966. SQLITE_API int sqlite3_expired(sqlite3_stmt *pStmt){
  73967. Vdbe *p = (Vdbe*)pStmt;
  73968. return p==0 || p->expired;
  73969. }
  73970. #endif
  73971. /*
  73972. ** Check on a Vdbe to make sure it has not been finalized. Log
  73973. ** an error and return true if it has been finalized (or is otherwise
  73974. ** invalid). Return false if it is ok.
  73975. */
  73976. static int vdbeSafety(Vdbe *p){
  73977. if( p->db==0 ){
  73978. sqlite3_log(SQLITE_MISUSE, "API called with finalized prepared statement");
  73979. return 1;
  73980. }else{
  73981. return 0;
  73982. }
  73983. }
  73984. static int vdbeSafetyNotNull(Vdbe *p){
  73985. if( p==0 ){
  73986. sqlite3_log(SQLITE_MISUSE, "API called with NULL prepared statement");
  73987. return 1;
  73988. }else{
  73989. return vdbeSafety(p);
  73990. }
  73991. }
  73992. #ifndef SQLITE_OMIT_TRACE
  73993. /*
  73994. ** Invoke the profile callback. This routine is only called if we already
  73995. ** know that the profile callback is defined and needs to be invoked.
  73996. */
  73997. static SQLITE_NOINLINE void invokeProfileCallback(sqlite3 *db, Vdbe *p){
  73998. sqlite3_int64 iNow;
  73999. sqlite3_int64 iElapse;
  74000. assert( p->startTime>0 );
  74001. assert( db->xProfile!=0 || (db->mTrace & SQLITE_TRACE_PROFILE)!=0 );
  74002. assert( db->init.busy==0 );
  74003. assert( p->zSql!=0 );
  74004. sqlite3OsCurrentTimeInt64(db->pVfs, &iNow);
  74005. iElapse = (iNow - p->startTime)*1000000;
  74006. if( db->xProfile ){
  74007. db->xProfile(db->pProfileArg, p->zSql, iElapse);
  74008. }
  74009. if( db->mTrace & SQLITE_TRACE_PROFILE ){
  74010. db->xTrace(SQLITE_TRACE_PROFILE, db->pTraceArg, p, (void*)&iElapse);
  74011. }
  74012. p->startTime = 0;
  74013. }
  74014. /*
  74015. ** The checkProfileCallback(DB,P) macro checks to see if a profile callback
  74016. ** is needed, and it invokes the callback if it is needed.
  74017. */
  74018. # define checkProfileCallback(DB,P) \
  74019. if( ((P)->startTime)>0 ){ invokeProfileCallback(DB,P); }
  74020. #else
  74021. # define checkProfileCallback(DB,P) /*no-op*/
  74022. #endif
  74023. /*
  74024. ** The following routine destroys a virtual machine that is created by
  74025. ** the sqlite3_compile() routine. The integer returned is an SQLITE_
  74026. ** success/failure code that describes the result of executing the virtual
  74027. ** machine.
  74028. **
  74029. ** This routine sets the error code and string returned by
  74030. ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
  74031. */
  74032. SQLITE_API int sqlite3_finalize(sqlite3_stmt *pStmt){
  74033. int rc;
  74034. if( pStmt==0 ){
  74035. /* IMPLEMENTATION-OF: R-57228-12904 Invoking sqlite3_finalize() on a NULL
  74036. ** pointer is a harmless no-op. */
  74037. rc = SQLITE_OK;
  74038. }else{
  74039. Vdbe *v = (Vdbe*)pStmt;
  74040. sqlite3 *db = v->db;
  74041. if( vdbeSafety(v) ) return SQLITE_MISUSE_BKPT;
  74042. sqlite3_mutex_enter(db->mutex);
  74043. checkProfileCallback(db, v);
  74044. rc = sqlite3VdbeFinalize(v);
  74045. rc = sqlite3ApiExit(db, rc);
  74046. sqlite3LeaveMutexAndCloseZombie(db);
  74047. }
  74048. return rc;
  74049. }
  74050. /*
  74051. ** Terminate the current execution of an SQL statement and reset it
  74052. ** back to its starting state so that it can be reused. A success code from
  74053. ** the prior execution is returned.
  74054. **
  74055. ** This routine sets the error code and string returned by
  74056. ** sqlite3_errcode(), sqlite3_errmsg() and sqlite3_errmsg16().
  74057. */
  74058. SQLITE_API int sqlite3_reset(sqlite3_stmt *pStmt){
  74059. int rc;
  74060. if( pStmt==0 ){
  74061. rc = SQLITE_OK;
  74062. }else{
  74063. Vdbe *v = (Vdbe*)pStmt;
  74064. sqlite3 *db = v->db;
  74065. sqlite3_mutex_enter(db->mutex);
  74066. checkProfileCallback(db, v);
  74067. rc = sqlite3VdbeReset(v);
  74068. sqlite3VdbeRewind(v);
  74069. assert( (rc & (db->errMask))==rc );
  74070. rc = sqlite3ApiExit(db, rc);
  74071. sqlite3_mutex_leave(db->mutex);
  74072. }
  74073. return rc;
  74074. }
  74075. /*
  74076. ** Set all the parameters in the compiled SQL statement to NULL.
  74077. */
  74078. SQLITE_API int sqlite3_clear_bindings(sqlite3_stmt *pStmt){
  74079. int i;
  74080. int rc = SQLITE_OK;
  74081. Vdbe *p = (Vdbe*)pStmt;
  74082. #if SQLITE_THREADSAFE
  74083. sqlite3_mutex *mutex = ((Vdbe*)pStmt)->db->mutex;
  74084. #endif
  74085. sqlite3_mutex_enter(mutex);
  74086. for(i=0; i<p->nVar; i++){
  74087. sqlite3VdbeMemRelease(&p->aVar[i]);
  74088. p->aVar[i].flags = MEM_Null;
  74089. }
  74090. assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
  74091. if( p->expmask ){
  74092. p->expired = 1;
  74093. }
  74094. sqlite3_mutex_leave(mutex);
  74095. return rc;
  74096. }
  74097. /**************************** sqlite3_value_ *******************************
  74098. ** The following routines extract information from a Mem or sqlite3_value
  74099. ** structure.
  74100. */
  74101. SQLITE_API const void *sqlite3_value_blob(sqlite3_value *pVal){
  74102. Mem *p = (Mem*)pVal;
  74103. if( p->flags & (MEM_Blob|MEM_Str) ){
  74104. if( ExpandBlob(p)!=SQLITE_OK ){
  74105. assert( p->flags==MEM_Null && p->z==0 );
  74106. return 0;
  74107. }
  74108. p->flags |= MEM_Blob;
  74109. return p->n ? p->z : 0;
  74110. }else{
  74111. return sqlite3_value_text(pVal);
  74112. }
  74113. }
  74114. SQLITE_API int sqlite3_value_bytes(sqlite3_value *pVal){
  74115. return sqlite3ValueBytes(pVal, SQLITE_UTF8);
  74116. }
  74117. SQLITE_API int sqlite3_value_bytes16(sqlite3_value *pVal){
  74118. return sqlite3ValueBytes(pVal, SQLITE_UTF16NATIVE);
  74119. }
  74120. SQLITE_API double sqlite3_value_double(sqlite3_value *pVal){
  74121. return sqlite3VdbeRealValue((Mem*)pVal);
  74122. }
  74123. SQLITE_API int sqlite3_value_int(sqlite3_value *pVal){
  74124. return (int)sqlite3VdbeIntValue((Mem*)pVal);
  74125. }
  74126. SQLITE_API sqlite_int64 sqlite3_value_int64(sqlite3_value *pVal){
  74127. return sqlite3VdbeIntValue((Mem*)pVal);
  74128. }
  74129. SQLITE_API unsigned int sqlite3_value_subtype(sqlite3_value *pVal){
  74130. Mem *pMem = (Mem*)pVal;
  74131. return ((pMem->flags & MEM_Subtype) ? pMem->eSubtype : 0);
  74132. }
  74133. SQLITE_API void *sqlite3_value_pointer(sqlite3_value *pVal, const char *zPType){
  74134. Mem *p = (Mem*)pVal;
  74135. if( (p->flags&(MEM_TypeMask|MEM_Term|MEM_Subtype)) ==
  74136. (MEM_Null|MEM_Term|MEM_Subtype)
  74137. && zPType!=0
  74138. && p->eSubtype=='p'
  74139. && strcmp(p->u.zPType, zPType)==0
  74140. ){
  74141. return (void*)p->z;
  74142. }else{
  74143. return 0;
  74144. }
  74145. }
  74146. SQLITE_API const unsigned char *sqlite3_value_text(sqlite3_value *pVal){
  74147. return (const unsigned char *)sqlite3ValueText(pVal, SQLITE_UTF8);
  74148. }
  74149. #ifndef SQLITE_OMIT_UTF16
  74150. SQLITE_API const void *sqlite3_value_text16(sqlite3_value* pVal){
  74151. return sqlite3ValueText(pVal, SQLITE_UTF16NATIVE);
  74152. }
  74153. SQLITE_API const void *sqlite3_value_text16be(sqlite3_value *pVal){
  74154. return sqlite3ValueText(pVal, SQLITE_UTF16BE);
  74155. }
  74156. SQLITE_API const void *sqlite3_value_text16le(sqlite3_value *pVal){
  74157. return sqlite3ValueText(pVal, SQLITE_UTF16LE);
  74158. }
  74159. #endif /* SQLITE_OMIT_UTF16 */
  74160. /* EVIDENCE-OF: R-12793-43283 Every value in SQLite has one of five
  74161. ** fundamental datatypes: 64-bit signed integer 64-bit IEEE floating
  74162. ** point number string BLOB NULL
  74163. */
  74164. SQLITE_API int sqlite3_value_type(sqlite3_value* pVal){
  74165. static const u8 aType[] = {
  74166. SQLITE_BLOB, /* 0x00 */
  74167. SQLITE_NULL, /* 0x01 */
  74168. SQLITE_TEXT, /* 0x02 */
  74169. SQLITE_NULL, /* 0x03 */
  74170. SQLITE_INTEGER, /* 0x04 */
  74171. SQLITE_NULL, /* 0x05 */
  74172. SQLITE_INTEGER, /* 0x06 */
  74173. SQLITE_NULL, /* 0x07 */
  74174. SQLITE_FLOAT, /* 0x08 */
  74175. SQLITE_NULL, /* 0x09 */
  74176. SQLITE_FLOAT, /* 0x0a */
  74177. SQLITE_NULL, /* 0x0b */
  74178. SQLITE_INTEGER, /* 0x0c */
  74179. SQLITE_NULL, /* 0x0d */
  74180. SQLITE_INTEGER, /* 0x0e */
  74181. SQLITE_NULL, /* 0x0f */
  74182. SQLITE_BLOB, /* 0x10 */
  74183. SQLITE_NULL, /* 0x11 */
  74184. SQLITE_TEXT, /* 0x12 */
  74185. SQLITE_NULL, /* 0x13 */
  74186. SQLITE_INTEGER, /* 0x14 */
  74187. SQLITE_NULL, /* 0x15 */
  74188. SQLITE_INTEGER, /* 0x16 */
  74189. SQLITE_NULL, /* 0x17 */
  74190. SQLITE_FLOAT, /* 0x18 */
  74191. SQLITE_NULL, /* 0x19 */
  74192. SQLITE_FLOAT, /* 0x1a */
  74193. SQLITE_NULL, /* 0x1b */
  74194. SQLITE_INTEGER, /* 0x1c */
  74195. SQLITE_NULL, /* 0x1d */
  74196. SQLITE_INTEGER, /* 0x1e */
  74197. SQLITE_NULL, /* 0x1f */
  74198. };
  74199. return aType[pVal->flags&MEM_AffMask];
  74200. }
  74201. /* Return true if a parameter to xUpdate represents an unchanged column */
  74202. SQLITE_API int sqlite3_value_nochange(sqlite3_value *pVal){
  74203. return (pVal->flags&(MEM_Null|MEM_Zero))==(MEM_Null|MEM_Zero);
  74204. }
  74205. /* Make a copy of an sqlite3_value object
  74206. */
  74207. SQLITE_API sqlite3_value *sqlite3_value_dup(const sqlite3_value *pOrig){
  74208. sqlite3_value *pNew;
  74209. if( pOrig==0 ) return 0;
  74210. pNew = sqlite3_malloc( sizeof(*pNew) );
  74211. if( pNew==0 ) return 0;
  74212. memset(pNew, 0, sizeof(*pNew));
  74213. memcpy(pNew, pOrig, MEMCELLSIZE);
  74214. pNew->flags &= ~MEM_Dyn;
  74215. pNew->db = 0;
  74216. if( pNew->flags&(MEM_Str|MEM_Blob) ){
  74217. pNew->flags &= ~(MEM_Static|MEM_Dyn);
  74218. pNew->flags |= MEM_Ephem;
  74219. if( sqlite3VdbeMemMakeWriteable(pNew)!=SQLITE_OK ){
  74220. sqlite3ValueFree(pNew);
  74221. pNew = 0;
  74222. }
  74223. }
  74224. return pNew;
  74225. }
  74226. /* Destroy an sqlite3_value object previously obtained from
  74227. ** sqlite3_value_dup().
  74228. */
  74229. SQLITE_API void sqlite3_value_free(sqlite3_value *pOld){
  74230. sqlite3ValueFree(pOld);
  74231. }
  74232. /**************************** sqlite3_result_ *******************************
  74233. ** The following routines are used by user-defined functions to specify
  74234. ** the function result.
  74235. **
  74236. ** The setStrOrError() function calls sqlite3VdbeMemSetStr() to store the
  74237. ** result as a string or blob but if the string or blob is too large, it
  74238. ** then sets the error code to SQLITE_TOOBIG
  74239. **
  74240. ** The invokeValueDestructor(P,X) routine invokes destructor function X()
  74241. ** on value P is not going to be used and need to be destroyed.
  74242. */
  74243. static void setResultStrOrError(
  74244. sqlite3_context *pCtx, /* Function context */
  74245. const char *z, /* String pointer */
  74246. int n, /* Bytes in string, or negative */
  74247. u8 enc, /* Encoding of z. 0 for BLOBs */
  74248. void (*xDel)(void*) /* Destructor function */
  74249. ){
  74250. if( sqlite3VdbeMemSetStr(pCtx->pOut, z, n, enc, xDel)==SQLITE_TOOBIG ){
  74251. sqlite3_result_error_toobig(pCtx);
  74252. }
  74253. }
  74254. static int invokeValueDestructor(
  74255. const void *p, /* Value to destroy */
  74256. void (*xDel)(void*), /* The destructor */
  74257. sqlite3_context *pCtx /* Set a SQLITE_TOOBIG error if no NULL */
  74258. ){
  74259. assert( xDel!=SQLITE_DYNAMIC );
  74260. if( xDel==0 ){
  74261. /* noop */
  74262. }else if( xDel==SQLITE_TRANSIENT ){
  74263. /* noop */
  74264. }else{
  74265. xDel((void*)p);
  74266. }
  74267. if( pCtx ) sqlite3_result_error_toobig(pCtx);
  74268. return SQLITE_TOOBIG;
  74269. }
  74270. SQLITE_API void sqlite3_result_blob(
  74271. sqlite3_context *pCtx,
  74272. const void *z,
  74273. int n,
  74274. void (*xDel)(void *)
  74275. ){
  74276. assert( n>=0 );
  74277. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74278. setResultStrOrError(pCtx, z, n, 0, xDel);
  74279. }
  74280. SQLITE_API void sqlite3_result_blob64(
  74281. sqlite3_context *pCtx,
  74282. const void *z,
  74283. sqlite3_uint64 n,
  74284. void (*xDel)(void *)
  74285. ){
  74286. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74287. assert( xDel!=SQLITE_DYNAMIC );
  74288. if( n>0x7fffffff ){
  74289. (void)invokeValueDestructor(z, xDel, pCtx);
  74290. }else{
  74291. setResultStrOrError(pCtx, z, (int)n, 0, xDel);
  74292. }
  74293. }
  74294. SQLITE_API void sqlite3_result_double(sqlite3_context *pCtx, double rVal){
  74295. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74296. sqlite3VdbeMemSetDouble(pCtx->pOut, rVal);
  74297. }
  74298. SQLITE_API void sqlite3_result_error(sqlite3_context *pCtx, const char *z, int n){
  74299. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74300. pCtx->isError = SQLITE_ERROR;
  74301. sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF8, SQLITE_TRANSIENT);
  74302. }
  74303. #ifndef SQLITE_OMIT_UTF16
  74304. SQLITE_API void sqlite3_result_error16(sqlite3_context *pCtx, const void *z, int n){
  74305. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74306. pCtx->isError = SQLITE_ERROR;
  74307. sqlite3VdbeMemSetStr(pCtx->pOut, z, n, SQLITE_UTF16NATIVE, SQLITE_TRANSIENT);
  74308. }
  74309. #endif
  74310. SQLITE_API void sqlite3_result_int(sqlite3_context *pCtx, int iVal){
  74311. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74312. sqlite3VdbeMemSetInt64(pCtx->pOut, (i64)iVal);
  74313. }
  74314. SQLITE_API void sqlite3_result_int64(sqlite3_context *pCtx, i64 iVal){
  74315. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74316. sqlite3VdbeMemSetInt64(pCtx->pOut, iVal);
  74317. }
  74318. SQLITE_API void sqlite3_result_null(sqlite3_context *pCtx){
  74319. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74320. sqlite3VdbeMemSetNull(pCtx->pOut);
  74321. }
  74322. SQLITE_API void sqlite3_result_pointer(
  74323. sqlite3_context *pCtx,
  74324. void *pPtr,
  74325. const char *zPType,
  74326. void (*xDestructor)(void*)
  74327. ){
  74328. Mem *pOut = pCtx->pOut;
  74329. assert( sqlite3_mutex_held(pOut->db->mutex) );
  74330. sqlite3VdbeMemRelease(pOut);
  74331. pOut->flags = MEM_Null;
  74332. sqlite3VdbeMemSetPointer(pOut, pPtr, zPType, xDestructor);
  74333. }
  74334. SQLITE_API void sqlite3_result_subtype(sqlite3_context *pCtx, unsigned int eSubtype){
  74335. Mem *pOut = pCtx->pOut;
  74336. assert( sqlite3_mutex_held(pOut->db->mutex) );
  74337. pOut->eSubtype = eSubtype & 0xff;
  74338. pOut->flags |= MEM_Subtype;
  74339. }
  74340. SQLITE_API void sqlite3_result_text(
  74341. sqlite3_context *pCtx,
  74342. const char *z,
  74343. int n,
  74344. void (*xDel)(void *)
  74345. ){
  74346. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74347. setResultStrOrError(pCtx, z, n, SQLITE_UTF8, xDel);
  74348. }
  74349. SQLITE_API void sqlite3_result_text64(
  74350. sqlite3_context *pCtx,
  74351. const char *z,
  74352. sqlite3_uint64 n,
  74353. void (*xDel)(void *),
  74354. unsigned char enc
  74355. ){
  74356. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74357. assert( xDel!=SQLITE_DYNAMIC );
  74358. if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
  74359. if( n>0x7fffffff ){
  74360. (void)invokeValueDestructor(z, xDel, pCtx);
  74361. }else{
  74362. setResultStrOrError(pCtx, z, (int)n, enc, xDel);
  74363. }
  74364. }
  74365. #ifndef SQLITE_OMIT_UTF16
  74366. SQLITE_API void sqlite3_result_text16(
  74367. sqlite3_context *pCtx,
  74368. const void *z,
  74369. int n,
  74370. void (*xDel)(void *)
  74371. ){
  74372. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74373. setResultStrOrError(pCtx, z, n, SQLITE_UTF16NATIVE, xDel);
  74374. }
  74375. SQLITE_API void sqlite3_result_text16be(
  74376. sqlite3_context *pCtx,
  74377. const void *z,
  74378. int n,
  74379. void (*xDel)(void *)
  74380. ){
  74381. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74382. setResultStrOrError(pCtx, z, n, SQLITE_UTF16BE, xDel);
  74383. }
  74384. SQLITE_API void sqlite3_result_text16le(
  74385. sqlite3_context *pCtx,
  74386. const void *z,
  74387. int n,
  74388. void (*xDel)(void *)
  74389. ){
  74390. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74391. setResultStrOrError(pCtx, z, n, SQLITE_UTF16LE, xDel);
  74392. }
  74393. #endif /* SQLITE_OMIT_UTF16 */
  74394. SQLITE_API void sqlite3_result_value(sqlite3_context *pCtx, sqlite3_value *pValue){
  74395. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74396. sqlite3VdbeMemCopy(pCtx->pOut, pValue);
  74397. }
  74398. SQLITE_API void sqlite3_result_zeroblob(sqlite3_context *pCtx, int n){
  74399. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74400. sqlite3VdbeMemSetZeroBlob(pCtx->pOut, n);
  74401. }
  74402. SQLITE_API int sqlite3_result_zeroblob64(sqlite3_context *pCtx, u64 n){
  74403. Mem *pOut = pCtx->pOut;
  74404. assert( sqlite3_mutex_held(pOut->db->mutex) );
  74405. if( n>(u64)pOut->db->aLimit[SQLITE_LIMIT_LENGTH] ){
  74406. return SQLITE_TOOBIG;
  74407. }
  74408. sqlite3VdbeMemSetZeroBlob(pCtx->pOut, (int)n);
  74409. return SQLITE_OK;
  74410. }
  74411. SQLITE_API void sqlite3_result_error_code(sqlite3_context *pCtx, int errCode){
  74412. pCtx->isError = errCode ? errCode : -1;
  74413. #ifdef SQLITE_DEBUG
  74414. if( pCtx->pVdbe ) pCtx->pVdbe->rcApp = errCode;
  74415. #endif
  74416. if( pCtx->pOut->flags & MEM_Null ){
  74417. sqlite3VdbeMemSetStr(pCtx->pOut, sqlite3ErrStr(errCode), -1,
  74418. SQLITE_UTF8, SQLITE_STATIC);
  74419. }
  74420. }
  74421. /* Force an SQLITE_TOOBIG error. */
  74422. SQLITE_API void sqlite3_result_error_toobig(sqlite3_context *pCtx){
  74423. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74424. pCtx->isError = SQLITE_TOOBIG;
  74425. sqlite3VdbeMemSetStr(pCtx->pOut, "string or blob too big", -1,
  74426. SQLITE_UTF8, SQLITE_STATIC);
  74427. }
  74428. /* An SQLITE_NOMEM error. */
  74429. SQLITE_API void sqlite3_result_error_nomem(sqlite3_context *pCtx){
  74430. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74431. sqlite3VdbeMemSetNull(pCtx->pOut);
  74432. pCtx->isError = SQLITE_NOMEM_BKPT;
  74433. sqlite3OomFault(pCtx->pOut->db);
  74434. }
  74435. /*
  74436. ** This function is called after a transaction has been committed. It
  74437. ** invokes callbacks registered with sqlite3_wal_hook() as required.
  74438. */
  74439. static int doWalCallbacks(sqlite3 *db){
  74440. int rc = SQLITE_OK;
  74441. #ifndef SQLITE_OMIT_WAL
  74442. int i;
  74443. for(i=0; i<db->nDb; i++){
  74444. Btree *pBt = db->aDb[i].pBt;
  74445. if( pBt ){
  74446. int nEntry;
  74447. sqlite3BtreeEnter(pBt);
  74448. nEntry = sqlite3PagerWalCallback(sqlite3BtreePager(pBt));
  74449. sqlite3BtreeLeave(pBt);
  74450. if( nEntry>0 && db->xWalCallback && rc==SQLITE_OK ){
  74451. rc = db->xWalCallback(db->pWalArg, db, db->aDb[i].zDbSName, nEntry);
  74452. }
  74453. }
  74454. }
  74455. #endif
  74456. return rc;
  74457. }
  74458. /*
  74459. ** Execute the statement pStmt, either until a row of data is ready, the
  74460. ** statement is completely executed or an error occurs.
  74461. **
  74462. ** This routine implements the bulk of the logic behind the sqlite_step()
  74463. ** API. The only thing omitted is the automatic recompile if a
  74464. ** schema change has occurred. That detail is handled by the
  74465. ** outer sqlite3_step() wrapper procedure.
  74466. */
  74467. static int sqlite3Step(Vdbe *p){
  74468. sqlite3 *db;
  74469. int rc;
  74470. assert(p);
  74471. if( p->magic!=VDBE_MAGIC_RUN ){
  74472. /* We used to require that sqlite3_reset() be called before retrying
  74473. ** sqlite3_step() after any error or after SQLITE_DONE. But beginning
  74474. ** with version 3.7.0, we changed this so that sqlite3_reset() would
  74475. ** be called automatically instead of throwing the SQLITE_MISUSE error.
  74476. ** This "automatic-reset" change is not technically an incompatibility,
  74477. ** since any application that receives an SQLITE_MISUSE is broken by
  74478. ** definition.
  74479. **
  74480. ** Nevertheless, some published applications that were originally written
  74481. ** for version 3.6.23 or earlier do in fact depend on SQLITE_MISUSE
  74482. ** returns, and those were broken by the automatic-reset change. As a
  74483. ** a work-around, the SQLITE_OMIT_AUTORESET compile-time restores the
  74484. ** legacy behavior of returning SQLITE_MISUSE for cases where the
  74485. ** previous sqlite3_step() returned something other than a SQLITE_LOCKED
  74486. ** or SQLITE_BUSY error.
  74487. */
  74488. #ifdef SQLITE_OMIT_AUTORESET
  74489. if( (rc = p->rc&0xff)==SQLITE_BUSY || rc==SQLITE_LOCKED ){
  74490. sqlite3_reset((sqlite3_stmt*)p);
  74491. }else{
  74492. return SQLITE_MISUSE_BKPT;
  74493. }
  74494. #else
  74495. sqlite3_reset((sqlite3_stmt*)p);
  74496. #endif
  74497. }
  74498. /* Check that malloc() has not failed. If it has, return early. */
  74499. db = p->db;
  74500. if( db->mallocFailed ){
  74501. p->rc = SQLITE_NOMEM;
  74502. return SQLITE_NOMEM_BKPT;
  74503. }
  74504. if( p->pc<=0 && p->expired ){
  74505. p->rc = SQLITE_SCHEMA;
  74506. rc = SQLITE_ERROR;
  74507. goto end_of_step;
  74508. }
  74509. if( p->pc<0 ){
  74510. /* If there are no other statements currently running, then
  74511. ** reset the interrupt flag. This prevents a call to sqlite3_interrupt
  74512. ** from interrupting a statement that has not yet started.
  74513. */
  74514. if( db->nVdbeActive==0 ){
  74515. db->u1.isInterrupted = 0;
  74516. }
  74517. assert( db->nVdbeWrite>0 || db->autoCommit==0
  74518. || (db->nDeferredCons==0 && db->nDeferredImmCons==0)
  74519. );
  74520. #ifndef SQLITE_OMIT_TRACE
  74521. if( (db->xProfile || (db->mTrace & SQLITE_TRACE_PROFILE)!=0)
  74522. && !db->init.busy && p->zSql ){
  74523. sqlite3OsCurrentTimeInt64(db->pVfs, &p->startTime);
  74524. }else{
  74525. assert( p->startTime==0 );
  74526. }
  74527. #endif
  74528. db->nVdbeActive++;
  74529. if( p->readOnly==0 ) db->nVdbeWrite++;
  74530. if( p->bIsReader ) db->nVdbeRead++;
  74531. p->pc = 0;
  74532. }
  74533. #ifdef SQLITE_DEBUG
  74534. p->rcApp = SQLITE_OK;
  74535. #endif
  74536. #ifndef SQLITE_OMIT_EXPLAIN
  74537. if( p->explain ){
  74538. rc = sqlite3VdbeList(p);
  74539. }else
  74540. #endif /* SQLITE_OMIT_EXPLAIN */
  74541. {
  74542. db->nVdbeExec++;
  74543. rc = sqlite3VdbeExec(p);
  74544. db->nVdbeExec--;
  74545. }
  74546. #ifndef SQLITE_OMIT_TRACE
  74547. /* If the statement completed successfully, invoke the profile callback */
  74548. if( rc!=SQLITE_ROW ) checkProfileCallback(db, p);
  74549. #endif
  74550. if( rc==SQLITE_DONE && db->autoCommit ){
  74551. assert( p->rc==SQLITE_OK );
  74552. p->rc = doWalCallbacks(db);
  74553. if( p->rc!=SQLITE_OK ){
  74554. rc = SQLITE_ERROR;
  74555. }
  74556. }
  74557. db->errCode = rc;
  74558. if( SQLITE_NOMEM==sqlite3ApiExit(p->db, p->rc) ){
  74559. p->rc = SQLITE_NOMEM_BKPT;
  74560. }
  74561. end_of_step:
  74562. /* At this point local variable rc holds the value that should be
  74563. ** returned if this statement was compiled using the legacy
  74564. ** sqlite3_prepare() interface. According to the docs, this can only
  74565. ** be one of the values in the first assert() below. Variable p->rc
  74566. ** contains the value that would be returned if sqlite3_finalize()
  74567. ** were called on statement p.
  74568. */
  74569. assert( rc==SQLITE_ROW || rc==SQLITE_DONE || rc==SQLITE_ERROR
  74570. || (rc&0xff)==SQLITE_BUSY || rc==SQLITE_MISUSE
  74571. );
  74572. assert( (p->rc!=SQLITE_ROW && p->rc!=SQLITE_DONE) || p->rc==p->rcApp );
  74573. if( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0
  74574. && rc!=SQLITE_ROW
  74575. && rc!=SQLITE_DONE
  74576. ){
  74577. /* If this statement was prepared using saved SQL and an
  74578. ** error has occurred, then return the error code in p->rc to the
  74579. ** caller. Set the error code in the database handle to the same value.
  74580. */
  74581. rc = sqlite3VdbeTransferError(p);
  74582. }
  74583. return (rc&db->errMask);
  74584. }
  74585. /*
  74586. ** This is the top-level implementation of sqlite3_step(). Call
  74587. ** sqlite3Step() to do most of the work. If a schema error occurs,
  74588. ** call sqlite3Reprepare() and try again.
  74589. */
  74590. SQLITE_API int sqlite3_step(sqlite3_stmt *pStmt){
  74591. int rc = SQLITE_OK; /* Result from sqlite3Step() */
  74592. Vdbe *v = (Vdbe*)pStmt; /* the prepared statement */
  74593. int cnt = 0; /* Counter to prevent infinite loop of reprepares */
  74594. sqlite3 *db; /* The database connection */
  74595. if( vdbeSafetyNotNull(v) ){
  74596. return SQLITE_MISUSE_BKPT;
  74597. }
  74598. db = v->db;
  74599. sqlite3_mutex_enter(db->mutex);
  74600. v->doingRerun = 0;
  74601. while( (rc = sqlite3Step(v))==SQLITE_SCHEMA
  74602. && cnt++ < SQLITE_MAX_SCHEMA_RETRY ){
  74603. int savedPc = v->pc;
  74604. rc = sqlite3Reprepare(v);
  74605. if( rc!=SQLITE_OK ){
  74606. /* This case occurs after failing to recompile an sql statement.
  74607. ** The error message from the SQL compiler has already been loaded
  74608. ** into the database handle. This block copies the error message
  74609. ** from the database handle into the statement and sets the statement
  74610. ** program counter to 0 to ensure that when the statement is
  74611. ** finalized or reset the parser error message is available via
  74612. ** sqlite3_errmsg() and sqlite3_errcode().
  74613. */
  74614. const char *zErr = (const char *)sqlite3_value_text(db->pErr);
  74615. sqlite3DbFree(db, v->zErrMsg);
  74616. if( !db->mallocFailed ){
  74617. v->zErrMsg = sqlite3DbStrDup(db, zErr);
  74618. v->rc = rc = sqlite3ApiExit(db, rc);
  74619. } else {
  74620. v->zErrMsg = 0;
  74621. v->rc = rc = SQLITE_NOMEM_BKPT;
  74622. }
  74623. break;
  74624. }
  74625. sqlite3_reset(pStmt);
  74626. if( savedPc>=0 ) v->doingRerun = 1;
  74627. assert( v->expired==0 );
  74628. }
  74629. sqlite3_mutex_leave(db->mutex);
  74630. return rc;
  74631. }
  74632. /*
  74633. ** Extract the user data from a sqlite3_context structure and return a
  74634. ** pointer to it.
  74635. */
  74636. SQLITE_API void *sqlite3_user_data(sqlite3_context *p){
  74637. assert( p && p->pFunc );
  74638. return p->pFunc->pUserData;
  74639. }
  74640. /*
  74641. ** Extract the user data from a sqlite3_context structure and return a
  74642. ** pointer to it.
  74643. **
  74644. ** IMPLEMENTATION-OF: R-46798-50301 The sqlite3_context_db_handle() interface
  74645. ** returns a copy of the pointer to the database connection (the 1st
  74646. ** parameter) of the sqlite3_create_function() and
  74647. ** sqlite3_create_function16() routines that originally registered the
  74648. ** application defined function.
  74649. */
  74650. SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context *p){
  74651. assert( p && p->pOut );
  74652. return p->pOut->db;
  74653. }
  74654. /*
  74655. ** If this routine is invoked from within an xColumn method of a virtual
  74656. ** table, then it returns true if and only if the the call is during an
  74657. ** UPDATE operation and the value of the column will not be modified
  74658. ** by the UPDATE.
  74659. **
  74660. ** If this routine is called from any context other than within the
  74661. ** xColumn method of a virtual table, then the return value is meaningless
  74662. ** and arbitrary.
  74663. **
  74664. ** Virtual table implements might use this routine to optimize their
  74665. ** performance by substituting a NULL result, or some other light-weight
  74666. ** value, as a signal to the xUpdate routine that the column is unchanged.
  74667. */
  74668. SQLITE_API int sqlite3_vtab_nochange(sqlite3_context *p){
  74669. assert( p );
  74670. return sqlite3_value_nochange(p->pOut);
  74671. }
  74672. /*
  74673. ** Return the current time for a statement. If the current time
  74674. ** is requested more than once within the same run of a single prepared
  74675. ** statement, the exact same time is returned for each invocation regardless
  74676. ** of the amount of time that elapses between invocations. In other words,
  74677. ** the time returned is always the time of the first call.
  74678. */
  74679. SQLITE_PRIVATE sqlite3_int64 sqlite3StmtCurrentTime(sqlite3_context *p){
  74680. int rc;
  74681. #ifndef SQLITE_ENABLE_STAT3_OR_STAT4
  74682. sqlite3_int64 *piTime = &p->pVdbe->iCurrentTime;
  74683. assert( p->pVdbe!=0 );
  74684. #else
  74685. sqlite3_int64 iTime = 0;
  74686. sqlite3_int64 *piTime = p->pVdbe!=0 ? &p->pVdbe->iCurrentTime : &iTime;
  74687. #endif
  74688. if( *piTime==0 ){
  74689. rc = sqlite3OsCurrentTimeInt64(p->pOut->db->pVfs, piTime);
  74690. if( rc ) *piTime = 0;
  74691. }
  74692. return *piTime;
  74693. }
  74694. /*
  74695. ** The following is the implementation of an SQL function that always
  74696. ** fails with an error message stating that the function is used in the
  74697. ** wrong context. The sqlite3_overload_function() API might construct
  74698. ** SQL function that use this routine so that the functions will exist
  74699. ** for name resolution but are actually overloaded by the xFindFunction
  74700. ** method of virtual tables.
  74701. */
  74702. SQLITE_PRIVATE void sqlite3InvalidFunction(
  74703. sqlite3_context *context, /* The function calling context */
  74704. int NotUsed, /* Number of arguments to the function */
  74705. sqlite3_value **NotUsed2 /* Value of each argument */
  74706. ){
  74707. const char *zName = context->pFunc->zName;
  74708. char *zErr;
  74709. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  74710. zErr = sqlite3_mprintf(
  74711. "unable to use function %s in the requested context", zName);
  74712. sqlite3_result_error(context, zErr, -1);
  74713. sqlite3_free(zErr);
  74714. }
  74715. /*
  74716. ** Create a new aggregate context for p and return a pointer to
  74717. ** its pMem->z element.
  74718. */
  74719. static SQLITE_NOINLINE void *createAggContext(sqlite3_context *p, int nByte){
  74720. Mem *pMem = p->pMem;
  74721. assert( (pMem->flags & MEM_Agg)==0 );
  74722. if( nByte<=0 ){
  74723. sqlite3VdbeMemSetNull(pMem);
  74724. pMem->z = 0;
  74725. }else{
  74726. sqlite3VdbeMemClearAndResize(pMem, nByte);
  74727. pMem->flags = MEM_Agg;
  74728. pMem->u.pDef = p->pFunc;
  74729. if( pMem->z ){
  74730. memset(pMem->z, 0, nByte);
  74731. }
  74732. }
  74733. return (void*)pMem->z;
  74734. }
  74735. /*
  74736. ** Allocate or return the aggregate context for a user function. A new
  74737. ** context is allocated on the first call. Subsequent calls return the
  74738. ** same context that was returned on prior calls.
  74739. */
  74740. SQLITE_API void *sqlite3_aggregate_context(sqlite3_context *p, int nByte){
  74741. assert( p && p->pFunc && p->pFunc->xFinalize );
  74742. assert( sqlite3_mutex_held(p->pOut->db->mutex) );
  74743. testcase( nByte<0 );
  74744. if( (p->pMem->flags & MEM_Agg)==0 ){
  74745. return createAggContext(p, nByte);
  74746. }else{
  74747. return (void*)p->pMem->z;
  74748. }
  74749. }
  74750. /*
  74751. ** Return the auxiliary data pointer, if any, for the iArg'th argument to
  74752. ** the user-function defined by pCtx.
  74753. **
  74754. ** The left-most argument is 0.
  74755. **
  74756. ** Undocumented behavior: If iArg is negative then access a cache of
  74757. ** auxiliary data pointers that is available to all functions within a
  74758. ** single prepared statement. The iArg values must match.
  74759. */
  74760. SQLITE_API void *sqlite3_get_auxdata(sqlite3_context *pCtx, int iArg){
  74761. AuxData *pAuxData;
  74762. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74763. #if SQLITE_ENABLE_STAT3_OR_STAT4
  74764. if( pCtx->pVdbe==0 ) return 0;
  74765. #else
  74766. assert( pCtx->pVdbe!=0 );
  74767. #endif
  74768. for(pAuxData=pCtx->pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
  74769. if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
  74770. return pAuxData->pAux;
  74771. }
  74772. }
  74773. return 0;
  74774. }
  74775. /*
  74776. ** Set the auxiliary data pointer and delete function, for the iArg'th
  74777. ** argument to the user-function defined by pCtx. Any previous value is
  74778. ** deleted by calling the delete function specified when it was set.
  74779. **
  74780. ** The left-most argument is 0.
  74781. **
  74782. ** Undocumented behavior: If iArg is negative then make the data available
  74783. ** to all functions within the current prepared statement using iArg as an
  74784. ** access code.
  74785. */
  74786. SQLITE_API void sqlite3_set_auxdata(
  74787. sqlite3_context *pCtx,
  74788. int iArg,
  74789. void *pAux,
  74790. void (*xDelete)(void*)
  74791. ){
  74792. AuxData *pAuxData;
  74793. Vdbe *pVdbe = pCtx->pVdbe;
  74794. assert( sqlite3_mutex_held(pCtx->pOut->db->mutex) );
  74795. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  74796. if( pVdbe==0 ) goto failed;
  74797. #else
  74798. assert( pVdbe!=0 );
  74799. #endif
  74800. for(pAuxData=pVdbe->pAuxData; pAuxData; pAuxData=pAuxData->pNextAux){
  74801. if( pAuxData->iAuxArg==iArg && (pAuxData->iAuxOp==pCtx->iOp || iArg<0) ){
  74802. break;
  74803. }
  74804. }
  74805. if( pAuxData==0 ){
  74806. pAuxData = sqlite3DbMallocZero(pVdbe->db, sizeof(AuxData));
  74807. if( !pAuxData ) goto failed;
  74808. pAuxData->iAuxOp = pCtx->iOp;
  74809. pAuxData->iAuxArg = iArg;
  74810. pAuxData->pNextAux = pVdbe->pAuxData;
  74811. pVdbe->pAuxData = pAuxData;
  74812. if( pCtx->isError==0 ) pCtx->isError = -1;
  74813. }else if( pAuxData->xDeleteAux ){
  74814. pAuxData->xDeleteAux(pAuxData->pAux);
  74815. }
  74816. pAuxData->pAux = pAux;
  74817. pAuxData->xDeleteAux = xDelete;
  74818. return;
  74819. failed:
  74820. if( xDelete ){
  74821. xDelete(pAux);
  74822. }
  74823. }
  74824. #ifndef SQLITE_OMIT_DEPRECATED
  74825. /*
  74826. ** Return the number of times the Step function of an aggregate has been
  74827. ** called.
  74828. **
  74829. ** This function is deprecated. Do not use it for new code. It is
  74830. ** provide only to avoid breaking legacy code. New aggregate function
  74831. ** implementations should keep their own counts within their aggregate
  74832. ** context.
  74833. */
  74834. SQLITE_API int sqlite3_aggregate_count(sqlite3_context *p){
  74835. assert( p && p->pMem && p->pFunc && p->pFunc->xFinalize );
  74836. return p->pMem->n;
  74837. }
  74838. #endif
  74839. /*
  74840. ** Return the number of columns in the result set for the statement pStmt.
  74841. */
  74842. SQLITE_API int sqlite3_column_count(sqlite3_stmt *pStmt){
  74843. Vdbe *pVm = (Vdbe *)pStmt;
  74844. return pVm ? pVm->nResColumn : 0;
  74845. }
  74846. /*
  74847. ** Return the number of values available from the current row of the
  74848. ** currently executing statement pStmt.
  74849. */
  74850. SQLITE_API int sqlite3_data_count(sqlite3_stmt *pStmt){
  74851. Vdbe *pVm = (Vdbe *)pStmt;
  74852. if( pVm==0 || pVm->pResultSet==0 ) return 0;
  74853. return pVm->nResColumn;
  74854. }
  74855. /*
  74856. ** Return a pointer to static memory containing an SQL NULL value.
  74857. */
  74858. static const Mem *columnNullValue(void){
  74859. /* Even though the Mem structure contains an element
  74860. ** of type i64, on certain architectures (x86) with certain compiler
  74861. ** switches (-Os), gcc may align this Mem object on a 4-byte boundary
  74862. ** instead of an 8-byte one. This all works fine, except that when
  74863. ** running with SQLITE_DEBUG defined the SQLite code sometimes assert()s
  74864. ** that a Mem structure is located on an 8-byte boundary. To prevent
  74865. ** these assert()s from failing, when building with SQLITE_DEBUG defined
  74866. ** using gcc, we force nullMem to be 8-byte aligned using the magical
  74867. ** __attribute__((aligned(8))) macro. */
  74868. static const Mem nullMem
  74869. #if defined(SQLITE_DEBUG) && defined(__GNUC__)
  74870. __attribute__((aligned(8)))
  74871. #endif
  74872. = {
  74873. /* .u = */ {0},
  74874. /* .flags = */ (u16)MEM_Null,
  74875. /* .enc = */ (u8)0,
  74876. /* .eSubtype = */ (u8)0,
  74877. /* .n = */ (int)0,
  74878. /* .z = */ (char*)0,
  74879. /* .zMalloc = */ (char*)0,
  74880. /* .szMalloc = */ (int)0,
  74881. /* .uTemp = */ (u32)0,
  74882. /* .db = */ (sqlite3*)0,
  74883. /* .xDel = */ (void(*)(void*))0,
  74884. #ifdef SQLITE_DEBUG
  74885. /* .pScopyFrom = */ (Mem*)0,
  74886. /* .pFiller = */ (void*)0,
  74887. #endif
  74888. };
  74889. return &nullMem;
  74890. }
  74891. /*
  74892. ** Check to see if column iCol of the given statement is valid. If
  74893. ** it is, return a pointer to the Mem for the value of that column.
  74894. ** If iCol is not valid, return a pointer to a Mem which has a value
  74895. ** of NULL.
  74896. */
  74897. static Mem *columnMem(sqlite3_stmt *pStmt, int i){
  74898. Vdbe *pVm;
  74899. Mem *pOut;
  74900. pVm = (Vdbe *)pStmt;
  74901. if( pVm==0 ) return (Mem*)columnNullValue();
  74902. assert( pVm->db );
  74903. sqlite3_mutex_enter(pVm->db->mutex);
  74904. if( pVm->pResultSet!=0 && i<pVm->nResColumn && i>=0 ){
  74905. pOut = &pVm->pResultSet[i];
  74906. }else{
  74907. sqlite3Error(pVm->db, SQLITE_RANGE);
  74908. pOut = (Mem*)columnNullValue();
  74909. }
  74910. return pOut;
  74911. }
  74912. /*
  74913. ** This function is called after invoking an sqlite3_value_XXX function on a
  74914. ** column value (i.e. a value returned by evaluating an SQL expression in the
  74915. ** select list of a SELECT statement) that may cause a malloc() failure. If
  74916. ** malloc() has failed, the threads mallocFailed flag is cleared and the result
  74917. ** code of statement pStmt set to SQLITE_NOMEM.
  74918. **
  74919. ** Specifically, this is called from within:
  74920. **
  74921. ** sqlite3_column_int()
  74922. ** sqlite3_column_int64()
  74923. ** sqlite3_column_text()
  74924. ** sqlite3_column_text16()
  74925. ** sqlite3_column_real()
  74926. ** sqlite3_column_bytes()
  74927. ** sqlite3_column_bytes16()
  74928. ** sqiite3_column_blob()
  74929. */
  74930. static void columnMallocFailure(sqlite3_stmt *pStmt)
  74931. {
  74932. /* If malloc() failed during an encoding conversion within an
  74933. ** sqlite3_column_XXX API, then set the return code of the statement to
  74934. ** SQLITE_NOMEM. The next call to _step() (if any) will return SQLITE_ERROR
  74935. ** and _finalize() will return NOMEM.
  74936. */
  74937. Vdbe *p = (Vdbe *)pStmt;
  74938. if( p ){
  74939. assert( p->db!=0 );
  74940. assert( sqlite3_mutex_held(p->db->mutex) );
  74941. p->rc = sqlite3ApiExit(p->db, p->rc);
  74942. sqlite3_mutex_leave(p->db->mutex);
  74943. }
  74944. }
  74945. /**************************** sqlite3_column_ *******************************
  74946. ** The following routines are used to access elements of the current row
  74947. ** in the result set.
  74948. */
  74949. SQLITE_API const void *sqlite3_column_blob(sqlite3_stmt *pStmt, int i){
  74950. const void *val;
  74951. val = sqlite3_value_blob( columnMem(pStmt,i) );
  74952. /* Even though there is no encoding conversion, value_blob() might
  74953. ** need to call malloc() to expand the result of a zeroblob()
  74954. ** expression.
  74955. */
  74956. columnMallocFailure(pStmt);
  74957. return val;
  74958. }
  74959. SQLITE_API int sqlite3_column_bytes(sqlite3_stmt *pStmt, int i){
  74960. int val = sqlite3_value_bytes( columnMem(pStmt,i) );
  74961. columnMallocFailure(pStmt);
  74962. return val;
  74963. }
  74964. SQLITE_API int sqlite3_column_bytes16(sqlite3_stmt *pStmt, int i){
  74965. int val = sqlite3_value_bytes16( columnMem(pStmt,i) );
  74966. columnMallocFailure(pStmt);
  74967. return val;
  74968. }
  74969. SQLITE_API double sqlite3_column_double(sqlite3_stmt *pStmt, int i){
  74970. double val = sqlite3_value_double( columnMem(pStmt,i) );
  74971. columnMallocFailure(pStmt);
  74972. return val;
  74973. }
  74974. SQLITE_API int sqlite3_column_int(sqlite3_stmt *pStmt, int i){
  74975. int val = sqlite3_value_int( columnMem(pStmt,i) );
  74976. columnMallocFailure(pStmt);
  74977. return val;
  74978. }
  74979. SQLITE_API sqlite_int64 sqlite3_column_int64(sqlite3_stmt *pStmt, int i){
  74980. sqlite_int64 val = sqlite3_value_int64( columnMem(pStmt,i) );
  74981. columnMallocFailure(pStmt);
  74982. return val;
  74983. }
  74984. SQLITE_API const unsigned char *sqlite3_column_text(sqlite3_stmt *pStmt, int i){
  74985. const unsigned char *val = sqlite3_value_text( columnMem(pStmt,i) );
  74986. columnMallocFailure(pStmt);
  74987. return val;
  74988. }
  74989. SQLITE_API sqlite3_value *sqlite3_column_value(sqlite3_stmt *pStmt, int i){
  74990. Mem *pOut = columnMem(pStmt, i);
  74991. if( pOut->flags&MEM_Static ){
  74992. pOut->flags &= ~MEM_Static;
  74993. pOut->flags |= MEM_Ephem;
  74994. }
  74995. columnMallocFailure(pStmt);
  74996. return (sqlite3_value *)pOut;
  74997. }
  74998. #ifndef SQLITE_OMIT_UTF16
  74999. SQLITE_API const void *sqlite3_column_text16(sqlite3_stmt *pStmt, int i){
  75000. const void *val = sqlite3_value_text16( columnMem(pStmt,i) );
  75001. columnMallocFailure(pStmt);
  75002. return val;
  75003. }
  75004. #endif /* SQLITE_OMIT_UTF16 */
  75005. SQLITE_API int sqlite3_column_type(sqlite3_stmt *pStmt, int i){
  75006. int iType = sqlite3_value_type( columnMem(pStmt,i) );
  75007. columnMallocFailure(pStmt);
  75008. return iType;
  75009. }
  75010. /*
  75011. ** Convert the N-th element of pStmt->pColName[] into a string using
  75012. ** xFunc() then return that string. If N is out of range, return 0.
  75013. **
  75014. ** There are up to 5 names for each column. useType determines which
  75015. ** name is returned. Here are the names:
  75016. **
  75017. ** 0 The column name as it should be displayed for output
  75018. ** 1 The datatype name for the column
  75019. ** 2 The name of the database that the column derives from
  75020. ** 3 The name of the table that the column derives from
  75021. ** 4 The name of the table column that the result column derives from
  75022. **
  75023. ** If the result is not a simple column reference (if it is an expression
  75024. ** or a constant) then useTypes 2, 3, and 4 return NULL.
  75025. */
  75026. static const void *columnName(
  75027. sqlite3_stmt *pStmt,
  75028. int N,
  75029. const void *(*xFunc)(Mem*),
  75030. int useType
  75031. ){
  75032. const void *ret;
  75033. Vdbe *p;
  75034. int n;
  75035. sqlite3 *db;
  75036. #ifdef SQLITE_ENABLE_API_ARMOR
  75037. if( pStmt==0 ){
  75038. (void)SQLITE_MISUSE_BKPT;
  75039. return 0;
  75040. }
  75041. #endif
  75042. ret = 0;
  75043. p = (Vdbe *)pStmt;
  75044. db = p->db;
  75045. assert( db!=0 );
  75046. n = sqlite3_column_count(pStmt);
  75047. if( N<n && N>=0 ){
  75048. N += useType*n;
  75049. sqlite3_mutex_enter(db->mutex);
  75050. assert( db->mallocFailed==0 );
  75051. ret = xFunc(&p->aColName[N]);
  75052. /* A malloc may have failed inside of the xFunc() call. If this
  75053. ** is the case, clear the mallocFailed flag and return NULL.
  75054. */
  75055. if( db->mallocFailed ){
  75056. sqlite3OomClear(db);
  75057. ret = 0;
  75058. }
  75059. sqlite3_mutex_leave(db->mutex);
  75060. }
  75061. return ret;
  75062. }
  75063. /*
  75064. ** Return the name of the Nth column of the result set returned by SQL
  75065. ** statement pStmt.
  75066. */
  75067. SQLITE_API const char *sqlite3_column_name(sqlite3_stmt *pStmt, int N){
  75068. return columnName(
  75069. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_NAME);
  75070. }
  75071. #ifndef SQLITE_OMIT_UTF16
  75072. SQLITE_API const void *sqlite3_column_name16(sqlite3_stmt *pStmt, int N){
  75073. return columnName(
  75074. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_NAME);
  75075. }
  75076. #endif
  75077. /*
  75078. ** Constraint: If you have ENABLE_COLUMN_METADATA then you must
  75079. ** not define OMIT_DECLTYPE.
  75080. */
  75081. #if defined(SQLITE_OMIT_DECLTYPE) && defined(SQLITE_ENABLE_COLUMN_METADATA)
  75082. # error "Must not define both SQLITE_OMIT_DECLTYPE \
  75083. and SQLITE_ENABLE_COLUMN_METADATA"
  75084. #endif
  75085. #ifndef SQLITE_OMIT_DECLTYPE
  75086. /*
  75087. ** Return the column declaration type (if applicable) of the 'i'th column
  75088. ** of the result set of SQL statement pStmt.
  75089. */
  75090. SQLITE_API const char *sqlite3_column_decltype(sqlite3_stmt *pStmt, int N){
  75091. return columnName(
  75092. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DECLTYPE);
  75093. }
  75094. #ifndef SQLITE_OMIT_UTF16
  75095. SQLITE_API const void *sqlite3_column_decltype16(sqlite3_stmt *pStmt, int N){
  75096. return columnName(
  75097. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DECLTYPE);
  75098. }
  75099. #endif /* SQLITE_OMIT_UTF16 */
  75100. #endif /* SQLITE_OMIT_DECLTYPE */
  75101. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  75102. /*
  75103. ** Return the name of the database from which a result column derives.
  75104. ** NULL is returned if the result column is an expression or constant or
  75105. ** anything else which is not an unambiguous reference to a database column.
  75106. */
  75107. SQLITE_API const char *sqlite3_column_database_name(sqlite3_stmt *pStmt, int N){
  75108. return columnName(
  75109. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_DATABASE);
  75110. }
  75111. #ifndef SQLITE_OMIT_UTF16
  75112. SQLITE_API const void *sqlite3_column_database_name16(sqlite3_stmt *pStmt, int N){
  75113. return columnName(
  75114. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_DATABASE);
  75115. }
  75116. #endif /* SQLITE_OMIT_UTF16 */
  75117. /*
  75118. ** Return the name of the table from which a result column derives.
  75119. ** NULL is returned if the result column is an expression or constant or
  75120. ** anything else which is not an unambiguous reference to a database column.
  75121. */
  75122. SQLITE_API const char *sqlite3_column_table_name(sqlite3_stmt *pStmt, int N){
  75123. return columnName(
  75124. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_TABLE);
  75125. }
  75126. #ifndef SQLITE_OMIT_UTF16
  75127. SQLITE_API const void *sqlite3_column_table_name16(sqlite3_stmt *pStmt, int N){
  75128. return columnName(
  75129. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_TABLE);
  75130. }
  75131. #endif /* SQLITE_OMIT_UTF16 */
  75132. /*
  75133. ** Return the name of the table column from which a result column derives.
  75134. ** NULL is returned if the result column is an expression or constant or
  75135. ** anything else which is not an unambiguous reference to a database column.
  75136. */
  75137. SQLITE_API const char *sqlite3_column_origin_name(sqlite3_stmt *pStmt, int N){
  75138. return columnName(
  75139. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text, COLNAME_COLUMN);
  75140. }
  75141. #ifndef SQLITE_OMIT_UTF16
  75142. SQLITE_API const void *sqlite3_column_origin_name16(sqlite3_stmt *pStmt, int N){
  75143. return columnName(
  75144. pStmt, N, (const void*(*)(Mem*))sqlite3_value_text16, COLNAME_COLUMN);
  75145. }
  75146. #endif /* SQLITE_OMIT_UTF16 */
  75147. #endif /* SQLITE_ENABLE_COLUMN_METADATA */
  75148. /******************************* sqlite3_bind_ ***************************
  75149. **
  75150. ** Routines used to attach values to wildcards in a compiled SQL statement.
  75151. */
  75152. /*
  75153. ** Unbind the value bound to variable i in virtual machine p. This is the
  75154. ** the same as binding a NULL value to the column. If the "i" parameter is
  75155. ** out of range, then SQLITE_RANGE is returned. Othewise SQLITE_OK.
  75156. **
  75157. ** A successful evaluation of this routine acquires the mutex on p.
  75158. ** the mutex is released if any kind of error occurs.
  75159. **
  75160. ** The error code stored in database p->db is overwritten with the return
  75161. ** value in any case.
  75162. */
  75163. static int vdbeUnbind(Vdbe *p, int i){
  75164. Mem *pVar;
  75165. if( vdbeSafetyNotNull(p) ){
  75166. return SQLITE_MISUSE_BKPT;
  75167. }
  75168. sqlite3_mutex_enter(p->db->mutex);
  75169. if( p->magic!=VDBE_MAGIC_RUN || p->pc>=0 ){
  75170. sqlite3Error(p->db, SQLITE_MISUSE);
  75171. sqlite3_mutex_leave(p->db->mutex);
  75172. sqlite3_log(SQLITE_MISUSE,
  75173. "bind on a busy prepared statement: [%s]", p->zSql);
  75174. return SQLITE_MISUSE_BKPT;
  75175. }
  75176. if( i<1 || i>p->nVar ){
  75177. sqlite3Error(p->db, SQLITE_RANGE);
  75178. sqlite3_mutex_leave(p->db->mutex);
  75179. return SQLITE_RANGE;
  75180. }
  75181. i--;
  75182. pVar = &p->aVar[i];
  75183. sqlite3VdbeMemRelease(pVar);
  75184. pVar->flags = MEM_Null;
  75185. sqlite3Error(p->db, SQLITE_OK);
  75186. /* If the bit corresponding to this variable in Vdbe.expmask is set, then
  75187. ** binding a new value to this variable invalidates the current query plan.
  75188. **
  75189. ** IMPLEMENTATION-OF: R-48440-37595 If the specific value bound to host
  75190. ** parameter in the WHERE clause might influence the choice of query plan
  75191. ** for a statement, then the statement will be automatically recompiled,
  75192. ** as if there had been a schema change, on the first sqlite3_step() call
  75193. ** following any change to the bindings of that parameter.
  75194. */
  75195. assert( (p->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || p->expmask==0 );
  75196. if( p->expmask!=0 && (p->expmask & (i>=31 ? 0x80000000 : (u32)1<<i))!=0 ){
  75197. p->expired = 1;
  75198. }
  75199. return SQLITE_OK;
  75200. }
  75201. /*
  75202. ** Bind a text or BLOB value.
  75203. */
  75204. static int bindText(
  75205. sqlite3_stmt *pStmt, /* The statement to bind against */
  75206. int i, /* Index of the parameter to bind */
  75207. const void *zData, /* Pointer to the data to be bound */
  75208. int nData, /* Number of bytes of data to be bound */
  75209. void (*xDel)(void*), /* Destructor for the data */
  75210. u8 encoding /* Encoding for the data */
  75211. ){
  75212. Vdbe *p = (Vdbe *)pStmt;
  75213. Mem *pVar;
  75214. int rc;
  75215. rc = vdbeUnbind(p, i);
  75216. if( rc==SQLITE_OK ){
  75217. if( zData!=0 ){
  75218. pVar = &p->aVar[i-1];
  75219. rc = sqlite3VdbeMemSetStr(pVar, zData, nData, encoding, xDel);
  75220. if( rc==SQLITE_OK && encoding!=0 ){
  75221. rc = sqlite3VdbeChangeEncoding(pVar, ENC(p->db));
  75222. }
  75223. if( rc ){
  75224. sqlite3Error(p->db, rc);
  75225. rc = sqlite3ApiExit(p->db, rc);
  75226. }
  75227. }
  75228. sqlite3_mutex_leave(p->db->mutex);
  75229. }else if( xDel!=SQLITE_STATIC && xDel!=SQLITE_TRANSIENT ){
  75230. xDel((void*)zData);
  75231. }
  75232. return rc;
  75233. }
  75234. /*
  75235. ** Bind a blob value to an SQL statement variable.
  75236. */
  75237. SQLITE_API int sqlite3_bind_blob(
  75238. sqlite3_stmt *pStmt,
  75239. int i,
  75240. const void *zData,
  75241. int nData,
  75242. void (*xDel)(void*)
  75243. ){
  75244. #ifdef SQLITE_ENABLE_API_ARMOR
  75245. if( nData<0 ) return SQLITE_MISUSE_BKPT;
  75246. #endif
  75247. return bindText(pStmt, i, zData, nData, xDel, 0);
  75248. }
  75249. SQLITE_API int sqlite3_bind_blob64(
  75250. sqlite3_stmt *pStmt,
  75251. int i,
  75252. const void *zData,
  75253. sqlite3_uint64 nData,
  75254. void (*xDel)(void*)
  75255. ){
  75256. assert( xDel!=SQLITE_DYNAMIC );
  75257. if( nData>0x7fffffff ){
  75258. return invokeValueDestructor(zData, xDel, 0);
  75259. }else{
  75260. return bindText(pStmt, i, zData, (int)nData, xDel, 0);
  75261. }
  75262. }
  75263. SQLITE_API int sqlite3_bind_double(sqlite3_stmt *pStmt, int i, double rValue){
  75264. int rc;
  75265. Vdbe *p = (Vdbe *)pStmt;
  75266. rc = vdbeUnbind(p, i);
  75267. if( rc==SQLITE_OK ){
  75268. sqlite3VdbeMemSetDouble(&p->aVar[i-1], rValue);
  75269. sqlite3_mutex_leave(p->db->mutex);
  75270. }
  75271. return rc;
  75272. }
  75273. SQLITE_API int sqlite3_bind_int(sqlite3_stmt *p, int i, int iValue){
  75274. return sqlite3_bind_int64(p, i, (i64)iValue);
  75275. }
  75276. SQLITE_API int sqlite3_bind_int64(sqlite3_stmt *pStmt, int i, sqlite_int64 iValue){
  75277. int rc;
  75278. Vdbe *p = (Vdbe *)pStmt;
  75279. rc = vdbeUnbind(p, i);
  75280. if( rc==SQLITE_OK ){
  75281. sqlite3VdbeMemSetInt64(&p->aVar[i-1], iValue);
  75282. sqlite3_mutex_leave(p->db->mutex);
  75283. }
  75284. return rc;
  75285. }
  75286. SQLITE_API int sqlite3_bind_null(sqlite3_stmt *pStmt, int i){
  75287. int rc;
  75288. Vdbe *p = (Vdbe*)pStmt;
  75289. rc = vdbeUnbind(p, i);
  75290. if( rc==SQLITE_OK ){
  75291. sqlite3_mutex_leave(p->db->mutex);
  75292. }
  75293. return rc;
  75294. }
  75295. SQLITE_API int sqlite3_bind_pointer(
  75296. sqlite3_stmt *pStmt,
  75297. int i,
  75298. void *pPtr,
  75299. const char *zPTtype,
  75300. void (*xDestructor)(void*)
  75301. ){
  75302. int rc;
  75303. Vdbe *p = (Vdbe*)pStmt;
  75304. rc = vdbeUnbind(p, i);
  75305. if( rc==SQLITE_OK ){
  75306. sqlite3VdbeMemSetPointer(&p->aVar[i-1], pPtr, zPTtype, xDestructor);
  75307. sqlite3_mutex_leave(p->db->mutex);
  75308. }else if( xDestructor ){
  75309. xDestructor(pPtr);
  75310. }
  75311. return rc;
  75312. }
  75313. SQLITE_API int sqlite3_bind_text(
  75314. sqlite3_stmt *pStmt,
  75315. int i,
  75316. const char *zData,
  75317. int nData,
  75318. void (*xDel)(void*)
  75319. ){
  75320. return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF8);
  75321. }
  75322. SQLITE_API int sqlite3_bind_text64(
  75323. sqlite3_stmt *pStmt,
  75324. int i,
  75325. const char *zData,
  75326. sqlite3_uint64 nData,
  75327. void (*xDel)(void*),
  75328. unsigned char enc
  75329. ){
  75330. assert( xDel!=SQLITE_DYNAMIC );
  75331. if( nData>0x7fffffff ){
  75332. return invokeValueDestructor(zData, xDel, 0);
  75333. }else{
  75334. if( enc==SQLITE_UTF16 ) enc = SQLITE_UTF16NATIVE;
  75335. return bindText(pStmt, i, zData, (int)nData, xDel, enc);
  75336. }
  75337. }
  75338. #ifndef SQLITE_OMIT_UTF16
  75339. SQLITE_API int sqlite3_bind_text16(
  75340. sqlite3_stmt *pStmt,
  75341. int i,
  75342. const void *zData,
  75343. int nData,
  75344. void (*xDel)(void*)
  75345. ){
  75346. return bindText(pStmt, i, zData, nData, xDel, SQLITE_UTF16NATIVE);
  75347. }
  75348. #endif /* SQLITE_OMIT_UTF16 */
  75349. SQLITE_API int sqlite3_bind_value(sqlite3_stmt *pStmt, int i, const sqlite3_value *pValue){
  75350. int rc;
  75351. switch( sqlite3_value_type((sqlite3_value*)pValue) ){
  75352. case SQLITE_INTEGER: {
  75353. rc = sqlite3_bind_int64(pStmt, i, pValue->u.i);
  75354. break;
  75355. }
  75356. case SQLITE_FLOAT: {
  75357. rc = sqlite3_bind_double(pStmt, i, pValue->u.r);
  75358. break;
  75359. }
  75360. case SQLITE_BLOB: {
  75361. if( pValue->flags & MEM_Zero ){
  75362. rc = sqlite3_bind_zeroblob(pStmt, i, pValue->u.nZero);
  75363. }else{
  75364. rc = sqlite3_bind_blob(pStmt, i, pValue->z, pValue->n,SQLITE_TRANSIENT);
  75365. }
  75366. break;
  75367. }
  75368. case SQLITE_TEXT: {
  75369. rc = bindText(pStmt,i, pValue->z, pValue->n, SQLITE_TRANSIENT,
  75370. pValue->enc);
  75371. break;
  75372. }
  75373. default: {
  75374. rc = sqlite3_bind_null(pStmt, i);
  75375. break;
  75376. }
  75377. }
  75378. return rc;
  75379. }
  75380. SQLITE_API int sqlite3_bind_zeroblob(sqlite3_stmt *pStmt, int i, int n){
  75381. int rc;
  75382. Vdbe *p = (Vdbe *)pStmt;
  75383. rc = vdbeUnbind(p, i);
  75384. if( rc==SQLITE_OK ){
  75385. sqlite3VdbeMemSetZeroBlob(&p->aVar[i-1], n);
  75386. sqlite3_mutex_leave(p->db->mutex);
  75387. }
  75388. return rc;
  75389. }
  75390. SQLITE_API int sqlite3_bind_zeroblob64(sqlite3_stmt *pStmt, int i, sqlite3_uint64 n){
  75391. int rc;
  75392. Vdbe *p = (Vdbe *)pStmt;
  75393. sqlite3_mutex_enter(p->db->mutex);
  75394. if( n>(u64)p->db->aLimit[SQLITE_LIMIT_LENGTH] ){
  75395. rc = SQLITE_TOOBIG;
  75396. }else{
  75397. assert( (n & 0x7FFFFFFF)==n );
  75398. rc = sqlite3_bind_zeroblob(pStmt, i, n);
  75399. }
  75400. rc = sqlite3ApiExit(p->db, rc);
  75401. sqlite3_mutex_leave(p->db->mutex);
  75402. return rc;
  75403. }
  75404. /*
  75405. ** Return the number of wildcards that can be potentially bound to.
  75406. ** This routine is added to support DBD::SQLite.
  75407. */
  75408. SQLITE_API int sqlite3_bind_parameter_count(sqlite3_stmt *pStmt){
  75409. Vdbe *p = (Vdbe*)pStmt;
  75410. return p ? p->nVar : 0;
  75411. }
  75412. /*
  75413. ** Return the name of a wildcard parameter. Return NULL if the index
  75414. ** is out of range or if the wildcard is unnamed.
  75415. **
  75416. ** The result is always UTF-8.
  75417. */
  75418. SQLITE_API const char *sqlite3_bind_parameter_name(sqlite3_stmt *pStmt, int i){
  75419. Vdbe *p = (Vdbe*)pStmt;
  75420. if( p==0 ) return 0;
  75421. return sqlite3VListNumToName(p->pVList, i);
  75422. }
  75423. /*
  75424. ** Given a wildcard parameter name, return the index of the variable
  75425. ** with that name. If there is no variable with the given name,
  75426. ** return 0.
  75427. */
  75428. SQLITE_PRIVATE int sqlite3VdbeParameterIndex(Vdbe *p, const char *zName, int nName){
  75429. if( p==0 || zName==0 ) return 0;
  75430. return sqlite3VListNameToNum(p->pVList, zName, nName);
  75431. }
  75432. SQLITE_API int sqlite3_bind_parameter_index(sqlite3_stmt *pStmt, const char *zName){
  75433. return sqlite3VdbeParameterIndex((Vdbe*)pStmt, zName, sqlite3Strlen30(zName));
  75434. }
  75435. /*
  75436. ** Transfer all bindings from the first statement over to the second.
  75437. */
  75438. SQLITE_PRIVATE int sqlite3TransferBindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
  75439. Vdbe *pFrom = (Vdbe*)pFromStmt;
  75440. Vdbe *pTo = (Vdbe*)pToStmt;
  75441. int i;
  75442. assert( pTo->db==pFrom->db );
  75443. assert( pTo->nVar==pFrom->nVar );
  75444. sqlite3_mutex_enter(pTo->db->mutex);
  75445. for(i=0; i<pFrom->nVar; i++){
  75446. sqlite3VdbeMemMove(&pTo->aVar[i], &pFrom->aVar[i]);
  75447. }
  75448. sqlite3_mutex_leave(pTo->db->mutex);
  75449. return SQLITE_OK;
  75450. }
  75451. #ifndef SQLITE_OMIT_DEPRECATED
  75452. /*
  75453. ** Deprecated external interface. Internal/core SQLite code
  75454. ** should call sqlite3TransferBindings.
  75455. **
  75456. ** It is misuse to call this routine with statements from different
  75457. ** database connections. But as this is a deprecated interface, we
  75458. ** will not bother to check for that condition.
  75459. **
  75460. ** If the two statements contain a different number of bindings, then
  75461. ** an SQLITE_ERROR is returned. Nothing else can go wrong, so otherwise
  75462. ** SQLITE_OK is returned.
  75463. */
  75464. SQLITE_API int sqlite3_transfer_bindings(sqlite3_stmt *pFromStmt, sqlite3_stmt *pToStmt){
  75465. Vdbe *pFrom = (Vdbe*)pFromStmt;
  75466. Vdbe *pTo = (Vdbe*)pToStmt;
  75467. if( pFrom->nVar!=pTo->nVar ){
  75468. return SQLITE_ERROR;
  75469. }
  75470. assert( (pTo->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pTo->expmask==0 );
  75471. if( pTo->expmask ){
  75472. pTo->expired = 1;
  75473. }
  75474. assert( (pFrom->prepFlags & SQLITE_PREPARE_SAVESQL)!=0 || pFrom->expmask==0 );
  75475. if( pFrom->expmask ){
  75476. pFrom->expired = 1;
  75477. }
  75478. return sqlite3TransferBindings(pFromStmt, pToStmt);
  75479. }
  75480. #endif
  75481. /*
  75482. ** Return the sqlite3* database handle to which the prepared statement given
  75483. ** in the argument belongs. This is the same database handle that was
  75484. ** the first argument to the sqlite3_prepare() that was used to create
  75485. ** the statement in the first place.
  75486. */
  75487. SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt *pStmt){
  75488. return pStmt ? ((Vdbe*)pStmt)->db : 0;
  75489. }
  75490. /*
  75491. ** Return true if the prepared statement is guaranteed to not modify the
  75492. ** database.
  75493. */
  75494. SQLITE_API int sqlite3_stmt_readonly(sqlite3_stmt *pStmt){
  75495. return pStmt ? ((Vdbe*)pStmt)->readOnly : 1;
  75496. }
  75497. /*
  75498. ** Return true if the prepared statement is in need of being reset.
  75499. */
  75500. SQLITE_API int sqlite3_stmt_busy(sqlite3_stmt *pStmt){
  75501. Vdbe *v = (Vdbe*)pStmt;
  75502. return v!=0 && v->magic==VDBE_MAGIC_RUN && v->pc>=0;
  75503. }
  75504. /*
  75505. ** Return a pointer to the next prepared statement after pStmt associated
  75506. ** with database connection pDb. If pStmt is NULL, return the first
  75507. ** prepared statement for the database connection. Return NULL if there
  75508. ** are no more.
  75509. */
  75510. SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt){
  75511. sqlite3_stmt *pNext;
  75512. #ifdef SQLITE_ENABLE_API_ARMOR
  75513. if( !sqlite3SafetyCheckOk(pDb) ){
  75514. (void)SQLITE_MISUSE_BKPT;
  75515. return 0;
  75516. }
  75517. #endif
  75518. sqlite3_mutex_enter(pDb->mutex);
  75519. if( pStmt==0 ){
  75520. pNext = (sqlite3_stmt*)pDb->pVdbe;
  75521. }else{
  75522. pNext = (sqlite3_stmt*)((Vdbe*)pStmt)->pNext;
  75523. }
  75524. sqlite3_mutex_leave(pDb->mutex);
  75525. return pNext;
  75526. }
  75527. /*
  75528. ** Return the value of a status counter for a prepared statement
  75529. */
  75530. SQLITE_API int sqlite3_stmt_status(sqlite3_stmt *pStmt, int op, int resetFlag){
  75531. Vdbe *pVdbe = (Vdbe*)pStmt;
  75532. u32 v;
  75533. #ifdef SQLITE_ENABLE_API_ARMOR
  75534. if( !pStmt
  75535. || (op!=SQLITE_STMTSTATUS_MEMUSED && (op<0||op>=ArraySize(pVdbe->aCounter)))
  75536. ){
  75537. (void)SQLITE_MISUSE_BKPT;
  75538. return 0;
  75539. }
  75540. #endif
  75541. if( op==SQLITE_STMTSTATUS_MEMUSED ){
  75542. sqlite3 *db = pVdbe->db;
  75543. sqlite3_mutex_enter(db->mutex);
  75544. v = 0;
  75545. db->pnBytesFreed = (int*)&v;
  75546. sqlite3VdbeClearObject(db, pVdbe);
  75547. sqlite3DbFree(db, pVdbe);
  75548. db->pnBytesFreed = 0;
  75549. sqlite3_mutex_leave(db->mutex);
  75550. }else{
  75551. v = pVdbe->aCounter[op];
  75552. if( resetFlag ) pVdbe->aCounter[op] = 0;
  75553. }
  75554. return (int)v;
  75555. }
  75556. /*
  75557. ** Return the SQL associated with a prepared statement
  75558. */
  75559. SQLITE_API const char *sqlite3_sql(sqlite3_stmt *pStmt){
  75560. Vdbe *p = (Vdbe *)pStmt;
  75561. return p ? p->zSql : 0;
  75562. }
  75563. /*
  75564. ** Return the SQL associated with a prepared statement with
  75565. ** bound parameters expanded. Space to hold the returned string is
  75566. ** obtained from sqlite3_malloc(). The caller is responsible for
  75567. ** freeing the returned string by passing it to sqlite3_free().
  75568. **
  75569. ** The SQLITE_TRACE_SIZE_LIMIT puts an upper bound on the size of
  75570. ** expanded bound parameters.
  75571. */
  75572. SQLITE_API char *sqlite3_expanded_sql(sqlite3_stmt *pStmt){
  75573. #ifdef SQLITE_OMIT_TRACE
  75574. return 0;
  75575. #else
  75576. char *z = 0;
  75577. const char *zSql = sqlite3_sql(pStmt);
  75578. if( zSql ){
  75579. Vdbe *p = (Vdbe *)pStmt;
  75580. sqlite3_mutex_enter(p->db->mutex);
  75581. z = sqlite3VdbeExpandSql(p, zSql);
  75582. sqlite3_mutex_leave(p->db->mutex);
  75583. }
  75584. return z;
  75585. #endif
  75586. }
  75587. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  75588. /*
  75589. ** Allocate and populate an UnpackedRecord structure based on the serialized
  75590. ** record in nKey/pKey. Return a pointer to the new UnpackedRecord structure
  75591. ** if successful, or a NULL pointer if an OOM error is encountered.
  75592. */
  75593. static UnpackedRecord *vdbeUnpackRecord(
  75594. KeyInfo *pKeyInfo,
  75595. int nKey,
  75596. const void *pKey
  75597. ){
  75598. UnpackedRecord *pRet; /* Return value */
  75599. pRet = sqlite3VdbeAllocUnpackedRecord(pKeyInfo);
  75600. if( pRet ){
  75601. memset(pRet->aMem, 0, sizeof(Mem)*(pKeyInfo->nKeyField+1));
  75602. sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, pRet);
  75603. }
  75604. return pRet;
  75605. }
  75606. /*
  75607. ** This function is called from within a pre-update callback to retrieve
  75608. ** a field of the row currently being updated or deleted.
  75609. */
  75610. SQLITE_API int sqlite3_preupdate_old(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
  75611. PreUpdate *p = db->pPreUpdate;
  75612. Mem *pMem;
  75613. int rc = SQLITE_OK;
  75614. /* Test that this call is being made from within an SQLITE_DELETE or
  75615. ** SQLITE_UPDATE pre-update callback, and that iIdx is within range. */
  75616. if( !p || p->op==SQLITE_INSERT ){
  75617. rc = SQLITE_MISUSE_BKPT;
  75618. goto preupdate_old_out;
  75619. }
  75620. if( p->pPk ){
  75621. iIdx = sqlite3ColumnOfIndex(p->pPk, iIdx);
  75622. }
  75623. if( iIdx>=p->pCsr->nField || iIdx<0 ){
  75624. rc = SQLITE_RANGE;
  75625. goto preupdate_old_out;
  75626. }
  75627. /* If the old.* record has not yet been loaded into memory, do so now. */
  75628. if( p->pUnpacked==0 ){
  75629. u32 nRec;
  75630. u8 *aRec;
  75631. nRec = sqlite3BtreePayloadSize(p->pCsr->uc.pCursor);
  75632. aRec = sqlite3DbMallocRaw(db, nRec);
  75633. if( !aRec ) goto preupdate_old_out;
  75634. rc = sqlite3BtreePayload(p->pCsr->uc.pCursor, 0, nRec, aRec);
  75635. if( rc==SQLITE_OK ){
  75636. p->pUnpacked = vdbeUnpackRecord(&p->keyinfo, nRec, aRec);
  75637. if( !p->pUnpacked ) rc = SQLITE_NOMEM;
  75638. }
  75639. if( rc!=SQLITE_OK ){
  75640. sqlite3DbFree(db, aRec);
  75641. goto preupdate_old_out;
  75642. }
  75643. p->aRecord = aRec;
  75644. }
  75645. pMem = *ppValue = &p->pUnpacked->aMem[iIdx];
  75646. if( iIdx==p->pTab->iPKey ){
  75647. sqlite3VdbeMemSetInt64(pMem, p->iKey1);
  75648. }else if( iIdx>=p->pUnpacked->nField ){
  75649. *ppValue = (sqlite3_value *)columnNullValue();
  75650. }else if( p->pTab->aCol[iIdx].affinity==SQLITE_AFF_REAL ){
  75651. if( pMem->flags & MEM_Int ){
  75652. sqlite3VdbeMemRealify(pMem);
  75653. }
  75654. }
  75655. preupdate_old_out:
  75656. sqlite3Error(db, rc);
  75657. return sqlite3ApiExit(db, rc);
  75658. }
  75659. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  75660. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  75661. /*
  75662. ** This function is called from within a pre-update callback to retrieve
  75663. ** the number of columns in the row being updated, deleted or inserted.
  75664. */
  75665. SQLITE_API int sqlite3_preupdate_count(sqlite3 *db){
  75666. PreUpdate *p = db->pPreUpdate;
  75667. return (p ? p->keyinfo.nKeyField : 0);
  75668. }
  75669. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  75670. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  75671. /*
  75672. ** This function is designed to be called from within a pre-update callback
  75673. ** only. It returns zero if the change that caused the callback was made
  75674. ** immediately by a user SQL statement. Or, if the change was made by a
  75675. ** trigger program, it returns the number of trigger programs currently
  75676. ** on the stack (1 for a top-level trigger, 2 for a trigger fired by a
  75677. ** top-level trigger etc.).
  75678. **
  75679. ** For the purposes of the previous paragraph, a foreign key CASCADE, SET NULL
  75680. ** or SET DEFAULT action is considered a trigger.
  75681. */
  75682. SQLITE_API int sqlite3_preupdate_depth(sqlite3 *db){
  75683. PreUpdate *p = db->pPreUpdate;
  75684. return (p ? p->v->nFrame : 0);
  75685. }
  75686. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  75687. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  75688. /*
  75689. ** This function is called from within a pre-update callback to retrieve
  75690. ** a field of the row currently being updated or inserted.
  75691. */
  75692. SQLITE_API int sqlite3_preupdate_new(sqlite3 *db, int iIdx, sqlite3_value **ppValue){
  75693. PreUpdate *p = db->pPreUpdate;
  75694. int rc = SQLITE_OK;
  75695. Mem *pMem;
  75696. if( !p || p->op==SQLITE_DELETE ){
  75697. rc = SQLITE_MISUSE_BKPT;
  75698. goto preupdate_new_out;
  75699. }
  75700. if( p->pPk && p->op!=SQLITE_UPDATE ){
  75701. iIdx = sqlite3ColumnOfIndex(p->pPk, iIdx);
  75702. }
  75703. if( iIdx>=p->pCsr->nField || iIdx<0 ){
  75704. rc = SQLITE_RANGE;
  75705. goto preupdate_new_out;
  75706. }
  75707. if( p->op==SQLITE_INSERT ){
  75708. /* For an INSERT, memory cell p->iNewReg contains the serialized record
  75709. ** that is being inserted. Deserialize it. */
  75710. UnpackedRecord *pUnpack = p->pNewUnpacked;
  75711. if( !pUnpack ){
  75712. Mem *pData = &p->v->aMem[p->iNewReg];
  75713. rc = ExpandBlob(pData);
  75714. if( rc!=SQLITE_OK ) goto preupdate_new_out;
  75715. pUnpack = vdbeUnpackRecord(&p->keyinfo, pData->n, pData->z);
  75716. if( !pUnpack ){
  75717. rc = SQLITE_NOMEM;
  75718. goto preupdate_new_out;
  75719. }
  75720. p->pNewUnpacked = pUnpack;
  75721. }
  75722. pMem = &pUnpack->aMem[iIdx];
  75723. if( iIdx==p->pTab->iPKey ){
  75724. sqlite3VdbeMemSetInt64(pMem, p->iKey2);
  75725. }else if( iIdx>=pUnpack->nField ){
  75726. pMem = (sqlite3_value *)columnNullValue();
  75727. }
  75728. }else{
  75729. /* For an UPDATE, memory cell (p->iNewReg+1+iIdx) contains the required
  75730. ** value. Make a copy of the cell contents and return a pointer to it.
  75731. ** It is not safe to return a pointer to the memory cell itself as the
  75732. ** caller may modify the value text encoding.
  75733. */
  75734. assert( p->op==SQLITE_UPDATE );
  75735. if( !p->aNew ){
  75736. p->aNew = (Mem *)sqlite3DbMallocZero(db, sizeof(Mem) * p->pCsr->nField);
  75737. if( !p->aNew ){
  75738. rc = SQLITE_NOMEM;
  75739. goto preupdate_new_out;
  75740. }
  75741. }
  75742. assert( iIdx>=0 && iIdx<p->pCsr->nField );
  75743. pMem = &p->aNew[iIdx];
  75744. if( pMem->flags==0 ){
  75745. if( iIdx==p->pTab->iPKey ){
  75746. sqlite3VdbeMemSetInt64(pMem, p->iKey2);
  75747. }else{
  75748. rc = sqlite3VdbeMemCopy(pMem, &p->v->aMem[p->iNewReg+1+iIdx]);
  75749. if( rc!=SQLITE_OK ) goto preupdate_new_out;
  75750. }
  75751. }
  75752. }
  75753. *ppValue = pMem;
  75754. preupdate_new_out:
  75755. sqlite3Error(db, rc);
  75756. return sqlite3ApiExit(db, rc);
  75757. }
  75758. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  75759. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  75760. /*
  75761. ** Return status data for a single loop within query pStmt.
  75762. */
  75763. SQLITE_API int sqlite3_stmt_scanstatus(
  75764. sqlite3_stmt *pStmt, /* Prepared statement being queried */
  75765. int idx, /* Index of loop to report on */
  75766. int iScanStatusOp, /* Which metric to return */
  75767. void *pOut /* OUT: Write the answer here */
  75768. ){
  75769. Vdbe *p = (Vdbe*)pStmt;
  75770. ScanStatus *pScan;
  75771. if( idx<0 || idx>=p->nScan ) return 1;
  75772. pScan = &p->aScan[idx];
  75773. switch( iScanStatusOp ){
  75774. case SQLITE_SCANSTAT_NLOOP: {
  75775. *(sqlite3_int64*)pOut = p->anExec[pScan->addrLoop];
  75776. break;
  75777. }
  75778. case SQLITE_SCANSTAT_NVISIT: {
  75779. *(sqlite3_int64*)pOut = p->anExec[pScan->addrVisit];
  75780. break;
  75781. }
  75782. case SQLITE_SCANSTAT_EST: {
  75783. double r = 1.0;
  75784. LogEst x = pScan->nEst;
  75785. while( x<100 ){
  75786. x += 10;
  75787. r *= 0.5;
  75788. }
  75789. *(double*)pOut = r*sqlite3LogEstToInt(x);
  75790. break;
  75791. }
  75792. case SQLITE_SCANSTAT_NAME: {
  75793. *(const char**)pOut = pScan->zName;
  75794. break;
  75795. }
  75796. case SQLITE_SCANSTAT_EXPLAIN: {
  75797. if( pScan->addrExplain ){
  75798. *(const char**)pOut = p->aOp[ pScan->addrExplain ].p4.z;
  75799. }else{
  75800. *(const char**)pOut = 0;
  75801. }
  75802. break;
  75803. }
  75804. case SQLITE_SCANSTAT_SELECTID: {
  75805. if( pScan->addrExplain ){
  75806. *(int*)pOut = p->aOp[ pScan->addrExplain ].p1;
  75807. }else{
  75808. *(int*)pOut = -1;
  75809. }
  75810. break;
  75811. }
  75812. default: {
  75813. return 1;
  75814. }
  75815. }
  75816. return 0;
  75817. }
  75818. /*
  75819. ** Zero all counters associated with the sqlite3_stmt_scanstatus() data.
  75820. */
  75821. SQLITE_API void sqlite3_stmt_scanstatus_reset(sqlite3_stmt *pStmt){
  75822. Vdbe *p = (Vdbe*)pStmt;
  75823. memset(p->anExec, 0, p->nOp * sizeof(i64));
  75824. }
  75825. #endif /* SQLITE_ENABLE_STMT_SCANSTATUS */
  75826. /************** End of vdbeapi.c *********************************************/
  75827. /************** Begin file vdbetrace.c ***************************************/
  75828. /*
  75829. ** 2009 November 25
  75830. **
  75831. ** The author disclaims copyright to this source code. In place of
  75832. ** a legal notice, here is a blessing:
  75833. **
  75834. ** May you do good and not evil.
  75835. ** May you find forgiveness for yourself and forgive others.
  75836. ** May you share freely, never taking more than you give.
  75837. **
  75838. *************************************************************************
  75839. **
  75840. ** This file contains code used to insert the values of host parameters
  75841. ** (aka "wildcards") into the SQL text output by sqlite3_trace().
  75842. **
  75843. ** The Vdbe parse-tree explainer is also found here.
  75844. */
  75845. /* #include "sqliteInt.h" */
  75846. /* #include "vdbeInt.h" */
  75847. #ifndef SQLITE_OMIT_TRACE
  75848. /*
  75849. ** zSql is a zero-terminated string of UTF-8 SQL text. Return the number of
  75850. ** bytes in this text up to but excluding the first character in
  75851. ** a host parameter. If the text contains no host parameters, return
  75852. ** the total number of bytes in the text.
  75853. */
  75854. static int findNextHostParameter(const char *zSql, int *pnToken){
  75855. int tokenType;
  75856. int nTotal = 0;
  75857. int n;
  75858. *pnToken = 0;
  75859. while( zSql[0] ){
  75860. n = sqlite3GetToken((u8*)zSql, &tokenType);
  75861. assert( n>0 && tokenType!=TK_ILLEGAL );
  75862. if( tokenType==TK_VARIABLE ){
  75863. *pnToken = n;
  75864. break;
  75865. }
  75866. nTotal += n;
  75867. zSql += n;
  75868. }
  75869. return nTotal;
  75870. }
  75871. /*
  75872. ** This function returns a pointer to a nul-terminated string in memory
  75873. ** obtained from sqlite3DbMalloc(). If sqlite3.nVdbeExec is 1, then the
  75874. ** string contains a copy of zRawSql but with host parameters expanded to
  75875. ** their current bindings. Or, if sqlite3.nVdbeExec is greater than 1,
  75876. ** then the returned string holds a copy of zRawSql with "-- " prepended
  75877. ** to each line of text.
  75878. **
  75879. ** If the SQLITE_TRACE_SIZE_LIMIT macro is defined to an integer, then
  75880. ** then long strings and blobs are truncated to that many bytes. This
  75881. ** can be used to prevent unreasonably large trace strings when dealing
  75882. ** with large (multi-megabyte) strings and blobs.
  75883. **
  75884. ** The calling function is responsible for making sure the memory returned
  75885. ** is eventually freed.
  75886. **
  75887. ** ALGORITHM: Scan the input string looking for host parameters in any of
  75888. ** these forms: ?, ?N, $A, @A, :A. Take care to avoid text within
  75889. ** string literals, quoted identifier names, and comments. For text forms,
  75890. ** the host parameter index is found by scanning the prepared
  75891. ** statement for the corresponding OP_Variable opcode. Once the host
  75892. ** parameter index is known, locate the value in p->aVar[]. Then render
  75893. ** the value as a literal in place of the host parameter name.
  75894. */
  75895. SQLITE_PRIVATE char *sqlite3VdbeExpandSql(
  75896. Vdbe *p, /* The prepared statement being evaluated */
  75897. const char *zRawSql /* Raw text of the SQL statement */
  75898. ){
  75899. sqlite3 *db; /* The database connection */
  75900. int idx = 0; /* Index of a host parameter */
  75901. int nextIndex = 1; /* Index of next ? host parameter */
  75902. int n; /* Length of a token prefix */
  75903. int nToken; /* Length of the parameter token */
  75904. int i; /* Loop counter */
  75905. Mem *pVar; /* Value of a host parameter */
  75906. StrAccum out; /* Accumulate the output here */
  75907. #ifndef SQLITE_OMIT_UTF16
  75908. Mem utf8; /* Used to convert UTF16 into UTF8 for display */
  75909. #endif
  75910. char zBase[100]; /* Initial working space */
  75911. db = p->db;
  75912. sqlite3StrAccumInit(&out, 0, zBase, sizeof(zBase),
  75913. db->aLimit[SQLITE_LIMIT_LENGTH]);
  75914. if( db->nVdbeExec>1 ){
  75915. while( *zRawSql ){
  75916. const char *zStart = zRawSql;
  75917. while( *(zRawSql++)!='\n' && *zRawSql );
  75918. sqlite3StrAccumAppend(&out, "-- ", 3);
  75919. assert( (zRawSql - zStart) > 0 );
  75920. sqlite3StrAccumAppend(&out, zStart, (int)(zRawSql-zStart));
  75921. }
  75922. }else if( p->nVar==0 ){
  75923. sqlite3StrAccumAppend(&out, zRawSql, sqlite3Strlen30(zRawSql));
  75924. }else{
  75925. while( zRawSql[0] ){
  75926. n = findNextHostParameter(zRawSql, &nToken);
  75927. assert( n>0 );
  75928. sqlite3StrAccumAppend(&out, zRawSql, n);
  75929. zRawSql += n;
  75930. assert( zRawSql[0] || nToken==0 );
  75931. if( nToken==0 ) break;
  75932. if( zRawSql[0]=='?' ){
  75933. if( nToken>1 ){
  75934. assert( sqlite3Isdigit(zRawSql[1]) );
  75935. sqlite3GetInt32(&zRawSql[1], &idx);
  75936. }else{
  75937. idx = nextIndex;
  75938. }
  75939. }else{
  75940. assert( zRawSql[0]==':' || zRawSql[0]=='$' ||
  75941. zRawSql[0]=='@' || zRawSql[0]=='#' );
  75942. testcase( zRawSql[0]==':' );
  75943. testcase( zRawSql[0]=='$' );
  75944. testcase( zRawSql[0]=='@' );
  75945. testcase( zRawSql[0]=='#' );
  75946. idx = sqlite3VdbeParameterIndex(p, zRawSql, nToken);
  75947. assert( idx>0 );
  75948. }
  75949. zRawSql += nToken;
  75950. nextIndex = idx + 1;
  75951. assert( idx>0 && idx<=p->nVar );
  75952. pVar = &p->aVar[idx-1];
  75953. if( pVar->flags & MEM_Null ){
  75954. sqlite3StrAccumAppend(&out, "NULL", 4);
  75955. }else if( pVar->flags & MEM_Int ){
  75956. sqlite3XPrintf(&out, "%lld", pVar->u.i);
  75957. }else if( pVar->flags & MEM_Real ){
  75958. sqlite3XPrintf(&out, "%!.15g", pVar->u.r);
  75959. }else if( pVar->flags & MEM_Str ){
  75960. int nOut; /* Number of bytes of the string text to include in output */
  75961. #ifndef SQLITE_OMIT_UTF16
  75962. u8 enc = ENC(db);
  75963. if( enc!=SQLITE_UTF8 ){
  75964. memset(&utf8, 0, sizeof(utf8));
  75965. utf8.db = db;
  75966. sqlite3VdbeMemSetStr(&utf8, pVar->z, pVar->n, enc, SQLITE_STATIC);
  75967. if( SQLITE_NOMEM==sqlite3VdbeChangeEncoding(&utf8, SQLITE_UTF8) ){
  75968. out.accError = STRACCUM_NOMEM;
  75969. out.nAlloc = 0;
  75970. }
  75971. pVar = &utf8;
  75972. }
  75973. #endif
  75974. nOut = pVar->n;
  75975. #ifdef SQLITE_TRACE_SIZE_LIMIT
  75976. if( nOut>SQLITE_TRACE_SIZE_LIMIT ){
  75977. nOut = SQLITE_TRACE_SIZE_LIMIT;
  75978. while( nOut<pVar->n && (pVar->z[nOut]&0xc0)==0x80 ){ nOut++; }
  75979. }
  75980. #endif
  75981. sqlite3XPrintf(&out, "'%.*q'", nOut, pVar->z);
  75982. #ifdef SQLITE_TRACE_SIZE_LIMIT
  75983. if( nOut<pVar->n ){
  75984. sqlite3XPrintf(&out, "/*+%d bytes*/", pVar->n-nOut);
  75985. }
  75986. #endif
  75987. #ifndef SQLITE_OMIT_UTF16
  75988. if( enc!=SQLITE_UTF8 ) sqlite3VdbeMemRelease(&utf8);
  75989. #endif
  75990. }else if( pVar->flags & MEM_Zero ){
  75991. sqlite3XPrintf(&out, "zeroblob(%d)", pVar->u.nZero);
  75992. }else{
  75993. int nOut; /* Number of bytes of the blob to include in output */
  75994. assert( pVar->flags & MEM_Blob );
  75995. sqlite3StrAccumAppend(&out, "x'", 2);
  75996. nOut = pVar->n;
  75997. #ifdef SQLITE_TRACE_SIZE_LIMIT
  75998. if( nOut>SQLITE_TRACE_SIZE_LIMIT ) nOut = SQLITE_TRACE_SIZE_LIMIT;
  75999. #endif
  76000. for(i=0; i<nOut; i++){
  76001. sqlite3XPrintf(&out, "%02x", pVar->z[i]&0xff);
  76002. }
  76003. sqlite3StrAccumAppend(&out, "'", 1);
  76004. #ifdef SQLITE_TRACE_SIZE_LIMIT
  76005. if( nOut<pVar->n ){
  76006. sqlite3XPrintf(&out, "/*+%d bytes*/", pVar->n-nOut);
  76007. }
  76008. #endif
  76009. }
  76010. }
  76011. }
  76012. if( out.accError ) sqlite3StrAccumReset(&out);
  76013. return sqlite3StrAccumFinish(&out);
  76014. }
  76015. #endif /* #ifndef SQLITE_OMIT_TRACE */
  76016. /************** End of vdbetrace.c *******************************************/
  76017. /************** Begin file vdbe.c ********************************************/
  76018. /*
  76019. ** 2001 September 15
  76020. **
  76021. ** The author disclaims copyright to this source code. In place of
  76022. ** a legal notice, here is a blessing:
  76023. **
  76024. ** May you do good and not evil.
  76025. ** May you find forgiveness for yourself and forgive others.
  76026. ** May you share freely, never taking more than you give.
  76027. **
  76028. *************************************************************************
  76029. ** The code in this file implements the function that runs the
  76030. ** bytecode of a prepared statement.
  76031. **
  76032. ** Various scripts scan this source file in order to generate HTML
  76033. ** documentation, headers files, or other derived files. The formatting
  76034. ** of the code in this file is, therefore, important. See other comments
  76035. ** in this file for details. If in doubt, do not deviate from existing
  76036. ** commenting and indentation practices when changing or adding code.
  76037. */
  76038. /* #include "sqliteInt.h" */
  76039. /* #include "vdbeInt.h" */
  76040. /*
  76041. ** Invoke this macro on memory cells just prior to changing the
  76042. ** value of the cell. This macro verifies that shallow copies are
  76043. ** not misused. A shallow copy of a string or blob just copies a
  76044. ** pointer to the string or blob, not the content. If the original
  76045. ** is changed while the copy is still in use, the string or blob might
  76046. ** be changed out from under the copy. This macro verifies that nothing
  76047. ** like that ever happens.
  76048. */
  76049. #ifdef SQLITE_DEBUG
  76050. # define memAboutToChange(P,M) sqlite3VdbeMemAboutToChange(P,M)
  76051. #else
  76052. # define memAboutToChange(P,M)
  76053. #endif
  76054. /*
  76055. ** The following global variable is incremented every time a cursor
  76056. ** moves, either by the OP_SeekXX, OP_Next, or OP_Prev opcodes. The test
  76057. ** procedures use this information to make sure that indices are
  76058. ** working correctly. This variable has no function other than to
  76059. ** help verify the correct operation of the library.
  76060. */
  76061. #ifdef SQLITE_TEST
  76062. SQLITE_API int sqlite3_search_count = 0;
  76063. #endif
  76064. /*
  76065. ** When this global variable is positive, it gets decremented once before
  76066. ** each instruction in the VDBE. When it reaches zero, the u1.isInterrupted
  76067. ** field of the sqlite3 structure is set in order to simulate an interrupt.
  76068. **
  76069. ** This facility is used for testing purposes only. It does not function
  76070. ** in an ordinary build.
  76071. */
  76072. #ifdef SQLITE_TEST
  76073. SQLITE_API int sqlite3_interrupt_count = 0;
  76074. #endif
  76075. /*
  76076. ** The next global variable is incremented each type the OP_Sort opcode
  76077. ** is executed. The test procedures use this information to make sure that
  76078. ** sorting is occurring or not occurring at appropriate times. This variable
  76079. ** has no function other than to help verify the correct operation of the
  76080. ** library.
  76081. */
  76082. #ifdef SQLITE_TEST
  76083. SQLITE_API int sqlite3_sort_count = 0;
  76084. #endif
  76085. /*
  76086. ** The next global variable records the size of the largest MEM_Blob
  76087. ** or MEM_Str that has been used by a VDBE opcode. The test procedures
  76088. ** use this information to make sure that the zero-blob functionality
  76089. ** is working correctly. This variable has no function other than to
  76090. ** help verify the correct operation of the library.
  76091. */
  76092. #ifdef SQLITE_TEST
  76093. SQLITE_API int sqlite3_max_blobsize = 0;
  76094. static void updateMaxBlobsize(Mem *p){
  76095. if( (p->flags & (MEM_Str|MEM_Blob))!=0 && p->n>sqlite3_max_blobsize ){
  76096. sqlite3_max_blobsize = p->n;
  76097. }
  76098. }
  76099. #endif
  76100. /*
  76101. ** This macro evaluates to true if either the update hook or the preupdate
  76102. ** hook are enabled for database connect DB.
  76103. */
  76104. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  76105. # define HAS_UPDATE_HOOK(DB) ((DB)->xPreUpdateCallback||(DB)->xUpdateCallback)
  76106. #else
  76107. # define HAS_UPDATE_HOOK(DB) ((DB)->xUpdateCallback)
  76108. #endif
  76109. /*
  76110. ** The next global variable is incremented each time the OP_Found opcode
  76111. ** is executed. This is used to test whether or not the foreign key
  76112. ** operation implemented using OP_FkIsZero is working. This variable
  76113. ** has no function other than to help verify the correct operation of the
  76114. ** library.
  76115. */
  76116. #ifdef SQLITE_TEST
  76117. SQLITE_API int sqlite3_found_count = 0;
  76118. #endif
  76119. /*
  76120. ** Test a register to see if it exceeds the current maximum blob size.
  76121. ** If it does, record the new maximum blob size.
  76122. */
  76123. #if defined(SQLITE_TEST) && !defined(SQLITE_UNTESTABLE)
  76124. # define UPDATE_MAX_BLOBSIZE(P) updateMaxBlobsize(P)
  76125. #else
  76126. # define UPDATE_MAX_BLOBSIZE(P)
  76127. #endif
  76128. /*
  76129. ** Invoke the VDBE coverage callback, if that callback is defined. This
  76130. ** feature is used for test suite validation only and does not appear an
  76131. ** production builds.
  76132. **
  76133. ** M is an integer, 2 or 3, that indices how many different ways the
  76134. ** branch can go. It is usually 2. "I" is the direction the branch
  76135. ** goes. 0 means falls through. 1 means branch is taken. 2 means the
  76136. ** second alternative branch is taken.
  76137. **
  76138. ** iSrcLine is the source code line (from the __LINE__ macro) that
  76139. ** generated the VDBE instruction. This instrumentation assumes that all
  76140. ** source code is in a single file (the amalgamation). Special values 1
  76141. ** and 2 for the iSrcLine parameter mean that this particular branch is
  76142. ** always taken or never taken, respectively.
  76143. */
  76144. #if !defined(SQLITE_VDBE_COVERAGE)
  76145. # define VdbeBranchTaken(I,M)
  76146. #else
  76147. # define VdbeBranchTaken(I,M) vdbeTakeBranch(pOp->iSrcLine,I,M)
  76148. static void vdbeTakeBranch(int iSrcLine, u8 I, u8 M){
  76149. if( iSrcLine<=2 && ALWAYS(iSrcLine>0) ){
  76150. M = iSrcLine;
  76151. /* Assert the truth of VdbeCoverageAlwaysTaken() and
  76152. ** VdbeCoverageNeverTaken() */
  76153. assert( (M & I)==I );
  76154. }else{
  76155. if( sqlite3GlobalConfig.xVdbeBranch==0 ) return; /*NO_TEST*/
  76156. sqlite3GlobalConfig.xVdbeBranch(sqlite3GlobalConfig.pVdbeBranchArg,
  76157. iSrcLine,I,M);
  76158. }
  76159. }
  76160. #endif
  76161. /*
  76162. ** Convert the given register into a string if it isn't one
  76163. ** already. Return non-zero if a malloc() fails.
  76164. */
  76165. #define Stringify(P, enc) \
  76166. if(((P)->flags&(MEM_Str|MEM_Blob))==0 && sqlite3VdbeMemStringify(P,enc,0)) \
  76167. { goto no_mem; }
  76168. /*
  76169. ** An ephemeral string value (signified by the MEM_Ephem flag) contains
  76170. ** a pointer to a dynamically allocated string where some other entity
  76171. ** is responsible for deallocating that string. Because the register
  76172. ** does not control the string, it might be deleted without the register
  76173. ** knowing it.
  76174. **
  76175. ** This routine converts an ephemeral string into a dynamically allocated
  76176. ** string that the register itself controls. In other words, it
  76177. ** converts an MEM_Ephem string into a string with P.z==P.zMalloc.
  76178. */
  76179. #define Deephemeralize(P) \
  76180. if( ((P)->flags&MEM_Ephem)!=0 \
  76181. && sqlite3VdbeMemMakeWriteable(P) ){ goto no_mem;}
  76182. /* Return true if the cursor was opened using the OP_OpenSorter opcode. */
  76183. #define isSorter(x) ((x)->eCurType==CURTYPE_SORTER)
  76184. /*
  76185. ** Allocate VdbeCursor number iCur. Return a pointer to it. Return NULL
  76186. ** if we run out of memory.
  76187. */
  76188. static VdbeCursor *allocateCursor(
  76189. Vdbe *p, /* The virtual machine */
  76190. int iCur, /* Index of the new VdbeCursor */
  76191. int nField, /* Number of fields in the table or index */
  76192. int iDb, /* Database the cursor belongs to, or -1 */
  76193. u8 eCurType /* Type of the new cursor */
  76194. ){
  76195. /* Find the memory cell that will be used to store the blob of memory
  76196. ** required for this VdbeCursor structure. It is convenient to use a
  76197. ** vdbe memory cell to manage the memory allocation required for a
  76198. ** VdbeCursor structure for the following reasons:
  76199. **
  76200. ** * Sometimes cursor numbers are used for a couple of different
  76201. ** purposes in a vdbe program. The different uses might require
  76202. ** different sized allocations. Memory cells provide growable
  76203. ** allocations.
  76204. **
  76205. ** * When using ENABLE_MEMORY_MANAGEMENT, memory cell buffers can
  76206. ** be freed lazily via the sqlite3_release_memory() API. This
  76207. ** minimizes the number of malloc calls made by the system.
  76208. **
  76209. ** The memory cell for cursor 0 is aMem[0]. The rest are allocated from
  76210. ** the top of the register space. Cursor 1 is at Mem[p->nMem-1].
  76211. ** Cursor 2 is at Mem[p->nMem-2]. And so forth.
  76212. */
  76213. Mem *pMem = iCur>0 ? &p->aMem[p->nMem-iCur] : p->aMem;
  76214. int nByte;
  76215. VdbeCursor *pCx = 0;
  76216. nByte =
  76217. ROUND8(sizeof(VdbeCursor)) + 2*sizeof(u32)*nField +
  76218. (eCurType==CURTYPE_BTREE?sqlite3BtreeCursorSize():0);
  76219. assert( iCur>=0 && iCur<p->nCursor );
  76220. if( p->apCsr[iCur] ){ /*OPTIMIZATION-IF-FALSE*/
  76221. sqlite3VdbeFreeCursor(p, p->apCsr[iCur]);
  76222. p->apCsr[iCur] = 0;
  76223. }
  76224. if( SQLITE_OK==sqlite3VdbeMemClearAndResize(pMem, nByte) ){
  76225. p->apCsr[iCur] = pCx = (VdbeCursor*)pMem->z;
  76226. memset(pCx, 0, offsetof(VdbeCursor,pAltCursor));
  76227. pCx->eCurType = eCurType;
  76228. pCx->iDb = iDb;
  76229. pCx->nField = nField;
  76230. pCx->aOffset = &pCx->aType[nField];
  76231. if( eCurType==CURTYPE_BTREE ){
  76232. pCx->uc.pCursor = (BtCursor*)
  76233. &pMem->z[ROUND8(sizeof(VdbeCursor))+2*sizeof(u32)*nField];
  76234. sqlite3BtreeCursorZero(pCx->uc.pCursor);
  76235. }
  76236. }
  76237. return pCx;
  76238. }
  76239. /*
  76240. ** Try to convert a value into a numeric representation if we can
  76241. ** do so without loss of information. In other words, if the string
  76242. ** looks like a number, convert it into a number. If it does not
  76243. ** look like a number, leave it alone.
  76244. **
  76245. ** If the bTryForInt flag is true, then extra effort is made to give
  76246. ** an integer representation. Strings that look like floating point
  76247. ** values but which have no fractional component (example: '48.00')
  76248. ** will have a MEM_Int representation when bTryForInt is true.
  76249. **
  76250. ** If bTryForInt is false, then if the input string contains a decimal
  76251. ** point or exponential notation, the result is only MEM_Real, even
  76252. ** if there is an exact integer representation of the quantity.
  76253. */
  76254. static void applyNumericAffinity(Mem *pRec, int bTryForInt){
  76255. double rValue;
  76256. i64 iValue;
  76257. u8 enc = pRec->enc;
  76258. assert( (pRec->flags & (MEM_Str|MEM_Int|MEM_Real))==MEM_Str );
  76259. if( sqlite3AtoF(pRec->z, &rValue, pRec->n, enc)==0 ) return;
  76260. if( 0==sqlite3Atoi64(pRec->z, &iValue, pRec->n, enc) ){
  76261. pRec->u.i = iValue;
  76262. pRec->flags |= MEM_Int;
  76263. }else{
  76264. pRec->u.r = rValue;
  76265. pRec->flags |= MEM_Real;
  76266. if( bTryForInt ) sqlite3VdbeIntegerAffinity(pRec);
  76267. }
  76268. /* TEXT->NUMERIC is many->one. Hence, it is important to invalidate the
  76269. ** string representation after computing a numeric equivalent, because the
  76270. ** string representation might not be the canonical representation for the
  76271. ** numeric value. Ticket [343634942dd54ab57b7024] 2018-01-31. */
  76272. pRec->flags &= ~MEM_Str;
  76273. }
  76274. /*
  76275. ** Processing is determine by the affinity parameter:
  76276. **
  76277. ** SQLITE_AFF_INTEGER:
  76278. ** SQLITE_AFF_REAL:
  76279. ** SQLITE_AFF_NUMERIC:
  76280. ** Try to convert pRec to an integer representation or a
  76281. ** floating-point representation if an integer representation
  76282. ** is not possible. Note that the integer representation is
  76283. ** always preferred, even if the affinity is REAL, because
  76284. ** an integer representation is more space efficient on disk.
  76285. **
  76286. ** SQLITE_AFF_TEXT:
  76287. ** Convert pRec to a text representation.
  76288. **
  76289. ** SQLITE_AFF_BLOB:
  76290. ** No-op. pRec is unchanged.
  76291. */
  76292. static void applyAffinity(
  76293. Mem *pRec, /* The value to apply affinity to */
  76294. char affinity, /* The affinity to be applied */
  76295. u8 enc /* Use this text encoding */
  76296. ){
  76297. if( affinity>=SQLITE_AFF_NUMERIC ){
  76298. assert( affinity==SQLITE_AFF_INTEGER || affinity==SQLITE_AFF_REAL
  76299. || affinity==SQLITE_AFF_NUMERIC );
  76300. if( (pRec->flags & MEM_Int)==0 ){ /*OPTIMIZATION-IF-FALSE*/
  76301. if( (pRec->flags & MEM_Real)==0 ){
  76302. if( pRec->flags & MEM_Str ) applyNumericAffinity(pRec,1);
  76303. }else{
  76304. sqlite3VdbeIntegerAffinity(pRec);
  76305. }
  76306. }
  76307. }else if( affinity==SQLITE_AFF_TEXT ){
  76308. /* Only attempt the conversion to TEXT if there is an integer or real
  76309. ** representation (blob and NULL do not get converted) but no string
  76310. ** representation. It would be harmless to repeat the conversion if
  76311. ** there is already a string rep, but it is pointless to waste those
  76312. ** CPU cycles. */
  76313. if( 0==(pRec->flags&MEM_Str) ){ /*OPTIMIZATION-IF-FALSE*/
  76314. if( (pRec->flags&(MEM_Real|MEM_Int)) ){
  76315. sqlite3VdbeMemStringify(pRec, enc, 1);
  76316. }
  76317. }
  76318. pRec->flags &= ~(MEM_Real|MEM_Int);
  76319. }
  76320. }
  76321. /*
  76322. ** Try to convert the type of a function argument or a result column
  76323. ** into a numeric representation. Use either INTEGER or REAL whichever
  76324. ** is appropriate. But only do the conversion if it is possible without
  76325. ** loss of information and return the revised type of the argument.
  76326. */
  76327. SQLITE_API int sqlite3_value_numeric_type(sqlite3_value *pVal){
  76328. int eType = sqlite3_value_type(pVal);
  76329. if( eType==SQLITE_TEXT ){
  76330. Mem *pMem = (Mem*)pVal;
  76331. applyNumericAffinity(pMem, 0);
  76332. eType = sqlite3_value_type(pVal);
  76333. }
  76334. return eType;
  76335. }
  76336. /*
  76337. ** Exported version of applyAffinity(). This one works on sqlite3_value*,
  76338. ** not the internal Mem* type.
  76339. */
  76340. SQLITE_PRIVATE void sqlite3ValueApplyAffinity(
  76341. sqlite3_value *pVal,
  76342. u8 affinity,
  76343. u8 enc
  76344. ){
  76345. applyAffinity((Mem *)pVal, affinity, enc);
  76346. }
  76347. /*
  76348. ** pMem currently only holds a string type (or maybe a BLOB that we can
  76349. ** interpret as a string if we want to). Compute its corresponding
  76350. ** numeric type, if has one. Set the pMem->u.r and pMem->u.i fields
  76351. ** accordingly.
  76352. */
  76353. static u16 SQLITE_NOINLINE computeNumericType(Mem *pMem){
  76354. assert( (pMem->flags & (MEM_Int|MEM_Real))==0 );
  76355. assert( (pMem->flags & (MEM_Str|MEM_Blob))!=0 );
  76356. if( sqlite3AtoF(pMem->z, &pMem->u.r, pMem->n, pMem->enc)==0 ){
  76357. return 0;
  76358. }
  76359. if( sqlite3Atoi64(pMem->z, &pMem->u.i, pMem->n, pMem->enc)==0 ){
  76360. return MEM_Int;
  76361. }
  76362. return MEM_Real;
  76363. }
  76364. /*
  76365. ** Return the numeric type for pMem, either MEM_Int or MEM_Real or both or
  76366. ** none.
  76367. **
  76368. ** Unlike applyNumericAffinity(), this routine does not modify pMem->flags.
  76369. ** But it does set pMem->u.r and pMem->u.i appropriately.
  76370. */
  76371. static u16 numericType(Mem *pMem){
  76372. if( pMem->flags & (MEM_Int|MEM_Real) ){
  76373. return pMem->flags & (MEM_Int|MEM_Real);
  76374. }
  76375. if( pMem->flags & (MEM_Str|MEM_Blob) ){
  76376. return computeNumericType(pMem);
  76377. }
  76378. return 0;
  76379. }
  76380. #ifdef SQLITE_DEBUG
  76381. /*
  76382. ** Write a nice string representation of the contents of cell pMem
  76383. ** into buffer zBuf, length nBuf.
  76384. */
  76385. SQLITE_PRIVATE void sqlite3VdbeMemPrettyPrint(Mem *pMem, char *zBuf){
  76386. char *zCsr = zBuf;
  76387. int f = pMem->flags;
  76388. static const char *const encnames[] = {"(X)", "(8)", "(16LE)", "(16BE)"};
  76389. if( f&MEM_Blob ){
  76390. int i;
  76391. char c;
  76392. if( f & MEM_Dyn ){
  76393. c = 'z';
  76394. assert( (f & (MEM_Static|MEM_Ephem))==0 );
  76395. }else if( f & MEM_Static ){
  76396. c = 't';
  76397. assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
  76398. }else if( f & MEM_Ephem ){
  76399. c = 'e';
  76400. assert( (f & (MEM_Static|MEM_Dyn))==0 );
  76401. }else{
  76402. c = 's';
  76403. }
  76404. *(zCsr++) = c;
  76405. sqlite3_snprintf(100, zCsr, "%d[", pMem->n);
  76406. zCsr += sqlite3Strlen30(zCsr);
  76407. for(i=0; i<16 && i<pMem->n; i++){
  76408. sqlite3_snprintf(100, zCsr, "%02X", ((int)pMem->z[i] & 0xFF));
  76409. zCsr += sqlite3Strlen30(zCsr);
  76410. }
  76411. for(i=0; i<16 && i<pMem->n; i++){
  76412. char z = pMem->z[i];
  76413. if( z<32 || z>126 ) *zCsr++ = '.';
  76414. else *zCsr++ = z;
  76415. }
  76416. *(zCsr++) = ']';
  76417. if( f & MEM_Zero ){
  76418. sqlite3_snprintf(100, zCsr,"+%dz",pMem->u.nZero);
  76419. zCsr += sqlite3Strlen30(zCsr);
  76420. }
  76421. *zCsr = '\0';
  76422. }else if( f & MEM_Str ){
  76423. int j, k;
  76424. zBuf[0] = ' ';
  76425. if( f & MEM_Dyn ){
  76426. zBuf[1] = 'z';
  76427. assert( (f & (MEM_Static|MEM_Ephem))==0 );
  76428. }else if( f & MEM_Static ){
  76429. zBuf[1] = 't';
  76430. assert( (f & (MEM_Dyn|MEM_Ephem))==0 );
  76431. }else if( f & MEM_Ephem ){
  76432. zBuf[1] = 'e';
  76433. assert( (f & (MEM_Static|MEM_Dyn))==0 );
  76434. }else{
  76435. zBuf[1] = 's';
  76436. }
  76437. k = 2;
  76438. sqlite3_snprintf(100, &zBuf[k], "%d", pMem->n);
  76439. k += sqlite3Strlen30(&zBuf[k]);
  76440. zBuf[k++] = '[';
  76441. for(j=0; j<15 && j<pMem->n; j++){
  76442. u8 c = pMem->z[j];
  76443. if( c>=0x20 && c<0x7f ){
  76444. zBuf[k++] = c;
  76445. }else{
  76446. zBuf[k++] = '.';
  76447. }
  76448. }
  76449. zBuf[k++] = ']';
  76450. sqlite3_snprintf(100,&zBuf[k], encnames[pMem->enc]);
  76451. k += sqlite3Strlen30(&zBuf[k]);
  76452. zBuf[k++] = 0;
  76453. }
  76454. }
  76455. #endif
  76456. #ifdef SQLITE_DEBUG
  76457. /*
  76458. ** Print the value of a register for tracing purposes:
  76459. */
  76460. static void memTracePrint(Mem *p){
  76461. if( p->flags & MEM_Undefined ){
  76462. printf(" undefined");
  76463. }else if( p->flags & MEM_Null ){
  76464. printf(p->flags & MEM_Zero ? " NULL-nochng" : " NULL");
  76465. }else if( (p->flags & (MEM_Int|MEM_Str))==(MEM_Int|MEM_Str) ){
  76466. printf(" si:%lld", p->u.i);
  76467. }else if( p->flags & MEM_Int ){
  76468. printf(" i:%lld", p->u.i);
  76469. #ifndef SQLITE_OMIT_FLOATING_POINT
  76470. }else if( p->flags & MEM_Real ){
  76471. printf(" r:%g", p->u.r);
  76472. #endif
  76473. }else if( p->flags & MEM_RowSet ){
  76474. printf(" (rowset)");
  76475. }else{
  76476. char zBuf[200];
  76477. sqlite3VdbeMemPrettyPrint(p, zBuf);
  76478. printf(" %s", zBuf);
  76479. }
  76480. if( p->flags & MEM_Subtype ) printf(" subtype=0x%02x", p->eSubtype);
  76481. }
  76482. static void registerTrace(int iReg, Mem *p){
  76483. printf("REG[%d] = ", iReg);
  76484. memTracePrint(p);
  76485. printf("\n");
  76486. sqlite3VdbeCheckMemInvariants(p);
  76487. }
  76488. #endif
  76489. #ifdef SQLITE_DEBUG
  76490. # define REGISTER_TRACE(R,M) if(db->flags&SQLITE_VdbeTrace)registerTrace(R,M)
  76491. #else
  76492. # define REGISTER_TRACE(R,M)
  76493. #endif
  76494. #ifdef VDBE_PROFILE
  76495. /*
  76496. ** hwtime.h contains inline assembler code for implementing
  76497. ** high-performance timing routines.
  76498. */
  76499. /************** Include hwtime.h in the middle of vdbe.c *********************/
  76500. /************** Begin file hwtime.h ******************************************/
  76501. /*
  76502. ** 2008 May 27
  76503. **
  76504. ** The author disclaims copyright to this source code. In place of
  76505. ** a legal notice, here is a blessing:
  76506. **
  76507. ** May you do good and not evil.
  76508. ** May you find forgiveness for yourself and forgive others.
  76509. ** May you share freely, never taking more than you give.
  76510. **
  76511. ******************************************************************************
  76512. **
  76513. ** This file contains inline asm code for retrieving "high-performance"
  76514. ** counters for x86 class CPUs.
  76515. */
  76516. #ifndef SQLITE_HWTIME_H
  76517. #define SQLITE_HWTIME_H
  76518. /*
  76519. ** The following routine only works on pentium-class (or newer) processors.
  76520. ** It uses the RDTSC opcode to read the cycle count value out of the
  76521. ** processor and returns that value. This can be used for high-res
  76522. ** profiling.
  76523. */
  76524. #if (defined(__GNUC__) || defined(_MSC_VER)) && \
  76525. (defined(i386) || defined(__i386__) || defined(_M_IX86))
  76526. #if defined(__GNUC__)
  76527. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  76528. unsigned int lo, hi;
  76529. __asm__ __volatile__ ("rdtsc" : "=a" (lo), "=d" (hi));
  76530. return (sqlite_uint64)hi << 32 | lo;
  76531. }
  76532. #elif defined(_MSC_VER)
  76533. __declspec(naked) __inline sqlite_uint64 __cdecl sqlite3Hwtime(void){
  76534. __asm {
  76535. rdtsc
  76536. ret ; return value at EDX:EAX
  76537. }
  76538. }
  76539. #endif
  76540. #elif (defined(__GNUC__) && defined(__x86_64__))
  76541. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  76542. unsigned long val;
  76543. __asm__ __volatile__ ("rdtsc" : "=A" (val));
  76544. return val;
  76545. }
  76546. #elif (defined(__GNUC__) && defined(__ppc__))
  76547. __inline__ sqlite_uint64 sqlite3Hwtime(void){
  76548. unsigned long long retval;
  76549. unsigned long junk;
  76550. __asm__ __volatile__ ("\n\
  76551. 1: mftbu %1\n\
  76552. mftb %L0\n\
  76553. mftbu %0\n\
  76554. cmpw %0,%1\n\
  76555. bne 1b"
  76556. : "=r" (retval), "=r" (junk));
  76557. return retval;
  76558. }
  76559. #else
  76560. #error Need implementation of sqlite3Hwtime() for your platform.
  76561. /*
  76562. ** To compile without implementing sqlite3Hwtime() for your platform,
  76563. ** you can remove the above #error and use the following
  76564. ** stub function. You will lose timing support for many
  76565. ** of the debugging and testing utilities, but it should at
  76566. ** least compile and run.
  76567. */
  76568. SQLITE_PRIVATE sqlite_uint64 sqlite3Hwtime(void){ return ((sqlite_uint64)0); }
  76569. #endif
  76570. #endif /* !defined(SQLITE_HWTIME_H) */
  76571. /************** End of hwtime.h **********************************************/
  76572. /************** Continuing where we left off in vdbe.c ***********************/
  76573. #endif
  76574. #ifndef NDEBUG
  76575. /*
  76576. ** This function is only called from within an assert() expression. It
  76577. ** checks that the sqlite3.nTransaction variable is correctly set to
  76578. ** the number of non-transaction savepoints currently in the
  76579. ** linked list starting at sqlite3.pSavepoint.
  76580. **
  76581. ** Usage:
  76582. **
  76583. ** assert( checkSavepointCount(db) );
  76584. */
  76585. static int checkSavepointCount(sqlite3 *db){
  76586. int n = 0;
  76587. Savepoint *p;
  76588. for(p=db->pSavepoint; p; p=p->pNext) n++;
  76589. assert( n==(db->nSavepoint + db->isTransactionSavepoint) );
  76590. return 1;
  76591. }
  76592. #endif
  76593. /*
  76594. ** Return the register of pOp->p2 after first preparing it to be
  76595. ** overwritten with an integer value.
  76596. */
  76597. static SQLITE_NOINLINE Mem *out2PrereleaseWithClear(Mem *pOut){
  76598. sqlite3VdbeMemSetNull(pOut);
  76599. pOut->flags = MEM_Int;
  76600. return pOut;
  76601. }
  76602. static Mem *out2Prerelease(Vdbe *p, VdbeOp *pOp){
  76603. Mem *pOut;
  76604. assert( pOp->p2>0 );
  76605. assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
  76606. pOut = &p->aMem[pOp->p2];
  76607. memAboutToChange(p, pOut);
  76608. if( VdbeMemDynamic(pOut) ){ /*OPTIMIZATION-IF-FALSE*/
  76609. return out2PrereleaseWithClear(pOut);
  76610. }else{
  76611. pOut->flags = MEM_Int;
  76612. return pOut;
  76613. }
  76614. }
  76615. /*
  76616. ** Execute as much of a VDBE program as we can.
  76617. ** This is the core of sqlite3_step().
  76618. */
  76619. SQLITE_PRIVATE int sqlite3VdbeExec(
  76620. Vdbe *p /* The VDBE */
  76621. ){
  76622. Op *aOp = p->aOp; /* Copy of p->aOp */
  76623. Op *pOp = aOp; /* Current operation */
  76624. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  76625. Op *pOrigOp; /* Value of pOp at the top of the loop */
  76626. #endif
  76627. #ifdef SQLITE_DEBUG
  76628. int nExtraDelete = 0; /* Verifies FORDELETE and AUXDELETE flags */
  76629. #endif
  76630. int rc = SQLITE_OK; /* Value to return */
  76631. sqlite3 *db = p->db; /* The database */
  76632. u8 resetSchemaOnFault = 0; /* Reset schema after an error if positive */
  76633. u8 encoding = ENC(db); /* The database encoding */
  76634. int iCompare = 0; /* Result of last comparison */
  76635. unsigned nVmStep = 0; /* Number of virtual machine steps */
  76636. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  76637. unsigned nProgressLimit; /* Invoke xProgress() when nVmStep reaches this */
  76638. #endif
  76639. Mem *aMem = p->aMem; /* Copy of p->aMem */
  76640. Mem *pIn1 = 0; /* 1st input operand */
  76641. Mem *pIn2 = 0; /* 2nd input operand */
  76642. Mem *pIn3 = 0; /* 3rd input operand */
  76643. Mem *pOut = 0; /* Output operand */
  76644. #ifdef VDBE_PROFILE
  76645. u64 start; /* CPU clock count at start of opcode */
  76646. #endif
  76647. /*** INSERT STACK UNION HERE ***/
  76648. assert( p->magic==VDBE_MAGIC_RUN ); /* sqlite3_step() verifies this */
  76649. sqlite3VdbeEnter(p);
  76650. if( p->rc==SQLITE_NOMEM ){
  76651. /* This happens if a malloc() inside a call to sqlite3_column_text() or
  76652. ** sqlite3_column_text16() failed. */
  76653. goto no_mem;
  76654. }
  76655. assert( p->rc==SQLITE_OK || (p->rc&0xff)==SQLITE_BUSY );
  76656. assert( p->bIsReader || p->readOnly!=0 );
  76657. p->iCurrentTime = 0;
  76658. assert( p->explain==0 );
  76659. p->pResultSet = 0;
  76660. db->busyHandler.nBusy = 0;
  76661. if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
  76662. sqlite3VdbeIOTraceSql(p);
  76663. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  76664. if( db->xProgress ){
  76665. u32 iPrior = p->aCounter[SQLITE_STMTSTATUS_VM_STEP];
  76666. assert( 0 < db->nProgressOps );
  76667. nProgressLimit = db->nProgressOps - (iPrior % db->nProgressOps);
  76668. }else{
  76669. nProgressLimit = 0xffffffff;
  76670. }
  76671. #endif
  76672. #ifdef SQLITE_DEBUG
  76673. sqlite3BeginBenignMalloc();
  76674. if( p->pc==0
  76675. && (p->db->flags & (SQLITE_VdbeListing|SQLITE_VdbeEQP|SQLITE_VdbeTrace))!=0
  76676. ){
  76677. int i;
  76678. int once = 1;
  76679. sqlite3VdbePrintSql(p);
  76680. if( p->db->flags & SQLITE_VdbeListing ){
  76681. printf("VDBE Program Listing:\n");
  76682. for(i=0; i<p->nOp; i++){
  76683. sqlite3VdbePrintOp(stdout, i, &aOp[i]);
  76684. }
  76685. }
  76686. if( p->db->flags & SQLITE_VdbeEQP ){
  76687. for(i=0; i<p->nOp; i++){
  76688. if( aOp[i].opcode==OP_Explain ){
  76689. if( once ) printf("VDBE Query Plan:\n");
  76690. printf("%s\n", aOp[i].p4.z);
  76691. once = 0;
  76692. }
  76693. }
  76694. }
  76695. if( p->db->flags & SQLITE_VdbeTrace ) printf("VDBE Trace:\n");
  76696. }
  76697. sqlite3EndBenignMalloc();
  76698. #endif
  76699. for(pOp=&aOp[p->pc]; 1; pOp++){
  76700. /* Errors are detected by individual opcodes, with an immediate
  76701. ** jumps to abort_due_to_error. */
  76702. assert( rc==SQLITE_OK );
  76703. assert( pOp>=aOp && pOp<&aOp[p->nOp]);
  76704. #ifdef VDBE_PROFILE
  76705. start = sqlite3NProfileCnt ? sqlite3NProfileCnt : sqlite3Hwtime();
  76706. #endif
  76707. nVmStep++;
  76708. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  76709. if( p->anExec ) p->anExec[(int)(pOp-aOp)]++;
  76710. #endif
  76711. /* Only allow tracing if SQLITE_DEBUG is defined.
  76712. */
  76713. #ifdef SQLITE_DEBUG
  76714. if( db->flags & SQLITE_VdbeTrace ){
  76715. sqlite3VdbePrintOp(stdout, (int)(pOp - aOp), pOp);
  76716. }
  76717. #endif
  76718. /* Check to see if we need to simulate an interrupt. This only happens
  76719. ** if we have a special test build.
  76720. */
  76721. #ifdef SQLITE_TEST
  76722. if( sqlite3_interrupt_count>0 ){
  76723. sqlite3_interrupt_count--;
  76724. if( sqlite3_interrupt_count==0 ){
  76725. sqlite3_interrupt(db);
  76726. }
  76727. }
  76728. #endif
  76729. /* Sanity checking on other operands */
  76730. #ifdef SQLITE_DEBUG
  76731. {
  76732. u8 opProperty = sqlite3OpcodeProperty[pOp->opcode];
  76733. if( (opProperty & OPFLG_IN1)!=0 ){
  76734. assert( pOp->p1>0 );
  76735. assert( pOp->p1<=(p->nMem+1 - p->nCursor) );
  76736. assert( memIsValid(&aMem[pOp->p1]) );
  76737. assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p1]) );
  76738. REGISTER_TRACE(pOp->p1, &aMem[pOp->p1]);
  76739. }
  76740. if( (opProperty & OPFLG_IN2)!=0 ){
  76741. assert( pOp->p2>0 );
  76742. assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
  76743. assert( memIsValid(&aMem[pOp->p2]) );
  76744. assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p2]) );
  76745. REGISTER_TRACE(pOp->p2, &aMem[pOp->p2]);
  76746. }
  76747. if( (opProperty & OPFLG_IN3)!=0 ){
  76748. assert( pOp->p3>0 );
  76749. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  76750. assert( memIsValid(&aMem[pOp->p3]) );
  76751. assert( sqlite3VdbeCheckMemInvariants(&aMem[pOp->p3]) );
  76752. REGISTER_TRACE(pOp->p3, &aMem[pOp->p3]);
  76753. }
  76754. if( (opProperty & OPFLG_OUT2)!=0 ){
  76755. assert( pOp->p2>0 );
  76756. assert( pOp->p2<=(p->nMem+1 - p->nCursor) );
  76757. memAboutToChange(p, &aMem[pOp->p2]);
  76758. }
  76759. if( (opProperty & OPFLG_OUT3)!=0 ){
  76760. assert( pOp->p3>0 );
  76761. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  76762. memAboutToChange(p, &aMem[pOp->p3]);
  76763. }
  76764. }
  76765. #endif
  76766. #if defined(SQLITE_DEBUG) || defined(VDBE_PROFILE)
  76767. pOrigOp = pOp;
  76768. #endif
  76769. switch( pOp->opcode ){
  76770. /*****************************************************************************
  76771. ** What follows is a massive switch statement where each case implements a
  76772. ** separate instruction in the virtual machine. If we follow the usual
  76773. ** indentation conventions, each case should be indented by 6 spaces. But
  76774. ** that is a lot of wasted space on the left margin. So the code within
  76775. ** the switch statement will break with convention and be flush-left. Another
  76776. ** big comment (similar to this one) will mark the point in the code where
  76777. ** we transition back to normal indentation.
  76778. **
  76779. ** The formatting of each case is important. The makefile for SQLite
  76780. ** generates two C files "opcodes.h" and "opcodes.c" by scanning this
  76781. ** file looking for lines that begin with "case OP_". The opcodes.h files
  76782. ** will be filled with #defines that give unique integer values to each
  76783. ** opcode and the opcodes.c file is filled with an array of strings where
  76784. ** each string is the symbolic name for the corresponding opcode. If the
  76785. ** case statement is followed by a comment of the form "/# same as ... #/"
  76786. ** that comment is used to determine the particular value of the opcode.
  76787. **
  76788. ** Other keywords in the comment that follows each case are used to
  76789. ** construct the OPFLG_INITIALIZER value that initializes opcodeProperty[].
  76790. ** Keywords include: in1, in2, in3, out2, out3. See
  76791. ** the mkopcodeh.awk script for additional information.
  76792. **
  76793. ** Documentation about VDBE opcodes is generated by scanning this file
  76794. ** for lines of that contain "Opcode:". That line and all subsequent
  76795. ** comment lines are used in the generation of the opcode.html documentation
  76796. ** file.
  76797. **
  76798. ** SUMMARY:
  76799. **
  76800. ** Formatting is important to scripts that scan this file.
  76801. ** Do not deviate from the formatting style currently in use.
  76802. **
  76803. *****************************************************************************/
  76804. /* Opcode: Goto * P2 * * *
  76805. **
  76806. ** An unconditional jump to address P2.
  76807. ** The next instruction executed will be
  76808. ** the one at index P2 from the beginning of
  76809. ** the program.
  76810. **
  76811. ** The P1 parameter is not actually used by this opcode. However, it
  76812. ** is sometimes set to 1 instead of 0 as a hint to the command-line shell
  76813. ** that this Goto is the bottom of a loop and that the lines from P2 down
  76814. ** to the current line should be indented for EXPLAIN output.
  76815. */
  76816. case OP_Goto: { /* jump */
  76817. jump_to_p2_and_check_for_interrupt:
  76818. pOp = &aOp[pOp->p2 - 1];
  76819. /* Opcodes that are used as the bottom of a loop (OP_Next, OP_Prev,
  76820. ** OP_VNext, or OP_SorterNext) all jump here upon
  76821. ** completion. Check to see if sqlite3_interrupt() has been called
  76822. ** or if the progress callback needs to be invoked.
  76823. **
  76824. ** This code uses unstructured "goto" statements and does not look clean.
  76825. ** But that is not due to sloppy coding habits. The code is written this
  76826. ** way for performance, to avoid having to run the interrupt and progress
  76827. ** checks on every opcode. This helps sqlite3_step() to run about 1.5%
  76828. ** faster according to "valgrind --tool=cachegrind" */
  76829. check_for_interrupt:
  76830. if( db->u1.isInterrupted ) goto abort_due_to_interrupt;
  76831. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  76832. /* Call the progress callback if it is configured and the required number
  76833. ** of VDBE ops have been executed (either since this invocation of
  76834. ** sqlite3VdbeExec() or since last time the progress callback was called).
  76835. ** If the progress callback returns non-zero, exit the virtual machine with
  76836. ** a return code SQLITE_ABORT.
  76837. */
  76838. if( nVmStep>=nProgressLimit && db->xProgress!=0 ){
  76839. assert( db->nProgressOps!=0 );
  76840. nProgressLimit = nVmStep + db->nProgressOps - (nVmStep%db->nProgressOps);
  76841. if( db->xProgress(db->pProgressArg) ){
  76842. rc = SQLITE_INTERRUPT;
  76843. goto abort_due_to_error;
  76844. }
  76845. }
  76846. #endif
  76847. break;
  76848. }
  76849. /* Opcode: Gosub P1 P2 * * *
  76850. **
  76851. ** Write the current address onto register P1
  76852. ** and then jump to address P2.
  76853. */
  76854. case OP_Gosub: { /* jump */
  76855. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  76856. pIn1 = &aMem[pOp->p1];
  76857. assert( VdbeMemDynamic(pIn1)==0 );
  76858. memAboutToChange(p, pIn1);
  76859. pIn1->flags = MEM_Int;
  76860. pIn1->u.i = (int)(pOp-aOp);
  76861. REGISTER_TRACE(pOp->p1, pIn1);
  76862. /* Most jump operations do a goto to this spot in order to update
  76863. ** the pOp pointer. */
  76864. jump_to_p2:
  76865. pOp = &aOp[pOp->p2 - 1];
  76866. break;
  76867. }
  76868. /* Opcode: Return P1 * * * *
  76869. **
  76870. ** Jump to the next instruction after the address in register P1. After
  76871. ** the jump, register P1 becomes undefined.
  76872. */
  76873. case OP_Return: { /* in1 */
  76874. pIn1 = &aMem[pOp->p1];
  76875. assert( pIn1->flags==MEM_Int );
  76876. pOp = &aOp[pIn1->u.i];
  76877. pIn1->flags = MEM_Undefined;
  76878. break;
  76879. }
  76880. /* Opcode: InitCoroutine P1 P2 P3 * *
  76881. **
  76882. ** Set up register P1 so that it will Yield to the coroutine
  76883. ** located at address P3.
  76884. **
  76885. ** If P2!=0 then the coroutine implementation immediately follows
  76886. ** this opcode. So jump over the coroutine implementation to
  76887. ** address P2.
  76888. **
  76889. ** See also: EndCoroutine
  76890. */
  76891. case OP_InitCoroutine: { /* jump */
  76892. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  76893. assert( pOp->p2>=0 && pOp->p2<p->nOp );
  76894. assert( pOp->p3>=0 && pOp->p3<p->nOp );
  76895. pOut = &aMem[pOp->p1];
  76896. assert( !VdbeMemDynamic(pOut) );
  76897. pOut->u.i = pOp->p3 - 1;
  76898. pOut->flags = MEM_Int;
  76899. if( pOp->p2 ) goto jump_to_p2;
  76900. break;
  76901. }
  76902. /* Opcode: EndCoroutine P1 * * * *
  76903. **
  76904. ** The instruction at the address in register P1 is a Yield.
  76905. ** Jump to the P2 parameter of that Yield.
  76906. ** After the jump, register P1 becomes undefined.
  76907. **
  76908. ** See also: InitCoroutine
  76909. */
  76910. case OP_EndCoroutine: { /* in1 */
  76911. VdbeOp *pCaller;
  76912. pIn1 = &aMem[pOp->p1];
  76913. assert( pIn1->flags==MEM_Int );
  76914. assert( pIn1->u.i>=0 && pIn1->u.i<p->nOp );
  76915. pCaller = &aOp[pIn1->u.i];
  76916. assert( pCaller->opcode==OP_Yield );
  76917. assert( pCaller->p2>=0 && pCaller->p2<p->nOp );
  76918. pOp = &aOp[pCaller->p2 - 1];
  76919. pIn1->flags = MEM_Undefined;
  76920. break;
  76921. }
  76922. /* Opcode: Yield P1 P2 * * *
  76923. **
  76924. ** Swap the program counter with the value in register P1. This
  76925. ** has the effect of yielding to a coroutine.
  76926. **
  76927. ** If the coroutine that is launched by this instruction ends with
  76928. ** Yield or Return then continue to the next instruction. But if
  76929. ** the coroutine launched by this instruction ends with
  76930. ** EndCoroutine, then jump to P2 rather than continuing with the
  76931. ** next instruction.
  76932. **
  76933. ** See also: InitCoroutine
  76934. */
  76935. case OP_Yield: { /* in1, jump */
  76936. int pcDest;
  76937. pIn1 = &aMem[pOp->p1];
  76938. assert( VdbeMemDynamic(pIn1)==0 );
  76939. pIn1->flags = MEM_Int;
  76940. pcDest = (int)pIn1->u.i;
  76941. pIn1->u.i = (int)(pOp - aOp);
  76942. REGISTER_TRACE(pOp->p1, pIn1);
  76943. pOp = &aOp[pcDest];
  76944. break;
  76945. }
  76946. /* Opcode: HaltIfNull P1 P2 P3 P4 P5
  76947. ** Synopsis: if r[P3]=null halt
  76948. **
  76949. ** Check the value in register P3. If it is NULL then Halt using
  76950. ** parameter P1, P2, and P4 as if this were a Halt instruction. If the
  76951. ** value in register P3 is not NULL, then this routine is a no-op.
  76952. ** The P5 parameter should be 1.
  76953. */
  76954. case OP_HaltIfNull: { /* in3 */
  76955. pIn3 = &aMem[pOp->p3];
  76956. if( (pIn3->flags & MEM_Null)==0 ) break;
  76957. /* Fall through into OP_Halt */
  76958. }
  76959. /* Opcode: Halt P1 P2 * P4 P5
  76960. **
  76961. ** Exit immediately. All open cursors, etc are closed
  76962. ** automatically.
  76963. **
  76964. ** P1 is the result code returned by sqlite3_exec(), sqlite3_reset(),
  76965. ** or sqlite3_finalize(). For a normal halt, this should be SQLITE_OK (0).
  76966. ** For errors, it can be some other value. If P1!=0 then P2 will determine
  76967. ** whether or not to rollback the current transaction. Do not rollback
  76968. ** if P2==OE_Fail. Do the rollback if P2==OE_Rollback. If P2==OE_Abort,
  76969. ** then back out all changes that have occurred during this execution of the
  76970. ** VDBE, but do not rollback the transaction.
  76971. **
  76972. ** If P4 is not null then it is an error message string.
  76973. **
  76974. ** P5 is a value between 0 and 4, inclusive, that modifies the P4 string.
  76975. **
  76976. ** 0: (no change)
  76977. ** 1: NOT NULL contraint failed: P4
  76978. ** 2: UNIQUE constraint failed: P4
  76979. ** 3: CHECK constraint failed: P4
  76980. ** 4: FOREIGN KEY constraint failed: P4
  76981. **
  76982. ** If P5 is not zero and P4 is NULL, then everything after the ":" is
  76983. ** omitted.
  76984. **
  76985. ** There is an implied "Halt 0 0 0" instruction inserted at the very end of
  76986. ** every program. So a jump past the last instruction of the program
  76987. ** is the same as executing Halt.
  76988. */
  76989. case OP_Halt: {
  76990. VdbeFrame *pFrame;
  76991. int pcx;
  76992. pcx = (int)(pOp - aOp);
  76993. if( pOp->p1==SQLITE_OK && p->pFrame ){
  76994. /* Halt the sub-program. Return control to the parent frame. */
  76995. pFrame = p->pFrame;
  76996. p->pFrame = pFrame->pParent;
  76997. p->nFrame--;
  76998. sqlite3VdbeSetChanges(db, p->nChange);
  76999. pcx = sqlite3VdbeFrameRestore(pFrame);
  77000. if( pOp->p2==OE_Ignore ){
  77001. /* Instruction pcx is the OP_Program that invoked the sub-program
  77002. ** currently being halted. If the p2 instruction of this OP_Halt
  77003. ** instruction is set to OE_Ignore, then the sub-program is throwing
  77004. ** an IGNORE exception. In this case jump to the address specified
  77005. ** as the p2 of the calling OP_Program. */
  77006. pcx = p->aOp[pcx].p2-1;
  77007. }
  77008. aOp = p->aOp;
  77009. aMem = p->aMem;
  77010. pOp = &aOp[pcx];
  77011. break;
  77012. }
  77013. p->rc = pOp->p1;
  77014. p->errorAction = (u8)pOp->p2;
  77015. p->pc = pcx;
  77016. assert( pOp->p5<=4 );
  77017. if( p->rc ){
  77018. if( pOp->p5 ){
  77019. static const char * const azType[] = { "NOT NULL", "UNIQUE", "CHECK",
  77020. "FOREIGN KEY" };
  77021. testcase( pOp->p5==1 );
  77022. testcase( pOp->p5==2 );
  77023. testcase( pOp->p5==3 );
  77024. testcase( pOp->p5==4 );
  77025. sqlite3VdbeError(p, "%s constraint failed", azType[pOp->p5-1]);
  77026. if( pOp->p4.z ){
  77027. p->zErrMsg = sqlite3MPrintf(db, "%z: %s", p->zErrMsg, pOp->p4.z);
  77028. }
  77029. }else{
  77030. sqlite3VdbeError(p, "%s", pOp->p4.z);
  77031. }
  77032. sqlite3_log(pOp->p1, "abort at %d in [%s]: %s", pcx, p->zSql, p->zErrMsg);
  77033. }
  77034. rc = sqlite3VdbeHalt(p);
  77035. assert( rc==SQLITE_BUSY || rc==SQLITE_OK || rc==SQLITE_ERROR );
  77036. if( rc==SQLITE_BUSY ){
  77037. p->rc = SQLITE_BUSY;
  77038. }else{
  77039. assert( rc==SQLITE_OK || (p->rc&0xff)==SQLITE_CONSTRAINT );
  77040. assert( rc==SQLITE_OK || db->nDeferredCons>0 || db->nDeferredImmCons>0 );
  77041. rc = p->rc ? SQLITE_ERROR : SQLITE_DONE;
  77042. }
  77043. goto vdbe_return;
  77044. }
  77045. /* Opcode: Integer P1 P2 * * *
  77046. ** Synopsis: r[P2]=P1
  77047. **
  77048. ** The 32-bit integer value P1 is written into register P2.
  77049. */
  77050. case OP_Integer: { /* out2 */
  77051. pOut = out2Prerelease(p, pOp);
  77052. pOut->u.i = pOp->p1;
  77053. break;
  77054. }
  77055. /* Opcode: Int64 * P2 * P4 *
  77056. ** Synopsis: r[P2]=P4
  77057. **
  77058. ** P4 is a pointer to a 64-bit integer value.
  77059. ** Write that value into register P2.
  77060. */
  77061. case OP_Int64: { /* out2 */
  77062. pOut = out2Prerelease(p, pOp);
  77063. assert( pOp->p4.pI64!=0 );
  77064. pOut->u.i = *pOp->p4.pI64;
  77065. break;
  77066. }
  77067. #ifndef SQLITE_OMIT_FLOATING_POINT
  77068. /* Opcode: Real * P2 * P4 *
  77069. ** Synopsis: r[P2]=P4
  77070. **
  77071. ** P4 is a pointer to a 64-bit floating point value.
  77072. ** Write that value into register P2.
  77073. */
  77074. case OP_Real: { /* same as TK_FLOAT, out2 */
  77075. pOut = out2Prerelease(p, pOp);
  77076. pOut->flags = MEM_Real;
  77077. assert( !sqlite3IsNaN(*pOp->p4.pReal) );
  77078. pOut->u.r = *pOp->p4.pReal;
  77079. break;
  77080. }
  77081. #endif
  77082. /* Opcode: String8 * P2 * P4 *
  77083. ** Synopsis: r[P2]='P4'
  77084. **
  77085. ** P4 points to a nul terminated UTF-8 string. This opcode is transformed
  77086. ** into a String opcode before it is executed for the first time. During
  77087. ** this transformation, the length of string P4 is computed and stored
  77088. ** as the P1 parameter.
  77089. */
  77090. case OP_String8: { /* same as TK_STRING, out2 */
  77091. assert( pOp->p4.z!=0 );
  77092. pOut = out2Prerelease(p, pOp);
  77093. pOp->opcode = OP_String;
  77094. pOp->p1 = sqlite3Strlen30(pOp->p4.z);
  77095. #ifndef SQLITE_OMIT_UTF16
  77096. if( encoding!=SQLITE_UTF8 ){
  77097. rc = sqlite3VdbeMemSetStr(pOut, pOp->p4.z, -1, SQLITE_UTF8, SQLITE_STATIC);
  77098. assert( rc==SQLITE_OK || rc==SQLITE_TOOBIG );
  77099. if( SQLITE_OK!=sqlite3VdbeChangeEncoding(pOut, encoding) ) goto no_mem;
  77100. assert( pOut->szMalloc>0 && pOut->zMalloc==pOut->z );
  77101. assert( VdbeMemDynamic(pOut)==0 );
  77102. pOut->szMalloc = 0;
  77103. pOut->flags |= MEM_Static;
  77104. if( pOp->p4type==P4_DYNAMIC ){
  77105. sqlite3DbFree(db, pOp->p4.z);
  77106. }
  77107. pOp->p4type = P4_DYNAMIC;
  77108. pOp->p4.z = pOut->z;
  77109. pOp->p1 = pOut->n;
  77110. }
  77111. testcase( rc==SQLITE_TOOBIG );
  77112. #endif
  77113. if( pOp->p1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  77114. goto too_big;
  77115. }
  77116. assert( rc==SQLITE_OK );
  77117. /* Fall through to the next case, OP_String */
  77118. }
  77119. /* Opcode: String P1 P2 P3 P4 P5
  77120. ** Synopsis: r[P2]='P4' (len=P1)
  77121. **
  77122. ** The string value P4 of length P1 (bytes) is stored in register P2.
  77123. **
  77124. ** If P3 is not zero and the content of register P3 is equal to P5, then
  77125. ** the datatype of the register P2 is converted to BLOB. The content is
  77126. ** the same sequence of bytes, it is merely interpreted as a BLOB instead
  77127. ** of a string, as if it had been CAST. In other words:
  77128. **
  77129. ** if( P3!=0 and reg[P3]==P5 ) reg[P2] := CAST(reg[P2] as BLOB)
  77130. */
  77131. case OP_String: { /* out2 */
  77132. assert( pOp->p4.z!=0 );
  77133. pOut = out2Prerelease(p, pOp);
  77134. pOut->flags = MEM_Str|MEM_Static|MEM_Term;
  77135. pOut->z = pOp->p4.z;
  77136. pOut->n = pOp->p1;
  77137. pOut->enc = encoding;
  77138. UPDATE_MAX_BLOBSIZE(pOut);
  77139. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  77140. if( pOp->p3>0 ){
  77141. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  77142. pIn3 = &aMem[pOp->p3];
  77143. assert( pIn3->flags & MEM_Int );
  77144. if( pIn3->u.i==pOp->p5 ) pOut->flags = MEM_Blob|MEM_Static|MEM_Term;
  77145. }
  77146. #endif
  77147. break;
  77148. }
  77149. /* Opcode: Null P1 P2 P3 * *
  77150. ** Synopsis: r[P2..P3]=NULL
  77151. **
  77152. ** Write a NULL into registers P2. If P3 greater than P2, then also write
  77153. ** NULL into register P3 and every register in between P2 and P3. If P3
  77154. ** is less than P2 (typically P3 is zero) then only register P2 is
  77155. ** set to NULL.
  77156. **
  77157. ** If the P1 value is non-zero, then also set the MEM_Cleared flag so that
  77158. ** NULL values will not compare equal even if SQLITE_NULLEQ is set on
  77159. ** OP_Ne or OP_Eq.
  77160. */
  77161. case OP_Null: { /* out2 */
  77162. int cnt;
  77163. u16 nullFlag;
  77164. pOut = out2Prerelease(p, pOp);
  77165. cnt = pOp->p3-pOp->p2;
  77166. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  77167. pOut->flags = nullFlag = pOp->p1 ? (MEM_Null|MEM_Cleared) : MEM_Null;
  77168. pOut->n = 0;
  77169. while( cnt>0 ){
  77170. pOut++;
  77171. memAboutToChange(p, pOut);
  77172. sqlite3VdbeMemSetNull(pOut);
  77173. pOut->flags = nullFlag;
  77174. pOut->n = 0;
  77175. cnt--;
  77176. }
  77177. break;
  77178. }
  77179. /* Opcode: SoftNull P1 * * * *
  77180. ** Synopsis: r[P1]=NULL
  77181. **
  77182. ** Set register P1 to have the value NULL as seen by the OP_MakeRecord
  77183. ** instruction, but do not free any string or blob memory associated with
  77184. ** the register, so that if the value was a string or blob that was
  77185. ** previously copied using OP_SCopy, the copies will continue to be valid.
  77186. */
  77187. case OP_SoftNull: {
  77188. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  77189. pOut = &aMem[pOp->p1];
  77190. pOut->flags = (pOut->flags&~(MEM_Undefined|MEM_AffMask))|MEM_Null;
  77191. break;
  77192. }
  77193. /* Opcode: Blob P1 P2 * P4 *
  77194. ** Synopsis: r[P2]=P4 (len=P1)
  77195. **
  77196. ** P4 points to a blob of data P1 bytes long. Store this
  77197. ** blob in register P2.
  77198. */
  77199. case OP_Blob: { /* out2 */
  77200. assert( pOp->p1 <= SQLITE_MAX_LENGTH );
  77201. pOut = out2Prerelease(p, pOp);
  77202. sqlite3VdbeMemSetStr(pOut, pOp->p4.z, pOp->p1, 0, 0);
  77203. pOut->enc = encoding;
  77204. UPDATE_MAX_BLOBSIZE(pOut);
  77205. break;
  77206. }
  77207. /* Opcode: Variable P1 P2 * P4 *
  77208. ** Synopsis: r[P2]=parameter(P1,P4)
  77209. **
  77210. ** Transfer the values of bound parameter P1 into register P2
  77211. **
  77212. ** If the parameter is named, then its name appears in P4.
  77213. ** The P4 value is used by sqlite3_bind_parameter_name().
  77214. */
  77215. case OP_Variable: { /* out2 */
  77216. Mem *pVar; /* Value being transferred */
  77217. assert( pOp->p1>0 && pOp->p1<=p->nVar );
  77218. assert( pOp->p4.z==0 || pOp->p4.z==sqlite3VListNumToName(p->pVList,pOp->p1) );
  77219. pVar = &p->aVar[pOp->p1 - 1];
  77220. if( sqlite3VdbeMemTooBig(pVar) ){
  77221. goto too_big;
  77222. }
  77223. pOut = &aMem[pOp->p2];
  77224. sqlite3VdbeMemShallowCopy(pOut, pVar, MEM_Static);
  77225. UPDATE_MAX_BLOBSIZE(pOut);
  77226. break;
  77227. }
  77228. /* Opcode: Move P1 P2 P3 * *
  77229. ** Synopsis: r[P2@P3]=r[P1@P3]
  77230. **
  77231. ** Move the P3 values in register P1..P1+P3-1 over into
  77232. ** registers P2..P2+P3-1. Registers P1..P1+P3-1 are
  77233. ** left holding a NULL. It is an error for register ranges
  77234. ** P1..P1+P3-1 and P2..P2+P3-1 to overlap. It is an error
  77235. ** for P3 to be less than 1.
  77236. */
  77237. case OP_Move: {
  77238. int n; /* Number of registers left to copy */
  77239. int p1; /* Register to copy from */
  77240. int p2; /* Register to copy to */
  77241. n = pOp->p3;
  77242. p1 = pOp->p1;
  77243. p2 = pOp->p2;
  77244. assert( n>0 && p1>0 && p2>0 );
  77245. assert( p1+n<=p2 || p2+n<=p1 );
  77246. pIn1 = &aMem[p1];
  77247. pOut = &aMem[p2];
  77248. do{
  77249. assert( pOut<=&aMem[(p->nMem+1 - p->nCursor)] );
  77250. assert( pIn1<=&aMem[(p->nMem+1 - p->nCursor)] );
  77251. assert( memIsValid(pIn1) );
  77252. memAboutToChange(p, pOut);
  77253. sqlite3VdbeMemMove(pOut, pIn1);
  77254. #ifdef SQLITE_DEBUG
  77255. if( pOut->pScopyFrom>=&aMem[p1] && pOut->pScopyFrom<pOut ){
  77256. pOut->pScopyFrom += pOp->p2 - p1;
  77257. }
  77258. #endif
  77259. Deephemeralize(pOut);
  77260. REGISTER_TRACE(p2++, pOut);
  77261. pIn1++;
  77262. pOut++;
  77263. }while( --n );
  77264. break;
  77265. }
  77266. /* Opcode: Copy P1 P2 P3 * *
  77267. ** Synopsis: r[P2@P3+1]=r[P1@P3+1]
  77268. **
  77269. ** Make a copy of registers P1..P1+P3 into registers P2..P2+P3.
  77270. **
  77271. ** This instruction makes a deep copy of the value. A duplicate
  77272. ** is made of any string or blob constant. See also OP_SCopy.
  77273. */
  77274. case OP_Copy: {
  77275. int n;
  77276. n = pOp->p3;
  77277. pIn1 = &aMem[pOp->p1];
  77278. pOut = &aMem[pOp->p2];
  77279. assert( pOut!=pIn1 );
  77280. while( 1 ){
  77281. sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
  77282. Deephemeralize(pOut);
  77283. #ifdef SQLITE_DEBUG
  77284. pOut->pScopyFrom = 0;
  77285. #endif
  77286. REGISTER_TRACE(pOp->p2+pOp->p3-n, pOut);
  77287. if( (n--)==0 ) break;
  77288. pOut++;
  77289. pIn1++;
  77290. }
  77291. break;
  77292. }
  77293. /* Opcode: SCopy P1 P2 * * *
  77294. ** Synopsis: r[P2]=r[P1]
  77295. **
  77296. ** Make a shallow copy of register P1 into register P2.
  77297. **
  77298. ** This instruction makes a shallow copy of the value. If the value
  77299. ** is a string or blob, then the copy is only a pointer to the
  77300. ** original and hence if the original changes so will the copy.
  77301. ** Worse, if the original is deallocated, the copy becomes invalid.
  77302. ** Thus the program must guarantee that the original will not change
  77303. ** during the lifetime of the copy. Use OP_Copy to make a complete
  77304. ** copy.
  77305. */
  77306. case OP_SCopy: { /* out2 */
  77307. pIn1 = &aMem[pOp->p1];
  77308. pOut = &aMem[pOp->p2];
  77309. assert( pOut!=pIn1 );
  77310. sqlite3VdbeMemShallowCopy(pOut, pIn1, MEM_Ephem);
  77311. #ifdef SQLITE_DEBUG
  77312. if( pOut->pScopyFrom==0 ) pOut->pScopyFrom = pIn1;
  77313. #endif
  77314. break;
  77315. }
  77316. /* Opcode: IntCopy P1 P2 * * *
  77317. ** Synopsis: r[P2]=r[P1]
  77318. **
  77319. ** Transfer the integer value held in register P1 into register P2.
  77320. **
  77321. ** This is an optimized version of SCopy that works only for integer
  77322. ** values.
  77323. */
  77324. case OP_IntCopy: { /* out2 */
  77325. pIn1 = &aMem[pOp->p1];
  77326. assert( (pIn1->flags & MEM_Int)!=0 );
  77327. pOut = &aMem[pOp->p2];
  77328. sqlite3VdbeMemSetInt64(pOut, pIn1->u.i);
  77329. break;
  77330. }
  77331. /* Opcode: ResultRow P1 P2 * * *
  77332. ** Synopsis: output=r[P1@P2]
  77333. **
  77334. ** The registers P1 through P1+P2-1 contain a single row of
  77335. ** results. This opcode causes the sqlite3_step() call to terminate
  77336. ** with an SQLITE_ROW return code and it sets up the sqlite3_stmt
  77337. ** structure to provide access to the r(P1)..r(P1+P2-1) values as
  77338. ** the result row.
  77339. */
  77340. case OP_ResultRow: {
  77341. Mem *pMem;
  77342. int i;
  77343. assert( p->nResColumn==pOp->p2 );
  77344. assert( pOp->p1>0 );
  77345. assert( pOp->p1+pOp->p2<=(p->nMem+1 - p->nCursor)+1 );
  77346. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  77347. /* Run the progress counter just before returning.
  77348. */
  77349. if( db->xProgress!=0
  77350. && nVmStep>=nProgressLimit
  77351. && db->xProgress(db->pProgressArg)!=0
  77352. ){
  77353. rc = SQLITE_INTERRUPT;
  77354. goto abort_due_to_error;
  77355. }
  77356. #endif
  77357. /* If this statement has violated immediate foreign key constraints, do
  77358. ** not return the number of rows modified. And do not RELEASE the statement
  77359. ** transaction. It needs to be rolled back. */
  77360. if( SQLITE_OK!=(rc = sqlite3VdbeCheckFk(p, 0)) ){
  77361. assert( db->flags&SQLITE_CountRows );
  77362. assert( p->usesStmtJournal );
  77363. goto abort_due_to_error;
  77364. }
  77365. /* If the SQLITE_CountRows flag is set in sqlite3.flags mask, then
  77366. ** DML statements invoke this opcode to return the number of rows
  77367. ** modified to the user. This is the only way that a VM that
  77368. ** opens a statement transaction may invoke this opcode.
  77369. **
  77370. ** In case this is such a statement, close any statement transaction
  77371. ** opened by this VM before returning control to the user. This is to
  77372. ** ensure that statement-transactions are always nested, not overlapping.
  77373. ** If the open statement-transaction is not closed here, then the user
  77374. ** may step another VM that opens its own statement transaction. This
  77375. ** may lead to overlapping statement transactions.
  77376. **
  77377. ** The statement transaction is never a top-level transaction. Hence
  77378. ** the RELEASE call below can never fail.
  77379. */
  77380. assert( p->iStatement==0 || db->flags&SQLITE_CountRows );
  77381. rc = sqlite3VdbeCloseStatement(p, SAVEPOINT_RELEASE);
  77382. assert( rc==SQLITE_OK );
  77383. /* Invalidate all ephemeral cursor row caches */
  77384. p->cacheCtr = (p->cacheCtr + 2)|1;
  77385. /* Make sure the results of the current row are \000 terminated
  77386. ** and have an assigned type. The results are de-ephemeralized as
  77387. ** a side effect.
  77388. */
  77389. pMem = p->pResultSet = &aMem[pOp->p1];
  77390. for(i=0; i<pOp->p2; i++){
  77391. assert( memIsValid(&pMem[i]) );
  77392. Deephemeralize(&pMem[i]);
  77393. assert( (pMem[i].flags & MEM_Ephem)==0
  77394. || (pMem[i].flags & (MEM_Str|MEM_Blob))==0 );
  77395. sqlite3VdbeMemNulTerminate(&pMem[i]);
  77396. REGISTER_TRACE(pOp->p1+i, &pMem[i]);
  77397. }
  77398. if( db->mallocFailed ) goto no_mem;
  77399. if( db->mTrace & SQLITE_TRACE_ROW ){
  77400. db->xTrace(SQLITE_TRACE_ROW, db->pTraceArg, p, 0);
  77401. }
  77402. /* Return SQLITE_ROW
  77403. */
  77404. p->pc = (int)(pOp - aOp) + 1;
  77405. rc = SQLITE_ROW;
  77406. goto vdbe_return;
  77407. }
  77408. /* Opcode: Concat P1 P2 P3 * *
  77409. ** Synopsis: r[P3]=r[P2]+r[P1]
  77410. **
  77411. ** Add the text in register P1 onto the end of the text in
  77412. ** register P2 and store the result in register P3.
  77413. ** If either the P1 or P2 text are NULL then store NULL in P3.
  77414. **
  77415. ** P3 = P2 || P1
  77416. **
  77417. ** It is illegal for P1 and P3 to be the same register. Sometimes,
  77418. ** if P3 is the same register as P2, the implementation is able
  77419. ** to avoid a memcpy().
  77420. */
  77421. case OP_Concat: { /* same as TK_CONCAT, in1, in2, out3 */
  77422. i64 nByte;
  77423. pIn1 = &aMem[pOp->p1];
  77424. pIn2 = &aMem[pOp->p2];
  77425. pOut = &aMem[pOp->p3];
  77426. assert( pIn1!=pOut );
  77427. if( (pIn1->flags | pIn2->flags) & MEM_Null ){
  77428. sqlite3VdbeMemSetNull(pOut);
  77429. break;
  77430. }
  77431. if( ExpandBlob(pIn1) || ExpandBlob(pIn2) ) goto no_mem;
  77432. Stringify(pIn1, encoding);
  77433. Stringify(pIn2, encoding);
  77434. nByte = pIn1->n + pIn2->n;
  77435. if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  77436. goto too_big;
  77437. }
  77438. if( sqlite3VdbeMemGrow(pOut, (int)nByte+2, pOut==pIn2) ){
  77439. goto no_mem;
  77440. }
  77441. MemSetTypeFlag(pOut, MEM_Str);
  77442. if( pOut!=pIn2 ){
  77443. memcpy(pOut->z, pIn2->z, pIn2->n);
  77444. }
  77445. memcpy(&pOut->z[pIn2->n], pIn1->z, pIn1->n);
  77446. pOut->z[nByte]=0;
  77447. pOut->z[nByte+1] = 0;
  77448. pOut->flags |= MEM_Term;
  77449. pOut->n = (int)nByte;
  77450. pOut->enc = encoding;
  77451. UPDATE_MAX_BLOBSIZE(pOut);
  77452. break;
  77453. }
  77454. /* Opcode: Add P1 P2 P3 * *
  77455. ** Synopsis: r[P3]=r[P1]+r[P2]
  77456. **
  77457. ** Add the value in register P1 to the value in register P2
  77458. ** and store the result in register P3.
  77459. ** If either input is NULL, the result is NULL.
  77460. */
  77461. /* Opcode: Multiply P1 P2 P3 * *
  77462. ** Synopsis: r[P3]=r[P1]*r[P2]
  77463. **
  77464. **
  77465. ** Multiply the value in register P1 by the value in register P2
  77466. ** and store the result in register P3.
  77467. ** If either input is NULL, the result is NULL.
  77468. */
  77469. /* Opcode: Subtract P1 P2 P3 * *
  77470. ** Synopsis: r[P3]=r[P2]-r[P1]
  77471. **
  77472. ** Subtract the value in register P1 from the value in register P2
  77473. ** and store the result in register P3.
  77474. ** If either input is NULL, the result is NULL.
  77475. */
  77476. /* Opcode: Divide P1 P2 P3 * *
  77477. ** Synopsis: r[P3]=r[P2]/r[P1]
  77478. **
  77479. ** Divide the value in register P1 by the value in register P2
  77480. ** and store the result in register P3 (P3=P2/P1). If the value in
  77481. ** register P1 is zero, then the result is NULL. If either input is
  77482. ** NULL, the result is NULL.
  77483. */
  77484. /* Opcode: Remainder P1 P2 P3 * *
  77485. ** Synopsis: r[P3]=r[P2]%r[P1]
  77486. **
  77487. ** Compute the remainder after integer register P2 is divided by
  77488. ** register P1 and store the result in register P3.
  77489. ** If the value in register P1 is zero the result is NULL.
  77490. ** If either operand is NULL, the result is NULL.
  77491. */
  77492. case OP_Add: /* same as TK_PLUS, in1, in2, out3 */
  77493. case OP_Subtract: /* same as TK_MINUS, in1, in2, out3 */
  77494. case OP_Multiply: /* same as TK_STAR, in1, in2, out3 */
  77495. case OP_Divide: /* same as TK_SLASH, in1, in2, out3 */
  77496. case OP_Remainder: { /* same as TK_REM, in1, in2, out3 */
  77497. char bIntint; /* Started out as two integer operands */
  77498. u16 flags; /* Combined MEM_* flags from both inputs */
  77499. u16 type1; /* Numeric type of left operand */
  77500. u16 type2; /* Numeric type of right operand */
  77501. i64 iA; /* Integer value of left operand */
  77502. i64 iB; /* Integer value of right operand */
  77503. double rA; /* Real value of left operand */
  77504. double rB; /* Real value of right operand */
  77505. pIn1 = &aMem[pOp->p1];
  77506. type1 = numericType(pIn1);
  77507. pIn2 = &aMem[pOp->p2];
  77508. type2 = numericType(pIn2);
  77509. pOut = &aMem[pOp->p3];
  77510. flags = pIn1->flags | pIn2->flags;
  77511. if( (type1 & type2 & MEM_Int)!=0 ){
  77512. iA = pIn1->u.i;
  77513. iB = pIn2->u.i;
  77514. bIntint = 1;
  77515. switch( pOp->opcode ){
  77516. case OP_Add: if( sqlite3AddInt64(&iB,iA) ) goto fp_math; break;
  77517. case OP_Subtract: if( sqlite3SubInt64(&iB,iA) ) goto fp_math; break;
  77518. case OP_Multiply: if( sqlite3MulInt64(&iB,iA) ) goto fp_math; break;
  77519. case OP_Divide: {
  77520. if( iA==0 ) goto arithmetic_result_is_null;
  77521. if( iA==-1 && iB==SMALLEST_INT64 ) goto fp_math;
  77522. iB /= iA;
  77523. break;
  77524. }
  77525. default: {
  77526. if( iA==0 ) goto arithmetic_result_is_null;
  77527. if( iA==-1 ) iA = 1;
  77528. iB %= iA;
  77529. break;
  77530. }
  77531. }
  77532. pOut->u.i = iB;
  77533. MemSetTypeFlag(pOut, MEM_Int);
  77534. }else if( (flags & MEM_Null)!=0 ){
  77535. goto arithmetic_result_is_null;
  77536. }else{
  77537. bIntint = 0;
  77538. fp_math:
  77539. rA = sqlite3VdbeRealValue(pIn1);
  77540. rB = sqlite3VdbeRealValue(pIn2);
  77541. switch( pOp->opcode ){
  77542. case OP_Add: rB += rA; break;
  77543. case OP_Subtract: rB -= rA; break;
  77544. case OP_Multiply: rB *= rA; break;
  77545. case OP_Divide: {
  77546. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  77547. if( rA==(double)0 ) goto arithmetic_result_is_null;
  77548. rB /= rA;
  77549. break;
  77550. }
  77551. default: {
  77552. iA = (i64)rA;
  77553. iB = (i64)rB;
  77554. if( iA==0 ) goto arithmetic_result_is_null;
  77555. if( iA==-1 ) iA = 1;
  77556. rB = (double)(iB % iA);
  77557. break;
  77558. }
  77559. }
  77560. #ifdef SQLITE_OMIT_FLOATING_POINT
  77561. pOut->u.i = rB;
  77562. MemSetTypeFlag(pOut, MEM_Int);
  77563. #else
  77564. if( sqlite3IsNaN(rB) ){
  77565. goto arithmetic_result_is_null;
  77566. }
  77567. pOut->u.r = rB;
  77568. MemSetTypeFlag(pOut, MEM_Real);
  77569. if( ((type1|type2)&MEM_Real)==0 && !bIntint ){
  77570. sqlite3VdbeIntegerAffinity(pOut);
  77571. }
  77572. #endif
  77573. }
  77574. break;
  77575. arithmetic_result_is_null:
  77576. sqlite3VdbeMemSetNull(pOut);
  77577. break;
  77578. }
  77579. /* Opcode: CollSeq P1 * * P4
  77580. **
  77581. ** P4 is a pointer to a CollSeq object. If the next call to a user function
  77582. ** or aggregate calls sqlite3GetFuncCollSeq(), this collation sequence will
  77583. ** be returned. This is used by the built-in min(), max() and nullif()
  77584. ** functions.
  77585. **
  77586. ** If P1 is not zero, then it is a register that a subsequent min() or
  77587. ** max() aggregate will set to 1 if the current row is not the minimum or
  77588. ** maximum. The P1 register is initialized to 0 by this instruction.
  77589. **
  77590. ** The interface used by the implementation of the aforementioned functions
  77591. ** to retrieve the collation sequence set by this opcode is not available
  77592. ** publicly. Only built-in functions have access to this feature.
  77593. */
  77594. case OP_CollSeq: {
  77595. assert( pOp->p4type==P4_COLLSEQ );
  77596. if( pOp->p1 ){
  77597. sqlite3VdbeMemSetInt64(&aMem[pOp->p1], 0);
  77598. }
  77599. break;
  77600. }
  77601. /* Opcode: BitAnd P1 P2 P3 * *
  77602. ** Synopsis: r[P3]=r[P1]&r[P2]
  77603. **
  77604. ** Take the bit-wise AND of the values in register P1 and P2 and
  77605. ** store the result in register P3.
  77606. ** If either input is NULL, the result is NULL.
  77607. */
  77608. /* Opcode: BitOr P1 P2 P3 * *
  77609. ** Synopsis: r[P3]=r[P1]|r[P2]
  77610. **
  77611. ** Take the bit-wise OR of the values in register P1 and P2 and
  77612. ** store the result in register P3.
  77613. ** If either input is NULL, the result is NULL.
  77614. */
  77615. /* Opcode: ShiftLeft P1 P2 P3 * *
  77616. ** Synopsis: r[P3]=r[P2]<<r[P1]
  77617. **
  77618. ** Shift the integer value in register P2 to the left by the
  77619. ** number of bits specified by the integer in register P1.
  77620. ** Store the result in register P3.
  77621. ** If either input is NULL, the result is NULL.
  77622. */
  77623. /* Opcode: ShiftRight P1 P2 P3 * *
  77624. ** Synopsis: r[P3]=r[P2]>>r[P1]
  77625. **
  77626. ** Shift the integer value in register P2 to the right by the
  77627. ** number of bits specified by the integer in register P1.
  77628. ** Store the result in register P3.
  77629. ** If either input is NULL, the result is NULL.
  77630. */
  77631. case OP_BitAnd: /* same as TK_BITAND, in1, in2, out3 */
  77632. case OP_BitOr: /* same as TK_BITOR, in1, in2, out3 */
  77633. case OP_ShiftLeft: /* same as TK_LSHIFT, in1, in2, out3 */
  77634. case OP_ShiftRight: { /* same as TK_RSHIFT, in1, in2, out3 */
  77635. i64 iA;
  77636. u64 uA;
  77637. i64 iB;
  77638. u8 op;
  77639. pIn1 = &aMem[pOp->p1];
  77640. pIn2 = &aMem[pOp->p2];
  77641. pOut = &aMem[pOp->p3];
  77642. if( (pIn1->flags | pIn2->flags) & MEM_Null ){
  77643. sqlite3VdbeMemSetNull(pOut);
  77644. break;
  77645. }
  77646. iA = sqlite3VdbeIntValue(pIn2);
  77647. iB = sqlite3VdbeIntValue(pIn1);
  77648. op = pOp->opcode;
  77649. if( op==OP_BitAnd ){
  77650. iA &= iB;
  77651. }else if( op==OP_BitOr ){
  77652. iA |= iB;
  77653. }else if( iB!=0 ){
  77654. assert( op==OP_ShiftRight || op==OP_ShiftLeft );
  77655. /* If shifting by a negative amount, shift in the other direction */
  77656. if( iB<0 ){
  77657. assert( OP_ShiftRight==OP_ShiftLeft+1 );
  77658. op = 2*OP_ShiftLeft + 1 - op;
  77659. iB = iB>(-64) ? -iB : 64;
  77660. }
  77661. if( iB>=64 ){
  77662. iA = (iA>=0 || op==OP_ShiftLeft) ? 0 : -1;
  77663. }else{
  77664. memcpy(&uA, &iA, sizeof(uA));
  77665. if( op==OP_ShiftLeft ){
  77666. uA <<= iB;
  77667. }else{
  77668. uA >>= iB;
  77669. /* Sign-extend on a right shift of a negative number */
  77670. if( iA<0 ) uA |= ((((u64)0xffffffff)<<32)|0xffffffff) << (64-iB);
  77671. }
  77672. memcpy(&iA, &uA, sizeof(iA));
  77673. }
  77674. }
  77675. pOut->u.i = iA;
  77676. MemSetTypeFlag(pOut, MEM_Int);
  77677. break;
  77678. }
  77679. /* Opcode: AddImm P1 P2 * * *
  77680. ** Synopsis: r[P1]=r[P1]+P2
  77681. **
  77682. ** Add the constant P2 to the value in register P1.
  77683. ** The result is always an integer.
  77684. **
  77685. ** To force any register to be an integer, just add 0.
  77686. */
  77687. case OP_AddImm: { /* in1 */
  77688. pIn1 = &aMem[pOp->p1];
  77689. memAboutToChange(p, pIn1);
  77690. sqlite3VdbeMemIntegerify(pIn1);
  77691. pIn1->u.i += pOp->p2;
  77692. break;
  77693. }
  77694. /* Opcode: MustBeInt P1 P2 * * *
  77695. **
  77696. ** Force the value in register P1 to be an integer. If the value
  77697. ** in P1 is not an integer and cannot be converted into an integer
  77698. ** without data loss, then jump immediately to P2, or if P2==0
  77699. ** raise an SQLITE_MISMATCH exception.
  77700. */
  77701. case OP_MustBeInt: { /* jump, in1 */
  77702. pIn1 = &aMem[pOp->p1];
  77703. if( (pIn1->flags & MEM_Int)==0 ){
  77704. applyAffinity(pIn1, SQLITE_AFF_NUMERIC, encoding);
  77705. VdbeBranchTaken((pIn1->flags&MEM_Int)==0, 2);
  77706. if( (pIn1->flags & MEM_Int)==0 ){
  77707. if( pOp->p2==0 ){
  77708. rc = SQLITE_MISMATCH;
  77709. goto abort_due_to_error;
  77710. }else{
  77711. goto jump_to_p2;
  77712. }
  77713. }
  77714. }
  77715. MemSetTypeFlag(pIn1, MEM_Int);
  77716. break;
  77717. }
  77718. #ifndef SQLITE_OMIT_FLOATING_POINT
  77719. /* Opcode: RealAffinity P1 * * * *
  77720. **
  77721. ** If register P1 holds an integer convert it to a real value.
  77722. **
  77723. ** This opcode is used when extracting information from a column that
  77724. ** has REAL affinity. Such column values may still be stored as
  77725. ** integers, for space efficiency, but after extraction we want them
  77726. ** to have only a real value.
  77727. */
  77728. case OP_RealAffinity: { /* in1 */
  77729. pIn1 = &aMem[pOp->p1];
  77730. if( pIn1->flags & MEM_Int ){
  77731. sqlite3VdbeMemRealify(pIn1);
  77732. }
  77733. break;
  77734. }
  77735. #endif
  77736. #ifndef SQLITE_OMIT_CAST
  77737. /* Opcode: Cast P1 P2 * * *
  77738. ** Synopsis: affinity(r[P1])
  77739. **
  77740. ** Force the value in register P1 to be the type defined by P2.
  77741. **
  77742. ** <ul>
  77743. ** <li> P2=='A' &rarr; BLOB
  77744. ** <li> P2=='B' &rarr; TEXT
  77745. ** <li> P2=='C' &rarr; NUMERIC
  77746. ** <li> P2=='D' &rarr; INTEGER
  77747. ** <li> P2=='E' &rarr; REAL
  77748. ** </ul>
  77749. **
  77750. ** A NULL value is not changed by this routine. It remains NULL.
  77751. */
  77752. case OP_Cast: { /* in1 */
  77753. assert( pOp->p2>=SQLITE_AFF_BLOB && pOp->p2<=SQLITE_AFF_REAL );
  77754. testcase( pOp->p2==SQLITE_AFF_TEXT );
  77755. testcase( pOp->p2==SQLITE_AFF_BLOB );
  77756. testcase( pOp->p2==SQLITE_AFF_NUMERIC );
  77757. testcase( pOp->p2==SQLITE_AFF_INTEGER );
  77758. testcase( pOp->p2==SQLITE_AFF_REAL );
  77759. pIn1 = &aMem[pOp->p1];
  77760. memAboutToChange(p, pIn1);
  77761. rc = ExpandBlob(pIn1);
  77762. sqlite3VdbeMemCast(pIn1, pOp->p2, encoding);
  77763. UPDATE_MAX_BLOBSIZE(pIn1);
  77764. if( rc ) goto abort_due_to_error;
  77765. break;
  77766. }
  77767. #endif /* SQLITE_OMIT_CAST */
  77768. /* Opcode: Eq P1 P2 P3 P4 P5
  77769. ** Synopsis: IF r[P3]==r[P1]
  77770. **
  77771. ** Compare the values in register P1 and P3. If reg(P3)==reg(P1) then
  77772. ** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5, then
  77773. ** store the result of comparison in register P2.
  77774. **
  77775. ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
  77776. ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
  77777. ** to coerce both inputs according to this affinity before the
  77778. ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
  77779. ** affinity is used. Note that the affinity conversions are stored
  77780. ** back into the input registers P1 and P3. So this opcode can cause
  77781. ** persistent changes to registers P1 and P3.
  77782. **
  77783. ** Once any conversions have taken place, and neither value is NULL,
  77784. ** the values are compared. If both values are blobs then memcmp() is
  77785. ** used to determine the results of the comparison. If both values
  77786. ** are text, then the appropriate collating function specified in
  77787. ** P4 is used to do the comparison. If P4 is not specified then
  77788. ** memcmp() is used to compare text string. If both values are
  77789. ** numeric, then a numeric comparison is used. If the two values
  77790. ** are of different types, then numbers are considered less than
  77791. ** strings and strings are considered less than blobs.
  77792. **
  77793. ** If SQLITE_NULLEQ is set in P5 then the result of comparison is always either
  77794. ** true or false and is never NULL. If both operands are NULL then the result
  77795. ** of comparison is true. If either operand is NULL then the result is false.
  77796. ** If neither operand is NULL the result is the same as it would be if
  77797. ** the SQLITE_NULLEQ flag were omitted from P5.
  77798. **
  77799. ** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
  77800. ** content of r[P2] is only changed if the new value is NULL or 0 (false).
  77801. ** In other words, a prior r[P2] value will not be overwritten by 1 (true).
  77802. */
  77803. /* Opcode: Ne P1 P2 P3 P4 P5
  77804. ** Synopsis: IF r[P3]!=r[P1]
  77805. **
  77806. ** This works just like the Eq opcode except that the jump is taken if
  77807. ** the operands in registers P1 and P3 are not equal. See the Eq opcode for
  77808. ** additional information.
  77809. **
  77810. ** If both SQLITE_STOREP2 and SQLITE_KEEPNULL flags are set then the
  77811. ** content of r[P2] is only changed if the new value is NULL or 1 (true).
  77812. ** In other words, a prior r[P2] value will not be overwritten by 0 (false).
  77813. */
  77814. /* Opcode: Lt P1 P2 P3 P4 P5
  77815. ** Synopsis: IF r[P3]<r[P1]
  77816. **
  77817. ** Compare the values in register P1 and P3. If reg(P3)<reg(P1) then
  77818. ** jump to address P2. Or if the SQLITE_STOREP2 flag is set in P5 store
  77819. ** the result of comparison (0 or 1 or NULL) into register P2.
  77820. **
  77821. ** If the SQLITE_JUMPIFNULL bit of P5 is set and either reg(P1) or
  77822. ** reg(P3) is NULL then the take the jump. If the SQLITE_JUMPIFNULL
  77823. ** bit is clear then fall through if either operand is NULL.
  77824. **
  77825. ** The SQLITE_AFF_MASK portion of P5 must be an affinity character -
  77826. ** SQLITE_AFF_TEXT, SQLITE_AFF_INTEGER, and so forth. An attempt is made
  77827. ** to coerce both inputs according to this affinity before the
  77828. ** comparison is made. If the SQLITE_AFF_MASK is 0x00, then numeric
  77829. ** affinity is used. Note that the affinity conversions are stored
  77830. ** back into the input registers P1 and P3. So this opcode can cause
  77831. ** persistent changes to registers P1 and P3.
  77832. **
  77833. ** Once any conversions have taken place, and neither value is NULL,
  77834. ** the values are compared. If both values are blobs then memcmp() is
  77835. ** used to determine the results of the comparison. If both values
  77836. ** are text, then the appropriate collating function specified in
  77837. ** P4 is used to do the comparison. If P4 is not specified then
  77838. ** memcmp() is used to compare text string. If both values are
  77839. ** numeric, then a numeric comparison is used. If the two values
  77840. ** are of different types, then numbers are considered less than
  77841. ** strings and strings are considered less than blobs.
  77842. */
  77843. /* Opcode: Le P1 P2 P3 P4 P5
  77844. ** Synopsis: IF r[P3]<=r[P1]
  77845. **
  77846. ** This works just like the Lt opcode except that the jump is taken if
  77847. ** the content of register P3 is less than or equal to the content of
  77848. ** register P1. See the Lt opcode for additional information.
  77849. */
  77850. /* Opcode: Gt P1 P2 P3 P4 P5
  77851. ** Synopsis: IF r[P3]>r[P1]
  77852. **
  77853. ** This works just like the Lt opcode except that the jump is taken if
  77854. ** the content of register P3 is greater than the content of
  77855. ** register P1. See the Lt opcode for additional information.
  77856. */
  77857. /* Opcode: Ge P1 P2 P3 P4 P5
  77858. ** Synopsis: IF r[P3]>=r[P1]
  77859. **
  77860. ** This works just like the Lt opcode except that the jump is taken if
  77861. ** the content of register P3 is greater than or equal to the content of
  77862. ** register P1. See the Lt opcode for additional information.
  77863. */
  77864. case OP_Eq: /* same as TK_EQ, jump, in1, in3 */
  77865. case OP_Ne: /* same as TK_NE, jump, in1, in3 */
  77866. case OP_Lt: /* same as TK_LT, jump, in1, in3 */
  77867. case OP_Le: /* same as TK_LE, jump, in1, in3 */
  77868. case OP_Gt: /* same as TK_GT, jump, in1, in3 */
  77869. case OP_Ge: { /* same as TK_GE, jump, in1, in3 */
  77870. int res, res2; /* Result of the comparison of pIn1 against pIn3 */
  77871. char affinity; /* Affinity to use for comparison */
  77872. u16 flags1; /* Copy of initial value of pIn1->flags */
  77873. u16 flags3; /* Copy of initial value of pIn3->flags */
  77874. pIn1 = &aMem[pOp->p1];
  77875. pIn3 = &aMem[pOp->p3];
  77876. flags1 = pIn1->flags;
  77877. flags3 = pIn3->flags;
  77878. if( (flags1 | flags3)&MEM_Null ){
  77879. /* One or both operands are NULL */
  77880. if( pOp->p5 & SQLITE_NULLEQ ){
  77881. /* If SQLITE_NULLEQ is set (which will only happen if the operator is
  77882. ** OP_Eq or OP_Ne) then take the jump or not depending on whether
  77883. ** or not both operands are null.
  77884. */
  77885. assert( pOp->opcode==OP_Eq || pOp->opcode==OP_Ne );
  77886. assert( (flags1 & MEM_Cleared)==0 );
  77887. assert( (pOp->p5 & SQLITE_JUMPIFNULL)==0 );
  77888. if( (flags1&flags3&MEM_Null)!=0
  77889. && (flags3&MEM_Cleared)==0
  77890. ){
  77891. res = 0; /* Operands are equal */
  77892. }else{
  77893. res = 1; /* Operands are not equal */
  77894. }
  77895. }else{
  77896. /* SQLITE_NULLEQ is clear and at least one operand is NULL,
  77897. ** then the result is always NULL.
  77898. ** The jump is taken if the SQLITE_JUMPIFNULL bit is set.
  77899. */
  77900. if( pOp->p5 & SQLITE_STOREP2 ){
  77901. pOut = &aMem[pOp->p2];
  77902. iCompare = 1; /* Operands are not equal */
  77903. memAboutToChange(p, pOut);
  77904. MemSetTypeFlag(pOut, MEM_Null);
  77905. REGISTER_TRACE(pOp->p2, pOut);
  77906. }else{
  77907. VdbeBranchTaken(2,3);
  77908. if( pOp->p5 & SQLITE_JUMPIFNULL ){
  77909. goto jump_to_p2;
  77910. }
  77911. }
  77912. break;
  77913. }
  77914. }else{
  77915. /* Neither operand is NULL. Do a comparison. */
  77916. affinity = pOp->p5 & SQLITE_AFF_MASK;
  77917. if( affinity>=SQLITE_AFF_NUMERIC ){
  77918. if( (flags1 | flags3)&MEM_Str ){
  77919. if( (flags1 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
  77920. applyNumericAffinity(pIn1,0);
  77921. testcase( flags3!=pIn3->flags ); /* Possible if pIn1==pIn3 */
  77922. flags3 = pIn3->flags;
  77923. }
  77924. if( (flags3 & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
  77925. applyNumericAffinity(pIn3,0);
  77926. }
  77927. }
  77928. /* Handle the common case of integer comparison here, as an
  77929. ** optimization, to avoid a call to sqlite3MemCompare() */
  77930. if( (pIn1->flags & pIn3->flags & MEM_Int)!=0 ){
  77931. if( pIn3->u.i > pIn1->u.i ){ res = +1; goto compare_op; }
  77932. if( pIn3->u.i < pIn1->u.i ){ res = -1; goto compare_op; }
  77933. res = 0;
  77934. goto compare_op;
  77935. }
  77936. }else if( affinity==SQLITE_AFF_TEXT ){
  77937. if( (flags1 & MEM_Str)==0 && (flags1 & (MEM_Int|MEM_Real))!=0 ){
  77938. testcase( pIn1->flags & MEM_Int );
  77939. testcase( pIn1->flags & MEM_Real );
  77940. sqlite3VdbeMemStringify(pIn1, encoding, 1);
  77941. testcase( (flags1&MEM_Dyn) != (pIn1->flags&MEM_Dyn) );
  77942. flags1 = (pIn1->flags & ~MEM_TypeMask) | (flags1 & MEM_TypeMask);
  77943. assert( pIn1!=pIn3 );
  77944. }
  77945. if( (flags3 & MEM_Str)==0 && (flags3 & (MEM_Int|MEM_Real))!=0 ){
  77946. testcase( pIn3->flags & MEM_Int );
  77947. testcase( pIn3->flags & MEM_Real );
  77948. sqlite3VdbeMemStringify(pIn3, encoding, 1);
  77949. testcase( (flags3&MEM_Dyn) != (pIn3->flags&MEM_Dyn) );
  77950. flags3 = (pIn3->flags & ~MEM_TypeMask) | (flags3 & MEM_TypeMask);
  77951. }
  77952. }
  77953. assert( pOp->p4type==P4_COLLSEQ || pOp->p4.pColl==0 );
  77954. res = sqlite3MemCompare(pIn3, pIn1, pOp->p4.pColl);
  77955. }
  77956. compare_op:
  77957. /* At this point, res is negative, zero, or positive if reg[P1] is
  77958. ** less than, equal to, or greater than reg[P3], respectively. Compute
  77959. ** the answer to this operator in res2, depending on what the comparison
  77960. ** operator actually is. The next block of code depends on the fact
  77961. ** that the 6 comparison operators are consecutive integers in this
  77962. ** order: NE, EQ, GT, LE, LT, GE */
  77963. assert( OP_Eq==OP_Ne+1 ); assert( OP_Gt==OP_Ne+2 ); assert( OP_Le==OP_Ne+3 );
  77964. assert( OP_Lt==OP_Ne+4 ); assert( OP_Ge==OP_Ne+5 );
  77965. if( res<0 ){ /* ne, eq, gt, le, lt, ge */
  77966. static const unsigned char aLTb[] = { 1, 0, 0, 1, 1, 0 };
  77967. res2 = aLTb[pOp->opcode - OP_Ne];
  77968. }else if( res==0 ){
  77969. static const unsigned char aEQb[] = { 0, 1, 0, 1, 0, 1 };
  77970. res2 = aEQb[pOp->opcode - OP_Ne];
  77971. }else{
  77972. static const unsigned char aGTb[] = { 1, 0, 1, 0, 0, 1 };
  77973. res2 = aGTb[pOp->opcode - OP_Ne];
  77974. }
  77975. /* Undo any changes made by applyAffinity() to the input registers. */
  77976. assert( (pIn1->flags & MEM_Dyn) == (flags1 & MEM_Dyn) );
  77977. pIn1->flags = flags1;
  77978. assert( (pIn3->flags & MEM_Dyn) == (flags3 & MEM_Dyn) );
  77979. pIn3->flags = flags3;
  77980. if( pOp->p5 & SQLITE_STOREP2 ){
  77981. pOut = &aMem[pOp->p2];
  77982. iCompare = res;
  77983. if( (pOp->p5 & SQLITE_KEEPNULL)!=0 ){
  77984. /* The KEEPNULL flag prevents OP_Eq from overwriting a NULL with 1
  77985. ** and prevents OP_Ne from overwriting NULL with 0. This flag
  77986. ** is only used in contexts where either:
  77987. ** (1) op==OP_Eq && (r[P2]==NULL || r[P2]==0)
  77988. ** (2) op==OP_Ne && (r[P2]==NULL || r[P2]==1)
  77989. ** Therefore it is not necessary to check the content of r[P2] for
  77990. ** NULL. */
  77991. assert( pOp->opcode==OP_Ne || pOp->opcode==OP_Eq );
  77992. assert( res2==0 || res2==1 );
  77993. testcase( res2==0 && pOp->opcode==OP_Eq );
  77994. testcase( res2==1 && pOp->opcode==OP_Eq );
  77995. testcase( res2==0 && pOp->opcode==OP_Ne );
  77996. testcase( res2==1 && pOp->opcode==OP_Ne );
  77997. if( (pOp->opcode==OP_Eq)==res2 ) break;
  77998. }
  77999. memAboutToChange(p, pOut);
  78000. MemSetTypeFlag(pOut, MEM_Int);
  78001. pOut->u.i = res2;
  78002. REGISTER_TRACE(pOp->p2, pOut);
  78003. }else{
  78004. VdbeBranchTaken(res!=0, (pOp->p5 & SQLITE_NULLEQ)?2:3);
  78005. if( res2 ){
  78006. goto jump_to_p2;
  78007. }
  78008. }
  78009. break;
  78010. }
  78011. /* Opcode: ElseNotEq * P2 * * *
  78012. **
  78013. ** This opcode must immediately follow an OP_Lt or OP_Gt comparison operator.
  78014. ** If result of an OP_Eq comparison on the same two operands
  78015. ** would have be NULL or false (0), then then jump to P2.
  78016. ** If the result of an OP_Eq comparison on the two previous operands
  78017. ** would have been true (1), then fall through.
  78018. */
  78019. case OP_ElseNotEq: { /* same as TK_ESCAPE, jump */
  78020. assert( pOp>aOp );
  78021. assert( pOp[-1].opcode==OP_Lt || pOp[-1].opcode==OP_Gt );
  78022. assert( pOp[-1].p5 & SQLITE_STOREP2 );
  78023. VdbeBranchTaken(iCompare!=0, 2);
  78024. if( iCompare!=0 ) goto jump_to_p2;
  78025. break;
  78026. }
  78027. /* Opcode: Permutation * * * P4 *
  78028. **
  78029. ** Set the permutation used by the OP_Compare operator in the next
  78030. ** instruction. The permutation is stored in the P4 operand.
  78031. **
  78032. ** The permutation is only valid until the next OP_Compare that has
  78033. ** the OPFLAG_PERMUTE bit set in P5. Typically the OP_Permutation should
  78034. ** occur immediately prior to the OP_Compare.
  78035. **
  78036. ** The first integer in the P4 integer array is the length of the array
  78037. ** and does not become part of the permutation.
  78038. */
  78039. case OP_Permutation: {
  78040. assert( pOp->p4type==P4_INTARRAY );
  78041. assert( pOp->p4.ai );
  78042. assert( pOp[1].opcode==OP_Compare );
  78043. assert( pOp[1].p5 & OPFLAG_PERMUTE );
  78044. break;
  78045. }
  78046. /* Opcode: Compare P1 P2 P3 P4 P5
  78047. ** Synopsis: r[P1@P3] <-> r[P2@P3]
  78048. **
  78049. ** Compare two vectors of registers in reg(P1)..reg(P1+P3-1) (call this
  78050. ** vector "A") and in reg(P2)..reg(P2+P3-1) ("B"). Save the result of
  78051. ** the comparison for use by the next OP_Jump instruct.
  78052. **
  78053. ** If P5 has the OPFLAG_PERMUTE bit set, then the order of comparison is
  78054. ** determined by the most recent OP_Permutation operator. If the
  78055. ** OPFLAG_PERMUTE bit is clear, then register are compared in sequential
  78056. ** order.
  78057. **
  78058. ** P4 is a KeyInfo structure that defines collating sequences and sort
  78059. ** orders for the comparison. The permutation applies to registers
  78060. ** only. The KeyInfo elements are used sequentially.
  78061. **
  78062. ** The comparison is a sort comparison, so NULLs compare equal,
  78063. ** NULLs are less than numbers, numbers are less than strings,
  78064. ** and strings are less than blobs.
  78065. */
  78066. case OP_Compare: {
  78067. int n;
  78068. int i;
  78069. int p1;
  78070. int p2;
  78071. const KeyInfo *pKeyInfo;
  78072. int idx;
  78073. CollSeq *pColl; /* Collating sequence to use on this term */
  78074. int bRev; /* True for DESCENDING sort order */
  78075. int *aPermute; /* The permutation */
  78076. if( (pOp->p5 & OPFLAG_PERMUTE)==0 ){
  78077. aPermute = 0;
  78078. }else{
  78079. assert( pOp>aOp );
  78080. assert( pOp[-1].opcode==OP_Permutation );
  78081. assert( pOp[-1].p4type==P4_INTARRAY );
  78082. aPermute = pOp[-1].p4.ai + 1;
  78083. assert( aPermute!=0 );
  78084. }
  78085. n = pOp->p3;
  78086. pKeyInfo = pOp->p4.pKeyInfo;
  78087. assert( n>0 );
  78088. assert( pKeyInfo!=0 );
  78089. p1 = pOp->p1;
  78090. p2 = pOp->p2;
  78091. #ifdef SQLITE_DEBUG
  78092. if( aPermute ){
  78093. int k, mx = 0;
  78094. for(k=0; k<n; k++) if( aPermute[k]>mx ) mx = aPermute[k];
  78095. assert( p1>0 && p1+mx<=(p->nMem+1 - p->nCursor)+1 );
  78096. assert( p2>0 && p2+mx<=(p->nMem+1 - p->nCursor)+1 );
  78097. }else{
  78098. assert( p1>0 && p1+n<=(p->nMem+1 - p->nCursor)+1 );
  78099. assert( p2>0 && p2+n<=(p->nMem+1 - p->nCursor)+1 );
  78100. }
  78101. #endif /* SQLITE_DEBUG */
  78102. for(i=0; i<n; i++){
  78103. idx = aPermute ? aPermute[i] : i;
  78104. assert( memIsValid(&aMem[p1+idx]) );
  78105. assert( memIsValid(&aMem[p2+idx]) );
  78106. REGISTER_TRACE(p1+idx, &aMem[p1+idx]);
  78107. REGISTER_TRACE(p2+idx, &aMem[p2+idx]);
  78108. assert( i<pKeyInfo->nKeyField );
  78109. pColl = pKeyInfo->aColl[i];
  78110. bRev = pKeyInfo->aSortOrder[i];
  78111. iCompare = sqlite3MemCompare(&aMem[p1+idx], &aMem[p2+idx], pColl);
  78112. if( iCompare ){
  78113. if( bRev ) iCompare = -iCompare;
  78114. break;
  78115. }
  78116. }
  78117. break;
  78118. }
  78119. /* Opcode: Jump P1 P2 P3 * *
  78120. **
  78121. ** Jump to the instruction at address P1, P2, or P3 depending on whether
  78122. ** in the most recent OP_Compare instruction the P1 vector was less than
  78123. ** equal to, or greater than the P2 vector, respectively.
  78124. */
  78125. case OP_Jump: { /* jump */
  78126. if( iCompare<0 ){
  78127. VdbeBranchTaken(0,3); pOp = &aOp[pOp->p1 - 1];
  78128. }else if( iCompare==0 ){
  78129. VdbeBranchTaken(1,3); pOp = &aOp[pOp->p2 - 1];
  78130. }else{
  78131. VdbeBranchTaken(2,3); pOp = &aOp[pOp->p3 - 1];
  78132. }
  78133. break;
  78134. }
  78135. /* Opcode: And P1 P2 P3 * *
  78136. ** Synopsis: r[P3]=(r[P1] && r[P2])
  78137. **
  78138. ** Take the logical AND of the values in registers P1 and P2 and
  78139. ** write the result into register P3.
  78140. **
  78141. ** If either P1 or P2 is 0 (false) then the result is 0 even if
  78142. ** the other input is NULL. A NULL and true or two NULLs give
  78143. ** a NULL output.
  78144. */
  78145. /* Opcode: Or P1 P2 P3 * *
  78146. ** Synopsis: r[P3]=(r[P1] || r[P2])
  78147. **
  78148. ** Take the logical OR of the values in register P1 and P2 and
  78149. ** store the answer in register P3.
  78150. **
  78151. ** If either P1 or P2 is nonzero (true) then the result is 1 (true)
  78152. ** even if the other input is NULL. A NULL and false or two NULLs
  78153. ** give a NULL output.
  78154. */
  78155. case OP_And: /* same as TK_AND, in1, in2, out3 */
  78156. case OP_Or: { /* same as TK_OR, in1, in2, out3 */
  78157. int v1; /* Left operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
  78158. int v2; /* Right operand: 0==FALSE, 1==TRUE, 2==UNKNOWN or NULL */
  78159. v1 = sqlite3VdbeBooleanValue(&aMem[pOp->p1], 2);
  78160. v2 = sqlite3VdbeBooleanValue(&aMem[pOp->p2], 2);
  78161. if( pOp->opcode==OP_And ){
  78162. static const unsigned char and_logic[] = { 0, 0, 0, 0, 1, 2, 0, 2, 2 };
  78163. v1 = and_logic[v1*3+v2];
  78164. }else{
  78165. static const unsigned char or_logic[] = { 0, 1, 2, 1, 1, 1, 2, 1, 2 };
  78166. v1 = or_logic[v1*3+v2];
  78167. }
  78168. pOut = &aMem[pOp->p3];
  78169. if( v1==2 ){
  78170. MemSetTypeFlag(pOut, MEM_Null);
  78171. }else{
  78172. pOut->u.i = v1;
  78173. MemSetTypeFlag(pOut, MEM_Int);
  78174. }
  78175. break;
  78176. }
  78177. /* Opcode: IsTrue P1 P2 P3 P4 *
  78178. ** Synopsis: r[P2] = coalesce(r[P1]==TRUE,P3) ^ P4
  78179. **
  78180. ** This opcode implements the IS TRUE, IS FALSE, IS NOT TRUE, and
  78181. ** IS NOT FALSE operators.
  78182. **
  78183. ** Interpret the value in register P1 as a boolean value. Store that
  78184. ** boolean (a 0 or 1) in register P2. Or if the value in register P1 is
  78185. ** NULL, then the P3 is stored in register P2. Invert the answer if P4
  78186. ** is 1.
  78187. **
  78188. ** The logic is summarized like this:
  78189. **
  78190. ** <ul>
  78191. ** <li> If P3==0 and P4==0 then r[P2] := r[P1] IS TRUE
  78192. ** <li> If P3==1 and P4==1 then r[P2] := r[P1] IS FALSE
  78193. ** <li> If P3==0 and P4==1 then r[P2] := r[P1] IS NOT TRUE
  78194. ** <li> If P3==1 and P4==0 then r[P2] := r[P1] IS NOT FALSE
  78195. ** </ul>
  78196. */
  78197. case OP_IsTrue: { /* in1, out2 */
  78198. assert( pOp->p4type==P4_INT32 );
  78199. assert( pOp->p4.i==0 || pOp->p4.i==1 );
  78200. assert( pOp->p3==0 || pOp->p3==1 );
  78201. sqlite3VdbeMemSetInt64(&aMem[pOp->p2],
  78202. sqlite3VdbeBooleanValue(&aMem[pOp->p1], pOp->p3) ^ pOp->p4.i);
  78203. break;
  78204. }
  78205. /* Opcode: Not P1 P2 * * *
  78206. ** Synopsis: r[P2]= !r[P1]
  78207. **
  78208. ** Interpret the value in register P1 as a boolean value. Store the
  78209. ** boolean complement in register P2. If the value in register P1 is
  78210. ** NULL, then a NULL is stored in P2.
  78211. */
  78212. case OP_Not: { /* same as TK_NOT, in1, out2 */
  78213. pIn1 = &aMem[pOp->p1];
  78214. pOut = &aMem[pOp->p2];
  78215. if( (pIn1->flags & MEM_Null)==0 ){
  78216. sqlite3VdbeMemSetInt64(pOut, !sqlite3VdbeBooleanValue(pIn1,0));
  78217. }else{
  78218. sqlite3VdbeMemSetNull(pOut);
  78219. }
  78220. break;
  78221. }
  78222. /* Opcode: BitNot P1 P2 * * *
  78223. ** Synopsis: r[P1]= ~r[P1]
  78224. **
  78225. ** Interpret the content of register P1 as an integer. Store the
  78226. ** ones-complement of the P1 value into register P2. If P1 holds
  78227. ** a NULL then store a NULL in P2.
  78228. */
  78229. case OP_BitNot: { /* same as TK_BITNOT, in1, out2 */
  78230. pIn1 = &aMem[pOp->p1];
  78231. pOut = &aMem[pOp->p2];
  78232. sqlite3VdbeMemSetNull(pOut);
  78233. if( (pIn1->flags & MEM_Null)==0 ){
  78234. pOut->flags = MEM_Int;
  78235. pOut->u.i = ~sqlite3VdbeIntValue(pIn1);
  78236. }
  78237. break;
  78238. }
  78239. /* Opcode: Once P1 P2 * * *
  78240. **
  78241. ** Fall through to the next instruction the first time this opcode is
  78242. ** encountered on each invocation of the byte-code program. Jump to P2
  78243. ** on the second and all subsequent encounters during the same invocation.
  78244. **
  78245. ** Top-level programs determine first invocation by comparing the P1
  78246. ** operand against the P1 operand on the OP_Init opcode at the beginning
  78247. ** of the program. If the P1 values differ, then fall through and make
  78248. ** the P1 of this opcode equal to the P1 of OP_Init. If P1 values are
  78249. ** the same then take the jump.
  78250. **
  78251. ** For subprograms, there is a bitmask in the VdbeFrame that determines
  78252. ** whether or not the jump should be taken. The bitmask is necessary
  78253. ** because the self-altering code trick does not work for recursive
  78254. ** triggers.
  78255. */
  78256. case OP_Once: { /* jump */
  78257. u32 iAddr; /* Address of this instruction */
  78258. assert( p->aOp[0].opcode==OP_Init );
  78259. if( p->pFrame ){
  78260. iAddr = (int)(pOp - p->aOp);
  78261. if( (p->pFrame->aOnce[iAddr/8] & (1<<(iAddr & 7)))!=0 ){
  78262. VdbeBranchTaken(1, 2);
  78263. goto jump_to_p2;
  78264. }
  78265. p->pFrame->aOnce[iAddr/8] |= 1<<(iAddr & 7);
  78266. }else{
  78267. if( p->aOp[0].p1==pOp->p1 ){
  78268. VdbeBranchTaken(1, 2);
  78269. goto jump_to_p2;
  78270. }
  78271. }
  78272. VdbeBranchTaken(0, 2);
  78273. pOp->p1 = p->aOp[0].p1;
  78274. break;
  78275. }
  78276. /* Opcode: If P1 P2 P3 * *
  78277. **
  78278. ** Jump to P2 if the value in register P1 is true. The value
  78279. ** is considered true if it is numeric and non-zero. If the value
  78280. ** in P1 is NULL then take the jump if and only if P3 is non-zero.
  78281. */
  78282. case OP_If: { /* jump, in1 */
  78283. int c;
  78284. c = sqlite3VdbeBooleanValue(&aMem[pOp->p1], pOp->p3);
  78285. VdbeBranchTaken(c!=0, 2);
  78286. if( c ) goto jump_to_p2;
  78287. break;
  78288. }
  78289. /* Opcode: IfNot P1 P2 P3 * *
  78290. **
  78291. ** Jump to P2 if the value in register P1 is False. The value
  78292. ** is considered false if it has a numeric value of zero. If the value
  78293. ** in P1 is NULL then take the jump if and only if P3 is non-zero.
  78294. */
  78295. case OP_IfNot: { /* jump, in1 */
  78296. int c;
  78297. c = !sqlite3VdbeBooleanValue(&aMem[pOp->p1], !pOp->p3);
  78298. VdbeBranchTaken(c!=0, 2);
  78299. if( c ) goto jump_to_p2;
  78300. break;
  78301. }
  78302. /* Opcode: IsNull P1 P2 * * *
  78303. ** Synopsis: if r[P1]==NULL goto P2
  78304. **
  78305. ** Jump to P2 if the value in register P1 is NULL.
  78306. */
  78307. case OP_IsNull: { /* same as TK_ISNULL, jump, in1 */
  78308. pIn1 = &aMem[pOp->p1];
  78309. VdbeBranchTaken( (pIn1->flags & MEM_Null)!=0, 2);
  78310. if( (pIn1->flags & MEM_Null)!=0 ){
  78311. goto jump_to_p2;
  78312. }
  78313. break;
  78314. }
  78315. /* Opcode: NotNull P1 P2 * * *
  78316. ** Synopsis: if r[P1]!=NULL goto P2
  78317. **
  78318. ** Jump to P2 if the value in register P1 is not NULL.
  78319. */
  78320. case OP_NotNull: { /* same as TK_NOTNULL, jump, in1 */
  78321. pIn1 = &aMem[pOp->p1];
  78322. VdbeBranchTaken( (pIn1->flags & MEM_Null)==0, 2);
  78323. if( (pIn1->flags & MEM_Null)==0 ){
  78324. goto jump_to_p2;
  78325. }
  78326. break;
  78327. }
  78328. /* Opcode: IfNullRow P1 P2 P3 * *
  78329. ** Synopsis: if P1.nullRow then r[P3]=NULL, goto P2
  78330. **
  78331. ** Check the cursor P1 to see if it is currently pointing at a NULL row.
  78332. ** If it is, then set register P3 to NULL and jump immediately to P2.
  78333. ** If P1 is not on a NULL row, then fall through without making any
  78334. ** changes.
  78335. */
  78336. case OP_IfNullRow: { /* jump */
  78337. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  78338. assert( p->apCsr[pOp->p1]!=0 );
  78339. if( p->apCsr[pOp->p1]->nullRow ){
  78340. sqlite3VdbeMemSetNull(aMem + pOp->p3);
  78341. goto jump_to_p2;
  78342. }
  78343. break;
  78344. }
  78345. #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
  78346. /* Opcode: Offset P1 P2 P3 * *
  78347. ** Synopsis: r[P3] = sqlite_offset(P1)
  78348. **
  78349. ** Store in register r[P3] the byte offset into the database file that is the
  78350. ** start of the payload for the record at which that cursor P1 is currently
  78351. ** pointing.
  78352. **
  78353. ** P2 is the column number for the argument to the sqlite_offset() function.
  78354. ** This opcode does not use P2 itself, but the P2 value is used by the
  78355. ** code generator. The P1, P2, and P3 operands to this opcode are the
  78356. ** same as for OP_Column.
  78357. **
  78358. ** This opcode is only available if SQLite is compiled with the
  78359. ** -DSQLITE_ENABLE_OFFSET_SQL_FUNC option.
  78360. */
  78361. case OP_Offset: { /* out3 */
  78362. VdbeCursor *pC; /* The VDBE cursor */
  78363. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  78364. pC = p->apCsr[pOp->p1];
  78365. pOut = &p->aMem[pOp->p3];
  78366. if( NEVER(pC==0) || pC->eCurType!=CURTYPE_BTREE ){
  78367. sqlite3VdbeMemSetNull(pOut);
  78368. }else{
  78369. sqlite3VdbeMemSetInt64(pOut, sqlite3BtreeOffset(pC->uc.pCursor));
  78370. }
  78371. break;
  78372. }
  78373. #endif /* SQLITE_ENABLE_OFFSET_SQL_FUNC */
  78374. /* Opcode: Column P1 P2 P3 P4 P5
  78375. ** Synopsis: r[P3]=PX
  78376. **
  78377. ** Interpret the data that cursor P1 points to as a structure built using
  78378. ** the MakeRecord instruction. (See the MakeRecord opcode for additional
  78379. ** information about the format of the data.) Extract the P2-th column
  78380. ** from this record. If there are less that (P2+1)
  78381. ** values in the record, extract a NULL.
  78382. **
  78383. ** The value extracted is stored in register P3.
  78384. **
  78385. ** If the record contains fewer than P2 fields, then extract a NULL. Or,
  78386. ** if the P4 argument is a P4_MEM use the value of the P4 argument as
  78387. ** the result.
  78388. **
  78389. ** If the OPFLAG_CLEARCACHE bit is set on P5 and P1 is a pseudo-table cursor,
  78390. ** then the cache of the cursor is reset prior to extracting the column.
  78391. ** The first OP_Column against a pseudo-table after the value of the content
  78392. ** register has changed should have this bit set.
  78393. **
  78394. ** If the OPFLAG_LENGTHARG and OPFLAG_TYPEOFARG bits are set on P5 then
  78395. ** the result is guaranteed to only be used as the argument of a length()
  78396. ** or typeof() function, respectively. The loading of large blobs can be
  78397. ** skipped for length() and all content loading can be skipped for typeof().
  78398. */
  78399. case OP_Column: {
  78400. int p2; /* column number to retrieve */
  78401. VdbeCursor *pC; /* The VDBE cursor */
  78402. BtCursor *pCrsr; /* The BTree cursor */
  78403. u32 *aOffset; /* aOffset[i] is offset to start of data for i-th column */
  78404. int len; /* The length of the serialized data for the column */
  78405. int i; /* Loop counter */
  78406. Mem *pDest; /* Where to write the extracted value */
  78407. Mem sMem; /* For storing the record being decoded */
  78408. const u8 *zData; /* Part of the record being decoded */
  78409. const u8 *zHdr; /* Next unparsed byte of the header */
  78410. const u8 *zEndHdr; /* Pointer to first byte after the header */
  78411. u64 offset64; /* 64-bit offset */
  78412. u32 t; /* A type code from the record header */
  78413. Mem *pReg; /* PseudoTable input register */
  78414. pC = p->apCsr[pOp->p1];
  78415. p2 = pOp->p2;
  78416. /* If the cursor cache is stale (meaning it is not currently point at
  78417. ** the correct row) then bring it up-to-date by doing the necessary
  78418. ** B-Tree seek. */
  78419. rc = sqlite3VdbeCursorMoveto(&pC, &p2);
  78420. if( rc ) goto abort_due_to_error;
  78421. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  78422. pDest = &aMem[pOp->p3];
  78423. memAboutToChange(p, pDest);
  78424. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  78425. assert( pC!=0 );
  78426. assert( p2<pC->nField );
  78427. aOffset = pC->aOffset;
  78428. assert( pC->eCurType!=CURTYPE_VTAB );
  78429. assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
  78430. assert( pC->eCurType!=CURTYPE_SORTER );
  78431. if( pC->cacheStatus!=p->cacheCtr ){ /*OPTIMIZATION-IF-FALSE*/
  78432. if( pC->nullRow ){
  78433. if( pC->eCurType==CURTYPE_PSEUDO ){
  78434. /* For the special case of as pseudo-cursor, the seekResult field
  78435. ** identifies the register that holds the record */
  78436. assert( pC->seekResult>0 );
  78437. pReg = &aMem[pC->seekResult];
  78438. assert( pReg->flags & MEM_Blob );
  78439. assert( memIsValid(pReg) );
  78440. pC->payloadSize = pC->szRow = pReg->n;
  78441. pC->aRow = (u8*)pReg->z;
  78442. }else{
  78443. sqlite3VdbeMemSetNull(pDest);
  78444. goto op_column_out;
  78445. }
  78446. }else{
  78447. pCrsr = pC->uc.pCursor;
  78448. assert( pC->eCurType==CURTYPE_BTREE );
  78449. assert( pCrsr );
  78450. assert( sqlite3BtreeCursorIsValid(pCrsr) );
  78451. pC->payloadSize = sqlite3BtreePayloadSize(pCrsr);
  78452. pC->aRow = sqlite3BtreePayloadFetch(pCrsr, &pC->szRow);
  78453. assert( pC->szRow<=pC->payloadSize );
  78454. assert( pC->szRow<=65536 ); /* Maximum page size is 64KiB */
  78455. if( pC->payloadSize > (u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
  78456. goto too_big;
  78457. }
  78458. }
  78459. pC->cacheStatus = p->cacheCtr;
  78460. pC->iHdrOffset = getVarint32(pC->aRow, aOffset[0]);
  78461. pC->nHdrParsed = 0;
  78462. if( pC->szRow<aOffset[0] ){ /*OPTIMIZATION-IF-FALSE*/
  78463. /* pC->aRow does not have to hold the entire row, but it does at least
  78464. ** need to cover the header of the record. If pC->aRow does not contain
  78465. ** the complete header, then set it to zero, forcing the header to be
  78466. ** dynamically allocated. */
  78467. pC->aRow = 0;
  78468. pC->szRow = 0;
  78469. /* Make sure a corrupt database has not given us an oversize header.
  78470. ** Do this now to avoid an oversize memory allocation.
  78471. **
  78472. ** Type entries can be between 1 and 5 bytes each. But 4 and 5 byte
  78473. ** types use so much data space that there can only be 4096 and 32 of
  78474. ** them, respectively. So the maximum header length results from a
  78475. ** 3-byte type for each of the maximum of 32768 columns plus three
  78476. ** extra bytes for the header length itself. 32768*3 + 3 = 98307.
  78477. */
  78478. if( aOffset[0] > 98307 || aOffset[0] > pC->payloadSize ){
  78479. goto op_column_corrupt;
  78480. }
  78481. }else{
  78482. /* This is an optimization. By skipping over the first few tests
  78483. ** (ex: pC->nHdrParsed<=p2) in the next section, we achieve a
  78484. ** measurable performance gain.
  78485. **
  78486. ** This branch is taken even if aOffset[0]==0. Such a record is never
  78487. ** generated by SQLite, and could be considered corruption, but we
  78488. ** accept it for historical reasons. When aOffset[0]==0, the code this
  78489. ** branch jumps to reads past the end of the record, but never more
  78490. ** than a few bytes. Even if the record occurs at the end of the page
  78491. ** content area, the "page header" comes after the page content and so
  78492. ** this overread is harmless. Similar overreads can occur for a corrupt
  78493. ** database file.
  78494. */
  78495. zData = pC->aRow;
  78496. assert( pC->nHdrParsed<=p2 ); /* Conditional skipped */
  78497. testcase( aOffset[0]==0 );
  78498. goto op_column_read_header;
  78499. }
  78500. }
  78501. /* Make sure at least the first p2+1 entries of the header have been
  78502. ** parsed and valid information is in aOffset[] and pC->aType[].
  78503. */
  78504. if( pC->nHdrParsed<=p2 ){
  78505. /* If there is more header available for parsing in the record, try
  78506. ** to extract additional fields up through the p2+1-th field
  78507. */
  78508. if( pC->iHdrOffset<aOffset[0] ){
  78509. /* Make sure zData points to enough of the record to cover the header. */
  78510. if( pC->aRow==0 ){
  78511. memset(&sMem, 0, sizeof(sMem));
  78512. rc = sqlite3VdbeMemFromBtree(pC->uc.pCursor, 0, aOffset[0], &sMem);
  78513. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  78514. zData = (u8*)sMem.z;
  78515. }else{
  78516. zData = pC->aRow;
  78517. }
  78518. /* Fill in pC->aType[i] and aOffset[i] values through the p2-th field. */
  78519. op_column_read_header:
  78520. i = pC->nHdrParsed;
  78521. offset64 = aOffset[i];
  78522. zHdr = zData + pC->iHdrOffset;
  78523. zEndHdr = zData + aOffset[0];
  78524. testcase( zHdr>=zEndHdr );
  78525. do{
  78526. if( (t = zHdr[0])<0x80 ){
  78527. zHdr++;
  78528. offset64 += sqlite3VdbeOneByteSerialTypeLen(t);
  78529. }else{
  78530. zHdr += sqlite3GetVarint32(zHdr, &t);
  78531. offset64 += sqlite3VdbeSerialTypeLen(t);
  78532. }
  78533. pC->aType[i++] = t;
  78534. aOffset[i] = (u32)(offset64 & 0xffffffff);
  78535. }while( i<=p2 && zHdr<zEndHdr );
  78536. /* The record is corrupt if any of the following are true:
  78537. ** (1) the bytes of the header extend past the declared header size
  78538. ** (2) the entire header was used but not all data was used
  78539. ** (3) the end of the data extends beyond the end of the record.
  78540. */
  78541. if( (zHdr>=zEndHdr && (zHdr>zEndHdr || offset64!=pC->payloadSize))
  78542. || (offset64 > pC->payloadSize)
  78543. ){
  78544. if( aOffset[0]==0 ){
  78545. i = 0;
  78546. zHdr = zEndHdr;
  78547. }else{
  78548. if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
  78549. goto op_column_corrupt;
  78550. }
  78551. }
  78552. pC->nHdrParsed = i;
  78553. pC->iHdrOffset = (u32)(zHdr - zData);
  78554. if( pC->aRow==0 ) sqlite3VdbeMemRelease(&sMem);
  78555. }else{
  78556. t = 0;
  78557. }
  78558. /* If after trying to extract new entries from the header, nHdrParsed is
  78559. ** still not up to p2, that means that the record has fewer than p2
  78560. ** columns. So the result will be either the default value or a NULL.
  78561. */
  78562. if( pC->nHdrParsed<=p2 ){
  78563. if( pOp->p4type==P4_MEM ){
  78564. sqlite3VdbeMemShallowCopy(pDest, pOp->p4.pMem, MEM_Static);
  78565. }else{
  78566. sqlite3VdbeMemSetNull(pDest);
  78567. }
  78568. goto op_column_out;
  78569. }
  78570. }else{
  78571. t = pC->aType[p2];
  78572. }
  78573. /* Extract the content for the p2+1-th column. Control can only
  78574. ** reach this point if aOffset[p2], aOffset[p2+1], and pC->aType[p2] are
  78575. ** all valid.
  78576. */
  78577. assert( p2<pC->nHdrParsed );
  78578. assert( rc==SQLITE_OK );
  78579. assert( sqlite3VdbeCheckMemInvariants(pDest) );
  78580. if( VdbeMemDynamic(pDest) ){
  78581. sqlite3VdbeMemSetNull(pDest);
  78582. }
  78583. assert( t==pC->aType[p2] );
  78584. if( pC->szRow>=aOffset[p2+1] ){
  78585. /* This is the common case where the desired content fits on the original
  78586. ** page - where the content is not on an overflow page */
  78587. zData = pC->aRow + aOffset[p2];
  78588. if( t<12 ){
  78589. sqlite3VdbeSerialGet(zData, t, pDest);
  78590. }else{
  78591. /* If the column value is a string, we need a persistent value, not
  78592. ** a MEM_Ephem value. This branch is a fast short-cut that is equivalent
  78593. ** to calling sqlite3VdbeSerialGet() and sqlite3VdbeDeephemeralize().
  78594. */
  78595. static const u16 aFlag[] = { MEM_Blob, MEM_Str|MEM_Term };
  78596. pDest->n = len = (t-12)/2;
  78597. pDest->enc = encoding;
  78598. if( pDest->szMalloc < len+2 ){
  78599. pDest->flags = MEM_Null;
  78600. if( sqlite3VdbeMemGrow(pDest, len+2, 0) ) goto no_mem;
  78601. }else{
  78602. pDest->z = pDest->zMalloc;
  78603. }
  78604. memcpy(pDest->z, zData, len);
  78605. pDest->z[len] = 0;
  78606. pDest->z[len+1] = 0;
  78607. pDest->flags = aFlag[t&1];
  78608. }
  78609. }else{
  78610. pDest->enc = encoding;
  78611. /* This branch happens only when content is on overflow pages */
  78612. if( ((pOp->p5 & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG))!=0
  78613. && ((t>=12 && (t&1)==0) || (pOp->p5 & OPFLAG_TYPEOFARG)!=0))
  78614. || (len = sqlite3VdbeSerialTypeLen(t))==0
  78615. ){
  78616. /* Content is irrelevant for
  78617. ** 1. the typeof() function,
  78618. ** 2. the length(X) function if X is a blob, and
  78619. ** 3. if the content length is zero.
  78620. ** So we might as well use bogus content rather than reading
  78621. ** content from disk.
  78622. **
  78623. ** Although sqlite3VdbeSerialGet() may read at most 8 bytes from the
  78624. ** buffer passed to it, debugging function VdbeMemPrettyPrint() may
  78625. ** read up to 16. So 16 bytes of bogus content is supplied.
  78626. */
  78627. static u8 aZero[16]; /* This is the bogus content */
  78628. sqlite3VdbeSerialGet(aZero, t, pDest);
  78629. }else{
  78630. rc = sqlite3VdbeMemFromBtree(pC->uc.pCursor, aOffset[p2], len, pDest);
  78631. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  78632. sqlite3VdbeSerialGet((const u8*)pDest->z, t, pDest);
  78633. pDest->flags &= ~MEM_Ephem;
  78634. }
  78635. }
  78636. op_column_out:
  78637. UPDATE_MAX_BLOBSIZE(pDest);
  78638. REGISTER_TRACE(pOp->p3, pDest);
  78639. break;
  78640. op_column_corrupt:
  78641. if( aOp[0].p3>0 ){
  78642. pOp = &aOp[aOp[0].p3-1];
  78643. break;
  78644. }else{
  78645. rc = SQLITE_CORRUPT_BKPT;
  78646. goto abort_due_to_error;
  78647. }
  78648. }
  78649. /* Opcode: Affinity P1 P2 * P4 *
  78650. ** Synopsis: affinity(r[P1@P2])
  78651. **
  78652. ** Apply affinities to a range of P2 registers starting with P1.
  78653. **
  78654. ** P4 is a string that is P2 characters long. The N-th character of the
  78655. ** string indicates the column affinity that should be used for the N-th
  78656. ** memory cell in the range.
  78657. */
  78658. case OP_Affinity: {
  78659. const char *zAffinity; /* The affinity to be applied */
  78660. zAffinity = pOp->p4.z;
  78661. assert( zAffinity!=0 );
  78662. assert( pOp->p2>0 );
  78663. assert( zAffinity[pOp->p2]==0 );
  78664. pIn1 = &aMem[pOp->p1];
  78665. do{
  78666. assert( pIn1 <= &p->aMem[(p->nMem+1 - p->nCursor)] );
  78667. assert( memIsValid(pIn1) );
  78668. applyAffinity(pIn1, *(zAffinity++), encoding);
  78669. pIn1++;
  78670. }while( zAffinity[0] );
  78671. break;
  78672. }
  78673. /* Opcode: MakeRecord P1 P2 P3 P4 *
  78674. ** Synopsis: r[P3]=mkrec(r[P1@P2])
  78675. **
  78676. ** Convert P2 registers beginning with P1 into the [record format]
  78677. ** use as a data record in a database table or as a key
  78678. ** in an index. The OP_Column opcode can decode the record later.
  78679. **
  78680. ** P4 may be a string that is P2 characters long. The N-th character of the
  78681. ** string indicates the column affinity that should be used for the N-th
  78682. ** field of the index key.
  78683. **
  78684. ** The mapping from character to affinity is given by the SQLITE_AFF_
  78685. ** macros defined in sqliteInt.h.
  78686. **
  78687. ** If P4 is NULL then all index fields have the affinity BLOB.
  78688. */
  78689. case OP_MakeRecord: {
  78690. u8 *zNewRecord; /* A buffer to hold the data for the new record */
  78691. Mem *pRec; /* The new record */
  78692. u64 nData; /* Number of bytes of data space */
  78693. int nHdr; /* Number of bytes of header space */
  78694. i64 nByte; /* Data space required for this record */
  78695. i64 nZero; /* Number of zero bytes at the end of the record */
  78696. int nVarint; /* Number of bytes in a varint */
  78697. u32 serial_type; /* Type field */
  78698. Mem *pData0; /* First field to be combined into the record */
  78699. Mem *pLast; /* Last field of the record */
  78700. int nField; /* Number of fields in the record */
  78701. char *zAffinity; /* The affinity string for the record */
  78702. int file_format; /* File format to use for encoding */
  78703. int i; /* Space used in zNewRecord[] header */
  78704. int j; /* Space used in zNewRecord[] content */
  78705. u32 len; /* Length of a field */
  78706. /* Assuming the record contains N fields, the record format looks
  78707. ** like this:
  78708. **
  78709. ** ------------------------------------------------------------------------
  78710. ** | hdr-size | type 0 | type 1 | ... | type N-1 | data0 | ... | data N-1 |
  78711. ** ------------------------------------------------------------------------
  78712. **
  78713. ** Data(0) is taken from register P1. Data(1) comes from register P1+1
  78714. ** and so forth.
  78715. **
  78716. ** Each type field is a varint representing the serial type of the
  78717. ** corresponding data element (see sqlite3VdbeSerialType()). The
  78718. ** hdr-size field is also a varint which is the offset from the beginning
  78719. ** of the record to data0.
  78720. */
  78721. nData = 0; /* Number of bytes of data space */
  78722. nHdr = 0; /* Number of bytes of header space */
  78723. nZero = 0; /* Number of zero bytes at the end of the record */
  78724. nField = pOp->p1;
  78725. zAffinity = pOp->p4.z;
  78726. assert( nField>0 && pOp->p2>0 && pOp->p2+nField<=(p->nMem+1 - p->nCursor)+1 );
  78727. pData0 = &aMem[nField];
  78728. nField = pOp->p2;
  78729. pLast = &pData0[nField-1];
  78730. file_format = p->minWriteFileFormat;
  78731. /* Identify the output register */
  78732. assert( pOp->p3<pOp->p1 || pOp->p3>=pOp->p1+pOp->p2 );
  78733. pOut = &aMem[pOp->p3];
  78734. memAboutToChange(p, pOut);
  78735. /* Apply the requested affinity to all inputs
  78736. */
  78737. assert( pData0<=pLast );
  78738. if( zAffinity ){
  78739. pRec = pData0;
  78740. do{
  78741. applyAffinity(pRec++, *(zAffinity++), encoding);
  78742. assert( zAffinity[0]==0 || pRec<=pLast );
  78743. }while( zAffinity[0] );
  78744. }
  78745. #ifdef SQLITE_ENABLE_NULL_TRIM
  78746. /* NULLs can be safely trimmed from the end of the record, as long as
  78747. ** as the schema format is 2 or more and none of the omitted columns
  78748. ** have a non-NULL default value. Also, the record must be left with
  78749. ** at least one field. If P5>0 then it will be one more than the
  78750. ** index of the right-most column with a non-NULL default value */
  78751. if( pOp->p5 ){
  78752. while( (pLast->flags & MEM_Null)!=0 && nField>pOp->p5 ){
  78753. pLast--;
  78754. nField--;
  78755. }
  78756. }
  78757. #endif
  78758. /* Loop through the elements that will make up the record to figure
  78759. ** out how much space is required for the new record.
  78760. */
  78761. pRec = pLast;
  78762. do{
  78763. assert( memIsValid(pRec) );
  78764. serial_type = sqlite3VdbeSerialType(pRec, file_format, &len);
  78765. if( pRec->flags & MEM_Zero ){
  78766. if( serial_type==0 ){
  78767. /* Values with MEM_Null and MEM_Zero are created by xColumn virtual
  78768. ** table methods that never invoke sqlite3_result_xxxxx() while
  78769. ** computing an unchanging column value in an UPDATE statement.
  78770. ** Give such values a special internal-use-only serial-type of 10
  78771. ** so that they can be passed through to xUpdate and have
  78772. ** a true sqlite3_value_nochange(). */
  78773. assert( pOp->p5==OPFLAG_NOCHNG_MAGIC || CORRUPT_DB );
  78774. serial_type = 10;
  78775. }else if( nData ){
  78776. if( sqlite3VdbeMemExpandBlob(pRec) ) goto no_mem;
  78777. }else{
  78778. nZero += pRec->u.nZero;
  78779. len -= pRec->u.nZero;
  78780. }
  78781. }
  78782. nData += len;
  78783. testcase( serial_type==127 );
  78784. testcase( serial_type==128 );
  78785. nHdr += serial_type<=127 ? 1 : sqlite3VarintLen(serial_type);
  78786. pRec->uTemp = serial_type;
  78787. if( pRec==pData0 ) break;
  78788. pRec--;
  78789. }while(1);
  78790. /* EVIDENCE-OF: R-22564-11647 The header begins with a single varint
  78791. ** which determines the total number of bytes in the header. The varint
  78792. ** value is the size of the header in bytes including the size varint
  78793. ** itself. */
  78794. testcase( nHdr==126 );
  78795. testcase( nHdr==127 );
  78796. if( nHdr<=126 ){
  78797. /* The common case */
  78798. nHdr += 1;
  78799. }else{
  78800. /* Rare case of a really large header */
  78801. nVarint = sqlite3VarintLen(nHdr);
  78802. nHdr += nVarint;
  78803. if( nVarint<sqlite3VarintLen(nHdr) ) nHdr++;
  78804. }
  78805. nByte = nHdr+nData;
  78806. if( nByte+nZero>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  78807. goto too_big;
  78808. }
  78809. /* Make sure the output register has a buffer large enough to store
  78810. ** the new record. The output register (pOp->p3) is not allowed to
  78811. ** be one of the input registers (because the following call to
  78812. ** sqlite3VdbeMemClearAndResize() could clobber the value before it is used).
  78813. */
  78814. if( sqlite3VdbeMemClearAndResize(pOut, (int)nByte) ){
  78815. goto no_mem;
  78816. }
  78817. zNewRecord = (u8 *)pOut->z;
  78818. /* Write the record */
  78819. i = putVarint32(zNewRecord, nHdr);
  78820. j = nHdr;
  78821. assert( pData0<=pLast );
  78822. pRec = pData0;
  78823. do{
  78824. serial_type = pRec->uTemp;
  78825. /* EVIDENCE-OF: R-06529-47362 Following the size varint are one or more
  78826. ** additional varints, one per column. */
  78827. i += putVarint32(&zNewRecord[i], serial_type); /* serial type */
  78828. /* EVIDENCE-OF: R-64536-51728 The values for each column in the record
  78829. ** immediately follow the header. */
  78830. j += sqlite3VdbeSerialPut(&zNewRecord[j], pRec, serial_type); /* content */
  78831. }while( (++pRec)<=pLast );
  78832. assert( i==nHdr );
  78833. assert( j==nByte );
  78834. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  78835. pOut->n = (int)nByte;
  78836. pOut->flags = MEM_Blob;
  78837. if( nZero ){
  78838. pOut->u.nZero = nZero;
  78839. pOut->flags |= MEM_Zero;
  78840. }
  78841. REGISTER_TRACE(pOp->p3, pOut);
  78842. UPDATE_MAX_BLOBSIZE(pOut);
  78843. break;
  78844. }
  78845. /* Opcode: Count P1 P2 * * *
  78846. ** Synopsis: r[P2]=count()
  78847. **
  78848. ** Store the number of entries (an integer value) in the table or index
  78849. ** opened by cursor P1 in register P2
  78850. */
  78851. #ifndef SQLITE_OMIT_BTREECOUNT
  78852. case OP_Count: { /* out2 */
  78853. i64 nEntry;
  78854. BtCursor *pCrsr;
  78855. assert( p->apCsr[pOp->p1]->eCurType==CURTYPE_BTREE );
  78856. pCrsr = p->apCsr[pOp->p1]->uc.pCursor;
  78857. assert( pCrsr );
  78858. nEntry = 0; /* Not needed. Only used to silence a warning. */
  78859. rc = sqlite3BtreeCount(pCrsr, &nEntry);
  78860. if( rc ) goto abort_due_to_error;
  78861. pOut = out2Prerelease(p, pOp);
  78862. pOut->u.i = nEntry;
  78863. break;
  78864. }
  78865. #endif
  78866. /* Opcode: Savepoint P1 * * P4 *
  78867. **
  78868. ** Open, release or rollback the savepoint named by parameter P4, depending
  78869. ** on the value of P1. To open a new savepoint, P1==0. To release (commit) an
  78870. ** existing savepoint, P1==1, or to rollback an existing savepoint P1==2.
  78871. */
  78872. case OP_Savepoint: {
  78873. int p1; /* Value of P1 operand */
  78874. char *zName; /* Name of savepoint */
  78875. int nName;
  78876. Savepoint *pNew;
  78877. Savepoint *pSavepoint;
  78878. Savepoint *pTmp;
  78879. int iSavepoint;
  78880. int ii;
  78881. p1 = pOp->p1;
  78882. zName = pOp->p4.z;
  78883. /* Assert that the p1 parameter is valid. Also that if there is no open
  78884. ** transaction, then there cannot be any savepoints.
  78885. */
  78886. assert( db->pSavepoint==0 || db->autoCommit==0 );
  78887. assert( p1==SAVEPOINT_BEGIN||p1==SAVEPOINT_RELEASE||p1==SAVEPOINT_ROLLBACK );
  78888. assert( db->pSavepoint || db->isTransactionSavepoint==0 );
  78889. assert( checkSavepointCount(db) );
  78890. assert( p->bIsReader );
  78891. if( p1==SAVEPOINT_BEGIN ){
  78892. if( db->nVdbeWrite>0 ){
  78893. /* A new savepoint cannot be created if there are active write
  78894. ** statements (i.e. open read/write incremental blob handles).
  78895. */
  78896. sqlite3VdbeError(p, "cannot open savepoint - SQL statements in progress");
  78897. rc = SQLITE_BUSY;
  78898. }else{
  78899. nName = sqlite3Strlen30(zName);
  78900. #ifndef SQLITE_OMIT_VIRTUALTABLE
  78901. /* This call is Ok even if this savepoint is actually a transaction
  78902. ** savepoint (and therefore should not prompt xSavepoint()) callbacks.
  78903. ** If this is a transaction savepoint being opened, it is guaranteed
  78904. ** that the db->aVTrans[] array is empty. */
  78905. assert( db->autoCommit==0 || db->nVTrans==0 );
  78906. rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN,
  78907. db->nStatement+db->nSavepoint);
  78908. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  78909. #endif
  78910. /* Create a new savepoint structure. */
  78911. pNew = sqlite3DbMallocRawNN(db, sizeof(Savepoint)+nName+1);
  78912. if( pNew ){
  78913. pNew->zName = (char *)&pNew[1];
  78914. memcpy(pNew->zName, zName, nName+1);
  78915. /* If there is no open transaction, then mark this as a special
  78916. ** "transaction savepoint". */
  78917. if( db->autoCommit ){
  78918. db->autoCommit = 0;
  78919. db->isTransactionSavepoint = 1;
  78920. }else{
  78921. db->nSavepoint++;
  78922. }
  78923. /* Link the new savepoint into the database handle's list. */
  78924. pNew->pNext = db->pSavepoint;
  78925. db->pSavepoint = pNew;
  78926. pNew->nDeferredCons = db->nDeferredCons;
  78927. pNew->nDeferredImmCons = db->nDeferredImmCons;
  78928. }
  78929. }
  78930. }else{
  78931. iSavepoint = 0;
  78932. /* Find the named savepoint. If there is no such savepoint, then an
  78933. ** an error is returned to the user. */
  78934. for(
  78935. pSavepoint = db->pSavepoint;
  78936. pSavepoint && sqlite3StrICmp(pSavepoint->zName, zName);
  78937. pSavepoint = pSavepoint->pNext
  78938. ){
  78939. iSavepoint++;
  78940. }
  78941. if( !pSavepoint ){
  78942. sqlite3VdbeError(p, "no such savepoint: %s", zName);
  78943. rc = SQLITE_ERROR;
  78944. }else if( db->nVdbeWrite>0 && p1==SAVEPOINT_RELEASE ){
  78945. /* It is not possible to release (commit) a savepoint if there are
  78946. ** active write statements.
  78947. */
  78948. sqlite3VdbeError(p, "cannot release savepoint - "
  78949. "SQL statements in progress");
  78950. rc = SQLITE_BUSY;
  78951. }else{
  78952. /* Determine whether or not this is a transaction savepoint. If so,
  78953. ** and this is a RELEASE command, then the current transaction
  78954. ** is committed.
  78955. */
  78956. int isTransaction = pSavepoint->pNext==0 && db->isTransactionSavepoint;
  78957. if( isTransaction && p1==SAVEPOINT_RELEASE ){
  78958. if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
  78959. goto vdbe_return;
  78960. }
  78961. db->autoCommit = 1;
  78962. if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
  78963. p->pc = (int)(pOp - aOp);
  78964. db->autoCommit = 0;
  78965. p->rc = rc = SQLITE_BUSY;
  78966. goto vdbe_return;
  78967. }
  78968. db->isTransactionSavepoint = 0;
  78969. rc = p->rc;
  78970. }else{
  78971. int isSchemaChange;
  78972. iSavepoint = db->nSavepoint - iSavepoint - 1;
  78973. if( p1==SAVEPOINT_ROLLBACK ){
  78974. isSchemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0;
  78975. for(ii=0; ii<db->nDb; ii++){
  78976. rc = sqlite3BtreeTripAllCursors(db->aDb[ii].pBt,
  78977. SQLITE_ABORT_ROLLBACK,
  78978. isSchemaChange==0);
  78979. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  78980. }
  78981. }else{
  78982. isSchemaChange = 0;
  78983. }
  78984. for(ii=0; ii<db->nDb; ii++){
  78985. rc = sqlite3BtreeSavepoint(db->aDb[ii].pBt, p1, iSavepoint);
  78986. if( rc!=SQLITE_OK ){
  78987. goto abort_due_to_error;
  78988. }
  78989. }
  78990. if( isSchemaChange ){
  78991. sqlite3ExpirePreparedStatements(db);
  78992. sqlite3ResetAllSchemasOfConnection(db);
  78993. db->mDbFlags |= DBFLAG_SchemaChange;
  78994. }
  78995. }
  78996. /* Regardless of whether this is a RELEASE or ROLLBACK, destroy all
  78997. ** savepoints nested inside of the savepoint being operated on. */
  78998. while( db->pSavepoint!=pSavepoint ){
  78999. pTmp = db->pSavepoint;
  79000. db->pSavepoint = pTmp->pNext;
  79001. sqlite3DbFree(db, pTmp);
  79002. db->nSavepoint--;
  79003. }
  79004. /* If it is a RELEASE, then destroy the savepoint being operated on
  79005. ** too. If it is a ROLLBACK TO, then set the number of deferred
  79006. ** constraint violations present in the database to the value stored
  79007. ** when the savepoint was created. */
  79008. if( p1==SAVEPOINT_RELEASE ){
  79009. assert( pSavepoint==db->pSavepoint );
  79010. db->pSavepoint = pSavepoint->pNext;
  79011. sqlite3DbFree(db, pSavepoint);
  79012. if( !isTransaction ){
  79013. db->nSavepoint--;
  79014. }
  79015. }else{
  79016. db->nDeferredCons = pSavepoint->nDeferredCons;
  79017. db->nDeferredImmCons = pSavepoint->nDeferredImmCons;
  79018. }
  79019. if( !isTransaction || p1==SAVEPOINT_ROLLBACK ){
  79020. rc = sqlite3VtabSavepoint(db, p1, iSavepoint);
  79021. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  79022. }
  79023. }
  79024. }
  79025. if( rc ) goto abort_due_to_error;
  79026. break;
  79027. }
  79028. /* Opcode: AutoCommit P1 P2 * * *
  79029. **
  79030. ** Set the database auto-commit flag to P1 (1 or 0). If P2 is true, roll
  79031. ** back any currently active btree transactions. If there are any active
  79032. ** VMs (apart from this one), then a ROLLBACK fails. A COMMIT fails if
  79033. ** there are active writing VMs or active VMs that use shared cache.
  79034. **
  79035. ** This instruction causes the VM to halt.
  79036. */
  79037. case OP_AutoCommit: {
  79038. int desiredAutoCommit;
  79039. int iRollback;
  79040. desiredAutoCommit = pOp->p1;
  79041. iRollback = pOp->p2;
  79042. assert( desiredAutoCommit==1 || desiredAutoCommit==0 );
  79043. assert( desiredAutoCommit==1 || iRollback==0 );
  79044. assert( db->nVdbeActive>0 ); /* At least this one VM is active */
  79045. assert( p->bIsReader );
  79046. if( desiredAutoCommit!=db->autoCommit ){
  79047. if( iRollback ){
  79048. assert( desiredAutoCommit==1 );
  79049. sqlite3RollbackAll(db, SQLITE_ABORT_ROLLBACK);
  79050. db->autoCommit = 1;
  79051. }else if( desiredAutoCommit && db->nVdbeWrite>0 ){
  79052. /* If this instruction implements a COMMIT and other VMs are writing
  79053. ** return an error indicating that the other VMs must complete first.
  79054. */
  79055. sqlite3VdbeError(p, "cannot commit transaction - "
  79056. "SQL statements in progress");
  79057. rc = SQLITE_BUSY;
  79058. goto abort_due_to_error;
  79059. }else if( (rc = sqlite3VdbeCheckFk(p, 1))!=SQLITE_OK ){
  79060. goto vdbe_return;
  79061. }else{
  79062. db->autoCommit = (u8)desiredAutoCommit;
  79063. }
  79064. if( sqlite3VdbeHalt(p)==SQLITE_BUSY ){
  79065. p->pc = (int)(pOp - aOp);
  79066. db->autoCommit = (u8)(1-desiredAutoCommit);
  79067. p->rc = rc = SQLITE_BUSY;
  79068. goto vdbe_return;
  79069. }
  79070. assert( db->nStatement==0 );
  79071. sqlite3CloseSavepoints(db);
  79072. if( p->rc==SQLITE_OK ){
  79073. rc = SQLITE_DONE;
  79074. }else{
  79075. rc = SQLITE_ERROR;
  79076. }
  79077. goto vdbe_return;
  79078. }else{
  79079. sqlite3VdbeError(p,
  79080. (!desiredAutoCommit)?"cannot start a transaction within a transaction":(
  79081. (iRollback)?"cannot rollback - no transaction is active":
  79082. "cannot commit - no transaction is active"));
  79083. rc = SQLITE_ERROR;
  79084. goto abort_due_to_error;
  79085. }
  79086. break;
  79087. }
  79088. /* Opcode: Transaction P1 P2 P3 P4 P5
  79089. **
  79090. ** Begin a transaction on database P1 if a transaction is not already
  79091. ** active.
  79092. ** If P2 is non-zero, then a write-transaction is started, or if a
  79093. ** read-transaction is already active, it is upgraded to a write-transaction.
  79094. ** If P2 is zero, then a read-transaction is started.
  79095. **
  79096. ** P1 is the index of the database file on which the transaction is
  79097. ** started. Index 0 is the main database file and index 1 is the
  79098. ** file used for temporary tables. Indices of 2 or more are used for
  79099. ** attached databases.
  79100. **
  79101. ** If a write-transaction is started and the Vdbe.usesStmtJournal flag is
  79102. ** true (this flag is set if the Vdbe may modify more than one row and may
  79103. ** throw an ABORT exception), a statement transaction may also be opened.
  79104. ** More specifically, a statement transaction is opened iff the database
  79105. ** connection is currently not in autocommit mode, or if there are other
  79106. ** active statements. A statement transaction allows the changes made by this
  79107. ** VDBE to be rolled back after an error without having to roll back the
  79108. ** entire transaction. If no error is encountered, the statement transaction
  79109. ** will automatically commit when the VDBE halts.
  79110. **
  79111. ** If P5!=0 then this opcode also checks the schema cookie against P3
  79112. ** and the schema generation counter against P4.
  79113. ** The cookie changes its value whenever the database schema changes.
  79114. ** This operation is used to detect when that the cookie has changed
  79115. ** and that the current process needs to reread the schema. If the schema
  79116. ** cookie in P3 differs from the schema cookie in the database header or
  79117. ** if the schema generation counter in P4 differs from the current
  79118. ** generation counter, then an SQLITE_SCHEMA error is raised and execution
  79119. ** halts. The sqlite3_step() wrapper function might then reprepare the
  79120. ** statement and rerun it from the beginning.
  79121. */
  79122. case OP_Transaction: {
  79123. Btree *pBt;
  79124. int iMeta;
  79125. int iGen;
  79126. assert( p->bIsReader );
  79127. assert( p->readOnly==0 || pOp->p2==0 );
  79128. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  79129. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  79130. if( pOp->p2 && (db->flags & SQLITE_QueryOnly)!=0 ){
  79131. rc = SQLITE_READONLY;
  79132. goto abort_due_to_error;
  79133. }
  79134. pBt = db->aDb[pOp->p1].pBt;
  79135. if( pBt ){
  79136. rc = sqlite3BtreeBeginTrans(pBt, pOp->p2);
  79137. testcase( rc==SQLITE_BUSY_SNAPSHOT );
  79138. testcase( rc==SQLITE_BUSY_RECOVERY );
  79139. if( rc!=SQLITE_OK ){
  79140. if( (rc&0xff)==SQLITE_BUSY ){
  79141. p->pc = (int)(pOp - aOp);
  79142. p->rc = rc;
  79143. goto vdbe_return;
  79144. }
  79145. goto abort_due_to_error;
  79146. }
  79147. if( pOp->p2 && p->usesStmtJournal
  79148. && (db->autoCommit==0 || db->nVdbeRead>1)
  79149. ){
  79150. assert( sqlite3BtreeIsInTrans(pBt) );
  79151. if( p->iStatement==0 ){
  79152. assert( db->nStatement>=0 && db->nSavepoint>=0 );
  79153. db->nStatement++;
  79154. p->iStatement = db->nSavepoint + db->nStatement;
  79155. }
  79156. rc = sqlite3VtabSavepoint(db, SAVEPOINT_BEGIN, p->iStatement-1);
  79157. if( rc==SQLITE_OK ){
  79158. rc = sqlite3BtreeBeginStmt(pBt, p->iStatement);
  79159. }
  79160. /* Store the current value of the database handles deferred constraint
  79161. ** counter. If the statement transaction needs to be rolled back,
  79162. ** the value of this counter needs to be restored too. */
  79163. p->nStmtDefCons = db->nDeferredCons;
  79164. p->nStmtDefImmCons = db->nDeferredImmCons;
  79165. }
  79166. /* Gather the schema version number for checking:
  79167. ** IMPLEMENTATION-OF: R-03189-51135 As each SQL statement runs, the schema
  79168. ** version is checked to ensure that the schema has not changed since the
  79169. ** SQL statement was prepared.
  79170. */
  79171. sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&iMeta);
  79172. iGen = db->aDb[pOp->p1].pSchema->iGeneration;
  79173. }else{
  79174. iGen = iMeta = 0;
  79175. }
  79176. assert( pOp->p5==0 || pOp->p4type==P4_INT32 );
  79177. if( pOp->p5 && (iMeta!=pOp->p3 || iGen!=pOp->p4.i) ){
  79178. sqlite3DbFree(db, p->zErrMsg);
  79179. p->zErrMsg = sqlite3DbStrDup(db, "database schema has changed");
  79180. /* If the schema-cookie from the database file matches the cookie
  79181. ** stored with the in-memory representation of the schema, do
  79182. ** not reload the schema from the database file.
  79183. **
  79184. ** If virtual-tables are in use, this is not just an optimization.
  79185. ** Often, v-tables store their data in other SQLite tables, which
  79186. ** are queried from within xNext() and other v-table methods using
  79187. ** prepared queries. If such a query is out-of-date, we do not want to
  79188. ** discard the database schema, as the user code implementing the
  79189. ** v-table would have to be ready for the sqlite3_vtab structure itself
  79190. ** to be invalidated whenever sqlite3_step() is called from within
  79191. ** a v-table method.
  79192. */
  79193. if( db->aDb[pOp->p1].pSchema->schema_cookie!=iMeta ){
  79194. sqlite3ResetOneSchema(db, pOp->p1);
  79195. }
  79196. p->expired = 1;
  79197. rc = SQLITE_SCHEMA;
  79198. }
  79199. if( rc ) goto abort_due_to_error;
  79200. break;
  79201. }
  79202. /* Opcode: ReadCookie P1 P2 P3 * *
  79203. **
  79204. ** Read cookie number P3 from database P1 and write it into register P2.
  79205. ** P3==1 is the schema version. P3==2 is the database format.
  79206. ** P3==3 is the recommended pager cache size, and so forth. P1==0 is
  79207. ** the main database file and P1==1 is the database file used to store
  79208. ** temporary tables.
  79209. **
  79210. ** There must be a read-lock on the database (either a transaction
  79211. ** must be started or there must be an open cursor) before
  79212. ** executing this instruction.
  79213. */
  79214. case OP_ReadCookie: { /* out2 */
  79215. int iMeta;
  79216. int iDb;
  79217. int iCookie;
  79218. assert( p->bIsReader );
  79219. iDb = pOp->p1;
  79220. iCookie = pOp->p3;
  79221. assert( pOp->p3<SQLITE_N_BTREE_META );
  79222. assert( iDb>=0 && iDb<db->nDb );
  79223. assert( db->aDb[iDb].pBt!=0 );
  79224. assert( DbMaskTest(p->btreeMask, iDb) );
  79225. sqlite3BtreeGetMeta(db->aDb[iDb].pBt, iCookie, (u32 *)&iMeta);
  79226. pOut = out2Prerelease(p, pOp);
  79227. pOut->u.i = iMeta;
  79228. break;
  79229. }
  79230. /* Opcode: SetCookie P1 P2 P3 * *
  79231. **
  79232. ** Write the integer value P3 into cookie number P2 of database P1.
  79233. ** P2==1 is the schema version. P2==2 is the database format.
  79234. ** P2==3 is the recommended pager cache
  79235. ** size, and so forth. P1==0 is the main database file and P1==1 is the
  79236. ** database file used to store temporary tables.
  79237. **
  79238. ** A transaction must be started before executing this opcode.
  79239. */
  79240. case OP_SetCookie: {
  79241. Db *pDb;
  79242. assert( pOp->p2<SQLITE_N_BTREE_META );
  79243. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  79244. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  79245. assert( p->readOnly==0 );
  79246. pDb = &db->aDb[pOp->p1];
  79247. assert( pDb->pBt!=0 );
  79248. assert( sqlite3SchemaMutexHeld(db, pOp->p1, 0) );
  79249. /* See note about index shifting on OP_ReadCookie */
  79250. rc = sqlite3BtreeUpdateMeta(pDb->pBt, pOp->p2, pOp->p3);
  79251. if( pOp->p2==BTREE_SCHEMA_VERSION ){
  79252. /* When the schema cookie changes, record the new cookie internally */
  79253. pDb->pSchema->schema_cookie = pOp->p3;
  79254. db->mDbFlags |= DBFLAG_SchemaChange;
  79255. }else if( pOp->p2==BTREE_FILE_FORMAT ){
  79256. /* Record changes in the file format */
  79257. pDb->pSchema->file_format = pOp->p3;
  79258. }
  79259. if( pOp->p1==1 ){
  79260. /* Invalidate all prepared statements whenever the TEMP database
  79261. ** schema is changed. Ticket #1644 */
  79262. sqlite3ExpirePreparedStatements(db);
  79263. p->expired = 0;
  79264. }
  79265. if( rc ) goto abort_due_to_error;
  79266. break;
  79267. }
  79268. /* Opcode: OpenRead P1 P2 P3 P4 P5
  79269. ** Synopsis: root=P2 iDb=P3
  79270. **
  79271. ** Open a read-only cursor for the database table whose root page is
  79272. ** P2 in a database file. The database file is determined by P3.
  79273. ** P3==0 means the main database, P3==1 means the database used for
  79274. ** temporary tables, and P3>1 means used the corresponding attached
  79275. ** database. Give the new cursor an identifier of P1. The P1
  79276. ** values need not be contiguous but all P1 values should be small integers.
  79277. ** It is an error for P1 to be negative.
  79278. **
  79279. ** If P5!=0 then use the content of register P2 as the root page, not
  79280. ** the value of P2 itself.
  79281. **
  79282. ** There will be a read lock on the database whenever there is an
  79283. ** open cursor. If the database was unlocked prior to this instruction
  79284. ** then a read lock is acquired as part of this instruction. A read
  79285. ** lock allows other processes to read the database but prohibits
  79286. ** any other process from modifying the database. The read lock is
  79287. ** released when all cursors are closed. If this instruction attempts
  79288. ** to get a read lock but fails, the script terminates with an
  79289. ** SQLITE_BUSY error code.
  79290. **
  79291. ** The P4 value may be either an integer (P4_INT32) or a pointer to
  79292. ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
  79293. ** structure, then said structure defines the content and collating
  79294. ** sequence of the index being opened. Otherwise, if P4 is an integer
  79295. ** value, it is set to the number of columns in the table.
  79296. **
  79297. ** See also: OpenWrite, ReopenIdx
  79298. */
  79299. /* Opcode: ReopenIdx P1 P2 P3 P4 P5
  79300. ** Synopsis: root=P2 iDb=P3
  79301. **
  79302. ** The ReopenIdx opcode works exactly like ReadOpen except that it first
  79303. ** checks to see if the cursor on P1 is already open with a root page
  79304. ** number of P2 and if it is this opcode becomes a no-op. In other words,
  79305. ** if the cursor is already open, do not reopen it.
  79306. **
  79307. ** The ReopenIdx opcode may only be used with P5==0 and with P4 being
  79308. ** a P4_KEYINFO object. Furthermore, the P3 value must be the same as
  79309. ** every other ReopenIdx or OpenRead for the same cursor number.
  79310. **
  79311. ** See the OpenRead opcode documentation for additional information.
  79312. */
  79313. /* Opcode: OpenWrite P1 P2 P3 P4 P5
  79314. ** Synopsis: root=P2 iDb=P3
  79315. **
  79316. ** Open a read/write cursor named P1 on the table or index whose root
  79317. ** page is P2. Or if P5!=0 use the content of register P2 to find the
  79318. ** root page.
  79319. **
  79320. ** The P4 value may be either an integer (P4_INT32) or a pointer to
  79321. ** a KeyInfo structure (P4_KEYINFO). If it is a pointer to a KeyInfo
  79322. ** structure, then said structure defines the content and collating
  79323. ** sequence of the index being opened. Otherwise, if P4 is an integer
  79324. ** value, it is set to the number of columns in the table, or to the
  79325. ** largest index of any column of the table that is actually used.
  79326. **
  79327. ** This instruction works just like OpenRead except that it opens the cursor
  79328. ** in read/write mode. For a given table, there can be one or more read-only
  79329. ** cursors or a single read/write cursor but not both.
  79330. **
  79331. ** See also OpenRead.
  79332. */
  79333. case OP_ReopenIdx: {
  79334. int nField;
  79335. KeyInfo *pKeyInfo;
  79336. int p2;
  79337. int iDb;
  79338. int wrFlag;
  79339. Btree *pX;
  79340. VdbeCursor *pCur;
  79341. Db *pDb;
  79342. assert( pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
  79343. assert( pOp->p4type==P4_KEYINFO );
  79344. pCur = p->apCsr[pOp->p1];
  79345. if( pCur && pCur->pgnoRoot==(u32)pOp->p2 ){
  79346. assert( pCur->iDb==pOp->p3 ); /* Guaranteed by the code generator */
  79347. goto open_cursor_set_hints;
  79348. }
  79349. /* If the cursor is not currently open or is open on a different
  79350. ** index, then fall through into OP_OpenRead to force a reopen */
  79351. case OP_OpenRead:
  79352. case OP_OpenWrite:
  79353. assert( pOp->opcode==OP_OpenWrite || pOp->p5==0 || pOp->p5==OPFLAG_SEEKEQ );
  79354. assert( p->bIsReader );
  79355. assert( pOp->opcode==OP_OpenRead || pOp->opcode==OP_ReopenIdx
  79356. || p->readOnly==0 );
  79357. if( p->expired ){
  79358. rc = SQLITE_ABORT_ROLLBACK;
  79359. goto abort_due_to_error;
  79360. }
  79361. nField = 0;
  79362. pKeyInfo = 0;
  79363. p2 = pOp->p2;
  79364. iDb = pOp->p3;
  79365. assert( iDb>=0 && iDb<db->nDb );
  79366. assert( DbMaskTest(p->btreeMask, iDb) );
  79367. pDb = &db->aDb[iDb];
  79368. pX = pDb->pBt;
  79369. assert( pX!=0 );
  79370. if( pOp->opcode==OP_OpenWrite ){
  79371. assert( OPFLAG_FORDELETE==BTREE_FORDELETE );
  79372. wrFlag = BTREE_WRCSR | (pOp->p5 & OPFLAG_FORDELETE);
  79373. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  79374. if( pDb->pSchema->file_format < p->minWriteFileFormat ){
  79375. p->minWriteFileFormat = pDb->pSchema->file_format;
  79376. }
  79377. }else{
  79378. wrFlag = 0;
  79379. }
  79380. if( pOp->p5 & OPFLAG_P2ISREG ){
  79381. assert( p2>0 );
  79382. assert( p2<=(p->nMem+1 - p->nCursor) );
  79383. pIn2 = &aMem[p2];
  79384. assert( memIsValid(pIn2) );
  79385. assert( (pIn2->flags & MEM_Int)!=0 );
  79386. sqlite3VdbeMemIntegerify(pIn2);
  79387. p2 = (int)pIn2->u.i;
  79388. /* The p2 value always comes from a prior OP_CreateBtree opcode and
  79389. ** that opcode will always set the p2 value to 2 or more or else fail.
  79390. ** If there were a failure, the prepared statement would have halted
  79391. ** before reaching this instruction. */
  79392. assert( p2>=2 );
  79393. }
  79394. if( pOp->p4type==P4_KEYINFO ){
  79395. pKeyInfo = pOp->p4.pKeyInfo;
  79396. assert( pKeyInfo->enc==ENC(db) );
  79397. assert( pKeyInfo->db==db );
  79398. nField = pKeyInfo->nAllField;
  79399. }else if( pOp->p4type==P4_INT32 ){
  79400. nField = pOp->p4.i;
  79401. }
  79402. assert( pOp->p1>=0 );
  79403. assert( nField>=0 );
  79404. testcase( nField==0 ); /* Table with INTEGER PRIMARY KEY and nothing else */
  79405. pCur = allocateCursor(p, pOp->p1, nField, iDb, CURTYPE_BTREE);
  79406. if( pCur==0 ) goto no_mem;
  79407. pCur->nullRow = 1;
  79408. pCur->isOrdered = 1;
  79409. pCur->pgnoRoot = p2;
  79410. #ifdef SQLITE_DEBUG
  79411. pCur->wrFlag = wrFlag;
  79412. #endif
  79413. rc = sqlite3BtreeCursor(pX, p2, wrFlag, pKeyInfo, pCur->uc.pCursor);
  79414. pCur->pKeyInfo = pKeyInfo;
  79415. /* Set the VdbeCursor.isTable variable. Previous versions of
  79416. ** SQLite used to check if the root-page flags were sane at this point
  79417. ** and report database corruption if they were not, but this check has
  79418. ** since moved into the btree layer. */
  79419. pCur->isTable = pOp->p4type!=P4_KEYINFO;
  79420. open_cursor_set_hints:
  79421. assert( OPFLAG_BULKCSR==BTREE_BULKLOAD );
  79422. assert( OPFLAG_SEEKEQ==BTREE_SEEK_EQ );
  79423. testcase( pOp->p5 & OPFLAG_BULKCSR );
  79424. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  79425. testcase( pOp->p2 & OPFLAG_SEEKEQ );
  79426. #endif
  79427. sqlite3BtreeCursorHintFlags(pCur->uc.pCursor,
  79428. (pOp->p5 & (OPFLAG_BULKCSR|OPFLAG_SEEKEQ)));
  79429. if( rc ) goto abort_due_to_error;
  79430. break;
  79431. }
  79432. /* Opcode: OpenDup P1 P2 * * *
  79433. **
  79434. ** Open a new cursor P1 that points to the same ephemeral table as
  79435. ** cursor P2. The P2 cursor must have been opened by a prior OP_OpenEphemeral
  79436. ** opcode. Only ephemeral cursors may be duplicated.
  79437. **
  79438. ** Duplicate ephemeral cursors are used for self-joins of materialized views.
  79439. */
  79440. case OP_OpenDup: {
  79441. VdbeCursor *pOrig; /* The original cursor to be duplicated */
  79442. VdbeCursor *pCx; /* The new cursor */
  79443. pOrig = p->apCsr[pOp->p2];
  79444. assert( pOrig->pBtx!=0 ); /* Only ephemeral cursors can be duplicated */
  79445. pCx = allocateCursor(p, pOp->p1, pOrig->nField, -1, CURTYPE_BTREE);
  79446. if( pCx==0 ) goto no_mem;
  79447. pCx->nullRow = 1;
  79448. pCx->isEphemeral = 1;
  79449. pCx->pKeyInfo = pOrig->pKeyInfo;
  79450. pCx->isTable = pOrig->isTable;
  79451. rc = sqlite3BtreeCursor(pOrig->pBtx, MASTER_ROOT, BTREE_WRCSR,
  79452. pCx->pKeyInfo, pCx->uc.pCursor);
  79453. /* The sqlite3BtreeCursor() routine can only fail for the first cursor
  79454. ** opened for a database. Since there is already an open cursor when this
  79455. ** opcode is run, the sqlite3BtreeCursor() cannot fail */
  79456. assert( rc==SQLITE_OK );
  79457. break;
  79458. }
  79459. /* Opcode: OpenEphemeral P1 P2 * P4 P5
  79460. ** Synopsis: nColumn=P2
  79461. **
  79462. ** Open a new cursor P1 to a transient table.
  79463. ** The cursor is always opened read/write even if
  79464. ** the main database is read-only. The ephemeral
  79465. ** table is deleted automatically when the cursor is closed.
  79466. **
  79467. ** P2 is the number of columns in the ephemeral table.
  79468. ** The cursor points to a BTree table if P4==0 and to a BTree index
  79469. ** if P4 is not 0. If P4 is not NULL, it points to a KeyInfo structure
  79470. ** that defines the format of keys in the index.
  79471. **
  79472. ** The P5 parameter can be a mask of the BTREE_* flags defined
  79473. ** in btree.h. These flags control aspects of the operation of
  79474. ** the btree. The BTREE_OMIT_JOURNAL and BTREE_SINGLE flags are
  79475. ** added automatically.
  79476. */
  79477. /* Opcode: OpenAutoindex P1 P2 * P4 *
  79478. ** Synopsis: nColumn=P2
  79479. **
  79480. ** This opcode works the same as OP_OpenEphemeral. It has a
  79481. ** different name to distinguish its use. Tables created using
  79482. ** by this opcode will be used for automatically created transient
  79483. ** indices in joins.
  79484. */
  79485. case OP_OpenAutoindex:
  79486. case OP_OpenEphemeral: {
  79487. VdbeCursor *pCx;
  79488. KeyInfo *pKeyInfo;
  79489. static const int vfsFlags =
  79490. SQLITE_OPEN_READWRITE |
  79491. SQLITE_OPEN_CREATE |
  79492. SQLITE_OPEN_EXCLUSIVE |
  79493. SQLITE_OPEN_DELETEONCLOSE |
  79494. SQLITE_OPEN_TRANSIENT_DB;
  79495. assert( pOp->p1>=0 );
  79496. assert( pOp->p2>=0 );
  79497. pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_BTREE);
  79498. if( pCx==0 ) goto no_mem;
  79499. pCx->nullRow = 1;
  79500. pCx->isEphemeral = 1;
  79501. rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pCx->pBtx,
  79502. BTREE_OMIT_JOURNAL | BTREE_SINGLE | pOp->p5, vfsFlags);
  79503. if( rc==SQLITE_OK ){
  79504. rc = sqlite3BtreeBeginTrans(pCx->pBtx, 1);
  79505. }
  79506. if( rc==SQLITE_OK ){
  79507. /* If a transient index is required, create it by calling
  79508. ** sqlite3BtreeCreateTable() with the BTREE_BLOBKEY flag before
  79509. ** opening it. If a transient table is required, just use the
  79510. ** automatically created table with root-page 1 (an BLOB_INTKEY table).
  79511. */
  79512. if( (pCx->pKeyInfo = pKeyInfo = pOp->p4.pKeyInfo)!=0 ){
  79513. int pgno;
  79514. assert( pOp->p4type==P4_KEYINFO );
  79515. rc = sqlite3BtreeCreateTable(pCx->pBtx, &pgno, BTREE_BLOBKEY | pOp->p5);
  79516. if( rc==SQLITE_OK ){
  79517. assert( pgno==MASTER_ROOT+1 );
  79518. assert( pKeyInfo->db==db );
  79519. assert( pKeyInfo->enc==ENC(db) );
  79520. rc = sqlite3BtreeCursor(pCx->pBtx, pgno, BTREE_WRCSR,
  79521. pKeyInfo, pCx->uc.pCursor);
  79522. }
  79523. pCx->isTable = 0;
  79524. }else{
  79525. rc = sqlite3BtreeCursor(pCx->pBtx, MASTER_ROOT, BTREE_WRCSR,
  79526. 0, pCx->uc.pCursor);
  79527. pCx->isTable = 1;
  79528. }
  79529. }
  79530. if( rc ) goto abort_due_to_error;
  79531. pCx->isOrdered = (pOp->p5!=BTREE_UNORDERED);
  79532. break;
  79533. }
  79534. /* Opcode: SorterOpen P1 P2 P3 P4 *
  79535. **
  79536. ** This opcode works like OP_OpenEphemeral except that it opens
  79537. ** a transient index that is specifically designed to sort large
  79538. ** tables using an external merge-sort algorithm.
  79539. **
  79540. ** If argument P3 is non-zero, then it indicates that the sorter may
  79541. ** assume that a stable sort considering the first P3 fields of each
  79542. ** key is sufficient to produce the required results.
  79543. */
  79544. case OP_SorterOpen: {
  79545. VdbeCursor *pCx;
  79546. assert( pOp->p1>=0 );
  79547. assert( pOp->p2>=0 );
  79548. pCx = allocateCursor(p, pOp->p1, pOp->p2, -1, CURTYPE_SORTER);
  79549. if( pCx==0 ) goto no_mem;
  79550. pCx->pKeyInfo = pOp->p4.pKeyInfo;
  79551. assert( pCx->pKeyInfo->db==db );
  79552. assert( pCx->pKeyInfo->enc==ENC(db) );
  79553. rc = sqlite3VdbeSorterInit(db, pOp->p3, pCx);
  79554. if( rc ) goto abort_due_to_error;
  79555. break;
  79556. }
  79557. /* Opcode: SequenceTest P1 P2 * * *
  79558. ** Synopsis: if( cursor[P1].ctr++ ) pc = P2
  79559. **
  79560. ** P1 is a sorter cursor. If the sequence counter is currently zero, jump
  79561. ** to P2. Regardless of whether or not the jump is taken, increment the
  79562. ** the sequence value.
  79563. */
  79564. case OP_SequenceTest: {
  79565. VdbeCursor *pC;
  79566. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  79567. pC = p->apCsr[pOp->p1];
  79568. assert( isSorter(pC) );
  79569. if( (pC->seqCount++)==0 ){
  79570. goto jump_to_p2;
  79571. }
  79572. break;
  79573. }
  79574. /* Opcode: OpenPseudo P1 P2 P3 * *
  79575. ** Synopsis: P3 columns in r[P2]
  79576. **
  79577. ** Open a new cursor that points to a fake table that contains a single
  79578. ** row of data. The content of that one row is the content of memory
  79579. ** register P2. In other words, cursor P1 becomes an alias for the
  79580. ** MEM_Blob content contained in register P2.
  79581. **
  79582. ** A pseudo-table created by this opcode is used to hold a single
  79583. ** row output from the sorter so that the row can be decomposed into
  79584. ** individual columns using the OP_Column opcode. The OP_Column opcode
  79585. ** is the only cursor opcode that works with a pseudo-table.
  79586. **
  79587. ** P3 is the number of fields in the records that will be stored by
  79588. ** the pseudo-table.
  79589. */
  79590. case OP_OpenPseudo: {
  79591. VdbeCursor *pCx;
  79592. assert( pOp->p1>=0 );
  79593. assert( pOp->p3>=0 );
  79594. pCx = allocateCursor(p, pOp->p1, pOp->p3, -1, CURTYPE_PSEUDO);
  79595. if( pCx==0 ) goto no_mem;
  79596. pCx->nullRow = 1;
  79597. pCx->seekResult = pOp->p2;
  79598. pCx->isTable = 1;
  79599. /* Give this pseudo-cursor a fake BtCursor pointer so that pCx
  79600. ** can be safely passed to sqlite3VdbeCursorMoveto(). This avoids a test
  79601. ** for pCx->eCurType==CURTYPE_BTREE inside of sqlite3VdbeCursorMoveto()
  79602. ** which is a performance optimization */
  79603. pCx->uc.pCursor = sqlite3BtreeFakeValidCursor();
  79604. assert( pOp->p5==0 );
  79605. break;
  79606. }
  79607. /* Opcode: Close P1 * * * *
  79608. **
  79609. ** Close a cursor previously opened as P1. If P1 is not
  79610. ** currently open, this instruction is a no-op.
  79611. */
  79612. case OP_Close: {
  79613. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  79614. sqlite3VdbeFreeCursor(p, p->apCsr[pOp->p1]);
  79615. p->apCsr[pOp->p1] = 0;
  79616. break;
  79617. }
  79618. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  79619. /* Opcode: ColumnsUsed P1 * * P4 *
  79620. **
  79621. ** This opcode (which only exists if SQLite was compiled with
  79622. ** SQLITE_ENABLE_COLUMN_USED_MASK) identifies which columns of the
  79623. ** table or index for cursor P1 are used. P4 is a 64-bit integer
  79624. ** (P4_INT64) in which the first 63 bits are one for each of the
  79625. ** first 63 columns of the table or index that are actually used
  79626. ** by the cursor. The high-order bit is set if any column after
  79627. ** the 64th is used.
  79628. */
  79629. case OP_ColumnsUsed: {
  79630. VdbeCursor *pC;
  79631. pC = p->apCsr[pOp->p1];
  79632. assert( pC->eCurType==CURTYPE_BTREE );
  79633. pC->maskUsed = *(u64*)pOp->p4.pI64;
  79634. break;
  79635. }
  79636. #endif
  79637. /* Opcode: SeekGE P1 P2 P3 P4 *
  79638. ** Synopsis: key=r[P3@P4]
  79639. **
  79640. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  79641. ** use the value in register P3 as the key. If cursor P1 refers
  79642. ** to an SQL index, then P3 is the first in an array of P4 registers
  79643. ** that are used as an unpacked index key.
  79644. **
  79645. ** Reposition cursor P1 so that it points to the smallest entry that
  79646. ** is greater than or equal to the key value. If there are no records
  79647. ** greater than or equal to the key and P2 is not zero, then jump to P2.
  79648. **
  79649. ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
  79650. ** opcode will always land on a record that equally equals the key, or
  79651. ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
  79652. ** opcode must be followed by an IdxLE opcode with the same arguments.
  79653. ** The IdxLE opcode will be skipped if this opcode succeeds, but the
  79654. ** IdxLE opcode will be used on subsequent loop iterations.
  79655. **
  79656. ** This opcode leaves the cursor configured to move in forward order,
  79657. ** from the beginning toward the end. In other words, the cursor is
  79658. ** configured to use Next, not Prev.
  79659. **
  79660. ** See also: Found, NotFound, SeekLt, SeekGt, SeekLe
  79661. */
  79662. /* Opcode: SeekGT P1 P2 P3 P4 *
  79663. ** Synopsis: key=r[P3@P4]
  79664. **
  79665. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  79666. ** use the value in register P3 as a key. If cursor P1 refers
  79667. ** to an SQL index, then P3 is the first in an array of P4 registers
  79668. ** that are used as an unpacked index key.
  79669. **
  79670. ** Reposition cursor P1 so that it points to the smallest entry that
  79671. ** is greater than the key value. If there are no records greater than
  79672. ** the key and P2 is not zero, then jump to P2.
  79673. **
  79674. ** This opcode leaves the cursor configured to move in forward order,
  79675. ** from the beginning toward the end. In other words, the cursor is
  79676. ** configured to use Next, not Prev.
  79677. **
  79678. ** See also: Found, NotFound, SeekLt, SeekGe, SeekLe
  79679. */
  79680. /* Opcode: SeekLT P1 P2 P3 P4 *
  79681. ** Synopsis: key=r[P3@P4]
  79682. **
  79683. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  79684. ** use the value in register P3 as a key. If cursor P1 refers
  79685. ** to an SQL index, then P3 is the first in an array of P4 registers
  79686. ** that are used as an unpacked index key.
  79687. **
  79688. ** Reposition cursor P1 so that it points to the largest entry that
  79689. ** is less than the key value. If there are no records less than
  79690. ** the key and P2 is not zero, then jump to P2.
  79691. **
  79692. ** This opcode leaves the cursor configured to move in reverse order,
  79693. ** from the end toward the beginning. In other words, the cursor is
  79694. ** configured to use Prev, not Next.
  79695. **
  79696. ** See also: Found, NotFound, SeekGt, SeekGe, SeekLe
  79697. */
  79698. /* Opcode: SeekLE P1 P2 P3 P4 *
  79699. ** Synopsis: key=r[P3@P4]
  79700. **
  79701. ** If cursor P1 refers to an SQL table (B-Tree that uses integer keys),
  79702. ** use the value in register P3 as a key. If cursor P1 refers
  79703. ** to an SQL index, then P3 is the first in an array of P4 registers
  79704. ** that are used as an unpacked index key.
  79705. **
  79706. ** Reposition cursor P1 so that it points to the largest entry that
  79707. ** is less than or equal to the key value. If there are no records
  79708. ** less than or equal to the key and P2 is not zero, then jump to P2.
  79709. **
  79710. ** This opcode leaves the cursor configured to move in reverse order,
  79711. ** from the end toward the beginning. In other words, the cursor is
  79712. ** configured to use Prev, not Next.
  79713. **
  79714. ** If the cursor P1 was opened using the OPFLAG_SEEKEQ flag, then this
  79715. ** opcode will always land on a record that equally equals the key, or
  79716. ** else jump immediately to P2. When the cursor is OPFLAG_SEEKEQ, this
  79717. ** opcode must be followed by an IdxGE opcode with the same arguments.
  79718. ** The IdxGE opcode will be skipped if this opcode succeeds, but the
  79719. ** IdxGE opcode will be used on subsequent loop iterations.
  79720. **
  79721. ** See also: Found, NotFound, SeekGt, SeekGe, SeekLt
  79722. */
  79723. case OP_SeekLT: /* jump, in3 */
  79724. case OP_SeekLE: /* jump, in3 */
  79725. case OP_SeekGE: /* jump, in3 */
  79726. case OP_SeekGT: { /* jump, in3 */
  79727. int res; /* Comparison result */
  79728. int oc; /* Opcode */
  79729. VdbeCursor *pC; /* The cursor to seek */
  79730. UnpackedRecord r; /* The key to seek for */
  79731. int nField; /* Number of columns or fields in the key */
  79732. i64 iKey; /* The rowid we are to seek to */
  79733. int eqOnly; /* Only interested in == results */
  79734. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  79735. assert( pOp->p2!=0 );
  79736. pC = p->apCsr[pOp->p1];
  79737. assert( pC!=0 );
  79738. assert( pC->eCurType==CURTYPE_BTREE );
  79739. assert( OP_SeekLE == OP_SeekLT+1 );
  79740. assert( OP_SeekGE == OP_SeekLT+2 );
  79741. assert( OP_SeekGT == OP_SeekLT+3 );
  79742. assert( pC->isOrdered );
  79743. assert( pC->uc.pCursor!=0 );
  79744. oc = pOp->opcode;
  79745. eqOnly = 0;
  79746. pC->nullRow = 0;
  79747. #ifdef SQLITE_DEBUG
  79748. pC->seekOp = pOp->opcode;
  79749. #endif
  79750. if( pC->isTable ){
  79751. /* The BTREE_SEEK_EQ flag is only set on index cursors */
  79752. assert( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ)==0
  79753. || CORRUPT_DB );
  79754. /* The input value in P3 might be of any type: integer, real, string,
  79755. ** blob, or NULL. But it needs to be an integer before we can do
  79756. ** the seek, so convert it. */
  79757. pIn3 = &aMem[pOp->p3];
  79758. if( (pIn3->flags & (MEM_Int|MEM_Real|MEM_Str))==MEM_Str ){
  79759. applyNumericAffinity(pIn3, 0);
  79760. }
  79761. iKey = sqlite3VdbeIntValue(pIn3);
  79762. /* If the P3 value could not be converted into an integer without
  79763. ** loss of information, then special processing is required... */
  79764. if( (pIn3->flags & MEM_Int)==0 ){
  79765. if( (pIn3->flags & MEM_Real)==0 ){
  79766. /* If the P3 value cannot be converted into any kind of a number,
  79767. ** then the seek is not possible, so jump to P2 */
  79768. VdbeBranchTaken(1,2); goto jump_to_p2;
  79769. break;
  79770. }
  79771. /* If the approximation iKey is larger than the actual real search
  79772. ** term, substitute >= for > and < for <=. e.g. if the search term
  79773. ** is 4.9 and the integer approximation 5:
  79774. **
  79775. ** (x > 4.9) -> (x >= 5)
  79776. ** (x <= 4.9) -> (x < 5)
  79777. */
  79778. if( pIn3->u.r<(double)iKey ){
  79779. assert( OP_SeekGE==(OP_SeekGT-1) );
  79780. assert( OP_SeekLT==(OP_SeekLE-1) );
  79781. assert( (OP_SeekLE & 0x0001)==(OP_SeekGT & 0x0001) );
  79782. if( (oc & 0x0001)==(OP_SeekGT & 0x0001) ) oc--;
  79783. }
  79784. /* If the approximation iKey is smaller than the actual real search
  79785. ** term, substitute <= for < and > for >=. */
  79786. else if( pIn3->u.r>(double)iKey ){
  79787. assert( OP_SeekLE==(OP_SeekLT+1) );
  79788. assert( OP_SeekGT==(OP_SeekGE+1) );
  79789. assert( (OP_SeekLT & 0x0001)==(OP_SeekGE & 0x0001) );
  79790. if( (oc & 0x0001)==(OP_SeekLT & 0x0001) ) oc++;
  79791. }
  79792. }
  79793. rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)iKey, 0, &res);
  79794. pC->movetoTarget = iKey; /* Used by OP_Delete */
  79795. if( rc!=SQLITE_OK ){
  79796. goto abort_due_to_error;
  79797. }
  79798. }else{
  79799. /* For a cursor with the BTREE_SEEK_EQ hint, only the OP_SeekGE and
  79800. ** OP_SeekLE opcodes are allowed, and these must be immediately followed
  79801. ** by an OP_IdxGT or OP_IdxLT opcode, respectively, with the same key.
  79802. */
  79803. if( sqlite3BtreeCursorHasHint(pC->uc.pCursor, BTREE_SEEK_EQ) ){
  79804. eqOnly = 1;
  79805. assert( pOp->opcode==OP_SeekGE || pOp->opcode==OP_SeekLE );
  79806. assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
  79807. assert( pOp[1].p1==pOp[0].p1 );
  79808. assert( pOp[1].p2==pOp[0].p2 );
  79809. assert( pOp[1].p3==pOp[0].p3 );
  79810. assert( pOp[1].p4.i==pOp[0].p4.i );
  79811. }
  79812. nField = pOp->p4.i;
  79813. assert( pOp->p4type==P4_INT32 );
  79814. assert( nField>0 );
  79815. r.pKeyInfo = pC->pKeyInfo;
  79816. r.nField = (u16)nField;
  79817. /* The next line of code computes as follows, only faster:
  79818. ** if( oc==OP_SeekGT || oc==OP_SeekLE ){
  79819. ** r.default_rc = -1;
  79820. ** }else{
  79821. ** r.default_rc = +1;
  79822. ** }
  79823. */
  79824. r.default_rc = ((1 & (oc - OP_SeekLT)) ? -1 : +1);
  79825. assert( oc!=OP_SeekGT || r.default_rc==-1 );
  79826. assert( oc!=OP_SeekLE || r.default_rc==-1 );
  79827. assert( oc!=OP_SeekGE || r.default_rc==+1 );
  79828. assert( oc!=OP_SeekLT || r.default_rc==+1 );
  79829. r.aMem = &aMem[pOp->p3];
  79830. #ifdef SQLITE_DEBUG
  79831. { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
  79832. #endif
  79833. r.eqSeen = 0;
  79834. rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, &r, 0, 0, &res);
  79835. if( rc!=SQLITE_OK ){
  79836. goto abort_due_to_error;
  79837. }
  79838. if( eqOnly && r.eqSeen==0 ){
  79839. assert( res!=0 );
  79840. goto seek_not_found;
  79841. }
  79842. }
  79843. pC->deferredMoveto = 0;
  79844. pC->cacheStatus = CACHE_STALE;
  79845. #ifdef SQLITE_TEST
  79846. sqlite3_search_count++;
  79847. #endif
  79848. if( oc>=OP_SeekGE ){ assert( oc==OP_SeekGE || oc==OP_SeekGT );
  79849. if( res<0 || (res==0 && oc==OP_SeekGT) ){
  79850. res = 0;
  79851. rc = sqlite3BtreeNext(pC->uc.pCursor, 0);
  79852. if( rc!=SQLITE_OK ){
  79853. if( rc==SQLITE_DONE ){
  79854. rc = SQLITE_OK;
  79855. res = 1;
  79856. }else{
  79857. goto abort_due_to_error;
  79858. }
  79859. }
  79860. }else{
  79861. res = 0;
  79862. }
  79863. }else{
  79864. assert( oc==OP_SeekLT || oc==OP_SeekLE );
  79865. if( res>0 || (res==0 && oc==OP_SeekLT) ){
  79866. res = 0;
  79867. rc = sqlite3BtreePrevious(pC->uc.pCursor, 0);
  79868. if( rc!=SQLITE_OK ){
  79869. if( rc==SQLITE_DONE ){
  79870. rc = SQLITE_OK;
  79871. res = 1;
  79872. }else{
  79873. goto abort_due_to_error;
  79874. }
  79875. }
  79876. }else{
  79877. /* res might be negative because the table is empty. Check to
  79878. ** see if this is the case.
  79879. */
  79880. res = sqlite3BtreeEof(pC->uc.pCursor);
  79881. }
  79882. }
  79883. seek_not_found:
  79884. assert( pOp->p2>0 );
  79885. VdbeBranchTaken(res!=0,2);
  79886. if( res ){
  79887. goto jump_to_p2;
  79888. }else if( eqOnly ){
  79889. assert( pOp[1].opcode==OP_IdxLT || pOp[1].opcode==OP_IdxGT );
  79890. pOp++; /* Skip the OP_IdxLt or OP_IdxGT that follows */
  79891. }
  79892. break;
  79893. }
  79894. /* Opcode: Found P1 P2 P3 P4 *
  79895. ** Synopsis: key=r[P3@P4]
  79896. **
  79897. ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
  79898. ** P4>0 then register P3 is the first of P4 registers that form an unpacked
  79899. ** record.
  79900. **
  79901. ** Cursor P1 is on an index btree. If the record identified by P3 and P4
  79902. ** is a prefix of any entry in P1 then a jump is made to P2 and
  79903. ** P1 is left pointing at the matching entry.
  79904. **
  79905. ** This operation leaves the cursor in a state where it can be
  79906. ** advanced in the forward direction. The Next instruction will work,
  79907. ** but not the Prev instruction.
  79908. **
  79909. ** See also: NotFound, NoConflict, NotExists. SeekGe
  79910. */
  79911. /* Opcode: NotFound P1 P2 P3 P4 *
  79912. ** Synopsis: key=r[P3@P4]
  79913. **
  79914. ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
  79915. ** P4>0 then register P3 is the first of P4 registers that form an unpacked
  79916. ** record.
  79917. **
  79918. ** Cursor P1 is on an index btree. If the record identified by P3 and P4
  79919. ** is not the prefix of any entry in P1 then a jump is made to P2. If P1
  79920. ** does contain an entry whose prefix matches the P3/P4 record then control
  79921. ** falls through to the next instruction and P1 is left pointing at the
  79922. ** matching entry.
  79923. **
  79924. ** This operation leaves the cursor in a state where it cannot be
  79925. ** advanced in either direction. In other words, the Next and Prev
  79926. ** opcodes do not work after this operation.
  79927. **
  79928. ** See also: Found, NotExists, NoConflict
  79929. */
  79930. /* Opcode: NoConflict P1 P2 P3 P4 *
  79931. ** Synopsis: key=r[P3@P4]
  79932. **
  79933. ** If P4==0 then register P3 holds a blob constructed by MakeRecord. If
  79934. ** P4>0 then register P3 is the first of P4 registers that form an unpacked
  79935. ** record.
  79936. **
  79937. ** Cursor P1 is on an index btree. If the record identified by P3 and P4
  79938. ** contains any NULL value, jump immediately to P2. If all terms of the
  79939. ** record are not-NULL then a check is done to determine if any row in the
  79940. ** P1 index btree has a matching key prefix. If there are no matches, jump
  79941. ** immediately to P2. If there is a match, fall through and leave the P1
  79942. ** cursor pointing to the matching row.
  79943. **
  79944. ** This opcode is similar to OP_NotFound with the exceptions that the
  79945. ** branch is always taken if any part of the search key input is NULL.
  79946. **
  79947. ** This operation leaves the cursor in a state where it cannot be
  79948. ** advanced in either direction. In other words, the Next and Prev
  79949. ** opcodes do not work after this operation.
  79950. **
  79951. ** See also: NotFound, Found, NotExists
  79952. */
  79953. case OP_NoConflict: /* jump, in3 */
  79954. case OP_NotFound: /* jump, in3 */
  79955. case OP_Found: { /* jump, in3 */
  79956. int alreadyExists;
  79957. int takeJump;
  79958. int ii;
  79959. VdbeCursor *pC;
  79960. int res;
  79961. UnpackedRecord *pFree;
  79962. UnpackedRecord *pIdxKey;
  79963. UnpackedRecord r;
  79964. #ifdef SQLITE_TEST
  79965. if( pOp->opcode!=OP_NoConflict ) sqlite3_found_count++;
  79966. #endif
  79967. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  79968. assert( pOp->p4type==P4_INT32 );
  79969. pC = p->apCsr[pOp->p1];
  79970. assert( pC!=0 );
  79971. #ifdef SQLITE_DEBUG
  79972. pC->seekOp = pOp->opcode;
  79973. #endif
  79974. pIn3 = &aMem[pOp->p3];
  79975. assert( pC->eCurType==CURTYPE_BTREE );
  79976. assert( pC->uc.pCursor!=0 );
  79977. assert( pC->isTable==0 );
  79978. if( pOp->p4.i>0 ){
  79979. r.pKeyInfo = pC->pKeyInfo;
  79980. r.nField = (u16)pOp->p4.i;
  79981. r.aMem = pIn3;
  79982. #ifdef SQLITE_DEBUG
  79983. for(ii=0; ii<r.nField; ii++){
  79984. assert( memIsValid(&r.aMem[ii]) );
  79985. assert( (r.aMem[ii].flags & MEM_Zero)==0 || r.aMem[ii].n==0 );
  79986. if( ii ) REGISTER_TRACE(pOp->p3+ii, &r.aMem[ii]);
  79987. }
  79988. #endif
  79989. pIdxKey = &r;
  79990. pFree = 0;
  79991. }else{
  79992. assert( pIn3->flags & MEM_Blob );
  79993. rc = ExpandBlob(pIn3);
  79994. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  79995. if( rc ) goto no_mem;
  79996. pFree = pIdxKey = sqlite3VdbeAllocUnpackedRecord(pC->pKeyInfo);
  79997. if( pIdxKey==0 ) goto no_mem;
  79998. sqlite3VdbeRecordUnpack(pC->pKeyInfo, pIn3->n, pIn3->z, pIdxKey);
  79999. }
  80000. pIdxKey->default_rc = 0;
  80001. takeJump = 0;
  80002. if( pOp->opcode==OP_NoConflict ){
  80003. /* For the OP_NoConflict opcode, take the jump if any of the
  80004. ** input fields are NULL, since any key with a NULL will not
  80005. ** conflict */
  80006. for(ii=0; ii<pIdxKey->nField; ii++){
  80007. if( pIdxKey->aMem[ii].flags & MEM_Null ){
  80008. takeJump = 1;
  80009. break;
  80010. }
  80011. }
  80012. }
  80013. rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, pIdxKey, 0, 0, &res);
  80014. if( pFree ) sqlite3DbFreeNN(db, pFree);
  80015. if( rc!=SQLITE_OK ){
  80016. goto abort_due_to_error;
  80017. }
  80018. pC->seekResult = res;
  80019. alreadyExists = (res==0);
  80020. pC->nullRow = 1-alreadyExists;
  80021. pC->deferredMoveto = 0;
  80022. pC->cacheStatus = CACHE_STALE;
  80023. if( pOp->opcode==OP_Found ){
  80024. VdbeBranchTaken(alreadyExists!=0,2);
  80025. if( alreadyExists ) goto jump_to_p2;
  80026. }else{
  80027. VdbeBranchTaken(takeJump||alreadyExists==0,2);
  80028. if( takeJump || !alreadyExists ) goto jump_to_p2;
  80029. }
  80030. break;
  80031. }
  80032. /* Opcode: SeekRowid P1 P2 P3 * *
  80033. ** Synopsis: intkey=r[P3]
  80034. **
  80035. ** P1 is the index of a cursor open on an SQL table btree (with integer
  80036. ** keys). If register P3 does not contain an integer or if P1 does not
  80037. ** contain a record with rowid P3 then jump immediately to P2.
  80038. ** Or, if P2 is 0, raise an SQLITE_CORRUPT error. If P1 does contain
  80039. ** a record with rowid P3 then
  80040. ** leave the cursor pointing at that record and fall through to the next
  80041. ** instruction.
  80042. **
  80043. ** The OP_NotExists opcode performs the same operation, but with OP_NotExists
  80044. ** the P3 register must be guaranteed to contain an integer value. With this
  80045. ** opcode, register P3 might not contain an integer.
  80046. **
  80047. ** The OP_NotFound opcode performs the same operation on index btrees
  80048. ** (with arbitrary multi-value keys).
  80049. **
  80050. ** This opcode leaves the cursor in a state where it cannot be advanced
  80051. ** in either direction. In other words, the Next and Prev opcodes will
  80052. ** not work following this opcode.
  80053. **
  80054. ** See also: Found, NotFound, NoConflict, SeekRowid
  80055. */
  80056. /* Opcode: NotExists P1 P2 P3 * *
  80057. ** Synopsis: intkey=r[P3]
  80058. **
  80059. ** P1 is the index of a cursor open on an SQL table btree (with integer
  80060. ** keys). P3 is an integer rowid. If P1 does not contain a record with
  80061. ** rowid P3 then jump immediately to P2. Or, if P2 is 0, raise an
  80062. ** SQLITE_CORRUPT error. If P1 does contain a record with rowid P3 then
  80063. ** leave the cursor pointing at that record and fall through to the next
  80064. ** instruction.
  80065. **
  80066. ** The OP_SeekRowid opcode performs the same operation but also allows the
  80067. ** P3 register to contain a non-integer value, in which case the jump is
  80068. ** always taken. This opcode requires that P3 always contain an integer.
  80069. **
  80070. ** The OP_NotFound opcode performs the same operation on index btrees
  80071. ** (with arbitrary multi-value keys).
  80072. **
  80073. ** This opcode leaves the cursor in a state where it cannot be advanced
  80074. ** in either direction. In other words, the Next and Prev opcodes will
  80075. ** not work following this opcode.
  80076. **
  80077. ** See also: Found, NotFound, NoConflict, SeekRowid
  80078. */
  80079. case OP_SeekRowid: { /* jump, in3 */
  80080. VdbeCursor *pC;
  80081. BtCursor *pCrsr;
  80082. int res;
  80083. u64 iKey;
  80084. pIn3 = &aMem[pOp->p3];
  80085. if( (pIn3->flags & MEM_Int)==0 ){
  80086. applyAffinity(pIn3, SQLITE_AFF_NUMERIC, encoding);
  80087. if( (pIn3->flags & MEM_Int)==0 ) goto jump_to_p2;
  80088. }
  80089. /* Fall through into OP_NotExists */
  80090. case OP_NotExists: /* jump, in3 */
  80091. pIn3 = &aMem[pOp->p3];
  80092. assert( pIn3->flags & MEM_Int );
  80093. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80094. pC = p->apCsr[pOp->p1];
  80095. assert( pC!=0 );
  80096. #ifdef SQLITE_DEBUG
  80097. pC->seekOp = 0;
  80098. #endif
  80099. assert( pC->isTable );
  80100. assert( pC->eCurType==CURTYPE_BTREE );
  80101. pCrsr = pC->uc.pCursor;
  80102. assert( pCrsr!=0 );
  80103. res = 0;
  80104. iKey = pIn3->u.i;
  80105. rc = sqlite3BtreeMovetoUnpacked(pCrsr, 0, iKey, 0, &res);
  80106. assert( rc==SQLITE_OK || res==0 );
  80107. pC->movetoTarget = iKey; /* Used by OP_Delete */
  80108. pC->nullRow = 0;
  80109. pC->cacheStatus = CACHE_STALE;
  80110. pC->deferredMoveto = 0;
  80111. VdbeBranchTaken(res!=0,2);
  80112. pC->seekResult = res;
  80113. if( res!=0 ){
  80114. assert( rc==SQLITE_OK );
  80115. if( pOp->p2==0 ){
  80116. rc = SQLITE_CORRUPT_BKPT;
  80117. }else{
  80118. goto jump_to_p2;
  80119. }
  80120. }
  80121. if( rc ) goto abort_due_to_error;
  80122. break;
  80123. }
  80124. /* Opcode: Sequence P1 P2 * * *
  80125. ** Synopsis: r[P2]=cursor[P1].ctr++
  80126. **
  80127. ** Find the next available sequence number for cursor P1.
  80128. ** Write the sequence number into register P2.
  80129. ** The sequence number on the cursor is incremented after this
  80130. ** instruction.
  80131. */
  80132. case OP_Sequence: { /* out2 */
  80133. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80134. assert( p->apCsr[pOp->p1]!=0 );
  80135. assert( p->apCsr[pOp->p1]->eCurType!=CURTYPE_VTAB );
  80136. pOut = out2Prerelease(p, pOp);
  80137. pOut->u.i = p->apCsr[pOp->p1]->seqCount++;
  80138. break;
  80139. }
  80140. /* Opcode: NewRowid P1 P2 P3 * *
  80141. ** Synopsis: r[P2]=rowid
  80142. **
  80143. ** Get a new integer record number (a.k.a "rowid") used as the key to a table.
  80144. ** The record number is not previously used as a key in the database
  80145. ** table that cursor P1 points to. The new record number is written
  80146. ** written to register P2.
  80147. **
  80148. ** If P3>0 then P3 is a register in the root frame of this VDBE that holds
  80149. ** the largest previously generated record number. No new record numbers are
  80150. ** allowed to be less than this value. When this value reaches its maximum,
  80151. ** an SQLITE_FULL error is generated. The P3 register is updated with the '
  80152. ** generated record number. This P3 mechanism is used to help implement the
  80153. ** AUTOINCREMENT feature.
  80154. */
  80155. case OP_NewRowid: { /* out2 */
  80156. i64 v; /* The new rowid */
  80157. VdbeCursor *pC; /* Cursor of table to get the new rowid */
  80158. int res; /* Result of an sqlite3BtreeLast() */
  80159. int cnt; /* Counter to limit the number of searches */
  80160. Mem *pMem; /* Register holding largest rowid for AUTOINCREMENT */
  80161. VdbeFrame *pFrame; /* Root frame of VDBE */
  80162. v = 0;
  80163. res = 0;
  80164. pOut = out2Prerelease(p, pOp);
  80165. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80166. pC = p->apCsr[pOp->p1];
  80167. if( !pC->isTable ){
  80168. rc = SQLITE_CORRUPT_BKPT;
  80169. goto abort_due_to_error;
  80170. }
  80171. assert( pC!=0 );
  80172. assert( pC->eCurType==CURTYPE_BTREE );
  80173. assert( pC->uc.pCursor!=0 );
  80174. {
  80175. /* The next rowid or record number (different terms for the same
  80176. ** thing) is obtained in a two-step algorithm.
  80177. **
  80178. ** First we attempt to find the largest existing rowid and add one
  80179. ** to that. But if the largest existing rowid is already the maximum
  80180. ** positive integer, we have to fall through to the second
  80181. ** probabilistic algorithm
  80182. **
  80183. ** The second algorithm is to select a rowid at random and see if
  80184. ** it already exists in the table. If it does not exist, we have
  80185. ** succeeded. If the random rowid does exist, we select a new one
  80186. ** and try again, up to 100 times.
  80187. */
  80188. assert( pC->isTable );
  80189. #ifdef SQLITE_32BIT_ROWID
  80190. # define MAX_ROWID 0x7fffffff
  80191. #else
  80192. /* Some compilers complain about constants of the form 0x7fffffffffffffff.
  80193. ** Others complain about 0x7ffffffffffffffffLL. The following macro seems
  80194. ** to provide the constant while making all compilers happy.
  80195. */
  80196. # define MAX_ROWID (i64)( (((u64)0x7fffffff)<<32) | (u64)0xffffffff )
  80197. #endif
  80198. if( !pC->useRandomRowid ){
  80199. rc = sqlite3BtreeLast(pC->uc.pCursor, &res);
  80200. if( rc!=SQLITE_OK ){
  80201. goto abort_due_to_error;
  80202. }
  80203. if( res ){
  80204. v = 1; /* IMP: R-61914-48074 */
  80205. }else{
  80206. assert( sqlite3BtreeCursorIsValid(pC->uc.pCursor) );
  80207. v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  80208. if( v>=MAX_ROWID ){
  80209. pC->useRandomRowid = 1;
  80210. }else{
  80211. v++; /* IMP: R-29538-34987 */
  80212. }
  80213. }
  80214. }
  80215. #ifndef SQLITE_OMIT_AUTOINCREMENT
  80216. if( pOp->p3 ){
  80217. /* Assert that P3 is a valid memory cell. */
  80218. assert( pOp->p3>0 );
  80219. if( p->pFrame ){
  80220. for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
  80221. /* Assert that P3 is a valid memory cell. */
  80222. assert( pOp->p3<=pFrame->nMem );
  80223. pMem = &pFrame->aMem[pOp->p3];
  80224. }else{
  80225. /* Assert that P3 is a valid memory cell. */
  80226. assert( pOp->p3<=(p->nMem+1 - p->nCursor) );
  80227. pMem = &aMem[pOp->p3];
  80228. memAboutToChange(p, pMem);
  80229. }
  80230. assert( memIsValid(pMem) );
  80231. REGISTER_TRACE(pOp->p3, pMem);
  80232. sqlite3VdbeMemIntegerify(pMem);
  80233. assert( (pMem->flags & MEM_Int)!=0 ); /* mem(P3) holds an integer */
  80234. if( pMem->u.i==MAX_ROWID || pC->useRandomRowid ){
  80235. rc = SQLITE_FULL; /* IMP: R-17817-00630 */
  80236. goto abort_due_to_error;
  80237. }
  80238. if( v<pMem->u.i+1 ){
  80239. v = pMem->u.i + 1;
  80240. }
  80241. pMem->u.i = v;
  80242. }
  80243. #endif
  80244. if( pC->useRandomRowid ){
  80245. /* IMPLEMENTATION-OF: R-07677-41881 If the largest ROWID is equal to the
  80246. ** largest possible integer (9223372036854775807) then the database
  80247. ** engine starts picking positive candidate ROWIDs at random until
  80248. ** it finds one that is not previously used. */
  80249. assert( pOp->p3==0 ); /* We cannot be in random rowid mode if this is
  80250. ** an AUTOINCREMENT table. */
  80251. cnt = 0;
  80252. do{
  80253. sqlite3_randomness(sizeof(v), &v);
  80254. v &= (MAX_ROWID>>1); v++; /* Ensure that v is greater than zero */
  80255. }while( ((rc = sqlite3BtreeMovetoUnpacked(pC->uc.pCursor, 0, (u64)v,
  80256. 0, &res))==SQLITE_OK)
  80257. && (res==0)
  80258. && (++cnt<100));
  80259. if( rc ) goto abort_due_to_error;
  80260. if( res==0 ){
  80261. rc = SQLITE_FULL; /* IMP: R-38219-53002 */
  80262. goto abort_due_to_error;
  80263. }
  80264. assert( v>0 ); /* EV: R-40812-03570 */
  80265. }
  80266. pC->deferredMoveto = 0;
  80267. pC->cacheStatus = CACHE_STALE;
  80268. }
  80269. pOut->u.i = v;
  80270. break;
  80271. }
  80272. /* Opcode: Insert P1 P2 P3 P4 P5
  80273. ** Synopsis: intkey=r[P3] data=r[P2]
  80274. **
  80275. ** Write an entry into the table of cursor P1. A new entry is
  80276. ** created if it doesn't already exist or the data for an existing
  80277. ** entry is overwritten. The data is the value MEM_Blob stored in register
  80278. ** number P2. The key is stored in register P3. The key must
  80279. ** be a MEM_Int.
  80280. **
  80281. ** If the OPFLAG_NCHANGE flag of P5 is set, then the row change count is
  80282. ** incremented (otherwise not). If the OPFLAG_LASTROWID flag of P5 is set,
  80283. ** then rowid is stored for subsequent return by the
  80284. ** sqlite3_last_insert_rowid() function (otherwise it is unmodified).
  80285. **
  80286. ** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
  80287. ** run faster by avoiding an unnecessary seek on cursor P1. However,
  80288. ** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
  80289. ** seeks on the cursor or if the most recent seek used a key equal to P3.
  80290. **
  80291. ** If the OPFLAG_ISUPDATE flag is set, then this opcode is part of an
  80292. ** UPDATE operation. Otherwise (if the flag is clear) then this opcode
  80293. ** is part of an INSERT operation. The difference is only important to
  80294. ** the update hook.
  80295. **
  80296. ** Parameter P4 may point to a Table structure, or may be NULL. If it is
  80297. ** not NULL, then the update-hook (sqlite3.xUpdateCallback) is invoked
  80298. ** following a successful insert.
  80299. **
  80300. ** (WARNING/TODO: If P1 is a pseudo-cursor and P2 is dynamically
  80301. ** allocated, then ownership of P2 is transferred to the pseudo-cursor
  80302. ** and register P2 becomes ephemeral. If the cursor is changed, the
  80303. ** value of register P2 will then change. Make sure this does not
  80304. ** cause any problems.)
  80305. **
  80306. ** This instruction only works on tables. The equivalent instruction
  80307. ** for indices is OP_IdxInsert.
  80308. */
  80309. /* Opcode: InsertInt P1 P2 P3 P4 P5
  80310. ** Synopsis: intkey=P3 data=r[P2]
  80311. **
  80312. ** This works exactly like OP_Insert except that the key is the
  80313. ** integer value P3, not the value of the integer stored in register P3.
  80314. */
  80315. case OP_Insert:
  80316. case OP_InsertInt: {
  80317. Mem *pData; /* MEM cell holding data for the record to be inserted */
  80318. Mem *pKey; /* MEM cell holding key for the record */
  80319. VdbeCursor *pC; /* Cursor to table into which insert is written */
  80320. int seekResult; /* Result of prior seek or 0 if no USESEEKRESULT flag */
  80321. const char *zDb; /* database name - used by the update hook */
  80322. Table *pTab; /* Table structure - used by update and pre-update hooks */
  80323. BtreePayload x; /* Payload to be inserted */
  80324. pData = &aMem[pOp->p2];
  80325. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80326. assert( memIsValid(pData) );
  80327. pC = p->apCsr[pOp->p1];
  80328. assert( pC!=0 );
  80329. assert( pC->eCurType==CURTYPE_BTREE );
  80330. assert( pC->uc.pCursor!=0 );
  80331. assert( (pOp->p5 & OPFLAG_ISNOOP) || pC->isTable );
  80332. assert( pOp->p4type==P4_TABLE || pOp->p4type>=P4_STATIC );
  80333. REGISTER_TRACE(pOp->p2, pData);
  80334. if( pOp->opcode==OP_Insert ){
  80335. pKey = &aMem[pOp->p3];
  80336. assert( pKey->flags & MEM_Int );
  80337. assert( memIsValid(pKey) );
  80338. REGISTER_TRACE(pOp->p3, pKey);
  80339. x.nKey = pKey->u.i;
  80340. }else{
  80341. assert( pOp->opcode==OP_InsertInt );
  80342. x.nKey = pOp->p3;
  80343. }
  80344. if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
  80345. assert( pC->iDb>=0 );
  80346. zDb = db->aDb[pC->iDb].zDbSName;
  80347. pTab = pOp->p4.pTab;
  80348. assert( (pOp->p5 & OPFLAG_ISNOOP) || HasRowid(pTab) );
  80349. }else{
  80350. pTab = 0;
  80351. zDb = 0; /* Not needed. Silence a compiler warning. */
  80352. }
  80353. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  80354. /* Invoke the pre-update hook, if any */
  80355. if( pTab ){
  80356. if( db->xPreUpdateCallback && !(pOp->p5 & OPFLAG_ISUPDATE) ){
  80357. sqlite3VdbePreUpdateHook(p, pC, SQLITE_INSERT, zDb, pTab, x.nKey,pOp->p2);
  80358. }
  80359. if( db->xUpdateCallback==0 || pTab->aCol==0 ){
  80360. /* Prevent post-update hook from running in cases when it should not */
  80361. pTab = 0;
  80362. }
  80363. }
  80364. if( pOp->p5 & OPFLAG_ISNOOP ) break;
  80365. #endif
  80366. if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
  80367. if( pOp->p5 & OPFLAG_LASTROWID ) db->lastRowid = x.nKey;
  80368. assert( pData->flags & (MEM_Blob|MEM_Str) );
  80369. x.pData = pData->z;
  80370. x.nData = pData->n;
  80371. seekResult = ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0);
  80372. if( pData->flags & MEM_Zero ){
  80373. x.nZero = pData->u.nZero;
  80374. }else{
  80375. x.nZero = 0;
  80376. }
  80377. x.pKey = 0;
  80378. rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
  80379. (pOp->p5 & (OPFLAG_APPEND|OPFLAG_SAVEPOSITION)), seekResult
  80380. );
  80381. pC->deferredMoveto = 0;
  80382. pC->cacheStatus = CACHE_STALE;
  80383. /* Invoke the update-hook if required. */
  80384. if( rc ) goto abort_due_to_error;
  80385. if( pTab ){
  80386. assert( db->xUpdateCallback!=0 );
  80387. assert( pTab->aCol!=0 );
  80388. db->xUpdateCallback(db->pUpdateArg,
  80389. (pOp->p5 & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_INSERT,
  80390. zDb, pTab->zName, x.nKey);
  80391. }
  80392. break;
  80393. }
  80394. /* Opcode: Delete P1 P2 P3 P4 P5
  80395. **
  80396. ** Delete the record at which the P1 cursor is currently pointing.
  80397. **
  80398. ** If the OPFLAG_SAVEPOSITION bit of the P5 parameter is set, then
  80399. ** the cursor will be left pointing at either the next or the previous
  80400. ** record in the table. If it is left pointing at the next record, then
  80401. ** the next Next instruction will be a no-op. As a result, in this case
  80402. ** it is ok to delete a record from within a Next loop. If
  80403. ** OPFLAG_SAVEPOSITION bit of P5 is clear, then the cursor will be
  80404. ** left in an undefined state.
  80405. **
  80406. ** If the OPFLAG_AUXDELETE bit is set on P5, that indicates that this
  80407. ** delete one of several associated with deleting a table row and all its
  80408. ** associated index entries. Exactly one of those deletes is the "primary"
  80409. ** delete. The others are all on OPFLAG_FORDELETE cursors or else are
  80410. ** marked with the AUXDELETE flag.
  80411. **
  80412. ** If the OPFLAG_NCHANGE flag of P2 (NB: P2 not P5) is set, then the row
  80413. ** change count is incremented (otherwise not).
  80414. **
  80415. ** P1 must not be pseudo-table. It has to be a real table with
  80416. ** multiple rows.
  80417. **
  80418. ** If P4 is not NULL then it points to a Table object. In this case either
  80419. ** the update or pre-update hook, or both, may be invoked. The P1 cursor must
  80420. ** have been positioned using OP_NotFound prior to invoking this opcode in
  80421. ** this case. Specifically, if one is configured, the pre-update hook is
  80422. ** invoked if P4 is not NULL. The update-hook is invoked if one is configured,
  80423. ** P4 is not NULL, and the OPFLAG_NCHANGE flag is set in P2.
  80424. **
  80425. ** If the OPFLAG_ISUPDATE flag is set in P2, then P3 contains the address
  80426. ** of the memory cell that contains the value that the rowid of the row will
  80427. ** be set to by the update.
  80428. */
  80429. case OP_Delete: {
  80430. VdbeCursor *pC;
  80431. const char *zDb;
  80432. Table *pTab;
  80433. int opflags;
  80434. opflags = pOp->p2;
  80435. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80436. pC = p->apCsr[pOp->p1];
  80437. assert( pC!=0 );
  80438. assert( pC->eCurType==CURTYPE_BTREE );
  80439. assert( pC->uc.pCursor!=0 );
  80440. assert( pC->deferredMoveto==0 );
  80441. #ifdef SQLITE_DEBUG
  80442. if( pOp->p4type==P4_TABLE && HasRowid(pOp->p4.pTab) && pOp->p5==0 ){
  80443. /* If p5 is zero, the seek operation that positioned the cursor prior to
  80444. ** OP_Delete will have also set the pC->movetoTarget field to the rowid of
  80445. ** the row that is being deleted */
  80446. i64 iKey = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  80447. assert( pC->movetoTarget==iKey );
  80448. }
  80449. #endif
  80450. /* If the update-hook or pre-update-hook will be invoked, set zDb to
  80451. ** the name of the db to pass as to it. Also set local pTab to a copy
  80452. ** of p4.pTab. Finally, if p5 is true, indicating that this cursor was
  80453. ** last moved with OP_Next or OP_Prev, not Seek or NotFound, set
  80454. ** VdbeCursor.movetoTarget to the current rowid. */
  80455. if( pOp->p4type==P4_TABLE && HAS_UPDATE_HOOK(db) ){
  80456. assert( pC->iDb>=0 );
  80457. assert( pOp->p4.pTab!=0 );
  80458. zDb = db->aDb[pC->iDb].zDbSName;
  80459. pTab = pOp->p4.pTab;
  80460. if( (pOp->p5 & OPFLAG_SAVEPOSITION)!=0 && pC->isTable ){
  80461. pC->movetoTarget = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  80462. }
  80463. }else{
  80464. zDb = 0; /* Not needed. Silence a compiler warning. */
  80465. pTab = 0; /* Not needed. Silence a compiler warning. */
  80466. }
  80467. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  80468. /* Invoke the pre-update-hook if required. */
  80469. if( db->xPreUpdateCallback && pOp->p4.pTab ){
  80470. assert( !(opflags & OPFLAG_ISUPDATE)
  80471. || HasRowid(pTab)==0
  80472. || (aMem[pOp->p3].flags & MEM_Int)
  80473. );
  80474. sqlite3VdbePreUpdateHook(p, pC,
  80475. (opflags & OPFLAG_ISUPDATE) ? SQLITE_UPDATE : SQLITE_DELETE,
  80476. zDb, pTab, pC->movetoTarget,
  80477. pOp->p3
  80478. );
  80479. }
  80480. if( opflags & OPFLAG_ISNOOP ) break;
  80481. #endif
  80482. /* Only flags that can be set are SAVEPOISTION and AUXDELETE */
  80483. assert( (pOp->p5 & ~(OPFLAG_SAVEPOSITION|OPFLAG_AUXDELETE))==0 );
  80484. assert( OPFLAG_SAVEPOSITION==BTREE_SAVEPOSITION );
  80485. assert( OPFLAG_AUXDELETE==BTREE_AUXDELETE );
  80486. #ifdef SQLITE_DEBUG
  80487. if( p->pFrame==0 ){
  80488. if( pC->isEphemeral==0
  80489. && (pOp->p5 & OPFLAG_AUXDELETE)==0
  80490. && (pC->wrFlag & OPFLAG_FORDELETE)==0
  80491. ){
  80492. nExtraDelete++;
  80493. }
  80494. if( pOp->p2 & OPFLAG_NCHANGE ){
  80495. nExtraDelete--;
  80496. }
  80497. }
  80498. #endif
  80499. rc = sqlite3BtreeDelete(pC->uc.pCursor, pOp->p5);
  80500. pC->cacheStatus = CACHE_STALE;
  80501. pC->seekResult = 0;
  80502. if( rc ) goto abort_due_to_error;
  80503. /* Invoke the update-hook if required. */
  80504. if( opflags & OPFLAG_NCHANGE ){
  80505. p->nChange++;
  80506. if( db->xUpdateCallback && HasRowid(pTab) ){
  80507. db->xUpdateCallback(db->pUpdateArg, SQLITE_DELETE, zDb, pTab->zName,
  80508. pC->movetoTarget);
  80509. assert( pC->iDb>=0 );
  80510. }
  80511. }
  80512. break;
  80513. }
  80514. /* Opcode: ResetCount * * * * *
  80515. **
  80516. ** The value of the change counter is copied to the database handle
  80517. ** change counter (returned by subsequent calls to sqlite3_changes()).
  80518. ** Then the VMs internal change counter resets to 0.
  80519. ** This is used by trigger programs.
  80520. */
  80521. case OP_ResetCount: {
  80522. sqlite3VdbeSetChanges(db, p->nChange);
  80523. p->nChange = 0;
  80524. break;
  80525. }
  80526. /* Opcode: SorterCompare P1 P2 P3 P4
  80527. ** Synopsis: if key(P1)!=trim(r[P3],P4) goto P2
  80528. **
  80529. ** P1 is a sorter cursor. This instruction compares a prefix of the
  80530. ** record blob in register P3 against a prefix of the entry that
  80531. ** the sorter cursor currently points to. Only the first P4 fields
  80532. ** of r[P3] and the sorter record are compared.
  80533. **
  80534. ** If either P3 or the sorter contains a NULL in one of their significant
  80535. ** fields (not counting the P4 fields at the end which are ignored) then
  80536. ** the comparison is assumed to be equal.
  80537. **
  80538. ** Fall through to next instruction if the two records compare equal to
  80539. ** each other. Jump to P2 if they are different.
  80540. */
  80541. case OP_SorterCompare: {
  80542. VdbeCursor *pC;
  80543. int res;
  80544. int nKeyCol;
  80545. pC = p->apCsr[pOp->p1];
  80546. assert( isSorter(pC) );
  80547. assert( pOp->p4type==P4_INT32 );
  80548. pIn3 = &aMem[pOp->p3];
  80549. nKeyCol = pOp->p4.i;
  80550. res = 0;
  80551. rc = sqlite3VdbeSorterCompare(pC, pIn3, nKeyCol, &res);
  80552. VdbeBranchTaken(res!=0,2);
  80553. if( rc ) goto abort_due_to_error;
  80554. if( res ) goto jump_to_p2;
  80555. break;
  80556. };
  80557. /* Opcode: SorterData P1 P2 P3 * *
  80558. ** Synopsis: r[P2]=data
  80559. **
  80560. ** Write into register P2 the current sorter data for sorter cursor P1.
  80561. ** Then clear the column header cache on cursor P3.
  80562. **
  80563. ** This opcode is normally use to move a record out of the sorter and into
  80564. ** a register that is the source for a pseudo-table cursor created using
  80565. ** OpenPseudo. That pseudo-table cursor is the one that is identified by
  80566. ** parameter P3. Clearing the P3 column cache as part of this opcode saves
  80567. ** us from having to issue a separate NullRow instruction to clear that cache.
  80568. */
  80569. case OP_SorterData: {
  80570. VdbeCursor *pC;
  80571. pOut = &aMem[pOp->p2];
  80572. pC = p->apCsr[pOp->p1];
  80573. assert( isSorter(pC) );
  80574. rc = sqlite3VdbeSorterRowkey(pC, pOut);
  80575. assert( rc!=SQLITE_OK || (pOut->flags & MEM_Blob) );
  80576. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80577. if( rc ) goto abort_due_to_error;
  80578. p->apCsr[pOp->p3]->cacheStatus = CACHE_STALE;
  80579. break;
  80580. }
  80581. /* Opcode: RowData P1 P2 P3 * *
  80582. ** Synopsis: r[P2]=data
  80583. **
  80584. ** Write into register P2 the complete row content for the row at
  80585. ** which cursor P1 is currently pointing.
  80586. ** There is no interpretation of the data.
  80587. ** It is just copied onto the P2 register exactly as
  80588. ** it is found in the database file.
  80589. **
  80590. ** If cursor P1 is an index, then the content is the key of the row.
  80591. ** If cursor P2 is a table, then the content extracted is the data.
  80592. **
  80593. ** If the P1 cursor must be pointing to a valid row (not a NULL row)
  80594. ** of a real table, not a pseudo-table.
  80595. **
  80596. ** If P3!=0 then this opcode is allowed to make an ephermeral pointer
  80597. ** into the database page. That means that the content of the output
  80598. ** register will be invalidated as soon as the cursor moves - including
  80599. ** moves caused by other cursors that "save" the the current cursors
  80600. ** position in order that they can write to the same table. If P3==0
  80601. ** then a copy of the data is made into memory. P3!=0 is faster, but
  80602. ** P3==0 is safer.
  80603. **
  80604. ** If P3!=0 then the content of the P2 register is unsuitable for use
  80605. ** in OP_Result and any OP_Result will invalidate the P2 register content.
  80606. ** The P2 register content is invalidated by opcodes like OP_Function or
  80607. ** by any use of another cursor pointing to the same table.
  80608. */
  80609. case OP_RowData: {
  80610. VdbeCursor *pC;
  80611. BtCursor *pCrsr;
  80612. u32 n;
  80613. pOut = out2Prerelease(p, pOp);
  80614. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80615. pC = p->apCsr[pOp->p1];
  80616. assert( pC!=0 );
  80617. assert( pC->eCurType==CURTYPE_BTREE );
  80618. assert( isSorter(pC)==0 );
  80619. assert( pC->nullRow==0 );
  80620. assert( pC->uc.pCursor!=0 );
  80621. pCrsr = pC->uc.pCursor;
  80622. /* The OP_RowData opcodes always follow OP_NotExists or
  80623. ** OP_SeekRowid or OP_Rewind/Op_Next with no intervening instructions
  80624. ** that might invalidate the cursor.
  80625. ** If this where not the case, on of the following assert()s
  80626. ** would fail. Should this ever change (because of changes in the code
  80627. ** generator) then the fix would be to insert a call to
  80628. ** sqlite3VdbeCursorMoveto().
  80629. */
  80630. assert( pC->deferredMoveto==0 );
  80631. assert( sqlite3BtreeCursorIsValid(pCrsr) );
  80632. #if 0 /* Not required due to the previous to assert() statements */
  80633. rc = sqlite3VdbeCursorMoveto(pC);
  80634. if( rc!=SQLITE_OK ) goto abort_due_to_error;
  80635. #endif
  80636. n = sqlite3BtreePayloadSize(pCrsr);
  80637. if( n>(u32)db->aLimit[SQLITE_LIMIT_LENGTH] ){
  80638. goto too_big;
  80639. }
  80640. testcase( n==0 );
  80641. rc = sqlite3VdbeMemFromBtree(pCrsr, 0, n, pOut);
  80642. if( rc ) goto abort_due_to_error;
  80643. if( !pOp->p3 ) Deephemeralize(pOut);
  80644. UPDATE_MAX_BLOBSIZE(pOut);
  80645. REGISTER_TRACE(pOp->p2, pOut);
  80646. break;
  80647. }
  80648. /* Opcode: Rowid P1 P2 * * *
  80649. ** Synopsis: r[P2]=rowid
  80650. **
  80651. ** Store in register P2 an integer which is the key of the table entry that
  80652. ** P1 is currently point to.
  80653. **
  80654. ** P1 can be either an ordinary table or a virtual table. There used to
  80655. ** be a separate OP_VRowid opcode for use with virtual tables, but this
  80656. ** one opcode now works for both table types.
  80657. */
  80658. case OP_Rowid: { /* out2 */
  80659. VdbeCursor *pC;
  80660. i64 v;
  80661. sqlite3_vtab *pVtab;
  80662. const sqlite3_module *pModule;
  80663. pOut = out2Prerelease(p, pOp);
  80664. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80665. pC = p->apCsr[pOp->p1];
  80666. assert( pC!=0 );
  80667. assert( pC->eCurType!=CURTYPE_PSEUDO || pC->nullRow );
  80668. if( pC->nullRow ){
  80669. pOut->flags = MEM_Null;
  80670. break;
  80671. }else if( pC->deferredMoveto ){
  80672. v = pC->movetoTarget;
  80673. #ifndef SQLITE_OMIT_VIRTUALTABLE
  80674. }else if( pC->eCurType==CURTYPE_VTAB ){
  80675. assert( pC->uc.pVCur!=0 );
  80676. pVtab = pC->uc.pVCur->pVtab;
  80677. pModule = pVtab->pModule;
  80678. assert( pModule->xRowid );
  80679. rc = pModule->xRowid(pC->uc.pVCur, &v);
  80680. sqlite3VtabImportErrmsg(p, pVtab);
  80681. if( rc ) goto abort_due_to_error;
  80682. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  80683. }else{
  80684. assert( pC->eCurType==CURTYPE_BTREE );
  80685. assert( pC->uc.pCursor!=0 );
  80686. rc = sqlite3VdbeCursorRestore(pC);
  80687. if( rc ) goto abort_due_to_error;
  80688. if( pC->nullRow ){
  80689. pOut->flags = MEM_Null;
  80690. break;
  80691. }
  80692. v = sqlite3BtreeIntegerKey(pC->uc.pCursor);
  80693. }
  80694. pOut->u.i = v;
  80695. break;
  80696. }
  80697. /* Opcode: NullRow P1 * * * *
  80698. **
  80699. ** Move the cursor P1 to a null row. Any OP_Column operations
  80700. ** that occur while the cursor is on the null row will always
  80701. ** write a NULL.
  80702. */
  80703. case OP_NullRow: {
  80704. VdbeCursor *pC;
  80705. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80706. pC = p->apCsr[pOp->p1];
  80707. assert( pC!=0 );
  80708. pC->nullRow = 1;
  80709. pC->cacheStatus = CACHE_STALE;
  80710. if( pC->eCurType==CURTYPE_BTREE ){
  80711. assert( pC->uc.pCursor!=0 );
  80712. sqlite3BtreeClearCursor(pC->uc.pCursor);
  80713. }
  80714. break;
  80715. }
  80716. /* Opcode: SeekEnd P1 * * * *
  80717. **
  80718. ** Position cursor P1 at the end of the btree for the purpose of
  80719. ** appending a new entry onto the btree.
  80720. **
  80721. ** It is assumed that the cursor is used only for appending and so
  80722. ** if the cursor is valid, then the cursor must already be pointing
  80723. ** at the end of the btree and so no changes are made to
  80724. ** the cursor.
  80725. */
  80726. /* Opcode: Last P1 P2 * * *
  80727. **
  80728. ** The next use of the Rowid or Column or Prev instruction for P1
  80729. ** will refer to the last entry in the database table or index.
  80730. ** If the table or index is empty and P2>0, then jump immediately to P2.
  80731. ** If P2 is 0 or if the table or index is not empty, fall through
  80732. ** to the following instruction.
  80733. **
  80734. ** This opcode leaves the cursor configured to move in reverse order,
  80735. ** from the end toward the beginning. In other words, the cursor is
  80736. ** configured to use Prev, not Next.
  80737. */
  80738. case OP_SeekEnd:
  80739. case OP_Last: { /* jump */
  80740. VdbeCursor *pC;
  80741. BtCursor *pCrsr;
  80742. int res;
  80743. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80744. pC = p->apCsr[pOp->p1];
  80745. assert( pC!=0 );
  80746. assert( pC->eCurType==CURTYPE_BTREE );
  80747. pCrsr = pC->uc.pCursor;
  80748. res = 0;
  80749. assert( pCrsr!=0 );
  80750. #ifdef SQLITE_DEBUG
  80751. pC->seekOp = pOp->opcode;
  80752. #endif
  80753. if( pOp->opcode==OP_SeekEnd ){
  80754. assert( pOp->p2==0 );
  80755. pC->seekResult = -1;
  80756. if( sqlite3BtreeCursorIsValidNN(pCrsr) ){
  80757. break;
  80758. }
  80759. }
  80760. rc = sqlite3BtreeLast(pCrsr, &res);
  80761. pC->nullRow = (u8)res;
  80762. pC->deferredMoveto = 0;
  80763. pC->cacheStatus = CACHE_STALE;
  80764. if( rc ) goto abort_due_to_error;
  80765. if( pOp->p2>0 ){
  80766. VdbeBranchTaken(res!=0,2);
  80767. if( res ) goto jump_to_p2;
  80768. }
  80769. break;
  80770. }
  80771. /* Opcode: IfSmaller P1 P2 P3 * *
  80772. **
  80773. ** Estimate the number of rows in the table P1. Jump to P2 if that
  80774. ** estimate is less than approximately 2**(0.1*P3).
  80775. */
  80776. case OP_IfSmaller: { /* jump */
  80777. VdbeCursor *pC;
  80778. BtCursor *pCrsr;
  80779. int res;
  80780. i64 sz;
  80781. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80782. pC = p->apCsr[pOp->p1];
  80783. assert( pC!=0 );
  80784. pCrsr = pC->uc.pCursor;
  80785. assert( pCrsr );
  80786. rc = sqlite3BtreeFirst(pCrsr, &res);
  80787. if( rc ) goto abort_due_to_error;
  80788. if( res==0 ){
  80789. sz = sqlite3BtreeRowCountEst(pCrsr);
  80790. if( ALWAYS(sz>=0) && sqlite3LogEst((u64)sz)<pOp->p3 ) res = 1;
  80791. }
  80792. VdbeBranchTaken(res!=0,2);
  80793. if( res ) goto jump_to_p2;
  80794. break;
  80795. }
  80796. /* Opcode: SorterSort P1 P2 * * *
  80797. **
  80798. ** After all records have been inserted into the Sorter object
  80799. ** identified by P1, invoke this opcode to actually do the sorting.
  80800. ** Jump to P2 if there are no records to be sorted.
  80801. **
  80802. ** This opcode is an alias for OP_Sort and OP_Rewind that is used
  80803. ** for Sorter objects.
  80804. */
  80805. /* Opcode: Sort P1 P2 * * *
  80806. **
  80807. ** This opcode does exactly the same thing as OP_Rewind except that
  80808. ** it increments an undocumented global variable used for testing.
  80809. **
  80810. ** Sorting is accomplished by writing records into a sorting index,
  80811. ** then rewinding that index and playing it back from beginning to
  80812. ** end. We use the OP_Sort opcode instead of OP_Rewind to do the
  80813. ** rewinding so that the global variable will be incremented and
  80814. ** regression tests can determine whether or not the optimizer is
  80815. ** correctly optimizing out sorts.
  80816. */
  80817. case OP_SorterSort: /* jump */
  80818. case OP_Sort: { /* jump */
  80819. #ifdef SQLITE_TEST
  80820. sqlite3_sort_count++;
  80821. sqlite3_search_count--;
  80822. #endif
  80823. p->aCounter[SQLITE_STMTSTATUS_SORT]++;
  80824. /* Fall through into OP_Rewind */
  80825. }
  80826. /* Opcode: Rewind P1 P2 * * *
  80827. **
  80828. ** The next use of the Rowid or Column or Next instruction for P1
  80829. ** will refer to the first entry in the database table or index.
  80830. ** If the table or index is empty, jump immediately to P2.
  80831. ** If the table or index is not empty, fall through to the following
  80832. ** instruction.
  80833. **
  80834. ** This opcode leaves the cursor configured to move in forward order,
  80835. ** from the beginning toward the end. In other words, the cursor is
  80836. ** configured to use Next, not Prev.
  80837. */
  80838. case OP_Rewind: { /* jump */
  80839. VdbeCursor *pC;
  80840. BtCursor *pCrsr;
  80841. int res;
  80842. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80843. pC = p->apCsr[pOp->p1];
  80844. assert( pC!=0 );
  80845. assert( isSorter(pC)==(pOp->opcode==OP_SorterSort) );
  80846. res = 1;
  80847. #ifdef SQLITE_DEBUG
  80848. pC->seekOp = OP_Rewind;
  80849. #endif
  80850. if( isSorter(pC) ){
  80851. rc = sqlite3VdbeSorterRewind(pC, &res);
  80852. }else{
  80853. assert( pC->eCurType==CURTYPE_BTREE );
  80854. pCrsr = pC->uc.pCursor;
  80855. assert( pCrsr );
  80856. rc = sqlite3BtreeFirst(pCrsr, &res);
  80857. pC->deferredMoveto = 0;
  80858. pC->cacheStatus = CACHE_STALE;
  80859. }
  80860. if( rc ) goto abort_due_to_error;
  80861. pC->nullRow = (u8)res;
  80862. assert( pOp->p2>0 && pOp->p2<p->nOp );
  80863. VdbeBranchTaken(res!=0,2);
  80864. if( res ) goto jump_to_p2;
  80865. break;
  80866. }
  80867. /* Opcode: Next P1 P2 P3 P4 P5
  80868. **
  80869. ** Advance cursor P1 so that it points to the next key/data pair in its
  80870. ** table or index. If there are no more key/value pairs then fall through
  80871. ** to the following instruction. But if the cursor advance was successful,
  80872. ** jump immediately to P2.
  80873. **
  80874. ** The Next opcode is only valid following an SeekGT, SeekGE, or
  80875. ** OP_Rewind opcode used to position the cursor. Next is not allowed
  80876. ** to follow SeekLT, SeekLE, or OP_Last.
  80877. **
  80878. ** The P1 cursor must be for a real table, not a pseudo-table. P1 must have
  80879. ** been opened prior to this opcode or the program will segfault.
  80880. **
  80881. ** The P3 value is a hint to the btree implementation. If P3==1, that
  80882. ** means P1 is an SQL index and that this instruction could have been
  80883. ** omitted if that index had been unique. P3 is usually 0. P3 is
  80884. ** always either 0 or 1.
  80885. **
  80886. ** P4 is always of type P4_ADVANCE. The function pointer points to
  80887. ** sqlite3BtreeNext().
  80888. **
  80889. ** If P5 is positive and the jump is taken, then event counter
  80890. ** number P5-1 in the prepared statement is incremented.
  80891. **
  80892. ** See also: Prev, NextIfOpen
  80893. */
  80894. /* Opcode: NextIfOpen P1 P2 P3 P4 P5
  80895. **
  80896. ** This opcode works just like Next except that if cursor P1 is not
  80897. ** open it behaves a no-op.
  80898. */
  80899. /* Opcode: Prev P1 P2 P3 P4 P5
  80900. **
  80901. ** Back up cursor P1 so that it points to the previous key/data pair in its
  80902. ** table or index. If there is no previous key/value pairs then fall through
  80903. ** to the following instruction. But if the cursor backup was successful,
  80904. ** jump immediately to P2.
  80905. **
  80906. **
  80907. ** The Prev opcode is only valid following an SeekLT, SeekLE, or
  80908. ** OP_Last opcode used to position the cursor. Prev is not allowed
  80909. ** to follow SeekGT, SeekGE, or OP_Rewind.
  80910. **
  80911. ** The P1 cursor must be for a real table, not a pseudo-table. If P1 is
  80912. ** not open then the behavior is undefined.
  80913. **
  80914. ** The P3 value is a hint to the btree implementation. If P3==1, that
  80915. ** means P1 is an SQL index and that this instruction could have been
  80916. ** omitted if that index had been unique. P3 is usually 0. P3 is
  80917. ** always either 0 or 1.
  80918. **
  80919. ** P4 is always of type P4_ADVANCE. The function pointer points to
  80920. ** sqlite3BtreePrevious().
  80921. **
  80922. ** If P5 is positive and the jump is taken, then event counter
  80923. ** number P5-1 in the prepared statement is incremented.
  80924. */
  80925. /* Opcode: PrevIfOpen P1 P2 P3 P4 P5
  80926. **
  80927. ** This opcode works just like Prev except that if cursor P1 is not
  80928. ** open it behaves a no-op.
  80929. */
  80930. /* Opcode: SorterNext P1 P2 * * P5
  80931. **
  80932. ** This opcode works just like OP_Next except that P1 must be a
  80933. ** sorter object for which the OP_SorterSort opcode has been
  80934. ** invoked. This opcode advances the cursor to the next sorted
  80935. ** record, or jumps to P2 if there are no more sorted records.
  80936. */
  80937. case OP_SorterNext: { /* jump */
  80938. VdbeCursor *pC;
  80939. pC = p->apCsr[pOp->p1];
  80940. assert( isSorter(pC) );
  80941. rc = sqlite3VdbeSorterNext(db, pC);
  80942. goto next_tail;
  80943. case OP_PrevIfOpen: /* jump */
  80944. case OP_NextIfOpen: /* jump */
  80945. if( p->apCsr[pOp->p1]==0 ) break;
  80946. /* Fall through */
  80947. case OP_Prev: /* jump */
  80948. case OP_Next: /* jump */
  80949. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  80950. assert( pOp->p5<ArraySize(p->aCounter) );
  80951. pC = p->apCsr[pOp->p1];
  80952. assert( pC!=0 );
  80953. assert( pC->deferredMoveto==0 );
  80954. assert( pC->eCurType==CURTYPE_BTREE );
  80955. assert( pOp->opcode!=OP_Next || pOp->p4.xAdvance==sqlite3BtreeNext );
  80956. assert( pOp->opcode!=OP_Prev || pOp->p4.xAdvance==sqlite3BtreePrevious );
  80957. assert( pOp->opcode!=OP_NextIfOpen || pOp->p4.xAdvance==sqlite3BtreeNext );
  80958. assert( pOp->opcode!=OP_PrevIfOpen || pOp->p4.xAdvance==sqlite3BtreePrevious);
  80959. /* The Next opcode is only used after SeekGT, SeekGE, and Rewind.
  80960. ** The Prev opcode is only used after SeekLT, SeekLE, and Last. */
  80961. assert( pOp->opcode!=OP_Next || pOp->opcode!=OP_NextIfOpen
  80962. || pC->seekOp==OP_SeekGT || pC->seekOp==OP_SeekGE
  80963. || pC->seekOp==OP_Rewind || pC->seekOp==OP_Found);
  80964. assert( pOp->opcode!=OP_Prev || pOp->opcode!=OP_PrevIfOpen
  80965. || pC->seekOp==OP_SeekLT || pC->seekOp==OP_SeekLE
  80966. || pC->seekOp==OP_Last );
  80967. rc = pOp->p4.xAdvance(pC->uc.pCursor, pOp->p3);
  80968. next_tail:
  80969. pC->cacheStatus = CACHE_STALE;
  80970. VdbeBranchTaken(rc==SQLITE_OK,2);
  80971. if( rc==SQLITE_OK ){
  80972. pC->nullRow = 0;
  80973. p->aCounter[pOp->p5]++;
  80974. #ifdef SQLITE_TEST
  80975. sqlite3_search_count++;
  80976. #endif
  80977. goto jump_to_p2_and_check_for_interrupt;
  80978. }
  80979. if( rc!=SQLITE_DONE ) goto abort_due_to_error;
  80980. rc = SQLITE_OK;
  80981. pC->nullRow = 1;
  80982. goto check_for_interrupt;
  80983. }
  80984. /* Opcode: IdxInsert P1 P2 P3 P4 P5
  80985. ** Synopsis: key=r[P2]
  80986. **
  80987. ** Register P2 holds an SQL index key made using the
  80988. ** MakeRecord instructions. This opcode writes that key
  80989. ** into the index P1. Data for the entry is nil.
  80990. **
  80991. ** If P4 is not zero, then it is the number of values in the unpacked
  80992. ** key of reg(P2). In that case, P3 is the index of the first register
  80993. ** for the unpacked key. The availability of the unpacked key can sometimes
  80994. ** be an optimization.
  80995. **
  80996. ** If P5 has the OPFLAG_APPEND bit set, that is a hint to the b-tree layer
  80997. ** that this insert is likely to be an append.
  80998. **
  80999. ** If P5 has the OPFLAG_NCHANGE bit set, then the change counter is
  81000. ** incremented by this instruction. If the OPFLAG_NCHANGE bit is clear,
  81001. ** then the change counter is unchanged.
  81002. **
  81003. ** If the OPFLAG_USESEEKRESULT flag of P5 is set, the implementation might
  81004. ** run faster by avoiding an unnecessary seek on cursor P1. However,
  81005. ** the OPFLAG_USESEEKRESULT flag must only be set if there have been no prior
  81006. ** seeks on the cursor or if the most recent seek used a key equivalent
  81007. ** to P2.
  81008. **
  81009. ** This instruction only works for indices. The equivalent instruction
  81010. ** for tables is OP_Insert.
  81011. */
  81012. /* Opcode: SorterInsert P1 P2 * * *
  81013. ** Synopsis: key=r[P2]
  81014. **
  81015. ** Register P2 holds an SQL index key made using the
  81016. ** MakeRecord instructions. This opcode writes that key
  81017. ** into the sorter P1. Data for the entry is nil.
  81018. */
  81019. case OP_SorterInsert: /* in2 */
  81020. case OP_IdxInsert: { /* in2 */
  81021. VdbeCursor *pC;
  81022. BtreePayload x;
  81023. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  81024. pC = p->apCsr[pOp->p1];
  81025. assert( pC!=0 );
  81026. assert( isSorter(pC)==(pOp->opcode==OP_SorterInsert) );
  81027. pIn2 = &aMem[pOp->p2];
  81028. assert( pIn2->flags & MEM_Blob );
  81029. if( pOp->p5 & OPFLAG_NCHANGE ) p->nChange++;
  81030. assert( pC->eCurType==CURTYPE_BTREE || pOp->opcode==OP_SorterInsert );
  81031. assert( pC->isTable==0 );
  81032. rc = ExpandBlob(pIn2);
  81033. if( rc ) goto abort_due_to_error;
  81034. if( pOp->opcode==OP_SorterInsert ){
  81035. rc = sqlite3VdbeSorterWrite(pC, pIn2);
  81036. }else{
  81037. x.nKey = pIn2->n;
  81038. x.pKey = pIn2->z;
  81039. x.aMem = aMem + pOp->p3;
  81040. x.nMem = (u16)pOp->p4.i;
  81041. rc = sqlite3BtreeInsert(pC->uc.pCursor, &x,
  81042. (pOp->p5 & (OPFLAG_APPEND|OPFLAG_SAVEPOSITION)),
  81043. ((pOp->p5 & OPFLAG_USESEEKRESULT) ? pC->seekResult : 0)
  81044. );
  81045. assert( pC->deferredMoveto==0 );
  81046. pC->cacheStatus = CACHE_STALE;
  81047. }
  81048. if( rc) goto abort_due_to_error;
  81049. break;
  81050. }
  81051. /* Opcode: IdxDelete P1 P2 P3 * *
  81052. ** Synopsis: key=r[P2@P3]
  81053. **
  81054. ** The content of P3 registers starting at register P2 form
  81055. ** an unpacked index key. This opcode removes that entry from the
  81056. ** index opened by cursor P1.
  81057. */
  81058. case OP_IdxDelete: {
  81059. VdbeCursor *pC;
  81060. BtCursor *pCrsr;
  81061. int res;
  81062. UnpackedRecord r;
  81063. assert( pOp->p3>0 );
  81064. assert( pOp->p2>0 && pOp->p2+pOp->p3<=(p->nMem+1 - p->nCursor)+1 );
  81065. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  81066. pC = p->apCsr[pOp->p1];
  81067. assert( pC!=0 );
  81068. assert( pC->eCurType==CURTYPE_BTREE );
  81069. pCrsr = pC->uc.pCursor;
  81070. assert( pCrsr!=0 );
  81071. assert( pOp->p5==0 );
  81072. r.pKeyInfo = pC->pKeyInfo;
  81073. r.nField = (u16)pOp->p3;
  81074. r.default_rc = 0;
  81075. r.aMem = &aMem[pOp->p2];
  81076. rc = sqlite3BtreeMovetoUnpacked(pCrsr, &r, 0, 0, &res);
  81077. if( rc ) goto abort_due_to_error;
  81078. if( res==0 ){
  81079. rc = sqlite3BtreeDelete(pCrsr, BTREE_AUXDELETE);
  81080. if( rc ) goto abort_due_to_error;
  81081. }
  81082. assert( pC->deferredMoveto==0 );
  81083. pC->cacheStatus = CACHE_STALE;
  81084. pC->seekResult = 0;
  81085. break;
  81086. }
  81087. /* Opcode: DeferredSeek P1 * P3 P4 *
  81088. ** Synopsis: Move P3 to P1.rowid if needed
  81089. **
  81090. ** P1 is an open index cursor and P3 is a cursor on the corresponding
  81091. ** table. This opcode does a deferred seek of the P3 table cursor
  81092. ** to the row that corresponds to the current row of P1.
  81093. **
  81094. ** This is a deferred seek. Nothing actually happens until
  81095. ** the cursor is used to read a record. That way, if no reads
  81096. ** occur, no unnecessary I/O happens.
  81097. **
  81098. ** P4 may be an array of integers (type P4_INTARRAY) containing
  81099. ** one entry for each column in the P3 table. If array entry a(i)
  81100. ** is non-zero, then reading column a(i)-1 from cursor P3 is
  81101. ** equivalent to performing the deferred seek and then reading column i
  81102. ** from P1. This information is stored in P3 and used to redirect
  81103. ** reads against P3 over to P1, thus possibly avoiding the need to
  81104. ** seek and read cursor P3.
  81105. */
  81106. /* Opcode: IdxRowid P1 P2 * * *
  81107. ** Synopsis: r[P2]=rowid
  81108. **
  81109. ** Write into register P2 an integer which is the last entry in the record at
  81110. ** the end of the index key pointed to by cursor P1. This integer should be
  81111. ** the rowid of the table entry to which this index entry points.
  81112. **
  81113. ** See also: Rowid, MakeRecord.
  81114. */
  81115. case OP_DeferredSeek:
  81116. case OP_IdxRowid: { /* out2 */
  81117. VdbeCursor *pC; /* The P1 index cursor */
  81118. VdbeCursor *pTabCur; /* The P2 table cursor (OP_DeferredSeek only) */
  81119. i64 rowid; /* Rowid that P1 current points to */
  81120. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  81121. pC = p->apCsr[pOp->p1];
  81122. assert( pC!=0 );
  81123. assert( pC->eCurType==CURTYPE_BTREE );
  81124. assert( pC->uc.pCursor!=0 );
  81125. assert( pC->isTable==0 );
  81126. assert( pC->deferredMoveto==0 );
  81127. assert( !pC->nullRow || pOp->opcode==OP_IdxRowid );
  81128. /* The IdxRowid and Seek opcodes are combined because of the commonality
  81129. ** of sqlite3VdbeCursorRestore() and sqlite3VdbeIdxRowid(). */
  81130. rc = sqlite3VdbeCursorRestore(pC);
  81131. /* sqlite3VbeCursorRestore() can only fail if the record has been deleted
  81132. ** out from under the cursor. That will never happens for an IdxRowid
  81133. ** or Seek opcode */
  81134. if( NEVER(rc!=SQLITE_OK) ) goto abort_due_to_error;
  81135. if( !pC->nullRow ){
  81136. rowid = 0; /* Not needed. Only used to silence a warning. */
  81137. rc = sqlite3VdbeIdxRowid(db, pC->uc.pCursor, &rowid);
  81138. if( rc!=SQLITE_OK ){
  81139. goto abort_due_to_error;
  81140. }
  81141. if( pOp->opcode==OP_DeferredSeek ){
  81142. assert( pOp->p3>=0 && pOp->p3<p->nCursor );
  81143. pTabCur = p->apCsr[pOp->p3];
  81144. assert( pTabCur!=0 );
  81145. assert( pTabCur->eCurType==CURTYPE_BTREE );
  81146. assert( pTabCur->uc.pCursor!=0 );
  81147. assert( pTabCur->isTable );
  81148. pTabCur->nullRow = 0;
  81149. pTabCur->movetoTarget = rowid;
  81150. pTabCur->deferredMoveto = 1;
  81151. assert( pOp->p4type==P4_INTARRAY || pOp->p4.ai==0 );
  81152. pTabCur->aAltMap = pOp->p4.ai;
  81153. pTabCur->pAltCursor = pC;
  81154. }else{
  81155. pOut = out2Prerelease(p, pOp);
  81156. pOut->u.i = rowid;
  81157. }
  81158. }else{
  81159. assert( pOp->opcode==OP_IdxRowid );
  81160. sqlite3VdbeMemSetNull(&aMem[pOp->p2]);
  81161. }
  81162. break;
  81163. }
  81164. /* Opcode: IdxGE P1 P2 P3 P4 P5
  81165. ** Synopsis: key=r[P3@P4]
  81166. **
  81167. ** The P4 register values beginning with P3 form an unpacked index
  81168. ** key that omits the PRIMARY KEY. Compare this key value against the index
  81169. ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
  81170. ** fields at the end.
  81171. **
  81172. ** If the P1 index entry is greater than or equal to the key value
  81173. ** then jump to P2. Otherwise fall through to the next instruction.
  81174. */
  81175. /* Opcode: IdxGT P1 P2 P3 P4 P5
  81176. ** Synopsis: key=r[P3@P4]
  81177. **
  81178. ** The P4 register values beginning with P3 form an unpacked index
  81179. ** key that omits the PRIMARY KEY. Compare this key value against the index
  81180. ** that P1 is currently pointing to, ignoring the PRIMARY KEY or ROWID
  81181. ** fields at the end.
  81182. **
  81183. ** If the P1 index entry is greater than the key value
  81184. ** then jump to P2. Otherwise fall through to the next instruction.
  81185. */
  81186. /* Opcode: IdxLT P1 P2 P3 P4 P5
  81187. ** Synopsis: key=r[P3@P4]
  81188. **
  81189. ** The P4 register values beginning with P3 form an unpacked index
  81190. ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
  81191. ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
  81192. ** ROWID on the P1 index.
  81193. **
  81194. ** If the P1 index entry is less than the key value then jump to P2.
  81195. ** Otherwise fall through to the next instruction.
  81196. */
  81197. /* Opcode: IdxLE P1 P2 P3 P4 P5
  81198. ** Synopsis: key=r[P3@P4]
  81199. **
  81200. ** The P4 register values beginning with P3 form an unpacked index
  81201. ** key that omits the PRIMARY KEY or ROWID. Compare this key value against
  81202. ** the index that P1 is currently pointing to, ignoring the PRIMARY KEY or
  81203. ** ROWID on the P1 index.
  81204. **
  81205. ** If the P1 index entry is less than or equal to the key value then jump
  81206. ** to P2. Otherwise fall through to the next instruction.
  81207. */
  81208. case OP_IdxLE: /* jump */
  81209. case OP_IdxGT: /* jump */
  81210. case OP_IdxLT: /* jump */
  81211. case OP_IdxGE: { /* jump */
  81212. VdbeCursor *pC;
  81213. int res;
  81214. UnpackedRecord r;
  81215. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  81216. pC = p->apCsr[pOp->p1];
  81217. assert( pC!=0 );
  81218. assert( pC->isOrdered );
  81219. assert( pC->eCurType==CURTYPE_BTREE );
  81220. assert( pC->uc.pCursor!=0);
  81221. assert( pC->deferredMoveto==0 );
  81222. assert( pOp->p5==0 || pOp->p5==1 );
  81223. assert( pOp->p4type==P4_INT32 );
  81224. r.pKeyInfo = pC->pKeyInfo;
  81225. r.nField = (u16)pOp->p4.i;
  81226. if( pOp->opcode<OP_IdxLT ){
  81227. assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxGT );
  81228. r.default_rc = -1;
  81229. }else{
  81230. assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxLT );
  81231. r.default_rc = 0;
  81232. }
  81233. r.aMem = &aMem[pOp->p3];
  81234. #ifdef SQLITE_DEBUG
  81235. { int i; for(i=0; i<r.nField; i++) assert( memIsValid(&r.aMem[i]) ); }
  81236. #endif
  81237. res = 0; /* Not needed. Only used to silence a warning. */
  81238. rc = sqlite3VdbeIdxKeyCompare(db, pC, &r, &res);
  81239. assert( (OP_IdxLE&1)==(OP_IdxLT&1) && (OP_IdxGE&1)==(OP_IdxGT&1) );
  81240. if( (pOp->opcode&1)==(OP_IdxLT&1) ){
  81241. assert( pOp->opcode==OP_IdxLE || pOp->opcode==OP_IdxLT );
  81242. res = -res;
  81243. }else{
  81244. assert( pOp->opcode==OP_IdxGE || pOp->opcode==OP_IdxGT );
  81245. res++;
  81246. }
  81247. VdbeBranchTaken(res>0,2);
  81248. if( rc ) goto abort_due_to_error;
  81249. if( res>0 ) goto jump_to_p2;
  81250. break;
  81251. }
  81252. /* Opcode: Destroy P1 P2 P3 * *
  81253. **
  81254. ** Delete an entire database table or index whose root page in the database
  81255. ** file is given by P1.
  81256. **
  81257. ** The table being destroyed is in the main database file if P3==0. If
  81258. ** P3==1 then the table to be clear is in the auxiliary database file
  81259. ** that is used to store tables create using CREATE TEMPORARY TABLE.
  81260. **
  81261. ** If AUTOVACUUM is enabled then it is possible that another root page
  81262. ** might be moved into the newly deleted root page in order to keep all
  81263. ** root pages contiguous at the beginning of the database. The former
  81264. ** value of the root page that moved - its value before the move occurred -
  81265. ** is stored in register P2. If no page movement was required (because the
  81266. ** table being dropped was already the last one in the database) then a
  81267. ** zero is stored in register P2. If AUTOVACUUM is disabled then a zero
  81268. ** is stored in register P2.
  81269. **
  81270. ** This opcode throws an error if there are any active reader VMs when
  81271. ** it is invoked. This is done to avoid the difficulty associated with
  81272. ** updating existing cursors when a root page is moved in an AUTOVACUUM
  81273. ** database. This error is thrown even if the database is not an AUTOVACUUM
  81274. ** db in order to avoid introducing an incompatibility between autovacuum
  81275. ** and non-autovacuum modes.
  81276. **
  81277. ** See also: Clear
  81278. */
  81279. case OP_Destroy: { /* out2 */
  81280. int iMoved;
  81281. int iDb;
  81282. assert( p->readOnly==0 );
  81283. assert( pOp->p1>1 );
  81284. pOut = out2Prerelease(p, pOp);
  81285. pOut->flags = MEM_Null;
  81286. if( db->nVdbeRead > db->nVDestroy+1 ){
  81287. rc = SQLITE_LOCKED;
  81288. p->errorAction = OE_Abort;
  81289. goto abort_due_to_error;
  81290. }else{
  81291. iDb = pOp->p3;
  81292. assert( DbMaskTest(p->btreeMask, iDb) );
  81293. iMoved = 0; /* Not needed. Only to silence a warning. */
  81294. rc = sqlite3BtreeDropTable(db->aDb[iDb].pBt, pOp->p1, &iMoved);
  81295. pOut->flags = MEM_Int;
  81296. pOut->u.i = iMoved;
  81297. if( rc ) goto abort_due_to_error;
  81298. #ifndef SQLITE_OMIT_AUTOVACUUM
  81299. if( iMoved!=0 ){
  81300. sqlite3RootPageMoved(db, iDb, iMoved, pOp->p1);
  81301. /* All OP_Destroy operations occur on the same btree */
  81302. assert( resetSchemaOnFault==0 || resetSchemaOnFault==iDb+1 );
  81303. resetSchemaOnFault = iDb+1;
  81304. }
  81305. #endif
  81306. }
  81307. break;
  81308. }
  81309. /* Opcode: Clear P1 P2 P3
  81310. **
  81311. ** Delete all contents of the database table or index whose root page
  81312. ** in the database file is given by P1. But, unlike Destroy, do not
  81313. ** remove the table or index from the database file.
  81314. **
  81315. ** The table being clear is in the main database file if P2==0. If
  81316. ** P2==1 then the table to be clear is in the auxiliary database file
  81317. ** that is used to store tables create using CREATE TEMPORARY TABLE.
  81318. **
  81319. ** If the P3 value is non-zero, then the table referred to must be an
  81320. ** intkey table (an SQL table, not an index). In this case the row change
  81321. ** count is incremented by the number of rows in the table being cleared.
  81322. ** If P3 is greater than zero, then the value stored in register P3 is
  81323. ** also incremented by the number of rows in the table being cleared.
  81324. **
  81325. ** See also: Destroy
  81326. */
  81327. case OP_Clear: {
  81328. int nChange;
  81329. nChange = 0;
  81330. assert( p->readOnly==0 );
  81331. assert( DbMaskTest(p->btreeMask, pOp->p2) );
  81332. rc = sqlite3BtreeClearTable(
  81333. db->aDb[pOp->p2].pBt, pOp->p1, (pOp->p3 ? &nChange : 0)
  81334. );
  81335. if( pOp->p3 ){
  81336. p->nChange += nChange;
  81337. if( pOp->p3>0 ){
  81338. assert( memIsValid(&aMem[pOp->p3]) );
  81339. memAboutToChange(p, &aMem[pOp->p3]);
  81340. aMem[pOp->p3].u.i += nChange;
  81341. }
  81342. }
  81343. if( rc ) goto abort_due_to_error;
  81344. break;
  81345. }
  81346. /* Opcode: ResetSorter P1 * * * *
  81347. **
  81348. ** Delete all contents from the ephemeral table or sorter
  81349. ** that is open on cursor P1.
  81350. **
  81351. ** This opcode only works for cursors used for sorting and
  81352. ** opened with OP_OpenEphemeral or OP_SorterOpen.
  81353. */
  81354. case OP_ResetSorter: {
  81355. VdbeCursor *pC;
  81356. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  81357. pC = p->apCsr[pOp->p1];
  81358. assert( pC!=0 );
  81359. if( isSorter(pC) ){
  81360. sqlite3VdbeSorterReset(db, pC->uc.pSorter);
  81361. }else{
  81362. assert( pC->eCurType==CURTYPE_BTREE );
  81363. assert( pC->isEphemeral );
  81364. rc = sqlite3BtreeClearTableOfCursor(pC->uc.pCursor);
  81365. if( rc ) goto abort_due_to_error;
  81366. }
  81367. break;
  81368. }
  81369. /* Opcode: CreateBtree P1 P2 P3 * *
  81370. ** Synopsis: r[P2]=root iDb=P1 flags=P3
  81371. **
  81372. ** Allocate a new b-tree in the main database file if P1==0 or in the
  81373. ** TEMP database file if P1==1 or in an attached database if
  81374. ** P1>1. The P3 argument must be 1 (BTREE_INTKEY) for a rowid table
  81375. ** it must be 2 (BTREE_BLOBKEY) for a index or WITHOUT ROWID table.
  81376. ** The root page number of the new b-tree is stored in register P2.
  81377. */
  81378. case OP_CreateBtree: { /* out2 */
  81379. int pgno;
  81380. Db *pDb;
  81381. pOut = out2Prerelease(p, pOp);
  81382. pgno = 0;
  81383. assert( pOp->p3==BTREE_INTKEY || pOp->p3==BTREE_BLOBKEY );
  81384. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  81385. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  81386. assert( p->readOnly==0 );
  81387. pDb = &db->aDb[pOp->p1];
  81388. assert( pDb->pBt!=0 );
  81389. rc = sqlite3BtreeCreateTable(pDb->pBt, &pgno, pOp->p3);
  81390. if( rc ) goto abort_due_to_error;
  81391. pOut->u.i = pgno;
  81392. break;
  81393. }
  81394. /* Opcode: SqlExec * * * P4 *
  81395. **
  81396. ** Run the SQL statement or statements specified in the P4 string.
  81397. */
  81398. case OP_SqlExec: {
  81399. db->nSqlExec++;
  81400. rc = sqlite3_exec(db, pOp->p4.z, 0, 0, 0);
  81401. db->nSqlExec--;
  81402. if( rc ) goto abort_due_to_error;
  81403. break;
  81404. }
  81405. /* Opcode: ParseSchema P1 * * P4 *
  81406. **
  81407. ** Read and parse all entries from the SQLITE_MASTER table of database P1
  81408. ** that match the WHERE clause P4.
  81409. **
  81410. ** This opcode invokes the parser to create a new virtual machine,
  81411. ** then runs the new virtual machine. It is thus a re-entrant opcode.
  81412. */
  81413. case OP_ParseSchema: {
  81414. int iDb;
  81415. const char *zMaster;
  81416. char *zSql;
  81417. InitData initData;
  81418. /* Any prepared statement that invokes this opcode will hold mutexes
  81419. ** on every btree. This is a prerequisite for invoking
  81420. ** sqlite3InitCallback().
  81421. */
  81422. #ifdef SQLITE_DEBUG
  81423. for(iDb=0; iDb<db->nDb; iDb++){
  81424. assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
  81425. }
  81426. #endif
  81427. iDb = pOp->p1;
  81428. assert( iDb>=0 && iDb<db->nDb );
  81429. assert( DbHasProperty(db, iDb, DB_SchemaLoaded) );
  81430. /* Used to be a conditional */ {
  81431. zMaster = MASTER_NAME;
  81432. initData.db = db;
  81433. initData.iDb = pOp->p1;
  81434. initData.pzErrMsg = &p->zErrMsg;
  81435. zSql = sqlite3MPrintf(db,
  81436. "SELECT name, rootpage, sql FROM '%q'.%s WHERE %s ORDER BY rowid",
  81437. db->aDb[iDb].zDbSName, zMaster, pOp->p4.z);
  81438. if( zSql==0 ){
  81439. rc = SQLITE_NOMEM_BKPT;
  81440. }else{
  81441. assert( db->init.busy==0 );
  81442. db->init.busy = 1;
  81443. initData.rc = SQLITE_OK;
  81444. assert( !db->mallocFailed );
  81445. rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
  81446. if( rc==SQLITE_OK ) rc = initData.rc;
  81447. sqlite3DbFreeNN(db, zSql);
  81448. db->init.busy = 0;
  81449. }
  81450. }
  81451. if( rc ){
  81452. sqlite3ResetAllSchemasOfConnection(db);
  81453. if( rc==SQLITE_NOMEM ){
  81454. goto no_mem;
  81455. }
  81456. goto abort_due_to_error;
  81457. }
  81458. break;
  81459. }
  81460. #if !defined(SQLITE_OMIT_ANALYZE)
  81461. /* Opcode: LoadAnalysis P1 * * * *
  81462. **
  81463. ** Read the sqlite_stat1 table for database P1 and load the content
  81464. ** of that table into the internal index hash table. This will cause
  81465. ** the analysis to be used when preparing all subsequent queries.
  81466. */
  81467. case OP_LoadAnalysis: {
  81468. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  81469. rc = sqlite3AnalysisLoad(db, pOp->p1);
  81470. if( rc ) goto abort_due_to_error;
  81471. break;
  81472. }
  81473. #endif /* !defined(SQLITE_OMIT_ANALYZE) */
  81474. /* Opcode: DropTable P1 * * P4 *
  81475. **
  81476. ** Remove the internal (in-memory) data structures that describe
  81477. ** the table named P4 in database P1. This is called after a table
  81478. ** is dropped from disk (using the Destroy opcode) in order to keep
  81479. ** the internal representation of the
  81480. ** schema consistent with what is on disk.
  81481. */
  81482. case OP_DropTable: {
  81483. sqlite3UnlinkAndDeleteTable(db, pOp->p1, pOp->p4.z);
  81484. break;
  81485. }
  81486. /* Opcode: DropIndex P1 * * P4 *
  81487. **
  81488. ** Remove the internal (in-memory) data structures that describe
  81489. ** the index named P4 in database P1. This is called after an index
  81490. ** is dropped from disk (using the Destroy opcode)
  81491. ** in order to keep the internal representation of the
  81492. ** schema consistent with what is on disk.
  81493. */
  81494. case OP_DropIndex: {
  81495. sqlite3UnlinkAndDeleteIndex(db, pOp->p1, pOp->p4.z);
  81496. break;
  81497. }
  81498. /* Opcode: DropTrigger P1 * * P4 *
  81499. **
  81500. ** Remove the internal (in-memory) data structures that describe
  81501. ** the trigger named P4 in database P1. This is called after a trigger
  81502. ** is dropped from disk (using the Destroy opcode) in order to keep
  81503. ** the internal representation of the
  81504. ** schema consistent with what is on disk.
  81505. */
  81506. case OP_DropTrigger: {
  81507. sqlite3UnlinkAndDeleteTrigger(db, pOp->p1, pOp->p4.z);
  81508. break;
  81509. }
  81510. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  81511. /* Opcode: IntegrityCk P1 P2 P3 P4 P5
  81512. **
  81513. ** Do an analysis of the currently open database. Store in
  81514. ** register P1 the text of an error message describing any problems.
  81515. ** If no problems are found, store a NULL in register P1.
  81516. **
  81517. ** The register P3 contains one less than the maximum number of allowed errors.
  81518. ** At most reg(P3) errors will be reported.
  81519. ** In other words, the analysis stops as soon as reg(P1) errors are
  81520. ** seen. Reg(P1) is updated with the number of errors remaining.
  81521. **
  81522. ** The root page numbers of all tables in the database are integers
  81523. ** stored in P4_INTARRAY argument.
  81524. **
  81525. ** If P5 is not zero, the check is done on the auxiliary database
  81526. ** file, not the main database file.
  81527. **
  81528. ** This opcode is used to implement the integrity_check pragma.
  81529. */
  81530. case OP_IntegrityCk: {
  81531. int nRoot; /* Number of tables to check. (Number of root pages.) */
  81532. int *aRoot; /* Array of rootpage numbers for tables to be checked */
  81533. int nErr; /* Number of errors reported */
  81534. char *z; /* Text of the error report */
  81535. Mem *pnErr; /* Register keeping track of errors remaining */
  81536. assert( p->bIsReader );
  81537. nRoot = pOp->p2;
  81538. aRoot = pOp->p4.ai;
  81539. assert( nRoot>0 );
  81540. assert( aRoot[0]==nRoot );
  81541. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  81542. pnErr = &aMem[pOp->p3];
  81543. assert( (pnErr->flags & MEM_Int)!=0 );
  81544. assert( (pnErr->flags & (MEM_Str|MEM_Blob))==0 );
  81545. pIn1 = &aMem[pOp->p1];
  81546. assert( pOp->p5<db->nDb );
  81547. assert( DbMaskTest(p->btreeMask, pOp->p5) );
  81548. z = sqlite3BtreeIntegrityCheck(db->aDb[pOp->p5].pBt, &aRoot[1], nRoot,
  81549. (int)pnErr->u.i+1, &nErr);
  81550. sqlite3VdbeMemSetNull(pIn1);
  81551. if( nErr==0 ){
  81552. assert( z==0 );
  81553. }else if( z==0 ){
  81554. goto no_mem;
  81555. }else{
  81556. pnErr->u.i -= nErr-1;
  81557. sqlite3VdbeMemSetStr(pIn1, z, -1, SQLITE_UTF8, sqlite3_free);
  81558. }
  81559. UPDATE_MAX_BLOBSIZE(pIn1);
  81560. sqlite3VdbeChangeEncoding(pIn1, encoding);
  81561. break;
  81562. }
  81563. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  81564. /* Opcode: RowSetAdd P1 P2 * * *
  81565. ** Synopsis: rowset(P1)=r[P2]
  81566. **
  81567. ** Insert the integer value held by register P2 into a RowSet object
  81568. ** held in register P1.
  81569. **
  81570. ** An assertion fails if P2 is not an integer.
  81571. */
  81572. case OP_RowSetAdd: { /* in1, in2 */
  81573. pIn1 = &aMem[pOp->p1];
  81574. pIn2 = &aMem[pOp->p2];
  81575. assert( (pIn2->flags & MEM_Int)!=0 );
  81576. if( (pIn1->flags & MEM_RowSet)==0 ){
  81577. sqlite3VdbeMemSetRowSet(pIn1);
  81578. if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
  81579. }
  81580. sqlite3RowSetInsert(pIn1->u.pRowSet, pIn2->u.i);
  81581. break;
  81582. }
  81583. /* Opcode: RowSetRead P1 P2 P3 * *
  81584. ** Synopsis: r[P3]=rowset(P1)
  81585. **
  81586. ** Extract the smallest value from the RowSet object in P1
  81587. ** and put that value into register P3.
  81588. ** Or, if RowSet object P1 is initially empty, leave P3
  81589. ** unchanged and jump to instruction P2.
  81590. */
  81591. case OP_RowSetRead: { /* jump, in1, out3 */
  81592. i64 val;
  81593. pIn1 = &aMem[pOp->p1];
  81594. if( (pIn1->flags & MEM_RowSet)==0
  81595. || sqlite3RowSetNext(pIn1->u.pRowSet, &val)==0
  81596. ){
  81597. /* The boolean index is empty */
  81598. sqlite3VdbeMemSetNull(pIn1);
  81599. VdbeBranchTaken(1,2);
  81600. goto jump_to_p2_and_check_for_interrupt;
  81601. }else{
  81602. /* A value was pulled from the index */
  81603. VdbeBranchTaken(0,2);
  81604. sqlite3VdbeMemSetInt64(&aMem[pOp->p3], val);
  81605. }
  81606. goto check_for_interrupt;
  81607. }
  81608. /* Opcode: RowSetTest P1 P2 P3 P4
  81609. ** Synopsis: if r[P3] in rowset(P1) goto P2
  81610. **
  81611. ** Register P3 is assumed to hold a 64-bit integer value. If register P1
  81612. ** contains a RowSet object and that RowSet object contains
  81613. ** the value held in P3, jump to register P2. Otherwise, insert the
  81614. ** integer in P3 into the RowSet and continue on to the
  81615. ** next opcode.
  81616. **
  81617. ** The RowSet object is optimized for the case where sets of integers
  81618. ** are inserted in distinct phases, which each set contains no duplicates.
  81619. ** Each set is identified by a unique P4 value. The first set
  81620. ** must have P4==0, the final set must have P4==-1, and for all other sets
  81621. ** must have P4>0.
  81622. **
  81623. ** This allows optimizations: (a) when P4==0 there is no need to test
  81624. ** the RowSet object for P3, as it is guaranteed not to contain it,
  81625. ** (b) when P4==-1 there is no need to insert the value, as it will
  81626. ** never be tested for, and (c) when a value that is part of set X is
  81627. ** inserted, there is no need to search to see if the same value was
  81628. ** previously inserted as part of set X (only if it was previously
  81629. ** inserted as part of some other set).
  81630. */
  81631. case OP_RowSetTest: { /* jump, in1, in3 */
  81632. int iSet;
  81633. int exists;
  81634. pIn1 = &aMem[pOp->p1];
  81635. pIn3 = &aMem[pOp->p3];
  81636. iSet = pOp->p4.i;
  81637. assert( pIn3->flags&MEM_Int );
  81638. /* If there is anything other than a rowset object in memory cell P1,
  81639. ** delete it now and initialize P1 with an empty rowset
  81640. */
  81641. if( (pIn1->flags & MEM_RowSet)==0 ){
  81642. sqlite3VdbeMemSetRowSet(pIn1);
  81643. if( (pIn1->flags & MEM_RowSet)==0 ) goto no_mem;
  81644. }
  81645. assert( pOp->p4type==P4_INT32 );
  81646. assert( iSet==-1 || iSet>=0 );
  81647. if( iSet ){
  81648. exists = sqlite3RowSetTest(pIn1->u.pRowSet, iSet, pIn3->u.i);
  81649. VdbeBranchTaken(exists!=0,2);
  81650. if( exists ) goto jump_to_p2;
  81651. }
  81652. if( iSet>=0 ){
  81653. sqlite3RowSetInsert(pIn1->u.pRowSet, pIn3->u.i);
  81654. }
  81655. break;
  81656. }
  81657. #ifndef SQLITE_OMIT_TRIGGER
  81658. /* Opcode: Program P1 P2 P3 P4 P5
  81659. **
  81660. ** Execute the trigger program passed as P4 (type P4_SUBPROGRAM).
  81661. **
  81662. ** P1 contains the address of the memory cell that contains the first memory
  81663. ** cell in an array of values used as arguments to the sub-program. P2
  81664. ** contains the address to jump to if the sub-program throws an IGNORE
  81665. ** exception using the RAISE() function. Register P3 contains the address
  81666. ** of a memory cell in this (the parent) VM that is used to allocate the
  81667. ** memory required by the sub-vdbe at runtime.
  81668. **
  81669. ** P4 is a pointer to the VM containing the trigger program.
  81670. **
  81671. ** If P5 is non-zero, then recursive program invocation is enabled.
  81672. */
  81673. case OP_Program: { /* jump */
  81674. int nMem; /* Number of memory registers for sub-program */
  81675. int nByte; /* Bytes of runtime space required for sub-program */
  81676. Mem *pRt; /* Register to allocate runtime space */
  81677. Mem *pMem; /* Used to iterate through memory cells */
  81678. Mem *pEnd; /* Last memory cell in new array */
  81679. VdbeFrame *pFrame; /* New vdbe frame to execute in */
  81680. SubProgram *pProgram; /* Sub-program to execute */
  81681. void *t; /* Token identifying trigger */
  81682. pProgram = pOp->p4.pProgram;
  81683. pRt = &aMem[pOp->p3];
  81684. assert( pProgram->nOp>0 );
  81685. /* If the p5 flag is clear, then recursive invocation of triggers is
  81686. ** disabled for backwards compatibility (p5 is set if this sub-program
  81687. ** is really a trigger, not a foreign key action, and the flag set
  81688. ** and cleared by the "PRAGMA recursive_triggers" command is clear).
  81689. **
  81690. ** It is recursive invocation of triggers, at the SQL level, that is
  81691. ** disabled. In some cases a single trigger may generate more than one
  81692. ** SubProgram (if the trigger may be executed with more than one different
  81693. ** ON CONFLICT algorithm). SubProgram structures associated with a
  81694. ** single trigger all have the same value for the SubProgram.token
  81695. ** variable. */
  81696. if( pOp->p5 ){
  81697. t = pProgram->token;
  81698. for(pFrame=p->pFrame; pFrame && pFrame->token!=t; pFrame=pFrame->pParent);
  81699. if( pFrame ) break;
  81700. }
  81701. if( p->nFrame>=db->aLimit[SQLITE_LIMIT_TRIGGER_DEPTH] ){
  81702. rc = SQLITE_ERROR;
  81703. sqlite3VdbeError(p, "too many levels of trigger recursion");
  81704. goto abort_due_to_error;
  81705. }
  81706. /* Register pRt is used to store the memory required to save the state
  81707. ** of the current program, and the memory required at runtime to execute
  81708. ** the trigger program. If this trigger has been fired before, then pRt
  81709. ** is already allocated. Otherwise, it must be initialized. */
  81710. if( (pRt->flags&MEM_Frame)==0 ){
  81711. /* SubProgram.nMem is set to the number of memory cells used by the
  81712. ** program stored in SubProgram.aOp. As well as these, one memory
  81713. ** cell is required for each cursor used by the program. Set local
  81714. ** variable nMem (and later, VdbeFrame.nChildMem) to this value.
  81715. */
  81716. nMem = pProgram->nMem + pProgram->nCsr;
  81717. assert( nMem>0 );
  81718. if( pProgram->nCsr==0 ) nMem++;
  81719. nByte = ROUND8(sizeof(VdbeFrame))
  81720. + nMem * sizeof(Mem)
  81721. + pProgram->nCsr * sizeof(VdbeCursor*)
  81722. + (pProgram->nOp + 7)/8;
  81723. pFrame = sqlite3DbMallocZero(db, nByte);
  81724. if( !pFrame ){
  81725. goto no_mem;
  81726. }
  81727. sqlite3VdbeMemRelease(pRt);
  81728. pRt->flags = MEM_Frame;
  81729. pRt->u.pFrame = pFrame;
  81730. pFrame->v = p;
  81731. pFrame->nChildMem = nMem;
  81732. pFrame->nChildCsr = pProgram->nCsr;
  81733. pFrame->pc = (int)(pOp - aOp);
  81734. pFrame->aMem = p->aMem;
  81735. pFrame->nMem = p->nMem;
  81736. pFrame->apCsr = p->apCsr;
  81737. pFrame->nCursor = p->nCursor;
  81738. pFrame->aOp = p->aOp;
  81739. pFrame->nOp = p->nOp;
  81740. pFrame->token = pProgram->token;
  81741. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  81742. pFrame->anExec = p->anExec;
  81743. #endif
  81744. pEnd = &VdbeFrameMem(pFrame)[pFrame->nChildMem];
  81745. for(pMem=VdbeFrameMem(pFrame); pMem!=pEnd; pMem++){
  81746. pMem->flags = MEM_Undefined;
  81747. pMem->db = db;
  81748. }
  81749. }else{
  81750. pFrame = pRt->u.pFrame;
  81751. assert( pProgram->nMem+pProgram->nCsr==pFrame->nChildMem
  81752. || (pProgram->nCsr==0 && pProgram->nMem+1==pFrame->nChildMem) );
  81753. assert( pProgram->nCsr==pFrame->nChildCsr );
  81754. assert( (int)(pOp - aOp)==pFrame->pc );
  81755. }
  81756. p->nFrame++;
  81757. pFrame->pParent = p->pFrame;
  81758. pFrame->lastRowid = db->lastRowid;
  81759. pFrame->nChange = p->nChange;
  81760. pFrame->nDbChange = p->db->nChange;
  81761. assert( pFrame->pAuxData==0 );
  81762. pFrame->pAuxData = p->pAuxData;
  81763. p->pAuxData = 0;
  81764. p->nChange = 0;
  81765. p->pFrame = pFrame;
  81766. p->aMem = aMem = VdbeFrameMem(pFrame);
  81767. p->nMem = pFrame->nChildMem;
  81768. p->nCursor = (u16)pFrame->nChildCsr;
  81769. p->apCsr = (VdbeCursor **)&aMem[p->nMem];
  81770. pFrame->aOnce = (u8*)&p->apCsr[pProgram->nCsr];
  81771. memset(pFrame->aOnce, 0, (pProgram->nOp + 7)/8);
  81772. p->aOp = aOp = pProgram->aOp;
  81773. p->nOp = pProgram->nOp;
  81774. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  81775. p->anExec = 0;
  81776. #endif
  81777. pOp = &aOp[-1];
  81778. break;
  81779. }
  81780. /* Opcode: Param P1 P2 * * *
  81781. **
  81782. ** This opcode is only ever present in sub-programs called via the
  81783. ** OP_Program instruction. Copy a value currently stored in a memory
  81784. ** cell of the calling (parent) frame to cell P2 in the current frames
  81785. ** address space. This is used by trigger programs to access the new.*
  81786. ** and old.* values.
  81787. **
  81788. ** The address of the cell in the parent frame is determined by adding
  81789. ** the value of the P1 argument to the value of the P1 argument to the
  81790. ** calling OP_Program instruction.
  81791. */
  81792. case OP_Param: { /* out2 */
  81793. VdbeFrame *pFrame;
  81794. Mem *pIn;
  81795. pOut = out2Prerelease(p, pOp);
  81796. pFrame = p->pFrame;
  81797. pIn = &pFrame->aMem[pOp->p1 + pFrame->aOp[pFrame->pc].p1];
  81798. sqlite3VdbeMemShallowCopy(pOut, pIn, MEM_Ephem);
  81799. break;
  81800. }
  81801. #endif /* #ifndef SQLITE_OMIT_TRIGGER */
  81802. #ifndef SQLITE_OMIT_FOREIGN_KEY
  81803. /* Opcode: FkCounter P1 P2 * * *
  81804. ** Synopsis: fkctr[P1]+=P2
  81805. **
  81806. ** Increment a "constraint counter" by P2 (P2 may be negative or positive).
  81807. ** If P1 is non-zero, the database constraint counter is incremented
  81808. ** (deferred foreign key constraints). Otherwise, if P1 is zero, the
  81809. ** statement counter is incremented (immediate foreign key constraints).
  81810. */
  81811. case OP_FkCounter: {
  81812. if( db->flags & SQLITE_DeferFKs ){
  81813. db->nDeferredImmCons += pOp->p2;
  81814. }else if( pOp->p1 ){
  81815. db->nDeferredCons += pOp->p2;
  81816. }else{
  81817. p->nFkConstraint += pOp->p2;
  81818. }
  81819. break;
  81820. }
  81821. /* Opcode: FkIfZero P1 P2 * * *
  81822. ** Synopsis: if fkctr[P1]==0 goto P2
  81823. **
  81824. ** This opcode tests if a foreign key constraint-counter is currently zero.
  81825. ** If so, jump to instruction P2. Otherwise, fall through to the next
  81826. ** instruction.
  81827. **
  81828. ** If P1 is non-zero, then the jump is taken if the database constraint-counter
  81829. ** is zero (the one that counts deferred constraint violations). If P1 is
  81830. ** zero, the jump is taken if the statement constraint-counter is zero
  81831. ** (immediate foreign key constraint violations).
  81832. */
  81833. case OP_FkIfZero: { /* jump */
  81834. if( pOp->p1 ){
  81835. VdbeBranchTaken(db->nDeferredCons==0 && db->nDeferredImmCons==0, 2);
  81836. if( db->nDeferredCons==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
  81837. }else{
  81838. VdbeBranchTaken(p->nFkConstraint==0 && db->nDeferredImmCons==0, 2);
  81839. if( p->nFkConstraint==0 && db->nDeferredImmCons==0 ) goto jump_to_p2;
  81840. }
  81841. break;
  81842. }
  81843. #endif /* #ifndef SQLITE_OMIT_FOREIGN_KEY */
  81844. #ifndef SQLITE_OMIT_AUTOINCREMENT
  81845. /* Opcode: MemMax P1 P2 * * *
  81846. ** Synopsis: r[P1]=max(r[P1],r[P2])
  81847. **
  81848. ** P1 is a register in the root frame of this VM (the root frame is
  81849. ** different from the current frame if this instruction is being executed
  81850. ** within a sub-program). Set the value of register P1 to the maximum of
  81851. ** its current value and the value in register P2.
  81852. **
  81853. ** This instruction throws an error if the memory cell is not initially
  81854. ** an integer.
  81855. */
  81856. case OP_MemMax: { /* in2 */
  81857. VdbeFrame *pFrame;
  81858. if( p->pFrame ){
  81859. for(pFrame=p->pFrame; pFrame->pParent; pFrame=pFrame->pParent);
  81860. pIn1 = &pFrame->aMem[pOp->p1];
  81861. }else{
  81862. pIn1 = &aMem[pOp->p1];
  81863. }
  81864. assert( memIsValid(pIn1) );
  81865. sqlite3VdbeMemIntegerify(pIn1);
  81866. pIn2 = &aMem[pOp->p2];
  81867. sqlite3VdbeMemIntegerify(pIn2);
  81868. if( pIn1->u.i<pIn2->u.i){
  81869. pIn1->u.i = pIn2->u.i;
  81870. }
  81871. break;
  81872. }
  81873. #endif /* SQLITE_OMIT_AUTOINCREMENT */
  81874. /* Opcode: IfPos P1 P2 P3 * *
  81875. ** Synopsis: if r[P1]>0 then r[P1]-=P3, goto P2
  81876. **
  81877. ** Register P1 must contain an integer.
  81878. ** If the value of register P1 is 1 or greater, subtract P3 from the
  81879. ** value in P1 and jump to P2.
  81880. **
  81881. ** If the initial value of register P1 is less than 1, then the
  81882. ** value is unchanged and control passes through to the next instruction.
  81883. */
  81884. case OP_IfPos: { /* jump, in1 */
  81885. pIn1 = &aMem[pOp->p1];
  81886. assert( pIn1->flags&MEM_Int );
  81887. VdbeBranchTaken( pIn1->u.i>0, 2);
  81888. if( pIn1->u.i>0 ){
  81889. pIn1->u.i -= pOp->p3;
  81890. goto jump_to_p2;
  81891. }
  81892. break;
  81893. }
  81894. /* Opcode: OffsetLimit P1 P2 P3 * *
  81895. ** Synopsis: if r[P1]>0 then r[P2]=r[P1]+max(0,r[P3]) else r[P2]=(-1)
  81896. **
  81897. ** This opcode performs a commonly used computation associated with
  81898. ** LIMIT and OFFSET process. r[P1] holds the limit counter. r[P3]
  81899. ** holds the offset counter. The opcode computes the combined value
  81900. ** of the LIMIT and OFFSET and stores that value in r[P2]. The r[P2]
  81901. ** value computed is the total number of rows that will need to be
  81902. ** visited in order to complete the query.
  81903. **
  81904. ** If r[P3] is zero or negative, that means there is no OFFSET
  81905. ** and r[P2] is set to be the value of the LIMIT, r[P1].
  81906. **
  81907. ** if r[P1] is zero or negative, that means there is no LIMIT
  81908. ** and r[P2] is set to -1.
  81909. **
  81910. ** Otherwise, r[P2] is set to the sum of r[P1] and r[P3].
  81911. */
  81912. case OP_OffsetLimit: { /* in1, out2, in3 */
  81913. i64 x;
  81914. pIn1 = &aMem[pOp->p1];
  81915. pIn3 = &aMem[pOp->p3];
  81916. pOut = out2Prerelease(p, pOp);
  81917. assert( pIn1->flags & MEM_Int );
  81918. assert( pIn3->flags & MEM_Int );
  81919. x = pIn1->u.i;
  81920. if( x<=0 || sqlite3AddInt64(&x, pIn3->u.i>0?pIn3->u.i:0) ){
  81921. /* If the LIMIT is less than or equal to zero, loop forever. This
  81922. ** is documented. But also, if the LIMIT+OFFSET exceeds 2^63 then
  81923. ** also loop forever. This is undocumented. In fact, one could argue
  81924. ** that the loop should terminate. But assuming 1 billion iterations
  81925. ** per second (far exceeding the capabilities of any current hardware)
  81926. ** it would take nearly 300 years to actually reach the limit. So
  81927. ** looping forever is a reasonable approximation. */
  81928. pOut->u.i = -1;
  81929. }else{
  81930. pOut->u.i = x;
  81931. }
  81932. break;
  81933. }
  81934. /* Opcode: IfNotZero P1 P2 * * *
  81935. ** Synopsis: if r[P1]!=0 then r[P1]--, goto P2
  81936. **
  81937. ** Register P1 must contain an integer. If the content of register P1 is
  81938. ** initially greater than zero, then decrement the value in register P1.
  81939. ** If it is non-zero (negative or positive) and then also jump to P2.
  81940. ** If register P1 is initially zero, leave it unchanged and fall through.
  81941. */
  81942. case OP_IfNotZero: { /* jump, in1 */
  81943. pIn1 = &aMem[pOp->p1];
  81944. assert( pIn1->flags&MEM_Int );
  81945. VdbeBranchTaken(pIn1->u.i<0, 2);
  81946. if( pIn1->u.i ){
  81947. if( pIn1->u.i>0 ) pIn1->u.i--;
  81948. goto jump_to_p2;
  81949. }
  81950. break;
  81951. }
  81952. /* Opcode: DecrJumpZero P1 P2 * * *
  81953. ** Synopsis: if (--r[P1])==0 goto P2
  81954. **
  81955. ** Register P1 must hold an integer. Decrement the value in P1
  81956. ** and jump to P2 if the new value is exactly zero.
  81957. */
  81958. case OP_DecrJumpZero: { /* jump, in1 */
  81959. pIn1 = &aMem[pOp->p1];
  81960. assert( pIn1->flags&MEM_Int );
  81961. if( pIn1->u.i>SMALLEST_INT64 ) pIn1->u.i--;
  81962. VdbeBranchTaken(pIn1->u.i==0, 2);
  81963. if( pIn1->u.i==0 ) goto jump_to_p2;
  81964. break;
  81965. }
  81966. /* Opcode: AggStep0 * P2 P3 P4 P5
  81967. ** Synopsis: accum=r[P3] step(r[P2@P5])
  81968. **
  81969. ** Execute the step function for an aggregate. The
  81970. ** function has P5 arguments. P4 is a pointer to the FuncDef
  81971. ** structure that specifies the function. Register P3 is the
  81972. ** accumulator.
  81973. **
  81974. ** The P5 arguments are taken from register P2 and its
  81975. ** successors.
  81976. */
  81977. /* Opcode: AggStep * P2 P3 P4 P5
  81978. ** Synopsis: accum=r[P3] step(r[P2@P5])
  81979. **
  81980. ** Execute the step function for an aggregate. The
  81981. ** function has P5 arguments. P4 is a pointer to an sqlite3_context
  81982. ** object that is used to run the function. Register P3 is
  81983. ** as the accumulator.
  81984. **
  81985. ** The P5 arguments are taken from register P2 and its
  81986. ** successors.
  81987. **
  81988. ** This opcode is initially coded as OP_AggStep0. On first evaluation,
  81989. ** the FuncDef stored in P4 is converted into an sqlite3_context and
  81990. ** the opcode is changed. In this way, the initialization of the
  81991. ** sqlite3_context only happens once, instead of on each call to the
  81992. ** step function.
  81993. */
  81994. case OP_AggStep0: {
  81995. int n;
  81996. sqlite3_context *pCtx;
  81997. assert( pOp->p4type==P4_FUNCDEF );
  81998. n = pOp->p5;
  81999. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  82000. assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
  82001. assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
  82002. pCtx = sqlite3DbMallocRawNN(db, n*sizeof(sqlite3_value*) +
  82003. (sizeof(pCtx[0]) + sizeof(Mem) - sizeof(sqlite3_value*)));
  82004. if( pCtx==0 ) goto no_mem;
  82005. pCtx->pMem = 0;
  82006. pCtx->pOut = (Mem*)&(pCtx->argv[n]);
  82007. sqlite3VdbeMemInit(pCtx->pOut, db, MEM_Null);
  82008. pCtx->pFunc = pOp->p4.pFunc;
  82009. pCtx->iOp = (int)(pOp - aOp);
  82010. pCtx->pVdbe = p;
  82011. pCtx->skipFlag = 0;
  82012. pCtx->isError = 0;
  82013. pCtx->argc = n;
  82014. pOp->p4type = P4_FUNCCTX;
  82015. pOp->p4.pCtx = pCtx;
  82016. pOp->opcode = OP_AggStep;
  82017. /* Fall through into OP_AggStep */
  82018. }
  82019. case OP_AggStep: {
  82020. int i;
  82021. sqlite3_context *pCtx;
  82022. Mem *pMem;
  82023. assert( pOp->p4type==P4_FUNCCTX );
  82024. pCtx = pOp->p4.pCtx;
  82025. pMem = &aMem[pOp->p3];
  82026. /* If this function is inside of a trigger, the register array in aMem[]
  82027. ** might change from one evaluation to the next. The next block of code
  82028. ** checks to see if the register array has changed, and if so it
  82029. ** reinitializes the relavant parts of the sqlite3_context object */
  82030. if( pCtx->pMem != pMem ){
  82031. pCtx->pMem = pMem;
  82032. for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
  82033. }
  82034. #ifdef SQLITE_DEBUG
  82035. for(i=0; i<pCtx->argc; i++){
  82036. assert( memIsValid(pCtx->argv[i]) );
  82037. REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
  82038. }
  82039. #endif
  82040. pMem->n++;
  82041. assert( pCtx->pOut->flags==MEM_Null );
  82042. assert( pCtx->isError==0 );
  82043. assert( pCtx->skipFlag==0 );
  82044. (pCtx->pFunc->xSFunc)(pCtx,pCtx->argc,pCtx->argv); /* IMP: R-24505-23230 */
  82045. if( pCtx->isError ){
  82046. if( pCtx->isError>0 ){
  82047. sqlite3VdbeError(p, "%s", sqlite3_value_text(pCtx->pOut));
  82048. rc = pCtx->isError;
  82049. }
  82050. if( pCtx->skipFlag ){
  82051. assert( pOp[-1].opcode==OP_CollSeq );
  82052. i = pOp[-1].p1;
  82053. if( i ) sqlite3VdbeMemSetInt64(&aMem[i], 1);
  82054. pCtx->skipFlag = 0;
  82055. }
  82056. sqlite3VdbeMemRelease(pCtx->pOut);
  82057. pCtx->pOut->flags = MEM_Null;
  82058. pCtx->isError = 0;
  82059. if( rc ) goto abort_due_to_error;
  82060. }
  82061. assert( pCtx->pOut->flags==MEM_Null );
  82062. assert( pCtx->skipFlag==0 );
  82063. break;
  82064. }
  82065. /* Opcode: AggFinal P1 P2 * P4 *
  82066. ** Synopsis: accum=r[P1] N=P2
  82067. **
  82068. ** Execute the finalizer function for an aggregate. P1 is
  82069. ** the memory location that is the accumulator for the aggregate.
  82070. **
  82071. ** P2 is the number of arguments that the step function takes and
  82072. ** P4 is a pointer to the FuncDef for this function. The P2
  82073. ** argument is not used by this opcode. It is only there to disambiguate
  82074. ** functions that can take varying numbers of arguments. The
  82075. ** P4 argument is only needed for the degenerate case where
  82076. ** the step function was not previously called.
  82077. */
  82078. case OP_AggFinal: {
  82079. Mem *pMem;
  82080. assert( pOp->p1>0 && pOp->p1<=(p->nMem+1 - p->nCursor) );
  82081. pMem = &aMem[pOp->p1];
  82082. assert( (pMem->flags & ~(MEM_Null|MEM_Agg))==0 );
  82083. rc = sqlite3VdbeMemFinalize(pMem, pOp->p4.pFunc);
  82084. if( rc ){
  82085. sqlite3VdbeError(p, "%s", sqlite3_value_text(pMem));
  82086. goto abort_due_to_error;
  82087. }
  82088. sqlite3VdbeChangeEncoding(pMem, encoding);
  82089. UPDATE_MAX_BLOBSIZE(pMem);
  82090. if( sqlite3VdbeMemTooBig(pMem) ){
  82091. goto too_big;
  82092. }
  82093. break;
  82094. }
  82095. #ifndef SQLITE_OMIT_WAL
  82096. /* Opcode: Checkpoint P1 P2 P3 * *
  82097. **
  82098. ** Checkpoint database P1. This is a no-op if P1 is not currently in
  82099. ** WAL mode. Parameter P2 is one of SQLITE_CHECKPOINT_PASSIVE, FULL,
  82100. ** RESTART, or TRUNCATE. Write 1 or 0 into mem[P3] if the checkpoint returns
  82101. ** SQLITE_BUSY or not, respectively. Write the number of pages in the
  82102. ** WAL after the checkpoint into mem[P3+1] and the number of pages
  82103. ** in the WAL that have been checkpointed after the checkpoint
  82104. ** completes into mem[P3+2]. However on an error, mem[P3+1] and
  82105. ** mem[P3+2] are initialized to -1.
  82106. */
  82107. case OP_Checkpoint: {
  82108. int i; /* Loop counter */
  82109. int aRes[3]; /* Results */
  82110. Mem *pMem; /* Write results here */
  82111. assert( p->readOnly==0 );
  82112. aRes[0] = 0;
  82113. aRes[1] = aRes[2] = -1;
  82114. assert( pOp->p2==SQLITE_CHECKPOINT_PASSIVE
  82115. || pOp->p2==SQLITE_CHECKPOINT_FULL
  82116. || pOp->p2==SQLITE_CHECKPOINT_RESTART
  82117. || pOp->p2==SQLITE_CHECKPOINT_TRUNCATE
  82118. );
  82119. rc = sqlite3Checkpoint(db, pOp->p1, pOp->p2, &aRes[1], &aRes[2]);
  82120. if( rc ){
  82121. if( rc!=SQLITE_BUSY ) goto abort_due_to_error;
  82122. rc = SQLITE_OK;
  82123. aRes[0] = 1;
  82124. }
  82125. for(i=0, pMem = &aMem[pOp->p3]; i<3; i++, pMem++){
  82126. sqlite3VdbeMemSetInt64(pMem, (i64)aRes[i]);
  82127. }
  82128. break;
  82129. };
  82130. #endif
  82131. #ifndef SQLITE_OMIT_PRAGMA
  82132. /* Opcode: JournalMode P1 P2 P3 * *
  82133. **
  82134. ** Change the journal mode of database P1 to P3. P3 must be one of the
  82135. ** PAGER_JOURNALMODE_XXX values. If changing between the various rollback
  82136. ** modes (delete, truncate, persist, off and memory), this is a simple
  82137. ** operation. No IO is required.
  82138. **
  82139. ** If changing into or out of WAL mode the procedure is more complicated.
  82140. **
  82141. ** Write a string containing the final journal-mode to register P2.
  82142. */
  82143. case OP_JournalMode: { /* out2 */
  82144. Btree *pBt; /* Btree to change journal mode of */
  82145. Pager *pPager; /* Pager associated with pBt */
  82146. int eNew; /* New journal mode */
  82147. int eOld; /* The old journal mode */
  82148. #ifndef SQLITE_OMIT_WAL
  82149. const char *zFilename; /* Name of database file for pPager */
  82150. #endif
  82151. pOut = out2Prerelease(p, pOp);
  82152. eNew = pOp->p3;
  82153. assert( eNew==PAGER_JOURNALMODE_DELETE
  82154. || eNew==PAGER_JOURNALMODE_TRUNCATE
  82155. || eNew==PAGER_JOURNALMODE_PERSIST
  82156. || eNew==PAGER_JOURNALMODE_OFF
  82157. || eNew==PAGER_JOURNALMODE_MEMORY
  82158. || eNew==PAGER_JOURNALMODE_WAL
  82159. || eNew==PAGER_JOURNALMODE_QUERY
  82160. );
  82161. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  82162. assert( p->readOnly==0 );
  82163. pBt = db->aDb[pOp->p1].pBt;
  82164. pPager = sqlite3BtreePager(pBt);
  82165. eOld = sqlite3PagerGetJournalMode(pPager);
  82166. if( eNew==PAGER_JOURNALMODE_QUERY ) eNew = eOld;
  82167. if( !sqlite3PagerOkToChangeJournalMode(pPager) ) eNew = eOld;
  82168. #ifndef SQLITE_OMIT_WAL
  82169. zFilename = sqlite3PagerFilename(pPager, 1);
  82170. /* Do not allow a transition to journal_mode=WAL for a database
  82171. ** in temporary storage or if the VFS does not support shared memory
  82172. */
  82173. if( eNew==PAGER_JOURNALMODE_WAL
  82174. && (sqlite3Strlen30(zFilename)==0 /* Temp file */
  82175. || !sqlite3PagerWalSupported(pPager)) /* No shared-memory support */
  82176. ){
  82177. eNew = eOld;
  82178. }
  82179. if( (eNew!=eOld)
  82180. && (eOld==PAGER_JOURNALMODE_WAL || eNew==PAGER_JOURNALMODE_WAL)
  82181. ){
  82182. if( !db->autoCommit || db->nVdbeRead>1 ){
  82183. rc = SQLITE_ERROR;
  82184. sqlite3VdbeError(p,
  82185. "cannot change %s wal mode from within a transaction",
  82186. (eNew==PAGER_JOURNALMODE_WAL ? "into" : "out of")
  82187. );
  82188. goto abort_due_to_error;
  82189. }else{
  82190. if( eOld==PAGER_JOURNALMODE_WAL ){
  82191. /* If leaving WAL mode, close the log file. If successful, the call
  82192. ** to PagerCloseWal() checkpoints and deletes the write-ahead-log
  82193. ** file. An EXCLUSIVE lock may still be held on the database file
  82194. ** after a successful return.
  82195. */
  82196. rc = sqlite3PagerCloseWal(pPager, db);
  82197. if( rc==SQLITE_OK ){
  82198. sqlite3PagerSetJournalMode(pPager, eNew);
  82199. }
  82200. }else if( eOld==PAGER_JOURNALMODE_MEMORY ){
  82201. /* Cannot transition directly from MEMORY to WAL. Use mode OFF
  82202. ** as an intermediate */
  82203. sqlite3PagerSetJournalMode(pPager, PAGER_JOURNALMODE_OFF);
  82204. }
  82205. /* Open a transaction on the database file. Regardless of the journal
  82206. ** mode, this transaction always uses a rollback journal.
  82207. */
  82208. assert( sqlite3BtreeIsInTrans(pBt)==0 );
  82209. if( rc==SQLITE_OK ){
  82210. rc = sqlite3BtreeSetVersion(pBt, (eNew==PAGER_JOURNALMODE_WAL ? 2 : 1));
  82211. }
  82212. }
  82213. }
  82214. #endif /* ifndef SQLITE_OMIT_WAL */
  82215. if( rc ) eNew = eOld;
  82216. eNew = sqlite3PagerSetJournalMode(pPager, eNew);
  82217. pOut->flags = MEM_Str|MEM_Static|MEM_Term;
  82218. pOut->z = (char *)sqlite3JournalModename(eNew);
  82219. pOut->n = sqlite3Strlen30(pOut->z);
  82220. pOut->enc = SQLITE_UTF8;
  82221. sqlite3VdbeChangeEncoding(pOut, encoding);
  82222. if( rc ) goto abort_due_to_error;
  82223. break;
  82224. };
  82225. #endif /* SQLITE_OMIT_PRAGMA */
  82226. #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
  82227. /* Opcode: Vacuum P1 * * * *
  82228. **
  82229. ** Vacuum the entire database P1. P1 is 0 for "main", and 2 or more
  82230. ** for an attached database. The "temp" database may not be vacuumed.
  82231. */
  82232. case OP_Vacuum: {
  82233. assert( p->readOnly==0 );
  82234. rc = sqlite3RunVacuum(&p->zErrMsg, db, pOp->p1);
  82235. if( rc ) goto abort_due_to_error;
  82236. break;
  82237. }
  82238. #endif
  82239. #if !defined(SQLITE_OMIT_AUTOVACUUM)
  82240. /* Opcode: IncrVacuum P1 P2 * * *
  82241. **
  82242. ** Perform a single step of the incremental vacuum procedure on
  82243. ** the P1 database. If the vacuum has finished, jump to instruction
  82244. ** P2. Otherwise, fall through to the next instruction.
  82245. */
  82246. case OP_IncrVacuum: { /* jump */
  82247. Btree *pBt;
  82248. assert( pOp->p1>=0 && pOp->p1<db->nDb );
  82249. assert( DbMaskTest(p->btreeMask, pOp->p1) );
  82250. assert( p->readOnly==0 );
  82251. pBt = db->aDb[pOp->p1].pBt;
  82252. rc = sqlite3BtreeIncrVacuum(pBt);
  82253. VdbeBranchTaken(rc==SQLITE_DONE,2);
  82254. if( rc ){
  82255. if( rc!=SQLITE_DONE ) goto abort_due_to_error;
  82256. rc = SQLITE_OK;
  82257. goto jump_to_p2;
  82258. }
  82259. break;
  82260. }
  82261. #endif
  82262. /* Opcode: Expire P1 * * * *
  82263. **
  82264. ** Cause precompiled statements to expire. When an expired statement
  82265. ** is executed using sqlite3_step() it will either automatically
  82266. ** reprepare itself (if it was originally created using sqlite3_prepare_v2())
  82267. ** or it will fail with SQLITE_SCHEMA.
  82268. **
  82269. ** If P1 is 0, then all SQL statements become expired. If P1 is non-zero,
  82270. ** then only the currently executing statement is expired.
  82271. */
  82272. case OP_Expire: {
  82273. if( !pOp->p1 ){
  82274. sqlite3ExpirePreparedStatements(db);
  82275. }else{
  82276. p->expired = 1;
  82277. }
  82278. break;
  82279. }
  82280. #ifndef SQLITE_OMIT_SHARED_CACHE
  82281. /* Opcode: TableLock P1 P2 P3 P4 *
  82282. ** Synopsis: iDb=P1 root=P2 write=P3
  82283. **
  82284. ** Obtain a lock on a particular table. This instruction is only used when
  82285. ** the shared-cache feature is enabled.
  82286. **
  82287. ** P1 is the index of the database in sqlite3.aDb[] of the database
  82288. ** on which the lock is acquired. A readlock is obtained if P3==0 or
  82289. ** a write lock if P3==1.
  82290. **
  82291. ** P2 contains the root-page of the table to lock.
  82292. **
  82293. ** P4 contains a pointer to the name of the table being locked. This is only
  82294. ** used to generate an error message if the lock cannot be obtained.
  82295. */
  82296. case OP_TableLock: {
  82297. u8 isWriteLock = (u8)pOp->p3;
  82298. if( isWriteLock || 0==(db->flags&SQLITE_ReadUncommit) ){
  82299. int p1 = pOp->p1;
  82300. assert( p1>=0 && p1<db->nDb );
  82301. assert( DbMaskTest(p->btreeMask, p1) );
  82302. assert( isWriteLock==0 || isWriteLock==1 );
  82303. rc = sqlite3BtreeLockTable(db->aDb[p1].pBt, pOp->p2, isWriteLock);
  82304. if( rc ){
  82305. if( (rc&0xFF)==SQLITE_LOCKED ){
  82306. const char *z = pOp->p4.z;
  82307. sqlite3VdbeError(p, "database table is locked: %s", z);
  82308. }
  82309. goto abort_due_to_error;
  82310. }
  82311. }
  82312. break;
  82313. }
  82314. #endif /* SQLITE_OMIT_SHARED_CACHE */
  82315. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82316. /* Opcode: VBegin * * * P4 *
  82317. **
  82318. ** P4 may be a pointer to an sqlite3_vtab structure. If so, call the
  82319. ** xBegin method for that table.
  82320. **
  82321. ** Also, whether or not P4 is set, check that this is not being called from
  82322. ** within a callback to a virtual table xSync() method. If it is, the error
  82323. ** code will be set to SQLITE_LOCKED.
  82324. */
  82325. case OP_VBegin: {
  82326. VTable *pVTab;
  82327. pVTab = pOp->p4.pVtab;
  82328. rc = sqlite3VtabBegin(db, pVTab);
  82329. if( pVTab ) sqlite3VtabImportErrmsg(p, pVTab->pVtab);
  82330. if( rc ) goto abort_due_to_error;
  82331. break;
  82332. }
  82333. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82334. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82335. /* Opcode: VCreate P1 P2 * * *
  82336. **
  82337. ** P2 is a register that holds the name of a virtual table in database
  82338. ** P1. Call the xCreate method for that table.
  82339. */
  82340. case OP_VCreate: {
  82341. Mem sMem; /* For storing the record being decoded */
  82342. const char *zTab; /* Name of the virtual table */
  82343. memset(&sMem, 0, sizeof(sMem));
  82344. sMem.db = db;
  82345. /* Because P2 is always a static string, it is impossible for the
  82346. ** sqlite3VdbeMemCopy() to fail */
  82347. assert( (aMem[pOp->p2].flags & MEM_Str)!=0 );
  82348. assert( (aMem[pOp->p2].flags & MEM_Static)!=0 );
  82349. rc = sqlite3VdbeMemCopy(&sMem, &aMem[pOp->p2]);
  82350. assert( rc==SQLITE_OK );
  82351. zTab = (const char*)sqlite3_value_text(&sMem);
  82352. assert( zTab || db->mallocFailed );
  82353. if( zTab ){
  82354. rc = sqlite3VtabCallCreate(db, pOp->p1, zTab, &p->zErrMsg);
  82355. }
  82356. sqlite3VdbeMemRelease(&sMem);
  82357. if( rc ) goto abort_due_to_error;
  82358. break;
  82359. }
  82360. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82361. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82362. /* Opcode: VDestroy P1 * * P4 *
  82363. **
  82364. ** P4 is the name of a virtual table in database P1. Call the xDestroy method
  82365. ** of that table.
  82366. */
  82367. case OP_VDestroy: {
  82368. db->nVDestroy++;
  82369. rc = sqlite3VtabCallDestroy(db, pOp->p1, pOp->p4.z);
  82370. db->nVDestroy--;
  82371. if( rc ) goto abort_due_to_error;
  82372. break;
  82373. }
  82374. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82375. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82376. /* Opcode: VOpen P1 * * P4 *
  82377. **
  82378. ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
  82379. ** P1 is a cursor number. This opcode opens a cursor to the virtual
  82380. ** table and stores that cursor in P1.
  82381. */
  82382. case OP_VOpen: {
  82383. VdbeCursor *pCur;
  82384. sqlite3_vtab_cursor *pVCur;
  82385. sqlite3_vtab *pVtab;
  82386. const sqlite3_module *pModule;
  82387. assert( p->bIsReader );
  82388. pCur = 0;
  82389. pVCur = 0;
  82390. pVtab = pOp->p4.pVtab->pVtab;
  82391. if( pVtab==0 || NEVER(pVtab->pModule==0) ){
  82392. rc = SQLITE_LOCKED;
  82393. goto abort_due_to_error;
  82394. }
  82395. pModule = pVtab->pModule;
  82396. rc = pModule->xOpen(pVtab, &pVCur);
  82397. sqlite3VtabImportErrmsg(p, pVtab);
  82398. if( rc ) goto abort_due_to_error;
  82399. /* Initialize sqlite3_vtab_cursor base class */
  82400. pVCur->pVtab = pVtab;
  82401. /* Initialize vdbe cursor object */
  82402. pCur = allocateCursor(p, pOp->p1, 0, -1, CURTYPE_VTAB);
  82403. if( pCur ){
  82404. pCur->uc.pVCur = pVCur;
  82405. pVtab->nRef++;
  82406. }else{
  82407. assert( db->mallocFailed );
  82408. pModule->xClose(pVCur);
  82409. goto no_mem;
  82410. }
  82411. break;
  82412. }
  82413. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82414. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82415. /* Opcode: VFilter P1 P2 P3 P4 *
  82416. ** Synopsis: iplan=r[P3] zplan='P4'
  82417. **
  82418. ** P1 is a cursor opened using VOpen. P2 is an address to jump to if
  82419. ** the filtered result set is empty.
  82420. **
  82421. ** P4 is either NULL or a string that was generated by the xBestIndex
  82422. ** method of the module. The interpretation of the P4 string is left
  82423. ** to the module implementation.
  82424. **
  82425. ** This opcode invokes the xFilter method on the virtual table specified
  82426. ** by P1. The integer query plan parameter to xFilter is stored in register
  82427. ** P3. Register P3+1 stores the argc parameter to be passed to the
  82428. ** xFilter method. Registers P3+2..P3+1+argc are the argc
  82429. ** additional parameters which are passed to
  82430. ** xFilter as argv. Register P3+2 becomes argv[0] when passed to xFilter.
  82431. **
  82432. ** A jump is made to P2 if the result set after filtering would be empty.
  82433. */
  82434. case OP_VFilter: { /* jump */
  82435. int nArg;
  82436. int iQuery;
  82437. const sqlite3_module *pModule;
  82438. Mem *pQuery;
  82439. Mem *pArgc;
  82440. sqlite3_vtab_cursor *pVCur;
  82441. sqlite3_vtab *pVtab;
  82442. VdbeCursor *pCur;
  82443. int res;
  82444. int i;
  82445. Mem **apArg;
  82446. pQuery = &aMem[pOp->p3];
  82447. pArgc = &pQuery[1];
  82448. pCur = p->apCsr[pOp->p1];
  82449. assert( memIsValid(pQuery) );
  82450. REGISTER_TRACE(pOp->p3, pQuery);
  82451. assert( pCur->eCurType==CURTYPE_VTAB );
  82452. pVCur = pCur->uc.pVCur;
  82453. pVtab = pVCur->pVtab;
  82454. pModule = pVtab->pModule;
  82455. /* Grab the index number and argc parameters */
  82456. assert( (pQuery->flags&MEM_Int)!=0 && pArgc->flags==MEM_Int );
  82457. nArg = (int)pArgc->u.i;
  82458. iQuery = (int)pQuery->u.i;
  82459. /* Invoke the xFilter method */
  82460. res = 0;
  82461. apArg = p->apArg;
  82462. for(i = 0; i<nArg; i++){
  82463. apArg[i] = &pArgc[i+1];
  82464. }
  82465. rc = pModule->xFilter(pVCur, iQuery, pOp->p4.z, nArg, apArg);
  82466. sqlite3VtabImportErrmsg(p, pVtab);
  82467. if( rc ) goto abort_due_to_error;
  82468. res = pModule->xEof(pVCur);
  82469. pCur->nullRow = 0;
  82470. VdbeBranchTaken(res!=0,2);
  82471. if( res ) goto jump_to_p2;
  82472. break;
  82473. }
  82474. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82475. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82476. /* Opcode: VColumn P1 P2 P3 * P5
  82477. ** Synopsis: r[P3]=vcolumn(P2)
  82478. **
  82479. ** Store in register P3 the value of the P2-th column of
  82480. ** the current row of the virtual-table of cursor P1.
  82481. **
  82482. ** If the VColumn opcode is being used to fetch the value of
  82483. ** an unchanging column during an UPDATE operation, then the P5
  82484. ** value is 1. Otherwise, P5 is 0. The P5 value is returned
  82485. ** by sqlite3_vtab_nochange() routine can can be used
  82486. ** by virtual table implementations to return special "no-change"
  82487. ** marks which can be more efficient, depending on the virtual table.
  82488. */
  82489. case OP_VColumn: {
  82490. sqlite3_vtab *pVtab;
  82491. const sqlite3_module *pModule;
  82492. Mem *pDest;
  82493. sqlite3_context sContext;
  82494. VdbeCursor *pCur = p->apCsr[pOp->p1];
  82495. assert( pCur->eCurType==CURTYPE_VTAB );
  82496. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  82497. pDest = &aMem[pOp->p3];
  82498. memAboutToChange(p, pDest);
  82499. if( pCur->nullRow ){
  82500. sqlite3VdbeMemSetNull(pDest);
  82501. break;
  82502. }
  82503. pVtab = pCur->uc.pVCur->pVtab;
  82504. pModule = pVtab->pModule;
  82505. assert( pModule->xColumn );
  82506. memset(&sContext, 0, sizeof(sContext));
  82507. sContext.pOut = pDest;
  82508. if( pOp->p5 ){
  82509. sqlite3VdbeMemSetNull(pDest);
  82510. pDest->flags = MEM_Null|MEM_Zero;
  82511. pDest->u.nZero = 0;
  82512. }else{
  82513. MemSetTypeFlag(pDest, MEM_Null);
  82514. }
  82515. rc = pModule->xColumn(pCur->uc.pVCur, &sContext, pOp->p2);
  82516. sqlite3VtabImportErrmsg(p, pVtab);
  82517. if( sContext.isError>0 ){
  82518. sqlite3VdbeError(p, "%s", sqlite3_value_text(pDest));
  82519. rc = sContext.isError;
  82520. }
  82521. sqlite3VdbeChangeEncoding(pDest, encoding);
  82522. REGISTER_TRACE(pOp->p3, pDest);
  82523. UPDATE_MAX_BLOBSIZE(pDest);
  82524. if( sqlite3VdbeMemTooBig(pDest) ){
  82525. goto too_big;
  82526. }
  82527. if( rc ) goto abort_due_to_error;
  82528. break;
  82529. }
  82530. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82531. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82532. /* Opcode: VNext P1 P2 * * *
  82533. **
  82534. ** Advance virtual table P1 to the next row in its result set and
  82535. ** jump to instruction P2. Or, if the virtual table has reached
  82536. ** the end of its result set, then fall through to the next instruction.
  82537. */
  82538. case OP_VNext: { /* jump */
  82539. sqlite3_vtab *pVtab;
  82540. const sqlite3_module *pModule;
  82541. int res;
  82542. VdbeCursor *pCur;
  82543. res = 0;
  82544. pCur = p->apCsr[pOp->p1];
  82545. assert( pCur->eCurType==CURTYPE_VTAB );
  82546. if( pCur->nullRow ){
  82547. break;
  82548. }
  82549. pVtab = pCur->uc.pVCur->pVtab;
  82550. pModule = pVtab->pModule;
  82551. assert( pModule->xNext );
  82552. /* Invoke the xNext() method of the module. There is no way for the
  82553. ** underlying implementation to return an error if one occurs during
  82554. ** xNext(). Instead, if an error occurs, true is returned (indicating that
  82555. ** data is available) and the error code returned when xColumn or
  82556. ** some other method is next invoked on the save virtual table cursor.
  82557. */
  82558. rc = pModule->xNext(pCur->uc.pVCur);
  82559. sqlite3VtabImportErrmsg(p, pVtab);
  82560. if( rc ) goto abort_due_to_error;
  82561. res = pModule->xEof(pCur->uc.pVCur);
  82562. VdbeBranchTaken(!res,2);
  82563. if( !res ){
  82564. /* If there is data, jump to P2 */
  82565. goto jump_to_p2_and_check_for_interrupt;
  82566. }
  82567. goto check_for_interrupt;
  82568. }
  82569. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82570. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82571. /* Opcode: VRename P1 * * P4 *
  82572. **
  82573. ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
  82574. ** This opcode invokes the corresponding xRename method. The value
  82575. ** in register P1 is passed as the zName argument to the xRename method.
  82576. */
  82577. case OP_VRename: {
  82578. sqlite3_vtab *pVtab;
  82579. Mem *pName;
  82580. pVtab = pOp->p4.pVtab->pVtab;
  82581. pName = &aMem[pOp->p1];
  82582. assert( pVtab->pModule->xRename );
  82583. assert( memIsValid(pName) );
  82584. assert( p->readOnly==0 );
  82585. REGISTER_TRACE(pOp->p1, pName);
  82586. assert( pName->flags & MEM_Str );
  82587. testcase( pName->enc==SQLITE_UTF8 );
  82588. testcase( pName->enc==SQLITE_UTF16BE );
  82589. testcase( pName->enc==SQLITE_UTF16LE );
  82590. rc = sqlite3VdbeChangeEncoding(pName, SQLITE_UTF8);
  82591. if( rc ) goto abort_due_to_error;
  82592. rc = pVtab->pModule->xRename(pVtab, pName->z);
  82593. sqlite3VtabImportErrmsg(p, pVtab);
  82594. p->expired = 0;
  82595. if( rc ) goto abort_due_to_error;
  82596. break;
  82597. }
  82598. #endif
  82599. #ifndef SQLITE_OMIT_VIRTUALTABLE
  82600. /* Opcode: VUpdate P1 P2 P3 P4 P5
  82601. ** Synopsis: data=r[P3@P2]
  82602. **
  82603. ** P4 is a pointer to a virtual table object, an sqlite3_vtab structure.
  82604. ** This opcode invokes the corresponding xUpdate method. P2 values
  82605. ** are contiguous memory cells starting at P3 to pass to the xUpdate
  82606. ** invocation. The value in register (P3+P2-1) corresponds to the
  82607. ** p2th element of the argv array passed to xUpdate.
  82608. **
  82609. ** The xUpdate method will do a DELETE or an INSERT or both.
  82610. ** The argv[0] element (which corresponds to memory cell P3)
  82611. ** is the rowid of a row to delete. If argv[0] is NULL then no
  82612. ** deletion occurs. The argv[1] element is the rowid of the new
  82613. ** row. This can be NULL to have the virtual table select the new
  82614. ** rowid for itself. The subsequent elements in the array are
  82615. ** the values of columns in the new row.
  82616. **
  82617. ** If P2==1 then no insert is performed. argv[0] is the rowid of
  82618. ** a row to delete.
  82619. **
  82620. ** P1 is a boolean flag. If it is set to true and the xUpdate call
  82621. ** is successful, then the value returned by sqlite3_last_insert_rowid()
  82622. ** is set to the value of the rowid for the row just inserted.
  82623. **
  82624. ** P5 is the error actions (OE_Replace, OE_Fail, OE_Ignore, etc) to
  82625. ** apply in the case of a constraint failure on an insert or update.
  82626. */
  82627. case OP_VUpdate: {
  82628. sqlite3_vtab *pVtab;
  82629. const sqlite3_module *pModule;
  82630. int nArg;
  82631. int i;
  82632. sqlite_int64 rowid;
  82633. Mem **apArg;
  82634. Mem *pX;
  82635. assert( pOp->p2==1 || pOp->p5==OE_Fail || pOp->p5==OE_Rollback
  82636. || pOp->p5==OE_Abort || pOp->p5==OE_Ignore || pOp->p5==OE_Replace
  82637. );
  82638. assert( p->readOnly==0 );
  82639. pVtab = pOp->p4.pVtab->pVtab;
  82640. if( pVtab==0 || NEVER(pVtab->pModule==0) ){
  82641. rc = SQLITE_LOCKED;
  82642. goto abort_due_to_error;
  82643. }
  82644. pModule = pVtab->pModule;
  82645. nArg = pOp->p2;
  82646. assert( pOp->p4type==P4_VTAB );
  82647. if( ALWAYS(pModule->xUpdate) ){
  82648. u8 vtabOnConflict = db->vtabOnConflict;
  82649. apArg = p->apArg;
  82650. pX = &aMem[pOp->p3];
  82651. for(i=0; i<nArg; i++){
  82652. assert( memIsValid(pX) );
  82653. memAboutToChange(p, pX);
  82654. apArg[i] = pX;
  82655. pX++;
  82656. }
  82657. db->vtabOnConflict = pOp->p5;
  82658. rc = pModule->xUpdate(pVtab, nArg, apArg, &rowid);
  82659. db->vtabOnConflict = vtabOnConflict;
  82660. sqlite3VtabImportErrmsg(p, pVtab);
  82661. if( rc==SQLITE_OK && pOp->p1 ){
  82662. assert( nArg>1 && apArg[0] && (apArg[0]->flags&MEM_Null) );
  82663. db->lastRowid = rowid;
  82664. }
  82665. if( (rc&0xff)==SQLITE_CONSTRAINT && pOp->p4.pVtab->bConstraint ){
  82666. if( pOp->p5==OE_Ignore ){
  82667. rc = SQLITE_OK;
  82668. }else{
  82669. p->errorAction = ((pOp->p5==OE_Replace) ? OE_Abort : pOp->p5);
  82670. }
  82671. }else{
  82672. p->nChange++;
  82673. }
  82674. if( rc ) goto abort_due_to_error;
  82675. }
  82676. break;
  82677. }
  82678. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  82679. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  82680. /* Opcode: Pagecount P1 P2 * * *
  82681. **
  82682. ** Write the current number of pages in database P1 to memory cell P2.
  82683. */
  82684. case OP_Pagecount: { /* out2 */
  82685. pOut = out2Prerelease(p, pOp);
  82686. pOut->u.i = sqlite3BtreeLastPage(db->aDb[pOp->p1].pBt);
  82687. break;
  82688. }
  82689. #endif
  82690. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  82691. /* Opcode: MaxPgcnt P1 P2 P3 * *
  82692. **
  82693. ** Try to set the maximum page count for database P1 to the value in P3.
  82694. ** Do not let the maximum page count fall below the current page count and
  82695. ** do not change the maximum page count value if P3==0.
  82696. **
  82697. ** Store the maximum page count after the change in register P2.
  82698. */
  82699. case OP_MaxPgcnt: { /* out2 */
  82700. unsigned int newMax;
  82701. Btree *pBt;
  82702. pOut = out2Prerelease(p, pOp);
  82703. pBt = db->aDb[pOp->p1].pBt;
  82704. newMax = 0;
  82705. if( pOp->p3 ){
  82706. newMax = sqlite3BtreeLastPage(pBt);
  82707. if( newMax < (unsigned)pOp->p3 ) newMax = (unsigned)pOp->p3;
  82708. }
  82709. pOut->u.i = sqlite3BtreeMaxPageCount(pBt, newMax);
  82710. break;
  82711. }
  82712. #endif
  82713. /* Opcode: Function0 P1 P2 P3 P4 P5
  82714. ** Synopsis: r[P3]=func(r[P2@P5])
  82715. **
  82716. ** Invoke a user function (P4 is a pointer to a FuncDef object that
  82717. ** defines the function) with P5 arguments taken from register P2 and
  82718. ** successors. The result of the function is stored in register P3.
  82719. ** Register P3 must not be one of the function inputs.
  82720. **
  82721. ** P1 is a 32-bit bitmask indicating whether or not each argument to the
  82722. ** function was determined to be constant at compile time. If the first
  82723. ** argument was constant then bit 0 of P1 is set. This is used to determine
  82724. ** whether meta data associated with a user function argument using the
  82725. ** sqlite3_set_auxdata() API may be safely retained until the next
  82726. ** invocation of this opcode.
  82727. **
  82728. ** See also: Function, AggStep, AggFinal
  82729. */
  82730. /* Opcode: Function P1 P2 P3 P4 P5
  82731. ** Synopsis: r[P3]=func(r[P2@P5])
  82732. **
  82733. ** Invoke a user function (P4 is a pointer to an sqlite3_context object that
  82734. ** contains a pointer to the function to be run) with P5 arguments taken
  82735. ** from register P2 and successors. The result of the function is stored
  82736. ** in register P3. Register P3 must not be one of the function inputs.
  82737. **
  82738. ** P1 is a 32-bit bitmask indicating whether or not each argument to the
  82739. ** function was determined to be constant at compile time. If the first
  82740. ** argument was constant then bit 0 of P1 is set. This is used to determine
  82741. ** whether meta data associated with a user function argument using the
  82742. ** sqlite3_set_auxdata() API may be safely retained until the next
  82743. ** invocation of this opcode.
  82744. **
  82745. ** SQL functions are initially coded as OP_Function0 with P4 pointing
  82746. ** to a FuncDef object. But on first evaluation, the P4 operand is
  82747. ** automatically converted into an sqlite3_context object and the operation
  82748. ** changed to this OP_Function opcode. In this way, the initialization of
  82749. ** the sqlite3_context object occurs only once, rather than once for each
  82750. ** evaluation of the function.
  82751. **
  82752. ** See also: Function0, AggStep, AggFinal
  82753. */
  82754. case OP_PureFunc0:
  82755. case OP_Function0: {
  82756. int n;
  82757. sqlite3_context *pCtx;
  82758. assert( pOp->p4type==P4_FUNCDEF );
  82759. n = pOp->p5;
  82760. assert( pOp->p3>0 && pOp->p3<=(p->nMem+1 - p->nCursor) );
  82761. assert( n==0 || (pOp->p2>0 && pOp->p2+n<=(p->nMem+1 - p->nCursor)+1) );
  82762. assert( pOp->p3<pOp->p2 || pOp->p3>=pOp->p2+n );
  82763. pCtx = sqlite3DbMallocRawNN(db, sizeof(*pCtx) + (n-1)*sizeof(sqlite3_value*));
  82764. if( pCtx==0 ) goto no_mem;
  82765. pCtx->pOut = 0;
  82766. pCtx->pFunc = pOp->p4.pFunc;
  82767. pCtx->iOp = (int)(pOp - aOp);
  82768. pCtx->pVdbe = p;
  82769. pCtx->isError = 0;
  82770. pCtx->argc = n;
  82771. pOp->p4type = P4_FUNCCTX;
  82772. pOp->p4.pCtx = pCtx;
  82773. assert( OP_PureFunc == OP_PureFunc0+2 );
  82774. assert( OP_Function == OP_Function0+2 );
  82775. pOp->opcode += 2;
  82776. /* Fall through into OP_Function */
  82777. }
  82778. case OP_PureFunc:
  82779. case OP_Function: {
  82780. int i;
  82781. sqlite3_context *pCtx;
  82782. assert( pOp->p4type==P4_FUNCCTX );
  82783. pCtx = pOp->p4.pCtx;
  82784. /* If this function is inside of a trigger, the register array in aMem[]
  82785. ** might change from one evaluation to the next. The next block of code
  82786. ** checks to see if the register array has changed, and if so it
  82787. ** reinitializes the relavant parts of the sqlite3_context object */
  82788. pOut = &aMem[pOp->p3];
  82789. if( pCtx->pOut != pOut ){
  82790. pCtx->pOut = pOut;
  82791. for(i=pCtx->argc-1; i>=0; i--) pCtx->argv[i] = &aMem[pOp->p2+i];
  82792. }
  82793. memAboutToChange(p, pOut);
  82794. #ifdef SQLITE_DEBUG
  82795. for(i=0; i<pCtx->argc; i++){
  82796. assert( memIsValid(pCtx->argv[i]) );
  82797. REGISTER_TRACE(pOp->p2+i, pCtx->argv[i]);
  82798. }
  82799. #endif
  82800. MemSetTypeFlag(pOut, MEM_Null);
  82801. assert( pCtx->isError==0 );
  82802. (*pCtx->pFunc->xSFunc)(pCtx, pCtx->argc, pCtx->argv);/* IMP: R-24505-23230 */
  82803. /* If the function returned an error, throw an exception */
  82804. if( pCtx->isError ){
  82805. if( pCtx->isError>0 ){
  82806. sqlite3VdbeError(p, "%s", sqlite3_value_text(pOut));
  82807. rc = pCtx->isError;
  82808. }
  82809. sqlite3VdbeDeleteAuxData(db, &p->pAuxData, pCtx->iOp, pOp->p1);
  82810. pCtx->isError = 0;
  82811. if( rc ) goto abort_due_to_error;
  82812. }
  82813. /* Copy the result of the function into register P3 */
  82814. if( pOut->flags & (MEM_Str|MEM_Blob) ){
  82815. sqlite3VdbeChangeEncoding(pOut, encoding);
  82816. if( sqlite3VdbeMemTooBig(pOut) ) goto too_big;
  82817. }
  82818. REGISTER_TRACE(pOp->p3, pOut);
  82819. UPDATE_MAX_BLOBSIZE(pOut);
  82820. break;
  82821. }
  82822. /* Opcode: Trace P1 P2 * P4 *
  82823. **
  82824. ** Write P4 on the statement trace output if statement tracing is
  82825. ** enabled.
  82826. **
  82827. ** Operand P1 must be 0x7fffffff and P2 must positive.
  82828. */
  82829. /* Opcode: Init P1 P2 P3 P4 *
  82830. ** Synopsis: Start at P2
  82831. **
  82832. ** Programs contain a single instance of this opcode as the very first
  82833. ** opcode.
  82834. **
  82835. ** If tracing is enabled (by the sqlite3_trace()) interface, then
  82836. ** the UTF-8 string contained in P4 is emitted on the trace callback.
  82837. ** Or if P4 is blank, use the string returned by sqlite3_sql().
  82838. **
  82839. ** If P2 is not zero, jump to instruction P2.
  82840. **
  82841. ** Increment the value of P1 so that OP_Once opcodes will jump the
  82842. ** first time they are evaluated for this run.
  82843. **
  82844. ** If P3 is not zero, then it is an address to jump to if an SQLITE_CORRUPT
  82845. ** error is encountered.
  82846. */
  82847. case OP_Trace:
  82848. case OP_Init: { /* jump */
  82849. int i;
  82850. #ifndef SQLITE_OMIT_TRACE
  82851. char *zTrace;
  82852. #endif
  82853. /* If the P4 argument is not NULL, then it must be an SQL comment string.
  82854. ** The "--" string is broken up to prevent false-positives with srcck1.c.
  82855. **
  82856. ** This assert() provides evidence for:
  82857. ** EVIDENCE-OF: R-50676-09860 The callback can compute the same text that
  82858. ** would have been returned by the legacy sqlite3_trace() interface by
  82859. ** using the X argument when X begins with "--" and invoking
  82860. ** sqlite3_expanded_sql(P) otherwise.
  82861. */
  82862. assert( pOp->p4.z==0 || strncmp(pOp->p4.z, "-" "- ", 3)==0 );
  82863. /* OP_Init is always instruction 0 */
  82864. assert( pOp==p->aOp || pOp->opcode==OP_Trace );
  82865. #ifndef SQLITE_OMIT_TRACE
  82866. if( (db->mTrace & (SQLITE_TRACE_STMT|SQLITE_TRACE_LEGACY))!=0
  82867. && !p->doingRerun
  82868. && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
  82869. ){
  82870. #ifndef SQLITE_OMIT_DEPRECATED
  82871. if( db->mTrace & SQLITE_TRACE_LEGACY ){
  82872. void (*x)(void*,const char*) = (void(*)(void*,const char*))db->xTrace;
  82873. char *z = sqlite3VdbeExpandSql(p, zTrace);
  82874. x(db->pTraceArg, z);
  82875. sqlite3_free(z);
  82876. }else
  82877. #endif
  82878. if( db->nVdbeExec>1 ){
  82879. char *z = sqlite3MPrintf(db, "-- %s", zTrace);
  82880. (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, z);
  82881. sqlite3DbFree(db, z);
  82882. }else{
  82883. (void)db->xTrace(SQLITE_TRACE_STMT, db->pTraceArg, p, zTrace);
  82884. }
  82885. }
  82886. #ifdef SQLITE_USE_FCNTL_TRACE
  82887. zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql);
  82888. if( zTrace ){
  82889. int j;
  82890. for(j=0; j<db->nDb; j++){
  82891. if( DbMaskTest(p->btreeMask, j)==0 ) continue;
  82892. sqlite3_file_control(db, db->aDb[j].zDbSName, SQLITE_FCNTL_TRACE, zTrace);
  82893. }
  82894. }
  82895. #endif /* SQLITE_USE_FCNTL_TRACE */
  82896. #ifdef SQLITE_DEBUG
  82897. if( (db->flags & SQLITE_SqlTrace)!=0
  82898. && (zTrace = (pOp->p4.z ? pOp->p4.z : p->zSql))!=0
  82899. ){
  82900. sqlite3DebugPrintf("SQL-trace: %s\n", zTrace);
  82901. }
  82902. #endif /* SQLITE_DEBUG */
  82903. #endif /* SQLITE_OMIT_TRACE */
  82904. assert( pOp->p2>0 );
  82905. if( pOp->p1>=sqlite3GlobalConfig.iOnceResetThreshold ){
  82906. if( pOp->opcode==OP_Trace ) break;
  82907. for(i=1; i<p->nOp; i++){
  82908. if( p->aOp[i].opcode==OP_Once ) p->aOp[i].p1 = 0;
  82909. }
  82910. pOp->p1 = 0;
  82911. }
  82912. pOp->p1++;
  82913. p->aCounter[SQLITE_STMTSTATUS_RUN]++;
  82914. goto jump_to_p2;
  82915. }
  82916. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  82917. /* Opcode: CursorHint P1 * * P4 *
  82918. **
  82919. ** Provide a hint to cursor P1 that it only needs to return rows that
  82920. ** satisfy the Expr in P4. TK_REGISTER terms in the P4 expression refer
  82921. ** to values currently held in registers. TK_COLUMN terms in the P4
  82922. ** expression refer to columns in the b-tree to which cursor P1 is pointing.
  82923. */
  82924. case OP_CursorHint: {
  82925. VdbeCursor *pC;
  82926. assert( pOp->p1>=0 && pOp->p1<p->nCursor );
  82927. assert( pOp->p4type==P4_EXPR );
  82928. pC = p->apCsr[pOp->p1];
  82929. if( pC ){
  82930. assert( pC->eCurType==CURTYPE_BTREE );
  82931. sqlite3BtreeCursorHint(pC->uc.pCursor, BTREE_HINT_RANGE,
  82932. pOp->p4.pExpr, aMem);
  82933. }
  82934. break;
  82935. }
  82936. #endif /* SQLITE_ENABLE_CURSOR_HINTS */
  82937. /* Opcode: Noop * * * * *
  82938. **
  82939. ** Do nothing. This instruction is often useful as a jump
  82940. ** destination.
  82941. */
  82942. /*
  82943. ** The magic Explain opcode are only inserted when explain==2 (which
  82944. ** is to say when the EXPLAIN QUERY PLAN syntax is used.)
  82945. ** This opcode records information from the optimizer. It is the
  82946. ** the same as a no-op. This opcodesnever appears in a real VM program.
  82947. */
  82948. default: { /* This is really OP_Noop and OP_Explain */
  82949. assert( pOp->opcode==OP_Noop || pOp->opcode==OP_Explain );
  82950. break;
  82951. }
  82952. /*****************************************************************************
  82953. ** The cases of the switch statement above this line should all be indented
  82954. ** by 6 spaces. But the left-most 6 spaces have been removed to improve the
  82955. ** readability. From this point on down, the normal indentation rules are
  82956. ** restored.
  82957. *****************************************************************************/
  82958. }
  82959. #ifdef VDBE_PROFILE
  82960. {
  82961. u64 endTime = sqlite3NProfileCnt ? sqlite3NProfileCnt : sqlite3Hwtime();
  82962. if( endTime>start ) pOrigOp->cycles += endTime - start;
  82963. pOrigOp->cnt++;
  82964. }
  82965. #endif
  82966. /* The following code adds nothing to the actual functionality
  82967. ** of the program. It is only here for testing and debugging.
  82968. ** On the other hand, it does burn CPU cycles every time through
  82969. ** the evaluator loop. So we can leave it out when NDEBUG is defined.
  82970. */
  82971. #ifndef NDEBUG
  82972. assert( pOp>=&aOp[-1] && pOp<&aOp[p->nOp-1] );
  82973. #ifdef SQLITE_DEBUG
  82974. if( db->flags & SQLITE_VdbeTrace ){
  82975. u8 opProperty = sqlite3OpcodeProperty[pOrigOp->opcode];
  82976. if( rc!=0 ) printf("rc=%d\n",rc);
  82977. if( opProperty & (OPFLG_OUT2) ){
  82978. registerTrace(pOrigOp->p2, &aMem[pOrigOp->p2]);
  82979. }
  82980. if( opProperty & OPFLG_OUT3 ){
  82981. registerTrace(pOrigOp->p3, &aMem[pOrigOp->p3]);
  82982. }
  82983. }
  82984. #endif /* SQLITE_DEBUG */
  82985. #endif /* NDEBUG */
  82986. } /* The end of the for(;;) loop the loops through opcodes */
  82987. /* If we reach this point, it means that execution is finished with
  82988. ** an error of some kind.
  82989. */
  82990. abort_due_to_error:
  82991. if( db->mallocFailed ) rc = SQLITE_NOMEM_BKPT;
  82992. assert( rc );
  82993. if( p->zErrMsg==0 && rc!=SQLITE_IOERR_NOMEM ){
  82994. sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
  82995. }
  82996. p->rc = rc;
  82997. sqlite3SystemError(db, rc);
  82998. testcase( sqlite3GlobalConfig.xLog!=0 );
  82999. sqlite3_log(rc, "statement aborts at %d: [%s] %s",
  83000. (int)(pOp - aOp), p->zSql, p->zErrMsg);
  83001. sqlite3VdbeHalt(p);
  83002. if( rc==SQLITE_IOERR_NOMEM ) sqlite3OomFault(db);
  83003. rc = SQLITE_ERROR;
  83004. if( resetSchemaOnFault>0 ){
  83005. sqlite3ResetOneSchema(db, resetSchemaOnFault-1);
  83006. }
  83007. /* This is the only way out of this procedure. We have to
  83008. ** release the mutexes on btrees that were acquired at the
  83009. ** top. */
  83010. vdbe_return:
  83011. testcase( nVmStep>0 );
  83012. p->aCounter[SQLITE_STMTSTATUS_VM_STEP] += (int)nVmStep;
  83013. sqlite3VdbeLeave(p);
  83014. assert( rc!=SQLITE_OK || nExtraDelete==0
  83015. || sqlite3_strlike("DELETE%",p->zSql,0)!=0
  83016. );
  83017. return rc;
  83018. /* Jump to here if a string or blob larger than SQLITE_MAX_LENGTH
  83019. ** is encountered.
  83020. */
  83021. too_big:
  83022. sqlite3VdbeError(p, "string or blob too big");
  83023. rc = SQLITE_TOOBIG;
  83024. goto abort_due_to_error;
  83025. /* Jump to here if a malloc() fails.
  83026. */
  83027. no_mem:
  83028. sqlite3OomFault(db);
  83029. sqlite3VdbeError(p, "out of memory");
  83030. rc = SQLITE_NOMEM_BKPT;
  83031. goto abort_due_to_error;
  83032. /* Jump to here if the sqlite3_interrupt() API sets the interrupt
  83033. ** flag.
  83034. */
  83035. abort_due_to_interrupt:
  83036. assert( db->u1.isInterrupted );
  83037. rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_INTERRUPT;
  83038. p->rc = rc;
  83039. sqlite3VdbeError(p, "%s", sqlite3ErrStr(rc));
  83040. goto abort_due_to_error;
  83041. }
  83042. /************** End of vdbe.c ************************************************/
  83043. /************** Begin file vdbeblob.c ****************************************/
  83044. /*
  83045. ** 2007 May 1
  83046. **
  83047. ** The author disclaims copyright to this source code. In place of
  83048. ** a legal notice, here is a blessing:
  83049. **
  83050. ** May you do good and not evil.
  83051. ** May you find forgiveness for yourself and forgive others.
  83052. ** May you share freely, never taking more than you give.
  83053. **
  83054. *************************************************************************
  83055. **
  83056. ** This file contains code used to implement incremental BLOB I/O.
  83057. */
  83058. /* #include "sqliteInt.h" */
  83059. /* #include "vdbeInt.h" */
  83060. #ifndef SQLITE_OMIT_INCRBLOB
  83061. /*
  83062. ** Valid sqlite3_blob* handles point to Incrblob structures.
  83063. */
  83064. typedef struct Incrblob Incrblob;
  83065. struct Incrblob {
  83066. int nByte; /* Size of open blob, in bytes */
  83067. int iOffset; /* Byte offset of blob in cursor data */
  83068. u16 iCol; /* Table column this handle is open on */
  83069. BtCursor *pCsr; /* Cursor pointing at blob row */
  83070. sqlite3_stmt *pStmt; /* Statement holding cursor open */
  83071. sqlite3 *db; /* The associated database */
  83072. char *zDb; /* Database name */
  83073. Table *pTab; /* Table object */
  83074. };
  83075. /*
  83076. ** This function is used by both blob_open() and blob_reopen(). It seeks
  83077. ** the b-tree cursor associated with blob handle p to point to row iRow.
  83078. ** If successful, SQLITE_OK is returned and subsequent calls to
  83079. ** sqlite3_blob_read() or sqlite3_blob_write() access the specified row.
  83080. **
  83081. ** If an error occurs, or if the specified row does not exist or does not
  83082. ** contain a value of type TEXT or BLOB in the column nominated when the
  83083. ** blob handle was opened, then an error code is returned and *pzErr may
  83084. ** be set to point to a buffer containing an error message. It is the
  83085. ** responsibility of the caller to free the error message buffer using
  83086. ** sqlite3DbFree().
  83087. **
  83088. ** If an error does occur, then the b-tree cursor is closed. All subsequent
  83089. ** calls to sqlite3_blob_read(), blob_write() or blob_reopen() will
  83090. ** immediately return SQLITE_ABORT.
  83091. */
  83092. static int blobSeekToRow(Incrblob *p, sqlite3_int64 iRow, char **pzErr){
  83093. int rc; /* Error code */
  83094. char *zErr = 0; /* Error message */
  83095. Vdbe *v = (Vdbe *)p->pStmt;
  83096. /* Set the value of register r[1] in the SQL statement to integer iRow.
  83097. ** This is done directly as a performance optimization
  83098. */
  83099. v->aMem[1].flags = MEM_Int;
  83100. v->aMem[1].u.i = iRow;
  83101. /* If the statement has been run before (and is paused at the OP_ResultRow)
  83102. ** then back it up to the point where it does the OP_NotExists. This could
  83103. ** have been down with an extra OP_Goto, but simply setting the program
  83104. ** counter is faster. */
  83105. if( v->pc>4 ){
  83106. v->pc = 4;
  83107. assert( v->aOp[v->pc].opcode==OP_NotExists );
  83108. rc = sqlite3VdbeExec(v);
  83109. }else{
  83110. rc = sqlite3_step(p->pStmt);
  83111. }
  83112. if( rc==SQLITE_ROW ){
  83113. VdbeCursor *pC = v->apCsr[0];
  83114. u32 type = pC->nHdrParsed>p->iCol ? pC->aType[p->iCol] : 0;
  83115. testcase( pC->nHdrParsed==p->iCol );
  83116. testcase( pC->nHdrParsed==p->iCol+1 );
  83117. if( type<12 ){
  83118. zErr = sqlite3MPrintf(p->db, "cannot open value of type %s",
  83119. type==0?"null": type==7?"real": "integer"
  83120. );
  83121. rc = SQLITE_ERROR;
  83122. sqlite3_finalize(p->pStmt);
  83123. p->pStmt = 0;
  83124. }else{
  83125. p->iOffset = pC->aType[p->iCol + pC->nField];
  83126. p->nByte = sqlite3VdbeSerialTypeLen(type);
  83127. p->pCsr = pC->uc.pCursor;
  83128. sqlite3BtreeIncrblobCursor(p->pCsr);
  83129. }
  83130. }
  83131. if( rc==SQLITE_ROW ){
  83132. rc = SQLITE_OK;
  83133. }else if( p->pStmt ){
  83134. rc = sqlite3_finalize(p->pStmt);
  83135. p->pStmt = 0;
  83136. if( rc==SQLITE_OK ){
  83137. zErr = sqlite3MPrintf(p->db, "no such rowid: %lld", iRow);
  83138. rc = SQLITE_ERROR;
  83139. }else{
  83140. zErr = sqlite3MPrintf(p->db, "%s", sqlite3_errmsg(p->db));
  83141. }
  83142. }
  83143. assert( rc!=SQLITE_OK || zErr==0 );
  83144. assert( rc!=SQLITE_ROW && rc!=SQLITE_DONE );
  83145. *pzErr = zErr;
  83146. return rc;
  83147. }
  83148. /*
  83149. ** Open a blob handle.
  83150. */
  83151. SQLITE_API int sqlite3_blob_open(
  83152. sqlite3* db, /* The database connection */
  83153. const char *zDb, /* The attached database containing the blob */
  83154. const char *zTable, /* The table containing the blob */
  83155. const char *zColumn, /* The column containing the blob */
  83156. sqlite_int64 iRow, /* The row containing the glob */
  83157. int wrFlag, /* True -> read/write access, false -> read-only */
  83158. sqlite3_blob **ppBlob /* Handle for accessing the blob returned here */
  83159. ){
  83160. int nAttempt = 0;
  83161. int iCol; /* Index of zColumn in row-record */
  83162. int rc = SQLITE_OK;
  83163. char *zErr = 0;
  83164. Table *pTab;
  83165. Incrblob *pBlob = 0;
  83166. Parse sParse;
  83167. #ifdef SQLITE_ENABLE_API_ARMOR
  83168. if( ppBlob==0 ){
  83169. return SQLITE_MISUSE_BKPT;
  83170. }
  83171. #endif
  83172. *ppBlob = 0;
  83173. #ifdef SQLITE_ENABLE_API_ARMOR
  83174. if( !sqlite3SafetyCheckOk(db) || zTable==0 ){
  83175. return SQLITE_MISUSE_BKPT;
  83176. }
  83177. #endif
  83178. wrFlag = !!wrFlag; /* wrFlag = (wrFlag ? 1 : 0); */
  83179. sqlite3_mutex_enter(db->mutex);
  83180. pBlob = (Incrblob *)sqlite3DbMallocZero(db, sizeof(Incrblob));
  83181. do {
  83182. memset(&sParse, 0, sizeof(Parse));
  83183. if( !pBlob ) goto blob_open_out;
  83184. sParse.db = db;
  83185. sqlite3DbFree(db, zErr);
  83186. zErr = 0;
  83187. sqlite3BtreeEnterAll(db);
  83188. pTab = sqlite3LocateTable(&sParse, 0, zTable, zDb);
  83189. if( pTab && IsVirtual(pTab) ){
  83190. pTab = 0;
  83191. sqlite3ErrorMsg(&sParse, "cannot open virtual table: %s", zTable);
  83192. }
  83193. if( pTab && !HasRowid(pTab) ){
  83194. pTab = 0;
  83195. sqlite3ErrorMsg(&sParse, "cannot open table without rowid: %s", zTable);
  83196. }
  83197. #ifndef SQLITE_OMIT_VIEW
  83198. if( pTab && pTab->pSelect ){
  83199. pTab = 0;
  83200. sqlite3ErrorMsg(&sParse, "cannot open view: %s", zTable);
  83201. }
  83202. #endif
  83203. if( !pTab ){
  83204. if( sParse.zErrMsg ){
  83205. sqlite3DbFree(db, zErr);
  83206. zErr = sParse.zErrMsg;
  83207. sParse.zErrMsg = 0;
  83208. }
  83209. rc = SQLITE_ERROR;
  83210. sqlite3BtreeLeaveAll(db);
  83211. goto blob_open_out;
  83212. }
  83213. pBlob->pTab = pTab;
  83214. pBlob->zDb = db->aDb[sqlite3SchemaToIndex(db, pTab->pSchema)].zDbSName;
  83215. /* Now search pTab for the exact column. */
  83216. for(iCol=0; iCol<pTab->nCol; iCol++) {
  83217. if( sqlite3StrICmp(pTab->aCol[iCol].zName, zColumn)==0 ){
  83218. break;
  83219. }
  83220. }
  83221. if( iCol==pTab->nCol ){
  83222. sqlite3DbFree(db, zErr);
  83223. zErr = sqlite3MPrintf(db, "no such column: \"%s\"", zColumn);
  83224. rc = SQLITE_ERROR;
  83225. sqlite3BtreeLeaveAll(db);
  83226. goto blob_open_out;
  83227. }
  83228. /* If the value is being opened for writing, check that the
  83229. ** column is not indexed, and that it is not part of a foreign key.
  83230. */
  83231. if( wrFlag ){
  83232. const char *zFault = 0;
  83233. Index *pIdx;
  83234. #ifndef SQLITE_OMIT_FOREIGN_KEY
  83235. if( db->flags&SQLITE_ForeignKeys ){
  83236. /* Check that the column is not part of an FK child key definition. It
  83237. ** is not necessary to check if it is part of a parent key, as parent
  83238. ** key columns must be indexed. The check below will pick up this
  83239. ** case. */
  83240. FKey *pFKey;
  83241. for(pFKey=pTab->pFKey; pFKey; pFKey=pFKey->pNextFrom){
  83242. int j;
  83243. for(j=0; j<pFKey->nCol; j++){
  83244. if( pFKey->aCol[j].iFrom==iCol ){
  83245. zFault = "foreign key";
  83246. }
  83247. }
  83248. }
  83249. }
  83250. #endif
  83251. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  83252. int j;
  83253. for(j=0; j<pIdx->nKeyCol; j++){
  83254. /* FIXME: Be smarter about indexes that use expressions */
  83255. if( pIdx->aiColumn[j]==iCol || pIdx->aiColumn[j]==XN_EXPR ){
  83256. zFault = "indexed";
  83257. }
  83258. }
  83259. }
  83260. if( zFault ){
  83261. sqlite3DbFree(db, zErr);
  83262. zErr = sqlite3MPrintf(db, "cannot open %s column for writing", zFault);
  83263. rc = SQLITE_ERROR;
  83264. sqlite3BtreeLeaveAll(db);
  83265. goto blob_open_out;
  83266. }
  83267. }
  83268. pBlob->pStmt = (sqlite3_stmt *)sqlite3VdbeCreate(&sParse);
  83269. assert( pBlob->pStmt || db->mallocFailed );
  83270. if( pBlob->pStmt ){
  83271. /* This VDBE program seeks a btree cursor to the identified
  83272. ** db/table/row entry. The reason for using a vdbe program instead
  83273. ** of writing code to use the b-tree layer directly is that the
  83274. ** vdbe program will take advantage of the various transaction,
  83275. ** locking and error handling infrastructure built into the vdbe.
  83276. **
  83277. ** After seeking the cursor, the vdbe executes an OP_ResultRow.
  83278. ** Code external to the Vdbe then "borrows" the b-tree cursor and
  83279. ** uses it to implement the blob_read(), blob_write() and
  83280. ** blob_bytes() functions.
  83281. **
  83282. ** The sqlite3_blob_close() function finalizes the vdbe program,
  83283. ** which closes the b-tree cursor and (possibly) commits the
  83284. ** transaction.
  83285. */
  83286. static const int iLn = VDBE_OFFSET_LINENO(2);
  83287. static const VdbeOpList openBlob[] = {
  83288. {OP_TableLock, 0, 0, 0}, /* 0: Acquire a read or write lock */
  83289. {OP_OpenRead, 0, 0, 0}, /* 1: Open a cursor */
  83290. /* blobSeekToRow() will initialize r[1] to the desired rowid */
  83291. {OP_NotExists, 0, 5, 1}, /* 2: Seek the cursor to rowid=r[1] */
  83292. {OP_Column, 0, 0, 1}, /* 3 */
  83293. {OP_ResultRow, 1, 0, 0}, /* 4 */
  83294. {OP_Halt, 0, 0, 0}, /* 5 */
  83295. };
  83296. Vdbe *v = (Vdbe *)pBlob->pStmt;
  83297. int iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  83298. VdbeOp *aOp;
  83299. sqlite3VdbeAddOp4Int(v, OP_Transaction, iDb, wrFlag,
  83300. pTab->pSchema->schema_cookie,
  83301. pTab->pSchema->iGeneration);
  83302. sqlite3VdbeChangeP5(v, 1);
  83303. assert( sqlite3VdbeCurrentAddr(v)==2 || db->mallocFailed );
  83304. aOp = sqlite3VdbeAddOpList(v, ArraySize(openBlob), openBlob, iLn);
  83305. /* Make sure a mutex is held on the table to be accessed */
  83306. sqlite3VdbeUsesBtree(v, iDb);
  83307. if( db->mallocFailed==0 ){
  83308. assert( aOp!=0 );
  83309. /* Configure the OP_TableLock instruction */
  83310. #ifdef SQLITE_OMIT_SHARED_CACHE
  83311. aOp[0].opcode = OP_Noop;
  83312. #else
  83313. aOp[0].p1 = iDb;
  83314. aOp[0].p2 = pTab->tnum;
  83315. aOp[0].p3 = wrFlag;
  83316. sqlite3VdbeChangeP4(v, 2, pTab->zName, P4_TRANSIENT);
  83317. }
  83318. if( db->mallocFailed==0 ){
  83319. #endif
  83320. /* Remove either the OP_OpenWrite or OpenRead. Set the P2
  83321. ** parameter of the other to pTab->tnum. */
  83322. if( wrFlag ) aOp[1].opcode = OP_OpenWrite;
  83323. aOp[1].p2 = pTab->tnum;
  83324. aOp[1].p3 = iDb;
  83325. /* Configure the number of columns. Configure the cursor to
  83326. ** think that the table has one more column than it really
  83327. ** does. An OP_Column to retrieve this imaginary column will
  83328. ** always return an SQL NULL. This is useful because it means
  83329. ** we can invoke OP_Column to fill in the vdbe cursors type
  83330. ** and offset cache without causing any IO.
  83331. */
  83332. aOp[1].p4type = P4_INT32;
  83333. aOp[1].p4.i = pTab->nCol+1;
  83334. aOp[3].p2 = pTab->nCol;
  83335. sParse.nVar = 0;
  83336. sParse.nMem = 1;
  83337. sParse.nTab = 1;
  83338. sqlite3VdbeMakeReady(v, &sParse);
  83339. }
  83340. }
  83341. pBlob->iCol = iCol;
  83342. pBlob->db = db;
  83343. sqlite3BtreeLeaveAll(db);
  83344. if( db->mallocFailed ){
  83345. goto blob_open_out;
  83346. }
  83347. rc = blobSeekToRow(pBlob, iRow, &zErr);
  83348. } while( (++nAttempt)<SQLITE_MAX_SCHEMA_RETRY && rc==SQLITE_SCHEMA );
  83349. blob_open_out:
  83350. if( rc==SQLITE_OK && db->mallocFailed==0 ){
  83351. *ppBlob = (sqlite3_blob *)pBlob;
  83352. }else{
  83353. if( pBlob && pBlob->pStmt ) sqlite3VdbeFinalize((Vdbe *)pBlob->pStmt);
  83354. sqlite3DbFree(db, pBlob);
  83355. }
  83356. sqlite3ErrorWithMsg(db, rc, (zErr ? "%s" : 0), zErr);
  83357. sqlite3DbFree(db, zErr);
  83358. sqlite3ParserReset(&sParse);
  83359. rc = sqlite3ApiExit(db, rc);
  83360. sqlite3_mutex_leave(db->mutex);
  83361. return rc;
  83362. }
  83363. /*
  83364. ** Close a blob handle that was previously created using
  83365. ** sqlite3_blob_open().
  83366. */
  83367. SQLITE_API int sqlite3_blob_close(sqlite3_blob *pBlob){
  83368. Incrblob *p = (Incrblob *)pBlob;
  83369. int rc;
  83370. sqlite3 *db;
  83371. if( p ){
  83372. db = p->db;
  83373. sqlite3_mutex_enter(db->mutex);
  83374. rc = sqlite3_finalize(p->pStmt);
  83375. sqlite3DbFree(db, p);
  83376. sqlite3_mutex_leave(db->mutex);
  83377. }else{
  83378. rc = SQLITE_OK;
  83379. }
  83380. return rc;
  83381. }
  83382. /*
  83383. ** Perform a read or write operation on a blob
  83384. */
  83385. static int blobReadWrite(
  83386. sqlite3_blob *pBlob,
  83387. void *z,
  83388. int n,
  83389. int iOffset,
  83390. int (*xCall)(BtCursor*, u32, u32, void*)
  83391. ){
  83392. int rc;
  83393. Incrblob *p = (Incrblob *)pBlob;
  83394. Vdbe *v;
  83395. sqlite3 *db;
  83396. if( p==0 ) return SQLITE_MISUSE_BKPT;
  83397. db = p->db;
  83398. sqlite3_mutex_enter(db->mutex);
  83399. v = (Vdbe*)p->pStmt;
  83400. if( n<0 || iOffset<0 || ((sqlite3_int64)iOffset+n)>p->nByte ){
  83401. /* Request is out of range. Return a transient error. */
  83402. rc = SQLITE_ERROR;
  83403. }else if( v==0 ){
  83404. /* If there is no statement handle, then the blob-handle has
  83405. ** already been invalidated. Return SQLITE_ABORT in this case.
  83406. */
  83407. rc = SQLITE_ABORT;
  83408. }else{
  83409. /* Call either BtreeData() or BtreePutData(). If SQLITE_ABORT is
  83410. ** returned, clean-up the statement handle.
  83411. */
  83412. assert( db == v->db );
  83413. sqlite3BtreeEnterCursor(p->pCsr);
  83414. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  83415. if( xCall==sqlite3BtreePutData && db->xPreUpdateCallback ){
  83416. /* If a pre-update hook is registered and this is a write cursor,
  83417. ** invoke it here.
  83418. **
  83419. ** TODO: The preupdate-hook is passed SQLITE_DELETE, even though this
  83420. ** operation should really be an SQLITE_UPDATE. This is probably
  83421. ** incorrect, but is convenient because at this point the new.* values
  83422. ** are not easily obtainable. And for the sessions module, an
  83423. ** SQLITE_UPDATE where the PK columns do not change is handled in the
  83424. ** same way as an SQLITE_DELETE (the SQLITE_DELETE code is actually
  83425. ** slightly more efficient). Since you cannot write to a PK column
  83426. ** using the incremental-blob API, this works. For the sessions module
  83427. ** anyhow.
  83428. */
  83429. sqlite3_int64 iKey;
  83430. iKey = sqlite3BtreeIntegerKey(p->pCsr);
  83431. sqlite3VdbePreUpdateHook(
  83432. v, v->apCsr[0], SQLITE_DELETE, p->zDb, p->pTab, iKey, -1
  83433. );
  83434. }
  83435. #endif
  83436. rc = xCall(p->pCsr, iOffset+p->iOffset, n, z);
  83437. sqlite3BtreeLeaveCursor(p->pCsr);
  83438. if( rc==SQLITE_ABORT ){
  83439. sqlite3VdbeFinalize(v);
  83440. p->pStmt = 0;
  83441. }else{
  83442. v->rc = rc;
  83443. }
  83444. }
  83445. sqlite3Error(db, rc);
  83446. rc = sqlite3ApiExit(db, rc);
  83447. sqlite3_mutex_leave(db->mutex);
  83448. return rc;
  83449. }
  83450. /*
  83451. ** Read data from a blob handle.
  83452. */
  83453. SQLITE_API int sqlite3_blob_read(sqlite3_blob *pBlob, void *z, int n, int iOffset){
  83454. return blobReadWrite(pBlob, z, n, iOffset, sqlite3BtreePayloadChecked);
  83455. }
  83456. /*
  83457. ** Write data to a blob handle.
  83458. */
  83459. SQLITE_API int sqlite3_blob_write(sqlite3_blob *pBlob, const void *z, int n, int iOffset){
  83460. return blobReadWrite(pBlob, (void *)z, n, iOffset, sqlite3BtreePutData);
  83461. }
  83462. /*
  83463. ** Query a blob handle for the size of the data.
  83464. **
  83465. ** The Incrblob.nByte field is fixed for the lifetime of the Incrblob
  83466. ** so no mutex is required for access.
  83467. */
  83468. SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *pBlob){
  83469. Incrblob *p = (Incrblob *)pBlob;
  83470. return (p && p->pStmt) ? p->nByte : 0;
  83471. }
  83472. /*
  83473. ** Move an existing blob handle to point to a different row of the same
  83474. ** database table.
  83475. **
  83476. ** If an error occurs, or if the specified row does not exist or does not
  83477. ** contain a blob or text value, then an error code is returned and the
  83478. ** database handle error code and message set. If this happens, then all
  83479. ** subsequent calls to sqlite3_blob_xxx() functions (except blob_close())
  83480. ** immediately return SQLITE_ABORT.
  83481. */
  83482. SQLITE_API int sqlite3_blob_reopen(sqlite3_blob *pBlob, sqlite3_int64 iRow){
  83483. int rc;
  83484. Incrblob *p = (Incrblob *)pBlob;
  83485. sqlite3 *db;
  83486. if( p==0 ) return SQLITE_MISUSE_BKPT;
  83487. db = p->db;
  83488. sqlite3_mutex_enter(db->mutex);
  83489. if( p->pStmt==0 ){
  83490. /* If there is no statement handle, then the blob-handle has
  83491. ** already been invalidated. Return SQLITE_ABORT in this case.
  83492. */
  83493. rc = SQLITE_ABORT;
  83494. }else{
  83495. char *zErr;
  83496. rc = blobSeekToRow(p, iRow, &zErr);
  83497. if( rc!=SQLITE_OK ){
  83498. sqlite3ErrorWithMsg(db, rc, (zErr ? "%s" : 0), zErr);
  83499. sqlite3DbFree(db, zErr);
  83500. }
  83501. assert( rc!=SQLITE_SCHEMA );
  83502. }
  83503. rc = sqlite3ApiExit(db, rc);
  83504. assert( rc==SQLITE_OK || p->pStmt==0 );
  83505. sqlite3_mutex_leave(db->mutex);
  83506. return rc;
  83507. }
  83508. #endif /* #ifndef SQLITE_OMIT_INCRBLOB */
  83509. /************** End of vdbeblob.c ********************************************/
  83510. /************** Begin file vdbesort.c ****************************************/
  83511. /*
  83512. ** 2011-07-09
  83513. **
  83514. ** The author disclaims copyright to this source code. In place of
  83515. ** a legal notice, here is a blessing:
  83516. **
  83517. ** May you do good and not evil.
  83518. ** May you find forgiveness for yourself and forgive others.
  83519. ** May you share freely, never taking more than you give.
  83520. **
  83521. *************************************************************************
  83522. ** This file contains code for the VdbeSorter object, used in concert with
  83523. ** a VdbeCursor to sort large numbers of keys for CREATE INDEX statements
  83524. ** or by SELECT statements with ORDER BY clauses that cannot be satisfied
  83525. ** using indexes and without LIMIT clauses.
  83526. **
  83527. ** The VdbeSorter object implements a multi-threaded external merge sort
  83528. ** algorithm that is efficient even if the number of elements being sorted
  83529. ** exceeds the available memory.
  83530. **
  83531. ** Here is the (internal, non-API) interface between this module and the
  83532. ** rest of the SQLite system:
  83533. **
  83534. ** sqlite3VdbeSorterInit() Create a new VdbeSorter object.
  83535. **
  83536. ** sqlite3VdbeSorterWrite() Add a single new row to the VdbeSorter
  83537. ** object. The row is a binary blob in the
  83538. ** OP_MakeRecord format that contains both
  83539. ** the ORDER BY key columns and result columns
  83540. ** in the case of a SELECT w/ ORDER BY, or
  83541. ** the complete record for an index entry
  83542. ** in the case of a CREATE INDEX.
  83543. **
  83544. ** sqlite3VdbeSorterRewind() Sort all content previously added.
  83545. ** Position the read cursor on the
  83546. ** first sorted element.
  83547. **
  83548. ** sqlite3VdbeSorterNext() Advance the read cursor to the next sorted
  83549. ** element.
  83550. **
  83551. ** sqlite3VdbeSorterRowkey() Return the complete binary blob for the
  83552. ** row currently under the read cursor.
  83553. **
  83554. ** sqlite3VdbeSorterCompare() Compare the binary blob for the row
  83555. ** currently under the read cursor against
  83556. ** another binary blob X and report if
  83557. ** X is strictly less than the read cursor.
  83558. ** Used to enforce uniqueness in a
  83559. ** CREATE UNIQUE INDEX statement.
  83560. **
  83561. ** sqlite3VdbeSorterClose() Close the VdbeSorter object and reclaim
  83562. ** all resources.
  83563. **
  83564. ** sqlite3VdbeSorterReset() Refurbish the VdbeSorter for reuse. This
  83565. ** is like Close() followed by Init() only
  83566. ** much faster.
  83567. **
  83568. ** The interfaces above must be called in a particular order. Write() can
  83569. ** only occur in between Init()/Reset() and Rewind(). Next(), Rowkey(), and
  83570. ** Compare() can only occur in between Rewind() and Close()/Reset(). i.e.
  83571. **
  83572. ** Init()
  83573. ** for each record: Write()
  83574. ** Rewind()
  83575. ** Rowkey()/Compare()
  83576. ** Next()
  83577. ** Close()
  83578. **
  83579. ** Algorithm:
  83580. **
  83581. ** Records passed to the sorter via calls to Write() are initially held
  83582. ** unsorted in main memory. Assuming the amount of memory used never exceeds
  83583. ** a threshold, when Rewind() is called the set of records is sorted using
  83584. ** an in-memory merge sort. In this case, no temporary files are required
  83585. ** and subsequent calls to Rowkey(), Next() and Compare() read records
  83586. ** directly from main memory.
  83587. **
  83588. ** If the amount of space used to store records in main memory exceeds the
  83589. ** threshold, then the set of records currently in memory are sorted and
  83590. ** written to a temporary file in "Packed Memory Array" (PMA) format.
  83591. ** A PMA created at this point is known as a "level-0 PMA". Higher levels
  83592. ** of PMAs may be created by merging existing PMAs together - for example
  83593. ** merging two or more level-0 PMAs together creates a level-1 PMA.
  83594. **
  83595. ** The threshold for the amount of main memory to use before flushing
  83596. ** records to a PMA is roughly the same as the limit configured for the
  83597. ** page-cache of the main database. Specifically, the threshold is set to
  83598. ** the value returned by "PRAGMA main.page_size" multipled by
  83599. ** that returned by "PRAGMA main.cache_size", in bytes.
  83600. **
  83601. ** If the sorter is running in single-threaded mode, then all PMAs generated
  83602. ** are appended to a single temporary file. Or, if the sorter is running in
  83603. ** multi-threaded mode then up to (N+1) temporary files may be opened, where
  83604. ** N is the configured number of worker threads. In this case, instead of
  83605. ** sorting the records and writing the PMA to a temporary file itself, the
  83606. ** calling thread usually launches a worker thread to do so. Except, if
  83607. ** there are already N worker threads running, the main thread does the work
  83608. ** itself.
  83609. **
  83610. ** The sorter is running in multi-threaded mode if (a) the library was built
  83611. ** with pre-processor symbol SQLITE_MAX_WORKER_THREADS set to a value greater
  83612. ** than zero, and (b) worker threads have been enabled at runtime by calling
  83613. ** "PRAGMA threads=N" with some value of N greater than 0.
  83614. **
  83615. ** When Rewind() is called, any data remaining in memory is flushed to a
  83616. ** final PMA. So at this point the data is stored in some number of sorted
  83617. ** PMAs within temporary files on disk.
  83618. **
  83619. ** If there are fewer than SORTER_MAX_MERGE_COUNT PMAs in total and the
  83620. ** sorter is running in single-threaded mode, then these PMAs are merged
  83621. ** incrementally as keys are retreived from the sorter by the VDBE. The
  83622. ** MergeEngine object, described in further detail below, performs this
  83623. ** merge.
  83624. **
  83625. ** Or, if running in multi-threaded mode, then a background thread is
  83626. ** launched to merge the existing PMAs. Once the background thread has
  83627. ** merged T bytes of data into a single sorted PMA, the main thread
  83628. ** begins reading keys from that PMA while the background thread proceeds
  83629. ** with merging the next T bytes of data. And so on.
  83630. **
  83631. ** Parameter T is set to half the value of the memory threshold used
  83632. ** by Write() above to determine when to create a new PMA.
  83633. **
  83634. ** If there are more than SORTER_MAX_MERGE_COUNT PMAs in total when
  83635. ** Rewind() is called, then a hierarchy of incremental-merges is used.
  83636. ** First, T bytes of data from the first SORTER_MAX_MERGE_COUNT PMAs on
  83637. ** disk are merged together. Then T bytes of data from the second set, and
  83638. ** so on, such that no operation ever merges more than SORTER_MAX_MERGE_COUNT
  83639. ** PMAs at a time. This done is to improve locality.
  83640. **
  83641. ** If running in multi-threaded mode and there are more than
  83642. ** SORTER_MAX_MERGE_COUNT PMAs on disk when Rewind() is called, then more
  83643. ** than one background thread may be created. Specifically, there may be
  83644. ** one background thread for each temporary file on disk, and one background
  83645. ** thread to merge the output of each of the others to a single PMA for
  83646. ** the main thread to read from.
  83647. */
  83648. /* #include "sqliteInt.h" */
  83649. /* #include "vdbeInt.h" */
  83650. /*
  83651. ** If SQLITE_DEBUG_SORTER_THREADS is defined, this module outputs various
  83652. ** messages to stderr that may be helpful in understanding the performance
  83653. ** characteristics of the sorter in multi-threaded mode.
  83654. */
  83655. #if 0
  83656. # define SQLITE_DEBUG_SORTER_THREADS 1
  83657. #endif
  83658. /*
  83659. ** Hard-coded maximum amount of data to accumulate in memory before flushing
  83660. ** to a level 0 PMA. The purpose of this limit is to prevent various integer
  83661. ** overflows. 512MiB.
  83662. */
  83663. #define SQLITE_MAX_PMASZ (1<<29)
  83664. /*
  83665. ** Private objects used by the sorter
  83666. */
  83667. typedef struct MergeEngine MergeEngine; /* Merge PMAs together */
  83668. typedef struct PmaReader PmaReader; /* Incrementally read one PMA */
  83669. typedef struct PmaWriter PmaWriter; /* Incrementally write one PMA */
  83670. typedef struct SorterRecord SorterRecord; /* A record being sorted */
  83671. typedef struct SortSubtask SortSubtask; /* A sub-task in the sort process */
  83672. typedef struct SorterFile SorterFile; /* Temporary file object wrapper */
  83673. typedef struct SorterList SorterList; /* In-memory list of records */
  83674. typedef struct IncrMerger IncrMerger; /* Read & merge multiple PMAs */
  83675. /*
  83676. ** A container for a temp file handle and the current amount of data
  83677. ** stored in the file.
  83678. */
  83679. struct SorterFile {
  83680. sqlite3_file *pFd; /* File handle */
  83681. i64 iEof; /* Bytes of data stored in pFd */
  83682. };
  83683. /*
  83684. ** An in-memory list of objects to be sorted.
  83685. **
  83686. ** If aMemory==0 then each object is allocated separately and the objects
  83687. ** are connected using SorterRecord.u.pNext. If aMemory!=0 then all objects
  83688. ** are stored in the aMemory[] bulk memory, one right after the other, and
  83689. ** are connected using SorterRecord.u.iNext.
  83690. */
  83691. struct SorterList {
  83692. SorterRecord *pList; /* Linked list of records */
  83693. u8 *aMemory; /* If non-NULL, bulk memory to hold pList */
  83694. int szPMA; /* Size of pList as PMA in bytes */
  83695. };
  83696. /*
  83697. ** The MergeEngine object is used to combine two or more smaller PMAs into
  83698. ** one big PMA using a merge operation. Separate PMAs all need to be
  83699. ** combined into one big PMA in order to be able to step through the sorted
  83700. ** records in order.
  83701. **
  83702. ** The aReadr[] array contains a PmaReader object for each of the PMAs being
  83703. ** merged. An aReadr[] object either points to a valid key or else is at EOF.
  83704. ** ("EOF" means "End Of File". When aReadr[] is at EOF there is no more data.)
  83705. ** For the purposes of the paragraphs below, we assume that the array is
  83706. ** actually N elements in size, where N is the smallest power of 2 greater
  83707. ** to or equal to the number of PMAs being merged. The extra aReadr[] elements
  83708. ** are treated as if they are empty (always at EOF).
  83709. **
  83710. ** The aTree[] array is also N elements in size. The value of N is stored in
  83711. ** the MergeEngine.nTree variable.
  83712. **
  83713. ** The final (N/2) elements of aTree[] contain the results of comparing
  83714. ** pairs of PMA keys together. Element i contains the result of
  83715. ** comparing aReadr[2*i-N] and aReadr[2*i-N+1]. Whichever key is smaller, the
  83716. ** aTree element is set to the index of it.
  83717. **
  83718. ** For the purposes of this comparison, EOF is considered greater than any
  83719. ** other key value. If the keys are equal (only possible with two EOF
  83720. ** values), it doesn't matter which index is stored.
  83721. **
  83722. ** The (N/4) elements of aTree[] that precede the final (N/2) described
  83723. ** above contains the index of the smallest of each block of 4 PmaReaders
  83724. ** And so on. So that aTree[1] contains the index of the PmaReader that
  83725. ** currently points to the smallest key value. aTree[0] is unused.
  83726. **
  83727. ** Example:
  83728. **
  83729. ** aReadr[0] -> Banana
  83730. ** aReadr[1] -> Feijoa
  83731. ** aReadr[2] -> Elderberry
  83732. ** aReadr[3] -> Currant
  83733. ** aReadr[4] -> Grapefruit
  83734. ** aReadr[5] -> Apple
  83735. ** aReadr[6] -> Durian
  83736. ** aReadr[7] -> EOF
  83737. **
  83738. ** aTree[] = { X, 5 0, 5 0, 3, 5, 6 }
  83739. **
  83740. ** The current element is "Apple" (the value of the key indicated by
  83741. ** PmaReader 5). When the Next() operation is invoked, PmaReader 5 will
  83742. ** be advanced to the next key in its segment. Say the next key is
  83743. ** "Eggplant":
  83744. **
  83745. ** aReadr[5] -> Eggplant
  83746. **
  83747. ** The contents of aTree[] are updated first by comparing the new PmaReader
  83748. ** 5 key to the current key of PmaReader 4 (still "Grapefruit"). The PmaReader
  83749. ** 5 value is still smaller, so aTree[6] is set to 5. And so on up the tree.
  83750. ** The value of PmaReader 6 - "Durian" - is now smaller than that of PmaReader
  83751. ** 5, so aTree[3] is set to 6. Key 0 is smaller than key 6 (Banana<Durian),
  83752. ** so the value written into element 1 of the array is 0. As follows:
  83753. **
  83754. ** aTree[] = { X, 0 0, 6 0, 3, 5, 6 }
  83755. **
  83756. ** In other words, each time we advance to the next sorter element, log2(N)
  83757. ** key comparison operations are required, where N is the number of segments
  83758. ** being merged (rounded up to the next power of 2).
  83759. */
  83760. struct MergeEngine {
  83761. int nTree; /* Used size of aTree/aReadr (power of 2) */
  83762. SortSubtask *pTask; /* Used by this thread only */
  83763. int *aTree; /* Current state of incremental merge */
  83764. PmaReader *aReadr; /* Array of PmaReaders to merge data from */
  83765. };
  83766. /*
  83767. ** This object represents a single thread of control in a sort operation.
  83768. ** Exactly VdbeSorter.nTask instances of this object are allocated
  83769. ** as part of each VdbeSorter object. Instances are never allocated any
  83770. ** other way. VdbeSorter.nTask is set to the number of worker threads allowed
  83771. ** (see SQLITE_CONFIG_WORKER_THREADS) plus one (the main thread). Thus for
  83772. ** single-threaded operation, there is exactly one instance of this object
  83773. ** and for multi-threaded operation there are two or more instances.
  83774. **
  83775. ** Essentially, this structure contains all those fields of the VdbeSorter
  83776. ** structure for which each thread requires a separate instance. For example,
  83777. ** each thread requries its own UnpackedRecord object to unpack records in
  83778. ** as part of comparison operations.
  83779. **
  83780. ** Before a background thread is launched, variable bDone is set to 0. Then,
  83781. ** right before it exits, the thread itself sets bDone to 1. This is used for
  83782. ** two purposes:
  83783. **
  83784. ** 1. When flushing the contents of memory to a level-0 PMA on disk, to
  83785. ** attempt to select a SortSubtask for which there is not already an
  83786. ** active background thread (since doing so causes the main thread
  83787. ** to block until it finishes).
  83788. **
  83789. ** 2. If SQLITE_DEBUG_SORTER_THREADS is defined, to determine if a call
  83790. ** to sqlite3ThreadJoin() is likely to block. Cases that are likely to
  83791. ** block provoke debugging output.
  83792. **
  83793. ** In both cases, the effects of the main thread seeing (bDone==0) even
  83794. ** after the thread has finished are not dire. So we don't worry about
  83795. ** memory barriers and such here.
  83796. */
  83797. typedef int (*SorterCompare)(SortSubtask*,int*,const void*,int,const void*,int);
  83798. struct SortSubtask {
  83799. SQLiteThread *pThread; /* Background thread, if any */
  83800. int bDone; /* Set if thread is finished but not joined */
  83801. VdbeSorter *pSorter; /* Sorter that owns this sub-task */
  83802. UnpackedRecord *pUnpacked; /* Space to unpack a record */
  83803. SorterList list; /* List for thread to write to a PMA */
  83804. int nPMA; /* Number of PMAs currently in file */
  83805. SorterCompare xCompare; /* Compare function to use */
  83806. SorterFile file; /* Temp file for level-0 PMAs */
  83807. SorterFile file2; /* Space for other PMAs */
  83808. };
  83809. /*
  83810. ** Main sorter structure. A single instance of this is allocated for each
  83811. ** sorter cursor created by the VDBE.
  83812. **
  83813. ** mxKeysize:
  83814. ** As records are added to the sorter by calls to sqlite3VdbeSorterWrite(),
  83815. ** this variable is updated so as to be set to the size on disk of the
  83816. ** largest record in the sorter.
  83817. */
  83818. struct VdbeSorter {
  83819. int mnPmaSize; /* Minimum PMA size, in bytes */
  83820. int mxPmaSize; /* Maximum PMA size, in bytes. 0==no limit */
  83821. int mxKeysize; /* Largest serialized key seen so far */
  83822. int pgsz; /* Main database page size */
  83823. PmaReader *pReader; /* Readr data from here after Rewind() */
  83824. MergeEngine *pMerger; /* Or here, if bUseThreads==0 */
  83825. sqlite3 *db; /* Database connection */
  83826. KeyInfo *pKeyInfo; /* How to compare records */
  83827. UnpackedRecord *pUnpacked; /* Used by VdbeSorterCompare() */
  83828. SorterList list; /* List of in-memory records */
  83829. int iMemory; /* Offset of free space in list.aMemory */
  83830. int nMemory; /* Size of list.aMemory allocation in bytes */
  83831. u8 bUsePMA; /* True if one or more PMAs created */
  83832. u8 bUseThreads; /* True to use background threads */
  83833. u8 iPrev; /* Previous thread used to flush PMA */
  83834. u8 nTask; /* Size of aTask[] array */
  83835. u8 typeMask;
  83836. SortSubtask aTask[1]; /* One or more subtasks */
  83837. };
  83838. #define SORTER_TYPE_INTEGER 0x01
  83839. #define SORTER_TYPE_TEXT 0x02
  83840. /*
  83841. ** An instance of the following object is used to read records out of a
  83842. ** PMA, in sorted order. The next key to be read is cached in nKey/aKey.
  83843. ** aKey might point into aMap or into aBuffer. If neither of those locations
  83844. ** contain a contiguous representation of the key, then aAlloc is allocated
  83845. ** and the key is copied into aAlloc and aKey is made to poitn to aAlloc.
  83846. **
  83847. ** pFd==0 at EOF.
  83848. */
  83849. struct PmaReader {
  83850. i64 iReadOff; /* Current read offset */
  83851. i64 iEof; /* 1 byte past EOF for this PmaReader */
  83852. int nAlloc; /* Bytes of space at aAlloc */
  83853. int nKey; /* Number of bytes in key */
  83854. sqlite3_file *pFd; /* File handle we are reading from */
  83855. u8 *aAlloc; /* Space for aKey if aBuffer and pMap wont work */
  83856. u8 *aKey; /* Pointer to current key */
  83857. u8 *aBuffer; /* Current read buffer */
  83858. int nBuffer; /* Size of read buffer in bytes */
  83859. u8 *aMap; /* Pointer to mapping of entire file */
  83860. IncrMerger *pIncr; /* Incremental merger */
  83861. };
  83862. /*
  83863. ** Normally, a PmaReader object iterates through an existing PMA stored
  83864. ** within a temp file. However, if the PmaReader.pIncr variable points to
  83865. ** an object of the following type, it may be used to iterate/merge through
  83866. ** multiple PMAs simultaneously.
  83867. **
  83868. ** There are two types of IncrMerger object - single (bUseThread==0) and
  83869. ** multi-threaded (bUseThread==1).
  83870. **
  83871. ** A multi-threaded IncrMerger object uses two temporary files - aFile[0]
  83872. ** and aFile[1]. Neither file is allowed to grow to more than mxSz bytes in
  83873. ** size. When the IncrMerger is initialized, it reads enough data from
  83874. ** pMerger to populate aFile[0]. It then sets variables within the
  83875. ** corresponding PmaReader object to read from that file and kicks off
  83876. ** a background thread to populate aFile[1] with the next mxSz bytes of
  83877. ** sorted record data from pMerger.
  83878. **
  83879. ** When the PmaReader reaches the end of aFile[0], it blocks until the
  83880. ** background thread has finished populating aFile[1]. It then exchanges
  83881. ** the contents of the aFile[0] and aFile[1] variables within this structure,
  83882. ** sets the PmaReader fields to read from the new aFile[0] and kicks off
  83883. ** another background thread to populate the new aFile[1]. And so on, until
  83884. ** the contents of pMerger are exhausted.
  83885. **
  83886. ** A single-threaded IncrMerger does not open any temporary files of its
  83887. ** own. Instead, it has exclusive access to mxSz bytes of space beginning
  83888. ** at offset iStartOff of file pTask->file2. And instead of using a
  83889. ** background thread to prepare data for the PmaReader, with a single
  83890. ** threaded IncrMerger the allocate part of pTask->file2 is "refilled" with
  83891. ** keys from pMerger by the calling thread whenever the PmaReader runs out
  83892. ** of data.
  83893. */
  83894. struct IncrMerger {
  83895. SortSubtask *pTask; /* Task that owns this merger */
  83896. MergeEngine *pMerger; /* Merge engine thread reads data from */
  83897. i64 iStartOff; /* Offset to start writing file at */
  83898. int mxSz; /* Maximum bytes of data to store */
  83899. int bEof; /* Set to true when merge is finished */
  83900. int bUseThread; /* True to use a bg thread for this object */
  83901. SorterFile aFile[2]; /* aFile[0] for reading, [1] for writing */
  83902. };
  83903. /*
  83904. ** An instance of this object is used for writing a PMA.
  83905. **
  83906. ** The PMA is written one record at a time. Each record is of an arbitrary
  83907. ** size. But I/O is more efficient if it occurs in page-sized blocks where
  83908. ** each block is aligned on a page boundary. This object caches writes to
  83909. ** the PMA so that aligned, page-size blocks are written.
  83910. */
  83911. struct PmaWriter {
  83912. int eFWErr; /* Non-zero if in an error state */
  83913. u8 *aBuffer; /* Pointer to write buffer */
  83914. int nBuffer; /* Size of write buffer in bytes */
  83915. int iBufStart; /* First byte of buffer to write */
  83916. int iBufEnd; /* Last byte of buffer to write */
  83917. i64 iWriteOff; /* Offset of start of buffer in file */
  83918. sqlite3_file *pFd; /* File handle to write to */
  83919. };
  83920. /*
  83921. ** This object is the header on a single record while that record is being
  83922. ** held in memory and prior to being written out as part of a PMA.
  83923. **
  83924. ** How the linked list is connected depends on how memory is being managed
  83925. ** by this module. If using a separate allocation for each in-memory record
  83926. ** (VdbeSorter.list.aMemory==0), then the list is always connected using the
  83927. ** SorterRecord.u.pNext pointers.
  83928. **
  83929. ** Or, if using the single large allocation method (VdbeSorter.list.aMemory!=0),
  83930. ** then while records are being accumulated the list is linked using the
  83931. ** SorterRecord.u.iNext offset. This is because the aMemory[] array may
  83932. ** be sqlite3Realloc()ed while records are being accumulated. Once the VM
  83933. ** has finished passing records to the sorter, or when the in-memory buffer
  83934. ** is full, the list is sorted. As part of the sorting process, it is
  83935. ** converted to use the SorterRecord.u.pNext pointers. See function
  83936. ** vdbeSorterSort() for details.
  83937. */
  83938. struct SorterRecord {
  83939. int nVal; /* Size of the record in bytes */
  83940. union {
  83941. SorterRecord *pNext; /* Pointer to next record in list */
  83942. int iNext; /* Offset within aMemory of next record */
  83943. } u;
  83944. /* The data for the record immediately follows this header */
  83945. };
  83946. /* Return a pointer to the buffer containing the record data for SorterRecord
  83947. ** object p. Should be used as if:
  83948. **
  83949. ** void *SRVAL(SorterRecord *p) { return (void*)&p[1]; }
  83950. */
  83951. #define SRVAL(p) ((void*)((SorterRecord*)(p) + 1))
  83952. /* Maximum number of PMAs that a single MergeEngine can merge */
  83953. #define SORTER_MAX_MERGE_COUNT 16
  83954. static int vdbeIncrSwap(IncrMerger*);
  83955. static void vdbeIncrFree(IncrMerger *);
  83956. /*
  83957. ** Free all memory belonging to the PmaReader object passed as the
  83958. ** argument. All structure fields are set to zero before returning.
  83959. */
  83960. static void vdbePmaReaderClear(PmaReader *pReadr){
  83961. sqlite3_free(pReadr->aAlloc);
  83962. sqlite3_free(pReadr->aBuffer);
  83963. if( pReadr->aMap ) sqlite3OsUnfetch(pReadr->pFd, 0, pReadr->aMap);
  83964. vdbeIncrFree(pReadr->pIncr);
  83965. memset(pReadr, 0, sizeof(PmaReader));
  83966. }
  83967. /*
  83968. ** Read the next nByte bytes of data from the PMA p.
  83969. ** If successful, set *ppOut to point to a buffer containing the data
  83970. ** and return SQLITE_OK. Otherwise, if an error occurs, return an SQLite
  83971. ** error code.
  83972. **
  83973. ** The buffer returned in *ppOut is only valid until the
  83974. ** next call to this function.
  83975. */
  83976. static int vdbePmaReadBlob(
  83977. PmaReader *p, /* PmaReader from which to take the blob */
  83978. int nByte, /* Bytes of data to read */
  83979. u8 **ppOut /* OUT: Pointer to buffer containing data */
  83980. ){
  83981. int iBuf; /* Offset within buffer to read from */
  83982. int nAvail; /* Bytes of data available in buffer */
  83983. if( p->aMap ){
  83984. *ppOut = &p->aMap[p->iReadOff];
  83985. p->iReadOff += nByte;
  83986. return SQLITE_OK;
  83987. }
  83988. assert( p->aBuffer );
  83989. /* If there is no more data to be read from the buffer, read the next
  83990. ** p->nBuffer bytes of data from the file into it. Or, if there are less
  83991. ** than p->nBuffer bytes remaining in the PMA, read all remaining data. */
  83992. iBuf = p->iReadOff % p->nBuffer;
  83993. if( iBuf==0 ){
  83994. int nRead; /* Bytes to read from disk */
  83995. int rc; /* sqlite3OsRead() return code */
  83996. /* Determine how many bytes of data to read. */
  83997. if( (p->iEof - p->iReadOff) > (i64)p->nBuffer ){
  83998. nRead = p->nBuffer;
  83999. }else{
  84000. nRead = (int)(p->iEof - p->iReadOff);
  84001. }
  84002. assert( nRead>0 );
  84003. /* Readr data from the file. Return early if an error occurs. */
  84004. rc = sqlite3OsRead(p->pFd, p->aBuffer, nRead, p->iReadOff);
  84005. assert( rc!=SQLITE_IOERR_SHORT_READ );
  84006. if( rc!=SQLITE_OK ) return rc;
  84007. }
  84008. nAvail = p->nBuffer - iBuf;
  84009. if( nByte<=nAvail ){
  84010. /* The requested data is available in the in-memory buffer. In this
  84011. ** case there is no need to make a copy of the data, just return a
  84012. ** pointer into the buffer to the caller. */
  84013. *ppOut = &p->aBuffer[iBuf];
  84014. p->iReadOff += nByte;
  84015. }else{
  84016. /* The requested data is not all available in the in-memory buffer.
  84017. ** In this case, allocate space at p->aAlloc[] to copy the requested
  84018. ** range into. Then return a copy of pointer p->aAlloc to the caller. */
  84019. int nRem; /* Bytes remaining to copy */
  84020. /* Extend the p->aAlloc[] allocation if required. */
  84021. if( p->nAlloc<nByte ){
  84022. u8 *aNew;
  84023. int nNew = MAX(128, p->nAlloc*2);
  84024. while( nByte>nNew ) nNew = nNew*2;
  84025. aNew = sqlite3Realloc(p->aAlloc, nNew);
  84026. if( !aNew ) return SQLITE_NOMEM_BKPT;
  84027. p->nAlloc = nNew;
  84028. p->aAlloc = aNew;
  84029. }
  84030. /* Copy as much data as is available in the buffer into the start of
  84031. ** p->aAlloc[]. */
  84032. memcpy(p->aAlloc, &p->aBuffer[iBuf], nAvail);
  84033. p->iReadOff += nAvail;
  84034. nRem = nByte - nAvail;
  84035. /* The following loop copies up to p->nBuffer bytes per iteration into
  84036. ** the p->aAlloc[] buffer. */
  84037. while( nRem>0 ){
  84038. int rc; /* vdbePmaReadBlob() return code */
  84039. int nCopy; /* Number of bytes to copy */
  84040. u8 *aNext; /* Pointer to buffer to copy data from */
  84041. nCopy = nRem;
  84042. if( nRem>p->nBuffer ) nCopy = p->nBuffer;
  84043. rc = vdbePmaReadBlob(p, nCopy, &aNext);
  84044. if( rc!=SQLITE_OK ) return rc;
  84045. assert( aNext!=p->aAlloc );
  84046. memcpy(&p->aAlloc[nByte - nRem], aNext, nCopy);
  84047. nRem -= nCopy;
  84048. }
  84049. *ppOut = p->aAlloc;
  84050. }
  84051. return SQLITE_OK;
  84052. }
  84053. /*
  84054. ** Read a varint from the stream of data accessed by p. Set *pnOut to
  84055. ** the value read.
  84056. */
  84057. static int vdbePmaReadVarint(PmaReader *p, u64 *pnOut){
  84058. int iBuf;
  84059. if( p->aMap ){
  84060. p->iReadOff += sqlite3GetVarint(&p->aMap[p->iReadOff], pnOut);
  84061. }else{
  84062. iBuf = p->iReadOff % p->nBuffer;
  84063. if( iBuf && (p->nBuffer-iBuf)>=9 ){
  84064. p->iReadOff += sqlite3GetVarint(&p->aBuffer[iBuf], pnOut);
  84065. }else{
  84066. u8 aVarint[16], *a;
  84067. int i = 0, rc;
  84068. do{
  84069. rc = vdbePmaReadBlob(p, 1, &a);
  84070. if( rc ) return rc;
  84071. aVarint[(i++)&0xf] = a[0];
  84072. }while( (a[0]&0x80)!=0 );
  84073. sqlite3GetVarint(aVarint, pnOut);
  84074. }
  84075. }
  84076. return SQLITE_OK;
  84077. }
  84078. /*
  84079. ** Attempt to memory map file pFile. If successful, set *pp to point to the
  84080. ** new mapping and return SQLITE_OK. If the mapping is not attempted
  84081. ** (because the file is too large or the VFS layer is configured not to use
  84082. ** mmap), return SQLITE_OK and set *pp to NULL.
  84083. **
  84084. ** Or, if an error occurs, return an SQLite error code. The final value of
  84085. ** *pp is undefined in this case.
  84086. */
  84087. static int vdbeSorterMapFile(SortSubtask *pTask, SorterFile *pFile, u8 **pp){
  84088. int rc = SQLITE_OK;
  84089. if( pFile->iEof<=(i64)(pTask->pSorter->db->nMaxSorterMmap) ){
  84090. sqlite3_file *pFd = pFile->pFd;
  84091. if( pFd->pMethods->iVersion>=3 ){
  84092. rc = sqlite3OsFetch(pFd, 0, (int)pFile->iEof, (void**)pp);
  84093. testcase( rc!=SQLITE_OK );
  84094. }
  84095. }
  84096. return rc;
  84097. }
  84098. /*
  84099. ** Attach PmaReader pReadr to file pFile (if it is not already attached to
  84100. ** that file) and seek it to offset iOff within the file. Return SQLITE_OK
  84101. ** if successful, or an SQLite error code if an error occurs.
  84102. */
  84103. static int vdbePmaReaderSeek(
  84104. SortSubtask *pTask, /* Task context */
  84105. PmaReader *pReadr, /* Reader whose cursor is to be moved */
  84106. SorterFile *pFile, /* Sorter file to read from */
  84107. i64 iOff /* Offset in pFile */
  84108. ){
  84109. int rc = SQLITE_OK;
  84110. assert( pReadr->pIncr==0 || pReadr->pIncr->bEof==0 );
  84111. if( sqlite3FaultSim(201) ) return SQLITE_IOERR_READ;
  84112. if( pReadr->aMap ){
  84113. sqlite3OsUnfetch(pReadr->pFd, 0, pReadr->aMap);
  84114. pReadr->aMap = 0;
  84115. }
  84116. pReadr->iReadOff = iOff;
  84117. pReadr->iEof = pFile->iEof;
  84118. pReadr->pFd = pFile->pFd;
  84119. rc = vdbeSorterMapFile(pTask, pFile, &pReadr->aMap);
  84120. if( rc==SQLITE_OK && pReadr->aMap==0 ){
  84121. int pgsz = pTask->pSorter->pgsz;
  84122. int iBuf = pReadr->iReadOff % pgsz;
  84123. if( pReadr->aBuffer==0 ){
  84124. pReadr->aBuffer = (u8*)sqlite3Malloc(pgsz);
  84125. if( pReadr->aBuffer==0 ) rc = SQLITE_NOMEM_BKPT;
  84126. pReadr->nBuffer = pgsz;
  84127. }
  84128. if( rc==SQLITE_OK && iBuf ){
  84129. int nRead = pgsz - iBuf;
  84130. if( (pReadr->iReadOff + nRead) > pReadr->iEof ){
  84131. nRead = (int)(pReadr->iEof - pReadr->iReadOff);
  84132. }
  84133. rc = sqlite3OsRead(
  84134. pReadr->pFd, &pReadr->aBuffer[iBuf], nRead, pReadr->iReadOff
  84135. );
  84136. testcase( rc!=SQLITE_OK );
  84137. }
  84138. }
  84139. return rc;
  84140. }
  84141. /*
  84142. ** Advance PmaReader pReadr to the next key in its PMA. Return SQLITE_OK if
  84143. ** no error occurs, or an SQLite error code if one does.
  84144. */
  84145. static int vdbePmaReaderNext(PmaReader *pReadr){
  84146. int rc = SQLITE_OK; /* Return Code */
  84147. u64 nRec = 0; /* Size of record in bytes */
  84148. if( pReadr->iReadOff>=pReadr->iEof ){
  84149. IncrMerger *pIncr = pReadr->pIncr;
  84150. int bEof = 1;
  84151. if( pIncr ){
  84152. rc = vdbeIncrSwap(pIncr);
  84153. if( rc==SQLITE_OK && pIncr->bEof==0 ){
  84154. rc = vdbePmaReaderSeek(
  84155. pIncr->pTask, pReadr, &pIncr->aFile[0], pIncr->iStartOff
  84156. );
  84157. bEof = 0;
  84158. }
  84159. }
  84160. if( bEof ){
  84161. /* This is an EOF condition */
  84162. vdbePmaReaderClear(pReadr);
  84163. testcase( rc!=SQLITE_OK );
  84164. return rc;
  84165. }
  84166. }
  84167. if( rc==SQLITE_OK ){
  84168. rc = vdbePmaReadVarint(pReadr, &nRec);
  84169. }
  84170. if( rc==SQLITE_OK ){
  84171. pReadr->nKey = (int)nRec;
  84172. rc = vdbePmaReadBlob(pReadr, (int)nRec, &pReadr->aKey);
  84173. testcase( rc!=SQLITE_OK );
  84174. }
  84175. return rc;
  84176. }
  84177. /*
  84178. ** Initialize PmaReader pReadr to scan through the PMA stored in file pFile
  84179. ** starting at offset iStart and ending at offset iEof-1. This function
  84180. ** leaves the PmaReader pointing to the first key in the PMA (or EOF if the
  84181. ** PMA is empty).
  84182. **
  84183. ** If the pnByte parameter is NULL, then it is assumed that the file
  84184. ** contains a single PMA, and that that PMA omits the initial length varint.
  84185. */
  84186. static int vdbePmaReaderInit(
  84187. SortSubtask *pTask, /* Task context */
  84188. SorterFile *pFile, /* Sorter file to read from */
  84189. i64 iStart, /* Start offset in pFile */
  84190. PmaReader *pReadr, /* PmaReader to populate */
  84191. i64 *pnByte /* IN/OUT: Increment this value by PMA size */
  84192. ){
  84193. int rc;
  84194. assert( pFile->iEof>iStart );
  84195. assert( pReadr->aAlloc==0 && pReadr->nAlloc==0 );
  84196. assert( pReadr->aBuffer==0 );
  84197. assert( pReadr->aMap==0 );
  84198. rc = vdbePmaReaderSeek(pTask, pReadr, pFile, iStart);
  84199. if( rc==SQLITE_OK ){
  84200. u64 nByte = 0; /* Size of PMA in bytes */
  84201. rc = vdbePmaReadVarint(pReadr, &nByte);
  84202. pReadr->iEof = pReadr->iReadOff + nByte;
  84203. *pnByte += nByte;
  84204. }
  84205. if( rc==SQLITE_OK ){
  84206. rc = vdbePmaReaderNext(pReadr);
  84207. }
  84208. return rc;
  84209. }
  84210. /*
  84211. ** A version of vdbeSorterCompare() that assumes that it has already been
  84212. ** determined that the first field of key1 is equal to the first field of
  84213. ** key2.
  84214. */
  84215. static int vdbeSorterCompareTail(
  84216. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  84217. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  84218. const void *pKey1, int nKey1, /* Left side of comparison */
  84219. const void *pKey2, int nKey2 /* Right side of comparison */
  84220. ){
  84221. UnpackedRecord *r2 = pTask->pUnpacked;
  84222. if( *pbKey2Cached==0 ){
  84223. sqlite3VdbeRecordUnpack(pTask->pSorter->pKeyInfo, nKey2, pKey2, r2);
  84224. *pbKey2Cached = 1;
  84225. }
  84226. return sqlite3VdbeRecordCompareWithSkip(nKey1, pKey1, r2, 1);
  84227. }
  84228. /*
  84229. ** Compare key1 (buffer pKey1, size nKey1 bytes) with key2 (buffer pKey2,
  84230. ** size nKey2 bytes). Use (pTask->pKeyInfo) for the collation sequences
  84231. ** used by the comparison. Return the result of the comparison.
  84232. **
  84233. ** If IN/OUT parameter *pbKey2Cached is true when this function is called,
  84234. ** it is assumed that (pTask->pUnpacked) contains the unpacked version
  84235. ** of key2. If it is false, (pTask->pUnpacked) is populated with the unpacked
  84236. ** version of key2 and *pbKey2Cached set to true before returning.
  84237. **
  84238. ** If an OOM error is encountered, (pTask->pUnpacked->error_rc) is set
  84239. ** to SQLITE_NOMEM.
  84240. */
  84241. static int vdbeSorterCompare(
  84242. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  84243. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  84244. const void *pKey1, int nKey1, /* Left side of comparison */
  84245. const void *pKey2, int nKey2 /* Right side of comparison */
  84246. ){
  84247. UnpackedRecord *r2 = pTask->pUnpacked;
  84248. if( !*pbKey2Cached ){
  84249. sqlite3VdbeRecordUnpack(pTask->pSorter->pKeyInfo, nKey2, pKey2, r2);
  84250. *pbKey2Cached = 1;
  84251. }
  84252. return sqlite3VdbeRecordCompare(nKey1, pKey1, r2);
  84253. }
  84254. /*
  84255. ** A specially optimized version of vdbeSorterCompare() that assumes that
  84256. ** the first field of each key is a TEXT value and that the collation
  84257. ** sequence to compare them with is BINARY.
  84258. */
  84259. static int vdbeSorterCompareText(
  84260. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  84261. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  84262. const void *pKey1, int nKey1, /* Left side of comparison */
  84263. const void *pKey2, int nKey2 /* Right side of comparison */
  84264. ){
  84265. const u8 * const p1 = (const u8 * const)pKey1;
  84266. const u8 * const p2 = (const u8 * const)pKey2;
  84267. const u8 * const v1 = &p1[ p1[0] ]; /* Pointer to value 1 */
  84268. const u8 * const v2 = &p2[ p2[0] ]; /* Pointer to value 2 */
  84269. int n1;
  84270. int n2;
  84271. int res;
  84272. getVarint32(&p1[1], n1);
  84273. getVarint32(&p2[1], n2);
  84274. res = memcmp(v1, v2, (MIN(n1, n2) - 13)/2);
  84275. if( res==0 ){
  84276. res = n1 - n2;
  84277. }
  84278. if( res==0 ){
  84279. if( pTask->pSorter->pKeyInfo->nKeyField>1 ){
  84280. res = vdbeSorterCompareTail(
  84281. pTask, pbKey2Cached, pKey1, nKey1, pKey2, nKey2
  84282. );
  84283. }
  84284. }else{
  84285. if( pTask->pSorter->pKeyInfo->aSortOrder[0] ){
  84286. res = res * -1;
  84287. }
  84288. }
  84289. return res;
  84290. }
  84291. /*
  84292. ** A specially optimized version of vdbeSorterCompare() that assumes that
  84293. ** the first field of each key is an INTEGER value.
  84294. */
  84295. static int vdbeSorterCompareInt(
  84296. SortSubtask *pTask, /* Subtask context (for pKeyInfo) */
  84297. int *pbKey2Cached, /* True if pTask->pUnpacked is pKey2 */
  84298. const void *pKey1, int nKey1, /* Left side of comparison */
  84299. const void *pKey2, int nKey2 /* Right side of comparison */
  84300. ){
  84301. const u8 * const p1 = (const u8 * const)pKey1;
  84302. const u8 * const p2 = (const u8 * const)pKey2;
  84303. const int s1 = p1[1]; /* Left hand serial type */
  84304. const int s2 = p2[1]; /* Right hand serial type */
  84305. const u8 * const v1 = &p1[ p1[0] ]; /* Pointer to value 1 */
  84306. const u8 * const v2 = &p2[ p2[0] ]; /* Pointer to value 2 */
  84307. int res; /* Return value */
  84308. assert( (s1>0 && s1<7) || s1==8 || s1==9 );
  84309. assert( (s2>0 && s2<7) || s2==8 || s2==9 );
  84310. if( s1==s2 ){
  84311. /* The two values have the same sign. Compare using memcmp(). */
  84312. static const u8 aLen[] = {0, 1, 2, 3, 4, 6, 8, 0, 0, 0 };
  84313. const u8 n = aLen[s1];
  84314. int i;
  84315. res = 0;
  84316. for(i=0; i<n; i++){
  84317. if( (res = v1[i] - v2[i])!=0 ){
  84318. if( ((v1[0] ^ v2[0]) & 0x80)!=0 ){
  84319. res = v1[0] & 0x80 ? -1 : +1;
  84320. }
  84321. break;
  84322. }
  84323. }
  84324. }else if( s1>7 && s2>7 ){
  84325. res = s1 - s2;
  84326. }else{
  84327. if( s2>7 ){
  84328. res = +1;
  84329. }else if( s1>7 ){
  84330. res = -1;
  84331. }else{
  84332. res = s1 - s2;
  84333. }
  84334. assert( res!=0 );
  84335. if( res>0 ){
  84336. if( *v1 & 0x80 ) res = -1;
  84337. }else{
  84338. if( *v2 & 0x80 ) res = +1;
  84339. }
  84340. }
  84341. if( res==0 ){
  84342. if( pTask->pSorter->pKeyInfo->nKeyField>1 ){
  84343. res = vdbeSorterCompareTail(
  84344. pTask, pbKey2Cached, pKey1, nKey1, pKey2, nKey2
  84345. );
  84346. }
  84347. }else if( pTask->pSorter->pKeyInfo->aSortOrder[0] ){
  84348. res = res * -1;
  84349. }
  84350. return res;
  84351. }
  84352. /*
  84353. ** Initialize the temporary index cursor just opened as a sorter cursor.
  84354. **
  84355. ** Usually, the sorter module uses the value of (pCsr->pKeyInfo->nKeyField)
  84356. ** to determine the number of fields that should be compared from the
  84357. ** records being sorted. However, if the value passed as argument nField
  84358. ** is non-zero and the sorter is able to guarantee a stable sort, nField
  84359. ** is used instead. This is used when sorting records for a CREATE INDEX
  84360. ** statement. In this case, keys are always delivered to the sorter in
  84361. ** order of the primary key, which happens to be make up the final part
  84362. ** of the records being sorted. So if the sort is stable, there is never
  84363. ** any reason to compare PK fields and they can be ignored for a small
  84364. ** performance boost.
  84365. **
  84366. ** The sorter can guarantee a stable sort when running in single-threaded
  84367. ** mode, but not in multi-threaded mode.
  84368. **
  84369. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  84370. */
  84371. SQLITE_PRIVATE int sqlite3VdbeSorterInit(
  84372. sqlite3 *db, /* Database connection (for malloc()) */
  84373. int nField, /* Number of key fields in each record */
  84374. VdbeCursor *pCsr /* Cursor that holds the new sorter */
  84375. ){
  84376. int pgsz; /* Page size of main database */
  84377. int i; /* Used to iterate through aTask[] */
  84378. VdbeSorter *pSorter; /* The new sorter */
  84379. KeyInfo *pKeyInfo; /* Copy of pCsr->pKeyInfo with db==0 */
  84380. int szKeyInfo; /* Size of pCsr->pKeyInfo in bytes */
  84381. int sz; /* Size of pSorter in bytes */
  84382. int rc = SQLITE_OK;
  84383. #if SQLITE_MAX_WORKER_THREADS==0
  84384. # define nWorker 0
  84385. #else
  84386. int nWorker;
  84387. #endif
  84388. /* Initialize the upper limit on the number of worker threads */
  84389. #if SQLITE_MAX_WORKER_THREADS>0
  84390. if( sqlite3TempInMemory(db) || sqlite3GlobalConfig.bCoreMutex==0 ){
  84391. nWorker = 0;
  84392. }else{
  84393. nWorker = db->aLimit[SQLITE_LIMIT_WORKER_THREADS];
  84394. }
  84395. #endif
  84396. /* Do not allow the total number of threads (main thread + all workers)
  84397. ** to exceed the maximum merge count */
  84398. #if SQLITE_MAX_WORKER_THREADS>=SORTER_MAX_MERGE_COUNT
  84399. if( nWorker>=SORTER_MAX_MERGE_COUNT ){
  84400. nWorker = SORTER_MAX_MERGE_COUNT-1;
  84401. }
  84402. #endif
  84403. assert( pCsr->pKeyInfo && pCsr->pBtx==0 );
  84404. assert( pCsr->eCurType==CURTYPE_SORTER );
  84405. szKeyInfo = sizeof(KeyInfo) + (pCsr->pKeyInfo->nKeyField-1)*sizeof(CollSeq*);
  84406. sz = sizeof(VdbeSorter) + nWorker * sizeof(SortSubtask);
  84407. pSorter = (VdbeSorter*)sqlite3DbMallocZero(db, sz + szKeyInfo);
  84408. pCsr->uc.pSorter = pSorter;
  84409. if( pSorter==0 ){
  84410. rc = SQLITE_NOMEM_BKPT;
  84411. }else{
  84412. pSorter->pKeyInfo = pKeyInfo = (KeyInfo*)((u8*)pSorter + sz);
  84413. memcpy(pKeyInfo, pCsr->pKeyInfo, szKeyInfo);
  84414. pKeyInfo->db = 0;
  84415. if( nField && nWorker==0 ){
  84416. pKeyInfo->nKeyField = nField;
  84417. }
  84418. pSorter->pgsz = pgsz = sqlite3BtreeGetPageSize(db->aDb[0].pBt);
  84419. pSorter->nTask = nWorker + 1;
  84420. pSorter->iPrev = (u8)(nWorker - 1);
  84421. pSorter->bUseThreads = (pSorter->nTask>1);
  84422. pSorter->db = db;
  84423. for(i=0; i<pSorter->nTask; i++){
  84424. SortSubtask *pTask = &pSorter->aTask[i];
  84425. pTask->pSorter = pSorter;
  84426. }
  84427. if( !sqlite3TempInMemory(db) ){
  84428. i64 mxCache; /* Cache size in bytes*/
  84429. u32 szPma = sqlite3GlobalConfig.szPma;
  84430. pSorter->mnPmaSize = szPma * pgsz;
  84431. mxCache = db->aDb[0].pSchema->cache_size;
  84432. if( mxCache<0 ){
  84433. /* A negative cache-size value C indicates that the cache is abs(C)
  84434. ** KiB in size. */
  84435. mxCache = mxCache * -1024;
  84436. }else{
  84437. mxCache = mxCache * pgsz;
  84438. }
  84439. mxCache = MIN(mxCache, SQLITE_MAX_PMASZ);
  84440. pSorter->mxPmaSize = MAX(pSorter->mnPmaSize, (int)mxCache);
  84441. /* Avoid large memory allocations if the application has requested
  84442. ** SQLITE_CONFIG_SMALL_MALLOC. */
  84443. if( sqlite3GlobalConfig.bSmallMalloc==0 ){
  84444. assert( pSorter->iMemory==0 );
  84445. pSorter->nMemory = pgsz;
  84446. pSorter->list.aMemory = (u8*)sqlite3Malloc(pgsz);
  84447. if( !pSorter->list.aMemory ) rc = SQLITE_NOMEM_BKPT;
  84448. }
  84449. }
  84450. if( pKeyInfo->nAllField<13
  84451. && (pKeyInfo->aColl[0]==0 || pKeyInfo->aColl[0]==db->pDfltColl)
  84452. ){
  84453. pSorter->typeMask = SORTER_TYPE_INTEGER | SORTER_TYPE_TEXT;
  84454. }
  84455. }
  84456. return rc;
  84457. }
  84458. #undef nWorker /* Defined at the top of this function */
  84459. /*
  84460. ** Free the list of sorted records starting at pRecord.
  84461. */
  84462. static void vdbeSorterRecordFree(sqlite3 *db, SorterRecord *pRecord){
  84463. SorterRecord *p;
  84464. SorterRecord *pNext;
  84465. for(p=pRecord; p; p=pNext){
  84466. pNext = p->u.pNext;
  84467. sqlite3DbFree(db, p);
  84468. }
  84469. }
  84470. /*
  84471. ** Free all resources owned by the object indicated by argument pTask. All
  84472. ** fields of *pTask are zeroed before returning.
  84473. */
  84474. static void vdbeSortSubtaskCleanup(sqlite3 *db, SortSubtask *pTask){
  84475. sqlite3DbFree(db, pTask->pUnpacked);
  84476. #if SQLITE_MAX_WORKER_THREADS>0
  84477. /* pTask->list.aMemory can only be non-zero if it was handed memory
  84478. ** from the main thread. That only occurs SQLITE_MAX_WORKER_THREADS>0 */
  84479. if( pTask->list.aMemory ){
  84480. sqlite3_free(pTask->list.aMemory);
  84481. }else
  84482. #endif
  84483. {
  84484. assert( pTask->list.aMemory==0 );
  84485. vdbeSorterRecordFree(0, pTask->list.pList);
  84486. }
  84487. if( pTask->file.pFd ){
  84488. sqlite3OsCloseFree(pTask->file.pFd);
  84489. }
  84490. if( pTask->file2.pFd ){
  84491. sqlite3OsCloseFree(pTask->file2.pFd);
  84492. }
  84493. memset(pTask, 0, sizeof(SortSubtask));
  84494. }
  84495. #ifdef SQLITE_DEBUG_SORTER_THREADS
  84496. static void vdbeSorterWorkDebug(SortSubtask *pTask, const char *zEvent){
  84497. i64 t;
  84498. int iTask = (pTask - pTask->pSorter->aTask);
  84499. sqlite3OsCurrentTimeInt64(pTask->pSorter->db->pVfs, &t);
  84500. fprintf(stderr, "%lld:%d %s\n", t, iTask, zEvent);
  84501. }
  84502. static void vdbeSorterRewindDebug(const char *zEvent){
  84503. i64 t;
  84504. sqlite3OsCurrentTimeInt64(sqlite3_vfs_find(0), &t);
  84505. fprintf(stderr, "%lld:X %s\n", t, zEvent);
  84506. }
  84507. static void vdbeSorterPopulateDebug(
  84508. SortSubtask *pTask,
  84509. const char *zEvent
  84510. ){
  84511. i64 t;
  84512. int iTask = (pTask - pTask->pSorter->aTask);
  84513. sqlite3OsCurrentTimeInt64(pTask->pSorter->db->pVfs, &t);
  84514. fprintf(stderr, "%lld:bg%d %s\n", t, iTask, zEvent);
  84515. }
  84516. static void vdbeSorterBlockDebug(
  84517. SortSubtask *pTask,
  84518. int bBlocked,
  84519. const char *zEvent
  84520. ){
  84521. if( bBlocked ){
  84522. i64 t;
  84523. sqlite3OsCurrentTimeInt64(pTask->pSorter->db->pVfs, &t);
  84524. fprintf(stderr, "%lld:main %s\n", t, zEvent);
  84525. }
  84526. }
  84527. #else
  84528. # define vdbeSorterWorkDebug(x,y)
  84529. # define vdbeSorterRewindDebug(y)
  84530. # define vdbeSorterPopulateDebug(x,y)
  84531. # define vdbeSorterBlockDebug(x,y,z)
  84532. #endif
  84533. #if SQLITE_MAX_WORKER_THREADS>0
  84534. /*
  84535. ** Join thread pTask->thread.
  84536. */
  84537. static int vdbeSorterJoinThread(SortSubtask *pTask){
  84538. int rc = SQLITE_OK;
  84539. if( pTask->pThread ){
  84540. #ifdef SQLITE_DEBUG_SORTER_THREADS
  84541. int bDone = pTask->bDone;
  84542. #endif
  84543. void *pRet = SQLITE_INT_TO_PTR(SQLITE_ERROR);
  84544. vdbeSorterBlockDebug(pTask, !bDone, "enter");
  84545. (void)sqlite3ThreadJoin(pTask->pThread, &pRet);
  84546. vdbeSorterBlockDebug(pTask, !bDone, "exit");
  84547. rc = SQLITE_PTR_TO_INT(pRet);
  84548. assert( pTask->bDone==1 );
  84549. pTask->bDone = 0;
  84550. pTask->pThread = 0;
  84551. }
  84552. return rc;
  84553. }
  84554. /*
  84555. ** Launch a background thread to run xTask(pIn).
  84556. */
  84557. static int vdbeSorterCreateThread(
  84558. SortSubtask *pTask, /* Thread will use this task object */
  84559. void *(*xTask)(void*), /* Routine to run in a separate thread */
  84560. void *pIn /* Argument passed into xTask() */
  84561. ){
  84562. assert( pTask->pThread==0 && pTask->bDone==0 );
  84563. return sqlite3ThreadCreate(&pTask->pThread, xTask, pIn);
  84564. }
  84565. /*
  84566. ** Join all outstanding threads launched by SorterWrite() to create
  84567. ** level-0 PMAs.
  84568. */
  84569. static int vdbeSorterJoinAll(VdbeSorter *pSorter, int rcin){
  84570. int rc = rcin;
  84571. int i;
  84572. /* This function is always called by the main user thread.
  84573. **
  84574. ** If this function is being called after SorterRewind() has been called,
  84575. ** it is possible that thread pSorter->aTask[pSorter->nTask-1].pThread
  84576. ** is currently attempt to join one of the other threads. To avoid a race
  84577. ** condition where this thread also attempts to join the same object, join
  84578. ** thread pSorter->aTask[pSorter->nTask-1].pThread first. */
  84579. for(i=pSorter->nTask-1; i>=0; i--){
  84580. SortSubtask *pTask = &pSorter->aTask[i];
  84581. int rc2 = vdbeSorterJoinThread(pTask);
  84582. if( rc==SQLITE_OK ) rc = rc2;
  84583. }
  84584. return rc;
  84585. }
  84586. #else
  84587. # define vdbeSorterJoinAll(x,rcin) (rcin)
  84588. # define vdbeSorterJoinThread(pTask) SQLITE_OK
  84589. #endif
  84590. /*
  84591. ** Allocate a new MergeEngine object capable of handling up to
  84592. ** nReader PmaReader inputs.
  84593. **
  84594. ** nReader is automatically rounded up to the next power of two.
  84595. ** nReader may not exceed SORTER_MAX_MERGE_COUNT even after rounding up.
  84596. */
  84597. static MergeEngine *vdbeMergeEngineNew(int nReader){
  84598. int N = 2; /* Smallest power of two >= nReader */
  84599. int nByte; /* Total bytes of space to allocate */
  84600. MergeEngine *pNew; /* Pointer to allocated object to return */
  84601. assert( nReader<=SORTER_MAX_MERGE_COUNT );
  84602. while( N<nReader ) N += N;
  84603. nByte = sizeof(MergeEngine) + N * (sizeof(int) + sizeof(PmaReader));
  84604. pNew = sqlite3FaultSim(100) ? 0 : (MergeEngine*)sqlite3MallocZero(nByte);
  84605. if( pNew ){
  84606. pNew->nTree = N;
  84607. pNew->pTask = 0;
  84608. pNew->aReadr = (PmaReader*)&pNew[1];
  84609. pNew->aTree = (int*)&pNew->aReadr[N];
  84610. }
  84611. return pNew;
  84612. }
  84613. /*
  84614. ** Free the MergeEngine object passed as the only argument.
  84615. */
  84616. static void vdbeMergeEngineFree(MergeEngine *pMerger){
  84617. int i;
  84618. if( pMerger ){
  84619. for(i=0; i<pMerger->nTree; i++){
  84620. vdbePmaReaderClear(&pMerger->aReadr[i]);
  84621. }
  84622. }
  84623. sqlite3_free(pMerger);
  84624. }
  84625. /*
  84626. ** Free all resources associated with the IncrMerger object indicated by
  84627. ** the first argument.
  84628. */
  84629. static void vdbeIncrFree(IncrMerger *pIncr){
  84630. if( pIncr ){
  84631. #if SQLITE_MAX_WORKER_THREADS>0
  84632. if( pIncr->bUseThread ){
  84633. vdbeSorterJoinThread(pIncr->pTask);
  84634. if( pIncr->aFile[0].pFd ) sqlite3OsCloseFree(pIncr->aFile[0].pFd);
  84635. if( pIncr->aFile[1].pFd ) sqlite3OsCloseFree(pIncr->aFile[1].pFd);
  84636. }
  84637. #endif
  84638. vdbeMergeEngineFree(pIncr->pMerger);
  84639. sqlite3_free(pIncr);
  84640. }
  84641. }
  84642. /*
  84643. ** Reset a sorting cursor back to its original empty state.
  84644. */
  84645. SQLITE_PRIVATE void sqlite3VdbeSorterReset(sqlite3 *db, VdbeSorter *pSorter){
  84646. int i;
  84647. (void)vdbeSorterJoinAll(pSorter, SQLITE_OK);
  84648. assert( pSorter->bUseThreads || pSorter->pReader==0 );
  84649. #if SQLITE_MAX_WORKER_THREADS>0
  84650. if( pSorter->pReader ){
  84651. vdbePmaReaderClear(pSorter->pReader);
  84652. sqlite3DbFree(db, pSorter->pReader);
  84653. pSorter->pReader = 0;
  84654. }
  84655. #endif
  84656. vdbeMergeEngineFree(pSorter->pMerger);
  84657. pSorter->pMerger = 0;
  84658. for(i=0; i<pSorter->nTask; i++){
  84659. SortSubtask *pTask = &pSorter->aTask[i];
  84660. vdbeSortSubtaskCleanup(db, pTask);
  84661. pTask->pSorter = pSorter;
  84662. }
  84663. if( pSorter->list.aMemory==0 ){
  84664. vdbeSorterRecordFree(0, pSorter->list.pList);
  84665. }
  84666. pSorter->list.pList = 0;
  84667. pSorter->list.szPMA = 0;
  84668. pSorter->bUsePMA = 0;
  84669. pSorter->iMemory = 0;
  84670. pSorter->mxKeysize = 0;
  84671. sqlite3DbFree(db, pSorter->pUnpacked);
  84672. pSorter->pUnpacked = 0;
  84673. }
  84674. /*
  84675. ** Free any cursor components allocated by sqlite3VdbeSorterXXX routines.
  84676. */
  84677. SQLITE_PRIVATE void sqlite3VdbeSorterClose(sqlite3 *db, VdbeCursor *pCsr){
  84678. VdbeSorter *pSorter;
  84679. assert( pCsr->eCurType==CURTYPE_SORTER );
  84680. pSorter = pCsr->uc.pSorter;
  84681. if( pSorter ){
  84682. sqlite3VdbeSorterReset(db, pSorter);
  84683. sqlite3_free(pSorter->list.aMemory);
  84684. sqlite3DbFree(db, pSorter);
  84685. pCsr->uc.pSorter = 0;
  84686. }
  84687. }
  84688. #if SQLITE_MAX_MMAP_SIZE>0
  84689. /*
  84690. ** The first argument is a file-handle open on a temporary file. The file
  84691. ** is guaranteed to be nByte bytes or smaller in size. This function
  84692. ** attempts to extend the file to nByte bytes in size and to ensure that
  84693. ** the VFS has memory mapped it.
  84694. **
  84695. ** Whether or not the file does end up memory mapped of course depends on
  84696. ** the specific VFS implementation.
  84697. */
  84698. static void vdbeSorterExtendFile(sqlite3 *db, sqlite3_file *pFd, i64 nByte){
  84699. if( nByte<=(i64)(db->nMaxSorterMmap) && pFd->pMethods->iVersion>=3 ){
  84700. void *p = 0;
  84701. int chunksize = 4*1024;
  84702. sqlite3OsFileControlHint(pFd, SQLITE_FCNTL_CHUNK_SIZE, &chunksize);
  84703. sqlite3OsFileControlHint(pFd, SQLITE_FCNTL_SIZE_HINT, &nByte);
  84704. sqlite3OsFetch(pFd, 0, (int)nByte, &p);
  84705. sqlite3OsUnfetch(pFd, 0, p);
  84706. }
  84707. }
  84708. #else
  84709. # define vdbeSorterExtendFile(x,y,z)
  84710. #endif
  84711. /*
  84712. ** Allocate space for a file-handle and open a temporary file. If successful,
  84713. ** set *ppFd to point to the malloc'd file-handle and return SQLITE_OK.
  84714. ** Otherwise, set *ppFd to 0 and return an SQLite error code.
  84715. */
  84716. static int vdbeSorterOpenTempFile(
  84717. sqlite3 *db, /* Database handle doing sort */
  84718. i64 nExtend, /* Attempt to extend file to this size */
  84719. sqlite3_file **ppFd
  84720. ){
  84721. int rc;
  84722. if( sqlite3FaultSim(202) ) return SQLITE_IOERR_ACCESS;
  84723. rc = sqlite3OsOpenMalloc(db->pVfs, 0, ppFd,
  84724. SQLITE_OPEN_TEMP_JOURNAL |
  84725. SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
  84726. SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE, &rc
  84727. );
  84728. if( rc==SQLITE_OK ){
  84729. i64 max = SQLITE_MAX_MMAP_SIZE;
  84730. sqlite3OsFileControlHint(*ppFd, SQLITE_FCNTL_MMAP_SIZE, (void*)&max);
  84731. if( nExtend>0 ){
  84732. vdbeSorterExtendFile(db, *ppFd, nExtend);
  84733. }
  84734. }
  84735. return rc;
  84736. }
  84737. /*
  84738. ** If it has not already been allocated, allocate the UnpackedRecord
  84739. ** structure at pTask->pUnpacked. Return SQLITE_OK if successful (or
  84740. ** if no allocation was required), or SQLITE_NOMEM otherwise.
  84741. */
  84742. static int vdbeSortAllocUnpacked(SortSubtask *pTask){
  84743. if( pTask->pUnpacked==0 ){
  84744. pTask->pUnpacked = sqlite3VdbeAllocUnpackedRecord(pTask->pSorter->pKeyInfo);
  84745. if( pTask->pUnpacked==0 ) return SQLITE_NOMEM_BKPT;
  84746. pTask->pUnpacked->nField = pTask->pSorter->pKeyInfo->nKeyField;
  84747. pTask->pUnpacked->errCode = 0;
  84748. }
  84749. return SQLITE_OK;
  84750. }
  84751. /*
  84752. ** Merge the two sorted lists p1 and p2 into a single list.
  84753. */
  84754. static SorterRecord *vdbeSorterMerge(
  84755. SortSubtask *pTask, /* Calling thread context */
  84756. SorterRecord *p1, /* First list to merge */
  84757. SorterRecord *p2 /* Second list to merge */
  84758. ){
  84759. SorterRecord *pFinal = 0;
  84760. SorterRecord **pp = &pFinal;
  84761. int bCached = 0;
  84762. assert( p1!=0 && p2!=0 );
  84763. for(;;){
  84764. int res;
  84765. res = pTask->xCompare(
  84766. pTask, &bCached, SRVAL(p1), p1->nVal, SRVAL(p2), p2->nVal
  84767. );
  84768. if( res<=0 ){
  84769. *pp = p1;
  84770. pp = &p1->u.pNext;
  84771. p1 = p1->u.pNext;
  84772. if( p1==0 ){
  84773. *pp = p2;
  84774. break;
  84775. }
  84776. }else{
  84777. *pp = p2;
  84778. pp = &p2->u.pNext;
  84779. p2 = p2->u.pNext;
  84780. bCached = 0;
  84781. if( p2==0 ){
  84782. *pp = p1;
  84783. break;
  84784. }
  84785. }
  84786. }
  84787. return pFinal;
  84788. }
  84789. /*
  84790. ** Return the SorterCompare function to compare values collected by the
  84791. ** sorter object passed as the only argument.
  84792. */
  84793. static SorterCompare vdbeSorterGetCompare(VdbeSorter *p){
  84794. if( p->typeMask==SORTER_TYPE_INTEGER ){
  84795. return vdbeSorterCompareInt;
  84796. }else if( p->typeMask==SORTER_TYPE_TEXT ){
  84797. return vdbeSorterCompareText;
  84798. }
  84799. return vdbeSorterCompare;
  84800. }
  84801. /*
  84802. ** Sort the linked list of records headed at pTask->pList. Return
  84803. ** SQLITE_OK if successful, or an SQLite error code (i.e. SQLITE_NOMEM) if
  84804. ** an error occurs.
  84805. */
  84806. static int vdbeSorterSort(SortSubtask *pTask, SorterList *pList){
  84807. int i;
  84808. SorterRecord **aSlot;
  84809. SorterRecord *p;
  84810. int rc;
  84811. rc = vdbeSortAllocUnpacked(pTask);
  84812. if( rc!=SQLITE_OK ) return rc;
  84813. p = pList->pList;
  84814. pTask->xCompare = vdbeSorterGetCompare(pTask->pSorter);
  84815. aSlot = (SorterRecord **)sqlite3MallocZero(64 * sizeof(SorterRecord *));
  84816. if( !aSlot ){
  84817. return SQLITE_NOMEM_BKPT;
  84818. }
  84819. while( p ){
  84820. SorterRecord *pNext;
  84821. if( pList->aMemory ){
  84822. if( (u8*)p==pList->aMemory ){
  84823. pNext = 0;
  84824. }else{
  84825. assert( p->u.iNext<sqlite3MallocSize(pList->aMemory) );
  84826. pNext = (SorterRecord*)&pList->aMemory[p->u.iNext];
  84827. }
  84828. }else{
  84829. pNext = p->u.pNext;
  84830. }
  84831. p->u.pNext = 0;
  84832. for(i=0; aSlot[i]; i++){
  84833. p = vdbeSorterMerge(pTask, p, aSlot[i]);
  84834. aSlot[i] = 0;
  84835. }
  84836. aSlot[i] = p;
  84837. p = pNext;
  84838. }
  84839. p = 0;
  84840. for(i=0; i<64; i++){
  84841. if( aSlot[i]==0 ) continue;
  84842. p = p ? vdbeSorterMerge(pTask, p, aSlot[i]) : aSlot[i];
  84843. }
  84844. pList->pList = p;
  84845. sqlite3_free(aSlot);
  84846. assert( pTask->pUnpacked->errCode==SQLITE_OK
  84847. || pTask->pUnpacked->errCode==SQLITE_NOMEM
  84848. );
  84849. return pTask->pUnpacked->errCode;
  84850. }
  84851. /*
  84852. ** Initialize a PMA-writer object.
  84853. */
  84854. static void vdbePmaWriterInit(
  84855. sqlite3_file *pFd, /* File handle to write to */
  84856. PmaWriter *p, /* Object to populate */
  84857. int nBuf, /* Buffer size */
  84858. i64 iStart /* Offset of pFd to begin writing at */
  84859. ){
  84860. memset(p, 0, sizeof(PmaWriter));
  84861. p->aBuffer = (u8*)sqlite3Malloc(nBuf);
  84862. if( !p->aBuffer ){
  84863. p->eFWErr = SQLITE_NOMEM_BKPT;
  84864. }else{
  84865. p->iBufEnd = p->iBufStart = (iStart % nBuf);
  84866. p->iWriteOff = iStart - p->iBufStart;
  84867. p->nBuffer = nBuf;
  84868. p->pFd = pFd;
  84869. }
  84870. }
  84871. /*
  84872. ** Write nData bytes of data to the PMA. Return SQLITE_OK
  84873. ** if successful, or an SQLite error code if an error occurs.
  84874. */
  84875. static void vdbePmaWriteBlob(PmaWriter *p, u8 *pData, int nData){
  84876. int nRem = nData;
  84877. while( nRem>0 && p->eFWErr==0 ){
  84878. int nCopy = nRem;
  84879. if( nCopy>(p->nBuffer - p->iBufEnd) ){
  84880. nCopy = p->nBuffer - p->iBufEnd;
  84881. }
  84882. memcpy(&p->aBuffer[p->iBufEnd], &pData[nData-nRem], nCopy);
  84883. p->iBufEnd += nCopy;
  84884. if( p->iBufEnd==p->nBuffer ){
  84885. p->eFWErr = sqlite3OsWrite(p->pFd,
  84886. &p->aBuffer[p->iBufStart], p->iBufEnd - p->iBufStart,
  84887. p->iWriteOff + p->iBufStart
  84888. );
  84889. p->iBufStart = p->iBufEnd = 0;
  84890. p->iWriteOff += p->nBuffer;
  84891. }
  84892. assert( p->iBufEnd<p->nBuffer );
  84893. nRem -= nCopy;
  84894. }
  84895. }
  84896. /*
  84897. ** Flush any buffered data to disk and clean up the PMA-writer object.
  84898. ** The results of using the PMA-writer after this call are undefined.
  84899. ** Return SQLITE_OK if flushing the buffered data succeeds or is not
  84900. ** required. Otherwise, return an SQLite error code.
  84901. **
  84902. ** Before returning, set *piEof to the offset immediately following the
  84903. ** last byte written to the file.
  84904. */
  84905. static int vdbePmaWriterFinish(PmaWriter *p, i64 *piEof){
  84906. int rc;
  84907. if( p->eFWErr==0 && ALWAYS(p->aBuffer) && p->iBufEnd>p->iBufStart ){
  84908. p->eFWErr = sqlite3OsWrite(p->pFd,
  84909. &p->aBuffer[p->iBufStart], p->iBufEnd - p->iBufStart,
  84910. p->iWriteOff + p->iBufStart
  84911. );
  84912. }
  84913. *piEof = (p->iWriteOff + p->iBufEnd);
  84914. sqlite3_free(p->aBuffer);
  84915. rc = p->eFWErr;
  84916. memset(p, 0, sizeof(PmaWriter));
  84917. return rc;
  84918. }
  84919. /*
  84920. ** Write value iVal encoded as a varint to the PMA. Return
  84921. ** SQLITE_OK if successful, or an SQLite error code if an error occurs.
  84922. */
  84923. static void vdbePmaWriteVarint(PmaWriter *p, u64 iVal){
  84924. int nByte;
  84925. u8 aByte[10];
  84926. nByte = sqlite3PutVarint(aByte, iVal);
  84927. vdbePmaWriteBlob(p, aByte, nByte);
  84928. }
  84929. /*
  84930. ** Write the current contents of in-memory linked-list pList to a level-0
  84931. ** PMA in the temp file belonging to sub-task pTask. Return SQLITE_OK if
  84932. ** successful, or an SQLite error code otherwise.
  84933. **
  84934. ** The format of a PMA is:
  84935. **
  84936. ** * A varint. This varint contains the total number of bytes of content
  84937. ** in the PMA (not including the varint itself).
  84938. **
  84939. ** * One or more records packed end-to-end in order of ascending keys.
  84940. ** Each record consists of a varint followed by a blob of data (the
  84941. ** key). The varint is the number of bytes in the blob of data.
  84942. */
  84943. static int vdbeSorterListToPMA(SortSubtask *pTask, SorterList *pList){
  84944. sqlite3 *db = pTask->pSorter->db;
  84945. int rc = SQLITE_OK; /* Return code */
  84946. PmaWriter writer; /* Object used to write to the file */
  84947. #ifdef SQLITE_DEBUG
  84948. /* Set iSz to the expected size of file pTask->file after writing the PMA.
  84949. ** This is used by an assert() statement at the end of this function. */
  84950. i64 iSz = pList->szPMA + sqlite3VarintLen(pList->szPMA) + pTask->file.iEof;
  84951. #endif
  84952. vdbeSorterWorkDebug(pTask, "enter");
  84953. memset(&writer, 0, sizeof(PmaWriter));
  84954. assert( pList->szPMA>0 );
  84955. /* If the first temporary PMA file has not been opened, open it now. */
  84956. if( pTask->file.pFd==0 ){
  84957. rc = vdbeSorterOpenTempFile(db, 0, &pTask->file.pFd);
  84958. assert( rc!=SQLITE_OK || pTask->file.pFd );
  84959. assert( pTask->file.iEof==0 );
  84960. assert( pTask->nPMA==0 );
  84961. }
  84962. /* Try to get the file to memory map */
  84963. if( rc==SQLITE_OK ){
  84964. vdbeSorterExtendFile(db, pTask->file.pFd, pTask->file.iEof+pList->szPMA+9);
  84965. }
  84966. /* Sort the list */
  84967. if( rc==SQLITE_OK ){
  84968. rc = vdbeSorterSort(pTask, pList);
  84969. }
  84970. if( rc==SQLITE_OK ){
  84971. SorterRecord *p;
  84972. SorterRecord *pNext = 0;
  84973. vdbePmaWriterInit(pTask->file.pFd, &writer, pTask->pSorter->pgsz,
  84974. pTask->file.iEof);
  84975. pTask->nPMA++;
  84976. vdbePmaWriteVarint(&writer, pList->szPMA);
  84977. for(p=pList->pList; p; p=pNext){
  84978. pNext = p->u.pNext;
  84979. vdbePmaWriteVarint(&writer, p->nVal);
  84980. vdbePmaWriteBlob(&writer, SRVAL(p), p->nVal);
  84981. if( pList->aMemory==0 ) sqlite3_free(p);
  84982. }
  84983. pList->pList = p;
  84984. rc = vdbePmaWriterFinish(&writer, &pTask->file.iEof);
  84985. }
  84986. vdbeSorterWorkDebug(pTask, "exit");
  84987. assert( rc!=SQLITE_OK || pList->pList==0 );
  84988. assert( rc!=SQLITE_OK || pTask->file.iEof==iSz );
  84989. return rc;
  84990. }
  84991. /*
  84992. ** Advance the MergeEngine to its next entry.
  84993. ** Set *pbEof to true there is no next entry because
  84994. ** the MergeEngine has reached the end of all its inputs.
  84995. **
  84996. ** Return SQLITE_OK if successful or an error code if an error occurs.
  84997. */
  84998. static int vdbeMergeEngineStep(
  84999. MergeEngine *pMerger, /* The merge engine to advance to the next row */
  85000. int *pbEof /* Set TRUE at EOF. Set false for more content */
  85001. ){
  85002. int rc;
  85003. int iPrev = pMerger->aTree[1];/* Index of PmaReader to advance */
  85004. SortSubtask *pTask = pMerger->pTask;
  85005. /* Advance the current PmaReader */
  85006. rc = vdbePmaReaderNext(&pMerger->aReadr[iPrev]);
  85007. /* Update contents of aTree[] */
  85008. if( rc==SQLITE_OK ){
  85009. int i; /* Index of aTree[] to recalculate */
  85010. PmaReader *pReadr1; /* First PmaReader to compare */
  85011. PmaReader *pReadr2; /* Second PmaReader to compare */
  85012. int bCached = 0;
  85013. /* Find the first two PmaReaders to compare. The one that was just
  85014. ** advanced (iPrev) and the one next to it in the array. */
  85015. pReadr1 = &pMerger->aReadr[(iPrev & 0xFFFE)];
  85016. pReadr2 = &pMerger->aReadr[(iPrev | 0x0001)];
  85017. for(i=(pMerger->nTree+iPrev)/2; i>0; i=i/2){
  85018. /* Compare pReadr1 and pReadr2. Store the result in variable iRes. */
  85019. int iRes;
  85020. if( pReadr1->pFd==0 ){
  85021. iRes = +1;
  85022. }else if( pReadr2->pFd==0 ){
  85023. iRes = -1;
  85024. }else{
  85025. iRes = pTask->xCompare(pTask, &bCached,
  85026. pReadr1->aKey, pReadr1->nKey, pReadr2->aKey, pReadr2->nKey
  85027. );
  85028. }
  85029. /* If pReadr1 contained the smaller value, set aTree[i] to its index.
  85030. ** Then set pReadr2 to the next PmaReader to compare to pReadr1. In this
  85031. ** case there is no cache of pReadr2 in pTask->pUnpacked, so set
  85032. ** pKey2 to point to the record belonging to pReadr2.
  85033. **
  85034. ** Alternatively, if pReadr2 contains the smaller of the two values,
  85035. ** set aTree[i] to its index and update pReadr1. If vdbeSorterCompare()
  85036. ** was actually called above, then pTask->pUnpacked now contains
  85037. ** a value equivalent to pReadr2. So set pKey2 to NULL to prevent
  85038. ** vdbeSorterCompare() from decoding pReadr2 again.
  85039. **
  85040. ** If the two values were equal, then the value from the oldest
  85041. ** PMA should be considered smaller. The VdbeSorter.aReadr[] array
  85042. ** is sorted from oldest to newest, so pReadr1 contains older values
  85043. ** than pReadr2 iff (pReadr1<pReadr2). */
  85044. if( iRes<0 || (iRes==0 && pReadr1<pReadr2) ){
  85045. pMerger->aTree[i] = (int)(pReadr1 - pMerger->aReadr);
  85046. pReadr2 = &pMerger->aReadr[ pMerger->aTree[i ^ 0x0001] ];
  85047. bCached = 0;
  85048. }else{
  85049. if( pReadr1->pFd ) bCached = 0;
  85050. pMerger->aTree[i] = (int)(pReadr2 - pMerger->aReadr);
  85051. pReadr1 = &pMerger->aReadr[ pMerger->aTree[i ^ 0x0001] ];
  85052. }
  85053. }
  85054. *pbEof = (pMerger->aReadr[pMerger->aTree[1]].pFd==0);
  85055. }
  85056. return (rc==SQLITE_OK ? pTask->pUnpacked->errCode : rc);
  85057. }
  85058. #if SQLITE_MAX_WORKER_THREADS>0
  85059. /*
  85060. ** The main routine for background threads that write level-0 PMAs.
  85061. */
  85062. static void *vdbeSorterFlushThread(void *pCtx){
  85063. SortSubtask *pTask = (SortSubtask*)pCtx;
  85064. int rc; /* Return code */
  85065. assert( pTask->bDone==0 );
  85066. rc = vdbeSorterListToPMA(pTask, &pTask->list);
  85067. pTask->bDone = 1;
  85068. return SQLITE_INT_TO_PTR(rc);
  85069. }
  85070. #endif /* SQLITE_MAX_WORKER_THREADS>0 */
  85071. /*
  85072. ** Flush the current contents of VdbeSorter.list to a new PMA, possibly
  85073. ** using a background thread.
  85074. */
  85075. static int vdbeSorterFlushPMA(VdbeSorter *pSorter){
  85076. #if SQLITE_MAX_WORKER_THREADS==0
  85077. pSorter->bUsePMA = 1;
  85078. return vdbeSorterListToPMA(&pSorter->aTask[0], &pSorter->list);
  85079. #else
  85080. int rc = SQLITE_OK;
  85081. int i;
  85082. SortSubtask *pTask = 0; /* Thread context used to create new PMA */
  85083. int nWorker = (pSorter->nTask-1);
  85084. /* Set the flag to indicate that at least one PMA has been written.
  85085. ** Or will be, anyhow. */
  85086. pSorter->bUsePMA = 1;
  85087. /* Select a sub-task to sort and flush the current list of in-memory
  85088. ** records to disk. If the sorter is running in multi-threaded mode,
  85089. ** round-robin between the first (pSorter->nTask-1) tasks. Except, if
  85090. ** the background thread from a sub-tasks previous turn is still running,
  85091. ** skip it. If the first (pSorter->nTask-1) sub-tasks are all still busy,
  85092. ** fall back to using the final sub-task. The first (pSorter->nTask-1)
  85093. ** sub-tasks are prefered as they use background threads - the final
  85094. ** sub-task uses the main thread. */
  85095. for(i=0; i<nWorker; i++){
  85096. int iTest = (pSorter->iPrev + i + 1) % nWorker;
  85097. pTask = &pSorter->aTask[iTest];
  85098. if( pTask->bDone ){
  85099. rc = vdbeSorterJoinThread(pTask);
  85100. }
  85101. if( rc!=SQLITE_OK || pTask->pThread==0 ) break;
  85102. }
  85103. if( rc==SQLITE_OK ){
  85104. if( i==nWorker ){
  85105. /* Use the foreground thread for this operation */
  85106. rc = vdbeSorterListToPMA(&pSorter->aTask[nWorker], &pSorter->list);
  85107. }else{
  85108. /* Launch a background thread for this operation */
  85109. u8 *aMem = pTask->list.aMemory;
  85110. void *pCtx = (void*)pTask;
  85111. assert( pTask->pThread==0 && pTask->bDone==0 );
  85112. assert( pTask->list.pList==0 );
  85113. assert( pTask->list.aMemory==0 || pSorter->list.aMemory!=0 );
  85114. pSorter->iPrev = (u8)(pTask - pSorter->aTask);
  85115. pTask->list = pSorter->list;
  85116. pSorter->list.pList = 0;
  85117. pSorter->list.szPMA = 0;
  85118. if( aMem ){
  85119. pSorter->list.aMemory = aMem;
  85120. pSorter->nMemory = sqlite3MallocSize(aMem);
  85121. }else if( pSorter->list.aMemory ){
  85122. pSorter->list.aMemory = sqlite3Malloc(pSorter->nMemory);
  85123. if( !pSorter->list.aMemory ) return SQLITE_NOMEM_BKPT;
  85124. }
  85125. rc = vdbeSorterCreateThread(pTask, vdbeSorterFlushThread, pCtx);
  85126. }
  85127. }
  85128. return rc;
  85129. #endif /* SQLITE_MAX_WORKER_THREADS!=0 */
  85130. }
  85131. /*
  85132. ** Add a record to the sorter.
  85133. */
  85134. SQLITE_PRIVATE int sqlite3VdbeSorterWrite(
  85135. const VdbeCursor *pCsr, /* Sorter cursor */
  85136. Mem *pVal /* Memory cell containing record */
  85137. ){
  85138. VdbeSorter *pSorter;
  85139. int rc = SQLITE_OK; /* Return Code */
  85140. SorterRecord *pNew; /* New list element */
  85141. int bFlush; /* True to flush contents of memory to PMA */
  85142. int nReq; /* Bytes of memory required */
  85143. int nPMA; /* Bytes of PMA space required */
  85144. int t; /* serial type of first record field */
  85145. assert( pCsr->eCurType==CURTYPE_SORTER );
  85146. pSorter = pCsr->uc.pSorter;
  85147. getVarint32((const u8*)&pVal->z[1], t);
  85148. if( t>0 && t<10 && t!=7 ){
  85149. pSorter->typeMask &= SORTER_TYPE_INTEGER;
  85150. }else if( t>10 && (t & 0x01) ){
  85151. pSorter->typeMask &= SORTER_TYPE_TEXT;
  85152. }else{
  85153. pSorter->typeMask = 0;
  85154. }
  85155. assert( pSorter );
  85156. /* Figure out whether or not the current contents of memory should be
  85157. ** flushed to a PMA before continuing. If so, do so.
  85158. **
  85159. ** If using the single large allocation mode (pSorter->aMemory!=0), then
  85160. ** flush the contents of memory to a new PMA if (a) at least one value is
  85161. ** already in memory and (b) the new value will not fit in memory.
  85162. **
  85163. ** Or, if using separate allocations for each record, flush the contents
  85164. ** of memory to a PMA if either of the following are true:
  85165. **
  85166. ** * The total memory allocated for the in-memory list is greater
  85167. ** than (page-size * cache-size), or
  85168. **
  85169. ** * The total memory allocated for the in-memory list is greater
  85170. ** than (page-size * 10) and sqlite3HeapNearlyFull() returns true.
  85171. */
  85172. nReq = pVal->n + sizeof(SorterRecord);
  85173. nPMA = pVal->n + sqlite3VarintLen(pVal->n);
  85174. if( pSorter->mxPmaSize ){
  85175. if( pSorter->list.aMemory ){
  85176. bFlush = pSorter->iMemory && (pSorter->iMemory+nReq) > pSorter->mxPmaSize;
  85177. }else{
  85178. bFlush = (
  85179. (pSorter->list.szPMA > pSorter->mxPmaSize)
  85180. || (pSorter->list.szPMA > pSorter->mnPmaSize && sqlite3HeapNearlyFull())
  85181. );
  85182. }
  85183. if( bFlush ){
  85184. rc = vdbeSorterFlushPMA(pSorter);
  85185. pSorter->list.szPMA = 0;
  85186. pSorter->iMemory = 0;
  85187. assert( rc!=SQLITE_OK || pSorter->list.pList==0 );
  85188. }
  85189. }
  85190. pSorter->list.szPMA += nPMA;
  85191. if( nPMA>pSorter->mxKeysize ){
  85192. pSorter->mxKeysize = nPMA;
  85193. }
  85194. if( pSorter->list.aMemory ){
  85195. int nMin = pSorter->iMemory + nReq;
  85196. if( nMin>pSorter->nMemory ){
  85197. u8 *aNew;
  85198. int iListOff = (u8*)pSorter->list.pList - pSorter->list.aMemory;
  85199. int nNew = pSorter->nMemory * 2;
  85200. while( nNew < nMin ) nNew = nNew*2;
  85201. if( nNew > pSorter->mxPmaSize ) nNew = pSorter->mxPmaSize;
  85202. if( nNew < nMin ) nNew = nMin;
  85203. aNew = sqlite3Realloc(pSorter->list.aMemory, nNew);
  85204. if( !aNew ) return SQLITE_NOMEM_BKPT;
  85205. pSorter->list.pList = (SorterRecord*)&aNew[iListOff];
  85206. pSorter->list.aMemory = aNew;
  85207. pSorter->nMemory = nNew;
  85208. }
  85209. pNew = (SorterRecord*)&pSorter->list.aMemory[pSorter->iMemory];
  85210. pSorter->iMemory += ROUND8(nReq);
  85211. if( pSorter->list.pList ){
  85212. pNew->u.iNext = (int)((u8*)(pSorter->list.pList) - pSorter->list.aMemory);
  85213. }
  85214. }else{
  85215. pNew = (SorterRecord *)sqlite3Malloc(nReq);
  85216. if( pNew==0 ){
  85217. return SQLITE_NOMEM_BKPT;
  85218. }
  85219. pNew->u.pNext = pSorter->list.pList;
  85220. }
  85221. memcpy(SRVAL(pNew), pVal->z, pVal->n);
  85222. pNew->nVal = pVal->n;
  85223. pSorter->list.pList = pNew;
  85224. return rc;
  85225. }
  85226. /*
  85227. ** Read keys from pIncr->pMerger and populate pIncr->aFile[1]. The format
  85228. ** of the data stored in aFile[1] is the same as that used by regular PMAs,
  85229. ** except that the number-of-bytes varint is omitted from the start.
  85230. */
  85231. static int vdbeIncrPopulate(IncrMerger *pIncr){
  85232. int rc = SQLITE_OK;
  85233. int rc2;
  85234. i64 iStart = pIncr->iStartOff;
  85235. SorterFile *pOut = &pIncr->aFile[1];
  85236. SortSubtask *pTask = pIncr->pTask;
  85237. MergeEngine *pMerger = pIncr->pMerger;
  85238. PmaWriter writer;
  85239. assert( pIncr->bEof==0 );
  85240. vdbeSorterPopulateDebug(pTask, "enter");
  85241. vdbePmaWriterInit(pOut->pFd, &writer, pTask->pSorter->pgsz, iStart);
  85242. while( rc==SQLITE_OK ){
  85243. int dummy;
  85244. PmaReader *pReader = &pMerger->aReadr[ pMerger->aTree[1] ];
  85245. int nKey = pReader->nKey;
  85246. i64 iEof = writer.iWriteOff + writer.iBufEnd;
  85247. /* Check if the output file is full or if the input has been exhausted.
  85248. ** In either case exit the loop. */
  85249. if( pReader->pFd==0 ) break;
  85250. if( (iEof + nKey + sqlite3VarintLen(nKey))>(iStart + pIncr->mxSz) ) break;
  85251. /* Write the next key to the output. */
  85252. vdbePmaWriteVarint(&writer, nKey);
  85253. vdbePmaWriteBlob(&writer, pReader->aKey, nKey);
  85254. assert( pIncr->pMerger->pTask==pTask );
  85255. rc = vdbeMergeEngineStep(pIncr->pMerger, &dummy);
  85256. }
  85257. rc2 = vdbePmaWriterFinish(&writer, &pOut->iEof);
  85258. if( rc==SQLITE_OK ) rc = rc2;
  85259. vdbeSorterPopulateDebug(pTask, "exit");
  85260. return rc;
  85261. }
  85262. #if SQLITE_MAX_WORKER_THREADS>0
  85263. /*
  85264. ** The main routine for background threads that populate aFile[1] of
  85265. ** multi-threaded IncrMerger objects.
  85266. */
  85267. static void *vdbeIncrPopulateThread(void *pCtx){
  85268. IncrMerger *pIncr = (IncrMerger*)pCtx;
  85269. void *pRet = SQLITE_INT_TO_PTR( vdbeIncrPopulate(pIncr) );
  85270. pIncr->pTask->bDone = 1;
  85271. return pRet;
  85272. }
  85273. /*
  85274. ** Launch a background thread to populate aFile[1] of pIncr.
  85275. */
  85276. static int vdbeIncrBgPopulate(IncrMerger *pIncr){
  85277. void *p = (void*)pIncr;
  85278. assert( pIncr->bUseThread );
  85279. return vdbeSorterCreateThread(pIncr->pTask, vdbeIncrPopulateThread, p);
  85280. }
  85281. #endif
  85282. /*
  85283. ** This function is called when the PmaReader corresponding to pIncr has
  85284. ** finished reading the contents of aFile[0]. Its purpose is to "refill"
  85285. ** aFile[0] such that the PmaReader should start rereading it from the
  85286. ** beginning.
  85287. **
  85288. ** For single-threaded objects, this is accomplished by literally reading
  85289. ** keys from pIncr->pMerger and repopulating aFile[0].
  85290. **
  85291. ** For multi-threaded objects, all that is required is to wait until the
  85292. ** background thread is finished (if it is not already) and then swap
  85293. ** aFile[0] and aFile[1] in place. If the contents of pMerger have not
  85294. ** been exhausted, this function also launches a new background thread
  85295. ** to populate the new aFile[1].
  85296. **
  85297. ** SQLITE_OK is returned on success, or an SQLite error code otherwise.
  85298. */
  85299. static int vdbeIncrSwap(IncrMerger *pIncr){
  85300. int rc = SQLITE_OK;
  85301. #if SQLITE_MAX_WORKER_THREADS>0
  85302. if( pIncr->bUseThread ){
  85303. rc = vdbeSorterJoinThread(pIncr->pTask);
  85304. if( rc==SQLITE_OK ){
  85305. SorterFile f0 = pIncr->aFile[0];
  85306. pIncr->aFile[0] = pIncr->aFile[1];
  85307. pIncr->aFile[1] = f0;
  85308. }
  85309. if( rc==SQLITE_OK ){
  85310. if( pIncr->aFile[0].iEof==pIncr->iStartOff ){
  85311. pIncr->bEof = 1;
  85312. }else{
  85313. rc = vdbeIncrBgPopulate(pIncr);
  85314. }
  85315. }
  85316. }else
  85317. #endif
  85318. {
  85319. rc = vdbeIncrPopulate(pIncr);
  85320. pIncr->aFile[0] = pIncr->aFile[1];
  85321. if( pIncr->aFile[0].iEof==pIncr->iStartOff ){
  85322. pIncr->bEof = 1;
  85323. }
  85324. }
  85325. return rc;
  85326. }
  85327. /*
  85328. ** Allocate and return a new IncrMerger object to read data from pMerger.
  85329. **
  85330. ** If an OOM condition is encountered, return NULL. In this case free the
  85331. ** pMerger argument before returning.
  85332. */
  85333. static int vdbeIncrMergerNew(
  85334. SortSubtask *pTask, /* The thread that will be using the new IncrMerger */
  85335. MergeEngine *pMerger, /* The MergeEngine that the IncrMerger will control */
  85336. IncrMerger **ppOut /* Write the new IncrMerger here */
  85337. ){
  85338. int rc = SQLITE_OK;
  85339. IncrMerger *pIncr = *ppOut = (IncrMerger*)
  85340. (sqlite3FaultSim(100) ? 0 : sqlite3MallocZero(sizeof(*pIncr)));
  85341. if( pIncr ){
  85342. pIncr->pMerger = pMerger;
  85343. pIncr->pTask = pTask;
  85344. pIncr->mxSz = MAX(pTask->pSorter->mxKeysize+9,pTask->pSorter->mxPmaSize/2);
  85345. pTask->file2.iEof += pIncr->mxSz;
  85346. }else{
  85347. vdbeMergeEngineFree(pMerger);
  85348. rc = SQLITE_NOMEM_BKPT;
  85349. }
  85350. return rc;
  85351. }
  85352. #if SQLITE_MAX_WORKER_THREADS>0
  85353. /*
  85354. ** Set the "use-threads" flag on object pIncr.
  85355. */
  85356. static void vdbeIncrMergerSetThreads(IncrMerger *pIncr){
  85357. pIncr->bUseThread = 1;
  85358. pIncr->pTask->file2.iEof -= pIncr->mxSz;
  85359. }
  85360. #endif /* SQLITE_MAX_WORKER_THREADS>0 */
  85361. /*
  85362. ** Recompute pMerger->aTree[iOut] by comparing the next keys on the
  85363. ** two PmaReaders that feed that entry. Neither of the PmaReaders
  85364. ** are advanced. This routine merely does the comparison.
  85365. */
  85366. static void vdbeMergeEngineCompare(
  85367. MergeEngine *pMerger, /* Merge engine containing PmaReaders to compare */
  85368. int iOut /* Store the result in pMerger->aTree[iOut] */
  85369. ){
  85370. int i1;
  85371. int i2;
  85372. int iRes;
  85373. PmaReader *p1;
  85374. PmaReader *p2;
  85375. assert( iOut<pMerger->nTree && iOut>0 );
  85376. if( iOut>=(pMerger->nTree/2) ){
  85377. i1 = (iOut - pMerger->nTree/2) * 2;
  85378. i2 = i1 + 1;
  85379. }else{
  85380. i1 = pMerger->aTree[iOut*2];
  85381. i2 = pMerger->aTree[iOut*2+1];
  85382. }
  85383. p1 = &pMerger->aReadr[i1];
  85384. p2 = &pMerger->aReadr[i2];
  85385. if( p1->pFd==0 ){
  85386. iRes = i2;
  85387. }else if( p2->pFd==0 ){
  85388. iRes = i1;
  85389. }else{
  85390. SortSubtask *pTask = pMerger->pTask;
  85391. int bCached = 0;
  85392. int res;
  85393. assert( pTask->pUnpacked!=0 ); /* from vdbeSortSubtaskMain() */
  85394. res = pTask->xCompare(
  85395. pTask, &bCached, p1->aKey, p1->nKey, p2->aKey, p2->nKey
  85396. );
  85397. if( res<=0 ){
  85398. iRes = i1;
  85399. }else{
  85400. iRes = i2;
  85401. }
  85402. }
  85403. pMerger->aTree[iOut] = iRes;
  85404. }
  85405. /*
  85406. ** Allowed values for the eMode parameter to vdbeMergeEngineInit()
  85407. ** and vdbePmaReaderIncrMergeInit().
  85408. **
  85409. ** Only INCRINIT_NORMAL is valid in single-threaded builds (when
  85410. ** SQLITE_MAX_WORKER_THREADS==0). The other values are only used
  85411. ** when there exists one or more separate worker threads.
  85412. */
  85413. #define INCRINIT_NORMAL 0
  85414. #define INCRINIT_TASK 1
  85415. #define INCRINIT_ROOT 2
  85416. /*
  85417. ** Forward reference required as the vdbeIncrMergeInit() and
  85418. ** vdbePmaReaderIncrInit() routines are called mutually recursively when
  85419. ** building a merge tree.
  85420. */
  85421. static int vdbePmaReaderIncrInit(PmaReader *pReadr, int eMode);
  85422. /*
  85423. ** Initialize the MergeEngine object passed as the second argument. Once this
  85424. ** function returns, the first key of merged data may be read from the
  85425. ** MergeEngine object in the usual fashion.
  85426. **
  85427. ** If argument eMode is INCRINIT_ROOT, then it is assumed that any IncrMerge
  85428. ** objects attached to the PmaReader objects that the merger reads from have
  85429. ** already been populated, but that they have not yet populated aFile[0] and
  85430. ** set the PmaReader objects up to read from it. In this case all that is
  85431. ** required is to call vdbePmaReaderNext() on each PmaReader to point it at
  85432. ** its first key.
  85433. **
  85434. ** Otherwise, if eMode is any value other than INCRINIT_ROOT, then use
  85435. ** vdbePmaReaderIncrMergeInit() to initialize each PmaReader that feeds data
  85436. ** to pMerger.
  85437. **
  85438. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  85439. */
  85440. static int vdbeMergeEngineInit(
  85441. SortSubtask *pTask, /* Thread that will run pMerger */
  85442. MergeEngine *pMerger, /* MergeEngine to initialize */
  85443. int eMode /* One of the INCRINIT_XXX constants */
  85444. ){
  85445. int rc = SQLITE_OK; /* Return code */
  85446. int i; /* For looping over PmaReader objects */
  85447. int nTree = pMerger->nTree;
  85448. /* eMode is always INCRINIT_NORMAL in single-threaded mode */
  85449. assert( SQLITE_MAX_WORKER_THREADS>0 || eMode==INCRINIT_NORMAL );
  85450. /* Verify that the MergeEngine is assigned to a single thread */
  85451. assert( pMerger->pTask==0 );
  85452. pMerger->pTask = pTask;
  85453. for(i=0; i<nTree; i++){
  85454. if( SQLITE_MAX_WORKER_THREADS>0 && eMode==INCRINIT_ROOT ){
  85455. /* PmaReaders should be normally initialized in order, as if they are
  85456. ** reading from the same temp file this makes for more linear file IO.
  85457. ** However, in the INCRINIT_ROOT case, if PmaReader aReadr[nTask-1] is
  85458. ** in use it will block the vdbePmaReaderNext() call while it uses
  85459. ** the main thread to fill its buffer. So calling PmaReaderNext()
  85460. ** on this PmaReader before any of the multi-threaded PmaReaders takes
  85461. ** better advantage of multi-processor hardware. */
  85462. rc = vdbePmaReaderNext(&pMerger->aReadr[nTree-i-1]);
  85463. }else{
  85464. rc = vdbePmaReaderIncrInit(&pMerger->aReadr[i], INCRINIT_NORMAL);
  85465. }
  85466. if( rc!=SQLITE_OK ) return rc;
  85467. }
  85468. for(i=pMerger->nTree-1; i>0; i--){
  85469. vdbeMergeEngineCompare(pMerger, i);
  85470. }
  85471. return pTask->pUnpacked->errCode;
  85472. }
  85473. /*
  85474. ** The PmaReader passed as the first argument is guaranteed to be an
  85475. ** incremental-reader (pReadr->pIncr!=0). This function serves to open
  85476. ** and/or initialize the temp file related fields of the IncrMerge
  85477. ** object at (pReadr->pIncr).
  85478. **
  85479. ** If argument eMode is set to INCRINIT_NORMAL, then all PmaReaders
  85480. ** in the sub-tree headed by pReadr are also initialized. Data is then
  85481. ** loaded into the buffers belonging to pReadr and it is set to point to
  85482. ** the first key in its range.
  85483. **
  85484. ** If argument eMode is set to INCRINIT_TASK, then pReadr is guaranteed
  85485. ** to be a multi-threaded PmaReader and this function is being called in a
  85486. ** background thread. In this case all PmaReaders in the sub-tree are
  85487. ** initialized as for INCRINIT_NORMAL and the aFile[1] buffer belonging to
  85488. ** pReadr is populated. However, pReadr itself is not set up to point
  85489. ** to its first key. A call to vdbePmaReaderNext() is still required to do
  85490. ** that.
  85491. **
  85492. ** The reason this function does not call vdbePmaReaderNext() immediately
  85493. ** in the INCRINIT_TASK case is that vdbePmaReaderNext() assumes that it has
  85494. ** to block on thread (pTask->thread) before accessing aFile[1]. But, since
  85495. ** this entire function is being run by thread (pTask->thread), that will
  85496. ** lead to the current background thread attempting to join itself.
  85497. **
  85498. ** Finally, if argument eMode is set to INCRINIT_ROOT, it may be assumed
  85499. ** that pReadr->pIncr is a multi-threaded IncrMerge objects, and that all
  85500. ** child-trees have already been initialized using IncrInit(INCRINIT_TASK).
  85501. ** In this case vdbePmaReaderNext() is called on all child PmaReaders and
  85502. ** the current PmaReader set to point to the first key in its range.
  85503. **
  85504. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  85505. */
  85506. static int vdbePmaReaderIncrMergeInit(PmaReader *pReadr, int eMode){
  85507. int rc = SQLITE_OK;
  85508. IncrMerger *pIncr = pReadr->pIncr;
  85509. SortSubtask *pTask = pIncr->pTask;
  85510. sqlite3 *db = pTask->pSorter->db;
  85511. /* eMode is always INCRINIT_NORMAL in single-threaded mode */
  85512. assert( SQLITE_MAX_WORKER_THREADS>0 || eMode==INCRINIT_NORMAL );
  85513. rc = vdbeMergeEngineInit(pTask, pIncr->pMerger, eMode);
  85514. /* Set up the required files for pIncr. A multi-theaded IncrMerge object
  85515. ** requires two temp files to itself, whereas a single-threaded object
  85516. ** only requires a region of pTask->file2. */
  85517. if( rc==SQLITE_OK ){
  85518. int mxSz = pIncr->mxSz;
  85519. #if SQLITE_MAX_WORKER_THREADS>0
  85520. if( pIncr->bUseThread ){
  85521. rc = vdbeSorterOpenTempFile(db, mxSz, &pIncr->aFile[0].pFd);
  85522. if( rc==SQLITE_OK ){
  85523. rc = vdbeSorterOpenTempFile(db, mxSz, &pIncr->aFile[1].pFd);
  85524. }
  85525. }else
  85526. #endif
  85527. /*if( !pIncr->bUseThread )*/{
  85528. if( pTask->file2.pFd==0 ){
  85529. assert( pTask->file2.iEof>0 );
  85530. rc = vdbeSorterOpenTempFile(db, pTask->file2.iEof, &pTask->file2.pFd);
  85531. pTask->file2.iEof = 0;
  85532. }
  85533. if( rc==SQLITE_OK ){
  85534. pIncr->aFile[1].pFd = pTask->file2.pFd;
  85535. pIncr->iStartOff = pTask->file2.iEof;
  85536. pTask->file2.iEof += mxSz;
  85537. }
  85538. }
  85539. }
  85540. #if SQLITE_MAX_WORKER_THREADS>0
  85541. if( rc==SQLITE_OK && pIncr->bUseThread ){
  85542. /* Use the current thread to populate aFile[1], even though this
  85543. ** PmaReader is multi-threaded. If this is an INCRINIT_TASK object,
  85544. ** then this function is already running in background thread
  85545. ** pIncr->pTask->thread.
  85546. **
  85547. ** If this is the INCRINIT_ROOT object, then it is running in the
  85548. ** main VDBE thread. But that is Ok, as that thread cannot return
  85549. ** control to the VDBE or proceed with anything useful until the
  85550. ** first results are ready from this merger object anyway.
  85551. */
  85552. assert( eMode==INCRINIT_ROOT || eMode==INCRINIT_TASK );
  85553. rc = vdbeIncrPopulate(pIncr);
  85554. }
  85555. #endif
  85556. if( rc==SQLITE_OK && (SQLITE_MAX_WORKER_THREADS==0 || eMode!=INCRINIT_TASK) ){
  85557. rc = vdbePmaReaderNext(pReadr);
  85558. }
  85559. return rc;
  85560. }
  85561. #if SQLITE_MAX_WORKER_THREADS>0
  85562. /*
  85563. ** The main routine for vdbePmaReaderIncrMergeInit() operations run in
  85564. ** background threads.
  85565. */
  85566. static void *vdbePmaReaderBgIncrInit(void *pCtx){
  85567. PmaReader *pReader = (PmaReader*)pCtx;
  85568. void *pRet = SQLITE_INT_TO_PTR(
  85569. vdbePmaReaderIncrMergeInit(pReader,INCRINIT_TASK)
  85570. );
  85571. pReader->pIncr->pTask->bDone = 1;
  85572. return pRet;
  85573. }
  85574. #endif
  85575. /*
  85576. ** If the PmaReader passed as the first argument is not an incremental-reader
  85577. ** (if pReadr->pIncr==0), then this function is a no-op. Otherwise, it invokes
  85578. ** the vdbePmaReaderIncrMergeInit() function with the parameters passed to
  85579. ** this routine to initialize the incremental merge.
  85580. **
  85581. ** If the IncrMerger object is multi-threaded (IncrMerger.bUseThread==1),
  85582. ** then a background thread is launched to call vdbePmaReaderIncrMergeInit().
  85583. ** Or, if the IncrMerger is single threaded, the same function is called
  85584. ** using the current thread.
  85585. */
  85586. static int vdbePmaReaderIncrInit(PmaReader *pReadr, int eMode){
  85587. IncrMerger *pIncr = pReadr->pIncr; /* Incremental merger */
  85588. int rc = SQLITE_OK; /* Return code */
  85589. if( pIncr ){
  85590. #if SQLITE_MAX_WORKER_THREADS>0
  85591. assert( pIncr->bUseThread==0 || eMode==INCRINIT_TASK );
  85592. if( pIncr->bUseThread ){
  85593. void *pCtx = (void*)pReadr;
  85594. rc = vdbeSorterCreateThread(pIncr->pTask, vdbePmaReaderBgIncrInit, pCtx);
  85595. }else
  85596. #endif
  85597. {
  85598. rc = vdbePmaReaderIncrMergeInit(pReadr, eMode);
  85599. }
  85600. }
  85601. return rc;
  85602. }
  85603. /*
  85604. ** Allocate a new MergeEngine object to merge the contents of nPMA level-0
  85605. ** PMAs from pTask->file. If no error occurs, set *ppOut to point to
  85606. ** the new object and return SQLITE_OK. Or, if an error does occur, set *ppOut
  85607. ** to NULL and return an SQLite error code.
  85608. **
  85609. ** When this function is called, *piOffset is set to the offset of the
  85610. ** first PMA to read from pTask->file. Assuming no error occurs, it is
  85611. ** set to the offset immediately following the last byte of the last
  85612. ** PMA before returning. If an error does occur, then the final value of
  85613. ** *piOffset is undefined.
  85614. */
  85615. static int vdbeMergeEngineLevel0(
  85616. SortSubtask *pTask, /* Sorter task to read from */
  85617. int nPMA, /* Number of PMAs to read */
  85618. i64 *piOffset, /* IN/OUT: Readr offset in pTask->file */
  85619. MergeEngine **ppOut /* OUT: New merge-engine */
  85620. ){
  85621. MergeEngine *pNew; /* Merge engine to return */
  85622. i64 iOff = *piOffset;
  85623. int i;
  85624. int rc = SQLITE_OK;
  85625. *ppOut = pNew = vdbeMergeEngineNew(nPMA);
  85626. if( pNew==0 ) rc = SQLITE_NOMEM_BKPT;
  85627. for(i=0; i<nPMA && rc==SQLITE_OK; i++){
  85628. i64 nDummy = 0;
  85629. PmaReader *pReadr = &pNew->aReadr[i];
  85630. rc = vdbePmaReaderInit(pTask, &pTask->file, iOff, pReadr, &nDummy);
  85631. iOff = pReadr->iEof;
  85632. }
  85633. if( rc!=SQLITE_OK ){
  85634. vdbeMergeEngineFree(pNew);
  85635. *ppOut = 0;
  85636. }
  85637. *piOffset = iOff;
  85638. return rc;
  85639. }
  85640. /*
  85641. ** Return the depth of a tree comprising nPMA PMAs, assuming a fanout of
  85642. ** SORTER_MAX_MERGE_COUNT. The returned value does not include leaf nodes.
  85643. **
  85644. ** i.e.
  85645. **
  85646. ** nPMA<=16 -> TreeDepth() == 0
  85647. ** nPMA<=256 -> TreeDepth() == 1
  85648. ** nPMA<=65536 -> TreeDepth() == 2
  85649. */
  85650. static int vdbeSorterTreeDepth(int nPMA){
  85651. int nDepth = 0;
  85652. i64 nDiv = SORTER_MAX_MERGE_COUNT;
  85653. while( nDiv < (i64)nPMA ){
  85654. nDiv = nDiv * SORTER_MAX_MERGE_COUNT;
  85655. nDepth++;
  85656. }
  85657. return nDepth;
  85658. }
  85659. /*
  85660. ** pRoot is the root of an incremental merge-tree with depth nDepth (according
  85661. ** to vdbeSorterTreeDepth()). pLeaf is the iSeq'th leaf to be added to the
  85662. ** tree, counting from zero. This function adds pLeaf to the tree.
  85663. **
  85664. ** If successful, SQLITE_OK is returned. If an error occurs, an SQLite error
  85665. ** code is returned and pLeaf is freed.
  85666. */
  85667. static int vdbeSorterAddToTree(
  85668. SortSubtask *pTask, /* Task context */
  85669. int nDepth, /* Depth of tree according to TreeDepth() */
  85670. int iSeq, /* Sequence number of leaf within tree */
  85671. MergeEngine *pRoot, /* Root of tree */
  85672. MergeEngine *pLeaf /* Leaf to add to tree */
  85673. ){
  85674. int rc = SQLITE_OK;
  85675. int nDiv = 1;
  85676. int i;
  85677. MergeEngine *p = pRoot;
  85678. IncrMerger *pIncr;
  85679. rc = vdbeIncrMergerNew(pTask, pLeaf, &pIncr);
  85680. for(i=1; i<nDepth; i++){
  85681. nDiv = nDiv * SORTER_MAX_MERGE_COUNT;
  85682. }
  85683. for(i=1; i<nDepth && rc==SQLITE_OK; i++){
  85684. int iIter = (iSeq / nDiv) % SORTER_MAX_MERGE_COUNT;
  85685. PmaReader *pReadr = &p->aReadr[iIter];
  85686. if( pReadr->pIncr==0 ){
  85687. MergeEngine *pNew = vdbeMergeEngineNew(SORTER_MAX_MERGE_COUNT);
  85688. if( pNew==0 ){
  85689. rc = SQLITE_NOMEM_BKPT;
  85690. }else{
  85691. rc = vdbeIncrMergerNew(pTask, pNew, &pReadr->pIncr);
  85692. }
  85693. }
  85694. if( rc==SQLITE_OK ){
  85695. p = pReadr->pIncr->pMerger;
  85696. nDiv = nDiv / SORTER_MAX_MERGE_COUNT;
  85697. }
  85698. }
  85699. if( rc==SQLITE_OK ){
  85700. p->aReadr[iSeq % SORTER_MAX_MERGE_COUNT].pIncr = pIncr;
  85701. }else{
  85702. vdbeIncrFree(pIncr);
  85703. }
  85704. return rc;
  85705. }
  85706. /*
  85707. ** This function is called as part of a SorterRewind() operation on a sorter
  85708. ** that has already written two or more level-0 PMAs to one or more temp
  85709. ** files. It builds a tree of MergeEngine/IncrMerger/PmaReader objects that
  85710. ** can be used to incrementally merge all PMAs on disk.
  85711. **
  85712. ** If successful, SQLITE_OK is returned and *ppOut set to point to the
  85713. ** MergeEngine object at the root of the tree before returning. Or, if an
  85714. ** error occurs, an SQLite error code is returned and the final value
  85715. ** of *ppOut is undefined.
  85716. */
  85717. static int vdbeSorterMergeTreeBuild(
  85718. VdbeSorter *pSorter, /* The VDBE cursor that implements the sort */
  85719. MergeEngine **ppOut /* Write the MergeEngine here */
  85720. ){
  85721. MergeEngine *pMain = 0;
  85722. int rc = SQLITE_OK;
  85723. int iTask;
  85724. #if SQLITE_MAX_WORKER_THREADS>0
  85725. /* If the sorter uses more than one task, then create the top-level
  85726. ** MergeEngine here. This MergeEngine will read data from exactly
  85727. ** one PmaReader per sub-task. */
  85728. assert( pSorter->bUseThreads || pSorter->nTask==1 );
  85729. if( pSorter->nTask>1 ){
  85730. pMain = vdbeMergeEngineNew(pSorter->nTask);
  85731. if( pMain==0 ) rc = SQLITE_NOMEM_BKPT;
  85732. }
  85733. #endif
  85734. for(iTask=0; rc==SQLITE_OK && iTask<pSorter->nTask; iTask++){
  85735. SortSubtask *pTask = &pSorter->aTask[iTask];
  85736. assert( pTask->nPMA>0 || SQLITE_MAX_WORKER_THREADS>0 );
  85737. if( SQLITE_MAX_WORKER_THREADS==0 || pTask->nPMA ){
  85738. MergeEngine *pRoot = 0; /* Root node of tree for this task */
  85739. int nDepth = vdbeSorterTreeDepth(pTask->nPMA);
  85740. i64 iReadOff = 0;
  85741. if( pTask->nPMA<=SORTER_MAX_MERGE_COUNT ){
  85742. rc = vdbeMergeEngineLevel0(pTask, pTask->nPMA, &iReadOff, &pRoot);
  85743. }else{
  85744. int i;
  85745. int iSeq = 0;
  85746. pRoot = vdbeMergeEngineNew(SORTER_MAX_MERGE_COUNT);
  85747. if( pRoot==0 ) rc = SQLITE_NOMEM_BKPT;
  85748. for(i=0; i<pTask->nPMA && rc==SQLITE_OK; i += SORTER_MAX_MERGE_COUNT){
  85749. MergeEngine *pMerger = 0; /* New level-0 PMA merger */
  85750. int nReader; /* Number of level-0 PMAs to merge */
  85751. nReader = MIN(pTask->nPMA - i, SORTER_MAX_MERGE_COUNT);
  85752. rc = vdbeMergeEngineLevel0(pTask, nReader, &iReadOff, &pMerger);
  85753. if( rc==SQLITE_OK ){
  85754. rc = vdbeSorterAddToTree(pTask, nDepth, iSeq++, pRoot, pMerger);
  85755. }
  85756. }
  85757. }
  85758. if( rc==SQLITE_OK ){
  85759. #if SQLITE_MAX_WORKER_THREADS>0
  85760. if( pMain!=0 ){
  85761. rc = vdbeIncrMergerNew(pTask, pRoot, &pMain->aReadr[iTask].pIncr);
  85762. }else
  85763. #endif
  85764. {
  85765. assert( pMain==0 );
  85766. pMain = pRoot;
  85767. }
  85768. }else{
  85769. vdbeMergeEngineFree(pRoot);
  85770. }
  85771. }
  85772. }
  85773. if( rc!=SQLITE_OK ){
  85774. vdbeMergeEngineFree(pMain);
  85775. pMain = 0;
  85776. }
  85777. *ppOut = pMain;
  85778. return rc;
  85779. }
  85780. /*
  85781. ** This function is called as part of an sqlite3VdbeSorterRewind() operation
  85782. ** on a sorter that has written two or more PMAs to temporary files. It sets
  85783. ** up either VdbeSorter.pMerger (for single threaded sorters) or pReader
  85784. ** (for multi-threaded sorters) so that it can be used to iterate through
  85785. ** all records stored in the sorter.
  85786. **
  85787. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  85788. */
  85789. static int vdbeSorterSetupMerge(VdbeSorter *pSorter){
  85790. int rc; /* Return code */
  85791. SortSubtask *pTask0 = &pSorter->aTask[0];
  85792. MergeEngine *pMain = 0;
  85793. #if SQLITE_MAX_WORKER_THREADS
  85794. sqlite3 *db = pTask0->pSorter->db;
  85795. int i;
  85796. SorterCompare xCompare = vdbeSorterGetCompare(pSorter);
  85797. for(i=0; i<pSorter->nTask; i++){
  85798. pSorter->aTask[i].xCompare = xCompare;
  85799. }
  85800. #endif
  85801. rc = vdbeSorterMergeTreeBuild(pSorter, &pMain);
  85802. if( rc==SQLITE_OK ){
  85803. #if SQLITE_MAX_WORKER_THREADS
  85804. assert( pSorter->bUseThreads==0 || pSorter->nTask>1 );
  85805. if( pSorter->bUseThreads ){
  85806. int iTask;
  85807. PmaReader *pReadr = 0;
  85808. SortSubtask *pLast = &pSorter->aTask[pSorter->nTask-1];
  85809. rc = vdbeSortAllocUnpacked(pLast);
  85810. if( rc==SQLITE_OK ){
  85811. pReadr = (PmaReader*)sqlite3DbMallocZero(db, sizeof(PmaReader));
  85812. pSorter->pReader = pReadr;
  85813. if( pReadr==0 ) rc = SQLITE_NOMEM_BKPT;
  85814. }
  85815. if( rc==SQLITE_OK ){
  85816. rc = vdbeIncrMergerNew(pLast, pMain, &pReadr->pIncr);
  85817. if( rc==SQLITE_OK ){
  85818. vdbeIncrMergerSetThreads(pReadr->pIncr);
  85819. for(iTask=0; iTask<(pSorter->nTask-1); iTask++){
  85820. IncrMerger *pIncr;
  85821. if( (pIncr = pMain->aReadr[iTask].pIncr) ){
  85822. vdbeIncrMergerSetThreads(pIncr);
  85823. assert( pIncr->pTask!=pLast );
  85824. }
  85825. }
  85826. for(iTask=0; rc==SQLITE_OK && iTask<pSorter->nTask; iTask++){
  85827. /* Check that:
  85828. **
  85829. ** a) The incremental merge object is configured to use the
  85830. ** right task, and
  85831. ** b) If it is using task (nTask-1), it is configured to run
  85832. ** in single-threaded mode. This is important, as the
  85833. ** root merge (INCRINIT_ROOT) will be using the same task
  85834. ** object.
  85835. */
  85836. PmaReader *p = &pMain->aReadr[iTask];
  85837. assert( p->pIncr==0 || (
  85838. (p->pIncr->pTask==&pSorter->aTask[iTask]) /* a */
  85839. && (iTask!=pSorter->nTask-1 || p->pIncr->bUseThread==0) /* b */
  85840. ));
  85841. rc = vdbePmaReaderIncrInit(p, INCRINIT_TASK);
  85842. }
  85843. }
  85844. pMain = 0;
  85845. }
  85846. if( rc==SQLITE_OK ){
  85847. rc = vdbePmaReaderIncrMergeInit(pReadr, INCRINIT_ROOT);
  85848. }
  85849. }else
  85850. #endif
  85851. {
  85852. rc = vdbeMergeEngineInit(pTask0, pMain, INCRINIT_NORMAL);
  85853. pSorter->pMerger = pMain;
  85854. pMain = 0;
  85855. }
  85856. }
  85857. if( rc!=SQLITE_OK ){
  85858. vdbeMergeEngineFree(pMain);
  85859. }
  85860. return rc;
  85861. }
  85862. /*
  85863. ** Once the sorter has been populated by calls to sqlite3VdbeSorterWrite,
  85864. ** this function is called to prepare for iterating through the records
  85865. ** in sorted order.
  85866. */
  85867. SQLITE_PRIVATE int sqlite3VdbeSorterRewind(const VdbeCursor *pCsr, int *pbEof){
  85868. VdbeSorter *pSorter;
  85869. int rc = SQLITE_OK; /* Return code */
  85870. assert( pCsr->eCurType==CURTYPE_SORTER );
  85871. pSorter = pCsr->uc.pSorter;
  85872. assert( pSorter );
  85873. /* If no data has been written to disk, then do not do so now. Instead,
  85874. ** sort the VdbeSorter.pRecord list. The vdbe layer will read data directly
  85875. ** from the in-memory list. */
  85876. if( pSorter->bUsePMA==0 ){
  85877. if( pSorter->list.pList ){
  85878. *pbEof = 0;
  85879. rc = vdbeSorterSort(&pSorter->aTask[0], &pSorter->list);
  85880. }else{
  85881. *pbEof = 1;
  85882. }
  85883. return rc;
  85884. }
  85885. /* Write the current in-memory list to a PMA. When the VdbeSorterWrite()
  85886. ** function flushes the contents of memory to disk, it immediately always
  85887. ** creates a new list consisting of a single key immediately afterwards.
  85888. ** So the list is never empty at this point. */
  85889. assert( pSorter->list.pList );
  85890. rc = vdbeSorterFlushPMA(pSorter);
  85891. /* Join all threads */
  85892. rc = vdbeSorterJoinAll(pSorter, rc);
  85893. vdbeSorterRewindDebug("rewind");
  85894. /* Assuming no errors have occurred, set up a merger structure to
  85895. ** incrementally read and merge all remaining PMAs. */
  85896. assert( pSorter->pReader==0 );
  85897. if( rc==SQLITE_OK ){
  85898. rc = vdbeSorterSetupMerge(pSorter);
  85899. *pbEof = 0;
  85900. }
  85901. vdbeSorterRewindDebug("rewinddone");
  85902. return rc;
  85903. }
  85904. /*
  85905. ** Advance to the next element in the sorter. Return value:
  85906. **
  85907. ** SQLITE_OK success
  85908. ** SQLITE_DONE end of data
  85909. ** otherwise some kind of error.
  85910. */
  85911. SQLITE_PRIVATE int sqlite3VdbeSorterNext(sqlite3 *db, const VdbeCursor *pCsr){
  85912. VdbeSorter *pSorter;
  85913. int rc; /* Return code */
  85914. assert( pCsr->eCurType==CURTYPE_SORTER );
  85915. pSorter = pCsr->uc.pSorter;
  85916. assert( pSorter->bUsePMA || (pSorter->pReader==0 && pSorter->pMerger==0) );
  85917. if( pSorter->bUsePMA ){
  85918. assert( pSorter->pReader==0 || pSorter->pMerger==0 );
  85919. assert( pSorter->bUseThreads==0 || pSorter->pReader );
  85920. assert( pSorter->bUseThreads==1 || pSorter->pMerger );
  85921. #if SQLITE_MAX_WORKER_THREADS>0
  85922. if( pSorter->bUseThreads ){
  85923. rc = vdbePmaReaderNext(pSorter->pReader);
  85924. if( rc==SQLITE_OK && pSorter->pReader->pFd==0 ) rc = SQLITE_DONE;
  85925. }else
  85926. #endif
  85927. /*if( !pSorter->bUseThreads )*/ {
  85928. int res = 0;
  85929. assert( pSorter->pMerger!=0 );
  85930. assert( pSorter->pMerger->pTask==(&pSorter->aTask[0]) );
  85931. rc = vdbeMergeEngineStep(pSorter->pMerger, &res);
  85932. if( rc==SQLITE_OK && res ) rc = SQLITE_DONE;
  85933. }
  85934. }else{
  85935. SorterRecord *pFree = pSorter->list.pList;
  85936. pSorter->list.pList = pFree->u.pNext;
  85937. pFree->u.pNext = 0;
  85938. if( pSorter->list.aMemory==0 ) vdbeSorterRecordFree(db, pFree);
  85939. rc = pSorter->list.pList ? SQLITE_OK : SQLITE_DONE;
  85940. }
  85941. return rc;
  85942. }
  85943. /*
  85944. ** Return a pointer to a buffer owned by the sorter that contains the
  85945. ** current key.
  85946. */
  85947. static void *vdbeSorterRowkey(
  85948. const VdbeSorter *pSorter, /* Sorter object */
  85949. int *pnKey /* OUT: Size of current key in bytes */
  85950. ){
  85951. void *pKey;
  85952. if( pSorter->bUsePMA ){
  85953. PmaReader *pReader;
  85954. #if SQLITE_MAX_WORKER_THREADS>0
  85955. if( pSorter->bUseThreads ){
  85956. pReader = pSorter->pReader;
  85957. }else
  85958. #endif
  85959. /*if( !pSorter->bUseThreads )*/{
  85960. pReader = &pSorter->pMerger->aReadr[pSorter->pMerger->aTree[1]];
  85961. }
  85962. *pnKey = pReader->nKey;
  85963. pKey = pReader->aKey;
  85964. }else{
  85965. *pnKey = pSorter->list.pList->nVal;
  85966. pKey = SRVAL(pSorter->list.pList);
  85967. }
  85968. return pKey;
  85969. }
  85970. /*
  85971. ** Copy the current sorter key into the memory cell pOut.
  85972. */
  85973. SQLITE_PRIVATE int sqlite3VdbeSorterRowkey(const VdbeCursor *pCsr, Mem *pOut){
  85974. VdbeSorter *pSorter;
  85975. void *pKey; int nKey; /* Sorter key to copy into pOut */
  85976. assert( pCsr->eCurType==CURTYPE_SORTER );
  85977. pSorter = pCsr->uc.pSorter;
  85978. pKey = vdbeSorterRowkey(pSorter, &nKey);
  85979. if( sqlite3VdbeMemClearAndResize(pOut, nKey) ){
  85980. return SQLITE_NOMEM_BKPT;
  85981. }
  85982. pOut->n = nKey;
  85983. MemSetTypeFlag(pOut, MEM_Blob);
  85984. memcpy(pOut->z, pKey, nKey);
  85985. return SQLITE_OK;
  85986. }
  85987. /*
  85988. ** Compare the key in memory cell pVal with the key that the sorter cursor
  85989. ** passed as the first argument currently points to. For the purposes of
  85990. ** the comparison, ignore the rowid field at the end of each record.
  85991. **
  85992. ** If the sorter cursor key contains any NULL values, consider it to be
  85993. ** less than pVal. Even if pVal also contains NULL values.
  85994. **
  85995. ** If an error occurs, return an SQLite error code (i.e. SQLITE_NOMEM).
  85996. ** Otherwise, set *pRes to a negative, zero or positive value if the
  85997. ** key in pVal is smaller than, equal to or larger than the current sorter
  85998. ** key.
  85999. **
  86000. ** This routine forms the core of the OP_SorterCompare opcode, which in
  86001. ** turn is used to verify uniqueness when constructing a UNIQUE INDEX.
  86002. */
  86003. SQLITE_PRIVATE int sqlite3VdbeSorterCompare(
  86004. const VdbeCursor *pCsr, /* Sorter cursor */
  86005. Mem *pVal, /* Value to compare to current sorter key */
  86006. int nKeyCol, /* Compare this many columns */
  86007. int *pRes /* OUT: Result of comparison */
  86008. ){
  86009. VdbeSorter *pSorter;
  86010. UnpackedRecord *r2;
  86011. KeyInfo *pKeyInfo;
  86012. int i;
  86013. void *pKey; int nKey; /* Sorter key to compare pVal with */
  86014. assert( pCsr->eCurType==CURTYPE_SORTER );
  86015. pSorter = pCsr->uc.pSorter;
  86016. r2 = pSorter->pUnpacked;
  86017. pKeyInfo = pCsr->pKeyInfo;
  86018. if( r2==0 ){
  86019. r2 = pSorter->pUnpacked = sqlite3VdbeAllocUnpackedRecord(pKeyInfo);
  86020. if( r2==0 ) return SQLITE_NOMEM_BKPT;
  86021. r2->nField = nKeyCol;
  86022. }
  86023. assert( r2->nField==nKeyCol );
  86024. pKey = vdbeSorterRowkey(pSorter, &nKey);
  86025. sqlite3VdbeRecordUnpack(pKeyInfo, nKey, pKey, r2);
  86026. for(i=0; i<nKeyCol; i++){
  86027. if( r2->aMem[i].flags & MEM_Null ){
  86028. *pRes = -1;
  86029. return SQLITE_OK;
  86030. }
  86031. }
  86032. *pRes = sqlite3VdbeRecordCompare(pVal->n, pVal->z, r2);
  86033. return SQLITE_OK;
  86034. }
  86035. /************** End of vdbesort.c ********************************************/
  86036. /************** Begin file memjournal.c **************************************/
  86037. /*
  86038. ** 2008 October 7
  86039. **
  86040. ** The author disclaims copyright to this source code. In place of
  86041. ** a legal notice, here is a blessing:
  86042. **
  86043. ** May you do good and not evil.
  86044. ** May you find forgiveness for yourself and forgive others.
  86045. ** May you share freely, never taking more than you give.
  86046. **
  86047. *************************************************************************
  86048. **
  86049. ** This file contains code use to implement an in-memory rollback journal.
  86050. ** The in-memory rollback journal is used to journal transactions for
  86051. ** ":memory:" databases and when the journal_mode=MEMORY pragma is used.
  86052. **
  86053. ** Update: The in-memory journal is also used to temporarily cache
  86054. ** smaller journals that are not critical for power-loss recovery.
  86055. ** For example, statement journals that are not too big will be held
  86056. ** entirely in memory, thus reducing the number of file I/O calls, and
  86057. ** more importantly, reducing temporary file creation events. If these
  86058. ** journals become too large for memory, they are spilled to disk. But
  86059. ** in the common case, they are usually small and no file I/O needs to
  86060. ** occur.
  86061. */
  86062. /* #include "sqliteInt.h" */
  86063. /* Forward references to internal structures */
  86064. typedef struct MemJournal MemJournal;
  86065. typedef struct FilePoint FilePoint;
  86066. typedef struct FileChunk FileChunk;
  86067. /*
  86068. ** The rollback journal is composed of a linked list of these structures.
  86069. **
  86070. ** The zChunk array is always at least 8 bytes in size - usually much more.
  86071. ** Its actual size is stored in the MemJournal.nChunkSize variable.
  86072. */
  86073. struct FileChunk {
  86074. FileChunk *pNext; /* Next chunk in the journal */
  86075. u8 zChunk[8]; /* Content of this chunk */
  86076. };
  86077. /*
  86078. ** By default, allocate this many bytes of memory for each FileChunk object.
  86079. */
  86080. #define MEMJOURNAL_DFLT_FILECHUNKSIZE 1024
  86081. /*
  86082. ** For chunk size nChunkSize, return the number of bytes that should
  86083. ** be allocated for each FileChunk structure.
  86084. */
  86085. #define fileChunkSize(nChunkSize) (sizeof(FileChunk) + ((nChunkSize)-8))
  86086. /*
  86087. ** An instance of this object serves as a cursor into the rollback journal.
  86088. ** The cursor can be either for reading or writing.
  86089. */
  86090. struct FilePoint {
  86091. sqlite3_int64 iOffset; /* Offset from the beginning of the file */
  86092. FileChunk *pChunk; /* Specific chunk into which cursor points */
  86093. };
  86094. /*
  86095. ** This structure is a subclass of sqlite3_file. Each open memory-journal
  86096. ** is an instance of this class.
  86097. */
  86098. struct MemJournal {
  86099. const sqlite3_io_methods *pMethod; /* Parent class. MUST BE FIRST */
  86100. int nChunkSize; /* In-memory chunk-size */
  86101. int nSpill; /* Bytes of data before flushing */
  86102. int nSize; /* Bytes of data currently in memory */
  86103. FileChunk *pFirst; /* Head of in-memory chunk-list */
  86104. FilePoint endpoint; /* Pointer to the end of the file */
  86105. FilePoint readpoint; /* Pointer to the end of the last xRead() */
  86106. int flags; /* xOpen flags */
  86107. sqlite3_vfs *pVfs; /* The "real" underlying VFS */
  86108. const char *zJournal; /* Name of the journal file */
  86109. };
  86110. /*
  86111. ** Read data from the in-memory journal file. This is the implementation
  86112. ** of the sqlite3_vfs.xRead method.
  86113. */
  86114. static int memjrnlRead(
  86115. sqlite3_file *pJfd, /* The journal file from which to read */
  86116. void *zBuf, /* Put the results here */
  86117. int iAmt, /* Number of bytes to read */
  86118. sqlite_int64 iOfst /* Begin reading at this offset */
  86119. ){
  86120. MemJournal *p = (MemJournal *)pJfd;
  86121. u8 *zOut = zBuf;
  86122. int nRead = iAmt;
  86123. int iChunkOffset;
  86124. FileChunk *pChunk;
  86125. #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
  86126. || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  86127. if( (iAmt+iOfst)>p->endpoint.iOffset ){
  86128. return SQLITE_IOERR_SHORT_READ;
  86129. }
  86130. #endif
  86131. assert( (iAmt+iOfst)<=p->endpoint.iOffset );
  86132. assert( p->readpoint.iOffset==0 || p->readpoint.pChunk!=0 );
  86133. if( p->readpoint.iOffset!=iOfst || iOfst==0 ){
  86134. sqlite3_int64 iOff = 0;
  86135. for(pChunk=p->pFirst;
  86136. ALWAYS(pChunk) && (iOff+p->nChunkSize)<=iOfst;
  86137. pChunk=pChunk->pNext
  86138. ){
  86139. iOff += p->nChunkSize;
  86140. }
  86141. }else{
  86142. pChunk = p->readpoint.pChunk;
  86143. assert( pChunk!=0 );
  86144. }
  86145. iChunkOffset = (int)(iOfst%p->nChunkSize);
  86146. do {
  86147. int iSpace = p->nChunkSize - iChunkOffset;
  86148. int nCopy = MIN(nRead, (p->nChunkSize - iChunkOffset));
  86149. memcpy(zOut, (u8*)pChunk->zChunk + iChunkOffset, nCopy);
  86150. zOut += nCopy;
  86151. nRead -= iSpace;
  86152. iChunkOffset = 0;
  86153. } while( nRead>=0 && (pChunk=pChunk->pNext)!=0 && nRead>0 );
  86154. p->readpoint.iOffset = pChunk ? iOfst+iAmt : 0;
  86155. p->readpoint.pChunk = pChunk;
  86156. return SQLITE_OK;
  86157. }
  86158. /*
  86159. ** Free the list of FileChunk structures headed at MemJournal.pFirst.
  86160. */
  86161. static void memjrnlFreeChunks(MemJournal *p){
  86162. FileChunk *pIter;
  86163. FileChunk *pNext;
  86164. for(pIter=p->pFirst; pIter; pIter=pNext){
  86165. pNext = pIter->pNext;
  86166. sqlite3_free(pIter);
  86167. }
  86168. p->pFirst = 0;
  86169. }
  86170. /*
  86171. ** Flush the contents of memory to a real file on disk.
  86172. */
  86173. static int memjrnlCreateFile(MemJournal *p){
  86174. int rc;
  86175. sqlite3_file *pReal = (sqlite3_file*)p;
  86176. MemJournal copy = *p;
  86177. memset(p, 0, sizeof(MemJournal));
  86178. rc = sqlite3OsOpen(copy.pVfs, copy.zJournal, pReal, copy.flags, 0);
  86179. if( rc==SQLITE_OK ){
  86180. int nChunk = copy.nChunkSize;
  86181. i64 iOff = 0;
  86182. FileChunk *pIter;
  86183. for(pIter=copy.pFirst; pIter; pIter=pIter->pNext){
  86184. if( iOff + nChunk > copy.endpoint.iOffset ){
  86185. nChunk = copy.endpoint.iOffset - iOff;
  86186. }
  86187. rc = sqlite3OsWrite(pReal, (u8*)pIter->zChunk, nChunk, iOff);
  86188. if( rc ) break;
  86189. iOff += nChunk;
  86190. }
  86191. if( rc==SQLITE_OK ){
  86192. /* No error has occurred. Free the in-memory buffers. */
  86193. memjrnlFreeChunks(&copy);
  86194. }
  86195. }
  86196. if( rc!=SQLITE_OK ){
  86197. /* If an error occurred while creating or writing to the file, restore
  86198. ** the original before returning. This way, SQLite uses the in-memory
  86199. ** journal data to roll back changes made to the internal page-cache
  86200. ** before this function was called. */
  86201. sqlite3OsClose(pReal);
  86202. *p = copy;
  86203. }
  86204. return rc;
  86205. }
  86206. /*
  86207. ** Write data to the file.
  86208. */
  86209. static int memjrnlWrite(
  86210. sqlite3_file *pJfd, /* The journal file into which to write */
  86211. const void *zBuf, /* Take data to be written from here */
  86212. int iAmt, /* Number of bytes to write */
  86213. sqlite_int64 iOfst /* Begin writing at this offset into the file */
  86214. ){
  86215. MemJournal *p = (MemJournal *)pJfd;
  86216. int nWrite = iAmt;
  86217. u8 *zWrite = (u8 *)zBuf;
  86218. /* If the file should be created now, create it and write the new data
  86219. ** into the file on disk. */
  86220. if( p->nSpill>0 && (iAmt+iOfst)>p->nSpill ){
  86221. int rc = memjrnlCreateFile(p);
  86222. if( rc==SQLITE_OK ){
  86223. rc = sqlite3OsWrite(pJfd, zBuf, iAmt, iOfst);
  86224. }
  86225. return rc;
  86226. }
  86227. /* If the contents of this write should be stored in memory */
  86228. else{
  86229. /* An in-memory journal file should only ever be appended to. Random
  86230. ** access writes are not required. The only exception to this is when
  86231. ** the in-memory journal is being used by a connection using the
  86232. ** atomic-write optimization. In this case the first 28 bytes of the
  86233. ** journal file may be written as part of committing the transaction. */
  86234. assert( iOfst==p->endpoint.iOffset || iOfst==0 );
  86235. #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
  86236. || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  86237. if( iOfst==0 && p->pFirst ){
  86238. assert( p->nChunkSize>iAmt );
  86239. memcpy((u8*)p->pFirst->zChunk, zBuf, iAmt);
  86240. }else
  86241. #else
  86242. assert( iOfst>0 || p->pFirst==0 );
  86243. #endif
  86244. {
  86245. while( nWrite>0 ){
  86246. FileChunk *pChunk = p->endpoint.pChunk;
  86247. int iChunkOffset = (int)(p->endpoint.iOffset%p->nChunkSize);
  86248. int iSpace = MIN(nWrite, p->nChunkSize - iChunkOffset);
  86249. if( iChunkOffset==0 ){
  86250. /* New chunk is required to extend the file. */
  86251. FileChunk *pNew = sqlite3_malloc(fileChunkSize(p->nChunkSize));
  86252. if( !pNew ){
  86253. return SQLITE_IOERR_NOMEM_BKPT;
  86254. }
  86255. pNew->pNext = 0;
  86256. if( pChunk ){
  86257. assert( p->pFirst );
  86258. pChunk->pNext = pNew;
  86259. }else{
  86260. assert( !p->pFirst );
  86261. p->pFirst = pNew;
  86262. }
  86263. p->endpoint.pChunk = pNew;
  86264. }
  86265. memcpy((u8*)p->endpoint.pChunk->zChunk + iChunkOffset, zWrite, iSpace);
  86266. zWrite += iSpace;
  86267. nWrite -= iSpace;
  86268. p->endpoint.iOffset += iSpace;
  86269. }
  86270. p->nSize = iAmt + iOfst;
  86271. }
  86272. }
  86273. return SQLITE_OK;
  86274. }
  86275. /*
  86276. ** Truncate the file.
  86277. **
  86278. ** If the journal file is already on disk, truncate it there. Or, if it
  86279. ** is still in main memory but is being truncated to zero bytes in size,
  86280. ** ignore
  86281. */
  86282. static int memjrnlTruncate(sqlite3_file *pJfd, sqlite_int64 size){
  86283. MemJournal *p = (MemJournal *)pJfd;
  86284. if( ALWAYS(size==0) ){
  86285. memjrnlFreeChunks(p);
  86286. p->nSize = 0;
  86287. p->endpoint.pChunk = 0;
  86288. p->endpoint.iOffset = 0;
  86289. p->readpoint.pChunk = 0;
  86290. p->readpoint.iOffset = 0;
  86291. }
  86292. return SQLITE_OK;
  86293. }
  86294. /*
  86295. ** Close the file.
  86296. */
  86297. static int memjrnlClose(sqlite3_file *pJfd){
  86298. MemJournal *p = (MemJournal *)pJfd;
  86299. memjrnlFreeChunks(p);
  86300. return SQLITE_OK;
  86301. }
  86302. /*
  86303. ** Sync the file.
  86304. **
  86305. ** If the real file has been created, call its xSync method. Otherwise,
  86306. ** syncing an in-memory journal is a no-op.
  86307. */
  86308. static int memjrnlSync(sqlite3_file *pJfd, int flags){
  86309. UNUSED_PARAMETER2(pJfd, flags);
  86310. return SQLITE_OK;
  86311. }
  86312. /*
  86313. ** Query the size of the file in bytes.
  86314. */
  86315. static int memjrnlFileSize(sqlite3_file *pJfd, sqlite_int64 *pSize){
  86316. MemJournal *p = (MemJournal *)pJfd;
  86317. *pSize = (sqlite_int64) p->endpoint.iOffset;
  86318. return SQLITE_OK;
  86319. }
  86320. /*
  86321. ** Table of methods for MemJournal sqlite3_file object.
  86322. */
  86323. static const struct sqlite3_io_methods MemJournalMethods = {
  86324. 1, /* iVersion */
  86325. memjrnlClose, /* xClose */
  86326. memjrnlRead, /* xRead */
  86327. memjrnlWrite, /* xWrite */
  86328. memjrnlTruncate, /* xTruncate */
  86329. memjrnlSync, /* xSync */
  86330. memjrnlFileSize, /* xFileSize */
  86331. 0, /* xLock */
  86332. 0, /* xUnlock */
  86333. 0, /* xCheckReservedLock */
  86334. 0, /* xFileControl */
  86335. 0, /* xSectorSize */
  86336. 0, /* xDeviceCharacteristics */
  86337. 0, /* xShmMap */
  86338. 0, /* xShmLock */
  86339. 0, /* xShmBarrier */
  86340. 0, /* xShmUnmap */
  86341. 0, /* xFetch */
  86342. 0 /* xUnfetch */
  86343. };
  86344. /*
  86345. ** Open a journal file.
  86346. **
  86347. ** The behaviour of the journal file depends on the value of parameter
  86348. ** nSpill. If nSpill is 0, then the journal file is always create and
  86349. ** accessed using the underlying VFS. If nSpill is less than zero, then
  86350. ** all content is always stored in main-memory. Finally, if nSpill is a
  86351. ** positive value, then the journal file is initially created in-memory
  86352. ** but may be flushed to disk later on. In this case the journal file is
  86353. ** flushed to disk either when it grows larger than nSpill bytes in size,
  86354. ** or when sqlite3JournalCreate() is called.
  86355. */
  86356. SQLITE_PRIVATE int sqlite3JournalOpen(
  86357. sqlite3_vfs *pVfs, /* The VFS to use for actual file I/O */
  86358. const char *zName, /* Name of the journal file */
  86359. sqlite3_file *pJfd, /* Preallocated, blank file handle */
  86360. int flags, /* Opening flags */
  86361. int nSpill /* Bytes buffered before opening the file */
  86362. ){
  86363. MemJournal *p = (MemJournal*)pJfd;
  86364. /* Zero the file-handle object. If nSpill was passed zero, initialize
  86365. ** it using the sqlite3OsOpen() function of the underlying VFS. In this
  86366. ** case none of the code in this module is executed as a result of calls
  86367. ** made on the journal file-handle. */
  86368. memset(p, 0, sizeof(MemJournal));
  86369. if( nSpill==0 ){
  86370. return sqlite3OsOpen(pVfs, zName, pJfd, flags, 0);
  86371. }
  86372. if( nSpill>0 ){
  86373. p->nChunkSize = nSpill;
  86374. }else{
  86375. p->nChunkSize = 8 + MEMJOURNAL_DFLT_FILECHUNKSIZE - sizeof(FileChunk);
  86376. assert( MEMJOURNAL_DFLT_FILECHUNKSIZE==fileChunkSize(p->nChunkSize) );
  86377. }
  86378. p->pMethod = (const sqlite3_io_methods*)&MemJournalMethods;
  86379. p->nSpill = nSpill;
  86380. p->flags = flags;
  86381. p->zJournal = zName;
  86382. p->pVfs = pVfs;
  86383. return SQLITE_OK;
  86384. }
  86385. /*
  86386. ** Open an in-memory journal file.
  86387. */
  86388. SQLITE_PRIVATE void sqlite3MemJournalOpen(sqlite3_file *pJfd){
  86389. sqlite3JournalOpen(0, 0, pJfd, 0, -1);
  86390. }
  86391. #if defined(SQLITE_ENABLE_ATOMIC_WRITE) \
  86392. || defined(SQLITE_ENABLE_BATCH_ATOMIC_WRITE)
  86393. /*
  86394. ** If the argument p points to a MemJournal structure that is not an
  86395. ** in-memory-only journal file (i.e. is one that was opened with a +ve
  86396. ** nSpill parameter or as SQLITE_OPEN_MAIN_JOURNAL), and the underlying
  86397. ** file has not yet been created, create it now.
  86398. */
  86399. SQLITE_PRIVATE int sqlite3JournalCreate(sqlite3_file *pJfd){
  86400. int rc = SQLITE_OK;
  86401. MemJournal *p = (MemJournal*)pJfd;
  86402. if( p->pMethod==&MemJournalMethods && (
  86403. #ifdef SQLITE_ENABLE_ATOMIC_WRITE
  86404. p->nSpill>0
  86405. #else
  86406. /* While this appears to not be possible without ATOMIC_WRITE, the
  86407. ** paths are complex, so it seems prudent to leave the test in as
  86408. ** a NEVER(), in case our analysis is subtly flawed. */
  86409. NEVER(p->nSpill>0)
  86410. #endif
  86411. #ifdef SQLITE_ENABLE_BATCH_ATOMIC_WRITE
  86412. || (p->flags & SQLITE_OPEN_MAIN_JOURNAL)
  86413. #endif
  86414. )){
  86415. rc = memjrnlCreateFile(p);
  86416. }
  86417. return rc;
  86418. }
  86419. #endif
  86420. /*
  86421. ** The file-handle passed as the only argument is open on a journal file.
  86422. ** Return true if this "journal file" is currently stored in heap memory,
  86423. ** or false otherwise.
  86424. */
  86425. SQLITE_PRIVATE int sqlite3JournalIsInMemory(sqlite3_file *p){
  86426. return p->pMethods==&MemJournalMethods;
  86427. }
  86428. /*
  86429. ** Return the number of bytes required to store a JournalFile that uses vfs
  86430. ** pVfs to create the underlying on-disk files.
  86431. */
  86432. SQLITE_PRIVATE int sqlite3JournalSize(sqlite3_vfs *pVfs){
  86433. return MAX(pVfs->szOsFile, (int)sizeof(MemJournal));
  86434. }
  86435. /************** End of memjournal.c ******************************************/
  86436. /************** Begin file walker.c ******************************************/
  86437. /*
  86438. ** 2008 August 16
  86439. **
  86440. ** The author disclaims copyright to this source code. In place of
  86441. ** a legal notice, here is a blessing:
  86442. **
  86443. ** May you do good and not evil.
  86444. ** May you find forgiveness for yourself and forgive others.
  86445. ** May you share freely, never taking more than you give.
  86446. **
  86447. *************************************************************************
  86448. ** This file contains routines used for walking the parser tree for
  86449. ** an SQL statement.
  86450. */
  86451. /* #include "sqliteInt.h" */
  86452. /* #include <stdlib.h> */
  86453. /* #include <string.h> */
  86454. /*
  86455. ** Walk an expression tree. Invoke the callback once for each node
  86456. ** of the expression, while descending. (In other words, the callback
  86457. ** is invoked before visiting children.)
  86458. **
  86459. ** The return value from the callback should be one of the WRC_*
  86460. ** constants to specify how to proceed with the walk.
  86461. **
  86462. ** WRC_Continue Continue descending down the tree.
  86463. **
  86464. ** WRC_Prune Do not descend into child nodes, but allow
  86465. ** the walk to continue with sibling nodes.
  86466. **
  86467. ** WRC_Abort Do no more callbacks. Unwind the stack and
  86468. ** return from the top-level walk call.
  86469. **
  86470. ** The return value from this routine is WRC_Abort to abandon the tree walk
  86471. ** and WRC_Continue to continue.
  86472. */
  86473. static SQLITE_NOINLINE int walkExpr(Walker *pWalker, Expr *pExpr){
  86474. int rc;
  86475. testcase( ExprHasProperty(pExpr, EP_TokenOnly) );
  86476. testcase( ExprHasProperty(pExpr, EP_Reduced) );
  86477. while(1){
  86478. rc = pWalker->xExprCallback(pWalker, pExpr);
  86479. if( rc ) return rc & WRC_Abort;
  86480. if( !ExprHasProperty(pExpr,(EP_TokenOnly|EP_Leaf)) ){
  86481. if( pExpr->pLeft && walkExpr(pWalker, pExpr->pLeft) ) return WRC_Abort;
  86482. assert( pExpr->x.pList==0 || pExpr->pRight==0 );
  86483. if( pExpr->pRight ){
  86484. pExpr = pExpr->pRight;
  86485. continue;
  86486. }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  86487. if( sqlite3WalkSelect(pWalker, pExpr->x.pSelect) ) return WRC_Abort;
  86488. }else if( pExpr->x.pList ){
  86489. if( sqlite3WalkExprList(pWalker, pExpr->x.pList) ) return WRC_Abort;
  86490. }
  86491. }
  86492. break;
  86493. }
  86494. return WRC_Continue;
  86495. }
  86496. SQLITE_PRIVATE int sqlite3WalkExpr(Walker *pWalker, Expr *pExpr){
  86497. return pExpr ? walkExpr(pWalker,pExpr) : WRC_Continue;
  86498. }
  86499. /*
  86500. ** Call sqlite3WalkExpr() for every expression in list p or until
  86501. ** an abort request is seen.
  86502. */
  86503. SQLITE_PRIVATE int sqlite3WalkExprList(Walker *pWalker, ExprList *p){
  86504. int i;
  86505. struct ExprList_item *pItem;
  86506. if( p ){
  86507. for(i=p->nExpr, pItem=p->a; i>0; i--, pItem++){
  86508. if( sqlite3WalkExpr(pWalker, pItem->pExpr) ) return WRC_Abort;
  86509. }
  86510. }
  86511. return WRC_Continue;
  86512. }
  86513. /*
  86514. ** Walk all expressions associated with SELECT statement p. Do
  86515. ** not invoke the SELECT callback on p, but do (of course) invoke
  86516. ** any expr callbacks and SELECT callbacks that come from subqueries.
  86517. ** Return WRC_Abort or WRC_Continue.
  86518. */
  86519. SQLITE_PRIVATE int sqlite3WalkSelectExpr(Walker *pWalker, Select *p){
  86520. if( sqlite3WalkExprList(pWalker, p->pEList) ) return WRC_Abort;
  86521. if( sqlite3WalkExpr(pWalker, p->pWhere) ) return WRC_Abort;
  86522. if( sqlite3WalkExprList(pWalker, p->pGroupBy) ) return WRC_Abort;
  86523. if( sqlite3WalkExpr(pWalker, p->pHaving) ) return WRC_Abort;
  86524. if( sqlite3WalkExprList(pWalker, p->pOrderBy) ) return WRC_Abort;
  86525. if( sqlite3WalkExpr(pWalker, p->pLimit) ) return WRC_Abort;
  86526. return WRC_Continue;
  86527. }
  86528. /*
  86529. ** Walk the parse trees associated with all subqueries in the
  86530. ** FROM clause of SELECT statement p. Do not invoke the select
  86531. ** callback on p, but do invoke it on each FROM clause subquery
  86532. ** and on any subqueries further down in the tree. Return
  86533. ** WRC_Abort or WRC_Continue;
  86534. */
  86535. SQLITE_PRIVATE int sqlite3WalkSelectFrom(Walker *pWalker, Select *p){
  86536. SrcList *pSrc;
  86537. int i;
  86538. struct SrcList_item *pItem;
  86539. pSrc = p->pSrc;
  86540. assert( pSrc!=0 );
  86541. for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
  86542. if( pItem->pSelect && sqlite3WalkSelect(pWalker, pItem->pSelect) ){
  86543. return WRC_Abort;
  86544. }
  86545. if( pItem->fg.isTabFunc
  86546. && sqlite3WalkExprList(pWalker, pItem->u1.pFuncArg)
  86547. ){
  86548. return WRC_Abort;
  86549. }
  86550. }
  86551. return WRC_Continue;
  86552. }
  86553. /*
  86554. ** Call sqlite3WalkExpr() for every expression in Select statement p.
  86555. ** Invoke sqlite3WalkSelect() for subqueries in the FROM clause and
  86556. ** on the compound select chain, p->pPrior.
  86557. **
  86558. ** If it is not NULL, the xSelectCallback() callback is invoked before
  86559. ** the walk of the expressions and FROM clause. The xSelectCallback2()
  86560. ** method is invoked following the walk of the expressions and FROM clause,
  86561. ** but only if both xSelectCallback and xSelectCallback2 are both non-NULL
  86562. ** and if the expressions and FROM clause both return WRC_Continue;
  86563. **
  86564. ** Return WRC_Continue under normal conditions. Return WRC_Abort if
  86565. ** there is an abort request.
  86566. **
  86567. ** If the Walker does not have an xSelectCallback() then this routine
  86568. ** is a no-op returning WRC_Continue.
  86569. */
  86570. SQLITE_PRIVATE int sqlite3WalkSelect(Walker *pWalker, Select *p){
  86571. int rc;
  86572. if( p==0 ) return WRC_Continue;
  86573. if( pWalker->xSelectCallback==0 ) return WRC_Continue;
  86574. do{
  86575. rc = pWalker->xSelectCallback(pWalker, p);
  86576. if( rc ) return rc & WRC_Abort;
  86577. if( sqlite3WalkSelectExpr(pWalker, p)
  86578. || sqlite3WalkSelectFrom(pWalker, p)
  86579. ){
  86580. return WRC_Abort;
  86581. }
  86582. if( pWalker->xSelectCallback2 ){
  86583. pWalker->xSelectCallback2(pWalker, p);
  86584. }
  86585. p = p->pPrior;
  86586. }while( p!=0 );
  86587. return WRC_Continue;
  86588. }
  86589. /************** End of walker.c **********************************************/
  86590. /************** Begin file resolve.c *****************************************/
  86591. /*
  86592. ** 2008 August 18
  86593. **
  86594. ** The author disclaims copyright to this source code. In place of
  86595. ** a legal notice, here is a blessing:
  86596. **
  86597. ** May you do good and not evil.
  86598. ** May you find forgiveness for yourself and forgive others.
  86599. ** May you share freely, never taking more than you give.
  86600. **
  86601. *************************************************************************
  86602. **
  86603. ** This file contains routines used for walking the parser tree and
  86604. ** resolve all identifiers by associating them with a particular
  86605. ** table and column.
  86606. */
  86607. /* #include "sqliteInt.h" */
  86608. /*
  86609. ** Walk the expression tree pExpr and increase the aggregate function
  86610. ** depth (the Expr.op2 field) by N on every TK_AGG_FUNCTION node.
  86611. ** This needs to occur when copying a TK_AGG_FUNCTION node from an
  86612. ** outer query into an inner subquery.
  86613. **
  86614. ** incrAggFunctionDepth(pExpr,n) is the main routine. incrAggDepth(..)
  86615. ** is a helper function - a callback for the tree walker.
  86616. */
  86617. static int incrAggDepth(Walker *pWalker, Expr *pExpr){
  86618. if( pExpr->op==TK_AGG_FUNCTION ) pExpr->op2 += pWalker->u.n;
  86619. return WRC_Continue;
  86620. }
  86621. static void incrAggFunctionDepth(Expr *pExpr, int N){
  86622. if( N>0 ){
  86623. Walker w;
  86624. memset(&w, 0, sizeof(w));
  86625. w.xExprCallback = incrAggDepth;
  86626. w.u.n = N;
  86627. sqlite3WalkExpr(&w, pExpr);
  86628. }
  86629. }
  86630. /*
  86631. ** Turn the pExpr expression into an alias for the iCol-th column of the
  86632. ** result set in pEList.
  86633. **
  86634. ** If the reference is followed by a COLLATE operator, then make sure
  86635. ** the COLLATE operator is preserved. For example:
  86636. **
  86637. ** SELECT a+b, c+d FROM t1 ORDER BY 1 COLLATE nocase;
  86638. **
  86639. ** Should be transformed into:
  86640. **
  86641. ** SELECT a+b, c+d FROM t1 ORDER BY (a+b) COLLATE nocase;
  86642. **
  86643. ** The nSubquery parameter specifies how many levels of subquery the
  86644. ** alias is removed from the original expression. The usual value is
  86645. ** zero but it might be more if the alias is contained within a subquery
  86646. ** of the original expression. The Expr.op2 field of TK_AGG_FUNCTION
  86647. ** structures must be increased by the nSubquery amount.
  86648. */
  86649. static void resolveAlias(
  86650. Parse *pParse, /* Parsing context */
  86651. ExprList *pEList, /* A result set */
  86652. int iCol, /* A column in the result set. 0..pEList->nExpr-1 */
  86653. Expr *pExpr, /* Transform this into an alias to the result set */
  86654. const char *zType, /* "GROUP" or "ORDER" or "" */
  86655. int nSubquery /* Number of subqueries that the label is moving */
  86656. ){
  86657. Expr *pOrig; /* The iCol-th column of the result set */
  86658. Expr *pDup; /* Copy of pOrig */
  86659. sqlite3 *db; /* The database connection */
  86660. assert( iCol>=0 && iCol<pEList->nExpr );
  86661. pOrig = pEList->a[iCol].pExpr;
  86662. assert( pOrig!=0 );
  86663. db = pParse->db;
  86664. pDup = sqlite3ExprDup(db, pOrig, 0);
  86665. if( pDup==0 ) return;
  86666. if( zType[0]!='G' ) incrAggFunctionDepth(pDup, nSubquery);
  86667. if( pExpr->op==TK_COLLATE ){
  86668. pDup = sqlite3ExprAddCollateString(pParse, pDup, pExpr->u.zToken);
  86669. }
  86670. ExprSetProperty(pDup, EP_Alias);
  86671. /* Before calling sqlite3ExprDelete(), set the EP_Static flag. This
  86672. ** prevents ExprDelete() from deleting the Expr structure itself,
  86673. ** allowing it to be repopulated by the memcpy() on the following line.
  86674. ** The pExpr->u.zToken might point into memory that will be freed by the
  86675. ** sqlite3DbFree(db, pDup) on the last line of this block, so be sure to
  86676. ** make a copy of the token before doing the sqlite3DbFree().
  86677. */
  86678. ExprSetProperty(pExpr, EP_Static);
  86679. sqlite3ExprDelete(db, pExpr);
  86680. memcpy(pExpr, pDup, sizeof(*pExpr));
  86681. if( !ExprHasProperty(pExpr, EP_IntValue) && pExpr->u.zToken!=0 ){
  86682. assert( (pExpr->flags & (EP_Reduced|EP_TokenOnly))==0 );
  86683. pExpr->u.zToken = sqlite3DbStrDup(db, pExpr->u.zToken);
  86684. pExpr->flags |= EP_MemToken;
  86685. }
  86686. sqlite3DbFree(db, pDup);
  86687. }
  86688. /*
  86689. ** Return TRUE if the name zCol occurs anywhere in the USING clause.
  86690. **
  86691. ** Return FALSE if the USING clause is NULL or if it does not contain
  86692. ** zCol.
  86693. */
  86694. static int nameInUsingClause(IdList *pUsing, const char *zCol){
  86695. if( pUsing ){
  86696. int k;
  86697. for(k=0; k<pUsing->nId; k++){
  86698. if( sqlite3StrICmp(pUsing->a[k].zName, zCol)==0 ) return 1;
  86699. }
  86700. }
  86701. return 0;
  86702. }
  86703. /*
  86704. ** Subqueries stores the original database, table and column names for their
  86705. ** result sets in ExprList.a[].zSpan, in the form "DATABASE.TABLE.COLUMN".
  86706. ** Check to see if the zSpan given to this routine matches the zDb, zTab,
  86707. ** and zCol. If any of zDb, zTab, and zCol are NULL then those fields will
  86708. ** match anything.
  86709. */
  86710. SQLITE_PRIVATE int sqlite3MatchSpanName(
  86711. const char *zSpan,
  86712. const char *zCol,
  86713. const char *zTab,
  86714. const char *zDb
  86715. ){
  86716. int n;
  86717. for(n=0; ALWAYS(zSpan[n]) && zSpan[n]!='.'; n++){}
  86718. if( zDb && (sqlite3StrNICmp(zSpan, zDb, n)!=0 || zDb[n]!=0) ){
  86719. return 0;
  86720. }
  86721. zSpan += n+1;
  86722. for(n=0; ALWAYS(zSpan[n]) && zSpan[n]!='.'; n++){}
  86723. if( zTab && (sqlite3StrNICmp(zSpan, zTab, n)!=0 || zTab[n]!=0) ){
  86724. return 0;
  86725. }
  86726. zSpan += n+1;
  86727. if( zCol && sqlite3StrICmp(zSpan, zCol)!=0 ){
  86728. return 0;
  86729. }
  86730. return 1;
  86731. }
  86732. /*
  86733. ** Given the name of a column of the form X.Y.Z or Y.Z or just Z, look up
  86734. ** that name in the set of source tables in pSrcList and make the pExpr
  86735. ** expression node refer back to that source column. The following changes
  86736. ** are made to pExpr:
  86737. **
  86738. ** pExpr->iDb Set the index in db->aDb[] of the database X
  86739. ** (even if X is implied).
  86740. ** pExpr->iTable Set to the cursor number for the table obtained
  86741. ** from pSrcList.
  86742. ** pExpr->pTab Points to the Table structure of X.Y (even if
  86743. ** X and/or Y are implied.)
  86744. ** pExpr->iColumn Set to the column number within the table.
  86745. ** pExpr->op Set to TK_COLUMN.
  86746. ** pExpr->pLeft Any expression this points to is deleted
  86747. ** pExpr->pRight Any expression this points to is deleted.
  86748. **
  86749. ** The zDb variable is the name of the database (the "X"). This value may be
  86750. ** NULL meaning that name is of the form Y.Z or Z. Any available database
  86751. ** can be used. The zTable variable is the name of the table (the "Y"). This
  86752. ** value can be NULL if zDb is also NULL. If zTable is NULL it
  86753. ** means that the form of the name is Z and that columns from any table
  86754. ** can be used.
  86755. **
  86756. ** If the name cannot be resolved unambiguously, leave an error message
  86757. ** in pParse and return WRC_Abort. Return WRC_Prune on success.
  86758. */
  86759. static int lookupName(
  86760. Parse *pParse, /* The parsing context */
  86761. const char *zDb, /* Name of the database containing table, or NULL */
  86762. const char *zTab, /* Name of table containing column, or NULL */
  86763. const char *zCol, /* Name of the column. */
  86764. NameContext *pNC, /* The name context used to resolve the name */
  86765. Expr *pExpr /* Make this EXPR node point to the selected column */
  86766. ){
  86767. int i, j; /* Loop counters */
  86768. int cnt = 0; /* Number of matching column names */
  86769. int cntTab = 0; /* Number of matching table names */
  86770. int nSubquery = 0; /* How many levels of subquery */
  86771. sqlite3 *db = pParse->db; /* The database connection */
  86772. struct SrcList_item *pItem; /* Use for looping over pSrcList items */
  86773. struct SrcList_item *pMatch = 0; /* The matching pSrcList item */
  86774. NameContext *pTopNC = pNC; /* First namecontext in the list */
  86775. Schema *pSchema = 0; /* Schema of the expression */
  86776. int isTrigger = 0; /* True if resolved to a trigger column */
  86777. Table *pTab = 0; /* Table hold the row */
  86778. Column *pCol; /* A column of pTab */
  86779. assert( pNC ); /* the name context cannot be NULL. */
  86780. assert( zCol ); /* The Z in X.Y.Z cannot be NULL */
  86781. assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
  86782. /* Initialize the node to no-match */
  86783. pExpr->iTable = -1;
  86784. pExpr->pTab = 0;
  86785. ExprSetVVAProperty(pExpr, EP_NoReduce);
  86786. /* Translate the schema name in zDb into a pointer to the corresponding
  86787. ** schema. If not found, pSchema will remain NULL and nothing will match
  86788. ** resulting in an appropriate error message toward the end of this routine
  86789. */
  86790. if( zDb ){
  86791. testcase( pNC->ncFlags & NC_PartIdx );
  86792. testcase( pNC->ncFlags & NC_IsCheck );
  86793. if( (pNC->ncFlags & (NC_PartIdx|NC_IsCheck))!=0 ){
  86794. /* Silently ignore database qualifiers inside CHECK constraints and
  86795. ** partial indices. Do not raise errors because that might break
  86796. ** legacy and because it does not hurt anything to just ignore the
  86797. ** database name. */
  86798. zDb = 0;
  86799. }else{
  86800. for(i=0; i<db->nDb; i++){
  86801. assert( db->aDb[i].zDbSName );
  86802. if( sqlite3StrICmp(db->aDb[i].zDbSName,zDb)==0 ){
  86803. pSchema = db->aDb[i].pSchema;
  86804. break;
  86805. }
  86806. }
  86807. }
  86808. }
  86809. /* Start at the inner-most context and move outward until a match is found */
  86810. assert( pNC && cnt==0 );
  86811. do{
  86812. ExprList *pEList;
  86813. SrcList *pSrcList = pNC->pSrcList;
  86814. if( pSrcList ){
  86815. for(i=0, pItem=pSrcList->a; i<pSrcList->nSrc; i++, pItem++){
  86816. pTab = pItem->pTab;
  86817. assert( pTab!=0 && pTab->zName!=0 );
  86818. assert( pTab->nCol>0 );
  86819. if( pItem->pSelect && (pItem->pSelect->selFlags & SF_NestedFrom)!=0 ){
  86820. int hit = 0;
  86821. pEList = pItem->pSelect->pEList;
  86822. for(j=0; j<pEList->nExpr; j++){
  86823. if( sqlite3MatchSpanName(pEList->a[j].zSpan, zCol, zTab, zDb) ){
  86824. cnt++;
  86825. cntTab = 2;
  86826. pMatch = pItem;
  86827. pExpr->iColumn = j;
  86828. hit = 1;
  86829. }
  86830. }
  86831. if( hit || zTab==0 ) continue;
  86832. }
  86833. if( zDb && pTab->pSchema!=pSchema ){
  86834. continue;
  86835. }
  86836. if( zTab ){
  86837. const char *zTabName = pItem->zAlias ? pItem->zAlias : pTab->zName;
  86838. assert( zTabName!=0 );
  86839. if( sqlite3StrICmp(zTabName, zTab)!=0 ){
  86840. continue;
  86841. }
  86842. }
  86843. if( 0==(cntTab++) ){
  86844. pMatch = pItem;
  86845. }
  86846. for(j=0, pCol=pTab->aCol; j<pTab->nCol; j++, pCol++){
  86847. if( sqlite3StrICmp(pCol->zName, zCol)==0 ){
  86848. /* If there has been exactly one prior match and this match
  86849. ** is for the right-hand table of a NATURAL JOIN or is in a
  86850. ** USING clause, then skip this match.
  86851. */
  86852. if( cnt==1 ){
  86853. if( pItem->fg.jointype & JT_NATURAL ) continue;
  86854. if( nameInUsingClause(pItem->pUsing, zCol) ) continue;
  86855. }
  86856. cnt++;
  86857. pMatch = pItem;
  86858. /* Substitute the rowid (column -1) for the INTEGER PRIMARY KEY */
  86859. pExpr->iColumn = j==pTab->iPKey ? -1 : (i16)j;
  86860. break;
  86861. }
  86862. }
  86863. }
  86864. if( pMatch ){
  86865. pExpr->iTable = pMatch->iCursor;
  86866. pExpr->pTab = pMatch->pTab;
  86867. /* RIGHT JOIN not (yet) supported */
  86868. assert( (pMatch->fg.jointype & JT_RIGHT)==0 );
  86869. if( (pMatch->fg.jointype & JT_LEFT)!=0 ){
  86870. ExprSetProperty(pExpr, EP_CanBeNull);
  86871. }
  86872. pSchema = pExpr->pTab->pSchema;
  86873. }
  86874. } /* if( pSrcList ) */
  86875. #ifndef SQLITE_OMIT_TRIGGER
  86876. /* If we have not already resolved the name, then maybe
  86877. ** it is a new.* or old.* trigger argument reference
  86878. */
  86879. if( zDb==0 && zTab!=0 && cntTab==0 && pParse->pTriggerTab!=0 ){
  86880. int op = pParse->eTriggerOp;
  86881. assert( op==TK_DELETE || op==TK_UPDATE || op==TK_INSERT );
  86882. if( op!=TK_DELETE && sqlite3StrICmp("new",zTab) == 0 ){
  86883. pExpr->iTable = 1;
  86884. pTab = pParse->pTriggerTab;
  86885. }else if( op!=TK_INSERT && sqlite3StrICmp("old",zTab)==0 ){
  86886. pExpr->iTable = 0;
  86887. pTab = pParse->pTriggerTab;
  86888. }else{
  86889. pTab = 0;
  86890. }
  86891. if( pTab ){
  86892. int iCol;
  86893. pSchema = pTab->pSchema;
  86894. cntTab++;
  86895. for(iCol=0, pCol=pTab->aCol; iCol<pTab->nCol; iCol++, pCol++){
  86896. if( sqlite3StrICmp(pCol->zName, zCol)==0 ){
  86897. if( iCol==pTab->iPKey ){
  86898. iCol = -1;
  86899. }
  86900. break;
  86901. }
  86902. }
  86903. if( iCol>=pTab->nCol && sqlite3IsRowid(zCol) && VisibleRowid(pTab) ){
  86904. /* IMP: R-51414-32910 */
  86905. iCol = -1;
  86906. }
  86907. if( iCol<pTab->nCol ){
  86908. cnt++;
  86909. if( iCol<0 ){
  86910. pExpr->affinity = SQLITE_AFF_INTEGER;
  86911. }else if( pExpr->iTable==0 ){
  86912. testcase( iCol==31 );
  86913. testcase( iCol==32 );
  86914. pParse->oldmask |= (iCol>=32 ? 0xffffffff : (((u32)1)<<iCol));
  86915. }else{
  86916. testcase( iCol==31 );
  86917. testcase( iCol==32 );
  86918. pParse->newmask |= (iCol>=32 ? 0xffffffff : (((u32)1)<<iCol));
  86919. }
  86920. pExpr->iColumn = (i16)iCol;
  86921. pExpr->pTab = pTab;
  86922. isTrigger = 1;
  86923. }
  86924. }
  86925. }
  86926. #endif /* !defined(SQLITE_OMIT_TRIGGER) */
  86927. /*
  86928. ** Perhaps the name is a reference to the ROWID
  86929. */
  86930. if( cnt==0
  86931. && cntTab==1
  86932. && pMatch
  86933. && (pNC->ncFlags & NC_IdxExpr)==0
  86934. && sqlite3IsRowid(zCol)
  86935. && VisibleRowid(pMatch->pTab)
  86936. ){
  86937. cnt = 1;
  86938. pExpr->iColumn = -1;
  86939. pExpr->affinity = SQLITE_AFF_INTEGER;
  86940. }
  86941. /*
  86942. ** If the input is of the form Z (not Y.Z or X.Y.Z) then the name Z
  86943. ** might refer to an result-set alias. This happens, for example, when
  86944. ** we are resolving names in the WHERE clause of the following command:
  86945. **
  86946. ** SELECT a+b AS x FROM table WHERE x<10;
  86947. **
  86948. ** In cases like this, replace pExpr with a copy of the expression that
  86949. ** forms the result set entry ("a+b" in the example) and return immediately.
  86950. ** Note that the expression in the result set should have already been
  86951. ** resolved by the time the WHERE clause is resolved.
  86952. **
  86953. ** The ability to use an output result-set column in the WHERE, GROUP BY,
  86954. ** or HAVING clauses, or as part of a larger expression in the ORDER BY
  86955. ** clause is not standard SQL. This is a (goofy) SQLite extension, that
  86956. ** is supported for backwards compatibility only. Hence, we issue a warning
  86957. ** on sqlite3_log() whenever the capability is used.
  86958. */
  86959. if( (pEList = pNC->pEList)!=0
  86960. && zTab==0
  86961. && cnt==0
  86962. ){
  86963. for(j=0; j<pEList->nExpr; j++){
  86964. char *zAs = pEList->a[j].zName;
  86965. if( zAs!=0 && sqlite3StrICmp(zAs, zCol)==0 ){
  86966. Expr *pOrig;
  86967. assert( pExpr->pLeft==0 && pExpr->pRight==0 );
  86968. assert( pExpr->x.pList==0 );
  86969. assert( pExpr->x.pSelect==0 );
  86970. pOrig = pEList->a[j].pExpr;
  86971. if( (pNC->ncFlags&NC_AllowAgg)==0 && ExprHasProperty(pOrig, EP_Agg) ){
  86972. sqlite3ErrorMsg(pParse, "misuse of aliased aggregate %s", zAs);
  86973. return WRC_Abort;
  86974. }
  86975. if( sqlite3ExprVectorSize(pOrig)!=1 ){
  86976. sqlite3ErrorMsg(pParse, "row value misused");
  86977. return WRC_Abort;
  86978. }
  86979. resolveAlias(pParse, pEList, j, pExpr, "", nSubquery);
  86980. cnt = 1;
  86981. pMatch = 0;
  86982. assert( zTab==0 && zDb==0 );
  86983. goto lookupname_end;
  86984. }
  86985. }
  86986. }
  86987. /* Advance to the next name context. The loop will exit when either
  86988. ** we have a match (cnt>0) or when we run out of name contexts.
  86989. */
  86990. if( cnt ) break;
  86991. pNC = pNC->pNext;
  86992. nSubquery++;
  86993. }while( pNC );
  86994. /*
  86995. ** If X and Y are NULL (in other words if only the column name Z is
  86996. ** supplied) and the value of Z is enclosed in double-quotes, then
  86997. ** Z is a string literal if it doesn't match any column names. In that
  86998. ** case, we need to return right away and not make any changes to
  86999. ** pExpr.
  87000. **
  87001. ** Because no reference was made to outer contexts, the pNC->nRef
  87002. ** fields are not changed in any context.
  87003. */
  87004. if( cnt==0 && zTab==0 ){
  87005. assert( pExpr->op==TK_ID );
  87006. if( ExprHasProperty(pExpr,EP_DblQuoted) ){
  87007. pExpr->op = TK_STRING;
  87008. pExpr->pTab = 0;
  87009. return WRC_Prune;
  87010. }
  87011. if( sqlite3ExprIdToTrueFalse(pExpr) ){
  87012. return WRC_Prune;
  87013. }
  87014. }
  87015. /*
  87016. ** cnt==0 means there was not match. cnt>1 means there were two or
  87017. ** more matches. Either way, we have an error.
  87018. */
  87019. if( cnt!=1 ){
  87020. const char *zErr;
  87021. zErr = cnt==0 ? "no such column" : "ambiguous column name";
  87022. if( zDb ){
  87023. sqlite3ErrorMsg(pParse, "%s: %s.%s.%s", zErr, zDb, zTab, zCol);
  87024. }else if( zTab ){
  87025. sqlite3ErrorMsg(pParse, "%s: %s.%s", zErr, zTab, zCol);
  87026. }else{
  87027. sqlite3ErrorMsg(pParse, "%s: %s", zErr, zCol);
  87028. }
  87029. pParse->checkSchema = 1;
  87030. pTopNC->nErr++;
  87031. }
  87032. /* If a column from a table in pSrcList is referenced, then record
  87033. ** this fact in the pSrcList.a[].colUsed bitmask. Column 0 causes
  87034. ** bit 0 to be set. Column 1 sets bit 1. And so forth. If the
  87035. ** column number is greater than the number of bits in the bitmask
  87036. ** then set the high-order bit of the bitmask.
  87037. */
  87038. if( pExpr->iColumn>=0 && pMatch!=0 ){
  87039. int n = pExpr->iColumn;
  87040. testcase( n==BMS-1 );
  87041. if( n>=BMS ){
  87042. n = BMS-1;
  87043. }
  87044. assert( pMatch->iCursor==pExpr->iTable );
  87045. pMatch->colUsed |= ((Bitmask)1)<<n;
  87046. }
  87047. /* Clean up and return
  87048. */
  87049. sqlite3ExprDelete(db, pExpr->pLeft);
  87050. pExpr->pLeft = 0;
  87051. sqlite3ExprDelete(db, pExpr->pRight);
  87052. pExpr->pRight = 0;
  87053. pExpr->op = (isTrigger ? TK_TRIGGER : TK_COLUMN);
  87054. ExprSetProperty(pExpr, EP_Leaf);
  87055. lookupname_end:
  87056. if( cnt==1 ){
  87057. assert( pNC!=0 );
  87058. if( !ExprHasProperty(pExpr, EP_Alias) ){
  87059. sqlite3AuthRead(pParse, pExpr, pSchema, pNC->pSrcList);
  87060. }
  87061. /* Increment the nRef value on all name contexts from TopNC up to
  87062. ** the point where the name matched. */
  87063. for(;;){
  87064. assert( pTopNC!=0 );
  87065. pTopNC->nRef++;
  87066. if( pTopNC==pNC ) break;
  87067. pTopNC = pTopNC->pNext;
  87068. }
  87069. return WRC_Prune;
  87070. } else {
  87071. return WRC_Abort;
  87072. }
  87073. }
  87074. /*
  87075. ** Allocate and return a pointer to an expression to load the column iCol
  87076. ** from datasource iSrc in SrcList pSrc.
  87077. */
  87078. SQLITE_PRIVATE Expr *sqlite3CreateColumnExpr(sqlite3 *db, SrcList *pSrc, int iSrc, int iCol){
  87079. Expr *p = sqlite3ExprAlloc(db, TK_COLUMN, 0, 0);
  87080. if( p ){
  87081. struct SrcList_item *pItem = &pSrc->a[iSrc];
  87082. p->pTab = pItem->pTab;
  87083. p->iTable = pItem->iCursor;
  87084. if( p->pTab->iPKey==iCol ){
  87085. p->iColumn = -1;
  87086. }else{
  87087. p->iColumn = (ynVar)iCol;
  87088. testcase( iCol==BMS );
  87089. testcase( iCol==BMS-1 );
  87090. pItem->colUsed |= ((Bitmask)1)<<(iCol>=BMS ? BMS-1 : iCol);
  87091. }
  87092. }
  87093. return p;
  87094. }
  87095. /*
  87096. ** Report an error that an expression is not valid for some set of
  87097. ** pNC->ncFlags values determined by validMask.
  87098. */
  87099. static void notValid(
  87100. Parse *pParse, /* Leave error message here */
  87101. NameContext *pNC, /* The name context */
  87102. const char *zMsg, /* Type of error */
  87103. int validMask /* Set of contexts for which prohibited */
  87104. ){
  87105. assert( (validMask&~(NC_IsCheck|NC_PartIdx|NC_IdxExpr))==0 );
  87106. if( (pNC->ncFlags & validMask)!=0 ){
  87107. const char *zIn = "partial index WHERE clauses";
  87108. if( pNC->ncFlags & NC_IdxExpr ) zIn = "index expressions";
  87109. #ifndef SQLITE_OMIT_CHECK
  87110. else if( pNC->ncFlags & NC_IsCheck ) zIn = "CHECK constraints";
  87111. #endif
  87112. sqlite3ErrorMsg(pParse, "%s prohibited in %s", zMsg, zIn);
  87113. }
  87114. }
  87115. /*
  87116. ** Expression p should encode a floating point value between 1.0 and 0.0.
  87117. ** Return 1024 times this value. Or return -1 if p is not a floating point
  87118. ** value between 1.0 and 0.0.
  87119. */
  87120. static int exprProbability(Expr *p){
  87121. double r = -1.0;
  87122. if( p->op!=TK_FLOAT ) return -1;
  87123. sqlite3AtoF(p->u.zToken, &r, sqlite3Strlen30(p->u.zToken), SQLITE_UTF8);
  87124. assert( r>=0.0 );
  87125. if( r>1.0 ) return -1;
  87126. return (int)(r*134217728.0);
  87127. }
  87128. /*
  87129. ** This routine is callback for sqlite3WalkExpr().
  87130. **
  87131. ** Resolve symbolic names into TK_COLUMN operators for the current
  87132. ** node in the expression tree. Return 0 to continue the search down
  87133. ** the tree or 2 to abort the tree walk.
  87134. **
  87135. ** This routine also does error checking and name resolution for
  87136. ** function names. The operator for aggregate functions is changed
  87137. ** to TK_AGG_FUNCTION.
  87138. */
  87139. static int resolveExprStep(Walker *pWalker, Expr *pExpr){
  87140. NameContext *pNC;
  87141. Parse *pParse;
  87142. pNC = pWalker->u.pNC;
  87143. assert( pNC!=0 );
  87144. pParse = pNC->pParse;
  87145. assert( pParse==pWalker->pParse );
  87146. #ifndef NDEBUG
  87147. if( pNC->pSrcList && pNC->pSrcList->nAlloc>0 ){
  87148. SrcList *pSrcList = pNC->pSrcList;
  87149. int i;
  87150. for(i=0; i<pNC->pSrcList->nSrc; i++){
  87151. assert( pSrcList->a[i].iCursor>=0 && pSrcList->a[i].iCursor<pParse->nTab);
  87152. }
  87153. }
  87154. #endif
  87155. switch( pExpr->op ){
  87156. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
  87157. /* The special operator TK_ROW means use the rowid for the first
  87158. ** column in the FROM clause. This is used by the LIMIT and ORDER BY
  87159. ** clause processing on UPDATE and DELETE statements.
  87160. */
  87161. case TK_ROW: {
  87162. SrcList *pSrcList = pNC->pSrcList;
  87163. struct SrcList_item *pItem;
  87164. assert( pSrcList && pSrcList->nSrc==1 );
  87165. pItem = pSrcList->a;
  87166. assert( HasRowid(pItem->pTab) && pItem->pTab->pSelect==0 );
  87167. pExpr->op = TK_COLUMN;
  87168. pExpr->pTab = pItem->pTab;
  87169. pExpr->iTable = pItem->iCursor;
  87170. pExpr->iColumn = -1;
  87171. pExpr->affinity = SQLITE_AFF_INTEGER;
  87172. break;
  87173. }
  87174. #endif /* defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT)
  87175. && !defined(SQLITE_OMIT_SUBQUERY) */
  87176. /* A column name: ID
  87177. ** Or table name and column name: ID.ID
  87178. ** Or a database, table and column: ID.ID.ID
  87179. **
  87180. ** The TK_ID and TK_OUT cases are combined so that there will only
  87181. ** be one call to lookupName(). Then the compiler will in-line
  87182. ** lookupName() for a size reduction and performance increase.
  87183. */
  87184. case TK_ID:
  87185. case TK_DOT: {
  87186. const char *zColumn;
  87187. const char *zTable;
  87188. const char *zDb;
  87189. Expr *pRight;
  87190. if( pExpr->op==TK_ID ){
  87191. zDb = 0;
  87192. zTable = 0;
  87193. zColumn = pExpr->u.zToken;
  87194. }else{
  87195. notValid(pParse, pNC, "the \".\" operator", NC_IdxExpr);
  87196. pRight = pExpr->pRight;
  87197. if( pRight->op==TK_ID ){
  87198. zDb = 0;
  87199. zTable = pExpr->pLeft->u.zToken;
  87200. zColumn = pRight->u.zToken;
  87201. }else{
  87202. assert( pRight->op==TK_DOT );
  87203. zDb = pExpr->pLeft->u.zToken;
  87204. zTable = pRight->pLeft->u.zToken;
  87205. zColumn = pRight->pRight->u.zToken;
  87206. }
  87207. }
  87208. return lookupName(pParse, zDb, zTable, zColumn, pNC, pExpr);
  87209. }
  87210. /* Resolve function names
  87211. */
  87212. case TK_FUNCTION: {
  87213. ExprList *pList = pExpr->x.pList; /* The argument list */
  87214. int n = pList ? pList->nExpr : 0; /* Number of arguments */
  87215. int no_such_func = 0; /* True if no such function exists */
  87216. int wrong_num_args = 0; /* True if wrong number of arguments */
  87217. int is_agg = 0; /* True if is an aggregate function */
  87218. int nId; /* Number of characters in function name */
  87219. const char *zId; /* The function name. */
  87220. FuncDef *pDef; /* Information about the function */
  87221. u8 enc = ENC(pParse->db); /* The database encoding */
  87222. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  87223. zId = pExpr->u.zToken;
  87224. nId = sqlite3Strlen30(zId);
  87225. pDef = sqlite3FindFunction(pParse->db, zId, n, enc, 0);
  87226. if( pDef==0 ){
  87227. pDef = sqlite3FindFunction(pParse->db, zId, -2, enc, 0);
  87228. if( pDef==0 ){
  87229. no_such_func = 1;
  87230. }else{
  87231. wrong_num_args = 1;
  87232. }
  87233. }else{
  87234. is_agg = pDef->xFinalize!=0;
  87235. if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
  87236. ExprSetProperty(pExpr, EP_Unlikely|EP_Skip);
  87237. if( n==2 ){
  87238. pExpr->iTable = exprProbability(pList->a[1].pExpr);
  87239. if( pExpr->iTable<0 ){
  87240. sqlite3ErrorMsg(pParse,
  87241. "second argument to likelihood() must be a "
  87242. "constant between 0.0 and 1.0");
  87243. pNC->nErr++;
  87244. }
  87245. }else{
  87246. /* EVIDENCE-OF: R-61304-29449 The unlikely(X) function is
  87247. ** equivalent to likelihood(X, 0.0625).
  87248. ** EVIDENCE-OF: R-01283-11636 The unlikely(X) function is
  87249. ** short-hand for likelihood(X,0.0625).
  87250. ** EVIDENCE-OF: R-36850-34127 The likely(X) function is short-hand
  87251. ** for likelihood(X,0.9375).
  87252. ** EVIDENCE-OF: R-53436-40973 The likely(X) function is equivalent
  87253. ** to likelihood(X,0.9375). */
  87254. /* TUNING: unlikely() probability is 0.0625. likely() is 0.9375 */
  87255. pExpr->iTable = pDef->zName[0]=='u' ? 8388608 : 125829120;
  87256. }
  87257. }
  87258. #ifndef SQLITE_OMIT_AUTHORIZATION
  87259. {
  87260. int auth = sqlite3AuthCheck(pParse, SQLITE_FUNCTION, 0,pDef->zName,0);
  87261. if( auth!=SQLITE_OK ){
  87262. if( auth==SQLITE_DENY ){
  87263. sqlite3ErrorMsg(pParse, "not authorized to use function: %s",
  87264. pDef->zName);
  87265. pNC->nErr++;
  87266. }
  87267. pExpr->op = TK_NULL;
  87268. return WRC_Prune;
  87269. }
  87270. }
  87271. #endif
  87272. if( pDef->funcFlags & (SQLITE_FUNC_CONSTANT|SQLITE_FUNC_SLOCHNG) ){
  87273. /* For the purposes of the EP_ConstFunc flag, date and time
  87274. ** functions and other functions that change slowly are considered
  87275. ** constant because they are constant for the duration of one query */
  87276. ExprSetProperty(pExpr,EP_ConstFunc);
  87277. }
  87278. if( (pDef->funcFlags & SQLITE_FUNC_CONSTANT)==0 ){
  87279. /* Date/time functions that use 'now', and other functions like
  87280. ** sqlite_version() that might change over time cannot be used
  87281. ** in an index. */
  87282. notValid(pParse, pNC, "non-deterministic functions",
  87283. NC_IdxExpr|NC_PartIdx);
  87284. }
  87285. }
  87286. if( is_agg && (pNC->ncFlags & NC_AllowAgg)==0 ){
  87287. sqlite3ErrorMsg(pParse, "misuse of aggregate function %.*s()", nId,zId);
  87288. pNC->nErr++;
  87289. is_agg = 0;
  87290. }else if( no_such_func && pParse->db->init.busy==0
  87291. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  87292. && pParse->explain==0
  87293. #endif
  87294. ){
  87295. sqlite3ErrorMsg(pParse, "no such function: %.*s", nId, zId);
  87296. pNC->nErr++;
  87297. }else if( wrong_num_args ){
  87298. sqlite3ErrorMsg(pParse,"wrong number of arguments to function %.*s()",
  87299. nId, zId);
  87300. pNC->nErr++;
  87301. }
  87302. if( is_agg ) pNC->ncFlags &= ~NC_AllowAgg;
  87303. sqlite3WalkExprList(pWalker, pList);
  87304. if( is_agg ){
  87305. NameContext *pNC2 = pNC;
  87306. pExpr->op = TK_AGG_FUNCTION;
  87307. pExpr->op2 = 0;
  87308. while( pNC2 && !sqlite3FunctionUsesThisSrc(pExpr, pNC2->pSrcList) ){
  87309. pExpr->op2++;
  87310. pNC2 = pNC2->pNext;
  87311. }
  87312. assert( pDef!=0 );
  87313. if( pNC2 ){
  87314. assert( SQLITE_FUNC_MINMAX==NC_MinMaxAgg );
  87315. testcase( (pDef->funcFlags & SQLITE_FUNC_MINMAX)!=0 );
  87316. pNC2->ncFlags |= NC_HasAgg | (pDef->funcFlags & SQLITE_FUNC_MINMAX);
  87317. }
  87318. pNC->ncFlags |= NC_AllowAgg;
  87319. }
  87320. /* FIX ME: Compute pExpr->affinity based on the expected return
  87321. ** type of the function
  87322. */
  87323. return WRC_Prune;
  87324. }
  87325. #ifndef SQLITE_OMIT_SUBQUERY
  87326. case TK_SELECT:
  87327. case TK_EXISTS: testcase( pExpr->op==TK_EXISTS );
  87328. #endif
  87329. case TK_IN: {
  87330. testcase( pExpr->op==TK_IN );
  87331. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  87332. int nRef = pNC->nRef;
  87333. notValid(pParse, pNC, "subqueries", NC_IsCheck|NC_PartIdx|NC_IdxExpr);
  87334. sqlite3WalkSelect(pWalker, pExpr->x.pSelect);
  87335. assert( pNC->nRef>=nRef );
  87336. if( nRef!=pNC->nRef ){
  87337. ExprSetProperty(pExpr, EP_VarSelect);
  87338. pNC->ncFlags |= NC_VarSelect;
  87339. }
  87340. }
  87341. break;
  87342. }
  87343. case TK_VARIABLE: {
  87344. notValid(pParse, pNC, "parameters", NC_IsCheck|NC_PartIdx|NC_IdxExpr);
  87345. break;
  87346. }
  87347. case TK_IS:
  87348. case TK_ISNOT: {
  87349. Expr *pRight;
  87350. assert( !ExprHasProperty(pExpr, EP_Reduced) );
  87351. /* Handle special cases of "x IS TRUE", "x IS FALSE", "x IS NOT TRUE",
  87352. ** and "x IS NOT FALSE". */
  87353. if( (pRight = pExpr->pRight)->op==TK_ID ){
  87354. int rc = resolveExprStep(pWalker, pRight);
  87355. if( rc==WRC_Abort ) return WRC_Abort;
  87356. if( pRight->op==TK_TRUEFALSE ){
  87357. pExpr->op2 = pExpr->op;
  87358. pExpr->op = TK_TRUTH;
  87359. return WRC_Continue;
  87360. }
  87361. }
  87362. /* Fall thru */
  87363. }
  87364. case TK_BETWEEN:
  87365. case TK_EQ:
  87366. case TK_NE:
  87367. case TK_LT:
  87368. case TK_LE:
  87369. case TK_GT:
  87370. case TK_GE: {
  87371. int nLeft, nRight;
  87372. if( pParse->db->mallocFailed ) break;
  87373. assert( pExpr->pLeft!=0 );
  87374. nLeft = sqlite3ExprVectorSize(pExpr->pLeft);
  87375. if( pExpr->op==TK_BETWEEN ){
  87376. nRight = sqlite3ExprVectorSize(pExpr->x.pList->a[0].pExpr);
  87377. if( nRight==nLeft ){
  87378. nRight = sqlite3ExprVectorSize(pExpr->x.pList->a[1].pExpr);
  87379. }
  87380. }else{
  87381. assert( pExpr->pRight!=0 );
  87382. nRight = sqlite3ExprVectorSize(pExpr->pRight);
  87383. }
  87384. if( nLeft!=nRight ){
  87385. testcase( pExpr->op==TK_EQ );
  87386. testcase( pExpr->op==TK_NE );
  87387. testcase( pExpr->op==TK_LT );
  87388. testcase( pExpr->op==TK_LE );
  87389. testcase( pExpr->op==TK_GT );
  87390. testcase( pExpr->op==TK_GE );
  87391. testcase( pExpr->op==TK_IS );
  87392. testcase( pExpr->op==TK_ISNOT );
  87393. testcase( pExpr->op==TK_BETWEEN );
  87394. sqlite3ErrorMsg(pParse, "row value misused");
  87395. }
  87396. break;
  87397. }
  87398. }
  87399. return (pParse->nErr || pParse->db->mallocFailed) ? WRC_Abort : WRC_Continue;
  87400. }
  87401. /*
  87402. ** pEList is a list of expressions which are really the result set of the
  87403. ** a SELECT statement. pE is a term in an ORDER BY or GROUP BY clause.
  87404. ** This routine checks to see if pE is a simple identifier which corresponds
  87405. ** to the AS-name of one of the terms of the expression list. If it is,
  87406. ** this routine return an integer between 1 and N where N is the number of
  87407. ** elements in pEList, corresponding to the matching entry. If there is
  87408. ** no match, or if pE is not a simple identifier, then this routine
  87409. ** return 0.
  87410. **
  87411. ** pEList has been resolved. pE has not.
  87412. */
  87413. static int resolveAsName(
  87414. Parse *pParse, /* Parsing context for error messages */
  87415. ExprList *pEList, /* List of expressions to scan */
  87416. Expr *pE /* Expression we are trying to match */
  87417. ){
  87418. int i; /* Loop counter */
  87419. UNUSED_PARAMETER(pParse);
  87420. if( pE->op==TK_ID ){
  87421. char *zCol = pE->u.zToken;
  87422. for(i=0; i<pEList->nExpr; i++){
  87423. char *zAs = pEList->a[i].zName;
  87424. if( zAs!=0 && sqlite3StrICmp(zAs, zCol)==0 ){
  87425. return i+1;
  87426. }
  87427. }
  87428. }
  87429. return 0;
  87430. }
  87431. /*
  87432. ** pE is a pointer to an expression which is a single term in the
  87433. ** ORDER BY of a compound SELECT. The expression has not been
  87434. ** name resolved.
  87435. **
  87436. ** At the point this routine is called, we already know that the
  87437. ** ORDER BY term is not an integer index into the result set. That
  87438. ** case is handled by the calling routine.
  87439. **
  87440. ** Attempt to match pE against result set columns in the left-most
  87441. ** SELECT statement. Return the index i of the matching column,
  87442. ** as an indication to the caller that it should sort by the i-th column.
  87443. ** The left-most column is 1. In other words, the value returned is the
  87444. ** same integer value that would be used in the SQL statement to indicate
  87445. ** the column.
  87446. **
  87447. ** If there is no match, return 0. Return -1 if an error occurs.
  87448. */
  87449. static int resolveOrderByTermToExprList(
  87450. Parse *pParse, /* Parsing context for error messages */
  87451. Select *pSelect, /* The SELECT statement with the ORDER BY clause */
  87452. Expr *pE /* The specific ORDER BY term */
  87453. ){
  87454. int i; /* Loop counter */
  87455. ExprList *pEList; /* The columns of the result set */
  87456. NameContext nc; /* Name context for resolving pE */
  87457. sqlite3 *db; /* Database connection */
  87458. int rc; /* Return code from subprocedures */
  87459. u8 savedSuppErr; /* Saved value of db->suppressErr */
  87460. assert( sqlite3ExprIsInteger(pE, &i)==0 );
  87461. pEList = pSelect->pEList;
  87462. /* Resolve all names in the ORDER BY term expression
  87463. */
  87464. memset(&nc, 0, sizeof(nc));
  87465. nc.pParse = pParse;
  87466. nc.pSrcList = pSelect->pSrc;
  87467. nc.pEList = pEList;
  87468. nc.ncFlags = NC_AllowAgg;
  87469. nc.nErr = 0;
  87470. db = pParse->db;
  87471. savedSuppErr = db->suppressErr;
  87472. db->suppressErr = 1;
  87473. rc = sqlite3ResolveExprNames(&nc, pE);
  87474. db->suppressErr = savedSuppErr;
  87475. if( rc ) return 0;
  87476. /* Try to match the ORDER BY expression against an expression
  87477. ** in the result set. Return an 1-based index of the matching
  87478. ** result-set entry.
  87479. */
  87480. for(i=0; i<pEList->nExpr; i++){
  87481. if( sqlite3ExprCompare(0, pEList->a[i].pExpr, pE, -1)<2 ){
  87482. return i+1;
  87483. }
  87484. }
  87485. /* If no match, return 0. */
  87486. return 0;
  87487. }
  87488. /*
  87489. ** Generate an ORDER BY or GROUP BY term out-of-range error.
  87490. */
  87491. static void resolveOutOfRangeError(
  87492. Parse *pParse, /* The error context into which to write the error */
  87493. const char *zType, /* "ORDER" or "GROUP" */
  87494. int i, /* The index (1-based) of the term out of range */
  87495. int mx /* Largest permissible value of i */
  87496. ){
  87497. sqlite3ErrorMsg(pParse,
  87498. "%r %s BY term out of range - should be "
  87499. "between 1 and %d", i, zType, mx);
  87500. }
  87501. /*
  87502. ** Analyze the ORDER BY clause in a compound SELECT statement. Modify
  87503. ** each term of the ORDER BY clause is a constant integer between 1
  87504. ** and N where N is the number of columns in the compound SELECT.
  87505. **
  87506. ** ORDER BY terms that are already an integer between 1 and N are
  87507. ** unmodified. ORDER BY terms that are integers outside the range of
  87508. ** 1 through N generate an error. ORDER BY terms that are expressions
  87509. ** are matched against result set expressions of compound SELECT
  87510. ** beginning with the left-most SELECT and working toward the right.
  87511. ** At the first match, the ORDER BY expression is transformed into
  87512. ** the integer column number.
  87513. **
  87514. ** Return the number of errors seen.
  87515. */
  87516. static int resolveCompoundOrderBy(
  87517. Parse *pParse, /* Parsing context. Leave error messages here */
  87518. Select *pSelect /* The SELECT statement containing the ORDER BY */
  87519. ){
  87520. int i;
  87521. ExprList *pOrderBy;
  87522. ExprList *pEList;
  87523. sqlite3 *db;
  87524. int moreToDo = 1;
  87525. pOrderBy = pSelect->pOrderBy;
  87526. if( pOrderBy==0 ) return 0;
  87527. db = pParse->db;
  87528. if( pOrderBy->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  87529. sqlite3ErrorMsg(pParse, "too many terms in ORDER BY clause");
  87530. return 1;
  87531. }
  87532. for(i=0; i<pOrderBy->nExpr; i++){
  87533. pOrderBy->a[i].done = 0;
  87534. }
  87535. pSelect->pNext = 0;
  87536. while( pSelect->pPrior ){
  87537. pSelect->pPrior->pNext = pSelect;
  87538. pSelect = pSelect->pPrior;
  87539. }
  87540. while( pSelect && moreToDo ){
  87541. struct ExprList_item *pItem;
  87542. moreToDo = 0;
  87543. pEList = pSelect->pEList;
  87544. assert( pEList!=0 );
  87545. for(i=0, pItem=pOrderBy->a; i<pOrderBy->nExpr; i++, pItem++){
  87546. int iCol = -1;
  87547. Expr *pE, *pDup;
  87548. if( pItem->done ) continue;
  87549. pE = sqlite3ExprSkipCollate(pItem->pExpr);
  87550. if( sqlite3ExprIsInteger(pE, &iCol) ){
  87551. if( iCol<=0 || iCol>pEList->nExpr ){
  87552. resolveOutOfRangeError(pParse, "ORDER", i+1, pEList->nExpr);
  87553. return 1;
  87554. }
  87555. }else{
  87556. iCol = resolveAsName(pParse, pEList, pE);
  87557. if( iCol==0 ){
  87558. pDup = sqlite3ExprDup(db, pE, 0);
  87559. if( !db->mallocFailed ){
  87560. assert(pDup);
  87561. iCol = resolveOrderByTermToExprList(pParse, pSelect, pDup);
  87562. }
  87563. sqlite3ExprDelete(db, pDup);
  87564. }
  87565. }
  87566. if( iCol>0 ){
  87567. /* Convert the ORDER BY term into an integer column number iCol,
  87568. ** taking care to preserve the COLLATE clause if it exists */
  87569. Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
  87570. if( pNew==0 ) return 1;
  87571. pNew->flags |= EP_IntValue;
  87572. pNew->u.iValue = iCol;
  87573. if( pItem->pExpr==pE ){
  87574. pItem->pExpr = pNew;
  87575. }else{
  87576. Expr *pParent = pItem->pExpr;
  87577. assert( pParent->op==TK_COLLATE );
  87578. while( pParent->pLeft->op==TK_COLLATE ) pParent = pParent->pLeft;
  87579. assert( pParent->pLeft==pE );
  87580. pParent->pLeft = pNew;
  87581. }
  87582. sqlite3ExprDelete(db, pE);
  87583. pItem->u.x.iOrderByCol = (u16)iCol;
  87584. pItem->done = 1;
  87585. }else{
  87586. moreToDo = 1;
  87587. }
  87588. }
  87589. pSelect = pSelect->pNext;
  87590. }
  87591. for(i=0; i<pOrderBy->nExpr; i++){
  87592. if( pOrderBy->a[i].done==0 ){
  87593. sqlite3ErrorMsg(pParse, "%r ORDER BY term does not match any "
  87594. "column in the result set", i+1);
  87595. return 1;
  87596. }
  87597. }
  87598. return 0;
  87599. }
  87600. /*
  87601. ** Check every term in the ORDER BY or GROUP BY clause pOrderBy of
  87602. ** the SELECT statement pSelect. If any term is reference to a
  87603. ** result set expression (as determined by the ExprList.a.u.x.iOrderByCol
  87604. ** field) then convert that term into a copy of the corresponding result set
  87605. ** column.
  87606. **
  87607. ** If any errors are detected, add an error message to pParse and
  87608. ** return non-zero. Return zero if no errors are seen.
  87609. */
  87610. SQLITE_PRIVATE int sqlite3ResolveOrderGroupBy(
  87611. Parse *pParse, /* Parsing context. Leave error messages here */
  87612. Select *pSelect, /* The SELECT statement containing the clause */
  87613. ExprList *pOrderBy, /* The ORDER BY or GROUP BY clause to be processed */
  87614. const char *zType /* "ORDER" or "GROUP" */
  87615. ){
  87616. int i;
  87617. sqlite3 *db = pParse->db;
  87618. ExprList *pEList;
  87619. struct ExprList_item *pItem;
  87620. if( pOrderBy==0 || pParse->db->mallocFailed ) return 0;
  87621. if( pOrderBy->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  87622. sqlite3ErrorMsg(pParse, "too many terms in %s BY clause", zType);
  87623. return 1;
  87624. }
  87625. pEList = pSelect->pEList;
  87626. assert( pEList!=0 ); /* sqlite3SelectNew() guarantees this */
  87627. for(i=0, pItem=pOrderBy->a; i<pOrderBy->nExpr; i++, pItem++){
  87628. if( pItem->u.x.iOrderByCol ){
  87629. if( pItem->u.x.iOrderByCol>pEList->nExpr ){
  87630. resolveOutOfRangeError(pParse, zType, i+1, pEList->nExpr);
  87631. return 1;
  87632. }
  87633. resolveAlias(pParse, pEList, pItem->u.x.iOrderByCol-1, pItem->pExpr,
  87634. zType,0);
  87635. }
  87636. }
  87637. return 0;
  87638. }
  87639. /*
  87640. ** pOrderBy is an ORDER BY or GROUP BY clause in SELECT statement pSelect.
  87641. ** The Name context of the SELECT statement is pNC. zType is either
  87642. ** "ORDER" or "GROUP" depending on which type of clause pOrderBy is.
  87643. **
  87644. ** This routine resolves each term of the clause into an expression.
  87645. ** If the order-by term is an integer I between 1 and N (where N is the
  87646. ** number of columns in the result set of the SELECT) then the expression
  87647. ** in the resolution is a copy of the I-th result-set expression. If
  87648. ** the order-by term is an identifier that corresponds to the AS-name of
  87649. ** a result-set expression, then the term resolves to a copy of the
  87650. ** result-set expression. Otherwise, the expression is resolved in
  87651. ** the usual way - using sqlite3ResolveExprNames().
  87652. **
  87653. ** This routine returns the number of errors. If errors occur, then
  87654. ** an appropriate error message might be left in pParse. (OOM errors
  87655. ** excepted.)
  87656. */
  87657. static int resolveOrderGroupBy(
  87658. NameContext *pNC, /* The name context of the SELECT statement */
  87659. Select *pSelect, /* The SELECT statement holding pOrderBy */
  87660. ExprList *pOrderBy, /* An ORDER BY or GROUP BY clause to resolve */
  87661. const char *zType /* Either "ORDER" or "GROUP", as appropriate */
  87662. ){
  87663. int i, j; /* Loop counters */
  87664. int iCol; /* Column number */
  87665. struct ExprList_item *pItem; /* A term of the ORDER BY clause */
  87666. Parse *pParse; /* Parsing context */
  87667. int nResult; /* Number of terms in the result set */
  87668. if( pOrderBy==0 ) return 0;
  87669. nResult = pSelect->pEList->nExpr;
  87670. pParse = pNC->pParse;
  87671. for(i=0, pItem=pOrderBy->a; i<pOrderBy->nExpr; i++, pItem++){
  87672. Expr *pE = pItem->pExpr;
  87673. Expr *pE2 = sqlite3ExprSkipCollate(pE);
  87674. if( zType[0]!='G' ){
  87675. iCol = resolveAsName(pParse, pSelect->pEList, pE2);
  87676. if( iCol>0 ){
  87677. /* If an AS-name match is found, mark this ORDER BY column as being
  87678. ** a copy of the iCol-th result-set column. The subsequent call to
  87679. ** sqlite3ResolveOrderGroupBy() will convert the expression to a
  87680. ** copy of the iCol-th result-set expression. */
  87681. pItem->u.x.iOrderByCol = (u16)iCol;
  87682. continue;
  87683. }
  87684. }
  87685. if( sqlite3ExprIsInteger(pE2, &iCol) ){
  87686. /* The ORDER BY term is an integer constant. Again, set the column
  87687. ** number so that sqlite3ResolveOrderGroupBy() will convert the
  87688. ** order-by term to a copy of the result-set expression */
  87689. if( iCol<1 || iCol>0xffff ){
  87690. resolveOutOfRangeError(pParse, zType, i+1, nResult);
  87691. return 1;
  87692. }
  87693. pItem->u.x.iOrderByCol = (u16)iCol;
  87694. continue;
  87695. }
  87696. /* Otherwise, treat the ORDER BY term as an ordinary expression */
  87697. pItem->u.x.iOrderByCol = 0;
  87698. if( sqlite3ResolveExprNames(pNC, pE) ){
  87699. return 1;
  87700. }
  87701. for(j=0; j<pSelect->pEList->nExpr; j++){
  87702. if( sqlite3ExprCompare(0, pE, pSelect->pEList->a[j].pExpr, -1)==0 ){
  87703. pItem->u.x.iOrderByCol = j+1;
  87704. }
  87705. }
  87706. }
  87707. return sqlite3ResolveOrderGroupBy(pParse, pSelect, pOrderBy, zType);
  87708. }
  87709. /*
  87710. ** Resolve names in the SELECT statement p and all of its descendants.
  87711. */
  87712. static int resolveSelectStep(Walker *pWalker, Select *p){
  87713. NameContext *pOuterNC; /* Context that contains this SELECT */
  87714. NameContext sNC; /* Name context of this SELECT */
  87715. int isCompound; /* True if p is a compound select */
  87716. int nCompound; /* Number of compound terms processed so far */
  87717. Parse *pParse; /* Parsing context */
  87718. int i; /* Loop counter */
  87719. ExprList *pGroupBy; /* The GROUP BY clause */
  87720. Select *pLeftmost; /* Left-most of SELECT of a compound */
  87721. sqlite3 *db; /* Database connection */
  87722. assert( p!=0 );
  87723. if( p->selFlags & SF_Resolved ){
  87724. return WRC_Prune;
  87725. }
  87726. pOuterNC = pWalker->u.pNC;
  87727. pParse = pWalker->pParse;
  87728. db = pParse->db;
  87729. /* Normally sqlite3SelectExpand() will be called first and will have
  87730. ** already expanded this SELECT. However, if this is a subquery within
  87731. ** an expression, sqlite3ResolveExprNames() will be called without a
  87732. ** prior call to sqlite3SelectExpand(). When that happens, let
  87733. ** sqlite3SelectPrep() do all of the processing for this SELECT.
  87734. ** sqlite3SelectPrep() will invoke both sqlite3SelectExpand() and
  87735. ** this routine in the correct order.
  87736. */
  87737. if( (p->selFlags & SF_Expanded)==0 ){
  87738. sqlite3SelectPrep(pParse, p, pOuterNC);
  87739. return (pParse->nErr || db->mallocFailed) ? WRC_Abort : WRC_Prune;
  87740. }
  87741. isCompound = p->pPrior!=0;
  87742. nCompound = 0;
  87743. pLeftmost = p;
  87744. while( p ){
  87745. assert( (p->selFlags & SF_Expanded)!=0 );
  87746. assert( (p->selFlags & SF_Resolved)==0 );
  87747. p->selFlags |= SF_Resolved;
  87748. /* Resolve the expressions in the LIMIT and OFFSET clauses. These
  87749. ** are not allowed to refer to any names, so pass an empty NameContext.
  87750. */
  87751. memset(&sNC, 0, sizeof(sNC));
  87752. sNC.pParse = pParse;
  87753. if( sqlite3ResolveExprNames(&sNC, p->pLimit) ){
  87754. return WRC_Abort;
  87755. }
  87756. /* If the SF_Converted flags is set, then this Select object was
  87757. ** was created by the convertCompoundSelectToSubquery() function.
  87758. ** In this case the ORDER BY clause (p->pOrderBy) should be resolved
  87759. ** as if it were part of the sub-query, not the parent. This block
  87760. ** moves the pOrderBy down to the sub-query. It will be moved back
  87761. ** after the names have been resolved. */
  87762. if( p->selFlags & SF_Converted ){
  87763. Select *pSub = p->pSrc->a[0].pSelect;
  87764. assert( p->pSrc->nSrc==1 && p->pOrderBy );
  87765. assert( pSub->pPrior && pSub->pOrderBy==0 );
  87766. pSub->pOrderBy = p->pOrderBy;
  87767. p->pOrderBy = 0;
  87768. }
  87769. /* Recursively resolve names in all subqueries
  87770. */
  87771. for(i=0; i<p->pSrc->nSrc; i++){
  87772. struct SrcList_item *pItem = &p->pSrc->a[i];
  87773. if( pItem->pSelect ){
  87774. NameContext *pNC; /* Used to iterate name contexts */
  87775. int nRef = 0; /* Refcount for pOuterNC and outer contexts */
  87776. const char *zSavedContext = pParse->zAuthContext;
  87777. /* Count the total number of references to pOuterNC and all of its
  87778. ** parent contexts. After resolving references to expressions in
  87779. ** pItem->pSelect, check if this value has changed. If so, then
  87780. ** SELECT statement pItem->pSelect must be correlated. Set the
  87781. ** pItem->fg.isCorrelated flag if this is the case. */
  87782. for(pNC=pOuterNC; pNC; pNC=pNC->pNext) nRef += pNC->nRef;
  87783. if( pItem->zName ) pParse->zAuthContext = pItem->zName;
  87784. sqlite3ResolveSelectNames(pParse, pItem->pSelect, pOuterNC);
  87785. pParse->zAuthContext = zSavedContext;
  87786. if( pParse->nErr || db->mallocFailed ) return WRC_Abort;
  87787. for(pNC=pOuterNC; pNC; pNC=pNC->pNext) nRef -= pNC->nRef;
  87788. assert( pItem->fg.isCorrelated==0 && nRef<=0 );
  87789. pItem->fg.isCorrelated = (nRef!=0);
  87790. }
  87791. }
  87792. /* Set up the local name-context to pass to sqlite3ResolveExprNames() to
  87793. ** resolve the result-set expression list.
  87794. */
  87795. sNC.ncFlags = NC_AllowAgg;
  87796. sNC.pSrcList = p->pSrc;
  87797. sNC.pNext = pOuterNC;
  87798. /* Resolve names in the result set. */
  87799. if( sqlite3ResolveExprListNames(&sNC, p->pEList) ) return WRC_Abort;
  87800. /* If there are no aggregate functions in the result-set, and no GROUP BY
  87801. ** expression, do not allow aggregates in any of the other expressions.
  87802. */
  87803. assert( (p->selFlags & SF_Aggregate)==0 );
  87804. pGroupBy = p->pGroupBy;
  87805. if( pGroupBy || (sNC.ncFlags & NC_HasAgg)!=0 ){
  87806. assert( NC_MinMaxAgg==SF_MinMaxAgg );
  87807. p->selFlags |= SF_Aggregate | (sNC.ncFlags&NC_MinMaxAgg);
  87808. }else{
  87809. sNC.ncFlags &= ~NC_AllowAgg;
  87810. }
  87811. /* If a HAVING clause is present, then there must be a GROUP BY clause.
  87812. */
  87813. if( p->pHaving && !pGroupBy ){
  87814. sqlite3ErrorMsg(pParse, "a GROUP BY clause is required before HAVING");
  87815. return WRC_Abort;
  87816. }
  87817. /* Add the output column list to the name-context before parsing the
  87818. ** other expressions in the SELECT statement. This is so that
  87819. ** expressions in the WHERE clause (etc.) can refer to expressions by
  87820. ** aliases in the result set.
  87821. **
  87822. ** Minor point: If this is the case, then the expression will be
  87823. ** re-evaluated for each reference to it.
  87824. */
  87825. sNC.pEList = p->pEList;
  87826. if( sqlite3ResolveExprNames(&sNC, p->pHaving) ) return WRC_Abort;
  87827. if( sqlite3ResolveExprNames(&sNC, p->pWhere) ) return WRC_Abort;
  87828. /* Resolve names in table-valued-function arguments */
  87829. for(i=0; i<p->pSrc->nSrc; i++){
  87830. struct SrcList_item *pItem = &p->pSrc->a[i];
  87831. if( pItem->fg.isTabFunc
  87832. && sqlite3ResolveExprListNames(&sNC, pItem->u1.pFuncArg)
  87833. ){
  87834. return WRC_Abort;
  87835. }
  87836. }
  87837. /* The ORDER BY and GROUP BY clauses may not refer to terms in
  87838. ** outer queries
  87839. */
  87840. sNC.pNext = 0;
  87841. sNC.ncFlags |= NC_AllowAgg;
  87842. /* If this is a converted compound query, move the ORDER BY clause from
  87843. ** the sub-query back to the parent query. At this point each term
  87844. ** within the ORDER BY clause has been transformed to an integer value.
  87845. ** These integers will be replaced by copies of the corresponding result
  87846. ** set expressions by the call to resolveOrderGroupBy() below. */
  87847. if( p->selFlags & SF_Converted ){
  87848. Select *pSub = p->pSrc->a[0].pSelect;
  87849. p->pOrderBy = pSub->pOrderBy;
  87850. pSub->pOrderBy = 0;
  87851. }
  87852. /* Process the ORDER BY clause for singleton SELECT statements.
  87853. ** The ORDER BY clause for compounds SELECT statements is handled
  87854. ** below, after all of the result-sets for all of the elements of
  87855. ** the compound have been resolved.
  87856. **
  87857. ** If there is an ORDER BY clause on a term of a compound-select other
  87858. ** than the right-most term, then that is a syntax error. But the error
  87859. ** is not detected until much later, and so we need to go ahead and
  87860. ** resolve those symbols on the incorrect ORDER BY for consistency.
  87861. */
  87862. if( isCompound<=nCompound /* Defer right-most ORDER BY of a compound */
  87863. && resolveOrderGroupBy(&sNC, p, p->pOrderBy, "ORDER")
  87864. ){
  87865. return WRC_Abort;
  87866. }
  87867. if( db->mallocFailed ){
  87868. return WRC_Abort;
  87869. }
  87870. /* Resolve the GROUP BY clause. At the same time, make sure
  87871. ** the GROUP BY clause does not contain aggregate functions.
  87872. */
  87873. if( pGroupBy ){
  87874. struct ExprList_item *pItem;
  87875. if( resolveOrderGroupBy(&sNC, p, pGroupBy, "GROUP") || db->mallocFailed ){
  87876. return WRC_Abort;
  87877. }
  87878. for(i=0, pItem=pGroupBy->a; i<pGroupBy->nExpr; i++, pItem++){
  87879. if( ExprHasProperty(pItem->pExpr, EP_Agg) ){
  87880. sqlite3ErrorMsg(pParse, "aggregate functions are not allowed in "
  87881. "the GROUP BY clause");
  87882. return WRC_Abort;
  87883. }
  87884. }
  87885. }
  87886. /* If this is part of a compound SELECT, check that it has the right
  87887. ** number of expressions in the select list. */
  87888. if( p->pNext && p->pEList->nExpr!=p->pNext->pEList->nExpr ){
  87889. sqlite3SelectWrongNumTermsError(pParse, p->pNext);
  87890. return WRC_Abort;
  87891. }
  87892. /* Advance to the next term of the compound
  87893. */
  87894. p = p->pPrior;
  87895. nCompound++;
  87896. }
  87897. /* Resolve the ORDER BY on a compound SELECT after all terms of
  87898. ** the compound have been resolved.
  87899. */
  87900. if( isCompound && resolveCompoundOrderBy(pParse, pLeftmost) ){
  87901. return WRC_Abort;
  87902. }
  87903. return WRC_Prune;
  87904. }
  87905. /*
  87906. ** This routine walks an expression tree and resolves references to
  87907. ** table columns and result-set columns. At the same time, do error
  87908. ** checking on function usage and set a flag if any aggregate functions
  87909. ** are seen.
  87910. **
  87911. ** To resolve table columns references we look for nodes (or subtrees) of the
  87912. ** form X.Y.Z or Y.Z or just Z where
  87913. **
  87914. ** X: The name of a database. Ex: "main" or "temp" or
  87915. ** the symbolic name assigned to an ATTACH-ed database.
  87916. **
  87917. ** Y: The name of a table in a FROM clause. Or in a trigger
  87918. ** one of the special names "old" or "new".
  87919. **
  87920. ** Z: The name of a column in table Y.
  87921. **
  87922. ** The node at the root of the subtree is modified as follows:
  87923. **
  87924. ** Expr.op Changed to TK_COLUMN
  87925. ** Expr.pTab Points to the Table object for X.Y
  87926. ** Expr.iColumn The column index in X.Y. -1 for the rowid.
  87927. ** Expr.iTable The VDBE cursor number for X.Y
  87928. **
  87929. **
  87930. ** To resolve result-set references, look for expression nodes of the
  87931. ** form Z (with no X and Y prefix) where the Z matches the right-hand
  87932. ** size of an AS clause in the result-set of a SELECT. The Z expression
  87933. ** is replaced by a copy of the left-hand side of the result-set expression.
  87934. ** Table-name and function resolution occurs on the substituted expression
  87935. ** tree. For example, in:
  87936. **
  87937. ** SELECT a+b AS x, c+d AS y FROM t1 ORDER BY x;
  87938. **
  87939. ** The "x" term of the order by is replaced by "a+b" to render:
  87940. **
  87941. ** SELECT a+b AS x, c+d AS y FROM t1 ORDER BY a+b;
  87942. **
  87943. ** Function calls are checked to make sure that the function is
  87944. ** defined and that the correct number of arguments are specified.
  87945. ** If the function is an aggregate function, then the NC_HasAgg flag is
  87946. ** set and the opcode is changed from TK_FUNCTION to TK_AGG_FUNCTION.
  87947. ** If an expression contains aggregate functions then the EP_Agg
  87948. ** property on the expression is set.
  87949. **
  87950. ** An error message is left in pParse if anything is amiss. The number
  87951. ** if errors is returned.
  87952. */
  87953. SQLITE_PRIVATE int sqlite3ResolveExprNames(
  87954. NameContext *pNC, /* Namespace to resolve expressions in. */
  87955. Expr *pExpr /* The expression to be analyzed. */
  87956. ){
  87957. u16 savedHasAgg;
  87958. Walker w;
  87959. if( pExpr==0 ) return SQLITE_OK;
  87960. savedHasAgg = pNC->ncFlags & (NC_HasAgg|NC_MinMaxAgg);
  87961. pNC->ncFlags &= ~(NC_HasAgg|NC_MinMaxAgg);
  87962. w.pParse = pNC->pParse;
  87963. w.xExprCallback = resolveExprStep;
  87964. w.xSelectCallback = resolveSelectStep;
  87965. w.xSelectCallback2 = 0;
  87966. w.u.pNC = pNC;
  87967. #if SQLITE_MAX_EXPR_DEPTH>0
  87968. w.pParse->nHeight += pExpr->nHeight;
  87969. if( sqlite3ExprCheckHeight(w.pParse, w.pParse->nHeight) ){
  87970. return SQLITE_ERROR;
  87971. }
  87972. #endif
  87973. sqlite3WalkExpr(&w, pExpr);
  87974. #if SQLITE_MAX_EXPR_DEPTH>0
  87975. w.pParse->nHeight -= pExpr->nHeight;
  87976. #endif
  87977. if( pNC->ncFlags & NC_HasAgg ){
  87978. ExprSetProperty(pExpr, EP_Agg);
  87979. }
  87980. pNC->ncFlags |= savedHasAgg;
  87981. return pNC->nErr>0 || w.pParse->nErr>0;
  87982. }
  87983. /*
  87984. ** Resolve all names for all expression in an expression list. This is
  87985. ** just like sqlite3ResolveExprNames() except that it works for an expression
  87986. ** list rather than a single expression.
  87987. */
  87988. SQLITE_PRIVATE int sqlite3ResolveExprListNames(
  87989. NameContext *pNC, /* Namespace to resolve expressions in. */
  87990. ExprList *pList /* The expression list to be analyzed. */
  87991. ){
  87992. int i;
  87993. if( pList ){
  87994. for(i=0; i<pList->nExpr; i++){
  87995. if( sqlite3ResolveExprNames(pNC, pList->a[i].pExpr) ) return WRC_Abort;
  87996. }
  87997. }
  87998. return WRC_Continue;
  87999. }
  88000. /*
  88001. ** Resolve all names in all expressions of a SELECT and in all
  88002. ** decendents of the SELECT, including compounds off of p->pPrior,
  88003. ** subqueries in expressions, and subqueries used as FROM clause
  88004. ** terms.
  88005. **
  88006. ** See sqlite3ResolveExprNames() for a description of the kinds of
  88007. ** transformations that occur.
  88008. **
  88009. ** All SELECT statements should have been expanded using
  88010. ** sqlite3SelectExpand() prior to invoking this routine.
  88011. */
  88012. SQLITE_PRIVATE void sqlite3ResolveSelectNames(
  88013. Parse *pParse, /* The parser context */
  88014. Select *p, /* The SELECT statement being coded. */
  88015. NameContext *pOuterNC /* Name context for parent SELECT statement */
  88016. ){
  88017. Walker w;
  88018. assert( p!=0 );
  88019. w.xExprCallback = resolveExprStep;
  88020. w.xSelectCallback = resolveSelectStep;
  88021. w.xSelectCallback2 = 0;
  88022. w.pParse = pParse;
  88023. w.u.pNC = pOuterNC;
  88024. sqlite3WalkSelect(&w, p);
  88025. }
  88026. /*
  88027. ** Resolve names in expressions that can only reference a single table:
  88028. **
  88029. ** * CHECK constraints
  88030. ** * WHERE clauses on partial indices
  88031. **
  88032. ** The Expr.iTable value for Expr.op==TK_COLUMN nodes of the expression
  88033. ** is set to -1 and the Expr.iColumn value is set to the column number.
  88034. **
  88035. ** Any errors cause an error message to be set in pParse.
  88036. */
  88037. SQLITE_PRIVATE void sqlite3ResolveSelfReference(
  88038. Parse *pParse, /* Parsing context */
  88039. Table *pTab, /* The table being referenced */
  88040. int type, /* NC_IsCheck or NC_PartIdx or NC_IdxExpr */
  88041. Expr *pExpr, /* Expression to resolve. May be NULL. */
  88042. ExprList *pList /* Expression list to resolve. May be NUL. */
  88043. ){
  88044. SrcList sSrc; /* Fake SrcList for pParse->pNewTable */
  88045. NameContext sNC; /* Name context for pParse->pNewTable */
  88046. assert( type==NC_IsCheck || type==NC_PartIdx || type==NC_IdxExpr );
  88047. memset(&sNC, 0, sizeof(sNC));
  88048. memset(&sSrc, 0, sizeof(sSrc));
  88049. sSrc.nSrc = 1;
  88050. sSrc.a[0].zName = pTab->zName;
  88051. sSrc.a[0].pTab = pTab;
  88052. sSrc.a[0].iCursor = -1;
  88053. sNC.pParse = pParse;
  88054. sNC.pSrcList = &sSrc;
  88055. sNC.ncFlags = type;
  88056. if( sqlite3ResolveExprNames(&sNC, pExpr) ) return;
  88057. if( pList ) sqlite3ResolveExprListNames(&sNC, pList);
  88058. }
  88059. /************** End of resolve.c *********************************************/
  88060. /************** Begin file expr.c ********************************************/
  88061. /*
  88062. ** 2001 September 15
  88063. **
  88064. ** The author disclaims copyright to this source code. In place of
  88065. ** a legal notice, here is a blessing:
  88066. **
  88067. ** May you do good and not evil.
  88068. ** May you find forgiveness for yourself and forgive others.
  88069. ** May you share freely, never taking more than you give.
  88070. **
  88071. *************************************************************************
  88072. ** This file contains routines used for analyzing expressions and
  88073. ** for generating VDBE code that evaluates expressions in SQLite.
  88074. */
  88075. /* #include "sqliteInt.h" */
  88076. /* Forward declarations */
  88077. static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
  88078. static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
  88079. /*
  88080. ** Return the affinity character for a single column of a table.
  88081. */
  88082. SQLITE_PRIVATE char sqlite3TableColumnAffinity(Table *pTab, int iCol){
  88083. assert( iCol<pTab->nCol );
  88084. return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
  88085. }
  88086. /*
  88087. ** Return the 'affinity' of the expression pExpr if any.
  88088. **
  88089. ** If pExpr is a column, a reference to a column via an 'AS' alias,
  88090. ** or a sub-select with a column as the return value, then the
  88091. ** affinity of that column is returned. Otherwise, 0x00 is returned,
  88092. ** indicating no affinity for the expression.
  88093. **
  88094. ** i.e. the WHERE clause expressions in the following statements all
  88095. ** have an affinity:
  88096. **
  88097. ** CREATE TABLE t1(a);
  88098. ** SELECT * FROM t1 WHERE a;
  88099. ** SELECT a AS b FROM t1 WHERE b;
  88100. ** SELECT * FROM t1 WHERE (select a from t1);
  88101. */
  88102. SQLITE_PRIVATE char sqlite3ExprAffinity(Expr *pExpr){
  88103. int op;
  88104. pExpr = sqlite3ExprSkipCollate(pExpr);
  88105. if( pExpr->flags & EP_Generic ) return 0;
  88106. op = pExpr->op;
  88107. if( op==TK_SELECT ){
  88108. assert( pExpr->flags&EP_xIsSelect );
  88109. return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
  88110. }
  88111. if( op==TK_REGISTER ) op = pExpr->op2;
  88112. #ifndef SQLITE_OMIT_CAST
  88113. if( op==TK_CAST ){
  88114. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  88115. return sqlite3AffinityType(pExpr->u.zToken, 0);
  88116. }
  88117. #endif
  88118. if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab ){
  88119. return sqlite3TableColumnAffinity(pExpr->pTab, pExpr->iColumn);
  88120. }
  88121. if( op==TK_SELECT_COLUMN ){
  88122. assert( pExpr->pLeft->flags&EP_xIsSelect );
  88123. return sqlite3ExprAffinity(
  88124. pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
  88125. );
  88126. }
  88127. return pExpr->affinity;
  88128. }
  88129. /*
  88130. ** Set the collating sequence for expression pExpr to be the collating
  88131. ** sequence named by pToken. Return a pointer to a new Expr node that
  88132. ** implements the COLLATE operator.
  88133. **
  88134. ** If a memory allocation error occurs, that fact is recorded in pParse->db
  88135. ** and the pExpr parameter is returned unchanged.
  88136. */
  88137. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateToken(
  88138. Parse *pParse, /* Parsing context */
  88139. Expr *pExpr, /* Add the "COLLATE" clause to this expression */
  88140. const Token *pCollName, /* Name of collating sequence */
  88141. int dequote /* True to dequote pCollName */
  88142. ){
  88143. if( pCollName->n>0 ){
  88144. Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
  88145. if( pNew ){
  88146. pNew->pLeft = pExpr;
  88147. pNew->flags |= EP_Collate|EP_Skip;
  88148. pExpr = pNew;
  88149. }
  88150. }
  88151. return pExpr;
  88152. }
  88153. SQLITE_PRIVATE Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
  88154. Token s;
  88155. assert( zC!=0 );
  88156. sqlite3TokenInit(&s, (char*)zC);
  88157. return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
  88158. }
  88159. /*
  88160. ** Skip over any TK_COLLATE operators and any unlikely()
  88161. ** or likelihood() function at the root of an expression.
  88162. */
  88163. SQLITE_PRIVATE Expr *sqlite3ExprSkipCollate(Expr *pExpr){
  88164. while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
  88165. if( ExprHasProperty(pExpr, EP_Unlikely) ){
  88166. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  88167. assert( pExpr->x.pList->nExpr>0 );
  88168. assert( pExpr->op==TK_FUNCTION );
  88169. pExpr = pExpr->x.pList->a[0].pExpr;
  88170. }else{
  88171. assert( pExpr->op==TK_COLLATE );
  88172. pExpr = pExpr->pLeft;
  88173. }
  88174. }
  88175. return pExpr;
  88176. }
  88177. /*
  88178. ** Return the collation sequence for the expression pExpr. If
  88179. ** there is no defined collating sequence, return NULL.
  88180. **
  88181. ** See also: sqlite3ExprNNCollSeq()
  88182. **
  88183. ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
  88184. ** default collation if pExpr has no defined collation.
  88185. **
  88186. ** The collating sequence might be determined by a COLLATE operator
  88187. ** or by the presence of a column with a defined collating sequence.
  88188. ** COLLATE operators take first precedence. Left operands take
  88189. ** precedence over right operands.
  88190. */
  88191. SQLITE_PRIVATE CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
  88192. sqlite3 *db = pParse->db;
  88193. CollSeq *pColl = 0;
  88194. Expr *p = pExpr;
  88195. while( p ){
  88196. int op = p->op;
  88197. if( p->flags & EP_Generic ) break;
  88198. if( op==TK_CAST || op==TK_UPLUS ){
  88199. p = p->pLeft;
  88200. continue;
  88201. }
  88202. if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
  88203. pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
  88204. break;
  88205. }
  88206. if( (op==TK_AGG_COLUMN || op==TK_COLUMN
  88207. || op==TK_REGISTER || op==TK_TRIGGER)
  88208. && p->pTab!=0
  88209. ){
  88210. /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
  88211. ** a TK_COLUMN but was previously evaluated and cached in a register */
  88212. int j = p->iColumn;
  88213. if( j>=0 ){
  88214. const char *zColl = p->pTab->aCol[j].zColl;
  88215. pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
  88216. }
  88217. break;
  88218. }
  88219. if( p->flags & EP_Collate ){
  88220. if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
  88221. p = p->pLeft;
  88222. }else{
  88223. Expr *pNext = p->pRight;
  88224. /* The Expr.x union is never used at the same time as Expr.pRight */
  88225. assert( p->x.pList==0 || p->pRight==0 );
  88226. /* p->flags holds EP_Collate and p->pLeft->flags does not. And
  88227. ** p->x.pSelect cannot. So if p->x.pLeft exists, it must hold at
  88228. ** least one EP_Collate. Thus the following two ALWAYS. */
  88229. if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
  88230. int i;
  88231. for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
  88232. if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
  88233. pNext = p->x.pList->a[i].pExpr;
  88234. break;
  88235. }
  88236. }
  88237. }
  88238. p = pNext;
  88239. }
  88240. }else{
  88241. break;
  88242. }
  88243. }
  88244. if( sqlite3CheckCollSeq(pParse, pColl) ){
  88245. pColl = 0;
  88246. }
  88247. return pColl;
  88248. }
  88249. /*
  88250. ** Return the collation sequence for the expression pExpr. If
  88251. ** there is no defined collating sequence, return a pointer to the
  88252. ** defautl collation sequence.
  88253. **
  88254. ** See also: sqlite3ExprCollSeq()
  88255. **
  88256. ** The sqlite3ExprCollSeq() routine works the same except that it
  88257. ** returns NULL if there is no defined collation.
  88258. */
  88259. SQLITE_PRIVATE CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
  88260. CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
  88261. if( p==0 ) p = pParse->db->pDfltColl;
  88262. assert( p!=0 );
  88263. return p;
  88264. }
  88265. /*
  88266. ** Return TRUE if the two expressions have equivalent collating sequences.
  88267. */
  88268. SQLITE_PRIVATE int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
  88269. CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
  88270. CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
  88271. return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
  88272. }
  88273. /*
  88274. ** pExpr is an operand of a comparison operator. aff2 is the
  88275. ** type affinity of the other operand. This routine returns the
  88276. ** type affinity that should be used for the comparison operator.
  88277. */
  88278. SQLITE_PRIVATE char sqlite3CompareAffinity(Expr *pExpr, char aff2){
  88279. char aff1 = sqlite3ExprAffinity(pExpr);
  88280. if( aff1 && aff2 ){
  88281. /* Both sides of the comparison are columns. If one has numeric
  88282. ** affinity, use that. Otherwise use no affinity.
  88283. */
  88284. if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
  88285. return SQLITE_AFF_NUMERIC;
  88286. }else{
  88287. return SQLITE_AFF_BLOB;
  88288. }
  88289. }else if( !aff1 && !aff2 ){
  88290. /* Neither side of the comparison is a column. Compare the
  88291. ** results directly.
  88292. */
  88293. return SQLITE_AFF_BLOB;
  88294. }else{
  88295. /* One side is a column, the other is not. Use the columns affinity. */
  88296. assert( aff1==0 || aff2==0 );
  88297. return (aff1 + aff2);
  88298. }
  88299. }
  88300. /*
  88301. ** pExpr is a comparison operator. Return the type affinity that should
  88302. ** be applied to both operands prior to doing the comparison.
  88303. */
  88304. static char comparisonAffinity(Expr *pExpr){
  88305. char aff;
  88306. assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
  88307. pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
  88308. pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
  88309. assert( pExpr->pLeft );
  88310. aff = sqlite3ExprAffinity(pExpr->pLeft);
  88311. if( pExpr->pRight ){
  88312. aff = sqlite3CompareAffinity(pExpr->pRight, aff);
  88313. }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  88314. aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
  88315. }else if( aff==0 ){
  88316. aff = SQLITE_AFF_BLOB;
  88317. }
  88318. return aff;
  88319. }
  88320. /*
  88321. ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
  88322. ** idx_affinity is the affinity of an indexed column. Return true
  88323. ** if the index with affinity idx_affinity may be used to implement
  88324. ** the comparison in pExpr.
  88325. */
  88326. SQLITE_PRIVATE int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
  88327. char aff = comparisonAffinity(pExpr);
  88328. switch( aff ){
  88329. case SQLITE_AFF_BLOB:
  88330. return 1;
  88331. case SQLITE_AFF_TEXT:
  88332. return idx_affinity==SQLITE_AFF_TEXT;
  88333. default:
  88334. return sqlite3IsNumericAffinity(idx_affinity);
  88335. }
  88336. }
  88337. /*
  88338. ** Return the P5 value that should be used for a binary comparison
  88339. ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
  88340. */
  88341. static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
  88342. u8 aff = (char)sqlite3ExprAffinity(pExpr2);
  88343. aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
  88344. return aff;
  88345. }
  88346. /*
  88347. ** Return a pointer to the collation sequence that should be used by
  88348. ** a binary comparison operator comparing pLeft and pRight.
  88349. **
  88350. ** If the left hand expression has a collating sequence type, then it is
  88351. ** used. Otherwise the collation sequence for the right hand expression
  88352. ** is used, or the default (BINARY) if neither expression has a collating
  88353. ** type.
  88354. **
  88355. ** Argument pRight (but not pLeft) may be a null pointer. In this case,
  88356. ** it is not considered.
  88357. */
  88358. SQLITE_PRIVATE CollSeq *sqlite3BinaryCompareCollSeq(
  88359. Parse *pParse,
  88360. Expr *pLeft,
  88361. Expr *pRight
  88362. ){
  88363. CollSeq *pColl;
  88364. assert( pLeft );
  88365. if( pLeft->flags & EP_Collate ){
  88366. pColl = sqlite3ExprCollSeq(pParse, pLeft);
  88367. }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
  88368. pColl = sqlite3ExprCollSeq(pParse, pRight);
  88369. }else{
  88370. pColl = sqlite3ExprCollSeq(pParse, pLeft);
  88371. if( !pColl ){
  88372. pColl = sqlite3ExprCollSeq(pParse, pRight);
  88373. }
  88374. }
  88375. return pColl;
  88376. }
  88377. /*
  88378. ** Generate code for a comparison operator.
  88379. */
  88380. static int codeCompare(
  88381. Parse *pParse, /* The parsing (and code generating) context */
  88382. Expr *pLeft, /* The left operand */
  88383. Expr *pRight, /* The right operand */
  88384. int opcode, /* The comparison opcode */
  88385. int in1, int in2, /* Register holding operands */
  88386. int dest, /* Jump here if true. */
  88387. int jumpIfNull /* If true, jump if either operand is NULL */
  88388. ){
  88389. int p5;
  88390. int addr;
  88391. CollSeq *p4;
  88392. p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
  88393. p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
  88394. addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
  88395. (void*)p4, P4_COLLSEQ);
  88396. sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
  88397. return addr;
  88398. }
  88399. /*
  88400. ** Return true if expression pExpr is a vector, or false otherwise.
  88401. **
  88402. ** A vector is defined as any expression that results in two or more
  88403. ** columns of result. Every TK_VECTOR node is an vector because the
  88404. ** parser will not generate a TK_VECTOR with fewer than two entries.
  88405. ** But a TK_SELECT might be either a vector or a scalar. It is only
  88406. ** considered a vector if it has two or more result columns.
  88407. */
  88408. SQLITE_PRIVATE int sqlite3ExprIsVector(Expr *pExpr){
  88409. return sqlite3ExprVectorSize(pExpr)>1;
  88410. }
  88411. /*
  88412. ** If the expression passed as the only argument is of type TK_VECTOR
  88413. ** return the number of expressions in the vector. Or, if the expression
  88414. ** is a sub-select, return the number of columns in the sub-select. For
  88415. ** any other type of expression, return 1.
  88416. */
  88417. SQLITE_PRIVATE int sqlite3ExprVectorSize(Expr *pExpr){
  88418. u8 op = pExpr->op;
  88419. if( op==TK_REGISTER ) op = pExpr->op2;
  88420. if( op==TK_VECTOR ){
  88421. return pExpr->x.pList->nExpr;
  88422. }else if( op==TK_SELECT ){
  88423. return pExpr->x.pSelect->pEList->nExpr;
  88424. }else{
  88425. return 1;
  88426. }
  88427. }
  88428. /*
  88429. ** Return a pointer to a subexpression of pVector that is the i-th
  88430. ** column of the vector (numbered starting with 0). The caller must
  88431. ** ensure that i is within range.
  88432. **
  88433. ** If pVector is really a scalar (and "scalar" here includes subqueries
  88434. ** that return a single column!) then return pVector unmodified.
  88435. **
  88436. ** pVector retains ownership of the returned subexpression.
  88437. **
  88438. ** If the vector is a (SELECT ...) then the expression returned is
  88439. ** just the expression for the i-th term of the result set, and may
  88440. ** not be ready for evaluation because the table cursor has not yet
  88441. ** been positioned.
  88442. */
  88443. SQLITE_PRIVATE Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
  88444. assert( i<sqlite3ExprVectorSize(pVector) );
  88445. if( sqlite3ExprIsVector(pVector) ){
  88446. assert( pVector->op2==0 || pVector->op==TK_REGISTER );
  88447. if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
  88448. return pVector->x.pSelect->pEList->a[i].pExpr;
  88449. }else{
  88450. return pVector->x.pList->a[i].pExpr;
  88451. }
  88452. }
  88453. return pVector;
  88454. }
  88455. /*
  88456. ** Compute and return a new Expr object which when passed to
  88457. ** sqlite3ExprCode() will generate all necessary code to compute
  88458. ** the iField-th column of the vector expression pVector.
  88459. **
  88460. ** It is ok for pVector to be a scalar (as long as iField==0).
  88461. ** In that case, this routine works like sqlite3ExprDup().
  88462. **
  88463. ** The caller owns the returned Expr object and is responsible for
  88464. ** ensuring that the returned value eventually gets freed.
  88465. **
  88466. ** The caller retains ownership of pVector. If pVector is a TK_SELECT,
  88467. ** then the returned object will reference pVector and so pVector must remain
  88468. ** valid for the life of the returned object. If pVector is a TK_VECTOR
  88469. ** or a scalar expression, then it can be deleted as soon as this routine
  88470. ** returns.
  88471. **
  88472. ** A trick to cause a TK_SELECT pVector to be deleted together with
  88473. ** the returned Expr object is to attach the pVector to the pRight field
  88474. ** of the returned TK_SELECT_COLUMN Expr object.
  88475. */
  88476. SQLITE_PRIVATE Expr *sqlite3ExprForVectorField(
  88477. Parse *pParse, /* Parsing context */
  88478. Expr *pVector, /* The vector. List of expressions or a sub-SELECT */
  88479. int iField /* Which column of the vector to return */
  88480. ){
  88481. Expr *pRet;
  88482. if( pVector->op==TK_SELECT ){
  88483. assert( pVector->flags & EP_xIsSelect );
  88484. /* The TK_SELECT_COLUMN Expr node:
  88485. **
  88486. ** pLeft: pVector containing TK_SELECT. Not deleted.
  88487. ** pRight: not used. But recursively deleted.
  88488. ** iColumn: Index of a column in pVector
  88489. ** iTable: 0 or the number of columns on the LHS of an assignment
  88490. ** pLeft->iTable: First in an array of register holding result, or 0
  88491. ** if the result is not yet computed.
  88492. **
  88493. ** sqlite3ExprDelete() specifically skips the recursive delete of
  88494. ** pLeft on TK_SELECT_COLUMN nodes. But pRight is followed, so pVector
  88495. ** can be attached to pRight to cause this node to take ownership of
  88496. ** pVector. Typically there will be multiple TK_SELECT_COLUMN nodes
  88497. ** with the same pLeft pointer to the pVector, but only one of them
  88498. ** will own the pVector.
  88499. */
  88500. pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
  88501. if( pRet ){
  88502. pRet->iColumn = iField;
  88503. pRet->pLeft = pVector;
  88504. }
  88505. assert( pRet==0 || pRet->iTable==0 );
  88506. }else{
  88507. if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
  88508. pRet = sqlite3ExprDup(pParse->db, pVector, 0);
  88509. }
  88510. return pRet;
  88511. }
  88512. /*
  88513. ** If expression pExpr is of type TK_SELECT, generate code to evaluate
  88514. ** it. Return the register in which the result is stored (or, if the
  88515. ** sub-select returns more than one column, the first in an array
  88516. ** of registers in which the result is stored).
  88517. **
  88518. ** If pExpr is not a TK_SELECT expression, return 0.
  88519. */
  88520. static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
  88521. int reg = 0;
  88522. #ifndef SQLITE_OMIT_SUBQUERY
  88523. if( pExpr->op==TK_SELECT ){
  88524. reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
  88525. }
  88526. #endif
  88527. return reg;
  88528. }
  88529. /*
  88530. ** Argument pVector points to a vector expression - either a TK_VECTOR
  88531. ** or TK_SELECT that returns more than one column. This function returns
  88532. ** the register number of a register that contains the value of
  88533. ** element iField of the vector.
  88534. **
  88535. ** If pVector is a TK_SELECT expression, then code for it must have
  88536. ** already been generated using the exprCodeSubselect() routine. In this
  88537. ** case parameter regSelect should be the first in an array of registers
  88538. ** containing the results of the sub-select.
  88539. **
  88540. ** If pVector is of type TK_VECTOR, then code for the requested field
  88541. ** is generated. In this case (*pRegFree) may be set to the number of
  88542. ** a temporary register to be freed by the caller before returning.
  88543. **
  88544. ** Before returning, output parameter (*ppExpr) is set to point to the
  88545. ** Expr object corresponding to element iElem of the vector.
  88546. */
  88547. static int exprVectorRegister(
  88548. Parse *pParse, /* Parse context */
  88549. Expr *pVector, /* Vector to extract element from */
  88550. int iField, /* Field to extract from pVector */
  88551. int regSelect, /* First in array of registers */
  88552. Expr **ppExpr, /* OUT: Expression element */
  88553. int *pRegFree /* OUT: Temp register to free */
  88554. ){
  88555. u8 op = pVector->op;
  88556. assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
  88557. if( op==TK_REGISTER ){
  88558. *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
  88559. return pVector->iTable+iField;
  88560. }
  88561. if( op==TK_SELECT ){
  88562. *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
  88563. return regSelect+iField;
  88564. }
  88565. *ppExpr = pVector->x.pList->a[iField].pExpr;
  88566. return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
  88567. }
  88568. /*
  88569. ** Expression pExpr is a comparison between two vector values. Compute
  88570. ** the result of the comparison (1, 0, or NULL) and write that
  88571. ** result into register dest.
  88572. **
  88573. ** The caller must satisfy the following preconditions:
  88574. **
  88575. ** if pExpr->op==TK_IS: op==TK_EQ and p5==SQLITE_NULLEQ
  88576. ** if pExpr->op==TK_ISNOT: op==TK_NE and p5==SQLITE_NULLEQ
  88577. ** otherwise: op==pExpr->op and p5==0
  88578. */
  88579. static void codeVectorCompare(
  88580. Parse *pParse, /* Code generator context */
  88581. Expr *pExpr, /* The comparison operation */
  88582. int dest, /* Write results into this register */
  88583. u8 op, /* Comparison operator */
  88584. u8 p5 /* SQLITE_NULLEQ or zero */
  88585. ){
  88586. Vdbe *v = pParse->pVdbe;
  88587. Expr *pLeft = pExpr->pLeft;
  88588. Expr *pRight = pExpr->pRight;
  88589. int nLeft = sqlite3ExprVectorSize(pLeft);
  88590. int i;
  88591. int regLeft = 0;
  88592. int regRight = 0;
  88593. u8 opx = op;
  88594. int addrDone = sqlite3VdbeMakeLabel(v);
  88595. if( nLeft!=sqlite3ExprVectorSize(pRight) ){
  88596. sqlite3ErrorMsg(pParse, "row value misused");
  88597. return;
  88598. }
  88599. assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
  88600. || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
  88601. || pExpr->op==TK_LT || pExpr->op==TK_GT
  88602. || pExpr->op==TK_LE || pExpr->op==TK_GE
  88603. );
  88604. assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
  88605. || (pExpr->op==TK_ISNOT && op==TK_NE) );
  88606. assert( p5==0 || pExpr->op!=op );
  88607. assert( p5==SQLITE_NULLEQ || pExpr->op==op );
  88608. p5 |= SQLITE_STOREP2;
  88609. if( opx==TK_LE ) opx = TK_LT;
  88610. if( opx==TK_GE ) opx = TK_GT;
  88611. regLeft = exprCodeSubselect(pParse, pLeft);
  88612. regRight = exprCodeSubselect(pParse, pRight);
  88613. for(i=0; 1 /*Loop exits by "break"*/; i++){
  88614. int regFree1 = 0, regFree2 = 0;
  88615. Expr *pL, *pR;
  88616. int r1, r2;
  88617. assert( i>=0 && i<nLeft );
  88618. if( i>0 ) sqlite3ExprCachePush(pParse);
  88619. r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
  88620. r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
  88621. codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
  88622. testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  88623. testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  88624. testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  88625. testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  88626. testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
  88627. testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
  88628. sqlite3ReleaseTempReg(pParse, regFree1);
  88629. sqlite3ReleaseTempReg(pParse, regFree2);
  88630. if( i>0 ) sqlite3ExprCachePop(pParse);
  88631. if( i==nLeft-1 ){
  88632. break;
  88633. }
  88634. if( opx==TK_EQ ){
  88635. sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
  88636. p5 |= SQLITE_KEEPNULL;
  88637. }else if( opx==TK_NE ){
  88638. sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
  88639. p5 |= SQLITE_KEEPNULL;
  88640. }else{
  88641. assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
  88642. sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
  88643. VdbeCoverageIf(v, op==TK_LT);
  88644. VdbeCoverageIf(v, op==TK_GT);
  88645. VdbeCoverageIf(v, op==TK_LE);
  88646. VdbeCoverageIf(v, op==TK_GE);
  88647. if( i==nLeft-2 ) opx = op;
  88648. }
  88649. }
  88650. sqlite3VdbeResolveLabel(v, addrDone);
  88651. }
  88652. #if SQLITE_MAX_EXPR_DEPTH>0
  88653. /*
  88654. ** Check that argument nHeight is less than or equal to the maximum
  88655. ** expression depth allowed. If it is not, leave an error message in
  88656. ** pParse.
  88657. */
  88658. SQLITE_PRIVATE int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
  88659. int rc = SQLITE_OK;
  88660. int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
  88661. if( nHeight>mxHeight ){
  88662. sqlite3ErrorMsg(pParse,
  88663. "Expression tree is too large (maximum depth %d)", mxHeight
  88664. );
  88665. rc = SQLITE_ERROR;
  88666. }
  88667. return rc;
  88668. }
  88669. /* The following three functions, heightOfExpr(), heightOfExprList()
  88670. ** and heightOfSelect(), are used to determine the maximum height
  88671. ** of any expression tree referenced by the structure passed as the
  88672. ** first argument.
  88673. **
  88674. ** If this maximum height is greater than the current value pointed
  88675. ** to by pnHeight, the second parameter, then set *pnHeight to that
  88676. ** value.
  88677. */
  88678. static void heightOfExpr(Expr *p, int *pnHeight){
  88679. if( p ){
  88680. if( p->nHeight>*pnHeight ){
  88681. *pnHeight = p->nHeight;
  88682. }
  88683. }
  88684. }
  88685. static void heightOfExprList(ExprList *p, int *pnHeight){
  88686. if( p ){
  88687. int i;
  88688. for(i=0; i<p->nExpr; i++){
  88689. heightOfExpr(p->a[i].pExpr, pnHeight);
  88690. }
  88691. }
  88692. }
  88693. static void heightOfSelect(Select *pSelect, int *pnHeight){
  88694. Select *p;
  88695. for(p=pSelect; p; p=p->pPrior){
  88696. heightOfExpr(p->pWhere, pnHeight);
  88697. heightOfExpr(p->pHaving, pnHeight);
  88698. heightOfExpr(p->pLimit, pnHeight);
  88699. heightOfExprList(p->pEList, pnHeight);
  88700. heightOfExprList(p->pGroupBy, pnHeight);
  88701. heightOfExprList(p->pOrderBy, pnHeight);
  88702. }
  88703. }
  88704. /*
  88705. ** Set the Expr.nHeight variable in the structure passed as an
  88706. ** argument. An expression with no children, Expr.pList or
  88707. ** Expr.pSelect member has a height of 1. Any other expression
  88708. ** has a height equal to the maximum height of any other
  88709. ** referenced Expr plus one.
  88710. **
  88711. ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
  88712. ** if appropriate.
  88713. */
  88714. static void exprSetHeight(Expr *p){
  88715. int nHeight = 0;
  88716. heightOfExpr(p->pLeft, &nHeight);
  88717. heightOfExpr(p->pRight, &nHeight);
  88718. if( ExprHasProperty(p, EP_xIsSelect) ){
  88719. heightOfSelect(p->x.pSelect, &nHeight);
  88720. }else if( p->x.pList ){
  88721. heightOfExprList(p->x.pList, &nHeight);
  88722. p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
  88723. }
  88724. p->nHeight = nHeight + 1;
  88725. }
  88726. /*
  88727. ** Set the Expr.nHeight variable using the exprSetHeight() function. If
  88728. ** the height is greater than the maximum allowed expression depth,
  88729. ** leave an error in pParse.
  88730. **
  88731. ** Also propagate all EP_Propagate flags from the Expr.x.pList into
  88732. ** Expr.flags.
  88733. */
  88734. SQLITE_PRIVATE void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
  88735. if( pParse->nErr ) return;
  88736. exprSetHeight(p);
  88737. sqlite3ExprCheckHeight(pParse, p->nHeight);
  88738. }
  88739. /*
  88740. ** Return the maximum height of any expression tree referenced
  88741. ** by the select statement passed as an argument.
  88742. */
  88743. SQLITE_PRIVATE int sqlite3SelectExprHeight(Select *p){
  88744. int nHeight = 0;
  88745. heightOfSelect(p, &nHeight);
  88746. return nHeight;
  88747. }
  88748. #else /* ABOVE: Height enforcement enabled. BELOW: Height enforcement off */
  88749. /*
  88750. ** Propagate all EP_Propagate flags from the Expr.x.pList into
  88751. ** Expr.flags.
  88752. */
  88753. SQLITE_PRIVATE void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
  88754. if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
  88755. p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
  88756. }
  88757. }
  88758. #define exprSetHeight(y)
  88759. #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
  88760. /*
  88761. ** This routine is the core allocator for Expr nodes.
  88762. **
  88763. ** Construct a new expression node and return a pointer to it. Memory
  88764. ** for this node and for the pToken argument is a single allocation
  88765. ** obtained from sqlite3DbMalloc(). The calling function
  88766. ** is responsible for making sure the node eventually gets freed.
  88767. **
  88768. ** If dequote is true, then the token (if it exists) is dequoted.
  88769. ** If dequote is false, no dequoting is performed. The deQuote
  88770. ** parameter is ignored if pToken is NULL or if the token does not
  88771. ** appear to be quoted. If the quotes were of the form "..." (double-quotes)
  88772. ** then the EP_DblQuoted flag is set on the expression node.
  88773. **
  88774. ** Special case: If op==TK_INTEGER and pToken points to a string that
  88775. ** can be translated into a 32-bit integer, then the token is not
  88776. ** stored in u.zToken. Instead, the integer values is written
  88777. ** into u.iValue and the EP_IntValue flag is set. No extra storage
  88778. ** is allocated to hold the integer text and the dequote flag is ignored.
  88779. */
  88780. SQLITE_PRIVATE Expr *sqlite3ExprAlloc(
  88781. sqlite3 *db, /* Handle for sqlite3DbMallocRawNN() */
  88782. int op, /* Expression opcode */
  88783. const Token *pToken, /* Token argument. Might be NULL */
  88784. int dequote /* True to dequote */
  88785. ){
  88786. Expr *pNew;
  88787. int nExtra = 0;
  88788. int iValue = 0;
  88789. assert( db!=0 );
  88790. if( pToken ){
  88791. if( op!=TK_INTEGER || pToken->z==0
  88792. || sqlite3GetInt32(pToken->z, &iValue)==0 ){
  88793. nExtra = pToken->n+1;
  88794. assert( iValue>=0 );
  88795. }
  88796. }
  88797. pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
  88798. if( pNew ){
  88799. memset(pNew, 0, sizeof(Expr));
  88800. pNew->op = (u8)op;
  88801. pNew->iAgg = -1;
  88802. if( pToken ){
  88803. if( nExtra==0 ){
  88804. pNew->flags |= EP_IntValue|EP_Leaf;
  88805. pNew->u.iValue = iValue;
  88806. }else{
  88807. pNew->u.zToken = (char*)&pNew[1];
  88808. assert( pToken->z!=0 || pToken->n==0 );
  88809. if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
  88810. pNew->u.zToken[pToken->n] = 0;
  88811. if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
  88812. if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
  88813. sqlite3Dequote(pNew->u.zToken);
  88814. }
  88815. }
  88816. }
  88817. #if SQLITE_MAX_EXPR_DEPTH>0
  88818. pNew->nHeight = 1;
  88819. #endif
  88820. }
  88821. return pNew;
  88822. }
  88823. /*
  88824. ** Allocate a new expression node from a zero-terminated token that has
  88825. ** already been dequoted.
  88826. */
  88827. SQLITE_PRIVATE Expr *sqlite3Expr(
  88828. sqlite3 *db, /* Handle for sqlite3DbMallocZero() (may be null) */
  88829. int op, /* Expression opcode */
  88830. const char *zToken /* Token argument. Might be NULL */
  88831. ){
  88832. Token x;
  88833. x.z = zToken;
  88834. x.n = sqlite3Strlen30(zToken);
  88835. return sqlite3ExprAlloc(db, op, &x, 0);
  88836. }
  88837. /*
  88838. ** Attach subtrees pLeft and pRight to the Expr node pRoot.
  88839. **
  88840. ** If pRoot==NULL that means that a memory allocation error has occurred.
  88841. ** In that case, delete the subtrees pLeft and pRight.
  88842. */
  88843. SQLITE_PRIVATE void sqlite3ExprAttachSubtrees(
  88844. sqlite3 *db,
  88845. Expr *pRoot,
  88846. Expr *pLeft,
  88847. Expr *pRight
  88848. ){
  88849. if( pRoot==0 ){
  88850. assert( db->mallocFailed );
  88851. sqlite3ExprDelete(db, pLeft);
  88852. sqlite3ExprDelete(db, pRight);
  88853. }else{
  88854. if( pRight ){
  88855. pRoot->pRight = pRight;
  88856. pRoot->flags |= EP_Propagate & pRight->flags;
  88857. }
  88858. if( pLeft ){
  88859. pRoot->pLeft = pLeft;
  88860. pRoot->flags |= EP_Propagate & pLeft->flags;
  88861. }
  88862. exprSetHeight(pRoot);
  88863. }
  88864. }
  88865. /*
  88866. ** Allocate an Expr node which joins as many as two subtrees.
  88867. **
  88868. ** One or both of the subtrees can be NULL. Return a pointer to the new
  88869. ** Expr node. Or, if an OOM error occurs, set pParse->db->mallocFailed,
  88870. ** free the subtrees and return NULL.
  88871. */
  88872. SQLITE_PRIVATE Expr *sqlite3PExpr(
  88873. Parse *pParse, /* Parsing context */
  88874. int op, /* Expression opcode */
  88875. Expr *pLeft, /* Left operand */
  88876. Expr *pRight /* Right operand */
  88877. ){
  88878. Expr *p;
  88879. if( op==TK_AND && pParse->nErr==0 ){
  88880. /* Take advantage of short-circuit false optimization for AND */
  88881. p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
  88882. }else{
  88883. p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
  88884. if( p ){
  88885. memset(p, 0, sizeof(Expr));
  88886. p->op = op & TKFLG_MASK;
  88887. p->iAgg = -1;
  88888. }
  88889. sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
  88890. }
  88891. if( p ) {
  88892. sqlite3ExprCheckHeight(pParse, p->nHeight);
  88893. }
  88894. return p;
  88895. }
  88896. /*
  88897. ** Add pSelect to the Expr.x.pSelect field. Or, if pExpr is NULL (due
  88898. ** do a memory allocation failure) then delete the pSelect object.
  88899. */
  88900. SQLITE_PRIVATE void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
  88901. if( pExpr ){
  88902. pExpr->x.pSelect = pSelect;
  88903. ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
  88904. sqlite3ExprSetHeightAndFlags(pParse, pExpr);
  88905. }else{
  88906. assert( pParse->db->mallocFailed );
  88907. sqlite3SelectDelete(pParse->db, pSelect);
  88908. }
  88909. }
  88910. /*
  88911. ** If the expression is always either TRUE or FALSE (respectively),
  88912. ** then return 1. If one cannot determine the truth value of the
  88913. ** expression at compile-time return 0.
  88914. **
  88915. ** This is an optimization. If is OK to return 0 here even if
  88916. ** the expression really is always false or false (a false negative).
  88917. ** But it is a bug to return 1 if the expression might have different
  88918. ** boolean values in different circumstances (a false positive.)
  88919. **
  88920. ** Note that if the expression is part of conditional for a
  88921. ** LEFT JOIN, then we cannot determine at compile-time whether or not
  88922. ** is it true or false, so always return 0.
  88923. */
  88924. static int exprAlwaysTrue(Expr *p){
  88925. int v = 0;
  88926. if( ExprHasProperty(p, EP_FromJoin) ) return 0;
  88927. if( !sqlite3ExprIsInteger(p, &v) ) return 0;
  88928. return v!=0;
  88929. }
  88930. static int exprAlwaysFalse(Expr *p){
  88931. int v = 0;
  88932. if( ExprHasProperty(p, EP_FromJoin) ) return 0;
  88933. if( !sqlite3ExprIsInteger(p, &v) ) return 0;
  88934. return v==0;
  88935. }
  88936. /*
  88937. ** Join two expressions using an AND operator. If either expression is
  88938. ** NULL, then just return the other expression.
  88939. **
  88940. ** If one side or the other of the AND is known to be false, then instead
  88941. ** of returning an AND expression, just return a constant expression with
  88942. ** a value of false.
  88943. */
  88944. SQLITE_PRIVATE Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
  88945. if( pLeft==0 ){
  88946. return pRight;
  88947. }else if( pRight==0 ){
  88948. return pLeft;
  88949. }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
  88950. sqlite3ExprDelete(db, pLeft);
  88951. sqlite3ExprDelete(db, pRight);
  88952. return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
  88953. }else{
  88954. Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
  88955. sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
  88956. return pNew;
  88957. }
  88958. }
  88959. /*
  88960. ** Construct a new expression node for a function with multiple
  88961. ** arguments.
  88962. */
  88963. SQLITE_PRIVATE Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
  88964. Expr *pNew;
  88965. sqlite3 *db = pParse->db;
  88966. assert( pToken );
  88967. pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
  88968. if( pNew==0 ){
  88969. sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
  88970. return 0;
  88971. }
  88972. pNew->x.pList = pList;
  88973. ExprSetProperty(pNew, EP_HasFunc);
  88974. assert( !ExprHasProperty(pNew, EP_xIsSelect) );
  88975. sqlite3ExprSetHeightAndFlags(pParse, pNew);
  88976. return pNew;
  88977. }
  88978. /*
  88979. ** Assign a variable number to an expression that encodes a wildcard
  88980. ** in the original SQL statement.
  88981. **
  88982. ** Wildcards consisting of a single "?" are assigned the next sequential
  88983. ** variable number.
  88984. **
  88985. ** Wildcards of the form "?nnn" are assigned the number "nnn". We make
  88986. ** sure "nnn" is not too big to avoid a denial of service attack when
  88987. ** the SQL statement comes from an external source.
  88988. **
  88989. ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
  88990. ** as the previous instance of the same wildcard. Or if this is the first
  88991. ** instance of the wildcard, the next sequential variable number is
  88992. ** assigned.
  88993. */
  88994. SQLITE_PRIVATE void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
  88995. sqlite3 *db = pParse->db;
  88996. const char *z;
  88997. ynVar x;
  88998. if( pExpr==0 ) return;
  88999. assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
  89000. z = pExpr->u.zToken;
  89001. assert( z!=0 );
  89002. assert( z[0]!=0 );
  89003. assert( n==(u32)sqlite3Strlen30(z) );
  89004. if( z[1]==0 ){
  89005. /* Wildcard of the form "?". Assign the next variable number */
  89006. assert( z[0]=='?' );
  89007. x = (ynVar)(++pParse->nVar);
  89008. }else{
  89009. int doAdd = 0;
  89010. if( z[0]=='?' ){
  89011. /* Wildcard of the form "?nnn". Convert "nnn" to an integer and
  89012. ** use it as the variable number */
  89013. i64 i;
  89014. int bOk;
  89015. if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
  89016. i = z[1]-'0'; /* The common case of ?N for a single digit N */
  89017. bOk = 1;
  89018. }else{
  89019. bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
  89020. }
  89021. testcase( i==0 );
  89022. testcase( i==1 );
  89023. testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
  89024. testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
  89025. if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
  89026. sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
  89027. db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
  89028. return;
  89029. }
  89030. x = (ynVar)i;
  89031. if( x>pParse->nVar ){
  89032. pParse->nVar = (int)x;
  89033. doAdd = 1;
  89034. }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
  89035. doAdd = 1;
  89036. }
  89037. }else{
  89038. /* Wildcards like ":aaa", "$aaa" or "@aaa". Reuse the same variable
  89039. ** number as the prior appearance of the same name, or if the name
  89040. ** has never appeared before, reuse the same variable number
  89041. */
  89042. x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
  89043. if( x==0 ){
  89044. x = (ynVar)(++pParse->nVar);
  89045. doAdd = 1;
  89046. }
  89047. }
  89048. if( doAdd ){
  89049. pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
  89050. }
  89051. }
  89052. pExpr->iColumn = x;
  89053. if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
  89054. sqlite3ErrorMsg(pParse, "too many SQL variables");
  89055. }
  89056. }
  89057. /*
  89058. ** Recursively delete an expression tree.
  89059. */
  89060. static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
  89061. assert( p!=0 );
  89062. /* Sanity check: Assert that the IntValue is non-negative if it exists */
  89063. assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
  89064. #ifdef SQLITE_DEBUG
  89065. if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
  89066. assert( p->pLeft==0 );
  89067. assert( p->pRight==0 );
  89068. assert( p->x.pSelect==0 );
  89069. }
  89070. #endif
  89071. if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
  89072. /* The Expr.x union is never used at the same time as Expr.pRight */
  89073. assert( p->x.pList==0 || p->pRight==0 );
  89074. if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
  89075. if( p->pRight ){
  89076. sqlite3ExprDeleteNN(db, p->pRight);
  89077. }else if( ExprHasProperty(p, EP_xIsSelect) ){
  89078. sqlite3SelectDelete(db, p->x.pSelect);
  89079. }else{
  89080. sqlite3ExprListDelete(db, p->x.pList);
  89081. }
  89082. }
  89083. if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
  89084. if( !ExprHasProperty(p, EP_Static) ){
  89085. sqlite3DbFreeNN(db, p);
  89086. }
  89087. }
  89088. SQLITE_PRIVATE void sqlite3ExprDelete(sqlite3 *db, Expr *p){
  89089. if( p ) sqlite3ExprDeleteNN(db, p);
  89090. }
  89091. /*
  89092. ** Return the number of bytes allocated for the expression structure
  89093. ** passed as the first argument. This is always one of EXPR_FULLSIZE,
  89094. ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
  89095. */
  89096. static int exprStructSize(Expr *p){
  89097. if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
  89098. if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
  89099. return EXPR_FULLSIZE;
  89100. }
  89101. /*
  89102. ** The dupedExpr*Size() routines each return the number of bytes required
  89103. ** to store a copy of an expression or expression tree. They differ in
  89104. ** how much of the tree is measured.
  89105. **
  89106. ** dupedExprStructSize() Size of only the Expr structure
  89107. ** dupedExprNodeSize() Size of Expr + space for token
  89108. ** dupedExprSize() Expr + token + subtree components
  89109. **
  89110. ***************************************************************************
  89111. **
  89112. ** The dupedExprStructSize() function returns two values OR-ed together:
  89113. ** (1) the space required for a copy of the Expr structure only and
  89114. ** (2) the EP_xxx flags that indicate what the structure size should be.
  89115. ** The return values is always one of:
  89116. **
  89117. ** EXPR_FULLSIZE
  89118. ** EXPR_REDUCEDSIZE | EP_Reduced
  89119. ** EXPR_TOKENONLYSIZE | EP_TokenOnly
  89120. **
  89121. ** The size of the structure can be found by masking the return value
  89122. ** of this routine with 0xfff. The flags can be found by masking the
  89123. ** return value with EP_Reduced|EP_TokenOnly.
  89124. **
  89125. ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
  89126. ** (unreduced) Expr objects as they or originally constructed by the parser.
  89127. ** During expression analysis, extra information is computed and moved into
  89128. ** later parts of teh Expr object and that extra information might get chopped
  89129. ** off if the expression is reduced. Note also that it does not work to
  89130. ** make an EXPRDUP_REDUCE copy of a reduced expression. It is only legal
  89131. ** to reduce a pristine expression tree from the parser. The implementation
  89132. ** of dupedExprStructSize() contain multiple assert() statements that attempt
  89133. ** to enforce this constraint.
  89134. */
  89135. static int dupedExprStructSize(Expr *p, int flags){
  89136. int nSize;
  89137. assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
  89138. assert( EXPR_FULLSIZE<=0xfff );
  89139. assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
  89140. if( 0==flags || p->op==TK_SELECT_COLUMN ){
  89141. nSize = EXPR_FULLSIZE;
  89142. }else{
  89143. assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
  89144. assert( !ExprHasProperty(p, EP_FromJoin) );
  89145. assert( !ExprHasProperty(p, EP_MemToken) );
  89146. assert( !ExprHasProperty(p, EP_NoReduce) );
  89147. if( p->pLeft || p->x.pList ){
  89148. nSize = EXPR_REDUCEDSIZE | EP_Reduced;
  89149. }else{
  89150. assert( p->pRight==0 );
  89151. nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
  89152. }
  89153. }
  89154. return nSize;
  89155. }
  89156. /*
  89157. ** This function returns the space in bytes required to store the copy
  89158. ** of the Expr structure and a copy of the Expr.u.zToken string (if that
  89159. ** string is defined.)
  89160. */
  89161. static int dupedExprNodeSize(Expr *p, int flags){
  89162. int nByte = dupedExprStructSize(p, flags) & 0xfff;
  89163. if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
  89164. nByte += sqlite3Strlen30(p->u.zToken)+1;
  89165. }
  89166. return ROUND8(nByte);
  89167. }
  89168. /*
  89169. ** Return the number of bytes required to create a duplicate of the
  89170. ** expression passed as the first argument. The second argument is a
  89171. ** mask containing EXPRDUP_XXX flags.
  89172. **
  89173. ** The value returned includes space to create a copy of the Expr struct
  89174. ** itself and the buffer referred to by Expr.u.zToken, if any.
  89175. **
  89176. ** If the EXPRDUP_REDUCE flag is set, then the return value includes
  89177. ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
  89178. ** and Expr.pRight variables (but not for any structures pointed to or
  89179. ** descended from the Expr.x.pList or Expr.x.pSelect variables).
  89180. */
  89181. static int dupedExprSize(Expr *p, int flags){
  89182. int nByte = 0;
  89183. if( p ){
  89184. nByte = dupedExprNodeSize(p, flags);
  89185. if( flags&EXPRDUP_REDUCE ){
  89186. nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
  89187. }
  89188. }
  89189. return nByte;
  89190. }
  89191. /*
  89192. ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
  89193. ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
  89194. ** to store the copy of expression p, the copies of p->u.zToken
  89195. ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
  89196. ** if any. Before returning, *pzBuffer is set to the first byte past the
  89197. ** portion of the buffer copied into by this function.
  89198. */
  89199. static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
  89200. Expr *pNew; /* Value to return */
  89201. u8 *zAlloc; /* Memory space from which to build Expr object */
  89202. u32 staticFlag; /* EP_Static if space not obtained from malloc */
  89203. assert( db!=0 );
  89204. assert( p );
  89205. assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
  89206. assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
  89207. /* Figure out where to write the new Expr structure. */
  89208. if( pzBuffer ){
  89209. zAlloc = *pzBuffer;
  89210. staticFlag = EP_Static;
  89211. }else{
  89212. zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
  89213. staticFlag = 0;
  89214. }
  89215. pNew = (Expr *)zAlloc;
  89216. if( pNew ){
  89217. /* Set nNewSize to the size allocated for the structure pointed to
  89218. ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
  89219. ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
  89220. ** by the copy of the p->u.zToken string (if any).
  89221. */
  89222. const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
  89223. const int nNewSize = nStructSize & 0xfff;
  89224. int nToken;
  89225. if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
  89226. nToken = sqlite3Strlen30(p->u.zToken) + 1;
  89227. }else{
  89228. nToken = 0;
  89229. }
  89230. if( dupFlags ){
  89231. assert( ExprHasProperty(p, EP_Reduced)==0 );
  89232. memcpy(zAlloc, p, nNewSize);
  89233. }else{
  89234. u32 nSize = (u32)exprStructSize(p);
  89235. memcpy(zAlloc, p, nSize);
  89236. if( nSize<EXPR_FULLSIZE ){
  89237. memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
  89238. }
  89239. }
  89240. /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
  89241. pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
  89242. pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
  89243. pNew->flags |= staticFlag;
  89244. /* Copy the p->u.zToken string, if any. */
  89245. if( nToken ){
  89246. char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
  89247. memcpy(zToken, p->u.zToken, nToken);
  89248. }
  89249. if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
  89250. /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
  89251. if( ExprHasProperty(p, EP_xIsSelect) ){
  89252. pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
  89253. }else{
  89254. pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
  89255. }
  89256. }
  89257. /* Fill in pNew->pLeft and pNew->pRight. */
  89258. if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
  89259. zAlloc += dupedExprNodeSize(p, dupFlags);
  89260. if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
  89261. pNew->pLeft = p->pLeft ?
  89262. exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
  89263. pNew->pRight = p->pRight ?
  89264. exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
  89265. }
  89266. if( pzBuffer ){
  89267. *pzBuffer = zAlloc;
  89268. }
  89269. }else{
  89270. if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
  89271. if( pNew->op==TK_SELECT_COLUMN ){
  89272. pNew->pLeft = p->pLeft;
  89273. assert( p->iColumn==0 || p->pRight==0 );
  89274. assert( p->pRight==0 || p->pRight==p->pLeft );
  89275. }else{
  89276. pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
  89277. }
  89278. pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
  89279. }
  89280. }
  89281. }
  89282. return pNew;
  89283. }
  89284. /*
  89285. ** Create and return a deep copy of the object passed as the second
  89286. ** argument. If an OOM condition is encountered, NULL is returned
  89287. ** and the db->mallocFailed flag set.
  89288. */
  89289. #ifndef SQLITE_OMIT_CTE
  89290. static With *withDup(sqlite3 *db, With *p){
  89291. With *pRet = 0;
  89292. if( p ){
  89293. int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
  89294. pRet = sqlite3DbMallocZero(db, nByte);
  89295. if( pRet ){
  89296. int i;
  89297. pRet->nCte = p->nCte;
  89298. for(i=0; i<p->nCte; i++){
  89299. pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
  89300. pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
  89301. pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
  89302. }
  89303. }
  89304. }
  89305. return pRet;
  89306. }
  89307. #else
  89308. # define withDup(x,y) 0
  89309. #endif
  89310. /*
  89311. ** The following group of routines make deep copies of expressions,
  89312. ** expression lists, ID lists, and select statements. The copies can
  89313. ** be deleted (by being passed to their respective ...Delete() routines)
  89314. ** without effecting the originals.
  89315. **
  89316. ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
  89317. ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
  89318. ** by subsequent calls to sqlite*ListAppend() routines.
  89319. **
  89320. ** Any tables that the SrcList might point to are not duplicated.
  89321. **
  89322. ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
  89323. ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
  89324. ** truncated version of the usual Expr structure that will be stored as
  89325. ** part of the in-memory representation of the database schema.
  89326. */
  89327. SQLITE_PRIVATE Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
  89328. assert( flags==0 || flags==EXPRDUP_REDUCE );
  89329. return p ? exprDup(db, p, flags, 0) : 0;
  89330. }
  89331. SQLITE_PRIVATE ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
  89332. ExprList *pNew;
  89333. struct ExprList_item *pItem, *pOldItem;
  89334. int i;
  89335. Expr *pPriorSelectCol = 0;
  89336. assert( db!=0 );
  89337. if( p==0 ) return 0;
  89338. pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
  89339. if( pNew==0 ) return 0;
  89340. pNew->nExpr = p->nExpr;
  89341. pItem = pNew->a;
  89342. pOldItem = p->a;
  89343. for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
  89344. Expr *pOldExpr = pOldItem->pExpr;
  89345. Expr *pNewExpr;
  89346. pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
  89347. if( pOldExpr
  89348. && pOldExpr->op==TK_SELECT_COLUMN
  89349. && (pNewExpr = pItem->pExpr)!=0
  89350. ){
  89351. assert( pNewExpr->iColumn==0 || i>0 );
  89352. if( pNewExpr->iColumn==0 ){
  89353. assert( pOldExpr->pLeft==pOldExpr->pRight );
  89354. pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
  89355. }else{
  89356. assert( i>0 );
  89357. assert( pItem[-1].pExpr!=0 );
  89358. assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
  89359. assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
  89360. pNewExpr->pLeft = pPriorSelectCol;
  89361. }
  89362. }
  89363. pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
  89364. pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
  89365. pItem->sortOrder = pOldItem->sortOrder;
  89366. pItem->done = 0;
  89367. pItem->bSpanIsTab = pOldItem->bSpanIsTab;
  89368. pItem->u = pOldItem->u;
  89369. }
  89370. return pNew;
  89371. }
  89372. /*
  89373. ** If cursors, triggers, views and subqueries are all omitted from
  89374. ** the build, then none of the following routines, except for
  89375. ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
  89376. ** called with a NULL argument.
  89377. */
  89378. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
  89379. || !defined(SQLITE_OMIT_SUBQUERY)
  89380. SQLITE_PRIVATE SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
  89381. SrcList *pNew;
  89382. int i;
  89383. int nByte;
  89384. assert( db!=0 );
  89385. if( p==0 ) return 0;
  89386. nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
  89387. pNew = sqlite3DbMallocRawNN(db, nByte );
  89388. if( pNew==0 ) return 0;
  89389. pNew->nSrc = pNew->nAlloc = p->nSrc;
  89390. for(i=0; i<p->nSrc; i++){
  89391. struct SrcList_item *pNewItem = &pNew->a[i];
  89392. struct SrcList_item *pOldItem = &p->a[i];
  89393. Table *pTab;
  89394. pNewItem->pSchema = pOldItem->pSchema;
  89395. pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
  89396. pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
  89397. pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
  89398. pNewItem->fg = pOldItem->fg;
  89399. pNewItem->iCursor = pOldItem->iCursor;
  89400. pNewItem->addrFillSub = pOldItem->addrFillSub;
  89401. pNewItem->regReturn = pOldItem->regReturn;
  89402. if( pNewItem->fg.isIndexedBy ){
  89403. pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
  89404. }
  89405. pNewItem->pIBIndex = pOldItem->pIBIndex;
  89406. if( pNewItem->fg.isTabFunc ){
  89407. pNewItem->u1.pFuncArg =
  89408. sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
  89409. }
  89410. pTab = pNewItem->pTab = pOldItem->pTab;
  89411. if( pTab ){
  89412. pTab->nTabRef++;
  89413. }
  89414. pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
  89415. pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
  89416. pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
  89417. pNewItem->colUsed = pOldItem->colUsed;
  89418. }
  89419. return pNew;
  89420. }
  89421. SQLITE_PRIVATE IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
  89422. IdList *pNew;
  89423. int i;
  89424. assert( db!=0 );
  89425. if( p==0 ) return 0;
  89426. pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
  89427. if( pNew==0 ) return 0;
  89428. pNew->nId = p->nId;
  89429. pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
  89430. if( pNew->a==0 ){
  89431. sqlite3DbFreeNN(db, pNew);
  89432. return 0;
  89433. }
  89434. /* Note that because the size of the allocation for p->a[] is not
  89435. ** necessarily a power of two, sqlite3IdListAppend() may not be called
  89436. ** on the duplicate created by this function. */
  89437. for(i=0; i<p->nId; i++){
  89438. struct IdList_item *pNewItem = &pNew->a[i];
  89439. struct IdList_item *pOldItem = &p->a[i];
  89440. pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
  89441. pNewItem->idx = pOldItem->idx;
  89442. }
  89443. return pNew;
  89444. }
  89445. SQLITE_PRIVATE Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
  89446. Select *pRet = 0;
  89447. Select *pNext = 0;
  89448. Select **pp = &pRet;
  89449. Select *p;
  89450. assert( db!=0 );
  89451. for(p=pDup; p; p=p->pPrior){
  89452. Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
  89453. if( pNew==0 ) break;
  89454. pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
  89455. pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
  89456. pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
  89457. pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
  89458. pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
  89459. pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
  89460. pNew->op = p->op;
  89461. pNew->pNext = pNext;
  89462. pNew->pPrior = 0;
  89463. pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
  89464. pNew->iLimit = 0;
  89465. pNew->iOffset = 0;
  89466. pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
  89467. pNew->addrOpenEphm[0] = -1;
  89468. pNew->addrOpenEphm[1] = -1;
  89469. pNew->nSelectRow = p->nSelectRow;
  89470. pNew->pWith = withDup(db, p->pWith);
  89471. sqlite3SelectSetName(pNew, p->zSelName);
  89472. *pp = pNew;
  89473. pp = &pNew->pPrior;
  89474. pNext = pNew;
  89475. }
  89476. return pRet;
  89477. }
  89478. #else
  89479. SQLITE_PRIVATE Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
  89480. assert( p==0 );
  89481. return 0;
  89482. }
  89483. #endif
  89484. /*
  89485. ** Add a new element to the end of an expression list. If pList is
  89486. ** initially NULL, then create a new expression list.
  89487. **
  89488. ** The pList argument must be either NULL or a pointer to an ExprList
  89489. ** obtained from a prior call to sqlite3ExprListAppend(). This routine
  89490. ** may not be used with an ExprList obtained from sqlite3ExprListDup().
  89491. ** Reason: This routine assumes that the number of slots in pList->a[]
  89492. ** is a power of two. That is true for sqlite3ExprListAppend() returns
  89493. ** but is not necessarily true from the return value of sqlite3ExprListDup().
  89494. **
  89495. ** If a memory allocation error occurs, the entire list is freed and
  89496. ** NULL is returned. If non-NULL is returned, then it is guaranteed
  89497. ** that the new entry was successfully appended.
  89498. */
  89499. SQLITE_PRIVATE ExprList *sqlite3ExprListAppend(
  89500. Parse *pParse, /* Parsing context */
  89501. ExprList *pList, /* List to which to append. Might be NULL */
  89502. Expr *pExpr /* Expression to be appended. Might be NULL */
  89503. ){
  89504. struct ExprList_item *pItem;
  89505. sqlite3 *db = pParse->db;
  89506. assert( db!=0 );
  89507. if( pList==0 ){
  89508. pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
  89509. if( pList==0 ){
  89510. goto no_mem;
  89511. }
  89512. pList->nExpr = 0;
  89513. }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
  89514. ExprList *pNew;
  89515. pNew = sqlite3DbRealloc(db, pList,
  89516. sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
  89517. if( pNew==0 ){
  89518. goto no_mem;
  89519. }
  89520. pList = pNew;
  89521. }
  89522. pItem = &pList->a[pList->nExpr++];
  89523. assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
  89524. assert( offsetof(struct ExprList_item,pExpr)==0 );
  89525. memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
  89526. pItem->pExpr = pExpr;
  89527. return pList;
  89528. no_mem:
  89529. /* Avoid leaking memory if malloc has failed. */
  89530. sqlite3ExprDelete(db, pExpr);
  89531. sqlite3ExprListDelete(db, pList);
  89532. return 0;
  89533. }
  89534. /*
  89535. ** pColumns and pExpr form a vector assignment which is part of the SET
  89536. ** clause of an UPDATE statement. Like this:
  89537. **
  89538. ** (a,b,c) = (expr1,expr2,expr3)
  89539. ** Or: (a,b,c) = (SELECT x,y,z FROM ....)
  89540. **
  89541. ** For each term of the vector assignment, append new entries to the
  89542. ** expression list pList. In the case of a subquery on the RHS, append
  89543. ** TK_SELECT_COLUMN expressions.
  89544. */
  89545. SQLITE_PRIVATE ExprList *sqlite3ExprListAppendVector(
  89546. Parse *pParse, /* Parsing context */
  89547. ExprList *pList, /* List to which to append. Might be NULL */
  89548. IdList *pColumns, /* List of names of LHS of the assignment */
  89549. Expr *pExpr /* Vector expression to be appended. Might be NULL */
  89550. ){
  89551. sqlite3 *db = pParse->db;
  89552. int n;
  89553. int i;
  89554. int iFirst = pList ? pList->nExpr : 0;
  89555. /* pColumns can only be NULL due to an OOM but an OOM will cause an
  89556. ** exit prior to this routine being invoked */
  89557. if( NEVER(pColumns==0) ) goto vector_append_error;
  89558. if( pExpr==0 ) goto vector_append_error;
  89559. /* If the RHS is a vector, then we can immediately check to see that
  89560. ** the size of the RHS and LHS match. But if the RHS is a SELECT,
  89561. ** wildcards ("*") in the result set of the SELECT must be expanded before
  89562. ** we can do the size check, so defer the size check until code generation.
  89563. */
  89564. if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
  89565. sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
  89566. pColumns->nId, n);
  89567. goto vector_append_error;
  89568. }
  89569. for(i=0; i<pColumns->nId; i++){
  89570. Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
  89571. pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
  89572. if( pList ){
  89573. assert( pList->nExpr==iFirst+i+1 );
  89574. pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
  89575. pColumns->a[i].zName = 0;
  89576. }
  89577. }
  89578. if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
  89579. Expr *pFirst = pList->a[iFirst].pExpr;
  89580. assert( pFirst!=0 );
  89581. assert( pFirst->op==TK_SELECT_COLUMN );
  89582. /* Store the SELECT statement in pRight so it will be deleted when
  89583. ** sqlite3ExprListDelete() is called */
  89584. pFirst->pRight = pExpr;
  89585. pExpr = 0;
  89586. /* Remember the size of the LHS in iTable so that we can check that
  89587. ** the RHS and LHS sizes match during code generation. */
  89588. pFirst->iTable = pColumns->nId;
  89589. }
  89590. vector_append_error:
  89591. sqlite3ExprDelete(db, pExpr);
  89592. sqlite3IdListDelete(db, pColumns);
  89593. return pList;
  89594. }
  89595. /*
  89596. ** Set the sort order for the last element on the given ExprList.
  89597. */
  89598. SQLITE_PRIVATE void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
  89599. if( p==0 ) return;
  89600. assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
  89601. assert( p->nExpr>0 );
  89602. if( iSortOrder<0 ){
  89603. assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
  89604. return;
  89605. }
  89606. p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
  89607. }
  89608. /*
  89609. ** Set the ExprList.a[].zName element of the most recently added item
  89610. ** on the expression list.
  89611. **
  89612. ** pList might be NULL following an OOM error. But pName should never be
  89613. ** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
  89614. ** is set.
  89615. */
  89616. SQLITE_PRIVATE void sqlite3ExprListSetName(
  89617. Parse *pParse, /* Parsing context */
  89618. ExprList *pList, /* List to which to add the span. */
  89619. Token *pName, /* Name to be added */
  89620. int dequote /* True to cause the name to be dequoted */
  89621. ){
  89622. assert( pList!=0 || pParse->db->mallocFailed!=0 );
  89623. if( pList ){
  89624. struct ExprList_item *pItem;
  89625. assert( pList->nExpr>0 );
  89626. pItem = &pList->a[pList->nExpr-1];
  89627. assert( pItem->zName==0 );
  89628. pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
  89629. if( dequote ) sqlite3Dequote(pItem->zName);
  89630. }
  89631. }
  89632. /*
  89633. ** Set the ExprList.a[].zSpan element of the most recently added item
  89634. ** on the expression list.
  89635. **
  89636. ** pList might be NULL following an OOM error. But pSpan should never be
  89637. ** NULL. If a memory allocation fails, the pParse->db->mallocFailed flag
  89638. ** is set.
  89639. */
  89640. SQLITE_PRIVATE void sqlite3ExprListSetSpan(
  89641. Parse *pParse, /* Parsing context */
  89642. ExprList *pList, /* List to which to add the span. */
  89643. const char *zStart, /* Start of the span */
  89644. const char *zEnd /* End of the span */
  89645. ){
  89646. sqlite3 *db = pParse->db;
  89647. assert( pList!=0 || db->mallocFailed!=0 );
  89648. if( pList ){
  89649. struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
  89650. assert( pList->nExpr>0 );
  89651. sqlite3DbFree(db, pItem->zSpan);
  89652. pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
  89653. }
  89654. }
  89655. /*
  89656. ** If the expression list pEList contains more than iLimit elements,
  89657. ** leave an error message in pParse.
  89658. */
  89659. SQLITE_PRIVATE void sqlite3ExprListCheckLength(
  89660. Parse *pParse,
  89661. ExprList *pEList,
  89662. const char *zObject
  89663. ){
  89664. int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
  89665. testcase( pEList && pEList->nExpr==mx );
  89666. testcase( pEList && pEList->nExpr==mx+1 );
  89667. if( pEList && pEList->nExpr>mx ){
  89668. sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
  89669. }
  89670. }
  89671. /*
  89672. ** Delete an entire expression list.
  89673. */
  89674. static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
  89675. int i = pList->nExpr;
  89676. struct ExprList_item *pItem = pList->a;
  89677. assert( pList->nExpr>0 );
  89678. do{
  89679. sqlite3ExprDelete(db, pItem->pExpr);
  89680. sqlite3DbFree(db, pItem->zName);
  89681. sqlite3DbFree(db, pItem->zSpan);
  89682. pItem++;
  89683. }while( --i>0 );
  89684. sqlite3DbFreeNN(db, pList);
  89685. }
  89686. SQLITE_PRIVATE void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
  89687. if( pList ) exprListDeleteNN(db, pList);
  89688. }
  89689. /*
  89690. ** Return the bitwise-OR of all Expr.flags fields in the given
  89691. ** ExprList.
  89692. */
  89693. SQLITE_PRIVATE u32 sqlite3ExprListFlags(const ExprList *pList){
  89694. int i;
  89695. u32 m = 0;
  89696. assert( pList!=0 );
  89697. for(i=0; i<pList->nExpr; i++){
  89698. Expr *pExpr = pList->a[i].pExpr;
  89699. assert( pExpr!=0 );
  89700. m |= pExpr->flags;
  89701. }
  89702. return m;
  89703. }
  89704. /*
  89705. ** This is a SELECT-node callback for the expression walker that
  89706. ** always "fails". By "fail" in this case, we mean set
  89707. ** pWalker->eCode to zero and abort.
  89708. **
  89709. ** This callback is used by multiple expression walkers.
  89710. */
  89711. SQLITE_PRIVATE int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
  89712. UNUSED_PARAMETER(NotUsed);
  89713. pWalker->eCode = 0;
  89714. return WRC_Abort;
  89715. }
  89716. /*
  89717. ** If the input expression is an ID with the name "true" or "false"
  89718. ** then convert it into an TK_TRUEFALSE term. Return non-zero if
  89719. ** the conversion happened, and zero if the expression is unaltered.
  89720. */
  89721. SQLITE_PRIVATE int sqlite3ExprIdToTrueFalse(Expr *pExpr){
  89722. assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
  89723. if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
  89724. || sqlite3StrICmp(pExpr->u.zToken, "false")==0
  89725. ){
  89726. pExpr->op = TK_TRUEFALSE;
  89727. return 1;
  89728. }
  89729. return 0;
  89730. }
  89731. /*
  89732. ** The argument must be a TK_TRUEFALSE Expr node. Return 1 if it is TRUE
  89733. ** and 0 if it is FALSE.
  89734. */
  89735. SQLITE_PRIVATE int sqlite3ExprTruthValue(const Expr *pExpr){
  89736. assert( pExpr->op==TK_TRUEFALSE );
  89737. assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
  89738. || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
  89739. return pExpr->u.zToken[4]==0;
  89740. }
  89741. /*
  89742. ** These routines are Walker callbacks used to check expressions to
  89743. ** see if they are "constant" for some definition of constant. The
  89744. ** Walker.eCode value determines the type of "constant" we are looking
  89745. ** for.
  89746. **
  89747. ** These callback routines are used to implement the following:
  89748. **
  89749. ** sqlite3ExprIsConstant() pWalker->eCode==1
  89750. ** sqlite3ExprIsConstantNotJoin() pWalker->eCode==2
  89751. ** sqlite3ExprIsTableConstant() pWalker->eCode==3
  89752. ** sqlite3ExprIsConstantOrFunction() pWalker->eCode==4 or 5
  89753. **
  89754. ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
  89755. ** is found to not be a constant.
  89756. **
  89757. ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
  89758. ** in a CREATE TABLE statement. The Walker.eCode value is 5 when parsing
  89759. ** an existing schema and 4 when processing a new statement. A bound
  89760. ** parameter raises an error for new statements, but is silently converted
  89761. ** to NULL for existing schemas. This allows sqlite_master tables that
  89762. ** contain a bound parameter because they were generated by older versions
  89763. ** of SQLite to be parsed by newer versions of SQLite without raising a
  89764. ** malformed schema error.
  89765. */
  89766. static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
  89767. /* If pWalker->eCode is 2 then any term of the expression that comes from
  89768. ** the ON or USING clauses of a left join disqualifies the expression
  89769. ** from being considered constant. */
  89770. if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
  89771. pWalker->eCode = 0;
  89772. return WRC_Abort;
  89773. }
  89774. switch( pExpr->op ){
  89775. /* Consider functions to be constant if all their arguments are constant
  89776. ** and either pWalker->eCode==4 or 5 or the function has the
  89777. ** SQLITE_FUNC_CONST flag. */
  89778. case TK_FUNCTION:
  89779. if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
  89780. return WRC_Continue;
  89781. }else{
  89782. pWalker->eCode = 0;
  89783. return WRC_Abort;
  89784. }
  89785. case TK_ID:
  89786. /* Convert "true" or "false" in a DEFAULT clause into the
  89787. ** appropriate TK_TRUEFALSE operator */
  89788. if( sqlite3ExprIdToTrueFalse(pExpr) ){
  89789. return WRC_Prune;
  89790. }
  89791. /* Fall thru */
  89792. case TK_COLUMN:
  89793. case TK_AGG_FUNCTION:
  89794. case TK_AGG_COLUMN:
  89795. testcase( pExpr->op==TK_ID );
  89796. testcase( pExpr->op==TK_COLUMN );
  89797. testcase( pExpr->op==TK_AGG_FUNCTION );
  89798. testcase( pExpr->op==TK_AGG_COLUMN );
  89799. if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
  89800. return WRC_Continue;
  89801. }
  89802. /* Fall through */
  89803. case TK_IF_NULL_ROW:
  89804. testcase( pExpr->op==TK_IF_NULL_ROW );
  89805. pWalker->eCode = 0;
  89806. return WRC_Abort;
  89807. case TK_VARIABLE:
  89808. if( pWalker->eCode==5 ){
  89809. /* Silently convert bound parameters that appear inside of CREATE
  89810. ** statements into a NULL when parsing the CREATE statement text out
  89811. ** of the sqlite_master table */
  89812. pExpr->op = TK_NULL;
  89813. }else if( pWalker->eCode==4 ){
  89814. /* A bound parameter in a CREATE statement that originates from
  89815. ** sqlite3_prepare() causes an error */
  89816. pWalker->eCode = 0;
  89817. return WRC_Abort;
  89818. }
  89819. /* Fall through */
  89820. default:
  89821. testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail will disallow */
  89822. testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail will disallow */
  89823. return WRC_Continue;
  89824. }
  89825. }
  89826. static int exprIsConst(Expr *p, int initFlag, int iCur){
  89827. Walker w;
  89828. w.eCode = initFlag;
  89829. w.xExprCallback = exprNodeIsConstant;
  89830. w.xSelectCallback = sqlite3SelectWalkFail;
  89831. #ifdef SQLITE_DEBUG
  89832. w.xSelectCallback2 = sqlite3SelectWalkAssert2;
  89833. #endif
  89834. w.u.iCur = iCur;
  89835. sqlite3WalkExpr(&w, p);
  89836. return w.eCode;
  89837. }
  89838. /*
  89839. ** Walk an expression tree. Return non-zero if the expression is constant
  89840. ** and 0 if it involves variables or function calls.
  89841. **
  89842. ** For the purposes of this function, a double-quoted string (ex: "abc")
  89843. ** is considered a variable but a single-quoted string (ex: 'abc') is
  89844. ** a constant.
  89845. */
  89846. SQLITE_PRIVATE int sqlite3ExprIsConstant(Expr *p){
  89847. return exprIsConst(p, 1, 0);
  89848. }
  89849. /*
  89850. ** Walk an expression tree. Return non-zero if the expression is constant
  89851. ** that does no originate from the ON or USING clauses of a join.
  89852. ** Return 0 if it involves variables or function calls or terms from
  89853. ** an ON or USING clause.
  89854. */
  89855. SQLITE_PRIVATE int sqlite3ExprIsConstantNotJoin(Expr *p){
  89856. return exprIsConst(p, 2, 0);
  89857. }
  89858. /*
  89859. ** Walk an expression tree. Return non-zero if the expression is constant
  89860. ** for any single row of the table with cursor iCur. In other words, the
  89861. ** expression must not refer to any non-deterministic function nor any
  89862. ** table other than iCur.
  89863. */
  89864. SQLITE_PRIVATE int sqlite3ExprIsTableConstant(Expr *p, int iCur){
  89865. return exprIsConst(p, 3, iCur);
  89866. }
  89867. /*
  89868. ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
  89869. */
  89870. static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
  89871. ExprList *pGroupBy = pWalker->u.pGroupBy;
  89872. int i;
  89873. /* Check if pExpr is identical to any GROUP BY term. If so, consider
  89874. ** it constant. */
  89875. for(i=0; i<pGroupBy->nExpr; i++){
  89876. Expr *p = pGroupBy->a[i].pExpr;
  89877. if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
  89878. CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
  89879. if( sqlite3_stricmp("BINARY", pColl->zName)==0 ){
  89880. return WRC_Prune;
  89881. }
  89882. }
  89883. }
  89884. /* Check if pExpr is a sub-select. If so, consider it variable. */
  89885. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  89886. pWalker->eCode = 0;
  89887. return WRC_Abort;
  89888. }
  89889. return exprNodeIsConstant(pWalker, pExpr);
  89890. }
  89891. /*
  89892. ** Walk the expression tree passed as the first argument. Return non-zero
  89893. ** if the expression consists entirely of constants or copies of terms
  89894. ** in pGroupBy that sort with the BINARY collation sequence.
  89895. **
  89896. ** This routine is used to determine if a term of the HAVING clause can
  89897. ** be promoted into the WHERE clause. In order for such a promotion to work,
  89898. ** the value of the HAVING clause term must be the same for all members of
  89899. ** a "group". The requirement that the GROUP BY term must be BINARY
  89900. ** assumes that no other collating sequence will have a finer-grained
  89901. ** grouping than binary. In other words (A=B COLLATE binary) implies
  89902. ** A=B in every other collating sequence. The requirement that the
  89903. ** GROUP BY be BINARY is stricter than necessary. It would also work
  89904. ** to promote HAVING clauses that use the same alternative collating
  89905. ** sequence as the GROUP BY term, but that is much harder to check,
  89906. ** alternative collating sequences are uncommon, and this is only an
  89907. ** optimization, so we take the easy way out and simply require the
  89908. ** GROUP BY to use the BINARY collating sequence.
  89909. */
  89910. SQLITE_PRIVATE int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
  89911. Walker w;
  89912. w.eCode = 1;
  89913. w.xExprCallback = exprNodeIsConstantOrGroupBy;
  89914. w.xSelectCallback = 0;
  89915. w.u.pGroupBy = pGroupBy;
  89916. w.pParse = pParse;
  89917. sqlite3WalkExpr(&w, p);
  89918. return w.eCode;
  89919. }
  89920. /*
  89921. ** Walk an expression tree. Return non-zero if the expression is constant
  89922. ** or a function call with constant arguments. Return and 0 if there
  89923. ** are any variables.
  89924. **
  89925. ** For the purposes of this function, a double-quoted string (ex: "abc")
  89926. ** is considered a variable but a single-quoted string (ex: 'abc') is
  89927. ** a constant.
  89928. */
  89929. SQLITE_PRIVATE int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
  89930. assert( isInit==0 || isInit==1 );
  89931. return exprIsConst(p, 4+isInit, 0);
  89932. }
  89933. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  89934. /*
  89935. ** Walk an expression tree. Return 1 if the expression contains a
  89936. ** subquery of some kind. Return 0 if there are no subqueries.
  89937. */
  89938. SQLITE_PRIVATE int sqlite3ExprContainsSubquery(Expr *p){
  89939. Walker w;
  89940. w.eCode = 1;
  89941. w.xExprCallback = sqlite3ExprWalkNoop;
  89942. w.xSelectCallback = sqlite3SelectWalkFail;
  89943. #ifdef SQLITE_DEBUG
  89944. w.xSelectCallback2 = sqlite3SelectWalkAssert2;
  89945. #endif
  89946. sqlite3WalkExpr(&w, p);
  89947. return w.eCode==0;
  89948. }
  89949. #endif
  89950. /*
  89951. ** If the expression p codes a constant integer that is small enough
  89952. ** to fit in a 32-bit integer, return 1 and put the value of the integer
  89953. ** in *pValue. If the expression is not an integer or if it is too big
  89954. ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
  89955. */
  89956. SQLITE_PRIVATE int sqlite3ExprIsInteger(Expr *p, int *pValue){
  89957. int rc = 0;
  89958. if( p==0 ) return 0; /* Can only happen following on OOM */
  89959. /* If an expression is an integer literal that fits in a signed 32-bit
  89960. ** integer, then the EP_IntValue flag will have already been set */
  89961. assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
  89962. || sqlite3GetInt32(p->u.zToken, &rc)==0 );
  89963. if( p->flags & EP_IntValue ){
  89964. *pValue = p->u.iValue;
  89965. return 1;
  89966. }
  89967. switch( p->op ){
  89968. case TK_UPLUS: {
  89969. rc = sqlite3ExprIsInteger(p->pLeft, pValue);
  89970. break;
  89971. }
  89972. case TK_UMINUS: {
  89973. int v;
  89974. if( sqlite3ExprIsInteger(p->pLeft, &v) ){
  89975. assert( v!=(-2147483647-1) );
  89976. *pValue = -v;
  89977. rc = 1;
  89978. }
  89979. break;
  89980. }
  89981. default: break;
  89982. }
  89983. return rc;
  89984. }
  89985. /*
  89986. ** Return FALSE if there is no chance that the expression can be NULL.
  89987. **
  89988. ** If the expression might be NULL or if the expression is too complex
  89989. ** to tell return TRUE.
  89990. **
  89991. ** This routine is used as an optimization, to skip OP_IsNull opcodes
  89992. ** when we know that a value cannot be NULL. Hence, a false positive
  89993. ** (returning TRUE when in fact the expression can never be NULL) might
  89994. ** be a small performance hit but is otherwise harmless. On the other
  89995. ** hand, a false negative (returning FALSE when the result could be NULL)
  89996. ** will likely result in an incorrect answer. So when in doubt, return
  89997. ** TRUE.
  89998. */
  89999. SQLITE_PRIVATE int sqlite3ExprCanBeNull(const Expr *p){
  90000. u8 op;
  90001. while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
  90002. op = p->op;
  90003. if( op==TK_REGISTER ) op = p->op2;
  90004. switch( op ){
  90005. case TK_INTEGER:
  90006. case TK_STRING:
  90007. case TK_FLOAT:
  90008. case TK_BLOB:
  90009. return 0;
  90010. case TK_COLUMN:
  90011. return ExprHasProperty(p, EP_CanBeNull) ||
  90012. p->pTab==0 || /* Reference to column of index on expression */
  90013. (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
  90014. default:
  90015. return 1;
  90016. }
  90017. }
  90018. /*
  90019. ** Return TRUE if the given expression is a constant which would be
  90020. ** unchanged by OP_Affinity with the affinity given in the second
  90021. ** argument.
  90022. **
  90023. ** This routine is used to determine if the OP_Affinity operation
  90024. ** can be omitted. When in doubt return FALSE. A false negative
  90025. ** is harmless. A false positive, however, can result in the wrong
  90026. ** answer.
  90027. */
  90028. SQLITE_PRIVATE int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
  90029. u8 op;
  90030. if( aff==SQLITE_AFF_BLOB ) return 1;
  90031. while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
  90032. op = p->op;
  90033. if( op==TK_REGISTER ) op = p->op2;
  90034. switch( op ){
  90035. case TK_INTEGER: {
  90036. return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
  90037. }
  90038. case TK_FLOAT: {
  90039. return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
  90040. }
  90041. case TK_STRING: {
  90042. return aff==SQLITE_AFF_TEXT;
  90043. }
  90044. case TK_BLOB: {
  90045. return 1;
  90046. }
  90047. case TK_COLUMN: {
  90048. assert( p->iTable>=0 ); /* p cannot be part of a CHECK constraint */
  90049. return p->iColumn<0
  90050. && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
  90051. }
  90052. default: {
  90053. return 0;
  90054. }
  90055. }
  90056. }
  90057. /*
  90058. ** Return TRUE if the given string is a row-id column name.
  90059. */
  90060. SQLITE_PRIVATE int sqlite3IsRowid(const char *z){
  90061. if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
  90062. if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
  90063. if( sqlite3StrICmp(z, "OID")==0 ) return 1;
  90064. return 0;
  90065. }
  90066. /*
  90067. ** pX is the RHS of an IN operator. If pX is a SELECT statement
  90068. ** that can be simplified to a direct table access, then return
  90069. ** a pointer to the SELECT statement. If pX is not a SELECT statement,
  90070. ** or if the SELECT statement needs to be manifested into a transient
  90071. ** table, then return NULL.
  90072. */
  90073. #ifndef SQLITE_OMIT_SUBQUERY
  90074. static Select *isCandidateForInOpt(Expr *pX){
  90075. Select *p;
  90076. SrcList *pSrc;
  90077. ExprList *pEList;
  90078. Table *pTab;
  90079. int i;
  90080. if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0; /* Not a subquery */
  90081. if( ExprHasProperty(pX, EP_VarSelect) ) return 0; /* Correlated subq */
  90082. p = pX->x.pSelect;
  90083. if( p->pPrior ) return 0; /* Not a compound SELECT */
  90084. if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
  90085. testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
  90086. testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
  90087. return 0; /* No DISTINCT keyword and no aggregate functions */
  90088. }
  90089. assert( p->pGroupBy==0 ); /* Has no GROUP BY clause */
  90090. if( p->pLimit ) return 0; /* Has no LIMIT clause */
  90091. if( p->pWhere ) return 0; /* Has no WHERE clause */
  90092. pSrc = p->pSrc;
  90093. assert( pSrc!=0 );
  90094. if( pSrc->nSrc!=1 ) return 0; /* Single term in FROM clause */
  90095. if( pSrc->a[0].pSelect ) return 0; /* FROM is not a subquery or view */
  90096. pTab = pSrc->a[0].pTab;
  90097. assert( pTab!=0 );
  90098. assert( pTab->pSelect==0 ); /* FROM clause is not a view */
  90099. if( IsVirtual(pTab) ) return 0; /* FROM clause not a virtual table */
  90100. pEList = p->pEList;
  90101. assert( pEList!=0 );
  90102. /* All SELECT results must be columns. */
  90103. for(i=0; i<pEList->nExpr; i++){
  90104. Expr *pRes = pEList->a[i].pExpr;
  90105. if( pRes->op!=TK_COLUMN ) return 0;
  90106. assert( pRes->iTable==pSrc->a[0].iCursor ); /* Not a correlated subquery */
  90107. }
  90108. return p;
  90109. }
  90110. #endif /* SQLITE_OMIT_SUBQUERY */
  90111. #ifndef SQLITE_OMIT_SUBQUERY
  90112. /*
  90113. ** Generate code that checks the left-most column of index table iCur to see if
  90114. ** it contains any NULL entries. Cause the register at regHasNull to be set
  90115. ** to a non-NULL value if iCur contains no NULLs. Cause register regHasNull
  90116. ** to be set to NULL if iCur contains one or more NULL values.
  90117. */
  90118. static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
  90119. int addr1;
  90120. sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
  90121. addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
  90122. sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
  90123. sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
  90124. VdbeComment((v, "first_entry_in(%d)", iCur));
  90125. sqlite3VdbeJumpHere(v, addr1);
  90126. }
  90127. #endif
  90128. #ifndef SQLITE_OMIT_SUBQUERY
  90129. /*
  90130. ** The argument is an IN operator with a list (not a subquery) on the
  90131. ** right-hand side. Return TRUE if that list is constant.
  90132. */
  90133. static int sqlite3InRhsIsConstant(Expr *pIn){
  90134. Expr *pLHS;
  90135. int res;
  90136. assert( !ExprHasProperty(pIn, EP_xIsSelect) );
  90137. pLHS = pIn->pLeft;
  90138. pIn->pLeft = 0;
  90139. res = sqlite3ExprIsConstant(pIn);
  90140. pIn->pLeft = pLHS;
  90141. return res;
  90142. }
  90143. #endif
  90144. /*
  90145. ** This function is used by the implementation of the IN (...) operator.
  90146. ** The pX parameter is the expression on the RHS of the IN operator, which
  90147. ** might be either a list of expressions or a subquery.
  90148. **
  90149. ** The job of this routine is to find or create a b-tree object that can
  90150. ** be used either to test for membership in the RHS set or to iterate through
  90151. ** all members of the RHS set, skipping duplicates.
  90152. **
  90153. ** A cursor is opened on the b-tree object that is the RHS of the IN operator
  90154. ** and pX->iTable is set to the index of that cursor.
  90155. **
  90156. ** The returned value of this function indicates the b-tree type, as follows:
  90157. **
  90158. ** IN_INDEX_ROWID - The cursor was opened on a database table.
  90159. ** IN_INDEX_INDEX_ASC - The cursor was opened on an ascending index.
  90160. ** IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
  90161. ** IN_INDEX_EPH - The cursor was opened on a specially created and
  90162. ** populated epheremal table.
  90163. ** IN_INDEX_NOOP - No cursor was allocated. The IN operator must be
  90164. ** implemented as a sequence of comparisons.
  90165. **
  90166. ** An existing b-tree might be used if the RHS expression pX is a simple
  90167. ** subquery such as:
  90168. **
  90169. ** SELECT <column1>, <column2>... FROM <table>
  90170. **
  90171. ** If the RHS of the IN operator is a list or a more complex subquery, then
  90172. ** an ephemeral table might need to be generated from the RHS and then
  90173. ** pX->iTable made to point to the ephemeral table instead of an
  90174. ** existing table.
  90175. **
  90176. ** The inFlags parameter must contain, at a minimum, one of the bits
  90177. ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both. If inFlags contains
  90178. ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
  90179. ** membership test. When the IN_INDEX_LOOP bit is set, the IN index will
  90180. ** be used to loop over all values of the RHS of the IN operator.
  90181. **
  90182. ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
  90183. ** through the set members) then the b-tree must not contain duplicates.
  90184. ** An epheremal table will be created unless the selected columns are guaranteed
  90185. ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
  90186. ** a UNIQUE constraint or index.
  90187. **
  90188. ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
  90189. ** for fast set membership tests) then an epheremal table must
  90190. ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
  90191. ** index can be found with the specified <columns> as its left-most.
  90192. **
  90193. ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
  90194. ** if the RHS of the IN operator is a list (not a subquery) then this
  90195. ** routine might decide that creating an ephemeral b-tree for membership
  90196. ** testing is too expensive and return IN_INDEX_NOOP. In that case, the
  90197. ** calling routine should implement the IN operator using a sequence
  90198. ** of Eq or Ne comparison operations.
  90199. **
  90200. ** When the b-tree is being used for membership tests, the calling function
  90201. ** might need to know whether or not the RHS side of the IN operator
  90202. ** contains a NULL. If prRhsHasNull is not a NULL pointer and
  90203. ** if there is any chance that the (...) might contain a NULL value at
  90204. ** runtime, then a register is allocated and the register number written
  90205. ** to *prRhsHasNull. If there is no chance that the (...) contains a
  90206. ** NULL value, then *prRhsHasNull is left unchanged.
  90207. **
  90208. ** If a register is allocated and its location stored in *prRhsHasNull, then
  90209. ** the value in that register will be NULL if the b-tree contains one or more
  90210. ** NULL values, and it will be some non-NULL value if the b-tree contains no
  90211. ** NULL values.
  90212. **
  90213. ** If the aiMap parameter is not NULL, it must point to an array containing
  90214. ** one element for each column returned by the SELECT statement on the RHS
  90215. ** of the IN(...) operator. The i'th entry of the array is populated with the
  90216. ** offset of the index column that matches the i'th column returned by the
  90217. ** SELECT. For example, if the expression and selected index are:
  90218. **
  90219. ** (?,?,?) IN (SELECT a, b, c FROM t1)
  90220. ** CREATE INDEX i1 ON t1(b, c, a);
  90221. **
  90222. ** then aiMap[] is populated with {2, 0, 1}.
  90223. */
  90224. #ifndef SQLITE_OMIT_SUBQUERY
  90225. SQLITE_PRIVATE int sqlite3FindInIndex(
  90226. Parse *pParse, /* Parsing context */
  90227. Expr *pX, /* The right-hand side (RHS) of the IN operator */
  90228. u32 inFlags, /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
  90229. int *prRhsHasNull, /* Register holding NULL status. See notes */
  90230. int *aiMap /* Mapping from Index fields to RHS fields */
  90231. ){
  90232. Select *p; /* SELECT to the right of IN operator */
  90233. int eType = 0; /* Type of RHS table. IN_INDEX_* */
  90234. int iTab = pParse->nTab++; /* Cursor of the RHS table */
  90235. int mustBeUnique; /* True if RHS must be unique */
  90236. Vdbe *v = sqlite3GetVdbe(pParse); /* Virtual machine being coded */
  90237. assert( pX->op==TK_IN );
  90238. mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
  90239. /* If the RHS of this IN(...) operator is a SELECT, and if it matters
  90240. ** whether or not the SELECT result contains NULL values, check whether
  90241. ** or not NULL is actually possible (it may not be, for example, due
  90242. ** to NOT NULL constraints in the schema). If no NULL values are possible,
  90243. ** set prRhsHasNull to 0 before continuing. */
  90244. if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
  90245. int i;
  90246. ExprList *pEList = pX->x.pSelect->pEList;
  90247. for(i=0; i<pEList->nExpr; i++){
  90248. if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
  90249. }
  90250. if( i==pEList->nExpr ){
  90251. prRhsHasNull = 0;
  90252. }
  90253. }
  90254. /* Check to see if an existing table or index can be used to
  90255. ** satisfy the query. This is preferable to generating a new
  90256. ** ephemeral table. */
  90257. if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
  90258. sqlite3 *db = pParse->db; /* Database connection */
  90259. Table *pTab; /* Table <table>. */
  90260. i16 iDb; /* Database idx for pTab */
  90261. ExprList *pEList = p->pEList;
  90262. int nExpr = pEList->nExpr;
  90263. assert( p->pEList!=0 ); /* Because of isCandidateForInOpt(p) */
  90264. assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
  90265. assert( p->pSrc!=0 ); /* Because of isCandidateForInOpt(p) */
  90266. pTab = p->pSrc->a[0].pTab;
  90267. /* Code an OP_Transaction and OP_TableLock for <table>. */
  90268. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  90269. sqlite3CodeVerifySchema(pParse, iDb);
  90270. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  90271. assert(v); /* sqlite3GetVdbe() has always been previously called */
  90272. if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
  90273. /* The "x IN (SELECT rowid FROM table)" case */
  90274. int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
  90275. VdbeCoverage(v);
  90276. sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
  90277. eType = IN_INDEX_ROWID;
  90278. sqlite3VdbeJumpHere(v, iAddr);
  90279. }else{
  90280. Index *pIdx; /* Iterator variable */
  90281. int affinity_ok = 1;
  90282. int i;
  90283. /* Check that the affinity that will be used to perform each
  90284. ** comparison is the same as the affinity of each column in table
  90285. ** on the RHS of the IN operator. If it not, it is not possible to
  90286. ** use any index of the RHS table. */
  90287. for(i=0; i<nExpr && affinity_ok; i++){
  90288. Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
  90289. int iCol = pEList->a[i].pExpr->iColumn;
  90290. char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
  90291. char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
  90292. testcase( cmpaff==SQLITE_AFF_BLOB );
  90293. testcase( cmpaff==SQLITE_AFF_TEXT );
  90294. switch( cmpaff ){
  90295. case SQLITE_AFF_BLOB:
  90296. break;
  90297. case SQLITE_AFF_TEXT:
  90298. /* sqlite3CompareAffinity() only returns TEXT if one side or the
  90299. ** other has no affinity and the other side is TEXT. Hence,
  90300. ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
  90301. ** and for the term on the LHS of the IN to have no affinity. */
  90302. assert( idxaff==SQLITE_AFF_TEXT );
  90303. break;
  90304. default:
  90305. affinity_ok = sqlite3IsNumericAffinity(idxaff);
  90306. }
  90307. }
  90308. if( affinity_ok ){
  90309. /* Search for an existing index that will work for this IN operator */
  90310. for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
  90311. Bitmask colUsed; /* Columns of the index used */
  90312. Bitmask mCol; /* Mask for the current column */
  90313. if( pIdx->nColumn<nExpr ) continue;
  90314. /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
  90315. ** BITMASK(nExpr) without overflowing */
  90316. testcase( pIdx->nColumn==BMS-2 );
  90317. testcase( pIdx->nColumn==BMS-1 );
  90318. if( pIdx->nColumn>=BMS-1 ) continue;
  90319. if( mustBeUnique ){
  90320. if( pIdx->nKeyCol>nExpr
  90321. ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
  90322. ){
  90323. continue; /* This index is not unique over the IN RHS columns */
  90324. }
  90325. }
  90326. colUsed = 0; /* Columns of index used so far */
  90327. for(i=0; i<nExpr; i++){
  90328. Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
  90329. Expr *pRhs = pEList->a[i].pExpr;
  90330. CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
  90331. int j;
  90332. assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
  90333. for(j=0; j<nExpr; j++){
  90334. if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
  90335. assert( pIdx->azColl[j] );
  90336. if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
  90337. continue;
  90338. }
  90339. break;
  90340. }
  90341. if( j==nExpr ) break;
  90342. mCol = MASKBIT(j);
  90343. if( mCol & colUsed ) break; /* Each column used only once */
  90344. colUsed |= mCol;
  90345. if( aiMap ) aiMap[i] = j;
  90346. }
  90347. assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
  90348. if( colUsed==(MASKBIT(nExpr)-1) ){
  90349. /* If we reach this point, that means the index pIdx is usable */
  90350. int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  90351. #ifndef SQLITE_OMIT_EXPLAIN
  90352. sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
  90353. sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
  90354. P4_DYNAMIC);
  90355. #endif
  90356. sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
  90357. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  90358. VdbeComment((v, "%s", pIdx->zName));
  90359. assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
  90360. eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
  90361. if( prRhsHasNull ){
  90362. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  90363. i64 mask = (1<<nExpr)-1;
  90364. sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
  90365. iTab, 0, 0, (u8*)&mask, P4_INT64);
  90366. #endif
  90367. *prRhsHasNull = ++pParse->nMem;
  90368. if( nExpr==1 ){
  90369. sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
  90370. }
  90371. }
  90372. sqlite3VdbeJumpHere(v, iAddr);
  90373. }
  90374. } /* End loop over indexes */
  90375. } /* End if( affinity_ok ) */
  90376. } /* End if not an rowid index */
  90377. } /* End attempt to optimize using an index */
  90378. /* If no preexisting index is available for the IN clause
  90379. ** and IN_INDEX_NOOP is an allowed reply
  90380. ** and the RHS of the IN operator is a list, not a subquery
  90381. ** and the RHS is not constant or has two or fewer terms,
  90382. ** then it is not worth creating an ephemeral table to evaluate
  90383. ** the IN operator so return IN_INDEX_NOOP.
  90384. */
  90385. if( eType==0
  90386. && (inFlags & IN_INDEX_NOOP_OK)
  90387. && !ExprHasProperty(pX, EP_xIsSelect)
  90388. && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
  90389. ){
  90390. eType = IN_INDEX_NOOP;
  90391. }
  90392. if( eType==0 ){
  90393. /* Could not find an existing table or index to use as the RHS b-tree.
  90394. ** We will have to generate an ephemeral table to do the job.
  90395. */
  90396. u32 savedNQueryLoop = pParse->nQueryLoop;
  90397. int rMayHaveNull = 0;
  90398. eType = IN_INDEX_EPH;
  90399. if( inFlags & IN_INDEX_LOOP ){
  90400. pParse->nQueryLoop = 0;
  90401. if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
  90402. eType = IN_INDEX_ROWID;
  90403. }
  90404. }else if( prRhsHasNull ){
  90405. *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
  90406. }
  90407. sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
  90408. pParse->nQueryLoop = savedNQueryLoop;
  90409. }else{
  90410. pX->iTable = iTab;
  90411. }
  90412. if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
  90413. int i, n;
  90414. n = sqlite3ExprVectorSize(pX->pLeft);
  90415. for(i=0; i<n; i++) aiMap[i] = i;
  90416. }
  90417. return eType;
  90418. }
  90419. #endif
  90420. #ifndef SQLITE_OMIT_SUBQUERY
  90421. /*
  90422. ** Argument pExpr is an (?, ?...) IN(...) expression. This
  90423. ** function allocates and returns a nul-terminated string containing
  90424. ** the affinities to be used for each column of the comparison.
  90425. **
  90426. ** It is the responsibility of the caller to ensure that the returned
  90427. ** string is eventually freed using sqlite3DbFree().
  90428. */
  90429. static char *exprINAffinity(Parse *pParse, Expr *pExpr){
  90430. Expr *pLeft = pExpr->pLeft;
  90431. int nVal = sqlite3ExprVectorSize(pLeft);
  90432. Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
  90433. char *zRet;
  90434. assert( pExpr->op==TK_IN );
  90435. zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
  90436. if( zRet ){
  90437. int i;
  90438. for(i=0; i<nVal; i++){
  90439. Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
  90440. char a = sqlite3ExprAffinity(pA);
  90441. if( pSelect ){
  90442. zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
  90443. }else{
  90444. zRet[i] = a;
  90445. }
  90446. }
  90447. zRet[nVal] = '\0';
  90448. }
  90449. return zRet;
  90450. }
  90451. #endif
  90452. #ifndef SQLITE_OMIT_SUBQUERY
  90453. /*
  90454. ** Load the Parse object passed as the first argument with an error
  90455. ** message of the form:
  90456. **
  90457. ** "sub-select returns N columns - expected M"
  90458. */
  90459. SQLITE_PRIVATE void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
  90460. const char *zFmt = "sub-select returns %d columns - expected %d";
  90461. sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
  90462. }
  90463. #endif
  90464. /*
  90465. ** Expression pExpr is a vector that has been used in a context where
  90466. ** it is not permitted. If pExpr is a sub-select vector, this routine
  90467. ** loads the Parse object with a message of the form:
  90468. **
  90469. ** "sub-select returns N columns - expected 1"
  90470. **
  90471. ** Or, if it is a regular scalar vector:
  90472. **
  90473. ** "row value misused"
  90474. */
  90475. SQLITE_PRIVATE void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
  90476. #ifndef SQLITE_OMIT_SUBQUERY
  90477. if( pExpr->flags & EP_xIsSelect ){
  90478. sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
  90479. }else
  90480. #endif
  90481. {
  90482. sqlite3ErrorMsg(pParse, "row value misused");
  90483. }
  90484. }
  90485. /*
  90486. ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
  90487. ** or IN operators. Examples:
  90488. **
  90489. ** (SELECT a FROM b) -- subquery
  90490. ** EXISTS (SELECT a FROM b) -- EXISTS subquery
  90491. ** x IN (4,5,11) -- IN operator with list on right-hand side
  90492. ** x IN (SELECT a FROM b) -- IN operator with subquery on the right
  90493. **
  90494. ** The pExpr parameter describes the expression that contains the IN
  90495. ** operator or subquery.
  90496. **
  90497. ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
  90498. ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
  90499. ** to some integer key column of a table B-Tree. In this case, use an
  90500. ** intkey B-Tree to store the set of IN(...) values instead of the usual
  90501. ** (slower) variable length keys B-Tree.
  90502. **
  90503. ** If rMayHaveNull is non-zero, that means that the operation is an IN
  90504. ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
  90505. ** All this routine does is initialize the register given by rMayHaveNull
  90506. ** to NULL. Calling routines will take care of changing this register
  90507. ** value to non-NULL if the RHS is NULL-free.
  90508. **
  90509. ** For a SELECT or EXISTS operator, return the register that holds the
  90510. ** result. For a multi-column SELECT, the result is stored in a contiguous
  90511. ** array of registers and the return value is the register of the left-most
  90512. ** result column. Return 0 for IN operators or if an error occurs.
  90513. */
  90514. #ifndef SQLITE_OMIT_SUBQUERY
  90515. SQLITE_PRIVATE int sqlite3CodeSubselect(
  90516. Parse *pParse, /* Parsing context */
  90517. Expr *pExpr, /* The IN, SELECT, or EXISTS operator */
  90518. int rHasNullFlag, /* Register that records whether NULLs exist in RHS */
  90519. int isRowid /* If true, LHS of IN operator is a rowid */
  90520. ){
  90521. int jmpIfDynamic = -1; /* One-time test address */
  90522. int rReg = 0; /* Register storing resulting */
  90523. Vdbe *v = sqlite3GetVdbe(pParse);
  90524. if( NEVER(v==0) ) return 0;
  90525. sqlite3ExprCachePush(pParse);
  90526. /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
  90527. ** is encountered if any of the following is true:
  90528. **
  90529. ** * The right-hand side is a correlated subquery
  90530. ** * The right-hand side is an expression list containing variables
  90531. ** * We are inside a trigger
  90532. **
  90533. ** If all of the above are false, then we can run this code just once
  90534. ** save the results, and reuse the same result on subsequent invocations.
  90535. */
  90536. if( !ExprHasProperty(pExpr, EP_VarSelect) ){
  90537. jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  90538. }
  90539. #ifndef SQLITE_OMIT_EXPLAIN
  90540. if( pParse->explain==2 ){
  90541. char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
  90542. jmpIfDynamic>=0?"":"CORRELATED ",
  90543. pExpr->op==TK_IN?"LIST":"SCALAR",
  90544. pParse->iNextSelectId
  90545. );
  90546. sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
  90547. }
  90548. #endif
  90549. switch( pExpr->op ){
  90550. case TK_IN: {
  90551. int addr; /* Address of OP_OpenEphemeral instruction */
  90552. Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
  90553. KeyInfo *pKeyInfo = 0; /* Key information */
  90554. int nVal; /* Size of vector pLeft */
  90555. nVal = sqlite3ExprVectorSize(pLeft);
  90556. assert( !isRowid || nVal==1 );
  90557. /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
  90558. ** expression it is handled the same way. An ephemeral table is
  90559. ** filled with index keys representing the results from the
  90560. ** SELECT or the <exprlist>.
  90561. **
  90562. ** If the 'x' expression is a column value, or the SELECT...
  90563. ** statement returns a column value, then the affinity of that
  90564. ** column is used to build the index keys. If both 'x' and the
  90565. ** SELECT... statement are columns, then numeric affinity is used
  90566. ** if either column has NUMERIC or INTEGER affinity. If neither
  90567. ** 'x' nor the SELECT... statement are columns, then numeric affinity
  90568. ** is used.
  90569. */
  90570. pExpr->iTable = pParse->nTab++;
  90571. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
  90572. pExpr->iTable, (isRowid?0:nVal));
  90573. pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
  90574. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  90575. /* Case 1: expr IN (SELECT ...)
  90576. **
  90577. ** Generate code to write the results of the select into the temporary
  90578. ** table allocated and opened above.
  90579. */
  90580. Select *pSelect = pExpr->x.pSelect;
  90581. ExprList *pEList = pSelect->pEList;
  90582. assert( !isRowid );
  90583. /* If the LHS and RHS of the IN operator do not match, that
  90584. ** error will have been caught long before we reach this point. */
  90585. if( ALWAYS(pEList->nExpr==nVal) ){
  90586. SelectDest dest;
  90587. int i;
  90588. sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
  90589. dest.zAffSdst = exprINAffinity(pParse, pExpr);
  90590. pSelect->iLimit = 0;
  90591. testcase( pSelect->selFlags & SF_Distinct );
  90592. testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
  90593. if( sqlite3Select(pParse, pSelect, &dest) ){
  90594. sqlite3DbFree(pParse->db, dest.zAffSdst);
  90595. sqlite3KeyInfoUnref(pKeyInfo);
  90596. return 0;
  90597. }
  90598. sqlite3DbFree(pParse->db, dest.zAffSdst);
  90599. assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
  90600. assert( pEList!=0 );
  90601. assert( pEList->nExpr>0 );
  90602. assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
  90603. for(i=0; i<nVal; i++){
  90604. Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
  90605. pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
  90606. pParse, p, pEList->a[i].pExpr
  90607. );
  90608. }
  90609. }
  90610. }else if( ALWAYS(pExpr->x.pList!=0) ){
  90611. /* Case 2: expr IN (exprlist)
  90612. **
  90613. ** For each expression, build an index key from the evaluation and
  90614. ** store it in the temporary table. If <expr> is a column, then use
  90615. ** that columns affinity when building index keys. If <expr> is not
  90616. ** a column, use numeric affinity.
  90617. */
  90618. char affinity; /* Affinity of the LHS of the IN */
  90619. int i;
  90620. ExprList *pList = pExpr->x.pList;
  90621. struct ExprList_item *pItem;
  90622. int r1, r2, r3;
  90623. affinity = sqlite3ExprAffinity(pLeft);
  90624. if( !affinity ){
  90625. affinity = SQLITE_AFF_BLOB;
  90626. }
  90627. if( pKeyInfo ){
  90628. assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
  90629. pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
  90630. }
  90631. /* Loop through each expression in <exprlist>. */
  90632. r1 = sqlite3GetTempReg(pParse);
  90633. r2 = sqlite3GetTempReg(pParse);
  90634. if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
  90635. for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
  90636. Expr *pE2 = pItem->pExpr;
  90637. int iValToIns;
  90638. /* If the expression is not constant then we will need to
  90639. ** disable the test that was generated above that makes sure
  90640. ** this code only executes once. Because for a non-constant
  90641. ** expression we need to rerun this code each time.
  90642. */
  90643. if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
  90644. sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
  90645. jmpIfDynamic = -1;
  90646. }
  90647. /* Evaluate the expression and insert it into the temp table */
  90648. if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
  90649. sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
  90650. }else{
  90651. r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
  90652. if( isRowid ){
  90653. sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
  90654. sqlite3VdbeCurrentAddr(v)+2);
  90655. VdbeCoverage(v);
  90656. sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
  90657. }else{
  90658. sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
  90659. sqlite3ExprCacheAffinityChange(pParse, r3, 1);
  90660. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
  90661. }
  90662. }
  90663. }
  90664. sqlite3ReleaseTempReg(pParse, r1);
  90665. sqlite3ReleaseTempReg(pParse, r2);
  90666. }
  90667. if( pKeyInfo ){
  90668. sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
  90669. }
  90670. break;
  90671. }
  90672. case TK_EXISTS:
  90673. case TK_SELECT:
  90674. default: {
  90675. /* Case 3: (SELECT ... FROM ...)
  90676. ** or: EXISTS(SELECT ... FROM ...)
  90677. **
  90678. ** For a SELECT, generate code to put the values for all columns of
  90679. ** the first row into an array of registers and return the index of
  90680. ** the first register.
  90681. **
  90682. ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
  90683. ** into a register and return that register number.
  90684. **
  90685. ** In both cases, the query is augmented with "LIMIT 1". Any
  90686. ** preexisting limit is discarded in place of the new LIMIT 1.
  90687. */
  90688. Select *pSel; /* SELECT statement to encode */
  90689. SelectDest dest; /* How to deal with SELECT result */
  90690. int nReg; /* Registers to allocate */
  90691. Expr *pLimit; /* New limit expression */
  90692. testcase( pExpr->op==TK_EXISTS );
  90693. testcase( pExpr->op==TK_SELECT );
  90694. assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
  90695. assert( ExprHasProperty(pExpr, EP_xIsSelect) );
  90696. pSel = pExpr->x.pSelect;
  90697. nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
  90698. sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
  90699. pParse->nMem += nReg;
  90700. if( pExpr->op==TK_SELECT ){
  90701. dest.eDest = SRT_Mem;
  90702. dest.iSdst = dest.iSDParm;
  90703. dest.nSdst = nReg;
  90704. sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
  90705. VdbeComment((v, "Init subquery result"));
  90706. }else{
  90707. dest.eDest = SRT_Exists;
  90708. sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
  90709. VdbeComment((v, "Init EXISTS result"));
  90710. }
  90711. pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
  90712. if( pSel->pLimit ){
  90713. sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
  90714. pSel->pLimit->pLeft = pLimit;
  90715. }else{
  90716. pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
  90717. }
  90718. pSel->iLimit = 0;
  90719. if( sqlite3Select(pParse, pSel, &dest) ){
  90720. return 0;
  90721. }
  90722. rReg = dest.iSDParm;
  90723. ExprSetVVAProperty(pExpr, EP_NoReduce);
  90724. break;
  90725. }
  90726. }
  90727. if( rHasNullFlag ){
  90728. sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
  90729. }
  90730. if( jmpIfDynamic>=0 ){
  90731. sqlite3VdbeJumpHere(v, jmpIfDynamic);
  90732. }
  90733. sqlite3ExprCachePop(pParse);
  90734. return rReg;
  90735. }
  90736. #endif /* SQLITE_OMIT_SUBQUERY */
  90737. #ifndef SQLITE_OMIT_SUBQUERY
  90738. /*
  90739. ** Expr pIn is an IN(...) expression. This function checks that the
  90740. ** sub-select on the RHS of the IN() operator has the same number of
  90741. ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
  90742. ** a sub-query, that the LHS is a vector of size 1.
  90743. */
  90744. SQLITE_PRIVATE int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
  90745. int nVector = sqlite3ExprVectorSize(pIn->pLeft);
  90746. if( (pIn->flags & EP_xIsSelect) ){
  90747. if( nVector!=pIn->x.pSelect->pEList->nExpr ){
  90748. sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
  90749. return 1;
  90750. }
  90751. }else if( nVector!=1 ){
  90752. sqlite3VectorErrorMsg(pParse, pIn->pLeft);
  90753. return 1;
  90754. }
  90755. return 0;
  90756. }
  90757. #endif
  90758. #ifndef SQLITE_OMIT_SUBQUERY
  90759. /*
  90760. ** Generate code for an IN expression.
  90761. **
  90762. ** x IN (SELECT ...)
  90763. ** x IN (value, value, ...)
  90764. **
  90765. ** The left-hand side (LHS) is a scalar or vector expression. The
  90766. ** right-hand side (RHS) is an array of zero or more scalar values, or a
  90767. ** subquery. If the RHS is a subquery, the number of result columns must
  90768. ** match the number of columns in the vector on the LHS. If the RHS is
  90769. ** a list of values, the LHS must be a scalar.
  90770. **
  90771. ** The IN operator is true if the LHS value is contained within the RHS.
  90772. ** The result is false if the LHS is definitely not in the RHS. The
  90773. ** result is NULL if the presence of the LHS in the RHS cannot be
  90774. ** determined due to NULLs.
  90775. **
  90776. ** This routine generates code that jumps to destIfFalse if the LHS is not
  90777. ** contained within the RHS. If due to NULLs we cannot determine if the LHS
  90778. ** is contained in the RHS then jump to destIfNull. If the LHS is contained
  90779. ** within the RHS then fall through.
  90780. **
  90781. ** See the separate in-operator.md documentation file in the canonical
  90782. ** SQLite source tree for additional information.
  90783. */
  90784. static void sqlite3ExprCodeIN(
  90785. Parse *pParse, /* Parsing and code generating context */
  90786. Expr *pExpr, /* The IN expression */
  90787. int destIfFalse, /* Jump here if LHS is not contained in the RHS */
  90788. int destIfNull /* Jump here if the results are unknown due to NULLs */
  90789. ){
  90790. int rRhsHasNull = 0; /* Register that is true if RHS contains NULL values */
  90791. int eType; /* Type of the RHS */
  90792. int rLhs; /* Register(s) holding the LHS values */
  90793. int rLhsOrig; /* LHS values prior to reordering by aiMap[] */
  90794. Vdbe *v; /* Statement under construction */
  90795. int *aiMap = 0; /* Map from vector field to index column */
  90796. char *zAff = 0; /* Affinity string for comparisons */
  90797. int nVector; /* Size of vectors for this IN operator */
  90798. int iDummy; /* Dummy parameter to exprCodeVector() */
  90799. Expr *pLeft; /* The LHS of the IN operator */
  90800. int i; /* loop counter */
  90801. int destStep2; /* Where to jump when NULLs seen in step 2 */
  90802. int destStep6 = 0; /* Start of code for Step 6 */
  90803. int addrTruthOp; /* Address of opcode that determines the IN is true */
  90804. int destNotNull; /* Jump here if a comparison is not true in step 6 */
  90805. int addrTop; /* Top of the step-6 loop */
  90806. pLeft = pExpr->pLeft;
  90807. if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
  90808. zAff = exprINAffinity(pParse, pExpr);
  90809. nVector = sqlite3ExprVectorSize(pExpr->pLeft);
  90810. aiMap = (int*)sqlite3DbMallocZero(
  90811. pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
  90812. );
  90813. if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
  90814. /* Attempt to compute the RHS. After this step, if anything other than
  90815. ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
  90816. ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
  90817. ** the RHS has not yet been coded. */
  90818. v = pParse->pVdbe;
  90819. assert( v!=0 ); /* OOM detected prior to this routine */
  90820. VdbeNoopComment((v, "begin IN expr"));
  90821. eType = sqlite3FindInIndex(pParse, pExpr,
  90822. IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
  90823. destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
  90824. assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
  90825. || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
  90826. );
  90827. #ifdef SQLITE_DEBUG
  90828. /* Confirm that aiMap[] contains nVector integer values between 0 and
  90829. ** nVector-1. */
  90830. for(i=0; i<nVector; i++){
  90831. int j, cnt;
  90832. for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
  90833. assert( cnt==1 );
  90834. }
  90835. #endif
  90836. /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
  90837. ** vector, then it is stored in an array of nVector registers starting
  90838. ** at r1.
  90839. **
  90840. ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
  90841. ** so that the fields are in the same order as an existing index. The
  90842. ** aiMap[] array contains a mapping from the original LHS field order to
  90843. ** the field order that matches the RHS index.
  90844. */
  90845. sqlite3ExprCachePush(pParse);
  90846. rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
  90847. for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
  90848. if( i==nVector ){
  90849. /* LHS fields are not reordered */
  90850. rLhs = rLhsOrig;
  90851. }else{
  90852. /* Need to reorder the LHS fields according to aiMap */
  90853. rLhs = sqlite3GetTempRange(pParse, nVector);
  90854. for(i=0; i<nVector; i++){
  90855. sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
  90856. }
  90857. }
  90858. /* If sqlite3FindInIndex() did not find or create an index that is
  90859. ** suitable for evaluating the IN operator, then evaluate using a
  90860. ** sequence of comparisons.
  90861. **
  90862. ** This is step (1) in the in-operator.md optimized algorithm.
  90863. */
  90864. if( eType==IN_INDEX_NOOP ){
  90865. ExprList *pList = pExpr->x.pList;
  90866. CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
  90867. int labelOk = sqlite3VdbeMakeLabel(v);
  90868. int r2, regToFree;
  90869. int regCkNull = 0;
  90870. int ii;
  90871. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  90872. if( destIfNull!=destIfFalse ){
  90873. regCkNull = sqlite3GetTempReg(pParse);
  90874. sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
  90875. }
  90876. for(ii=0; ii<pList->nExpr; ii++){
  90877. r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
  90878. if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
  90879. sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
  90880. }
  90881. if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
  90882. sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
  90883. (void*)pColl, P4_COLLSEQ);
  90884. VdbeCoverageIf(v, ii<pList->nExpr-1);
  90885. VdbeCoverageIf(v, ii==pList->nExpr-1);
  90886. sqlite3VdbeChangeP5(v, zAff[0]);
  90887. }else{
  90888. assert( destIfNull==destIfFalse );
  90889. sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
  90890. (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
  90891. sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
  90892. }
  90893. sqlite3ReleaseTempReg(pParse, regToFree);
  90894. }
  90895. if( regCkNull ){
  90896. sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
  90897. sqlite3VdbeGoto(v, destIfFalse);
  90898. }
  90899. sqlite3VdbeResolveLabel(v, labelOk);
  90900. sqlite3ReleaseTempReg(pParse, regCkNull);
  90901. goto sqlite3ExprCodeIN_finished;
  90902. }
  90903. /* Step 2: Check to see if the LHS contains any NULL columns. If the
  90904. ** LHS does contain NULLs then the result must be either FALSE or NULL.
  90905. ** We will then skip the binary search of the RHS.
  90906. */
  90907. if( destIfNull==destIfFalse ){
  90908. destStep2 = destIfFalse;
  90909. }else{
  90910. destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
  90911. }
  90912. for(i=0; i<nVector; i++){
  90913. Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
  90914. if( sqlite3ExprCanBeNull(p) ){
  90915. sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
  90916. VdbeCoverage(v);
  90917. }
  90918. }
  90919. /* Step 3. The LHS is now known to be non-NULL. Do the binary search
  90920. ** of the RHS using the LHS as a probe. If found, the result is
  90921. ** true.
  90922. */
  90923. if( eType==IN_INDEX_ROWID ){
  90924. /* In this case, the RHS is the ROWID of table b-tree and so we also
  90925. ** know that the RHS is non-NULL. Hence, we combine steps 3 and 4
  90926. ** into a single opcode. */
  90927. sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
  90928. VdbeCoverage(v);
  90929. addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto); /* Return True */
  90930. }else{
  90931. sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
  90932. if( destIfFalse==destIfNull ){
  90933. /* Combine Step 3 and Step 5 into a single opcode */
  90934. sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
  90935. rLhs, nVector); VdbeCoverage(v);
  90936. goto sqlite3ExprCodeIN_finished;
  90937. }
  90938. /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
  90939. addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
  90940. rLhs, nVector); VdbeCoverage(v);
  90941. }
  90942. /* Step 4. If the RHS is known to be non-NULL and we did not find
  90943. ** an match on the search above, then the result must be FALSE.
  90944. */
  90945. if( rRhsHasNull && nVector==1 ){
  90946. sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
  90947. VdbeCoverage(v);
  90948. }
  90949. /* Step 5. If we do not care about the difference between NULL and
  90950. ** FALSE, then just return false.
  90951. */
  90952. if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
  90953. /* Step 6: Loop through rows of the RHS. Compare each row to the LHS.
  90954. ** If any comparison is NULL, then the result is NULL. If all
  90955. ** comparisons are FALSE then the final result is FALSE.
  90956. **
  90957. ** For a scalar LHS, it is sufficient to check just the first row
  90958. ** of the RHS.
  90959. */
  90960. if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
  90961. addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
  90962. VdbeCoverage(v);
  90963. if( nVector>1 ){
  90964. destNotNull = sqlite3VdbeMakeLabel(v);
  90965. }else{
  90966. /* For nVector==1, combine steps 6 and 7 by immediately returning
  90967. ** FALSE if the first comparison is not NULL */
  90968. destNotNull = destIfFalse;
  90969. }
  90970. for(i=0; i<nVector; i++){
  90971. Expr *p;
  90972. CollSeq *pColl;
  90973. int r3 = sqlite3GetTempReg(pParse);
  90974. p = sqlite3VectorFieldSubexpr(pLeft, i);
  90975. pColl = sqlite3ExprCollSeq(pParse, p);
  90976. sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
  90977. sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
  90978. (void*)pColl, P4_COLLSEQ);
  90979. VdbeCoverage(v);
  90980. sqlite3ReleaseTempReg(pParse, r3);
  90981. }
  90982. sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
  90983. if( nVector>1 ){
  90984. sqlite3VdbeResolveLabel(v, destNotNull);
  90985. sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
  90986. VdbeCoverage(v);
  90987. /* Step 7: If we reach this point, we know that the result must
  90988. ** be false. */
  90989. sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
  90990. }
  90991. /* Jumps here in order to return true. */
  90992. sqlite3VdbeJumpHere(v, addrTruthOp);
  90993. sqlite3ExprCodeIN_finished:
  90994. if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
  90995. sqlite3ExprCachePop(pParse);
  90996. VdbeComment((v, "end IN expr"));
  90997. sqlite3ExprCodeIN_oom_error:
  90998. sqlite3DbFree(pParse->db, aiMap);
  90999. sqlite3DbFree(pParse->db, zAff);
  91000. }
  91001. #endif /* SQLITE_OMIT_SUBQUERY */
  91002. #ifndef SQLITE_OMIT_FLOATING_POINT
  91003. /*
  91004. ** Generate an instruction that will put the floating point
  91005. ** value described by z[0..n-1] into register iMem.
  91006. **
  91007. ** The z[] string will probably not be zero-terminated. But the
  91008. ** z[n] character is guaranteed to be something that does not look
  91009. ** like the continuation of the number.
  91010. */
  91011. static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
  91012. if( ALWAYS(z!=0) ){
  91013. double value;
  91014. sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
  91015. assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
  91016. if( negateFlag ) value = -value;
  91017. sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
  91018. }
  91019. }
  91020. #endif
  91021. /*
  91022. ** Generate an instruction that will put the integer describe by
  91023. ** text z[0..n-1] into register iMem.
  91024. **
  91025. ** Expr.u.zToken is always UTF8 and zero-terminated.
  91026. */
  91027. static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
  91028. Vdbe *v = pParse->pVdbe;
  91029. if( pExpr->flags & EP_IntValue ){
  91030. int i = pExpr->u.iValue;
  91031. assert( i>=0 );
  91032. if( negFlag ) i = -i;
  91033. sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
  91034. }else{
  91035. int c;
  91036. i64 value;
  91037. const char *z = pExpr->u.zToken;
  91038. assert( z!=0 );
  91039. c = sqlite3DecOrHexToI64(z, &value);
  91040. if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
  91041. #ifdef SQLITE_OMIT_FLOATING_POINT
  91042. sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
  91043. #else
  91044. #ifndef SQLITE_OMIT_HEX_INTEGER
  91045. if( sqlite3_strnicmp(z,"0x",2)==0 ){
  91046. sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
  91047. }else
  91048. #endif
  91049. {
  91050. codeReal(v, z, negFlag, iMem);
  91051. }
  91052. #endif
  91053. }else{
  91054. if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
  91055. sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
  91056. }
  91057. }
  91058. }
  91059. /*
  91060. ** Erase column-cache entry number i
  91061. */
  91062. static void cacheEntryClear(Parse *pParse, int i){
  91063. if( pParse->aColCache[i].tempReg ){
  91064. if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
  91065. pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
  91066. }
  91067. }
  91068. pParse->nColCache--;
  91069. if( i<pParse->nColCache ){
  91070. pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
  91071. }
  91072. }
  91073. /*
  91074. ** Record in the column cache that a particular column from a
  91075. ** particular table is stored in a particular register.
  91076. */
  91077. SQLITE_PRIVATE void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
  91078. int i;
  91079. int minLru;
  91080. int idxLru;
  91081. struct yColCache *p;
  91082. /* Unless an error has occurred, register numbers are always positive. */
  91083. assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
  91084. assert( iCol>=-1 && iCol<32768 ); /* Finite column numbers */
  91085. /* The SQLITE_ColumnCache flag disables the column cache. This is used
  91086. ** for testing only - to verify that SQLite always gets the same answer
  91087. ** with and without the column cache.
  91088. */
  91089. if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
  91090. /* First replace any existing entry.
  91091. **
  91092. ** Actually, the way the column cache is currently used, we are guaranteed
  91093. ** that the object will never already be in cache. Verify this guarantee.
  91094. */
  91095. #ifndef NDEBUG
  91096. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  91097. assert( p->iTable!=iTab || p->iColumn!=iCol );
  91098. }
  91099. #endif
  91100. /* If the cache is already full, delete the least recently used entry */
  91101. if( pParse->nColCache>=SQLITE_N_COLCACHE ){
  91102. minLru = 0x7fffffff;
  91103. idxLru = -1;
  91104. for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
  91105. if( p->lru<minLru ){
  91106. idxLru = i;
  91107. minLru = p->lru;
  91108. }
  91109. }
  91110. p = &pParse->aColCache[idxLru];
  91111. }else{
  91112. p = &pParse->aColCache[pParse->nColCache++];
  91113. }
  91114. /* Add the new entry to the end of the cache */
  91115. p->iLevel = pParse->iCacheLevel;
  91116. p->iTable = iTab;
  91117. p->iColumn = iCol;
  91118. p->iReg = iReg;
  91119. p->tempReg = 0;
  91120. p->lru = pParse->iCacheCnt++;
  91121. }
  91122. /*
  91123. ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
  91124. ** Purge the range of registers from the column cache.
  91125. */
  91126. SQLITE_PRIVATE void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
  91127. int i = 0;
  91128. while( i<pParse->nColCache ){
  91129. struct yColCache *p = &pParse->aColCache[i];
  91130. if( p->iReg >= iReg && p->iReg < iReg+nReg ){
  91131. cacheEntryClear(pParse, i);
  91132. }else{
  91133. i++;
  91134. }
  91135. }
  91136. }
  91137. /*
  91138. ** Remember the current column cache context. Any new entries added
  91139. ** added to the column cache after this call are removed when the
  91140. ** corresponding pop occurs.
  91141. */
  91142. SQLITE_PRIVATE void sqlite3ExprCachePush(Parse *pParse){
  91143. pParse->iCacheLevel++;
  91144. #ifdef SQLITE_DEBUG
  91145. if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
  91146. printf("PUSH to %d\n", pParse->iCacheLevel);
  91147. }
  91148. #endif
  91149. }
  91150. /*
  91151. ** Remove from the column cache any entries that were added since the
  91152. ** the previous sqlite3ExprCachePush operation. In other words, restore
  91153. ** the cache to the state it was in prior the most recent Push.
  91154. */
  91155. SQLITE_PRIVATE void sqlite3ExprCachePop(Parse *pParse){
  91156. int i = 0;
  91157. assert( pParse->iCacheLevel>=1 );
  91158. pParse->iCacheLevel--;
  91159. #ifdef SQLITE_DEBUG
  91160. if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
  91161. printf("POP to %d\n", pParse->iCacheLevel);
  91162. }
  91163. #endif
  91164. while( i<pParse->nColCache ){
  91165. if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
  91166. cacheEntryClear(pParse, i);
  91167. }else{
  91168. i++;
  91169. }
  91170. }
  91171. }
  91172. /*
  91173. ** When a cached column is reused, make sure that its register is
  91174. ** no longer available as a temp register. ticket #3879: that same
  91175. ** register might be in the cache in multiple places, so be sure to
  91176. ** get them all.
  91177. */
  91178. static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
  91179. int i;
  91180. struct yColCache *p;
  91181. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  91182. if( p->iReg==iReg ){
  91183. p->tempReg = 0;
  91184. }
  91185. }
  91186. }
  91187. /* Generate code that will load into register regOut a value that is
  91188. ** appropriate for the iIdxCol-th column of index pIdx.
  91189. */
  91190. SQLITE_PRIVATE void sqlite3ExprCodeLoadIndexColumn(
  91191. Parse *pParse, /* The parsing context */
  91192. Index *pIdx, /* The index whose column is to be loaded */
  91193. int iTabCur, /* Cursor pointing to a table row */
  91194. int iIdxCol, /* The column of the index to be loaded */
  91195. int regOut /* Store the index column value in this register */
  91196. ){
  91197. i16 iTabCol = pIdx->aiColumn[iIdxCol];
  91198. if( iTabCol==XN_EXPR ){
  91199. assert( pIdx->aColExpr );
  91200. assert( pIdx->aColExpr->nExpr>iIdxCol );
  91201. pParse->iSelfTab = iTabCur + 1;
  91202. sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
  91203. pParse->iSelfTab = 0;
  91204. }else{
  91205. sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
  91206. iTabCol, regOut);
  91207. }
  91208. }
  91209. /*
  91210. ** Generate code to extract the value of the iCol-th column of a table.
  91211. */
  91212. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnOfTable(
  91213. Vdbe *v, /* The VDBE under construction */
  91214. Table *pTab, /* The table containing the value */
  91215. int iTabCur, /* The table cursor. Or the PK cursor for WITHOUT ROWID */
  91216. int iCol, /* Index of the column to extract */
  91217. int regOut /* Extract the value into this register */
  91218. ){
  91219. if( pTab==0 ){
  91220. sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
  91221. return;
  91222. }
  91223. if( iCol<0 || iCol==pTab->iPKey ){
  91224. sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
  91225. }else{
  91226. int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
  91227. int x = iCol;
  91228. if( !HasRowid(pTab) && !IsVirtual(pTab) ){
  91229. x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
  91230. }
  91231. sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
  91232. }
  91233. if( iCol>=0 ){
  91234. sqlite3ColumnDefault(v, pTab, iCol, regOut);
  91235. }
  91236. }
  91237. /*
  91238. ** Generate code that will extract the iColumn-th column from
  91239. ** table pTab and store the column value in a register.
  91240. **
  91241. ** An effort is made to store the column value in register iReg. This
  91242. ** is not garanteeed for GetColumn() - the result can be stored in
  91243. ** any register. But the result is guaranteed to land in register iReg
  91244. ** for GetColumnToReg().
  91245. **
  91246. ** There must be an open cursor to pTab in iTable when this routine
  91247. ** is called. If iColumn<0 then code is generated that extracts the rowid.
  91248. */
  91249. SQLITE_PRIVATE int sqlite3ExprCodeGetColumn(
  91250. Parse *pParse, /* Parsing and code generating context */
  91251. Table *pTab, /* Description of the table we are reading from */
  91252. int iColumn, /* Index of the table column */
  91253. int iTable, /* The cursor pointing to the table */
  91254. int iReg, /* Store results here */
  91255. u8 p5 /* P5 value for OP_Column + FLAGS */
  91256. ){
  91257. Vdbe *v = pParse->pVdbe;
  91258. int i;
  91259. struct yColCache *p;
  91260. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  91261. if( p->iTable==iTable && p->iColumn==iColumn ){
  91262. p->lru = pParse->iCacheCnt++;
  91263. sqlite3ExprCachePinRegister(pParse, p->iReg);
  91264. return p->iReg;
  91265. }
  91266. }
  91267. assert( v!=0 );
  91268. sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
  91269. if( p5 ){
  91270. sqlite3VdbeChangeP5(v, p5);
  91271. }else{
  91272. sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
  91273. }
  91274. return iReg;
  91275. }
  91276. SQLITE_PRIVATE void sqlite3ExprCodeGetColumnToReg(
  91277. Parse *pParse, /* Parsing and code generating context */
  91278. Table *pTab, /* Description of the table we are reading from */
  91279. int iColumn, /* Index of the table column */
  91280. int iTable, /* The cursor pointing to the table */
  91281. int iReg /* Store results here */
  91282. ){
  91283. int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
  91284. if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
  91285. }
  91286. /*
  91287. ** Clear all column cache entries.
  91288. */
  91289. SQLITE_PRIVATE void sqlite3ExprCacheClear(Parse *pParse){
  91290. int i;
  91291. #ifdef SQLITE_DEBUG
  91292. if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
  91293. printf("CLEAR\n");
  91294. }
  91295. #endif
  91296. for(i=0; i<pParse->nColCache; i++){
  91297. if( pParse->aColCache[i].tempReg
  91298. && pParse->nTempReg<ArraySize(pParse->aTempReg)
  91299. ){
  91300. pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
  91301. }
  91302. }
  91303. pParse->nColCache = 0;
  91304. }
  91305. /*
  91306. ** Record the fact that an affinity change has occurred on iCount
  91307. ** registers starting with iStart.
  91308. */
  91309. SQLITE_PRIVATE void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
  91310. sqlite3ExprCacheRemove(pParse, iStart, iCount);
  91311. }
  91312. /*
  91313. ** Generate code to move content from registers iFrom...iFrom+nReg-1
  91314. ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
  91315. */
  91316. SQLITE_PRIVATE void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
  91317. assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
  91318. sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
  91319. sqlite3ExprCacheRemove(pParse, iFrom, nReg);
  91320. }
  91321. #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
  91322. /*
  91323. ** Return true if any register in the range iFrom..iTo (inclusive)
  91324. ** is used as part of the column cache.
  91325. **
  91326. ** This routine is used within assert() and testcase() macros only
  91327. ** and does not appear in a normal build.
  91328. */
  91329. static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
  91330. int i;
  91331. struct yColCache *p;
  91332. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  91333. int r = p->iReg;
  91334. if( r>=iFrom && r<=iTo ) return 1; /*NO_TEST*/
  91335. }
  91336. return 0;
  91337. }
  91338. #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
  91339. /*
  91340. ** Convert a scalar expression node to a TK_REGISTER referencing
  91341. ** register iReg. The caller must ensure that iReg already contains
  91342. ** the correct value for the expression.
  91343. */
  91344. static void exprToRegister(Expr *p, int iReg){
  91345. p->op2 = p->op;
  91346. p->op = TK_REGISTER;
  91347. p->iTable = iReg;
  91348. ExprClearProperty(p, EP_Skip);
  91349. }
  91350. /*
  91351. ** Evaluate an expression (either a vector or a scalar expression) and store
  91352. ** the result in continguous temporary registers. Return the index of
  91353. ** the first register used to store the result.
  91354. **
  91355. ** If the returned result register is a temporary scalar, then also write
  91356. ** that register number into *piFreeable. If the returned result register
  91357. ** is not a temporary or if the expression is a vector set *piFreeable
  91358. ** to 0.
  91359. */
  91360. static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
  91361. int iResult;
  91362. int nResult = sqlite3ExprVectorSize(p);
  91363. if( nResult==1 ){
  91364. iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
  91365. }else{
  91366. *piFreeable = 0;
  91367. if( p->op==TK_SELECT ){
  91368. #if SQLITE_OMIT_SUBQUERY
  91369. iResult = 0;
  91370. #else
  91371. iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
  91372. #endif
  91373. }else{
  91374. int i;
  91375. iResult = pParse->nMem+1;
  91376. pParse->nMem += nResult;
  91377. for(i=0; i<nResult; i++){
  91378. sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
  91379. }
  91380. }
  91381. }
  91382. return iResult;
  91383. }
  91384. /*
  91385. ** Generate code into the current Vdbe to evaluate the given
  91386. ** expression. Attempt to store the results in register "target".
  91387. ** Return the register where results are stored.
  91388. **
  91389. ** With this routine, there is no guarantee that results will
  91390. ** be stored in target. The result might be stored in some other
  91391. ** register if it is convenient to do so. The calling function
  91392. ** must check the return code and move the results to the desired
  91393. ** register.
  91394. */
  91395. SQLITE_PRIVATE int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
  91396. Vdbe *v = pParse->pVdbe; /* The VM under construction */
  91397. int op; /* The opcode being coded */
  91398. int inReg = target; /* Results stored in register inReg */
  91399. int regFree1 = 0; /* If non-zero free this temporary register */
  91400. int regFree2 = 0; /* If non-zero free this temporary register */
  91401. int r1, r2; /* Various register numbers */
  91402. Expr tempX; /* Temporary expression node */
  91403. int p5 = 0;
  91404. assert( target>0 && target<=pParse->nMem );
  91405. if( v==0 ){
  91406. assert( pParse->db->mallocFailed );
  91407. return 0;
  91408. }
  91409. if( pExpr==0 ){
  91410. op = TK_NULL;
  91411. }else{
  91412. op = pExpr->op;
  91413. }
  91414. switch( op ){
  91415. case TK_AGG_COLUMN: {
  91416. AggInfo *pAggInfo = pExpr->pAggInfo;
  91417. struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
  91418. if( !pAggInfo->directMode ){
  91419. assert( pCol->iMem>0 );
  91420. return pCol->iMem;
  91421. }else if( pAggInfo->useSortingIdx ){
  91422. sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
  91423. pCol->iSorterColumn, target);
  91424. return target;
  91425. }
  91426. /* Otherwise, fall thru into the TK_COLUMN case */
  91427. }
  91428. case TK_COLUMN: {
  91429. int iTab = pExpr->iTable;
  91430. if( iTab<0 ){
  91431. if( pParse->iSelfTab<0 ){
  91432. /* Generating CHECK constraints or inserting into partial index */
  91433. return pExpr->iColumn - pParse->iSelfTab;
  91434. }else{
  91435. /* Coding an expression that is part of an index where column names
  91436. ** in the index refer to the table to which the index belongs */
  91437. iTab = pParse->iSelfTab - 1;
  91438. }
  91439. }
  91440. return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
  91441. pExpr->iColumn, iTab, target,
  91442. pExpr->op2);
  91443. }
  91444. case TK_INTEGER: {
  91445. codeInteger(pParse, pExpr, 0, target);
  91446. return target;
  91447. }
  91448. case TK_TRUEFALSE: {
  91449. sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
  91450. return target;
  91451. }
  91452. #ifndef SQLITE_OMIT_FLOATING_POINT
  91453. case TK_FLOAT: {
  91454. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91455. codeReal(v, pExpr->u.zToken, 0, target);
  91456. return target;
  91457. }
  91458. #endif
  91459. case TK_STRING: {
  91460. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91461. sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
  91462. return target;
  91463. }
  91464. case TK_NULL: {
  91465. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  91466. return target;
  91467. }
  91468. #ifndef SQLITE_OMIT_BLOB_LITERAL
  91469. case TK_BLOB: {
  91470. int n;
  91471. const char *z;
  91472. char *zBlob;
  91473. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91474. assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
  91475. assert( pExpr->u.zToken[1]=='\'' );
  91476. z = &pExpr->u.zToken[2];
  91477. n = sqlite3Strlen30(z) - 1;
  91478. assert( z[n]=='\'' );
  91479. zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
  91480. sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
  91481. return target;
  91482. }
  91483. #endif
  91484. case TK_VARIABLE: {
  91485. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91486. assert( pExpr->u.zToken!=0 );
  91487. assert( pExpr->u.zToken[0]!=0 );
  91488. sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
  91489. if( pExpr->u.zToken[1]!=0 ){
  91490. const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
  91491. assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
  91492. pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
  91493. sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
  91494. }
  91495. return target;
  91496. }
  91497. case TK_REGISTER: {
  91498. return pExpr->iTable;
  91499. }
  91500. #ifndef SQLITE_OMIT_CAST
  91501. case TK_CAST: {
  91502. /* Expressions of the form: CAST(pLeft AS token) */
  91503. inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
  91504. if( inReg!=target ){
  91505. sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
  91506. inReg = target;
  91507. }
  91508. sqlite3VdbeAddOp2(v, OP_Cast, target,
  91509. sqlite3AffinityType(pExpr->u.zToken, 0));
  91510. testcase( usedAsColumnCache(pParse, inReg, inReg) );
  91511. sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
  91512. return inReg;
  91513. }
  91514. #endif /* SQLITE_OMIT_CAST */
  91515. case TK_IS:
  91516. case TK_ISNOT:
  91517. op = (op==TK_IS) ? TK_EQ : TK_NE;
  91518. p5 = SQLITE_NULLEQ;
  91519. /* fall-through */
  91520. case TK_LT:
  91521. case TK_LE:
  91522. case TK_GT:
  91523. case TK_GE:
  91524. case TK_NE:
  91525. case TK_EQ: {
  91526. Expr *pLeft = pExpr->pLeft;
  91527. if( sqlite3ExprIsVector(pLeft) ){
  91528. codeVectorCompare(pParse, pExpr, target, op, p5);
  91529. }else{
  91530. r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
  91531. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  91532. codeCompare(pParse, pLeft, pExpr->pRight, op,
  91533. r1, r2, inReg, SQLITE_STOREP2 | p5);
  91534. assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  91535. assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  91536. assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  91537. assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  91538. assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
  91539. assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
  91540. testcase( regFree1==0 );
  91541. testcase( regFree2==0 );
  91542. }
  91543. break;
  91544. }
  91545. case TK_AND:
  91546. case TK_OR:
  91547. case TK_PLUS:
  91548. case TK_STAR:
  91549. case TK_MINUS:
  91550. case TK_REM:
  91551. case TK_BITAND:
  91552. case TK_BITOR:
  91553. case TK_SLASH:
  91554. case TK_LSHIFT:
  91555. case TK_RSHIFT:
  91556. case TK_CONCAT: {
  91557. assert( TK_AND==OP_And ); testcase( op==TK_AND );
  91558. assert( TK_OR==OP_Or ); testcase( op==TK_OR );
  91559. assert( TK_PLUS==OP_Add ); testcase( op==TK_PLUS );
  91560. assert( TK_MINUS==OP_Subtract ); testcase( op==TK_MINUS );
  91561. assert( TK_REM==OP_Remainder ); testcase( op==TK_REM );
  91562. assert( TK_BITAND==OP_BitAnd ); testcase( op==TK_BITAND );
  91563. assert( TK_BITOR==OP_BitOr ); testcase( op==TK_BITOR );
  91564. assert( TK_SLASH==OP_Divide ); testcase( op==TK_SLASH );
  91565. assert( TK_LSHIFT==OP_ShiftLeft ); testcase( op==TK_LSHIFT );
  91566. assert( TK_RSHIFT==OP_ShiftRight ); testcase( op==TK_RSHIFT );
  91567. assert( TK_CONCAT==OP_Concat ); testcase( op==TK_CONCAT );
  91568. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  91569. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  91570. sqlite3VdbeAddOp3(v, op, r2, r1, target);
  91571. testcase( regFree1==0 );
  91572. testcase( regFree2==0 );
  91573. break;
  91574. }
  91575. case TK_UMINUS: {
  91576. Expr *pLeft = pExpr->pLeft;
  91577. assert( pLeft );
  91578. if( pLeft->op==TK_INTEGER ){
  91579. codeInteger(pParse, pLeft, 1, target);
  91580. return target;
  91581. #ifndef SQLITE_OMIT_FLOATING_POINT
  91582. }else if( pLeft->op==TK_FLOAT ){
  91583. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91584. codeReal(v, pLeft->u.zToken, 1, target);
  91585. return target;
  91586. #endif
  91587. }else{
  91588. tempX.op = TK_INTEGER;
  91589. tempX.flags = EP_IntValue|EP_TokenOnly;
  91590. tempX.u.iValue = 0;
  91591. r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
  91592. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
  91593. sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
  91594. testcase( regFree2==0 );
  91595. }
  91596. break;
  91597. }
  91598. case TK_BITNOT:
  91599. case TK_NOT: {
  91600. assert( TK_BITNOT==OP_BitNot ); testcase( op==TK_BITNOT );
  91601. assert( TK_NOT==OP_Not ); testcase( op==TK_NOT );
  91602. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  91603. testcase( regFree1==0 );
  91604. sqlite3VdbeAddOp2(v, op, r1, inReg);
  91605. break;
  91606. }
  91607. case TK_TRUTH: {
  91608. int isTrue; /* IS TRUE or IS NOT TRUE */
  91609. int bNormal; /* IS TRUE or IS FALSE */
  91610. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  91611. testcase( regFree1==0 );
  91612. isTrue = sqlite3ExprTruthValue(pExpr->pRight);
  91613. bNormal = pExpr->op2==TK_IS;
  91614. testcase( isTrue && bNormal);
  91615. testcase( !isTrue && bNormal);
  91616. sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
  91617. break;
  91618. }
  91619. case TK_ISNULL:
  91620. case TK_NOTNULL: {
  91621. int addr;
  91622. assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
  91623. assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
  91624. sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
  91625. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  91626. testcase( regFree1==0 );
  91627. addr = sqlite3VdbeAddOp1(v, op, r1);
  91628. VdbeCoverageIf(v, op==TK_ISNULL);
  91629. VdbeCoverageIf(v, op==TK_NOTNULL);
  91630. sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
  91631. sqlite3VdbeJumpHere(v, addr);
  91632. break;
  91633. }
  91634. case TK_AGG_FUNCTION: {
  91635. AggInfo *pInfo = pExpr->pAggInfo;
  91636. if( pInfo==0 ){
  91637. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91638. sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
  91639. }else{
  91640. return pInfo->aFunc[pExpr->iAgg].iMem;
  91641. }
  91642. break;
  91643. }
  91644. case TK_FUNCTION: {
  91645. ExprList *pFarg; /* List of function arguments */
  91646. int nFarg; /* Number of function arguments */
  91647. FuncDef *pDef; /* The function definition object */
  91648. const char *zId; /* The function name */
  91649. u32 constMask = 0; /* Mask of function arguments that are constant */
  91650. int i; /* Loop counter */
  91651. sqlite3 *db = pParse->db; /* The database connection */
  91652. u8 enc = ENC(db); /* The text encoding used by this database */
  91653. CollSeq *pColl = 0; /* A collating sequence */
  91654. if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
  91655. /* SQL functions can be expensive. So try to move constant functions
  91656. ** out of the inner loop, even if that means an extra OP_Copy. */
  91657. return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
  91658. }
  91659. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  91660. if( ExprHasProperty(pExpr, EP_TokenOnly) ){
  91661. pFarg = 0;
  91662. }else{
  91663. pFarg = pExpr->x.pList;
  91664. }
  91665. nFarg = pFarg ? pFarg->nExpr : 0;
  91666. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  91667. zId = pExpr->u.zToken;
  91668. pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
  91669. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  91670. if( pDef==0 && pParse->explain ){
  91671. pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
  91672. }
  91673. #endif
  91674. if( pDef==0 || pDef->xFinalize!=0 ){
  91675. sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
  91676. break;
  91677. }
  91678. /* Attempt a direct implementation of the built-in COALESCE() and
  91679. ** IFNULL() functions. This avoids unnecessary evaluation of
  91680. ** arguments past the first non-NULL argument.
  91681. */
  91682. if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
  91683. int endCoalesce = sqlite3VdbeMakeLabel(v);
  91684. assert( nFarg>=2 );
  91685. sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
  91686. for(i=1; i<nFarg; i++){
  91687. sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
  91688. VdbeCoverage(v);
  91689. sqlite3ExprCacheRemove(pParse, target, 1);
  91690. sqlite3ExprCachePush(pParse);
  91691. sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
  91692. sqlite3ExprCachePop(pParse);
  91693. }
  91694. sqlite3VdbeResolveLabel(v, endCoalesce);
  91695. break;
  91696. }
  91697. /* The UNLIKELY() function is a no-op. The result is the value
  91698. ** of the first argument.
  91699. */
  91700. if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
  91701. assert( nFarg>=1 );
  91702. return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
  91703. }
  91704. #ifdef SQLITE_DEBUG
  91705. /* The AFFINITY() function evaluates to a string that describes
  91706. ** the type affinity of the argument. This is used for testing of
  91707. ** the SQLite type logic.
  91708. */
  91709. if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
  91710. const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
  91711. char aff;
  91712. assert( nFarg==1 );
  91713. aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
  91714. sqlite3VdbeLoadString(v, target,
  91715. aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
  91716. return target;
  91717. }
  91718. #endif
  91719. for(i=0; i<nFarg; i++){
  91720. if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
  91721. testcase( i==31 );
  91722. constMask |= MASKBIT32(i);
  91723. }
  91724. if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
  91725. pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
  91726. }
  91727. }
  91728. if( pFarg ){
  91729. if( constMask ){
  91730. r1 = pParse->nMem+1;
  91731. pParse->nMem += nFarg;
  91732. }else{
  91733. r1 = sqlite3GetTempRange(pParse, nFarg);
  91734. }
  91735. /* For length() and typeof() functions with a column argument,
  91736. ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
  91737. ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
  91738. ** loading.
  91739. */
  91740. if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
  91741. u8 exprOp;
  91742. assert( nFarg==1 );
  91743. assert( pFarg->a[0].pExpr!=0 );
  91744. exprOp = pFarg->a[0].pExpr->op;
  91745. if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
  91746. assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
  91747. assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
  91748. testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
  91749. pFarg->a[0].pExpr->op2 =
  91750. pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
  91751. }
  91752. }
  91753. sqlite3ExprCachePush(pParse); /* Ticket 2ea2425d34be */
  91754. sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
  91755. SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
  91756. sqlite3ExprCachePop(pParse); /* Ticket 2ea2425d34be */
  91757. }else{
  91758. r1 = 0;
  91759. }
  91760. #ifndef SQLITE_OMIT_VIRTUALTABLE
  91761. /* Possibly overload the function if the first argument is
  91762. ** a virtual table column.
  91763. **
  91764. ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
  91765. ** second argument, not the first, as the argument to test to
  91766. ** see if it is a column in a virtual table. This is done because
  91767. ** the left operand of infix functions (the operand we want to
  91768. ** control overloading) ends up as the second argument to the
  91769. ** function. The expression "A glob B" is equivalent to
  91770. ** "glob(B,A). We want to use the A in "A glob B" to test
  91771. ** for function overloading. But we use the B term in "glob(B,A)".
  91772. */
  91773. if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
  91774. pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
  91775. }else if( nFarg>0 ){
  91776. pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
  91777. }
  91778. #endif
  91779. if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
  91780. if( !pColl ) pColl = db->pDfltColl;
  91781. sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
  91782. }
  91783. #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
  91784. if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
  91785. Expr *pArg = pFarg->a[0].pExpr;
  91786. if( pArg->op==TK_COLUMN ){
  91787. sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
  91788. }else{
  91789. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  91790. }
  91791. }else
  91792. #endif
  91793. {
  91794. sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
  91795. constMask, r1, target, (char*)pDef, P4_FUNCDEF);
  91796. sqlite3VdbeChangeP5(v, (u8)nFarg);
  91797. }
  91798. if( nFarg && constMask==0 ){
  91799. sqlite3ReleaseTempRange(pParse, r1, nFarg);
  91800. }
  91801. return target;
  91802. }
  91803. #ifndef SQLITE_OMIT_SUBQUERY
  91804. case TK_EXISTS:
  91805. case TK_SELECT: {
  91806. int nCol;
  91807. testcase( op==TK_EXISTS );
  91808. testcase( op==TK_SELECT );
  91809. if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
  91810. sqlite3SubselectError(pParse, nCol, 1);
  91811. }else{
  91812. return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
  91813. }
  91814. break;
  91815. }
  91816. case TK_SELECT_COLUMN: {
  91817. int n;
  91818. if( pExpr->pLeft->iTable==0 ){
  91819. pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
  91820. }
  91821. assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
  91822. if( pExpr->iTable
  91823. && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
  91824. ){
  91825. sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
  91826. pExpr->iTable, n);
  91827. }
  91828. return pExpr->pLeft->iTable + pExpr->iColumn;
  91829. }
  91830. case TK_IN: {
  91831. int destIfFalse = sqlite3VdbeMakeLabel(v);
  91832. int destIfNull = sqlite3VdbeMakeLabel(v);
  91833. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  91834. sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
  91835. sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
  91836. sqlite3VdbeResolveLabel(v, destIfFalse);
  91837. sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
  91838. sqlite3VdbeResolveLabel(v, destIfNull);
  91839. return target;
  91840. }
  91841. #endif /* SQLITE_OMIT_SUBQUERY */
  91842. /*
  91843. ** x BETWEEN y AND z
  91844. **
  91845. ** This is equivalent to
  91846. **
  91847. ** x>=y AND x<=z
  91848. **
  91849. ** X is stored in pExpr->pLeft.
  91850. ** Y is stored in pExpr->pList->a[0].pExpr.
  91851. ** Z is stored in pExpr->pList->a[1].pExpr.
  91852. */
  91853. case TK_BETWEEN: {
  91854. exprCodeBetween(pParse, pExpr, target, 0, 0);
  91855. return target;
  91856. }
  91857. case TK_SPAN:
  91858. case TK_COLLATE:
  91859. case TK_UPLUS: {
  91860. return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
  91861. }
  91862. case TK_TRIGGER: {
  91863. /* If the opcode is TK_TRIGGER, then the expression is a reference
  91864. ** to a column in the new.* or old.* pseudo-tables available to
  91865. ** trigger programs. In this case Expr.iTable is set to 1 for the
  91866. ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
  91867. ** is set to the column of the pseudo-table to read, or to -1 to
  91868. ** read the rowid field.
  91869. **
  91870. ** The expression is implemented using an OP_Param opcode. The p1
  91871. ** parameter is set to 0 for an old.rowid reference, or to (i+1)
  91872. ** to reference another column of the old.* pseudo-table, where
  91873. ** i is the index of the column. For a new.rowid reference, p1 is
  91874. ** set to (n+1), where n is the number of columns in each pseudo-table.
  91875. ** For a reference to any other column in the new.* pseudo-table, p1
  91876. ** is set to (n+2+i), where n and i are as defined previously. For
  91877. ** example, if the table on which triggers are being fired is
  91878. ** declared as:
  91879. **
  91880. ** CREATE TABLE t1(a, b);
  91881. **
  91882. ** Then p1 is interpreted as follows:
  91883. **
  91884. ** p1==0 -> old.rowid p1==3 -> new.rowid
  91885. ** p1==1 -> old.a p1==4 -> new.a
  91886. ** p1==2 -> old.b p1==5 -> new.b
  91887. */
  91888. Table *pTab = pExpr->pTab;
  91889. int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
  91890. assert( pExpr->iTable==0 || pExpr->iTable==1 );
  91891. assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
  91892. assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
  91893. assert( p1>=0 && p1<(pTab->nCol*2+2) );
  91894. sqlite3VdbeAddOp2(v, OP_Param, p1, target);
  91895. VdbeComment((v, "%s.%s -> $%d",
  91896. (pExpr->iTable ? "new" : "old"),
  91897. (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
  91898. target
  91899. ));
  91900. #ifndef SQLITE_OMIT_FLOATING_POINT
  91901. /* If the column has REAL affinity, it may currently be stored as an
  91902. ** integer. Use OP_RealAffinity to make sure it is really real.
  91903. **
  91904. ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
  91905. ** floating point when extracting it from the record. */
  91906. if( pExpr->iColumn>=0
  91907. && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
  91908. ){
  91909. sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
  91910. }
  91911. #endif
  91912. break;
  91913. }
  91914. case TK_VECTOR: {
  91915. sqlite3ErrorMsg(pParse, "row value misused");
  91916. break;
  91917. }
  91918. case TK_IF_NULL_ROW: {
  91919. int addrINR;
  91920. addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
  91921. sqlite3ExprCachePush(pParse);
  91922. inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
  91923. sqlite3ExprCachePop(pParse);
  91924. sqlite3VdbeJumpHere(v, addrINR);
  91925. sqlite3VdbeChangeP3(v, addrINR, inReg);
  91926. break;
  91927. }
  91928. /*
  91929. ** Form A:
  91930. ** CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
  91931. **
  91932. ** Form B:
  91933. ** CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
  91934. **
  91935. ** Form A is can be transformed into the equivalent form B as follows:
  91936. ** CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
  91937. ** WHEN x=eN THEN rN ELSE y END
  91938. **
  91939. ** X (if it exists) is in pExpr->pLeft.
  91940. ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
  91941. ** odd. The Y is also optional. If the number of elements in x.pList
  91942. ** is even, then Y is omitted and the "otherwise" result is NULL.
  91943. ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
  91944. **
  91945. ** The result of the expression is the Ri for the first matching Ei,
  91946. ** or if there is no matching Ei, the ELSE term Y, or if there is
  91947. ** no ELSE term, NULL.
  91948. */
  91949. default: assert( op==TK_CASE ); {
  91950. int endLabel; /* GOTO label for end of CASE stmt */
  91951. int nextCase; /* GOTO label for next WHEN clause */
  91952. int nExpr; /* 2x number of WHEN terms */
  91953. int i; /* Loop counter */
  91954. ExprList *pEList; /* List of WHEN terms */
  91955. struct ExprList_item *aListelem; /* Array of WHEN terms */
  91956. Expr opCompare; /* The X==Ei expression */
  91957. Expr *pX; /* The X expression */
  91958. Expr *pTest = 0; /* X==Ei (form A) or just Ei (form B) */
  91959. VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
  91960. assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
  91961. assert(pExpr->x.pList->nExpr > 0);
  91962. pEList = pExpr->x.pList;
  91963. aListelem = pEList->a;
  91964. nExpr = pEList->nExpr;
  91965. endLabel = sqlite3VdbeMakeLabel(v);
  91966. if( (pX = pExpr->pLeft)!=0 ){
  91967. tempX = *pX;
  91968. testcase( pX->op==TK_COLUMN );
  91969. exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
  91970. testcase( regFree1==0 );
  91971. memset(&opCompare, 0, sizeof(opCompare));
  91972. opCompare.op = TK_EQ;
  91973. opCompare.pLeft = &tempX;
  91974. pTest = &opCompare;
  91975. /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
  91976. ** The value in regFree1 might get SCopy-ed into the file result.
  91977. ** So make sure that the regFree1 register is not reused for other
  91978. ** purposes and possibly overwritten. */
  91979. regFree1 = 0;
  91980. }
  91981. for(i=0; i<nExpr-1; i=i+2){
  91982. sqlite3ExprCachePush(pParse);
  91983. if( pX ){
  91984. assert( pTest!=0 );
  91985. opCompare.pRight = aListelem[i].pExpr;
  91986. }else{
  91987. pTest = aListelem[i].pExpr;
  91988. }
  91989. nextCase = sqlite3VdbeMakeLabel(v);
  91990. testcase( pTest->op==TK_COLUMN );
  91991. sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
  91992. testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
  91993. sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
  91994. sqlite3VdbeGoto(v, endLabel);
  91995. sqlite3ExprCachePop(pParse);
  91996. sqlite3VdbeResolveLabel(v, nextCase);
  91997. }
  91998. if( (nExpr&1)!=0 ){
  91999. sqlite3ExprCachePush(pParse);
  92000. sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
  92001. sqlite3ExprCachePop(pParse);
  92002. }else{
  92003. sqlite3VdbeAddOp2(v, OP_Null, 0, target);
  92004. }
  92005. assert( pParse->db->mallocFailed || pParse->nErr>0
  92006. || pParse->iCacheLevel==iCacheLevel );
  92007. sqlite3VdbeResolveLabel(v, endLabel);
  92008. break;
  92009. }
  92010. #ifndef SQLITE_OMIT_TRIGGER
  92011. case TK_RAISE: {
  92012. assert( pExpr->affinity==OE_Rollback
  92013. || pExpr->affinity==OE_Abort
  92014. || pExpr->affinity==OE_Fail
  92015. || pExpr->affinity==OE_Ignore
  92016. );
  92017. if( !pParse->pTriggerTab ){
  92018. sqlite3ErrorMsg(pParse,
  92019. "RAISE() may only be used within a trigger-program");
  92020. return 0;
  92021. }
  92022. if( pExpr->affinity==OE_Abort ){
  92023. sqlite3MayAbort(pParse);
  92024. }
  92025. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  92026. if( pExpr->affinity==OE_Ignore ){
  92027. sqlite3VdbeAddOp4(
  92028. v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
  92029. VdbeCoverage(v);
  92030. }else{
  92031. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
  92032. pExpr->affinity, pExpr->u.zToken, 0, 0);
  92033. }
  92034. break;
  92035. }
  92036. #endif
  92037. }
  92038. sqlite3ReleaseTempReg(pParse, regFree1);
  92039. sqlite3ReleaseTempReg(pParse, regFree2);
  92040. return inReg;
  92041. }
  92042. /*
  92043. ** Factor out the code of the given expression to initialization time.
  92044. **
  92045. ** If regDest>=0 then the result is always stored in that register and the
  92046. ** result is not reusable. If regDest<0 then this routine is free to
  92047. ** store the value whereever it wants. The register where the expression
  92048. ** is stored is returned. When regDest<0, two identical expressions will
  92049. ** code to the same register.
  92050. */
  92051. SQLITE_PRIVATE int sqlite3ExprCodeAtInit(
  92052. Parse *pParse, /* Parsing context */
  92053. Expr *pExpr, /* The expression to code when the VDBE initializes */
  92054. int regDest /* Store the value in this register */
  92055. ){
  92056. ExprList *p;
  92057. assert( ConstFactorOk(pParse) );
  92058. p = pParse->pConstExpr;
  92059. if( regDest<0 && p ){
  92060. struct ExprList_item *pItem;
  92061. int i;
  92062. for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
  92063. if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
  92064. return pItem->u.iConstExprReg;
  92065. }
  92066. }
  92067. }
  92068. pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
  92069. p = sqlite3ExprListAppend(pParse, p, pExpr);
  92070. if( p ){
  92071. struct ExprList_item *pItem = &p->a[p->nExpr-1];
  92072. pItem->reusable = regDest<0;
  92073. if( regDest<0 ) regDest = ++pParse->nMem;
  92074. pItem->u.iConstExprReg = regDest;
  92075. }
  92076. pParse->pConstExpr = p;
  92077. return regDest;
  92078. }
  92079. /*
  92080. ** Generate code to evaluate an expression and store the results
  92081. ** into a register. Return the register number where the results
  92082. ** are stored.
  92083. **
  92084. ** If the register is a temporary register that can be deallocated,
  92085. ** then write its number into *pReg. If the result register is not
  92086. ** a temporary, then set *pReg to zero.
  92087. **
  92088. ** If pExpr is a constant, then this routine might generate this
  92089. ** code to fill the register in the initialization section of the
  92090. ** VDBE program, in order to factor it out of the evaluation loop.
  92091. */
  92092. SQLITE_PRIVATE int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
  92093. int r2;
  92094. pExpr = sqlite3ExprSkipCollate(pExpr);
  92095. if( ConstFactorOk(pParse)
  92096. && pExpr->op!=TK_REGISTER
  92097. && sqlite3ExprIsConstantNotJoin(pExpr)
  92098. ){
  92099. *pReg = 0;
  92100. r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
  92101. }else{
  92102. int r1 = sqlite3GetTempReg(pParse);
  92103. r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
  92104. if( r2==r1 ){
  92105. *pReg = r1;
  92106. }else{
  92107. sqlite3ReleaseTempReg(pParse, r1);
  92108. *pReg = 0;
  92109. }
  92110. }
  92111. return r2;
  92112. }
  92113. /*
  92114. ** Generate code that will evaluate expression pExpr and store the
  92115. ** results in register target. The results are guaranteed to appear
  92116. ** in register target.
  92117. */
  92118. SQLITE_PRIVATE void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
  92119. int inReg;
  92120. assert( target>0 && target<=pParse->nMem );
  92121. if( pExpr && pExpr->op==TK_REGISTER ){
  92122. sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
  92123. }else{
  92124. inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
  92125. assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
  92126. if( inReg!=target && pParse->pVdbe ){
  92127. sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
  92128. }
  92129. }
  92130. }
  92131. /*
  92132. ** Make a transient copy of expression pExpr and then code it using
  92133. ** sqlite3ExprCode(). This routine works just like sqlite3ExprCode()
  92134. ** except that the input expression is guaranteed to be unchanged.
  92135. */
  92136. SQLITE_PRIVATE void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
  92137. sqlite3 *db = pParse->db;
  92138. pExpr = sqlite3ExprDup(db, pExpr, 0);
  92139. if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
  92140. sqlite3ExprDelete(db, pExpr);
  92141. }
  92142. /*
  92143. ** Generate code that will evaluate expression pExpr and store the
  92144. ** results in register target. The results are guaranteed to appear
  92145. ** in register target. If the expression is constant, then this routine
  92146. ** might choose to code the expression at initialization time.
  92147. */
  92148. SQLITE_PRIVATE void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
  92149. if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
  92150. sqlite3ExprCodeAtInit(pParse, pExpr, target);
  92151. }else{
  92152. sqlite3ExprCode(pParse, pExpr, target);
  92153. }
  92154. }
  92155. /*
  92156. ** Generate code that evaluates the given expression and puts the result
  92157. ** in register target.
  92158. **
  92159. ** Also make a copy of the expression results into another "cache" register
  92160. ** and modify the expression so that the next time it is evaluated,
  92161. ** the result is a copy of the cache register.
  92162. **
  92163. ** This routine is used for expressions that are used multiple
  92164. ** times. They are evaluated once and the results of the expression
  92165. ** are reused.
  92166. */
  92167. SQLITE_PRIVATE void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
  92168. Vdbe *v = pParse->pVdbe;
  92169. int iMem;
  92170. assert( target>0 );
  92171. assert( pExpr->op!=TK_REGISTER );
  92172. sqlite3ExprCode(pParse, pExpr, target);
  92173. iMem = ++pParse->nMem;
  92174. sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
  92175. exprToRegister(pExpr, iMem);
  92176. }
  92177. /*
  92178. ** Generate code that pushes the value of every element of the given
  92179. ** expression list into a sequence of registers beginning at target.
  92180. **
  92181. ** Return the number of elements evaluated. The number returned will
  92182. ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
  92183. ** is defined.
  92184. **
  92185. ** The SQLITE_ECEL_DUP flag prevents the arguments from being
  92186. ** filled using OP_SCopy. OP_Copy must be used instead.
  92187. **
  92188. ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
  92189. ** factored out into initialization code.
  92190. **
  92191. ** The SQLITE_ECEL_REF flag means that expressions in the list with
  92192. ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
  92193. ** in registers at srcReg, and so the value can be copied from there.
  92194. ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
  92195. ** are simply omitted rather than being copied from srcReg.
  92196. */
  92197. SQLITE_PRIVATE int sqlite3ExprCodeExprList(
  92198. Parse *pParse, /* Parsing context */
  92199. ExprList *pList, /* The expression list to be coded */
  92200. int target, /* Where to write results */
  92201. int srcReg, /* Source registers if SQLITE_ECEL_REF */
  92202. u8 flags /* SQLITE_ECEL_* flags */
  92203. ){
  92204. struct ExprList_item *pItem;
  92205. int i, j, n;
  92206. u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
  92207. Vdbe *v = pParse->pVdbe;
  92208. assert( pList!=0 );
  92209. assert( target>0 );
  92210. assert( pParse->pVdbe!=0 ); /* Never gets this far otherwise */
  92211. n = pList->nExpr;
  92212. if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
  92213. for(pItem=pList->a, i=0; i<n; i++, pItem++){
  92214. Expr *pExpr = pItem->pExpr;
  92215. if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
  92216. if( flags & SQLITE_ECEL_OMITREF ){
  92217. i--;
  92218. n--;
  92219. }else{
  92220. sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
  92221. }
  92222. }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
  92223. sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
  92224. }else{
  92225. int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
  92226. if( inReg!=target+i ){
  92227. VdbeOp *pOp;
  92228. if( copyOp==OP_Copy
  92229. && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
  92230. && pOp->p1+pOp->p3+1==inReg
  92231. && pOp->p2+pOp->p3+1==target+i
  92232. ){
  92233. pOp->p3++;
  92234. }else{
  92235. sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
  92236. }
  92237. }
  92238. }
  92239. }
  92240. return n;
  92241. }
  92242. /*
  92243. ** Generate code for a BETWEEN operator.
  92244. **
  92245. ** x BETWEEN y AND z
  92246. **
  92247. ** The above is equivalent to
  92248. **
  92249. ** x>=y AND x<=z
  92250. **
  92251. ** Code it as such, taking care to do the common subexpression
  92252. ** elimination of x.
  92253. **
  92254. ** The xJumpIf parameter determines details:
  92255. **
  92256. ** NULL: Store the boolean result in reg[dest]
  92257. ** sqlite3ExprIfTrue: Jump to dest if true
  92258. ** sqlite3ExprIfFalse: Jump to dest if false
  92259. **
  92260. ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
  92261. */
  92262. static void exprCodeBetween(
  92263. Parse *pParse, /* Parsing and code generating context */
  92264. Expr *pExpr, /* The BETWEEN expression */
  92265. int dest, /* Jump destination or storage location */
  92266. void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
  92267. int jumpIfNull /* Take the jump if the BETWEEN is NULL */
  92268. ){
  92269. Expr exprAnd; /* The AND operator in x>=y AND x<=z */
  92270. Expr compLeft; /* The x>=y term */
  92271. Expr compRight; /* The x<=z term */
  92272. Expr exprX; /* The x subexpression */
  92273. int regFree1 = 0; /* Temporary use register */
  92274. memset(&compLeft, 0, sizeof(Expr));
  92275. memset(&compRight, 0, sizeof(Expr));
  92276. memset(&exprAnd, 0, sizeof(Expr));
  92277. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  92278. exprX = *pExpr->pLeft;
  92279. exprAnd.op = TK_AND;
  92280. exprAnd.pLeft = &compLeft;
  92281. exprAnd.pRight = &compRight;
  92282. compLeft.op = TK_GE;
  92283. compLeft.pLeft = &exprX;
  92284. compLeft.pRight = pExpr->x.pList->a[0].pExpr;
  92285. compRight.op = TK_LE;
  92286. compRight.pLeft = &exprX;
  92287. compRight.pRight = pExpr->x.pList->a[1].pExpr;
  92288. exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
  92289. if( xJump ){
  92290. xJump(pParse, &exprAnd, dest, jumpIfNull);
  92291. }else{
  92292. /* Mark the expression is being from the ON or USING clause of a join
  92293. ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
  92294. ** it into the Parse.pConstExpr list. We should use a new bit for this,
  92295. ** for clarity, but we are out of bits in the Expr.flags field so we
  92296. ** have to reuse the EP_FromJoin bit. Bummer. */
  92297. exprX.flags |= EP_FromJoin;
  92298. sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
  92299. }
  92300. sqlite3ReleaseTempReg(pParse, regFree1);
  92301. /* Ensure adequate test coverage */
  92302. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1==0 );
  92303. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull==0 && regFree1!=0 );
  92304. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1==0 );
  92305. testcase( xJump==sqlite3ExprIfTrue && jumpIfNull!=0 && regFree1!=0 );
  92306. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
  92307. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
  92308. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
  92309. testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
  92310. testcase( xJump==0 );
  92311. }
  92312. /*
  92313. ** Generate code for a boolean expression such that a jump is made
  92314. ** to the label "dest" if the expression is true but execution
  92315. ** continues straight thru if the expression is false.
  92316. **
  92317. ** If the expression evaluates to NULL (neither true nor false), then
  92318. ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
  92319. **
  92320. ** This code depends on the fact that certain token values (ex: TK_EQ)
  92321. ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
  92322. ** operation. Special comments in vdbe.c and the mkopcodeh.awk script in
  92323. ** the make process cause these values to align. Assert()s in the code
  92324. ** below verify that the numbers are aligned correctly.
  92325. */
  92326. SQLITE_PRIVATE void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
  92327. Vdbe *v = pParse->pVdbe;
  92328. int op = 0;
  92329. int regFree1 = 0;
  92330. int regFree2 = 0;
  92331. int r1, r2;
  92332. assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
  92333. if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
  92334. if( NEVER(pExpr==0) ) return; /* No way this can happen */
  92335. op = pExpr->op;
  92336. switch( op ){
  92337. case TK_AND: {
  92338. int d2 = sqlite3VdbeMakeLabel(v);
  92339. testcase( jumpIfNull==0 );
  92340. sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
  92341. sqlite3ExprCachePush(pParse);
  92342. sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
  92343. sqlite3VdbeResolveLabel(v, d2);
  92344. sqlite3ExprCachePop(pParse);
  92345. break;
  92346. }
  92347. case TK_OR: {
  92348. testcase( jumpIfNull==0 );
  92349. sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
  92350. sqlite3ExprCachePush(pParse);
  92351. sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
  92352. sqlite3ExprCachePop(pParse);
  92353. break;
  92354. }
  92355. case TK_NOT: {
  92356. testcase( jumpIfNull==0 );
  92357. sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
  92358. break;
  92359. }
  92360. case TK_TRUTH: {
  92361. int isNot; /* IS NOT TRUE or IS NOT FALSE */
  92362. int isTrue; /* IS TRUE or IS NOT TRUE */
  92363. testcase( jumpIfNull==0 );
  92364. isNot = pExpr->op2==TK_ISNOT;
  92365. isTrue = sqlite3ExprTruthValue(pExpr->pRight);
  92366. testcase( isTrue && isNot );
  92367. testcase( !isTrue && isNot );
  92368. if( isTrue ^ isNot ){
  92369. sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
  92370. isNot ? SQLITE_JUMPIFNULL : 0);
  92371. }else{
  92372. sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
  92373. isNot ? SQLITE_JUMPIFNULL : 0);
  92374. }
  92375. break;
  92376. }
  92377. case TK_IS:
  92378. case TK_ISNOT:
  92379. testcase( op==TK_IS );
  92380. testcase( op==TK_ISNOT );
  92381. op = (op==TK_IS) ? TK_EQ : TK_NE;
  92382. jumpIfNull = SQLITE_NULLEQ;
  92383. /* Fall thru */
  92384. case TK_LT:
  92385. case TK_LE:
  92386. case TK_GT:
  92387. case TK_GE:
  92388. case TK_NE:
  92389. case TK_EQ: {
  92390. if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
  92391. testcase( jumpIfNull==0 );
  92392. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  92393. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  92394. codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
  92395. r1, r2, dest, jumpIfNull);
  92396. assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  92397. assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  92398. assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  92399. assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  92400. assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
  92401. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
  92402. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
  92403. assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
  92404. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
  92405. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
  92406. testcase( regFree1==0 );
  92407. testcase( regFree2==0 );
  92408. break;
  92409. }
  92410. case TK_ISNULL:
  92411. case TK_NOTNULL: {
  92412. assert( TK_ISNULL==OP_IsNull ); testcase( op==TK_ISNULL );
  92413. assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
  92414. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  92415. sqlite3VdbeAddOp2(v, op, r1, dest);
  92416. VdbeCoverageIf(v, op==TK_ISNULL);
  92417. VdbeCoverageIf(v, op==TK_NOTNULL);
  92418. testcase( regFree1==0 );
  92419. break;
  92420. }
  92421. case TK_BETWEEN: {
  92422. testcase( jumpIfNull==0 );
  92423. exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
  92424. break;
  92425. }
  92426. #ifndef SQLITE_OMIT_SUBQUERY
  92427. case TK_IN: {
  92428. int destIfFalse = sqlite3VdbeMakeLabel(v);
  92429. int destIfNull = jumpIfNull ? dest : destIfFalse;
  92430. sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
  92431. sqlite3VdbeGoto(v, dest);
  92432. sqlite3VdbeResolveLabel(v, destIfFalse);
  92433. break;
  92434. }
  92435. #endif
  92436. default: {
  92437. default_expr:
  92438. if( exprAlwaysTrue(pExpr) ){
  92439. sqlite3VdbeGoto(v, dest);
  92440. }else if( exprAlwaysFalse(pExpr) ){
  92441. /* No-op */
  92442. }else{
  92443. r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
  92444. sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
  92445. VdbeCoverage(v);
  92446. testcase( regFree1==0 );
  92447. testcase( jumpIfNull==0 );
  92448. }
  92449. break;
  92450. }
  92451. }
  92452. sqlite3ReleaseTempReg(pParse, regFree1);
  92453. sqlite3ReleaseTempReg(pParse, regFree2);
  92454. }
  92455. /*
  92456. ** Generate code for a boolean expression such that a jump is made
  92457. ** to the label "dest" if the expression is false but execution
  92458. ** continues straight thru if the expression is true.
  92459. **
  92460. ** If the expression evaluates to NULL (neither true nor false) then
  92461. ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
  92462. ** is 0.
  92463. */
  92464. SQLITE_PRIVATE void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
  92465. Vdbe *v = pParse->pVdbe;
  92466. int op = 0;
  92467. int regFree1 = 0;
  92468. int regFree2 = 0;
  92469. int r1, r2;
  92470. assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
  92471. if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
  92472. if( pExpr==0 ) return;
  92473. /* The value of pExpr->op and op are related as follows:
  92474. **
  92475. ** pExpr->op op
  92476. ** --------- ----------
  92477. ** TK_ISNULL OP_NotNull
  92478. ** TK_NOTNULL OP_IsNull
  92479. ** TK_NE OP_Eq
  92480. ** TK_EQ OP_Ne
  92481. ** TK_GT OP_Le
  92482. ** TK_LE OP_Gt
  92483. ** TK_GE OP_Lt
  92484. ** TK_LT OP_Ge
  92485. **
  92486. ** For other values of pExpr->op, op is undefined and unused.
  92487. ** The value of TK_ and OP_ constants are arranged such that we
  92488. ** can compute the mapping above using the following expression.
  92489. ** Assert()s verify that the computation is correct.
  92490. */
  92491. op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
  92492. /* Verify correct alignment of TK_ and OP_ constants
  92493. */
  92494. assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
  92495. assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
  92496. assert( pExpr->op!=TK_NE || op==OP_Eq );
  92497. assert( pExpr->op!=TK_EQ || op==OP_Ne );
  92498. assert( pExpr->op!=TK_LT || op==OP_Ge );
  92499. assert( pExpr->op!=TK_LE || op==OP_Gt );
  92500. assert( pExpr->op!=TK_GT || op==OP_Le );
  92501. assert( pExpr->op!=TK_GE || op==OP_Lt );
  92502. switch( pExpr->op ){
  92503. case TK_AND: {
  92504. testcase( jumpIfNull==0 );
  92505. sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
  92506. sqlite3ExprCachePush(pParse);
  92507. sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
  92508. sqlite3ExprCachePop(pParse);
  92509. break;
  92510. }
  92511. case TK_OR: {
  92512. int d2 = sqlite3VdbeMakeLabel(v);
  92513. testcase( jumpIfNull==0 );
  92514. sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
  92515. sqlite3ExprCachePush(pParse);
  92516. sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
  92517. sqlite3VdbeResolveLabel(v, d2);
  92518. sqlite3ExprCachePop(pParse);
  92519. break;
  92520. }
  92521. case TK_NOT: {
  92522. testcase( jumpIfNull==0 );
  92523. sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
  92524. break;
  92525. }
  92526. case TK_TRUTH: {
  92527. int isNot; /* IS NOT TRUE or IS NOT FALSE */
  92528. int isTrue; /* IS TRUE or IS NOT TRUE */
  92529. testcase( jumpIfNull==0 );
  92530. isNot = pExpr->op2==TK_ISNOT;
  92531. isTrue = sqlite3ExprTruthValue(pExpr->pRight);
  92532. testcase( isTrue && isNot );
  92533. testcase( !isTrue && isNot );
  92534. if( isTrue ^ isNot ){
  92535. /* IS TRUE and IS NOT FALSE */
  92536. sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
  92537. isNot ? 0 : SQLITE_JUMPIFNULL);
  92538. }else{
  92539. /* IS FALSE and IS NOT TRUE */
  92540. sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
  92541. isNot ? 0 : SQLITE_JUMPIFNULL);
  92542. }
  92543. break;
  92544. }
  92545. case TK_IS:
  92546. case TK_ISNOT:
  92547. testcase( pExpr->op==TK_IS );
  92548. testcase( pExpr->op==TK_ISNOT );
  92549. op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
  92550. jumpIfNull = SQLITE_NULLEQ;
  92551. /* Fall thru */
  92552. case TK_LT:
  92553. case TK_LE:
  92554. case TK_GT:
  92555. case TK_GE:
  92556. case TK_NE:
  92557. case TK_EQ: {
  92558. if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
  92559. testcase( jumpIfNull==0 );
  92560. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  92561. r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
  92562. codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
  92563. r1, r2, dest, jumpIfNull);
  92564. assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
  92565. assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
  92566. assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
  92567. assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
  92568. assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
  92569. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
  92570. VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
  92571. assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
  92572. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
  92573. VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
  92574. testcase( regFree1==0 );
  92575. testcase( regFree2==0 );
  92576. break;
  92577. }
  92578. case TK_ISNULL:
  92579. case TK_NOTNULL: {
  92580. r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
  92581. sqlite3VdbeAddOp2(v, op, r1, dest);
  92582. testcase( op==TK_ISNULL ); VdbeCoverageIf(v, op==TK_ISNULL);
  92583. testcase( op==TK_NOTNULL ); VdbeCoverageIf(v, op==TK_NOTNULL);
  92584. testcase( regFree1==0 );
  92585. break;
  92586. }
  92587. case TK_BETWEEN: {
  92588. testcase( jumpIfNull==0 );
  92589. exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
  92590. break;
  92591. }
  92592. #ifndef SQLITE_OMIT_SUBQUERY
  92593. case TK_IN: {
  92594. if( jumpIfNull ){
  92595. sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
  92596. }else{
  92597. int destIfNull = sqlite3VdbeMakeLabel(v);
  92598. sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
  92599. sqlite3VdbeResolveLabel(v, destIfNull);
  92600. }
  92601. break;
  92602. }
  92603. #endif
  92604. default: {
  92605. default_expr:
  92606. if( exprAlwaysFalse(pExpr) ){
  92607. sqlite3VdbeGoto(v, dest);
  92608. }else if( exprAlwaysTrue(pExpr) ){
  92609. /* no-op */
  92610. }else{
  92611. r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
  92612. sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
  92613. VdbeCoverage(v);
  92614. testcase( regFree1==0 );
  92615. testcase( jumpIfNull==0 );
  92616. }
  92617. break;
  92618. }
  92619. }
  92620. sqlite3ReleaseTempReg(pParse, regFree1);
  92621. sqlite3ReleaseTempReg(pParse, regFree2);
  92622. }
  92623. /*
  92624. ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
  92625. ** code generation, and that copy is deleted after code generation. This
  92626. ** ensures that the original pExpr is unchanged.
  92627. */
  92628. SQLITE_PRIVATE void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
  92629. sqlite3 *db = pParse->db;
  92630. Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
  92631. if( db->mallocFailed==0 ){
  92632. sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
  92633. }
  92634. sqlite3ExprDelete(db, pCopy);
  92635. }
  92636. /*
  92637. ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
  92638. ** type of expression.
  92639. **
  92640. ** If pExpr is a simple SQL value - an integer, real, string, blob
  92641. ** or NULL value - then the VDBE currently being prepared is configured
  92642. ** to re-prepare each time a new value is bound to variable pVar.
  92643. **
  92644. ** Additionally, if pExpr is a simple SQL value and the value is the
  92645. ** same as that currently bound to variable pVar, non-zero is returned.
  92646. ** Otherwise, if the values are not the same or if pExpr is not a simple
  92647. ** SQL value, zero is returned.
  92648. */
  92649. static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
  92650. int res = 0;
  92651. int iVar;
  92652. sqlite3_value *pL, *pR = 0;
  92653. sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
  92654. if( pR ){
  92655. iVar = pVar->iColumn;
  92656. sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
  92657. pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
  92658. if( pL ){
  92659. if( sqlite3_value_type(pL)==SQLITE_TEXT ){
  92660. sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
  92661. }
  92662. res = 0==sqlite3MemCompare(pL, pR, 0);
  92663. }
  92664. sqlite3ValueFree(pR);
  92665. sqlite3ValueFree(pL);
  92666. }
  92667. return res;
  92668. }
  92669. /*
  92670. ** Do a deep comparison of two expression trees. Return 0 if the two
  92671. ** expressions are completely identical. Return 1 if they differ only
  92672. ** by a COLLATE operator at the top level. Return 2 if there are differences
  92673. ** other than the top-level COLLATE operator.
  92674. **
  92675. ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
  92676. ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
  92677. **
  92678. ** The pA side might be using TK_REGISTER. If that is the case and pB is
  92679. ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
  92680. **
  92681. ** Sometimes this routine will return 2 even if the two expressions
  92682. ** really are equivalent. If we cannot prove that the expressions are
  92683. ** identical, we return 2 just to be safe. So if this routine
  92684. ** returns 2, then you do not really know for certain if the two
  92685. ** expressions are the same. But if you get a 0 or 1 return, then you
  92686. ** can be sure the expressions are the same. In the places where
  92687. ** this routine is used, it does not hurt to get an extra 2 - that
  92688. ** just might result in some slightly slower code. But returning
  92689. ** an incorrect 0 or 1 could lead to a malfunction.
  92690. **
  92691. ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
  92692. ** pParse->pReprepare can be matched against literals in pB. The
  92693. ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
  92694. ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
  92695. ** Argument pParse should normally be NULL. If it is not NULL and pA or
  92696. ** pB causes a return value of 2.
  92697. */
  92698. SQLITE_PRIVATE int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
  92699. u32 combinedFlags;
  92700. if( pA==0 || pB==0 ){
  92701. return pB==pA ? 0 : 2;
  92702. }
  92703. if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
  92704. return 0;
  92705. }
  92706. combinedFlags = pA->flags | pB->flags;
  92707. if( combinedFlags & EP_IntValue ){
  92708. if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
  92709. return 0;
  92710. }
  92711. return 2;
  92712. }
  92713. if( pA->op!=pB->op ){
  92714. if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
  92715. return 1;
  92716. }
  92717. if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
  92718. return 1;
  92719. }
  92720. return 2;
  92721. }
  92722. if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
  92723. if( pA->op==TK_FUNCTION ){
  92724. if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
  92725. }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
  92726. return pA->op==TK_COLLATE ? 1 : 2;
  92727. }
  92728. }
  92729. if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
  92730. if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
  92731. if( combinedFlags & EP_xIsSelect ) return 2;
  92732. if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
  92733. if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
  92734. if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
  92735. if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
  92736. if( pA->iColumn!=pB->iColumn ) return 2;
  92737. if( pA->iTable!=pB->iTable
  92738. && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
  92739. }
  92740. }
  92741. return 0;
  92742. }
  92743. /*
  92744. ** Compare two ExprList objects. Return 0 if they are identical and
  92745. ** non-zero if they differ in any way.
  92746. **
  92747. ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
  92748. ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
  92749. **
  92750. ** This routine might return non-zero for equivalent ExprLists. The
  92751. ** only consequence will be disabled optimizations. But this routine
  92752. ** must never return 0 if the two ExprList objects are different, or
  92753. ** a malfunction will result.
  92754. **
  92755. ** Two NULL pointers are considered to be the same. But a NULL pointer
  92756. ** always differs from a non-NULL pointer.
  92757. */
  92758. SQLITE_PRIVATE int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
  92759. int i;
  92760. if( pA==0 && pB==0 ) return 0;
  92761. if( pA==0 || pB==0 ) return 1;
  92762. if( pA->nExpr!=pB->nExpr ) return 1;
  92763. for(i=0; i<pA->nExpr; i++){
  92764. Expr *pExprA = pA->a[i].pExpr;
  92765. Expr *pExprB = pB->a[i].pExpr;
  92766. if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
  92767. if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
  92768. }
  92769. return 0;
  92770. }
  92771. /*
  92772. ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
  92773. ** are ignored.
  92774. */
  92775. SQLITE_PRIVATE int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
  92776. return sqlite3ExprCompare(0,
  92777. sqlite3ExprSkipCollate(pA),
  92778. sqlite3ExprSkipCollate(pB),
  92779. iTab);
  92780. }
  92781. /*
  92782. ** Return true if we can prove the pE2 will always be true if pE1 is
  92783. ** true. Return false if we cannot complete the proof or if pE2 might
  92784. ** be false. Examples:
  92785. **
  92786. ** pE1: x==5 pE2: x==5 Result: true
  92787. ** pE1: x>0 pE2: x==5 Result: false
  92788. ** pE1: x=21 pE2: x=21 OR y=43 Result: true
  92789. ** pE1: x!=123 pE2: x IS NOT NULL Result: true
  92790. ** pE1: x!=?1 pE2: x IS NOT NULL Result: true
  92791. ** pE1: x IS NULL pE2: x IS NOT NULL Result: false
  92792. ** pE1: x IS ?2 pE2: x IS NOT NULL Reuslt: false
  92793. **
  92794. ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
  92795. ** Expr.iTable<0 then assume a table number given by iTab.
  92796. **
  92797. ** If pParse is not NULL, then the values of bound variables in pE1 are
  92798. ** compared against literal values in pE2 and pParse->pVdbe->expmask is
  92799. ** modified to record which bound variables are referenced. If pParse
  92800. ** is NULL, then false will be returned if pE1 contains any bound variables.
  92801. **
  92802. ** When in doubt, return false. Returning true might give a performance
  92803. ** improvement. Returning false might cause a performance reduction, but
  92804. ** it will always give the correct answer and is hence always safe.
  92805. */
  92806. SQLITE_PRIVATE int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
  92807. if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
  92808. return 1;
  92809. }
  92810. if( pE2->op==TK_OR
  92811. && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
  92812. || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
  92813. ){
  92814. return 1;
  92815. }
  92816. if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
  92817. Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
  92818. testcase( pX!=pE1->pLeft );
  92819. if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
  92820. }
  92821. return 0;
  92822. }
  92823. /*
  92824. ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
  92825. ** If the expression node requires that the table at pWalker->iCur
  92826. ** have a non-NULL column, then set pWalker->eCode to 1 and abort.
  92827. */
  92828. static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
  92829. /* This routine is only called for WHERE clause expressions and so it
  92830. ** cannot have any TK_AGG_COLUMN entries because those are only found
  92831. ** in HAVING clauses. We can get a TK_AGG_FUNCTION in a WHERE clause,
  92832. ** but that is an illegal construct and the query will be rejected at
  92833. ** a later stage of processing, so the TK_AGG_FUNCTION case does not
  92834. ** need to be considered here. */
  92835. assert( pExpr->op!=TK_AGG_COLUMN );
  92836. testcase( pExpr->op==TK_AGG_FUNCTION );
  92837. if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
  92838. switch( pExpr->op ){
  92839. case TK_ISNOT:
  92840. case TK_NOT:
  92841. case TK_ISNULL:
  92842. case TK_IS:
  92843. case TK_OR:
  92844. case TK_CASE:
  92845. case TK_IN:
  92846. case TK_FUNCTION:
  92847. testcase( pExpr->op==TK_ISNOT );
  92848. testcase( pExpr->op==TK_NOT );
  92849. testcase( pExpr->op==TK_ISNULL );
  92850. testcase( pExpr->op==TK_IS );
  92851. testcase( pExpr->op==TK_OR );
  92852. testcase( pExpr->op==TK_CASE );
  92853. testcase( pExpr->op==TK_IN );
  92854. testcase( pExpr->op==TK_FUNCTION );
  92855. return WRC_Prune;
  92856. case TK_COLUMN:
  92857. if( pWalker->u.iCur==pExpr->iTable ){
  92858. pWalker->eCode = 1;
  92859. return WRC_Abort;
  92860. }
  92861. return WRC_Prune;
  92862. /* Virtual tables are allowed to use constraints like x=NULL. So
  92863. ** a term of the form x=y does not prove that y is not null if x
  92864. ** is the column of a virtual table */
  92865. case TK_EQ:
  92866. case TK_NE:
  92867. case TK_LT:
  92868. case TK_LE:
  92869. case TK_GT:
  92870. case TK_GE:
  92871. testcase( pExpr->op==TK_EQ );
  92872. testcase( pExpr->op==TK_NE );
  92873. testcase( pExpr->op==TK_LT );
  92874. testcase( pExpr->op==TK_LE );
  92875. testcase( pExpr->op==TK_GT );
  92876. testcase( pExpr->op==TK_GE );
  92877. if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->pTab))
  92878. || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->pTab))
  92879. ){
  92880. return WRC_Prune;
  92881. }
  92882. default:
  92883. return WRC_Continue;
  92884. }
  92885. }
  92886. /*
  92887. ** Return true (non-zero) if expression p can only be true if at least
  92888. ** one column of table iTab is non-null. In other words, return true
  92889. ** if expression p will always be NULL or false if every column of iTab
  92890. ** is NULL.
  92891. **
  92892. ** False negatives are acceptable. In other words, it is ok to return
  92893. ** zero even if expression p will never be true of every column of iTab
  92894. ** is NULL. A false negative is merely a missed optimization opportunity.
  92895. **
  92896. ** False positives are not allowed, however. A false positive may result
  92897. ** in an incorrect answer.
  92898. **
  92899. ** Terms of p that are marked with EP_FromJoin (and hence that come from
  92900. ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
  92901. **
  92902. ** This routine is used to check if a LEFT JOIN can be converted into
  92903. ** an ordinary JOIN. The p argument is the WHERE clause. If the WHERE
  92904. ** clause requires that some column of the right table of the LEFT JOIN
  92905. ** be non-NULL, then the LEFT JOIN can be safely converted into an
  92906. ** ordinary join.
  92907. */
  92908. SQLITE_PRIVATE int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
  92909. Walker w;
  92910. w.xExprCallback = impliesNotNullRow;
  92911. w.xSelectCallback = 0;
  92912. w.xSelectCallback2 = 0;
  92913. w.eCode = 0;
  92914. w.u.iCur = iTab;
  92915. sqlite3WalkExpr(&w, p);
  92916. return w.eCode;
  92917. }
  92918. /*
  92919. ** An instance of the following structure is used by the tree walker
  92920. ** to determine if an expression can be evaluated by reference to the
  92921. ** index only, without having to do a search for the corresponding
  92922. ** table entry. The IdxCover.pIdx field is the index. IdxCover.iCur
  92923. ** is the cursor for the table.
  92924. */
  92925. struct IdxCover {
  92926. Index *pIdx; /* The index to be tested for coverage */
  92927. int iCur; /* Cursor number for the table corresponding to the index */
  92928. };
  92929. /*
  92930. ** Check to see if there are references to columns in table
  92931. ** pWalker->u.pIdxCover->iCur can be satisfied using the index
  92932. ** pWalker->u.pIdxCover->pIdx.
  92933. */
  92934. static int exprIdxCover(Walker *pWalker, Expr *pExpr){
  92935. if( pExpr->op==TK_COLUMN
  92936. && pExpr->iTable==pWalker->u.pIdxCover->iCur
  92937. && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
  92938. ){
  92939. pWalker->eCode = 1;
  92940. return WRC_Abort;
  92941. }
  92942. return WRC_Continue;
  92943. }
  92944. /*
  92945. ** Determine if an index pIdx on table with cursor iCur contains will
  92946. ** the expression pExpr. Return true if the index does cover the
  92947. ** expression and false if the pExpr expression references table columns
  92948. ** that are not found in the index pIdx.
  92949. **
  92950. ** An index covering an expression means that the expression can be
  92951. ** evaluated using only the index and without having to lookup the
  92952. ** corresponding table entry.
  92953. */
  92954. SQLITE_PRIVATE int sqlite3ExprCoveredByIndex(
  92955. Expr *pExpr, /* The index to be tested */
  92956. int iCur, /* The cursor number for the corresponding table */
  92957. Index *pIdx /* The index that might be used for coverage */
  92958. ){
  92959. Walker w;
  92960. struct IdxCover xcov;
  92961. memset(&w, 0, sizeof(w));
  92962. xcov.iCur = iCur;
  92963. xcov.pIdx = pIdx;
  92964. w.xExprCallback = exprIdxCover;
  92965. w.u.pIdxCover = &xcov;
  92966. sqlite3WalkExpr(&w, pExpr);
  92967. return !w.eCode;
  92968. }
  92969. /*
  92970. ** An instance of the following structure is used by the tree walker
  92971. ** to count references to table columns in the arguments of an
  92972. ** aggregate function, in order to implement the
  92973. ** sqlite3FunctionThisSrc() routine.
  92974. */
  92975. struct SrcCount {
  92976. SrcList *pSrc; /* One particular FROM clause in a nested query */
  92977. int nThis; /* Number of references to columns in pSrcList */
  92978. int nOther; /* Number of references to columns in other FROM clauses */
  92979. };
  92980. /*
  92981. ** Count the number of references to columns.
  92982. */
  92983. static int exprSrcCount(Walker *pWalker, Expr *pExpr){
  92984. /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
  92985. ** is always called before sqlite3ExprAnalyzeAggregates() and so the
  92986. ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN. If
  92987. ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
  92988. ** NEVER() will need to be removed. */
  92989. if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
  92990. int i;
  92991. struct SrcCount *p = pWalker->u.pSrcCount;
  92992. SrcList *pSrc = p->pSrc;
  92993. int nSrc = pSrc ? pSrc->nSrc : 0;
  92994. for(i=0; i<nSrc; i++){
  92995. if( pExpr->iTable==pSrc->a[i].iCursor ) break;
  92996. }
  92997. if( i<nSrc ){
  92998. p->nThis++;
  92999. }else{
  93000. p->nOther++;
  93001. }
  93002. }
  93003. return WRC_Continue;
  93004. }
  93005. /*
  93006. ** Determine if any of the arguments to the pExpr Function reference
  93007. ** pSrcList. Return true if they do. Also return true if the function
  93008. ** has no arguments or has only constant arguments. Return false if pExpr
  93009. ** references columns but not columns of tables found in pSrcList.
  93010. */
  93011. SQLITE_PRIVATE int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
  93012. Walker w;
  93013. struct SrcCount cnt;
  93014. assert( pExpr->op==TK_AGG_FUNCTION );
  93015. w.xExprCallback = exprSrcCount;
  93016. w.xSelectCallback = 0;
  93017. w.u.pSrcCount = &cnt;
  93018. cnt.pSrc = pSrcList;
  93019. cnt.nThis = 0;
  93020. cnt.nOther = 0;
  93021. sqlite3WalkExprList(&w, pExpr->x.pList);
  93022. return cnt.nThis>0 || cnt.nOther==0;
  93023. }
  93024. /*
  93025. ** Add a new element to the pAggInfo->aCol[] array. Return the index of
  93026. ** the new element. Return a negative number if malloc fails.
  93027. */
  93028. static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
  93029. int i;
  93030. pInfo->aCol = sqlite3ArrayAllocate(
  93031. db,
  93032. pInfo->aCol,
  93033. sizeof(pInfo->aCol[0]),
  93034. &pInfo->nColumn,
  93035. &i
  93036. );
  93037. return i;
  93038. }
  93039. /*
  93040. ** Add a new element to the pAggInfo->aFunc[] array. Return the index of
  93041. ** the new element. Return a negative number if malloc fails.
  93042. */
  93043. static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
  93044. int i;
  93045. pInfo->aFunc = sqlite3ArrayAllocate(
  93046. db,
  93047. pInfo->aFunc,
  93048. sizeof(pInfo->aFunc[0]),
  93049. &pInfo->nFunc,
  93050. &i
  93051. );
  93052. return i;
  93053. }
  93054. /*
  93055. ** This is the xExprCallback for a tree walker. It is used to
  93056. ** implement sqlite3ExprAnalyzeAggregates(). See sqlite3ExprAnalyzeAggregates
  93057. ** for additional information.
  93058. */
  93059. static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
  93060. int i;
  93061. NameContext *pNC = pWalker->u.pNC;
  93062. Parse *pParse = pNC->pParse;
  93063. SrcList *pSrcList = pNC->pSrcList;
  93064. AggInfo *pAggInfo = pNC->pAggInfo;
  93065. switch( pExpr->op ){
  93066. case TK_AGG_COLUMN:
  93067. case TK_COLUMN: {
  93068. testcase( pExpr->op==TK_AGG_COLUMN );
  93069. testcase( pExpr->op==TK_COLUMN );
  93070. /* Check to see if the column is in one of the tables in the FROM
  93071. ** clause of the aggregate query */
  93072. if( ALWAYS(pSrcList!=0) ){
  93073. struct SrcList_item *pItem = pSrcList->a;
  93074. for(i=0; i<pSrcList->nSrc; i++, pItem++){
  93075. struct AggInfo_col *pCol;
  93076. assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
  93077. if( pExpr->iTable==pItem->iCursor ){
  93078. /* If we reach this point, it means that pExpr refers to a table
  93079. ** that is in the FROM clause of the aggregate query.
  93080. **
  93081. ** Make an entry for the column in pAggInfo->aCol[] if there
  93082. ** is not an entry there already.
  93083. */
  93084. int k;
  93085. pCol = pAggInfo->aCol;
  93086. for(k=0; k<pAggInfo->nColumn; k++, pCol++){
  93087. if( pCol->iTable==pExpr->iTable &&
  93088. pCol->iColumn==pExpr->iColumn ){
  93089. break;
  93090. }
  93091. }
  93092. if( (k>=pAggInfo->nColumn)
  93093. && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
  93094. ){
  93095. pCol = &pAggInfo->aCol[k];
  93096. pCol->pTab = pExpr->pTab;
  93097. pCol->iTable = pExpr->iTable;
  93098. pCol->iColumn = pExpr->iColumn;
  93099. pCol->iMem = ++pParse->nMem;
  93100. pCol->iSorterColumn = -1;
  93101. pCol->pExpr = pExpr;
  93102. if( pAggInfo->pGroupBy ){
  93103. int j, n;
  93104. ExprList *pGB = pAggInfo->pGroupBy;
  93105. struct ExprList_item *pTerm = pGB->a;
  93106. n = pGB->nExpr;
  93107. for(j=0; j<n; j++, pTerm++){
  93108. Expr *pE = pTerm->pExpr;
  93109. if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
  93110. pE->iColumn==pExpr->iColumn ){
  93111. pCol->iSorterColumn = j;
  93112. break;
  93113. }
  93114. }
  93115. }
  93116. if( pCol->iSorterColumn<0 ){
  93117. pCol->iSorterColumn = pAggInfo->nSortingColumn++;
  93118. }
  93119. }
  93120. /* There is now an entry for pExpr in pAggInfo->aCol[] (either
  93121. ** because it was there before or because we just created it).
  93122. ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
  93123. ** pAggInfo->aCol[] entry.
  93124. */
  93125. ExprSetVVAProperty(pExpr, EP_NoReduce);
  93126. pExpr->pAggInfo = pAggInfo;
  93127. pExpr->op = TK_AGG_COLUMN;
  93128. pExpr->iAgg = (i16)k;
  93129. break;
  93130. } /* endif pExpr->iTable==pItem->iCursor */
  93131. } /* end loop over pSrcList */
  93132. }
  93133. return WRC_Prune;
  93134. }
  93135. case TK_AGG_FUNCTION: {
  93136. if( (pNC->ncFlags & NC_InAggFunc)==0
  93137. && pWalker->walkerDepth==pExpr->op2
  93138. ){
  93139. /* Check to see if pExpr is a duplicate of another aggregate
  93140. ** function that is already in the pAggInfo structure
  93141. */
  93142. struct AggInfo_func *pItem = pAggInfo->aFunc;
  93143. for(i=0; i<pAggInfo->nFunc; i++, pItem++){
  93144. if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
  93145. break;
  93146. }
  93147. }
  93148. if( i>=pAggInfo->nFunc ){
  93149. /* pExpr is original. Make a new entry in pAggInfo->aFunc[]
  93150. */
  93151. u8 enc = ENC(pParse->db);
  93152. i = addAggInfoFunc(pParse->db, pAggInfo);
  93153. if( i>=0 ){
  93154. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  93155. pItem = &pAggInfo->aFunc[i];
  93156. pItem->pExpr = pExpr;
  93157. pItem->iMem = ++pParse->nMem;
  93158. assert( !ExprHasProperty(pExpr, EP_IntValue) );
  93159. pItem->pFunc = sqlite3FindFunction(pParse->db,
  93160. pExpr->u.zToken,
  93161. pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
  93162. if( pExpr->flags & EP_Distinct ){
  93163. pItem->iDistinct = pParse->nTab++;
  93164. }else{
  93165. pItem->iDistinct = -1;
  93166. }
  93167. }
  93168. }
  93169. /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
  93170. */
  93171. assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
  93172. ExprSetVVAProperty(pExpr, EP_NoReduce);
  93173. pExpr->iAgg = (i16)i;
  93174. pExpr->pAggInfo = pAggInfo;
  93175. return WRC_Prune;
  93176. }else{
  93177. return WRC_Continue;
  93178. }
  93179. }
  93180. }
  93181. return WRC_Continue;
  93182. }
  93183. static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
  93184. UNUSED_PARAMETER(pSelect);
  93185. pWalker->walkerDepth++;
  93186. return WRC_Continue;
  93187. }
  93188. static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
  93189. UNUSED_PARAMETER(pSelect);
  93190. pWalker->walkerDepth--;
  93191. }
  93192. /*
  93193. ** Analyze the pExpr expression looking for aggregate functions and
  93194. ** for variables that need to be added to AggInfo object that pNC->pAggInfo
  93195. ** points to. Additional entries are made on the AggInfo object as
  93196. ** necessary.
  93197. **
  93198. ** This routine should only be called after the expression has been
  93199. ** analyzed by sqlite3ResolveExprNames().
  93200. */
  93201. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
  93202. Walker w;
  93203. w.xExprCallback = analyzeAggregate;
  93204. w.xSelectCallback = analyzeAggregatesInSelect;
  93205. w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
  93206. w.walkerDepth = 0;
  93207. w.u.pNC = pNC;
  93208. assert( pNC->pSrcList!=0 );
  93209. sqlite3WalkExpr(&w, pExpr);
  93210. }
  93211. /*
  93212. ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
  93213. ** expression list. Return the number of errors.
  93214. **
  93215. ** If an error is found, the analysis is cut short.
  93216. */
  93217. SQLITE_PRIVATE void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
  93218. struct ExprList_item *pItem;
  93219. int i;
  93220. if( pList ){
  93221. for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
  93222. sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
  93223. }
  93224. }
  93225. }
  93226. /*
  93227. ** Allocate a single new register for use to hold some intermediate result.
  93228. */
  93229. SQLITE_PRIVATE int sqlite3GetTempReg(Parse *pParse){
  93230. if( pParse->nTempReg==0 ){
  93231. return ++pParse->nMem;
  93232. }
  93233. return pParse->aTempReg[--pParse->nTempReg];
  93234. }
  93235. /*
  93236. ** Deallocate a register, making available for reuse for some other
  93237. ** purpose.
  93238. **
  93239. ** If a register is currently being used by the column cache, then
  93240. ** the deallocation is deferred until the column cache line that uses
  93241. ** the register becomes stale.
  93242. */
  93243. SQLITE_PRIVATE void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
  93244. if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
  93245. int i;
  93246. struct yColCache *p;
  93247. for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
  93248. if( p->iReg==iReg ){
  93249. p->tempReg = 1;
  93250. return;
  93251. }
  93252. }
  93253. pParse->aTempReg[pParse->nTempReg++] = iReg;
  93254. }
  93255. }
  93256. /*
  93257. ** Allocate or deallocate a block of nReg consecutive registers.
  93258. */
  93259. SQLITE_PRIVATE int sqlite3GetTempRange(Parse *pParse, int nReg){
  93260. int i, n;
  93261. if( nReg==1 ) return sqlite3GetTempReg(pParse);
  93262. i = pParse->iRangeReg;
  93263. n = pParse->nRangeReg;
  93264. if( nReg<=n ){
  93265. assert( !usedAsColumnCache(pParse, i, i+n-1) );
  93266. pParse->iRangeReg += nReg;
  93267. pParse->nRangeReg -= nReg;
  93268. }else{
  93269. i = pParse->nMem+1;
  93270. pParse->nMem += nReg;
  93271. }
  93272. return i;
  93273. }
  93274. SQLITE_PRIVATE void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
  93275. if( nReg==1 ){
  93276. sqlite3ReleaseTempReg(pParse, iReg);
  93277. return;
  93278. }
  93279. sqlite3ExprCacheRemove(pParse, iReg, nReg);
  93280. if( nReg>pParse->nRangeReg ){
  93281. pParse->nRangeReg = nReg;
  93282. pParse->iRangeReg = iReg;
  93283. }
  93284. }
  93285. /*
  93286. ** Mark all temporary registers as being unavailable for reuse.
  93287. */
  93288. SQLITE_PRIVATE void sqlite3ClearTempRegCache(Parse *pParse){
  93289. pParse->nTempReg = 0;
  93290. pParse->nRangeReg = 0;
  93291. }
  93292. /*
  93293. ** Validate that no temporary register falls within the range of
  93294. ** iFirst..iLast, inclusive. This routine is only call from within assert()
  93295. ** statements.
  93296. */
  93297. #ifdef SQLITE_DEBUG
  93298. SQLITE_PRIVATE int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
  93299. int i;
  93300. if( pParse->nRangeReg>0
  93301. && pParse->iRangeReg+pParse->nRangeReg > iFirst
  93302. && pParse->iRangeReg <= iLast
  93303. ){
  93304. return 0;
  93305. }
  93306. for(i=0; i<pParse->nTempReg; i++){
  93307. if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
  93308. return 0;
  93309. }
  93310. }
  93311. return 1;
  93312. }
  93313. #endif /* SQLITE_DEBUG */
  93314. /************** End of expr.c ************************************************/
  93315. /************** Begin file alter.c *******************************************/
  93316. /*
  93317. ** 2005 February 15
  93318. **
  93319. ** The author disclaims copyright to this source code. In place of
  93320. ** a legal notice, here is a blessing:
  93321. **
  93322. ** May you do good and not evil.
  93323. ** May you find forgiveness for yourself and forgive others.
  93324. ** May you share freely, never taking more than you give.
  93325. **
  93326. *************************************************************************
  93327. ** This file contains C code routines that used to generate VDBE code
  93328. ** that implements the ALTER TABLE command.
  93329. */
  93330. /* #include "sqliteInt.h" */
  93331. /*
  93332. ** The code in this file only exists if we are not omitting the
  93333. ** ALTER TABLE logic from the build.
  93334. */
  93335. #ifndef SQLITE_OMIT_ALTERTABLE
  93336. /*
  93337. ** This function is used by SQL generated to implement the
  93338. ** ALTER TABLE command. The first argument is the text of a CREATE TABLE or
  93339. ** CREATE INDEX command. The second is a table name. The table name in
  93340. ** the CREATE TABLE or CREATE INDEX statement is replaced with the third
  93341. ** argument and the result returned. Examples:
  93342. **
  93343. ** sqlite_rename_table('CREATE TABLE abc(a, b, c)', 'def')
  93344. ** -> 'CREATE TABLE def(a, b, c)'
  93345. **
  93346. ** sqlite_rename_table('CREATE INDEX i ON abc(a)', 'def')
  93347. ** -> 'CREATE INDEX i ON def(a, b, c)'
  93348. */
  93349. static void renameTableFunc(
  93350. sqlite3_context *context,
  93351. int NotUsed,
  93352. sqlite3_value **argv
  93353. ){
  93354. unsigned char const *zSql = sqlite3_value_text(argv[0]);
  93355. unsigned char const *zTableName = sqlite3_value_text(argv[1]);
  93356. int token;
  93357. Token tname;
  93358. unsigned char const *zCsr = zSql;
  93359. int len = 0;
  93360. char *zRet;
  93361. sqlite3 *db = sqlite3_context_db_handle(context);
  93362. UNUSED_PARAMETER(NotUsed);
  93363. /* The principle used to locate the table name in the CREATE TABLE
  93364. ** statement is that the table name is the first non-space token that
  93365. ** is immediately followed by a TK_LP or TK_USING token.
  93366. */
  93367. if( zSql ){
  93368. do {
  93369. if( !*zCsr ){
  93370. /* Ran out of input before finding an opening bracket. Return NULL. */
  93371. return;
  93372. }
  93373. /* Store the token that zCsr points to in tname. */
  93374. tname.z = (char*)zCsr;
  93375. tname.n = len;
  93376. /* Advance zCsr to the next token. Store that token type in 'token',
  93377. ** and its length in 'len' (to be used next iteration of this loop).
  93378. */
  93379. do {
  93380. zCsr += len;
  93381. len = sqlite3GetToken(zCsr, &token);
  93382. } while( token==TK_SPACE );
  93383. assert( len>0 );
  93384. } while( token!=TK_LP && token!=TK_USING );
  93385. zRet = sqlite3MPrintf(db, "%.*s\"%w\"%s", (int)(((u8*)tname.z) - zSql),
  93386. zSql, zTableName, tname.z+tname.n);
  93387. sqlite3_result_text(context, zRet, -1, SQLITE_DYNAMIC);
  93388. }
  93389. }
  93390. /*
  93391. ** This C function implements an SQL user function that is used by SQL code
  93392. ** generated by the ALTER TABLE ... RENAME command to modify the definition
  93393. ** of any foreign key constraints that use the table being renamed as the
  93394. ** parent table. It is passed three arguments:
  93395. **
  93396. ** 1) The complete text of the CREATE TABLE statement being modified,
  93397. ** 2) The old name of the table being renamed, and
  93398. ** 3) The new name of the table being renamed.
  93399. **
  93400. ** It returns the new CREATE TABLE statement. For example:
  93401. **
  93402. ** sqlite_rename_parent('CREATE TABLE t1(a REFERENCES t2)', 't2', 't3')
  93403. ** -> 'CREATE TABLE t1(a REFERENCES t3)'
  93404. */
  93405. #ifndef SQLITE_OMIT_FOREIGN_KEY
  93406. static void renameParentFunc(
  93407. sqlite3_context *context,
  93408. int NotUsed,
  93409. sqlite3_value **argv
  93410. ){
  93411. sqlite3 *db = sqlite3_context_db_handle(context);
  93412. char *zOutput = 0;
  93413. char *zResult;
  93414. unsigned char const *zInput = sqlite3_value_text(argv[0]);
  93415. unsigned char const *zOld = sqlite3_value_text(argv[1]);
  93416. unsigned char const *zNew = sqlite3_value_text(argv[2]);
  93417. unsigned const char *z; /* Pointer to token */
  93418. int n; /* Length of token z */
  93419. int token; /* Type of token */
  93420. UNUSED_PARAMETER(NotUsed);
  93421. if( zInput==0 || zOld==0 ) return;
  93422. for(z=zInput; *z; z=z+n){
  93423. n = sqlite3GetToken(z, &token);
  93424. if( token==TK_REFERENCES ){
  93425. char *zParent;
  93426. do {
  93427. z += n;
  93428. n = sqlite3GetToken(z, &token);
  93429. }while( token==TK_SPACE );
  93430. if( token==TK_ILLEGAL ) break;
  93431. zParent = sqlite3DbStrNDup(db, (const char *)z, n);
  93432. if( zParent==0 ) break;
  93433. sqlite3Dequote(zParent);
  93434. if( 0==sqlite3StrICmp((const char *)zOld, zParent) ){
  93435. char *zOut = sqlite3MPrintf(db, "%s%.*s\"%w\"",
  93436. (zOutput?zOutput:""), (int)(z-zInput), zInput, (const char *)zNew
  93437. );
  93438. sqlite3DbFree(db, zOutput);
  93439. zOutput = zOut;
  93440. zInput = &z[n];
  93441. }
  93442. sqlite3DbFree(db, zParent);
  93443. }
  93444. }
  93445. zResult = sqlite3MPrintf(db, "%s%s", (zOutput?zOutput:""), zInput),
  93446. sqlite3_result_text(context, zResult, -1, SQLITE_DYNAMIC);
  93447. sqlite3DbFree(db, zOutput);
  93448. }
  93449. #endif
  93450. #ifndef SQLITE_OMIT_TRIGGER
  93451. /* This function is used by SQL generated to implement the
  93452. ** ALTER TABLE command. The first argument is the text of a CREATE TRIGGER
  93453. ** statement. The second is a table name. The table name in the CREATE
  93454. ** TRIGGER statement is replaced with the third argument and the result
  93455. ** returned. This is analagous to renameTableFunc() above, except for CREATE
  93456. ** TRIGGER, not CREATE INDEX and CREATE TABLE.
  93457. */
  93458. static void renameTriggerFunc(
  93459. sqlite3_context *context,
  93460. int NotUsed,
  93461. sqlite3_value **argv
  93462. ){
  93463. unsigned char const *zSql = sqlite3_value_text(argv[0]);
  93464. unsigned char const *zTableName = sqlite3_value_text(argv[1]);
  93465. int token;
  93466. Token tname;
  93467. int dist = 3;
  93468. unsigned char const *zCsr = zSql;
  93469. int len = 0;
  93470. char *zRet;
  93471. sqlite3 *db = sqlite3_context_db_handle(context);
  93472. UNUSED_PARAMETER(NotUsed);
  93473. /* The principle used to locate the table name in the CREATE TRIGGER
  93474. ** statement is that the table name is the first token that is immediately
  93475. ** preceded by either TK_ON or TK_DOT and immediately followed by one
  93476. ** of TK_WHEN, TK_BEGIN or TK_FOR.
  93477. */
  93478. if( zSql ){
  93479. do {
  93480. if( !*zCsr ){
  93481. /* Ran out of input before finding the table name. Return NULL. */
  93482. return;
  93483. }
  93484. /* Store the token that zCsr points to in tname. */
  93485. tname.z = (char*)zCsr;
  93486. tname.n = len;
  93487. /* Advance zCsr to the next token. Store that token type in 'token',
  93488. ** and its length in 'len' (to be used next iteration of this loop).
  93489. */
  93490. do {
  93491. zCsr += len;
  93492. len = sqlite3GetToken(zCsr, &token);
  93493. }while( token==TK_SPACE );
  93494. assert( len>0 );
  93495. /* Variable 'dist' stores the number of tokens read since the most
  93496. ** recent TK_DOT or TK_ON. This means that when a WHEN, FOR or BEGIN
  93497. ** token is read and 'dist' equals 2, the condition stated above
  93498. ** to be met.
  93499. **
  93500. ** Note that ON cannot be a database, table or column name, so
  93501. ** there is no need to worry about syntax like
  93502. ** "CREATE TRIGGER ... ON ON.ON BEGIN ..." etc.
  93503. */
  93504. dist++;
  93505. if( token==TK_DOT || token==TK_ON ){
  93506. dist = 0;
  93507. }
  93508. } while( dist!=2 || (token!=TK_WHEN && token!=TK_FOR && token!=TK_BEGIN) );
  93509. /* Variable tname now contains the token that is the old table-name
  93510. ** in the CREATE TRIGGER statement.
  93511. */
  93512. zRet = sqlite3MPrintf(db, "%.*s\"%w\"%s", (int)(((u8*)tname.z) - zSql),
  93513. zSql, zTableName, tname.z+tname.n);
  93514. sqlite3_result_text(context, zRet, -1, SQLITE_DYNAMIC);
  93515. }
  93516. }
  93517. #endif /* !SQLITE_OMIT_TRIGGER */
  93518. /*
  93519. ** Register built-in functions used to help implement ALTER TABLE
  93520. */
  93521. SQLITE_PRIVATE void sqlite3AlterFunctions(void){
  93522. static FuncDef aAlterTableFuncs[] = {
  93523. FUNCTION(sqlite_rename_table, 2, 0, 0, renameTableFunc),
  93524. #ifndef SQLITE_OMIT_TRIGGER
  93525. FUNCTION(sqlite_rename_trigger, 2, 0, 0, renameTriggerFunc),
  93526. #endif
  93527. #ifndef SQLITE_OMIT_FOREIGN_KEY
  93528. FUNCTION(sqlite_rename_parent, 3, 0, 0, renameParentFunc),
  93529. #endif
  93530. };
  93531. sqlite3InsertBuiltinFuncs(aAlterTableFuncs, ArraySize(aAlterTableFuncs));
  93532. }
  93533. /*
  93534. ** This function is used to create the text of expressions of the form:
  93535. **
  93536. ** name=<constant1> OR name=<constant2> OR ...
  93537. **
  93538. ** If argument zWhere is NULL, then a pointer string containing the text
  93539. ** "name=<constant>" is returned, where <constant> is the quoted version
  93540. ** of the string passed as argument zConstant. The returned buffer is
  93541. ** allocated using sqlite3DbMalloc(). It is the responsibility of the
  93542. ** caller to ensure that it is eventually freed.
  93543. **
  93544. ** If argument zWhere is not NULL, then the string returned is
  93545. ** "<where> OR name=<constant>", where <where> is the contents of zWhere.
  93546. ** In this case zWhere is passed to sqlite3DbFree() before returning.
  93547. **
  93548. */
  93549. static char *whereOrName(sqlite3 *db, char *zWhere, char *zConstant){
  93550. char *zNew;
  93551. if( !zWhere ){
  93552. zNew = sqlite3MPrintf(db, "name=%Q", zConstant);
  93553. }else{
  93554. zNew = sqlite3MPrintf(db, "%s OR name=%Q", zWhere, zConstant);
  93555. sqlite3DbFree(db, zWhere);
  93556. }
  93557. return zNew;
  93558. }
  93559. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  93560. /*
  93561. ** Generate the text of a WHERE expression which can be used to select all
  93562. ** tables that have foreign key constraints that refer to table pTab (i.e.
  93563. ** constraints for which pTab is the parent table) from the sqlite_master
  93564. ** table.
  93565. */
  93566. static char *whereForeignKeys(Parse *pParse, Table *pTab){
  93567. FKey *p;
  93568. char *zWhere = 0;
  93569. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  93570. zWhere = whereOrName(pParse->db, zWhere, p->pFrom->zName);
  93571. }
  93572. return zWhere;
  93573. }
  93574. #endif
  93575. /*
  93576. ** Generate the text of a WHERE expression which can be used to select all
  93577. ** temporary triggers on table pTab from the sqlite_temp_master table. If
  93578. ** table pTab has no temporary triggers, or is itself stored in the
  93579. ** temporary database, NULL is returned.
  93580. */
  93581. static char *whereTempTriggers(Parse *pParse, Table *pTab){
  93582. Trigger *pTrig;
  93583. char *zWhere = 0;
  93584. const Schema *pTempSchema = pParse->db->aDb[1].pSchema; /* Temp db schema */
  93585. /* If the table is not located in the temp-db (in which case NULL is
  93586. ** returned, loop through the tables list of triggers. For each trigger
  93587. ** that is not part of the temp-db schema, add a clause to the WHERE
  93588. ** expression being built up in zWhere.
  93589. */
  93590. if( pTab->pSchema!=pTempSchema ){
  93591. sqlite3 *db = pParse->db;
  93592. for(pTrig=sqlite3TriggerList(pParse, pTab); pTrig; pTrig=pTrig->pNext){
  93593. if( pTrig->pSchema==pTempSchema ){
  93594. zWhere = whereOrName(db, zWhere, pTrig->zName);
  93595. }
  93596. }
  93597. }
  93598. if( zWhere ){
  93599. char *zNew = sqlite3MPrintf(pParse->db, "type='trigger' AND (%s)", zWhere);
  93600. sqlite3DbFree(pParse->db, zWhere);
  93601. zWhere = zNew;
  93602. }
  93603. return zWhere;
  93604. }
  93605. /*
  93606. ** Generate code to drop and reload the internal representation of table
  93607. ** pTab from the database, including triggers and temporary triggers.
  93608. ** Argument zName is the name of the table in the database schema at
  93609. ** the time the generated code is executed. This can be different from
  93610. ** pTab->zName if this function is being called to code part of an
  93611. ** "ALTER TABLE RENAME TO" statement.
  93612. */
  93613. static void reloadTableSchema(Parse *pParse, Table *pTab, const char *zName){
  93614. Vdbe *v;
  93615. char *zWhere;
  93616. int iDb; /* Index of database containing pTab */
  93617. #ifndef SQLITE_OMIT_TRIGGER
  93618. Trigger *pTrig;
  93619. #endif
  93620. v = sqlite3GetVdbe(pParse);
  93621. if( NEVER(v==0) ) return;
  93622. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  93623. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  93624. assert( iDb>=0 );
  93625. #ifndef SQLITE_OMIT_TRIGGER
  93626. /* Drop any table triggers from the internal schema. */
  93627. for(pTrig=sqlite3TriggerList(pParse, pTab); pTrig; pTrig=pTrig->pNext){
  93628. int iTrigDb = sqlite3SchemaToIndex(pParse->db, pTrig->pSchema);
  93629. assert( iTrigDb==iDb || iTrigDb==1 );
  93630. sqlite3VdbeAddOp4(v, OP_DropTrigger, iTrigDb, 0, 0, pTrig->zName, 0);
  93631. }
  93632. #endif
  93633. /* Drop the table and index from the internal schema. */
  93634. sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
  93635. /* Reload the table, index and permanent trigger schemas. */
  93636. zWhere = sqlite3MPrintf(pParse->db, "tbl_name=%Q", zName);
  93637. if( !zWhere ) return;
  93638. sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere);
  93639. #ifndef SQLITE_OMIT_TRIGGER
  93640. /* Now, if the table is not stored in the temp database, reload any temp
  93641. ** triggers. Don't use IN(...) in case SQLITE_OMIT_SUBQUERY is defined.
  93642. */
  93643. if( (zWhere=whereTempTriggers(pParse, pTab))!=0 ){
  93644. sqlite3VdbeAddParseSchemaOp(v, 1, zWhere);
  93645. }
  93646. #endif
  93647. }
  93648. /*
  93649. ** Parameter zName is the name of a table that is about to be altered
  93650. ** (either with ALTER TABLE ... RENAME TO or ALTER TABLE ... ADD COLUMN).
  93651. ** If the table is a system table, this function leaves an error message
  93652. ** in pParse->zErr (system tables may not be altered) and returns non-zero.
  93653. **
  93654. ** Or, if zName is not a system table, zero is returned.
  93655. */
  93656. static int isSystemTable(Parse *pParse, const char *zName){
  93657. if( 0==sqlite3StrNICmp(zName, "sqlite_", 7) ){
  93658. sqlite3ErrorMsg(pParse, "table %s may not be altered", zName);
  93659. return 1;
  93660. }
  93661. return 0;
  93662. }
  93663. /*
  93664. ** Generate code to implement the "ALTER TABLE xxx RENAME TO yyy"
  93665. ** command.
  93666. */
  93667. SQLITE_PRIVATE void sqlite3AlterRenameTable(
  93668. Parse *pParse, /* Parser context. */
  93669. SrcList *pSrc, /* The table to rename. */
  93670. Token *pName /* The new table name. */
  93671. ){
  93672. int iDb; /* Database that contains the table */
  93673. char *zDb; /* Name of database iDb */
  93674. Table *pTab; /* Table being renamed */
  93675. char *zName = 0; /* NULL-terminated version of pName */
  93676. sqlite3 *db = pParse->db; /* Database connection */
  93677. int nTabName; /* Number of UTF-8 characters in zTabName */
  93678. const char *zTabName; /* Original name of the table */
  93679. Vdbe *v;
  93680. #ifndef SQLITE_OMIT_TRIGGER
  93681. char *zWhere = 0; /* Where clause to locate temp triggers */
  93682. #endif
  93683. VTable *pVTab = 0; /* Non-zero if this is a v-tab with an xRename() */
  93684. u32 savedDbFlags; /* Saved value of db->mDbFlags */
  93685. savedDbFlags = db->mDbFlags;
  93686. if( NEVER(db->mallocFailed) ) goto exit_rename_table;
  93687. assert( pSrc->nSrc==1 );
  93688. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  93689. pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
  93690. if( !pTab ) goto exit_rename_table;
  93691. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  93692. zDb = db->aDb[iDb].zDbSName;
  93693. db->mDbFlags |= DBFLAG_PreferBuiltin;
  93694. /* Get a NULL terminated version of the new table name. */
  93695. zName = sqlite3NameFromToken(db, pName);
  93696. if( !zName ) goto exit_rename_table;
  93697. /* Check that a table or index named 'zName' does not already exist
  93698. ** in database iDb. If so, this is an error.
  93699. */
  93700. if( sqlite3FindTable(db, zName, zDb) || sqlite3FindIndex(db, zName, zDb) ){
  93701. sqlite3ErrorMsg(pParse,
  93702. "there is already another table or index with this name: %s", zName);
  93703. goto exit_rename_table;
  93704. }
  93705. /* Make sure it is not a system table being altered, or a reserved name
  93706. ** that the table is being renamed to.
  93707. */
  93708. if( SQLITE_OK!=isSystemTable(pParse, pTab->zName) ){
  93709. goto exit_rename_table;
  93710. }
  93711. if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){ goto
  93712. exit_rename_table;
  93713. }
  93714. #ifndef SQLITE_OMIT_VIEW
  93715. if( pTab->pSelect ){
  93716. sqlite3ErrorMsg(pParse, "view %s may not be altered", pTab->zName);
  93717. goto exit_rename_table;
  93718. }
  93719. #endif
  93720. #ifndef SQLITE_OMIT_AUTHORIZATION
  93721. /* Invoke the authorization callback. */
  93722. if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
  93723. goto exit_rename_table;
  93724. }
  93725. #endif
  93726. #ifndef SQLITE_OMIT_VIRTUALTABLE
  93727. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  93728. goto exit_rename_table;
  93729. }
  93730. if( IsVirtual(pTab) ){
  93731. pVTab = sqlite3GetVTable(db, pTab);
  93732. if( pVTab->pVtab->pModule->xRename==0 ){
  93733. pVTab = 0;
  93734. }
  93735. }
  93736. #endif
  93737. /* Begin a transaction for database iDb.
  93738. ** Then modify the schema cookie (since the ALTER TABLE modifies the
  93739. ** schema). Open a statement transaction if the table is a virtual
  93740. ** table.
  93741. */
  93742. v = sqlite3GetVdbe(pParse);
  93743. if( v==0 ){
  93744. goto exit_rename_table;
  93745. }
  93746. sqlite3BeginWriteOperation(pParse, pVTab!=0, iDb);
  93747. sqlite3ChangeCookie(pParse, iDb);
  93748. /* If this is a virtual table, invoke the xRename() function if
  93749. ** one is defined. The xRename() callback will modify the names
  93750. ** of any resources used by the v-table implementation (including other
  93751. ** SQLite tables) that are identified by the name of the virtual table.
  93752. */
  93753. #ifndef SQLITE_OMIT_VIRTUALTABLE
  93754. if( pVTab ){
  93755. int i = ++pParse->nMem;
  93756. sqlite3VdbeLoadString(v, i, zName);
  93757. sqlite3VdbeAddOp4(v, OP_VRename, i, 0, 0,(const char*)pVTab, P4_VTAB);
  93758. sqlite3MayAbort(pParse);
  93759. }
  93760. #endif
  93761. /* figure out how many UTF-8 characters are in zName */
  93762. zTabName = pTab->zName;
  93763. nTabName = sqlite3Utf8CharLen(zTabName, -1);
  93764. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  93765. if( db->flags&SQLITE_ForeignKeys ){
  93766. /* If foreign-key support is enabled, rewrite the CREATE TABLE
  93767. ** statements corresponding to all child tables of foreign key constraints
  93768. ** for which the renamed table is the parent table. */
  93769. if( (zWhere=whereForeignKeys(pParse, pTab))!=0 ){
  93770. sqlite3NestedParse(pParse,
  93771. "UPDATE \"%w\".%s SET "
  93772. "sql = sqlite_rename_parent(sql, %Q, %Q) "
  93773. "WHERE %s;", zDb, MASTER_NAME, zTabName, zName, zWhere);
  93774. sqlite3DbFree(db, zWhere);
  93775. }
  93776. }
  93777. #endif
  93778. /* Modify the sqlite_master table to use the new table name. */
  93779. sqlite3NestedParse(pParse,
  93780. "UPDATE %Q.%s SET "
  93781. #ifdef SQLITE_OMIT_TRIGGER
  93782. "sql = sqlite_rename_table(sql, %Q), "
  93783. #else
  93784. "sql = CASE "
  93785. "WHEN type = 'trigger' THEN sqlite_rename_trigger(sql, %Q)"
  93786. "ELSE sqlite_rename_table(sql, %Q) END, "
  93787. #endif
  93788. "tbl_name = %Q, "
  93789. "name = CASE "
  93790. "WHEN type='table' THEN %Q "
  93791. "WHEN name LIKE 'sqlite_autoindex%%' AND type='index' THEN "
  93792. "'sqlite_autoindex_' || %Q || substr(name,%d+18) "
  93793. "ELSE name END "
  93794. "WHERE tbl_name=%Q COLLATE nocase AND "
  93795. "(type='table' OR type='index' OR type='trigger');",
  93796. zDb, MASTER_NAME, zName, zName, zName,
  93797. #ifndef SQLITE_OMIT_TRIGGER
  93798. zName,
  93799. #endif
  93800. zName, nTabName, zTabName
  93801. );
  93802. #ifndef SQLITE_OMIT_AUTOINCREMENT
  93803. /* If the sqlite_sequence table exists in this database, then update
  93804. ** it with the new table name.
  93805. */
  93806. if( sqlite3FindTable(db, "sqlite_sequence", zDb) ){
  93807. sqlite3NestedParse(pParse,
  93808. "UPDATE \"%w\".sqlite_sequence set name = %Q WHERE name = %Q",
  93809. zDb, zName, pTab->zName);
  93810. }
  93811. #endif
  93812. #ifndef SQLITE_OMIT_TRIGGER
  93813. /* If there are TEMP triggers on this table, modify the sqlite_temp_master
  93814. ** table. Don't do this if the table being ALTERed is itself located in
  93815. ** the temp database.
  93816. */
  93817. if( (zWhere=whereTempTriggers(pParse, pTab))!=0 ){
  93818. sqlite3NestedParse(pParse,
  93819. "UPDATE sqlite_temp_master SET "
  93820. "sql = sqlite_rename_trigger(sql, %Q), "
  93821. "tbl_name = %Q "
  93822. "WHERE %s;", zName, zName, zWhere);
  93823. sqlite3DbFree(db, zWhere);
  93824. }
  93825. #endif
  93826. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  93827. if( db->flags&SQLITE_ForeignKeys ){
  93828. FKey *p;
  93829. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  93830. Table *pFrom = p->pFrom;
  93831. if( pFrom!=pTab ){
  93832. reloadTableSchema(pParse, p->pFrom, pFrom->zName);
  93833. }
  93834. }
  93835. }
  93836. #endif
  93837. /* Drop and reload the internal table schema. */
  93838. reloadTableSchema(pParse, pTab, zName);
  93839. exit_rename_table:
  93840. sqlite3SrcListDelete(db, pSrc);
  93841. sqlite3DbFree(db, zName);
  93842. db->mDbFlags = savedDbFlags;
  93843. }
  93844. /*
  93845. ** This function is called after an "ALTER TABLE ... ADD" statement
  93846. ** has been parsed. Argument pColDef contains the text of the new
  93847. ** column definition.
  93848. **
  93849. ** The Table structure pParse->pNewTable was extended to include
  93850. ** the new column during parsing.
  93851. */
  93852. SQLITE_PRIVATE void sqlite3AlterFinishAddColumn(Parse *pParse, Token *pColDef){
  93853. Table *pNew; /* Copy of pParse->pNewTable */
  93854. Table *pTab; /* Table being altered */
  93855. int iDb; /* Database number */
  93856. const char *zDb; /* Database name */
  93857. const char *zTab; /* Table name */
  93858. char *zCol; /* Null-terminated column definition */
  93859. Column *pCol; /* The new column */
  93860. Expr *pDflt; /* Default value for the new column */
  93861. sqlite3 *db; /* The database connection; */
  93862. Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
  93863. int r1; /* Temporary registers */
  93864. db = pParse->db;
  93865. if( pParse->nErr || db->mallocFailed ) return;
  93866. assert( v!=0 );
  93867. pNew = pParse->pNewTable;
  93868. assert( pNew );
  93869. assert( sqlite3BtreeHoldsAllMutexes(db) );
  93870. iDb = sqlite3SchemaToIndex(db, pNew->pSchema);
  93871. zDb = db->aDb[iDb].zDbSName;
  93872. zTab = &pNew->zName[16]; /* Skip the "sqlite_altertab_" prefix on the name */
  93873. pCol = &pNew->aCol[pNew->nCol-1];
  93874. pDflt = pCol->pDflt;
  93875. pTab = sqlite3FindTable(db, zTab, zDb);
  93876. assert( pTab );
  93877. #ifndef SQLITE_OMIT_AUTHORIZATION
  93878. /* Invoke the authorization callback. */
  93879. if( sqlite3AuthCheck(pParse, SQLITE_ALTER_TABLE, zDb, pTab->zName, 0) ){
  93880. return;
  93881. }
  93882. #endif
  93883. /* If the default value for the new column was specified with a
  93884. ** literal NULL, then set pDflt to 0. This simplifies checking
  93885. ** for an SQL NULL default below.
  93886. */
  93887. assert( pDflt==0 || pDflt->op==TK_SPAN );
  93888. if( pDflt && pDflt->pLeft->op==TK_NULL ){
  93889. pDflt = 0;
  93890. }
  93891. /* Check that the new column is not specified as PRIMARY KEY or UNIQUE.
  93892. ** If there is a NOT NULL constraint, then the default value for the
  93893. ** column must not be NULL.
  93894. */
  93895. if( pCol->colFlags & COLFLAG_PRIMKEY ){
  93896. sqlite3ErrorMsg(pParse, "Cannot add a PRIMARY KEY column");
  93897. return;
  93898. }
  93899. if( pNew->pIndex ){
  93900. sqlite3ErrorMsg(pParse, "Cannot add a UNIQUE column");
  93901. return;
  93902. }
  93903. if( (db->flags&SQLITE_ForeignKeys) && pNew->pFKey && pDflt ){
  93904. sqlite3ErrorMsg(pParse,
  93905. "Cannot add a REFERENCES column with non-NULL default value");
  93906. return;
  93907. }
  93908. if( pCol->notNull && !pDflt ){
  93909. sqlite3ErrorMsg(pParse,
  93910. "Cannot add a NOT NULL column with default value NULL");
  93911. return;
  93912. }
  93913. /* Ensure the default expression is something that sqlite3ValueFromExpr()
  93914. ** can handle (i.e. not CURRENT_TIME etc.)
  93915. */
  93916. if( pDflt ){
  93917. sqlite3_value *pVal = 0;
  93918. int rc;
  93919. rc = sqlite3ValueFromExpr(db, pDflt, SQLITE_UTF8, SQLITE_AFF_BLOB, &pVal);
  93920. assert( rc==SQLITE_OK || rc==SQLITE_NOMEM );
  93921. if( rc!=SQLITE_OK ){
  93922. assert( db->mallocFailed == 1 );
  93923. return;
  93924. }
  93925. if( !pVal ){
  93926. sqlite3ErrorMsg(pParse, "Cannot add a column with non-constant default");
  93927. return;
  93928. }
  93929. sqlite3ValueFree(pVal);
  93930. }
  93931. /* Modify the CREATE TABLE statement. */
  93932. zCol = sqlite3DbStrNDup(db, (char*)pColDef->z, pColDef->n);
  93933. if( zCol ){
  93934. char *zEnd = &zCol[pColDef->n-1];
  93935. u32 savedDbFlags = db->mDbFlags;
  93936. while( zEnd>zCol && (*zEnd==';' || sqlite3Isspace(*zEnd)) ){
  93937. *zEnd-- = '\0';
  93938. }
  93939. db->mDbFlags |= DBFLAG_PreferBuiltin;
  93940. sqlite3NestedParse(pParse,
  93941. "UPDATE \"%w\".%s SET "
  93942. "sql = substr(sql,1,%d) || ', ' || %Q || substr(sql,%d) "
  93943. "WHERE type = 'table' AND name = %Q",
  93944. zDb, MASTER_NAME, pNew->addColOffset, zCol, pNew->addColOffset+1,
  93945. zTab
  93946. );
  93947. sqlite3DbFree(db, zCol);
  93948. db->mDbFlags = savedDbFlags;
  93949. }
  93950. /* Make sure the schema version is at least 3. But do not upgrade
  93951. ** from less than 3 to 4, as that will corrupt any preexisting DESC
  93952. ** index.
  93953. */
  93954. r1 = sqlite3GetTempReg(pParse);
  93955. sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, r1, BTREE_FILE_FORMAT);
  93956. sqlite3VdbeUsesBtree(v, iDb);
  93957. sqlite3VdbeAddOp2(v, OP_AddImm, r1, -2);
  93958. sqlite3VdbeAddOp2(v, OP_IfPos, r1, sqlite3VdbeCurrentAddr(v)+2);
  93959. VdbeCoverage(v);
  93960. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, 3);
  93961. sqlite3ReleaseTempReg(pParse, r1);
  93962. /* Reload the schema of the modified table. */
  93963. reloadTableSchema(pParse, pTab, pTab->zName);
  93964. }
  93965. /*
  93966. ** This function is called by the parser after the table-name in
  93967. ** an "ALTER TABLE <table-name> ADD" statement is parsed. Argument
  93968. ** pSrc is the full-name of the table being altered.
  93969. **
  93970. ** This routine makes a (partial) copy of the Table structure
  93971. ** for the table being altered and sets Parse.pNewTable to point
  93972. ** to it. Routines called by the parser as the column definition
  93973. ** is parsed (i.e. sqlite3AddColumn()) add the new Column data to
  93974. ** the copy. The copy of the Table structure is deleted by tokenize.c
  93975. ** after parsing is finished.
  93976. **
  93977. ** Routine sqlite3AlterFinishAddColumn() will be called to complete
  93978. ** coding the "ALTER TABLE ... ADD" statement.
  93979. */
  93980. SQLITE_PRIVATE void sqlite3AlterBeginAddColumn(Parse *pParse, SrcList *pSrc){
  93981. Table *pNew;
  93982. Table *pTab;
  93983. Vdbe *v;
  93984. int iDb;
  93985. int i;
  93986. int nAlloc;
  93987. sqlite3 *db = pParse->db;
  93988. /* Look up the table being altered. */
  93989. assert( pParse->pNewTable==0 );
  93990. assert( sqlite3BtreeHoldsAllMutexes(db) );
  93991. if( db->mallocFailed ) goto exit_begin_add_column;
  93992. pTab = sqlite3LocateTableItem(pParse, 0, &pSrc->a[0]);
  93993. if( !pTab ) goto exit_begin_add_column;
  93994. #ifndef SQLITE_OMIT_VIRTUALTABLE
  93995. if( IsVirtual(pTab) ){
  93996. sqlite3ErrorMsg(pParse, "virtual tables may not be altered");
  93997. goto exit_begin_add_column;
  93998. }
  93999. #endif
  94000. /* Make sure this is not an attempt to ALTER a view. */
  94001. if( pTab->pSelect ){
  94002. sqlite3ErrorMsg(pParse, "Cannot add a column to a view");
  94003. goto exit_begin_add_column;
  94004. }
  94005. if( SQLITE_OK!=isSystemTable(pParse, pTab->zName) ){
  94006. goto exit_begin_add_column;
  94007. }
  94008. assert( pTab->addColOffset>0 );
  94009. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  94010. /* Put a copy of the Table struct in Parse.pNewTable for the
  94011. ** sqlite3AddColumn() function and friends to modify. But modify
  94012. ** the name by adding an "sqlite_altertab_" prefix. By adding this
  94013. ** prefix, we insure that the name will not collide with an existing
  94014. ** table because user table are not allowed to have the "sqlite_"
  94015. ** prefix on their name.
  94016. */
  94017. pNew = (Table*)sqlite3DbMallocZero(db, sizeof(Table));
  94018. if( !pNew ) goto exit_begin_add_column;
  94019. pParse->pNewTable = pNew;
  94020. pNew->nTabRef = 1;
  94021. pNew->nCol = pTab->nCol;
  94022. assert( pNew->nCol>0 );
  94023. nAlloc = (((pNew->nCol-1)/8)*8)+8;
  94024. assert( nAlloc>=pNew->nCol && nAlloc%8==0 && nAlloc-pNew->nCol<8 );
  94025. pNew->aCol = (Column*)sqlite3DbMallocZero(db, sizeof(Column)*nAlloc);
  94026. pNew->zName = sqlite3MPrintf(db, "sqlite_altertab_%s", pTab->zName);
  94027. if( !pNew->aCol || !pNew->zName ){
  94028. assert( db->mallocFailed );
  94029. goto exit_begin_add_column;
  94030. }
  94031. memcpy(pNew->aCol, pTab->aCol, sizeof(Column)*pNew->nCol);
  94032. for(i=0; i<pNew->nCol; i++){
  94033. Column *pCol = &pNew->aCol[i];
  94034. pCol->zName = sqlite3DbStrDup(db, pCol->zName);
  94035. pCol->zColl = 0;
  94036. pCol->pDflt = 0;
  94037. }
  94038. pNew->pSchema = db->aDb[iDb].pSchema;
  94039. pNew->addColOffset = pTab->addColOffset;
  94040. pNew->nTabRef = 1;
  94041. /* Begin a transaction and increment the schema cookie. */
  94042. sqlite3BeginWriteOperation(pParse, 0, iDb);
  94043. v = sqlite3GetVdbe(pParse);
  94044. if( !v ) goto exit_begin_add_column;
  94045. sqlite3ChangeCookie(pParse, iDb);
  94046. exit_begin_add_column:
  94047. sqlite3SrcListDelete(db, pSrc);
  94048. return;
  94049. }
  94050. #endif /* SQLITE_ALTER_TABLE */
  94051. /************** End of alter.c ***********************************************/
  94052. /************** Begin file analyze.c *****************************************/
  94053. /*
  94054. ** 2005-07-08
  94055. **
  94056. ** The author disclaims copyright to this source code. In place of
  94057. ** a legal notice, here is a blessing:
  94058. **
  94059. ** May you do good and not evil.
  94060. ** May you find forgiveness for yourself and forgive others.
  94061. ** May you share freely, never taking more than you give.
  94062. **
  94063. *************************************************************************
  94064. ** This file contains code associated with the ANALYZE command.
  94065. **
  94066. ** The ANALYZE command gather statistics about the content of tables
  94067. ** and indices. These statistics are made available to the query planner
  94068. ** to help it make better decisions about how to perform queries.
  94069. **
  94070. ** The following system tables are or have been supported:
  94071. **
  94072. ** CREATE TABLE sqlite_stat1(tbl, idx, stat);
  94073. ** CREATE TABLE sqlite_stat2(tbl, idx, sampleno, sample);
  94074. ** CREATE TABLE sqlite_stat3(tbl, idx, nEq, nLt, nDLt, sample);
  94075. ** CREATE TABLE sqlite_stat4(tbl, idx, nEq, nLt, nDLt, sample);
  94076. **
  94077. ** Additional tables might be added in future releases of SQLite.
  94078. ** The sqlite_stat2 table is not created or used unless the SQLite version
  94079. ** is between 3.6.18 and 3.7.8, inclusive, and unless SQLite is compiled
  94080. ** with SQLITE_ENABLE_STAT2. The sqlite_stat2 table is deprecated.
  94081. ** The sqlite_stat2 table is superseded by sqlite_stat3, which is only
  94082. ** created and used by SQLite versions 3.7.9 and later and with
  94083. ** SQLITE_ENABLE_STAT3 defined. The functionality of sqlite_stat3
  94084. ** is a superset of sqlite_stat2. The sqlite_stat4 is an enhanced
  94085. ** version of sqlite_stat3 and is only available when compiled with
  94086. ** SQLITE_ENABLE_STAT4 and in SQLite versions 3.8.1 and later. It is
  94087. ** not possible to enable both STAT3 and STAT4 at the same time. If they
  94088. ** are both enabled, then STAT4 takes precedence.
  94089. **
  94090. ** For most applications, sqlite_stat1 provides all the statistics required
  94091. ** for the query planner to make good choices.
  94092. **
  94093. ** Format of sqlite_stat1:
  94094. **
  94095. ** There is normally one row per index, with the index identified by the
  94096. ** name in the idx column. The tbl column is the name of the table to
  94097. ** which the index belongs. In each such row, the stat column will be
  94098. ** a string consisting of a list of integers. The first integer in this
  94099. ** list is the number of rows in the index. (This is the same as the
  94100. ** number of rows in the table, except for partial indices.) The second
  94101. ** integer is the average number of rows in the index that have the same
  94102. ** value in the first column of the index. The third integer is the average
  94103. ** number of rows in the index that have the same value for the first two
  94104. ** columns. The N-th integer (for N>1) is the average number of rows in
  94105. ** the index which have the same value for the first N-1 columns. For
  94106. ** a K-column index, there will be K+1 integers in the stat column. If
  94107. ** the index is unique, then the last integer will be 1.
  94108. **
  94109. ** The list of integers in the stat column can optionally be followed
  94110. ** by the keyword "unordered". The "unordered" keyword, if it is present,
  94111. ** must be separated from the last integer by a single space. If the
  94112. ** "unordered" keyword is present, then the query planner assumes that
  94113. ** the index is unordered and will not use the index for a range query.
  94114. **
  94115. ** If the sqlite_stat1.idx column is NULL, then the sqlite_stat1.stat
  94116. ** column contains a single integer which is the (estimated) number of
  94117. ** rows in the table identified by sqlite_stat1.tbl.
  94118. **
  94119. ** Format of sqlite_stat2:
  94120. **
  94121. ** The sqlite_stat2 is only created and is only used if SQLite is compiled
  94122. ** with SQLITE_ENABLE_STAT2 and if the SQLite version number is between
  94123. ** 3.6.18 and 3.7.8. The "stat2" table contains additional information
  94124. ** about the distribution of keys within an index. The index is identified by
  94125. ** the "idx" column and the "tbl" column is the name of the table to which
  94126. ** the index belongs. There are usually 10 rows in the sqlite_stat2
  94127. ** table for each index.
  94128. **
  94129. ** The sqlite_stat2 entries for an index that have sampleno between 0 and 9
  94130. ** inclusive are samples of the left-most key value in the index taken at
  94131. ** evenly spaced points along the index. Let the number of samples be S
  94132. ** (10 in the standard build) and let C be the number of rows in the index.
  94133. ** Then the sampled rows are given by:
  94134. **
  94135. ** rownumber = (i*C*2 + C)/(S*2)
  94136. **
  94137. ** For i between 0 and S-1. Conceptually, the index space is divided into
  94138. ** S uniform buckets and the samples are the middle row from each bucket.
  94139. **
  94140. ** The format for sqlite_stat2 is recorded here for legacy reference. This
  94141. ** version of SQLite does not support sqlite_stat2. It neither reads nor
  94142. ** writes the sqlite_stat2 table. This version of SQLite only supports
  94143. ** sqlite_stat3.
  94144. **
  94145. ** Format for sqlite_stat3:
  94146. **
  94147. ** The sqlite_stat3 format is a subset of sqlite_stat4. Hence, the
  94148. ** sqlite_stat4 format will be described first. Further information
  94149. ** about sqlite_stat3 follows the sqlite_stat4 description.
  94150. **
  94151. ** Format for sqlite_stat4:
  94152. **
  94153. ** As with sqlite_stat2, the sqlite_stat4 table contains histogram data
  94154. ** to aid the query planner in choosing good indices based on the values
  94155. ** that indexed columns are compared against in the WHERE clauses of
  94156. ** queries.
  94157. **
  94158. ** The sqlite_stat4 table contains multiple entries for each index.
  94159. ** The idx column names the index and the tbl column is the table of the
  94160. ** index. If the idx and tbl columns are the same, then the sample is
  94161. ** of the INTEGER PRIMARY KEY. The sample column is a blob which is the
  94162. ** binary encoding of a key from the index. The nEq column is a
  94163. ** list of integers. The first integer is the approximate number
  94164. ** of entries in the index whose left-most column exactly matches
  94165. ** the left-most column of the sample. The second integer in nEq
  94166. ** is the approximate number of entries in the index where the
  94167. ** first two columns match the first two columns of the sample.
  94168. ** And so forth. nLt is another list of integers that show the approximate
  94169. ** number of entries that are strictly less than the sample. The first
  94170. ** integer in nLt contains the number of entries in the index where the
  94171. ** left-most column is less than the left-most column of the sample.
  94172. ** The K-th integer in the nLt entry is the number of index entries
  94173. ** where the first K columns are less than the first K columns of the
  94174. ** sample. The nDLt column is like nLt except that it contains the
  94175. ** number of distinct entries in the index that are less than the
  94176. ** sample.
  94177. **
  94178. ** There can be an arbitrary number of sqlite_stat4 entries per index.
  94179. ** The ANALYZE command will typically generate sqlite_stat4 tables
  94180. ** that contain between 10 and 40 samples which are distributed across
  94181. ** the key space, though not uniformly, and which include samples with
  94182. ** large nEq values.
  94183. **
  94184. ** Format for sqlite_stat3 redux:
  94185. **
  94186. ** The sqlite_stat3 table is like sqlite_stat4 except that it only
  94187. ** looks at the left-most column of the index. The sqlite_stat3.sample
  94188. ** column contains the actual value of the left-most column instead
  94189. ** of a blob encoding of the complete index key as is found in
  94190. ** sqlite_stat4.sample. The nEq, nLt, and nDLt entries of sqlite_stat3
  94191. ** all contain just a single integer which is the same as the first
  94192. ** integer in the equivalent columns in sqlite_stat4.
  94193. */
  94194. #ifndef SQLITE_OMIT_ANALYZE
  94195. /* #include "sqliteInt.h" */
  94196. #if defined(SQLITE_ENABLE_STAT4)
  94197. # define IsStat4 1
  94198. # define IsStat3 0
  94199. #elif defined(SQLITE_ENABLE_STAT3)
  94200. # define IsStat4 0
  94201. # define IsStat3 1
  94202. #else
  94203. # define IsStat4 0
  94204. # define IsStat3 0
  94205. # undef SQLITE_STAT4_SAMPLES
  94206. # define SQLITE_STAT4_SAMPLES 1
  94207. #endif
  94208. #define IsStat34 (IsStat3+IsStat4) /* 1 for STAT3 or STAT4. 0 otherwise */
  94209. /*
  94210. ** This routine generates code that opens the sqlite_statN tables.
  94211. ** The sqlite_stat1 table is always relevant. sqlite_stat2 is now
  94212. ** obsolete. sqlite_stat3 and sqlite_stat4 are only opened when
  94213. ** appropriate compile-time options are provided.
  94214. **
  94215. ** If the sqlite_statN tables do not previously exist, it is created.
  94216. **
  94217. ** Argument zWhere may be a pointer to a buffer containing a table name,
  94218. ** or it may be a NULL pointer. If it is not NULL, then all entries in
  94219. ** the sqlite_statN tables associated with the named table are deleted.
  94220. ** If zWhere==0, then code is generated to delete all stat table entries.
  94221. */
  94222. static void openStatTable(
  94223. Parse *pParse, /* Parsing context */
  94224. int iDb, /* The database we are looking in */
  94225. int iStatCur, /* Open the sqlite_stat1 table on this cursor */
  94226. const char *zWhere, /* Delete entries for this table or index */
  94227. const char *zWhereType /* Either "tbl" or "idx" */
  94228. ){
  94229. static const struct {
  94230. const char *zName;
  94231. const char *zCols;
  94232. } aTable[] = {
  94233. { "sqlite_stat1", "tbl,idx,stat" },
  94234. #if defined(SQLITE_ENABLE_STAT4)
  94235. { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
  94236. { "sqlite_stat3", 0 },
  94237. #elif defined(SQLITE_ENABLE_STAT3)
  94238. { "sqlite_stat3", "tbl,idx,neq,nlt,ndlt,sample" },
  94239. { "sqlite_stat4", 0 },
  94240. #else
  94241. { "sqlite_stat3", 0 },
  94242. { "sqlite_stat4", 0 },
  94243. #endif
  94244. };
  94245. int i;
  94246. sqlite3 *db = pParse->db;
  94247. Db *pDb;
  94248. Vdbe *v = sqlite3GetVdbe(pParse);
  94249. int aRoot[ArraySize(aTable)];
  94250. u8 aCreateTbl[ArraySize(aTable)];
  94251. if( v==0 ) return;
  94252. assert( sqlite3BtreeHoldsAllMutexes(db) );
  94253. assert( sqlite3VdbeDb(v)==db );
  94254. pDb = &db->aDb[iDb];
  94255. /* Create new statistic tables if they do not exist, or clear them
  94256. ** if they do already exist.
  94257. */
  94258. for(i=0; i<ArraySize(aTable); i++){
  94259. const char *zTab = aTable[i].zName;
  94260. Table *pStat;
  94261. if( (pStat = sqlite3FindTable(db, zTab, pDb->zDbSName))==0 ){
  94262. if( aTable[i].zCols ){
  94263. /* The sqlite_statN table does not exist. Create it. Note that a
  94264. ** side-effect of the CREATE TABLE statement is to leave the rootpage
  94265. ** of the new table in register pParse->regRoot. This is important
  94266. ** because the OpenWrite opcode below will be needing it. */
  94267. sqlite3NestedParse(pParse,
  94268. "CREATE TABLE %Q.%s(%s)", pDb->zDbSName, zTab, aTable[i].zCols
  94269. );
  94270. aRoot[i] = pParse->regRoot;
  94271. aCreateTbl[i] = OPFLAG_P2ISREG;
  94272. }
  94273. }else{
  94274. /* The table already exists. If zWhere is not NULL, delete all entries
  94275. ** associated with the table zWhere. If zWhere is NULL, delete the
  94276. ** entire contents of the table. */
  94277. aRoot[i] = pStat->tnum;
  94278. aCreateTbl[i] = 0;
  94279. sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
  94280. if( zWhere ){
  94281. sqlite3NestedParse(pParse,
  94282. "DELETE FROM %Q.%s WHERE %s=%Q",
  94283. pDb->zDbSName, zTab, zWhereType, zWhere
  94284. );
  94285. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  94286. }else if( db->xPreUpdateCallback ){
  94287. sqlite3NestedParse(pParse, "DELETE FROM %Q.%s", pDb->zDbSName, zTab);
  94288. #endif
  94289. }else{
  94290. /* The sqlite_stat[134] table already exists. Delete all rows. */
  94291. sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
  94292. }
  94293. }
  94294. }
  94295. /* Open the sqlite_stat[134] tables for writing. */
  94296. for(i=0; aTable[i].zCols; i++){
  94297. assert( i<ArraySize(aTable) );
  94298. sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb, 3);
  94299. sqlite3VdbeChangeP5(v, aCreateTbl[i]);
  94300. VdbeComment((v, aTable[i].zName));
  94301. }
  94302. }
  94303. /*
  94304. ** Recommended number of samples for sqlite_stat4
  94305. */
  94306. #ifndef SQLITE_STAT4_SAMPLES
  94307. # define SQLITE_STAT4_SAMPLES 24
  94308. #endif
  94309. /*
  94310. ** Three SQL functions - stat_init(), stat_push(), and stat_get() -
  94311. ** share an instance of the following structure to hold their state
  94312. ** information.
  94313. */
  94314. typedef struct Stat4Accum Stat4Accum;
  94315. typedef struct Stat4Sample Stat4Sample;
  94316. struct Stat4Sample {
  94317. tRowcnt *anEq; /* sqlite_stat4.nEq */
  94318. tRowcnt *anDLt; /* sqlite_stat4.nDLt */
  94319. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94320. tRowcnt *anLt; /* sqlite_stat4.nLt */
  94321. union {
  94322. i64 iRowid; /* Rowid in main table of the key */
  94323. u8 *aRowid; /* Key for WITHOUT ROWID tables */
  94324. } u;
  94325. u32 nRowid; /* Sizeof aRowid[] */
  94326. u8 isPSample; /* True if a periodic sample */
  94327. int iCol; /* If !isPSample, the reason for inclusion */
  94328. u32 iHash; /* Tiebreaker hash */
  94329. #endif
  94330. };
  94331. struct Stat4Accum {
  94332. tRowcnt nRow; /* Number of rows in the entire table */
  94333. tRowcnt nPSample; /* How often to do a periodic sample */
  94334. int nCol; /* Number of columns in index + pk/rowid */
  94335. int nKeyCol; /* Number of index columns w/o the pk/rowid */
  94336. int mxSample; /* Maximum number of samples to accumulate */
  94337. Stat4Sample current; /* Current row as a Stat4Sample */
  94338. u32 iPrn; /* Pseudo-random number used for sampling */
  94339. Stat4Sample *aBest; /* Array of nCol best samples */
  94340. int iMin; /* Index in a[] of entry with minimum score */
  94341. int nSample; /* Current number of samples */
  94342. int nMaxEqZero; /* Max leading 0 in anEq[] for any a[] entry */
  94343. int iGet; /* Index of current sample accessed by stat_get() */
  94344. Stat4Sample *a; /* Array of mxSample Stat4Sample objects */
  94345. sqlite3 *db; /* Database connection, for malloc() */
  94346. };
  94347. /* Reclaim memory used by a Stat4Sample
  94348. */
  94349. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94350. static void sampleClear(sqlite3 *db, Stat4Sample *p){
  94351. assert( db!=0 );
  94352. if( p->nRowid ){
  94353. sqlite3DbFree(db, p->u.aRowid);
  94354. p->nRowid = 0;
  94355. }
  94356. }
  94357. #endif
  94358. /* Initialize the BLOB value of a ROWID
  94359. */
  94360. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94361. static void sampleSetRowid(sqlite3 *db, Stat4Sample *p, int n, const u8 *pData){
  94362. assert( db!=0 );
  94363. if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
  94364. p->u.aRowid = sqlite3DbMallocRawNN(db, n);
  94365. if( p->u.aRowid ){
  94366. p->nRowid = n;
  94367. memcpy(p->u.aRowid, pData, n);
  94368. }else{
  94369. p->nRowid = 0;
  94370. }
  94371. }
  94372. #endif
  94373. /* Initialize the INTEGER value of a ROWID.
  94374. */
  94375. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94376. static void sampleSetRowidInt64(sqlite3 *db, Stat4Sample *p, i64 iRowid){
  94377. assert( db!=0 );
  94378. if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
  94379. p->nRowid = 0;
  94380. p->u.iRowid = iRowid;
  94381. }
  94382. #endif
  94383. /*
  94384. ** Copy the contents of object (*pFrom) into (*pTo).
  94385. */
  94386. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94387. static void sampleCopy(Stat4Accum *p, Stat4Sample *pTo, Stat4Sample *pFrom){
  94388. pTo->isPSample = pFrom->isPSample;
  94389. pTo->iCol = pFrom->iCol;
  94390. pTo->iHash = pFrom->iHash;
  94391. memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
  94392. memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
  94393. memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
  94394. if( pFrom->nRowid ){
  94395. sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
  94396. }else{
  94397. sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
  94398. }
  94399. }
  94400. #endif
  94401. /*
  94402. ** Reclaim all memory of a Stat4Accum structure.
  94403. */
  94404. static void stat4Destructor(void *pOld){
  94405. Stat4Accum *p = (Stat4Accum*)pOld;
  94406. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94407. int i;
  94408. for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
  94409. for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
  94410. sampleClear(p->db, &p->current);
  94411. #endif
  94412. sqlite3DbFree(p->db, p);
  94413. }
  94414. /*
  94415. ** Implementation of the stat_init(N,K,C) SQL function. The three parameters
  94416. ** are:
  94417. ** N: The number of columns in the index including the rowid/pk (note 1)
  94418. ** K: The number of columns in the index excluding the rowid/pk.
  94419. ** C: The number of rows in the index (note 2)
  94420. **
  94421. ** Note 1: In the special case of the covering index that implements a
  94422. ** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
  94423. ** total number of columns in the table.
  94424. **
  94425. ** Note 2: C is only used for STAT3 and STAT4.
  94426. **
  94427. ** For indexes on ordinary rowid tables, N==K+1. But for indexes on
  94428. ** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
  94429. ** PRIMARY KEY of the table. The covering index that implements the
  94430. ** original WITHOUT ROWID table as N==K as a special case.
  94431. **
  94432. ** This routine allocates the Stat4Accum object in heap memory. The return
  94433. ** value is a pointer to the Stat4Accum object. The datatype of the
  94434. ** return value is BLOB, but it is really just a pointer to the Stat4Accum
  94435. ** object.
  94436. */
  94437. static void statInit(
  94438. sqlite3_context *context,
  94439. int argc,
  94440. sqlite3_value **argv
  94441. ){
  94442. Stat4Accum *p;
  94443. int nCol; /* Number of columns in index being sampled */
  94444. int nKeyCol; /* Number of key columns */
  94445. int nColUp; /* nCol rounded up for alignment */
  94446. int n; /* Bytes of space to allocate */
  94447. sqlite3 *db; /* Database connection */
  94448. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94449. int mxSample = SQLITE_STAT4_SAMPLES;
  94450. #endif
  94451. /* Decode the three function arguments */
  94452. UNUSED_PARAMETER(argc);
  94453. nCol = sqlite3_value_int(argv[0]);
  94454. assert( nCol>0 );
  94455. nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
  94456. nKeyCol = sqlite3_value_int(argv[1]);
  94457. assert( nKeyCol<=nCol );
  94458. assert( nKeyCol>0 );
  94459. /* Allocate the space required for the Stat4Accum object */
  94460. n = sizeof(*p)
  94461. + sizeof(tRowcnt)*nColUp /* Stat4Accum.anEq */
  94462. + sizeof(tRowcnt)*nColUp /* Stat4Accum.anDLt */
  94463. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94464. + sizeof(tRowcnt)*nColUp /* Stat4Accum.anLt */
  94465. + sizeof(Stat4Sample)*(nCol+mxSample) /* Stat4Accum.aBest[], a[] */
  94466. + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
  94467. #endif
  94468. ;
  94469. db = sqlite3_context_db_handle(context);
  94470. p = sqlite3DbMallocZero(db, n);
  94471. if( p==0 ){
  94472. sqlite3_result_error_nomem(context);
  94473. return;
  94474. }
  94475. p->db = db;
  94476. p->nRow = 0;
  94477. p->nCol = nCol;
  94478. p->nKeyCol = nKeyCol;
  94479. p->current.anDLt = (tRowcnt*)&p[1];
  94480. p->current.anEq = &p->current.anDLt[nColUp];
  94481. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94482. {
  94483. u8 *pSpace; /* Allocated space not yet assigned */
  94484. int i; /* Used to iterate through p->aSample[] */
  94485. p->iGet = -1;
  94486. p->mxSample = mxSample;
  94487. p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
  94488. p->current.anLt = &p->current.anEq[nColUp];
  94489. p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
  94490. /* Set up the Stat4Accum.a[] and aBest[] arrays */
  94491. p->a = (struct Stat4Sample*)&p->current.anLt[nColUp];
  94492. p->aBest = &p->a[mxSample];
  94493. pSpace = (u8*)(&p->a[mxSample+nCol]);
  94494. for(i=0; i<(mxSample+nCol); i++){
  94495. p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
  94496. p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
  94497. p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
  94498. }
  94499. assert( (pSpace - (u8*)p)==n );
  94500. for(i=0; i<nCol; i++){
  94501. p->aBest[i].iCol = i;
  94502. }
  94503. }
  94504. #endif
  94505. /* Return a pointer to the allocated object to the caller. Note that
  94506. ** only the pointer (the 2nd parameter) matters. The size of the object
  94507. ** (given by the 3rd parameter) is never used and can be any positive
  94508. ** value. */
  94509. sqlite3_result_blob(context, p, sizeof(*p), stat4Destructor);
  94510. }
  94511. static const FuncDef statInitFuncdef = {
  94512. 2+IsStat34, /* nArg */
  94513. SQLITE_UTF8, /* funcFlags */
  94514. 0, /* pUserData */
  94515. 0, /* pNext */
  94516. statInit, /* xSFunc */
  94517. 0, /* xFinalize */
  94518. "stat_init", /* zName */
  94519. {0}
  94520. };
  94521. #ifdef SQLITE_ENABLE_STAT4
  94522. /*
  94523. ** pNew and pOld are both candidate non-periodic samples selected for
  94524. ** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
  94525. ** considering only any trailing columns and the sample hash value, this
  94526. ** function returns true if sample pNew is to be preferred over pOld.
  94527. ** In other words, if we assume that the cardinalities of the selected
  94528. ** column for pNew and pOld are equal, is pNew to be preferred over pOld.
  94529. **
  94530. ** This function assumes that for each argument sample, the contents of
  94531. ** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
  94532. */
  94533. static int sampleIsBetterPost(
  94534. Stat4Accum *pAccum,
  94535. Stat4Sample *pNew,
  94536. Stat4Sample *pOld
  94537. ){
  94538. int nCol = pAccum->nCol;
  94539. int i;
  94540. assert( pNew->iCol==pOld->iCol );
  94541. for(i=pNew->iCol+1; i<nCol; i++){
  94542. if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
  94543. if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
  94544. }
  94545. if( pNew->iHash>pOld->iHash ) return 1;
  94546. return 0;
  94547. }
  94548. #endif
  94549. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94550. /*
  94551. ** Return true if pNew is to be preferred over pOld.
  94552. **
  94553. ** This function assumes that for each argument sample, the contents of
  94554. ** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
  94555. */
  94556. static int sampleIsBetter(
  94557. Stat4Accum *pAccum,
  94558. Stat4Sample *pNew,
  94559. Stat4Sample *pOld
  94560. ){
  94561. tRowcnt nEqNew = pNew->anEq[pNew->iCol];
  94562. tRowcnt nEqOld = pOld->anEq[pOld->iCol];
  94563. assert( pOld->isPSample==0 && pNew->isPSample==0 );
  94564. assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
  94565. if( (nEqNew>nEqOld) ) return 1;
  94566. #ifdef SQLITE_ENABLE_STAT4
  94567. if( nEqNew==nEqOld ){
  94568. if( pNew->iCol<pOld->iCol ) return 1;
  94569. return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
  94570. }
  94571. return 0;
  94572. #else
  94573. return (nEqNew==nEqOld && pNew->iHash>pOld->iHash);
  94574. #endif
  94575. }
  94576. /*
  94577. ** Copy the contents of sample *pNew into the p->a[] array. If necessary,
  94578. ** remove the least desirable sample from p->a[] to make room.
  94579. */
  94580. static void sampleInsert(Stat4Accum *p, Stat4Sample *pNew, int nEqZero){
  94581. Stat4Sample *pSample = 0;
  94582. int i;
  94583. assert( IsStat4 || nEqZero==0 );
  94584. #ifdef SQLITE_ENABLE_STAT4
  94585. /* Stat4Accum.nMaxEqZero is set to the maximum number of leading 0
  94586. ** values in the anEq[] array of any sample in Stat4Accum.a[]. In
  94587. ** other words, if nMaxEqZero is n, then it is guaranteed that there
  94588. ** are no samples with Stat4Sample.anEq[m]==0 for (m>=n). */
  94589. if( nEqZero>p->nMaxEqZero ){
  94590. p->nMaxEqZero = nEqZero;
  94591. }
  94592. if( pNew->isPSample==0 ){
  94593. Stat4Sample *pUpgrade = 0;
  94594. assert( pNew->anEq[pNew->iCol]>0 );
  94595. /* This sample is being added because the prefix that ends in column
  94596. ** iCol occurs many times in the table. However, if we have already
  94597. ** added a sample that shares this prefix, there is no need to add
  94598. ** this one. Instead, upgrade the priority of the highest priority
  94599. ** existing sample that shares this prefix. */
  94600. for(i=p->nSample-1; i>=0; i--){
  94601. Stat4Sample *pOld = &p->a[i];
  94602. if( pOld->anEq[pNew->iCol]==0 ){
  94603. if( pOld->isPSample ) return;
  94604. assert( pOld->iCol>pNew->iCol );
  94605. assert( sampleIsBetter(p, pNew, pOld) );
  94606. if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
  94607. pUpgrade = pOld;
  94608. }
  94609. }
  94610. }
  94611. if( pUpgrade ){
  94612. pUpgrade->iCol = pNew->iCol;
  94613. pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
  94614. goto find_new_min;
  94615. }
  94616. }
  94617. #endif
  94618. /* If necessary, remove sample iMin to make room for the new sample. */
  94619. if( p->nSample>=p->mxSample ){
  94620. Stat4Sample *pMin = &p->a[p->iMin];
  94621. tRowcnt *anEq = pMin->anEq;
  94622. tRowcnt *anLt = pMin->anLt;
  94623. tRowcnt *anDLt = pMin->anDLt;
  94624. sampleClear(p->db, pMin);
  94625. memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
  94626. pSample = &p->a[p->nSample-1];
  94627. pSample->nRowid = 0;
  94628. pSample->anEq = anEq;
  94629. pSample->anDLt = anDLt;
  94630. pSample->anLt = anLt;
  94631. p->nSample = p->mxSample-1;
  94632. }
  94633. /* The "rows less-than" for the rowid column must be greater than that
  94634. ** for the last sample in the p->a[] array. Otherwise, the samples would
  94635. ** be out of order. */
  94636. #ifdef SQLITE_ENABLE_STAT4
  94637. assert( p->nSample==0
  94638. || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
  94639. #endif
  94640. /* Insert the new sample */
  94641. pSample = &p->a[p->nSample];
  94642. sampleCopy(p, pSample, pNew);
  94643. p->nSample++;
  94644. /* Zero the first nEqZero entries in the anEq[] array. */
  94645. memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
  94646. #ifdef SQLITE_ENABLE_STAT4
  94647. find_new_min:
  94648. #endif
  94649. if( p->nSample>=p->mxSample ){
  94650. int iMin = -1;
  94651. for(i=0; i<p->mxSample; i++){
  94652. if( p->a[i].isPSample ) continue;
  94653. if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
  94654. iMin = i;
  94655. }
  94656. }
  94657. assert( iMin>=0 );
  94658. p->iMin = iMin;
  94659. }
  94660. }
  94661. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  94662. /*
  94663. ** Field iChng of the index being scanned has changed. So at this point
  94664. ** p->current contains a sample that reflects the previous row of the
  94665. ** index. The value of anEq[iChng] and subsequent anEq[] elements are
  94666. ** correct at this point.
  94667. */
  94668. static void samplePushPrevious(Stat4Accum *p, int iChng){
  94669. #ifdef SQLITE_ENABLE_STAT4
  94670. int i;
  94671. /* Check if any samples from the aBest[] array should be pushed
  94672. ** into IndexSample.a[] at this point. */
  94673. for(i=(p->nCol-2); i>=iChng; i--){
  94674. Stat4Sample *pBest = &p->aBest[i];
  94675. pBest->anEq[i] = p->current.anEq[i];
  94676. if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
  94677. sampleInsert(p, pBest, i);
  94678. }
  94679. }
  94680. /* Check that no sample contains an anEq[] entry with an index of
  94681. ** p->nMaxEqZero or greater set to zero. */
  94682. for(i=p->nSample-1; i>=0; i--){
  94683. int j;
  94684. for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
  94685. }
  94686. /* Update the anEq[] fields of any samples already collected. */
  94687. if( iChng<p->nMaxEqZero ){
  94688. for(i=p->nSample-1; i>=0; i--){
  94689. int j;
  94690. for(j=iChng; j<p->nCol; j++){
  94691. if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
  94692. }
  94693. }
  94694. p->nMaxEqZero = iChng;
  94695. }
  94696. #endif
  94697. #if defined(SQLITE_ENABLE_STAT3) && !defined(SQLITE_ENABLE_STAT4)
  94698. if( iChng==0 ){
  94699. tRowcnt nLt = p->current.anLt[0];
  94700. tRowcnt nEq = p->current.anEq[0];
  94701. /* Check if this is to be a periodic sample. If so, add it. */
  94702. if( (nLt/p->nPSample)!=(nLt+nEq)/p->nPSample ){
  94703. p->current.isPSample = 1;
  94704. sampleInsert(p, &p->current, 0);
  94705. p->current.isPSample = 0;
  94706. }else
  94707. /* Or if it is a non-periodic sample. Add it in this case too. */
  94708. if( p->nSample<p->mxSample
  94709. || sampleIsBetter(p, &p->current, &p->a[p->iMin])
  94710. ){
  94711. sampleInsert(p, &p->current, 0);
  94712. }
  94713. }
  94714. #endif
  94715. #ifndef SQLITE_ENABLE_STAT3_OR_STAT4
  94716. UNUSED_PARAMETER( p );
  94717. UNUSED_PARAMETER( iChng );
  94718. #endif
  94719. }
  94720. /*
  94721. ** Implementation of the stat_push SQL function: stat_push(P,C,R)
  94722. ** Arguments:
  94723. **
  94724. ** P Pointer to the Stat4Accum object created by stat_init()
  94725. ** C Index of left-most column to differ from previous row
  94726. ** R Rowid for the current row. Might be a key record for
  94727. ** WITHOUT ROWID tables.
  94728. **
  94729. ** This SQL function always returns NULL. It's purpose it to accumulate
  94730. ** statistical data and/or samples in the Stat4Accum object about the
  94731. ** index being analyzed. The stat_get() SQL function will later be used to
  94732. ** extract relevant information for constructing the sqlite_statN tables.
  94733. **
  94734. ** The R parameter is only used for STAT3 and STAT4
  94735. */
  94736. static void statPush(
  94737. sqlite3_context *context,
  94738. int argc,
  94739. sqlite3_value **argv
  94740. ){
  94741. int i;
  94742. /* The three function arguments */
  94743. Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
  94744. int iChng = sqlite3_value_int(argv[1]);
  94745. UNUSED_PARAMETER( argc );
  94746. UNUSED_PARAMETER( context );
  94747. assert( p->nCol>0 );
  94748. assert( iChng<p->nCol );
  94749. if( p->nRow==0 ){
  94750. /* This is the first call to this function. Do initialization. */
  94751. for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
  94752. }else{
  94753. /* Second and subsequent calls get processed here */
  94754. samplePushPrevious(p, iChng);
  94755. /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
  94756. ** to the current row of the index. */
  94757. for(i=0; i<iChng; i++){
  94758. p->current.anEq[i]++;
  94759. }
  94760. for(i=iChng; i<p->nCol; i++){
  94761. p->current.anDLt[i]++;
  94762. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94763. p->current.anLt[i] += p->current.anEq[i];
  94764. #endif
  94765. p->current.anEq[i] = 1;
  94766. }
  94767. }
  94768. p->nRow++;
  94769. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94770. if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
  94771. sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
  94772. }else{
  94773. sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
  94774. sqlite3_value_blob(argv[2]));
  94775. }
  94776. p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
  94777. #endif
  94778. #ifdef SQLITE_ENABLE_STAT4
  94779. {
  94780. tRowcnt nLt = p->current.anLt[p->nCol-1];
  94781. /* Check if this is to be a periodic sample. If so, add it. */
  94782. if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
  94783. p->current.isPSample = 1;
  94784. p->current.iCol = 0;
  94785. sampleInsert(p, &p->current, p->nCol-1);
  94786. p->current.isPSample = 0;
  94787. }
  94788. /* Update the aBest[] array. */
  94789. for(i=0; i<(p->nCol-1); i++){
  94790. p->current.iCol = i;
  94791. if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
  94792. sampleCopy(p, &p->aBest[i], &p->current);
  94793. }
  94794. }
  94795. }
  94796. #endif
  94797. }
  94798. static const FuncDef statPushFuncdef = {
  94799. 2+IsStat34, /* nArg */
  94800. SQLITE_UTF8, /* funcFlags */
  94801. 0, /* pUserData */
  94802. 0, /* pNext */
  94803. statPush, /* xSFunc */
  94804. 0, /* xFinalize */
  94805. "stat_push", /* zName */
  94806. {0}
  94807. };
  94808. #define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
  94809. #define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
  94810. #define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
  94811. #define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
  94812. #define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
  94813. /*
  94814. ** Implementation of the stat_get(P,J) SQL function. This routine is
  94815. ** used to query statistical information that has been gathered into
  94816. ** the Stat4Accum object by prior calls to stat_push(). The P parameter
  94817. ** has type BLOB but it is really just a pointer to the Stat4Accum object.
  94818. ** The content to returned is determined by the parameter J
  94819. ** which is one of the STAT_GET_xxxx values defined above.
  94820. **
  94821. ** The stat_get(P,J) function is not available to generic SQL. It is
  94822. ** inserted as part of a manually constructed bytecode program. (See
  94823. ** the callStatGet() routine below.) It is guaranteed that the P
  94824. ** parameter will always be a poiner to a Stat4Accum object, never a
  94825. ** NULL.
  94826. **
  94827. ** If neither STAT3 nor STAT4 are enabled, then J is always
  94828. ** STAT_GET_STAT1 and is hence omitted and this routine becomes
  94829. ** a one-parameter function, stat_get(P), that always returns the
  94830. ** stat1 table entry information.
  94831. */
  94832. static void statGet(
  94833. sqlite3_context *context,
  94834. int argc,
  94835. sqlite3_value **argv
  94836. ){
  94837. Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
  94838. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94839. /* STAT3 and STAT4 have a parameter on this routine. */
  94840. int eCall = sqlite3_value_int(argv[1]);
  94841. assert( argc==2 );
  94842. assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
  94843. || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
  94844. || eCall==STAT_GET_NDLT
  94845. );
  94846. if( eCall==STAT_GET_STAT1 )
  94847. #else
  94848. assert( argc==1 );
  94849. #endif
  94850. {
  94851. /* Return the value to store in the "stat" column of the sqlite_stat1
  94852. ** table for this index.
  94853. **
  94854. ** The value is a string composed of a list of integers describing
  94855. ** the index. The first integer in the list is the total number of
  94856. ** entries in the index. There is one additional integer in the list
  94857. ** for each indexed column. This additional integer is an estimate of
  94858. ** the number of rows matched by a stabbing query on the index using
  94859. ** a key with the corresponding number of fields. In other words,
  94860. ** if the index is on columns (a,b) and the sqlite_stat1 value is
  94861. ** "100 10 2", then SQLite estimates that:
  94862. **
  94863. ** * the index contains 100 rows,
  94864. ** * "WHERE a=?" matches 10 rows, and
  94865. ** * "WHERE a=? AND b=?" matches 2 rows.
  94866. **
  94867. ** If D is the count of distinct values and K is the total number of
  94868. ** rows, then each estimate is computed as:
  94869. **
  94870. ** I = (K+D-1)/D
  94871. */
  94872. char *z;
  94873. int i;
  94874. char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
  94875. if( zRet==0 ){
  94876. sqlite3_result_error_nomem(context);
  94877. return;
  94878. }
  94879. sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
  94880. z = zRet + sqlite3Strlen30(zRet);
  94881. for(i=0; i<p->nKeyCol; i++){
  94882. u64 nDistinct = p->current.anDLt[i] + 1;
  94883. u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
  94884. sqlite3_snprintf(24, z, " %llu", iVal);
  94885. z += sqlite3Strlen30(z);
  94886. assert( p->current.anEq[i] );
  94887. }
  94888. assert( z[0]=='\0' && z>zRet );
  94889. sqlite3_result_text(context, zRet, -1, sqlite3_free);
  94890. }
  94891. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94892. else if( eCall==STAT_GET_ROWID ){
  94893. if( p->iGet<0 ){
  94894. samplePushPrevious(p, 0);
  94895. p->iGet = 0;
  94896. }
  94897. if( p->iGet<p->nSample ){
  94898. Stat4Sample *pS = p->a + p->iGet;
  94899. if( pS->nRowid==0 ){
  94900. sqlite3_result_int64(context, pS->u.iRowid);
  94901. }else{
  94902. sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
  94903. SQLITE_TRANSIENT);
  94904. }
  94905. }
  94906. }else{
  94907. tRowcnt *aCnt = 0;
  94908. assert( p->iGet<p->nSample );
  94909. switch( eCall ){
  94910. case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
  94911. case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
  94912. default: {
  94913. aCnt = p->a[p->iGet].anDLt;
  94914. p->iGet++;
  94915. break;
  94916. }
  94917. }
  94918. if( IsStat3 ){
  94919. sqlite3_result_int64(context, (i64)aCnt[0]);
  94920. }else{
  94921. char *zRet = sqlite3MallocZero(p->nCol * 25);
  94922. if( zRet==0 ){
  94923. sqlite3_result_error_nomem(context);
  94924. }else{
  94925. int i;
  94926. char *z = zRet;
  94927. for(i=0; i<p->nCol; i++){
  94928. sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
  94929. z += sqlite3Strlen30(z);
  94930. }
  94931. assert( z[0]=='\0' && z>zRet );
  94932. z[-1] = '\0';
  94933. sqlite3_result_text(context, zRet, -1, sqlite3_free);
  94934. }
  94935. }
  94936. }
  94937. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  94938. #ifndef SQLITE_DEBUG
  94939. UNUSED_PARAMETER( argc );
  94940. #endif
  94941. }
  94942. static const FuncDef statGetFuncdef = {
  94943. 1+IsStat34, /* nArg */
  94944. SQLITE_UTF8, /* funcFlags */
  94945. 0, /* pUserData */
  94946. 0, /* pNext */
  94947. statGet, /* xSFunc */
  94948. 0, /* xFinalize */
  94949. "stat_get", /* zName */
  94950. {0}
  94951. };
  94952. static void callStatGet(Vdbe *v, int regStat4, int iParam, int regOut){
  94953. assert( regOut!=regStat4 && regOut!=regStat4+1 );
  94954. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94955. sqlite3VdbeAddOp2(v, OP_Integer, iParam, regStat4+1);
  94956. #elif SQLITE_DEBUG
  94957. assert( iParam==STAT_GET_STAT1 );
  94958. #else
  94959. UNUSED_PARAMETER( iParam );
  94960. #endif
  94961. sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4, regOut,
  94962. (char*)&statGetFuncdef, P4_FUNCDEF);
  94963. sqlite3VdbeChangeP5(v, 1 + IsStat34);
  94964. }
  94965. /*
  94966. ** Generate code to do an analysis of all indices associated with
  94967. ** a single table.
  94968. */
  94969. static void analyzeOneTable(
  94970. Parse *pParse, /* Parser context */
  94971. Table *pTab, /* Table whose indices are to be analyzed */
  94972. Index *pOnlyIdx, /* If not NULL, only analyze this one index */
  94973. int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
  94974. int iMem, /* Available memory locations begin here */
  94975. int iTab /* Next available cursor */
  94976. ){
  94977. sqlite3 *db = pParse->db; /* Database handle */
  94978. Index *pIdx; /* An index to being analyzed */
  94979. int iIdxCur; /* Cursor open on index being analyzed */
  94980. int iTabCur; /* Table cursor */
  94981. Vdbe *v; /* The virtual machine being built up */
  94982. int i; /* Loop counter */
  94983. int jZeroRows = -1; /* Jump from here if number of rows is zero */
  94984. int iDb; /* Index of database containing pTab */
  94985. u8 needTableCnt = 1; /* True to count the table */
  94986. int regNewRowid = iMem++; /* Rowid for the inserted record */
  94987. int regStat4 = iMem++; /* Register to hold Stat4Accum object */
  94988. int regChng = iMem++; /* Index of changed index field */
  94989. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  94990. int regRowid = iMem++; /* Rowid argument passed to stat_push() */
  94991. #endif
  94992. int regTemp = iMem++; /* Temporary use register */
  94993. int regTabname = iMem++; /* Register containing table name */
  94994. int regIdxname = iMem++; /* Register containing index name */
  94995. int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
  94996. int regPrev = iMem; /* MUST BE LAST (see below) */
  94997. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  94998. Table *pStat1 = 0;
  94999. #endif
  95000. pParse->nMem = MAX(pParse->nMem, iMem);
  95001. v = sqlite3GetVdbe(pParse);
  95002. if( v==0 || NEVER(pTab==0) ){
  95003. return;
  95004. }
  95005. if( pTab->tnum==0 ){
  95006. /* Do not gather statistics on views or virtual tables */
  95007. return;
  95008. }
  95009. if( sqlite3_strlike("sqlite\\_%", pTab->zName, '\\')==0 ){
  95010. /* Do not gather statistics on system tables */
  95011. return;
  95012. }
  95013. assert( sqlite3BtreeHoldsAllMutexes(db) );
  95014. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  95015. assert( iDb>=0 );
  95016. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  95017. #ifndef SQLITE_OMIT_AUTHORIZATION
  95018. if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
  95019. db->aDb[iDb].zDbSName ) ){
  95020. return;
  95021. }
  95022. #endif
  95023. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  95024. if( db->xPreUpdateCallback ){
  95025. pStat1 = (Table*)sqlite3DbMallocZero(db, sizeof(Table) + 13);
  95026. if( pStat1==0 ) return;
  95027. pStat1->zName = (char*)&pStat1[1];
  95028. memcpy(pStat1->zName, "sqlite_stat1", 13);
  95029. pStat1->nCol = 3;
  95030. pStat1->iPKey = -1;
  95031. sqlite3VdbeAddOp4(pParse->pVdbe, OP_Noop, 0, 0, 0,(char*)pStat1,P4_DYNBLOB);
  95032. }
  95033. #endif
  95034. /* Establish a read-lock on the table at the shared-cache level.
  95035. ** Open a read-only cursor on the table. Also allocate a cursor number
  95036. ** to use for scanning indexes (iIdxCur). No index cursor is opened at
  95037. ** this time though. */
  95038. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  95039. iTabCur = iTab++;
  95040. iIdxCur = iTab++;
  95041. pParse->nTab = MAX(pParse->nTab, iTab);
  95042. sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
  95043. sqlite3VdbeLoadString(v, regTabname, pTab->zName);
  95044. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  95045. int nCol; /* Number of columns in pIdx. "N" */
  95046. int addrRewind; /* Address of "OP_Rewind iIdxCur" */
  95047. int addrNextRow; /* Address of "next_row:" */
  95048. const char *zIdxName; /* Name of the index */
  95049. int nColTest; /* Number of columns to test for changes */
  95050. if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
  95051. if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
  95052. if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
  95053. nCol = pIdx->nKeyCol;
  95054. zIdxName = pTab->zName;
  95055. nColTest = nCol - 1;
  95056. }else{
  95057. nCol = pIdx->nColumn;
  95058. zIdxName = pIdx->zName;
  95059. nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
  95060. }
  95061. /* Populate the register containing the index name. */
  95062. sqlite3VdbeLoadString(v, regIdxname, zIdxName);
  95063. VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
  95064. /*
  95065. ** Pseudo-code for loop that calls stat_push():
  95066. **
  95067. ** Rewind csr
  95068. ** if eof(csr) goto end_of_scan;
  95069. ** regChng = 0
  95070. ** goto chng_addr_0;
  95071. **
  95072. ** next_row:
  95073. ** regChng = 0
  95074. ** if( idx(0) != regPrev(0) ) goto chng_addr_0
  95075. ** regChng = 1
  95076. ** if( idx(1) != regPrev(1) ) goto chng_addr_1
  95077. ** ...
  95078. ** regChng = N
  95079. ** goto chng_addr_N
  95080. **
  95081. ** chng_addr_0:
  95082. ** regPrev(0) = idx(0)
  95083. ** chng_addr_1:
  95084. ** regPrev(1) = idx(1)
  95085. ** ...
  95086. **
  95087. ** endDistinctTest:
  95088. ** regRowid = idx(rowid)
  95089. ** stat_push(P, regChng, regRowid)
  95090. ** Next csr
  95091. ** if !eof(csr) goto next_row;
  95092. **
  95093. ** end_of_scan:
  95094. */
  95095. /* Make sure there are enough memory cells allocated to accommodate
  95096. ** the regPrev array and a trailing rowid (the rowid slot is required
  95097. ** when building a record to insert into the sample column of
  95098. ** the sqlite_stat4 table. */
  95099. pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
  95100. /* Open a read-only cursor on the index being analyzed. */
  95101. assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
  95102. sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
  95103. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  95104. VdbeComment((v, "%s", pIdx->zName));
  95105. /* Invoke the stat_init() function. The arguments are:
  95106. **
  95107. ** (1) the number of columns in the index including the rowid
  95108. ** (or for a WITHOUT ROWID table, the number of PK columns),
  95109. ** (2) the number of columns in the key without the rowid/pk
  95110. ** (3) the number of rows in the index,
  95111. **
  95112. **
  95113. ** The third argument is only used for STAT3 and STAT4
  95114. */
  95115. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95116. sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
  95117. #endif
  95118. sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
  95119. sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
  95120. sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4+1, regStat4,
  95121. (char*)&statInitFuncdef, P4_FUNCDEF);
  95122. sqlite3VdbeChangeP5(v, 2+IsStat34);
  95123. /* Implementation of the following:
  95124. **
  95125. ** Rewind csr
  95126. ** if eof(csr) goto end_of_scan;
  95127. ** regChng = 0
  95128. ** goto next_push_0;
  95129. **
  95130. */
  95131. addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
  95132. VdbeCoverage(v);
  95133. sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
  95134. addrNextRow = sqlite3VdbeCurrentAddr(v);
  95135. if( nColTest>0 ){
  95136. int endDistinctTest = sqlite3VdbeMakeLabel(v);
  95137. int *aGotoChng; /* Array of jump instruction addresses */
  95138. aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
  95139. if( aGotoChng==0 ) continue;
  95140. /*
  95141. ** next_row:
  95142. ** regChng = 0
  95143. ** if( idx(0) != regPrev(0) ) goto chng_addr_0
  95144. ** regChng = 1
  95145. ** if( idx(1) != regPrev(1) ) goto chng_addr_1
  95146. ** ...
  95147. ** regChng = N
  95148. ** goto endDistinctTest
  95149. */
  95150. sqlite3VdbeAddOp0(v, OP_Goto);
  95151. addrNextRow = sqlite3VdbeCurrentAddr(v);
  95152. if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
  95153. /* For a single-column UNIQUE index, once we have found a non-NULL
  95154. ** row, we know that all the rest will be distinct, so skip
  95155. ** subsequent distinctness tests. */
  95156. sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
  95157. VdbeCoverage(v);
  95158. }
  95159. for(i=0; i<nColTest; i++){
  95160. char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
  95161. sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
  95162. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
  95163. aGotoChng[i] =
  95164. sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
  95165. sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
  95166. VdbeCoverage(v);
  95167. }
  95168. sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
  95169. sqlite3VdbeGoto(v, endDistinctTest);
  95170. /*
  95171. ** chng_addr_0:
  95172. ** regPrev(0) = idx(0)
  95173. ** chng_addr_1:
  95174. ** regPrev(1) = idx(1)
  95175. ** ...
  95176. */
  95177. sqlite3VdbeJumpHere(v, addrNextRow-1);
  95178. for(i=0; i<nColTest; i++){
  95179. sqlite3VdbeJumpHere(v, aGotoChng[i]);
  95180. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
  95181. }
  95182. sqlite3VdbeResolveLabel(v, endDistinctTest);
  95183. sqlite3DbFree(db, aGotoChng);
  95184. }
  95185. /*
  95186. ** chng_addr_N:
  95187. ** regRowid = idx(rowid) // STAT34 only
  95188. ** stat_push(P, regChng, regRowid) // 3rd parameter STAT34 only
  95189. ** Next csr
  95190. ** if !eof(csr) goto next_row;
  95191. */
  95192. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95193. assert( regRowid==(regStat4+2) );
  95194. if( HasRowid(pTab) ){
  95195. sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
  95196. }else{
  95197. Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
  95198. int j, k, regKey;
  95199. regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
  95200. for(j=0; j<pPk->nKeyCol; j++){
  95201. k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
  95202. assert( k>=0 && k<pIdx->nColumn );
  95203. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
  95204. VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
  95205. }
  95206. sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
  95207. sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
  95208. }
  95209. #endif
  95210. assert( regChng==(regStat4+1) );
  95211. sqlite3VdbeAddOp4(v, OP_Function0, 1, regStat4, regTemp,
  95212. (char*)&statPushFuncdef, P4_FUNCDEF);
  95213. sqlite3VdbeChangeP5(v, 2+IsStat34);
  95214. sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
  95215. /* Add the entry to the stat1 table. */
  95216. callStatGet(v, regStat4, STAT_GET_STAT1, regStat1);
  95217. assert( "BBB"[0]==SQLITE_AFF_TEXT );
  95218. sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
  95219. sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
  95220. sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
  95221. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  95222. sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
  95223. #endif
  95224. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  95225. /* Add the entries to the stat3 or stat4 table. */
  95226. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95227. {
  95228. int regEq = regStat1;
  95229. int regLt = regStat1+1;
  95230. int regDLt = regStat1+2;
  95231. int regSample = regStat1+3;
  95232. int regCol = regStat1+4;
  95233. int regSampleRowid = regCol + nCol;
  95234. int addrNext;
  95235. int addrIsNull;
  95236. u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
  95237. pParse->nMem = MAX(pParse->nMem, regCol+nCol);
  95238. addrNext = sqlite3VdbeCurrentAddr(v);
  95239. callStatGet(v, regStat4, STAT_GET_ROWID, regSampleRowid);
  95240. addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
  95241. VdbeCoverage(v);
  95242. callStatGet(v, regStat4, STAT_GET_NEQ, regEq);
  95243. callStatGet(v, regStat4, STAT_GET_NLT, regLt);
  95244. callStatGet(v, regStat4, STAT_GET_NDLT, regDLt);
  95245. sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
  95246. /* We know that the regSampleRowid row exists because it was read by
  95247. ** the previous loop. Thus the not-found jump of seekOp will never
  95248. ** be taken */
  95249. VdbeCoverageNeverTaken(v);
  95250. #ifdef SQLITE_ENABLE_STAT3
  95251. sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, 0, regSample);
  95252. #else
  95253. for(i=0; i<nCol; i++){
  95254. sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
  95255. }
  95256. sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
  95257. #endif
  95258. sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
  95259. sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
  95260. sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
  95261. sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
  95262. sqlite3VdbeJumpHere(v, addrIsNull);
  95263. }
  95264. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  95265. /* End of analysis */
  95266. sqlite3VdbeJumpHere(v, addrRewind);
  95267. }
  95268. /* Create a single sqlite_stat1 entry containing NULL as the index
  95269. ** name and the row count as the content.
  95270. */
  95271. if( pOnlyIdx==0 && needTableCnt ){
  95272. VdbeComment((v, "%s", pTab->zName));
  95273. sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
  95274. jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
  95275. sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
  95276. assert( "BBB"[0]==SQLITE_AFF_TEXT );
  95277. sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
  95278. sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
  95279. sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
  95280. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  95281. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  95282. sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
  95283. #endif
  95284. sqlite3VdbeJumpHere(v, jZeroRows);
  95285. }
  95286. }
  95287. /*
  95288. ** Generate code that will cause the most recent index analysis to
  95289. ** be loaded into internal hash tables where is can be used.
  95290. */
  95291. static void loadAnalysis(Parse *pParse, int iDb){
  95292. Vdbe *v = sqlite3GetVdbe(pParse);
  95293. if( v ){
  95294. sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
  95295. }
  95296. }
  95297. /*
  95298. ** Generate code that will do an analysis of an entire database
  95299. */
  95300. static void analyzeDatabase(Parse *pParse, int iDb){
  95301. sqlite3 *db = pParse->db;
  95302. Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
  95303. HashElem *k;
  95304. int iStatCur;
  95305. int iMem;
  95306. int iTab;
  95307. sqlite3BeginWriteOperation(pParse, 0, iDb);
  95308. iStatCur = pParse->nTab;
  95309. pParse->nTab += 3;
  95310. openStatTable(pParse, iDb, iStatCur, 0, 0);
  95311. iMem = pParse->nMem+1;
  95312. iTab = pParse->nTab;
  95313. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  95314. for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
  95315. Table *pTab = (Table*)sqliteHashData(k);
  95316. analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
  95317. }
  95318. loadAnalysis(pParse, iDb);
  95319. }
  95320. /*
  95321. ** Generate code that will do an analysis of a single table in
  95322. ** a database. If pOnlyIdx is not NULL then it is a single index
  95323. ** in pTab that should be analyzed.
  95324. */
  95325. static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
  95326. int iDb;
  95327. int iStatCur;
  95328. assert( pTab!=0 );
  95329. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  95330. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  95331. sqlite3BeginWriteOperation(pParse, 0, iDb);
  95332. iStatCur = pParse->nTab;
  95333. pParse->nTab += 3;
  95334. if( pOnlyIdx ){
  95335. openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
  95336. }else{
  95337. openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
  95338. }
  95339. analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
  95340. loadAnalysis(pParse, iDb);
  95341. }
  95342. /*
  95343. ** Generate code for the ANALYZE command. The parser calls this routine
  95344. ** when it recognizes an ANALYZE command.
  95345. **
  95346. ** ANALYZE -- 1
  95347. ** ANALYZE <database> -- 2
  95348. ** ANALYZE ?<database>.?<tablename> -- 3
  95349. **
  95350. ** Form 1 causes all indices in all attached databases to be analyzed.
  95351. ** Form 2 analyzes all indices the single database named.
  95352. ** Form 3 analyzes all indices associated with the named table.
  95353. */
  95354. SQLITE_PRIVATE void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
  95355. sqlite3 *db = pParse->db;
  95356. int iDb;
  95357. int i;
  95358. char *z, *zDb;
  95359. Table *pTab;
  95360. Index *pIdx;
  95361. Token *pTableName;
  95362. Vdbe *v;
  95363. /* Read the database schema. If an error occurs, leave an error message
  95364. ** and code in pParse and return NULL. */
  95365. assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
  95366. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  95367. return;
  95368. }
  95369. assert( pName2!=0 || pName1==0 );
  95370. if( pName1==0 ){
  95371. /* Form 1: Analyze everything */
  95372. for(i=0; i<db->nDb; i++){
  95373. if( i==1 ) continue; /* Do not analyze the TEMP database */
  95374. analyzeDatabase(pParse, i);
  95375. }
  95376. }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
  95377. /* Analyze the schema named as the argument */
  95378. analyzeDatabase(pParse, iDb);
  95379. }else{
  95380. /* Form 3: Analyze the table or index named as an argument */
  95381. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
  95382. if( iDb>=0 ){
  95383. zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
  95384. z = sqlite3NameFromToken(db, pTableName);
  95385. if( z ){
  95386. if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
  95387. analyzeTable(pParse, pIdx->pTable, pIdx);
  95388. }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
  95389. analyzeTable(pParse, pTab, 0);
  95390. }
  95391. sqlite3DbFree(db, z);
  95392. }
  95393. }
  95394. }
  95395. if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
  95396. sqlite3VdbeAddOp0(v, OP_Expire);
  95397. }
  95398. }
  95399. /*
  95400. ** Used to pass information from the analyzer reader through to the
  95401. ** callback routine.
  95402. */
  95403. typedef struct analysisInfo analysisInfo;
  95404. struct analysisInfo {
  95405. sqlite3 *db;
  95406. const char *zDatabase;
  95407. };
  95408. /*
  95409. ** The first argument points to a nul-terminated string containing a
  95410. ** list of space separated integers. Read the first nOut of these into
  95411. ** the array aOut[].
  95412. */
  95413. static void decodeIntArray(
  95414. char *zIntArray, /* String containing int array to decode */
  95415. int nOut, /* Number of slots in aOut[] */
  95416. tRowcnt *aOut, /* Store integers here */
  95417. LogEst *aLog, /* Or, if aOut==0, here */
  95418. Index *pIndex /* Handle extra flags for this index, if not NULL */
  95419. ){
  95420. char *z = zIntArray;
  95421. int c;
  95422. int i;
  95423. tRowcnt v;
  95424. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95425. if( z==0 ) z = "";
  95426. #else
  95427. assert( z!=0 );
  95428. #endif
  95429. for(i=0; *z && i<nOut; i++){
  95430. v = 0;
  95431. while( (c=z[0])>='0' && c<='9' ){
  95432. v = v*10 + c - '0';
  95433. z++;
  95434. }
  95435. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95436. if( aOut ) aOut[i] = v;
  95437. if( aLog ) aLog[i] = sqlite3LogEst(v);
  95438. #else
  95439. assert( aOut==0 );
  95440. UNUSED_PARAMETER(aOut);
  95441. assert( aLog!=0 );
  95442. aLog[i] = sqlite3LogEst(v);
  95443. #endif
  95444. if( *z==' ' ) z++;
  95445. }
  95446. #ifndef SQLITE_ENABLE_STAT3_OR_STAT4
  95447. assert( pIndex!=0 ); {
  95448. #else
  95449. if( pIndex ){
  95450. #endif
  95451. pIndex->bUnordered = 0;
  95452. pIndex->noSkipScan = 0;
  95453. while( z[0] ){
  95454. if( sqlite3_strglob("unordered*", z)==0 ){
  95455. pIndex->bUnordered = 1;
  95456. }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
  95457. pIndex->szIdxRow = sqlite3LogEst(sqlite3Atoi(z+3));
  95458. }else if( sqlite3_strglob("noskipscan*", z)==0 ){
  95459. pIndex->noSkipScan = 1;
  95460. }
  95461. #ifdef SQLITE_ENABLE_COSTMULT
  95462. else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
  95463. pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
  95464. }
  95465. #endif
  95466. while( z[0]!=0 && z[0]!=' ' ) z++;
  95467. while( z[0]==' ' ) z++;
  95468. }
  95469. }
  95470. }
  95471. /*
  95472. ** This callback is invoked once for each index when reading the
  95473. ** sqlite_stat1 table.
  95474. **
  95475. ** argv[0] = name of the table
  95476. ** argv[1] = name of the index (might be NULL)
  95477. ** argv[2] = results of analysis - on integer for each column
  95478. **
  95479. ** Entries for which argv[1]==NULL simply record the number of rows in
  95480. ** the table.
  95481. */
  95482. static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
  95483. analysisInfo *pInfo = (analysisInfo*)pData;
  95484. Index *pIndex;
  95485. Table *pTable;
  95486. const char *z;
  95487. assert( argc==3 );
  95488. UNUSED_PARAMETER2(NotUsed, argc);
  95489. if( argv==0 || argv[0]==0 || argv[2]==0 ){
  95490. return 0;
  95491. }
  95492. pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
  95493. if( pTable==0 ){
  95494. return 0;
  95495. }
  95496. if( argv[1]==0 ){
  95497. pIndex = 0;
  95498. }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
  95499. pIndex = sqlite3PrimaryKeyIndex(pTable);
  95500. }else{
  95501. pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
  95502. }
  95503. z = argv[2];
  95504. if( pIndex ){
  95505. tRowcnt *aiRowEst = 0;
  95506. int nCol = pIndex->nKeyCol+1;
  95507. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95508. /* Index.aiRowEst may already be set here if there are duplicate
  95509. ** sqlite_stat1 entries for this index. In that case just clobber
  95510. ** the old data with the new instead of allocating a new array. */
  95511. if( pIndex->aiRowEst==0 ){
  95512. pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
  95513. if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
  95514. }
  95515. aiRowEst = pIndex->aiRowEst;
  95516. #endif
  95517. pIndex->bUnordered = 0;
  95518. decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
  95519. pIndex->hasStat1 = 1;
  95520. if( pIndex->pPartIdxWhere==0 ){
  95521. pTable->nRowLogEst = pIndex->aiRowLogEst[0];
  95522. pTable->tabFlags |= TF_HasStat1;
  95523. }
  95524. }else{
  95525. Index fakeIdx;
  95526. fakeIdx.szIdxRow = pTable->szTabRow;
  95527. #ifdef SQLITE_ENABLE_COSTMULT
  95528. fakeIdx.pTable = pTable;
  95529. #endif
  95530. decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
  95531. pTable->szTabRow = fakeIdx.szIdxRow;
  95532. pTable->tabFlags |= TF_HasStat1;
  95533. }
  95534. return 0;
  95535. }
  95536. /*
  95537. ** If the Index.aSample variable is not NULL, delete the aSample[] array
  95538. ** and its contents.
  95539. */
  95540. SQLITE_PRIVATE void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
  95541. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95542. if( pIdx->aSample ){
  95543. int j;
  95544. for(j=0; j<pIdx->nSample; j++){
  95545. IndexSample *p = &pIdx->aSample[j];
  95546. sqlite3DbFree(db, p->p);
  95547. }
  95548. sqlite3DbFree(db, pIdx->aSample);
  95549. }
  95550. if( db && db->pnBytesFreed==0 ){
  95551. pIdx->nSample = 0;
  95552. pIdx->aSample = 0;
  95553. }
  95554. #else
  95555. UNUSED_PARAMETER(db);
  95556. UNUSED_PARAMETER(pIdx);
  95557. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  95558. }
  95559. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95560. /*
  95561. ** Populate the pIdx->aAvgEq[] array based on the samples currently
  95562. ** stored in pIdx->aSample[].
  95563. */
  95564. static void initAvgEq(Index *pIdx){
  95565. if( pIdx ){
  95566. IndexSample *aSample = pIdx->aSample;
  95567. IndexSample *pFinal = &aSample[pIdx->nSample-1];
  95568. int iCol;
  95569. int nCol = 1;
  95570. if( pIdx->nSampleCol>1 ){
  95571. /* If this is stat4 data, then calculate aAvgEq[] values for all
  95572. ** sample columns except the last. The last is always set to 1, as
  95573. ** once the trailing PK fields are considered all index keys are
  95574. ** unique. */
  95575. nCol = pIdx->nSampleCol-1;
  95576. pIdx->aAvgEq[nCol] = 1;
  95577. }
  95578. for(iCol=0; iCol<nCol; iCol++){
  95579. int nSample = pIdx->nSample;
  95580. int i; /* Used to iterate through samples */
  95581. tRowcnt sumEq = 0; /* Sum of the nEq values */
  95582. tRowcnt avgEq = 0;
  95583. tRowcnt nRow; /* Number of rows in index */
  95584. i64 nSum100 = 0; /* Number of terms contributing to sumEq */
  95585. i64 nDist100; /* Number of distinct values in index */
  95586. if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
  95587. nRow = pFinal->anLt[iCol];
  95588. nDist100 = (i64)100 * pFinal->anDLt[iCol];
  95589. nSample--;
  95590. }else{
  95591. nRow = pIdx->aiRowEst[0];
  95592. nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
  95593. }
  95594. pIdx->nRowEst0 = nRow;
  95595. /* Set nSum to the number of distinct (iCol+1) field prefixes that
  95596. ** occur in the stat4 table for this index. Set sumEq to the sum of
  95597. ** the nEq values for column iCol for the same set (adding the value
  95598. ** only once where there exist duplicate prefixes). */
  95599. for(i=0; i<nSample; i++){
  95600. if( i==(pIdx->nSample-1)
  95601. || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
  95602. ){
  95603. sumEq += aSample[i].anEq[iCol];
  95604. nSum100 += 100;
  95605. }
  95606. }
  95607. if( nDist100>nSum100 && sumEq<nRow ){
  95608. avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
  95609. }
  95610. if( avgEq==0 ) avgEq = 1;
  95611. pIdx->aAvgEq[iCol] = avgEq;
  95612. }
  95613. }
  95614. }
  95615. /*
  95616. ** Look up an index by name. Or, if the name of a WITHOUT ROWID table
  95617. ** is supplied instead, find the PRIMARY KEY index for that table.
  95618. */
  95619. static Index *findIndexOrPrimaryKey(
  95620. sqlite3 *db,
  95621. const char *zName,
  95622. const char *zDb
  95623. ){
  95624. Index *pIdx = sqlite3FindIndex(db, zName, zDb);
  95625. if( pIdx==0 ){
  95626. Table *pTab = sqlite3FindTable(db, zName, zDb);
  95627. if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
  95628. }
  95629. return pIdx;
  95630. }
  95631. /*
  95632. ** Load the content from either the sqlite_stat4 or sqlite_stat3 table
  95633. ** into the relevant Index.aSample[] arrays.
  95634. **
  95635. ** Arguments zSql1 and zSql2 must point to SQL statements that return
  95636. ** data equivalent to the following (statements are different for stat3,
  95637. ** see the caller of this function for details):
  95638. **
  95639. ** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
  95640. ** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
  95641. **
  95642. ** where %Q is replaced with the database name before the SQL is executed.
  95643. */
  95644. static int loadStatTbl(
  95645. sqlite3 *db, /* Database handle */
  95646. int bStat3, /* Assume single column records only */
  95647. const char *zSql1, /* SQL statement 1 (see above) */
  95648. const char *zSql2, /* SQL statement 2 (see above) */
  95649. const char *zDb /* Database name (e.g. "main") */
  95650. ){
  95651. int rc; /* Result codes from subroutines */
  95652. sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
  95653. char *zSql; /* Text of the SQL statement */
  95654. Index *pPrevIdx = 0; /* Previous index in the loop */
  95655. IndexSample *pSample; /* A slot in pIdx->aSample[] */
  95656. assert( db->lookaside.bDisable );
  95657. zSql = sqlite3MPrintf(db, zSql1, zDb);
  95658. if( !zSql ){
  95659. return SQLITE_NOMEM_BKPT;
  95660. }
  95661. rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
  95662. sqlite3DbFree(db, zSql);
  95663. if( rc ) return rc;
  95664. while( sqlite3_step(pStmt)==SQLITE_ROW ){
  95665. int nIdxCol = 1; /* Number of columns in stat4 records */
  95666. char *zIndex; /* Index name */
  95667. Index *pIdx; /* Pointer to the index object */
  95668. int nSample; /* Number of samples */
  95669. int nByte; /* Bytes of space required */
  95670. int i; /* Bytes of space required */
  95671. tRowcnt *pSpace;
  95672. zIndex = (char *)sqlite3_column_text(pStmt, 0);
  95673. if( zIndex==0 ) continue;
  95674. nSample = sqlite3_column_int(pStmt, 1);
  95675. pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
  95676. assert( pIdx==0 || bStat3 || pIdx->nSample==0 );
  95677. /* Index.nSample is non-zero at this point if data has already been
  95678. ** loaded from the stat4 table. In this case ignore stat3 data. */
  95679. if( pIdx==0 || pIdx->nSample ) continue;
  95680. if( bStat3==0 ){
  95681. assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
  95682. if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
  95683. nIdxCol = pIdx->nKeyCol;
  95684. }else{
  95685. nIdxCol = pIdx->nColumn;
  95686. }
  95687. }
  95688. pIdx->nSampleCol = nIdxCol;
  95689. nByte = sizeof(IndexSample) * nSample;
  95690. nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
  95691. nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
  95692. pIdx->aSample = sqlite3DbMallocZero(db, nByte);
  95693. if( pIdx->aSample==0 ){
  95694. sqlite3_finalize(pStmt);
  95695. return SQLITE_NOMEM_BKPT;
  95696. }
  95697. pSpace = (tRowcnt*)&pIdx->aSample[nSample];
  95698. pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
  95699. for(i=0; i<nSample; i++){
  95700. pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
  95701. pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
  95702. pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
  95703. }
  95704. assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
  95705. }
  95706. rc = sqlite3_finalize(pStmt);
  95707. if( rc ) return rc;
  95708. zSql = sqlite3MPrintf(db, zSql2, zDb);
  95709. if( !zSql ){
  95710. return SQLITE_NOMEM_BKPT;
  95711. }
  95712. rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
  95713. sqlite3DbFree(db, zSql);
  95714. if( rc ) return rc;
  95715. while( sqlite3_step(pStmt)==SQLITE_ROW ){
  95716. char *zIndex; /* Index name */
  95717. Index *pIdx; /* Pointer to the index object */
  95718. int nCol = 1; /* Number of columns in index */
  95719. zIndex = (char *)sqlite3_column_text(pStmt, 0);
  95720. if( zIndex==0 ) continue;
  95721. pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
  95722. if( pIdx==0 ) continue;
  95723. /* This next condition is true if data has already been loaded from
  95724. ** the sqlite_stat4 table. In this case ignore stat3 data. */
  95725. nCol = pIdx->nSampleCol;
  95726. if( bStat3 && nCol>1 ) continue;
  95727. if( pIdx!=pPrevIdx ){
  95728. initAvgEq(pPrevIdx);
  95729. pPrevIdx = pIdx;
  95730. }
  95731. pSample = &pIdx->aSample[pIdx->nSample];
  95732. decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
  95733. decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
  95734. decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
  95735. /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
  95736. ** This is in case the sample record is corrupted. In that case, the
  95737. ** sqlite3VdbeRecordCompare() may read up to two varints past the
  95738. ** end of the allocated buffer before it realizes it is dealing with
  95739. ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
  95740. ** a buffer overread. */
  95741. pSample->n = sqlite3_column_bytes(pStmt, 4);
  95742. pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
  95743. if( pSample->p==0 ){
  95744. sqlite3_finalize(pStmt);
  95745. return SQLITE_NOMEM_BKPT;
  95746. }
  95747. if( pSample->n ){
  95748. memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
  95749. }
  95750. pIdx->nSample++;
  95751. }
  95752. rc = sqlite3_finalize(pStmt);
  95753. if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
  95754. return rc;
  95755. }
  95756. /*
  95757. ** Load content from the sqlite_stat4 and sqlite_stat3 tables into
  95758. ** the Index.aSample[] arrays of all indices.
  95759. */
  95760. static int loadStat4(sqlite3 *db, const char *zDb){
  95761. int rc = SQLITE_OK; /* Result codes from subroutines */
  95762. assert( db->lookaside.bDisable );
  95763. if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
  95764. rc = loadStatTbl(db, 0,
  95765. "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
  95766. "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
  95767. zDb
  95768. );
  95769. }
  95770. if( rc==SQLITE_OK && sqlite3FindTable(db, "sqlite_stat3", zDb) ){
  95771. rc = loadStatTbl(db, 1,
  95772. "SELECT idx,count(*) FROM %Q.sqlite_stat3 GROUP BY idx",
  95773. "SELECT idx,neq,nlt,ndlt,sqlite_record(sample) FROM %Q.sqlite_stat3",
  95774. zDb
  95775. );
  95776. }
  95777. return rc;
  95778. }
  95779. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  95780. /*
  95781. ** Load the content of the sqlite_stat1 and sqlite_stat3/4 tables. The
  95782. ** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
  95783. ** arrays. The contents of sqlite_stat3/4 are used to populate the
  95784. ** Index.aSample[] arrays.
  95785. **
  95786. ** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
  95787. ** is returned. In this case, even if SQLITE_ENABLE_STAT3/4 was defined
  95788. ** during compilation and the sqlite_stat3/4 table is present, no data is
  95789. ** read from it.
  95790. **
  95791. ** If SQLITE_ENABLE_STAT3/4 was defined during compilation and the
  95792. ** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
  95793. ** returned. However, in this case, data is read from the sqlite_stat1
  95794. ** table (if it is present) before returning.
  95795. **
  95796. ** If an OOM error occurs, this function always sets db->mallocFailed.
  95797. ** This means if the caller does not care about other errors, the return
  95798. ** code may be ignored.
  95799. */
  95800. SQLITE_PRIVATE int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
  95801. analysisInfo sInfo;
  95802. HashElem *i;
  95803. char *zSql;
  95804. int rc = SQLITE_OK;
  95805. Schema *pSchema = db->aDb[iDb].pSchema;
  95806. assert( iDb>=0 && iDb<db->nDb );
  95807. assert( db->aDb[iDb].pBt!=0 );
  95808. /* Clear any prior statistics */
  95809. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  95810. for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
  95811. Table *pTab = sqliteHashData(i);
  95812. pTab->tabFlags &= ~TF_HasStat1;
  95813. }
  95814. for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
  95815. Index *pIdx = sqliteHashData(i);
  95816. pIdx->hasStat1 = 0;
  95817. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95818. sqlite3DeleteIndexSamples(db, pIdx);
  95819. pIdx->aSample = 0;
  95820. #endif
  95821. }
  95822. /* Load new statistics out of the sqlite_stat1 table */
  95823. sInfo.db = db;
  95824. sInfo.zDatabase = db->aDb[iDb].zDbSName;
  95825. if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
  95826. zSql = sqlite3MPrintf(db,
  95827. "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
  95828. if( zSql==0 ){
  95829. rc = SQLITE_NOMEM_BKPT;
  95830. }else{
  95831. rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
  95832. sqlite3DbFree(db, zSql);
  95833. }
  95834. }
  95835. /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
  95836. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  95837. for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
  95838. Index *pIdx = sqliteHashData(i);
  95839. if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
  95840. }
  95841. /* Load the statistics from the sqlite_stat4 table. */
  95842. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  95843. if( rc==SQLITE_OK && OptimizationEnabled(db, SQLITE_Stat34) ){
  95844. db->lookaside.bDisable++;
  95845. rc = loadStat4(db, sInfo.zDatabase);
  95846. db->lookaside.bDisable--;
  95847. }
  95848. for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
  95849. Index *pIdx = sqliteHashData(i);
  95850. sqlite3_free(pIdx->aiRowEst);
  95851. pIdx->aiRowEst = 0;
  95852. }
  95853. #endif
  95854. if( rc==SQLITE_NOMEM ){
  95855. sqlite3OomFault(db);
  95856. }
  95857. return rc;
  95858. }
  95859. #endif /* SQLITE_OMIT_ANALYZE */
  95860. /************** End of analyze.c *********************************************/
  95861. /************** Begin file attach.c ******************************************/
  95862. /*
  95863. ** 2003 April 6
  95864. **
  95865. ** The author disclaims copyright to this source code. In place of
  95866. ** a legal notice, here is a blessing:
  95867. **
  95868. ** May you do good and not evil.
  95869. ** May you find forgiveness for yourself and forgive others.
  95870. ** May you share freely, never taking more than you give.
  95871. **
  95872. *************************************************************************
  95873. ** This file contains code used to implement the ATTACH and DETACH commands.
  95874. */
  95875. /* #include "sqliteInt.h" */
  95876. #ifndef SQLITE_OMIT_ATTACH
  95877. /*
  95878. ** Resolve an expression that was part of an ATTACH or DETACH statement. This
  95879. ** is slightly different from resolving a normal SQL expression, because simple
  95880. ** identifiers are treated as strings, not possible column names or aliases.
  95881. **
  95882. ** i.e. if the parser sees:
  95883. **
  95884. ** ATTACH DATABASE abc AS def
  95885. **
  95886. ** it treats the two expressions as literal strings 'abc' and 'def' instead of
  95887. ** looking for columns of the same name.
  95888. **
  95889. ** This only applies to the root node of pExpr, so the statement:
  95890. **
  95891. ** ATTACH DATABASE abc||def AS 'db2'
  95892. **
  95893. ** will fail because neither abc or def can be resolved.
  95894. */
  95895. static int resolveAttachExpr(NameContext *pName, Expr *pExpr)
  95896. {
  95897. int rc = SQLITE_OK;
  95898. if( pExpr ){
  95899. if( pExpr->op!=TK_ID ){
  95900. rc = sqlite3ResolveExprNames(pName, pExpr);
  95901. }else{
  95902. pExpr->op = TK_STRING;
  95903. }
  95904. }
  95905. return rc;
  95906. }
  95907. /*
  95908. ** An SQL user-function registered to do the work of an ATTACH statement. The
  95909. ** three arguments to the function come directly from an attach statement:
  95910. **
  95911. ** ATTACH DATABASE x AS y KEY z
  95912. **
  95913. ** SELECT sqlite_attach(x, y, z)
  95914. **
  95915. ** If the optional "KEY z" syntax is omitted, an SQL NULL is passed as the
  95916. ** third argument.
  95917. **
  95918. ** If the db->init.reopenMemdb flags is set, then instead of attaching a
  95919. ** new database, close the database on db->init.iDb and reopen it as an
  95920. ** empty MemDB.
  95921. */
  95922. static void attachFunc(
  95923. sqlite3_context *context,
  95924. int NotUsed,
  95925. sqlite3_value **argv
  95926. ){
  95927. int i;
  95928. int rc = 0;
  95929. sqlite3 *db = sqlite3_context_db_handle(context);
  95930. const char *zName;
  95931. const char *zFile;
  95932. char *zPath = 0;
  95933. char *zErr = 0;
  95934. unsigned int flags;
  95935. Db *aNew; /* New array of Db pointers */
  95936. Db *pNew; /* Db object for the newly attached database */
  95937. char *zErrDyn = 0;
  95938. sqlite3_vfs *pVfs;
  95939. UNUSED_PARAMETER(NotUsed);
  95940. zFile = (const char *)sqlite3_value_text(argv[0]);
  95941. zName = (const char *)sqlite3_value_text(argv[1]);
  95942. if( zFile==0 ) zFile = "";
  95943. if( zName==0 ) zName = "";
  95944. #ifdef SQLITE_ENABLE_DESERIALIZE
  95945. # define REOPEN_AS_MEMDB(db) (db->init.reopenMemdb)
  95946. #else
  95947. # define REOPEN_AS_MEMDB(db) (0)
  95948. #endif
  95949. if( REOPEN_AS_MEMDB(db) ){
  95950. /* This is not a real ATTACH. Instead, this routine is being called
  95951. ** from sqlite3_deserialize() to close database db->init.iDb and
  95952. ** reopen it as a MemDB */
  95953. pVfs = sqlite3_vfs_find("memdb");
  95954. if( pVfs==0 ) return;
  95955. pNew = &db->aDb[db->init.iDb];
  95956. if( pNew->pBt ) sqlite3BtreeClose(pNew->pBt);
  95957. pNew->pBt = 0;
  95958. pNew->pSchema = 0;
  95959. rc = sqlite3BtreeOpen(pVfs, "x", db, &pNew->pBt, 0, SQLITE_OPEN_MAIN_DB);
  95960. }else{
  95961. /* This is a real ATTACH
  95962. **
  95963. ** Check for the following errors:
  95964. **
  95965. ** * Too many attached databases,
  95966. ** * Transaction currently open
  95967. ** * Specified database name already being used.
  95968. */
  95969. if( db->nDb>=db->aLimit[SQLITE_LIMIT_ATTACHED]+2 ){
  95970. zErrDyn = sqlite3MPrintf(db, "too many attached databases - max %d",
  95971. db->aLimit[SQLITE_LIMIT_ATTACHED]
  95972. );
  95973. goto attach_error;
  95974. }
  95975. for(i=0; i<db->nDb; i++){
  95976. char *z = db->aDb[i].zDbSName;
  95977. assert( z && zName );
  95978. if( sqlite3StrICmp(z, zName)==0 ){
  95979. zErrDyn = sqlite3MPrintf(db, "database %s is already in use", zName);
  95980. goto attach_error;
  95981. }
  95982. }
  95983. /* Allocate the new entry in the db->aDb[] array and initialize the schema
  95984. ** hash tables.
  95985. */
  95986. if( db->aDb==db->aDbStatic ){
  95987. aNew = sqlite3DbMallocRawNN(db, sizeof(db->aDb[0])*3 );
  95988. if( aNew==0 ) return;
  95989. memcpy(aNew, db->aDb, sizeof(db->aDb[0])*2);
  95990. }else{
  95991. aNew = sqlite3DbRealloc(db, db->aDb, sizeof(db->aDb[0])*(db->nDb+1) );
  95992. if( aNew==0 ) return;
  95993. }
  95994. db->aDb = aNew;
  95995. pNew = &db->aDb[db->nDb];
  95996. memset(pNew, 0, sizeof(*pNew));
  95997. /* Open the database file. If the btree is successfully opened, use
  95998. ** it to obtain the database schema. At this point the schema may
  95999. ** or may not be initialized.
  96000. */
  96001. flags = db->openFlags;
  96002. rc = sqlite3ParseUri(db->pVfs->zName, zFile, &flags, &pVfs, &zPath, &zErr);
  96003. if( rc!=SQLITE_OK ){
  96004. if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
  96005. sqlite3_result_error(context, zErr, -1);
  96006. sqlite3_free(zErr);
  96007. return;
  96008. }
  96009. assert( pVfs );
  96010. flags |= SQLITE_OPEN_MAIN_DB;
  96011. rc = sqlite3BtreeOpen(pVfs, zPath, db, &pNew->pBt, 0, flags);
  96012. sqlite3_free( zPath );
  96013. db->nDb++;
  96014. }
  96015. db->skipBtreeMutex = 0;
  96016. if( rc==SQLITE_CONSTRAINT ){
  96017. rc = SQLITE_ERROR;
  96018. zErrDyn = sqlite3MPrintf(db, "database is already attached");
  96019. }else if( rc==SQLITE_OK ){
  96020. Pager *pPager;
  96021. pNew->pSchema = sqlite3SchemaGet(db, pNew->pBt);
  96022. if( !pNew->pSchema ){
  96023. rc = SQLITE_NOMEM_BKPT;
  96024. }else if( pNew->pSchema->file_format && pNew->pSchema->enc!=ENC(db) ){
  96025. zErrDyn = sqlite3MPrintf(db,
  96026. "attached databases must use the same text encoding as main database");
  96027. rc = SQLITE_ERROR;
  96028. }
  96029. sqlite3BtreeEnter(pNew->pBt);
  96030. pPager = sqlite3BtreePager(pNew->pBt);
  96031. sqlite3PagerLockingMode(pPager, db->dfltLockMode);
  96032. sqlite3BtreeSecureDelete(pNew->pBt,
  96033. sqlite3BtreeSecureDelete(db->aDb[0].pBt,-1) );
  96034. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  96035. sqlite3BtreeSetPagerFlags(pNew->pBt,
  96036. PAGER_SYNCHRONOUS_FULL | (db->flags & PAGER_FLAGS_MASK));
  96037. #endif
  96038. sqlite3BtreeLeave(pNew->pBt);
  96039. }
  96040. pNew->safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
  96041. if( !REOPEN_AS_MEMDB(db) ) pNew->zDbSName = sqlite3DbStrDup(db, zName);
  96042. if( rc==SQLITE_OK && pNew->zDbSName==0 ){
  96043. rc = SQLITE_NOMEM_BKPT;
  96044. }
  96045. #ifdef SQLITE_HAS_CODEC
  96046. if( rc==SQLITE_OK ){
  96047. extern int sqlite3CodecAttach(sqlite3*, int, const void*, int);
  96048. extern void sqlite3CodecGetKey(sqlite3*, int, void**, int*);
  96049. int nKey;
  96050. char *zKey;
  96051. int t = sqlite3_value_type(argv[2]);
  96052. switch( t ){
  96053. case SQLITE_INTEGER:
  96054. case SQLITE_FLOAT:
  96055. zErrDyn = sqlite3DbStrDup(db, "Invalid key value");
  96056. rc = SQLITE_ERROR;
  96057. break;
  96058. case SQLITE_TEXT:
  96059. case SQLITE_BLOB:
  96060. nKey = sqlite3_value_bytes(argv[2]);
  96061. zKey = (char *)sqlite3_value_blob(argv[2]);
  96062. rc = sqlite3CodecAttach(db, db->nDb-1, zKey, nKey);
  96063. break;
  96064. case SQLITE_NULL:
  96065. /* No key specified. Use the key from the main database */
  96066. sqlite3CodecGetKey(db, 0, (void**)&zKey, &nKey);
  96067. if( nKey || sqlite3BtreeGetOptimalReserve(db->aDb[0].pBt)>0 ){
  96068. rc = sqlite3CodecAttach(db, db->nDb-1, zKey, nKey);
  96069. }
  96070. break;
  96071. }
  96072. }
  96073. #endif
  96074. /* If the file was opened successfully, read the schema for the new database.
  96075. ** If this fails, or if opening the file failed, then close the file and
  96076. ** remove the entry from the db->aDb[] array. i.e. put everything back the
  96077. ** way we found it.
  96078. */
  96079. if( rc==SQLITE_OK ){
  96080. sqlite3BtreeEnterAll(db);
  96081. db->init.iDb = 0;
  96082. rc = sqlite3Init(db, &zErrDyn);
  96083. sqlite3BtreeLeaveAll(db);
  96084. assert( zErrDyn==0 || rc!=SQLITE_OK );
  96085. }
  96086. #ifdef SQLITE_USER_AUTHENTICATION
  96087. if( rc==SQLITE_OK ){
  96088. u8 newAuth = 0;
  96089. rc = sqlite3UserAuthCheckLogin(db, zName, &newAuth);
  96090. if( newAuth<db->auth.authLevel ){
  96091. rc = SQLITE_AUTH_USER;
  96092. }
  96093. }
  96094. #endif
  96095. if( rc ){
  96096. if( !REOPEN_AS_MEMDB(db) ){
  96097. int iDb = db->nDb - 1;
  96098. assert( iDb>=2 );
  96099. if( db->aDb[iDb].pBt ){
  96100. sqlite3BtreeClose(db->aDb[iDb].pBt);
  96101. db->aDb[iDb].pBt = 0;
  96102. db->aDb[iDb].pSchema = 0;
  96103. }
  96104. sqlite3ResetAllSchemasOfConnection(db);
  96105. db->nDb = iDb;
  96106. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
  96107. sqlite3OomFault(db);
  96108. sqlite3DbFree(db, zErrDyn);
  96109. zErrDyn = sqlite3MPrintf(db, "out of memory");
  96110. }else if( zErrDyn==0 ){
  96111. zErrDyn = sqlite3MPrintf(db, "unable to open database: %s", zFile);
  96112. }
  96113. }
  96114. goto attach_error;
  96115. }
  96116. return;
  96117. attach_error:
  96118. /* Return an error if we get here */
  96119. if( zErrDyn ){
  96120. sqlite3_result_error(context, zErrDyn, -1);
  96121. sqlite3DbFree(db, zErrDyn);
  96122. }
  96123. if( rc ) sqlite3_result_error_code(context, rc);
  96124. }
  96125. /*
  96126. ** An SQL user-function registered to do the work of an DETACH statement. The
  96127. ** three arguments to the function come directly from a detach statement:
  96128. **
  96129. ** DETACH DATABASE x
  96130. **
  96131. ** SELECT sqlite_detach(x)
  96132. */
  96133. static void detachFunc(
  96134. sqlite3_context *context,
  96135. int NotUsed,
  96136. sqlite3_value **argv
  96137. ){
  96138. const char *zName = (const char *)sqlite3_value_text(argv[0]);
  96139. sqlite3 *db = sqlite3_context_db_handle(context);
  96140. int i;
  96141. Db *pDb = 0;
  96142. char zErr[128];
  96143. UNUSED_PARAMETER(NotUsed);
  96144. if( zName==0 ) zName = "";
  96145. for(i=0; i<db->nDb; i++){
  96146. pDb = &db->aDb[i];
  96147. if( pDb->pBt==0 ) continue;
  96148. if( sqlite3StrICmp(pDb->zDbSName, zName)==0 ) break;
  96149. }
  96150. if( i>=db->nDb ){
  96151. sqlite3_snprintf(sizeof(zErr),zErr, "no such database: %s", zName);
  96152. goto detach_error;
  96153. }
  96154. if( i<2 ){
  96155. sqlite3_snprintf(sizeof(zErr),zErr, "cannot detach database %s", zName);
  96156. goto detach_error;
  96157. }
  96158. if( sqlite3BtreeIsInReadTrans(pDb->pBt) || sqlite3BtreeIsInBackup(pDb->pBt) ){
  96159. sqlite3_snprintf(sizeof(zErr),zErr, "database %s is locked", zName);
  96160. goto detach_error;
  96161. }
  96162. sqlite3BtreeClose(pDb->pBt);
  96163. pDb->pBt = 0;
  96164. pDb->pSchema = 0;
  96165. sqlite3CollapseDatabaseArray(db);
  96166. return;
  96167. detach_error:
  96168. sqlite3_result_error(context, zErr, -1);
  96169. }
  96170. /*
  96171. ** This procedure generates VDBE code for a single invocation of either the
  96172. ** sqlite_detach() or sqlite_attach() SQL user functions.
  96173. */
  96174. static void codeAttach(
  96175. Parse *pParse, /* The parser context */
  96176. int type, /* Either SQLITE_ATTACH or SQLITE_DETACH */
  96177. FuncDef const *pFunc,/* FuncDef wrapper for detachFunc() or attachFunc() */
  96178. Expr *pAuthArg, /* Expression to pass to authorization callback */
  96179. Expr *pFilename, /* Name of database file */
  96180. Expr *pDbname, /* Name of the database to use internally */
  96181. Expr *pKey /* Database key for encryption extension */
  96182. ){
  96183. int rc;
  96184. NameContext sName;
  96185. Vdbe *v;
  96186. sqlite3* db = pParse->db;
  96187. int regArgs;
  96188. if( pParse->nErr ) goto attach_end;
  96189. memset(&sName, 0, sizeof(NameContext));
  96190. sName.pParse = pParse;
  96191. if(
  96192. SQLITE_OK!=(rc = resolveAttachExpr(&sName, pFilename)) ||
  96193. SQLITE_OK!=(rc = resolveAttachExpr(&sName, pDbname)) ||
  96194. SQLITE_OK!=(rc = resolveAttachExpr(&sName, pKey))
  96195. ){
  96196. goto attach_end;
  96197. }
  96198. #ifndef SQLITE_OMIT_AUTHORIZATION
  96199. if( pAuthArg ){
  96200. char *zAuthArg;
  96201. if( pAuthArg->op==TK_STRING ){
  96202. zAuthArg = pAuthArg->u.zToken;
  96203. }else{
  96204. zAuthArg = 0;
  96205. }
  96206. rc = sqlite3AuthCheck(pParse, type, zAuthArg, 0, 0);
  96207. if(rc!=SQLITE_OK ){
  96208. goto attach_end;
  96209. }
  96210. }
  96211. #endif /* SQLITE_OMIT_AUTHORIZATION */
  96212. v = sqlite3GetVdbe(pParse);
  96213. regArgs = sqlite3GetTempRange(pParse, 4);
  96214. sqlite3ExprCode(pParse, pFilename, regArgs);
  96215. sqlite3ExprCode(pParse, pDbname, regArgs+1);
  96216. sqlite3ExprCode(pParse, pKey, regArgs+2);
  96217. assert( v || db->mallocFailed );
  96218. if( v ){
  96219. sqlite3VdbeAddOp4(v, OP_Function0, 0, regArgs+3-pFunc->nArg, regArgs+3,
  96220. (char *)pFunc, P4_FUNCDEF);
  96221. assert( pFunc->nArg==-1 || (pFunc->nArg&0xff)==pFunc->nArg );
  96222. sqlite3VdbeChangeP5(v, (u8)(pFunc->nArg));
  96223. /* Code an OP_Expire. For an ATTACH statement, set P1 to true (expire this
  96224. ** statement only). For DETACH, set it to false (expire all existing
  96225. ** statements).
  96226. */
  96227. sqlite3VdbeAddOp1(v, OP_Expire, (type==SQLITE_ATTACH));
  96228. }
  96229. attach_end:
  96230. sqlite3ExprDelete(db, pFilename);
  96231. sqlite3ExprDelete(db, pDbname);
  96232. sqlite3ExprDelete(db, pKey);
  96233. }
  96234. /*
  96235. ** Called by the parser to compile a DETACH statement.
  96236. **
  96237. ** DETACH pDbname
  96238. */
  96239. SQLITE_PRIVATE void sqlite3Detach(Parse *pParse, Expr *pDbname){
  96240. static const FuncDef detach_func = {
  96241. 1, /* nArg */
  96242. SQLITE_UTF8, /* funcFlags */
  96243. 0, /* pUserData */
  96244. 0, /* pNext */
  96245. detachFunc, /* xSFunc */
  96246. 0, /* xFinalize */
  96247. "sqlite_detach", /* zName */
  96248. {0}
  96249. };
  96250. codeAttach(pParse, SQLITE_DETACH, &detach_func, pDbname, 0, 0, pDbname);
  96251. }
  96252. /*
  96253. ** Called by the parser to compile an ATTACH statement.
  96254. **
  96255. ** ATTACH p AS pDbname KEY pKey
  96256. */
  96257. SQLITE_PRIVATE void sqlite3Attach(Parse *pParse, Expr *p, Expr *pDbname, Expr *pKey){
  96258. static const FuncDef attach_func = {
  96259. 3, /* nArg */
  96260. SQLITE_UTF8, /* funcFlags */
  96261. 0, /* pUserData */
  96262. 0, /* pNext */
  96263. attachFunc, /* xSFunc */
  96264. 0, /* xFinalize */
  96265. "sqlite_attach", /* zName */
  96266. {0}
  96267. };
  96268. codeAttach(pParse, SQLITE_ATTACH, &attach_func, p, p, pDbname, pKey);
  96269. }
  96270. #endif /* SQLITE_OMIT_ATTACH */
  96271. /*
  96272. ** Initialize a DbFixer structure. This routine must be called prior
  96273. ** to passing the structure to one of the sqliteFixAAAA() routines below.
  96274. */
  96275. SQLITE_PRIVATE void sqlite3FixInit(
  96276. DbFixer *pFix, /* The fixer to be initialized */
  96277. Parse *pParse, /* Error messages will be written here */
  96278. int iDb, /* This is the database that must be used */
  96279. const char *zType, /* "view", "trigger", or "index" */
  96280. const Token *pName /* Name of the view, trigger, or index */
  96281. ){
  96282. sqlite3 *db;
  96283. db = pParse->db;
  96284. assert( db->nDb>iDb );
  96285. pFix->pParse = pParse;
  96286. pFix->zDb = db->aDb[iDb].zDbSName;
  96287. pFix->pSchema = db->aDb[iDb].pSchema;
  96288. pFix->zType = zType;
  96289. pFix->pName = pName;
  96290. pFix->bVarOnly = (iDb==1);
  96291. }
  96292. /*
  96293. ** The following set of routines walk through the parse tree and assign
  96294. ** a specific database to all table references where the database name
  96295. ** was left unspecified in the original SQL statement. The pFix structure
  96296. ** must have been initialized by a prior call to sqlite3FixInit().
  96297. **
  96298. ** These routines are used to make sure that an index, trigger, or
  96299. ** view in one database does not refer to objects in a different database.
  96300. ** (Exception: indices, triggers, and views in the TEMP database are
  96301. ** allowed to refer to anything.) If a reference is explicitly made
  96302. ** to an object in a different database, an error message is added to
  96303. ** pParse->zErrMsg and these routines return non-zero. If everything
  96304. ** checks out, these routines return 0.
  96305. */
  96306. SQLITE_PRIVATE int sqlite3FixSrcList(
  96307. DbFixer *pFix, /* Context of the fixation */
  96308. SrcList *pList /* The Source list to check and modify */
  96309. ){
  96310. int i;
  96311. const char *zDb;
  96312. struct SrcList_item *pItem;
  96313. if( NEVER(pList==0) ) return 0;
  96314. zDb = pFix->zDb;
  96315. for(i=0, pItem=pList->a; i<pList->nSrc; i++, pItem++){
  96316. if( pFix->bVarOnly==0 ){
  96317. if( pItem->zDatabase && sqlite3StrICmp(pItem->zDatabase, zDb) ){
  96318. sqlite3ErrorMsg(pFix->pParse,
  96319. "%s %T cannot reference objects in database %s",
  96320. pFix->zType, pFix->pName, pItem->zDatabase);
  96321. return 1;
  96322. }
  96323. sqlite3DbFree(pFix->pParse->db, pItem->zDatabase);
  96324. pItem->zDatabase = 0;
  96325. pItem->pSchema = pFix->pSchema;
  96326. }
  96327. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER)
  96328. if( sqlite3FixSelect(pFix, pItem->pSelect) ) return 1;
  96329. if( sqlite3FixExpr(pFix, pItem->pOn) ) return 1;
  96330. #endif
  96331. }
  96332. return 0;
  96333. }
  96334. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER)
  96335. SQLITE_PRIVATE int sqlite3FixSelect(
  96336. DbFixer *pFix, /* Context of the fixation */
  96337. Select *pSelect /* The SELECT statement to be fixed to one database */
  96338. ){
  96339. while( pSelect ){
  96340. if( sqlite3FixExprList(pFix, pSelect->pEList) ){
  96341. return 1;
  96342. }
  96343. if( sqlite3FixSrcList(pFix, pSelect->pSrc) ){
  96344. return 1;
  96345. }
  96346. if( sqlite3FixExpr(pFix, pSelect->pWhere) ){
  96347. return 1;
  96348. }
  96349. if( sqlite3FixExprList(pFix, pSelect->pGroupBy) ){
  96350. return 1;
  96351. }
  96352. if( sqlite3FixExpr(pFix, pSelect->pHaving) ){
  96353. return 1;
  96354. }
  96355. if( sqlite3FixExprList(pFix, pSelect->pOrderBy) ){
  96356. return 1;
  96357. }
  96358. if( sqlite3FixExpr(pFix, pSelect->pLimit) ){
  96359. return 1;
  96360. }
  96361. if( pSelect->pWith ){
  96362. int i;
  96363. for(i=0; i<pSelect->pWith->nCte; i++){
  96364. if( sqlite3FixSelect(pFix, pSelect->pWith->a[i].pSelect) ){
  96365. return 1;
  96366. }
  96367. }
  96368. }
  96369. pSelect = pSelect->pPrior;
  96370. }
  96371. return 0;
  96372. }
  96373. SQLITE_PRIVATE int sqlite3FixExpr(
  96374. DbFixer *pFix, /* Context of the fixation */
  96375. Expr *pExpr /* The expression to be fixed to one database */
  96376. ){
  96377. while( pExpr ){
  96378. if( pExpr->op==TK_VARIABLE ){
  96379. if( pFix->pParse->db->init.busy ){
  96380. pExpr->op = TK_NULL;
  96381. }else{
  96382. sqlite3ErrorMsg(pFix->pParse, "%s cannot use variables", pFix->zType);
  96383. return 1;
  96384. }
  96385. }
  96386. if( ExprHasProperty(pExpr, EP_TokenOnly|EP_Leaf) ) break;
  96387. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  96388. if( sqlite3FixSelect(pFix, pExpr->x.pSelect) ) return 1;
  96389. }else{
  96390. if( sqlite3FixExprList(pFix, pExpr->x.pList) ) return 1;
  96391. }
  96392. if( sqlite3FixExpr(pFix, pExpr->pRight) ){
  96393. return 1;
  96394. }
  96395. pExpr = pExpr->pLeft;
  96396. }
  96397. return 0;
  96398. }
  96399. SQLITE_PRIVATE int sqlite3FixExprList(
  96400. DbFixer *pFix, /* Context of the fixation */
  96401. ExprList *pList /* The expression to be fixed to one database */
  96402. ){
  96403. int i;
  96404. struct ExprList_item *pItem;
  96405. if( pList==0 ) return 0;
  96406. for(i=0, pItem=pList->a; i<pList->nExpr; i++, pItem++){
  96407. if( sqlite3FixExpr(pFix, pItem->pExpr) ){
  96408. return 1;
  96409. }
  96410. }
  96411. return 0;
  96412. }
  96413. #endif
  96414. #ifndef SQLITE_OMIT_TRIGGER
  96415. SQLITE_PRIVATE int sqlite3FixTriggerStep(
  96416. DbFixer *pFix, /* Context of the fixation */
  96417. TriggerStep *pStep /* The trigger step be fixed to one database */
  96418. ){
  96419. while( pStep ){
  96420. if( sqlite3FixSelect(pFix, pStep->pSelect) ){
  96421. return 1;
  96422. }
  96423. if( sqlite3FixExpr(pFix, pStep->pWhere) ){
  96424. return 1;
  96425. }
  96426. if( sqlite3FixExprList(pFix, pStep->pExprList) ){
  96427. return 1;
  96428. }
  96429. pStep = pStep->pNext;
  96430. }
  96431. return 0;
  96432. }
  96433. #endif
  96434. /************** End of attach.c **********************************************/
  96435. /************** Begin file auth.c ********************************************/
  96436. /*
  96437. ** 2003 January 11
  96438. **
  96439. ** The author disclaims copyright to this source code. In place of
  96440. ** a legal notice, here is a blessing:
  96441. **
  96442. ** May you do good and not evil.
  96443. ** May you find forgiveness for yourself and forgive others.
  96444. ** May you share freely, never taking more than you give.
  96445. **
  96446. *************************************************************************
  96447. ** This file contains code used to implement the sqlite3_set_authorizer()
  96448. ** API. This facility is an optional feature of the library. Embedded
  96449. ** systems that do not need this facility may omit it by recompiling
  96450. ** the library with -DSQLITE_OMIT_AUTHORIZATION=1
  96451. */
  96452. /* #include "sqliteInt.h" */
  96453. /*
  96454. ** All of the code in this file may be omitted by defining a single
  96455. ** macro.
  96456. */
  96457. #ifndef SQLITE_OMIT_AUTHORIZATION
  96458. /*
  96459. ** Set or clear the access authorization function.
  96460. **
  96461. ** The access authorization function is be called during the compilation
  96462. ** phase to verify that the user has read and/or write access permission on
  96463. ** various fields of the database. The first argument to the auth function
  96464. ** is a copy of the 3rd argument to this routine. The second argument
  96465. ** to the auth function is one of these constants:
  96466. **
  96467. ** SQLITE_CREATE_INDEX
  96468. ** SQLITE_CREATE_TABLE
  96469. ** SQLITE_CREATE_TEMP_INDEX
  96470. ** SQLITE_CREATE_TEMP_TABLE
  96471. ** SQLITE_CREATE_TEMP_TRIGGER
  96472. ** SQLITE_CREATE_TEMP_VIEW
  96473. ** SQLITE_CREATE_TRIGGER
  96474. ** SQLITE_CREATE_VIEW
  96475. ** SQLITE_DELETE
  96476. ** SQLITE_DROP_INDEX
  96477. ** SQLITE_DROP_TABLE
  96478. ** SQLITE_DROP_TEMP_INDEX
  96479. ** SQLITE_DROP_TEMP_TABLE
  96480. ** SQLITE_DROP_TEMP_TRIGGER
  96481. ** SQLITE_DROP_TEMP_VIEW
  96482. ** SQLITE_DROP_TRIGGER
  96483. ** SQLITE_DROP_VIEW
  96484. ** SQLITE_INSERT
  96485. ** SQLITE_PRAGMA
  96486. ** SQLITE_READ
  96487. ** SQLITE_SELECT
  96488. ** SQLITE_TRANSACTION
  96489. ** SQLITE_UPDATE
  96490. **
  96491. ** The third and fourth arguments to the auth function are the name of
  96492. ** the table and the column that are being accessed. The auth function
  96493. ** should return either SQLITE_OK, SQLITE_DENY, or SQLITE_IGNORE. If
  96494. ** SQLITE_OK is returned, it means that access is allowed. SQLITE_DENY
  96495. ** means that the SQL statement will never-run - the sqlite3_exec() call
  96496. ** will return with an error. SQLITE_IGNORE means that the SQL statement
  96497. ** should run but attempts to read the specified column will return NULL
  96498. ** and attempts to write the column will be ignored.
  96499. **
  96500. ** Setting the auth function to NULL disables this hook. The default
  96501. ** setting of the auth function is NULL.
  96502. */
  96503. SQLITE_API int sqlite3_set_authorizer(
  96504. sqlite3 *db,
  96505. int (*xAuth)(void*,int,const char*,const char*,const char*,const char*),
  96506. void *pArg
  96507. ){
  96508. #ifdef SQLITE_ENABLE_API_ARMOR
  96509. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  96510. #endif
  96511. sqlite3_mutex_enter(db->mutex);
  96512. db->xAuth = (sqlite3_xauth)xAuth;
  96513. db->pAuthArg = pArg;
  96514. sqlite3ExpirePreparedStatements(db);
  96515. sqlite3_mutex_leave(db->mutex);
  96516. return SQLITE_OK;
  96517. }
  96518. /*
  96519. ** Write an error message into pParse->zErrMsg that explains that the
  96520. ** user-supplied authorization function returned an illegal value.
  96521. */
  96522. static void sqliteAuthBadReturnCode(Parse *pParse){
  96523. sqlite3ErrorMsg(pParse, "authorizer malfunction");
  96524. pParse->rc = SQLITE_ERROR;
  96525. }
  96526. /*
  96527. ** Invoke the authorization callback for permission to read column zCol from
  96528. ** table zTab in database zDb. This function assumes that an authorization
  96529. ** callback has been registered (i.e. that sqlite3.xAuth is not NULL).
  96530. **
  96531. ** If SQLITE_IGNORE is returned and pExpr is not NULL, then pExpr is changed
  96532. ** to an SQL NULL expression. Otherwise, if pExpr is NULL, then SQLITE_IGNORE
  96533. ** is treated as SQLITE_DENY. In this case an error is left in pParse.
  96534. */
  96535. SQLITE_PRIVATE int sqlite3AuthReadCol(
  96536. Parse *pParse, /* The parser context */
  96537. const char *zTab, /* Table name */
  96538. const char *zCol, /* Column name */
  96539. int iDb /* Index of containing database. */
  96540. ){
  96541. sqlite3 *db = pParse->db; /* Database handle */
  96542. char *zDb = db->aDb[iDb].zDbSName; /* Schema name of attached database */
  96543. int rc; /* Auth callback return code */
  96544. if( db->init.busy ) return SQLITE_OK;
  96545. rc = db->xAuth(db->pAuthArg, SQLITE_READ, zTab,zCol,zDb,pParse->zAuthContext
  96546. #ifdef SQLITE_USER_AUTHENTICATION
  96547. ,db->auth.zAuthUser
  96548. #endif
  96549. );
  96550. if( rc==SQLITE_DENY ){
  96551. char *z = sqlite3_mprintf("%s.%s", zTab, zCol);
  96552. if( db->nDb>2 || iDb!=0 ) z = sqlite3_mprintf("%s.%z", zDb, z);
  96553. sqlite3ErrorMsg(pParse, "access to %z is prohibited", z);
  96554. pParse->rc = SQLITE_AUTH;
  96555. }else if( rc!=SQLITE_IGNORE && rc!=SQLITE_OK ){
  96556. sqliteAuthBadReturnCode(pParse);
  96557. }
  96558. return rc;
  96559. }
  96560. /*
  96561. ** The pExpr should be a TK_COLUMN expression. The table referred to
  96562. ** is in pTabList or else it is the NEW or OLD table of a trigger.
  96563. ** Check to see if it is OK to read this particular column.
  96564. **
  96565. ** If the auth function returns SQLITE_IGNORE, change the TK_COLUMN
  96566. ** instruction into a TK_NULL. If the auth function returns SQLITE_DENY,
  96567. ** then generate an error.
  96568. */
  96569. SQLITE_PRIVATE void sqlite3AuthRead(
  96570. Parse *pParse, /* The parser context */
  96571. Expr *pExpr, /* The expression to check authorization on */
  96572. Schema *pSchema, /* The schema of the expression */
  96573. SrcList *pTabList /* All table that pExpr might refer to */
  96574. ){
  96575. sqlite3 *db = pParse->db;
  96576. Table *pTab = 0; /* The table being read */
  96577. const char *zCol; /* Name of the column of the table */
  96578. int iSrc; /* Index in pTabList->a[] of table being read */
  96579. int iDb; /* The index of the database the expression refers to */
  96580. int iCol; /* Index of column in table */
  96581. if( db->xAuth==0 ) return;
  96582. iDb = sqlite3SchemaToIndex(pParse->db, pSchema);
  96583. if( iDb<0 ){
  96584. /* An attempt to read a column out of a subquery or other
  96585. ** temporary table. */
  96586. return;
  96587. }
  96588. assert( pExpr->op==TK_COLUMN || pExpr->op==TK_TRIGGER );
  96589. if( pExpr->op==TK_TRIGGER ){
  96590. pTab = pParse->pTriggerTab;
  96591. }else{
  96592. assert( pTabList );
  96593. for(iSrc=0; ALWAYS(iSrc<pTabList->nSrc); iSrc++){
  96594. if( pExpr->iTable==pTabList->a[iSrc].iCursor ){
  96595. pTab = pTabList->a[iSrc].pTab;
  96596. break;
  96597. }
  96598. }
  96599. }
  96600. iCol = pExpr->iColumn;
  96601. if( NEVER(pTab==0) ) return;
  96602. if( iCol>=0 ){
  96603. assert( iCol<pTab->nCol );
  96604. zCol = pTab->aCol[iCol].zName;
  96605. }else if( pTab->iPKey>=0 ){
  96606. assert( pTab->iPKey<pTab->nCol );
  96607. zCol = pTab->aCol[pTab->iPKey].zName;
  96608. }else{
  96609. zCol = "ROWID";
  96610. }
  96611. assert( iDb>=0 && iDb<db->nDb );
  96612. if( SQLITE_IGNORE==sqlite3AuthReadCol(pParse, pTab->zName, zCol, iDb) ){
  96613. pExpr->op = TK_NULL;
  96614. }
  96615. }
  96616. /*
  96617. ** Do an authorization check using the code and arguments given. Return
  96618. ** either SQLITE_OK (zero) or SQLITE_IGNORE or SQLITE_DENY. If SQLITE_DENY
  96619. ** is returned, then the error count and error message in pParse are
  96620. ** modified appropriately.
  96621. */
  96622. SQLITE_PRIVATE int sqlite3AuthCheck(
  96623. Parse *pParse,
  96624. int code,
  96625. const char *zArg1,
  96626. const char *zArg2,
  96627. const char *zArg3
  96628. ){
  96629. sqlite3 *db = pParse->db;
  96630. int rc;
  96631. /* Don't do any authorization checks if the database is initialising
  96632. ** or if the parser is being invoked from within sqlite3_declare_vtab.
  96633. */
  96634. if( db->init.busy || IN_DECLARE_VTAB ){
  96635. return SQLITE_OK;
  96636. }
  96637. if( db->xAuth==0 ){
  96638. return SQLITE_OK;
  96639. }
  96640. /* EVIDENCE-OF: R-43249-19882 The third through sixth parameters to the
  96641. ** callback are either NULL pointers or zero-terminated strings that
  96642. ** contain additional details about the action to be authorized.
  96643. **
  96644. ** The following testcase() macros show that any of the 3rd through 6th
  96645. ** parameters can be either NULL or a string. */
  96646. testcase( zArg1==0 );
  96647. testcase( zArg2==0 );
  96648. testcase( zArg3==0 );
  96649. testcase( pParse->zAuthContext==0 );
  96650. rc = db->xAuth(db->pAuthArg, code, zArg1, zArg2, zArg3, pParse->zAuthContext
  96651. #ifdef SQLITE_USER_AUTHENTICATION
  96652. ,db->auth.zAuthUser
  96653. #endif
  96654. );
  96655. if( rc==SQLITE_DENY ){
  96656. sqlite3ErrorMsg(pParse, "not authorized");
  96657. pParse->rc = SQLITE_AUTH;
  96658. }else if( rc!=SQLITE_OK && rc!=SQLITE_IGNORE ){
  96659. rc = SQLITE_DENY;
  96660. sqliteAuthBadReturnCode(pParse);
  96661. }
  96662. return rc;
  96663. }
  96664. /*
  96665. ** Push an authorization context. After this routine is called, the
  96666. ** zArg3 argument to authorization callbacks will be zContext until
  96667. ** popped. Or if pParse==0, this routine is a no-op.
  96668. */
  96669. SQLITE_PRIVATE void sqlite3AuthContextPush(
  96670. Parse *pParse,
  96671. AuthContext *pContext,
  96672. const char *zContext
  96673. ){
  96674. assert( pParse );
  96675. pContext->pParse = pParse;
  96676. pContext->zAuthContext = pParse->zAuthContext;
  96677. pParse->zAuthContext = zContext;
  96678. }
  96679. /*
  96680. ** Pop an authorization context that was previously pushed
  96681. ** by sqlite3AuthContextPush
  96682. */
  96683. SQLITE_PRIVATE void sqlite3AuthContextPop(AuthContext *pContext){
  96684. if( pContext->pParse ){
  96685. pContext->pParse->zAuthContext = pContext->zAuthContext;
  96686. pContext->pParse = 0;
  96687. }
  96688. }
  96689. #endif /* SQLITE_OMIT_AUTHORIZATION */
  96690. /************** End of auth.c ************************************************/
  96691. /************** Begin file build.c *******************************************/
  96692. /*
  96693. ** 2001 September 15
  96694. **
  96695. ** The author disclaims copyright to this source code. In place of
  96696. ** a legal notice, here is a blessing:
  96697. **
  96698. ** May you do good and not evil.
  96699. ** May you find forgiveness for yourself and forgive others.
  96700. ** May you share freely, never taking more than you give.
  96701. **
  96702. *************************************************************************
  96703. ** This file contains C code routines that are called by the SQLite parser
  96704. ** when syntax rules are reduced. The routines in this file handle the
  96705. ** following kinds of SQL syntax:
  96706. **
  96707. ** CREATE TABLE
  96708. ** DROP TABLE
  96709. ** CREATE INDEX
  96710. ** DROP INDEX
  96711. ** creating ID lists
  96712. ** BEGIN TRANSACTION
  96713. ** COMMIT
  96714. ** ROLLBACK
  96715. */
  96716. /* #include "sqliteInt.h" */
  96717. #ifndef SQLITE_OMIT_SHARED_CACHE
  96718. /*
  96719. ** The TableLock structure is only used by the sqlite3TableLock() and
  96720. ** codeTableLocks() functions.
  96721. */
  96722. struct TableLock {
  96723. int iDb; /* The database containing the table to be locked */
  96724. int iTab; /* The root page of the table to be locked */
  96725. u8 isWriteLock; /* True for write lock. False for a read lock */
  96726. const char *zLockName; /* Name of the table */
  96727. };
  96728. /*
  96729. ** Record the fact that we want to lock a table at run-time.
  96730. **
  96731. ** The table to be locked has root page iTab and is found in database iDb.
  96732. ** A read or a write lock can be taken depending on isWritelock.
  96733. **
  96734. ** This routine just records the fact that the lock is desired. The
  96735. ** code to make the lock occur is generated by a later call to
  96736. ** codeTableLocks() which occurs during sqlite3FinishCoding().
  96737. */
  96738. SQLITE_PRIVATE void sqlite3TableLock(
  96739. Parse *pParse, /* Parsing context */
  96740. int iDb, /* Index of the database containing the table to lock */
  96741. int iTab, /* Root page number of the table to be locked */
  96742. u8 isWriteLock, /* True for a write lock */
  96743. const char *zName /* Name of the table to be locked */
  96744. ){
  96745. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  96746. int i;
  96747. int nBytes;
  96748. TableLock *p;
  96749. assert( iDb>=0 );
  96750. if( iDb==1 ) return;
  96751. if( !sqlite3BtreeSharable(pParse->db->aDb[iDb].pBt) ) return;
  96752. for(i=0; i<pToplevel->nTableLock; i++){
  96753. p = &pToplevel->aTableLock[i];
  96754. if( p->iDb==iDb && p->iTab==iTab ){
  96755. p->isWriteLock = (p->isWriteLock || isWriteLock);
  96756. return;
  96757. }
  96758. }
  96759. nBytes = sizeof(TableLock) * (pToplevel->nTableLock+1);
  96760. pToplevel->aTableLock =
  96761. sqlite3DbReallocOrFree(pToplevel->db, pToplevel->aTableLock, nBytes);
  96762. if( pToplevel->aTableLock ){
  96763. p = &pToplevel->aTableLock[pToplevel->nTableLock++];
  96764. p->iDb = iDb;
  96765. p->iTab = iTab;
  96766. p->isWriteLock = isWriteLock;
  96767. p->zLockName = zName;
  96768. }else{
  96769. pToplevel->nTableLock = 0;
  96770. sqlite3OomFault(pToplevel->db);
  96771. }
  96772. }
  96773. /*
  96774. ** Code an OP_TableLock instruction for each table locked by the
  96775. ** statement (configured by calls to sqlite3TableLock()).
  96776. */
  96777. static void codeTableLocks(Parse *pParse){
  96778. int i;
  96779. Vdbe *pVdbe;
  96780. pVdbe = sqlite3GetVdbe(pParse);
  96781. assert( pVdbe!=0 ); /* sqlite3GetVdbe cannot fail: VDBE already allocated */
  96782. for(i=0; i<pParse->nTableLock; i++){
  96783. TableLock *p = &pParse->aTableLock[i];
  96784. int p1 = p->iDb;
  96785. sqlite3VdbeAddOp4(pVdbe, OP_TableLock, p1, p->iTab, p->isWriteLock,
  96786. p->zLockName, P4_STATIC);
  96787. }
  96788. }
  96789. #else
  96790. #define codeTableLocks(x)
  96791. #endif
  96792. /*
  96793. ** Return TRUE if the given yDbMask object is empty - if it contains no
  96794. ** 1 bits. This routine is used by the DbMaskAllZero() and DbMaskNotZero()
  96795. ** macros when SQLITE_MAX_ATTACHED is greater than 30.
  96796. */
  96797. #if SQLITE_MAX_ATTACHED>30
  96798. SQLITE_PRIVATE int sqlite3DbMaskAllZero(yDbMask m){
  96799. int i;
  96800. for(i=0; i<sizeof(yDbMask); i++) if( m[i] ) return 0;
  96801. return 1;
  96802. }
  96803. #endif
  96804. /*
  96805. ** This routine is called after a single SQL statement has been
  96806. ** parsed and a VDBE program to execute that statement has been
  96807. ** prepared. This routine puts the finishing touches on the
  96808. ** VDBE program and resets the pParse structure for the next
  96809. ** parse.
  96810. **
  96811. ** Note that if an error occurred, it might be the case that
  96812. ** no VDBE code was generated.
  96813. */
  96814. SQLITE_PRIVATE void sqlite3FinishCoding(Parse *pParse){
  96815. sqlite3 *db;
  96816. Vdbe *v;
  96817. assert( pParse->pToplevel==0 );
  96818. db = pParse->db;
  96819. if( pParse->nested ) return;
  96820. if( db->mallocFailed || pParse->nErr ){
  96821. if( pParse->rc==SQLITE_OK ) pParse->rc = SQLITE_ERROR;
  96822. return;
  96823. }
  96824. /* Begin by generating some termination code at the end of the
  96825. ** vdbe program
  96826. */
  96827. v = sqlite3GetVdbe(pParse);
  96828. assert( !pParse->isMultiWrite
  96829. || sqlite3VdbeAssertMayAbort(v, pParse->mayAbort));
  96830. if( v ){
  96831. sqlite3VdbeAddOp0(v, OP_Halt);
  96832. #if SQLITE_USER_AUTHENTICATION
  96833. if( pParse->nTableLock>0 && db->init.busy==0 ){
  96834. sqlite3UserAuthInit(db);
  96835. if( db->auth.authLevel<UAUTH_User ){
  96836. sqlite3ErrorMsg(pParse, "user not authenticated");
  96837. pParse->rc = SQLITE_AUTH_USER;
  96838. return;
  96839. }
  96840. }
  96841. #endif
  96842. /* The cookie mask contains one bit for each database file open.
  96843. ** (Bit 0 is for main, bit 1 is for temp, and so forth.) Bits are
  96844. ** set for each database that is used. Generate code to start a
  96845. ** transaction on each used database and to verify the schema cookie
  96846. ** on each used database.
  96847. */
  96848. if( db->mallocFailed==0
  96849. && (DbMaskNonZero(pParse->cookieMask) || pParse->pConstExpr)
  96850. ){
  96851. int iDb, i;
  96852. assert( sqlite3VdbeGetOp(v, 0)->opcode==OP_Init );
  96853. sqlite3VdbeJumpHere(v, 0);
  96854. for(iDb=0; iDb<db->nDb; iDb++){
  96855. Schema *pSchema;
  96856. if( DbMaskTest(pParse->cookieMask, iDb)==0 ) continue;
  96857. sqlite3VdbeUsesBtree(v, iDb);
  96858. pSchema = db->aDb[iDb].pSchema;
  96859. sqlite3VdbeAddOp4Int(v,
  96860. OP_Transaction, /* Opcode */
  96861. iDb, /* P1 */
  96862. DbMaskTest(pParse->writeMask,iDb), /* P2 */
  96863. pSchema->schema_cookie, /* P3 */
  96864. pSchema->iGeneration /* P4 */
  96865. );
  96866. if( db->init.busy==0 ) sqlite3VdbeChangeP5(v, 1);
  96867. VdbeComment((v,
  96868. "usesStmtJournal=%d", pParse->mayAbort && pParse->isMultiWrite));
  96869. }
  96870. #ifndef SQLITE_OMIT_VIRTUALTABLE
  96871. for(i=0; i<pParse->nVtabLock; i++){
  96872. char *vtab = (char *)sqlite3GetVTable(db, pParse->apVtabLock[i]);
  96873. sqlite3VdbeAddOp4(v, OP_VBegin, 0, 0, 0, vtab, P4_VTAB);
  96874. }
  96875. pParse->nVtabLock = 0;
  96876. #endif
  96877. /* Once all the cookies have been verified and transactions opened,
  96878. ** obtain the required table-locks. This is a no-op unless the
  96879. ** shared-cache feature is enabled.
  96880. */
  96881. codeTableLocks(pParse);
  96882. /* Initialize any AUTOINCREMENT data structures required.
  96883. */
  96884. sqlite3AutoincrementBegin(pParse);
  96885. /* Code constant expressions that where factored out of inner loops */
  96886. if( pParse->pConstExpr ){
  96887. ExprList *pEL = pParse->pConstExpr;
  96888. pParse->okConstFactor = 0;
  96889. for(i=0; i<pEL->nExpr; i++){
  96890. sqlite3ExprCode(pParse, pEL->a[i].pExpr, pEL->a[i].u.iConstExprReg);
  96891. }
  96892. }
  96893. /* Finally, jump back to the beginning of the executable code. */
  96894. sqlite3VdbeGoto(v, 1);
  96895. }
  96896. }
  96897. /* Get the VDBE program ready for execution
  96898. */
  96899. if( v && pParse->nErr==0 && !db->mallocFailed ){
  96900. assert( pParse->iCacheLevel==0 ); /* Disables and re-enables match */
  96901. /* A minimum of one cursor is required if autoincrement is used
  96902. * See ticket [a696379c1f08866] */
  96903. if( pParse->pAinc!=0 && pParse->nTab==0 ) pParse->nTab = 1;
  96904. sqlite3VdbeMakeReady(v, pParse);
  96905. pParse->rc = SQLITE_DONE;
  96906. }else{
  96907. pParse->rc = SQLITE_ERROR;
  96908. }
  96909. }
  96910. /*
  96911. ** Run the parser and code generator recursively in order to generate
  96912. ** code for the SQL statement given onto the end of the pParse context
  96913. ** currently under construction. When the parser is run recursively
  96914. ** this way, the final OP_Halt is not appended and other initialization
  96915. ** and finalization steps are omitted because those are handling by the
  96916. ** outermost parser.
  96917. **
  96918. ** Not everything is nestable. This facility is designed to permit
  96919. ** INSERT, UPDATE, and DELETE operations against SQLITE_MASTER. Use
  96920. ** care if you decide to try to use this routine for some other purposes.
  96921. */
  96922. SQLITE_PRIVATE void sqlite3NestedParse(Parse *pParse, const char *zFormat, ...){
  96923. va_list ap;
  96924. char *zSql;
  96925. char *zErrMsg = 0;
  96926. sqlite3 *db = pParse->db;
  96927. char saveBuf[PARSE_TAIL_SZ];
  96928. if( pParse->nErr ) return;
  96929. assert( pParse->nested<10 ); /* Nesting should only be of limited depth */
  96930. va_start(ap, zFormat);
  96931. zSql = sqlite3VMPrintf(db, zFormat, ap);
  96932. va_end(ap);
  96933. if( zSql==0 ){
  96934. return; /* A malloc must have failed */
  96935. }
  96936. pParse->nested++;
  96937. memcpy(saveBuf, PARSE_TAIL(pParse), PARSE_TAIL_SZ);
  96938. memset(PARSE_TAIL(pParse), 0, PARSE_TAIL_SZ);
  96939. sqlite3RunParser(pParse, zSql, &zErrMsg);
  96940. sqlite3DbFree(db, zErrMsg);
  96941. sqlite3DbFree(db, zSql);
  96942. memcpy(PARSE_TAIL(pParse), saveBuf, PARSE_TAIL_SZ);
  96943. pParse->nested--;
  96944. }
  96945. #if SQLITE_USER_AUTHENTICATION
  96946. /*
  96947. ** Return TRUE if zTable is the name of the system table that stores the
  96948. ** list of users and their access credentials.
  96949. */
  96950. SQLITE_PRIVATE int sqlite3UserAuthTable(const char *zTable){
  96951. return sqlite3_stricmp(zTable, "sqlite_user")==0;
  96952. }
  96953. #endif
  96954. /*
  96955. ** Locate the in-memory structure that describes a particular database
  96956. ** table given the name of that table and (optionally) the name of the
  96957. ** database containing the table. Return NULL if not found.
  96958. **
  96959. ** If zDatabase is 0, all databases are searched for the table and the
  96960. ** first matching table is returned. (No checking for duplicate table
  96961. ** names is done.) The search order is TEMP first, then MAIN, then any
  96962. ** auxiliary databases added using the ATTACH command.
  96963. **
  96964. ** See also sqlite3LocateTable().
  96965. */
  96966. SQLITE_PRIVATE Table *sqlite3FindTable(sqlite3 *db, const char *zName, const char *zDatabase){
  96967. Table *p = 0;
  96968. int i;
  96969. /* All mutexes are required for schema access. Make sure we hold them. */
  96970. assert( zDatabase!=0 || sqlite3BtreeHoldsAllMutexes(db) );
  96971. #if SQLITE_USER_AUTHENTICATION
  96972. /* Only the admin user is allowed to know that the sqlite_user table
  96973. ** exists */
  96974. if( db->auth.authLevel<UAUTH_Admin && sqlite3UserAuthTable(zName)!=0 ){
  96975. return 0;
  96976. }
  96977. #endif
  96978. while(1){
  96979. for(i=OMIT_TEMPDB; i<db->nDb; i++){
  96980. int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
  96981. if( zDatabase==0 || sqlite3StrICmp(zDatabase, db->aDb[j].zDbSName)==0 ){
  96982. assert( sqlite3SchemaMutexHeld(db, j, 0) );
  96983. p = sqlite3HashFind(&db->aDb[j].pSchema->tblHash, zName);
  96984. if( p ) return p;
  96985. }
  96986. }
  96987. /* Not found. If the name we were looking for was temp.sqlite_master
  96988. ** then change the name to sqlite_temp_master and try again. */
  96989. if( sqlite3StrICmp(zName, MASTER_NAME)!=0 ) break;
  96990. if( sqlite3_stricmp(zDatabase, db->aDb[1].zDbSName)!=0 ) break;
  96991. zName = TEMP_MASTER_NAME;
  96992. }
  96993. return 0;
  96994. }
  96995. /*
  96996. ** Locate the in-memory structure that describes a particular database
  96997. ** table given the name of that table and (optionally) the name of the
  96998. ** database containing the table. Return NULL if not found. Also leave an
  96999. ** error message in pParse->zErrMsg.
  97000. **
  97001. ** The difference between this routine and sqlite3FindTable() is that this
  97002. ** routine leaves an error message in pParse->zErrMsg where
  97003. ** sqlite3FindTable() does not.
  97004. */
  97005. SQLITE_PRIVATE Table *sqlite3LocateTable(
  97006. Parse *pParse, /* context in which to report errors */
  97007. u32 flags, /* LOCATE_VIEW or LOCATE_NOERR */
  97008. const char *zName, /* Name of the table we are looking for */
  97009. const char *zDbase /* Name of the database. Might be NULL */
  97010. ){
  97011. Table *p;
  97012. /* Read the database schema. If an error occurs, leave an error message
  97013. ** and code in pParse and return NULL. */
  97014. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  97015. return 0;
  97016. }
  97017. p = sqlite3FindTable(pParse->db, zName, zDbase);
  97018. if( p==0 ){
  97019. const char *zMsg = flags & LOCATE_VIEW ? "no such view" : "no such table";
  97020. #ifndef SQLITE_OMIT_VIRTUALTABLE
  97021. if( sqlite3FindDbName(pParse->db, zDbase)<1 ){
  97022. /* If zName is the not the name of a table in the schema created using
  97023. ** CREATE, then check to see if it is the name of an virtual table that
  97024. ** can be an eponymous virtual table. */
  97025. Module *pMod = (Module*)sqlite3HashFind(&pParse->db->aModule, zName);
  97026. if( pMod==0 && sqlite3_strnicmp(zName, "pragma_", 7)==0 ){
  97027. pMod = sqlite3PragmaVtabRegister(pParse->db, zName);
  97028. }
  97029. if( pMod && sqlite3VtabEponymousTableInit(pParse, pMod) ){
  97030. return pMod->pEpoTab;
  97031. }
  97032. }
  97033. #endif
  97034. if( (flags & LOCATE_NOERR)==0 ){
  97035. if( zDbase ){
  97036. sqlite3ErrorMsg(pParse, "%s: %s.%s", zMsg, zDbase, zName);
  97037. }else{
  97038. sqlite3ErrorMsg(pParse, "%s: %s", zMsg, zName);
  97039. }
  97040. pParse->checkSchema = 1;
  97041. }
  97042. }
  97043. return p;
  97044. }
  97045. /*
  97046. ** Locate the table identified by *p.
  97047. **
  97048. ** This is a wrapper around sqlite3LocateTable(). The difference between
  97049. ** sqlite3LocateTable() and this function is that this function restricts
  97050. ** the search to schema (p->pSchema) if it is not NULL. p->pSchema may be
  97051. ** non-NULL if it is part of a view or trigger program definition. See
  97052. ** sqlite3FixSrcList() for details.
  97053. */
  97054. SQLITE_PRIVATE Table *sqlite3LocateTableItem(
  97055. Parse *pParse,
  97056. u32 flags,
  97057. struct SrcList_item *p
  97058. ){
  97059. const char *zDb;
  97060. assert( p->pSchema==0 || p->zDatabase==0 );
  97061. if( p->pSchema ){
  97062. int iDb = sqlite3SchemaToIndex(pParse->db, p->pSchema);
  97063. zDb = pParse->db->aDb[iDb].zDbSName;
  97064. }else{
  97065. zDb = p->zDatabase;
  97066. }
  97067. return sqlite3LocateTable(pParse, flags, p->zName, zDb);
  97068. }
  97069. /*
  97070. ** Locate the in-memory structure that describes
  97071. ** a particular index given the name of that index
  97072. ** and the name of the database that contains the index.
  97073. ** Return NULL if not found.
  97074. **
  97075. ** If zDatabase is 0, all databases are searched for the
  97076. ** table and the first matching index is returned. (No checking
  97077. ** for duplicate index names is done.) The search order is
  97078. ** TEMP first, then MAIN, then any auxiliary databases added
  97079. ** using the ATTACH command.
  97080. */
  97081. SQLITE_PRIVATE Index *sqlite3FindIndex(sqlite3 *db, const char *zName, const char *zDb){
  97082. Index *p = 0;
  97083. int i;
  97084. /* All mutexes are required for schema access. Make sure we hold them. */
  97085. assert( zDb!=0 || sqlite3BtreeHoldsAllMutexes(db) );
  97086. for(i=OMIT_TEMPDB; i<db->nDb; i++){
  97087. int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
  97088. Schema *pSchema = db->aDb[j].pSchema;
  97089. assert( pSchema );
  97090. if( zDb && sqlite3StrICmp(zDb, db->aDb[j].zDbSName) ) continue;
  97091. assert( sqlite3SchemaMutexHeld(db, j, 0) );
  97092. p = sqlite3HashFind(&pSchema->idxHash, zName);
  97093. if( p ) break;
  97094. }
  97095. return p;
  97096. }
  97097. /*
  97098. ** Reclaim the memory used by an index
  97099. */
  97100. static void freeIndex(sqlite3 *db, Index *p){
  97101. #ifndef SQLITE_OMIT_ANALYZE
  97102. sqlite3DeleteIndexSamples(db, p);
  97103. #endif
  97104. sqlite3ExprDelete(db, p->pPartIdxWhere);
  97105. sqlite3ExprListDelete(db, p->aColExpr);
  97106. sqlite3DbFree(db, p->zColAff);
  97107. if( p->isResized ) sqlite3DbFree(db, (void *)p->azColl);
  97108. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  97109. sqlite3_free(p->aiRowEst);
  97110. #endif
  97111. sqlite3DbFree(db, p);
  97112. }
  97113. /*
  97114. ** For the index called zIdxName which is found in the database iDb,
  97115. ** unlike that index from its Table then remove the index from
  97116. ** the index hash table and free all memory structures associated
  97117. ** with the index.
  97118. */
  97119. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteIndex(sqlite3 *db, int iDb, const char *zIdxName){
  97120. Index *pIndex;
  97121. Hash *pHash;
  97122. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  97123. pHash = &db->aDb[iDb].pSchema->idxHash;
  97124. pIndex = sqlite3HashInsert(pHash, zIdxName, 0);
  97125. if( ALWAYS(pIndex) ){
  97126. if( pIndex->pTable->pIndex==pIndex ){
  97127. pIndex->pTable->pIndex = pIndex->pNext;
  97128. }else{
  97129. Index *p;
  97130. /* Justification of ALWAYS(); The index must be on the list of
  97131. ** indices. */
  97132. p = pIndex->pTable->pIndex;
  97133. while( ALWAYS(p) && p->pNext!=pIndex ){ p = p->pNext; }
  97134. if( ALWAYS(p && p->pNext==pIndex) ){
  97135. p->pNext = pIndex->pNext;
  97136. }
  97137. }
  97138. freeIndex(db, pIndex);
  97139. }
  97140. db->mDbFlags |= DBFLAG_SchemaChange;
  97141. }
  97142. /*
  97143. ** Look through the list of open database files in db->aDb[] and if
  97144. ** any have been closed, remove them from the list. Reallocate the
  97145. ** db->aDb[] structure to a smaller size, if possible.
  97146. **
  97147. ** Entry 0 (the "main" database) and entry 1 (the "temp" database)
  97148. ** are never candidates for being collapsed.
  97149. */
  97150. SQLITE_PRIVATE void sqlite3CollapseDatabaseArray(sqlite3 *db){
  97151. int i, j;
  97152. for(i=j=2; i<db->nDb; i++){
  97153. struct Db *pDb = &db->aDb[i];
  97154. if( pDb->pBt==0 ){
  97155. sqlite3DbFree(db, pDb->zDbSName);
  97156. pDb->zDbSName = 0;
  97157. continue;
  97158. }
  97159. if( j<i ){
  97160. db->aDb[j] = db->aDb[i];
  97161. }
  97162. j++;
  97163. }
  97164. db->nDb = j;
  97165. if( db->nDb<=2 && db->aDb!=db->aDbStatic ){
  97166. memcpy(db->aDbStatic, db->aDb, 2*sizeof(db->aDb[0]));
  97167. sqlite3DbFree(db, db->aDb);
  97168. db->aDb = db->aDbStatic;
  97169. }
  97170. }
  97171. /*
  97172. ** Reset the schema for the database at index iDb. Also reset the
  97173. ** TEMP schema. The reset is deferred if db->nSchemaLock is not zero.
  97174. ** Deferred resets may be run by calling with iDb<0.
  97175. */
  97176. SQLITE_PRIVATE void sqlite3ResetOneSchema(sqlite3 *db, int iDb){
  97177. int i;
  97178. assert( iDb<db->nDb );
  97179. if( iDb>=0 ){
  97180. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  97181. DbSetProperty(db, iDb, DB_ResetWanted);
  97182. DbSetProperty(db, 1, DB_ResetWanted);
  97183. }
  97184. if( db->nSchemaLock==0 ){
  97185. for(i=0; i<db->nDb; i++){
  97186. if( DbHasProperty(db, i, DB_ResetWanted) ){
  97187. sqlite3SchemaClear(db->aDb[i].pSchema);
  97188. }
  97189. }
  97190. }
  97191. }
  97192. /*
  97193. ** Erase all schema information from all attached databases (including
  97194. ** "main" and "temp") for a single database connection.
  97195. */
  97196. SQLITE_PRIVATE void sqlite3ResetAllSchemasOfConnection(sqlite3 *db){
  97197. int i;
  97198. sqlite3BtreeEnterAll(db);
  97199. assert( db->nSchemaLock==0 );
  97200. for(i=0; i<db->nDb; i++){
  97201. Db *pDb = &db->aDb[i];
  97202. if( pDb->pSchema ){
  97203. sqlite3SchemaClear(pDb->pSchema);
  97204. }
  97205. }
  97206. db->mDbFlags &= ~DBFLAG_SchemaChange;
  97207. sqlite3VtabUnlockList(db);
  97208. sqlite3BtreeLeaveAll(db);
  97209. sqlite3CollapseDatabaseArray(db);
  97210. }
  97211. /*
  97212. ** This routine is called when a commit occurs.
  97213. */
  97214. SQLITE_PRIVATE void sqlite3CommitInternalChanges(sqlite3 *db){
  97215. db->mDbFlags &= ~DBFLAG_SchemaChange;
  97216. }
  97217. /*
  97218. ** Delete memory allocated for the column names of a table or view (the
  97219. ** Table.aCol[] array).
  97220. */
  97221. SQLITE_PRIVATE void sqlite3DeleteColumnNames(sqlite3 *db, Table *pTable){
  97222. int i;
  97223. Column *pCol;
  97224. assert( pTable!=0 );
  97225. if( (pCol = pTable->aCol)!=0 ){
  97226. for(i=0; i<pTable->nCol; i++, pCol++){
  97227. sqlite3DbFree(db, pCol->zName);
  97228. sqlite3ExprDelete(db, pCol->pDflt);
  97229. sqlite3DbFree(db, pCol->zColl);
  97230. }
  97231. sqlite3DbFree(db, pTable->aCol);
  97232. }
  97233. }
  97234. /*
  97235. ** Remove the memory data structures associated with the given
  97236. ** Table. No changes are made to disk by this routine.
  97237. **
  97238. ** This routine just deletes the data structure. It does not unlink
  97239. ** the table data structure from the hash table. But it does destroy
  97240. ** memory structures of the indices and foreign keys associated with
  97241. ** the table.
  97242. **
  97243. ** The db parameter is optional. It is needed if the Table object
  97244. ** contains lookaside memory. (Table objects in the schema do not use
  97245. ** lookaside memory, but some ephemeral Table objects do.) Or the
  97246. ** db parameter can be used with db->pnBytesFreed to measure the memory
  97247. ** used by the Table object.
  97248. */
  97249. static void SQLITE_NOINLINE deleteTable(sqlite3 *db, Table *pTable){
  97250. Index *pIndex, *pNext;
  97251. #ifdef SQLITE_DEBUG
  97252. /* Record the number of outstanding lookaside allocations in schema Tables
  97253. ** prior to doing any free() operations. Since schema Tables do not use
  97254. ** lookaside, this number should not change. */
  97255. int nLookaside = 0;
  97256. if( db && (pTable->tabFlags & TF_Ephemeral)==0 ){
  97257. nLookaside = sqlite3LookasideUsed(db, 0);
  97258. }
  97259. #endif
  97260. /* Delete all indices associated with this table. */
  97261. for(pIndex = pTable->pIndex; pIndex; pIndex=pNext){
  97262. pNext = pIndex->pNext;
  97263. assert( pIndex->pSchema==pTable->pSchema
  97264. || (IsVirtual(pTable) && pIndex->idxType!=SQLITE_IDXTYPE_APPDEF) );
  97265. if( (db==0 || db->pnBytesFreed==0) && !IsVirtual(pTable) ){
  97266. char *zName = pIndex->zName;
  97267. TESTONLY ( Index *pOld = ) sqlite3HashInsert(
  97268. &pIndex->pSchema->idxHash, zName, 0
  97269. );
  97270. assert( db==0 || sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
  97271. assert( pOld==pIndex || pOld==0 );
  97272. }
  97273. freeIndex(db, pIndex);
  97274. }
  97275. /* Delete any foreign keys attached to this table. */
  97276. sqlite3FkDelete(db, pTable);
  97277. /* Delete the Table structure itself.
  97278. */
  97279. sqlite3DeleteColumnNames(db, pTable);
  97280. sqlite3DbFree(db, pTable->zName);
  97281. sqlite3DbFree(db, pTable->zColAff);
  97282. sqlite3SelectDelete(db, pTable->pSelect);
  97283. sqlite3ExprListDelete(db, pTable->pCheck);
  97284. #ifndef SQLITE_OMIT_VIRTUALTABLE
  97285. sqlite3VtabClear(db, pTable);
  97286. #endif
  97287. sqlite3DbFree(db, pTable);
  97288. /* Verify that no lookaside memory was used by schema tables */
  97289. assert( nLookaside==0 || nLookaside==sqlite3LookasideUsed(db,0) );
  97290. }
  97291. SQLITE_PRIVATE void sqlite3DeleteTable(sqlite3 *db, Table *pTable){
  97292. /* Do not delete the table until the reference count reaches zero. */
  97293. if( !pTable ) return;
  97294. if( ((!db || db->pnBytesFreed==0) && (--pTable->nTabRef)>0) ) return;
  97295. deleteTable(db, pTable);
  97296. }
  97297. /*
  97298. ** Unlink the given table from the hash tables and the delete the
  97299. ** table structure with all its indices and foreign keys.
  97300. */
  97301. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTable(sqlite3 *db, int iDb, const char *zTabName){
  97302. Table *p;
  97303. Db *pDb;
  97304. assert( db!=0 );
  97305. assert( iDb>=0 && iDb<db->nDb );
  97306. assert( zTabName );
  97307. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  97308. testcase( zTabName[0]==0 ); /* Zero-length table names are allowed */
  97309. pDb = &db->aDb[iDb];
  97310. p = sqlite3HashInsert(&pDb->pSchema->tblHash, zTabName, 0);
  97311. sqlite3DeleteTable(db, p);
  97312. db->mDbFlags |= DBFLAG_SchemaChange;
  97313. }
  97314. /*
  97315. ** Given a token, return a string that consists of the text of that
  97316. ** token. Space to hold the returned string
  97317. ** is obtained from sqliteMalloc() and must be freed by the calling
  97318. ** function.
  97319. **
  97320. ** Any quotation marks (ex: "name", 'name', [name], or `name`) that
  97321. ** surround the body of the token are removed.
  97322. **
  97323. ** Tokens are often just pointers into the original SQL text and so
  97324. ** are not \000 terminated and are not persistent. The returned string
  97325. ** is \000 terminated and is persistent.
  97326. */
  97327. SQLITE_PRIVATE char *sqlite3NameFromToken(sqlite3 *db, Token *pName){
  97328. char *zName;
  97329. if( pName ){
  97330. zName = sqlite3DbStrNDup(db, (char*)pName->z, pName->n);
  97331. sqlite3Dequote(zName);
  97332. }else{
  97333. zName = 0;
  97334. }
  97335. return zName;
  97336. }
  97337. /*
  97338. ** Open the sqlite_master table stored in database number iDb for
  97339. ** writing. The table is opened using cursor 0.
  97340. */
  97341. SQLITE_PRIVATE void sqlite3OpenMasterTable(Parse *p, int iDb){
  97342. Vdbe *v = sqlite3GetVdbe(p);
  97343. sqlite3TableLock(p, iDb, MASTER_ROOT, 1, MASTER_NAME);
  97344. sqlite3VdbeAddOp4Int(v, OP_OpenWrite, 0, MASTER_ROOT, iDb, 5);
  97345. if( p->nTab==0 ){
  97346. p->nTab = 1;
  97347. }
  97348. }
  97349. /*
  97350. ** Parameter zName points to a nul-terminated buffer containing the name
  97351. ** of a database ("main", "temp" or the name of an attached db). This
  97352. ** function returns the index of the named database in db->aDb[], or
  97353. ** -1 if the named db cannot be found.
  97354. */
  97355. SQLITE_PRIVATE int sqlite3FindDbName(sqlite3 *db, const char *zName){
  97356. int i = -1; /* Database number */
  97357. if( zName ){
  97358. Db *pDb;
  97359. for(i=(db->nDb-1), pDb=&db->aDb[i]; i>=0; i--, pDb--){
  97360. if( 0==sqlite3_stricmp(pDb->zDbSName, zName) ) break;
  97361. /* "main" is always an acceptable alias for the primary database
  97362. ** even if it has been renamed using SQLITE_DBCONFIG_MAINDBNAME. */
  97363. if( i==0 && 0==sqlite3_stricmp("main", zName) ) break;
  97364. }
  97365. }
  97366. return i;
  97367. }
  97368. /*
  97369. ** The token *pName contains the name of a database (either "main" or
  97370. ** "temp" or the name of an attached db). This routine returns the
  97371. ** index of the named database in db->aDb[], or -1 if the named db
  97372. ** does not exist.
  97373. */
  97374. SQLITE_PRIVATE int sqlite3FindDb(sqlite3 *db, Token *pName){
  97375. int i; /* Database number */
  97376. char *zName; /* Name we are searching for */
  97377. zName = sqlite3NameFromToken(db, pName);
  97378. i = sqlite3FindDbName(db, zName);
  97379. sqlite3DbFree(db, zName);
  97380. return i;
  97381. }
  97382. /* The table or view or trigger name is passed to this routine via tokens
  97383. ** pName1 and pName2. If the table name was fully qualified, for example:
  97384. **
  97385. ** CREATE TABLE xxx.yyy (...);
  97386. **
  97387. ** Then pName1 is set to "xxx" and pName2 "yyy". On the other hand if
  97388. ** the table name is not fully qualified, i.e.:
  97389. **
  97390. ** CREATE TABLE yyy(...);
  97391. **
  97392. ** Then pName1 is set to "yyy" and pName2 is "".
  97393. **
  97394. ** This routine sets the *ppUnqual pointer to point at the token (pName1 or
  97395. ** pName2) that stores the unqualified table name. The index of the
  97396. ** database "xxx" is returned.
  97397. */
  97398. SQLITE_PRIVATE int sqlite3TwoPartName(
  97399. Parse *pParse, /* Parsing and code generating context */
  97400. Token *pName1, /* The "xxx" in the name "xxx.yyy" or "xxx" */
  97401. Token *pName2, /* The "yyy" in the name "xxx.yyy" */
  97402. Token **pUnqual /* Write the unqualified object name here */
  97403. ){
  97404. int iDb; /* Database holding the object */
  97405. sqlite3 *db = pParse->db;
  97406. assert( pName2!=0 );
  97407. if( pName2->n>0 ){
  97408. if( db->init.busy ) {
  97409. sqlite3ErrorMsg(pParse, "corrupt database");
  97410. return -1;
  97411. }
  97412. *pUnqual = pName2;
  97413. iDb = sqlite3FindDb(db, pName1);
  97414. if( iDb<0 ){
  97415. sqlite3ErrorMsg(pParse, "unknown database %T", pName1);
  97416. return -1;
  97417. }
  97418. }else{
  97419. assert( db->init.iDb==0 || db->init.busy
  97420. || (db->mDbFlags & DBFLAG_Vacuum)!=0);
  97421. iDb = db->init.iDb;
  97422. *pUnqual = pName1;
  97423. }
  97424. return iDb;
  97425. }
  97426. /*
  97427. ** This routine is used to check if the UTF-8 string zName is a legal
  97428. ** unqualified name for a new schema object (table, index, view or
  97429. ** trigger). All names are legal except those that begin with the string
  97430. ** "sqlite_" (in upper, lower or mixed case). This portion of the namespace
  97431. ** is reserved for internal use.
  97432. */
  97433. SQLITE_PRIVATE int sqlite3CheckObjectName(Parse *pParse, const char *zName){
  97434. if( !pParse->db->init.busy && pParse->nested==0
  97435. && (pParse->db->flags & SQLITE_WriteSchema)==0
  97436. && 0==sqlite3StrNICmp(zName, "sqlite_", 7) ){
  97437. sqlite3ErrorMsg(pParse, "object name reserved for internal use: %s", zName);
  97438. return SQLITE_ERROR;
  97439. }
  97440. return SQLITE_OK;
  97441. }
  97442. /*
  97443. ** Return the PRIMARY KEY index of a table
  97444. */
  97445. SQLITE_PRIVATE Index *sqlite3PrimaryKeyIndex(Table *pTab){
  97446. Index *p;
  97447. for(p=pTab->pIndex; p && !IsPrimaryKeyIndex(p); p=p->pNext){}
  97448. return p;
  97449. }
  97450. /*
  97451. ** Return the column of index pIdx that corresponds to table
  97452. ** column iCol. Return -1 if not found.
  97453. */
  97454. SQLITE_PRIVATE i16 sqlite3ColumnOfIndex(Index *pIdx, i16 iCol){
  97455. int i;
  97456. for(i=0; i<pIdx->nColumn; i++){
  97457. if( iCol==pIdx->aiColumn[i] ) return i;
  97458. }
  97459. return -1;
  97460. }
  97461. /*
  97462. ** Begin constructing a new table representation in memory. This is
  97463. ** the first of several action routines that get called in response
  97464. ** to a CREATE TABLE statement. In particular, this routine is called
  97465. ** after seeing tokens "CREATE" and "TABLE" and the table name. The isTemp
  97466. ** flag is true if the table should be stored in the auxiliary database
  97467. ** file instead of in the main database file. This is normally the case
  97468. ** when the "TEMP" or "TEMPORARY" keyword occurs in between
  97469. ** CREATE and TABLE.
  97470. **
  97471. ** The new table record is initialized and put in pParse->pNewTable.
  97472. ** As more of the CREATE TABLE statement is parsed, additional action
  97473. ** routines will be called to add more information to this record.
  97474. ** At the end of the CREATE TABLE statement, the sqlite3EndTable() routine
  97475. ** is called to complete the construction of the new table record.
  97476. */
  97477. SQLITE_PRIVATE void sqlite3StartTable(
  97478. Parse *pParse, /* Parser context */
  97479. Token *pName1, /* First part of the name of the table or view */
  97480. Token *pName2, /* Second part of the name of the table or view */
  97481. int isTemp, /* True if this is a TEMP table */
  97482. int isView, /* True if this is a VIEW */
  97483. int isVirtual, /* True if this is a VIRTUAL table */
  97484. int noErr /* Do nothing if table already exists */
  97485. ){
  97486. Table *pTable;
  97487. char *zName = 0; /* The name of the new table */
  97488. sqlite3 *db = pParse->db;
  97489. Vdbe *v;
  97490. int iDb; /* Database number to create the table in */
  97491. Token *pName; /* Unqualified name of the table to create */
  97492. if( db->init.busy && db->init.newTnum==1 ){
  97493. /* Special case: Parsing the sqlite_master or sqlite_temp_master schema */
  97494. iDb = db->init.iDb;
  97495. zName = sqlite3DbStrDup(db, SCHEMA_TABLE(iDb));
  97496. pName = pName1;
  97497. }else{
  97498. /* The common case */
  97499. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  97500. if( iDb<0 ) return;
  97501. if( !OMIT_TEMPDB && isTemp && pName2->n>0 && iDb!=1 ){
  97502. /* If creating a temp table, the name may not be qualified. Unless
  97503. ** the database name is "temp" anyway. */
  97504. sqlite3ErrorMsg(pParse, "temporary table name must be unqualified");
  97505. return;
  97506. }
  97507. if( !OMIT_TEMPDB && isTemp ) iDb = 1;
  97508. zName = sqlite3NameFromToken(db, pName);
  97509. }
  97510. pParse->sNameToken = *pName;
  97511. if( zName==0 ) return;
  97512. if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
  97513. goto begin_table_error;
  97514. }
  97515. if( db->init.iDb==1 ) isTemp = 1;
  97516. #ifndef SQLITE_OMIT_AUTHORIZATION
  97517. assert( isTemp==0 || isTemp==1 );
  97518. assert( isView==0 || isView==1 );
  97519. {
  97520. static const u8 aCode[] = {
  97521. SQLITE_CREATE_TABLE,
  97522. SQLITE_CREATE_TEMP_TABLE,
  97523. SQLITE_CREATE_VIEW,
  97524. SQLITE_CREATE_TEMP_VIEW
  97525. };
  97526. char *zDb = db->aDb[iDb].zDbSName;
  97527. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(isTemp), 0, zDb) ){
  97528. goto begin_table_error;
  97529. }
  97530. if( !isVirtual && sqlite3AuthCheck(pParse, (int)aCode[isTemp+2*isView],
  97531. zName, 0, zDb) ){
  97532. goto begin_table_error;
  97533. }
  97534. }
  97535. #endif
  97536. /* Make sure the new table name does not collide with an existing
  97537. ** index or table name in the same database. Issue an error message if
  97538. ** it does. The exception is if the statement being parsed was passed
  97539. ** to an sqlite3_declare_vtab() call. In that case only the column names
  97540. ** and types will be used, so there is no need to test for namespace
  97541. ** collisions.
  97542. */
  97543. if( !IN_DECLARE_VTAB ){
  97544. char *zDb = db->aDb[iDb].zDbSName;
  97545. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  97546. goto begin_table_error;
  97547. }
  97548. pTable = sqlite3FindTable(db, zName, zDb);
  97549. if( pTable ){
  97550. if( !noErr ){
  97551. sqlite3ErrorMsg(pParse, "table %T already exists", pName);
  97552. }else{
  97553. assert( !db->init.busy || CORRUPT_DB );
  97554. sqlite3CodeVerifySchema(pParse, iDb);
  97555. }
  97556. goto begin_table_error;
  97557. }
  97558. if( sqlite3FindIndex(db, zName, zDb)!=0 ){
  97559. sqlite3ErrorMsg(pParse, "there is already an index named %s", zName);
  97560. goto begin_table_error;
  97561. }
  97562. }
  97563. pTable = sqlite3DbMallocZero(db, sizeof(Table));
  97564. if( pTable==0 ){
  97565. assert( db->mallocFailed );
  97566. pParse->rc = SQLITE_NOMEM_BKPT;
  97567. pParse->nErr++;
  97568. goto begin_table_error;
  97569. }
  97570. pTable->zName = zName;
  97571. pTable->iPKey = -1;
  97572. pTable->pSchema = db->aDb[iDb].pSchema;
  97573. pTable->nTabRef = 1;
  97574. #ifdef SQLITE_DEFAULT_ROWEST
  97575. pTable->nRowLogEst = sqlite3LogEst(SQLITE_DEFAULT_ROWEST);
  97576. #else
  97577. pTable->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  97578. #endif
  97579. assert( pParse->pNewTable==0 );
  97580. pParse->pNewTable = pTable;
  97581. /* If this is the magic sqlite_sequence table used by autoincrement,
  97582. ** then record a pointer to this table in the main database structure
  97583. ** so that INSERT can find the table easily.
  97584. */
  97585. #ifndef SQLITE_OMIT_AUTOINCREMENT
  97586. if( !pParse->nested && strcmp(zName, "sqlite_sequence")==0 ){
  97587. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  97588. pTable->pSchema->pSeqTab = pTable;
  97589. }
  97590. #endif
  97591. /* Begin generating the code that will insert the table record into
  97592. ** the SQLITE_MASTER table. Note in particular that we must go ahead
  97593. ** and allocate the record number for the table entry now. Before any
  97594. ** PRIMARY KEY or UNIQUE keywords are parsed. Those keywords will cause
  97595. ** indices to be created and the table record must come before the
  97596. ** indices. Hence, the record number for the table must be allocated
  97597. ** now.
  97598. */
  97599. if( !db->init.busy && (v = sqlite3GetVdbe(pParse))!=0 ){
  97600. int addr1;
  97601. int fileFormat;
  97602. int reg1, reg2, reg3;
  97603. /* nullRow[] is an OP_Record encoding of a row containing 5 NULLs */
  97604. static const char nullRow[] = { 6, 0, 0, 0, 0, 0 };
  97605. sqlite3BeginWriteOperation(pParse, 1, iDb);
  97606. #ifndef SQLITE_OMIT_VIRTUALTABLE
  97607. if( isVirtual ){
  97608. sqlite3VdbeAddOp0(v, OP_VBegin);
  97609. }
  97610. #endif
  97611. /* If the file format and encoding in the database have not been set,
  97612. ** set them now.
  97613. */
  97614. reg1 = pParse->regRowid = ++pParse->nMem;
  97615. reg2 = pParse->regRoot = ++pParse->nMem;
  97616. reg3 = ++pParse->nMem;
  97617. sqlite3VdbeAddOp3(v, OP_ReadCookie, iDb, reg3, BTREE_FILE_FORMAT);
  97618. sqlite3VdbeUsesBtree(v, iDb);
  97619. addr1 = sqlite3VdbeAddOp1(v, OP_If, reg3); VdbeCoverage(v);
  97620. fileFormat = (db->flags & SQLITE_LegacyFileFmt)!=0 ?
  97621. 1 : SQLITE_MAX_FILE_FORMAT;
  97622. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_FILE_FORMAT, fileFormat);
  97623. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_TEXT_ENCODING, ENC(db));
  97624. sqlite3VdbeJumpHere(v, addr1);
  97625. /* This just creates a place-holder record in the sqlite_master table.
  97626. ** The record created does not contain anything yet. It will be replaced
  97627. ** by the real entry in code generated at sqlite3EndTable().
  97628. **
  97629. ** The rowid for the new entry is left in register pParse->regRowid.
  97630. ** The root page number of the new table is left in reg pParse->regRoot.
  97631. ** The rowid and root page number values are needed by the code that
  97632. ** sqlite3EndTable will generate.
  97633. */
  97634. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
  97635. if( isView || isVirtual ){
  97636. sqlite3VdbeAddOp2(v, OP_Integer, 0, reg2);
  97637. }else
  97638. #endif
  97639. {
  97640. pParse->addrCrTab =
  97641. sqlite3VdbeAddOp3(v, OP_CreateBtree, iDb, reg2, BTREE_INTKEY);
  97642. }
  97643. sqlite3OpenMasterTable(pParse, iDb);
  97644. sqlite3VdbeAddOp2(v, OP_NewRowid, 0, reg1);
  97645. sqlite3VdbeAddOp4(v, OP_Blob, 6, reg3, 0, nullRow, P4_STATIC);
  97646. sqlite3VdbeAddOp3(v, OP_Insert, 0, reg3, reg1);
  97647. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  97648. sqlite3VdbeAddOp0(v, OP_Close);
  97649. }
  97650. /* Normal (non-error) return. */
  97651. return;
  97652. /* If an error occurs, we jump here */
  97653. begin_table_error:
  97654. sqlite3DbFree(db, zName);
  97655. return;
  97656. }
  97657. /* Set properties of a table column based on the (magical)
  97658. ** name of the column.
  97659. */
  97660. #if SQLITE_ENABLE_HIDDEN_COLUMNS
  97661. SQLITE_PRIVATE void sqlite3ColumnPropertiesFromName(Table *pTab, Column *pCol){
  97662. if( sqlite3_strnicmp(pCol->zName, "__hidden__", 10)==0 ){
  97663. pCol->colFlags |= COLFLAG_HIDDEN;
  97664. }else if( pTab && pCol!=pTab->aCol && (pCol[-1].colFlags & COLFLAG_HIDDEN) ){
  97665. pTab->tabFlags |= TF_OOOHidden;
  97666. }
  97667. }
  97668. #endif
  97669. /*
  97670. ** Add a new column to the table currently being constructed.
  97671. **
  97672. ** The parser calls this routine once for each column declaration
  97673. ** in a CREATE TABLE statement. sqlite3StartTable() gets called
  97674. ** first to get things going. Then this routine is called for each
  97675. ** column.
  97676. */
  97677. SQLITE_PRIVATE void sqlite3AddColumn(Parse *pParse, Token *pName, Token *pType){
  97678. Table *p;
  97679. int i;
  97680. char *z;
  97681. char *zType;
  97682. Column *pCol;
  97683. sqlite3 *db = pParse->db;
  97684. if( (p = pParse->pNewTable)==0 ) return;
  97685. if( p->nCol+1>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  97686. sqlite3ErrorMsg(pParse, "too many columns on %s", p->zName);
  97687. return;
  97688. }
  97689. z = sqlite3DbMallocRaw(db, pName->n + pType->n + 2);
  97690. if( z==0 ) return;
  97691. memcpy(z, pName->z, pName->n);
  97692. z[pName->n] = 0;
  97693. sqlite3Dequote(z);
  97694. for(i=0; i<p->nCol; i++){
  97695. if( sqlite3_stricmp(z, p->aCol[i].zName)==0 ){
  97696. sqlite3ErrorMsg(pParse, "duplicate column name: %s", z);
  97697. sqlite3DbFree(db, z);
  97698. return;
  97699. }
  97700. }
  97701. if( (p->nCol & 0x7)==0 ){
  97702. Column *aNew;
  97703. aNew = sqlite3DbRealloc(db,p->aCol,(p->nCol+8)*sizeof(p->aCol[0]));
  97704. if( aNew==0 ){
  97705. sqlite3DbFree(db, z);
  97706. return;
  97707. }
  97708. p->aCol = aNew;
  97709. }
  97710. pCol = &p->aCol[p->nCol];
  97711. memset(pCol, 0, sizeof(p->aCol[0]));
  97712. pCol->zName = z;
  97713. sqlite3ColumnPropertiesFromName(p, pCol);
  97714. if( pType->n==0 ){
  97715. /* If there is no type specified, columns have the default affinity
  97716. ** 'BLOB'. */
  97717. pCol->affinity = SQLITE_AFF_BLOB;
  97718. pCol->szEst = 1;
  97719. }else{
  97720. zType = z + sqlite3Strlen30(z) + 1;
  97721. memcpy(zType, pType->z, pType->n);
  97722. zType[pType->n] = 0;
  97723. sqlite3Dequote(zType);
  97724. pCol->affinity = sqlite3AffinityType(zType, &pCol->szEst);
  97725. pCol->colFlags |= COLFLAG_HASTYPE;
  97726. }
  97727. p->nCol++;
  97728. pParse->constraintName.n = 0;
  97729. }
  97730. /*
  97731. ** This routine is called by the parser while in the middle of
  97732. ** parsing a CREATE TABLE statement. A "NOT NULL" constraint has
  97733. ** been seen on a column. This routine sets the notNull flag on
  97734. ** the column currently under construction.
  97735. */
  97736. SQLITE_PRIVATE void sqlite3AddNotNull(Parse *pParse, int onError){
  97737. Table *p;
  97738. Column *pCol;
  97739. p = pParse->pNewTable;
  97740. if( p==0 || NEVER(p->nCol<1) ) return;
  97741. pCol = &p->aCol[p->nCol-1];
  97742. pCol->notNull = (u8)onError;
  97743. p->tabFlags |= TF_HasNotNull;
  97744. /* Set the uniqNotNull flag on any UNIQUE or PK indexes already created
  97745. ** on this column. */
  97746. if( pCol->colFlags & COLFLAG_UNIQUE ){
  97747. Index *pIdx;
  97748. for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
  97749. assert( pIdx->nKeyCol==1 && pIdx->onError!=OE_None );
  97750. if( pIdx->aiColumn[0]==p->nCol-1 ){
  97751. pIdx->uniqNotNull = 1;
  97752. }
  97753. }
  97754. }
  97755. }
  97756. /*
  97757. ** Scan the column type name zType (length nType) and return the
  97758. ** associated affinity type.
  97759. **
  97760. ** This routine does a case-independent search of zType for the
  97761. ** substrings in the following table. If one of the substrings is
  97762. ** found, the corresponding affinity is returned. If zType contains
  97763. ** more than one of the substrings, entries toward the top of
  97764. ** the table take priority. For example, if zType is 'BLOBINT',
  97765. ** SQLITE_AFF_INTEGER is returned.
  97766. **
  97767. ** Substring | Affinity
  97768. ** --------------------------------
  97769. ** 'INT' | SQLITE_AFF_INTEGER
  97770. ** 'CHAR' | SQLITE_AFF_TEXT
  97771. ** 'CLOB' | SQLITE_AFF_TEXT
  97772. ** 'TEXT' | SQLITE_AFF_TEXT
  97773. ** 'BLOB' | SQLITE_AFF_BLOB
  97774. ** 'REAL' | SQLITE_AFF_REAL
  97775. ** 'FLOA' | SQLITE_AFF_REAL
  97776. ** 'DOUB' | SQLITE_AFF_REAL
  97777. **
  97778. ** If none of the substrings in the above table are found,
  97779. ** SQLITE_AFF_NUMERIC is returned.
  97780. */
  97781. SQLITE_PRIVATE char sqlite3AffinityType(const char *zIn, u8 *pszEst){
  97782. u32 h = 0;
  97783. char aff = SQLITE_AFF_NUMERIC;
  97784. const char *zChar = 0;
  97785. assert( zIn!=0 );
  97786. while( zIn[0] ){
  97787. h = (h<<8) + sqlite3UpperToLower[(*zIn)&0xff];
  97788. zIn++;
  97789. if( h==(('c'<<24)+('h'<<16)+('a'<<8)+'r') ){ /* CHAR */
  97790. aff = SQLITE_AFF_TEXT;
  97791. zChar = zIn;
  97792. }else if( h==(('c'<<24)+('l'<<16)+('o'<<8)+'b') ){ /* CLOB */
  97793. aff = SQLITE_AFF_TEXT;
  97794. }else if( h==(('t'<<24)+('e'<<16)+('x'<<8)+'t') ){ /* TEXT */
  97795. aff = SQLITE_AFF_TEXT;
  97796. }else if( h==(('b'<<24)+('l'<<16)+('o'<<8)+'b') /* BLOB */
  97797. && (aff==SQLITE_AFF_NUMERIC || aff==SQLITE_AFF_REAL) ){
  97798. aff = SQLITE_AFF_BLOB;
  97799. if( zIn[0]=='(' ) zChar = zIn;
  97800. #ifndef SQLITE_OMIT_FLOATING_POINT
  97801. }else if( h==(('r'<<24)+('e'<<16)+('a'<<8)+'l') /* REAL */
  97802. && aff==SQLITE_AFF_NUMERIC ){
  97803. aff = SQLITE_AFF_REAL;
  97804. }else if( h==(('f'<<24)+('l'<<16)+('o'<<8)+'a') /* FLOA */
  97805. && aff==SQLITE_AFF_NUMERIC ){
  97806. aff = SQLITE_AFF_REAL;
  97807. }else if( h==(('d'<<24)+('o'<<16)+('u'<<8)+'b') /* DOUB */
  97808. && aff==SQLITE_AFF_NUMERIC ){
  97809. aff = SQLITE_AFF_REAL;
  97810. #endif
  97811. }else if( (h&0x00FFFFFF)==(('i'<<16)+('n'<<8)+'t') ){ /* INT */
  97812. aff = SQLITE_AFF_INTEGER;
  97813. break;
  97814. }
  97815. }
  97816. /* If pszEst is not NULL, store an estimate of the field size. The
  97817. ** estimate is scaled so that the size of an integer is 1. */
  97818. if( pszEst ){
  97819. *pszEst = 1; /* default size is approx 4 bytes */
  97820. if( aff<SQLITE_AFF_NUMERIC ){
  97821. if( zChar ){
  97822. while( zChar[0] ){
  97823. if( sqlite3Isdigit(zChar[0]) ){
  97824. int v = 0;
  97825. sqlite3GetInt32(zChar, &v);
  97826. v = v/4 + 1;
  97827. if( v>255 ) v = 255;
  97828. *pszEst = v; /* BLOB(k), VARCHAR(k), CHAR(k) -> r=(k/4+1) */
  97829. break;
  97830. }
  97831. zChar++;
  97832. }
  97833. }else{
  97834. *pszEst = 5; /* BLOB, TEXT, CLOB -> r=5 (approx 20 bytes)*/
  97835. }
  97836. }
  97837. }
  97838. return aff;
  97839. }
  97840. /*
  97841. ** The expression is the default value for the most recently added column
  97842. ** of the table currently under construction.
  97843. **
  97844. ** Default value expressions must be constant. Raise an exception if this
  97845. ** is not the case.
  97846. **
  97847. ** This routine is called by the parser while in the middle of
  97848. ** parsing a CREATE TABLE statement.
  97849. */
  97850. SQLITE_PRIVATE void sqlite3AddDefaultValue(
  97851. Parse *pParse, /* Parsing context */
  97852. Expr *pExpr, /* The parsed expression of the default value */
  97853. const char *zStart, /* Start of the default value text */
  97854. const char *zEnd /* First character past end of defaut value text */
  97855. ){
  97856. Table *p;
  97857. Column *pCol;
  97858. sqlite3 *db = pParse->db;
  97859. p = pParse->pNewTable;
  97860. if( p!=0 ){
  97861. pCol = &(p->aCol[p->nCol-1]);
  97862. if( !sqlite3ExprIsConstantOrFunction(pExpr, db->init.busy) ){
  97863. sqlite3ErrorMsg(pParse, "default value of column [%s] is not constant",
  97864. pCol->zName);
  97865. }else{
  97866. /* A copy of pExpr is used instead of the original, as pExpr contains
  97867. ** tokens that point to volatile memory.
  97868. */
  97869. Expr x;
  97870. sqlite3ExprDelete(db, pCol->pDflt);
  97871. memset(&x, 0, sizeof(x));
  97872. x.op = TK_SPAN;
  97873. x.u.zToken = sqlite3DbSpanDup(db, zStart, zEnd);
  97874. x.pLeft = pExpr;
  97875. x.flags = EP_Skip;
  97876. pCol->pDflt = sqlite3ExprDup(db, &x, EXPRDUP_REDUCE);
  97877. sqlite3DbFree(db, x.u.zToken);
  97878. }
  97879. }
  97880. sqlite3ExprDelete(db, pExpr);
  97881. }
  97882. /*
  97883. ** Backwards Compatibility Hack:
  97884. **
  97885. ** Historical versions of SQLite accepted strings as column names in
  97886. ** indexes and PRIMARY KEY constraints and in UNIQUE constraints. Example:
  97887. **
  97888. ** CREATE TABLE xyz(a,b,c,d,e,PRIMARY KEY('a'),UNIQUE('b','c' COLLATE trim)
  97889. ** CREATE INDEX abc ON xyz('c','d' DESC,'e' COLLATE nocase DESC);
  97890. **
  97891. ** This is goofy. But to preserve backwards compatibility we continue to
  97892. ** accept it. This routine does the necessary conversion. It converts
  97893. ** the expression given in its argument from a TK_STRING into a TK_ID
  97894. ** if the expression is just a TK_STRING with an optional COLLATE clause.
  97895. ** If the epxression is anything other than TK_STRING, the expression is
  97896. ** unchanged.
  97897. */
  97898. static void sqlite3StringToId(Expr *p){
  97899. if( p->op==TK_STRING ){
  97900. p->op = TK_ID;
  97901. }else if( p->op==TK_COLLATE && p->pLeft->op==TK_STRING ){
  97902. p->pLeft->op = TK_ID;
  97903. }
  97904. }
  97905. /*
  97906. ** Designate the PRIMARY KEY for the table. pList is a list of names
  97907. ** of columns that form the primary key. If pList is NULL, then the
  97908. ** most recently added column of the table is the primary key.
  97909. **
  97910. ** A table can have at most one primary key. If the table already has
  97911. ** a primary key (and this is the second primary key) then create an
  97912. ** error.
  97913. **
  97914. ** If the PRIMARY KEY is on a single column whose datatype is INTEGER,
  97915. ** then we will try to use that column as the rowid. Set the Table.iPKey
  97916. ** field of the table under construction to be the index of the
  97917. ** INTEGER PRIMARY KEY column. Table.iPKey is set to -1 if there is
  97918. ** no INTEGER PRIMARY KEY.
  97919. **
  97920. ** If the key is not an INTEGER PRIMARY KEY, then create a unique
  97921. ** index for the key. No index is created for INTEGER PRIMARY KEYs.
  97922. */
  97923. SQLITE_PRIVATE void sqlite3AddPrimaryKey(
  97924. Parse *pParse, /* Parsing context */
  97925. ExprList *pList, /* List of field names to be indexed */
  97926. int onError, /* What to do with a uniqueness conflict */
  97927. int autoInc, /* True if the AUTOINCREMENT keyword is present */
  97928. int sortOrder /* SQLITE_SO_ASC or SQLITE_SO_DESC */
  97929. ){
  97930. Table *pTab = pParse->pNewTable;
  97931. Column *pCol = 0;
  97932. int iCol = -1, i;
  97933. int nTerm;
  97934. if( pTab==0 ) goto primary_key_exit;
  97935. if( pTab->tabFlags & TF_HasPrimaryKey ){
  97936. sqlite3ErrorMsg(pParse,
  97937. "table \"%s\" has more than one primary key", pTab->zName);
  97938. goto primary_key_exit;
  97939. }
  97940. pTab->tabFlags |= TF_HasPrimaryKey;
  97941. if( pList==0 ){
  97942. iCol = pTab->nCol - 1;
  97943. pCol = &pTab->aCol[iCol];
  97944. pCol->colFlags |= COLFLAG_PRIMKEY;
  97945. nTerm = 1;
  97946. }else{
  97947. nTerm = pList->nExpr;
  97948. for(i=0; i<nTerm; i++){
  97949. Expr *pCExpr = sqlite3ExprSkipCollate(pList->a[i].pExpr);
  97950. assert( pCExpr!=0 );
  97951. sqlite3StringToId(pCExpr);
  97952. if( pCExpr->op==TK_ID ){
  97953. const char *zCName = pCExpr->u.zToken;
  97954. for(iCol=0; iCol<pTab->nCol; iCol++){
  97955. if( sqlite3StrICmp(zCName, pTab->aCol[iCol].zName)==0 ){
  97956. pCol = &pTab->aCol[iCol];
  97957. pCol->colFlags |= COLFLAG_PRIMKEY;
  97958. break;
  97959. }
  97960. }
  97961. }
  97962. }
  97963. }
  97964. if( nTerm==1
  97965. && pCol
  97966. && sqlite3StrICmp(sqlite3ColumnType(pCol,""), "INTEGER")==0
  97967. && sortOrder!=SQLITE_SO_DESC
  97968. ){
  97969. pTab->iPKey = iCol;
  97970. pTab->keyConf = (u8)onError;
  97971. assert( autoInc==0 || autoInc==1 );
  97972. pTab->tabFlags |= autoInc*TF_Autoincrement;
  97973. if( pList ) pParse->iPkSortOrder = pList->a[0].sortOrder;
  97974. }else if( autoInc ){
  97975. #ifndef SQLITE_OMIT_AUTOINCREMENT
  97976. sqlite3ErrorMsg(pParse, "AUTOINCREMENT is only allowed on an "
  97977. "INTEGER PRIMARY KEY");
  97978. #endif
  97979. }else{
  97980. sqlite3CreateIndex(pParse, 0, 0, 0, pList, onError, 0,
  97981. 0, sortOrder, 0, SQLITE_IDXTYPE_PRIMARYKEY);
  97982. pList = 0;
  97983. }
  97984. primary_key_exit:
  97985. sqlite3ExprListDelete(pParse->db, pList);
  97986. return;
  97987. }
  97988. /*
  97989. ** Add a new CHECK constraint to the table currently under construction.
  97990. */
  97991. SQLITE_PRIVATE void sqlite3AddCheckConstraint(
  97992. Parse *pParse, /* Parsing context */
  97993. Expr *pCheckExpr /* The check expression */
  97994. ){
  97995. #ifndef SQLITE_OMIT_CHECK
  97996. Table *pTab = pParse->pNewTable;
  97997. sqlite3 *db = pParse->db;
  97998. if( pTab && !IN_DECLARE_VTAB
  97999. && !sqlite3BtreeIsReadonly(db->aDb[db->init.iDb].pBt)
  98000. ){
  98001. pTab->pCheck = sqlite3ExprListAppend(pParse, pTab->pCheck, pCheckExpr);
  98002. if( pParse->constraintName.n ){
  98003. sqlite3ExprListSetName(pParse, pTab->pCheck, &pParse->constraintName, 1);
  98004. }
  98005. }else
  98006. #endif
  98007. {
  98008. sqlite3ExprDelete(pParse->db, pCheckExpr);
  98009. }
  98010. }
  98011. /*
  98012. ** Set the collation function of the most recently parsed table column
  98013. ** to the CollSeq given.
  98014. */
  98015. SQLITE_PRIVATE void sqlite3AddCollateType(Parse *pParse, Token *pToken){
  98016. Table *p;
  98017. int i;
  98018. char *zColl; /* Dequoted name of collation sequence */
  98019. sqlite3 *db;
  98020. if( (p = pParse->pNewTable)==0 ) return;
  98021. i = p->nCol-1;
  98022. db = pParse->db;
  98023. zColl = sqlite3NameFromToken(db, pToken);
  98024. if( !zColl ) return;
  98025. if( sqlite3LocateCollSeq(pParse, zColl) ){
  98026. Index *pIdx;
  98027. sqlite3DbFree(db, p->aCol[i].zColl);
  98028. p->aCol[i].zColl = zColl;
  98029. /* If the column is declared as "<name> PRIMARY KEY COLLATE <type>",
  98030. ** then an index may have been created on this column before the
  98031. ** collation type was added. Correct this if it is the case.
  98032. */
  98033. for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
  98034. assert( pIdx->nKeyCol==1 );
  98035. if( pIdx->aiColumn[0]==i ){
  98036. pIdx->azColl[0] = p->aCol[i].zColl;
  98037. }
  98038. }
  98039. }else{
  98040. sqlite3DbFree(db, zColl);
  98041. }
  98042. }
  98043. /*
  98044. ** This function returns the collation sequence for database native text
  98045. ** encoding identified by the string zName, length nName.
  98046. **
  98047. ** If the requested collation sequence is not available, or not available
  98048. ** in the database native encoding, the collation factory is invoked to
  98049. ** request it. If the collation factory does not supply such a sequence,
  98050. ** and the sequence is available in another text encoding, then that is
  98051. ** returned instead.
  98052. **
  98053. ** If no versions of the requested collations sequence are available, or
  98054. ** another error occurs, NULL is returned and an error message written into
  98055. ** pParse.
  98056. **
  98057. ** This routine is a wrapper around sqlite3FindCollSeq(). This routine
  98058. ** invokes the collation factory if the named collation cannot be found
  98059. ** and generates an error message.
  98060. **
  98061. ** See also: sqlite3FindCollSeq(), sqlite3GetCollSeq()
  98062. */
  98063. SQLITE_PRIVATE CollSeq *sqlite3LocateCollSeq(Parse *pParse, const char *zName){
  98064. sqlite3 *db = pParse->db;
  98065. u8 enc = ENC(db);
  98066. u8 initbusy = db->init.busy;
  98067. CollSeq *pColl;
  98068. pColl = sqlite3FindCollSeq(db, enc, zName, initbusy);
  98069. if( !initbusy && (!pColl || !pColl->xCmp) ){
  98070. pColl = sqlite3GetCollSeq(pParse, enc, pColl, zName);
  98071. }
  98072. return pColl;
  98073. }
  98074. /*
  98075. ** Generate code that will increment the schema cookie.
  98076. **
  98077. ** The schema cookie is used to determine when the schema for the
  98078. ** database changes. After each schema change, the cookie value
  98079. ** changes. When a process first reads the schema it records the
  98080. ** cookie. Thereafter, whenever it goes to access the database,
  98081. ** it checks the cookie to make sure the schema has not changed
  98082. ** since it was last read.
  98083. **
  98084. ** This plan is not completely bullet-proof. It is possible for
  98085. ** the schema to change multiple times and for the cookie to be
  98086. ** set back to prior value. But schema changes are infrequent
  98087. ** and the probability of hitting the same cookie value is only
  98088. ** 1 chance in 2^32. So we're safe enough.
  98089. **
  98090. ** IMPLEMENTATION-OF: R-34230-56049 SQLite automatically increments
  98091. ** the schema-version whenever the schema changes.
  98092. */
  98093. SQLITE_PRIVATE void sqlite3ChangeCookie(Parse *pParse, int iDb){
  98094. sqlite3 *db = pParse->db;
  98095. Vdbe *v = pParse->pVdbe;
  98096. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  98097. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_SCHEMA_VERSION,
  98098. (int)(1+(unsigned)db->aDb[iDb].pSchema->schema_cookie));
  98099. }
  98100. /*
  98101. ** Measure the number of characters needed to output the given
  98102. ** identifier. The number returned includes any quotes used
  98103. ** but does not include the null terminator.
  98104. **
  98105. ** The estimate is conservative. It might be larger that what is
  98106. ** really needed.
  98107. */
  98108. static int identLength(const char *z){
  98109. int n;
  98110. for(n=0; *z; n++, z++){
  98111. if( *z=='"' ){ n++; }
  98112. }
  98113. return n + 2;
  98114. }
  98115. /*
  98116. ** The first parameter is a pointer to an output buffer. The second
  98117. ** parameter is a pointer to an integer that contains the offset at
  98118. ** which to write into the output buffer. This function copies the
  98119. ** nul-terminated string pointed to by the third parameter, zSignedIdent,
  98120. ** to the specified offset in the buffer and updates *pIdx to refer
  98121. ** to the first byte after the last byte written before returning.
  98122. **
  98123. ** If the string zSignedIdent consists entirely of alpha-numeric
  98124. ** characters, does not begin with a digit and is not an SQL keyword,
  98125. ** then it is copied to the output buffer exactly as it is. Otherwise,
  98126. ** it is quoted using double-quotes.
  98127. */
  98128. static void identPut(char *z, int *pIdx, char *zSignedIdent){
  98129. unsigned char *zIdent = (unsigned char*)zSignedIdent;
  98130. int i, j, needQuote;
  98131. i = *pIdx;
  98132. for(j=0; zIdent[j]; j++){
  98133. if( !sqlite3Isalnum(zIdent[j]) && zIdent[j]!='_' ) break;
  98134. }
  98135. needQuote = sqlite3Isdigit(zIdent[0])
  98136. || sqlite3KeywordCode(zIdent, j)!=TK_ID
  98137. || zIdent[j]!=0
  98138. || j==0;
  98139. if( needQuote ) z[i++] = '"';
  98140. for(j=0; zIdent[j]; j++){
  98141. z[i++] = zIdent[j];
  98142. if( zIdent[j]=='"' ) z[i++] = '"';
  98143. }
  98144. if( needQuote ) z[i++] = '"';
  98145. z[i] = 0;
  98146. *pIdx = i;
  98147. }
  98148. /*
  98149. ** Generate a CREATE TABLE statement appropriate for the given
  98150. ** table. Memory to hold the text of the statement is obtained
  98151. ** from sqliteMalloc() and must be freed by the calling function.
  98152. */
  98153. static char *createTableStmt(sqlite3 *db, Table *p){
  98154. int i, k, n;
  98155. char *zStmt;
  98156. char *zSep, *zSep2, *zEnd;
  98157. Column *pCol;
  98158. n = 0;
  98159. for(pCol = p->aCol, i=0; i<p->nCol; i++, pCol++){
  98160. n += identLength(pCol->zName) + 5;
  98161. }
  98162. n += identLength(p->zName);
  98163. if( n<50 ){
  98164. zSep = "";
  98165. zSep2 = ",";
  98166. zEnd = ")";
  98167. }else{
  98168. zSep = "\n ";
  98169. zSep2 = ",\n ";
  98170. zEnd = "\n)";
  98171. }
  98172. n += 35 + 6*p->nCol;
  98173. zStmt = sqlite3DbMallocRaw(0, n);
  98174. if( zStmt==0 ){
  98175. sqlite3OomFault(db);
  98176. return 0;
  98177. }
  98178. sqlite3_snprintf(n, zStmt, "CREATE TABLE ");
  98179. k = sqlite3Strlen30(zStmt);
  98180. identPut(zStmt, &k, p->zName);
  98181. zStmt[k++] = '(';
  98182. for(pCol=p->aCol, i=0; i<p->nCol; i++, pCol++){
  98183. static const char * const azType[] = {
  98184. /* SQLITE_AFF_BLOB */ "",
  98185. /* SQLITE_AFF_TEXT */ " TEXT",
  98186. /* SQLITE_AFF_NUMERIC */ " NUM",
  98187. /* SQLITE_AFF_INTEGER */ " INT",
  98188. /* SQLITE_AFF_REAL */ " REAL"
  98189. };
  98190. int len;
  98191. const char *zType;
  98192. sqlite3_snprintf(n-k, &zStmt[k], zSep);
  98193. k += sqlite3Strlen30(&zStmt[k]);
  98194. zSep = zSep2;
  98195. identPut(zStmt, &k, pCol->zName);
  98196. assert( pCol->affinity-SQLITE_AFF_BLOB >= 0 );
  98197. assert( pCol->affinity-SQLITE_AFF_BLOB < ArraySize(azType) );
  98198. testcase( pCol->affinity==SQLITE_AFF_BLOB );
  98199. testcase( pCol->affinity==SQLITE_AFF_TEXT );
  98200. testcase( pCol->affinity==SQLITE_AFF_NUMERIC );
  98201. testcase( pCol->affinity==SQLITE_AFF_INTEGER );
  98202. testcase( pCol->affinity==SQLITE_AFF_REAL );
  98203. zType = azType[pCol->affinity - SQLITE_AFF_BLOB];
  98204. len = sqlite3Strlen30(zType);
  98205. assert( pCol->affinity==SQLITE_AFF_BLOB
  98206. || pCol->affinity==sqlite3AffinityType(zType, 0) );
  98207. memcpy(&zStmt[k], zType, len);
  98208. k += len;
  98209. assert( k<=n );
  98210. }
  98211. sqlite3_snprintf(n-k, &zStmt[k], "%s", zEnd);
  98212. return zStmt;
  98213. }
  98214. /*
  98215. ** Resize an Index object to hold N columns total. Return SQLITE_OK
  98216. ** on success and SQLITE_NOMEM on an OOM error.
  98217. */
  98218. static int resizeIndexObject(sqlite3 *db, Index *pIdx, int N){
  98219. char *zExtra;
  98220. int nByte;
  98221. if( pIdx->nColumn>=N ) return SQLITE_OK;
  98222. assert( pIdx->isResized==0 );
  98223. nByte = (sizeof(char*) + sizeof(i16) + 1)*N;
  98224. zExtra = sqlite3DbMallocZero(db, nByte);
  98225. if( zExtra==0 ) return SQLITE_NOMEM_BKPT;
  98226. memcpy(zExtra, pIdx->azColl, sizeof(char*)*pIdx->nColumn);
  98227. pIdx->azColl = (const char**)zExtra;
  98228. zExtra += sizeof(char*)*N;
  98229. memcpy(zExtra, pIdx->aiColumn, sizeof(i16)*pIdx->nColumn);
  98230. pIdx->aiColumn = (i16*)zExtra;
  98231. zExtra += sizeof(i16)*N;
  98232. memcpy(zExtra, pIdx->aSortOrder, pIdx->nColumn);
  98233. pIdx->aSortOrder = (u8*)zExtra;
  98234. pIdx->nColumn = N;
  98235. pIdx->isResized = 1;
  98236. return SQLITE_OK;
  98237. }
  98238. /*
  98239. ** Estimate the total row width for a table.
  98240. */
  98241. static void estimateTableWidth(Table *pTab){
  98242. unsigned wTable = 0;
  98243. const Column *pTabCol;
  98244. int i;
  98245. for(i=pTab->nCol, pTabCol=pTab->aCol; i>0; i--, pTabCol++){
  98246. wTable += pTabCol->szEst;
  98247. }
  98248. if( pTab->iPKey<0 ) wTable++;
  98249. pTab->szTabRow = sqlite3LogEst(wTable*4);
  98250. }
  98251. /*
  98252. ** Estimate the average size of a row for an index.
  98253. */
  98254. static void estimateIndexWidth(Index *pIdx){
  98255. unsigned wIndex = 0;
  98256. int i;
  98257. const Column *aCol = pIdx->pTable->aCol;
  98258. for(i=0; i<pIdx->nColumn; i++){
  98259. i16 x = pIdx->aiColumn[i];
  98260. assert( x<pIdx->pTable->nCol );
  98261. wIndex += x<0 ? 1 : aCol[pIdx->aiColumn[i]].szEst;
  98262. }
  98263. pIdx->szIdxRow = sqlite3LogEst(wIndex*4);
  98264. }
  98265. /* Return true if value x is found any of the first nCol entries of aiCol[]
  98266. */
  98267. static int hasColumn(const i16 *aiCol, int nCol, int x){
  98268. while( nCol-- > 0 ) if( x==*(aiCol++) ) return 1;
  98269. return 0;
  98270. }
  98271. /*
  98272. ** This routine runs at the end of parsing a CREATE TABLE statement that
  98273. ** has a WITHOUT ROWID clause. The job of this routine is to convert both
  98274. ** internal schema data structures and the generated VDBE code so that they
  98275. ** are appropriate for a WITHOUT ROWID table instead of a rowid table.
  98276. ** Changes include:
  98277. **
  98278. ** (1) Set all columns of the PRIMARY KEY schema object to be NOT NULL.
  98279. ** (2) Convert P3 parameter of the OP_CreateBtree from BTREE_INTKEY
  98280. ** into BTREE_BLOBKEY.
  98281. ** (3) Bypass the creation of the sqlite_master table entry
  98282. ** for the PRIMARY KEY as the primary key index is now
  98283. ** identified by the sqlite_master table entry of the table itself.
  98284. ** (4) Set the Index.tnum of the PRIMARY KEY Index object in the
  98285. ** schema to the rootpage from the main table.
  98286. ** (5) Add all table columns to the PRIMARY KEY Index object
  98287. ** so that the PRIMARY KEY is a covering index. The surplus
  98288. ** columns are part of KeyInfo.nAllField and are not used for
  98289. ** sorting or lookup or uniqueness checks.
  98290. ** (6) Replace the rowid tail on all automatically generated UNIQUE
  98291. ** indices with the PRIMARY KEY columns.
  98292. **
  98293. ** For virtual tables, only (1) is performed.
  98294. */
  98295. static void convertToWithoutRowidTable(Parse *pParse, Table *pTab){
  98296. Index *pIdx;
  98297. Index *pPk;
  98298. int nPk;
  98299. int i, j;
  98300. sqlite3 *db = pParse->db;
  98301. Vdbe *v = pParse->pVdbe;
  98302. /* Mark every PRIMARY KEY column as NOT NULL (except for imposter tables)
  98303. */
  98304. if( !db->init.imposterTable ){
  98305. for(i=0; i<pTab->nCol; i++){
  98306. if( (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0 ){
  98307. pTab->aCol[i].notNull = OE_Abort;
  98308. }
  98309. }
  98310. }
  98311. /* The remaining transformations only apply to b-tree tables, not to
  98312. ** virtual tables */
  98313. if( IN_DECLARE_VTAB ) return;
  98314. /* Convert the P3 operand of the OP_CreateBtree opcode from BTREE_INTKEY
  98315. ** into BTREE_BLOBKEY.
  98316. */
  98317. if( pParse->addrCrTab ){
  98318. assert( v );
  98319. sqlite3VdbeChangeP3(v, pParse->addrCrTab, BTREE_BLOBKEY);
  98320. }
  98321. /* Locate the PRIMARY KEY index. Or, if this table was originally
  98322. ** an INTEGER PRIMARY KEY table, create a new PRIMARY KEY index.
  98323. */
  98324. if( pTab->iPKey>=0 ){
  98325. ExprList *pList;
  98326. Token ipkToken;
  98327. sqlite3TokenInit(&ipkToken, pTab->aCol[pTab->iPKey].zName);
  98328. pList = sqlite3ExprListAppend(pParse, 0,
  98329. sqlite3ExprAlloc(db, TK_ID, &ipkToken, 0));
  98330. if( pList==0 ) return;
  98331. pList->a[0].sortOrder = pParse->iPkSortOrder;
  98332. assert( pParse->pNewTable==pTab );
  98333. sqlite3CreateIndex(pParse, 0, 0, 0, pList, pTab->keyConf, 0, 0, 0, 0,
  98334. SQLITE_IDXTYPE_PRIMARYKEY);
  98335. if( db->mallocFailed ) return;
  98336. pPk = sqlite3PrimaryKeyIndex(pTab);
  98337. pTab->iPKey = -1;
  98338. }else{
  98339. pPk = sqlite3PrimaryKeyIndex(pTab);
  98340. /*
  98341. ** Remove all redundant columns from the PRIMARY KEY. For example, change
  98342. ** "PRIMARY KEY(a,b,a,b,c,b,c,d)" into just "PRIMARY KEY(a,b,c,d)". Later
  98343. ** code assumes the PRIMARY KEY contains no repeated columns.
  98344. */
  98345. for(i=j=1; i<pPk->nKeyCol; i++){
  98346. if( hasColumn(pPk->aiColumn, j, pPk->aiColumn[i]) ){
  98347. pPk->nColumn--;
  98348. }else{
  98349. pPk->aiColumn[j++] = pPk->aiColumn[i];
  98350. }
  98351. }
  98352. pPk->nKeyCol = j;
  98353. }
  98354. assert( pPk!=0 );
  98355. pPk->isCovering = 1;
  98356. if( !db->init.imposterTable ) pPk->uniqNotNull = 1;
  98357. nPk = pPk->nKeyCol;
  98358. /* Bypass the creation of the PRIMARY KEY btree and the sqlite_master
  98359. ** table entry. This is only required if currently generating VDBE
  98360. ** code for a CREATE TABLE (not when parsing one as part of reading
  98361. ** a database schema). */
  98362. if( v && pPk->tnum>0 ){
  98363. assert( db->init.busy==0 );
  98364. sqlite3VdbeChangeOpcode(v, pPk->tnum, OP_Goto);
  98365. }
  98366. /* The root page of the PRIMARY KEY is the table root page */
  98367. pPk->tnum = pTab->tnum;
  98368. /* Update the in-memory representation of all UNIQUE indices by converting
  98369. ** the final rowid column into one or more columns of the PRIMARY KEY.
  98370. */
  98371. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  98372. int n;
  98373. if( IsPrimaryKeyIndex(pIdx) ) continue;
  98374. for(i=n=0; i<nPk; i++){
  98375. if( !hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) ) n++;
  98376. }
  98377. if( n==0 ){
  98378. /* This index is a superset of the primary key */
  98379. pIdx->nColumn = pIdx->nKeyCol;
  98380. continue;
  98381. }
  98382. if( resizeIndexObject(db, pIdx, pIdx->nKeyCol+n) ) return;
  98383. for(i=0, j=pIdx->nKeyCol; i<nPk; i++){
  98384. if( !hasColumn(pIdx->aiColumn, pIdx->nKeyCol, pPk->aiColumn[i]) ){
  98385. pIdx->aiColumn[j] = pPk->aiColumn[i];
  98386. pIdx->azColl[j] = pPk->azColl[i];
  98387. j++;
  98388. }
  98389. }
  98390. assert( pIdx->nColumn>=pIdx->nKeyCol+n );
  98391. assert( pIdx->nColumn>=j );
  98392. }
  98393. /* Add all table columns to the PRIMARY KEY index
  98394. */
  98395. if( nPk<pTab->nCol ){
  98396. if( resizeIndexObject(db, pPk, pTab->nCol) ) return;
  98397. for(i=0, j=nPk; i<pTab->nCol; i++){
  98398. if( !hasColumn(pPk->aiColumn, j, i) ){
  98399. assert( j<pPk->nColumn );
  98400. pPk->aiColumn[j] = i;
  98401. pPk->azColl[j] = sqlite3StrBINARY;
  98402. j++;
  98403. }
  98404. }
  98405. assert( pPk->nColumn==j );
  98406. assert( pTab->nCol==j );
  98407. }else{
  98408. pPk->nColumn = pTab->nCol;
  98409. }
  98410. }
  98411. /*
  98412. ** This routine is called to report the final ")" that terminates
  98413. ** a CREATE TABLE statement.
  98414. **
  98415. ** The table structure that other action routines have been building
  98416. ** is added to the internal hash tables, assuming no errors have
  98417. ** occurred.
  98418. **
  98419. ** An entry for the table is made in the master table on disk, unless
  98420. ** this is a temporary table or db->init.busy==1. When db->init.busy==1
  98421. ** it means we are reading the sqlite_master table because we just
  98422. ** connected to the database or because the sqlite_master table has
  98423. ** recently changed, so the entry for this table already exists in
  98424. ** the sqlite_master table. We do not want to create it again.
  98425. **
  98426. ** If the pSelect argument is not NULL, it means that this routine
  98427. ** was called to create a table generated from a
  98428. ** "CREATE TABLE ... AS SELECT ..." statement. The column names of
  98429. ** the new table will match the result set of the SELECT.
  98430. */
  98431. SQLITE_PRIVATE void sqlite3EndTable(
  98432. Parse *pParse, /* Parse context */
  98433. Token *pCons, /* The ',' token after the last column defn. */
  98434. Token *pEnd, /* The ')' before options in the CREATE TABLE */
  98435. u8 tabOpts, /* Extra table options. Usually 0. */
  98436. Select *pSelect /* Select from a "CREATE ... AS SELECT" */
  98437. ){
  98438. Table *p; /* The new table */
  98439. sqlite3 *db = pParse->db; /* The database connection */
  98440. int iDb; /* Database in which the table lives */
  98441. Index *pIdx; /* An implied index of the table */
  98442. if( pEnd==0 && pSelect==0 ){
  98443. return;
  98444. }
  98445. assert( !db->mallocFailed );
  98446. p = pParse->pNewTable;
  98447. if( p==0 ) return;
  98448. /* If the db->init.busy is 1 it means we are reading the SQL off the
  98449. ** "sqlite_master" or "sqlite_temp_master" table on the disk.
  98450. ** So do not write to the disk again. Extract the root page number
  98451. ** for the table from the db->init.newTnum field. (The page number
  98452. ** should have been put there by the sqliteOpenCb routine.)
  98453. **
  98454. ** If the root page number is 1, that means this is the sqlite_master
  98455. ** table itself. So mark it read-only.
  98456. */
  98457. if( db->init.busy ){
  98458. if( pSelect ){
  98459. sqlite3ErrorMsg(pParse, "");
  98460. return;
  98461. }
  98462. p->tnum = db->init.newTnum;
  98463. if( p->tnum==1 ) p->tabFlags |= TF_Readonly;
  98464. }
  98465. /* Special processing for WITHOUT ROWID Tables */
  98466. if( tabOpts & TF_WithoutRowid ){
  98467. if( (p->tabFlags & TF_Autoincrement) ){
  98468. sqlite3ErrorMsg(pParse,
  98469. "AUTOINCREMENT not allowed on WITHOUT ROWID tables");
  98470. return;
  98471. }
  98472. if( (p->tabFlags & TF_HasPrimaryKey)==0 ){
  98473. sqlite3ErrorMsg(pParse, "PRIMARY KEY missing on table %s", p->zName);
  98474. }else{
  98475. p->tabFlags |= TF_WithoutRowid | TF_NoVisibleRowid;
  98476. convertToWithoutRowidTable(pParse, p);
  98477. }
  98478. }
  98479. iDb = sqlite3SchemaToIndex(db, p->pSchema);
  98480. #ifndef SQLITE_OMIT_CHECK
  98481. /* Resolve names in all CHECK constraint expressions.
  98482. */
  98483. if( p->pCheck ){
  98484. sqlite3ResolveSelfReference(pParse, p, NC_IsCheck, 0, p->pCheck);
  98485. }
  98486. #endif /* !defined(SQLITE_OMIT_CHECK) */
  98487. /* Estimate the average row size for the table and for all implied indices */
  98488. estimateTableWidth(p);
  98489. for(pIdx=p->pIndex; pIdx; pIdx=pIdx->pNext){
  98490. estimateIndexWidth(pIdx);
  98491. }
  98492. /* If not initializing, then create a record for the new table
  98493. ** in the SQLITE_MASTER table of the database.
  98494. **
  98495. ** If this is a TEMPORARY table, write the entry into the auxiliary
  98496. ** file instead of into the main database file.
  98497. */
  98498. if( !db->init.busy ){
  98499. int n;
  98500. Vdbe *v;
  98501. char *zType; /* "view" or "table" */
  98502. char *zType2; /* "VIEW" or "TABLE" */
  98503. char *zStmt; /* Text of the CREATE TABLE or CREATE VIEW statement */
  98504. v = sqlite3GetVdbe(pParse);
  98505. if( NEVER(v==0) ) return;
  98506. sqlite3VdbeAddOp1(v, OP_Close, 0);
  98507. /*
  98508. ** Initialize zType for the new view or table.
  98509. */
  98510. if( p->pSelect==0 ){
  98511. /* A regular table */
  98512. zType = "table";
  98513. zType2 = "TABLE";
  98514. #ifndef SQLITE_OMIT_VIEW
  98515. }else{
  98516. /* A view */
  98517. zType = "view";
  98518. zType2 = "VIEW";
  98519. #endif
  98520. }
  98521. /* If this is a CREATE TABLE xx AS SELECT ..., execute the SELECT
  98522. ** statement to populate the new table. The root-page number for the
  98523. ** new table is in register pParse->regRoot.
  98524. **
  98525. ** Once the SELECT has been coded by sqlite3Select(), it is in a
  98526. ** suitable state to query for the column names and types to be used
  98527. ** by the new table.
  98528. **
  98529. ** A shared-cache write-lock is not required to write to the new table,
  98530. ** as a schema-lock must have already been obtained to create it. Since
  98531. ** a schema-lock excludes all other database users, the write-lock would
  98532. ** be redundant.
  98533. */
  98534. if( pSelect ){
  98535. SelectDest dest; /* Where the SELECT should store results */
  98536. int regYield; /* Register holding co-routine entry-point */
  98537. int addrTop; /* Top of the co-routine */
  98538. int regRec; /* A record to be insert into the new table */
  98539. int regRowid; /* Rowid of the next row to insert */
  98540. int addrInsLoop; /* Top of the loop for inserting rows */
  98541. Table *pSelTab; /* A table that describes the SELECT results */
  98542. regYield = ++pParse->nMem;
  98543. regRec = ++pParse->nMem;
  98544. regRowid = ++pParse->nMem;
  98545. assert(pParse->nTab==1);
  98546. sqlite3MayAbort(pParse);
  98547. sqlite3VdbeAddOp3(v, OP_OpenWrite, 1, pParse->regRoot, iDb);
  98548. sqlite3VdbeChangeP5(v, OPFLAG_P2ISREG);
  98549. pParse->nTab = 2;
  98550. addrTop = sqlite3VdbeCurrentAddr(v) + 1;
  98551. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
  98552. if( pParse->nErr ) return;
  98553. pSelTab = sqlite3ResultSetOfSelect(pParse, pSelect);
  98554. if( pSelTab==0 ) return;
  98555. assert( p->aCol==0 );
  98556. p->nCol = pSelTab->nCol;
  98557. p->aCol = pSelTab->aCol;
  98558. pSelTab->nCol = 0;
  98559. pSelTab->aCol = 0;
  98560. sqlite3DeleteTable(db, pSelTab);
  98561. sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
  98562. sqlite3Select(pParse, pSelect, &dest);
  98563. if( pParse->nErr ) return;
  98564. sqlite3VdbeEndCoroutine(v, regYield);
  98565. sqlite3VdbeJumpHere(v, addrTop - 1);
  98566. addrInsLoop = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
  98567. VdbeCoverage(v);
  98568. sqlite3VdbeAddOp3(v, OP_MakeRecord, dest.iSdst, dest.nSdst, regRec);
  98569. sqlite3TableAffinity(v, p, 0);
  98570. sqlite3VdbeAddOp2(v, OP_NewRowid, 1, regRowid);
  98571. sqlite3VdbeAddOp3(v, OP_Insert, 1, regRec, regRowid);
  98572. sqlite3VdbeGoto(v, addrInsLoop);
  98573. sqlite3VdbeJumpHere(v, addrInsLoop);
  98574. sqlite3VdbeAddOp1(v, OP_Close, 1);
  98575. }
  98576. /* Compute the complete text of the CREATE statement */
  98577. if( pSelect ){
  98578. zStmt = createTableStmt(db, p);
  98579. }else{
  98580. Token *pEnd2 = tabOpts ? &pParse->sLastToken : pEnd;
  98581. n = (int)(pEnd2->z - pParse->sNameToken.z);
  98582. if( pEnd2->z[0]!=';' ) n += pEnd2->n;
  98583. zStmt = sqlite3MPrintf(db,
  98584. "CREATE %s %.*s", zType2, n, pParse->sNameToken.z
  98585. );
  98586. }
  98587. /* A slot for the record has already been allocated in the
  98588. ** SQLITE_MASTER table. We just need to update that slot with all
  98589. ** the information we've collected.
  98590. */
  98591. sqlite3NestedParse(pParse,
  98592. "UPDATE %Q.%s "
  98593. "SET type='%s', name=%Q, tbl_name=%Q, rootpage=#%d, sql=%Q "
  98594. "WHERE rowid=#%d",
  98595. db->aDb[iDb].zDbSName, MASTER_NAME,
  98596. zType,
  98597. p->zName,
  98598. p->zName,
  98599. pParse->regRoot,
  98600. zStmt,
  98601. pParse->regRowid
  98602. );
  98603. sqlite3DbFree(db, zStmt);
  98604. sqlite3ChangeCookie(pParse, iDb);
  98605. #ifndef SQLITE_OMIT_AUTOINCREMENT
  98606. /* Check to see if we need to create an sqlite_sequence table for
  98607. ** keeping track of autoincrement keys.
  98608. */
  98609. if( (p->tabFlags & TF_Autoincrement)!=0 ){
  98610. Db *pDb = &db->aDb[iDb];
  98611. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  98612. if( pDb->pSchema->pSeqTab==0 ){
  98613. sqlite3NestedParse(pParse,
  98614. "CREATE TABLE %Q.sqlite_sequence(name,seq)",
  98615. pDb->zDbSName
  98616. );
  98617. }
  98618. }
  98619. #endif
  98620. /* Reparse everything to update our internal data structures */
  98621. sqlite3VdbeAddParseSchemaOp(v, iDb,
  98622. sqlite3MPrintf(db, "tbl_name='%q' AND type!='trigger'", p->zName));
  98623. }
  98624. /* Add the table to the in-memory representation of the database.
  98625. */
  98626. if( db->init.busy ){
  98627. Table *pOld;
  98628. Schema *pSchema = p->pSchema;
  98629. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  98630. pOld = sqlite3HashInsert(&pSchema->tblHash, p->zName, p);
  98631. if( pOld ){
  98632. assert( p==pOld ); /* Malloc must have failed inside HashInsert() */
  98633. sqlite3OomFault(db);
  98634. return;
  98635. }
  98636. pParse->pNewTable = 0;
  98637. db->mDbFlags |= DBFLAG_SchemaChange;
  98638. #ifndef SQLITE_OMIT_ALTERTABLE
  98639. if( !p->pSelect ){
  98640. const char *zName = (const char *)pParse->sNameToken.z;
  98641. int nName;
  98642. assert( !pSelect && pCons && pEnd );
  98643. if( pCons->z==0 ){
  98644. pCons = pEnd;
  98645. }
  98646. nName = (int)((const char *)pCons->z - zName);
  98647. p->addColOffset = 13 + sqlite3Utf8CharLen(zName, nName);
  98648. }
  98649. #endif
  98650. }
  98651. }
  98652. #ifndef SQLITE_OMIT_VIEW
  98653. /*
  98654. ** The parser calls this routine in order to create a new VIEW
  98655. */
  98656. SQLITE_PRIVATE void sqlite3CreateView(
  98657. Parse *pParse, /* The parsing context */
  98658. Token *pBegin, /* The CREATE token that begins the statement */
  98659. Token *pName1, /* The token that holds the name of the view */
  98660. Token *pName2, /* The token that holds the name of the view */
  98661. ExprList *pCNames, /* Optional list of view column names */
  98662. Select *pSelect, /* A SELECT statement that will become the new view */
  98663. int isTemp, /* TRUE for a TEMPORARY view */
  98664. int noErr /* Suppress error messages if VIEW already exists */
  98665. ){
  98666. Table *p;
  98667. int n;
  98668. const char *z;
  98669. Token sEnd;
  98670. DbFixer sFix;
  98671. Token *pName = 0;
  98672. int iDb;
  98673. sqlite3 *db = pParse->db;
  98674. if( pParse->nVar>0 ){
  98675. sqlite3ErrorMsg(pParse, "parameters are not allowed in views");
  98676. goto create_view_fail;
  98677. }
  98678. sqlite3StartTable(pParse, pName1, pName2, isTemp, 1, 0, noErr);
  98679. p = pParse->pNewTable;
  98680. if( p==0 || pParse->nErr ) goto create_view_fail;
  98681. sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  98682. iDb = sqlite3SchemaToIndex(db, p->pSchema);
  98683. sqlite3FixInit(&sFix, pParse, iDb, "view", pName);
  98684. if( sqlite3FixSelect(&sFix, pSelect) ) goto create_view_fail;
  98685. /* Make a copy of the entire SELECT statement that defines the view.
  98686. ** This will force all the Expr.token.z values to be dynamically
  98687. ** allocated rather than point to the input string - which means that
  98688. ** they will persist after the current sqlite3_exec() call returns.
  98689. */
  98690. p->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
  98691. p->pCheck = sqlite3ExprListDup(db, pCNames, EXPRDUP_REDUCE);
  98692. if( db->mallocFailed ) goto create_view_fail;
  98693. /* Locate the end of the CREATE VIEW statement. Make sEnd point to
  98694. ** the end.
  98695. */
  98696. sEnd = pParse->sLastToken;
  98697. assert( sEnd.z[0]!=0 || sEnd.n==0 );
  98698. if( sEnd.z[0]!=';' ){
  98699. sEnd.z += sEnd.n;
  98700. }
  98701. sEnd.n = 0;
  98702. n = (int)(sEnd.z - pBegin->z);
  98703. assert( n>0 );
  98704. z = pBegin->z;
  98705. while( sqlite3Isspace(z[n-1]) ){ n--; }
  98706. sEnd.z = &z[n-1];
  98707. sEnd.n = 1;
  98708. /* Use sqlite3EndTable() to add the view to the SQLITE_MASTER table */
  98709. sqlite3EndTable(pParse, 0, &sEnd, 0, 0);
  98710. create_view_fail:
  98711. sqlite3SelectDelete(db, pSelect);
  98712. sqlite3ExprListDelete(db, pCNames);
  98713. return;
  98714. }
  98715. #endif /* SQLITE_OMIT_VIEW */
  98716. #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
  98717. /*
  98718. ** The Table structure pTable is really a VIEW. Fill in the names of
  98719. ** the columns of the view in the pTable structure. Return the number
  98720. ** of errors. If an error is seen leave an error message in pParse->zErrMsg.
  98721. */
  98722. SQLITE_PRIVATE int sqlite3ViewGetColumnNames(Parse *pParse, Table *pTable){
  98723. Table *pSelTab; /* A fake table from which we get the result set */
  98724. Select *pSel; /* Copy of the SELECT that implements the view */
  98725. int nErr = 0; /* Number of errors encountered */
  98726. int n; /* Temporarily holds the number of cursors assigned */
  98727. sqlite3 *db = pParse->db; /* Database connection for malloc errors */
  98728. #ifndef SQLITE_OMIT_VIRTUALTABLE
  98729. int rc;
  98730. #endif
  98731. #ifndef SQLITE_OMIT_AUTHORIZATION
  98732. sqlite3_xauth xAuth; /* Saved xAuth pointer */
  98733. #endif
  98734. assert( pTable );
  98735. #ifndef SQLITE_OMIT_VIRTUALTABLE
  98736. db->nSchemaLock++;
  98737. rc = sqlite3VtabCallConnect(pParse, pTable);
  98738. db->nSchemaLock--;
  98739. if( rc ){
  98740. return 1;
  98741. }
  98742. if( IsVirtual(pTable) ) return 0;
  98743. #endif
  98744. #ifndef SQLITE_OMIT_VIEW
  98745. /* A positive nCol means the columns names for this view are
  98746. ** already known.
  98747. */
  98748. if( pTable->nCol>0 ) return 0;
  98749. /* A negative nCol is a special marker meaning that we are currently
  98750. ** trying to compute the column names. If we enter this routine with
  98751. ** a negative nCol, it means two or more views form a loop, like this:
  98752. **
  98753. ** CREATE VIEW one AS SELECT * FROM two;
  98754. ** CREATE VIEW two AS SELECT * FROM one;
  98755. **
  98756. ** Actually, the error above is now caught prior to reaching this point.
  98757. ** But the following test is still important as it does come up
  98758. ** in the following:
  98759. **
  98760. ** CREATE TABLE main.ex1(a);
  98761. ** CREATE TEMP VIEW ex1 AS SELECT a FROM ex1;
  98762. ** SELECT * FROM temp.ex1;
  98763. */
  98764. if( pTable->nCol<0 ){
  98765. sqlite3ErrorMsg(pParse, "view %s is circularly defined", pTable->zName);
  98766. return 1;
  98767. }
  98768. assert( pTable->nCol>=0 );
  98769. /* If we get this far, it means we need to compute the table names.
  98770. ** Note that the call to sqlite3ResultSetOfSelect() will expand any
  98771. ** "*" elements in the results set of the view and will assign cursors
  98772. ** to the elements of the FROM clause. But we do not want these changes
  98773. ** to be permanent. So the computation is done on a copy of the SELECT
  98774. ** statement that defines the view.
  98775. */
  98776. assert( pTable->pSelect );
  98777. pSel = sqlite3SelectDup(db, pTable->pSelect, 0);
  98778. if( pSel ){
  98779. n = pParse->nTab;
  98780. sqlite3SrcListAssignCursors(pParse, pSel->pSrc);
  98781. pTable->nCol = -1;
  98782. db->lookaside.bDisable++;
  98783. #ifndef SQLITE_OMIT_AUTHORIZATION
  98784. xAuth = db->xAuth;
  98785. db->xAuth = 0;
  98786. pSelTab = sqlite3ResultSetOfSelect(pParse, pSel);
  98787. db->xAuth = xAuth;
  98788. #else
  98789. pSelTab = sqlite3ResultSetOfSelect(pParse, pSel);
  98790. #endif
  98791. pParse->nTab = n;
  98792. if( pTable->pCheck ){
  98793. /* CREATE VIEW name(arglist) AS ...
  98794. ** The names of the columns in the table are taken from
  98795. ** arglist which is stored in pTable->pCheck. The pCheck field
  98796. ** normally holds CHECK constraints on an ordinary table, but for
  98797. ** a VIEW it holds the list of column names.
  98798. */
  98799. sqlite3ColumnsFromExprList(pParse, pTable->pCheck,
  98800. &pTable->nCol, &pTable->aCol);
  98801. if( db->mallocFailed==0
  98802. && pParse->nErr==0
  98803. && pTable->nCol==pSel->pEList->nExpr
  98804. ){
  98805. sqlite3SelectAddColumnTypeAndCollation(pParse, pTable, pSel);
  98806. }
  98807. }else if( pSelTab ){
  98808. /* CREATE VIEW name AS... without an argument list. Construct
  98809. ** the column names from the SELECT statement that defines the view.
  98810. */
  98811. assert( pTable->aCol==0 );
  98812. pTable->nCol = pSelTab->nCol;
  98813. pTable->aCol = pSelTab->aCol;
  98814. pSelTab->nCol = 0;
  98815. pSelTab->aCol = 0;
  98816. assert( sqlite3SchemaMutexHeld(db, 0, pTable->pSchema) );
  98817. }else{
  98818. pTable->nCol = 0;
  98819. nErr++;
  98820. }
  98821. sqlite3DeleteTable(db, pSelTab);
  98822. sqlite3SelectDelete(db, pSel);
  98823. db->lookaside.bDisable--;
  98824. } else {
  98825. nErr++;
  98826. }
  98827. pTable->pSchema->schemaFlags |= DB_UnresetViews;
  98828. #endif /* SQLITE_OMIT_VIEW */
  98829. return nErr;
  98830. }
  98831. #endif /* !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE) */
  98832. #ifndef SQLITE_OMIT_VIEW
  98833. /*
  98834. ** Clear the column names from every VIEW in database idx.
  98835. */
  98836. static void sqliteViewResetAll(sqlite3 *db, int idx){
  98837. HashElem *i;
  98838. assert( sqlite3SchemaMutexHeld(db, idx, 0) );
  98839. if( !DbHasProperty(db, idx, DB_UnresetViews) ) return;
  98840. for(i=sqliteHashFirst(&db->aDb[idx].pSchema->tblHash); i;i=sqliteHashNext(i)){
  98841. Table *pTab = sqliteHashData(i);
  98842. if( pTab->pSelect ){
  98843. sqlite3DeleteColumnNames(db, pTab);
  98844. pTab->aCol = 0;
  98845. pTab->nCol = 0;
  98846. }
  98847. }
  98848. DbClearProperty(db, idx, DB_UnresetViews);
  98849. }
  98850. #else
  98851. # define sqliteViewResetAll(A,B)
  98852. #endif /* SQLITE_OMIT_VIEW */
  98853. /*
  98854. ** This function is called by the VDBE to adjust the internal schema
  98855. ** used by SQLite when the btree layer moves a table root page. The
  98856. ** root-page of a table or index in database iDb has changed from iFrom
  98857. ** to iTo.
  98858. **
  98859. ** Ticket #1728: The symbol table might still contain information
  98860. ** on tables and/or indices that are the process of being deleted.
  98861. ** If you are unlucky, one of those deleted indices or tables might
  98862. ** have the same rootpage number as the real table or index that is
  98863. ** being moved. So we cannot stop searching after the first match
  98864. ** because the first match might be for one of the deleted indices
  98865. ** or tables and not the table/index that is actually being moved.
  98866. ** We must continue looping until all tables and indices with
  98867. ** rootpage==iFrom have been converted to have a rootpage of iTo
  98868. ** in order to be certain that we got the right one.
  98869. */
  98870. #ifndef SQLITE_OMIT_AUTOVACUUM
  98871. SQLITE_PRIVATE void sqlite3RootPageMoved(sqlite3 *db, int iDb, int iFrom, int iTo){
  98872. HashElem *pElem;
  98873. Hash *pHash;
  98874. Db *pDb;
  98875. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  98876. pDb = &db->aDb[iDb];
  98877. pHash = &pDb->pSchema->tblHash;
  98878. for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
  98879. Table *pTab = sqliteHashData(pElem);
  98880. if( pTab->tnum==iFrom ){
  98881. pTab->tnum = iTo;
  98882. }
  98883. }
  98884. pHash = &pDb->pSchema->idxHash;
  98885. for(pElem=sqliteHashFirst(pHash); pElem; pElem=sqliteHashNext(pElem)){
  98886. Index *pIdx = sqliteHashData(pElem);
  98887. if( pIdx->tnum==iFrom ){
  98888. pIdx->tnum = iTo;
  98889. }
  98890. }
  98891. }
  98892. #endif
  98893. /*
  98894. ** Write code to erase the table with root-page iTable from database iDb.
  98895. ** Also write code to modify the sqlite_master table and internal schema
  98896. ** if a root-page of another table is moved by the btree-layer whilst
  98897. ** erasing iTable (this can happen with an auto-vacuum database).
  98898. */
  98899. static void destroyRootPage(Parse *pParse, int iTable, int iDb){
  98900. Vdbe *v = sqlite3GetVdbe(pParse);
  98901. int r1 = sqlite3GetTempReg(pParse);
  98902. assert( iTable>1 );
  98903. sqlite3VdbeAddOp3(v, OP_Destroy, iTable, r1, iDb);
  98904. sqlite3MayAbort(pParse);
  98905. #ifndef SQLITE_OMIT_AUTOVACUUM
  98906. /* OP_Destroy stores an in integer r1. If this integer
  98907. ** is non-zero, then it is the root page number of a table moved to
  98908. ** location iTable. The following code modifies the sqlite_master table to
  98909. ** reflect this.
  98910. **
  98911. ** The "#NNN" in the SQL is a special constant that means whatever value
  98912. ** is in register NNN. See grammar rules associated with the TK_REGISTER
  98913. ** token for additional information.
  98914. */
  98915. sqlite3NestedParse(pParse,
  98916. "UPDATE %Q.%s SET rootpage=%d WHERE #%d AND rootpage=#%d",
  98917. pParse->db->aDb[iDb].zDbSName, MASTER_NAME, iTable, r1, r1);
  98918. #endif
  98919. sqlite3ReleaseTempReg(pParse, r1);
  98920. }
  98921. /*
  98922. ** Write VDBE code to erase table pTab and all associated indices on disk.
  98923. ** Code to update the sqlite_master tables and internal schema definitions
  98924. ** in case a root-page belonging to another table is moved by the btree layer
  98925. ** is also added (this can happen with an auto-vacuum database).
  98926. */
  98927. static void destroyTable(Parse *pParse, Table *pTab){
  98928. /* If the database may be auto-vacuum capable (if SQLITE_OMIT_AUTOVACUUM
  98929. ** is not defined), then it is important to call OP_Destroy on the
  98930. ** table and index root-pages in order, starting with the numerically
  98931. ** largest root-page number. This guarantees that none of the root-pages
  98932. ** to be destroyed is relocated by an earlier OP_Destroy. i.e. if the
  98933. ** following were coded:
  98934. **
  98935. ** OP_Destroy 4 0
  98936. ** ...
  98937. ** OP_Destroy 5 0
  98938. **
  98939. ** and root page 5 happened to be the largest root-page number in the
  98940. ** database, then root page 5 would be moved to page 4 by the
  98941. ** "OP_Destroy 4 0" opcode. The subsequent "OP_Destroy 5 0" would hit
  98942. ** a free-list page.
  98943. */
  98944. int iTab = pTab->tnum;
  98945. int iDestroyed = 0;
  98946. while( 1 ){
  98947. Index *pIdx;
  98948. int iLargest = 0;
  98949. if( iDestroyed==0 || iTab<iDestroyed ){
  98950. iLargest = iTab;
  98951. }
  98952. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  98953. int iIdx = pIdx->tnum;
  98954. assert( pIdx->pSchema==pTab->pSchema );
  98955. if( (iDestroyed==0 || (iIdx<iDestroyed)) && iIdx>iLargest ){
  98956. iLargest = iIdx;
  98957. }
  98958. }
  98959. if( iLargest==0 ){
  98960. return;
  98961. }else{
  98962. int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  98963. assert( iDb>=0 && iDb<pParse->db->nDb );
  98964. destroyRootPage(pParse, iLargest, iDb);
  98965. iDestroyed = iLargest;
  98966. }
  98967. }
  98968. }
  98969. /*
  98970. ** Remove entries from the sqlite_statN tables (for N in (1,2,3))
  98971. ** after a DROP INDEX or DROP TABLE command.
  98972. */
  98973. static void sqlite3ClearStatTables(
  98974. Parse *pParse, /* The parsing context */
  98975. int iDb, /* The database number */
  98976. const char *zType, /* "idx" or "tbl" */
  98977. const char *zName /* Name of index or table */
  98978. ){
  98979. int i;
  98980. const char *zDbName = pParse->db->aDb[iDb].zDbSName;
  98981. for(i=1; i<=4; i++){
  98982. char zTab[24];
  98983. sqlite3_snprintf(sizeof(zTab),zTab,"sqlite_stat%d",i);
  98984. if( sqlite3FindTable(pParse->db, zTab, zDbName) ){
  98985. sqlite3NestedParse(pParse,
  98986. "DELETE FROM %Q.%s WHERE %s=%Q",
  98987. zDbName, zTab, zType, zName
  98988. );
  98989. }
  98990. }
  98991. }
  98992. /*
  98993. ** Generate code to drop a table.
  98994. */
  98995. SQLITE_PRIVATE void sqlite3CodeDropTable(Parse *pParse, Table *pTab, int iDb, int isView){
  98996. Vdbe *v;
  98997. sqlite3 *db = pParse->db;
  98998. Trigger *pTrigger;
  98999. Db *pDb = &db->aDb[iDb];
  99000. v = sqlite3GetVdbe(pParse);
  99001. assert( v!=0 );
  99002. sqlite3BeginWriteOperation(pParse, 1, iDb);
  99003. #ifndef SQLITE_OMIT_VIRTUALTABLE
  99004. if( IsVirtual(pTab) ){
  99005. sqlite3VdbeAddOp0(v, OP_VBegin);
  99006. }
  99007. #endif
  99008. /* Drop all triggers associated with the table being dropped. Code
  99009. ** is generated to remove entries from sqlite_master and/or
  99010. ** sqlite_temp_master if required.
  99011. */
  99012. pTrigger = sqlite3TriggerList(pParse, pTab);
  99013. while( pTrigger ){
  99014. assert( pTrigger->pSchema==pTab->pSchema ||
  99015. pTrigger->pSchema==db->aDb[1].pSchema );
  99016. sqlite3DropTriggerPtr(pParse, pTrigger);
  99017. pTrigger = pTrigger->pNext;
  99018. }
  99019. #ifndef SQLITE_OMIT_AUTOINCREMENT
  99020. /* Remove any entries of the sqlite_sequence table associated with
  99021. ** the table being dropped. This is done before the table is dropped
  99022. ** at the btree level, in case the sqlite_sequence table needs to
  99023. ** move as a result of the drop (can happen in auto-vacuum mode).
  99024. */
  99025. if( pTab->tabFlags & TF_Autoincrement ){
  99026. sqlite3NestedParse(pParse,
  99027. "DELETE FROM %Q.sqlite_sequence WHERE name=%Q",
  99028. pDb->zDbSName, pTab->zName
  99029. );
  99030. }
  99031. #endif
  99032. /* Drop all SQLITE_MASTER table and index entries that refer to the
  99033. ** table. The program name loops through the master table and deletes
  99034. ** every row that refers to a table of the same name as the one being
  99035. ** dropped. Triggers are handled separately because a trigger can be
  99036. ** created in the temp database that refers to a table in another
  99037. ** database.
  99038. */
  99039. sqlite3NestedParse(pParse,
  99040. "DELETE FROM %Q.%s WHERE tbl_name=%Q and type!='trigger'",
  99041. pDb->zDbSName, MASTER_NAME, pTab->zName);
  99042. if( !isView && !IsVirtual(pTab) ){
  99043. destroyTable(pParse, pTab);
  99044. }
  99045. /* Remove the table entry from SQLite's internal schema and modify
  99046. ** the schema cookie.
  99047. */
  99048. if( IsVirtual(pTab) ){
  99049. sqlite3VdbeAddOp4(v, OP_VDestroy, iDb, 0, 0, pTab->zName, 0);
  99050. }
  99051. sqlite3VdbeAddOp4(v, OP_DropTable, iDb, 0, 0, pTab->zName, 0);
  99052. sqlite3ChangeCookie(pParse, iDb);
  99053. sqliteViewResetAll(db, iDb);
  99054. }
  99055. /*
  99056. ** This routine is called to do the work of a DROP TABLE statement.
  99057. ** pName is the name of the table to be dropped.
  99058. */
  99059. SQLITE_PRIVATE void sqlite3DropTable(Parse *pParse, SrcList *pName, int isView, int noErr){
  99060. Table *pTab;
  99061. Vdbe *v;
  99062. sqlite3 *db = pParse->db;
  99063. int iDb;
  99064. if( db->mallocFailed ){
  99065. goto exit_drop_table;
  99066. }
  99067. assert( pParse->nErr==0 );
  99068. assert( pName->nSrc==1 );
  99069. if( sqlite3ReadSchema(pParse) ) goto exit_drop_table;
  99070. if( noErr ) db->suppressErr++;
  99071. assert( isView==0 || isView==LOCATE_VIEW );
  99072. pTab = sqlite3LocateTableItem(pParse, isView, &pName->a[0]);
  99073. if( noErr ) db->suppressErr--;
  99074. if( pTab==0 ){
  99075. if( noErr ) sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
  99076. goto exit_drop_table;
  99077. }
  99078. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  99079. assert( iDb>=0 && iDb<db->nDb );
  99080. /* If pTab is a virtual table, call ViewGetColumnNames() to ensure
  99081. ** it is initialized.
  99082. */
  99083. if( IsVirtual(pTab) && sqlite3ViewGetColumnNames(pParse, pTab) ){
  99084. goto exit_drop_table;
  99085. }
  99086. #ifndef SQLITE_OMIT_AUTHORIZATION
  99087. {
  99088. int code;
  99089. const char *zTab = SCHEMA_TABLE(iDb);
  99090. const char *zDb = db->aDb[iDb].zDbSName;
  99091. const char *zArg2 = 0;
  99092. if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb)){
  99093. goto exit_drop_table;
  99094. }
  99095. if( isView ){
  99096. if( !OMIT_TEMPDB && iDb==1 ){
  99097. code = SQLITE_DROP_TEMP_VIEW;
  99098. }else{
  99099. code = SQLITE_DROP_VIEW;
  99100. }
  99101. #ifndef SQLITE_OMIT_VIRTUALTABLE
  99102. }else if( IsVirtual(pTab) ){
  99103. code = SQLITE_DROP_VTABLE;
  99104. zArg2 = sqlite3GetVTable(db, pTab)->pMod->zName;
  99105. #endif
  99106. }else{
  99107. if( !OMIT_TEMPDB && iDb==1 ){
  99108. code = SQLITE_DROP_TEMP_TABLE;
  99109. }else{
  99110. code = SQLITE_DROP_TABLE;
  99111. }
  99112. }
  99113. if( sqlite3AuthCheck(pParse, code, pTab->zName, zArg2, zDb) ){
  99114. goto exit_drop_table;
  99115. }
  99116. if( sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0, zDb) ){
  99117. goto exit_drop_table;
  99118. }
  99119. }
  99120. #endif
  99121. if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
  99122. && sqlite3StrNICmp(pTab->zName, "sqlite_stat", 11)!=0 ){
  99123. sqlite3ErrorMsg(pParse, "table %s may not be dropped", pTab->zName);
  99124. goto exit_drop_table;
  99125. }
  99126. #ifndef SQLITE_OMIT_VIEW
  99127. /* Ensure DROP TABLE is not used on a view, and DROP VIEW is not used
  99128. ** on a table.
  99129. */
  99130. if( isView && pTab->pSelect==0 ){
  99131. sqlite3ErrorMsg(pParse, "use DROP TABLE to delete table %s", pTab->zName);
  99132. goto exit_drop_table;
  99133. }
  99134. if( !isView && pTab->pSelect ){
  99135. sqlite3ErrorMsg(pParse, "use DROP VIEW to delete view %s", pTab->zName);
  99136. goto exit_drop_table;
  99137. }
  99138. #endif
  99139. /* Generate code to remove the table from the master table
  99140. ** on disk.
  99141. */
  99142. v = sqlite3GetVdbe(pParse);
  99143. if( v ){
  99144. sqlite3BeginWriteOperation(pParse, 1, iDb);
  99145. sqlite3ClearStatTables(pParse, iDb, "tbl", pTab->zName);
  99146. sqlite3FkDropTable(pParse, pName, pTab);
  99147. sqlite3CodeDropTable(pParse, pTab, iDb, isView);
  99148. }
  99149. exit_drop_table:
  99150. sqlite3SrcListDelete(db, pName);
  99151. }
  99152. /*
  99153. ** This routine is called to create a new foreign key on the table
  99154. ** currently under construction. pFromCol determines which columns
  99155. ** in the current table point to the foreign key. If pFromCol==0 then
  99156. ** connect the key to the last column inserted. pTo is the name of
  99157. ** the table referred to (a.k.a the "parent" table). pToCol is a list
  99158. ** of tables in the parent pTo table. flags contains all
  99159. ** information about the conflict resolution algorithms specified
  99160. ** in the ON DELETE, ON UPDATE and ON INSERT clauses.
  99161. **
  99162. ** An FKey structure is created and added to the table currently
  99163. ** under construction in the pParse->pNewTable field.
  99164. **
  99165. ** The foreign key is set for IMMEDIATE processing. A subsequent call
  99166. ** to sqlite3DeferForeignKey() might change this to DEFERRED.
  99167. */
  99168. SQLITE_PRIVATE void sqlite3CreateForeignKey(
  99169. Parse *pParse, /* Parsing context */
  99170. ExprList *pFromCol, /* Columns in this table that point to other table */
  99171. Token *pTo, /* Name of the other table */
  99172. ExprList *pToCol, /* Columns in the other table */
  99173. int flags /* Conflict resolution algorithms. */
  99174. ){
  99175. sqlite3 *db = pParse->db;
  99176. #ifndef SQLITE_OMIT_FOREIGN_KEY
  99177. FKey *pFKey = 0;
  99178. FKey *pNextTo;
  99179. Table *p = pParse->pNewTable;
  99180. int nByte;
  99181. int i;
  99182. int nCol;
  99183. char *z;
  99184. assert( pTo!=0 );
  99185. if( p==0 || IN_DECLARE_VTAB ) goto fk_end;
  99186. if( pFromCol==0 ){
  99187. int iCol = p->nCol-1;
  99188. if( NEVER(iCol<0) ) goto fk_end;
  99189. if( pToCol && pToCol->nExpr!=1 ){
  99190. sqlite3ErrorMsg(pParse, "foreign key on %s"
  99191. " should reference only one column of table %T",
  99192. p->aCol[iCol].zName, pTo);
  99193. goto fk_end;
  99194. }
  99195. nCol = 1;
  99196. }else if( pToCol && pToCol->nExpr!=pFromCol->nExpr ){
  99197. sqlite3ErrorMsg(pParse,
  99198. "number of columns in foreign key does not match the number of "
  99199. "columns in the referenced table");
  99200. goto fk_end;
  99201. }else{
  99202. nCol = pFromCol->nExpr;
  99203. }
  99204. nByte = sizeof(*pFKey) + (nCol-1)*sizeof(pFKey->aCol[0]) + pTo->n + 1;
  99205. if( pToCol ){
  99206. for(i=0; i<pToCol->nExpr; i++){
  99207. nByte += sqlite3Strlen30(pToCol->a[i].zName) + 1;
  99208. }
  99209. }
  99210. pFKey = sqlite3DbMallocZero(db, nByte );
  99211. if( pFKey==0 ){
  99212. goto fk_end;
  99213. }
  99214. pFKey->pFrom = p;
  99215. pFKey->pNextFrom = p->pFKey;
  99216. z = (char*)&pFKey->aCol[nCol];
  99217. pFKey->zTo = z;
  99218. memcpy(z, pTo->z, pTo->n);
  99219. z[pTo->n] = 0;
  99220. sqlite3Dequote(z);
  99221. z += pTo->n+1;
  99222. pFKey->nCol = nCol;
  99223. if( pFromCol==0 ){
  99224. pFKey->aCol[0].iFrom = p->nCol-1;
  99225. }else{
  99226. for(i=0; i<nCol; i++){
  99227. int j;
  99228. for(j=0; j<p->nCol; j++){
  99229. if( sqlite3StrICmp(p->aCol[j].zName, pFromCol->a[i].zName)==0 ){
  99230. pFKey->aCol[i].iFrom = j;
  99231. break;
  99232. }
  99233. }
  99234. if( j>=p->nCol ){
  99235. sqlite3ErrorMsg(pParse,
  99236. "unknown column \"%s\" in foreign key definition",
  99237. pFromCol->a[i].zName);
  99238. goto fk_end;
  99239. }
  99240. }
  99241. }
  99242. if( pToCol ){
  99243. for(i=0; i<nCol; i++){
  99244. int n = sqlite3Strlen30(pToCol->a[i].zName);
  99245. pFKey->aCol[i].zCol = z;
  99246. memcpy(z, pToCol->a[i].zName, n);
  99247. z[n] = 0;
  99248. z += n+1;
  99249. }
  99250. }
  99251. pFKey->isDeferred = 0;
  99252. pFKey->aAction[0] = (u8)(flags & 0xff); /* ON DELETE action */
  99253. pFKey->aAction[1] = (u8)((flags >> 8 ) & 0xff); /* ON UPDATE action */
  99254. assert( sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
  99255. pNextTo = (FKey *)sqlite3HashInsert(&p->pSchema->fkeyHash,
  99256. pFKey->zTo, (void *)pFKey
  99257. );
  99258. if( pNextTo==pFKey ){
  99259. sqlite3OomFault(db);
  99260. goto fk_end;
  99261. }
  99262. if( pNextTo ){
  99263. assert( pNextTo->pPrevTo==0 );
  99264. pFKey->pNextTo = pNextTo;
  99265. pNextTo->pPrevTo = pFKey;
  99266. }
  99267. /* Link the foreign key to the table as the last step.
  99268. */
  99269. p->pFKey = pFKey;
  99270. pFKey = 0;
  99271. fk_end:
  99272. sqlite3DbFree(db, pFKey);
  99273. #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
  99274. sqlite3ExprListDelete(db, pFromCol);
  99275. sqlite3ExprListDelete(db, pToCol);
  99276. }
  99277. /*
  99278. ** This routine is called when an INITIALLY IMMEDIATE or INITIALLY DEFERRED
  99279. ** clause is seen as part of a foreign key definition. The isDeferred
  99280. ** parameter is 1 for INITIALLY DEFERRED and 0 for INITIALLY IMMEDIATE.
  99281. ** The behavior of the most recently created foreign key is adjusted
  99282. ** accordingly.
  99283. */
  99284. SQLITE_PRIVATE void sqlite3DeferForeignKey(Parse *pParse, int isDeferred){
  99285. #ifndef SQLITE_OMIT_FOREIGN_KEY
  99286. Table *pTab;
  99287. FKey *pFKey;
  99288. if( (pTab = pParse->pNewTable)==0 || (pFKey = pTab->pFKey)==0 ) return;
  99289. assert( isDeferred==0 || isDeferred==1 ); /* EV: R-30323-21917 */
  99290. pFKey->isDeferred = (u8)isDeferred;
  99291. #endif
  99292. }
  99293. /*
  99294. ** Generate code that will erase and refill index *pIdx. This is
  99295. ** used to initialize a newly created index or to recompute the
  99296. ** content of an index in response to a REINDEX command.
  99297. **
  99298. ** if memRootPage is not negative, it means that the index is newly
  99299. ** created. The register specified by memRootPage contains the
  99300. ** root page number of the index. If memRootPage is negative, then
  99301. ** the index already exists and must be cleared before being refilled and
  99302. ** the root page number of the index is taken from pIndex->tnum.
  99303. */
  99304. static void sqlite3RefillIndex(Parse *pParse, Index *pIndex, int memRootPage){
  99305. Table *pTab = pIndex->pTable; /* The table that is indexed */
  99306. int iTab = pParse->nTab++; /* Btree cursor used for pTab */
  99307. int iIdx = pParse->nTab++; /* Btree cursor used for pIndex */
  99308. int iSorter; /* Cursor opened by OpenSorter (if in use) */
  99309. int addr1; /* Address of top of loop */
  99310. int addr2; /* Address to jump to for next iteration */
  99311. int tnum; /* Root page of index */
  99312. int iPartIdxLabel; /* Jump to this label to skip a row */
  99313. Vdbe *v; /* Generate code into this virtual machine */
  99314. KeyInfo *pKey; /* KeyInfo for index */
  99315. int regRecord; /* Register holding assembled index record */
  99316. sqlite3 *db = pParse->db; /* The database connection */
  99317. int iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
  99318. #ifndef SQLITE_OMIT_AUTHORIZATION
  99319. if( sqlite3AuthCheck(pParse, SQLITE_REINDEX, pIndex->zName, 0,
  99320. db->aDb[iDb].zDbSName ) ){
  99321. return;
  99322. }
  99323. #endif
  99324. /* Require a write-lock on the table to perform this operation */
  99325. sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
  99326. v = sqlite3GetVdbe(pParse);
  99327. if( v==0 ) return;
  99328. if( memRootPage>=0 ){
  99329. tnum = memRootPage;
  99330. }else{
  99331. tnum = pIndex->tnum;
  99332. }
  99333. pKey = sqlite3KeyInfoOfIndex(pParse, pIndex);
  99334. assert( pKey!=0 || db->mallocFailed || pParse->nErr );
  99335. /* Open the sorter cursor if we are to use one. */
  99336. iSorter = pParse->nTab++;
  99337. sqlite3VdbeAddOp4(v, OP_SorterOpen, iSorter, 0, pIndex->nKeyCol, (char*)
  99338. sqlite3KeyInfoRef(pKey), P4_KEYINFO);
  99339. /* Open the table. Loop through all rows of the table, inserting index
  99340. ** records into the sorter. */
  99341. sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
  99342. addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0); VdbeCoverage(v);
  99343. regRecord = sqlite3GetTempReg(pParse);
  99344. sqlite3GenerateIndexKey(pParse,pIndex,iTab,regRecord,0,&iPartIdxLabel,0,0);
  99345. sqlite3VdbeAddOp2(v, OP_SorterInsert, iSorter, regRecord);
  99346. sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
  99347. sqlite3VdbeAddOp2(v, OP_Next, iTab, addr1+1); VdbeCoverage(v);
  99348. sqlite3VdbeJumpHere(v, addr1);
  99349. if( memRootPage<0 ) sqlite3VdbeAddOp2(v, OP_Clear, tnum, iDb);
  99350. sqlite3VdbeAddOp4(v, OP_OpenWrite, iIdx, tnum, iDb,
  99351. (char *)pKey, P4_KEYINFO);
  99352. sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR|((memRootPage>=0)?OPFLAG_P2ISREG:0));
  99353. addr1 = sqlite3VdbeAddOp2(v, OP_SorterSort, iSorter, 0); VdbeCoverage(v);
  99354. if( IsUniqueIndex(pIndex) ){
  99355. int j2 = sqlite3VdbeCurrentAddr(v) + 3;
  99356. sqlite3VdbeGoto(v, j2);
  99357. addr2 = sqlite3VdbeCurrentAddr(v);
  99358. sqlite3VdbeAddOp4Int(v, OP_SorterCompare, iSorter, j2, regRecord,
  99359. pIndex->nKeyCol); VdbeCoverage(v);
  99360. sqlite3UniqueConstraint(pParse, OE_Abort, pIndex);
  99361. }else{
  99362. addr2 = sqlite3VdbeCurrentAddr(v);
  99363. }
  99364. sqlite3VdbeAddOp3(v, OP_SorterData, iSorter, regRecord, iIdx);
  99365. sqlite3VdbeAddOp1(v, OP_SeekEnd, iIdx);
  99366. sqlite3VdbeAddOp2(v, OP_IdxInsert, iIdx, regRecord);
  99367. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  99368. sqlite3ReleaseTempReg(pParse, regRecord);
  99369. sqlite3VdbeAddOp2(v, OP_SorterNext, iSorter, addr2); VdbeCoverage(v);
  99370. sqlite3VdbeJumpHere(v, addr1);
  99371. sqlite3VdbeAddOp1(v, OP_Close, iTab);
  99372. sqlite3VdbeAddOp1(v, OP_Close, iIdx);
  99373. sqlite3VdbeAddOp1(v, OP_Close, iSorter);
  99374. }
  99375. /*
  99376. ** Allocate heap space to hold an Index object with nCol columns.
  99377. **
  99378. ** Increase the allocation size to provide an extra nExtra bytes
  99379. ** of 8-byte aligned space after the Index object and return a
  99380. ** pointer to this extra space in *ppExtra.
  99381. */
  99382. SQLITE_PRIVATE Index *sqlite3AllocateIndexObject(
  99383. sqlite3 *db, /* Database connection */
  99384. i16 nCol, /* Total number of columns in the index */
  99385. int nExtra, /* Number of bytes of extra space to alloc */
  99386. char **ppExtra /* Pointer to the "extra" space */
  99387. ){
  99388. Index *p; /* Allocated index object */
  99389. int nByte; /* Bytes of space for Index object + arrays */
  99390. nByte = ROUND8(sizeof(Index)) + /* Index structure */
  99391. ROUND8(sizeof(char*)*nCol) + /* Index.azColl */
  99392. ROUND8(sizeof(LogEst)*(nCol+1) + /* Index.aiRowLogEst */
  99393. sizeof(i16)*nCol + /* Index.aiColumn */
  99394. sizeof(u8)*nCol); /* Index.aSortOrder */
  99395. p = sqlite3DbMallocZero(db, nByte + nExtra);
  99396. if( p ){
  99397. char *pExtra = ((char*)p)+ROUND8(sizeof(Index));
  99398. p->azColl = (const char**)pExtra; pExtra += ROUND8(sizeof(char*)*nCol);
  99399. p->aiRowLogEst = (LogEst*)pExtra; pExtra += sizeof(LogEst)*(nCol+1);
  99400. p->aiColumn = (i16*)pExtra; pExtra += sizeof(i16)*nCol;
  99401. p->aSortOrder = (u8*)pExtra;
  99402. p->nColumn = nCol;
  99403. p->nKeyCol = nCol - 1;
  99404. *ppExtra = ((char*)p) + nByte;
  99405. }
  99406. return p;
  99407. }
  99408. /*
  99409. ** Create a new index for an SQL table. pName1.pName2 is the name of the index
  99410. ** and pTblList is the name of the table that is to be indexed. Both will
  99411. ** be NULL for a primary key or an index that is created to satisfy a
  99412. ** UNIQUE constraint. If pTable and pIndex are NULL, use pParse->pNewTable
  99413. ** as the table to be indexed. pParse->pNewTable is a table that is
  99414. ** currently being constructed by a CREATE TABLE statement.
  99415. **
  99416. ** pList is a list of columns to be indexed. pList will be NULL if this
  99417. ** is a primary key or unique-constraint on the most recent column added
  99418. ** to the table currently under construction.
  99419. */
  99420. SQLITE_PRIVATE void sqlite3CreateIndex(
  99421. Parse *pParse, /* All information about this parse */
  99422. Token *pName1, /* First part of index name. May be NULL */
  99423. Token *pName2, /* Second part of index name. May be NULL */
  99424. SrcList *pTblName, /* Table to index. Use pParse->pNewTable if 0 */
  99425. ExprList *pList, /* A list of columns to be indexed */
  99426. int onError, /* OE_Abort, OE_Ignore, OE_Replace, or OE_None */
  99427. Token *pStart, /* The CREATE token that begins this statement */
  99428. Expr *pPIWhere, /* WHERE clause for partial indices */
  99429. int sortOrder, /* Sort order of primary key when pList==NULL */
  99430. int ifNotExist, /* Omit error if index already exists */
  99431. u8 idxType /* The index type */
  99432. ){
  99433. Table *pTab = 0; /* Table to be indexed */
  99434. Index *pIndex = 0; /* The index to be created */
  99435. char *zName = 0; /* Name of the index */
  99436. int nName; /* Number of characters in zName */
  99437. int i, j;
  99438. DbFixer sFix; /* For assigning database names to pTable */
  99439. int sortOrderMask; /* 1 to honor DESC in index. 0 to ignore. */
  99440. sqlite3 *db = pParse->db;
  99441. Db *pDb; /* The specific table containing the indexed database */
  99442. int iDb; /* Index of the database that is being written */
  99443. Token *pName = 0; /* Unqualified name of the index to create */
  99444. struct ExprList_item *pListItem; /* For looping over pList */
  99445. int nExtra = 0; /* Space allocated for zExtra[] */
  99446. int nExtraCol; /* Number of extra columns needed */
  99447. char *zExtra = 0; /* Extra space after the Index object */
  99448. Index *pPk = 0; /* PRIMARY KEY index for WITHOUT ROWID tables */
  99449. if( db->mallocFailed || pParse->nErr>0 ){
  99450. goto exit_create_index;
  99451. }
  99452. if( IN_DECLARE_VTAB && idxType!=SQLITE_IDXTYPE_PRIMARYKEY ){
  99453. goto exit_create_index;
  99454. }
  99455. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  99456. goto exit_create_index;
  99457. }
  99458. /*
  99459. ** Find the table that is to be indexed. Return early if not found.
  99460. */
  99461. if( pTblName!=0 ){
  99462. /* Use the two-part index name to determine the database
  99463. ** to search for the table. 'Fix' the table name to this db
  99464. ** before looking up the table.
  99465. */
  99466. assert( pName1 && pName2 );
  99467. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  99468. if( iDb<0 ) goto exit_create_index;
  99469. assert( pName && pName->z );
  99470. #ifndef SQLITE_OMIT_TEMPDB
  99471. /* If the index name was unqualified, check if the table
  99472. ** is a temp table. If so, set the database to 1. Do not do this
  99473. ** if initialising a database schema.
  99474. */
  99475. if( !db->init.busy ){
  99476. pTab = sqlite3SrcListLookup(pParse, pTblName);
  99477. if( pName2->n==0 && pTab && pTab->pSchema==db->aDb[1].pSchema ){
  99478. iDb = 1;
  99479. }
  99480. }
  99481. #endif
  99482. sqlite3FixInit(&sFix, pParse, iDb, "index", pName);
  99483. if( sqlite3FixSrcList(&sFix, pTblName) ){
  99484. /* Because the parser constructs pTblName from a single identifier,
  99485. ** sqlite3FixSrcList can never fail. */
  99486. assert(0);
  99487. }
  99488. pTab = sqlite3LocateTableItem(pParse, 0, &pTblName->a[0]);
  99489. assert( db->mallocFailed==0 || pTab==0 );
  99490. if( pTab==0 ) goto exit_create_index;
  99491. if( iDb==1 && db->aDb[iDb].pSchema!=pTab->pSchema ){
  99492. sqlite3ErrorMsg(pParse,
  99493. "cannot create a TEMP index on non-TEMP table \"%s\"",
  99494. pTab->zName);
  99495. goto exit_create_index;
  99496. }
  99497. if( !HasRowid(pTab) ) pPk = sqlite3PrimaryKeyIndex(pTab);
  99498. }else{
  99499. assert( pName==0 );
  99500. assert( pStart==0 );
  99501. pTab = pParse->pNewTable;
  99502. if( !pTab ) goto exit_create_index;
  99503. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  99504. }
  99505. pDb = &db->aDb[iDb];
  99506. assert( pTab!=0 );
  99507. assert( pParse->nErr==0 );
  99508. if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0
  99509. && db->init.busy==0
  99510. #if SQLITE_USER_AUTHENTICATION
  99511. && sqlite3UserAuthTable(pTab->zName)==0
  99512. #endif
  99513. && sqlite3StrNICmp(&pTab->zName[7],"altertab_",9)!=0 ){
  99514. sqlite3ErrorMsg(pParse, "table %s may not be indexed", pTab->zName);
  99515. goto exit_create_index;
  99516. }
  99517. #ifndef SQLITE_OMIT_VIEW
  99518. if( pTab->pSelect ){
  99519. sqlite3ErrorMsg(pParse, "views may not be indexed");
  99520. goto exit_create_index;
  99521. }
  99522. #endif
  99523. #ifndef SQLITE_OMIT_VIRTUALTABLE
  99524. if( IsVirtual(pTab) ){
  99525. sqlite3ErrorMsg(pParse, "virtual tables may not be indexed");
  99526. goto exit_create_index;
  99527. }
  99528. #endif
  99529. /*
  99530. ** Find the name of the index. Make sure there is not already another
  99531. ** index or table with the same name.
  99532. **
  99533. ** Exception: If we are reading the names of permanent indices from the
  99534. ** sqlite_master table (because some other process changed the schema) and
  99535. ** one of the index names collides with the name of a temporary table or
  99536. ** index, then we will continue to process this index.
  99537. **
  99538. ** If pName==0 it means that we are
  99539. ** dealing with a primary key or UNIQUE constraint. We have to invent our
  99540. ** own name.
  99541. */
  99542. if( pName ){
  99543. zName = sqlite3NameFromToken(db, pName);
  99544. if( zName==0 ) goto exit_create_index;
  99545. assert( pName->z!=0 );
  99546. if( SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
  99547. goto exit_create_index;
  99548. }
  99549. if( !db->init.busy ){
  99550. if( sqlite3FindTable(db, zName, 0)!=0 ){
  99551. sqlite3ErrorMsg(pParse, "there is already a table named %s", zName);
  99552. goto exit_create_index;
  99553. }
  99554. }
  99555. if( sqlite3FindIndex(db, zName, pDb->zDbSName)!=0 ){
  99556. if( !ifNotExist ){
  99557. sqlite3ErrorMsg(pParse, "index %s already exists", zName);
  99558. }else{
  99559. assert( !db->init.busy );
  99560. sqlite3CodeVerifySchema(pParse, iDb);
  99561. }
  99562. goto exit_create_index;
  99563. }
  99564. }else{
  99565. int n;
  99566. Index *pLoop;
  99567. for(pLoop=pTab->pIndex, n=1; pLoop; pLoop=pLoop->pNext, n++){}
  99568. zName = sqlite3MPrintf(db, "sqlite_autoindex_%s_%d", pTab->zName, n);
  99569. if( zName==0 ){
  99570. goto exit_create_index;
  99571. }
  99572. /* Automatic index names generated from within sqlite3_declare_vtab()
  99573. ** must have names that are distinct from normal automatic index names.
  99574. ** The following statement converts "sqlite3_autoindex..." into
  99575. ** "sqlite3_butoindex..." in order to make the names distinct.
  99576. ** The "vtab_err.test" test demonstrates the need of this statement. */
  99577. if( IN_DECLARE_VTAB ) zName[7]++;
  99578. }
  99579. /* Check for authorization to create an index.
  99580. */
  99581. #ifndef SQLITE_OMIT_AUTHORIZATION
  99582. {
  99583. const char *zDb = pDb->zDbSName;
  99584. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(iDb), 0, zDb) ){
  99585. goto exit_create_index;
  99586. }
  99587. i = SQLITE_CREATE_INDEX;
  99588. if( !OMIT_TEMPDB && iDb==1 ) i = SQLITE_CREATE_TEMP_INDEX;
  99589. if( sqlite3AuthCheck(pParse, i, zName, pTab->zName, zDb) ){
  99590. goto exit_create_index;
  99591. }
  99592. }
  99593. #endif
  99594. /* If pList==0, it means this routine was called to make a primary
  99595. ** key out of the last column added to the table under construction.
  99596. ** So create a fake list to simulate this.
  99597. */
  99598. if( pList==0 ){
  99599. Token prevCol;
  99600. Column *pCol = &pTab->aCol[pTab->nCol-1];
  99601. pCol->colFlags |= COLFLAG_UNIQUE;
  99602. sqlite3TokenInit(&prevCol, pCol->zName);
  99603. pList = sqlite3ExprListAppend(pParse, 0,
  99604. sqlite3ExprAlloc(db, TK_ID, &prevCol, 0));
  99605. if( pList==0 ) goto exit_create_index;
  99606. assert( pList->nExpr==1 );
  99607. sqlite3ExprListSetSortOrder(pList, sortOrder);
  99608. }else{
  99609. sqlite3ExprListCheckLength(pParse, pList, "index");
  99610. }
  99611. /* Figure out how many bytes of space are required to store explicitly
  99612. ** specified collation sequence names.
  99613. */
  99614. for(i=0; i<pList->nExpr; i++){
  99615. Expr *pExpr = pList->a[i].pExpr;
  99616. assert( pExpr!=0 );
  99617. if( pExpr->op==TK_COLLATE ){
  99618. nExtra += (1 + sqlite3Strlen30(pExpr->u.zToken));
  99619. }
  99620. }
  99621. /*
  99622. ** Allocate the index structure.
  99623. */
  99624. nName = sqlite3Strlen30(zName);
  99625. nExtraCol = pPk ? pPk->nKeyCol : 1;
  99626. pIndex = sqlite3AllocateIndexObject(db, pList->nExpr + nExtraCol,
  99627. nName + nExtra + 1, &zExtra);
  99628. if( db->mallocFailed ){
  99629. goto exit_create_index;
  99630. }
  99631. assert( EIGHT_BYTE_ALIGNMENT(pIndex->aiRowLogEst) );
  99632. assert( EIGHT_BYTE_ALIGNMENT(pIndex->azColl) );
  99633. pIndex->zName = zExtra;
  99634. zExtra += nName + 1;
  99635. memcpy(pIndex->zName, zName, nName+1);
  99636. pIndex->pTable = pTab;
  99637. pIndex->onError = (u8)onError;
  99638. pIndex->uniqNotNull = onError!=OE_None;
  99639. pIndex->idxType = idxType;
  99640. pIndex->pSchema = db->aDb[iDb].pSchema;
  99641. pIndex->nKeyCol = pList->nExpr;
  99642. if( pPIWhere ){
  99643. sqlite3ResolveSelfReference(pParse, pTab, NC_PartIdx, pPIWhere, 0);
  99644. pIndex->pPartIdxWhere = pPIWhere;
  99645. pPIWhere = 0;
  99646. }
  99647. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  99648. /* Check to see if we should honor DESC requests on index columns
  99649. */
  99650. if( pDb->pSchema->file_format>=4 ){
  99651. sortOrderMask = -1; /* Honor DESC */
  99652. }else{
  99653. sortOrderMask = 0; /* Ignore DESC */
  99654. }
  99655. /* Analyze the list of expressions that form the terms of the index and
  99656. ** report any errors. In the common case where the expression is exactly
  99657. ** a table column, store that column in aiColumn[]. For general expressions,
  99658. ** populate pIndex->aColExpr and store XN_EXPR (-2) in aiColumn[].
  99659. **
  99660. ** TODO: Issue a warning if two or more columns of the index are identical.
  99661. ** TODO: Issue a warning if the table primary key is used as part of the
  99662. ** index key.
  99663. */
  99664. for(i=0, pListItem=pList->a; i<pList->nExpr; i++, pListItem++){
  99665. Expr *pCExpr; /* The i-th index expression */
  99666. int requestedSortOrder; /* ASC or DESC on the i-th expression */
  99667. const char *zColl; /* Collation sequence name */
  99668. sqlite3StringToId(pListItem->pExpr);
  99669. sqlite3ResolveSelfReference(pParse, pTab, NC_IdxExpr, pListItem->pExpr, 0);
  99670. if( pParse->nErr ) goto exit_create_index;
  99671. pCExpr = sqlite3ExprSkipCollate(pListItem->pExpr);
  99672. if( pCExpr->op!=TK_COLUMN ){
  99673. if( pTab==pParse->pNewTable ){
  99674. sqlite3ErrorMsg(pParse, "expressions prohibited in PRIMARY KEY and "
  99675. "UNIQUE constraints");
  99676. goto exit_create_index;
  99677. }
  99678. if( pIndex->aColExpr==0 ){
  99679. ExprList *pCopy = sqlite3ExprListDup(db, pList, 0);
  99680. pIndex->aColExpr = pCopy;
  99681. if( !db->mallocFailed ){
  99682. assert( pCopy!=0 );
  99683. pListItem = &pCopy->a[i];
  99684. }
  99685. }
  99686. j = XN_EXPR;
  99687. pIndex->aiColumn[i] = XN_EXPR;
  99688. pIndex->uniqNotNull = 0;
  99689. }else{
  99690. j = pCExpr->iColumn;
  99691. assert( j<=0x7fff );
  99692. if( j<0 ){
  99693. j = pTab->iPKey;
  99694. }else if( pTab->aCol[j].notNull==0 ){
  99695. pIndex->uniqNotNull = 0;
  99696. }
  99697. pIndex->aiColumn[i] = (i16)j;
  99698. }
  99699. zColl = 0;
  99700. if( pListItem->pExpr->op==TK_COLLATE ){
  99701. int nColl;
  99702. zColl = pListItem->pExpr->u.zToken;
  99703. nColl = sqlite3Strlen30(zColl) + 1;
  99704. assert( nExtra>=nColl );
  99705. memcpy(zExtra, zColl, nColl);
  99706. zColl = zExtra;
  99707. zExtra += nColl;
  99708. nExtra -= nColl;
  99709. }else if( j>=0 ){
  99710. zColl = pTab->aCol[j].zColl;
  99711. }
  99712. if( !zColl ) zColl = sqlite3StrBINARY;
  99713. if( !db->init.busy && !sqlite3LocateCollSeq(pParse, zColl) ){
  99714. goto exit_create_index;
  99715. }
  99716. pIndex->azColl[i] = zColl;
  99717. requestedSortOrder = pListItem->sortOrder & sortOrderMask;
  99718. pIndex->aSortOrder[i] = (u8)requestedSortOrder;
  99719. }
  99720. /* Append the table key to the end of the index. For WITHOUT ROWID
  99721. ** tables (when pPk!=0) this will be the declared PRIMARY KEY. For
  99722. ** normal tables (when pPk==0) this will be the rowid.
  99723. */
  99724. if( pPk ){
  99725. for(j=0; j<pPk->nKeyCol; j++){
  99726. int x = pPk->aiColumn[j];
  99727. assert( x>=0 );
  99728. if( hasColumn(pIndex->aiColumn, pIndex->nKeyCol, x) ){
  99729. pIndex->nColumn--;
  99730. }else{
  99731. pIndex->aiColumn[i] = x;
  99732. pIndex->azColl[i] = pPk->azColl[j];
  99733. pIndex->aSortOrder[i] = pPk->aSortOrder[j];
  99734. i++;
  99735. }
  99736. }
  99737. assert( i==pIndex->nColumn );
  99738. }else{
  99739. pIndex->aiColumn[i] = XN_ROWID;
  99740. pIndex->azColl[i] = sqlite3StrBINARY;
  99741. }
  99742. sqlite3DefaultRowEst(pIndex);
  99743. if( pParse->pNewTable==0 ) estimateIndexWidth(pIndex);
  99744. /* If this index contains every column of its table, then mark
  99745. ** it as a covering index */
  99746. assert( HasRowid(pTab)
  99747. || pTab->iPKey<0 || sqlite3ColumnOfIndex(pIndex, pTab->iPKey)>=0 );
  99748. if( pTblName!=0 && pIndex->nColumn>=pTab->nCol ){
  99749. pIndex->isCovering = 1;
  99750. for(j=0; j<pTab->nCol; j++){
  99751. if( j==pTab->iPKey ) continue;
  99752. if( sqlite3ColumnOfIndex(pIndex,j)>=0 ) continue;
  99753. pIndex->isCovering = 0;
  99754. break;
  99755. }
  99756. }
  99757. if( pTab==pParse->pNewTable ){
  99758. /* This routine has been called to create an automatic index as a
  99759. ** result of a PRIMARY KEY or UNIQUE clause on a column definition, or
  99760. ** a PRIMARY KEY or UNIQUE clause following the column definitions.
  99761. ** i.e. one of:
  99762. **
  99763. ** CREATE TABLE t(x PRIMARY KEY, y);
  99764. ** CREATE TABLE t(x, y, UNIQUE(x, y));
  99765. **
  99766. ** Either way, check to see if the table already has such an index. If
  99767. ** so, don't bother creating this one. This only applies to
  99768. ** automatically created indices. Users can do as they wish with
  99769. ** explicit indices.
  99770. **
  99771. ** Two UNIQUE or PRIMARY KEY constraints are considered equivalent
  99772. ** (and thus suppressing the second one) even if they have different
  99773. ** sort orders.
  99774. **
  99775. ** If there are different collating sequences or if the columns of
  99776. ** the constraint occur in different orders, then the constraints are
  99777. ** considered distinct and both result in separate indices.
  99778. */
  99779. Index *pIdx;
  99780. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  99781. int k;
  99782. assert( IsUniqueIndex(pIdx) );
  99783. assert( pIdx->idxType!=SQLITE_IDXTYPE_APPDEF );
  99784. assert( IsUniqueIndex(pIndex) );
  99785. if( pIdx->nKeyCol!=pIndex->nKeyCol ) continue;
  99786. for(k=0; k<pIdx->nKeyCol; k++){
  99787. const char *z1;
  99788. const char *z2;
  99789. assert( pIdx->aiColumn[k]>=0 );
  99790. if( pIdx->aiColumn[k]!=pIndex->aiColumn[k] ) break;
  99791. z1 = pIdx->azColl[k];
  99792. z2 = pIndex->azColl[k];
  99793. if( sqlite3StrICmp(z1, z2) ) break;
  99794. }
  99795. if( k==pIdx->nKeyCol ){
  99796. if( pIdx->onError!=pIndex->onError ){
  99797. /* This constraint creates the same index as a previous
  99798. ** constraint specified somewhere in the CREATE TABLE statement.
  99799. ** However the ON CONFLICT clauses are different. If both this
  99800. ** constraint and the previous equivalent constraint have explicit
  99801. ** ON CONFLICT clauses this is an error. Otherwise, use the
  99802. ** explicitly specified behavior for the index.
  99803. */
  99804. if( !(pIdx->onError==OE_Default || pIndex->onError==OE_Default) ){
  99805. sqlite3ErrorMsg(pParse,
  99806. "conflicting ON CONFLICT clauses specified", 0);
  99807. }
  99808. if( pIdx->onError==OE_Default ){
  99809. pIdx->onError = pIndex->onError;
  99810. }
  99811. }
  99812. if( idxType==SQLITE_IDXTYPE_PRIMARYKEY ) pIdx->idxType = idxType;
  99813. goto exit_create_index;
  99814. }
  99815. }
  99816. }
  99817. /* Link the new Index structure to its table and to the other
  99818. ** in-memory database structures.
  99819. */
  99820. assert( pParse->nErr==0 );
  99821. if( db->init.busy ){
  99822. Index *p;
  99823. assert( !IN_DECLARE_VTAB );
  99824. assert( sqlite3SchemaMutexHeld(db, 0, pIndex->pSchema) );
  99825. p = sqlite3HashInsert(&pIndex->pSchema->idxHash,
  99826. pIndex->zName, pIndex);
  99827. if( p ){
  99828. assert( p==pIndex ); /* Malloc must have failed */
  99829. sqlite3OomFault(db);
  99830. goto exit_create_index;
  99831. }
  99832. db->mDbFlags |= DBFLAG_SchemaChange;
  99833. if( pTblName!=0 ){
  99834. pIndex->tnum = db->init.newTnum;
  99835. }
  99836. }
  99837. /* If this is the initial CREATE INDEX statement (or CREATE TABLE if the
  99838. ** index is an implied index for a UNIQUE or PRIMARY KEY constraint) then
  99839. ** emit code to allocate the index rootpage on disk and make an entry for
  99840. ** the index in the sqlite_master table and populate the index with
  99841. ** content. But, do not do this if we are simply reading the sqlite_master
  99842. ** table to parse the schema, or if this index is the PRIMARY KEY index
  99843. ** of a WITHOUT ROWID table.
  99844. **
  99845. ** If pTblName==0 it means this index is generated as an implied PRIMARY KEY
  99846. ** or UNIQUE index in a CREATE TABLE statement. Since the table
  99847. ** has just been created, it contains no data and the index initialization
  99848. ** step can be skipped.
  99849. */
  99850. else if( HasRowid(pTab) || pTblName!=0 ){
  99851. Vdbe *v;
  99852. char *zStmt;
  99853. int iMem = ++pParse->nMem;
  99854. v = sqlite3GetVdbe(pParse);
  99855. if( v==0 ) goto exit_create_index;
  99856. sqlite3BeginWriteOperation(pParse, 1, iDb);
  99857. /* Create the rootpage for the index using CreateIndex. But before
  99858. ** doing so, code a Noop instruction and store its address in
  99859. ** Index.tnum. This is required in case this index is actually a
  99860. ** PRIMARY KEY and the table is actually a WITHOUT ROWID table. In
  99861. ** that case the convertToWithoutRowidTable() routine will replace
  99862. ** the Noop with a Goto to jump over the VDBE code generated below. */
  99863. pIndex->tnum = sqlite3VdbeAddOp0(v, OP_Noop);
  99864. sqlite3VdbeAddOp3(v, OP_CreateBtree, iDb, iMem, BTREE_BLOBKEY);
  99865. /* Gather the complete text of the CREATE INDEX statement into
  99866. ** the zStmt variable
  99867. */
  99868. if( pStart ){
  99869. int n = (int)(pParse->sLastToken.z - pName->z) + pParse->sLastToken.n;
  99870. if( pName->z[n-1]==';' ) n--;
  99871. /* A named index with an explicit CREATE INDEX statement */
  99872. zStmt = sqlite3MPrintf(db, "CREATE%s INDEX %.*s",
  99873. onError==OE_None ? "" : " UNIQUE", n, pName->z);
  99874. }else{
  99875. /* An automatic index created by a PRIMARY KEY or UNIQUE constraint */
  99876. /* zStmt = sqlite3MPrintf(""); */
  99877. zStmt = 0;
  99878. }
  99879. /* Add an entry in sqlite_master for this index
  99880. */
  99881. sqlite3NestedParse(pParse,
  99882. "INSERT INTO %Q.%s VALUES('index',%Q,%Q,#%d,%Q);",
  99883. db->aDb[iDb].zDbSName, MASTER_NAME,
  99884. pIndex->zName,
  99885. pTab->zName,
  99886. iMem,
  99887. zStmt
  99888. );
  99889. sqlite3DbFree(db, zStmt);
  99890. /* Fill the index with data and reparse the schema. Code an OP_Expire
  99891. ** to invalidate all pre-compiled statements.
  99892. */
  99893. if( pTblName ){
  99894. sqlite3RefillIndex(pParse, pIndex, iMem);
  99895. sqlite3ChangeCookie(pParse, iDb);
  99896. sqlite3VdbeAddParseSchemaOp(v, iDb,
  99897. sqlite3MPrintf(db, "name='%q' AND type='index'", pIndex->zName));
  99898. sqlite3VdbeAddOp0(v, OP_Expire);
  99899. }
  99900. sqlite3VdbeJumpHere(v, pIndex->tnum);
  99901. }
  99902. /* When adding an index to the list of indices for a table, make
  99903. ** sure all indices labeled OE_Replace come after all those labeled
  99904. ** OE_Ignore. This is necessary for the correct constraint check
  99905. ** processing (in sqlite3GenerateConstraintChecks()) as part of
  99906. ** UPDATE and INSERT statements.
  99907. */
  99908. if( db->init.busy || pTblName==0 ){
  99909. if( onError!=OE_Replace || pTab->pIndex==0
  99910. || pTab->pIndex->onError==OE_Replace){
  99911. pIndex->pNext = pTab->pIndex;
  99912. pTab->pIndex = pIndex;
  99913. }else{
  99914. Index *pOther = pTab->pIndex;
  99915. while( pOther->pNext && pOther->pNext->onError!=OE_Replace ){
  99916. pOther = pOther->pNext;
  99917. }
  99918. pIndex->pNext = pOther->pNext;
  99919. pOther->pNext = pIndex;
  99920. }
  99921. pIndex = 0;
  99922. }
  99923. /* Clean up before exiting */
  99924. exit_create_index:
  99925. if( pIndex ) freeIndex(db, pIndex);
  99926. sqlite3ExprDelete(db, pPIWhere);
  99927. sqlite3ExprListDelete(db, pList);
  99928. sqlite3SrcListDelete(db, pTblName);
  99929. sqlite3DbFree(db, zName);
  99930. }
  99931. /*
  99932. ** Fill the Index.aiRowEst[] array with default information - information
  99933. ** to be used when we have not run the ANALYZE command.
  99934. **
  99935. ** aiRowEst[0] is supposed to contain the number of elements in the index.
  99936. ** Since we do not know, guess 1 million. aiRowEst[1] is an estimate of the
  99937. ** number of rows in the table that match any particular value of the
  99938. ** first column of the index. aiRowEst[2] is an estimate of the number
  99939. ** of rows that match any particular combination of the first 2 columns
  99940. ** of the index. And so forth. It must always be the case that
  99941. *
  99942. ** aiRowEst[N]<=aiRowEst[N-1]
  99943. ** aiRowEst[N]>=1
  99944. **
  99945. ** Apart from that, we have little to go on besides intuition as to
  99946. ** how aiRowEst[] should be initialized. The numbers generated here
  99947. ** are based on typical values found in actual indices.
  99948. */
  99949. SQLITE_PRIVATE void sqlite3DefaultRowEst(Index *pIdx){
  99950. /* 10, 9, 8, 7, 6 */
  99951. LogEst aVal[] = { 33, 32, 30, 28, 26 };
  99952. LogEst *a = pIdx->aiRowLogEst;
  99953. int nCopy = MIN(ArraySize(aVal), pIdx->nKeyCol);
  99954. int i;
  99955. /* Indexes with default row estimates should not have stat1 data */
  99956. assert( !pIdx->hasStat1 );
  99957. /* Set the first entry (number of rows in the index) to the estimated
  99958. ** number of rows in the table, or half the number of rows in the table
  99959. ** for a partial index. But do not let the estimate drop below 10. */
  99960. a[0] = pIdx->pTable->nRowLogEst;
  99961. if( pIdx->pPartIdxWhere!=0 ) a[0] -= 10; assert( 10==sqlite3LogEst(2) );
  99962. if( a[0]<33 ) a[0] = 33; assert( 33==sqlite3LogEst(10) );
  99963. /* Estimate that a[1] is 10, a[2] is 9, a[3] is 8, a[4] is 7, a[5] is
  99964. ** 6 and each subsequent value (if any) is 5. */
  99965. memcpy(&a[1], aVal, nCopy*sizeof(LogEst));
  99966. for(i=nCopy+1; i<=pIdx->nKeyCol; i++){
  99967. a[i] = 23; assert( 23==sqlite3LogEst(5) );
  99968. }
  99969. assert( 0==sqlite3LogEst(1) );
  99970. if( IsUniqueIndex(pIdx) ) a[pIdx->nKeyCol] = 0;
  99971. }
  99972. /*
  99973. ** This routine will drop an existing named index. This routine
  99974. ** implements the DROP INDEX statement.
  99975. */
  99976. SQLITE_PRIVATE void sqlite3DropIndex(Parse *pParse, SrcList *pName, int ifExists){
  99977. Index *pIndex;
  99978. Vdbe *v;
  99979. sqlite3 *db = pParse->db;
  99980. int iDb;
  99981. assert( pParse->nErr==0 ); /* Never called with prior errors */
  99982. if( db->mallocFailed ){
  99983. goto exit_drop_index;
  99984. }
  99985. assert( pName->nSrc==1 );
  99986. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  99987. goto exit_drop_index;
  99988. }
  99989. pIndex = sqlite3FindIndex(db, pName->a[0].zName, pName->a[0].zDatabase);
  99990. if( pIndex==0 ){
  99991. if( !ifExists ){
  99992. sqlite3ErrorMsg(pParse, "no such index: %S", pName, 0);
  99993. }else{
  99994. sqlite3CodeVerifyNamedSchema(pParse, pName->a[0].zDatabase);
  99995. }
  99996. pParse->checkSchema = 1;
  99997. goto exit_drop_index;
  99998. }
  99999. if( pIndex->idxType!=SQLITE_IDXTYPE_APPDEF ){
  100000. sqlite3ErrorMsg(pParse, "index associated with UNIQUE "
  100001. "or PRIMARY KEY constraint cannot be dropped", 0);
  100002. goto exit_drop_index;
  100003. }
  100004. iDb = sqlite3SchemaToIndex(db, pIndex->pSchema);
  100005. #ifndef SQLITE_OMIT_AUTHORIZATION
  100006. {
  100007. int code = SQLITE_DROP_INDEX;
  100008. Table *pTab = pIndex->pTable;
  100009. const char *zDb = db->aDb[iDb].zDbSName;
  100010. const char *zTab = SCHEMA_TABLE(iDb);
  100011. if( sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb) ){
  100012. goto exit_drop_index;
  100013. }
  100014. if( !OMIT_TEMPDB && iDb ) code = SQLITE_DROP_TEMP_INDEX;
  100015. if( sqlite3AuthCheck(pParse, code, pIndex->zName, pTab->zName, zDb) ){
  100016. goto exit_drop_index;
  100017. }
  100018. }
  100019. #endif
  100020. /* Generate code to remove the index and from the master table */
  100021. v = sqlite3GetVdbe(pParse);
  100022. if( v ){
  100023. sqlite3BeginWriteOperation(pParse, 1, iDb);
  100024. sqlite3NestedParse(pParse,
  100025. "DELETE FROM %Q.%s WHERE name=%Q AND type='index'",
  100026. db->aDb[iDb].zDbSName, MASTER_NAME, pIndex->zName
  100027. );
  100028. sqlite3ClearStatTables(pParse, iDb, "idx", pIndex->zName);
  100029. sqlite3ChangeCookie(pParse, iDb);
  100030. destroyRootPage(pParse, pIndex->tnum, iDb);
  100031. sqlite3VdbeAddOp4(v, OP_DropIndex, iDb, 0, 0, pIndex->zName, 0);
  100032. }
  100033. exit_drop_index:
  100034. sqlite3SrcListDelete(db, pName);
  100035. }
  100036. /*
  100037. ** pArray is a pointer to an array of objects. Each object in the
  100038. ** array is szEntry bytes in size. This routine uses sqlite3DbRealloc()
  100039. ** to extend the array so that there is space for a new object at the end.
  100040. **
  100041. ** When this function is called, *pnEntry contains the current size of
  100042. ** the array (in entries - so the allocation is ((*pnEntry) * szEntry) bytes
  100043. ** in total).
  100044. **
  100045. ** If the realloc() is successful (i.e. if no OOM condition occurs), the
  100046. ** space allocated for the new object is zeroed, *pnEntry updated to
  100047. ** reflect the new size of the array and a pointer to the new allocation
  100048. ** returned. *pIdx is set to the index of the new array entry in this case.
  100049. **
  100050. ** Otherwise, if the realloc() fails, *pIdx is set to -1, *pnEntry remains
  100051. ** unchanged and a copy of pArray returned.
  100052. */
  100053. SQLITE_PRIVATE void *sqlite3ArrayAllocate(
  100054. sqlite3 *db, /* Connection to notify of malloc failures */
  100055. void *pArray, /* Array of objects. Might be reallocated */
  100056. int szEntry, /* Size of each object in the array */
  100057. int *pnEntry, /* Number of objects currently in use */
  100058. int *pIdx /* Write the index of a new slot here */
  100059. ){
  100060. char *z;
  100061. int n = *pnEntry;
  100062. if( (n & (n-1))==0 ){
  100063. int sz = (n==0) ? 1 : 2*n;
  100064. void *pNew = sqlite3DbRealloc(db, pArray, sz*szEntry);
  100065. if( pNew==0 ){
  100066. *pIdx = -1;
  100067. return pArray;
  100068. }
  100069. pArray = pNew;
  100070. }
  100071. z = (char*)pArray;
  100072. memset(&z[n * szEntry], 0, szEntry);
  100073. *pIdx = n;
  100074. ++*pnEntry;
  100075. return pArray;
  100076. }
  100077. /*
  100078. ** Append a new element to the given IdList. Create a new IdList if
  100079. ** need be.
  100080. **
  100081. ** A new IdList is returned, or NULL if malloc() fails.
  100082. */
  100083. SQLITE_PRIVATE IdList *sqlite3IdListAppend(sqlite3 *db, IdList *pList, Token *pToken){
  100084. int i;
  100085. if( pList==0 ){
  100086. pList = sqlite3DbMallocZero(db, sizeof(IdList) );
  100087. if( pList==0 ) return 0;
  100088. }
  100089. pList->a = sqlite3ArrayAllocate(
  100090. db,
  100091. pList->a,
  100092. sizeof(pList->a[0]),
  100093. &pList->nId,
  100094. &i
  100095. );
  100096. if( i<0 ){
  100097. sqlite3IdListDelete(db, pList);
  100098. return 0;
  100099. }
  100100. pList->a[i].zName = sqlite3NameFromToken(db, pToken);
  100101. return pList;
  100102. }
  100103. /*
  100104. ** Delete an IdList.
  100105. */
  100106. SQLITE_PRIVATE void sqlite3IdListDelete(sqlite3 *db, IdList *pList){
  100107. int i;
  100108. if( pList==0 ) return;
  100109. for(i=0; i<pList->nId; i++){
  100110. sqlite3DbFree(db, pList->a[i].zName);
  100111. }
  100112. sqlite3DbFree(db, pList->a);
  100113. sqlite3DbFreeNN(db, pList);
  100114. }
  100115. /*
  100116. ** Return the index in pList of the identifier named zId. Return -1
  100117. ** if not found.
  100118. */
  100119. SQLITE_PRIVATE int sqlite3IdListIndex(IdList *pList, const char *zName){
  100120. int i;
  100121. if( pList==0 ) return -1;
  100122. for(i=0; i<pList->nId; i++){
  100123. if( sqlite3StrICmp(pList->a[i].zName, zName)==0 ) return i;
  100124. }
  100125. return -1;
  100126. }
  100127. /*
  100128. ** Expand the space allocated for the given SrcList object by
  100129. ** creating nExtra new slots beginning at iStart. iStart is zero based.
  100130. ** New slots are zeroed.
  100131. **
  100132. ** For example, suppose a SrcList initially contains two entries: A,B.
  100133. ** To append 3 new entries onto the end, do this:
  100134. **
  100135. ** sqlite3SrcListEnlarge(db, pSrclist, 3, 2);
  100136. **
  100137. ** After the call above it would contain: A, B, nil, nil, nil.
  100138. ** If the iStart argument had been 1 instead of 2, then the result
  100139. ** would have been: A, nil, nil, nil, B. To prepend the new slots,
  100140. ** the iStart value would be 0. The result then would
  100141. ** be: nil, nil, nil, A, B.
  100142. **
  100143. ** If a memory allocation fails the SrcList is unchanged. The
  100144. ** db->mallocFailed flag will be set to true.
  100145. */
  100146. SQLITE_PRIVATE SrcList *sqlite3SrcListEnlarge(
  100147. sqlite3 *db, /* Database connection to notify of OOM errors */
  100148. SrcList *pSrc, /* The SrcList to be enlarged */
  100149. int nExtra, /* Number of new slots to add to pSrc->a[] */
  100150. int iStart /* Index in pSrc->a[] of first new slot */
  100151. ){
  100152. int i;
  100153. /* Sanity checking on calling parameters */
  100154. assert( iStart>=0 );
  100155. assert( nExtra>=1 );
  100156. assert( pSrc!=0 );
  100157. assert( iStart<=pSrc->nSrc );
  100158. /* Allocate additional space if needed */
  100159. if( (u32)pSrc->nSrc+nExtra>pSrc->nAlloc ){
  100160. SrcList *pNew;
  100161. int nAlloc = pSrc->nSrc*2+nExtra;
  100162. int nGot;
  100163. pNew = sqlite3DbRealloc(db, pSrc,
  100164. sizeof(*pSrc) + (nAlloc-1)*sizeof(pSrc->a[0]) );
  100165. if( pNew==0 ){
  100166. assert( db->mallocFailed );
  100167. return pSrc;
  100168. }
  100169. pSrc = pNew;
  100170. nGot = (sqlite3DbMallocSize(db, pNew) - sizeof(*pSrc))/sizeof(pSrc->a[0])+1;
  100171. pSrc->nAlloc = nGot;
  100172. }
  100173. /* Move existing slots that come after the newly inserted slots
  100174. ** out of the way */
  100175. for(i=pSrc->nSrc-1; i>=iStart; i--){
  100176. pSrc->a[i+nExtra] = pSrc->a[i];
  100177. }
  100178. pSrc->nSrc += nExtra;
  100179. /* Zero the newly allocated slots */
  100180. memset(&pSrc->a[iStart], 0, sizeof(pSrc->a[0])*nExtra);
  100181. for(i=iStart; i<iStart+nExtra; i++){
  100182. pSrc->a[i].iCursor = -1;
  100183. }
  100184. /* Return a pointer to the enlarged SrcList */
  100185. return pSrc;
  100186. }
  100187. /*
  100188. ** Append a new table name to the given SrcList. Create a new SrcList if
  100189. ** need be. A new entry is created in the SrcList even if pTable is NULL.
  100190. **
  100191. ** A SrcList is returned, or NULL if there is an OOM error. The returned
  100192. ** SrcList might be the same as the SrcList that was input or it might be
  100193. ** a new one. If an OOM error does occurs, then the prior value of pList
  100194. ** that is input to this routine is automatically freed.
  100195. **
  100196. ** If pDatabase is not null, it means that the table has an optional
  100197. ** database name prefix. Like this: "database.table". The pDatabase
  100198. ** points to the table name and the pTable points to the database name.
  100199. ** The SrcList.a[].zName field is filled with the table name which might
  100200. ** come from pTable (if pDatabase is NULL) or from pDatabase.
  100201. ** SrcList.a[].zDatabase is filled with the database name from pTable,
  100202. ** or with NULL if no database is specified.
  100203. **
  100204. ** In other words, if call like this:
  100205. **
  100206. ** sqlite3SrcListAppend(D,A,B,0);
  100207. **
  100208. ** Then B is a table name and the database name is unspecified. If called
  100209. ** like this:
  100210. **
  100211. ** sqlite3SrcListAppend(D,A,B,C);
  100212. **
  100213. ** Then C is the table name and B is the database name. If C is defined
  100214. ** then so is B. In other words, we never have a case where:
  100215. **
  100216. ** sqlite3SrcListAppend(D,A,0,C);
  100217. **
  100218. ** Both pTable and pDatabase are assumed to be quoted. They are dequoted
  100219. ** before being added to the SrcList.
  100220. */
  100221. SQLITE_PRIVATE SrcList *sqlite3SrcListAppend(
  100222. sqlite3 *db, /* Connection to notify of malloc failures */
  100223. SrcList *pList, /* Append to this SrcList. NULL creates a new SrcList */
  100224. Token *pTable, /* Table to append */
  100225. Token *pDatabase /* Database of the table */
  100226. ){
  100227. struct SrcList_item *pItem;
  100228. assert( pDatabase==0 || pTable!=0 ); /* Cannot have C without B */
  100229. assert( db!=0 );
  100230. if( pList==0 ){
  100231. pList = sqlite3DbMallocRawNN(db, sizeof(SrcList) );
  100232. if( pList==0 ) return 0;
  100233. pList->nAlloc = 1;
  100234. pList->nSrc = 1;
  100235. memset(&pList->a[0], 0, sizeof(pList->a[0]));
  100236. pList->a[0].iCursor = -1;
  100237. }else{
  100238. pList = sqlite3SrcListEnlarge(db, pList, 1, pList->nSrc);
  100239. }
  100240. if( db->mallocFailed ){
  100241. sqlite3SrcListDelete(db, pList);
  100242. return 0;
  100243. }
  100244. pItem = &pList->a[pList->nSrc-1];
  100245. if( pDatabase && pDatabase->z==0 ){
  100246. pDatabase = 0;
  100247. }
  100248. if( pDatabase ){
  100249. pItem->zName = sqlite3NameFromToken(db, pDatabase);
  100250. pItem->zDatabase = sqlite3NameFromToken(db, pTable);
  100251. }else{
  100252. pItem->zName = sqlite3NameFromToken(db, pTable);
  100253. pItem->zDatabase = 0;
  100254. }
  100255. return pList;
  100256. }
  100257. /*
  100258. ** Assign VdbeCursor index numbers to all tables in a SrcList
  100259. */
  100260. SQLITE_PRIVATE void sqlite3SrcListAssignCursors(Parse *pParse, SrcList *pList){
  100261. int i;
  100262. struct SrcList_item *pItem;
  100263. assert(pList || pParse->db->mallocFailed );
  100264. if( pList ){
  100265. for(i=0, pItem=pList->a; i<pList->nSrc; i++, pItem++){
  100266. if( pItem->iCursor>=0 ) break;
  100267. pItem->iCursor = pParse->nTab++;
  100268. if( pItem->pSelect ){
  100269. sqlite3SrcListAssignCursors(pParse, pItem->pSelect->pSrc);
  100270. }
  100271. }
  100272. }
  100273. }
  100274. /*
  100275. ** Delete an entire SrcList including all its substructure.
  100276. */
  100277. SQLITE_PRIVATE void sqlite3SrcListDelete(sqlite3 *db, SrcList *pList){
  100278. int i;
  100279. struct SrcList_item *pItem;
  100280. if( pList==0 ) return;
  100281. for(pItem=pList->a, i=0; i<pList->nSrc; i++, pItem++){
  100282. sqlite3DbFree(db, pItem->zDatabase);
  100283. sqlite3DbFree(db, pItem->zName);
  100284. sqlite3DbFree(db, pItem->zAlias);
  100285. if( pItem->fg.isIndexedBy ) sqlite3DbFree(db, pItem->u1.zIndexedBy);
  100286. if( pItem->fg.isTabFunc ) sqlite3ExprListDelete(db, pItem->u1.pFuncArg);
  100287. sqlite3DeleteTable(db, pItem->pTab);
  100288. sqlite3SelectDelete(db, pItem->pSelect);
  100289. sqlite3ExprDelete(db, pItem->pOn);
  100290. sqlite3IdListDelete(db, pItem->pUsing);
  100291. }
  100292. sqlite3DbFreeNN(db, pList);
  100293. }
  100294. /*
  100295. ** This routine is called by the parser to add a new term to the
  100296. ** end of a growing FROM clause. The "p" parameter is the part of
  100297. ** the FROM clause that has already been constructed. "p" is NULL
  100298. ** if this is the first term of the FROM clause. pTable and pDatabase
  100299. ** are the name of the table and database named in the FROM clause term.
  100300. ** pDatabase is NULL if the database name qualifier is missing - the
  100301. ** usual case. If the term has an alias, then pAlias points to the
  100302. ** alias token. If the term is a subquery, then pSubquery is the
  100303. ** SELECT statement that the subquery encodes. The pTable and
  100304. ** pDatabase parameters are NULL for subqueries. The pOn and pUsing
  100305. ** parameters are the content of the ON and USING clauses.
  100306. **
  100307. ** Return a new SrcList which encodes is the FROM with the new
  100308. ** term added.
  100309. */
  100310. SQLITE_PRIVATE SrcList *sqlite3SrcListAppendFromTerm(
  100311. Parse *pParse, /* Parsing context */
  100312. SrcList *p, /* The left part of the FROM clause already seen */
  100313. Token *pTable, /* Name of the table to add to the FROM clause */
  100314. Token *pDatabase, /* Name of the database containing pTable */
  100315. Token *pAlias, /* The right-hand side of the AS subexpression */
  100316. Select *pSubquery, /* A subquery used in place of a table name */
  100317. Expr *pOn, /* The ON clause of a join */
  100318. IdList *pUsing /* The USING clause of a join */
  100319. ){
  100320. struct SrcList_item *pItem;
  100321. sqlite3 *db = pParse->db;
  100322. if( !p && (pOn || pUsing) ){
  100323. sqlite3ErrorMsg(pParse, "a JOIN clause is required before %s",
  100324. (pOn ? "ON" : "USING")
  100325. );
  100326. goto append_from_error;
  100327. }
  100328. p = sqlite3SrcListAppend(db, p, pTable, pDatabase);
  100329. if( p==0 ){
  100330. goto append_from_error;
  100331. }
  100332. assert( p->nSrc>0 );
  100333. pItem = &p->a[p->nSrc-1];
  100334. assert( pAlias!=0 );
  100335. if( pAlias->n ){
  100336. pItem->zAlias = sqlite3NameFromToken(db, pAlias);
  100337. }
  100338. pItem->pSelect = pSubquery;
  100339. pItem->pOn = pOn;
  100340. pItem->pUsing = pUsing;
  100341. return p;
  100342. append_from_error:
  100343. assert( p==0 );
  100344. sqlite3ExprDelete(db, pOn);
  100345. sqlite3IdListDelete(db, pUsing);
  100346. sqlite3SelectDelete(db, pSubquery);
  100347. return 0;
  100348. }
  100349. /*
  100350. ** Add an INDEXED BY or NOT INDEXED clause to the most recently added
  100351. ** element of the source-list passed as the second argument.
  100352. */
  100353. SQLITE_PRIVATE void sqlite3SrcListIndexedBy(Parse *pParse, SrcList *p, Token *pIndexedBy){
  100354. assert( pIndexedBy!=0 );
  100355. if( p && pIndexedBy->n>0 ){
  100356. struct SrcList_item *pItem;
  100357. assert( p->nSrc>0 );
  100358. pItem = &p->a[p->nSrc-1];
  100359. assert( pItem->fg.notIndexed==0 );
  100360. assert( pItem->fg.isIndexedBy==0 );
  100361. assert( pItem->fg.isTabFunc==0 );
  100362. if( pIndexedBy->n==1 && !pIndexedBy->z ){
  100363. /* A "NOT INDEXED" clause was supplied. See parse.y
  100364. ** construct "indexed_opt" for details. */
  100365. pItem->fg.notIndexed = 1;
  100366. }else{
  100367. pItem->u1.zIndexedBy = sqlite3NameFromToken(pParse->db, pIndexedBy);
  100368. pItem->fg.isIndexedBy = 1;
  100369. }
  100370. }
  100371. }
  100372. /*
  100373. ** Add the list of function arguments to the SrcList entry for a
  100374. ** table-valued-function.
  100375. */
  100376. SQLITE_PRIVATE void sqlite3SrcListFuncArgs(Parse *pParse, SrcList *p, ExprList *pList){
  100377. if( p ){
  100378. struct SrcList_item *pItem = &p->a[p->nSrc-1];
  100379. assert( pItem->fg.notIndexed==0 );
  100380. assert( pItem->fg.isIndexedBy==0 );
  100381. assert( pItem->fg.isTabFunc==0 );
  100382. pItem->u1.pFuncArg = pList;
  100383. pItem->fg.isTabFunc = 1;
  100384. }else{
  100385. sqlite3ExprListDelete(pParse->db, pList);
  100386. }
  100387. }
  100388. /*
  100389. ** When building up a FROM clause in the parser, the join operator
  100390. ** is initially attached to the left operand. But the code generator
  100391. ** expects the join operator to be on the right operand. This routine
  100392. ** Shifts all join operators from left to right for an entire FROM
  100393. ** clause.
  100394. **
  100395. ** Example: Suppose the join is like this:
  100396. **
  100397. ** A natural cross join B
  100398. **
  100399. ** The operator is "natural cross join". The A and B operands are stored
  100400. ** in p->a[0] and p->a[1], respectively. The parser initially stores the
  100401. ** operator with A. This routine shifts that operator over to B.
  100402. */
  100403. SQLITE_PRIVATE void sqlite3SrcListShiftJoinType(SrcList *p){
  100404. if( p ){
  100405. int i;
  100406. for(i=p->nSrc-1; i>0; i--){
  100407. p->a[i].fg.jointype = p->a[i-1].fg.jointype;
  100408. }
  100409. p->a[0].fg.jointype = 0;
  100410. }
  100411. }
  100412. /*
  100413. ** Generate VDBE code for a BEGIN statement.
  100414. */
  100415. SQLITE_PRIVATE void sqlite3BeginTransaction(Parse *pParse, int type){
  100416. sqlite3 *db;
  100417. Vdbe *v;
  100418. int i;
  100419. assert( pParse!=0 );
  100420. db = pParse->db;
  100421. assert( db!=0 );
  100422. if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION, "BEGIN", 0, 0) ){
  100423. return;
  100424. }
  100425. v = sqlite3GetVdbe(pParse);
  100426. if( !v ) return;
  100427. if( type!=TK_DEFERRED ){
  100428. for(i=0; i<db->nDb; i++){
  100429. sqlite3VdbeAddOp2(v, OP_Transaction, i, (type==TK_EXCLUSIVE)+1);
  100430. sqlite3VdbeUsesBtree(v, i);
  100431. }
  100432. }
  100433. sqlite3VdbeAddOp0(v, OP_AutoCommit);
  100434. }
  100435. /*
  100436. ** Generate VDBE code for a COMMIT or ROLLBACK statement.
  100437. ** Code for ROLLBACK is generated if eType==TK_ROLLBACK. Otherwise
  100438. ** code is generated for a COMMIT.
  100439. */
  100440. SQLITE_PRIVATE void sqlite3EndTransaction(Parse *pParse, int eType){
  100441. Vdbe *v;
  100442. int isRollback;
  100443. assert( pParse!=0 );
  100444. assert( pParse->db!=0 );
  100445. assert( eType==TK_COMMIT || eType==TK_END || eType==TK_ROLLBACK );
  100446. isRollback = eType==TK_ROLLBACK;
  100447. if( sqlite3AuthCheck(pParse, SQLITE_TRANSACTION,
  100448. isRollback ? "ROLLBACK" : "COMMIT", 0, 0) ){
  100449. return;
  100450. }
  100451. v = sqlite3GetVdbe(pParse);
  100452. if( v ){
  100453. sqlite3VdbeAddOp2(v, OP_AutoCommit, 1, isRollback);
  100454. }
  100455. }
  100456. /*
  100457. ** This function is called by the parser when it parses a command to create,
  100458. ** release or rollback an SQL savepoint.
  100459. */
  100460. SQLITE_PRIVATE void sqlite3Savepoint(Parse *pParse, int op, Token *pName){
  100461. char *zName = sqlite3NameFromToken(pParse->db, pName);
  100462. if( zName ){
  100463. Vdbe *v = sqlite3GetVdbe(pParse);
  100464. #ifndef SQLITE_OMIT_AUTHORIZATION
  100465. static const char * const az[] = { "BEGIN", "RELEASE", "ROLLBACK" };
  100466. assert( !SAVEPOINT_BEGIN && SAVEPOINT_RELEASE==1 && SAVEPOINT_ROLLBACK==2 );
  100467. #endif
  100468. if( !v || sqlite3AuthCheck(pParse, SQLITE_SAVEPOINT, az[op], zName, 0) ){
  100469. sqlite3DbFree(pParse->db, zName);
  100470. return;
  100471. }
  100472. sqlite3VdbeAddOp4(v, OP_Savepoint, op, 0, 0, zName, P4_DYNAMIC);
  100473. }
  100474. }
  100475. /*
  100476. ** Make sure the TEMP database is open and available for use. Return
  100477. ** the number of errors. Leave any error messages in the pParse structure.
  100478. */
  100479. SQLITE_PRIVATE int sqlite3OpenTempDatabase(Parse *pParse){
  100480. sqlite3 *db = pParse->db;
  100481. if( db->aDb[1].pBt==0 && !pParse->explain ){
  100482. int rc;
  100483. Btree *pBt;
  100484. static const int flags =
  100485. SQLITE_OPEN_READWRITE |
  100486. SQLITE_OPEN_CREATE |
  100487. SQLITE_OPEN_EXCLUSIVE |
  100488. SQLITE_OPEN_DELETEONCLOSE |
  100489. SQLITE_OPEN_TEMP_DB;
  100490. rc = sqlite3BtreeOpen(db->pVfs, 0, db, &pBt, 0, flags);
  100491. if( rc!=SQLITE_OK ){
  100492. sqlite3ErrorMsg(pParse, "unable to open a temporary database "
  100493. "file for storing temporary tables");
  100494. pParse->rc = rc;
  100495. return 1;
  100496. }
  100497. db->aDb[1].pBt = pBt;
  100498. assert( db->aDb[1].pSchema );
  100499. if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize, -1, 0) ){
  100500. sqlite3OomFault(db);
  100501. return 1;
  100502. }
  100503. }
  100504. return 0;
  100505. }
  100506. /*
  100507. ** Record the fact that the schema cookie will need to be verified
  100508. ** for database iDb. The code to actually verify the schema cookie
  100509. ** will occur at the end of the top-level VDBE and will be generated
  100510. ** later, by sqlite3FinishCoding().
  100511. */
  100512. SQLITE_PRIVATE void sqlite3CodeVerifySchema(Parse *pParse, int iDb){
  100513. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  100514. assert( iDb>=0 && iDb<pParse->db->nDb );
  100515. assert( pParse->db->aDb[iDb].pBt!=0 || iDb==1 );
  100516. assert( iDb<SQLITE_MAX_ATTACHED+2 );
  100517. assert( sqlite3SchemaMutexHeld(pParse->db, iDb, 0) );
  100518. if( DbMaskTest(pToplevel->cookieMask, iDb)==0 ){
  100519. DbMaskSet(pToplevel->cookieMask, iDb);
  100520. if( !OMIT_TEMPDB && iDb==1 ){
  100521. sqlite3OpenTempDatabase(pToplevel);
  100522. }
  100523. }
  100524. }
  100525. /*
  100526. ** If argument zDb is NULL, then call sqlite3CodeVerifySchema() for each
  100527. ** attached database. Otherwise, invoke it for the database named zDb only.
  100528. */
  100529. SQLITE_PRIVATE void sqlite3CodeVerifyNamedSchema(Parse *pParse, const char *zDb){
  100530. sqlite3 *db = pParse->db;
  100531. int i;
  100532. for(i=0; i<db->nDb; i++){
  100533. Db *pDb = &db->aDb[i];
  100534. if( pDb->pBt && (!zDb || 0==sqlite3StrICmp(zDb, pDb->zDbSName)) ){
  100535. sqlite3CodeVerifySchema(pParse, i);
  100536. }
  100537. }
  100538. }
  100539. /*
  100540. ** Generate VDBE code that prepares for doing an operation that
  100541. ** might change the database.
  100542. **
  100543. ** This routine starts a new transaction if we are not already within
  100544. ** a transaction. If we are already within a transaction, then a checkpoint
  100545. ** is set if the setStatement parameter is true. A checkpoint should
  100546. ** be set for operations that might fail (due to a constraint) part of
  100547. ** the way through and which will need to undo some writes without having to
  100548. ** rollback the whole transaction. For operations where all constraints
  100549. ** can be checked before any changes are made to the database, it is never
  100550. ** necessary to undo a write and the checkpoint should not be set.
  100551. */
  100552. SQLITE_PRIVATE void sqlite3BeginWriteOperation(Parse *pParse, int setStatement, int iDb){
  100553. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  100554. sqlite3CodeVerifySchema(pParse, iDb);
  100555. DbMaskSet(pToplevel->writeMask, iDb);
  100556. pToplevel->isMultiWrite |= setStatement;
  100557. }
  100558. /*
  100559. ** Indicate that the statement currently under construction might write
  100560. ** more than one entry (example: deleting one row then inserting another,
  100561. ** inserting multiple rows in a table, or inserting a row and index entries.)
  100562. ** If an abort occurs after some of these writes have completed, then it will
  100563. ** be necessary to undo the completed writes.
  100564. */
  100565. SQLITE_PRIVATE void sqlite3MultiWrite(Parse *pParse){
  100566. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  100567. pToplevel->isMultiWrite = 1;
  100568. }
  100569. /*
  100570. ** The code generator calls this routine if is discovers that it is
  100571. ** possible to abort a statement prior to completion. In order to
  100572. ** perform this abort without corrupting the database, we need to make
  100573. ** sure that the statement is protected by a statement transaction.
  100574. **
  100575. ** Technically, we only need to set the mayAbort flag if the
  100576. ** isMultiWrite flag was previously set. There is a time dependency
  100577. ** such that the abort must occur after the multiwrite. This makes
  100578. ** some statements involving the REPLACE conflict resolution algorithm
  100579. ** go a little faster. But taking advantage of this time dependency
  100580. ** makes it more difficult to prove that the code is correct (in
  100581. ** particular, it prevents us from writing an effective
  100582. ** implementation of sqlite3AssertMayAbort()) and so we have chosen
  100583. ** to take the safe route and skip the optimization.
  100584. */
  100585. SQLITE_PRIVATE void sqlite3MayAbort(Parse *pParse){
  100586. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  100587. pToplevel->mayAbort = 1;
  100588. }
  100589. /*
  100590. ** Code an OP_Halt that causes the vdbe to return an SQLITE_CONSTRAINT
  100591. ** error. The onError parameter determines which (if any) of the statement
  100592. ** and/or current transaction is rolled back.
  100593. */
  100594. SQLITE_PRIVATE void sqlite3HaltConstraint(
  100595. Parse *pParse, /* Parsing context */
  100596. int errCode, /* extended error code */
  100597. int onError, /* Constraint type */
  100598. char *p4, /* Error message */
  100599. i8 p4type, /* P4_STATIC or P4_TRANSIENT */
  100600. u8 p5Errmsg /* P5_ErrMsg type */
  100601. ){
  100602. Vdbe *v = sqlite3GetVdbe(pParse);
  100603. assert( (errCode&0xff)==SQLITE_CONSTRAINT );
  100604. if( onError==OE_Abort ){
  100605. sqlite3MayAbort(pParse);
  100606. }
  100607. sqlite3VdbeAddOp4(v, OP_Halt, errCode, onError, 0, p4, p4type);
  100608. sqlite3VdbeChangeP5(v, p5Errmsg);
  100609. }
  100610. /*
  100611. ** Code an OP_Halt due to UNIQUE or PRIMARY KEY constraint violation.
  100612. */
  100613. SQLITE_PRIVATE void sqlite3UniqueConstraint(
  100614. Parse *pParse, /* Parsing context */
  100615. int onError, /* Constraint type */
  100616. Index *pIdx /* The index that triggers the constraint */
  100617. ){
  100618. char *zErr;
  100619. int j;
  100620. StrAccum errMsg;
  100621. Table *pTab = pIdx->pTable;
  100622. sqlite3StrAccumInit(&errMsg, pParse->db, 0, 0, 200);
  100623. if( pIdx->aColExpr ){
  100624. sqlite3XPrintf(&errMsg, "index '%q'", pIdx->zName);
  100625. }else{
  100626. for(j=0; j<pIdx->nKeyCol; j++){
  100627. char *zCol;
  100628. assert( pIdx->aiColumn[j]>=0 );
  100629. zCol = pTab->aCol[pIdx->aiColumn[j]].zName;
  100630. if( j ) sqlite3StrAccumAppend(&errMsg, ", ", 2);
  100631. sqlite3StrAccumAppendAll(&errMsg, pTab->zName);
  100632. sqlite3StrAccumAppend(&errMsg, ".", 1);
  100633. sqlite3StrAccumAppendAll(&errMsg, zCol);
  100634. }
  100635. }
  100636. zErr = sqlite3StrAccumFinish(&errMsg);
  100637. sqlite3HaltConstraint(pParse,
  100638. IsPrimaryKeyIndex(pIdx) ? SQLITE_CONSTRAINT_PRIMARYKEY
  100639. : SQLITE_CONSTRAINT_UNIQUE,
  100640. onError, zErr, P4_DYNAMIC, P5_ConstraintUnique);
  100641. }
  100642. /*
  100643. ** Code an OP_Halt due to non-unique rowid.
  100644. */
  100645. SQLITE_PRIVATE void sqlite3RowidConstraint(
  100646. Parse *pParse, /* Parsing context */
  100647. int onError, /* Conflict resolution algorithm */
  100648. Table *pTab /* The table with the non-unique rowid */
  100649. ){
  100650. char *zMsg;
  100651. int rc;
  100652. if( pTab->iPKey>=0 ){
  100653. zMsg = sqlite3MPrintf(pParse->db, "%s.%s", pTab->zName,
  100654. pTab->aCol[pTab->iPKey].zName);
  100655. rc = SQLITE_CONSTRAINT_PRIMARYKEY;
  100656. }else{
  100657. zMsg = sqlite3MPrintf(pParse->db, "%s.rowid", pTab->zName);
  100658. rc = SQLITE_CONSTRAINT_ROWID;
  100659. }
  100660. sqlite3HaltConstraint(pParse, rc, onError, zMsg, P4_DYNAMIC,
  100661. P5_ConstraintUnique);
  100662. }
  100663. /*
  100664. ** Check to see if pIndex uses the collating sequence pColl. Return
  100665. ** true if it does and false if it does not.
  100666. */
  100667. #ifndef SQLITE_OMIT_REINDEX
  100668. static int collationMatch(const char *zColl, Index *pIndex){
  100669. int i;
  100670. assert( zColl!=0 );
  100671. for(i=0; i<pIndex->nColumn; i++){
  100672. const char *z = pIndex->azColl[i];
  100673. assert( z!=0 || pIndex->aiColumn[i]<0 );
  100674. if( pIndex->aiColumn[i]>=0 && 0==sqlite3StrICmp(z, zColl) ){
  100675. return 1;
  100676. }
  100677. }
  100678. return 0;
  100679. }
  100680. #endif
  100681. /*
  100682. ** Recompute all indices of pTab that use the collating sequence pColl.
  100683. ** If pColl==0 then recompute all indices of pTab.
  100684. */
  100685. #ifndef SQLITE_OMIT_REINDEX
  100686. static void reindexTable(Parse *pParse, Table *pTab, char const *zColl){
  100687. Index *pIndex; /* An index associated with pTab */
  100688. for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
  100689. if( zColl==0 || collationMatch(zColl, pIndex) ){
  100690. int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  100691. sqlite3BeginWriteOperation(pParse, 0, iDb);
  100692. sqlite3RefillIndex(pParse, pIndex, -1);
  100693. }
  100694. }
  100695. }
  100696. #endif
  100697. /*
  100698. ** Recompute all indices of all tables in all databases where the
  100699. ** indices use the collating sequence pColl. If pColl==0 then recompute
  100700. ** all indices everywhere.
  100701. */
  100702. #ifndef SQLITE_OMIT_REINDEX
  100703. static void reindexDatabases(Parse *pParse, char const *zColl){
  100704. Db *pDb; /* A single database */
  100705. int iDb; /* The database index number */
  100706. sqlite3 *db = pParse->db; /* The database connection */
  100707. HashElem *k; /* For looping over tables in pDb */
  100708. Table *pTab; /* A table in the database */
  100709. assert( sqlite3BtreeHoldsAllMutexes(db) ); /* Needed for schema access */
  100710. for(iDb=0, pDb=db->aDb; iDb<db->nDb; iDb++, pDb++){
  100711. assert( pDb!=0 );
  100712. for(k=sqliteHashFirst(&pDb->pSchema->tblHash); k; k=sqliteHashNext(k)){
  100713. pTab = (Table*)sqliteHashData(k);
  100714. reindexTable(pParse, pTab, zColl);
  100715. }
  100716. }
  100717. }
  100718. #endif
  100719. /*
  100720. ** Generate code for the REINDEX command.
  100721. **
  100722. ** REINDEX -- 1
  100723. ** REINDEX <collation> -- 2
  100724. ** REINDEX ?<database>.?<tablename> -- 3
  100725. ** REINDEX ?<database>.?<indexname> -- 4
  100726. **
  100727. ** Form 1 causes all indices in all attached databases to be rebuilt.
  100728. ** Form 2 rebuilds all indices in all databases that use the named
  100729. ** collating function. Forms 3 and 4 rebuild the named index or all
  100730. ** indices associated with the named table.
  100731. */
  100732. #ifndef SQLITE_OMIT_REINDEX
  100733. SQLITE_PRIVATE void sqlite3Reindex(Parse *pParse, Token *pName1, Token *pName2){
  100734. CollSeq *pColl; /* Collating sequence to be reindexed, or NULL */
  100735. char *z; /* Name of a table or index */
  100736. const char *zDb; /* Name of the database */
  100737. Table *pTab; /* A table in the database */
  100738. Index *pIndex; /* An index associated with pTab */
  100739. int iDb; /* The database index number */
  100740. sqlite3 *db = pParse->db; /* The database connection */
  100741. Token *pObjName; /* Name of the table or index to be reindexed */
  100742. /* Read the database schema. If an error occurs, leave an error message
  100743. ** and code in pParse and return NULL. */
  100744. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  100745. return;
  100746. }
  100747. if( pName1==0 ){
  100748. reindexDatabases(pParse, 0);
  100749. return;
  100750. }else if( NEVER(pName2==0) || pName2->z==0 ){
  100751. char *zColl;
  100752. assert( pName1->z );
  100753. zColl = sqlite3NameFromToken(pParse->db, pName1);
  100754. if( !zColl ) return;
  100755. pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
  100756. if( pColl ){
  100757. reindexDatabases(pParse, zColl);
  100758. sqlite3DbFree(db, zColl);
  100759. return;
  100760. }
  100761. sqlite3DbFree(db, zColl);
  100762. }
  100763. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pObjName);
  100764. if( iDb<0 ) return;
  100765. z = sqlite3NameFromToken(db, pObjName);
  100766. if( z==0 ) return;
  100767. zDb = db->aDb[iDb].zDbSName;
  100768. pTab = sqlite3FindTable(db, z, zDb);
  100769. if( pTab ){
  100770. reindexTable(pParse, pTab, 0);
  100771. sqlite3DbFree(db, z);
  100772. return;
  100773. }
  100774. pIndex = sqlite3FindIndex(db, z, zDb);
  100775. sqlite3DbFree(db, z);
  100776. if( pIndex ){
  100777. sqlite3BeginWriteOperation(pParse, 0, iDb);
  100778. sqlite3RefillIndex(pParse, pIndex, -1);
  100779. return;
  100780. }
  100781. sqlite3ErrorMsg(pParse, "unable to identify the object to be reindexed");
  100782. }
  100783. #endif
  100784. /*
  100785. ** Return a KeyInfo structure that is appropriate for the given Index.
  100786. **
  100787. ** The caller should invoke sqlite3KeyInfoUnref() on the returned object
  100788. ** when it has finished using it.
  100789. */
  100790. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoOfIndex(Parse *pParse, Index *pIdx){
  100791. int i;
  100792. int nCol = pIdx->nColumn;
  100793. int nKey = pIdx->nKeyCol;
  100794. KeyInfo *pKey;
  100795. if( pParse->nErr ) return 0;
  100796. if( pIdx->uniqNotNull ){
  100797. pKey = sqlite3KeyInfoAlloc(pParse->db, nKey, nCol-nKey);
  100798. }else{
  100799. pKey = sqlite3KeyInfoAlloc(pParse->db, nCol, 0);
  100800. }
  100801. if( pKey ){
  100802. assert( sqlite3KeyInfoIsWriteable(pKey) );
  100803. for(i=0; i<nCol; i++){
  100804. const char *zColl = pIdx->azColl[i];
  100805. pKey->aColl[i] = zColl==sqlite3StrBINARY ? 0 :
  100806. sqlite3LocateCollSeq(pParse, zColl);
  100807. pKey->aSortOrder[i] = pIdx->aSortOrder[i];
  100808. }
  100809. if( pParse->nErr ){
  100810. assert( pParse->rc==SQLITE_ERROR_MISSING_COLLSEQ );
  100811. if( pIdx->bNoQuery==0 ){
  100812. /* Deactivate the index because it contains an unknown collating
  100813. ** sequence. The only way to reactive the index is to reload the
  100814. ** schema. Adding the missing collating sequence later does not
  100815. ** reactive the index. The application had the chance to register
  100816. ** the missing index using the collation-needed callback. For
  100817. ** simplicity, SQLite will not give the application a second chance.
  100818. */
  100819. pIdx->bNoQuery = 1;
  100820. pParse->rc = SQLITE_ERROR_RETRY;
  100821. }
  100822. sqlite3KeyInfoUnref(pKey);
  100823. pKey = 0;
  100824. }
  100825. }
  100826. return pKey;
  100827. }
  100828. #ifndef SQLITE_OMIT_CTE
  100829. /*
  100830. ** This routine is invoked once per CTE by the parser while parsing a
  100831. ** WITH clause.
  100832. */
  100833. SQLITE_PRIVATE With *sqlite3WithAdd(
  100834. Parse *pParse, /* Parsing context */
  100835. With *pWith, /* Existing WITH clause, or NULL */
  100836. Token *pName, /* Name of the common-table */
  100837. ExprList *pArglist, /* Optional column name list for the table */
  100838. Select *pQuery /* Query used to initialize the table */
  100839. ){
  100840. sqlite3 *db = pParse->db;
  100841. With *pNew;
  100842. char *zName;
  100843. /* Check that the CTE name is unique within this WITH clause. If
  100844. ** not, store an error in the Parse structure. */
  100845. zName = sqlite3NameFromToken(pParse->db, pName);
  100846. if( zName && pWith ){
  100847. int i;
  100848. for(i=0; i<pWith->nCte; i++){
  100849. if( sqlite3StrICmp(zName, pWith->a[i].zName)==0 ){
  100850. sqlite3ErrorMsg(pParse, "duplicate WITH table name: %s", zName);
  100851. }
  100852. }
  100853. }
  100854. if( pWith ){
  100855. int nByte = sizeof(*pWith) + (sizeof(pWith->a[1]) * pWith->nCte);
  100856. pNew = sqlite3DbRealloc(db, pWith, nByte);
  100857. }else{
  100858. pNew = sqlite3DbMallocZero(db, sizeof(*pWith));
  100859. }
  100860. assert( (pNew!=0 && zName!=0) || db->mallocFailed );
  100861. if( db->mallocFailed ){
  100862. sqlite3ExprListDelete(db, pArglist);
  100863. sqlite3SelectDelete(db, pQuery);
  100864. sqlite3DbFree(db, zName);
  100865. pNew = pWith;
  100866. }else{
  100867. pNew->a[pNew->nCte].pSelect = pQuery;
  100868. pNew->a[pNew->nCte].pCols = pArglist;
  100869. pNew->a[pNew->nCte].zName = zName;
  100870. pNew->a[pNew->nCte].zCteErr = 0;
  100871. pNew->nCte++;
  100872. }
  100873. return pNew;
  100874. }
  100875. /*
  100876. ** Free the contents of the With object passed as the second argument.
  100877. */
  100878. SQLITE_PRIVATE void sqlite3WithDelete(sqlite3 *db, With *pWith){
  100879. if( pWith ){
  100880. int i;
  100881. for(i=0; i<pWith->nCte; i++){
  100882. struct Cte *pCte = &pWith->a[i];
  100883. sqlite3ExprListDelete(db, pCte->pCols);
  100884. sqlite3SelectDelete(db, pCte->pSelect);
  100885. sqlite3DbFree(db, pCte->zName);
  100886. }
  100887. sqlite3DbFree(db, pWith);
  100888. }
  100889. }
  100890. #endif /* !defined(SQLITE_OMIT_CTE) */
  100891. /************** End of build.c ***********************************************/
  100892. /************** Begin file callback.c ****************************************/
  100893. /*
  100894. ** 2005 May 23
  100895. **
  100896. ** The author disclaims copyright to this source code. In place of
  100897. ** a legal notice, here is a blessing:
  100898. **
  100899. ** May you do good and not evil.
  100900. ** May you find forgiveness for yourself and forgive others.
  100901. ** May you share freely, never taking more than you give.
  100902. **
  100903. *************************************************************************
  100904. **
  100905. ** This file contains functions used to access the internal hash tables
  100906. ** of user defined functions and collation sequences.
  100907. */
  100908. /* #include "sqliteInt.h" */
  100909. /*
  100910. ** Invoke the 'collation needed' callback to request a collation sequence
  100911. ** in the encoding enc of name zName, length nName.
  100912. */
  100913. static void callCollNeeded(sqlite3 *db, int enc, const char *zName){
  100914. assert( !db->xCollNeeded || !db->xCollNeeded16 );
  100915. if( db->xCollNeeded ){
  100916. char *zExternal = sqlite3DbStrDup(db, zName);
  100917. if( !zExternal ) return;
  100918. db->xCollNeeded(db->pCollNeededArg, db, enc, zExternal);
  100919. sqlite3DbFree(db, zExternal);
  100920. }
  100921. #ifndef SQLITE_OMIT_UTF16
  100922. if( db->xCollNeeded16 ){
  100923. char const *zExternal;
  100924. sqlite3_value *pTmp = sqlite3ValueNew(db);
  100925. sqlite3ValueSetStr(pTmp, -1, zName, SQLITE_UTF8, SQLITE_STATIC);
  100926. zExternal = sqlite3ValueText(pTmp, SQLITE_UTF16NATIVE);
  100927. if( zExternal ){
  100928. db->xCollNeeded16(db->pCollNeededArg, db, (int)ENC(db), zExternal);
  100929. }
  100930. sqlite3ValueFree(pTmp);
  100931. }
  100932. #endif
  100933. }
  100934. /*
  100935. ** This routine is called if the collation factory fails to deliver a
  100936. ** collation function in the best encoding but there may be other versions
  100937. ** of this collation function (for other text encodings) available. Use one
  100938. ** of these instead if they exist. Avoid a UTF-8 <-> UTF-16 conversion if
  100939. ** possible.
  100940. */
  100941. static int synthCollSeq(sqlite3 *db, CollSeq *pColl){
  100942. CollSeq *pColl2;
  100943. char *z = pColl->zName;
  100944. int i;
  100945. static const u8 aEnc[] = { SQLITE_UTF16BE, SQLITE_UTF16LE, SQLITE_UTF8 };
  100946. for(i=0; i<3; i++){
  100947. pColl2 = sqlite3FindCollSeq(db, aEnc[i], z, 0);
  100948. if( pColl2->xCmp!=0 ){
  100949. memcpy(pColl, pColl2, sizeof(CollSeq));
  100950. pColl->xDel = 0; /* Do not copy the destructor */
  100951. return SQLITE_OK;
  100952. }
  100953. }
  100954. return SQLITE_ERROR;
  100955. }
  100956. /*
  100957. ** This function is responsible for invoking the collation factory callback
  100958. ** or substituting a collation sequence of a different encoding when the
  100959. ** requested collation sequence is not available in the desired encoding.
  100960. **
  100961. ** If it is not NULL, then pColl must point to the database native encoding
  100962. ** collation sequence with name zName, length nName.
  100963. **
  100964. ** The return value is either the collation sequence to be used in database
  100965. ** db for collation type name zName, length nName, or NULL, if no collation
  100966. ** sequence can be found. If no collation is found, leave an error message.
  100967. **
  100968. ** See also: sqlite3LocateCollSeq(), sqlite3FindCollSeq()
  100969. */
  100970. SQLITE_PRIVATE CollSeq *sqlite3GetCollSeq(
  100971. Parse *pParse, /* Parsing context */
  100972. u8 enc, /* The desired encoding for the collating sequence */
  100973. CollSeq *pColl, /* Collating sequence with native encoding, or NULL */
  100974. const char *zName /* Collating sequence name */
  100975. ){
  100976. CollSeq *p;
  100977. sqlite3 *db = pParse->db;
  100978. p = pColl;
  100979. if( !p ){
  100980. p = sqlite3FindCollSeq(db, enc, zName, 0);
  100981. }
  100982. if( !p || !p->xCmp ){
  100983. /* No collation sequence of this type for this encoding is registered.
  100984. ** Call the collation factory to see if it can supply us with one.
  100985. */
  100986. callCollNeeded(db, enc, zName);
  100987. p = sqlite3FindCollSeq(db, enc, zName, 0);
  100988. }
  100989. if( p && !p->xCmp && synthCollSeq(db, p) ){
  100990. p = 0;
  100991. }
  100992. assert( !p || p->xCmp );
  100993. if( p==0 ){
  100994. sqlite3ErrorMsg(pParse, "no such collation sequence: %s", zName);
  100995. pParse->rc = SQLITE_ERROR_MISSING_COLLSEQ;
  100996. }
  100997. return p;
  100998. }
  100999. /*
  101000. ** This routine is called on a collation sequence before it is used to
  101001. ** check that it is defined. An undefined collation sequence exists when
  101002. ** a database is loaded that contains references to collation sequences
  101003. ** that have not been defined by sqlite3_create_collation() etc.
  101004. **
  101005. ** If required, this routine calls the 'collation needed' callback to
  101006. ** request a definition of the collating sequence. If this doesn't work,
  101007. ** an equivalent collating sequence that uses a text encoding different
  101008. ** from the main database is substituted, if one is available.
  101009. */
  101010. SQLITE_PRIVATE int sqlite3CheckCollSeq(Parse *pParse, CollSeq *pColl){
  101011. if( pColl && pColl->xCmp==0 ){
  101012. const char *zName = pColl->zName;
  101013. sqlite3 *db = pParse->db;
  101014. CollSeq *p = sqlite3GetCollSeq(pParse, ENC(db), pColl, zName);
  101015. if( !p ){
  101016. return SQLITE_ERROR;
  101017. }
  101018. assert( p==pColl );
  101019. }
  101020. return SQLITE_OK;
  101021. }
  101022. /*
  101023. ** Locate and return an entry from the db.aCollSeq hash table. If the entry
  101024. ** specified by zName and nName is not found and parameter 'create' is
  101025. ** true, then create a new entry. Otherwise return NULL.
  101026. **
  101027. ** Each pointer stored in the sqlite3.aCollSeq hash table contains an
  101028. ** array of three CollSeq structures. The first is the collation sequence
  101029. ** preferred for UTF-8, the second UTF-16le, and the third UTF-16be.
  101030. **
  101031. ** Stored immediately after the three collation sequences is a copy of
  101032. ** the collation sequence name. A pointer to this string is stored in
  101033. ** each collation sequence structure.
  101034. */
  101035. static CollSeq *findCollSeqEntry(
  101036. sqlite3 *db, /* Database connection */
  101037. const char *zName, /* Name of the collating sequence */
  101038. int create /* Create a new entry if true */
  101039. ){
  101040. CollSeq *pColl;
  101041. pColl = sqlite3HashFind(&db->aCollSeq, zName);
  101042. if( 0==pColl && create ){
  101043. int nName = sqlite3Strlen30(zName) + 1;
  101044. pColl = sqlite3DbMallocZero(db, 3*sizeof(*pColl) + nName);
  101045. if( pColl ){
  101046. CollSeq *pDel = 0;
  101047. pColl[0].zName = (char*)&pColl[3];
  101048. pColl[0].enc = SQLITE_UTF8;
  101049. pColl[1].zName = (char*)&pColl[3];
  101050. pColl[1].enc = SQLITE_UTF16LE;
  101051. pColl[2].zName = (char*)&pColl[3];
  101052. pColl[2].enc = SQLITE_UTF16BE;
  101053. memcpy(pColl[0].zName, zName, nName);
  101054. pDel = sqlite3HashInsert(&db->aCollSeq, pColl[0].zName, pColl);
  101055. /* If a malloc() failure occurred in sqlite3HashInsert(), it will
  101056. ** return the pColl pointer to be deleted (because it wasn't added
  101057. ** to the hash table).
  101058. */
  101059. assert( pDel==0 || pDel==pColl );
  101060. if( pDel!=0 ){
  101061. sqlite3OomFault(db);
  101062. sqlite3DbFree(db, pDel);
  101063. pColl = 0;
  101064. }
  101065. }
  101066. }
  101067. return pColl;
  101068. }
  101069. /*
  101070. ** Parameter zName points to a UTF-8 encoded string nName bytes long.
  101071. ** Return the CollSeq* pointer for the collation sequence named zName
  101072. ** for the encoding 'enc' from the database 'db'.
  101073. **
  101074. ** If the entry specified is not found and 'create' is true, then create a
  101075. ** new entry. Otherwise return NULL.
  101076. **
  101077. ** A separate function sqlite3LocateCollSeq() is a wrapper around
  101078. ** this routine. sqlite3LocateCollSeq() invokes the collation factory
  101079. ** if necessary and generates an error message if the collating sequence
  101080. ** cannot be found.
  101081. **
  101082. ** See also: sqlite3LocateCollSeq(), sqlite3GetCollSeq()
  101083. */
  101084. SQLITE_PRIVATE CollSeq *sqlite3FindCollSeq(
  101085. sqlite3 *db,
  101086. u8 enc,
  101087. const char *zName,
  101088. int create
  101089. ){
  101090. CollSeq *pColl;
  101091. if( zName ){
  101092. pColl = findCollSeqEntry(db, zName, create);
  101093. }else{
  101094. pColl = db->pDfltColl;
  101095. }
  101096. assert( SQLITE_UTF8==1 && SQLITE_UTF16LE==2 && SQLITE_UTF16BE==3 );
  101097. assert( enc>=SQLITE_UTF8 && enc<=SQLITE_UTF16BE );
  101098. if( pColl ) pColl += enc-1;
  101099. return pColl;
  101100. }
  101101. /* During the search for the best function definition, this procedure
  101102. ** is called to test how well the function passed as the first argument
  101103. ** matches the request for a function with nArg arguments in a system
  101104. ** that uses encoding enc. The value returned indicates how well the
  101105. ** request is matched. A higher value indicates a better match.
  101106. **
  101107. ** If nArg is -1 that means to only return a match (non-zero) if p->nArg
  101108. ** is also -1. In other words, we are searching for a function that
  101109. ** takes a variable number of arguments.
  101110. **
  101111. ** If nArg is -2 that means that we are searching for any function
  101112. ** regardless of the number of arguments it uses, so return a positive
  101113. ** match score for any
  101114. **
  101115. ** The returned value is always between 0 and 6, as follows:
  101116. **
  101117. ** 0: Not a match.
  101118. ** 1: UTF8/16 conversion required and function takes any number of arguments.
  101119. ** 2: UTF16 byte order change required and function takes any number of args.
  101120. ** 3: encoding matches and function takes any number of arguments
  101121. ** 4: UTF8/16 conversion required - argument count matches exactly
  101122. ** 5: UTF16 byte order conversion required - argument count matches exactly
  101123. ** 6: Perfect match: encoding and argument count match exactly.
  101124. **
  101125. ** If nArg==(-2) then any function with a non-null xSFunc is
  101126. ** a perfect match and any function with xSFunc NULL is
  101127. ** a non-match.
  101128. */
  101129. #define FUNC_PERFECT_MATCH 6 /* The score for a perfect match */
  101130. static int matchQuality(
  101131. FuncDef *p, /* The function we are evaluating for match quality */
  101132. int nArg, /* Desired number of arguments. (-1)==any */
  101133. u8 enc /* Desired text encoding */
  101134. ){
  101135. int match;
  101136. /* nArg of -2 is a special case */
  101137. if( nArg==(-2) ) return (p->xSFunc==0) ? 0 : FUNC_PERFECT_MATCH;
  101138. /* Wrong number of arguments means "no match" */
  101139. if( p->nArg!=nArg && p->nArg>=0 ) return 0;
  101140. /* Give a better score to a function with a specific number of arguments
  101141. ** than to function that accepts any number of arguments. */
  101142. if( p->nArg==nArg ){
  101143. match = 4;
  101144. }else{
  101145. match = 1;
  101146. }
  101147. /* Bonus points if the text encoding matches */
  101148. if( enc==(p->funcFlags & SQLITE_FUNC_ENCMASK) ){
  101149. match += 2; /* Exact encoding match */
  101150. }else if( (enc & p->funcFlags & 2)!=0 ){
  101151. match += 1; /* Both are UTF16, but with different byte orders */
  101152. }
  101153. return match;
  101154. }
  101155. /*
  101156. ** Search a FuncDefHash for a function with the given name. Return
  101157. ** a pointer to the matching FuncDef if found, or 0 if there is no match.
  101158. */
  101159. static FuncDef *functionSearch(
  101160. int h, /* Hash of the name */
  101161. const char *zFunc /* Name of function */
  101162. ){
  101163. FuncDef *p;
  101164. for(p=sqlite3BuiltinFunctions.a[h]; p; p=p->u.pHash){
  101165. if( sqlite3StrICmp(p->zName, zFunc)==0 ){
  101166. return p;
  101167. }
  101168. }
  101169. return 0;
  101170. }
  101171. /*
  101172. ** Insert a new FuncDef into a FuncDefHash hash table.
  101173. */
  101174. SQLITE_PRIVATE void sqlite3InsertBuiltinFuncs(
  101175. FuncDef *aDef, /* List of global functions to be inserted */
  101176. int nDef /* Length of the apDef[] list */
  101177. ){
  101178. int i;
  101179. for(i=0; i<nDef; i++){
  101180. FuncDef *pOther;
  101181. const char *zName = aDef[i].zName;
  101182. int nName = sqlite3Strlen30(zName);
  101183. int h = (zName[0] + nName) % SQLITE_FUNC_HASH_SZ;
  101184. assert( zName[0]>='a' && zName[0]<='z' );
  101185. pOther = functionSearch(h, zName);
  101186. if( pOther ){
  101187. assert( pOther!=&aDef[i] && pOther->pNext!=&aDef[i] );
  101188. aDef[i].pNext = pOther->pNext;
  101189. pOther->pNext = &aDef[i];
  101190. }else{
  101191. aDef[i].pNext = 0;
  101192. aDef[i].u.pHash = sqlite3BuiltinFunctions.a[h];
  101193. sqlite3BuiltinFunctions.a[h] = &aDef[i];
  101194. }
  101195. }
  101196. }
  101197. /*
  101198. ** Locate a user function given a name, a number of arguments and a flag
  101199. ** indicating whether the function prefers UTF-16 over UTF-8. Return a
  101200. ** pointer to the FuncDef structure that defines that function, or return
  101201. ** NULL if the function does not exist.
  101202. **
  101203. ** If the createFlag argument is true, then a new (blank) FuncDef
  101204. ** structure is created and liked into the "db" structure if a
  101205. ** no matching function previously existed.
  101206. **
  101207. ** If nArg is -2, then the first valid function found is returned. A
  101208. ** function is valid if xSFunc is non-zero. The nArg==(-2)
  101209. ** case is used to see if zName is a valid function name for some number
  101210. ** of arguments. If nArg is -2, then createFlag must be 0.
  101211. **
  101212. ** If createFlag is false, then a function with the required name and
  101213. ** number of arguments may be returned even if the eTextRep flag does not
  101214. ** match that requested.
  101215. */
  101216. SQLITE_PRIVATE FuncDef *sqlite3FindFunction(
  101217. sqlite3 *db, /* An open database */
  101218. const char *zName, /* Name of the function. zero-terminated */
  101219. int nArg, /* Number of arguments. -1 means any number */
  101220. u8 enc, /* Preferred text encoding */
  101221. u8 createFlag /* Create new entry if true and does not otherwise exist */
  101222. ){
  101223. FuncDef *p; /* Iterator variable */
  101224. FuncDef *pBest = 0; /* Best match found so far */
  101225. int bestScore = 0; /* Score of best match */
  101226. int h; /* Hash value */
  101227. int nName; /* Length of the name */
  101228. assert( nArg>=(-2) );
  101229. assert( nArg>=(-1) || createFlag==0 );
  101230. nName = sqlite3Strlen30(zName);
  101231. /* First search for a match amongst the application-defined functions.
  101232. */
  101233. p = (FuncDef*)sqlite3HashFind(&db->aFunc, zName);
  101234. while( p ){
  101235. int score = matchQuality(p, nArg, enc);
  101236. if( score>bestScore ){
  101237. pBest = p;
  101238. bestScore = score;
  101239. }
  101240. p = p->pNext;
  101241. }
  101242. /* If no match is found, search the built-in functions.
  101243. **
  101244. ** If the DBFLAG_PreferBuiltin flag is set, then search the built-in
  101245. ** functions even if a prior app-defined function was found. And give
  101246. ** priority to built-in functions.
  101247. **
  101248. ** Except, if createFlag is true, that means that we are trying to
  101249. ** install a new function. Whatever FuncDef structure is returned it will
  101250. ** have fields overwritten with new information appropriate for the
  101251. ** new function. But the FuncDefs for built-in functions are read-only.
  101252. ** So we must not search for built-ins when creating a new function.
  101253. */
  101254. if( !createFlag && (pBest==0 || (db->mDbFlags & DBFLAG_PreferBuiltin)!=0) ){
  101255. bestScore = 0;
  101256. h = (sqlite3UpperToLower[(u8)zName[0]] + nName) % SQLITE_FUNC_HASH_SZ;
  101257. p = functionSearch(h, zName);
  101258. while( p ){
  101259. int score = matchQuality(p, nArg, enc);
  101260. if( score>bestScore ){
  101261. pBest = p;
  101262. bestScore = score;
  101263. }
  101264. p = p->pNext;
  101265. }
  101266. }
  101267. /* If the createFlag parameter is true and the search did not reveal an
  101268. ** exact match for the name, number of arguments and encoding, then add a
  101269. ** new entry to the hash table and return it.
  101270. */
  101271. if( createFlag && bestScore<FUNC_PERFECT_MATCH &&
  101272. (pBest = sqlite3DbMallocZero(db, sizeof(*pBest)+nName+1))!=0 ){
  101273. FuncDef *pOther;
  101274. pBest->zName = (const char*)&pBest[1];
  101275. pBest->nArg = (u16)nArg;
  101276. pBest->funcFlags = enc;
  101277. memcpy((char*)&pBest[1], zName, nName+1);
  101278. pOther = (FuncDef*)sqlite3HashInsert(&db->aFunc, pBest->zName, pBest);
  101279. if( pOther==pBest ){
  101280. sqlite3DbFree(db, pBest);
  101281. sqlite3OomFault(db);
  101282. return 0;
  101283. }else{
  101284. pBest->pNext = pOther;
  101285. }
  101286. }
  101287. if( pBest && (pBest->xSFunc || createFlag) ){
  101288. return pBest;
  101289. }
  101290. return 0;
  101291. }
  101292. /*
  101293. ** Free all resources held by the schema structure. The void* argument points
  101294. ** at a Schema struct. This function does not call sqlite3DbFree(db, ) on the
  101295. ** pointer itself, it just cleans up subsidiary resources (i.e. the contents
  101296. ** of the schema hash tables).
  101297. **
  101298. ** The Schema.cache_size variable is not cleared.
  101299. */
  101300. SQLITE_PRIVATE void sqlite3SchemaClear(void *p){
  101301. Hash temp1;
  101302. Hash temp2;
  101303. HashElem *pElem;
  101304. Schema *pSchema = (Schema *)p;
  101305. temp1 = pSchema->tblHash;
  101306. temp2 = pSchema->trigHash;
  101307. sqlite3HashInit(&pSchema->trigHash);
  101308. sqlite3HashClear(&pSchema->idxHash);
  101309. for(pElem=sqliteHashFirst(&temp2); pElem; pElem=sqliteHashNext(pElem)){
  101310. sqlite3DeleteTrigger(0, (Trigger*)sqliteHashData(pElem));
  101311. }
  101312. sqlite3HashClear(&temp2);
  101313. sqlite3HashInit(&pSchema->tblHash);
  101314. for(pElem=sqliteHashFirst(&temp1); pElem; pElem=sqliteHashNext(pElem)){
  101315. Table *pTab = sqliteHashData(pElem);
  101316. sqlite3DeleteTable(0, pTab);
  101317. }
  101318. sqlite3HashClear(&temp1);
  101319. sqlite3HashClear(&pSchema->fkeyHash);
  101320. pSchema->pSeqTab = 0;
  101321. if( pSchema->schemaFlags & DB_SchemaLoaded ){
  101322. pSchema->iGeneration++;
  101323. }
  101324. pSchema->schemaFlags &= ~(DB_SchemaLoaded|DB_ResetWanted);
  101325. }
  101326. /*
  101327. ** Find and return the schema associated with a BTree. Create
  101328. ** a new one if necessary.
  101329. */
  101330. SQLITE_PRIVATE Schema *sqlite3SchemaGet(sqlite3 *db, Btree *pBt){
  101331. Schema * p;
  101332. if( pBt ){
  101333. p = (Schema *)sqlite3BtreeSchema(pBt, sizeof(Schema), sqlite3SchemaClear);
  101334. }else{
  101335. p = (Schema *)sqlite3DbMallocZero(0, sizeof(Schema));
  101336. }
  101337. if( !p ){
  101338. sqlite3OomFault(db);
  101339. }else if ( 0==p->file_format ){
  101340. sqlite3HashInit(&p->tblHash);
  101341. sqlite3HashInit(&p->idxHash);
  101342. sqlite3HashInit(&p->trigHash);
  101343. sqlite3HashInit(&p->fkeyHash);
  101344. p->enc = SQLITE_UTF8;
  101345. }
  101346. return p;
  101347. }
  101348. /************** End of callback.c ********************************************/
  101349. /************** Begin file delete.c ******************************************/
  101350. /*
  101351. ** 2001 September 15
  101352. **
  101353. ** The author disclaims copyright to this source code. In place of
  101354. ** a legal notice, here is a blessing:
  101355. **
  101356. ** May you do good and not evil.
  101357. ** May you find forgiveness for yourself and forgive others.
  101358. ** May you share freely, never taking more than you give.
  101359. **
  101360. *************************************************************************
  101361. ** This file contains C code routines that are called by the parser
  101362. ** in order to generate code for DELETE FROM statements.
  101363. */
  101364. /* #include "sqliteInt.h" */
  101365. /*
  101366. ** While a SrcList can in general represent multiple tables and subqueries
  101367. ** (as in the FROM clause of a SELECT statement) in this case it contains
  101368. ** the name of a single table, as one might find in an INSERT, DELETE,
  101369. ** or UPDATE statement. Look up that table in the symbol table and
  101370. ** return a pointer. Set an error message and return NULL if the table
  101371. ** name is not found or if any other error occurs.
  101372. **
  101373. ** The following fields are initialized appropriate in pSrc:
  101374. **
  101375. ** pSrc->a[0].pTab Pointer to the Table object
  101376. ** pSrc->a[0].pIndex Pointer to the INDEXED BY index, if there is one
  101377. **
  101378. */
  101379. SQLITE_PRIVATE Table *sqlite3SrcListLookup(Parse *pParse, SrcList *pSrc){
  101380. struct SrcList_item *pItem = pSrc->a;
  101381. Table *pTab;
  101382. assert( pItem && pSrc->nSrc==1 );
  101383. pTab = sqlite3LocateTableItem(pParse, 0, pItem);
  101384. sqlite3DeleteTable(pParse->db, pItem->pTab);
  101385. pItem->pTab = pTab;
  101386. if( pTab ){
  101387. pTab->nTabRef++;
  101388. }
  101389. if( sqlite3IndexedByLookup(pParse, pItem) ){
  101390. pTab = 0;
  101391. }
  101392. return pTab;
  101393. }
  101394. /*
  101395. ** Check to make sure the given table is writable. If it is not
  101396. ** writable, generate an error message and return 1. If it is
  101397. ** writable return 0;
  101398. */
  101399. SQLITE_PRIVATE int sqlite3IsReadOnly(Parse *pParse, Table *pTab, int viewOk){
  101400. /* A table is not writable under the following circumstances:
  101401. **
  101402. ** 1) It is a virtual table and no implementation of the xUpdate method
  101403. ** has been provided, or
  101404. ** 2) It is a system table (i.e. sqlite_master), this call is not
  101405. ** part of a nested parse and writable_schema pragma has not
  101406. ** been specified.
  101407. **
  101408. ** In either case leave an error message in pParse and return non-zero.
  101409. */
  101410. if( ( IsVirtual(pTab)
  101411. && sqlite3GetVTable(pParse->db, pTab)->pMod->pModule->xUpdate==0 )
  101412. || ( (pTab->tabFlags & TF_Readonly)!=0
  101413. && (pParse->db->flags & SQLITE_WriteSchema)==0
  101414. && pParse->nested==0 )
  101415. ){
  101416. sqlite3ErrorMsg(pParse, "table %s may not be modified", pTab->zName);
  101417. return 1;
  101418. }
  101419. #ifndef SQLITE_OMIT_VIEW
  101420. if( !viewOk && pTab->pSelect ){
  101421. sqlite3ErrorMsg(pParse,"cannot modify %s because it is a view",pTab->zName);
  101422. return 1;
  101423. }
  101424. #endif
  101425. return 0;
  101426. }
  101427. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  101428. /*
  101429. ** Evaluate a view and store its result in an ephemeral table. The
  101430. ** pWhere argument is an optional WHERE clause that restricts the
  101431. ** set of rows in the view that are to be added to the ephemeral table.
  101432. */
  101433. SQLITE_PRIVATE void sqlite3MaterializeView(
  101434. Parse *pParse, /* Parsing context */
  101435. Table *pView, /* View definition */
  101436. Expr *pWhere, /* Optional WHERE clause to be added */
  101437. ExprList *pOrderBy, /* Optional ORDER BY clause */
  101438. Expr *pLimit, /* Optional LIMIT clause */
  101439. int iCur /* Cursor number for ephemeral table */
  101440. ){
  101441. SelectDest dest;
  101442. Select *pSel;
  101443. SrcList *pFrom;
  101444. sqlite3 *db = pParse->db;
  101445. int iDb = sqlite3SchemaToIndex(db, pView->pSchema);
  101446. pWhere = sqlite3ExprDup(db, pWhere, 0);
  101447. pFrom = sqlite3SrcListAppend(db, 0, 0, 0);
  101448. if( pFrom ){
  101449. assert( pFrom->nSrc==1 );
  101450. pFrom->a[0].zName = sqlite3DbStrDup(db, pView->zName);
  101451. pFrom->a[0].zDatabase = sqlite3DbStrDup(db, db->aDb[iDb].zDbSName);
  101452. assert( pFrom->a[0].pOn==0 );
  101453. assert( pFrom->a[0].pUsing==0 );
  101454. }
  101455. pSel = sqlite3SelectNew(pParse, 0, pFrom, pWhere, 0, 0, pOrderBy,
  101456. SF_IncludeHidden, pLimit);
  101457. sqlite3SelectDestInit(&dest, SRT_EphemTab, iCur);
  101458. sqlite3Select(pParse, pSel, &dest);
  101459. sqlite3SelectDelete(db, pSel);
  101460. }
  101461. #endif /* !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER) */
  101462. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) && !defined(SQLITE_OMIT_SUBQUERY)
  101463. /*
  101464. ** Generate an expression tree to implement the WHERE, ORDER BY,
  101465. ** and LIMIT/OFFSET portion of DELETE and UPDATE statements.
  101466. **
  101467. ** DELETE FROM table_wxyz WHERE a<5 ORDER BY a LIMIT 1;
  101468. ** \__________________________/
  101469. ** pLimitWhere (pInClause)
  101470. */
  101471. SQLITE_PRIVATE Expr *sqlite3LimitWhere(
  101472. Parse *pParse, /* The parser context */
  101473. SrcList *pSrc, /* the FROM clause -- which tables to scan */
  101474. Expr *pWhere, /* The WHERE clause. May be null */
  101475. ExprList *pOrderBy, /* The ORDER BY clause. May be null */
  101476. Expr *pLimit, /* The LIMIT clause. May be null */
  101477. char *zStmtType /* Either DELETE or UPDATE. For err msgs. */
  101478. ){
  101479. sqlite3 *db = pParse->db;
  101480. Expr *pLhs = NULL; /* LHS of IN(SELECT...) operator */
  101481. Expr *pInClause = NULL; /* WHERE rowid IN ( select ) */
  101482. ExprList *pEList = NULL; /* Expression list contaning only pSelectRowid */
  101483. SrcList *pSelectSrc = NULL; /* SELECT rowid FROM x ... (dup of pSrc) */
  101484. Select *pSelect = NULL; /* Complete SELECT tree */
  101485. Table *pTab;
  101486. /* Check that there isn't an ORDER BY without a LIMIT clause.
  101487. */
  101488. if( pOrderBy && pLimit==0 ) {
  101489. sqlite3ErrorMsg(pParse, "ORDER BY without LIMIT on %s", zStmtType);
  101490. sqlite3ExprDelete(pParse->db, pWhere);
  101491. sqlite3ExprListDelete(pParse->db, pOrderBy);
  101492. return 0;
  101493. }
  101494. /* We only need to generate a select expression if there
  101495. ** is a limit/offset term to enforce.
  101496. */
  101497. if( pLimit == 0 ) {
  101498. return pWhere;
  101499. }
  101500. /* Generate a select expression tree to enforce the limit/offset
  101501. ** term for the DELETE or UPDATE statement. For example:
  101502. ** DELETE FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
  101503. ** becomes:
  101504. ** DELETE FROM table_a WHERE rowid IN (
  101505. ** SELECT rowid FROM table_a WHERE col1=1 ORDER BY col2 LIMIT 1 OFFSET 1
  101506. ** );
  101507. */
  101508. pTab = pSrc->a[0].pTab;
  101509. if( HasRowid(pTab) ){
  101510. pLhs = sqlite3PExpr(pParse, TK_ROW, 0, 0);
  101511. pEList = sqlite3ExprListAppend(
  101512. pParse, 0, sqlite3PExpr(pParse, TK_ROW, 0, 0)
  101513. );
  101514. }else{
  101515. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  101516. if( pPk->nKeyCol==1 ){
  101517. const char *zName = pTab->aCol[pPk->aiColumn[0]].zName;
  101518. pLhs = sqlite3Expr(db, TK_ID, zName);
  101519. pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ID, zName));
  101520. }else{
  101521. int i;
  101522. for(i=0; i<pPk->nKeyCol; i++){
  101523. Expr *p = sqlite3Expr(db, TK_ID, pTab->aCol[pPk->aiColumn[i]].zName);
  101524. pEList = sqlite3ExprListAppend(pParse, pEList, p);
  101525. }
  101526. pLhs = sqlite3PExpr(pParse, TK_VECTOR, 0, 0);
  101527. if( pLhs ){
  101528. pLhs->x.pList = sqlite3ExprListDup(db, pEList, 0);
  101529. }
  101530. }
  101531. }
  101532. /* duplicate the FROM clause as it is needed by both the DELETE/UPDATE tree
  101533. ** and the SELECT subtree. */
  101534. pSrc->a[0].pTab = 0;
  101535. pSelectSrc = sqlite3SrcListDup(pParse->db, pSrc, 0);
  101536. pSrc->a[0].pTab = pTab;
  101537. pSrc->a[0].pIBIndex = 0;
  101538. /* generate the SELECT expression tree. */
  101539. pSelect = sqlite3SelectNew(pParse, pEList, pSelectSrc, pWhere, 0 ,0,
  101540. pOrderBy,0,pLimit
  101541. );
  101542. /* now generate the new WHERE rowid IN clause for the DELETE/UDPATE */
  101543. pInClause = sqlite3PExpr(pParse, TK_IN, pLhs, 0);
  101544. sqlite3PExprAddSelect(pParse, pInClause, pSelect);
  101545. return pInClause;
  101546. }
  101547. #endif /* defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT) */
  101548. /* && !defined(SQLITE_OMIT_SUBQUERY) */
  101549. /*
  101550. ** Generate code for a DELETE FROM statement.
  101551. **
  101552. ** DELETE FROM table_wxyz WHERE a<5 AND b NOT NULL;
  101553. ** \________/ \________________/
  101554. ** pTabList pWhere
  101555. */
  101556. SQLITE_PRIVATE void sqlite3DeleteFrom(
  101557. Parse *pParse, /* The parser context */
  101558. SrcList *pTabList, /* The table from which we should delete things */
  101559. Expr *pWhere, /* The WHERE clause. May be null */
  101560. ExprList *pOrderBy, /* ORDER BY clause. May be null */
  101561. Expr *pLimit /* LIMIT clause. May be null */
  101562. ){
  101563. Vdbe *v; /* The virtual database engine */
  101564. Table *pTab; /* The table from which records will be deleted */
  101565. int i; /* Loop counter */
  101566. WhereInfo *pWInfo; /* Information about the WHERE clause */
  101567. Index *pIdx; /* For looping over indices of the table */
  101568. int iTabCur; /* Cursor number for the table */
  101569. int iDataCur = 0; /* VDBE cursor for the canonical data source */
  101570. int iIdxCur = 0; /* Cursor number of the first index */
  101571. int nIdx; /* Number of indices */
  101572. sqlite3 *db; /* Main database structure */
  101573. AuthContext sContext; /* Authorization context */
  101574. NameContext sNC; /* Name context to resolve expressions in */
  101575. int iDb; /* Database number */
  101576. int memCnt = -1; /* Memory cell used for change counting */
  101577. int rcauth; /* Value returned by authorization callback */
  101578. int eOnePass; /* ONEPASS_OFF or _SINGLE or _MULTI */
  101579. int aiCurOnePass[2]; /* The write cursors opened by WHERE_ONEPASS */
  101580. u8 *aToOpen = 0; /* Open cursor iTabCur+j if aToOpen[j] is true */
  101581. Index *pPk; /* The PRIMARY KEY index on the table */
  101582. int iPk = 0; /* First of nPk registers holding PRIMARY KEY value */
  101583. i16 nPk = 1; /* Number of columns in the PRIMARY KEY */
  101584. int iKey; /* Memory cell holding key of row to be deleted */
  101585. i16 nKey; /* Number of memory cells in the row key */
  101586. int iEphCur = 0; /* Ephemeral table holding all primary key values */
  101587. int iRowSet = 0; /* Register for rowset of rows to delete */
  101588. int addrBypass = 0; /* Address of jump over the delete logic */
  101589. int addrLoop = 0; /* Top of the delete loop */
  101590. int addrEphOpen = 0; /* Instruction to open the Ephemeral table */
  101591. int bComplex; /* True if there are triggers or FKs or
  101592. ** subqueries in the WHERE clause */
  101593. #ifndef SQLITE_OMIT_TRIGGER
  101594. int isView; /* True if attempting to delete from a view */
  101595. Trigger *pTrigger; /* List of table triggers, if required */
  101596. #endif
  101597. memset(&sContext, 0, sizeof(sContext));
  101598. db = pParse->db;
  101599. if( pParse->nErr || db->mallocFailed ){
  101600. goto delete_from_cleanup;
  101601. }
  101602. assert( pTabList->nSrc==1 );
  101603. /* Locate the table which we want to delete. This table has to be
  101604. ** put in an SrcList structure because some of the subroutines we
  101605. ** will be calling are designed to work with multiple tables and expect
  101606. ** an SrcList* parameter instead of just a Table* parameter.
  101607. */
  101608. pTab = sqlite3SrcListLookup(pParse, pTabList);
  101609. if( pTab==0 ) goto delete_from_cleanup;
  101610. /* Figure out if we have any triggers and if the table being
  101611. ** deleted from is a view
  101612. */
  101613. #ifndef SQLITE_OMIT_TRIGGER
  101614. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
  101615. isView = pTab->pSelect!=0;
  101616. #else
  101617. # define pTrigger 0
  101618. # define isView 0
  101619. #endif
  101620. bComplex = pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0);
  101621. #ifdef SQLITE_OMIT_VIEW
  101622. # undef isView
  101623. # define isView 0
  101624. #endif
  101625. #ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
  101626. if( !isView ){
  101627. pWhere = sqlite3LimitWhere(
  101628. pParse, pTabList, pWhere, pOrderBy, pLimit, "DELETE"
  101629. );
  101630. pOrderBy = 0;
  101631. pLimit = 0;
  101632. }
  101633. #endif
  101634. /* If pTab is really a view, make sure it has been initialized.
  101635. */
  101636. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  101637. goto delete_from_cleanup;
  101638. }
  101639. if( sqlite3IsReadOnly(pParse, pTab, (pTrigger?1:0)) ){
  101640. goto delete_from_cleanup;
  101641. }
  101642. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  101643. assert( iDb<db->nDb );
  101644. rcauth = sqlite3AuthCheck(pParse, SQLITE_DELETE, pTab->zName, 0,
  101645. db->aDb[iDb].zDbSName);
  101646. assert( rcauth==SQLITE_OK || rcauth==SQLITE_DENY || rcauth==SQLITE_IGNORE );
  101647. if( rcauth==SQLITE_DENY ){
  101648. goto delete_from_cleanup;
  101649. }
  101650. assert(!isView || pTrigger);
  101651. /* Assign cursor numbers to the table and all its indices.
  101652. */
  101653. assert( pTabList->nSrc==1 );
  101654. iTabCur = pTabList->a[0].iCursor = pParse->nTab++;
  101655. for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
  101656. pParse->nTab++;
  101657. }
  101658. /* Start the view context
  101659. */
  101660. if( isView ){
  101661. sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
  101662. }
  101663. /* Begin generating code.
  101664. */
  101665. v = sqlite3GetVdbe(pParse);
  101666. if( v==0 ){
  101667. goto delete_from_cleanup;
  101668. }
  101669. if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
  101670. sqlite3BeginWriteOperation(pParse, 1, iDb);
  101671. /* If we are trying to delete from a view, realize that view into
  101672. ** an ephemeral table.
  101673. */
  101674. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  101675. if( isView ){
  101676. sqlite3MaterializeView(pParse, pTab,
  101677. pWhere, pOrderBy, pLimit, iTabCur
  101678. );
  101679. iDataCur = iIdxCur = iTabCur;
  101680. pOrderBy = 0;
  101681. pLimit = 0;
  101682. }
  101683. #endif
  101684. /* Resolve the column names in the WHERE clause.
  101685. */
  101686. memset(&sNC, 0, sizeof(sNC));
  101687. sNC.pParse = pParse;
  101688. sNC.pSrcList = pTabList;
  101689. if( sqlite3ResolveExprNames(&sNC, pWhere) ){
  101690. goto delete_from_cleanup;
  101691. }
  101692. /* Initialize the counter of the number of rows deleted, if
  101693. ** we are counting rows.
  101694. */
  101695. if( db->flags & SQLITE_CountRows ){
  101696. memCnt = ++pParse->nMem;
  101697. sqlite3VdbeAddOp2(v, OP_Integer, 0, memCnt);
  101698. }
  101699. #ifndef SQLITE_OMIT_TRUNCATE_OPTIMIZATION
  101700. /* Special case: A DELETE without a WHERE clause deletes everything.
  101701. ** It is easier just to erase the whole table. Prior to version 3.6.5,
  101702. ** this optimization caused the row change count (the value returned by
  101703. ** API function sqlite3_count_changes) to be set incorrectly.
  101704. **
  101705. ** The "rcauth==SQLITE_OK" terms is the
  101706. ** IMPLEMENTATION-OF: R-17228-37124 If the action code is SQLITE_DELETE and
  101707. ** the callback returns SQLITE_IGNORE then the DELETE operation proceeds but
  101708. ** the truncate optimization is disabled and all rows are deleted
  101709. ** individually.
  101710. */
  101711. if( rcauth==SQLITE_OK
  101712. && pWhere==0
  101713. && !bComplex
  101714. && !IsVirtual(pTab)
  101715. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  101716. && db->xPreUpdateCallback==0
  101717. #endif
  101718. ){
  101719. assert( !isView );
  101720. sqlite3TableLock(pParse, iDb, pTab->tnum, 1, pTab->zName);
  101721. if( HasRowid(pTab) ){
  101722. sqlite3VdbeAddOp4(v, OP_Clear, pTab->tnum, iDb, memCnt,
  101723. pTab->zName, P4_STATIC);
  101724. }
  101725. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  101726. assert( pIdx->pSchema==pTab->pSchema );
  101727. sqlite3VdbeAddOp2(v, OP_Clear, pIdx->tnum, iDb);
  101728. }
  101729. }else
  101730. #endif /* SQLITE_OMIT_TRUNCATE_OPTIMIZATION */
  101731. {
  101732. u16 wcf = WHERE_ONEPASS_DESIRED|WHERE_DUPLICATES_OK|WHERE_SEEK_TABLE;
  101733. if( sNC.ncFlags & NC_VarSelect ) bComplex = 1;
  101734. wcf |= (bComplex ? 0 : WHERE_ONEPASS_MULTIROW);
  101735. if( HasRowid(pTab) ){
  101736. /* For a rowid table, initialize the RowSet to an empty set */
  101737. pPk = 0;
  101738. nPk = 1;
  101739. iRowSet = ++pParse->nMem;
  101740. sqlite3VdbeAddOp2(v, OP_Null, 0, iRowSet);
  101741. }else{
  101742. /* For a WITHOUT ROWID table, create an ephemeral table used to
  101743. ** hold all primary keys for rows to be deleted. */
  101744. pPk = sqlite3PrimaryKeyIndex(pTab);
  101745. assert( pPk!=0 );
  101746. nPk = pPk->nKeyCol;
  101747. iPk = pParse->nMem+1;
  101748. pParse->nMem += nPk;
  101749. iEphCur = pParse->nTab++;
  101750. addrEphOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEphCur, nPk);
  101751. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  101752. }
  101753. /* Construct a query to find the rowid or primary key for every row
  101754. ** to be deleted, based on the WHERE clause. Set variable eOnePass
  101755. ** to indicate the strategy used to implement this delete:
  101756. **
  101757. ** ONEPASS_OFF: Two-pass approach - use a FIFO for rowids/PK values.
  101758. ** ONEPASS_SINGLE: One-pass approach - at most one row deleted.
  101759. ** ONEPASS_MULTI: One-pass approach - any number of rows may be deleted.
  101760. */
  101761. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0, wcf, iTabCur+1);
  101762. if( pWInfo==0 ) goto delete_from_cleanup;
  101763. eOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
  101764. assert( IsVirtual(pTab)==0 || eOnePass!=ONEPASS_MULTI );
  101765. assert( IsVirtual(pTab) || bComplex || eOnePass!=ONEPASS_OFF );
  101766. /* Keep track of the number of rows to be deleted */
  101767. if( db->flags & SQLITE_CountRows ){
  101768. sqlite3VdbeAddOp2(v, OP_AddImm, memCnt, 1);
  101769. }
  101770. /* Extract the rowid or primary key for the current row */
  101771. if( pPk ){
  101772. for(i=0; i<nPk; i++){
  101773. assert( pPk->aiColumn[i]>=0 );
  101774. sqlite3ExprCodeGetColumnOfTable(v, pTab, iTabCur,
  101775. pPk->aiColumn[i], iPk+i);
  101776. }
  101777. iKey = iPk;
  101778. }else{
  101779. iKey = pParse->nMem + 1;
  101780. iKey = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iTabCur, iKey, 0);
  101781. if( iKey>pParse->nMem ) pParse->nMem = iKey;
  101782. }
  101783. if( eOnePass!=ONEPASS_OFF ){
  101784. /* For ONEPASS, no need to store the rowid/primary-key. There is only
  101785. ** one, so just keep it in its register(s) and fall through to the
  101786. ** delete code. */
  101787. nKey = nPk; /* OP_Found will use an unpacked key */
  101788. aToOpen = sqlite3DbMallocRawNN(db, nIdx+2);
  101789. if( aToOpen==0 ){
  101790. sqlite3WhereEnd(pWInfo);
  101791. goto delete_from_cleanup;
  101792. }
  101793. memset(aToOpen, 1, nIdx+1);
  101794. aToOpen[nIdx+1] = 0;
  101795. if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iTabCur] = 0;
  101796. if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iTabCur] = 0;
  101797. if( addrEphOpen ) sqlite3VdbeChangeToNoop(v, addrEphOpen);
  101798. }else{
  101799. if( pPk ){
  101800. /* Add the PK key for this row to the temporary table */
  101801. iKey = ++pParse->nMem;
  101802. nKey = 0; /* Zero tells OP_Found to use a composite key */
  101803. sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, iKey,
  101804. sqlite3IndexAffinityStr(pParse->db, pPk), nPk);
  101805. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iEphCur, iKey, iPk, nPk);
  101806. }else{
  101807. /* Add the rowid of the row to be deleted to the RowSet */
  101808. nKey = 1; /* OP_DeferredSeek always uses a single rowid */
  101809. sqlite3VdbeAddOp2(v, OP_RowSetAdd, iRowSet, iKey);
  101810. }
  101811. }
  101812. /* If this DELETE cannot use the ONEPASS strategy, this is the
  101813. ** end of the WHERE loop */
  101814. if( eOnePass!=ONEPASS_OFF ){
  101815. addrBypass = sqlite3VdbeMakeLabel(v);
  101816. }else{
  101817. sqlite3WhereEnd(pWInfo);
  101818. }
  101819. /* Unless this is a view, open cursors for the table we are
  101820. ** deleting from and all its indices. If this is a view, then the
  101821. ** only effect this statement has is to fire the INSTEAD OF
  101822. ** triggers.
  101823. */
  101824. if( !isView ){
  101825. int iAddrOnce = 0;
  101826. if( eOnePass==ONEPASS_MULTI ){
  101827. iAddrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  101828. }
  101829. testcase( IsVirtual(pTab) );
  101830. sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, OPFLAG_FORDELETE,
  101831. iTabCur, aToOpen, &iDataCur, &iIdxCur);
  101832. assert( pPk || IsVirtual(pTab) || iDataCur==iTabCur );
  101833. assert( pPk || IsVirtual(pTab) || iIdxCur==iDataCur+1 );
  101834. if( eOnePass==ONEPASS_MULTI ) sqlite3VdbeJumpHere(v, iAddrOnce);
  101835. }
  101836. /* Set up a loop over the rowids/primary-keys that were found in the
  101837. ** where-clause loop above.
  101838. */
  101839. if( eOnePass!=ONEPASS_OFF ){
  101840. assert( nKey==nPk ); /* OP_Found will use an unpacked key */
  101841. if( !IsVirtual(pTab) && aToOpen[iDataCur-iTabCur] ){
  101842. assert( pPk!=0 || pTab->pSelect!=0 );
  101843. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, addrBypass, iKey, nKey);
  101844. VdbeCoverage(v);
  101845. }
  101846. }else if( pPk ){
  101847. addrLoop = sqlite3VdbeAddOp1(v, OP_Rewind, iEphCur); VdbeCoverage(v);
  101848. if( IsVirtual(pTab) ){
  101849. sqlite3VdbeAddOp3(v, OP_Column, iEphCur, 0, iKey);
  101850. }else{
  101851. sqlite3VdbeAddOp2(v, OP_RowData, iEphCur, iKey);
  101852. }
  101853. assert( nKey==0 ); /* OP_Found will use a composite key */
  101854. }else{
  101855. addrLoop = sqlite3VdbeAddOp3(v, OP_RowSetRead, iRowSet, 0, iKey);
  101856. VdbeCoverage(v);
  101857. assert( nKey==1 );
  101858. }
  101859. /* Delete the row */
  101860. #ifndef SQLITE_OMIT_VIRTUALTABLE
  101861. if( IsVirtual(pTab) ){
  101862. const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
  101863. sqlite3VtabMakeWritable(pParse, pTab);
  101864. sqlite3VdbeAddOp4(v, OP_VUpdate, 0, 1, iKey, pVTab, P4_VTAB);
  101865. sqlite3VdbeChangeP5(v, OE_Abort);
  101866. assert( eOnePass==ONEPASS_OFF || eOnePass==ONEPASS_SINGLE );
  101867. sqlite3MayAbort(pParse);
  101868. if( eOnePass==ONEPASS_SINGLE && sqlite3IsToplevel(pParse) ){
  101869. pParse->isMultiWrite = 0;
  101870. }
  101871. }else
  101872. #endif
  101873. {
  101874. int count = (pParse->nested==0); /* True to count changes */
  101875. sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
  101876. iKey, nKey, count, OE_Default, eOnePass, aiCurOnePass[1]);
  101877. }
  101878. /* End of the loop over all rowids/primary-keys. */
  101879. if( eOnePass!=ONEPASS_OFF ){
  101880. sqlite3VdbeResolveLabel(v, addrBypass);
  101881. sqlite3WhereEnd(pWInfo);
  101882. }else if( pPk ){
  101883. sqlite3VdbeAddOp2(v, OP_Next, iEphCur, addrLoop+1); VdbeCoverage(v);
  101884. sqlite3VdbeJumpHere(v, addrLoop);
  101885. }else{
  101886. sqlite3VdbeGoto(v, addrLoop);
  101887. sqlite3VdbeJumpHere(v, addrLoop);
  101888. }
  101889. } /* End non-truncate path */
  101890. /* Update the sqlite_sequence table by storing the content of the
  101891. ** maximum rowid counter values recorded while inserting into
  101892. ** autoincrement tables.
  101893. */
  101894. if( pParse->nested==0 && pParse->pTriggerTab==0 ){
  101895. sqlite3AutoincrementEnd(pParse);
  101896. }
  101897. /* Return the number of rows that were deleted. If this routine is
  101898. ** generating code because of a call to sqlite3NestedParse(), do not
  101899. ** invoke the callback function.
  101900. */
  101901. if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
  101902. sqlite3VdbeAddOp2(v, OP_ResultRow, memCnt, 1);
  101903. sqlite3VdbeSetNumCols(v, 1);
  101904. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows deleted", SQLITE_STATIC);
  101905. }
  101906. delete_from_cleanup:
  101907. sqlite3AuthContextPop(&sContext);
  101908. sqlite3SrcListDelete(db, pTabList);
  101909. sqlite3ExprDelete(db, pWhere);
  101910. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT)
  101911. sqlite3ExprListDelete(db, pOrderBy);
  101912. sqlite3ExprDelete(db, pLimit);
  101913. #endif
  101914. sqlite3DbFree(db, aToOpen);
  101915. return;
  101916. }
  101917. /* Make sure "isView" and other macros defined above are undefined. Otherwise
  101918. ** they may interfere with compilation of other functions in this file
  101919. ** (or in another file, if this file becomes part of the amalgamation). */
  101920. #ifdef isView
  101921. #undef isView
  101922. #endif
  101923. #ifdef pTrigger
  101924. #undef pTrigger
  101925. #endif
  101926. /*
  101927. ** This routine generates VDBE code that causes a single row of a
  101928. ** single table to be deleted. Both the original table entry and
  101929. ** all indices are removed.
  101930. **
  101931. ** Preconditions:
  101932. **
  101933. ** 1. iDataCur is an open cursor on the btree that is the canonical data
  101934. ** store for the table. (This will be either the table itself,
  101935. ** in the case of a rowid table, or the PRIMARY KEY index in the case
  101936. ** of a WITHOUT ROWID table.)
  101937. **
  101938. ** 2. Read/write cursors for all indices of pTab must be open as
  101939. ** cursor number iIdxCur+i for the i-th index.
  101940. **
  101941. ** 3. The primary key for the row to be deleted must be stored in a
  101942. ** sequence of nPk memory cells starting at iPk. If nPk==0 that means
  101943. ** that a search record formed from OP_MakeRecord is contained in the
  101944. ** single memory location iPk.
  101945. **
  101946. ** eMode:
  101947. ** Parameter eMode may be passed either ONEPASS_OFF (0), ONEPASS_SINGLE, or
  101948. ** ONEPASS_MULTI. If eMode is not ONEPASS_OFF, then the cursor
  101949. ** iDataCur already points to the row to delete. If eMode is ONEPASS_OFF
  101950. ** then this function must seek iDataCur to the entry identified by iPk
  101951. ** and nPk before reading from it.
  101952. **
  101953. ** If eMode is ONEPASS_MULTI, then this call is being made as part
  101954. ** of a ONEPASS delete that affects multiple rows. In this case, if
  101955. ** iIdxNoSeek is a valid cursor number (>=0) and is not the same as
  101956. ** iDataCur, then its position should be preserved following the delete
  101957. ** operation. Or, if iIdxNoSeek is not a valid cursor number, the
  101958. ** position of iDataCur should be preserved instead.
  101959. **
  101960. ** iIdxNoSeek:
  101961. ** If iIdxNoSeek is a valid cursor number (>=0) not equal to iDataCur,
  101962. ** then it identifies an index cursor (from within array of cursors
  101963. ** starting at iIdxCur) that already points to the index entry to be deleted.
  101964. ** Except, this optimization is disabled if there are BEFORE triggers since
  101965. ** the trigger body might have moved the cursor.
  101966. */
  101967. SQLITE_PRIVATE void sqlite3GenerateRowDelete(
  101968. Parse *pParse, /* Parsing context */
  101969. Table *pTab, /* Table containing the row to be deleted */
  101970. Trigger *pTrigger, /* List of triggers to (potentially) fire */
  101971. int iDataCur, /* Cursor from which column data is extracted */
  101972. int iIdxCur, /* First index cursor */
  101973. int iPk, /* First memory cell containing the PRIMARY KEY */
  101974. i16 nPk, /* Number of PRIMARY KEY memory cells */
  101975. u8 count, /* If non-zero, increment the row change counter */
  101976. u8 onconf, /* Default ON CONFLICT policy for triggers */
  101977. u8 eMode, /* ONEPASS_OFF, _SINGLE, or _MULTI. See above */
  101978. int iIdxNoSeek /* Cursor number of cursor that does not need seeking */
  101979. ){
  101980. Vdbe *v = pParse->pVdbe; /* Vdbe */
  101981. int iOld = 0; /* First register in OLD.* array */
  101982. int iLabel; /* Label resolved to end of generated code */
  101983. u8 opSeek; /* Seek opcode */
  101984. /* Vdbe is guaranteed to have been allocated by this stage. */
  101985. assert( v );
  101986. VdbeModuleComment((v, "BEGIN: GenRowDel(%d,%d,%d,%d)",
  101987. iDataCur, iIdxCur, iPk, (int)nPk));
  101988. /* Seek cursor iCur to the row to delete. If this row no longer exists
  101989. ** (this can happen if a trigger program has already deleted it), do
  101990. ** not attempt to delete it or fire any DELETE triggers. */
  101991. iLabel = sqlite3VdbeMakeLabel(v);
  101992. opSeek = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
  101993. if( eMode==ONEPASS_OFF ){
  101994. sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
  101995. VdbeCoverageIf(v, opSeek==OP_NotExists);
  101996. VdbeCoverageIf(v, opSeek==OP_NotFound);
  101997. }
  101998. /* If there are any triggers to fire, allocate a range of registers to
  101999. ** use for the old.* references in the triggers. */
  102000. if( sqlite3FkRequired(pParse, pTab, 0, 0) || pTrigger ){
  102001. u32 mask; /* Mask of OLD.* columns in use */
  102002. int iCol; /* Iterator used while populating OLD.* */
  102003. int addrStart; /* Start of BEFORE trigger programs */
  102004. /* TODO: Could use temporary registers here. Also could attempt to
  102005. ** avoid copying the contents of the rowid register. */
  102006. mask = sqlite3TriggerColmask(
  102007. pParse, pTrigger, 0, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onconf
  102008. );
  102009. mask |= sqlite3FkOldmask(pParse, pTab);
  102010. iOld = pParse->nMem+1;
  102011. pParse->nMem += (1 + pTab->nCol);
  102012. /* Populate the OLD.* pseudo-table register array. These values will be
  102013. ** used by any BEFORE and AFTER triggers that exist. */
  102014. sqlite3VdbeAddOp2(v, OP_Copy, iPk, iOld);
  102015. for(iCol=0; iCol<pTab->nCol; iCol++){
  102016. testcase( mask!=0xffffffff && iCol==31 );
  102017. testcase( mask!=0xffffffff && iCol==32 );
  102018. if( mask==0xffffffff || (iCol<=31 && (mask & MASKBIT32(iCol))!=0) ){
  102019. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, iCol, iOld+iCol+1);
  102020. }
  102021. }
  102022. /* Invoke BEFORE DELETE trigger programs. */
  102023. addrStart = sqlite3VdbeCurrentAddr(v);
  102024. sqlite3CodeRowTrigger(pParse, pTrigger,
  102025. TK_DELETE, 0, TRIGGER_BEFORE, pTab, iOld, onconf, iLabel
  102026. );
  102027. /* If any BEFORE triggers were coded, then seek the cursor to the
  102028. ** row to be deleted again. It may be that the BEFORE triggers moved
  102029. ** the cursor or already deleted the row that the cursor was
  102030. ** pointing to.
  102031. **
  102032. ** Also disable the iIdxNoSeek optimization since the BEFORE trigger
  102033. ** may have moved that cursor.
  102034. */
  102035. if( addrStart<sqlite3VdbeCurrentAddr(v) ){
  102036. sqlite3VdbeAddOp4Int(v, opSeek, iDataCur, iLabel, iPk, nPk);
  102037. VdbeCoverageIf(v, opSeek==OP_NotExists);
  102038. VdbeCoverageIf(v, opSeek==OP_NotFound);
  102039. testcase( iIdxNoSeek>=0 );
  102040. iIdxNoSeek = -1;
  102041. }
  102042. /* Do FK processing. This call checks that any FK constraints that
  102043. ** refer to this table (i.e. constraints attached to other tables)
  102044. ** are not violated by deleting this row. */
  102045. sqlite3FkCheck(pParse, pTab, iOld, 0, 0, 0);
  102046. }
  102047. /* Delete the index and table entries. Skip this step if pTab is really
  102048. ** a view (in which case the only effect of the DELETE statement is to
  102049. ** fire the INSTEAD OF triggers).
  102050. **
  102051. ** If variable 'count' is non-zero, then this OP_Delete instruction should
  102052. ** invoke the update-hook. The pre-update-hook, on the other hand should
  102053. ** be invoked unless table pTab is a system table. The difference is that
  102054. ** the update-hook is not invoked for rows removed by REPLACE, but the
  102055. ** pre-update-hook is.
  102056. */
  102057. if( pTab->pSelect==0 ){
  102058. u8 p5 = 0;
  102059. sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,iIdxNoSeek);
  102060. sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, (count?OPFLAG_NCHANGE:0));
  102061. if( pParse->nested==0 || 0==sqlite3_stricmp(pTab->zName, "sqlite_stat1") ){
  102062. sqlite3VdbeAppendP4(v, (char*)pTab, P4_TABLE);
  102063. }
  102064. if( eMode!=ONEPASS_OFF ){
  102065. sqlite3VdbeChangeP5(v, OPFLAG_AUXDELETE);
  102066. }
  102067. if( iIdxNoSeek>=0 && iIdxNoSeek!=iDataCur ){
  102068. sqlite3VdbeAddOp1(v, OP_Delete, iIdxNoSeek);
  102069. }
  102070. if( eMode==ONEPASS_MULTI ) p5 |= OPFLAG_SAVEPOSITION;
  102071. sqlite3VdbeChangeP5(v, p5);
  102072. }
  102073. /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
  102074. ** handle rows (possibly in other tables) that refer via a foreign key
  102075. ** to the row just deleted. */
  102076. sqlite3FkActions(pParse, pTab, 0, iOld, 0, 0);
  102077. /* Invoke AFTER DELETE trigger programs. */
  102078. sqlite3CodeRowTrigger(pParse, pTrigger,
  102079. TK_DELETE, 0, TRIGGER_AFTER, pTab, iOld, onconf, iLabel
  102080. );
  102081. /* Jump here if the row had already been deleted before any BEFORE
  102082. ** trigger programs were invoked. Or if a trigger program throws a
  102083. ** RAISE(IGNORE) exception. */
  102084. sqlite3VdbeResolveLabel(v, iLabel);
  102085. VdbeModuleComment((v, "END: GenRowDel()"));
  102086. }
  102087. /*
  102088. ** This routine generates VDBE code that causes the deletion of all
  102089. ** index entries associated with a single row of a single table, pTab
  102090. **
  102091. ** Preconditions:
  102092. **
  102093. ** 1. A read/write cursor "iDataCur" must be open on the canonical storage
  102094. ** btree for the table pTab. (This will be either the table itself
  102095. ** for rowid tables or to the primary key index for WITHOUT ROWID
  102096. ** tables.)
  102097. **
  102098. ** 2. Read/write cursors for all indices of pTab must be open as
  102099. ** cursor number iIdxCur+i for the i-th index. (The pTab->pIndex
  102100. ** index is the 0-th index.)
  102101. **
  102102. ** 3. The "iDataCur" cursor must be already be positioned on the row
  102103. ** that is to be deleted.
  102104. */
  102105. SQLITE_PRIVATE void sqlite3GenerateRowIndexDelete(
  102106. Parse *pParse, /* Parsing and code generating context */
  102107. Table *pTab, /* Table containing the row to be deleted */
  102108. int iDataCur, /* Cursor of table holding data. */
  102109. int iIdxCur, /* First index cursor */
  102110. int *aRegIdx, /* Only delete if aRegIdx!=0 && aRegIdx[i]>0 */
  102111. int iIdxNoSeek /* Do not delete from this cursor */
  102112. ){
  102113. int i; /* Index loop counter */
  102114. int r1 = -1; /* Register holding an index key */
  102115. int iPartIdxLabel; /* Jump destination for skipping partial index entries */
  102116. Index *pIdx; /* Current index */
  102117. Index *pPrior = 0; /* Prior index */
  102118. Vdbe *v; /* The prepared statement under construction */
  102119. Index *pPk; /* PRIMARY KEY index, or NULL for rowid tables */
  102120. v = pParse->pVdbe;
  102121. pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
  102122. for(i=0, pIdx=pTab->pIndex; pIdx; i++, pIdx=pIdx->pNext){
  102123. assert( iIdxCur+i!=iDataCur || pPk==pIdx );
  102124. if( aRegIdx!=0 && aRegIdx[i]==0 ) continue;
  102125. if( pIdx==pPk ) continue;
  102126. if( iIdxCur+i==iIdxNoSeek ) continue;
  102127. VdbeModuleComment((v, "GenRowIdxDel for %s", pIdx->zName));
  102128. r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 1,
  102129. &iPartIdxLabel, pPrior, r1);
  102130. sqlite3VdbeAddOp3(v, OP_IdxDelete, iIdxCur+i, r1,
  102131. pIdx->uniqNotNull ? pIdx->nKeyCol : pIdx->nColumn);
  102132. sqlite3ResolvePartIdxLabel(pParse, iPartIdxLabel);
  102133. pPrior = pIdx;
  102134. }
  102135. }
  102136. /*
  102137. ** Generate code that will assemble an index key and stores it in register
  102138. ** regOut. The key with be for index pIdx which is an index on pTab.
  102139. ** iCur is the index of a cursor open on the pTab table and pointing to
  102140. ** the entry that needs indexing. If pTab is a WITHOUT ROWID table, then
  102141. ** iCur must be the cursor of the PRIMARY KEY index.
  102142. **
  102143. ** Return a register number which is the first in a block of
  102144. ** registers that holds the elements of the index key. The
  102145. ** block of registers has already been deallocated by the time
  102146. ** this routine returns.
  102147. **
  102148. ** If *piPartIdxLabel is not NULL, fill it in with a label and jump
  102149. ** to that label if pIdx is a partial index that should be skipped.
  102150. ** The label should be resolved using sqlite3ResolvePartIdxLabel().
  102151. ** A partial index should be skipped if its WHERE clause evaluates
  102152. ** to false or null. If pIdx is not a partial index, *piPartIdxLabel
  102153. ** will be set to zero which is an empty label that is ignored by
  102154. ** sqlite3ResolvePartIdxLabel().
  102155. **
  102156. ** The pPrior and regPrior parameters are used to implement a cache to
  102157. ** avoid unnecessary register loads. If pPrior is not NULL, then it is
  102158. ** a pointer to a different index for which an index key has just been
  102159. ** computed into register regPrior. If the current pIdx index is generating
  102160. ** its key into the same sequence of registers and if pPrior and pIdx share
  102161. ** a column in common, then the register corresponding to that column already
  102162. ** holds the correct value and the loading of that register is skipped.
  102163. ** This optimization is helpful when doing a DELETE or an INTEGRITY_CHECK
  102164. ** on a table with multiple indices, and especially with the ROWID or
  102165. ** PRIMARY KEY columns of the index.
  102166. */
  102167. SQLITE_PRIVATE int sqlite3GenerateIndexKey(
  102168. Parse *pParse, /* Parsing context */
  102169. Index *pIdx, /* The index for which to generate a key */
  102170. int iDataCur, /* Cursor number from which to take column data */
  102171. int regOut, /* Put the new key into this register if not 0 */
  102172. int prefixOnly, /* Compute only a unique prefix of the key */
  102173. int *piPartIdxLabel, /* OUT: Jump to this label to skip partial index */
  102174. Index *pPrior, /* Previously generated index key */
  102175. int regPrior /* Register holding previous generated key */
  102176. ){
  102177. Vdbe *v = pParse->pVdbe;
  102178. int j;
  102179. int regBase;
  102180. int nCol;
  102181. if( piPartIdxLabel ){
  102182. if( pIdx->pPartIdxWhere ){
  102183. *piPartIdxLabel = sqlite3VdbeMakeLabel(v);
  102184. pParse->iSelfTab = iDataCur + 1;
  102185. sqlite3ExprCachePush(pParse);
  102186. sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, *piPartIdxLabel,
  102187. SQLITE_JUMPIFNULL);
  102188. pParse->iSelfTab = 0;
  102189. }else{
  102190. *piPartIdxLabel = 0;
  102191. }
  102192. }
  102193. nCol = (prefixOnly && pIdx->uniqNotNull) ? pIdx->nKeyCol : pIdx->nColumn;
  102194. regBase = sqlite3GetTempRange(pParse, nCol);
  102195. if( pPrior && (regBase!=regPrior || pPrior->pPartIdxWhere) ) pPrior = 0;
  102196. for(j=0; j<nCol; j++){
  102197. if( pPrior
  102198. && pPrior->aiColumn[j]==pIdx->aiColumn[j]
  102199. && pPrior->aiColumn[j]!=XN_EXPR
  102200. ){
  102201. /* This column was already computed by the previous index */
  102202. continue;
  102203. }
  102204. sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iDataCur, j, regBase+j);
  102205. /* If the column affinity is REAL but the number is an integer, then it
  102206. ** might be stored in the table as an integer (using a compact
  102207. ** representation) then converted to REAL by an OP_RealAffinity opcode.
  102208. ** But we are getting ready to store this value back into an index, where
  102209. ** it should be converted by to INTEGER again. So omit the OP_RealAffinity
  102210. ** opcode if it is present */
  102211. sqlite3VdbeDeletePriorOpcode(v, OP_RealAffinity);
  102212. }
  102213. if( regOut ){
  102214. sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regOut);
  102215. if( pIdx->pTable->pSelect ){
  102216. const char *zAff = sqlite3IndexAffinityStr(pParse->db, pIdx);
  102217. sqlite3VdbeChangeP4(v, -1, zAff, P4_TRANSIENT);
  102218. }
  102219. }
  102220. sqlite3ReleaseTempRange(pParse, regBase, nCol);
  102221. return regBase;
  102222. }
  102223. /*
  102224. ** If a prior call to sqlite3GenerateIndexKey() generated a jump-over label
  102225. ** because it was a partial index, then this routine should be called to
  102226. ** resolve that label.
  102227. */
  102228. SQLITE_PRIVATE void sqlite3ResolvePartIdxLabel(Parse *pParse, int iLabel){
  102229. if( iLabel ){
  102230. sqlite3VdbeResolveLabel(pParse->pVdbe, iLabel);
  102231. sqlite3ExprCachePop(pParse);
  102232. }
  102233. }
  102234. /************** End of delete.c **********************************************/
  102235. /************** Begin file func.c ********************************************/
  102236. /*
  102237. ** 2002 February 23
  102238. **
  102239. ** The author disclaims copyright to this source code. In place of
  102240. ** a legal notice, here is a blessing:
  102241. **
  102242. ** May you do good and not evil.
  102243. ** May you find forgiveness for yourself and forgive others.
  102244. ** May you share freely, never taking more than you give.
  102245. **
  102246. *************************************************************************
  102247. ** This file contains the C-language implementations for many of the SQL
  102248. ** functions of SQLite. (Some function, and in particular the date and
  102249. ** time functions, are implemented separately.)
  102250. */
  102251. /* #include "sqliteInt.h" */
  102252. /* #include <stdlib.h> */
  102253. /* #include <assert.h> */
  102254. /* #include "vdbeInt.h" */
  102255. /*
  102256. ** Return the collating function associated with a function.
  102257. */
  102258. static CollSeq *sqlite3GetFuncCollSeq(sqlite3_context *context){
  102259. VdbeOp *pOp;
  102260. assert( context->pVdbe!=0 );
  102261. pOp = &context->pVdbe->aOp[context->iOp-1];
  102262. assert( pOp->opcode==OP_CollSeq );
  102263. assert( pOp->p4type==P4_COLLSEQ );
  102264. return pOp->p4.pColl;
  102265. }
  102266. /*
  102267. ** Indicate that the accumulator load should be skipped on this
  102268. ** iteration of the aggregate loop.
  102269. */
  102270. static void sqlite3SkipAccumulatorLoad(sqlite3_context *context){
  102271. assert( context->isError<=0 );
  102272. context->isError = -1;
  102273. context->skipFlag = 1;
  102274. }
  102275. /*
  102276. ** Implementation of the non-aggregate min() and max() functions
  102277. */
  102278. static void minmaxFunc(
  102279. sqlite3_context *context,
  102280. int argc,
  102281. sqlite3_value **argv
  102282. ){
  102283. int i;
  102284. int mask; /* 0 for min() or 0xffffffff for max() */
  102285. int iBest;
  102286. CollSeq *pColl;
  102287. assert( argc>1 );
  102288. mask = sqlite3_user_data(context)==0 ? 0 : -1;
  102289. pColl = sqlite3GetFuncCollSeq(context);
  102290. assert( pColl );
  102291. assert( mask==-1 || mask==0 );
  102292. iBest = 0;
  102293. if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
  102294. for(i=1; i<argc; i++){
  102295. if( sqlite3_value_type(argv[i])==SQLITE_NULL ) return;
  102296. if( (sqlite3MemCompare(argv[iBest], argv[i], pColl)^mask)>=0 ){
  102297. testcase( mask==0 );
  102298. iBest = i;
  102299. }
  102300. }
  102301. sqlite3_result_value(context, argv[iBest]);
  102302. }
  102303. /*
  102304. ** Return the type of the argument.
  102305. */
  102306. static void typeofFunc(
  102307. sqlite3_context *context,
  102308. int NotUsed,
  102309. sqlite3_value **argv
  102310. ){
  102311. static const char *azType[] = { "integer", "real", "text", "blob", "null" };
  102312. int i = sqlite3_value_type(argv[0]) - 1;
  102313. UNUSED_PARAMETER(NotUsed);
  102314. assert( i>=0 && i<ArraySize(azType) );
  102315. assert( SQLITE_INTEGER==1 );
  102316. assert( SQLITE_FLOAT==2 );
  102317. assert( SQLITE_TEXT==3 );
  102318. assert( SQLITE_BLOB==4 );
  102319. assert( SQLITE_NULL==5 );
  102320. /* EVIDENCE-OF: R-01470-60482 The sqlite3_value_type(V) interface returns
  102321. ** the datatype code for the initial datatype of the sqlite3_value object
  102322. ** V. The returned value is one of SQLITE_INTEGER, SQLITE_FLOAT,
  102323. ** SQLITE_TEXT, SQLITE_BLOB, or SQLITE_NULL. */
  102324. sqlite3_result_text(context, azType[i], -1, SQLITE_STATIC);
  102325. }
  102326. /*
  102327. ** Implementation of the length() function
  102328. */
  102329. static void lengthFunc(
  102330. sqlite3_context *context,
  102331. int argc,
  102332. sqlite3_value **argv
  102333. ){
  102334. assert( argc==1 );
  102335. UNUSED_PARAMETER(argc);
  102336. switch( sqlite3_value_type(argv[0]) ){
  102337. case SQLITE_BLOB:
  102338. case SQLITE_INTEGER:
  102339. case SQLITE_FLOAT: {
  102340. sqlite3_result_int(context, sqlite3_value_bytes(argv[0]));
  102341. break;
  102342. }
  102343. case SQLITE_TEXT: {
  102344. const unsigned char *z = sqlite3_value_text(argv[0]);
  102345. const unsigned char *z0;
  102346. unsigned char c;
  102347. if( z==0 ) return;
  102348. z0 = z;
  102349. while( (c = *z)!=0 ){
  102350. z++;
  102351. if( c>=0xc0 ){
  102352. while( (*z & 0xc0)==0x80 ){ z++; z0++; }
  102353. }
  102354. }
  102355. sqlite3_result_int(context, (int)(z-z0));
  102356. break;
  102357. }
  102358. default: {
  102359. sqlite3_result_null(context);
  102360. break;
  102361. }
  102362. }
  102363. }
  102364. /*
  102365. ** Implementation of the abs() function.
  102366. **
  102367. ** IMP: R-23979-26855 The abs(X) function returns the absolute value of
  102368. ** the numeric argument X.
  102369. */
  102370. static void absFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  102371. assert( argc==1 );
  102372. UNUSED_PARAMETER(argc);
  102373. switch( sqlite3_value_type(argv[0]) ){
  102374. case SQLITE_INTEGER: {
  102375. i64 iVal = sqlite3_value_int64(argv[0]);
  102376. if( iVal<0 ){
  102377. if( iVal==SMALLEST_INT64 ){
  102378. /* IMP: R-31676-45509 If X is the integer -9223372036854775808
  102379. ** then abs(X) throws an integer overflow error since there is no
  102380. ** equivalent positive 64-bit two complement value. */
  102381. sqlite3_result_error(context, "integer overflow", -1);
  102382. return;
  102383. }
  102384. iVal = -iVal;
  102385. }
  102386. sqlite3_result_int64(context, iVal);
  102387. break;
  102388. }
  102389. case SQLITE_NULL: {
  102390. /* IMP: R-37434-19929 Abs(X) returns NULL if X is NULL. */
  102391. sqlite3_result_null(context);
  102392. break;
  102393. }
  102394. default: {
  102395. /* Because sqlite3_value_double() returns 0.0 if the argument is not
  102396. ** something that can be converted into a number, we have:
  102397. ** IMP: R-01992-00519 Abs(X) returns 0.0 if X is a string or blob
  102398. ** that cannot be converted to a numeric value.
  102399. */
  102400. double rVal = sqlite3_value_double(argv[0]);
  102401. if( rVal<0 ) rVal = -rVal;
  102402. sqlite3_result_double(context, rVal);
  102403. break;
  102404. }
  102405. }
  102406. }
  102407. /*
  102408. ** Implementation of the instr() function.
  102409. **
  102410. ** instr(haystack,needle) finds the first occurrence of needle
  102411. ** in haystack and returns the number of previous characters plus 1,
  102412. ** or 0 if needle does not occur within haystack.
  102413. **
  102414. ** If both haystack and needle are BLOBs, then the result is one more than
  102415. ** the number of bytes in haystack prior to the first occurrence of needle,
  102416. ** or 0 if needle never occurs in haystack.
  102417. */
  102418. static void instrFunc(
  102419. sqlite3_context *context,
  102420. int argc,
  102421. sqlite3_value **argv
  102422. ){
  102423. const unsigned char *zHaystack;
  102424. const unsigned char *zNeedle;
  102425. int nHaystack;
  102426. int nNeedle;
  102427. int typeHaystack, typeNeedle;
  102428. int N = 1;
  102429. int isText;
  102430. UNUSED_PARAMETER(argc);
  102431. typeHaystack = sqlite3_value_type(argv[0]);
  102432. typeNeedle = sqlite3_value_type(argv[1]);
  102433. if( typeHaystack==SQLITE_NULL || typeNeedle==SQLITE_NULL ) return;
  102434. nHaystack = sqlite3_value_bytes(argv[0]);
  102435. nNeedle = sqlite3_value_bytes(argv[1]);
  102436. if( nNeedle>0 ){
  102437. if( typeHaystack==SQLITE_BLOB && typeNeedle==SQLITE_BLOB ){
  102438. zHaystack = sqlite3_value_blob(argv[0]);
  102439. zNeedle = sqlite3_value_blob(argv[1]);
  102440. isText = 0;
  102441. }else{
  102442. zHaystack = sqlite3_value_text(argv[0]);
  102443. zNeedle = sqlite3_value_text(argv[1]);
  102444. isText = 1;
  102445. }
  102446. if( zNeedle==0 || (nHaystack && zHaystack==0) ) return;
  102447. while( nNeedle<=nHaystack && memcmp(zHaystack, zNeedle, nNeedle)!=0 ){
  102448. N++;
  102449. do{
  102450. nHaystack--;
  102451. zHaystack++;
  102452. }while( isText && (zHaystack[0]&0xc0)==0x80 );
  102453. }
  102454. if( nNeedle>nHaystack ) N = 0;
  102455. }
  102456. sqlite3_result_int(context, N);
  102457. }
  102458. /*
  102459. ** Implementation of the printf() function.
  102460. */
  102461. static void printfFunc(
  102462. sqlite3_context *context,
  102463. int argc,
  102464. sqlite3_value **argv
  102465. ){
  102466. PrintfArguments x;
  102467. StrAccum str;
  102468. const char *zFormat;
  102469. int n;
  102470. sqlite3 *db = sqlite3_context_db_handle(context);
  102471. if( argc>=1 && (zFormat = (const char*)sqlite3_value_text(argv[0]))!=0 ){
  102472. x.nArg = argc-1;
  102473. x.nUsed = 0;
  102474. x.apArg = argv+1;
  102475. sqlite3StrAccumInit(&str, db, 0, 0, db->aLimit[SQLITE_LIMIT_LENGTH]);
  102476. str.printfFlags = SQLITE_PRINTF_SQLFUNC;
  102477. sqlite3XPrintf(&str, zFormat, &x);
  102478. n = str.nChar;
  102479. sqlite3_result_text(context, sqlite3StrAccumFinish(&str), n,
  102480. SQLITE_DYNAMIC);
  102481. }
  102482. }
  102483. /*
  102484. ** Implementation of the substr() function.
  102485. **
  102486. ** substr(x,p1,p2) returns p2 characters of x[] beginning with p1.
  102487. ** p1 is 1-indexed. So substr(x,1,1) returns the first character
  102488. ** of x. If x is text, then we actually count UTF-8 characters.
  102489. ** If x is a blob, then we count bytes.
  102490. **
  102491. ** If p1 is negative, then we begin abs(p1) from the end of x[].
  102492. **
  102493. ** If p2 is negative, return the p2 characters preceding p1.
  102494. */
  102495. static void substrFunc(
  102496. sqlite3_context *context,
  102497. int argc,
  102498. sqlite3_value **argv
  102499. ){
  102500. const unsigned char *z;
  102501. const unsigned char *z2;
  102502. int len;
  102503. int p0type;
  102504. i64 p1, p2;
  102505. int negP2 = 0;
  102506. assert( argc==3 || argc==2 );
  102507. if( sqlite3_value_type(argv[1])==SQLITE_NULL
  102508. || (argc==3 && sqlite3_value_type(argv[2])==SQLITE_NULL)
  102509. ){
  102510. return;
  102511. }
  102512. p0type = sqlite3_value_type(argv[0]);
  102513. p1 = sqlite3_value_int(argv[1]);
  102514. if( p0type==SQLITE_BLOB ){
  102515. len = sqlite3_value_bytes(argv[0]);
  102516. z = sqlite3_value_blob(argv[0]);
  102517. if( z==0 ) return;
  102518. assert( len==sqlite3_value_bytes(argv[0]) );
  102519. }else{
  102520. z = sqlite3_value_text(argv[0]);
  102521. if( z==0 ) return;
  102522. len = 0;
  102523. if( p1<0 ){
  102524. for(z2=z; *z2; len++){
  102525. SQLITE_SKIP_UTF8(z2);
  102526. }
  102527. }
  102528. }
  102529. #ifdef SQLITE_SUBSTR_COMPATIBILITY
  102530. /* If SUBSTR_COMPATIBILITY is defined then substr(X,0,N) work the same as
  102531. ** as substr(X,1,N) - it returns the first N characters of X. This
  102532. ** is essentially a back-out of the bug-fix in check-in [5fc125d362df4b8]
  102533. ** from 2009-02-02 for compatibility of applications that exploited the
  102534. ** old buggy behavior. */
  102535. if( p1==0 ) p1 = 1; /* <rdar://problem/6778339> */
  102536. #endif
  102537. if( argc==3 ){
  102538. p2 = sqlite3_value_int(argv[2]);
  102539. if( p2<0 ){
  102540. p2 = -p2;
  102541. negP2 = 1;
  102542. }
  102543. }else{
  102544. p2 = sqlite3_context_db_handle(context)->aLimit[SQLITE_LIMIT_LENGTH];
  102545. }
  102546. if( p1<0 ){
  102547. p1 += len;
  102548. if( p1<0 ){
  102549. p2 += p1;
  102550. if( p2<0 ) p2 = 0;
  102551. p1 = 0;
  102552. }
  102553. }else if( p1>0 ){
  102554. p1--;
  102555. }else if( p2>0 ){
  102556. p2--;
  102557. }
  102558. if( negP2 ){
  102559. p1 -= p2;
  102560. if( p1<0 ){
  102561. p2 += p1;
  102562. p1 = 0;
  102563. }
  102564. }
  102565. assert( p1>=0 && p2>=0 );
  102566. if( p0type!=SQLITE_BLOB ){
  102567. while( *z && p1 ){
  102568. SQLITE_SKIP_UTF8(z);
  102569. p1--;
  102570. }
  102571. for(z2=z; *z2 && p2; p2--){
  102572. SQLITE_SKIP_UTF8(z2);
  102573. }
  102574. sqlite3_result_text64(context, (char*)z, z2-z, SQLITE_TRANSIENT,
  102575. SQLITE_UTF8);
  102576. }else{
  102577. if( p1+p2>len ){
  102578. p2 = len-p1;
  102579. if( p2<0 ) p2 = 0;
  102580. }
  102581. sqlite3_result_blob64(context, (char*)&z[p1], (u64)p2, SQLITE_TRANSIENT);
  102582. }
  102583. }
  102584. /*
  102585. ** Implementation of the round() function
  102586. */
  102587. #ifndef SQLITE_OMIT_FLOATING_POINT
  102588. static void roundFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  102589. int n = 0;
  102590. double r;
  102591. char *zBuf;
  102592. assert( argc==1 || argc==2 );
  102593. if( argc==2 ){
  102594. if( SQLITE_NULL==sqlite3_value_type(argv[1]) ) return;
  102595. n = sqlite3_value_int(argv[1]);
  102596. if( n>30 ) n = 30;
  102597. if( n<0 ) n = 0;
  102598. }
  102599. if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
  102600. r = sqlite3_value_double(argv[0]);
  102601. /* If Y==0 and X will fit in a 64-bit int,
  102602. ** handle the rounding directly,
  102603. ** otherwise use printf.
  102604. */
  102605. if( n==0 && r>=0 && r<LARGEST_INT64-1 ){
  102606. r = (double)((sqlite_int64)(r+0.5));
  102607. }else if( n==0 && r<0 && (-r)<LARGEST_INT64-1 ){
  102608. r = -(double)((sqlite_int64)((-r)+0.5));
  102609. }else{
  102610. zBuf = sqlite3_mprintf("%.*f",n,r);
  102611. if( zBuf==0 ){
  102612. sqlite3_result_error_nomem(context);
  102613. return;
  102614. }
  102615. sqlite3AtoF(zBuf, &r, sqlite3Strlen30(zBuf), SQLITE_UTF8);
  102616. sqlite3_free(zBuf);
  102617. }
  102618. sqlite3_result_double(context, r);
  102619. }
  102620. #endif
  102621. /*
  102622. ** Allocate nByte bytes of space using sqlite3Malloc(). If the
  102623. ** allocation fails, call sqlite3_result_error_nomem() to notify
  102624. ** the database handle that malloc() has failed and return NULL.
  102625. ** If nByte is larger than the maximum string or blob length, then
  102626. ** raise an SQLITE_TOOBIG exception and return NULL.
  102627. */
  102628. static void *contextMalloc(sqlite3_context *context, i64 nByte){
  102629. char *z;
  102630. sqlite3 *db = sqlite3_context_db_handle(context);
  102631. assert( nByte>0 );
  102632. testcase( nByte==db->aLimit[SQLITE_LIMIT_LENGTH] );
  102633. testcase( nByte==db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
  102634. if( nByte>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  102635. sqlite3_result_error_toobig(context);
  102636. z = 0;
  102637. }else{
  102638. z = sqlite3Malloc(nByte);
  102639. if( !z ){
  102640. sqlite3_result_error_nomem(context);
  102641. }
  102642. }
  102643. return z;
  102644. }
  102645. /*
  102646. ** Implementation of the upper() and lower() SQL functions.
  102647. */
  102648. static void upperFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  102649. char *z1;
  102650. const char *z2;
  102651. int i, n;
  102652. UNUSED_PARAMETER(argc);
  102653. z2 = (char*)sqlite3_value_text(argv[0]);
  102654. n = sqlite3_value_bytes(argv[0]);
  102655. /* Verify that the call to _bytes() does not invalidate the _text() pointer */
  102656. assert( z2==(char*)sqlite3_value_text(argv[0]) );
  102657. if( z2 ){
  102658. z1 = contextMalloc(context, ((i64)n)+1);
  102659. if( z1 ){
  102660. for(i=0; i<n; i++){
  102661. z1[i] = (char)sqlite3Toupper(z2[i]);
  102662. }
  102663. sqlite3_result_text(context, z1, n, sqlite3_free);
  102664. }
  102665. }
  102666. }
  102667. static void lowerFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  102668. char *z1;
  102669. const char *z2;
  102670. int i, n;
  102671. UNUSED_PARAMETER(argc);
  102672. z2 = (char*)sqlite3_value_text(argv[0]);
  102673. n = sqlite3_value_bytes(argv[0]);
  102674. /* Verify that the call to _bytes() does not invalidate the _text() pointer */
  102675. assert( z2==(char*)sqlite3_value_text(argv[0]) );
  102676. if( z2 ){
  102677. z1 = contextMalloc(context, ((i64)n)+1);
  102678. if( z1 ){
  102679. for(i=0; i<n; i++){
  102680. z1[i] = sqlite3Tolower(z2[i]);
  102681. }
  102682. sqlite3_result_text(context, z1, n, sqlite3_free);
  102683. }
  102684. }
  102685. }
  102686. /*
  102687. ** Some functions like COALESCE() and IFNULL() and UNLIKELY() are implemented
  102688. ** as VDBE code so that unused argument values do not have to be computed.
  102689. ** However, we still need some kind of function implementation for this
  102690. ** routines in the function table. The noopFunc macro provides this.
  102691. ** noopFunc will never be called so it doesn't matter what the implementation
  102692. ** is. We might as well use the "version()" function as a substitute.
  102693. */
  102694. #define noopFunc versionFunc /* Substitute function - never called */
  102695. /*
  102696. ** Implementation of random(). Return a random integer.
  102697. */
  102698. static void randomFunc(
  102699. sqlite3_context *context,
  102700. int NotUsed,
  102701. sqlite3_value **NotUsed2
  102702. ){
  102703. sqlite_int64 r;
  102704. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  102705. sqlite3_randomness(sizeof(r), &r);
  102706. if( r<0 ){
  102707. /* We need to prevent a random number of 0x8000000000000000
  102708. ** (or -9223372036854775808) since when you do abs() of that
  102709. ** number of you get the same value back again. To do this
  102710. ** in a way that is testable, mask the sign bit off of negative
  102711. ** values, resulting in a positive value. Then take the
  102712. ** 2s complement of that positive value. The end result can
  102713. ** therefore be no less than -9223372036854775807.
  102714. */
  102715. r = -(r & LARGEST_INT64);
  102716. }
  102717. sqlite3_result_int64(context, r);
  102718. }
  102719. /*
  102720. ** Implementation of randomblob(N). Return a random blob
  102721. ** that is N bytes long.
  102722. */
  102723. static void randomBlob(
  102724. sqlite3_context *context,
  102725. int argc,
  102726. sqlite3_value **argv
  102727. ){
  102728. int n;
  102729. unsigned char *p;
  102730. assert( argc==1 );
  102731. UNUSED_PARAMETER(argc);
  102732. n = sqlite3_value_int(argv[0]);
  102733. if( n<1 ){
  102734. n = 1;
  102735. }
  102736. p = contextMalloc(context, n);
  102737. if( p ){
  102738. sqlite3_randomness(n, p);
  102739. sqlite3_result_blob(context, (char*)p, n, sqlite3_free);
  102740. }
  102741. }
  102742. /*
  102743. ** Implementation of the last_insert_rowid() SQL function. The return
  102744. ** value is the same as the sqlite3_last_insert_rowid() API function.
  102745. */
  102746. static void last_insert_rowid(
  102747. sqlite3_context *context,
  102748. int NotUsed,
  102749. sqlite3_value **NotUsed2
  102750. ){
  102751. sqlite3 *db = sqlite3_context_db_handle(context);
  102752. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  102753. /* IMP: R-51513-12026 The last_insert_rowid() SQL function is a
  102754. ** wrapper around the sqlite3_last_insert_rowid() C/C++ interface
  102755. ** function. */
  102756. sqlite3_result_int64(context, sqlite3_last_insert_rowid(db));
  102757. }
  102758. /*
  102759. ** Implementation of the changes() SQL function.
  102760. **
  102761. ** IMP: R-62073-11209 The changes() SQL function is a wrapper
  102762. ** around the sqlite3_changes() C/C++ function and hence follows the same
  102763. ** rules for counting changes.
  102764. */
  102765. static void changes(
  102766. sqlite3_context *context,
  102767. int NotUsed,
  102768. sqlite3_value **NotUsed2
  102769. ){
  102770. sqlite3 *db = sqlite3_context_db_handle(context);
  102771. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  102772. sqlite3_result_int(context, sqlite3_changes(db));
  102773. }
  102774. /*
  102775. ** Implementation of the total_changes() SQL function. The return value is
  102776. ** the same as the sqlite3_total_changes() API function.
  102777. */
  102778. static void total_changes(
  102779. sqlite3_context *context,
  102780. int NotUsed,
  102781. sqlite3_value **NotUsed2
  102782. ){
  102783. sqlite3 *db = sqlite3_context_db_handle(context);
  102784. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  102785. /* IMP: R-52756-41993 This function is a wrapper around the
  102786. ** sqlite3_total_changes() C/C++ interface. */
  102787. sqlite3_result_int(context, sqlite3_total_changes(db));
  102788. }
  102789. /*
  102790. ** A structure defining how to do GLOB-style comparisons.
  102791. */
  102792. struct compareInfo {
  102793. u8 matchAll; /* "*" or "%" */
  102794. u8 matchOne; /* "?" or "_" */
  102795. u8 matchSet; /* "[" or 0 */
  102796. u8 noCase; /* true to ignore case differences */
  102797. };
  102798. /*
  102799. ** For LIKE and GLOB matching on EBCDIC machines, assume that every
  102800. ** character is exactly one byte in size. Also, provde the Utf8Read()
  102801. ** macro for fast reading of the next character in the common case where
  102802. ** the next character is ASCII.
  102803. */
  102804. #if defined(SQLITE_EBCDIC)
  102805. # define sqlite3Utf8Read(A) (*((*A)++))
  102806. # define Utf8Read(A) (*(A++))
  102807. #else
  102808. # define Utf8Read(A) (A[0]<0x80?*(A++):sqlite3Utf8Read(&A))
  102809. #endif
  102810. static const struct compareInfo globInfo = { '*', '?', '[', 0 };
  102811. /* The correct SQL-92 behavior is for the LIKE operator to ignore
  102812. ** case. Thus 'a' LIKE 'A' would be true. */
  102813. static const struct compareInfo likeInfoNorm = { '%', '_', 0, 1 };
  102814. /* If SQLITE_CASE_SENSITIVE_LIKE is defined, then the LIKE operator
  102815. ** is case sensitive causing 'a' LIKE 'A' to be false */
  102816. static const struct compareInfo likeInfoAlt = { '%', '_', 0, 0 };
  102817. /*
  102818. ** Possible error returns from patternMatch()
  102819. */
  102820. #define SQLITE_MATCH 0
  102821. #define SQLITE_NOMATCH 1
  102822. #define SQLITE_NOWILDCARDMATCH 2
  102823. /*
  102824. ** Compare two UTF-8 strings for equality where the first string is
  102825. ** a GLOB or LIKE expression. Return values:
  102826. **
  102827. ** SQLITE_MATCH: Match
  102828. ** SQLITE_NOMATCH: No match
  102829. ** SQLITE_NOWILDCARDMATCH: No match in spite of having * or % wildcards.
  102830. **
  102831. ** Globbing rules:
  102832. **
  102833. ** '*' Matches any sequence of zero or more characters.
  102834. **
  102835. ** '?' Matches exactly one character.
  102836. **
  102837. ** [...] Matches one character from the enclosed list of
  102838. ** characters.
  102839. **
  102840. ** [^...] Matches one character not in the enclosed list.
  102841. **
  102842. ** With the [...] and [^...] matching, a ']' character can be included
  102843. ** in the list by making it the first character after '[' or '^'. A
  102844. ** range of characters can be specified using '-'. Example:
  102845. ** "[a-z]" matches any single lower-case letter. To match a '-', make
  102846. ** it the last character in the list.
  102847. **
  102848. ** Like matching rules:
  102849. **
  102850. ** '%' Matches any sequence of zero or more characters
  102851. **
  102852. *** '_' Matches any one character
  102853. **
  102854. ** Ec Where E is the "esc" character and c is any other
  102855. ** character, including '%', '_', and esc, match exactly c.
  102856. **
  102857. ** The comments within this routine usually assume glob matching.
  102858. **
  102859. ** This routine is usually quick, but can be N**2 in the worst case.
  102860. */
  102861. static int patternCompare(
  102862. const u8 *zPattern, /* The glob pattern */
  102863. const u8 *zString, /* The string to compare against the glob */
  102864. const struct compareInfo *pInfo, /* Information about how to do the compare */
  102865. u32 matchOther /* The escape char (LIKE) or '[' (GLOB) */
  102866. ){
  102867. u32 c, c2; /* Next pattern and input string chars */
  102868. u32 matchOne = pInfo->matchOne; /* "?" or "_" */
  102869. u32 matchAll = pInfo->matchAll; /* "*" or "%" */
  102870. u8 noCase = pInfo->noCase; /* True if uppercase==lowercase */
  102871. const u8 *zEscaped = 0; /* One past the last escaped input char */
  102872. while( (c = Utf8Read(zPattern))!=0 ){
  102873. if( c==matchAll ){ /* Match "*" */
  102874. /* Skip over multiple "*" characters in the pattern. If there
  102875. ** are also "?" characters, skip those as well, but consume a
  102876. ** single character of the input string for each "?" skipped */
  102877. while( (c=Utf8Read(zPattern)) == matchAll || c == matchOne ){
  102878. if( c==matchOne && sqlite3Utf8Read(&zString)==0 ){
  102879. return SQLITE_NOWILDCARDMATCH;
  102880. }
  102881. }
  102882. if( c==0 ){
  102883. return SQLITE_MATCH; /* "*" at the end of the pattern matches */
  102884. }else if( c==matchOther ){
  102885. if( pInfo->matchSet==0 ){
  102886. c = sqlite3Utf8Read(&zPattern);
  102887. if( c==0 ) return SQLITE_NOWILDCARDMATCH;
  102888. }else{
  102889. /* "[...]" immediately follows the "*". We have to do a slow
  102890. ** recursive search in this case, but it is an unusual case. */
  102891. assert( matchOther<0x80 ); /* '[' is a single-byte character */
  102892. while( *zString ){
  102893. int bMatch = patternCompare(&zPattern[-1],zString,pInfo,matchOther);
  102894. if( bMatch!=SQLITE_NOMATCH ) return bMatch;
  102895. SQLITE_SKIP_UTF8(zString);
  102896. }
  102897. return SQLITE_NOWILDCARDMATCH;
  102898. }
  102899. }
  102900. /* At this point variable c contains the first character of the
  102901. ** pattern string past the "*". Search in the input string for the
  102902. ** first matching character and recursively continue the match from
  102903. ** that point.
  102904. **
  102905. ** For a case-insensitive search, set variable cx to be the same as
  102906. ** c but in the other case and search the input string for either
  102907. ** c or cx.
  102908. */
  102909. if( c<=0x80 ){
  102910. char zStop[3];
  102911. int bMatch;
  102912. if( noCase ){
  102913. zStop[0] = sqlite3Toupper(c);
  102914. zStop[1] = sqlite3Tolower(c);
  102915. zStop[2] = 0;
  102916. }else{
  102917. zStop[0] = c;
  102918. zStop[1] = 0;
  102919. }
  102920. while(1){
  102921. zString += strcspn((const char*)zString, zStop);
  102922. if( zString[0]==0 ) break;
  102923. zString++;
  102924. bMatch = patternCompare(zPattern,zString,pInfo,matchOther);
  102925. if( bMatch!=SQLITE_NOMATCH ) return bMatch;
  102926. }
  102927. }else{
  102928. int bMatch;
  102929. while( (c2 = Utf8Read(zString))!=0 ){
  102930. if( c2!=c ) continue;
  102931. bMatch = patternCompare(zPattern,zString,pInfo,matchOther);
  102932. if( bMatch!=SQLITE_NOMATCH ) return bMatch;
  102933. }
  102934. }
  102935. return SQLITE_NOWILDCARDMATCH;
  102936. }
  102937. if( c==matchOther ){
  102938. if( pInfo->matchSet==0 ){
  102939. c = sqlite3Utf8Read(&zPattern);
  102940. if( c==0 ) return SQLITE_NOMATCH;
  102941. zEscaped = zPattern;
  102942. }else{
  102943. u32 prior_c = 0;
  102944. int seen = 0;
  102945. int invert = 0;
  102946. c = sqlite3Utf8Read(&zString);
  102947. if( c==0 ) return SQLITE_NOMATCH;
  102948. c2 = sqlite3Utf8Read(&zPattern);
  102949. if( c2=='^' ){
  102950. invert = 1;
  102951. c2 = sqlite3Utf8Read(&zPattern);
  102952. }
  102953. if( c2==']' ){
  102954. if( c==']' ) seen = 1;
  102955. c2 = sqlite3Utf8Read(&zPattern);
  102956. }
  102957. while( c2 && c2!=']' ){
  102958. if( c2=='-' && zPattern[0]!=']' && zPattern[0]!=0 && prior_c>0 ){
  102959. c2 = sqlite3Utf8Read(&zPattern);
  102960. if( c>=prior_c && c<=c2 ) seen = 1;
  102961. prior_c = 0;
  102962. }else{
  102963. if( c==c2 ){
  102964. seen = 1;
  102965. }
  102966. prior_c = c2;
  102967. }
  102968. c2 = sqlite3Utf8Read(&zPattern);
  102969. }
  102970. if( c2==0 || (seen ^ invert)==0 ){
  102971. return SQLITE_NOMATCH;
  102972. }
  102973. continue;
  102974. }
  102975. }
  102976. c2 = Utf8Read(zString);
  102977. if( c==c2 ) continue;
  102978. if( noCase && sqlite3Tolower(c)==sqlite3Tolower(c2) && c<0x80 && c2<0x80 ){
  102979. continue;
  102980. }
  102981. if( c==matchOne && zPattern!=zEscaped && c2!=0 ) continue;
  102982. return SQLITE_NOMATCH;
  102983. }
  102984. return *zString==0 ? SQLITE_MATCH : SQLITE_NOMATCH;
  102985. }
  102986. /*
  102987. ** The sqlite3_strglob() interface. Return 0 on a match (like strcmp()) and
  102988. ** non-zero if there is no match.
  102989. */
  102990. SQLITE_API int sqlite3_strglob(const char *zGlobPattern, const char *zString){
  102991. return patternCompare((u8*)zGlobPattern, (u8*)zString, &globInfo, '[');
  102992. }
  102993. /*
  102994. ** The sqlite3_strlike() interface. Return 0 on a match and non-zero for
  102995. ** a miss - like strcmp().
  102996. */
  102997. SQLITE_API int sqlite3_strlike(const char *zPattern, const char *zStr, unsigned int esc){
  102998. return patternCompare((u8*)zPattern, (u8*)zStr, &likeInfoNorm, esc);
  102999. }
  103000. /*
  103001. ** Count the number of times that the LIKE operator (or GLOB which is
  103002. ** just a variation of LIKE) gets called. This is used for testing
  103003. ** only.
  103004. */
  103005. #ifdef SQLITE_TEST
  103006. SQLITE_API int sqlite3_like_count = 0;
  103007. #endif
  103008. /*
  103009. ** Implementation of the like() SQL function. This function implements
  103010. ** the build-in LIKE operator. The first argument to the function is the
  103011. ** pattern and the second argument is the string. So, the SQL statements:
  103012. **
  103013. ** A LIKE B
  103014. **
  103015. ** is implemented as like(B,A).
  103016. **
  103017. ** This same function (with a different compareInfo structure) computes
  103018. ** the GLOB operator.
  103019. */
  103020. static void likeFunc(
  103021. sqlite3_context *context,
  103022. int argc,
  103023. sqlite3_value **argv
  103024. ){
  103025. const unsigned char *zA, *zB;
  103026. u32 escape;
  103027. int nPat;
  103028. sqlite3 *db = sqlite3_context_db_handle(context);
  103029. struct compareInfo *pInfo = sqlite3_user_data(context);
  103030. #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  103031. if( sqlite3_value_type(argv[0])==SQLITE_BLOB
  103032. || sqlite3_value_type(argv[1])==SQLITE_BLOB
  103033. ){
  103034. #ifdef SQLITE_TEST
  103035. sqlite3_like_count++;
  103036. #endif
  103037. sqlite3_result_int(context, 0);
  103038. return;
  103039. }
  103040. #endif
  103041. zB = sqlite3_value_text(argv[0]);
  103042. zA = sqlite3_value_text(argv[1]);
  103043. /* Limit the length of the LIKE or GLOB pattern to avoid problems
  103044. ** of deep recursion and N*N behavior in patternCompare().
  103045. */
  103046. nPat = sqlite3_value_bytes(argv[0]);
  103047. testcase( nPat==db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH] );
  103048. testcase( nPat==db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]+1 );
  103049. if( nPat > db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH] ){
  103050. sqlite3_result_error(context, "LIKE or GLOB pattern too complex", -1);
  103051. return;
  103052. }
  103053. assert( zB==sqlite3_value_text(argv[0]) ); /* Encoding did not change */
  103054. if( argc==3 ){
  103055. /* The escape character string must consist of a single UTF-8 character.
  103056. ** Otherwise, return an error.
  103057. */
  103058. const unsigned char *zEsc = sqlite3_value_text(argv[2]);
  103059. if( zEsc==0 ) return;
  103060. if( sqlite3Utf8CharLen((char*)zEsc, -1)!=1 ){
  103061. sqlite3_result_error(context,
  103062. "ESCAPE expression must be a single character", -1);
  103063. return;
  103064. }
  103065. escape = sqlite3Utf8Read(&zEsc);
  103066. }else{
  103067. escape = pInfo->matchSet;
  103068. }
  103069. if( zA && zB ){
  103070. #ifdef SQLITE_TEST
  103071. sqlite3_like_count++;
  103072. #endif
  103073. sqlite3_result_int(context,
  103074. patternCompare(zB, zA, pInfo, escape)==SQLITE_MATCH);
  103075. }
  103076. }
  103077. /*
  103078. ** Implementation of the NULLIF(x,y) function. The result is the first
  103079. ** argument if the arguments are different. The result is NULL if the
  103080. ** arguments are equal to each other.
  103081. */
  103082. static void nullifFunc(
  103083. sqlite3_context *context,
  103084. int NotUsed,
  103085. sqlite3_value **argv
  103086. ){
  103087. CollSeq *pColl = sqlite3GetFuncCollSeq(context);
  103088. UNUSED_PARAMETER(NotUsed);
  103089. if( sqlite3MemCompare(argv[0], argv[1], pColl)!=0 ){
  103090. sqlite3_result_value(context, argv[0]);
  103091. }
  103092. }
  103093. /*
  103094. ** Implementation of the sqlite_version() function. The result is the version
  103095. ** of the SQLite library that is running.
  103096. */
  103097. static void versionFunc(
  103098. sqlite3_context *context,
  103099. int NotUsed,
  103100. sqlite3_value **NotUsed2
  103101. ){
  103102. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  103103. /* IMP: R-48699-48617 This function is an SQL wrapper around the
  103104. ** sqlite3_libversion() C-interface. */
  103105. sqlite3_result_text(context, sqlite3_libversion(), -1, SQLITE_STATIC);
  103106. }
  103107. /*
  103108. ** Implementation of the sqlite_source_id() function. The result is a string
  103109. ** that identifies the particular version of the source code used to build
  103110. ** SQLite.
  103111. */
  103112. static void sourceidFunc(
  103113. sqlite3_context *context,
  103114. int NotUsed,
  103115. sqlite3_value **NotUsed2
  103116. ){
  103117. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  103118. /* IMP: R-24470-31136 This function is an SQL wrapper around the
  103119. ** sqlite3_sourceid() C interface. */
  103120. sqlite3_result_text(context, sqlite3_sourceid(), -1, SQLITE_STATIC);
  103121. }
  103122. /*
  103123. ** Implementation of the sqlite_log() function. This is a wrapper around
  103124. ** sqlite3_log(). The return value is NULL. The function exists purely for
  103125. ** its side-effects.
  103126. */
  103127. static void errlogFunc(
  103128. sqlite3_context *context,
  103129. int argc,
  103130. sqlite3_value **argv
  103131. ){
  103132. UNUSED_PARAMETER(argc);
  103133. UNUSED_PARAMETER(context);
  103134. sqlite3_log(sqlite3_value_int(argv[0]), "%s", sqlite3_value_text(argv[1]));
  103135. }
  103136. /*
  103137. ** Implementation of the sqlite_compileoption_used() function.
  103138. ** The result is an integer that identifies if the compiler option
  103139. ** was used to build SQLite.
  103140. */
  103141. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  103142. static void compileoptionusedFunc(
  103143. sqlite3_context *context,
  103144. int argc,
  103145. sqlite3_value **argv
  103146. ){
  103147. const char *zOptName;
  103148. assert( argc==1 );
  103149. UNUSED_PARAMETER(argc);
  103150. /* IMP: R-39564-36305 The sqlite_compileoption_used() SQL
  103151. ** function is a wrapper around the sqlite3_compileoption_used() C/C++
  103152. ** function.
  103153. */
  103154. if( (zOptName = (const char*)sqlite3_value_text(argv[0]))!=0 ){
  103155. sqlite3_result_int(context, sqlite3_compileoption_used(zOptName));
  103156. }
  103157. }
  103158. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  103159. /*
  103160. ** Implementation of the sqlite_compileoption_get() function.
  103161. ** The result is a string that identifies the compiler options
  103162. ** used to build SQLite.
  103163. */
  103164. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  103165. static void compileoptiongetFunc(
  103166. sqlite3_context *context,
  103167. int argc,
  103168. sqlite3_value **argv
  103169. ){
  103170. int n;
  103171. assert( argc==1 );
  103172. UNUSED_PARAMETER(argc);
  103173. /* IMP: R-04922-24076 The sqlite_compileoption_get() SQL function
  103174. ** is a wrapper around the sqlite3_compileoption_get() C/C++ function.
  103175. */
  103176. n = sqlite3_value_int(argv[0]);
  103177. sqlite3_result_text(context, sqlite3_compileoption_get(n), -1, SQLITE_STATIC);
  103178. }
  103179. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  103180. /* Array for converting from half-bytes (nybbles) into ASCII hex
  103181. ** digits. */
  103182. static const char hexdigits[] = {
  103183. '0', '1', '2', '3', '4', '5', '6', '7',
  103184. '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
  103185. };
  103186. /*
  103187. ** Implementation of the QUOTE() function. This function takes a single
  103188. ** argument. If the argument is numeric, the return value is the same as
  103189. ** the argument. If the argument is NULL, the return value is the string
  103190. ** "NULL". Otherwise, the argument is enclosed in single quotes with
  103191. ** single-quote escapes.
  103192. */
  103193. static void quoteFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
  103194. assert( argc==1 );
  103195. UNUSED_PARAMETER(argc);
  103196. switch( sqlite3_value_type(argv[0]) ){
  103197. case SQLITE_FLOAT: {
  103198. double r1, r2;
  103199. char zBuf[50];
  103200. r1 = sqlite3_value_double(argv[0]);
  103201. sqlite3_snprintf(sizeof(zBuf), zBuf, "%!.15g", r1);
  103202. sqlite3AtoF(zBuf, &r2, 20, SQLITE_UTF8);
  103203. if( r1!=r2 ){
  103204. sqlite3_snprintf(sizeof(zBuf), zBuf, "%!.20e", r1);
  103205. }
  103206. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  103207. break;
  103208. }
  103209. case SQLITE_INTEGER: {
  103210. sqlite3_result_value(context, argv[0]);
  103211. break;
  103212. }
  103213. case SQLITE_BLOB: {
  103214. char *zText = 0;
  103215. char const *zBlob = sqlite3_value_blob(argv[0]);
  103216. int nBlob = sqlite3_value_bytes(argv[0]);
  103217. assert( zBlob==sqlite3_value_blob(argv[0]) ); /* No encoding change */
  103218. zText = (char *)contextMalloc(context, (2*(i64)nBlob)+4);
  103219. if( zText ){
  103220. int i;
  103221. for(i=0; i<nBlob; i++){
  103222. zText[(i*2)+2] = hexdigits[(zBlob[i]>>4)&0x0F];
  103223. zText[(i*2)+3] = hexdigits[(zBlob[i])&0x0F];
  103224. }
  103225. zText[(nBlob*2)+2] = '\'';
  103226. zText[(nBlob*2)+3] = '\0';
  103227. zText[0] = 'X';
  103228. zText[1] = '\'';
  103229. sqlite3_result_text(context, zText, -1, SQLITE_TRANSIENT);
  103230. sqlite3_free(zText);
  103231. }
  103232. break;
  103233. }
  103234. case SQLITE_TEXT: {
  103235. int i,j;
  103236. u64 n;
  103237. const unsigned char *zArg = sqlite3_value_text(argv[0]);
  103238. char *z;
  103239. if( zArg==0 ) return;
  103240. for(i=0, n=0; zArg[i]; i++){ if( zArg[i]=='\'' ) n++; }
  103241. z = contextMalloc(context, ((i64)i)+((i64)n)+3);
  103242. if( z ){
  103243. z[0] = '\'';
  103244. for(i=0, j=1; zArg[i]; i++){
  103245. z[j++] = zArg[i];
  103246. if( zArg[i]=='\'' ){
  103247. z[j++] = '\'';
  103248. }
  103249. }
  103250. z[j++] = '\'';
  103251. z[j] = 0;
  103252. sqlite3_result_text(context, z, j, sqlite3_free);
  103253. }
  103254. break;
  103255. }
  103256. default: {
  103257. assert( sqlite3_value_type(argv[0])==SQLITE_NULL );
  103258. sqlite3_result_text(context, "NULL", 4, SQLITE_STATIC);
  103259. break;
  103260. }
  103261. }
  103262. }
  103263. /*
  103264. ** The unicode() function. Return the integer unicode code-point value
  103265. ** for the first character of the input string.
  103266. */
  103267. static void unicodeFunc(
  103268. sqlite3_context *context,
  103269. int argc,
  103270. sqlite3_value **argv
  103271. ){
  103272. const unsigned char *z = sqlite3_value_text(argv[0]);
  103273. (void)argc;
  103274. if( z && z[0] ) sqlite3_result_int(context, sqlite3Utf8Read(&z));
  103275. }
  103276. /*
  103277. ** The char() function takes zero or more arguments, each of which is
  103278. ** an integer. It constructs a string where each character of the string
  103279. ** is the unicode character for the corresponding integer argument.
  103280. */
  103281. static void charFunc(
  103282. sqlite3_context *context,
  103283. int argc,
  103284. sqlite3_value **argv
  103285. ){
  103286. unsigned char *z, *zOut;
  103287. int i;
  103288. zOut = z = sqlite3_malloc64( argc*4+1 );
  103289. if( z==0 ){
  103290. sqlite3_result_error_nomem(context);
  103291. return;
  103292. }
  103293. for(i=0; i<argc; i++){
  103294. sqlite3_int64 x;
  103295. unsigned c;
  103296. x = sqlite3_value_int64(argv[i]);
  103297. if( x<0 || x>0x10ffff ) x = 0xfffd;
  103298. c = (unsigned)(x & 0x1fffff);
  103299. if( c<0x00080 ){
  103300. *zOut++ = (u8)(c&0xFF);
  103301. }else if( c<0x00800 ){
  103302. *zOut++ = 0xC0 + (u8)((c>>6)&0x1F);
  103303. *zOut++ = 0x80 + (u8)(c & 0x3F);
  103304. }else if( c<0x10000 ){
  103305. *zOut++ = 0xE0 + (u8)((c>>12)&0x0F);
  103306. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F);
  103307. *zOut++ = 0x80 + (u8)(c & 0x3F);
  103308. }else{
  103309. *zOut++ = 0xF0 + (u8)((c>>18) & 0x07);
  103310. *zOut++ = 0x80 + (u8)((c>>12) & 0x3F);
  103311. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F);
  103312. *zOut++ = 0x80 + (u8)(c & 0x3F);
  103313. } \
  103314. }
  103315. sqlite3_result_text64(context, (char*)z, zOut-z, sqlite3_free, SQLITE_UTF8);
  103316. }
  103317. /*
  103318. ** The hex() function. Interpret the argument as a blob. Return
  103319. ** a hexadecimal rendering as text.
  103320. */
  103321. static void hexFunc(
  103322. sqlite3_context *context,
  103323. int argc,
  103324. sqlite3_value **argv
  103325. ){
  103326. int i, n;
  103327. const unsigned char *pBlob;
  103328. char *zHex, *z;
  103329. assert( argc==1 );
  103330. UNUSED_PARAMETER(argc);
  103331. pBlob = sqlite3_value_blob(argv[0]);
  103332. n = sqlite3_value_bytes(argv[0]);
  103333. assert( pBlob==sqlite3_value_blob(argv[0]) ); /* No encoding change */
  103334. z = zHex = contextMalloc(context, ((i64)n)*2 + 1);
  103335. if( zHex ){
  103336. for(i=0; i<n; i++, pBlob++){
  103337. unsigned char c = *pBlob;
  103338. *(z++) = hexdigits[(c>>4)&0xf];
  103339. *(z++) = hexdigits[c&0xf];
  103340. }
  103341. *z = 0;
  103342. sqlite3_result_text(context, zHex, n*2, sqlite3_free);
  103343. }
  103344. }
  103345. /*
  103346. ** The zeroblob(N) function returns a zero-filled blob of size N bytes.
  103347. */
  103348. static void zeroblobFunc(
  103349. sqlite3_context *context,
  103350. int argc,
  103351. sqlite3_value **argv
  103352. ){
  103353. i64 n;
  103354. int rc;
  103355. assert( argc==1 );
  103356. UNUSED_PARAMETER(argc);
  103357. n = sqlite3_value_int64(argv[0]);
  103358. if( n<0 ) n = 0;
  103359. rc = sqlite3_result_zeroblob64(context, n); /* IMP: R-00293-64994 */
  103360. if( rc ){
  103361. sqlite3_result_error_code(context, rc);
  103362. }
  103363. }
  103364. /*
  103365. ** The replace() function. Three arguments are all strings: call
  103366. ** them A, B, and C. The result is also a string which is derived
  103367. ** from A by replacing every occurrence of B with C. The match
  103368. ** must be exact. Collating sequences are not used.
  103369. */
  103370. static void replaceFunc(
  103371. sqlite3_context *context,
  103372. int argc,
  103373. sqlite3_value **argv
  103374. ){
  103375. const unsigned char *zStr; /* The input string A */
  103376. const unsigned char *zPattern; /* The pattern string B */
  103377. const unsigned char *zRep; /* The replacement string C */
  103378. unsigned char *zOut; /* The output */
  103379. int nStr; /* Size of zStr */
  103380. int nPattern; /* Size of zPattern */
  103381. int nRep; /* Size of zRep */
  103382. i64 nOut; /* Maximum size of zOut */
  103383. int loopLimit; /* Last zStr[] that might match zPattern[] */
  103384. int i, j; /* Loop counters */
  103385. unsigned cntExpand; /* Number zOut expansions */
  103386. sqlite3 *db = sqlite3_context_db_handle(context);
  103387. assert( argc==3 );
  103388. UNUSED_PARAMETER(argc);
  103389. zStr = sqlite3_value_text(argv[0]);
  103390. if( zStr==0 ) return;
  103391. nStr = sqlite3_value_bytes(argv[0]);
  103392. assert( zStr==sqlite3_value_text(argv[0]) ); /* No encoding change */
  103393. zPattern = sqlite3_value_text(argv[1]);
  103394. if( zPattern==0 ){
  103395. assert( sqlite3_value_type(argv[1])==SQLITE_NULL
  103396. || sqlite3_context_db_handle(context)->mallocFailed );
  103397. return;
  103398. }
  103399. if( zPattern[0]==0 ){
  103400. assert( sqlite3_value_type(argv[1])!=SQLITE_NULL );
  103401. sqlite3_result_value(context, argv[0]);
  103402. return;
  103403. }
  103404. nPattern = sqlite3_value_bytes(argv[1]);
  103405. assert( zPattern==sqlite3_value_text(argv[1]) ); /* No encoding change */
  103406. zRep = sqlite3_value_text(argv[2]);
  103407. if( zRep==0 ) return;
  103408. nRep = sqlite3_value_bytes(argv[2]);
  103409. assert( zRep==sqlite3_value_text(argv[2]) );
  103410. nOut = nStr + 1;
  103411. assert( nOut<SQLITE_MAX_LENGTH );
  103412. zOut = contextMalloc(context, (i64)nOut);
  103413. if( zOut==0 ){
  103414. return;
  103415. }
  103416. loopLimit = nStr - nPattern;
  103417. cntExpand = 0;
  103418. for(i=j=0; i<=loopLimit; i++){
  103419. if( zStr[i]!=zPattern[0] || memcmp(&zStr[i], zPattern, nPattern) ){
  103420. zOut[j++] = zStr[i];
  103421. }else{
  103422. if( nRep>nPattern ){
  103423. nOut += nRep - nPattern;
  103424. testcase( nOut-1==db->aLimit[SQLITE_LIMIT_LENGTH] );
  103425. testcase( nOut-2==db->aLimit[SQLITE_LIMIT_LENGTH] );
  103426. if( nOut-1>db->aLimit[SQLITE_LIMIT_LENGTH] ){
  103427. sqlite3_result_error_toobig(context);
  103428. sqlite3_free(zOut);
  103429. return;
  103430. }
  103431. cntExpand++;
  103432. if( (cntExpand&(cntExpand-1))==0 ){
  103433. /* Grow the size of the output buffer only on substitutions
  103434. ** whose index is a power of two: 1, 2, 4, 8, 16, 32, ... */
  103435. u8 *zOld;
  103436. zOld = zOut;
  103437. zOut = sqlite3_realloc64(zOut, (int)nOut + (nOut - nStr - 1));
  103438. if( zOut==0 ){
  103439. sqlite3_result_error_nomem(context);
  103440. sqlite3_free(zOld);
  103441. return;
  103442. }
  103443. }
  103444. }
  103445. memcpy(&zOut[j], zRep, nRep);
  103446. j += nRep;
  103447. i += nPattern-1;
  103448. }
  103449. }
  103450. assert( j+nStr-i+1<=nOut );
  103451. memcpy(&zOut[j], &zStr[i], nStr-i);
  103452. j += nStr - i;
  103453. assert( j<=nOut );
  103454. zOut[j] = 0;
  103455. sqlite3_result_text(context, (char*)zOut, j, sqlite3_free);
  103456. }
  103457. /*
  103458. ** Implementation of the TRIM(), LTRIM(), and RTRIM() functions.
  103459. ** The userdata is 0x1 for left trim, 0x2 for right trim, 0x3 for both.
  103460. */
  103461. static void trimFunc(
  103462. sqlite3_context *context,
  103463. int argc,
  103464. sqlite3_value **argv
  103465. ){
  103466. const unsigned char *zIn; /* Input string */
  103467. const unsigned char *zCharSet; /* Set of characters to trim */
  103468. int nIn; /* Number of bytes in input */
  103469. int flags; /* 1: trimleft 2: trimright 3: trim */
  103470. int i; /* Loop counter */
  103471. unsigned char *aLen = 0; /* Length of each character in zCharSet */
  103472. unsigned char **azChar = 0; /* Individual characters in zCharSet */
  103473. int nChar; /* Number of characters in zCharSet */
  103474. if( sqlite3_value_type(argv[0])==SQLITE_NULL ){
  103475. return;
  103476. }
  103477. zIn = sqlite3_value_text(argv[0]);
  103478. if( zIn==0 ) return;
  103479. nIn = sqlite3_value_bytes(argv[0]);
  103480. assert( zIn==sqlite3_value_text(argv[0]) );
  103481. if( argc==1 ){
  103482. static const unsigned char lenOne[] = { 1 };
  103483. static unsigned char * const azOne[] = { (u8*)" " };
  103484. nChar = 1;
  103485. aLen = (u8*)lenOne;
  103486. azChar = (unsigned char **)azOne;
  103487. zCharSet = 0;
  103488. }else if( (zCharSet = sqlite3_value_text(argv[1]))==0 ){
  103489. return;
  103490. }else{
  103491. const unsigned char *z;
  103492. for(z=zCharSet, nChar=0; *z; nChar++){
  103493. SQLITE_SKIP_UTF8(z);
  103494. }
  103495. if( nChar>0 ){
  103496. azChar = contextMalloc(context, ((i64)nChar)*(sizeof(char*)+1));
  103497. if( azChar==0 ){
  103498. return;
  103499. }
  103500. aLen = (unsigned char*)&azChar[nChar];
  103501. for(z=zCharSet, nChar=0; *z; nChar++){
  103502. azChar[nChar] = (unsigned char *)z;
  103503. SQLITE_SKIP_UTF8(z);
  103504. aLen[nChar] = (u8)(z - azChar[nChar]);
  103505. }
  103506. }
  103507. }
  103508. if( nChar>0 ){
  103509. flags = SQLITE_PTR_TO_INT(sqlite3_user_data(context));
  103510. if( flags & 1 ){
  103511. while( nIn>0 ){
  103512. int len = 0;
  103513. for(i=0; i<nChar; i++){
  103514. len = aLen[i];
  103515. if( len<=nIn && memcmp(zIn, azChar[i], len)==0 ) break;
  103516. }
  103517. if( i>=nChar ) break;
  103518. zIn += len;
  103519. nIn -= len;
  103520. }
  103521. }
  103522. if( flags & 2 ){
  103523. while( nIn>0 ){
  103524. int len = 0;
  103525. for(i=0; i<nChar; i++){
  103526. len = aLen[i];
  103527. if( len<=nIn && memcmp(&zIn[nIn-len],azChar[i],len)==0 ) break;
  103528. }
  103529. if( i>=nChar ) break;
  103530. nIn -= len;
  103531. }
  103532. }
  103533. if( zCharSet ){
  103534. sqlite3_free(azChar);
  103535. }
  103536. }
  103537. sqlite3_result_text(context, (char*)zIn, nIn, SQLITE_TRANSIENT);
  103538. }
  103539. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  103540. /*
  103541. ** The "unknown" function is automatically substituted in place of
  103542. ** any unrecognized function name when doing an EXPLAIN or EXPLAIN QUERY PLAN
  103543. ** when the SQLITE_ENABLE_UNKNOWN_FUNCTION compile-time option is used.
  103544. ** When the "sqlite3" command-line shell is built using this functionality,
  103545. ** that allows an EXPLAIN or EXPLAIN QUERY PLAN for complex queries
  103546. ** involving application-defined functions to be examined in a generic
  103547. ** sqlite3 shell.
  103548. */
  103549. static void unknownFunc(
  103550. sqlite3_context *context,
  103551. int argc,
  103552. sqlite3_value **argv
  103553. ){
  103554. /* no-op */
  103555. }
  103556. #endif /*SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION*/
  103557. /* IMP: R-25361-16150 This function is omitted from SQLite by default. It
  103558. ** is only available if the SQLITE_SOUNDEX compile-time option is used
  103559. ** when SQLite is built.
  103560. */
  103561. #ifdef SQLITE_SOUNDEX
  103562. /*
  103563. ** Compute the soundex encoding of a word.
  103564. **
  103565. ** IMP: R-59782-00072 The soundex(X) function returns a string that is the
  103566. ** soundex encoding of the string X.
  103567. */
  103568. static void soundexFunc(
  103569. sqlite3_context *context,
  103570. int argc,
  103571. sqlite3_value **argv
  103572. ){
  103573. char zResult[8];
  103574. const u8 *zIn;
  103575. int i, j;
  103576. static const unsigned char iCode[] = {
  103577. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  103578. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  103579. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  103580. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  103581. 0, 0, 1, 2, 3, 0, 1, 2, 0, 0, 2, 2, 4, 5, 5, 0,
  103582. 1, 2, 6, 2, 3, 0, 1, 0, 2, 0, 2, 0, 0, 0, 0, 0,
  103583. 0, 0, 1, 2, 3, 0, 1, 2, 0, 0, 2, 2, 4, 5, 5, 0,
  103584. 1, 2, 6, 2, 3, 0, 1, 0, 2, 0, 2, 0, 0, 0, 0, 0,
  103585. };
  103586. assert( argc==1 );
  103587. zIn = (u8*)sqlite3_value_text(argv[0]);
  103588. if( zIn==0 ) zIn = (u8*)"";
  103589. for(i=0; zIn[i] && !sqlite3Isalpha(zIn[i]); i++){}
  103590. if( zIn[i] ){
  103591. u8 prevcode = iCode[zIn[i]&0x7f];
  103592. zResult[0] = sqlite3Toupper(zIn[i]);
  103593. for(j=1; j<4 && zIn[i]; i++){
  103594. int code = iCode[zIn[i]&0x7f];
  103595. if( code>0 ){
  103596. if( code!=prevcode ){
  103597. prevcode = code;
  103598. zResult[j++] = code + '0';
  103599. }
  103600. }else{
  103601. prevcode = 0;
  103602. }
  103603. }
  103604. while( j<4 ){
  103605. zResult[j++] = '0';
  103606. }
  103607. zResult[j] = 0;
  103608. sqlite3_result_text(context, zResult, 4, SQLITE_TRANSIENT);
  103609. }else{
  103610. /* IMP: R-64894-50321 The string "?000" is returned if the argument
  103611. ** is NULL or contains no ASCII alphabetic characters. */
  103612. sqlite3_result_text(context, "?000", 4, SQLITE_STATIC);
  103613. }
  103614. }
  103615. #endif /* SQLITE_SOUNDEX */
  103616. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  103617. /*
  103618. ** A function that loads a shared-library extension then returns NULL.
  103619. */
  103620. static void loadExt(sqlite3_context *context, int argc, sqlite3_value **argv){
  103621. const char *zFile = (const char *)sqlite3_value_text(argv[0]);
  103622. const char *zProc;
  103623. sqlite3 *db = sqlite3_context_db_handle(context);
  103624. char *zErrMsg = 0;
  103625. /* Disallow the load_extension() SQL function unless the SQLITE_LoadExtFunc
  103626. ** flag is set. See the sqlite3_enable_load_extension() API.
  103627. */
  103628. if( (db->flags & SQLITE_LoadExtFunc)==0 ){
  103629. sqlite3_result_error(context, "not authorized", -1);
  103630. return;
  103631. }
  103632. if( argc==2 ){
  103633. zProc = (const char *)sqlite3_value_text(argv[1]);
  103634. }else{
  103635. zProc = 0;
  103636. }
  103637. if( zFile && sqlite3_load_extension(db, zFile, zProc, &zErrMsg) ){
  103638. sqlite3_result_error(context, zErrMsg, -1);
  103639. sqlite3_free(zErrMsg);
  103640. }
  103641. }
  103642. #endif
  103643. /*
  103644. ** An instance of the following structure holds the context of a
  103645. ** sum() or avg() aggregate computation.
  103646. */
  103647. typedef struct SumCtx SumCtx;
  103648. struct SumCtx {
  103649. double rSum; /* Floating point sum */
  103650. i64 iSum; /* Integer sum */
  103651. i64 cnt; /* Number of elements summed */
  103652. u8 overflow; /* True if integer overflow seen */
  103653. u8 approx; /* True if non-integer value was input to the sum */
  103654. };
  103655. /*
  103656. ** Routines used to compute the sum, average, and total.
  103657. **
  103658. ** The SUM() function follows the (broken) SQL standard which means
  103659. ** that it returns NULL if it sums over no inputs. TOTAL returns
  103660. ** 0.0 in that case. In addition, TOTAL always returns a float where
  103661. ** SUM might return an integer if it never encounters a floating point
  103662. ** value. TOTAL never fails, but SUM might through an exception if
  103663. ** it overflows an integer.
  103664. */
  103665. static void sumStep(sqlite3_context *context, int argc, sqlite3_value **argv){
  103666. SumCtx *p;
  103667. int type;
  103668. assert( argc==1 );
  103669. UNUSED_PARAMETER(argc);
  103670. p = sqlite3_aggregate_context(context, sizeof(*p));
  103671. type = sqlite3_value_numeric_type(argv[0]);
  103672. if( p && type!=SQLITE_NULL ){
  103673. p->cnt++;
  103674. if( type==SQLITE_INTEGER ){
  103675. i64 v = sqlite3_value_int64(argv[0]);
  103676. p->rSum += v;
  103677. if( (p->approx|p->overflow)==0 && sqlite3AddInt64(&p->iSum, v) ){
  103678. p->overflow = 1;
  103679. }
  103680. }else{
  103681. p->rSum += sqlite3_value_double(argv[0]);
  103682. p->approx = 1;
  103683. }
  103684. }
  103685. }
  103686. static void sumFinalize(sqlite3_context *context){
  103687. SumCtx *p;
  103688. p = sqlite3_aggregate_context(context, 0);
  103689. if( p && p->cnt>0 ){
  103690. if( p->overflow ){
  103691. sqlite3_result_error(context,"integer overflow",-1);
  103692. }else if( p->approx ){
  103693. sqlite3_result_double(context, p->rSum);
  103694. }else{
  103695. sqlite3_result_int64(context, p->iSum);
  103696. }
  103697. }
  103698. }
  103699. static void avgFinalize(sqlite3_context *context){
  103700. SumCtx *p;
  103701. p = sqlite3_aggregate_context(context, 0);
  103702. if( p && p->cnt>0 ){
  103703. sqlite3_result_double(context, p->rSum/(double)p->cnt);
  103704. }
  103705. }
  103706. static void totalFinalize(sqlite3_context *context){
  103707. SumCtx *p;
  103708. p = sqlite3_aggregate_context(context, 0);
  103709. /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
  103710. sqlite3_result_double(context, p ? p->rSum : (double)0);
  103711. }
  103712. /*
  103713. ** The following structure keeps track of state information for the
  103714. ** count() aggregate function.
  103715. */
  103716. typedef struct CountCtx CountCtx;
  103717. struct CountCtx {
  103718. i64 n;
  103719. };
  103720. /*
  103721. ** Routines to implement the count() aggregate function.
  103722. */
  103723. static void countStep(sqlite3_context *context, int argc, sqlite3_value **argv){
  103724. CountCtx *p;
  103725. p = sqlite3_aggregate_context(context, sizeof(*p));
  103726. if( (argc==0 || SQLITE_NULL!=sqlite3_value_type(argv[0])) && p ){
  103727. p->n++;
  103728. }
  103729. #ifndef SQLITE_OMIT_DEPRECATED
  103730. /* The sqlite3_aggregate_count() function is deprecated. But just to make
  103731. ** sure it still operates correctly, verify that its count agrees with our
  103732. ** internal count when using count(*) and when the total count can be
  103733. ** expressed as a 32-bit integer. */
  103734. assert( argc==1 || p==0 || p->n>0x7fffffff
  103735. || p->n==sqlite3_aggregate_count(context) );
  103736. #endif
  103737. }
  103738. static void countFinalize(sqlite3_context *context){
  103739. CountCtx *p;
  103740. p = sqlite3_aggregate_context(context, 0);
  103741. sqlite3_result_int64(context, p ? p->n : 0);
  103742. }
  103743. /*
  103744. ** Routines to implement min() and max() aggregate functions.
  103745. */
  103746. static void minmaxStep(
  103747. sqlite3_context *context,
  103748. int NotUsed,
  103749. sqlite3_value **argv
  103750. ){
  103751. Mem *pArg = (Mem *)argv[0];
  103752. Mem *pBest;
  103753. UNUSED_PARAMETER(NotUsed);
  103754. pBest = (Mem *)sqlite3_aggregate_context(context, sizeof(*pBest));
  103755. if( !pBest ) return;
  103756. if( sqlite3_value_type(argv[0])==SQLITE_NULL ){
  103757. if( pBest->flags ) sqlite3SkipAccumulatorLoad(context);
  103758. }else if( pBest->flags ){
  103759. int max;
  103760. int cmp;
  103761. CollSeq *pColl = sqlite3GetFuncCollSeq(context);
  103762. /* This step function is used for both the min() and max() aggregates,
  103763. ** the only difference between the two being that the sense of the
  103764. ** comparison is inverted. For the max() aggregate, the
  103765. ** sqlite3_user_data() function returns (void *)-1. For min() it
  103766. ** returns (void *)db, where db is the sqlite3* database pointer.
  103767. ** Therefore the next statement sets variable 'max' to 1 for the max()
  103768. ** aggregate, or 0 for min().
  103769. */
  103770. max = sqlite3_user_data(context)!=0;
  103771. cmp = sqlite3MemCompare(pBest, pArg, pColl);
  103772. if( (max && cmp<0) || (!max && cmp>0) ){
  103773. sqlite3VdbeMemCopy(pBest, pArg);
  103774. }else{
  103775. sqlite3SkipAccumulatorLoad(context);
  103776. }
  103777. }else{
  103778. pBest->db = sqlite3_context_db_handle(context);
  103779. sqlite3VdbeMemCopy(pBest, pArg);
  103780. }
  103781. }
  103782. static void minMaxFinalize(sqlite3_context *context){
  103783. sqlite3_value *pRes;
  103784. pRes = (sqlite3_value *)sqlite3_aggregate_context(context, 0);
  103785. if( pRes ){
  103786. if( pRes->flags ){
  103787. sqlite3_result_value(context, pRes);
  103788. }
  103789. sqlite3VdbeMemRelease(pRes);
  103790. }
  103791. }
  103792. /*
  103793. ** group_concat(EXPR, ?SEPARATOR?)
  103794. */
  103795. static void groupConcatStep(
  103796. sqlite3_context *context,
  103797. int argc,
  103798. sqlite3_value **argv
  103799. ){
  103800. const char *zVal;
  103801. StrAccum *pAccum;
  103802. const char *zSep;
  103803. int nVal, nSep;
  103804. assert( argc==1 || argc==2 );
  103805. if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
  103806. pAccum = (StrAccum*)sqlite3_aggregate_context(context, sizeof(*pAccum));
  103807. if( pAccum ){
  103808. sqlite3 *db = sqlite3_context_db_handle(context);
  103809. int firstTerm = pAccum->mxAlloc==0;
  103810. pAccum->mxAlloc = db->aLimit[SQLITE_LIMIT_LENGTH];
  103811. if( !firstTerm ){
  103812. if( argc==2 ){
  103813. zSep = (char*)sqlite3_value_text(argv[1]);
  103814. nSep = sqlite3_value_bytes(argv[1]);
  103815. }else{
  103816. zSep = ",";
  103817. nSep = 1;
  103818. }
  103819. if( zSep ) sqlite3StrAccumAppend(pAccum, zSep, nSep);
  103820. }
  103821. zVal = (char*)sqlite3_value_text(argv[0]);
  103822. nVal = sqlite3_value_bytes(argv[0]);
  103823. if( zVal ) sqlite3StrAccumAppend(pAccum, zVal, nVal);
  103824. }
  103825. }
  103826. static void groupConcatFinalize(sqlite3_context *context){
  103827. StrAccum *pAccum;
  103828. pAccum = sqlite3_aggregate_context(context, 0);
  103829. if( pAccum ){
  103830. if( pAccum->accError==STRACCUM_TOOBIG ){
  103831. sqlite3_result_error_toobig(context);
  103832. }else if( pAccum->accError==STRACCUM_NOMEM ){
  103833. sqlite3_result_error_nomem(context);
  103834. }else{
  103835. sqlite3_result_text(context, sqlite3StrAccumFinish(pAccum), -1,
  103836. sqlite3_free);
  103837. }
  103838. }
  103839. }
  103840. /*
  103841. ** This routine does per-connection function registration. Most
  103842. ** of the built-in functions above are part of the global function set.
  103843. ** This routine only deals with those that are not global.
  103844. */
  103845. SQLITE_PRIVATE void sqlite3RegisterPerConnectionBuiltinFunctions(sqlite3 *db){
  103846. int rc = sqlite3_overload_function(db, "MATCH", 2);
  103847. assert( rc==SQLITE_NOMEM || rc==SQLITE_OK );
  103848. if( rc==SQLITE_NOMEM ){
  103849. sqlite3OomFault(db);
  103850. }
  103851. }
  103852. /*
  103853. ** Set the LIKEOPT flag on the 2-argument function with the given name.
  103854. */
  103855. static void setLikeOptFlag(sqlite3 *db, const char *zName, u8 flagVal){
  103856. FuncDef *pDef;
  103857. pDef = sqlite3FindFunction(db, zName, 2, SQLITE_UTF8, 0);
  103858. if( ALWAYS(pDef) ){
  103859. pDef->funcFlags |= flagVal;
  103860. }
  103861. }
  103862. /*
  103863. ** Register the built-in LIKE and GLOB functions. The caseSensitive
  103864. ** parameter determines whether or not the LIKE operator is case
  103865. ** sensitive. GLOB is always case sensitive.
  103866. */
  103867. SQLITE_PRIVATE void sqlite3RegisterLikeFunctions(sqlite3 *db, int caseSensitive){
  103868. struct compareInfo *pInfo;
  103869. if( caseSensitive ){
  103870. pInfo = (struct compareInfo*)&likeInfoAlt;
  103871. }else{
  103872. pInfo = (struct compareInfo*)&likeInfoNorm;
  103873. }
  103874. sqlite3CreateFunc(db, "like", 2, SQLITE_UTF8, pInfo, likeFunc, 0, 0, 0);
  103875. sqlite3CreateFunc(db, "like", 3, SQLITE_UTF8, pInfo, likeFunc, 0, 0, 0);
  103876. sqlite3CreateFunc(db, "glob", 2, SQLITE_UTF8,
  103877. (struct compareInfo*)&globInfo, likeFunc, 0, 0, 0);
  103878. setLikeOptFlag(db, "glob", SQLITE_FUNC_LIKE | SQLITE_FUNC_CASE);
  103879. setLikeOptFlag(db, "like",
  103880. caseSensitive ? (SQLITE_FUNC_LIKE | SQLITE_FUNC_CASE) : SQLITE_FUNC_LIKE);
  103881. }
  103882. /*
  103883. ** pExpr points to an expression which implements a function. If
  103884. ** it is appropriate to apply the LIKE optimization to that function
  103885. ** then set aWc[0] through aWc[2] to the wildcard characters and the
  103886. ** escape character and then return TRUE. If the function is not a
  103887. ** LIKE-style function then return FALSE.
  103888. **
  103889. ** The expression "a LIKE b ESCAPE c" is only considered a valid LIKE
  103890. ** operator if c is a string literal that is exactly one byte in length.
  103891. ** That one byte is stored in aWc[3]. aWc[3] is set to zero if there is
  103892. ** no ESCAPE clause.
  103893. **
  103894. ** *pIsNocase is set to true if uppercase and lowercase are equivalent for
  103895. ** the function (default for LIKE). If the function makes the distinction
  103896. ** between uppercase and lowercase (as does GLOB) then *pIsNocase is set to
  103897. ** false.
  103898. */
  103899. SQLITE_PRIVATE int sqlite3IsLikeFunction(sqlite3 *db, Expr *pExpr, int *pIsNocase, char *aWc){
  103900. FuncDef *pDef;
  103901. int nExpr;
  103902. if( pExpr->op!=TK_FUNCTION || !pExpr->x.pList ){
  103903. return 0;
  103904. }
  103905. assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
  103906. nExpr = pExpr->x.pList->nExpr;
  103907. pDef = sqlite3FindFunction(db, pExpr->u.zToken, nExpr, SQLITE_UTF8, 0);
  103908. if( NEVER(pDef==0) || (pDef->funcFlags & SQLITE_FUNC_LIKE)==0 ){
  103909. return 0;
  103910. }
  103911. if( nExpr<3 ){
  103912. aWc[3] = 0;
  103913. }else{
  103914. Expr *pEscape = pExpr->x.pList->a[2].pExpr;
  103915. char *zEscape;
  103916. if( pEscape->op!=TK_STRING ) return 0;
  103917. zEscape = pEscape->u.zToken;
  103918. if( zEscape[0]==0 || zEscape[1]!=0 ) return 0;
  103919. aWc[3] = zEscape[0];
  103920. }
  103921. /* The memcpy() statement assumes that the wildcard characters are
  103922. ** the first three statements in the compareInfo structure. The
  103923. ** asserts() that follow verify that assumption
  103924. */
  103925. memcpy(aWc, pDef->pUserData, 3);
  103926. assert( (char*)&likeInfoAlt == (char*)&likeInfoAlt.matchAll );
  103927. assert( &((char*)&likeInfoAlt)[1] == (char*)&likeInfoAlt.matchOne );
  103928. assert( &((char*)&likeInfoAlt)[2] == (char*)&likeInfoAlt.matchSet );
  103929. *pIsNocase = (pDef->funcFlags & SQLITE_FUNC_CASE)==0;
  103930. return 1;
  103931. }
  103932. /*
  103933. ** All of the FuncDef structures in the aBuiltinFunc[] array above
  103934. ** to the global function hash table. This occurs at start-time (as
  103935. ** a consequence of calling sqlite3_initialize()).
  103936. **
  103937. ** After this routine runs
  103938. */
  103939. SQLITE_PRIVATE void sqlite3RegisterBuiltinFunctions(void){
  103940. /*
  103941. ** The following array holds FuncDef structures for all of the functions
  103942. ** defined in this file.
  103943. **
  103944. ** The array cannot be constant since changes are made to the
  103945. ** FuncDef.pHash elements at start-time. The elements of this array
  103946. ** are read-only after initialization is complete.
  103947. **
  103948. ** For peak efficiency, put the most frequently used function last.
  103949. */
  103950. static FuncDef aBuiltinFunc[] = {
  103951. #ifdef SQLITE_SOUNDEX
  103952. FUNCTION(soundex, 1, 0, 0, soundexFunc ),
  103953. #endif
  103954. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  103955. VFUNCTION(load_extension, 1, 0, 0, loadExt ),
  103956. VFUNCTION(load_extension, 2, 0, 0, loadExt ),
  103957. #endif
  103958. #if SQLITE_USER_AUTHENTICATION
  103959. FUNCTION(sqlite_crypt, 2, 0, 0, sqlite3CryptFunc ),
  103960. #endif
  103961. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  103962. DFUNCTION(sqlite_compileoption_used,1, 0, 0, compileoptionusedFunc ),
  103963. DFUNCTION(sqlite_compileoption_get, 1, 0, 0, compileoptiongetFunc ),
  103964. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  103965. FUNCTION2(unlikely, 1, 0, 0, noopFunc, SQLITE_FUNC_UNLIKELY),
  103966. FUNCTION2(likelihood, 2, 0, 0, noopFunc, SQLITE_FUNC_UNLIKELY),
  103967. FUNCTION2(likely, 1, 0, 0, noopFunc, SQLITE_FUNC_UNLIKELY),
  103968. #ifdef SQLITE_DEBUG
  103969. FUNCTION2(affinity, 1, 0, 0, noopFunc, SQLITE_FUNC_AFFINITY),
  103970. #endif
  103971. #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
  103972. FUNCTION2(sqlite_offset, 1, 0, 0, noopFunc, SQLITE_FUNC_OFFSET|
  103973. SQLITE_FUNC_TYPEOF),
  103974. #endif
  103975. FUNCTION(ltrim, 1, 1, 0, trimFunc ),
  103976. FUNCTION(ltrim, 2, 1, 0, trimFunc ),
  103977. FUNCTION(rtrim, 1, 2, 0, trimFunc ),
  103978. FUNCTION(rtrim, 2, 2, 0, trimFunc ),
  103979. FUNCTION(trim, 1, 3, 0, trimFunc ),
  103980. FUNCTION(trim, 2, 3, 0, trimFunc ),
  103981. FUNCTION(min, -1, 0, 1, minmaxFunc ),
  103982. FUNCTION(min, 0, 0, 1, 0 ),
  103983. AGGREGATE2(min, 1, 0, 1, minmaxStep, minMaxFinalize,
  103984. SQLITE_FUNC_MINMAX ),
  103985. FUNCTION(max, -1, 1, 1, minmaxFunc ),
  103986. FUNCTION(max, 0, 1, 1, 0 ),
  103987. AGGREGATE2(max, 1, 1, 1, minmaxStep, minMaxFinalize,
  103988. SQLITE_FUNC_MINMAX ),
  103989. FUNCTION2(typeof, 1, 0, 0, typeofFunc, SQLITE_FUNC_TYPEOF),
  103990. FUNCTION2(length, 1, 0, 0, lengthFunc, SQLITE_FUNC_LENGTH),
  103991. FUNCTION(instr, 2, 0, 0, instrFunc ),
  103992. FUNCTION(printf, -1, 0, 0, printfFunc ),
  103993. FUNCTION(unicode, 1, 0, 0, unicodeFunc ),
  103994. FUNCTION(char, -1, 0, 0, charFunc ),
  103995. FUNCTION(abs, 1, 0, 0, absFunc ),
  103996. #ifndef SQLITE_OMIT_FLOATING_POINT
  103997. FUNCTION(round, 1, 0, 0, roundFunc ),
  103998. FUNCTION(round, 2, 0, 0, roundFunc ),
  103999. #endif
  104000. FUNCTION(upper, 1, 0, 0, upperFunc ),
  104001. FUNCTION(lower, 1, 0, 0, lowerFunc ),
  104002. FUNCTION(hex, 1, 0, 0, hexFunc ),
  104003. FUNCTION2(ifnull, 2, 0, 0, noopFunc, SQLITE_FUNC_COALESCE),
  104004. VFUNCTION(random, 0, 0, 0, randomFunc ),
  104005. VFUNCTION(randomblob, 1, 0, 0, randomBlob ),
  104006. FUNCTION(nullif, 2, 0, 1, nullifFunc ),
  104007. DFUNCTION(sqlite_version, 0, 0, 0, versionFunc ),
  104008. DFUNCTION(sqlite_source_id, 0, 0, 0, sourceidFunc ),
  104009. FUNCTION(sqlite_log, 2, 0, 0, errlogFunc ),
  104010. FUNCTION(quote, 1, 0, 0, quoteFunc ),
  104011. VFUNCTION(last_insert_rowid, 0, 0, 0, last_insert_rowid),
  104012. VFUNCTION(changes, 0, 0, 0, changes ),
  104013. VFUNCTION(total_changes, 0, 0, 0, total_changes ),
  104014. FUNCTION(replace, 3, 0, 0, replaceFunc ),
  104015. FUNCTION(zeroblob, 1, 0, 0, zeroblobFunc ),
  104016. FUNCTION(substr, 2, 0, 0, substrFunc ),
  104017. FUNCTION(substr, 3, 0, 0, substrFunc ),
  104018. AGGREGATE(sum, 1, 0, 0, sumStep, sumFinalize ),
  104019. AGGREGATE(total, 1, 0, 0, sumStep, totalFinalize ),
  104020. AGGREGATE(avg, 1, 0, 0, sumStep, avgFinalize ),
  104021. AGGREGATE2(count, 0, 0, 0, countStep, countFinalize,
  104022. SQLITE_FUNC_COUNT ),
  104023. AGGREGATE(count, 1, 0, 0, countStep, countFinalize ),
  104024. AGGREGATE(group_concat, 1, 0, 0, groupConcatStep, groupConcatFinalize),
  104025. AGGREGATE(group_concat, 2, 0, 0, groupConcatStep, groupConcatFinalize),
  104026. LIKEFUNC(glob, 2, &globInfo, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
  104027. #ifdef SQLITE_CASE_SENSITIVE_LIKE
  104028. LIKEFUNC(like, 2, &likeInfoAlt, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
  104029. LIKEFUNC(like, 3, &likeInfoAlt, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
  104030. #else
  104031. LIKEFUNC(like, 2, &likeInfoNorm, SQLITE_FUNC_LIKE),
  104032. LIKEFUNC(like, 3, &likeInfoNorm, SQLITE_FUNC_LIKE),
  104033. #endif
  104034. #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
  104035. FUNCTION(unknown, -1, 0, 0, unknownFunc ),
  104036. #endif
  104037. FUNCTION(coalesce, 1, 0, 0, 0 ),
  104038. FUNCTION(coalesce, 0, 0, 0, 0 ),
  104039. FUNCTION2(coalesce, -1, 0, 0, noopFunc, SQLITE_FUNC_COALESCE),
  104040. };
  104041. #ifndef SQLITE_OMIT_ALTERTABLE
  104042. sqlite3AlterFunctions();
  104043. #endif
  104044. #if defined(SQLITE_ENABLE_STAT3) || defined(SQLITE_ENABLE_STAT4)
  104045. sqlite3AnalyzeFunctions();
  104046. #endif
  104047. sqlite3RegisterDateTimeFunctions();
  104048. sqlite3InsertBuiltinFuncs(aBuiltinFunc, ArraySize(aBuiltinFunc));
  104049. #if 0 /* Enable to print out how the built-in functions are hashed */
  104050. {
  104051. int i;
  104052. FuncDef *p;
  104053. for(i=0; i<SQLITE_FUNC_HASH_SZ; i++){
  104054. printf("FUNC-HASH %02d:", i);
  104055. for(p=sqlite3BuiltinFunctions.a[i]; p; p=p->u.pHash){
  104056. int n = sqlite3Strlen30(p->zName);
  104057. int h = p->zName[0] + n;
  104058. printf(" %s(%d)", p->zName, h);
  104059. }
  104060. printf("\n");
  104061. }
  104062. }
  104063. #endif
  104064. }
  104065. /************** End of func.c ************************************************/
  104066. /************** Begin file fkey.c ********************************************/
  104067. /*
  104068. **
  104069. ** The author disclaims copyright to this source code. In place of
  104070. ** a legal notice, here is a blessing:
  104071. **
  104072. ** May you do good and not evil.
  104073. ** May you find forgiveness for yourself and forgive others.
  104074. ** May you share freely, never taking more than you give.
  104075. **
  104076. *************************************************************************
  104077. ** This file contains code used by the compiler to add foreign key
  104078. ** support to compiled SQL statements.
  104079. */
  104080. /* #include "sqliteInt.h" */
  104081. #ifndef SQLITE_OMIT_FOREIGN_KEY
  104082. #ifndef SQLITE_OMIT_TRIGGER
  104083. /*
  104084. ** Deferred and Immediate FKs
  104085. ** --------------------------
  104086. **
  104087. ** Foreign keys in SQLite come in two flavours: deferred and immediate.
  104088. ** If an immediate foreign key constraint is violated,
  104089. ** SQLITE_CONSTRAINT_FOREIGNKEY is returned and the current
  104090. ** statement transaction rolled back. If a
  104091. ** deferred foreign key constraint is violated, no action is taken
  104092. ** immediately. However if the application attempts to commit the
  104093. ** transaction before fixing the constraint violation, the attempt fails.
  104094. **
  104095. ** Deferred constraints are implemented using a simple counter associated
  104096. ** with the database handle. The counter is set to zero each time a
  104097. ** database transaction is opened. Each time a statement is executed
  104098. ** that causes a foreign key violation, the counter is incremented. Each
  104099. ** time a statement is executed that removes an existing violation from
  104100. ** the database, the counter is decremented. When the transaction is
  104101. ** committed, the commit fails if the current value of the counter is
  104102. ** greater than zero. This scheme has two big drawbacks:
  104103. **
  104104. ** * When a commit fails due to a deferred foreign key constraint,
  104105. ** there is no way to tell which foreign constraint is not satisfied,
  104106. ** or which row it is not satisfied for.
  104107. **
  104108. ** * If the database contains foreign key violations when the
  104109. ** transaction is opened, this may cause the mechanism to malfunction.
  104110. **
  104111. ** Despite these problems, this approach is adopted as it seems simpler
  104112. ** than the alternatives.
  104113. **
  104114. ** INSERT operations:
  104115. **
  104116. ** I.1) For each FK for which the table is the child table, search
  104117. ** the parent table for a match. If none is found increment the
  104118. ** constraint counter.
  104119. **
  104120. ** I.2) For each FK for which the table is the parent table,
  104121. ** search the child table for rows that correspond to the new
  104122. ** row in the parent table. Decrement the counter for each row
  104123. ** found (as the constraint is now satisfied).
  104124. **
  104125. ** DELETE operations:
  104126. **
  104127. ** D.1) For each FK for which the table is the child table,
  104128. ** search the parent table for a row that corresponds to the
  104129. ** deleted row in the child table. If such a row is not found,
  104130. ** decrement the counter.
  104131. **
  104132. ** D.2) For each FK for which the table is the parent table, search
  104133. ** the child table for rows that correspond to the deleted row
  104134. ** in the parent table. For each found increment the counter.
  104135. **
  104136. ** UPDATE operations:
  104137. **
  104138. ** An UPDATE command requires that all 4 steps above are taken, but only
  104139. ** for FK constraints for which the affected columns are actually
  104140. ** modified (values must be compared at runtime).
  104141. **
  104142. ** Note that I.1 and D.1 are very similar operations, as are I.2 and D.2.
  104143. ** This simplifies the implementation a bit.
  104144. **
  104145. ** For the purposes of immediate FK constraints, the OR REPLACE conflict
  104146. ** resolution is considered to delete rows before the new row is inserted.
  104147. ** If a delete caused by OR REPLACE violates an FK constraint, an exception
  104148. ** is thrown, even if the FK constraint would be satisfied after the new
  104149. ** row is inserted.
  104150. **
  104151. ** Immediate constraints are usually handled similarly. The only difference
  104152. ** is that the counter used is stored as part of each individual statement
  104153. ** object (struct Vdbe). If, after the statement has run, its immediate
  104154. ** constraint counter is greater than zero,
  104155. ** it returns SQLITE_CONSTRAINT_FOREIGNKEY
  104156. ** and the statement transaction is rolled back. An exception is an INSERT
  104157. ** statement that inserts a single row only (no triggers). In this case,
  104158. ** instead of using a counter, an exception is thrown immediately if the
  104159. ** INSERT violates a foreign key constraint. This is necessary as such
  104160. ** an INSERT does not open a statement transaction.
  104161. **
  104162. ** TODO: How should dropping a table be handled? How should renaming a
  104163. ** table be handled?
  104164. **
  104165. **
  104166. ** Query API Notes
  104167. ** ---------------
  104168. **
  104169. ** Before coding an UPDATE or DELETE row operation, the code-generator
  104170. ** for those two operations needs to know whether or not the operation
  104171. ** requires any FK processing and, if so, which columns of the original
  104172. ** row are required by the FK processing VDBE code (i.e. if FKs were
  104173. ** implemented using triggers, which of the old.* columns would be
  104174. ** accessed). No information is required by the code-generator before
  104175. ** coding an INSERT operation. The functions used by the UPDATE/DELETE
  104176. ** generation code to query for this information are:
  104177. **
  104178. ** sqlite3FkRequired() - Test to see if FK processing is required.
  104179. ** sqlite3FkOldmask() - Query for the set of required old.* columns.
  104180. **
  104181. **
  104182. ** Externally accessible module functions
  104183. ** --------------------------------------
  104184. **
  104185. ** sqlite3FkCheck() - Check for foreign key violations.
  104186. ** sqlite3FkActions() - Code triggers for ON UPDATE/ON DELETE actions.
  104187. ** sqlite3FkDelete() - Delete an FKey structure.
  104188. */
  104189. /*
  104190. ** VDBE Calling Convention
  104191. ** -----------------------
  104192. **
  104193. ** Example:
  104194. **
  104195. ** For the following INSERT statement:
  104196. **
  104197. ** CREATE TABLE t1(a, b INTEGER PRIMARY KEY, c);
  104198. ** INSERT INTO t1 VALUES(1, 2, 3.1);
  104199. **
  104200. ** Register (x): 2 (type integer)
  104201. ** Register (x+1): 1 (type integer)
  104202. ** Register (x+2): NULL (type NULL)
  104203. ** Register (x+3): 3.1 (type real)
  104204. */
  104205. /*
  104206. ** A foreign key constraint requires that the key columns in the parent
  104207. ** table are collectively subject to a UNIQUE or PRIMARY KEY constraint.
  104208. ** Given that pParent is the parent table for foreign key constraint pFKey,
  104209. ** search the schema for a unique index on the parent key columns.
  104210. **
  104211. ** If successful, zero is returned. If the parent key is an INTEGER PRIMARY
  104212. ** KEY column, then output variable *ppIdx is set to NULL. Otherwise, *ppIdx
  104213. ** is set to point to the unique index.
  104214. **
  104215. ** If the parent key consists of a single column (the foreign key constraint
  104216. ** is not a composite foreign key), output variable *paiCol is set to NULL.
  104217. ** Otherwise, it is set to point to an allocated array of size N, where
  104218. ** N is the number of columns in the parent key. The first element of the
  104219. ** array is the index of the child table column that is mapped by the FK
  104220. ** constraint to the parent table column stored in the left-most column
  104221. ** of index *ppIdx. The second element of the array is the index of the
  104222. ** child table column that corresponds to the second left-most column of
  104223. ** *ppIdx, and so on.
  104224. **
  104225. ** If the required index cannot be found, either because:
  104226. **
  104227. ** 1) The named parent key columns do not exist, or
  104228. **
  104229. ** 2) The named parent key columns do exist, but are not subject to a
  104230. ** UNIQUE or PRIMARY KEY constraint, or
  104231. **
  104232. ** 3) No parent key columns were provided explicitly as part of the
  104233. ** foreign key definition, and the parent table does not have a
  104234. ** PRIMARY KEY, or
  104235. **
  104236. ** 4) No parent key columns were provided explicitly as part of the
  104237. ** foreign key definition, and the PRIMARY KEY of the parent table
  104238. ** consists of a different number of columns to the child key in
  104239. ** the child table.
  104240. **
  104241. ** then non-zero is returned, and a "foreign key mismatch" error loaded
  104242. ** into pParse. If an OOM error occurs, non-zero is returned and the
  104243. ** pParse->db->mallocFailed flag is set.
  104244. */
  104245. SQLITE_PRIVATE int sqlite3FkLocateIndex(
  104246. Parse *pParse, /* Parse context to store any error in */
  104247. Table *pParent, /* Parent table of FK constraint pFKey */
  104248. FKey *pFKey, /* Foreign key to find index for */
  104249. Index **ppIdx, /* OUT: Unique index on parent table */
  104250. int **paiCol /* OUT: Map of index columns in pFKey */
  104251. ){
  104252. Index *pIdx = 0; /* Value to return via *ppIdx */
  104253. int *aiCol = 0; /* Value to return via *paiCol */
  104254. int nCol = pFKey->nCol; /* Number of columns in parent key */
  104255. char *zKey = pFKey->aCol[0].zCol; /* Name of left-most parent key column */
  104256. /* The caller is responsible for zeroing output parameters. */
  104257. assert( ppIdx && *ppIdx==0 );
  104258. assert( !paiCol || *paiCol==0 );
  104259. assert( pParse );
  104260. /* If this is a non-composite (single column) foreign key, check if it
  104261. ** maps to the INTEGER PRIMARY KEY of table pParent. If so, leave *ppIdx
  104262. ** and *paiCol set to zero and return early.
  104263. **
  104264. ** Otherwise, for a composite foreign key (more than one column), allocate
  104265. ** space for the aiCol array (returned via output parameter *paiCol).
  104266. ** Non-composite foreign keys do not require the aiCol array.
  104267. */
  104268. if( nCol==1 ){
  104269. /* The FK maps to the IPK if any of the following are true:
  104270. **
  104271. ** 1) There is an INTEGER PRIMARY KEY column and the FK is implicitly
  104272. ** mapped to the primary key of table pParent, or
  104273. ** 2) The FK is explicitly mapped to a column declared as INTEGER
  104274. ** PRIMARY KEY.
  104275. */
  104276. if( pParent->iPKey>=0 ){
  104277. if( !zKey ) return 0;
  104278. if( !sqlite3StrICmp(pParent->aCol[pParent->iPKey].zName, zKey) ) return 0;
  104279. }
  104280. }else if( paiCol ){
  104281. assert( nCol>1 );
  104282. aiCol = (int *)sqlite3DbMallocRawNN(pParse->db, nCol*sizeof(int));
  104283. if( !aiCol ) return 1;
  104284. *paiCol = aiCol;
  104285. }
  104286. for(pIdx=pParent->pIndex; pIdx; pIdx=pIdx->pNext){
  104287. if( pIdx->nKeyCol==nCol && IsUniqueIndex(pIdx) && pIdx->pPartIdxWhere==0 ){
  104288. /* pIdx is a UNIQUE index (or a PRIMARY KEY) and has the right number
  104289. ** of columns. If each indexed column corresponds to a foreign key
  104290. ** column of pFKey, then this index is a winner. */
  104291. if( zKey==0 ){
  104292. /* If zKey is NULL, then this foreign key is implicitly mapped to
  104293. ** the PRIMARY KEY of table pParent. The PRIMARY KEY index may be
  104294. ** identified by the test. */
  104295. if( IsPrimaryKeyIndex(pIdx) ){
  104296. if( aiCol ){
  104297. int i;
  104298. for(i=0; i<nCol; i++) aiCol[i] = pFKey->aCol[i].iFrom;
  104299. }
  104300. break;
  104301. }
  104302. }else{
  104303. /* If zKey is non-NULL, then this foreign key was declared to
  104304. ** map to an explicit list of columns in table pParent. Check if this
  104305. ** index matches those columns. Also, check that the index uses
  104306. ** the default collation sequences for each column. */
  104307. int i, j;
  104308. for(i=0; i<nCol; i++){
  104309. i16 iCol = pIdx->aiColumn[i]; /* Index of column in parent tbl */
  104310. const char *zDfltColl; /* Def. collation for column */
  104311. char *zIdxCol; /* Name of indexed column */
  104312. if( iCol<0 ) break; /* No foreign keys against expression indexes */
  104313. /* If the index uses a collation sequence that is different from
  104314. ** the default collation sequence for the column, this index is
  104315. ** unusable. Bail out early in this case. */
  104316. zDfltColl = pParent->aCol[iCol].zColl;
  104317. if( !zDfltColl ) zDfltColl = sqlite3StrBINARY;
  104318. if( sqlite3StrICmp(pIdx->azColl[i], zDfltColl) ) break;
  104319. zIdxCol = pParent->aCol[iCol].zName;
  104320. for(j=0; j<nCol; j++){
  104321. if( sqlite3StrICmp(pFKey->aCol[j].zCol, zIdxCol)==0 ){
  104322. if( aiCol ) aiCol[i] = pFKey->aCol[j].iFrom;
  104323. break;
  104324. }
  104325. }
  104326. if( j==nCol ) break;
  104327. }
  104328. if( i==nCol ) break; /* pIdx is usable */
  104329. }
  104330. }
  104331. }
  104332. if( !pIdx ){
  104333. if( !pParse->disableTriggers ){
  104334. sqlite3ErrorMsg(pParse,
  104335. "foreign key mismatch - \"%w\" referencing \"%w\"",
  104336. pFKey->pFrom->zName, pFKey->zTo);
  104337. }
  104338. sqlite3DbFree(pParse->db, aiCol);
  104339. return 1;
  104340. }
  104341. *ppIdx = pIdx;
  104342. return 0;
  104343. }
  104344. /*
  104345. ** This function is called when a row is inserted into or deleted from the
  104346. ** child table of foreign key constraint pFKey. If an SQL UPDATE is executed
  104347. ** on the child table of pFKey, this function is invoked twice for each row
  104348. ** affected - once to "delete" the old row, and then again to "insert" the
  104349. ** new row.
  104350. **
  104351. ** Each time it is called, this function generates VDBE code to locate the
  104352. ** row in the parent table that corresponds to the row being inserted into
  104353. ** or deleted from the child table. If the parent row can be found, no
  104354. ** special action is taken. Otherwise, if the parent row can *not* be
  104355. ** found in the parent table:
  104356. **
  104357. ** Operation | FK type | Action taken
  104358. ** --------------------------------------------------------------------------
  104359. ** INSERT immediate Increment the "immediate constraint counter".
  104360. **
  104361. ** DELETE immediate Decrement the "immediate constraint counter".
  104362. **
  104363. ** INSERT deferred Increment the "deferred constraint counter".
  104364. **
  104365. ** DELETE deferred Decrement the "deferred constraint counter".
  104366. **
  104367. ** These operations are identified in the comment at the top of this file
  104368. ** (fkey.c) as "I.1" and "D.1".
  104369. */
  104370. static void fkLookupParent(
  104371. Parse *pParse, /* Parse context */
  104372. int iDb, /* Index of database housing pTab */
  104373. Table *pTab, /* Parent table of FK pFKey */
  104374. Index *pIdx, /* Unique index on parent key columns in pTab */
  104375. FKey *pFKey, /* Foreign key constraint */
  104376. int *aiCol, /* Map from parent key columns to child table columns */
  104377. int regData, /* Address of array containing child table row */
  104378. int nIncr, /* Increment constraint counter by this */
  104379. int isIgnore /* If true, pretend pTab contains all NULL values */
  104380. ){
  104381. int i; /* Iterator variable */
  104382. Vdbe *v = sqlite3GetVdbe(pParse); /* Vdbe to add code to */
  104383. int iCur = pParse->nTab - 1; /* Cursor number to use */
  104384. int iOk = sqlite3VdbeMakeLabel(v); /* jump here if parent key found */
  104385. /* If nIncr is less than zero, then check at runtime if there are any
  104386. ** outstanding constraints to resolve. If there are not, there is no need
  104387. ** to check if deleting this row resolves any outstanding violations.
  104388. **
  104389. ** Check if any of the key columns in the child table row are NULL. If
  104390. ** any are, then the constraint is considered satisfied. No need to
  104391. ** search for a matching row in the parent table. */
  104392. if( nIncr<0 ){
  104393. sqlite3VdbeAddOp2(v, OP_FkIfZero, pFKey->isDeferred, iOk);
  104394. VdbeCoverage(v);
  104395. }
  104396. for(i=0; i<pFKey->nCol; i++){
  104397. int iReg = aiCol[i] + regData + 1;
  104398. sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iOk); VdbeCoverage(v);
  104399. }
  104400. if( isIgnore==0 ){
  104401. if( pIdx==0 ){
  104402. /* If pIdx is NULL, then the parent key is the INTEGER PRIMARY KEY
  104403. ** column of the parent table (table pTab). */
  104404. int iMustBeInt; /* Address of MustBeInt instruction */
  104405. int regTemp = sqlite3GetTempReg(pParse);
  104406. /* Invoke MustBeInt to coerce the child key value to an integer (i.e.
  104407. ** apply the affinity of the parent key). If this fails, then there
  104408. ** is no matching parent key. Before using MustBeInt, make a copy of
  104409. ** the value. Otherwise, the value inserted into the child key column
  104410. ** will have INTEGER affinity applied to it, which may not be correct. */
  104411. sqlite3VdbeAddOp2(v, OP_SCopy, aiCol[0]+1+regData, regTemp);
  104412. iMustBeInt = sqlite3VdbeAddOp2(v, OP_MustBeInt, regTemp, 0);
  104413. VdbeCoverage(v);
  104414. /* If the parent table is the same as the child table, and we are about
  104415. ** to increment the constraint-counter (i.e. this is an INSERT operation),
  104416. ** then check if the row being inserted matches itself. If so, do not
  104417. ** increment the constraint-counter. */
  104418. if( pTab==pFKey->pFrom && nIncr==1 ){
  104419. sqlite3VdbeAddOp3(v, OP_Eq, regData, iOk, regTemp); VdbeCoverage(v);
  104420. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  104421. }
  104422. sqlite3OpenTable(pParse, iCur, iDb, pTab, OP_OpenRead);
  104423. sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, regTemp); VdbeCoverage(v);
  104424. sqlite3VdbeGoto(v, iOk);
  104425. sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-2);
  104426. sqlite3VdbeJumpHere(v, iMustBeInt);
  104427. sqlite3ReleaseTempReg(pParse, regTemp);
  104428. }else{
  104429. int nCol = pFKey->nCol;
  104430. int regTemp = sqlite3GetTempRange(pParse, nCol);
  104431. int regRec = sqlite3GetTempReg(pParse);
  104432. sqlite3VdbeAddOp3(v, OP_OpenRead, iCur, pIdx->tnum, iDb);
  104433. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  104434. for(i=0; i<nCol; i++){
  104435. sqlite3VdbeAddOp2(v, OP_Copy, aiCol[i]+1+regData, regTemp+i);
  104436. }
  104437. /* If the parent table is the same as the child table, and we are about
  104438. ** to increment the constraint-counter (i.e. this is an INSERT operation),
  104439. ** then check if the row being inserted matches itself. If so, do not
  104440. ** increment the constraint-counter.
  104441. **
  104442. ** If any of the parent-key values are NULL, then the row cannot match
  104443. ** itself. So set JUMPIFNULL to make sure we do the OP_Found if any
  104444. ** of the parent-key values are NULL (at this point it is known that
  104445. ** none of the child key values are).
  104446. */
  104447. if( pTab==pFKey->pFrom && nIncr==1 ){
  104448. int iJump = sqlite3VdbeCurrentAddr(v) + nCol + 1;
  104449. for(i=0; i<nCol; i++){
  104450. int iChild = aiCol[i]+1+regData;
  104451. int iParent = pIdx->aiColumn[i]+1+regData;
  104452. assert( pIdx->aiColumn[i]>=0 );
  104453. assert( aiCol[i]!=pTab->iPKey );
  104454. if( pIdx->aiColumn[i]==pTab->iPKey ){
  104455. /* The parent key is a composite key that includes the IPK column */
  104456. iParent = regData;
  104457. }
  104458. sqlite3VdbeAddOp3(v, OP_Ne, iChild, iJump, iParent); VdbeCoverage(v);
  104459. sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
  104460. }
  104461. sqlite3VdbeGoto(v, iOk);
  104462. }
  104463. sqlite3VdbeAddOp4(v, OP_MakeRecord, regTemp, nCol, regRec,
  104464. sqlite3IndexAffinityStr(pParse->db,pIdx), nCol);
  104465. sqlite3VdbeAddOp4Int(v, OP_Found, iCur, iOk, regRec, 0); VdbeCoverage(v);
  104466. sqlite3ReleaseTempReg(pParse, regRec);
  104467. sqlite3ReleaseTempRange(pParse, regTemp, nCol);
  104468. }
  104469. }
  104470. if( !pFKey->isDeferred && !(pParse->db->flags & SQLITE_DeferFKs)
  104471. && !pParse->pToplevel
  104472. && !pParse->isMultiWrite
  104473. ){
  104474. /* Special case: If this is an INSERT statement that will insert exactly
  104475. ** one row into the table, raise a constraint immediately instead of
  104476. ** incrementing a counter. This is necessary as the VM code is being
  104477. ** generated for will not open a statement transaction. */
  104478. assert( nIncr==1 );
  104479. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_FOREIGNKEY,
  104480. OE_Abort, 0, P4_STATIC, P5_ConstraintFK);
  104481. }else{
  104482. if( nIncr>0 && pFKey->isDeferred==0 ){
  104483. sqlite3MayAbort(pParse);
  104484. }
  104485. sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, nIncr);
  104486. }
  104487. sqlite3VdbeResolveLabel(v, iOk);
  104488. sqlite3VdbeAddOp1(v, OP_Close, iCur);
  104489. }
  104490. /*
  104491. ** Return an Expr object that refers to a memory register corresponding
  104492. ** to column iCol of table pTab.
  104493. **
  104494. ** regBase is the first of an array of register that contains the data
  104495. ** for pTab. regBase itself holds the rowid. regBase+1 holds the first
  104496. ** column. regBase+2 holds the second column, and so forth.
  104497. */
  104498. static Expr *exprTableRegister(
  104499. Parse *pParse, /* Parsing and code generating context */
  104500. Table *pTab, /* The table whose content is at r[regBase]... */
  104501. int regBase, /* Contents of table pTab */
  104502. i16 iCol /* Which column of pTab is desired */
  104503. ){
  104504. Expr *pExpr;
  104505. Column *pCol;
  104506. const char *zColl;
  104507. sqlite3 *db = pParse->db;
  104508. pExpr = sqlite3Expr(db, TK_REGISTER, 0);
  104509. if( pExpr ){
  104510. if( iCol>=0 && iCol!=pTab->iPKey ){
  104511. pCol = &pTab->aCol[iCol];
  104512. pExpr->iTable = regBase + iCol + 1;
  104513. pExpr->affinity = pCol->affinity;
  104514. zColl = pCol->zColl;
  104515. if( zColl==0 ) zColl = db->pDfltColl->zName;
  104516. pExpr = sqlite3ExprAddCollateString(pParse, pExpr, zColl);
  104517. }else{
  104518. pExpr->iTable = regBase;
  104519. pExpr->affinity = SQLITE_AFF_INTEGER;
  104520. }
  104521. }
  104522. return pExpr;
  104523. }
  104524. /*
  104525. ** Return an Expr object that refers to column iCol of table pTab which
  104526. ** has cursor iCur.
  104527. */
  104528. static Expr *exprTableColumn(
  104529. sqlite3 *db, /* The database connection */
  104530. Table *pTab, /* The table whose column is desired */
  104531. int iCursor, /* The open cursor on the table */
  104532. i16 iCol /* The column that is wanted */
  104533. ){
  104534. Expr *pExpr = sqlite3Expr(db, TK_COLUMN, 0);
  104535. if( pExpr ){
  104536. pExpr->pTab = pTab;
  104537. pExpr->iTable = iCursor;
  104538. pExpr->iColumn = iCol;
  104539. }
  104540. return pExpr;
  104541. }
  104542. /*
  104543. ** This function is called to generate code executed when a row is deleted
  104544. ** from the parent table of foreign key constraint pFKey and, if pFKey is
  104545. ** deferred, when a row is inserted into the same table. When generating
  104546. ** code for an SQL UPDATE operation, this function may be called twice -
  104547. ** once to "delete" the old row and once to "insert" the new row.
  104548. **
  104549. ** Parameter nIncr is passed -1 when inserting a row (as this may decrease
  104550. ** the number of FK violations in the db) or +1 when deleting one (as this
  104551. ** may increase the number of FK constraint problems).
  104552. **
  104553. ** The code generated by this function scans through the rows in the child
  104554. ** table that correspond to the parent table row being deleted or inserted.
  104555. ** For each child row found, one of the following actions is taken:
  104556. **
  104557. ** Operation | FK type | Action taken
  104558. ** --------------------------------------------------------------------------
  104559. ** DELETE immediate Increment the "immediate constraint counter".
  104560. ** Or, if the ON (UPDATE|DELETE) action is RESTRICT,
  104561. ** throw a "FOREIGN KEY constraint failed" exception.
  104562. **
  104563. ** INSERT immediate Decrement the "immediate constraint counter".
  104564. **
  104565. ** DELETE deferred Increment the "deferred constraint counter".
  104566. ** Or, if the ON (UPDATE|DELETE) action is RESTRICT,
  104567. ** throw a "FOREIGN KEY constraint failed" exception.
  104568. **
  104569. ** INSERT deferred Decrement the "deferred constraint counter".
  104570. **
  104571. ** These operations are identified in the comment at the top of this file
  104572. ** (fkey.c) as "I.2" and "D.2".
  104573. */
  104574. static void fkScanChildren(
  104575. Parse *pParse, /* Parse context */
  104576. SrcList *pSrc, /* The child table to be scanned */
  104577. Table *pTab, /* The parent table */
  104578. Index *pIdx, /* Index on parent covering the foreign key */
  104579. FKey *pFKey, /* The foreign key linking pSrc to pTab */
  104580. int *aiCol, /* Map from pIdx cols to child table cols */
  104581. int regData, /* Parent row data starts here */
  104582. int nIncr /* Amount to increment deferred counter by */
  104583. ){
  104584. sqlite3 *db = pParse->db; /* Database handle */
  104585. int i; /* Iterator variable */
  104586. Expr *pWhere = 0; /* WHERE clause to scan with */
  104587. NameContext sNameContext; /* Context used to resolve WHERE clause */
  104588. WhereInfo *pWInfo; /* Context used by sqlite3WhereXXX() */
  104589. int iFkIfZero = 0; /* Address of OP_FkIfZero */
  104590. Vdbe *v = sqlite3GetVdbe(pParse);
  104591. assert( pIdx==0 || pIdx->pTable==pTab );
  104592. assert( pIdx==0 || pIdx->nKeyCol==pFKey->nCol );
  104593. assert( pIdx!=0 || pFKey->nCol==1 );
  104594. assert( pIdx!=0 || HasRowid(pTab) );
  104595. if( nIncr<0 ){
  104596. iFkIfZero = sqlite3VdbeAddOp2(v, OP_FkIfZero, pFKey->isDeferred, 0);
  104597. VdbeCoverage(v);
  104598. }
  104599. /* Create an Expr object representing an SQL expression like:
  104600. **
  104601. ** <parent-key1> = <child-key1> AND <parent-key2> = <child-key2> ...
  104602. **
  104603. ** The collation sequence used for the comparison should be that of
  104604. ** the parent key columns. The affinity of the parent key column should
  104605. ** be applied to each child key value before the comparison takes place.
  104606. */
  104607. for(i=0; i<pFKey->nCol; i++){
  104608. Expr *pLeft; /* Value from parent table row */
  104609. Expr *pRight; /* Column ref to child table */
  104610. Expr *pEq; /* Expression (pLeft = pRight) */
  104611. i16 iCol; /* Index of column in child table */
  104612. const char *zCol; /* Name of column in child table */
  104613. iCol = pIdx ? pIdx->aiColumn[i] : -1;
  104614. pLeft = exprTableRegister(pParse, pTab, regData, iCol);
  104615. iCol = aiCol ? aiCol[i] : pFKey->aCol[0].iFrom;
  104616. assert( iCol>=0 );
  104617. zCol = pFKey->pFrom->aCol[iCol].zName;
  104618. pRight = sqlite3Expr(db, TK_ID, zCol);
  104619. pEq = sqlite3PExpr(pParse, TK_EQ, pLeft, pRight);
  104620. pWhere = sqlite3ExprAnd(db, pWhere, pEq);
  104621. }
  104622. /* If the child table is the same as the parent table, then add terms
  104623. ** to the WHERE clause that prevent this entry from being scanned.
  104624. ** The added WHERE clause terms are like this:
  104625. **
  104626. ** $current_rowid!=rowid
  104627. ** NOT( $current_a==a AND $current_b==b AND ... )
  104628. **
  104629. ** The first form is used for rowid tables. The second form is used
  104630. ** for WITHOUT ROWID tables. In the second form, the primary key is
  104631. ** (a,b,...)
  104632. */
  104633. if( pTab==pFKey->pFrom && nIncr>0 ){
  104634. Expr *pNe; /* Expression (pLeft != pRight) */
  104635. Expr *pLeft; /* Value from parent table row */
  104636. Expr *pRight; /* Column ref to child table */
  104637. if( HasRowid(pTab) ){
  104638. pLeft = exprTableRegister(pParse, pTab, regData, -1);
  104639. pRight = exprTableColumn(db, pTab, pSrc->a[0].iCursor, -1);
  104640. pNe = sqlite3PExpr(pParse, TK_NE, pLeft, pRight);
  104641. }else{
  104642. Expr *pEq, *pAll = 0;
  104643. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  104644. assert( pIdx!=0 );
  104645. for(i=0; i<pPk->nKeyCol; i++){
  104646. i16 iCol = pIdx->aiColumn[i];
  104647. assert( iCol>=0 );
  104648. pLeft = exprTableRegister(pParse, pTab, regData, iCol);
  104649. pRight = exprTableColumn(db, pTab, pSrc->a[0].iCursor, iCol);
  104650. pEq = sqlite3PExpr(pParse, TK_EQ, pLeft, pRight);
  104651. pAll = sqlite3ExprAnd(db, pAll, pEq);
  104652. }
  104653. pNe = sqlite3PExpr(pParse, TK_NOT, pAll, 0);
  104654. }
  104655. pWhere = sqlite3ExprAnd(db, pWhere, pNe);
  104656. }
  104657. /* Resolve the references in the WHERE clause. */
  104658. memset(&sNameContext, 0, sizeof(NameContext));
  104659. sNameContext.pSrcList = pSrc;
  104660. sNameContext.pParse = pParse;
  104661. sqlite3ResolveExprNames(&sNameContext, pWhere);
  104662. /* Create VDBE to loop through the entries in pSrc that match the WHERE
  104663. ** clause. For each row found, increment either the deferred or immediate
  104664. ** foreign key constraint counter. */
  104665. if( pParse->nErr==0 ){
  104666. pWInfo = sqlite3WhereBegin(pParse, pSrc, pWhere, 0, 0, 0, 0);
  104667. sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, nIncr);
  104668. if( pWInfo ){
  104669. sqlite3WhereEnd(pWInfo);
  104670. }
  104671. }
  104672. /* Clean up the WHERE clause constructed above. */
  104673. sqlite3ExprDelete(db, pWhere);
  104674. if( iFkIfZero ){
  104675. sqlite3VdbeJumpHere(v, iFkIfZero);
  104676. }
  104677. }
  104678. /*
  104679. ** This function returns a linked list of FKey objects (connected by
  104680. ** FKey.pNextTo) holding all children of table pTab. For example,
  104681. ** given the following schema:
  104682. **
  104683. ** CREATE TABLE t1(a PRIMARY KEY);
  104684. ** CREATE TABLE t2(b REFERENCES t1(a);
  104685. **
  104686. ** Calling this function with table "t1" as an argument returns a pointer
  104687. ** to the FKey structure representing the foreign key constraint on table
  104688. ** "t2". Calling this function with "t2" as the argument would return a
  104689. ** NULL pointer (as there are no FK constraints for which t2 is the parent
  104690. ** table).
  104691. */
  104692. SQLITE_PRIVATE FKey *sqlite3FkReferences(Table *pTab){
  104693. return (FKey *)sqlite3HashFind(&pTab->pSchema->fkeyHash, pTab->zName);
  104694. }
  104695. /*
  104696. ** The second argument is a Trigger structure allocated by the
  104697. ** fkActionTrigger() routine. This function deletes the Trigger structure
  104698. ** and all of its sub-components.
  104699. **
  104700. ** The Trigger structure or any of its sub-components may be allocated from
  104701. ** the lookaside buffer belonging to database handle dbMem.
  104702. */
  104703. static void fkTriggerDelete(sqlite3 *dbMem, Trigger *p){
  104704. if( p ){
  104705. TriggerStep *pStep = p->step_list;
  104706. sqlite3ExprDelete(dbMem, pStep->pWhere);
  104707. sqlite3ExprListDelete(dbMem, pStep->pExprList);
  104708. sqlite3SelectDelete(dbMem, pStep->pSelect);
  104709. sqlite3ExprDelete(dbMem, p->pWhen);
  104710. sqlite3DbFree(dbMem, p);
  104711. }
  104712. }
  104713. /*
  104714. ** This function is called to generate code that runs when table pTab is
  104715. ** being dropped from the database. The SrcList passed as the second argument
  104716. ** to this function contains a single entry guaranteed to resolve to
  104717. ** table pTab.
  104718. **
  104719. ** Normally, no code is required. However, if either
  104720. **
  104721. ** (a) The table is the parent table of a FK constraint, or
  104722. ** (b) The table is the child table of a deferred FK constraint and it is
  104723. ** determined at runtime that there are outstanding deferred FK
  104724. ** constraint violations in the database,
  104725. **
  104726. ** then the equivalent of "DELETE FROM <tbl>" is executed before dropping
  104727. ** the table from the database. Triggers are disabled while running this
  104728. ** DELETE, but foreign key actions are not.
  104729. */
  104730. SQLITE_PRIVATE void sqlite3FkDropTable(Parse *pParse, SrcList *pName, Table *pTab){
  104731. sqlite3 *db = pParse->db;
  104732. if( (db->flags&SQLITE_ForeignKeys) && !IsVirtual(pTab) && !pTab->pSelect ){
  104733. int iSkip = 0;
  104734. Vdbe *v = sqlite3GetVdbe(pParse);
  104735. assert( v ); /* VDBE has already been allocated */
  104736. if( sqlite3FkReferences(pTab)==0 ){
  104737. /* Search for a deferred foreign key constraint for which this table
  104738. ** is the child table. If one cannot be found, return without
  104739. ** generating any VDBE code. If one can be found, then jump over
  104740. ** the entire DELETE if there are no outstanding deferred constraints
  104741. ** when this statement is run. */
  104742. FKey *p;
  104743. for(p=pTab->pFKey; p; p=p->pNextFrom){
  104744. if( p->isDeferred || (db->flags & SQLITE_DeferFKs) ) break;
  104745. }
  104746. if( !p ) return;
  104747. iSkip = sqlite3VdbeMakeLabel(v);
  104748. sqlite3VdbeAddOp2(v, OP_FkIfZero, 1, iSkip); VdbeCoverage(v);
  104749. }
  104750. pParse->disableTriggers = 1;
  104751. sqlite3DeleteFrom(pParse, sqlite3SrcListDup(db, pName, 0), 0, 0, 0);
  104752. pParse->disableTriggers = 0;
  104753. /* If the DELETE has generated immediate foreign key constraint
  104754. ** violations, halt the VDBE and return an error at this point, before
  104755. ** any modifications to the schema are made. This is because statement
  104756. ** transactions are not able to rollback schema changes.
  104757. **
  104758. ** If the SQLITE_DeferFKs flag is set, then this is not required, as
  104759. ** the statement transaction will not be rolled back even if FK
  104760. ** constraints are violated.
  104761. */
  104762. if( (db->flags & SQLITE_DeferFKs)==0 ){
  104763. sqlite3VdbeAddOp2(v, OP_FkIfZero, 0, sqlite3VdbeCurrentAddr(v)+2);
  104764. VdbeCoverage(v);
  104765. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_FOREIGNKEY,
  104766. OE_Abort, 0, P4_STATIC, P5_ConstraintFK);
  104767. }
  104768. if( iSkip ){
  104769. sqlite3VdbeResolveLabel(v, iSkip);
  104770. }
  104771. }
  104772. }
  104773. /*
  104774. ** The second argument points to an FKey object representing a foreign key
  104775. ** for which pTab is the child table. An UPDATE statement against pTab
  104776. ** is currently being processed. For each column of the table that is
  104777. ** actually updated, the corresponding element in the aChange[] array
  104778. ** is zero or greater (if a column is unmodified the corresponding element
  104779. ** is set to -1). If the rowid column is modified by the UPDATE statement
  104780. ** the bChngRowid argument is non-zero.
  104781. **
  104782. ** This function returns true if any of the columns that are part of the
  104783. ** child key for FK constraint *p are modified.
  104784. */
  104785. static int fkChildIsModified(
  104786. Table *pTab, /* Table being updated */
  104787. FKey *p, /* Foreign key for which pTab is the child */
  104788. int *aChange, /* Array indicating modified columns */
  104789. int bChngRowid /* True if rowid is modified by this update */
  104790. ){
  104791. int i;
  104792. for(i=0; i<p->nCol; i++){
  104793. int iChildKey = p->aCol[i].iFrom;
  104794. if( aChange[iChildKey]>=0 ) return 1;
  104795. if( iChildKey==pTab->iPKey && bChngRowid ) return 1;
  104796. }
  104797. return 0;
  104798. }
  104799. /*
  104800. ** The second argument points to an FKey object representing a foreign key
  104801. ** for which pTab is the parent table. An UPDATE statement against pTab
  104802. ** is currently being processed. For each column of the table that is
  104803. ** actually updated, the corresponding element in the aChange[] array
  104804. ** is zero or greater (if a column is unmodified the corresponding element
  104805. ** is set to -1). If the rowid column is modified by the UPDATE statement
  104806. ** the bChngRowid argument is non-zero.
  104807. **
  104808. ** This function returns true if any of the columns that are part of the
  104809. ** parent key for FK constraint *p are modified.
  104810. */
  104811. static int fkParentIsModified(
  104812. Table *pTab,
  104813. FKey *p,
  104814. int *aChange,
  104815. int bChngRowid
  104816. ){
  104817. int i;
  104818. for(i=0; i<p->nCol; i++){
  104819. char *zKey = p->aCol[i].zCol;
  104820. int iKey;
  104821. for(iKey=0; iKey<pTab->nCol; iKey++){
  104822. if( aChange[iKey]>=0 || (iKey==pTab->iPKey && bChngRowid) ){
  104823. Column *pCol = &pTab->aCol[iKey];
  104824. if( zKey ){
  104825. if( 0==sqlite3StrICmp(pCol->zName, zKey) ) return 1;
  104826. }else if( pCol->colFlags & COLFLAG_PRIMKEY ){
  104827. return 1;
  104828. }
  104829. }
  104830. }
  104831. }
  104832. return 0;
  104833. }
  104834. /*
  104835. ** Return true if the parser passed as the first argument is being
  104836. ** used to code a trigger that is really a "SET NULL" action belonging
  104837. ** to trigger pFKey.
  104838. */
  104839. static int isSetNullAction(Parse *pParse, FKey *pFKey){
  104840. Parse *pTop = sqlite3ParseToplevel(pParse);
  104841. if( pTop->pTriggerPrg ){
  104842. Trigger *p = pTop->pTriggerPrg->pTrigger;
  104843. if( (p==pFKey->apTrigger[0] && pFKey->aAction[0]==OE_SetNull)
  104844. || (p==pFKey->apTrigger[1] && pFKey->aAction[1]==OE_SetNull)
  104845. ){
  104846. return 1;
  104847. }
  104848. }
  104849. return 0;
  104850. }
  104851. /*
  104852. ** This function is called when inserting, deleting or updating a row of
  104853. ** table pTab to generate VDBE code to perform foreign key constraint
  104854. ** processing for the operation.
  104855. **
  104856. ** For a DELETE operation, parameter regOld is passed the index of the
  104857. ** first register in an array of (pTab->nCol+1) registers containing the
  104858. ** rowid of the row being deleted, followed by each of the column values
  104859. ** of the row being deleted, from left to right. Parameter regNew is passed
  104860. ** zero in this case.
  104861. **
  104862. ** For an INSERT operation, regOld is passed zero and regNew is passed the
  104863. ** first register of an array of (pTab->nCol+1) registers containing the new
  104864. ** row data.
  104865. **
  104866. ** For an UPDATE operation, this function is called twice. Once before
  104867. ** the original record is deleted from the table using the calling convention
  104868. ** described for DELETE. Then again after the original record is deleted
  104869. ** but before the new record is inserted using the INSERT convention.
  104870. */
  104871. SQLITE_PRIVATE void sqlite3FkCheck(
  104872. Parse *pParse, /* Parse context */
  104873. Table *pTab, /* Row is being deleted from this table */
  104874. int regOld, /* Previous row data is stored here */
  104875. int regNew, /* New row data is stored here */
  104876. int *aChange, /* Array indicating UPDATEd columns (or 0) */
  104877. int bChngRowid /* True if rowid is UPDATEd */
  104878. ){
  104879. sqlite3 *db = pParse->db; /* Database handle */
  104880. FKey *pFKey; /* Used to iterate through FKs */
  104881. int iDb; /* Index of database containing pTab */
  104882. const char *zDb; /* Name of database containing pTab */
  104883. int isIgnoreErrors = pParse->disableTriggers;
  104884. /* Exactly one of regOld and regNew should be non-zero. */
  104885. assert( (regOld==0)!=(regNew==0) );
  104886. /* If foreign-keys are disabled, this function is a no-op. */
  104887. if( (db->flags&SQLITE_ForeignKeys)==0 ) return;
  104888. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  104889. zDb = db->aDb[iDb].zDbSName;
  104890. /* Loop through all the foreign key constraints for which pTab is the
  104891. ** child table (the table that the foreign key definition is part of). */
  104892. for(pFKey=pTab->pFKey; pFKey; pFKey=pFKey->pNextFrom){
  104893. Table *pTo; /* Parent table of foreign key pFKey */
  104894. Index *pIdx = 0; /* Index on key columns in pTo */
  104895. int *aiFree = 0;
  104896. int *aiCol;
  104897. int iCol;
  104898. int i;
  104899. int bIgnore = 0;
  104900. if( aChange
  104901. && sqlite3_stricmp(pTab->zName, pFKey->zTo)!=0
  104902. && fkChildIsModified(pTab, pFKey, aChange, bChngRowid)==0
  104903. ){
  104904. continue;
  104905. }
  104906. /* Find the parent table of this foreign key. Also find a unique index
  104907. ** on the parent key columns in the parent table. If either of these
  104908. ** schema items cannot be located, set an error in pParse and return
  104909. ** early. */
  104910. if( pParse->disableTriggers ){
  104911. pTo = sqlite3FindTable(db, pFKey->zTo, zDb);
  104912. }else{
  104913. pTo = sqlite3LocateTable(pParse, 0, pFKey->zTo, zDb);
  104914. }
  104915. if( !pTo || sqlite3FkLocateIndex(pParse, pTo, pFKey, &pIdx, &aiFree) ){
  104916. assert( isIgnoreErrors==0 || (regOld!=0 && regNew==0) );
  104917. if( !isIgnoreErrors || db->mallocFailed ) return;
  104918. if( pTo==0 ){
  104919. /* If isIgnoreErrors is true, then a table is being dropped. In this
  104920. ** case SQLite runs a "DELETE FROM xxx" on the table being dropped
  104921. ** before actually dropping it in order to check FK constraints.
  104922. ** If the parent table of an FK constraint on the current table is
  104923. ** missing, behave as if it is empty. i.e. decrement the relevant
  104924. ** FK counter for each row of the current table with non-NULL keys.
  104925. */
  104926. Vdbe *v = sqlite3GetVdbe(pParse);
  104927. int iJump = sqlite3VdbeCurrentAddr(v) + pFKey->nCol + 1;
  104928. for(i=0; i<pFKey->nCol; i++){
  104929. int iReg = pFKey->aCol[i].iFrom + regOld + 1;
  104930. sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iJump); VdbeCoverage(v);
  104931. }
  104932. sqlite3VdbeAddOp2(v, OP_FkCounter, pFKey->isDeferred, -1);
  104933. }
  104934. continue;
  104935. }
  104936. assert( pFKey->nCol==1 || (aiFree && pIdx) );
  104937. if( aiFree ){
  104938. aiCol = aiFree;
  104939. }else{
  104940. iCol = pFKey->aCol[0].iFrom;
  104941. aiCol = &iCol;
  104942. }
  104943. for(i=0; i<pFKey->nCol; i++){
  104944. if( aiCol[i]==pTab->iPKey ){
  104945. aiCol[i] = -1;
  104946. }
  104947. assert( pIdx==0 || pIdx->aiColumn[i]>=0 );
  104948. #ifndef SQLITE_OMIT_AUTHORIZATION
  104949. /* Request permission to read the parent key columns. If the
  104950. ** authorization callback returns SQLITE_IGNORE, behave as if any
  104951. ** values read from the parent table are NULL. */
  104952. if( db->xAuth ){
  104953. int rcauth;
  104954. char *zCol = pTo->aCol[pIdx ? pIdx->aiColumn[i] : pTo->iPKey].zName;
  104955. rcauth = sqlite3AuthReadCol(pParse, pTo->zName, zCol, iDb);
  104956. bIgnore = (rcauth==SQLITE_IGNORE);
  104957. }
  104958. #endif
  104959. }
  104960. /* Take a shared-cache advisory read-lock on the parent table. Allocate
  104961. ** a cursor to use to search the unique index on the parent key columns
  104962. ** in the parent table. */
  104963. sqlite3TableLock(pParse, iDb, pTo->tnum, 0, pTo->zName);
  104964. pParse->nTab++;
  104965. if( regOld!=0 ){
  104966. /* A row is being removed from the child table. Search for the parent.
  104967. ** If the parent does not exist, removing the child row resolves an
  104968. ** outstanding foreign key constraint violation. */
  104969. fkLookupParent(pParse, iDb, pTo, pIdx, pFKey, aiCol, regOld, -1, bIgnore);
  104970. }
  104971. if( regNew!=0 && !isSetNullAction(pParse, pFKey) ){
  104972. /* A row is being added to the child table. If a parent row cannot
  104973. ** be found, adding the child row has violated the FK constraint.
  104974. **
  104975. ** If this operation is being performed as part of a trigger program
  104976. ** that is actually a "SET NULL" action belonging to this very
  104977. ** foreign key, then omit this scan altogether. As all child key
  104978. ** values are guaranteed to be NULL, it is not possible for adding
  104979. ** this row to cause an FK violation. */
  104980. fkLookupParent(pParse, iDb, pTo, pIdx, pFKey, aiCol, regNew, +1, bIgnore);
  104981. }
  104982. sqlite3DbFree(db, aiFree);
  104983. }
  104984. /* Loop through all the foreign key constraints that refer to this table.
  104985. ** (the "child" constraints) */
  104986. for(pFKey = sqlite3FkReferences(pTab); pFKey; pFKey=pFKey->pNextTo){
  104987. Index *pIdx = 0; /* Foreign key index for pFKey */
  104988. SrcList *pSrc;
  104989. int *aiCol = 0;
  104990. if( aChange && fkParentIsModified(pTab, pFKey, aChange, bChngRowid)==0 ){
  104991. continue;
  104992. }
  104993. if( !pFKey->isDeferred && !(db->flags & SQLITE_DeferFKs)
  104994. && !pParse->pToplevel && !pParse->isMultiWrite
  104995. ){
  104996. assert( regOld==0 && regNew!=0 );
  104997. /* Inserting a single row into a parent table cannot cause (or fix)
  104998. ** an immediate foreign key violation. So do nothing in this case. */
  104999. continue;
  105000. }
  105001. if( sqlite3FkLocateIndex(pParse, pTab, pFKey, &pIdx, &aiCol) ){
  105002. if( !isIgnoreErrors || db->mallocFailed ) return;
  105003. continue;
  105004. }
  105005. assert( aiCol || pFKey->nCol==1 );
  105006. /* Create a SrcList structure containing the child table. We need the
  105007. ** child table as a SrcList for sqlite3WhereBegin() */
  105008. pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
  105009. if( pSrc ){
  105010. struct SrcList_item *pItem = pSrc->a;
  105011. pItem->pTab = pFKey->pFrom;
  105012. pItem->zName = pFKey->pFrom->zName;
  105013. pItem->pTab->nTabRef++;
  105014. pItem->iCursor = pParse->nTab++;
  105015. if( regNew!=0 ){
  105016. fkScanChildren(pParse, pSrc, pTab, pIdx, pFKey, aiCol, regNew, -1);
  105017. }
  105018. if( regOld!=0 ){
  105019. int eAction = pFKey->aAction[aChange!=0];
  105020. fkScanChildren(pParse, pSrc, pTab, pIdx, pFKey, aiCol, regOld, 1);
  105021. /* If this is a deferred FK constraint, or a CASCADE or SET NULL
  105022. ** action applies, then any foreign key violations caused by
  105023. ** removing the parent key will be rectified by the action trigger.
  105024. ** So do not set the "may-abort" flag in this case.
  105025. **
  105026. ** Note 1: If the FK is declared "ON UPDATE CASCADE", then the
  105027. ** may-abort flag will eventually be set on this statement anyway
  105028. ** (when this function is called as part of processing the UPDATE
  105029. ** within the action trigger).
  105030. **
  105031. ** Note 2: At first glance it may seem like SQLite could simply omit
  105032. ** all OP_FkCounter related scans when either CASCADE or SET NULL
  105033. ** applies. The trouble starts if the CASCADE or SET NULL action
  105034. ** trigger causes other triggers or action rules attached to the
  105035. ** child table to fire. In these cases the fk constraint counters
  105036. ** might be set incorrectly if any OP_FkCounter related scans are
  105037. ** omitted. */
  105038. if( !pFKey->isDeferred && eAction!=OE_Cascade && eAction!=OE_SetNull ){
  105039. sqlite3MayAbort(pParse);
  105040. }
  105041. }
  105042. pItem->zName = 0;
  105043. sqlite3SrcListDelete(db, pSrc);
  105044. }
  105045. sqlite3DbFree(db, aiCol);
  105046. }
  105047. }
  105048. #define COLUMN_MASK(x) (((x)>31) ? 0xffffffff : ((u32)1<<(x)))
  105049. /*
  105050. ** This function is called before generating code to update or delete a
  105051. ** row contained in table pTab.
  105052. */
  105053. SQLITE_PRIVATE u32 sqlite3FkOldmask(
  105054. Parse *pParse, /* Parse context */
  105055. Table *pTab /* Table being modified */
  105056. ){
  105057. u32 mask = 0;
  105058. if( pParse->db->flags&SQLITE_ForeignKeys ){
  105059. FKey *p;
  105060. int i;
  105061. for(p=pTab->pFKey; p; p=p->pNextFrom){
  105062. for(i=0; i<p->nCol; i++) mask |= COLUMN_MASK(p->aCol[i].iFrom);
  105063. }
  105064. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  105065. Index *pIdx = 0;
  105066. sqlite3FkLocateIndex(pParse, pTab, p, &pIdx, 0);
  105067. if( pIdx ){
  105068. for(i=0; i<pIdx->nKeyCol; i++){
  105069. assert( pIdx->aiColumn[i]>=0 );
  105070. mask |= COLUMN_MASK(pIdx->aiColumn[i]);
  105071. }
  105072. }
  105073. }
  105074. }
  105075. return mask;
  105076. }
  105077. /*
  105078. ** This function is called before generating code to update or delete a
  105079. ** row contained in table pTab. If the operation is a DELETE, then
  105080. ** parameter aChange is passed a NULL value. For an UPDATE, aChange points
  105081. ** to an array of size N, where N is the number of columns in table pTab.
  105082. ** If the i'th column is not modified by the UPDATE, then the corresponding
  105083. ** entry in the aChange[] array is set to -1. If the column is modified,
  105084. ** the value is 0 or greater. Parameter chngRowid is set to true if the
  105085. ** UPDATE statement modifies the rowid fields of the table.
  105086. **
  105087. ** If any foreign key processing will be required, this function returns
  105088. ** non-zero. If there is no foreign key related processing, this function
  105089. ** returns zero.
  105090. **
  105091. ** For an UPDATE, this function returns 2 if:
  105092. **
  105093. ** * There are any FKs for which pTab is the child and the parent table, or
  105094. ** * the UPDATE modifies one or more parent keys for which the action is
  105095. ** not "NO ACTION" (i.e. is CASCADE, SET DEFAULT or SET NULL).
  105096. **
  105097. ** Or, assuming some other foreign key processing is required, 1.
  105098. */
  105099. SQLITE_PRIVATE int sqlite3FkRequired(
  105100. Parse *pParse, /* Parse context */
  105101. Table *pTab, /* Table being modified */
  105102. int *aChange, /* Non-NULL for UPDATE operations */
  105103. int chngRowid /* True for UPDATE that affects rowid */
  105104. ){
  105105. int eRet = 0;
  105106. if( pParse->db->flags&SQLITE_ForeignKeys ){
  105107. if( !aChange ){
  105108. /* A DELETE operation. Foreign key processing is required if the
  105109. ** table in question is either the child or parent table for any
  105110. ** foreign key constraint. */
  105111. eRet = (sqlite3FkReferences(pTab) || pTab->pFKey);
  105112. }else{
  105113. /* This is an UPDATE. Foreign key processing is only required if the
  105114. ** operation modifies one or more child or parent key columns. */
  105115. FKey *p;
  105116. /* Check if any child key columns are being modified. */
  105117. for(p=pTab->pFKey; p; p=p->pNextFrom){
  105118. if( 0==sqlite3_stricmp(pTab->zName, p->zTo) ) return 2;
  105119. if( fkChildIsModified(pTab, p, aChange, chngRowid) ){
  105120. eRet = 1;
  105121. }
  105122. }
  105123. /* Check if any parent key columns are being modified. */
  105124. for(p=sqlite3FkReferences(pTab); p; p=p->pNextTo){
  105125. if( fkParentIsModified(pTab, p, aChange, chngRowid) ){
  105126. if( p->aAction[1]!=OE_None ) return 2;
  105127. eRet = 1;
  105128. }
  105129. }
  105130. }
  105131. }
  105132. return eRet;
  105133. }
  105134. /*
  105135. ** This function is called when an UPDATE or DELETE operation is being
  105136. ** compiled on table pTab, which is the parent table of foreign-key pFKey.
  105137. ** If the current operation is an UPDATE, then the pChanges parameter is
  105138. ** passed a pointer to the list of columns being modified. If it is a
  105139. ** DELETE, pChanges is passed a NULL pointer.
  105140. **
  105141. ** It returns a pointer to a Trigger structure containing a trigger
  105142. ** equivalent to the ON UPDATE or ON DELETE action specified by pFKey.
  105143. ** If the action is "NO ACTION" or "RESTRICT", then a NULL pointer is
  105144. ** returned (these actions require no special handling by the triggers
  105145. ** sub-system, code for them is created by fkScanChildren()).
  105146. **
  105147. ** For example, if pFKey is the foreign key and pTab is table "p" in
  105148. ** the following schema:
  105149. **
  105150. ** CREATE TABLE p(pk PRIMARY KEY);
  105151. ** CREATE TABLE c(ck REFERENCES p ON DELETE CASCADE);
  105152. **
  105153. ** then the returned trigger structure is equivalent to:
  105154. **
  105155. ** CREATE TRIGGER ... DELETE ON p BEGIN
  105156. ** DELETE FROM c WHERE ck = old.pk;
  105157. ** END;
  105158. **
  105159. ** The returned pointer is cached as part of the foreign key object. It
  105160. ** is eventually freed along with the rest of the foreign key object by
  105161. ** sqlite3FkDelete().
  105162. */
  105163. static Trigger *fkActionTrigger(
  105164. Parse *pParse, /* Parse context */
  105165. Table *pTab, /* Table being updated or deleted from */
  105166. FKey *pFKey, /* Foreign key to get action for */
  105167. ExprList *pChanges /* Change-list for UPDATE, NULL for DELETE */
  105168. ){
  105169. sqlite3 *db = pParse->db; /* Database handle */
  105170. int action; /* One of OE_None, OE_Cascade etc. */
  105171. Trigger *pTrigger; /* Trigger definition to return */
  105172. int iAction = (pChanges!=0); /* 1 for UPDATE, 0 for DELETE */
  105173. action = pFKey->aAction[iAction];
  105174. if( action==OE_Restrict && (db->flags & SQLITE_DeferFKs) ){
  105175. return 0;
  105176. }
  105177. pTrigger = pFKey->apTrigger[iAction];
  105178. if( action!=OE_None && !pTrigger ){
  105179. char const *zFrom; /* Name of child table */
  105180. int nFrom; /* Length in bytes of zFrom */
  105181. Index *pIdx = 0; /* Parent key index for this FK */
  105182. int *aiCol = 0; /* child table cols -> parent key cols */
  105183. TriggerStep *pStep = 0; /* First (only) step of trigger program */
  105184. Expr *pWhere = 0; /* WHERE clause of trigger step */
  105185. ExprList *pList = 0; /* Changes list if ON UPDATE CASCADE */
  105186. Select *pSelect = 0; /* If RESTRICT, "SELECT RAISE(...)" */
  105187. int i; /* Iterator variable */
  105188. Expr *pWhen = 0; /* WHEN clause for the trigger */
  105189. if( sqlite3FkLocateIndex(pParse, pTab, pFKey, &pIdx, &aiCol) ) return 0;
  105190. assert( aiCol || pFKey->nCol==1 );
  105191. for(i=0; i<pFKey->nCol; i++){
  105192. Token tOld = { "old", 3 }; /* Literal "old" token */
  105193. Token tNew = { "new", 3 }; /* Literal "new" token */
  105194. Token tFromCol; /* Name of column in child table */
  105195. Token tToCol; /* Name of column in parent table */
  105196. int iFromCol; /* Idx of column in child table */
  105197. Expr *pEq; /* tFromCol = OLD.tToCol */
  105198. iFromCol = aiCol ? aiCol[i] : pFKey->aCol[0].iFrom;
  105199. assert( iFromCol>=0 );
  105200. assert( pIdx!=0 || (pTab->iPKey>=0 && pTab->iPKey<pTab->nCol) );
  105201. assert( pIdx==0 || pIdx->aiColumn[i]>=0 );
  105202. sqlite3TokenInit(&tToCol,
  105203. pTab->aCol[pIdx ? pIdx->aiColumn[i] : pTab->iPKey].zName);
  105204. sqlite3TokenInit(&tFromCol, pFKey->pFrom->aCol[iFromCol].zName);
  105205. /* Create the expression "OLD.zToCol = zFromCol". It is important
  105206. ** that the "OLD.zToCol" term is on the LHS of the = operator, so
  105207. ** that the affinity and collation sequence associated with the
  105208. ** parent table are used for the comparison. */
  105209. pEq = sqlite3PExpr(pParse, TK_EQ,
  105210. sqlite3PExpr(pParse, TK_DOT,
  105211. sqlite3ExprAlloc(db, TK_ID, &tOld, 0),
  105212. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0)),
  105213. sqlite3ExprAlloc(db, TK_ID, &tFromCol, 0)
  105214. );
  105215. pWhere = sqlite3ExprAnd(db, pWhere, pEq);
  105216. /* For ON UPDATE, construct the next term of the WHEN clause.
  105217. ** The final WHEN clause will be like this:
  105218. **
  105219. ** WHEN NOT(old.col1 IS new.col1 AND ... AND old.colN IS new.colN)
  105220. */
  105221. if( pChanges ){
  105222. pEq = sqlite3PExpr(pParse, TK_IS,
  105223. sqlite3PExpr(pParse, TK_DOT,
  105224. sqlite3ExprAlloc(db, TK_ID, &tOld, 0),
  105225. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0)),
  105226. sqlite3PExpr(pParse, TK_DOT,
  105227. sqlite3ExprAlloc(db, TK_ID, &tNew, 0),
  105228. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0))
  105229. );
  105230. pWhen = sqlite3ExprAnd(db, pWhen, pEq);
  105231. }
  105232. if( action!=OE_Restrict && (action!=OE_Cascade || pChanges) ){
  105233. Expr *pNew;
  105234. if( action==OE_Cascade ){
  105235. pNew = sqlite3PExpr(pParse, TK_DOT,
  105236. sqlite3ExprAlloc(db, TK_ID, &tNew, 0),
  105237. sqlite3ExprAlloc(db, TK_ID, &tToCol, 0));
  105238. }else if( action==OE_SetDflt ){
  105239. Expr *pDflt = pFKey->pFrom->aCol[iFromCol].pDflt;
  105240. if( pDflt ){
  105241. pNew = sqlite3ExprDup(db, pDflt, 0);
  105242. }else{
  105243. pNew = sqlite3ExprAlloc(db, TK_NULL, 0, 0);
  105244. }
  105245. }else{
  105246. pNew = sqlite3ExprAlloc(db, TK_NULL, 0, 0);
  105247. }
  105248. pList = sqlite3ExprListAppend(pParse, pList, pNew);
  105249. sqlite3ExprListSetName(pParse, pList, &tFromCol, 0);
  105250. }
  105251. }
  105252. sqlite3DbFree(db, aiCol);
  105253. zFrom = pFKey->pFrom->zName;
  105254. nFrom = sqlite3Strlen30(zFrom);
  105255. if( action==OE_Restrict ){
  105256. Token tFrom;
  105257. Expr *pRaise;
  105258. tFrom.z = zFrom;
  105259. tFrom.n = nFrom;
  105260. pRaise = sqlite3Expr(db, TK_RAISE, "FOREIGN KEY constraint failed");
  105261. if( pRaise ){
  105262. pRaise->affinity = OE_Abort;
  105263. }
  105264. pSelect = sqlite3SelectNew(pParse,
  105265. sqlite3ExprListAppend(pParse, 0, pRaise),
  105266. sqlite3SrcListAppend(db, 0, &tFrom, 0),
  105267. pWhere,
  105268. 0, 0, 0, 0, 0
  105269. );
  105270. pWhere = 0;
  105271. }
  105272. /* Disable lookaside memory allocation */
  105273. db->lookaside.bDisable++;
  105274. pTrigger = (Trigger *)sqlite3DbMallocZero(db,
  105275. sizeof(Trigger) + /* struct Trigger */
  105276. sizeof(TriggerStep) + /* Single step in trigger program */
  105277. nFrom + 1 /* Space for pStep->zTarget */
  105278. );
  105279. if( pTrigger ){
  105280. pStep = pTrigger->step_list = (TriggerStep *)&pTrigger[1];
  105281. pStep->zTarget = (char *)&pStep[1];
  105282. memcpy((char *)pStep->zTarget, zFrom, nFrom);
  105283. pStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
  105284. pStep->pExprList = sqlite3ExprListDup(db, pList, EXPRDUP_REDUCE);
  105285. pStep->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
  105286. if( pWhen ){
  105287. pWhen = sqlite3PExpr(pParse, TK_NOT, pWhen, 0);
  105288. pTrigger->pWhen = sqlite3ExprDup(db, pWhen, EXPRDUP_REDUCE);
  105289. }
  105290. }
  105291. /* Re-enable the lookaside buffer, if it was disabled earlier. */
  105292. db->lookaside.bDisable--;
  105293. sqlite3ExprDelete(db, pWhere);
  105294. sqlite3ExprDelete(db, pWhen);
  105295. sqlite3ExprListDelete(db, pList);
  105296. sqlite3SelectDelete(db, pSelect);
  105297. if( db->mallocFailed==1 ){
  105298. fkTriggerDelete(db, pTrigger);
  105299. return 0;
  105300. }
  105301. assert( pStep!=0 );
  105302. switch( action ){
  105303. case OE_Restrict:
  105304. pStep->op = TK_SELECT;
  105305. break;
  105306. case OE_Cascade:
  105307. if( !pChanges ){
  105308. pStep->op = TK_DELETE;
  105309. break;
  105310. }
  105311. default:
  105312. pStep->op = TK_UPDATE;
  105313. }
  105314. pStep->pTrig = pTrigger;
  105315. pTrigger->pSchema = pTab->pSchema;
  105316. pTrigger->pTabSchema = pTab->pSchema;
  105317. pFKey->apTrigger[iAction] = pTrigger;
  105318. pTrigger->op = (pChanges ? TK_UPDATE : TK_DELETE);
  105319. }
  105320. return pTrigger;
  105321. }
  105322. /*
  105323. ** This function is called when deleting or updating a row to implement
  105324. ** any required CASCADE, SET NULL or SET DEFAULT actions.
  105325. */
  105326. SQLITE_PRIVATE void sqlite3FkActions(
  105327. Parse *pParse, /* Parse context */
  105328. Table *pTab, /* Table being updated or deleted from */
  105329. ExprList *pChanges, /* Change-list for UPDATE, NULL for DELETE */
  105330. int regOld, /* Address of array containing old row */
  105331. int *aChange, /* Array indicating UPDATEd columns (or 0) */
  105332. int bChngRowid /* True if rowid is UPDATEd */
  105333. ){
  105334. /* If foreign-key support is enabled, iterate through all FKs that
  105335. ** refer to table pTab. If there is an action associated with the FK
  105336. ** for this operation (either update or delete), invoke the associated
  105337. ** trigger sub-program. */
  105338. if( pParse->db->flags&SQLITE_ForeignKeys ){
  105339. FKey *pFKey; /* Iterator variable */
  105340. for(pFKey = sqlite3FkReferences(pTab); pFKey; pFKey=pFKey->pNextTo){
  105341. if( aChange==0 || fkParentIsModified(pTab, pFKey, aChange, bChngRowid) ){
  105342. Trigger *pAct = fkActionTrigger(pParse, pTab, pFKey, pChanges);
  105343. if( pAct ){
  105344. sqlite3CodeRowTriggerDirect(pParse, pAct, pTab, regOld, OE_Abort, 0);
  105345. }
  105346. }
  105347. }
  105348. }
  105349. }
  105350. #endif /* ifndef SQLITE_OMIT_TRIGGER */
  105351. /*
  105352. ** Free all memory associated with foreign key definitions attached to
  105353. ** table pTab. Remove the deleted foreign keys from the Schema.fkeyHash
  105354. ** hash table.
  105355. */
  105356. SQLITE_PRIVATE void sqlite3FkDelete(sqlite3 *db, Table *pTab){
  105357. FKey *pFKey; /* Iterator variable */
  105358. FKey *pNext; /* Copy of pFKey->pNextFrom */
  105359. assert( db==0 || IsVirtual(pTab)
  105360. || sqlite3SchemaMutexHeld(db, 0, pTab->pSchema) );
  105361. for(pFKey=pTab->pFKey; pFKey; pFKey=pNext){
  105362. /* Remove the FK from the fkeyHash hash table. */
  105363. if( !db || db->pnBytesFreed==0 ){
  105364. if( pFKey->pPrevTo ){
  105365. pFKey->pPrevTo->pNextTo = pFKey->pNextTo;
  105366. }else{
  105367. void *p = (void *)pFKey->pNextTo;
  105368. const char *z = (p ? pFKey->pNextTo->zTo : pFKey->zTo);
  105369. sqlite3HashInsert(&pTab->pSchema->fkeyHash, z, p);
  105370. }
  105371. if( pFKey->pNextTo ){
  105372. pFKey->pNextTo->pPrevTo = pFKey->pPrevTo;
  105373. }
  105374. }
  105375. /* EV: R-30323-21917 Each foreign key constraint in SQLite is
  105376. ** classified as either immediate or deferred.
  105377. */
  105378. assert( pFKey->isDeferred==0 || pFKey->isDeferred==1 );
  105379. /* Delete any triggers created to implement actions for this FK. */
  105380. #ifndef SQLITE_OMIT_TRIGGER
  105381. fkTriggerDelete(db, pFKey->apTrigger[0]);
  105382. fkTriggerDelete(db, pFKey->apTrigger[1]);
  105383. #endif
  105384. pNext = pFKey->pNextFrom;
  105385. sqlite3DbFree(db, pFKey);
  105386. }
  105387. }
  105388. #endif /* ifndef SQLITE_OMIT_FOREIGN_KEY */
  105389. /************** End of fkey.c ************************************************/
  105390. /************** Begin file insert.c ******************************************/
  105391. /*
  105392. ** 2001 September 15
  105393. **
  105394. ** The author disclaims copyright to this source code. In place of
  105395. ** a legal notice, here is a blessing:
  105396. **
  105397. ** May you do good and not evil.
  105398. ** May you find forgiveness for yourself and forgive others.
  105399. ** May you share freely, never taking more than you give.
  105400. **
  105401. *************************************************************************
  105402. ** This file contains C code routines that are called by the parser
  105403. ** to handle INSERT statements in SQLite.
  105404. */
  105405. /* #include "sqliteInt.h" */
  105406. /*
  105407. ** Generate code that will
  105408. **
  105409. ** (1) acquire a lock for table pTab then
  105410. ** (2) open pTab as cursor iCur.
  105411. **
  105412. ** If pTab is a WITHOUT ROWID table, then it is the PRIMARY KEY index
  105413. ** for that table that is actually opened.
  105414. */
  105415. SQLITE_PRIVATE void sqlite3OpenTable(
  105416. Parse *pParse, /* Generate code into this VDBE */
  105417. int iCur, /* The cursor number of the table */
  105418. int iDb, /* The database index in sqlite3.aDb[] */
  105419. Table *pTab, /* The table to be opened */
  105420. int opcode /* OP_OpenRead or OP_OpenWrite */
  105421. ){
  105422. Vdbe *v;
  105423. assert( !IsVirtual(pTab) );
  105424. v = sqlite3GetVdbe(pParse);
  105425. assert( opcode==OP_OpenWrite || opcode==OP_OpenRead );
  105426. sqlite3TableLock(pParse, iDb, pTab->tnum,
  105427. (opcode==OP_OpenWrite)?1:0, pTab->zName);
  105428. if( HasRowid(pTab) ){
  105429. sqlite3VdbeAddOp4Int(v, opcode, iCur, pTab->tnum, iDb, pTab->nCol);
  105430. VdbeComment((v, "%s", pTab->zName));
  105431. }else{
  105432. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  105433. assert( pPk!=0 );
  105434. assert( pPk->tnum==pTab->tnum );
  105435. sqlite3VdbeAddOp3(v, opcode, iCur, pPk->tnum, iDb);
  105436. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  105437. VdbeComment((v, "%s", pTab->zName));
  105438. }
  105439. }
  105440. /*
  105441. ** Return a pointer to the column affinity string associated with index
  105442. ** pIdx. A column affinity string has one character for each column in
  105443. ** the table, according to the affinity of the column:
  105444. **
  105445. ** Character Column affinity
  105446. ** ------------------------------
  105447. ** 'A' BLOB
  105448. ** 'B' TEXT
  105449. ** 'C' NUMERIC
  105450. ** 'D' INTEGER
  105451. ** 'F' REAL
  105452. **
  105453. ** An extra 'D' is appended to the end of the string to cover the
  105454. ** rowid that appears as the last column in every index.
  105455. **
  105456. ** Memory for the buffer containing the column index affinity string
  105457. ** is managed along with the rest of the Index structure. It will be
  105458. ** released when sqlite3DeleteIndex() is called.
  105459. */
  105460. SQLITE_PRIVATE const char *sqlite3IndexAffinityStr(sqlite3 *db, Index *pIdx){
  105461. if( !pIdx->zColAff ){
  105462. /* The first time a column affinity string for a particular index is
  105463. ** required, it is allocated and populated here. It is then stored as
  105464. ** a member of the Index structure for subsequent use.
  105465. **
  105466. ** The column affinity string will eventually be deleted by
  105467. ** sqliteDeleteIndex() when the Index structure itself is cleaned
  105468. ** up.
  105469. */
  105470. int n;
  105471. Table *pTab = pIdx->pTable;
  105472. pIdx->zColAff = (char *)sqlite3DbMallocRaw(0, pIdx->nColumn+1);
  105473. if( !pIdx->zColAff ){
  105474. sqlite3OomFault(db);
  105475. return 0;
  105476. }
  105477. for(n=0; n<pIdx->nColumn; n++){
  105478. i16 x = pIdx->aiColumn[n];
  105479. if( x>=0 ){
  105480. pIdx->zColAff[n] = pTab->aCol[x].affinity;
  105481. }else if( x==XN_ROWID ){
  105482. pIdx->zColAff[n] = SQLITE_AFF_INTEGER;
  105483. }else{
  105484. char aff;
  105485. assert( x==XN_EXPR );
  105486. assert( pIdx->aColExpr!=0 );
  105487. aff = sqlite3ExprAffinity(pIdx->aColExpr->a[n].pExpr);
  105488. if( aff==0 ) aff = SQLITE_AFF_BLOB;
  105489. pIdx->zColAff[n] = aff;
  105490. }
  105491. }
  105492. pIdx->zColAff[n] = 0;
  105493. }
  105494. return pIdx->zColAff;
  105495. }
  105496. /*
  105497. ** Compute the affinity string for table pTab, if it has not already been
  105498. ** computed. As an optimization, omit trailing SQLITE_AFF_BLOB affinities.
  105499. **
  105500. ** If the affinity exists (if it is no entirely SQLITE_AFF_BLOB values) and
  105501. ** if iReg>0 then code an OP_Affinity opcode that will set the affinities
  105502. ** for register iReg and following. Or if affinities exists and iReg==0,
  105503. ** then just set the P4 operand of the previous opcode (which should be
  105504. ** an OP_MakeRecord) to the affinity string.
  105505. **
  105506. ** A column affinity string has one character per column:
  105507. **
  105508. ** Character Column affinity
  105509. ** ------------------------------
  105510. ** 'A' BLOB
  105511. ** 'B' TEXT
  105512. ** 'C' NUMERIC
  105513. ** 'D' INTEGER
  105514. ** 'E' REAL
  105515. */
  105516. SQLITE_PRIVATE void sqlite3TableAffinity(Vdbe *v, Table *pTab, int iReg){
  105517. int i;
  105518. char *zColAff = pTab->zColAff;
  105519. if( zColAff==0 ){
  105520. sqlite3 *db = sqlite3VdbeDb(v);
  105521. zColAff = (char *)sqlite3DbMallocRaw(0, pTab->nCol+1);
  105522. if( !zColAff ){
  105523. sqlite3OomFault(db);
  105524. return;
  105525. }
  105526. for(i=0; i<pTab->nCol; i++){
  105527. zColAff[i] = pTab->aCol[i].affinity;
  105528. }
  105529. do{
  105530. zColAff[i--] = 0;
  105531. }while( i>=0 && zColAff[i]==SQLITE_AFF_BLOB );
  105532. pTab->zColAff = zColAff;
  105533. }
  105534. i = sqlite3Strlen30(zColAff);
  105535. if( i ){
  105536. if( iReg ){
  105537. sqlite3VdbeAddOp4(v, OP_Affinity, iReg, i, 0, zColAff, i);
  105538. }else{
  105539. sqlite3VdbeChangeP4(v, -1, zColAff, i);
  105540. }
  105541. }
  105542. }
  105543. /*
  105544. ** Return non-zero if the table pTab in database iDb or any of its indices
  105545. ** have been opened at any point in the VDBE program. This is used to see if
  105546. ** a statement of the form "INSERT INTO <iDb, pTab> SELECT ..." can
  105547. ** run without using a temporary table for the results of the SELECT.
  105548. */
  105549. static int readsTable(Parse *p, int iDb, Table *pTab){
  105550. Vdbe *v = sqlite3GetVdbe(p);
  105551. int i;
  105552. int iEnd = sqlite3VdbeCurrentAddr(v);
  105553. #ifndef SQLITE_OMIT_VIRTUALTABLE
  105554. VTable *pVTab = IsVirtual(pTab) ? sqlite3GetVTable(p->db, pTab) : 0;
  105555. #endif
  105556. for(i=1; i<iEnd; i++){
  105557. VdbeOp *pOp = sqlite3VdbeGetOp(v, i);
  105558. assert( pOp!=0 );
  105559. if( pOp->opcode==OP_OpenRead && pOp->p3==iDb ){
  105560. Index *pIndex;
  105561. int tnum = pOp->p2;
  105562. if( tnum==pTab->tnum ){
  105563. return 1;
  105564. }
  105565. for(pIndex=pTab->pIndex; pIndex; pIndex=pIndex->pNext){
  105566. if( tnum==pIndex->tnum ){
  105567. return 1;
  105568. }
  105569. }
  105570. }
  105571. #ifndef SQLITE_OMIT_VIRTUALTABLE
  105572. if( pOp->opcode==OP_VOpen && pOp->p4.pVtab==pVTab ){
  105573. assert( pOp->p4.pVtab!=0 );
  105574. assert( pOp->p4type==P4_VTAB );
  105575. return 1;
  105576. }
  105577. #endif
  105578. }
  105579. return 0;
  105580. }
  105581. #ifndef SQLITE_OMIT_AUTOINCREMENT
  105582. /*
  105583. ** Locate or create an AutoincInfo structure associated with table pTab
  105584. ** which is in database iDb. Return the register number for the register
  105585. ** that holds the maximum rowid. Return zero if pTab is not an AUTOINCREMENT
  105586. ** table. (Also return zero when doing a VACUUM since we do not want to
  105587. ** update the AUTOINCREMENT counters during a VACUUM.)
  105588. **
  105589. ** There is at most one AutoincInfo structure per table even if the
  105590. ** same table is autoincremented multiple times due to inserts within
  105591. ** triggers. A new AutoincInfo structure is created if this is the
  105592. ** first use of table pTab. On 2nd and subsequent uses, the original
  105593. ** AutoincInfo structure is used.
  105594. **
  105595. ** Four consecutive registers are allocated:
  105596. **
  105597. ** (1) The name of the pTab table.
  105598. ** (2) The maximum ROWID of pTab.
  105599. ** (3) The rowid in sqlite_sequence of pTab
  105600. ** (4) The original value of the max ROWID in pTab, or NULL if none
  105601. **
  105602. ** The 2nd register is the one that is returned. That is all the
  105603. ** insert routine needs to know about.
  105604. */
  105605. static int autoIncBegin(
  105606. Parse *pParse, /* Parsing context */
  105607. int iDb, /* Index of the database holding pTab */
  105608. Table *pTab /* The table we are writing to */
  105609. ){
  105610. int memId = 0; /* Register holding maximum rowid */
  105611. if( (pTab->tabFlags & TF_Autoincrement)!=0
  105612. && (pParse->db->mDbFlags & DBFLAG_Vacuum)==0
  105613. ){
  105614. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  105615. AutoincInfo *pInfo;
  105616. pInfo = pToplevel->pAinc;
  105617. while( pInfo && pInfo->pTab!=pTab ){ pInfo = pInfo->pNext; }
  105618. if( pInfo==0 ){
  105619. pInfo = sqlite3DbMallocRawNN(pParse->db, sizeof(*pInfo));
  105620. if( pInfo==0 ) return 0;
  105621. pInfo->pNext = pToplevel->pAinc;
  105622. pToplevel->pAinc = pInfo;
  105623. pInfo->pTab = pTab;
  105624. pInfo->iDb = iDb;
  105625. pToplevel->nMem++; /* Register to hold name of table */
  105626. pInfo->regCtr = ++pToplevel->nMem; /* Max rowid register */
  105627. pToplevel->nMem +=2; /* Rowid in sqlite_sequence + orig max val */
  105628. }
  105629. memId = pInfo->regCtr;
  105630. }
  105631. return memId;
  105632. }
  105633. /*
  105634. ** This routine generates code that will initialize all of the
  105635. ** register used by the autoincrement tracker.
  105636. */
  105637. SQLITE_PRIVATE void sqlite3AutoincrementBegin(Parse *pParse){
  105638. AutoincInfo *p; /* Information about an AUTOINCREMENT */
  105639. sqlite3 *db = pParse->db; /* The database connection */
  105640. Db *pDb; /* Database only autoinc table */
  105641. int memId; /* Register holding max rowid */
  105642. Vdbe *v = pParse->pVdbe; /* VDBE under construction */
  105643. /* This routine is never called during trigger-generation. It is
  105644. ** only called from the top-level */
  105645. assert( pParse->pTriggerTab==0 );
  105646. assert( sqlite3IsToplevel(pParse) );
  105647. assert( v ); /* We failed long ago if this is not so */
  105648. for(p = pParse->pAinc; p; p = p->pNext){
  105649. static const int iLn = VDBE_OFFSET_LINENO(2);
  105650. static const VdbeOpList autoInc[] = {
  105651. /* 0 */ {OP_Null, 0, 0, 0},
  105652. /* 1 */ {OP_Rewind, 0, 10, 0},
  105653. /* 2 */ {OP_Column, 0, 0, 0},
  105654. /* 3 */ {OP_Ne, 0, 9, 0},
  105655. /* 4 */ {OP_Rowid, 0, 0, 0},
  105656. /* 5 */ {OP_Column, 0, 1, 0},
  105657. /* 6 */ {OP_AddImm, 0, 0, 0},
  105658. /* 7 */ {OP_Copy, 0, 0, 0},
  105659. /* 8 */ {OP_Goto, 0, 11, 0},
  105660. /* 9 */ {OP_Next, 0, 2, 0},
  105661. /* 10 */ {OP_Integer, 0, 0, 0},
  105662. /* 11 */ {OP_Close, 0, 0, 0}
  105663. };
  105664. VdbeOp *aOp;
  105665. pDb = &db->aDb[p->iDb];
  105666. memId = p->regCtr;
  105667. assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
  105668. sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenRead);
  105669. sqlite3VdbeLoadString(v, memId-1, p->pTab->zName);
  105670. aOp = sqlite3VdbeAddOpList(v, ArraySize(autoInc), autoInc, iLn);
  105671. if( aOp==0 ) break;
  105672. aOp[0].p2 = memId;
  105673. aOp[0].p3 = memId+2;
  105674. aOp[2].p3 = memId;
  105675. aOp[3].p1 = memId-1;
  105676. aOp[3].p3 = memId;
  105677. aOp[3].p5 = SQLITE_JUMPIFNULL;
  105678. aOp[4].p2 = memId+1;
  105679. aOp[5].p3 = memId;
  105680. aOp[6].p1 = memId;
  105681. aOp[7].p2 = memId+2;
  105682. aOp[7].p1 = memId;
  105683. aOp[10].p2 = memId;
  105684. }
  105685. }
  105686. /*
  105687. ** Update the maximum rowid for an autoincrement calculation.
  105688. **
  105689. ** This routine should be called when the regRowid register holds a
  105690. ** new rowid that is about to be inserted. If that new rowid is
  105691. ** larger than the maximum rowid in the memId memory cell, then the
  105692. ** memory cell is updated.
  105693. */
  105694. static void autoIncStep(Parse *pParse, int memId, int regRowid){
  105695. if( memId>0 ){
  105696. sqlite3VdbeAddOp2(pParse->pVdbe, OP_MemMax, memId, regRowid);
  105697. }
  105698. }
  105699. /*
  105700. ** This routine generates the code needed to write autoincrement
  105701. ** maximum rowid values back into the sqlite_sequence register.
  105702. ** Every statement that might do an INSERT into an autoincrement
  105703. ** table (either directly or through triggers) needs to call this
  105704. ** routine just before the "exit" code.
  105705. */
  105706. static SQLITE_NOINLINE void autoIncrementEnd(Parse *pParse){
  105707. AutoincInfo *p;
  105708. Vdbe *v = pParse->pVdbe;
  105709. sqlite3 *db = pParse->db;
  105710. assert( v );
  105711. for(p = pParse->pAinc; p; p = p->pNext){
  105712. static const int iLn = VDBE_OFFSET_LINENO(2);
  105713. static const VdbeOpList autoIncEnd[] = {
  105714. /* 0 */ {OP_NotNull, 0, 2, 0},
  105715. /* 1 */ {OP_NewRowid, 0, 0, 0},
  105716. /* 2 */ {OP_MakeRecord, 0, 2, 0},
  105717. /* 3 */ {OP_Insert, 0, 0, 0},
  105718. /* 4 */ {OP_Close, 0, 0, 0}
  105719. };
  105720. VdbeOp *aOp;
  105721. Db *pDb = &db->aDb[p->iDb];
  105722. int iRec;
  105723. int memId = p->regCtr;
  105724. iRec = sqlite3GetTempReg(pParse);
  105725. assert( sqlite3SchemaMutexHeld(db, 0, pDb->pSchema) );
  105726. sqlite3VdbeAddOp3(v, OP_Le, memId+2, sqlite3VdbeCurrentAddr(v)+7, memId);
  105727. VdbeCoverage(v);
  105728. sqlite3OpenTable(pParse, 0, p->iDb, pDb->pSchema->pSeqTab, OP_OpenWrite);
  105729. aOp = sqlite3VdbeAddOpList(v, ArraySize(autoIncEnd), autoIncEnd, iLn);
  105730. if( aOp==0 ) break;
  105731. aOp[0].p1 = memId+1;
  105732. aOp[1].p2 = memId+1;
  105733. aOp[2].p1 = memId-1;
  105734. aOp[2].p3 = iRec;
  105735. aOp[3].p2 = iRec;
  105736. aOp[3].p3 = memId+1;
  105737. aOp[3].p5 = OPFLAG_APPEND;
  105738. sqlite3ReleaseTempReg(pParse, iRec);
  105739. }
  105740. }
  105741. SQLITE_PRIVATE void sqlite3AutoincrementEnd(Parse *pParse){
  105742. if( pParse->pAinc ) autoIncrementEnd(pParse);
  105743. }
  105744. #else
  105745. /*
  105746. ** If SQLITE_OMIT_AUTOINCREMENT is defined, then the three routines
  105747. ** above are all no-ops
  105748. */
  105749. # define autoIncBegin(A,B,C) (0)
  105750. # define autoIncStep(A,B,C)
  105751. #endif /* SQLITE_OMIT_AUTOINCREMENT */
  105752. /* Forward declaration */
  105753. static int xferOptimization(
  105754. Parse *pParse, /* Parser context */
  105755. Table *pDest, /* The table we are inserting into */
  105756. Select *pSelect, /* A SELECT statement to use as the data source */
  105757. int onError, /* How to handle constraint errors */
  105758. int iDbDest /* The database of pDest */
  105759. );
  105760. /*
  105761. ** This routine is called to handle SQL of the following forms:
  105762. **
  105763. ** insert into TABLE (IDLIST) values(EXPRLIST),(EXPRLIST),...
  105764. ** insert into TABLE (IDLIST) select
  105765. ** insert into TABLE (IDLIST) default values
  105766. **
  105767. ** The IDLIST following the table name is always optional. If omitted,
  105768. ** then a list of all (non-hidden) columns for the table is substituted.
  105769. ** The IDLIST appears in the pColumn parameter. pColumn is NULL if IDLIST
  105770. ** is omitted.
  105771. **
  105772. ** For the pSelect parameter holds the values to be inserted for the
  105773. ** first two forms shown above. A VALUES clause is really just short-hand
  105774. ** for a SELECT statement that omits the FROM clause and everything else
  105775. ** that follows. If the pSelect parameter is NULL, that means that the
  105776. ** DEFAULT VALUES form of the INSERT statement is intended.
  105777. **
  105778. ** The code generated follows one of four templates. For a simple
  105779. ** insert with data coming from a single-row VALUES clause, the code executes
  105780. ** once straight down through. Pseudo-code follows (we call this
  105781. ** the "1st template"):
  105782. **
  105783. ** open write cursor to <table> and its indices
  105784. ** put VALUES clause expressions into registers
  105785. ** write the resulting record into <table>
  105786. ** cleanup
  105787. **
  105788. ** The three remaining templates assume the statement is of the form
  105789. **
  105790. ** INSERT INTO <table> SELECT ...
  105791. **
  105792. ** If the SELECT clause is of the restricted form "SELECT * FROM <table2>" -
  105793. ** in other words if the SELECT pulls all columns from a single table
  105794. ** and there is no WHERE or LIMIT or GROUP BY or ORDER BY clauses, and
  105795. ** if <table2> and <table1> are distinct tables but have identical
  105796. ** schemas, including all the same indices, then a special optimization
  105797. ** is invoked that copies raw records from <table2> over to <table1>.
  105798. ** See the xferOptimization() function for the implementation of this
  105799. ** template. This is the 2nd template.
  105800. **
  105801. ** open a write cursor to <table>
  105802. ** open read cursor on <table2>
  105803. ** transfer all records in <table2> over to <table>
  105804. ** close cursors
  105805. ** foreach index on <table>
  105806. ** open a write cursor on the <table> index
  105807. ** open a read cursor on the corresponding <table2> index
  105808. ** transfer all records from the read to the write cursors
  105809. ** close cursors
  105810. ** end foreach
  105811. **
  105812. ** The 3rd template is for when the second template does not apply
  105813. ** and the SELECT clause does not read from <table> at any time.
  105814. ** The generated code follows this template:
  105815. **
  105816. ** X <- A
  105817. ** goto B
  105818. ** A: setup for the SELECT
  105819. ** loop over the rows in the SELECT
  105820. ** load values into registers R..R+n
  105821. ** yield X
  105822. ** end loop
  105823. ** cleanup after the SELECT
  105824. ** end-coroutine X
  105825. ** B: open write cursor to <table> and its indices
  105826. ** C: yield X, at EOF goto D
  105827. ** insert the select result into <table> from R..R+n
  105828. ** goto C
  105829. ** D: cleanup
  105830. **
  105831. ** The 4th template is used if the insert statement takes its
  105832. ** values from a SELECT but the data is being inserted into a table
  105833. ** that is also read as part of the SELECT. In the third form,
  105834. ** we have to use an intermediate table to store the results of
  105835. ** the select. The template is like this:
  105836. **
  105837. ** X <- A
  105838. ** goto B
  105839. ** A: setup for the SELECT
  105840. ** loop over the tables in the SELECT
  105841. ** load value into register R..R+n
  105842. ** yield X
  105843. ** end loop
  105844. ** cleanup after the SELECT
  105845. ** end co-routine R
  105846. ** B: open temp table
  105847. ** L: yield X, at EOF goto M
  105848. ** insert row from R..R+n into temp table
  105849. ** goto L
  105850. ** M: open write cursor to <table> and its indices
  105851. ** rewind temp table
  105852. ** C: loop over rows of intermediate table
  105853. ** transfer values form intermediate table into <table>
  105854. ** end loop
  105855. ** D: cleanup
  105856. */
  105857. SQLITE_PRIVATE void sqlite3Insert(
  105858. Parse *pParse, /* Parser context */
  105859. SrcList *pTabList, /* Name of table into which we are inserting */
  105860. Select *pSelect, /* A SELECT statement to use as the data source */
  105861. IdList *pColumn, /* Column names corresponding to IDLIST. */
  105862. int onError /* How to handle constraint errors */
  105863. ){
  105864. sqlite3 *db; /* The main database structure */
  105865. Table *pTab; /* The table to insert into. aka TABLE */
  105866. int i, j; /* Loop counters */
  105867. Vdbe *v; /* Generate code into this virtual machine */
  105868. Index *pIdx; /* For looping over indices of the table */
  105869. int nColumn; /* Number of columns in the data */
  105870. int nHidden = 0; /* Number of hidden columns if TABLE is virtual */
  105871. int iDataCur = 0; /* VDBE cursor that is the main data repository */
  105872. int iIdxCur = 0; /* First index cursor */
  105873. int ipkColumn = -1; /* Column that is the INTEGER PRIMARY KEY */
  105874. int endOfLoop; /* Label for the end of the insertion loop */
  105875. int srcTab = 0; /* Data comes from this temporary cursor if >=0 */
  105876. int addrInsTop = 0; /* Jump to label "D" */
  105877. int addrCont = 0; /* Top of insert loop. Label "C" in templates 3 and 4 */
  105878. SelectDest dest; /* Destination for SELECT on rhs of INSERT */
  105879. int iDb; /* Index of database holding TABLE */
  105880. u8 useTempTable = 0; /* Store SELECT results in intermediate table */
  105881. u8 appendFlag = 0; /* True if the insert is likely to be an append */
  105882. u8 withoutRowid; /* 0 for normal table. 1 for WITHOUT ROWID table */
  105883. u8 bIdListInOrder; /* True if IDLIST is in table order */
  105884. ExprList *pList = 0; /* List of VALUES() to be inserted */
  105885. /* Register allocations */
  105886. int regFromSelect = 0;/* Base register for data coming from SELECT */
  105887. int regAutoinc = 0; /* Register holding the AUTOINCREMENT counter */
  105888. int regRowCount = 0; /* Memory cell used for the row counter */
  105889. int regIns; /* Block of regs holding rowid+data being inserted */
  105890. int regRowid; /* registers holding insert rowid */
  105891. int regData; /* register holding first column to insert */
  105892. int *aRegIdx = 0; /* One register allocated to each index */
  105893. #ifndef SQLITE_OMIT_TRIGGER
  105894. int isView; /* True if attempting to insert into a view */
  105895. Trigger *pTrigger; /* List of triggers on pTab, if required */
  105896. int tmask; /* Mask of trigger times */
  105897. #endif
  105898. db = pParse->db;
  105899. if( pParse->nErr || db->mallocFailed ){
  105900. goto insert_cleanup;
  105901. }
  105902. dest.iSDParm = 0; /* Suppress a harmless compiler warning */
  105903. /* If the Select object is really just a simple VALUES() list with a
  105904. ** single row (the common case) then keep that one row of values
  105905. ** and discard the other (unused) parts of the pSelect object
  105906. */
  105907. if( pSelect && (pSelect->selFlags & SF_Values)!=0 && pSelect->pPrior==0 ){
  105908. pList = pSelect->pEList;
  105909. pSelect->pEList = 0;
  105910. sqlite3SelectDelete(db, pSelect);
  105911. pSelect = 0;
  105912. }
  105913. /* Locate the table into which we will be inserting new information.
  105914. */
  105915. assert( pTabList->nSrc==1 );
  105916. pTab = sqlite3SrcListLookup(pParse, pTabList);
  105917. if( pTab==0 ){
  105918. goto insert_cleanup;
  105919. }
  105920. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  105921. assert( iDb<db->nDb );
  105922. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, pTab->zName, 0,
  105923. db->aDb[iDb].zDbSName) ){
  105924. goto insert_cleanup;
  105925. }
  105926. withoutRowid = !HasRowid(pTab);
  105927. /* Figure out if we have any triggers and if the table being
  105928. ** inserted into is a view
  105929. */
  105930. #ifndef SQLITE_OMIT_TRIGGER
  105931. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_INSERT, 0, &tmask);
  105932. isView = pTab->pSelect!=0;
  105933. #else
  105934. # define pTrigger 0
  105935. # define tmask 0
  105936. # define isView 0
  105937. #endif
  105938. #ifdef SQLITE_OMIT_VIEW
  105939. # undef isView
  105940. # define isView 0
  105941. #endif
  105942. assert( (pTrigger && tmask) || (pTrigger==0 && tmask==0) );
  105943. /* If pTab is really a view, make sure it has been initialized.
  105944. ** ViewGetColumnNames() is a no-op if pTab is not a view.
  105945. */
  105946. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  105947. goto insert_cleanup;
  105948. }
  105949. /* Cannot insert into a read-only table.
  105950. */
  105951. if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
  105952. goto insert_cleanup;
  105953. }
  105954. /* Allocate a VDBE
  105955. */
  105956. v = sqlite3GetVdbe(pParse);
  105957. if( v==0 ) goto insert_cleanup;
  105958. if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
  105959. sqlite3BeginWriteOperation(pParse, pSelect || pTrigger, iDb);
  105960. #ifndef SQLITE_OMIT_XFER_OPT
  105961. /* If the statement is of the form
  105962. **
  105963. ** INSERT INTO <table1> SELECT * FROM <table2>;
  105964. **
  105965. ** Then special optimizations can be applied that make the transfer
  105966. ** very fast and which reduce fragmentation of indices.
  105967. **
  105968. ** This is the 2nd template.
  105969. */
  105970. if( pColumn==0 && xferOptimization(pParse, pTab, pSelect, onError, iDb) ){
  105971. assert( !pTrigger );
  105972. assert( pList==0 );
  105973. goto insert_end;
  105974. }
  105975. #endif /* SQLITE_OMIT_XFER_OPT */
  105976. /* If this is an AUTOINCREMENT table, look up the sequence number in the
  105977. ** sqlite_sequence table and store it in memory cell regAutoinc.
  105978. */
  105979. regAutoinc = autoIncBegin(pParse, iDb, pTab);
  105980. /* Allocate registers for holding the rowid of the new row,
  105981. ** the content of the new row, and the assembled row record.
  105982. */
  105983. regRowid = regIns = pParse->nMem+1;
  105984. pParse->nMem += pTab->nCol + 1;
  105985. if( IsVirtual(pTab) ){
  105986. regRowid++;
  105987. pParse->nMem++;
  105988. }
  105989. regData = regRowid+1;
  105990. /* If the INSERT statement included an IDLIST term, then make sure
  105991. ** all elements of the IDLIST really are columns of the table and
  105992. ** remember the column indices.
  105993. **
  105994. ** If the table has an INTEGER PRIMARY KEY column and that column
  105995. ** is named in the IDLIST, then record in the ipkColumn variable
  105996. ** the index into IDLIST of the primary key column. ipkColumn is
  105997. ** the index of the primary key as it appears in IDLIST, not as
  105998. ** is appears in the original table. (The index of the INTEGER
  105999. ** PRIMARY KEY in the original table is pTab->iPKey.)
  106000. */
  106001. bIdListInOrder = (pTab->tabFlags & TF_OOOHidden)==0;
  106002. if( pColumn ){
  106003. for(i=0; i<pColumn->nId; i++){
  106004. pColumn->a[i].idx = -1;
  106005. }
  106006. for(i=0; i<pColumn->nId; i++){
  106007. for(j=0; j<pTab->nCol; j++){
  106008. if( sqlite3StrICmp(pColumn->a[i].zName, pTab->aCol[j].zName)==0 ){
  106009. pColumn->a[i].idx = j;
  106010. if( i!=j ) bIdListInOrder = 0;
  106011. if( j==pTab->iPKey ){
  106012. ipkColumn = i; assert( !withoutRowid );
  106013. }
  106014. break;
  106015. }
  106016. }
  106017. if( j>=pTab->nCol ){
  106018. if( sqlite3IsRowid(pColumn->a[i].zName) && !withoutRowid ){
  106019. ipkColumn = i;
  106020. bIdListInOrder = 0;
  106021. }else{
  106022. sqlite3ErrorMsg(pParse, "table %S has no column named %s",
  106023. pTabList, 0, pColumn->a[i].zName);
  106024. pParse->checkSchema = 1;
  106025. goto insert_cleanup;
  106026. }
  106027. }
  106028. }
  106029. }
  106030. /* Figure out how many columns of data are supplied. If the data
  106031. ** is coming from a SELECT statement, then generate a co-routine that
  106032. ** produces a single row of the SELECT on each invocation. The
  106033. ** co-routine is the common header to the 3rd and 4th templates.
  106034. */
  106035. if( pSelect ){
  106036. /* Data is coming from a SELECT or from a multi-row VALUES clause.
  106037. ** Generate a co-routine to run the SELECT. */
  106038. int regYield; /* Register holding co-routine entry-point */
  106039. int addrTop; /* Top of the co-routine */
  106040. int rc; /* Result code */
  106041. regYield = ++pParse->nMem;
  106042. addrTop = sqlite3VdbeCurrentAddr(v) + 1;
  106043. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, addrTop);
  106044. sqlite3SelectDestInit(&dest, SRT_Coroutine, regYield);
  106045. dest.iSdst = bIdListInOrder ? regData : 0;
  106046. dest.nSdst = pTab->nCol;
  106047. rc = sqlite3Select(pParse, pSelect, &dest);
  106048. regFromSelect = dest.iSdst;
  106049. if( rc || db->mallocFailed || pParse->nErr ) goto insert_cleanup;
  106050. sqlite3VdbeEndCoroutine(v, regYield);
  106051. sqlite3VdbeJumpHere(v, addrTop - 1); /* label B: */
  106052. assert( pSelect->pEList );
  106053. nColumn = pSelect->pEList->nExpr;
  106054. /* Set useTempTable to TRUE if the result of the SELECT statement
  106055. ** should be written into a temporary table (template 4). Set to
  106056. ** FALSE if each output row of the SELECT can be written directly into
  106057. ** the destination table (template 3).
  106058. **
  106059. ** A temp table must be used if the table being updated is also one
  106060. ** of the tables being read by the SELECT statement. Also use a
  106061. ** temp table in the case of row triggers.
  106062. */
  106063. if( pTrigger || readsTable(pParse, iDb, pTab) ){
  106064. useTempTable = 1;
  106065. }
  106066. if( useTempTable ){
  106067. /* Invoke the coroutine to extract information from the SELECT
  106068. ** and add it to a transient table srcTab. The code generated
  106069. ** here is from the 4th template:
  106070. **
  106071. ** B: open temp table
  106072. ** L: yield X, goto M at EOF
  106073. ** insert row from R..R+n into temp table
  106074. ** goto L
  106075. ** M: ...
  106076. */
  106077. int regRec; /* Register to hold packed record */
  106078. int regTempRowid; /* Register to hold temp table ROWID */
  106079. int addrL; /* Label "L" */
  106080. srcTab = pParse->nTab++;
  106081. regRec = sqlite3GetTempReg(pParse);
  106082. regTempRowid = sqlite3GetTempReg(pParse);
  106083. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, srcTab, nColumn);
  106084. addrL = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm); VdbeCoverage(v);
  106085. sqlite3VdbeAddOp3(v, OP_MakeRecord, regFromSelect, nColumn, regRec);
  106086. sqlite3VdbeAddOp2(v, OP_NewRowid, srcTab, regTempRowid);
  106087. sqlite3VdbeAddOp3(v, OP_Insert, srcTab, regRec, regTempRowid);
  106088. sqlite3VdbeGoto(v, addrL);
  106089. sqlite3VdbeJumpHere(v, addrL);
  106090. sqlite3ReleaseTempReg(pParse, regRec);
  106091. sqlite3ReleaseTempReg(pParse, regTempRowid);
  106092. }
  106093. }else{
  106094. /* This is the case if the data for the INSERT is coming from a
  106095. ** single-row VALUES clause
  106096. */
  106097. NameContext sNC;
  106098. memset(&sNC, 0, sizeof(sNC));
  106099. sNC.pParse = pParse;
  106100. srcTab = -1;
  106101. assert( useTempTable==0 );
  106102. if( pList ){
  106103. nColumn = pList->nExpr;
  106104. if( sqlite3ResolveExprListNames(&sNC, pList) ){
  106105. goto insert_cleanup;
  106106. }
  106107. }else{
  106108. nColumn = 0;
  106109. }
  106110. }
  106111. /* If there is no IDLIST term but the table has an integer primary
  106112. ** key, the set the ipkColumn variable to the integer primary key
  106113. ** column index in the original table definition.
  106114. */
  106115. if( pColumn==0 && nColumn>0 ){
  106116. ipkColumn = pTab->iPKey;
  106117. }
  106118. /* Make sure the number of columns in the source data matches the number
  106119. ** of columns to be inserted into the table.
  106120. */
  106121. for(i=0; i<pTab->nCol; i++){
  106122. nHidden += (IsHiddenColumn(&pTab->aCol[i]) ? 1 : 0);
  106123. }
  106124. if( pColumn==0 && nColumn && nColumn!=(pTab->nCol-nHidden) ){
  106125. sqlite3ErrorMsg(pParse,
  106126. "table %S has %d columns but %d values were supplied",
  106127. pTabList, 0, pTab->nCol-nHidden, nColumn);
  106128. goto insert_cleanup;
  106129. }
  106130. if( pColumn!=0 && nColumn!=pColumn->nId ){
  106131. sqlite3ErrorMsg(pParse, "%d values for %d columns", nColumn, pColumn->nId);
  106132. goto insert_cleanup;
  106133. }
  106134. /* Initialize the count of rows to be inserted
  106135. */
  106136. if( db->flags & SQLITE_CountRows ){
  106137. regRowCount = ++pParse->nMem;
  106138. sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
  106139. }
  106140. /* If this is not a view, open the table and and all indices */
  106141. if( !isView ){
  106142. int nIdx;
  106143. nIdx = sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, 0, -1, 0,
  106144. &iDataCur, &iIdxCur);
  106145. aRegIdx = sqlite3DbMallocRawNN(db, sizeof(int)*(nIdx+1));
  106146. if( aRegIdx==0 ){
  106147. goto insert_cleanup;
  106148. }
  106149. for(i=0, pIdx=pTab->pIndex; i<nIdx; pIdx=pIdx->pNext, i++){
  106150. assert( pIdx );
  106151. aRegIdx[i] = ++pParse->nMem;
  106152. pParse->nMem += pIdx->nColumn;
  106153. }
  106154. }
  106155. /* This is the top of the main insertion loop */
  106156. if( useTempTable ){
  106157. /* This block codes the top of loop only. The complete loop is the
  106158. ** following pseudocode (template 4):
  106159. **
  106160. ** rewind temp table, if empty goto D
  106161. ** C: loop over rows of intermediate table
  106162. ** transfer values form intermediate table into <table>
  106163. ** end loop
  106164. ** D: ...
  106165. */
  106166. addrInsTop = sqlite3VdbeAddOp1(v, OP_Rewind, srcTab); VdbeCoverage(v);
  106167. addrCont = sqlite3VdbeCurrentAddr(v);
  106168. }else if( pSelect ){
  106169. /* This block codes the top of loop only. The complete loop is the
  106170. ** following pseudocode (template 3):
  106171. **
  106172. ** C: yield X, at EOF goto D
  106173. ** insert the select result into <table> from R..R+n
  106174. ** goto C
  106175. ** D: ...
  106176. */
  106177. addrInsTop = addrCont = sqlite3VdbeAddOp1(v, OP_Yield, dest.iSDParm);
  106178. VdbeCoverage(v);
  106179. }
  106180. /* Run the BEFORE and INSTEAD OF triggers, if there are any
  106181. */
  106182. endOfLoop = sqlite3VdbeMakeLabel(v);
  106183. if( tmask & TRIGGER_BEFORE ){
  106184. int regCols = sqlite3GetTempRange(pParse, pTab->nCol+1);
  106185. /* build the NEW.* reference row. Note that if there is an INTEGER
  106186. ** PRIMARY KEY into which a NULL is being inserted, that NULL will be
  106187. ** translated into a unique ID for the row. But on a BEFORE trigger,
  106188. ** we do not know what the unique ID will be (because the insert has
  106189. ** not happened yet) so we substitute a rowid of -1
  106190. */
  106191. if( ipkColumn<0 ){
  106192. sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
  106193. }else{
  106194. int addr1;
  106195. assert( !withoutRowid );
  106196. if( useTempTable ){
  106197. sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regCols);
  106198. }else{
  106199. assert( pSelect==0 ); /* Otherwise useTempTable is true */
  106200. sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regCols);
  106201. }
  106202. addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regCols); VdbeCoverage(v);
  106203. sqlite3VdbeAddOp2(v, OP_Integer, -1, regCols);
  106204. sqlite3VdbeJumpHere(v, addr1);
  106205. sqlite3VdbeAddOp1(v, OP_MustBeInt, regCols); VdbeCoverage(v);
  106206. }
  106207. /* Cannot have triggers on a virtual table. If it were possible,
  106208. ** this block would have to account for hidden column.
  106209. */
  106210. assert( !IsVirtual(pTab) );
  106211. /* Create the new column data
  106212. */
  106213. for(i=j=0; i<pTab->nCol; i++){
  106214. if( pColumn ){
  106215. for(j=0; j<pColumn->nId; j++){
  106216. if( pColumn->a[j].idx==i ) break;
  106217. }
  106218. }
  106219. if( (!useTempTable && !pList) || (pColumn && j>=pColumn->nId)
  106220. || (pColumn==0 && IsOrdinaryHiddenColumn(&pTab->aCol[i])) ){
  106221. sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regCols+i+1);
  106222. }else if( useTempTable ){
  106223. sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, regCols+i+1);
  106224. }else{
  106225. assert( pSelect==0 ); /* Otherwise useTempTable is true */
  106226. sqlite3ExprCodeAndCache(pParse, pList->a[j].pExpr, regCols+i+1);
  106227. }
  106228. if( pColumn==0 && !IsOrdinaryHiddenColumn(&pTab->aCol[i]) ) j++;
  106229. }
  106230. /* If this is an INSERT on a view with an INSTEAD OF INSERT trigger,
  106231. ** do not attempt any conversions before assembling the record.
  106232. ** If this is a real table, attempt conversions as required by the
  106233. ** table column affinities.
  106234. */
  106235. if( !isView ){
  106236. sqlite3TableAffinity(v, pTab, regCols+1);
  106237. }
  106238. /* Fire BEFORE or INSTEAD OF triggers */
  106239. sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_BEFORE,
  106240. pTab, regCols-pTab->nCol-1, onError, endOfLoop);
  106241. sqlite3ReleaseTempRange(pParse, regCols, pTab->nCol+1);
  106242. }
  106243. /* Compute the content of the next row to insert into a range of
  106244. ** registers beginning at regIns.
  106245. */
  106246. if( !isView ){
  106247. if( IsVirtual(pTab) ){
  106248. /* The row that the VUpdate opcode will delete: none */
  106249. sqlite3VdbeAddOp2(v, OP_Null, 0, regIns);
  106250. }
  106251. if( ipkColumn>=0 ){
  106252. if( useTempTable ){
  106253. sqlite3VdbeAddOp3(v, OP_Column, srcTab, ipkColumn, regRowid);
  106254. }else if( pSelect ){
  106255. sqlite3VdbeAddOp2(v, OP_Copy, regFromSelect+ipkColumn, regRowid);
  106256. }else{
  106257. VdbeOp *pOp;
  106258. sqlite3ExprCode(pParse, pList->a[ipkColumn].pExpr, regRowid);
  106259. pOp = sqlite3VdbeGetOp(v, -1);
  106260. assert( pOp!=0 );
  106261. if( pOp->opcode==OP_Null && !IsVirtual(pTab) ){
  106262. appendFlag = 1;
  106263. pOp->opcode = OP_NewRowid;
  106264. pOp->p1 = iDataCur;
  106265. pOp->p2 = regRowid;
  106266. pOp->p3 = regAutoinc;
  106267. }
  106268. }
  106269. /* If the PRIMARY KEY expression is NULL, then use OP_NewRowid
  106270. ** to generate a unique primary key value.
  106271. */
  106272. if( !appendFlag ){
  106273. int addr1;
  106274. if( !IsVirtual(pTab) ){
  106275. addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regRowid); VdbeCoverage(v);
  106276. sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
  106277. sqlite3VdbeJumpHere(v, addr1);
  106278. }else{
  106279. addr1 = sqlite3VdbeCurrentAddr(v);
  106280. sqlite3VdbeAddOp2(v, OP_IsNull, regRowid, addr1+2); VdbeCoverage(v);
  106281. }
  106282. sqlite3VdbeAddOp1(v, OP_MustBeInt, regRowid); VdbeCoverage(v);
  106283. }
  106284. }else if( IsVirtual(pTab) || withoutRowid ){
  106285. sqlite3VdbeAddOp2(v, OP_Null, 0, regRowid);
  106286. }else{
  106287. sqlite3VdbeAddOp3(v, OP_NewRowid, iDataCur, regRowid, regAutoinc);
  106288. appendFlag = 1;
  106289. }
  106290. autoIncStep(pParse, regAutoinc, regRowid);
  106291. /* Compute data for all columns of the new entry, beginning
  106292. ** with the first column.
  106293. */
  106294. nHidden = 0;
  106295. for(i=0; i<pTab->nCol; i++){
  106296. int iRegStore = regRowid+1+i;
  106297. if( i==pTab->iPKey ){
  106298. /* The value of the INTEGER PRIMARY KEY column is always a NULL.
  106299. ** Whenever this column is read, the rowid will be substituted
  106300. ** in its place. Hence, fill this column with a NULL to avoid
  106301. ** taking up data space with information that will never be used.
  106302. ** As there may be shallow copies of this value, make it a soft-NULL */
  106303. sqlite3VdbeAddOp1(v, OP_SoftNull, iRegStore);
  106304. continue;
  106305. }
  106306. if( pColumn==0 ){
  106307. if( IsHiddenColumn(&pTab->aCol[i]) ){
  106308. j = -1;
  106309. nHidden++;
  106310. }else{
  106311. j = i - nHidden;
  106312. }
  106313. }else{
  106314. for(j=0; j<pColumn->nId; j++){
  106315. if( pColumn->a[j].idx==i ) break;
  106316. }
  106317. }
  106318. if( j<0 || nColumn==0 || (pColumn && j>=pColumn->nId) ){
  106319. sqlite3ExprCodeFactorable(pParse, pTab->aCol[i].pDflt, iRegStore);
  106320. }else if( useTempTable ){
  106321. sqlite3VdbeAddOp3(v, OP_Column, srcTab, j, iRegStore);
  106322. }else if( pSelect ){
  106323. if( regFromSelect!=regData ){
  106324. sqlite3VdbeAddOp2(v, OP_SCopy, regFromSelect+j, iRegStore);
  106325. }
  106326. }else{
  106327. sqlite3ExprCode(pParse, pList->a[j].pExpr, iRegStore);
  106328. }
  106329. }
  106330. /* Generate code to check constraints and generate index keys and
  106331. ** do the insertion.
  106332. */
  106333. #ifndef SQLITE_OMIT_VIRTUALTABLE
  106334. if( IsVirtual(pTab) ){
  106335. const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
  106336. sqlite3VtabMakeWritable(pParse, pTab);
  106337. sqlite3VdbeAddOp4(v, OP_VUpdate, 1, pTab->nCol+2, regIns, pVTab, P4_VTAB);
  106338. sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
  106339. sqlite3MayAbort(pParse);
  106340. }else
  106341. #endif
  106342. {
  106343. int isReplace; /* Set to true if constraints may cause a replace */
  106344. int bUseSeek; /* True to use OPFLAG_SEEKRESULT */
  106345. sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
  106346. regIns, 0, ipkColumn>=0, onError, endOfLoop, &isReplace, 0
  106347. );
  106348. sqlite3FkCheck(pParse, pTab, 0, regIns, 0, 0);
  106349. /* Set the OPFLAG_USESEEKRESULT flag if either (a) there are no REPLACE
  106350. ** constraints or (b) there are no triggers and this table is not a
  106351. ** parent table in a foreign key constraint. It is safe to set the
  106352. ** flag in the second case as if any REPLACE constraint is hit, an
  106353. ** OP_Delete or OP_IdxDelete instruction will be executed on each
  106354. ** cursor that is disturbed. And these instructions both clear the
  106355. ** VdbeCursor.seekResult variable, disabling the OPFLAG_USESEEKRESULT
  106356. ** functionality. */
  106357. bUseSeek = (isReplace==0 || (pTrigger==0 &&
  106358. ((db->flags & SQLITE_ForeignKeys)==0 || sqlite3FkReferences(pTab)==0)
  106359. ));
  106360. sqlite3CompleteInsertion(pParse, pTab, iDataCur, iIdxCur,
  106361. regIns, aRegIdx, 0, appendFlag, bUseSeek
  106362. );
  106363. }
  106364. }
  106365. /* Update the count of rows that are inserted
  106366. */
  106367. if( (db->flags & SQLITE_CountRows)!=0 ){
  106368. sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
  106369. }
  106370. if( pTrigger ){
  106371. /* Code AFTER triggers */
  106372. sqlite3CodeRowTrigger(pParse, pTrigger, TK_INSERT, 0, TRIGGER_AFTER,
  106373. pTab, regData-2-pTab->nCol, onError, endOfLoop);
  106374. }
  106375. /* The bottom of the main insertion loop, if the data source
  106376. ** is a SELECT statement.
  106377. */
  106378. sqlite3VdbeResolveLabel(v, endOfLoop);
  106379. if( useTempTable ){
  106380. sqlite3VdbeAddOp2(v, OP_Next, srcTab, addrCont); VdbeCoverage(v);
  106381. sqlite3VdbeJumpHere(v, addrInsTop);
  106382. sqlite3VdbeAddOp1(v, OP_Close, srcTab);
  106383. }else if( pSelect ){
  106384. sqlite3VdbeGoto(v, addrCont);
  106385. sqlite3VdbeJumpHere(v, addrInsTop);
  106386. }
  106387. insert_end:
  106388. /* Update the sqlite_sequence table by storing the content of the
  106389. ** maximum rowid counter values recorded while inserting into
  106390. ** autoincrement tables.
  106391. */
  106392. if( pParse->nested==0 && pParse->pTriggerTab==0 ){
  106393. sqlite3AutoincrementEnd(pParse);
  106394. }
  106395. /*
  106396. ** Return the number of rows inserted. If this routine is
  106397. ** generating code because of a call to sqlite3NestedParse(), do not
  106398. ** invoke the callback function.
  106399. */
  106400. if( (db->flags&SQLITE_CountRows) && !pParse->nested && !pParse->pTriggerTab ){
  106401. sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
  106402. sqlite3VdbeSetNumCols(v, 1);
  106403. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows inserted", SQLITE_STATIC);
  106404. }
  106405. insert_cleanup:
  106406. sqlite3SrcListDelete(db, pTabList);
  106407. sqlite3ExprListDelete(db, pList);
  106408. sqlite3SelectDelete(db, pSelect);
  106409. sqlite3IdListDelete(db, pColumn);
  106410. sqlite3DbFree(db, aRegIdx);
  106411. }
  106412. /* Make sure "isView" and other macros defined above are undefined. Otherwise
  106413. ** they may interfere with compilation of other functions in this file
  106414. ** (or in another file, if this file becomes part of the amalgamation). */
  106415. #ifdef isView
  106416. #undef isView
  106417. #endif
  106418. #ifdef pTrigger
  106419. #undef pTrigger
  106420. #endif
  106421. #ifdef tmask
  106422. #undef tmask
  106423. #endif
  106424. /*
  106425. ** Meanings of bits in of pWalker->eCode for checkConstraintUnchanged()
  106426. */
  106427. #define CKCNSTRNT_COLUMN 0x01 /* CHECK constraint uses a changing column */
  106428. #define CKCNSTRNT_ROWID 0x02 /* CHECK constraint references the ROWID */
  106429. /* This is the Walker callback from checkConstraintUnchanged(). Set
  106430. ** bit 0x01 of pWalker->eCode if
  106431. ** pWalker->eCode to 0 if this expression node references any of the
  106432. ** columns that are being modifed by an UPDATE statement.
  106433. */
  106434. static int checkConstraintExprNode(Walker *pWalker, Expr *pExpr){
  106435. if( pExpr->op==TK_COLUMN ){
  106436. assert( pExpr->iColumn>=0 || pExpr->iColumn==-1 );
  106437. if( pExpr->iColumn>=0 ){
  106438. if( pWalker->u.aiCol[pExpr->iColumn]>=0 ){
  106439. pWalker->eCode |= CKCNSTRNT_COLUMN;
  106440. }
  106441. }else{
  106442. pWalker->eCode |= CKCNSTRNT_ROWID;
  106443. }
  106444. }
  106445. return WRC_Continue;
  106446. }
  106447. /*
  106448. ** pExpr is a CHECK constraint on a row that is being UPDATE-ed. The
  106449. ** only columns that are modified by the UPDATE are those for which
  106450. ** aiChng[i]>=0, and also the ROWID is modified if chngRowid is true.
  106451. **
  106452. ** Return true if CHECK constraint pExpr does not use any of the
  106453. ** changing columns (or the rowid if it is changing). In other words,
  106454. ** return true if this CHECK constraint can be skipped when validating
  106455. ** the new row in the UPDATE statement.
  106456. */
  106457. static int checkConstraintUnchanged(Expr *pExpr, int *aiChng, int chngRowid){
  106458. Walker w;
  106459. memset(&w, 0, sizeof(w));
  106460. w.eCode = 0;
  106461. w.xExprCallback = checkConstraintExprNode;
  106462. w.u.aiCol = aiChng;
  106463. sqlite3WalkExpr(&w, pExpr);
  106464. if( !chngRowid ){
  106465. testcase( (w.eCode & CKCNSTRNT_ROWID)!=0 );
  106466. w.eCode &= ~CKCNSTRNT_ROWID;
  106467. }
  106468. testcase( w.eCode==0 );
  106469. testcase( w.eCode==CKCNSTRNT_COLUMN );
  106470. testcase( w.eCode==CKCNSTRNT_ROWID );
  106471. testcase( w.eCode==(CKCNSTRNT_ROWID|CKCNSTRNT_COLUMN) );
  106472. return !w.eCode;
  106473. }
  106474. /*
  106475. ** Generate code to do constraint checks prior to an INSERT or an UPDATE
  106476. ** on table pTab.
  106477. **
  106478. ** The regNewData parameter is the first register in a range that contains
  106479. ** the data to be inserted or the data after the update. There will be
  106480. ** pTab->nCol+1 registers in this range. The first register (the one
  106481. ** that regNewData points to) will contain the new rowid, or NULL in the
  106482. ** case of a WITHOUT ROWID table. The second register in the range will
  106483. ** contain the content of the first table column. The third register will
  106484. ** contain the content of the second table column. And so forth.
  106485. **
  106486. ** The regOldData parameter is similar to regNewData except that it contains
  106487. ** the data prior to an UPDATE rather than afterwards. regOldData is zero
  106488. ** for an INSERT. This routine can distinguish between UPDATE and INSERT by
  106489. ** checking regOldData for zero.
  106490. **
  106491. ** For an UPDATE, the pkChng boolean is true if the true primary key (the
  106492. ** rowid for a normal table or the PRIMARY KEY for a WITHOUT ROWID table)
  106493. ** might be modified by the UPDATE. If pkChng is false, then the key of
  106494. ** the iDataCur content table is guaranteed to be unchanged by the UPDATE.
  106495. **
  106496. ** For an INSERT, the pkChng boolean indicates whether or not the rowid
  106497. ** was explicitly specified as part of the INSERT statement. If pkChng
  106498. ** is zero, it means that the either rowid is computed automatically or
  106499. ** that the table is a WITHOUT ROWID table and has no rowid. On an INSERT,
  106500. ** pkChng will only be true if the INSERT statement provides an integer
  106501. ** value for either the rowid column or its INTEGER PRIMARY KEY alias.
  106502. **
  106503. ** The code generated by this routine will store new index entries into
  106504. ** registers identified by aRegIdx[]. No index entry is created for
  106505. ** indices where aRegIdx[i]==0. The order of indices in aRegIdx[] is
  106506. ** the same as the order of indices on the linked list of indices
  106507. ** at pTab->pIndex.
  106508. **
  106509. ** The caller must have already opened writeable cursors on the main
  106510. ** table and all applicable indices (that is to say, all indices for which
  106511. ** aRegIdx[] is not zero). iDataCur is the cursor for the main table when
  106512. ** inserting or updating a rowid table, or the cursor for the PRIMARY KEY
  106513. ** index when operating on a WITHOUT ROWID table. iIdxCur is the cursor
  106514. ** for the first index in the pTab->pIndex list. Cursors for other indices
  106515. ** are at iIdxCur+N for the N-th element of the pTab->pIndex list.
  106516. **
  106517. ** This routine also generates code to check constraints. NOT NULL,
  106518. ** CHECK, and UNIQUE constraints are all checked. If a constraint fails,
  106519. ** then the appropriate action is performed. There are five possible
  106520. ** actions: ROLLBACK, ABORT, FAIL, REPLACE, and IGNORE.
  106521. **
  106522. ** Constraint type Action What Happens
  106523. ** --------------- ---------- ----------------------------------------
  106524. ** any ROLLBACK The current transaction is rolled back and
  106525. ** sqlite3_step() returns immediately with a
  106526. ** return code of SQLITE_CONSTRAINT.
  106527. **
  106528. ** any ABORT Back out changes from the current command
  106529. ** only (do not do a complete rollback) then
  106530. ** cause sqlite3_step() to return immediately
  106531. ** with SQLITE_CONSTRAINT.
  106532. **
  106533. ** any FAIL Sqlite3_step() returns immediately with a
  106534. ** return code of SQLITE_CONSTRAINT. The
  106535. ** transaction is not rolled back and any
  106536. ** changes to prior rows are retained.
  106537. **
  106538. ** any IGNORE The attempt in insert or update the current
  106539. ** row is skipped, without throwing an error.
  106540. ** Processing continues with the next row.
  106541. ** (There is an immediate jump to ignoreDest.)
  106542. **
  106543. ** NOT NULL REPLACE The NULL value is replace by the default
  106544. ** value for that column. If the default value
  106545. ** is NULL, the action is the same as ABORT.
  106546. **
  106547. ** UNIQUE REPLACE The other row that conflicts with the row
  106548. ** being inserted is removed.
  106549. **
  106550. ** CHECK REPLACE Illegal. The results in an exception.
  106551. **
  106552. ** Which action to take is determined by the overrideError parameter.
  106553. ** Or if overrideError==OE_Default, then the pParse->onError parameter
  106554. ** is used. Or if pParse->onError==OE_Default then the onError value
  106555. ** for the constraint is used.
  106556. */
  106557. SQLITE_PRIVATE void sqlite3GenerateConstraintChecks(
  106558. Parse *pParse, /* The parser context */
  106559. Table *pTab, /* The table being inserted or updated */
  106560. int *aRegIdx, /* Use register aRegIdx[i] for index i. 0 for unused */
  106561. int iDataCur, /* Canonical data cursor (main table or PK index) */
  106562. int iIdxCur, /* First index cursor */
  106563. int regNewData, /* First register in a range holding values to insert */
  106564. int regOldData, /* Previous content. 0 for INSERTs */
  106565. u8 pkChng, /* Non-zero if the rowid or PRIMARY KEY changed */
  106566. u8 overrideError, /* Override onError to this if not OE_Default */
  106567. int ignoreDest, /* Jump to this label on an OE_Ignore resolution */
  106568. int *pbMayReplace, /* OUT: Set to true if constraint may cause a replace */
  106569. int *aiChng /* column i is unchanged if aiChng[i]<0 */
  106570. ){
  106571. Vdbe *v; /* VDBE under constrution */
  106572. Index *pIdx; /* Pointer to one of the indices */
  106573. Index *pPk = 0; /* The PRIMARY KEY index */
  106574. sqlite3 *db; /* Database connection */
  106575. int i; /* loop counter */
  106576. int ix; /* Index loop counter */
  106577. int nCol; /* Number of columns */
  106578. int onError; /* Conflict resolution strategy */
  106579. int addr1; /* Address of jump instruction */
  106580. int seenReplace = 0; /* True if REPLACE is used to resolve INT PK conflict */
  106581. int nPkField; /* Number of fields in PRIMARY KEY. 1 for ROWID tables */
  106582. int ipkTop = 0; /* Top of the rowid change constraint check */
  106583. int ipkBottom = 0; /* Bottom of the rowid change constraint check */
  106584. u8 isUpdate; /* True if this is an UPDATE operation */
  106585. u8 bAffinityDone = 0; /* True if the OP_Affinity operation has been run */
  106586. isUpdate = regOldData!=0;
  106587. db = pParse->db;
  106588. v = sqlite3GetVdbe(pParse);
  106589. assert( v!=0 );
  106590. assert( pTab->pSelect==0 ); /* This table is not a VIEW */
  106591. nCol = pTab->nCol;
  106592. /* pPk is the PRIMARY KEY index for WITHOUT ROWID tables and NULL for
  106593. ** normal rowid tables. nPkField is the number of key fields in the
  106594. ** pPk index or 1 for a rowid table. In other words, nPkField is the
  106595. ** number of fields in the true primary key of the table. */
  106596. if( HasRowid(pTab) ){
  106597. pPk = 0;
  106598. nPkField = 1;
  106599. }else{
  106600. pPk = sqlite3PrimaryKeyIndex(pTab);
  106601. nPkField = pPk->nKeyCol;
  106602. }
  106603. /* Record that this module has started */
  106604. VdbeModuleComment((v, "BEGIN: GenCnstCks(%d,%d,%d,%d,%d)",
  106605. iDataCur, iIdxCur, regNewData, regOldData, pkChng));
  106606. /* Test all NOT NULL constraints.
  106607. */
  106608. for(i=0; i<nCol; i++){
  106609. if( i==pTab->iPKey ){
  106610. continue; /* ROWID is never NULL */
  106611. }
  106612. if( aiChng && aiChng[i]<0 ){
  106613. /* Don't bother checking for NOT NULL on columns that do not change */
  106614. continue;
  106615. }
  106616. onError = pTab->aCol[i].notNull;
  106617. if( onError==OE_None ) continue; /* This column is allowed to be NULL */
  106618. if( overrideError!=OE_Default ){
  106619. onError = overrideError;
  106620. }else if( onError==OE_Default ){
  106621. onError = OE_Abort;
  106622. }
  106623. if( onError==OE_Replace && pTab->aCol[i].pDflt==0 ){
  106624. onError = OE_Abort;
  106625. }
  106626. assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
  106627. || onError==OE_Ignore || onError==OE_Replace );
  106628. switch( onError ){
  106629. case OE_Abort:
  106630. sqlite3MayAbort(pParse);
  106631. /* Fall through */
  106632. case OE_Rollback:
  106633. case OE_Fail: {
  106634. char *zMsg = sqlite3MPrintf(db, "%s.%s", pTab->zName,
  106635. pTab->aCol[i].zName);
  106636. sqlite3VdbeAddOp3(v, OP_HaltIfNull, SQLITE_CONSTRAINT_NOTNULL, onError,
  106637. regNewData+1+i);
  106638. sqlite3VdbeAppendP4(v, zMsg, P4_DYNAMIC);
  106639. sqlite3VdbeChangeP5(v, P5_ConstraintNotNull);
  106640. VdbeCoverage(v);
  106641. break;
  106642. }
  106643. case OE_Ignore: {
  106644. sqlite3VdbeAddOp2(v, OP_IsNull, regNewData+1+i, ignoreDest);
  106645. VdbeCoverage(v);
  106646. break;
  106647. }
  106648. default: {
  106649. assert( onError==OE_Replace );
  106650. addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, regNewData+1+i);
  106651. VdbeCoverage(v);
  106652. sqlite3ExprCode(pParse, pTab->aCol[i].pDflt, regNewData+1+i);
  106653. sqlite3VdbeJumpHere(v, addr1);
  106654. break;
  106655. }
  106656. }
  106657. }
  106658. /* Test all CHECK constraints
  106659. */
  106660. #ifndef SQLITE_OMIT_CHECK
  106661. if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
  106662. ExprList *pCheck = pTab->pCheck;
  106663. pParse->iSelfTab = -(regNewData+1);
  106664. onError = overrideError!=OE_Default ? overrideError : OE_Abort;
  106665. for(i=0; i<pCheck->nExpr; i++){
  106666. int allOk;
  106667. Expr *pExpr = pCheck->a[i].pExpr;
  106668. if( aiChng && checkConstraintUnchanged(pExpr, aiChng, pkChng) ) continue;
  106669. allOk = sqlite3VdbeMakeLabel(v);
  106670. sqlite3ExprIfTrue(pParse, pExpr, allOk, SQLITE_JUMPIFNULL);
  106671. if( onError==OE_Ignore ){
  106672. sqlite3VdbeGoto(v, ignoreDest);
  106673. }else{
  106674. char *zName = pCheck->a[i].zName;
  106675. if( zName==0 ) zName = pTab->zName;
  106676. if( onError==OE_Replace ) onError = OE_Abort; /* IMP: R-15569-63625 */
  106677. sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_CHECK,
  106678. onError, zName, P4_TRANSIENT,
  106679. P5_ConstraintCheck);
  106680. }
  106681. sqlite3VdbeResolveLabel(v, allOk);
  106682. }
  106683. pParse->iSelfTab = 0;
  106684. }
  106685. #endif /* !defined(SQLITE_OMIT_CHECK) */
  106686. /* If rowid is changing, make sure the new rowid does not previously
  106687. ** exist in the table.
  106688. */
  106689. if( pkChng && pPk==0 ){
  106690. int addrRowidOk = sqlite3VdbeMakeLabel(v);
  106691. /* Figure out what action to take in case of a rowid collision */
  106692. onError = pTab->keyConf;
  106693. if( overrideError!=OE_Default ){
  106694. onError = overrideError;
  106695. }else if( onError==OE_Default ){
  106696. onError = OE_Abort;
  106697. }
  106698. if( isUpdate ){
  106699. /* pkChng!=0 does not mean that the rowid has changed, only that
  106700. ** it might have changed. Skip the conflict logic below if the rowid
  106701. ** is unchanged. */
  106702. sqlite3VdbeAddOp3(v, OP_Eq, regNewData, addrRowidOk, regOldData);
  106703. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  106704. VdbeCoverage(v);
  106705. }
  106706. /* If the response to a rowid conflict is REPLACE but the response
  106707. ** to some other UNIQUE constraint is FAIL or IGNORE, then we need
  106708. ** to defer the running of the rowid conflict checking until after
  106709. ** the UNIQUE constraints have run.
  106710. */
  106711. if( onError==OE_Replace && overrideError!=OE_Replace ){
  106712. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  106713. if( pIdx->onError==OE_Ignore || pIdx->onError==OE_Fail ){
  106714. ipkTop = sqlite3VdbeAddOp0(v, OP_Goto);
  106715. break;
  106716. }
  106717. }
  106718. }
  106719. /* Check to see if the new rowid already exists in the table. Skip
  106720. ** the following conflict logic if it does not. */
  106721. sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, addrRowidOk, regNewData);
  106722. VdbeCoverage(v);
  106723. /* Generate code that deals with a rowid collision */
  106724. switch( onError ){
  106725. default: {
  106726. onError = OE_Abort;
  106727. /* Fall thru into the next case */
  106728. }
  106729. case OE_Rollback:
  106730. case OE_Abort:
  106731. case OE_Fail: {
  106732. sqlite3RowidConstraint(pParse, onError, pTab);
  106733. break;
  106734. }
  106735. case OE_Replace: {
  106736. /* If there are DELETE triggers on this table and the
  106737. ** recursive-triggers flag is set, call GenerateRowDelete() to
  106738. ** remove the conflicting row from the table. This will fire
  106739. ** the triggers and remove both the table and index b-tree entries.
  106740. **
  106741. ** Otherwise, if there are no triggers or the recursive-triggers
  106742. ** flag is not set, but the table has one or more indexes, call
  106743. ** GenerateRowIndexDelete(). This removes the index b-tree entries
  106744. ** only. The table b-tree entry will be replaced by the new entry
  106745. ** when it is inserted.
  106746. **
  106747. ** If either GenerateRowDelete() or GenerateRowIndexDelete() is called,
  106748. ** also invoke MultiWrite() to indicate that this VDBE may require
  106749. ** statement rollback (if the statement is aborted after the delete
  106750. ** takes place). Earlier versions called sqlite3MultiWrite() regardless,
  106751. ** but being more selective here allows statements like:
  106752. **
  106753. ** REPLACE INTO t(rowid) VALUES($newrowid)
  106754. **
  106755. ** to run without a statement journal if there are no indexes on the
  106756. ** table.
  106757. */
  106758. Trigger *pTrigger = 0;
  106759. if( db->flags&SQLITE_RecTriggers ){
  106760. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
  106761. }
  106762. if( pTrigger || sqlite3FkRequired(pParse, pTab, 0, 0) ){
  106763. sqlite3MultiWrite(pParse);
  106764. sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
  106765. regNewData, 1, 0, OE_Replace, 1, -1);
  106766. }else{
  106767. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  106768. if( HasRowid(pTab) ){
  106769. /* This OP_Delete opcode fires the pre-update-hook only. It does
  106770. ** not modify the b-tree. It is more efficient to let the coming
  106771. ** OP_Insert replace the existing entry than it is to delete the
  106772. ** existing entry and then insert a new one. */
  106773. sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, OPFLAG_ISNOOP);
  106774. sqlite3VdbeAppendP4(v, pTab, P4_TABLE);
  106775. }
  106776. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  106777. if( pTab->pIndex ){
  106778. sqlite3MultiWrite(pParse);
  106779. sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur,0,-1);
  106780. }
  106781. }
  106782. seenReplace = 1;
  106783. break;
  106784. }
  106785. case OE_Ignore: {
  106786. /*assert( seenReplace==0 );*/
  106787. sqlite3VdbeGoto(v, ignoreDest);
  106788. break;
  106789. }
  106790. }
  106791. sqlite3VdbeResolveLabel(v, addrRowidOk);
  106792. if( ipkTop ){
  106793. ipkBottom = sqlite3VdbeAddOp0(v, OP_Goto);
  106794. sqlite3VdbeJumpHere(v, ipkTop);
  106795. }
  106796. }
  106797. /* Test all UNIQUE constraints by creating entries for each UNIQUE
  106798. ** index and making sure that duplicate entries do not already exist.
  106799. ** Compute the revised record entries for indices as we go.
  106800. **
  106801. ** This loop also handles the case of the PRIMARY KEY index for a
  106802. ** WITHOUT ROWID table.
  106803. */
  106804. for(ix=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, ix++){
  106805. int regIdx; /* Range of registers hold conent for pIdx */
  106806. int regR; /* Range of registers holding conflicting PK */
  106807. int iThisCur; /* Cursor for this UNIQUE index */
  106808. int addrUniqueOk; /* Jump here if the UNIQUE constraint is satisfied */
  106809. if( aRegIdx[ix]==0 ) continue; /* Skip indices that do not change */
  106810. if( bAffinityDone==0 ){
  106811. sqlite3TableAffinity(v, pTab, regNewData+1);
  106812. bAffinityDone = 1;
  106813. }
  106814. iThisCur = iIdxCur+ix;
  106815. addrUniqueOk = sqlite3VdbeMakeLabel(v);
  106816. /* Skip partial indices for which the WHERE clause is not true */
  106817. if( pIdx->pPartIdxWhere ){
  106818. sqlite3VdbeAddOp2(v, OP_Null, 0, aRegIdx[ix]);
  106819. pParse->iSelfTab = -(regNewData+1);
  106820. sqlite3ExprIfFalseDup(pParse, pIdx->pPartIdxWhere, addrUniqueOk,
  106821. SQLITE_JUMPIFNULL);
  106822. pParse->iSelfTab = 0;
  106823. }
  106824. /* Create a record for this index entry as it should appear after
  106825. ** the insert or update. Store that record in the aRegIdx[ix] register
  106826. */
  106827. regIdx = aRegIdx[ix]+1;
  106828. for(i=0; i<pIdx->nColumn; i++){
  106829. int iField = pIdx->aiColumn[i];
  106830. int x;
  106831. if( iField==XN_EXPR ){
  106832. pParse->iSelfTab = -(regNewData+1);
  106833. sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[i].pExpr, regIdx+i);
  106834. pParse->iSelfTab = 0;
  106835. VdbeComment((v, "%s column %d", pIdx->zName, i));
  106836. }else{
  106837. if( iField==XN_ROWID || iField==pTab->iPKey ){
  106838. x = regNewData;
  106839. }else{
  106840. x = iField + regNewData + 1;
  106841. }
  106842. sqlite3VdbeAddOp2(v, iField<0 ? OP_IntCopy : OP_SCopy, x, regIdx+i);
  106843. VdbeComment((v, "%s", iField<0 ? "rowid" : pTab->aCol[iField].zName));
  106844. }
  106845. }
  106846. sqlite3VdbeAddOp3(v, OP_MakeRecord, regIdx, pIdx->nColumn, aRegIdx[ix]);
  106847. VdbeComment((v, "for %s", pIdx->zName));
  106848. #ifdef SQLITE_ENABLE_NULL_TRIM
  106849. if( pIdx->idxType==2 ) sqlite3SetMakeRecordP5(v, pIdx->pTable);
  106850. #endif
  106851. /* In an UPDATE operation, if this index is the PRIMARY KEY index
  106852. ** of a WITHOUT ROWID table and there has been no change the
  106853. ** primary key, then no collision is possible. The collision detection
  106854. ** logic below can all be skipped. */
  106855. if( isUpdate && pPk==pIdx && pkChng==0 ){
  106856. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  106857. continue;
  106858. }
  106859. /* Find out what action to take in case there is a uniqueness conflict */
  106860. onError = pIdx->onError;
  106861. if( onError==OE_None ){
  106862. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  106863. continue; /* pIdx is not a UNIQUE index */
  106864. }
  106865. if( overrideError!=OE_Default ){
  106866. onError = overrideError;
  106867. }else if( onError==OE_Default ){
  106868. onError = OE_Abort;
  106869. }
  106870. /* Collision detection may be omitted if all of the following are true:
  106871. ** (1) The conflict resolution algorithm is REPLACE
  106872. ** (2) The table is a WITHOUT ROWID table
  106873. ** (3) There are no secondary indexes on the table
  106874. ** (4) No delete triggers need to be fired if there is a conflict
  106875. ** (5) No FK constraint counters need to be updated if a conflict occurs.
  106876. */
  106877. if( (ix==0 && pIdx->pNext==0) /* Condition 3 */
  106878. && pPk==pIdx /* Condition 2 */
  106879. && onError==OE_Replace /* Condition 1 */
  106880. && ( 0==(db->flags&SQLITE_RecTriggers) || /* Condition 4 */
  106881. 0==sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0))
  106882. && ( 0==(db->flags&SQLITE_ForeignKeys) || /* Condition 5 */
  106883. (0==pTab->pFKey && 0==sqlite3FkReferences(pTab)))
  106884. ){
  106885. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  106886. continue;
  106887. }
  106888. /* Check to see if the new index entry will be unique */
  106889. sqlite3ExprCachePush(pParse);
  106890. sqlite3VdbeAddOp4Int(v, OP_NoConflict, iThisCur, addrUniqueOk,
  106891. regIdx, pIdx->nKeyCol); VdbeCoverage(v);
  106892. /* Generate code to handle collisions */
  106893. regR = (pIdx==pPk) ? regIdx : sqlite3GetTempRange(pParse, nPkField);
  106894. if( isUpdate || onError==OE_Replace ){
  106895. if( HasRowid(pTab) ){
  106896. sqlite3VdbeAddOp2(v, OP_IdxRowid, iThisCur, regR);
  106897. /* Conflict only if the rowid of the existing index entry
  106898. ** is different from old-rowid */
  106899. if( isUpdate ){
  106900. sqlite3VdbeAddOp3(v, OP_Eq, regR, addrUniqueOk, regOldData);
  106901. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  106902. VdbeCoverage(v);
  106903. }
  106904. }else{
  106905. int x;
  106906. /* Extract the PRIMARY KEY from the end of the index entry and
  106907. ** store it in registers regR..regR+nPk-1 */
  106908. if( pIdx!=pPk ){
  106909. for(i=0; i<pPk->nKeyCol; i++){
  106910. assert( pPk->aiColumn[i]>=0 );
  106911. x = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[i]);
  106912. sqlite3VdbeAddOp3(v, OP_Column, iThisCur, x, regR+i);
  106913. VdbeComment((v, "%s.%s", pTab->zName,
  106914. pTab->aCol[pPk->aiColumn[i]].zName));
  106915. }
  106916. }
  106917. if( isUpdate ){
  106918. /* If currently processing the PRIMARY KEY of a WITHOUT ROWID
  106919. ** table, only conflict if the new PRIMARY KEY values are actually
  106920. ** different from the old.
  106921. **
  106922. ** For a UNIQUE index, only conflict if the PRIMARY KEY values
  106923. ** of the matched index row are different from the original PRIMARY
  106924. ** KEY values of this row before the update. */
  106925. int addrJump = sqlite3VdbeCurrentAddr(v)+pPk->nKeyCol;
  106926. int op = OP_Ne;
  106927. int regCmp = (IsPrimaryKeyIndex(pIdx) ? regIdx : regR);
  106928. for(i=0; i<pPk->nKeyCol; i++){
  106929. char *p4 = (char*)sqlite3LocateCollSeq(pParse, pPk->azColl[i]);
  106930. x = pPk->aiColumn[i];
  106931. assert( x>=0 );
  106932. if( i==(pPk->nKeyCol-1) ){
  106933. addrJump = addrUniqueOk;
  106934. op = OP_Eq;
  106935. }
  106936. sqlite3VdbeAddOp4(v, op,
  106937. regOldData+1+x, addrJump, regCmp+i, p4, P4_COLLSEQ
  106938. );
  106939. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  106940. VdbeCoverageIf(v, op==OP_Eq);
  106941. VdbeCoverageIf(v, op==OP_Ne);
  106942. }
  106943. }
  106944. }
  106945. }
  106946. /* Generate code that executes if the new index entry is not unique */
  106947. assert( onError==OE_Rollback || onError==OE_Abort || onError==OE_Fail
  106948. || onError==OE_Ignore || onError==OE_Replace );
  106949. switch( onError ){
  106950. case OE_Rollback:
  106951. case OE_Abort:
  106952. case OE_Fail: {
  106953. sqlite3UniqueConstraint(pParse, onError, pIdx);
  106954. break;
  106955. }
  106956. case OE_Ignore: {
  106957. sqlite3VdbeGoto(v, ignoreDest);
  106958. break;
  106959. }
  106960. default: {
  106961. Trigger *pTrigger = 0;
  106962. assert( onError==OE_Replace );
  106963. sqlite3MultiWrite(pParse);
  106964. if( db->flags&SQLITE_RecTriggers ){
  106965. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_DELETE, 0, 0);
  106966. }
  106967. sqlite3GenerateRowDelete(pParse, pTab, pTrigger, iDataCur, iIdxCur,
  106968. regR, nPkField, 0, OE_Replace,
  106969. (pIdx==pPk ? ONEPASS_SINGLE : ONEPASS_OFF), iThisCur);
  106970. seenReplace = 1;
  106971. break;
  106972. }
  106973. }
  106974. sqlite3VdbeResolveLabel(v, addrUniqueOk);
  106975. sqlite3ExprCachePop(pParse);
  106976. if( regR!=regIdx ) sqlite3ReleaseTempRange(pParse, regR, nPkField);
  106977. }
  106978. if( ipkTop ){
  106979. sqlite3VdbeGoto(v, ipkTop+1);
  106980. sqlite3VdbeJumpHere(v, ipkBottom);
  106981. }
  106982. *pbMayReplace = seenReplace;
  106983. VdbeModuleComment((v, "END: GenCnstCks(%d)", seenReplace));
  106984. }
  106985. #ifdef SQLITE_ENABLE_NULL_TRIM
  106986. /*
  106987. ** Change the P5 operand on the last opcode (which should be an OP_MakeRecord)
  106988. ** to be the number of columns in table pTab that must not be NULL-trimmed.
  106989. **
  106990. ** Or if no columns of pTab may be NULL-trimmed, leave P5 at zero.
  106991. */
  106992. SQLITE_PRIVATE void sqlite3SetMakeRecordP5(Vdbe *v, Table *pTab){
  106993. u16 i;
  106994. /* Records with omitted columns are only allowed for schema format
  106995. ** version 2 and later (SQLite version 3.1.4, 2005-02-20). */
  106996. if( pTab->pSchema->file_format<2 ) return;
  106997. for(i=pTab->nCol-1; i>0; i--){
  106998. if( pTab->aCol[i].pDflt!=0 ) break;
  106999. if( pTab->aCol[i].colFlags & COLFLAG_PRIMKEY ) break;
  107000. }
  107001. sqlite3VdbeChangeP5(v, i+1);
  107002. }
  107003. #endif
  107004. /*
  107005. ** This routine generates code to finish the INSERT or UPDATE operation
  107006. ** that was started by a prior call to sqlite3GenerateConstraintChecks.
  107007. ** A consecutive range of registers starting at regNewData contains the
  107008. ** rowid and the content to be inserted.
  107009. **
  107010. ** The arguments to this routine should be the same as the first six
  107011. ** arguments to sqlite3GenerateConstraintChecks.
  107012. */
  107013. SQLITE_PRIVATE void sqlite3CompleteInsertion(
  107014. Parse *pParse, /* The parser context */
  107015. Table *pTab, /* the table into which we are inserting */
  107016. int iDataCur, /* Cursor of the canonical data source */
  107017. int iIdxCur, /* First index cursor */
  107018. int regNewData, /* Range of content */
  107019. int *aRegIdx, /* Register used by each index. 0 for unused indices */
  107020. int update_flags, /* True for UPDATE, False for INSERT */
  107021. int appendBias, /* True if this is likely to be an append */
  107022. int useSeekResult /* True to set the USESEEKRESULT flag on OP_[Idx]Insert */
  107023. ){
  107024. Vdbe *v; /* Prepared statements under construction */
  107025. Index *pIdx; /* An index being inserted or updated */
  107026. u8 pik_flags; /* flag values passed to the btree insert */
  107027. int regData; /* Content registers (after the rowid) */
  107028. int regRec; /* Register holding assembled record for the table */
  107029. int i; /* Loop counter */
  107030. u8 bAffinityDone = 0; /* True if OP_Affinity has been run already */
  107031. assert( update_flags==0
  107032. || update_flags==OPFLAG_ISUPDATE
  107033. || update_flags==(OPFLAG_ISUPDATE|OPFLAG_SAVEPOSITION)
  107034. );
  107035. v = sqlite3GetVdbe(pParse);
  107036. assert( v!=0 );
  107037. assert( pTab->pSelect==0 ); /* This table is not a VIEW */
  107038. for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
  107039. if( aRegIdx[i]==0 ) continue;
  107040. bAffinityDone = 1;
  107041. if( pIdx->pPartIdxWhere ){
  107042. sqlite3VdbeAddOp2(v, OP_IsNull, aRegIdx[i], sqlite3VdbeCurrentAddr(v)+2);
  107043. VdbeCoverage(v);
  107044. }
  107045. pik_flags = (useSeekResult ? OPFLAG_USESEEKRESULT : 0);
  107046. if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
  107047. assert( pParse->nested==0 );
  107048. pik_flags |= OPFLAG_NCHANGE;
  107049. pik_flags |= (update_flags & OPFLAG_SAVEPOSITION);
  107050. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  107051. if( update_flags==0 ){
  107052. sqlite3VdbeAddOp4(v, OP_InsertInt,
  107053. iIdxCur+i, aRegIdx[i], 0, (char*)pTab, P4_TABLE
  107054. );
  107055. sqlite3VdbeChangeP5(v, OPFLAG_ISNOOP);
  107056. }
  107057. #endif
  107058. }
  107059. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iIdxCur+i, aRegIdx[i],
  107060. aRegIdx[i]+1,
  107061. pIdx->uniqNotNull ? pIdx->nKeyCol: pIdx->nColumn);
  107062. sqlite3VdbeChangeP5(v, pik_flags);
  107063. }
  107064. if( !HasRowid(pTab) ) return;
  107065. regData = regNewData + 1;
  107066. regRec = sqlite3GetTempReg(pParse);
  107067. sqlite3VdbeAddOp3(v, OP_MakeRecord, regData, pTab->nCol, regRec);
  107068. sqlite3SetMakeRecordP5(v, pTab);
  107069. if( !bAffinityDone ){
  107070. sqlite3TableAffinity(v, pTab, 0);
  107071. sqlite3ExprCacheAffinityChange(pParse, regData, pTab->nCol);
  107072. }
  107073. if( pParse->nested ){
  107074. pik_flags = 0;
  107075. }else{
  107076. pik_flags = OPFLAG_NCHANGE;
  107077. pik_flags |= (update_flags?update_flags:OPFLAG_LASTROWID);
  107078. }
  107079. if( appendBias ){
  107080. pik_flags |= OPFLAG_APPEND;
  107081. }
  107082. if( useSeekResult ){
  107083. pik_flags |= OPFLAG_USESEEKRESULT;
  107084. }
  107085. sqlite3VdbeAddOp3(v, OP_Insert, iDataCur, regRec, regNewData);
  107086. if( !pParse->nested ){
  107087. sqlite3VdbeAppendP4(v, pTab, P4_TABLE);
  107088. }
  107089. sqlite3VdbeChangeP5(v, pik_flags);
  107090. }
  107091. /*
  107092. ** Allocate cursors for the pTab table and all its indices and generate
  107093. ** code to open and initialized those cursors.
  107094. **
  107095. ** The cursor for the object that contains the complete data (normally
  107096. ** the table itself, but the PRIMARY KEY index in the case of a WITHOUT
  107097. ** ROWID table) is returned in *piDataCur. The first index cursor is
  107098. ** returned in *piIdxCur. The number of indices is returned.
  107099. **
  107100. ** Use iBase as the first cursor (either the *piDataCur for rowid tables
  107101. ** or the first index for WITHOUT ROWID tables) if it is non-negative.
  107102. ** If iBase is negative, then allocate the next available cursor.
  107103. **
  107104. ** For a rowid table, *piDataCur will be exactly one less than *piIdxCur.
  107105. ** For a WITHOUT ROWID table, *piDataCur will be somewhere in the range
  107106. ** of *piIdxCurs, depending on where the PRIMARY KEY index appears on the
  107107. ** pTab->pIndex list.
  107108. **
  107109. ** If pTab is a virtual table, then this routine is a no-op and the
  107110. ** *piDataCur and *piIdxCur values are left uninitialized.
  107111. */
  107112. SQLITE_PRIVATE int sqlite3OpenTableAndIndices(
  107113. Parse *pParse, /* Parsing context */
  107114. Table *pTab, /* Table to be opened */
  107115. int op, /* OP_OpenRead or OP_OpenWrite */
  107116. u8 p5, /* P5 value for OP_Open* opcodes (except on WITHOUT ROWID) */
  107117. int iBase, /* Use this for the table cursor, if there is one */
  107118. u8 *aToOpen, /* If not NULL: boolean for each table and index */
  107119. int *piDataCur, /* Write the database source cursor number here */
  107120. int *piIdxCur /* Write the first index cursor number here */
  107121. ){
  107122. int i;
  107123. int iDb;
  107124. int iDataCur;
  107125. Index *pIdx;
  107126. Vdbe *v;
  107127. assert( op==OP_OpenRead || op==OP_OpenWrite );
  107128. assert( op==OP_OpenWrite || p5==0 );
  107129. if( IsVirtual(pTab) ){
  107130. /* This routine is a no-op for virtual tables. Leave the output
  107131. ** variables *piDataCur and *piIdxCur uninitialized so that valgrind
  107132. ** can detect if they are used by mistake in the caller. */
  107133. return 0;
  107134. }
  107135. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  107136. v = sqlite3GetVdbe(pParse);
  107137. assert( v!=0 );
  107138. if( iBase<0 ) iBase = pParse->nTab;
  107139. iDataCur = iBase++;
  107140. if( piDataCur ) *piDataCur = iDataCur;
  107141. if( HasRowid(pTab) && (aToOpen==0 || aToOpen[0]) ){
  107142. sqlite3OpenTable(pParse, iDataCur, iDb, pTab, op);
  107143. }else{
  107144. sqlite3TableLock(pParse, iDb, pTab->tnum, op==OP_OpenWrite, pTab->zName);
  107145. }
  107146. if( piIdxCur ) *piIdxCur = iBase;
  107147. for(i=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, i++){
  107148. int iIdxCur = iBase++;
  107149. assert( pIdx->pSchema==pTab->pSchema );
  107150. if( IsPrimaryKeyIndex(pIdx) && !HasRowid(pTab) ){
  107151. if( piDataCur ) *piDataCur = iIdxCur;
  107152. p5 = 0;
  107153. }
  107154. if( aToOpen==0 || aToOpen[i+1] ){
  107155. sqlite3VdbeAddOp3(v, op, iIdxCur, pIdx->tnum, iDb);
  107156. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  107157. sqlite3VdbeChangeP5(v, p5);
  107158. VdbeComment((v, "%s", pIdx->zName));
  107159. }
  107160. }
  107161. if( iBase>pParse->nTab ) pParse->nTab = iBase;
  107162. return i;
  107163. }
  107164. #ifdef SQLITE_TEST
  107165. /*
  107166. ** The following global variable is incremented whenever the
  107167. ** transfer optimization is used. This is used for testing
  107168. ** purposes only - to make sure the transfer optimization really
  107169. ** is happening when it is supposed to.
  107170. */
  107171. SQLITE_API int sqlite3_xferopt_count;
  107172. #endif /* SQLITE_TEST */
  107173. #ifndef SQLITE_OMIT_XFER_OPT
  107174. /*
  107175. ** Check to see if index pSrc is compatible as a source of data
  107176. ** for index pDest in an insert transfer optimization. The rules
  107177. ** for a compatible index:
  107178. **
  107179. ** * The index is over the same set of columns
  107180. ** * The same DESC and ASC markings occurs on all columns
  107181. ** * The same onError processing (OE_Abort, OE_Ignore, etc)
  107182. ** * The same collating sequence on each column
  107183. ** * The index has the exact same WHERE clause
  107184. */
  107185. static int xferCompatibleIndex(Index *pDest, Index *pSrc){
  107186. int i;
  107187. assert( pDest && pSrc );
  107188. assert( pDest->pTable!=pSrc->pTable );
  107189. if( pDest->nKeyCol!=pSrc->nKeyCol ){
  107190. return 0; /* Different number of columns */
  107191. }
  107192. if( pDest->onError!=pSrc->onError ){
  107193. return 0; /* Different conflict resolution strategies */
  107194. }
  107195. for(i=0; i<pSrc->nKeyCol; i++){
  107196. if( pSrc->aiColumn[i]!=pDest->aiColumn[i] ){
  107197. return 0; /* Different columns indexed */
  107198. }
  107199. if( pSrc->aiColumn[i]==XN_EXPR ){
  107200. assert( pSrc->aColExpr!=0 && pDest->aColExpr!=0 );
  107201. if( sqlite3ExprCompare(0, pSrc->aColExpr->a[i].pExpr,
  107202. pDest->aColExpr->a[i].pExpr, -1)!=0 ){
  107203. return 0; /* Different expressions in the index */
  107204. }
  107205. }
  107206. if( pSrc->aSortOrder[i]!=pDest->aSortOrder[i] ){
  107207. return 0; /* Different sort orders */
  107208. }
  107209. if( sqlite3_stricmp(pSrc->azColl[i],pDest->azColl[i])!=0 ){
  107210. return 0; /* Different collating sequences */
  107211. }
  107212. }
  107213. if( sqlite3ExprCompare(0, pSrc->pPartIdxWhere, pDest->pPartIdxWhere, -1) ){
  107214. return 0; /* Different WHERE clauses */
  107215. }
  107216. /* If no test above fails then the indices must be compatible */
  107217. return 1;
  107218. }
  107219. /*
  107220. ** Attempt the transfer optimization on INSERTs of the form
  107221. **
  107222. ** INSERT INTO tab1 SELECT * FROM tab2;
  107223. **
  107224. ** The xfer optimization transfers raw records from tab2 over to tab1.
  107225. ** Columns are not decoded and reassembled, which greatly improves
  107226. ** performance. Raw index records are transferred in the same way.
  107227. **
  107228. ** The xfer optimization is only attempted if tab1 and tab2 are compatible.
  107229. ** There are lots of rules for determining compatibility - see comments
  107230. ** embedded in the code for details.
  107231. **
  107232. ** This routine returns TRUE if the optimization is guaranteed to be used.
  107233. ** Sometimes the xfer optimization will only work if the destination table
  107234. ** is empty - a factor that can only be determined at run-time. In that
  107235. ** case, this routine generates code for the xfer optimization but also
  107236. ** does a test to see if the destination table is empty and jumps over the
  107237. ** xfer optimization code if the test fails. In that case, this routine
  107238. ** returns FALSE so that the caller will know to go ahead and generate
  107239. ** an unoptimized transfer. This routine also returns FALSE if there
  107240. ** is no chance that the xfer optimization can be applied.
  107241. **
  107242. ** This optimization is particularly useful at making VACUUM run faster.
  107243. */
  107244. static int xferOptimization(
  107245. Parse *pParse, /* Parser context */
  107246. Table *pDest, /* The table we are inserting into */
  107247. Select *pSelect, /* A SELECT statement to use as the data source */
  107248. int onError, /* How to handle constraint errors */
  107249. int iDbDest /* The database of pDest */
  107250. ){
  107251. sqlite3 *db = pParse->db;
  107252. ExprList *pEList; /* The result set of the SELECT */
  107253. Table *pSrc; /* The table in the FROM clause of SELECT */
  107254. Index *pSrcIdx, *pDestIdx; /* Source and destination indices */
  107255. struct SrcList_item *pItem; /* An element of pSelect->pSrc */
  107256. int i; /* Loop counter */
  107257. int iDbSrc; /* The database of pSrc */
  107258. int iSrc, iDest; /* Cursors from source and destination */
  107259. int addr1, addr2; /* Loop addresses */
  107260. int emptyDestTest = 0; /* Address of test for empty pDest */
  107261. int emptySrcTest = 0; /* Address of test for empty pSrc */
  107262. Vdbe *v; /* The VDBE we are building */
  107263. int regAutoinc; /* Memory register used by AUTOINC */
  107264. int destHasUniqueIdx = 0; /* True if pDest has a UNIQUE index */
  107265. int regData, regRowid; /* Registers holding data and rowid */
  107266. if( pSelect==0 ){
  107267. return 0; /* Must be of the form INSERT INTO ... SELECT ... */
  107268. }
  107269. if( pParse->pWith || pSelect->pWith ){
  107270. /* Do not attempt to process this query if there are an WITH clauses
  107271. ** attached to it. Proceeding may generate a false "no such table: xxx"
  107272. ** error if pSelect reads from a CTE named "xxx". */
  107273. return 0;
  107274. }
  107275. if( sqlite3TriggerList(pParse, pDest) ){
  107276. return 0; /* tab1 must not have triggers */
  107277. }
  107278. #ifndef SQLITE_OMIT_VIRTUALTABLE
  107279. if( IsVirtual(pDest) ){
  107280. return 0; /* tab1 must not be a virtual table */
  107281. }
  107282. #endif
  107283. if( onError==OE_Default ){
  107284. if( pDest->iPKey>=0 ) onError = pDest->keyConf;
  107285. if( onError==OE_Default ) onError = OE_Abort;
  107286. }
  107287. assert(pSelect->pSrc); /* allocated even if there is no FROM clause */
  107288. if( pSelect->pSrc->nSrc!=1 ){
  107289. return 0; /* FROM clause must have exactly one term */
  107290. }
  107291. if( pSelect->pSrc->a[0].pSelect ){
  107292. return 0; /* FROM clause cannot contain a subquery */
  107293. }
  107294. if( pSelect->pWhere ){
  107295. return 0; /* SELECT may not have a WHERE clause */
  107296. }
  107297. if( pSelect->pOrderBy ){
  107298. return 0; /* SELECT may not have an ORDER BY clause */
  107299. }
  107300. /* Do not need to test for a HAVING clause. If HAVING is present but
  107301. ** there is no ORDER BY, we will get an error. */
  107302. if( pSelect->pGroupBy ){
  107303. return 0; /* SELECT may not have a GROUP BY clause */
  107304. }
  107305. if( pSelect->pLimit ){
  107306. return 0; /* SELECT may not have a LIMIT clause */
  107307. }
  107308. if( pSelect->pPrior ){
  107309. return 0; /* SELECT may not be a compound query */
  107310. }
  107311. if( pSelect->selFlags & SF_Distinct ){
  107312. return 0; /* SELECT may not be DISTINCT */
  107313. }
  107314. pEList = pSelect->pEList;
  107315. assert( pEList!=0 );
  107316. if( pEList->nExpr!=1 ){
  107317. return 0; /* The result set must have exactly one column */
  107318. }
  107319. assert( pEList->a[0].pExpr );
  107320. if( pEList->a[0].pExpr->op!=TK_ASTERISK ){
  107321. return 0; /* The result set must be the special operator "*" */
  107322. }
  107323. /* At this point we have established that the statement is of the
  107324. ** correct syntactic form to participate in this optimization. Now
  107325. ** we have to check the semantics.
  107326. */
  107327. pItem = pSelect->pSrc->a;
  107328. pSrc = sqlite3LocateTableItem(pParse, 0, pItem);
  107329. if( pSrc==0 ){
  107330. return 0; /* FROM clause does not contain a real table */
  107331. }
  107332. if( pSrc==pDest ){
  107333. return 0; /* tab1 and tab2 may not be the same table */
  107334. }
  107335. if( HasRowid(pDest)!=HasRowid(pSrc) ){
  107336. return 0; /* source and destination must both be WITHOUT ROWID or not */
  107337. }
  107338. #ifndef SQLITE_OMIT_VIRTUALTABLE
  107339. if( IsVirtual(pSrc) ){
  107340. return 0; /* tab2 must not be a virtual table */
  107341. }
  107342. #endif
  107343. if( pSrc->pSelect ){
  107344. return 0; /* tab2 may not be a view */
  107345. }
  107346. if( pDest->nCol!=pSrc->nCol ){
  107347. return 0; /* Number of columns must be the same in tab1 and tab2 */
  107348. }
  107349. if( pDest->iPKey!=pSrc->iPKey ){
  107350. return 0; /* Both tables must have the same INTEGER PRIMARY KEY */
  107351. }
  107352. for(i=0; i<pDest->nCol; i++){
  107353. Column *pDestCol = &pDest->aCol[i];
  107354. Column *pSrcCol = &pSrc->aCol[i];
  107355. #ifdef SQLITE_ENABLE_HIDDEN_COLUMNS
  107356. if( (db->mDbFlags & DBFLAG_Vacuum)==0
  107357. && (pDestCol->colFlags | pSrcCol->colFlags) & COLFLAG_HIDDEN
  107358. ){
  107359. return 0; /* Neither table may have __hidden__ columns */
  107360. }
  107361. #endif
  107362. if( pDestCol->affinity!=pSrcCol->affinity ){
  107363. return 0; /* Affinity must be the same on all columns */
  107364. }
  107365. if( sqlite3_stricmp(pDestCol->zColl, pSrcCol->zColl)!=0 ){
  107366. return 0; /* Collating sequence must be the same on all columns */
  107367. }
  107368. if( pDestCol->notNull && !pSrcCol->notNull ){
  107369. return 0; /* tab2 must be NOT NULL if tab1 is */
  107370. }
  107371. /* Default values for second and subsequent columns need to match. */
  107372. if( i>0 ){
  107373. assert( pDestCol->pDflt==0 || pDestCol->pDflt->op==TK_SPAN );
  107374. assert( pSrcCol->pDflt==0 || pSrcCol->pDflt->op==TK_SPAN );
  107375. if( (pDestCol->pDflt==0)!=(pSrcCol->pDflt==0)
  107376. || (pDestCol->pDflt && strcmp(pDestCol->pDflt->u.zToken,
  107377. pSrcCol->pDflt->u.zToken)!=0)
  107378. ){
  107379. return 0; /* Default values must be the same for all columns */
  107380. }
  107381. }
  107382. }
  107383. for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
  107384. if( IsUniqueIndex(pDestIdx) ){
  107385. destHasUniqueIdx = 1;
  107386. }
  107387. for(pSrcIdx=pSrc->pIndex; pSrcIdx; pSrcIdx=pSrcIdx->pNext){
  107388. if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
  107389. }
  107390. if( pSrcIdx==0 ){
  107391. return 0; /* pDestIdx has no corresponding index in pSrc */
  107392. }
  107393. }
  107394. #ifndef SQLITE_OMIT_CHECK
  107395. if( pDest->pCheck && sqlite3ExprListCompare(pSrc->pCheck,pDest->pCheck,-1) ){
  107396. return 0; /* Tables have different CHECK constraints. Ticket #2252 */
  107397. }
  107398. #endif
  107399. #ifndef SQLITE_OMIT_FOREIGN_KEY
  107400. /* Disallow the transfer optimization if the destination table constains
  107401. ** any foreign key constraints. This is more restrictive than necessary.
  107402. ** But the main beneficiary of the transfer optimization is the VACUUM
  107403. ** command, and the VACUUM command disables foreign key constraints. So
  107404. ** the extra complication to make this rule less restrictive is probably
  107405. ** not worth the effort. Ticket [6284df89debdfa61db8073e062908af0c9b6118e]
  107406. */
  107407. if( (db->flags & SQLITE_ForeignKeys)!=0 && pDest->pFKey!=0 ){
  107408. return 0;
  107409. }
  107410. #endif
  107411. if( (db->flags & SQLITE_CountRows)!=0 ){
  107412. return 0; /* xfer opt does not play well with PRAGMA count_changes */
  107413. }
  107414. /* If we get this far, it means that the xfer optimization is at
  107415. ** least a possibility, though it might only work if the destination
  107416. ** table (tab1) is initially empty.
  107417. */
  107418. #ifdef SQLITE_TEST
  107419. sqlite3_xferopt_count++;
  107420. #endif
  107421. iDbSrc = sqlite3SchemaToIndex(db, pSrc->pSchema);
  107422. v = sqlite3GetVdbe(pParse);
  107423. sqlite3CodeVerifySchema(pParse, iDbSrc);
  107424. iSrc = pParse->nTab++;
  107425. iDest = pParse->nTab++;
  107426. regAutoinc = autoIncBegin(pParse, iDbDest, pDest);
  107427. regData = sqlite3GetTempReg(pParse);
  107428. regRowid = sqlite3GetTempReg(pParse);
  107429. sqlite3OpenTable(pParse, iDest, iDbDest, pDest, OP_OpenWrite);
  107430. assert( HasRowid(pDest) || destHasUniqueIdx );
  107431. if( (db->mDbFlags & DBFLAG_Vacuum)==0 && (
  107432. (pDest->iPKey<0 && pDest->pIndex!=0) /* (1) */
  107433. || destHasUniqueIdx /* (2) */
  107434. || (onError!=OE_Abort && onError!=OE_Rollback) /* (3) */
  107435. )){
  107436. /* In some circumstances, we are able to run the xfer optimization
  107437. ** only if the destination table is initially empty. Unless the
  107438. ** DBFLAG_Vacuum flag is set, this block generates code to make
  107439. ** that determination. If DBFLAG_Vacuum is set, then the destination
  107440. ** table is always empty.
  107441. **
  107442. ** Conditions under which the destination must be empty:
  107443. **
  107444. ** (1) There is no INTEGER PRIMARY KEY but there are indices.
  107445. ** (If the destination is not initially empty, the rowid fields
  107446. ** of index entries might need to change.)
  107447. **
  107448. ** (2) The destination has a unique index. (The xfer optimization
  107449. ** is unable to test uniqueness.)
  107450. **
  107451. ** (3) onError is something other than OE_Abort and OE_Rollback.
  107452. */
  107453. addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iDest, 0); VdbeCoverage(v);
  107454. emptyDestTest = sqlite3VdbeAddOp0(v, OP_Goto);
  107455. sqlite3VdbeJumpHere(v, addr1);
  107456. }
  107457. if( HasRowid(pSrc) ){
  107458. u8 insFlags;
  107459. sqlite3OpenTable(pParse, iSrc, iDbSrc, pSrc, OP_OpenRead);
  107460. emptySrcTest = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
  107461. if( pDest->iPKey>=0 ){
  107462. addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
  107463. addr2 = sqlite3VdbeAddOp3(v, OP_NotExists, iDest, 0, regRowid);
  107464. VdbeCoverage(v);
  107465. sqlite3RowidConstraint(pParse, onError, pDest);
  107466. sqlite3VdbeJumpHere(v, addr2);
  107467. autoIncStep(pParse, regAutoinc, regRowid);
  107468. }else if( pDest->pIndex==0 ){
  107469. addr1 = sqlite3VdbeAddOp2(v, OP_NewRowid, iDest, regRowid);
  107470. }else{
  107471. addr1 = sqlite3VdbeAddOp2(v, OP_Rowid, iSrc, regRowid);
  107472. assert( (pDest->tabFlags & TF_Autoincrement)==0 );
  107473. }
  107474. sqlite3VdbeAddOp3(v, OP_RowData, iSrc, regData, 1);
  107475. if( db->mDbFlags & DBFLAG_Vacuum ){
  107476. sqlite3VdbeAddOp1(v, OP_SeekEnd, iDest);
  107477. insFlags = OPFLAG_NCHANGE|OPFLAG_LASTROWID|
  107478. OPFLAG_APPEND|OPFLAG_USESEEKRESULT;
  107479. }else{
  107480. insFlags = OPFLAG_NCHANGE|OPFLAG_LASTROWID|OPFLAG_APPEND;
  107481. }
  107482. sqlite3VdbeAddOp4(v, OP_Insert, iDest, regData, regRowid,
  107483. (char*)pDest, P4_TABLE);
  107484. sqlite3VdbeChangeP5(v, insFlags);
  107485. sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1); VdbeCoverage(v);
  107486. sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
  107487. sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
  107488. }else{
  107489. sqlite3TableLock(pParse, iDbDest, pDest->tnum, 1, pDest->zName);
  107490. sqlite3TableLock(pParse, iDbSrc, pSrc->tnum, 0, pSrc->zName);
  107491. }
  107492. for(pDestIdx=pDest->pIndex; pDestIdx; pDestIdx=pDestIdx->pNext){
  107493. u8 idxInsFlags = 0;
  107494. for(pSrcIdx=pSrc->pIndex; ALWAYS(pSrcIdx); pSrcIdx=pSrcIdx->pNext){
  107495. if( xferCompatibleIndex(pDestIdx, pSrcIdx) ) break;
  107496. }
  107497. assert( pSrcIdx );
  107498. sqlite3VdbeAddOp3(v, OP_OpenRead, iSrc, pSrcIdx->tnum, iDbSrc);
  107499. sqlite3VdbeSetP4KeyInfo(pParse, pSrcIdx);
  107500. VdbeComment((v, "%s", pSrcIdx->zName));
  107501. sqlite3VdbeAddOp3(v, OP_OpenWrite, iDest, pDestIdx->tnum, iDbDest);
  107502. sqlite3VdbeSetP4KeyInfo(pParse, pDestIdx);
  107503. sqlite3VdbeChangeP5(v, OPFLAG_BULKCSR);
  107504. VdbeComment((v, "%s", pDestIdx->zName));
  107505. addr1 = sqlite3VdbeAddOp2(v, OP_Rewind, iSrc, 0); VdbeCoverage(v);
  107506. sqlite3VdbeAddOp3(v, OP_RowData, iSrc, regData, 1);
  107507. if( db->mDbFlags & DBFLAG_Vacuum ){
  107508. /* This INSERT command is part of a VACUUM operation, which guarantees
  107509. ** that the destination table is empty. If all indexed columns use
  107510. ** collation sequence BINARY, then it can also be assumed that the
  107511. ** index will be populated by inserting keys in strictly sorted
  107512. ** order. In this case, instead of seeking within the b-tree as part
  107513. ** of every OP_IdxInsert opcode, an OP_SeekEnd is added before the
  107514. ** OP_IdxInsert to seek to the point within the b-tree where each key
  107515. ** should be inserted. This is faster.
  107516. **
  107517. ** If any of the indexed columns use a collation sequence other than
  107518. ** BINARY, this optimization is disabled. This is because the user
  107519. ** might change the definition of a collation sequence and then run
  107520. ** a VACUUM command. In that case keys may not be written in strictly
  107521. ** sorted order. */
  107522. for(i=0; i<pSrcIdx->nColumn; i++){
  107523. const char *zColl = pSrcIdx->azColl[i];
  107524. if( sqlite3_stricmp(sqlite3StrBINARY, zColl) ) break;
  107525. }
  107526. if( i==pSrcIdx->nColumn ){
  107527. idxInsFlags = OPFLAG_USESEEKRESULT;
  107528. sqlite3VdbeAddOp1(v, OP_SeekEnd, iDest);
  107529. }
  107530. }
  107531. if( !HasRowid(pSrc) && pDestIdx->idxType==2 ){
  107532. idxInsFlags |= OPFLAG_NCHANGE;
  107533. }
  107534. sqlite3VdbeAddOp2(v, OP_IdxInsert, iDest, regData);
  107535. sqlite3VdbeChangeP5(v, idxInsFlags|OPFLAG_APPEND);
  107536. sqlite3VdbeAddOp2(v, OP_Next, iSrc, addr1+1); VdbeCoverage(v);
  107537. sqlite3VdbeJumpHere(v, addr1);
  107538. sqlite3VdbeAddOp2(v, OP_Close, iSrc, 0);
  107539. sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
  107540. }
  107541. if( emptySrcTest ) sqlite3VdbeJumpHere(v, emptySrcTest);
  107542. sqlite3ReleaseTempReg(pParse, regRowid);
  107543. sqlite3ReleaseTempReg(pParse, regData);
  107544. if( emptyDestTest ){
  107545. sqlite3AutoincrementEnd(pParse);
  107546. sqlite3VdbeAddOp2(v, OP_Halt, SQLITE_OK, 0);
  107547. sqlite3VdbeJumpHere(v, emptyDestTest);
  107548. sqlite3VdbeAddOp2(v, OP_Close, iDest, 0);
  107549. return 0;
  107550. }else{
  107551. return 1;
  107552. }
  107553. }
  107554. #endif /* SQLITE_OMIT_XFER_OPT */
  107555. /************** End of insert.c **********************************************/
  107556. /************** Begin file legacy.c ******************************************/
  107557. /*
  107558. ** 2001 September 15
  107559. **
  107560. ** The author disclaims copyright to this source code. In place of
  107561. ** a legal notice, here is a blessing:
  107562. **
  107563. ** May you do good and not evil.
  107564. ** May you find forgiveness for yourself and forgive others.
  107565. ** May you share freely, never taking more than you give.
  107566. **
  107567. *************************************************************************
  107568. ** Main file for the SQLite library. The routines in this file
  107569. ** implement the programmer interface to the library. Routines in
  107570. ** other files are for internal use by SQLite and should not be
  107571. ** accessed by users of the library.
  107572. */
  107573. /* #include "sqliteInt.h" */
  107574. /*
  107575. ** Execute SQL code. Return one of the SQLITE_ success/failure
  107576. ** codes. Also write an error message into memory obtained from
  107577. ** malloc() and make *pzErrMsg point to that message.
  107578. **
  107579. ** If the SQL is a query, then for each row in the query result
  107580. ** the xCallback() function is called. pArg becomes the first
  107581. ** argument to xCallback(). If xCallback=NULL then no callback
  107582. ** is invoked, even for queries.
  107583. */
  107584. SQLITE_API int sqlite3_exec(
  107585. sqlite3 *db, /* The database on which the SQL executes */
  107586. const char *zSql, /* The SQL to be executed */
  107587. sqlite3_callback xCallback, /* Invoke this callback routine */
  107588. void *pArg, /* First argument to xCallback() */
  107589. char **pzErrMsg /* Write error messages here */
  107590. ){
  107591. int rc = SQLITE_OK; /* Return code */
  107592. const char *zLeftover; /* Tail of unprocessed SQL */
  107593. sqlite3_stmt *pStmt = 0; /* The current SQL statement */
  107594. char **azCols = 0; /* Names of result columns */
  107595. int callbackIsInit; /* True if callback data is initialized */
  107596. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  107597. if( zSql==0 ) zSql = "";
  107598. sqlite3_mutex_enter(db->mutex);
  107599. sqlite3Error(db, SQLITE_OK);
  107600. while( rc==SQLITE_OK && zSql[0] ){
  107601. int nCol;
  107602. char **azVals = 0;
  107603. pStmt = 0;
  107604. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, &zLeftover);
  107605. assert( rc==SQLITE_OK || pStmt==0 );
  107606. if( rc!=SQLITE_OK ){
  107607. continue;
  107608. }
  107609. if( !pStmt ){
  107610. /* this happens for a comment or white-space */
  107611. zSql = zLeftover;
  107612. continue;
  107613. }
  107614. callbackIsInit = 0;
  107615. nCol = sqlite3_column_count(pStmt);
  107616. while( 1 ){
  107617. int i;
  107618. rc = sqlite3_step(pStmt);
  107619. /* Invoke the callback function if required */
  107620. if( xCallback && (SQLITE_ROW==rc ||
  107621. (SQLITE_DONE==rc && !callbackIsInit
  107622. && db->flags&SQLITE_NullCallback)) ){
  107623. if( !callbackIsInit ){
  107624. azCols = sqlite3DbMallocRaw(db, (2*nCol+1)*sizeof(const char*));
  107625. if( azCols==0 ){
  107626. goto exec_out;
  107627. }
  107628. for(i=0; i<nCol; i++){
  107629. azCols[i] = (char *)sqlite3_column_name(pStmt, i);
  107630. /* sqlite3VdbeSetColName() installs column names as UTF8
  107631. ** strings so there is no way for sqlite3_column_name() to fail. */
  107632. assert( azCols[i]!=0 );
  107633. }
  107634. callbackIsInit = 1;
  107635. }
  107636. if( rc==SQLITE_ROW ){
  107637. azVals = &azCols[nCol];
  107638. for(i=0; i<nCol; i++){
  107639. azVals[i] = (char *)sqlite3_column_text(pStmt, i);
  107640. if( !azVals[i] && sqlite3_column_type(pStmt, i)!=SQLITE_NULL ){
  107641. sqlite3OomFault(db);
  107642. goto exec_out;
  107643. }
  107644. }
  107645. azVals[i] = 0;
  107646. }
  107647. if( xCallback(pArg, nCol, azVals, azCols) ){
  107648. /* EVIDENCE-OF: R-38229-40159 If the callback function to
  107649. ** sqlite3_exec() returns non-zero, then sqlite3_exec() will
  107650. ** return SQLITE_ABORT. */
  107651. rc = SQLITE_ABORT;
  107652. sqlite3VdbeFinalize((Vdbe *)pStmt);
  107653. pStmt = 0;
  107654. sqlite3Error(db, SQLITE_ABORT);
  107655. goto exec_out;
  107656. }
  107657. }
  107658. if( rc!=SQLITE_ROW ){
  107659. rc = sqlite3VdbeFinalize((Vdbe *)pStmt);
  107660. pStmt = 0;
  107661. zSql = zLeftover;
  107662. while( sqlite3Isspace(zSql[0]) ) zSql++;
  107663. break;
  107664. }
  107665. }
  107666. sqlite3DbFree(db, azCols);
  107667. azCols = 0;
  107668. }
  107669. exec_out:
  107670. if( pStmt ) sqlite3VdbeFinalize((Vdbe *)pStmt);
  107671. sqlite3DbFree(db, azCols);
  107672. rc = sqlite3ApiExit(db, rc);
  107673. if( rc!=SQLITE_OK && pzErrMsg ){
  107674. *pzErrMsg = sqlite3DbStrDup(0, sqlite3_errmsg(db));
  107675. if( *pzErrMsg==0 ){
  107676. rc = SQLITE_NOMEM_BKPT;
  107677. sqlite3Error(db, SQLITE_NOMEM);
  107678. }
  107679. }else if( pzErrMsg ){
  107680. *pzErrMsg = 0;
  107681. }
  107682. assert( (rc&db->errMask)==rc );
  107683. sqlite3_mutex_leave(db->mutex);
  107684. return rc;
  107685. }
  107686. /************** End of legacy.c **********************************************/
  107687. /************** Begin file loadext.c *****************************************/
  107688. /*
  107689. ** 2006 June 7
  107690. **
  107691. ** The author disclaims copyright to this source code. In place of
  107692. ** a legal notice, here is a blessing:
  107693. **
  107694. ** May you do good and not evil.
  107695. ** May you find forgiveness for yourself and forgive others.
  107696. ** May you share freely, never taking more than you give.
  107697. **
  107698. *************************************************************************
  107699. ** This file contains code used to dynamically load extensions into
  107700. ** the SQLite library.
  107701. */
  107702. #ifndef SQLITE_CORE
  107703. #define SQLITE_CORE 1 /* Disable the API redefinition in sqlite3ext.h */
  107704. #endif
  107705. /************** Include sqlite3ext.h in the middle of loadext.c **************/
  107706. /************** Begin file sqlite3ext.h **************************************/
  107707. /*
  107708. ** 2006 June 7
  107709. **
  107710. ** The author disclaims copyright to this source code. In place of
  107711. ** a legal notice, here is a blessing:
  107712. **
  107713. ** May you do good and not evil.
  107714. ** May you find forgiveness for yourself and forgive others.
  107715. ** May you share freely, never taking more than you give.
  107716. **
  107717. *************************************************************************
  107718. ** This header file defines the SQLite interface for use by
  107719. ** shared libraries that want to be imported as extensions into
  107720. ** an SQLite instance. Shared libraries that intend to be loaded
  107721. ** as extensions by SQLite should #include this file instead of
  107722. ** sqlite3.h.
  107723. */
  107724. #ifndef SQLITE3EXT_H
  107725. #define SQLITE3EXT_H
  107726. /* #include "sqlite3.h" */
  107727. /*
  107728. ** The following structure holds pointers to all of the SQLite API
  107729. ** routines.
  107730. **
  107731. ** WARNING: In order to maintain backwards compatibility, add new
  107732. ** interfaces to the end of this structure only. If you insert new
  107733. ** interfaces in the middle of this structure, then older different
  107734. ** versions of SQLite will not be able to load each other's shared
  107735. ** libraries!
  107736. */
  107737. struct sqlite3_api_routines {
  107738. void * (*aggregate_context)(sqlite3_context*,int nBytes);
  107739. int (*aggregate_count)(sqlite3_context*);
  107740. int (*bind_blob)(sqlite3_stmt*,int,const void*,int n,void(*)(void*));
  107741. int (*bind_double)(sqlite3_stmt*,int,double);
  107742. int (*bind_int)(sqlite3_stmt*,int,int);
  107743. int (*bind_int64)(sqlite3_stmt*,int,sqlite_int64);
  107744. int (*bind_null)(sqlite3_stmt*,int);
  107745. int (*bind_parameter_count)(sqlite3_stmt*);
  107746. int (*bind_parameter_index)(sqlite3_stmt*,const char*zName);
  107747. const char * (*bind_parameter_name)(sqlite3_stmt*,int);
  107748. int (*bind_text)(sqlite3_stmt*,int,const char*,int n,void(*)(void*));
  107749. int (*bind_text16)(sqlite3_stmt*,int,const void*,int,void(*)(void*));
  107750. int (*bind_value)(sqlite3_stmt*,int,const sqlite3_value*);
  107751. int (*busy_handler)(sqlite3*,int(*)(void*,int),void*);
  107752. int (*busy_timeout)(sqlite3*,int ms);
  107753. int (*changes)(sqlite3*);
  107754. int (*close)(sqlite3*);
  107755. int (*collation_needed)(sqlite3*,void*,void(*)(void*,sqlite3*,
  107756. int eTextRep,const char*));
  107757. int (*collation_needed16)(sqlite3*,void*,void(*)(void*,sqlite3*,
  107758. int eTextRep,const void*));
  107759. const void * (*column_blob)(sqlite3_stmt*,int iCol);
  107760. int (*column_bytes)(sqlite3_stmt*,int iCol);
  107761. int (*column_bytes16)(sqlite3_stmt*,int iCol);
  107762. int (*column_count)(sqlite3_stmt*pStmt);
  107763. const char * (*column_database_name)(sqlite3_stmt*,int);
  107764. const void * (*column_database_name16)(sqlite3_stmt*,int);
  107765. const char * (*column_decltype)(sqlite3_stmt*,int i);
  107766. const void * (*column_decltype16)(sqlite3_stmt*,int);
  107767. double (*column_double)(sqlite3_stmt*,int iCol);
  107768. int (*column_int)(sqlite3_stmt*,int iCol);
  107769. sqlite_int64 (*column_int64)(sqlite3_stmt*,int iCol);
  107770. const char * (*column_name)(sqlite3_stmt*,int);
  107771. const void * (*column_name16)(sqlite3_stmt*,int);
  107772. const char * (*column_origin_name)(sqlite3_stmt*,int);
  107773. const void * (*column_origin_name16)(sqlite3_stmt*,int);
  107774. const char * (*column_table_name)(sqlite3_stmt*,int);
  107775. const void * (*column_table_name16)(sqlite3_stmt*,int);
  107776. const unsigned char * (*column_text)(sqlite3_stmt*,int iCol);
  107777. const void * (*column_text16)(sqlite3_stmt*,int iCol);
  107778. int (*column_type)(sqlite3_stmt*,int iCol);
  107779. sqlite3_value* (*column_value)(sqlite3_stmt*,int iCol);
  107780. void * (*commit_hook)(sqlite3*,int(*)(void*),void*);
  107781. int (*complete)(const char*sql);
  107782. int (*complete16)(const void*sql);
  107783. int (*create_collation)(sqlite3*,const char*,int,void*,
  107784. int(*)(void*,int,const void*,int,const void*));
  107785. int (*create_collation16)(sqlite3*,const void*,int,void*,
  107786. int(*)(void*,int,const void*,int,const void*));
  107787. int (*create_function)(sqlite3*,const char*,int,int,void*,
  107788. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  107789. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  107790. void (*xFinal)(sqlite3_context*));
  107791. int (*create_function16)(sqlite3*,const void*,int,int,void*,
  107792. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  107793. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  107794. void (*xFinal)(sqlite3_context*));
  107795. int (*create_module)(sqlite3*,const char*,const sqlite3_module*,void*);
  107796. int (*data_count)(sqlite3_stmt*pStmt);
  107797. sqlite3 * (*db_handle)(sqlite3_stmt*);
  107798. int (*declare_vtab)(sqlite3*,const char*);
  107799. int (*enable_shared_cache)(int);
  107800. int (*errcode)(sqlite3*db);
  107801. const char * (*errmsg)(sqlite3*);
  107802. const void * (*errmsg16)(sqlite3*);
  107803. int (*exec)(sqlite3*,const char*,sqlite3_callback,void*,char**);
  107804. int (*expired)(sqlite3_stmt*);
  107805. int (*finalize)(sqlite3_stmt*pStmt);
  107806. void (*free)(void*);
  107807. void (*free_table)(char**result);
  107808. int (*get_autocommit)(sqlite3*);
  107809. void * (*get_auxdata)(sqlite3_context*,int);
  107810. int (*get_table)(sqlite3*,const char*,char***,int*,int*,char**);
  107811. int (*global_recover)(void);
  107812. void (*interruptx)(sqlite3*);
  107813. sqlite_int64 (*last_insert_rowid)(sqlite3*);
  107814. const char * (*libversion)(void);
  107815. int (*libversion_number)(void);
  107816. void *(*malloc)(int);
  107817. char * (*mprintf)(const char*,...);
  107818. int (*open)(const char*,sqlite3**);
  107819. int (*open16)(const void*,sqlite3**);
  107820. int (*prepare)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
  107821. int (*prepare16)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
  107822. void * (*profile)(sqlite3*,void(*)(void*,const char*,sqlite_uint64),void*);
  107823. void (*progress_handler)(sqlite3*,int,int(*)(void*),void*);
  107824. void *(*realloc)(void*,int);
  107825. int (*reset)(sqlite3_stmt*pStmt);
  107826. void (*result_blob)(sqlite3_context*,const void*,int,void(*)(void*));
  107827. void (*result_double)(sqlite3_context*,double);
  107828. void (*result_error)(sqlite3_context*,const char*,int);
  107829. void (*result_error16)(sqlite3_context*,const void*,int);
  107830. void (*result_int)(sqlite3_context*,int);
  107831. void (*result_int64)(sqlite3_context*,sqlite_int64);
  107832. void (*result_null)(sqlite3_context*);
  107833. void (*result_text)(sqlite3_context*,const char*,int,void(*)(void*));
  107834. void (*result_text16)(sqlite3_context*,const void*,int,void(*)(void*));
  107835. void (*result_text16be)(sqlite3_context*,const void*,int,void(*)(void*));
  107836. void (*result_text16le)(sqlite3_context*,const void*,int,void(*)(void*));
  107837. void (*result_value)(sqlite3_context*,sqlite3_value*);
  107838. void * (*rollback_hook)(sqlite3*,void(*)(void*),void*);
  107839. int (*set_authorizer)(sqlite3*,int(*)(void*,int,const char*,const char*,
  107840. const char*,const char*),void*);
  107841. void (*set_auxdata)(sqlite3_context*,int,void*,void (*)(void*));
  107842. char * (*xsnprintf)(int,char*,const char*,...);
  107843. int (*step)(sqlite3_stmt*);
  107844. int (*table_column_metadata)(sqlite3*,const char*,const char*,const char*,
  107845. char const**,char const**,int*,int*,int*);
  107846. void (*thread_cleanup)(void);
  107847. int (*total_changes)(sqlite3*);
  107848. void * (*trace)(sqlite3*,void(*xTrace)(void*,const char*),void*);
  107849. int (*transfer_bindings)(sqlite3_stmt*,sqlite3_stmt*);
  107850. void * (*update_hook)(sqlite3*,void(*)(void*,int ,char const*,char const*,
  107851. sqlite_int64),void*);
  107852. void * (*user_data)(sqlite3_context*);
  107853. const void * (*value_blob)(sqlite3_value*);
  107854. int (*value_bytes)(sqlite3_value*);
  107855. int (*value_bytes16)(sqlite3_value*);
  107856. double (*value_double)(sqlite3_value*);
  107857. int (*value_int)(sqlite3_value*);
  107858. sqlite_int64 (*value_int64)(sqlite3_value*);
  107859. int (*value_numeric_type)(sqlite3_value*);
  107860. const unsigned char * (*value_text)(sqlite3_value*);
  107861. const void * (*value_text16)(sqlite3_value*);
  107862. const void * (*value_text16be)(sqlite3_value*);
  107863. const void * (*value_text16le)(sqlite3_value*);
  107864. int (*value_type)(sqlite3_value*);
  107865. char *(*vmprintf)(const char*,va_list);
  107866. /* Added ??? */
  107867. int (*overload_function)(sqlite3*, const char *zFuncName, int nArg);
  107868. /* Added by 3.3.13 */
  107869. int (*prepare_v2)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
  107870. int (*prepare16_v2)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
  107871. int (*clear_bindings)(sqlite3_stmt*);
  107872. /* Added by 3.4.1 */
  107873. int (*create_module_v2)(sqlite3*,const char*,const sqlite3_module*,void*,
  107874. void (*xDestroy)(void *));
  107875. /* Added by 3.5.0 */
  107876. int (*bind_zeroblob)(sqlite3_stmt*,int,int);
  107877. int (*blob_bytes)(sqlite3_blob*);
  107878. int (*blob_close)(sqlite3_blob*);
  107879. int (*blob_open)(sqlite3*,const char*,const char*,const char*,sqlite3_int64,
  107880. int,sqlite3_blob**);
  107881. int (*blob_read)(sqlite3_blob*,void*,int,int);
  107882. int (*blob_write)(sqlite3_blob*,const void*,int,int);
  107883. int (*create_collation_v2)(sqlite3*,const char*,int,void*,
  107884. int(*)(void*,int,const void*,int,const void*),
  107885. void(*)(void*));
  107886. int (*file_control)(sqlite3*,const char*,int,void*);
  107887. sqlite3_int64 (*memory_highwater)(int);
  107888. sqlite3_int64 (*memory_used)(void);
  107889. sqlite3_mutex *(*mutex_alloc)(int);
  107890. void (*mutex_enter)(sqlite3_mutex*);
  107891. void (*mutex_free)(sqlite3_mutex*);
  107892. void (*mutex_leave)(sqlite3_mutex*);
  107893. int (*mutex_try)(sqlite3_mutex*);
  107894. int (*open_v2)(const char*,sqlite3**,int,const char*);
  107895. int (*release_memory)(int);
  107896. void (*result_error_nomem)(sqlite3_context*);
  107897. void (*result_error_toobig)(sqlite3_context*);
  107898. int (*sleep)(int);
  107899. void (*soft_heap_limit)(int);
  107900. sqlite3_vfs *(*vfs_find)(const char*);
  107901. int (*vfs_register)(sqlite3_vfs*,int);
  107902. int (*vfs_unregister)(sqlite3_vfs*);
  107903. int (*xthreadsafe)(void);
  107904. void (*result_zeroblob)(sqlite3_context*,int);
  107905. void (*result_error_code)(sqlite3_context*,int);
  107906. int (*test_control)(int, ...);
  107907. void (*randomness)(int,void*);
  107908. sqlite3 *(*context_db_handle)(sqlite3_context*);
  107909. int (*extended_result_codes)(sqlite3*,int);
  107910. int (*limit)(sqlite3*,int,int);
  107911. sqlite3_stmt *(*next_stmt)(sqlite3*,sqlite3_stmt*);
  107912. const char *(*sql)(sqlite3_stmt*);
  107913. int (*status)(int,int*,int*,int);
  107914. int (*backup_finish)(sqlite3_backup*);
  107915. sqlite3_backup *(*backup_init)(sqlite3*,const char*,sqlite3*,const char*);
  107916. int (*backup_pagecount)(sqlite3_backup*);
  107917. int (*backup_remaining)(sqlite3_backup*);
  107918. int (*backup_step)(sqlite3_backup*,int);
  107919. const char *(*compileoption_get)(int);
  107920. int (*compileoption_used)(const char*);
  107921. int (*create_function_v2)(sqlite3*,const char*,int,int,void*,
  107922. void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
  107923. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  107924. void (*xFinal)(sqlite3_context*),
  107925. void(*xDestroy)(void*));
  107926. int (*db_config)(sqlite3*,int,...);
  107927. sqlite3_mutex *(*db_mutex)(sqlite3*);
  107928. int (*db_status)(sqlite3*,int,int*,int*,int);
  107929. int (*extended_errcode)(sqlite3*);
  107930. void (*log)(int,const char*,...);
  107931. sqlite3_int64 (*soft_heap_limit64)(sqlite3_int64);
  107932. const char *(*sourceid)(void);
  107933. int (*stmt_status)(sqlite3_stmt*,int,int);
  107934. int (*strnicmp)(const char*,const char*,int);
  107935. int (*unlock_notify)(sqlite3*,void(*)(void**,int),void*);
  107936. int (*wal_autocheckpoint)(sqlite3*,int);
  107937. int (*wal_checkpoint)(sqlite3*,const char*);
  107938. void *(*wal_hook)(sqlite3*,int(*)(void*,sqlite3*,const char*,int),void*);
  107939. int (*blob_reopen)(sqlite3_blob*,sqlite3_int64);
  107940. int (*vtab_config)(sqlite3*,int op,...);
  107941. int (*vtab_on_conflict)(sqlite3*);
  107942. /* Version 3.7.16 and later */
  107943. int (*close_v2)(sqlite3*);
  107944. const char *(*db_filename)(sqlite3*,const char*);
  107945. int (*db_readonly)(sqlite3*,const char*);
  107946. int (*db_release_memory)(sqlite3*);
  107947. const char *(*errstr)(int);
  107948. int (*stmt_busy)(sqlite3_stmt*);
  107949. int (*stmt_readonly)(sqlite3_stmt*);
  107950. int (*stricmp)(const char*,const char*);
  107951. int (*uri_boolean)(const char*,const char*,int);
  107952. sqlite3_int64 (*uri_int64)(const char*,const char*,sqlite3_int64);
  107953. const char *(*uri_parameter)(const char*,const char*);
  107954. char *(*xvsnprintf)(int,char*,const char*,va_list);
  107955. int (*wal_checkpoint_v2)(sqlite3*,const char*,int,int*,int*);
  107956. /* Version 3.8.7 and later */
  107957. int (*auto_extension)(void(*)(void));
  107958. int (*bind_blob64)(sqlite3_stmt*,int,const void*,sqlite3_uint64,
  107959. void(*)(void*));
  107960. int (*bind_text64)(sqlite3_stmt*,int,const char*,sqlite3_uint64,
  107961. void(*)(void*),unsigned char);
  107962. int (*cancel_auto_extension)(void(*)(void));
  107963. int (*load_extension)(sqlite3*,const char*,const char*,char**);
  107964. void *(*malloc64)(sqlite3_uint64);
  107965. sqlite3_uint64 (*msize)(void*);
  107966. void *(*realloc64)(void*,sqlite3_uint64);
  107967. void (*reset_auto_extension)(void);
  107968. void (*result_blob64)(sqlite3_context*,const void*,sqlite3_uint64,
  107969. void(*)(void*));
  107970. void (*result_text64)(sqlite3_context*,const char*,sqlite3_uint64,
  107971. void(*)(void*), unsigned char);
  107972. int (*strglob)(const char*,const char*);
  107973. /* Version 3.8.11 and later */
  107974. sqlite3_value *(*value_dup)(const sqlite3_value*);
  107975. void (*value_free)(sqlite3_value*);
  107976. int (*result_zeroblob64)(sqlite3_context*,sqlite3_uint64);
  107977. int (*bind_zeroblob64)(sqlite3_stmt*, int, sqlite3_uint64);
  107978. /* Version 3.9.0 and later */
  107979. unsigned int (*value_subtype)(sqlite3_value*);
  107980. void (*result_subtype)(sqlite3_context*,unsigned int);
  107981. /* Version 3.10.0 and later */
  107982. int (*status64)(int,sqlite3_int64*,sqlite3_int64*,int);
  107983. int (*strlike)(const char*,const char*,unsigned int);
  107984. int (*db_cacheflush)(sqlite3*);
  107985. /* Version 3.12.0 and later */
  107986. int (*system_errno)(sqlite3*);
  107987. /* Version 3.14.0 and later */
  107988. int (*trace_v2)(sqlite3*,unsigned,int(*)(unsigned,void*,void*,void*),void*);
  107989. char *(*expanded_sql)(sqlite3_stmt*);
  107990. /* Version 3.18.0 and later */
  107991. void (*set_last_insert_rowid)(sqlite3*,sqlite3_int64);
  107992. /* Version 3.20.0 and later */
  107993. int (*prepare_v3)(sqlite3*,const char*,int,unsigned int,
  107994. sqlite3_stmt**,const char**);
  107995. int (*prepare16_v3)(sqlite3*,const void*,int,unsigned int,
  107996. sqlite3_stmt**,const void**);
  107997. int (*bind_pointer)(sqlite3_stmt*,int,void*,const char*,void(*)(void*));
  107998. void (*result_pointer)(sqlite3_context*,void*,const char*,void(*)(void*));
  107999. void *(*value_pointer)(sqlite3_value*,const char*);
  108000. int (*vtab_nochange)(sqlite3_context*);
  108001. int (*value_nochange)(sqlite3_value*);
  108002. const char *(*vtab_collation)(sqlite3_index_info*,int);
  108003. };
  108004. /*
  108005. ** This is the function signature used for all extension entry points. It
  108006. ** is also defined in the file "loadext.c".
  108007. */
  108008. typedef int (*sqlite3_loadext_entry)(
  108009. sqlite3 *db, /* Handle to the database. */
  108010. char **pzErrMsg, /* Used to set error string on failure. */
  108011. const sqlite3_api_routines *pThunk /* Extension API function pointers. */
  108012. );
  108013. /*
  108014. ** The following macros redefine the API routines so that they are
  108015. ** redirected through the global sqlite3_api structure.
  108016. **
  108017. ** This header file is also used by the loadext.c source file
  108018. ** (part of the main SQLite library - not an extension) so that
  108019. ** it can get access to the sqlite3_api_routines structure
  108020. ** definition. But the main library does not want to redefine
  108021. ** the API. So the redefinition macros are only valid if the
  108022. ** SQLITE_CORE macros is undefined.
  108023. */
  108024. #if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  108025. #define sqlite3_aggregate_context sqlite3_api->aggregate_context
  108026. #ifndef SQLITE_OMIT_DEPRECATED
  108027. #define sqlite3_aggregate_count sqlite3_api->aggregate_count
  108028. #endif
  108029. #define sqlite3_bind_blob sqlite3_api->bind_blob
  108030. #define sqlite3_bind_double sqlite3_api->bind_double
  108031. #define sqlite3_bind_int sqlite3_api->bind_int
  108032. #define sqlite3_bind_int64 sqlite3_api->bind_int64
  108033. #define sqlite3_bind_null sqlite3_api->bind_null
  108034. #define sqlite3_bind_parameter_count sqlite3_api->bind_parameter_count
  108035. #define sqlite3_bind_parameter_index sqlite3_api->bind_parameter_index
  108036. #define sqlite3_bind_parameter_name sqlite3_api->bind_parameter_name
  108037. #define sqlite3_bind_text sqlite3_api->bind_text
  108038. #define sqlite3_bind_text16 sqlite3_api->bind_text16
  108039. #define sqlite3_bind_value sqlite3_api->bind_value
  108040. #define sqlite3_busy_handler sqlite3_api->busy_handler
  108041. #define sqlite3_busy_timeout sqlite3_api->busy_timeout
  108042. #define sqlite3_changes sqlite3_api->changes
  108043. #define sqlite3_close sqlite3_api->close
  108044. #define sqlite3_collation_needed sqlite3_api->collation_needed
  108045. #define sqlite3_collation_needed16 sqlite3_api->collation_needed16
  108046. #define sqlite3_column_blob sqlite3_api->column_blob
  108047. #define sqlite3_column_bytes sqlite3_api->column_bytes
  108048. #define sqlite3_column_bytes16 sqlite3_api->column_bytes16
  108049. #define sqlite3_column_count sqlite3_api->column_count
  108050. #define sqlite3_column_database_name sqlite3_api->column_database_name
  108051. #define sqlite3_column_database_name16 sqlite3_api->column_database_name16
  108052. #define sqlite3_column_decltype sqlite3_api->column_decltype
  108053. #define sqlite3_column_decltype16 sqlite3_api->column_decltype16
  108054. #define sqlite3_column_double sqlite3_api->column_double
  108055. #define sqlite3_column_int sqlite3_api->column_int
  108056. #define sqlite3_column_int64 sqlite3_api->column_int64
  108057. #define sqlite3_column_name sqlite3_api->column_name
  108058. #define sqlite3_column_name16 sqlite3_api->column_name16
  108059. #define sqlite3_column_origin_name sqlite3_api->column_origin_name
  108060. #define sqlite3_column_origin_name16 sqlite3_api->column_origin_name16
  108061. #define sqlite3_column_table_name sqlite3_api->column_table_name
  108062. #define sqlite3_column_table_name16 sqlite3_api->column_table_name16
  108063. #define sqlite3_column_text sqlite3_api->column_text
  108064. #define sqlite3_column_text16 sqlite3_api->column_text16
  108065. #define sqlite3_column_type sqlite3_api->column_type
  108066. #define sqlite3_column_value sqlite3_api->column_value
  108067. #define sqlite3_commit_hook sqlite3_api->commit_hook
  108068. #define sqlite3_complete sqlite3_api->complete
  108069. #define sqlite3_complete16 sqlite3_api->complete16
  108070. #define sqlite3_create_collation sqlite3_api->create_collation
  108071. #define sqlite3_create_collation16 sqlite3_api->create_collation16
  108072. #define sqlite3_create_function sqlite3_api->create_function
  108073. #define sqlite3_create_function16 sqlite3_api->create_function16
  108074. #define sqlite3_create_module sqlite3_api->create_module
  108075. #define sqlite3_create_module_v2 sqlite3_api->create_module_v2
  108076. #define sqlite3_data_count sqlite3_api->data_count
  108077. #define sqlite3_db_handle sqlite3_api->db_handle
  108078. #define sqlite3_declare_vtab sqlite3_api->declare_vtab
  108079. #define sqlite3_enable_shared_cache sqlite3_api->enable_shared_cache
  108080. #define sqlite3_errcode sqlite3_api->errcode
  108081. #define sqlite3_errmsg sqlite3_api->errmsg
  108082. #define sqlite3_errmsg16 sqlite3_api->errmsg16
  108083. #define sqlite3_exec sqlite3_api->exec
  108084. #ifndef SQLITE_OMIT_DEPRECATED
  108085. #define sqlite3_expired sqlite3_api->expired
  108086. #endif
  108087. #define sqlite3_finalize sqlite3_api->finalize
  108088. #define sqlite3_free sqlite3_api->free
  108089. #define sqlite3_free_table sqlite3_api->free_table
  108090. #define sqlite3_get_autocommit sqlite3_api->get_autocommit
  108091. #define sqlite3_get_auxdata sqlite3_api->get_auxdata
  108092. #define sqlite3_get_table sqlite3_api->get_table
  108093. #ifndef SQLITE_OMIT_DEPRECATED
  108094. #define sqlite3_global_recover sqlite3_api->global_recover
  108095. #endif
  108096. #define sqlite3_interrupt sqlite3_api->interruptx
  108097. #define sqlite3_last_insert_rowid sqlite3_api->last_insert_rowid
  108098. #define sqlite3_libversion sqlite3_api->libversion
  108099. #define sqlite3_libversion_number sqlite3_api->libversion_number
  108100. #define sqlite3_malloc sqlite3_api->malloc
  108101. #define sqlite3_mprintf sqlite3_api->mprintf
  108102. #define sqlite3_open sqlite3_api->open
  108103. #define sqlite3_open16 sqlite3_api->open16
  108104. #define sqlite3_prepare sqlite3_api->prepare
  108105. #define sqlite3_prepare16 sqlite3_api->prepare16
  108106. #define sqlite3_prepare_v2 sqlite3_api->prepare_v2
  108107. #define sqlite3_prepare16_v2 sqlite3_api->prepare16_v2
  108108. #define sqlite3_profile sqlite3_api->profile
  108109. #define sqlite3_progress_handler sqlite3_api->progress_handler
  108110. #define sqlite3_realloc sqlite3_api->realloc
  108111. #define sqlite3_reset sqlite3_api->reset
  108112. #define sqlite3_result_blob sqlite3_api->result_blob
  108113. #define sqlite3_result_double sqlite3_api->result_double
  108114. #define sqlite3_result_error sqlite3_api->result_error
  108115. #define sqlite3_result_error16 sqlite3_api->result_error16
  108116. #define sqlite3_result_int sqlite3_api->result_int
  108117. #define sqlite3_result_int64 sqlite3_api->result_int64
  108118. #define sqlite3_result_null sqlite3_api->result_null
  108119. #define sqlite3_result_text sqlite3_api->result_text
  108120. #define sqlite3_result_text16 sqlite3_api->result_text16
  108121. #define sqlite3_result_text16be sqlite3_api->result_text16be
  108122. #define sqlite3_result_text16le sqlite3_api->result_text16le
  108123. #define sqlite3_result_value sqlite3_api->result_value
  108124. #define sqlite3_rollback_hook sqlite3_api->rollback_hook
  108125. #define sqlite3_set_authorizer sqlite3_api->set_authorizer
  108126. #define sqlite3_set_auxdata sqlite3_api->set_auxdata
  108127. #define sqlite3_snprintf sqlite3_api->xsnprintf
  108128. #define sqlite3_step sqlite3_api->step
  108129. #define sqlite3_table_column_metadata sqlite3_api->table_column_metadata
  108130. #define sqlite3_thread_cleanup sqlite3_api->thread_cleanup
  108131. #define sqlite3_total_changes sqlite3_api->total_changes
  108132. #define sqlite3_trace sqlite3_api->trace
  108133. #ifndef SQLITE_OMIT_DEPRECATED
  108134. #define sqlite3_transfer_bindings sqlite3_api->transfer_bindings
  108135. #endif
  108136. #define sqlite3_update_hook sqlite3_api->update_hook
  108137. #define sqlite3_user_data sqlite3_api->user_data
  108138. #define sqlite3_value_blob sqlite3_api->value_blob
  108139. #define sqlite3_value_bytes sqlite3_api->value_bytes
  108140. #define sqlite3_value_bytes16 sqlite3_api->value_bytes16
  108141. #define sqlite3_value_double sqlite3_api->value_double
  108142. #define sqlite3_value_int sqlite3_api->value_int
  108143. #define sqlite3_value_int64 sqlite3_api->value_int64
  108144. #define sqlite3_value_numeric_type sqlite3_api->value_numeric_type
  108145. #define sqlite3_value_text sqlite3_api->value_text
  108146. #define sqlite3_value_text16 sqlite3_api->value_text16
  108147. #define sqlite3_value_text16be sqlite3_api->value_text16be
  108148. #define sqlite3_value_text16le sqlite3_api->value_text16le
  108149. #define sqlite3_value_type sqlite3_api->value_type
  108150. #define sqlite3_vmprintf sqlite3_api->vmprintf
  108151. #define sqlite3_vsnprintf sqlite3_api->xvsnprintf
  108152. #define sqlite3_overload_function sqlite3_api->overload_function
  108153. #define sqlite3_prepare_v2 sqlite3_api->prepare_v2
  108154. #define sqlite3_prepare16_v2 sqlite3_api->prepare16_v2
  108155. #define sqlite3_clear_bindings sqlite3_api->clear_bindings
  108156. #define sqlite3_bind_zeroblob sqlite3_api->bind_zeroblob
  108157. #define sqlite3_blob_bytes sqlite3_api->blob_bytes
  108158. #define sqlite3_blob_close sqlite3_api->blob_close
  108159. #define sqlite3_blob_open sqlite3_api->blob_open
  108160. #define sqlite3_blob_read sqlite3_api->blob_read
  108161. #define sqlite3_blob_write sqlite3_api->blob_write
  108162. #define sqlite3_create_collation_v2 sqlite3_api->create_collation_v2
  108163. #define sqlite3_file_control sqlite3_api->file_control
  108164. #define sqlite3_memory_highwater sqlite3_api->memory_highwater
  108165. #define sqlite3_memory_used sqlite3_api->memory_used
  108166. #define sqlite3_mutex_alloc sqlite3_api->mutex_alloc
  108167. #define sqlite3_mutex_enter sqlite3_api->mutex_enter
  108168. #define sqlite3_mutex_free sqlite3_api->mutex_free
  108169. #define sqlite3_mutex_leave sqlite3_api->mutex_leave
  108170. #define sqlite3_mutex_try sqlite3_api->mutex_try
  108171. #define sqlite3_open_v2 sqlite3_api->open_v2
  108172. #define sqlite3_release_memory sqlite3_api->release_memory
  108173. #define sqlite3_result_error_nomem sqlite3_api->result_error_nomem
  108174. #define sqlite3_result_error_toobig sqlite3_api->result_error_toobig
  108175. #define sqlite3_sleep sqlite3_api->sleep
  108176. #define sqlite3_soft_heap_limit sqlite3_api->soft_heap_limit
  108177. #define sqlite3_vfs_find sqlite3_api->vfs_find
  108178. #define sqlite3_vfs_register sqlite3_api->vfs_register
  108179. #define sqlite3_vfs_unregister sqlite3_api->vfs_unregister
  108180. #define sqlite3_threadsafe sqlite3_api->xthreadsafe
  108181. #define sqlite3_result_zeroblob sqlite3_api->result_zeroblob
  108182. #define sqlite3_result_error_code sqlite3_api->result_error_code
  108183. #define sqlite3_test_control sqlite3_api->test_control
  108184. #define sqlite3_randomness sqlite3_api->randomness
  108185. #define sqlite3_context_db_handle sqlite3_api->context_db_handle
  108186. #define sqlite3_extended_result_codes sqlite3_api->extended_result_codes
  108187. #define sqlite3_limit sqlite3_api->limit
  108188. #define sqlite3_next_stmt sqlite3_api->next_stmt
  108189. #define sqlite3_sql sqlite3_api->sql
  108190. #define sqlite3_status sqlite3_api->status
  108191. #define sqlite3_backup_finish sqlite3_api->backup_finish
  108192. #define sqlite3_backup_init sqlite3_api->backup_init
  108193. #define sqlite3_backup_pagecount sqlite3_api->backup_pagecount
  108194. #define sqlite3_backup_remaining sqlite3_api->backup_remaining
  108195. #define sqlite3_backup_step sqlite3_api->backup_step
  108196. #define sqlite3_compileoption_get sqlite3_api->compileoption_get
  108197. #define sqlite3_compileoption_used sqlite3_api->compileoption_used
  108198. #define sqlite3_create_function_v2 sqlite3_api->create_function_v2
  108199. #define sqlite3_db_config sqlite3_api->db_config
  108200. #define sqlite3_db_mutex sqlite3_api->db_mutex
  108201. #define sqlite3_db_status sqlite3_api->db_status
  108202. #define sqlite3_extended_errcode sqlite3_api->extended_errcode
  108203. #define sqlite3_log sqlite3_api->log
  108204. #define sqlite3_soft_heap_limit64 sqlite3_api->soft_heap_limit64
  108205. #define sqlite3_sourceid sqlite3_api->sourceid
  108206. #define sqlite3_stmt_status sqlite3_api->stmt_status
  108207. #define sqlite3_strnicmp sqlite3_api->strnicmp
  108208. #define sqlite3_unlock_notify sqlite3_api->unlock_notify
  108209. #define sqlite3_wal_autocheckpoint sqlite3_api->wal_autocheckpoint
  108210. #define sqlite3_wal_checkpoint sqlite3_api->wal_checkpoint
  108211. #define sqlite3_wal_hook sqlite3_api->wal_hook
  108212. #define sqlite3_blob_reopen sqlite3_api->blob_reopen
  108213. #define sqlite3_vtab_config sqlite3_api->vtab_config
  108214. #define sqlite3_vtab_on_conflict sqlite3_api->vtab_on_conflict
  108215. /* Version 3.7.16 and later */
  108216. #define sqlite3_close_v2 sqlite3_api->close_v2
  108217. #define sqlite3_db_filename sqlite3_api->db_filename
  108218. #define sqlite3_db_readonly sqlite3_api->db_readonly
  108219. #define sqlite3_db_release_memory sqlite3_api->db_release_memory
  108220. #define sqlite3_errstr sqlite3_api->errstr
  108221. #define sqlite3_stmt_busy sqlite3_api->stmt_busy
  108222. #define sqlite3_stmt_readonly sqlite3_api->stmt_readonly
  108223. #define sqlite3_stricmp sqlite3_api->stricmp
  108224. #define sqlite3_uri_boolean sqlite3_api->uri_boolean
  108225. #define sqlite3_uri_int64 sqlite3_api->uri_int64
  108226. #define sqlite3_uri_parameter sqlite3_api->uri_parameter
  108227. #define sqlite3_uri_vsnprintf sqlite3_api->xvsnprintf
  108228. #define sqlite3_wal_checkpoint_v2 sqlite3_api->wal_checkpoint_v2
  108229. /* Version 3.8.7 and later */
  108230. #define sqlite3_auto_extension sqlite3_api->auto_extension
  108231. #define sqlite3_bind_blob64 sqlite3_api->bind_blob64
  108232. #define sqlite3_bind_text64 sqlite3_api->bind_text64
  108233. #define sqlite3_cancel_auto_extension sqlite3_api->cancel_auto_extension
  108234. #define sqlite3_load_extension sqlite3_api->load_extension
  108235. #define sqlite3_malloc64 sqlite3_api->malloc64
  108236. #define sqlite3_msize sqlite3_api->msize
  108237. #define sqlite3_realloc64 sqlite3_api->realloc64
  108238. #define sqlite3_reset_auto_extension sqlite3_api->reset_auto_extension
  108239. #define sqlite3_result_blob64 sqlite3_api->result_blob64
  108240. #define sqlite3_result_text64 sqlite3_api->result_text64
  108241. #define sqlite3_strglob sqlite3_api->strglob
  108242. /* Version 3.8.11 and later */
  108243. #define sqlite3_value_dup sqlite3_api->value_dup
  108244. #define sqlite3_value_free sqlite3_api->value_free
  108245. #define sqlite3_result_zeroblob64 sqlite3_api->result_zeroblob64
  108246. #define sqlite3_bind_zeroblob64 sqlite3_api->bind_zeroblob64
  108247. /* Version 3.9.0 and later */
  108248. #define sqlite3_value_subtype sqlite3_api->value_subtype
  108249. #define sqlite3_result_subtype sqlite3_api->result_subtype
  108250. /* Version 3.10.0 and later */
  108251. #define sqlite3_status64 sqlite3_api->status64
  108252. #define sqlite3_strlike sqlite3_api->strlike
  108253. #define sqlite3_db_cacheflush sqlite3_api->db_cacheflush
  108254. /* Version 3.12.0 and later */
  108255. #define sqlite3_system_errno sqlite3_api->system_errno
  108256. /* Version 3.14.0 and later */
  108257. #define sqlite3_trace_v2 sqlite3_api->trace_v2
  108258. #define sqlite3_expanded_sql sqlite3_api->expanded_sql
  108259. /* Version 3.18.0 and later */
  108260. #define sqlite3_set_last_insert_rowid sqlite3_api->set_last_insert_rowid
  108261. /* Version 3.20.0 and later */
  108262. #define sqlite3_prepare_v3 sqlite3_api->prepare_v3
  108263. #define sqlite3_prepare16_v3 sqlite3_api->prepare16_v3
  108264. #define sqlite3_bind_pointer sqlite3_api->bind_pointer
  108265. #define sqlite3_result_pointer sqlite3_api->result_pointer
  108266. #define sqlite3_value_pointer sqlite3_api->value_pointer
  108267. /* Version 3.22.0 and later */
  108268. #define sqlite3_vtab_nochange sqlite3_api->vtab_nochange
  108269. #define sqlite3_value_nochange sqlite3_api->value_nochange
  108270. #define sqlite3_vtab_collation sqlite3_api->vtab_collation
  108271. #endif /* !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION) */
  108272. #if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
  108273. /* This case when the file really is being compiled as a loadable
  108274. ** extension */
  108275. # define SQLITE_EXTENSION_INIT1 const sqlite3_api_routines *sqlite3_api=0;
  108276. # define SQLITE_EXTENSION_INIT2(v) sqlite3_api=v;
  108277. # define SQLITE_EXTENSION_INIT3 \
  108278. extern const sqlite3_api_routines *sqlite3_api;
  108279. #else
  108280. /* This case when the file is being statically linked into the
  108281. ** application */
  108282. # define SQLITE_EXTENSION_INIT1 /*no-op*/
  108283. # define SQLITE_EXTENSION_INIT2(v) (void)v; /* unused parameter */
  108284. # define SQLITE_EXTENSION_INIT3 /*no-op*/
  108285. #endif
  108286. #endif /* SQLITE3EXT_H */
  108287. /************** End of sqlite3ext.h ******************************************/
  108288. /************** Continuing where we left off in loadext.c ********************/
  108289. /* #include "sqliteInt.h" */
  108290. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  108291. /*
  108292. ** Some API routines are omitted when various features are
  108293. ** excluded from a build of SQLite. Substitute a NULL pointer
  108294. ** for any missing APIs.
  108295. */
  108296. #ifndef SQLITE_ENABLE_COLUMN_METADATA
  108297. # define sqlite3_column_database_name 0
  108298. # define sqlite3_column_database_name16 0
  108299. # define sqlite3_column_table_name 0
  108300. # define sqlite3_column_table_name16 0
  108301. # define sqlite3_column_origin_name 0
  108302. # define sqlite3_column_origin_name16 0
  108303. #endif
  108304. #ifdef SQLITE_OMIT_AUTHORIZATION
  108305. # define sqlite3_set_authorizer 0
  108306. #endif
  108307. #ifdef SQLITE_OMIT_UTF16
  108308. # define sqlite3_bind_text16 0
  108309. # define sqlite3_collation_needed16 0
  108310. # define sqlite3_column_decltype16 0
  108311. # define sqlite3_column_name16 0
  108312. # define sqlite3_column_text16 0
  108313. # define sqlite3_complete16 0
  108314. # define sqlite3_create_collation16 0
  108315. # define sqlite3_create_function16 0
  108316. # define sqlite3_errmsg16 0
  108317. # define sqlite3_open16 0
  108318. # define sqlite3_prepare16 0
  108319. # define sqlite3_prepare16_v2 0
  108320. # define sqlite3_prepare16_v3 0
  108321. # define sqlite3_result_error16 0
  108322. # define sqlite3_result_text16 0
  108323. # define sqlite3_result_text16be 0
  108324. # define sqlite3_result_text16le 0
  108325. # define sqlite3_value_text16 0
  108326. # define sqlite3_value_text16be 0
  108327. # define sqlite3_value_text16le 0
  108328. # define sqlite3_column_database_name16 0
  108329. # define sqlite3_column_table_name16 0
  108330. # define sqlite3_column_origin_name16 0
  108331. #endif
  108332. #ifdef SQLITE_OMIT_COMPLETE
  108333. # define sqlite3_complete 0
  108334. # define sqlite3_complete16 0
  108335. #endif
  108336. #ifdef SQLITE_OMIT_DECLTYPE
  108337. # define sqlite3_column_decltype16 0
  108338. # define sqlite3_column_decltype 0
  108339. #endif
  108340. #ifdef SQLITE_OMIT_PROGRESS_CALLBACK
  108341. # define sqlite3_progress_handler 0
  108342. #endif
  108343. #ifdef SQLITE_OMIT_VIRTUALTABLE
  108344. # define sqlite3_create_module 0
  108345. # define sqlite3_create_module_v2 0
  108346. # define sqlite3_declare_vtab 0
  108347. # define sqlite3_vtab_config 0
  108348. # define sqlite3_vtab_on_conflict 0
  108349. #endif
  108350. #ifdef SQLITE_OMIT_SHARED_CACHE
  108351. # define sqlite3_enable_shared_cache 0
  108352. #endif
  108353. #if defined(SQLITE_OMIT_TRACE) || defined(SQLITE_OMIT_DEPRECATED)
  108354. # define sqlite3_profile 0
  108355. # define sqlite3_trace 0
  108356. #endif
  108357. #ifdef SQLITE_OMIT_GET_TABLE
  108358. # define sqlite3_free_table 0
  108359. # define sqlite3_get_table 0
  108360. #endif
  108361. #ifdef SQLITE_OMIT_INCRBLOB
  108362. #define sqlite3_bind_zeroblob 0
  108363. #define sqlite3_blob_bytes 0
  108364. #define sqlite3_blob_close 0
  108365. #define sqlite3_blob_open 0
  108366. #define sqlite3_blob_read 0
  108367. #define sqlite3_blob_write 0
  108368. #define sqlite3_blob_reopen 0
  108369. #endif
  108370. #if defined(SQLITE_OMIT_TRACE)
  108371. # define sqlite3_trace_v2 0
  108372. #endif
  108373. /*
  108374. ** The following structure contains pointers to all SQLite API routines.
  108375. ** A pointer to this structure is passed into extensions when they are
  108376. ** loaded so that the extension can make calls back into the SQLite
  108377. ** library.
  108378. **
  108379. ** When adding new APIs, add them to the bottom of this structure
  108380. ** in order to preserve backwards compatibility.
  108381. **
  108382. ** Extensions that use newer APIs should first call the
  108383. ** sqlite3_libversion_number() to make sure that the API they
  108384. ** intend to use is supported by the library. Extensions should
  108385. ** also check to make sure that the pointer to the function is
  108386. ** not NULL before calling it.
  108387. */
  108388. static const sqlite3_api_routines sqlite3Apis = {
  108389. sqlite3_aggregate_context,
  108390. #ifndef SQLITE_OMIT_DEPRECATED
  108391. sqlite3_aggregate_count,
  108392. #else
  108393. 0,
  108394. #endif
  108395. sqlite3_bind_blob,
  108396. sqlite3_bind_double,
  108397. sqlite3_bind_int,
  108398. sqlite3_bind_int64,
  108399. sqlite3_bind_null,
  108400. sqlite3_bind_parameter_count,
  108401. sqlite3_bind_parameter_index,
  108402. sqlite3_bind_parameter_name,
  108403. sqlite3_bind_text,
  108404. sqlite3_bind_text16,
  108405. sqlite3_bind_value,
  108406. sqlite3_busy_handler,
  108407. sqlite3_busy_timeout,
  108408. sqlite3_changes,
  108409. sqlite3_close,
  108410. sqlite3_collation_needed,
  108411. sqlite3_collation_needed16,
  108412. sqlite3_column_blob,
  108413. sqlite3_column_bytes,
  108414. sqlite3_column_bytes16,
  108415. sqlite3_column_count,
  108416. sqlite3_column_database_name,
  108417. sqlite3_column_database_name16,
  108418. sqlite3_column_decltype,
  108419. sqlite3_column_decltype16,
  108420. sqlite3_column_double,
  108421. sqlite3_column_int,
  108422. sqlite3_column_int64,
  108423. sqlite3_column_name,
  108424. sqlite3_column_name16,
  108425. sqlite3_column_origin_name,
  108426. sqlite3_column_origin_name16,
  108427. sqlite3_column_table_name,
  108428. sqlite3_column_table_name16,
  108429. sqlite3_column_text,
  108430. sqlite3_column_text16,
  108431. sqlite3_column_type,
  108432. sqlite3_column_value,
  108433. sqlite3_commit_hook,
  108434. sqlite3_complete,
  108435. sqlite3_complete16,
  108436. sqlite3_create_collation,
  108437. sqlite3_create_collation16,
  108438. sqlite3_create_function,
  108439. sqlite3_create_function16,
  108440. sqlite3_create_module,
  108441. sqlite3_data_count,
  108442. sqlite3_db_handle,
  108443. sqlite3_declare_vtab,
  108444. sqlite3_enable_shared_cache,
  108445. sqlite3_errcode,
  108446. sqlite3_errmsg,
  108447. sqlite3_errmsg16,
  108448. sqlite3_exec,
  108449. #ifndef SQLITE_OMIT_DEPRECATED
  108450. sqlite3_expired,
  108451. #else
  108452. 0,
  108453. #endif
  108454. sqlite3_finalize,
  108455. sqlite3_free,
  108456. sqlite3_free_table,
  108457. sqlite3_get_autocommit,
  108458. sqlite3_get_auxdata,
  108459. sqlite3_get_table,
  108460. 0, /* Was sqlite3_global_recover(), but that function is deprecated */
  108461. sqlite3_interrupt,
  108462. sqlite3_last_insert_rowid,
  108463. sqlite3_libversion,
  108464. sqlite3_libversion_number,
  108465. sqlite3_malloc,
  108466. sqlite3_mprintf,
  108467. sqlite3_open,
  108468. sqlite3_open16,
  108469. sqlite3_prepare,
  108470. sqlite3_prepare16,
  108471. sqlite3_profile,
  108472. sqlite3_progress_handler,
  108473. sqlite3_realloc,
  108474. sqlite3_reset,
  108475. sqlite3_result_blob,
  108476. sqlite3_result_double,
  108477. sqlite3_result_error,
  108478. sqlite3_result_error16,
  108479. sqlite3_result_int,
  108480. sqlite3_result_int64,
  108481. sqlite3_result_null,
  108482. sqlite3_result_text,
  108483. sqlite3_result_text16,
  108484. sqlite3_result_text16be,
  108485. sqlite3_result_text16le,
  108486. sqlite3_result_value,
  108487. sqlite3_rollback_hook,
  108488. sqlite3_set_authorizer,
  108489. sqlite3_set_auxdata,
  108490. sqlite3_snprintf,
  108491. sqlite3_step,
  108492. sqlite3_table_column_metadata,
  108493. #ifndef SQLITE_OMIT_DEPRECATED
  108494. sqlite3_thread_cleanup,
  108495. #else
  108496. 0,
  108497. #endif
  108498. sqlite3_total_changes,
  108499. sqlite3_trace,
  108500. #ifndef SQLITE_OMIT_DEPRECATED
  108501. sqlite3_transfer_bindings,
  108502. #else
  108503. 0,
  108504. #endif
  108505. sqlite3_update_hook,
  108506. sqlite3_user_data,
  108507. sqlite3_value_blob,
  108508. sqlite3_value_bytes,
  108509. sqlite3_value_bytes16,
  108510. sqlite3_value_double,
  108511. sqlite3_value_int,
  108512. sqlite3_value_int64,
  108513. sqlite3_value_numeric_type,
  108514. sqlite3_value_text,
  108515. sqlite3_value_text16,
  108516. sqlite3_value_text16be,
  108517. sqlite3_value_text16le,
  108518. sqlite3_value_type,
  108519. sqlite3_vmprintf,
  108520. /*
  108521. ** The original API set ends here. All extensions can call any
  108522. ** of the APIs above provided that the pointer is not NULL. But
  108523. ** before calling APIs that follow, extension should check the
  108524. ** sqlite3_libversion_number() to make sure they are dealing with
  108525. ** a library that is new enough to support that API.
  108526. *************************************************************************
  108527. */
  108528. sqlite3_overload_function,
  108529. /*
  108530. ** Added after 3.3.13
  108531. */
  108532. sqlite3_prepare_v2,
  108533. sqlite3_prepare16_v2,
  108534. sqlite3_clear_bindings,
  108535. /*
  108536. ** Added for 3.4.1
  108537. */
  108538. sqlite3_create_module_v2,
  108539. /*
  108540. ** Added for 3.5.0
  108541. */
  108542. sqlite3_bind_zeroblob,
  108543. sqlite3_blob_bytes,
  108544. sqlite3_blob_close,
  108545. sqlite3_blob_open,
  108546. sqlite3_blob_read,
  108547. sqlite3_blob_write,
  108548. sqlite3_create_collation_v2,
  108549. sqlite3_file_control,
  108550. sqlite3_memory_highwater,
  108551. sqlite3_memory_used,
  108552. #ifdef SQLITE_MUTEX_OMIT
  108553. 0,
  108554. 0,
  108555. 0,
  108556. 0,
  108557. 0,
  108558. #else
  108559. sqlite3_mutex_alloc,
  108560. sqlite3_mutex_enter,
  108561. sqlite3_mutex_free,
  108562. sqlite3_mutex_leave,
  108563. sqlite3_mutex_try,
  108564. #endif
  108565. sqlite3_open_v2,
  108566. sqlite3_release_memory,
  108567. sqlite3_result_error_nomem,
  108568. sqlite3_result_error_toobig,
  108569. sqlite3_sleep,
  108570. sqlite3_soft_heap_limit,
  108571. sqlite3_vfs_find,
  108572. sqlite3_vfs_register,
  108573. sqlite3_vfs_unregister,
  108574. /*
  108575. ** Added for 3.5.8
  108576. */
  108577. sqlite3_threadsafe,
  108578. sqlite3_result_zeroblob,
  108579. sqlite3_result_error_code,
  108580. sqlite3_test_control,
  108581. sqlite3_randomness,
  108582. sqlite3_context_db_handle,
  108583. /*
  108584. ** Added for 3.6.0
  108585. */
  108586. sqlite3_extended_result_codes,
  108587. sqlite3_limit,
  108588. sqlite3_next_stmt,
  108589. sqlite3_sql,
  108590. sqlite3_status,
  108591. /*
  108592. ** Added for 3.7.4
  108593. */
  108594. sqlite3_backup_finish,
  108595. sqlite3_backup_init,
  108596. sqlite3_backup_pagecount,
  108597. sqlite3_backup_remaining,
  108598. sqlite3_backup_step,
  108599. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  108600. sqlite3_compileoption_get,
  108601. sqlite3_compileoption_used,
  108602. #else
  108603. 0,
  108604. 0,
  108605. #endif
  108606. sqlite3_create_function_v2,
  108607. sqlite3_db_config,
  108608. sqlite3_db_mutex,
  108609. sqlite3_db_status,
  108610. sqlite3_extended_errcode,
  108611. sqlite3_log,
  108612. sqlite3_soft_heap_limit64,
  108613. sqlite3_sourceid,
  108614. sqlite3_stmt_status,
  108615. sqlite3_strnicmp,
  108616. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  108617. sqlite3_unlock_notify,
  108618. #else
  108619. 0,
  108620. #endif
  108621. #ifndef SQLITE_OMIT_WAL
  108622. sqlite3_wal_autocheckpoint,
  108623. sqlite3_wal_checkpoint,
  108624. sqlite3_wal_hook,
  108625. #else
  108626. 0,
  108627. 0,
  108628. 0,
  108629. #endif
  108630. sqlite3_blob_reopen,
  108631. sqlite3_vtab_config,
  108632. sqlite3_vtab_on_conflict,
  108633. sqlite3_close_v2,
  108634. sqlite3_db_filename,
  108635. sqlite3_db_readonly,
  108636. sqlite3_db_release_memory,
  108637. sqlite3_errstr,
  108638. sqlite3_stmt_busy,
  108639. sqlite3_stmt_readonly,
  108640. sqlite3_stricmp,
  108641. sqlite3_uri_boolean,
  108642. sqlite3_uri_int64,
  108643. sqlite3_uri_parameter,
  108644. sqlite3_vsnprintf,
  108645. sqlite3_wal_checkpoint_v2,
  108646. /* Version 3.8.7 and later */
  108647. sqlite3_auto_extension,
  108648. sqlite3_bind_blob64,
  108649. sqlite3_bind_text64,
  108650. sqlite3_cancel_auto_extension,
  108651. sqlite3_load_extension,
  108652. sqlite3_malloc64,
  108653. sqlite3_msize,
  108654. sqlite3_realloc64,
  108655. sqlite3_reset_auto_extension,
  108656. sqlite3_result_blob64,
  108657. sqlite3_result_text64,
  108658. sqlite3_strglob,
  108659. /* Version 3.8.11 and later */
  108660. (sqlite3_value*(*)(const sqlite3_value*))sqlite3_value_dup,
  108661. sqlite3_value_free,
  108662. sqlite3_result_zeroblob64,
  108663. sqlite3_bind_zeroblob64,
  108664. /* Version 3.9.0 and later */
  108665. sqlite3_value_subtype,
  108666. sqlite3_result_subtype,
  108667. /* Version 3.10.0 and later */
  108668. sqlite3_status64,
  108669. sqlite3_strlike,
  108670. sqlite3_db_cacheflush,
  108671. /* Version 3.12.0 and later */
  108672. sqlite3_system_errno,
  108673. /* Version 3.14.0 and later */
  108674. sqlite3_trace_v2,
  108675. sqlite3_expanded_sql,
  108676. /* Version 3.18.0 and later */
  108677. sqlite3_set_last_insert_rowid,
  108678. /* Version 3.20.0 and later */
  108679. sqlite3_prepare_v3,
  108680. sqlite3_prepare16_v3,
  108681. sqlite3_bind_pointer,
  108682. sqlite3_result_pointer,
  108683. sqlite3_value_pointer,
  108684. /* Version 3.22.0 and later */
  108685. sqlite3_vtab_nochange,
  108686. sqlite3_value_nochange,
  108687. sqlite3_vtab_collation
  108688. };
  108689. /*
  108690. ** Attempt to load an SQLite extension library contained in the file
  108691. ** zFile. The entry point is zProc. zProc may be 0 in which case a
  108692. ** default entry point name (sqlite3_extension_init) is used. Use
  108693. ** of the default name is recommended.
  108694. **
  108695. ** Return SQLITE_OK on success and SQLITE_ERROR if something goes wrong.
  108696. **
  108697. ** If an error occurs and pzErrMsg is not 0, then fill *pzErrMsg with
  108698. ** error message text. The calling function should free this memory
  108699. ** by calling sqlite3DbFree(db, ).
  108700. */
  108701. static int sqlite3LoadExtension(
  108702. sqlite3 *db, /* Load the extension into this database connection */
  108703. const char *zFile, /* Name of the shared library containing extension */
  108704. const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
  108705. char **pzErrMsg /* Put error message here if not 0 */
  108706. ){
  108707. sqlite3_vfs *pVfs = db->pVfs;
  108708. void *handle;
  108709. sqlite3_loadext_entry xInit;
  108710. char *zErrmsg = 0;
  108711. const char *zEntry;
  108712. char *zAltEntry = 0;
  108713. void **aHandle;
  108714. u64 nMsg = 300 + sqlite3Strlen30(zFile);
  108715. int ii;
  108716. int rc;
  108717. /* Shared library endings to try if zFile cannot be loaded as written */
  108718. static const char *azEndings[] = {
  108719. #if SQLITE_OS_WIN
  108720. "dll"
  108721. #elif defined(__APPLE__)
  108722. "dylib"
  108723. #else
  108724. "so"
  108725. #endif
  108726. };
  108727. if( pzErrMsg ) *pzErrMsg = 0;
  108728. /* Ticket #1863. To avoid a creating security problems for older
  108729. ** applications that relink against newer versions of SQLite, the
  108730. ** ability to run load_extension is turned off by default. One
  108731. ** must call either sqlite3_enable_load_extension(db) or
  108732. ** sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, 1, 0)
  108733. ** to turn on extension loading.
  108734. */
  108735. if( (db->flags & SQLITE_LoadExtension)==0 ){
  108736. if( pzErrMsg ){
  108737. *pzErrMsg = sqlite3_mprintf("not authorized");
  108738. }
  108739. return SQLITE_ERROR;
  108740. }
  108741. zEntry = zProc ? zProc : "sqlite3_extension_init";
  108742. handle = sqlite3OsDlOpen(pVfs, zFile);
  108743. #if SQLITE_OS_UNIX || SQLITE_OS_WIN
  108744. for(ii=0; ii<ArraySize(azEndings) && handle==0; ii++){
  108745. char *zAltFile = sqlite3_mprintf("%s.%s", zFile, azEndings[ii]);
  108746. int bExists = 0;
  108747. if( zAltFile==0 ) return SQLITE_NOMEM_BKPT;
  108748. sqlite3OsAccess(pVfs, zAltFile, SQLITE_ACCESS_EXISTS, &bExists);
  108749. if( bExists ) handle = sqlite3OsDlOpen(pVfs, zAltFile);
  108750. sqlite3_free(zAltFile);
  108751. }
  108752. #endif
  108753. if( handle==0 ){
  108754. if( pzErrMsg ){
  108755. *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
  108756. if( zErrmsg ){
  108757. sqlite3_snprintf(nMsg, zErrmsg,
  108758. "unable to open shared library [%s]", zFile);
  108759. sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
  108760. }
  108761. }
  108762. return SQLITE_ERROR;
  108763. }
  108764. xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
  108765. /* If no entry point was specified and the default legacy
  108766. ** entry point name "sqlite3_extension_init" was not found, then
  108767. ** construct an entry point name "sqlite3_X_init" where the X is
  108768. ** replaced by the lowercase value of every ASCII alphabetic
  108769. ** character in the filename after the last "/" upto the first ".",
  108770. ** and eliding the first three characters if they are "lib".
  108771. ** Examples:
  108772. **
  108773. ** /usr/local/lib/libExample5.4.3.so ==> sqlite3_example_init
  108774. ** C:/lib/mathfuncs.dll ==> sqlite3_mathfuncs_init
  108775. */
  108776. if( xInit==0 && zProc==0 ){
  108777. int iFile, iEntry, c;
  108778. int ncFile = sqlite3Strlen30(zFile);
  108779. zAltEntry = sqlite3_malloc64(ncFile+30);
  108780. if( zAltEntry==0 ){
  108781. sqlite3OsDlClose(pVfs, handle);
  108782. return SQLITE_NOMEM_BKPT;
  108783. }
  108784. memcpy(zAltEntry, "sqlite3_", 8);
  108785. for(iFile=ncFile-1; iFile>=0 && zFile[iFile]!='/'; iFile--){}
  108786. iFile++;
  108787. if( sqlite3_strnicmp(zFile+iFile, "lib", 3)==0 ) iFile += 3;
  108788. for(iEntry=8; (c = zFile[iFile])!=0 && c!='.'; iFile++){
  108789. if( sqlite3Isalpha(c) ){
  108790. zAltEntry[iEntry++] = (char)sqlite3UpperToLower[(unsigned)c];
  108791. }
  108792. }
  108793. memcpy(zAltEntry+iEntry, "_init", 6);
  108794. zEntry = zAltEntry;
  108795. xInit = (sqlite3_loadext_entry)sqlite3OsDlSym(pVfs, handle, zEntry);
  108796. }
  108797. if( xInit==0 ){
  108798. if( pzErrMsg ){
  108799. nMsg += sqlite3Strlen30(zEntry);
  108800. *pzErrMsg = zErrmsg = sqlite3_malloc64(nMsg);
  108801. if( zErrmsg ){
  108802. sqlite3_snprintf(nMsg, zErrmsg,
  108803. "no entry point [%s] in shared library [%s]", zEntry, zFile);
  108804. sqlite3OsDlError(pVfs, nMsg-1, zErrmsg);
  108805. }
  108806. }
  108807. sqlite3OsDlClose(pVfs, handle);
  108808. sqlite3_free(zAltEntry);
  108809. return SQLITE_ERROR;
  108810. }
  108811. sqlite3_free(zAltEntry);
  108812. rc = xInit(db, &zErrmsg, &sqlite3Apis);
  108813. if( rc ){
  108814. if( rc==SQLITE_OK_LOAD_PERMANENTLY ) return SQLITE_OK;
  108815. if( pzErrMsg ){
  108816. *pzErrMsg = sqlite3_mprintf("error during initialization: %s", zErrmsg);
  108817. }
  108818. sqlite3_free(zErrmsg);
  108819. sqlite3OsDlClose(pVfs, handle);
  108820. return SQLITE_ERROR;
  108821. }
  108822. /* Append the new shared library handle to the db->aExtension array. */
  108823. aHandle = sqlite3DbMallocZero(db, sizeof(handle)*(db->nExtension+1));
  108824. if( aHandle==0 ){
  108825. return SQLITE_NOMEM_BKPT;
  108826. }
  108827. if( db->nExtension>0 ){
  108828. memcpy(aHandle, db->aExtension, sizeof(handle)*db->nExtension);
  108829. }
  108830. sqlite3DbFree(db, db->aExtension);
  108831. db->aExtension = aHandle;
  108832. db->aExtension[db->nExtension++] = handle;
  108833. return SQLITE_OK;
  108834. }
  108835. SQLITE_API int sqlite3_load_extension(
  108836. sqlite3 *db, /* Load the extension into this database connection */
  108837. const char *zFile, /* Name of the shared library containing extension */
  108838. const char *zProc, /* Entry point. Use "sqlite3_extension_init" if 0 */
  108839. char **pzErrMsg /* Put error message here if not 0 */
  108840. ){
  108841. int rc;
  108842. sqlite3_mutex_enter(db->mutex);
  108843. rc = sqlite3LoadExtension(db, zFile, zProc, pzErrMsg);
  108844. rc = sqlite3ApiExit(db, rc);
  108845. sqlite3_mutex_leave(db->mutex);
  108846. return rc;
  108847. }
  108848. /*
  108849. ** Call this routine when the database connection is closing in order
  108850. ** to clean up loaded extensions
  108851. */
  108852. SQLITE_PRIVATE void sqlite3CloseExtensions(sqlite3 *db){
  108853. int i;
  108854. assert( sqlite3_mutex_held(db->mutex) );
  108855. for(i=0; i<db->nExtension; i++){
  108856. sqlite3OsDlClose(db->pVfs, db->aExtension[i]);
  108857. }
  108858. sqlite3DbFree(db, db->aExtension);
  108859. }
  108860. /*
  108861. ** Enable or disable extension loading. Extension loading is disabled by
  108862. ** default so as not to open security holes in older applications.
  108863. */
  108864. SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff){
  108865. sqlite3_mutex_enter(db->mutex);
  108866. if( onoff ){
  108867. db->flags |= SQLITE_LoadExtension|SQLITE_LoadExtFunc;
  108868. }else{
  108869. db->flags &= ~(SQLITE_LoadExtension|SQLITE_LoadExtFunc);
  108870. }
  108871. sqlite3_mutex_leave(db->mutex);
  108872. return SQLITE_OK;
  108873. }
  108874. #endif /* !defined(SQLITE_OMIT_LOAD_EXTENSION) */
  108875. /*
  108876. ** The following object holds the list of automatically loaded
  108877. ** extensions.
  108878. **
  108879. ** This list is shared across threads. The SQLITE_MUTEX_STATIC_MASTER
  108880. ** mutex must be held while accessing this list.
  108881. */
  108882. typedef struct sqlite3AutoExtList sqlite3AutoExtList;
  108883. static SQLITE_WSD struct sqlite3AutoExtList {
  108884. u32 nExt; /* Number of entries in aExt[] */
  108885. void (**aExt)(void); /* Pointers to the extension init functions */
  108886. } sqlite3Autoext = { 0, 0 };
  108887. /* The "wsdAutoext" macro will resolve to the autoextension
  108888. ** state vector. If writable static data is unsupported on the target,
  108889. ** we have to locate the state vector at run-time. In the more common
  108890. ** case where writable static data is supported, wsdStat can refer directly
  108891. ** to the "sqlite3Autoext" state vector declared above.
  108892. */
  108893. #ifdef SQLITE_OMIT_WSD
  108894. # define wsdAutoextInit \
  108895. sqlite3AutoExtList *x = &GLOBAL(sqlite3AutoExtList,sqlite3Autoext)
  108896. # define wsdAutoext x[0]
  108897. #else
  108898. # define wsdAutoextInit
  108899. # define wsdAutoext sqlite3Autoext
  108900. #endif
  108901. /*
  108902. ** Register a statically linked extension that is automatically
  108903. ** loaded by every new database connection.
  108904. */
  108905. SQLITE_API int sqlite3_auto_extension(
  108906. void (*xInit)(void)
  108907. ){
  108908. int rc = SQLITE_OK;
  108909. #ifndef SQLITE_OMIT_AUTOINIT
  108910. rc = sqlite3_initialize();
  108911. if( rc ){
  108912. return rc;
  108913. }else
  108914. #endif
  108915. {
  108916. u32 i;
  108917. #if SQLITE_THREADSAFE
  108918. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  108919. #endif
  108920. wsdAutoextInit;
  108921. sqlite3_mutex_enter(mutex);
  108922. for(i=0; i<wsdAutoext.nExt; i++){
  108923. if( wsdAutoext.aExt[i]==xInit ) break;
  108924. }
  108925. if( i==wsdAutoext.nExt ){
  108926. u64 nByte = (wsdAutoext.nExt+1)*sizeof(wsdAutoext.aExt[0]);
  108927. void (**aNew)(void);
  108928. aNew = sqlite3_realloc64(wsdAutoext.aExt, nByte);
  108929. if( aNew==0 ){
  108930. rc = SQLITE_NOMEM_BKPT;
  108931. }else{
  108932. wsdAutoext.aExt = aNew;
  108933. wsdAutoext.aExt[wsdAutoext.nExt] = xInit;
  108934. wsdAutoext.nExt++;
  108935. }
  108936. }
  108937. sqlite3_mutex_leave(mutex);
  108938. assert( (rc&0xff)==rc );
  108939. return rc;
  108940. }
  108941. }
  108942. /*
  108943. ** Cancel a prior call to sqlite3_auto_extension. Remove xInit from the
  108944. ** set of routines that is invoked for each new database connection, if it
  108945. ** is currently on the list. If xInit is not on the list, then this
  108946. ** routine is a no-op.
  108947. **
  108948. ** Return 1 if xInit was found on the list and removed. Return 0 if xInit
  108949. ** was not on the list.
  108950. */
  108951. SQLITE_API int sqlite3_cancel_auto_extension(
  108952. void (*xInit)(void)
  108953. ){
  108954. #if SQLITE_THREADSAFE
  108955. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  108956. #endif
  108957. int i;
  108958. int n = 0;
  108959. wsdAutoextInit;
  108960. sqlite3_mutex_enter(mutex);
  108961. for(i=(int)wsdAutoext.nExt-1; i>=0; i--){
  108962. if( wsdAutoext.aExt[i]==xInit ){
  108963. wsdAutoext.nExt--;
  108964. wsdAutoext.aExt[i] = wsdAutoext.aExt[wsdAutoext.nExt];
  108965. n++;
  108966. break;
  108967. }
  108968. }
  108969. sqlite3_mutex_leave(mutex);
  108970. return n;
  108971. }
  108972. /*
  108973. ** Reset the automatic extension loading mechanism.
  108974. */
  108975. SQLITE_API void sqlite3_reset_auto_extension(void){
  108976. #ifndef SQLITE_OMIT_AUTOINIT
  108977. if( sqlite3_initialize()==SQLITE_OK )
  108978. #endif
  108979. {
  108980. #if SQLITE_THREADSAFE
  108981. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  108982. #endif
  108983. wsdAutoextInit;
  108984. sqlite3_mutex_enter(mutex);
  108985. sqlite3_free(wsdAutoext.aExt);
  108986. wsdAutoext.aExt = 0;
  108987. wsdAutoext.nExt = 0;
  108988. sqlite3_mutex_leave(mutex);
  108989. }
  108990. }
  108991. /*
  108992. ** Load all automatic extensions.
  108993. **
  108994. ** If anything goes wrong, set an error in the database connection.
  108995. */
  108996. SQLITE_PRIVATE void sqlite3AutoLoadExtensions(sqlite3 *db){
  108997. u32 i;
  108998. int go = 1;
  108999. int rc;
  109000. sqlite3_loadext_entry xInit;
  109001. wsdAutoextInit;
  109002. if( wsdAutoext.nExt==0 ){
  109003. /* Common case: early out without every having to acquire a mutex */
  109004. return;
  109005. }
  109006. for(i=0; go; i++){
  109007. char *zErrmsg;
  109008. #if SQLITE_THREADSAFE
  109009. sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
  109010. #endif
  109011. #ifdef SQLITE_OMIT_LOAD_EXTENSION
  109012. const sqlite3_api_routines *pThunk = 0;
  109013. #else
  109014. const sqlite3_api_routines *pThunk = &sqlite3Apis;
  109015. #endif
  109016. sqlite3_mutex_enter(mutex);
  109017. if( i>=wsdAutoext.nExt ){
  109018. xInit = 0;
  109019. go = 0;
  109020. }else{
  109021. xInit = (sqlite3_loadext_entry)wsdAutoext.aExt[i];
  109022. }
  109023. sqlite3_mutex_leave(mutex);
  109024. zErrmsg = 0;
  109025. if( xInit && (rc = xInit(db, &zErrmsg, pThunk))!=0 ){
  109026. sqlite3ErrorWithMsg(db, rc,
  109027. "automatic extension loading failed: %s", zErrmsg);
  109028. go = 0;
  109029. }
  109030. sqlite3_free(zErrmsg);
  109031. }
  109032. }
  109033. /************** End of loadext.c *********************************************/
  109034. /************** Begin file pragma.c ******************************************/
  109035. /*
  109036. ** 2003 April 6
  109037. **
  109038. ** The author disclaims copyright to this source code. In place of
  109039. ** a legal notice, here is a blessing:
  109040. **
  109041. ** May you do good and not evil.
  109042. ** May you find forgiveness for yourself and forgive others.
  109043. ** May you share freely, never taking more than you give.
  109044. **
  109045. *************************************************************************
  109046. ** This file contains code used to implement the PRAGMA command.
  109047. */
  109048. /* #include "sqliteInt.h" */
  109049. #if !defined(SQLITE_ENABLE_LOCKING_STYLE)
  109050. # if defined(__APPLE__)
  109051. # define SQLITE_ENABLE_LOCKING_STYLE 1
  109052. # else
  109053. # define SQLITE_ENABLE_LOCKING_STYLE 0
  109054. # endif
  109055. #endif
  109056. /***************************************************************************
  109057. ** The "pragma.h" include file is an automatically generated file that
  109058. ** that includes the PragType_XXXX macro definitions and the aPragmaName[]
  109059. ** object. This ensures that the aPragmaName[] table is arranged in
  109060. ** lexicographical order to facility a binary search of the pragma name.
  109061. ** Do not edit pragma.h directly. Edit and rerun the script in at
  109062. ** ../tool/mkpragmatab.tcl. */
  109063. /************** Include pragma.h in the middle of pragma.c *******************/
  109064. /************** Begin file pragma.h ******************************************/
  109065. /* DO NOT EDIT!
  109066. ** This file is automatically generated by the script at
  109067. ** ../tool/mkpragmatab.tcl. To update the set of pragmas, edit
  109068. ** that script and rerun it.
  109069. */
  109070. /* The various pragma types */
  109071. #define PragTyp_HEADER_VALUE 0
  109072. #define PragTyp_AUTO_VACUUM 1
  109073. #define PragTyp_FLAG 2
  109074. #define PragTyp_BUSY_TIMEOUT 3
  109075. #define PragTyp_CACHE_SIZE 4
  109076. #define PragTyp_CACHE_SPILL 5
  109077. #define PragTyp_CASE_SENSITIVE_LIKE 6
  109078. #define PragTyp_COLLATION_LIST 7
  109079. #define PragTyp_COMPILE_OPTIONS 8
  109080. #define PragTyp_DATA_STORE_DIRECTORY 9
  109081. #define PragTyp_DATABASE_LIST 10
  109082. #define PragTyp_DEFAULT_CACHE_SIZE 11
  109083. #define PragTyp_ENCODING 12
  109084. #define PragTyp_FOREIGN_KEY_CHECK 13
  109085. #define PragTyp_FOREIGN_KEY_LIST 14
  109086. #define PragTyp_FUNCTION_LIST 15
  109087. #define PragTyp_INCREMENTAL_VACUUM 16
  109088. #define PragTyp_INDEX_INFO 17
  109089. #define PragTyp_INDEX_LIST 18
  109090. #define PragTyp_INTEGRITY_CHECK 19
  109091. #define PragTyp_JOURNAL_MODE 20
  109092. #define PragTyp_JOURNAL_SIZE_LIMIT 21
  109093. #define PragTyp_LOCK_PROXY_FILE 22
  109094. #define PragTyp_LOCKING_MODE 23
  109095. #define PragTyp_PAGE_COUNT 24
  109096. #define PragTyp_MMAP_SIZE 25
  109097. #define PragTyp_MODULE_LIST 26
  109098. #define PragTyp_OPTIMIZE 27
  109099. #define PragTyp_PAGE_SIZE 28
  109100. #define PragTyp_PRAGMA_LIST 29
  109101. #define PragTyp_SECURE_DELETE 30
  109102. #define PragTyp_SHRINK_MEMORY 31
  109103. #define PragTyp_SOFT_HEAP_LIMIT 32
  109104. #define PragTyp_SYNCHRONOUS 33
  109105. #define PragTyp_TABLE_INFO 34
  109106. #define PragTyp_TEMP_STORE 35
  109107. #define PragTyp_TEMP_STORE_DIRECTORY 36
  109108. #define PragTyp_THREADS 37
  109109. #define PragTyp_WAL_AUTOCHECKPOINT 38
  109110. #define PragTyp_WAL_CHECKPOINT 39
  109111. #define PragTyp_ACTIVATE_EXTENSIONS 40
  109112. #define PragTyp_HEXKEY 41
  109113. #define PragTyp_KEY 42
  109114. #define PragTyp_REKEY 43
  109115. #define PragTyp_LOCK_STATUS 44
  109116. #define PragTyp_PARSER_TRACE 45
  109117. #define PragTyp_STATS 46
  109118. /* Property flags associated with various pragma. */
  109119. #define PragFlg_NeedSchema 0x01 /* Force schema load before running */
  109120. #define PragFlg_NoColumns 0x02 /* OP_ResultRow called with zero columns */
  109121. #define PragFlg_NoColumns1 0x04 /* zero columns if RHS argument is present */
  109122. #define PragFlg_ReadOnly 0x08 /* Read-only HEADER_VALUE */
  109123. #define PragFlg_Result0 0x10 /* Acts as query when no argument */
  109124. #define PragFlg_Result1 0x20 /* Acts as query when has one argument */
  109125. #define PragFlg_SchemaOpt 0x40 /* Schema restricts name search if present */
  109126. #define PragFlg_SchemaReq 0x80 /* Schema required - "main" is default */
  109127. /* Names of columns for pragmas that return multi-column result
  109128. ** or that return single-column results where the name of the
  109129. ** result column is different from the name of the pragma
  109130. */
  109131. static const char *const pragCName[] = {
  109132. /* 0 */ "cache_size", /* Used by: default_cache_size */
  109133. /* 1 */ "cid", /* Used by: table_info */
  109134. /* 2 */ "name",
  109135. /* 3 */ "type",
  109136. /* 4 */ "notnull",
  109137. /* 5 */ "dflt_value",
  109138. /* 6 */ "pk",
  109139. /* 7 */ "tbl", /* Used by: stats */
  109140. /* 8 */ "idx",
  109141. /* 9 */ "wdth",
  109142. /* 10 */ "hght",
  109143. /* 11 */ "flgs",
  109144. /* 12 */ "seqno", /* Used by: index_info */
  109145. /* 13 */ "cid",
  109146. /* 14 */ "name",
  109147. /* 15 */ "seqno", /* Used by: index_xinfo */
  109148. /* 16 */ "cid",
  109149. /* 17 */ "name",
  109150. /* 18 */ "desc",
  109151. /* 19 */ "coll",
  109152. /* 20 */ "key",
  109153. /* 21 */ "seq", /* Used by: index_list */
  109154. /* 22 */ "name",
  109155. /* 23 */ "unique",
  109156. /* 24 */ "origin",
  109157. /* 25 */ "partial",
  109158. /* 26 */ "seq", /* Used by: database_list */
  109159. /* 27 */ "name",
  109160. /* 28 */ "file",
  109161. /* 29 */ "name", /* Used by: function_list */
  109162. /* 30 */ "builtin",
  109163. /* 31 */ "name", /* Used by: module_list pragma_list */
  109164. /* 32 */ "seq", /* Used by: collation_list */
  109165. /* 33 */ "name",
  109166. /* 34 */ "id", /* Used by: foreign_key_list */
  109167. /* 35 */ "seq",
  109168. /* 36 */ "table",
  109169. /* 37 */ "from",
  109170. /* 38 */ "to",
  109171. /* 39 */ "on_update",
  109172. /* 40 */ "on_delete",
  109173. /* 41 */ "match",
  109174. /* 42 */ "table", /* Used by: foreign_key_check */
  109175. /* 43 */ "rowid",
  109176. /* 44 */ "parent",
  109177. /* 45 */ "fkid",
  109178. /* 46 */ "busy", /* Used by: wal_checkpoint */
  109179. /* 47 */ "log",
  109180. /* 48 */ "checkpointed",
  109181. /* 49 */ "timeout", /* Used by: busy_timeout */
  109182. /* 50 */ "database", /* Used by: lock_status */
  109183. /* 51 */ "status",
  109184. };
  109185. /* Definitions of all built-in pragmas */
  109186. typedef struct PragmaName {
  109187. const char *const zName; /* Name of pragma */
  109188. u8 ePragTyp; /* PragTyp_XXX value */
  109189. u8 mPragFlg; /* Zero or more PragFlg_XXX values */
  109190. u8 iPragCName; /* Start of column names in pragCName[] */
  109191. u8 nPragCName; /* Num of col names. 0 means use pragma name */
  109192. u32 iArg; /* Extra argument */
  109193. } PragmaName;
  109194. static const PragmaName aPragmaName[] = {
  109195. #if defined(SQLITE_HAS_CODEC) || defined(SQLITE_ENABLE_CEROD)
  109196. {/* zName: */ "activate_extensions",
  109197. /* ePragTyp: */ PragTyp_ACTIVATE_EXTENSIONS,
  109198. /* ePragFlg: */ 0,
  109199. /* ColNames: */ 0, 0,
  109200. /* iArg: */ 0 },
  109201. #endif
  109202. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  109203. {/* zName: */ "application_id",
  109204. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  109205. /* ePragFlg: */ PragFlg_NoColumns1|PragFlg_Result0,
  109206. /* ColNames: */ 0, 0,
  109207. /* iArg: */ BTREE_APPLICATION_ID },
  109208. #endif
  109209. #if !defined(SQLITE_OMIT_AUTOVACUUM)
  109210. {/* zName: */ "auto_vacuum",
  109211. /* ePragTyp: */ PragTyp_AUTO_VACUUM,
  109212. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq|PragFlg_NoColumns1,
  109213. /* ColNames: */ 0, 0,
  109214. /* iArg: */ 0 },
  109215. #endif
  109216. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109217. #if !defined(SQLITE_OMIT_AUTOMATIC_INDEX)
  109218. {/* zName: */ "automatic_index",
  109219. /* ePragTyp: */ PragTyp_FLAG,
  109220. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109221. /* ColNames: */ 0, 0,
  109222. /* iArg: */ SQLITE_AutoIndex },
  109223. #endif
  109224. #endif
  109225. {/* zName: */ "busy_timeout",
  109226. /* ePragTyp: */ PragTyp_BUSY_TIMEOUT,
  109227. /* ePragFlg: */ PragFlg_Result0,
  109228. /* ColNames: */ 49, 1,
  109229. /* iArg: */ 0 },
  109230. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109231. {/* zName: */ "cache_size",
  109232. /* ePragTyp: */ PragTyp_CACHE_SIZE,
  109233. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq|PragFlg_NoColumns1,
  109234. /* ColNames: */ 0, 0,
  109235. /* iArg: */ 0 },
  109236. #endif
  109237. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109238. {/* zName: */ "cache_spill",
  109239. /* ePragTyp: */ PragTyp_CACHE_SPILL,
  109240. /* ePragFlg: */ PragFlg_Result0|PragFlg_SchemaReq|PragFlg_NoColumns1,
  109241. /* ColNames: */ 0, 0,
  109242. /* iArg: */ 0 },
  109243. #endif
  109244. {/* zName: */ "case_sensitive_like",
  109245. /* ePragTyp: */ PragTyp_CASE_SENSITIVE_LIKE,
  109246. /* ePragFlg: */ PragFlg_NoColumns,
  109247. /* ColNames: */ 0, 0,
  109248. /* iArg: */ 0 },
  109249. {/* zName: */ "cell_size_check",
  109250. /* ePragTyp: */ PragTyp_FLAG,
  109251. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109252. /* ColNames: */ 0, 0,
  109253. /* iArg: */ SQLITE_CellSizeCk },
  109254. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109255. {/* zName: */ "checkpoint_fullfsync",
  109256. /* ePragTyp: */ PragTyp_FLAG,
  109257. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109258. /* ColNames: */ 0, 0,
  109259. /* iArg: */ SQLITE_CkptFullFSync },
  109260. #endif
  109261. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  109262. {/* zName: */ "collation_list",
  109263. /* ePragTyp: */ PragTyp_COLLATION_LIST,
  109264. /* ePragFlg: */ PragFlg_Result0,
  109265. /* ColNames: */ 32, 2,
  109266. /* iArg: */ 0 },
  109267. #endif
  109268. #if !defined(SQLITE_OMIT_COMPILEOPTION_DIAGS)
  109269. {/* zName: */ "compile_options",
  109270. /* ePragTyp: */ PragTyp_COMPILE_OPTIONS,
  109271. /* ePragFlg: */ PragFlg_Result0,
  109272. /* ColNames: */ 0, 0,
  109273. /* iArg: */ 0 },
  109274. #endif
  109275. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109276. {/* zName: */ "count_changes",
  109277. /* ePragTyp: */ PragTyp_FLAG,
  109278. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109279. /* ColNames: */ 0, 0,
  109280. /* iArg: */ SQLITE_CountRows },
  109281. #endif
  109282. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && SQLITE_OS_WIN
  109283. {/* zName: */ "data_store_directory",
  109284. /* ePragTyp: */ PragTyp_DATA_STORE_DIRECTORY,
  109285. /* ePragFlg: */ PragFlg_NoColumns1,
  109286. /* ColNames: */ 0, 0,
  109287. /* iArg: */ 0 },
  109288. #endif
  109289. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  109290. {/* zName: */ "data_version",
  109291. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  109292. /* ePragFlg: */ PragFlg_ReadOnly|PragFlg_Result0,
  109293. /* ColNames: */ 0, 0,
  109294. /* iArg: */ BTREE_DATA_VERSION },
  109295. #endif
  109296. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  109297. {/* zName: */ "database_list",
  109298. /* ePragTyp: */ PragTyp_DATABASE_LIST,
  109299. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0,
  109300. /* ColNames: */ 26, 3,
  109301. /* iArg: */ 0 },
  109302. #endif
  109303. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
  109304. {/* zName: */ "default_cache_size",
  109305. /* ePragTyp: */ PragTyp_DEFAULT_CACHE_SIZE,
  109306. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq|PragFlg_NoColumns1,
  109307. /* ColNames: */ 0, 1,
  109308. /* iArg: */ 0 },
  109309. #endif
  109310. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109311. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  109312. {/* zName: */ "defer_foreign_keys",
  109313. /* ePragTyp: */ PragTyp_FLAG,
  109314. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109315. /* ColNames: */ 0, 0,
  109316. /* iArg: */ SQLITE_DeferFKs },
  109317. #endif
  109318. #endif
  109319. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109320. {/* zName: */ "empty_result_callbacks",
  109321. /* ePragTyp: */ PragTyp_FLAG,
  109322. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109323. /* ColNames: */ 0, 0,
  109324. /* iArg: */ SQLITE_NullCallback },
  109325. #endif
  109326. #if !defined(SQLITE_OMIT_UTF16)
  109327. {/* zName: */ "encoding",
  109328. /* ePragTyp: */ PragTyp_ENCODING,
  109329. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109330. /* ColNames: */ 0, 0,
  109331. /* iArg: */ 0 },
  109332. #endif
  109333. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  109334. {/* zName: */ "foreign_key_check",
  109335. /* ePragTyp: */ PragTyp_FOREIGN_KEY_CHECK,
  109336. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0,
  109337. /* ColNames: */ 42, 4,
  109338. /* iArg: */ 0 },
  109339. #endif
  109340. #if !defined(SQLITE_OMIT_FOREIGN_KEY)
  109341. {/* zName: */ "foreign_key_list",
  109342. /* ePragTyp: */ PragTyp_FOREIGN_KEY_LIST,
  109343. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result1|PragFlg_SchemaOpt,
  109344. /* ColNames: */ 34, 8,
  109345. /* iArg: */ 0 },
  109346. #endif
  109347. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109348. #if !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
  109349. {/* zName: */ "foreign_keys",
  109350. /* ePragTyp: */ PragTyp_FLAG,
  109351. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109352. /* ColNames: */ 0, 0,
  109353. /* iArg: */ SQLITE_ForeignKeys },
  109354. #endif
  109355. #endif
  109356. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  109357. {/* zName: */ "freelist_count",
  109358. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  109359. /* ePragFlg: */ PragFlg_ReadOnly|PragFlg_Result0,
  109360. /* ColNames: */ 0, 0,
  109361. /* iArg: */ BTREE_FREE_PAGE_COUNT },
  109362. #endif
  109363. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109364. {/* zName: */ "full_column_names",
  109365. /* ePragTyp: */ PragTyp_FLAG,
  109366. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109367. /* ColNames: */ 0, 0,
  109368. /* iArg: */ SQLITE_FullColNames },
  109369. {/* zName: */ "fullfsync",
  109370. /* ePragTyp: */ PragTyp_FLAG,
  109371. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109372. /* ColNames: */ 0, 0,
  109373. /* iArg: */ SQLITE_FullFSync },
  109374. #endif
  109375. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  109376. #if defined(SQLITE_INTROSPECTION_PRAGMAS)
  109377. {/* zName: */ "function_list",
  109378. /* ePragTyp: */ PragTyp_FUNCTION_LIST,
  109379. /* ePragFlg: */ PragFlg_Result0,
  109380. /* ColNames: */ 29, 2,
  109381. /* iArg: */ 0 },
  109382. #endif
  109383. #endif
  109384. #if defined(SQLITE_HAS_CODEC)
  109385. {/* zName: */ "hexkey",
  109386. /* ePragTyp: */ PragTyp_HEXKEY,
  109387. /* ePragFlg: */ 0,
  109388. /* ColNames: */ 0, 0,
  109389. /* iArg: */ 0 },
  109390. {/* zName: */ "hexrekey",
  109391. /* ePragTyp: */ PragTyp_HEXKEY,
  109392. /* ePragFlg: */ 0,
  109393. /* ColNames: */ 0, 0,
  109394. /* iArg: */ 0 },
  109395. #endif
  109396. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109397. #if !defined(SQLITE_OMIT_CHECK)
  109398. {/* zName: */ "ignore_check_constraints",
  109399. /* ePragTyp: */ PragTyp_FLAG,
  109400. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109401. /* ColNames: */ 0, 0,
  109402. /* iArg: */ SQLITE_IgnoreChecks },
  109403. #endif
  109404. #endif
  109405. #if !defined(SQLITE_OMIT_AUTOVACUUM)
  109406. {/* zName: */ "incremental_vacuum",
  109407. /* ePragTyp: */ PragTyp_INCREMENTAL_VACUUM,
  109408. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_NoColumns,
  109409. /* ColNames: */ 0, 0,
  109410. /* iArg: */ 0 },
  109411. #endif
  109412. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  109413. {/* zName: */ "index_info",
  109414. /* ePragTyp: */ PragTyp_INDEX_INFO,
  109415. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result1|PragFlg_SchemaOpt,
  109416. /* ColNames: */ 12, 3,
  109417. /* iArg: */ 0 },
  109418. {/* zName: */ "index_list",
  109419. /* ePragTyp: */ PragTyp_INDEX_LIST,
  109420. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result1|PragFlg_SchemaOpt,
  109421. /* ColNames: */ 21, 5,
  109422. /* iArg: */ 0 },
  109423. {/* zName: */ "index_xinfo",
  109424. /* ePragTyp: */ PragTyp_INDEX_INFO,
  109425. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result1|PragFlg_SchemaOpt,
  109426. /* ColNames: */ 15, 6,
  109427. /* iArg: */ 1 },
  109428. #endif
  109429. #if !defined(SQLITE_OMIT_INTEGRITY_CHECK)
  109430. {/* zName: */ "integrity_check",
  109431. /* ePragTyp: */ PragTyp_INTEGRITY_CHECK,
  109432. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_Result1,
  109433. /* ColNames: */ 0, 0,
  109434. /* iArg: */ 0 },
  109435. #endif
  109436. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109437. {/* zName: */ "journal_mode",
  109438. /* ePragTyp: */ PragTyp_JOURNAL_MODE,
  109439. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq,
  109440. /* ColNames: */ 0, 0,
  109441. /* iArg: */ 0 },
  109442. {/* zName: */ "journal_size_limit",
  109443. /* ePragTyp: */ PragTyp_JOURNAL_SIZE_LIMIT,
  109444. /* ePragFlg: */ PragFlg_Result0|PragFlg_SchemaReq,
  109445. /* ColNames: */ 0, 0,
  109446. /* iArg: */ 0 },
  109447. #endif
  109448. #if defined(SQLITE_HAS_CODEC)
  109449. {/* zName: */ "key",
  109450. /* ePragTyp: */ PragTyp_KEY,
  109451. /* ePragFlg: */ 0,
  109452. /* ColNames: */ 0, 0,
  109453. /* iArg: */ 0 },
  109454. #endif
  109455. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109456. {/* zName: */ "legacy_file_format",
  109457. /* ePragTyp: */ PragTyp_FLAG,
  109458. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109459. /* ColNames: */ 0, 0,
  109460. /* iArg: */ SQLITE_LegacyFileFmt },
  109461. #endif
  109462. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && SQLITE_ENABLE_LOCKING_STYLE
  109463. {/* zName: */ "lock_proxy_file",
  109464. /* ePragTyp: */ PragTyp_LOCK_PROXY_FILE,
  109465. /* ePragFlg: */ PragFlg_NoColumns1,
  109466. /* ColNames: */ 0, 0,
  109467. /* iArg: */ 0 },
  109468. #endif
  109469. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  109470. {/* zName: */ "lock_status",
  109471. /* ePragTyp: */ PragTyp_LOCK_STATUS,
  109472. /* ePragFlg: */ PragFlg_Result0,
  109473. /* ColNames: */ 50, 2,
  109474. /* iArg: */ 0 },
  109475. #endif
  109476. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109477. {/* zName: */ "locking_mode",
  109478. /* ePragTyp: */ PragTyp_LOCKING_MODE,
  109479. /* ePragFlg: */ PragFlg_Result0|PragFlg_SchemaReq,
  109480. /* ColNames: */ 0, 0,
  109481. /* iArg: */ 0 },
  109482. {/* zName: */ "max_page_count",
  109483. /* ePragTyp: */ PragTyp_PAGE_COUNT,
  109484. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq,
  109485. /* ColNames: */ 0, 0,
  109486. /* iArg: */ 0 },
  109487. {/* zName: */ "mmap_size",
  109488. /* ePragTyp: */ PragTyp_MMAP_SIZE,
  109489. /* ePragFlg: */ 0,
  109490. /* ColNames: */ 0, 0,
  109491. /* iArg: */ 0 },
  109492. #endif
  109493. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  109494. #if !defined(SQLITE_OMIT_VIRTUALTABLE)
  109495. #if defined(SQLITE_INTROSPECTION_PRAGMAS)
  109496. {/* zName: */ "module_list",
  109497. /* ePragTyp: */ PragTyp_MODULE_LIST,
  109498. /* ePragFlg: */ PragFlg_Result0,
  109499. /* ColNames: */ 31, 1,
  109500. /* iArg: */ 0 },
  109501. #endif
  109502. #endif
  109503. #endif
  109504. {/* zName: */ "optimize",
  109505. /* ePragTyp: */ PragTyp_OPTIMIZE,
  109506. /* ePragFlg: */ PragFlg_Result1|PragFlg_NeedSchema,
  109507. /* ColNames: */ 0, 0,
  109508. /* iArg: */ 0 },
  109509. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109510. {/* zName: */ "page_count",
  109511. /* ePragTyp: */ PragTyp_PAGE_COUNT,
  109512. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq,
  109513. /* ColNames: */ 0, 0,
  109514. /* iArg: */ 0 },
  109515. {/* zName: */ "page_size",
  109516. /* ePragTyp: */ PragTyp_PAGE_SIZE,
  109517. /* ePragFlg: */ PragFlg_Result0|PragFlg_SchemaReq|PragFlg_NoColumns1,
  109518. /* ColNames: */ 0, 0,
  109519. /* iArg: */ 0 },
  109520. #endif
  109521. #if defined(SQLITE_DEBUG) && !defined(SQLITE_OMIT_PARSER_TRACE)
  109522. {/* zName: */ "parser_trace",
  109523. /* ePragTyp: */ PragTyp_PARSER_TRACE,
  109524. /* ePragFlg: */ 0,
  109525. /* ColNames: */ 0, 0,
  109526. /* iArg: */ 0 },
  109527. #endif
  109528. #if defined(SQLITE_INTROSPECTION_PRAGMAS)
  109529. {/* zName: */ "pragma_list",
  109530. /* ePragTyp: */ PragTyp_PRAGMA_LIST,
  109531. /* ePragFlg: */ PragFlg_Result0,
  109532. /* ColNames: */ 31, 1,
  109533. /* iArg: */ 0 },
  109534. #endif
  109535. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109536. {/* zName: */ "query_only",
  109537. /* ePragTyp: */ PragTyp_FLAG,
  109538. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109539. /* ColNames: */ 0, 0,
  109540. /* iArg: */ SQLITE_QueryOnly },
  109541. #endif
  109542. #if !defined(SQLITE_OMIT_INTEGRITY_CHECK)
  109543. {/* zName: */ "quick_check",
  109544. /* ePragTyp: */ PragTyp_INTEGRITY_CHECK,
  109545. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_Result1,
  109546. /* ColNames: */ 0, 0,
  109547. /* iArg: */ 0 },
  109548. #endif
  109549. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109550. {/* zName: */ "read_uncommitted",
  109551. /* ePragTyp: */ PragTyp_FLAG,
  109552. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109553. /* ColNames: */ 0, 0,
  109554. /* iArg: */ SQLITE_ReadUncommit },
  109555. {/* zName: */ "recursive_triggers",
  109556. /* ePragTyp: */ PragTyp_FLAG,
  109557. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109558. /* ColNames: */ 0, 0,
  109559. /* iArg: */ SQLITE_RecTriggers },
  109560. #endif
  109561. #if defined(SQLITE_HAS_CODEC)
  109562. {/* zName: */ "rekey",
  109563. /* ePragTyp: */ PragTyp_REKEY,
  109564. /* ePragFlg: */ 0,
  109565. /* ColNames: */ 0, 0,
  109566. /* iArg: */ 0 },
  109567. #endif
  109568. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109569. {/* zName: */ "reverse_unordered_selects",
  109570. /* ePragTyp: */ PragTyp_FLAG,
  109571. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109572. /* ColNames: */ 0, 0,
  109573. /* iArg: */ SQLITE_ReverseOrder },
  109574. #endif
  109575. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  109576. {/* zName: */ "schema_version",
  109577. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  109578. /* ePragFlg: */ PragFlg_NoColumns1|PragFlg_Result0,
  109579. /* ColNames: */ 0, 0,
  109580. /* iArg: */ BTREE_SCHEMA_VERSION },
  109581. #endif
  109582. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109583. {/* zName: */ "secure_delete",
  109584. /* ePragTyp: */ PragTyp_SECURE_DELETE,
  109585. /* ePragFlg: */ PragFlg_Result0,
  109586. /* ColNames: */ 0, 0,
  109587. /* iArg: */ 0 },
  109588. #endif
  109589. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109590. {/* zName: */ "short_column_names",
  109591. /* ePragTyp: */ PragTyp_FLAG,
  109592. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109593. /* ColNames: */ 0, 0,
  109594. /* iArg: */ SQLITE_ShortColNames },
  109595. #endif
  109596. {/* zName: */ "shrink_memory",
  109597. /* ePragTyp: */ PragTyp_SHRINK_MEMORY,
  109598. /* ePragFlg: */ PragFlg_NoColumns,
  109599. /* ColNames: */ 0, 0,
  109600. /* iArg: */ 0 },
  109601. {/* zName: */ "soft_heap_limit",
  109602. /* ePragTyp: */ PragTyp_SOFT_HEAP_LIMIT,
  109603. /* ePragFlg: */ PragFlg_Result0,
  109604. /* ColNames: */ 0, 0,
  109605. /* iArg: */ 0 },
  109606. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109607. #if defined(SQLITE_DEBUG)
  109608. {/* zName: */ "sql_trace",
  109609. /* ePragTyp: */ PragTyp_FLAG,
  109610. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109611. /* ColNames: */ 0, 0,
  109612. /* iArg: */ SQLITE_SqlTrace },
  109613. #endif
  109614. #endif
  109615. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS) && defined(SQLITE_DEBUG)
  109616. {/* zName: */ "stats",
  109617. /* ePragTyp: */ PragTyp_STATS,
  109618. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq,
  109619. /* ColNames: */ 7, 5,
  109620. /* iArg: */ 0 },
  109621. #endif
  109622. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109623. {/* zName: */ "synchronous",
  109624. /* ePragTyp: */ PragTyp_SYNCHRONOUS,
  109625. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result0|PragFlg_SchemaReq|PragFlg_NoColumns1,
  109626. /* ColNames: */ 0, 0,
  109627. /* iArg: */ 0 },
  109628. #endif
  109629. #if !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
  109630. {/* zName: */ "table_info",
  109631. /* ePragTyp: */ PragTyp_TABLE_INFO,
  109632. /* ePragFlg: */ PragFlg_NeedSchema|PragFlg_Result1|PragFlg_SchemaOpt,
  109633. /* ColNames: */ 1, 6,
  109634. /* iArg: */ 0 },
  109635. #endif
  109636. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  109637. {/* zName: */ "temp_store",
  109638. /* ePragTyp: */ PragTyp_TEMP_STORE,
  109639. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109640. /* ColNames: */ 0, 0,
  109641. /* iArg: */ 0 },
  109642. {/* zName: */ "temp_store_directory",
  109643. /* ePragTyp: */ PragTyp_TEMP_STORE_DIRECTORY,
  109644. /* ePragFlg: */ PragFlg_NoColumns1,
  109645. /* ColNames: */ 0, 0,
  109646. /* iArg: */ 0 },
  109647. #endif
  109648. {/* zName: */ "threads",
  109649. /* ePragTyp: */ PragTyp_THREADS,
  109650. /* ePragFlg: */ PragFlg_Result0,
  109651. /* ColNames: */ 0, 0,
  109652. /* iArg: */ 0 },
  109653. #if !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
  109654. {/* zName: */ "user_version",
  109655. /* ePragTyp: */ PragTyp_HEADER_VALUE,
  109656. /* ePragFlg: */ PragFlg_NoColumns1|PragFlg_Result0,
  109657. /* ColNames: */ 0, 0,
  109658. /* iArg: */ BTREE_USER_VERSION },
  109659. #endif
  109660. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109661. #if defined(SQLITE_DEBUG)
  109662. {/* zName: */ "vdbe_addoptrace",
  109663. /* ePragTyp: */ PragTyp_FLAG,
  109664. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109665. /* ColNames: */ 0, 0,
  109666. /* iArg: */ SQLITE_VdbeAddopTrace },
  109667. {/* zName: */ "vdbe_debug",
  109668. /* ePragTyp: */ PragTyp_FLAG,
  109669. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109670. /* ColNames: */ 0, 0,
  109671. /* iArg: */ SQLITE_SqlTrace|SQLITE_VdbeListing|SQLITE_VdbeTrace },
  109672. {/* zName: */ "vdbe_eqp",
  109673. /* ePragTyp: */ PragTyp_FLAG,
  109674. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109675. /* ColNames: */ 0, 0,
  109676. /* iArg: */ SQLITE_VdbeEQP },
  109677. {/* zName: */ "vdbe_listing",
  109678. /* ePragTyp: */ PragTyp_FLAG,
  109679. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109680. /* ColNames: */ 0, 0,
  109681. /* iArg: */ SQLITE_VdbeListing },
  109682. {/* zName: */ "vdbe_trace",
  109683. /* ePragTyp: */ PragTyp_FLAG,
  109684. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109685. /* ColNames: */ 0, 0,
  109686. /* iArg: */ SQLITE_VdbeTrace },
  109687. #endif
  109688. #endif
  109689. #if !defined(SQLITE_OMIT_WAL)
  109690. {/* zName: */ "wal_autocheckpoint",
  109691. /* ePragTyp: */ PragTyp_WAL_AUTOCHECKPOINT,
  109692. /* ePragFlg: */ 0,
  109693. /* ColNames: */ 0, 0,
  109694. /* iArg: */ 0 },
  109695. {/* zName: */ "wal_checkpoint",
  109696. /* ePragTyp: */ PragTyp_WAL_CHECKPOINT,
  109697. /* ePragFlg: */ PragFlg_NeedSchema,
  109698. /* ColNames: */ 46, 3,
  109699. /* iArg: */ 0 },
  109700. #endif
  109701. #if !defined(SQLITE_OMIT_FLAG_PRAGMAS)
  109702. {/* zName: */ "writable_schema",
  109703. /* ePragTyp: */ PragTyp_FLAG,
  109704. /* ePragFlg: */ PragFlg_Result0|PragFlg_NoColumns1,
  109705. /* ColNames: */ 0, 0,
  109706. /* iArg: */ SQLITE_WriteSchema },
  109707. #endif
  109708. };
  109709. /* Number of pragmas: 60 on by default, 77 total. */
  109710. /************** End of pragma.h **********************************************/
  109711. /************** Continuing where we left off in pragma.c *********************/
  109712. /*
  109713. ** Interpret the given string as a safety level. Return 0 for OFF,
  109714. ** 1 for ON or NORMAL, 2 for FULL, and 3 for EXTRA. Return 1 for an empty or
  109715. ** unrecognized string argument. The FULL and EXTRA option is disallowed
  109716. ** if the omitFull parameter it 1.
  109717. **
  109718. ** Note that the values returned are one less that the values that
  109719. ** should be passed into sqlite3BtreeSetSafetyLevel(). The is done
  109720. ** to support legacy SQL code. The safety level used to be boolean
  109721. ** and older scripts may have used numbers 0 for OFF and 1 for ON.
  109722. */
  109723. static u8 getSafetyLevel(const char *z, int omitFull, u8 dflt){
  109724. /* 123456789 123456789 123 */
  109725. static const char zText[] = "onoffalseyestruextrafull";
  109726. static const u8 iOffset[] = {0, 1, 2, 4, 9, 12, 15, 20};
  109727. static const u8 iLength[] = {2, 2, 3, 5, 3, 4, 5, 4};
  109728. static const u8 iValue[] = {1, 0, 0, 0, 1, 1, 3, 2};
  109729. /* on no off false yes true extra full */
  109730. int i, n;
  109731. if( sqlite3Isdigit(*z) ){
  109732. return (u8)sqlite3Atoi(z);
  109733. }
  109734. n = sqlite3Strlen30(z);
  109735. for(i=0; i<ArraySize(iLength); i++){
  109736. if( iLength[i]==n && sqlite3StrNICmp(&zText[iOffset[i]],z,n)==0
  109737. && (!omitFull || iValue[i]<=1)
  109738. ){
  109739. return iValue[i];
  109740. }
  109741. }
  109742. return dflt;
  109743. }
  109744. /*
  109745. ** Interpret the given string as a boolean value.
  109746. */
  109747. SQLITE_PRIVATE u8 sqlite3GetBoolean(const char *z, u8 dflt){
  109748. return getSafetyLevel(z,1,dflt)!=0;
  109749. }
  109750. /* The sqlite3GetBoolean() function is used by other modules but the
  109751. ** remainder of this file is specific to PRAGMA processing. So omit
  109752. ** the rest of the file if PRAGMAs are omitted from the build.
  109753. */
  109754. #if !defined(SQLITE_OMIT_PRAGMA)
  109755. /*
  109756. ** Interpret the given string as a locking mode value.
  109757. */
  109758. static int getLockingMode(const char *z){
  109759. if( z ){
  109760. if( 0==sqlite3StrICmp(z, "exclusive") ) return PAGER_LOCKINGMODE_EXCLUSIVE;
  109761. if( 0==sqlite3StrICmp(z, "normal") ) return PAGER_LOCKINGMODE_NORMAL;
  109762. }
  109763. return PAGER_LOCKINGMODE_QUERY;
  109764. }
  109765. #ifndef SQLITE_OMIT_AUTOVACUUM
  109766. /*
  109767. ** Interpret the given string as an auto-vacuum mode value.
  109768. **
  109769. ** The following strings, "none", "full" and "incremental" are
  109770. ** acceptable, as are their numeric equivalents: 0, 1 and 2 respectively.
  109771. */
  109772. static int getAutoVacuum(const char *z){
  109773. int i;
  109774. if( 0==sqlite3StrICmp(z, "none") ) return BTREE_AUTOVACUUM_NONE;
  109775. if( 0==sqlite3StrICmp(z, "full") ) return BTREE_AUTOVACUUM_FULL;
  109776. if( 0==sqlite3StrICmp(z, "incremental") ) return BTREE_AUTOVACUUM_INCR;
  109777. i = sqlite3Atoi(z);
  109778. return (u8)((i>=0&&i<=2)?i:0);
  109779. }
  109780. #endif /* ifndef SQLITE_OMIT_AUTOVACUUM */
  109781. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  109782. /*
  109783. ** Interpret the given string as a temp db location. Return 1 for file
  109784. ** backed temporary databases, 2 for the Red-Black tree in memory database
  109785. ** and 0 to use the compile-time default.
  109786. */
  109787. static int getTempStore(const char *z){
  109788. if( z[0]>='0' && z[0]<='2' ){
  109789. return z[0] - '0';
  109790. }else if( sqlite3StrICmp(z, "file")==0 ){
  109791. return 1;
  109792. }else if( sqlite3StrICmp(z, "memory")==0 ){
  109793. return 2;
  109794. }else{
  109795. return 0;
  109796. }
  109797. }
  109798. #endif /* SQLITE_PAGER_PRAGMAS */
  109799. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  109800. /*
  109801. ** Invalidate temp storage, either when the temp storage is changed
  109802. ** from default, or when 'file' and the temp_store_directory has changed
  109803. */
  109804. static int invalidateTempStorage(Parse *pParse){
  109805. sqlite3 *db = pParse->db;
  109806. if( db->aDb[1].pBt!=0 ){
  109807. if( !db->autoCommit || sqlite3BtreeIsInReadTrans(db->aDb[1].pBt) ){
  109808. sqlite3ErrorMsg(pParse, "temporary storage cannot be changed "
  109809. "from within a transaction");
  109810. return SQLITE_ERROR;
  109811. }
  109812. sqlite3BtreeClose(db->aDb[1].pBt);
  109813. db->aDb[1].pBt = 0;
  109814. sqlite3ResetAllSchemasOfConnection(db);
  109815. }
  109816. return SQLITE_OK;
  109817. }
  109818. #endif /* SQLITE_PAGER_PRAGMAS */
  109819. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  109820. /*
  109821. ** If the TEMP database is open, close it and mark the database schema
  109822. ** as needing reloading. This must be done when using the SQLITE_TEMP_STORE
  109823. ** or DEFAULT_TEMP_STORE pragmas.
  109824. */
  109825. static int changeTempStorage(Parse *pParse, const char *zStorageType){
  109826. int ts = getTempStore(zStorageType);
  109827. sqlite3 *db = pParse->db;
  109828. if( db->temp_store==ts ) return SQLITE_OK;
  109829. if( invalidateTempStorage( pParse ) != SQLITE_OK ){
  109830. return SQLITE_ERROR;
  109831. }
  109832. db->temp_store = (u8)ts;
  109833. return SQLITE_OK;
  109834. }
  109835. #endif /* SQLITE_PAGER_PRAGMAS */
  109836. /*
  109837. ** Set result column names for a pragma.
  109838. */
  109839. static void setPragmaResultColumnNames(
  109840. Vdbe *v, /* The query under construction */
  109841. const PragmaName *pPragma /* The pragma */
  109842. ){
  109843. u8 n = pPragma->nPragCName;
  109844. sqlite3VdbeSetNumCols(v, n==0 ? 1 : n);
  109845. if( n==0 ){
  109846. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, pPragma->zName, SQLITE_STATIC);
  109847. }else{
  109848. int i, j;
  109849. for(i=0, j=pPragma->iPragCName; i<n; i++, j++){
  109850. sqlite3VdbeSetColName(v, i, COLNAME_NAME, pragCName[j], SQLITE_STATIC);
  109851. }
  109852. }
  109853. }
  109854. /*
  109855. ** Generate code to return a single integer value.
  109856. */
  109857. static void returnSingleInt(Vdbe *v, i64 value){
  109858. sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, 1, 0, (const u8*)&value, P4_INT64);
  109859. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  109860. }
  109861. /*
  109862. ** Generate code to return a single text value.
  109863. */
  109864. static void returnSingleText(
  109865. Vdbe *v, /* Prepared statement under construction */
  109866. const char *zValue /* Value to be returned */
  109867. ){
  109868. if( zValue ){
  109869. sqlite3VdbeLoadString(v, 1, (const char*)zValue);
  109870. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  109871. }
  109872. }
  109873. /*
  109874. ** Set the safety_level and pager flags for pager iDb. Or if iDb<0
  109875. ** set these values for all pagers.
  109876. */
  109877. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  109878. static void setAllPagerFlags(sqlite3 *db){
  109879. if( db->autoCommit ){
  109880. Db *pDb = db->aDb;
  109881. int n = db->nDb;
  109882. assert( SQLITE_FullFSync==PAGER_FULLFSYNC );
  109883. assert( SQLITE_CkptFullFSync==PAGER_CKPT_FULLFSYNC );
  109884. assert( SQLITE_CacheSpill==PAGER_CACHESPILL );
  109885. assert( (PAGER_FULLFSYNC | PAGER_CKPT_FULLFSYNC | PAGER_CACHESPILL)
  109886. == PAGER_FLAGS_MASK );
  109887. assert( (pDb->safety_level & PAGER_SYNCHRONOUS_MASK)==pDb->safety_level );
  109888. while( (n--) > 0 ){
  109889. if( pDb->pBt ){
  109890. sqlite3BtreeSetPagerFlags(pDb->pBt,
  109891. pDb->safety_level | (db->flags & PAGER_FLAGS_MASK) );
  109892. }
  109893. pDb++;
  109894. }
  109895. }
  109896. }
  109897. #else
  109898. # define setAllPagerFlags(X) /* no-op */
  109899. #endif
  109900. /*
  109901. ** Return a human-readable name for a constraint resolution action.
  109902. */
  109903. #ifndef SQLITE_OMIT_FOREIGN_KEY
  109904. static const char *actionName(u8 action){
  109905. const char *zName;
  109906. switch( action ){
  109907. case OE_SetNull: zName = "SET NULL"; break;
  109908. case OE_SetDflt: zName = "SET DEFAULT"; break;
  109909. case OE_Cascade: zName = "CASCADE"; break;
  109910. case OE_Restrict: zName = "RESTRICT"; break;
  109911. default: zName = "NO ACTION";
  109912. assert( action==OE_None ); break;
  109913. }
  109914. return zName;
  109915. }
  109916. #endif
  109917. /*
  109918. ** Parameter eMode must be one of the PAGER_JOURNALMODE_XXX constants
  109919. ** defined in pager.h. This function returns the associated lowercase
  109920. ** journal-mode name.
  109921. */
  109922. SQLITE_PRIVATE const char *sqlite3JournalModename(int eMode){
  109923. static char * const azModeName[] = {
  109924. "delete", "persist", "off", "truncate", "memory"
  109925. #ifndef SQLITE_OMIT_WAL
  109926. , "wal"
  109927. #endif
  109928. };
  109929. assert( PAGER_JOURNALMODE_DELETE==0 );
  109930. assert( PAGER_JOURNALMODE_PERSIST==1 );
  109931. assert( PAGER_JOURNALMODE_OFF==2 );
  109932. assert( PAGER_JOURNALMODE_TRUNCATE==3 );
  109933. assert( PAGER_JOURNALMODE_MEMORY==4 );
  109934. assert( PAGER_JOURNALMODE_WAL==5 );
  109935. assert( eMode>=0 && eMode<=ArraySize(azModeName) );
  109936. if( eMode==ArraySize(azModeName) ) return 0;
  109937. return azModeName[eMode];
  109938. }
  109939. /*
  109940. ** Locate a pragma in the aPragmaName[] array.
  109941. */
  109942. static const PragmaName *pragmaLocate(const char *zName){
  109943. int upr, lwr, mid = 0, rc;
  109944. lwr = 0;
  109945. upr = ArraySize(aPragmaName)-1;
  109946. while( lwr<=upr ){
  109947. mid = (lwr+upr)/2;
  109948. rc = sqlite3_stricmp(zName, aPragmaName[mid].zName);
  109949. if( rc==0 ) break;
  109950. if( rc<0 ){
  109951. upr = mid - 1;
  109952. }else{
  109953. lwr = mid + 1;
  109954. }
  109955. }
  109956. return lwr>upr ? 0 : &aPragmaName[mid];
  109957. }
  109958. /*
  109959. ** Helper subroutine for PRAGMA integrity_check:
  109960. **
  109961. ** Generate code to output a single-column result row with a value of the
  109962. ** string held in register 3. Decrement the result count in register 1
  109963. ** and halt if the maximum number of result rows have been issued.
  109964. */
  109965. static int integrityCheckResultRow(Vdbe *v){
  109966. int addr;
  109967. sqlite3VdbeAddOp2(v, OP_ResultRow, 3, 1);
  109968. addr = sqlite3VdbeAddOp3(v, OP_IfPos, 1, sqlite3VdbeCurrentAddr(v)+2, 1);
  109969. VdbeCoverage(v);
  109970. sqlite3VdbeAddOp0(v, OP_Halt);
  109971. return addr;
  109972. }
  109973. /*
  109974. ** Process a pragma statement.
  109975. **
  109976. ** Pragmas are of this form:
  109977. **
  109978. ** PRAGMA [schema.]id [= value]
  109979. **
  109980. ** The identifier might also be a string. The value is a string, and
  109981. ** identifier, or a number. If minusFlag is true, then the value is
  109982. ** a number that was preceded by a minus sign.
  109983. **
  109984. ** If the left side is "database.id" then pId1 is the database name
  109985. ** and pId2 is the id. If the left side is just "id" then pId1 is the
  109986. ** id and pId2 is any empty string.
  109987. */
  109988. SQLITE_PRIVATE void sqlite3Pragma(
  109989. Parse *pParse,
  109990. Token *pId1, /* First part of [schema.]id field */
  109991. Token *pId2, /* Second part of [schema.]id field, or NULL */
  109992. Token *pValue, /* Token for <value>, or NULL */
  109993. int minusFlag /* True if a '-' sign preceded <value> */
  109994. ){
  109995. char *zLeft = 0; /* Nul-terminated UTF-8 string <id> */
  109996. char *zRight = 0; /* Nul-terminated UTF-8 string <value>, or NULL */
  109997. const char *zDb = 0; /* The database name */
  109998. Token *pId; /* Pointer to <id> token */
  109999. char *aFcntl[4]; /* Argument to SQLITE_FCNTL_PRAGMA */
  110000. int iDb; /* Database index for <database> */
  110001. int rc; /* return value form SQLITE_FCNTL_PRAGMA */
  110002. sqlite3 *db = pParse->db; /* The database connection */
  110003. Db *pDb; /* The specific database being pragmaed */
  110004. Vdbe *v = sqlite3GetVdbe(pParse); /* Prepared statement */
  110005. const PragmaName *pPragma; /* The pragma */
  110006. if( v==0 ) return;
  110007. sqlite3VdbeRunOnlyOnce(v);
  110008. pParse->nMem = 2;
  110009. /* Interpret the [schema.] part of the pragma statement. iDb is the
  110010. ** index of the database this pragma is being applied to in db.aDb[]. */
  110011. iDb = sqlite3TwoPartName(pParse, pId1, pId2, &pId);
  110012. if( iDb<0 ) return;
  110013. pDb = &db->aDb[iDb];
  110014. /* If the temp database has been explicitly named as part of the
  110015. ** pragma, make sure it is open.
  110016. */
  110017. if( iDb==1 && sqlite3OpenTempDatabase(pParse) ){
  110018. return;
  110019. }
  110020. zLeft = sqlite3NameFromToken(db, pId);
  110021. if( !zLeft ) return;
  110022. if( minusFlag ){
  110023. zRight = sqlite3MPrintf(db, "-%T", pValue);
  110024. }else{
  110025. zRight = sqlite3NameFromToken(db, pValue);
  110026. }
  110027. assert( pId2 );
  110028. zDb = pId2->n>0 ? pDb->zDbSName : 0;
  110029. if( sqlite3AuthCheck(pParse, SQLITE_PRAGMA, zLeft, zRight, zDb) ){
  110030. goto pragma_out;
  110031. }
  110032. /* Send an SQLITE_FCNTL_PRAGMA file-control to the underlying VFS
  110033. ** connection. If it returns SQLITE_OK, then assume that the VFS
  110034. ** handled the pragma and generate a no-op prepared statement.
  110035. **
  110036. ** IMPLEMENTATION-OF: R-12238-55120 Whenever a PRAGMA statement is parsed,
  110037. ** an SQLITE_FCNTL_PRAGMA file control is sent to the open sqlite3_file
  110038. ** object corresponding to the database file to which the pragma
  110039. ** statement refers.
  110040. **
  110041. ** IMPLEMENTATION-OF: R-29875-31678 The argument to the SQLITE_FCNTL_PRAGMA
  110042. ** file control is an array of pointers to strings (char**) in which the
  110043. ** second element of the array is the name of the pragma and the third
  110044. ** element is the argument to the pragma or NULL if the pragma has no
  110045. ** argument.
  110046. */
  110047. aFcntl[0] = 0;
  110048. aFcntl[1] = zLeft;
  110049. aFcntl[2] = zRight;
  110050. aFcntl[3] = 0;
  110051. db->busyHandler.nBusy = 0;
  110052. rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_PRAGMA, (void*)aFcntl);
  110053. if( rc==SQLITE_OK ){
  110054. sqlite3VdbeSetNumCols(v, 1);
  110055. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, aFcntl[0], SQLITE_TRANSIENT);
  110056. returnSingleText(v, aFcntl[0]);
  110057. sqlite3_free(aFcntl[0]);
  110058. goto pragma_out;
  110059. }
  110060. if( rc!=SQLITE_NOTFOUND ){
  110061. if( aFcntl[0] ){
  110062. sqlite3ErrorMsg(pParse, "%s", aFcntl[0]);
  110063. sqlite3_free(aFcntl[0]);
  110064. }
  110065. pParse->nErr++;
  110066. pParse->rc = rc;
  110067. goto pragma_out;
  110068. }
  110069. /* Locate the pragma in the lookup table */
  110070. pPragma = pragmaLocate(zLeft);
  110071. if( pPragma==0 ) goto pragma_out;
  110072. /* Make sure the database schema is loaded if the pragma requires that */
  110073. if( (pPragma->mPragFlg & PragFlg_NeedSchema)!=0 ){
  110074. if( sqlite3ReadSchema(pParse) ) goto pragma_out;
  110075. }
  110076. /* Register the result column names for pragmas that return results */
  110077. if( (pPragma->mPragFlg & PragFlg_NoColumns)==0
  110078. && ((pPragma->mPragFlg & PragFlg_NoColumns1)==0 || zRight==0)
  110079. ){
  110080. setPragmaResultColumnNames(v, pPragma);
  110081. }
  110082. /* Jump to the appropriate pragma handler */
  110083. switch( pPragma->ePragTyp ){
  110084. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
  110085. /*
  110086. ** PRAGMA [schema.]default_cache_size
  110087. ** PRAGMA [schema.]default_cache_size=N
  110088. **
  110089. ** The first form reports the current persistent setting for the
  110090. ** page cache size. The value returned is the maximum number of
  110091. ** pages in the page cache. The second form sets both the current
  110092. ** page cache size value and the persistent page cache size value
  110093. ** stored in the database file.
  110094. **
  110095. ** Older versions of SQLite would set the default cache size to a
  110096. ** negative number to indicate synchronous=OFF. These days, synchronous
  110097. ** is always on by default regardless of the sign of the default cache
  110098. ** size. But continue to take the absolute value of the default cache
  110099. ** size of historical compatibility.
  110100. */
  110101. case PragTyp_DEFAULT_CACHE_SIZE: {
  110102. static const int iLn = VDBE_OFFSET_LINENO(2);
  110103. static const VdbeOpList getCacheSize[] = {
  110104. { OP_Transaction, 0, 0, 0}, /* 0 */
  110105. { OP_ReadCookie, 0, 1, BTREE_DEFAULT_CACHE_SIZE}, /* 1 */
  110106. { OP_IfPos, 1, 8, 0},
  110107. { OP_Integer, 0, 2, 0},
  110108. { OP_Subtract, 1, 2, 1},
  110109. { OP_IfPos, 1, 8, 0},
  110110. { OP_Integer, 0, 1, 0}, /* 6 */
  110111. { OP_Noop, 0, 0, 0},
  110112. { OP_ResultRow, 1, 1, 0},
  110113. };
  110114. VdbeOp *aOp;
  110115. sqlite3VdbeUsesBtree(v, iDb);
  110116. if( !zRight ){
  110117. pParse->nMem += 2;
  110118. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(getCacheSize));
  110119. aOp = sqlite3VdbeAddOpList(v, ArraySize(getCacheSize), getCacheSize, iLn);
  110120. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  110121. aOp[0].p1 = iDb;
  110122. aOp[1].p1 = iDb;
  110123. aOp[6].p1 = SQLITE_DEFAULT_CACHE_SIZE;
  110124. }else{
  110125. int size = sqlite3AbsInt32(sqlite3Atoi(zRight));
  110126. sqlite3BeginWriteOperation(pParse, 0, iDb);
  110127. sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_DEFAULT_CACHE_SIZE, size);
  110128. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  110129. pDb->pSchema->cache_size = size;
  110130. sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
  110131. }
  110132. break;
  110133. }
  110134. #endif /* !SQLITE_OMIT_PAGER_PRAGMAS && !SQLITE_OMIT_DEPRECATED */
  110135. #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
  110136. /*
  110137. ** PRAGMA [schema.]page_size
  110138. ** PRAGMA [schema.]page_size=N
  110139. **
  110140. ** The first form reports the current setting for the
  110141. ** database page size in bytes. The second form sets the
  110142. ** database page size value. The value can only be set if
  110143. ** the database has not yet been created.
  110144. */
  110145. case PragTyp_PAGE_SIZE: {
  110146. Btree *pBt = pDb->pBt;
  110147. assert( pBt!=0 );
  110148. if( !zRight ){
  110149. int size = ALWAYS(pBt) ? sqlite3BtreeGetPageSize(pBt) : 0;
  110150. returnSingleInt(v, size);
  110151. }else{
  110152. /* Malloc may fail when setting the page-size, as there is an internal
  110153. ** buffer that the pager module resizes using sqlite3_realloc().
  110154. */
  110155. db->nextPagesize = sqlite3Atoi(zRight);
  110156. if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize,-1,0) ){
  110157. sqlite3OomFault(db);
  110158. }
  110159. }
  110160. break;
  110161. }
  110162. /*
  110163. ** PRAGMA [schema.]secure_delete
  110164. ** PRAGMA [schema.]secure_delete=ON/OFF/FAST
  110165. **
  110166. ** The first form reports the current setting for the
  110167. ** secure_delete flag. The second form changes the secure_delete
  110168. ** flag setting and reports the new value.
  110169. */
  110170. case PragTyp_SECURE_DELETE: {
  110171. Btree *pBt = pDb->pBt;
  110172. int b = -1;
  110173. assert( pBt!=0 );
  110174. if( zRight ){
  110175. if( sqlite3_stricmp(zRight, "fast")==0 ){
  110176. b = 2;
  110177. }else{
  110178. b = sqlite3GetBoolean(zRight, 0);
  110179. }
  110180. }
  110181. if( pId2->n==0 && b>=0 ){
  110182. int ii;
  110183. for(ii=0; ii<db->nDb; ii++){
  110184. sqlite3BtreeSecureDelete(db->aDb[ii].pBt, b);
  110185. }
  110186. }
  110187. b = sqlite3BtreeSecureDelete(pBt, b);
  110188. returnSingleInt(v, b);
  110189. break;
  110190. }
  110191. /*
  110192. ** PRAGMA [schema.]max_page_count
  110193. ** PRAGMA [schema.]max_page_count=N
  110194. **
  110195. ** The first form reports the current setting for the
  110196. ** maximum number of pages in the database file. The
  110197. ** second form attempts to change this setting. Both
  110198. ** forms return the current setting.
  110199. **
  110200. ** The absolute value of N is used. This is undocumented and might
  110201. ** change. The only purpose is to provide an easy way to test
  110202. ** the sqlite3AbsInt32() function.
  110203. **
  110204. ** PRAGMA [schema.]page_count
  110205. **
  110206. ** Return the number of pages in the specified database.
  110207. */
  110208. case PragTyp_PAGE_COUNT: {
  110209. int iReg;
  110210. sqlite3CodeVerifySchema(pParse, iDb);
  110211. iReg = ++pParse->nMem;
  110212. if( sqlite3Tolower(zLeft[0])=='p' ){
  110213. sqlite3VdbeAddOp2(v, OP_Pagecount, iDb, iReg);
  110214. }else{
  110215. sqlite3VdbeAddOp3(v, OP_MaxPgcnt, iDb, iReg,
  110216. sqlite3AbsInt32(sqlite3Atoi(zRight)));
  110217. }
  110218. sqlite3VdbeAddOp2(v, OP_ResultRow, iReg, 1);
  110219. break;
  110220. }
  110221. /*
  110222. ** PRAGMA [schema.]locking_mode
  110223. ** PRAGMA [schema.]locking_mode = (normal|exclusive)
  110224. */
  110225. case PragTyp_LOCKING_MODE: {
  110226. const char *zRet = "normal";
  110227. int eMode = getLockingMode(zRight);
  110228. if( pId2->n==0 && eMode==PAGER_LOCKINGMODE_QUERY ){
  110229. /* Simple "PRAGMA locking_mode;" statement. This is a query for
  110230. ** the current default locking mode (which may be different to
  110231. ** the locking-mode of the main database).
  110232. */
  110233. eMode = db->dfltLockMode;
  110234. }else{
  110235. Pager *pPager;
  110236. if( pId2->n==0 ){
  110237. /* This indicates that no database name was specified as part
  110238. ** of the PRAGMA command. In this case the locking-mode must be
  110239. ** set on all attached databases, as well as the main db file.
  110240. **
  110241. ** Also, the sqlite3.dfltLockMode variable is set so that
  110242. ** any subsequently attached databases also use the specified
  110243. ** locking mode.
  110244. */
  110245. int ii;
  110246. assert(pDb==&db->aDb[0]);
  110247. for(ii=2; ii<db->nDb; ii++){
  110248. pPager = sqlite3BtreePager(db->aDb[ii].pBt);
  110249. sqlite3PagerLockingMode(pPager, eMode);
  110250. }
  110251. db->dfltLockMode = (u8)eMode;
  110252. }
  110253. pPager = sqlite3BtreePager(pDb->pBt);
  110254. eMode = sqlite3PagerLockingMode(pPager, eMode);
  110255. }
  110256. assert( eMode==PAGER_LOCKINGMODE_NORMAL
  110257. || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
  110258. if( eMode==PAGER_LOCKINGMODE_EXCLUSIVE ){
  110259. zRet = "exclusive";
  110260. }
  110261. returnSingleText(v, zRet);
  110262. break;
  110263. }
  110264. /*
  110265. ** PRAGMA [schema.]journal_mode
  110266. ** PRAGMA [schema.]journal_mode =
  110267. ** (delete|persist|off|truncate|memory|wal|off)
  110268. */
  110269. case PragTyp_JOURNAL_MODE: {
  110270. int eMode; /* One of the PAGER_JOURNALMODE_XXX symbols */
  110271. int ii; /* Loop counter */
  110272. if( zRight==0 ){
  110273. /* If there is no "=MODE" part of the pragma, do a query for the
  110274. ** current mode */
  110275. eMode = PAGER_JOURNALMODE_QUERY;
  110276. }else{
  110277. const char *zMode;
  110278. int n = sqlite3Strlen30(zRight);
  110279. for(eMode=0; (zMode = sqlite3JournalModename(eMode))!=0; eMode++){
  110280. if( sqlite3StrNICmp(zRight, zMode, n)==0 ) break;
  110281. }
  110282. if( !zMode ){
  110283. /* If the "=MODE" part does not match any known journal mode,
  110284. ** then do a query */
  110285. eMode = PAGER_JOURNALMODE_QUERY;
  110286. }
  110287. }
  110288. if( eMode==PAGER_JOURNALMODE_QUERY && pId2->n==0 ){
  110289. /* Convert "PRAGMA journal_mode" into "PRAGMA main.journal_mode" */
  110290. iDb = 0;
  110291. pId2->n = 1;
  110292. }
  110293. for(ii=db->nDb-1; ii>=0; ii--){
  110294. if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
  110295. sqlite3VdbeUsesBtree(v, ii);
  110296. sqlite3VdbeAddOp3(v, OP_JournalMode, ii, 1, eMode);
  110297. }
  110298. }
  110299. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  110300. break;
  110301. }
  110302. /*
  110303. ** PRAGMA [schema.]journal_size_limit
  110304. ** PRAGMA [schema.]journal_size_limit=N
  110305. **
  110306. ** Get or set the size limit on rollback journal files.
  110307. */
  110308. case PragTyp_JOURNAL_SIZE_LIMIT: {
  110309. Pager *pPager = sqlite3BtreePager(pDb->pBt);
  110310. i64 iLimit = -2;
  110311. if( zRight ){
  110312. sqlite3DecOrHexToI64(zRight, &iLimit);
  110313. if( iLimit<-1 ) iLimit = -1;
  110314. }
  110315. iLimit = sqlite3PagerJournalSizeLimit(pPager, iLimit);
  110316. returnSingleInt(v, iLimit);
  110317. break;
  110318. }
  110319. #endif /* SQLITE_OMIT_PAGER_PRAGMAS */
  110320. /*
  110321. ** PRAGMA [schema.]auto_vacuum
  110322. ** PRAGMA [schema.]auto_vacuum=N
  110323. **
  110324. ** Get or set the value of the database 'auto-vacuum' parameter.
  110325. ** The value is one of: 0 NONE 1 FULL 2 INCREMENTAL
  110326. */
  110327. #ifndef SQLITE_OMIT_AUTOVACUUM
  110328. case PragTyp_AUTO_VACUUM: {
  110329. Btree *pBt = pDb->pBt;
  110330. assert( pBt!=0 );
  110331. if( !zRight ){
  110332. returnSingleInt(v, sqlite3BtreeGetAutoVacuum(pBt));
  110333. }else{
  110334. int eAuto = getAutoVacuum(zRight);
  110335. assert( eAuto>=0 && eAuto<=2 );
  110336. db->nextAutovac = (u8)eAuto;
  110337. /* Call SetAutoVacuum() to set initialize the internal auto and
  110338. ** incr-vacuum flags. This is required in case this connection
  110339. ** creates the database file. It is important that it is created
  110340. ** as an auto-vacuum capable db.
  110341. */
  110342. rc = sqlite3BtreeSetAutoVacuum(pBt, eAuto);
  110343. if( rc==SQLITE_OK && (eAuto==1 || eAuto==2) ){
  110344. /* When setting the auto_vacuum mode to either "full" or
  110345. ** "incremental", write the value of meta[6] in the database
  110346. ** file. Before writing to meta[6], check that meta[3] indicates
  110347. ** that this really is an auto-vacuum capable database.
  110348. */
  110349. static const int iLn = VDBE_OFFSET_LINENO(2);
  110350. static const VdbeOpList setMeta6[] = {
  110351. { OP_Transaction, 0, 1, 0}, /* 0 */
  110352. { OP_ReadCookie, 0, 1, BTREE_LARGEST_ROOT_PAGE},
  110353. { OP_If, 1, 0, 0}, /* 2 */
  110354. { OP_Halt, SQLITE_OK, OE_Abort, 0}, /* 3 */
  110355. { OP_SetCookie, 0, BTREE_INCR_VACUUM, 0}, /* 4 */
  110356. };
  110357. VdbeOp *aOp;
  110358. int iAddr = sqlite3VdbeCurrentAddr(v);
  110359. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setMeta6));
  110360. aOp = sqlite3VdbeAddOpList(v, ArraySize(setMeta6), setMeta6, iLn);
  110361. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  110362. aOp[0].p1 = iDb;
  110363. aOp[1].p1 = iDb;
  110364. aOp[2].p2 = iAddr+4;
  110365. aOp[4].p1 = iDb;
  110366. aOp[4].p3 = eAuto - 1;
  110367. sqlite3VdbeUsesBtree(v, iDb);
  110368. }
  110369. }
  110370. break;
  110371. }
  110372. #endif
  110373. /*
  110374. ** PRAGMA [schema.]incremental_vacuum(N)
  110375. **
  110376. ** Do N steps of incremental vacuuming on a database.
  110377. */
  110378. #ifndef SQLITE_OMIT_AUTOVACUUM
  110379. case PragTyp_INCREMENTAL_VACUUM: {
  110380. int iLimit, addr;
  110381. if( zRight==0 || !sqlite3GetInt32(zRight, &iLimit) || iLimit<=0 ){
  110382. iLimit = 0x7fffffff;
  110383. }
  110384. sqlite3BeginWriteOperation(pParse, 0, iDb);
  110385. sqlite3VdbeAddOp2(v, OP_Integer, iLimit, 1);
  110386. addr = sqlite3VdbeAddOp1(v, OP_IncrVacuum, iDb); VdbeCoverage(v);
  110387. sqlite3VdbeAddOp1(v, OP_ResultRow, 1);
  110388. sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1);
  110389. sqlite3VdbeAddOp2(v, OP_IfPos, 1, addr); VdbeCoverage(v);
  110390. sqlite3VdbeJumpHere(v, addr);
  110391. break;
  110392. }
  110393. #endif
  110394. #ifndef SQLITE_OMIT_PAGER_PRAGMAS
  110395. /*
  110396. ** PRAGMA [schema.]cache_size
  110397. ** PRAGMA [schema.]cache_size=N
  110398. **
  110399. ** The first form reports the current local setting for the
  110400. ** page cache size. The second form sets the local
  110401. ** page cache size value. If N is positive then that is the
  110402. ** number of pages in the cache. If N is negative, then the
  110403. ** number of pages is adjusted so that the cache uses -N kibibytes
  110404. ** of memory.
  110405. */
  110406. case PragTyp_CACHE_SIZE: {
  110407. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  110408. if( !zRight ){
  110409. returnSingleInt(v, pDb->pSchema->cache_size);
  110410. }else{
  110411. int size = sqlite3Atoi(zRight);
  110412. pDb->pSchema->cache_size = size;
  110413. sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
  110414. }
  110415. break;
  110416. }
  110417. /*
  110418. ** PRAGMA [schema.]cache_spill
  110419. ** PRAGMA cache_spill=BOOLEAN
  110420. ** PRAGMA [schema.]cache_spill=N
  110421. **
  110422. ** The first form reports the current local setting for the
  110423. ** page cache spill size. The second form turns cache spill on
  110424. ** or off. When turnning cache spill on, the size is set to the
  110425. ** current cache_size. The third form sets a spill size that
  110426. ** may be different form the cache size.
  110427. ** If N is positive then that is the
  110428. ** number of pages in the cache. If N is negative, then the
  110429. ** number of pages is adjusted so that the cache uses -N kibibytes
  110430. ** of memory.
  110431. **
  110432. ** If the number of cache_spill pages is less then the number of
  110433. ** cache_size pages, no spilling occurs until the page count exceeds
  110434. ** the number of cache_size pages.
  110435. **
  110436. ** The cache_spill=BOOLEAN setting applies to all attached schemas,
  110437. ** not just the schema specified.
  110438. */
  110439. case PragTyp_CACHE_SPILL: {
  110440. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  110441. if( !zRight ){
  110442. returnSingleInt(v,
  110443. (db->flags & SQLITE_CacheSpill)==0 ? 0 :
  110444. sqlite3BtreeSetSpillSize(pDb->pBt,0));
  110445. }else{
  110446. int size = 1;
  110447. if( sqlite3GetInt32(zRight, &size) ){
  110448. sqlite3BtreeSetSpillSize(pDb->pBt, size);
  110449. }
  110450. if( sqlite3GetBoolean(zRight, size!=0) ){
  110451. db->flags |= SQLITE_CacheSpill;
  110452. }else{
  110453. db->flags &= ~SQLITE_CacheSpill;
  110454. }
  110455. setAllPagerFlags(db);
  110456. }
  110457. break;
  110458. }
  110459. /*
  110460. ** PRAGMA [schema.]mmap_size(N)
  110461. **
  110462. ** Used to set mapping size limit. The mapping size limit is
  110463. ** used to limit the aggregate size of all memory mapped regions of the
  110464. ** database file. If this parameter is set to zero, then memory mapping
  110465. ** is not used at all. If N is negative, then the default memory map
  110466. ** limit determined by sqlite3_config(SQLITE_CONFIG_MMAP_SIZE) is set.
  110467. ** The parameter N is measured in bytes.
  110468. **
  110469. ** This value is advisory. The underlying VFS is free to memory map
  110470. ** as little or as much as it wants. Except, if N is set to 0 then the
  110471. ** upper layers will never invoke the xFetch interfaces to the VFS.
  110472. */
  110473. case PragTyp_MMAP_SIZE: {
  110474. sqlite3_int64 sz;
  110475. #if SQLITE_MAX_MMAP_SIZE>0
  110476. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  110477. if( zRight ){
  110478. int ii;
  110479. sqlite3DecOrHexToI64(zRight, &sz);
  110480. if( sz<0 ) sz = sqlite3GlobalConfig.szMmap;
  110481. if( pId2->n==0 ) db->szMmap = sz;
  110482. for(ii=db->nDb-1; ii>=0; ii--){
  110483. if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
  110484. sqlite3BtreeSetMmapLimit(db->aDb[ii].pBt, sz);
  110485. }
  110486. }
  110487. }
  110488. sz = -1;
  110489. rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_MMAP_SIZE, &sz);
  110490. #else
  110491. sz = 0;
  110492. rc = SQLITE_OK;
  110493. #endif
  110494. if( rc==SQLITE_OK ){
  110495. returnSingleInt(v, sz);
  110496. }else if( rc!=SQLITE_NOTFOUND ){
  110497. pParse->nErr++;
  110498. pParse->rc = rc;
  110499. }
  110500. break;
  110501. }
  110502. /*
  110503. ** PRAGMA temp_store
  110504. ** PRAGMA temp_store = "default"|"memory"|"file"
  110505. **
  110506. ** Return or set the local value of the temp_store flag. Changing
  110507. ** the local value does not make changes to the disk file and the default
  110508. ** value will be restored the next time the database is opened.
  110509. **
  110510. ** Note that it is possible for the library compile-time options to
  110511. ** override this setting
  110512. */
  110513. case PragTyp_TEMP_STORE: {
  110514. if( !zRight ){
  110515. returnSingleInt(v, db->temp_store);
  110516. }else{
  110517. changeTempStorage(pParse, zRight);
  110518. }
  110519. break;
  110520. }
  110521. /*
  110522. ** PRAGMA temp_store_directory
  110523. ** PRAGMA temp_store_directory = ""|"directory_name"
  110524. **
  110525. ** Return or set the local value of the temp_store_directory flag. Changing
  110526. ** the value sets a specific directory to be used for temporary files.
  110527. ** Setting to a null string reverts to the default temporary directory search.
  110528. ** If temporary directory is changed, then invalidateTempStorage.
  110529. **
  110530. */
  110531. case PragTyp_TEMP_STORE_DIRECTORY: {
  110532. if( !zRight ){
  110533. returnSingleText(v, sqlite3_temp_directory);
  110534. }else{
  110535. #ifndef SQLITE_OMIT_WSD
  110536. if( zRight[0] ){
  110537. int res;
  110538. rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
  110539. if( rc!=SQLITE_OK || res==0 ){
  110540. sqlite3ErrorMsg(pParse, "not a writable directory");
  110541. goto pragma_out;
  110542. }
  110543. }
  110544. if( SQLITE_TEMP_STORE==0
  110545. || (SQLITE_TEMP_STORE==1 && db->temp_store<=1)
  110546. || (SQLITE_TEMP_STORE==2 && db->temp_store==1)
  110547. ){
  110548. invalidateTempStorage(pParse);
  110549. }
  110550. sqlite3_free(sqlite3_temp_directory);
  110551. if( zRight[0] ){
  110552. sqlite3_temp_directory = sqlite3_mprintf("%s", zRight);
  110553. }else{
  110554. sqlite3_temp_directory = 0;
  110555. }
  110556. #endif /* SQLITE_OMIT_WSD */
  110557. }
  110558. break;
  110559. }
  110560. #if SQLITE_OS_WIN
  110561. /*
  110562. ** PRAGMA data_store_directory
  110563. ** PRAGMA data_store_directory = ""|"directory_name"
  110564. **
  110565. ** Return or set the local value of the data_store_directory flag. Changing
  110566. ** the value sets a specific directory to be used for database files that
  110567. ** were specified with a relative pathname. Setting to a null string reverts
  110568. ** to the default database directory, which for database files specified with
  110569. ** a relative path will probably be based on the current directory for the
  110570. ** process. Database file specified with an absolute path are not impacted
  110571. ** by this setting, regardless of its value.
  110572. **
  110573. */
  110574. case PragTyp_DATA_STORE_DIRECTORY: {
  110575. if( !zRight ){
  110576. returnSingleText(v, sqlite3_data_directory);
  110577. }else{
  110578. #ifndef SQLITE_OMIT_WSD
  110579. if( zRight[0] ){
  110580. int res;
  110581. rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
  110582. if( rc!=SQLITE_OK || res==0 ){
  110583. sqlite3ErrorMsg(pParse, "not a writable directory");
  110584. goto pragma_out;
  110585. }
  110586. }
  110587. sqlite3_free(sqlite3_data_directory);
  110588. if( zRight[0] ){
  110589. sqlite3_data_directory = sqlite3_mprintf("%s", zRight);
  110590. }else{
  110591. sqlite3_data_directory = 0;
  110592. }
  110593. #endif /* SQLITE_OMIT_WSD */
  110594. }
  110595. break;
  110596. }
  110597. #endif
  110598. #if SQLITE_ENABLE_LOCKING_STYLE
  110599. /*
  110600. ** PRAGMA [schema.]lock_proxy_file
  110601. ** PRAGMA [schema.]lock_proxy_file = ":auto:"|"lock_file_path"
  110602. **
  110603. ** Return or set the value of the lock_proxy_file flag. Changing
  110604. ** the value sets a specific file to be used for database access locks.
  110605. **
  110606. */
  110607. case PragTyp_LOCK_PROXY_FILE: {
  110608. if( !zRight ){
  110609. Pager *pPager = sqlite3BtreePager(pDb->pBt);
  110610. char *proxy_file_path = NULL;
  110611. sqlite3_file *pFile = sqlite3PagerFile(pPager);
  110612. sqlite3OsFileControlHint(pFile, SQLITE_GET_LOCKPROXYFILE,
  110613. &proxy_file_path);
  110614. returnSingleText(v, proxy_file_path);
  110615. }else{
  110616. Pager *pPager = sqlite3BtreePager(pDb->pBt);
  110617. sqlite3_file *pFile = sqlite3PagerFile(pPager);
  110618. int res;
  110619. if( zRight[0] ){
  110620. res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
  110621. zRight);
  110622. } else {
  110623. res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
  110624. NULL);
  110625. }
  110626. if( res!=SQLITE_OK ){
  110627. sqlite3ErrorMsg(pParse, "failed to set lock proxy file");
  110628. goto pragma_out;
  110629. }
  110630. }
  110631. break;
  110632. }
  110633. #endif /* SQLITE_ENABLE_LOCKING_STYLE */
  110634. /*
  110635. ** PRAGMA [schema.]synchronous
  110636. ** PRAGMA [schema.]synchronous=OFF|ON|NORMAL|FULL|EXTRA
  110637. **
  110638. ** Return or set the local value of the synchronous flag. Changing
  110639. ** the local value does not make changes to the disk file and the
  110640. ** default value will be restored the next time the database is
  110641. ** opened.
  110642. */
  110643. case PragTyp_SYNCHRONOUS: {
  110644. if( !zRight ){
  110645. returnSingleInt(v, pDb->safety_level-1);
  110646. }else{
  110647. if( !db->autoCommit ){
  110648. sqlite3ErrorMsg(pParse,
  110649. "Safety level may not be changed inside a transaction");
  110650. }else if( iDb!=1 ){
  110651. int iLevel = (getSafetyLevel(zRight,0,1)+1) & PAGER_SYNCHRONOUS_MASK;
  110652. if( iLevel==0 ) iLevel = 1;
  110653. pDb->safety_level = iLevel;
  110654. pDb->bSyncSet = 1;
  110655. setAllPagerFlags(db);
  110656. }
  110657. }
  110658. break;
  110659. }
  110660. #endif /* SQLITE_OMIT_PAGER_PRAGMAS */
  110661. #ifndef SQLITE_OMIT_FLAG_PRAGMAS
  110662. case PragTyp_FLAG: {
  110663. if( zRight==0 ){
  110664. setPragmaResultColumnNames(v, pPragma);
  110665. returnSingleInt(v, (db->flags & pPragma->iArg)!=0 );
  110666. }else{
  110667. int mask = pPragma->iArg; /* Mask of bits to set or clear. */
  110668. if( db->autoCommit==0 ){
  110669. /* Foreign key support may not be enabled or disabled while not
  110670. ** in auto-commit mode. */
  110671. mask &= ~(SQLITE_ForeignKeys);
  110672. }
  110673. #if SQLITE_USER_AUTHENTICATION
  110674. if( db->auth.authLevel==UAUTH_User ){
  110675. /* Do not allow non-admin users to modify the schema arbitrarily */
  110676. mask &= ~(SQLITE_WriteSchema);
  110677. }
  110678. #endif
  110679. if( sqlite3GetBoolean(zRight, 0) ){
  110680. db->flags |= mask;
  110681. }else{
  110682. db->flags &= ~mask;
  110683. if( mask==SQLITE_DeferFKs ) db->nDeferredImmCons = 0;
  110684. }
  110685. /* Many of the flag-pragmas modify the code generated by the SQL
  110686. ** compiler (eg. count_changes). So add an opcode to expire all
  110687. ** compiled SQL statements after modifying a pragma value.
  110688. */
  110689. sqlite3VdbeAddOp0(v, OP_Expire);
  110690. setAllPagerFlags(db);
  110691. }
  110692. break;
  110693. }
  110694. #endif /* SQLITE_OMIT_FLAG_PRAGMAS */
  110695. #ifndef SQLITE_OMIT_SCHEMA_PRAGMAS
  110696. /*
  110697. ** PRAGMA table_info(<table>)
  110698. **
  110699. ** Return a single row for each column of the named table. The columns of
  110700. ** the returned data set are:
  110701. **
  110702. ** cid: Column id (numbered from left to right, starting at 0)
  110703. ** name: Column name
  110704. ** type: Column declaration type.
  110705. ** notnull: True if 'NOT NULL' is part of column declaration
  110706. ** dflt_value: The default value for the column, if any.
  110707. ** pk: Non-zero for PK fields.
  110708. */
  110709. case PragTyp_TABLE_INFO: if( zRight ){
  110710. Table *pTab;
  110711. pTab = sqlite3LocateTable(pParse, LOCATE_NOERR, zRight, zDb);
  110712. if( pTab ){
  110713. int i, k;
  110714. int nHidden = 0;
  110715. Column *pCol;
  110716. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  110717. pParse->nMem = 6;
  110718. sqlite3CodeVerifySchema(pParse, iDb);
  110719. sqlite3ViewGetColumnNames(pParse, pTab);
  110720. for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
  110721. if( IsHiddenColumn(pCol) ){
  110722. nHidden++;
  110723. continue;
  110724. }
  110725. if( (pCol->colFlags & COLFLAG_PRIMKEY)==0 ){
  110726. k = 0;
  110727. }else if( pPk==0 ){
  110728. k = 1;
  110729. }else{
  110730. for(k=1; k<=pTab->nCol && pPk->aiColumn[k-1]!=i; k++){}
  110731. }
  110732. assert( pCol->pDflt==0 || pCol->pDflt->op==TK_SPAN );
  110733. sqlite3VdbeMultiLoad(v, 1, "issisi",
  110734. i-nHidden,
  110735. pCol->zName,
  110736. sqlite3ColumnType(pCol,""),
  110737. pCol->notNull ? 1 : 0,
  110738. pCol->pDflt ? pCol->pDflt->u.zToken : 0,
  110739. k);
  110740. }
  110741. }
  110742. }
  110743. break;
  110744. #ifdef SQLITE_DEBUG
  110745. case PragTyp_STATS: {
  110746. Index *pIdx;
  110747. HashElem *i;
  110748. pParse->nMem = 5;
  110749. sqlite3CodeVerifySchema(pParse, iDb);
  110750. for(i=sqliteHashFirst(&pDb->pSchema->tblHash); i; i=sqliteHashNext(i)){
  110751. Table *pTab = sqliteHashData(i);
  110752. sqlite3VdbeMultiLoad(v, 1, "ssiii",
  110753. pTab->zName,
  110754. 0,
  110755. pTab->szTabRow,
  110756. pTab->nRowLogEst,
  110757. pTab->tabFlags);
  110758. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  110759. sqlite3VdbeMultiLoad(v, 2, "siiiX",
  110760. pIdx->zName,
  110761. pIdx->szIdxRow,
  110762. pIdx->aiRowLogEst[0],
  110763. pIdx->hasStat1);
  110764. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 5);
  110765. }
  110766. }
  110767. }
  110768. break;
  110769. #endif
  110770. case PragTyp_INDEX_INFO: if( zRight ){
  110771. Index *pIdx;
  110772. Table *pTab;
  110773. pIdx = sqlite3FindIndex(db, zRight, zDb);
  110774. if( pIdx ){
  110775. int i;
  110776. int mx;
  110777. if( pPragma->iArg ){
  110778. /* PRAGMA index_xinfo (newer version with more rows and columns) */
  110779. mx = pIdx->nColumn;
  110780. pParse->nMem = 6;
  110781. }else{
  110782. /* PRAGMA index_info (legacy version) */
  110783. mx = pIdx->nKeyCol;
  110784. pParse->nMem = 3;
  110785. }
  110786. pTab = pIdx->pTable;
  110787. sqlite3CodeVerifySchema(pParse, iDb);
  110788. assert( pParse->nMem<=pPragma->nPragCName );
  110789. for(i=0; i<mx; i++){
  110790. i16 cnum = pIdx->aiColumn[i];
  110791. sqlite3VdbeMultiLoad(v, 1, "iisX", i, cnum,
  110792. cnum<0 ? 0 : pTab->aCol[cnum].zName);
  110793. if( pPragma->iArg ){
  110794. sqlite3VdbeMultiLoad(v, 4, "isiX",
  110795. pIdx->aSortOrder[i],
  110796. pIdx->azColl[i],
  110797. i<pIdx->nKeyCol);
  110798. }
  110799. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, pParse->nMem);
  110800. }
  110801. }
  110802. }
  110803. break;
  110804. case PragTyp_INDEX_LIST: if( zRight ){
  110805. Index *pIdx;
  110806. Table *pTab;
  110807. int i;
  110808. pTab = sqlite3FindTable(db, zRight, zDb);
  110809. if( pTab ){
  110810. pParse->nMem = 5;
  110811. sqlite3CodeVerifySchema(pParse, iDb);
  110812. for(pIdx=pTab->pIndex, i=0; pIdx; pIdx=pIdx->pNext, i++){
  110813. const char *azOrigin[] = { "c", "u", "pk" };
  110814. sqlite3VdbeMultiLoad(v, 1, "isisi",
  110815. i,
  110816. pIdx->zName,
  110817. IsUniqueIndex(pIdx),
  110818. azOrigin[pIdx->idxType],
  110819. pIdx->pPartIdxWhere!=0);
  110820. }
  110821. }
  110822. }
  110823. break;
  110824. case PragTyp_DATABASE_LIST: {
  110825. int i;
  110826. pParse->nMem = 3;
  110827. for(i=0; i<db->nDb; i++){
  110828. if( db->aDb[i].pBt==0 ) continue;
  110829. assert( db->aDb[i].zDbSName!=0 );
  110830. sqlite3VdbeMultiLoad(v, 1, "iss",
  110831. i,
  110832. db->aDb[i].zDbSName,
  110833. sqlite3BtreeGetFilename(db->aDb[i].pBt));
  110834. }
  110835. }
  110836. break;
  110837. case PragTyp_COLLATION_LIST: {
  110838. int i = 0;
  110839. HashElem *p;
  110840. pParse->nMem = 2;
  110841. for(p=sqliteHashFirst(&db->aCollSeq); p; p=sqliteHashNext(p)){
  110842. CollSeq *pColl = (CollSeq *)sqliteHashData(p);
  110843. sqlite3VdbeMultiLoad(v, 1, "is", i++, pColl->zName);
  110844. }
  110845. }
  110846. break;
  110847. #ifdef SQLITE_INTROSPECTION_PRAGMAS
  110848. case PragTyp_FUNCTION_LIST: {
  110849. int i;
  110850. HashElem *j;
  110851. FuncDef *p;
  110852. pParse->nMem = 2;
  110853. for(i=0; i<SQLITE_FUNC_HASH_SZ; i++){
  110854. for(p=sqlite3BuiltinFunctions.a[i]; p; p=p->u.pHash ){
  110855. sqlite3VdbeMultiLoad(v, 1, "si", p->zName, 1);
  110856. }
  110857. }
  110858. for(j=sqliteHashFirst(&db->aFunc); j; j=sqliteHashNext(j)){
  110859. p = (FuncDef*)sqliteHashData(j);
  110860. sqlite3VdbeMultiLoad(v, 1, "si", p->zName, 0);
  110861. }
  110862. }
  110863. break;
  110864. #ifndef SQLITE_OMIT_VIRTUALTABLE
  110865. case PragTyp_MODULE_LIST: {
  110866. HashElem *j;
  110867. pParse->nMem = 1;
  110868. for(j=sqliteHashFirst(&db->aModule); j; j=sqliteHashNext(j)){
  110869. Module *pMod = (Module*)sqliteHashData(j);
  110870. sqlite3VdbeMultiLoad(v, 1, "s", pMod->zName);
  110871. }
  110872. }
  110873. break;
  110874. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  110875. case PragTyp_PRAGMA_LIST: {
  110876. int i;
  110877. for(i=0; i<ArraySize(aPragmaName); i++){
  110878. sqlite3VdbeMultiLoad(v, 1, "s", aPragmaName[i].zName);
  110879. }
  110880. }
  110881. break;
  110882. #endif /* SQLITE_INTROSPECTION_PRAGMAS */
  110883. #endif /* SQLITE_OMIT_SCHEMA_PRAGMAS */
  110884. #ifndef SQLITE_OMIT_FOREIGN_KEY
  110885. case PragTyp_FOREIGN_KEY_LIST: if( zRight ){
  110886. FKey *pFK;
  110887. Table *pTab;
  110888. pTab = sqlite3FindTable(db, zRight, zDb);
  110889. if( pTab ){
  110890. pFK = pTab->pFKey;
  110891. if( pFK ){
  110892. int i = 0;
  110893. pParse->nMem = 8;
  110894. sqlite3CodeVerifySchema(pParse, iDb);
  110895. while(pFK){
  110896. int j;
  110897. for(j=0; j<pFK->nCol; j++){
  110898. sqlite3VdbeMultiLoad(v, 1, "iissssss",
  110899. i,
  110900. j,
  110901. pFK->zTo,
  110902. pTab->aCol[pFK->aCol[j].iFrom].zName,
  110903. pFK->aCol[j].zCol,
  110904. actionName(pFK->aAction[1]), /* ON UPDATE */
  110905. actionName(pFK->aAction[0]), /* ON DELETE */
  110906. "NONE");
  110907. }
  110908. ++i;
  110909. pFK = pFK->pNextFrom;
  110910. }
  110911. }
  110912. }
  110913. }
  110914. break;
  110915. #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
  110916. #ifndef SQLITE_OMIT_FOREIGN_KEY
  110917. #ifndef SQLITE_OMIT_TRIGGER
  110918. case PragTyp_FOREIGN_KEY_CHECK: {
  110919. FKey *pFK; /* A foreign key constraint */
  110920. Table *pTab; /* Child table contain "REFERENCES" keyword */
  110921. Table *pParent; /* Parent table that child points to */
  110922. Index *pIdx; /* Index in the parent table */
  110923. int i; /* Loop counter: Foreign key number for pTab */
  110924. int j; /* Loop counter: Field of the foreign key */
  110925. HashElem *k; /* Loop counter: Next table in schema */
  110926. int x; /* result variable */
  110927. int regResult; /* 3 registers to hold a result row */
  110928. int regKey; /* Register to hold key for checking the FK */
  110929. int regRow; /* Registers to hold a row from pTab */
  110930. int addrTop; /* Top of a loop checking foreign keys */
  110931. int addrOk; /* Jump here if the key is OK */
  110932. int *aiCols; /* child to parent column mapping */
  110933. regResult = pParse->nMem+1;
  110934. pParse->nMem += 4;
  110935. regKey = ++pParse->nMem;
  110936. regRow = ++pParse->nMem;
  110937. sqlite3CodeVerifySchema(pParse, iDb);
  110938. k = sqliteHashFirst(&db->aDb[iDb].pSchema->tblHash);
  110939. while( k ){
  110940. if( zRight ){
  110941. pTab = sqlite3LocateTable(pParse, 0, zRight, zDb);
  110942. k = 0;
  110943. }else{
  110944. pTab = (Table*)sqliteHashData(k);
  110945. k = sqliteHashNext(k);
  110946. }
  110947. if( pTab==0 || pTab->pFKey==0 ) continue;
  110948. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  110949. if( pTab->nCol+regRow>pParse->nMem ) pParse->nMem = pTab->nCol + regRow;
  110950. sqlite3OpenTable(pParse, 0, iDb, pTab, OP_OpenRead);
  110951. sqlite3VdbeLoadString(v, regResult, pTab->zName);
  110952. for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
  110953. pParent = sqlite3FindTable(db, pFK->zTo, zDb);
  110954. if( pParent==0 ) continue;
  110955. pIdx = 0;
  110956. sqlite3TableLock(pParse, iDb, pParent->tnum, 0, pParent->zName);
  110957. x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, 0);
  110958. if( x==0 ){
  110959. if( pIdx==0 ){
  110960. sqlite3OpenTable(pParse, i, iDb, pParent, OP_OpenRead);
  110961. }else{
  110962. sqlite3VdbeAddOp3(v, OP_OpenRead, i, pIdx->tnum, iDb);
  110963. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  110964. }
  110965. }else{
  110966. k = 0;
  110967. break;
  110968. }
  110969. }
  110970. assert( pParse->nErr>0 || pFK==0 );
  110971. if( pFK ) break;
  110972. if( pParse->nTab<i ) pParse->nTab = i;
  110973. addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, 0); VdbeCoverage(v);
  110974. for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
  110975. pParent = sqlite3FindTable(db, pFK->zTo, zDb);
  110976. pIdx = 0;
  110977. aiCols = 0;
  110978. if( pParent ){
  110979. x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, &aiCols);
  110980. assert( x==0 );
  110981. }
  110982. addrOk = sqlite3VdbeMakeLabel(v);
  110983. /* Generate code to read the child key values into registers
  110984. ** regRow..regRow+n. If any of the child key values are NULL, this
  110985. ** row cannot cause an FK violation. Jump directly to addrOk in
  110986. ** this case. */
  110987. for(j=0; j<pFK->nCol; j++){
  110988. int iCol = aiCols ? aiCols[j] : pFK->aCol[j].iFrom;
  110989. sqlite3ExprCodeGetColumnOfTable(v, pTab, 0, iCol, regRow+j);
  110990. sqlite3VdbeAddOp2(v, OP_IsNull, regRow+j, addrOk); VdbeCoverage(v);
  110991. }
  110992. /* Generate code to query the parent index for a matching parent
  110993. ** key. If a match is found, jump to addrOk. */
  110994. if( pIdx ){
  110995. sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, pFK->nCol, regKey,
  110996. sqlite3IndexAffinityStr(db,pIdx), pFK->nCol);
  110997. sqlite3VdbeAddOp4Int(v, OP_Found, i, addrOk, regKey, 0);
  110998. VdbeCoverage(v);
  110999. }else if( pParent ){
  111000. int jmp = sqlite3VdbeCurrentAddr(v)+2;
  111001. sqlite3VdbeAddOp3(v, OP_SeekRowid, i, jmp, regRow); VdbeCoverage(v);
  111002. sqlite3VdbeGoto(v, addrOk);
  111003. assert( pFK->nCol==1 );
  111004. }
  111005. /* Generate code to report an FK violation to the caller. */
  111006. if( HasRowid(pTab) ){
  111007. sqlite3VdbeAddOp2(v, OP_Rowid, 0, regResult+1);
  111008. }else{
  111009. sqlite3VdbeAddOp2(v, OP_Null, 0, regResult+1);
  111010. }
  111011. sqlite3VdbeMultiLoad(v, regResult+2, "siX", pFK->zTo, i-1);
  111012. sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, 4);
  111013. sqlite3VdbeResolveLabel(v, addrOk);
  111014. sqlite3DbFree(db, aiCols);
  111015. }
  111016. sqlite3VdbeAddOp2(v, OP_Next, 0, addrTop+1); VdbeCoverage(v);
  111017. sqlite3VdbeJumpHere(v, addrTop);
  111018. }
  111019. }
  111020. break;
  111021. #endif /* !defined(SQLITE_OMIT_TRIGGER) */
  111022. #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
  111023. #ifndef NDEBUG
  111024. case PragTyp_PARSER_TRACE: {
  111025. if( zRight ){
  111026. if( sqlite3GetBoolean(zRight, 0) ){
  111027. sqlite3ParserTrace(stdout, "parser: ");
  111028. }else{
  111029. sqlite3ParserTrace(0, 0);
  111030. }
  111031. }
  111032. }
  111033. break;
  111034. #endif
  111035. /* Reinstall the LIKE and GLOB functions. The variant of LIKE
  111036. ** used will be case sensitive or not depending on the RHS.
  111037. */
  111038. case PragTyp_CASE_SENSITIVE_LIKE: {
  111039. if( zRight ){
  111040. sqlite3RegisterLikeFunctions(db, sqlite3GetBoolean(zRight, 0));
  111041. }
  111042. }
  111043. break;
  111044. #ifndef SQLITE_INTEGRITY_CHECK_ERROR_MAX
  111045. # define SQLITE_INTEGRITY_CHECK_ERROR_MAX 100
  111046. #endif
  111047. #ifndef SQLITE_OMIT_INTEGRITY_CHECK
  111048. /* PRAGMA integrity_check
  111049. ** PRAGMA integrity_check(N)
  111050. ** PRAGMA quick_check
  111051. ** PRAGMA quick_check(N)
  111052. **
  111053. ** Verify the integrity of the database.
  111054. **
  111055. ** The "quick_check" is reduced version of
  111056. ** integrity_check designed to detect most database corruption
  111057. ** without the overhead of cross-checking indexes. Quick_check
  111058. ** is linear time wherease integrity_check is O(NlogN).
  111059. */
  111060. case PragTyp_INTEGRITY_CHECK: {
  111061. int i, j, addr, mxErr;
  111062. int isQuick = (sqlite3Tolower(zLeft[0])=='q');
  111063. /* If the PRAGMA command was of the form "PRAGMA <db>.integrity_check",
  111064. ** then iDb is set to the index of the database identified by <db>.
  111065. ** In this case, the integrity of database iDb only is verified by
  111066. ** the VDBE created below.
  111067. **
  111068. ** Otherwise, if the command was simply "PRAGMA integrity_check" (or
  111069. ** "PRAGMA quick_check"), then iDb is set to 0. In this case, set iDb
  111070. ** to -1 here, to indicate that the VDBE should verify the integrity
  111071. ** of all attached databases. */
  111072. assert( iDb>=0 );
  111073. assert( iDb==0 || pId2->z );
  111074. if( pId2->z==0 ) iDb = -1;
  111075. /* Initialize the VDBE program */
  111076. pParse->nMem = 6;
  111077. /* Set the maximum error count */
  111078. mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
  111079. if( zRight ){
  111080. sqlite3GetInt32(zRight, &mxErr);
  111081. if( mxErr<=0 ){
  111082. mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
  111083. }
  111084. }
  111085. sqlite3VdbeAddOp2(v, OP_Integer, mxErr-1, 1); /* reg[1] holds errors left */
  111086. /* Do an integrity check on each database file */
  111087. for(i=0; i<db->nDb; i++){
  111088. HashElem *x; /* For looping over tables in the schema */
  111089. Hash *pTbls; /* Set of all tables in the schema */
  111090. int *aRoot; /* Array of root page numbers of all btrees */
  111091. int cnt = 0; /* Number of entries in aRoot[] */
  111092. int mxIdx = 0; /* Maximum number of indexes for any table */
  111093. if( OMIT_TEMPDB && i==1 ) continue;
  111094. if( iDb>=0 && i!=iDb ) continue;
  111095. sqlite3CodeVerifySchema(pParse, i);
  111096. /* Do an integrity check of the B-Tree
  111097. **
  111098. ** Begin by finding the root pages numbers
  111099. ** for all tables and indices in the database.
  111100. */
  111101. assert( sqlite3SchemaMutexHeld(db, i, 0) );
  111102. pTbls = &db->aDb[i].pSchema->tblHash;
  111103. for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
  111104. Table *pTab = sqliteHashData(x); /* Current table */
  111105. Index *pIdx; /* An index on pTab */
  111106. int nIdx; /* Number of indexes on pTab */
  111107. if( HasRowid(pTab) ) cnt++;
  111108. for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){ cnt++; }
  111109. if( nIdx>mxIdx ) mxIdx = nIdx;
  111110. }
  111111. aRoot = sqlite3DbMallocRawNN(db, sizeof(int)*(cnt+1));
  111112. if( aRoot==0 ) break;
  111113. for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
  111114. Table *pTab = sqliteHashData(x);
  111115. Index *pIdx;
  111116. if( HasRowid(pTab) ) aRoot[++cnt] = pTab->tnum;
  111117. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  111118. aRoot[++cnt] = pIdx->tnum;
  111119. }
  111120. }
  111121. aRoot[0] = cnt;
  111122. /* Make sure sufficient number of registers have been allocated */
  111123. pParse->nMem = MAX( pParse->nMem, 8+mxIdx );
  111124. sqlite3ClearTempRegCache(pParse);
  111125. /* Do the b-tree integrity checks */
  111126. sqlite3VdbeAddOp4(v, OP_IntegrityCk, 2, cnt, 1, (char*)aRoot,P4_INTARRAY);
  111127. sqlite3VdbeChangeP5(v, (u8)i);
  111128. addr = sqlite3VdbeAddOp1(v, OP_IsNull, 2); VdbeCoverage(v);
  111129. sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0,
  111130. sqlite3MPrintf(db, "*** in database %s ***\n", db->aDb[i].zDbSName),
  111131. P4_DYNAMIC);
  111132. sqlite3VdbeAddOp3(v, OP_Concat, 2, 3, 3);
  111133. integrityCheckResultRow(v);
  111134. sqlite3VdbeJumpHere(v, addr);
  111135. /* Make sure all the indices are constructed correctly.
  111136. */
  111137. for(x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
  111138. Table *pTab = sqliteHashData(x);
  111139. Index *pIdx, *pPk;
  111140. Index *pPrior = 0;
  111141. int loopTop;
  111142. int iDataCur, iIdxCur;
  111143. int r1 = -1;
  111144. if( pTab->tnum<1 ) continue; /* Skip VIEWs or VIRTUAL TABLEs */
  111145. pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
  111146. sqlite3ExprCacheClear(pParse);
  111147. sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenRead, 0,
  111148. 1, 0, &iDataCur, &iIdxCur);
  111149. /* reg[7] counts the number of entries in the table.
  111150. ** reg[8+i] counts the number of entries in the i-th index
  111151. */
  111152. sqlite3VdbeAddOp2(v, OP_Integer, 0, 7);
  111153. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  111154. sqlite3VdbeAddOp2(v, OP_Integer, 0, 8+j); /* index entries counter */
  111155. }
  111156. assert( pParse->nMem>=8+j );
  111157. assert( sqlite3NoTempsInRange(pParse,1,7+j) );
  111158. sqlite3VdbeAddOp2(v, OP_Rewind, iDataCur, 0); VdbeCoverage(v);
  111159. loopTop = sqlite3VdbeAddOp2(v, OP_AddImm, 7, 1);
  111160. /* Verify that all NOT NULL columns really are NOT NULL */
  111161. for(j=0; j<pTab->nCol; j++){
  111162. char *zErr;
  111163. int jmp2;
  111164. if( j==pTab->iPKey ) continue;
  111165. if( pTab->aCol[j].notNull==0 ) continue;
  111166. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, j, 3);
  111167. sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
  111168. jmp2 = sqlite3VdbeAddOp1(v, OP_NotNull, 3); VdbeCoverage(v);
  111169. zErr = sqlite3MPrintf(db, "NULL value in %s.%s", pTab->zName,
  111170. pTab->aCol[j].zName);
  111171. sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
  111172. integrityCheckResultRow(v);
  111173. sqlite3VdbeJumpHere(v, jmp2);
  111174. }
  111175. /* Verify CHECK constraints */
  111176. if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
  111177. ExprList *pCheck = sqlite3ExprListDup(db, pTab->pCheck, 0);
  111178. if( db->mallocFailed==0 ){
  111179. int addrCkFault = sqlite3VdbeMakeLabel(v);
  111180. int addrCkOk = sqlite3VdbeMakeLabel(v);
  111181. char *zErr;
  111182. int k;
  111183. pParse->iSelfTab = iDataCur + 1;
  111184. sqlite3ExprCachePush(pParse);
  111185. for(k=pCheck->nExpr-1; k>0; k--){
  111186. sqlite3ExprIfFalse(pParse, pCheck->a[k].pExpr, addrCkFault, 0);
  111187. }
  111188. sqlite3ExprIfTrue(pParse, pCheck->a[0].pExpr, addrCkOk,
  111189. SQLITE_JUMPIFNULL);
  111190. sqlite3VdbeResolveLabel(v, addrCkFault);
  111191. pParse->iSelfTab = 0;
  111192. zErr = sqlite3MPrintf(db, "CHECK constraint failed in %s",
  111193. pTab->zName);
  111194. sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
  111195. integrityCheckResultRow(v);
  111196. sqlite3VdbeResolveLabel(v, addrCkOk);
  111197. sqlite3ExprCachePop(pParse);
  111198. }
  111199. sqlite3ExprListDelete(db, pCheck);
  111200. }
  111201. if( !isQuick ){ /* Omit the remaining tests for quick_check */
  111202. /* Sanity check on record header decoding */
  111203. sqlite3VdbeAddOp3(v, OP_Column, iDataCur, pTab->nCol-1, 3);
  111204. sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
  111205. /* Validate index entries for the current row */
  111206. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  111207. int jmp2, jmp3, jmp4, jmp5;
  111208. int ckUniq = sqlite3VdbeMakeLabel(v);
  111209. if( pPk==pIdx ) continue;
  111210. r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 0, &jmp3,
  111211. pPrior, r1);
  111212. pPrior = pIdx;
  111213. sqlite3VdbeAddOp2(v, OP_AddImm, 8+j, 1);/* increment entry count */
  111214. /* Verify that an index entry exists for the current table row */
  111215. jmp2 = sqlite3VdbeAddOp4Int(v, OP_Found, iIdxCur+j, ckUniq, r1,
  111216. pIdx->nColumn); VdbeCoverage(v);
  111217. sqlite3VdbeLoadString(v, 3, "row ");
  111218. sqlite3VdbeAddOp3(v, OP_Concat, 7, 3, 3);
  111219. sqlite3VdbeLoadString(v, 4, " missing from index ");
  111220. sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
  111221. jmp5 = sqlite3VdbeLoadString(v, 4, pIdx->zName);
  111222. sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
  111223. jmp4 = integrityCheckResultRow(v);
  111224. sqlite3VdbeJumpHere(v, jmp2);
  111225. /* For UNIQUE indexes, verify that only one entry exists with the
  111226. ** current key. The entry is unique if (1) any column is NULL
  111227. ** or (2) the next entry has a different key */
  111228. if( IsUniqueIndex(pIdx) ){
  111229. int uniqOk = sqlite3VdbeMakeLabel(v);
  111230. int jmp6;
  111231. int kk;
  111232. for(kk=0; kk<pIdx->nKeyCol; kk++){
  111233. int iCol = pIdx->aiColumn[kk];
  111234. assert( iCol!=XN_ROWID && iCol<pTab->nCol );
  111235. if( iCol>=0 && pTab->aCol[iCol].notNull ) continue;
  111236. sqlite3VdbeAddOp2(v, OP_IsNull, r1+kk, uniqOk);
  111237. VdbeCoverage(v);
  111238. }
  111239. jmp6 = sqlite3VdbeAddOp1(v, OP_Next, iIdxCur+j); VdbeCoverage(v);
  111240. sqlite3VdbeGoto(v, uniqOk);
  111241. sqlite3VdbeJumpHere(v, jmp6);
  111242. sqlite3VdbeAddOp4Int(v, OP_IdxGT, iIdxCur+j, uniqOk, r1,
  111243. pIdx->nKeyCol); VdbeCoverage(v);
  111244. sqlite3VdbeLoadString(v, 3, "non-unique entry in index ");
  111245. sqlite3VdbeGoto(v, jmp5);
  111246. sqlite3VdbeResolveLabel(v, uniqOk);
  111247. }
  111248. sqlite3VdbeJumpHere(v, jmp4);
  111249. sqlite3ResolvePartIdxLabel(pParse, jmp3);
  111250. }
  111251. }
  111252. sqlite3VdbeAddOp2(v, OP_Next, iDataCur, loopTop); VdbeCoverage(v);
  111253. sqlite3VdbeJumpHere(v, loopTop-1);
  111254. #ifndef SQLITE_OMIT_BTREECOUNT
  111255. if( !isQuick ){
  111256. sqlite3VdbeLoadString(v, 2, "wrong # of entries in index ");
  111257. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  111258. if( pPk==pIdx ) continue;
  111259. sqlite3VdbeAddOp2(v, OP_Count, iIdxCur+j, 3);
  111260. addr = sqlite3VdbeAddOp3(v, OP_Eq, 8+j, 0, 3); VdbeCoverage(v);
  111261. sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
  111262. sqlite3VdbeLoadString(v, 4, pIdx->zName);
  111263. sqlite3VdbeAddOp3(v, OP_Concat, 4, 2, 3);
  111264. integrityCheckResultRow(v);
  111265. sqlite3VdbeJumpHere(v, addr);
  111266. }
  111267. }
  111268. #endif /* SQLITE_OMIT_BTREECOUNT */
  111269. }
  111270. }
  111271. {
  111272. static const int iLn = VDBE_OFFSET_LINENO(2);
  111273. static const VdbeOpList endCode[] = {
  111274. { OP_AddImm, 1, 0, 0}, /* 0 */
  111275. { OP_IfNotZero, 1, 4, 0}, /* 1 */
  111276. { OP_String8, 0, 3, 0}, /* 2 */
  111277. { OP_ResultRow, 3, 1, 0}, /* 3 */
  111278. { OP_Halt, 0, 0, 0}, /* 4 */
  111279. { OP_String8, 0, 3, 0}, /* 5 */
  111280. { OP_Goto, 0, 3, 0}, /* 6 */
  111281. };
  111282. VdbeOp *aOp;
  111283. aOp = sqlite3VdbeAddOpList(v, ArraySize(endCode), endCode, iLn);
  111284. if( aOp ){
  111285. aOp[0].p2 = 1-mxErr;
  111286. aOp[2].p4type = P4_STATIC;
  111287. aOp[2].p4.z = "ok";
  111288. aOp[5].p4type = P4_STATIC;
  111289. aOp[5].p4.z = (char*)sqlite3ErrStr(SQLITE_CORRUPT);
  111290. }
  111291. sqlite3VdbeChangeP3(v, 0, sqlite3VdbeCurrentAddr(v)-2);
  111292. }
  111293. }
  111294. break;
  111295. #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
  111296. #ifndef SQLITE_OMIT_UTF16
  111297. /*
  111298. ** PRAGMA encoding
  111299. ** PRAGMA encoding = "utf-8"|"utf-16"|"utf-16le"|"utf-16be"
  111300. **
  111301. ** In its first form, this pragma returns the encoding of the main
  111302. ** database. If the database is not initialized, it is initialized now.
  111303. **
  111304. ** The second form of this pragma is a no-op if the main database file
  111305. ** has not already been initialized. In this case it sets the default
  111306. ** encoding that will be used for the main database file if a new file
  111307. ** is created. If an existing main database file is opened, then the
  111308. ** default text encoding for the existing database is used.
  111309. **
  111310. ** In all cases new databases created using the ATTACH command are
  111311. ** created to use the same default text encoding as the main database. If
  111312. ** the main database has not been initialized and/or created when ATTACH
  111313. ** is executed, this is done before the ATTACH operation.
  111314. **
  111315. ** In the second form this pragma sets the text encoding to be used in
  111316. ** new database files created using this database handle. It is only
  111317. ** useful if invoked immediately after the main database i
  111318. */
  111319. case PragTyp_ENCODING: {
  111320. static const struct EncName {
  111321. char *zName;
  111322. u8 enc;
  111323. } encnames[] = {
  111324. { "UTF8", SQLITE_UTF8 },
  111325. { "UTF-8", SQLITE_UTF8 }, /* Must be element [1] */
  111326. { "UTF-16le", SQLITE_UTF16LE }, /* Must be element [2] */
  111327. { "UTF-16be", SQLITE_UTF16BE }, /* Must be element [3] */
  111328. { "UTF16le", SQLITE_UTF16LE },
  111329. { "UTF16be", SQLITE_UTF16BE },
  111330. { "UTF-16", 0 }, /* SQLITE_UTF16NATIVE */
  111331. { "UTF16", 0 }, /* SQLITE_UTF16NATIVE */
  111332. { 0, 0 }
  111333. };
  111334. const struct EncName *pEnc;
  111335. if( !zRight ){ /* "PRAGMA encoding" */
  111336. if( sqlite3ReadSchema(pParse) ) goto pragma_out;
  111337. assert( encnames[SQLITE_UTF8].enc==SQLITE_UTF8 );
  111338. assert( encnames[SQLITE_UTF16LE].enc==SQLITE_UTF16LE );
  111339. assert( encnames[SQLITE_UTF16BE].enc==SQLITE_UTF16BE );
  111340. returnSingleText(v, encnames[ENC(pParse->db)].zName);
  111341. }else{ /* "PRAGMA encoding = XXX" */
  111342. /* Only change the value of sqlite.enc if the database handle is not
  111343. ** initialized. If the main database exists, the new sqlite.enc value
  111344. ** will be overwritten when the schema is next loaded. If it does not
  111345. ** already exists, it will be created to use the new encoding value.
  111346. */
  111347. if(
  111348. !(DbHasProperty(db, 0, DB_SchemaLoaded)) ||
  111349. DbHasProperty(db, 0, DB_Empty)
  111350. ){
  111351. for(pEnc=&encnames[0]; pEnc->zName; pEnc++){
  111352. if( 0==sqlite3StrICmp(zRight, pEnc->zName) ){
  111353. SCHEMA_ENC(db) = ENC(db) =
  111354. pEnc->enc ? pEnc->enc : SQLITE_UTF16NATIVE;
  111355. break;
  111356. }
  111357. }
  111358. if( !pEnc->zName ){
  111359. sqlite3ErrorMsg(pParse, "unsupported encoding: %s", zRight);
  111360. }
  111361. }
  111362. }
  111363. }
  111364. break;
  111365. #endif /* SQLITE_OMIT_UTF16 */
  111366. #ifndef SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
  111367. /*
  111368. ** PRAGMA [schema.]schema_version
  111369. ** PRAGMA [schema.]schema_version = <integer>
  111370. **
  111371. ** PRAGMA [schema.]user_version
  111372. ** PRAGMA [schema.]user_version = <integer>
  111373. **
  111374. ** PRAGMA [schema.]freelist_count
  111375. **
  111376. ** PRAGMA [schema.]data_version
  111377. **
  111378. ** PRAGMA [schema.]application_id
  111379. ** PRAGMA [schema.]application_id = <integer>
  111380. **
  111381. ** The pragma's schema_version and user_version are used to set or get
  111382. ** the value of the schema-version and user-version, respectively. Both
  111383. ** the schema-version and the user-version are 32-bit signed integers
  111384. ** stored in the database header.
  111385. **
  111386. ** The schema-cookie is usually only manipulated internally by SQLite. It
  111387. ** is incremented by SQLite whenever the database schema is modified (by
  111388. ** creating or dropping a table or index). The schema version is used by
  111389. ** SQLite each time a query is executed to ensure that the internal cache
  111390. ** of the schema used when compiling the SQL query matches the schema of
  111391. ** the database against which the compiled query is actually executed.
  111392. ** Subverting this mechanism by using "PRAGMA schema_version" to modify
  111393. ** the schema-version is potentially dangerous and may lead to program
  111394. ** crashes or database corruption. Use with caution!
  111395. **
  111396. ** The user-version is not used internally by SQLite. It may be used by
  111397. ** applications for any purpose.
  111398. */
  111399. case PragTyp_HEADER_VALUE: {
  111400. int iCookie = pPragma->iArg; /* Which cookie to read or write */
  111401. sqlite3VdbeUsesBtree(v, iDb);
  111402. if( zRight && (pPragma->mPragFlg & PragFlg_ReadOnly)==0 ){
  111403. /* Write the specified cookie value */
  111404. static const VdbeOpList setCookie[] = {
  111405. { OP_Transaction, 0, 1, 0}, /* 0 */
  111406. { OP_SetCookie, 0, 0, 0}, /* 1 */
  111407. };
  111408. VdbeOp *aOp;
  111409. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setCookie));
  111410. aOp = sqlite3VdbeAddOpList(v, ArraySize(setCookie), setCookie, 0);
  111411. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  111412. aOp[0].p1 = iDb;
  111413. aOp[1].p1 = iDb;
  111414. aOp[1].p2 = iCookie;
  111415. aOp[1].p3 = sqlite3Atoi(zRight);
  111416. }else{
  111417. /* Read the specified cookie value */
  111418. static const VdbeOpList readCookie[] = {
  111419. { OP_Transaction, 0, 0, 0}, /* 0 */
  111420. { OP_ReadCookie, 0, 1, 0}, /* 1 */
  111421. { OP_ResultRow, 1, 1, 0}
  111422. };
  111423. VdbeOp *aOp;
  111424. sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(readCookie));
  111425. aOp = sqlite3VdbeAddOpList(v, ArraySize(readCookie),readCookie,0);
  111426. if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
  111427. aOp[0].p1 = iDb;
  111428. aOp[1].p1 = iDb;
  111429. aOp[1].p3 = iCookie;
  111430. sqlite3VdbeReusable(v);
  111431. }
  111432. }
  111433. break;
  111434. #endif /* SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS */
  111435. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  111436. /*
  111437. ** PRAGMA compile_options
  111438. **
  111439. ** Return the names of all compile-time options used in this build,
  111440. ** one option per row.
  111441. */
  111442. case PragTyp_COMPILE_OPTIONS: {
  111443. int i = 0;
  111444. const char *zOpt;
  111445. pParse->nMem = 1;
  111446. while( (zOpt = sqlite3_compileoption_get(i++))!=0 ){
  111447. sqlite3VdbeLoadString(v, 1, zOpt);
  111448. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
  111449. }
  111450. sqlite3VdbeReusable(v);
  111451. }
  111452. break;
  111453. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  111454. #ifndef SQLITE_OMIT_WAL
  111455. /*
  111456. ** PRAGMA [schema.]wal_checkpoint = passive|full|restart|truncate
  111457. **
  111458. ** Checkpoint the database.
  111459. */
  111460. case PragTyp_WAL_CHECKPOINT: {
  111461. int iBt = (pId2->z?iDb:SQLITE_MAX_ATTACHED);
  111462. int eMode = SQLITE_CHECKPOINT_PASSIVE;
  111463. if( zRight ){
  111464. if( sqlite3StrICmp(zRight, "full")==0 ){
  111465. eMode = SQLITE_CHECKPOINT_FULL;
  111466. }else if( sqlite3StrICmp(zRight, "restart")==0 ){
  111467. eMode = SQLITE_CHECKPOINT_RESTART;
  111468. }else if( sqlite3StrICmp(zRight, "truncate")==0 ){
  111469. eMode = SQLITE_CHECKPOINT_TRUNCATE;
  111470. }
  111471. }
  111472. pParse->nMem = 3;
  111473. sqlite3VdbeAddOp3(v, OP_Checkpoint, iBt, eMode, 1);
  111474. sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 3);
  111475. }
  111476. break;
  111477. /*
  111478. ** PRAGMA wal_autocheckpoint
  111479. ** PRAGMA wal_autocheckpoint = N
  111480. **
  111481. ** Configure a database connection to automatically checkpoint a database
  111482. ** after accumulating N frames in the log. Or query for the current value
  111483. ** of N.
  111484. */
  111485. case PragTyp_WAL_AUTOCHECKPOINT: {
  111486. if( zRight ){
  111487. sqlite3_wal_autocheckpoint(db, sqlite3Atoi(zRight));
  111488. }
  111489. returnSingleInt(v,
  111490. db->xWalCallback==sqlite3WalDefaultHook ?
  111491. SQLITE_PTR_TO_INT(db->pWalArg) : 0);
  111492. }
  111493. break;
  111494. #endif
  111495. /*
  111496. ** PRAGMA shrink_memory
  111497. **
  111498. ** IMPLEMENTATION-OF: R-23445-46109 This pragma causes the database
  111499. ** connection on which it is invoked to free up as much memory as it
  111500. ** can, by calling sqlite3_db_release_memory().
  111501. */
  111502. case PragTyp_SHRINK_MEMORY: {
  111503. sqlite3_db_release_memory(db);
  111504. break;
  111505. }
  111506. /*
  111507. ** PRAGMA optimize
  111508. ** PRAGMA optimize(MASK)
  111509. ** PRAGMA schema.optimize
  111510. ** PRAGMA schema.optimize(MASK)
  111511. **
  111512. ** Attempt to optimize the database. All schemas are optimized in the first
  111513. ** two forms, and only the specified schema is optimized in the latter two.
  111514. **
  111515. ** The details of optimizations performed by this pragma are expected
  111516. ** to change and improve over time. Applications should anticipate that
  111517. ** this pragma will perform new optimizations in future releases.
  111518. **
  111519. ** The optional argument is a bitmask of optimizations to perform:
  111520. **
  111521. ** 0x0001 Debugging mode. Do not actually perform any optimizations
  111522. ** but instead return one line of text for each optimization
  111523. ** that would have been done. Off by default.
  111524. **
  111525. ** 0x0002 Run ANALYZE on tables that might benefit. On by default.
  111526. ** See below for additional information.
  111527. **
  111528. ** 0x0004 (Not yet implemented) Record usage and performance
  111529. ** information from the current session in the
  111530. ** database file so that it will be available to "optimize"
  111531. ** pragmas run by future database connections.
  111532. **
  111533. ** 0x0008 (Not yet implemented) Create indexes that might have
  111534. ** been helpful to recent queries
  111535. **
  111536. ** The default MASK is and always shall be 0xfffe. 0xfffe means perform all
  111537. ** of the optimizations listed above except Debug Mode, including new
  111538. ** optimizations that have not yet been invented. If new optimizations are
  111539. ** ever added that should be off by default, those off-by-default
  111540. ** optimizations will have bitmasks of 0x10000 or larger.
  111541. **
  111542. ** DETERMINATION OF WHEN TO RUN ANALYZE
  111543. **
  111544. ** In the current implementation, a table is analyzed if only if all of
  111545. ** the following are true:
  111546. **
  111547. ** (1) MASK bit 0x02 is set.
  111548. **
  111549. ** (2) The query planner used sqlite_stat1-style statistics for one or
  111550. ** more indexes of the table at some point during the lifetime of
  111551. ** the current connection.
  111552. **
  111553. ** (3) One or more indexes of the table are currently unanalyzed OR
  111554. ** the number of rows in the table has increased by 25 times or more
  111555. ** since the last time ANALYZE was run.
  111556. **
  111557. ** The rules for when tables are analyzed are likely to change in
  111558. ** future releases.
  111559. */
  111560. case PragTyp_OPTIMIZE: {
  111561. int iDbLast; /* Loop termination point for the schema loop */
  111562. int iTabCur; /* Cursor for a table whose size needs checking */
  111563. HashElem *k; /* Loop over tables of a schema */
  111564. Schema *pSchema; /* The current schema */
  111565. Table *pTab; /* A table in the schema */
  111566. Index *pIdx; /* An index of the table */
  111567. LogEst szThreshold; /* Size threshold above which reanalysis is needd */
  111568. char *zSubSql; /* SQL statement for the OP_SqlExec opcode */
  111569. u32 opMask; /* Mask of operations to perform */
  111570. if( zRight ){
  111571. opMask = (u32)sqlite3Atoi(zRight);
  111572. if( (opMask & 0x02)==0 ) break;
  111573. }else{
  111574. opMask = 0xfffe;
  111575. }
  111576. iTabCur = pParse->nTab++;
  111577. for(iDbLast = zDb?iDb:db->nDb-1; iDb<=iDbLast; iDb++){
  111578. if( iDb==1 ) continue;
  111579. sqlite3CodeVerifySchema(pParse, iDb);
  111580. pSchema = db->aDb[iDb].pSchema;
  111581. for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
  111582. pTab = (Table*)sqliteHashData(k);
  111583. /* If table pTab has not been used in a way that would benefit from
  111584. ** having analysis statistics during the current session, then skip it.
  111585. ** This also has the effect of skipping virtual tables and views */
  111586. if( (pTab->tabFlags & TF_StatsUsed)==0 ) continue;
  111587. /* Reanalyze if the table is 25 times larger than the last analysis */
  111588. szThreshold = pTab->nRowLogEst + 46; assert( sqlite3LogEst(25)==46 );
  111589. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  111590. if( !pIdx->hasStat1 ){
  111591. szThreshold = 0; /* Always analyze if any index lacks statistics */
  111592. break;
  111593. }
  111594. }
  111595. if( szThreshold ){
  111596. sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
  111597. sqlite3VdbeAddOp3(v, OP_IfSmaller, iTabCur,
  111598. sqlite3VdbeCurrentAddr(v)+2+(opMask&1), szThreshold);
  111599. VdbeCoverage(v);
  111600. }
  111601. zSubSql = sqlite3MPrintf(db, "ANALYZE \"%w\".\"%w\"",
  111602. db->aDb[iDb].zDbSName, pTab->zName);
  111603. if( opMask & 0x01 ){
  111604. int r1 = sqlite3GetTempReg(pParse);
  111605. sqlite3VdbeAddOp4(v, OP_String8, 0, r1, 0, zSubSql, P4_DYNAMIC);
  111606. sqlite3VdbeAddOp2(v, OP_ResultRow, r1, 1);
  111607. }else{
  111608. sqlite3VdbeAddOp4(v, OP_SqlExec, 0, 0, 0, zSubSql, P4_DYNAMIC);
  111609. }
  111610. }
  111611. }
  111612. sqlite3VdbeAddOp0(v, OP_Expire);
  111613. break;
  111614. }
  111615. /*
  111616. ** PRAGMA busy_timeout
  111617. ** PRAGMA busy_timeout = N
  111618. **
  111619. ** Call sqlite3_busy_timeout(db, N). Return the current timeout value
  111620. ** if one is set. If no busy handler or a different busy handler is set
  111621. ** then 0 is returned. Setting the busy_timeout to 0 or negative
  111622. ** disables the timeout.
  111623. */
  111624. /*case PragTyp_BUSY_TIMEOUT*/ default: {
  111625. assert( pPragma->ePragTyp==PragTyp_BUSY_TIMEOUT );
  111626. if( zRight ){
  111627. sqlite3_busy_timeout(db, sqlite3Atoi(zRight));
  111628. }
  111629. returnSingleInt(v, db->busyTimeout);
  111630. break;
  111631. }
  111632. /*
  111633. ** PRAGMA soft_heap_limit
  111634. ** PRAGMA soft_heap_limit = N
  111635. **
  111636. ** IMPLEMENTATION-OF: R-26343-45930 This pragma invokes the
  111637. ** sqlite3_soft_heap_limit64() interface with the argument N, if N is
  111638. ** specified and is a non-negative integer.
  111639. ** IMPLEMENTATION-OF: R-64451-07163 The soft_heap_limit pragma always
  111640. ** returns the same integer that would be returned by the
  111641. ** sqlite3_soft_heap_limit64(-1) C-language function.
  111642. */
  111643. case PragTyp_SOFT_HEAP_LIMIT: {
  111644. sqlite3_int64 N;
  111645. if( zRight && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK ){
  111646. sqlite3_soft_heap_limit64(N);
  111647. }
  111648. returnSingleInt(v, sqlite3_soft_heap_limit64(-1));
  111649. break;
  111650. }
  111651. /*
  111652. ** PRAGMA threads
  111653. ** PRAGMA threads = N
  111654. **
  111655. ** Configure the maximum number of worker threads. Return the new
  111656. ** maximum, which might be less than requested.
  111657. */
  111658. case PragTyp_THREADS: {
  111659. sqlite3_int64 N;
  111660. if( zRight
  111661. && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK
  111662. && N>=0
  111663. ){
  111664. sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, (int)(N&0x7fffffff));
  111665. }
  111666. returnSingleInt(v, sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, -1));
  111667. break;
  111668. }
  111669. #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
  111670. /*
  111671. ** Report the current state of file logs for all databases
  111672. */
  111673. case PragTyp_LOCK_STATUS: {
  111674. static const char *const azLockName[] = {
  111675. "unlocked", "shared", "reserved", "pending", "exclusive"
  111676. };
  111677. int i;
  111678. pParse->nMem = 2;
  111679. for(i=0; i<db->nDb; i++){
  111680. Btree *pBt;
  111681. const char *zState = "unknown";
  111682. int j;
  111683. if( db->aDb[i].zDbSName==0 ) continue;
  111684. pBt = db->aDb[i].pBt;
  111685. if( pBt==0 || sqlite3BtreePager(pBt)==0 ){
  111686. zState = "closed";
  111687. }else if( sqlite3_file_control(db, i ? db->aDb[i].zDbSName : 0,
  111688. SQLITE_FCNTL_LOCKSTATE, &j)==SQLITE_OK ){
  111689. zState = azLockName[j];
  111690. }
  111691. sqlite3VdbeMultiLoad(v, 1, "ss", db->aDb[i].zDbSName, zState);
  111692. }
  111693. break;
  111694. }
  111695. #endif
  111696. #ifdef SQLITE_HAS_CODEC
  111697. case PragTyp_KEY: {
  111698. if( zRight ) sqlite3_key_v2(db, zDb, zRight, sqlite3Strlen30(zRight));
  111699. break;
  111700. }
  111701. case PragTyp_REKEY: {
  111702. if( zRight ) sqlite3_rekey_v2(db, zDb, zRight, sqlite3Strlen30(zRight));
  111703. break;
  111704. }
  111705. case PragTyp_HEXKEY: {
  111706. if( zRight ){
  111707. u8 iByte;
  111708. int i;
  111709. char zKey[40];
  111710. for(i=0, iByte=0; i<sizeof(zKey)*2 && sqlite3Isxdigit(zRight[i]); i++){
  111711. iByte = (iByte<<4) + sqlite3HexToInt(zRight[i]);
  111712. if( (i&1)!=0 ) zKey[i/2] = iByte;
  111713. }
  111714. if( (zLeft[3] & 0xf)==0xb ){
  111715. sqlite3_key_v2(db, zDb, zKey, i/2);
  111716. }else{
  111717. sqlite3_rekey_v2(db, zDb, zKey, i/2);
  111718. }
  111719. }
  111720. break;
  111721. }
  111722. #endif
  111723. #if defined(SQLITE_HAS_CODEC) || defined(SQLITE_ENABLE_CEROD)
  111724. case PragTyp_ACTIVATE_EXTENSIONS: if( zRight ){
  111725. #ifdef SQLITE_HAS_CODEC
  111726. if( sqlite3StrNICmp(zRight, "see-", 4)==0 ){
  111727. sqlite3_activate_see(&zRight[4]);
  111728. }
  111729. #endif
  111730. #ifdef SQLITE_ENABLE_CEROD
  111731. if( sqlite3StrNICmp(zRight, "cerod-", 6)==0 ){
  111732. sqlite3_activate_cerod(&zRight[6]);
  111733. }
  111734. #endif
  111735. }
  111736. break;
  111737. #endif
  111738. } /* End of the PRAGMA switch */
  111739. /* The following block is a no-op unless SQLITE_DEBUG is defined. Its only
  111740. ** purpose is to execute assert() statements to verify that if the
  111741. ** PragFlg_NoColumns1 flag is set and the caller specified an argument
  111742. ** to the PRAGMA, the implementation has not added any OP_ResultRow
  111743. ** instructions to the VM. */
  111744. if( (pPragma->mPragFlg & PragFlg_NoColumns1) && zRight ){
  111745. sqlite3VdbeVerifyNoResultRow(v);
  111746. }
  111747. pragma_out:
  111748. sqlite3DbFree(db, zLeft);
  111749. sqlite3DbFree(db, zRight);
  111750. }
  111751. #ifndef SQLITE_OMIT_VIRTUALTABLE
  111752. /*****************************************************************************
  111753. ** Implementation of an eponymous virtual table that runs a pragma.
  111754. **
  111755. */
  111756. typedef struct PragmaVtab PragmaVtab;
  111757. typedef struct PragmaVtabCursor PragmaVtabCursor;
  111758. struct PragmaVtab {
  111759. sqlite3_vtab base; /* Base class. Must be first */
  111760. sqlite3 *db; /* The database connection to which it belongs */
  111761. const PragmaName *pName; /* Name of the pragma */
  111762. u8 nHidden; /* Number of hidden columns */
  111763. u8 iHidden; /* Index of the first hidden column */
  111764. };
  111765. struct PragmaVtabCursor {
  111766. sqlite3_vtab_cursor base; /* Base class. Must be first */
  111767. sqlite3_stmt *pPragma; /* The pragma statement to run */
  111768. sqlite_int64 iRowid; /* Current rowid */
  111769. char *azArg[2]; /* Value of the argument and schema */
  111770. };
  111771. /*
  111772. ** Pragma virtual table module xConnect method.
  111773. */
  111774. static int pragmaVtabConnect(
  111775. sqlite3 *db,
  111776. void *pAux,
  111777. int argc, const char *const*argv,
  111778. sqlite3_vtab **ppVtab,
  111779. char **pzErr
  111780. ){
  111781. const PragmaName *pPragma = (const PragmaName*)pAux;
  111782. PragmaVtab *pTab = 0;
  111783. int rc;
  111784. int i, j;
  111785. char cSep = '(';
  111786. StrAccum acc;
  111787. char zBuf[200];
  111788. UNUSED_PARAMETER(argc);
  111789. UNUSED_PARAMETER(argv);
  111790. sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
  111791. sqlite3StrAccumAppendAll(&acc, "CREATE TABLE x");
  111792. for(i=0, j=pPragma->iPragCName; i<pPragma->nPragCName; i++, j++){
  111793. sqlite3XPrintf(&acc, "%c\"%s\"", cSep, pragCName[j]);
  111794. cSep = ',';
  111795. }
  111796. if( i==0 ){
  111797. sqlite3XPrintf(&acc, "(\"%s\"", pPragma->zName);
  111798. cSep = ',';
  111799. i++;
  111800. }
  111801. j = 0;
  111802. if( pPragma->mPragFlg & PragFlg_Result1 ){
  111803. sqlite3StrAccumAppendAll(&acc, ",arg HIDDEN");
  111804. j++;
  111805. }
  111806. if( pPragma->mPragFlg & (PragFlg_SchemaOpt|PragFlg_SchemaReq) ){
  111807. sqlite3StrAccumAppendAll(&acc, ",schema HIDDEN");
  111808. j++;
  111809. }
  111810. sqlite3StrAccumAppend(&acc, ")", 1);
  111811. sqlite3StrAccumFinish(&acc);
  111812. assert( strlen(zBuf) < sizeof(zBuf)-1 );
  111813. rc = sqlite3_declare_vtab(db, zBuf);
  111814. if( rc==SQLITE_OK ){
  111815. pTab = (PragmaVtab*)sqlite3_malloc(sizeof(PragmaVtab));
  111816. if( pTab==0 ){
  111817. rc = SQLITE_NOMEM;
  111818. }else{
  111819. memset(pTab, 0, sizeof(PragmaVtab));
  111820. pTab->pName = pPragma;
  111821. pTab->db = db;
  111822. pTab->iHidden = i;
  111823. pTab->nHidden = j;
  111824. }
  111825. }else{
  111826. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  111827. }
  111828. *ppVtab = (sqlite3_vtab*)pTab;
  111829. return rc;
  111830. }
  111831. /*
  111832. ** Pragma virtual table module xDisconnect method.
  111833. */
  111834. static int pragmaVtabDisconnect(sqlite3_vtab *pVtab){
  111835. PragmaVtab *pTab = (PragmaVtab*)pVtab;
  111836. sqlite3_free(pTab);
  111837. return SQLITE_OK;
  111838. }
  111839. /* Figure out the best index to use to search a pragma virtual table.
  111840. **
  111841. ** There are not really any index choices. But we want to encourage the
  111842. ** query planner to give == constraints on as many hidden parameters as
  111843. ** possible, and especially on the first hidden parameter. So return a
  111844. ** high cost if hidden parameters are unconstrained.
  111845. */
  111846. static int pragmaVtabBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
  111847. PragmaVtab *pTab = (PragmaVtab*)tab;
  111848. const struct sqlite3_index_constraint *pConstraint;
  111849. int i, j;
  111850. int seen[2];
  111851. pIdxInfo->estimatedCost = (double)1;
  111852. if( pTab->nHidden==0 ){ return SQLITE_OK; }
  111853. pConstraint = pIdxInfo->aConstraint;
  111854. seen[0] = 0;
  111855. seen[1] = 0;
  111856. for(i=0; i<pIdxInfo->nConstraint; i++, pConstraint++){
  111857. if( pConstraint->usable==0 ) continue;
  111858. if( pConstraint->op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
  111859. if( pConstraint->iColumn < pTab->iHidden ) continue;
  111860. j = pConstraint->iColumn - pTab->iHidden;
  111861. assert( j < 2 );
  111862. seen[j] = i+1;
  111863. }
  111864. if( seen[0]==0 ){
  111865. pIdxInfo->estimatedCost = (double)2147483647;
  111866. pIdxInfo->estimatedRows = 2147483647;
  111867. return SQLITE_OK;
  111868. }
  111869. j = seen[0]-1;
  111870. pIdxInfo->aConstraintUsage[j].argvIndex = 1;
  111871. pIdxInfo->aConstraintUsage[j].omit = 1;
  111872. if( seen[1]==0 ) return SQLITE_OK;
  111873. pIdxInfo->estimatedCost = (double)20;
  111874. pIdxInfo->estimatedRows = 20;
  111875. j = seen[1]-1;
  111876. pIdxInfo->aConstraintUsage[j].argvIndex = 2;
  111877. pIdxInfo->aConstraintUsage[j].omit = 1;
  111878. return SQLITE_OK;
  111879. }
  111880. /* Create a new cursor for the pragma virtual table */
  111881. static int pragmaVtabOpen(sqlite3_vtab *pVtab, sqlite3_vtab_cursor **ppCursor){
  111882. PragmaVtabCursor *pCsr;
  111883. pCsr = (PragmaVtabCursor*)sqlite3_malloc(sizeof(*pCsr));
  111884. if( pCsr==0 ) return SQLITE_NOMEM;
  111885. memset(pCsr, 0, sizeof(PragmaVtabCursor));
  111886. pCsr->base.pVtab = pVtab;
  111887. *ppCursor = &pCsr->base;
  111888. return SQLITE_OK;
  111889. }
  111890. /* Clear all content from pragma virtual table cursor. */
  111891. static void pragmaVtabCursorClear(PragmaVtabCursor *pCsr){
  111892. int i;
  111893. sqlite3_finalize(pCsr->pPragma);
  111894. pCsr->pPragma = 0;
  111895. for(i=0; i<ArraySize(pCsr->azArg); i++){
  111896. sqlite3_free(pCsr->azArg[i]);
  111897. pCsr->azArg[i] = 0;
  111898. }
  111899. }
  111900. /* Close a pragma virtual table cursor */
  111901. static int pragmaVtabClose(sqlite3_vtab_cursor *cur){
  111902. PragmaVtabCursor *pCsr = (PragmaVtabCursor*)cur;
  111903. pragmaVtabCursorClear(pCsr);
  111904. sqlite3_free(pCsr);
  111905. return SQLITE_OK;
  111906. }
  111907. /* Advance the pragma virtual table cursor to the next row */
  111908. static int pragmaVtabNext(sqlite3_vtab_cursor *pVtabCursor){
  111909. PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
  111910. int rc = SQLITE_OK;
  111911. /* Increment the xRowid value */
  111912. pCsr->iRowid++;
  111913. assert( pCsr->pPragma );
  111914. if( SQLITE_ROW!=sqlite3_step(pCsr->pPragma) ){
  111915. rc = sqlite3_finalize(pCsr->pPragma);
  111916. pCsr->pPragma = 0;
  111917. pragmaVtabCursorClear(pCsr);
  111918. }
  111919. return rc;
  111920. }
  111921. /*
  111922. ** Pragma virtual table module xFilter method.
  111923. */
  111924. static int pragmaVtabFilter(
  111925. sqlite3_vtab_cursor *pVtabCursor,
  111926. int idxNum, const char *idxStr,
  111927. int argc, sqlite3_value **argv
  111928. ){
  111929. PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
  111930. PragmaVtab *pTab = (PragmaVtab*)(pVtabCursor->pVtab);
  111931. int rc;
  111932. int i, j;
  111933. StrAccum acc;
  111934. char *zSql;
  111935. UNUSED_PARAMETER(idxNum);
  111936. UNUSED_PARAMETER(idxStr);
  111937. pragmaVtabCursorClear(pCsr);
  111938. j = (pTab->pName->mPragFlg & PragFlg_Result1)!=0 ? 0 : 1;
  111939. for(i=0; i<argc; i++, j++){
  111940. const char *zText = (const char*)sqlite3_value_text(argv[i]);
  111941. assert( j<ArraySize(pCsr->azArg) );
  111942. assert( pCsr->azArg[j]==0 );
  111943. if( zText ){
  111944. pCsr->azArg[j] = sqlite3_mprintf("%s", zText);
  111945. if( pCsr->azArg[j]==0 ){
  111946. return SQLITE_NOMEM;
  111947. }
  111948. }
  111949. }
  111950. sqlite3StrAccumInit(&acc, 0, 0, 0, pTab->db->aLimit[SQLITE_LIMIT_SQL_LENGTH]);
  111951. sqlite3StrAccumAppendAll(&acc, "PRAGMA ");
  111952. if( pCsr->azArg[1] ){
  111953. sqlite3XPrintf(&acc, "%Q.", pCsr->azArg[1]);
  111954. }
  111955. sqlite3StrAccumAppendAll(&acc, pTab->pName->zName);
  111956. if( pCsr->azArg[0] ){
  111957. sqlite3XPrintf(&acc, "=%Q", pCsr->azArg[0]);
  111958. }
  111959. zSql = sqlite3StrAccumFinish(&acc);
  111960. if( zSql==0 ) return SQLITE_NOMEM;
  111961. rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pCsr->pPragma, 0);
  111962. sqlite3_free(zSql);
  111963. if( rc!=SQLITE_OK ){
  111964. pTab->base.zErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(pTab->db));
  111965. return rc;
  111966. }
  111967. return pragmaVtabNext(pVtabCursor);
  111968. }
  111969. /*
  111970. ** Pragma virtual table module xEof method.
  111971. */
  111972. static int pragmaVtabEof(sqlite3_vtab_cursor *pVtabCursor){
  111973. PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
  111974. return (pCsr->pPragma==0);
  111975. }
  111976. /* The xColumn method simply returns the corresponding column from
  111977. ** the PRAGMA.
  111978. */
  111979. static int pragmaVtabColumn(
  111980. sqlite3_vtab_cursor *pVtabCursor,
  111981. sqlite3_context *ctx,
  111982. int i
  111983. ){
  111984. PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
  111985. PragmaVtab *pTab = (PragmaVtab*)(pVtabCursor->pVtab);
  111986. if( i<pTab->iHidden ){
  111987. sqlite3_result_value(ctx, sqlite3_column_value(pCsr->pPragma, i));
  111988. }else{
  111989. sqlite3_result_text(ctx, pCsr->azArg[i-pTab->iHidden],-1,SQLITE_TRANSIENT);
  111990. }
  111991. return SQLITE_OK;
  111992. }
  111993. /*
  111994. ** Pragma virtual table module xRowid method.
  111995. */
  111996. static int pragmaVtabRowid(sqlite3_vtab_cursor *pVtabCursor, sqlite_int64 *p){
  111997. PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
  111998. *p = pCsr->iRowid;
  111999. return SQLITE_OK;
  112000. }
  112001. /* The pragma virtual table object */
  112002. static const sqlite3_module pragmaVtabModule = {
  112003. 0, /* iVersion */
  112004. 0, /* xCreate - create a table */
  112005. pragmaVtabConnect, /* xConnect - connect to an existing table */
  112006. pragmaVtabBestIndex, /* xBestIndex - Determine search strategy */
  112007. pragmaVtabDisconnect, /* xDisconnect - Disconnect from a table */
  112008. 0, /* xDestroy - Drop a table */
  112009. pragmaVtabOpen, /* xOpen - open a cursor */
  112010. pragmaVtabClose, /* xClose - close a cursor */
  112011. pragmaVtabFilter, /* xFilter - configure scan constraints */
  112012. pragmaVtabNext, /* xNext - advance a cursor */
  112013. pragmaVtabEof, /* xEof */
  112014. pragmaVtabColumn, /* xColumn - read data */
  112015. pragmaVtabRowid, /* xRowid - read data */
  112016. 0, /* xUpdate - write data */
  112017. 0, /* xBegin - begin transaction */
  112018. 0, /* xSync - sync transaction */
  112019. 0, /* xCommit - commit transaction */
  112020. 0, /* xRollback - rollback transaction */
  112021. 0, /* xFindFunction - function overloading */
  112022. 0, /* xRename - rename the table */
  112023. 0, /* xSavepoint */
  112024. 0, /* xRelease */
  112025. 0 /* xRollbackTo */
  112026. };
  112027. /*
  112028. ** Check to see if zTabName is really the name of a pragma. If it is,
  112029. ** then register an eponymous virtual table for that pragma and return
  112030. ** a pointer to the Module object for the new virtual table.
  112031. */
  112032. SQLITE_PRIVATE Module *sqlite3PragmaVtabRegister(sqlite3 *db, const char *zName){
  112033. const PragmaName *pName;
  112034. assert( sqlite3_strnicmp(zName, "pragma_", 7)==0 );
  112035. pName = pragmaLocate(zName+7);
  112036. if( pName==0 ) return 0;
  112037. if( (pName->mPragFlg & (PragFlg_Result0|PragFlg_Result1))==0 ) return 0;
  112038. assert( sqlite3HashFind(&db->aModule, zName)==0 );
  112039. return sqlite3VtabCreateModule(db, zName, &pragmaVtabModule, (void*)pName, 0);
  112040. }
  112041. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  112042. #endif /* SQLITE_OMIT_PRAGMA */
  112043. /************** End of pragma.c **********************************************/
  112044. /************** Begin file prepare.c *****************************************/
  112045. /*
  112046. ** 2005 May 25
  112047. **
  112048. ** The author disclaims copyright to this source code. In place of
  112049. ** a legal notice, here is a blessing:
  112050. **
  112051. ** May you do good and not evil.
  112052. ** May you find forgiveness for yourself and forgive others.
  112053. ** May you share freely, never taking more than you give.
  112054. **
  112055. *************************************************************************
  112056. ** This file contains the implementation of the sqlite3_prepare()
  112057. ** interface, and routines that contribute to loading the database schema
  112058. ** from disk.
  112059. */
  112060. /* #include "sqliteInt.h" */
  112061. /*
  112062. ** Fill the InitData structure with an error message that indicates
  112063. ** that the database is corrupt.
  112064. */
  112065. static void corruptSchema(
  112066. InitData *pData, /* Initialization context */
  112067. const char *zObj, /* Object being parsed at the point of error */
  112068. const char *zExtra /* Error information */
  112069. ){
  112070. sqlite3 *db = pData->db;
  112071. if( !db->mallocFailed && (db->flags & SQLITE_WriteSchema)==0 ){
  112072. char *z;
  112073. if( zObj==0 ) zObj = "?";
  112074. z = sqlite3MPrintf(db, "malformed database schema (%s)", zObj);
  112075. if( zExtra && zExtra[0] ) z = sqlite3MPrintf(db, "%z - %s", z, zExtra);
  112076. sqlite3DbFree(db, *pData->pzErrMsg);
  112077. *pData->pzErrMsg = z;
  112078. }
  112079. pData->rc = db->mallocFailed ? SQLITE_NOMEM_BKPT : SQLITE_CORRUPT_BKPT;
  112080. }
  112081. /*
  112082. ** This is the callback routine for the code that initializes the
  112083. ** database. See sqlite3Init() below for additional information.
  112084. ** This routine is also called from the OP_ParseSchema opcode of the VDBE.
  112085. **
  112086. ** Each callback contains the following information:
  112087. **
  112088. ** argv[0] = name of thing being created
  112089. ** argv[1] = root page number for table or index. 0 for trigger or view.
  112090. ** argv[2] = SQL text for the CREATE statement.
  112091. **
  112092. */
  112093. SQLITE_PRIVATE int sqlite3InitCallback(void *pInit, int argc, char **argv, char **NotUsed){
  112094. InitData *pData = (InitData*)pInit;
  112095. sqlite3 *db = pData->db;
  112096. int iDb = pData->iDb;
  112097. assert( argc==3 );
  112098. UNUSED_PARAMETER2(NotUsed, argc);
  112099. assert( sqlite3_mutex_held(db->mutex) );
  112100. DbClearProperty(db, iDb, DB_Empty);
  112101. if( db->mallocFailed ){
  112102. corruptSchema(pData, argv[0], 0);
  112103. return 1;
  112104. }
  112105. assert( iDb>=0 && iDb<db->nDb );
  112106. if( argv==0 ) return 0; /* Might happen if EMPTY_RESULT_CALLBACKS are on */
  112107. if( argv[1]==0 ){
  112108. corruptSchema(pData, argv[0], 0);
  112109. }else if( sqlite3_strnicmp(argv[2],"create ",7)==0 ){
  112110. /* Call the parser to process a CREATE TABLE, INDEX or VIEW.
  112111. ** But because db->init.busy is set to 1, no VDBE code is generated
  112112. ** or executed. All the parser does is build the internal data
  112113. ** structures that describe the table, index, or view.
  112114. */
  112115. int rc;
  112116. u8 saved_iDb = db->init.iDb;
  112117. sqlite3_stmt *pStmt;
  112118. TESTONLY(int rcp); /* Return code from sqlite3_prepare() */
  112119. assert( db->init.busy );
  112120. db->init.iDb = iDb;
  112121. db->init.newTnum = sqlite3Atoi(argv[1]);
  112122. db->init.orphanTrigger = 0;
  112123. TESTONLY(rcp = ) sqlite3_prepare(db, argv[2], -1, &pStmt, 0);
  112124. rc = db->errCode;
  112125. assert( (rc&0xFF)==(rcp&0xFF) );
  112126. db->init.iDb = saved_iDb;
  112127. assert( saved_iDb==0 || (db->mDbFlags & DBFLAG_Vacuum)!=0 );
  112128. if( SQLITE_OK!=rc ){
  112129. if( db->init.orphanTrigger ){
  112130. assert( iDb==1 );
  112131. }else{
  112132. pData->rc = rc;
  112133. if( rc==SQLITE_NOMEM ){
  112134. sqlite3OomFault(db);
  112135. }else if( rc!=SQLITE_INTERRUPT && (rc&0xFF)!=SQLITE_LOCKED ){
  112136. corruptSchema(pData, argv[0], sqlite3_errmsg(db));
  112137. }
  112138. }
  112139. }
  112140. sqlite3_finalize(pStmt);
  112141. }else if( argv[0]==0 || (argv[2]!=0 && argv[2][0]!=0) ){
  112142. corruptSchema(pData, argv[0], 0);
  112143. }else{
  112144. /* If the SQL column is blank it means this is an index that
  112145. ** was created to be the PRIMARY KEY or to fulfill a UNIQUE
  112146. ** constraint for a CREATE TABLE. The index should have already
  112147. ** been created when we processed the CREATE TABLE. All we have
  112148. ** to do here is record the root page number for that index.
  112149. */
  112150. Index *pIndex;
  112151. pIndex = sqlite3FindIndex(db, argv[0], db->aDb[iDb].zDbSName);
  112152. if( pIndex==0 ){
  112153. /* This can occur if there exists an index on a TEMP table which
  112154. ** has the same name as another index on a permanent index. Since
  112155. ** the permanent table is hidden by the TEMP table, we can also
  112156. ** safely ignore the index on the permanent table.
  112157. */
  112158. /* Do Nothing */;
  112159. }else if( sqlite3GetInt32(argv[1], &pIndex->tnum)==0 ){
  112160. corruptSchema(pData, argv[0], "invalid rootpage");
  112161. }
  112162. }
  112163. return 0;
  112164. }
  112165. /*
  112166. ** Attempt to read the database schema and initialize internal
  112167. ** data structures for a single database file. The index of the
  112168. ** database file is given by iDb. iDb==0 is used for the main
  112169. ** database. iDb==1 should never be used. iDb>=2 is used for
  112170. ** auxiliary databases. Return one of the SQLITE_ error codes to
  112171. ** indicate success or failure.
  112172. */
  112173. static int sqlite3InitOne(sqlite3 *db, int iDb, char **pzErrMsg){
  112174. int rc;
  112175. int i;
  112176. #ifndef SQLITE_OMIT_DEPRECATED
  112177. int size;
  112178. #endif
  112179. Db *pDb;
  112180. char const *azArg[4];
  112181. int meta[5];
  112182. InitData initData;
  112183. const char *zMasterName;
  112184. int openedTransaction = 0;
  112185. assert( iDb>=0 && iDb<db->nDb );
  112186. assert( db->aDb[iDb].pSchema );
  112187. assert( sqlite3_mutex_held(db->mutex) );
  112188. assert( iDb==1 || sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
  112189. db->init.busy = 1;
  112190. /* Construct the in-memory representation schema tables (sqlite_master or
  112191. ** sqlite_temp_master) by invoking the parser directly. The appropriate
  112192. ** table name will be inserted automatically by the parser so we can just
  112193. ** use the abbreviation "x" here. The parser will also automatically tag
  112194. ** the schema table as read-only. */
  112195. azArg[0] = zMasterName = SCHEMA_TABLE(iDb);
  112196. azArg[1] = "1";
  112197. azArg[2] = "CREATE TABLE x(type text,name text,tbl_name text,"
  112198. "rootpage int,sql text)";
  112199. azArg[3] = 0;
  112200. initData.db = db;
  112201. initData.iDb = iDb;
  112202. initData.rc = SQLITE_OK;
  112203. initData.pzErrMsg = pzErrMsg;
  112204. sqlite3InitCallback(&initData, 3, (char **)azArg, 0);
  112205. if( initData.rc ){
  112206. rc = initData.rc;
  112207. goto error_out;
  112208. }
  112209. /* Create a cursor to hold the database open
  112210. */
  112211. pDb = &db->aDb[iDb];
  112212. if( pDb->pBt==0 ){
  112213. assert( iDb==1 );
  112214. DbSetProperty(db, 1, DB_SchemaLoaded);
  112215. rc = SQLITE_OK;
  112216. goto error_out;
  112217. }
  112218. /* If there is not already a read-only (or read-write) transaction opened
  112219. ** on the b-tree database, open one now. If a transaction is opened, it
  112220. ** will be closed before this function returns. */
  112221. sqlite3BtreeEnter(pDb->pBt);
  112222. if( !sqlite3BtreeIsInReadTrans(pDb->pBt) ){
  112223. rc = sqlite3BtreeBeginTrans(pDb->pBt, 0);
  112224. if( rc!=SQLITE_OK ){
  112225. sqlite3SetString(pzErrMsg, db, sqlite3ErrStr(rc));
  112226. goto initone_error_out;
  112227. }
  112228. openedTransaction = 1;
  112229. }
  112230. /* Get the database meta information.
  112231. **
  112232. ** Meta values are as follows:
  112233. ** meta[0] Schema cookie. Changes with each schema change.
  112234. ** meta[1] File format of schema layer.
  112235. ** meta[2] Size of the page cache.
  112236. ** meta[3] Largest rootpage (auto/incr_vacuum mode)
  112237. ** meta[4] Db text encoding. 1:UTF-8 2:UTF-16LE 3:UTF-16BE
  112238. ** meta[5] User version
  112239. ** meta[6] Incremental vacuum mode
  112240. ** meta[7] unused
  112241. ** meta[8] unused
  112242. ** meta[9] unused
  112243. **
  112244. ** Note: The #defined SQLITE_UTF* symbols in sqliteInt.h correspond to
  112245. ** the possible values of meta[4].
  112246. */
  112247. for(i=0; i<ArraySize(meta); i++){
  112248. sqlite3BtreeGetMeta(pDb->pBt, i+1, (u32 *)&meta[i]);
  112249. }
  112250. pDb->pSchema->schema_cookie = meta[BTREE_SCHEMA_VERSION-1];
  112251. /* If opening a non-empty database, check the text encoding. For the
  112252. ** main database, set sqlite3.enc to the encoding of the main database.
  112253. ** For an attached db, it is an error if the encoding is not the same
  112254. ** as sqlite3.enc.
  112255. */
  112256. if( meta[BTREE_TEXT_ENCODING-1] ){ /* text encoding */
  112257. if( iDb==0 ){
  112258. #ifndef SQLITE_OMIT_UTF16
  112259. u8 encoding;
  112260. /* If opening the main database, set ENC(db). */
  112261. encoding = (u8)meta[BTREE_TEXT_ENCODING-1] & 3;
  112262. if( encoding==0 ) encoding = SQLITE_UTF8;
  112263. ENC(db) = encoding;
  112264. #else
  112265. ENC(db) = SQLITE_UTF8;
  112266. #endif
  112267. }else{
  112268. /* If opening an attached database, the encoding much match ENC(db) */
  112269. if( meta[BTREE_TEXT_ENCODING-1]!=ENC(db) ){
  112270. sqlite3SetString(pzErrMsg, db, "attached databases must use the same"
  112271. " text encoding as main database");
  112272. rc = SQLITE_ERROR;
  112273. goto initone_error_out;
  112274. }
  112275. }
  112276. }else{
  112277. DbSetProperty(db, iDb, DB_Empty);
  112278. }
  112279. pDb->pSchema->enc = ENC(db);
  112280. if( pDb->pSchema->cache_size==0 ){
  112281. #ifndef SQLITE_OMIT_DEPRECATED
  112282. size = sqlite3AbsInt32(meta[BTREE_DEFAULT_CACHE_SIZE-1]);
  112283. if( size==0 ){ size = SQLITE_DEFAULT_CACHE_SIZE; }
  112284. pDb->pSchema->cache_size = size;
  112285. #else
  112286. pDb->pSchema->cache_size = SQLITE_DEFAULT_CACHE_SIZE;
  112287. #endif
  112288. sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
  112289. }
  112290. /*
  112291. ** file_format==1 Version 3.0.0.
  112292. ** file_format==2 Version 3.1.3. // ALTER TABLE ADD COLUMN
  112293. ** file_format==3 Version 3.1.4. // ditto but with non-NULL defaults
  112294. ** file_format==4 Version 3.3.0. // DESC indices. Boolean constants
  112295. */
  112296. pDb->pSchema->file_format = (u8)meta[BTREE_FILE_FORMAT-1];
  112297. if( pDb->pSchema->file_format==0 ){
  112298. pDb->pSchema->file_format = 1;
  112299. }
  112300. if( pDb->pSchema->file_format>SQLITE_MAX_FILE_FORMAT ){
  112301. sqlite3SetString(pzErrMsg, db, "unsupported file format");
  112302. rc = SQLITE_ERROR;
  112303. goto initone_error_out;
  112304. }
  112305. /* Ticket #2804: When we open a database in the newer file format,
  112306. ** clear the legacy_file_format pragma flag so that a VACUUM will
  112307. ** not downgrade the database and thus invalidate any descending
  112308. ** indices that the user might have created.
  112309. */
  112310. if( iDb==0 && meta[BTREE_FILE_FORMAT-1]>=4 ){
  112311. db->flags &= ~SQLITE_LegacyFileFmt;
  112312. }
  112313. /* Read the schema information out of the schema tables
  112314. */
  112315. assert( db->init.busy );
  112316. {
  112317. char *zSql;
  112318. zSql = sqlite3MPrintf(db,
  112319. "SELECT name, rootpage, sql FROM \"%w\".%s ORDER BY rowid",
  112320. db->aDb[iDb].zDbSName, zMasterName);
  112321. #ifndef SQLITE_OMIT_AUTHORIZATION
  112322. {
  112323. sqlite3_xauth xAuth;
  112324. xAuth = db->xAuth;
  112325. db->xAuth = 0;
  112326. #endif
  112327. rc = sqlite3_exec(db, zSql, sqlite3InitCallback, &initData, 0);
  112328. #ifndef SQLITE_OMIT_AUTHORIZATION
  112329. db->xAuth = xAuth;
  112330. }
  112331. #endif
  112332. if( rc==SQLITE_OK ) rc = initData.rc;
  112333. sqlite3DbFree(db, zSql);
  112334. #ifndef SQLITE_OMIT_ANALYZE
  112335. if( rc==SQLITE_OK ){
  112336. sqlite3AnalysisLoad(db, iDb);
  112337. }
  112338. #endif
  112339. }
  112340. if( db->mallocFailed ){
  112341. rc = SQLITE_NOMEM_BKPT;
  112342. sqlite3ResetAllSchemasOfConnection(db);
  112343. }
  112344. if( rc==SQLITE_OK || (db->flags&SQLITE_WriteSchema)){
  112345. /* Black magic: If the SQLITE_WriteSchema flag is set, then consider
  112346. ** the schema loaded, even if errors occurred. In this situation the
  112347. ** current sqlite3_prepare() operation will fail, but the following one
  112348. ** will attempt to compile the supplied statement against whatever subset
  112349. ** of the schema was loaded before the error occurred. The primary
  112350. ** purpose of this is to allow access to the sqlite_master table
  112351. ** even when its contents have been corrupted.
  112352. */
  112353. DbSetProperty(db, iDb, DB_SchemaLoaded);
  112354. rc = SQLITE_OK;
  112355. }
  112356. /* Jump here for an error that occurs after successfully allocating
  112357. ** curMain and calling sqlite3BtreeEnter(). For an error that occurs
  112358. ** before that point, jump to error_out.
  112359. */
  112360. initone_error_out:
  112361. if( openedTransaction ){
  112362. sqlite3BtreeCommit(pDb->pBt);
  112363. }
  112364. sqlite3BtreeLeave(pDb->pBt);
  112365. error_out:
  112366. if( rc ){
  112367. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
  112368. sqlite3OomFault(db);
  112369. }
  112370. sqlite3ResetOneSchema(db, iDb);
  112371. }
  112372. db->init.busy = 0;
  112373. return rc;
  112374. }
  112375. /*
  112376. ** Initialize all database files - the main database file, the file
  112377. ** used to store temporary tables, and any additional database files
  112378. ** created using ATTACH statements. Return a success code. If an
  112379. ** error occurs, write an error message into *pzErrMsg.
  112380. **
  112381. ** After a database is initialized, the DB_SchemaLoaded bit is set
  112382. ** bit is set in the flags field of the Db structure. If the database
  112383. ** file was of zero-length, then the DB_Empty flag is also set.
  112384. */
  112385. SQLITE_PRIVATE int sqlite3Init(sqlite3 *db, char **pzErrMsg){
  112386. int i, rc;
  112387. int commit_internal = !(db->mDbFlags&DBFLAG_SchemaChange);
  112388. assert( sqlite3_mutex_held(db->mutex) );
  112389. assert( sqlite3BtreeHoldsMutex(db->aDb[0].pBt) );
  112390. assert( db->init.busy==0 );
  112391. ENC(db) = SCHEMA_ENC(db);
  112392. assert( db->nDb>0 );
  112393. /* Do the main schema first */
  112394. if( !DbHasProperty(db, 0, DB_SchemaLoaded) ){
  112395. rc = sqlite3InitOne(db, 0, pzErrMsg);
  112396. if( rc ) return rc;
  112397. }
  112398. /* All other schemas after the main schema. The "temp" schema must be last */
  112399. for(i=db->nDb-1; i>0; i--){
  112400. if( !DbHasProperty(db, i, DB_SchemaLoaded) ){
  112401. rc = sqlite3InitOne(db, i, pzErrMsg);
  112402. if( rc ) return rc;
  112403. }
  112404. }
  112405. if( commit_internal ){
  112406. sqlite3CommitInternalChanges(db);
  112407. }
  112408. return SQLITE_OK;
  112409. }
  112410. /*
  112411. ** This routine is a no-op if the database schema is already initialized.
  112412. ** Otherwise, the schema is loaded. An error code is returned.
  112413. */
  112414. SQLITE_PRIVATE int sqlite3ReadSchema(Parse *pParse){
  112415. int rc = SQLITE_OK;
  112416. sqlite3 *db = pParse->db;
  112417. assert( sqlite3_mutex_held(db->mutex) );
  112418. if( !db->init.busy ){
  112419. rc = sqlite3Init(db, &pParse->zErrMsg);
  112420. }
  112421. if( rc!=SQLITE_OK ){
  112422. pParse->rc = rc;
  112423. pParse->nErr++;
  112424. }
  112425. return rc;
  112426. }
  112427. /*
  112428. ** Check schema cookies in all databases. If any cookie is out
  112429. ** of date set pParse->rc to SQLITE_SCHEMA. If all schema cookies
  112430. ** make no changes to pParse->rc.
  112431. */
  112432. static void schemaIsValid(Parse *pParse){
  112433. sqlite3 *db = pParse->db;
  112434. int iDb;
  112435. int rc;
  112436. int cookie;
  112437. assert( pParse->checkSchema );
  112438. assert( sqlite3_mutex_held(db->mutex) );
  112439. for(iDb=0; iDb<db->nDb; iDb++){
  112440. int openedTransaction = 0; /* True if a transaction is opened */
  112441. Btree *pBt = db->aDb[iDb].pBt; /* Btree database to read cookie from */
  112442. if( pBt==0 ) continue;
  112443. /* If there is not already a read-only (or read-write) transaction opened
  112444. ** on the b-tree database, open one now. If a transaction is opened, it
  112445. ** will be closed immediately after reading the meta-value. */
  112446. if( !sqlite3BtreeIsInReadTrans(pBt) ){
  112447. rc = sqlite3BtreeBeginTrans(pBt, 0);
  112448. if( rc==SQLITE_NOMEM || rc==SQLITE_IOERR_NOMEM ){
  112449. sqlite3OomFault(db);
  112450. }
  112451. if( rc!=SQLITE_OK ) return;
  112452. openedTransaction = 1;
  112453. }
  112454. /* Read the schema cookie from the database. If it does not match the
  112455. ** value stored as part of the in-memory schema representation,
  112456. ** set Parse.rc to SQLITE_SCHEMA. */
  112457. sqlite3BtreeGetMeta(pBt, BTREE_SCHEMA_VERSION, (u32 *)&cookie);
  112458. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  112459. if( cookie!=db->aDb[iDb].pSchema->schema_cookie ){
  112460. sqlite3ResetOneSchema(db, iDb);
  112461. pParse->rc = SQLITE_SCHEMA;
  112462. }
  112463. /* Close the transaction, if one was opened. */
  112464. if( openedTransaction ){
  112465. sqlite3BtreeCommit(pBt);
  112466. }
  112467. }
  112468. }
  112469. /*
  112470. ** Convert a schema pointer into the iDb index that indicates
  112471. ** which database file in db->aDb[] the schema refers to.
  112472. **
  112473. ** If the same database is attached more than once, the first
  112474. ** attached database is returned.
  112475. */
  112476. SQLITE_PRIVATE int sqlite3SchemaToIndex(sqlite3 *db, Schema *pSchema){
  112477. int i = -1000000;
  112478. /* If pSchema is NULL, then return -1000000. This happens when code in
  112479. ** expr.c is trying to resolve a reference to a transient table (i.e. one
  112480. ** created by a sub-select). In this case the return value of this
  112481. ** function should never be used.
  112482. **
  112483. ** We return -1000000 instead of the more usual -1 simply because using
  112484. ** -1000000 as the incorrect index into db->aDb[] is much
  112485. ** more likely to cause a segfault than -1 (of course there are assert()
  112486. ** statements too, but it never hurts to play the odds).
  112487. */
  112488. assert( sqlite3_mutex_held(db->mutex) );
  112489. if( pSchema ){
  112490. for(i=0; 1; i++){
  112491. assert( i<db->nDb );
  112492. if( db->aDb[i].pSchema==pSchema ){
  112493. break;
  112494. }
  112495. }
  112496. assert( i>=0 && i<db->nDb );
  112497. }
  112498. return i;
  112499. }
  112500. /*
  112501. ** Free all memory allocations in the pParse object
  112502. */
  112503. SQLITE_PRIVATE void sqlite3ParserReset(Parse *pParse){
  112504. sqlite3 *db = pParse->db;
  112505. sqlite3DbFree(db, pParse->aLabel);
  112506. sqlite3ExprListDelete(db, pParse->pConstExpr);
  112507. if( db ){
  112508. assert( db->lookaside.bDisable >= pParse->disableLookaside );
  112509. db->lookaside.bDisable -= pParse->disableLookaside;
  112510. }
  112511. pParse->disableLookaside = 0;
  112512. }
  112513. /*
  112514. ** Compile the UTF-8 encoded SQL statement zSql into a statement handle.
  112515. */
  112516. static int sqlite3Prepare(
  112517. sqlite3 *db, /* Database handle. */
  112518. const char *zSql, /* UTF-8 encoded SQL statement. */
  112519. int nBytes, /* Length of zSql in bytes. */
  112520. u32 prepFlags, /* Zero or more SQLITE_PREPARE_* flags */
  112521. Vdbe *pReprepare, /* VM being reprepared */
  112522. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112523. const char **pzTail /* OUT: End of parsed string */
  112524. ){
  112525. char *zErrMsg = 0; /* Error message */
  112526. int rc = SQLITE_OK; /* Result code */
  112527. int i; /* Loop counter */
  112528. Parse sParse; /* Parsing context */
  112529. memset(&sParse, 0, PARSE_HDR_SZ);
  112530. memset(PARSE_TAIL(&sParse), 0, PARSE_TAIL_SZ);
  112531. sParse.pReprepare = pReprepare;
  112532. assert( ppStmt && *ppStmt==0 );
  112533. /* assert( !db->mallocFailed ); // not true with SQLITE_USE_ALLOCA */
  112534. assert( sqlite3_mutex_held(db->mutex) );
  112535. /* For a long-term use prepared statement avoid the use of
  112536. ** lookaside memory.
  112537. */
  112538. if( prepFlags & SQLITE_PREPARE_PERSISTENT ){
  112539. sParse.disableLookaside++;
  112540. db->lookaside.bDisable++;
  112541. }
  112542. /* Check to verify that it is possible to get a read lock on all
  112543. ** database schemas. The inability to get a read lock indicates that
  112544. ** some other database connection is holding a write-lock, which in
  112545. ** turn means that the other connection has made uncommitted changes
  112546. ** to the schema.
  112547. **
  112548. ** Were we to proceed and prepare the statement against the uncommitted
  112549. ** schema changes and if those schema changes are subsequently rolled
  112550. ** back and different changes are made in their place, then when this
  112551. ** prepared statement goes to run the schema cookie would fail to detect
  112552. ** the schema change. Disaster would follow.
  112553. **
  112554. ** This thread is currently holding mutexes on all Btrees (because
  112555. ** of the sqlite3BtreeEnterAll() in sqlite3LockAndPrepare()) so it
  112556. ** is not possible for another thread to start a new schema change
  112557. ** while this routine is running. Hence, we do not need to hold
  112558. ** locks on the schema, we just need to make sure nobody else is
  112559. ** holding them.
  112560. **
  112561. ** Note that setting READ_UNCOMMITTED overrides most lock detection,
  112562. ** but it does *not* override schema lock detection, so this all still
  112563. ** works even if READ_UNCOMMITTED is set.
  112564. */
  112565. for(i=0; i<db->nDb; i++) {
  112566. Btree *pBt = db->aDb[i].pBt;
  112567. if( pBt ){
  112568. assert( sqlite3BtreeHoldsMutex(pBt) );
  112569. rc = sqlite3BtreeSchemaLocked(pBt);
  112570. if( rc ){
  112571. const char *zDb = db->aDb[i].zDbSName;
  112572. sqlite3ErrorWithMsg(db, rc, "database schema is locked: %s", zDb);
  112573. testcase( db->flags & SQLITE_ReadUncommit );
  112574. goto end_prepare;
  112575. }
  112576. }
  112577. }
  112578. sqlite3VtabUnlockList(db);
  112579. sParse.db = db;
  112580. if( nBytes>=0 && (nBytes==0 || zSql[nBytes-1]!=0) ){
  112581. char *zSqlCopy;
  112582. int mxLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
  112583. testcase( nBytes==mxLen );
  112584. testcase( nBytes==mxLen+1 );
  112585. if( nBytes>mxLen ){
  112586. sqlite3ErrorWithMsg(db, SQLITE_TOOBIG, "statement too long");
  112587. rc = sqlite3ApiExit(db, SQLITE_TOOBIG);
  112588. goto end_prepare;
  112589. }
  112590. zSqlCopy = sqlite3DbStrNDup(db, zSql, nBytes);
  112591. if( zSqlCopy ){
  112592. sqlite3RunParser(&sParse, zSqlCopy, &zErrMsg);
  112593. sParse.zTail = &zSql[sParse.zTail-zSqlCopy];
  112594. sqlite3DbFree(db, zSqlCopy);
  112595. }else{
  112596. sParse.zTail = &zSql[nBytes];
  112597. }
  112598. }else{
  112599. sqlite3RunParser(&sParse, zSql, &zErrMsg);
  112600. }
  112601. assert( 0==sParse.nQueryLoop );
  112602. if( sParse.rc==SQLITE_DONE ) sParse.rc = SQLITE_OK;
  112603. if( sParse.checkSchema ){
  112604. schemaIsValid(&sParse);
  112605. }
  112606. if( db->mallocFailed ){
  112607. sParse.rc = SQLITE_NOMEM_BKPT;
  112608. }
  112609. if( pzTail ){
  112610. *pzTail = sParse.zTail;
  112611. }
  112612. rc = sParse.rc;
  112613. #ifndef SQLITE_OMIT_EXPLAIN
  112614. if( rc==SQLITE_OK && sParse.pVdbe && sParse.explain ){
  112615. static const char * const azColName[] = {
  112616. "addr", "opcode", "p1", "p2", "p3", "p4", "p5", "comment",
  112617. "selectid", "order", "from", "detail"
  112618. };
  112619. int iFirst, mx;
  112620. if( sParse.explain==2 ){
  112621. sqlite3VdbeSetNumCols(sParse.pVdbe, 4);
  112622. iFirst = 8;
  112623. mx = 12;
  112624. }else{
  112625. sqlite3VdbeSetNumCols(sParse.pVdbe, 8);
  112626. iFirst = 0;
  112627. mx = 8;
  112628. }
  112629. for(i=iFirst; i<mx; i++){
  112630. sqlite3VdbeSetColName(sParse.pVdbe, i-iFirst, COLNAME_NAME,
  112631. azColName[i], SQLITE_STATIC);
  112632. }
  112633. }
  112634. #endif
  112635. if( db->init.busy==0 ){
  112636. sqlite3VdbeSetSql(sParse.pVdbe, zSql, (int)(sParse.zTail-zSql), prepFlags);
  112637. }
  112638. if( sParse.pVdbe && (rc!=SQLITE_OK || db->mallocFailed) ){
  112639. sqlite3VdbeFinalize(sParse.pVdbe);
  112640. assert(!(*ppStmt));
  112641. }else{
  112642. *ppStmt = (sqlite3_stmt*)sParse.pVdbe;
  112643. }
  112644. if( zErrMsg ){
  112645. sqlite3ErrorWithMsg(db, rc, "%s", zErrMsg);
  112646. sqlite3DbFree(db, zErrMsg);
  112647. }else{
  112648. sqlite3Error(db, rc);
  112649. }
  112650. /* Delete any TriggerPrg structures allocated while parsing this statement. */
  112651. while( sParse.pTriggerPrg ){
  112652. TriggerPrg *pT = sParse.pTriggerPrg;
  112653. sParse.pTriggerPrg = pT->pNext;
  112654. sqlite3DbFree(db, pT);
  112655. }
  112656. end_prepare:
  112657. sqlite3ParserReset(&sParse);
  112658. return rc;
  112659. }
  112660. static int sqlite3LockAndPrepare(
  112661. sqlite3 *db, /* Database handle. */
  112662. const char *zSql, /* UTF-8 encoded SQL statement. */
  112663. int nBytes, /* Length of zSql in bytes. */
  112664. u32 prepFlags, /* Zero or more SQLITE_PREPARE_* flags */
  112665. Vdbe *pOld, /* VM being reprepared */
  112666. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112667. const char **pzTail /* OUT: End of parsed string */
  112668. ){
  112669. int rc;
  112670. int cnt = 0;
  112671. #ifdef SQLITE_ENABLE_API_ARMOR
  112672. if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
  112673. #endif
  112674. *ppStmt = 0;
  112675. if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
  112676. return SQLITE_MISUSE_BKPT;
  112677. }
  112678. sqlite3_mutex_enter(db->mutex);
  112679. sqlite3BtreeEnterAll(db);
  112680. do{
  112681. /* Make multiple attempts to compile the SQL, until it either succeeds
  112682. ** or encounters a permanent error. A schema problem after one schema
  112683. ** reset is considered a permanent error. */
  112684. rc = sqlite3Prepare(db, zSql, nBytes, prepFlags, pOld, ppStmt, pzTail);
  112685. assert( rc==SQLITE_OK || *ppStmt==0 );
  112686. }while( rc==SQLITE_ERROR_RETRY
  112687. || (rc==SQLITE_SCHEMA && (sqlite3ResetOneSchema(db,-1), cnt++)==0) );
  112688. sqlite3BtreeLeaveAll(db);
  112689. rc = sqlite3ApiExit(db, rc);
  112690. assert( (rc&db->errMask)==rc );
  112691. sqlite3_mutex_leave(db->mutex);
  112692. return rc;
  112693. }
  112694. /*
  112695. ** Rerun the compilation of a statement after a schema change.
  112696. **
  112697. ** If the statement is successfully recompiled, return SQLITE_OK. Otherwise,
  112698. ** if the statement cannot be recompiled because another connection has
  112699. ** locked the sqlite3_master table, return SQLITE_LOCKED. If any other error
  112700. ** occurs, return SQLITE_SCHEMA.
  112701. */
  112702. SQLITE_PRIVATE int sqlite3Reprepare(Vdbe *p){
  112703. int rc;
  112704. sqlite3_stmt *pNew;
  112705. const char *zSql;
  112706. sqlite3 *db;
  112707. u8 prepFlags;
  112708. assert( sqlite3_mutex_held(sqlite3VdbeDb(p)->mutex) );
  112709. zSql = sqlite3_sql((sqlite3_stmt *)p);
  112710. assert( zSql!=0 ); /* Reprepare only called for prepare_v2() statements */
  112711. db = sqlite3VdbeDb(p);
  112712. assert( sqlite3_mutex_held(db->mutex) );
  112713. prepFlags = sqlite3VdbePrepareFlags(p);
  112714. rc = sqlite3LockAndPrepare(db, zSql, -1, prepFlags, p, &pNew, 0);
  112715. if( rc ){
  112716. if( rc==SQLITE_NOMEM ){
  112717. sqlite3OomFault(db);
  112718. }
  112719. assert( pNew==0 );
  112720. return rc;
  112721. }else{
  112722. assert( pNew!=0 );
  112723. }
  112724. sqlite3VdbeSwap((Vdbe*)pNew, p);
  112725. sqlite3TransferBindings(pNew, (sqlite3_stmt*)p);
  112726. sqlite3VdbeResetStepResult((Vdbe*)pNew);
  112727. sqlite3VdbeFinalize((Vdbe*)pNew);
  112728. return SQLITE_OK;
  112729. }
  112730. /*
  112731. ** Two versions of the official API. Legacy and new use. In the legacy
  112732. ** version, the original SQL text is not saved in the prepared statement
  112733. ** and so if a schema change occurs, SQLITE_SCHEMA is returned by
  112734. ** sqlite3_step(). In the new version, the original SQL text is retained
  112735. ** and the statement is automatically recompiled if an schema change
  112736. ** occurs.
  112737. */
  112738. SQLITE_API int sqlite3_prepare(
  112739. sqlite3 *db, /* Database handle. */
  112740. const char *zSql, /* UTF-8 encoded SQL statement. */
  112741. int nBytes, /* Length of zSql in bytes. */
  112742. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112743. const char **pzTail /* OUT: End of parsed string */
  112744. ){
  112745. int rc;
  112746. rc = sqlite3LockAndPrepare(db,zSql,nBytes,0,0,ppStmt,pzTail);
  112747. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  112748. return rc;
  112749. }
  112750. SQLITE_API int sqlite3_prepare_v2(
  112751. sqlite3 *db, /* Database handle. */
  112752. const char *zSql, /* UTF-8 encoded SQL statement. */
  112753. int nBytes, /* Length of zSql in bytes. */
  112754. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112755. const char **pzTail /* OUT: End of parsed string */
  112756. ){
  112757. int rc;
  112758. /* EVIDENCE-OF: R-37923-12173 The sqlite3_prepare_v2() interface works
  112759. ** exactly the same as sqlite3_prepare_v3() with a zero prepFlags
  112760. ** parameter.
  112761. **
  112762. ** Proof in that the 5th parameter to sqlite3LockAndPrepare is 0 */
  112763. rc = sqlite3LockAndPrepare(db,zSql,nBytes,SQLITE_PREPARE_SAVESQL,0,
  112764. ppStmt,pzTail);
  112765. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 );
  112766. return rc;
  112767. }
  112768. SQLITE_API int sqlite3_prepare_v3(
  112769. sqlite3 *db, /* Database handle. */
  112770. const char *zSql, /* UTF-8 encoded SQL statement. */
  112771. int nBytes, /* Length of zSql in bytes. */
  112772. unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_* flags */
  112773. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112774. const char **pzTail /* OUT: End of parsed string */
  112775. ){
  112776. int rc;
  112777. /* EVIDENCE-OF: R-56861-42673 sqlite3_prepare_v3() differs from
  112778. ** sqlite3_prepare_v2() only in having the extra prepFlags parameter,
  112779. ** which is a bit array consisting of zero or more of the
  112780. ** SQLITE_PREPARE_* flags.
  112781. **
  112782. ** Proof by comparison to the implementation of sqlite3_prepare_v2()
  112783. ** directly above. */
  112784. rc = sqlite3LockAndPrepare(db,zSql,nBytes,
  112785. SQLITE_PREPARE_SAVESQL|(prepFlags&SQLITE_PREPARE_MASK),
  112786. 0,ppStmt,pzTail);
  112787. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 );
  112788. return rc;
  112789. }
  112790. #ifndef SQLITE_OMIT_UTF16
  112791. /*
  112792. ** Compile the UTF-16 encoded SQL statement zSql into a statement handle.
  112793. */
  112794. static int sqlite3Prepare16(
  112795. sqlite3 *db, /* Database handle. */
  112796. const void *zSql, /* UTF-16 encoded SQL statement. */
  112797. int nBytes, /* Length of zSql in bytes. */
  112798. u32 prepFlags, /* Zero or more SQLITE_PREPARE_* flags */
  112799. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112800. const void **pzTail /* OUT: End of parsed string */
  112801. ){
  112802. /* This function currently works by first transforming the UTF-16
  112803. ** encoded string to UTF-8, then invoking sqlite3_prepare(). The
  112804. ** tricky bit is figuring out the pointer to return in *pzTail.
  112805. */
  112806. char *zSql8;
  112807. const char *zTail8 = 0;
  112808. int rc = SQLITE_OK;
  112809. #ifdef SQLITE_ENABLE_API_ARMOR
  112810. if( ppStmt==0 ) return SQLITE_MISUSE_BKPT;
  112811. #endif
  112812. *ppStmt = 0;
  112813. if( !sqlite3SafetyCheckOk(db)||zSql==0 ){
  112814. return SQLITE_MISUSE_BKPT;
  112815. }
  112816. if( nBytes>=0 ){
  112817. int sz;
  112818. const char *z = (const char*)zSql;
  112819. for(sz=0; sz<nBytes && (z[sz]!=0 || z[sz+1]!=0); sz += 2){}
  112820. nBytes = sz;
  112821. }
  112822. sqlite3_mutex_enter(db->mutex);
  112823. zSql8 = sqlite3Utf16to8(db, zSql, nBytes, SQLITE_UTF16NATIVE);
  112824. if( zSql8 ){
  112825. rc = sqlite3LockAndPrepare(db, zSql8, -1, prepFlags, 0, ppStmt, &zTail8);
  112826. }
  112827. if( zTail8 && pzTail ){
  112828. /* If sqlite3_prepare returns a tail pointer, we calculate the
  112829. ** equivalent pointer into the UTF-16 string by counting the unicode
  112830. ** characters between zSql8 and zTail8, and then returning a pointer
  112831. ** the same number of characters into the UTF-16 string.
  112832. */
  112833. int chars_parsed = sqlite3Utf8CharLen(zSql8, (int)(zTail8-zSql8));
  112834. *pzTail = (u8 *)zSql + sqlite3Utf16ByteLen(zSql, chars_parsed);
  112835. }
  112836. sqlite3DbFree(db, zSql8);
  112837. rc = sqlite3ApiExit(db, rc);
  112838. sqlite3_mutex_leave(db->mutex);
  112839. return rc;
  112840. }
  112841. /*
  112842. ** Two versions of the official API. Legacy and new use. In the legacy
  112843. ** version, the original SQL text is not saved in the prepared statement
  112844. ** and so if a schema change occurs, SQLITE_SCHEMA is returned by
  112845. ** sqlite3_step(). In the new version, the original SQL text is retained
  112846. ** and the statement is automatically recompiled if an schema change
  112847. ** occurs.
  112848. */
  112849. SQLITE_API int sqlite3_prepare16(
  112850. sqlite3 *db, /* Database handle. */
  112851. const void *zSql, /* UTF-16 encoded SQL statement. */
  112852. int nBytes, /* Length of zSql in bytes. */
  112853. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112854. const void **pzTail /* OUT: End of parsed string */
  112855. ){
  112856. int rc;
  112857. rc = sqlite3Prepare16(db,zSql,nBytes,0,ppStmt,pzTail);
  112858. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  112859. return rc;
  112860. }
  112861. SQLITE_API int sqlite3_prepare16_v2(
  112862. sqlite3 *db, /* Database handle. */
  112863. const void *zSql, /* UTF-16 encoded SQL statement. */
  112864. int nBytes, /* Length of zSql in bytes. */
  112865. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112866. const void **pzTail /* OUT: End of parsed string */
  112867. ){
  112868. int rc;
  112869. rc = sqlite3Prepare16(db,zSql,nBytes,SQLITE_PREPARE_SAVESQL,ppStmt,pzTail);
  112870. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  112871. return rc;
  112872. }
  112873. SQLITE_API int sqlite3_prepare16_v3(
  112874. sqlite3 *db, /* Database handle. */
  112875. const void *zSql, /* UTF-16 encoded SQL statement. */
  112876. int nBytes, /* Length of zSql in bytes. */
  112877. unsigned int prepFlags, /* Zero or more SQLITE_PREPARE_* flags */
  112878. sqlite3_stmt **ppStmt, /* OUT: A pointer to the prepared statement */
  112879. const void **pzTail /* OUT: End of parsed string */
  112880. ){
  112881. int rc;
  112882. rc = sqlite3Prepare16(db,zSql,nBytes,
  112883. SQLITE_PREPARE_SAVESQL|(prepFlags&SQLITE_PREPARE_MASK),
  112884. ppStmt,pzTail);
  112885. assert( rc==SQLITE_OK || ppStmt==0 || *ppStmt==0 ); /* VERIFY: F13021 */
  112886. return rc;
  112887. }
  112888. #endif /* SQLITE_OMIT_UTF16 */
  112889. /************** End of prepare.c *********************************************/
  112890. /************** Begin file select.c ******************************************/
  112891. /*
  112892. ** 2001 September 15
  112893. **
  112894. ** The author disclaims copyright to this source code. In place of
  112895. ** a legal notice, here is a blessing:
  112896. **
  112897. ** May you do good and not evil.
  112898. ** May you find forgiveness for yourself and forgive others.
  112899. ** May you share freely, never taking more than you give.
  112900. **
  112901. *************************************************************************
  112902. ** This file contains C code routines that are called by the parser
  112903. ** to handle SELECT statements in SQLite.
  112904. */
  112905. /* #include "sqliteInt.h" */
  112906. /*
  112907. ** Trace output macros
  112908. */
  112909. #if SELECTTRACE_ENABLED
  112910. /***/ int sqlite3SelectTrace = 0;
  112911. # define SELECTTRACE(K,P,S,X) \
  112912. if(sqlite3SelectTrace&(K)) \
  112913. sqlite3DebugPrintf("%s/%p: ",(S)->zSelName,(S)),\
  112914. sqlite3DebugPrintf X
  112915. #else
  112916. # define SELECTTRACE(K,P,S,X)
  112917. #endif
  112918. /*
  112919. ** An instance of the following object is used to record information about
  112920. ** how to process the DISTINCT keyword, to simplify passing that information
  112921. ** into the selectInnerLoop() routine.
  112922. */
  112923. typedef struct DistinctCtx DistinctCtx;
  112924. struct DistinctCtx {
  112925. u8 isTnct; /* True if the DISTINCT keyword is present */
  112926. u8 eTnctType; /* One of the WHERE_DISTINCT_* operators */
  112927. int tabTnct; /* Ephemeral table used for DISTINCT processing */
  112928. int addrTnct; /* Address of OP_OpenEphemeral opcode for tabTnct */
  112929. };
  112930. /*
  112931. ** An instance of the following object is used to record information about
  112932. ** the ORDER BY (or GROUP BY) clause of query is being coded.
  112933. */
  112934. typedef struct SortCtx SortCtx;
  112935. struct SortCtx {
  112936. ExprList *pOrderBy; /* The ORDER BY (or GROUP BY clause) */
  112937. int nOBSat; /* Number of ORDER BY terms satisfied by indices */
  112938. int iECursor; /* Cursor number for the sorter */
  112939. int regReturn; /* Register holding block-output return address */
  112940. int labelBkOut; /* Start label for the block-output subroutine */
  112941. int addrSortIndex; /* Address of the OP_SorterOpen or OP_OpenEphemeral */
  112942. int labelDone; /* Jump here when done, ex: LIMIT reached */
  112943. u8 sortFlags; /* Zero or more SORTFLAG_* bits */
  112944. u8 bOrderedInnerLoop; /* ORDER BY correctly sorts the inner loop */
  112945. };
  112946. #define SORTFLAG_UseSorter 0x01 /* Use SorterOpen instead of OpenEphemeral */
  112947. /*
  112948. ** Delete all the content of a Select structure. Deallocate the structure
  112949. ** itself only if bFree is true.
  112950. */
  112951. static void clearSelect(sqlite3 *db, Select *p, int bFree){
  112952. while( p ){
  112953. Select *pPrior = p->pPrior;
  112954. sqlite3ExprListDelete(db, p->pEList);
  112955. sqlite3SrcListDelete(db, p->pSrc);
  112956. sqlite3ExprDelete(db, p->pWhere);
  112957. sqlite3ExprListDelete(db, p->pGroupBy);
  112958. sqlite3ExprDelete(db, p->pHaving);
  112959. sqlite3ExprListDelete(db, p->pOrderBy);
  112960. sqlite3ExprDelete(db, p->pLimit);
  112961. if( OK_IF_ALWAYS_TRUE(p->pWith) ) sqlite3WithDelete(db, p->pWith);
  112962. if( bFree ) sqlite3DbFreeNN(db, p);
  112963. p = pPrior;
  112964. bFree = 1;
  112965. }
  112966. }
  112967. /*
  112968. ** Initialize a SelectDest structure.
  112969. */
  112970. SQLITE_PRIVATE void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
  112971. pDest->eDest = (u8)eDest;
  112972. pDest->iSDParm = iParm;
  112973. pDest->zAffSdst = 0;
  112974. pDest->iSdst = 0;
  112975. pDest->nSdst = 0;
  112976. }
  112977. /*
  112978. ** Allocate a new Select structure and return a pointer to that
  112979. ** structure.
  112980. */
  112981. SQLITE_PRIVATE Select *sqlite3SelectNew(
  112982. Parse *pParse, /* Parsing context */
  112983. ExprList *pEList, /* which columns to include in the result */
  112984. SrcList *pSrc, /* the FROM clause -- which tables to scan */
  112985. Expr *pWhere, /* the WHERE clause */
  112986. ExprList *pGroupBy, /* the GROUP BY clause */
  112987. Expr *pHaving, /* the HAVING clause */
  112988. ExprList *pOrderBy, /* the ORDER BY clause */
  112989. u32 selFlags, /* Flag parameters, such as SF_Distinct */
  112990. Expr *pLimit /* LIMIT value. NULL means not used */
  112991. ){
  112992. Select *pNew;
  112993. Select standin;
  112994. pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
  112995. if( pNew==0 ){
  112996. assert( pParse->db->mallocFailed );
  112997. pNew = &standin;
  112998. }
  112999. if( pEList==0 ){
  113000. pEList = sqlite3ExprListAppend(pParse, 0,
  113001. sqlite3Expr(pParse->db,TK_ASTERISK,0));
  113002. }
  113003. pNew->pEList = pEList;
  113004. pNew->op = TK_SELECT;
  113005. pNew->selFlags = selFlags;
  113006. pNew->iLimit = 0;
  113007. pNew->iOffset = 0;
  113008. #if SELECTTRACE_ENABLED
  113009. pNew->zSelName[0] = 0;
  113010. #endif
  113011. pNew->addrOpenEphm[0] = -1;
  113012. pNew->addrOpenEphm[1] = -1;
  113013. pNew->nSelectRow = 0;
  113014. if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
  113015. pNew->pSrc = pSrc;
  113016. pNew->pWhere = pWhere;
  113017. pNew->pGroupBy = pGroupBy;
  113018. pNew->pHaving = pHaving;
  113019. pNew->pOrderBy = pOrderBy;
  113020. pNew->pPrior = 0;
  113021. pNew->pNext = 0;
  113022. pNew->pLimit = pLimit;
  113023. pNew->pWith = 0;
  113024. if( pParse->db->mallocFailed ) {
  113025. clearSelect(pParse->db, pNew, pNew!=&standin);
  113026. pNew = 0;
  113027. }else{
  113028. assert( pNew->pSrc!=0 || pParse->nErr>0 );
  113029. }
  113030. assert( pNew!=&standin );
  113031. return pNew;
  113032. }
  113033. #if SELECTTRACE_ENABLED
  113034. /*
  113035. ** Set the name of a Select object
  113036. */
  113037. SQLITE_PRIVATE void sqlite3SelectSetName(Select *p, const char *zName){
  113038. if( p && zName ){
  113039. sqlite3_snprintf(sizeof(p->zSelName), p->zSelName, "%s", zName);
  113040. }
  113041. }
  113042. #endif
  113043. /*
  113044. ** Delete the given Select structure and all of its substructures.
  113045. */
  113046. SQLITE_PRIVATE void sqlite3SelectDelete(sqlite3 *db, Select *p){
  113047. if( OK_IF_ALWAYS_TRUE(p) ) clearSelect(db, p, 1);
  113048. }
  113049. /*
  113050. ** Return a pointer to the right-most SELECT statement in a compound.
  113051. */
  113052. static Select *findRightmost(Select *p){
  113053. while( p->pNext ) p = p->pNext;
  113054. return p;
  113055. }
  113056. /*
  113057. ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
  113058. ** type of join. Return an integer constant that expresses that type
  113059. ** in terms of the following bit values:
  113060. **
  113061. ** JT_INNER
  113062. ** JT_CROSS
  113063. ** JT_OUTER
  113064. ** JT_NATURAL
  113065. ** JT_LEFT
  113066. ** JT_RIGHT
  113067. **
  113068. ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
  113069. **
  113070. ** If an illegal or unsupported join type is seen, then still return
  113071. ** a join type, but put an error in the pParse structure.
  113072. */
  113073. SQLITE_PRIVATE int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
  113074. int jointype = 0;
  113075. Token *apAll[3];
  113076. Token *p;
  113077. /* 0123456789 123456789 123456789 123 */
  113078. static const char zKeyText[] = "naturaleftouterightfullinnercross";
  113079. static const struct {
  113080. u8 i; /* Beginning of keyword text in zKeyText[] */
  113081. u8 nChar; /* Length of the keyword in characters */
  113082. u8 code; /* Join type mask */
  113083. } aKeyword[] = {
  113084. /* natural */ { 0, 7, JT_NATURAL },
  113085. /* left */ { 6, 4, JT_LEFT|JT_OUTER },
  113086. /* outer */ { 10, 5, JT_OUTER },
  113087. /* right */ { 14, 5, JT_RIGHT|JT_OUTER },
  113088. /* full */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
  113089. /* inner */ { 23, 5, JT_INNER },
  113090. /* cross */ { 28, 5, JT_INNER|JT_CROSS },
  113091. };
  113092. int i, j;
  113093. apAll[0] = pA;
  113094. apAll[1] = pB;
  113095. apAll[2] = pC;
  113096. for(i=0; i<3 && apAll[i]; i++){
  113097. p = apAll[i];
  113098. for(j=0; j<ArraySize(aKeyword); j++){
  113099. if( p->n==aKeyword[j].nChar
  113100. && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
  113101. jointype |= aKeyword[j].code;
  113102. break;
  113103. }
  113104. }
  113105. testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
  113106. if( j>=ArraySize(aKeyword) ){
  113107. jointype |= JT_ERROR;
  113108. break;
  113109. }
  113110. }
  113111. if(
  113112. (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
  113113. (jointype & JT_ERROR)!=0
  113114. ){
  113115. const char *zSp = " ";
  113116. assert( pB!=0 );
  113117. if( pC==0 ){ zSp++; }
  113118. sqlite3ErrorMsg(pParse, "unknown or unsupported join type: "
  113119. "%T %T%s%T", pA, pB, zSp, pC);
  113120. jointype = JT_INNER;
  113121. }else if( (jointype & JT_OUTER)!=0
  113122. && (jointype & (JT_LEFT|JT_RIGHT))!=JT_LEFT ){
  113123. sqlite3ErrorMsg(pParse,
  113124. "RIGHT and FULL OUTER JOINs are not currently supported");
  113125. jointype = JT_INNER;
  113126. }
  113127. return jointype;
  113128. }
  113129. /*
  113130. ** Return the index of a column in a table. Return -1 if the column
  113131. ** is not contained in the table.
  113132. */
  113133. static int columnIndex(Table *pTab, const char *zCol){
  113134. int i;
  113135. for(i=0; i<pTab->nCol; i++){
  113136. if( sqlite3StrICmp(pTab->aCol[i].zName, zCol)==0 ) return i;
  113137. }
  113138. return -1;
  113139. }
  113140. /*
  113141. ** Search the first N tables in pSrc, from left to right, looking for a
  113142. ** table that has a column named zCol.
  113143. **
  113144. ** When found, set *piTab and *piCol to the table index and column index
  113145. ** of the matching column and return TRUE.
  113146. **
  113147. ** If not found, return FALSE.
  113148. */
  113149. static int tableAndColumnIndex(
  113150. SrcList *pSrc, /* Array of tables to search */
  113151. int N, /* Number of tables in pSrc->a[] to search */
  113152. const char *zCol, /* Name of the column we are looking for */
  113153. int *piTab, /* Write index of pSrc->a[] here */
  113154. int *piCol /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
  113155. ){
  113156. int i; /* For looping over tables in pSrc */
  113157. int iCol; /* Index of column matching zCol */
  113158. assert( (piTab==0)==(piCol==0) ); /* Both or neither are NULL */
  113159. for(i=0; i<N; i++){
  113160. iCol = columnIndex(pSrc->a[i].pTab, zCol);
  113161. if( iCol>=0 ){
  113162. if( piTab ){
  113163. *piTab = i;
  113164. *piCol = iCol;
  113165. }
  113166. return 1;
  113167. }
  113168. }
  113169. return 0;
  113170. }
  113171. /*
  113172. ** This function is used to add terms implied by JOIN syntax to the
  113173. ** WHERE clause expression of a SELECT statement. The new term, which
  113174. ** is ANDed with the existing WHERE clause, is of the form:
  113175. **
  113176. ** (tab1.col1 = tab2.col2)
  113177. **
  113178. ** where tab1 is the iSrc'th table in SrcList pSrc and tab2 is the
  113179. ** (iSrc+1)'th. Column col1 is column iColLeft of tab1, and col2 is
  113180. ** column iColRight of tab2.
  113181. */
  113182. static void addWhereTerm(
  113183. Parse *pParse, /* Parsing context */
  113184. SrcList *pSrc, /* List of tables in FROM clause */
  113185. int iLeft, /* Index of first table to join in pSrc */
  113186. int iColLeft, /* Index of column in first table */
  113187. int iRight, /* Index of second table in pSrc */
  113188. int iColRight, /* Index of column in second table */
  113189. int isOuterJoin, /* True if this is an OUTER join */
  113190. Expr **ppWhere /* IN/OUT: The WHERE clause to add to */
  113191. ){
  113192. sqlite3 *db = pParse->db;
  113193. Expr *pE1;
  113194. Expr *pE2;
  113195. Expr *pEq;
  113196. assert( iLeft<iRight );
  113197. assert( pSrc->nSrc>iRight );
  113198. assert( pSrc->a[iLeft].pTab );
  113199. assert( pSrc->a[iRight].pTab );
  113200. pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iColLeft);
  113201. pE2 = sqlite3CreateColumnExpr(db, pSrc, iRight, iColRight);
  113202. pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
  113203. if( pEq && isOuterJoin ){
  113204. ExprSetProperty(pEq, EP_FromJoin);
  113205. assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
  113206. ExprSetVVAProperty(pEq, EP_NoReduce);
  113207. pEq->iRightJoinTable = (i16)pE2->iTable;
  113208. }
  113209. *ppWhere = sqlite3ExprAnd(db, *ppWhere, pEq);
  113210. }
  113211. /*
  113212. ** Set the EP_FromJoin property on all terms of the given expression.
  113213. ** And set the Expr.iRightJoinTable to iTable for every term in the
  113214. ** expression.
  113215. **
  113216. ** The EP_FromJoin property is used on terms of an expression to tell
  113217. ** the LEFT OUTER JOIN processing logic that this term is part of the
  113218. ** join restriction specified in the ON or USING clause and not a part
  113219. ** of the more general WHERE clause. These terms are moved over to the
  113220. ** WHERE clause during join processing but we need to remember that they
  113221. ** originated in the ON or USING clause.
  113222. **
  113223. ** The Expr.iRightJoinTable tells the WHERE clause processing that the
  113224. ** expression depends on table iRightJoinTable even if that table is not
  113225. ** explicitly mentioned in the expression. That information is needed
  113226. ** for cases like this:
  113227. **
  113228. ** SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
  113229. **
  113230. ** The where clause needs to defer the handling of the t1.x=5
  113231. ** term until after the t2 loop of the join. In that way, a
  113232. ** NULL t2 row will be inserted whenever t1.x!=5. If we do not
  113233. ** defer the handling of t1.x=5, it will be processed immediately
  113234. ** after the t1 loop and rows with t1.x!=5 will never appear in
  113235. ** the output, which is incorrect.
  113236. */
  113237. static void setJoinExpr(Expr *p, int iTable){
  113238. while( p ){
  113239. ExprSetProperty(p, EP_FromJoin);
  113240. assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
  113241. ExprSetVVAProperty(p, EP_NoReduce);
  113242. p->iRightJoinTable = (i16)iTable;
  113243. if( p->op==TK_FUNCTION && p->x.pList ){
  113244. int i;
  113245. for(i=0; i<p->x.pList->nExpr; i++){
  113246. setJoinExpr(p->x.pList->a[i].pExpr, iTable);
  113247. }
  113248. }
  113249. setJoinExpr(p->pLeft, iTable);
  113250. p = p->pRight;
  113251. }
  113252. }
  113253. /* Undo the work of setJoinExpr(). In the expression tree p, convert every
  113254. ** term that is marked with EP_FromJoin and iRightJoinTable==iTable into
  113255. ** an ordinary term that omits the EP_FromJoin mark.
  113256. **
  113257. ** This happens when a LEFT JOIN is simplified into an ordinary JOIN.
  113258. */
  113259. static void unsetJoinExpr(Expr *p, int iTable){
  113260. while( p ){
  113261. if( ExprHasProperty(p, EP_FromJoin)
  113262. && (iTable<0 || p->iRightJoinTable==iTable) ){
  113263. ExprClearProperty(p, EP_FromJoin);
  113264. }
  113265. if( p->op==TK_FUNCTION && p->x.pList ){
  113266. int i;
  113267. for(i=0; i<p->x.pList->nExpr; i++){
  113268. unsetJoinExpr(p->x.pList->a[i].pExpr, iTable);
  113269. }
  113270. }
  113271. unsetJoinExpr(p->pLeft, iTable);
  113272. p = p->pRight;
  113273. }
  113274. }
  113275. /*
  113276. ** This routine processes the join information for a SELECT statement.
  113277. ** ON and USING clauses are converted into extra terms of the WHERE clause.
  113278. ** NATURAL joins also create extra WHERE clause terms.
  113279. **
  113280. ** The terms of a FROM clause are contained in the Select.pSrc structure.
  113281. ** The left most table is the first entry in Select.pSrc. The right-most
  113282. ** table is the last entry. The join operator is held in the entry to
  113283. ** the left. Thus entry 0 contains the join operator for the join between
  113284. ** entries 0 and 1. Any ON or USING clauses associated with the join are
  113285. ** also attached to the left entry.
  113286. **
  113287. ** This routine returns the number of errors encountered.
  113288. */
  113289. static int sqliteProcessJoin(Parse *pParse, Select *p){
  113290. SrcList *pSrc; /* All tables in the FROM clause */
  113291. int i, j; /* Loop counters */
  113292. struct SrcList_item *pLeft; /* Left table being joined */
  113293. struct SrcList_item *pRight; /* Right table being joined */
  113294. pSrc = p->pSrc;
  113295. pLeft = &pSrc->a[0];
  113296. pRight = &pLeft[1];
  113297. for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
  113298. Table *pRightTab = pRight->pTab;
  113299. int isOuter;
  113300. if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
  113301. isOuter = (pRight->fg.jointype & JT_OUTER)!=0;
  113302. /* When the NATURAL keyword is present, add WHERE clause terms for
  113303. ** every column that the two tables have in common.
  113304. */
  113305. if( pRight->fg.jointype & JT_NATURAL ){
  113306. if( pRight->pOn || pRight->pUsing ){
  113307. sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
  113308. "an ON or USING clause", 0);
  113309. return 1;
  113310. }
  113311. for(j=0; j<pRightTab->nCol; j++){
  113312. char *zName; /* Name of column in the right table */
  113313. int iLeft; /* Matching left table */
  113314. int iLeftCol; /* Matching column in the left table */
  113315. zName = pRightTab->aCol[j].zName;
  113316. if( tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol) ){
  113317. addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, j,
  113318. isOuter, &p->pWhere);
  113319. }
  113320. }
  113321. }
  113322. /* Disallow both ON and USING clauses in the same join
  113323. */
  113324. if( pRight->pOn && pRight->pUsing ){
  113325. sqlite3ErrorMsg(pParse, "cannot have both ON and USING "
  113326. "clauses in the same join");
  113327. return 1;
  113328. }
  113329. /* Add the ON clause to the end of the WHERE clause, connected by
  113330. ** an AND operator.
  113331. */
  113332. if( pRight->pOn ){
  113333. if( isOuter ) setJoinExpr(pRight->pOn, pRight->iCursor);
  113334. p->pWhere = sqlite3ExprAnd(pParse->db, p->pWhere, pRight->pOn);
  113335. pRight->pOn = 0;
  113336. }
  113337. /* Create extra terms on the WHERE clause for each column named
  113338. ** in the USING clause. Example: If the two tables to be joined are
  113339. ** A and B and the USING clause names X, Y, and Z, then add this
  113340. ** to the WHERE clause: A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
  113341. ** Report an error if any column mentioned in the USING clause is
  113342. ** not contained in both tables to be joined.
  113343. */
  113344. if( pRight->pUsing ){
  113345. IdList *pList = pRight->pUsing;
  113346. for(j=0; j<pList->nId; j++){
  113347. char *zName; /* Name of the term in the USING clause */
  113348. int iLeft; /* Table on the left with matching column name */
  113349. int iLeftCol; /* Column number of matching column on the left */
  113350. int iRightCol; /* Column number of matching column on the right */
  113351. zName = pList->a[j].zName;
  113352. iRightCol = columnIndex(pRightTab, zName);
  113353. if( iRightCol<0
  113354. || !tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol)
  113355. ){
  113356. sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
  113357. "not present in both tables", zName);
  113358. return 1;
  113359. }
  113360. addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, iRightCol,
  113361. isOuter, &p->pWhere);
  113362. }
  113363. }
  113364. }
  113365. return 0;
  113366. }
  113367. /* Forward reference */
  113368. static KeyInfo *keyInfoFromExprList(
  113369. Parse *pParse, /* Parsing context */
  113370. ExprList *pList, /* Form the KeyInfo object from this ExprList */
  113371. int iStart, /* Begin with this column of pList */
  113372. int nExtra /* Add this many extra columns to the end */
  113373. );
  113374. /*
  113375. ** Generate code that will push the record in registers regData
  113376. ** through regData+nData-1 onto the sorter.
  113377. */
  113378. static void pushOntoSorter(
  113379. Parse *pParse, /* Parser context */
  113380. SortCtx *pSort, /* Information about the ORDER BY clause */
  113381. Select *pSelect, /* The whole SELECT statement */
  113382. int regData, /* First register holding data to be sorted */
  113383. int regOrigData, /* First register holding data before packing */
  113384. int nData, /* Number of elements in the data array */
  113385. int nPrefixReg /* No. of reg prior to regData available for use */
  113386. ){
  113387. Vdbe *v = pParse->pVdbe; /* Stmt under construction */
  113388. int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
  113389. int nExpr = pSort->pOrderBy->nExpr; /* No. of ORDER BY terms */
  113390. int nBase = nExpr + bSeq + nData; /* Fields in sorter record */
  113391. int regBase; /* Regs for sorter record */
  113392. int regRecord = ++pParse->nMem; /* Assembled sorter record */
  113393. int nOBSat = pSort->nOBSat; /* ORDER BY terms to skip */
  113394. int op; /* Opcode to add sorter record to sorter */
  113395. int iLimit; /* LIMIT counter */
  113396. assert( bSeq==0 || bSeq==1 );
  113397. assert( nData==1 || regData==regOrigData || regOrigData==0 );
  113398. if( nPrefixReg ){
  113399. assert( nPrefixReg==nExpr+bSeq );
  113400. regBase = regData - nExpr - bSeq;
  113401. }else{
  113402. regBase = pParse->nMem + 1;
  113403. pParse->nMem += nBase;
  113404. }
  113405. assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
  113406. iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
  113407. pSort->labelDone = sqlite3VdbeMakeLabel(v);
  113408. sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
  113409. SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
  113410. if( bSeq ){
  113411. sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
  113412. }
  113413. if( nPrefixReg==0 && nData>0 ){
  113414. sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
  113415. }
  113416. sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regRecord);
  113417. if( nOBSat>0 ){
  113418. int regPrevKey; /* The first nOBSat columns of the previous row */
  113419. int addrFirst; /* Address of the OP_IfNot opcode */
  113420. int addrJmp; /* Address of the OP_Jump opcode */
  113421. VdbeOp *pOp; /* Opcode that opens the sorter */
  113422. int nKey; /* Number of sorting key columns, including OP_Sequence */
  113423. KeyInfo *pKI; /* Original KeyInfo on the sorter table */
  113424. regPrevKey = pParse->nMem+1;
  113425. pParse->nMem += pSort->nOBSat;
  113426. nKey = nExpr - pSort->nOBSat + bSeq;
  113427. if( bSeq ){
  113428. addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
  113429. }else{
  113430. addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
  113431. }
  113432. VdbeCoverage(v);
  113433. sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
  113434. pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
  113435. if( pParse->db->mallocFailed ) return;
  113436. pOp->p2 = nKey + nData;
  113437. pKI = pOp->p4.pKeyInfo;
  113438. memset(pKI->aSortOrder, 0, pKI->nKeyField); /* Makes OP_Jump testable */
  113439. sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
  113440. testcase( pKI->nAllField > pKI->nKeyField+2 );
  113441. pOp->p4.pKeyInfo = keyInfoFromExprList(pParse, pSort->pOrderBy, nOBSat,
  113442. pKI->nAllField-pKI->nKeyField-1);
  113443. addrJmp = sqlite3VdbeCurrentAddr(v);
  113444. sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
  113445. pSort->labelBkOut = sqlite3VdbeMakeLabel(v);
  113446. pSort->regReturn = ++pParse->nMem;
  113447. sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
  113448. sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
  113449. if( iLimit ){
  113450. sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
  113451. VdbeCoverage(v);
  113452. }
  113453. sqlite3VdbeJumpHere(v, addrFirst);
  113454. sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
  113455. sqlite3VdbeJumpHere(v, addrJmp);
  113456. }
  113457. if( pSort->sortFlags & SORTFLAG_UseSorter ){
  113458. op = OP_SorterInsert;
  113459. }else{
  113460. op = OP_IdxInsert;
  113461. }
  113462. sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
  113463. regBase+nOBSat, nBase-nOBSat);
  113464. if( iLimit ){
  113465. int addr;
  113466. int r1 = 0;
  113467. /* Fill the sorter until it contains LIMIT+OFFSET entries. (The iLimit
  113468. ** register is initialized with value of LIMIT+OFFSET.) After the sorter
  113469. ** fills up, delete the least entry in the sorter after each insert.
  113470. ** Thus we never hold more than the LIMIT+OFFSET rows in memory at once */
  113471. addr = sqlite3VdbeAddOp1(v, OP_IfNotZero, iLimit); VdbeCoverage(v);
  113472. sqlite3VdbeAddOp1(v, OP_Last, pSort->iECursor);
  113473. if( pSort->bOrderedInnerLoop ){
  113474. r1 = ++pParse->nMem;
  113475. sqlite3VdbeAddOp3(v, OP_Column, pSort->iECursor, nExpr, r1);
  113476. VdbeComment((v, "seq"));
  113477. }
  113478. sqlite3VdbeAddOp1(v, OP_Delete, pSort->iECursor);
  113479. if( pSort->bOrderedInnerLoop ){
  113480. /* If the inner loop is driven by an index such that values from
  113481. ** the same iteration of the inner loop are in sorted order, then
  113482. ** immediately jump to the next iteration of an inner loop if the
  113483. ** entry from the current iteration does not fit into the top
  113484. ** LIMIT+OFFSET entries of the sorter. */
  113485. int iBrk = sqlite3VdbeCurrentAddr(v) + 2;
  113486. sqlite3VdbeAddOp3(v, OP_Eq, regBase+nExpr, iBrk, r1);
  113487. sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
  113488. VdbeCoverage(v);
  113489. }
  113490. sqlite3VdbeJumpHere(v, addr);
  113491. }
  113492. }
  113493. /*
  113494. ** Add code to implement the OFFSET
  113495. */
  113496. static void codeOffset(
  113497. Vdbe *v, /* Generate code into this VM */
  113498. int iOffset, /* Register holding the offset counter */
  113499. int iContinue /* Jump here to skip the current record */
  113500. ){
  113501. if( iOffset>0 ){
  113502. sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
  113503. VdbeComment((v, "OFFSET"));
  113504. }
  113505. }
  113506. /*
  113507. ** Add code that will check to make sure the N registers starting at iMem
  113508. ** form a distinct entry. iTab is a sorting index that holds previously
  113509. ** seen combinations of the N values. A new entry is made in iTab
  113510. ** if the current N values are new.
  113511. **
  113512. ** A jump to addrRepeat is made and the N+1 values are popped from the
  113513. ** stack if the top N elements are not distinct.
  113514. */
  113515. static void codeDistinct(
  113516. Parse *pParse, /* Parsing and code generating context */
  113517. int iTab, /* A sorting index used to test for distinctness */
  113518. int addrRepeat, /* Jump to here if not distinct */
  113519. int N, /* Number of elements */
  113520. int iMem /* First element */
  113521. ){
  113522. Vdbe *v;
  113523. int r1;
  113524. v = pParse->pVdbe;
  113525. r1 = sqlite3GetTempReg(pParse);
  113526. sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, iMem, N); VdbeCoverage(v);
  113527. sqlite3VdbeAddOp3(v, OP_MakeRecord, iMem, N, r1);
  113528. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, iMem, N);
  113529. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  113530. sqlite3ReleaseTempReg(pParse, r1);
  113531. }
  113532. /*
  113533. ** This routine generates the code for the inside of the inner loop
  113534. ** of a SELECT.
  113535. **
  113536. ** If srcTab is negative, then the p->pEList expressions
  113537. ** are evaluated in order to get the data for this row. If srcTab is
  113538. ** zero or more, then data is pulled from srcTab and p->pEList is used only
  113539. ** to get the number of columns and the collation sequence for each column.
  113540. */
  113541. static void selectInnerLoop(
  113542. Parse *pParse, /* The parser context */
  113543. Select *p, /* The complete select statement being coded */
  113544. int srcTab, /* Pull data from this table if non-negative */
  113545. SortCtx *pSort, /* If not NULL, info on how to process ORDER BY */
  113546. DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
  113547. SelectDest *pDest, /* How to dispose of the results */
  113548. int iContinue, /* Jump here to continue with next row */
  113549. int iBreak /* Jump here to break out of the inner loop */
  113550. ){
  113551. Vdbe *v = pParse->pVdbe;
  113552. int i;
  113553. int hasDistinct; /* True if the DISTINCT keyword is present */
  113554. int eDest = pDest->eDest; /* How to dispose of results */
  113555. int iParm = pDest->iSDParm; /* First argument to disposal method */
  113556. int nResultCol; /* Number of result columns */
  113557. int nPrefixReg = 0; /* Number of extra registers before regResult */
  113558. /* Usually, regResult is the first cell in an array of memory cells
  113559. ** containing the current result row. In this case regOrig is set to the
  113560. ** same value. However, if the results are being sent to the sorter, the
  113561. ** values for any expressions that are also part of the sort-key are omitted
  113562. ** from this array. In this case regOrig is set to zero. */
  113563. int regResult; /* Start of memory holding current results */
  113564. int regOrig; /* Start of memory holding full result (or 0) */
  113565. assert( v );
  113566. assert( p->pEList!=0 );
  113567. hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
  113568. if( pSort && pSort->pOrderBy==0 ) pSort = 0;
  113569. if( pSort==0 && !hasDistinct ){
  113570. assert( iContinue!=0 );
  113571. codeOffset(v, p->iOffset, iContinue);
  113572. }
  113573. /* Pull the requested columns.
  113574. */
  113575. nResultCol = p->pEList->nExpr;
  113576. if( pDest->iSdst==0 ){
  113577. if( pSort ){
  113578. nPrefixReg = pSort->pOrderBy->nExpr;
  113579. if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
  113580. pParse->nMem += nPrefixReg;
  113581. }
  113582. pDest->iSdst = pParse->nMem+1;
  113583. pParse->nMem += nResultCol;
  113584. }else if( pDest->iSdst+nResultCol > pParse->nMem ){
  113585. /* This is an error condition that can result, for example, when a SELECT
  113586. ** on the right-hand side of an INSERT contains more result columns than
  113587. ** there are columns in the table on the left. The error will be caught
  113588. ** and reported later. But we need to make sure enough memory is allocated
  113589. ** to avoid other spurious errors in the meantime. */
  113590. pParse->nMem += nResultCol;
  113591. }
  113592. pDest->nSdst = nResultCol;
  113593. regOrig = regResult = pDest->iSdst;
  113594. if( srcTab>=0 ){
  113595. for(i=0; i<nResultCol; i++){
  113596. sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
  113597. VdbeComment((v, "%s", p->pEList->a[i].zName));
  113598. }
  113599. }else if( eDest!=SRT_Exists ){
  113600. /* If the destination is an EXISTS(...) expression, the actual
  113601. ** values returned by the SELECT are not required.
  113602. */
  113603. u8 ecelFlags;
  113604. if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
  113605. ecelFlags = SQLITE_ECEL_DUP;
  113606. }else{
  113607. ecelFlags = 0;
  113608. }
  113609. if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
  113610. /* For each expression in p->pEList that is a copy of an expression in
  113611. ** the ORDER BY clause (pSort->pOrderBy), set the associated
  113612. ** iOrderByCol value to one more than the index of the ORDER BY
  113613. ** expression within the sort-key that pushOntoSorter() will generate.
  113614. ** This allows the p->pEList field to be omitted from the sorted record,
  113615. ** saving space and CPU cycles. */
  113616. ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
  113617. for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
  113618. int j;
  113619. if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
  113620. p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
  113621. }
  113622. }
  113623. regOrig = 0;
  113624. assert( eDest==SRT_Set || eDest==SRT_Mem
  113625. || eDest==SRT_Coroutine || eDest==SRT_Output );
  113626. }
  113627. nResultCol = sqlite3ExprCodeExprList(pParse,p->pEList,regResult,
  113628. 0,ecelFlags);
  113629. }
  113630. /* If the DISTINCT keyword was present on the SELECT statement
  113631. ** and this row has been seen before, then do not make this row
  113632. ** part of the result.
  113633. */
  113634. if( hasDistinct ){
  113635. switch( pDistinct->eTnctType ){
  113636. case WHERE_DISTINCT_ORDERED: {
  113637. VdbeOp *pOp; /* No longer required OpenEphemeral instr. */
  113638. int iJump; /* Jump destination */
  113639. int regPrev; /* Previous row content */
  113640. /* Allocate space for the previous row */
  113641. regPrev = pParse->nMem+1;
  113642. pParse->nMem += nResultCol;
  113643. /* Change the OP_OpenEphemeral coded earlier to an OP_Null
  113644. ** sets the MEM_Cleared bit on the first register of the
  113645. ** previous value. This will cause the OP_Ne below to always
  113646. ** fail on the first iteration of the loop even if the first
  113647. ** row is all NULLs.
  113648. */
  113649. sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
  113650. pOp = sqlite3VdbeGetOp(v, pDistinct->addrTnct);
  113651. pOp->opcode = OP_Null;
  113652. pOp->p1 = 1;
  113653. pOp->p2 = regPrev;
  113654. iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
  113655. for(i=0; i<nResultCol; i++){
  113656. CollSeq *pColl = sqlite3ExprCollSeq(pParse, p->pEList->a[i].pExpr);
  113657. if( i<nResultCol-1 ){
  113658. sqlite3VdbeAddOp3(v, OP_Ne, regResult+i, iJump, regPrev+i);
  113659. VdbeCoverage(v);
  113660. }else{
  113661. sqlite3VdbeAddOp3(v, OP_Eq, regResult+i, iContinue, regPrev+i);
  113662. VdbeCoverage(v);
  113663. }
  113664. sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
  113665. sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
  113666. }
  113667. assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
  113668. sqlite3VdbeAddOp3(v, OP_Copy, regResult, regPrev, nResultCol-1);
  113669. break;
  113670. }
  113671. case WHERE_DISTINCT_UNIQUE: {
  113672. sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
  113673. break;
  113674. }
  113675. default: {
  113676. assert( pDistinct->eTnctType==WHERE_DISTINCT_UNORDERED );
  113677. codeDistinct(pParse, pDistinct->tabTnct, iContinue, nResultCol,
  113678. regResult);
  113679. break;
  113680. }
  113681. }
  113682. if( pSort==0 ){
  113683. codeOffset(v, p->iOffset, iContinue);
  113684. }
  113685. }
  113686. switch( eDest ){
  113687. /* In this mode, write each query result to the key of the temporary
  113688. ** table iParm.
  113689. */
  113690. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  113691. case SRT_Union: {
  113692. int r1;
  113693. r1 = sqlite3GetTempReg(pParse);
  113694. sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
  113695. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
  113696. sqlite3ReleaseTempReg(pParse, r1);
  113697. break;
  113698. }
  113699. /* Construct a record from the query result, but instead of
  113700. ** saving that record, use it as a key to delete elements from
  113701. ** the temporary table iParm.
  113702. */
  113703. case SRT_Except: {
  113704. sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
  113705. break;
  113706. }
  113707. #endif /* SQLITE_OMIT_COMPOUND_SELECT */
  113708. /* Store the result as data using a unique key.
  113709. */
  113710. case SRT_Fifo:
  113711. case SRT_DistFifo:
  113712. case SRT_Table:
  113713. case SRT_EphemTab: {
  113714. int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
  113715. testcase( eDest==SRT_Table );
  113716. testcase( eDest==SRT_EphemTab );
  113717. testcase( eDest==SRT_Fifo );
  113718. testcase( eDest==SRT_DistFifo );
  113719. sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
  113720. #ifndef SQLITE_OMIT_CTE
  113721. if( eDest==SRT_DistFifo ){
  113722. /* If the destination is DistFifo, then cursor (iParm+1) is open
  113723. ** on an ephemeral index. If the current row is already present
  113724. ** in the index, do not write it to the output. If not, add the
  113725. ** current row to the index and proceed with writing it to the
  113726. ** output table as well. */
  113727. int addr = sqlite3VdbeCurrentAddr(v) + 4;
  113728. sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
  113729. VdbeCoverage(v);
  113730. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
  113731. assert( pSort==0 );
  113732. }
  113733. #endif
  113734. if( pSort ){
  113735. pushOntoSorter(pParse, pSort, p, r1+nPrefixReg,regResult,1,nPrefixReg);
  113736. }else{
  113737. int r2 = sqlite3GetTempReg(pParse);
  113738. sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
  113739. sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
  113740. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  113741. sqlite3ReleaseTempReg(pParse, r2);
  113742. }
  113743. sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
  113744. break;
  113745. }
  113746. #ifndef SQLITE_OMIT_SUBQUERY
  113747. /* If we are creating a set for an "expr IN (SELECT ...)" construct,
  113748. ** then there should be a single item on the stack. Write this
  113749. ** item into the set table with bogus data.
  113750. */
  113751. case SRT_Set: {
  113752. if( pSort ){
  113753. /* At first glance you would think we could optimize out the
  113754. ** ORDER BY in this case since the order of entries in the set
  113755. ** does not matter. But there might be a LIMIT clause, in which
  113756. ** case the order does matter */
  113757. pushOntoSorter(
  113758. pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
  113759. }else{
  113760. int r1 = sqlite3GetTempReg(pParse);
  113761. assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
  113762. sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
  113763. r1, pDest->zAffSdst, nResultCol);
  113764. sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
  113765. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
  113766. sqlite3ReleaseTempReg(pParse, r1);
  113767. }
  113768. break;
  113769. }
  113770. /* If any row exist in the result set, record that fact and abort.
  113771. */
  113772. case SRT_Exists: {
  113773. sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
  113774. /* The LIMIT clause will terminate the loop for us */
  113775. break;
  113776. }
  113777. /* If this is a scalar select that is part of an expression, then
  113778. ** store the results in the appropriate memory cell or array of
  113779. ** memory cells and break out of the scan loop.
  113780. */
  113781. case SRT_Mem: {
  113782. if( pSort ){
  113783. assert( nResultCol<=pDest->nSdst );
  113784. pushOntoSorter(
  113785. pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
  113786. }else{
  113787. assert( nResultCol==pDest->nSdst );
  113788. assert( regResult==iParm );
  113789. /* The LIMIT clause will jump out of the loop for us */
  113790. }
  113791. break;
  113792. }
  113793. #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
  113794. case SRT_Coroutine: /* Send data to a co-routine */
  113795. case SRT_Output: { /* Return the results */
  113796. testcase( eDest==SRT_Coroutine );
  113797. testcase( eDest==SRT_Output );
  113798. if( pSort ){
  113799. pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
  113800. nPrefixReg);
  113801. }else if( eDest==SRT_Coroutine ){
  113802. sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
  113803. }else{
  113804. sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
  113805. sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
  113806. }
  113807. break;
  113808. }
  113809. #ifndef SQLITE_OMIT_CTE
  113810. /* Write the results into a priority queue that is order according to
  113811. ** pDest->pOrderBy (in pSO). pDest->iSDParm (in iParm) is the cursor for an
  113812. ** index with pSO->nExpr+2 columns. Build a key using pSO for the first
  113813. ** pSO->nExpr columns, then make sure all keys are unique by adding a
  113814. ** final OP_Sequence column. The last column is the record as a blob.
  113815. */
  113816. case SRT_DistQueue:
  113817. case SRT_Queue: {
  113818. int nKey;
  113819. int r1, r2, r3;
  113820. int addrTest = 0;
  113821. ExprList *pSO;
  113822. pSO = pDest->pOrderBy;
  113823. assert( pSO );
  113824. nKey = pSO->nExpr;
  113825. r1 = sqlite3GetTempReg(pParse);
  113826. r2 = sqlite3GetTempRange(pParse, nKey+2);
  113827. r3 = r2+nKey+1;
  113828. if( eDest==SRT_DistQueue ){
  113829. /* If the destination is DistQueue, then cursor (iParm+1) is open
  113830. ** on a second ephemeral index that holds all values every previously
  113831. ** added to the queue. */
  113832. addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
  113833. regResult, nResultCol);
  113834. VdbeCoverage(v);
  113835. }
  113836. sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
  113837. if( eDest==SRT_DistQueue ){
  113838. sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
  113839. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  113840. }
  113841. for(i=0; i<nKey; i++){
  113842. sqlite3VdbeAddOp2(v, OP_SCopy,
  113843. regResult + pSO->a[i].u.x.iOrderByCol - 1,
  113844. r2+i);
  113845. }
  113846. sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
  113847. sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
  113848. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
  113849. if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
  113850. sqlite3ReleaseTempReg(pParse, r1);
  113851. sqlite3ReleaseTempRange(pParse, r2, nKey+2);
  113852. break;
  113853. }
  113854. #endif /* SQLITE_OMIT_CTE */
  113855. #if !defined(SQLITE_OMIT_TRIGGER)
  113856. /* Discard the results. This is used for SELECT statements inside
  113857. ** the body of a TRIGGER. The purpose of such selects is to call
  113858. ** user-defined functions that have side effects. We do not care
  113859. ** about the actual results of the select.
  113860. */
  113861. default: {
  113862. assert( eDest==SRT_Discard );
  113863. break;
  113864. }
  113865. #endif
  113866. }
  113867. /* Jump to the end of the loop if the LIMIT is reached. Except, if
  113868. ** there is a sorter, in which case the sorter has already limited
  113869. ** the output for us.
  113870. */
  113871. if( pSort==0 && p->iLimit ){
  113872. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
  113873. }
  113874. }
  113875. /*
  113876. ** Allocate a KeyInfo object sufficient for an index of N key columns and
  113877. ** X extra columns.
  113878. */
  113879. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
  113880. int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
  113881. KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
  113882. if( p ){
  113883. p->aSortOrder = (u8*)&p->aColl[N+X];
  113884. p->nKeyField = (u16)N;
  113885. p->nAllField = (u16)(N+X);
  113886. p->enc = ENC(db);
  113887. p->db = db;
  113888. p->nRef = 1;
  113889. memset(&p[1], 0, nExtra);
  113890. }else{
  113891. sqlite3OomFault(db);
  113892. }
  113893. return p;
  113894. }
  113895. /*
  113896. ** Deallocate a KeyInfo object
  113897. */
  113898. SQLITE_PRIVATE void sqlite3KeyInfoUnref(KeyInfo *p){
  113899. if( p ){
  113900. assert( p->nRef>0 );
  113901. p->nRef--;
  113902. if( p->nRef==0 ) sqlite3DbFreeNN(p->db, p);
  113903. }
  113904. }
  113905. /*
  113906. ** Make a new pointer to a KeyInfo object
  113907. */
  113908. SQLITE_PRIVATE KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
  113909. if( p ){
  113910. assert( p->nRef>0 );
  113911. p->nRef++;
  113912. }
  113913. return p;
  113914. }
  113915. #ifdef SQLITE_DEBUG
  113916. /*
  113917. ** Return TRUE if a KeyInfo object can be change. The KeyInfo object
  113918. ** can only be changed if this is just a single reference to the object.
  113919. **
  113920. ** This routine is used only inside of assert() statements.
  113921. */
  113922. SQLITE_PRIVATE int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
  113923. #endif /* SQLITE_DEBUG */
  113924. /*
  113925. ** Given an expression list, generate a KeyInfo structure that records
  113926. ** the collating sequence for each expression in that expression list.
  113927. **
  113928. ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
  113929. ** KeyInfo structure is appropriate for initializing a virtual index to
  113930. ** implement that clause. If the ExprList is the result set of a SELECT
  113931. ** then the KeyInfo structure is appropriate for initializing a virtual
  113932. ** index to implement a DISTINCT test.
  113933. **
  113934. ** Space to hold the KeyInfo structure is obtained from malloc. The calling
  113935. ** function is responsible for seeing that this structure is eventually
  113936. ** freed.
  113937. */
  113938. static KeyInfo *keyInfoFromExprList(
  113939. Parse *pParse, /* Parsing context */
  113940. ExprList *pList, /* Form the KeyInfo object from this ExprList */
  113941. int iStart, /* Begin with this column of pList */
  113942. int nExtra /* Add this many extra columns to the end */
  113943. ){
  113944. int nExpr;
  113945. KeyInfo *pInfo;
  113946. struct ExprList_item *pItem;
  113947. sqlite3 *db = pParse->db;
  113948. int i;
  113949. nExpr = pList->nExpr;
  113950. pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
  113951. if( pInfo ){
  113952. assert( sqlite3KeyInfoIsWriteable(pInfo) );
  113953. for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
  113954. pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
  113955. pInfo->aSortOrder[i-iStart] = pItem->sortOrder;
  113956. }
  113957. }
  113958. return pInfo;
  113959. }
  113960. /*
  113961. ** Name of the connection operator, used for error messages.
  113962. */
  113963. static const char *selectOpName(int id){
  113964. char *z;
  113965. switch( id ){
  113966. case TK_ALL: z = "UNION ALL"; break;
  113967. case TK_INTERSECT: z = "INTERSECT"; break;
  113968. case TK_EXCEPT: z = "EXCEPT"; break;
  113969. default: z = "UNION"; break;
  113970. }
  113971. return z;
  113972. }
  113973. #ifndef SQLITE_OMIT_EXPLAIN
  113974. /*
  113975. ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
  113976. ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
  113977. ** where the caption is of the form:
  113978. **
  113979. ** "USE TEMP B-TREE FOR xxx"
  113980. **
  113981. ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
  113982. ** is determined by the zUsage argument.
  113983. */
  113984. static void explainTempTable(Parse *pParse, const char *zUsage){
  113985. if( pParse->explain==2 ){
  113986. Vdbe *v = pParse->pVdbe;
  113987. char *zMsg = sqlite3MPrintf(pParse->db, "USE TEMP B-TREE FOR %s", zUsage);
  113988. sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
  113989. }
  113990. }
  113991. /*
  113992. ** Assign expression b to lvalue a. A second, no-op, version of this macro
  113993. ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
  113994. ** in sqlite3Select() to assign values to structure member variables that
  113995. ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
  113996. ** code with #ifndef directives.
  113997. */
  113998. # define explainSetInteger(a, b) a = b
  113999. #else
  114000. /* No-op versions of the explainXXX() functions and macros. */
  114001. # define explainTempTable(y,z)
  114002. # define explainSetInteger(y,z)
  114003. #endif
  114004. #if !defined(SQLITE_OMIT_EXPLAIN) && !defined(SQLITE_OMIT_COMPOUND_SELECT)
  114005. /*
  114006. ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
  114007. ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
  114008. ** where the caption is of one of the two forms:
  114009. **
  114010. ** "COMPOSITE SUBQUERIES iSub1 and iSub2 (op)"
  114011. ** "COMPOSITE SUBQUERIES iSub1 and iSub2 USING TEMP B-TREE (op)"
  114012. **
  114013. ** where iSub1 and iSub2 are the integers passed as the corresponding
  114014. ** function parameters, and op is the text representation of the parameter
  114015. ** of the same name. The parameter "op" must be one of TK_UNION, TK_EXCEPT,
  114016. ** TK_INTERSECT or TK_ALL. The first form is used if argument bUseTmp is
  114017. ** false, or the second form if it is true.
  114018. */
  114019. static void explainComposite(
  114020. Parse *pParse, /* Parse context */
  114021. int op, /* One of TK_UNION, TK_EXCEPT etc. */
  114022. int iSub1, /* Subquery id 1 */
  114023. int iSub2, /* Subquery id 2 */
  114024. int bUseTmp /* True if a temp table was used */
  114025. ){
  114026. assert( op==TK_UNION || op==TK_EXCEPT || op==TK_INTERSECT || op==TK_ALL );
  114027. if( pParse->explain==2 ){
  114028. Vdbe *v = pParse->pVdbe;
  114029. char *zMsg = sqlite3MPrintf(
  114030. pParse->db, "COMPOUND SUBQUERIES %d AND %d %s(%s)", iSub1, iSub2,
  114031. bUseTmp?"USING TEMP B-TREE ":"", selectOpName(op)
  114032. );
  114033. sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
  114034. }
  114035. }
  114036. #else
  114037. /* No-op versions of the explainXXX() functions and macros. */
  114038. # define explainComposite(v,w,x,y,z)
  114039. #endif
  114040. /*
  114041. ** If the inner loop was generated using a non-null pOrderBy argument,
  114042. ** then the results were placed in a sorter. After the loop is terminated
  114043. ** we need to run the sorter and output the results. The following
  114044. ** routine generates the code needed to do that.
  114045. */
  114046. static void generateSortTail(
  114047. Parse *pParse, /* Parsing context */
  114048. Select *p, /* The SELECT statement */
  114049. SortCtx *pSort, /* Information on the ORDER BY clause */
  114050. int nColumn, /* Number of columns of data */
  114051. SelectDest *pDest /* Write the sorted results here */
  114052. ){
  114053. Vdbe *v = pParse->pVdbe; /* The prepared statement */
  114054. int addrBreak = pSort->labelDone; /* Jump here to exit loop */
  114055. int addrContinue = sqlite3VdbeMakeLabel(v); /* Jump here for next cycle */
  114056. int addr;
  114057. int addrOnce = 0;
  114058. int iTab;
  114059. ExprList *pOrderBy = pSort->pOrderBy;
  114060. int eDest = pDest->eDest;
  114061. int iParm = pDest->iSDParm;
  114062. int regRow;
  114063. int regRowid;
  114064. int iCol;
  114065. int nKey;
  114066. int iSortTab; /* Sorter cursor to read from */
  114067. int nSortData; /* Trailing values to read from sorter */
  114068. int i;
  114069. int bSeq; /* True if sorter record includes seq. no. */
  114070. struct ExprList_item *aOutEx = p->pEList->a;
  114071. assert( addrBreak<0 );
  114072. if( pSort->labelBkOut ){
  114073. sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
  114074. sqlite3VdbeGoto(v, addrBreak);
  114075. sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
  114076. }
  114077. iTab = pSort->iECursor;
  114078. if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
  114079. regRowid = 0;
  114080. regRow = pDest->iSdst;
  114081. nSortData = nColumn;
  114082. }else{
  114083. regRowid = sqlite3GetTempReg(pParse);
  114084. regRow = sqlite3GetTempRange(pParse, nColumn);
  114085. nSortData = nColumn;
  114086. }
  114087. nKey = pOrderBy->nExpr - pSort->nOBSat;
  114088. if( pSort->sortFlags & SORTFLAG_UseSorter ){
  114089. int regSortOut = ++pParse->nMem;
  114090. iSortTab = pParse->nTab++;
  114091. if( pSort->labelBkOut ){
  114092. addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  114093. }
  114094. sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut, nKey+1+nSortData);
  114095. if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
  114096. addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
  114097. VdbeCoverage(v);
  114098. codeOffset(v, p->iOffset, addrContinue);
  114099. sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
  114100. bSeq = 0;
  114101. }else{
  114102. addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
  114103. codeOffset(v, p->iOffset, addrContinue);
  114104. iSortTab = iTab;
  114105. bSeq = 1;
  114106. }
  114107. for(i=0, iCol=nKey+bSeq-1; i<nSortData; i++){
  114108. if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
  114109. }
  114110. for(i=nSortData-1; i>=0; i--){
  114111. int iRead;
  114112. if( aOutEx[i].u.x.iOrderByCol ){
  114113. iRead = aOutEx[i].u.x.iOrderByCol-1;
  114114. }else{
  114115. iRead = iCol--;
  114116. }
  114117. sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
  114118. VdbeComment((v, "%s", aOutEx[i].zName ? aOutEx[i].zName : aOutEx[i].zSpan));
  114119. }
  114120. switch( eDest ){
  114121. case SRT_Table:
  114122. case SRT_EphemTab: {
  114123. sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
  114124. sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
  114125. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  114126. break;
  114127. }
  114128. #ifndef SQLITE_OMIT_SUBQUERY
  114129. case SRT_Set: {
  114130. assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
  114131. sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
  114132. pDest->zAffSdst, nColumn);
  114133. sqlite3ExprCacheAffinityChange(pParse, regRow, nColumn);
  114134. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
  114135. break;
  114136. }
  114137. case SRT_Mem: {
  114138. /* The LIMIT clause will terminate the loop for us */
  114139. break;
  114140. }
  114141. #endif
  114142. default: {
  114143. assert( eDest==SRT_Output || eDest==SRT_Coroutine );
  114144. testcase( eDest==SRT_Output );
  114145. testcase( eDest==SRT_Coroutine );
  114146. if( eDest==SRT_Output ){
  114147. sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
  114148. sqlite3ExprCacheAffinityChange(pParse, pDest->iSdst, nColumn);
  114149. }else{
  114150. sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
  114151. }
  114152. break;
  114153. }
  114154. }
  114155. if( regRowid ){
  114156. if( eDest==SRT_Set ){
  114157. sqlite3ReleaseTempRange(pParse, regRow, nColumn);
  114158. }else{
  114159. sqlite3ReleaseTempReg(pParse, regRow);
  114160. }
  114161. sqlite3ReleaseTempReg(pParse, regRowid);
  114162. }
  114163. /* The bottom of the loop
  114164. */
  114165. sqlite3VdbeResolveLabel(v, addrContinue);
  114166. if( pSort->sortFlags & SORTFLAG_UseSorter ){
  114167. sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
  114168. }else{
  114169. sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
  114170. }
  114171. if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
  114172. sqlite3VdbeResolveLabel(v, addrBreak);
  114173. }
  114174. /*
  114175. ** Return a pointer to a string containing the 'declaration type' of the
  114176. ** expression pExpr. The string may be treated as static by the caller.
  114177. **
  114178. ** Also try to estimate the size of the returned value and return that
  114179. ** result in *pEstWidth.
  114180. **
  114181. ** The declaration type is the exact datatype definition extracted from the
  114182. ** original CREATE TABLE statement if the expression is a column. The
  114183. ** declaration type for a ROWID field is INTEGER. Exactly when an expression
  114184. ** is considered a column can be complex in the presence of subqueries. The
  114185. ** result-set expression in all of the following SELECT statements is
  114186. ** considered a column by this function.
  114187. **
  114188. ** SELECT col FROM tbl;
  114189. ** SELECT (SELECT col FROM tbl;
  114190. ** SELECT (SELECT col FROM tbl);
  114191. ** SELECT abc FROM (SELECT col AS abc FROM tbl);
  114192. **
  114193. ** The declaration type for any expression other than a column is NULL.
  114194. **
  114195. ** This routine has either 3 or 6 parameters depending on whether or not
  114196. ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
  114197. */
  114198. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  114199. # define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
  114200. #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
  114201. # define columnType(A,B,C,D,E) columnTypeImpl(A,B)
  114202. #endif
  114203. static const char *columnTypeImpl(
  114204. NameContext *pNC,
  114205. #ifndef SQLITE_ENABLE_COLUMN_METADATA
  114206. Expr *pExpr
  114207. #else
  114208. Expr *pExpr,
  114209. const char **pzOrigDb,
  114210. const char **pzOrigTab,
  114211. const char **pzOrigCol
  114212. #endif
  114213. ){
  114214. char const *zType = 0;
  114215. int j;
  114216. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  114217. char const *zOrigDb = 0;
  114218. char const *zOrigTab = 0;
  114219. char const *zOrigCol = 0;
  114220. #endif
  114221. assert( pExpr!=0 );
  114222. assert( pNC->pSrcList!=0 );
  114223. assert( pExpr->op!=TK_AGG_COLUMN ); /* This routine runes before aggregates
  114224. ** are processed */
  114225. switch( pExpr->op ){
  114226. case TK_COLUMN: {
  114227. /* The expression is a column. Locate the table the column is being
  114228. ** extracted from in NameContext.pSrcList. This table may be real
  114229. ** database table or a subquery.
  114230. */
  114231. Table *pTab = 0; /* Table structure column is extracted from */
  114232. Select *pS = 0; /* Select the column is extracted from */
  114233. int iCol = pExpr->iColumn; /* Index of column in pTab */
  114234. while( pNC && !pTab ){
  114235. SrcList *pTabList = pNC->pSrcList;
  114236. for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
  114237. if( j<pTabList->nSrc ){
  114238. pTab = pTabList->a[j].pTab;
  114239. pS = pTabList->a[j].pSelect;
  114240. }else{
  114241. pNC = pNC->pNext;
  114242. }
  114243. }
  114244. if( pTab==0 ){
  114245. /* At one time, code such as "SELECT new.x" within a trigger would
  114246. ** cause this condition to run. Since then, we have restructured how
  114247. ** trigger code is generated and so this condition is no longer
  114248. ** possible. However, it can still be true for statements like
  114249. ** the following:
  114250. **
  114251. ** CREATE TABLE t1(col INTEGER);
  114252. ** SELECT (SELECT t1.col) FROM FROM t1;
  114253. **
  114254. ** when columnType() is called on the expression "t1.col" in the
  114255. ** sub-select. In this case, set the column type to NULL, even
  114256. ** though it should really be "INTEGER".
  114257. **
  114258. ** This is not a problem, as the column type of "t1.col" is never
  114259. ** used. When columnType() is called on the expression
  114260. ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
  114261. ** branch below. */
  114262. break;
  114263. }
  114264. assert( pTab && pExpr->pTab==pTab );
  114265. if( pS ){
  114266. /* The "table" is actually a sub-select or a view in the FROM clause
  114267. ** of the SELECT statement. Return the declaration type and origin
  114268. ** data for the result-set column of the sub-select.
  114269. */
  114270. if( iCol>=0 && iCol<pS->pEList->nExpr ){
  114271. /* If iCol is less than zero, then the expression requests the
  114272. ** rowid of the sub-select or view. This expression is legal (see
  114273. ** test case misc2.2.2) - it always evaluates to NULL.
  114274. */
  114275. NameContext sNC;
  114276. Expr *p = pS->pEList->a[iCol].pExpr;
  114277. sNC.pSrcList = pS->pSrc;
  114278. sNC.pNext = pNC;
  114279. sNC.pParse = pNC->pParse;
  114280. zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
  114281. }
  114282. }else{
  114283. /* A real table or a CTE table */
  114284. assert( !pS );
  114285. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  114286. if( iCol<0 ) iCol = pTab->iPKey;
  114287. assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
  114288. if( iCol<0 ){
  114289. zType = "INTEGER";
  114290. zOrigCol = "rowid";
  114291. }else{
  114292. zOrigCol = pTab->aCol[iCol].zName;
  114293. zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
  114294. }
  114295. zOrigTab = pTab->zName;
  114296. if( pNC->pParse && pTab->pSchema ){
  114297. int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
  114298. zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
  114299. }
  114300. #else
  114301. assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
  114302. if( iCol<0 ){
  114303. zType = "INTEGER";
  114304. }else{
  114305. zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
  114306. }
  114307. #endif
  114308. }
  114309. break;
  114310. }
  114311. #ifndef SQLITE_OMIT_SUBQUERY
  114312. case TK_SELECT: {
  114313. /* The expression is a sub-select. Return the declaration type and
  114314. ** origin info for the single column in the result set of the SELECT
  114315. ** statement.
  114316. */
  114317. NameContext sNC;
  114318. Select *pS = pExpr->x.pSelect;
  114319. Expr *p = pS->pEList->a[0].pExpr;
  114320. assert( ExprHasProperty(pExpr, EP_xIsSelect) );
  114321. sNC.pSrcList = pS->pSrc;
  114322. sNC.pNext = pNC;
  114323. sNC.pParse = pNC->pParse;
  114324. zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
  114325. break;
  114326. }
  114327. #endif
  114328. }
  114329. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  114330. if( pzOrigDb ){
  114331. assert( pzOrigTab && pzOrigCol );
  114332. *pzOrigDb = zOrigDb;
  114333. *pzOrigTab = zOrigTab;
  114334. *pzOrigCol = zOrigCol;
  114335. }
  114336. #endif
  114337. return zType;
  114338. }
  114339. /*
  114340. ** Generate code that will tell the VDBE the declaration types of columns
  114341. ** in the result set.
  114342. */
  114343. static void generateColumnTypes(
  114344. Parse *pParse, /* Parser context */
  114345. SrcList *pTabList, /* List of tables */
  114346. ExprList *pEList /* Expressions defining the result set */
  114347. ){
  114348. #ifndef SQLITE_OMIT_DECLTYPE
  114349. Vdbe *v = pParse->pVdbe;
  114350. int i;
  114351. NameContext sNC;
  114352. sNC.pSrcList = pTabList;
  114353. sNC.pParse = pParse;
  114354. sNC.pNext = 0;
  114355. for(i=0; i<pEList->nExpr; i++){
  114356. Expr *p = pEList->a[i].pExpr;
  114357. const char *zType;
  114358. #ifdef SQLITE_ENABLE_COLUMN_METADATA
  114359. const char *zOrigDb = 0;
  114360. const char *zOrigTab = 0;
  114361. const char *zOrigCol = 0;
  114362. zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
  114363. /* The vdbe must make its own copy of the column-type and other
  114364. ** column specific strings, in case the schema is reset before this
  114365. ** virtual machine is deleted.
  114366. */
  114367. sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
  114368. sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
  114369. sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
  114370. #else
  114371. zType = columnType(&sNC, p, 0, 0, 0);
  114372. #endif
  114373. sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
  114374. }
  114375. #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
  114376. }
  114377. /*
  114378. ** Compute the column names for a SELECT statement.
  114379. **
  114380. ** The only guarantee that SQLite makes about column names is that if the
  114381. ** column has an AS clause assigning it a name, that will be the name used.
  114382. ** That is the only documented guarantee. However, countless applications
  114383. ** developed over the years have made baseless assumptions about column names
  114384. ** and will break if those assumptions changes. Hence, use extreme caution
  114385. ** when modifying this routine to avoid breaking legacy.
  114386. **
  114387. ** See Also: sqlite3ColumnsFromExprList()
  114388. **
  114389. ** The PRAGMA short_column_names and PRAGMA full_column_names settings are
  114390. ** deprecated. The default setting is short=ON, full=OFF. 99.9% of all
  114391. ** applications should operate this way. Nevertheless, we need to support the
  114392. ** other modes for legacy:
  114393. **
  114394. ** short=OFF, full=OFF: Column name is the text of the expression has it
  114395. ** originally appears in the SELECT statement. In
  114396. ** other words, the zSpan of the result expression.
  114397. **
  114398. ** short=ON, full=OFF: (This is the default setting). If the result
  114399. ** refers directly to a table column, then the
  114400. ** result column name is just the table column
  114401. ** name: COLUMN. Otherwise use zSpan.
  114402. **
  114403. ** full=ON, short=ANY: If the result refers directly to a table column,
  114404. ** then the result column name with the table name
  114405. ** prefix, ex: TABLE.COLUMN. Otherwise use zSpan.
  114406. */
  114407. static void generateColumnNames(
  114408. Parse *pParse, /* Parser context */
  114409. Select *pSelect /* Generate column names for this SELECT statement */
  114410. ){
  114411. Vdbe *v = pParse->pVdbe;
  114412. int i;
  114413. Table *pTab;
  114414. SrcList *pTabList;
  114415. ExprList *pEList;
  114416. sqlite3 *db = pParse->db;
  114417. int fullName; /* TABLE.COLUMN if no AS clause and is a direct table ref */
  114418. int srcName; /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
  114419. #ifndef SQLITE_OMIT_EXPLAIN
  114420. /* If this is an EXPLAIN, skip this step */
  114421. if( pParse->explain ){
  114422. return;
  114423. }
  114424. #endif
  114425. if( pParse->colNamesSet || db->mallocFailed ) return;
  114426. /* Column names are determined by the left-most term of a compound select */
  114427. while( pSelect->pPrior ) pSelect = pSelect->pPrior;
  114428. SELECTTRACE(1,pParse,pSelect,("generating column names\n"));
  114429. pTabList = pSelect->pSrc;
  114430. pEList = pSelect->pEList;
  114431. assert( v!=0 );
  114432. assert( pTabList!=0 );
  114433. pParse->colNamesSet = 1;
  114434. fullName = (db->flags & SQLITE_FullColNames)!=0;
  114435. srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
  114436. sqlite3VdbeSetNumCols(v, pEList->nExpr);
  114437. for(i=0; i<pEList->nExpr; i++){
  114438. Expr *p = pEList->a[i].pExpr;
  114439. assert( p!=0 );
  114440. assert( p->op!=TK_AGG_COLUMN ); /* Agg processing has not run yet */
  114441. assert( p->op!=TK_COLUMN || p->pTab!=0 ); /* Covering idx not yet coded */
  114442. if( pEList->a[i].zName ){
  114443. /* An AS clause always takes first priority */
  114444. char *zName = pEList->a[i].zName;
  114445. sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
  114446. }else if( srcName && p->op==TK_COLUMN ){
  114447. char *zCol;
  114448. int iCol = p->iColumn;
  114449. pTab = p->pTab;
  114450. assert( pTab!=0 );
  114451. if( iCol<0 ) iCol = pTab->iPKey;
  114452. assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
  114453. if( iCol<0 ){
  114454. zCol = "rowid";
  114455. }else{
  114456. zCol = pTab->aCol[iCol].zName;
  114457. }
  114458. if( fullName ){
  114459. char *zName = 0;
  114460. zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
  114461. sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
  114462. }else{
  114463. sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
  114464. }
  114465. }else{
  114466. const char *z = pEList->a[i].zSpan;
  114467. z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
  114468. sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
  114469. }
  114470. }
  114471. generateColumnTypes(pParse, pTabList, pEList);
  114472. }
  114473. /*
  114474. ** Given an expression list (which is really the list of expressions
  114475. ** that form the result set of a SELECT statement) compute appropriate
  114476. ** column names for a table that would hold the expression list.
  114477. **
  114478. ** All column names will be unique.
  114479. **
  114480. ** Only the column names are computed. Column.zType, Column.zColl,
  114481. ** and other fields of Column are zeroed.
  114482. **
  114483. ** Return SQLITE_OK on success. If a memory allocation error occurs,
  114484. ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
  114485. **
  114486. ** The only guarantee that SQLite makes about column names is that if the
  114487. ** column has an AS clause assigning it a name, that will be the name used.
  114488. ** That is the only documented guarantee. However, countless applications
  114489. ** developed over the years have made baseless assumptions about column names
  114490. ** and will break if those assumptions changes. Hence, use extreme caution
  114491. ** when modifying this routine to avoid breaking legacy.
  114492. **
  114493. ** See Also: generateColumnNames()
  114494. */
  114495. SQLITE_PRIVATE int sqlite3ColumnsFromExprList(
  114496. Parse *pParse, /* Parsing context */
  114497. ExprList *pEList, /* Expr list from which to derive column names */
  114498. i16 *pnCol, /* Write the number of columns here */
  114499. Column **paCol /* Write the new column list here */
  114500. ){
  114501. sqlite3 *db = pParse->db; /* Database connection */
  114502. int i, j; /* Loop counters */
  114503. u32 cnt; /* Index added to make the name unique */
  114504. Column *aCol, *pCol; /* For looping over result columns */
  114505. int nCol; /* Number of columns in the result set */
  114506. char *zName; /* Column name */
  114507. int nName; /* Size of name in zName[] */
  114508. Hash ht; /* Hash table of column names */
  114509. sqlite3HashInit(&ht);
  114510. if( pEList ){
  114511. nCol = pEList->nExpr;
  114512. aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
  114513. testcase( aCol==0 );
  114514. if( nCol>32767 ) nCol = 32767;
  114515. }else{
  114516. nCol = 0;
  114517. aCol = 0;
  114518. }
  114519. assert( nCol==(i16)nCol );
  114520. *pnCol = nCol;
  114521. *paCol = aCol;
  114522. for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
  114523. /* Get an appropriate name for the column
  114524. */
  114525. if( (zName = pEList->a[i].zName)!=0 ){
  114526. /* If the column contains an "AS <name>" phrase, use <name> as the name */
  114527. }else{
  114528. Expr *pColExpr = sqlite3ExprSkipCollate(pEList->a[i].pExpr);
  114529. while( pColExpr->op==TK_DOT ){
  114530. pColExpr = pColExpr->pRight;
  114531. assert( pColExpr!=0 );
  114532. }
  114533. assert( pColExpr->op!=TK_AGG_COLUMN );
  114534. if( pColExpr->op==TK_COLUMN ){
  114535. /* For columns use the column name name */
  114536. int iCol = pColExpr->iColumn;
  114537. Table *pTab = pColExpr->pTab;
  114538. assert( pTab!=0 );
  114539. if( iCol<0 ) iCol = pTab->iPKey;
  114540. zName = iCol>=0 ? pTab->aCol[iCol].zName : "rowid";
  114541. }else if( pColExpr->op==TK_ID ){
  114542. assert( !ExprHasProperty(pColExpr, EP_IntValue) );
  114543. zName = pColExpr->u.zToken;
  114544. }else{
  114545. /* Use the original text of the column expression as its name */
  114546. zName = pEList->a[i].zSpan;
  114547. }
  114548. }
  114549. if( zName ){
  114550. zName = sqlite3DbStrDup(db, zName);
  114551. }else{
  114552. zName = sqlite3MPrintf(db,"column%d",i+1);
  114553. }
  114554. /* Make sure the column name is unique. If the name is not unique,
  114555. ** append an integer to the name so that it becomes unique.
  114556. */
  114557. cnt = 0;
  114558. while( zName && sqlite3HashFind(&ht, zName)!=0 ){
  114559. nName = sqlite3Strlen30(zName);
  114560. if( nName>0 ){
  114561. for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
  114562. if( zName[j]==':' ) nName = j;
  114563. }
  114564. zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
  114565. if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
  114566. }
  114567. pCol->zName = zName;
  114568. sqlite3ColumnPropertiesFromName(0, pCol);
  114569. if( zName && sqlite3HashInsert(&ht, zName, pCol)==pCol ){
  114570. sqlite3OomFault(db);
  114571. }
  114572. }
  114573. sqlite3HashClear(&ht);
  114574. if( db->mallocFailed ){
  114575. for(j=0; j<i; j++){
  114576. sqlite3DbFree(db, aCol[j].zName);
  114577. }
  114578. sqlite3DbFree(db, aCol);
  114579. *paCol = 0;
  114580. *pnCol = 0;
  114581. return SQLITE_NOMEM_BKPT;
  114582. }
  114583. return SQLITE_OK;
  114584. }
  114585. /*
  114586. ** Add type and collation information to a column list based on
  114587. ** a SELECT statement.
  114588. **
  114589. ** The column list presumably came from selectColumnNamesFromExprList().
  114590. ** The column list has only names, not types or collations. This
  114591. ** routine goes through and adds the types and collations.
  114592. **
  114593. ** This routine requires that all identifiers in the SELECT
  114594. ** statement be resolved.
  114595. */
  114596. SQLITE_PRIVATE void sqlite3SelectAddColumnTypeAndCollation(
  114597. Parse *pParse, /* Parsing contexts */
  114598. Table *pTab, /* Add column type information to this table */
  114599. Select *pSelect /* SELECT used to determine types and collations */
  114600. ){
  114601. sqlite3 *db = pParse->db;
  114602. NameContext sNC;
  114603. Column *pCol;
  114604. CollSeq *pColl;
  114605. int i;
  114606. Expr *p;
  114607. struct ExprList_item *a;
  114608. assert( pSelect!=0 );
  114609. assert( (pSelect->selFlags & SF_Resolved)!=0 );
  114610. assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
  114611. if( db->mallocFailed ) return;
  114612. memset(&sNC, 0, sizeof(sNC));
  114613. sNC.pSrcList = pSelect->pSrc;
  114614. a = pSelect->pEList->a;
  114615. for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
  114616. const char *zType;
  114617. int n, m;
  114618. p = a[i].pExpr;
  114619. zType = columnType(&sNC, p, 0, 0, 0);
  114620. /* pCol->szEst = ... // Column size est for SELECT tables never used */
  114621. pCol->affinity = sqlite3ExprAffinity(p);
  114622. if( zType ){
  114623. m = sqlite3Strlen30(zType);
  114624. n = sqlite3Strlen30(pCol->zName);
  114625. pCol->zName = sqlite3DbReallocOrFree(db, pCol->zName, n+m+2);
  114626. if( pCol->zName ){
  114627. memcpy(&pCol->zName[n+1], zType, m+1);
  114628. pCol->colFlags |= COLFLAG_HASTYPE;
  114629. }
  114630. }
  114631. if( pCol->affinity==0 ) pCol->affinity = SQLITE_AFF_BLOB;
  114632. pColl = sqlite3ExprCollSeq(pParse, p);
  114633. if( pColl && pCol->zColl==0 ){
  114634. pCol->zColl = sqlite3DbStrDup(db, pColl->zName);
  114635. }
  114636. }
  114637. pTab->szTabRow = 1; /* Any non-zero value works */
  114638. }
  114639. /*
  114640. ** Given a SELECT statement, generate a Table structure that describes
  114641. ** the result set of that SELECT.
  114642. */
  114643. SQLITE_PRIVATE Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect){
  114644. Table *pTab;
  114645. sqlite3 *db = pParse->db;
  114646. int savedFlags;
  114647. savedFlags = db->flags;
  114648. db->flags &= ~SQLITE_FullColNames;
  114649. db->flags |= SQLITE_ShortColNames;
  114650. sqlite3SelectPrep(pParse, pSelect, 0);
  114651. if( pParse->nErr ) return 0;
  114652. while( pSelect->pPrior ) pSelect = pSelect->pPrior;
  114653. db->flags = savedFlags;
  114654. pTab = sqlite3DbMallocZero(db, sizeof(Table) );
  114655. if( pTab==0 ){
  114656. return 0;
  114657. }
  114658. /* The sqlite3ResultSetOfSelect() is only used n contexts where lookaside
  114659. ** is disabled */
  114660. assert( db->lookaside.bDisable );
  114661. pTab->nTabRef = 1;
  114662. pTab->zName = 0;
  114663. pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  114664. sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
  114665. sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect);
  114666. pTab->iPKey = -1;
  114667. if( db->mallocFailed ){
  114668. sqlite3DeleteTable(db, pTab);
  114669. return 0;
  114670. }
  114671. return pTab;
  114672. }
  114673. /*
  114674. ** Get a VDBE for the given parser context. Create a new one if necessary.
  114675. ** If an error occurs, return NULL and leave a message in pParse.
  114676. */
  114677. SQLITE_PRIVATE Vdbe *sqlite3GetVdbe(Parse *pParse){
  114678. if( pParse->pVdbe ){
  114679. return pParse->pVdbe;
  114680. }
  114681. if( pParse->pToplevel==0
  114682. && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
  114683. ){
  114684. pParse->okConstFactor = 1;
  114685. }
  114686. return sqlite3VdbeCreate(pParse);
  114687. }
  114688. /*
  114689. ** Compute the iLimit and iOffset fields of the SELECT based on the
  114690. ** pLimit expressions. pLimit->pLeft and pLimit->pRight hold the expressions
  114691. ** that appear in the original SQL statement after the LIMIT and OFFSET
  114692. ** keywords. Or NULL if those keywords are omitted. iLimit and iOffset
  114693. ** are the integer memory register numbers for counters used to compute
  114694. ** the limit and offset. If there is no limit and/or offset, then
  114695. ** iLimit and iOffset are negative.
  114696. **
  114697. ** This routine changes the values of iLimit and iOffset only if
  114698. ** a limit or offset is defined by pLimit->pLeft and pLimit->pRight. iLimit
  114699. ** and iOffset should have been preset to appropriate default values (zero)
  114700. ** prior to calling this routine.
  114701. **
  114702. ** The iOffset register (if it exists) is initialized to the value
  114703. ** of the OFFSET. The iLimit register is initialized to LIMIT. Register
  114704. ** iOffset+1 is initialized to LIMIT+OFFSET.
  114705. **
  114706. ** Only if pLimit->pLeft!=0 do the limit registers get
  114707. ** redefined. The UNION ALL operator uses this property to force
  114708. ** the reuse of the same limit and offset registers across multiple
  114709. ** SELECT statements.
  114710. */
  114711. static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
  114712. Vdbe *v = 0;
  114713. int iLimit = 0;
  114714. int iOffset;
  114715. int n;
  114716. Expr *pLimit = p->pLimit;
  114717. if( p->iLimit ) return;
  114718. /*
  114719. ** "LIMIT -1" always shows all rows. There is some
  114720. ** controversy about what the correct behavior should be.
  114721. ** The current implementation interprets "LIMIT 0" to mean
  114722. ** no rows.
  114723. */
  114724. sqlite3ExprCacheClear(pParse);
  114725. if( pLimit ){
  114726. assert( pLimit->op==TK_LIMIT );
  114727. assert( pLimit->pLeft!=0 );
  114728. p->iLimit = iLimit = ++pParse->nMem;
  114729. v = sqlite3GetVdbe(pParse);
  114730. assert( v!=0 );
  114731. if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
  114732. sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
  114733. VdbeComment((v, "LIMIT counter"));
  114734. if( n==0 ){
  114735. sqlite3VdbeGoto(v, iBreak);
  114736. }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
  114737. p->nSelectRow = sqlite3LogEst((u64)n);
  114738. p->selFlags |= SF_FixedLimit;
  114739. }
  114740. }else{
  114741. sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
  114742. sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
  114743. VdbeComment((v, "LIMIT counter"));
  114744. sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
  114745. }
  114746. if( pLimit->pRight ){
  114747. p->iOffset = iOffset = ++pParse->nMem;
  114748. pParse->nMem++; /* Allocate an extra register for limit+offset */
  114749. sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
  114750. sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
  114751. VdbeComment((v, "OFFSET counter"));
  114752. sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
  114753. VdbeComment((v, "LIMIT+OFFSET"));
  114754. }
  114755. }
  114756. }
  114757. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  114758. /*
  114759. ** Return the appropriate collating sequence for the iCol-th column of
  114760. ** the result set for the compound-select statement "p". Return NULL if
  114761. ** the column has no default collating sequence.
  114762. **
  114763. ** The collating sequence for the compound select is taken from the
  114764. ** left-most term of the select that has a collating sequence.
  114765. */
  114766. static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
  114767. CollSeq *pRet;
  114768. if( p->pPrior ){
  114769. pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
  114770. }else{
  114771. pRet = 0;
  114772. }
  114773. assert( iCol>=0 );
  114774. /* iCol must be less than p->pEList->nExpr. Otherwise an error would
  114775. ** have been thrown during name resolution and we would not have gotten
  114776. ** this far */
  114777. if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
  114778. pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
  114779. }
  114780. return pRet;
  114781. }
  114782. /*
  114783. ** The select statement passed as the second parameter is a compound SELECT
  114784. ** with an ORDER BY clause. This function allocates and returns a KeyInfo
  114785. ** structure suitable for implementing the ORDER BY.
  114786. **
  114787. ** Space to hold the KeyInfo structure is obtained from malloc. The calling
  114788. ** function is responsible for ensuring that this structure is eventually
  114789. ** freed.
  114790. */
  114791. static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
  114792. ExprList *pOrderBy = p->pOrderBy;
  114793. int nOrderBy = p->pOrderBy->nExpr;
  114794. sqlite3 *db = pParse->db;
  114795. KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
  114796. if( pRet ){
  114797. int i;
  114798. for(i=0; i<nOrderBy; i++){
  114799. struct ExprList_item *pItem = &pOrderBy->a[i];
  114800. Expr *pTerm = pItem->pExpr;
  114801. CollSeq *pColl;
  114802. if( pTerm->flags & EP_Collate ){
  114803. pColl = sqlite3ExprCollSeq(pParse, pTerm);
  114804. }else{
  114805. pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
  114806. if( pColl==0 ) pColl = db->pDfltColl;
  114807. pOrderBy->a[i].pExpr =
  114808. sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
  114809. }
  114810. assert( sqlite3KeyInfoIsWriteable(pRet) );
  114811. pRet->aColl[i] = pColl;
  114812. pRet->aSortOrder[i] = pOrderBy->a[i].sortOrder;
  114813. }
  114814. }
  114815. return pRet;
  114816. }
  114817. #ifndef SQLITE_OMIT_CTE
  114818. /*
  114819. ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
  114820. ** query of the form:
  114821. **
  114822. ** <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
  114823. ** \___________/ \_______________/
  114824. ** p->pPrior p
  114825. **
  114826. **
  114827. ** There is exactly one reference to the recursive-table in the FROM clause
  114828. ** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
  114829. **
  114830. ** The setup-query runs once to generate an initial set of rows that go
  114831. ** into a Queue table. Rows are extracted from the Queue table one by
  114832. ** one. Each row extracted from Queue is output to pDest. Then the single
  114833. ** extracted row (now in the iCurrent table) becomes the content of the
  114834. ** recursive-table for a recursive-query run. The output of the recursive-query
  114835. ** is added back into the Queue table. Then another row is extracted from Queue
  114836. ** and the iteration continues until the Queue table is empty.
  114837. **
  114838. ** If the compound query operator is UNION then no duplicate rows are ever
  114839. ** inserted into the Queue table. The iDistinct table keeps a copy of all rows
  114840. ** that have ever been inserted into Queue and causes duplicates to be
  114841. ** discarded. If the operator is UNION ALL, then duplicates are allowed.
  114842. **
  114843. ** If the query has an ORDER BY, then entries in the Queue table are kept in
  114844. ** ORDER BY order and the first entry is extracted for each cycle. Without
  114845. ** an ORDER BY, the Queue table is just a FIFO.
  114846. **
  114847. ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
  114848. ** have been output to pDest. A LIMIT of zero means to output no rows and a
  114849. ** negative LIMIT means to output all rows. If there is also an OFFSET clause
  114850. ** with a positive value, then the first OFFSET outputs are discarded rather
  114851. ** than being sent to pDest. The LIMIT count does not begin until after OFFSET
  114852. ** rows have been skipped.
  114853. */
  114854. static void generateWithRecursiveQuery(
  114855. Parse *pParse, /* Parsing context */
  114856. Select *p, /* The recursive SELECT to be coded */
  114857. SelectDest *pDest /* What to do with query results */
  114858. ){
  114859. SrcList *pSrc = p->pSrc; /* The FROM clause of the recursive query */
  114860. int nCol = p->pEList->nExpr; /* Number of columns in the recursive table */
  114861. Vdbe *v = pParse->pVdbe; /* The prepared statement under construction */
  114862. Select *pSetup = p->pPrior; /* The setup query */
  114863. int addrTop; /* Top of the loop */
  114864. int addrCont, addrBreak; /* CONTINUE and BREAK addresses */
  114865. int iCurrent = 0; /* The Current table */
  114866. int regCurrent; /* Register holding Current table */
  114867. int iQueue; /* The Queue table */
  114868. int iDistinct = 0; /* To ensure unique results if UNION */
  114869. int eDest = SRT_Fifo; /* How to write to Queue */
  114870. SelectDest destQueue; /* SelectDest targetting the Queue table */
  114871. int i; /* Loop counter */
  114872. int rc; /* Result code */
  114873. ExprList *pOrderBy; /* The ORDER BY clause */
  114874. Expr *pLimit; /* Saved LIMIT and OFFSET */
  114875. int regLimit, regOffset; /* Registers used by LIMIT and OFFSET */
  114876. /* Obtain authorization to do a recursive query */
  114877. if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
  114878. /* Process the LIMIT and OFFSET clauses, if they exist */
  114879. addrBreak = sqlite3VdbeMakeLabel(v);
  114880. p->nSelectRow = 320; /* 4 billion rows */
  114881. computeLimitRegisters(pParse, p, addrBreak);
  114882. pLimit = p->pLimit;
  114883. regLimit = p->iLimit;
  114884. regOffset = p->iOffset;
  114885. p->pLimit = 0;
  114886. p->iLimit = p->iOffset = 0;
  114887. pOrderBy = p->pOrderBy;
  114888. /* Locate the cursor number of the Current table */
  114889. for(i=0; ALWAYS(i<pSrc->nSrc); i++){
  114890. if( pSrc->a[i].fg.isRecursive ){
  114891. iCurrent = pSrc->a[i].iCursor;
  114892. break;
  114893. }
  114894. }
  114895. /* Allocate cursors numbers for Queue and Distinct. The cursor number for
  114896. ** the Distinct table must be exactly one greater than Queue in order
  114897. ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
  114898. iQueue = pParse->nTab++;
  114899. if( p->op==TK_UNION ){
  114900. eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
  114901. iDistinct = pParse->nTab++;
  114902. }else{
  114903. eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
  114904. }
  114905. sqlite3SelectDestInit(&destQueue, eDest, iQueue);
  114906. /* Allocate cursors for Current, Queue, and Distinct. */
  114907. regCurrent = ++pParse->nMem;
  114908. sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
  114909. if( pOrderBy ){
  114910. KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
  114911. sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
  114912. (char*)pKeyInfo, P4_KEYINFO);
  114913. destQueue.pOrderBy = pOrderBy;
  114914. }else{
  114915. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
  114916. }
  114917. VdbeComment((v, "Queue table"));
  114918. if( iDistinct ){
  114919. p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
  114920. p->selFlags |= SF_UsesEphemeral;
  114921. }
  114922. /* Detach the ORDER BY clause from the compound SELECT */
  114923. p->pOrderBy = 0;
  114924. /* Store the results of the setup-query in Queue. */
  114925. pSetup->pNext = 0;
  114926. rc = sqlite3Select(pParse, pSetup, &destQueue);
  114927. pSetup->pNext = p;
  114928. if( rc ) goto end_of_recursive_query;
  114929. /* Find the next row in the Queue and output that row */
  114930. addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
  114931. /* Transfer the next row in Queue over to Current */
  114932. sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
  114933. if( pOrderBy ){
  114934. sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
  114935. }else{
  114936. sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
  114937. }
  114938. sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
  114939. /* Output the single row in Current */
  114940. addrCont = sqlite3VdbeMakeLabel(v);
  114941. codeOffset(v, regOffset, addrCont);
  114942. selectInnerLoop(pParse, p, iCurrent,
  114943. 0, 0, pDest, addrCont, addrBreak);
  114944. if( regLimit ){
  114945. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
  114946. VdbeCoverage(v);
  114947. }
  114948. sqlite3VdbeResolveLabel(v, addrCont);
  114949. /* Execute the recursive SELECT taking the single row in Current as
  114950. ** the value for the recursive-table. Store the results in the Queue.
  114951. */
  114952. if( p->selFlags & SF_Aggregate ){
  114953. sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
  114954. }else{
  114955. p->pPrior = 0;
  114956. sqlite3Select(pParse, p, &destQueue);
  114957. assert( p->pPrior==0 );
  114958. p->pPrior = pSetup;
  114959. }
  114960. /* Keep running the loop until the Queue is empty */
  114961. sqlite3VdbeGoto(v, addrTop);
  114962. sqlite3VdbeResolveLabel(v, addrBreak);
  114963. end_of_recursive_query:
  114964. sqlite3ExprListDelete(pParse->db, p->pOrderBy);
  114965. p->pOrderBy = pOrderBy;
  114966. p->pLimit = pLimit;
  114967. return;
  114968. }
  114969. #endif /* SQLITE_OMIT_CTE */
  114970. /* Forward references */
  114971. static int multiSelectOrderBy(
  114972. Parse *pParse, /* Parsing context */
  114973. Select *p, /* The right-most of SELECTs to be coded */
  114974. SelectDest *pDest /* What to do with query results */
  114975. );
  114976. /*
  114977. ** Handle the special case of a compound-select that originates from a
  114978. ** VALUES clause. By handling this as a special case, we avoid deep
  114979. ** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
  114980. ** on a VALUES clause.
  114981. **
  114982. ** Because the Select object originates from a VALUES clause:
  114983. ** (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
  114984. ** (2) All terms are UNION ALL
  114985. ** (3) There is no ORDER BY clause
  114986. **
  114987. ** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
  114988. ** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
  114989. ** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
  114990. ** Since the limit is exactly 1, we only need to evalutes the left-most VALUES.
  114991. */
  114992. static int multiSelectValues(
  114993. Parse *pParse, /* Parsing context */
  114994. Select *p, /* The right-most of SELECTs to be coded */
  114995. SelectDest *pDest /* What to do with query results */
  114996. ){
  114997. Select *pPrior;
  114998. Select *pRightmost = p;
  114999. int nRow = 1;
  115000. int rc = 0;
  115001. assert( p->selFlags & SF_MultiValue );
  115002. do{
  115003. assert( p->selFlags & SF_Values );
  115004. assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
  115005. assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
  115006. if( p->pPrior==0 ) break;
  115007. assert( p->pPrior->pNext==p );
  115008. p = p->pPrior;
  115009. nRow++;
  115010. }while(1);
  115011. while( p ){
  115012. pPrior = p->pPrior;
  115013. p->pPrior = 0;
  115014. rc = sqlite3Select(pParse, p, pDest);
  115015. p->pPrior = pPrior;
  115016. if( rc || pRightmost->pLimit ) break;
  115017. p->nSelectRow = nRow;
  115018. p = p->pNext;
  115019. }
  115020. return rc;
  115021. }
  115022. /*
  115023. ** This routine is called to process a compound query form from
  115024. ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
  115025. ** INTERSECT
  115026. **
  115027. ** "p" points to the right-most of the two queries. the query on the
  115028. ** left is p->pPrior. The left query could also be a compound query
  115029. ** in which case this routine will be called recursively.
  115030. **
  115031. ** The results of the total query are to be written into a destination
  115032. ** of type eDest with parameter iParm.
  115033. **
  115034. ** Example 1: Consider a three-way compound SQL statement.
  115035. **
  115036. ** SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
  115037. **
  115038. ** This statement is parsed up as follows:
  115039. **
  115040. ** SELECT c FROM t3
  115041. ** |
  115042. ** `-----> SELECT b FROM t2
  115043. ** |
  115044. ** `------> SELECT a FROM t1
  115045. **
  115046. ** The arrows in the diagram above represent the Select.pPrior pointer.
  115047. ** So if this routine is called with p equal to the t3 query, then
  115048. ** pPrior will be the t2 query. p->op will be TK_UNION in this case.
  115049. **
  115050. ** Notice that because of the way SQLite parses compound SELECTs, the
  115051. ** individual selects always group from left to right.
  115052. */
  115053. static int multiSelect(
  115054. Parse *pParse, /* Parsing context */
  115055. Select *p, /* The right-most of SELECTs to be coded */
  115056. SelectDest *pDest /* What to do with query results */
  115057. ){
  115058. int rc = SQLITE_OK; /* Success code from a subroutine */
  115059. Select *pPrior; /* Another SELECT immediately to our left */
  115060. Vdbe *v; /* Generate code to this VDBE */
  115061. SelectDest dest; /* Alternative data destination */
  115062. Select *pDelete = 0; /* Chain of simple selects to delete */
  115063. sqlite3 *db; /* Database connection */
  115064. #ifndef SQLITE_OMIT_EXPLAIN
  115065. int iSub1 = 0; /* EQP id of left-hand query */
  115066. int iSub2 = 0; /* EQP id of right-hand query */
  115067. #endif
  115068. /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs. Only
  115069. ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
  115070. */
  115071. assert( p && p->pPrior ); /* Calling function guarantees this much */
  115072. assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
  115073. db = pParse->db;
  115074. pPrior = p->pPrior;
  115075. dest = *pDest;
  115076. if( pPrior->pOrderBy || pPrior->pLimit ){
  115077. sqlite3ErrorMsg(pParse,"%s clause should come after %s not before",
  115078. pPrior->pOrderBy!=0 ? "ORDER BY" : "LIMIT", selectOpName(p->op));
  115079. rc = 1;
  115080. goto multi_select_end;
  115081. }
  115082. v = sqlite3GetVdbe(pParse);
  115083. assert( v!=0 ); /* The VDBE already created by calling function */
  115084. /* Create the destination temporary table if necessary
  115085. */
  115086. if( dest.eDest==SRT_EphemTab ){
  115087. assert( p->pEList );
  115088. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
  115089. dest.eDest = SRT_Table;
  115090. }
  115091. /* Special handling for a compound-select that originates as a VALUES clause.
  115092. */
  115093. if( p->selFlags & SF_MultiValue ){
  115094. rc = multiSelectValues(pParse, p, &dest);
  115095. goto multi_select_end;
  115096. }
  115097. /* Make sure all SELECTs in the statement have the same number of elements
  115098. ** in their result sets.
  115099. */
  115100. assert( p->pEList && pPrior->pEList );
  115101. assert( p->pEList->nExpr==pPrior->pEList->nExpr );
  115102. #ifndef SQLITE_OMIT_CTE
  115103. if( p->selFlags & SF_Recursive ){
  115104. generateWithRecursiveQuery(pParse, p, &dest);
  115105. }else
  115106. #endif
  115107. /* Compound SELECTs that have an ORDER BY clause are handled separately.
  115108. */
  115109. if( p->pOrderBy ){
  115110. return multiSelectOrderBy(pParse, p, pDest);
  115111. }else
  115112. /* Generate code for the left and right SELECT statements.
  115113. */
  115114. switch( p->op ){
  115115. case TK_ALL: {
  115116. int addr = 0;
  115117. int nLimit;
  115118. assert( !pPrior->pLimit );
  115119. pPrior->iLimit = p->iLimit;
  115120. pPrior->iOffset = p->iOffset;
  115121. pPrior->pLimit = p->pLimit;
  115122. explainSetInteger(iSub1, pParse->iNextSelectId);
  115123. rc = sqlite3Select(pParse, pPrior, &dest);
  115124. p->pLimit = 0;
  115125. if( rc ){
  115126. goto multi_select_end;
  115127. }
  115128. p->pPrior = 0;
  115129. p->iLimit = pPrior->iLimit;
  115130. p->iOffset = pPrior->iOffset;
  115131. if( p->iLimit ){
  115132. addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
  115133. VdbeComment((v, "Jump ahead if LIMIT reached"));
  115134. if( p->iOffset ){
  115135. sqlite3VdbeAddOp3(v, OP_OffsetLimit,
  115136. p->iLimit, p->iOffset+1, p->iOffset);
  115137. }
  115138. }
  115139. explainSetInteger(iSub2, pParse->iNextSelectId);
  115140. rc = sqlite3Select(pParse, p, &dest);
  115141. testcase( rc!=SQLITE_OK );
  115142. pDelete = p->pPrior;
  115143. p->pPrior = pPrior;
  115144. p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
  115145. if( pPrior->pLimit
  115146. && sqlite3ExprIsInteger(pPrior->pLimit->pLeft, &nLimit)
  115147. && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
  115148. ){
  115149. p->nSelectRow = sqlite3LogEst((u64)nLimit);
  115150. }
  115151. if( addr ){
  115152. sqlite3VdbeJumpHere(v, addr);
  115153. }
  115154. break;
  115155. }
  115156. case TK_EXCEPT:
  115157. case TK_UNION: {
  115158. int unionTab; /* Cursor number of the temporary table holding result */
  115159. u8 op = 0; /* One of the SRT_ operations to apply to self */
  115160. int priorOp; /* The SRT_ operation to apply to prior selects */
  115161. Expr *pLimit; /* Saved values of p->nLimit */
  115162. int addr;
  115163. SelectDest uniondest;
  115164. testcase( p->op==TK_EXCEPT );
  115165. testcase( p->op==TK_UNION );
  115166. priorOp = SRT_Union;
  115167. if( dest.eDest==priorOp ){
  115168. /* We can reuse a temporary table generated by a SELECT to our
  115169. ** right.
  115170. */
  115171. assert( p->pLimit==0 ); /* Not allowed on leftward elements */
  115172. unionTab = dest.iSDParm;
  115173. }else{
  115174. /* We will need to create our own temporary table to hold the
  115175. ** intermediate results.
  115176. */
  115177. unionTab = pParse->nTab++;
  115178. assert( p->pOrderBy==0 );
  115179. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
  115180. assert( p->addrOpenEphm[0] == -1 );
  115181. p->addrOpenEphm[0] = addr;
  115182. findRightmost(p)->selFlags |= SF_UsesEphemeral;
  115183. assert( p->pEList );
  115184. }
  115185. /* Code the SELECT statements to our left
  115186. */
  115187. assert( !pPrior->pOrderBy );
  115188. sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
  115189. explainSetInteger(iSub1, pParse->iNextSelectId);
  115190. rc = sqlite3Select(pParse, pPrior, &uniondest);
  115191. if( rc ){
  115192. goto multi_select_end;
  115193. }
  115194. /* Code the current SELECT statement
  115195. */
  115196. if( p->op==TK_EXCEPT ){
  115197. op = SRT_Except;
  115198. }else{
  115199. assert( p->op==TK_UNION );
  115200. op = SRT_Union;
  115201. }
  115202. p->pPrior = 0;
  115203. pLimit = p->pLimit;
  115204. p->pLimit = 0;
  115205. uniondest.eDest = op;
  115206. explainSetInteger(iSub2, pParse->iNextSelectId);
  115207. rc = sqlite3Select(pParse, p, &uniondest);
  115208. testcase( rc!=SQLITE_OK );
  115209. /* Query flattening in sqlite3Select() might refill p->pOrderBy.
  115210. ** Be sure to delete p->pOrderBy, therefore, to avoid a memory leak. */
  115211. sqlite3ExprListDelete(db, p->pOrderBy);
  115212. pDelete = p->pPrior;
  115213. p->pPrior = pPrior;
  115214. p->pOrderBy = 0;
  115215. if( p->op==TK_UNION ){
  115216. p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
  115217. }
  115218. sqlite3ExprDelete(db, p->pLimit);
  115219. p->pLimit = pLimit;
  115220. p->iLimit = 0;
  115221. p->iOffset = 0;
  115222. /* Convert the data in the temporary table into whatever form
  115223. ** it is that we currently need.
  115224. */
  115225. assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
  115226. if( dest.eDest!=priorOp ){
  115227. int iCont, iBreak, iStart;
  115228. assert( p->pEList );
  115229. iBreak = sqlite3VdbeMakeLabel(v);
  115230. iCont = sqlite3VdbeMakeLabel(v);
  115231. computeLimitRegisters(pParse, p, iBreak);
  115232. sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
  115233. iStart = sqlite3VdbeCurrentAddr(v);
  115234. selectInnerLoop(pParse, p, unionTab,
  115235. 0, 0, &dest, iCont, iBreak);
  115236. sqlite3VdbeResolveLabel(v, iCont);
  115237. sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
  115238. sqlite3VdbeResolveLabel(v, iBreak);
  115239. sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
  115240. }
  115241. break;
  115242. }
  115243. default: assert( p->op==TK_INTERSECT ); {
  115244. int tab1, tab2;
  115245. int iCont, iBreak, iStart;
  115246. Expr *pLimit;
  115247. int addr;
  115248. SelectDest intersectdest;
  115249. int r1;
  115250. /* INTERSECT is different from the others since it requires
  115251. ** two temporary tables. Hence it has its own case. Begin
  115252. ** by allocating the tables we will need.
  115253. */
  115254. tab1 = pParse->nTab++;
  115255. tab2 = pParse->nTab++;
  115256. assert( p->pOrderBy==0 );
  115257. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
  115258. assert( p->addrOpenEphm[0] == -1 );
  115259. p->addrOpenEphm[0] = addr;
  115260. findRightmost(p)->selFlags |= SF_UsesEphemeral;
  115261. assert( p->pEList );
  115262. /* Code the SELECTs to our left into temporary table "tab1".
  115263. */
  115264. sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
  115265. explainSetInteger(iSub1, pParse->iNextSelectId);
  115266. rc = sqlite3Select(pParse, pPrior, &intersectdest);
  115267. if( rc ){
  115268. goto multi_select_end;
  115269. }
  115270. /* Code the current SELECT into temporary table "tab2"
  115271. */
  115272. addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
  115273. assert( p->addrOpenEphm[1] == -1 );
  115274. p->addrOpenEphm[1] = addr;
  115275. p->pPrior = 0;
  115276. pLimit = p->pLimit;
  115277. p->pLimit = 0;
  115278. intersectdest.iSDParm = tab2;
  115279. explainSetInteger(iSub2, pParse->iNextSelectId);
  115280. rc = sqlite3Select(pParse, p, &intersectdest);
  115281. testcase( rc!=SQLITE_OK );
  115282. pDelete = p->pPrior;
  115283. p->pPrior = pPrior;
  115284. if( p->nSelectRow>pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
  115285. sqlite3ExprDelete(db, p->pLimit);
  115286. p->pLimit = pLimit;
  115287. /* Generate code to take the intersection of the two temporary
  115288. ** tables.
  115289. */
  115290. assert( p->pEList );
  115291. iBreak = sqlite3VdbeMakeLabel(v);
  115292. iCont = sqlite3VdbeMakeLabel(v);
  115293. computeLimitRegisters(pParse, p, iBreak);
  115294. sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
  115295. r1 = sqlite3GetTempReg(pParse);
  115296. iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
  115297. sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0); VdbeCoverage(v);
  115298. sqlite3ReleaseTempReg(pParse, r1);
  115299. selectInnerLoop(pParse, p, tab1,
  115300. 0, 0, &dest, iCont, iBreak);
  115301. sqlite3VdbeResolveLabel(v, iCont);
  115302. sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
  115303. sqlite3VdbeResolveLabel(v, iBreak);
  115304. sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
  115305. sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
  115306. break;
  115307. }
  115308. }
  115309. explainComposite(pParse, p->op, iSub1, iSub2, p->op!=TK_ALL);
  115310. /* Compute collating sequences used by
  115311. ** temporary tables needed to implement the compound select.
  115312. ** Attach the KeyInfo structure to all temporary tables.
  115313. **
  115314. ** This section is run by the right-most SELECT statement only.
  115315. ** SELECT statements to the left always skip this part. The right-most
  115316. ** SELECT might also skip this part if it has no ORDER BY clause and
  115317. ** no temp tables are required.
  115318. */
  115319. if( p->selFlags & SF_UsesEphemeral ){
  115320. int i; /* Loop counter */
  115321. KeyInfo *pKeyInfo; /* Collating sequence for the result set */
  115322. Select *pLoop; /* For looping through SELECT statements */
  115323. CollSeq **apColl; /* For looping through pKeyInfo->aColl[] */
  115324. int nCol; /* Number of columns in result set */
  115325. assert( p->pNext==0 );
  115326. nCol = p->pEList->nExpr;
  115327. pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
  115328. if( !pKeyInfo ){
  115329. rc = SQLITE_NOMEM_BKPT;
  115330. goto multi_select_end;
  115331. }
  115332. for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
  115333. *apColl = multiSelectCollSeq(pParse, p, i);
  115334. if( 0==*apColl ){
  115335. *apColl = db->pDfltColl;
  115336. }
  115337. }
  115338. for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
  115339. for(i=0; i<2; i++){
  115340. int addr = pLoop->addrOpenEphm[i];
  115341. if( addr<0 ){
  115342. /* If [0] is unused then [1] is also unused. So we can
  115343. ** always safely abort as soon as the first unused slot is found */
  115344. assert( pLoop->addrOpenEphm[1]<0 );
  115345. break;
  115346. }
  115347. sqlite3VdbeChangeP2(v, addr, nCol);
  115348. sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
  115349. P4_KEYINFO);
  115350. pLoop->addrOpenEphm[i] = -1;
  115351. }
  115352. }
  115353. sqlite3KeyInfoUnref(pKeyInfo);
  115354. }
  115355. multi_select_end:
  115356. pDest->iSdst = dest.iSdst;
  115357. pDest->nSdst = dest.nSdst;
  115358. sqlite3SelectDelete(db, pDelete);
  115359. return rc;
  115360. }
  115361. #endif /* SQLITE_OMIT_COMPOUND_SELECT */
  115362. /*
  115363. ** Error message for when two or more terms of a compound select have different
  115364. ** size result sets.
  115365. */
  115366. SQLITE_PRIVATE void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
  115367. if( p->selFlags & SF_Values ){
  115368. sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
  115369. }else{
  115370. sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
  115371. " do not have the same number of result columns", selectOpName(p->op));
  115372. }
  115373. }
  115374. /*
  115375. ** Code an output subroutine for a coroutine implementation of a
  115376. ** SELECT statment.
  115377. **
  115378. ** The data to be output is contained in pIn->iSdst. There are
  115379. ** pIn->nSdst columns to be output. pDest is where the output should
  115380. ** be sent.
  115381. **
  115382. ** regReturn is the number of the register holding the subroutine
  115383. ** return address.
  115384. **
  115385. ** If regPrev>0 then it is the first register in a vector that
  115386. ** records the previous output. mem[regPrev] is a flag that is false
  115387. ** if there has been no previous output. If regPrev>0 then code is
  115388. ** generated to suppress duplicates. pKeyInfo is used for comparing
  115389. ** keys.
  115390. **
  115391. ** If the LIMIT found in p->iLimit is reached, jump immediately to
  115392. ** iBreak.
  115393. */
  115394. static int generateOutputSubroutine(
  115395. Parse *pParse, /* Parsing context */
  115396. Select *p, /* The SELECT statement */
  115397. SelectDest *pIn, /* Coroutine supplying data */
  115398. SelectDest *pDest, /* Where to send the data */
  115399. int regReturn, /* The return address register */
  115400. int regPrev, /* Previous result register. No uniqueness if 0 */
  115401. KeyInfo *pKeyInfo, /* For comparing with previous entry */
  115402. int iBreak /* Jump here if we hit the LIMIT */
  115403. ){
  115404. Vdbe *v = pParse->pVdbe;
  115405. int iContinue;
  115406. int addr;
  115407. addr = sqlite3VdbeCurrentAddr(v);
  115408. iContinue = sqlite3VdbeMakeLabel(v);
  115409. /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
  115410. */
  115411. if( regPrev ){
  115412. int addr1, addr2;
  115413. addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
  115414. addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
  115415. (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
  115416. sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
  115417. sqlite3VdbeJumpHere(v, addr1);
  115418. sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
  115419. sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
  115420. }
  115421. if( pParse->db->mallocFailed ) return 0;
  115422. /* Suppress the first OFFSET entries if there is an OFFSET clause
  115423. */
  115424. codeOffset(v, p->iOffset, iContinue);
  115425. assert( pDest->eDest!=SRT_Exists );
  115426. assert( pDest->eDest!=SRT_Table );
  115427. switch( pDest->eDest ){
  115428. /* Store the result as data using a unique key.
  115429. */
  115430. case SRT_EphemTab: {
  115431. int r1 = sqlite3GetTempReg(pParse);
  115432. int r2 = sqlite3GetTempReg(pParse);
  115433. sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
  115434. sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
  115435. sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
  115436. sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
  115437. sqlite3ReleaseTempReg(pParse, r2);
  115438. sqlite3ReleaseTempReg(pParse, r1);
  115439. break;
  115440. }
  115441. #ifndef SQLITE_OMIT_SUBQUERY
  115442. /* If we are creating a set for an "expr IN (SELECT ...)".
  115443. */
  115444. case SRT_Set: {
  115445. int r1;
  115446. testcase( pIn->nSdst>1 );
  115447. r1 = sqlite3GetTempReg(pParse);
  115448. sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
  115449. r1, pDest->zAffSdst, pIn->nSdst);
  115450. sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
  115451. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
  115452. pIn->iSdst, pIn->nSdst);
  115453. sqlite3ReleaseTempReg(pParse, r1);
  115454. break;
  115455. }
  115456. /* If this is a scalar select that is part of an expression, then
  115457. ** store the results in the appropriate memory cell and break out
  115458. ** of the scan loop.
  115459. */
  115460. case SRT_Mem: {
  115461. assert( pIn->nSdst==1 || pParse->nErr>0 ); testcase( pIn->nSdst!=1 );
  115462. sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, 1);
  115463. /* The LIMIT clause will jump out of the loop for us */
  115464. break;
  115465. }
  115466. #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
  115467. /* The results are stored in a sequence of registers
  115468. ** starting at pDest->iSdst. Then the co-routine yields.
  115469. */
  115470. case SRT_Coroutine: {
  115471. if( pDest->iSdst==0 ){
  115472. pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
  115473. pDest->nSdst = pIn->nSdst;
  115474. }
  115475. sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
  115476. sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
  115477. break;
  115478. }
  115479. /* If none of the above, then the result destination must be
  115480. ** SRT_Output. This routine is never called with any other
  115481. ** destination other than the ones handled above or SRT_Output.
  115482. **
  115483. ** For SRT_Output, results are stored in a sequence of registers.
  115484. ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
  115485. ** return the next row of result.
  115486. */
  115487. default: {
  115488. assert( pDest->eDest==SRT_Output );
  115489. sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
  115490. sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
  115491. break;
  115492. }
  115493. }
  115494. /* Jump to the end of the loop if the LIMIT is reached.
  115495. */
  115496. if( p->iLimit ){
  115497. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
  115498. }
  115499. /* Generate the subroutine return
  115500. */
  115501. sqlite3VdbeResolveLabel(v, iContinue);
  115502. sqlite3VdbeAddOp1(v, OP_Return, regReturn);
  115503. return addr;
  115504. }
  115505. /*
  115506. ** Alternative compound select code generator for cases when there
  115507. ** is an ORDER BY clause.
  115508. **
  115509. ** We assume a query of the following form:
  115510. **
  115511. ** <selectA> <operator> <selectB> ORDER BY <orderbylist>
  115512. **
  115513. ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT. The idea
  115514. ** is to code both <selectA> and <selectB> with the ORDER BY clause as
  115515. ** co-routines. Then run the co-routines in parallel and merge the results
  115516. ** into the output. In addition to the two coroutines (called selectA and
  115517. ** selectB) there are 7 subroutines:
  115518. **
  115519. ** outA: Move the output of the selectA coroutine into the output
  115520. ** of the compound query.
  115521. **
  115522. ** outB: Move the output of the selectB coroutine into the output
  115523. ** of the compound query. (Only generated for UNION and
  115524. ** UNION ALL. EXCEPT and INSERTSECT never output a row that
  115525. ** appears only in B.)
  115526. **
  115527. ** AltB: Called when there is data from both coroutines and A<B.
  115528. **
  115529. ** AeqB: Called when there is data from both coroutines and A==B.
  115530. **
  115531. ** AgtB: Called when there is data from both coroutines and A>B.
  115532. **
  115533. ** EofA: Called when data is exhausted from selectA.
  115534. **
  115535. ** EofB: Called when data is exhausted from selectB.
  115536. **
  115537. ** The implementation of the latter five subroutines depend on which
  115538. ** <operator> is used:
  115539. **
  115540. **
  115541. ** UNION ALL UNION EXCEPT INTERSECT
  115542. ** ------------- ----------------- -------------- -----------------
  115543. ** AltB: outA, nextA outA, nextA outA, nextA nextA
  115544. **
  115545. ** AeqB: outA, nextA nextA nextA outA, nextA
  115546. **
  115547. ** AgtB: outB, nextB outB, nextB nextB nextB
  115548. **
  115549. ** EofA: outB, nextB outB, nextB halt halt
  115550. **
  115551. ** EofB: outA, nextA outA, nextA outA, nextA halt
  115552. **
  115553. ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
  115554. ** causes an immediate jump to EofA and an EOF on B following nextB causes
  115555. ** an immediate jump to EofB. Within EofA and EofB, and EOF on entry or
  115556. ** following nextX causes a jump to the end of the select processing.
  115557. **
  115558. ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
  115559. ** within the output subroutine. The regPrev register set holds the previously
  115560. ** output value. A comparison is made against this value and the output
  115561. ** is skipped if the next results would be the same as the previous.
  115562. **
  115563. ** The implementation plan is to implement the two coroutines and seven
  115564. ** subroutines first, then put the control logic at the bottom. Like this:
  115565. **
  115566. ** goto Init
  115567. ** coA: coroutine for left query (A)
  115568. ** coB: coroutine for right query (B)
  115569. ** outA: output one row of A
  115570. ** outB: output one row of B (UNION and UNION ALL only)
  115571. ** EofA: ...
  115572. ** EofB: ...
  115573. ** AltB: ...
  115574. ** AeqB: ...
  115575. ** AgtB: ...
  115576. ** Init: initialize coroutine registers
  115577. ** yield coA
  115578. ** if eof(A) goto EofA
  115579. ** yield coB
  115580. ** if eof(B) goto EofB
  115581. ** Cmpr: Compare A, B
  115582. ** Jump AltB, AeqB, AgtB
  115583. ** End: ...
  115584. **
  115585. ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
  115586. ** actually called using Gosub and they do not Return. EofA and EofB loop
  115587. ** until all data is exhausted then jump to the "end" labe. AltB, AeqB,
  115588. ** and AgtB jump to either L2 or to one of EofA or EofB.
  115589. */
  115590. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  115591. static int multiSelectOrderBy(
  115592. Parse *pParse, /* Parsing context */
  115593. Select *p, /* The right-most of SELECTs to be coded */
  115594. SelectDest *pDest /* What to do with query results */
  115595. ){
  115596. int i, j; /* Loop counters */
  115597. Select *pPrior; /* Another SELECT immediately to our left */
  115598. Vdbe *v; /* Generate code to this VDBE */
  115599. SelectDest destA; /* Destination for coroutine A */
  115600. SelectDest destB; /* Destination for coroutine B */
  115601. int regAddrA; /* Address register for select-A coroutine */
  115602. int regAddrB; /* Address register for select-B coroutine */
  115603. int addrSelectA; /* Address of the select-A coroutine */
  115604. int addrSelectB; /* Address of the select-B coroutine */
  115605. int regOutA; /* Address register for the output-A subroutine */
  115606. int regOutB; /* Address register for the output-B subroutine */
  115607. int addrOutA; /* Address of the output-A subroutine */
  115608. int addrOutB = 0; /* Address of the output-B subroutine */
  115609. int addrEofA; /* Address of the select-A-exhausted subroutine */
  115610. int addrEofA_noB; /* Alternate addrEofA if B is uninitialized */
  115611. int addrEofB; /* Address of the select-B-exhausted subroutine */
  115612. int addrAltB; /* Address of the A<B subroutine */
  115613. int addrAeqB; /* Address of the A==B subroutine */
  115614. int addrAgtB; /* Address of the A>B subroutine */
  115615. int regLimitA; /* Limit register for select-A */
  115616. int regLimitB; /* Limit register for select-A */
  115617. int regPrev; /* A range of registers to hold previous output */
  115618. int savedLimit; /* Saved value of p->iLimit */
  115619. int savedOffset; /* Saved value of p->iOffset */
  115620. int labelCmpr; /* Label for the start of the merge algorithm */
  115621. int labelEnd; /* Label for the end of the overall SELECT stmt */
  115622. int addr1; /* Jump instructions that get retargetted */
  115623. int op; /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
  115624. KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
  115625. KeyInfo *pKeyMerge; /* Comparison information for merging rows */
  115626. sqlite3 *db; /* Database connection */
  115627. ExprList *pOrderBy; /* The ORDER BY clause */
  115628. int nOrderBy; /* Number of terms in the ORDER BY clause */
  115629. int *aPermute; /* Mapping from ORDER BY terms to result set columns */
  115630. #ifndef SQLITE_OMIT_EXPLAIN
  115631. int iSub1; /* EQP id of left-hand query */
  115632. int iSub2; /* EQP id of right-hand query */
  115633. #endif
  115634. assert( p->pOrderBy!=0 );
  115635. assert( pKeyDup==0 ); /* "Managed" code needs this. Ticket #3382. */
  115636. db = pParse->db;
  115637. v = pParse->pVdbe;
  115638. assert( v!=0 ); /* Already thrown the error if VDBE alloc failed */
  115639. labelEnd = sqlite3VdbeMakeLabel(v);
  115640. labelCmpr = sqlite3VdbeMakeLabel(v);
  115641. /* Patch up the ORDER BY clause
  115642. */
  115643. op = p->op;
  115644. pPrior = p->pPrior;
  115645. assert( pPrior->pOrderBy==0 );
  115646. pOrderBy = p->pOrderBy;
  115647. assert( pOrderBy );
  115648. nOrderBy = pOrderBy->nExpr;
  115649. /* For operators other than UNION ALL we have to make sure that
  115650. ** the ORDER BY clause covers every term of the result set. Add
  115651. ** terms to the ORDER BY clause as necessary.
  115652. */
  115653. if( op!=TK_ALL ){
  115654. for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
  115655. struct ExprList_item *pItem;
  115656. for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
  115657. assert( pItem->u.x.iOrderByCol>0 );
  115658. if( pItem->u.x.iOrderByCol==i ) break;
  115659. }
  115660. if( j==nOrderBy ){
  115661. Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
  115662. if( pNew==0 ) return SQLITE_NOMEM_BKPT;
  115663. pNew->flags |= EP_IntValue;
  115664. pNew->u.iValue = i;
  115665. p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
  115666. if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
  115667. }
  115668. }
  115669. }
  115670. /* Compute the comparison permutation and keyinfo that is used with
  115671. ** the permutation used to determine if the next
  115672. ** row of results comes from selectA or selectB. Also add explicit
  115673. ** collations to the ORDER BY clause terms so that when the subqueries
  115674. ** to the right and the left are evaluated, they use the correct
  115675. ** collation.
  115676. */
  115677. aPermute = sqlite3DbMallocRawNN(db, sizeof(int)*(nOrderBy + 1));
  115678. if( aPermute ){
  115679. struct ExprList_item *pItem;
  115680. aPermute[0] = nOrderBy;
  115681. for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
  115682. assert( pItem->u.x.iOrderByCol>0 );
  115683. assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
  115684. aPermute[i] = pItem->u.x.iOrderByCol - 1;
  115685. }
  115686. pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
  115687. }else{
  115688. pKeyMerge = 0;
  115689. }
  115690. /* Reattach the ORDER BY clause to the query.
  115691. */
  115692. p->pOrderBy = pOrderBy;
  115693. pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
  115694. /* Allocate a range of temporary registers and the KeyInfo needed
  115695. ** for the logic that removes duplicate result rows when the
  115696. ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
  115697. */
  115698. if( op==TK_ALL ){
  115699. regPrev = 0;
  115700. }else{
  115701. int nExpr = p->pEList->nExpr;
  115702. assert( nOrderBy>=nExpr || db->mallocFailed );
  115703. regPrev = pParse->nMem+1;
  115704. pParse->nMem += nExpr+1;
  115705. sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
  115706. pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
  115707. if( pKeyDup ){
  115708. assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
  115709. for(i=0; i<nExpr; i++){
  115710. pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
  115711. pKeyDup->aSortOrder[i] = 0;
  115712. }
  115713. }
  115714. }
  115715. /* Separate the left and the right query from one another
  115716. */
  115717. p->pPrior = 0;
  115718. pPrior->pNext = 0;
  115719. sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
  115720. if( pPrior->pPrior==0 ){
  115721. sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
  115722. }
  115723. /* Compute the limit registers */
  115724. computeLimitRegisters(pParse, p, labelEnd);
  115725. if( p->iLimit && op==TK_ALL ){
  115726. regLimitA = ++pParse->nMem;
  115727. regLimitB = ++pParse->nMem;
  115728. sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
  115729. regLimitA);
  115730. sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
  115731. }else{
  115732. regLimitA = regLimitB = 0;
  115733. }
  115734. sqlite3ExprDelete(db, p->pLimit);
  115735. p->pLimit = 0;
  115736. regAddrA = ++pParse->nMem;
  115737. regAddrB = ++pParse->nMem;
  115738. regOutA = ++pParse->nMem;
  115739. regOutB = ++pParse->nMem;
  115740. sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
  115741. sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
  115742. /* Generate a coroutine to evaluate the SELECT statement to the
  115743. ** left of the compound operator - the "A" select.
  115744. */
  115745. addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
  115746. addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
  115747. VdbeComment((v, "left SELECT"));
  115748. pPrior->iLimit = regLimitA;
  115749. explainSetInteger(iSub1, pParse->iNextSelectId);
  115750. sqlite3Select(pParse, pPrior, &destA);
  115751. sqlite3VdbeEndCoroutine(v, regAddrA);
  115752. sqlite3VdbeJumpHere(v, addr1);
  115753. /* Generate a coroutine to evaluate the SELECT statement on
  115754. ** the right - the "B" select
  115755. */
  115756. addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
  115757. addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
  115758. VdbeComment((v, "right SELECT"));
  115759. savedLimit = p->iLimit;
  115760. savedOffset = p->iOffset;
  115761. p->iLimit = regLimitB;
  115762. p->iOffset = 0;
  115763. explainSetInteger(iSub2, pParse->iNextSelectId);
  115764. sqlite3Select(pParse, p, &destB);
  115765. p->iLimit = savedLimit;
  115766. p->iOffset = savedOffset;
  115767. sqlite3VdbeEndCoroutine(v, regAddrB);
  115768. /* Generate a subroutine that outputs the current row of the A
  115769. ** select as the next output row of the compound select.
  115770. */
  115771. VdbeNoopComment((v, "Output routine for A"));
  115772. addrOutA = generateOutputSubroutine(pParse,
  115773. p, &destA, pDest, regOutA,
  115774. regPrev, pKeyDup, labelEnd);
  115775. /* Generate a subroutine that outputs the current row of the B
  115776. ** select as the next output row of the compound select.
  115777. */
  115778. if( op==TK_ALL || op==TK_UNION ){
  115779. VdbeNoopComment((v, "Output routine for B"));
  115780. addrOutB = generateOutputSubroutine(pParse,
  115781. p, &destB, pDest, regOutB,
  115782. regPrev, pKeyDup, labelEnd);
  115783. }
  115784. sqlite3KeyInfoUnref(pKeyDup);
  115785. /* Generate a subroutine to run when the results from select A
  115786. ** are exhausted and only data in select B remains.
  115787. */
  115788. if( op==TK_EXCEPT || op==TK_INTERSECT ){
  115789. addrEofA_noB = addrEofA = labelEnd;
  115790. }else{
  115791. VdbeNoopComment((v, "eof-A subroutine"));
  115792. addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
  115793. addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
  115794. VdbeCoverage(v);
  115795. sqlite3VdbeGoto(v, addrEofA);
  115796. p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
  115797. }
  115798. /* Generate a subroutine to run when the results from select B
  115799. ** are exhausted and only data in select A remains.
  115800. */
  115801. if( op==TK_INTERSECT ){
  115802. addrEofB = addrEofA;
  115803. if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
  115804. }else{
  115805. VdbeNoopComment((v, "eof-B subroutine"));
  115806. addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
  115807. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
  115808. sqlite3VdbeGoto(v, addrEofB);
  115809. }
  115810. /* Generate code to handle the case of A<B
  115811. */
  115812. VdbeNoopComment((v, "A-lt-B subroutine"));
  115813. addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
  115814. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
  115815. sqlite3VdbeGoto(v, labelCmpr);
  115816. /* Generate code to handle the case of A==B
  115817. */
  115818. if( op==TK_ALL ){
  115819. addrAeqB = addrAltB;
  115820. }else if( op==TK_INTERSECT ){
  115821. addrAeqB = addrAltB;
  115822. addrAltB++;
  115823. }else{
  115824. VdbeNoopComment((v, "A-eq-B subroutine"));
  115825. addrAeqB =
  115826. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
  115827. sqlite3VdbeGoto(v, labelCmpr);
  115828. }
  115829. /* Generate code to handle the case of A>B
  115830. */
  115831. VdbeNoopComment((v, "A-gt-B subroutine"));
  115832. addrAgtB = sqlite3VdbeCurrentAddr(v);
  115833. if( op==TK_ALL || op==TK_UNION ){
  115834. sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
  115835. }
  115836. sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
  115837. sqlite3VdbeGoto(v, labelCmpr);
  115838. /* This code runs once to initialize everything.
  115839. */
  115840. sqlite3VdbeJumpHere(v, addr1);
  115841. sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
  115842. sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
  115843. /* Implement the main merge loop
  115844. */
  115845. sqlite3VdbeResolveLabel(v, labelCmpr);
  115846. sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
  115847. sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
  115848. (char*)pKeyMerge, P4_KEYINFO);
  115849. sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
  115850. sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
  115851. /* Jump to the this point in order to terminate the query.
  115852. */
  115853. sqlite3VdbeResolveLabel(v, labelEnd);
  115854. /* Reassembly the compound query so that it will be freed correctly
  115855. ** by the calling function */
  115856. if( p->pPrior ){
  115857. sqlite3SelectDelete(db, p->pPrior);
  115858. }
  115859. p->pPrior = pPrior;
  115860. pPrior->pNext = p;
  115861. /*** TBD: Insert subroutine calls to close cursors on incomplete
  115862. **** subqueries ****/
  115863. explainComposite(pParse, p->op, iSub1, iSub2, 0);
  115864. return pParse->nErr!=0;
  115865. }
  115866. #endif
  115867. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  115868. /* An instance of the SubstContext object describes an substitution edit
  115869. ** to be performed on a parse tree.
  115870. **
  115871. ** All references to columns in table iTable are to be replaced by corresponding
  115872. ** expressions in pEList.
  115873. */
  115874. typedef struct SubstContext {
  115875. Parse *pParse; /* The parsing context */
  115876. int iTable; /* Replace references to this table */
  115877. int iNewTable; /* New table number */
  115878. int isLeftJoin; /* Add TK_IF_NULL_ROW opcodes on each replacement */
  115879. ExprList *pEList; /* Replacement expressions */
  115880. } SubstContext;
  115881. /* Forward Declarations */
  115882. static void substExprList(SubstContext*, ExprList*);
  115883. static void substSelect(SubstContext*, Select*, int);
  115884. /*
  115885. ** Scan through the expression pExpr. Replace every reference to
  115886. ** a column in table number iTable with a copy of the iColumn-th
  115887. ** entry in pEList. (But leave references to the ROWID column
  115888. ** unchanged.)
  115889. **
  115890. ** This routine is part of the flattening procedure. A subquery
  115891. ** whose result set is defined by pEList appears as entry in the
  115892. ** FROM clause of a SELECT such that the VDBE cursor assigned to that
  115893. ** FORM clause entry is iTable. This routine makes the necessary
  115894. ** changes to pExpr so that it refers directly to the source table
  115895. ** of the subquery rather the result set of the subquery.
  115896. */
  115897. static Expr *substExpr(
  115898. SubstContext *pSubst, /* Description of the substitution */
  115899. Expr *pExpr /* Expr in which substitution occurs */
  115900. ){
  115901. if( pExpr==0 ) return 0;
  115902. if( ExprHasProperty(pExpr, EP_FromJoin)
  115903. && pExpr->iRightJoinTable==pSubst->iTable
  115904. ){
  115905. pExpr->iRightJoinTable = pSubst->iNewTable;
  115906. }
  115907. if( pExpr->op==TK_COLUMN && pExpr->iTable==pSubst->iTable ){
  115908. if( pExpr->iColumn<0 ){
  115909. pExpr->op = TK_NULL;
  115910. }else{
  115911. Expr *pNew;
  115912. Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
  115913. Expr ifNullRow;
  115914. assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
  115915. assert( pExpr->pLeft==0 && pExpr->pRight==0 );
  115916. if( sqlite3ExprIsVector(pCopy) ){
  115917. sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
  115918. }else{
  115919. sqlite3 *db = pSubst->pParse->db;
  115920. if( pSubst->isLeftJoin && pCopy->op!=TK_COLUMN ){
  115921. memset(&ifNullRow, 0, sizeof(ifNullRow));
  115922. ifNullRow.op = TK_IF_NULL_ROW;
  115923. ifNullRow.pLeft = pCopy;
  115924. ifNullRow.iTable = pSubst->iNewTable;
  115925. pCopy = &ifNullRow;
  115926. }
  115927. pNew = sqlite3ExprDup(db, pCopy, 0);
  115928. if( pNew && pSubst->isLeftJoin ){
  115929. ExprSetProperty(pNew, EP_CanBeNull);
  115930. }
  115931. if( pNew && ExprHasProperty(pExpr,EP_FromJoin) ){
  115932. pNew->iRightJoinTable = pExpr->iRightJoinTable;
  115933. ExprSetProperty(pNew, EP_FromJoin);
  115934. }
  115935. sqlite3ExprDelete(db, pExpr);
  115936. pExpr = pNew;
  115937. }
  115938. }
  115939. }else{
  115940. if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
  115941. pExpr->iTable = pSubst->iNewTable;
  115942. }
  115943. pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
  115944. pExpr->pRight = substExpr(pSubst, pExpr->pRight);
  115945. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  115946. substSelect(pSubst, pExpr->x.pSelect, 1);
  115947. }else{
  115948. substExprList(pSubst, pExpr->x.pList);
  115949. }
  115950. }
  115951. return pExpr;
  115952. }
  115953. static void substExprList(
  115954. SubstContext *pSubst, /* Description of the substitution */
  115955. ExprList *pList /* List to scan and in which to make substitutes */
  115956. ){
  115957. int i;
  115958. if( pList==0 ) return;
  115959. for(i=0; i<pList->nExpr; i++){
  115960. pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
  115961. }
  115962. }
  115963. static void substSelect(
  115964. SubstContext *pSubst, /* Description of the substitution */
  115965. Select *p, /* SELECT statement in which to make substitutions */
  115966. int doPrior /* Do substitutes on p->pPrior too */
  115967. ){
  115968. SrcList *pSrc;
  115969. struct SrcList_item *pItem;
  115970. int i;
  115971. if( !p ) return;
  115972. do{
  115973. substExprList(pSubst, p->pEList);
  115974. substExprList(pSubst, p->pGroupBy);
  115975. substExprList(pSubst, p->pOrderBy);
  115976. p->pHaving = substExpr(pSubst, p->pHaving);
  115977. p->pWhere = substExpr(pSubst, p->pWhere);
  115978. pSrc = p->pSrc;
  115979. assert( pSrc!=0 );
  115980. for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
  115981. substSelect(pSubst, pItem->pSelect, 1);
  115982. if( pItem->fg.isTabFunc ){
  115983. substExprList(pSubst, pItem->u1.pFuncArg);
  115984. }
  115985. }
  115986. }while( doPrior && (p = p->pPrior)!=0 );
  115987. }
  115988. #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
  115989. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  115990. /*
  115991. ** This routine attempts to flatten subqueries as a performance optimization.
  115992. ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
  115993. **
  115994. ** To understand the concept of flattening, consider the following
  115995. ** query:
  115996. **
  115997. ** SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
  115998. **
  115999. ** The default way of implementing this query is to execute the
  116000. ** subquery first and store the results in a temporary table, then
  116001. ** run the outer query on that temporary table. This requires two
  116002. ** passes over the data. Furthermore, because the temporary table
  116003. ** has no indices, the WHERE clause on the outer query cannot be
  116004. ** optimized.
  116005. **
  116006. ** This routine attempts to rewrite queries such as the above into
  116007. ** a single flat select, like this:
  116008. **
  116009. ** SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
  116010. **
  116011. ** The code generated for this simplification gives the same result
  116012. ** but only has to scan the data once. And because indices might
  116013. ** exist on the table t1, a complete scan of the data might be
  116014. ** avoided.
  116015. **
  116016. ** Flattening is subject to the following constraints:
  116017. **
  116018. ** (**) We no longer attempt to flatten aggregate subqueries. Was:
  116019. ** The subquery and the outer query cannot both be aggregates.
  116020. **
  116021. ** (**) We no longer attempt to flatten aggregate subqueries. Was:
  116022. ** (2) If the subquery is an aggregate then
  116023. ** (2a) the outer query must not be a join and
  116024. ** (2b) the outer query must not use subqueries
  116025. ** other than the one FROM-clause subquery that is a candidate
  116026. ** for flattening. (This is due to ticket [2f7170d73bf9abf80]
  116027. ** from 2015-02-09.)
  116028. **
  116029. ** (3) If the subquery is the right operand of a LEFT JOIN then
  116030. ** (3a) the subquery may not be a join and
  116031. ** (3b) the FROM clause of the subquery may not contain a virtual
  116032. ** table and
  116033. ** (3c) the outer query may not be an aggregate.
  116034. **
  116035. ** (4) The subquery can not be DISTINCT.
  116036. **
  116037. ** (**) At one point restrictions (4) and (5) defined a subset of DISTINCT
  116038. ** sub-queries that were excluded from this optimization. Restriction
  116039. ** (4) has since been expanded to exclude all DISTINCT subqueries.
  116040. **
  116041. ** (**) We no longer attempt to flatten aggregate subqueries. Was:
  116042. ** If the subquery is aggregate, the outer query may not be DISTINCT.
  116043. **
  116044. ** (7) The subquery must have a FROM clause. TODO: For subqueries without
  116045. ** A FROM clause, consider adding a FROM clause with the special
  116046. ** table sqlite_once that consists of a single row containing a
  116047. ** single NULL.
  116048. **
  116049. ** (8) If the subquery uses LIMIT then the outer query may not be a join.
  116050. **
  116051. ** (9) If the subquery uses LIMIT then the outer query may not be aggregate.
  116052. **
  116053. ** (**) Restriction (10) was removed from the code on 2005-02-05 but we
  116054. ** accidently carried the comment forward until 2014-09-15. Original
  116055. ** constraint: "If the subquery is aggregate then the outer query
  116056. ** may not use LIMIT."
  116057. **
  116058. ** (11) The subquery and the outer query may not both have ORDER BY clauses.
  116059. **
  116060. ** (**) Not implemented. Subsumed into restriction (3). Was previously
  116061. ** a separate restriction deriving from ticket #350.
  116062. **
  116063. ** (13) The subquery and outer query may not both use LIMIT.
  116064. **
  116065. ** (14) The subquery may not use OFFSET.
  116066. **
  116067. ** (15) If the outer query is part of a compound select, then the
  116068. ** subquery may not use LIMIT.
  116069. ** (See ticket #2339 and ticket [02a8e81d44]).
  116070. **
  116071. ** (16) If the outer query is aggregate, then the subquery may not
  116072. ** use ORDER BY. (Ticket #2942) This used to not matter
  116073. ** until we introduced the group_concat() function.
  116074. **
  116075. ** (17) If the subquery is a compound select, then
  116076. ** (17a) all compound operators must be a UNION ALL, and
  116077. ** (17b) no terms within the subquery compound may be aggregate
  116078. ** or DISTINCT, and
  116079. ** (17c) every term within the subquery compound must have a FROM clause
  116080. ** (17d) the outer query may not be
  116081. ** (17d1) aggregate, or
  116082. ** (17d2) DISTINCT, or
  116083. ** (17d3) a join.
  116084. **
  116085. ** The parent and sub-query may contain WHERE clauses. Subject to
  116086. ** rules (11), (13) and (14), they may also contain ORDER BY,
  116087. ** LIMIT and OFFSET clauses. The subquery cannot use any compound
  116088. ** operator other than UNION ALL because all the other compound
  116089. ** operators have an implied DISTINCT which is disallowed by
  116090. ** restriction (4).
  116091. **
  116092. ** Also, each component of the sub-query must return the same number
  116093. ** of result columns. This is actually a requirement for any compound
  116094. ** SELECT statement, but all the code here does is make sure that no
  116095. ** such (illegal) sub-query is flattened. The caller will detect the
  116096. ** syntax error and return a detailed message.
  116097. **
  116098. ** (18) If the sub-query is a compound select, then all terms of the
  116099. ** ORDER BY clause of the parent must be simple references to
  116100. ** columns of the sub-query.
  116101. **
  116102. ** (19) If the subquery uses LIMIT then the outer query may not
  116103. ** have a WHERE clause.
  116104. **
  116105. ** (20) If the sub-query is a compound select, then it must not use
  116106. ** an ORDER BY clause. Ticket #3773. We could relax this constraint
  116107. ** somewhat by saying that the terms of the ORDER BY clause must
  116108. ** appear as unmodified result columns in the outer query. But we
  116109. ** have other optimizations in mind to deal with that case.
  116110. **
  116111. ** (21) If the subquery uses LIMIT then the outer query may not be
  116112. ** DISTINCT. (See ticket [752e1646fc]).
  116113. **
  116114. ** (22) The subquery may not be a recursive CTE.
  116115. **
  116116. ** (**) Subsumed into restriction (17d3). Was: If the outer query is
  116117. ** a recursive CTE, then the sub-query may not be a compound query.
  116118. ** This restriction is because transforming the
  116119. ** parent to a compound query confuses the code that handles
  116120. ** recursive queries in multiSelect().
  116121. **
  116122. ** (**) We no longer attempt to flatten aggregate subqueries. Was:
  116123. ** The subquery may not be an aggregate that uses the built-in min() or
  116124. ** or max() functions. (Without this restriction, a query like:
  116125. ** "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
  116126. ** return the value X for which Y was maximal.)
  116127. **
  116128. **
  116129. ** In this routine, the "p" parameter is a pointer to the outer query.
  116130. ** The subquery is p->pSrc->a[iFrom]. isAgg is true if the outer query
  116131. ** uses aggregates.
  116132. **
  116133. ** If flattening is not attempted, this routine is a no-op and returns 0.
  116134. ** If flattening is attempted this routine returns 1.
  116135. **
  116136. ** All of the expression analysis must occur on both the outer query and
  116137. ** the subquery before this routine runs.
  116138. */
  116139. static int flattenSubquery(
  116140. Parse *pParse, /* Parsing context */
  116141. Select *p, /* The parent or outer SELECT statement */
  116142. int iFrom, /* Index in p->pSrc->a[] of the inner subquery */
  116143. int isAgg /* True if outer SELECT uses aggregate functions */
  116144. ){
  116145. const char *zSavedAuthContext = pParse->zAuthContext;
  116146. Select *pParent; /* Current UNION ALL term of the other query */
  116147. Select *pSub; /* The inner query or "subquery" */
  116148. Select *pSub1; /* Pointer to the rightmost select in sub-query */
  116149. SrcList *pSrc; /* The FROM clause of the outer query */
  116150. SrcList *pSubSrc; /* The FROM clause of the subquery */
  116151. int iParent; /* VDBE cursor number of the pSub result set temp table */
  116152. int iNewParent = -1;/* Replacement table for iParent */
  116153. int isLeftJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
  116154. int i; /* Loop counter */
  116155. Expr *pWhere; /* The WHERE clause */
  116156. struct SrcList_item *pSubitem; /* The subquery */
  116157. sqlite3 *db = pParse->db;
  116158. /* Check to see if flattening is permitted. Return 0 if not.
  116159. */
  116160. assert( p!=0 );
  116161. assert( p->pPrior==0 );
  116162. if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
  116163. pSrc = p->pSrc;
  116164. assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
  116165. pSubitem = &pSrc->a[iFrom];
  116166. iParent = pSubitem->iCursor;
  116167. pSub = pSubitem->pSelect;
  116168. assert( pSub!=0 );
  116169. pSubSrc = pSub->pSrc;
  116170. assert( pSubSrc );
  116171. /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
  116172. ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
  116173. ** because they could be computed at compile-time. But when LIMIT and OFFSET
  116174. ** became arbitrary expressions, we were forced to add restrictions (13)
  116175. ** and (14). */
  116176. if( pSub->pLimit && p->pLimit ) return 0; /* Restriction (13) */
  116177. if( pSub->pLimit && pSub->pLimit->pRight ) return 0; /* Restriction (14) */
  116178. if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
  116179. return 0; /* Restriction (15) */
  116180. }
  116181. if( pSubSrc->nSrc==0 ) return 0; /* Restriction (7) */
  116182. if( pSub->selFlags & SF_Distinct ) return 0; /* Restriction (4) */
  116183. if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
  116184. return 0; /* Restrictions (8)(9) */
  116185. }
  116186. if( p->pOrderBy && pSub->pOrderBy ){
  116187. return 0; /* Restriction (11) */
  116188. }
  116189. if( isAgg && pSub->pOrderBy ) return 0; /* Restriction (16) */
  116190. if( pSub->pLimit && p->pWhere ) return 0; /* Restriction (19) */
  116191. if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
  116192. return 0; /* Restriction (21) */
  116193. }
  116194. if( pSub->selFlags & (SF_Recursive) ){
  116195. return 0; /* Restrictions (22) */
  116196. }
  116197. /*
  116198. ** If the subquery is the right operand of a LEFT JOIN, then the
  116199. ** subquery may not be a join itself (3a). Example of why this is not
  116200. ** allowed:
  116201. **
  116202. ** t1 LEFT OUTER JOIN (t2 JOIN t3)
  116203. **
  116204. ** If we flatten the above, we would get
  116205. **
  116206. ** (t1 LEFT OUTER JOIN t2) JOIN t3
  116207. **
  116208. ** which is not at all the same thing.
  116209. **
  116210. ** If the subquery is the right operand of a LEFT JOIN, then the outer
  116211. ** query cannot be an aggregate. (3c) This is an artifact of the way
  116212. ** aggregates are processed - there is no mechanism to determine if
  116213. ** the LEFT JOIN table should be all-NULL.
  116214. **
  116215. ** See also tickets #306, #350, and #3300.
  116216. */
  116217. if( (pSubitem->fg.jointype & JT_OUTER)!=0 ){
  116218. isLeftJoin = 1;
  116219. if( pSubSrc->nSrc>1 || isAgg || IsVirtual(pSubSrc->a[0].pTab) ){
  116220. /* (3a) (3c) (3b) */
  116221. return 0;
  116222. }
  116223. }
  116224. #ifdef SQLITE_EXTRA_IFNULLROW
  116225. else if( iFrom>0 && !isAgg ){
  116226. /* Setting isLeftJoin to -1 causes OP_IfNullRow opcodes to be generated for
  116227. ** every reference to any result column from subquery in a join, even
  116228. ** though they are not necessary. This will stress-test the OP_IfNullRow
  116229. ** opcode. */
  116230. isLeftJoin = -1;
  116231. }
  116232. #endif
  116233. /* Restriction (17): If the sub-query is a compound SELECT, then it must
  116234. ** use only the UNION ALL operator. And none of the simple select queries
  116235. ** that make up the compound SELECT are allowed to be aggregate or distinct
  116236. ** queries.
  116237. */
  116238. if( pSub->pPrior ){
  116239. if( pSub->pOrderBy ){
  116240. return 0; /* Restriction (20) */
  116241. }
  116242. if( isAgg || (p->selFlags & SF_Distinct)!=0 || pSrc->nSrc!=1 ){
  116243. return 0; /* (17d1), (17d2), or (17d3) */
  116244. }
  116245. for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
  116246. testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
  116247. testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
  116248. assert( pSub->pSrc!=0 );
  116249. assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
  116250. if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0 /* (17b) */
  116251. || (pSub1->pPrior && pSub1->op!=TK_ALL) /* (17a) */
  116252. || pSub1->pSrc->nSrc<1 /* (17c) */
  116253. ){
  116254. return 0;
  116255. }
  116256. testcase( pSub1->pSrc->nSrc>1 );
  116257. }
  116258. /* Restriction (18). */
  116259. if( p->pOrderBy ){
  116260. int ii;
  116261. for(ii=0; ii<p->pOrderBy->nExpr; ii++){
  116262. if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
  116263. }
  116264. }
  116265. }
  116266. /* Ex-restriction (23):
  116267. ** The only way that the recursive part of a CTE can contain a compound
  116268. ** subquery is for the subquery to be one term of a join. But if the
  116269. ** subquery is a join, then the flattening has already been stopped by
  116270. ** restriction (17d3)
  116271. */
  116272. assert( (p->selFlags & SF_Recursive)==0 || pSub->pPrior==0 );
  116273. /***** If we reach this point, flattening is permitted. *****/
  116274. SELECTTRACE(1,pParse,p,("flatten %s.%p from term %d\n",
  116275. pSub->zSelName, pSub, iFrom));
  116276. /* Authorize the subquery */
  116277. pParse->zAuthContext = pSubitem->zName;
  116278. TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
  116279. testcase( i==SQLITE_DENY );
  116280. pParse->zAuthContext = zSavedAuthContext;
  116281. /* If the sub-query is a compound SELECT statement, then (by restrictions
  116282. ** 17 and 18 above) it must be a UNION ALL and the parent query must
  116283. ** be of the form:
  116284. **
  116285. ** SELECT <expr-list> FROM (<sub-query>) <where-clause>
  116286. **
  116287. ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
  116288. ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
  116289. ** OFFSET clauses and joins them to the left-hand-side of the original
  116290. ** using UNION ALL operators. In this case N is the number of simple
  116291. ** select statements in the compound sub-query.
  116292. **
  116293. ** Example:
  116294. **
  116295. ** SELECT a+1 FROM (
  116296. ** SELECT x FROM tab
  116297. ** UNION ALL
  116298. ** SELECT y FROM tab
  116299. ** UNION ALL
  116300. ** SELECT abs(z*2) FROM tab2
  116301. ** ) WHERE a!=5 ORDER BY 1
  116302. **
  116303. ** Transformed into:
  116304. **
  116305. ** SELECT x+1 FROM tab WHERE x+1!=5
  116306. ** UNION ALL
  116307. ** SELECT y+1 FROM tab WHERE y+1!=5
  116308. ** UNION ALL
  116309. ** SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
  116310. ** ORDER BY 1
  116311. **
  116312. ** We call this the "compound-subquery flattening".
  116313. */
  116314. for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
  116315. Select *pNew;
  116316. ExprList *pOrderBy = p->pOrderBy;
  116317. Expr *pLimit = p->pLimit;
  116318. Select *pPrior = p->pPrior;
  116319. p->pOrderBy = 0;
  116320. p->pSrc = 0;
  116321. p->pPrior = 0;
  116322. p->pLimit = 0;
  116323. pNew = sqlite3SelectDup(db, p, 0);
  116324. sqlite3SelectSetName(pNew, pSub->zSelName);
  116325. p->pLimit = pLimit;
  116326. p->pOrderBy = pOrderBy;
  116327. p->pSrc = pSrc;
  116328. p->op = TK_ALL;
  116329. if( pNew==0 ){
  116330. p->pPrior = pPrior;
  116331. }else{
  116332. pNew->pPrior = pPrior;
  116333. if( pPrior ) pPrior->pNext = pNew;
  116334. pNew->pNext = p;
  116335. p->pPrior = pNew;
  116336. SELECTTRACE(2,pParse,p,
  116337. ("compound-subquery flattener creates %s.%p as peer\n",
  116338. pNew->zSelName, pNew));
  116339. }
  116340. if( db->mallocFailed ) return 1;
  116341. }
  116342. /* Begin flattening the iFrom-th entry of the FROM clause
  116343. ** in the outer query.
  116344. */
  116345. pSub = pSub1 = pSubitem->pSelect;
  116346. /* Delete the transient table structure associated with the
  116347. ** subquery
  116348. */
  116349. sqlite3DbFree(db, pSubitem->zDatabase);
  116350. sqlite3DbFree(db, pSubitem->zName);
  116351. sqlite3DbFree(db, pSubitem->zAlias);
  116352. pSubitem->zDatabase = 0;
  116353. pSubitem->zName = 0;
  116354. pSubitem->zAlias = 0;
  116355. pSubitem->pSelect = 0;
  116356. /* Defer deleting the Table object associated with the
  116357. ** subquery until code generation is
  116358. ** complete, since there may still exist Expr.pTab entries that
  116359. ** refer to the subquery even after flattening. Ticket #3346.
  116360. **
  116361. ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
  116362. */
  116363. if( ALWAYS(pSubitem->pTab!=0) ){
  116364. Table *pTabToDel = pSubitem->pTab;
  116365. if( pTabToDel->nTabRef==1 ){
  116366. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  116367. pTabToDel->pNextZombie = pToplevel->pZombieTab;
  116368. pToplevel->pZombieTab = pTabToDel;
  116369. }else{
  116370. pTabToDel->nTabRef--;
  116371. }
  116372. pSubitem->pTab = 0;
  116373. }
  116374. /* The following loop runs once for each term in a compound-subquery
  116375. ** flattening (as described above). If we are doing a different kind
  116376. ** of flattening - a flattening other than a compound-subquery flattening -
  116377. ** then this loop only runs once.
  116378. **
  116379. ** This loop moves all of the FROM elements of the subquery into the
  116380. ** the FROM clause of the outer query. Before doing this, remember
  116381. ** the cursor number for the original outer query FROM element in
  116382. ** iParent. The iParent cursor will never be used. Subsequent code
  116383. ** will scan expressions looking for iParent references and replace
  116384. ** those references with expressions that resolve to the subquery FROM
  116385. ** elements we are now copying in.
  116386. */
  116387. for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
  116388. int nSubSrc;
  116389. u8 jointype = 0;
  116390. pSubSrc = pSub->pSrc; /* FROM clause of subquery */
  116391. nSubSrc = pSubSrc->nSrc; /* Number of terms in subquery FROM clause */
  116392. pSrc = pParent->pSrc; /* FROM clause of the outer query */
  116393. if( pSrc ){
  116394. assert( pParent==p ); /* First time through the loop */
  116395. jointype = pSubitem->fg.jointype;
  116396. }else{
  116397. assert( pParent!=p ); /* 2nd and subsequent times through the loop */
  116398. pSrc = pParent->pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
  116399. if( pSrc==0 ){
  116400. assert( db->mallocFailed );
  116401. break;
  116402. }
  116403. }
  116404. /* The subquery uses a single slot of the FROM clause of the outer
  116405. ** query. If the subquery has more than one element in its FROM clause,
  116406. ** then expand the outer query to make space for it to hold all elements
  116407. ** of the subquery.
  116408. **
  116409. ** Example:
  116410. **
  116411. ** SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
  116412. **
  116413. ** The outer query has 3 slots in its FROM clause. One slot of the
  116414. ** outer query (the middle slot) is used by the subquery. The next
  116415. ** block of code will expand the outer query FROM clause to 4 slots.
  116416. ** The middle slot is expanded to two slots in order to make space
  116417. ** for the two elements in the FROM clause of the subquery.
  116418. */
  116419. if( nSubSrc>1 ){
  116420. pParent->pSrc = pSrc = sqlite3SrcListEnlarge(db, pSrc, nSubSrc-1,iFrom+1);
  116421. if( db->mallocFailed ){
  116422. break;
  116423. }
  116424. }
  116425. /* Transfer the FROM clause terms from the subquery into the
  116426. ** outer query.
  116427. */
  116428. for(i=0; i<nSubSrc; i++){
  116429. sqlite3IdListDelete(db, pSrc->a[i+iFrom].pUsing);
  116430. assert( pSrc->a[i+iFrom].fg.isTabFunc==0 );
  116431. pSrc->a[i+iFrom] = pSubSrc->a[i];
  116432. iNewParent = pSubSrc->a[i].iCursor;
  116433. memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
  116434. }
  116435. pSrc->a[iFrom].fg.jointype = jointype;
  116436. /* Now begin substituting subquery result set expressions for
  116437. ** references to the iParent in the outer query.
  116438. **
  116439. ** Example:
  116440. **
  116441. ** SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
  116442. ** \ \_____________ subquery __________/ /
  116443. ** \_____________________ outer query ______________________________/
  116444. **
  116445. ** We look at every expression in the outer query and every place we see
  116446. ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
  116447. */
  116448. if( pSub->pOrderBy ){
  116449. /* At this point, any non-zero iOrderByCol values indicate that the
  116450. ** ORDER BY column expression is identical to the iOrderByCol'th
  116451. ** expression returned by SELECT statement pSub. Since these values
  116452. ** do not necessarily correspond to columns in SELECT statement pParent,
  116453. ** zero them before transfering the ORDER BY clause.
  116454. **
  116455. ** Not doing this may cause an error if a subsequent call to this
  116456. ** function attempts to flatten a compound sub-query into pParent
  116457. ** (the only way this can happen is if the compound sub-query is
  116458. ** currently part of pSub->pSrc). See ticket [d11a6e908f]. */
  116459. ExprList *pOrderBy = pSub->pOrderBy;
  116460. for(i=0; i<pOrderBy->nExpr; i++){
  116461. pOrderBy->a[i].u.x.iOrderByCol = 0;
  116462. }
  116463. assert( pParent->pOrderBy==0 );
  116464. pParent->pOrderBy = pOrderBy;
  116465. pSub->pOrderBy = 0;
  116466. }
  116467. pWhere = sqlite3ExprDup(db, pSub->pWhere, 0);
  116468. if( isLeftJoin>0 ){
  116469. setJoinExpr(pWhere, iNewParent);
  116470. }
  116471. pParent->pWhere = sqlite3ExprAnd(db, pWhere, pParent->pWhere);
  116472. if( db->mallocFailed==0 ){
  116473. SubstContext x;
  116474. x.pParse = pParse;
  116475. x.iTable = iParent;
  116476. x.iNewTable = iNewParent;
  116477. x.isLeftJoin = isLeftJoin;
  116478. x.pEList = pSub->pEList;
  116479. substSelect(&x, pParent, 0);
  116480. }
  116481. /* The flattened query is distinct if either the inner or the
  116482. ** outer query is distinct.
  116483. */
  116484. pParent->selFlags |= pSub->selFlags & SF_Distinct;
  116485. /*
  116486. ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
  116487. **
  116488. ** One is tempted to try to add a and b to combine the limits. But this
  116489. ** does not work if either limit is negative.
  116490. */
  116491. if( pSub->pLimit ){
  116492. pParent->pLimit = pSub->pLimit;
  116493. pSub->pLimit = 0;
  116494. }
  116495. }
  116496. /* Finially, delete what is left of the subquery and return
  116497. ** success.
  116498. */
  116499. sqlite3SelectDelete(db, pSub1);
  116500. #if SELECTTRACE_ENABLED
  116501. if( sqlite3SelectTrace & 0x100 ){
  116502. SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
  116503. sqlite3TreeViewSelect(0, p, 0);
  116504. }
  116505. #endif
  116506. return 1;
  116507. }
  116508. #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
  116509. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  116510. /*
  116511. ** Make copies of relevant WHERE clause terms of the outer query into
  116512. ** the WHERE clause of subquery. Example:
  116513. **
  116514. ** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
  116515. **
  116516. ** Transformed into:
  116517. **
  116518. ** SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
  116519. ** WHERE x=5 AND y=10;
  116520. **
  116521. ** The hope is that the terms added to the inner query will make it more
  116522. ** efficient.
  116523. **
  116524. ** Do not attempt this optimization if:
  116525. **
  116526. ** (1) (** This restriction was removed on 2017-09-29. We used to
  116527. ** disallow this optimization for aggregate subqueries, but now
  116528. ** it is allowed by putting the extra terms on the HAVING clause.
  116529. ** The added HAVING clause is pointless if the subquery lacks
  116530. ** a GROUP BY clause. But such a HAVING clause is also harmless
  116531. ** so there does not appear to be any reason to add extra logic
  116532. ** to suppress it. **)
  116533. **
  116534. ** (2) The inner query is the recursive part of a common table expression.
  116535. **
  116536. ** (3) The inner query has a LIMIT clause (since the changes to the WHERE
  116537. ** close would change the meaning of the LIMIT).
  116538. **
  116539. ** (4) The inner query is the right operand of a LEFT JOIN and the
  116540. ** expression to be pushed down does not come from the ON clause
  116541. ** on that LEFT JOIN.
  116542. **
  116543. ** (5) The WHERE clause expression originates in the ON or USING clause
  116544. ** of a LEFT JOIN where iCursor is not the right-hand table of that
  116545. ** left join. An example:
  116546. **
  116547. ** SELECT *
  116548. ** FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
  116549. ** JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
  116550. ** LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
  116551. **
  116552. ** The correct answer is three rows: (1,1,NULL),(2,2,8),(2,2,9).
  116553. ** But if the (b2=2) term were to be pushed down into the bb subquery,
  116554. ** then the (1,1,NULL) row would be suppressed.
  116555. **
  116556. ** Return 0 if no changes are made and non-zero if one or more WHERE clause
  116557. ** terms are duplicated into the subquery.
  116558. */
  116559. static int pushDownWhereTerms(
  116560. Parse *pParse, /* Parse context (for malloc() and error reporting) */
  116561. Select *pSubq, /* The subquery whose WHERE clause is to be augmented */
  116562. Expr *pWhere, /* The WHERE clause of the outer query */
  116563. int iCursor, /* Cursor number of the subquery */
  116564. int isLeftJoin /* True if pSubq is the right term of a LEFT JOIN */
  116565. ){
  116566. Expr *pNew;
  116567. int nChng = 0;
  116568. if( pWhere==0 ) return 0;
  116569. if( pSubq->selFlags & SF_Recursive ) return 0; /* restriction (2) */
  116570. #ifdef SQLITE_DEBUG
  116571. /* Only the first term of a compound can have a WITH clause. But make
  116572. ** sure no other terms are marked SF_Recursive in case something changes
  116573. ** in the future.
  116574. */
  116575. {
  116576. Select *pX;
  116577. for(pX=pSubq; pX; pX=pX->pPrior){
  116578. assert( (pX->selFlags & (SF_Recursive))==0 );
  116579. }
  116580. }
  116581. #endif
  116582. if( pSubq->pLimit!=0 ){
  116583. return 0; /* restriction (3) */
  116584. }
  116585. while( pWhere->op==TK_AND ){
  116586. nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight,
  116587. iCursor, isLeftJoin);
  116588. pWhere = pWhere->pLeft;
  116589. }
  116590. if( isLeftJoin
  116591. && (ExprHasProperty(pWhere,EP_FromJoin)==0
  116592. || pWhere->iRightJoinTable!=iCursor)
  116593. ){
  116594. return 0; /* restriction (4) */
  116595. }
  116596. if( ExprHasProperty(pWhere,EP_FromJoin) && pWhere->iRightJoinTable!=iCursor ){
  116597. return 0; /* restriction (5) */
  116598. }
  116599. if( sqlite3ExprIsTableConstant(pWhere, iCursor) ){
  116600. nChng++;
  116601. while( pSubq ){
  116602. SubstContext x;
  116603. pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
  116604. unsetJoinExpr(pNew, -1);
  116605. x.pParse = pParse;
  116606. x.iTable = iCursor;
  116607. x.iNewTable = iCursor;
  116608. x.isLeftJoin = 0;
  116609. x.pEList = pSubq->pEList;
  116610. pNew = substExpr(&x, pNew);
  116611. if( pSubq->selFlags & SF_Aggregate ){
  116612. pSubq->pHaving = sqlite3ExprAnd(pParse->db, pSubq->pHaving, pNew);
  116613. }else{
  116614. pSubq->pWhere = sqlite3ExprAnd(pParse->db, pSubq->pWhere, pNew);
  116615. }
  116616. pSubq = pSubq->pPrior;
  116617. }
  116618. }
  116619. return nChng;
  116620. }
  116621. #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
  116622. /*
  116623. ** The pFunc is the only aggregate function in the query. Check to see
  116624. ** if the query is a candidate for the min/max optimization.
  116625. **
  116626. ** If the query is a candidate for the min/max optimization, then set
  116627. ** *ppMinMax to be an ORDER BY clause to be used for the optimization
  116628. ** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
  116629. ** whether pFunc is a min() or max() function.
  116630. **
  116631. ** If the query is not a candidate for the min/max optimization, return
  116632. ** WHERE_ORDERBY_NORMAL (which must be zero).
  116633. **
  116634. ** This routine must be called after aggregate functions have been
  116635. ** located but before their arguments have been subjected to aggregate
  116636. ** analysis.
  116637. */
  116638. static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
  116639. int eRet = WHERE_ORDERBY_NORMAL; /* Return value */
  116640. ExprList *pEList = pFunc->x.pList; /* Arguments to agg function */
  116641. const char *zFunc; /* Name of aggregate function pFunc */
  116642. ExprList *pOrderBy;
  116643. u8 sortOrder;
  116644. assert( *ppMinMax==0 );
  116645. assert( pFunc->op==TK_AGG_FUNCTION );
  116646. if( pEList==0 || pEList->nExpr!=1 ) return eRet;
  116647. zFunc = pFunc->u.zToken;
  116648. if( sqlite3StrICmp(zFunc, "min")==0 ){
  116649. eRet = WHERE_ORDERBY_MIN;
  116650. sortOrder = SQLITE_SO_ASC;
  116651. }else if( sqlite3StrICmp(zFunc, "max")==0 ){
  116652. eRet = WHERE_ORDERBY_MAX;
  116653. sortOrder = SQLITE_SO_DESC;
  116654. }else{
  116655. return eRet;
  116656. }
  116657. *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
  116658. assert( pOrderBy!=0 || db->mallocFailed );
  116659. if( pOrderBy ) pOrderBy->a[0].sortOrder = sortOrder;
  116660. return eRet;
  116661. }
  116662. /*
  116663. ** The select statement passed as the first argument is an aggregate query.
  116664. ** The second argument is the associated aggregate-info object. This
  116665. ** function tests if the SELECT is of the form:
  116666. **
  116667. ** SELECT count(*) FROM <tbl>
  116668. **
  116669. ** where table is a database table, not a sub-select or view. If the query
  116670. ** does match this pattern, then a pointer to the Table object representing
  116671. ** <tbl> is returned. Otherwise, 0 is returned.
  116672. */
  116673. static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
  116674. Table *pTab;
  116675. Expr *pExpr;
  116676. assert( !p->pGroupBy );
  116677. if( p->pWhere || p->pEList->nExpr!=1
  116678. || p->pSrc->nSrc!=1 || p->pSrc->a[0].pSelect
  116679. ){
  116680. return 0;
  116681. }
  116682. pTab = p->pSrc->a[0].pTab;
  116683. pExpr = p->pEList->a[0].pExpr;
  116684. assert( pTab && !pTab->pSelect && pExpr );
  116685. if( IsVirtual(pTab) ) return 0;
  116686. if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
  116687. if( NEVER(pAggInfo->nFunc==0) ) return 0;
  116688. if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
  116689. if( pExpr->flags&EP_Distinct ) return 0;
  116690. return pTab;
  116691. }
  116692. /*
  116693. ** If the source-list item passed as an argument was augmented with an
  116694. ** INDEXED BY clause, then try to locate the specified index. If there
  116695. ** was such a clause and the named index cannot be found, return
  116696. ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
  116697. ** pFrom->pIndex and return SQLITE_OK.
  116698. */
  116699. SQLITE_PRIVATE int sqlite3IndexedByLookup(Parse *pParse, struct SrcList_item *pFrom){
  116700. if( pFrom->pTab && pFrom->fg.isIndexedBy ){
  116701. Table *pTab = pFrom->pTab;
  116702. char *zIndexedBy = pFrom->u1.zIndexedBy;
  116703. Index *pIdx;
  116704. for(pIdx=pTab->pIndex;
  116705. pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
  116706. pIdx=pIdx->pNext
  116707. );
  116708. if( !pIdx ){
  116709. sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
  116710. pParse->checkSchema = 1;
  116711. return SQLITE_ERROR;
  116712. }
  116713. pFrom->pIBIndex = pIdx;
  116714. }
  116715. return SQLITE_OK;
  116716. }
  116717. /*
  116718. ** Detect compound SELECT statements that use an ORDER BY clause with
  116719. ** an alternative collating sequence.
  116720. **
  116721. ** SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
  116722. **
  116723. ** These are rewritten as a subquery:
  116724. **
  116725. ** SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
  116726. ** ORDER BY ... COLLATE ...
  116727. **
  116728. ** This transformation is necessary because the multiSelectOrderBy() routine
  116729. ** above that generates the code for a compound SELECT with an ORDER BY clause
  116730. ** uses a merge algorithm that requires the same collating sequence on the
  116731. ** result columns as on the ORDER BY clause. See ticket
  116732. ** http://www.sqlite.org/src/info/6709574d2a
  116733. **
  116734. ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
  116735. ** The UNION ALL operator works fine with multiSelectOrderBy() even when
  116736. ** there are COLLATE terms in the ORDER BY.
  116737. */
  116738. static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
  116739. int i;
  116740. Select *pNew;
  116741. Select *pX;
  116742. sqlite3 *db;
  116743. struct ExprList_item *a;
  116744. SrcList *pNewSrc;
  116745. Parse *pParse;
  116746. Token dummy;
  116747. if( p->pPrior==0 ) return WRC_Continue;
  116748. if( p->pOrderBy==0 ) return WRC_Continue;
  116749. for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
  116750. if( pX==0 ) return WRC_Continue;
  116751. a = p->pOrderBy->a;
  116752. for(i=p->pOrderBy->nExpr-1; i>=0; i--){
  116753. if( a[i].pExpr->flags & EP_Collate ) break;
  116754. }
  116755. if( i<0 ) return WRC_Continue;
  116756. /* If we reach this point, that means the transformation is required. */
  116757. pParse = pWalker->pParse;
  116758. db = pParse->db;
  116759. pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
  116760. if( pNew==0 ) return WRC_Abort;
  116761. memset(&dummy, 0, sizeof(dummy));
  116762. pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0,0);
  116763. if( pNewSrc==0 ) return WRC_Abort;
  116764. *pNew = *p;
  116765. p->pSrc = pNewSrc;
  116766. p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
  116767. p->op = TK_SELECT;
  116768. p->pWhere = 0;
  116769. pNew->pGroupBy = 0;
  116770. pNew->pHaving = 0;
  116771. pNew->pOrderBy = 0;
  116772. p->pPrior = 0;
  116773. p->pNext = 0;
  116774. p->pWith = 0;
  116775. p->selFlags &= ~SF_Compound;
  116776. assert( (p->selFlags & SF_Converted)==0 );
  116777. p->selFlags |= SF_Converted;
  116778. assert( pNew->pPrior!=0 );
  116779. pNew->pPrior->pNext = pNew;
  116780. pNew->pLimit = 0;
  116781. return WRC_Continue;
  116782. }
  116783. /*
  116784. ** Check to see if the FROM clause term pFrom has table-valued function
  116785. ** arguments. If it does, leave an error message in pParse and return
  116786. ** non-zero, since pFrom is not allowed to be a table-valued function.
  116787. */
  116788. static int cannotBeFunction(Parse *pParse, struct SrcList_item *pFrom){
  116789. if( pFrom->fg.isTabFunc ){
  116790. sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
  116791. return 1;
  116792. }
  116793. return 0;
  116794. }
  116795. #ifndef SQLITE_OMIT_CTE
  116796. /*
  116797. ** Argument pWith (which may be NULL) points to a linked list of nested
  116798. ** WITH contexts, from inner to outermost. If the table identified by
  116799. ** FROM clause element pItem is really a common-table-expression (CTE)
  116800. ** then return a pointer to the CTE definition for that table. Otherwise
  116801. ** return NULL.
  116802. **
  116803. ** If a non-NULL value is returned, set *ppContext to point to the With
  116804. ** object that the returned CTE belongs to.
  116805. */
  116806. static struct Cte *searchWith(
  116807. With *pWith, /* Current innermost WITH clause */
  116808. struct SrcList_item *pItem, /* FROM clause element to resolve */
  116809. With **ppContext /* OUT: WITH clause return value belongs to */
  116810. ){
  116811. const char *zName;
  116812. if( pItem->zDatabase==0 && (zName = pItem->zName)!=0 ){
  116813. With *p;
  116814. for(p=pWith; p; p=p->pOuter){
  116815. int i;
  116816. for(i=0; i<p->nCte; i++){
  116817. if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
  116818. *ppContext = p;
  116819. return &p->a[i];
  116820. }
  116821. }
  116822. }
  116823. }
  116824. return 0;
  116825. }
  116826. /* The code generator maintains a stack of active WITH clauses
  116827. ** with the inner-most WITH clause being at the top of the stack.
  116828. **
  116829. ** This routine pushes the WITH clause passed as the second argument
  116830. ** onto the top of the stack. If argument bFree is true, then this
  116831. ** WITH clause will never be popped from the stack. In this case it
  116832. ** should be freed along with the Parse object. In other cases, when
  116833. ** bFree==0, the With object will be freed along with the SELECT
  116834. ** statement with which it is associated.
  116835. */
  116836. SQLITE_PRIVATE void sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
  116837. assert( bFree==0 || (pParse->pWith==0 && pParse->pWithToFree==0) );
  116838. if( pWith ){
  116839. assert( pParse->pWith!=pWith );
  116840. pWith->pOuter = pParse->pWith;
  116841. pParse->pWith = pWith;
  116842. if( bFree ) pParse->pWithToFree = pWith;
  116843. }
  116844. }
  116845. /*
  116846. ** This function checks if argument pFrom refers to a CTE declared by
  116847. ** a WITH clause on the stack currently maintained by the parser. And,
  116848. ** if currently processing a CTE expression, if it is a recursive
  116849. ** reference to the current CTE.
  116850. **
  116851. ** If pFrom falls into either of the two categories above, pFrom->pTab
  116852. ** and other fields are populated accordingly. The caller should check
  116853. ** (pFrom->pTab!=0) to determine whether or not a successful match
  116854. ** was found.
  116855. **
  116856. ** Whether or not a match is found, SQLITE_OK is returned if no error
  116857. ** occurs. If an error does occur, an error message is stored in the
  116858. ** parser and some error code other than SQLITE_OK returned.
  116859. */
  116860. static int withExpand(
  116861. Walker *pWalker,
  116862. struct SrcList_item *pFrom
  116863. ){
  116864. Parse *pParse = pWalker->pParse;
  116865. sqlite3 *db = pParse->db;
  116866. struct Cte *pCte; /* Matched CTE (or NULL if no match) */
  116867. With *pWith; /* WITH clause that pCte belongs to */
  116868. assert( pFrom->pTab==0 );
  116869. pCte = searchWith(pParse->pWith, pFrom, &pWith);
  116870. if( pCte ){
  116871. Table *pTab;
  116872. ExprList *pEList;
  116873. Select *pSel;
  116874. Select *pLeft; /* Left-most SELECT statement */
  116875. int bMayRecursive; /* True if compound joined by UNION [ALL] */
  116876. With *pSavedWith; /* Initial value of pParse->pWith */
  116877. /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
  116878. ** recursive reference to CTE pCte. Leave an error in pParse and return
  116879. ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
  116880. ** In this case, proceed. */
  116881. if( pCte->zCteErr ){
  116882. sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
  116883. return SQLITE_ERROR;
  116884. }
  116885. if( cannotBeFunction(pParse, pFrom) ) return SQLITE_ERROR;
  116886. assert( pFrom->pTab==0 );
  116887. pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
  116888. if( pTab==0 ) return WRC_Abort;
  116889. pTab->nTabRef = 1;
  116890. pTab->zName = sqlite3DbStrDup(db, pCte->zName);
  116891. pTab->iPKey = -1;
  116892. pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  116893. pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
  116894. pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
  116895. if( db->mallocFailed ) return SQLITE_NOMEM_BKPT;
  116896. assert( pFrom->pSelect );
  116897. /* Check if this is a recursive CTE. */
  116898. pSel = pFrom->pSelect;
  116899. bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
  116900. if( bMayRecursive ){
  116901. int i;
  116902. SrcList *pSrc = pFrom->pSelect->pSrc;
  116903. for(i=0; i<pSrc->nSrc; i++){
  116904. struct SrcList_item *pItem = &pSrc->a[i];
  116905. if( pItem->zDatabase==0
  116906. && pItem->zName!=0
  116907. && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
  116908. ){
  116909. pItem->pTab = pTab;
  116910. pItem->fg.isRecursive = 1;
  116911. pTab->nTabRef++;
  116912. pSel->selFlags |= SF_Recursive;
  116913. }
  116914. }
  116915. }
  116916. /* Only one recursive reference is permitted. */
  116917. if( pTab->nTabRef>2 ){
  116918. sqlite3ErrorMsg(
  116919. pParse, "multiple references to recursive table: %s", pCte->zName
  116920. );
  116921. return SQLITE_ERROR;
  116922. }
  116923. assert( pTab->nTabRef==1 ||
  116924. ((pSel->selFlags&SF_Recursive) && pTab->nTabRef==2 ));
  116925. pCte->zCteErr = "circular reference: %s";
  116926. pSavedWith = pParse->pWith;
  116927. pParse->pWith = pWith;
  116928. if( bMayRecursive ){
  116929. Select *pPrior = pSel->pPrior;
  116930. assert( pPrior->pWith==0 );
  116931. pPrior->pWith = pSel->pWith;
  116932. sqlite3WalkSelect(pWalker, pPrior);
  116933. pPrior->pWith = 0;
  116934. }else{
  116935. sqlite3WalkSelect(pWalker, pSel);
  116936. }
  116937. pParse->pWith = pWith;
  116938. for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
  116939. pEList = pLeft->pEList;
  116940. if( pCte->pCols ){
  116941. if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
  116942. sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
  116943. pCte->zName, pEList->nExpr, pCte->pCols->nExpr
  116944. );
  116945. pParse->pWith = pSavedWith;
  116946. return SQLITE_ERROR;
  116947. }
  116948. pEList = pCte->pCols;
  116949. }
  116950. sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
  116951. if( bMayRecursive ){
  116952. if( pSel->selFlags & SF_Recursive ){
  116953. pCte->zCteErr = "multiple recursive references: %s";
  116954. }else{
  116955. pCte->zCteErr = "recursive reference in a subquery: %s";
  116956. }
  116957. sqlite3WalkSelect(pWalker, pSel);
  116958. }
  116959. pCte->zCteErr = 0;
  116960. pParse->pWith = pSavedWith;
  116961. }
  116962. return SQLITE_OK;
  116963. }
  116964. #endif
  116965. #ifndef SQLITE_OMIT_CTE
  116966. /*
  116967. ** If the SELECT passed as the second argument has an associated WITH
  116968. ** clause, pop it from the stack stored as part of the Parse object.
  116969. **
  116970. ** This function is used as the xSelectCallback2() callback by
  116971. ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
  116972. ** names and other FROM clause elements.
  116973. */
  116974. static void selectPopWith(Walker *pWalker, Select *p){
  116975. Parse *pParse = pWalker->pParse;
  116976. if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
  116977. With *pWith = findRightmost(p)->pWith;
  116978. if( pWith!=0 ){
  116979. assert( pParse->pWith==pWith );
  116980. pParse->pWith = pWith->pOuter;
  116981. }
  116982. }
  116983. }
  116984. #else
  116985. #define selectPopWith 0
  116986. #endif
  116987. /*
  116988. ** This routine is a Walker callback for "expanding" a SELECT statement.
  116989. ** "Expanding" means to do the following:
  116990. **
  116991. ** (1) Make sure VDBE cursor numbers have been assigned to every
  116992. ** element of the FROM clause.
  116993. **
  116994. ** (2) Fill in the pTabList->a[].pTab fields in the SrcList that
  116995. ** defines FROM clause. When views appear in the FROM clause,
  116996. ** fill pTabList->a[].pSelect with a copy of the SELECT statement
  116997. ** that implements the view. A copy is made of the view's SELECT
  116998. ** statement so that we can freely modify or delete that statement
  116999. ** without worrying about messing up the persistent representation
  117000. ** of the view.
  117001. **
  117002. ** (3) Add terms to the WHERE clause to accommodate the NATURAL keyword
  117003. ** on joins and the ON and USING clause of joins.
  117004. **
  117005. ** (4) Scan the list of columns in the result set (pEList) looking
  117006. ** for instances of the "*" operator or the TABLE.* operator.
  117007. ** If found, expand each "*" to be every column in every table
  117008. ** and TABLE.* to be every column in TABLE.
  117009. **
  117010. */
  117011. static int selectExpander(Walker *pWalker, Select *p){
  117012. Parse *pParse = pWalker->pParse;
  117013. int i, j, k;
  117014. SrcList *pTabList;
  117015. ExprList *pEList;
  117016. struct SrcList_item *pFrom;
  117017. sqlite3 *db = pParse->db;
  117018. Expr *pE, *pRight, *pExpr;
  117019. u16 selFlags = p->selFlags;
  117020. u32 elistFlags = 0;
  117021. p->selFlags |= SF_Expanded;
  117022. if( db->mallocFailed ){
  117023. return WRC_Abort;
  117024. }
  117025. assert( p->pSrc!=0 );
  117026. if( (selFlags & SF_Expanded)!=0 ){
  117027. return WRC_Prune;
  117028. }
  117029. pTabList = p->pSrc;
  117030. pEList = p->pEList;
  117031. sqlite3WithPush(pParse, p->pWith, 0);
  117032. /* Make sure cursor numbers have been assigned to all entries in
  117033. ** the FROM clause of the SELECT statement.
  117034. */
  117035. sqlite3SrcListAssignCursors(pParse, pTabList);
  117036. /* Look up every table named in the FROM clause of the select. If
  117037. ** an entry of the FROM clause is a subquery instead of a table or view,
  117038. ** then create a transient table structure to describe the subquery.
  117039. */
  117040. for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
  117041. Table *pTab;
  117042. assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
  117043. if( pFrom->fg.isRecursive ) continue;
  117044. assert( pFrom->pTab==0 );
  117045. #ifndef SQLITE_OMIT_CTE
  117046. if( withExpand(pWalker, pFrom) ) return WRC_Abort;
  117047. if( pFrom->pTab ) {} else
  117048. #endif
  117049. if( pFrom->zName==0 ){
  117050. #ifndef SQLITE_OMIT_SUBQUERY
  117051. Select *pSel = pFrom->pSelect;
  117052. /* A sub-query in the FROM clause of a SELECT */
  117053. assert( pSel!=0 );
  117054. assert( pFrom->pTab==0 );
  117055. if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
  117056. pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
  117057. if( pTab==0 ) return WRC_Abort;
  117058. pTab->nTabRef = 1;
  117059. if( pFrom->zAlias ){
  117060. pTab->zName = sqlite3DbStrDup(db, pFrom->zAlias);
  117061. }else{
  117062. pTab->zName = sqlite3MPrintf(db, "subquery_%p", (void*)pTab);
  117063. }
  117064. while( pSel->pPrior ){ pSel = pSel->pPrior; }
  117065. sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
  117066. pTab->iPKey = -1;
  117067. pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
  117068. pTab->tabFlags |= TF_Ephemeral;
  117069. #endif
  117070. }else{
  117071. /* An ordinary table or view name in the FROM clause */
  117072. assert( pFrom->pTab==0 );
  117073. pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
  117074. if( pTab==0 ) return WRC_Abort;
  117075. if( pTab->nTabRef>=0xffff ){
  117076. sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
  117077. pTab->zName);
  117078. pFrom->pTab = 0;
  117079. return WRC_Abort;
  117080. }
  117081. pTab->nTabRef++;
  117082. if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
  117083. return WRC_Abort;
  117084. }
  117085. #if !defined(SQLITE_OMIT_VIEW) || !defined (SQLITE_OMIT_VIRTUALTABLE)
  117086. if( IsVirtual(pTab) || pTab->pSelect ){
  117087. i16 nCol;
  117088. if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
  117089. assert( pFrom->pSelect==0 );
  117090. pFrom->pSelect = sqlite3SelectDup(db, pTab->pSelect, 0);
  117091. sqlite3SelectSetName(pFrom->pSelect, pTab->zName);
  117092. nCol = pTab->nCol;
  117093. pTab->nCol = -1;
  117094. sqlite3WalkSelect(pWalker, pFrom->pSelect);
  117095. pTab->nCol = nCol;
  117096. }
  117097. #endif
  117098. }
  117099. /* Locate the index named by the INDEXED BY clause, if any. */
  117100. if( sqlite3IndexedByLookup(pParse, pFrom) ){
  117101. return WRC_Abort;
  117102. }
  117103. }
  117104. /* Process NATURAL keywords, and ON and USING clauses of joins.
  117105. */
  117106. if( db->mallocFailed || sqliteProcessJoin(pParse, p) ){
  117107. return WRC_Abort;
  117108. }
  117109. /* For every "*" that occurs in the column list, insert the names of
  117110. ** all columns in all tables. And for every TABLE.* insert the names
  117111. ** of all columns in TABLE. The parser inserted a special expression
  117112. ** with the TK_ASTERISK operator for each "*" that it found in the column
  117113. ** list. The following code just has to locate the TK_ASTERISK
  117114. ** expressions and expand each one to the list of all columns in
  117115. ** all tables.
  117116. **
  117117. ** The first loop just checks to see if there are any "*" operators
  117118. ** that need expanding.
  117119. */
  117120. for(k=0; k<pEList->nExpr; k++){
  117121. pE = pEList->a[k].pExpr;
  117122. if( pE->op==TK_ASTERISK ) break;
  117123. assert( pE->op!=TK_DOT || pE->pRight!=0 );
  117124. assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
  117125. if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
  117126. elistFlags |= pE->flags;
  117127. }
  117128. if( k<pEList->nExpr ){
  117129. /*
  117130. ** If we get here it means the result set contains one or more "*"
  117131. ** operators that need to be expanded. Loop through each expression
  117132. ** in the result set and expand them one by one.
  117133. */
  117134. struct ExprList_item *a = pEList->a;
  117135. ExprList *pNew = 0;
  117136. int flags = pParse->db->flags;
  117137. int longNames = (flags & SQLITE_FullColNames)!=0
  117138. && (flags & SQLITE_ShortColNames)==0;
  117139. for(k=0; k<pEList->nExpr; k++){
  117140. pE = a[k].pExpr;
  117141. elistFlags |= pE->flags;
  117142. pRight = pE->pRight;
  117143. assert( pE->op!=TK_DOT || pRight!=0 );
  117144. if( pE->op!=TK_ASTERISK
  117145. && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
  117146. ){
  117147. /* This particular expression does not need to be expanded.
  117148. */
  117149. pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
  117150. if( pNew ){
  117151. pNew->a[pNew->nExpr-1].zName = a[k].zName;
  117152. pNew->a[pNew->nExpr-1].zSpan = a[k].zSpan;
  117153. a[k].zName = 0;
  117154. a[k].zSpan = 0;
  117155. }
  117156. a[k].pExpr = 0;
  117157. }else{
  117158. /* This expression is a "*" or a "TABLE.*" and needs to be
  117159. ** expanded. */
  117160. int tableSeen = 0; /* Set to 1 when TABLE matches */
  117161. char *zTName = 0; /* text of name of TABLE */
  117162. if( pE->op==TK_DOT ){
  117163. assert( pE->pLeft!=0 );
  117164. assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
  117165. zTName = pE->pLeft->u.zToken;
  117166. }
  117167. for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
  117168. Table *pTab = pFrom->pTab;
  117169. Select *pSub = pFrom->pSelect;
  117170. char *zTabName = pFrom->zAlias;
  117171. const char *zSchemaName = 0;
  117172. int iDb;
  117173. if( zTabName==0 ){
  117174. zTabName = pTab->zName;
  117175. }
  117176. if( db->mallocFailed ) break;
  117177. if( pSub==0 || (pSub->selFlags & SF_NestedFrom)==0 ){
  117178. pSub = 0;
  117179. if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
  117180. continue;
  117181. }
  117182. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  117183. zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
  117184. }
  117185. for(j=0; j<pTab->nCol; j++){
  117186. char *zName = pTab->aCol[j].zName;
  117187. char *zColname; /* The computed column name */
  117188. char *zToFree; /* Malloced string that needs to be freed */
  117189. Token sColname; /* Computed column name as a token */
  117190. assert( zName );
  117191. if( zTName && pSub
  117192. && sqlite3MatchSpanName(pSub->pEList->a[j].zSpan, 0, zTName, 0)==0
  117193. ){
  117194. continue;
  117195. }
  117196. /* If a column is marked as 'hidden', omit it from the expanded
  117197. ** result-set list unless the SELECT has the SF_IncludeHidden
  117198. ** bit set.
  117199. */
  117200. if( (p->selFlags & SF_IncludeHidden)==0
  117201. && IsHiddenColumn(&pTab->aCol[j])
  117202. ){
  117203. continue;
  117204. }
  117205. tableSeen = 1;
  117206. if( i>0 && zTName==0 ){
  117207. if( (pFrom->fg.jointype & JT_NATURAL)!=0
  117208. && tableAndColumnIndex(pTabList, i, zName, 0, 0)
  117209. ){
  117210. /* In a NATURAL join, omit the join columns from the
  117211. ** table to the right of the join */
  117212. continue;
  117213. }
  117214. if( sqlite3IdListIndex(pFrom->pUsing, zName)>=0 ){
  117215. /* In a join with a USING clause, omit columns in the
  117216. ** using clause from the table on the right. */
  117217. continue;
  117218. }
  117219. }
  117220. pRight = sqlite3Expr(db, TK_ID, zName);
  117221. zColname = zName;
  117222. zToFree = 0;
  117223. if( longNames || pTabList->nSrc>1 ){
  117224. Expr *pLeft;
  117225. pLeft = sqlite3Expr(db, TK_ID, zTabName);
  117226. pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
  117227. if( zSchemaName ){
  117228. pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
  117229. pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
  117230. }
  117231. if( longNames ){
  117232. zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
  117233. zToFree = zColname;
  117234. }
  117235. }else{
  117236. pExpr = pRight;
  117237. }
  117238. pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
  117239. sqlite3TokenInit(&sColname, zColname);
  117240. sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
  117241. if( pNew && (p->selFlags & SF_NestedFrom)!=0 ){
  117242. struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
  117243. if( pSub ){
  117244. pX->zSpan = sqlite3DbStrDup(db, pSub->pEList->a[j].zSpan);
  117245. testcase( pX->zSpan==0 );
  117246. }else{
  117247. pX->zSpan = sqlite3MPrintf(db, "%s.%s.%s",
  117248. zSchemaName, zTabName, zColname);
  117249. testcase( pX->zSpan==0 );
  117250. }
  117251. pX->bSpanIsTab = 1;
  117252. }
  117253. sqlite3DbFree(db, zToFree);
  117254. }
  117255. }
  117256. if( !tableSeen ){
  117257. if( zTName ){
  117258. sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
  117259. }else{
  117260. sqlite3ErrorMsg(pParse, "no tables specified");
  117261. }
  117262. }
  117263. }
  117264. }
  117265. sqlite3ExprListDelete(db, pEList);
  117266. p->pEList = pNew;
  117267. }
  117268. if( p->pEList ){
  117269. if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
  117270. sqlite3ErrorMsg(pParse, "too many columns in result set");
  117271. return WRC_Abort;
  117272. }
  117273. if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
  117274. p->selFlags |= SF_ComplexResult;
  117275. }
  117276. }
  117277. return WRC_Continue;
  117278. }
  117279. /*
  117280. ** No-op routine for the parse-tree walker.
  117281. **
  117282. ** When this routine is the Walker.xExprCallback then expression trees
  117283. ** are walked without any actions being taken at each node. Presumably,
  117284. ** when this routine is used for Walker.xExprCallback then
  117285. ** Walker.xSelectCallback is set to do something useful for every
  117286. ** subquery in the parser tree.
  117287. */
  117288. SQLITE_PRIVATE int sqlite3ExprWalkNoop(Walker *NotUsed, Expr *NotUsed2){
  117289. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  117290. return WRC_Continue;
  117291. }
  117292. /*
  117293. ** No-op routine for the parse-tree walker for SELECT statements.
  117294. ** subquery in the parser tree.
  117295. */
  117296. SQLITE_PRIVATE int sqlite3SelectWalkNoop(Walker *NotUsed, Select *NotUsed2){
  117297. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  117298. return WRC_Continue;
  117299. }
  117300. #if SQLITE_DEBUG
  117301. /*
  117302. ** Always assert. This xSelectCallback2 implementation proves that the
  117303. ** xSelectCallback2 is never invoked.
  117304. */
  117305. SQLITE_PRIVATE void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
  117306. UNUSED_PARAMETER2(NotUsed, NotUsed2);
  117307. assert( 0 );
  117308. }
  117309. #endif
  117310. /*
  117311. ** This routine "expands" a SELECT statement and all of its subqueries.
  117312. ** For additional information on what it means to "expand" a SELECT
  117313. ** statement, see the comment on the selectExpand worker callback above.
  117314. **
  117315. ** Expanding a SELECT statement is the first step in processing a
  117316. ** SELECT statement. The SELECT statement must be expanded before
  117317. ** name resolution is performed.
  117318. **
  117319. ** If anything goes wrong, an error message is written into pParse.
  117320. ** The calling function can detect the problem by looking at pParse->nErr
  117321. ** and/or pParse->db->mallocFailed.
  117322. */
  117323. static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
  117324. Walker w;
  117325. w.xExprCallback = sqlite3ExprWalkNoop;
  117326. w.pParse = pParse;
  117327. if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
  117328. w.xSelectCallback = convertCompoundSelectToSubquery;
  117329. w.xSelectCallback2 = 0;
  117330. sqlite3WalkSelect(&w, pSelect);
  117331. }
  117332. w.xSelectCallback = selectExpander;
  117333. w.xSelectCallback2 = selectPopWith;
  117334. sqlite3WalkSelect(&w, pSelect);
  117335. }
  117336. #ifndef SQLITE_OMIT_SUBQUERY
  117337. /*
  117338. ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
  117339. ** interface.
  117340. **
  117341. ** For each FROM-clause subquery, add Column.zType and Column.zColl
  117342. ** information to the Table structure that represents the result set
  117343. ** of that subquery.
  117344. **
  117345. ** The Table structure that represents the result set was constructed
  117346. ** by selectExpander() but the type and collation information was omitted
  117347. ** at that point because identifiers had not yet been resolved. This
  117348. ** routine is called after identifier resolution.
  117349. */
  117350. static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
  117351. Parse *pParse;
  117352. int i;
  117353. SrcList *pTabList;
  117354. struct SrcList_item *pFrom;
  117355. assert( p->selFlags & SF_Resolved );
  117356. assert( (p->selFlags & SF_HasTypeInfo)==0 );
  117357. p->selFlags |= SF_HasTypeInfo;
  117358. pParse = pWalker->pParse;
  117359. pTabList = p->pSrc;
  117360. for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
  117361. Table *pTab = pFrom->pTab;
  117362. assert( pTab!=0 );
  117363. if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
  117364. /* A sub-query in the FROM clause of a SELECT */
  117365. Select *pSel = pFrom->pSelect;
  117366. if( pSel ){
  117367. while( pSel->pPrior ) pSel = pSel->pPrior;
  117368. sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel);
  117369. }
  117370. }
  117371. }
  117372. }
  117373. #endif
  117374. /*
  117375. ** This routine adds datatype and collating sequence information to
  117376. ** the Table structures of all FROM-clause subqueries in a
  117377. ** SELECT statement.
  117378. **
  117379. ** Use this routine after name resolution.
  117380. */
  117381. static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
  117382. #ifndef SQLITE_OMIT_SUBQUERY
  117383. Walker w;
  117384. w.xSelectCallback = sqlite3SelectWalkNoop;
  117385. w.xSelectCallback2 = selectAddSubqueryTypeInfo;
  117386. w.xExprCallback = sqlite3ExprWalkNoop;
  117387. w.pParse = pParse;
  117388. sqlite3WalkSelect(&w, pSelect);
  117389. #endif
  117390. }
  117391. /*
  117392. ** This routine sets up a SELECT statement for processing. The
  117393. ** following is accomplished:
  117394. **
  117395. ** * VDBE Cursor numbers are assigned to all FROM-clause terms.
  117396. ** * Ephemeral Table objects are created for all FROM-clause subqueries.
  117397. ** * ON and USING clauses are shifted into WHERE statements
  117398. ** * Wildcards "*" and "TABLE.*" in result sets are expanded.
  117399. ** * Identifiers in expression are matched to tables.
  117400. **
  117401. ** This routine acts recursively on all subqueries within the SELECT.
  117402. */
  117403. SQLITE_PRIVATE void sqlite3SelectPrep(
  117404. Parse *pParse, /* The parser context */
  117405. Select *p, /* The SELECT statement being coded. */
  117406. NameContext *pOuterNC /* Name context for container */
  117407. ){
  117408. assert( p!=0 || pParse->db->mallocFailed );
  117409. if( pParse->db->mallocFailed ) return;
  117410. if( p->selFlags & SF_HasTypeInfo ) return;
  117411. sqlite3SelectExpand(pParse, p);
  117412. if( pParse->nErr || pParse->db->mallocFailed ) return;
  117413. sqlite3ResolveSelectNames(pParse, p, pOuterNC);
  117414. if( pParse->nErr || pParse->db->mallocFailed ) return;
  117415. sqlite3SelectAddTypeInfo(pParse, p);
  117416. }
  117417. /*
  117418. ** Reset the aggregate accumulator.
  117419. **
  117420. ** The aggregate accumulator is a set of memory cells that hold
  117421. ** intermediate results while calculating an aggregate. This
  117422. ** routine generates code that stores NULLs in all of those memory
  117423. ** cells.
  117424. */
  117425. static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
  117426. Vdbe *v = pParse->pVdbe;
  117427. int i;
  117428. struct AggInfo_func *pFunc;
  117429. int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
  117430. if( nReg==0 ) return;
  117431. #ifdef SQLITE_DEBUG
  117432. /* Verify that all AggInfo registers are within the range specified by
  117433. ** AggInfo.mnReg..AggInfo.mxReg */
  117434. assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
  117435. for(i=0; i<pAggInfo->nColumn; i++){
  117436. assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
  117437. && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
  117438. }
  117439. for(i=0; i<pAggInfo->nFunc; i++){
  117440. assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
  117441. && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
  117442. }
  117443. #endif
  117444. sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
  117445. for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
  117446. if( pFunc->iDistinct>=0 ){
  117447. Expr *pE = pFunc->pExpr;
  117448. assert( !ExprHasProperty(pE, EP_xIsSelect) );
  117449. if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
  117450. sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
  117451. "argument");
  117452. pFunc->iDistinct = -1;
  117453. }else{
  117454. KeyInfo *pKeyInfo = keyInfoFromExprList(pParse, pE->x.pList, 0, 0);
  117455. sqlite3VdbeAddOp4(v, OP_OpenEphemeral, pFunc->iDistinct, 0, 0,
  117456. (char*)pKeyInfo, P4_KEYINFO);
  117457. }
  117458. }
  117459. }
  117460. }
  117461. /*
  117462. ** Invoke the OP_AggFinalize opcode for every aggregate function
  117463. ** in the AggInfo structure.
  117464. */
  117465. static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
  117466. Vdbe *v = pParse->pVdbe;
  117467. int i;
  117468. struct AggInfo_func *pF;
  117469. for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
  117470. ExprList *pList = pF->pExpr->x.pList;
  117471. assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
  117472. sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
  117473. sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
  117474. }
  117475. }
  117476. /*
  117477. ** Update the accumulator memory cells for an aggregate based on
  117478. ** the current cursor position.
  117479. */
  117480. static void updateAccumulator(Parse *pParse, AggInfo *pAggInfo){
  117481. Vdbe *v = pParse->pVdbe;
  117482. int i;
  117483. int regHit = 0;
  117484. int addrHitTest = 0;
  117485. struct AggInfo_func *pF;
  117486. struct AggInfo_col *pC;
  117487. pAggInfo->directMode = 1;
  117488. for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
  117489. int nArg;
  117490. int addrNext = 0;
  117491. int regAgg;
  117492. ExprList *pList = pF->pExpr->x.pList;
  117493. assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
  117494. if( pList ){
  117495. nArg = pList->nExpr;
  117496. regAgg = sqlite3GetTempRange(pParse, nArg);
  117497. sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
  117498. }else{
  117499. nArg = 0;
  117500. regAgg = 0;
  117501. }
  117502. if( pF->iDistinct>=0 ){
  117503. addrNext = sqlite3VdbeMakeLabel(v);
  117504. testcase( nArg==0 ); /* Error condition */
  117505. testcase( nArg>1 ); /* Also an error */
  117506. codeDistinct(pParse, pF->iDistinct, addrNext, 1, regAgg);
  117507. }
  117508. if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
  117509. CollSeq *pColl = 0;
  117510. struct ExprList_item *pItem;
  117511. int j;
  117512. assert( pList!=0 ); /* pList!=0 if pF->pFunc has NEEDCOLL */
  117513. for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
  117514. pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
  117515. }
  117516. if( !pColl ){
  117517. pColl = pParse->db->pDfltColl;
  117518. }
  117519. if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
  117520. sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
  117521. }
  117522. sqlite3VdbeAddOp3(v, OP_AggStep0, 0, regAgg, pF->iMem);
  117523. sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
  117524. sqlite3VdbeChangeP5(v, (u8)nArg);
  117525. sqlite3ExprCacheAffinityChange(pParse, regAgg, nArg);
  117526. sqlite3ReleaseTempRange(pParse, regAgg, nArg);
  117527. if( addrNext ){
  117528. sqlite3VdbeResolveLabel(v, addrNext);
  117529. sqlite3ExprCacheClear(pParse);
  117530. }
  117531. }
  117532. /* Before populating the accumulator registers, clear the column cache.
  117533. ** Otherwise, if any of the required column values are already present
  117534. ** in registers, sqlite3ExprCode() may use OP_SCopy to copy the value
  117535. ** to pC->iMem. But by the time the value is used, the original register
  117536. ** may have been used, invalidating the underlying buffer holding the
  117537. ** text or blob value. See ticket [883034dcb5].
  117538. **
  117539. ** Another solution would be to change the OP_SCopy used to copy cached
  117540. ** values to an OP_Copy.
  117541. */
  117542. if( regHit ){
  117543. addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
  117544. }
  117545. sqlite3ExprCacheClear(pParse);
  117546. for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
  117547. sqlite3ExprCode(pParse, pC->pExpr, pC->iMem);
  117548. }
  117549. pAggInfo->directMode = 0;
  117550. sqlite3ExprCacheClear(pParse);
  117551. if( addrHitTest ){
  117552. sqlite3VdbeJumpHere(v, addrHitTest);
  117553. }
  117554. }
  117555. /*
  117556. ** Add a single OP_Explain instruction to the VDBE to explain a simple
  117557. ** count(*) query ("SELECT count(*) FROM pTab").
  117558. */
  117559. #ifndef SQLITE_OMIT_EXPLAIN
  117560. static void explainSimpleCount(
  117561. Parse *pParse, /* Parse context */
  117562. Table *pTab, /* Table being queried */
  117563. Index *pIdx /* Index used to optimize scan, or NULL */
  117564. ){
  117565. if( pParse->explain==2 ){
  117566. int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
  117567. char *zEqp = sqlite3MPrintf(pParse->db, "SCAN TABLE %s%s%s",
  117568. pTab->zName,
  117569. bCover ? " USING COVERING INDEX " : "",
  117570. bCover ? pIdx->zName : ""
  117571. );
  117572. sqlite3VdbeAddOp4(
  117573. pParse->pVdbe, OP_Explain, pParse->iSelectId, 0, 0, zEqp, P4_DYNAMIC
  117574. );
  117575. }
  117576. }
  117577. #else
  117578. # define explainSimpleCount(a,b,c)
  117579. #endif
  117580. /*
  117581. ** sqlite3WalkExpr() callback used by havingToWhere().
  117582. **
  117583. ** If the node passed to the callback is a TK_AND node, return
  117584. ** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
  117585. **
  117586. ** Otherwise, return WRC_Prune. In this case, also check if the
  117587. ** sub-expression matches the criteria for being moved to the WHERE
  117588. ** clause. If so, add it to the WHERE clause and replace the sub-expression
  117589. ** within the HAVING expression with a constant "1".
  117590. */
  117591. static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
  117592. if( pExpr->op!=TK_AND ){
  117593. Select *pS = pWalker->u.pSelect;
  117594. if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy) ){
  117595. sqlite3 *db = pWalker->pParse->db;
  117596. Expr *pNew = sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[1], 0);
  117597. if( pNew ){
  117598. Expr *pWhere = pS->pWhere;
  117599. SWAP(Expr, *pNew, *pExpr);
  117600. pNew = sqlite3ExprAnd(db, pWhere, pNew);
  117601. pS->pWhere = pNew;
  117602. pWalker->eCode = 1;
  117603. }
  117604. }
  117605. return WRC_Prune;
  117606. }
  117607. return WRC_Continue;
  117608. }
  117609. /*
  117610. ** Transfer eligible terms from the HAVING clause of a query, which is
  117611. ** processed after grouping, to the WHERE clause, which is processed before
  117612. ** grouping. For example, the query:
  117613. **
  117614. ** SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
  117615. **
  117616. ** can be rewritten as:
  117617. **
  117618. ** SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
  117619. **
  117620. ** A term of the HAVING expression is eligible for transfer if it consists
  117621. ** entirely of constants and expressions that are also GROUP BY terms that
  117622. ** use the "BINARY" collation sequence.
  117623. */
  117624. static void havingToWhere(Parse *pParse, Select *p){
  117625. Walker sWalker;
  117626. memset(&sWalker, 0, sizeof(sWalker));
  117627. sWalker.pParse = pParse;
  117628. sWalker.xExprCallback = havingToWhereExprCb;
  117629. sWalker.u.pSelect = p;
  117630. sqlite3WalkExpr(&sWalker, p->pHaving);
  117631. #if SELECTTRACE_ENABLED
  117632. if( sWalker.eCode && (sqlite3SelectTrace & 0x100)!=0 ){
  117633. SELECTTRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
  117634. sqlite3TreeViewSelect(0, p, 0);
  117635. }
  117636. #endif
  117637. }
  117638. /*
  117639. ** Check to see if the pThis entry of pTabList is a self-join of a prior view.
  117640. ** If it is, then return the SrcList_item for the prior view. If it is not,
  117641. ** then return 0.
  117642. */
  117643. static struct SrcList_item *isSelfJoinView(
  117644. SrcList *pTabList, /* Search for self-joins in this FROM clause */
  117645. struct SrcList_item *pThis /* Search for prior reference to this subquery */
  117646. ){
  117647. struct SrcList_item *pItem;
  117648. for(pItem = pTabList->a; pItem<pThis; pItem++){
  117649. if( pItem->pSelect==0 ) continue;
  117650. if( pItem->fg.viaCoroutine ) continue;
  117651. if( pItem->zName==0 ) continue;
  117652. if( sqlite3_stricmp(pItem->zDatabase, pThis->zDatabase)!=0 ) continue;
  117653. if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
  117654. if( sqlite3ExprCompare(0,
  117655. pThis->pSelect->pWhere, pItem->pSelect->pWhere, -1)
  117656. ){
  117657. /* The view was modified by some other optimization such as
  117658. ** pushDownWhereTerms() */
  117659. continue;
  117660. }
  117661. return pItem;
  117662. }
  117663. return 0;
  117664. }
  117665. #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
  117666. /*
  117667. ** Attempt to transform a query of the form
  117668. **
  117669. ** SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
  117670. **
  117671. ** Into this:
  117672. **
  117673. ** SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
  117674. **
  117675. ** The transformation only works if all of the following are true:
  117676. **
  117677. ** * The subquery is a UNION ALL of two or more terms
  117678. ** * There is no WHERE or GROUP BY or HAVING clauses on the subqueries
  117679. ** * The outer query is a simple count(*)
  117680. **
  117681. ** Return TRUE if the optimization is undertaken.
  117682. */
  117683. static int countOfViewOptimization(Parse *pParse, Select *p){
  117684. Select *pSub, *pPrior;
  117685. Expr *pExpr;
  117686. Expr *pCount;
  117687. sqlite3 *db;
  117688. if( (p->selFlags & SF_Aggregate)==0 ) return 0; /* This is an aggregate */
  117689. if( p->pEList->nExpr!=1 ) return 0; /* Single result column */
  117690. pExpr = p->pEList->a[0].pExpr;
  117691. if( pExpr->op!=TK_AGG_FUNCTION ) return 0; /* Result is an aggregate */
  117692. if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0; /* Is count() */
  117693. if( pExpr->x.pList!=0 ) return 0; /* Must be count(*) */
  117694. if( p->pSrc->nSrc!=1 ) return 0; /* One table in FROM */
  117695. pSub = p->pSrc->a[0].pSelect;
  117696. if( pSub==0 ) return 0; /* The FROM is a subquery */
  117697. if( pSub->pPrior==0 ) return 0; /* Must be a compound ry */
  117698. do{
  117699. if( pSub->op!=TK_ALL && pSub->pPrior ) return 0; /* Must be UNION ALL */
  117700. if( pSub->pWhere ) return 0; /* No WHERE clause */
  117701. if( pSub->selFlags & SF_Aggregate ) return 0; /* Not an aggregate */
  117702. pSub = pSub->pPrior; /* Repeat over compound */
  117703. }while( pSub );
  117704. /* If we reach this point then it is OK to perform the transformation */
  117705. db = pParse->db;
  117706. pCount = pExpr;
  117707. pExpr = 0;
  117708. pSub = p->pSrc->a[0].pSelect;
  117709. p->pSrc->a[0].pSelect = 0;
  117710. sqlite3SrcListDelete(db, p->pSrc);
  117711. p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
  117712. while( pSub ){
  117713. Expr *pTerm;
  117714. pPrior = pSub->pPrior;
  117715. pSub->pPrior = 0;
  117716. pSub->pNext = 0;
  117717. pSub->selFlags |= SF_Aggregate;
  117718. pSub->selFlags &= ~SF_Compound;
  117719. pSub->nSelectRow = 0;
  117720. sqlite3ExprListDelete(db, pSub->pEList);
  117721. pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
  117722. pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
  117723. pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
  117724. sqlite3PExprAddSelect(pParse, pTerm, pSub);
  117725. if( pExpr==0 ){
  117726. pExpr = pTerm;
  117727. }else{
  117728. pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
  117729. }
  117730. pSub = pPrior;
  117731. }
  117732. p->pEList->a[0].pExpr = pExpr;
  117733. p->selFlags &= ~SF_Aggregate;
  117734. #if SELECTTRACE_ENABLED
  117735. if( sqlite3SelectTrace & 0x400 ){
  117736. SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
  117737. sqlite3TreeViewSelect(0, p, 0);
  117738. }
  117739. #endif
  117740. return 1;
  117741. }
  117742. #endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
  117743. /*
  117744. ** Generate code for the SELECT statement given in the p argument.
  117745. **
  117746. ** The results are returned according to the SelectDest structure.
  117747. ** See comments in sqliteInt.h for further information.
  117748. **
  117749. ** This routine returns the number of errors. If any errors are
  117750. ** encountered, then an appropriate error message is left in
  117751. ** pParse->zErrMsg.
  117752. **
  117753. ** This routine does NOT free the Select structure passed in. The
  117754. ** calling function needs to do that.
  117755. */
  117756. SQLITE_PRIVATE int sqlite3Select(
  117757. Parse *pParse, /* The parser context */
  117758. Select *p, /* The SELECT statement being coded. */
  117759. SelectDest *pDest /* What to do with the query results */
  117760. ){
  117761. int i, j; /* Loop counters */
  117762. WhereInfo *pWInfo; /* Return from sqlite3WhereBegin() */
  117763. Vdbe *v; /* The virtual machine under construction */
  117764. int isAgg; /* True for select lists like "count(*)" */
  117765. ExprList *pEList = 0; /* List of columns to extract. */
  117766. SrcList *pTabList; /* List of tables to select from */
  117767. Expr *pWhere; /* The WHERE clause. May be NULL */
  117768. ExprList *pGroupBy; /* The GROUP BY clause. May be NULL */
  117769. Expr *pHaving; /* The HAVING clause. May be NULL */
  117770. int rc = 1; /* Value to return from this function */
  117771. DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
  117772. SortCtx sSort; /* Info on how to code the ORDER BY clause */
  117773. AggInfo sAggInfo; /* Information used by aggregate queries */
  117774. int iEnd; /* Address of the end of the query */
  117775. sqlite3 *db; /* The database connection */
  117776. ExprList *pMinMaxOrderBy = 0; /* Added ORDER BY for min/max queries */
  117777. u8 minMaxFlag; /* Flag for min/max queries */
  117778. #ifndef SQLITE_OMIT_EXPLAIN
  117779. int iRestoreSelectId = pParse->iSelectId;
  117780. pParse->iSelectId = pParse->iNextSelectId++;
  117781. #endif
  117782. db = pParse->db;
  117783. if( p==0 || db->mallocFailed || pParse->nErr ){
  117784. return 1;
  117785. }
  117786. if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
  117787. memset(&sAggInfo, 0, sizeof(sAggInfo));
  117788. #if SELECTTRACE_ENABLED
  117789. SELECTTRACE(1,pParse,p, ("begin processing:\n"));
  117790. if( sqlite3SelectTrace & 0x100 ){
  117791. sqlite3TreeViewSelect(0, p, 0);
  117792. }
  117793. #endif
  117794. assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
  117795. assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
  117796. assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
  117797. assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
  117798. if( IgnorableOrderby(pDest) ){
  117799. assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
  117800. pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
  117801. pDest->eDest==SRT_Queue || pDest->eDest==SRT_DistFifo ||
  117802. pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_Fifo);
  117803. /* If ORDER BY makes no difference in the output then neither does
  117804. ** DISTINCT so it can be removed too. */
  117805. sqlite3ExprListDelete(db, p->pOrderBy);
  117806. p->pOrderBy = 0;
  117807. p->selFlags &= ~SF_Distinct;
  117808. }
  117809. sqlite3SelectPrep(pParse, p, 0);
  117810. memset(&sSort, 0, sizeof(sSort));
  117811. sSort.pOrderBy = p->pOrderBy;
  117812. pTabList = p->pSrc;
  117813. if( pParse->nErr || db->mallocFailed ){
  117814. goto select_end;
  117815. }
  117816. assert( p->pEList!=0 );
  117817. isAgg = (p->selFlags & SF_Aggregate)!=0;
  117818. #if SELECTTRACE_ENABLED
  117819. if( sqlite3SelectTrace & 0x100 ){
  117820. SELECTTRACE(0x100,pParse,p, ("after name resolution:\n"));
  117821. sqlite3TreeViewSelect(0, p, 0);
  117822. }
  117823. #endif
  117824. /* Get a pointer the VDBE under construction, allocating a new VDBE if one
  117825. ** does not already exist */
  117826. v = sqlite3GetVdbe(pParse);
  117827. if( v==0 ) goto select_end;
  117828. if( pDest->eDest==SRT_Output ){
  117829. generateColumnNames(pParse, p);
  117830. }
  117831. /* Try to various optimizations (flattening subqueries, and strength
  117832. ** reduction of join operators) in the FROM clause up into the main query
  117833. */
  117834. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  117835. for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
  117836. struct SrcList_item *pItem = &pTabList->a[i];
  117837. Select *pSub = pItem->pSelect;
  117838. Table *pTab = pItem->pTab;
  117839. /* Convert LEFT JOIN into JOIN if there are terms of the right table
  117840. ** of the LEFT JOIN used in the WHERE clause.
  117841. */
  117842. if( (pItem->fg.jointype & JT_LEFT)!=0
  117843. && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
  117844. && OptimizationEnabled(db, SQLITE_SimplifyJoin)
  117845. ){
  117846. SELECTTRACE(0x100,pParse,p,
  117847. ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
  117848. pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
  117849. unsetJoinExpr(p->pWhere, pItem->iCursor);
  117850. }
  117851. /* No futher action if this term of the FROM clause is no a subquery */
  117852. if( pSub==0 ) continue;
  117853. /* Catch mismatch in the declared columns of a view and the number of
  117854. ** columns in the SELECT on the RHS */
  117855. if( pTab->nCol!=pSub->pEList->nExpr ){
  117856. sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
  117857. pTab->nCol, pTab->zName, pSub->pEList->nExpr);
  117858. goto select_end;
  117859. }
  117860. /* Do not try to flatten an aggregate subquery.
  117861. **
  117862. ** Flattening an aggregate subquery is only possible if the outer query
  117863. ** is not a join. But if the outer query is not a join, then the subquery
  117864. ** will be implemented as a co-routine and there is no advantage to
  117865. ** flattening in that case.
  117866. */
  117867. if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
  117868. assert( pSub->pGroupBy==0 );
  117869. /* If the outer query contains a "complex" result set (that is,
  117870. ** if the result set of the outer query uses functions or subqueries)
  117871. ** and if the subquery contains an ORDER BY clause and if
  117872. ** it will be implemented as a co-routine, then do not flatten. This
  117873. ** restriction allows SQL constructs like this:
  117874. **
  117875. ** SELECT expensive_function(x)
  117876. ** FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
  117877. **
  117878. ** The expensive_function() is only computed on the 10 rows that
  117879. ** are output, rather than every row of the table.
  117880. **
  117881. ** The requirement that the outer query have a complex result set
  117882. ** means that flattening does occur on simpler SQL constraints without
  117883. ** the expensive_function() like:
  117884. **
  117885. ** SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
  117886. */
  117887. if( pSub->pOrderBy!=0
  117888. && i==0
  117889. && (p->selFlags & SF_ComplexResult)!=0
  117890. && (pTabList->nSrc==1
  117891. || (pTabList->a[1].fg.jointype&(JT_LEFT|JT_CROSS))!=0)
  117892. ){
  117893. continue;
  117894. }
  117895. if( flattenSubquery(pParse, p, i, isAgg) ){
  117896. /* This subquery can be absorbed into its parent. */
  117897. i = -1;
  117898. }
  117899. pTabList = p->pSrc;
  117900. if( db->mallocFailed ) goto select_end;
  117901. if( !IgnorableOrderby(pDest) ){
  117902. sSort.pOrderBy = p->pOrderBy;
  117903. }
  117904. }
  117905. #endif
  117906. #ifndef SQLITE_OMIT_COMPOUND_SELECT
  117907. /* Handle compound SELECT statements using the separate multiSelect()
  117908. ** procedure.
  117909. */
  117910. if( p->pPrior ){
  117911. rc = multiSelect(pParse, p, pDest);
  117912. explainSetInteger(pParse->iSelectId, iRestoreSelectId);
  117913. #if SELECTTRACE_ENABLED
  117914. SELECTTRACE(1,pParse,p,("end compound-select processing\n"));
  117915. #endif
  117916. return rc;
  117917. }
  117918. #endif
  117919. /* For each term in the FROM clause, do two things:
  117920. ** (1) Authorized unreferenced tables
  117921. ** (2) Generate code for all sub-queries
  117922. */
  117923. for(i=0; i<pTabList->nSrc; i++){
  117924. struct SrcList_item *pItem = &pTabList->a[i];
  117925. SelectDest dest;
  117926. Select *pSub;
  117927. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  117928. const char *zSavedAuthContext;
  117929. #endif
  117930. /* Issue SQLITE_READ authorizations with a fake column name for any
  117931. ** tables that are referenced but from which no values are extracted.
  117932. ** Examples of where these kinds of null SQLITE_READ authorizations
  117933. ** would occur:
  117934. **
  117935. ** SELECT count(*) FROM t1; -- SQLITE_READ t1.""
  117936. ** SELECT t1.* FROM t1, t2; -- SQLITE_READ t2.""
  117937. **
  117938. ** The fake column name is an empty string. It is possible for a table to
  117939. ** have a column named by the empty string, in which case there is no way to
  117940. ** distinguish between an unreferenced table and an actual reference to the
  117941. ** "" column. The original design was for the fake column name to be a NULL,
  117942. ** which would be unambiguous. But legacy authorization callbacks might
  117943. ** assume the column name is non-NULL and segfault. The use of an empty
  117944. ** string for the fake column name seems safer.
  117945. */
  117946. if( pItem->colUsed==0 ){
  117947. sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
  117948. }
  117949. #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
  117950. /* Generate code for all sub-queries in the FROM clause
  117951. */
  117952. pSub = pItem->pSelect;
  117953. if( pSub==0 ) continue;
  117954. /* Sometimes the code for a subquery will be generated more than
  117955. ** once, if the subquery is part of the WHERE clause in a LEFT JOIN,
  117956. ** for example. In that case, do not regenerate the code to manifest
  117957. ** a view or the co-routine to implement a view. The first instance
  117958. ** is sufficient, though the subroutine to manifest the view does need
  117959. ** to be invoked again. */
  117960. if( pItem->addrFillSub ){
  117961. if( pItem->fg.viaCoroutine==0 ){
  117962. /* The subroutine that manifests the view might be a one-time routine,
  117963. ** or it might need to be rerun on each iteration because it
  117964. ** encodes a correlated subquery. */
  117965. testcase( sqlite3VdbeGetOp(v, pItem->addrFillSub)->opcode==OP_Once );
  117966. sqlite3VdbeAddOp2(v, OP_Gosub, pItem->regReturn, pItem->addrFillSub);
  117967. }
  117968. continue;
  117969. }
  117970. /* Increment Parse.nHeight by the height of the largest expression
  117971. ** tree referred to by this, the parent select. The child select
  117972. ** may contain expression trees of at most
  117973. ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
  117974. ** more conservative than necessary, but much easier than enforcing
  117975. ** an exact limit.
  117976. */
  117977. pParse->nHeight += sqlite3SelectExprHeight(p);
  117978. /* Make copies of constant WHERE-clause terms in the outer query down
  117979. ** inside the subquery. This can help the subquery to run more efficiently.
  117980. */
  117981. if( OptimizationEnabled(db, SQLITE_PushDown)
  117982. && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem->iCursor,
  117983. (pItem->fg.jointype & JT_OUTER)!=0)
  117984. ){
  117985. #if SELECTTRACE_ENABLED
  117986. if( sqlite3SelectTrace & 0x100 ){
  117987. SELECTTRACE(0x100,pParse,p,("After WHERE-clause push-down:\n"));
  117988. sqlite3TreeViewSelect(0, p, 0);
  117989. }
  117990. #endif
  117991. }else{
  117992. SELECTTRACE(0x100,pParse,p,("Push-down not possible\n"));
  117993. }
  117994. zSavedAuthContext = pParse->zAuthContext;
  117995. pParse->zAuthContext = pItem->zName;
  117996. /* Generate code to implement the subquery
  117997. **
  117998. ** The subquery is implemented as a co-routine if the subquery is
  117999. ** guaranteed to be the outer loop (so that it does not need to be
  118000. ** computed more than once)
  118001. **
  118002. ** TODO: Are there other reasons beside (1) to use a co-routine
  118003. ** implementation?
  118004. */
  118005. if( i==0
  118006. && (pTabList->nSrc==1
  118007. || (pTabList->a[1].fg.jointype&(JT_LEFT|JT_CROSS))!=0) /* (1) */
  118008. ){
  118009. /* Implement a co-routine that will return a single row of the result
  118010. ** set on each invocation.
  118011. */
  118012. int addrTop = sqlite3VdbeCurrentAddr(v)+1;
  118013. pItem->regReturn = ++pParse->nMem;
  118014. sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
  118015. VdbeComment((v, "%s", pItem->pTab->zName));
  118016. pItem->addrFillSub = addrTop;
  118017. sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
  118018. explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
  118019. sqlite3Select(pParse, pSub, &dest);
  118020. pItem->pTab->nRowLogEst = pSub->nSelectRow;
  118021. pItem->fg.viaCoroutine = 1;
  118022. pItem->regResult = dest.iSdst;
  118023. sqlite3VdbeEndCoroutine(v, pItem->regReturn);
  118024. sqlite3VdbeJumpHere(v, addrTop-1);
  118025. sqlite3ClearTempRegCache(pParse);
  118026. }else{
  118027. /* Generate a subroutine that will fill an ephemeral table with
  118028. ** the content of this subquery. pItem->addrFillSub will point
  118029. ** to the address of the generated subroutine. pItem->regReturn
  118030. ** is a register allocated to hold the subroutine return address
  118031. */
  118032. int topAddr;
  118033. int onceAddr = 0;
  118034. int retAddr;
  118035. struct SrcList_item *pPrior;
  118036. assert( pItem->addrFillSub==0 );
  118037. pItem->regReturn = ++pParse->nMem;
  118038. topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
  118039. pItem->addrFillSub = topAddr+1;
  118040. if( pItem->fg.isCorrelated==0 ){
  118041. /* If the subquery is not correlated and if we are not inside of
  118042. ** a trigger, then we only need to compute the value of the subquery
  118043. ** once. */
  118044. onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  118045. VdbeComment((v, "materialize \"%s\"", pItem->pTab->zName));
  118046. }else{
  118047. VdbeNoopComment((v, "materialize \"%s\"", pItem->pTab->zName));
  118048. }
  118049. pPrior = isSelfJoinView(pTabList, pItem);
  118050. if( pPrior ){
  118051. sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
  118052. explainSetInteger(pItem->iSelectId, pPrior->iSelectId);
  118053. assert( pPrior->pSelect!=0 );
  118054. pSub->nSelectRow = pPrior->pSelect->nSelectRow;
  118055. }else{
  118056. sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
  118057. explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
  118058. sqlite3Select(pParse, pSub, &dest);
  118059. }
  118060. pItem->pTab->nRowLogEst = pSub->nSelectRow;
  118061. if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
  118062. retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
  118063. VdbeComment((v, "end %s", pItem->pTab->zName));
  118064. sqlite3VdbeChangeP1(v, topAddr, retAddr);
  118065. sqlite3ClearTempRegCache(pParse);
  118066. }
  118067. if( db->mallocFailed ) goto select_end;
  118068. pParse->nHeight -= sqlite3SelectExprHeight(p);
  118069. pParse->zAuthContext = zSavedAuthContext;
  118070. #endif
  118071. }
  118072. /* Various elements of the SELECT copied into local variables for
  118073. ** convenience */
  118074. pEList = p->pEList;
  118075. pWhere = p->pWhere;
  118076. pGroupBy = p->pGroupBy;
  118077. pHaving = p->pHaving;
  118078. sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
  118079. #if SELECTTRACE_ENABLED
  118080. if( sqlite3SelectTrace & 0x400 ){
  118081. SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
  118082. sqlite3TreeViewSelect(0, p, 0);
  118083. }
  118084. #endif
  118085. #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
  118086. if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
  118087. && countOfViewOptimization(pParse, p)
  118088. ){
  118089. if( db->mallocFailed ) goto select_end;
  118090. pEList = p->pEList;
  118091. pTabList = p->pSrc;
  118092. }
  118093. #endif
  118094. /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
  118095. ** if the select-list is the same as the ORDER BY list, then this query
  118096. ** can be rewritten as a GROUP BY. In other words, this:
  118097. **
  118098. ** SELECT DISTINCT xyz FROM ... ORDER BY xyz
  118099. **
  118100. ** is transformed to:
  118101. **
  118102. ** SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
  118103. **
  118104. ** The second form is preferred as a single index (or temp-table) may be
  118105. ** used for both the ORDER BY and DISTINCT processing. As originally
  118106. ** written the query must use a temp-table for at least one of the ORDER
  118107. ** BY and DISTINCT, and an index or separate temp-table for the other.
  118108. */
  118109. if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
  118110. && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
  118111. ){
  118112. p->selFlags &= ~SF_Distinct;
  118113. pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
  118114. /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
  118115. ** the sDistinct.isTnct is still set. Hence, isTnct represents the
  118116. ** original setting of the SF_Distinct flag, not the current setting */
  118117. assert( sDistinct.isTnct );
  118118. #if SELECTTRACE_ENABLED
  118119. if( sqlite3SelectTrace & 0x400 ){
  118120. SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
  118121. sqlite3TreeViewSelect(0, p, 0);
  118122. }
  118123. #endif
  118124. }
  118125. /* If there is an ORDER BY clause, then create an ephemeral index to
  118126. ** do the sorting. But this sorting ephemeral index might end up
  118127. ** being unused if the data can be extracted in pre-sorted order.
  118128. ** If that is the case, then the OP_OpenEphemeral instruction will be
  118129. ** changed to an OP_Noop once we figure out that the sorting index is
  118130. ** not needed. The sSort.addrSortIndex variable is used to facilitate
  118131. ** that change.
  118132. */
  118133. if( sSort.pOrderBy ){
  118134. KeyInfo *pKeyInfo;
  118135. pKeyInfo = keyInfoFromExprList(pParse, sSort.pOrderBy, 0, pEList->nExpr);
  118136. sSort.iECursor = pParse->nTab++;
  118137. sSort.addrSortIndex =
  118138. sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
  118139. sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
  118140. (char*)pKeyInfo, P4_KEYINFO
  118141. );
  118142. }else{
  118143. sSort.addrSortIndex = -1;
  118144. }
  118145. /* If the output is destined for a temporary table, open that table.
  118146. */
  118147. if( pDest->eDest==SRT_EphemTab ){
  118148. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
  118149. }
  118150. /* Set the limiter.
  118151. */
  118152. iEnd = sqlite3VdbeMakeLabel(v);
  118153. if( (p->selFlags & SF_FixedLimit)==0 ){
  118154. p->nSelectRow = 320; /* 4 billion rows */
  118155. }
  118156. computeLimitRegisters(pParse, p, iEnd);
  118157. if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
  118158. sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
  118159. sSort.sortFlags |= SORTFLAG_UseSorter;
  118160. }
  118161. /* Open an ephemeral index to use for the distinct set.
  118162. */
  118163. if( p->selFlags & SF_Distinct ){
  118164. sDistinct.tabTnct = pParse->nTab++;
  118165. sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
  118166. sDistinct.tabTnct, 0, 0,
  118167. (char*)keyInfoFromExprList(pParse, p->pEList,0,0),
  118168. P4_KEYINFO);
  118169. sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
  118170. sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
  118171. }else{
  118172. sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
  118173. }
  118174. if( !isAgg && pGroupBy==0 ){
  118175. /* No aggregate functions and no GROUP BY clause */
  118176. u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0);
  118177. assert( WHERE_USE_LIMIT==SF_FixedLimit );
  118178. wctrlFlags |= p->selFlags & SF_FixedLimit;
  118179. /* Begin the database scan. */
  118180. SELECTTRACE(1,pParse,p,("WhereBegin\n"));
  118181. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
  118182. p->pEList, wctrlFlags, p->nSelectRow);
  118183. if( pWInfo==0 ) goto select_end;
  118184. if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
  118185. p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
  118186. }
  118187. if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
  118188. sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
  118189. }
  118190. if( sSort.pOrderBy ){
  118191. sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
  118192. sSort.bOrderedInnerLoop = sqlite3WhereOrderedInnerLoop(pWInfo);
  118193. if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
  118194. sSort.pOrderBy = 0;
  118195. }
  118196. }
  118197. /* If sorting index that was created by a prior OP_OpenEphemeral
  118198. ** instruction ended up not being needed, then change the OP_OpenEphemeral
  118199. ** into an OP_Noop.
  118200. */
  118201. if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
  118202. sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
  118203. }
  118204. /* Use the standard inner loop. */
  118205. assert( p->pEList==pEList );
  118206. selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
  118207. sqlite3WhereContinueLabel(pWInfo),
  118208. sqlite3WhereBreakLabel(pWInfo));
  118209. /* End the database scan loop.
  118210. */
  118211. sqlite3WhereEnd(pWInfo);
  118212. }else{
  118213. /* This case when there exist aggregate functions or a GROUP BY clause
  118214. ** or both */
  118215. NameContext sNC; /* Name context for processing aggregate information */
  118216. int iAMem; /* First Mem address for storing current GROUP BY */
  118217. int iBMem; /* First Mem address for previous GROUP BY */
  118218. int iUseFlag; /* Mem address holding flag indicating that at least
  118219. ** one row of the input to the aggregator has been
  118220. ** processed */
  118221. int iAbortFlag; /* Mem address which causes query abort if positive */
  118222. int groupBySort; /* Rows come from source in GROUP BY order */
  118223. int addrEnd; /* End of processing for this SELECT */
  118224. int sortPTab = 0; /* Pseudotable used to decode sorting results */
  118225. int sortOut = 0; /* Output register from the sorter */
  118226. int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
  118227. /* Remove any and all aliases between the result set and the
  118228. ** GROUP BY clause.
  118229. */
  118230. if( pGroupBy ){
  118231. int k; /* Loop counter */
  118232. struct ExprList_item *pItem; /* For looping over expression in a list */
  118233. for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
  118234. pItem->u.x.iAlias = 0;
  118235. }
  118236. for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
  118237. pItem->u.x.iAlias = 0;
  118238. }
  118239. assert( 66==sqlite3LogEst(100) );
  118240. if( p->nSelectRow>66 ) p->nSelectRow = 66;
  118241. }else{
  118242. assert( 0==sqlite3LogEst(1) );
  118243. p->nSelectRow = 0;
  118244. }
  118245. /* If there is both a GROUP BY and an ORDER BY clause and they are
  118246. ** identical, then it may be possible to disable the ORDER BY clause
  118247. ** on the grounds that the GROUP BY will cause elements to come out
  118248. ** in the correct order. It also may not - the GROUP BY might use a
  118249. ** database index that causes rows to be grouped together as required
  118250. ** but not actually sorted. Either way, record the fact that the
  118251. ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
  118252. ** variable. */
  118253. if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
  118254. orderByGrp = 1;
  118255. }
  118256. /* Create a label to jump to when we want to abort the query */
  118257. addrEnd = sqlite3VdbeMakeLabel(v);
  118258. /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
  118259. ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
  118260. ** SELECT statement.
  118261. */
  118262. memset(&sNC, 0, sizeof(sNC));
  118263. sNC.pParse = pParse;
  118264. sNC.pSrcList = pTabList;
  118265. sNC.pAggInfo = &sAggInfo;
  118266. sAggInfo.mnReg = pParse->nMem+1;
  118267. sAggInfo.nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
  118268. sAggInfo.pGroupBy = pGroupBy;
  118269. sqlite3ExprAnalyzeAggList(&sNC, pEList);
  118270. sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
  118271. if( pHaving ){
  118272. if( pGroupBy ){
  118273. assert( pWhere==p->pWhere );
  118274. assert( pHaving==p->pHaving );
  118275. assert( pGroupBy==p->pGroupBy );
  118276. havingToWhere(pParse, p);
  118277. pWhere = p->pWhere;
  118278. }
  118279. sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
  118280. }
  118281. sAggInfo.nAccumulator = sAggInfo.nColumn;
  118282. if( p->pGroupBy==0 && p->pHaving==0 && sAggInfo.nFunc==1 ){
  118283. minMaxFlag = minMaxQuery(db, sAggInfo.aFunc[0].pExpr, &pMinMaxOrderBy);
  118284. }else{
  118285. minMaxFlag = WHERE_ORDERBY_NORMAL;
  118286. }
  118287. for(i=0; i<sAggInfo.nFunc; i++){
  118288. assert( !ExprHasProperty(sAggInfo.aFunc[i].pExpr, EP_xIsSelect) );
  118289. sNC.ncFlags |= NC_InAggFunc;
  118290. sqlite3ExprAnalyzeAggList(&sNC, sAggInfo.aFunc[i].pExpr->x.pList);
  118291. sNC.ncFlags &= ~NC_InAggFunc;
  118292. }
  118293. sAggInfo.mxReg = pParse->nMem;
  118294. if( db->mallocFailed ) goto select_end;
  118295. #if SELECTTRACE_ENABLED
  118296. if( sqlite3SelectTrace & 0x400 ){
  118297. int ii;
  118298. SELECTTRACE(0x400,pParse,p,("After aggregate analysis:\n"));
  118299. sqlite3TreeViewSelect(0, p, 0);
  118300. for(ii=0; ii<sAggInfo.nColumn; ii++){
  118301. sqlite3DebugPrintf("agg-column[%d] iMem=%d\n",
  118302. ii, sAggInfo.aCol[ii].iMem);
  118303. sqlite3TreeViewExpr(0, sAggInfo.aCol[ii].pExpr, 0);
  118304. }
  118305. for(ii=0; ii<sAggInfo.nFunc; ii++){
  118306. sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
  118307. ii, sAggInfo.aFunc[ii].iMem);
  118308. sqlite3TreeViewExpr(0, sAggInfo.aFunc[ii].pExpr, 0);
  118309. }
  118310. }
  118311. #endif
  118312. /* Processing for aggregates with GROUP BY is very different and
  118313. ** much more complex than aggregates without a GROUP BY.
  118314. */
  118315. if( pGroupBy ){
  118316. KeyInfo *pKeyInfo; /* Keying information for the group by clause */
  118317. int addr1; /* A-vs-B comparision jump */
  118318. int addrOutputRow; /* Start of subroutine that outputs a result row */
  118319. int regOutputRow; /* Return address register for output subroutine */
  118320. int addrSetAbort; /* Set the abort flag and return */
  118321. int addrTopOfLoop; /* Top of the input loop */
  118322. int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
  118323. int addrReset; /* Subroutine for resetting the accumulator */
  118324. int regReset; /* Return address register for reset subroutine */
  118325. /* If there is a GROUP BY clause we might need a sorting index to
  118326. ** implement it. Allocate that sorting index now. If it turns out
  118327. ** that we do not need it after all, the OP_SorterOpen instruction
  118328. ** will be converted into a Noop.
  118329. */
  118330. sAggInfo.sortingIdx = pParse->nTab++;
  118331. pKeyInfo = keyInfoFromExprList(pParse, pGroupBy, 0, sAggInfo.nColumn);
  118332. addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
  118333. sAggInfo.sortingIdx, sAggInfo.nSortingColumn,
  118334. 0, (char*)pKeyInfo, P4_KEYINFO);
  118335. /* Initialize memory locations used by GROUP BY aggregate processing
  118336. */
  118337. iUseFlag = ++pParse->nMem;
  118338. iAbortFlag = ++pParse->nMem;
  118339. regOutputRow = ++pParse->nMem;
  118340. addrOutputRow = sqlite3VdbeMakeLabel(v);
  118341. regReset = ++pParse->nMem;
  118342. addrReset = sqlite3VdbeMakeLabel(v);
  118343. iAMem = pParse->nMem + 1;
  118344. pParse->nMem += pGroupBy->nExpr;
  118345. iBMem = pParse->nMem + 1;
  118346. pParse->nMem += pGroupBy->nExpr;
  118347. sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
  118348. VdbeComment((v, "clear abort flag"));
  118349. sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
  118350. VdbeComment((v, "indicate accumulator empty"));
  118351. sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
  118352. /* Begin a loop that will extract all source rows in GROUP BY order.
  118353. ** This might involve two separate loops with an OP_Sort in between, or
  118354. ** it might be a single loop that uses an index to extract information
  118355. ** in the right order to begin with.
  118356. */
  118357. sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
  118358. SELECTTRACE(1,pParse,p,("WhereBegin\n"));
  118359. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, 0,
  118360. WHERE_GROUPBY | (orderByGrp ? WHERE_SORTBYGROUP : 0), 0
  118361. );
  118362. if( pWInfo==0 ) goto select_end;
  118363. if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
  118364. /* The optimizer is able to deliver rows in group by order so
  118365. ** we do not have to sort. The OP_OpenEphemeral table will be
  118366. ** cancelled later because we still need to use the pKeyInfo
  118367. */
  118368. groupBySort = 0;
  118369. }else{
  118370. /* Rows are coming out in undetermined order. We have to push
  118371. ** each row into a sorting index, terminate the first loop,
  118372. ** then loop over the sorting index in order to get the output
  118373. ** in sorted order
  118374. */
  118375. int regBase;
  118376. int regRecord;
  118377. int nCol;
  118378. int nGroupBy;
  118379. explainTempTable(pParse,
  118380. (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
  118381. "DISTINCT" : "GROUP BY");
  118382. groupBySort = 1;
  118383. nGroupBy = pGroupBy->nExpr;
  118384. nCol = nGroupBy;
  118385. j = nGroupBy;
  118386. for(i=0; i<sAggInfo.nColumn; i++){
  118387. if( sAggInfo.aCol[i].iSorterColumn>=j ){
  118388. nCol++;
  118389. j++;
  118390. }
  118391. }
  118392. regBase = sqlite3GetTempRange(pParse, nCol);
  118393. sqlite3ExprCacheClear(pParse);
  118394. sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
  118395. j = nGroupBy;
  118396. for(i=0; i<sAggInfo.nColumn; i++){
  118397. struct AggInfo_col *pCol = &sAggInfo.aCol[i];
  118398. if( pCol->iSorterColumn>=j ){
  118399. int r1 = j + regBase;
  118400. sqlite3ExprCodeGetColumnToReg(pParse,
  118401. pCol->pTab, pCol->iColumn, pCol->iTable, r1);
  118402. j++;
  118403. }
  118404. }
  118405. regRecord = sqlite3GetTempReg(pParse);
  118406. sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
  118407. sqlite3VdbeAddOp2(v, OP_SorterInsert, sAggInfo.sortingIdx, regRecord);
  118408. sqlite3ReleaseTempReg(pParse, regRecord);
  118409. sqlite3ReleaseTempRange(pParse, regBase, nCol);
  118410. sqlite3WhereEnd(pWInfo);
  118411. sAggInfo.sortingIdxPTab = sortPTab = pParse->nTab++;
  118412. sortOut = sqlite3GetTempReg(pParse);
  118413. sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
  118414. sqlite3VdbeAddOp2(v, OP_SorterSort, sAggInfo.sortingIdx, addrEnd);
  118415. VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
  118416. sAggInfo.useSortingIdx = 1;
  118417. sqlite3ExprCacheClear(pParse);
  118418. }
  118419. /* If the index or temporary table used by the GROUP BY sort
  118420. ** will naturally deliver rows in the order required by the ORDER BY
  118421. ** clause, cancel the ephemeral table open coded earlier.
  118422. **
  118423. ** This is an optimization - the correct answer should result regardless.
  118424. ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
  118425. ** disable this optimization for testing purposes. */
  118426. if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
  118427. && (groupBySort || sqlite3WhereIsSorted(pWInfo))
  118428. ){
  118429. sSort.pOrderBy = 0;
  118430. sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
  118431. }
  118432. /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
  118433. ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
  118434. ** Then compare the current GROUP BY terms against the GROUP BY terms
  118435. ** from the previous row currently stored in a0, a1, a2...
  118436. */
  118437. addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
  118438. sqlite3ExprCacheClear(pParse);
  118439. if( groupBySort ){
  118440. sqlite3VdbeAddOp3(v, OP_SorterData, sAggInfo.sortingIdx,
  118441. sortOut, sortPTab);
  118442. }
  118443. for(j=0; j<pGroupBy->nExpr; j++){
  118444. if( groupBySort ){
  118445. sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
  118446. }else{
  118447. sAggInfo.directMode = 1;
  118448. sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
  118449. }
  118450. }
  118451. sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
  118452. (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
  118453. addr1 = sqlite3VdbeCurrentAddr(v);
  118454. sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
  118455. /* Generate code that runs whenever the GROUP BY changes.
  118456. ** Changes in the GROUP BY are detected by the previous code
  118457. ** block. If there were no changes, this block is skipped.
  118458. **
  118459. ** This code copies current group by terms in b0,b1,b2,...
  118460. ** over to a0,a1,a2. It then calls the output subroutine
  118461. ** and resets the aggregate accumulator registers in preparation
  118462. ** for the next GROUP BY batch.
  118463. */
  118464. sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
  118465. sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
  118466. VdbeComment((v, "output one row"));
  118467. sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
  118468. VdbeComment((v, "check abort flag"));
  118469. sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
  118470. VdbeComment((v, "reset accumulator"));
  118471. /* Update the aggregate accumulators based on the content of
  118472. ** the current row
  118473. */
  118474. sqlite3VdbeJumpHere(v, addr1);
  118475. updateAccumulator(pParse, &sAggInfo);
  118476. sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
  118477. VdbeComment((v, "indicate data in accumulator"));
  118478. /* End of the loop
  118479. */
  118480. if( groupBySort ){
  118481. sqlite3VdbeAddOp2(v, OP_SorterNext, sAggInfo.sortingIdx, addrTopOfLoop);
  118482. VdbeCoverage(v);
  118483. }else{
  118484. sqlite3WhereEnd(pWInfo);
  118485. sqlite3VdbeChangeToNoop(v, addrSortingIdx);
  118486. }
  118487. /* Output the final row of result
  118488. */
  118489. sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
  118490. VdbeComment((v, "output final row"));
  118491. /* Jump over the subroutines
  118492. */
  118493. sqlite3VdbeGoto(v, addrEnd);
  118494. /* Generate a subroutine that outputs a single row of the result
  118495. ** set. This subroutine first looks at the iUseFlag. If iUseFlag
  118496. ** is less than or equal to zero, the subroutine is a no-op. If
  118497. ** the processing calls for the query to abort, this subroutine
  118498. ** increments the iAbortFlag memory location before returning in
  118499. ** order to signal the caller to abort.
  118500. */
  118501. addrSetAbort = sqlite3VdbeCurrentAddr(v);
  118502. sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
  118503. VdbeComment((v, "set abort flag"));
  118504. sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
  118505. sqlite3VdbeResolveLabel(v, addrOutputRow);
  118506. addrOutputRow = sqlite3VdbeCurrentAddr(v);
  118507. sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
  118508. VdbeCoverage(v);
  118509. VdbeComment((v, "Groupby result generator entry point"));
  118510. sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
  118511. finalizeAggFunctions(pParse, &sAggInfo);
  118512. sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
  118513. selectInnerLoop(pParse, p, -1, &sSort,
  118514. &sDistinct, pDest,
  118515. addrOutputRow+1, addrSetAbort);
  118516. sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
  118517. VdbeComment((v, "end groupby result generator"));
  118518. /* Generate a subroutine that will reset the group-by accumulator
  118519. */
  118520. sqlite3VdbeResolveLabel(v, addrReset);
  118521. resetAccumulator(pParse, &sAggInfo);
  118522. sqlite3VdbeAddOp1(v, OP_Return, regReset);
  118523. } /* endif pGroupBy. Begin aggregate queries without GROUP BY: */
  118524. else {
  118525. #ifndef SQLITE_OMIT_BTREECOUNT
  118526. Table *pTab;
  118527. if( (pTab = isSimpleCount(p, &sAggInfo))!=0 ){
  118528. /* If isSimpleCount() returns a pointer to a Table structure, then
  118529. ** the SQL statement is of the form:
  118530. **
  118531. ** SELECT count(*) FROM <tbl>
  118532. **
  118533. ** where the Table structure returned represents table <tbl>.
  118534. **
  118535. ** This statement is so common that it is optimized specially. The
  118536. ** OP_Count instruction is executed either on the intkey table that
  118537. ** contains the data for table <tbl> or on one of its indexes. It
  118538. ** is better to execute the op on an index, as indexes are almost
  118539. ** always spread across less pages than their corresponding tables.
  118540. */
  118541. const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  118542. const int iCsr = pParse->nTab++; /* Cursor to scan b-tree */
  118543. Index *pIdx; /* Iterator variable */
  118544. KeyInfo *pKeyInfo = 0; /* Keyinfo for scanned index */
  118545. Index *pBest = 0; /* Best index found so far */
  118546. int iRoot = pTab->tnum; /* Root page of scanned b-tree */
  118547. sqlite3CodeVerifySchema(pParse, iDb);
  118548. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  118549. /* Search for the index that has the lowest scan cost.
  118550. **
  118551. ** (2011-04-15) Do not do a full scan of an unordered index.
  118552. **
  118553. ** (2013-10-03) Do not count the entries in a partial index.
  118554. **
  118555. ** In practice the KeyInfo structure will not be used. It is only
  118556. ** passed to keep OP_OpenRead happy.
  118557. */
  118558. if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
  118559. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  118560. if( pIdx->bUnordered==0
  118561. && pIdx->szIdxRow<pTab->szTabRow
  118562. && pIdx->pPartIdxWhere==0
  118563. && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
  118564. ){
  118565. pBest = pIdx;
  118566. }
  118567. }
  118568. if( pBest ){
  118569. iRoot = pBest->tnum;
  118570. pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
  118571. }
  118572. /* Open a read-only cursor, execute the OP_Count, close the cursor. */
  118573. sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, iRoot, iDb, 1);
  118574. if( pKeyInfo ){
  118575. sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
  118576. }
  118577. sqlite3VdbeAddOp2(v, OP_Count, iCsr, sAggInfo.aFunc[0].iMem);
  118578. sqlite3VdbeAddOp1(v, OP_Close, iCsr);
  118579. explainSimpleCount(pParse, pTab, pBest);
  118580. }else
  118581. #endif /* SQLITE_OMIT_BTREECOUNT */
  118582. {
  118583. /* This case runs if the aggregate has no GROUP BY clause. The
  118584. ** processing is much simpler since there is only a single row
  118585. ** of output.
  118586. */
  118587. assert( p->pGroupBy==0 );
  118588. resetAccumulator(pParse, &sAggInfo);
  118589. /* If this query is a candidate for the min/max optimization, then
  118590. ** minMaxFlag will have been previously set to either
  118591. ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
  118592. ** be an appropriate ORDER BY expression for the optimization.
  118593. */
  118594. assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
  118595. assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
  118596. SELECTTRACE(1,pParse,p,("WhereBegin\n"));
  118597. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
  118598. 0, minMaxFlag, 0);
  118599. if( pWInfo==0 ){
  118600. goto select_end;
  118601. }
  118602. updateAccumulator(pParse, &sAggInfo);
  118603. if( sqlite3WhereIsOrdered(pWInfo)>0 ){
  118604. sqlite3VdbeGoto(v, sqlite3WhereBreakLabel(pWInfo));
  118605. VdbeComment((v, "%s() by index",
  118606. (minMaxFlag==WHERE_ORDERBY_MIN?"min":"max")));
  118607. }
  118608. sqlite3WhereEnd(pWInfo);
  118609. finalizeAggFunctions(pParse, &sAggInfo);
  118610. }
  118611. sSort.pOrderBy = 0;
  118612. sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
  118613. selectInnerLoop(pParse, p, -1, 0, 0,
  118614. pDest, addrEnd, addrEnd);
  118615. }
  118616. sqlite3VdbeResolveLabel(v, addrEnd);
  118617. } /* endif aggregate query */
  118618. if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
  118619. explainTempTable(pParse, "DISTINCT");
  118620. }
  118621. /* If there is an ORDER BY clause, then we need to sort the results
  118622. ** and send them to the callback one by one.
  118623. */
  118624. if( sSort.pOrderBy ){
  118625. explainTempTable(pParse,
  118626. sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
  118627. generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
  118628. }
  118629. /* Jump here to skip this query
  118630. */
  118631. sqlite3VdbeResolveLabel(v, iEnd);
  118632. /* The SELECT has been coded. If there is an error in the Parse structure,
  118633. ** set the return code to 1. Otherwise 0. */
  118634. rc = (pParse->nErr>0);
  118635. /* Control jumps to here if an error is encountered above, or upon
  118636. ** successful coding of the SELECT.
  118637. */
  118638. select_end:
  118639. explainSetInteger(pParse->iSelectId, iRestoreSelectId);
  118640. sqlite3ExprListDelete(db, pMinMaxOrderBy);
  118641. sqlite3DbFree(db, sAggInfo.aCol);
  118642. sqlite3DbFree(db, sAggInfo.aFunc);
  118643. #if SELECTTRACE_ENABLED
  118644. SELECTTRACE(1,pParse,p,("end processing\n"));
  118645. #endif
  118646. return rc;
  118647. }
  118648. /************** End of select.c **********************************************/
  118649. /************** Begin file table.c *******************************************/
  118650. /*
  118651. ** 2001 September 15
  118652. **
  118653. ** The author disclaims copyright to this source code. In place of
  118654. ** a legal notice, here is a blessing:
  118655. **
  118656. ** May you do good and not evil.
  118657. ** May you find forgiveness for yourself and forgive others.
  118658. ** May you share freely, never taking more than you give.
  118659. **
  118660. *************************************************************************
  118661. ** This file contains the sqlite3_get_table() and sqlite3_free_table()
  118662. ** interface routines. These are just wrappers around the main
  118663. ** interface routine of sqlite3_exec().
  118664. **
  118665. ** These routines are in a separate files so that they will not be linked
  118666. ** if they are not used.
  118667. */
  118668. /* #include "sqliteInt.h" */
  118669. #ifndef SQLITE_OMIT_GET_TABLE
  118670. /*
  118671. ** This structure is used to pass data from sqlite3_get_table() through
  118672. ** to the callback function is uses to build the result.
  118673. */
  118674. typedef struct TabResult {
  118675. char **azResult; /* Accumulated output */
  118676. char *zErrMsg; /* Error message text, if an error occurs */
  118677. u32 nAlloc; /* Slots allocated for azResult[] */
  118678. u32 nRow; /* Number of rows in the result */
  118679. u32 nColumn; /* Number of columns in the result */
  118680. u32 nData; /* Slots used in azResult[]. (nRow+1)*nColumn */
  118681. int rc; /* Return code from sqlite3_exec() */
  118682. } TabResult;
  118683. /*
  118684. ** This routine is called once for each row in the result table. Its job
  118685. ** is to fill in the TabResult structure appropriately, allocating new
  118686. ** memory as necessary.
  118687. */
  118688. static int sqlite3_get_table_cb(void *pArg, int nCol, char **argv, char **colv){
  118689. TabResult *p = (TabResult*)pArg; /* Result accumulator */
  118690. int need; /* Slots needed in p->azResult[] */
  118691. int i; /* Loop counter */
  118692. char *z; /* A single column of result */
  118693. /* Make sure there is enough space in p->azResult to hold everything
  118694. ** we need to remember from this invocation of the callback.
  118695. */
  118696. if( p->nRow==0 && argv!=0 ){
  118697. need = nCol*2;
  118698. }else{
  118699. need = nCol;
  118700. }
  118701. if( p->nData + need > p->nAlloc ){
  118702. char **azNew;
  118703. p->nAlloc = p->nAlloc*2 + need;
  118704. azNew = sqlite3_realloc64( p->azResult, sizeof(char*)*p->nAlloc );
  118705. if( azNew==0 ) goto malloc_failed;
  118706. p->azResult = azNew;
  118707. }
  118708. /* If this is the first row, then generate an extra row containing
  118709. ** the names of all columns.
  118710. */
  118711. if( p->nRow==0 ){
  118712. p->nColumn = nCol;
  118713. for(i=0; i<nCol; i++){
  118714. z = sqlite3_mprintf("%s", colv[i]);
  118715. if( z==0 ) goto malloc_failed;
  118716. p->azResult[p->nData++] = z;
  118717. }
  118718. }else if( (int)p->nColumn!=nCol ){
  118719. sqlite3_free(p->zErrMsg);
  118720. p->zErrMsg = sqlite3_mprintf(
  118721. "sqlite3_get_table() called with two or more incompatible queries"
  118722. );
  118723. p->rc = SQLITE_ERROR;
  118724. return 1;
  118725. }
  118726. /* Copy over the row data
  118727. */
  118728. if( argv!=0 ){
  118729. for(i=0; i<nCol; i++){
  118730. if( argv[i]==0 ){
  118731. z = 0;
  118732. }else{
  118733. int n = sqlite3Strlen30(argv[i])+1;
  118734. z = sqlite3_malloc64( n );
  118735. if( z==0 ) goto malloc_failed;
  118736. memcpy(z, argv[i], n);
  118737. }
  118738. p->azResult[p->nData++] = z;
  118739. }
  118740. p->nRow++;
  118741. }
  118742. return 0;
  118743. malloc_failed:
  118744. p->rc = SQLITE_NOMEM_BKPT;
  118745. return 1;
  118746. }
  118747. /*
  118748. ** Query the database. But instead of invoking a callback for each row,
  118749. ** malloc() for space to hold the result and return the entire results
  118750. ** at the conclusion of the call.
  118751. **
  118752. ** The result that is written to ***pazResult is held in memory obtained
  118753. ** from malloc(). But the caller cannot free this memory directly.
  118754. ** Instead, the entire table should be passed to sqlite3_free_table() when
  118755. ** the calling procedure is finished using it.
  118756. */
  118757. SQLITE_API int sqlite3_get_table(
  118758. sqlite3 *db, /* The database on which the SQL executes */
  118759. const char *zSql, /* The SQL to be executed */
  118760. char ***pazResult, /* Write the result table here */
  118761. int *pnRow, /* Write the number of rows in the result here */
  118762. int *pnColumn, /* Write the number of columns of result here */
  118763. char **pzErrMsg /* Write error messages here */
  118764. ){
  118765. int rc;
  118766. TabResult res;
  118767. #ifdef SQLITE_ENABLE_API_ARMOR
  118768. if( !sqlite3SafetyCheckOk(db) || pazResult==0 ) return SQLITE_MISUSE_BKPT;
  118769. #endif
  118770. *pazResult = 0;
  118771. if( pnColumn ) *pnColumn = 0;
  118772. if( pnRow ) *pnRow = 0;
  118773. if( pzErrMsg ) *pzErrMsg = 0;
  118774. res.zErrMsg = 0;
  118775. res.nRow = 0;
  118776. res.nColumn = 0;
  118777. res.nData = 1;
  118778. res.nAlloc = 20;
  118779. res.rc = SQLITE_OK;
  118780. res.azResult = sqlite3_malloc64(sizeof(char*)*res.nAlloc );
  118781. if( res.azResult==0 ){
  118782. db->errCode = SQLITE_NOMEM;
  118783. return SQLITE_NOMEM_BKPT;
  118784. }
  118785. res.azResult[0] = 0;
  118786. rc = sqlite3_exec(db, zSql, sqlite3_get_table_cb, &res, pzErrMsg);
  118787. assert( sizeof(res.azResult[0])>= sizeof(res.nData) );
  118788. res.azResult[0] = SQLITE_INT_TO_PTR(res.nData);
  118789. if( (rc&0xff)==SQLITE_ABORT ){
  118790. sqlite3_free_table(&res.azResult[1]);
  118791. if( res.zErrMsg ){
  118792. if( pzErrMsg ){
  118793. sqlite3_free(*pzErrMsg);
  118794. *pzErrMsg = sqlite3_mprintf("%s",res.zErrMsg);
  118795. }
  118796. sqlite3_free(res.zErrMsg);
  118797. }
  118798. db->errCode = res.rc; /* Assume 32-bit assignment is atomic */
  118799. return res.rc;
  118800. }
  118801. sqlite3_free(res.zErrMsg);
  118802. if( rc!=SQLITE_OK ){
  118803. sqlite3_free_table(&res.azResult[1]);
  118804. return rc;
  118805. }
  118806. if( res.nAlloc>res.nData ){
  118807. char **azNew;
  118808. azNew = sqlite3_realloc64( res.azResult, sizeof(char*)*res.nData );
  118809. if( azNew==0 ){
  118810. sqlite3_free_table(&res.azResult[1]);
  118811. db->errCode = SQLITE_NOMEM;
  118812. return SQLITE_NOMEM_BKPT;
  118813. }
  118814. res.azResult = azNew;
  118815. }
  118816. *pazResult = &res.azResult[1];
  118817. if( pnColumn ) *pnColumn = res.nColumn;
  118818. if( pnRow ) *pnRow = res.nRow;
  118819. return rc;
  118820. }
  118821. /*
  118822. ** This routine frees the space the sqlite3_get_table() malloced.
  118823. */
  118824. SQLITE_API void sqlite3_free_table(
  118825. char **azResult /* Result returned from sqlite3_get_table() */
  118826. ){
  118827. if( azResult ){
  118828. int i, n;
  118829. azResult--;
  118830. assert( azResult!=0 );
  118831. n = SQLITE_PTR_TO_INT(azResult[0]);
  118832. for(i=1; i<n; i++){ if( azResult[i] ) sqlite3_free(azResult[i]); }
  118833. sqlite3_free(azResult);
  118834. }
  118835. }
  118836. #endif /* SQLITE_OMIT_GET_TABLE */
  118837. /************** End of table.c ***********************************************/
  118838. /************** Begin file trigger.c *****************************************/
  118839. /*
  118840. **
  118841. ** The author disclaims copyright to this source code. In place of
  118842. ** a legal notice, here is a blessing:
  118843. **
  118844. ** May you do good and not evil.
  118845. ** May you find forgiveness for yourself and forgive others.
  118846. ** May you share freely, never taking more than you give.
  118847. **
  118848. *************************************************************************
  118849. ** This file contains the implementation for TRIGGERs
  118850. */
  118851. /* #include "sqliteInt.h" */
  118852. #ifndef SQLITE_OMIT_TRIGGER
  118853. /*
  118854. ** Delete a linked list of TriggerStep structures.
  118855. */
  118856. SQLITE_PRIVATE void sqlite3DeleteTriggerStep(sqlite3 *db, TriggerStep *pTriggerStep){
  118857. while( pTriggerStep ){
  118858. TriggerStep * pTmp = pTriggerStep;
  118859. pTriggerStep = pTriggerStep->pNext;
  118860. sqlite3ExprDelete(db, pTmp->pWhere);
  118861. sqlite3ExprListDelete(db, pTmp->pExprList);
  118862. sqlite3SelectDelete(db, pTmp->pSelect);
  118863. sqlite3IdListDelete(db, pTmp->pIdList);
  118864. sqlite3DbFree(db, pTmp->zSpan);
  118865. sqlite3DbFree(db, pTmp);
  118866. }
  118867. }
  118868. /*
  118869. ** Given table pTab, return a list of all the triggers attached to
  118870. ** the table. The list is connected by Trigger.pNext pointers.
  118871. **
  118872. ** All of the triggers on pTab that are in the same database as pTab
  118873. ** are already attached to pTab->pTrigger. But there might be additional
  118874. ** triggers on pTab in the TEMP schema. This routine prepends all
  118875. ** TEMP triggers on pTab to the beginning of the pTab->pTrigger list
  118876. ** and returns the combined list.
  118877. **
  118878. ** To state it another way: This routine returns a list of all triggers
  118879. ** that fire off of pTab. The list will include any TEMP triggers on
  118880. ** pTab as well as the triggers lised in pTab->pTrigger.
  118881. */
  118882. SQLITE_PRIVATE Trigger *sqlite3TriggerList(Parse *pParse, Table *pTab){
  118883. Schema * const pTmpSchema = pParse->db->aDb[1].pSchema;
  118884. Trigger *pList = 0; /* List of triggers to return */
  118885. if( pParse->disableTriggers ){
  118886. return 0;
  118887. }
  118888. if( pTmpSchema!=pTab->pSchema ){
  118889. HashElem *p;
  118890. assert( sqlite3SchemaMutexHeld(pParse->db, 0, pTmpSchema) );
  118891. for(p=sqliteHashFirst(&pTmpSchema->trigHash); p; p=sqliteHashNext(p)){
  118892. Trigger *pTrig = (Trigger *)sqliteHashData(p);
  118893. if( pTrig->pTabSchema==pTab->pSchema
  118894. && 0==sqlite3StrICmp(pTrig->table, pTab->zName)
  118895. ){
  118896. pTrig->pNext = (pList ? pList : pTab->pTrigger);
  118897. pList = pTrig;
  118898. }
  118899. }
  118900. }
  118901. return (pList ? pList : pTab->pTrigger);
  118902. }
  118903. /*
  118904. ** This is called by the parser when it sees a CREATE TRIGGER statement
  118905. ** up to the point of the BEGIN before the trigger actions. A Trigger
  118906. ** structure is generated based on the information available and stored
  118907. ** in pParse->pNewTrigger. After the trigger actions have been parsed, the
  118908. ** sqlite3FinishTrigger() function is called to complete the trigger
  118909. ** construction process.
  118910. */
  118911. SQLITE_PRIVATE void sqlite3BeginTrigger(
  118912. Parse *pParse, /* The parse context of the CREATE TRIGGER statement */
  118913. Token *pName1, /* The name of the trigger */
  118914. Token *pName2, /* The name of the trigger */
  118915. int tr_tm, /* One of TK_BEFORE, TK_AFTER, TK_INSTEAD */
  118916. int op, /* One of TK_INSERT, TK_UPDATE, TK_DELETE */
  118917. IdList *pColumns, /* column list if this is an UPDATE OF trigger */
  118918. SrcList *pTableName,/* The name of the table/view the trigger applies to */
  118919. Expr *pWhen, /* WHEN clause */
  118920. int isTemp, /* True if the TEMPORARY keyword is present */
  118921. int noErr /* Suppress errors if the trigger already exists */
  118922. ){
  118923. Trigger *pTrigger = 0; /* The new trigger */
  118924. Table *pTab; /* Table that the trigger fires off of */
  118925. char *zName = 0; /* Name of the trigger */
  118926. sqlite3 *db = pParse->db; /* The database connection */
  118927. int iDb; /* The database to store the trigger in */
  118928. Token *pName; /* The unqualified db name */
  118929. DbFixer sFix; /* State vector for the DB fixer */
  118930. assert( pName1!=0 ); /* pName1->z might be NULL, but not pName1 itself */
  118931. assert( pName2!=0 );
  118932. assert( op==TK_INSERT || op==TK_UPDATE || op==TK_DELETE );
  118933. assert( op>0 && op<0xff );
  118934. if( isTemp ){
  118935. /* If TEMP was specified, then the trigger name may not be qualified. */
  118936. if( pName2->n>0 ){
  118937. sqlite3ErrorMsg(pParse, "temporary trigger may not have qualified name");
  118938. goto trigger_cleanup;
  118939. }
  118940. iDb = 1;
  118941. pName = pName1;
  118942. }else{
  118943. /* Figure out the db that the trigger will be created in */
  118944. iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pName);
  118945. if( iDb<0 ){
  118946. goto trigger_cleanup;
  118947. }
  118948. }
  118949. if( !pTableName || db->mallocFailed ){
  118950. goto trigger_cleanup;
  118951. }
  118952. /* A long-standing parser bug is that this syntax was allowed:
  118953. **
  118954. ** CREATE TRIGGER attached.demo AFTER INSERT ON attached.tab ....
  118955. ** ^^^^^^^^
  118956. **
  118957. ** To maintain backwards compatibility, ignore the database
  118958. ** name on pTableName if we are reparsing out of SQLITE_MASTER.
  118959. */
  118960. if( db->init.busy && iDb!=1 ){
  118961. sqlite3DbFree(db, pTableName->a[0].zDatabase);
  118962. pTableName->a[0].zDatabase = 0;
  118963. }
  118964. /* If the trigger name was unqualified, and the table is a temp table,
  118965. ** then set iDb to 1 to create the trigger in the temporary database.
  118966. ** If sqlite3SrcListLookup() returns 0, indicating the table does not
  118967. ** exist, the error is caught by the block below.
  118968. */
  118969. pTab = sqlite3SrcListLookup(pParse, pTableName);
  118970. if( db->init.busy==0 && pName2->n==0 && pTab
  118971. && pTab->pSchema==db->aDb[1].pSchema ){
  118972. iDb = 1;
  118973. }
  118974. /* Ensure the table name matches database name and that the table exists */
  118975. if( db->mallocFailed ) goto trigger_cleanup;
  118976. assert( pTableName->nSrc==1 );
  118977. sqlite3FixInit(&sFix, pParse, iDb, "trigger", pName);
  118978. if( sqlite3FixSrcList(&sFix, pTableName) ){
  118979. goto trigger_cleanup;
  118980. }
  118981. pTab = sqlite3SrcListLookup(pParse, pTableName);
  118982. if( !pTab ){
  118983. /* The table does not exist. */
  118984. if( db->init.iDb==1 ){
  118985. /* Ticket #3810.
  118986. ** Normally, whenever a table is dropped, all associated triggers are
  118987. ** dropped too. But if a TEMP trigger is created on a non-TEMP table
  118988. ** and the table is dropped by a different database connection, the
  118989. ** trigger is not visible to the database connection that does the
  118990. ** drop so the trigger cannot be dropped. This results in an
  118991. ** "orphaned trigger" - a trigger whose associated table is missing.
  118992. */
  118993. db->init.orphanTrigger = 1;
  118994. }
  118995. goto trigger_cleanup;
  118996. }
  118997. if( IsVirtual(pTab) ){
  118998. sqlite3ErrorMsg(pParse, "cannot create triggers on virtual tables");
  118999. goto trigger_cleanup;
  119000. }
  119001. /* Check that the trigger name is not reserved and that no trigger of the
  119002. ** specified name exists */
  119003. zName = sqlite3NameFromToken(db, pName);
  119004. if( !zName || SQLITE_OK!=sqlite3CheckObjectName(pParse, zName) ){
  119005. goto trigger_cleanup;
  119006. }
  119007. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  119008. if( sqlite3HashFind(&(db->aDb[iDb].pSchema->trigHash),zName) ){
  119009. if( !noErr ){
  119010. sqlite3ErrorMsg(pParse, "trigger %T already exists", pName);
  119011. }else{
  119012. assert( !db->init.busy );
  119013. sqlite3CodeVerifySchema(pParse, iDb);
  119014. }
  119015. goto trigger_cleanup;
  119016. }
  119017. /* Do not create a trigger on a system table */
  119018. if( sqlite3StrNICmp(pTab->zName, "sqlite_", 7)==0 ){
  119019. sqlite3ErrorMsg(pParse, "cannot create trigger on system table");
  119020. goto trigger_cleanup;
  119021. }
  119022. /* INSTEAD of triggers are only for views and views only support INSTEAD
  119023. ** of triggers.
  119024. */
  119025. if( pTab->pSelect && tr_tm!=TK_INSTEAD ){
  119026. sqlite3ErrorMsg(pParse, "cannot create %s trigger on view: %S",
  119027. (tr_tm == TK_BEFORE)?"BEFORE":"AFTER", pTableName, 0);
  119028. goto trigger_cleanup;
  119029. }
  119030. if( !pTab->pSelect && tr_tm==TK_INSTEAD ){
  119031. sqlite3ErrorMsg(pParse, "cannot create INSTEAD OF"
  119032. " trigger on table: %S", pTableName, 0);
  119033. goto trigger_cleanup;
  119034. }
  119035. #ifndef SQLITE_OMIT_AUTHORIZATION
  119036. {
  119037. int iTabDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  119038. int code = SQLITE_CREATE_TRIGGER;
  119039. const char *zDb = db->aDb[iTabDb].zDbSName;
  119040. const char *zDbTrig = isTemp ? db->aDb[1].zDbSName : zDb;
  119041. if( iTabDb==1 || isTemp ) code = SQLITE_CREATE_TEMP_TRIGGER;
  119042. if( sqlite3AuthCheck(pParse, code, zName, pTab->zName, zDbTrig) ){
  119043. goto trigger_cleanup;
  119044. }
  119045. if( sqlite3AuthCheck(pParse, SQLITE_INSERT, SCHEMA_TABLE(iTabDb),0,zDb)){
  119046. goto trigger_cleanup;
  119047. }
  119048. }
  119049. #endif
  119050. /* INSTEAD OF triggers can only appear on views and BEFORE triggers
  119051. ** cannot appear on views. So we might as well translate every
  119052. ** INSTEAD OF trigger into a BEFORE trigger. It simplifies code
  119053. ** elsewhere.
  119054. */
  119055. if (tr_tm == TK_INSTEAD){
  119056. tr_tm = TK_BEFORE;
  119057. }
  119058. /* Build the Trigger object */
  119059. pTrigger = (Trigger*)sqlite3DbMallocZero(db, sizeof(Trigger));
  119060. if( pTrigger==0 ) goto trigger_cleanup;
  119061. pTrigger->zName = zName;
  119062. zName = 0;
  119063. pTrigger->table = sqlite3DbStrDup(db, pTableName->a[0].zName);
  119064. pTrigger->pSchema = db->aDb[iDb].pSchema;
  119065. pTrigger->pTabSchema = pTab->pSchema;
  119066. pTrigger->op = (u8)op;
  119067. pTrigger->tr_tm = tr_tm==TK_BEFORE ? TRIGGER_BEFORE : TRIGGER_AFTER;
  119068. pTrigger->pWhen = sqlite3ExprDup(db, pWhen, EXPRDUP_REDUCE);
  119069. pTrigger->pColumns = sqlite3IdListDup(db, pColumns);
  119070. assert( pParse->pNewTrigger==0 );
  119071. pParse->pNewTrigger = pTrigger;
  119072. trigger_cleanup:
  119073. sqlite3DbFree(db, zName);
  119074. sqlite3SrcListDelete(db, pTableName);
  119075. sqlite3IdListDelete(db, pColumns);
  119076. sqlite3ExprDelete(db, pWhen);
  119077. if( !pParse->pNewTrigger ){
  119078. sqlite3DeleteTrigger(db, pTrigger);
  119079. }else{
  119080. assert( pParse->pNewTrigger==pTrigger );
  119081. }
  119082. }
  119083. /*
  119084. ** This routine is called after all of the trigger actions have been parsed
  119085. ** in order to complete the process of building the trigger.
  119086. */
  119087. SQLITE_PRIVATE void sqlite3FinishTrigger(
  119088. Parse *pParse, /* Parser context */
  119089. TriggerStep *pStepList, /* The triggered program */
  119090. Token *pAll /* Token that describes the complete CREATE TRIGGER */
  119091. ){
  119092. Trigger *pTrig = pParse->pNewTrigger; /* Trigger being finished */
  119093. char *zName; /* Name of trigger */
  119094. sqlite3 *db = pParse->db; /* The database */
  119095. DbFixer sFix; /* Fixer object */
  119096. int iDb; /* Database containing the trigger */
  119097. Token nameToken; /* Trigger name for error reporting */
  119098. pParse->pNewTrigger = 0;
  119099. if( NEVER(pParse->nErr) || !pTrig ) goto triggerfinish_cleanup;
  119100. zName = pTrig->zName;
  119101. iDb = sqlite3SchemaToIndex(pParse->db, pTrig->pSchema);
  119102. pTrig->step_list = pStepList;
  119103. while( pStepList ){
  119104. pStepList->pTrig = pTrig;
  119105. pStepList = pStepList->pNext;
  119106. }
  119107. sqlite3TokenInit(&nameToken, pTrig->zName);
  119108. sqlite3FixInit(&sFix, pParse, iDb, "trigger", &nameToken);
  119109. if( sqlite3FixTriggerStep(&sFix, pTrig->step_list)
  119110. || sqlite3FixExpr(&sFix, pTrig->pWhen)
  119111. ){
  119112. goto triggerfinish_cleanup;
  119113. }
  119114. /* if we are not initializing,
  119115. ** build the sqlite_master entry
  119116. */
  119117. if( !db->init.busy ){
  119118. Vdbe *v;
  119119. char *z;
  119120. /* Make an entry in the sqlite_master table */
  119121. v = sqlite3GetVdbe(pParse);
  119122. if( v==0 ) goto triggerfinish_cleanup;
  119123. sqlite3BeginWriteOperation(pParse, 0, iDb);
  119124. z = sqlite3DbStrNDup(db, (char*)pAll->z, pAll->n);
  119125. testcase( z==0 );
  119126. sqlite3NestedParse(pParse,
  119127. "INSERT INTO %Q.%s VALUES('trigger',%Q,%Q,0,'CREATE TRIGGER %q')",
  119128. db->aDb[iDb].zDbSName, MASTER_NAME, zName,
  119129. pTrig->table, z);
  119130. sqlite3DbFree(db, z);
  119131. sqlite3ChangeCookie(pParse, iDb);
  119132. sqlite3VdbeAddParseSchemaOp(v, iDb,
  119133. sqlite3MPrintf(db, "type='trigger' AND name='%q'", zName));
  119134. }
  119135. if( db->init.busy ){
  119136. Trigger *pLink = pTrig;
  119137. Hash *pHash = &db->aDb[iDb].pSchema->trigHash;
  119138. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  119139. pTrig = sqlite3HashInsert(pHash, zName, pTrig);
  119140. if( pTrig ){
  119141. sqlite3OomFault(db);
  119142. }else if( pLink->pSchema==pLink->pTabSchema ){
  119143. Table *pTab;
  119144. pTab = sqlite3HashFind(&pLink->pTabSchema->tblHash, pLink->table);
  119145. assert( pTab!=0 );
  119146. pLink->pNext = pTab->pTrigger;
  119147. pTab->pTrigger = pLink;
  119148. }
  119149. }
  119150. triggerfinish_cleanup:
  119151. sqlite3DeleteTrigger(db, pTrig);
  119152. assert( !pParse->pNewTrigger );
  119153. sqlite3DeleteTriggerStep(db, pStepList);
  119154. }
  119155. /*
  119156. ** Duplicate a range of text from an SQL statement, then convert all
  119157. ** whitespace characters into ordinary space characters.
  119158. */
  119159. static char *triggerSpanDup(sqlite3 *db, const char *zStart, const char *zEnd){
  119160. char *z = sqlite3DbSpanDup(db, zStart, zEnd);
  119161. int i;
  119162. if( z ) for(i=0; z[i]; i++) if( sqlite3Isspace(z[i]) ) z[i] = ' ';
  119163. return z;
  119164. }
  119165. /*
  119166. ** Turn a SELECT statement (that the pSelect parameter points to) into
  119167. ** a trigger step. Return a pointer to a TriggerStep structure.
  119168. **
  119169. ** The parser calls this routine when it finds a SELECT statement in
  119170. ** body of a TRIGGER.
  119171. */
  119172. SQLITE_PRIVATE TriggerStep *sqlite3TriggerSelectStep(
  119173. sqlite3 *db, /* Database connection */
  119174. Select *pSelect, /* The SELECT statement */
  119175. const char *zStart, /* Start of SQL text */
  119176. const char *zEnd /* End of SQL text */
  119177. ){
  119178. TriggerStep *pTriggerStep = sqlite3DbMallocZero(db, sizeof(TriggerStep));
  119179. if( pTriggerStep==0 ) {
  119180. sqlite3SelectDelete(db, pSelect);
  119181. return 0;
  119182. }
  119183. pTriggerStep->op = TK_SELECT;
  119184. pTriggerStep->pSelect = pSelect;
  119185. pTriggerStep->orconf = OE_Default;
  119186. pTriggerStep->zSpan = triggerSpanDup(db, zStart, zEnd);
  119187. return pTriggerStep;
  119188. }
  119189. /*
  119190. ** Allocate space to hold a new trigger step. The allocated space
  119191. ** holds both the TriggerStep object and the TriggerStep.target.z string.
  119192. **
  119193. ** If an OOM error occurs, NULL is returned and db->mallocFailed is set.
  119194. */
  119195. static TriggerStep *triggerStepAllocate(
  119196. sqlite3 *db, /* Database connection */
  119197. u8 op, /* Trigger opcode */
  119198. Token *pName, /* The target name */
  119199. const char *zStart, /* Start of SQL text */
  119200. const char *zEnd /* End of SQL text */
  119201. ){
  119202. TriggerStep *pTriggerStep;
  119203. pTriggerStep = sqlite3DbMallocZero(db, sizeof(TriggerStep) + pName->n + 1);
  119204. if( pTriggerStep ){
  119205. char *z = (char*)&pTriggerStep[1];
  119206. memcpy(z, pName->z, pName->n);
  119207. sqlite3Dequote(z);
  119208. pTriggerStep->zTarget = z;
  119209. pTriggerStep->op = op;
  119210. pTriggerStep->zSpan = triggerSpanDup(db, zStart, zEnd);
  119211. }
  119212. return pTriggerStep;
  119213. }
  119214. /*
  119215. ** Build a trigger step out of an INSERT statement. Return a pointer
  119216. ** to the new trigger step.
  119217. **
  119218. ** The parser calls this routine when it sees an INSERT inside the
  119219. ** body of a trigger.
  119220. */
  119221. SQLITE_PRIVATE TriggerStep *sqlite3TriggerInsertStep(
  119222. sqlite3 *db, /* The database connection */
  119223. Token *pTableName, /* Name of the table into which we insert */
  119224. IdList *pColumn, /* List of columns in pTableName to insert into */
  119225. Select *pSelect, /* A SELECT statement that supplies values */
  119226. u8 orconf, /* The conflict algorithm (OE_Abort, OE_Replace, etc.) */
  119227. const char *zStart, /* Start of SQL text */
  119228. const char *zEnd /* End of SQL text */
  119229. ){
  119230. TriggerStep *pTriggerStep;
  119231. assert(pSelect != 0 || db->mallocFailed);
  119232. pTriggerStep = triggerStepAllocate(db, TK_INSERT, pTableName, zStart, zEnd);
  119233. if( pTriggerStep ){
  119234. pTriggerStep->pSelect = sqlite3SelectDup(db, pSelect, EXPRDUP_REDUCE);
  119235. pTriggerStep->pIdList = pColumn;
  119236. pTriggerStep->orconf = orconf;
  119237. }else{
  119238. sqlite3IdListDelete(db, pColumn);
  119239. }
  119240. sqlite3SelectDelete(db, pSelect);
  119241. return pTriggerStep;
  119242. }
  119243. /*
  119244. ** Construct a trigger step that implements an UPDATE statement and return
  119245. ** a pointer to that trigger step. The parser calls this routine when it
  119246. ** sees an UPDATE statement inside the body of a CREATE TRIGGER.
  119247. */
  119248. SQLITE_PRIVATE TriggerStep *sqlite3TriggerUpdateStep(
  119249. sqlite3 *db, /* The database connection */
  119250. Token *pTableName, /* Name of the table to be updated */
  119251. ExprList *pEList, /* The SET clause: list of column and new values */
  119252. Expr *pWhere, /* The WHERE clause */
  119253. u8 orconf, /* The conflict algorithm. (OE_Abort, OE_Ignore, etc) */
  119254. const char *zStart, /* Start of SQL text */
  119255. const char *zEnd /* End of SQL text */
  119256. ){
  119257. TriggerStep *pTriggerStep;
  119258. pTriggerStep = triggerStepAllocate(db, TK_UPDATE, pTableName, zStart, zEnd);
  119259. if( pTriggerStep ){
  119260. pTriggerStep->pExprList = sqlite3ExprListDup(db, pEList, EXPRDUP_REDUCE);
  119261. pTriggerStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
  119262. pTriggerStep->orconf = orconf;
  119263. }
  119264. sqlite3ExprListDelete(db, pEList);
  119265. sqlite3ExprDelete(db, pWhere);
  119266. return pTriggerStep;
  119267. }
  119268. /*
  119269. ** Construct a trigger step that implements a DELETE statement and return
  119270. ** a pointer to that trigger step. The parser calls this routine when it
  119271. ** sees a DELETE statement inside the body of a CREATE TRIGGER.
  119272. */
  119273. SQLITE_PRIVATE TriggerStep *sqlite3TriggerDeleteStep(
  119274. sqlite3 *db, /* Database connection */
  119275. Token *pTableName, /* The table from which rows are deleted */
  119276. Expr *pWhere, /* The WHERE clause */
  119277. const char *zStart, /* Start of SQL text */
  119278. const char *zEnd /* End of SQL text */
  119279. ){
  119280. TriggerStep *pTriggerStep;
  119281. pTriggerStep = triggerStepAllocate(db, TK_DELETE, pTableName, zStart, zEnd);
  119282. if( pTriggerStep ){
  119283. pTriggerStep->pWhere = sqlite3ExprDup(db, pWhere, EXPRDUP_REDUCE);
  119284. pTriggerStep->orconf = OE_Default;
  119285. }
  119286. sqlite3ExprDelete(db, pWhere);
  119287. return pTriggerStep;
  119288. }
  119289. /*
  119290. ** Recursively delete a Trigger structure
  119291. */
  119292. SQLITE_PRIVATE void sqlite3DeleteTrigger(sqlite3 *db, Trigger *pTrigger){
  119293. if( pTrigger==0 ) return;
  119294. sqlite3DeleteTriggerStep(db, pTrigger->step_list);
  119295. sqlite3DbFree(db, pTrigger->zName);
  119296. sqlite3DbFree(db, pTrigger->table);
  119297. sqlite3ExprDelete(db, pTrigger->pWhen);
  119298. sqlite3IdListDelete(db, pTrigger->pColumns);
  119299. sqlite3DbFree(db, pTrigger);
  119300. }
  119301. /*
  119302. ** This function is called to drop a trigger from the database schema.
  119303. **
  119304. ** This may be called directly from the parser and therefore identifies
  119305. ** the trigger by name. The sqlite3DropTriggerPtr() routine does the
  119306. ** same job as this routine except it takes a pointer to the trigger
  119307. ** instead of the trigger name.
  119308. **/
  119309. SQLITE_PRIVATE void sqlite3DropTrigger(Parse *pParse, SrcList *pName, int noErr){
  119310. Trigger *pTrigger = 0;
  119311. int i;
  119312. const char *zDb;
  119313. const char *zName;
  119314. sqlite3 *db = pParse->db;
  119315. if( db->mallocFailed ) goto drop_trigger_cleanup;
  119316. if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
  119317. goto drop_trigger_cleanup;
  119318. }
  119319. assert( pName->nSrc==1 );
  119320. zDb = pName->a[0].zDatabase;
  119321. zName = pName->a[0].zName;
  119322. assert( zDb!=0 || sqlite3BtreeHoldsAllMutexes(db) );
  119323. for(i=OMIT_TEMPDB; i<db->nDb; i++){
  119324. int j = (i<2) ? i^1 : i; /* Search TEMP before MAIN */
  119325. if( zDb && sqlite3StrICmp(db->aDb[j].zDbSName, zDb) ) continue;
  119326. assert( sqlite3SchemaMutexHeld(db, j, 0) );
  119327. pTrigger = sqlite3HashFind(&(db->aDb[j].pSchema->trigHash), zName);
  119328. if( pTrigger ) break;
  119329. }
  119330. if( !pTrigger ){
  119331. if( !noErr ){
  119332. sqlite3ErrorMsg(pParse, "no such trigger: %S", pName, 0);
  119333. }else{
  119334. sqlite3CodeVerifyNamedSchema(pParse, zDb);
  119335. }
  119336. pParse->checkSchema = 1;
  119337. goto drop_trigger_cleanup;
  119338. }
  119339. sqlite3DropTriggerPtr(pParse, pTrigger);
  119340. drop_trigger_cleanup:
  119341. sqlite3SrcListDelete(db, pName);
  119342. }
  119343. /*
  119344. ** Return a pointer to the Table structure for the table that a trigger
  119345. ** is set on.
  119346. */
  119347. static Table *tableOfTrigger(Trigger *pTrigger){
  119348. return sqlite3HashFind(&pTrigger->pTabSchema->tblHash, pTrigger->table);
  119349. }
  119350. /*
  119351. ** Drop a trigger given a pointer to that trigger.
  119352. */
  119353. SQLITE_PRIVATE void sqlite3DropTriggerPtr(Parse *pParse, Trigger *pTrigger){
  119354. Table *pTable;
  119355. Vdbe *v;
  119356. sqlite3 *db = pParse->db;
  119357. int iDb;
  119358. iDb = sqlite3SchemaToIndex(pParse->db, pTrigger->pSchema);
  119359. assert( iDb>=0 && iDb<db->nDb );
  119360. pTable = tableOfTrigger(pTrigger);
  119361. assert( pTable );
  119362. assert( pTable->pSchema==pTrigger->pSchema || iDb==1 );
  119363. #ifndef SQLITE_OMIT_AUTHORIZATION
  119364. {
  119365. int code = SQLITE_DROP_TRIGGER;
  119366. const char *zDb = db->aDb[iDb].zDbSName;
  119367. const char *zTab = SCHEMA_TABLE(iDb);
  119368. if( iDb==1 ) code = SQLITE_DROP_TEMP_TRIGGER;
  119369. if( sqlite3AuthCheck(pParse, code, pTrigger->zName, pTable->zName, zDb) ||
  119370. sqlite3AuthCheck(pParse, SQLITE_DELETE, zTab, 0, zDb) ){
  119371. return;
  119372. }
  119373. }
  119374. #endif
  119375. /* Generate code to destroy the database record of the trigger.
  119376. */
  119377. assert( pTable!=0 );
  119378. if( (v = sqlite3GetVdbe(pParse))!=0 ){
  119379. sqlite3NestedParse(pParse,
  119380. "DELETE FROM %Q.%s WHERE name=%Q AND type='trigger'",
  119381. db->aDb[iDb].zDbSName, MASTER_NAME, pTrigger->zName
  119382. );
  119383. sqlite3ChangeCookie(pParse, iDb);
  119384. sqlite3VdbeAddOp4(v, OP_DropTrigger, iDb, 0, 0, pTrigger->zName, 0);
  119385. }
  119386. }
  119387. /*
  119388. ** Remove a trigger from the hash tables of the sqlite* pointer.
  119389. */
  119390. SQLITE_PRIVATE void sqlite3UnlinkAndDeleteTrigger(sqlite3 *db, int iDb, const char *zName){
  119391. Trigger *pTrigger;
  119392. Hash *pHash;
  119393. assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
  119394. pHash = &(db->aDb[iDb].pSchema->trigHash);
  119395. pTrigger = sqlite3HashInsert(pHash, zName, 0);
  119396. if( ALWAYS(pTrigger) ){
  119397. if( pTrigger->pSchema==pTrigger->pTabSchema ){
  119398. Table *pTab = tableOfTrigger(pTrigger);
  119399. Trigger **pp;
  119400. for(pp=&pTab->pTrigger; *pp!=pTrigger; pp=&((*pp)->pNext));
  119401. *pp = (*pp)->pNext;
  119402. }
  119403. sqlite3DeleteTrigger(db, pTrigger);
  119404. db->mDbFlags |= DBFLAG_SchemaChange;
  119405. }
  119406. }
  119407. /*
  119408. ** pEList is the SET clause of an UPDATE statement. Each entry
  119409. ** in pEList is of the format <id>=<expr>. If any of the entries
  119410. ** in pEList have an <id> which matches an identifier in pIdList,
  119411. ** then return TRUE. If pIdList==NULL, then it is considered a
  119412. ** wildcard that matches anything. Likewise if pEList==NULL then
  119413. ** it matches anything so always return true. Return false only
  119414. ** if there is no match.
  119415. */
  119416. static int checkColumnOverlap(IdList *pIdList, ExprList *pEList){
  119417. int e;
  119418. if( pIdList==0 || NEVER(pEList==0) ) return 1;
  119419. for(e=0; e<pEList->nExpr; e++){
  119420. if( sqlite3IdListIndex(pIdList, pEList->a[e].zName)>=0 ) return 1;
  119421. }
  119422. return 0;
  119423. }
  119424. /*
  119425. ** Return a list of all triggers on table pTab if there exists at least
  119426. ** one trigger that must be fired when an operation of type 'op' is
  119427. ** performed on the table, and, if that operation is an UPDATE, if at
  119428. ** least one of the columns in pChanges is being modified.
  119429. */
  119430. SQLITE_PRIVATE Trigger *sqlite3TriggersExist(
  119431. Parse *pParse, /* Parse context */
  119432. Table *pTab, /* The table the contains the triggers */
  119433. int op, /* one of TK_DELETE, TK_INSERT, TK_UPDATE */
  119434. ExprList *pChanges, /* Columns that change in an UPDATE statement */
  119435. int *pMask /* OUT: Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
  119436. ){
  119437. int mask = 0;
  119438. Trigger *pList = 0;
  119439. Trigger *p;
  119440. if( (pParse->db->flags & SQLITE_EnableTrigger)!=0 ){
  119441. pList = sqlite3TriggerList(pParse, pTab);
  119442. }
  119443. assert( pList==0 || IsVirtual(pTab)==0 );
  119444. for(p=pList; p; p=p->pNext){
  119445. if( p->op==op && checkColumnOverlap(p->pColumns, pChanges) ){
  119446. mask |= p->tr_tm;
  119447. }
  119448. }
  119449. if( pMask ){
  119450. *pMask = mask;
  119451. }
  119452. return (mask ? pList : 0);
  119453. }
  119454. /*
  119455. ** Convert the pStep->zTarget string into a SrcList and return a pointer
  119456. ** to that SrcList.
  119457. **
  119458. ** This routine adds a specific database name, if needed, to the target when
  119459. ** forming the SrcList. This prevents a trigger in one database from
  119460. ** referring to a target in another database. An exception is when the
  119461. ** trigger is in TEMP in which case it can refer to any other database it
  119462. ** wants.
  119463. */
  119464. static SrcList *targetSrcList(
  119465. Parse *pParse, /* The parsing context */
  119466. TriggerStep *pStep /* The trigger containing the target token */
  119467. ){
  119468. sqlite3 *db = pParse->db;
  119469. int iDb; /* Index of the database to use */
  119470. SrcList *pSrc; /* SrcList to be returned */
  119471. pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
  119472. if( pSrc ){
  119473. assert( pSrc->nSrc>0 );
  119474. pSrc->a[pSrc->nSrc-1].zName = sqlite3DbStrDup(db, pStep->zTarget);
  119475. iDb = sqlite3SchemaToIndex(db, pStep->pTrig->pSchema);
  119476. if( iDb==0 || iDb>=2 ){
  119477. const char *zDb;
  119478. assert( iDb<db->nDb );
  119479. zDb = db->aDb[iDb].zDbSName;
  119480. pSrc->a[pSrc->nSrc-1].zDatabase = sqlite3DbStrDup(db, zDb);
  119481. }
  119482. }
  119483. return pSrc;
  119484. }
  119485. /*
  119486. ** Generate VDBE code for the statements inside the body of a single
  119487. ** trigger.
  119488. */
  119489. static int codeTriggerProgram(
  119490. Parse *pParse, /* The parser context */
  119491. TriggerStep *pStepList, /* List of statements inside the trigger body */
  119492. int orconf /* Conflict algorithm. (OE_Abort, etc) */
  119493. ){
  119494. TriggerStep *pStep;
  119495. Vdbe *v = pParse->pVdbe;
  119496. sqlite3 *db = pParse->db;
  119497. assert( pParse->pTriggerTab && pParse->pToplevel );
  119498. assert( pStepList );
  119499. assert( v!=0 );
  119500. for(pStep=pStepList; pStep; pStep=pStep->pNext){
  119501. /* Figure out the ON CONFLICT policy that will be used for this step
  119502. ** of the trigger program. If the statement that caused this trigger
  119503. ** to fire had an explicit ON CONFLICT, then use it. Otherwise, use
  119504. ** the ON CONFLICT policy that was specified as part of the trigger
  119505. ** step statement. Example:
  119506. **
  119507. ** CREATE TRIGGER AFTER INSERT ON t1 BEGIN;
  119508. ** INSERT OR REPLACE INTO t2 VALUES(new.a, new.b);
  119509. ** END;
  119510. **
  119511. ** INSERT INTO t1 ... ; -- insert into t2 uses REPLACE policy
  119512. ** INSERT OR IGNORE INTO t1 ... ; -- insert into t2 uses IGNORE policy
  119513. */
  119514. pParse->eOrconf = (orconf==OE_Default)?pStep->orconf:(u8)orconf;
  119515. assert( pParse->okConstFactor==0 );
  119516. #ifndef SQLITE_OMIT_TRACE
  119517. if( pStep->zSpan ){
  119518. sqlite3VdbeAddOp4(v, OP_Trace, 0x7fffffff, 1, 0,
  119519. sqlite3MPrintf(db, "-- %s", pStep->zSpan),
  119520. P4_DYNAMIC);
  119521. }
  119522. #endif
  119523. switch( pStep->op ){
  119524. case TK_UPDATE: {
  119525. sqlite3Update(pParse,
  119526. targetSrcList(pParse, pStep),
  119527. sqlite3ExprListDup(db, pStep->pExprList, 0),
  119528. sqlite3ExprDup(db, pStep->pWhere, 0),
  119529. pParse->eOrconf, 0, 0
  119530. );
  119531. break;
  119532. }
  119533. case TK_INSERT: {
  119534. sqlite3Insert(pParse,
  119535. targetSrcList(pParse, pStep),
  119536. sqlite3SelectDup(db, pStep->pSelect, 0),
  119537. sqlite3IdListDup(db, pStep->pIdList),
  119538. pParse->eOrconf
  119539. );
  119540. break;
  119541. }
  119542. case TK_DELETE: {
  119543. sqlite3DeleteFrom(pParse,
  119544. targetSrcList(pParse, pStep),
  119545. sqlite3ExprDup(db, pStep->pWhere, 0), 0, 0
  119546. );
  119547. break;
  119548. }
  119549. default: assert( pStep->op==TK_SELECT ); {
  119550. SelectDest sDest;
  119551. Select *pSelect = sqlite3SelectDup(db, pStep->pSelect, 0);
  119552. sqlite3SelectDestInit(&sDest, SRT_Discard, 0);
  119553. sqlite3Select(pParse, pSelect, &sDest);
  119554. sqlite3SelectDelete(db, pSelect);
  119555. break;
  119556. }
  119557. }
  119558. if( pStep->op!=TK_SELECT ){
  119559. sqlite3VdbeAddOp0(v, OP_ResetCount);
  119560. }
  119561. }
  119562. return 0;
  119563. }
  119564. #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
  119565. /*
  119566. ** This function is used to add VdbeComment() annotations to a VDBE
  119567. ** program. It is not used in production code, only for debugging.
  119568. */
  119569. static const char *onErrorText(int onError){
  119570. switch( onError ){
  119571. case OE_Abort: return "abort";
  119572. case OE_Rollback: return "rollback";
  119573. case OE_Fail: return "fail";
  119574. case OE_Replace: return "replace";
  119575. case OE_Ignore: return "ignore";
  119576. case OE_Default: return "default";
  119577. }
  119578. return "n/a";
  119579. }
  119580. #endif
  119581. /*
  119582. ** Parse context structure pFrom has just been used to create a sub-vdbe
  119583. ** (trigger program). If an error has occurred, transfer error information
  119584. ** from pFrom to pTo.
  119585. */
  119586. static void transferParseError(Parse *pTo, Parse *pFrom){
  119587. assert( pFrom->zErrMsg==0 || pFrom->nErr );
  119588. assert( pTo->zErrMsg==0 || pTo->nErr );
  119589. if( pTo->nErr==0 ){
  119590. pTo->zErrMsg = pFrom->zErrMsg;
  119591. pTo->nErr = pFrom->nErr;
  119592. pTo->rc = pFrom->rc;
  119593. }else{
  119594. sqlite3DbFree(pFrom->db, pFrom->zErrMsg);
  119595. }
  119596. }
  119597. /*
  119598. ** Create and populate a new TriggerPrg object with a sub-program
  119599. ** implementing trigger pTrigger with ON CONFLICT policy orconf.
  119600. */
  119601. static TriggerPrg *codeRowTrigger(
  119602. Parse *pParse, /* Current parse context */
  119603. Trigger *pTrigger, /* Trigger to code */
  119604. Table *pTab, /* The table pTrigger is attached to */
  119605. int orconf /* ON CONFLICT policy to code trigger program with */
  119606. ){
  119607. Parse *pTop = sqlite3ParseToplevel(pParse);
  119608. sqlite3 *db = pParse->db; /* Database handle */
  119609. TriggerPrg *pPrg; /* Value to return */
  119610. Expr *pWhen = 0; /* Duplicate of trigger WHEN expression */
  119611. Vdbe *v; /* Temporary VM */
  119612. NameContext sNC; /* Name context for sub-vdbe */
  119613. SubProgram *pProgram = 0; /* Sub-vdbe for trigger program */
  119614. Parse *pSubParse; /* Parse context for sub-vdbe */
  119615. int iEndTrigger = 0; /* Label to jump to if WHEN is false */
  119616. assert( pTrigger->zName==0 || pTab==tableOfTrigger(pTrigger) );
  119617. assert( pTop->pVdbe );
  119618. /* Allocate the TriggerPrg and SubProgram objects. To ensure that they
  119619. ** are freed if an error occurs, link them into the Parse.pTriggerPrg
  119620. ** list of the top-level Parse object sooner rather than later. */
  119621. pPrg = sqlite3DbMallocZero(db, sizeof(TriggerPrg));
  119622. if( !pPrg ) return 0;
  119623. pPrg->pNext = pTop->pTriggerPrg;
  119624. pTop->pTriggerPrg = pPrg;
  119625. pPrg->pProgram = pProgram = sqlite3DbMallocZero(db, sizeof(SubProgram));
  119626. if( !pProgram ) return 0;
  119627. sqlite3VdbeLinkSubProgram(pTop->pVdbe, pProgram);
  119628. pPrg->pTrigger = pTrigger;
  119629. pPrg->orconf = orconf;
  119630. pPrg->aColmask[0] = 0xffffffff;
  119631. pPrg->aColmask[1] = 0xffffffff;
  119632. /* Allocate and populate a new Parse context to use for coding the
  119633. ** trigger sub-program. */
  119634. pSubParse = sqlite3StackAllocZero(db, sizeof(Parse));
  119635. if( !pSubParse ) return 0;
  119636. memset(&sNC, 0, sizeof(sNC));
  119637. sNC.pParse = pSubParse;
  119638. pSubParse->db = db;
  119639. pSubParse->pTriggerTab = pTab;
  119640. pSubParse->pToplevel = pTop;
  119641. pSubParse->zAuthContext = pTrigger->zName;
  119642. pSubParse->eTriggerOp = pTrigger->op;
  119643. pSubParse->nQueryLoop = pParse->nQueryLoop;
  119644. v = sqlite3GetVdbe(pSubParse);
  119645. if( v ){
  119646. VdbeComment((v, "Start: %s.%s (%s %s%s%s ON %s)",
  119647. pTrigger->zName, onErrorText(orconf),
  119648. (pTrigger->tr_tm==TRIGGER_BEFORE ? "BEFORE" : "AFTER"),
  119649. (pTrigger->op==TK_UPDATE ? "UPDATE" : ""),
  119650. (pTrigger->op==TK_INSERT ? "INSERT" : ""),
  119651. (pTrigger->op==TK_DELETE ? "DELETE" : ""),
  119652. pTab->zName
  119653. ));
  119654. #ifndef SQLITE_OMIT_TRACE
  119655. if( pTrigger->zName ){
  119656. sqlite3VdbeChangeP4(v, -1,
  119657. sqlite3MPrintf(db, "-- TRIGGER %s", pTrigger->zName), P4_DYNAMIC
  119658. );
  119659. }
  119660. #endif
  119661. /* If one was specified, code the WHEN clause. If it evaluates to false
  119662. ** (or NULL) the sub-vdbe is immediately halted by jumping to the
  119663. ** OP_Halt inserted at the end of the program. */
  119664. if( pTrigger->pWhen ){
  119665. pWhen = sqlite3ExprDup(db, pTrigger->pWhen, 0);
  119666. if( SQLITE_OK==sqlite3ResolveExprNames(&sNC, pWhen)
  119667. && db->mallocFailed==0
  119668. ){
  119669. iEndTrigger = sqlite3VdbeMakeLabel(v);
  119670. sqlite3ExprIfFalse(pSubParse, pWhen, iEndTrigger, SQLITE_JUMPIFNULL);
  119671. }
  119672. sqlite3ExprDelete(db, pWhen);
  119673. }
  119674. /* Code the trigger program into the sub-vdbe. */
  119675. codeTriggerProgram(pSubParse, pTrigger->step_list, orconf);
  119676. /* Insert an OP_Halt at the end of the sub-program. */
  119677. if( iEndTrigger ){
  119678. sqlite3VdbeResolveLabel(v, iEndTrigger);
  119679. }
  119680. sqlite3VdbeAddOp0(v, OP_Halt);
  119681. VdbeComment((v, "End: %s.%s", pTrigger->zName, onErrorText(orconf)));
  119682. transferParseError(pParse, pSubParse);
  119683. if( db->mallocFailed==0 && pParse->nErr==0 ){
  119684. pProgram->aOp = sqlite3VdbeTakeOpArray(v, &pProgram->nOp, &pTop->nMaxArg);
  119685. }
  119686. pProgram->nMem = pSubParse->nMem;
  119687. pProgram->nCsr = pSubParse->nTab;
  119688. pProgram->token = (void *)pTrigger;
  119689. pPrg->aColmask[0] = pSubParse->oldmask;
  119690. pPrg->aColmask[1] = pSubParse->newmask;
  119691. sqlite3VdbeDelete(v);
  119692. }
  119693. assert( !pSubParse->pAinc && !pSubParse->pZombieTab );
  119694. assert( !pSubParse->pTriggerPrg && !pSubParse->nMaxArg );
  119695. sqlite3ParserReset(pSubParse);
  119696. sqlite3StackFree(db, pSubParse);
  119697. return pPrg;
  119698. }
  119699. /*
  119700. ** Return a pointer to a TriggerPrg object containing the sub-program for
  119701. ** trigger pTrigger with default ON CONFLICT algorithm orconf. If no such
  119702. ** TriggerPrg object exists, a new object is allocated and populated before
  119703. ** being returned.
  119704. */
  119705. static TriggerPrg *getRowTrigger(
  119706. Parse *pParse, /* Current parse context */
  119707. Trigger *pTrigger, /* Trigger to code */
  119708. Table *pTab, /* The table trigger pTrigger is attached to */
  119709. int orconf /* ON CONFLICT algorithm. */
  119710. ){
  119711. Parse *pRoot = sqlite3ParseToplevel(pParse);
  119712. TriggerPrg *pPrg;
  119713. assert( pTrigger->zName==0 || pTab==tableOfTrigger(pTrigger) );
  119714. /* It may be that this trigger has already been coded (or is in the
  119715. ** process of being coded). If this is the case, then an entry with
  119716. ** a matching TriggerPrg.pTrigger field will be present somewhere
  119717. ** in the Parse.pTriggerPrg list. Search for such an entry. */
  119718. for(pPrg=pRoot->pTriggerPrg;
  119719. pPrg && (pPrg->pTrigger!=pTrigger || pPrg->orconf!=orconf);
  119720. pPrg=pPrg->pNext
  119721. );
  119722. /* If an existing TriggerPrg could not be located, create a new one. */
  119723. if( !pPrg ){
  119724. pPrg = codeRowTrigger(pParse, pTrigger, pTab, orconf);
  119725. }
  119726. return pPrg;
  119727. }
  119728. /*
  119729. ** Generate code for the trigger program associated with trigger p on
  119730. ** table pTab. The reg, orconf and ignoreJump parameters passed to this
  119731. ** function are the same as those described in the header function for
  119732. ** sqlite3CodeRowTrigger()
  119733. */
  119734. SQLITE_PRIVATE void sqlite3CodeRowTriggerDirect(
  119735. Parse *pParse, /* Parse context */
  119736. Trigger *p, /* Trigger to code */
  119737. Table *pTab, /* The table to code triggers from */
  119738. int reg, /* Reg array containing OLD.* and NEW.* values */
  119739. int orconf, /* ON CONFLICT policy */
  119740. int ignoreJump /* Instruction to jump to for RAISE(IGNORE) */
  119741. ){
  119742. Vdbe *v = sqlite3GetVdbe(pParse); /* Main VM */
  119743. TriggerPrg *pPrg;
  119744. pPrg = getRowTrigger(pParse, p, pTab, orconf);
  119745. assert( pPrg || pParse->nErr || pParse->db->mallocFailed );
  119746. /* Code the OP_Program opcode in the parent VDBE. P4 of the OP_Program
  119747. ** is a pointer to the sub-vdbe containing the trigger program. */
  119748. if( pPrg ){
  119749. int bRecursive = (p->zName && 0==(pParse->db->flags&SQLITE_RecTriggers));
  119750. sqlite3VdbeAddOp4(v, OP_Program, reg, ignoreJump, ++pParse->nMem,
  119751. (const char *)pPrg->pProgram, P4_SUBPROGRAM);
  119752. VdbeComment(
  119753. (v, "Call: %s.%s", (p->zName?p->zName:"fkey"), onErrorText(orconf)));
  119754. /* Set the P5 operand of the OP_Program instruction to non-zero if
  119755. ** recursive invocation of this trigger program is disallowed. Recursive
  119756. ** invocation is disallowed if (a) the sub-program is really a trigger,
  119757. ** not a foreign key action, and (b) the flag to enable recursive triggers
  119758. ** is clear. */
  119759. sqlite3VdbeChangeP5(v, (u8)bRecursive);
  119760. }
  119761. }
  119762. /*
  119763. ** This is called to code the required FOR EACH ROW triggers for an operation
  119764. ** on table pTab. The operation to code triggers for (INSERT, UPDATE or DELETE)
  119765. ** is given by the op parameter. The tr_tm parameter determines whether the
  119766. ** BEFORE or AFTER triggers are coded. If the operation is an UPDATE, then
  119767. ** parameter pChanges is passed the list of columns being modified.
  119768. **
  119769. ** If there are no triggers that fire at the specified time for the specified
  119770. ** operation on pTab, this function is a no-op.
  119771. **
  119772. ** The reg argument is the address of the first in an array of registers
  119773. ** that contain the values substituted for the new.* and old.* references
  119774. ** in the trigger program. If N is the number of columns in table pTab
  119775. ** (a copy of pTab->nCol), then registers are populated as follows:
  119776. **
  119777. ** Register Contains
  119778. ** ------------------------------------------------------
  119779. ** reg+0 OLD.rowid
  119780. ** reg+1 OLD.* value of left-most column of pTab
  119781. ** ... ...
  119782. ** reg+N OLD.* value of right-most column of pTab
  119783. ** reg+N+1 NEW.rowid
  119784. ** reg+N+2 OLD.* value of left-most column of pTab
  119785. ** ... ...
  119786. ** reg+N+N+1 NEW.* value of right-most column of pTab
  119787. **
  119788. ** For ON DELETE triggers, the registers containing the NEW.* values will
  119789. ** never be accessed by the trigger program, so they are not allocated or
  119790. ** populated by the caller (there is no data to populate them with anyway).
  119791. ** Similarly, for ON INSERT triggers the values stored in the OLD.* registers
  119792. ** are never accessed, and so are not allocated by the caller. So, for an
  119793. ** ON INSERT trigger, the value passed to this function as parameter reg
  119794. ** is not a readable register, although registers (reg+N) through
  119795. ** (reg+N+N+1) are.
  119796. **
  119797. ** Parameter orconf is the default conflict resolution algorithm for the
  119798. ** trigger program to use (REPLACE, IGNORE etc.). Parameter ignoreJump
  119799. ** is the instruction that control should jump to if a trigger program
  119800. ** raises an IGNORE exception.
  119801. */
  119802. SQLITE_PRIVATE void sqlite3CodeRowTrigger(
  119803. Parse *pParse, /* Parse context */
  119804. Trigger *pTrigger, /* List of triggers on table pTab */
  119805. int op, /* One of TK_UPDATE, TK_INSERT, TK_DELETE */
  119806. ExprList *pChanges, /* Changes list for any UPDATE OF triggers */
  119807. int tr_tm, /* One of TRIGGER_BEFORE, TRIGGER_AFTER */
  119808. Table *pTab, /* The table to code triggers from */
  119809. int reg, /* The first in an array of registers (see above) */
  119810. int orconf, /* ON CONFLICT policy */
  119811. int ignoreJump /* Instruction to jump to for RAISE(IGNORE) */
  119812. ){
  119813. Trigger *p; /* Used to iterate through pTrigger list */
  119814. assert( op==TK_UPDATE || op==TK_INSERT || op==TK_DELETE );
  119815. assert( tr_tm==TRIGGER_BEFORE || tr_tm==TRIGGER_AFTER );
  119816. assert( (op==TK_UPDATE)==(pChanges!=0) );
  119817. for(p=pTrigger; p; p=p->pNext){
  119818. /* Sanity checking: The schema for the trigger and for the table are
  119819. ** always defined. The trigger must be in the same schema as the table
  119820. ** or else it must be a TEMP trigger. */
  119821. assert( p->pSchema!=0 );
  119822. assert( p->pTabSchema!=0 );
  119823. assert( p->pSchema==p->pTabSchema
  119824. || p->pSchema==pParse->db->aDb[1].pSchema );
  119825. /* Determine whether we should code this trigger */
  119826. if( p->op==op
  119827. && p->tr_tm==tr_tm
  119828. && checkColumnOverlap(p->pColumns, pChanges)
  119829. ){
  119830. sqlite3CodeRowTriggerDirect(pParse, p, pTab, reg, orconf, ignoreJump);
  119831. }
  119832. }
  119833. }
  119834. /*
  119835. ** Triggers may access values stored in the old.* or new.* pseudo-table.
  119836. ** This function returns a 32-bit bitmask indicating which columns of the
  119837. ** old.* or new.* tables actually are used by triggers. This information
  119838. ** may be used by the caller, for example, to avoid having to load the entire
  119839. ** old.* record into memory when executing an UPDATE or DELETE command.
  119840. **
  119841. ** Bit 0 of the returned mask is set if the left-most column of the
  119842. ** table may be accessed using an [old|new].<col> reference. Bit 1 is set if
  119843. ** the second leftmost column value is required, and so on. If there
  119844. ** are more than 32 columns in the table, and at least one of the columns
  119845. ** with an index greater than 32 may be accessed, 0xffffffff is returned.
  119846. **
  119847. ** It is not possible to determine if the old.rowid or new.rowid column is
  119848. ** accessed by triggers. The caller must always assume that it is.
  119849. **
  119850. ** Parameter isNew must be either 1 or 0. If it is 0, then the mask returned
  119851. ** applies to the old.* table. If 1, the new.* table.
  119852. **
  119853. ** Parameter tr_tm must be a mask with one or both of the TRIGGER_BEFORE
  119854. ** and TRIGGER_AFTER bits set. Values accessed by BEFORE triggers are only
  119855. ** included in the returned mask if the TRIGGER_BEFORE bit is set in the
  119856. ** tr_tm parameter. Similarly, values accessed by AFTER triggers are only
  119857. ** included in the returned mask if the TRIGGER_AFTER bit is set in tr_tm.
  119858. */
  119859. SQLITE_PRIVATE u32 sqlite3TriggerColmask(
  119860. Parse *pParse, /* Parse context */
  119861. Trigger *pTrigger, /* List of triggers on table pTab */
  119862. ExprList *pChanges, /* Changes list for any UPDATE OF triggers */
  119863. int isNew, /* 1 for new.* ref mask, 0 for old.* ref mask */
  119864. int tr_tm, /* Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
  119865. Table *pTab, /* The table to code triggers from */
  119866. int orconf /* Default ON CONFLICT policy for trigger steps */
  119867. ){
  119868. const int op = pChanges ? TK_UPDATE : TK_DELETE;
  119869. u32 mask = 0;
  119870. Trigger *p;
  119871. assert( isNew==1 || isNew==0 );
  119872. for(p=pTrigger; p; p=p->pNext){
  119873. if( p->op==op && (tr_tm&p->tr_tm)
  119874. && checkColumnOverlap(p->pColumns,pChanges)
  119875. ){
  119876. TriggerPrg *pPrg;
  119877. pPrg = getRowTrigger(pParse, p, pTab, orconf);
  119878. if( pPrg ){
  119879. mask |= pPrg->aColmask[isNew];
  119880. }
  119881. }
  119882. }
  119883. return mask;
  119884. }
  119885. #endif /* !defined(SQLITE_OMIT_TRIGGER) */
  119886. /************** End of trigger.c *********************************************/
  119887. /************** Begin file update.c ******************************************/
  119888. /*
  119889. ** 2001 September 15
  119890. **
  119891. ** The author disclaims copyright to this source code. In place of
  119892. ** a legal notice, here is a blessing:
  119893. **
  119894. ** May you do good and not evil.
  119895. ** May you find forgiveness for yourself and forgive others.
  119896. ** May you share freely, never taking more than you give.
  119897. **
  119898. *************************************************************************
  119899. ** This file contains C code routines that are called by the parser
  119900. ** to handle UPDATE statements.
  119901. */
  119902. /* #include "sqliteInt.h" */
  119903. #ifndef SQLITE_OMIT_VIRTUALTABLE
  119904. /* Forward declaration */
  119905. static void updateVirtualTable(
  119906. Parse *pParse, /* The parsing context */
  119907. SrcList *pSrc, /* The virtual table to be modified */
  119908. Table *pTab, /* The virtual table */
  119909. ExprList *pChanges, /* The columns to change in the UPDATE statement */
  119910. Expr *pRowidExpr, /* Expression used to recompute the rowid */
  119911. int *aXRef, /* Mapping from columns of pTab to entries in pChanges */
  119912. Expr *pWhere, /* WHERE clause of the UPDATE statement */
  119913. int onError /* ON CONFLICT strategy */
  119914. );
  119915. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  119916. /*
  119917. ** The most recently coded instruction was an OP_Column to retrieve the
  119918. ** i-th column of table pTab. This routine sets the P4 parameter of the
  119919. ** OP_Column to the default value, if any.
  119920. **
  119921. ** The default value of a column is specified by a DEFAULT clause in the
  119922. ** column definition. This was either supplied by the user when the table
  119923. ** was created, or added later to the table definition by an ALTER TABLE
  119924. ** command. If the latter, then the row-records in the table btree on disk
  119925. ** may not contain a value for the column and the default value, taken
  119926. ** from the P4 parameter of the OP_Column instruction, is returned instead.
  119927. ** If the former, then all row-records are guaranteed to include a value
  119928. ** for the column and the P4 value is not required.
  119929. **
  119930. ** Column definitions created by an ALTER TABLE command may only have
  119931. ** literal default values specified: a number, null or a string. (If a more
  119932. ** complicated default expression value was provided, it is evaluated
  119933. ** when the ALTER TABLE is executed and one of the literal values written
  119934. ** into the sqlite_master table.)
  119935. **
  119936. ** Therefore, the P4 parameter is only required if the default value for
  119937. ** the column is a literal number, string or null. The sqlite3ValueFromExpr()
  119938. ** function is capable of transforming these types of expressions into
  119939. ** sqlite3_value objects.
  119940. **
  119941. ** If parameter iReg is not negative, code an OP_RealAffinity instruction
  119942. ** on register iReg. This is used when an equivalent integer value is
  119943. ** stored in place of an 8-byte floating point value in order to save
  119944. ** space.
  119945. */
  119946. SQLITE_PRIVATE void sqlite3ColumnDefault(Vdbe *v, Table *pTab, int i, int iReg){
  119947. assert( pTab!=0 );
  119948. if( !pTab->pSelect ){
  119949. sqlite3_value *pValue = 0;
  119950. u8 enc = ENC(sqlite3VdbeDb(v));
  119951. Column *pCol = &pTab->aCol[i];
  119952. VdbeComment((v, "%s.%s", pTab->zName, pCol->zName));
  119953. assert( i<pTab->nCol );
  119954. sqlite3ValueFromExpr(sqlite3VdbeDb(v), pCol->pDflt, enc,
  119955. pCol->affinity, &pValue);
  119956. if( pValue ){
  119957. sqlite3VdbeAppendP4(v, pValue, P4_MEM);
  119958. }
  119959. }
  119960. #ifndef SQLITE_OMIT_FLOATING_POINT
  119961. if( pTab->aCol[i].affinity==SQLITE_AFF_REAL ){
  119962. sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
  119963. }
  119964. #endif
  119965. }
  119966. /*
  119967. ** Process an UPDATE statement.
  119968. **
  119969. ** UPDATE OR IGNORE table_wxyz SET a=b, c=d WHERE e<5 AND f NOT NULL;
  119970. ** \_______/ \________/ \______/ \________________/
  119971. * onError pTabList pChanges pWhere
  119972. */
  119973. SQLITE_PRIVATE void sqlite3Update(
  119974. Parse *pParse, /* The parser context */
  119975. SrcList *pTabList, /* The table in which we should change things */
  119976. ExprList *pChanges, /* Things to be changed */
  119977. Expr *pWhere, /* The WHERE clause. May be null */
  119978. int onError, /* How to handle constraint errors */
  119979. ExprList *pOrderBy, /* ORDER BY clause. May be null */
  119980. Expr *pLimit /* LIMIT clause. May be null */
  119981. ){
  119982. int i, j; /* Loop counters */
  119983. Table *pTab; /* The table to be updated */
  119984. int addrTop = 0; /* VDBE instruction address of the start of the loop */
  119985. WhereInfo *pWInfo; /* Information about the WHERE clause */
  119986. Vdbe *v; /* The virtual database engine */
  119987. Index *pIdx; /* For looping over indices */
  119988. Index *pPk; /* The PRIMARY KEY index for WITHOUT ROWID tables */
  119989. int nIdx; /* Number of indices that need updating */
  119990. int iBaseCur; /* Base cursor number */
  119991. int iDataCur; /* Cursor for the canonical data btree */
  119992. int iIdxCur; /* Cursor for the first index */
  119993. sqlite3 *db; /* The database structure */
  119994. int *aRegIdx = 0; /* First register in array assigned to each index */
  119995. int *aXRef = 0; /* aXRef[i] is the index in pChanges->a[] of the
  119996. ** an expression for the i-th column of the table.
  119997. ** aXRef[i]==-1 if the i-th column is not changed. */
  119998. u8 *aToOpen; /* 1 for tables and indices to be opened */
  119999. u8 chngPk; /* PRIMARY KEY changed in a WITHOUT ROWID table */
  120000. u8 chngRowid; /* Rowid changed in a normal table */
  120001. u8 chngKey; /* Either chngPk or chngRowid */
  120002. Expr *pRowidExpr = 0; /* Expression defining the new record number */
  120003. AuthContext sContext; /* The authorization context */
  120004. NameContext sNC; /* The name-context to resolve expressions in */
  120005. int iDb; /* Database containing the table being updated */
  120006. int eOnePass; /* ONEPASS_XXX value from where.c */
  120007. int hasFK; /* True if foreign key processing is required */
  120008. int labelBreak; /* Jump here to break out of UPDATE loop */
  120009. int labelContinue; /* Jump here to continue next step of UPDATE loop */
  120010. int flags; /* Flags for sqlite3WhereBegin() */
  120011. #ifndef SQLITE_OMIT_TRIGGER
  120012. int isView; /* True when updating a view (INSTEAD OF trigger) */
  120013. Trigger *pTrigger; /* List of triggers on pTab, if required */
  120014. int tmask; /* Mask of TRIGGER_BEFORE|TRIGGER_AFTER */
  120015. #endif
  120016. int newmask; /* Mask of NEW.* columns accessed by BEFORE triggers */
  120017. int iEph = 0; /* Ephemeral table holding all primary key values */
  120018. int nKey = 0; /* Number of elements in regKey for WITHOUT ROWID */
  120019. int aiCurOnePass[2]; /* The write cursors opened by WHERE_ONEPASS */
  120020. int addrOpen = 0; /* Address of OP_OpenEphemeral */
  120021. int iPk = 0; /* First of nPk cells holding PRIMARY KEY value */
  120022. i16 nPk = 0; /* Number of components of the PRIMARY KEY */
  120023. int bReplace = 0; /* True if REPLACE conflict resolution might happen */
  120024. /* Register Allocations */
  120025. int regRowCount = 0; /* A count of rows changed */
  120026. int regOldRowid = 0; /* The old rowid */
  120027. int regNewRowid = 0; /* The new rowid */
  120028. int regNew = 0; /* Content of the NEW.* table in triggers */
  120029. int regOld = 0; /* Content of OLD.* table in triggers */
  120030. int regRowSet = 0; /* Rowset of rows to be updated */
  120031. int regKey = 0; /* composite PRIMARY KEY value */
  120032. memset(&sContext, 0, sizeof(sContext));
  120033. db = pParse->db;
  120034. if( pParse->nErr || db->mallocFailed ){
  120035. goto update_cleanup;
  120036. }
  120037. assert( pTabList->nSrc==1 );
  120038. /* Locate the table which we want to update.
  120039. */
  120040. pTab = sqlite3SrcListLookup(pParse, pTabList);
  120041. if( pTab==0 ) goto update_cleanup;
  120042. iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
  120043. /* Figure out if we have any triggers and if the table being
  120044. ** updated is a view.
  120045. */
  120046. #ifndef SQLITE_OMIT_TRIGGER
  120047. pTrigger = sqlite3TriggersExist(pParse, pTab, TK_UPDATE, pChanges, &tmask);
  120048. isView = pTab->pSelect!=0;
  120049. assert( pTrigger || tmask==0 );
  120050. #else
  120051. # define pTrigger 0
  120052. # define isView 0
  120053. # define tmask 0
  120054. #endif
  120055. #ifdef SQLITE_OMIT_VIEW
  120056. # undef isView
  120057. # define isView 0
  120058. #endif
  120059. #ifdef SQLITE_ENABLE_UPDATE_DELETE_LIMIT
  120060. if( !isView ){
  120061. pWhere = sqlite3LimitWhere(
  120062. pParse, pTabList, pWhere, pOrderBy, pLimit, "UPDATE"
  120063. );
  120064. pOrderBy = 0;
  120065. pLimit = 0;
  120066. }
  120067. #endif
  120068. if( sqlite3ViewGetColumnNames(pParse, pTab) ){
  120069. goto update_cleanup;
  120070. }
  120071. if( sqlite3IsReadOnly(pParse, pTab, tmask) ){
  120072. goto update_cleanup;
  120073. }
  120074. /* Allocate a cursors for the main database table and for all indices.
  120075. ** The index cursors might not be used, but if they are used they
  120076. ** need to occur right after the database cursor. So go ahead and
  120077. ** allocate enough space, just in case.
  120078. */
  120079. pTabList->a[0].iCursor = iBaseCur = iDataCur = pParse->nTab++;
  120080. iIdxCur = iDataCur+1;
  120081. pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
  120082. for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){
  120083. if( IsPrimaryKeyIndex(pIdx) && pPk!=0 ){
  120084. iDataCur = pParse->nTab;
  120085. pTabList->a[0].iCursor = iDataCur;
  120086. }
  120087. pParse->nTab++;
  120088. }
  120089. /* Allocate space for aXRef[], aRegIdx[], and aToOpen[].
  120090. ** Initialize aXRef[] and aToOpen[] to their default values.
  120091. */
  120092. aXRef = sqlite3DbMallocRawNN(db, sizeof(int) * (pTab->nCol+nIdx) + nIdx+2 );
  120093. if( aXRef==0 ) goto update_cleanup;
  120094. aRegIdx = aXRef+pTab->nCol;
  120095. aToOpen = (u8*)(aRegIdx+nIdx);
  120096. memset(aToOpen, 1, nIdx+1);
  120097. aToOpen[nIdx+1] = 0;
  120098. for(i=0; i<pTab->nCol; i++) aXRef[i] = -1;
  120099. /* Initialize the name-context */
  120100. memset(&sNC, 0, sizeof(sNC));
  120101. sNC.pParse = pParse;
  120102. sNC.pSrcList = pTabList;
  120103. /* Resolve the column names in all the expressions of the
  120104. ** of the UPDATE statement. Also find the column index
  120105. ** for each column to be updated in the pChanges array. For each
  120106. ** column to be updated, make sure we have authorization to change
  120107. ** that column.
  120108. */
  120109. chngRowid = chngPk = 0;
  120110. for(i=0; i<pChanges->nExpr; i++){
  120111. if( sqlite3ResolveExprNames(&sNC, pChanges->a[i].pExpr) ){
  120112. goto update_cleanup;
  120113. }
  120114. for(j=0; j<pTab->nCol; j++){
  120115. if( sqlite3StrICmp(pTab->aCol[j].zName, pChanges->a[i].zName)==0 ){
  120116. if( j==pTab->iPKey ){
  120117. chngRowid = 1;
  120118. pRowidExpr = pChanges->a[i].pExpr;
  120119. }else if( pPk && (pTab->aCol[j].colFlags & COLFLAG_PRIMKEY)!=0 ){
  120120. chngPk = 1;
  120121. }
  120122. aXRef[j] = i;
  120123. break;
  120124. }
  120125. }
  120126. if( j>=pTab->nCol ){
  120127. if( pPk==0 && sqlite3IsRowid(pChanges->a[i].zName) ){
  120128. j = -1;
  120129. chngRowid = 1;
  120130. pRowidExpr = pChanges->a[i].pExpr;
  120131. }else{
  120132. sqlite3ErrorMsg(pParse, "no such column: %s", pChanges->a[i].zName);
  120133. pParse->checkSchema = 1;
  120134. goto update_cleanup;
  120135. }
  120136. }
  120137. #ifndef SQLITE_OMIT_AUTHORIZATION
  120138. {
  120139. int rc;
  120140. rc = sqlite3AuthCheck(pParse, SQLITE_UPDATE, pTab->zName,
  120141. j<0 ? "ROWID" : pTab->aCol[j].zName,
  120142. db->aDb[iDb].zDbSName);
  120143. if( rc==SQLITE_DENY ){
  120144. goto update_cleanup;
  120145. }else if( rc==SQLITE_IGNORE ){
  120146. aXRef[j] = -1;
  120147. }
  120148. }
  120149. #endif
  120150. }
  120151. assert( (chngRowid & chngPk)==0 );
  120152. assert( chngRowid==0 || chngRowid==1 );
  120153. assert( chngPk==0 || chngPk==1 );
  120154. chngKey = chngRowid + chngPk;
  120155. /* The SET expressions are not actually used inside the WHERE loop.
  120156. ** So reset the colUsed mask. Unless this is a virtual table. In that
  120157. ** case, set all bits of the colUsed mask (to ensure that the virtual
  120158. ** table implementation makes all columns available).
  120159. */
  120160. pTabList->a[0].colUsed = IsVirtual(pTab) ? ALLBITS : 0;
  120161. hasFK = sqlite3FkRequired(pParse, pTab, aXRef, chngKey);
  120162. /* There is one entry in the aRegIdx[] array for each index on the table
  120163. ** being updated. Fill in aRegIdx[] with a register number that will hold
  120164. ** the key for accessing each index.
  120165. **
  120166. ** FIXME: Be smarter about omitting indexes that use expressions.
  120167. */
  120168. for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
  120169. int reg;
  120170. if( chngKey || hasFK>1 || pIdx->pPartIdxWhere || pIdx==pPk ){
  120171. reg = ++pParse->nMem;
  120172. pParse->nMem += pIdx->nColumn;
  120173. }else{
  120174. reg = 0;
  120175. for(i=0; i<pIdx->nKeyCol; i++){
  120176. i16 iIdxCol = pIdx->aiColumn[i];
  120177. if( iIdxCol<0 || aXRef[iIdxCol]>=0 ){
  120178. reg = ++pParse->nMem;
  120179. pParse->nMem += pIdx->nColumn;
  120180. if( (onError==OE_Replace)
  120181. || (onError==OE_Default && pIdx->onError==OE_Replace)
  120182. ){
  120183. bReplace = 1;
  120184. }
  120185. break;
  120186. }
  120187. }
  120188. }
  120189. if( reg==0 ) aToOpen[j+1] = 0;
  120190. aRegIdx[j] = reg;
  120191. }
  120192. if( bReplace ){
  120193. /* If REPLACE conflict resolution might be invoked, open cursors on all
  120194. ** indexes in case they are needed to delete records. */
  120195. memset(aToOpen, 1, nIdx+1);
  120196. }
  120197. /* Begin generating code. */
  120198. v = sqlite3GetVdbe(pParse);
  120199. if( v==0 ) goto update_cleanup;
  120200. if( pParse->nested==0 ) sqlite3VdbeCountChanges(v);
  120201. sqlite3BeginWriteOperation(pParse, 1, iDb);
  120202. /* Allocate required registers. */
  120203. if( !IsVirtual(pTab) ){
  120204. regRowSet = ++pParse->nMem;
  120205. regOldRowid = regNewRowid = ++pParse->nMem;
  120206. if( chngPk || pTrigger || hasFK ){
  120207. regOld = pParse->nMem + 1;
  120208. pParse->nMem += pTab->nCol;
  120209. }
  120210. if( chngKey || pTrigger || hasFK ){
  120211. regNewRowid = ++pParse->nMem;
  120212. }
  120213. regNew = pParse->nMem + 1;
  120214. pParse->nMem += pTab->nCol;
  120215. }
  120216. /* Start the view context. */
  120217. if( isView ){
  120218. sqlite3AuthContextPush(pParse, &sContext, pTab->zName);
  120219. }
  120220. /* If we are trying to update a view, realize that view into
  120221. ** an ephemeral table.
  120222. */
  120223. #if !defined(SQLITE_OMIT_VIEW) && !defined(SQLITE_OMIT_TRIGGER)
  120224. if( isView ){
  120225. sqlite3MaterializeView(pParse, pTab,
  120226. pWhere, pOrderBy, pLimit, iDataCur
  120227. );
  120228. pOrderBy = 0;
  120229. pLimit = 0;
  120230. }
  120231. #endif
  120232. /* Resolve the column names in all the expressions in the
  120233. ** WHERE clause.
  120234. */
  120235. if( sqlite3ResolveExprNames(&sNC, pWhere) ){
  120236. goto update_cleanup;
  120237. }
  120238. #ifndef SQLITE_OMIT_VIRTUALTABLE
  120239. /* Virtual tables must be handled separately */
  120240. if( IsVirtual(pTab) ){
  120241. updateVirtualTable(pParse, pTabList, pTab, pChanges, pRowidExpr, aXRef,
  120242. pWhere, onError);
  120243. goto update_cleanup;
  120244. }
  120245. #endif
  120246. /* Initialize the count of updated rows */
  120247. if( (db->flags & SQLITE_CountRows) && !pParse->pTriggerTab ){
  120248. regRowCount = ++pParse->nMem;
  120249. sqlite3VdbeAddOp2(v, OP_Integer, 0, regRowCount);
  120250. }
  120251. if( HasRowid(pTab) ){
  120252. sqlite3VdbeAddOp3(v, OP_Null, 0, regRowSet, regOldRowid);
  120253. }else{
  120254. assert( pPk!=0 );
  120255. nPk = pPk->nKeyCol;
  120256. iPk = pParse->nMem+1;
  120257. pParse->nMem += nPk;
  120258. regKey = ++pParse->nMem;
  120259. iEph = pParse->nTab++;
  120260. sqlite3VdbeAddOp3(v, OP_Null, 0, iPk, iPk+nPk-1);
  120261. addrOpen = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iEph, nPk);
  120262. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  120263. }
  120264. /* Begin the database scan.
  120265. **
  120266. ** Do not consider a single-pass strategy for a multi-row update if
  120267. ** there are any triggers or foreign keys to process, or rows may
  120268. ** be deleted as a result of REPLACE conflict handling. Any of these
  120269. ** things might disturb a cursor being used to scan through the table
  120270. ** or index, causing a single-pass approach to malfunction. */
  120271. flags = WHERE_ONEPASS_DESIRED|WHERE_SEEK_UNIQ_TABLE;
  120272. if( !pParse->nested && !pTrigger && !hasFK && !chngKey && !bReplace ){
  120273. flags |= WHERE_ONEPASS_MULTIROW;
  120274. }
  120275. pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, 0, 0, flags, iIdxCur);
  120276. if( pWInfo==0 ) goto update_cleanup;
  120277. /* A one-pass strategy that might update more than one row may not
  120278. ** be used if any column of the index used for the scan is being
  120279. ** updated. Otherwise, if there is an index on "b", statements like
  120280. ** the following could create an infinite loop:
  120281. **
  120282. ** UPDATE t1 SET b=b+1 WHERE b>?
  120283. **
  120284. ** Fall back to ONEPASS_OFF if where.c has selected a ONEPASS_MULTI
  120285. ** strategy that uses an index for which one or more columns are being
  120286. ** updated. */
  120287. eOnePass = sqlite3WhereOkOnePass(pWInfo, aiCurOnePass);
  120288. if( eOnePass==ONEPASS_MULTI ){
  120289. int iCur = aiCurOnePass[1];
  120290. if( iCur>=0 && iCur!=iDataCur && aToOpen[iCur-iBaseCur] ){
  120291. eOnePass = ONEPASS_OFF;
  120292. }
  120293. assert( iCur!=iDataCur || !HasRowid(pTab) );
  120294. }
  120295. if( HasRowid(pTab) ){
  120296. /* Read the rowid of the current row of the WHERE scan. In ONEPASS_OFF
  120297. ** mode, write the rowid into the FIFO. In either of the one-pass modes,
  120298. ** leave it in register regOldRowid. */
  120299. sqlite3VdbeAddOp2(v, OP_Rowid, iDataCur, regOldRowid);
  120300. if( eOnePass==ONEPASS_OFF ){
  120301. sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, regOldRowid);
  120302. }
  120303. }else{
  120304. /* Read the PK of the current row into an array of registers. In
  120305. ** ONEPASS_OFF mode, serialize the array into a record and store it in
  120306. ** the ephemeral table. Or, in ONEPASS_SINGLE or MULTI mode, change
  120307. ** the OP_OpenEphemeral instruction to a Noop (the ephemeral table
  120308. ** is not required) and leave the PK fields in the array of registers. */
  120309. for(i=0; i<nPk; i++){
  120310. assert( pPk->aiColumn[i]>=0 );
  120311. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur,pPk->aiColumn[i],iPk+i);
  120312. }
  120313. if( eOnePass ){
  120314. sqlite3VdbeChangeToNoop(v, addrOpen);
  120315. nKey = nPk;
  120316. regKey = iPk;
  120317. }else{
  120318. sqlite3VdbeAddOp4(v, OP_MakeRecord, iPk, nPk, regKey,
  120319. sqlite3IndexAffinityStr(db, pPk), nPk);
  120320. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iEph, regKey, iPk, nPk);
  120321. }
  120322. }
  120323. if( eOnePass!=ONEPASS_MULTI ){
  120324. sqlite3WhereEnd(pWInfo);
  120325. }
  120326. labelBreak = sqlite3VdbeMakeLabel(v);
  120327. if( !isView ){
  120328. int addrOnce = 0;
  120329. /* Open every index that needs updating. */
  120330. if( eOnePass!=ONEPASS_OFF ){
  120331. if( aiCurOnePass[0]>=0 ) aToOpen[aiCurOnePass[0]-iBaseCur] = 0;
  120332. if( aiCurOnePass[1]>=0 ) aToOpen[aiCurOnePass[1]-iBaseCur] = 0;
  120333. }
  120334. if( eOnePass==ONEPASS_MULTI && (nIdx-(aiCurOnePass[1]>=0))>0 ){
  120335. addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  120336. }
  120337. sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenWrite, 0, iBaseCur, aToOpen,
  120338. 0, 0);
  120339. if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
  120340. }
  120341. /* Top of the update loop */
  120342. if( eOnePass!=ONEPASS_OFF ){
  120343. if( !isView && aiCurOnePass[0]!=iDataCur && aiCurOnePass[1]!=iDataCur ){
  120344. assert( pPk );
  120345. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelBreak, regKey, nKey);
  120346. VdbeCoverageNeverTaken(v);
  120347. }
  120348. if( eOnePass==ONEPASS_SINGLE ){
  120349. labelContinue = labelBreak;
  120350. }else{
  120351. labelContinue = sqlite3VdbeMakeLabel(v);
  120352. }
  120353. sqlite3VdbeAddOp2(v, OP_IsNull, pPk ? regKey : regOldRowid, labelBreak);
  120354. VdbeCoverageIf(v, pPk==0);
  120355. VdbeCoverageIf(v, pPk!=0);
  120356. }else if( pPk ){
  120357. labelContinue = sqlite3VdbeMakeLabel(v);
  120358. sqlite3VdbeAddOp2(v, OP_Rewind, iEph, labelBreak); VdbeCoverage(v);
  120359. addrTop = sqlite3VdbeAddOp2(v, OP_RowData, iEph, regKey);
  120360. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue, regKey, 0);
  120361. VdbeCoverage(v);
  120362. }else{
  120363. labelContinue = sqlite3VdbeAddOp3(v, OP_RowSetRead, regRowSet, labelBreak,
  120364. regOldRowid);
  120365. VdbeCoverage(v);
  120366. sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
  120367. VdbeCoverage(v);
  120368. }
  120369. /* If the record number will change, set register regNewRowid to
  120370. ** contain the new value. If the record number is not being modified,
  120371. ** then regNewRowid is the same register as regOldRowid, which is
  120372. ** already populated. */
  120373. assert( chngKey || pTrigger || hasFK || regOldRowid==regNewRowid );
  120374. if( chngRowid ){
  120375. sqlite3ExprCode(pParse, pRowidExpr, regNewRowid);
  120376. sqlite3VdbeAddOp1(v, OP_MustBeInt, regNewRowid); VdbeCoverage(v);
  120377. }
  120378. /* Compute the old pre-UPDATE content of the row being changed, if that
  120379. ** information is needed */
  120380. if( chngPk || hasFK || pTrigger ){
  120381. u32 oldmask = (hasFK ? sqlite3FkOldmask(pParse, pTab) : 0);
  120382. oldmask |= sqlite3TriggerColmask(pParse,
  120383. pTrigger, pChanges, 0, TRIGGER_BEFORE|TRIGGER_AFTER, pTab, onError
  120384. );
  120385. for(i=0; i<pTab->nCol; i++){
  120386. if( oldmask==0xffffffff
  120387. || (i<32 && (oldmask & MASKBIT32(i))!=0)
  120388. || (pTab->aCol[i].colFlags & COLFLAG_PRIMKEY)!=0
  120389. ){
  120390. testcase( oldmask!=0xffffffff && i==31 );
  120391. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regOld+i);
  120392. }else{
  120393. sqlite3VdbeAddOp2(v, OP_Null, 0, regOld+i);
  120394. }
  120395. }
  120396. if( chngRowid==0 && pPk==0 ){
  120397. sqlite3VdbeAddOp2(v, OP_Copy, regOldRowid, regNewRowid);
  120398. }
  120399. }
  120400. /* Populate the array of registers beginning at regNew with the new
  120401. ** row data. This array is used to check constants, create the new
  120402. ** table and index records, and as the values for any new.* references
  120403. ** made by triggers.
  120404. **
  120405. ** If there are one or more BEFORE triggers, then do not populate the
  120406. ** registers associated with columns that are (a) not modified by
  120407. ** this UPDATE statement and (b) not accessed by new.* references. The
  120408. ** values for registers not modified by the UPDATE must be reloaded from
  120409. ** the database after the BEFORE triggers are fired anyway (as the trigger
  120410. ** may have modified them). So not loading those that are not going to
  120411. ** be used eliminates some redundant opcodes.
  120412. */
  120413. newmask = sqlite3TriggerColmask(
  120414. pParse, pTrigger, pChanges, 1, TRIGGER_BEFORE, pTab, onError
  120415. );
  120416. for(i=0; i<pTab->nCol; i++){
  120417. if( i==pTab->iPKey ){
  120418. sqlite3VdbeAddOp2(v, OP_Null, 0, regNew+i);
  120419. }else{
  120420. j = aXRef[i];
  120421. if( j>=0 ){
  120422. sqlite3ExprCode(pParse, pChanges->a[j].pExpr, regNew+i);
  120423. }else if( 0==(tmask&TRIGGER_BEFORE) || i>31 || (newmask & MASKBIT32(i)) ){
  120424. /* This branch loads the value of a column that will not be changed
  120425. ** into a register. This is done if there are no BEFORE triggers, or
  120426. ** if there are one or more BEFORE triggers that use this value via
  120427. ** a new.* reference in a trigger program.
  120428. */
  120429. testcase( i==31 );
  120430. testcase( i==32 );
  120431. sqlite3ExprCodeGetColumnToReg(pParse, pTab, i, iDataCur, regNew+i);
  120432. }else{
  120433. sqlite3VdbeAddOp2(v, OP_Null, 0, regNew+i);
  120434. }
  120435. }
  120436. }
  120437. /* Fire any BEFORE UPDATE triggers. This happens before constraints are
  120438. ** verified. One could argue that this is wrong.
  120439. */
  120440. if( tmask&TRIGGER_BEFORE ){
  120441. sqlite3TableAffinity(v, pTab, regNew);
  120442. sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
  120443. TRIGGER_BEFORE, pTab, regOldRowid, onError, labelContinue);
  120444. /* The row-trigger may have deleted the row being updated. In this
  120445. ** case, jump to the next row. No updates or AFTER triggers are
  120446. ** required. This behavior - what happens when the row being updated
  120447. ** is deleted or renamed by a BEFORE trigger - is left undefined in the
  120448. ** documentation.
  120449. */
  120450. if( pPk ){
  120451. sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, labelContinue,regKey,nKey);
  120452. VdbeCoverage(v);
  120453. }else{
  120454. sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, labelContinue, regOldRowid);
  120455. VdbeCoverage(v);
  120456. }
  120457. /* If it did not delete it, the row-trigger may still have modified
  120458. ** some of the columns of the row being updated. Load the values for
  120459. ** all columns not modified by the update statement into their
  120460. ** registers in case this has happened.
  120461. */
  120462. for(i=0; i<pTab->nCol; i++){
  120463. if( aXRef[i]<0 && i!=pTab->iPKey ){
  120464. sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, i, regNew+i);
  120465. }
  120466. }
  120467. }
  120468. if( !isView ){
  120469. int addr1 = 0; /* Address of jump instruction */
  120470. /* Do constraint checks. */
  120471. assert( regOldRowid>0 );
  120472. sqlite3GenerateConstraintChecks(pParse, pTab, aRegIdx, iDataCur, iIdxCur,
  120473. regNewRowid, regOldRowid, chngKey, onError, labelContinue, &bReplace,
  120474. aXRef);
  120475. /* Do FK constraint checks. */
  120476. if( hasFK ){
  120477. sqlite3FkCheck(pParse, pTab, regOldRowid, 0, aXRef, chngKey);
  120478. }
  120479. /* Delete the index entries associated with the current record. */
  120480. if( bReplace || chngKey ){
  120481. if( pPk ){
  120482. addr1 = sqlite3VdbeAddOp4Int(v, OP_NotFound, iDataCur, 0, regKey, nKey);
  120483. }else{
  120484. addr1 = sqlite3VdbeAddOp3(v, OP_NotExists, iDataCur, 0, regOldRowid);
  120485. }
  120486. VdbeCoverageNeverTaken(v);
  120487. }
  120488. sqlite3GenerateRowIndexDelete(pParse, pTab, iDataCur, iIdxCur, aRegIdx, -1);
  120489. /* If changing the rowid value, or if there are foreign key constraints
  120490. ** to process, delete the old record. Otherwise, add a noop OP_Delete
  120491. ** to invoke the pre-update hook.
  120492. **
  120493. ** That (regNew==regnewRowid+1) is true is also important for the
  120494. ** pre-update hook. If the caller invokes preupdate_new(), the returned
  120495. ** value is copied from memory cell (regNewRowid+1+iCol), where iCol
  120496. ** is the column index supplied by the user.
  120497. */
  120498. assert( regNew==regNewRowid+1 );
  120499. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  120500. sqlite3VdbeAddOp3(v, OP_Delete, iDataCur,
  120501. OPFLAG_ISUPDATE | ((hasFK>1 || chngKey) ? 0 : OPFLAG_ISNOOP),
  120502. regNewRowid
  120503. );
  120504. if( eOnePass==ONEPASS_MULTI ){
  120505. assert( hasFK==0 && chngKey==0 );
  120506. sqlite3VdbeChangeP5(v, OPFLAG_SAVEPOSITION);
  120507. }
  120508. if( !pParse->nested ){
  120509. sqlite3VdbeAppendP4(v, pTab, P4_TABLE);
  120510. }
  120511. #else
  120512. if( hasFK>1 || chngKey ){
  120513. sqlite3VdbeAddOp2(v, OP_Delete, iDataCur, 0);
  120514. }
  120515. #endif
  120516. if( bReplace || chngKey ){
  120517. sqlite3VdbeJumpHere(v, addr1);
  120518. }
  120519. if( hasFK ){
  120520. sqlite3FkCheck(pParse, pTab, 0, regNewRowid, aXRef, chngKey);
  120521. }
  120522. /* Insert the new index entries and the new record. */
  120523. sqlite3CompleteInsertion(
  120524. pParse, pTab, iDataCur, iIdxCur, regNewRowid, aRegIdx,
  120525. OPFLAG_ISUPDATE | (eOnePass==ONEPASS_MULTI ? OPFLAG_SAVEPOSITION : 0),
  120526. 0, 0
  120527. );
  120528. /* Do any ON CASCADE, SET NULL or SET DEFAULT operations required to
  120529. ** handle rows (possibly in other tables) that refer via a foreign key
  120530. ** to the row just updated. */
  120531. if( hasFK ){
  120532. sqlite3FkActions(pParse, pTab, pChanges, regOldRowid, aXRef, chngKey);
  120533. }
  120534. }
  120535. /* Increment the row counter
  120536. */
  120537. if( (db->flags & SQLITE_CountRows) && !pParse->pTriggerTab){
  120538. sqlite3VdbeAddOp2(v, OP_AddImm, regRowCount, 1);
  120539. }
  120540. sqlite3CodeRowTrigger(pParse, pTrigger, TK_UPDATE, pChanges,
  120541. TRIGGER_AFTER, pTab, regOldRowid, onError, labelContinue);
  120542. /* Repeat the above with the next record to be updated, until
  120543. ** all record selected by the WHERE clause have been updated.
  120544. */
  120545. if( eOnePass==ONEPASS_SINGLE ){
  120546. /* Nothing to do at end-of-loop for a single-pass */
  120547. }else if( eOnePass==ONEPASS_MULTI ){
  120548. sqlite3VdbeResolveLabel(v, labelContinue);
  120549. sqlite3WhereEnd(pWInfo);
  120550. }else if( pPk ){
  120551. sqlite3VdbeResolveLabel(v, labelContinue);
  120552. sqlite3VdbeAddOp2(v, OP_Next, iEph, addrTop); VdbeCoverage(v);
  120553. }else{
  120554. sqlite3VdbeGoto(v, labelContinue);
  120555. }
  120556. sqlite3VdbeResolveLabel(v, labelBreak);
  120557. /* Update the sqlite_sequence table by storing the content of the
  120558. ** maximum rowid counter values recorded while inserting into
  120559. ** autoincrement tables.
  120560. */
  120561. if( pParse->nested==0 && pParse->pTriggerTab==0 ){
  120562. sqlite3AutoincrementEnd(pParse);
  120563. }
  120564. /*
  120565. ** Return the number of rows that were changed. If this routine is
  120566. ** generating code because of a call to sqlite3NestedParse(), do not
  120567. ** invoke the callback function.
  120568. */
  120569. if( (db->flags&SQLITE_CountRows) && !pParse->pTriggerTab && !pParse->nested ){
  120570. sqlite3VdbeAddOp2(v, OP_ResultRow, regRowCount, 1);
  120571. sqlite3VdbeSetNumCols(v, 1);
  120572. sqlite3VdbeSetColName(v, 0, COLNAME_NAME, "rows updated", SQLITE_STATIC);
  120573. }
  120574. update_cleanup:
  120575. sqlite3AuthContextPop(&sContext);
  120576. sqlite3DbFree(db, aXRef); /* Also frees aRegIdx[] and aToOpen[] */
  120577. sqlite3SrcListDelete(db, pTabList);
  120578. sqlite3ExprListDelete(db, pChanges);
  120579. sqlite3ExprDelete(db, pWhere);
  120580. #if defined(SQLITE_ENABLE_UPDATE_DELETE_LIMIT)
  120581. sqlite3ExprListDelete(db, pOrderBy);
  120582. sqlite3ExprDelete(db, pLimit);
  120583. #endif
  120584. return;
  120585. }
  120586. /* Make sure "isView" and other macros defined above are undefined. Otherwise
  120587. ** they may interfere with compilation of other functions in this file
  120588. ** (or in another file, if this file becomes part of the amalgamation). */
  120589. #ifdef isView
  120590. #undef isView
  120591. #endif
  120592. #ifdef pTrigger
  120593. #undef pTrigger
  120594. #endif
  120595. #ifndef SQLITE_OMIT_VIRTUALTABLE
  120596. /*
  120597. ** Generate code for an UPDATE of a virtual table.
  120598. **
  120599. ** There are two possible strategies - the default and the special
  120600. ** "onepass" strategy. Onepass is only used if the virtual table
  120601. ** implementation indicates that pWhere may match at most one row.
  120602. **
  120603. ** The default strategy is to create an ephemeral table that contains
  120604. ** for each row to be changed:
  120605. **
  120606. ** (A) The original rowid of that row.
  120607. ** (B) The revised rowid for the row.
  120608. ** (C) The content of every column in the row.
  120609. **
  120610. ** Then loop through the contents of this ephemeral table executing a
  120611. ** VUpdate for each row. When finished, drop the ephemeral table.
  120612. **
  120613. ** The "onepass" strategy does not use an ephemeral table. Instead, it
  120614. ** stores the same values (A, B and C above) in a register array and
  120615. ** makes a single invocation of VUpdate.
  120616. */
  120617. static void updateVirtualTable(
  120618. Parse *pParse, /* The parsing context */
  120619. SrcList *pSrc, /* The virtual table to be modified */
  120620. Table *pTab, /* The virtual table */
  120621. ExprList *pChanges, /* The columns to change in the UPDATE statement */
  120622. Expr *pRowid, /* Expression used to recompute the rowid */
  120623. int *aXRef, /* Mapping from columns of pTab to entries in pChanges */
  120624. Expr *pWhere, /* WHERE clause of the UPDATE statement */
  120625. int onError /* ON CONFLICT strategy */
  120626. ){
  120627. Vdbe *v = pParse->pVdbe; /* Virtual machine under construction */
  120628. int ephemTab; /* Table holding the result of the SELECT */
  120629. int i; /* Loop counter */
  120630. sqlite3 *db = pParse->db; /* Database connection */
  120631. const char *pVTab = (const char*)sqlite3GetVTable(db, pTab);
  120632. WhereInfo *pWInfo;
  120633. int nArg = 2 + pTab->nCol; /* Number of arguments to VUpdate */
  120634. int regArg; /* First register in VUpdate arg array */
  120635. int regRec; /* Register in which to assemble record */
  120636. int regRowid; /* Register for ephem table rowid */
  120637. int iCsr = pSrc->a[0].iCursor; /* Cursor used for virtual table scan */
  120638. int aDummy[2]; /* Unused arg for sqlite3WhereOkOnePass() */
  120639. int bOnePass; /* True to use onepass strategy */
  120640. int addr; /* Address of OP_OpenEphemeral */
  120641. /* Allocate nArg registers in which to gather the arguments for VUpdate. Then
  120642. ** create and open the ephemeral table in which the records created from
  120643. ** these arguments will be temporarily stored. */
  120644. assert( v );
  120645. ephemTab = pParse->nTab++;
  120646. addr= sqlite3VdbeAddOp2(v, OP_OpenEphemeral, ephemTab, nArg);
  120647. regArg = pParse->nMem + 1;
  120648. pParse->nMem += nArg;
  120649. regRec = ++pParse->nMem;
  120650. regRowid = ++pParse->nMem;
  120651. /* Start scanning the virtual table */
  120652. pWInfo = sqlite3WhereBegin(pParse, pSrc, pWhere, 0,0,WHERE_ONEPASS_DESIRED,0);
  120653. if( pWInfo==0 ) return;
  120654. /* Populate the argument registers. */
  120655. for(i=0; i<pTab->nCol; i++){
  120656. if( aXRef[i]>=0 ){
  120657. sqlite3ExprCode(pParse, pChanges->a[aXRef[i]].pExpr, regArg+2+i);
  120658. }else{
  120659. sqlite3VdbeAddOp3(v, OP_VColumn, iCsr, i, regArg+2+i);
  120660. sqlite3VdbeChangeP5(v, 1); /* Enable sqlite3_vtab_nochange() */
  120661. }
  120662. }
  120663. if( HasRowid(pTab) ){
  120664. sqlite3VdbeAddOp2(v, OP_Rowid, iCsr, regArg);
  120665. if( pRowid ){
  120666. sqlite3ExprCode(pParse, pRowid, regArg+1);
  120667. }else{
  120668. sqlite3VdbeAddOp2(v, OP_Rowid, iCsr, regArg+1);
  120669. }
  120670. }else{
  120671. Index *pPk; /* PRIMARY KEY index */
  120672. i16 iPk; /* PRIMARY KEY column */
  120673. pPk = sqlite3PrimaryKeyIndex(pTab);
  120674. assert( pPk!=0 );
  120675. assert( pPk->nKeyCol==1 );
  120676. iPk = pPk->aiColumn[0];
  120677. sqlite3VdbeAddOp3(v, OP_VColumn, iCsr, iPk, regArg);
  120678. sqlite3VdbeAddOp2(v, OP_SCopy, regArg+2+iPk, regArg+1);
  120679. }
  120680. bOnePass = sqlite3WhereOkOnePass(pWInfo, aDummy);
  120681. if( bOnePass ){
  120682. /* If using the onepass strategy, no-op out the OP_OpenEphemeral coded
  120683. ** above. Also, if this is a top-level parse (not a trigger), clear the
  120684. ** multi-write flag so that the VM does not open a statement journal */
  120685. sqlite3VdbeChangeToNoop(v, addr);
  120686. if( sqlite3IsToplevel(pParse) ){
  120687. pParse->isMultiWrite = 0;
  120688. }
  120689. }else{
  120690. /* Create a record from the argument register contents and insert it into
  120691. ** the ephemeral table. */
  120692. sqlite3VdbeAddOp3(v, OP_MakeRecord, regArg, nArg, regRec);
  120693. #ifdef SQLITE_DEBUG
  120694. /* Signal an assert() within OP_MakeRecord that it is allowed to
  120695. ** accept no-change records with serial_type 10 */
  120696. sqlite3VdbeChangeP5(v, OPFLAG_NOCHNG_MAGIC);
  120697. #endif
  120698. sqlite3VdbeAddOp2(v, OP_NewRowid, ephemTab, regRowid);
  120699. sqlite3VdbeAddOp3(v, OP_Insert, ephemTab, regRec, regRowid);
  120700. }
  120701. if( bOnePass==0 ){
  120702. /* End the virtual table scan */
  120703. sqlite3WhereEnd(pWInfo);
  120704. /* Begin scannning through the ephemeral table. */
  120705. addr = sqlite3VdbeAddOp1(v, OP_Rewind, ephemTab); VdbeCoverage(v);
  120706. /* Extract arguments from the current row of the ephemeral table and
  120707. ** invoke the VUpdate method. */
  120708. for(i=0; i<nArg; i++){
  120709. sqlite3VdbeAddOp3(v, OP_Column, ephemTab, i, regArg+i);
  120710. }
  120711. }
  120712. sqlite3VtabMakeWritable(pParse, pTab);
  120713. sqlite3VdbeAddOp4(v, OP_VUpdate, 0, nArg, regArg, pVTab, P4_VTAB);
  120714. sqlite3VdbeChangeP5(v, onError==OE_Default ? OE_Abort : onError);
  120715. sqlite3MayAbort(pParse);
  120716. /* End of the ephemeral table scan. Or, if using the onepass strategy,
  120717. ** jump to here if the scan visited zero rows. */
  120718. if( bOnePass==0 ){
  120719. sqlite3VdbeAddOp2(v, OP_Next, ephemTab, addr+1); VdbeCoverage(v);
  120720. sqlite3VdbeJumpHere(v, addr);
  120721. sqlite3VdbeAddOp2(v, OP_Close, ephemTab, 0);
  120722. }else{
  120723. sqlite3WhereEnd(pWInfo);
  120724. }
  120725. }
  120726. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  120727. /************** End of update.c **********************************************/
  120728. /************** Begin file vacuum.c ******************************************/
  120729. /*
  120730. ** 2003 April 6
  120731. **
  120732. ** The author disclaims copyright to this source code. In place of
  120733. ** a legal notice, here is a blessing:
  120734. **
  120735. ** May you do good and not evil.
  120736. ** May you find forgiveness for yourself and forgive others.
  120737. ** May you share freely, never taking more than you give.
  120738. **
  120739. *************************************************************************
  120740. ** This file contains code used to implement the VACUUM command.
  120741. **
  120742. ** Most of the code in this file may be omitted by defining the
  120743. ** SQLITE_OMIT_VACUUM macro.
  120744. */
  120745. /* #include "sqliteInt.h" */
  120746. /* #include "vdbeInt.h" */
  120747. #if !defined(SQLITE_OMIT_VACUUM) && !defined(SQLITE_OMIT_ATTACH)
  120748. /*
  120749. ** Execute zSql on database db.
  120750. **
  120751. ** If zSql returns rows, then each row will have exactly one
  120752. ** column. (This will only happen if zSql begins with "SELECT".)
  120753. ** Take each row of result and call execSql() again recursively.
  120754. **
  120755. ** The execSqlF() routine does the same thing, except it accepts
  120756. ** a format string as its third argument
  120757. */
  120758. static int execSql(sqlite3 *db, char **pzErrMsg, const char *zSql){
  120759. sqlite3_stmt *pStmt;
  120760. int rc;
  120761. /* printf("SQL: [%s]\n", zSql); fflush(stdout); */
  120762. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  120763. if( rc!=SQLITE_OK ) return rc;
  120764. while( SQLITE_ROW==(rc = sqlite3_step(pStmt)) ){
  120765. const char *zSubSql = (const char*)sqlite3_column_text(pStmt,0);
  120766. assert( sqlite3_strnicmp(zSql,"SELECT",6)==0 );
  120767. assert( sqlite3_strnicmp(zSubSql,"SELECT",6)!=0 || CORRUPT_DB );
  120768. if( zSubSql && zSubSql[0]!='S' ){
  120769. rc = execSql(db, pzErrMsg, zSubSql);
  120770. if( rc!=SQLITE_OK ) break;
  120771. }
  120772. }
  120773. assert( rc!=SQLITE_ROW );
  120774. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  120775. if( rc ){
  120776. sqlite3SetString(pzErrMsg, db, sqlite3_errmsg(db));
  120777. }
  120778. (void)sqlite3_finalize(pStmt);
  120779. return rc;
  120780. }
  120781. static int execSqlF(sqlite3 *db, char **pzErrMsg, const char *zSql, ...){
  120782. char *z;
  120783. va_list ap;
  120784. int rc;
  120785. va_start(ap, zSql);
  120786. z = sqlite3VMPrintf(db, zSql, ap);
  120787. va_end(ap);
  120788. if( z==0 ) return SQLITE_NOMEM;
  120789. rc = execSql(db, pzErrMsg, z);
  120790. sqlite3DbFree(db, z);
  120791. return rc;
  120792. }
  120793. /*
  120794. ** The VACUUM command is used to clean up the database,
  120795. ** collapse free space, etc. It is modelled after the VACUUM command
  120796. ** in PostgreSQL. The VACUUM command works as follows:
  120797. **
  120798. ** (1) Create a new transient database file
  120799. ** (2) Copy all content from the database being vacuumed into
  120800. ** the new transient database file
  120801. ** (3) Copy content from the transient database back into the
  120802. ** original database.
  120803. **
  120804. ** The transient database requires temporary disk space approximately
  120805. ** equal to the size of the original database. The copy operation of
  120806. ** step (3) requires additional temporary disk space approximately equal
  120807. ** to the size of the original database for the rollback journal.
  120808. ** Hence, temporary disk space that is approximately 2x the size of the
  120809. ** original database is required. Every page of the database is written
  120810. ** approximately 3 times: Once for step (2) and twice for step (3).
  120811. ** Two writes per page are required in step (3) because the original
  120812. ** database content must be written into the rollback journal prior to
  120813. ** overwriting the database with the vacuumed content.
  120814. **
  120815. ** Only 1x temporary space and only 1x writes would be required if
  120816. ** the copy of step (3) were replaced by deleting the original database
  120817. ** and renaming the transient database as the original. But that will
  120818. ** not work if other processes are attached to the original database.
  120819. ** And a power loss in between deleting the original and renaming the
  120820. ** transient would cause the database file to appear to be deleted
  120821. ** following reboot.
  120822. */
  120823. SQLITE_PRIVATE void sqlite3Vacuum(Parse *pParse, Token *pNm){
  120824. Vdbe *v = sqlite3GetVdbe(pParse);
  120825. int iDb = 0;
  120826. if( v==0 ) return;
  120827. if( pNm ){
  120828. #ifndef SQLITE_BUG_COMPATIBLE_20160819
  120829. /* Default behavior: Report an error if the argument to VACUUM is
  120830. ** not recognized */
  120831. iDb = sqlite3TwoPartName(pParse, pNm, pNm, &pNm);
  120832. if( iDb<0 ) return;
  120833. #else
  120834. /* When SQLITE_BUG_COMPATIBLE_20160819 is defined, unrecognized arguments
  120835. ** to VACUUM are silently ignored. This is a back-out of a bug fix that
  120836. ** occurred on 2016-08-19 (https://www.sqlite.org/src/info/083f9e6270).
  120837. ** The buggy behavior is required for binary compatibility with some
  120838. ** legacy applications. */
  120839. iDb = sqlite3FindDb(pParse->db, pNm);
  120840. if( iDb<0 ) iDb = 0;
  120841. #endif
  120842. }
  120843. if( iDb!=1 ){
  120844. sqlite3VdbeAddOp1(v, OP_Vacuum, iDb);
  120845. sqlite3VdbeUsesBtree(v, iDb);
  120846. }
  120847. return;
  120848. }
  120849. /*
  120850. ** This routine implements the OP_Vacuum opcode of the VDBE.
  120851. */
  120852. SQLITE_PRIVATE int sqlite3RunVacuum(char **pzErrMsg, sqlite3 *db, int iDb){
  120853. int rc = SQLITE_OK; /* Return code from service routines */
  120854. Btree *pMain; /* The database being vacuumed */
  120855. Btree *pTemp; /* The temporary database we vacuum into */
  120856. u16 saved_mDbFlags; /* Saved value of db->mDbFlags */
  120857. u32 saved_flags; /* Saved value of db->flags */
  120858. int saved_nChange; /* Saved value of db->nChange */
  120859. int saved_nTotalChange; /* Saved value of db->nTotalChange */
  120860. u8 saved_mTrace; /* Saved trace settings */
  120861. Db *pDb = 0; /* Database to detach at end of vacuum */
  120862. int isMemDb; /* True if vacuuming a :memory: database */
  120863. int nRes; /* Bytes of reserved space at the end of each page */
  120864. int nDb; /* Number of attached databases */
  120865. const char *zDbMain; /* Schema name of database to vacuum */
  120866. if( !db->autoCommit ){
  120867. sqlite3SetString(pzErrMsg, db, "cannot VACUUM from within a transaction");
  120868. return SQLITE_ERROR;
  120869. }
  120870. if( db->nVdbeActive>1 ){
  120871. sqlite3SetString(pzErrMsg, db,"cannot VACUUM - SQL statements in progress");
  120872. return SQLITE_ERROR;
  120873. }
  120874. /* Save the current value of the database flags so that it can be
  120875. ** restored before returning. Then set the writable-schema flag, and
  120876. ** disable CHECK and foreign key constraints. */
  120877. saved_flags = db->flags;
  120878. saved_mDbFlags = db->mDbFlags;
  120879. saved_nChange = db->nChange;
  120880. saved_nTotalChange = db->nTotalChange;
  120881. saved_mTrace = db->mTrace;
  120882. db->flags |= SQLITE_WriteSchema | SQLITE_IgnoreChecks;
  120883. db->mDbFlags |= DBFLAG_PreferBuiltin | DBFLAG_Vacuum;
  120884. db->flags &= ~(SQLITE_ForeignKeys | SQLITE_ReverseOrder | SQLITE_CountRows);
  120885. db->mTrace = 0;
  120886. zDbMain = db->aDb[iDb].zDbSName;
  120887. pMain = db->aDb[iDb].pBt;
  120888. isMemDb = sqlite3PagerIsMemdb(sqlite3BtreePager(pMain));
  120889. /* Attach the temporary database as 'vacuum_db'. The synchronous pragma
  120890. ** can be set to 'off' for this file, as it is not recovered if a crash
  120891. ** occurs anyway. The integrity of the database is maintained by a
  120892. ** (possibly synchronous) transaction opened on the main database before
  120893. ** sqlite3BtreeCopyFile() is called.
  120894. **
  120895. ** An optimisation would be to use a non-journaled pager.
  120896. ** (Later:) I tried setting "PRAGMA vacuum_db.journal_mode=OFF" but
  120897. ** that actually made the VACUUM run slower. Very little journalling
  120898. ** actually occurs when doing a vacuum since the vacuum_db is initially
  120899. ** empty. Only the journal header is written. Apparently it takes more
  120900. ** time to parse and run the PRAGMA to turn journalling off than it does
  120901. ** to write the journal header file.
  120902. */
  120903. nDb = db->nDb;
  120904. rc = execSql(db, pzErrMsg, "ATTACH''AS vacuum_db");
  120905. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  120906. assert( (db->nDb-1)==nDb );
  120907. pDb = &db->aDb[nDb];
  120908. assert( strcmp(pDb->zDbSName,"vacuum_db")==0 );
  120909. pTemp = pDb->pBt;
  120910. /* The call to execSql() to attach the temp database has left the file
  120911. ** locked (as there was more than one active statement when the transaction
  120912. ** to read the schema was concluded. Unlock it here so that this doesn't
  120913. ** cause problems for the call to BtreeSetPageSize() below. */
  120914. sqlite3BtreeCommit(pTemp);
  120915. nRes = sqlite3BtreeGetOptimalReserve(pMain);
  120916. /* A VACUUM cannot change the pagesize of an encrypted database. */
  120917. #ifdef SQLITE_HAS_CODEC
  120918. if( db->nextPagesize ){
  120919. extern void sqlite3CodecGetKey(sqlite3*, int, void**, int*);
  120920. int nKey;
  120921. char *zKey;
  120922. sqlite3CodecGetKey(db, iDb, (void**)&zKey, &nKey);
  120923. if( nKey ) db->nextPagesize = 0;
  120924. }
  120925. #endif
  120926. sqlite3BtreeSetCacheSize(pTemp, db->aDb[iDb].pSchema->cache_size);
  120927. sqlite3BtreeSetSpillSize(pTemp, sqlite3BtreeSetSpillSize(pMain,0));
  120928. sqlite3BtreeSetPagerFlags(pTemp, PAGER_SYNCHRONOUS_OFF|PAGER_CACHESPILL);
  120929. /* Begin a transaction and take an exclusive lock on the main database
  120930. ** file. This is done before the sqlite3BtreeGetPageSize(pMain) call below,
  120931. ** to ensure that we do not try to change the page-size on a WAL database.
  120932. */
  120933. rc = execSql(db, pzErrMsg, "BEGIN");
  120934. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  120935. rc = sqlite3BtreeBeginTrans(pMain, 2);
  120936. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  120937. /* Do not attempt to change the page size for a WAL database */
  120938. if( sqlite3PagerGetJournalMode(sqlite3BtreePager(pMain))
  120939. ==PAGER_JOURNALMODE_WAL ){
  120940. db->nextPagesize = 0;
  120941. }
  120942. if( sqlite3BtreeSetPageSize(pTemp, sqlite3BtreeGetPageSize(pMain), nRes, 0)
  120943. || (!isMemDb && sqlite3BtreeSetPageSize(pTemp, db->nextPagesize, nRes, 0))
  120944. || NEVER(db->mallocFailed)
  120945. ){
  120946. rc = SQLITE_NOMEM_BKPT;
  120947. goto end_of_vacuum;
  120948. }
  120949. #ifndef SQLITE_OMIT_AUTOVACUUM
  120950. sqlite3BtreeSetAutoVacuum(pTemp, db->nextAutovac>=0 ? db->nextAutovac :
  120951. sqlite3BtreeGetAutoVacuum(pMain));
  120952. #endif
  120953. /* Query the schema of the main database. Create a mirror schema
  120954. ** in the temporary database.
  120955. */
  120956. db->init.iDb = nDb; /* force new CREATE statements into vacuum_db */
  120957. rc = execSqlF(db, pzErrMsg,
  120958. "SELECT sql FROM \"%w\".sqlite_master"
  120959. " WHERE type='table'AND name<>'sqlite_sequence'"
  120960. " AND coalesce(rootpage,1)>0",
  120961. zDbMain
  120962. );
  120963. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  120964. rc = execSqlF(db, pzErrMsg,
  120965. "SELECT sql FROM \"%w\".sqlite_master"
  120966. " WHERE type='index' AND length(sql)>10",
  120967. zDbMain
  120968. );
  120969. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  120970. db->init.iDb = 0;
  120971. /* Loop through the tables in the main database. For each, do
  120972. ** an "INSERT INTO vacuum_db.xxx SELECT * FROM main.xxx;" to copy
  120973. ** the contents to the temporary database.
  120974. */
  120975. rc = execSqlF(db, pzErrMsg,
  120976. "SELECT'INSERT INTO vacuum_db.'||quote(name)"
  120977. "||' SELECT*FROM\"%w\".'||quote(name)"
  120978. "FROM vacuum_db.sqlite_master "
  120979. "WHERE type='table'AND coalesce(rootpage,1)>0",
  120980. zDbMain
  120981. );
  120982. assert( (db->mDbFlags & DBFLAG_Vacuum)!=0 );
  120983. db->mDbFlags &= ~DBFLAG_Vacuum;
  120984. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  120985. /* Copy the triggers, views, and virtual tables from the main database
  120986. ** over to the temporary database. None of these objects has any
  120987. ** associated storage, so all we have to do is copy their entries
  120988. ** from the SQLITE_MASTER table.
  120989. */
  120990. rc = execSqlF(db, pzErrMsg,
  120991. "INSERT INTO vacuum_db.sqlite_master"
  120992. " SELECT*FROM \"%w\".sqlite_master"
  120993. " WHERE type IN('view','trigger')"
  120994. " OR(type='table'AND rootpage=0)",
  120995. zDbMain
  120996. );
  120997. if( rc ) goto end_of_vacuum;
  120998. /* At this point, there is a write transaction open on both the
  120999. ** vacuum database and the main database. Assuming no error occurs,
  121000. ** both transactions are closed by this block - the main database
  121001. ** transaction by sqlite3BtreeCopyFile() and the other by an explicit
  121002. ** call to sqlite3BtreeCommit().
  121003. */
  121004. {
  121005. u32 meta;
  121006. int i;
  121007. /* This array determines which meta meta values are preserved in the
  121008. ** vacuum. Even entries are the meta value number and odd entries
  121009. ** are an increment to apply to the meta value after the vacuum.
  121010. ** The increment is used to increase the schema cookie so that other
  121011. ** connections to the same database will know to reread the schema.
  121012. */
  121013. static const unsigned char aCopy[] = {
  121014. BTREE_SCHEMA_VERSION, 1, /* Add one to the old schema cookie */
  121015. BTREE_DEFAULT_CACHE_SIZE, 0, /* Preserve the default page cache size */
  121016. BTREE_TEXT_ENCODING, 0, /* Preserve the text encoding */
  121017. BTREE_USER_VERSION, 0, /* Preserve the user version */
  121018. BTREE_APPLICATION_ID, 0, /* Preserve the application id */
  121019. };
  121020. assert( 1==sqlite3BtreeIsInTrans(pTemp) );
  121021. assert( 1==sqlite3BtreeIsInTrans(pMain) );
  121022. /* Copy Btree meta values */
  121023. for(i=0; i<ArraySize(aCopy); i+=2){
  121024. /* GetMeta() and UpdateMeta() cannot fail in this context because
  121025. ** we already have page 1 loaded into cache and marked dirty. */
  121026. sqlite3BtreeGetMeta(pMain, aCopy[i], &meta);
  121027. rc = sqlite3BtreeUpdateMeta(pTemp, aCopy[i], meta+aCopy[i+1]);
  121028. if( NEVER(rc!=SQLITE_OK) ) goto end_of_vacuum;
  121029. }
  121030. rc = sqlite3BtreeCopyFile(pMain, pTemp);
  121031. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  121032. rc = sqlite3BtreeCommit(pTemp);
  121033. if( rc!=SQLITE_OK ) goto end_of_vacuum;
  121034. #ifndef SQLITE_OMIT_AUTOVACUUM
  121035. sqlite3BtreeSetAutoVacuum(pMain, sqlite3BtreeGetAutoVacuum(pTemp));
  121036. #endif
  121037. }
  121038. assert( rc==SQLITE_OK );
  121039. rc = sqlite3BtreeSetPageSize(pMain, sqlite3BtreeGetPageSize(pTemp), nRes,1);
  121040. end_of_vacuum:
  121041. /* Restore the original value of db->flags */
  121042. db->init.iDb = 0;
  121043. db->mDbFlags = saved_mDbFlags;
  121044. db->flags = saved_flags;
  121045. db->nChange = saved_nChange;
  121046. db->nTotalChange = saved_nTotalChange;
  121047. db->mTrace = saved_mTrace;
  121048. sqlite3BtreeSetPageSize(pMain, -1, -1, 1);
  121049. /* Currently there is an SQL level transaction open on the vacuum
  121050. ** database. No locks are held on any other files (since the main file
  121051. ** was committed at the btree level). So it safe to end the transaction
  121052. ** by manually setting the autoCommit flag to true and detaching the
  121053. ** vacuum database. The vacuum_db journal file is deleted when the pager
  121054. ** is closed by the DETACH.
  121055. */
  121056. db->autoCommit = 1;
  121057. if( pDb ){
  121058. sqlite3BtreeClose(pDb->pBt);
  121059. pDb->pBt = 0;
  121060. pDb->pSchema = 0;
  121061. }
  121062. /* This both clears the schemas and reduces the size of the db->aDb[]
  121063. ** array. */
  121064. sqlite3ResetAllSchemasOfConnection(db);
  121065. return rc;
  121066. }
  121067. #endif /* SQLITE_OMIT_VACUUM && SQLITE_OMIT_ATTACH */
  121068. /************** End of vacuum.c **********************************************/
  121069. /************** Begin file vtab.c ********************************************/
  121070. /*
  121071. ** 2006 June 10
  121072. **
  121073. ** The author disclaims copyright to this source code. In place of
  121074. ** a legal notice, here is a blessing:
  121075. **
  121076. ** May you do good and not evil.
  121077. ** May you find forgiveness for yourself and forgive others.
  121078. ** May you share freely, never taking more than you give.
  121079. **
  121080. *************************************************************************
  121081. ** This file contains code used to help implement virtual tables.
  121082. */
  121083. #ifndef SQLITE_OMIT_VIRTUALTABLE
  121084. /* #include "sqliteInt.h" */
  121085. /*
  121086. ** Before a virtual table xCreate() or xConnect() method is invoked, the
  121087. ** sqlite3.pVtabCtx member variable is set to point to an instance of
  121088. ** this struct allocated on the stack. It is used by the implementation of
  121089. ** the sqlite3_declare_vtab() and sqlite3_vtab_config() APIs, both of which
  121090. ** are invoked only from within xCreate and xConnect methods.
  121091. */
  121092. struct VtabCtx {
  121093. VTable *pVTable; /* The virtual table being constructed */
  121094. Table *pTab; /* The Table object to which the virtual table belongs */
  121095. VtabCtx *pPrior; /* Parent context (if any) */
  121096. int bDeclared; /* True after sqlite3_declare_vtab() is called */
  121097. };
  121098. /*
  121099. ** Construct and install a Module object for a virtual table. When this
  121100. ** routine is called, it is guaranteed that all appropriate locks are held
  121101. ** and the module is not already part of the connection.
  121102. */
  121103. SQLITE_PRIVATE Module *sqlite3VtabCreateModule(
  121104. sqlite3 *db, /* Database in which module is registered */
  121105. const char *zName, /* Name assigned to this module */
  121106. const sqlite3_module *pModule, /* The definition of the module */
  121107. void *pAux, /* Context pointer for xCreate/xConnect */
  121108. void (*xDestroy)(void *) /* Module destructor function */
  121109. ){
  121110. Module *pMod;
  121111. int nName = sqlite3Strlen30(zName);
  121112. pMod = (Module *)sqlite3Malloc(sizeof(Module) + nName + 1);
  121113. if( pMod==0 ){
  121114. sqlite3OomFault(db);
  121115. }else{
  121116. Module *pDel;
  121117. char *zCopy = (char *)(&pMod[1]);
  121118. memcpy(zCopy, zName, nName+1);
  121119. pMod->zName = zCopy;
  121120. pMod->pModule = pModule;
  121121. pMod->pAux = pAux;
  121122. pMod->xDestroy = xDestroy;
  121123. pMod->pEpoTab = 0;
  121124. pDel = (Module *)sqlite3HashInsert(&db->aModule,zCopy,(void*)pMod);
  121125. assert( pDel==0 || pDel==pMod );
  121126. if( pDel ){
  121127. sqlite3OomFault(db);
  121128. sqlite3DbFree(db, pDel);
  121129. pMod = 0;
  121130. }
  121131. }
  121132. return pMod;
  121133. }
  121134. /*
  121135. ** The actual function that does the work of creating a new module.
  121136. ** This function implements the sqlite3_create_module() and
  121137. ** sqlite3_create_module_v2() interfaces.
  121138. */
  121139. static int createModule(
  121140. sqlite3 *db, /* Database in which module is registered */
  121141. const char *zName, /* Name assigned to this module */
  121142. const sqlite3_module *pModule, /* The definition of the module */
  121143. void *pAux, /* Context pointer for xCreate/xConnect */
  121144. void (*xDestroy)(void *) /* Module destructor function */
  121145. ){
  121146. int rc = SQLITE_OK;
  121147. sqlite3_mutex_enter(db->mutex);
  121148. if( sqlite3HashFind(&db->aModule, zName) ){
  121149. rc = SQLITE_MISUSE_BKPT;
  121150. }else{
  121151. (void)sqlite3VtabCreateModule(db, zName, pModule, pAux, xDestroy);
  121152. }
  121153. rc = sqlite3ApiExit(db, rc);
  121154. if( rc!=SQLITE_OK && xDestroy ) xDestroy(pAux);
  121155. sqlite3_mutex_leave(db->mutex);
  121156. return rc;
  121157. }
  121158. /*
  121159. ** External API function used to create a new virtual-table module.
  121160. */
  121161. SQLITE_API int sqlite3_create_module(
  121162. sqlite3 *db, /* Database in which module is registered */
  121163. const char *zName, /* Name assigned to this module */
  121164. const sqlite3_module *pModule, /* The definition of the module */
  121165. void *pAux /* Context pointer for xCreate/xConnect */
  121166. ){
  121167. #ifdef SQLITE_ENABLE_API_ARMOR
  121168. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  121169. #endif
  121170. return createModule(db, zName, pModule, pAux, 0);
  121171. }
  121172. /*
  121173. ** External API function used to create a new virtual-table module.
  121174. */
  121175. SQLITE_API int sqlite3_create_module_v2(
  121176. sqlite3 *db, /* Database in which module is registered */
  121177. const char *zName, /* Name assigned to this module */
  121178. const sqlite3_module *pModule, /* The definition of the module */
  121179. void *pAux, /* Context pointer for xCreate/xConnect */
  121180. void (*xDestroy)(void *) /* Module destructor function */
  121181. ){
  121182. #ifdef SQLITE_ENABLE_API_ARMOR
  121183. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  121184. #endif
  121185. return createModule(db, zName, pModule, pAux, xDestroy);
  121186. }
  121187. /*
  121188. ** Lock the virtual table so that it cannot be disconnected.
  121189. ** Locks nest. Every lock should have a corresponding unlock.
  121190. ** If an unlock is omitted, resources leaks will occur.
  121191. **
  121192. ** If a disconnect is attempted while a virtual table is locked,
  121193. ** the disconnect is deferred until all locks have been removed.
  121194. */
  121195. SQLITE_PRIVATE void sqlite3VtabLock(VTable *pVTab){
  121196. pVTab->nRef++;
  121197. }
  121198. /*
  121199. ** pTab is a pointer to a Table structure representing a virtual-table.
  121200. ** Return a pointer to the VTable object used by connection db to access
  121201. ** this virtual-table, if one has been created, or NULL otherwise.
  121202. */
  121203. SQLITE_PRIVATE VTable *sqlite3GetVTable(sqlite3 *db, Table *pTab){
  121204. VTable *pVtab;
  121205. assert( IsVirtual(pTab) );
  121206. for(pVtab=pTab->pVTable; pVtab && pVtab->db!=db; pVtab=pVtab->pNext);
  121207. return pVtab;
  121208. }
  121209. /*
  121210. ** Decrement the ref-count on a virtual table object. When the ref-count
  121211. ** reaches zero, call the xDisconnect() method to delete the object.
  121212. */
  121213. SQLITE_PRIVATE void sqlite3VtabUnlock(VTable *pVTab){
  121214. sqlite3 *db = pVTab->db;
  121215. assert( db );
  121216. assert( pVTab->nRef>0 );
  121217. assert( db->magic==SQLITE_MAGIC_OPEN || db->magic==SQLITE_MAGIC_ZOMBIE );
  121218. pVTab->nRef--;
  121219. if( pVTab->nRef==0 ){
  121220. sqlite3_vtab *p = pVTab->pVtab;
  121221. if( p ){
  121222. p->pModule->xDisconnect(p);
  121223. }
  121224. sqlite3DbFree(db, pVTab);
  121225. }
  121226. }
  121227. /*
  121228. ** Table p is a virtual table. This function moves all elements in the
  121229. ** p->pVTable list to the sqlite3.pDisconnect lists of their associated
  121230. ** database connections to be disconnected at the next opportunity.
  121231. ** Except, if argument db is not NULL, then the entry associated with
  121232. ** connection db is left in the p->pVTable list.
  121233. */
  121234. static VTable *vtabDisconnectAll(sqlite3 *db, Table *p){
  121235. VTable *pRet = 0;
  121236. VTable *pVTable = p->pVTable;
  121237. p->pVTable = 0;
  121238. /* Assert that the mutex (if any) associated with the BtShared database
  121239. ** that contains table p is held by the caller. See header comments
  121240. ** above function sqlite3VtabUnlockList() for an explanation of why
  121241. ** this makes it safe to access the sqlite3.pDisconnect list of any
  121242. ** database connection that may have an entry in the p->pVTable list.
  121243. */
  121244. assert( db==0 || sqlite3SchemaMutexHeld(db, 0, p->pSchema) );
  121245. while( pVTable ){
  121246. sqlite3 *db2 = pVTable->db;
  121247. VTable *pNext = pVTable->pNext;
  121248. assert( db2 );
  121249. if( db2==db ){
  121250. pRet = pVTable;
  121251. p->pVTable = pRet;
  121252. pRet->pNext = 0;
  121253. }else{
  121254. pVTable->pNext = db2->pDisconnect;
  121255. db2->pDisconnect = pVTable;
  121256. }
  121257. pVTable = pNext;
  121258. }
  121259. assert( !db || pRet );
  121260. return pRet;
  121261. }
  121262. /*
  121263. ** Table *p is a virtual table. This function removes the VTable object
  121264. ** for table *p associated with database connection db from the linked
  121265. ** list in p->pVTab. It also decrements the VTable ref count. This is
  121266. ** used when closing database connection db to free all of its VTable
  121267. ** objects without disturbing the rest of the Schema object (which may
  121268. ** be being used by other shared-cache connections).
  121269. */
  121270. SQLITE_PRIVATE void sqlite3VtabDisconnect(sqlite3 *db, Table *p){
  121271. VTable **ppVTab;
  121272. assert( IsVirtual(p) );
  121273. assert( sqlite3BtreeHoldsAllMutexes(db) );
  121274. assert( sqlite3_mutex_held(db->mutex) );
  121275. for(ppVTab=&p->pVTable; *ppVTab; ppVTab=&(*ppVTab)->pNext){
  121276. if( (*ppVTab)->db==db ){
  121277. VTable *pVTab = *ppVTab;
  121278. *ppVTab = pVTab->pNext;
  121279. sqlite3VtabUnlock(pVTab);
  121280. break;
  121281. }
  121282. }
  121283. }
  121284. /*
  121285. ** Disconnect all the virtual table objects in the sqlite3.pDisconnect list.
  121286. **
  121287. ** This function may only be called when the mutexes associated with all
  121288. ** shared b-tree databases opened using connection db are held by the
  121289. ** caller. This is done to protect the sqlite3.pDisconnect list. The
  121290. ** sqlite3.pDisconnect list is accessed only as follows:
  121291. **
  121292. ** 1) By this function. In this case, all BtShared mutexes and the mutex
  121293. ** associated with the database handle itself must be held.
  121294. **
  121295. ** 2) By function vtabDisconnectAll(), when it adds a VTable entry to
  121296. ** the sqlite3.pDisconnect list. In this case either the BtShared mutex
  121297. ** associated with the database the virtual table is stored in is held
  121298. ** or, if the virtual table is stored in a non-sharable database, then
  121299. ** the database handle mutex is held.
  121300. **
  121301. ** As a result, a sqlite3.pDisconnect cannot be accessed simultaneously
  121302. ** by multiple threads. It is thread-safe.
  121303. */
  121304. SQLITE_PRIVATE void sqlite3VtabUnlockList(sqlite3 *db){
  121305. VTable *p = db->pDisconnect;
  121306. db->pDisconnect = 0;
  121307. assert( sqlite3BtreeHoldsAllMutexes(db) );
  121308. assert( sqlite3_mutex_held(db->mutex) );
  121309. if( p ){
  121310. sqlite3ExpirePreparedStatements(db);
  121311. do {
  121312. VTable *pNext = p->pNext;
  121313. sqlite3VtabUnlock(p);
  121314. p = pNext;
  121315. }while( p );
  121316. }
  121317. }
  121318. /*
  121319. ** Clear any and all virtual-table information from the Table record.
  121320. ** This routine is called, for example, just before deleting the Table
  121321. ** record.
  121322. **
  121323. ** Since it is a virtual-table, the Table structure contains a pointer
  121324. ** to the head of a linked list of VTable structures. Each VTable
  121325. ** structure is associated with a single sqlite3* user of the schema.
  121326. ** The reference count of the VTable structure associated with database
  121327. ** connection db is decremented immediately (which may lead to the
  121328. ** structure being xDisconnected and free). Any other VTable structures
  121329. ** in the list are moved to the sqlite3.pDisconnect list of the associated
  121330. ** database connection.
  121331. */
  121332. SQLITE_PRIVATE void sqlite3VtabClear(sqlite3 *db, Table *p){
  121333. if( !db || db->pnBytesFreed==0 ) vtabDisconnectAll(0, p);
  121334. if( p->azModuleArg ){
  121335. int i;
  121336. for(i=0; i<p->nModuleArg; i++){
  121337. if( i!=1 ) sqlite3DbFree(db, p->azModuleArg[i]);
  121338. }
  121339. sqlite3DbFree(db, p->azModuleArg);
  121340. }
  121341. }
  121342. /*
  121343. ** Add a new module argument to pTable->azModuleArg[].
  121344. ** The string is not copied - the pointer is stored. The
  121345. ** string will be freed automatically when the table is
  121346. ** deleted.
  121347. */
  121348. static void addModuleArgument(sqlite3 *db, Table *pTable, char *zArg){
  121349. int nBytes = sizeof(char *)*(2+pTable->nModuleArg);
  121350. char **azModuleArg;
  121351. azModuleArg = sqlite3DbRealloc(db, pTable->azModuleArg, nBytes);
  121352. if( azModuleArg==0 ){
  121353. sqlite3DbFree(db, zArg);
  121354. }else{
  121355. int i = pTable->nModuleArg++;
  121356. azModuleArg[i] = zArg;
  121357. azModuleArg[i+1] = 0;
  121358. pTable->azModuleArg = azModuleArg;
  121359. }
  121360. }
  121361. /*
  121362. ** The parser calls this routine when it first sees a CREATE VIRTUAL TABLE
  121363. ** statement. The module name has been parsed, but the optional list
  121364. ** of parameters that follow the module name are still pending.
  121365. */
  121366. SQLITE_PRIVATE void sqlite3VtabBeginParse(
  121367. Parse *pParse, /* Parsing context */
  121368. Token *pName1, /* Name of new table, or database name */
  121369. Token *pName2, /* Name of new table or NULL */
  121370. Token *pModuleName, /* Name of the module for the virtual table */
  121371. int ifNotExists /* No error if the table already exists */
  121372. ){
  121373. int iDb; /* The database the table is being created in */
  121374. Table *pTable; /* The new virtual table */
  121375. sqlite3 *db; /* Database connection */
  121376. sqlite3StartTable(pParse, pName1, pName2, 0, 0, 1, ifNotExists);
  121377. pTable = pParse->pNewTable;
  121378. if( pTable==0 ) return;
  121379. assert( 0==pTable->pIndex );
  121380. db = pParse->db;
  121381. iDb = sqlite3SchemaToIndex(db, pTable->pSchema);
  121382. assert( iDb>=0 );
  121383. assert( pTable->nModuleArg==0 );
  121384. addModuleArgument(db, pTable, sqlite3NameFromToken(db, pModuleName));
  121385. addModuleArgument(db, pTable, 0);
  121386. addModuleArgument(db, pTable, sqlite3DbStrDup(db, pTable->zName));
  121387. assert( (pParse->sNameToken.z==pName2->z && pName2->z!=0)
  121388. || (pParse->sNameToken.z==pName1->z && pName2->z==0)
  121389. );
  121390. pParse->sNameToken.n = (int)(
  121391. &pModuleName->z[pModuleName->n] - pParse->sNameToken.z
  121392. );
  121393. #ifndef SQLITE_OMIT_AUTHORIZATION
  121394. /* Creating a virtual table invokes the authorization callback twice.
  121395. ** The first invocation, to obtain permission to INSERT a row into the
  121396. ** sqlite_master table, has already been made by sqlite3StartTable().
  121397. ** The second call, to obtain permission to create the table, is made now.
  121398. */
  121399. if( pTable->azModuleArg ){
  121400. sqlite3AuthCheck(pParse, SQLITE_CREATE_VTABLE, pTable->zName,
  121401. pTable->azModuleArg[0], pParse->db->aDb[iDb].zDbSName);
  121402. }
  121403. #endif
  121404. }
  121405. /*
  121406. ** This routine takes the module argument that has been accumulating
  121407. ** in pParse->zArg[] and appends it to the list of arguments on the
  121408. ** virtual table currently under construction in pParse->pTable.
  121409. */
  121410. static void addArgumentToVtab(Parse *pParse){
  121411. if( pParse->sArg.z && pParse->pNewTable ){
  121412. const char *z = (const char*)pParse->sArg.z;
  121413. int n = pParse->sArg.n;
  121414. sqlite3 *db = pParse->db;
  121415. addModuleArgument(db, pParse->pNewTable, sqlite3DbStrNDup(db, z, n));
  121416. }
  121417. }
  121418. /*
  121419. ** The parser calls this routine after the CREATE VIRTUAL TABLE statement
  121420. ** has been completely parsed.
  121421. */
  121422. SQLITE_PRIVATE void sqlite3VtabFinishParse(Parse *pParse, Token *pEnd){
  121423. Table *pTab = pParse->pNewTable; /* The table being constructed */
  121424. sqlite3 *db = pParse->db; /* The database connection */
  121425. if( pTab==0 ) return;
  121426. addArgumentToVtab(pParse);
  121427. pParse->sArg.z = 0;
  121428. if( pTab->nModuleArg<1 ) return;
  121429. /* If the CREATE VIRTUAL TABLE statement is being entered for the
  121430. ** first time (in other words if the virtual table is actually being
  121431. ** created now instead of just being read out of sqlite_master) then
  121432. ** do additional initialization work and store the statement text
  121433. ** in the sqlite_master table.
  121434. */
  121435. if( !db->init.busy ){
  121436. char *zStmt;
  121437. char *zWhere;
  121438. int iDb;
  121439. int iReg;
  121440. Vdbe *v;
  121441. /* Compute the complete text of the CREATE VIRTUAL TABLE statement */
  121442. if( pEnd ){
  121443. pParse->sNameToken.n = (int)(pEnd->z - pParse->sNameToken.z) + pEnd->n;
  121444. }
  121445. zStmt = sqlite3MPrintf(db, "CREATE VIRTUAL TABLE %T", &pParse->sNameToken);
  121446. /* A slot for the record has already been allocated in the
  121447. ** SQLITE_MASTER table. We just need to update that slot with all
  121448. ** the information we've collected.
  121449. **
  121450. ** The VM register number pParse->regRowid holds the rowid of an
  121451. ** entry in the sqlite_master table tht was created for this vtab
  121452. ** by sqlite3StartTable().
  121453. */
  121454. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  121455. sqlite3NestedParse(pParse,
  121456. "UPDATE %Q.%s "
  121457. "SET type='table', name=%Q, tbl_name=%Q, rootpage=0, sql=%Q "
  121458. "WHERE rowid=#%d",
  121459. db->aDb[iDb].zDbSName, MASTER_NAME,
  121460. pTab->zName,
  121461. pTab->zName,
  121462. zStmt,
  121463. pParse->regRowid
  121464. );
  121465. sqlite3DbFree(db, zStmt);
  121466. v = sqlite3GetVdbe(pParse);
  121467. sqlite3ChangeCookie(pParse, iDb);
  121468. sqlite3VdbeAddOp0(v, OP_Expire);
  121469. zWhere = sqlite3MPrintf(db, "name='%q' AND type='table'", pTab->zName);
  121470. sqlite3VdbeAddParseSchemaOp(v, iDb, zWhere);
  121471. iReg = ++pParse->nMem;
  121472. sqlite3VdbeLoadString(v, iReg, pTab->zName);
  121473. sqlite3VdbeAddOp2(v, OP_VCreate, iDb, iReg);
  121474. }
  121475. /* If we are rereading the sqlite_master table create the in-memory
  121476. ** record of the table. The xConnect() method is not called until
  121477. ** the first time the virtual table is used in an SQL statement. This
  121478. ** allows a schema that contains virtual tables to be loaded before
  121479. ** the required virtual table implementations are registered. */
  121480. else {
  121481. Table *pOld;
  121482. Schema *pSchema = pTab->pSchema;
  121483. const char *zName = pTab->zName;
  121484. assert( sqlite3SchemaMutexHeld(db, 0, pSchema) );
  121485. pOld = sqlite3HashInsert(&pSchema->tblHash, zName, pTab);
  121486. if( pOld ){
  121487. sqlite3OomFault(db);
  121488. assert( pTab==pOld ); /* Malloc must have failed inside HashInsert() */
  121489. return;
  121490. }
  121491. pParse->pNewTable = 0;
  121492. }
  121493. }
  121494. /*
  121495. ** The parser calls this routine when it sees the first token
  121496. ** of an argument to the module name in a CREATE VIRTUAL TABLE statement.
  121497. */
  121498. SQLITE_PRIVATE void sqlite3VtabArgInit(Parse *pParse){
  121499. addArgumentToVtab(pParse);
  121500. pParse->sArg.z = 0;
  121501. pParse->sArg.n = 0;
  121502. }
  121503. /*
  121504. ** The parser calls this routine for each token after the first token
  121505. ** in an argument to the module name in a CREATE VIRTUAL TABLE statement.
  121506. */
  121507. SQLITE_PRIVATE void sqlite3VtabArgExtend(Parse *pParse, Token *p){
  121508. Token *pArg = &pParse->sArg;
  121509. if( pArg->z==0 ){
  121510. pArg->z = p->z;
  121511. pArg->n = p->n;
  121512. }else{
  121513. assert(pArg->z <= p->z);
  121514. pArg->n = (int)(&p->z[p->n] - pArg->z);
  121515. }
  121516. }
  121517. /*
  121518. ** Invoke a virtual table constructor (either xCreate or xConnect). The
  121519. ** pointer to the function to invoke is passed as the fourth parameter
  121520. ** to this procedure.
  121521. */
  121522. static int vtabCallConstructor(
  121523. sqlite3 *db,
  121524. Table *pTab,
  121525. Module *pMod,
  121526. int (*xConstruct)(sqlite3*,void*,int,const char*const*,sqlite3_vtab**,char**),
  121527. char **pzErr
  121528. ){
  121529. VtabCtx sCtx;
  121530. VTable *pVTable;
  121531. int rc;
  121532. const char *const*azArg = (const char *const*)pTab->azModuleArg;
  121533. int nArg = pTab->nModuleArg;
  121534. char *zErr = 0;
  121535. char *zModuleName;
  121536. int iDb;
  121537. VtabCtx *pCtx;
  121538. /* Check that the virtual-table is not already being initialized */
  121539. for(pCtx=db->pVtabCtx; pCtx; pCtx=pCtx->pPrior){
  121540. if( pCtx->pTab==pTab ){
  121541. *pzErr = sqlite3MPrintf(db,
  121542. "vtable constructor called recursively: %s", pTab->zName
  121543. );
  121544. return SQLITE_LOCKED;
  121545. }
  121546. }
  121547. zModuleName = sqlite3DbStrDup(db, pTab->zName);
  121548. if( !zModuleName ){
  121549. return SQLITE_NOMEM_BKPT;
  121550. }
  121551. pVTable = sqlite3MallocZero(sizeof(VTable));
  121552. if( !pVTable ){
  121553. sqlite3OomFault(db);
  121554. sqlite3DbFree(db, zModuleName);
  121555. return SQLITE_NOMEM_BKPT;
  121556. }
  121557. pVTable->db = db;
  121558. pVTable->pMod = pMod;
  121559. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  121560. pTab->azModuleArg[1] = db->aDb[iDb].zDbSName;
  121561. /* Invoke the virtual table constructor */
  121562. assert( &db->pVtabCtx );
  121563. assert( xConstruct );
  121564. sCtx.pTab = pTab;
  121565. sCtx.pVTable = pVTable;
  121566. sCtx.pPrior = db->pVtabCtx;
  121567. sCtx.bDeclared = 0;
  121568. db->pVtabCtx = &sCtx;
  121569. rc = xConstruct(db, pMod->pAux, nArg, azArg, &pVTable->pVtab, &zErr);
  121570. db->pVtabCtx = sCtx.pPrior;
  121571. if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
  121572. assert( sCtx.pTab==pTab );
  121573. if( SQLITE_OK!=rc ){
  121574. if( zErr==0 ){
  121575. *pzErr = sqlite3MPrintf(db, "vtable constructor failed: %s", zModuleName);
  121576. }else {
  121577. *pzErr = sqlite3MPrintf(db, "%s", zErr);
  121578. sqlite3_free(zErr);
  121579. }
  121580. sqlite3DbFree(db, pVTable);
  121581. }else if( ALWAYS(pVTable->pVtab) ){
  121582. /* Justification of ALWAYS(): A correct vtab constructor must allocate
  121583. ** the sqlite3_vtab object if successful. */
  121584. memset(pVTable->pVtab, 0, sizeof(pVTable->pVtab[0]));
  121585. pVTable->pVtab->pModule = pMod->pModule;
  121586. pVTable->nRef = 1;
  121587. if( sCtx.bDeclared==0 ){
  121588. const char *zFormat = "vtable constructor did not declare schema: %s";
  121589. *pzErr = sqlite3MPrintf(db, zFormat, pTab->zName);
  121590. sqlite3VtabUnlock(pVTable);
  121591. rc = SQLITE_ERROR;
  121592. }else{
  121593. int iCol;
  121594. u8 oooHidden = 0;
  121595. /* If everything went according to plan, link the new VTable structure
  121596. ** into the linked list headed by pTab->pVTable. Then loop through the
  121597. ** columns of the table to see if any of them contain the token "hidden".
  121598. ** If so, set the Column COLFLAG_HIDDEN flag and remove the token from
  121599. ** the type string. */
  121600. pVTable->pNext = pTab->pVTable;
  121601. pTab->pVTable = pVTable;
  121602. for(iCol=0; iCol<pTab->nCol; iCol++){
  121603. char *zType = sqlite3ColumnType(&pTab->aCol[iCol], "");
  121604. int nType;
  121605. int i = 0;
  121606. nType = sqlite3Strlen30(zType);
  121607. for(i=0; i<nType; i++){
  121608. if( 0==sqlite3StrNICmp("hidden", &zType[i], 6)
  121609. && (i==0 || zType[i-1]==' ')
  121610. && (zType[i+6]=='\0' || zType[i+6]==' ')
  121611. ){
  121612. break;
  121613. }
  121614. }
  121615. if( i<nType ){
  121616. int j;
  121617. int nDel = 6 + (zType[i+6] ? 1 : 0);
  121618. for(j=i; (j+nDel)<=nType; j++){
  121619. zType[j] = zType[j+nDel];
  121620. }
  121621. if( zType[i]=='\0' && i>0 ){
  121622. assert(zType[i-1]==' ');
  121623. zType[i-1] = '\0';
  121624. }
  121625. pTab->aCol[iCol].colFlags |= COLFLAG_HIDDEN;
  121626. oooHidden = TF_OOOHidden;
  121627. }else{
  121628. pTab->tabFlags |= oooHidden;
  121629. }
  121630. }
  121631. }
  121632. }
  121633. sqlite3DbFree(db, zModuleName);
  121634. return rc;
  121635. }
  121636. /*
  121637. ** This function is invoked by the parser to call the xConnect() method
  121638. ** of the virtual table pTab. If an error occurs, an error code is returned
  121639. ** and an error left in pParse.
  121640. **
  121641. ** This call is a no-op if table pTab is not a virtual table.
  121642. */
  121643. SQLITE_PRIVATE int sqlite3VtabCallConnect(Parse *pParse, Table *pTab){
  121644. sqlite3 *db = pParse->db;
  121645. const char *zMod;
  121646. Module *pMod;
  121647. int rc;
  121648. assert( pTab );
  121649. if( !IsVirtual(pTab) || sqlite3GetVTable(db, pTab) ){
  121650. return SQLITE_OK;
  121651. }
  121652. /* Locate the required virtual table module */
  121653. zMod = pTab->azModuleArg[0];
  121654. pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
  121655. if( !pMod ){
  121656. const char *zModule = pTab->azModuleArg[0];
  121657. sqlite3ErrorMsg(pParse, "no such module: %s", zModule);
  121658. rc = SQLITE_ERROR;
  121659. }else{
  121660. char *zErr = 0;
  121661. rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xConnect, &zErr);
  121662. if( rc!=SQLITE_OK ){
  121663. sqlite3ErrorMsg(pParse, "%s", zErr);
  121664. pParse->rc = rc;
  121665. }
  121666. sqlite3DbFree(db, zErr);
  121667. }
  121668. return rc;
  121669. }
  121670. /*
  121671. ** Grow the db->aVTrans[] array so that there is room for at least one
  121672. ** more v-table. Return SQLITE_NOMEM if a malloc fails, or SQLITE_OK otherwise.
  121673. */
  121674. static int growVTrans(sqlite3 *db){
  121675. const int ARRAY_INCR = 5;
  121676. /* Grow the sqlite3.aVTrans array if required */
  121677. if( (db->nVTrans%ARRAY_INCR)==0 ){
  121678. VTable **aVTrans;
  121679. int nBytes = sizeof(sqlite3_vtab *) * (db->nVTrans + ARRAY_INCR);
  121680. aVTrans = sqlite3DbRealloc(db, (void *)db->aVTrans, nBytes);
  121681. if( !aVTrans ){
  121682. return SQLITE_NOMEM_BKPT;
  121683. }
  121684. memset(&aVTrans[db->nVTrans], 0, sizeof(sqlite3_vtab *)*ARRAY_INCR);
  121685. db->aVTrans = aVTrans;
  121686. }
  121687. return SQLITE_OK;
  121688. }
  121689. /*
  121690. ** Add the virtual table pVTab to the array sqlite3.aVTrans[]. Space should
  121691. ** have already been reserved using growVTrans().
  121692. */
  121693. static void addToVTrans(sqlite3 *db, VTable *pVTab){
  121694. /* Add pVtab to the end of sqlite3.aVTrans */
  121695. db->aVTrans[db->nVTrans++] = pVTab;
  121696. sqlite3VtabLock(pVTab);
  121697. }
  121698. /*
  121699. ** This function is invoked by the vdbe to call the xCreate method
  121700. ** of the virtual table named zTab in database iDb.
  121701. **
  121702. ** If an error occurs, *pzErr is set to point to an English language
  121703. ** description of the error and an SQLITE_XXX error code is returned.
  121704. ** In this case the caller must call sqlite3DbFree(db, ) on *pzErr.
  121705. */
  121706. SQLITE_PRIVATE int sqlite3VtabCallCreate(sqlite3 *db, int iDb, const char *zTab, char **pzErr){
  121707. int rc = SQLITE_OK;
  121708. Table *pTab;
  121709. Module *pMod;
  121710. const char *zMod;
  121711. pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
  121712. assert( pTab && IsVirtual(pTab) && !pTab->pVTable );
  121713. /* Locate the required virtual table module */
  121714. zMod = pTab->azModuleArg[0];
  121715. pMod = (Module*)sqlite3HashFind(&db->aModule, zMod);
  121716. /* If the module has been registered and includes a Create method,
  121717. ** invoke it now. If the module has not been registered, return an
  121718. ** error. Otherwise, do nothing.
  121719. */
  121720. if( pMod==0 || pMod->pModule->xCreate==0 || pMod->pModule->xDestroy==0 ){
  121721. *pzErr = sqlite3MPrintf(db, "no such module: %s", zMod);
  121722. rc = SQLITE_ERROR;
  121723. }else{
  121724. rc = vtabCallConstructor(db, pTab, pMod, pMod->pModule->xCreate, pzErr);
  121725. }
  121726. /* Justification of ALWAYS(): The xConstructor method is required to
  121727. ** create a valid sqlite3_vtab if it returns SQLITE_OK. */
  121728. if( rc==SQLITE_OK && ALWAYS(sqlite3GetVTable(db, pTab)) ){
  121729. rc = growVTrans(db);
  121730. if( rc==SQLITE_OK ){
  121731. addToVTrans(db, sqlite3GetVTable(db, pTab));
  121732. }
  121733. }
  121734. return rc;
  121735. }
  121736. /*
  121737. ** This function is used to set the schema of a virtual table. It is only
  121738. ** valid to call this function from within the xCreate() or xConnect() of a
  121739. ** virtual table module.
  121740. */
  121741. SQLITE_API int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable){
  121742. VtabCtx *pCtx;
  121743. int rc = SQLITE_OK;
  121744. Table *pTab;
  121745. char *zErr = 0;
  121746. Parse sParse;
  121747. #ifdef SQLITE_ENABLE_API_ARMOR
  121748. if( !sqlite3SafetyCheckOk(db) || zCreateTable==0 ){
  121749. return SQLITE_MISUSE_BKPT;
  121750. }
  121751. #endif
  121752. sqlite3_mutex_enter(db->mutex);
  121753. pCtx = db->pVtabCtx;
  121754. if( !pCtx || pCtx->bDeclared ){
  121755. sqlite3Error(db, SQLITE_MISUSE);
  121756. sqlite3_mutex_leave(db->mutex);
  121757. return SQLITE_MISUSE_BKPT;
  121758. }
  121759. pTab = pCtx->pTab;
  121760. assert( IsVirtual(pTab) );
  121761. memset(&sParse, 0, sizeof(sParse));
  121762. sParse.declareVtab = 1;
  121763. sParse.db = db;
  121764. sParse.nQueryLoop = 1;
  121765. if( SQLITE_OK==sqlite3RunParser(&sParse, zCreateTable, &zErr)
  121766. && sParse.pNewTable
  121767. && !db->mallocFailed
  121768. && !sParse.pNewTable->pSelect
  121769. && !IsVirtual(sParse.pNewTable)
  121770. ){
  121771. if( !pTab->aCol ){
  121772. Table *pNew = sParse.pNewTable;
  121773. Index *pIdx;
  121774. pTab->aCol = pNew->aCol;
  121775. pTab->nCol = pNew->nCol;
  121776. pTab->tabFlags |= pNew->tabFlags & (TF_WithoutRowid|TF_NoVisibleRowid);
  121777. pNew->nCol = 0;
  121778. pNew->aCol = 0;
  121779. assert( pTab->pIndex==0 );
  121780. assert( HasRowid(pNew) || sqlite3PrimaryKeyIndex(pNew)!=0 );
  121781. if( !HasRowid(pNew)
  121782. && pCtx->pVTable->pMod->pModule->xUpdate!=0
  121783. && sqlite3PrimaryKeyIndex(pNew)->nKeyCol!=1
  121784. ){
  121785. /* WITHOUT ROWID virtual tables must either be read-only (xUpdate==0)
  121786. ** or else must have a single-column PRIMARY KEY */
  121787. rc = SQLITE_ERROR;
  121788. }
  121789. pIdx = pNew->pIndex;
  121790. if( pIdx ){
  121791. assert( pIdx->pNext==0 );
  121792. pTab->pIndex = pIdx;
  121793. pNew->pIndex = 0;
  121794. pIdx->pTable = pTab;
  121795. }
  121796. }
  121797. pCtx->bDeclared = 1;
  121798. }else{
  121799. sqlite3ErrorWithMsg(db, SQLITE_ERROR, (zErr ? "%s" : 0), zErr);
  121800. sqlite3DbFree(db, zErr);
  121801. rc = SQLITE_ERROR;
  121802. }
  121803. sParse.declareVtab = 0;
  121804. if( sParse.pVdbe ){
  121805. sqlite3VdbeFinalize(sParse.pVdbe);
  121806. }
  121807. sqlite3DeleteTable(db, sParse.pNewTable);
  121808. sqlite3ParserReset(&sParse);
  121809. assert( (rc&0xff)==rc );
  121810. rc = sqlite3ApiExit(db, rc);
  121811. sqlite3_mutex_leave(db->mutex);
  121812. return rc;
  121813. }
  121814. /*
  121815. ** This function is invoked by the vdbe to call the xDestroy method
  121816. ** of the virtual table named zTab in database iDb. This occurs
  121817. ** when a DROP TABLE is mentioned.
  121818. **
  121819. ** This call is a no-op if zTab is not a virtual table.
  121820. */
  121821. SQLITE_PRIVATE int sqlite3VtabCallDestroy(sqlite3 *db, int iDb, const char *zTab){
  121822. int rc = SQLITE_OK;
  121823. Table *pTab;
  121824. pTab = sqlite3FindTable(db, zTab, db->aDb[iDb].zDbSName);
  121825. if( pTab!=0 && ALWAYS(pTab->pVTable!=0) ){
  121826. VTable *p;
  121827. int (*xDestroy)(sqlite3_vtab *);
  121828. for(p=pTab->pVTable; p; p=p->pNext){
  121829. assert( p->pVtab );
  121830. if( p->pVtab->nRef>0 ){
  121831. return SQLITE_LOCKED;
  121832. }
  121833. }
  121834. p = vtabDisconnectAll(db, pTab);
  121835. xDestroy = p->pMod->pModule->xDestroy;
  121836. assert( xDestroy!=0 ); /* Checked before the virtual table is created */
  121837. rc = xDestroy(p->pVtab);
  121838. /* Remove the sqlite3_vtab* from the aVTrans[] array, if applicable */
  121839. if( rc==SQLITE_OK ){
  121840. assert( pTab->pVTable==p && p->pNext==0 );
  121841. p->pVtab = 0;
  121842. pTab->pVTable = 0;
  121843. sqlite3VtabUnlock(p);
  121844. }
  121845. }
  121846. return rc;
  121847. }
  121848. /*
  121849. ** This function invokes either the xRollback or xCommit method
  121850. ** of each of the virtual tables in the sqlite3.aVTrans array. The method
  121851. ** called is identified by the second argument, "offset", which is
  121852. ** the offset of the method to call in the sqlite3_module structure.
  121853. **
  121854. ** The array is cleared after invoking the callbacks.
  121855. */
  121856. static void callFinaliser(sqlite3 *db, int offset){
  121857. int i;
  121858. if( db->aVTrans ){
  121859. VTable **aVTrans = db->aVTrans;
  121860. db->aVTrans = 0;
  121861. for(i=0; i<db->nVTrans; i++){
  121862. VTable *pVTab = aVTrans[i];
  121863. sqlite3_vtab *p = pVTab->pVtab;
  121864. if( p ){
  121865. int (*x)(sqlite3_vtab *);
  121866. x = *(int (**)(sqlite3_vtab *))((char *)p->pModule + offset);
  121867. if( x ) x(p);
  121868. }
  121869. pVTab->iSavepoint = 0;
  121870. sqlite3VtabUnlock(pVTab);
  121871. }
  121872. sqlite3DbFree(db, aVTrans);
  121873. db->nVTrans = 0;
  121874. }
  121875. }
  121876. /*
  121877. ** Invoke the xSync method of all virtual tables in the sqlite3.aVTrans
  121878. ** array. Return the error code for the first error that occurs, or
  121879. ** SQLITE_OK if all xSync operations are successful.
  121880. **
  121881. ** If an error message is available, leave it in p->zErrMsg.
  121882. */
  121883. SQLITE_PRIVATE int sqlite3VtabSync(sqlite3 *db, Vdbe *p){
  121884. int i;
  121885. int rc = SQLITE_OK;
  121886. VTable **aVTrans = db->aVTrans;
  121887. db->aVTrans = 0;
  121888. for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
  121889. int (*x)(sqlite3_vtab *);
  121890. sqlite3_vtab *pVtab = aVTrans[i]->pVtab;
  121891. if( pVtab && (x = pVtab->pModule->xSync)!=0 ){
  121892. rc = x(pVtab);
  121893. sqlite3VtabImportErrmsg(p, pVtab);
  121894. }
  121895. }
  121896. db->aVTrans = aVTrans;
  121897. return rc;
  121898. }
  121899. /*
  121900. ** Invoke the xRollback method of all virtual tables in the
  121901. ** sqlite3.aVTrans array. Then clear the array itself.
  121902. */
  121903. SQLITE_PRIVATE int sqlite3VtabRollback(sqlite3 *db){
  121904. callFinaliser(db, offsetof(sqlite3_module,xRollback));
  121905. return SQLITE_OK;
  121906. }
  121907. /*
  121908. ** Invoke the xCommit method of all virtual tables in the
  121909. ** sqlite3.aVTrans array. Then clear the array itself.
  121910. */
  121911. SQLITE_PRIVATE int sqlite3VtabCommit(sqlite3 *db){
  121912. callFinaliser(db, offsetof(sqlite3_module,xCommit));
  121913. return SQLITE_OK;
  121914. }
  121915. /*
  121916. ** If the virtual table pVtab supports the transaction interface
  121917. ** (xBegin/xRollback/xCommit and optionally xSync) and a transaction is
  121918. ** not currently open, invoke the xBegin method now.
  121919. **
  121920. ** If the xBegin call is successful, place the sqlite3_vtab pointer
  121921. ** in the sqlite3.aVTrans array.
  121922. */
  121923. SQLITE_PRIVATE int sqlite3VtabBegin(sqlite3 *db, VTable *pVTab){
  121924. int rc = SQLITE_OK;
  121925. const sqlite3_module *pModule;
  121926. /* Special case: If db->aVTrans is NULL and db->nVTrans is greater
  121927. ** than zero, then this function is being called from within a
  121928. ** virtual module xSync() callback. It is illegal to write to
  121929. ** virtual module tables in this case, so return SQLITE_LOCKED.
  121930. */
  121931. if( sqlite3VtabInSync(db) ){
  121932. return SQLITE_LOCKED;
  121933. }
  121934. if( !pVTab ){
  121935. return SQLITE_OK;
  121936. }
  121937. pModule = pVTab->pVtab->pModule;
  121938. if( pModule->xBegin ){
  121939. int i;
  121940. /* If pVtab is already in the aVTrans array, return early */
  121941. for(i=0; i<db->nVTrans; i++){
  121942. if( db->aVTrans[i]==pVTab ){
  121943. return SQLITE_OK;
  121944. }
  121945. }
  121946. /* Invoke the xBegin method. If successful, add the vtab to the
  121947. ** sqlite3.aVTrans[] array. */
  121948. rc = growVTrans(db);
  121949. if( rc==SQLITE_OK ){
  121950. rc = pModule->xBegin(pVTab->pVtab);
  121951. if( rc==SQLITE_OK ){
  121952. int iSvpt = db->nStatement + db->nSavepoint;
  121953. addToVTrans(db, pVTab);
  121954. if( iSvpt && pModule->xSavepoint ){
  121955. pVTab->iSavepoint = iSvpt;
  121956. rc = pModule->xSavepoint(pVTab->pVtab, iSvpt-1);
  121957. }
  121958. }
  121959. }
  121960. }
  121961. return rc;
  121962. }
  121963. /*
  121964. ** Invoke either the xSavepoint, xRollbackTo or xRelease method of all
  121965. ** virtual tables that currently have an open transaction. Pass iSavepoint
  121966. ** as the second argument to the virtual table method invoked.
  121967. **
  121968. ** If op is SAVEPOINT_BEGIN, the xSavepoint method is invoked. If it is
  121969. ** SAVEPOINT_ROLLBACK, the xRollbackTo method. Otherwise, if op is
  121970. ** SAVEPOINT_RELEASE, then the xRelease method of each virtual table with
  121971. ** an open transaction is invoked.
  121972. **
  121973. ** If any virtual table method returns an error code other than SQLITE_OK,
  121974. ** processing is abandoned and the error returned to the caller of this
  121975. ** function immediately. If all calls to virtual table methods are successful,
  121976. ** SQLITE_OK is returned.
  121977. */
  121978. SQLITE_PRIVATE int sqlite3VtabSavepoint(sqlite3 *db, int op, int iSavepoint){
  121979. int rc = SQLITE_OK;
  121980. assert( op==SAVEPOINT_RELEASE||op==SAVEPOINT_ROLLBACK||op==SAVEPOINT_BEGIN );
  121981. assert( iSavepoint>=-1 );
  121982. if( db->aVTrans ){
  121983. int i;
  121984. for(i=0; rc==SQLITE_OK && i<db->nVTrans; i++){
  121985. VTable *pVTab = db->aVTrans[i];
  121986. const sqlite3_module *pMod = pVTab->pMod->pModule;
  121987. if( pVTab->pVtab && pMod->iVersion>=2 ){
  121988. int (*xMethod)(sqlite3_vtab *, int);
  121989. switch( op ){
  121990. case SAVEPOINT_BEGIN:
  121991. xMethod = pMod->xSavepoint;
  121992. pVTab->iSavepoint = iSavepoint+1;
  121993. break;
  121994. case SAVEPOINT_ROLLBACK:
  121995. xMethod = pMod->xRollbackTo;
  121996. break;
  121997. default:
  121998. xMethod = pMod->xRelease;
  121999. break;
  122000. }
  122001. if( xMethod && pVTab->iSavepoint>iSavepoint ){
  122002. rc = xMethod(pVTab->pVtab, iSavepoint);
  122003. }
  122004. }
  122005. }
  122006. }
  122007. return rc;
  122008. }
  122009. /*
  122010. ** The first parameter (pDef) is a function implementation. The
  122011. ** second parameter (pExpr) is the first argument to this function.
  122012. ** If pExpr is a column in a virtual table, then let the virtual
  122013. ** table implementation have an opportunity to overload the function.
  122014. **
  122015. ** This routine is used to allow virtual table implementations to
  122016. ** overload MATCH, LIKE, GLOB, and REGEXP operators.
  122017. **
  122018. ** Return either the pDef argument (indicating no change) or a
  122019. ** new FuncDef structure that is marked as ephemeral using the
  122020. ** SQLITE_FUNC_EPHEM flag.
  122021. */
  122022. SQLITE_PRIVATE FuncDef *sqlite3VtabOverloadFunction(
  122023. sqlite3 *db, /* Database connection for reporting malloc problems */
  122024. FuncDef *pDef, /* Function to possibly overload */
  122025. int nArg, /* Number of arguments to the function */
  122026. Expr *pExpr /* First argument to the function */
  122027. ){
  122028. Table *pTab;
  122029. sqlite3_vtab *pVtab;
  122030. sqlite3_module *pMod;
  122031. void (*xSFunc)(sqlite3_context*,int,sqlite3_value**) = 0;
  122032. void *pArg = 0;
  122033. FuncDef *pNew;
  122034. int rc = 0;
  122035. char *zLowerName;
  122036. unsigned char *z;
  122037. /* Check to see the left operand is a column in a virtual table */
  122038. if( NEVER(pExpr==0) ) return pDef;
  122039. if( pExpr->op!=TK_COLUMN ) return pDef;
  122040. pTab = pExpr->pTab;
  122041. if( pTab==0 ) return pDef;
  122042. if( !IsVirtual(pTab) ) return pDef;
  122043. pVtab = sqlite3GetVTable(db, pTab)->pVtab;
  122044. assert( pVtab!=0 );
  122045. assert( pVtab->pModule!=0 );
  122046. pMod = (sqlite3_module *)pVtab->pModule;
  122047. if( pMod->xFindFunction==0 ) return pDef;
  122048. /* Call the xFindFunction method on the virtual table implementation
  122049. ** to see if the implementation wants to overload this function
  122050. */
  122051. zLowerName = sqlite3DbStrDup(db, pDef->zName);
  122052. if( zLowerName ){
  122053. for(z=(unsigned char*)zLowerName; *z; z++){
  122054. *z = sqlite3UpperToLower[*z];
  122055. }
  122056. rc = pMod->xFindFunction(pVtab, nArg, zLowerName, &xSFunc, &pArg);
  122057. sqlite3DbFree(db, zLowerName);
  122058. }
  122059. if( rc==0 ){
  122060. return pDef;
  122061. }
  122062. /* Create a new ephemeral function definition for the overloaded
  122063. ** function */
  122064. pNew = sqlite3DbMallocZero(db, sizeof(*pNew)
  122065. + sqlite3Strlen30(pDef->zName) + 1);
  122066. if( pNew==0 ){
  122067. return pDef;
  122068. }
  122069. *pNew = *pDef;
  122070. pNew->zName = (const char*)&pNew[1];
  122071. memcpy((char*)&pNew[1], pDef->zName, sqlite3Strlen30(pDef->zName)+1);
  122072. pNew->xSFunc = xSFunc;
  122073. pNew->pUserData = pArg;
  122074. pNew->funcFlags |= SQLITE_FUNC_EPHEM;
  122075. return pNew;
  122076. }
  122077. /*
  122078. ** Make sure virtual table pTab is contained in the pParse->apVirtualLock[]
  122079. ** array so that an OP_VBegin will get generated for it. Add pTab to the
  122080. ** array if it is missing. If pTab is already in the array, this routine
  122081. ** is a no-op.
  122082. */
  122083. SQLITE_PRIVATE void sqlite3VtabMakeWritable(Parse *pParse, Table *pTab){
  122084. Parse *pToplevel = sqlite3ParseToplevel(pParse);
  122085. int i, n;
  122086. Table **apVtabLock;
  122087. assert( IsVirtual(pTab) );
  122088. for(i=0; i<pToplevel->nVtabLock; i++){
  122089. if( pTab==pToplevel->apVtabLock[i] ) return;
  122090. }
  122091. n = (pToplevel->nVtabLock+1)*sizeof(pToplevel->apVtabLock[0]);
  122092. apVtabLock = sqlite3_realloc64(pToplevel->apVtabLock, n);
  122093. if( apVtabLock ){
  122094. pToplevel->apVtabLock = apVtabLock;
  122095. pToplevel->apVtabLock[pToplevel->nVtabLock++] = pTab;
  122096. }else{
  122097. sqlite3OomFault(pToplevel->db);
  122098. }
  122099. }
  122100. /*
  122101. ** Check to see if virtual table module pMod can be have an eponymous
  122102. ** virtual table instance. If it can, create one if one does not already
  122103. ** exist. Return non-zero if the eponymous virtual table instance exists
  122104. ** when this routine returns, and return zero if it does not exist.
  122105. **
  122106. ** An eponymous virtual table instance is one that is named after its
  122107. ** module, and more importantly, does not require a CREATE VIRTUAL TABLE
  122108. ** statement in order to come into existance. Eponymous virtual table
  122109. ** instances always exist. They cannot be DROP-ed.
  122110. **
  122111. ** Any virtual table module for which xConnect and xCreate are the same
  122112. ** method can have an eponymous virtual table instance.
  122113. */
  122114. SQLITE_PRIVATE int sqlite3VtabEponymousTableInit(Parse *pParse, Module *pMod){
  122115. const sqlite3_module *pModule = pMod->pModule;
  122116. Table *pTab;
  122117. char *zErr = 0;
  122118. int rc;
  122119. sqlite3 *db = pParse->db;
  122120. if( pMod->pEpoTab ) return 1;
  122121. if( pModule->xCreate!=0 && pModule->xCreate!=pModule->xConnect ) return 0;
  122122. pTab = sqlite3DbMallocZero(db, sizeof(Table));
  122123. if( pTab==0 ) return 0;
  122124. pTab->zName = sqlite3DbStrDup(db, pMod->zName);
  122125. if( pTab->zName==0 ){
  122126. sqlite3DbFree(db, pTab);
  122127. return 0;
  122128. }
  122129. pMod->pEpoTab = pTab;
  122130. pTab->nTabRef = 1;
  122131. pTab->pSchema = db->aDb[0].pSchema;
  122132. assert( pTab->nModuleArg==0 );
  122133. pTab->iPKey = -1;
  122134. addModuleArgument(db, pTab, sqlite3DbStrDup(db, pTab->zName));
  122135. addModuleArgument(db, pTab, 0);
  122136. addModuleArgument(db, pTab, sqlite3DbStrDup(db, pTab->zName));
  122137. rc = vtabCallConstructor(db, pTab, pMod, pModule->xConnect, &zErr);
  122138. if( rc ){
  122139. sqlite3ErrorMsg(pParse, "%s", zErr);
  122140. sqlite3DbFree(db, zErr);
  122141. sqlite3VtabEponymousTableClear(db, pMod);
  122142. return 0;
  122143. }
  122144. return 1;
  122145. }
  122146. /*
  122147. ** Erase the eponymous virtual table instance associated with
  122148. ** virtual table module pMod, if it exists.
  122149. */
  122150. SQLITE_PRIVATE void sqlite3VtabEponymousTableClear(sqlite3 *db, Module *pMod){
  122151. Table *pTab = pMod->pEpoTab;
  122152. if( pTab!=0 ){
  122153. /* Mark the table as Ephemeral prior to deleting it, so that the
  122154. ** sqlite3DeleteTable() routine will know that it is not stored in
  122155. ** the schema. */
  122156. pTab->tabFlags |= TF_Ephemeral;
  122157. sqlite3DeleteTable(db, pTab);
  122158. pMod->pEpoTab = 0;
  122159. }
  122160. }
  122161. /*
  122162. ** Return the ON CONFLICT resolution mode in effect for the virtual
  122163. ** table update operation currently in progress.
  122164. **
  122165. ** The results of this routine are undefined unless it is called from
  122166. ** within an xUpdate method.
  122167. */
  122168. SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *db){
  122169. static const unsigned char aMap[] = {
  122170. SQLITE_ROLLBACK, SQLITE_ABORT, SQLITE_FAIL, SQLITE_IGNORE, SQLITE_REPLACE
  122171. };
  122172. #ifdef SQLITE_ENABLE_API_ARMOR
  122173. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  122174. #endif
  122175. assert( OE_Rollback==1 && OE_Abort==2 && OE_Fail==3 );
  122176. assert( OE_Ignore==4 && OE_Replace==5 );
  122177. assert( db->vtabOnConflict>=1 && db->vtabOnConflict<=5 );
  122178. return (int)aMap[db->vtabOnConflict-1];
  122179. }
  122180. /*
  122181. ** Call from within the xCreate() or xConnect() methods to provide
  122182. ** the SQLite core with additional information about the behavior
  122183. ** of the virtual table being implemented.
  122184. */
  122185. SQLITE_API int sqlite3_vtab_config(sqlite3 *db, int op, ...){
  122186. va_list ap;
  122187. int rc = SQLITE_OK;
  122188. #ifdef SQLITE_ENABLE_API_ARMOR
  122189. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  122190. #endif
  122191. sqlite3_mutex_enter(db->mutex);
  122192. va_start(ap, op);
  122193. switch( op ){
  122194. case SQLITE_VTAB_CONSTRAINT_SUPPORT: {
  122195. VtabCtx *p = db->pVtabCtx;
  122196. if( !p ){
  122197. rc = SQLITE_MISUSE_BKPT;
  122198. }else{
  122199. assert( p->pTab==0 || IsVirtual(p->pTab) );
  122200. p->pVTable->bConstraint = (u8)va_arg(ap, int);
  122201. }
  122202. break;
  122203. }
  122204. default:
  122205. rc = SQLITE_MISUSE_BKPT;
  122206. break;
  122207. }
  122208. va_end(ap);
  122209. if( rc!=SQLITE_OK ) sqlite3Error(db, rc);
  122210. sqlite3_mutex_leave(db->mutex);
  122211. return rc;
  122212. }
  122213. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  122214. /************** End of vtab.c ************************************************/
  122215. /************** Begin file wherecode.c ***************************************/
  122216. /*
  122217. ** 2015-06-06
  122218. **
  122219. ** The author disclaims copyright to this source code. In place of
  122220. ** a legal notice, here is a blessing:
  122221. **
  122222. ** May you do good and not evil.
  122223. ** May you find forgiveness for yourself and forgive others.
  122224. ** May you share freely, never taking more than you give.
  122225. **
  122226. *************************************************************************
  122227. ** This module contains C code that generates VDBE code used to process
  122228. ** the WHERE clause of SQL statements.
  122229. **
  122230. ** This file was split off from where.c on 2015-06-06 in order to reduce the
  122231. ** size of where.c and make it easier to edit. This file contains the routines
  122232. ** that actually generate the bulk of the WHERE loop code. The original where.c
  122233. ** file retains the code that does query planning and analysis.
  122234. */
  122235. /* #include "sqliteInt.h" */
  122236. /************** Include whereInt.h in the middle of wherecode.c **************/
  122237. /************** Begin file whereInt.h ****************************************/
  122238. /*
  122239. ** 2013-11-12
  122240. **
  122241. ** The author disclaims copyright to this source code. In place of
  122242. ** a legal notice, here is a blessing:
  122243. **
  122244. ** May you do good and not evil.
  122245. ** May you find forgiveness for yourself and forgive others.
  122246. ** May you share freely, never taking more than you give.
  122247. **
  122248. *************************************************************************
  122249. **
  122250. ** This file contains structure and macro definitions for the query
  122251. ** planner logic in "where.c". These definitions are broken out into
  122252. ** a separate source file for easier editing.
  122253. */
  122254. /*
  122255. ** Trace output macros
  122256. */
  122257. #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
  122258. /***/ extern int sqlite3WhereTrace;
  122259. #endif
  122260. #if defined(SQLITE_DEBUG) \
  122261. && (defined(SQLITE_TEST) || defined(SQLITE_ENABLE_WHERETRACE))
  122262. # define WHERETRACE(K,X) if(sqlite3WhereTrace&(K)) sqlite3DebugPrintf X
  122263. # define WHERETRACE_ENABLED 1
  122264. #else
  122265. # define WHERETRACE(K,X)
  122266. #endif
  122267. /* Forward references
  122268. */
  122269. typedef struct WhereClause WhereClause;
  122270. typedef struct WhereMaskSet WhereMaskSet;
  122271. typedef struct WhereOrInfo WhereOrInfo;
  122272. typedef struct WhereAndInfo WhereAndInfo;
  122273. typedef struct WhereLevel WhereLevel;
  122274. typedef struct WhereLoop WhereLoop;
  122275. typedef struct WherePath WherePath;
  122276. typedef struct WhereTerm WhereTerm;
  122277. typedef struct WhereLoopBuilder WhereLoopBuilder;
  122278. typedef struct WhereScan WhereScan;
  122279. typedef struct WhereOrCost WhereOrCost;
  122280. typedef struct WhereOrSet WhereOrSet;
  122281. /*
  122282. ** This object contains information needed to implement a single nested
  122283. ** loop in WHERE clause.
  122284. **
  122285. ** Contrast this object with WhereLoop. This object describes the
  122286. ** implementation of the loop. WhereLoop describes the algorithm.
  122287. ** This object contains a pointer to the WhereLoop algorithm as one of
  122288. ** its elements.
  122289. **
  122290. ** The WhereInfo object contains a single instance of this object for
  122291. ** each term in the FROM clause (which is to say, for each of the
  122292. ** nested loops as implemented). The order of WhereLevel objects determines
  122293. ** the loop nested order, with WhereInfo.a[0] being the outer loop and
  122294. ** WhereInfo.a[WhereInfo.nLevel-1] being the inner loop.
  122295. */
  122296. struct WhereLevel {
  122297. int iLeftJoin; /* Memory cell used to implement LEFT OUTER JOIN */
  122298. int iTabCur; /* The VDBE cursor used to access the table */
  122299. int iIdxCur; /* The VDBE cursor used to access pIdx */
  122300. int addrBrk; /* Jump here to break out of the loop */
  122301. int addrNxt; /* Jump here to start the next IN combination */
  122302. int addrSkip; /* Jump here for next iteration of skip-scan */
  122303. int addrCont; /* Jump here to continue with the next loop cycle */
  122304. int addrFirst; /* First instruction of interior of the loop */
  122305. int addrBody; /* Beginning of the body of this loop */
  122306. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  122307. u32 iLikeRepCntr; /* LIKE range processing counter register (times 2) */
  122308. int addrLikeRep; /* LIKE range processing address */
  122309. #endif
  122310. u8 iFrom; /* Which entry in the FROM clause */
  122311. u8 op, p3, p5; /* Opcode, P3 & P5 of the opcode that ends the loop */
  122312. int p1, p2; /* Operands of the opcode used to ends the loop */
  122313. union { /* Information that depends on pWLoop->wsFlags */
  122314. struct {
  122315. int nIn; /* Number of entries in aInLoop[] */
  122316. struct InLoop {
  122317. int iCur; /* The VDBE cursor used by this IN operator */
  122318. int addrInTop; /* Top of the IN loop */
  122319. u8 eEndLoopOp; /* IN Loop terminator. OP_Next or OP_Prev */
  122320. } *aInLoop; /* Information about each nested IN operator */
  122321. } in; /* Used when pWLoop->wsFlags&WHERE_IN_ABLE */
  122322. Index *pCovidx; /* Possible covering index for WHERE_MULTI_OR */
  122323. } u;
  122324. struct WhereLoop *pWLoop; /* The selected WhereLoop object */
  122325. Bitmask notReady; /* FROM entries not usable at this level */
  122326. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  122327. int addrVisit; /* Address at which row is visited */
  122328. #endif
  122329. };
  122330. /*
  122331. ** Each instance of this object represents an algorithm for evaluating one
  122332. ** term of a join. Every term of the FROM clause will have at least
  122333. ** one corresponding WhereLoop object (unless INDEXED BY constraints
  122334. ** prevent a query solution - which is an error) and many terms of the
  122335. ** FROM clause will have multiple WhereLoop objects, each describing a
  122336. ** potential way of implementing that FROM-clause term, together with
  122337. ** dependencies and cost estimates for using the chosen algorithm.
  122338. **
  122339. ** Query planning consists of building up a collection of these WhereLoop
  122340. ** objects, then computing a particular sequence of WhereLoop objects, with
  122341. ** one WhereLoop object per FROM clause term, that satisfy all dependencies
  122342. ** and that minimize the overall cost.
  122343. */
  122344. struct WhereLoop {
  122345. Bitmask prereq; /* Bitmask of other loops that must run first */
  122346. Bitmask maskSelf; /* Bitmask identifying table iTab */
  122347. #ifdef SQLITE_DEBUG
  122348. char cId; /* Symbolic ID of this loop for debugging use */
  122349. #endif
  122350. u8 iTab; /* Position in FROM clause of table for this loop */
  122351. u8 iSortIdx; /* Sorting index number. 0==None */
  122352. LogEst rSetup; /* One-time setup cost (ex: create transient index) */
  122353. LogEst rRun; /* Cost of running each loop */
  122354. LogEst nOut; /* Estimated number of output rows */
  122355. union {
  122356. struct { /* Information for internal btree tables */
  122357. u16 nEq; /* Number of equality constraints */
  122358. u16 nBtm; /* Size of BTM vector */
  122359. u16 nTop; /* Size of TOP vector */
  122360. u16 nIdxCol; /* Index column used for ORDER BY */
  122361. Index *pIndex; /* Index used, or NULL */
  122362. } btree;
  122363. struct { /* Information for virtual tables */
  122364. int idxNum; /* Index number */
  122365. u8 needFree; /* True if sqlite3_free(idxStr) is needed */
  122366. i8 isOrdered; /* True if satisfies ORDER BY */
  122367. u16 omitMask; /* Terms that may be omitted */
  122368. char *idxStr; /* Index identifier string */
  122369. } vtab;
  122370. } u;
  122371. u32 wsFlags; /* WHERE_* flags describing the plan */
  122372. u16 nLTerm; /* Number of entries in aLTerm[] */
  122373. u16 nSkip; /* Number of NULL aLTerm[] entries */
  122374. /**** whereLoopXfer() copies fields above ***********************/
  122375. # define WHERE_LOOP_XFER_SZ offsetof(WhereLoop,nLSlot)
  122376. u16 nLSlot; /* Number of slots allocated for aLTerm[] */
  122377. WhereTerm **aLTerm; /* WhereTerms used */
  122378. WhereLoop *pNextLoop; /* Next WhereLoop object in the WhereClause */
  122379. WhereTerm *aLTermSpace[3]; /* Initial aLTerm[] space */
  122380. };
  122381. /* This object holds the prerequisites and the cost of running a
  122382. ** subquery on one operand of an OR operator in the WHERE clause.
  122383. ** See WhereOrSet for additional information
  122384. */
  122385. struct WhereOrCost {
  122386. Bitmask prereq; /* Prerequisites */
  122387. LogEst rRun; /* Cost of running this subquery */
  122388. LogEst nOut; /* Number of outputs for this subquery */
  122389. };
  122390. /* The WhereOrSet object holds a set of possible WhereOrCosts that
  122391. ** correspond to the subquery(s) of OR-clause processing. Only the
  122392. ** best N_OR_COST elements are retained.
  122393. */
  122394. #define N_OR_COST 3
  122395. struct WhereOrSet {
  122396. u16 n; /* Number of valid a[] entries */
  122397. WhereOrCost a[N_OR_COST]; /* Set of best costs */
  122398. };
  122399. /*
  122400. ** Each instance of this object holds a sequence of WhereLoop objects
  122401. ** that implement some or all of a query plan.
  122402. **
  122403. ** Think of each WhereLoop object as a node in a graph with arcs
  122404. ** showing dependencies and costs for travelling between nodes. (That is
  122405. ** not a completely accurate description because WhereLoop costs are a
  122406. ** vector, not a scalar, and because dependencies are many-to-one, not
  122407. ** one-to-one as are graph nodes. But it is a useful visualization aid.)
  122408. ** Then a WherePath object is a path through the graph that visits some
  122409. ** or all of the WhereLoop objects once.
  122410. **
  122411. ** The "solver" works by creating the N best WherePath objects of length
  122412. ** 1. Then using those as a basis to compute the N best WherePath objects
  122413. ** of length 2. And so forth until the length of WherePaths equals the
  122414. ** number of nodes in the FROM clause. The best (lowest cost) WherePath
  122415. ** at the end is the chosen query plan.
  122416. */
  122417. struct WherePath {
  122418. Bitmask maskLoop; /* Bitmask of all WhereLoop objects in this path */
  122419. Bitmask revLoop; /* aLoop[]s that should be reversed for ORDER BY */
  122420. LogEst nRow; /* Estimated number of rows generated by this path */
  122421. LogEst rCost; /* Total cost of this path */
  122422. LogEst rUnsorted; /* Total cost of this path ignoring sorting costs */
  122423. i8 isOrdered; /* No. of ORDER BY terms satisfied. -1 for unknown */
  122424. WhereLoop **aLoop; /* Array of WhereLoop objects implementing this path */
  122425. };
  122426. /*
  122427. ** The query generator uses an array of instances of this structure to
  122428. ** help it analyze the subexpressions of the WHERE clause. Each WHERE
  122429. ** clause subexpression is separated from the others by AND operators,
  122430. ** usually, or sometimes subexpressions separated by OR.
  122431. **
  122432. ** All WhereTerms are collected into a single WhereClause structure.
  122433. ** The following identity holds:
  122434. **
  122435. ** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
  122436. **
  122437. ** When a term is of the form:
  122438. **
  122439. ** X <op> <expr>
  122440. **
  122441. ** where X is a column name and <op> is one of certain operators,
  122442. ** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
  122443. ** cursor number and column number for X. WhereTerm.eOperator records
  122444. ** the <op> using a bitmask encoding defined by WO_xxx below. The
  122445. ** use of a bitmask encoding for the operator allows us to search
  122446. ** quickly for terms that match any of several different operators.
  122447. **
  122448. ** A WhereTerm might also be two or more subterms connected by OR:
  122449. **
  122450. ** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
  122451. **
  122452. ** In this second case, wtFlag has the TERM_ORINFO bit set and eOperator==WO_OR
  122453. ** and the WhereTerm.u.pOrInfo field points to auxiliary information that
  122454. ** is collected about the OR clause.
  122455. **
  122456. ** If a term in the WHERE clause does not match either of the two previous
  122457. ** categories, then eOperator==0. The WhereTerm.pExpr field is still set
  122458. ** to the original subexpression content and wtFlags is set up appropriately
  122459. ** but no other fields in the WhereTerm object are meaningful.
  122460. **
  122461. ** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
  122462. ** but they do so indirectly. A single WhereMaskSet structure translates
  122463. ** cursor number into bits and the translated bit is stored in the prereq
  122464. ** fields. The translation is used in order to maximize the number of
  122465. ** bits that will fit in a Bitmask. The VDBE cursor numbers might be
  122466. ** spread out over the non-negative integers. For example, the cursor
  122467. ** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
  122468. ** translates these sparse cursor numbers into consecutive integers
  122469. ** beginning with 0 in order to make the best possible use of the available
  122470. ** bits in the Bitmask. So, in the example above, the cursor numbers
  122471. ** would be mapped into integers 0 through 7.
  122472. **
  122473. ** The number of terms in a join is limited by the number of bits
  122474. ** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
  122475. ** is only able to process joins with 64 or fewer tables.
  122476. */
  122477. struct WhereTerm {
  122478. Expr *pExpr; /* Pointer to the subexpression that is this term */
  122479. WhereClause *pWC; /* The clause this term is part of */
  122480. LogEst truthProb; /* Probability of truth for this expression */
  122481. u16 wtFlags; /* TERM_xxx bit flags. See below */
  122482. u16 eOperator; /* A WO_xx value describing <op> */
  122483. u8 nChild; /* Number of children that must disable us */
  122484. u8 eMatchOp; /* Op for vtab MATCH/LIKE/GLOB/REGEXP terms */
  122485. int iParent; /* Disable pWC->a[iParent] when this term disabled */
  122486. int leftCursor; /* Cursor number of X in "X <op> <expr>" */
  122487. int iField; /* Field in (?,?,?) IN (SELECT...) vector */
  122488. union {
  122489. int leftColumn; /* Column number of X in "X <op> <expr>" */
  122490. WhereOrInfo *pOrInfo; /* Extra information if (eOperator & WO_OR)!=0 */
  122491. WhereAndInfo *pAndInfo; /* Extra information if (eOperator& WO_AND)!=0 */
  122492. } u;
  122493. Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
  122494. Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
  122495. };
  122496. /*
  122497. ** Allowed values of WhereTerm.wtFlags
  122498. */
  122499. #define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
  122500. #define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
  122501. #define TERM_CODED 0x04 /* This term is already coded */
  122502. #define TERM_COPIED 0x08 /* Has a child */
  122503. #define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
  122504. #define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
  122505. #define TERM_OR_OK 0x40 /* Used during OR-clause processing */
  122506. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  122507. # define TERM_VNULL 0x80 /* Manufactured x>NULL or x<=NULL term */
  122508. #else
  122509. # define TERM_VNULL 0x00 /* Disabled if not using stat3 */
  122510. #endif
  122511. #define TERM_LIKEOPT 0x100 /* Virtual terms from the LIKE optimization */
  122512. #define TERM_LIKECOND 0x200 /* Conditionally this LIKE operator term */
  122513. #define TERM_LIKE 0x400 /* The original LIKE operator */
  122514. #define TERM_IS 0x800 /* Term.pExpr is an IS operator */
  122515. #define TERM_VARSELECT 0x1000 /* Term.pExpr contains a correlated sub-query */
  122516. /*
  122517. ** An instance of the WhereScan object is used as an iterator for locating
  122518. ** terms in the WHERE clause that are useful to the query planner.
  122519. */
  122520. struct WhereScan {
  122521. WhereClause *pOrigWC; /* Original, innermost WhereClause */
  122522. WhereClause *pWC; /* WhereClause currently being scanned */
  122523. const char *zCollName; /* Required collating sequence, if not NULL */
  122524. Expr *pIdxExpr; /* Search for this index expression */
  122525. char idxaff; /* Must match this affinity, if zCollName!=NULL */
  122526. unsigned char nEquiv; /* Number of entries in aEquiv[] */
  122527. unsigned char iEquiv; /* Next unused slot in aEquiv[] */
  122528. u32 opMask; /* Acceptable operators */
  122529. int k; /* Resume scanning at this->pWC->a[this->k] */
  122530. int aiCur[11]; /* Cursors in the equivalence class */
  122531. i16 aiColumn[11]; /* Corresponding column number in the eq-class */
  122532. };
  122533. /*
  122534. ** An instance of the following structure holds all information about a
  122535. ** WHERE clause. Mostly this is a container for one or more WhereTerms.
  122536. **
  122537. ** Explanation of pOuter: For a WHERE clause of the form
  122538. **
  122539. ** a AND ((b AND c) OR (d AND e)) AND f
  122540. **
  122541. ** There are separate WhereClause objects for the whole clause and for
  122542. ** the subclauses "(b AND c)" and "(d AND e)". The pOuter field of the
  122543. ** subclauses points to the WhereClause object for the whole clause.
  122544. */
  122545. struct WhereClause {
  122546. WhereInfo *pWInfo; /* WHERE clause processing context */
  122547. WhereClause *pOuter; /* Outer conjunction */
  122548. u8 op; /* Split operator. TK_AND or TK_OR */
  122549. int nTerm; /* Number of terms */
  122550. int nSlot; /* Number of entries in a[] */
  122551. WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
  122552. #if defined(SQLITE_SMALL_STACK)
  122553. WhereTerm aStatic[1]; /* Initial static space for a[] */
  122554. #else
  122555. WhereTerm aStatic[8]; /* Initial static space for a[] */
  122556. #endif
  122557. };
  122558. /*
  122559. ** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
  122560. ** a dynamically allocated instance of the following structure.
  122561. */
  122562. struct WhereOrInfo {
  122563. WhereClause wc; /* Decomposition into subterms */
  122564. Bitmask indexable; /* Bitmask of all indexable tables in the clause */
  122565. };
  122566. /*
  122567. ** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
  122568. ** a dynamically allocated instance of the following structure.
  122569. */
  122570. struct WhereAndInfo {
  122571. WhereClause wc; /* The subexpression broken out */
  122572. };
  122573. /*
  122574. ** An instance of the following structure keeps track of a mapping
  122575. ** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
  122576. **
  122577. ** The VDBE cursor numbers are small integers contained in
  122578. ** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
  122579. ** clause, the cursor numbers might not begin with 0 and they might
  122580. ** contain gaps in the numbering sequence. But we want to make maximum
  122581. ** use of the bits in our bitmasks. This structure provides a mapping
  122582. ** from the sparse cursor numbers into consecutive integers beginning
  122583. ** with 0.
  122584. **
  122585. ** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
  122586. ** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
  122587. **
  122588. ** For example, if the WHERE clause expression used these VDBE
  122589. ** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
  122590. ** would map those cursor numbers into bits 0 through 5.
  122591. **
  122592. ** Note that the mapping is not necessarily ordered. In the example
  122593. ** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
  122594. ** 57->5, 73->4. Or one of 719 other combinations might be used. It
  122595. ** does not really matter. What is important is that sparse cursor
  122596. ** numbers all get mapped into bit numbers that begin with 0 and contain
  122597. ** no gaps.
  122598. */
  122599. struct WhereMaskSet {
  122600. int bVarSelect; /* Used by sqlite3WhereExprUsage() */
  122601. int n; /* Number of assigned cursor values */
  122602. int ix[BMS]; /* Cursor assigned to each bit */
  122603. };
  122604. /*
  122605. ** Initialize a WhereMaskSet object
  122606. */
  122607. #define initMaskSet(P) (P)->n=0
  122608. /*
  122609. ** This object is a convenience wrapper holding all information needed
  122610. ** to construct WhereLoop objects for a particular query.
  122611. */
  122612. struct WhereLoopBuilder {
  122613. WhereInfo *pWInfo; /* Information about this WHERE */
  122614. WhereClause *pWC; /* WHERE clause terms */
  122615. ExprList *pOrderBy; /* ORDER BY clause */
  122616. WhereLoop *pNew; /* Template WhereLoop */
  122617. WhereOrSet *pOrSet; /* Record best loops here, if not NULL */
  122618. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  122619. UnpackedRecord *pRec; /* Probe for stat4 (if required) */
  122620. int nRecValid; /* Number of valid fields currently in pRec */
  122621. #endif
  122622. unsigned int bldFlags; /* SQLITE_BLDF_* flags */
  122623. };
  122624. /* Allowed values for WhereLoopBuider.bldFlags */
  122625. #define SQLITE_BLDF_INDEXED 0x0001 /* An index is used */
  122626. #define SQLITE_BLDF_UNIQUE 0x0002 /* All keys of a UNIQUE index used */
  122627. /*
  122628. ** The WHERE clause processing routine has two halves. The
  122629. ** first part does the start of the WHERE loop and the second
  122630. ** half does the tail of the WHERE loop. An instance of
  122631. ** this structure is returned by the first half and passed
  122632. ** into the second half to give some continuity.
  122633. **
  122634. ** An instance of this object holds the complete state of the query
  122635. ** planner.
  122636. */
  122637. struct WhereInfo {
  122638. Parse *pParse; /* Parsing and code generating context */
  122639. SrcList *pTabList; /* List of tables in the join */
  122640. ExprList *pOrderBy; /* The ORDER BY clause or NULL */
  122641. ExprList *pResultSet; /* Result set of the query */
  122642. Expr *pWhere; /* The complete WHERE clause */
  122643. LogEst iLimit; /* LIMIT if wctrlFlags has WHERE_USE_LIMIT */
  122644. int aiCurOnePass[2]; /* OP_OpenWrite cursors for the ONEPASS opt */
  122645. int iContinue; /* Jump here to continue with next record */
  122646. int iBreak; /* Jump here to break out of the loop */
  122647. int savedNQueryLoop; /* pParse->nQueryLoop outside the WHERE loop */
  122648. u16 wctrlFlags; /* Flags originally passed to sqlite3WhereBegin() */
  122649. u8 nLevel; /* Number of nested loop */
  122650. i8 nOBSat; /* Number of ORDER BY terms satisfied by indices */
  122651. u8 sorted; /* True if really sorted (not just grouped) */
  122652. u8 eOnePass; /* ONEPASS_OFF, or _SINGLE, or _MULTI */
  122653. u8 untestedTerms; /* Not all WHERE terms resolved by outer loop */
  122654. u8 eDistinct; /* One of the WHERE_DISTINCT_* values */
  122655. u8 bOrderedInnerLoop; /* True if only the inner-most loop is ordered */
  122656. int iTop; /* The very beginning of the WHERE loop */
  122657. WhereLoop *pLoops; /* List of all WhereLoop objects */
  122658. Bitmask revMask; /* Mask of ORDER BY terms that need reversing */
  122659. LogEst nRowOut; /* Estimated number of output rows */
  122660. WhereClause sWC; /* Decomposition of the WHERE clause */
  122661. WhereMaskSet sMaskSet; /* Map cursor numbers to bitmasks */
  122662. WhereLevel a[1]; /* Information about each nest loop in WHERE */
  122663. };
  122664. /*
  122665. ** Private interfaces - callable only by other where.c routines.
  122666. **
  122667. ** where.c:
  122668. */
  122669. SQLITE_PRIVATE Bitmask sqlite3WhereGetMask(WhereMaskSet*,int);
  122670. #ifdef WHERETRACE_ENABLED
  122671. SQLITE_PRIVATE void sqlite3WhereClausePrint(WhereClause *pWC);
  122672. #endif
  122673. SQLITE_PRIVATE WhereTerm *sqlite3WhereFindTerm(
  122674. WhereClause *pWC, /* The WHERE clause to be searched */
  122675. int iCur, /* Cursor number of LHS */
  122676. int iColumn, /* Column number of LHS */
  122677. Bitmask notReady, /* RHS must not overlap with this mask */
  122678. u32 op, /* Mask of WO_xx values describing operator */
  122679. Index *pIdx /* Must be compatible with this index, if not NULL */
  122680. );
  122681. /* wherecode.c: */
  122682. #ifndef SQLITE_OMIT_EXPLAIN
  122683. SQLITE_PRIVATE int sqlite3WhereExplainOneScan(
  122684. Parse *pParse, /* Parse context */
  122685. SrcList *pTabList, /* Table list this loop refers to */
  122686. WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
  122687. int iLevel, /* Value for "level" column of output */
  122688. int iFrom, /* Value for "from" column of output */
  122689. u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
  122690. );
  122691. #else
  122692. # define sqlite3WhereExplainOneScan(u,v,w,x,y,z) 0
  122693. #endif /* SQLITE_OMIT_EXPLAIN */
  122694. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  122695. SQLITE_PRIVATE void sqlite3WhereAddScanStatus(
  122696. Vdbe *v, /* Vdbe to add scanstatus entry to */
  122697. SrcList *pSrclist, /* FROM clause pLvl reads data from */
  122698. WhereLevel *pLvl, /* Level to add scanstatus() entry for */
  122699. int addrExplain /* Address of OP_Explain (or 0) */
  122700. );
  122701. #else
  122702. # define sqlite3WhereAddScanStatus(a, b, c, d) ((void)d)
  122703. #endif
  122704. SQLITE_PRIVATE Bitmask sqlite3WhereCodeOneLoopStart(
  122705. WhereInfo *pWInfo, /* Complete information about the WHERE clause */
  122706. int iLevel, /* Which level of pWInfo->a[] should be coded */
  122707. Bitmask notReady /* Which tables are currently available */
  122708. );
  122709. /* whereexpr.c: */
  122710. SQLITE_PRIVATE void sqlite3WhereClauseInit(WhereClause*,WhereInfo*);
  122711. SQLITE_PRIVATE void sqlite3WhereClauseClear(WhereClause*);
  122712. SQLITE_PRIVATE void sqlite3WhereSplit(WhereClause*,Expr*,u8);
  122713. SQLITE_PRIVATE Bitmask sqlite3WhereExprUsage(WhereMaskSet*, Expr*);
  122714. SQLITE_PRIVATE Bitmask sqlite3WhereExprListUsage(WhereMaskSet*, ExprList*);
  122715. SQLITE_PRIVATE void sqlite3WhereExprAnalyze(SrcList*, WhereClause*);
  122716. SQLITE_PRIVATE void sqlite3WhereTabFuncArgs(Parse*, struct SrcList_item*, WhereClause*);
  122717. /*
  122718. ** Bitmasks for the operators on WhereTerm objects. These are all
  122719. ** operators that are of interest to the query planner. An
  122720. ** OR-ed combination of these values can be used when searching for
  122721. ** particular WhereTerms within a WhereClause.
  122722. **
  122723. ** Value constraints:
  122724. ** WO_EQ == SQLITE_INDEX_CONSTRAINT_EQ
  122725. ** WO_LT == SQLITE_INDEX_CONSTRAINT_LT
  122726. ** WO_LE == SQLITE_INDEX_CONSTRAINT_LE
  122727. ** WO_GT == SQLITE_INDEX_CONSTRAINT_GT
  122728. ** WO_GE == SQLITE_INDEX_CONSTRAINT_GE
  122729. */
  122730. #define WO_IN 0x0001
  122731. #define WO_EQ 0x0002
  122732. #define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
  122733. #define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
  122734. #define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
  122735. #define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
  122736. #define WO_AUX 0x0040 /* Op useful to virtual tables only */
  122737. #define WO_IS 0x0080
  122738. #define WO_ISNULL 0x0100
  122739. #define WO_OR 0x0200 /* Two or more OR-connected terms */
  122740. #define WO_AND 0x0400 /* Two or more AND-connected terms */
  122741. #define WO_EQUIV 0x0800 /* Of the form A==B, both columns */
  122742. #define WO_NOOP 0x1000 /* This term does not restrict search space */
  122743. #define WO_ALL 0x1fff /* Mask of all possible WO_* values */
  122744. #define WO_SINGLE 0x01ff /* Mask of all non-compound WO_* values */
  122745. /*
  122746. ** These are definitions of bits in the WhereLoop.wsFlags field.
  122747. ** The particular combination of bits in each WhereLoop help to
  122748. ** determine the algorithm that WhereLoop represents.
  122749. */
  122750. #define WHERE_COLUMN_EQ 0x00000001 /* x=EXPR */
  122751. #define WHERE_COLUMN_RANGE 0x00000002 /* x<EXPR and/or x>EXPR */
  122752. #define WHERE_COLUMN_IN 0x00000004 /* x IN (...) */
  122753. #define WHERE_COLUMN_NULL 0x00000008 /* x IS NULL */
  122754. #define WHERE_CONSTRAINT 0x0000000f /* Any of the WHERE_COLUMN_xxx values */
  122755. #define WHERE_TOP_LIMIT 0x00000010 /* x<EXPR or x<=EXPR constraint */
  122756. #define WHERE_BTM_LIMIT 0x00000020 /* x>EXPR or x>=EXPR constraint */
  122757. #define WHERE_BOTH_LIMIT 0x00000030 /* Both x>EXPR and x<EXPR */
  122758. #define WHERE_IDX_ONLY 0x00000040 /* Use index only - omit table */
  122759. #define WHERE_IPK 0x00000100 /* x is the INTEGER PRIMARY KEY */
  122760. #define WHERE_INDEXED 0x00000200 /* WhereLoop.u.btree.pIndex is valid */
  122761. #define WHERE_VIRTUALTABLE 0x00000400 /* WhereLoop.u.vtab is valid */
  122762. #define WHERE_IN_ABLE 0x00000800 /* Able to support an IN operator */
  122763. #define WHERE_ONEROW 0x00001000 /* Selects no more than one row */
  122764. #define WHERE_MULTI_OR 0x00002000 /* OR using multiple indices */
  122765. #define WHERE_AUTO_INDEX 0x00004000 /* Uses an ephemeral index */
  122766. #define WHERE_SKIPSCAN 0x00008000 /* Uses the skip-scan algorithm */
  122767. #define WHERE_UNQ_WANTED 0x00010000 /* WHERE_ONEROW would have been helpful*/
  122768. #define WHERE_PARTIALIDX 0x00020000 /* The automatic index is partial */
  122769. /************** End of whereInt.h ********************************************/
  122770. /************** Continuing where we left off in wherecode.c ******************/
  122771. #ifndef SQLITE_OMIT_EXPLAIN
  122772. /*
  122773. ** Return the name of the i-th column of the pIdx index.
  122774. */
  122775. static const char *explainIndexColumnName(Index *pIdx, int i){
  122776. i = pIdx->aiColumn[i];
  122777. if( i==XN_EXPR ) return "<expr>";
  122778. if( i==XN_ROWID ) return "rowid";
  122779. return pIdx->pTable->aCol[i].zName;
  122780. }
  122781. /*
  122782. ** This routine is a helper for explainIndexRange() below
  122783. **
  122784. ** pStr holds the text of an expression that we are building up one term
  122785. ** at a time. This routine adds a new term to the end of the expression.
  122786. ** Terms are separated by AND so add the "AND" text for second and subsequent
  122787. ** terms only.
  122788. */
  122789. static void explainAppendTerm(
  122790. StrAccum *pStr, /* The text expression being built */
  122791. Index *pIdx, /* Index to read column names from */
  122792. int nTerm, /* Number of terms */
  122793. int iTerm, /* Zero-based index of first term. */
  122794. int bAnd, /* Non-zero to append " AND " */
  122795. const char *zOp /* Name of the operator */
  122796. ){
  122797. int i;
  122798. assert( nTerm>=1 );
  122799. if( bAnd ) sqlite3StrAccumAppend(pStr, " AND ", 5);
  122800. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, "(", 1);
  122801. for(i=0; i<nTerm; i++){
  122802. if( i ) sqlite3StrAccumAppend(pStr, ",", 1);
  122803. sqlite3StrAccumAppendAll(pStr, explainIndexColumnName(pIdx, iTerm+i));
  122804. }
  122805. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, ")", 1);
  122806. sqlite3StrAccumAppend(pStr, zOp, 1);
  122807. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, "(", 1);
  122808. for(i=0; i<nTerm; i++){
  122809. if( i ) sqlite3StrAccumAppend(pStr, ",", 1);
  122810. sqlite3StrAccumAppend(pStr, "?", 1);
  122811. }
  122812. if( nTerm>1 ) sqlite3StrAccumAppend(pStr, ")", 1);
  122813. }
  122814. /*
  122815. ** Argument pLevel describes a strategy for scanning table pTab. This
  122816. ** function appends text to pStr that describes the subset of table
  122817. ** rows scanned by the strategy in the form of an SQL expression.
  122818. **
  122819. ** For example, if the query:
  122820. **
  122821. ** SELECT * FROM t1 WHERE a=1 AND b>2;
  122822. **
  122823. ** is run and there is an index on (a, b), then this function returns a
  122824. ** string similar to:
  122825. **
  122826. ** "a=? AND b>?"
  122827. */
  122828. static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
  122829. Index *pIndex = pLoop->u.btree.pIndex;
  122830. u16 nEq = pLoop->u.btree.nEq;
  122831. u16 nSkip = pLoop->nSkip;
  122832. int i, j;
  122833. if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
  122834. sqlite3StrAccumAppend(pStr, " (", 2);
  122835. for(i=0; i<nEq; i++){
  122836. const char *z = explainIndexColumnName(pIndex, i);
  122837. if( i ) sqlite3StrAccumAppend(pStr, " AND ", 5);
  122838. sqlite3XPrintf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
  122839. }
  122840. j = i;
  122841. if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
  122842. explainAppendTerm(pStr, pIndex, pLoop->u.btree.nBtm, j, i, ">");
  122843. i = 1;
  122844. }
  122845. if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
  122846. explainAppendTerm(pStr, pIndex, pLoop->u.btree.nTop, j, i, "<");
  122847. }
  122848. sqlite3StrAccumAppend(pStr, ")", 1);
  122849. }
  122850. /*
  122851. ** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
  122852. ** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
  122853. ** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
  122854. ** is added to the output to describe the table scan strategy in pLevel.
  122855. **
  122856. ** If an OP_Explain opcode is added to the VM, its address is returned.
  122857. ** Otherwise, if no OP_Explain is coded, zero is returned.
  122858. */
  122859. SQLITE_PRIVATE int sqlite3WhereExplainOneScan(
  122860. Parse *pParse, /* Parse context */
  122861. SrcList *pTabList, /* Table list this loop refers to */
  122862. WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
  122863. int iLevel, /* Value for "level" column of output */
  122864. int iFrom, /* Value for "from" column of output */
  122865. u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
  122866. ){
  122867. int ret = 0;
  122868. #if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
  122869. if( sqlite3ParseToplevel(pParse)->explain==2 )
  122870. #endif
  122871. {
  122872. struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
  122873. Vdbe *v = pParse->pVdbe; /* VM being constructed */
  122874. sqlite3 *db = pParse->db; /* Database handle */
  122875. int iId = pParse->iSelectId; /* Select id (left-most output column) */
  122876. int isSearch; /* True for a SEARCH. False for SCAN. */
  122877. WhereLoop *pLoop; /* The controlling WhereLoop object */
  122878. u32 flags; /* Flags that describe this loop */
  122879. char *zMsg; /* Text to add to EQP output */
  122880. StrAccum str; /* EQP output string */
  122881. char zBuf[100]; /* Initial space for EQP output string */
  122882. pLoop = pLevel->pWLoop;
  122883. flags = pLoop->wsFlags;
  122884. if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_OR_SUBCLAUSE) ) return 0;
  122885. isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
  122886. || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
  122887. || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
  122888. sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
  122889. sqlite3StrAccumAppendAll(&str, isSearch ? "SEARCH" : "SCAN");
  122890. if( pItem->pSelect ){
  122891. sqlite3XPrintf(&str, " SUBQUERY %d", pItem->iSelectId);
  122892. }else{
  122893. sqlite3XPrintf(&str, " TABLE %s", pItem->zName);
  122894. }
  122895. if( pItem->zAlias ){
  122896. sqlite3XPrintf(&str, " AS %s", pItem->zAlias);
  122897. }
  122898. if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
  122899. const char *zFmt = 0;
  122900. Index *pIdx;
  122901. assert( pLoop->u.btree.pIndex!=0 );
  122902. pIdx = pLoop->u.btree.pIndex;
  122903. assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
  122904. if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
  122905. if( isSearch ){
  122906. zFmt = "PRIMARY KEY";
  122907. }
  122908. }else if( flags & WHERE_PARTIALIDX ){
  122909. zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
  122910. }else if( flags & WHERE_AUTO_INDEX ){
  122911. zFmt = "AUTOMATIC COVERING INDEX";
  122912. }else if( flags & WHERE_IDX_ONLY ){
  122913. zFmt = "COVERING INDEX %s";
  122914. }else{
  122915. zFmt = "INDEX %s";
  122916. }
  122917. if( zFmt ){
  122918. sqlite3StrAccumAppend(&str, " USING ", 7);
  122919. sqlite3XPrintf(&str, zFmt, pIdx->zName);
  122920. explainIndexRange(&str, pLoop);
  122921. }
  122922. }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
  122923. const char *zRangeOp;
  122924. if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
  122925. zRangeOp = "=";
  122926. }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
  122927. zRangeOp = ">? AND rowid<";
  122928. }else if( flags&WHERE_BTM_LIMIT ){
  122929. zRangeOp = ">";
  122930. }else{
  122931. assert( flags&WHERE_TOP_LIMIT);
  122932. zRangeOp = "<";
  122933. }
  122934. sqlite3XPrintf(&str, " USING INTEGER PRIMARY KEY (rowid%s?)",zRangeOp);
  122935. }
  122936. #ifndef SQLITE_OMIT_VIRTUALTABLE
  122937. else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
  122938. sqlite3XPrintf(&str, " VIRTUAL TABLE INDEX %d:%s",
  122939. pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
  122940. }
  122941. #endif
  122942. #ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
  122943. if( pLoop->nOut>=10 ){
  122944. sqlite3XPrintf(&str, " (~%llu rows)", sqlite3LogEstToInt(pLoop->nOut));
  122945. }else{
  122946. sqlite3StrAccumAppend(&str, " (~1 row)", 9);
  122947. }
  122948. #endif
  122949. zMsg = sqlite3StrAccumFinish(&str);
  122950. ret = sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg,P4_DYNAMIC);
  122951. }
  122952. return ret;
  122953. }
  122954. #endif /* SQLITE_OMIT_EXPLAIN */
  122955. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  122956. /*
  122957. ** Configure the VM passed as the first argument with an
  122958. ** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
  122959. ** implement level pLvl. Argument pSrclist is a pointer to the FROM
  122960. ** clause that the scan reads data from.
  122961. **
  122962. ** If argument addrExplain is not 0, it must be the address of an
  122963. ** OP_Explain instruction that describes the same loop.
  122964. */
  122965. SQLITE_PRIVATE void sqlite3WhereAddScanStatus(
  122966. Vdbe *v, /* Vdbe to add scanstatus entry to */
  122967. SrcList *pSrclist, /* FROM clause pLvl reads data from */
  122968. WhereLevel *pLvl, /* Level to add scanstatus() entry for */
  122969. int addrExplain /* Address of OP_Explain (or 0) */
  122970. ){
  122971. const char *zObj = 0;
  122972. WhereLoop *pLoop = pLvl->pWLoop;
  122973. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
  122974. zObj = pLoop->u.btree.pIndex->zName;
  122975. }else{
  122976. zObj = pSrclist->a[pLvl->iFrom].zName;
  122977. }
  122978. sqlite3VdbeScanStatus(
  122979. v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
  122980. );
  122981. }
  122982. #endif
  122983. /*
  122984. ** Disable a term in the WHERE clause. Except, do not disable the term
  122985. ** if it controls a LEFT OUTER JOIN and it did not originate in the ON
  122986. ** or USING clause of that join.
  122987. **
  122988. ** Consider the term t2.z='ok' in the following queries:
  122989. **
  122990. ** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
  122991. ** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
  122992. ** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
  122993. **
  122994. ** The t2.z='ok' is disabled in the in (2) because it originates
  122995. ** in the ON clause. The term is disabled in (3) because it is not part
  122996. ** of a LEFT OUTER JOIN. In (1), the term is not disabled.
  122997. **
  122998. ** Disabling a term causes that term to not be tested in the inner loop
  122999. ** of the join. Disabling is an optimization. When terms are satisfied
  123000. ** by indices, we disable them to prevent redundant tests in the inner
  123001. ** loop. We would get the correct results if nothing were ever disabled,
  123002. ** but joins might run a little slower. The trick is to disable as much
  123003. ** as we can without disabling too much. If we disabled in (1), we'd get
  123004. ** the wrong answer. See ticket #813.
  123005. **
  123006. ** If all the children of a term are disabled, then that term is also
  123007. ** automatically disabled. In this way, terms get disabled if derived
  123008. ** virtual terms are tested first. For example:
  123009. **
  123010. ** x GLOB 'abc*' AND x>='abc' AND x<'acd'
  123011. ** \___________/ \______/ \_____/
  123012. ** parent child1 child2
  123013. **
  123014. ** Only the parent term was in the original WHERE clause. The child1
  123015. ** and child2 terms were added by the LIKE optimization. If both of
  123016. ** the virtual child terms are valid, then testing of the parent can be
  123017. ** skipped.
  123018. **
  123019. ** Usually the parent term is marked as TERM_CODED. But if the parent
  123020. ** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
  123021. ** The TERM_LIKECOND marking indicates that the term should be coded inside
  123022. ** a conditional such that is only evaluated on the second pass of a
  123023. ** LIKE-optimization loop, when scanning BLOBs instead of strings.
  123024. */
  123025. static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
  123026. int nLoop = 0;
  123027. assert( pTerm!=0 );
  123028. while( (pTerm->wtFlags & TERM_CODED)==0
  123029. && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
  123030. && (pLevel->notReady & pTerm->prereqAll)==0
  123031. ){
  123032. if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
  123033. pTerm->wtFlags |= TERM_LIKECOND;
  123034. }else{
  123035. pTerm->wtFlags |= TERM_CODED;
  123036. }
  123037. if( pTerm->iParent<0 ) break;
  123038. pTerm = &pTerm->pWC->a[pTerm->iParent];
  123039. assert( pTerm!=0 );
  123040. pTerm->nChild--;
  123041. if( pTerm->nChild!=0 ) break;
  123042. nLoop++;
  123043. }
  123044. }
  123045. /*
  123046. ** Code an OP_Affinity opcode to apply the column affinity string zAff
  123047. ** to the n registers starting at base.
  123048. **
  123049. ** As an optimization, SQLITE_AFF_BLOB entries (which are no-ops) at the
  123050. ** beginning and end of zAff are ignored. If all entries in zAff are
  123051. ** SQLITE_AFF_BLOB, then no code gets generated.
  123052. **
  123053. ** This routine makes its own copy of zAff so that the caller is free
  123054. ** to modify zAff after this routine returns.
  123055. */
  123056. static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
  123057. Vdbe *v = pParse->pVdbe;
  123058. if( zAff==0 ){
  123059. assert( pParse->db->mallocFailed );
  123060. return;
  123061. }
  123062. assert( v!=0 );
  123063. /* Adjust base and n to skip over SQLITE_AFF_BLOB entries at the beginning
  123064. ** and end of the affinity string.
  123065. */
  123066. while( n>0 && zAff[0]==SQLITE_AFF_BLOB ){
  123067. n--;
  123068. base++;
  123069. zAff++;
  123070. }
  123071. while( n>1 && zAff[n-1]==SQLITE_AFF_BLOB ){
  123072. n--;
  123073. }
  123074. /* Code the OP_Affinity opcode if there is anything left to do. */
  123075. if( n>0 ){
  123076. sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
  123077. sqlite3ExprCacheAffinityChange(pParse, base, n);
  123078. }
  123079. }
  123080. /*
  123081. ** Expression pRight, which is the RHS of a comparison operation, is
  123082. ** either a vector of n elements or, if n==1, a scalar expression.
  123083. ** Before the comparison operation, affinity zAff is to be applied
  123084. ** to the pRight values. This function modifies characters within the
  123085. ** affinity string to SQLITE_AFF_BLOB if either:
  123086. **
  123087. ** * the comparison will be performed with no affinity, or
  123088. ** * the affinity change in zAff is guaranteed not to change the value.
  123089. */
  123090. static void updateRangeAffinityStr(
  123091. Expr *pRight, /* RHS of comparison */
  123092. int n, /* Number of vector elements in comparison */
  123093. char *zAff /* Affinity string to modify */
  123094. ){
  123095. int i;
  123096. for(i=0; i<n; i++){
  123097. Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
  123098. if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
  123099. || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
  123100. ){
  123101. zAff[i] = SQLITE_AFF_BLOB;
  123102. }
  123103. }
  123104. }
  123105. /*
  123106. ** pX is an expression of the form: (vector) IN (SELECT ...)
  123107. ** In other words, it is a vector IN operator with a SELECT clause on the
  123108. ** LHS. But not all terms in the vector are indexable and the terms might
  123109. ** not be in the correct order for indexing.
  123110. **
  123111. ** This routine makes a copy of the input pX expression and then adjusts
  123112. ** the vector on the LHS with corresponding changes to the SELECT so that
  123113. ** the vector contains only index terms and those terms are in the correct
  123114. ** order. The modified IN expression is returned. The caller is responsible
  123115. ** for deleting the returned expression.
  123116. **
  123117. ** Example:
  123118. **
  123119. ** CREATE TABLE t1(a,b,c,d,e,f);
  123120. ** CREATE INDEX t1x1 ON t1(e,c);
  123121. ** SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
  123122. ** \_______________________________________/
  123123. ** The pX expression
  123124. **
  123125. ** Since only columns e and c can be used with the index, in that order,
  123126. ** the modified IN expression that is returned will be:
  123127. **
  123128. ** (e,c) IN (SELECT z,x FROM t2)
  123129. **
  123130. ** The reduced pX is different from the original (obviously) and thus is
  123131. ** only used for indexing, to improve performance. The original unaltered
  123132. ** IN expression must also be run on each output row for correctness.
  123133. */
  123134. static Expr *removeUnindexableInClauseTerms(
  123135. Parse *pParse, /* The parsing context */
  123136. int iEq, /* Look at loop terms starting here */
  123137. WhereLoop *pLoop, /* The current loop */
  123138. Expr *pX /* The IN expression to be reduced */
  123139. ){
  123140. sqlite3 *db = pParse->db;
  123141. Expr *pNew = sqlite3ExprDup(db, pX, 0);
  123142. if( db->mallocFailed==0 ){
  123143. ExprList *pOrigRhs = pNew->x.pSelect->pEList; /* Original unmodified RHS */
  123144. ExprList *pOrigLhs = pNew->pLeft->x.pList; /* Original unmodified LHS */
  123145. ExprList *pRhs = 0; /* New RHS after modifications */
  123146. ExprList *pLhs = 0; /* New LHS after mods */
  123147. int i; /* Loop counter */
  123148. Select *pSelect; /* Pointer to the SELECT on the RHS */
  123149. for(i=iEq; i<pLoop->nLTerm; i++){
  123150. if( pLoop->aLTerm[i]->pExpr==pX ){
  123151. int iField = pLoop->aLTerm[i]->iField - 1;
  123152. assert( pOrigRhs->a[iField].pExpr!=0 );
  123153. pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
  123154. pOrigRhs->a[iField].pExpr = 0;
  123155. assert( pOrigLhs->a[iField].pExpr!=0 );
  123156. pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
  123157. pOrigLhs->a[iField].pExpr = 0;
  123158. }
  123159. }
  123160. sqlite3ExprListDelete(db, pOrigRhs);
  123161. sqlite3ExprListDelete(db, pOrigLhs);
  123162. pNew->pLeft->x.pList = pLhs;
  123163. pNew->x.pSelect->pEList = pRhs;
  123164. if( pLhs && pLhs->nExpr==1 ){
  123165. /* Take care here not to generate a TK_VECTOR containing only a
  123166. ** single value. Since the parser never creates such a vector, some
  123167. ** of the subroutines do not handle this case. */
  123168. Expr *p = pLhs->a[0].pExpr;
  123169. pLhs->a[0].pExpr = 0;
  123170. sqlite3ExprDelete(db, pNew->pLeft);
  123171. pNew->pLeft = p;
  123172. }
  123173. pSelect = pNew->x.pSelect;
  123174. if( pSelect->pOrderBy ){
  123175. /* If the SELECT statement has an ORDER BY clause, zero the
  123176. ** iOrderByCol variables. These are set to non-zero when an
  123177. ** ORDER BY term exactly matches one of the terms of the
  123178. ** result-set. Since the result-set of the SELECT statement may
  123179. ** have been modified or reordered, these variables are no longer
  123180. ** set correctly. Since setting them is just an optimization,
  123181. ** it's easiest just to zero them here. */
  123182. ExprList *pOrderBy = pSelect->pOrderBy;
  123183. for(i=0; i<pOrderBy->nExpr; i++){
  123184. pOrderBy->a[i].u.x.iOrderByCol = 0;
  123185. }
  123186. }
  123187. #if 0
  123188. printf("For indexing, change the IN expr:\n");
  123189. sqlite3TreeViewExpr(0, pX, 0);
  123190. printf("Into:\n");
  123191. sqlite3TreeViewExpr(0, pNew, 0);
  123192. #endif
  123193. }
  123194. return pNew;
  123195. }
  123196. /*
  123197. ** Generate code for a single equality term of the WHERE clause. An equality
  123198. ** term can be either X=expr or X IN (...). pTerm is the term to be
  123199. ** coded.
  123200. **
  123201. ** The current value for the constraint is left in a register, the index
  123202. ** of which is returned. An attempt is made store the result in iTarget but
  123203. ** this is only guaranteed for TK_ISNULL and TK_IN constraints. If the
  123204. ** constraint is a TK_EQ or TK_IS, then the current value might be left in
  123205. ** some other register and it is the caller's responsibility to compensate.
  123206. **
  123207. ** For a constraint of the form X=expr, the expression is evaluated in
  123208. ** straight-line code. For constraints of the form X IN (...)
  123209. ** this routine sets up a loop that will iterate over all values of X.
  123210. */
  123211. static int codeEqualityTerm(
  123212. Parse *pParse, /* The parsing context */
  123213. WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
  123214. WhereLevel *pLevel, /* The level of the FROM clause we are working on */
  123215. int iEq, /* Index of the equality term within this level */
  123216. int bRev, /* True for reverse-order IN operations */
  123217. int iTarget /* Attempt to leave results in this register */
  123218. ){
  123219. Expr *pX = pTerm->pExpr;
  123220. Vdbe *v = pParse->pVdbe;
  123221. int iReg; /* Register holding results */
  123222. assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
  123223. assert( iTarget>0 );
  123224. if( pX->op==TK_EQ || pX->op==TK_IS ){
  123225. iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
  123226. }else if( pX->op==TK_ISNULL ){
  123227. iReg = iTarget;
  123228. sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
  123229. #ifndef SQLITE_OMIT_SUBQUERY
  123230. }else{
  123231. int eType = IN_INDEX_NOOP;
  123232. int iTab;
  123233. struct InLoop *pIn;
  123234. WhereLoop *pLoop = pLevel->pWLoop;
  123235. int i;
  123236. int nEq = 0;
  123237. int *aiMap = 0;
  123238. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
  123239. && pLoop->u.btree.pIndex!=0
  123240. && pLoop->u.btree.pIndex->aSortOrder[iEq]
  123241. ){
  123242. testcase( iEq==0 );
  123243. testcase( bRev );
  123244. bRev = !bRev;
  123245. }
  123246. assert( pX->op==TK_IN );
  123247. iReg = iTarget;
  123248. for(i=0; i<iEq; i++){
  123249. if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
  123250. disableTerm(pLevel, pTerm);
  123251. return iTarget;
  123252. }
  123253. }
  123254. for(i=iEq;i<pLoop->nLTerm; i++){
  123255. assert( pLoop->aLTerm[i]!=0 );
  123256. if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
  123257. }
  123258. if( (pX->flags & EP_xIsSelect)==0 || pX->x.pSelect->pEList->nExpr==1 ){
  123259. eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0);
  123260. }else{
  123261. sqlite3 *db = pParse->db;
  123262. pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
  123263. if( !db->mallocFailed ){
  123264. aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
  123265. eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap);
  123266. pTerm->pExpr->iTable = pX->iTable;
  123267. }
  123268. sqlite3ExprDelete(db, pX);
  123269. pX = pTerm->pExpr;
  123270. }
  123271. if( eType==IN_INDEX_INDEX_DESC ){
  123272. testcase( bRev );
  123273. bRev = !bRev;
  123274. }
  123275. iTab = pX->iTable;
  123276. sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
  123277. VdbeCoverageIf(v, bRev);
  123278. VdbeCoverageIf(v, !bRev);
  123279. assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
  123280. pLoop->wsFlags |= WHERE_IN_ABLE;
  123281. if( pLevel->u.in.nIn==0 ){
  123282. pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
  123283. }
  123284. i = pLevel->u.in.nIn;
  123285. pLevel->u.in.nIn += nEq;
  123286. pLevel->u.in.aInLoop =
  123287. sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
  123288. sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
  123289. pIn = pLevel->u.in.aInLoop;
  123290. if( pIn ){
  123291. int iMap = 0; /* Index in aiMap[] */
  123292. pIn += i;
  123293. for(i=iEq;i<pLoop->nLTerm; i++){
  123294. if( pLoop->aLTerm[i]->pExpr==pX ){
  123295. int iOut = iReg + i - iEq;
  123296. if( eType==IN_INDEX_ROWID ){
  123297. testcase( nEq>1 ); /* Happens with a UNIQUE index on ROWID */
  123298. pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
  123299. }else{
  123300. int iCol = aiMap ? aiMap[iMap++] : 0;
  123301. pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
  123302. }
  123303. sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
  123304. if( i==iEq ){
  123305. pIn->iCur = iTab;
  123306. pIn->eEndLoopOp = bRev ? OP_PrevIfOpen : OP_NextIfOpen;
  123307. }else{
  123308. pIn->eEndLoopOp = OP_Noop;
  123309. }
  123310. pIn++;
  123311. }
  123312. }
  123313. }else{
  123314. pLevel->u.in.nIn = 0;
  123315. }
  123316. sqlite3DbFree(pParse->db, aiMap);
  123317. #endif
  123318. }
  123319. disableTerm(pLevel, pTerm);
  123320. return iReg;
  123321. }
  123322. /*
  123323. ** Generate code that will evaluate all == and IN constraints for an
  123324. ** index scan.
  123325. **
  123326. ** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
  123327. ** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
  123328. ** The index has as many as three equality constraints, but in this
  123329. ** example, the third "c" value is an inequality. So only two
  123330. ** constraints are coded. This routine will generate code to evaluate
  123331. ** a==5 and b IN (1,2,3). The current values for a and b will be stored
  123332. ** in consecutive registers and the index of the first register is returned.
  123333. **
  123334. ** In the example above nEq==2. But this subroutine works for any value
  123335. ** of nEq including 0. If nEq==0, this routine is nearly a no-op.
  123336. ** The only thing it does is allocate the pLevel->iMem memory cell and
  123337. ** compute the affinity string.
  123338. **
  123339. ** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
  123340. ** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
  123341. ** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
  123342. ** occurs after the nEq quality constraints.
  123343. **
  123344. ** This routine allocates a range of nEq+nExtraReg memory cells and returns
  123345. ** the index of the first memory cell in that range. The code that
  123346. ** calls this routine will use that memory range to store keys for
  123347. ** start and termination conditions of the loop.
  123348. ** key value of the loop. If one or more IN operators appear, then
  123349. ** this routine allocates an additional nEq memory cells for internal
  123350. ** use.
  123351. **
  123352. ** Before returning, *pzAff is set to point to a buffer containing a
  123353. ** copy of the column affinity string of the index allocated using
  123354. ** sqlite3DbMalloc(). Except, entries in the copy of the string associated
  123355. ** with equality constraints that use BLOB or NONE affinity are set to
  123356. ** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
  123357. **
  123358. ** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
  123359. ** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
  123360. **
  123361. ** In the example above, the index on t1(a) has TEXT affinity. But since
  123362. ** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
  123363. ** no conversion should be attempted before using a t2.b value as part of
  123364. ** a key to search the index. Hence the first byte in the returned affinity
  123365. ** string in this example would be set to SQLITE_AFF_BLOB.
  123366. */
  123367. static int codeAllEqualityTerms(
  123368. Parse *pParse, /* Parsing context */
  123369. WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
  123370. int bRev, /* Reverse the order of IN operators */
  123371. int nExtraReg, /* Number of extra registers to allocate */
  123372. char **pzAff /* OUT: Set to point to affinity string */
  123373. ){
  123374. u16 nEq; /* The number of == or IN constraints to code */
  123375. u16 nSkip; /* Number of left-most columns to skip */
  123376. Vdbe *v = pParse->pVdbe; /* The vm under construction */
  123377. Index *pIdx; /* The index being used for this loop */
  123378. WhereTerm *pTerm; /* A single constraint term */
  123379. WhereLoop *pLoop; /* The WhereLoop object */
  123380. int j; /* Loop counter */
  123381. int regBase; /* Base register */
  123382. int nReg; /* Number of registers to allocate */
  123383. char *zAff; /* Affinity string to return */
  123384. /* This module is only called on query plans that use an index. */
  123385. pLoop = pLevel->pWLoop;
  123386. assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
  123387. nEq = pLoop->u.btree.nEq;
  123388. nSkip = pLoop->nSkip;
  123389. pIdx = pLoop->u.btree.pIndex;
  123390. assert( pIdx!=0 );
  123391. /* Figure out how many memory cells we will need then allocate them.
  123392. */
  123393. regBase = pParse->nMem + 1;
  123394. nReg = pLoop->u.btree.nEq + nExtraReg;
  123395. pParse->nMem += nReg;
  123396. zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
  123397. assert( zAff!=0 || pParse->db->mallocFailed );
  123398. if( nSkip ){
  123399. int iIdxCur = pLevel->iIdxCur;
  123400. sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
  123401. VdbeCoverageIf(v, bRev==0);
  123402. VdbeCoverageIf(v, bRev!=0);
  123403. VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
  123404. j = sqlite3VdbeAddOp0(v, OP_Goto);
  123405. pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
  123406. iIdxCur, 0, regBase, nSkip);
  123407. VdbeCoverageIf(v, bRev==0);
  123408. VdbeCoverageIf(v, bRev!=0);
  123409. sqlite3VdbeJumpHere(v, j);
  123410. for(j=0; j<nSkip; j++){
  123411. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
  123412. testcase( pIdx->aiColumn[j]==XN_EXPR );
  123413. VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
  123414. }
  123415. }
  123416. /* Evaluate the equality constraints
  123417. */
  123418. assert( zAff==0 || (int)strlen(zAff)>=nEq );
  123419. for(j=nSkip; j<nEq; j++){
  123420. int r1;
  123421. pTerm = pLoop->aLTerm[j];
  123422. assert( pTerm!=0 );
  123423. /* The following testcase is true for indices with redundant columns.
  123424. ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
  123425. testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
  123426. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  123427. r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
  123428. if( r1!=regBase+j ){
  123429. if( nReg==1 ){
  123430. sqlite3ReleaseTempReg(pParse, regBase);
  123431. regBase = r1;
  123432. }else{
  123433. sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
  123434. }
  123435. }
  123436. if( pTerm->eOperator & WO_IN ){
  123437. if( pTerm->pExpr->flags & EP_xIsSelect ){
  123438. /* No affinity ever needs to be (or should be) applied to a value
  123439. ** from the RHS of an "? IN (SELECT ...)" expression. The
  123440. ** sqlite3FindInIndex() routine has already ensured that the
  123441. ** affinity of the comparison has been applied to the value. */
  123442. if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
  123443. }
  123444. }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
  123445. Expr *pRight = pTerm->pExpr->pRight;
  123446. if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
  123447. sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
  123448. VdbeCoverage(v);
  123449. }
  123450. if( zAff ){
  123451. if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
  123452. zAff[j] = SQLITE_AFF_BLOB;
  123453. }
  123454. if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
  123455. zAff[j] = SQLITE_AFF_BLOB;
  123456. }
  123457. }
  123458. }
  123459. }
  123460. *pzAff = zAff;
  123461. return regBase;
  123462. }
  123463. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  123464. /*
  123465. ** If the most recently coded instruction is a constant range constraint
  123466. ** (a string literal) that originated from the LIKE optimization, then
  123467. ** set P3 and P5 on the OP_String opcode so that the string will be cast
  123468. ** to a BLOB at appropriate times.
  123469. **
  123470. ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
  123471. ** expression: "x>='ABC' AND x<'abd'". But this requires that the range
  123472. ** scan loop run twice, once for strings and a second time for BLOBs.
  123473. ** The OP_String opcodes on the second pass convert the upper and lower
  123474. ** bound string constants to blobs. This routine makes the necessary changes
  123475. ** to the OP_String opcodes for that to happen.
  123476. **
  123477. ** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
  123478. ** only the one pass through the string space is required, so this routine
  123479. ** becomes a no-op.
  123480. */
  123481. static void whereLikeOptimizationStringFixup(
  123482. Vdbe *v, /* prepared statement under construction */
  123483. WhereLevel *pLevel, /* The loop that contains the LIKE operator */
  123484. WhereTerm *pTerm /* The upper or lower bound just coded */
  123485. ){
  123486. if( pTerm->wtFlags & TERM_LIKEOPT ){
  123487. VdbeOp *pOp;
  123488. assert( pLevel->iLikeRepCntr>0 );
  123489. pOp = sqlite3VdbeGetOp(v, -1);
  123490. assert( pOp!=0 );
  123491. assert( pOp->opcode==OP_String8
  123492. || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
  123493. pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
  123494. pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
  123495. }
  123496. }
  123497. #else
  123498. # define whereLikeOptimizationStringFixup(A,B,C)
  123499. #endif
  123500. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  123501. /*
  123502. ** Information is passed from codeCursorHint() down to individual nodes of
  123503. ** the expression tree (by sqlite3WalkExpr()) using an instance of this
  123504. ** structure.
  123505. */
  123506. struct CCurHint {
  123507. int iTabCur; /* Cursor for the main table */
  123508. int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
  123509. Index *pIdx; /* The index used to access the table */
  123510. };
  123511. /*
  123512. ** This function is called for every node of an expression that is a candidate
  123513. ** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
  123514. ** the table CCurHint.iTabCur, verify that the same column can be
  123515. ** accessed through the index. If it cannot, then set pWalker->eCode to 1.
  123516. */
  123517. static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
  123518. struct CCurHint *pHint = pWalker->u.pCCurHint;
  123519. assert( pHint->pIdx!=0 );
  123520. if( pExpr->op==TK_COLUMN
  123521. && pExpr->iTable==pHint->iTabCur
  123522. && sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn)<0
  123523. ){
  123524. pWalker->eCode = 1;
  123525. }
  123526. return WRC_Continue;
  123527. }
  123528. /*
  123529. ** Test whether or not expression pExpr, which was part of a WHERE clause,
  123530. ** should be included in the cursor-hint for a table that is on the rhs
  123531. ** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
  123532. ** expression is not suitable.
  123533. **
  123534. ** An expression is unsuitable if it might evaluate to non NULL even if
  123535. ** a TK_COLUMN node that does affect the value of the expression is set
  123536. ** to NULL. For example:
  123537. **
  123538. ** col IS NULL
  123539. ** col IS NOT NULL
  123540. ** coalesce(col, 1)
  123541. ** CASE WHEN col THEN 0 ELSE 1 END
  123542. */
  123543. static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
  123544. if( pExpr->op==TK_IS
  123545. || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
  123546. || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
  123547. ){
  123548. pWalker->eCode = 1;
  123549. }else if( pExpr->op==TK_FUNCTION ){
  123550. int d1;
  123551. char d2[4];
  123552. if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
  123553. pWalker->eCode = 1;
  123554. }
  123555. }
  123556. return WRC_Continue;
  123557. }
  123558. /*
  123559. ** This function is called on every node of an expression tree used as an
  123560. ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
  123561. ** that accesses any table other than the one identified by
  123562. ** CCurHint.iTabCur, then do the following:
  123563. **
  123564. ** 1) allocate a register and code an OP_Column instruction to read
  123565. ** the specified column into the new register, and
  123566. **
  123567. ** 2) transform the expression node to a TK_REGISTER node that reads
  123568. ** from the newly populated register.
  123569. **
  123570. ** Also, if the node is a TK_COLUMN that does access the table idenified
  123571. ** by pCCurHint.iTabCur, and an index is being used (which we will
  123572. ** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
  123573. ** an access of the index rather than the original table.
  123574. */
  123575. static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
  123576. int rc = WRC_Continue;
  123577. struct CCurHint *pHint = pWalker->u.pCCurHint;
  123578. if( pExpr->op==TK_COLUMN ){
  123579. if( pExpr->iTable!=pHint->iTabCur ){
  123580. Vdbe *v = pWalker->pParse->pVdbe;
  123581. int reg = ++pWalker->pParse->nMem; /* Register for column value */
  123582. sqlite3ExprCodeGetColumnOfTable(
  123583. v, pExpr->pTab, pExpr->iTable, pExpr->iColumn, reg
  123584. );
  123585. pExpr->op = TK_REGISTER;
  123586. pExpr->iTable = reg;
  123587. }else if( pHint->pIdx!=0 ){
  123588. pExpr->iTable = pHint->iIdxCur;
  123589. pExpr->iColumn = sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn);
  123590. assert( pExpr->iColumn>=0 );
  123591. }
  123592. }else if( pExpr->op==TK_AGG_FUNCTION ){
  123593. /* An aggregate function in the WHERE clause of a query means this must
  123594. ** be a correlated sub-query, and expression pExpr is an aggregate from
  123595. ** the parent context. Do not walk the function arguments in this case.
  123596. **
  123597. ** todo: It should be possible to replace this node with a TK_REGISTER
  123598. ** expression, as the result of the expression must be stored in a
  123599. ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
  123600. rc = WRC_Prune;
  123601. }
  123602. return rc;
  123603. }
  123604. /*
  123605. ** Insert an OP_CursorHint instruction if it is appropriate to do so.
  123606. */
  123607. static void codeCursorHint(
  123608. struct SrcList_item *pTabItem, /* FROM clause item */
  123609. WhereInfo *pWInfo, /* The where clause */
  123610. WhereLevel *pLevel, /* Which loop to provide hints for */
  123611. WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
  123612. ){
  123613. Parse *pParse = pWInfo->pParse;
  123614. sqlite3 *db = pParse->db;
  123615. Vdbe *v = pParse->pVdbe;
  123616. Expr *pExpr = 0;
  123617. WhereLoop *pLoop = pLevel->pWLoop;
  123618. int iCur;
  123619. WhereClause *pWC;
  123620. WhereTerm *pTerm;
  123621. int i, j;
  123622. struct CCurHint sHint;
  123623. Walker sWalker;
  123624. if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
  123625. iCur = pLevel->iTabCur;
  123626. assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
  123627. sHint.iTabCur = iCur;
  123628. sHint.iIdxCur = pLevel->iIdxCur;
  123629. sHint.pIdx = pLoop->u.btree.pIndex;
  123630. memset(&sWalker, 0, sizeof(sWalker));
  123631. sWalker.pParse = pParse;
  123632. sWalker.u.pCCurHint = &sHint;
  123633. pWC = &pWInfo->sWC;
  123634. for(i=0; i<pWC->nTerm; i++){
  123635. pTerm = &pWC->a[i];
  123636. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  123637. if( pTerm->prereqAll & pLevel->notReady ) continue;
  123638. /* Any terms specified as part of the ON(...) clause for any LEFT
  123639. ** JOIN for which the current table is not the rhs are omitted
  123640. ** from the cursor-hint.
  123641. **
  123642. ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
  123643. ** that were specified as part of the WHERE clause must be excluded.
  123644. ** This is to address the following:
  123645. **
  123646. ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
  123647. **
  123648. ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
  123649. ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
  123650. ** pushed down to the cursor, this row is filtered out, causing
  123651. ** SQLite to synthesize a row of NULL values. Which does match the
  123652. ** WHERE clause, and so the query returns a row. Which is incorrect.
  123653. **
  123654. ** For the same reason, WHERE terms such as:
  123655. **
  123656. ** WHERE 1 = (t2.c IS NULL)
  123657. **
  123658. ** are also excluded. See codeCursorHintIsOrFunction() for details.
  123659. */
  123660. if( pTabItem->fg.jointype & JT_LEFT ){
  123661. Expr *pExpr = pTerm->pExpr;
  123662. if( !ExprHasProperty(pExpr, EP_FromJoin)
  123663. || pExpr->iRightJoinTable!=pTabItem->iCursor
  123664. ){
  123665. sWalker.eCode = 0;
  123666. sWalker.xExprCallback = codeCursorHintIsOrFunction;
  123667. sqlite3WalkExpr(&sWalker, pTerm->pExpr);
  123668. if( sWalker.eCode ) continue;
  123669. }
  123670. }else{
  123671. if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
  123672. }
  123673. /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
  123674. ** the cursor. These terms are not needed as hints for a pure range
  123675. ** scan (that has no == terms) so omit them. */
  123676. if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
  123677. for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
  123678. if( j<pLoop->nLTerm ) continue;
  123679. }
  123680. /* No subqueries or non-deterministic functions allowed */
  123681. if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
  123682. /* For an index scan, make sure referenced columns are actually in
  123683. ** the index. */
  123684. if( sHint.pIdx!=0 ){
  123685. sWalker.eCode = 0;
  123686. sWalker.xExprCallback = codeCursorHintCheckExpr;
  123687. sqlite3WalkExpr(&sWalker, pTerm->pExpr);
  123688. if( sWalker.eCode ) continue;
  123689. }
  123690. /* If we survive all prior tests, that means this term is worth hinting */
  123691. pExpr = sqlite3ExprAnd(db, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
  123692. }
  123693. if( pExpr!=0 ){
  123694. sWalker.xExprCallback = codeCursorHintFixExpr;
  123695. sqlite3WalkExpr(&sWalker, pExpr);
  123696. sqlite3VdbeAddOp4(v, OP_CursorHint,
  123697. (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
  123698. (const char*)pExpr, P4_EXPR);
  123699. }
  123700. }
  123701. #else
  123702. # define codeCursorHint(A,B,C,D) /* No-op */
  123703. #endif /* SQLITE_ENABLE_CURSOR_HINTS */
  123704. /*
  123705. ** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
  123706. ** a rowid value just read from cursor iIdxCur, open on index pIdx. This
  123707. ** function generates code to do a deferred seek of cursor iCur to the
  123708. ** rowid stored in register iRowid.
  123709. **
  123710. ** Normally, this is just:
  123711. **
  123712. ** OP_DeferredSeek $iCur $iRowid
  123713. **
  123714. ** However, if the scan currently being coded is a branch of an OR-loop and
  123715. ** the statement currently being coded is a SELECT, then P3 of OP_DeferredSeek
  123716. ** is set to iIdxCur and P4 is set to point to an array of integers
  123717. ** containing one entry for each column of the table cursor iCur is open
  123718. ** on. For each table column, if the column is the i'th column of the
  123719. ** index, then the corresponding array entry is set to (i+1). If the column
  123720. ** does not appear in the index at all, the array entry is set to 0.
  123721. */
  123722. static void codeDeferredSeek(
  123723. WhereInfo *pWInfo, /* Where clause context */
  123724. Index *pIdx, /* Index scan is using */
  123725. int iCur, /* Cursor for IPK b-tree */
  123726. int iIdxCur /* Index cursor */
  123727. ){
  123728. Parse *pParse = pWInfo->pParse; /* Parse context */
  123729. Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
  123730. assert( iIdxCur>0 );
  123731. assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
  123732. sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
  123733. if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
  123734. && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
  123735. ){
  123736. int i;
  123737. Table *pTab = pIdx->pTable;
  123738. int *ai = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*(pTab->nCol+1));
  123739. if( ai ){
  123740. ai[0] = pTab->nCol;
  123741. for(i=0; i<pIdx->nColumn-1; i++){
  123742. assert( pIdx->aiColumn[i]<pTab->nCol );
  123743. if( pIdx->aiColumn[i]>=0 ) ai[pIdx->aiColumn[i]+1] = i+1;
  123744. }
  123745. sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
  123746. }
  123747. }
  123748. }
  123749. /*
  123750. ** If the expression passed as the second argument is a vector, generate
  123751. ** code to write the first nReg elements of the vector into an array
  123752. ** of registers starting with iReg.
  123753. **
  123754. ** If the expression is not a vector, then nReg must be passed 1. In
  123755. ** this case, generate code to evaluate the expression and leave the
  123756. ** result in register iReg.
  123757. */
  123758. static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
  123759. assert( nReg>0 );
  123760. if( p && sqlite3ExprIsVector(p) ){
  123761. #ifndef SQLITE_OMIT_SUBQUERY
  123762. if( (p->flags & EP_xIsSelect) ){
  123763. Vdbe *v = pParse->pVdbe;
  123764. int iSelect = sqlite3CodeSubselect(pParse, p, 0, 0);
  123765. sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
  123766. }else
  123767. #endif
  123768. {
  123769. int i;
  123770. ExprList *pList = p->x.pList;
  123771. assert( nReg<=pList->nExpr );
  123772. for(i=0; i<nReg; i++){
  123773. sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
  123774. }
  123775. }
  123776. }else{
  123777. assert( nReg==1 );
  123778. sqlite3ExprCode(pParse, p, iReg);
  123779. }
  123780. }
  123781. /* An instance of the IdxExprTrans object carries information about a
  123782. ** mapping from an expression on table columns into a column in an index
  123783. ** down through the Walker.
  123784. */
  123785. typedef struct IdxExprTrans {
  123786. Expr *pIdxExpr; /* The index expression */
  123787. int iTabCur; /* The cursor of the corresponding table */
  123788. int iIdxCur; /* The cursor for the index */
  123789. int iIdxCol; /* The column for the index */
  123790. } IdxExprTrans;
  123791. /* The walker node callback used to transform matching expressions into
  123792. ** a reference to an index column for an index on an expression.
  123793. **
  123794. ** If pExpr matches, then transform it into a reference to the index column
  123795. ** that contains the value of pExpr.
  123796. */
  123797. static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
  123798. IdxExprTrans *pX = p->u.pIdxTrans;
  123799. if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
  123800. pExpr->op = TK_COLUMN;
  123801. pExpr->iTable = pX->iIdxCur;
  123802. pExpr->iColumn = pX->iIdxCol;
  123803. pExpr->pTab = 0;
  123804. return WRC_Prune;
  123805. }else{
  123806. return WRC_Continue;
  123807. }
  123808. }
  123809. /*
  123810. ** For an indexes on expression X, locate every instance of expression X
  123811. ** in pExpr and change that subexpression into a reference to the appropriate
  123812. ** column of the index.
  123813. */
  123814. static void whereIndexExprTrans(
  123815. Index *pIdx, /* The Index */
  123816. int iTabCur, /* Cursor of the table that is being indexed */
  123817. int iIdxCur, /* Cursor of the index itself */
  123818. WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
  123819. ){
  123820. int iIdxCol; /* Column number of the index */
  123821. ExprList *aColExpr; /* Expressions that are indexed */
  123822. Walker w;
  123823. IdxExprTrans x;
  123824. aColExpr = pIdx->aColExpr;
  123825. if( aColExpr==0 ) return; /* Not an index on expressions */
  123826. memset(&w, 0, sizeof(w));
  123827. w.xExprCallback = whereIndexExprTransNode;
  123828. w.u.pIdxTrans = &x;
  123829. x.iTabCur = iTabCur;
  123830. x.iIdxCur = iIdxCur;
  123831. for(iIdxCol=0; iIdxCol<aColExpr->nExpr; iIdxCol++){
  123832. if( pIdx->aiColumn[iIdxCol]!=XN_EXPR ) continue;
  123833. assert( aColExpr->a[iIdxCol].pExpr!=0 );
  123834. x.iIdxCol = iIdxCol;
  123835. x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
  123836. sqlite3WalkExpr(&w, pWInfo->pWhere);
  123837. sqlite3WalkExprList(&w, pWInfo->pOrderBy);
  123838. sqlite3WalkExprList(&w, pWInfo->pResultSet);
  123839. }
  123840. }
  123841. /*
  123842. ** Generate code for the start of the iLevel-th loop in the WHERE clause
  123843. ** implementation described by pWInfo.
  123844. */
  123845. SQLITE_PRIVATE Bitmask sqlite3WhereCodeOneLoopStart(
  123846. WhereInfo *pWInfo, /* Complete information about the WHERE clause */
  123847. int iLevel, /* Which level of pWInfo->a[] should be coded */
  123848. Bitmask notReady /* Which tables are currently available */
  123849. ){
  123850. int j, k; /* Loop counters */
  123851. int iCur; /* The VDBE cursor for the table */
  123852. int addrNxt; /* Where to jump to continue with the next IN case */
  123853. int omitTable; /* True if we use the index only */
  123854. int bRev; /* True if we need to scan in reverse order */
  123855. WhereLevel *pLevel; /* The where level to be coded */
  123856. WhereLoop *pLoop; /* The WhereLoop object being coded */
  123857. WhereClause *pWC; /* Decomposition of the entire WHERE clause */
  123858. WhereTerm *pTerm; /* A WHERE clause term */
  123859. Parse *pParse; /* Parsing context */
  123860. sqlite3 *db; /* Database connection */
  123861. Vdbe *v; /* The prepared stmt under constructions */
  123862. struct SrcList_item *pTabItem; /* FROM clause term being coded */
  123863. int addrBrk; /* Jump here to break out of the loop */
  123864. int addrHalt; /* addrBrk for the outermost loop */
  123865. int addrCont; /* Jump here to continue with next cycle */
  123866. int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
  123867. int iReleaseReg = 0; /* Temp register to free before returning */
  123868. Index *pIdx = 0; /* Index used by loop (if any) */
  123869. int iLoop; /* Iteration of constraint generator loop */
  123870. pParse = pWInfo->pParse;
  123871. v = pParse->pVdbe;
  123872. pWC = &pWInfo->sWC;
  123873. db = pParse->db;
  123874. pLevel = &pWInfo->a[iLevel];
  123875. pLoop = pLevel->pWLoop;
  123876. pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
  123877. iCur = pTabItem->iCursor;
  123878. pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
  123879. bRev = (pWInfo->revMask>>iLevel)&1;
  123880. omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
  123881. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
  123882. VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
  123883. /* Create labels for the "break" and "continue" instructions
  123884. ** for the current loop. Jump to addrBrk to break out of a loop.
  123885. ** Jump to cont to go immediately to the next iteration of the
  123886. ** loop.
  123887. **
  123888. ** When there is an IN operator, we also have a "addrNxt" label that
  123889. ** means to continue with the next IN value combination. When
  123890. ** there are no IN operators in the constraints, the "addrNxt" label
  123891. ** is the same as "addrBrk".
  123892. */
  123893. addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
  123894. addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
  123895. /* If this is the right table of a LEFT OUTER JOIN, allocate and
  123896. ** initialize a memory cell that records if this table matches any
  123897. ** row of the left table of the join.
  123898. */
  123899. if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
  123900. pLevel->iLeftJoin = ++pParse->nMem;
  123901. sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
  123902. VdbeComment((v, "init LEFT JOIN no-match flag"));
  123903. }
  123904. /* Compute a safe address to jump to if we discover that the table for
  123905. ** this loop is empty and can never contribute content. */
  123906. for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
  123907. addrHalt = pWInfo->a[j].addrBrk;
  123908. /* Special case of a FROM clause subquery implemented as a co-routine */
  123909. if( pTabItem->fg.viaCoroutine ){
  123910. int regYield = pTabItem->regReturn;
  123911. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
  123912. pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
  123913. VdbeCoverage(v);
  123914. VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
  123915. pLevel->op = OP_Goto;
  123916. }else
  123917. #ifndef SQLITE_OMIT_VIRTUALTABLE
  123918. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
  123919. /* Case 1: The table is a virtual-table. Use the VFilter and VNext
  123920. ** to access the data.
  123921. */
  123922. int iReg; /* P3 Value for OP_VFilter */
  123923. int addrNotFound;
  123924. int nConstraint = pLoop->nLTerm;
  123925. int iIn; /* Counter for IN constraints */
  123926. sqlite3ExprCachePush(pParse);
  123927. iReg = sqlite3GetTempRange(pParse, nConstraint+2);
  123928. addrNotFound = pLevel->addrBrk;
  123929. for(j=0; j<nConstraint; j++){
  123930. int iTarget = iReg+j+2;
  123931. pTerm = pLoop->aLTerm[j];
  123932. if( NEVER(pTerm==0) ) continue;
  123933. if( pTerm->eOperator & WO_IN ){
  123934. codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
  123935. addrNotFound = pLevel->addrNxt;
  123936. }else{
  123937. Expr *pRight = pTerm->pExpr->pRight;
  123938. codeExprOrVector(pParse, pRight, iTarget, 1);
  123939. }
  123940. }
  123941. sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
  123942. sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
  123943. sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
  123944. pLoop->u.vtab.idxStr,
  123945. pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
  123946. VdbeCoverage(v);
  123947. pLoop->u.vtab.needFree = 0;
  123948. pLevel->p1 = iCur;
  123949. pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
  123950. pLevel->p2 = sqlite3VdbeCurrentAddr(v);
  123951. iIn = pLevel->u.in.nIn;
  123952. for(j=nConstraint-1; j>=0; j--){
  123953. pTerm = pLoop->aLTerm[j];
  123954. if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
  123955. disableTerm(pLevel, pTerm);
  123956. }else if( (pTerm->eOperator & WO_IN)!=0 ){
  123957. Expr *pCompare; /* The comparison operator */
  123958. Expr *pRight; /* RHS of the comparison */
  123959. VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
  123960. /* Reload the constraint value into reg[iReg+j+2]. The same value
  123961. ** was loaded into the same register prior to the OP_VFilter, but
  123962. ** the xFilter implementation might have changed the datatype or
  123963. ** encoding of the value in the register, so it *must* be reloaded. */
  123964. assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
  123965. if( !db->mallocFailed ){
  123966. assert( iIn>0 );
  123967. pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[--iIn].addrInTop);
  123968. assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
  123969. assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
  123970. assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
  123971. testcase( pOp->opcode==OP_Rowid );
  123972. sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
  123973. }
  123974. /* Generate code that will continue to the next row if
  123975. ** the IN constraint is not satisfied */
  123976. pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
  123977. assert( pCompare!=0 || db->mallocFailed );
  123978. if( pCompare ){
  123979. pCompare->pLeft = pTerm->pExpr->pLeft;
  123980. pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
  123981. if( pRight ){
  123982. pRight->iTable = iReg+j+2;
  123983. sqlite3ExprIfFalse(pParse, pCompare, pLevel->addrCont, 0);
  123984. }
  123985. pCompare->pLeft = 0;
  123986. sqlite3ExprDelete(db, pCompare);
  123987. }
  123988. }
  123989. }
  123990. /* These registers need to be preserved in case there is an IN operator
  123991. ** loop. So we could deallocate the registers here (and potentially
  123992. ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
  123993. ** simpler and safer to simply not reuse the registers.
  123994. **
  123995. ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
  123996. */
  123997. sqlite3ExprCachePop(pParse);
  123998. }else
  123999. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  124000. if( (pLoop->wsFlags & WHERE_IPK)!=0
  124001. && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
  124002. ){
  124003. /* Case 2: We can directly reference a single row using an
  124004. ** equality comparison against the ROWID field. Or
  124005. ** we reference multiple rows using a "rowid IN (...)"
  124006. ** construct.
  124007. */
  124008. assert( pLoop->u.btree.nEq==1 );
  124009. pTerm = pLoop->aLTerm[0];
  124010. assert( pTerm!=0 );
  124011. assert( pTerm->pExpr!=0 );
  124012. assert( omitTable==0 );
  124013. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  124014. iReleaseReg = ++pParse->nMem;
  124015. iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
  124016. if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
  124017. addrNxt = pLevel->addrNxt;
  124018. sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
  124019. VdbeCoverage(v);
  124020. sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
  124021. sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
  124022. VdbeComment((v, "pk"));
  124023. pLevel->op = OP_Noop;
  124024. }else if( (pLoop->wsFlags & WHERE_IPK)!=0
  124025. && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
  124026. ){
  124027. /* Case 3: We have an inequality comparison against the ROWID field.
  124028. */
  124029. int testOp = OP_Noop;
  124030. int start;
  124031. int memEndValue = 0;
  124032. WhereTerm *pStart, *pEnd;
  124033. assert( omitTable==0 );
  124034. j = 0;
  124035. pStart = pEnd = 0;
  124036. if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
  124037. if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
  124038. assert( pStart!=0 || pEnd!=0 );
  124039. if( bRev ){
  124040. pTerm = pStart;
  124041. pStart = pEnd;
  124042. pEnd = pTerm;
  124043. }
  124044. codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
  124045. if( pStart ){
  124046. Expr *pX; /* The expression that defines the start bound */
  124047. int r1, rTemp; /* Registers for holding the start boundary */
  124048. int op; /* Cursor seek operation */
  124049. /* The following constant maps TK_xx codes into corresponding
  124050. ** seek opcodes. It depends on a particular ordering of TK_xx
  124051. */
  124052. const u8 aMoveOp[] = {
  124053. /* TK_GT */ OP_SeekGT,
  124054. /* TK_LE */ OP_SeekLE,
  124055. /* TK_LT */ OP_SeekLT,
  124056. /* TK_GE */ OP_SeekGE
  124057. };
  124058. assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
  124059. assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
  124060. assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
  124061. assert( (pStart->wtFlags & TERM_VNULL)==0 );
  124062. testcase( pStart->wtFlags & TERM_VIRTUAL );
  124063. pX = pStart->pExpr;
  124064. assert( pX!=0 );
  124065. testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
  124066. if( sqlite3ExprIsVector(pX->pRight) ){
  124067. r1 = rTemp = sqlite3GetTempReg(pParse);
  124068. codeExprOrVector(pParse, pX->pRight, r1, 1);
  124069. testcase( pX->op==TK_GT );
  124070. testcase( pX->op==TK_GE );
  124071. testcase( pX->op==TK_LT );
  124072. testcase( pX->op==TK_LE );
  124073. op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
  124074. assert( pX->op!=TK_GT || op==OP_SeekGE );
  124075. assert( pX->op!=TK_GE || op==OP_SeekGE );
  124076. assert( pX->op!=TK_LT || op==OP_SeekLE );
  124077. assert( pX->op!=TK_LE || op==OP_SeekLE );
  124078. }else{
  124079. r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
  124080. disableTerm(pLevel, pStart);
  124081. op = aMoveOp[(pX->op - TK_GT)];
  124082. }
  124083. sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
  124084. VdbeComment((v, "pk"));
  124085. VdbeCoverageIf(v, pX->op==TK_GT);
  124086. VdbeCoverageIf(v, pX->op==TK_LE);
  124087. VdbeCoverageIf(v, pX->op==TK_LT);
  124088. VdbeCoverageIf(v, pX->op==TK_GE);
  124089. sqlite3ExprCacheAffinityChange(pParse, r1, 1);
  124090. sqlite3ReleaseTempReg(pParse, rTemp);
  124091. }else{
  124092. sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
  124093. VdbeCoverageIf(v, bRev==0);
  124094. VdbeCoverageIf(v, bRev!=0);
  124095. }
  124096. if( pEnd ){
  124097. Expr *pX;
  124098. pX = pEnd->pExpr;
  124099. assert( pX!=0 );
  124100. assert( (pEnd->wtFlags & TERM_VNULL)==0 );
  124101. testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
  124102. testcase( pEnd->wtFlags & TERM_VIRTUAL );
  124103. memEndValue = ++pParse->nMem;
  124104. codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
  124105. if( 0==sqlite3ExprIsVector(pX->pRight)
  124106. && (pX->op==TK_LT || pX->op==TK_GT)
  124107. ){
  124108. testOp = bRev ? OP_Le : OP_Ge;
  124109. }else{
  124110. testOp = bRev ? OP_Lt : OP_Gt;
  124111. }
  124112. if( 0==sqlite3ExprIsVector(pX->pRight) ){
  124113. disableTerm(pLevel, pEnd);
  124114. }
  124115. }
  124116. start = sqlite3VdbeCurrentAddr(v);
  124117. pLevel->op = bRev ? OP_Prev : OP_Next;
  124118. pLevel->p1 = iCur;
  124119. pLevel->p2 = start;
  124120. assert( pLevel->p5==0 );
  124121. if( testOp!=OP_Noop ){
  124122. iRowidReg = ++pParse->nMem;
  124123. sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
  124124. sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
  124125. sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
  124126. VdbeCoverageIf(v, testOp==OP_Le);
  124127. VdbeCoverageIf(v, testOp==OP_Lt);
  124128. VdbeCoverageIf(v, testOp==OP_Ge);
  124129. VdbeCoverageIf(v, testOp==OP_Gt);
  124130. sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
  124131. }
  124132. }else if( pLoop->wsFlags & WHERE_INDEXED ){
  124133. /* Case 4: A scan using an index.
  124134. **
  124135. ** The WHERE clause may contain zero or more equality
  124136. ** terms ("==" or "IN" operators) that refer to the N
  124137. ** left-most columns of the index. It may also contain
  124138. ** inequality constraints (>, <, >= or <=) on the indexed
  124139. ** column that immediately follows the N equalities. Only
  124140. ** the right-most column can be an inequality - the rest must
  124141. ** use the "==" and "IN" operators. For example, if the
  124142. ** index is on (x,y,z), then the following clauses are all
  124143. ** optimized:
  124144. **
  124145. ** x=5
  124146. ** x=5 AND y=10
  124147. ** x=5 AND y<10
  124148. ** x=5 AND y>5 AND y<10
  124149. ** x=5 AND y=5 AND z<=10
  124150. **
  124151. ** The z<10 term of the following cannot be used, only
  124152. ** the x=5 term:
  124153. **
  124154. ** x=5 AND z<10
  124155. **
  124156. ** N may be zero if there are inequality constraints.
  124157. ** If there are no inequality constraints, then N is at
  124158. ** least one.
  124159. **
  124160. ** This case is also used when there are no WHERE clause
  124161. ** constraints but an index is selected anyway, in order
  124162. ** to force the output order to conform to an ORDER BY.
  124163. */
  124164. static const u8 aStartOp[] = {
  124165. 0,
  124166. 0,
  124167. OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
  124168. OP_Last, /* 3: (!start_constraints && startEq && bRev) */
  124169. OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
  124170. OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
  124171. OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
  124172. OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
  124173. };
  124174. static const u8 aEndOp[] = {
  124175. OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
  124176. OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
  124177. OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
  124178. OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
  124179. };
  124180. u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
  124181. u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
  124182. u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
  124183. int regBase; /* Base register holding constraint values */
  124184. WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
  124185. WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
  124186. int startEq; /* True if range start uses ==, >= or <= */
  124187. int endEq; /* True if range end uses ==, >= or <= */
  124188. int start_constraints; /* Start of range is constrained */
  124189. int nConstraint; /* Number of constraint terms */
  124190. int iIdxCur; /* The VDBE cursor for the index */
  124191. int nExtraReg = 0; /* Number of extra registers needed */
  124192. int op; /* Instruction opcode */
  124193. char *zStartAff; /* Affinity for start of range constraint */
  124194. char *zEndAff = 0; /* Affinity for end of range constraint */
  124195. u8 bSeekPastNull = 0; /* True to seek past initial nulls */
  124196. u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
  124197. pIdx = pLoop->u.btree.pIndex;
  124198. iIdxCur = pLevel->iIdxCur;
  124199. assert( nEq>=pLoop->nSkip );
  124200. /* If this loop satisfies a sort order (pOrderBy) request that
  124201. ** was passed to this function to implement a "SELECT min(x) ..."
  124202. ** query, then the caller will only allow the loop to run for
  124203. ** a single iteration. This means that the first row returned
  124204. ** should not have a NULL value stored in 'x'. If column 'x' is
  124205. ** the first one after the nEq equality constraints in the index,
  124206. ** this requires some special handling.
  124207. */
  124208. assert( pWInfo->pOrderBy==0
  124209. || pWInfo->pOrderBy->nExpr==1
  124210. || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
  124211. if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
  124212. && pWInfo->nOBSat>0
  124213. && (pIdx->nKeyCol>nEq)
  124214. ){
  124215. assert( pLoop->nSkip==0 );
  124216. bSeekPastNull = 1;
  124217. nExtraReg = 1;
  124218. }
  124219. /* Find any inequality constraint terms for the start and end
  124220. ** of the range.
  124221. */
  124222. j = nEq;
  124223. if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
  124224. pRangeStart = pLoop->aLTerm[j++];
  124225. nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
  124226. /* Like optimization range constraints always occur in pairs */
  124227. assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
  124228. (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
  124229. }
  124230. if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
  124231. pRangeEnd = pLoop->aLTerm[j++];
  124232. nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
  124233. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  124234. if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
  124235. assert( pRangeStart!=0 ); /* LIKE opt constraints */
  124236. assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
  124237. pLevel->iLikeRepCntr = (u32)++pParse->nMem;
  124238. sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
  124239. VdbeComment((v, "LIKE loop counter"));
  124240. pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
  124241. /* iLikeRepCntr actually stores 2x the counter register number. The
  124242. ** bottom bit indicates whether the search order is ASC or DESC. */
  124243. testcase( bRev );
  124244. testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
  124245. assert( (bRev & ~1)==0 );
  124246. pLevel->iLikeRepCntr <<=1;
  124247. pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
  124248. }
  124249. #endif
  124250. if( pRangeStart==0 ){
  124251. j = pIdx->aiColumn[nEq];
  124252. if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
  124253. bSeekPastNull = 1;
  124254. }
  124255. }
  124256. }
  124257. assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
  124258. /* If we are doing a reverse order scan on an ascending index, or
  124259. ** a forward order scan on a descending index, interchange the
  124260. ** start and end terms (pRangeStart and pRangeEnd).
  124261. */
  124262. if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
  124263. || (bRev && pIdx->nKeyCol==nEq)
  124264. ){
  124265. SWAP(WhereTerm *, pRangeEnd, pRangeStart);
  124266. SWAP(u8, bSeekPastNull, bStopAtNull);
  124267. SWAP(u8, nBtm, nTop);
  124268. }
  124269. /* Generate code to evaluate all constraint terms using == or IN
  124270. ** and store the values of those terms in an array of registers
  124271. ** starting at regBase.
  124272. */
  124273. codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
  124274. regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
  124275. assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
  124276. if( zStartAff && nTop ){
  124277. zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
  124278. }
  124279. addrNxt = pLevel->addrNxt;
  124280. testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
  124281. testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
  124282. testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
  124283. testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
  124284. startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
  124285. endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
  124286. start_constraints = pRangeStart || nEq>0;
  124287. /* Seek the index cursor to the start of the range. */
  124288. nConstraint = nEq;
  124289. if( pRangeStart ){
  124290. Expr *pRight = pRangeStart->pExpr->pRight;
  124291. codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
  124292. whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
  124293. if( (pRangeStart->wtFlags & TERM_VNULL)==0
  124294. && sqlite3ExprCanBeNull(pRight)
  124295. ){
  124296. sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
  124297. VdbeCoverage(v);
  124298. }
  124299. if( zStartAff ){
  124300. updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
  124301. }
  124302. nConstraint += nBtm;
  124303. testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
  124304. if( sqlite3ExprIsVector(pRight)==0 ){
  124305. disableTerm(pLevel, pRangeStart);
  124306. }else{
  124307. startEq = 1;
  124308. }
  124309. bSeekPastNull = 0;
  124310. }else if( bSeekPastNull ){
  124311. sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
  124312. nConstraint++;
  124313. startEq = 0;
  124314. start_constraints = 1;
  124315. }
  124316. codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
  124317. if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
  124318. /* The skip-scan logic inside the call to codeAllEqualityConstraints()
  124319. ** above has already left the cursor sitting on the correct row,
  124320. ** so no further seeking is needed */
  124321. }else{
  124322. op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
  124323. assert( op!=0 );
  124324. sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
  124325. VdbeCoverage(v);
  124326. VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
  124327. VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
  124328. VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
  124329. VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
  124330. VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
  124331. VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
  124332. }
  124333. /* Load the value for the inequality constraint at the end of the
  124334. ** range (if any).
  124335. */
  124336. nConstraint = nEq;
  124337. if( pRangeEnd ){
  124338. Expr *pRight = pRangeEnd->pExpr->pRight;
  124339. sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
  124340. codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
  124341. whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
  124342. if( (pRangeEnd->wtFlags & TERM_VNULL)==0
  124343. && sqlite3ExprCanBeNull(pRight)
  124344. ){
  124345. sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
  124346. VdbeCoverage(v);
  124347. }
  124348. if( zEndAff ){
  124349. updateRangeAffinityStr(pRight, nTop, zEndAff);
  124350. codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
  124351. }else{
  124352. assert( pParse->db->mallocFailed );
  124353. }
  124354. nConstraint += nTop;
  124355. testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
  124356. if( sqlite3ExprIsVector(pRight)==0 ){
  124357. disableTerm(pLevel, pRangeEnd);
  124358. }else{
  124359. endEq = 1;
  124360. }
  124361. }else if( bStopAtNull ){
  124362. sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
  124363. sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
  124364. endEq = 0;
  124365. nConstraint++;
  124366. }
  124367. sqlite3DbFree(db, zStartAff);
  124368. sqlite3DbFree(db, zEndAff);
  124369. /* Top of the loop body */
  124370. pLevel->p2 = sqlite3VdbeCurrentAddr(v);
  124371. /* Check if the index cursor is past the end of the range. */
  124372. if( nConstraint ){
  124373. op = aEndOp[bRev*2 + endEq];
  124374. sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
  124375. testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
  124376. testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
  124377. testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
  124378. testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
  124379. }
  124380. /* Seek the table cursor, if required */
  124381. if( omitTable ){
  124382. /* pIdx is a covering index. No need to access the main table. */
  124383. }else if( HasRowid(pIdx->pTable) ){
  124384. if( (pWInfo->wctrlFlags & WHERE_SEEK_TABLE) || (
  124385. (pWInfo->wctrlFlags & WHERE_SEEK_UNIQ_TABLE)
  124386. && (pWInfo->eOnePass==ONEPASS_SINGLE)
  124387. )){
  124388. iRowidReg = ++pParse->nMem;
  124389. sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
  124390. sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
  124391. sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, iRowidReg);
  124392. VdbeCoverage(v);
  124393. }else{
  124394. codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
  124395. }
  124396. }else if( iCur!=iIdxCur ){
  124397. Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
  124398. iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
  124399. for(j=0; j<pPk->nKeyCol; j++){
  124400. k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
  124401. sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
  124402. }
  124403. sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
  124404. iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
  124405. }
  124406. /* If pIdx is an index on one or more expressions, then look through
  124407. ** all the expressions in pWInfo and try to transform matching expressions
  124408. ** into reference to index columns.
  124409. */
  124410. whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
  124411. /* Record the instruction used to terminate the loop. */
  124412. if( pLoop->wsFlags & WHERE_ONEROW ){
  124413. pLevel->op = OP_Noop;
  124414. }else if( bRev ){
  124415. pLevel->op = OP_Prev;
  124416. }else{
  124417. pLevel->op = OP_Next;
  124418. }
  124419. pLevel->p1 = iIdxCur;
  124420. pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
  124421. if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
  124422. pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
  124423. }else{
  124424. assert( pLevel->p5==0 );
  124425. }
  124426. if( omitTable ) pIdx = 0;
  124427. }else
  124428. #ifndef SQLITE_OMIT_OR_OPTIMIZATION
  124429. if( pLoop->wsFlags & WHERE_MULTI_OR ){
  124430. /* Case 5: Two or more separately indexed terms connected by OR
  124431. **
  124432. ** Example:
  124433. **
  124434. ** CREATE TABLE t1(a,b,c,d);
  124435. ** CREATE INDEX i1 ON t1(a);
  124436. ** CREATE INDEX i2 ON t1(b);
  124437. ** CREATE INDEX i3 ON t1(c);
  124438. **
  124439. ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
  124440. **
  124441. ** In the example, there are three indexed terms connected by OR.
  124442. ** The top of the loop looks like this:
  124443. **
  124444. ** Null 1 # Zero the rowset in reg 1
  124445. **
  124446. ** Then, for each indexed term, the following. The arguments to
  124447. ** RowSetTest are such that the rowid of the current row is inserted
  124448. ** into the RowSet. If it is already present, control skips the
  124449. ** Gosub opcode and jumps straight to the code generated by WhereEnd().
  124450. **
  124451. ** sqlite3WhereBegin(<term>)
  124452. ** RowSetTest # Insert rowid into rowset
  124453. ** Gosub 2 A
  124454. ** sqlite3WhereEnd()
  124455. **
  124456. ** Following the above, code to terminate the loop. Label A, the target
  124457. ** of the Gosub above, jumps to the instruction right after the Goto.
  124458. **
  124459. ** Null 1 # Zero the rowset in reg 1
  124460. ** Goto B # The loop is finished.
  124461. **
  124462. ** A: <loop body> # Return data, whatever.
  124463. **
  124464. ** Return 2 # Jump back to the Gosub
  124465. **
  124466. ** B: <after the loop>
  124467. **
  124468. ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
  124469. ** use an ephemeral index instead of a RowSet to record the primary
  124470. ** keys of the rows we have already seen.
  124471. **
  124472. */
  124473. WhereClause *pOrWc; /* The OR-clause broken out into subterms */
  124474. SrcList *pOrTab; /* Shortened table list or OR-clause generation */
  124475. Index *pCov = 0; /* Potential covering index (or NULL) */
  124476. int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
  124477. int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
  124478. int regRowset = 0; /* Register for RowSet object */
  124479. int regRowid = 0; /* Register holding rowid */
  124480. int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
  124481. int iRetInit; /* Address of regReturn init */
  124482. int untestedTerms = 0; /* Some terms not completely tested */
  124483. int ii; /* Loop counter */
  124484. u16 wctrlFlags; /* Flags for sub-WHERE clause */
  124485. Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
  124486. Table *pTab = pTabItem->pTab;
  124487. pTerm = pLoop->aLTerm[0];
  124488. assert( pTerm!=0 );
  124489. assert( pTerm->eOperator & WO_OR );
  124490. assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
  124491. pOrWc = &pTerm->u.pOrInfo->wc;
  124492. pLevel->op = OP_Return;
  124493. pLevel->p1 = regReturn;
  124494. /* Set up a new SrcList in pOrTab containing the table being scanned
  124495. ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
  124496. ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
  124497. */
  124498. if( pWInfo->nLevel>1 ){
  124499. int nNotReady; /* The number of notReady tables */
  124500. struct SrcList_item *origSrc; /* Original list of tables */
  124501. nNotReady = pWInfo->nLevel - iLevel - 1;
  124502. pOrTab = sqlite3StackAllocRaw(db,
  124503. sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
  124504. if( pOrTab==0 ) return notReady;
  124505. pOrTab->nAlloc = (u8)(nNotReady + 1);
  124506. pOrTab->nSrc = pOrTab->nAlloc;
  124507. memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
  124508. origSrc = pWInfo->pTabList->a;
  124509. for(k=1; k<=nNotReady; k++){
  124510. memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
  124511. }
  124512. }else{
  124513. pOrTab = pWInfo->pTabList;
  124514. }
  124515. /* Initialize the rowset register to contain NULL. An SQL NULL is
  124516. ** equivalent to an empty rowset. Or, create an ephemeral index
  124517. ** capable of holding primary keys in the case of a WITHOUT ROWID.
  124518. **
  124519. ** Also initialize regReturn to contain the address of the instruction
  124520. ** immediately following the OP_Return at the bottom of the loop. This
  124521. ** is required in a few obscure LEFT JOIN cases where control jumps
  124522. ** over the top of the loop into the body of it. In this case the
  124523. ** correct response for the end-of-loop code (the OP_Return) is to
  124524. ** fall through to the next instruction, just as an OP_Next does if
  124525. ** called on an uninitialized cursor.
  124526. */
  124527. if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
  124528. if( HasRowid(pTab) ){
  124529. regRowset = ++pParse->nMem;
  124530. sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
  124531. }else{
  124532. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  124533. regRowset = pParse->nTab++;
  124534. sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
  124535. sqlite3VdbeSetP4KeyInfo(pParse, pPk);
  124536. }
  124537. regRowid = ++pParse->nMem;
  124538. }
  124539. iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
  124540. /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
  124541. ** Then for every term xN, evaluate as the subexpression: xN AND z
  124542. ** That way, terms in y that are factored into the disjunction will
  124543. ** be picked up by the recursive calls to sqlite3WhereBegin() below.
  124544. **
  124545. ** Actually, each subexpression is converted to "xN AND w" where w is
  124546. ** the "interesting" terms of z - terms that did not originate in the
  124547. ** ON or USING clause of a LEFT JOIN, and terms that are usable as
  124548. ** indices.
  124549. **
  124550. ** This optimization also only applies if the (x1 OR x2 OR ...) term
  124551. ** is not contained in the ON clause of a LEFT JOIN.
  124552. ** See ticket http://www.sqlite.org/src/info/f2369304e4
  124553. */
  124554. if( pWC->nTerm>1 ){
  124555. int iTerm;
  124556. for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
  124557. Expr *pExpr = pWC->a[iTerm].pExpr;
  124558. if( &pWC->a[iTerm] == pTerm ) continue;
  124559. if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
  124560. testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
  124561. testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
  124562. if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
  124563. if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
  124564. testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
  124565. pExpr = sqlite3ExprDup(db, pExpr, 0);
  124566. pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
  124567. }
  124568. if( pAndExpr ){
  124569. pAndExpr = sqlite3PExpr(pParse, TK_AND|TKFLG_DONTFOLD, 0, pAndExpr);
  124570. }
  124571. }
  124572. /* Run a separate WHERE clause for each term of the OR clause. After
  124573. ** eliminating duplicates from other WHERE clauses, the action for each
  124574. ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
  124575. */
  124576. wctrlFlags = WHERE_OR_SUBCLAUSE | (pWInfo->wctrlFlags & WHERE_SEEK_TABLE);
  124577. for(ii=0; ii<pOrWc->nTerm; ii++){
  124578. WhereTerm *pOrTerm = &pOrWc->a[ii];
  124579. if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
  124580. WhereInfo *pSubWInfo; /* Info for single OR-term scan */
  124581. Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
  124582. int jmp1 = 0; /* Address of jump operation */
  124583. if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
  124584. pAndExpr->pLeft = pOrExpr;
  124585. pOrExpr = pAndExpr;
  124586. }
  124587. /* Loop through table entries that match term pOrTerm. */
  124588. WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
  124589. pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
  124590. wctrlFlags, iCovCur);
  124591. assert( pSubWInfo || pParse->nErr || db->mallocFailed );
  124592. if( pSubWInfo ){
  124593. WhereLoop *pSubLoop;
  124594. int addrExplain = sqlite3WhereExplainOneScan(
  124595. pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
  124596. );
  124597. sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
  124598. /* This is the sub-WHERE clause body. First skip over
  124599. ** duplicate rows from prior sub-WHERE clauses, and record the
  124600. ** rowid (or PRIMARY KEY) for the current row so that the same
  124601. ** row will be skipped in subsequent sub-WHERE clauses.
  124602. */
  124603. if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
  124604. int r;
  124605. int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
  124606. if( HasRowid(pTab) ){
  124607. r = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iCur, regRowid, 0);
  124608. jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
  124609. r,iSet);
  124610. VdbeCoverage(v);
  124611. }else{
  124612. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  124613. int nPk = pPk->nKeyCol;
  124614. int iPk;
  124615. /* Read the PK into an array of temp registers. */
  124616. r = sqlite3GetTempRange(pParse, nPk);
  124617. for(iPk=0; iPk<nPk; iPk++){
  124618. int iCol = pPk->aiColumn[iPk];
  124619. sqlite3ExprCodeGetColumnToReg(pParse, pTab, iCol, iCur, r+iPk);
  124620. }
  124621. /* Check if the temp table already contains this key. If so,
  124622. ** the row has already been included in the result set and
  124623. ** can be ignored (by jumping past the Gosub below). Otherwise,
  124624. ** insert the key into the temp table and proceed with processing
  124625. ** the row.
  124626. **
  124627. ** Use some of the same optimizations as OP_RowSetTest: If iSet
  124628. ** is zero, assume that the key cannot already be present in
  124629. ** the temp table. And if iSet is -1, assume that there is no
  124630. ** need to insert the key into the temp table, as it will never
  124631. ** be tested for. */
  124632. if( iSet ){
  124633. jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
  124634. VdbeCoverage(v);
  124635. }
  124636. if( iSet>=0 ){
  124637. sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
  124638. sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
  124639. r, nPk);
  124640. if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  124641. }
  124642. /* Release the array of temp registers */
  124643. sqlite3ReleaseTempRange(pParse, r, nPk);
  124644. }
  124645. }
  124646. /* Invoke the main loop body as a subroutine */
  124647. sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
  124648. /* Jump here (skipping the main loop body subroutine) if the
  124649. ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
  124650. if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
  124651. /* The pSubWInfo->untestedTerms flag means that this OR term
  124652. ** contained one or more AND term from a notReady table. The
  124653. ** terms from the notReady table could not be tested and will
  124654. ** need to be tested later.
  124655. */
  124656. if( pSubWInfo->untestedTerms ) untestedTerms = 1;
  124657. /* If all of the OR-connected terms are optimized using the same
  124658. ** index, and the index is opened using the same cursor number
  124659. ** by each call to sqlite3WhereBegin() made by this loop, it may
  124660. ** be possible to use that index as a covering index.
  124661. **
  124662. ** If the call to sqlite3WhereBegin() above resulted in a scan that
  124663. ** uses an index, and this is either the first OR-connected term
  124664. ** processed or the index is the same as that used by all previous
  124665. ** terms, set pCov to the candidate covering index. Otherwise, set
  124666. ** pCov to NULL to indicate that no candidate covering index will
  124667. ** be available.
  124668. */
  124669. pSubLoop = pSubWInfo->a[0].pWLoop;
  124670. assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
  124671. if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
  124672. && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
  124673. && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
  124674. ){
  124675. assert( pSubWInfo->a[0].iIdxCur==iCovCur );
  124676. pCov = pSubLoop->u.btree.pIndex;
  124677. }else{
  124678. pCov = 0;
  124679. }
  124680. /* Finish the loop through table entries that match term pOrTerm. */
  124681. sqlite3WhereEnd(pSubWInfo);
  124682. }
  124683. }
  124684. }
  124685. pLevel->u.pCovidx = pCov;
  124686. if( pCov ) pLevel->iIdxCur = iCovCur;
  124687. if( pAndExpr ){
  124688. pAndExpr->pLeft = 0;
  124689. sqlite3ExprDelete(db, pAndExpr);
  124690. }
  124691. sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
  124692. sqlite3VdbeGoto(v, pLevel->addrBrk);
  124693. sqlite3VdbeResolveLabel(v, iLoopBody);
  124694. if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
  124695. if( !untestedTerms ) disableTerm(pLevel, pTerm);
  124696. }else
  124697. #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
  124698. {
  124699. /* Case 6: There is no usable index. We must do a complete
  124700. ** scan of the entire table.
  124701. */
  124702. static const u8 aStep[] = { OP_Next, OP_Prev };
  124703. static const u8 aStart[] = { OP_Rewind, OP_Last };
  124704. assert( bRev==0 || bRev==1 );
  124705. if( pTabItem->fg.isRecursive ){
  124706. /* Tables marked isRecursive have only a single row that is stored in
  124707. ** a pseudo-cursor. No need to Rewind or Next such cursors. */
  124708. pLevel->op = OP_Noop;
  124709. }else{
  124710. codeCursorHint(pTabItem, pWInfo, pLevel, 0);
  124711. pLevel->op = aStep[bRev];
  124712. pLevel->p1 = iCur;
  124713. pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
  124714. VdbeCoverageIf(v, bRev==0);
  124715. VdbeCoverageIf(v, bRev!=0);
  124716. pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
  124717. }
  124718. }
  124719. #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
  124720. pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
  124721. #endif
  124722. /* Insert code to test every subexpression that can be completely
  124723. ** computed using the current set of tables.
  124724. **
  124725. ** This loop may run between one and three times, depending on the
  124726. ** constraints to be generated. The value of stack variable iLoop
  124727. ** determines the constraints coded by each iteration, as follows:
  124728. **
  124729. ** iLoop==1: Code only expressions that are entirely covered by pIdx.
  124730. ** iLoop==2: Code remaining expressions that do not contain correlated
  124731. ** sub-queries.
  124732. ** iLoop==3: Code all remaining expressions.
  124733. **
  124734. ** An effort is made to skip unnecessary iterations of the loop.
  124735. */
  124736. iLoop = (pIdx ? 1 : 2);
  124737. do{
  124738. int iNext = 0; /* Next value for iLoop */
  124739. for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
  124740. Expr *pE;
  124741. int skipLikeAddr = 0;
  124742. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  124743. testcase( pTerm->wtFlags & TERM_CODED );
  124744. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  124745. if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
  124746. testcase( pWInfo->untestedTerms==0
  124747. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
  124748. pWInfo->untestedTerms = 1;
  124749. continue;
  124750. }
  124751. pE = pTerm->pExpr;
  124752. assert( pE!=0 );
  124753. if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
  124754. continue;
  124755. }
  124756. if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
  124757. iNext = 2;
  124758. continue;
  124759. }
  124760. if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
  124761. if( iNext==0 ) iNext = 3;
  124762. continue;
  124763. }
  124764. if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
  124765. /* If the TERM_LIKECOND flag is set, that means that the range search
  124766. ** is sufficient to guarantee that the LIKE operator is true, so we
  124767. ** can skip the call to the like(A,B) function. But this only works
  124768. ** for strings. So do not skip the call to the function on the pass
  124769. ** that compares BLOBs. */
  124770. #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  124771. continue;
  124772. #else
  124773. u32 x = pLevel->iLikeRepCntr;
  124774. if( x>0 ){
  124775. skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
  124776. }
  124777. VdbeCoverage(v);
  124778. #endif
  124779. }
  124780. #ifdef WHERETRACE_ENABLED /* 0xffff */
  124781. if( sqlite3WhereTrace ){
  124782. VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
  124783. pWC->nTerm-j, pTerm, iLoop));
  124784. }
  124785. #endif
  124786. sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
  124787. if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
  124788. pTerm->wtFlags |= TERM_CODED;
  124789. }
  124790. iLoop = iNext;
  124791. }while( iLoop>0 );
  124792. /* Insert code to test for implied constraints based on transitivity
  124793. ** of the "==" operator.
  124794. **
  124795. ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
  124796. ** and we are coding the t1 loop and the t2 loop has not yet coded,
  124797. ** then we cannot use the "t1.a=t2.b" constraint, but we can code
  124798. ** the implied "t1.a=123" constraint.
  124799. */
  124800. for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
  124801. Expr *pE, sEAlt;
  124802. WhereTerm *pAlt;
  124803. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  124804. if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
  124805. if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
  124806. if( pTerm->leftCursor!=iCur ) continue;
  124807. if( pLevel->iLeftJoin ) continue;
  124808. pE = pTerm->pExpr;
  124809. assert( !ExprHasProperty(pE, EP_FromJoin) );
  124810. assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
  124811. pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
  124812. WO_EQ|WO_IN|WO_IS, 0);
  124813. if( pAlt==0 ) continue;
  124814. if( pAlt->wtFlags & (TERM_CODED) ) continue;
  124815. if( (pAlt->eOperator & WO_IN)
  124816. && (pAlt->pExpr->flags & EP_xIsSelect)
  124817. && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
  124818. ){
  124819. continue;
  124820. }
  124821. testcase( pAlt->eOperator & WO_EQ );
  124822. testcase( pAlt->eOperator & WO_IS );
  124823. testcase( pAlt->eOperator & WO_IN );
  124824. VdbeModuleComment((v, "begin transitive constraint"));
  124825. sEAlt = *pAlt->pExpr;
  124826. sEAlt.pLeft = pE->pLeft;
  124827. sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
  124828. }
  124829. /* For a LEFT OUTER JOIN, generate code that will record the fact that
  124830. ** at least one row of the right table has matched the left table.
  124831. */
  124832. if( pLevel->iLeftJoin ){
  124833. pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
  124834. sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
  124835. VdbeComment((v, "record LEFT JOIN hit"));
  124836. sqlite3ExprCacheClear(pParse);
  124837. for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
  124838. testcase( pTerm->wtFlags & TERM_VIRTUAL );
  124839. testcase( pTerm->wtFlags & TERM_CODED );
  124840. if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
  124841. if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
  124842. assert( pWInfo->untestedTerms );
  124843. continue;
  124844. }
  124845. assert( pTerm->pExpr );
  124846. sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
  124847. pTerm->wtFlags |= TERM_CODED;
  124848. }
  124849. }
  124850. return pLevel->notReady;
  124851. }
  124852. /************** End of wherecode.c *******************************************/
  124853. /************** Begin file whereexpr.c ***************************************/
  124854. /*
  124855. ** 2015-06-08
  124856. **
  124857. ** The author disclaims copyright to this source code. In place of
  124858. ** a legal notice, here is a blessing:
  124859. **
  124860. ** May you do good and not evil.
  124861. ** May you find forgiveness for yourself and forgive others.
  124862. ** May you share freely, never taking more than you give.
  124863. **
  124864. *************************************************************************
  124865. ** This module contains C code that generates VDBE code used to process
  124866. ** the WHERE clause of SQL statements.
  124867. **
  124868. ** This file was originally part of where.c but was split out to improve
  124869. ** readability and editabiliity. This file contains utility routines for
  124870. ** analyzing Expr objects in the WHERE clause.
  124871. */
  124872. /* #include "sqliteInt.h" */
  124873. /* #include "whereInt.h" */
  124874. /* Forward declarations */
  124875. static void exprAnalyze(SrcList*, WhereClause*, int);
  124876. /*
  124877. ** Deallocate all memory associated with a WhereOrInfo object.
  124878. */
  124879. static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
  124880. sqlite3WhereClauseClear(&p->wc);
  124881. sqlite3DbFree(db, p);
  124882. }
  124883. /*
  124884. ** Deallocate all memory associated with a WhereAndInfo object.
  124885. */
  124886. static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
  124887. sqlite3WhereClauseClear(&p->wc);
  124888. sqlite3DbFree(db, p);
  124889. }
  124890. /*
  124891. ** Add a single new WhereTerm entry to the WhereClause object pWC.
  124892. ** The new WhereTerm object is constructed from Expr p and with wtFlags.
  124893. ** The index in pWC->a[] of the new WhereTerm is returned on success.
  124894. ** 0 is returned if the new WhereTerm could not be added due to a memory
  124895. ** allocation error. The memory allocation failure will be recorded in
  124896. ** the db->mallocFailed flag so that higher-level functions can detect it.
  124897. **
  124898. ** This routine will increase the size of the pWC->a[] array as necessary.
  124899. **
  124900. ** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
  124901. ** for freeing the expression p is assumed by the WhereClause object pWC.
  124902. ** This is true even if this routine fails to allocate a new WhereTerm.
  124903. **
  124904. ** WARNING: This routine might reallocate the space used to store
  124905. ** WhereTerms. All pointers to WhereTerms should be invalidated after
  124906. ** calling this routine. Such pointers may be reinitialized by referencing
  124907. ** the pWC->a[] array.
  124908. */
  124909. static int whereClauseInsert(WhereClause *pWC, Expr *p, u16 wtFlags){
  124910. WhereTerm *pTerm;
  124911. int idx;
  124912. testcase( wtFlags & TERM_VIRTUAL );
  124913. if( pWC->nTerm>=pWC->nSlot ){
  124914. WhereTerm *pOld = pWC->a;
  124915. sqlite3 *db = pWC->pWInfo->pParse->db;
  124916. pWC->a = sqlite3DbMallocRawNN(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
  124917. if( pWC->a==0 ){
  124918. if( wtFlags & TERM_DYNAMIC ){
  124919. sqlite3ExprDelete(db, p);
  124920. }
  124921. pWC->a = pOld;
  124922. return 0;
  124923. }
  124924. memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
  124925. if( pOld!=pWC->aStatic ){
  124926. sqlite3DbFree(db, pOld);
  124927. }
  124928. pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
  124929. }
  124930. pTerm = &pWC->a[idx = pWC->nTerm++];
  124931. if( p && ExprHasProperty(p, EP_Unlikely) ){
  124932. pTerm->truthProb = sqlite3LogEst(p->iTable) - 270;
  124933. }else{
  124934. pTerm->truthProb = 1;
  124935. }
  124936. pTerm->pExpr = sqlite3ExprSkipCollate(p);
  124937. pTerm->wtFlags = wtFlags;
  124938. pTerm->pWC = pWC;
  124939. pTerm->iParent = -1;
  124940. memset(&pTerm->eOperator, 0,
  124941. sizeof(WhereTerm) - offsetof(WhereTerm,eOperator));
  124942. return idx;
  124943. }
  124944. /*
  124945. ** Return TRUE if the given operator is one of the operators that is
  124946. ** allowed for an indexable WHERE clause term. The allowed operators are
  124947. ** "=", "<", ">", "<=", ">=", "IN", "IS", and "IS NULL"
  124948. */
  124949. static int allowedOp(int op){
  124950. assert( TK_GT>TK_EQ && TK_GT<TK_GE );
  124951. assert( TK_LT>TK_EQ && TK_LT<TK_GE );
  124952. assert( TK_LE>TK_EQ && TK_LE<TK_GE );
  124953. assert( TK_GE==TK_EQ+4 );
  124954. return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL || op==TK_IS;
  124955. }
  124956. /*
  124957. ** Commute a comparison operator. Expressions of the form "X op Y"
  124958. ** are converted into "Y op X".
  124959. **
  124960. ** If left/right precedence rules come into play when determining the
  124961. ** collating sequence, then COLLATE operators are adjusted to ensure
  124962. ** that the collating sequence does not change. For example:
  124963. ** "Y collate NOCASE op X" becomes "X op Y" because any collation sequence on
  124964. ** the left hand side of a comparison overrides any collation sequence
  124965. ** attached to the right. For the same reason the EP_Collate flag
  124966. ** is not commuted.
  124967. */
  124968. static void exprCommute(Parse *pParse, Expr *pExpr){
  124969. u16 expRight = (pExpr->pRight->flags & EP_Collate);
  124970. u16 expLeft = (pExpr->pLeft->flags & EP_Collate);
  124971. assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
  124972. if( expRight==expLeft ){
  124973. /* Either X and Y both have COLLATE operator or neither do */
  124974. if( expRight ){
  124975. /* Both X and Y have COLLATE operators. Make sure X is always
  124976. ** used by clearing the EP_Collate flag from Y. */
  124977. pExpr->pRight->flags &= ~EP_Collate;
  124978. }else if( sqlite3ExprCollSeq(pParse, pExpr->pLeft)!=0 ){
  124979. /* Neither X nor Y have COLLATE operators, but X has a non-default
  124980. ** collating sequence. So add the EP_Collate marker on X to cause
  124981. ** it to be searched first. */
  124982. pExpr->pLeft->flags |= EP_Collate;
  124983. }
  124984. }
  124985. SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
  124986. if( pExpr->op>=TK_GT ){
  124987. assert( TK_LT==TK_GT+2 );
  124988. assert( TK_GE==TK_LE+2 );
  124989. assert( TK_GT>TK_EQ );
  124990. assert( TK_GT<TK_LE );
  124991. assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
  124992. pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
  124993. }
  124994. }
  124995. /*
  124996. ** Translate from TK_xx operator to WO_xx bitmask.
  124997. */
  124998. static u16 operatorMask(int op){
  124999. u16 c;
  125000. assert( allowedOp(op) );
  125001. if( op==TK_IN ){
  125002. c = WO_IN;
  125003. }else if( op==TK_ISNULL ){
  125004. c = WO_ISNULL;
  125005. }else if( op==TK_IS ){
  125006. c = WO_IS;
  125007. }else{
  125008. assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
  125009. c = (u16)(WO_EQ<<(op-TK_EQ));
  125010. }
  125011. assert( op!=TK_ISNULL || c==WO_ISNULL );
  125012. assert( op!=TK_IN || c==WO_IN );
  125013. assert( op!=TK_EQ || c==WO_EQ );
  125014. assert( op!=TK_LT || c==WO_LT );
  125015. assert( op!=TK_LE || c==WO_LE );
  125016. assert( op!=TK_GT || c==WO_GT );
  125017. assert( op!=TK_GE || c==WO_GE );
  125018. assert( op!=TK_IS || c==WO_IS );
  125019. return c;
  125020. }
  125021. #ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
  125022. /*
  125023. ** Check to see if the given expression is a LIKE or GLOB operator that
  125024. ** can be optimized using inequality constraints. Return TRUE if it is
  125025. ** so and false if not.
  125026. **
  125027. ** In order for the operator to be optimizible, the RHS must be a string
  125028. ** literal that does not begin with a wildcard. The LHS must be a column
  125029. ** that may only be NULL, a string, or a BLOB, never a number. (This means
  125030. ** that virtual tables cannot participate in the LIKE optimization.) The
  125031. ** collating sequence for the column on the LHS must be appropriate for
  125032. ** the operator.
  125033. */
  125034. static int isLikeOrGlob(
  125035. Parse *pParse, /* Parsing and code generating context */
  125036. Expr *pExpr, /* Test this expression */
  125037. Expr **ppPrefix, /* Pointer to TK_STRING expression with pattern prefix */
  125038. int *pisComplete, /* True if the only wildcard is % in the last character */
  125039. int *pnoCase /* True if uppercase is equivalent to lowercase */
  125040. ){
  125041. const u8 *z = 0; /* String on RHS of LIKE operator */
  125042. Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
  125043. ExprList *pList; /* List of operands to the LIKE operator */
  125044. int c; /* One character in z[] */
  125045. int cnt; /* Number of non-wildcard prefix characters */
  125046. char wc[4]; /* Wildcard characters */
  125047. sqlite3 *db = pParse->db; /* Database connection */
  125048. sqlite3_value *pVal = 0;
  125049. int op; /* Opcode of pRight */
  125050. int rc; /* Result code to return */
  125051. if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
  125052. return 0;
  125053. }
  125054. #ifdef SQLITE_EBCDIC
  125055. if( *pnoCase ) return 0;
  125056. #endif
  125057. pList = pExpr->x.pList;
  125058. pLeft = pList->a[1].pExpr;
  125059. pRight = sqlite3ExprSkipCollate(pList->a[0].pExpr);
  125060. op = pRight->op;
  125061. if( op==TK_VARIABLE && (db->flags & SQLITE_EnableQPSG)==0 ){
  125062. Vdbe *pReprepare = pParse->pReprepare;
  125063. int iCol = pRight->iColumn;
  125064. pVal = sqlite3VdbeGetBoundValue(pReprepare, iCol, SQLITE_AFF_BLOB);
  125065. if( pVal && sqlite3_value_type(pVal)==SQLITE_TEXT ){
  125066. z = sqlite3_value_text(pVal);
  125067. }
  125068. sqlite3VdbeSetVarmask(pParse->pVdbe, iCol);
  125069. assert( pRight->op==TK_VARIABLE || pRight->op==TK_REGISTER );
  125070. }else if( op==TK_STRING ){
  125071. z = (u8*)pRight->u.zToken;
  125072. }
  125073. if( z ){
  125074. /* If the RHS begins with a digit or a minus sign, then the LHS must
  125075. ** be an ordinary column (not a virtual table column) with TEXT affinity.
  125076. ** Otherwise the LHS might be numeric and "lhs >= rhs" would be false
  125077. ** even though "lhs LIKE rhs" is true. But if the RHS does not start
  125078. ** with a digit or '-', then "lhs LIKE rhs" will always be false if
  125079. ** the LHS is numeric and so the optimization still works.
  125080. */
  125081. if( sqlite3Isdigit(z[0]) || z[0]=='-' ){
  125082. if( pLeft->op!=TK_COLUMN
  125083. || sqlite3ExprAffinity(pLeft)!=SQLITE_AFF_TEXT
  125084. || IsVirtual(pLeft->pTab) /* Value might be numeric */
  125085. ){
  125086. sqlite3ValueFree(pVal);
  125087. return 0;
  125088. }
  125089. }
  125090. /* Count the number of prefix characters prior to the first wildcard */
  125091. cnt = 0;
  125092. while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){
  125093. cnt++;
  125094. if( c==wc[3] && z[cnt]!=0 ) cnt++;
  125095. }
  125096. /* The optimization is possible only if (1) the pattern does not begin
  125097. ** with a wildcard and if (2) the non-wildcard prefix does not end with
  125098. ** an (illegal 0xff) character. The second condition is necessary so
  125099. ** that we can increment the prefix key to find an upper bound for the
  125100. ** range search.
  125101. */
  125102. if( cnt!=0 && 255!=(u8)z[cnt-1] ){
  125103. Expr *pPrefix;
  125104. /* A "complete" match if the pattern ends with "*" or "%" */
  125105. *pisComplete = c==wc[0] && z[cnt+1]==0;
  125106. /* Get the pattern prefix. Remove all escapes from the prefix. */
  125107. pPrefix = sqlite3Expr(db, TK_STRING, (char*)z);
  125108. if( pPrefix ){
  125109. int iFrom, iTo;
  125110. char *zNew = pPrefix->u.zToken;
  125111. zNew[cnt] = 0;
  125112. for(iFrom=iTo=0; iFrom<cnt; iFrom++){
  125113. if( zNew[iFrom]==wc[3] ) iFrom++;
  125114. zNew[iTo++] = zNew[iFrom];
  125115. }
  125116. zNew[iTo] = 0;
  125117. }
  125118. *ppPrefix = pPrefix;
  125119. /* If the RHS pattern is a bound parameter, make arrangements to
  125120. ** reprepare the statement when that parameter is rebound */
  125121. if( op==TK_VARIABLE ){
  125122. Vdbe *v = pParse->pVdbe;
  125123. sqlite3VdbeSetVarmask(v, pRight->iColumn);
  125124. if( *pisComplete && pRight->u.zToken[1] ){
  125125. /* If the rhs of the LIKE expression is a variable, and the current
  125126. ** value of the variable means there is no need to invoke the LIKE
  125127. ** function, then no OP_Variable will be added to the program.
  125128. ** This causes problems for the sqlite3_bind_parameter_name()
  125129. ** API. To work around them, add a dummy OP_Variable here.
  125130. */
  125131. int r1 = sqlite3GetTempReg(pParse);
  125132. sqlite3ExprCodeTarget(pParse, pRight, r1);
  125133. sqlite3VdbeChangeP3(v, sqlite3VdbeCurrentAddr(v)-1, 0);
  125134. sqlite3ReleaseTempReg(pParse, r1);
  125135. }
  125136. }
  125137. }else{
  125138. z = 0;
  125139. }
  125140. }
  125141. rc = (z!=0);
  125142. sqlite3ValueFree(pVal);
  125143. return rc;
  125144. }
  125145. #endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
  125146. #ifndef SQLITE_OMIT_VIRTUALTABLE
  125147. /*
  125148. ** Check to see if the pExpr expression is a form that needs to be passed
  125149. ** to the xBestIndex method of virtual tables. Forms of interest include:
  125150. **
  125151. ** Expression Virtual Table Operator
  125152. ** ----------------------- ---------------------------------
  125153. ** 1. column MATCH expr SQLITE_INDEX_CONSTRAINT_MATCH
  125154. ** 2. column GLOB expr SQLITE_INDEX_CONSTRAINT_GLOB
  125155. ** 3. column LIKE expr SQLITE_INDEX_CONSTRAINT_LIKE
  125156. ** 4. column REGEXP expr SQLITE_INDEX_CONSTRAINT_REGEXP
  125157. ** 5. column != expr SQLITE_INDEX_CONSTRAINT_NE
  125158. ** 6. expr != column SQLITE_INDEX_CONSTRAINT_NE
  125159. ** 7. column IS NOT expr SQLITE_INDEX_CONSTRAINT_ISNOT
  125160. ** 8. expr IS NOT column SQLITE_INDEX_CONSTRAINT_ISNOT
  125161. ** 9. column IS NOT NULL SQLITE_INDEX_CONSTRAINT_ISNOTNULL
  125162. **
  125163. ** In every case, "column" must be a column of a virtual table. If there
  125164. ** is a match, set *ppLeft to the "column" expression, set *ppRight to the
  125165. ** "expr" expression (even though in forms (6) and (8) the column is on the
  125166. ** right and the expression is on the left). Also set *peOp2 to the
  125167. ** appropriate virtual table operator. The return value is 1 or 2 if there
  125168. ** is a match. The usual return is 1, but if the RHS is also a column
  125169. ** of virtual table in forms (5) or (7) then return 2.
  125170. **
  125171. ** If the expression matches none of the patterns above, return 0.
  125172. */
  125173. static int isAuxiliaryVtabOperator(
  125174. Expr *pExpr, /* Test this expression */
  125175. unsigned char *peOp2, /* OUT: 0 for MATCH, or else an op2 value */
  125176. Expr **ppLeft, /* Column expression to left of MATCH/op2 */
  125177. Expr **ppRight /* Expression to left of MATCH/op2 */
  125178. ){
  125179. if( pExpr->op==TK_FUNCTION ){
  125180. static const struct Op2 {
  125181. const char *zOp;
  125182. unsigned char eOp2;
  125183. } aOp[] = {
  125184. { "match", SQLITE_INDEX_CONSTRAINT_MATCH },
  125185. { "glob", SQLITE_INDEX_CONSTRAINT_GLOB },
  125186. { "like", SQLITE_INDEX_CONSTRAINT_LIKE },
  125187. { "regexp", SQLITE_INDEX_CONSTRAINT_REGEXP }
  125188. };
  125189. ExprList *pList;
  125190. Expr *pCol; /* Column reference */
  125191. int i;
  125192. pList = pExpr->x.pList;
  125193. if( pList==0 || pList->nExpr!=2 ){
  125194. return 0;
  125195. }
  125196. pCol = pList->a[1].pExpr;
  125197. if( pCol->op!=TK_COLUMN || !IsVirtual(pCol->pTab) ){
  125198. return 0;
  125199. }
  125200. for(i=0; i<ArraySize(aOp); i++){
  125201. if( sqlite3StrICmp(pExpr->u.zToken, aOp[i].zOp)==0 ){
  125202. *peOp2 = aOp[i].eOp2;
  125203. *ppRight = pList->a[0].pExpr;
  125204. *ppLeft = pCol;
  125205. return 1;
  125206. }
  125207. }
  125208. }else if( pExpr->op==TK_NE || pExpr->op==TK_ISNOT || pExpr->op==TK_NOTNULL ){
  125209. int res = 0;
  125210. Expr *pLeft = pExpr->pLeft;
  125211. Expr *pRight = pExpr->pRight;
  125212. if( pLeft->op==TK_COLUMN && IsVirtual(pLeft->pTab) ){
  125213. res++;
  125214. }
  125215. if( pRight && pRight->op==TK_COLUMN && IsVirtual(pRight->pTab) ){
  125216. res++;
  125217. SWAP(Expr*, pLeft, pRight);
  125218. }
  125219. *ppLeft = pLeft;
  125220. *ppRight = pRight;
  125221. if( pExpr->op==TK_NE ) *peOp2 = SQLITE_INDEX_CONSTRAINT_NE;
  125222. if( pExpr->op==TK_ISNOT ) *peOp2 = SQLITE_INDEX_CONSTRAINT_ISNOT;
  125223. if( pExpr->op==TK_NOTNULL ) *peOp2 = SQLITE_INDEX_CONSTRAINT_ISNOTNULL;
  125224. return res;
  125225. }
  125226. return 0;
  125227. }
  125228. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  125229. /*
  125230. ** If the pBase expression originated in the ON or USING clause of
  125231. ** a join, then transfer the appropriate markings over to derived.
  125232. */
  125233. static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
  125234. if( pDerived ){
  125235. pDerived->flags |= pBase->flags & EP_FromJoin;
  125236. pDerived->iRightJoinTable = pBase->iRightJoinTable;
  125237. }
  125238. }
  125239. /*
  125240. ** Mark term iChild as being a child of term iParent
  125241. */
  125242. static void markTermAsChild(WhereClause *pWC, int iChild, int iParent){
  125243. pWC->a[iChild].iParent = iParent;
  125244. pWC->a[iChild].truthProb = pWC->a[iParent].truthProb;
  125245. pWC->a[iParent].nChild++;
  125246. }
  125247. /*
  125248. ** Return the N-th AND-connected subterm of pTerm. Or if pTerm is not
  125249. ** a conjunction, then return just pTerm when N==0. If N is exceeds
  125250. ** the number of available subterms, return NULL.
  125251. */
  125252. static WhereTerm *whereNthSubterm(WhereTerm *pTerm, int N){
  125253. if( pTerm->eOperator!=WO_AND ){
  125254. return N==0 ? pTerm : 0;
  125255. }
  125256. if( N<pTerm->u.pAndInfo->wc.nTerm ){
  125257. return &pTerm->u.pAndInfo->wc.a[N];
  125258. }
  125259. return 0;
  125260. }
  125261. /*
  125262. ** Subterms pOne and pTwo are contained within WHERE clause pWC. The
  125263. ** two subterms are in disjunction - they are OR-ed together.
  125264. **
  125265. ** If these two terms are both of the form: "A op B" with the same
  125266. ** A and B values but different operators and if the operators are
  125267. ** compatible (if one is = and the other is <, for example) then
  125268. ** add a new virtual AND term to pWC that is the combination of the
  125269. ** two.
  125270. **
  125271. ** Some examples:
  125272. **
  125273. ** x<y OR x=y --> x<=y
  125274. ** x=y OR x=y --> x=y
  125275. ** x<=y OR x<y --> x<=y
  125276. **
  125277. ** The following is NOT generated:
  125278. **
  125279. ** x<y OR x>y --> x!=y
  125280. */
  125281. static void whereCombineDisjuncts(
  125282. SrcList *pSrc, /* the FROM clause */
  125283. WhereClause *pWC, /* The complete WHERE clause */
  125284. WhereTerm *pOne, /* First disjunct */
  125285. WhereTerm *pTwo /* Second disjunct */
  125286. ){
  125287. u16 eOp = pOne->eOperator | pTwo->eOperator;
  125288. sqlite3 *db; /* Database connection (for malloc) */
  125289. Expr *pNew; /* New virtual expression */
  125290. int op; /* Operator for the combined expression */
  125291. int idxNew; /* Index in pWC of the next virtual term */
  125292. if( (pOne->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE))==0 ) return;
  125293. if( (pTwo->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE))==0 ) return;
  125294. if( (eOp & (WO_EQ|WO_LT|WO_LE))!=eOp
  125295. && (eOp & (WO_EQ|WO_GT|WO_GE))!=eOp ) return;
  125296. assert( pOne->pExpr->pLeft!=0 && pOne->pExpr->pRight!=0 );
  125297. assert( pTwo->pExpr->pLeft!=0 && pTwo->pExpr->pRight!=0 );
  125298. if( sqlite3ExprCompare(0,pOne->pExpr->pLeft, pTwo->pExpr->pLeft, -1) ) return;
  125299. if( sqlite3ExprCompare(0,pOne->pExpr->pRight, pTwo->pExpr->pRight,-1) )return;
  125300. /* If we reach this point, it means the two subterms can be combined */
  125301. if( (eOp & (eOp-1))!=0 ){
  125302. if( eOp & (WO_LT|WO_LE) ){
  125303. eOp = WO_LE;
  125304. }else{
  125305. assert( eOp & (WO_GT|WO_GE) );
  125306. eOp = WO_GE;
  125307. }
  125308. }
  125309. db = pWC->pWInfo->pParse->db;
  125310. pNew = sqlite3ExprDup(db, pOne->pExpr, 0);
  125311. if( pNew==0 ) return;
  125312. for(op=TK_EQ; eOp!=(WO_EQ<<(op-TK_EQ)); op++){ assert( op<TK_GE ); }
  125313. pNew->op = op;
  125314. idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
  125315. exprAnalyze(pSrc, pWC, idxNew);
  125316. }
  125317. #if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
  125318. /*
  125319. ** Analyze a term that consists of two or more OR-connected
  125320. ** subterms. So in:
  125321. **
  125322. ** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
  125323. ** ^^^^^^^^^^^^^^^^^^^^
  125324. **
  125325. ** This routine analyzes terms such as the middle term in the above example.
  125326. ** A WhereOrTerm object is computed and attached to the term under
  125327. ** analysis, regardless of the outcome of the analysis. Hence:
  125328. **
  125329. ** WhereTerm.wtFlags |= TERM_ORINFO
  125330. ** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
  125331. **
  125332. ** The term being analyzed must have two or more of OR-connected subterms.
  125333. ** A single subterm might be a set of AND-connected sub-subterms.
  125334. ** Examples of terms under analysis:
  125335. **
  125336. ** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
  125337. ** (B) x=expr1 OR expr2=x OR x=expr3
  125338. ** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
  125339. ** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
  125340. ** (E) (p.a=1 AND q.b=2 AND r.c=3) OR (p.x=4 AND q.y=5 AND r.z=6)
  125341. ** (F) x>A OR (x=A AND y>=B)
  125342. **
  125343. ** CASE 1:
  125344. **
  125345. ** If all subterms are of the form T.C=expr for some single column of C and
  125346. ** a single table T (as shown in example B above) then create a new virtual
  125347. ** term that is an equivalent IN expression. In other words, if the term
  125348. ** being analyzed is:
  125349. **
  125350. ** x = expr1 OR expr2 = x OR x = expr3
  125351. **
  125352. ** then create a new virtual term like this:
  125353. **
  125354. ** x IN (expr1,expr2,expr3)
  125355. **
  125356. ** CASE 2:
  125357. **
  125358. ** If there are exactly two disjuncts and one side has x>A and the other side
  125359. ** has x=A (for the same x and A) then add a new virtual conjunct term to the
  125360. ** WHERE clause of the form "x>=A". Example:
  125361. **
  125362. ** x>A OR (x=A AND y>B) adds: x>=A
  125363. **
  125364. ** The added conjunct can sometimes be helpful in query planning.
  125365. **
  125366. ** CASE 3:
  125367. **
  125368. ** If all subterms are indexable by a single table T, then set
  125369. **
  125370. ** WhereTerm.eOperator = WO_OR
  125371. ** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
  125372. **
  125373. ** A subterm is "indexable" if it is of the form
  125374. ** "T.C <op> <expr>" where C is any column of table T and
  125375. ** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
  125376. ** A subterm is also indexable if it is an AND of two or more
  125377. ** subsubterms at least one of which is indexable. Indexable AND
  125378. ** subterms have their eOperator set to WO_AND and they have
  125379. ** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
  125380. **
  125381. ** From another point of view, "indexable" means that the subterm could
  125382. ** potentially be used with an index if an appropriate index exists.
  125383. ** This analysis does not consider whether or not the index exists; that
  125384. ** is decided elsewhere. This analysis only looks at whether subterms
  125385. ** appropriate for indexing exist.
  125386. **
  125387. ** All examples A through E above satisfy case 3. But if a term
  125388. ** also satisfies case 1 (such as B) we know that the optimizer will
  125389. ** always prefer case 1, so in that case we pretend that case 3 is not
  125390. ** satisfied.
  125391. **
  125392. ** It might be the case that multiple tables are indexable. For example,
  125393. ** (E) above is indexable on tables P, Q, and R.
  125394. **
  125395. ** Terms that satisfy case 3 are candidates for lookup by using
  125396. ** separate indices to find rowids for each subterm and composing
  125397. ** the union of all rowids using a RowSet object. This is similar
  125398. ** to "bitmap indices" in other database engines.
  125399. **
  125400. ** OTHERWISE:
  125401. **
  125402. ** If none of cases 1, 2, or 3 apply, then leave the eOperator set to
  125403. ** zero. This term is not useful for search.
  125404. */
  125405. static void exprAnalyzeOrTerm(
  125406. SrcList *pSrc, /* the FROM clause */
  125407. WhereClause *pWC, /* the complete WHERE clause */
  125408. int idxTerm /* Index of the OR-term to be analyzed */
  125409. ){
  125410. WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
  125411. Parse *pParse = pWInfo->pParse; /* Parser context */
  125412. sqlite3 *db = pParse->db; /* Database connection */
  125413. WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
  125414. Expr *pExpr = pTerm->pExpr; /* The expression of the term */
  125415. int i; /* Loop counters */
  125416. WhereClause *pOrWc; /* Breakup of pTerm into subterms */
  125417. WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
  125418. WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
  125419. Bitmask chngToIN; /* Tables that might satisfy case 1 */
  125420. Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
  125421. /*
  125422. ** Break the OR clause into its separate subterms. The subterms are
  125423. ** stored in a WhereClause structure containing within the WhereOrInfo
  125424. ** object that is attached to the original OR clause term.
  125425. */
  125426. assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
  125427. assert( pExpr->op==TK_OR );
  125428. pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
  125429. if( pOrInfo==0 ) return;
  125430. pTerm->wtFlags |= TERM_ORINFO;
  125431. pOrWc = &pOrInfo->wc;
  125432. memset(pOrWc->aStatic, 0, sizeof(pOrWc->aStatic));
  125433. sqlite3WhereClauseInit(pOrWc, pWInfo);
  125434. sqlite3WhereSplit(pOrWc, pExpr, TK_OR);
  125435. sqlite3WhereExprAnalyze(pSrc, pOrWc);
  125436. if( db->mallocFailed ) return;
  125437. assert( pOrWc->nTerm>=2 );
  125438. /*
  125439. ** Compute the set of tables that might satisfy cases 1 or 3.
  125440. */
  125441. indexable = ~(Bitmask)0;
  125442. chngToIN = ~(Bitmask)0;
  125443. for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
  125444. if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
  125445. WhereAndInfo *pAndInfo;
  125446. assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
  125447. chngToIN = 0;
  125448. pAndInfo = sqlite3DbMallocRawNN(db, sizeof(*pAndInfo));
  125449. if( pAndInfo ){
  125450. WhereClause *pAndWC;
  125451. WhereTerm *pAndTerm;
  125452. int j;
  125453. Bitmask b = 0;
  125454. pOrTerm->u.pAndInfo = pAndInfo;
  125455. pOrTerm->wtFlags |= TERM_ANDINFO;
  125456. pOrTerm->eOperator = WO_AND;
  125457. pAndWC = &pAndInfo->wc;
  125458. memset(pAndWC->aStatic, 0, sizeof(pAndWC->aStatic));
  125459. sqlite3WhereClauseInit(pAndWC, pWC->pWInfo);
  125460. sqlite3WhereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
  125461. sqlite3WhereExprAnalyze(pSrc, pAndWC);
  125462. pAndWC->pOuter = pWC;
  125463. if( !db->mallocFailed ){
  125464. for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
  125465. assert( pAndTerm->pExpr );
  125466. if( allowedOp(pAndTerm->pExpr->op)
  125467. || pAndTerm->eOperator==WO_AUX
  125468. ){
  125469. b |= sqlite3WhereGetMask(&pWInfo->sMaskSet, pAndTerm->leftCursor);
  125470. }
  125471. }
  125472. }
  125473. indexable &= b;
  125474. }
  125475. }else if( pOrTerm->wtFlags & TERM_COPIED ){
  125476. /* Skip this term for now. We revisit it when we process the
  125477. ** corresponding TERM_VIRTUAL term */
  125478. }else{
  125479. Bitmask b;
  125480. b = sqlite3WhereGetMask(&pWInfo->sMaskSet, pOrTerm->leftCursor);
  125481. if( pOrTerm->wtFlags & TERM_VIRTUAL ){
  125482. WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
  125483. b |= sqlite3WhereGetMask(&pWInfo->sMaskSet, pOther->leftCursor);
  125484. }
  125485. indexable &= b;
  125486. if( (pOrTerm->eOperator & WO_EQ)==0 ){
  125487. chngToIN = 0;
  125488. }else{
  125489. chngToIN &= b;
  125490. }
  125491. }
  125492. }
  125493. /*
  125494. ** Record the set of tables that satisfy case 3. The set might be
  125495. ** empty.
  125496. */
  125497. pOrInfo->indexable = indexable;
  125498. pTerm->eOperator = indexable==0 ? 0 : WO_OR;
  125499. /* For a two-way OR, attempt to implementation case 2.
  125500. */
  125501. if( indexable && pOrWc->nTerm==2 ){
  125502. int iOne = 0;
  125503. WhereTerm *pOne;
  125504. while( (pOne = whereNthSubterm(&pOrWc->a[0],iOne++))!=0 ){
  125505. int iTwo = 0;
  125506. WhereTerm *pTwo;
  125507. while( (pTwo = whereNthSubterm(&pOrWc->a[1],iTwo++))!=0 ){
  125508. whereCombineDisjuncts(pSrc, pWC, pOne, pTwo);
  125509. }
  125510. }
  125511. }
  125512. /*
  125513. ** chngToIN holds a set of tables that *might* satisfy case 1. But
  125514. ** we have to do some additional checking to see if case 1 really
  125515. ** is satisfied.
  125516. **
  125517. ** chngToIN will hold either 0, 1, or 2 bits. The 0-bit case means
  125518. ** that there is no possibility of transforming the OR clause into an
  125519. ** IN operator because one or more terms in the OR clause contain
  125520. ** something other than == on a column in the single table. The 1-bit
  125521. ** case means that every term of the OR clause is of the form
  125522. ** "table.column=expr" for some single table. The one bit that is set
  125523. ** will correspond to the common table. We still need to check to make
  125524. ** sure the same column is used on all terms. The 2-bit case is when
  125525. ** the all terms are of the form "table1.column=table2.column". It
  125526. ** might be possible to form an IN operator with either table1.column
  125527. ** or table2.column as the LHS if either is common to every term of
  125528. ** the OR clause.
  125529. **
  125530. ** Note that terms of the form "table.column1=table.column2" (the
  125531. ** same table on both sizes of the ==) cannot be optimized.
  125532. */
  125533. if( chngToIN ){
  125534. int okToChngToIN = 0; /* True if the conversion to IN is valid */
  125535. int iColumn = -1; /* Column index on lhs of IN operator */
  125536. int iCursor = -1; /* Table cursor common to all terms */
  125537. int j = 0; /* Loop counter */
  125538. /* Search for a table and column that appears on one side or the
  125539. ** other of the == operator in every subterm. That table and column
  125540. ** will be recorded in iCursor and iColumn. There might not be any
  125541. ** such table and column. Set okToChngToIN if an appropriate table
  125542. ** and column is found but leave okToChngToIN false if not found.
  125543. */
  125544. for(j=0; j<2 && !okToChngToIN; j++){
  125545. pOrTerm = pOrWc->a;
  125546. for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
  125547. assert( pOrTerm->eOperator & WO_EQ );
  125548. pOrTerm->wtFlags &= ~TERM_OR_OK;
  125549. if( pOrTerm->leftCursor==iCursor ){
  125550. /* This is the 2-bit case and we are on the second iteration and
  125551. ** current term is from the first iteration. So skip this term. */
  125552. assert( j==1 );
  125553. continue;
  125554. }
  125555. if( (chngToIN & sqlite3WhereGetMask(&pWInfo->sMaskSet,
  125556. pOrTerm->leftCursor))==0 ){
  125557. /* This term must be of the form t1.a==t2.b where t2 is in the
  125558. ** chngToIN set but t1 is not. This term will be either preceded
  125559. ** or follwed by an inverted copy (t2.b==t1.a). Skip this term
  125560. ** and use its inversion. */
  125561. testcase( pOrTerm->wtFlags & TERM_COPIED );
  125562. testcase( pOrTerm->wtFlags & TERM_VIRTUAL );
  125563. assert( pOrTerm->wtFlags & (TERM_COPIED|TERM_VIRTUAL) );
  125564. continue;
  125565. }
  125566. iColumn = pOrTerm->u.leftColumn;
  125567. iCursor = pOrTerm->leftCursor;
  125568. break;
  125569. }
  125570. if( i<0 ){
  125571. /* No candidate table+column was found. This can only occur
  125572. ** on the second iteration */
  125573. assert( j==1 );
  125574. assert( IsPowerOfTwo(chngToIN) );
  125575. assert( chngToIN==sqlite3WhereGetMask(&pWInfo->sMaskSet, iCursor) );
  125576. break;
  125577. }
  125578. testcase( j==1 );
  125579. /* We have found a candidate table and column. Check to see if that
  125580. ** table and column is common to every term in the OR clause */
  125581. okToChngToIN = 1;
  125582. for(; i>=0 && okToChngToIN; i--, pOrTerm++){
  125583. assert( pOrTerm->eOperator & WO_EQ );
  125584. if( pOrTerm->leftCursor!=iCursor ){
  125585. pOrTerm->wtFlags &= ~TERM_OR_OK;
  125586. }else if( pOrTerm->u.leftColumn!=iColumn ){
  125587. okToChngToIN = 0;
  125588. }else{
  125589. int affLeft, affRight;
  125590. /* If the right-hand side is also a column, then the affinities
  125591. ** of both right and left sides must be such that no type
  125592. ** conversions are required on the right. (Ticket #2249)
  125593. */
  125594. affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
  125595. affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
  125596. if( affRight!=0 && affRight!=affLeft ){
  125597. okToChngToIN = 0;
  125598. }else{
  125599. pOrTerm->wtFlags |= TERM_OR_OK;
  125600. }
  125601. }
  125602. }
  125603. }
  125604. /* At this point, okToChngToIN is true if original pTerm satisfies
  125605. ** case 1. In that case, construct a new virtual term that is
  125606. ** pTerm converted into an IN operator.
  125607. */
  125608. if( okToChngToIN ){
  125609. Expr *pDup; /* A transient duplicate expression */
  125610. ExprList *pList = 0; /* The RHS of the IN operator */
  125611. Expr *pLeft = 0; /* The LHS of the IN operator */
  125612. Expr *pNew; /* The complete IN operator */
  125613. for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
  125614. if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
  125615. assert( pOrTerm->eOperator & WO_EQ );
  125616. assert( pOrTerm->leftCursor==iCursor );
  125617. assert( pOrTerm->u.leftColumn==iColumn );
  125618. pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
  125619. pList = sqlite3ExprListAppend(pWInfo->pParse, pList, pDup);
  125620. pLeft = pOrTerm->pExpr->pLeft;
  125621. }
  125622. assert( pLeft!=0 );
  125623. pDup = sqlite3ExprDup(db, pLeft, 0);
  125624. pNew = sqlite3PExpr(pParse, TK_IN, pDup, 0);
  125625. if( pNew ){
  125626. int idxNew;
  125627. transferJoinMarkings(pNew, pExpr);
  125628. assert( !ExprHasProperty(pNew, EP_xIsSelect) );
  125629. pNew->x.pList = pList;
  125630. idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
  125631. testcase( idxNew==0 );
  125632. exprAnalyze(pSrc, pWC, idxNew);
  125633. pTerm = &pWC->a[idxTerm];
  125634. markTermAsChild(pWC, idxNew, idxTerm);
  125635. }else{
  125636. sqlite3ExprListDelete(db, pList);
  125637. }
  125638. pTerm->eOperator = WO_NOOP; /* case 1 trumps case 3 */
  125639. }
  125640. }
  125641. }
  125642. #endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
  125643. /*
  125644. ** We already know that pExpr is a binary operator where both operands are
  125645. ** column references. This routine checks to see if pExpr is an equivalence
  125646. ** relation:
  125647. ** 1. The SQLITE_Transitive optimization must be enabled
  125648. ** 2. Must be either an == or an IS operator
  125649. ** 3. Not originating in the ON clause of an OUTER JOIN
  125650. ** 4. The affinities of A and B must be compatible
  125651. ** 5a. Both operands use the same collating sequence OR
  125652. ** 5b. The overall collating sequence is BINARY
  125653. ** If this routine returns TRUE, that means that the RHS can be substituted
  125654. ** for the LHS anyplace else in the WHERE clause where the LHS column occurs.
  125655. ** This is an optimization. No harm comes from returning 0. But if 1 is
  125656. ** returned when it should not be, then incorrect answers might result.
  125657. */
  125658. static int termIsEquivalence(Parse *pParse, Expr *pExpr){
  125659. char aff1, aff2;
  125660. CollSeq *pColl;
  125661. if( !OptimizationEnabled(pParse->db, SQLITE_Transitive) ) return 0;
  125662. if( pExpr->op!=TK_EQ && pExpr->op!=TK_IS ) return 0;
  125663. if( ExprHasProperty(pExpr, EP_FromJoin) ) return 0;
  125664. aff1 = sqlite3ExprAffinity(pExpr->pLeft);
  125665. aff2 = sqlite3ExprAffinity(pExpr->pRight);
  125666. if( aff1!=aff2
  125667. && (!sqlite3IsNumericAffinity(aff1) || !sqlite3IsNumericAffinity(aff2))
  125668. ){
  125669. return 0;
  125670. }
  125671. pColl = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft, pExpr->pRight);
  125672. if( pColl==0 || sqlite3StrICmp(pColl->zName, "BINARY")==0 ) return 1;
  125673. return sqlite3ExprCollSeqMatch(pParse, pExpr->pLeft, pExpr->pRight);
  125674. }
  125675. /*
  125676. ** Recursively walk the expressions of a SELECT statement and generate
  125677. ** a bitmask indicating which tables are used in that expression
  125678. ** tree.
  125679. */
  125680. static Bitmask exprSelectUsage(WhereMaskSet *pMaskSet, Select *pS){
  125681. Bitmask mask = 0;
  125682. while( pS ){
  125683. SrcList *pSrc = pS->pSrc;
  125684. mask |= sqlite3WhereExprListUsage(pMaskSet, pS->pEList);
  125685. mask |= sqlite3WhereExprListUsage(pMaskSet, pS->pGroupBy);
  125686. mask |= sqlite3WhereExprListUsage(pMaskSet, pS->pOrderBy);
  125687. mask |= sqlite3WhereExprUsage(pMaskSet, pS->pWhere);
  125688. mask |= sqlite3WhereExprUsage(pMaskSet, pS->pHaving);
  125689. if( ALWAYS(pSrc!=0) ){
  125690. int i;
  125691. for(i=0; i<pSrc->nSrc; i++){
  125692. mask |= exprSelectUsage(pMaskSet, pSrc->a[i].pSelect);
  125693. mask |= sqlite3WhereExprUsage(pMaskSet, pSrc->a[i].pOn);
  125694. if( pSrc->a[i].fg.isTabFunc ){
  125695. mask |= sqlite3WhereExprListUsage(pMaskSet, pSrc->a[i].u1.pFuncArg);
  125696. }
  125697. }
  125698. }
  125699. pS = pS->pPrior;
  125700. }
  125701. return mask;
  125702. }
  125703. /*
  125704. ** Expression pExpr is one operand of a comparison operator that might
  125705. ** be useful for indexing. This routine checks to see if pExpr appears
  125706. ** in any index. Return TRUE (1) if pExpr is an indexed term and return
  125707. ** FALSE (0) if not. If TRUE is returned, also set aiCurCol[0] to the cursor
  125708. ** number of the table that is indexed and aiCurCol[1] to the column number
  125709. ** of the column that is indexed, or XN_EXPR (-2) if an expression is being
  125710. ** indexed.
  125711. **
  125712. ** If pExpr is a TK_COLUMN column reference, then this routine always returns
  125713. ** true even if that particular column is not indexed, because the column
  125714. ** might be added to an automatic index later.
  125715. */
  125716. static SQLITE_NOINLINE int exprMightBeIndexed2(
  125717. SrcList *pFrom, /* The FROM clause */
  125718. Bitmask mPrereq, /* Bitmask of FROM clause terms referenced by pExpr */
  125719. int *aiCurCol, /* Write the referenced table cursor and column here */
  125720. Expr *pExpr /* An operand of a comparison operator */
  125721. ){
  125722. Index *pIdx;
  125723. int i;
  125724. int iCur;
  125725. for(i=0; mPrereq>1; i++, mPrereq>>=1){}
  125726. iCur = pFrom->a[i].iCursor;
  125727. for(pIdx=pFrom->a[i].pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  125728. if( pIdx->aColExpr==0 ) continue;
  125729. for(i=0; i<pIdx->nKeyCol; i++){
  125730. if( pIdx->aiColumn[i]!=XN_EXPR ) continue;
  125731. if( sqlite3ExprCompareSkip(pExpr, pIdx->aColExpr->a[i].pExpr, iCur)==0 ){
  125732. aiCurCol[0] = iCur;
  125733. aiCurCol[1] = XN_EXPR;
  125734. return 1;
  125735. }
  125736. }
  125737. }
  125738. return 0;
  125739. }
  125740. static int exprMightBeIndexed(
  125741. SrcList *pFrom, /* The FROM clause */
  125742. Bitmask mPrereq, /* Bitmask of FROM clause terms referenced by pExpr */
  125743. int *aiCurCol, /* Write the referenced table cursor & column here */
  125744. Expr *pExpr, /* An operand of a comparison operator */
  125745. int op /* The specific comparison operator */
  125746. ){
  125747. /* If this expression is a vector to the left or right of a
  125748. ** inequality constraint (>, <, >= or <=), perform the processing
  125749. ** on the first element of the vector. */
  125750. assert( TK_GT+1==TK_LE && TK_GT+2==TK_LT && TK_GT+3==TK_GE );
  125751. assert( TK_IS<TK_GE && TK_ISNULL<TK_GE && TK_IN<TK_GE );
  125752. assert( op<=TK_GE );
  125753. if( pExpr->op==TK_VECTOR && (op>=TK_GT && ALWAYS(op<=TK_GE)) ){
  125754. pExpr = pExpr->x.pList->a[0].pExpr;
  125755. }
  125756. if( pExpr->op==TK_COLUMN ){
  125757. aiCurCol[0] = pExpr->iTable;
  125758. aiCurCol[1] = pExpr->iColumn;
  125759. return 1;
  125760. }
  125761. if( mPrereq==0 ) return 0; /* No table references */
  125762. if( (mPrereq&(mPrereq-1))!=0 ) return 0; /* Refs more than one table */
  125763. return exprMightBeIndexed2(pFrom,mPrereq,aiCurCol,pExpr);
  125764. }
  125765. /*
  125766. ** The input to this routine is an WhereTerm structure with only the
  125767. ** "pExpr" field filled in. The job of this routine is to analyze the
  125768. ** subexpression and populate all the other fields of the WhereTerm
  125769. ** structure.
  125770. **
  125771. ** If the expression is of the form "<expr> <op> X" it gets commuted
  125772. ** to the standard form of "X <op> <expr>".
  125773. **
  125774. ** If the expression is of the form "X <op> Y" where both X and Y are
  125775. ** columns, then the original expression is unchanged and a new virtual
  125776. ** term of the form "Y <op> X" is added to the WHERE clause and
  125777. ** analyzed separately. The original term is marked with TERM_COPIED
  125778. ** and the new term is marked with TERM_DYNAMIC (because it's pExpr
  125779. ** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
  125780. ** is a commuted copy of a prior term.) The original term has nChild=1
  125781. ** and the copy has idxParent set to the index of the original term.
  125782. */
  125783. static void exprAnalyze(
  125784. SrcList *pSrc, /* the FROM clause */
  125785. WhereClause *pWC, /* the WHERE clause */
  125786. int idxTerm /* Index of the term to be analyzed */
  125787. ){
  125788. WhereInfo *pWInfo = pWC->pWInfo; /* WHERE clause processing context */
  125789. WhereTerm *pTerm; /* The term to be analyzed */
  125790. WhereMaskSet *pMaskSet; /* Set of table index masks */
  125791. Expr *pExpr; /* The expression to be analyzed */
  125792. Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
  125793. Bitmask prereqAll; /* Prerequesites of pExpr */
  125794. Bitmask extraRight = 0; /* Extra dependencies on LEFT JOIN */
  125795. Expr *pStr1 = 0; /* RHS of LIKE/GLOB operator */
  125796. int isComplete = 0; /* RHS of LIKE/GLOB ends with wildcard */
  125797. int noCase = 0; /* uppercase equivalent to lowercase */
  125798. int op; /* Top-level operator. pExpr->op */
  125799. Parse *pParse = pWInfo->pParse; /* Parsing context */
  125800. sqlite3 *db = pParse->db; /* Database connection */
  125801. unsigned char eOp2 = 0; /* op2 value for LIKE/REGEXP/GLOB */
  125802. int nLeft; /* Number of elements on left side vector */
  125803. if( db->mallocFailed ){
  125804. return;
  125805. }
  125806. pTerm = &pWC->a[idxTerm];
  125807. pMaskSet = &pWInfo->sMaskSet;
  125808. pExpr = pTerm->pExpr;
  125809. assert( pExpr->op!=TK_AS && pExpr->op!=TK_COLLATE );
  125810. prereqLeft = sqlite3WhereExprUsage(pMaskSet, pExpr->pLeft);
  125811. op = pExpr->op;
  125812. if( op==TK_IN ){
  125813. assert( pExpr->pRight==0 );
  125814. if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
  125815. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  125816. pTerm->prereqRight = exprSelectUsage(pMaskSet, pExpr->x.pSelect);
  125817. }else{
  125818. pTerm->prereqRight = sqlite3WhereExprListUsage(pMaskSet, pExpr->x.pList);
  125819. }
  125820. }else if( op==TK_ISNULL ){
  125821. pTerm->prereqRight = 0;
  125822. }else{
  125823. pTerm->prereqRight = sqlite3WhereExprUsage(pMaskSet, pExpr->pRight);
  125824. }
  125825. pMaskSet->bVarSelect = 0;
  125826. prereqAll = sqlite3WhereExprUsage(pMaskSet, pExpr);
  125827. if( pMaskSet->bVarSelect ) pTerm->wtFlags |= TERM_VARSELECT;
  125828. if( ExprHasProperty(pExpr, EP_FromJoin) ){
  125829. Bitmask x = sqlite3WhereGetMask(pMaskSet, pExpr->iRightJoinTable);
  125830. prereqAll |= x;
  125831. extraRight = x-1; /* ON clause terms may not be used with an index
  125832. ** on left table of a LEFT JOIN. Ticket #3015 */
  125833. if( (prereqAll>>1)>=x ){
  125834. sqlite3ErrorMsg(pParse, "ON clause references tables to its right");
  125835. return;
  125836. }
  125837. }
  125838. pTerm->prereqAll = prereqAll;
  125839. pTerm->leftCursor = -1;
  125840. pTerm->iParent = -1;
  125841. pTerm->eOperator = 0;
  125842. if( allowedOp(op) ){
  125843. int aiCurCol[2];
  125844. Expr *pLeft = sqlite3ExprSkipCollate(pExpr->pLeft);
  125845. Expr *pRight = sqlite3ExprSkipCollate(pExpr->pRight);
  125846. u16 opMask = (pTerm->prereqRight & prereqLeft)==0 ? WO_ALL : WO_EQUIV;
  125847. if( pTerm->iField>0 ){
  125848. assert( op==TK_IN );
  125849. assert( pLeft->op==TK_VECTOR );
  125850. pLeft = pLeft->x.pList->a[pTerm->iField-1].pExpr;
  125851. }
  125852. if( exprMightBeIndexed(pSrc, prereqLeft, aiCurCol, pLeft, op) ){
  125853. pTerm->leftCursor = aiCurCol[0];
  125854. pTerm->u.leftColumn = aiCurCol[1];
  125855. pTerm->eOperator = operatorMask(op) & opMask;
  125856. }
  125857. if( op==TK_IS ) pTerm->wtFlags |= TERM_IS;
  125858. if( pRight
  125859. && exprMightBeIndexed(pSrc, pTerm->prereqRight, aiCurCol, pRight, op)
  125860. ){
  125861. WhereTerm *pNew;
  125862. Expr *pDup;
  125863. u16 eExtraOp = 0; /* Extra bits for pNew->eOperator */
  125864. assert( pTerm->iField==0 );
  125865. if( pTerm->leftCursor>=0 ){
  125866. int idxNew;
  125867. pDup = sqlite3ExprDup(db, pExpr, 0);
  125868. if( db->mallocFailed ){
  125869. sqlite3ExprDelete(db, pDup);
  125870. return;
  125871. }
  125872. idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
  125873. if( idxNew==0 ) return;
  125874. pNew = &pWC->a[idxNew];
  125875. markTermAsChild(pWC, idxNew, idxTerm);
  125876. if( op==TK_IS ) pNew->wtFlags |= TERM_IS;
  125877. pTerm = &pWC->a[idxTerm];
  125878. pTerm->wtFlags |= TERM_COPIED;
  125879. if( termIsEquivalence(pParse, pDup) ){
  125880. pTerm->eOperator |= WO_EQUIV;
  125881. eExtraOp = WO_EQUIV;
  125882. }
  125883. }else{
  125884. pDup = pExpr;
  125885. pNew = pTerm;
  125886. }
  125887. exprCommute(pParse, pDup);
  125888. pNew->leftCursor = aiCurCol[0];
  125889. pNew->u.leftColumn = aiCurCol[1];
  125890. testcase( (prereqLeft | extraRight) != prereqLeft );
  125891. pNew->prereqRight = prereqLeft | extraRight;
  125892. pNew->prereqAll = prereqAll;
  125893. pNew->eOperator = (operatorMask(pDup->op) + eExtraOp) & opMask;
  125894. }
  125895. }
  125896. #ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
  125897. /* If a term is the BETWEEN operator, create two new virtual terms
  125898. ** that define the range that the BETWEEN implements. For example:
  125899. **
  125900. ** a BETWEEN b AND c
  125901. **
  125902. ** is converted into:
  125903. **
  125904. ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
  125905. **
  125906. ** The two new terms are added onto the end of the WhereClause object.
  125907. ** The new terms are "dynamic" and are children of the original BETWEEN
  125908. ** term. That means that if the BETWEEN term is coded, the children are
  125909. ** skipped. Or, if the children are satisfied by an index, the original
  125910. ** BETWEEN term is skipped.
  125911. */
  125912. else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
  125913. ExprList *pList = pExpr->x.pList;
  125914. int i;
  125915. static const u8 ops[] = {TK_GE, TK_LE};
  125916. assert( pList!=0 );
  125917. assert( pList->nExpr==2 );
  125918. for(i=0; i<2; i++){
  125919. Expr *pNewExpr;
  125920. int idxNew;
  125921. pNewExpr = sqlite3PExpr(pParse, ops[i],
  125922. sqlite3ExprDup(db, pExpr->pLeft, 0),
  125923. sqlite3ExprDup(db, pList->a[i].pExpr, 0));
  125924. transferJoinMarkings(pNewExpr, pExpr);
  125925. idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
  125926. testcase( idxNew==0 );
  125927. exprAnalyze(pSrc, pWC, idxNew);
  125928. pTerm = &pWC->a[idxTerm];
  125929. markTermAsChild(pWC, idxNew, idxTerm);
  125930. }
  125931. }
  125932. #endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
  125933. #if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
  125934. /* Analyze a term that is composed of two or more subterms connected by
  125935. ** an OR operator.
  125936. */
  125937. else if( pExpr->op==TK_OR ){
  125938. assert( pWC->op==TK_AND );
  125939. exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
  125940. pTerm = &pWC->a[idxTerm];
  125941. }
  125942. #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
  125943. #ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
  125944. /* Add constraints to reduce the search space on a LIKE or GLOB
  125945. ** operator.
  125946. **
  125947. ** A like pattern of the form "x LIKE 'aBc%'" is changed into constraints
  125948. **
  125949. ** x>='ABC' AND x<'abd' AND x LIKE 'aBc%'
  125950. **
  125951. ** The last character of the prefix "abc" is incremented to form the
  125952. ** termination condition "abd". If case is not significant (the default
  125953. ** for LIKE) then the lower-bound is made all uppercase and the upper-
  125954. ** bound is made all lowercase so that the bounds also work when comparing
  125955. ** BLOBs.
  125956. */
  125957. if( pWC->op==TK_AND
  125958. && isLikeOrGlob(pParse, pExpr, &pStr1, &isComplete, &noCase)
  125959. ){
  125960. Expr *pLeft; /* LHS of LIKE/GLOB operator */
  125961. Expr *pStr2; /* Copy of pStr1 - RHS of LIKE/GLOB operator */
  125962. Expr *pNewExpr1;
  125963. Expr *pNewExpr2;
  125964. int idxNew1;
  125965. int idxNew2;
  125966. const char *zCollSeqName; /* Name of collating sequence */
  125967. const u16 wtFlags = TERM_LIKEOPT | TERM_VIRTUAL | TERM_DYNAMIC;
  125968. pLeft = pExpr->x.pList->a[1].pExpr;
  125969. pStr2 = sqlite3ExprDup(db, pStr1, 0);
  125970. /* Convert the lower bound to upper-case and the upper bound to
  125971. ** lower-case (upper-case is less than lower-case in ASCII) so that
  125972. ** the range constraints also work for BLOBs
  125973. */
  125974. if( noCase && !pParse->db->mallocFailed ){
  125975. int i;
  125976. char c;
  125977. pTerm->wtFlags |= TERM_LIKE;
  125978. for(i=0; (c = pStr1->u.zToken[i])!=0; i++){
  125979. pStr1->u.zToken[i] = sqlite3Toupper(c);
  125980. pStr2->u.zToken[i] = sqlite3Tolower(c);
  125981. }
  125982. }
  125983. if( !db->mallocFailed ){
  125984. u8 c, *pC; /* Last character before the first wildcard */
  125985. pC = (u8*)&pStr2->u.zToken[sqlite3Strlen30(pStr2->u.zToken)-1];
  125986. c = *pC;
  125987. if( noCase ){
  125988. /* The point is to increment the last character before the first
  125989. ** wildcard. But if we increment '@', that will push it into the
  125990. ** alphabetic range where case conversions will mess up the
  125991. ** inequality. To avoid this, make sure to also run the full
  125992. ** LIKE on all candidate expressions by clearing the isComplete flag
  125993. */
  125994. if( c=='A'-1 ) isComplete = 0;
  125995. c = sqlite3UpperToLower[c];
  125996. }
  125997. *pC = c + 1;
  125998. }
  125999. zCollSeqName = noCase ? "NOCASE" : "BINARY";
  126000. pNewExpr1 = sqlite3ExprDup(db, pLeft, 0);
  126001. pNewExpr1 = sqlite3PExpr(pParse, TK_GE,
  126002. sqlite3ExprAddCollateString(pParse,pNewExpr1,zCollSeqName),
  126003. pStr1);
  126004. transferJoinMarkings(pNewExpr1, pExpr);
  126005. idxNew1 = whereClauseInsert(pWC, pNewExpr1, wtFlags);
  126006. testcase( idxNew1==0 );
  126007. exprAnalyze(pSrc, pWC, idxNew1);
  126008. pNewExpr2 = sqlite3ExprDup(db, pLeft, 0);
  126009. pNewExpr2 = sqlite3PExpr(pParse, TK_LT,
  126010. sqlite3ExprAddCollateString(pParse,pNewExpr2,zCollSeqName),
  126011. pStr2);
  126012. transferJoinMarkings(pNewExpr2, pExpr);
  126013. idxNew2 = whereClauseInsert(pWC, pNewExpr2, wtFlags);
  126014. testcase( idxNew2==0 );
  126015. exprAnalyze(pSrc, pWC, idxNew2);
  126016. pTerm = &pWC->a[idxTerm];
  126017. if( isComplete ){
  126018. markTermAsChild(pWC, idxNew1, idxTerm);
  126019. markTermAsChild(pWC, idxNew2, idxTerm);
  126020. }
  126021. }
  126022. #endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
  126023. #ifndef SQLITE_OMIT_VIRTUALTABLE
  126024. /* Add a WO_AUX auxiliary term to the constraint set if the
  126025. ** current expression is of the form "column OP expr" where OP
  126026. ** is an operator that gets passed into virtual tables but which is
  126027. ** not normally optimized for ordinary tables. In other words, OP
  126028. ** is one of MATCH, LIKE, GLOB, REGEXP, !=, IS, IS NOT, or NOT NULL.
  126029. ** This information is used by the xBestIndex methods of
  126030. ** virtual tables. The native query optimizer does not attempt
  126031. ** to do anything with MATCH functions.
  126032. */
  126033. if( pWC->op==TK_AND ){
  126034. Expr *pRight = 0, *pLeft = 0;
  126035. int res = isAuxiliaryVtabOperator(pExpr, &eOp2, &pLeft, &pRight);
  126036. while( res-- > 0 ){
  126037. int idxNew;
  126038. WhereTerm *pNewTerm;
  126039. Bitmask prereqColumn, prereqExpr;
  126040. prereqExpr = sqlite3WhereExprUsage(pMaskSet, pRight);
  126041. prereqColumn = sqlite3WhereExprUsage(pMaskSet, pLeft);
  126042. if( (prereqExpr & prereqColumn)==0 ){
  126043. Expr *pNewExpr;
  126044. pNewExpr = sqlite3PExpr(pParse, TK_MATCH,
  126045. 0, sqlite3ExprDup(db, pRight, 0));
  126046. if( ExprHasProperty(pExpr, EP_FromJoin) && pNewExpr ){
  126047. ExprSetProperty(pNewExpr, EP_FromJoin);
  126048. }
  126049. idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
  126050. testcase( idxNew==0 );
  126051. pNewTerm = &pWC->a[idxNew];
  126052. pNewTerm->prereqRight = prereqExpr;
  126053. pNewTerm->leftCursor = pLeft->iTable;
  126054. pNewTerm->u.leftColumn = pLeft->iColumn;
  126055. pNewTerm->eOperator = WO_AUX;
  126056. pNewTerm->eMatchOp = eOp2;
  126057. markTermAsChild(pWC, idxNew, idxTerm);
  126058. pTerm = &pWC->a[idxTerm];
  126059. pTerm->wtFlags |= TERM_COPIED;
  126060. pNewTerm->prereqAll = pTerm->prereqAll;
  126061. }
  126062. SWAP(Expr*, pLeft, pRight);
  126063. }
  126064. }
  126065. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  126066. /* If there is a vector == or IS term - e.g. "(a, b) == (?, ?)" - create
  126067. ** new terms for each component comparison - "a = ?" and "b = ?". The
  126068. ** new terms completely replace the original vector comparison, which is
  126069. ** no longer used.
  126070. **
  126071. ** This is only required if at least one side of the comparison operation
  126072. ** is not a sub-select. */
  126073. if( pWC->op==TK_AND
  126074. && (pExpr->op==TK_EQ || pExpr->op==TK_IS)
  126075. && (nLeft = sqlite3ExprVectorSize(pExpr->pLeft))>1
  126076. && sqlite3ExprVectorSize(pExpr->pRight)==nLeft
  126077. && ( (pExpr->pLeft->flags & EP_xIsSelect)==0
  126078. || (pExpr->pRight->flags & EP_xIsSelect)==0)
  126079. ){
  126080. int i;
  126081. for(i=0; i<nLeft; i++){
  126082. int idxNew;
  126083. Expr *pNew;
  126084. Expr *pLeft = sqlite3ExprForVectorField(pParse, pExpr->pLeft, i);
  126085. Expr *pRight = sqlite3ExprForVectorField(pParse, pExpr->pRight, i);
  126086. pNew = sqlite3PExpr(pParse, pExpr->op, pLeft, pRight);
  126087. transferJoinMarkings(pNew, pExpr);
  126088. idxNew = whereClauseInsert(pWC, pNew, TERM_DYNAMIC);
  126089. exprAnalyze(pSrc, pWC, idxNew);
  126090. }
  126091. pTerm = &pWC->a[idxTerm];
  126092. pTerm->wtFlags |= TERM_CODED|TERM_VIRTUAL; /* Disable the original */
  126093. pTerm->eOperator = 0;
  126094. }
  126095. /* If there is a vector IN term - e.g. "(a, b) IN (SELECT ...)" - create
  126096. ** a virtual term for each vector component. The expression object
  126097. ** used by each such virtual term is pExpr (the full vector IN(...)
  126098. ** expression). The WhereTerm.iField variable identifies the index within
  126099. ** the vector on the LHS that the virtual term represents.
  126100. **
  126101. ** This only works if the RHS is a simple SELECT, not a compound
  126102. */
  126103. if( pWC->op==TK_AND && pExpr->op==TK_IN && pTerm->iField==0
  126104. && pExpr->pLeft->op==TK_VECTOR
  126105. && pExpr->x.pSelect->pPrior==0
  126106. ){
  126107. int i;
  126108. for(i=0; i<sqlite3ExprVectorSize(pExpr->pLeft); i++){
  126109. int idxNew;
  126110. idxNew = whereClauseInsert(pWC, pExpr, TERM_VIRTUAL);
  126111. pWC->a[idxNew].iField = i+1;
  126112. exprAnalyze(pSrc, pWC, idxNew);
  126113. markTermAsChild(pWC, idxNew, idxTerm);
  126114. }
  126115. }
  126116. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  126117. /* When sqlite_stat3 histogram data is available an operator of the
  126118. ** form "x IS NOT NULL" can sometimes be evaluated more efficiently
  126119. ** as "x>NULL" if x is not an INTEGER PRIMARY KEY. So construct a
  126120. ** virtual term of that form.
  126121. **
  126122. ** Note that the virtual term must be tagged with TERM_VNULL.
  126123. */
  126124. if( pExpr->op==TK_NOTNULL
  126125. && pExpr->pLeft->op==TK_COLUMN
  126126. && pExpr->pLeft->iColumn>=0
  126127. && OptimizationEnabled(db, SQLITE_Stat34)
  126128. ){
  126129. Expr *pNewExpr;
  126130. Expr *pLeft = pExpr->pLeft;
  126131. int idxNew;
  126132. WhereTerm *pNewTerm;
  126133. pNewExpr = sqlite3PExpr(pParse, TK_GT,
  126134. sqlite3ExprDup(db, pLeft, 0),
  126135. sqlite3ExprAlloc(db, TK_NULL, 0, 0));
  126136. idxNew = whereClauseInsert(pWC, pNewExpr,
  126137. TERM_VIRTUAL|TERM_DYNAMIC|TERM_VNULL);
  126138. if( idxNew ){
  126139. pNewTerm = &pWC->a[idxNew];
  126140. pNewTerm->prereqRight = 0;
  126141. pNewTerm->leftCursor = pLeft->iTable;
  126142. pNewTerm->u.leftColumn = pLeft->iColumn;
  126143. pNewTerm->eOperator = WO_GT;
  126144. markTermAsChild(pWC, idxNew, idxTerm);
  126145. pTerm = &pWC->a[idxTerm];
  126146. pTerm->wtFlags |= TERM_COPIED;
  126147. pNewTerm->prereqAll = pTerm->prereqAll;
  126148. }
  126149. }
  126150. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  126151. /* Prevent ON clause terms of a LEFT JOIN from being used to drive
  126152. ** an index for tables to the left of the join.
  126153. */
  126154. testcase( pTerm!=&pWC->a[idxTerm] );
  126155. pTerm = &pWC->a[idxTerm];
  126156. pTerm->prereqRight |= extraRight;
  126157. }
  126158. /***************************************************************************
  126159. ** Routines with file scope above. Interface to the rest of the where.c
  126160. ** subsystem follows.
  126161. ***************************************************************************/
  126162. /*
  126163. ** This routine identifies subexpressions in the WHERE clause where
  126164. ** each subexpression is separated by the AND operator or some other
  126165. ** operator specified in the op parameter. The WhereClause structure
  126166. ** is filled with pointers to subexpressions. For example:
  126167. **
  126168. ** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
  126169. ** \________/ \_______________/ \________________/
  126170. ** slot[0] slot[1] slot[2]
  126171. **
  126172. ** The original WHERE clause in pExpr is unaltered. All this routine
  126173. ** does is make slot[] entries point to substructure within pExpr.
  126174. **
  126175. ** In the previous sentence and in the diagram, "slot[]" refers to
  126176. ** the WhereClause.a[] array. The slot[] array grows as needed to contain
  126177. ** all terms of the WHERE clause.
  126178. */
  126179. SQLITE_PRIVATE void sqlite3WhereSplit(WhereClause *pWC, Expr *pExpr, u8 op){
  126180. Expr *pE2 = sqlite3ExprSkipCollate(pExpr);
  126181. pWC->op = op;
  126182. if( pE2==0 ) return;
  126183. if( pE2->op!=op ){
  126184. whereClauseInsert(pWC, pExpr, 0);
  126185. }else{
  126186. sqlite3WhereSplit(pWC, pE2->pLeft, op);
  126187. sqlite3WhereSplit(pWC, pE2->pRight, op);
  126188. }
  126189. }
  126190. /*
  126191. ** Initialize a preallocated WhereClause structure.
  126192. */
  126193. SQLITE_PRIVATE void sqlite3WhereClauseInit(
  126194. WhereClause *pWC, /* The WhereClause to be initialized */
  126195. WhereInfo *pWInfo /* The WHERE processing context */
  126196. ){
  126197. pWC->pWInfo = pWInfo;
  126198. pWC->pOuter = 0;
  126199. pWC->nTerm = 0;
  126200. pWC->nSlot = ArraySize(pWC->aStatic);
  126201. pWC->a = pWC->aStatic;
  126202. }
  126203. /*
  126204. ** Deallocate a WhereClause structure. The WhereClause structure
  126205. ** itself is not freed. This routine is the inverse of
  126206. ** sqlite3WhereClauseInit().
  126207. */
  126208. SQLITE_PRIVATE void sqlite3WhereClauseClear(WhereClause *pWC){
  126209. int i;
  126210. WhereTerm *a;
  126211. sqlite3 *db = pWC->pWInfo->pParse->db;
  126212. for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
  126213. if( a->wtFlags & TERM_DYNAMIC ){
  126214. sqlite3ExprDelete(db, a->pExpr);
  126215. }
  126216. if( a->wtFlags & TERM_ORINFO ){
  126217. whereOrInfoDelete(db, a->u.pOrInfo);
  126218. }else if( a->wtFlags & TERM_ANDINFO ){
  126219. whereAndInfoDelete(db, a->u.pAndInfo);
  126220. }
  126221. }
  126222. if( pWC->a!=pWC->aStatic ){
  126223. sqlite3DbFree(db, pWC->a);
  126224. }
  126225. }
  126226. /*
  126227. ** These routines walk (recursively) an expression tree and generate
  126228. ** a bitmask indicating which tables are used in that expression
  126229. ** tree.
  126230. */
  126231. SQLITE_PRIVATE Bitmask sqlite3WhereExprUsage(WhereMaskSet *pMaskSet, Expr *p){
  126232. Bitmask mask;
  126233. if( p==0 ) return 0;
  126234. if( p->op==TK_COLUMN ){
  126235. return sqlite3WhereGetMask(pMaskSet, p->iTable);
  126236. }
  126237. mask = (p->op==TK_IF_NULL_ROW) ? sqlite3WhereGetMask(pMaskSet, p->iTable) : 0;
  126238. assert( !ExprHasProperty(p, EP_TokenOnly) );
  126239. if( p->pLeft ) mask |= sqlite3WhereExprUsage(pMaskSet, p->pLeft);
  126240. if( p->pRight ){
  126241. mask |= sqlite3WhereExprUsage(pMaskSet, p->pRight);
  126242. assert( p->x.pList==0 );
  126243. }else if( ExprHasProperty(p, EP_xIsSelect) ){
  126244. if( ExprHasProperty(p, EP_VarSelect) ) pMaskSet->bVarSelect = 1;
  126245. mask |= exprSelectUsage(pMaskSet, p->x.pSelect);
  126246. }else if( p->x.pList ){
  126247. mask |= sqlite3WhereExprListUsage(pMaskSet, p->x.pList);
  126248. }
  126249. return mask;
  126250. }
  126251. SQLITE_PRIVATE Bitmask sqlite3WhereExprListUsage(WhereMaskSet *pMaskSet, ExprList *pList){
  126252. int i;
  126253. Bitmask mask = 0;
  126254. if( pList ){
  126255. for(i=0; i<pList->nExpr; i++){
  126256. mask |= sqlite3WhereExprUsage(pMaskSet, pList->a[i].pExpr);
  126257. }
  126258. }
  126259. return mask;
  126260. }
  126261. /*
  126262. ** Call exprAnalyze on all terms in a WHERE clause.
  126263. **
  126264. ** Note that exprAnalyze() might add new virtual terms onto the
  126265. ** end of the WHERE clause. We do not want to analyze these new
  126266. ** virtual terms, so start analyzing at the end and work forward
  126267. ** so that the added virtual terms are never processed.
  126268. */
  126269. SQLITE_PRIVATE void sqlite3WhereExprAnalyze(
  126270. SrcList *pTabList, /* the FROM clause */
  126271. WhereClause *pWC /* the WHERE clause to be analyzed */
  126272. ){
  126273. int i;
  126274. for(i=pWC->nTerm-1; i>=0; i--){
  126275. exprAnalyze(pTabList, pWC, i);
  126276. }
  126277. }
  126278. /*
  126279. ** For table-valued-functions, transform the function arguments into
  126280. ** new WHERE clause terms.
  126281. **
  126282. ** Each function argument translates into an equality constraint against
  126283. ** a HIDDEN column in the table.
  126284. */
  126285. SQLITE_PRIVATE void sqlite3WhereTabFuncArgs(
  126286. Parse *pParse, /* Parsing context */
  126287. struct SrcList_item *pItem, /* The FROM clause term to process */
  126288. WhereClause *pWC /* Xfer function arguments to here */
  126289. ){
  126290. Table *pTab;
  126291. int j, k;
  126292. ExprList *pArgs;
  126293. Expr *pColRef;
  126294. Expr *pTerm;
  126295. if( pItem->fg.isTabFunc==0 ) return;
  126296. pTab = pItem->pTab;
  126297. assert( pTab!=0 );
  126298. pArgs = pItem->u1.pFuncArg;
  126299. if( pArgs==0 ) return;
  126300. for(j=k=0; j<pArgs->nExpr; j++){
  126301. while( k<pTab->nCol && (pTab->aCol[k].colFlags & COLFLAG_HIDDEN)==0 ){k++;}
  126302. if( k>=pTab->nCol ){
  126303. sqlite3ErrorMsg(pParse, "too many arguments on %s() - max %d",
  126304. pTab->zName, j);
  126305. return;
  126306. }
  126307. pColRef = sqlite3ExprAlloc(pParse->db, TK_COLUMN, 0, 0);
  126308. if( pColRef==0 ) return;
  126309. pColRef->iTable = pItem->iCursor;
  126310. pColRef->iColumn = k++;
  126311. pColRef->pTab = pTab;
  126312. pTerm = sqlite3PExpr(pParse, TK_EQ, pColRef,
  126313. sqlite3ExprDup(pParse->db, pArgs->a[j].pExpr, 0));
  126314. whereClauseInsert(pWC, pTerm, TERM_DYNAMIC);
  126315. }
  126316. }
  126317. /************** End of whereexpr.c *******************************************/
  126318. /************** Begin file where.c *******************************************/
  126319. /*
  126320. ** 2001 September 15
  126321. **
  126322. ** The author disclaims copyright to this source code. In place of
  126323. ** a legal notice, here is a blessing:
  126324. **
  126325. ** May you do good and not evil.
  126326. ** May you find forgiveness for yourself and forgive others.
  126327. ** May you share freely, never taking more than you give.
  126328. **
  126329. *************************************************************************
  126330. ** This module contains C code that generates VDBE code used to process
  126331. ** the WHERE clause of SQL statements. This module is responsible for
  126332. ** generating the code that loops through a table looking for applicable
  126333. ** rows. Indices are selected and used to speed the search when doing
  126334. ** so is applicable. Because this module is responsible for selecting
  126335. ** indices, you might also think of this module as the "query optimizer".
  126336. */
  126337. /* #include "sqliteInt.h" */
  126338. /* #include "whereInt.h" */
  126339. /*
  126340. ** Extra information appended to the end of sqlite3_index_info but not
  126341. ** visible to the xBestIndex function, at least not directly. The
  126342. ** sqlite3_vtab_collation() interface knows how to reach it, however.
  126343. **
  126344. ** This object is not an API and can be changed from one release to the
  126345. ** next. As long as allocateIndexInfo() and sqlite3_vtab_collation()
  126346. ** agree on the structure, all will be well.
  126347. */
  126348. typedef struct HiddenIndexInfo HiddenIndexInfo;
  126349. struct HiddenIndexInfo {
  126350. WhereClause *pWC; /* The Where clause being analyzed */
  126351. Parse *pParse; /* The parsing context */
  126352. };
  126353. /* Forward declaration of methods */
  126354. static int whereLoopResize(sqlite3*, WhereLoop*, int);
  126355. /* Test variable that can be set to enable WHERE tracing */
  126356. #if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
  126357. /***/ int sqlite3WhereTrace = 0;
  126358. #endif
  126359. /*
  126360. ** Return the estimated number of output rows from a WHERE clause
  126361. */
  126362. SQLITE_PRIVATE LogEst sqlite3WhereOutputRowCount(WhereInfo *pWInfo){
  126363. return pWInfo->nRowOut;
  126364. }
  126365. /*
  126366. ** Return one of the WHERE_DISTINCT_xxxxx values to indicate how this
  126367. ** WHERE clause returns outputs for DISTINCT processing.
  126368. */
  126369. SQLITE_PRIVATE int sqlite3WhereIsDistinct(WhereInfo *pWInfo){
  126370. return pWInfo->eDistinct;
  126371. }
  126372. /*
  126373. ** Return TRUE if the WHERE clause returns rows in ORDER BY order.
  126374. ** Return FALSE if the output needs to be sorted.
  126375. */
  126376. SQLITE_PRIVATE int sqlite3WhereIsOrdered(WhereInfo *pWInfo){
  126377. return pWInfo->nOBSat;
  126378. }
  126379. /*
  126380. ** Return TRUE if the innermost loop of the WHERE clause implementation
  126381. ** returns rows in ORDER BY order for complete run of the inner loop.
  126382. **
  126383. ** Across multiple iterations of outer loops, the output rows need not be
  126384. ** sorted. As long as rows are sorted for just the innermost loop, this
  126385. ** routine can return TRUE.
  126386. */
  126387. SQLITE_PRIVATE int sqlite3WhereOrderedInnerLoop(WhereInfo *pWInfo){
  126388. return pWInfo->bOrderedInnerLoop;
  126389. }
  126390. /*
  126391. ** Return the VDBE address or label to jump to in order to continue
  126392. ** immediately with the next row of a WHERE clause.
  126393. */
  126394. SQLITE_PRIVATE int sqlite3WhereContinueLabel(WhereInfo *pWInfo){
  126395. assert( pWInfo->iContinue!=0 );
  126396. return pWInfo->iContinue;
  126397. }
  126398. /*
  126399. ** Return the VDBE address or label to jump to in order to break
  126400. ** out of a WHERE loop.
  126401. */
  126402. SQLITE_PRIVATE int sqlite3WhereBreakLabel(WhereInfo *pWInfo){
  126403. return pWInfo->iBreak;
  126404. }
  126405. /*
  126406. ** Return ONEPASS_OFF (0) if an UPDATE or DELETE statement is unable to
  126407. ** operate directly on the rowis returned by a WHERE clause. Return
  126408. ** ONEPASS_SINGLE (1) if the statement can operation directly because only
  126409. ** a single row is to be changed. Return ONEPASS_MULTI (2) if the one-pass
  126410. ** optimization can be used on multiple
  126411. **
  126412. ** If the ONEPASS optimization is used (if this routine returns true)
  126413. ** then also write the indices of open cursors used by ONEPASS
  126414. ** into aiCur[0] and aiCur[1]. iaCur[0] gets the cursor of the data
  126415. ** table and iaCur[1] gets the cursor used by an auxiliary index.
  126416. ** Either value may be -1, indicating that cursor is not used.
  126417. ** Any cursors returned will have been opened for writing.
  126418. **
  126419. ** aiCur[0] and aiCur[1] both get -1 if the where-clause logic is
  126420. ** unable to use the ONEPASS optimization.
  126421. */
  126422. SQLITE_PRIVATE int sqlite3WhereOkOnePass(WhereInfo *pWInfo, int *aiCur){
  126423. memcpy(aiCur, pWInfo->aiCurOnePass, sizeof(int)*2);
  126424. #ifdef WHERETRACE_ENABLED
  126425. if( sqlite3WhereTrace && pWInfo->eOnePass!=ONEPASS_OFF ){
  126426. sqlite3DebugPrintf("%s cursors: %d %d\n",
  126427. pWInfo->eOnePass==ONEPASS_SINGLE ? "ONEPASS_SINGLE" : "ONEPASS_MULTI",
  126428. aiCur[0], aiCur[1]);
  126429. }
  126430. #endif
  126431. return pWInfo->eOnePass;
  126432. }
  126433. /*
  126434. ** Move the content of pSrc into pDest
  126435. */
  126436. static void whereOrMove(WhereOrSet *pDest, WhereOrSet *pSrc){
  126437. pDest->n = pSrc->n;
  126438. memcpy(pDest->a, pSrc->a, pDest->n*sizeof(pDest->a[0]));
  126439. }
  126440. /*
  126441. ** Try to insert a new prerequisite/cost entry into the WhereOrSet pSet.
  126442. **
  126443. ** The new entry might overwrite an existing entry, or it might be
  126444. ** appended, or it might be discarded. Do whatever is the right thing
  126445. ** so that pSet keeps the N_OR_COST best entries seen so far.
  126446. */
  126447. static int whereOrInsert(
  126448. WhereOrSet *pSet, /* The WhereOrSet to be updated */
  126449. Bitmask prereq, /* Prerequisites of the new entry */
  126450. LogEst rRun, /* Run-cost of the new entry */
  126451. LogEst nOut /* Number of outputs for the new entry */
  126452. ){
  126453. u16 i;
  126454. WhereOrCost *p;
  126455. for(i=pSet->n, p=pSet->a; i>0; i--, p++){
  126456. if( rRun<=p->rRun && (prereq & p->prereq)==prereq ){
  126457. goto whereOrInsert_done;
  126458. }
  126459. if( p->rRun<=rRun && (p->prereq & prereq)==p->prereq ){
  126460. return 0;
  126461. }
  126462. }
  126463. if( pSet->n<N_OR_COST ){
  126464. p = &pSet->a[pSet->n++];
  126465. p->nOut = nOut;
  126466. }else{
  126467. p = pSet->a;
  126468. for(i=1; i<pSet->n; i++){
  126469. if( p->rRun>pSet->a[i].rRun ) p = pSet->a + i;
  126470. }
  126471. if( p->rRun<=rRun ) return 0;
  126472. }
  126473. whereOrInsert_done:
  126474. p->prereq = prereq;
  126475. p->rRun = rRun;
  126476. if( p->nOut>nOut ) p->nOut = nOut;
  126477. return 1;
  126478. }
  126479. /*
  126480. ** Return the bitmask for the given cursor number. Return 0 if
  126481. ** iCursor is not in the set.
  126482. */
  126483. SQLITE_PRIVATE Bitmask sqlite3WhereGetMask(WhereMaskSet *pMaskSet, int iCursor){
  126484. int i;
  126485. assert( pMaskSet->n<=(int)sizeof(Bitmask)*8 );
  126486. for(i=0; i<pMaskSet->n; i++){
  126487. if( pMaskSet->ix[i]==iCursor ){
  126488. return MASKBIT(i);
  126489. }
  126490. }
  126491. return 0;
  126492. }
  126493. /*
  126494. ** Create a new mask for cursor iCursor.
  126495. **
  126496. ** There is one cursor per table in the FROM clause. The number of
  126497. ** tables in the FROM clause is limited by a test early in the
  126498. ** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
  126499. ** array will never overflow.
  126500. */
  126501. static void createMask(WhereMaskSet *pMaskSet, int iCursor){
  126502. assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
  126503. pMaskSet->ix[pMaskSet->n++] = iCursor;
  126504. }
  126505. /*
  126506. ** Advance to the next WhereTerm that matches according to the criteria
  126507. ** established when the pScan object was initialized by whereScanInit().
  126508. ** Return NULL if there are no more matching WhereTerms.
  126509. */
  126510. static WhereTerm *whereScanNext(WhereScan *pScan){
  126511. int iCur; /* The cursor on the LHS of the term */
  126512. i16 iColumn; /* The column on the LHS of the term. -1 for IPK */
  126513. Expr *pX; /* An expression being tested */
  126514. WhereClause *pWC; /* Shorthand for pScan->pWC */
  126515. WhereTerm *pTerm; /* The term being tested */
  126516. int k = pScan->k; /* Where to start scanning */
  126517. assert( pScan->iEquiv<=pScan->nEquiv );
  126518. pWC = pScan->pWC;
  126519. while(1){
  126520. iColumn = pScan->aiColumn[pScan->iEquiv-1];
  126521. iCur = pScan->aiCur[pScan->iEquiv-1];
  126522. assert( pWC!=0 );
  126523. do{
  126524. for(pTerm=pWC->a+k; k<pWC->nTerm; k++, pTerm++){
  126525. if( pTerm->leftCursor==iCur
  126526. && pTerm->u.leftColumn==iColumn
  126527. && (iColumn!=XN_EXPR
  126528. || sqlite3ExprCompareSkip(pTerm->pExpr->pLeft,
  126529. pScan->pIdxExpr,iCur)==0)
  126530. && (pScan->iEquiv<=1 || !ExprHasProperty(pTerm->pExpr, EP_FromJoin))
  126531. ){
  126532. if( (pTerm->eOperator & WO_EQUIV)!=0
  126533. && pScan->nEquiv<ArraySize(pScan->aiCur)
  126534. && (pX = sqlite3ExprSkipCollate(pTerm->pExpr->pRight))->op==TK_COLUMN
  126535. ){
  126536. int j;
  126537. for(j=0; j<pScan->nEquiv; j++){
  126538. if( pScan->aiCur[j]==pX->iTable
  126539. && pScan->aiColumn[j]==pX->iColumn ){
  126540. break;
  126541. }
  126542. }
  126543. if( j==pScan->nEquiv ){
  126544. pScan->aiCur[j] = pX->iTable;
  126545. pScan->aiColumn[j] = pX->iColumn;
  126546. pScan->nEquiv++;
  126547. }
  126548. }
  126549. if( (pTerm->eOperator & pScan->opMask)!=0 ){
  126550. /* Verify the affinity and collating sequence match */
  126551. if( pScan->zCollName && (pTerm->eOperator & WO_ISNULL)==0 ){
  126552. CollSeq *pColl;
  126553. Parse *pParse = pWC->pWInfo->pParse;
  126554. pX = pTerm->pExpr;
  126555. if( !sqlite3IndexAffinityOk(pX, pScan->idxaff) ){
  126556. continue;
  126557. }
  126558. assert(pX->pLeft);
  126559. pColl = sqlite3BinaryCompareCollSeq(pParse,
  126560. pX->pLeft, pX->pRight);
  126561. if( pColl==0 ) pColl = pParse->db->pDfltColl;
  126562. if( sqlite3StrICmp(pColl->zName, pScan->zCollName) ){
  126563. continue;
  126564. }
  126565. }
  126566. if( (pTerm->eOperator & (WO_EQ|WO_IS))!=0
  126567. && (pX = pTerm->pExpr->pRight)->op==TK_COLUMN
  126568. && pX->iTable==pScan->aiCur[0]
  126569. && pX->iColumn==pScan->aiColumn[0]
  126570. ){
  126571. testcase( pTerm->eOperator & WO_IS );
  126572. continue;
  126573. }
  126574. pScan->pWC = pWC;
  126575. pScan->k = k+1;
  126576. return pTerm;
  126577. }
  126578. }
  126579. }
  126580. pWC = pWC->pOuter;
  126581. k = 0;
  126582. }while( pWC!=0 );
  126583. if( pScan->iEquiv>=pScan->nEquiv ) break;
  126584. pWC = pScan->pOrigWC;
  126585. k = 0;
  126586. pScan->iEquiv++;
  126587. }
  126588. return 0;
  126589. }
  126590. /*
  126591. ** Initialize a WHERE clause scanner object. Return a pointer to the
  126592. ** first match. Return NULL if there are no matches.
  126593. **
  126594. ** The scanner will be searching the WHERE clause pWC. It will look
  126595. ** for terms of the form "X <op> <expr>" where X is column iColumn of table
  126596. ** iCur. Or if pIdx!=0 then X is column iColumn of index pIdx. pIdx
  126597. ** must be one of the indexes of table iCur.
  126598. **
  126599. ** The <op> must be one of the operators described by opMask.
  126600. **
  126601. ** If the search is for X and the WHERE clause contains terms of the
  126602. ** form X=Y then this routine might also return terms of the form
  126603. ** "Y <op> <expr>". The number of levels of transitivity is limited,
  126604. ** but is enough to handle most commonly occurring SQL statements.
  126605. **
  126606. ** If X is not the INTEGER PRIMARY KEY then X must be compatible with
  126607. ** index pIdx.
  126608. */
  126609. static WhereTerm *whereScanInit(
  126610. WhereScan *pScan, /* The WhereScan object being initialized */
  126611. WhereClause *pWC, /* The WHERE clause to be scanned */
  126612. int iCur, /* Cursor to scan for */
  126613. int iColumn, /* Column to scan for */
  126614. u32 opMask, /* Operator(s) to scan for */
  126615. Index *pIdx /* Must be compatible with this index */
  126616. ){
  126617. pScan->pOrigWC = pWC;
  126618. pScan->pWC = pWC;
  126619. pScan->pIdxExpr = 0;
  126620. pScan->idxaff = 0;
  126621. pScan->zCollName = 0;
  126622. if( pIdx ){
  126623. int j = iColumn;
  126624. iColumn = pIdx->aiColumn[j];
  126625. if( iColumn==XN_EXPR ){
  126626. pScan->pIdxExpr = pIdx->aColExpr->a[j].pExpr;
  126627. pScan->zCollName = pIdx->azColl[j];
  126628. }else if( iColumn==pIdx->pTable->iPKey ){
  126629. iColumn = XN_ROWID;
  126630. }else if( iColumn>=0 ){
  126631. pScan->idxaff = pIdx->pTable->aCol[iColumn].affinity;
  126632. pScan->zCollName = pIdx->azColl[j];
  126633. }
  126634. }else if( iColumn==XN_EXPR ){
  126635. return 0;
  126636. }
  126637. pScan->opMask = opMask;
  126638. pScan->k = 0;
  126639. pScan->aiCur[0] = iCur;
  126640. pScan->aiColumn[0] = iColumn;
  126641. pScan->nEquiv = 1;
  126642. pScan->iEquiv = 1;
  126643. return whereScanNext(pScan);
  126644. }
  126645. /*
  126646. ** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
  126647. ** where X is a reference to the iColumn of table iCur or of index pIdx
  126648. ** if pIdx!=0 and <op> is one of the WO_xx operator codes specified by
  126649. ** the op parameter. Return a pointer to the term. Return 0 if not found.
  126650. **
  126651. ** If pIdx!=0 then it must be one of the indexes of table iCur.
  126652. ** Search for terms matching the iColumn-th column of pIdx
  126653. ** rather than the iColumn-th column of table iCur.
  126654. **
  126655. ** The term returned might by Y=<expr> if there is another constraint in
  126656. ** the WHERE clause that specifies that X=Y. Any such constraints will be
  126657. ** identified by the WO_EQUIV bit in the pTerm->eOperator field. The
  126658. ** aiCur[]/iaColumn[] arrays hold X and all its equivalents. There are 11
  126659. ** slots in aiCur[]/aiColumn[] so that means we can look for X plus up to 10
  126660. ** other equivalent values. Hence a search for X will return <expr> if X=A1
  126661. ** and A1=A2 and A2=A3 and ... and A9=A10 and A10=<expr>.
  126662. **
  126663. ** If there are multiple terms in the WHERE clause of the form "X <op> <expr>"
  126664. ** then try for the one with no dependencies on <expr> - in other words where
  126665. ** <expr> is a constant expression of some kind. Only return entries of
  126666. ** the form "X <op> Y" where Y is a column in another table if no terms of
  126667. ** the form "X <op> <const-expr>" exist. If no terms with a constant RHS
  126668. ** exist, try to return a term that does not use WO_EQUIV.
  126669. */
  126670. SQLITE_PRIVATE WhereTerm *sqlite3WhereFindTerm(
  126671. WhereClause *pWC, /* The WHERE clause to be searched */
  126672. int iCur, /* Cursor number of LHS */
  126673. int iColumn, /* Column number of LHS */
  126674. Bitmask notReady, /* RHS must not overlap with this mask */
  126675. u32 op, /* Mask of WO_xx values describing operator */
  126676. Index *pIdx /* Must be compatible with this index, if not NULL */
  126677. ){
  126678. WhereTerm *pResult = 0;
  126679. WhereTerm *p;
  126680. WhereScan scan;
  126681. p = whereScanInit(&scan, pWC, iCur, iColumn, op, pIdx);
  126682. op &= WO_EQ|WO_IS;
  126683. while( p ){
  126684. if( (p->prereqRight & notReady)==0 ){
  126685. if( p->prereqRight==0 && (p->eOperator&op)!=0 ){
  126686. testcase( p->eOperator & WO_IS );
  126687. return p;
  126688. }
  126689. if( pResult==0 ) pResult = p;
  126690. }
  126691. p = whereScanNext(&scan);
  126692. }
  126693. return pResult;
  126694. }
  126695. /*
  126696. ** This function searches pList for an entry that matches the iCol-th column
  126697. ** of index pIdx.
  126698. **
  126699. ** If such an expression is found, its index in pList->a[] is returned. If
  126700. ** no expression is found, -1 is returned.
  126701. */
  126702. static int findIndexCol(
  126703. Parse *pParse, /* Parse context */
  126704. ExprList *pList, /* Expression list to search */
  126705. int iBase, /* Cursor for table associated with pIdx */
  126706. Index *pIdx, /* Index to match column of */
  126707. int iCol /* Column of index to match */
  126708. ){
  126709. int i;
  126710. const char *zColl = pIdx->azColl[iCol];
  126711. for(i=0; i<pList->nExpr; i++){
  126712. Expr *p = sqlite3ExprSkipCollate(pList->a[i].pExpr);
  126713. if( p->op==TK_COLUMN
  126714. && p->iColumn==pIdx->aiColumn[iCol]
  126715. && p->iTable==iBase
  126716. ){
  126717. CollSeq *pColl = sqlite3ExprNNCollSeq(pParse, pList->a[i].pExpr);
  126718. if( 0==sqlite3StrICmp(pColl->zName, zColl) ){
  126719. return i;
  126720. }
  126721. }
  126722. }
  126723. return -1;
  126724. }
  126725. /*
  126726. ** Return TRUE if the iCol-th column of index pIdx is NOT NULL
  126727. */
  126728. static int indexColumnNotNull(Index *pIdx, int iCol){
  126729. int j;
  126730. assert( pIdx!=0 );
  126731. assert( iCol>=0 && iCol<pIdx->nColumn );
  126732. j = pIdx->aiColumn[iCol];
  126733. if( j>=0 ){
  126734. return pIdx->pTable->aCol[j].notNull;
  126735. }else if( j==(-1) ){
  126736. return 1;
  126737. }else{
  126738. assert( j==(-2) );
  126739. return 0; /* Assume an indexed expression can always yield a NULL */
  126740. }
  126741. }
  126742. /*
  126743. ** Return true if the DISTINCT expression-list passed as the third argument
  126744. ** is redundant.
  126745. **
  126746. ** A DISTINCT list is redundant if any subset of the columns in the
  126747. ** DISTINCT list are collectively unique and individually non-null.
  126748. */
  126749. static int isDistinctRedundant(
  126750. Parse *pParse, /* Parsing context */
  126751. SrcList *pTabList, /* The FROM clause */
  126752. WhereClause *pWC, /* The WHERE clause */
  126753. ExprList *pDistinct /* The result set that needs to be DISTINCT */
  126754. ){
  126755. Table *pTab;
  126756. Index *pIdx;
  126757. int i;
  126758. int iBase;
  126759. /* If there is more than one table or sub-select in the FROM clause of
  126760. ** this query, then it will not be possible to show that the DISTINCT
  126761. ** clause is redundant. */
  126762. if( pTabList->nSrc!=1 ) return 0;
  126763. iBase = pTabList->a[0].iCursor;
  126764. pTab = pTabList->a[0].pTab;
  126765. /* If any of the expressions is an IPK column on table iBase, then return
  126766. ** true. Note: The (p->iTable==iBase) part of this test may be false if the
  126767. ** current SELECT is a correlated sub-query.
  126768. */
  126769. for(i=0; i<pDistinct->nExpr; i++){
  126770. Expr *p = sqlite3ExprSkipCollate(pDistinct->a[i].pExpr);
  126771. if( p->op==TK_COLUMN && p->iTable==iBase && p->iColumn<0 ) return 1;
  126772. }
  126773. /* Loop through all indices on the table, checking each to see if it makes
  126774. ** the DISTINCT qualifier redundant. It does so if:
  126775. **
  126776. ** 1. The index is itself UNIQUE, and
  126777. **
  126778. ** 2. All of the columns in the index are either part of the pDistinct
  126779. ** list, or else the WHERE clause contains a term of the form "col=X",
  126780. ** where X is a constant value. The collation sequences of the
  126781. ** comparison and select-list expressions must match those of the index.
  126782. **
  126783. ** 3. All of those index columns for which the WHERE clause does not
  126784. ** contain a "col=X" term are subject to a NOT NULL constraint.
  126785. */
  126786. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  126787. if( !IsUniqueIndex(pIdx) ) continue;
  126788. for(i=0; i<pIdx->nKeyCol; i++){
  126789. if( 0==sqlite3WhereFindTerm(pWC, iBase, i, ~(Bitmask)0, WO_EQ, pIdx) ){
  126790. if( findIndexCol(pParse, pDistinct, iBase, pIdx, i)<0 ) break;
  126791. if( indexColumnNotNull(pIdx, i)==0 ) break;
  126792. }
  126793. }
  126794. if( i==pIdx->nKeyCol ){
  126795. /* This index implies that the DISTINCT qualifier is redundant. */
  126796. return 1;
  126797. }
  126798. }
  126799. return 0;
  126800. }
  126801. /*
  126802. ** Estimate the logarithm of the input value to base 2.
  126803. */
  126804. static LogEst estLog(LogEst N){
  126805. return N<=10 ? 0 : sqlite3LogEst(N) - 33;
  126806. }
  126807. /*
  126808. ** Convert OP_Column opcodes to OP_Copy in previously generated code.
  126809. **
  126810. ** This routine runs over generated VDBE code and translates OP_Column
  126811. ** opcodes into OP_Copy when the table is being accessed via co-routine
  126812. ** instead of via table lookup.
  126813. **
  126814. ** If the bIncrRowid parameter is 0, then any OP_Rowid instructions on
  126815. ** cursor iTabCur are transformed into OP_Null. Or, if bIncrRowid is non-zero,
  126816. ** then each OP_Rowid is transformed into an instruction to increment the
  126817. ** value stored in its output register.
  126818. */
  126819. static void translateColumnToCopy(
  126820. Parse *pParse, /* Parsing context */
  126821. int iStart, /* Translate from this opcode to the end */
  126822. int iTabCur, /* OP_Column/OP_Rowid references to this table */
  126823. int iRegister, /* The first column is in this register */
  126824. int bIncrRowid /* If non-zero, transform OP_rowid to OP_AddImm(1) */
  126825. ){
  126826. Vdbe *v = pParse->pVdbe;
  126827. VdbeOp *pOp = sqlite3VdbeGetOp(v, iStart);
  126828. int iEnd = sqlite3VdbeCurrentAddr(v);
  126829. if( pParse->db->mallocFailed ) return;
  126830. for(; iStart<iEnd; iStart++, pOp++){
  126831. if( pOp->p1!=iTabCur ) continue;
  126832. if( pOp->opcode==OP_Column ){
  126833. pOp->opcode = OP_Copy;
  126834. pOp->p1 = pOp->p2 + iRegister;
  126835. pOp->p2 = pOp->p3;
  126836. pOp->p3 = 0;
  126837. }else if( pOp->opcode==OP_Rowid ){
  126838. if( bIncrRowid ){
  126839. /* Increment the value stored in the P2 operand of the OP_Rowid. */
  126840. pOp->opcode = OP_AddImm;
  126841. pOp->p1 = pOp->p2;
  126842. pOp->p2 = 1;
  126843. }else{
  126844. pOp->opcode = OP_Null;
  126845. pOp->p1 = 0;
  126846. pOp->p3 = 0;
  126847. }
  126848. }
  126849. }
  126850. }
  126851. /*
  126852. ** Two routines for printing the content of an sqlite3_index_info
  126853. ** structure. Used for testing and debugging only. If neither
  126854. ** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
  126855. ** are no-ops.
  126856. */
  126857. #if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(WHERETRACE_ENABLED)
  126858. static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
  126859. int i;
  126860. if( !sqlite3WhereTrace ) return;
  126861. for(i=0; i<p->nConstraint; i++){
  126862. sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
  126863. i,
  126864. p->aConstraint[i].iColumn,
  126865. p->aConstraint[i].iTermOffset,
  126866. p->aConstraint[i].op,
  126867. p->aConstraint[i].usable);
  126868. }
  126869. for(i=0; i<p->nOrderBy; i++){
  126870. sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
  126871. i,
  126872. p->aOrderBy[i].iColumn,
  126873. p->aOrderBy[i].desc);
  126874. }
  126875. }
  126876. static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
  126877. int i;
  126878. if( !sqlite3WhereTrace ) return;
  126879. for(i=0; i<p->nConstraint; i++){
  126880. sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
  126881. i,
  126882. p->aConstraintUsage[i].argvIndex,
  126883. p->aConstraintUsage[i].omit);
  126884. }
  126885. sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
  126886. sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
  126887. sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
  126888. sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
  126889. sqlite3DebugPrintf(" estimatedRows=%lld\n", p->estimatedRows);
  126890. }
  126891. #else
  126892. #define TRACE_IDX_INPUTS(A)
  126893. #define TRACE_IDX_OUTPUTS(A)
  126894. #endif
  126895. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  126896. /*
  126897. ** Return TRUE if the WHERE clause term pTerm is of a form where it
  126898. ** could be used with an index to access pSrc, assuming an appropriate
  126899. ** index existed.
  126900. */
  126901. static int termCanDriveIndex(
  126902. WhereTerm *pTerm, /* WHERE clause term to check */
  126903. struct SrcList_item *pSrc, /* Table we are trying to access */
  126904. Bitmask notReady /* Tables in outer loops of the join */
  126905. ){
  126906. char aff;
  126907. if( pTerm->leftCursor!=pSrc->iCursor ) return 0;
  126908. if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) return 0;
  126909. if( (pSrc->fg.jointype & JT_LEFT)
  126910. && !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
  126911. && (pTerm->eOperator & WO_IS)
  126912. ){
  126913. /* Cannot use an IS term from the WHERE clause as an index driver for
  126914. ** the RHS of a LEFT JOIN. Such a term can only be used if it is from
  126915. ** the ON clause. */
  126916. return 0;
  126917. }
  126918. if( (pTerm->prereqRight & notReady)!=0 ) return 0;
  126919. if( pTerm->u.leftColumn<0 ) return 0;
  126920. aff = pSrc->pTab->aCol[pTerm->u.leftColumn].affinity;
  126921. if( !sqlite3IndexAffinityOk(pTerm->pExpr, aff) ) return 0;
  126922. testcase( pTerm->pExpr->op==TK_IS );
  126923. return 1;
  126924. }
  126925. #endif
  126926. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  126927. /*
  126928. ** Generate code to construct the Index object for an automatic index
  126929. ** and to set up the WhereLevel object pLevel so that the code generator
  126930. ** makes use of the automatic index.
  126931. */
  126932. static void constructAutomaticIndex(
  126933. Parse *pParse, /* The parsing context */
  126934. WhereClause *pWC, /* The WHERE clause */
  126935. struct SrcList_item *pSrc, /* The FROM clause term to get the next index */
  126936. Bitmask notReady, /* Mask of cursors that are not available */
  126937. WhereLevel *pLevel /* Write new index here */
  126938. ){
  126939. int nKeyCol; /* Number of columns in the constructed index */
  126940. WhereTerm *pTerm; /* A single term of the WHERE clause */
  126941. WhereTerm *pWCEnd; /* End of pWC->a[] */
  126942. Index *pIdx; /* Object describing the transient index */
  126943. Vdbe *v; /* Prepared statement under construction */
  126944. int addrInit; /* Address of the initialization bypass jump */
  126945. Table *pTable; /* The table being indexed */
  126946. int addrTop; /* Top of the index fill loop */
  126947. int regRecord; /* Register holding an index record */
  126948. int n; /* Column counter */
  126949. int i; /* Loop counter */
  126950. int mxBitCol; /* Maximum column in pSrc->colUsed */
  126951. CollSeq *pColl; /* Collating sequence to on a column */
  126952. WhereLoop *pLoop; /* The Loop object */
  126953. char *zNotUsed; /* Extra space on the end of pIdx */
  126954. Bitmask idxCols; /* Bitmap of columns used for indexing */
  126955. Bitmask extraCols; /* Bitmap of additional columns */
  126956. u8 sentWarning = 0; /* True if a warnning has been issued */
  126957. Expr *pPartial = 0; /* Partial Index Expression */
  126958. int iContinue = 0; /* Jump here to skip excluded rows */
  126959. struct SrcList_item *pTabItem; /* FROM clause term being indexed */
  126960. int addrCounter = 0; /* Address where integer counter is initialized */
  126961. int regBase; /* Array of registers where record is assembled */
  126962. /* Generate code to skip over the creation and initialization of the
  126963. ** transient index on 2nd and subsequent iterations of the loop. */
  126964. v = pParse->pVdbe;
  126965. assert( v!=0 );
  126966. addrInit = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
  126967. /* Count the number of columns that will be added to the index
  126968. ** and used to match WHERE clause constraints */
  126969. nKeyCol = 0;
  126970. pTable = pSrc->pTab;
  126971. pWCEnd = &pWC->a[pWC->nTerm];
  126972. pLoop = pLevel->pWLoop;
  126973. idxCols = 0;
  126974. for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
  126975. Expr *pExpr = pTerm->pExpr;
  126976. assert( !ExprHasProperty(pExpr, EP_FromJoin) /* prereq always non-zero */
  126977. || pExpr->iRightJoinTable!=pSrc->iCursor /* for the right-hand */
  126978. || pLoop->prereq!=0 ); /* table of a LEFT JOIN */
  126979. if( pLoop->prereq==0
  126980. && (pTerm->wtFlags & TERM_VIRTUAL)==0
  126981. && !ExprHasProperty(pExpr, EP_FromJoin)
  126982. && sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor) ){
  126983. pPartial = sqlite3ExprAnd(pParse->db, pPartial,
  126984. sqlite3ExprDup(pParse->db, pExpr, 0));
  126985. }
  126986. if( termCanDriveIndex(pTerm, pSrc, notReady) ){
  126987. int iCol = pTerm->u.leftColumn;
  126988. Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
  126989. testcase( iCol==BMS );
  126990. testcase( iCol==BMS-1 );
  126991. if( !sentWarning ){
  126992. sqlite3_log(SQLITE_WARNING_AUTOINDEX,
  126993. "automatic index on %s(%s)", pTable->zName,
  126994. pTable->aCol[iCol].zName);
  126995. sentWarning = 1;
  126996. }
  126997. if( (idxCols & cMask)==0 ){
  126998. if( whereLoopResize(pParse->db, pLoop, nKeyCol+1) ){
  126999. goto end_auto_index_create;
  127000. }
  127001. pLoop->aLTerm[nKeyCol++] = pTerm;
  127002. idxCols |= cMask;
  127003. }
  127004. }
  127005. }
  127006. assert( nKeyCol>0 );
  127007. pLoop->u.btree.nEq = pLoop->nLTerm = nKeyCol;
  127008. pLoop->wsFlags = WHERE_COLUMN_EQ | WHERE_IDX_ONLY | WHERE_INDEXED
  127009. | WHERE_AUTO_INDEX;
  127010. /* Count the number of additional columns needed to create a
  127011. ** covering index. A "covering index" is an index that contains all
  127012. ** columns that are needed by the query. With a covering index, the
  127013. ** original table never needs to be accessed. Automatic indices must
  127014. ** be a covering index because the index will not be updated if the
  127015. ** original table changes and the index and table cannot both be used
  127016. ** if they go out of sync.
  127017. */
  127018. extraCols = pSrc->colUsed & (~idxCols | MASKBIT(BMS-1));
  127019. mxBitCol = MIN(BMS-1,pTable->nCol);
  127020. testcase( pTable->nCol==BMS-1 );
  127021. testcase( pTable->nCol==BMS-2 );
  127022. for(i=0; i<mxBitCol; i++){
  127023. if( extraCols & MASKBIT(i) ) nKeyCol++;
  127024. }
  127025. if( pSrc->colUsed & MASKBIT(BMS-1) ){
  127026. nKeyCol += pTable->nCol - BMS + 1;
  127027. }
  127028. /* Construct the Index object to describe this index */
  127029. pIdx = sqlite3AllocateIndexObject(pParse->db, nKeyCol+1, 0, &zNotUsed);
  127030. if( pIdx==0 ) goto end_auto_index_create;
  127031. pLoop->u.btree.pIndex = pIdx;
  127032. pIdx->zName = "auto-index";
  127033. pIdx->pTable = pTable;
  127034. n = 0;
  127035. idxCols = 0;
  127036. for(pTerm=pWC->a; pTerm<pWCEnd; pTerm++){
  127037. if( termCanDriveIndex(pTerm, pSrc, notReady) ){
  127038. int iCol = pTerm->u.leftColumn;
  127039. Bitmask cMask = iCol>=BMS ? MASKBIT(BMS-1) : MASKBIT(iCol);
  127040. testcase( iCol==BMS-1 );
  127041. testcase( iCol==BMS );
  127042. if( (idxCols & cMask)==0 ){
  127043. Expr *pX = pTerm->pExpr;
  127044. idxCols |= cMask;
  127045. pIdx->aiColumn[n] = pTerm->u.leftColumn;
  127046. pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
  127047. pIdx->azColl[n] = pColl ? pColl->zName : sqlite3StrBINARY;
  127048. n++;
  127049. }
  127050. }
  127051. }
  127052. assert( (u32)n==pLoop->u.btree.nEq );
  127053. /* Add additional columns needed to make the automatic index into
  127054. ** a covering index */
  127055. for(i=0; i<mxBitCol; i++){
  127056. if( extraCols & MASKBIT(i) ){
  127057. pIdx->aiColumn[n] = i;
  127058. pIdx->azColl[n] = sqlite3StrBINARY;
  127059. n++;
  127060. }
  127061. }
  127062. if( pSrc->colUsed & MASKBIT(BMS-1) ){
  127063. for(i=BMS-1; i<pTable->nCol; i++){
  127064. pIdx->aiColumn[n] = i;
  127065. pIdx->azColl[n] = sqlite3StrBINARY;
  127066. n++;
  127067. }
  127068. }
  127069. assert( n==nKeyCol );
  127070. pIdx->aiColumn[n] = XN_ROWID;
  127071. pIdx->azColl[n] = sqlite3StrBINARY;
  127072. /* Create the automatic index */
  127073. assert( pLevel->iIdxCur>=0 );
  127074. pLevel->iIdxCur = pParse->nTab++;
  127075. sqlite3VdbeAddOp2(v, OP_OpenAutoindex, pLevel->iIdxCur, nKeyCol+1);
  127076. sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
  127077. VdbeComment((v, "for %s", pTable->zName));
  127078. /* Fill the automatic index with content */
  127079. sqlite3ExprCachePush(pParse);
  127080. pTabItem = &pWC->pWInfo->pTabList->a[pLevel->iFrom];
  127081. if( pTabItem->fg.viaCoroutine ){
  127082. int regYield = pTabItem->regReturn;
  127083. addrCounter = sqlite3VdbeAddOp2(v, OP_Integer, 0, 0);
  127084. sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
  127085. addrTop = sqlite3VdbeAddOp1(v, OP_Yield, regYield);
  127086. VdbeCoverage(v);
  127087. VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
  127088. }else{
  127089. addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, pLevel->iTabCur); VdbeCoverage(v);
  127090. }
  127091. if( pPartial ){
  127092. iContinue = sqlite3VdbeMakeLabel(v);
  127093. sqlite3ExprIfFalse(pParse, pPartial, iContinue, SQLITE_JUMPIFNULL);
  127094. pLoop->wsFlags |= WHERE_PARTIALIDX;
  127095. }
  127096. regRecord = sqlite3GetTempReg(pParse);
  127097. regBase = sqlite3GenerateIndexKey(
  127098. pParse, pIdx, pLevel->iTabCur, regRecord, 0, 0, 0, 0
  127099. );
  127100. sqlite3VdbeAddOp2(v, OP_IdxInsert, pLevel->iIdxCur, regRecord);
  127101. sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
  127102. if( pPartial ) sqlite3VdbeResolveLabel(v, iContinue);
  127103. if( pTabItem->fg.viaCoroutine ){
  127104. sqlite3VdbeChangeP2(v, addrCounter, regBase+n);
  127105. testcase( pParse->db->mallocFailed );
  127106. translateColumnToCopy(pParse, addrTop, pLevel->iTabCur,
  127107. pTabItem->regResult, 1);
  127108. sqlite3VdbeGoto(v, addrTop);
  127109. pTabItem->fg.viaCoroutine = 0;
  127110. }else{
  127111. sqlite3VdbeAddOp2(v, OP_Next, pLevel->iTabCur, addrTop+1); VdbeCoverage(v);
  127112. }
  127113. sqlite3VdbeChangeP5(v, SQLITE_STMTSTATUS_AUTOINDEX);
  127114. sqlite3VdbeJumpHere(v, addrTop);
  127115. sqlite3ReleaseTempReg(pParse, regRecord);
  127116. sqlite3ExprCachePop(pParse);
  127117. /* Jump here when skipping the initialization */
  127118. sqlite3VdbeJumpHere(v, addrInit);
  127119. end_auto_index_create:
  127120. sqlite3ExprDelete(pParse->db, pPartial);
  127121. }
  127122. #endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
  127123. #ifndef SQLITE_OMIT_VIRTUALTABLE
  127124. /*
  127125. ** Allocate and populate an sqlite3_index_info structure. It is the
  127126. ** responsibility of the caller to eventually release the structure
  127127. ** by passing the pointer returned by this function to sqlite3_free().
  127128. */
  127129. static sqlite3_index_info *allocateIndexInfo(
  127130. Parse *pParse, /* The parsing context */
  127131. WhereClause *pWC, /* The WHERE clause being analyzed */
  127132. Bitmask mUnusable, /* Ignore terms with these prereqs */
  127133. struct SrcList_item *pSrc, /* The FROM clause term that is the vtab */
  127134. ExprList *pOrderBy, /* The ORDER BY clause */
  127135. u16 *pmNoOmit /* Mask of terms not to omit */
  127136. ){
  127137. int i, j;
  127138. int nTerm;
  127139. struct sqlite3_index_constraint *pIdxCons;
  127140. struct sqlite3_index_orderby *pIdxOrderBy;
  127141. struct sqlite3_index_constraint_usage *pUsage;
  127142. struct HiddenIndexInfo *pHidden;
  127143. WhereTerm *pTerm;
  127144. int nOrderBy;
  127145. sqlite3_index_info *pIdxInfo;
  127146. u16 mNoOmit = 0;
  127147. /* Count the number of possible WHERE clause constraints referring
  127148. ** to this virtual table */
  127149. for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
  127150. if( pTerm->leftCursor != pSrc->iCursor ) continue;
  127151. if( pTerm->prereqRight & mUnusable ) continue;
  127152. assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
  127153. testcase( pTerm->eOperator & WO_IN );
  127154. testcase( pTerm->eOperator & WO_ISNULL );
  127155. testcase( pTerm->eOperator & WO_IS );
  127156. testcase( pTerm->eOperator & WO_ALL );
  127157. if( (pTerm->eOperator & ~(WO_EQUIV))==0 ) continue;
  127158. if( pTerm->wtFlags & TERM_VNULL ) continue;
  127159. assert( pTerm->u.leftColumn>=(-1) );
  127160. nTerm++;
  127161. }
  127162. /* If the ORDER BY clause contains only columns in the current
  127163. ** virtual table then allocate space for the aOrderBy part of
  127164. ** the sqlite3_index_info structure.
  127165. */
  127166. nOrderBy = 0;
  127167. if( pOrderBy ){
  127168. int n = pOrderBy->nExpr;
  127169. for(i=0; i<n; i++){
  127170. Expr *pExpr = pOrderBy->a[i].pExpr;
  127171. if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
  127172. }
  127173. if( i==n){
  127174. nOrderBy = n;
  127175. }
  127176. }
  127177. /* Allocate the sqlite3_index_info structure
  127178. */
  127179. pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
  127180. + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
  127181. + sizeof(*pIdxOrderBy)*nOrderBy + sizeof(*pHidden) );
  127182. if( pIdxInfo==0 ){
  127183. sqlite3ErrorMsg(pParse, "out of memory");
  127184. return 0;
  127185. }
  127186. /* Initialize the structure. The sqlite3_index_info structure contains
  127187. ** many fields that are declared "const" to prevent xBestIndex from
  127188. ** changing them. We have to do some funky casting in order to
  127189. ** initialize those fields.
  127190. */
  127191. pHidden = (struct HiddenIndexInfo*)&pIdxInfo[1];
  127192. pIdxCons = (struct sqlite3_index_constraint*)&pHidden[1];
  127193. pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
  127194. pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
  127195. *(int*)&pIdxInfo->nConstraint = nTerm;
  127196. *(int*)&pIdxInfo->nOrderBy = nOrderBy;
  127197. *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
  127198. *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
  127199. *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
  127200. pUsage;
  127201. pHidden->pWC = pWC;
  127202. pHidden->pParse = pParse;
  127203. for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
  127204. u16 op;
  127205. if( pTerm->leftCursor != pSrc->iCursor ) continue;
  127206. if( pTerm->prereqRight & mUnusable ) continue;
  127207. assert( IsPowerOfTwo(pTerm->eOperator & ~WO_EQUIV) );
  127208. testcase( pTerm->eOperator & WO_IN );
  127209. testcase( pTerm->eOperator & WO_IS );
  127210. testcase( pTerm->eOperator & WO_ISNULL );
  127211. testcase( pTerm->eOperator & WO_ALL );
  127212. if( (pTerm->eOperator & ~(WO_EQUIV))==0 ) continue;
  127213. if( pTerm->wtFlags & TERM_VNULL ) continue;
  127214. assert( pTerm->u.leftColumn>=(-1) );
  127215. pIdxCons[j].iColumn = pTerm->u.leftColumn;
  127216. pIdxCons[j].iTermOffset = i;
  127217. op = pTerm->eOperator & WO_ALL;
  127218. if( op==WO_IN ) op = WO_EQ;
  127219. if( op==WO_AUX ){
  127220. pIdxCons[j].op = pTerm->eMatchOp;
  127221. }else if( op & (WO_ISNULL|WO_IS) ){
  127222. if( op==WO_ISNULL ){
  127223. pIdxCons[j].op = SQLITE_INDEX_CONSTRAINT_ISNULL;
  127224. }else{
  127225. pIdxCons[j].op = SQLITE_INDEX_CONSTRAINT_IS;
  127226. }
  127227. }else{
  127228. pIdxCons[j].op = (u8)op;
  127229. /* The direct assignment in the previous line is possible only because
  127230. ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
  127231. ** following asserts verify this fact. */
  127232. assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
  127233. assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
  127234. assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
  127235. assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
  127236. assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
  127237. assert( pTerm->eOperator&(WO_IN|WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_AUX) );
  127238. if( op & (WO_LT|WO_LE|WO_GT|WO_GE)
  127239. && sqlite3ExprIsVector(pTerm->pExpr->pRight)
  127240. ){
  127241. if( i<16 ) mNoOmit |= (1 << i);
  127242. if( op==WO_LT ) pIdxCons[j].op = WO_LE;
  127243. if( op==WO_GT ) pIdxCons[j].op = WO_GE;
  127244. }
  127245. }
  127246. j++;
  127247. }
  127248. for(i=0; i<nOrderBy; i++){
  127249. Expr *pExpr = pOrderBy->a[i].pExpr;
  127250. pIdxOrderBy[i].iColumn = pExpr->iColumn;
  127251. pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
  127252. }
  127253. *pmNoOmit = mNoOmit;
  127254. return pIdxInfo;
  127255. }
  127256. /*
  127257. ** The table object reference passed as the second argument to this function
  127258. ** must represent a virtual table. This function invokes the xBestIndex()
  127259. ** method of the virtual table with the sqlite3_index_info object that
  127260. ** comes in as the 3rd argument to this function.
  127261. **
  127262. ** If an error occurs, pParse is populated with an error message and a
  127263. ** non-zero value is returned. Otherwise, 0 is returned and the output
  127264. ** part of the sqlite3_index_info structure is left populated.
  127265. **
  127266. ** Whether or not an error is returned, it is the responsibility of the
  127267. ** caller to eventually free p->idxStr if p->needToFreeIdxStr indicates
  127268. ** that this is required.
  127269. */
  127270. static int vtabBestIndex(Parse *pParse, Table *pTab, sqlite3_index_info *p){
  127271. sqlite3_vtab *pVtab = sqlite3GetVTable(pParse->db, pTab)->pVtab;
  127272. int rc;
  127273. TRACE_IDX_INPUTS(p);
  127274. rc = pVtab->pModule->xBestIndex(pVtab, p);
  127275. TRACE_IDX_OUTPUTS(p);
  127276. if( rc!=SQLITE_OK ){
  127277. if( rc==SQLITE_NOMEM ){
  127278. sqlite3OomFault(pParse->db);
  127279. }else if( !pVtab->zErrMsg ){
  127280. sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
  127281. }else{
  127282. sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
  127283. }
  127284. }
  127285. sqlite3_free(pVtab->zErrMsg);
  127286. pVtab->zErrMsg = 0;
  127287. #if 0
  127288. /* This error is now caught by the caller.
  127289. ** Search for "xBestIndex malfunction" below */
  127290. for(i=0; i<p->nConstraint; i++){
  127291. if( !p->aConstraint[i].usable && p->aConstraintUsage[i].argvIndex>0 ){
  127292. sqlite3ErrorMsg(pParse,
  127293. "table %s: xBestIndex returned an invalid plan", pTab->zName);
  127294. }
  127295. }
  127296. #endif
  127297. return pParse->nErr;
  127298. }
  127299. #endif /* !defined(SQLITE_OMIT_VIRTUALTABLE) */
  127300. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  127301. /*
  127302. ** Estimate the location of a particular key among all keys in an
  127303. ** index. Store the results in aStat as follows:
  127304. **
  127305. ** aStat[0] Est. number of rows less than pRec
  127306. ** aStat[1] Est. number of rows equal to pRec
  127307. **
  127308. ** Return the index of the sample that is the smallest sample that
  127309. ** is greater than or equal to pRec. Note that this index is not an index
  127310. ** into the aSample[] array - it is an index into a virtual set of samples
  127311. ** based on the contents of aSample[] and the number of fields in record
  127312. ** pRec.
  127313. */
  127314. static int whereKeyStats(
  127315. Parse *pParse, /* Database connection */
  127316. Index *pIdx, /* Index to consider domain of */
  127317. UnpackedRecord *pRec, /* Vector of values to consider */
  127318. int roundUp, /* Round up if true. Round down if false */
  127319. tRowcnt *aStat /* OUT: stats written here */
  127320. ){
  127321. IndexSample *aSample = pIdx->aSample;
  127322. int iCol; /* Index of required stats in anEq[] etc. */
  127323. int i; /* Index of first sample >= pRec */
  127324. int iSample; /* Smallest sample larger than or equal to pRec */
  127325. int iMin = 0; /* Smallest sample not yet tested */
  127326. int iTest; /* Next sample to test */
  127327. int res; /* Result of comparison operation */
  127328. int nField; /* Number of fields in pRec */
  127329. tRowcnt iLower = 0; /* anLt[] + anEq[] of largest sample pRec is > */
  127330. #ifndef SQLITE_DEBUG
  127331. UNUSED_PARAMETER( pParse );
  127332. #endif
  127333. assert( pRec!=0 );
  127334. assert( pIdx->nSample>0 );
  127335. assert( pRec->nField>0 && pRec->nField<=pIdx->nSampleCol );
  127336. /* Do a binary search to find the first sample greater than or equal
  127337. ** to pRec. If pRec contains a single field, the set of samples to search
  127338. ** is simply the aSample[] array. If the samples in aSample[] contain more
  127339. ** than one fields, all fields following the first are ignored.
  127340. **
  127341. ** If pRec contains N fields, where N is more than one, then as well as the
  127342. ** samples in aSample[] (truncated to N fields), the search also has to
  127343. ** consider prefixes of those samples. For example, if the set of samples
  127344. ** in aSample is:
  127345. **
  127346. ** aSample[0] = (a, 5)
  127347. ** aSample[1] = (a, 10)
  127348. ** aSample[2] = (b, 5)
  127349. ** aSample[3] = (c, 100)
  127350. ** aSample[4] = (c, 105)
  127351. **
  127352. ** Then the search space should ideally be the samples above and the
  127353. ** unique prefixes [a], [b] and [c]. But since that is hard to organize,
  127354. ** the code actually searches this set:
  127355. **
  127356. ** 0: (a)
  127357. ** 1: (a, 5)
  127358. ** 2: (a, 10)
  127359. ** 3: (a, 10)
  127360. ** 4: (b)
  127361. ** 5: (b, 5)
  127362. ** 6: (c)
  127363. ** 7: (c, 100)
  127364. ** 8: (c, 105)
  127365. ** 9: (c, 105)
  127366. **
  127367. ** For each sample in the aSample[] array, N samples are present in the
  127368. ** effective sample array. In the above, samples 0 and 1 are based on
  127369. ** sample aSample[0]. Samples 2 and 3 on aSample[1] etc.
  127370. **
  127371. ** Often, sample i of each block of N effective samples has (i+1) fields.
  127372. ** Except, each sample may be extended to ensure that it is greater than or
  127373. ** equal to the previous sample in the array. For example, in the above,
  127374. ** sample 2 is the first sample of a block of N samples, so at first it
  127375. ** appears that it should be 1 field in size. However, that would make it
  127376. ** smaller than sample 1, so the binary search would not work. As a result,
  127377. ** it is extended to two fields. The duplicates that this creates do not
  127378. ** cause any problems.
  127379. */
  127380. nField = pRec->nField;
  127381. iCol = 0;
  127382. iSample = pIdx->nSample * nField;
  127383. do{
  127384. int iSamp; /* Index in aSample[] of test sample */
  127385. int n; /* Number of fields in test sample */
  127386. iTest = (iMin+iSample)/2;
  127387. iSamp = iTest / nField;
  127388. if( iSamp>0 ){
  127389. /* The proposed effective sample is a prefix of sample aSample[iSamp].
  127390. ** Specifically, the shortest prefix of at least (1 + iTest%nField)
  127391. ** fields that is greater than the previous effective sample. */
  127392. for(n=(iTest % nField) + 1; n<nField; n++){
  127393. if( aSample[iSamp-1].anLt[n-1]!=aSample[iSamp].anLt[n-1] ) break;
  127394. }
  127395. }else{
  127396. n = iTest + 1;
  127397. }
  127398. pRec->nField = n;
  127399. res = sqlite3VdbeRecordCompare(aSample[iSamp].n, aSample[iSamp].p, pRec);
  127400. if( res<0 ){
  127401. iLower = aSample[iSamp].anLt[n-1] + aSample[iSamp].anEq[n-1];
  127402. iMin = iTest+1;
  127403. }else if( res==0 && n<nField ){
  127404. iLower = aSample[iSamp].anLt[n-1];
  127405. iMin = iTest+1;
  127406. res = -1;
  127407. }else{
  127408. iSample = iTest;
  127409. iCol = n-1;
  127410. }
  127411. }while( res && iMin<iSample );
  127412. i = iSample / nField;
  127413. #ifdef SQLITE_DEBUG
  127414. /* The following assert statements check that the binary search code
  127415. ** above found the right answer. This block serves no purpose other
  127416. ** than to invoke the asserts. */
  127417. if( pParse->db->mallocFailed==0 ){
  127418. if( res==0 ){
  127419. /* If (res==0) is true, then pRec must be equal to sample i. */
  127420. assert( i<pIdx->nSample );
  127421. assert( iCol==nField-1 );
  127422. pRec->nField = nField;
  127423. assert( 0==sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)
  127424. || pParse->db->mallocFailed
  127425. );
  127426. }else{
  127427. /* Unless i==pIdx->nSample, indicating that pRec is larger than
  127428. ** all samples in the aSample[] array, pRec must be smaller than the
  127429. ** (iCol+1) field prefix of sample i. */
  127430. assert( i<=pIdx->nSample && i>=0 );
  127431. pRec->nField = iCol+1;
  127432. assert( i==pIdx->nSample
  127433. || sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)>0
  127434. || pParse->db->mallocFailed );
  127435. /* if i==0 and iCol==0, then record pRec is smaller than all samples
  127436. ** in the aSample[] array. Otherwise, if (iCol>0) then pRec must
  127437. ** be greater than or equal to the (iCol) field prefix of sample i.
  127438. ** If (i>0), then pRec must also be greater than sample (i-1). */
  127439. if( iCol>0 ){
  127440. pRec->nField = iCol;
  127441. assert( sqlite3VdbeRecordCompare(aSample[i].n, aSample[i].p, pRec)<=0
  127442. || pParse->db->mallocFailed );
  127443. }
  127444. if( i>0 ){
  127445. pRec->nField = nField;
  127446. assert( sqlite3VdbeRecordCompare(aSample[i-1].n, aSample[i-1].p, pRec)<0
  127447. || pParse->db->mallocFailed );
  127448. }
  127449. }
  127450. }
  127451. #endif /* ifdef SQLITE_DEBUG */
  127452. if( res==0 ){
  127453. /* Record pRec is equal to sample i */
  127454. assert( iCol==nField-1 );
  127455. aStat[0] = aSample[i].anLt[iCol];
  127456. aStat[1] = aSample[i].anEq[iCol];
  127457. }else{
  127458. /* At this point, the (iCol+1) field prefix of aSample[i] is the first
  127459. ** sample that is greater than pRec. Or, if i==pIdx->nSample then pRec
  127460. ** is larger than all samples in the array. */
  127461. tRowcnt iUpper, iGap;
  127462. if( i>=pIdx->nSample ){
  127463. iUpper = sqlite3LogEstToInt(pIdx->aiRowLogEst[0]);
  127464. }else{
  127465. iUpper = aSample[i].anLt[iCol];
  127466. }
  127467. if( iLower>=iUpper ){
  127468. iGap = 0;
  127469. }else{
  127470. iGap = iUpper - iLower;
  127471. }
  127472. if( roundUp ){
  127473. iGap = (iGap*2)/3;
  127474. }else{
  127475. iGap = iGap/3;
  127476. }
  127477. aStat[0] = iLower + iGap;
  127478. aStat[1] = pIdx->aAvgEq[nField-1];
  127479. }
  127480. /* Restore the pRec->nField value before returning. */
  127481. pRec->nField = nField;
  127482. return i;
  127483. }
  127484. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  127485. /*
  127486. ** If it is not NULL, pTerm is a term that provides an upper or lower
  127487. ** bound on a range scan. Without considering pTerm, it is estimated
  127488. ** that the scan will visit nNew rows. This function returns the number
  127489. ** estimated to be visited after taking pTerm into account.
  127490. **
  127491. ** If the user explicitly specified a likelihood() value for this term,
  127492. ** then the return value is the likelihood multiplied by the number of
  127493. ** input rows. Otherwise, this function assumes that an "IS NOT NULL" term
  127494. ** has a likelihood of 0.50, and any other term a likelihood of 0.25.
  127495. */
  127496. static LogEst whereRangeAdjust(WhereTerm *pTerm, LogEst nNew){
  127497. LogEst nRet = nNew;
  127498. if( pTerm ){
  127499. if( pTerm->truthProb<=0 ){
  127500. nRet += pTerm->truthProb;
  127501. }else if( (pTerm->wtFlags & TERM_VNULL)==0 ){
  127502. nRet -= 20; assert( 20==sqlite3LogEst(4) );
  127503. }
  127504. }
  127505. return nRet;
  127506. }
  127507. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  127508. /*
  127509. ** Return the affinity for a single column of an index.
  127510. */
  127511. SQLITE_PRIVATE char sqlite3IndexColumnAffinity(sqlite3 *db, Index *pIdx, int iCol){
  127512. assert( iCol>=0 && iCol<pIdx->nColumn );
  127513. if( !pIdx->zColAff ){
  127514. if( sqlite3IndexAffinityStr(db, pIdx)==0 ) return SQLITE_AFF_BLOB;
  127515. }
  127516. return pIdx->zColAff[iCol];
  127517. }
  127518. #endif
  127519. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  127520. /*
  127521. ** This function is called to estimate the number of rows visited by a
  127522. ** range-scan on a skip-scan index. For example:
  127523. **
  127524. ** CREATE INDEX i1 ON t1(a, b, c);
  127525. ** SELECT * FROM t1 WHERE a=? AND c BETWEEN ? AND ?;
  127526. **
  127527. ** Value pLoop->nOut is currently set to the estimated number of rows
  127528. ** visited for scanning (a=? AND b=?). This function reduces that estimate
  127529. ** by some factor to account for the (c BETWEEN ? AND ?) expression based
  127530. ** on the stat4 data for the index. this scan will be peformed multiple
  127531. ** times (once for each (a,b) combination that matches a=?) is dealt with
  127532. ** by the caller.
  127533. **
  127534. ** It does this by scanning through all stat4 samples, comparing values
  127535. ** extracted from pLower and pUpper with the corresponding column in each
  127536. ** sample. If L and U are the number of samples found to be less than or
  127537. ** equal to the values extracted from pLower and pUpper respectively, and
  127538. ** N is the total number of samples, the pLoop->nOut value is adjusted
  127539. ** as follows:
  127540. **
  127541. ** nOut = nOut * ( min(U - L, 1) / N )
  127542. **
  127543. ** If pLower is NULL, or a value cannot be extracted from the term, L is
  127544. ** set to zero. If pUpper is NULL, or a value cannot be extracted from it,
  127545. ** U is set to N.
  127546. **
  127547. ** Normally, this function sets *pbDone to 1 before returning. However,
  127548. ** if no value can be extracted from either pLower or pUpper (and so the
  127549. ** estimate of the number of rows delivered remains unchanged), *pbDone
  127550. ** is left as is.
  127551. **
  127552. ** If an error occurs, an SQLite error code is returned. Otherwise,
  127553. ** SQLITE_OK.
  127554. */
  127555. static int whereRangeSkipScanEst(
  127556. Parse *pParse, /* Parsing & code generating context */
  127557. WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
  127558. WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
  127559. WhereLoop *pLoop, /* Update the .nOut value of this loop */
  127560. int *pbDone /* Set to true if at least one expr. value extracted */
  127561. ){
  127562. Index *p = pLoop->u.btree.pIndex;
  127563. int nEq = pLoop->u.btree.nEq;
  127564. sqlite3 *db = pParse->db;
  127565. int nLower = -1;
  127566. int nUpper = p->nSample+1;
  127567. int rc = SQLITE_OK;
  127568. u8 aff = sqlite3IndexColumnAffinity(db, p, nEq);
  127569. CollSeq *pColl;
  127570. sqlite3_value *p1 = 0; /* Value extracted from pLower */
  127571. sqlite3_value *p2 = 0; /* Value extracted from pUpper */
  127572. sqlite3_value *pVal = 0; /* Value extracted from record */
  127573. pColl = sqlite3LocateCollSeq(pParse, p->azColl[nEq]);
  127574. if( pLower ){
  127575. rc = sqlite3Stat4ValueFromExpr(pParse, pLower->pExpr->pRight, aff, &p1);
  127576. nLower = 0;
  127577. }
  127578. if( pUpper && rc==SQLITE_OK ){
  127579. rc = sqlite3Stat4ValueFromExpr(pParse, pUpper->pExpr->pRight, aff, &p2);
  127580. nUpper = p2 ? 0 : p->nSample;
  127581. }
  127582. if( p1 || p2 ){
  127583. int i;
  127584. int nDiff;
  127585. for(i=0; rc==SQLITE_OK && i<p->nSample; i++){
  127586. rc = sqlite3Stat4Column(db, p->aSample[i].p, p->aSample[i].n, nEq, &pVal);
  127587. if( rc==SQLITE_OK && p1 ){
  127588. int res = sqlite3MemCompare(p1, pVal, pColl);
  127589. if( res>=0 ) nLower++;
  127590. }
  127591. if( rc==SQLITE_OK && p2 ){
  127592. int res = sqlite3MemCompare(p2, pVal, pColl);
  127593. if( res>=0 ) nUpper++;
  127594. }
  127595. }
  127596. nDiff = (nUpper - nLower);
  127597. if( nDiff<=0 ) nDiff = 1;
  127598. /* If there is both an upper and lower bound specified, and the
  127599. ** comparisons indicate that they are close together, use the fallback
  127600. ** method (assume that the scan visits 1/64 of the rows) for estimating
  127601. ** the number of rows visited. Otherwise, estimate the number of rows
  127602. ** using the method described in the header comment for this function. */
  127603. if( nDiff!=1 || pUpper==0 || pLower==0 ){
  127604. int nAdjust = (sqlite3LogEst(p->nSample) - sqlite3LogEst(nDiff));
  127605. pLoop->nOut -= nAdjust;
  127606. *pbDone = 1;
  127607. WHERETRACE(0x10, ("range skip-scan regions: %u..%u adjust=%d est=%d\n",
  127608. nLower, nUpper, nAdjust*-1, pLoop->nOut));
  127609. }
  127610. }else{
  127611. assert( *pbDone==0 );
  127612. }
  127613. sqlite3ValueFree(p1);
  127614. sqlite3ValueFree(p2);
  127615. sqlite3ValueFree(pVal);
  127616. return rc;
  127617. }
  127618. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  127619. /*
  127620. ** This function is used to estimate the number of rows that will be visited
  127621. ** by scanning an index for a range of values. The range may have an upper
  127622. ** bound, a lower bound, or both. The WHERE clause terms that set the upper
  127623. ** and lower bounds are represented by pLower and pUpper respectively. For
  127624. ** example, assuming that index p is on t1(a):
  127625. **
  127626. ** ... FROM t1 WHERE a > ? AND a < ? ...
  127627. ** |_____| |_____|
  127628. ** | |
  127629. ** pLower pUpper
  127630. **
  127631. ** If either of the upper or lower bound is not present, then NULL is passed in
  127632. ** place of the corresponding WhereTerm.
  127633. **
  127634. ** The value in (pBuilder->pNew->u.btree.nEq) is the number of the index
  127635. ** column subject to the range constraint. Or, equivalently, the number of
  127636. ** equality constraints optimized by the proposed index scan. For example,
  127637. ** assuming index p is on t1(a, b), and the SQL query is:
  127638. **
  127639. ** ... FROM t1 WHERE a = ? AND b > ? AND b < ? ...
  127640. **
  127641. ** then nEq is set to 1 (as the range restricted column, b, is the second
  127642. ** left-most column of the index). Or, if the query is:
  127643. **
  127644. ** ... FROM t1 WHERE a > ? AND a < ? ...
  127645. **
  127646. ** then nEq is set to 0.
  127647. **
  127648. ** When this function is called, *pnOut is set to the sqlite3LogEst() of the
  127649. ** number of rows that the index scan is expected to visit without
  127650. ** considering the range constraints. If nEq is 0, then *pnOut is the number of
  127651. ** rows in the index. Assuming no error occurs, *pnOut is adjusted (reduced)
  127652. ** to account for the range constraints pLower and pUpper.
  127653. **
  127654. ** In the absence of sqlite_stat4 ANALYZE data, or if such data cannot be
  127655. ** used, a single range inequality reduces the search space by a factor of 4.
  127656. ** and a pair of constraints (x>? AND x<?) reduces the expected number of
  127657. ** rows visited by a factor of 64.
  127658. */
  127659. static int whereRangeScanEst(
  127660. Parse *pParse, /* Parsing & code generating context */
  127661. WhereLoopBuilder *pBuilder,
  127662. WhereTerm *pLower, /* Lower bound on the range. ex: "x>123" Might be NULL */
  127663. WhereTerm *pUpper, /* Upper bound on the range. ex: "x<455" Might be NULL */
  127664. WhereLoop *pLoop /* Modify the .nOut and maybe .rRun fields */
  127665. ){
  127666. int rc = SQLITE_OK;
  127667. int nOut = pLoop->nOut;
  127668. LogEst nNew;
  127669. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  127670. Index *p = pLoop->u.btree.pIndex;
  127671. int nEq = pLoop->u.btree.nEq;
  127672. if( p->nSample>0 && nEq<p->nSampleCol ){
  127673. if( nEq==pBuilder->nRecValid ){
  127674. UnpackedRecord *pRec = pBuilder->pRec;
  127675. tRowcnt a[2];
  127676. int nBtm = pLoop->u.btree.nBtm;
  127677. int nTop = pLoop->u.btree.nTop;
  127678. /* Variable iLower will be set to the estimate of the number of rows in
  127679. ** the index that are less than the lower bound of the range query. The
  127680. ** lower bound being the concatenation of $P and $L, where $P is the
  127681. ** key-prefix formed by the nEq values matched against the nEq left-most
  127682. ** columns of the index, and $L is the value in pLower.
  127683. **
  127684. ** Or, if pLower is NULL or $L cannot be extracted from it (because it
  127685. ** is not a simple variable or literal value), the lower bound of the
  127686. ** range is $P. Due to a quirk in the way whereKeyStats() works, even
  127687. ** if $L is available, whereKeyStats() is called for both ($P) and
  127688. ** ($P:$L) and the larger of the two returned values is used.
  127689. **
  127690. ** Similarly, iUpper is to be set to the estimate of the number of rows
  127691. ** less than the upper bound of the range query. Where the upper bound
  127692. ** is either ($P) or ($P:$U). Again, even if $U is available, both values
  127693. ** of iUpper are requested of whereKeyStats() and the smaller used.
  127694. **
  127695. ** The number of rows between the two bounds is then just iUpper-iLower.
  127696. */
  127697. tRowcnt iLower; /* Rows less than the lower bound */
  127698. tRowcnt iUpper; /* Rows less than the upper bound */
  127699. int iLwrIdx = -2; /* aSample[] for the lower bound */
  127700. int iUprIdx = -1; /* aSample[] for the upper bound */
  127701. if( pRec ){
  127702. testcase( pRec->nField!=pBuilder->nRecValid );
  127703. pRec->nField = pBuilder->nRecValid;
  127704. }
  127705. /* Determine iLower and iUpper using ($P) only. */
  127706. if( nEq==0 ){
  127707. iLower = 0;
  127708. iUpper = p->nRowEst0;
  127709. }else{
  127710. /* Note: this call could be optimized away - since the same values must
  127711. ** have been requested when testing key $P in whereEqualScanEst(). */
  127712. whereKeyStats(pParse, p, pRec, 0, a);
  127713. iLower = a[0];
  127714. iUpper = a[0] + a[1];
  127715. }
  127716. assert( pLower==0 || (pLower->eOperator & (WO_GT|WO_GE))!=0 );
  127717. assert( pUpper==0 || (pUpper->eOperator & (WO_LT|WO_LE))!=0 );
  127718. assert( p->aSortOrder!=0 );
  127719. if( p->aSortOrder[nEq] ){
  127720. /* The roles of pLower and pUpper are swapped for a DESC index */
  127721. SWAP(WhereTerm*, pLower, pUpper);
  127722. SWAP(int, nBtm, nTop);
  127723. }
  127724. /* If possible, improve on the iLower estimate using ($P:$L). */
  127725. if( pLower ){
  127726. int n; /* Values extracted from pExpr */
  127727. Expr *pExpr = pLower->pExpr->pRight;
  127728. rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, nBtm, nEq, &n);
  127729. if( rc==SQLITE_OK && n ){
  127730. tRowcnt iNew;
  127731. u16 mask = WO_GT|WO_LE;
  127732. if( sqlite3ExprVectorSize(pExpr)>n ) mask = (WO_LE|WO_LT);
  127733. iLwrIdx = whereKeyStats(pParse, p, pRec, 0, a);
  127734. iNew = a[0] + ((pLower->eOperator & mask) ? a[1] : 0);
  127735. if( iNew>iLower ) iLower = iNew;
  127736. nOut--;
  127737. pLower = 0;
  127738. }
  127739. }
  127740. /* If possible, improve on the iUpper estimate using ($P:$U). */
  127741. if( pUpper ){
  127742. int n; /* Values extracted from pExpr */
  127743. Expr *pExpr = pUpper->pExpr->pRight;
  127744. rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, nTop, nEq, &n);
  127745. if( rc==SQLITE_OK && n ){
  127746. tRowcnt iNew;
  127747. u16 mask = WO_GT|WO_LE;
  127748. if( sqlite3ExprVectorSize(pExpr)>n ) mask = (WO_LE|WO_LT);
  127749. iUprIdx = whereKeyStats(pParse, p, pRec, 1, a);
  127750. iNew = a[0] + ((pUpper->eOperator & mask) ? a[1] : 0);
  127751. if( iNew<iUpper ) iUpper = iNew;
  127752. nOut--;
  127753. pUpper = 0;
  127754. }
  127755. }
  127756. pBuilder->pRec = pRec;
  127757. if( rc==SQLITE_OK ){
  127758. if( iUpper>iLower ){
  127759. nNew = sqlite3LogEst(iUpper - iLower);
  127760. /* TUNING: If both iUpper and iLower are derived from the same
  127761. ** sample, then assume they are 4x more selective. This brings
  127762. ** the estimated selectivity more in line with what it would be
  127763. ** if estimated without the use of STAT3/4 tables. */
  127764. if( iLwrIdx==iUprIdx ) nNew -= 20; assert( 20==sqlite3LogEst(4) );
  127765. }else{
  127766. nNew = 10; assert( 10==sqlite3LogEst(2) );
  127767. }
  127768. if( nNew<nOut ){
  127769. nOut = nNew;
  127770. }
  127771. WHERETRACE(0x10, ("STAT4 range scan: %u..%u est=%d\n",
  127772. (u32)iLower, (u32)iUpper, nOut));
  127773. }
  127774. }else{
  127775. int bDone = 0;
  127776. rc = whereRangeSkipScanEst(pParse, pLower, pUpper, pLoop, &bDone);
  127777. if( bDone ) return rc;
  127778. }
  127779. }
  127780. #else
  127781. UNUSED_PARAMETER(pParse);
  127782. UNUSED_PARAMETER(pBuilder);
  127783. assert( pLower || pUpper );
  127784. #endif
  127785. assert( pUpper==0 || (pUpper->wtFlags & TERM_VNULL)==0 );
  127786. nNew = whereRangeAdjust(pLower, nOut);
  127787. nNew = whereRangeAdjust(pUpper, nNew);
  127788. /* TUNING: If there is both an upper and lower limit and neither limit
  127789. ** has an application-defined likelihood(), assume the range is
  127790. ** reduced by an additional 75%. This means that, by default, an open-ended
  127791. ** range query (e.g. col > ?) is assumed to match 1/4 of the rows in the
  127792. ** index. While a closed range (e.g. col BETWEEN ? AND ?) is estimated to
  127793. ** match 1/64 of the index. */
  127794. if( pLower && pLower->truthProb>0 && pUpper && pUpper->truthProb>0 ){
  127795. nNew -= 20;
  127796. }
  127797. nOut -= (pLower!=0) + (pUpper!=0);
  127798. if( nNew<10 ) nNew = 10;
  127799. if( nNew<nOut ) nOut = nNew;
  127800. #if defined(WHERETRACE_ENABLED)
  127801. if( pLoop->nOut>nOut ){
  127802. WHERETRACE(0x10,("Range scan lowers nOut from %d to %d\n",
  127803. pLoop->nOut, nOut));
  127804. }
  127805. #endif
  127806. pLoop->nOut = (LogEst)nOut;
  127807. return rc;
  127808. }
  127809. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  127810. /*
  127811. ** Estimate the number of rows that will be returned based on
  127812. ** an equality constraint x=VALUE and where that VALUE occurs in
  127813. ** the histogram data. This only works when x is the left-most
  127814. ** column of an index and sqlite_stat3 histogram data is available
  127815. ** for that index. When pExpr==NULL that means the constraint is
  127816. ** "x IS NULL" instead of "x=VALUE".
  127817. **
  127818. ** Write the estimated row count into *pnRow and return SQLITE_OK.
  127819. ** If unable to make an estimate, leave *pnRow unchanged and return
  127820. ** non-zero.
  127821. **
  127822. ** This routine can fail if it is unable to load a collating sequence
  127823. ** required for string comparison, or if unable to allocate memory
  127824. ** for a UTF conversion required for comparison. The error is stored
  127825. ** in the pParse structure.
  127826. */
  127827. static int whereEqualScanEst(
  127828. Parse *pParse, /* Parsing & code generating context */
  127829. WhereLoopBuilder *pBuilder,
  127830. Expr *pExpr, /* Expression for VALUE in the x=VALUE constraint */
  127831. tRowcnt *pnRow /* Write the revised row estimate here */
  127832. ){
  127833. Index *p = pBuilder->pNew->u.btree.pIndex;
  127834. int nEq = pBuilder->pNew->u.btree.nEq;
  127835. UnpackedRecord *pRec = pBuilder->pRec;
  127836. int rc; /* Subfunction return code */
  127837. tRowcnt a[2]; /* Statistics */
  127838. int bOk;
  127839. assert( nEq>=1 );
  127840. assert( nEq<=p->nColumn );
  127841. assert( p->aSample!=0 );
  127842. assert( p->nSample>0 );
  127843. assert( pBuilder->nRecValid<nEq );
  127844. /* If values are not available for all fields of the index to the left
  127845. ** of this one, no estimate can be made. Return SQLITE_NOTFOUND. */
  127846. if( pBuilder->nRecValid<(nEq-1) ){
  127847. return SQLITE_NOTFOUND;
  127848. }
  127849. /* This is an optimization only. The call to sqlite3Stat4ProbeSetValue()
  127850. ** below would return the same value. */
  127851. if( nEq>=p->nColumn ){
  127852. *pnRow = 1;
  127853. return SQLITE_OK;
  127854. }
  127855. rc = sqlite3Stat4ProbeSetValue(pParse, p, &pRec, pExpr, 1, nEq-1, &bOk);
  127856. pBuilder->pRec = pRec;
  127857. if( rc!=SQLITE_OK ) return rc;
  127858. if( bOk==0 ) return SQLITE_NOTFOUND;
  127859. pBuilder->nRecValid = nEq;
  127860. whereKeyStats(pParse, p, pRec, 0, a);
  127861. WHERETRACE(0x10,("equality scan regions %s(%d): %d\n",
  127862. p->zName, nEq-1, (int)a[1]));
  127863. *pnRow = a[1];
  127864. return rc;
  127865. }
  127866. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  127867. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  127868. /*
  127869. ** Estimate the number of rows that will be returned based on
  127870. ** an IN constraint where the right-hand side of the IN operator
  127871. ** is a list of values. Example:
  127872. **
  127873. ** WHERE x IN (1,2,3,4)
  127874. **
  127875. ** Write the estimated row count into *pnRow and return SQLITE_OK.
  127876. ** If unable to make an estimate, leave *pnRow unchanged and return
  127877. ** non-zero.
  127878. **
  127879. ** This routine can fail if it is unable to load a collating sequence
  127880. ** required for string comparison, or if unable to allocate memory
  127881. ** for a UTF conversion required for comparison. The error is stored
  127882. ** in the pParse structure.
  127883. */
  127884. static int whereInScanEst(
  127885. Parse *pParse, /* Parsing & code generating context */
  127886. WhereLoopBuilder *pBuilder,
  127887. ExprList *pList, /* The value list on the RHS of "x IN (v1,v2,v3,...)" */
  127888. tRowcnt *pnRow /* Write the revised row estimate here */
  127889. ){
  127890. Index *p = pBuilder->pNew->u.btree.pIndex;
  127891. i64 nRow0 = sqlite3LogEstToInt(p->aiRowLogEst[0]);
  127892. int nRecValid = pBuilder->nRecValid;
  127893. int rc = SQLITE_OK; /* Subfunction return code */
  127894. tRowcnt nEst; /* Number of rows for a single term */
  127895. tRowcnt nRowEst = 0; /* New estimate of the number of rows */
  127896. int i; /* Loop counter */
  127897. assert( p->aSample!=0 );
  127898. for(i=0; rc==SQLITE_OK && i<pList->nExpr; i++){
  127899. nEst = nRow0;
  127900. rc = whereEqualScanEst(pParse, pBuilder, pList->a[i].pExpr, &nEst);
  127901. nRowEst += nEst;
  127902. pBuilder->nRecValid = nRecValid;
  127903. }
  127904. if( rc==SQLITE_OK ){
  127905. if( nRowEst > nRow0 ) nRowEst = nRow0;
  127906. *pnRow = nRowEst;
  127907. WHERETRACE(0x10,("IN row estimate: est=%d\n", nRowEst));
  127908. }
  127909. assert( pBuilder->nRecValid==nRecValid );
  127910. return rc;
  127911. }
  127912. #endif /* SQLITE_ENABLE_STAT3_OR_STAT4 */
  127913. #ifdef WHERETRACE_ENABLED
  127914. /*
  127915. ** Print the content of a WhereTerm object
  127916. */
  127917. static void whereTermPrint(WhereTerm *pTerm, int iTerm){
  127918. if( pTerm==0 ){
  127919. sqlite3DebugPrintf("TERM-%-3d NULL\n", iTerm);
  127920. }else{
  127921. char zType[4];
  127922. char zLeft[50];
  127923. memcpy(zType, "...", 4);
  127924. if( pTerm->wtFlags & TERM_VIRTUAL ) zType[0] = 'V';
  127925. if( pTerm->eOperator & WO_EQUIV ) zType[1] = 'E';
  127926. if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) zType[2] = 'L';
  127927. if( pTerm->eOperator & WO_SINGLE ){
  127928. sqlite3_snprintf(sizeof(zLeft),zLeft,"left={%d:%d}",
  127929. pTerm->leftCursor, pTerm->u.leftColumn);
  127930. }else if( (pTerm->eOperator & WO_OR)!=0 && pTerm->u.pOrInfo!=0 ){
  127931. sqlite3_snprintf(sizeof(zLeft),zLeft,"indexable=0x%lld",
  127932. pTerm->u.pOrInfo->indexable);
  127933. }else{
  127934. sqlite3_snprintf(sizeof(zLeft),zLeft,"left=%d", pTerm->leftCursor);
  127935. }
  127936. sqlite3DebugPrintf(
  127937. "TERM-%-3d %p %s %-12s prob=%-3d op=0x%03x wtFlags=0x%04x",
  127938. iTerm, pTerm, zType, zLeft, pTerm->truthProb,
  127939. pTerm->eOperator, pTerm->wtFlags);
  127940. if( pTerm->iField ){
  127941. sqlite3DebugPrintf(" iField=%d\n", pTerm->iField);
  127942. }else{
  127943. sqlite3DebugPrintf("\n");
  127944. }
  127945. sqlite3TreeViewExpr(0, pTerm->pExpr, 0);
  127946. }
  127947. }
  127948. #endif
  127949. #ifdef WHERETRACE_ENABLED
  127950. /*
  127951. ** Show the complete content of a WhereClause
  127952. */
  127953. SQLITE_PRIVATE void sqlite3WhereClausePrint(WhereClause *pWC){
  127954. int i;
  127955. for(i=0; i<pWC->nTerm; i++){
  127956. whereTermPrint(&pWC->a[i], i);
  127957. }
  127958. }
  127959. #endif
  127960. #ifdef WHERETRACE_ENABLED
  127961. /*
  127962. ** Print a WhereLoop object for debugging purposes
  127963. */
  127964. static void whereLoopPrint(WhereLoop *p, WhereClause *pWC){
  127965. WhereInfo *pWInfo = pWC->pWInfo;
  127966. int nb = 1+(pWInfo->pTabList->nSrc+3)/4;
  127967. struct SrcList_item *pItem = pWInfo->pTabList->a + p->iTab;
  127968. Table *pTab = pItem->pTab;
  127969. Bitmask mAll = (((Bitmask)1)<<(nb*4)) - 1;
  127970. sqlite3DebugPrintf("%c%2d.%0*llx.%0*llx", p->cId,
  127971. p->iTab, nb, p->maskSelf, nb, p->prereq & mAll);
  127972. sqlite3DebugPrintf(" %12s",
  127973. pItem->zAlias ? pItem->zAlias : pTab->zName);
  127974. if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
  127975. const char *zName;
  127976. if( p->u.btree.pIndex && (zName = p->u.btree.pIndex->zName)!=0 ){
  127977. if( strncmp(zName, "sqlite_autoindex_", 17)==0 ){
  127978. int i = sqlite3Strlen30(zName) - 1;
  127979. while( zName[i]!='_' ) i--;
  127980. zName += i;
  127981. }
  127982. sqlite3DebugPrintf(".%-16s %2d", zName, p->u.btree.nEq);
  127983. }else{
  127984. sqlite3DebugPrintf("%20s","");
  127985. }
  127986. }else{
  127987. char *z;
  127988. if( p->u.vtab.idxStr ){
  127989. z = sqlite3_mprintf("(%d,\"%s\",%x)",
  127990. p->u.vtab.idxNum, p->u.vtab.idxStr, p->u.vtab.omitMask);
  127991. }else{
  127992. z = sqlite3_mprintf("(%d,%x)", p->u.vtab.idxNum, p->u.vtab.omitMask);
  127993. }
  127994. sqlite3DebugPrintf(" %-19s", z);
  127995. sqlite3_free(z);
  127996. }
  127997. if( p->wsFlags & WHERE_SKIPSCAN ){
  127998. sqlite3DebugPrintf(" f %05x %d-%d", p->wsFlags, p->nLTerm,p->nSkip);
  127999. }else{
  128000. sqlite3DebugPrintf(" f %05x N %d", p->wsFlags, p->nLTerm);
  128001. }
  128002. sqlite3DebugPrintf(" cost %d,%d,%d\n", p->rSetup, p->rRun, p->nOut);
  128003. if( p->nLTerm && (sqlite3WhereTrace & 0x100)!=0 ){
  128004. int i;
  128005. for(i=0; i<p->nLTerm; i++){
  128006. whereTermPrint(p->aLTerm[i], i);
  128007. }
  128008. }
  128009. }
  128010. #endif
  128011. /*
  128012. ** Convert bulk memory into a valid WhereLoop that can be passed
  128013. ** to whereLoopClear harmlessly.
  128014. */
  128015. static void whereLoopInit(WhereLoop *p){
  128016. p->aLTerm = p->aLTermSpace;
  128017. p->nLTerm = 0;
  128018. p->nLSlot = ArraySize(p->aLTermSpace);
  128019. p->wsFlags = 0;
  128020. }
  128021. /*
  128022. ** Clear the WhereLoop.u union. Leave WhereLoop.pLTerm intact.
  128023. */
  128024. static void whereLoopClearUnion(sqlite3 *db, WhereLoop *p){
  128025. if( p->wsFlags & (WHERE_VIRTUALTABLE|WHERE_AUTO_INDEX) ){
  128026. if( (p->wsFlags & WHERE_VIRTUALTABLE)!=0 && p->u.vtab.needFree ){
  128027. sqlite3_free(p->u.vtab.idxStr);
  128028. p->u.vtab.needFree = 0;
  128029. p->u.vtab.idxStr = 0;
  128030. }else if( (p->wsFlags & WHERE_AUTO_INDEX)!=0 && p->u.btree.pIndex!=0 ){
  128031. sqlite3DbFree(db, p->u.btree.pIndex->zColAff);
  128032. sqlite3DbFreeNN(db, p->u.btree.pIndex);
  128033. p->u.btree.pIndex = 0;
  128034. }
  128035. }
  128036. }
  128037. /*
  128038. ** Deallocate internal memory used by a WhereLoop object
  128039. */
  128040. static void whereLoopClear(sqlite3 *db, WhereLoop *p){
  128041. if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFreeNN(db, p->aLTerm);
  128042. whereLoopClearUnion(db, p);
  128043. whereLoopInit(p);
  128044. }
  128045. /*
  128046. ** Increase the memory allocation for pLoop->aLTerm[] to be at least n.
  128047. */
  128048. static int whereLoopResize(sqlite3 *db, WhereLoop *p, int n){
  128049. WhereTerm **paNew;
  128050. if( p->nLSlot>=n ) return SQLITE_OK;
  128051. n = (n+7)&~7;
  128052. paNew = sqlite3DbMallocRawNN(db, sizeof(p->aLTerm[0])*n);
  128053. if( paNew==0 ) return SQLITE_NOMEM_BKPT;
  128054. memcpy(paNew, p->aLTerm, sizeof(p->aLTerm[0])*p->nLSlot);
  128055. if( p->aLTerm!=p->aLTermSpace ) sqlite3DbFreeNN(db, p->aLTerm);
  128056. p->aLTerm = paNew;
  128057. p->nLSlot = n;
  128058. return SQLITE_OK;
  128059. }
  128060. /*
  128061. ** Transfer content from the second pLoop into the first.
  128062. */
  128063. static int whereLoopXfer(sqlite3 *db, WhereLoop *pTo, WhereLoop *pFrom){
  128064. whereLoopClearUnion(db, pTo);
  128065. if( whereLoopResize(db, pTo, pFrom->nLTerm) ){
  128066. memset(&pTo->u, 0, sizeof(pTo->u));
  128067. return SQLITE_NOMEM_BKPT;
  128068. }
  128069. memcpy(pTo, pFrom, WHERE_LOOP_XFER_SZ);
  128070. memcpy(pTo->aLTerm, pFrom->aLTerm, pTo->nLTerm*sizeof(pTo->aLTerm[0]));
  128071. if( pFrom->wsFlags & WHERE_VIRTUALTABLE ){
  128072. pFrom->u.vtab.needFree = 0;
  128073. }else if( (pFrom->wsFlags & WHERE_AUTO_INDEX)!=0 ){
  128074. pFrom->u.btree.pIndex = 0;
  128075. }
  128076. return SQLITE_OK;
  128077. }
  128078. /*
  128079. ** Delete a WhereLoop object
  128080. */
  128081. static void whereLoopDelete(sqlite3 *db, WhereLoop *p){
  128082. whereLoopClear(db, p);
  128083. sqlite3DbFreeNN(db, p);
  128084. }
  128085. /*
  128086. ** Free a WhereInfo structure
  128087. */
  128088. static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
  128089. int i;
  128090. assert( pWInfo!=0 );
  128091. for(i=0; i<pWInfo->nLevel; i++){
  128092. WhereLevel *pLevel = &pWInfo->a[i];
  128093. if( pLevel->pWLoop && (pLevel->pWLoop->wsFlags & WHERE_IN_ABLE) ){
  128094. sqlite3DbFree(db, pLevel->u.in.aInLoop);
  128095. }
  128096. }
  128097. sqlite3WhereClauseClear(&pWInfo->sWC);
  128098. while( pWInfo->pLoops ){
  128099. WhereLoop *p = pWInfo->pLoops;
  128100. pWInfo->pLoops = p->pNextLoop;
  128101. whereLoopDelete(db, p);
  128102. }
  128103. sqlite3DbFreeNN(db, pWInfo);
  128104. }
  128105. /*
  128106. ** Return TRUE if all of the following are true:
  128107. **
  128108. ** (1) X has the same or lower cost that Y
  128109. ** (2) X uses fewer WHERE clause terms than Y
  128110. ** (3) Every WHERE clause term used by X is also used by Y
  128111. ** (4) X skips at least as many columns as Y
  128112. ** (5) If X is a covering index, than Y is too
  128113. **
  128114. ** Conditions (2) and (3) mean that X is a "proper subset" of Y.
  128115. ** If X is a proper subset of Y then Y is a better choice and ought
  128116. ** to have a lower cost. This routine returns TRUE when that cost
  128117. ** relationship is inverted and needs to be adjusted. Constraint (4)
  128118. ** was added because if X uses skip-scan less than Y it still might
  128119. ** deserve a lower cost even if it is a proper subset of Y. Constraint (5)
  128120. ** was added because a covering index probably deserves to have a lower cost
  128121. ** than a non-covering index even if it is a proper subset.
  128122. */
  128123. static int whereLoopCheaperProperSubset(
  128124. const WhereLoop *pX, /* First WhereLoop to compare */
  128125. const WhereLoop *pY /* Compare against this WhereLoop */
  128126. ){
  128127. int i, j;
  128128. if( pX->nLTerm-pX->nSkip >= pY->nLTerm-pY->nSkip ){
  128129. return 0; /* X is not a subset of Y */
  128130. }
  128131. if( pY->nSkip > pX->nSkip ) return 0;
  128132. if( pX->rRun >= pY->rRun ){
  128133. if( pX->rRun > pY->rRun ) return 0; /* X costs more than Y */
  128134. if( pX->nOut > pY->nOut ) return 0; /* X costs more than Y */
  128135. }
  128136. for(i=pX->nLTerm-1; i>=0; i--){
  128137. if( pX->aLTerm[i]==0 ) continue;
  128138. for(j=pY->nLTerm-1; j>=0; j--){
  128139. if( pY->aLTerm[j]==pX->aLTerm[i] ) break;
  128140. }
  128141. if( j<0 ) return 0; /* X not a subset of Y since term X[i] not used by Y */
  128142. }
  128143. if( (pX->wsFlags&WHERE_IDX_ONLY)!=0
  128144. && (pY->wsFlags&WHERE_IDX_ONLY)==0 ){
  128145. return 0; /* Constraint (5) */
  128146. }
  128147. return 1; /* All conditions meet */
  128148. }
  128149. /*
  128150. ** Try to adjust the cost of WhereLoop pTemplate upwards or downwards so
  128151. ** that:
  128152. **
  128153. ** (1) pTemplate costs less than any other WhereLoops that are a proper
  128154. ** subset of pTemplate
  128155. **
  128156. ** (2) pTemplate costs more than any other WhereLoops for which pTemplate
  128157. ** is a proper subset.
  128158. **
  128159. ** To say "WhereLoop X is a proper subset of Y" means that X uses fewer
  128160. ** WHERE clause terms than Y and that every WHERE clause term used by X is
  128161. ** also used by Y.
  128162. */
  128163. static void whereLoopAdjustCost(const WhereLoop *p, WhereLoop *pTemplate){
  128164. if( (pTemplate->wsFlags & WHERE_INDEXED)==0 ) return;
  128165. for(; p; p=p->pNextLoop){
  128166. if( p->iTab!=pTemplate->iTab ) continue;
  128167. if( (p->wsFlags & WHERE_INDEXED)==0 ) continue;
  128168. if( whereLoopCheaperProperSubset(p, pTemplate) ){
  128169. /* Adjust pTemplate cost downward so that it is cheaper than its
  128170. ** subset p. */
  128171. WHERETRACE(0x80,("subset cost adjustment %d,%d to %d,%d\n",
  128172. pTemplate->rRun, pTemplate->nOut, p->rRun, p->nOut-1));
  128173. pTemplate->rRun = p->rRun;
  128174. pTemplate->nOut = p->nOut - 1;
  128175. }else if( whereLoopCheaperProperSubset(pTemplate, p) ){
  128176. /* Adjust pTemplate cost upward so that it is costlier than p since
  128177. ** pTemplate is a proper subset of p */
  128178. WHERETRACE(0x80,("subset cost adjustment %d,%d to %d,%d\n",
  128179. pTemplate->rRun, pTemplate->nOut, p->rRun, p->nOut+1));
  128180. pTemplate->rRun = p->rRun;
  128181. pTemplate->nOut = p->nOut + 1;
  128182. }
  128183. }
  128184. }
  128185. /*
  128186. ** Search the list of WhereLoops in *ppPrev looking for one that can be
  128187. ** replaced by pTemplate.
  128188. **
  128189. ** Return NULL if pTemplate does not belong on the WhereLoop list.
  128190. ** In other words if pTemplate ought to be dropped from further consideration.
  128191. **
  128192. ** If pX is a WhereLoop that pTemplate can replace, then return the
  128193. ** link that points to pX.
  128194. **
  128195. ** If pTemplate cannot replace any existing element of the list but needs
  128196. ** to be added to the list as a new entry, then return a pointer to the
  128197. ** tail of the list.
  128198. */
  128199. static WhereLoop **whereLoopFindLesser(
  128200. WhereLoop **ppPrev,
  128201. const WhereLoop *pTemplate
  128202. ){
  128203. WhereLoop *p;
  128204. for(p=(*ppPrev); p; ppPrev=&p->pNextLoop, p=*ppPrev){
  128205. if( p->iTab!=pTemplate->iTab || p->iSortIdx!=pTemplate->iSortIdx ){
  128206. /* If either the iTab or iSortIdx values for two WhereLoop are different
  128207. ** then those WhereLoops need to be considered separately. Neither is
  128208. ** a candidate to replace the other. */
  128209. continue;
  128210. }
  128211. /* In the current implementation, the rSetup value is either zero
  128212. ** or the cost of building an automatic index (NlogN) and the NlogN
  128213. ** is the same for compatible WhereLoops. */
  128214. assert( p->rSetup==0 || pTemplate->rSetup==0
  128215. || p->rSetup==pTemplate->rSetup );
  128216. /* whereLoopAddBtree() always generates and inserts the automatic index
  128217. ** case first. Hence compatible candidate WhereLoops never have a larger
  128218. ** rSetup. Call this SETUP-INVARIANT */
  128219. assert( p->rSetup>=pTemplate->rSetup );
  128220. /* Any loop using an appliation-defined index (or PRIMARY KEY or
  128221. ** UNIQUE constraint) with one or more == constraints is better
  128222. ** than an automatic index. Unless it is a skip-scan. */
  128223. if( (p->wsFlags & WHERE_AUTO_INDEX)!=0
  128224. && (pTemplate->nSkip)==0
  128225. && (pTemplate->wsFlags & WHERE_INDEXED)!=0
  128226. && (pTemplate->wsFlags & WHERE_COLUMN_EQ)!=0
  128227. && (p->prereq & pTemplate->prereq)==pTemplate->prereq
  128228. ){
  128229. break;
  128230. }
  128231. /* If existing WhereLoop p is better than pTemplate, pTemplate can be
  128232. ** discarded. WhereLoop p is better if:
  128233. ** (1) p has no more dependencies than pTemplate, and
  128234. ** (2) p has an equal or lower cost than pTemplate
  128235. */
  128236. if( (p->prereq & pTemplate->prereq)==p->prereq /* (1) */
  128237. && p->rSetup<=pTemplate->rSetup /* (2a) */
  128238. && p->rRun<=pTemplate->rRun /* (2b) */
  128239. && p->nOut<=pTemplate->nOut /* (2c) */
  128240. ){
  128241. return 0; /* Discard pTemplate */
  128242. }
  128243. /* If pTemplate is always better than p, then cause p to be overwritten
  128244. ** with pTemplate. pTemplate is better than p if:
  128245. ** (1) pTemplate has no more dependences than p, and
  128246. ** (2) pTemplate has an equal or lower cost than p.
  128247. */
  128248. if( (p->prereq & pTemplate->prereq)==pTemplate->prereq /* (1) */
  128249. && p->rRun>=pTemplate->rRun /* (2a) */
  128250. && p->nOut>=pTemplate->nOut /* (2b) */
  128251. ){
  128252. assert( p->rSetup>=pTemplate->rSetup ); /* SETUP-INVARIANT above */
  128253. break; /* Cause p to be overwritten by pTemplate */
  128254. }
  128255. }
  128256. return ppPrev;
  128257. }
  128258. /*
  128259. ** Insert or replace a WhereLoop entry using the template supplied.
  128260. **
  128261. ** An existing WhereLoop entry might be overwritten if the new template
  128262. ** is better and has fewer dependencies. Or the template will be ignored
  128263. ** and no insert will occur if an existing WhereLoop is faster and has
  128264. ** fewer dependencies than the template. Otherwise a new WhereLoop is
  128265. ** added based on the template.
  128266. **
  128267. ** If pBuilder->pOrSet is not NULL then we care about only the
  128268. ** prerequisites and rRun and nOut costs of the N best loops. That
  128269. ** information is gathered in the pBuilder->pOrSet object. This special
  128270. ** processing mode is used only for OR clause processing.
  128271. **
  128272. ** When accumulating multiple loops (when pBuilder->pOrSet is NULL) we
  128273. ** still might overwrite similar loops with the new template if the
  128274. ** new template is better. Loops may be overwritten if the following
  128275. ** conditions are met:
  128276. **
  128277. ** (1) They have the same iTab.
  128278. ** (2) They have the same iSortIdx.
  128279. ** (3) The template has same or fewer dependencies than the current loop
  128280. ** (4) The template has the same or lower cost than the current loop
  128281. */
  128282. static int whereLoopInsert(WhereLoopBuilder *pBuilder, WhereLoop *pTemplate){
  128283. WhereLoop **ppPrev, *p;
  128284. WhereInfo *pWInfo = pBuilder->pWInfo;
  128285. sqlite3 *db = pWInfo->pParse->db;
  128286. int rc;
  128287. /* If pBuilder->pOrSet is defined, then only keep track of the costs
  128288. ** and prereqs.
  128289. */
  128290. if( pBuilder->pOrSet!=0 ){
  128291. if( pTemplate->nLTerm ){
  128292. #if WHERETRACE_ENABLED
  128293. u16 n = pBuilder->pOrSet->n;
  128294. int x =
  128295. #endif
  128296. whereOrInsert(pBuilder->pOrSet, pTemplate->prereq, pTemplate->rRun,
  128297. pTemplate->nOut);
  128298. #if WHERETRACE_ENABLED /* 0x8 */
  128299. if( sqlite3WhereTrace & 0x8 ){
  128300. sqlite3DebugPrintf(x?" or-%d: ":" or-X: ", n);
  128301. whereLoopPrint(pTemplate, pBuilder->pWC);
  128302. }
  128303. #endif
  128304. }
  128305. return SQLITE_OK;
  128306. }
  128307. /* Look for an existing WhereLoop to replace with pTemplate
  128308. */
  128309. whereLoopAdjustCost(pWInfo->pLoops, pTemplate);
  128310. ppPrev = whereLoopFindLesser(&pWInfo->pLoops, pTemplate);
  128311. if( ppPrev==0 ){
  128312. /* There already exists a WhereLoop on the list that is better
  128313. ** than pTemplate, so just ignore pTemplate */
  128314. #if WHERETRACE_ENABLED /* 0x8 */
  128315. if( sqlite3WhereTrace & 0x8 ){
  128316. sqlite3DebugPrintf(" skip: ");
  128317. whereLoopPrint(pTemplate, pBuilder->pWC);
  128318. }
  128319. #endif
  128320. return SQLITE_OK;
  128321. }else{
  128322. p = *ppPrev;
  128323. }
  128324. /* If we reach this point it means that either p[] should be overwritten
  128325. ** with pTemplate[] if p[] exists, or if p==NULL then allocate a new
  128326. ** WhereLoop and insert it.
  128327. */
  128328. #if WHERETRACE_ENABLED /* 0x8 */
  128329. if( sqlite3WhereTrace & 0x8 ){
  128330. if( p!=0 ){
  128331. sqlite3DebugPrintf("replace: ");
  128332. whereLoopPrint(p, pBuilder->pWC);
  128333. sqlite3DebugPrintf(" with: ");
  128334. }else{
  128335. sqlite3DebugPrintf(" add: ");
  128336. }
  128337. whereLoopPrint(pTemplate, pBuilder->pWC);
  128338. }
  128339. #endif
  128340. if( p==0 ){
  128341. /* Allocate a new WhereLoop to add to the end of the list */
  128342. *ppPrev = p = sqlite3DbMallocRawNN(db, sizeof(WhereLoop));
  128343. if( p==0 ) return SQLITE_NOMEM_BKPT;
  128344. whereLoopInit(p);
  128345. p->pNextLoop = 0;
  128346. }else{
  128347. /* We will be overwriting WhereLoop p[]. But before we do, first
  128348. ** go through the rest of the list and delete any other entries besides
  128349. ** p[] that are also supplated by pTemplate */
  128350. WhereLoop **ppTail = &p->pNextLoop;
  128351. WhereLoop *pToDel;
  128352. while( *ppTail ){
  128353. ppTail = whereLoopFindLesser(ppTail, pTemplate);
  128354. if( ppTail==0 ) break;
  128355. pToDel = *ppTail;
  128356. if( pToDel==0 ) break;
  128357. *ppTail = pToDel->pNextLoop;
  128358. #if WHERETRACE_ENABLED /* 0x8 */
  128359. if( sqlite3WhereTrace & 0x8 ){
  128360. sqlite3DebugPrintf(" delete: ");
  128361. whereLoopPrint(pToDel, pBuilder->pWC);
  128362. }
  128363. #endif
  128364. whereLoopDelete(db, pToDel);
  128365. }
  128366. }
  128367. rc = whereLoopXfer(db, p, pTemplate);
  128368. if( (p->wsFlags & WHERE_VIRTUALTABLE)==0 ){
  128369. Index *pIndex = p->u.btree.pIndex;
  128370. if( pIndex && pIndex->tnum==0 ){
  128371. p->u.btree.pIndex = 0;
  128372. }
  128373. }
  128374. return rc;
  128375. }
  128376. /*
  128377. ** Adjust the WhereLoop.nOut value downward to account for terms of the
  128378. ** WHERE clause that reference the loop but which are not used by an
  128379. ** index.
  128380. *
  128381. ** For every WHERE clause term that is not used by the index
  128382. ** and which has a truth probability assigned by one of the likelihood(),
  128383. ** likely(), or unlikely() SQL functions, reduce the estimated number
  128384. ** of output rows by the probability specified.
  128385. **
  128386. ** TUNING: For every WHERE clause term that is not used by the index
  128387. ** and which does not have an assigned truth probability, heuristics
  128388. ** described below are used to try to estimate the truth probability.
  128389. ** TODO --> Perhaps this is something that could be improved by better
  128390. ** table statistics.
  128391. **
  128392. ** Heuristic 1: Estimate the truth probability as 93.75%. The 93.75%
  128393. ** value corresponds to -1 in LogEst notation, so this means decrement
  128394. ** the WhereLoop.nOut field for every such WHERE clause term.
  128395. **
  128396. ** Heuristic 2: If there exists one or more WHERE clause terms of the
  128397. ** form "x==EXPR" and EXPR is not a constant 0 or 1, then make sure the
  128398. ** final output row estimate is no greater than 1/4 of the total number
  128399. ** of rows in the table. In other words, assume that x==EXPR will filter
  128400. ** out at least 3 out of 4 rows. If EXPR is -1 or 0 or 1, then maybe the
  128401. ** "x" column is boolean or else -1 or 0 or 1 is a common default value
  128402. ** on the "x" column and so in that case only cap the output row estimate
  128403. ** at 1/2 instead of 1/4.
  128404. */
  128405. static void whereLoopOutputAdjust(
  128406. WhereClause *pWC, /* The WHERE clause */
  128407. WhereLoop *pLoop, /* The loop to adjust downward */
  128408. LogEst nRow /* Number of rows in the entire table */
  128409. ){
  128410. WhereTerm *pTerm, *pX;
  128411. Bitmask notAllowed = ~(pLoop->prereq|pLoop->maskSelf);
  128412. int i, j, k;
  128413. LogEst iReduce = 0; /* pLoop->nOut should not exceed nRow-iReduce */
  128414. assert( (pLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
  128415. for(i=pWC->nTerm, pTerm=pWC->a; i>0; i--, pTerm++){
  128416. if( (pTerm->wtFlags & TERM_VIRTUAL)!=0 ) break;
  128417. if( (pTerm->prereqAll & pLoop->maskSelf)==0 ) continue;
  128418. if( (pTerm->prereqAll & notAllowed)!=0 ) continue;
  128419. for(j=pLoop->nLTerm-1; j>=0; j--){
  128420. pX = pLoop->aLTerm[j];
  128421. if( pX==0 ) continue;
  128422. if( pX==pTerm ) break;
  128423. if( pX->iParent>=0 && (&pWC->a[pX->iParent])==pTerm ) break;
  128424. }
  128425. if( j<0 ){
  128426. if( pTerm->truthProb<=0 ){
  128427. /* If a truth probability is specified using the likelihood() hints,
  128428. ** then use the probability provided by the application. */
  128429. pLoop->nOut += pTerm->truthProb;
  128430. }else{
  128431. /* In the absence of explicit truth probabilities, use heuristics to
  128432. ** guess a reasonable truth probability. */
  128433. pLoop->nOut--;
  128434. if( pTerm->eOperator&(WO_EQ|WO_IS) ){
  128435. Expr *pRight = pTerm->pExpr->pRight;
  128436. testcase( pTerm->pExpr->op==TK_IS );
  128437. if( sqlite3ExprIsInteger(pRight, &k) && k>=(-1) && k<=1 ){
  128438. k = 10;
  128439. }else{
  128440. k = 20;
  128441. }
  128442. if( iReduce<k ) iReduce = k;
  128443. }
  128444. }
  128445. }
  128446. }
  128447. if( pLoop->nOut > nRow-iReduce ) pLoop->nOut = nRow - iReduce;
  128448. }
  128449. /*
  128450. ** Term pTerm is a vector range comparison operation. The first comparison
  128451. ** in the vector can be optimized using column nEq of the index. This
  128452. ** function returns the total number of vector elements that can be used
  128453. ** as part of the range comparison.
  128454. **
  128455. ** For example, if the query is:
  128456. **
  128457. ** WHERE a = ? AND (b, c, d) > (?, ?, ?)
  128458. **
  128459. ** and the index:
  128460. **
  128461. ** CREATE INDEX ... ON (a, b, c, d, e)
  128462. **
  128463. ** then this function would be invoked with nEq=1. The value returned in
  128464. ** this case is 3.
  128465. */
  128466. static int whereRangeVectorLen(
  128467. Parse *pParse, /* Parsing context */
  128468. int iCur, /* Cursor open on pIdx */
  128469. Index *pIdx, /* The index to be used for a inequality constraint */
  128470. int nEq, /* Number of prior equality constraints on same index */
  128471. WhereTerm *pTerm /* The vector inequality constraint */
  128472. ){
  128473. int nCmp = sqlite3ExprVectorSize(pTerm->pExpr->pLeft);
  128474. int i;
  128475. nCmp = MIN(nCmp, (pIdx->nColumn - nEq));
  128476. for(i=1; i<nCmp; i++){
  128477. /* Test if comparison i of pTerm is compatible with column (i+nEq)
  128478. ** of the index. If not, exit the loop. */
  128479. char aff; /* Comparison affinity */
  128480. char idxaff = 0; /* Indexed columns affinity */
  128481. CollSeq *pColl; /* Comparison collation sequence */
  128482. Expr *pLhs = pTerm->pExpr->pLeft->x.pList->a[i].pExpr;
  128483. Expr *pRhs = pTerm->pExpr->pRight;
  128484. if( pRhs->flags & EP_xIsSelect ){
  128485. pRhs = pRhs->x.pSelect->pEList->a[i].pExpr;
  128486. }else{
  128487. pRhs = pRhs->x.pList->a[i].pExpr;
  128488. }
  128489. /* Check that the LHS of the comparison is a column reference to
  128490. ** the right column of the right source table. And that the sort
  128491. ** order of the index column is the same as the sort order of the
  128492. ** leftmost index column. */
  128493. if( pLhs->op!=TK_COLUMN
  128494. || pLhs->iTable!=iCur
  128495. || pLhs->iColumn!=pIdx->aiColumn[i+nEq]
  128496. || pIdx->aSortOrder[i+nEq]!=pIdx->aSortOrder[nEq]
  128497. ){
  128498. break;
  128499. }
  128500. testcase( pLhs->iColumn==XN_ROWID );
  128501. aff = sqlite3CompareAffinity(pRhs, sqlite3ExprAffinity(pLhs));
  128502. idxaff = sqlite3TableColumnAffinity(pIdx->pTable, pLhs->iColumn);
  128503. if( aff!=idxaff ) break;
  128504. pColl = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
  128505. if( pColl==0 ) break;
  128506. if( sqlite3StrICmp(pColl->zName, pIdx->azColl[i+nEq]) ) break;
  128507. }
  128508. return i;
  128509. }
  128510. /*
  128511. ** Adjust the cost C by the costMult facter T. This only occurs if
  128512. ** compiled with -DSQLITE_ENABLE_COSTMULT
  128513. */
  128514. #ifdef SQLITE_ENABLE_COSTMULT
  128515. # define ApplyCostMultiplier(C,T) C += T
  128516. #else
  128517. # define ApplyCostMultiplier(C,T)
  128518. #endif
  128519. /*
  128520. ** We have so far matched pBuilder->pNew->u.btree.nEq terms of the
  128521. ** index pIndex. Try to match one more.
  128522. **
  128523. ** When this function is called, pBuilder->pNew->nOut contains the
  128524. ** number of rows expected to be visited by filtering using the nEq
  128525. ** terms only. If it is modified, this value is restored before this
  128526. ** function returns.
  128527. **
  128528. ** If pProbe->tnum==0, that means pIndex is a fake index used for the
  128529. ** INTEGER PRIMARY KEY.
  128530. */
  128531. static int whereLoopAddBtreeIndex(
  128532. WhereLoopBuilder *pBuilder, /* The WhereLoop factory */
  128533. struct SrcList_item *pSrc, /* FROM clause term being analyzed */
  128534. Index *pProbe, /* An index on pSrc */
  128535. LogEst nInMul /* log(Number of iterations due to IN) */
  128536. ){
  128537. WhereInfo *pWInfo = pBuilder->pWInfo; /* WHERE analyse context */
  128538. Parse *pParse = pWInfo->pParse; /* Parsing context */
  128539. sqlite3 *db = pParse->db; /* Database connection malloc context */
  128540. WhereLoop *pNew; /* Template WhereLoop under construction */
  128541. WhereTerm *pTerm; /* A WhereTerm under consideration */
  128542. int opMask; /* Valid operators for constraints */
  128543. WhereScan scan; /* Iterator for WHERE terms */
  128544. Bitmask saved_prereq; /* Original value of pNew->prereq */
  128545. u16 saved_nLTerm; /* Original value of pNew->nLTerm */
  128546. u16 saved_nEq; /* Original value of pNew->u.btree.nEq */
  128547. u16 saved_nBtm; /* Original value of pNew->u.btree.nBtm */
  128548. u16 saved_nTop; /* Original value of pNew->u.btree.nTop */
  128549. u16 saved_nSkip; /* Original value of pNew->nSkip */
  128550. u32 saved_wsFlags; /* Original value of pNew->wsFlags */
  128551. LogEst saved_nOut; /* Original value of pNew->nOut */
  128552. int rc = SQLITE_OK; /* Return code */
  128553. LogEst rSize; /* Number of rows in the table */
  128554. LogEst rLogSize; /* Logarithm of table size */
  128555. WhereTerm *pTop = 0, *pBtm = 0; /* Top and bottom range constraints */
  128556. pNew = pBuilder->pNew;
  128557. if( db->mallocFailed ) return SQLITE_NOMEM_BKPT;
  128558. WHERETRACE(0x800, ("BEGIN %s.addBtreeIdx(%s), nEq=%d\n",
  128559. pProbe->pTable->zName,pProbe->zName, pNew->u.btree.nEq));
  128560. assert( (pNew->wsFlags & WHERE_VIRTUALTABLE)==0 );
  128561. assert( (pNew->wsFlags & WHERE_TOP_LIMIT)==0 );
  128562. if( pNew->wsFlags & WHERE_BTM_LIMIT ){
  128563. opMask = WO_LT|WO_LE;
  128564. }else{
  128565. assert( pNew->u.btree.nBtm==0 );
  128566. opMask = WO_EQ|WO_IN|WO_GT|WO_GE|WO_LT|WO_LE|WO_ISNULL|WO_IS;
  128567. }
  128568. if( pProbe->bUnordered ) opMask &= ~(WO_GT|WO_GE|WO_LT|WO_LE);
  128569. assert( pNew->u.btree.nEq<pProbe->nColumn );
  128570. saved_nEq = pNew->u.btree.nEq;
  128571. saved_nBtm = pNew->u.btree.nBtm;
  128572. saved_nTop = pNew->u.btree.nTop;
  128573. saved_nSkip = pNew->nSkip;
  128574. saved_nLTerm = pNew->nLTerm;
  128575. saved_wsFlags = pNew->wsFlags;
  128576. saved_prereq = pNew->prereq;
  128577. saved_nOut = pNew->nOut;
  128578. pTerm = whereScanInit(&scan, pBuilder->pWC, pSrc->iCursor, saved_nEq,
  128579. opMask, pProbe);
  128580. pNew->rSetup = 0;
  128581. rSize = pProbe->aiRowLogEst[0];
  128582. rLogSize = estLog(rSize);
  128583. for(; rc==SQLITE_OK && pTerm!=0; pTerm = whereScanNext(&scan)){
  128584. u16 eOp = pTerm->eOperator; /* Shorthand for pTerm->eOperator */
  128585. LogEst rCostIdx;
  128586. LogEst nOutUnadjusted; /* nOut before IN() and WHERE adjustments */
  128587. int nIn = 0;
  128588. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  128589. int nRecValid = pBuilder->nRecValid;
  128590. #endif
  128591. if( (eOp==WO_ISNULL || (pTerm->wtFlags&TERM_VNULL)!=0)
  128592. && indexColumnNotNull(pProbe, saved_nEq)
  128593. ){
  128594. continue; /* ignore IS [NOT] NULL constraints on NOT NULL columns */
  128595. }
  128596. if( pTerm->prereqRight & pNew->maskSelf ) continue;
  128597. /* Do not allow the upper bound of a LIKE optimization range constraint
  128598. ** to mix with a lower range bound from some other source */
  128599. if( pTerm->wtFlags & TERM_LIKEOPT && pTerm->eOperator==WO_LT ) continue;
  128600. /* Do not allow IS constraints from the WHERE clause to be used by the
  128601. ** right table of a LEFT JOIN. Only constraints in the ON clause are
  128602. ** allowed */
  128603. if( (pSrc->fg.jointype & JT_LEFT)!=0
  128604. && !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
  128605. && (eOp & (WO_IS|WO_ISNULL))!=0
  128606. ){
  128607. testcase( eOp & WO_IS );
  128608. testcase( eOp & WO_ISNULL );
  128609. continue;
  128610. }
  128611. if( IsUniqueIndex(pProbe) && saved_nEq==pProbe->nKeyCol-1 ){
  128612. pBuilder->bldFlags |= SQLITE_BLDF_UNIQUE;
  128613. }else{
  128614. pBuilder->bldFlags |= SQLITE_BLDF_INDEXED;
  128615. }
  128616. pNew->wsFlags = saved_wsFlags;
  128617. pNew->u.btree.nEq = saved_nEq;
  128618. pNew->u.btree.nBtm = saved_nBtm;
  128619. pNew->u.btree.nTop = saved_nTop;
  128620. pNew->nLTerm = saved_nLTerm;
  128621. if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
  128622. pNew->aLTerm[pNew->nLTerm++] = pTerm;
  128623. pNew->prereq = (saved_prereq | pTerm->prereqRight) & ~pNew->maskSelf;
  128624. assert( nInMul==0
  128625. || (pNew->wsFlags & WHERE_COLUMN_NULL)!=0
  128626. || (pNew->wsFlags & WHERE_COLUMN_IN)!=0
  128627. || (pNew->wsFlags & WHERE_SKIPSCAN)!=0
  128628. );
  128629. if( eOp & WO_IN ){
  128630. Expr *pExpr = pTerm->pExpr;
  128631. pNew->wsFlags |= WHERE_COLUMN_IN;
  128632. if( ExprHasProperty(pExpr, EP_xIsSelect) ){
  128633. /* "x IN (SELECT ...)": TUNING: the SELECT returns 25 rows */
  128634. int i;
  128635. nIn = 46; assert( 46==sqlite3LogEst(25) );
  128636. /* The expression may actually be of the form (x, y) IN (SELECT...).
  128637. ** In this case there is a separate term for each of (x) and (y).
  128638. ** However, the nIn multiplier should only be applied once, not once
  128639. ** for each such term. The following loop checks that pTerm is the
  128640. ** first such term in use, and sets nIn back to 0 if it is not. */
  128641. for(i=0; i<pNew->nLTerm-1; i++){
  128642. if( pNew->aLTerm[i] && pNew->aLTerm[i]->pExpr==pExpr ) nIn = 0;
  128643. }
  128644. }else if( ALWAYS(pExpr->x.pList && pExpr->x.pList->nExpr) ){
  128645. /* "x IN (value, value, ...)" */
  128646. nIn = sqlite3LogEst(pExpr->x.pList->nExpr);
  128647. assert( nIn>0 ); /* RHS always has 2 or more terms... The parser
  128648. ** changes "x IN (?)" into "x=?". */
  128649. }
  128650. }else if( eOp & (WO_EQ|WO_IS) ){
  128651. int iCol = pProbe->aiColumn[saved_nEq];
  128652. pNew->wsFlags |= WHERE_COLUMN_EQ;
  128653. assert( saved_nEq==pNew->u.btree.nEq );
  128654. if( iCol==XN_ROWID
  128655. || (iCol>=0 && nInMul==0 && saved_nEq==pProbe->nKeyCol-1)
  128656. ){
  128657. if( iCol==XN_ROWID || pProbe->uniqNotNull
  128658. || (pProbe->nKeyCol==1 && pProbe->onError && eOp==WO_EQ)
  128659. ){
  128660. pNew->wsFlags |= WHERE_ONEROW;
  128661. }else{
  128662. pNew->wsFlags |= WHERE_UNQ_WANTED;
  128663. }
  128664. }
  128665. }else if( eOp & WO_ISNULL ){
  128666. pNew->wsFlags |= WHERE_COLUMN_NULL;
  128667. }else if( eOp & (WO_GT|WO_GE) ){
  128668. testcase( eOp & WO_GT );
  128669. testcase( eOp & WO_GE );
  128670. pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_BTM_LIMIT;
  128671. pNew->u.btree.nBtm = whereRangeVectorLen(
  128672. pParse, pSrc->iCursor, pProbe, saved_nEq, pTerm
  128673. );
  128674. pBtm = pTerm;
  128675. pTop = 0;
  128676. if( pTerm->wtFlags & TERM_LIKEOPT ){
  128677. /* Range contraints that come from the LIKE optimization are
  128678. ** always used in pairs. */
  128679. pTop = &pTerm[1];
  128680. assert( (pTop-(pTerm->pWC->a))<pTerm->pWC->nTerm );
  128681. assert( pTop->wtFlags & TERM_LIKEOPT );
  128682. assert( pTop->eOperator==WO_LT );
  128683. if( whereLoopResize(db, pNew, pNew->nLTerm+1) ) break; /* OOM */
  128684. pNew->aLTerm[pNew->nLTerm++] = pTop;
  128685. pNew->wsFlags |= WHERE_TOP_LIMIT;
  128686. pNew->u.btree.nTop = 1;
  128687. }
  128688. }else{
  128689. assert( eOp & (WO_LT|WO_LE) );
  128690. testcase( eOp & WO_LT );
  128691. testcase( eOp & WO_LE );
  128692. pNew->wsFlags |= WHERE_COLUMN_RANGE|WHERE_TOP_LIMIT;
  128693. pNew->u.btree.nTop = whereRangeVectorLen(
  128694. pParse, pSrc->iCursor, pProbe, saved_nEq, pTerm
  128695. );
  128696. pTop = pTerm;
  128697. pBtm = (pNew->wsFlags & WHERE_BTM_LIMIT)!=0 ?
  128698. pNew->aLTerm[pNew->nLTerm-2] : 0;
  128699. }
  128700. /* At this point pNew->nOut is set to the number of rows expected to
  128701. ** be visited by the index scan before considering term pTerm, or the
  128702. ** values of nIn and nInMul. In other words, assuming that all
  128703. ** "x IN(...)" terms are replaced with "x = ?". This block updates
  128704. ** the value of pNew->nOut to account for pTerm (but not nIn/nInMul). */
  128705. assert( pNew->nOut==saved_nOut );
  128706. if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
  128707. /* Adjust nOut using stat3/stat4 data. Or, if there is no stat3/stat4
  128708. ** data, using some other estimate. */
  128709. whereRangeScanEst(pParse, pBuilder, pBtm, pTop, pNew);
  128710. }else{
  128711. int nEq = ++pNew->u.btree.nEq;
  128712. assert( eOp & (WO_ISNULL|WO_EQ|WO_IN|WO_IS) );
  128713. assert( pNew->nOut==saved_nOut );
  128714. if( pTerm->truthProb<=0 && pProbe->aiColumn[saved_nEq]>=0 ){
  128715. assert( (eOp & WO_IN) || nIn==0 );
  128716. testcase( eOp & WO_IN );
  128717. pNew->nOut += pTerm->truthProb;
  128718. pNew->nOut -= nIn;
  128719. }else{
  128720. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  128721. tRowcnt nOut = 0;
  128722. if( nInMul==0
  128723. && pProbe->nSample
  128724. && pNew->u.btree.nEq<=pProbe->nSampleCol
  128725. && ((eOp & WO_IN)==0 || !ExprHasProperty(pTerm->pExpr, EP_xIsSelect))
  128726. ){
  128727. Expr *pExpr = pTerm->pExpr;
  128728. if( (eOp & (WO_EQ|WO_ISNULL|WO_IS))!=0 ){
  128729. testcase( eOp & WO_EQ );
  128730. testcase( eOp & WO_IS );
  128731. testcase( eOp & WO_ISNULL );
  128732. rc = whereEqualScanEst(pParse, pBuilder, pExpr->pRight, &nOut);
  128733. }else{
  128734. rc = whereInScanEst(pParse, pBuilder, pExpr->x.pList, &nOut);
  128735. }
  128736. if( rc==SQLITE_NOTFOUND ) rc = SQLITE_OK;
  128737. if( rc!=SQLITE_OK ) break; /* Jump out of the pTerm loop */
  128738. if( nOut ){
  128739. pNew->nOut = sqlite3LogEst(nOut);
  128740. if( pNew->nOut>saved_nOut ) pNew->nOut = saved_nOut;
  128741. pNew->nOut -= nIn;
  128742. }
  128743. }
  128744. if( nOut==0 )
  128745. #endif
  128746. {
  128747. pNew->nOut += (pProbe->aiRowLogEst[nEq] - pProbe->aiRowLogEst[nEq-1]);
  128748. if( eOp & WO_ISNULL ){
  128749. /* TUNING: If there is no likelihood() value, assume that a
  128750. ** "col IS NULL" expression matches twice as many rows
  128751. ** as (col=?). */
  128752. pNew->nOut += 10;
  128753. }
  128754. }
  128755. }
  128756. }
  128757. /* Set rCostIdx to the cost of visiting selected rows in index. Add
  128758. ** it to pNew->rRun, which is currently set to the cost of the index
  128759. ** seek only. Then, if this is a non-covering index, add the cost of
  128760. ** visiting the rows in the main table. */
  128761. rCostIdx = pNew->nOut + 1 + (15*pProbe->szIdxRow)/pSrc->pTab->szTabRow;
  128762. pNew->rRun = sqlite3LogEstAdd(rLogSize, rCostIdx);
  128763. if( (pNew->wsFlags & (WHERE_IDX_ONLY|WHERE_IPK))==0 ){
  128764. pNew->rRun = sqlite3LogEstAdd(pNew->rRun, pNew->nOut + 16);
  128765. }
  128766. ApplyCostMultiplier(pNew->rRun, pProbe->pTable->costMult);
  128767. nOutUnadjusted = pNew->nOut;
  128768. pNew->rRun += nInMul + nIn;
  128769. pNew->nOut += nInMul + nIn;
  128770. whereLoopOutputAdjust(pBuilder->pWC, pNew, rSize);
  128771. rc = whereLoopInsert(pBuilder, pNew);
  128772. if( pNew->wsFlags & WHERE_COLUMN_RANGE ){
  128773. pNew->nOut = saved_nOut;
  128774. }else{
  128775. pNew->nOut = nOutUnadjusted;
  128776. }
  128777. if( (pNew->wsFlags & WHERE_TOP_LIMIT)==0
  128778. && pNew->u.btree.nEq<pProbe->nColumn
  128779. ){
  128780. whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nInMul+nIn);
  128781. }
  128782. pNew->nOut = saved_nOut;
  128783. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  128784. pBuilder->nRecValid = nRecValid;
  128785. #endif
  128786. }
  128787. pNew->prereq = saved_prereq;
  128788. pNew->u.btree.nEq = saved_nEq;
  128789. pNew->u.btree.nBtm = saved_nBtm;
  128790. pNew->u.btree.nTop = saved_nTop;
  128791. pNew->nSkip = saved_nSkip;
  128792. pNew->wsFlags = saved_wsFlags;
  128793. pNew->nOut = saved_nOut;
  128794. pNew->nLTerm = saved_nLTerm;
  128795. /* Consider using a skip-scan if there are no WHERE clause constraints
  128796. ** available for the left-most terms of the index, and if the average
  128797. ** number of repeats in the left-most terms is at least 18.
  128798. **
  128799. ** The magic number 18 is selected on the basis that scanning 17 rows
  128800. ** is almost always quicker than an index seek (even though if the index
  128801. ** contains fewer than 2^17 rows we assume otherwise in other parts of
  128802. ** the code). And, even if it is not, it should not be too much slower.
  128803. ** On the other hand, the extra seeks could end up being significantly
  128804. ** more expensive. */
  128805. assert( 42==sqlite3LogEst(18) );
  128806. if( saved_nEq==saved_nSkip
  128807. && saved_nEq+1<pProbe->nKeyCol
  128808. && pProbe->noSkipScan==0
  128809. && pProbe->aiRowLogEst[saved_nEq+1]>=42 /* TUNING: Minimum for skip-scan */
  128810. && (rc = whereLoopResize(db, pNew, pNew->nLTerm+1))==SQLITE_OK
  128811. ){
  128812. LogEst nIter;
  128813. pNew->u.btree.nEq++;
  128814. pNew->nSkip++;
  128815. pNew->aLTerm[pNew->nLTerm++] = 0;
  128816. pNew->wsFlags |= WHERE_SKIPSCAN;
  128817. nIter = pProbe->aiRowLogEst[saved_nEq] - pProbe->aiRowLogEst[saved_nEq+1];
  128818. pNew->nOut -= nIter;
  128819. /* TUNING: Because uncertainties in the estimates for skip-scan queries,
  128820. ** add a 1.375 fudge factor to make skip-scan slightly less likely. */
  128821. nIter += 5;
  128822. whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, nIter + nInMul);
  128823. pNew->nOut = saved_nOut;
  128824. pNew->u.btree.nEq = saved_nEq;
  128825. pNew->nSkip = saved_nSkip;
  128826. pNew->wsFlags = saved_wsFlags;
  128827. }
  128828. WHERETRACE(0x800, ("END %s.addBtreeIdx(%s), nEq=%d, rc=%d\n",
  128829. pProbe->pTable->zName, pProbe->zName, saved_nEq, rc));
  128830. return rc;
  128831. }
  128832. /*
  128833. ** Return True if it is possible that pIndex might be useful in
  128834. ** implementing the ORDER BY clause in pBuilder.
  128835. **
  128836. ** Return False if pBuilder does not contain an ORDER BY clause or
  128837. ** if there is no way for pIndex to be useful in implementing that
  128838. ** ORDER BY clause.
  128839. */
  128840. static int indexMightHelpWithOrderBy(
  128841. WhereLoopBuilder *pBuilder,
  128842. Index *pIndex,
  128843. int iCursor
  128844. ){
  128845. ExprList *pOB;
  128846. ExprList *aColExpr;
  128847. int ii, jj;
  128848. if( pIndex->bUnordered ) return 0;
  128849. if( (pOB = pBuilder->pWInfo->pOrderBy)==0 ) return 0;
  128850. for(ii=0; ii<pOB->nExpr; ii++){
  128851. Expr *pExpr = sqlite3ExprSkipCollate(pOB->a[ii].pExpr);
  128852. if( pExpr->op==TK_COLUMN && pExpr->iTable==iCursor ){
  128853. if( pExpr->iColumn<0 ) return 1;
  128854. for(jj=0; jj<pIndex->nKeyCol; jj++){
  128855. if( pExpr->iColumn==pIndex->aiColumn[jj] ) return 1;
  128856. }
  128857. }else if( (aColExpr = pIndex->aColExpr)!=0 ){
  128858. for(jj=0; jj<pIndex->nKeyCol; jj++){
  128859. if( pIndex->aiColumn[jj]!=XN_EXPR ) continue;
  128860. if( sqlite3ExprCompareSkip(pExpr,aColExpr->a[jj].pExpr,iCursor)==0 ){
  128861. return 1;
  128862. }
  128863. }
  128864. }
  128865. }
  128866. return 0;
  128867. }
  128868. /*
  128869. ** Return a bitmask where 1s indicate that the corresponding column of
  128870. ** the table is used by an index. Only the first 63 columns are considered.
  128871. */
  128872. static Bitmask columnsInIndex(Index *pIdx){
  128873. Bitmask m = 0;
  128874. int j;
  128875. for(j=pIdx->nColumn-1; j>=0; j--){
  128876. int x = pIdx->aiColumn[j];
  128877. if( x>=0 ){
  128878. testcase( x==BMS-1 );
  128879. testcase( x==BMS-2 );
  128880. if( x<BMS-1 ) m |= MASKBIT(x);
  128881. }
  128882. }
  128883. return m;
  128884. }
  128885. /* Check to see if a partial index with pPartIndexWhere can be used
  128886. ** in the current query. Return true if it can be and false if not.
  128887. */
  128888. static int whereUsablePartialIndex(int iTab, WhereClause *pWC, Expr *pWhere){
  128889. int i;
  128890. WhereTerm *pTerm;
  128891. Parse *pParse = pWC->pWInfo->pParse;
  128892. while( pWhere->op==TK_AND ){
  128893. if( !whereUsablePartialIndex(iTab,pWC,pWhere->pLeft) ) return 0;
  128894. pWhere = pWhere->pRight;
  128895. }
  128896. if( pParse->db->flags & SQLITE_EnableQPSG ) pParse = 0;
  128897. for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
  128898. Expr *pExpr = pTerm->pExpr;
  128899. if( (!ExprHasProperty(pExpr, EP_FromJoin) || pExpr->iRightJoinTable==iTab)
  128900. && sqlite3ExprImpliesExpr(pParse, pExpr, pWhere, iTab)
  128901. ){
  128902. return 1;
  128903. }
  128904. }
  128905. return 0;
  128906. }
  128907. /*
  128908. ** Add all WhereLoop objects for a single table of the join where the table
  128909. ** is identified by pBuilder->pNew->iTab. That table is guaranteed to be
  128910. ** a b-tree table, not a virtual table.
  128911. **
  128912. ** The costs (WhereLoop.rRun) of the b-tree loops added by this function
  128913. ** are calculated as follows:
  128914. **
  128915. ** For a full scan, assuming the table (or index) contains nRow rows:
  128916. **
  128917. ** cost = nRow * 3.0 // full-table scan
  128918. ** cost = nRow * K // scan of covering index
  128919. ** cost = nRow * (K+3.0) // scan of non-covering index
  128920. **
  128921. ** where K is a value between 1.1 and 3.0 set based on the relative
  128922. ** estimated average size of the index and table records.
  128923. **
  128924. ** For an index scan, where nVisit is the number of index rows visited
  128925. ** by the scan, and nSeek is the number of seek operations required on
  128926. ** the index b-tree:
  128927. **
  128928. ** cost = nSeek * (log(nRow) + K * nVisit) // covering index
  128929. ** cost = nSeek * (log(nRow) + (K+3.0) * nVisit) // non-covering index
  128930. **
  128931. ** Normally, nSeek is 1. nSeek values greater than 1 come about if the
  128932. ** WHERE clause includes "x IN (....)" terms used in place of "x=?". Or when
  128933. ** implicit "x IN (SELECT x FROM tbl)" terms are added for skip-scans.
  128934. **
  128935. ** The estimated values (nRow, nVisit, nSeek) often contain a large amount
  128936. ** of uncertainty. For this reason, scoring is designed to pick plans that
  128937. ** "do the least harm" if the estimates are inaccurate. For example, a
  128938. ** log(nRow) factor is omitted from a non-covering index scan in order to
  128939. ** bias the scoring in favor of using an index, since the worst-case
  128940. ** performance of using an index is far better than the worst-case performance
  128941. ** of a full table scan.
  128942. */
  128943. static int whereLoopAddBtree(
  128944. WhereLoopBuilder *pBuilder, /* WHERE clause information */
  128945. Bitmask mPrereq /* Extra prerequesites for using this table */
  128946. ){
  128947. WhereInfo *pWInfo; /* WHERE analysis context */
  128948. Index *pProbe; /* An index we are evaluating */
  128949. Index sPk; /* A fake index object for the primary key */
  128950. LogEst aiRowEstPk[2]; /* The aiRowLogEst[] value for the sPk index */
  128951. i16 aiColumnPk = -1; /* The aColumn[] value for the sPk index */
  128952. SrcList *pTabList; /* The FROM clause */
  128953. struct SrcList_item *pSrc; /* The FROM clause btree term to add */
  128954. WhereLoop *pNew; /* Template WhereLoop object */
  128955. int rc = SQLITE_OK; /* Return code */
  128956. int iSortIdx = 1; /* Index number */
  128957. int b; /* A boolean value */
  128958. LogEst rSize; /* number of rows in the table */
  128959. LogEst rLogSize; /* Logarithm of the number of rows in the table */
  128960. WhereClause *pWC; /* The parsed WHERE clause */
  128961. Table *pTab; /* Table being queried */
  128962. pNew = pBuilder->pNew;
  128963. pWInfo = pBuilder->pWInfo;
  128964. pTabList = pWInfo->pTabList;
  128965. pSrc = pTabList->a + pNew->iTab;
  128966. pTab = pSrc->pTab;
  128967. pWC = pBuilder->pWC;
  128968. assert( !IsVirtual(pSrc->pTab) );
  128969. if( pSrc->pIBIndex ){
  128970. /* An INDEXED BY clause specifies a particular index to use */
  128971. pProbe = pSrc->pIBIndex;
  128972. }else if( !HasRowid(pTab) ){
  128973. pProbe = pTab->pIndex;
  128974. }else{
  128975. /* There is no INDEXED BY clause. Create a fake Index object in local
  128976. ** variable sPk to represent the rowid primary key index. Make this
  128977. ** fake index the first in a chain of Index objects with all of the real
  128978. ** indices to follow */
  128979. Index *pFirst; /* First of real indices on the table */
  128980. memset(&sPk, 0, sizeof(Index));
  128981. sPk.nKeyCol = 1;
  128982. sPk.nColumn = 1;
  128983. sPk.aiColumn = &aiColumnPk;
  128984. sPk.aiRowLogEst = aiRowEstPk;
  128985. sPk.onError = OE_Replace;
  128986. sPk.pTable = pTab;
  128987. sPk.szIdxRow = pTab->szTabRow;
  128988. aiRowEstPk[0] = pTab->nRowLogEst;
  128989. aiRowEstPk[1] = 0;
  128990. pFirst = pSrc->pTab->pIndex;
  128991. if( pSrc->fg.notIndexed==0 ){
  128992. /* The real indices of the table are only considered if the
  128993. ** NOT INDEXED qualifier is omitted from the FROM clause */
  128994. sPk.pNext = pFirst;
  128995. }
  128996. pProbe = &sPk;
  128997. }
  128998. rSize = pTab->nRowLogEst;
  128999. rLogSize = estLog(rSize);
  129000. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  129001. /* Automatic indexes */
  129002. if( !pBuilder->pOrSet /* Not part of an OR optimization */
  129003. && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  129004. && (pWInfo->pParse->db->flags & SQLITE_AutoIndex)!=0
  129005. && pSrc->pIBIndex==0 /* Has no INDEXED BY clause */
  129006. && !pSrc->fg.notIndexed /* Has no NOT INDEXED clause */
  129007. && HasRowid(pTab) /* Not WITHOUT ROWID table. (FIXME: Why not?) */
  129008. && !pSrc->fg.isCorrelated /* Not a correlated subquery */
  129009. && !pSrc->fg.isRecursive /* Not a recursive common table expression. */
  129010. ){
  129011. /* Generate auto-index WhereLoops */
  129012. WhereTerm *pTerm;
  129013. WhereTerm *pWCEnd = pWC->a + pWC->nTerm;
  129014. for(pTerm=pWC->a; rc==SQLITE_OK && pTerm<pWCEnd; pTerm++){
  129015. if( pTerm->prereqRight & pNew->maskSelf ) continue;
  129016. if( termCanDriveIndex(pTerm, pSrc, 0) ){
  129017. pNew->u.btree.nEq = 1;
  129018. pNew->nSkip = 0;
  129019. pNew->u.btree.pIndex = 0;
  129020. pNew->nLTerm = 1;
  129021. pNew->aLTerm[0] = pTerm;
  129022. /* TUNING: One-time cost for computing the automatic index is
  129023. ** estimated to be X*N*log2(N) where N is the number of rows in
  129024. ** the table being indexed and where X is 7 (LogEst=28) for normal
  129025. ** tables or 1.375 (LogEst=4) for views and subqueries. The value
  129026. ** of X is smaller for views and subqueries so that the query planner
  129027. ** will be more aggressive about generating automatic indexes for
  129028. ** those objects, since there is no opportunity to add schema
  129029. ** indexes on subqueries and views. */
  129030. pNew->rSetup = rLogSize + rSize + 4;
  129031. if( pTab->pSelect==0 && (pTab->tabFlags & TF_Ephemeral)==0 ){
  129032. pNew->rSetup += 24;
  129033. }
  129034. ApplyCostMultiplier(pNew->rSetup, pTab->costMult);
  129035. if( pNew->rSetup<0 ) pNew->rSetup = 0;
  129036. /* TUNING: Each index lookup yields 20 rows in the table. This
  129037. ** is more than the usual guess of 10 rows, since we have no way
  129038. ** of knowing how selective the index will ultimately be. It would
  129039. ** not be unreasonable to make this value much larger. */
  129040. pNew->nOut = 43; assert( 43==sqlite3LogEst(20) );
  129041. pNew->rRun = sqlite3LogEstAdd(rLogSize,pNew->nOut);
  129042. pNew->wsFlags = WHERE_AUTO_INDEX;
  129043. pNew->prereq = mPrereq | pTerm->prereqRight;
  129044. rc = whereLoopInsert(pBuilder, pNew);
  129045. }
  129046. }
  129047. }
  129048. #endif /* SQLITE_OMIT_AUTOMATIC_INDEX */
  129049. /* Loop over all indices. If there was an INDEXED BY clause, then only
  129050. ** consider index pProbe. */
  129051. for(; rc==SQLITE_OK && pProbe;
  129052. pProbe=(pSrc->pIBIndex ? 0 : pProbe->pNext), iSortIdx++
  129053. ){
  129054. if( pProbe->pPartIdxWhere!=0
  129055. && !whereUsablePartialIndex(pSrc->iCursor, pWC, pProbe->pPartIdxWhere) ){
  129056. testcase( pNew->iTab!=pSrc->iCursor ); /* See ticket [98d973b8f5] */
  129057. continue; /* Partial index inappropriate for this query */
  129058. }
  129059. if( pProbe->bNoQuery ) continue;
  129060. rSize = pProbe->aiRowLogEst[0];
  129061. pNew->u.btree.nEq = 0;
  129062. pNew->u.btree.nBtm = 0;
  129063. pNew->u.btree.nTop = 0;
  129064. pNew->nSkip = 0;
  129065. pNew->nLTerm = 0;
  129066. pNew->iSortIdx = 0;
  129067. pNew->rSetup = 0;
  129068. pNew->prereq = mPrereq;
  129069. pNew->nOut = rSize;
  129070. pNew->u.btree.pIndex = pProbe;
  129071. b = indexMightHelpWithOrderBy(pBuilder, pProbe, pSrc->iCursor);
  129072. /* The ONEPASS_DESIRED flags never occurs together with ORDER BY */
  129073. assert( (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || b==0 );
  129074. if( pProbe->tnum<=0 ){
  129075. /* Integer primary key index */
  129076. pNew->wsFlags = WHERE_IPK;
  129077. /* Full table scan */
  129078. pNew->iSortIdx = b ? iSortIdx : 0;
  129079. /* TUNING: Cost of full table scan is (N*3.0). */
  129080. pNew->rRun = rSize + 16;
  129081. ApplyCostMultiplier(pNew->rRun, pTab->costMult);
  129082. whereLoopOutputAdjust(pWC, pNew, rSize);
  129083. rc = whereLoopInsert(pBuilder, pNew);
  129084. pNew->nOut = rSize;
  129085. if( rc ) break;
  129086. }else{
  129087. Bitmask m;
  129088. if( pProbe->isCovering ){
  129089. pNew->wsFlags = WHERE_IDX_ONLY | WHERE_INDEXED;
  129090. m = 0;
  129091. }else{
  129092. m = pSrc->colUsed & ~columnsInIndex(pProbe);
  129093. pNew->wsFlags = (m==0) ? (WHERE_IDX_ONLY|WHERE_INDEXED) : WHERE_INDEXED;
  129094. }
  129095. /* Full scan via index */
  129096. if( b
  129097. || !HasRowid(pTab)
  129098. || pProbe->pPartIdxWhere!=0
  129099. || ( m==0
  129100. && pProbe->bUnordered==0
  129101. && (pProbe->szIdxRow<pTab->szTabRow)
  129102. && (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0
  129103. && sqlite3GlobalConfig.bUseCis
  129104. && OptimizationEnabled(pWInfo->pParse->db, SQLITE_CoverIdxScan)
  129105. )
  129106. ){
  129107. pNew->iSortIdx = b ? iSortIdx : 0;
  129108. /* The cost of visiting the index rows is N*K, where K is
  129109. ** between 1.1 and 3.0, depending on the relative sizes of the
  129110. ** index and table rows. */
  129111. pNew->rRun = rSize + 1 + (15*pProbe->szIdxRow)/pTab->szTabRow;
  129112. if( m!=0 ){
  129113. /* If this is a non-covering index scan, add in the cost of
  129114. ** doing table lookups. The cost will be 3x the number of
  129115. ** lookups. Take into account WHERE clause terms that can be
  129116. ** satisfied using just the index, and that do not require a
  129117. ** table lookup. */
  129118. LogEst nLookup = rSize + 16; /* Base cost: N*3 */
  129119. int ii;
  129120. int iCur = pSrc->iCursor;
  129121. WhereClause *pWC2 = &pWInfo->sWC;
  129122. for(ii=0; ii<pWC2->nTerm; ii++){
  129123. WhereTerm *pTerm = &pWC2->a[ii];
  129124. if( !sqlite3ExprCoveredByIndex(pTerm->pExpr, iCur, pProbe) ){
  129125. break;
  129126. }
  129127. /* pTerm can be evaluated using just the index. So reduce
  129128. ** the expected number of table lookups accordingly */
  129129. if( pTerm->truthProb<=0 ){
  129130. nLookup += pTerm->truthProb;
  129131. }else{
  129132. nLookup--;
  129133. if( pTerm->eOperator & (WO_EQ|WO_IS) ) nLookup -= 19;
  129134. }
  129135. }
  129136. pNew->rRun = sqlite3LogEstAdd(pNew->rRun, nLookup);
  129137. }
  129138. ApplyCostMultiplier(pNew->rRun, pTab->costMult);
  129139. whereLoopOutputAdjust(pWC, pNew, rSize);
  129140. rc = whereLoopInsert(pBuilder, pNew);
  129141. pNew->nOut = rSize;
  129142. if( rc ) break;
  129143. }
  129144. }
  129145. pBuilder->bldFlags = 0;
  129146. rc = whereLoopAddBtreeIndex(pBuilder, pSrc, pProbe, 0);
  129147. if( pBuilder->bldFlags==SQLITE_BLDF_INDEXED ){
  129148. /* If a non-unique index is used, or if a prefix of the key for
  129149. ** unique index is used (making the index functionally non-unique)
  129150. ** then the sqlite_stat1 data becomes important for scoring the
  129151. ** plan */
  129152. pTab->tabFlags |= TF_StatsUsed;
  129153. }
  129154. #ifdef SQLITE_ENABLE_STAT3_OR_STAT4
  129155. sqlite3Stat4ProbeFree(pBuilder->pRec);
  129156. pBuilder->nRecValid = 0;
  129157. pBuilder->pRec = 0;
  129158. #endif
  129159. }
  129160. return rc;
  129161. }
  129162. #ifndef SQLITE_OMIT_VIRTUALTABLE
  129163. /*
  129164. ** Argument pIdxInfo is already populated with all constraints that may
  129165. ** be used by the virtual table identified by pBuilder->pNew->iTab. This
  129166. ** function marks a subset of those constraints usable, invokes the
  129167. ** xBestIndex method and adds the returned plan to pBuilder.
  129168. **
  129169. ** A constraint is marked usable if:
  129170. **
  129171. ** * Argument mUsable indicates that its prerequisites are available, and
  129172. **
  129173. ** * It is not one of the operators specified in the mExclude mask passed
  129174. ** as the fourth argument (which in practice is either WO_IN or 0).
  129175. **
  129176. ** Argument mPrereq is a mask of tables that must be scanned before the
  129177. ** virtual table in question. These are added to the plans prerequisites
  129178. ** before it is added to pBuilder.
  129179. **
  129180. ** Output parameter *pbIn is set to true if the plan added to pBuilder
  129181. ** uses one or more WO_IN terms, or false otherwise.
  129182. */
  129183. static int whereLoopAddVirtualOne(
  129184. WhereLoopBuilder *pBuilder,
  129185. Bitmask mPrereq, /* Mask of tables that must be used. */
  129186. Bitmask mUsable, /* Mask of usable tables */
  129187. u16 mExclude, /* Exclude terms using these operators */
  129188. sqlite3_index_info *pIdxInfo, /* Populated object for xBestIndex */
  129189. u16 mNoOmit, /* Do not omit these constraints */
  129190. int *pbIn /* OUT: True if plan uses an IN(...) op */
  129191. ){
  129192. WhereClause *pWC = pBuilder->pWC;
  129193. struct sqlite3_index_constraint *pIdxCons;
  129194. struct sqlite3_index_constraint_usage *pUsage = pIdxInfo->aConstraintUsage;
  129195. int i;
  129196. int mxTerm;
  129197. int rc = SQLITE_OK;
  129198. WhereLoop *pNew = pBuilder->pNew;
  129199. Parse *pParse = pBuilder->pWInfo->pParse;
  129200. struct SrcList_item *pSrc = &pBuilder->pWInfo->pTabList->a[pNew->iTab];
  129201. int nConstraint = pIdxInfo->nConstraint;
  129202. assert( (mUsable & mPrereq)==mPrereq );
  129203. *pbIn = 0;
  129204. pNew->prereq = mPrereq;
  129205. /* Set the usable flag on the subset of constraints identified by
  129206. ** arguments mUsable and mExclude. */
  129207. pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
  129208. for(i=0; i<nConstraint; i++, pIdxCons++){
  129209. WhereTerm *pTerm = &pWC->a[pIdxCons->iTermOffset];
  129210. pIdxCons->usable = 0;
  129211. if( (pTerm->prereqRight & mUsable)==pTerm->prereqRight
  129212. && (pTerm->eOperator & mExclude)==0
  129213. ){
  129214. pIdxCons->usable = 1;
  129215. }
  129216. }
  129217. /* Initialize the output fields of the sqlite3_index_info structure */
  129218. memset(pUsage, 0, sizeof(pUsage[0])*nConstraint);
  129219. assert( pIdxInfo->needToFreeIdxStr==0 );
  129220. pIdxInfo->idxStr = 0;
  129221. pIdxInfo->idxNum = 0;
  129222. pIdxInfo->orderByConsumed = 0;
  129223. pIdxInfo->estimatedCost = SQLITE_BIG_DBL / (double)2;
  129224. pIdxInfo->estimatedRows = 25;
  129225. pIdxInfo->idxFlags = 0;
  129226. pIdxInfo->colUsed = (sqlite3_int64)pSrc->colUsed;
  129227. /* Invoke the virtual table xBestIndex() method */
  129228. rc = vtabBestIndex(pParse, pSrc->pTab, pIdxInfo);
  129229. if( rc ) return rc;
  129230. mxTerm = -1;
  129231. assert( pNew->nLSlot>=nConstraint );
  129232. for(i=0; i<nConstraint; i++) pNew->aLTerm[i] = 0;
  129233. pNew->u.vtab.omitMask = 0;
  129234. pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
  129235. for(i=0; i<nConstraint; i++, pIdxCons++){
  129236. int iTerm;
  129237. if( (iTerm = pUsage[i].argvIndex - 1)>=0 ){
  129238. WhereTerm *pTerm;
  129239. int j = pIdxCons->iTermOffset;
  129240. if( iTerm>=nConstraint
  129241. || j<0
  129242. || j>=pWC->nTerm
  129243. || pNew->aLTerm[iTerm]!=0
  129244. || pIdxCons->usable==0
  129245. ){
  129246. sqlite3ErrorMsg(pParse,"%s.xBestIndex malfunction",pSrc->pTab->zName);
  129247. testcase( pIdxInfo->needToFreeIdxStr );
  129248. return SQLITE_ERROR;
  129249. }
  129250. testcase( iTerm==nConstraint-1 );
  129251. testcase( j==0 );
  129252. testcase( j==pWC->nTerm-1 );
  129253. pTerm = &pWC->a[j];
  129254. pNew->prereq |= pTerm->prereqRight;
  129255. assert( iTerm<pNew->nLSlot );
  129256. pNew->aLTerm[iTerm] = pTerm;
  129257. if( iTerm>mxTerm ) mxTerm = iTerm;
  129258. testcase( iTerm==15 );
  129259. testcase( iTerm==16 );
  129260. if( iTerm<16 && pUsage[i].omit ) pNew->u.vtab.omitMask |= 1<<iTerm;
  129261. if( (pTerm->eOperator & WO_IN)!=0 ){
  129262. /* A virtual table that is constrained by an IN clause may not
  129263. ** consume the ORDER BY clause because (1) the order of IN terms
  129264. ** is not necessarily related to the order of output terms and
  129265. ** (2) Multiple outputs from a single IN value will not merge
  129266. ** together. */
  129267. pIdxInfo->orderByConsumed = 0;
  129268. pIdxInfo->idxFlags &= ~SQLITE_INDEX_SCAN_UNIQUE;
  129269. *pbIn = 1; assert( (mExclude & WO_IN)==0 );
  129270. }
  129271. }
  129272. }
  129273. pNew->u.vtab.omitMask &= ~mNoOmit;
  129274. pNew->nLTerm = mxTerm+1;
  129275. for(i=0; i<=mxTerm; i++){
  129276. if( pNew->aLTerm[i]==0 ){
  129277. /* The non-zero argvIdx values must be contiguous. Raise an
  129278. ** error if they are not */
  129279. sqlite3ErrorMsg(pParse,"%s.xBestIndex malfunction",pSrc->pTab->zName);
  129280. testcase( pIdxInfo->needToFreeIdxStr );
  129281. return SQLITE_ERROR;
  129282. }
  129283. }
  129284. assert( pNew->nLTerm<=pNew->nLSlot );
  129285. pNew->u.vtab.idxNum = pIdxInfo->idxNum;
  129286. pNew->u.vtab.needFree = pIdxInfo->needToFreeIdxStr;
  129287. pIdxInfo->needToFreeIdxStr = 0;
  129288. pNew->u.vtab.idxStr = pIdxInfo->idxStr;
  129289. pNew->u.vtab.isOrdered = (i8)(pIdxInfo->orderByConsumed ?
  129290. pIdxInfo->nOrderBy : 0);
  129291. pNew->rSetup = 0;
  129292. pNew->rRun = sqlite3LogEstFromDouble(pIdxInfo->estimatedCost);
  129293. pNew->nOut = sqlite3LogEst(pIdxInfo->estimatedRows);
  129294. /* Set the WHERE_ONEROW flag if the xBestIndex() method indicated
  129295. ** that the scan will visit at most one row. Clear it otherwise. */
  129296. if( pIdxInfo->idxFlags & SQLITE_INDEX_SCAN_UNIQUE ){
  129297. pNew->wsFlags |= WHERE_ONEROW;
  129298. }else{
  129299. pNew->wsFlags &= ~WHERE_ONEROW;
  129300. }
  129301. rc = whereLoopInsert(pBuilder, pNew);
  129302. if( pNew->u.vtab.needFree ){
  129303. sqlite3_free(pNew->u.vtab.idxStr);
  129304. pNew->u.vtab.needFree = 0;
  129305. }
  129306. WHERETRACE(0xffff, (" bIn=%d prereqIn=%04llx prereqOut=%04llx\n",
  129307. *pbIn, (sqlite3_uint64)mPrereq,
  129308. (sqlite3_uint64)(pNew->prereq & ~mPrereq)));
  129309. return rc;
  129310. }
  129311. /*
  129312. ** If this function is invoked from within an xBestIndex() callback, it
  129313. ** returns a pointer to a buffer containing the name of the collation
  129314. ** sequence associated with element iCons of the sqlite3_index_info.aConstraint
  129315. ** array. Or, if iCons is out of range or there is no active xBestIndex
  129316. ** call, return NULL.
  129317. */
  129318. SQLITE_API const char *sqlite3_vtab_collation(sqlite3_index_info *pIdxInfo, int iCons){
  129319. HiddenIndexInfo *pHidden = (HiddenIndexInfo*)&pIdxInfo[1];
  129320. const char *zRet = 0;
  129321. if( iCons>=0 && iCons<pIdxInfo->nConstraint ){
  129322. CollSeq *pC = 0;
  129323. int iTerm = pIdxInfo->aConstraint[iCons].iTermOffset;
  129324. Expr *pX = pHidden->pWC->a[iTerm].pExpr;
  129325. if( pX->pLeft ){
  129326. pC = sqlite3BinaryCompareCollSeq(pHidden->pParse, pX->pLeft, pX->pRight);
  129327. }
  129328. zRet = (pC ? pC->zName : "BINARY");
  129329. }
  129330. return zRet;
  129331. }
  129332. /*
  129333. ** Add all WhereLoop objects for a table of the join identified by
  129334. ** pBuilder->pNew->iTab. That table is guaranteed to be a virtual table.
  129335. **
  129336. ** If there are no LEFT or CROSS JOIN joins in the query, both mPrereq and
  129337. ** mUnusable are set to 0. Otherwise, mPrereq is a mask of all FROM clause
  129338. ** entries that occur before the virtual table in the FROM clause and are
  129339. ** separated from it by at least one LEFT or CROSS JOIN. Similarly, the
  129340. ** mUnusable mask contains all FROM clause entries that occur after the
  129341. ** virtual table and are separated from it by at least one LEFT or
  129342. ** CROSS JOIN.
  129343. **
  129344. ** For example, if the query were:
  129345. **
  129346. ** ... FROM t1, t2 LEFT JOIN t3, t4, vt CROSS JOIN t5, t6;
  129347. **
  129348. ** then mPrereq corresponds to (t1, t2) and mUnusable to (t5, t6).
  129349. **
  129350. ** All the tables in mPrereq must be scanned before the current virtual
  129351. ** table. So any terms for which all prerequisites are satisfied by
  129352. ** mPrereq may be specified as "usable" in all calls to xBestIndex.
  129353. ** Conversely, all tables in mUnusable must be scanned after the current
  129354. ** virtual table, so any terms for which the prerequisites overlap with
  129355. ** mUnusable should always be configured as "not-usable" for xBestIndex.
  129356. */
  129357. static int whereLoopAddVirtual(
  129358. WhereLoopBuilder *pBuilder, /* WHERE clause information */
  129359. Bitmask mPrereq, /* Tables that must be scanned before this one */
  129360. Bitmask mUnusable /* Tables that must be scanned after this one */
  129361. ){
  129362. int rc = SQLITE_OK; /* Return code */
  129363. WhereInfo *pWInfo; /* WHERE analysis context */
  129364. Parse *pParse; /* The parsing context */
  129365. WhereClause *pWC; /* The WHERE clause */
  129366. struct SrcList_item *pSrc; /* The FROM clause term to search */
  129367. sqlite3_index_info *p; /* Object to pass to xBestIndex() */
  129368. int nConstraint; /* Number of constraints in p */
  129369. int bIn; /* True if plan uses IN(...) operator */
  129370. WhereLoop *pNew;
  129371. Bitmask mBest; /* Tables used by best possible plan */
  129372. u16 mNoOmit;
  129373. assert( (mPrereq & mUnusable)==0 );
  129374. pWInfo = pBuilder->pWInfo;
  129375. pParse = pWInfo->pParse;
  129376. pWC = pBuilder->pWC;
  129377. pNew = pBuilder->pNew;
  129378. pSrc = &pWInfo->pTabList->a[pNew->iTab];
  129379. assert( IsVirtual(pSrc->pTab) );
  129380. p = allocateIndexInfo(pParse, pWC, mUnusable, pSrc, pBuilder->pOrderBy,
  129381. &mNoOmit);
  129382. if( p==0 ) return SQLITE_NOMEM_BKPT;
  129383. pNew->rSetup = 0;
  129384. pNew->wsFlags = WHERE_VIRTUALTABLE;
  129385. pNew->nLTerm = 0;
  129386. pNew->u.vtab.needFree = 0;
  129387. nConstraint = p->nConstraint;
  129388. if( whereLoopResize(pParse->db, pNew, nConstraint) ){
  129389. sqlite3DbFree(pParse->db, p);
  129390. return SQLITE_NOMEM_BKPT;
  129391. }
  129392. /* First call xBestIndex() with all constraints usable. */
  129393. WHERETRACE(0x800, ("BEGIN %s.addVirtual()\n", pSrc->pTab->zName));
  129394. WHERETRACE(0x40, (" VirtualOne: all usable\n"));
  129395. rc = whereLoopAddVirtualOne(pBuilder, mPrereq, ALLBITS, 0, p, mNoOmit, &bIn);
  129396. /* If the call to xBestIndex() with all terms enabled produced a plan
  129397. ** that does not require any source tables (IOW: a plan with mBest==0),
  129398. ** then there is no point in making any further calls to xBestIndex()
  129399. ** since they will all return the same result (if the xBestIndex()
  129400. ** implementation is sane). */
  129401. if( rc==SQLITE_OK && (mBest = (pNew->prereq & ~mPrereq))!=0 ){
  129402. int seenZero = 0; /* True if a plan with no prereqs seen */
  129403. int seenZeroNoIN = 0; /* Plan with no prereqs and no IN(...) seen */
  129404. Bitmask mPrev = 0;
  129405. Bitmask mBestNoIn = 0;
  129406. /* If the plan produced by the earlier call uses an IN(...) term, call
  129407. ** xBestIndex again, this time with IN(...) terms disabled. */
  129408. if( bIn ){
  129409. WHERETRACE(0x40, (" VirtualOne: all usable w/o IN\n"));
  129410. rc = whereLoopAddVirtualOne(
  129411. pBuilder, mPrereq, ALLBITS, WO_IN, p, mNoOmit, &bIn);
  129412. assert( bIn==0 );
  129413. mBestNoIn = pNew->prereq & ~mPrereq;
  129414. if( mBestNoIn==0 ){
  129415. seenZero = 1;
  129416. seenZeroNoIN = 1;
  129417. }
  129418. }
  129419. /* Call xBestIndex once for each distinct value of (prereqRight & ~mPrereq)
  129420. ** in the set of terms that apply to the current virtual table. */
  129421. while( rc==SQLITE_OK ){
  129422. int i;
  129423. Bitmask mNext = ALLBITS;
  129424. assert( mNext>0 );
  129425. for(i=0; i<nConstraint; i++){
  129426. Bitmask mThis = (
  129427. pWC->a[p->aConstraint[i].iTermOffset].prereqRight & ~mPrereq
  129428. );
  129429. if( mThis>mPrev && mThis<mNext ) mNext = mThis;
  129430. }
  129431. mPrev = mNext;
  129432. if( mNext==ALLBITS ) break;
  129433. if( mNext==mBest || mNext==mBestNoIn ) continue;
  129434. WHERETRACE(0x40, (" VirtualOne: mPrev=%04llx mNext=%04llx\n",
  129435. (sqlite3_uint64)mPrev, (sqlite3_uint64)mNext));
  129436. rc = whereLoopAddVirtualOne(
  129437. pBuilder, mPrereq, mNext|mPrereq, 0, p, mNoOmit, &bIn);
  129438. if( pNew->prereq==mPrereq ){
  129439. seenZero = 1;
  129440. if( bIn==0 ) seenZeroNoIN = 1;
  129441. }
  129442. }
  129443. /* If the calls to xBestIndex() in the above loop did not find a plan
  129444. ** that requires no source tables at all (i.e. one guaranteed to be
  129445. ** usable), make a call here with all source tables disabled */
  129446. if( rc==SQLITE_OK && seenZero==0 ){
  129447. WHERETRACE(0x40, (" VirtualOne: all disabled\n"));
  129448. rc = whereLoopAddVirtualOne(
  129449. pBuilder, mPrereq, mPrereq, 0, p, mNoOmit, &bIn);
  129450. if( bIn==0 ) seenZeroNoIN = 1;
  129451. }
  129452. /* If the calls to xBestIndex() have so far failed to find a plan
  129453. ** that requires no source tables at all and does not use an IN(...)
  129454. ** operator, make a final call to obtain one here. */
  129455. if( rc==SQLITE_OK && seenZeroNoIN==0 ){
  129456. WHERETRACE(0x40, (" VirtualOne: all disabled and w/o IN\n"));
  129457. rc = whereLoopAddVirtualOne(
  129458. pBuilder, mPrereq, mPrereq, WO_IN, p, mNoOmit, &bIn);
  129459. }
  129460. }
  129461. if( p->needToFreeIdxStr ) sqlite3_free(p->idxStr);
  129462. sqlite3DbFreeNN(pParse->db, p);
  129463. WHERETRACE(0x800, ("END %s.addVirtual(), rc=%d\n", pSrc->pTab->zName, rc));
  129464. return rc;
  129465. }
  129466. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  129467. /*
  129468. ** Add WhereLoop entries to handle OR terms. This works for either
  129469. ** btrees or virtual tables.
  129470. */
  129471. static int whereLoopAddOr(
  129472. WhereLoopBuilder *pBuilder,
  129473. Bitmask mPrereq,
  129474. Bitmask mUnusable
  129475. ){
  129476. WhereInfo *pWInfo = pBuilder->pWInfo;
  129477. WhereClause *pWC;
  129478. WhereLoop *pNew;
  129479. WhereTerm *pTerm, *pWCEnd;
  129480. int rc = SQLITE_OK;
  129481. int iCur;
  129482. WhereClause tempWC;
  129483. WhereLoopBuilder sSubBuild;
  129484. WhereOrSet sSum, sCur;
  129485. struct SrcList_item *pItem;
  129486. pWC = pBuilder->pWC;
  129487. pWCEnd = pWC->a + pWC->nTerm;
  129488. pNew = pBuilder->pNew;
  129489. memset(&sSum, 0, sizeof(sSum));
  129490. pItem = pWInfo->pTabList->a + pNew->iTab;
  129491. iCur = pItem->iCursor;
  129492. for(pTerm=pWC->a; pTerm<pWCEnd && rc==SQLITE_OK; pTerm++){
  129493. if( (pTerm->eOperator & WO_OR)!=0
  129494. && (pTerm->u.pOrInfo->indexable & pNew->maskSelf)!=0
  129495. ){
  129496. WhereClause * const pOrWC = &pTerm->u.pOrInfo->wc;
  129497. WhereTerm * const pOrWCEnd = &pOrWC->a[pOrWC->nTerm];
  129498. WhereTerm *pOrTerm;
  129499. int once = 1;
  129500. int i, j;
  129501. sSubBuild = *pBuilder;
  129502. sSubBuild.pOrderBy = 0;
  129503. sSubBuild.pOrSet = &sCur;
  129504. WHERETRACE(0x200, ("Begin processing OR-clause %p\n", pTerm));
  129505. for(pOrTerm=pOrWC->a; pOrTerm<pOrWCEnd; pOrTerm++){
  129506. if( (pOrTerm->eOperator & WO_AND)!=0 ){
  129507. sSubBuild.pWC = &pOrTerm->u.pAndInfo->wc;
  129508. }else if( pOrTerm->leftCursor==iCur ){
  129509. tempWC.pWInfo = pWC->pWInfo;
  129510. tempWC.pOuter = pWC;
  129511. tempWC.op = TK_AND;
  129512. tempWC.nTerm = 1;
  129513. tempWC.a = pOrTerm;
  129514. sSubBuild.pWC = &tempWC;
  129515. }else{
  129516. continue;
  129517. }
  129518. sCur.n = 0;
  129519. #ifdef WHERETRACE_ENABLED
  129520. WHERETRACE(0x200, ("OR-term %d of %p has %d subterms:\n",
  129521. (int)(pOrTerm-pOrWC->a), pTerm, sSubBuild.pWC->nTerm));
  129522. if( sqlite3WhereTrace & 0x400 ){
  129523. sqlite3WhereClausePrint(sSubBuild.pWC);
  129524. }
  129525. #endif
  129526. #ifndef SQLITE_OMIT_VIRTUALTABLE
  129527. if( IsVirtual(pItem->pTab) ){
  129528. rc = whereLoopAddVirtual(&sSubBuild, mPrereq, mUnusable);
  129529. }else
  129530. #endif
  129531. {
  129532. rc = whereLoopAddBtree(&sSubBuild, mPrereq);
  129533. }
  129534. if( rc==SQLITE_OK ){
  129535. rc = whereLoopAddOr(&sSubBuild, mPrereq, mUnusable);
  129536. }
  129537. assert( rc==SQLITE_OK || sCur.n==0 );
  129538. if( sCur.n==0 ){
  129539. sSum.n = 0;
  129540. break;
  129541. }else if( once ){
  129542. whereOrMove(&sSum, &sCur);
  129543. once = 0;
  129544. }else{
  129545. WhereOrSet sPrev;
  129546. whereOrMove(&sPrev, &sSum);
  129547. sSum.n = 0;
  129548. for(i=0; i<sPrev.n; i++){
  129549. for(j=0; j<sCur.n; j++){
  129550. whereOrInsert(&sSum, sPrev.a[i].prereq | sCur.a[j].prereq,
  129551. sqlite3LogEstAdd(sPrev.a[i].rRun, sCur.a[j].rRun),
  129552. sqlite3LogEstAdd(sPrev.a[i].nOut, sCur.a[j].nOut));
  129553. }
  129554. }
  129555. }
  129556. }
  129557. pNew->nLTerm = 1;
  129558. pNew->aLTerm[0] = pTerm;
  129559. pNew->wsFlags = WHERE_MULTI_OR;
  129560. pNew->rSetup = 0;
  129561. pNew->iSortIdx = 0;
  129562. memset(&pNew->u, 0, sizeof(pNew->u));
  129563. for(i=0; rc==SQLITE_OK && i<sSum.n; i++){
  129564. /* TUNING: Currently sSum.a[i].rRun is set to the sum of the costs
  129565. ** of all sub-scans required by the OR-scan. However, due to rounding
  129566. ** errors, it may be that the cost of the OR-scan is equal to its
  129567. ** most expensive sub-scan. Add the smallest possible penalty
  129568. ** (equivalent to multiplying the cost by 1.07) to ensure that
  129569. ** this does not happen. Otherwise, for WHERE clauses such as the
  129570. ** following where there is an index on "y":
  129571. **
  129572. ** WHERE likelihood(x=?, 0.99) OR y=?
  129573. **
  129574. ** the planner may elect to "OR" together a full-table scan and an
  129575. ** index lookup. And other similarly odd results. */
  129576. pNew->rRun = sSum.a[i].rRun + 1;
  129577. pNew->nOut = sSum.a[i].nOut;
  129578. pNew->prereq = sSum.a[i].prereq;
  129579. rc = whereLoopInsert(pBuilder, pNew);
  129580. }
  129581. WHERETRACE(0x200, ("End processing OR-clause %p\n", pTerm));
  129582. }
  129583. }
  129584. return rc;
  129585. }
  129586. /*
  129587. ** Add all WhereLoop objects for all tables
  129588. */
  129589. static int whereLoopAddAll(WhereLoopBuilder *pBuilder){
  129590. WhereInfo *pWInfo = pBuilder->pWInfo;
  129591. Bitmask mPrereq = 0;
  129592. Bitmask mPrior = 0;
  129593. int iTab;
  129594. SrcList *pTabList = pWInfo->pTabList;
  129595. struct SrcList_item *pItem;
  129596. struct SrcList_item *pEnd = &pTabList->a[pWInfo->nLevel];
  129597. sqlite3 *db = pWInfo->pParse->db;
  129598. int rc = SQLITE_OK;
  129599. WhereLoop *pNew;
  129600. u8 priorJointype = 0;
  129601. /* Loop over the tables in the join, from left to right */
  129602. pNew = pBuilder->pNew;
  129603. whereLoopInit(pNew);
  129604. for(iTab=0, pItem=pTabList->a; pItem<pEnd; iTab++, pItem++){
  129605. Bitmask mUnusable = 0;
  129606. pNew->iTab = iTab;
  129607. pNew->maskSelf = sqlite3WhereGetMask(&pWInfo->sMaskSet, pItem->iCursor);
  129608. if( ((pItem->fg.jointype|priorJointype) & (JT_LEFT|JT_CROSS))!=0 ){
  129609. /* This condition is true when pItem is the FROM clause term on the
  129610. ** right-hand-side of a LEFT or CROSS JOIN. */
  129611. mPrereq = mPrior;
  129612. }
  129613. priorJointype = pItem->fg.jointype;
  129614. #ifndef SQLITE_OMIT_VIRTUALTABLE
  129615. if( IsVirtual(pItem->pTab) ){
  129616. struct SrcList_item *p;
  129617. for(p=&pItem[1]; p<pEnd; p++){
  129618. if( mUnusable || (p->fg.jointype & (JT_LEFT|JT_CROSS)) ){
  129619. mUnusable |= sqlite3WhereGetMask(&pWInfo->sMaskSet, p->iCursor);
  129620. }
  129621. }
  129622. rc = whereLoopAddVirtual(pBuilder, mPrereq, mUnusable);
  129623. }else
  129624. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  129625. {
  129626. rc = whereLoopAddBtree(pBuilder, mPrereq);
  129627. }
  129628. if( rc==SQLITE_OK ){
  129629. rc = whereLoopAddOr(pBuilder, mPrereq, mUnusable);
  129630. }
  129631. mPrior |= pNew->maskSelf;
  129632. if( rc || db->mallocFailed ) break;
  129633. }
  129634. whereLoopClear(db, pNew);
  129635. return rc;
  129636. }
  129637. /*
  129638. ** Examine a WherePath (with the addition of the extra WhereLoop of the 6th
  129639. ** parameters) to see if it outputs rows in the requested ORDER BY
  129640. ** (or GROUP BY) without requiring a separate sort operation. Return N:
  129641. **
  129642. ** N>0: N terms of the ORDER BY clause are satisfied
  129643. ** N==0: No terms of the ORDER BY clause are satisfied
  129644. ** N<0: Unknown yet how many terms of ORDER BY might be satisfied.
  129645. **
  129646. ** Note that processing for WHERE_GROUPBY and WHERE_DISTINCTBY is not as
  129647. ** strict. With GROUP BY and DISTINCT the only requirement is that
  129648. ** equivalent rows appear immediately adjacent to one another. GROUP BY
  129649. ** and DISTINCT do not require rows to appear in any particular order as long
  129650. ** as equivalent rows are grouped together. Thus for GROUP BY and DISTINCT
  129651. ** the pOrderBy terms can be matched in any order. With ORDER BY, the
  129652. ** pOrderBy terms must be matched in strict left-to-right order.
  129653. */
  129654. static i8 wherePathSatisfiesOrderBy(
  129655. WhereInfo *pWInfo, /* The WHERE clause */
  129656. ExprList *pOrderBy, /* ORDER BY or GROUP BY or DISTINCT clause to check */
  129657. WherePath *pPath, /* The WherePath to check */
  129658. u16 wctrlFlags, /* WHERE_GROUPBY or _DISTINCTBY or _ORDERBY_LIMIT */
  129659. u16 nLoop, /* Number of entries in pPath->aLoop[] */
  129660. WhereLoop *pLast, /* Add this WhereLoop to the end of pPath->aLoop[] */
  129661. Bitmask *pRevMask /* OUT: Mask of WhereLoops to run in reverse order */
  129662. ){
  129663. u8 revSet; /* True if rev is known */
  129664. u8 rev; /* Composite sort order */
  129665. u8 revIdx; /* Index sort order */
  129666. u8 isOrderDistinct; /* All prior WhereLoops are order-distinct */
  129667. u8 distinctColumns; /* True if the loop has UNIQUE NOT NULL columns */
  129668. u8 isMatch; /* iColumn matches a term of the ORDER BY clause */
  129669. u16 eqOpMask; /* Allowed equality operators */
  129670. u16 nKeyCol; /* Number of key columns in pIndex */
  129671. u16 nColumn; /* Total number of ordered columns in the index */
  129672. u16 nOrderBy; /* Number terms in the ORDER BY clause */
  129673. int iLoop; /* Index of WhereLoop in pPath being processed */
  129674. int i, j; /* Loop counters */
  129675. int iCur; /* Cursor number for current WhereLoop */
  129676. int iColumn; /* A column number within table iCur */
  129677. WhereLoop *pLoop = 0; /* Current WhereLoop being processed. */
  129678. WhereTerm *pTerm; /* A single term of the WHERE clause */
  129679. Expr *pOBExpr; /* An expression from the ORDER BY clause */
  129680. CollSeq *pColl; /* COLLATE function from an ORDER BY clause term */
  129681. Index *pIndex; /* The index associated with pLoop */
  129682. sqlite3 *db = pWInfo->pParse->db; /* Database connection */
  129683. Bitmask obSat = 0; /* Mask of ORDER BY terms satisfied so far */
  129684. Bitmask obDone; /* Mask of all ORDER BY terms */
  129685. Bitmask orderDistinctMask; /* Mask of all well-ordered loops */
  129686. Bitmask ready; /* Mask of inner loops */
  129687. /*
  129688. ** We say the WhereLoop is "one-row" if it generates no more than one
  129689. ** row of output. A WhereLoop is one-row if all of the following are true:
  129690. ** (a) All index columns match with WHERE_COLUMN_EQ.
  129691. ** (b) The index is unique
  129692. ** Any WhereLoop with an WHERE_COLUMN_EQ constraint on the rowid is one-row.
  129693. ** Every one-row WhereLoop will have the WHERE_ONEROW bit set in wsFlags.
  129694. **
  129695. ** We say the WhereLoop is "order-distinct" if the set of columns from
  129696. ** that WhereLoop that are in the ORDER BY clause are different for every
  129697. ** row of the WhereLoop. Every one-row WhereLoop is automatically
  129698. ** order-distinct. A WhereLoop that has no columns in the ORDER BY clause
  129699. ** is not order-distinct. To be order-distinct is not quite the same as being
  129700. ** UNIQUE since a UNIQUE column or index can have multiple rows that
  129701. ** are NULL and NULL values are equivalent for the purpose of order-distinct.
  129702. ** To be order-distinct, the columns must be UNIQUE and NOT NULL.
  129703. **
  129704. ** The rowid for a table is always UNIQUE and NOT NULL so whenever the
  129705. ** rowid appears in the ORDER BY clause, the corresponding WhereLoop is
  129706. ** automatically order-distinct.
  129707. */
  129708. assert( pOrderBy!=0 );
  129709. if( nLoop && OptimizationDisabled(db, SQLITE_OrderByIdxJoin) ) return 0;
  129710. nOrderBy = pOrderBy->nExpr;
  129711. testcase( nOrderBy==BMS-1 );
  129712. if( nOrderBy>BMS-1 ) return 0; /* Cannot optimize overly large ORDER BYs */
  129713. isOrderDistinct = 1;
  129714. obDone = MASKBIT(nOrderBy)-1;
  129715. orderDistinctMask = 0;
  129716. ready = 0;
  129717. eqOpMask = WO_EQ | WO_IS | WO_ISNULL;
  129718. if( wctrlFlags & WHERE_ORDERBY_LIMIT ) eqOpMask |= WO_IN;
  129719. for(iLoop=0; isOrderDistinct && obSat<obDone && iLoop<=nLoop; iLoop++){
  129720. if( iLoop>0 ) ready |= pLoop->maskSelf;
  129721. if( iLoop<nLoop ){
  129722. pLoop = pPath->aLoop[iLoop];
  129723. if( wctrlFlags & WHERE_ORDERBY_LIMIT ) continue;
  129724. }else{
  129725. pLoop = pLast;
  129726. }
  129727. if( pLoop->wsFlags & WHERE_VIRTUALTABLE ){
  129728. if( pLoop->u.vtab.isOrdered ) obSat = obDone;
  129729. break;
  129730. }else{
  129731. pLoop->u.btree.nIdxCol = 0;
  129732. }
  129733. iCur = pWInfo->pTabList->a[pLoop->iTab].iCursor;
  129734. /* Mark off any ORDER BY term X that is a column in the table of
  129735. ** the current loop for which there is term in the WHERE
  129736. ** clause of the form X IS NULL or X=? that reference only outer
  129737. ** loops.
  129738. */
  129739. for(i=0; i<nOrderBy; i++){
  129740. if( MASKBIT(i) & obSat ) continue;
  129741. pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
  129742. if( pOBExpr->op!=TK_COLUMN ) continue;
  129743. if( pOBExpr->iTable!=iCur ) continue;
  129744. pTerm = sqlite3WhereFindTerm(&pWInfo->sWC, iCur, pOBExpr->iColumn,
  129745. ~ready, eqOpMask, 0);
  129746. if( pTerm==0 ) continue;
  129747. if( pTerm->eOperator==WO_IN ){
  129748. /* IN terms are only valid for sorting in the ORDER BY LIMIT
  129749. ** optimization, and then only if they are actually used
  129750. ** by the query plan */
  129751. assert( wctrlFlags & WHERE_ORDERBY_LIMIT );
  129752. for(j=0; j<pLoop->nLTerm && pTerm!=pLoop->aLTerm[j]; j++){}
  129753. if( j>=pLoop->nLTerm ) continue;
  129754. }
  129755. if( (pTerm->eOperator&(WO_EQ|WO_IS))!=0 && pOBExpr->iColumn>=0 ){
  129756. if( sqlite3ExprCollSeqMatch(pWInfo->pParse,
  129757. pOrderBy->a[i].pExpr, pTerm->pExpr)==0 ){
  129758. continue;
  129759. }
  129760. testcase( pTerm->pExpr->op==TK_IS );
  129761. }
  129762. obSat |= MASKBIT(i);
  129763. }
  129764. if( (pLoop->wsFlags & WHERE_ONEROW)==0 ){
  129765. if( pLoop->wsFlags & WHERE_IPK ){
  129766. pIndex = 0;
  129767. nKeyCol = 0;
  129768. nColumn = 1;
  129769. }else if( (pIndex = pLoop->u.btree.pIndex)==0 || pIndex->bUnordered ){
  129770. return 0;
  129771. }else{
  129772. nKeyCol = pIndex->nKeyCol;
  129773. nColumn = pIndex->nColumn;
  129774. assert( nColumn==nKeyCol+1 || !HasRowid(pIndex->pTable) );
  129775. assert( pIndex->aiColumn[nColumn-1]==XN_ROWID
  129776. || !HasRowid(pIndex->pTable));
  129777. isOrderDistinct = IsUniqueIndex(pIndex);
  129778. }
  129779. /* Loop through all columns of the index and deal with the ones
  129780. ** that are not constrained by == or IN.
  129781. */
  129782. rev = revSet = 0;
  129783. distinctColumns = 0;
  129784. for(j=0; j<nColumn; j++){
  129785. u8 bOnce = 1; /* True to run the ORDER BY search loop */
  129786. assert( j>=pLoop->u.btree.nEq
  129787. || (pLoop->aLTerm[j]==0)==(j<pLoop->nSkip)
  129788. );
  129789. if( j<pLoop->u.btree.nEq && j>=pLoop->nSkip ){
  129790. u16 eOp = pLoop->aLTerm[j]->eOperator;
  129791. /* Skip over == and IS and ISNULL terms. (Also skip IN terms when
  129792. ** doing WHERE_ORDERBY_LIMIT processing).
  129793. **
  129794. ** If the current term is a column of an ((?,?) IN (SELECT...))
  129795. ** expression for which the SELECT returns more than one column,
  129796. ** check that it is the only column used by this loop. Otherwise,
  129797. ** if it is one of two or more, none of the columns can be
  129798. ** considered to match an ORDER BY term. */
  129799. if( (eOp & eqOpMask)!=0 ){
  129800. if( eOp & WO_ISNULL ){
  129801. testcase( isOrderDistinct );
  129802. isOrderDistinct = 0;
  129803. }
  129804. continue;
  129805. }else if( ALWAYS(eOp & WO_IN) ){
  129806. /* ALWAYS() justification: eOp is an equality operator due to the
  129807. ** j<pLoop->u.btree.nEq constraint above. Any equality other
  129808. ** than WO_IN is captured by the previous "if". So this one
  129809. ** always has to be WO_IN. */
  129810. Expr *pX = pLoop->aLTerm[j]->pExpr;
  129811. for(i=j+1; i<pLoop->u.btree.nEq; i++){
  129812. if( pLoop->aLTerm[i]->pExpr==pX ){
  129813. assert( (pLoop->aLTerm[i]->eOperator & WO_IN) );
  129814. bOnce = 0;
  129815. break;
  129816. }
  129817. }
  129818. }
  129819. }
  129820. /* Get the column number in the table (iColumn) and sort order
  129821. ** (revIdx) for the j-th column of the index.
  129822. */
  129823. if( pIndex ){
  129824. iColumn = pIndex->aiColumn[j];
  129825. revIdx = pIndex->aSortOrder[j];
  129826. if( iColumn==pIndex->pTable->iPKey ) iColumn = XN_ROWID;
  129827. }else{
  129828. iColumn = XN_ROWID;
  129829. revIdx = 0;
  129830. }
  129831. /* An unconstrained column that might be NULL means that this
  129832. ** WhereLoop is not well-ordered
  129833. */
  129834. if( isOrderDistinct
  129835. && iColumn>=0
  129836. && j>=pLoop->u.btree.nEq
  129837. && pIndex->pTable->aCol[iColumn].notNull==0
  129838. ){
  129839. isOrderDistinct = 0;
  129840. }
  129841. /* Find the ORDER BY term that corresponds to the j-th column
  129842. ** of the index and mark that ORDER BY term off
  129843. */
  129844. isMatch = 0;
  129845. for(i=0; bOnce && i<nOrderBy; i++){
  129846. if( MASKBIT(i) & obSat ) continue;
  129847. pOBExpr = sqlite3ExprSkipCollate(pOrderBy->a[i].pExpr);
  129848. testcase( wctrlFlags & WHERE_GROUPBY );
  129849. testcase( wctrlFlags & WHERE_DISTINCTBY );
  129850. if( (wctrlFlags & (WHERE_GROUPBY|WHERE_DISTINCTBY))==0 ) bOnce = 0;
  129851. if( iColumn>=XN_ROWID ){
  129852. if( pOBExpr->op!=TK_COLUMN ) continue;
  129853. if( pOBExpr->iTable!=iCur ) continue;
  129854. if( pOBExpr->iColumn!=iColumn ) continue;
  129855. }else{
  129856. Expr *pIdxExpr = pIndex->aColExpr->a[j].pExpr;
  129857. if( sqlite3ExprCompareSkip(pOBExpr, pIdxExpr, iCur) ){
  129858. continue;
  129859. }
  129860. }
  129861. if( iColumn!=XN_ROWID ){
  129862. pColl = sqlite3ExprNNCollSeq(pWInfo->pParse, pOrderBy->a[i].pExpr);
  129863. if( sqlite3StrICmp(pColl->zName, pIndex->azColl[j])!=0 ) continue;
  129864. }
  129865. pLoop->u.btree.nIdxCol = j+1;
  129866. isMatch = 1;
  129867. break;
  129868. }
  129869. if( isMatch && (wctrlFlags & WHERE_GROUPBY)==0 ){
  129870. /* Make sure the sort order is compatible in an ORDER BY clause.
  129871. ** Sort order is irrelevant for a GROUP BY clause. */
  129872. if( revSet ){
  129873. if( (rev ^ revIdx)!=pOrderBy->a[i].sortOrder ) isMatch = 0;
  129874. }else{
  129875. rev = revIdx ^ pOrderBy->a[i].sortOrder;
  129876. if( rev ) *pRevMask |= MASKBIT(iLoop);
  129877. revSet = 1;
  129878. }
  129879. }
  129880. if( isMatch ){
  129881. if( iColumn==XN_ROWID ){
  129882. testcase( distinctColumns==0 );
  129883. distinctColumns = 1;
  129884. }
  129885. obSat |= MASKBIT(i);
  129886. }else{
  129887. /* No match found */
  129888. if( j==0 || j<nKeyCol ){
  129889. testcase( isOrderDistinct!=0 );
  129890. isOrderDistinct = 0;
  129891. }
  129892. break;
  129893. }
  129894. } /* end Loop over all index columns */
  129895. if( distinctColumns ){
  129896. testcase( isOrderDistinct==0 );
  129897. isOrderDistinct = 1;
  129898. }
  129899. } /* end-if not one-row */
  129900. /* Mark off any other ORDER BY terms that reference pLoop */
  129901. if( isOrderDistinct ){
  129902. orderDistinctMask |= pLoop->maskSelf;
  129903. for(i=0; i<nOrderBy; i++){
  129904. Expr *p;
  129905. Bitmask mTerm;
  129906. if( MASKBIT(i) & obSat ) continue;
  129907. p = pOrderBy->a[i].pExpr;
  129908. mTerm = sqlite3WhereExprUsage(&pWInfo->sMaskSet,p);
  129909. if( mTerm==0 && !sqlite3ExprIsConstant(p) ) continue;
  129910. if( (mTerm&~orderDistinctMask)==0 ){
  129911. obSat |= MASKBIT(i);
  129912. }
  129913. }
  129914. }
  129915. } /* End the loop over all WhereLoops from outer-most down to inner-most */
  129916. if( obSat==obDone ) return (i8)nOrderBy;
  129917. if( !isOrderDistinct ){
  129918. for(i=nOrderBy-1; i>0; i--){
  129919. Bitmask m = MASKBIT(i) - 1;
  129920. if( (obSat&m)==m ) return i;
  129921. }
  129922. return 0;
  129923. }
  129924. return -1;
  129925. }
  129926. /*
  129927. ** If the WHERE_GROUPBY flag is set in the mask passed to sqlite3WhereBegin(),
  129928. ** the planner assumes that the specified pOrderBy list is actually a GROUP
  129929. ** BY clause - and so any order that groups rows as required satisfies the
  129930. ** request.
  129931. **
  129932. ** Normally, in this case it is not possible for the caller to determine
  129933. ** whether or not the rows are really being delivered in sorted order, or
  129934. ** just in some other order that provides the required grouping. However,
  129935. ** if the WHERE_SORTBYGROUP flag is also passed to sqlite3WhereBegin(), then
  129936. ** this function may be called on the returned WhereInfo object. It returns
  129937. ** true if the rows really will be sorted in the specified order, or false
  129938. ** otherwise.
  129939. **
  129940. ** For example, assuming:
  129941. **
  129942. ** CREATE INDEX i1 ON t1(x, Y);
  129943. **
  129944. ** then
  129945. **
  129946. ** SELECT * FROM t1 GROUP BY x,y ORDER BY x,y; -- IsSorted()==1
  129947. ** SELECT * FROM t1 GROUP BY y,x ORDER BY y,x; -- IsSorted()==0
  129948. */
  129949. SQLITE_PRIVATE int sqlite3WhereIsSorted(WhereInfo *pWInfo){
  129950. assert( pWInfo->wctrlFlags & WHERE_GROUPBY );
  129951. assert( pWInfo->wctrlFlags & WHERE_SORTBYGROUP );
  129952. return pWInfo->sorted;
  129953. }
  129954. #ifdef WHERETRACE_ENABLED
  129955. /* For debugging use only: */
  129956. static const char *wherePathName(WherePath *pPath, int nLoop, WhereLoop *pLast){
  129957. static char zName[65];
  129958. int i;
  129959. for(i=0; i<nLoop; i++){ zName[i] = pPath->aLoop[i]->cId; }
  129960. if( pLast ) zName[i++] = pLast->cId;
  129961. zName[i] = 0;
  129962. return zName;
  129963. }
  129964. #endif
  129965. /*
  129966. ** Return the cost of sorting nRow rows, assuming that the keys have
  129967. ** nOrderby columns and that the first nSorted columns are already in
  129968. ** order.
  129969. */
  129970. static LogEst whereSortingCost(
  129971. WhereInfo *pWInfo,
  129972. LogEst nRow,
  129973. int nOrderBy,
  129974. int nSorted
  129975. ){
  129976. /* TUNING: Estimated cost of a full external sort, where N is
  129977. ** the number of rows to sort is:
  129978. **
  129979. ** cost = (3.0 * N * log(N)).
  129980. **
  129981. ** Or, if the order-by clause has X terms but only the last Y
  129982. ** terms are out of order, then block-sorting will reduce the
  129983. ** sorting cost to:
  129984. **
  129985. ** cost = (3.0 * N * log(N)) * (Y/X)
  129986. **
  129987. ** The (Y/X) term is implemented using stack variable rScale
  129988. ** below. */
  129989. LogEst rScale, rSortCost;
  129990. assert( nOrderBy>0 && 66==sqlite3LogEst(100) );
  129991. rScale = sqlite3LogEst((nOrderBy-nSorted)*100/nOrderBy) - 66;
  129992. rSortCost = nRow + rScale + 16;
  129993. /* Multiple by log(M) where M is the number of output rows.
  129994. ** Use the LIMIT for M if it is smaller */
  129995. if( (pWInfo->wctrlFlags & WHERE_USE_LIMIT)!=0 && pWInfo->iLimit<nRow ){
  129996. nRow = pWInfo->iLimit;
  129997. }
  129998. rSortCost += estLog(nRow);
  129999. return rSortCost;
  130000. }
  130001. /*
  130002. ** Given the list of WhereLoop objects at pWInfo->pLoops, this routine
  130003. ** attempts to find the lowest cost path that visits each WhereLoop
  130004. ** once. This path is then loaded into the pWInfo->a[].pWLoop fields.
  130005. **
  130006. ** Assume that the total number of output rows that will need to be sorted
  130007. ** will be nRowEst (in the 10*log2 representation). Or, ignore sorting
  130008. ** costs if nRowEst==0.
  130009. **
  130010. ** Return SQLITE_OK on success or SQLITE_NOMEM of a memory allocation
  130011. ** error occurs.
  130012. */
  130013. static int wherePathSolver(WhereInfo *pWInfo, LogEst nRowEst){
  130014. int mxChoice; /* Maximum number of simultaneous paths tracked */
  130015. int nLoop; /* Number of terms in the join */
  130016. Parse *pParse; /* Parsing context */
  130017. sqlite3 *db; /* The database connection */
  130018. int iLoop; /* Loop counter over the terms of the join */
  130019. int ii, jj; /* Loop counters */
  130020. int mxI = 0; /* Index of next entry to replace */
  130021. int nOrderBy; /* Number of ORDER BY clause terms */
  130022. LogEst mxCost = 0; /* Maximum cost of a set of paths */
  130023. LogEst mxUnsorted = 0; /* Maximum unsorted cost of a set of path */
  130024. int nTo, nFrom; /* Number of valid entries in aTo[] and aFrom[] */
  130025. WherePath *aFrom; /* All nFrom paths at the previous level */
  130026. WherePath *aTo; /* The nTo best paths at the current level */
  130027. WherePath *pFrom; /* An element of aFrom[] that we are working on */
  130028. WherePath *pTo; /* An element of aTo[] that we are working on */
  130029. WhereLoop *pWLoop; /* One of the WhereLoop objects */
  130030. WhereLoop **pX; /* Used to divy up the pSpace memory */
  130031. LogEst *aSortCost = 0; /* Sorting and partial sorting costs */
  130032. char *pSpace; /* Temporary memory used by this routine */
  130033. int nSpace; /* Bytes of space allocated at pSpace */
  130034. pParse = pWInfo->pParse;
  130035. db = pParse->db;
  130036. nLoop = pWInfo->nLevel;
  130037. /* TUNING: For simple queries, only the best path is tracked.
  130038. ** For 2-way joins, the 5 best paths are followed.
  130039. ** For joins of 3 or more tables, track the 10 best paths */
  130040. mxChoice = (nLoop<=1) ? 1 : (nLoop==2 ? 5 : 10);
  130041. assert( nLoop<=pWInfo->pTabList->nSrc );
  130042. WHERETRACE(0x002, ("---- begin solver. (nRowEst=%d)\n", nRowEst));
  130043. /* If nRowEst is zero and there is an ORDER BY clause, ignore it. In this
  130044. ** case the purpose of this call is to estimate the number of rows returned
  130045. ** by the overall query. Once this estimate has been obtained, the caller
  130046. ** will invoke this function a second time, passing the estimate as the
  130047. ** nRowEst parameter. */
  130048. if( pWInfo->pOrderBy==0 || nRowEst==0 ){
  130049. nOrderBy = 0;
  130050. }else{
  130051. nOrderBy = pWInfo->pOrderBy->nExpr;
  130052. }
  130053. /* Allocate and initialize space for aTo, aFrom and aSortCost[] */
  130054. nSpace = (sizeof(WherePath)+sizeof(WhereLoop*)*nLoop)*mxChoice*2;
  130055. nSpace += sizeof(LogEst) * nOrderBy;
  130056. pSpace = sqlite3DbMallocRawNN(db, nSpace);
  130057. if( pSpace==0 ) return SQLITE_NOMEM_BKPT;
  130058. aTo = (WherePath*)pSpace;
  130059. aFrom = aTo+mxChoice;
  130060. memset(aFrom, 0, sizeof(aFrom[0]));
  130061. pX = (WhereLoop**)(aFrom+mxChoice);
  130062. for(ii=mxChoice*2, pFrom=aTo; ii>0; ii--, pFrom++, pX += nLoop){
  130063. pFrom->aLoop = pX;
  130064. }
  130065. if( nOrderBy ){
  130066. /* If there is an ORDER BY clause and it is not being ignored, set up
  130067. ** space for the aSortCost[] array. Each element of the aSortCost array
  130068. ** is either zero - meaning it has not yet been initialized - or the
  130069. ** cost of sorting nRowEst rows of data where the first X terms of
  130070. ** the ORDER BY clause are already in order, where X is the array
  130071. ** index. */
  130072. aSortCost = (LogEst*)pX;
  130073. memset(aSortCost, 0, sizeof(LogEst) * nOrderBy);
  130074. }
  130075. assert( aSortCost==0 || &pSpace[nSpace]==(char*)&aSortCost[nOrderBy] );
  130076. assert( aSortCost!=0 || &pSpace[nSpace]==(char*)pX );
  130077. /* Seed the search with a single WherePath containing zero WhereLoops.
  130078. **
  130079. ** TUNING: Do not let the number of iterations go above 28. If the cost
  130080. ** of computing an automatic index is not paid back within the first 28
  130081. ** rows, then do not use the automatic index. */
  130082. aFrom[0].nRow = MIN(pParse->nQueryLoop, 48); assert( 48==sqlite3LogEst(28) );
  130083. nFrom = 1;
  130084. assert( aFrom[0].isOrdered==0 );
  130085. if( nOrderBy ){
  130086. /* If nLoop is zero, then there are no FROM terms in the query. Since
  130087. ** in this case the query may return a maximum of one row, the results
  130088. ** are already in the requested order. Set isOrdered to nOrderBy to
  130089. ** indicate this. Or, if nLoop is greater than zero, set isOrdered to
  130090. ** -1, indicating that the result set may or may not be ordered,
  130091. ** depending on the loops added to the current plan. */
  130092. aFrom[0].isOrdered = nLoop>0 ? -1 : nOrderBy;
  130093. }
  130094. /* Compute successively longer WherePaths using the previous generation
  130095. ** of WherePaths as the basis for the next. Keep track of the mxChoice
  130096. ** best paths at each generation */
  130097. for(iLoop=0; iLoop<nLoop; iLoop++){
  130098. nTo = 0;
  130099. for(ii=0, pFrom=aFrom; ii<nFrom; ii++, pFrom++){
  130100. for(pWLoop=pWInfo->pLoops; pWLoop; pWLoop=pWLoop->pNextLoop){
  130101. LogEst nOut; /* Rows visited by (pFrom+pWLoop) */
  130102. LogEst rCost; /* Cost of path (pFrom+pWLoop) */
  130103. LogEst rUnsorted; /* Unsorted cost of (pFrom+pWLoop) */
  130104. i8 isOrdered = pFrom->isOrdered; /* isOrdered for (pFrom+pWLoop) */
  130105. Bitmask maskNew; /* Mask of src visited by (..) */
  130106. Bitmask revMask = 0; /* Mask of rev-order loops for (..) */
  130107. if( (pWLoop->prereq & ~pFrom->maskLoop)!=0 ) continue;
  130108. if( (pWLoop->maskSelf & pFrom->maskLoop)!=0 ) continue;
  130109. if( (pWLoop->wsFlags & WHERE_AUTO_INDEX)!=0 && pFrom->nRow<10 ){
  130110. /* Do not use an automatic index if the this loop is expected
  130111. ** to run less than 2 times. */
  130112. assert( 10==sqlite3LogEst(2) );
  130113. continue;
  130114. }
  130115. /* At this point, pWLoop is a candidate to be the next loop.
  130116. ** Compute its cost */
  130117. rUnsorted = sqlite3LogEstAdd(pWLoop->rSetup,pWLoop->rRun + pFrom->nRow);
  130118. rUnsorted = sqlite3LogEstAdd(rUnsorted, pFrom->rUnsorted);
  130119. nOut = pFrom->nRow + pWLoop->nOut;
  130120. maskNew = pFrom->maskLoop | pWLoop->maskSelf;
  130121. if( isOrdered<0 ){
  130122. isOrdered = wherePathSatisfiesOrderBy(pWInfo,
  130123. pWInfo->pOrderBy, pFrom, pWInfo->wctrlFlags,
  130124. iLoop, pWLoop, &revMask);
  130125. }else{
  130126. revMask = pFrom->revLoop;
  130127. }
  130128. if( isOrdered>=0 && isOrdered<nOrderBy ){
  130129. if( aSortCost[isOrdered]==0 ){
  130130. aSortCost[isOrdered] = whereSortingCost(
  130131. pWInfo, nRowEst, nOrderBy, isOrdered
  130132. );
  130133. }
  130134. rCost = sqlite3LogEstAdd(rUnsorted, aSortCost[isOrdered]);
  130135. WHERETRACE(0x002,
  130136. ("---- sort cost=%-3d (%d/%d) increases cost %3d to %-3d\n",
  130137. aSortCost[isOrdered], (nOrderBy-isOrdered), nOrderBy,
  130138. rUnsorted, rCost));
  130139. }else{
  130140. rCost = rUnsorted;
  130141. rUnsorted -= 2; /* TUNING: Slight bias in favor of no-sort plans */
  130142. }
  130143. /* Check to see if pWLoop should be added to the set of
  130144. ** mxChoice best-so-far paths.
  130145. **
  130146. ** First look for an existing path among best-so-far paths
  130147. ** that covers the same set of loops and has the same isOrdered
  130148. ** setting as the current path candidate.
  130149. **
  130150. ** The term "((pTo->isOrdered^isOrdered)&0x80)==0" is equivalent
  130151. ** to (pTo->isOrdered==(-1))==(isOrdered==(-1))" for the range
  130152. ** of legal values for isOrdered, -1..64.
  130153. */
  130154. for(jj=0, pTo=aTo; jj<nTo; jj++, pTo++){
  130155. if( pTo->maskLoop==maskNew
  130156. && ((pTo->isOrdered^isOrdered)&0x80)==0
  130157. ){
  130158. testcase( jj==nTo-1 );
  130159. break;
  130160. }
  130161. }
  130162. if( jj>=nTo ){
  130163. /* None of the existing best-so-far paths match the candidate. */
  130164. if( nTo>=mxChoice
  130165. && (rCost>mxCost || (rCost==mxCost && rUnsorted>=mxUnsorted))
  130166. ){
  130167. /* The current candidate is no better than any of the mxChoice
  130168. ** paths currently in the best-so-far buffer. So discard
  130169. ** this candidate as not viable. */
  130170. #ifdef WHERETRACE_ENABLED /* 0x4 */
  130171. if( sqlite3WhereTrace&0x4 ){
  130172. sqlite3DebugPrintf("Skip %s cost=%-3d,%3d,%3d order=%c\n",
  130173. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut, rUnsorted,
  130174. isOrdered>=0 ? isOrdered+'0' : '?');
  130175. }
  130176. #endif
  130177. continue;
  130178. }
  130179. /* If we reach this points it means that the new candidate path
  130180. ** needs to be added to the set of best-so-far paths. */
  130181. if( nTo<mxChoice ){
  130182. /* Increase the size of the aTo set by one */
  130183. jj = nTo++;
  130184. }else{
  130185. /* New path replaces the prior worst to keep count below mxChoice */
  130186. jj = mxI;
  130187. }
  130188. pTo = &aTo[jj];
  130189. #ifdef WHERETRACE_ENABLED /* 0x4 */
  130190. if( sqlite3WhereTrace&0x4 ){
  130191. sqlite3DebugPrintf("New %s cost=%-3d,%3d,%3d order=%c\n",
  130192. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut, rUnsorted,
  130193. isOrdered>=0 ? isOrdered+'0' : '?');
  130194. }
  130195. #endif
  130196. }else{
  130197. /* Control reaches here if best-so-far path pTo=aTo[jj] covers the
  130198. ** same set of loops and has the same isOrdered setting as the
  130199. ** candidate path. Check to see if the candidate should replace
  130200. ** pTo or if the candidate should be skipped.
  130201. **
  130202. ** The conditional is an expanded vector comparison equivalent to:
  130203. ** (pTo->rCost,pTo->nRow,pTo->rUnsorted) <= (rCost,nOut,rUnsorted)
  130204. */
  130205. if( pTo->rCost<rCost
  130206. || (pTo->rCost==rCost
  130207. && (pTo->nRow<nOut
  130208. || (pTo->nRow==nOut && pTo->rUnsorted<=rUnsorted)
  130209. )
  130210. )
  130211. ){
  130212. #ifdef WHERETRACE_ENABLED /* 0x4 */
  130213. if( sqlite3WhereTrace&0x4 ){
  130214. sqlite3DebugPrintf(
  130215. "Skip %s cost=%-3d,%3d,%3d order=%c",
  130216. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut, rUnsorted,
  130217. isOrdered>=0 ? isOrdered+'0' : '?');
  130218. sqlite3DebugPrintf(" vs %s cost=%-3d,%3d,%3d order=%c\n",
  130219. wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
  130220. pTo->rUnsorted, pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
  130221. }
  130222. #endif
  130223. /* Discard the candidate path from further consideration */
  130224. testcase( pTo->rCost==rCost );
  130225. continue;
  130226. }
  130227. testcase( pTo->rCost==rCost+1 );
  130228. /* Control reaches here if the candidate path is better than the
  130229. ** pTo path. Replace pTo with the candidate. */
  130230. #ifdef WHERETRACE_ENABLED /* 0x4 */
  130231. if( sqlite3WhereTrace&0x4 ){
  130232. sqlite3DebugPrintf(
  130233. "Update %s cost=%-3d,%3d,%3d order=%c",
  130234. wherePathName(pFrom, iLoop, pWLoop), rCost, nOut, rUnsorted,
  130235. isOrdered>=0 ? isOrdered+'0' : '?');
  130236. sqlite3DebugPrintf(" was %s cost=%-3d,%3d,%3d order=%c\n",
  130237. wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
  130238. pTo->rUnsorted, pTo->isOrdered>=0 ? pTo->isOrdered+'0' : '?');
  130239. }
  130240. #endif
  130241. }
  130242. /* pWLoop is a winner. Add it to the set of best so far */
  130243. pTo->maskLoop = pFrom->maskLoop | pWLoop->maskSelf;
  130244. pTo->revLoop = revMask;
  130245. pTo->nRow = nOut;
  130246. pTo->rCost = rCost;
  130247. pTo->rUnsorted = rUnsorted;
  130248. pTo->isOrdered = isOrdered;
  130249. memcpy(pTo->aLoop, pFrom->aLoop, sizeof(WhereLoop*)*iLoop);
  130250. pTo->aLoop[iLoop] = pWLoop;
  130251. if( nTo>=mxChoice ){
  130252. mxI = 0;
  130253. mxCost = aTo[0].rCost;
  130254. mxUnsorted = aTo[0].nRow;
  130255. for(jj=1, pTo=&aTo[1]; jj<mxChoice; jj++, pTo++){
  130256. if( pTo->rCost>mxCost
  130257. || (pTo->rCost==mxCost && pTo->rUnsorted>mxUnsorted)
  130258. ){
  130259. mxCost = pTo->rCost;
  130260. mxUnsorted = pTo->rUnsorted;
  130261. mxI = jj;
  130262. }
  130263. }
  130264. }
  130265. }
  130266. }
  130267. #ifdef WHERETRACE_ENABLED /* >=2 */
  130268. if( sqlite3WhereTrace & 0x02 ){
  130269. sqlite3DebugPrintf("---- after round %d ----\n", iLoop);
  130270. for(ii=0, pTo=aTo; ii<nTo; ii++, pTo++){
  130271. sqlite3DebugPrintf(" %s cost=%-3d nrow=%-3d order=%c",
  130272. wherePathName(pTo, iLoop+1, 0), pTo->rCost, pTo->nRow,
  130273. pTo->isOrdered>=0 ? (pTo->isOrdered+'0') : '?');
  130274. if( pTo->isOrdered>0 ){
  130275. sqlite3DebugPrintf(" rev=0x%llx\n", pTo->revLoop);
  130276. }else{
  130277. sqlite3DebugPrintf("\n");
  130278. }
  130279. }
  130280. }
  130281. #endif
  130282. /* Swap the roles of aFrom and aTo for the next generation */
  130283. pFrom = aTo;
  130284. aTo = aFrom;
  130285. aFrom = pFrom;
  130286. nFrom = nTo;
  130287. }
  130288. if( nFrom==0 ){
  130289. sqlite3ErrorMsg(pParse, "no query solution");
  130290. sqlite3DbFreeNN(db, pSpace);
  130291. return SQLITE_ERROR;
  130292. }
  130293. /* Find the lowest cost path. pFrom will be left pointing to that path */
  130294. pFrom = aFrom;
  130295. for(ii=1; ii<nFrom; ii++){
  130296. if( pFrom->rCost>aFrom[ii].rCost ) pFrom = &aFrom[ii];
  130297. }
  130298. assert( pWInfo->nLevel==nLoop );
  130299. /* Load the lowest cost path into pWInfo */
  130300. for(iLoop=0; iLoop<nLoop; iLoop++){
  130301. WhereLevel *pLevel = pWInfo->a + iLoop;
  130302. pLevel->pWLoop = pWLoop = pFrom->aLoop[iLoop];
  130303. pLevel->iFrom = pWLoop->iTab;
  130304. pLevel->iTabCur = pWInfo->pTabList->a[pLevel->iFrom].iCursor;
  130305. }
  130306. if( (pWInfo->wctrlFlags & WHERE_WANT_DISTINCT)!=0
  130307. && (pWInfo->wctrlFlags & WHERE_DISTINCTBY)==0
  130308. && pWInfo->eDistinct==WHERE_DISTINCT_NOOP
  130309. && nRowEst
  130310. ){
  130311. Bitmask notUsed;
  130312. int rc = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pResultSet, pFrom,
  130313. WHERE_DISTINCTBY, nLoop-1, pFrom->aLoop[nLoop-1], &notUsed);
  130314. if( rc==pWInfo->pResultSet->nExpr ){
  130315. pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
  130316. }
  130317. }
  130318. if( pWInfo->pOrderBy ){
  130319. if( pWInfo->wctrlFlags & WHERE_DISTINCTBY ){
  130320. if( pFrom->isOrdered==pWInfo->pOrderBy->nExpr ){
  130321. pWInfo->eDistinct = WHERE_DISTINCT_ORDERED;
  130322. }
  130323. }else{
  130324. pWInfo->nOBSat = pFrom->isOrdered;
  130325. pWInfo->revMask = pFrom->revLoop;
  130326. if( pWInfo->nOBSat<=0 ){
  130327. pWInfo->nOBSat = 0;
  130328. if( nLoop>0 ){
  130329. u32 wsFlags = pFrom->aLoop[nLoop-1]->wsFlags;
  130330. if( (wsFlags & WHERE_ONEROW)==0
  130331. && (wsFlags&(WHERE_IPK|WHERE_COLUMN_IN))!=(WHERE_IPK|WHERE_COLUMN_IN)
  130332. ){
  130333. Bitmask m = 0;
  130334. int rc = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pOrderBy, pFrom,
  130335. WHERE_ORDERBY_LIMIT, nLoop-1, pFrom->aLoop[nLoop-1], &m);
  130336. testcase( wsFlags & WHERE_IPK );
  130337. testcase( wsFlags & WHERE_COLUMN_IN );
  130338. if( rc==pWInfo->pOrderBy->nExpr ){
  130339. pWInfo->bOrderedInnerLoop = 1;
  130340. pWInfo->revMask = m;
  130341. }
  130342. }
  130343. }
  130344. }
  130345. }
  130346. if( (pWInfo->wctrlFlags & WHERE_SORTBYGROUP)
  130347. && pWInfo->nOBSat==pWInfo->pOrderBy->nExpr && nLoop>0
  130348. ){
  130349. Bitmask revMask = 0;
  130350. int nOrder = wherePathSatisfiesOrderBy(pWInfo, pWInfo->pOrderBy,
  130351. pFrom, 0, nLoop-1, pFrom->aLoop[nLoop-1], &revMask
  130352. );
  130353. assert( pWInfo->sorted==0 );
  130354. if( nOrder==pWInfo->pOrderBy->nExpr ){
  130355. pWInfo->sorted = 1;
  130356. pWInfo->revMask = revMask;
  130357. }
  130358. }
  130359. }
  130360. pWInfo->nRowOut = pFrom->nRow;
  130361. /* Free temporary memory and return success */
  130362. sqlite3DbFreeNN(db, pSpace);
  130363. return SQLITE_OK;
  130364. }
  130365. /*
  130366. ** Most queries use only a single table (they are not joins) and have
  130367. ** simple == constraints against indexed fields. This routine attempts
  130368. ** to plan those simple cases using much less ceremony than the
  130369. ** general-purpose query planner, and thereby yield faster sqlite3_prepare()
  130370. ** times for the common case.
  130371. **
  130372. ** Return non-zero on success, if this query can be handled by this
  130373. ** no-frills query planner. Return zero if this query needs the
  130374. ** general-purpose query planner.
  130375. */
  130376. static int whereShortCut(WhereLoopBuilder *pBuilder){
  130377. WhereInfo *pWInfo;
  130378. struct SrcList_item *pItem;
  130379. WhereClause *pWC;
  130380. WhereTerm *pTerm;
  130381. WhereLoop *pLoop;
  130382. int iCur;
  130383. int j;
  130384. Table *pTab;
  130385. Index *pIdx;
  130386. pWInfo = pBuilder->pWInfo;
  130387. if( pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE ) return 0;
  130388. assert( pWInfo->pTabList->nSrc>=1 );
  130389. pItem = pWInfo->pTabList->a;
  130390. pTab = pItem->pTab;
  130391. if( IsVirtual(pTab) ) return 0;
  130392. if( pItem->fg.isIndexedBy ) return 0;
  130393. iCur = pItem->iCursor;
  130394. pWC = &pWInfo->sWC;
  130395. pLoop = pBuilder->pNew;
  130396. pLoop->wsFlags = 0;
  130397. pLoop->nSkip = 0;
  130398. pTerm = sqlite3WhereFindTerm(pWC, iCur, -1, 0, WO_EQ|WO_IS, 0);
  130399. if( pTerm ){
  130400. testcase( pTerm->eOperator & WO_IS );
  130401. pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_IPK|WHERE_ONEROW;
  130402. pLoop->aLTerm[0] = pTerm;
  130403. pLoop->nLTerm = 1;
  130404. pLoop->u.btree.nEq = 1;
  130405. /* TUNING: Cost of a rowid lookup is 10 */
  130406. pLoop->rRun = 33; /* 33==sqlite3LogEst(10) */
  130407. }else{
  130408. for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
  130409. int opMask;
  130410. assert( pLoop->aLTermSpace==pLoop->aLTerm );
  130411. if( !IsUniqueIndex(pIdx)
  130412. || pIdx->pPartIdxWhere!=0
  130413. || pIdx->nKeyCol>ArraySize(pLoop->aLTermSpace)
  130414. ) continue;
  130415. opMask = pIdx->uniqNotNull ? (WO_EQ|WO_IS) : WO_EQ;
  130416. for(j=0; j<pIdx->nKeyCol; j++){
  130417. pTerm = sqlite3WhereFindTerm(pWC, iCur, j, 0, opMask, pIdx);
  130418. if( pTerm==0 ) break;
  130419. testcase( pTerm->eOperator & WO_IS );
  130420. pLoop->aLTerm[j] = pTerm;
  130421. }
  130422. if( j!=pIdx->nKeyCol ) continue;
  130423. pLoop->wsFlags = WHERE_COLUMN_EQ|WHERE_ONEROW|WHERE_INDEXED;
  130424. if( pIdx->isCovering || (pItem->colUsed & ~columnsInIndex(pIdx))==0 ){
  130425. pLoop->wsFlags |= WHERE_IDX_ONLY;
  130426. }
  130427. pLoop->nLTerm = j;
  130428. pLoop->u.btree.nEq = j;
  130429. pLoop->u.btree.pIndex = pIdx;
  130430. /* TUNING: Cost of a unique index lookup is 15 */
  130431. pLoop->rRun = 39; /* 39==sqlite3LogEst(15) */
  130432. break;
  130433. }
  130434. }
  130435. if( pLoop->wsFlags ){
  130436. pLoop->nOut = (LogEst)1;
  130437. pWInfo->a[0].pWLoop = pLoop;
  130438. assert( pWInfo->sMaskSet.n==1 && iCur==pWInfo->sMaskSet.ix[0] );
  130439. pLoop->maskSelf = 1; /* sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur); */
  130440. pWInfo->a[0].iTabCur = iCur;
  130441. pWInfo->nRowOut = 1;
  130442. if( pWInfo->pOrderBy ) pWInfo->nOBSat = pWInfo->pOrderBy->nExpr;
  130443. if( pWInfo->wctrlFlags & WHERE_WANT_DISTINCT ){
  130444. pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
  130445. }
  130446. #ifdef SQLITE_DEBUG
  130447. pLoop->cId = '0';
  130448. #endif
  130449. return 1;
  130450. }
  130451. return 0;
  130452. }
  130453. /*
  130454. ** Helper function for exprIsDeterministic().
  130455. */
  130456. static int exprNodeIsDeterministic(Walker *pWalker, Expr *pExpr){
  130457. if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_ConstFunc)==0 ){
  130458. pWalker->eCode = 0;
  130459. return WRC_Abort;
  130460. }
  130461. return WRC_Continue;
  130462. }
  130463. /*
  130464. ** Return true if the expression contains no non-deterministic SQL
  130465. ** functions. Do not consider non-deterministic SQL functions that are
  130466. ** part of sub-select statements.
  130467. */
  130468. static int exprIsDeterministic(Expr *p){
  130469. Walker w;
  130470. memset(&w, 0, sizeof(w));
  130471. w.eCode = 1;
  130472. w.xExprCallback = exprNodeIsDeterministic;
  130473. w.xSelectCallback = sqlite3SelectWalkFail;
  130474. sqlite3WalkExpr(&w, p);
  130475. return w.eCode;
  130476. }
  130477. /*
  130478. ** Generate the beginning of the loop used for WHERE clause processing.
  130479. ** The return value is a pointer to an opaque structure that contains
  130480. ** information needed to terminate the loop. Later, the calling routine
  130481. ** should invoke sqlite3WhereEnd() with the return value of this function
  130482. ** in order to complete the WHERE clause processing.
  130483. **
  130484. ** If an error occurs, this routine returns NULL.
  130485. **
  130486. ** The basic idea is to do a nested loop, one loop for each table in
  130487. ** the FROM clause of a select. (INSERT and UPDATE statements are the
  130488. ** same as a SELECT with only a single table in the FROM clause.) For
  130489. ** example, if the SQL is this:
  130490. **
  130491. ** SELECT * FROM t1, t2, t3 WHERE ...;
  130492. **
  130493. ** Then the code generated is conceptually like the following:
  130494. **
  130495. ** foreach row1 in t1 do \ Code generated
  130496. ** foreach row2 in t2 do |-- by sqlite3WhereBegin()
  130497. ** foreach row3 in t3 do /
  130498. ** ...
  130499. ** end \ Code generated
  130500. ** end |-- by sqlite3WhereEnd()
  130501. ** end /
  130502. **
  130503. ** Note that the loops might not be nested in the order in which they
  130504. ** appear in the FROM clause if a different order is better able to make
  130505. ** use of indices. Note also that when the IN operator appears in
  130506. ** the WHERE clause, it might result in additional nested loops for
  130507. ** scanning through all values on the right-hand side of the IN.
  130508. **
  130509. ** There are Btree cursors associated with each table. t1 uses cursor
  130510. ** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
  130511. ** And so forth. This routine generates code to open those VDBE cursors
  130512. ** and sqlite3WhereEnd() generates the code to close them.
  130513. **
  130514. ** The code that sqlite3WhereBegin() generates leaves the cursors named
  130515. ** in pTabList pointing at their appropriate entries. The [...] code
  130516. ** can use OP_Column and OP_Rowid opcodes on these cursors to extract
  130517. ** data from the various tables of the loop.
  130518. **
  130519. ** If the WHERE clause is empty, the foreach loops must each scan their
  130520. ** entire tables. Thus a three-way join is an O(N^3) operation. But if
  130521. ** the tables have indices and there are terms in the WHERE clause that
  130522. ** refer to those indices, a complete table scan can be avoided and the
  130523. ** code will run much faster. Most of the work of this routine is checking
  130524. ** to see if there are indices that can be used to speed up the loop.
  130525. **
  130526. ** Terms of the WHERE clause are also used to limit which rows actually
  130527. ** make it to the "..." in the middle of the loop. After each "foreach",
  130528. ** terms of the WHERE clause that use only terms in that loop and outer
  130529. ** loops are evaluated and if false a jump is made around all subsequent
  130530. ** inner loops (or around the "..." if the test occurs within the inner-
  130531. ** most loop)
  130532. **
  130533. ** OUTER JOINS
  130534. **
  130535. ** An outer join of tables t1 and t2 is conceptally coded as follows:
  130536. **
  130537. ** foreach row1 in t1 do
  130538. ** flag = 0
  130539. ** foreach row2 in t2 do
  130540. ** start:
  130541. ** ...
  130542. ** flag = 1
  130543. ** end
  130544. ** if flag==0 then
  130545. ** move the row2 cursor to a null row
  130546. ** goto start
  130547. ** fi
  130548. ** end
  130549. **
  130550. ** ORDER BY CLAUSE PROCESSING
  130551. **
  130552. ** pOrderBy is a pointer to the ORDER BY clause (or the GROUP BY clause
  130553. ** if the WHERE_GROUPBY flag is set in wctrlFlags) of a SELECT statement
  130554. ** if there is one. If there is no ORDER BY clause or if this routine
  130555. ** is called from an UPDATE or DELETE statement, then pOrderBy is NULL.
  130556. **
  130557. ** The iIdxCur parameter is the cursor number of an index. If
  130558. ** WHERE_OR_SUBCLAUSE is set, iIdxCur is the cursor number of an index
  130559. ** to use for OR clause processing. The WHERE clause should use this
  130560. ** specific cursor. If WHERE_ONEPASS_DESIRED is set, then iIdxCur is
  130561. ** the first cursor in an array of cursors for all indices. iIdxCur should
  130562. ** be used to compute the appropriate cursor depending on which index is
  130563. ** used.
  130564. */
  130565. SQLITE_PRIVATE WhereInfo *sqlite3WhereBegin(
  130566. Parse *pParse, /* The parser context */
  130567. SrcList *pTabList, /* FROM clause: A list of all tables to be scanned */
  130568. Expr *pWhere, /* The WHERE clause */
  130569. ExprList *pOrderBy, /* An ORDER BY (or GROUP BY) clause, or NULL */
  130570. ExprList *pResultSet, /* Query result set. Req'd for DISTINCT */
  130571. u16 wctrlFlags, /* The WHERE_* flags defined in sqliteInt.h */
  130572. int iAuxArg /* If WHERE_OR_SUBCLAUSE is set, index cursor number
  130573. ** If WHERE_USE_LIMIT, then the limit amount */
  130574. ){
  130575. int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
  130576. int nTabList; /* Number of elements in pTabList */
  130577. WhereInfo *pWInfo; /* Will become the return value of this function */
  130578. Vdbe *v = pParse->pVdbe; /* The virtual database engine */
  130579. Bitmask notReady; /* Cursors that are not yet positioned */
  130580. WhereLoopBuilder sWLB; /* The WhereLoop builder */
  130581. WhereMaskSet *pMaskSet; /* The expression mask set */
  130582. WhereLevel *pLevel; /* A single level in pWInfo->a[] */
  130583. WhereLoop *pLoop; /* Pointer to a single WhereLoop object */
  130584. int ii; /* Loop counter */
  130585. sqlite3 *db; /* Database connection */
  130586. int rc; /* Return code */
  130587. u8 bFordelete = 0; /* OPFLAG_FORDELETE or zero, as appropriate */
  130588. assert( (wctrlFlags & WHERE_ONEPASS_MULTIROW)==0 || (
  130589. (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0
  130590. && (wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  130591. ));
  130592. /* Only one of WHERE_OR_SUBCLAUSE or WHERE_USE_LIMIT */
  130593. assert( (wctrlFlags & WHERE_OR_SUBCLAUSE)==0
  130594. || (wctrlFlags & WHERE_USE_LIMIT)==0 );
  130595. /* Variable initialization */
  130596. db = pParse->db;
  130597. memset(&sWLB, 0, sizeof(sWLB));
  130598. /* An ORDER/GROUP BY clause of more than 63 terms cannot be optimized */
  130599. testcase( pOrderBy && pOrderBy->nExpr==BMS-1 );
  130600. if( pOrderBy && pOrderBy->nExpr>=BMS ) pOrderBy = 0;
  130601. sWLB.pOrderBy = pOrderBy;
  130602. /* Disable the DISTINCT optimization if SQLITE_DistinctOpt is set via
  130603. ** sqlite3_test_ctrl(SQLITE_TESTCTRL_OPTIMIZATIONS,...) */
  130604. if( OptimizationDisabled(db, SQLITE_DistinctOpt) ){
  130605. wctrlFlags &= ~WHERE_WANT_DISTINCT;
  130606. }
  130607. /* The number of tables in the FROM clause is limited by the number of
  130608. ** bits in a Bitmask
  130609. */
  130610. testcase( pTabList->nSrc==BMS );
  130611. if( pTabList->nSrc>BMS ){
  130612. sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
  130613. return 0;
  130614. }
  130615. /* This function normally generates a nested loop for all tables in
  130616. ** pTabList. But if the WHERE_OR_SUBCLAUSE flag is set, then we should
  130617. ** only generate code for the first table in pTabList and assume that
  130618. ** any cursors associated with subsequent tables are uninitialized.
  130619. */
  130620. nTabList = (wctrlFlags & WHERE_OR_SUBCLAUSE) ? 1 : pTabList->nSrc;
  130621. /* Allocate and initialize the WhereInfo structure that will become the
  130622. ** return value. A single allocation is used to store the WhereInfo
  130623. ** struct, the contents of WhereInfo.a[], the WhereClause structure
  130624. ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
  130625. ** field (type Bitmask) it must be aligned on an 8-byte boundary on
  130626. ** some architectures. Hence the ROUND8() below.
  130627. */
  130628. nByteWInfo = ROUND8(sizeof(WhereInfo)+(nTabList-1)*sizeof(WhereLevel));
  130629. pWInfo = sqlite3DbMallocRawNN(db, nByteWInfo + sizeof(WhereLoop));
  130630. if( db->mallocFailed ){
  130631. sqlite3DbFree(db, pWInfo);
  130632. pWInfo = 0;
  130633. goto whereBeginError;
  130634. }
  130635. pWInfo->pParse = pParse;
  130636. pWInfo->pTabList = pTabList;
  130637. pWInfo->pOrderBy = pOrderBy;
  130638. pWInfo->pWhere = pWhere;
  130639. pWInfo->pResultSet = pResultSet;
  130640. pWInfo->aiCurOnePass[0] = pWInfo->aiCurOnePass[1] = -1;
  130641. pWInfo->nLevel = nTabList;
  130642. pWInfo->iBreak = pWInfo->iContinue = sqlite3VdbeMakeLabel(v);
  130643. pWInfo->wctrlFlags = wctrlFlags;
  130644. pWInfo->iLimit = iAuxArg;
  130645. pWInfo->savedNQueryLoop = pParse->nQueryLoop;
  130646. memset(&pWInfo->nOBSat, 0,
  130647. offsetof(WhereInfo,sWC) - offsetof(WhereInfo,nOBSat));
  130648. memset(&pWInfo->a[0], 0, sizeof(WhereLoop)+nTabList*sizeof(WhereLevel));
  130649. assert( pWInfo->eOnePass==ONEPASS_OFF ); /* ONEPASS defaults to OFF */
  130650. pMaskSet = &pWInfo->sMaskSet;
  130651. sWLB.pWInfo = pWInfo;
  130652. sWLB.pWC = &pWInfo->sWC;
  130653. sWLB.pNew = (WhereLoop*)(((char*)pWInfo)+nByteWInfo);
  130654. assert( EIGHT_BYTE_ALIGNMENT(sWLB.pNew) );
  130655. whereLoopInit(sWLB.pNew);
  130656. #ifdef SQLITE_DEBUG
  130657. sWLB.pNew->cId = '*';
  130658. #endif
  130659. /* Split the WHERE clause into separate subexpressions where each
  130660. ** subexpression is separated by an AND operator.
  130661. */
  130662. initMaskSet(pMaskSet);
  130663. sqlite3WhereClauseInit(&pWInfo->sWC, pWInfo);
  130664. sqlite3WhereSplit(&pWInfo->sWC, pWhere, TK_AND);
  130665. /* Special case: No FROM clause
  130666. */
  130667. if( nTabList==0 ){
  130668. if( pOrderBy ) pWInfo->nOBSat = pOrderBy->nExpr;
  130669. if( wctrlFlags & WHERE_WANT_DISTINCT ){
  130670. pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
  130671. }
  130672. }else{
  130673. /* Assign a bit from the bitmask to every term in the FROM clause.
  130674. **
  130675. ** The N-th term of the FROM clause is assigned a bitmask of 1<<N.
  130676. **
  130677. ** The rule of the previous sentence ensures thta if X is the bitmask for
  130678. ** a table T, then X-1 is the bitmask for all other tables to the left of T.
  130679. ** Knowing the bitmask for all tables to the left of a left join is
  130680. ** important. Ticket #3015.
  130681. **
  130682. ** Note that bitmasks are created for all pTabList->nSrc tables in
  130683. ** pTabList, not just the first nTabList tables. nTabList is normally
  130684. ** equal to pTabList->nSrc but might be shortened to 1 if the
  130685. ** WHERE_OR_SUBCLAUSE flag is set.
  130686. */
  130687. ii = 0;
  130688. do{
  130689. createMask(pMaskSet, pTabList->a[ii].iCursor);
  130690. sqlite3WhereTabFuncArgs(pParse, &pTabList->a[ii], &pWInfo->sWC);
  130691. }while( (++ii)<pTabList->nSrc );
  130692. #ifdef SQLITE_DEBUG
  130693. {
  130694. Bitmask mx = 0;
  130695. for(ii=0; ii<pTabList->nSrc; ii++){
  130696. Bitmask m = sqlite3WhereGetMask(pMaskSet, pTabList->a[ii].iCursor);
  130697. assert( m>=mx );
  130698. mx = m;
  130699. }
  130700. }
  130701. #endif
  130702. }
  130703. /* Analyze all of the subexpressions. */
  130704. sqlite3WhereExprAnalyze(pTabList, &pWInfo->sWC);
  130705. if( db->mallocFailed ) goto whereBeginError;
  130706. /* Special case: WHERE terms that do not refer to any tables in the join
  130707. ** (constant expressions). Evaluate each such term, and jump over all the
  130708. ** generated code if the result is not true.
  130709. **
  130710. ** Do not do this if the expression contains non-deterministic functions
  130711. ** that are not within a sub-select. This is not strictly required, but
  130712. ** preserves SQLite's legacy behaviour in the following two cases:
  130713. **
  130714. ** FROM ... WHERE random()>0; -- eval random() once per row
  130715. ** FROM ... WHERE (SELECT random())>0; -- eval random() once overall
  130716. */
  130717. for(ii=0; ii<sWLB.pWC->nTerm; ii++){
  130718. WhereTerm *pT = &sWLB.pWC->a[ii];
  130719. if( pT->wtFlags & TERM_VIRTUAL ) continue;
  130720. if( pT->prereqAll==0 && (nTabList==0 || exprIsDeterministic(pT->pExpr)) ){
  130721. sqlite3ExprIfFalse(pParse, pT->pExpr, pWInfo->iBreak, SQLITE_JUMPIFNULL);
  130722. pT->wtFlags |= TERM_CODED;
  130723. }
  130724. }
  130725. if( wctrlFlags & WHERE_WANT_DISTINCT ){
  130726. if( isDistinctRedundant(pParse, pTabList, &pWInfo->sWC, pResultSet) ){
  130727. /* The DISTINCT marking is pointless. Ignore it. */
  130728. pWInfo->eDistinct = WHERE_DISTINCT_UNIQUE;
  130729. }else if( pOrderBy==0 ){
  130730. /* Try to ORDER BY the result set to make distinct processing easier */
  130731. pWInfo->wctrlFlags |= WHERE_DISTINCTBY;
  130732. pWInfo->pOrderBy = pResultSet;
  130733. }
  130734. }
  130735. /* Construct the WhereLoop objects */
  130736. #if defined(WHERETRACE_ENABLED)
  130737. if( sqlite3WhereTrace & 0xffff ){
  130738. sqlite3DebugPrintf("*** Optimizer Start *** (wctrlFlags: 0x%x",wctrlFlags);
  130739. if( wctrlFlags & WHERE_USE_LIMIT ){
  130740. sqlite3DebugPrintf(", limit: %d", iAuxArg);
  130741. }
  130742. sqlite3DebugPrintf(")\n");
  130743. }
  130744. if( sqlite3WhereTrace & 0x100 ){ /* Display all terms of the WHERE clause */
  130745. sqlite3WhereClausePrint(sWLB.pWC);
  130746. }
  130747. #endif
  130748. if( nTabList!=1 || whereShortCut(&sWLB)==0 ){
  130749. rc = whereLoopAddAll(&sWLB);
  130750. if( rc ) goto whereBeginError;
  130751. #ifdef WHERETRACE_ENABLED
  130752. if( sqlite3WhereTrace ){ /* Display all of the WhereLoop objects */
  130753. WhereLoop *p;
  130754. int i;
  130755. static const char zLabel[] = "0123456789abcdefghijklmnopqrstuvwyxz"
  130756. "ABCDEFGHIJKLMNOPQRSTUVWYXZ";
  130757. for(p=pWInfo->pLoops, i=0; p; p=p->pNextLoop, i++){
  130758. p->cId = zLabel[i%(sizeof(zLabel)-1)];
  130759. whereLoopPrint(p, sWLB.pWC);
  130760. }
  130761. }
  130762. #endif
  130763. wherePathSolver(pWInfo, 0);
  130764. if( db->mallocFailed ) goto whereBeginError;
  130765. if( pWInfo->pOrderBy ){
  130766. wherePathSolver(pWInfo, pWInfo->nRowOut+1);
  130767. if( db->mallocFailed ) goto whereBeginError;
  130768. }
  130769. }
  130770. if( pWInfo->pOrderBy==0 && (db->flags & SQLITE_ReverseOrder)!=0 ){
  130771. pWInfo->revMask = ALLBITS;
  130772. }
  130773. if( pParse->nErr || NEVER(db->mallocFailed) ){
  130774. goto whereBeginError;
  130775. }
  130776. #ifdef WHERETRACE_ENABLED
  130777. if( sqlite3WhereTrace ){
  130778. sqlite3DebugPrintf("---- Solution nRow=%d", pWInfo->nRowOut);
  130779. if( pWInfo->nOBSat>0 ){
  130780. sqlite3DebugPrintf(" ORDERBY=%d,0x%llx", pWInfo->nOBSat, pWInfo->revMask);
  130781. }
  130782. switch( pWInfo->eDistinct ){
  130783. case WHERE_DISTINCT_UNIQUE: {
  130784. sqlite3DebugPrintf(" DISTINCT=unique");
  130785. break;
  130786. }
  130787. case WHERE_DISTINCT_ORDERED: {
  130788. sqlite3DebugPrintf(" DISTINCT=ordered");
  130789. break;
  130790. }
  130791. case WHERE_DISTINCT_UNORDERED: {
  130792. sqlite3DebugPrintf(" DISTINCT=unordered");
  130793. break;
  130794. }
  130795. }
  130796. sqlite3DebugPrintf("\n");
  130797. for(ii=0; ii<pWInfo->nLevel; ii++){
  130798. whereLoopPrint(pWInfo->a[ii].pWLoop, sWLB.pWC);
  130799. }
  130800. }
  130801. #endif
  130802. /* Attempt to omit tables from the join that do not affect the result.
  130803. ** For a table to not affect the result, the following must be true:
  130804. **
  130805. ** 1) The query must not be an aggregate.
  130806. ** 2) The table must be the RHS of a LEFT JOIN.
  130807. ** 3) Either the query must be DISTINCT, or else the ON or USING clause
  130808. ** must contain a constraint that limits the scan of the table to
  130809. ** at most a single row.
  130810. ** 4) The table must not be referenced by any part of the query apart
  130811. ** from its own USING or ON clause.
  130812. **
  130813. ** For example, given:
  130814. **
  130815. ** CREATE TABLE t1(ipk INTEGER PRIMARY KEY, v1);
  130816. ** CREATE TABLE t2(ipk INTEGER PRIMARY KEY, v2);
  130817. ** CREATE TABLE t3(ipk INTEGER PRIMARY KEY, v3);
  130818. **
  130819. ** then table t2 can be omitted from the following:
  130820. **
  130821. ** SELECT v1, v3 FROM t1
  130822. ** LEFT JOIN t2 USING (t1.ipk=t2.ipk)
  130823. ** LEFT JOIN t3 USING (t1.ipk=t3.ipk)
  130824. **
  130825. ** or from:
  130826. **
  130827. ** SELECT DISTINCT v1, v3 FROM t1
  130828. ** LEFT JOIN t2
  130829. ** LEFT JOIN t3 USING (t1.ipk=t3.ipk)
  130830. */
  130831. notReady = ~(Bitmask)0;
  130832. if( pWInfo->nLevel>=2
  130833. && pResultSet!=0 /* guarantees condition (1) above */
  130834. && OptimizationEnabled(db, SQLITE_OmitNoopJoin)
  130835. ){
  130836. int i;
  130837. Bitmask tabUsed = sqlite3WhereExprListUsage(pMaskSet, pResultSet);
  130838. if( sWLB.pOrderBy ){
  130839. tabUsed |= sqlite3WhereExprListUsage(pMaskSet, sWLB.pOrderBy);
  130840. }
  130841. for(i=pWInfo->nLevel-1; i>=1; i--){
  130842. WhereTerm *pTerm, *pEnd;
  130843. struct SrcList_item *pItem;
  130844. pLoop = pWInfo->a[i].pWLoop;
  130845. pItem = &pWInfo->pTabList->a[pLoop->iTab];
  130846. if( (pItem->fg.jointype & JT_LEFT)==0 ) continue;
  130847. if( (wctrlFlags & WHERE_WANT_DISTINCT)==0
  130848. && (pLoop->wsFlags & WHERE_ONEROW)==0
  130849. ){
  130850. continue;
  130851. }
  130852. if( (tabUsed & pLoop->maskSelf)!=0 ) continue;
  130853. pEnd = sWLB.pWC->a + sWLB.pWC->nTerm;
  130854. for(pTerm=sWLB.pWC->a; pTerm<pEnd; pTerm++){
  130855. if( (pTerm->prereqAll & pLoop->maskSelf)!=0 ){
  130856. if( !ExprHasProperty(pTerm->pExpr, EP_FromJoin)
  130857. || pTerm->pExpr->iRightJoinTable!=pItem->iCursor
  130858. ){
  130859. break;
  130860. }
  130861. }
  130862. }
  130863. if( pTerm<pEnd ) continue;
  130864. WHERETRACE(0xffff, ("-> drop loop %c not used\n", pLoop->cId));
  130865. notReady &= ~pLoop->maskSelf;
  130866. for(pTerm=sWLB.pWC->a; pTerm<pEnd; pTerm++){
  130867. if( (pTerm->prereqAll & pLoop->maskSelf)!=0 ){
  130868. pTerm->wtFlags |= TERM_CODED;
  130869. }
  130870. }
  130871. if( i!=pWInfo->nLevel-1 ){
  130872. int nByte = (pWInfo->nLevel-1-i) * sizeof(WhereLevel);
  130873. memmove(&pWInfo->a[i], &pWInfo->a[i+1], nByte);
  130874. }
  130875. pWInfo->nLevel--;
  130876. nTabList--;
  130877. }
  130878. }
  130879. WHERETRACE(0xffff,("*** Optimizer Finished ***\n"));
  130880. pWInfo->pParse->nQueryLoop += pWInfo->nRowOut;
  130881. /* If the caller is an UPDATE or DELETE statement that is requesting
  130882. ** to use a one-pass algorithm, determine if this is appropriate.
  130883. **
  130884. ** A one-pass approach can be used if the caller has requested one
  130885. ** and either (a) the scan visits at most one row or (b) each
  130886. ** of the following are true:
  130887. **
  130888. ** * the caller has indicated that a one-pass approach can be used
  130889. ** with multiple rows (by setting WHERE_ONEPASS_MULTIROW), and
  130890. ** * the table is not a virtual table, and
  130891. ** * either the scan does not use the OR optimization or the caller
  130892. ** is a DELETE operation (WHERE_DUPLICATES_OK is only specified
  130893. ** for DELETE).
  130894. **
  130895. ** The last qualification is because an UPDATE statement uses
  130896. ** WhereInfo.aiCurOnePass[1] to determine whether or not it really can
  130897. ** use a one-pass approach, and this is not set accurately for scans
  130898. ** that use the OR optimization.
  130899. */
  130900. assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
  130901. if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 ){
  130902. int wsFlags = pWInfo->a[0].pWLoop->wsFlags;
  130903. int bOnerow = (wsFlags & WHERE_ONEROW)!=0;
  130904. if( bOnerow || (
  130905. 0!=(wctrlFlags & WHERE_ONEPASS_MULTIROW)
  130906. && 0==(wsFlags & WHERE_VIRTUALTABLE)
  130907. && (0==(wsFlags & WHERE_MULTI_OR) || (wctrlFlags & WHERE_DUPLICATES_OK))
  130908. )){
  130909. pWInfo->eOnePass = bOnerow ? ONEPASS_SINGLE : ONEPASS_MULTI;
  130910. if( HasRowid(pTabList->a[0].pTab) && (wsFlags & WHERE_IDX_ONLY) ){
  130911. if( wctrlFlags & WHERE_ONEPASS_MULTIROW ){
  130912. bFordelete = OPFLAG_FORDELETE;
  130913. }
  130914. pWInfo->a[0].pWLoop->wsFlags = (wsFlags & ~WHERE_IDX_ONLY);
  130915. }
  130916. }
  130917. }
  130918. /* Open all tables in the pTabList and any indices selected for
  130919. ** searching those tables.
  130920. */
  130921. for(ii=0, pLevel=pWInfo->a; ii<nTabList; ii++, pLevel++){
  130922. Table *pTab; /* Table to open */
  130923. int iDb; /* Index of database containing table/index */
  130924. struct SrcList_item *pTabItem;
  130925. pTabItem = &pTabList->a[pLevel->iFrom];
  130926. pTab = pTabItem->pTab;
  130927. iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
  130928. pLoop = pLevel->pWLoop;
  130929. if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ){
  130930. /* Do nothing */
  130931. }else
  130932. #ifndef SQLITE_OMIT_VIRTUALTABLE
  130933. if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
  130934. const char *pVTab = (const char *)sqlite3GetVTable(db, pTab);
  130935. int iCur = pTabItem->iCursor;
  130936. sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0, pVTab, P4_VTAB);
  130937. }else if( IsVirtual(pTab) ){
  130938. /* noop */
  130939. }else
  130940. #endif
  130941. if( (pLoop->wsFlags & WHERE_IDX_ONLY)==0
  130942. && (wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
  130943. int op = OP_OpenRead;
  130944. if( pWInfo->eOnePass!=ONEPASS_OFF ){
  130945. op = OP_OpenWrite;
  130946. pWInfo->aiCurOnePass[0] = pTabItem->iCursor;
  130947. };
  130948. sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
  130949. assert( pTabItem->iCursor==pLevel->iTabCur );
  130950. testcase( pWInfo->eOnePass==ONEPASS_OFF && pTab->nCol==BMS-1 );
  130951. testcase( pWInfo->eOnePass==ONEPASS_OFF && pTab->nCol==BMS );
  130952. if( pWInfo->eOnePass==ONEPASS_OFF && pTab->nCol<BMS && HasRowid(pTab) ){
  130953. Bitmask b = pTabItem->colUsed;
  130954. int n = 0;
  130955. for(; b; b=b>>1, n++){}
  130956. sqlite3VdbeChangeP4(v, -1, SQLITE_INT_TO_PTR(n), P4_INT32);
  130957. assert( n<=pTab->nCol );
  130958. }
  130959. #ifdef SQLITE_ENABLE_CURSOR_HINTS
  130960. if( pLoop->u.btree.pIndex!=0 ){
  130961. sqlite3VdbeChangeP5(v, OPFLAG_SEEKEQ|bFordelete);
  130962. }else
  130963. #endif
  130964. {
  130965. sqlite3VdbeChangeP5(v, bFordelete);
  130966. }
  130967. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  130968. sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed, pTabItem->iCursor, 0, 0,
  130969. (const u8*)&pTabItem->colUsed, P4_INT64);
  130970. #endif
  130971. }else{
  130972. sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
  130973. }
  130974. if( pLoop->wsFlags & WHERE_INDEXED ){
  130975. Index *pIx = pLoop->u.btree.pIndex;
  130976. int iIndexCur;
  130977. int op = OP_OpenRead;
  130978. /* iAuxArg is always set to a positive value if ONEPASS is possible */
  130979. assert( iAuxArg!=0 || (pWInfo->wctrlFlags & WHERE_ONEPASS_DESIRED)==0 );
  130980. if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIx)
  130981. && (wctrlFlags & WHERE_OR_SUBCLAUSE)!=0
  130982. ){
  130983. /* This is one term of an OR-optimization using the PRIMARY KEY of a
  130984. ** WITHOUT ROWID table. No need for a separate index */
  130985. iIndexCur = pLevel->iTabCur;
  130986. op = 0;
  130987. }else if( pWInfo->eOnePass!=ONEPASS_OFF ){
  130988. Index *pJ = pTabItem->pTab->pIndex;
  130989. iIndexCur = iAuxArg;
  130990. assert( wctrlFlags & WHERE_ONEPASS_DESIRED );
  130991. while( ALWAYS(pJ) && pJ!=pIx ){
  130992. iIndexCur++;
  130993. pJ = pJ->pNext;
  130994. }
  130995. op = OP_OpenWrite;
  130996. pWInfo->aiCurOnePass[1] = iIndexCur;
  130997. }else if( iAuxArg && (wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 ){
  130998. iIndexCur = iAuxArg;
  130999. op = OP_ReopenIdx;
  131000. }else{
  131001. iIndexCur = pParse->nTab++;
  131002. }
  131003. pLevel->iIdxCur = iIndexCur;
  131004. assert( pIx->pSchema==pTab->pSchema );
  131005. assert( iIndexCur>=0 );
  131006. if( op ){
  131007. sqlite3VdbeAddOp3(v, op, iIndexCur, pIx->tnum, iDb);
  131008. sqlite3VdbeSetP4KeyInfo(pParse, pIx);
  131009. if( (pLoop->wsFlags & WHERE_CONSTRAINT)!=0
  131010. && (pLoop->wsFlags & (WHERE_COLUMN_RANGE|WHERE_SKIPSCAN))==0
  131011. && (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0
  131012. && pWInfo->eDistinct!=WHERE_DISTINCT_ORDERED
  131013. ){
  131014. sqlite3VdbeChangeP5(v, OPFLAG_SEEKEQ); /* Hint to COMDB2 */
  131015. }
  131016. VdbeComment((v, "%s", pIx->zName));
  131017. #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
  131018. {
  131019. u64 colUsed = 0;
  131020. int ii, jj;
  131021. for(ii=0; ii<pIx->nColumn; ii++){
  131022. jj = pIx->aiColumn[ii];
  131023. if( jj<0 ) continue;
  131024. if( jj>63 ) jj = 63;
  131025. if( (pTabItem->colUsed & MASKBIT(jj))==0 ) continue;
  131026. colUsed |= ((u64)1)<<(ii<63 ? ii : 63);
  131027. }
  131028. sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed, iIndexCur, 0, 0,
  131029. (u8*)&colUsed, P4_INT64);
  131030. }
  131031. #endif /* SQLITE_ENABLE_COLUMN_USED_MASK */
  131032. }
  131033. }
  131034. if( iDb>=0 ) sqlite3CodeVerifySchema(pParse, iDb);
  131035. }
  131036. pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
  131037. if( db->mallocFailed ) goto whereBeginError;
  131038. /* Generate the code to do the search. Each iteration of the for
  131039. ** loop below generates code for a single nested loop of the VM
  131040. ** program.
  131041. */
  131042. for(ii=0; ii<nTabList; ii++){
  131043. int addrExplain;
  131044. int wsFlags;
  131045. pLevel = &pWInfo->a[ii];
  131046. wsFlags = pLevel->pWLoop->wsFlags;
  131047. #ifndef SQLITE_OMIT_AUTOMATIC_INDEX
  131048. if( (pLevel->pWLoop->wsFlags & WHERE_AUTO_INDEX)!=0 ){
  131049. constructAutomaticIndex(pParse, &pWInfo->sWC,
  131050. &pTabList->a[pLevel->iFrom], notReady, pLevel);
  131051. if( db->mallocFailed ) goto whereBeginError;
  131052. }
  131053. #endif
  131054. addrExplain = sqlite3WhereExplainOneScan(
  131055. pParse, pTabList, pLevel, ii, pLevel->iFrom, wctrlFlags
  131056. );
  131057. pLevel->addrBody = sqlite3VdbeCurrentAddr(v);
  131058. notReady = sqlite3WhereCodeOneLoopStart(pWInfo, ii, notReady);
  131059. pWInfo->iContinue = pLevel->addrCont;
  131060. if( (wsFlags&WHERE_MULTI_OR)==0 && (wctrlFlags&WHERE_OR_SUBCLAUSE)==0 ){
  131061. sqlite3WhereAddScanStatus(v, pTabList, pLevel, addrExplain);
  131062. }
  131063. }
  131064. /* Done. */
  131065. VdbeModuleComment((v, "Begin WHERE-core"));
  131066. return pWInfo;
  131067. /* Jump here if malloc fails */
  131068. whereBeginError:
  131069. if( pWInfo ){
  131070. pParse->nQueryLoop = pWInfo->savedNQueryLoop;
  131071. whereInfoFree(db, pWInfo);
  131072. }
  131073. return 0;
  131074. }
  131075. /*
  131076. ** Generate the end of the WHERE loop. See comments on
  131077. ** sqlite3WhereBegin() for additional information.
  131078. */
  131079. SQLITE_PRIVATE void sqlite3WhereEnd(WhereInfo *pWInfo){
  131080. Parse *pParse = pWInfo->pParse;
  131081. Vdbe *v = pParse->pVdbe;
  131082. int i;
  131083. WhereLevel *pLevel;
  131084. WhereLoop *pLoop;
  131085. SrcList *pTabList = pWInfo->pTabList;
  131086. sqlite3 *db = pParse->db;
  131087. /* Generate loop termination code.
  131088. */
  131089. VdbeModuleComment((v, "End WHERE-core"));
  131090. sqlite3ExprCacheClear(pParse);
  131091. for(i=pWInfo->nLevel-1; i>=0; i--){
  131092. int addr;
  131093. pLevel = &pWInfo->a[i];
  131094. pLoop = pLevel->pWLoop;
  131095. if( pLevel->op!=OP_Noop ){
  131096. #ifndef SQLITE_DISABLE_SKIPAHEAD_DISTINCT
  131097. int addrSeek = 0;
  131098. Index *pIdx;
  131099. int n;
  131100. if( pWInfo->eDistinct==WHERE_DISTINCT_ORDERED
  131101. && i==pWInfo->nLevel-1 /* Ticket [ef9318757b152e3] 2017-10-21 */
  131102. && (pLoop->wsFlags & WHERE_INDEXED)!=0
  131103. && (pIdx = pLoop->u.btree.pIndex)->hasStat1
  131104. && (n = pLoop->u.btree.nIdxCol)>0
  131105. && pIdx->aiRowLogEst[n]>=36
  131106. ){
  131107. int r1 = pParse->nMem+1;
  131108. int j, op;
  131109. for(j=0; j<n; j++){
  131110. sqlite3VdbeAddOp3(v, OP_Column, pLevel->iIdxCur, j, r1+j);
  131111. }
  131112. pParse->nMem += n+1;
  131113. op = pLevel->op==OP_Prev ? OP_SeekLT : OP_SeekGT;
  131114. addrSeek = sqlite3VdbeAddOp4Int(v, op, pLevel->iIdxCur, 0, r1, n);
  131115. VdbeCoverageIf(v, op==OP_SeekLT);
  131116. VdbeCoverageIf(v, op==OP_SeekGT);
  131117. sqlite3VdbeAddOp2(v, OP_Goto, 1, pLevel->p2);
  131118. }
  131119. #endif /* SQLITE_DISABLE_SKIPAHEAD_DISTINCT */
  131120. /* The common case: Advance to the next row */
  131121. sqlite3VdbeResolveLabel(v, pLevel->addrCont);
  131122. sqlite3VdbeAddOp3(v, pLevel->op, pLevel->p1, pLevel->p2, pLevel->p3);
  131123. sqlite3VdbeChangeP5(v, pLevel->p5);
  131124. VdbeCoverage(v);
  131125. VdbeCoverageIf(v, pLevel->op==OP_Next);
  131126. VdbeCoverageIf(v, pLevel->op==OP_Prev);
  131127. VdbeCoverageIf(v, pLevel->op==OP_VNext);
  131128. #ifndef SQLITE_DISABLE_SKIPAHEAD_DISTINCT
  131129. if( addrSeek ) sqlite3VdbeJumpHere(v, addrSeek);
  131130. #endif
  131131. }else{
  131132. sqlite3VdbeResolveLabel(v, pLevel->addrCont);
  131133. }
  131134. if( pLoop->wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
  131135. struct InLoop *pIn;
  131136. int j;
  131137. sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
  131138. for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
  131139. sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
  131140. if( pIn->eEndLoopOp!=OP_Noop ){
  131141. sqlite3VdbeAddOp2(v, pIn->eEndLoopOp, pIn->iCur, pIn->addrInTop);
  131142. VdbeCoverage(v);
  131143. VdbeCoverageIf(v, pIn->eEndLoopOp==OP_PrevIfOpen);
  131144. VdbeCoverageIf(v, pIn->eEndLoopOp==OP_NextIfOpen);
  131145. }
  131146. sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
  131147. }
  131148. }
  131149. sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
  131150. if( pLevel->addrSkip ){
  131151. sqlite3VdbeGoto(v, pLevel->addrSkip);
  131152. VdbeComment((v, "next skip-scan on %s", pLoop->u.btree.pIndex->zName));
  131153. sqlite3VdbeJumpHere(v, pLevel->addrSkip);
  131154. sqlite3VdbeJumpHere(v, pLevel->addrSkip-2);
  131155. }
  131156. #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
  131157. if( pLevel->addrLikeRep ){
  131158. sqlite3VdbeAddOp2(v, OP_DecrJumpZero, (int)(pLevel->iLikeRepCntr>>1),
  131159. pLevel->addrLikeRep);
  131160. VdbeCoverage(v);
  131161. }
  131162. #endif
  131163. if( pLevel->iLeftJoin ){
  131164. int ws = pLoop->wsFlags;
  131165. addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin); VdbeCoverage(v);
  131166. assert( (ws & WHERE_IDX_ONLY)==0 || (ws & WHERE_INDEXED)!=0 );
  131167. if( (ws & WHERE_IDX_ONLY)==0 ){
  131168. assert( pLevel->iTabCur==pTabList->a[pLevel->iFrom].iCursor );
  131169. sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iTabCur);
  131170. }
  131171. if( (ws & WHERE_INDEXED)
  131172. || ((ws & WHERE_MULTI_OR) && pLevel->u.pCovidx)
  131173. ){
  131174. sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
  131175. }
  131176. if( pLevel->op==OP_Return ){
  131177. sqlite3VdbeAddOp2(v, OP_Gosub, pLevel->p1, pLevel->addrFirst);
  131178. }else{
  131179. sqlite3VdbeGoto(v, pLevel->addrFirst);
  131180. }
  131181. sqlite3VdbeJumpHere(v, addr);
  131182. }
  131183. VdbeModuleComment((v, "End WHERE-loop%d: %s", i,
  131184. pWInfo->pTabList->a[pLevel->iFrom].pTab->zName));
  131185. }
  131186. /* The "break" point is here, just past the end of the outer loop.
  131187. ** Set it.
  131188. */
  131189. sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
  131190. assert( pWInfo->nLevel<=pTabList->nSrc );
  131191. for(i=0, pLevel=pWInfo->a; i<pWInfo->nLevel; i++, pLevel++){
  131192. int k, last;
  131193. VdbeOp *pOp;
  131194. Index *pIdx = 0;
  131195. struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
  131196. Table *pTab = pTabItem->pTab;
  131197. assert( pTab!=0 );
  131198. pLoop = pLevel->pWLoop;
  131199. /* For a co-routine, change all OP_Column references to the table of
  131200. ** the co-routine into OP_Copy of result contained in a register.
  131201. ** OP_Rowid becomes OP_Null.
  131202. */
  131203. if( pTabItem->fg.viaCoroutine ){
  131204. testcase( pParse->db->mallocFailed );
  131205. translateColumnToCopy(pParse, pLevel->addrBody, pLevel->iTabCur,
  131206. pTabItem->regResult, 0);
  131207. continue;
  131208. }
  131209. /* If this scan uses an index, make VDBE code substitutions to read data
  131210. ** from the index instead of from the table where possible. In some cases
  131211. ** this optimization prevents the table from ever being read, which can
  131212. ** yield a significant performance boost.
  131213. **
  131214. ** Calls to the code generator in between sqlite3WhereBegin and
  131215. ** sqlite3WhereEnd will have created code that references the table
  131216. ** directly. This loop scans all that code looking for opcodes
  131217. ** that reference the table and converts them into opcodes that
  131218. ** reference the index.
  131219. */
  131220. if( pLoop->wsFlags & (WHERE_INDEXED|WHERE_IDX_ONLY) ){
  131221. pIdx = pLoop->u.btree.pIndex;
  131222. }else if( pLoop->wsFlags & WHERE_MULTI_OR ){
  131223. pIdx = pLevel->u.pCovidx;
  131224. }
  131225. if( pIdx
  131226. && (pWInfo->eOnePass==ONEPASS_OFF || !HasRowid(pIdx->pTable))
  131227. && !db->mallocFailed
  131228. ){
  131229. last = sqlite3VdbeCurrentAddr(v);
  131230. k = pLevel->addrBody;
  131231. pOp = sqlite3VdbeGetOp(v, k);
  131232. for(; k<last; k++, pOp++){
  131233. if( pOp->p1!=pLevel->iTabCur ) continue;
  131234. if( pOp->opcode==OP_Column
  131235. #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
  131236. || pOp->opcode==OP_Offset
  131237. #endif
  131238. ){
  131239. int x = pOp->p2;
  131240. assert( pIdx->pTable==pTab );
  131241. if( !HasRowid(pTab) ){
  131242. Index *pPk = sqlite3PrimaryKeyIndex(pTab);
  131243. x = pPk->aiColumn[x];
  131244. assert( x>=0 );
  131245. }
  131246. x = sqlite3ColumnOfIndex(pIdx, x);
  131247. if( x>=0 ){
  131248. pOp->p2 = x;
  131249. pOp->p1 = pLevel->iIdxCur;
  131250. }
  131251. assert( (pLoop->wsFlags & WHERE_IDX_ONLY)==0 || x>=0
  131252. || pWInfo->eOnePass );
  131253. }else if( pOp->opcode==OP_Rowid ){
  131254. pOp->p1 = pLevel->iIdxCur;
  131255. pOp->opcode = OP_IdxRowid;
  131256. }else if( pOp->opcode==OP_IfNullRow ){
  131257. pOp->p1 = pLevel->iIdxCur;
  131258. }
  131259. }
  131260. }
  131261. }
  131262. /* Final cleanup
  131263. */
  131264. pParse->nQueryLoop = pWInfo->savedNQueryLoop;
  131265. whereInfoFree(db, pWInfo);
  131266. return;
  131267. }
  131268. /************** End of where.c ***********************************************/
  131269. /************** Begin file parse.c *******************************************/
  131270. /*
  131271. ** 2000-05-29
  131272. **
  131273. ** The author disclaims copyright to this source code. In place of
  131274. ** a legal notice, here is a blessing:
  131275. **
  131276. ** May you do good and not evil.
  131277. ** May you find forgiveness for yourself and forgive others.
  131278. ** May you share freely, never taking more than you give.
  131279. **
  131280. *************************************************************************
  131281. ** Driver template for the LEMON parser generator.
  131282. **
  131283. ** The "lemon" program processes an LALR(1) input grammar file, then uses
  131284. ** this template to construct a parser. The "lemon" program inserts text
  131285. ** at each "%%" line. Also, any "P-a-r-s-e" identifer prefix (without the
  131286. ** interstitial "-" characters) contained in this template is changed into
  131287. ** the value of the %name directive from the grammar. Otherwise, the content
  131288. ** of this template is copied straight through into the generate parser
  131289. ** source file.
  131290. **
  131291. ** The following is the concatenation of all %include directives from the
  131292. ** input grammar file:
  131293. */
  131294. /* #include <stdio.h> */
  131295. /************ Begin %include sections from the grammar ************************/
  131296. /* #include "sqliteInt.h" */
  131297. /*
  131298. ** Disable all error recovery processing in the parser push-down
  131299. ** automaton.
  131300. */
  131301. #define YYNOERRORRECOVERY 1
  131302. /*
  131303. ** Make yytestcase() the same as testcase()
  131304. */
  131305. #define yytestcase(X) testcase(X)
  131306. /*
  131307. ** Indicate that sqlite3ParserFree() will never be called with a null
  131308. ** pointer.
  131309. */
  131310. #define YYPARSEFREENEVERNULL 1
  131311. /*
  131312. ** In the amalgamation, the parse.c file generated by lemon and the
  131313. ** tokenize.c file are concatenated. In that case, sqlite3RunParser()
  131314. ** has access to the the size of the yyParser object and so the parser
  131315. ** engine can be allocated from stack. In that case, only the
  131316. ** sqlite3ParserInit() and sqlite3ParserFinalize() routines are invoked
  131317. ** and the sqlite3ParserAlloc() and sqlite3ParserFree() routines can be
  131318. ** omitted.
  131319. */
  131320. #ifdef SQLITE_AMALGAMATION
  131321. # define sqlite3Parser_ENGINEALWAYSONSTACK 1
  131322. #endif
  131323. /*
  131324. ** Alternative datatype for the argument to the malloc() routine passed
  131325. ** into sqlite3ParserAlloc(). The default is size_t.
  131326. */
  131327. #define YYMALLOCARGTYPE u64
  131328. /*
  131329. ** An instance of the following structure describes the event of a
  131330. ** TRIGGER. "a" is the event type, one of TK_UPDATE, TK_INSERT,
  131331. ** TK_DELETE, or TK_INSTEAD. If the event is of the form
  131332. **
  131333. ** UPDATE ON (a,b,c)
  131334. **
  131335. ** Then the "b" IdList records the list "a,b,c".
  131336. */
  131337. struct TrigEvent { int a; IdList * b; };
  131338. /*
  131339. ** Disable lookaside memory allocation for objects that might be
  131340. ** shared across database connections.
  131341. */
  131342. static void disableLookaside(Parse *pParse){
  131343. pParse->disableLookaside++;
  131344. pParse->db->lookaside.bDisable++;
  131345. }
  131346. /*
  131347. ** For a compound SELECT statement, make sure p->pPrior->pNext==p for
  131348. ** all elements in the list. And make sure list length does not exceed
  131349. ** SQLITE_LIMIT_COMPOUND_SELECT.
  131350. */
  131351. static void parserDoubleLinkSelect(Parse *pParse, Select *p){
  131352. if( p->pPrior ){
  131353. Select *pNext = 0, *pLoop;
  131354. int mxSelect, cnt = 0;
  131355. for(pLoop=p; pLoop; pNext=pLoop, pLoop=pLoop->pPrior, cnt++){
  131356. pLoop->pNext = pNext;
  131357. pLoop->selFlags |= SF_Compound;
  131358. }
  131359. if( (p->selFlags & SF_MultiValue)==0 &&
  131360. (mxSelect = pParse->db->aLimit[SQLITE_LIMIT_COMPOUND_SELECT])>0 &&
  131361. cnt>mxSelect
  131362. ){
  131363. sqlite3ErrorMsg(pParse, "too many terms in compound SELECT");
  131364. }
  131365. }
  131366. }
  131367. /* Construct a new Expr object from a single identifier. Use the
  131368. ** new Expr to populate pOut. Set the span of pOut to be the identifier
  131369. ** that created the expression.
  131370. */
  131371. static Expr *tokenExpr(Parse *pParse, int op, Token t){
  131372. Expr *p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr)+t.n+1);
  131373. if( p ){
  131374. memset(p, 0, sizeof(Expr));
  131375. p->op = (u8)op;
  131376. p->flags = EP_Leaf;
  131377. p->iAgg = -1;
  131378. p->u.zToken = (char*)&p[1];
  131379. memcpy(p->u.zToken, t.z, t.n);
  131380. p->u.zToken[t.n] = 0;
  131381. if( sqlite3Isquote(p->u.zToken[0]) ){
  131382. if( p->u.zToken[0]=='"' ) p->flags |= EP_DblQuoted;
  131383. sqlite3Dequote(p->u.zToken);
  131384. }
  131385. #if SQLITE_MAX_EXPR_DEPTH>0
  131386. p->nHeight = 1;
  131387. #endif
  131388. }
  131389. return p;
  131390. }
  131391. /* A routine to convert a binary TK_IS or TK_ISNOT expression into a
  131392. ** unary TK_ISNULL or TK_NOTNULL expression. */
  131393. static void binaryToUnaryIfNull(Parse *pParse, Expr *pY, Expr *pA, int op){
  131394. sqlite3 *db = pParse->db;
  131395. if( pA && pY && pY->op==TK_NULL ){
  131396. pA->op = (u8)op;
  131397. sqlite3ExprDelete(db, pA->pRight);
  131398. pA->pRight = 0;
  131399. }
  131400. }
  131401. /* Add a single new term to an ExprList that is used to store a
  131402. ** list of identifiers. Report an error if the ID list contains
  131403. ** a COLLATE clause or an ASC or DESC keyword, except ignore the
  131404. ** error while parsing a legacy schema.
  131405. */
  131406. static ExprList *parserAddExprIdListTerm(
  131407. Parse *pParse,
  131408. ExprList *pPrior,
  131409. Token *pIdToken,
  131410. int hasCollate,
  131411. int sortOrder
  131412. ){
  131413. ExprList *p = sqlite3ExprListAppend(pParse, pPrior, 0);
  131414. if( (hasCollate || sortOrder!=SQLITE_SO_UNDEFINED)
  131415. && pParse->db->init.busy==0
  131416. ){
  131417. sqlite3ErrorMsg(pParse, "syntax error after column name \"%.*s\"",
  131418. pIdToken->n, pIdToken->z);
  131419. }
  131420. sqlite3ExprListSetName(pParse, p, pIdToken, 1);
  131421. return p;
  131422. }
  131423. /**************** End of %include directives **********************************/
  131424. /* These constants specify the various numeric values for terminal symbols
  131425. ** in a format understandable to "makeheaders". This section is blank unless
  131426. ** "lemon" is run with the "-m" command-line option.
  131427. ***************** Begin makeheaders token definitions *************************/
  131428. /**************** End makeheaders token definitions ***************************/
  131429. /* The next sections is a series of control #defines.
  131430. ** various aspects of the generated parser.
  131431. ** YYCODETYPE is the data type used to store the integer codes
  131432. ** that represent terminal and non-terminal symbols.
  131433. ** "unsigned char" is used if there are fewer than
  131434. ** 256 symbols. Larger types otherwise.
  131435. ** YYNOCODE is a number of type YYCODETYPE that is not used for
  131436. ** any terminal or nonterminal symbol.
  131437. ** YYFALLBACK If defined, this indicates that one or more tokens
  131438. ** (also known as: "terminal symbols") have fall-back
  131439. ** values which should be used if the original symbol
  131440. ** would not parse. This permits keywords to sometimes
  131441. ** be used as identifiers, for example.
  131442. ** YYACTIONTYPE is the data type used for "action codes" - numbers
  131443. ** that indicate what to do in response to the next
  131444. ** token.
  131445. ** sqlite3ParserTOKENTYPE is the data type used for minor type for terminal
  131446. ** symbols. Background: A "minor type" is a semantic
  131447. ** value associated with a terminal or non-terminal
  131448. ** symbols. For example, for an "ID" terminal symbol,
  131449. ** the minor type might be the name of the identifier.
  131450. ** Each non-terminal can have a different minor type.
  131451. ** Terminal symbols all have the same minor type, though.
  131452. ** This macros defines the minor type for terminal
  131453. ** symbols.
  131454. ** YYMINORTYPE is the data type used for all minor types.
  131455. ** This is typically a union of many types, one of
  131456. ** which is sqlite3ParserTOKENTYPE. The entry in the union
  131457. ** for terminal symbols is called "yy0".
  131458. ** YYSTACKDEPTH is the maximum depth of the parser's stack. If
  131459. ** zero the stack is dynamically sized using realloc()
  131460. ** sqlite3ParserARG_SDECL A static variable declaration for the %extra_argument
  131461. ** sqlite3ParserARG_PDECL A parameter declaration for the %extra_argument
  131462. ** sqlite3ParserARG_STORE Code to store %extra_argument into yypParser
  131463. ** sqlite3ParserARG_FETCH Code to extract %extra_argument from yypParser
  131464. ** YYERRORSYMBOL is the code number of the error symbol. If not
  131465. ** defined, then do no error processing.
  131466. ** YYNSTATE the combined number of states.
  131467. ** YYNRULE the number of rules in the grammar
  131468. ** YYNTOKEN Number of terminal symbols
  131469. ** YY_MAX_SHIFT Maximum value for shift actions
  131470. ** YY_MIN_SHIFTREDUCE Minimum value for shift-reduce actions
  131471. ** YY_MAX_SHIFTREDUCE Maximum value for shift-reduce actions
  131472. ** YY_ERROR_ACTION The yy_action[] code for syntax error
  131473. ** YY_ACCEPT_ACTION The yy_action[] code for accept
  131474. ** YY_NO_ACTION The yy_action[] code for no-op
  131475. ** YY_MIN_REDUCE Minimum value for reduce actions
  131476. ** YY_MAX_REDUCE Maximum value for reduce actions
  131477. */
  131478. #ifndef INTERFACE
  131479. # define INTERFACE 1
  131480. #endif
  131481. /************* Begin control #defines *****************************************/
  131482. #define YYCODETYPE unsigned char
  131483. #define YYNOCODE 253
  131484. #define YYACTIONTYPE unsigned short int
  131485. #define YYWILDCARD 83
  131486. #define sqlite3ParserTOKENTYPE Token
  131487. typedef union {
  131488. int yyinit;
  131489. sqlite3ParserTOKENTYPE yy0;
  131490. int yy4;
  131491. struct TrigEvent yy90;
  131492. TriggerStep* yy203;
  131493. struct {int value; int mask;} yy215;
  131494. SrcList* yy259;
  131495. Expr* yy314;
  131496. ExprList* yy322;
  131497. const char* yy336;
  131498. IdList* yy384;
  131499. Select* yy387;
  131500. With* yy451;
  131501. } YYMINORTYPE;
  131502. #ifndef YYSTACKDEPTH
  131503. #define YYSTACKDEPTH 100
  131504. #endif
  131505. #define sqlite3ParserARG_SDECL Parse *pParse;
  131506. #define sqlite3ParserARG_PDECL ,Parse *pParse
  131507. #define sqlite3ParserARG_FETCH Parse *pParse = yypParser->pParse
  131508. #define sqlite3ParserARG_STORE yypParser->pParse = pParse
  131509. #define YYFALLBACK 1
  131510. #define YYNSTATE 472
  131511. #define YYNRULE 333
  131512. #define YYNTOKEN 143
  131513. #define YY_MAX_SHIFT 471
  131514. #define YY_MIN_SHIFTREDUCE 681
  131515. #define YY_MAX_SHIFTREDUCE 1013
  131516. #define YY_ERROR_ACTION 1014
  131517. #define YY_ACCEPT_ACTION 1015
  131518. #define YY_NO_ACTION 1016
  131519. #define YY_MIN_REDUCE 1017
  131520. #define YY_MAX_REDUCE 1349
  131521. /************* End control #defines *******************************************/
  131522. /* Define the yytestcase() macro to be a no-op if is not already defined
  131523. ** otherwise.
  131524. **
  131525. ** Applications can choose to define yytestcase() in the %include section
  131526. ** to a macro that can assist in verifying code coverage. For production
  131527. ** code the yytestcase() macro should be turned off. But it is useful
  131528. ** for testing.
  131529. */
  131530. #ifndef yytestcase
  131531. # define yytestcase(X)
  131532. #endif
  131533. /* Next are the tables used to determine what action to take based on the
  131534. ** current state and lookahead token. These tables are used to implement
  131535. ** functions that take a state number and lookahead value and return an
  131536. ** action integer.
  131537. **
  131538. ** Suppose the action integer is N. Then the action is determined as
  131539. ** follows
  131540. **
  131541. ** 0 <= N <= YY_MAX_SHIFT Shift N. That is, push the lookahead
  131542. ** token onto the stack and goto state N.
  131543. **
  131544. ** N between YY_MIN_SHIFTREDUCE Shift to an arbitrary state then
  131545. ** and YY_MAX_SHIFTREDUCE reduce by rule N-YY_MIN_SHIFTREDUCE.
  131546. **
  131547. ** N == YY_ERROR_ACTION A syntax error has occurred.
  131548. **
  131549. ** N == YY_ACCEPT_ACTION The parser accepts its input.
  131550. **
  131551. ** N == YY_NO_ACTION No such action. Denotes unused
  131552. ** slots in the yy_action[] table.
  131553. **
  131554. ** N between YY_MIN_REDUCE Reduce by rule N-YY_MIN_REDUCE
  131555. ** and YY_MAX_REDUCE
  131556. **
  131557. ** The action table is constructed as a single large table named yy_action[].
  131558. ** Given state S and lookahead X, the action is computed as either:
  131559. **
  131560. ** (A) N = yy_action[ yy_shift_ofst[S] + X ]
  131561. ** (B) N = yy_default[S]
  131562. **
  131563. ** The (A) formula is preferred. The B formula is used instead if
  131564. ** yy_lookahead[yy_shift_ofst[S]+X] is not equal to X.
  131565. **
  131566. ** The formulas above are for computing the action when the lookahead is
  131567. ** a terminal symbol. If the lookahead is a non-terminal (as occurs after
  131568. ** a reduce action) then the yy_reduce_ofst[] array is used in place of
  131569. ** the yy_shift_ofst[] array.
  131570. **
  131571. ** The following are the tables generated in this section:
  131572. **
  131573. ** yy_action[] A single table containing all actions.
  131574. ** yy_lookahead[] A table containing the lookahead for each entry in
  131575. ** yy_action. Used to detect hash collisions.
  131576. ** yy_shift_ofst[] For each state, the offset into yy_action for
  131577. ** shifting terminals.
  131578. ** yy_reduce_ofst[] For each state, the offset into yy_action for
  131579. ** shifting non-terminals after a reduce.
  131580. ** yy_default[] Default action for each state.
  131581. **
  131582. *********** Begin parsing tables **********************************************/
  131583. #define YY_ACTTAB_COUNT (1566)
  131584. static const YYACTIONTYPE yy_action[] = {
  131585. /* 0 */ 1169, 1015, 167, 167, 1, 168, 466, 1313, 466, 1083,
  131586. /* 10 */ 1062, 466, 97, 94, 183, 1057, 466, 329, 1083, 342,
  131587. /* 20 */ 97, 94, 183, 459, 459, 459, 436, 57, 57, 57,
  131588. /* 30 */ 57, 807, 57, 57, 367, 367, 367, 57, 57, 808,
  131589. /* 40 */ 1270, 1088, 1088, 104, 105, 95, 991, 991, 868, 871,
  131590. /* 50 */ 860, 860, 102, 102, 103, 103, 103, 103, 233, 233,
  131591. /* 60 */ 326, 1011, 449, 437, 449, 446, 351, 449, 461, 1142,
  131592. /* 70 */ 463, 342, 449, 426, 1316, 209, 180, 742, 80, 299,
  131593. /* 80 */ 857, 857, 869, 872, 101, 101, 101, 101, 100, 100,
  131594. /* 90 */ 99, 99, 99, 98, 368, 104, 105, 95, 991, 991,
  131595. /* 100 */ 868, 871, 860, 860, 102, 102, 103, 103, 103, 103,
  131596. /* 110 */ 99, 99, 99, 98, 368, 355, 97, 94, 183, 228,
  131597. /* 120 */ 106, 1012, 407, 342, 101, 101, 101, 101, 100, 100,
  131598. /* 130 */ 99, 99, 99, 98, 368, 861, 101, 101, 101, 101,
  131599. /* 140 */ 100, 100, 99, 99, 99, 98, 368, 104, 105, 95,
  131600. /* 150 */ 991, 991, 868, 871, 860, 860, 102, 102, 103, 103,
  131601. /* 160 */ 103, 103, 201, 368, 375, 420, 417, 416, 387, 273,
  131602. /* 170 */ 65, 97, 94, 183, 168, 342, 415, 951, 1343, 396,
  131603. /* 180 */ 66, 1343, 320, 959, 371, 970, 334, 340, 101, 101,
  131604. /* 190 */ 101, 101, 100, 100, 99, 99, 99, 98, 368, 104,
  131605. /* 200 */ 105, 95, 991, 991, 868, 871, 860, 860, 102, 102,
  131606. /* 210 */ 103, 103, 103, 103, 373, 100, 100, 99, 99, 99,
  131607. /* 220 */ 98, 368, 970, 971, 972, 201, 1100, 342, 420, 417,
  131608. /* 230 */ 416, 287, 366, 365, 337, 970, 1162, 463, 949, 415,
  131609. /* 240 */ 101, 101, 101, 101, 100, 100, 99, 99, 99, 98,
  131610. /* 250 */ 368, 104, 105, 95, 991, 991, 868, 871, 860, 860,
  131611. /* 260 */ 102, 102, 103, 103, 103, 103, 777, 241, 233, 233,
  131612. /* 270 */ 9, 847, 970, 971, 972, 390, 998, 1141, 998, 342,
  131613. /* 280 */ 463, 252, 829, 719, 98, 368, 840, 298, 338, 142,
  131614. /* 290 */ 839, 339, 101, 101, 101, 101, 100, 100, 99, 99,
  131615. /* 300 */ 99, 98, 368, 104, 105, 95, 991, 991, 868, 871,
  131616. /* 310 */ 860, 860, 102, 102, 103, 103, 103, 103, 272, 466,
  131617. /* 320 */ 392, 839, 839, 841, 97, 94, 183, 390, 1317, 253,
  131618. /* 330 */ 456, 342, 125, 166, 807, 712, 208, 407, 386, 970,
  131619. /* 340 */ 57, 57, 808, 238, 101, 101, 101, 101, 100, 100,
  131620. /* 350 */ 99, 99, 99, 98, 368, 104, 105, 95, 991, 991,
  131621. /* 360 */ 868, 871, 860, 860, 102, 102, 103, 103, 103, 103,
  131622. /* 370 */ 466, 108, 466, 267, 465, 442, 970, 971, 972, 261,
  131623. /* 380 */ 951, 1344, 909, 342, 1344, 142, 829, 848, 1292, 959,
  131624. /* 390 */ 371, 55, 55, 57, 57, 242, 101, 101, 101, 101,
  131625. /* 400 */ 100, 100, 99, 99, 99, 98, 368, 104, 105, 95,
  131626. /* 410 */ 991, 991, 868, 871, 860, 860, 102, 102, 103, 103,
  131627. /* 420 */ 103, 103, 272, 382, 262, 253, 456, 310, 364, 253,
  131628. /* 430 */ 456, 86, 264, 84, 266, 342, 441, 176, 175, 834,
  131629. /* 440 */ 464, 949, 767, 767, 332, 313, 1094, 396, 101, 101,
  131630. /* 450 */ 101, 101, 100, 100, 99, 99, 99, 98, 368, 104,
  131631. /* 460 */ 105, 95, 991, 991, 868, 871, 860, 860, 102, 102,
  131632. /* 470 */ 103, 103, 103, 103, 227, 227, 233, 233, 233, 233,
  131633. /* 480 */ 387, 273, 234, 234, 326, 950, 463, 342, 463, 298,
  131634. /* 490 */ 463, 914, 914, 404, 463, 1037, 123, 265, 27, 970,
  131635. /* 500 */ 101, 101, 101, 101, 100, 100, 99, 99, 99, 98,
  131636. /* 510 */ 368, 104, 105, 95, 991, 991, 868, 871, 860, 860,
  131637. /* 520 */ 102, 102, 103, 103, 103, 103, 435, 233, 233, 466,
  131638. /* 530 */ 285, 686, 687, 688, 127, 271, 970, 971, 972, 463,
  131639. /* 540 */ 1345, 327, 342, 407, 157, 1012, 988, 13, 13, 181,
  131640. /* 550 */ 41, 41, 101, 101, 101, 101, 100, 100, 99, 99,
  131641. /* 560 */ 99, 98, 368, 715, 794, 378, 104, 105, 95, 991,
  131642. /* 570 */ 991, 868, 871, 860, 860, 102, 102, 103, 103, 103,
  131643. /* 580 */ 103, 970, 378, 377, 346, 239, 847, 1086, 1086, 280,
  131644. /* 590 */ 1169, 283, 204, 203, 202, 177, 298, 342, 407, 298,
  131645. /* 600 */ 715, 840, 169, 299, 407, 839, 82, 101, 101, 101,
  131646. /* 610 */ 101, 100, 100, 99, 99, 99, 98, 368, 970, 971,
  131647. /* 620 */ 972, 104, 105, 95, 991, 991, 868, 871, 860, 860,
  131648. /* 630 */ 102, 102, 103, 103, 103, 103, 839, 839, 841, 362,
  131649. /* 640 */ 240, 124, 1169, 172, 126, 378, 1269, 1169, 1066, 342,
  131650. /* 650 */ 253, 456, 407, 407, 407, 396, 352, 401, 407, 429,
  131651. /* 660 */ 398, 85, 101, 101, 101, 101, 100, 100, 99, 99,
  131652. /* 670 */ 99, 98, 368, 104, 105, 95, 991, 991, 868, 871,
  131653. /* 680 */ 860, 860, 102, 102, 103, 103, 103, 103, 1169, 466,
  131654. /* 690 */ 230, 233, 233, 792, 1235, 1095, 1091, 1293, 1, 77,
  131655. /* 700 */ 278, 342, 205, 463, 974, 911, 1040, 348, 353, 911,
  131656. /* 710 */ 42, 42, 79, 403, 101, 101, 101, 101, 100, 100,
  131657. /* 720 */ 99, 99, 99, 98, 368, 104, 93, 95, 991, 991,
  131658. /* 730 */ 868, 871, 860, 860, 102, 102, 103, 103, 103, 103,
  131659. /* 740 */ 402, 9, 974, 243, 772, 458, 348, 232, 180, 771,
  131660. /* 750 */ 946, 312, 342, 328, 363, 349, 143, 831, 389, 1278,
  131661. /* 760 */ 211, 211, 21, 347, 432, 182, 101, 101, 101, 101,
  131662. /* 770 */ 100, 100, 99, 99, 99, 98, 368, 105, 95, 991,
  131663. /* 780 */ 991, 868, 871, 860, 860, 102, 102, 103, 103, 103,
  131664. /* 790 */ 103, 792, 724, 22, 732, 731, 233, 233, 1239, 256,
  131665. /* 800 */ 391, 274, 342, 211, 79, 360, 257, 413, 463, 397,
  131666. /* 810 */ 207, 288, 260, 450, 79, 1239, 1241, 101, 101, 101,
  131667. /* 820 */ 101, 100, 100, 99, 99, 99, 98, 368, 95, 991,
  131668. /* 830 */ 991, 868, 871, 860, 860, 102, 102, 103, 103, 103,
  131669. /* 840 */ 103, 91, 457, 296, 3, 233, 233, 5, 438, 212,
  131670. /* 850 */ 331, 394, 739, 740, 295, 898, 894, 463, 460, 207,
  131671. /* 860 */ 801, 1237, 722, 211, 698, 843, 1283, 101, 101, 101,
  131672. /* 870 */ 101, 100, 100, 99, 99, 99, 98, 368, 1239, 380,
  131673. /* 880 */ 357, 369, 233, 233, 989, 219, 236, 297, 423, 292,
  131674. /* 890 */ 422, 206, 454, 898, 463, 970, 91, 457, 290, 3,
  131675. /* 900 */ 722, 142, 268, 843, 847, 466, 1258, 149, 388, 425,
  131676. /* 910 */ 88, 89, 769, 460, 930, 87, 447, 90, 369, 468,
  131677. /* 920 */ 467, 385, 989, 839, 1257, 439, 57, 57, 395, 931,
  131678. /* 930 */ 1065, 158, 970, 971, 972, 772, 369, 471, 1019, 399,
  131679. /* 940 */ 771, 253, 456, 254, 932, 119, 891, 454, 233, 233,
  131680. /* 950 */ 4, 970, 1096, 275, 839, 839, 841, 842, 19, 847,
  131681. /* 960 */ 463, 449, 448, 163, 453, 88, 89, 776, 970, 1127,
  131682. /* 970 */ 279, 930, 90, 369, 468, 467, 91, 457, 839, 3,
  131683. /* 980 */ 235, 1064, 466, 1228, 233, 233, 931, 970, 970, 971,
  131684. /* 990 */ 972, 970, 908, 460, 908, 2, 463, 81, 457, 212,
  131685. /* 1000 */ 3, 932, 282, 10, 10, 970, 971, 972, 189, 839,
  131686. /* 1010 */ 839, 841, 842, 19, 460, 284, 369, 354, 907, 286,
  131687. /* 1020 */ 907, 753, 466, 1079, 970, 971, 972, 454, 970, 971,
  131688. /* 1030 */ 972, 754, 970, 1063, 989, 372, 792, 369, 1118, 847,
  131689. /* 1040 */ 291, 452, 466, 10, 10, 88, 89, 142, 454, 168,
  131690. /* 1050 */ 300, 412, 90, 369, 468, 467, 793, 356, 839, 706,
  131691. /* 1060 */ 847, 341, 121, 10, 10, 301, 88, 89, 379, 970,
  131692. /* 1070 */ 971, 972, 989, 90, 369, 468, 467, 244, 205, 839,
  131693. /* 1080 */ 1306, 245, 1135, 245, 250, 1168, 1114, 253, 456, 839,
  131694. /* 1090 */ 839, 841, 842, 19, 1125, 237, 122, 451, 1174, 733,
  131695. /* 1100 */ 324, 324, 323, 222, 321, 466, 1046, 695, 182, 225,
  131696. /* 1110 */ 839, 839, 841, 842, 19, 103, 103, 103, 103, 96,
  131697. /* 1120 */ 185, 466, 259, 1039, 1028, 170, 10, 10, 1027, 421,
  131698. /* 1130 */ 258, 1029, 1300, 708, 792, 466, 408, 734, 8, 347,
  131699. /* 1140 */ 444, 174, 12, 12, 290, 101, 101, 101, 101, 100,
  131700. /* 1150 */ 100, 99, 99, 99, 98, 368, 32, 32, 466, 187,
  131701. /* 1160 */ 466, 1111, 103, 103, 103, 103, 188, 466, 325, 138,
  131702. /* 1170 */ 186, 708, 303, 305, 307, 358, 970, 270, 393, 43,
  131703. /* 1180 */ 43, 44, 44, 1157, 333, 178, 418, 294, 45, 45,
  131704. /* 1190 */ 1232, 318, 101, 101, 101, 101, 100, 100, 99, 99,
  131705. /* 1200 */ 99, 98, 368, 381, 343, 366, 365, 466, 263, 253,
  131706. /* 1210 */ 456, 466, 1062, 970, 971, 972, 1231, 997, 309, 466,
  131707. /* 1220 */ 455, 466, 427, 466, 995, 173, 996, 1303, 46, 46,
  131708. /* 1230 */ 145, 376, 37, 37, 1006, 1277, 466, 214, 1275, 64,
  131709. /* 1240 */ 47, 47, 33, 33, 34, 34, 1003, 67, 466, 998,
  131710. /* 1250 */ 350, 998, 466, 155, 233, 233, 466, 36, 36, 24,
  131711. /* 1260 */ 140, 77, 1154, 466, 383, 466, 463, 428, 466, 48,
  131712. /* 1270 */ 48, 466, 147, 49, 49, 466, 150, 50, 50, 466,
  131713. /* 1280 */ 151, 152, 466, 384, 11, 11, 51, 51, 466, 110,
  131714. /* 1290 */ 110, 153, 52, 52, 411, 466, 38, 38, 466, 191,
  131715. /* 1300 */ 53, 53, 466, 54, 54, 466, 400, 466, 330, 39,
  131716. /* 1310 */ 39, 466, 1164, 466, 25, 466, 56, 56, 466, 131,
  131717. /* 1320 */ 131, 72, 466, 132, 132, 159, 133, 133, 61, 61,
  131718. /* 1330 */ 1226, 195, 40, 40, 111, 111, 58, 58, 406, 112,
  131719. /* 1340 */ 112, 466, 277, 113, 113, 466, 226, 466, 1246, 466,
  131720. /* 1350 */ 197, 466, 164, 466, 409, 466, 198, 466, 199, 466,
  131721. /* 1360 */ 335, 281, 109, 109, 466, 1030, 130, 130, 129, 129,
  131722. /* 1370 */ 117, 117, 116, 116, 114, 114, 115, 115, 60, 60,
  131723. /* 1380 */ 62, 62, 466, 359, 466, 59, 59, 424, 1082, 1081,
  131724. /* 1390 */ 1080, 724, 1073, 1054, 336, 293, 1053, 1052, 1315, 431,
  131725. /* 1400 */ 361, 76, 248, 31, 31, 35, 35, 1072, 249, 440,
  131726. /* 1410 */ 302, 434, 213, 1122, 6, 311, 1212, 107, 83, 251,
  131727. /* 1420 */ 78, 1123, 445, 220, 443, 1036, 304, 23, 1121, 469,
  131728. /* 1430 */ 965, 221, 223, 1104, 314, 224, 344, 317, 315, 316,
  131729. /* 1440 */ 470, 306, 1025, 1120, 308, 1262, 1020, 134, 120, 246,
  131730. /* 1450 */ 682, 370, 171, 255, 1263, 135, 184, 1261, 1260, 374,
  131731. /* 1460 */ 118, 906, 904, 827, 1050, 146, 136, 137, 148, 1049,
  131732. /* 1470 */ 63, 1047, 756, 190, 269, 920, 154, 156, 68, 69,
  131733. /* 1480 */ 70, 71, 139, 923, 192, 193, 144, 919, 345, 128,
  131734. /* 1490 */ 14, 194, 276, 211, 1000, 405, 196, 161, 912, 160,
  131735. /* 1500 */ 26, 697, 410, 295, 200, 289, 414, 162, 419, 73,
  131736. /* 1510 */ 15, 16, 141, 74, 28, 247, 846, 845, 735, 874,
  131737. /* 1520 */ 954, 75, 430, 955, 29, 433, 179, 229, 231, 800,
  131738. /* 1530 */ 165, 795, 87, 210, 889, 79, 875, 17, 873, 877,
  131739. /* 1540 */ 929, 18, 928, 216, 215, 878, 20, 30, 462, 844,
  131740. /* 1550 */ 707, 92, 766, 770, 7, 322, 217, 218, 319, 1308,
  131741. /* 1560 */ 960, 1016, 1016, 1016, 1016, 1307,
  131742. };
  131743. static const YYCODETYPE yy_lookahead[] = {
  131744. /* 0 */ 152, 144, 145, 146, 147, 152, 152, 172, 152, 180,
  131745. /* 10 */ 181, 152, 223, 224, 225, 180, 152, 164, 189, 19,
  131746. /* 20 */ 223, 224, 225, 168, 169, 170, 163, 173, 174, 173,
  131747. /* 30 */ 174, 31, 173, 174, 168, 169, 170, 173, 174, 39,
  131748. /* 40 */ 243, 191, 192, 43, 44, 45, 46, 47, 48, 49,
  131749. /* 50 */ 50, 51, 52, 53, 54, 55, 56, 57, 195, 196,
  131750. /* 60 */ 22, 23, 208, 209, 208, 209, 218, 208, 209, 176,
  131751. /* 70 */ 207, 19, 208, 209, 23, 212, 213, 26, 26, 152,
  131752. /* 80 */ 46, 47, 48, 49, 84, 85, 86, 87, 88, 89,
  131753. /* 90 */ 90, 91, 92, 93, 94, 43, 44, 45, 46, 47,
  131754. /* 100 */ 48, 49, 50, 51, 52, 53, 54, 55, 56, 57,
  131755. /* 110 */ 90, 91, 92, 93, 94, 188, 223, 224, 225, 171,
  131756. /* 120 */ 68, 83, 152, 19, 84, 85, 86, 87, 88, 89,
  131757. /* 130 */ 90, 91, 92, 93, 94, 101, 84, 85, 86, 87,
  131758. /* 140 */ 88, 89, 90, 91, 92, 93, 94, 43, 44, 45,
  131759. /* 150 */ 46, 47, 48, 49, 50, 51, 52, 53, 54, 55,
  131760. /* 160 */ 56, 57, 99, 94, 194, 102, 103, 104, 109, 110,
  131761. /* 170 */ 66, 223, 224, 225, 152, 19, 113, 22, 23, 152,
  131762. /* 180 */ 24, 26, 160, 1, 2, 59, 164, 173, 84, 85,
  131763. /* 190 */ 86, 87, 88, 89, 90, 91, 92, 93, 94, 43,
  131764. /* 200 */ 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
  131765. /* 210 */ 54, 55, 56, 57, 244, 88, 89, 90, 91, 92,
  131766. /* 220 */ 93, 94, 96, 97, 98, 99, 196, 19, 102, 103,
  131767. /* 230 */ 104, 23, 88, 89, 173, 59, 163, 207, 83, 113,
  131768. /* 240 */ 84, 85, 86, 87, 88, 89, 90, 91, 92, 93,
  131769. /* 250 */ 94, 43, 44, 45, 46, 47, 48, 49, 50, 51,
  131770. /* 260 */ 52, 53, 54, 55, 56, 57, 90, 240, 195, 196,
  131771. /* 270 */ 171, 82, 96, 97, 98, 152, 132, 176, 134, 19,
  131772. /* 280 */ 207, 200, 72, 23, 93, 94, 97, 152, 173, 79,
  131773. /* 290 */ 101, 210, 84, 85, 86, 87, 88, 89, 90, 91,
  131774. /* 300 */ 92, 93, 94, 43, 44, 45, 46, 47, 48, 49,
  131775. /* 310 */ 50, 51, 52, 53, 54, 55, 56, 57, 108, 152,
  131776. /* 320 */ 152, 132, 133, 134, 223, 224, 225, 152, 186, 119,
  131777. /* 330 */ 120, 19, 197, 234, 31, 23, 26, 152, 239, 59,
  131778. /* 340 */ 173, 174, 39, 220, 84, 85, 86, 87, 88, 89,
  131779. /* 350 */ 90, 91, 92, 93, 94, 43, 44, 45, 46, 47,
  131780. /* 360 */ 48, 49, 50, 51, 52, 53, 54, 55, 56, 57,
  131781. /* 370 */ 152, 22, 152, 16, 152, 208, 96, 97, 98, 194,
  131782. /* 380 */ 22, 23, 11, 19, 26, 79, 72, 23, 0, 1,
  131783. /* 390 */ 2, 173, 174, 173, 174, 220, 84, 85, 86, 87,
  131784. /* 400 */ 88, 89, 90, 91, 92, 93, 94, 43, 44, 45,
  131785. /* 410 */ 46, 47, 48, 49, 50, 51, 52, 53, 54, 55,
  131786. /* 420 */ 56, 57, 108, 109, 110, 119, 120, 152, 208, 119,
  131787. /* 430 */ 120, 137, 75, 139, 77, 19, 152, 88, 89, 23,
  131788. /* 440 */ 115, 83, 117, 118, 163, 227, 163, 152, 84, 85,
  131789. /* 450 */ 86, 87, 88, 89, 90, 91, 92, 93, 94, 43,
  131790. /* 460 */ 44, 45, 46, 47, 48, 49, 50, 51, 52, 53,
  131791. /* 470 */ 54, 55, 56, 57, 195, 196, 195, 196, 195, 196,
  131792. /* 480 */ 109, 110, 195, 196, 22, 23, 207, 19, 207, 152,
  131793. /* 490 */ 207, 108, 109, 110, 207, 163, 22, 140, 24, 59,
  131794. /* 500 */ 84, 85, 86, 87, 88, 89, 90, 91, 92, 93,
  131795. /* 510 */ 94, 43, 44, 45, 46, 47, 48, 49, 50, 51,
  131796. /* 520 */ 52, 53, 54, 55, 56, 57, 152, 195, 196, 152,
  131797. /* 530 */ 16, 7, 8, 9, 197, 240, 96, 97, 98, 207,
  131798. /* 540 */ 249, 250, 19, 152, 22, 83, 26, 173, 174, 152,
  131799. /* 550 */ 173, 174, 84, 85, 86, 87, 88, 89, 90, 91,
  131800. /* 560 */ 92, 93, 94, 59, 124, 152, 43, 44, 45, 46,
  131801. /* 570 */ 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
  131802. /* 580 */ 57, 59, 169, 170, 157, 194, 82, 191, 192, 75,
  131803. /* 590 */ 152, 77, 108, 109, 110, 26, 152, 19, 152, 152,
  131804. /* 600 */ 96, 97, 24, 152, 152, 101, 138, 84, 85, 86,
  131805. /* 610 */ 87, 88, 89, 90, 91, 92, 93, 94, 96, 97,
  131806. /* 620 */ 98, 43, 44, 45, 46, 47, 48, 49, 50, 51,
  131807. /* 630 */ 52, 53, 54, 55, 56, 57, 132, 133, 134, 188,
  131808. /* 640 */ 194, 197, 152, 123, 197, 232, 194, 152, 182, 19,
  131809. /* 650 */ 119, 120, 152, 152, 152, 152, 218, 230, 152, 163,
  131810. /* 660 */ 233, 138, 84, 85, 86, 87, 88, 89, 90, 91,
  131811. /* 670 */ 92, 93, 94, 43, 44, 45, 46, 47, 48, 49,
  131812. /* 680 */ 50, 51, 52, 53, 54, 55, 56, 57, 152, 152,
  131813. /* 690 */ 23, 195, 196, 26, 194, 194, 194, 146, 147, 130,
  131814. /* 700 */ 194, 19, 46, 207, 59, 29, 166, 167, 218, 33,
  131815. /* 710 */ 173, 174, 26, 218, 84, 85, 86, 87, 88, 89,
  131816. /* 720 */ 90, 91, 92, 93, 94, 43, 44, 45, 46, 47,
  131817. /* 730 */ 48, 49, 50, 51, 52, 53, 54, 55, 56, 57,
  131818. /* 740 */ 64, 171, 97, 240, 116, 166, 167, 212, 213, 121,
  131819. /* 750 */ 23, 152, 19, 26, 218, 247, 248, 23, 23, 152,
  131820. /* 760 */ 26, 26, 22, 107, 163, 98, 84, 85, 86, 87,
  131821. /* 770 */ 88, 89, 90, 91, 92, 93, 94, 44, 45, 46,
  131822. /* 780 */ 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
  131823. /* 790 */ 57, 124, 106, 53, 100, 101, 195, 196, 152, 152,
  131824. /* 800 */ 23, 23, 19, 26, 26, 19, 152, 23, 207, 239,
  131825. /* 810 */ 26, 23, 152, 163, 26, 169, 170, 84, 85, 86,
  131826. /* 820 */ 87, 88, 89, 90, 91, 92, 93, 94, 45, 46,
  131827. /* 830 */ 47, 48, 49, 50, 51, 52, 53, 54, 55, 56,
  131828. /* 840 */ 57, 19, 20, 101, 22, 195, 196, 22, 19, 24,
  131829. /* 850 */ 163, 19, 7, 8, 112, 59, 23, 207, 36, 26,
  131830. /* 860 */ 23, 152, 59, 26, 21, 59, 152, 84, 85, 86,
  131831. /* 870 */ 87, 88, 89, 90, 91, 92, 93, 94, 232, 221,
  131832. /* 880 */ 94, 59, 195, 196, 59, 99, 100, 101, 102, 103,
  131833. /* 890 */ 104, 105, 70, 97, 207, 59, 19, 20, 112, 22,
  131834. /* 900 */ 97, 79, 152, 97, 82, 152, 152, 71, 221, 90,
  131835. /* 910 */ 88, 89, 23, 36, 12, 26, 163, 95, 96, 97,
  131836. /* 920 */ 98, 78, 97, 101, 152, 96, 173, 174, 96, 27,
  131837. /* 930 */ 182, 22, 96, 97, 98, 116, 59, 148, 149, 152,
  131838. /* 940 */ 121, 119, 120, 154, 42, 156, 103, 70, 195, 196,
  131839. /* 950 */ 22, 59, 163, 152, 132, 133, 134, 135, 136, 82,
  131840. /* 960 */ 207, 208, 209, 71, 62, 88, 89, 90, 59, 152,
  131841. /* 970 */ 152, 12, 95, 96, 97, 98, 19, 20, 101, 22,
  131842. /* 980 */ 22, 182, 152, 140, 195, 196, 27, 59, 96, 97,
  131843. /* 990 */ 98, 59, 132, 36, 134, 22, 207, 19, 20, 24,
  131844. /* 1000 */ 22, 42, 152, 173, 174, 96, 97, 98, 219, 132,
  131845. /* 1010 */ 133, 134, 135, 136, 36, 152, 59, 187, 132, 152,
  131846. /* 1020 */ 134, 62, 152, 152, 96, 97, 98, 70, 96, 97,
  131847. /* 1030 */ 98, 72, 59, 152, 59, 246, 26, 59, 214, 82,
  131848. /* 1040 */ 152, 192, 152, 173, 174, 88, 89, 79, 70, 152,
  131849. /* 1050 */ 152, 19, 95, 96, 97, 98, 124, 187, 101, 23,
  131850. /* 1060 */ 82, 164, 26, 173, 174, 152, 88, 89, 100, 96,
  131851. /* 1070 */ 97, 98, 97, 95, 96, 97, 98, 187, 46, 101,
  131852. /* 1080 */ 122, 184, 152, 186, 211, 152, 152, 119, 120, 132,
  131853. /* 1090 */ 133, 134, 135, 136, 152, 5, 22, 152, 152, 35,
  131854. /* 1100 */ 10, 11, 12, 13, 14, 152, 152, 17, 98, 235,
  131855. /* 1110 */ 132, 133, 134, 135, 136, 54, 55, 56, 57, 58,
  131856. /* 1120 */ 30, 152, 32, 152, 152, 198, 173, 174, 152, 65,
  131857. /* 1130 */ 40, 152, 152, 59, 124, 152, 236, 73, 199, 107,
  131858. /* 1140 */ 187, 171, 173, 174, 112, 84, 85, 86, 87, 88,
  131859. /* 1150 */ 89, 90, 91, 92, 93, 94, 173, 174, 152, 69,
  131860. /* 1160 */ 152, 211, 54, 55, 56, 57, 76, 152, 150, 79,
  131861. /* 1170 */ 80, 97, 211, 211, 211, 111, 59, 241, 241, 173,
  131862. /* 1180 */ 174, 173, 174, 202, 202, 185, 177, 176, 173, 174,
  131863. /* 1190 */ 176, 201, 84, 85, 86, 87, 88, 89, 90, 91,
  131864. /* 1200 */ 92, 93, 94, 215, 114, 88, 89, 152, 215, 119,
  131865. /* 1210 */ 120, 152, 181, 96, 97, 98, 176, 100, 215, 152,
  131866. /* 1220 */ 229, 152, 163, 152, 107, 199, 109, 155, 173, 174,
  131867. /* 1230 */ 245, 141, 173, 174, 60, 159, 152, 122, 159, 242,
  131868. /* 1240 */ 173, 174, 173, 174, 173, 174, 38, 242, 152, 132,
  131869. /* 1250 */ 159, 134, 152, 22, 195, 196, 152, 173, 174, 222,
  131870. /* 1260 */ 43, 130, 202, 152, 18, 152, 207, 208, 152, 173,
  131871. /* 1270 */ 174, 152, 190, 173, 174, 152, 193, 173, 174, 152,
  131872. /* 1280 */ 193, 193, 152, 159, 173, 174, 173, 174, 152, 173,
  131873. /* 1290 */ 174, 193, 173, 174, 18, 152, 173, 174, 152, 158,
  131874. /* 1300 */ 173, 174, 152, 173, 174, 152, 159, 152, 202, 173,
  131875. /* 1310 */ 174, 152, 190, 152, 222, 152, 173, 174, 152, 173,
  131876. /* 1320 */ 174, 137, 152, 173, 174, 190, 173, 174, 173, 174,
  131877. /* 1330 */ 202, 158, 173, 174, 173, 174, 173, 174, 61, 173,
  131878. /* 1340 */ 174, 152, 237, 173, 174, 152, 159, 152, 238, 152,
  131879. /* 1350 */ 158, 152, 22, 152, 178, 152, 158, 152, 158, 152,
  131880. /* 1360 */ 178, 159, 173, 174, 152, 159, 173, 174, 173, 174,
  131881. /* 1370 */ 173, 174, 173, 174, 173, 174, 173, 174, 173, 174,
  131882. /* 1380 */ 173, 174, 152, 63, 152, 173, 174, 107, 175, 175,
  131883. /* 1390 */ 175, 106, 183, 175, 178, 175, 177, 175, 175, 178,
  131884. /* 1400 */ 94, 107, 231, 173, 174, 173, 174, 183, 231, 125,
  131885. /* 1410 */ 216, 178, 159, 217, 22, 159, 226, 129, 137, 228,
  131886. /* 1420 */ 128, 217, 126, 25, 127, 162, 216, 26, 217, 161,
  131887. /* 1430 */ 13, 153, 153, 206, 205, 6, 251, 202, 204, 203,
  131888. /* 1440 */ 151, 216, 151, 217, 216, 171, 151, 165, 179, 179,
  131889. /* 1450 */ 4, 3, 22, 142, 171, 165, 15, 171, 171, 81,
  131890. /* 1460 */ 16, 23, 23, 120, 171, 131, 165, 111, 123, 171,
  131891. /* 1470 */ 171, 171, 20, 125, 16, 1, 123, 131, 53, 53,
  131892. /* 1480 */ 53, 53, 111, 96, 34, 122, 248, 1, 251, 5,
  131893. /* 1490 */ 22, 107, 140, 26, 74, 41, 122, 107, 67, 67,
  131894. /* 1500 */ 24, 20, 19, 112, 105, 23, 66, 22, 66, 22,
  131895. /* 1510 */ 22, 22, 37, 22, 22, 66, 23, 23, 28, 23,
  131896. /* 1520 */ 23, 26, 24, 23, 22, 24, 122, 23, 23, 96,
  131897. /* 1530 */ 22, 124, 26, 34, 23, 26, 23, 34, 23, 23,
  131898. /* 1540 */ 23, 34, 23, 22, 26, 11, 22, 22, 26, 23,
  131899. /* 1550 */ 23, 22, 116, 23, 22, 15, 122, 122, 23, 122,
  131900. /* 1560 */ 1, 252, 252, 252, 252, 122, 252, 252, 252, 252,
  131901. /* 1570 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131902. /* 1580 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131903. /* 1590 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131904. /* 1600 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131905. /* 1610 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131906. /* 1620 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131907. /* 1630 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131908. /* 1640 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131909. /* 1650 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131910. /* 1660 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131911. /* 1670 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131912. /* 1680 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131913. /* 1690 */ 252, 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131914. /* 1700 */ 252, 252, 252, 252, 252, 252, 252, 252, 252,
  131915. };
  131916. #define YY_SHIFT_COUNT (471)
  131917. #define YY_SHIFT_MIN (0)
  131918. #define YY_SHIFT_MAX (1559)
  131919. static const unsigned short int yy_shift_ofst[] = {
  131920. /* 0 */ 182, 1090, 822, 822, 306, 957, 957, 957, 957, 210,
  131921. /* 10 */ 0, 0, 104, 630, 957, 957, 957, 957, 957, 957,
  131922. /* 20 */ 957, 1117, 1117, 126, 968, 306, 306, 306, 306, 306,
  131923. /* 30 */ 306, 52, 156, 208, 260, 312, 364, 416, 468, 523,
  131924. /* 40 */ 578, 630, 630, 630, 630, 630, 630, 630, 630, 630,
  131925. /* 50 */ 630, 630, 630, 630, 630, 630, 630, 630, 682, 630,
  131926. /* 60 */ 733, 783, 783, 877, 957, 957, 957, 957, 957, 957,
  131927. /* 70 */ 957, 957, 957, 957, 957, 957, 957, 957, 957, 957,
  131928. /* 80 */ 957, 957, 957, 957, 957, 957, 957, 957, 957, 957,
  131929. /* 90 */ 957, 957, 957, 957, 957, 978, 957, 957, 957, 957,
  131930. /* 100 */ 957, 957, 957, 957, 957, 957, 957, 957, 957, 1061,
  131931. /* 110 */ 1108, 1108, 1108, 1108, 1108, 40, 127, 20, 280, 843,
  131932. /* 120 */ 1032, 144, 144, 280, 310, 310, 310, 310, 59, 191,
  131933. /* 130 */ 69, 1566, 1566, 1566, 786, 786, 786, 522, 836, 522,
  131934. /* 140 */ 959, 959, 892, 155, 358, 280, 280, 280, 280, 280,
  131935. /* 150 */ 280, 280, 280, 280, 280, 280, 280, 280, 280, 280,
  131936. /* 160 */ 280, 280, 280, 280, 280, 280, 371, 388, 645, 645,
  131937. /* 170 */ 531, 1566, 1566, 1566, 504, 189, 189, 909, 63, 176,
  131938. /* 180 */ 928, 440, 932, 973, 280, 280, 280, 280, 280, 314,
  131939. /* 190 */ 280, 280, 280, 280, 280, 280, 280, 280, 280, 280,
  131940. /* 200 */ 280, 280, 1064, 1064, 1064, 280, 280, 280, 280, 667,
  131941. /* 210 */ 280, 280, 280, 825, 280, 280, 902, 280, 280, 280,
  131942. /* 220 */ 280, 280, 280, 280, 280, 383, 676, 325, 975, 975,
  131943. /* 230 */ 975, 975, 1010, 325, 325, 819, 349, 524, 569, 829,
  131944. /* 240 */ 829, 832, 569, 832, 686, 51, 656, 303, 303, 303,
  131945. /* 250 */ 829, 294, 520, 628, 474, 1174, 1115, 1115, 1208, 1208,
  131946. /* 260 */ 1115, 1231, 1217, 1131, 1246, 1246, 1246, 1246, 1115, 1276,
  131947. /* 270 */ 1131, 1231, 1217, 1217, 1131, 1115, 1276, 1184, 1277, 1115,
  131948. /* 280 */ 1276, 1330, 1115, 1276, 1115, 1276, 1330, 1280, 1280, 1280,
  131949. /* 290 */ 1320, 1330, 1280, 1285, 1280, 1320, 1280, 1280, 1330, 1306,
  131950. /* 300 */ 1306, 1330, 1284, 1294, 1284, 1294, 1284, 1294, 1284, 1294,
  131951. /* 310 */ 1115, 1392, 1115, 1281, 1288, 1296, 1292, 1297, 1131, 1398,
  131952. /* 320 */ 1401, 1417, 1417, 1429, 1429, 1429, 1566, 1566, 1566, 1566,
  131953. /* 330 */ 1566, 1566, 1566, 1566, 1566, 1566, 1566, 1566, 1566, 1566,
  131954. /* 340 */ 1566, 1566, 34, 357, 38, 462, 514, 484, 1074, 727,
  131955. /* 350 */ 740, 734, 735, 777, 778, 784, 788, 803, 694, 845,
  131956. /* 360 */ 742, 796, 833, 837, 889, 860, 886, 1036, 806, 958,
  131957. /* 370 */ 1446, 1448, 1430, 1311, 1441, 1378, 1444, 1438, 1439, 1343,
  131958. /* 380 */ 1334, 1356, 1345, 1452, 1348, 1458, 1474, 1353, 1346, 1425,
  131959. /* 390 */ 1426, 1427, 1428, 1371, 1387, 1450, 1363, 1486, 1484, 1468,
  131960. /* 400 */ 1384, 1352, 1431, 1467, 1432, 1420, 1454, 1374, 1390, 1476,
  131961. /* 410 */ 1481, 1483, 1391, 1399, 1485, 1440, 1487, 1488, 1482, 1489,
  131962. /* 420 */ 1442, 1490, 1491, 1449, 1475, 1493, 1494, 1496, 1495, 1497,
  131963. /* 430 */ 1492, 1498, 1500, 1502, 1501, 1404, 1504, 1505, 1433, 1499,
  131964. /* 440 */ 1508, 1407, 1506, 1503, 1509, 1507, 1511, 1513, 1515, 1506,
  131965. /* 450 */ 1516, 1517, 1518, 1519, 1521, 1534, 1524, 1525, 1526, 1527,
  131966. /* 460 */ 1529, 1530, 1532, 1522, 1436, 1434, 1435, 1437, 1443, 1535,
  131967. /* 470 */ 1540, 1559,
  131968. };
  131969. #define YY_REDUCE_COUNT (341)
  131970. #define YY_REDUCE_MIN (-211)
  131971. #define YY_REDUCE_MAX (1301)
  131972. static const short yy_reduce_ofst[] = {
  131973. /* 0 */ -143, 789, 753, 1059, -137, -146, -144, -141, -136, 687,
  131974. /* 10 */ -107, 101, -203, -52, 830, 870, 890, 167, 953, 218,
  131975. /* 20 */ 220, 413, 646, 897, 73, 281, 283, 332, 496, 601,
  131976. /* 30 */ 650, -211, -211, -211, -211, -211, -211, -211, -211, -211,
  131977. /* 40 */ -211, -211, -211, -211, -211, -211, -211, -211, -211, -211,
  131978. /* 50 */ -211, -211, -211, -211, -211, -211, -211, -211, -211, -211,
  131979. /* 60 */ -211, -211, -211, 374, 377, 537, 969, 983, 1006, 1008,
  131980. /* 70 */ 1015, 1055, 1067, 1069, 1071, 1084, 1096, 1100, 1104, 1111,
  131981. /* 80 */ 1113, 1116, 1119, 1123, 1127, 1130, 1136, 1143, 1146, 1150,
  131982. /* 90 */ 1153, 1155, 1159, 1161, 1163, 1166, 1170, 1189, 1193, 1195,
  131983. /* 100 */ 1197, 1199, 1201, 1203, 1205, 1207, 1212, 1230, 1232, -211,
  131984. /* 110 */ -211, -211, -211, -211, -211, -211, -211, -211, -30, 427,
  131985. /* 120 */ -171, -145, -134, 22, 279, 287, 279, 287, 99, -211,
  131986. /* 130 */ -211, -211, -211, -211, -165, -165, -165, 123, 135, 175,
  131987. /* 140 */ -150, 396, 337, 291, 291, -147, 185, 391, 446, 444,
  131988. /* 150 */ 452, 500, 501, 502, 27, -152, 295, 438, 490, 503,
  131989. /* 160 */ 495, 506, -73, 447, 451, 536, 570, 551, 540, 579,
  131990. /* 170 */ 30, 508, 535, 81, 14, 61, 115, 168, 142, 222,
  131991. /* 180 */ 275, 284, 397, 599, 607, 647, 654, 660, 709, 658,
  131992. /* 190 */ 714, 750, 754, 772, 787, 801, 817, 818, 850, 863,
  131993. /* 200 */ 867, 871, 466, 748, 799, 881, 888, 898, 913, 824,
  131994. /* 210 */ 930, 933, 934, 873, 942, 945, 849, 946, 222, 954,
  131995. /* 220 */ 971, 972, 976, 979, 980, 900, 874, 927, 950, 961,
  131996. /* 230 */ 962, 963, 824, 927, 927, 939, 970, 1018, 981, 988,
  131997. /* 240 */ 993, 936, 982, 937, 1009, 1000, 1031, 1011, 1014, 1040,
  131998. /* 250 */ 1003, 991, 990, 1026, 1072, 985, 1076, 1079, 997, 1005,
  131999. /* 260 */ 1091, 1037, 1082, 1060, 1083, 1087, 1088, 1098, 1124, 1141,
  132000. /* 270 */ 1106, 1092, 1122, 1135, 1128, 1147, 1173, 1110, 1105, 1187,
  132001. /* 280 */ 1192, 1176, 1202, 1198, 1206, 1200, 1182, 1213, 1214, 1215,
  132002. /* 290 */ 1209, 1216, 1218, 1219, 1220, 1224, 1222, 1223, 1221, 1171,
  132003. /* 300 */ 1177, 1233, 1196, 1194, 1204, 1210, 1211, 1225, 1226, 1228,
  132004. /* 310 */ 1253, 1190, 1256, 1191, 1227, 1229, 1234, 1236, 1235, 1263,
  132005. /* 320 */ 1268, 1278, 1279, 1289, 1291, 1295, 1185, 1237, 1238, 1282,
  132006. /* 330 */ 1274, 1283, 1286, 1287, 1290, 1269, 1270, 1293, 1298, 1299,
  132007. /* 340 */ 1300, 1301,
  132008. };
  132009. static const YYACTIONTYPE yy_default[] = {
  132010. /* 0 */ 1297, 1349, 1221, 1014, 1119, 1221, 1221, 1221, 1221, 1014,
  132011. /* 10 */ 1145, 1145, 1272, 1045, 1014, 1014, 1014, 1014, 1014, 1220,
  132012. /* 20 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132013. /* 30 */ 1014, 1151, 1014, 1014, 1014, 1014, 1222, 1223, 1014, 1014,
  132014. /* 40 */ 1014, 1271, 1273, 1161, 1160, 1159, 1158, 1254, 1132, 1156,
  132015. /* 50 */ 1149, 1153, 1216, 1217, 1215, 1219, 1222, 1223, 1014, 1152,
  132016. /* 60 */ 1186, 1200, 1185, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132017. /* 70 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132018. /* 80 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132019. /* 90 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132020. /* 100 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1194,
  132021. /* 110 */ 1199, 1206, 1198, 1195, 1188, 1187, 1189, 1190, 1014, 1035,
  132022. /* 120 */ 1084, 1014, 1014, 1014, 1289, 1288, 1014, 1014, 1045, 1191,
  132023. /* 130 */ 1192, 1203, 1202, 1201, 1279, 1305, 1304, 1014, 1014, 1014,
  132024. /* 140 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132025. /* 150 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132026. /* 160 */ 1014, 1014, 1014, 1014, 1014, 1014, 1045, 1297, 1041, 1041,
  132027. /* 170 */ 1014, 1284, 1119, 1110, 1014, 1014, 1014, 1014, 1014, 1014,
  132028. /* 180 */ 1014, 1014, 1014, 1014, 1014, 1276, 1274, 1014, 1236, 1014,
  132029. /* 190 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132030. /* 200 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132031. /* 210 */ 1014, 1014, 1014, 1115, 1014, 1014, 1014, 1014, 1014, 1014,
  132032. /* 220 */ 1014, 1014, 1014, 1014, 1299, 1014, 1249, 1098, 1115, 1115,
  132033. /* 230 */ 1115, 1115, 1117, 1099, 1097, 1109, 1045, 1021, 1155, 1134,
  132034. /* 240 */ 1134, 1338, 1155, 1338, 1059, 1319, 1056, 1145, 1145, 1145,
  132035. /* 250 */ 1134, 1218, 1116, 1109, 1014, 1341, 1124, 1124, 1340, 1340,
  132036. /* 260 */ 1124, 1166, 1087, 1155, 1093, 1093, 1093, 1093, 1124, 1032,
  132037. /* 270 */ 1155, 1166, 1087, 1087, 1155, 1124, 1032, 1253, 1335, 1124,
  132038. /* 280 */ 1032, 1229, 1124, 1032, 1124, 1032, 1229, 1085, 1085, 1085,
  132039. /* 290 */ 1074, 1229, 1085, 1059, 1085, 1074, 1085, 1085, 1229, 1233,
  132040. /* 300 */ 1233, 1229, 1138, 1133, 1138, 1133, 1138, 1133, 1138, 1133,
  132041. /* 310 */ 1124, 1224, 1124, 1014, 1150, 1139, 1148, 1146, 1155, 1038,
  132042. /* 320 */ 1077, 1302, 1302, 1298, 1298, 1298, 1346, 1346, 1284, 1314,
  132043. /* 330 */ 1045, 1045, 1045, 1045, 1314, 1061, 1061, 1045, 1045, 1045,
  132044. /* 340 */ 1045, 1314, 1014, 1014, 1014, 1014, 1014, 1014, 1309, 1014,
  132045. /* 350 */ 1238, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132046. /* 360 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1171,
  132047. /* 370 */ 1014, 1017, 1281, 1014, 1014, 1280, 1014, 1014, 1014, 1014,
  132048. /* 380 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132049. /* 390 */ 1014, 1014, 1014, 1014, 1014, 1014, 1337, 1014, 1014, 1014,
  132050. /* 400 */ 1014, 1014, 1014, 1252, 1251, 1014, 1014, 1126, 1014, 1014,
  132051. /* 410 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132052. /* 420 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132053. /* 430 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132054. /* 440 */ 1014, 1014, 1147, 1014, 1140, 1014, 1014, 1014, 1014, 1328,
  132055. /* 450 */ 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014, 1014,
  132056. /* 460 */ 1014, 1014, 1014, 1323, 1101, 1173, 1014, 1172, 1176, 1014,
  132057. /* 470 */ 1026, 1014,
  132058. };
  132059. /********** End of lemon-generated parsing tables *****************************/
  132060. /* The next table maps tokens (terminal symbols) into fallback tokens.
  132061. ** If a construct like the following:
  132062. **
  132063. ** %fallback ID X Y Z.
  132064. **
  132065. ** appears in the grammar, then ID becomes a fallback token for X, Y,
  132066. ** and Z. Whenever one of the tokens X, Y, or Z is input to the parser
  132067. ** but it does not parse, the type of the token is changed to ID and
  132068. ** the parse is retried before an error is thrown.
  132069. **
  132070. ** This feature can be used, for example, to cause some keywords in a language
  132071. ** to revert to identifiers if they keyword does not apply in the context where
  132072. ** it appears.
  132073. */
  132074. #ifdef YYFALLBACK
  132075. static const YYCODETYPE yyFallback[] = {
  132076. 0, /* $ => nothing */
  132077. 0, /* SEMI => nothing */
  132078. 59, /* EXPLAIN => ID */
  132079. 59, /* QUERY => ID */
  132080. 59, /* PLAN => ID */
  132081. 59, /* BEGIN => ID */
  132082. 0, /* TRANSACTION => nothing */
  132083. 59, /* DEFERRED => ID */
  132084. 59, /* IMMEDIATE => ID */
  132085. 59, /* EXCLUSIVE => ID */
  132086. 0, /* COMMIT => nothing */
  132087. 59, /* END => ID */
  132088. 59, /* ROLLBACK => ID */
  132089. 59, /* SAVEPOINT => ID */
  132090. 59, /* RELEASE => ID */
  132091. 0, /* TO => nothing */
  132092. 0, /* TABLE => nothing */
  132093. 0, /* CREATE => nothing */
  132094. 59, /* IF => ID */
  132095. 0, /* NOT => nothing */
  132096. 0, /* EXISTS => nothing */
  132097. 59, /* TEMP => ID */
  132098. 0, /* LP => nothing */
  132099. 0, /* RP => nothing */
  132100. 0, /* AS => nothing */
  132101. 59, /* WITHOUT => ID */
  132102. 0, /* COMMA => nothing */
  132103. 59, /* ABORT => ID */
  132104. 59, /* ACTION => ID */
  132105. 59, /* AFTER => ID */
  132106. 59, /* ANALYZE => ID */
  132107. 59, /* ASC => ID */
  132108. 59, /* ATTACH => ID */
  132109. 59, /* BEFORE => ID */
  132110. 59, /* BY => ID */
  132111. 59, /* CASCADE => ID */
  132112. 59, /* CAST => ID */
  132113. 59, /* CONFLICT => ID */
  132114. 59, /* DATABASE => ID */
  132115. 59, /* DESC => ID */
  132116. 59, /* DETACH => ID */
  132117. 59, /* EACH => ID */
  132118. 59, /* FAIL => ID */
  132119. 0, /* OR => nothing */
  132120. 0, /* AND => nothing */
  132121. 0, /* IS => nothing */
  132122. 59, /* MATCH => ID */
  132123. 59, /* LIKE_KW => ID */
  132124. 0, /* BETWEEN => nothing */
  132125. 0, /* IN => nothing */
  132126. 0, /* ISNULL => nothing */
  132127. 0, /* NOTNULL => nothing */
  132128. 0, /* NE => nothing */
  132129. 0, /* EQ => nothing */
  132130. 0, /* GT => nothing */
  132131. 0, /* LE => nothing */
  132132. 0, /* LT => nothing */
  132133. 0, /* GE => nothing */
  132134. 0, /* ESCAPE => nothing */
  132135. 0, /* ID => nothing */
  132136. 59, /* COLUMNKW => ID */
  132137. 59, /* FOR => ID */
  132138. 59, /* IGNORE => ID */
  132139. 59, /* INITIALLY => ID */
  132140. 59, /* INSTEAD => ID */
  132141. 59, /* NO => ID */
  132142. 59, /* KEY => ID */
  132143. 59, /* OF => ID */
  132144. 59, /* OFFSET => ID */
  132145. 59, /* PRAGMA => ID */
  132146. 59, /* RAISE => ID */
  132147. 59, /* RECURSIVE => ID */
  132148. 59, /* REPLACE => ID */
  132149. 59, /* RESTRICT => ID */
  132150. 59, /* ROW => ID */
  132151. 59, /* TRIGGER => ID */
  132152. 59, /* VACUUM => ID */
  132153. 59, /* VIEW => ID */
  132154. 59, /* VIRTUAL => ID */
  132155. 59, /* WITH => ID */
  132156. 59, /* REINDEX => ID */
  132157. 59, /* RENAME => ID */
  132158. 59, /* CTIME_KW => ID */
  132159. };
  132160. #endif /* YYFALLBACK */
  132161. /* The following structure represents a single element of the
  132162. ** parser's stack. Information stored includes:
  132163. **
  132164. ** + The state number for the parser at this level of the stack.
  132165. **
  132166. ** + The value of the token stored at this level of the stack.
  132167. ** (In other words, the "major" token.)
  132168. **
  132169. ** + The semantic value stored at this level of the stack. This is
  132170. ** the information used by the action routines in the grammar.
  132171. ** It is sometimes called the "minor" token.
  132172. **
  132173. ** After the "shift" half of a SHIFTREDUCE action, the stateno field
  132174. ** actually contains the reduce action for the second half of the
  132175. ** SHIFTREDUCE.
  132176. */
  132177. struct yyStackEntry {
  132178. YYACTIONTYPE stateno; /* The state-number, or reduce action in SHIFTREDUCE */
  132179. YYCODETYPE major; /* The major token value. This is the code
  132180. ** number for the token at this stack level */
  132181. YYMINORTYPE minor; /* The user-supplied minor token value. This
  132182. ** is the value of the token */
  132183. };
  132184. typedef struct yyStackEntry yyStackEntry;
  132185. /* The state of the parser is completely contained in an instance of
  132186. ** the following structure */
  132187. struct yyParser {
  132188. yyStackEntry *yytos; /* Pointer to top element of the stack */
  132189. #ifdef YYTRACKMAXSTACKDEPTH
  132190. int yyhwm; /* High-water mark of the stack */
  132191. #endif
  132192. #ifndef YYNOERRORRECOVERY
  132193. int yyerrcnt; /* Shifts left before out of the error */
  132194. #endif
  132195. sqlite3ParserARG_SDECL /* A place to hold %extra_argument */
  132196. #if YYSTACKDEPTH<=0
  132197. int yystksz; /* Current side of the stack */
  132198. yyStackEntry *yystack; /* The parser's stack */
  132199. yyStackEntry yystk0; /* First stack entry */
  132200. #else
  132201. yyStackEntry yystack[YYSTACKDEPTH]; /* The parser's stack */
  132202. yyStackEntry *yystackEnd; /* Last entry in the stack */
  132203. #endif
  132204. };
  132205. typedef struct yyParser yyParser;
  132206. #ifndef NDEBUG
  132207. /* #include <stdio.h> */
  132208. static FILE *yyTraceFILE = 0;
  132209. static char *yyTracePrompt = 0;
  132210. #endif /* NDEBUG */
  132211. #ifndef NDEBUG
  132212. /*
  132213. ** Turn parser tracing on by giving a stream to which to write the trace
  132214. ** and a prompt to preface each trace message. Tracing is turned off
  132215. ** by making either argument NULL
  132216. **
  132217. ** Inputs:
  132218. ** <ul>
  132219. ** <li> A FILE* to which trace output should be written.
  132220. ** If NULL, then tracing is turned off.
  132221. ** <li> A prefix string written at the beginning of every
  132222. ** line of trace output. If NULL, then tracing is
  132223. ** turned off.
  132224. ** </ul>
  132225. **
  132226. ** Outputs:
  132227. ** None.
  132228. */
  132229. SQLITE_PRIVATE void sqlite3ParserTrace(FILE *TraceFILE, char *zTracePrompt){
  132230. yyTraceFILE = TraceFILE;
  132231. yyTracePrompt = zTracePrompt;
  132232. if( yyTraceFILE==0 ) yyTracePrompt = 0;
  132233. else if( yyTracePrompt==0 ) yyTraceFILE = 0;
  132234. }
  132235. #endif /* NDEBUG */
  132236. #if defined(YYCOVERAGE) || !defined(NDEBUG)
  132237. /* For tracing shifts, the names of all terminals and nonterminals
  132238. ** are required. The following table supplies these names */
  132239. static const char *const yyTokenName[] = {
  132240. /* 0 */ "$",
  132241. /* 1 */ "SEMI",
  132242. /* 2 */ "EXPLAIN",
  132243. /* 3 */ "QUERY",
  132244. /* 4 */ "PLAN",
  132245. /* 5 */ "BEGIN",
  132246. /* 6 */ "TRANSACTION",
  132247. /* 7 */ "DEFERRED",
  132248. /* 8 */ "IMMEDIATE",
  132249. /* 9 */ "EXCLUSIVE",
  132250. /* 10 */ "COMMIT",
  132251. /* 11 */ "END",
  132252. /* 12 */ "ROLLBACK",
  132253. /* 13 */ "SAVEPOINT",
  132254. /* 14 */ "RELEASE",
  132255. /* 15 */ "TO",
  132256. /* 16 */ "TABLE",
  132257. /* 17 */ "CREATE",
  132258. /* 18 */ "IF",
  132259. /* 19 */ "NOT",
  132260. /* 20 */ "EXISTS",
  132261. /* 21 */ "TEMP",
  132262. /* 22 */ "LP",
  132263. /* 23 */ "RP",
  132264. /* 24 */ "AS",
  132265. /* 25 */ "WITHOUT",
  132266. /* 26 */ "COMMA",
  132267. /* 27 */ "ABORT",
  132268. /* 28 */ "ACTION",
  132269. /* 29 */ "AFTER",
  132270. /* 30 */ "ANALYZE",
  132271. /* 31 */ "ASC",
  132272. /* 32 */ "ATTACH",
  132273. /* 33 */ "BEFORE",
  132274. /* 34 */ "BY",
  132275. /* 35 */ "CASCADE",
  132276. /* 36 */ "CAST",
  132277. /* 37 */ "CONFLICT",
  132278. /* 38 */ "DATABASE",
  132279. /* 39 */ "DESC",
  132280. /* 40 */ "DETACH",
  132281. /* 41 */ "EACH",
  132282. /* 42 */ "FAIL",
  132283. /* 43 */ "OR",
  132284. /* 44 */ "AND",
  132285. /* 45 */ "IS",
  132286. /* 46 */ "MATCH",
  132287. /* 47 */ "LIKE_KW",
  132288. /* 48 */ "BETWEEN",
  132289. /* 49 */ "IN",
  132290. /* 50 */ "ISNULL",
  132291. /* 51 */ "NOTNULL",
  132292. /* 52 */ "NE",
  132293. /* 53 */ "EQ",
  132294. /* 54 */ "GT",
  132295. /* 55 */ "LE",
  132296. /* 56 */ "LT",
  132297. /* 57 */ "GE",
  132298. /* 58 */ "ESCAPE",
  132299. /* 59 */ "ID",
  132300. /* 60 */ "COLUMNKW",
  132301. /* 61 */ "FOR",
  132302. /* 62 */ "IGNORE",
  132303. /* 63 */ "INITIALLY",
  132304. /* 64 */ "INSTEAD",
  132305. /* 65 */ "NO",
  132306. /* 66 */ "KEY",
  132307. /* 67 */ "OF",
  132308. /* 68 */ "OFFSET",
  132309. /* 69 */ "PRAGMA",
  132310. /* 70 */ "RAISE",
  132311. /* 71 */ "RECURSIVE",
  132312. /* 72 */ "REPLACE",
  132313. /* 73 */ "RESTRICT",
  132314. /* 74 */ "ROW",
  132315. /* 75 */ "TRIGGER",
  132316. /* 76 */ "VACUUM",
  132317. /* 77 */ "VIEW",
  132318. /* 78 */ "VIRTUAL",
  132319. /* 79 */ "WITH",
  132320. /* 80 */ "REINDEX",
  132321. /* 81 */ "RENAME",
  132322. /* 82 */ "CTIME_KW",
  132323. /* 83 */ "ANY",
  132324. /* 84 */ "BITAND",
  132325. /* 85 */ "BITOR",
  132326. /* 86 */ "LSHIFT",
  132327. /* 87 */ "RSHIFT",
  132328. /* 88 */ "PLUS",
  132329. /* 89 */ "MINUS",
  132330. /* 90 */ "STAR",
  132331. /* 91 */ "SLASH",
  132332. /* 92 */ "REM",
  132333. /* 93 */ "CONCAT",
  132334. /* 94 */ "COLLATE",
  132335. /* 95 */ "BITNOT",
  132336. /* 96 */ "INDEXED",
  132337. /* 97 */ "STRING",
  132338. /* 98 */ "JOIN_KW",
  132339. /* 99 */ "CONSTRAINT",
  132340. /* 100 */ "DEFAULT",
  132341. /* 101 */ "NULL",
  132342. /* 102 */ "PRIMARY",
  132343. /* 103 */ "UNIQUE",
  132344. /* 104 */ "CHECK",
  132345. /* 105 */ "REFERENCES",
  132346. /* 106 */ "AUTOINCR",
  132347. /* 107 */ "ON",
  132348. /* 108 */ "INSERT",
  132349. /* 109 */ "DELETE",
  132350. /* 110 */ "UPDATE",
  132351. /* 111 */ "SET",
  132352. /* 112 */ "DEFERRABLE",
  132353. /* 113 */ "FOREIGN",
  132354. /* 114 */ "DROP",
  132355. /* 115 */ "UNION",
  132356. /* 116 */ "ALL",
  132357. /* 117 */ "EXCEPT",
  132358. /* 118 */ "INTERSECT",
  132359. /* 119 */ "SELECT",
  132360. /* 120 */ "VALUES",
  132361. /* 121 */ "DISTINCT",
  132362. /* 122 */ "DOT",
  132363. /* 123 */ "FROM",
  132364. /* 124 */ "JOIN",
  132365. /* 125 */ "USING",
  132366. /* 126 */ "ORDER",
  132367. /* 127 */ "GROUP",
  132368. /* 128 */ "HAVING",
  132369. /* 129 */ "LIMIT",
  132370. /* 130 */ "WHERE",
  132371. /* 131 */ "INTO",
  132372. /* 132 */ "FLOAT",
  132373. /* 133 */ "BLOB",
  132374. /* 134 */ "INTEGER",
  132375. /* 135 */ "VARIABLE",
  132376. /* 136 */ "CASE",
  132377. /* 137 */ "WHEN",
  132378. /* 138 */ "THEN",
  132379. /* 139 */ "ELSE",
  132380. /* 140 */ "INDEX",
  132381. /* 141 */ "ALTER",
  132382. /* 142 */ "ADD",
  132383. /* 143 */ "error",
  132384. /* 144 */ "input",
  132385. /* 145 */ "cmdlist",
  132386. /* 146 */ "ecmd",
  132387. /* 147 */ "explain",
  132388. /* 148 */ "cmdx",
  132389. /* 149 */ "cmd",
  132390. /* 150 */ "transtype",
  132391. /* 151 */ "trans_opt",
  132392. /* 152 */ "nm",
  132393. /* 153 */ "savepoint_opt",
  132394. /* 154 */ "create_table",
  132395. /* 155 */ "create_table_args",
  132396. /* 156 */ "createkw",
  132397. /* 157 */ "temp",
  132398. /* 158 */ "ifnotexists",
  132399. /* 159 */ "dbnm",
  132400. /* 160 */ "columnlist",
  132401. /* 161 */ "conslist_opt",
  132402. /* 162 */ "table_options",
  132403. /* 163 */ "select",
  132404. /* 164 */ "columnname",
  132405. /* 165 */ "carglist",
  132406. /* 166 */ "typetoken",
  132407. /* 167 */ "typename",
  132408. /* 168 */ "signed",
  132409. /* 169 */ "plus_num",
  132410. /* 170 */ "minus_num",
  132411. /* 171 */ "scanpt",
  132412. /* 172 */ "ccons",
  132413. /* 173 */ "term",
  132414. /* 174 */ "expr",
  132415. /* 175 */ "onconf",
  132416. /* 176 */ "sortorder",
  132417. /* 177 */ "autoinc",
  132418. /* 178 */ "eidlist_opt",
  132419. /* 179 */ "refargs",
  132420. /* 180 */ "defer_subclause",
  132421. /* 181 */ "refarg",
  132422. /* 182 */ "refact",
  132423. /* 183 */ "init_deferred_pred_opt",
  132424. /* 184 */ "conslist",
  132425. /* 185 */ "tconscomma",
  132426. /* 186 */ "tcons",
  132427. /* 187 */ "sortlist",
  132428. /* 188 */ "eidlist",
  132429. /* 189 */ "defer_subclause_opt",
  132430. /* 190 */ "orconf",
  132431. /* 191 */ "resolvetype",
  132432. /* 192 */ "raisetype",
  132433. /* 193 */ "ifexists",
  132434. /* 194 */ "fullname",
  132435. /* 195 */ "selectnowith",
  132436. /* 196 */ "oneselect",
  132437. /* 197 */ "wqlist",
  132438. /* 198 */ "multiselect_op",
  132439. /* 199 */ "distinct",
  132440. /* 200 */ "selcollist",
  132441. /* 201 */ "from",
  132442. /* 202 */ "where_opt",
  132443. /* 203 */ "groupby_opt",
  132444. /* 204 */ "having_opt",
  132445. /* 205 */ "orderby_opt",
  132446. /* 206 */ "limit_opt",
  132447. /* 207 */ "values",
  132448. /* 208 */ "nexprlist",
  132449. /* 209 */ "exprlist",
  132450. /* 210 */ "sclp",
  132451. /* 211 */ "as",
  132452. /* 212 */ "seltablist",
  132453. /* 213 */ "stl_prefix",
  132454. /* 214 */ "joinop",
  132455. /* 215 */ "indexed_opt",
  132456. /* 216 */ "on_opt",
  132457. /* 217 */ "using_opt",
  132458. /* 218 */ "idlist",
  132459. /* 219 */ "with",
  132460. /* 220 */ "setlist",
  132461. /* 221 */ "insert_cmd",
  132462. /* 222 */ "idlist_opt",
  132463. /* 223 */ "likeop",
  132464. /* 224 */ "between_op",
  132465. /* 225 */ "in_op",
  132466. /* 226 */ "paren_exprlist",
  132467. /* 227 */ "case_operand",
  132468. /* 228 */ "case_exprlist",
  132469. /* 229 */ "case_else",
  132470. /* 230 */ "uniqueflag",
  132471. /* 231 */ "collate",
  132472. /* 232 */ "nmnum",
  132473. /* 233 */ "trigger_decl",
  132474. /* 234 */ "trigger_cmd_list",
  132475. /* 235 */ "trigger_time",
  132476. /* 236 */ "trigger_event",
  132477. /* 237 */ "foreach_clause",
  132478. /* 238 */ "when_clause",
  132479. /* 239 */ "trigger_cmd",
  132480. /* 240 */ "trnm",
  132481. /* 241 */ "tridxby",
  132482. /* 242 */ "database_kw_opt",
  132483. /* 243 */ "key_opt",
  132484. /* 244 */ "add_column_fullname",
  132485. /* 245 */ "kwcolumn_opt",
  132486. /* 246 */ "create_vtab",
  132487. /* 247 */ "vtabarglist",
  132488. /* 248 */ "vtabarg",
  132489. /* 249 */ "vtabargtoken",
  132490. /* 250 */ "lp",
  132491. /* 251 */ "anylist",
  132492. };
  132493. #endif /* defined(YYCOVERAGE) || !defined(NDEBUG) */
  132494. #ifndef NDEBUG
  132495. /* For tracing reduce actions, the names of all rules are required.
  132496. */
  132497. static const char *const yyRuleName[] = {
  132498. /* 0 */ "explain ::= EXPLAIN",
  132499. /* 1 */ "explain ::= EXPLAIN QUERY PLAN",
  132500. /* 2 */ "cmdx ::= cmd",
  132501. /* 3 */ "cmd ::= BEGIN transtype trans_opt",
  132502. /* 4 */ "transtype ::=",
  132503. /* 5 */ "transtype ::= DEFERRED",
  132504. /* 6 */ "transtype ::= IMMEDIATE",
  132505. /* 7 */ "transtype ::= EXCLUSIVE",
  132506. /* 8 */ "cmd ::= COMMIT|END trans_opt",
  132507. /* 9 */ "cmd ::= ROLLBACK trans_opt",
  132508. /* 10 */ "cmd ::= SAVEPOINT nm",
  132509. /* 11 */ "cmd ::= RELEASE savepoint_opt nm",
  132510. /* 12 */ "cmd ::= ROLLBACK trans_opt TO savepoint_opt nm",
  132511. /* 13 */ "create_table ::= createkw temp TABLE ifnotexists nm dbnm",
  132512. /* 14 */ "createkw ::= CREATE",
  132513. /* 15 */ "ifnotexists ::=",
  132514. /* 16 */ "ifnotexists ::= IF NOT EXISTS",
  132515. /* 17 */ "temp ::= TEMP",
  132516. /* 18 */ "temp ::=",
  132517. /* 19 */ "create_table_args ::= LP columnlist conslist_opt RP table_options",
  132518. /* 20 */ "create_table_args ::= AS select",
  132519. /* 21 */ "table_options ::=",
  132520. /* 22 */ "table_options ::= WITHOUT nm",
  132521. /* 23 */ "columnname ::= nm typetoken",
  132522. /* 24 */ "typetoken ::=",
  132523. /* 25 */ "typetoken ::= typename LP signed RP",
  132524. /* 26 */ "typetoken ::= typename LP signed COMMA signed RP",
  132525. /* 27 */ "typename ::= typename ID|STRING",
  132526. /* 28 */ "scanpt ::=",
  132527. /* 29 */ "ccons ::= CONSTRAINT nm",
  132528. /* 30 */ "ccons ::= DEFAULT scanpt term scanpt",
  132529. /* 31 */ "ccons ::= DEFAULT LP expr RP",
  132530. /* 32 */ "ccons ::= DEFAULT PLUS term scanpt",
  132531. /* 33 */ "ccons ::= DEFAULT MINUS term scanpt",
  132532. /* 34 */ "ccons ::= DEFAULT scanpt ID|INDEXED",
  132533. /* 35 */ "ccons ::= NOT NULL onconf",
  132534. /* 36 */ "ccons ::= PRIMARY KEY sortorder onconf autoinc",
  132535. /* 37 */ "ccons ::= UNIQUE onconf",
  132536. /* 38 */ "ccons ::= CHECK LP expr RP",
  132537. /* 39 */ "ccons ::= REFERENCES nm eidlist_opt refargs",
  132538. /* 40 */ "ccons ::= defer_subclause",
  132539. /* 41 */ "ccons ::= COLLATE ID|STRING",
  132540. /* 42 */ "autoinc ::=",
  132541. /* 43 */ "autoinc ::= AUTOINCR",
  132542. /* 44 */ "refargs ::=",
  132543. /* 45 */ "refargs ::= refargs refarg",
  132544. /* 46 */ "refarg ::= MATCH nm",
  132545. /* 47 */ "refarg ::= ON INSERT refact",
  132546. /* 48 */ "refarg ::= ON DELETE refact",
  132547. /* 49 */ "refarg ::= ON UPDATE refact",
  132548. /* 50 */ "refact ::= SET NULL",
  132549. /* 51 */ "refact ::= SET DEFAULT",
  132550. /* 52 */ "refact ::= CASCADE",
  132551. /* 53 */ "refact ::= RESTRICT",
  132552. /* 54 */ "refact ::= NO ACTION",
  132553. /* 55 */ "defer_subclause ::= NOT DEFERRABLE init_deferred_pred_opt",
  132554. /* 56 */ "defer_subclause ::= DEFERRABLE init_deferred_pred_opt",
  132555. /* 57 */ "init_deferred_pred_opt ::=",
  132556. /* 58 */ "init_deferred_pred_opt ::= INITIALLY DEFERRED",
  132557. /* 59 */ "init_deferred_pred_opt ::= INITIALLY IMMEDIATE",
  132558. /* 60 */ "conslist_opt ::=",
  132559. /* 61 */ "tconscomma ::= COMMA",
  132560. /* 62 */ "tcons ::= CONSTRAINT nm",
  132561. /* 63 */ "tcons ::= PRIMARY KEY LP sortlist autoinc RP onconf",
  132562. /* 64 */ "tcons ::= UNIQUE LP sortlist RP onconf",
  132563. /* 65 */ "tcons ::= CHECK LP expr RP onconf",
  132564. /* 66 */ "tcons ::= FOREIGN KEY LP eidlist RP REFERENCES nm eidlist_opt refargs defer_subclause_opt",
  132565. /* 67 */ "defer_subclause_opt ::=",
  132566. /* 68 */ "onconf ::=",
  132567. /* 69 */ "onconf ::= ON CONFLICT resolvetype",
  132568. /* 70 */ "orconf ::=",
  132569. /* 71 */ "orconf ::= OR resolvetype",
  132570. /* 72 */ "resolvetype ::= IGNORE",
  132571. /* 73 */ "resolvetype ::= REPLACE",
  132572. /* 74 */ "cmd ::= DROP TABLE ifexists fullname",
  132573. /* 75 */ "ifexists ::= IF EXISTS",
  132574. /* 76 */ "ifexists ::=",
  132575. /* 77 */ "cmd ::= createkw temp VIEW ifnotexists nm dbnm eidlist_opt AS select",
  132576. /* 78 */ "cmd ::= DROP VIEW ifexists fullname",
  132577. /* 79 */ "cmd ::= select",
  132578. /* 80 */ "select ::= WITH wqlist selectnowith",
  132579. /* 81 */ "select ::= WITH RECURSIVE wqlist selectnowith",
  132580. /* 82 */ "select ::= selectnowith",
  132581. /* 83 */ "selectnowith ::= selectnowith multiselect_op oneselect",
  132582. /* 84 */ "multiselect_op ::= UNION",
  132583. /* 85 */ "multiselect_op ::= UNION ALL",
  132584. /* 86 */ "multiselect_op ::= EXCEPT|INTERSECT",
  132585. /* 87 */ "oneselect ::= SELECT distinct selcollist from where_opt groupby_opt having_opt orderby_opt limit_opt",
  132586. /* 88 */ "values ::= VALUES LP nexprlist RP",
  132587. /* 89 */ "values ::= values COMMA LP exprlist RP",
  132588. /* 90 */ "distinct ::= DISTINCT",
  132589. /* 91 */ "distinct ::= ALL",
  132590. /* 92 */ "distinct ::=",
  132591. /* 93 */ "sclp ::=",
  132592. /* 94 */ "selcollist ::= sclp scanpt expr scanpt as",
  132593. /* 95 */ "selcollist ::= sclp scanpt STAR",
  132594. /* 96 */ "selcollist ::= sclp scanpt nm DOT STAR",
  132595. /* 97 */ "as ::= AS nm",
  132596. /* 98 */ "as ::=",
  132597. /* 99 */ "from ::=",
  132598. /* 100 */ "from ::= FROM seltablist",
  132599. /* 101 */ "stl_prefix ::= seltablist joinop",
  132600. /* 102 */ "stl_prefix ::=",
  132601. /* 103 */ "seltablist ::= stl_prefix nm dbnm as indexed_opt on_opt using_opt",
  132602. /* 104 */ "seltablist ::= stl_prefix nm dbnm LP exprlist RP as on_opt using_opt",
  132603. /* 105 */ "seltablist ::= stl_prefix LP select RP as on_opt using_opt",
  132604. /* 106 */ "seltablist ::= stl_prefix LP seltablist RP as on_opt using_opt",
  132605. /* 107 */ "dbnm ::=",
  132606. /* 108 */ "dbnm ::= DOT nm",
  132607. /* 109 */ "fullname ::= nm",
  132608. /* 110 */ "fullname ::= nm DOT nm",
  132609. /* 111 */ "joinop ::= COMMA|JOIN",
  132610. /* 112 */ "joinop ::= JOIN_KW JOIN",
  132611. /* 113 */ "joinop ::= JOIN_KW nm JOIN",
  132612. /* 114 */ "joinop ::= JOIN_KW nm nm JOIN",
  132613. /* 115 */ "on_opt ::= ON expr",
  132614. /* 116 */ "on_opt ::=",
  132615. /* 117 */ "indexed_opt ::=",
  132616. /* 118 */ "indexed_opt ::= INDEXED BY nm",
  132617. /* 119 */ "indexed_opt ::= NOT INDEXED",
  132618. /* 120 */ "using_opt ::= USING LP idlist RP",
  132619. /* 121 */ "using_opt ::=",
  132620. /* 122 */ "orderby_opt ::=",
  132621. /* 123 */ "orderby_opt ::= ORDER BY sortlist",
  132622. /* 124 */ "sortlist ::= sortlist COMMA expr sortorder",
  132623. /* 125 */ "sortlist ::= expr sortorder",
  132624. /* 126 */ "sortorder ::= ASC",
  132625. /* 127 */ "sortorder ::= DESC",
  132626. /* 128 */ "sortorder ::=",
  132627. /* 129 */ "groupby_opt ::=",
  132628. /* 130 */ "groupby_opt ::= GROUP BY nexprlist",
  132629. /* 131 */ "having_opt ::=",
  132630. /* 132 */ "having_opt ::= HAVING expr",
  132631. /* 133 */ "limit_opt ::=",
  132632. /* 134 */ "limit_opt ::= LIMIT expr",
  132633. /* 135 */ "limit_opt ::= LIMIT expr OFFSET expr",
  132634. /* 136 */ "limit_opt ::= LIMIT expr COMMA expr",
  132635. /* 137 */ "cmd ::= with DELETE FROM fullname indexed_opt where_opt",
  132636. /* 138 */ "where_opt ::=",
  132637. /* 139 */ "where_opt ::= WHERE expr",
  132638. /* 140 */ "cmd ::= with UPDATE orconf fullname indexed_opt SET setlist where_opt",
  132639. /* 141 */ "setlist ::= setlist COMMA nm EQ expr",
  132640. /* 142 */ "setlist ::= setlist COMMA LP idlist RP EQ expr",
  132641. /* 143 */ "setlist ::= nm EQ expr",
  132642. /* 144 */ "setlist ::= LP idlist RP EQ expr",
  132643. /* 145 */ "cmd ::= with insert_cmd INTO fullname idlist_opt select",
  132644. /* 146 */ "cmd ::= with insert_cmd INTO fullname idlist_opt DEFAULT VALUES",
  132645. /* 147 */ "insert_cmd ::= INSERT orconf",
  132646. /* 148 */ "insert_cmd ::= REPLACE",
  132647. /* 149 */ "idlist_opt ::=",
  132648. /* 150 */ "idlist_opt ::= LP idlist RP",
  132649. /* 151 */ "idlist ::= idlist COMMA nm",
  132650. /* 152 */ "idlist ::= nm",
  132651. /* 153 */ "expr ::= LP expr RP",
  132652. /* 154 */ "expr ::= ID|INDEXED",
  132653. /* 155 */ "expr ::= JOIN_KW",
  132654. /* 156 */ "expr ::= nm DOT nm",
  132655. /* 157 */ "expr ::= nm DOT nm DOT nm",
  132656. /* 158 */ "term ::= NULL|FLOAT|BLOB",
  132657. /* 159 */ "term ::= STRING",
  132658. /* 160 */ "term ::= INTEGER",
  132659. /* 161 */ "expr ::= VARIABLE",
  132660. /* 162 */ "expr ::= expr COLLATE ID|STRING",
  132661. /* 163 */ "expr ::= CAST LP expr AS typetoken RP",
  132662. /* 164 */ "expr ::= ID|INDEXED LP distinct exprlist RP",
  132663. /* 165 */ "expr ::= ID|INDEXED LP STAR RP",
  132664. /* 166 */ "term ::= CTIME_KW",
  132665. /* 167 */ "expr ::= LP nexprlist COMMA expr RP",
  132666. /* 168 */ "expr ::= expr AND expr",
  132667. /* 169 */ "expr ::= expr OR expr",
  132668. /* 170 */ "expr ::= expr LT|GT|GE|LE expr",
  132669. /* 171 */ "expr ::= expr EQ|NE expr",
  132670. /* 172 */ "expr ::= expr BITAND|BITOR|LSHIFT|RSHIFT expr",
  132671. /* 173 */ "expr ::= expr PLUS|MINUS expr",
  132672. /* 174 */ "expr ::= expr STAR|SLASH|REM expr",
  132673. /* 175 */ "expr ::= expr CONCAT expr",
  132674. /* 176 */ "likeop ::= NOT LIKE_KW|MATCH",
  132675. /* 177 */ "expr ::= expr likeop expr",
  132676. /* 178 */ "expr ::= expr likeop expr ESCAPE expr",
  132677. /* 179 */ "expr ::= expr ISNULL|NOTNULL",
  132678. /* 180 */ "expr ::= expr NOT NULL",
  132679. /* 181 */ "expr ::= expr IS expr",
  132680. /* 182 */ "expr ::= expr IS NOT expr",
  132681. /* 183 */ "expr ::= NOT expr",
  132682. /* 184 */ "expr ::= BITNOT expr",
  132683. /* 185 */ "expr ::= MINUS expr",
  132684. /* 186 */ "expr ::= PLUS expr",
  132685. /* 187 */ "between_op ::= BETWEEN",
  132686. /* 188 */ "between_op ::= NOT BETWEEN",
  132687. /* 189 */ "expr ::= expr between_op expr AND expr",
  132688. /* 190 */ "in_op ::= IN",
  132689. /* 191 */ "in_op ::= NOT IN",
  132690. /* 192 */ "expr ::= expr in_op LP exprlist RP",
  132691. /* 193 */ "expr ::= LP select RP",
  132692. /* 194 */ "expr ::= expr in_op LP select RP",
  132693. /* 195 */ "expr ::= expr in_op nm dbnm paren_exprlist",
  132694. /* 196 */ "expr ::= EXISTS LP select RP",
  132695. /* 197 */ "expr ::= CASE case_operand case_exprlist case_else END",
  132696. /* 198 */ "case_exprlist ::= case_exprlist WHEN expr THEN expr",
  132697. /* 199 */ "case_exprlist ::= WHEN expr THEN expr",
  132698. /* 200 */ "case_else ::= ELSE expr",
  132699. /* 201 */ "case_else ::=",
  132700. /* 202 */ "case_operand ::= expr",
  132701. /* 203 */ "case_operand ::=",
  132702. /* 204 */ "exprlist ::=",
  132703. /* 205 */ "nexprlist ::= nexprlist COMMA expr",
  132704. /* 206 */ "nexprlist ::= expr",
  132705. /* 207 */ "paren_exprlist ::=",
  132706. /* 208 */ "paren_exprlist ::= LP exprlist RP",
  132707. /* 209 */ "cmd ::= createkw uniqueflag INDEX ifnotexists nm dbnm ON nm LP sortlist RP where_opt",
  132708. /* 210 */ "uniqueflag ::= UNIQUE",
  132709. /* 211 */ "uniqueflag ::=",
  132710. /* 212 */ "eidlist_opt ::=",
  132711. /* 213 */ "eidlist_opt ::= LP eidlist RP",
  132712. /* 214 */ "eidlist ::= eidlist COMMA nm collate sortorder",
  132713. /* 215 */ "eidlist ::= nm collate sortorder",
  132714. /* 216 */ "collate ::=",
  132715. /* 217 */ "collate ::= COLLATE ID|STRING",
  132716. /* 218 */ "cmd ::= DROP INDEX ifexists fullname",
  132717. /* 219 */ "cmd ::= VACUUM",
  132718. /* 220 */ "cmd ::= VACUUM nm",
  132719. /* 221 */ "cmd ::= PRAGMA nm dbnm",
  132720. /* 222 */ "cmd ::= PRAGMA nm dbnm EQ nmnum",
  132721. /* 223 */ "cmd ::= PRAGMA nm dbnm LP nmnum RP",
  132722. /* 224 */ "cmd ::= PRAGMA nm dbnm EQ minus_num",
  132723. /* 225 */ "cmd ::= PRAGMA nm dbnm LP minus_num RP",
  132724. /* 226 */ "plus_num ::= PLUS INTEGER|FLOAT",
  132725. /* 227 */ "minus_num ::= MINUS INTEGER|FLOAT",
  132726. /* 228 */ "cmd ::= createkw trigger_decl BEGIN trigger_cmd_list END",
  132727. /* 229 */ "trigger_decl ::= temp TRIGGER ifnotexists nm dbnm trigger_time trigger_event ON fullname foreach_clause when_clause",
  132728. /* 230 */ "trigger_time ::= BEFORE|AFTER",
  132729. /* 231 */ "trigger_time ::= INSTEAD OF",
  132730. /* 232 */ "trigger_time ::=",
  132731. /* 233 */ "trigger_event ::= DELETE|INSERT",
  132732. /* 234 */ "trigger_event ::= UPDATE",
  132733. /* 235 */ "trigger_event ::= UPDATE OF idlist",
  132734. /* 236 */ "when_clause ::=",
  132735. /* 237 */ "when_clause ::= WHEN expr",
  132736. /* 238 */ "trigger_cmd_list ::= trigger_cmd_list trigger_cmd SEMI",
  132737. /* 239 */ "trigger_cmd_list ::= trigger_cmd SEMI",
  132738. /* 240 */ "trnm ::= nm DOT nm",
  132739. /* 241 */ "tridxby ::= INDEXED BY nm",
  132740. /* 242 */ "tridxby ::= NOT INDEXED",
  132741. /* 243 */ "trigger_cmd ::= UPDATE orconf trnm tridxby SET setlist where_opt scanpt",
  132742. /* 244 */ "trigger_cmd ::= scanpt insert_cmd INTO trnm idlist_opt select scanpt",
  132743. /* 245 */ "trigger_cmd ::= DELETE FROM trnm tridxby where_opt scanpt",
  132744. /* 246 */ "trigger_cmd ::= scanpt select scanpt",
  132745. /* 247 */ "expr ::= RAISE LP IGNORE RP",
  132746. /* 248 */ "expr ::= RAISE LP raisetype COMMA nm RP",
  132747. /* 249 */ "raisetype ::= ROLLBACK",
  132748. /* 250 */ "raisetype ::= ABORT",
  132749. /* 251 */ "raisetype ::= FAIL",
  132750. /* 252 */ "cmd ::= DROP TRIGGER ifexists fullname",
  132751. /* 253 */ "cmd ::= ATTACH database_kw_opt expr AS expr key_opt",
  132752. /* 254 */ "cmd ::= DETACH database_kw_opt expr",
  132753. /* 255 */ "key_opt ::=",
  132754. /* 256 */ "key_opt ::= KEY expr",
  132755. /* 257 */ "cmd ::= REINDEX",
  132756. /* 258 */ "cmd ::= REINDEX nm dbnm",
  132757. /* 259 */ "cmd ::= ANALYZE",
  132758. /* 260 */ "cmd ::= ANALYZE nm dbnm",
  132759. /* 261 */ "cmd ::= ALTER TABLE fullname RENAME TO nm",
  132760. /* 262 */ "cmd ::= ALTER TABLE add_column_fullname ADD kwcolumn_opt columnname carglist",
  132761. /* 263 */ "add_column_fullname ::= fullname",
  132762. /* 264 */ "cmd ::= create_vtab",
  132763. /* 265 */ "cmd ::= create_vtab LP vtabarglist RP",
  132764. /* 266 */ "create_vtab ::= createkw VIRTUAL TABLE ifnotexists nm dbnm USING nm",
  132765. /* 267 */ "vtabarg ::=",
  132766. /* 268 */ "vtabargtoken ::= ANY",
  132767. /* 269 */ "vtabargtoken ::= lp anylist RP",
  132768. /* 270 */ "lp ::= LP",
  132769. /* 271 */ "with ::= WITH wqlist",
  132770. /* 272 */ "with ::= WITH RECURSIVE wqlist",
  132771. /* 273 */ "wqlist ::= nm eidlist_opt AS LP select RP",
  132772. /* 274 */ "wqlist ::= wqlist COMMA nm eidlist_opt AS LP select RP",
  132773. /* 275 */ "input ::= cmdlist",
  132774. /* 276 */ "cmdlist ::= cmdlist ecmd",
  132775. /* 277 */ "cmdlist ::= ecmd",
  132776. /* 278 */ "ecmd ::= SEMI",
  132777. /* 279 */ "ecmd ::= explain cmdx SEMI",
  132778. /* 280 */ "explain ::=",
  132779. /* 281 */ "trans_opt ::=",
  132780. /* 282 */ "trans_opt ::= TRANSACTION",
  132781. /* 283 */ "trans_opt ::= TRANSACTION nm",
  132782. /* 284 */ "savepoint_opt ::= SAVEPOINT",
  132783. /* 285 */ "savepoint_opt ::=",
  132784. /* 286 */ "cmd ::= create_table create_table_args",
  132785. /* 287 */ "columnlist ::= columnlist COMMA columnname carglist",
  132786. /* 288 */ "columnlist ::= columnname carglist",
  132787. /* 289 */ "nm ::= ID|INDEXED",
  132788. /* 290 */ "nm ::= STRING",
  132789. /* 291 */ "nm ::= JOIN_KW",
  132790. /* 292 */ "typetoken ::= typename",
  132791. /* 293 */ "typename ::= ID|STRING",
  132792. /* 294 */ "signed ::= plus_num",
  132793. /* 295 */ "signed ::= minus_num",
  132794. /* 296 */ "carglist ::= carglist ccons",
  132795. /* 297 */ "carglist ::=",
  132796. /* 298 */ "ccons ::= NULL onconf",
  132797. /* 299 */ "conslist_opt ::= COMMA conslist",
  132798. /* 300 */ "conslist ::= conslist tconscomma tcons",
  132799. /* 301 */ "conslist ::= tcons",
  132800. /* 302 */ "tconscomma ::=",
  132801. /* 303 */ "defer_subclause_opt ::= defer_subclause",
  132802. /* 304 */ "resolvetype ::= raisetype",
  132803. /* 305 */ "selectnowith ::= oneselect",
  132804. /* 306 */ "oneselect ::= values",
  132805. /* 307 */ "sclp ::= selcollist COMMA",
  132806. /* 308 */ "as ::= ID|STRING",
  132807. /* 309 */ "expr ::= term",
  132808. /* 310 */ "likeop ::= LIKE_KW|MATCH",
  132809. /* 311 */ "exprlist ::= nexprlist",
  132810. /* 312 */ "nmnum ::= plus_num",
  132811. /* 313 */ "nmnum ::= nm",
  132812. /* 314 */ "nmnum ::= ON",
  132813. /* 315 */ "nmnum ::= DELETE",
  132814. /* 316 */ "nmnum ::= DEFAULT",
  132815. /* 317 */ "plus_num ::= INTEGER|FLOAT",
  132816. /* 318 */ "foreach_clause ::=",
  132817. /* 319 */ "foreach_clause ::= FOR EACH ROW",
  132818. /* 320 */ "trnm ::= nm",
  132819. /* 321 */ "tridxby ::=",
  132820. /* 322 */ "database_kw_opt ::= DATABASE",
  132821. /* 323 */ "database_kw_opt ::=",
  132822. /* 324 */ "kwcolumn_opt ::=",
  132823. /* 325 */ "kwcolumn_opt ::= COLUMNKW",
  132824. /* 326 */ "vtabarglist ::= vtabarg",
  132825. /* 327 */ "vtabarglist ::= vtabarglist COMMA vtabarg",
  132826. /* 328 */ "vtabarg ::= vtabarg vtabargtoken",
  132827. /* 329 */ "anylist ::=",
  132828. /* 330 */ "anylist ::= anylist LP anylist RP",
  132829. /* 331 */ "anylist ::= anylist ANY",
  132830. /* 332 */ "with ::=",
  132831. };
  132832. #endif /* NDEBUG */
  132833. #if YYSTACKDEPTH<=0
  132834. /*
  132835. ** Try to increase the size of the parser stack. Return the number
  132836. ** of errors. Return 0 on success.
  132837. */
  132838. static int yyGrowStack(yyParser *p){
  132839. int newSize;
  132840. int idx;
  132841. yyStackEntry *pNew;
  132842. newSize = p->yystksz*2 + 100;
  132843. idx = p->yytos ? (int)(p->yytos - p->yystack) : 0;
  132844. if( p->yystack==&p->yystk0 ){
  132845. pNew = malloc(newSize*sizeof(pNew[0]));
  132846. if( pNew ) pNew[0] = p->yystk0;
  132847. }else{
  132848. pNew = realloc(p->yystack, newSize*sizeof(pNew[0]));
  132849. }
  132850. if( pNew ){
  132851. p->yystack = pNew;
  132852. p->yytos = &p->yystack[idx];
  132853. #ifndef NDEBUG
  132854. if( yyTraceFILE ){
  132855. fprintf(yyTraceFILE,"%sStack grows from %d to %d entries.\n",
  132856. yyTracePrompt, p->yystksz, newSize);
  132857. }
  132858. #endif
  132859. p->yystksz = newSize;
  132860. }
  132861. return pNew==0;
  132862. }
  132863. #endif
  132864. /* Datatype of the argument to the memory allocated passed as the
  132865. ** second argument to sqlite3ParserAlloc() below. This can be changed by
  132866. ** putting an appropriate #define in the %include section of the input
  132867. ** grammar.
  132868. */
  132869. #ifndef YYMALLOCARGTYPE
  132870. # define YYMALLOCARGTYPE size_t
  132871. #endif
  132872. /* Initialize a new parser that has already been allocated.
  132873. */
  132874. SQLITE_PRIVATE void sqlite3ParserInit(void *yypParser){
  132875. yyParser *pParser = (yyParser*)yypParser;
  132876. #ifdef YYTRACKMAXSTACKDEPTH
  132877. pParser->yyhwm = 0;
  132878. #endif
  132879. #if YYSTACKDEPTH<=0
  132880. pParser->yytos = NULL;
  132881. pParser->yystack = NULL;
  132882. pParser->yystksz = 0;
  132883. if( yyGrowStack(pParser) ){
  132884. pParser->yystack = &pParser->yystk0;
  132885. pParser->yystksz = 1;
  132886. }
  132887. #endif
  132888. #ifndef YYNOERRORRECOVERY
  132889. pParser->yyerrcnt = -1;
  132890. #endif
  132891. pParser->yytos = pParser->yystack;
  132892. pParser->yystack[0].stateno = 0;
  132893. pParser->yystack[0].major = 0;
  132894. #if YYSTACKDEPTH>0
  132895. pParser->yystackEnd = &pParser->yystack[YYSTACKDEPTH-1];
  132896. #endif
  132897. }
  132898. #ifndef sqlite3Parser_ENGINEALWAYSONSTACK
  132899. /*
  132900. ** This function allocates a new parser.
  132901. ** The only argument is a pointer to a function which works like
  132902. ** malloc.
  132903. **
  132904. ** Inputs:
  132905. ** A pointer to the function used to allocate memory.
  132906. **
  132907. ** Outputs:
  132908. ** A pointer to a parser. This pointer is used in subsequent calls
  132909. ** to sqlite3Parser and sqlite3ParserFree.
  132910. */
  132911. SQLITE_PRIVATE void *sqlite3ParserAlloc(void *(*mallocProc)(YYMALLOCARGTYPE)){
  132912. yyParser *pParser;
  132913. pParser = (yyParser*)(*mallocProc)( (YYMALLOCARGTYPE)sizeof(yyParser) );
  132914. if( pParser ) sqlite3ParserInit(pParser);
  132915. return pParser;
  132916. }
  132917. #endif /* sqlite3Parser_ENGINEALWAYSONSTACK */
  132918. /* The following function deletes the "minor type" or semantic value
  132919. ** associated with a symbol. The symbol can be either a terminal
  132920. ** or nonterminal. "yymajor" is the symbol code, and "yypminor" is
  132921. ** a pointer to the value to be deleted. The code used to do the
  132922. ** deletions is derived from the %destructor and/or %token_destructor
  132923. ** directives of the input grammar.
  132924. */
  132925. static void yy_destructor(
  132926. yyParser *yypParser, /* The parser */
  132927. YYCODETYPE yymajor, /* Type code for object to destroy */
  132928. YYMINORTYPE *yypminor /* The object to be destroyed */
  132929. ){
  132930. sqlite3ParserARG_FETCH;
  132931. switch( yymajor ){
  132932. /* Here is inserted the actions which take place when a
  132933. ** terminal or non-terminal is destroyed. This can happen
  132934. ** when the symbol is popped from the stack during a
  132935. ** reduce or during error processing or when a parser is
  132936. ** being destroyed before it is finished parsing.
  132937. **
  132938. ** Note: during a reduce, the only symbols destroyed are those
  132939. ** which appear on the RHS of the rule, but which are *not* used
  132940. ** inside the C code.
  132941. */
  132942. /********* Begin destructor definitions ***************************************/
  132943. case 163: /* select */
  132944. case 195: /* selectnowith */
  132945. case 196: /* oneselect */
  132946. case 207: /* values */
  132947. {
  132948. sqlite3SelectDelete(pParse->db, (yypminor->yy387));
  132949. }
  132950. break;
  132951. case 173: /* term */
  132952. case 174: /* expr */
  132953. case 202: /* where_opt */
  132954. case 204: /* having_opt */
  132955. case 216: /* on_opt */
  132956. case 227: /* case_operand */
  132957. case 229: /* case_else */
  132958. case 238: /* when_clause */
  132959. case 243: /* key_opt */
  132960. {
  132961. sqlite3ExprDelete(pParse->db, (yypminor->yy314));
  132962. }
  132963. break;
  132964. case 178: /* eidlist_opt */
  132965. case 187: /* sortlist */
  132966. case 188: /* eidlist */
  132967. case 200: /* selcollist */
  132968. case 203: /* groupby_opt */
  132969. case 205: /* orderby_opt */
  132970. case 208: /* nexprlist */
  132971. case 209: /* exprlist */
  132972. case 210: /* sclp */
  132973. case 220: /* setlist */
  132974. case 226: /* paren_exprlist */
  132975. case 228: /* case_exprlist */
  132976. {
  132977. sqlite3ExprListDelete(pParse->db, (yypminor->yy322));
  132978. }
  132979. break;
  132980. case 194: /* fullname */
  132981. case 201: /* from */
  132982. case 212: /* seltablist */
  132983. case 213: /* stl_prefix */
  132984. {
  132985. sqlite3SrcListDelete(pParse->db, (yypminor->yy259));
  132986. }
  132987. break;
  132988. case 197: /* wqlist */
  132989. {
  132990. sqlite3WithDelete(pParse->db, (yypminor->yy451));
  132991. }
  132992. break;
  132993. case 217: /* using_opt */
  132994. case 218: /* idlist */
  132995. case 222: /* idlist_opt */
  132996. {
  132997. sqlite3IdListDelete(pParse->db, (yypminor->yy384));
  132998. }
  132999. break;
  133000. case 234: /* trigger_cmd_list */
  133001. case 239: /* trigger_cmd */
  133002. {
  133003. sqlite3DeleteTriggerStep(pParse->db, (yypminor->yy203));
  133004. }
  133005. break;
  133006. case 236: /* trigger_event */
  133007. {
  133008. sqlite3IdListDelete(pParse->db, (yypminor->yy90).b);
  133009. }
  133010. break;
  133011. /********* End destructor definitions *****************************************/
  133012. default: break; /* If no destructor action specified: do nothing */
  133013. }
  133014. }
  133015. /*
  133016. ** Pop the parser's stack once.
  133017. **
  133018. ** If there is a destructor routine associated with the token which
  133019. ** is popped from the stack, then call it.
  133020. */
  133021. static void yy_pop_parser_stack(yyParser *pParser){
  133022. yyStackEntry *yytos;
  133023. assert( pParser->yytos!=0 );
  133024. assert( pParser->yytos > pParser->yystack );
  133025. yytos = pParser->yytos--;
  133026. #ifndef NDEBUG
  133027. if( yyTraceFILE ){
  133028. fprintf(yyTraceFILE,"%sPopping %s\n",
  133029. yyTracePrompt,
  133030. yyTokenName[yytos->major]);
  133031. }
  133032. #endif
  133033. yy_destructor(pParser, yytos->major, &yytos->minor);
  133034. }
  133035. /*
  133036. ** Clear all secondary memory allocations from the parser
  133037. */
  133038. SQLITE_PRIVATE void sqlite3ParserFinalize(void *p){
  133039. yyParser *pParser = (yyParser*)p;
  133040. while( pParser->yytos>pParser->yystack ) yy_pop_parser_stack(pParser);
  133041. #if YYSTACKDEPTH<=0
  133042. if( pParser->yystack!=&pParser->yystk0 ) free(pParser->yystack);
  133043. #endif
  133044. }
  133045. #ifndef sqlite3Parser_ENGINEALWAYSONSTACK
  133046. /*
  133047. ** Deallocate and destroy a parser. Destructors are called for
  133048. ** all stack elements before shutting the parser down.
  133049. **
  133050. ** If the YYPARSEFREENEVERNULL macro exists (for example because it
  133051. ** is defined in a %include section of the input grammar) then it is
  133052. ** assumed that the input pointer is never NULL.
  133053. */
  133054. SQLITE_PRIVATE void sqlite3ParserFree(
  133055. void *p, /* The parser to be deleted */
  133056. void (*freeProc)(void*) /* Function used to reclaim memory */
  133057. ){
  133058. #ifndef YYPARSEFREENEVERNULL
  133059. if( p==0 ) return;
  133060. #endif
  133061. sqlite3ParserFinalize(p);
  133062. (*freeProc)(p);
  133063. }
  133064. #endif /* sqlite3Parser_ENGINEALWAYSONSTACK */
  133065. /*
  133066. ** Return the peak depth of the stack for a parser.
  133067. */
  133068. #ifdef YYTRACKMAXSTACKDEPTH
  133069. SQLITE_PRIVATE int sqlite3ParserStackPeak(void *p){
  133070. yyParser *pParser = (yyParser*)p;
  133071. return pParser->yyhwm;
  133072. }
  133073. #endif
  133074. /* This array of booleans keeps track of the parser statement
  133075. ** coverage. The element yycoverage[X][Y] is set when the parser
  133076. ** is in state X and has a lookahead token Y. In a well-tested
  133077. ** systems, every element of this matrix should end up being set.
  133078. */
  133079. #if defined(YYCOVERAGE)
  133080. static unsigned char yycoverage[YYNSTATE][YYNTOKEN];
  133081. #endif
  133082. /*
  133083. ** Write into out a description of every state/lookahead combination that
  133084. **
  133085. ** (1) has not been used by the parser, and
  133086. ** (2) is not a syntax error.
  133087. **
  133088. ** Return the number of missed state/lookahead combinations.
  133089. */
  133090. #if defined(YYCOVERAGE)
  133091. SQLITE_PRIVATE int sqlite3ParserCoverage(FILE *out){
  133092. int stateno, iLookAhead, i;
  133093. int nMissed = 0;
  133094. for(stateno=0; stateno<YYNSTATE; stateno++){
  133095. i = yy_shift_ofst[stateno];
  133096. for(iLookAhead=0; iLookAhead<YYNTOKEN; iLookAhead++){
  133097. if( yy_lookahead[i+iLookAhead]!=iLookAhead ) continue;
  133098. if( yycoverage[stateno][iLookAhead]==0 ) nMissed++;
  133099. if( out ){
  133100. fprintf(out,"State %d lookahead %s %s\n", stateno,
  133101. yyTokenName[iLookAhead],
  133102. yycoverage[stateno][iLookAhead] ? "ok" : "missed");
  133103. }
  133104. }
  133105. }
  133106. return nMissed;
  133107. }
  133108. #endif
  133109. /*
  133110. ** Find the appropriate action for a parser given the terminal
  133111. ** look-ahead token iLookAhead.
  133112. */
  133113. static unsigned int yy_find_shift_action(
  133114. yyParser *pParser, /* The parser */
  133115. YYCODETYPE iLookAhead /* The look-ahead token */
  133116. ){
  133117. int i;
  133118. int stateno = pParser->yytos->stateno;
  133119. if( stateno>YY_MAX_SHIFT ) return stateno;
  133120. assert( stateno <= YY_SHIFT_COUNT );
  133121. #if defined(YYCOVERAGE)
  133122. yycoverage[stateno][iLookAhead] = 1;
  133123. #endif
  133124. do{
  133125. i = yy_shift_ofst[stateno];
  133126. assert( i>=0 );
  133127. assert( i+YYNTOKEN<=(int)sizeof(yy_lookahead)/sizeof(yy_lookahead[0]) );
  133128. assert( iLookAhead!=YYNOCODE );
  133129. assert( iLookAhead < YYNTOKEN );
  133130. i += iLookAhead;
  133131. if( yy_lookahead[i]!=iLookAhead ){
  133132. #ifdef YYFALLBACK
  133133. YYCODETYPE iFallback; /* Fallback token */
  133134. if( iLookAhead<sizeof(yyFallback)/sizeof(yyFallback[0])
  133135. && (iFallback = yyFallback[iLookAhead])!=0 ){
  133136. #ifndef NDEBUG
  133137. if( yyTraceFILE ){
  133138. fprintf(yyTraceFILE, "%sFALLBACK %s => %s\n",
  133139. yyTracePrompt, yyTokenName[iLookAhead], yyTokenName[iFallback]);
  133140. }
  133141. #endif
  133142. assert( yyFallback[iFallback]==0 ); /* Fallback loop must terminate */
  133143. iLookAhead = iFallback;
  133144. continue;
  133145. }
  133146. #endif
  133147. #ifdef YYWILDCARD
  133148. {
  133149. int j = i - iLookAhead + YYWILDCARD;
  133150. if(
  133151. #if YY_SHIFT_MIN+YYWILDCARD<0
  133152. j>=0 &&
  133153. #endif
  133154. #if YY_SHIFT_MAX+YYWILDCARD>=YY_ACTTAB_COUNT
  133155. j<YY_ACTTAB_COUNT &&
  133156. #endif
  133157. yy_lookahead[j]==YYWILDCARD && iLookAhead>0
  133158. ){
  133159. #ifndef NDEBUG
  133160. if( yyTraceFILE ){
  133161. fprintf(yyTraceFILE, "%sWILDCARD %s => %s\n",
  133162. yyTracePrompt, yyTokenName[iLookAhead],
  133163. yyTokenName[YYWILDCARD]);
  133164. }
  133165. #endif /* NDEBUG */
  133166. return yy_action[j];
  133167. }
  133168. }
  133169. #endif /* YYWILDCARD */
  133170. return yy_default[stateno];
  133171. }else{
  133172. return yy_action[i];
  133173. }
  133174. }while(1);
  133175. }
  133176. /*
  133177. ** Find the appropriate action for a parser given the non-terminal
  133178. ** look-ahead token iLookAhead.
  133179. */
  133180. static int yy_find_reduce_action(
  133181. int stateno, /* Current state number */
  133182. YYCODETYPE iLookAhead /* The look-ahead token */
  133183. ){
  133184. int i;
  133185. #ifdef YYERRORSYMBOL
  133186. if( stateno>YY_REDUCE_COUNT ){
  133187. return yy_default[stateno];
  133188. }
  133189. #else
  133190. assert( stateno<=YY_REDUCE_COUNT );
  133191. #endif
  133192. i = yy_reduce_ofst[stateno];
  133193. assert( iLookAhead!=YYNOCODE );
  133194. i += iLookAhead;
  133195. #ifdef YYERRORSYMBOL
  133196. if( i<0 || i>=YY_ACTTAB_COUNT || yy_lookahead[i]!=iLookAhead ){
  133197. return yy_default[stateno];
  133198. }
  133199. #else
  133200. assert( i>=0 && i<YY_ACTTAB_COUNT );
  133201. assert( yy_lookahead[i]==iLookAhead );
  133202. #endif
  133203. return yy_action[i];
  133204. }
  133205. /*
  133206. ** The following routine is called if the stack overflows.
  133207. */
  133208. static void yyStackOverflow(yyParser *yypParser){
  133209. sqlite3ParserARG_FETCH;
  133210. #ifndef NDEBUG
  133211. if( yyTraceFILE ){
  133212. fprintf(yyTraceFILE,"%sStack Overflow!\n",yyTracePrompt);
  133213. }
  133214. #endif
  133215. while( yypParser->yytos>yypParser->yystack ) yy_pop_parser_stack(yypParser);
  133216. /* Here code is inserted which will execute if the parser
  133217. ** stack every overflows */
  133218. /******** Begin %stack_overflow code ******************************************/
  133219. sqlite3ErrorMsg(pParse, "parser stack overflow");
  133220. /******** End %stack_overflow code ********************************************/
  133221. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument var */
  133222. }
  133223. /*
  133224. ** Print tracing information for a SHIFT action
  133225. */
  133226. #ifndef NDEBUG
  133227. static void yyTraceShift(yyParser *yypParser, int yyNewState, const char *zTag){
  133228. if( yyTraceFILE ){
  133229. if( yyNewState<YYNSTATE ){
  133230. fprintf(yyTraceFILE,"%s%s '%s', go to state %d\n",
  133231. yyTracePrompt, zTag, yyTokenName[yypParser->yytos->major],
  133232. yyNewState);
  133233. }else{
  133234. fprintf(yyTraceFILE,"%s%s '%s', pending reduce %d\n",
  133235. yyTracePrompt, zTag, yyTokenName[yypParser->yytos->major],
  133236. yyNewState - YY_MIN_REDUCE);
  133237. }
  133238. }
  133239. }
  133240. #else
  133241. # define yyTraceShift(X,Y,Z)
  133242. #endif
  133243. /*
  133244. ** Perform a shift action.
  133245. */
  133246. static void yy_shift(
  133247. yyParser *yypParser, /* The parser to be shifted */
  133248. int yyNewState, /* The new state to shift in */
  133249. int yyMajor, /* The major token to shift in */
  133250. sqlite3ParserTOKENTYPE yyMinor /* The minor token to shift in */
  133251. ){
  133252. yyStackEntry *yytos;
  133253. yypParser->yytos++;
  133254. #ifdef YYTRACKMAXSTACKDEPTH
  133255. if( (int)(yypParser->yytos - yypParser->yystack)>yypParser->yyhwm ){
  133256. yypParser->yyhwm++;
  133257. assert( yypParser->yyhwm == (int)(yypParser->yytos - yypParser->yystack) );
  133258. }
  133259. #endif
  133260. #if YYSTACKDEPTH>0
  133261. if( yypParser->yytos>yypParser->yystackEnd ){
  133262. yypParser->yytos--;
  133263. yyStackOverflow(yypParser);
  133264. return;
  133265. }
  133266. #else
  133267. if( yypParser->yytos>=&yypParser->yystack[yypParser->yystksz] ){
  133268. if( yyGrowStack(yypParser) ){
  133269. yypParser->yytos--;
  133270. yyStackOverflow(yypParser);
  133271. return;
  133272. }
  133273. }
  133274. #endif
  133275. if( yyNewState > YY_MAX_SHIFT ){
  133276. yyNewState += YY_MIN_REDUCE - YY_MIN_SHIFTREDUCE;
  133277. }
  133278. yytos = yypParser->yytos;
  133279. yytos->stateno = (YYACTIONTYPE)yyNewState;
  133280. yytos->major = (YYCODETYPE)yyMajor;
  133281. yytos->minor.yy0 = yyMinor;
  133282. yyTraceShift(yypParser, yyNewState, "Shift");
  133283. }
  133284. /* The following table contains information about every rule that
  133285. ** is used during the reduce.
  133286. */
  133287. static const struct {
  133288. YYCODETYPE lhs; /* Symbol on the left-hand side of the rule */
  133289. signed char nrhs; /* Negative of the number of RHS symbols in the rule */
  133290. } yyRuleInfo[] = {
  133291. { 147, -1 }, /* (0) explain ::= EXPLAIN */
  133292. { 147, -3 }, /* (1) explain ::= EXPLAIN QUERY PLAN */
  133293. { 148, -1 }, /* (2) cmdx ::= cmd */
  133294. { 149, -3 }, /* (3) cmd ::= BEGIN transtype trans_opt */
  133295. { 150, 0 }, /* (4) transtype ::= */
  133296. { 150, -1 }, /* (5) transtype ::= DEFERRED */
  133297. { 150, -1 }, /* (6) transtype ::= IMMEDIATE */
  133298. { 150, -1 }, /* (7) transtype ::= EXCLUSIVE */
  133299. { 149, -2 }, /* (8) cmd ::= COMMIT|END trans_opt */
  133300. { 149, -2 }, /* (9) cmd ::= ROLLBACK trans_opt */
  133301. { 149, -2 }, /* (10) cmd ::= SAVEPOINT nm */
  133302. { 149, -3 }, /* (11) cmd ::= RELEASE savepoint_opt nm */
  133303. { 149, -5 }, /* (12) cmd ::= ROLLBACK trans_opt TO savepoint_opt nm */
  133304. { 154, -6 }, /* (13) create_table ::= createkw temp TABLE ifnotexists nm dbnm */
  133305. { 156, -1 }, /* (14) createkw ::= CREATE */
  133306. { 158, 0 }, /* (15) ifnotexists ::= */
  133307. { 158, -3 }, /* (16) ifnotexists ::= IF NOT EXISTS */
  133308. { 157, -1 }, /* (17) temp ::= TEMP */
  133309. { 157, 0 }, /* (18) temp ::= */
  133310. { 155, -5 }, /* (19) create_table_args ::= LP columnlist conslist_opt RP table_options */
  133311. { 155, -2 }, /* (20) create_table_args ::= AS select */
  133312. { 162, 0 }, /* (21) table_options ::= */
  133313. { 162, -2 }, /* (22) table_options ::= WITHOUT nm */
  133314. { 164, -2 }, /* (23) columnname ::= nm typetoken */
  133315. { 166, 0 }, /* (24) typetoken ::= */
  133316. { 166, -4 }, /* (25) typetoken ::= typename LP signed RP */
  133317. { 166, -6 }, /* (26) typetoken ::= typename LP signed COMMA signed RP */
  133318. { 167, -2 }, /* (27) typename ::= typename ID|STRING */
  133319. { 171, 0 }, /* (28) scanpt ::= */
  133320. { 172, -2 }, /* (29) ccons ::= CONSTRAINT nm */
  133321. { 172, -4 }, /* (30) ccons ::= DEFAULT scanpt term scanpt */
  133322. { 172, -4 }, /* (31) ccons ::= DEFAULT LP expr RP */
  133323. { 172, -4 }, /* (32) ccons ::= DEFAULT PLUS term scanpt */
  133324. { 172, -4 }, /* (33) ccons ::= DEFAULT MINUS term scanpt */
  133325. { 172, -3 }, /* (34) ccons ::= DEFAULT scanpt ID|INDEXED */
  133326. { 172, -3 }, /* (35) ccons ::= NOT NULL onconf */
  133327. { 172, -5 }, /* (36) ccons ::= PRIMARY KEY sortorder onconf autoinc */
  133328. { 172, -2 }, /* (37) ccons ::= UNIQUE onconf */
  133329. { 172, -4 }, /* (38) ccons ::= CHECK LP expr RP */
  133330. { 172, -4 }, /* (39) ccons ::= REFERENCES nm eidlist_opt refargs */
  133331. { 172, -1 }, /* (40) ccons ::= defer_subclause */
  133332. { 172, -2 }, /* (41) ccons ::= COLLATE ID|STRING */
  133333. { 177, 0 }, /* (42) autoinc ::= */
  133334. { 177, -1 }, /* (43) autoinc ::= AUTOINCR */
  133335. { 179, 0 }, /* (44) refargs ::= */
  133336. { 179, -2 }, /* (45) refargs ::= refargs refarg */
  133337. { 181, -2 }, /* (46) refarg ::= MATCH nm */
  133338. { 181, -3 }, /* (47) refarg ::= ON INSERT refact */
  133339. { 181, -3 }, /* (48) refarg ::= ON DELETE refact */
  133340. { 181, -3 }, /* (49) refarg ::= ON UPDATE refact */
  133341. { 182, -2 }, /* (50) refact ::= SET NULL */
  133342. { 182, -2 }, /* (51) refact ::= SET DEFAULT */
  133343. { 182, -1 }, /* (52) refact ::= CASCADE */
  133344. { 182, -1 }, /* (53) refact ::= RESTRICT */
  133345. { 182, -2 }, /* (54) refact ::= NO ACTION */
  133346. { 180, -3 }, /* (55) defer_subclause ::= NOT DEFERRABLE init_deferred_pred_opt */
  133347. { 180, -2 }, /* (56) defer_subclause ::= DEFERRABLE init_deferred_pred_opt */
  133348. { 183, 0 }, /* (57) init_deferred_pred_opt ::= */
  133349. { 183, -2 }, /* (58) init_deferred_pred_opt ::= INITIALLY DEFERRED */
  133350. { 183, -2 }, /* (59) init_deferred_pred_opt ::= INITIALLY IMMEDIATE */
  133351. { 161, 0 }, /* (60) conslist_opt ::= */
  133352. { 185, -1 }, /* (61) tconscomma ::= COMMA */
  133353. { 186, -2 }, /* (62) tcons ::= CONSTRAINT nm */
  133354. { 186, -7 }, /* (63) tcons ::= PRIMARY KEY LP sortlist autoinc RP onconf */
  133355. { 186, -5 }, /* (64) tcons ::= UNIQUE LP sortlist RP onconf */
  133356. { 186, -5 }, /* (65) tcons ::= CHECK LP expr RP onconf */
  133357. { 186, -10 }, /* (66) tcons ::= FOREIGN KEY LP eidlist RP REFERENCES nm eidlist_opt refargs defer_subclause_opt */
  133358. { 189, 0 }, /* (67) defer_subclause_opt ::= */
  133359. { 175, 0 }, /* (68) onconf ::= */
  133360. { 175, -3 }, /* (69) onconf ::= ON CONFLICT resolvetype */
  133361. { 190, 0 }, /* (70) orconf ::= */
  133362. { 190, -2 }, /* (71) orconf ::= OR resolvetype */
  133363. { 191, -1 }, /* (72) resolvetype ::= IGNORE */
  133364. { 191, -1 }, /* (73) resolvetype ::= REPLACE */
  133365. { 149, -4 }, /* (74) cmd ::= DROP TABLE ifexists fullname */
  133366. { 193, -2 }, /* (75) ifexists ::= IF EXISTS */
  133367. { 193, 0 }, /* (76) ifexists ::= */
  133368. { 149, -9 }, /* (77) cmd ::= createkw temp VIEW ifnotexists nm dbnm eidlist_opt AS select */
  133369. { 149, -4 }, /* (78) cmd ::= DROP VIEW ifexists fullname */
  133370. { 149, -1 }, /* (79) cmd ::= select */
  133371. { 163, -3 }, /* (80) select ::= WITH wqlist selectnowith */
  133372. { 163, -4 }, /* (81) select ::= WITH RECURSIVE wqlist selectnowith */
  133373. { 163, -1 }, /* (82) select ::= selectnowith */
  133374. { 195, -3 }, /* (83) selectnowith ::= selectnowith multiselect_op oneselect */
  133375. { 198, -1 }, /* (84) multiselect_op ::= UNION */
  133376. { 198, -2 }, /* (85) multiselect_op ::= UNION ALL */
  133377. { 198, -1 }, /* (86) multiselect_op ::= EXCEPT|INTERSECT */
  133378. { 196, -9 }, /* (87) oneselect ::= SELECT distinct selcollist from where_opt groupby_opt having_opt orderby_opt limit_opt */
  133379. { 207, -4 }, /* (88) values ::= VALUES LP nexprlist RP */
  133380. { 207, -5 }, /* (89) values ::= values COMMA LP exprlist RP */
  133381. { 199, -1 }, /* (90) distinct ::= DISTINCT */
  133382. { 199, -1 }, /* (91) distinct ::= ALL */
  133383. { 199, 0 }, /* (92) distinct ::= */
  133384. { 210, 0 }, /* (93) sclp ::= */
  133385. { 200, -5 }, /* (94) selcollist ::= sclp scanpt expr scanpt as */
  133386. { 200, -3 }, /* (95) selcollist ::= sclp scanpt STAR */
  133387. { 200, -5 }, /* (96) selcollist ::= sclp scanpt nm DOT STAR */
  133388. { 211, -2 }, /* (97) as ::= AS nm */
  133389. { 211, 0 }, /* (98) as ::= */
  133390. { 201, 0 }, /* (99) from ::= */
  133391. { 201, -2 }, /* (100) from ::= FROM seltablist */
  133392. { 213, -2 }, /* (101) stl_prefix ::= seltablist joinop */
  133393. { 213, 0 }, /* (102) stl_prefix ::= */
  133394. { 212, -7 }, /* (103) seltablist ::= stl_prefix nm dbnm as indexed_opt on_opt using_opt */
  133395. { 212, -9 }, /* (104) seltablist ::= stl_prefix nm dbnm LP exprlist RP as on_opt using_opt */
  133396. { 212, -7 }, /* (105) seltablist ::= stl_prefix LP select RP as on_opt using_opt */
  133397. { 212, -7 }, /* (106) seltablist ::= stl_prefix LP seltablist RP as on_opt using_opt */
  133398. { 159, 0 }, /* (107) dbnm ::= */
  133399. { 159, -2 }, /* (108) dbnm ::= DOT nm */
  133400. { 194, -1 }, /* (109) fullname ::= nm */
  133401. { 194, -3 }, /* (110) fullname ::= nm DOT nm */
  133402. { 214, -1 }, /* (111) joinop ::= COMMA|JOIN */
  133403. { 214, -2 }, /* (112) joinop ::= JOIN_KW JOIN */
  133404. { 214, -3 }, /* (113) joinop ::= JOIN_KW nm JOIN */
  133405. { 214, -4 }, /* (114) joinop ::= JOIN_KW nm nm JOIN */
  133406. { 216, -2 }, /* (115) on_opt ::= ON expr */
  133407. { 216, 0 }, /* (116) on_opt ::= */
  133408. { 215, 0 }, /* (117) indexed_opt ::= */
  133409. { 215, -3 }, /* (118) indexed_opt ::= INDEXED BY nm */
  133410. { 215, -2 }, /* (119) indexed_opt ::= NOT INDEXED */
  133411. { 217, -4 }, /* (120) using_opt ::= USING LP idlist RP */
  133412. { 217, 0 }, /* (121) using_opt ::= */
  133413. { 205, 0 }, /* (122) orderby_opt ::= */
  133414. { 205, -3 }, /* (123) orderby_opt ::= ORDER BY sortlist */
  133415. { 187, -4 }, /* (124) sortlist ::= sortlist COMMA expr sortorder */
  133416. { 187, -2 }, /* (125) sortlist ::= expr sortorder */
  133417. { 176, -1 }, /* (126) sortorder ::= ASC */
  133418. { 176, -1 }, /* (127) sortorder ::= DESC */
  133419. { 176, 0 }, /* (128) sortorder ::= */
  133420. { 203, 0 }, /* (129) groupby_opt ::= */
  133421. { 203, -3 }, /* (130) groupby_opt ::= GROUP BY nexprlist */
  133422. { 204, 0 }, /* (131) having_opt ::= */
  133423. { 204, -2 }, /* (132) having_opt ::= HAVING expr */
  133424. { 206, 0 }, /* (133) limit_opt ::= */
  133425. { 206, -2 }, /* (134) limit_opt ::= LIMIT expr */
  133426. { 206, -4 }, /* (135) limit_opt ::= LIMIT expr OFFSET expr */
  133427. { 206, -4 }, /* (136) limit_opt ::= LIMIT expr COMMA expr */
  133428. { 149, -6 }, /* (137) cmd ::= with DELETE FROM fullname indexed_opt where_opt */
  133429. { 202, 0 }, /* (138) where_opt ::= */
  133430. { 202, -2 }, /* (139) where_opt ::= WHERE expr */
  133431. { 149, -8 }, /* (140) cmd ::= with UPDATE orconf fullname indexed_opt SET setlist where_opt */
  133432. { 220, -5 }, /* (141) setlist ::= setlist COMMA nm EQ expr */
  133433. { 220, -7 }, /* (142) setlist ::= setlist COMMA LP idlist RP EQ expr */
  133434. { 220, -3 }, /* (143) setlist ::= nm EQ expr */
  133435. { 220, -5 }, /* (144) setlist ::= LP idlist RP EQ expr */
  133436. { 149, -6 }, /* (145) cmd ::= with insert_cmd INTO fullname idlist_opt select */
  133437. { 149, -7 }, /* (146) cmd ::= with insert_cmd INTO fullname idlist_opt DEFAULT VALUES */
  133438. { 221, -2 }, /* (147) insert_cmd ::= INSERT orconf */
  133439. { 221, -1 }, /* (148) insert_cmd ::= REPLACE */
  133440. { 222, 0 }, /* (149) idlist_opt ::= */
  133441. { 222, -3 }, /* (150) idlist_opt ::= LP idlist RP */
  133442. { 218, -3 }, /* (151) idlist ::= idlist COMMA nm */
  133443. { 218, -1 }, /* (152) idlist ::= nm */
  133444. { 174, -3 }, /* (153) expr ::= LP expr RP */
  133445. { 174, -1 }, /* (154) expr ::= ID|INDEXED */
  133446. { 174, -1 }, /* (155) expr ::= JOIN_KW */
  133447. { 174, -3 }, /* (156) expr ::= nm DOT nm */
  133448. { 174, -5 }, /* (157) expr ::= nm DOT nm DOT nm */
  133449. { 173, -1 }, /* (158) term ::= NULL|FLOAT|BLOB */
  133450. { 173, -1 }, /* (159) term ::= STRING */
  133451. { 173, -1 }, /* (160) term ::= INTEGER */
  133452. { 174, -1 }, /* (161) expr ::= VARIABLE */
  133453. { 174, -3 }, /* (162) expr ::= expr COLLATE ID|STRING */
  133454. { 174, -6 }, /* (163) expr ::= CAST LP expr AS typetoken RP */
  133455. { 174, -5 }, /* (164) expr ::= ID|INDEXED LP distinct exprlist RP */
  133456. { 174, -4 }, /* (165) expr ::= ID|INDEXED LP STAR RP */
  133457. { 173, -1 }, /* (166) term ::= CTIME_KW */
  133458. { 174, -5 }, /* (167) expr ::= LP nexprlist COMMA expr RP */
  133459. { 174, -3 }, /* (168) expr ::= expr AND expr */
  133460. { 174, -3 }, /* (169) expr ::= expr OR expr */
  133461. { 174, -3 }, /* (170) expr ::= expr LT|GT|GE|LE expr */
  133462. { 174, -3 }, /* (171) expr ::= expr EQ|NE expr */
  133463. { 174, -3 }, /* (172) expr ::= expr BITAND|BITOR|LSHIFT|RSHIFT expr */
  133464. { 174, -3 }, /* (173) expr ::= expr PLUS|MINUS expr */
  133465. { 174, -3 }, /* (174) expr ::= expr STAR|SLASH|REM expr */
  133466. { 174, -3 }, /* (175) expr ::= expr CONCAT expr */
  133467. { 223, -2 }, /* (176) likeop ::= NOT LIKE_KW|MATCH */
  133468. { 174, -3 }, /* (177) expr ::= expr likeop expr */
  133469. { 174, -5 }, /* (178) expr ::= expr likeop expr ESCAPE expr */
  133470. { 174, -2 }, /* (179) expr ::= expr ISNULL|NOTNULL */
  133471. { 174, -3 }, /* (180) expr ::= expr NOT NULL */
  133472. { 174, -3 }, /* (181) expr ::= expr IS expr */
  133473. { 174, -4 }, /* (182) expr ::= expr IS NOT expr */
  133474. { 174, -2 }, /* (183) expr ::= NOT expr */
  133475. { 174, -2 }, /* (184) expr ::= BITNOT expr */
  133476. { 174, -2 }, /* (185) expr ::= MINUS expr */
  133477. { 174, -2 }, /* (186) expr ::= PLUS expr */
  133478. { 224, -1 }, /* (187) between_op ::= BETWEEN */
  133479. { 224, -2 }, /* (188) between_op ::= NOT BETWEEN */
  133480. { 174, -5 }, /* (189) expr ::= expr between_op expr AND expr */
  133481. { 225, -1 }, /* (190) in_op ::= IN */
  133482. { 225, -2 }, /* (191) in_op ::= NOT IN */
  133483. { 174, -5 }, /* (192) expr ::= expr in_op LP exprlist RP */
  133484. { 174, -3 }, /* (193) expr ::= LP select RP */
  133485. { 174, -5 }, /* (194) expr ::= expr in_op LP select RP */
  133486. { 174, -5 }, /* (195) expr ::= expr in_op nm dbnm paren_exprlist */
  133487. { 174, -4 }, /* (196) expr ::= EXISTS LP select RP */
  133488. { 174, -5 }, /* (197) expr ::= CASE case_operand case_exprlist case_else END */
  133489. { 228, -5 }, /* (198) case_exprlist ::= case_exprlist WHEN expr THEN expr */
  133490. { 228, -4 }, /* (199) case_exprlist ::= WHEN expr THEN expr */
  133491. { 229, -2 }, /* (200) case_else ::= ELSE expr */
  133492. { 229, 0 }, /* (201) case_else ::= */
  133493. { 227, -1 }, /* (202) case_operand ::= expr */
  133494. { 227, 0 }, /* (203) case_operand ::= */
  133495. { 209, 0 }, /* (204) exprlist ::= */
  133496. { 208, -3 }, /* (205) nexprlist ::= nexprlist COMMA expr */
  133497. { 208, -1 }, /* (206) nexprlist ::= expr */
  133498. { 226, 0 }, /* (207) paren_exprlist ::= */
  133499. { 226, -3 }, /* (208) paren_exprlist ::= LP exprlist RP */
  133500. { 149, -12 }, /* (209) cmd ::= createkw uniqueflag INDEX ifnotexists nm dbnm ON nm LP sortlist RP where_opt */
  133501. { 230, -1 }, /* (210) uniqueflag ::= UNIQUE */
  133502. { 230, 0 }, /* (211) uniqueflag ::= */
  133503. { 178, 0 }, /* (212) eidlist_opt ::= */
  133504. { 178, -3 }, /* (213) eidlist_opt ::= LP eidlist RP */
  133505. { 188, -5 }, /* (214) eidlist ::= eidlist COMMA nm collate sortorder */
  133506. { 188, -3 }, /* (215) eidlist ::= nm collate sortorder */
  133507. { 231, 0 }, /* (216) collate ::= */
  133508. { 231, -2 }, /* (217) collate ::= COLLATE ID|STRING */
  133509. { 149, -4 }, /* (218) cmd ::= DROP INDEX ifexists fullname */
  133510. { 149, -1 }, /* (219) cmd ::= VACUUM */
  133511. { 149, -2 }, /* (220) cmd ::= VACUUM nm */
  133512. { 149, -3 }, /* (221) cmd ::= PRAGMA nm dbnm */
  133513. { 149, -5 }, /* (222) cmd ::= PRAGMA nm dbnm EQ nmnum */
  133514. { 149, -6 }, /* (223) cmd ::= PRAGMA nm dbnm LP nmnum RP */
  133515. { 149, -5 }, /* (224) cmd ::= PRAGMA nm dbnm EQ minus_num */
  133516. { 149, -6 }, /* (225) cmd ::= PRAGMA nm dbnm LP minus_num RP */
  133517. { 169, -2 }, /* (226) plus_num ::= PLUS INTEGER|FLOAT */
  133518. { 170, -2 }, /* (227) minus_num ::= MINUS INTEGER|FLOAT */
  133519. { 149, -5 }, /* (228) cmd ::= createkw trigger_decl BEGIN trigger_cmd_list END */
  133520. { 233, -11 }, /* (229) trigger_decl ::= temp TRIGGER ifnotexists nm dbnm trigger_time trigger_event ON fullname foreach_clause when_clause */
  133521. { 235, -1 }, /* (230) trigger_time ::= BEFORE|AFTER */
  133522. { 235, -2 }, /* (231) trigger_time ::= INSTEAD OF */
  133523. { 235, 0 }, /* (232) trigger_time ::= */
  133524. { 236, -1 }, /* (233) trigger_event ::= DELETE|INSERT */
  133525. { 236, -1 }, /* (234) trigger_event ::= UPDATE */
  133526. { 236, -3 }, /* (235) trigger_event ::= UPDATE OF idlist */
  133527. { 238, 0 }, /* (236) when_clause ::= */
  133528. { 238, -2 }, /* (237) when_clause ::= WHEN expr */
  133529. { 234, -3 }, /* (238) trigger_cmd_list ::= trigger_cmd_list trigger_cmd SEMI */
  133530. { 234, -2 }, /* (239) trigger_cmd_list ::= trigger_cmd SEMI */
  133531. { 240, -3 }, /* (240) trnm ::= nm DOT nm */
  133532. { 241, -3 }, /* (241) tridxby ::= INDEXED BY nm */
  133533. { 241, -2 }, /* (242) tridxby ::= NOT INDEXED */
  133534. { 239, -8 }, /* (243) trigger_cmd ::= UPDATE orconf trnm tridxby SET setlist where_opt scanpt */
  133535. { 239, -7 }, /* (244) trigger_cmd ::= scanpt insert_cmd INTO trnm idlist_opt select scanpt */
  133536. { 239, -6 }, /* (245) trigger_cmd ::= DELETE FROM trnm tridxby where_opt scanpt */
  133537. { 239, -3 }, /* (246) trigger_cmd ::= scanpt select scanpt */
  133538. { 174, -4 }, /* (247) expr ::= RAISE LP IGNORE RP */
  133539. { 174, -6 }, /* (248) expr ::= RAISE LP raisetype COMMA nm RP */
  133540. { 192, -1 }, /* (249) raisetype ::= ROLLBACK */
  133541. { 192, -1 }, /* (250) raisetype ::= ABORT */
  133542. { 192, -1 }, /* (251) raisetype ::= FAIL */
  133543. { 149, -4 }, /* (252) cmd ::= DROP TRIGGER ifexists fullname */
  133544. { 149, -6 }, /* (253) cmd ::= ATTACH database_kw_opt expr AS expr key_opt */
  133545. { 149, -3 }, /* (254) cmd ::= DETACH database_kw_opt expr */
  133546. { 243, 0 }, /* (255) key_opt ::= */
  133547. { 243, -2 }, /* (256) key_opt ::= KEY expr */
  133548. { 149, -1 }, /* (257) cmd ::= REINDEX */
  133549. { 149, -3 }, /* (258) cmd ::= REINDEX nm dbnm */
  133550. { 149, -1 }, /* (259) cmd ::= ANALYZE */
  133551. { 149, -3 }, /* (260) cmd ::= ANALYZE nm dbnm */
  133552. { 149, -6 }, /* (261) cmd ::= ALTER TABLE fullname RENAME TO nm */
  133553. { 149, -7 }, /* (262) cmd ::= ALTER TABLE add_column_fullname ADD kwcolumn_opt columnname carglist */
  133554. { 244, -1 }, /* (263) add_column_fullname ::= fullname */
  133555. { 149, -1 }, /* (264) cmd ::= create_vtab */
  133556. { 149, -4 }, /* (265) cmd ::= create_vtab LP vtabarglist RP */
  133557. { 246, -8 }, /* (266) create_vtab ::= createkw VIRTUAL TABLE ifnotexists nm dbnm USING nm */
  133558. { 248, 0 }, /* (267) vtabarg ::= */
  133559. { 249, -1 }, /* (268) vtabargtoken ::= ANY */
  133560. { 249, -3 }, /* (269) vtabargtoken ::= lp anylist RP */
  133561. { 250, -1 }, /* (270) lp ::= LP */
  133562. { 219, -2 }, /* (271) with ::= WITH wqlist */
  133563. { 219, -3 }, /* (272) with ::= WITH RECURSIVE wqlist */
  133564. { 197, -6 }, /* (273) wqlist ::= nm eidlist_opt AS LP select RP */
  133565. { 197, -8 }, /* (274) wqlist ::= wqlist COMMA nm eidlist_opt AS LP select RP */
  133566. { 144, -1 }, /* (275) input ::= cmdlist */
  133567. { 145, -2 }, /* (276) cmdlist ::= cmdlist ecmd */
  133568. { 145, -1 }, /* (277) cmdlist ::= ecmd */
  133569. { 146, -1 }, /* (278) ecmd ::= SEMI */
  133570. { 146, -3 }, /* (279) ecmd ::= explain cmdx SEMI */
  133571. { 147, 0 }, /* (280) explain ::= */
  133572. { 151, 0 }, /* (281) trans_opt ::= */
  133573. { 151, -1 }, /* (282) trans_opt ::= TRANSACTION */
  133574. { 151, -2 }, /* (283) trans_opt ::= TRANSACTION nm */
  133575. { 153, -1 }, /* (284) savepoint_opt ::= SAVEPOINT */
  133576. { 153, 0 }, /* (285) savepoint_opt ::= */
  133577. { 149, -2 }, /* (286) cmd ::= create_table create_table_args */
  133578. { 160, -4 }, /* (287) columnlist ::= columnlist COMMA columnname carglist */
  133579. { 160, -2 }, /* (288) columnlist ::= columnname carglist */
  133580. { 152, -1 }, /* (289) nm ::= ID|INDEXED */
  133581. { 152, -1 }, /* (290) nm ::= STRING */
  133582. { 152, -1 }, /* (291) nm ::= JOIN_KW */
  133583. { 166, -1 }, /* (292) typetoken ::= typename */
  133584. { 167, -1 }, /* (293) typename ::= ID|STRING */
  133585. { 168, -1 }, /* (294) signed ::= plus_num */
  133586. { 168, -1 }, /* (295) signed ::= minus_num */
  133587. { 165, -2 }, /* (296) carglist ::= carglist ccons */
  133588. { 165, 0 }, /* (297) carglist ::= */
  133589. { 172, -2 }, /* (298) ccons ::= NULL onconf */
  133590. { 161, -2 }, /* (299) conslist_opt ::= COMMA conslist */
  133591. { 184, -3 }, /* (300) conslist ::= conslist tconscomma tcons */
  133592. { 184, -1 }, /* (301) conslist ::= tcons */
  133593. { 185, 0 }, /* (302) tconscomma ::= */
  133594. { 189, -1 }, /* (303) defer_subclause_opt ::= defer_subclause */
  133595. { 191, -1 }, /* (304) resolvetype ::= raisetype */
  133596. { 195, -1 }, /* (305) selectnowith ::= oneselect */
  133597. { 196, -1 }, /* (306) oneselect ::= values */
  133598. { 210, -2 }, /* (307) sclp ::= selcollist COMMA */
  133599. { 211, -1 }, /* (308) as ::= ID|STRING */
  133600. { 174, -1 }, /* (309) expr ::= term */
  133601. { 223, -1 }, /* (310) likeop ::= LIKE_KW|MATCH */
  133602. { 209, -1 }, /* (311) exprlist ::= nexprlist */
  133603. { 232, -1 }, /* (312) nmnum ::= plus_num */
  133604. { 232, -1 }, /* (313) nmnum ::= nm */
  133605. { 232, -1 }, /* (314) nmnum ::= ON */
  133606. { 232, -1 }, /* (315) nmnum ::= DELETE */
  133607. { 232, -1 }, /* (316) nmnum ::= DEFAULT */
  133608. { 169, -1 }, /* (317) plus_num ::= INTEGER|FLOAT */
  133609. { 237, 0 }, /* (318) foreach_clause ::= */
  133610. { 237, -3 }, /* (319) foreach_clause ::= FOR EACH ROW */
  133611. { 240, -1 }, /* (320) trnm ::= nm */
  133612. { 241, 0 }, /* (321) tridxby ::= */
  133613. { 242, -1 }, /* (322) database_kw_opt ::= DATABASE */
  133614. { 242, 0 }, /* (323) database_kw_opt ::= */
  133615. { 245, 0 }, /* (324) kwcolumn_opt ::= */
  133616. { 245, -1 }, /* (325) kwcolumn_opt ::= COLUMNKW */
  133617. { 247, -1 }, /* (326) vtabarglist ::= vtabarg */
  133618. { 247, -3 }, /* (327) vtabarglist ::= vtabarglist COMMA vtabarg */
  133619. { 248, -2 }, /* (328) vtabarg ::= vtabarg vtabargtoken */
  133620. { 251, 0 }, /* (329) anylist ::= */
  133621. { 251, -4 }, /* (330) anylist ::= anylist LP anylist RP */
  133622. { 251, -2 }, /* (331) anylist ::= anylist ANY */
  133623. { 219, 0 }, /* (332) with ::= */
  133624. };
  133625. static void yy_accept(yyParser*); /* Forward Declaration */
  133626. /*
  133627. ** Perform a reduce action and the shift that must immediately
  133628. ** follow the reduce.
  133629. **
  133630. ** The yyLookahead and yyLookaheadToken parameters provide reduce actions
  133631. ** access to the lookahead token (if any). The yyLookahead will be YYNOCODE
  133632. ** if the lookahead token has already been consumed. As this procedure is
  133633. ** only called from one place, optimizing compilers will in-line it, which
  133634. ** means that the extra parameters have no performance impact.
  133635. */
  133636. static void yy_reduce(
  133637. yyParser *yypParser, /* The parser */
  133638. unsigned int yyruleno, /* Number of the rule by which to reduce */
  133639. int yyLookahead, /* Lookahead token, or YYNOCODE if none */
  133640. sqlite3ParserTOKENTYPE yyLookaheadToken /* Value of the lookahead token */
  133641. ){
  133642. int yygoto; /* The next state */
  133643. int yyact; /* The next action */
  133644. yyStackEntry *yymsp; /* The top of the parser's stack */
  133645. int yysize; /* Amount to pop the stack */
  133646. sqlite3ParserARG_FETCH;
  133647. (void)yyLookahead;
  133648. (void)yyLookaheadToken;
  133649. yymsp = yypParser->yytos;
  133650. #ifndef NDEBUG
  133651. if( yyTraceFILE && yyruleno<(int)(sizeof(yyRuleName)/sizeof(yyRuleName[0])) ){
  133652. yysize = yyRuleInfo[yyruleno].nrhs;
  133653. if( yysize ){
  133654. fprintf(yyTraceFILE, "%sReduce %d [%s], go to state %d.\n",
  133655. yyTracePrompt,
  133656. yyruleno, yyRuleName[yyruleno], yymsp[yysize].stateno);
  133657. }else{
  133658. fprintf(yyTraceFILE, "%sReduce %d [%s].\n",
  133659. yyTracePrompt, yyruleno, yyRuleName[yyruleno]);
  133660. }
  133661. }
  133662. #endif /* NDEBUG */
  133663. /* Check that the stack is large enough to grow by a single entry
  133664. ** if the RHS of the rule is empty. This ensures that there is room
  133665. ** enough on the stack to push the LHS value */
  133666. if( yyRuleInfo[yyruleno].nrhs==0 ){
  133667. #ifdef YYTRACKMAXSTACKDEPTH
  133668. if( (int)(yypParser->yytos - yypParser->yystack)>yypParser->yyhwm ){
  133669. yypParser->yyhwm++;
  133670. assert( yypParser->yyhwm == (int)(yypParser->yytos - yypParser->yystack));
  133671. }
  133672. #endif
  133673. #if YYSTACKDEPTH>0
  133674. if( yypParser->yytos>=yypParser->yystackEnd ){
  133675. yyStackOverflow(yypParser);
  133676. return;
  133677. }
  133678. #else
  133679. if( yypParser->yytos>=&yypParser->yystack[yypParser->yystksz-1] ){
  133680. if( yyGrowStack(yypParser) ){
  133681. yyStackOverflow(yypParser);
  133682. return;
  133683. }
  133684. yymsp = yypParser->yytos;
  133685. }
  133686. #endif
  133687. }
  133688. switch( yyruleno ){
  133689. /* Beginning here are the reduction cases. A typical example
  133690. ** follows:
  133691. ** case 0:
  133692. ** #line <lineno> <grammarfile>
  133693. ** { ... } // User supplied code
  133694. ** #line <lineno> <thisfile>
  133695. ** break;
  133696. */
  133697. /********** Begin reduce actions **********************************************/
  133698. YYMINORTYPE yylhsminor;
  133699. case 0: /* explain ::= EXPLAIN */
  133700. { pParse->explain = 1; }
  133701. break;
  133702. case 1: /* explain ::= EXPLAIN QUERY PLAN */
  133703. { pParse->explain = 2; }
  133704. break;
  133705. case 2: /* cmdx ::= cmd */
  133706. { sqlite3FinishCoding(pParse); }
  133707. break;
  133708. case 3: /* cmd ::= BEGIN transtype trans_opt */
  133709. {sqlite3BeginTransaction(pParse, yymsp[-1].minor.yy4);}
  133710. break;
  133711. case 4: /* transtype ::= */
  133712. {yymsp[1].minor.yy4 = TK_DEFERRED;}
  133713. break;
  133714. case 5: /* transtype ::= DEFERRED */
  133715. case 6: /* transtype ::= IMMEDIATE */ yytestcase(yyruleno==6);
  133716. case 7: /* transtype ::= EXCLUSIVE */ yytestcase(yyruleno==7);
  133717. {yymsp[0].minor.yy4 = yymsp[0].major; /*A-overwrites-X*/}
  133718. break;
  133719. case 8: /* cmd ::= COMMIT|END trans_opt */
  133720. case 9: /* cmd ::= ROLLBACK trans_opt */ yytestcase(yyruleno==9);
  133721. {sqlite3EndTransaction(pParse,yymsp[-1].major);}
  133722. break;
  133723. case 10: /* cmd ::= SAVEPOINT nm */
  133724. {
  133725. sqlite3Savepoint(pParse, SAVEPOINT_BEGIN, &yymsp[0].minor.yy0);
  133726. }
  133727. break;
  133728. case 11: /* cmd ::= RELEASE savepoint_opt nm */
  133729. {
  133730. sqlite3Savepoint(pParse, SAVEPOINT_RELEASE, &yymsp[0].minor.yy0);
  133731. }
  133732. break;
  133733. case 12: /* cmd ::= ROLLBACK trans_opt TO savepoint_opt nm */
  133734. {
  133735. sqlite3Savepoint(pParse, SAVEPOINT_ROLLBACK, &yymsp[0].minor.yy0);
  133736. }
  133737. break;
  133738. case 13: /* create_table ::= createkw temp TABLE ifnotexists nm dbnm */
  133739. {
  133740. sqlite3StartTable(pParse,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0,yymsp[-4].minor.yy4,0,0,yymsp[-2].minor.yy4);
  133741. }
  133742. break;
  133743. case 14: /* createkw ::= CREATE */
  133744. {disableLookaside(pParse);}
  133745. break;
  133746. case 15: /* ifnotexists ::= */
  133747. case 18: /* temp ::= */ yytestcase(yyruleno==18);
  133748. case 21: /* table_options ::= */ yytestcase(yyruleno==21);
  133749. case 42: /* autoinc ::= */ yytestcase(yyruleno==42);
  133750. case 57: /* init_deferred_pred_opt ::= */ yytestcase(yyruleno==57);
  133751. case 67: /* defer_subclause_opt ::= */ yytestcase(yyruleno==67);
  133752. case 76: /* ifexists ::= */ yytestcase(yyruleno==76);
  133753. case 92: /* distinct ::= */ yytestcase(yyruleno==92);
  133754. case 216: /* collate ::= */ yytestcase(yyruleno==216);
  133755. {yymsp[1].minor.yy4 = 0;}
  133756. break;
  133757. case 16: /* ifnotexists ::= IF NOT EXISTS */
  133758. {yymsp[-2].minor.yy4 = 1;}
  133759. break;
  133760. case 17: /* temp ::= TEMP */
  133761. case 43: /* autoinc ::= AUTOINCR */ yytestcase(yyruleno==43);
  133762. {yymsp[0].minor.yy4 = 1;}
  133763. break;
  133764. case 19: /* create_table_args ::= LP columnlist conslist_opt RP table_options */
  133765. {
  133766. sqlite3EndTable(pParse,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0,yymsp[0].minor.yy4,0);
  133767. }
  133768. break;
  133769. case 20: /* create_table_args ::= AS select */
  133770. {
  133771. sqlite3EndTable(pParse,0,0,0,yymsp[0].minor.yy387);
  133772. sqlite3SelectDelete(pParse->db, yymsp[0].minor.yy387);
  133773. }
  133774. break;
  133775. case 22: /* table_options ::= WITHOUT nm */
  133776. {
  133777. if( yymsp[0].minor.yy0.n==5 && sqlite3_strnicmp(yymsp[0].minor.yy0.z,"rowid",5)==0 ){
  133778. yymsp[-1].minor.yy4 = TF_WithoutRowid | TF_NoVisibleRowid;
  133779. }else{
  133780. yymsp[-1].minor.yy4 = 0;
  133781. sqlite3ErrorMsg(pParse, "unknown table option: %.*s", yymsp[0].minor.yy0.n, yymsp[0].minor.yy0.z);
  133782. }
  133783. }
  133784. break;
  133785. case 23: /* columnname ::= nm typetoken */
  133786. {sqlite3AddColumn(pParse,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0);}
  133787. break;
  133788. case 24: /* typetoken ::= */
  133789. case 60: /* conslist_opt ::= */ yytestcase(yyruleno==60);
  133790. case 98: /* as ::= */ yytestcase(yyruleno==98);
  133791. {yymsp[1].minor.yy0.n = 0; yymsp[1].minor.yy0.z = 0;}
  133792. break;
  133793. case 25: /* typetoken ::= typename LP signed RP */
  133794. {
  133795. yymsp[-3].minor.yy0.n = (int)(&yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n] - yymsp[-3].minor.yy0.z);
  133796. }
  133797. break;
  133798. case 26: /* typetoken ::= typename LP signed COMMA signed RP */
  133799. {
  133800. yymsp[-5].minor.yy0.n = (int)(&yymsp[0].minor.yy0.z[yymsp[0].minor.yy0.n] - yymsp[-5].minor.yy0.z);
  133801. }
  133802. break;
  133803. case 27: /* typename ::= typename ID|STRING */
  133804. {yymsp[-1].minor.yy0.n=yymsp[0].minor.yy0.n+(int)(yymsp[0].minor.yy0.z-yymsp[-1].minor.yy0.z);}
  133805. break;
  133806. case 28: /* scanpt ::= */
  133807. {
  133808. assert( yyLookahead!=YYNOCODE );
  133809. yymsp[1].minor.yy336 = yyLookaheadToken.z;
  133810. }
  133811. break;
  133812. case 29: /* ccons ::= CONSTRAINT nm */
  133813. case 62: /* tcons ::= CONSTRAINT nm */ yytestcase(yyruleno==62);
  133814. {pParse->constraintName = yymsp[0].minor.yy0;}
  133815. break;
  133816. case 30: /* ccons ::= DEFAULT scanpt term scanpt */
  133817. {sqlite3AddDefaultValue(pParse,yymsp[-1].minor.yy314,yymsp[-2].minor.yy336,yymsp[0].minor.yy336);}
  133818. break;
  133819. case 31: /* ccons ::= DEFAULT LP expr RP */
  133820. {sqlite3AddDefaultValue(pParse,yymsp[-1].minor.yy314,yymsp[-2].minor.yy0.z+1,yymsp[0].minor.yy0.z);}
  133821. break;
  133822. case 32: /* ccons ::= DEFAULT PLUS term scanpt */
  133823. {sqlite3AddDefaultValue(pParse,yymsp[-1].minor.yy314,yymsp[-2].minor.yy0.z,yymsp[0].minor.yy336);}
  133824. break;
  133825. case 33: /* ccons ::= DEFAULT MINUS term scanpt */
  133826. {
  133827. Expr *p = sqlite3PExpr(pParse, TK_UMINUS, yymsp[-1].minor.yy314, 0);
  133828. sqlite3AddDefaultValue(pParse,p,yymsp[-2].minor.yy0.z,yymsp[0].minor.yy336);
  133829. }
  133830. break;
  133831. case 34: /* ccons ::= DEFAULT scanpt ID|INDEXED */
  133832. {
  133833. Expr *p = tokenExpr(pParse, TK_STRING, yymsp[0].minor.yy0);
  133834. if( p ){
  133835. sqlite3ExprIdToTrueFalse(p);
  133836. testcase( p->op==TK_TRUEFALSE && sqlite3ExprTruthValue(p) );
  133837. }
  133838. sqlite3AddDefaultValue(pParse,p,yymsp[0].minor.yy0.z,yymsp[0].minor.yy0.z+yymsp[0].minor.yy0.n);
  133839. }
  133840. break;
  133841. case 35: /* ccons ::= NOT NULL onconf */
  133842. {sqlite3AddNotNull(pParse, yymsp[0].minor.yy4);}
  133843. break;
  133844. case 36: /* ccons ::= PRIMARY KEY sortorder onconf autoinc */
  133845. {sqlite3AddPrimaryKey(pParse,0,yymsp[-1].minor.yy4,yymsp[0].minor.yy4,yymsp[-2].minor.yy4);}
  133846. break;
  133847. case 37: /* ccons ::= UNIQUE onconf */
  133848. {sqlite3CreateIndex(pParse,0,0,0,0,yymsp[0].minor.yy4,0,0,0,0,
  133849. SQLITE_IDXTYPE_UNIQUE);}
  133850. break;
  133851. case 38: /* ccons ::= CHECK LP expr RP */
  133852. {sqlite3AddCheckConstraint(pParse,yymsp[-1].minor.yy314);}
  133853. break;
  133854. case 39: /* ccons ::= REFERENCES nm eidlist_opt refargs */
  133855. {sqlite3CreateForeignKey(pParse,0,&yymsp[-2].minor.yy0,yymsp[-1].minor.yy322,yymsp[0].minor.yy4);}
  133856. break;
  133857. case 40: /* ccons ::= defer_subclause */
  133858. {sqlite3DeferForeignKey(pParse,yymsp[0].minor.yy4);}
  133859. break;
  133860. case 41: /* ccons ::= COLLATE ID|STRING */
  133861. {sqlite3AddCollateType(pParse, &yymsp[0].minor.yy0);}
  133862. break;
  133863. case 44: /* refargs ::= */
  133864. { yymsp[1].minor.yy4 = OE_None*0x0101; /* EV: R-19803-45884 */}
  133865. break;
  133866. case 45: /* refargs ::= refargs refarg */
  133867. { yymsp[-1].minor.yy4 = (yymsp[-1].minor.yy4 & ~yymsp[0].minor.yy215.mask) | yymsp[0].minor.yy215.value; }
  133868. break;
  133869. case 46: /* refarg ::= MATCH nm */
  133870. { yymsp[-1].minor.yy215.value = 0; yymsp[-1].minor.yy215.mask = 0x000000; }
  133871. break;
  133872. case 47: /* refarg ::= ON INSERT refact */
  133873. { yymsp[-2].minor.yy215.value = 0; yymsp[-2].minor.yy215.mask = 0x000000; }
  133874. break;
  133875. case 48: /* refarg ::= ON DELETE refact */
  133876. { yymsp[-2].minor.yy215.value = yymsp[0].minor.yy4; yymsp[-2].minor.yy215.mask = 0x0000ff; }
  133877. break;
  133878. case 49: /* refarg ::= ON UPDATE refact */
  133879. { yymsp[-2].minor.yy215.value = yymsp[0].minor.yy4<<8; yymsp[-2].minor.yy215.mask = 0x00ff00; }
  133880. break;
  133881. case 50: /* refact ::= SET NULL */
  133882. { yymsp[-1].minor.yy4 = OE_SetNull; /* EV: R-33326-45252 */}
  133883. break;
  133884. case 51: /* refact ::= SET DEFAULT */
  133885. { yymsp[-1].minor.yy4 = OE_SetDflt; /* EV: R-33326-45252 */}
  133886. break;
  133887. case 52: /* refact ::= CASCADE */
  133888. { yymsp[0].minor.yy4 = OE_Cascade; /* EV: R-33326-45252 */}
  133889. break;
  133890. case 53: /* refact ::= RESTRICT */
  133891. { yymsp[0].minor.yy4 = OE_Restrict; /* EV: R-33326-45252 */}
  133892. break;
  133893. case 54: /* refact ::= NO ACTION */
  133894. { yymsp[-1].minor.yy4 = OE_None; /* EV: R-33326-45252 */}
  133895. break;
  133896. case 55: /* defer_subclause ::= NOT DEFERRABLE init_deferred_pred_opt */
  133897. {yymsp[-2].minor.yy4 = 0;}
  133898. break;
  133899. case 56: /* defer_subclause ::= DEFERRABLE init_deferred_pred_opt */
  133900. case 71: /* orconf ::= OR resolvetype */ yytestcase(yyruleno==71);
  133901. case 147: /* insert_cmd ::= INSERT orconf */ yytestcase(yyruleno==147);
  133902. {yymsp[-1].minor.yy4 = yymsp[0].minor.yy4;}
  133903. break;
  133904. case 58: /* init_deferred_pred_opt ::= INITIALLY DEFERRED */
  133905. case 75: /* ifexists ::= IF EXISTS */ yytestcase(yyruleno==75);
  133906. case 188: /* between_op ::= NOT BETWEEN */ yytestcase(yyruleno==188);
  133907. case 191: /* in_op ::= NOT IN */ yytestcase(yyruleno==191);
  133908. case 217: /* collate ::= COLLATE ID|STRING */ yytestcase(yyruleno==217);
  133909. {yymsp[-1].minor.yy4 = 1;}
  133910. break;
  133911. case 59: /* init_deferred_pred_opt ::= INITIALLY IMMEDIATE */
  133912. {yymsp[-1].minor.yy4 = 0;}
  133913. break;
  133914. case 61: /* tconscomma ::= COMMA */
  133915. {pParse->constraintName.n = 0;}
  133916. break;
  133917. case 63: /* tcons ::= PRIMARY KEY LP sortlist autoinc RP onconf */
  133918. {sqlite3AddPrimaryKey(pParse,yymsp[-3].minor.yy322,yymsp[0].minor.yy4,yymsp[-2].minor.yy4,0);}
  133919. break;
  133920. case 64: /* tcons ::= UNIQUE LP sortlist RP onconf */
  133921. {sqlite3CreateIndex(pParse,0,0,0,yymsp[-2].minor.yy322,yymsp[0].minor.yy4,0,0,0,0,
  133922. SQLITE_IDXTYPE_UNIQUE);}
  133923. break;
  133924. case 65: /* tcons ::= CHECK LP expr RP onconf */
  133925. {sqlite3AddCheckConstraint(pParse,yymsp[-2].minor.yy314);}
  133926. break;
  133927. case 66: /* tcons ::= FOREIGN KEY LP eidlist RP REFERENCES nm eidlist_opt refargs defer_subclause_opt */
  133928. {
  133929. sqlite3CreateForeignKey(pParse, yymsp[-6].minor.yy322, &yymsp[-3].minor.yy0, yymsp[-2].minor.yy322, yymsp[-1].minor.yy4);
  133930. sqlite3DeferForeignKey(pParse, yymsp[0].minor.yy4);
  133931. }
  133932. break;
  133933. case 68: /* onconf ::= */
  133934. case 70: /* orconf ::= */ yytestcase(yyruleno==70);
  133935. {yymsp[1].minor.yy4 = OE_Default;}
  133936. break;
  133937. case 69: /* onconf ::= ON CONFLICT resolvetype */
  133938. {yymsp[-2].minor.yy4 = yymsp[0].minor.yy4;}
  133939. break;
  133940. case 72: /* resolvetype ::= IGNORE */
  133941. {yymsp[0].minor.yy4 = OE_Ignore;}
  133942. break;
  133943. case 73: /* resolvetype ::= REPLACE */
  133944. case 148: /* insert_cmd ::= REPLACE */ yytestcase(yyruleno==148);
  133945. {yymsp[0].minor.yy4 = OE_Replace;}
  133946. break;
  133947. case 74: /* cmd ::= DROP TABLE ifexists fullname */
  133948. {
  133949. sqlite3DropTable(pParse, yymsp[0].minor.yy259, 0, yymsp[-1].minor.yy4);
  133950. }
  133951. break;
  133952. case 77: /* cmd ::= createkw temp VIEW ifnotexists nm dbnm eidlist_opt AS select */
  133953. {
  133954. sqlite3CreateView(pParse, &yymsp[-8].minor.yy0, &yymsp[-4].minor.yy0, &yymsp[-3].minor.yy0, yymsp[-2].minor.yy322, yymsp[0].minor.yy387, yymsp[-7].minor.yy4, yymsp[-5].minor.yy4);
  133955. }
  133956. break;
  133957. case 78: /* cmd ::= DROP VIEW ifexists fullname */
  133958. {
  133959. sqlite3DropTable(pParse, yymsp[0].minor.yy259, 1, yymsp[-1].minor.yy4);
  133960. }
  133961. break;
  133962. case 79: /* cmd ::= select */
  133963. {
  133964. SelectDest dest = {SRT_Output, 0, 0, 0, 0, 0};
  133965. sqlite3Select(pParse, yymsp[0].minor.yy387, &dest);
  133966. sqlite3SelectDelete(pParse->db, yymsp[0].minor.yy387);
  133967. }
  133968. break;
  133969. case 80: /* select ::= WITH wqlist selectnowith */
  133970. {
  133971. Select *p = yymsp[0].minor.yy387;
  133972. if( p ){
  133973. p->pWith = yymsp[-1].minor.yy451;
  133974. parserDoubleLinkSelect(pParse, p);
  133975. }else{
  133976. sqlite3WithDelete(pParse->db, yymsp[-1].minor.yy451);
  133977. }
  133978. yymsp[-2].minor.yy387 = p;
  133979. }
  133980. break;
  133981. case 81: /* select ::= WITH RECURSIVE wqlist selectnowith */
  133982. {
  133983. Select *p = yymsp[0].minor.yy387;
  133984. if( p ){
  133985. p->pWith = yymsp[-1].minor.yy451;
  133986. parserDoubleLinkSelect(pParse, p);
  133987. }else{
  133988. sqlite3WithDelete(pParse->db, yymsp[-1].minor.yy451);
  133989. }
  133990. yymsp[-3].minor.yy387 = p;
  133991. }
  133992. break;
  133993. case 82: /* select ::= selectnowith */
  133994. {
  133995. Select *p = yymsp[0].minor.yy387;
  133996. if( p ){
  133997. parserDoubleLinkSelect(pParse, p);
  133998. }
  133999. yymsp[0].minor.yy387 = p; /*A-overwrites-X*/
  134000. }
  134001. break;
  134002. case 83: /* selectnowith ::= selectnowith multiselect_op oneselect */
  134003. {
  134004. Select *pRhs = yymsp[0].minor.yy387;
  134005. Select *pLhs = yymsp[-2].minor.yy387;
  134006. if( pRhs && pRhs->pPrior ){
  134007. SrcList *pFrom;
  134008. Token x;
  134009. x.n = 0;
  134010. parserDoubleLinkSelect(pParse, pRhs);
  134011. pFrom = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&x,pRhs,0,0);
  134012. pRhs = sqlite3SelectNew(pParse,0,pFrom,0,0,0,0,0,0);
  134013. }
  134014. if( pRhs ){
  134015. pRhs->op = (u8)yymsp[-1].minor.yy4;
  134016. pRhs->pPrior = pLhs;
  134017. if( ALWAYS(pLhs) ) pLhs->selFlags &= ~SF_MultiValue;
  134018. pRhs->selFlags &= ~SF_MultiValue;
  134019. if( yymsp[-1].minor.yy4!=TK_ALL ) pParse->hasCompound = 1;
  134020. }else{
  134021. sqlite3SelectDelete(pParse->db, pLhs);
  134022. }
  134023. yymsp[-2].minor.yy387 = pRhs;
  134024. }
  134025. break;
  134026. case 84: /* multiselect_op ::= UNION */
  134027. case 86: /* multiselect_op ::= EXCEPT|INTERSECT */ yytestcase(yyruleno==86);
  134028. {yymsp[0].minor.yy4 = yymsp[0].major; /*A-overwrites-OP*/}
  134029. break;
  134030. case 85: /* multiselect_op ::= UNION ALL */
  134031. {yymsp[-1].minor.yy4 = TK_ALL;}
  134032. break;
  134033. case 87: /* oneselect ::= SELECT distinct selcollist from where_opt groupby_opt having_opt orderby_opt limit_opt */
  134034. {
  134035. #if SELECTTRACE_ENABLED
  134036. Token s = yymsp[-8].minor.yy0; /*A-overwrites-S*/
  134037. #endif
  134038. yymsp[-8].minor.yy387 = sqlite3SelectNew(pParse,yymsp[-6].minor.yy322,yymsp[-5].minor.yy259,yymsp[-4].minor.yy314,yymsp[-3].minor.yy322,yymsp[-2].minor.yy314,yymsp[-1].minor.yy322,yymsp[-7].minor.yy4,yymsp[0].minor.yy314);
  134039. #if SELECTTRACE_ENABLED
  134040. /* Populate the Select.zSelName[] string that is used to help with
  134041. ** query planner debugging, to differentiate between multiple Select
  134042. ** objects in a complex query.
  134043. **
  134044. ** If the SELECT keyword is immediately followed by a C-style comment
  134045. ** then extract the first few alphanumeric characters from within that
  134046. ** comment to be the zSelName value. Otherwise, the label is #N where
  134047. ** is an integer that is incremented with each SELECT statement seen.
  134048. */
  134049. if( yymsp[-8].minor.yy387!=0 ){
  134050. const char *z = s.z+6;
  134051. int i;
  134052. sqlite3_snprintf(sizeof(yymsp[-8].minor.yy387->zSelName), yymsp[-8].minor.yy387->zSelName,"#%d",++pParse->nSelect);
  134053. while( z[0]==' ' ) z++;
  134054. if( z[0]=='/' && z[1]=='*' ){
  134055. z += 2;
  134056. while( z[0]==' ' ) z++;
  134057. for(i=0; sqlite3Isalnum(z[i]); i++){}
  134058. sqlite3_snprintf(sizeof(yymsp[-8].minor.yy387->zSelName), yymsp[-8].minor.yy387->zSelName, "%.*s", i, z);
  134059. }
  134060. }
  134061. #endif /* SELECTRACE_ENABLED */
  134062. }
  134063. break;
  134064. case 88: /* values ::= VALUES LP nexprlist RP */
  134065. {
  134066. yymsp[-3].minor.yy387 = sqlite3SelectNew(pParse,yymsp[-1].minor.yy322,0,0,0,0,0,SF_Values,0);
  134067. }
  134068. break;
  134069. case 89: /* values ::= values COMMA LP exprlist RP */
  134070. {
  134071. Select *pRight, *pLeft = yymsp[-4].minor.yy387;
  134072. pRight = sqlite3SelectNew(pParse,yymsp[-1].minor.yy322,0,0,0,0,0,SF_Values|SF_MultiValue,0);
  134073. if( ALWAYS(pLeft) ) pLeft->selFlags &= ~SF_MultiValue;
  134074. if( pRight ){
  134075. pRight->op = TK_ALL;
  134076. pRight->pPrior = pLeft;
  134077. yymsp[-4].minor.yy387 = pRight;
  134078. }else{
  134079. yymsp[-4].minor.yy387 = pLeft;
  134080. }
  134081. }
  134082. break;
  134083. case 90: /* distinct ::= DISTINCT */
  134084. {yymsp[0].minor.yy4 = SF_Distinct;}
  134085. break;
  134086. case 91: /* distinct ::= ALL */
  134087. {yymsp[0].minor.yy4 = SF_All;}
  134088. break;
  134089. case 93: /* sclp ::= */
  134090. case 122: /* orderby_opt ::= */ yytestcase(yyruleno==122);
  134091. case 129: /* groupby_opt ::= */ yytestcase(yyruleno==129);
  134092. case 204: /* exprlist ::= */ yytestcase(yyruleno==204);
  134093. case 207: /* paren_exprlist ::= */ yytestcase(yyruleno==207);
  134094. case 212: /* eidlist_opt ::= */ yytestcase(yyruleno==212);
  134095. {yymsp[1].minor.yy322 = 0;}
  134096. break;
  134097. case 94: /* selcollist ::= sclp scanpt expr scanpt as */
  134098. {
  134099. yymsp[-4].minor.yy322 = sqlite3ExprListAppend(pParse, yymsp[-4].minor.yy322, yymsp[-2].minor.yy314);
  134100. if( yymsp[0].minor.yy0.n>0 ) sqlite3ExprListSetName(pParse, yymsp[-4].minor.yy322, &yymsp[0].minor.yy0, 1);
  134101. sqlite3ExprListSetSpan(pParse,yymsp[-4].minor.yy322,yymsp[-3].minor.yy336,yymsp[-1].minor.yy336);
  134102. }
  134103. break;
  134104. case 95: /* selcollist ::= sclp scanpt STAR */
  134105. {
  134106. Expr *p = sqlite3Expr(pParse->db, TK_ASTERISK, 0);
  134107. yymsp[-2].minor.yy322 = sqlite3ExprListAppend(pParse, yymsp[-2].minor.yy322, p);
  134108. }
  134109. break;
  134110. case 96: /* selcollist ::= sclp scanpt nm DOT STAR */
  134111. {
  134112. Expr *pRight = sqlite3PExpr(pParse, TK_ASTERISK, 0, 0);
  134113. Expr *pLeft = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-2].minor.yy0, 1);
  134114. Expr *pDot = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
  134115. yymsp[-4].minor.yy322 = sqlite3ExprListAppend(pParse,yymsp[-4].minor.yy322, pDot);
  134116. }
  134117. break;
  134118. case 97: /* as ::= AS nm */
  134119. case 108: /* dbnm ::= DOT nm */ yytestcase(yyruleno==108);
  134120. case 226: /* plus_num ::= PLUS INTEGER|FLOAT */ yytestcase(yyruleno==226);
  134121. case 227: /* minus_num ::= MINUS INTEGER|FLOAT */ yytestcase(yyruleno==227);
  134122. {yymsp[-1].minor.yy0 = yymsp[0].minor.yy0;}
  134123. break;
  134124. case 99: /* from ::= */
  134125. {yymsp[1].minor.yy259 = sqlite3DbMallocZero(pParse->db, sizeof(*yymsp[1].minor.yy259));}
  134126. break;
  134127. case 100: /* from ::= FROM seltablist */
  134128. {
  134129. yymsp[-1].minor.yy259 = yymsp[0].minor.yy259;
  134130. sqlite3SrcListShiftJoinType(yymsp[-1].minor.yy259);
  134131. }
  134132. break;
  134133. case 101: /* stl_prefix ::= seltablist joinop */
  134134. {
  134135. if( ALWAYS(yymsp[-1].minor.yy259 && yymsp[-1].minor.yy259->nSrc>0) ) yymsp[-1].minor.yy259->a[yymsp[-1].minor.yy259->nSrc-1].fg.jointype = (u8)yymsp[0].minor.yy4;
  134136. }
  134137. break;
  134138. case 102: /* stl_prefix ::= */
  134139. {yymsp[1].minor.yy259 = 0;}
  134140. break;
  134141. case 103: /* seltablist ::= stl_prefix nm dbnm as indexed_opt on_opt using_opt */
  134142. {
  134143. yymsp[-6].minor.yy259 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy259,&yymsp[-5].minor.yy0,&yymsp[-4].minor.yy0,&yymsp[-3].minor.yy0,0,yymsp[-1].minor.yy314,yymsp[0].minor.yy384);
  134144. sqlite3SrcListIndexedBy(pParse, yymsp[-6].minor.yy259, &yymsp[-2].minor.yy0);
  134145. }
  134146. break;
  134147. case 104: /* seltablist ::= stl_prefix nm dbnm LP exprlist RP as on_opt using_opt */
  134148. {
  134149. yymsp[-8].minor.yy259 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-8].minor.yy259,&yymsp[-7].minor.yy0,&yymsp[-6].minor.yy0,&yymsp[-2].minor.yy0,0,yymsp[-1].minor.yy314,yymsp[0].minor.yy384);
  134150. sqlite3SrcListFuncArgs(pParse, yymsp[-8].minor.yy259, yymsp[-4].minor.yy322);
  134151. }
  134152. break;
  134153. case 105: /* seltablist ::= stl_prefix LP select RP as on_opt using_opt */
  134154. {
  134155. yymsp[-6].minor.yy259 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy259,0,0,&yymsp[-2].minor.yy0,yymsp[-4].minor.yy387,yymsp[-1].minor.yy314,yymsp[0].minor.yy384);
  134156. }
  134157. break;
  134158. case 106: /* seltablist ::= stl_prefix LP seltablist RP as on_opt using_opt */
  134159. {
  134160. if( yymsp[-6].minor.yy259==0 && yymsp[-2].minor.yy0.n==0 && yymsp[-1].minor.yy314==0 && yymsp[0].minor.yy384==0 ){
  134161. yymsp[-6].minor.yy259 = yymsp[-4].minor.yy259;
  134162. }else if( yymsp[-4].minor.yy259->nSrc==1 ){
  134163. yymsp[-6].minor.yy259 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy259,0,0,&yymsp[-2].minor.yy0,0,yymsp[-1].minor.yy314,yymsp[0].minor.yy384);
  134164. if( yymsp[-6].minor.yy259 ){
  134165. struct SrcList_item *pNew = &yymsp[-6].minor.yy259->a[yymsp[-6].minor.yy259->nSrc-1];
  134166. struct SrcList_item *pOld = yymsp[-4].minor.yy259->a;
  134167. pNew->zName = pOld->zName;
  134168. pNew->zDatabase = pOld->zDatabase;
  134169. pNew->pSelect = pOld->pSelect;
  134170. pOld->zName = pOld->zDatabase = 0;
  134171. pOld->pSelect = 0;
  134172. }
  134173. sqlite3SrcListDelete(pParse->db, yymsp[-4].minor.yy259);
  134174. }else{
  134175. Select *pSubquery;
  134176. sqlite3SrcListShiftJoinType(yymsp[-4].minor.yy259);
  134177. pSubquery = sqlite3SelectNew(pParse,0,yymsp[-4].minor.yy259,0,0,0,0,SF_NestedFrom,0);
  134178. yymsp[-6].minor.yy259 = sqlite3SrcListAppendFromTerm(pParse,yymsp[-6].minor.yy259,0,0,&yymsp[-2].minor.yy0,pSubquery,yymsp[-1].minor.yy314,yymsp[0].minor.yy384);
  134179. }
  134180. }
  134181. break;
  134182. case 107: /* dbnm ::= */
  134183. case 117: /* indexed_opt ::= */ yytestcase(yyruleno==117);
  134184. {yymsp[1].minor.yy0.z=0; yymsp[1].minor.yy0.n=0;}
  134185. break;
  134186. case 109: /* fullname ::= nm */
  134187. {yymsp[0].minor.yy259 = sqlite3SrcListAppend(pParse->db,0,&yymsp[0].minor.yy0,0); /*A-overwrites-X*/}
  134188. break;
  134189. case 110: /* fullname ::= nm DOT nm */
  134190. {yymsp[-2].minor.yy259 = sqlite3SrcListAppend(pParse->db,0,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0); /*A-overwrites-X*/}
  134191. break;
  134192. case 111: /* joinop ::= COMMA|JOIN */
  134193. { yymsp[0].minor.yy4 = JT_INNER; }
  134194. break;
  134195. case 112: /* joinop ::= JOIN_KW JOIN */
  134196. {yymsp[-1].minor.yy4 = sqlite3JoinType(pParse,&yymsp[-1].minor.yy0,0,0); /*X-overwrites-A*/}
  134197. break;
  134198. case 113: /* joinop ::= JOIN_KW nm JOIN */
  134199. {yymsp[-2].minor.yy4 = sqlite3JoinType(pParse,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0,0); /*X-overwrites-A*/}
  134200. break;
  134201. case 114: /* joinop ::= JOIN_KW nm nm JOIN */
  134202. {yymsp[-3].minor.yy4 = sqlite3JoinType(pParse,&yymsp[-3].minor.yy0,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0);/*X-overwrites-A*/}
  134203. break;
  134204. case 115: /* on_opt ::= ON expr */
  134205. case 132: /* having_opt ::= HAVING expr */ yytestcase(yyruleno==132);
  134206. case 139: /* where_opt ::= WHERE expr */ yytestcase(yyruleno==139);
  134207. case 200: /* case_else ::= ELSE expr */ yytestcase(yyruleno==200);
  134208. {yymsp[-1].minor.yy314 = yymsp[0].minor.yy314;}
  134209. break;
  134210. case 116: /* on_opt ::= */
  134211. case 131: /* having_opt ::= */ yytestcase(yyruleno==131);
  134212. case 133: /* limit_opt ::= */ yytestcase(yyruleno==133);
  134213. case 138: /* where_opt ::= */ yytestcase(yyruleno==138);
  134214. case 201: /* case_else ::= */ yytestcase(yyruleno==201);
  134215. case 203: /* case_operand ::= */ yytestcase(yyruleno==203);
  134216. {yymsp[1].minor.yy314 = 0;}
  134217. break;
  134218. case 118: /* indexed_opt ::= INDEXED BY nm */
  134219. {yymsp[-2].minor.yy0 = yymsp[0].minor.yy0;}
  134220. break;
  134221. case 119: /* indexed_opt ::= NOT INDEXED */
  134222. {yymsp[-1].minor.yy0.z=0; yymsp[-1].minor.yy0.n=1;}
  134223. break;
  134224. case 120: /* using_opt ::= USING LP idlist RP */
  134225. {yymsp[-3].minor.yy384 = yymsp[-1].minor.yy384;}
  134226. break;
  134227. case 121: /* using_opt ::= */
  134228. case 149: /* idlist_opt ::= */ yytestcase(yyruleno==149);
  134229. {yymsp[1].minor.yy384 = 0;}
  134230. break;
  134231. case 123: /* orderby_opt ::= ORDER BY sortlist */
  134232. case 130: /* groupby_opt ::= GROUP BY nexprlist */ yytestcase(yyruleno==130);
  134233. {yymsp[-2].minor.yy322 = yymsp[0].minor.yy322;}
  134234. break;
  134235. case 124: /* sortlist ::= sortlist COMMA expr sortorder */
  134236. {
  134237. yymsp[-3].minor.yy322 = sqlite3ExprListAppend(pParse,yymsp[-3].minor.yy322,yymsp[-1].minor.yy314);
  134238. sqlite3ExprListSetSortOrder(yymsp[-3].minor.yy322,yymsp[0].minor.yy4);
  134239. }
  134240. break;
  134241. case 125: /* sortlist ::= expr sortorder */
  134242. {
  134243. yymsp[-1].minor.yy322 = sqlite3ExprListAppend(pParse,0,yymsp[-1].minor.yy314); /*A-overwrites-Y*/
  134244. sqlite3ExprListSetSortOrder(yymsp[-1].minor.yy322,yymsp[0].minor.yy4);
  134245. }
  134246. break;
  134247. case 126: /* sortorder ::= ASC */
  134248. {yymsp[0].minor.yy4 = SQLITE_SO_ASC;}
  134249. break;
  134250. case 127: /* sortorder ::= DESC */
  134251. {yymsp[0].minor.yy4 = SQLITE_SO_DESC;}
  134252. break;
  134253. case 128: /* sortorder ::= */
  134254. {yymsp[1].minor.yy4 = SQLITE_SO_UNDEFINED;}
  134255. break;
  134256. case 134: /* limit_opt ::= LIMIT expr */
  134257. {yymsp[-1].minor.yy314 = sqlite3PExpr(pParse,TK_LIMIT,yymsp[0].minor.yy314,0);}
  134258. break;
  134259. case 135: /* limit_opt ::= LIMIT expr OFFSET expr */
  134260. {yymsp[-3].minor.yy314 = sqlite3PExpr(pParse,TK_LIMIT,yymsp[-2].minor.yy314,yymsp[0].minor.yy314);}
  134261. break;
  134262. case 136: /* limit_opt ::= LIMIT expr COMMA expr */
  134263. {yymsp[-3].minor.yy314 = sqlite3PExpr(pParse,TK_LIMIT,yymsp[0].minor.yy314,yymsp[-2].minor.yy314);}
  134264. break;
  134265. case 137: /* cmd ::= with DELETE FROM fullname indexed_opt where_opt */
  134266. {
  134267. sqlite3SrcListIndexedBy(pParse, yymsp[-2].minor.yy259, &yymsp[-1].minor.yy0);
  134268. sqlite3DeleteFrom(pParse,yymsp[-2].minor.yy259,yymsp[0].minor.yy314,0,0);
  134269. }
  134270. break;
  134271. case 140: /* cmd ::= with UPDATE orconf fullname indexed_opt SET setlist where_opt */
  134272. {
  134273. sqlite3SrcListIndexedBy(pParse, yymsp[-4].minor.yy259, &yymsp[-3].minor.yy0);
  134274. sqlite3ExprListCheckLength(pParse,yymsp[-1].minor.yy322,"set list");
  134275. sqlite3Update(pParse,yymsp[-4].minor.yy259,yymsp[-1].minor.yy322,yymsp[0].minor.yy314,yymsp[-5].minor.yy4,0,0);
  134276. }
  134277. break;
  134278. case 141: /* setlist ::= setlist COMMA nm EQ expr */
  134279. {
  134280. yymsp[-4].minor.yy322 = sqlite3ExprListAppend(pParse, yymsp[-4].minor.yy322, yymsp[0].minor.yy314);
  134281. sqlite3ExprListSetName(pParse, yymsp[-4].minor.yy322, &yymsp[-2].minor.yy0, 1);
  134282. }
  134283. break;
  134284. case 142: /* setlist ::= setlist COMMA LP idlist RP EQ expr */
  134285. {
  134286. yymsp[-6].minor.yy322 = sqlite3ExprListAppendVector(pParse, yymsp[-6].minor.yy322, yymsp[-3].minor.yy384, yymsp[0].minor.yy314);
  134287. }
  134288. break;
  134289. case 143: /* setlist ::= nm EQ expr */
  134290. {
  134291. yylhsminor.yy322 = sqlite3ExprListAppend(pParse, 0, yymsp[0].minor.yy314);
  134292. sqlite3ExprListSetName(pParse, yylhsminor.yy322, &yymsp[-2].minor.yy0, 1);
  134293. }
  134294. yymsp[-2].minor.yy322 = yylhsminor.yy322;
  134295. break;
  134296. case 144: /* setlist ::= LP idlist RP EQ expr */
  134297. {
  134298. yymsp[-4].minor.yy322 = sqlite3ExprListAppendVector(pParse, 0, yymsp[-3].minor.yy384, yymsp[0].minor.yy314);
  134299. }
  134300. break;
  134301. case 145: /* cmd ::= with insert_cmd INTO fullname idlist_opt select */
  134302. {
  134303. sqlite3Insert(pParse, yymsp[-2].minor.yy259, yymsp[0].minor.yy387, yymsp[-1].minor.yy384, yymsp[-4].minor.yy4);
  134304. }
  134305. break;
  134306. case 146: /* cmd ::= with insert_cmd INTO fullname idlist_opt DEFAULT VALUES */
  134307. {
  134308. sqlite3Insert(pParse, yymsp[-3].minor.yy259, 0, yymsp[-2].minor.yy384, yymsp[-5].minor.yy4);
  134309. }
  134310. break;
  134311. case 150: /* idlist_opt ::= LP idlist RP */
  134312. {yymsp[-2].minor.yy384 = yymsp[-1].minor.yy384;}
  134313. break;
  134314. case 151: /* idlist ::= idlist COMMA nm */
  134315. {yymsp[-2].minor.yy384 = sqlite3IdListAppend(pParse->db,yymsp[-2].minor.yy384,&yymsp[0].minor.yy0);}
  134316. break;
  134317. case 152: /* idlist ::= nm */
  134318. {yymsp[0].minor.yy384 = sqlite3IdListAppend(pParse->db,0,&yymsp[0].minor.yy0); /*A-overwrites-Y*/}
  134319. break;
  134320. case 153: /* expr ::= LP expr RP */
  134321. {yymsp[-2].minor.yy314 = yymsp[-1].minor.yy314;}
  134322. break;
  134323. case 154: /* expr ::= ID|INDEXED */
  134324. case 155: /* expr ::= JOIN_KW */ yytestcase(yyruleno==155);
  134325. {yymsp[0].minor.yy314=tokenExpr(pParse,TK_ID,yymsp[0].minor.yy0); /*A-overwrites-X*/}
  134326. break;
  134327. case 156: /* expr ::= nm DOT nm */
  134328. {
  134329. Expr *temp1 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-2].minor.yy0, 1);
  134330. Expr *temp2 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[0].minor.yy0, 1);
  134331. yylhsminor.yy314 = sqlite3PExpr(pParse, TK_DOT, temp1, temp2);
  134332. }
  134333. yymsp[-2].minor.yy314 = yylhsminor.yy314;
  134334. break;
  134335. case 157: /* expr ::= nm DOT nm DOT nm */
  134336. {
  134337. Expr *temp1 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-4].minor.yy0, 1);
  134338. Expr *temp2 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[-2].minor.yy0, 1);
  134339. Expr *temp3 = sqlite3ExprAlloc(pParse->db, TK_ID, &yymsp[0].minor.yy0, 1);
  134340. Expr *temp4 = sqlite3PExpr(pParse, TK_DOT, temp2, temp3);
  134341. yylhsminor.yy314 = sqlite3PExpr(pParse, TK_DOT, temp1, temp4);
  134342. }
  134343. yymsp[-4].minor.yy314 = yylhsminor.yy314;
  134344. break;
  134345. case 158: /* term ::= NULL|FLOAT|BLOB */
  134346. case 159: /* term ::= STRING */ yytestcase(yyruleno==159);
  134347. {yymsp[0].minor.yy314=tokenExpr(pParse,yymsp[0].major,yymsp[0].minor.yy0); /*A-overwrites-X*/}
  134348. break;
  134349. case 160: /* term ::= INTEGER */
  134350. {
  134351. yylhsminor.yy314 = sqlite3ExprAlloc(pParse->db, TK_INTEGER, &yymsp[0].minor.yy0, 1);
  134352. }
  134353. yymsp[0].minor.yy314 = yylhsminor.yy314;
  134354. break;
  134355. case 161: /* expr ::= VARIABLE */
  134356. {
  134357. if( !(yymsp[0].minor.yy0.z[0]=='#' && sqlite3Isdigit(yymsp[0].minor.yy0.z[1])) ){
  134358. u32 n = yymsp[0].minor.yy0.n;
  134359. yymsp[0].minor.yy314 = tokenExpr(pParse, TK_VARIABLE, yymsp[0].minor.yy0);
  134360. sqlite3ExprAssignVarNumber(pParse, yymsp[0].minor.yy314, n);
  134361. }else{
  134362. /* When doing a nested parse, one can include terms in an expression
  134363. ** that look like this: #1 #2 ... These terms refer to registers
  134364. ** in the virtual machine. #N is the N-th register. */
  134365. Token t = yymsp[0].minor.yy0; /*A-overwrites-X*/
  134366. assert( t.n>=2 );
  134367. if( pParse->nested==0 ){
  134368. sqlite3ErrorMsg(pParse, "near \"%T\": syntax error", &t);
  134369. yymsp[0].minor.yy314 = 0;
  134370. }else{
  134371. yymsp[0].minor.yy314 = sqlite3PExpr(pParse, TK_REGISTER, 0, 0);
  134372. if( yymsp[0].minor.yy314 ) sqlite3GetInt32(&t.z[1], &yymsp[0].minor.yy314->iTable);
  134373. }
  134374. }
  134375. }
  134376. break;
  134377. case 162: /* expr ::= expr COLLATE ID|STRING */
  134378. {
  134379. yymsp[-2].minor.yy314 = sqlite3ExprAddCollateToken(pParse, yymsp[-2].minor.yy314, &yymsp[0].minor.yy0, 1);
  134380. }
  134381. break;
  134382. case 163: /* expr ::= CAST LP expr AS typetoken RP */
  134383. {
  134384. yymsp[-5].minor.yy314 = sqlite3ExprAlloc(pParse->db, TK_CAST, &yymsp[-1].minor.yy0, 1);
  134385. sqlite3ExprAttachSubtrees(pParse->db, yymsp[-5].minor.yy314, yymsp[-3].minor.yy314, 0);
  134386. }
  134387. break;
  134388. case 164: /* expr ::= ID|INDEXED LP distinct exprlist RP */
  134389. {
  134390. if( yymsp[-1].minor.yy322 && yymsp[-1].minor.yy322->nExpr>pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
  134391. sqlite3ErrorMsg(pParse, "too many arguments on function %T", &yymsp[-4].minor.yy0);
  134392. }
  134393. yylhsminor.yy314 = sqlite3ExprFunction(pParse, yymsp[-1].minor.yy322, &yymsp[-4].minor.yy0);
  134394. if( yymsp[-2].minor.yy4==SF_Distinct && yylhsminor.yy314 ){
  134395. yylhsminor.yy314->flags |= EP_Distinct;
  134396. }
  134397. }
  134398. yymsp[-4].minor.yy314 = yylhsminor.yy314;
  134399. break;
  134400. case 165: /* expr ::= ID|INDEXED LP STAR RP */
  134401. {
  134402. yylhsminor.yy314 = sqlite3ExprFunction(pParse, 0, &yymsp[-3].minor.yy0);
  134403. }
  134404. yymsp[-3].minor.yy314 = yylhsminor.yy314;
  134405. break;
  134406. case 166: /* term ::= CTIME_KW */
  134407. {
  134408. yylhsminor.yy314 = sqlite3ExprFunction(pParse, 0, &yymsp[0].minor.yy0);
  134409. }
  134410. yymsp[0].minor.yy314 = yylhsminor.yy314;
  134411. break;
  134412. case 167: /* expr ::= LP nexprlist COMMA expr RP */
  134413. {
  134414. ExprList *pList = sqlite3ExprListAppend(pParse, yymsp[-3].minor.yy322, yymsp[-1].minor.yy314);
  134415. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_VECTOR, 0, 0);
  134416. if( yymsp[-4].minor.yy314 ){
  134417. yymsp[-4].minor.yy314->x.pList = pList;
  134418. }else{
  134419. sqlite3ExprListDelete(pParse->db, pList);
  134420. }
  134421. }
  134422. break;
  134423. case 168: /* expr ::= expr AND expr */
  134424. case 169: /* expr ::= expr OR expr */ yytestcase(yyruleno==169);
  134425. case 170: /* expr ::= expr LT|GT|GE|LE expr */ yytestcase(yyruleno==170);
  134426. case 171: /* expr ::= expr EQ|NE expr */ yytestcase(yyruleno==171);
  134427. case 172: /* expr ::= expr BITAND|BITOR|LSHIFT|RSHIFT expr */ yytestcase(yyruleno==172);
  134428. case 173: /* expr ::= expr PLUS|MINUS expr */ yytestcase(yyruleno==173);
  134429. case 174: /* expr ::= expr STAR|SLASH|REM expr */ yytestcase(yyruleno==174);
  134430. case 175: /* expr ::= expr CONCAT expr */ yytestcase(yyruleno==175);
  134431. {yymsp[-2].minor.yy314=sqlite3PExpr(pParse,yymsp[-1].major,yymsp[-2].minor.yy314,yymsp[0].minor.yy314);}
  134432. break;
  134433. case 176: /* likeop ::= NOT LIKE_KW|MATCH */
  134434. {yymsp[-1].minor.yy0=yymsp[0].minor.yy0; yymsp[-1].minor.yy0.n|=0x80000000; /*yymsp[-1].minor.yy0-overwrite-yymsp[0].minor.yy0*/}
  134435. break;
  134436. case 177: /* expr ::= expr likeop expr */
  134437. {
  134438. ExprList *pList;
  134439. int bNot = yymsp[-1].minor.yy0.n & 0x80000000;
  134440. yymsp[-1].minor.yy0.n &= 0x7fffffff;
  134441. pList = sqlite3ExprListAppend(pParse,0, yymsp[0].minor.yy314);
  134442. pList = sqlite3ExprListAppend(pParse,pList, yymsp[-2].minor.yy314);
  134443. yymsp[-2].minor.yy314 = sqlite3ExprFunction(pParse, pList, &yymsp[-1].minor.yy0);
  134444. if( bNot ) yymsp[-2].minor.yy314 = sqlite3PExpr(pParse, TK_NOT, yymsp[-2].minor.yy314, 0);
  134445. if( yymsp[-2].minor.yy314 ) yymsp[-2].minor.yy314->flags |= EP_InfixFunc;
  134446. }
  134447. break;
  134448. case 178: /* expr ::= expr likeop expr ESCAPE expr */
  134449. {
  134450. ExprList *pList;
  134451. int bNot = yymsp[-3].minor.yy0.n & 0x80000000;
  134452. yymsp[-3].minor.yy0.n &= 0x7fffffff;
  134453. pList = sqlite3ExprListAppend(pParse,0, yymsp[-2].minor.yy314);
  134454. pList = sqlite3ExprListAppend(pParse,pList, yymsp[-4].minor.yy314);
  134455. pList = sqlite3ExprListAppend(pParse,pList, yymsp[0].minor.yy314);
  134456. yymsp[-4].minor.yy314 = sqlite3ExprFunction(pParse, pList, &yymsp[-3].minor.yy0);
  134457. if( bNot ) yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_NOT, yymsp[-4].minor.yy314, 0);
  134458. if( yymsp[-4].minor.yy314 ) yymsp[-4].minor.yy314->flags |= EP_InfixFunc;
  134459. }
  134460. break;
  134461. case 179: /* expr ::= expr ISNULL|NOTNULL */
  134462. {yymsp[-1].minor.yy314 = sqlite3PExpr(pParse,yymsp[0].major,yymsp[-1].minor.yy314,0);}
  134463. break;
  134464. case 180: /* expr ::= expr NOT NULL */
  134465. {yymsp[-2].minor.yy314 = sqlite3PExpr(pParse,TK_NOTNULL,yymsp[-2].minor.yy314,0);}
  134466. break;
  134467. case 181: /* expr ::= expr IS expr */
  134468. {
  134469. yymsp[-2].minor.yy314 = sqlite3PExpr(pParse,TK_IS,yymsp[-2].minor.yy314,yymsp[0].minor.yy314);
  134470. binaryToUnaryIfNull(pParse, yymsp[0].minor.yy314, yymsp[-2].minor.yy314, TK_ISNULL);
  134471. }
  134472. break;
  134473. case 182: /* expr ::= expr IS NOT expr */
  134474. {
  134475. yymsp[-3].minor.yy314 = sqlite3PExpr(pParse,TK_ISNOT,yymsp[-3].minor.yy314,yymsp[0].minor.yy314);
  134476. binaryToUnaryIfNull(pParse, yymsp[0].minor.yy314, yymsp[-3].minor.yy314, TK_NOTNULL);
  134477. }
  134478. break;
  134479. case 183: /* expr ::= NOT expr */
  134480. case 184: /* expr ::= BITNOT expr */ yytestcase(yyruleno==184);
  134481. {yymsp[-1].minor.yy314 = sqlite3PExpr(pParse, yymsp[-1].major, yymsp[0].minor.yy314, 0);/*A-overwrites-B*/}
  134482. break;
  134483. case 185: /* expr ::= MINUS expr */
  134484. {yymsp[-1].minor.yy314 = sqlite3PExpr(pParse, TK_UMINUS, yymsp[0].minor.yy314, 0);}
  134485. break;
  134486. case 186: /* expr ::= PLUS expr */
  134487. {yymsp[-1].minor.yy314 = sqlite3PExpr(pParse, TK_UPLUS, yymsp[0].minor.yy314, 0);}
  134488. break;
  134489. case 187: /* between_op ::= BETWEEN */
  134490. case 190: /* in_op ::= IN */ yytestcase(yyruleno==190);
  134491. {yymsp[0].minor.yy4 = 0;}
  134492. break;
  134493. case 189: /* expr ::= expr between_op expr AND expr */
  134494. {
  134495. ExprList *pList = sqlite3ExprListAppend(pParse,0, yymsp[-2].minor.yy314);
  134496. pList = sqlite3ExprListAppend(pParse,pList, yymsp[0].minor.yy314);
  134497. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_BETWEEN, yymsp[-4].minor.yy314, 0);
  134498. if( yymsp[-4].minor.yy314 ){
  134499. yymsp[-4].minor.yy314->x.pList = pList;
  134500. }else{
  134501. sqlite3ExprListDelete(pParse->db, pList);
  134502. }
  134503. if( yymsp[-3].minor.yy4 ) yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_NOT, yymsp[-4].minor.yy314, 0);
  134504. }
  134505. break;
  134506. case 192: /* expr ::= expr in_op LP exprlist RP */
  134507. {
  134508. if( yymsp[-1].minor.yy322==0 ){
  134509. /* Expressions of the form
  134510. **
  134511. ** expr1 IN ()
  134512. ** expr1 NOT IN ()
  134513. **
  134514. ** simplify to constants 0 (false) and 1 (true), respectively,
  134515. ** regardless of the value of expr1.
  134516. */
  134517. sqlite3ExprDelete(pParse->db, yymsp[-4].minor.yy314);
  134518. yymsp[-4].minor.yy314 = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[yymsp[-3].minor.yy4],1);
  134519. }else if( yymsp[-1].minor.yy322->nExpr==1 ){
  134520. /* Expressions of the form:
  134521. **
  134522. ** expr1 IN (?1)
  134523. ** expr1 NOT IN (?2)
  134524. **
  134525. ** with exactly one value on the RHS can be simplified to something
  134526. ** like this:
  134527. **
  134528. ** expr1 == ?1
  134529. ** expr1 <> ?2
  134530. **
  134531. ** But, the RHS of the == or <> is marked with the EP_Generic flag
  134532. ** so that it may not contribute to the computation of comparison
  134533. ** affinity or the collating sequence to use for comparison. Otherwise,
  134534. ** the semantics would be subtly different from IN or NOT IN.
  134535. */
  134536. Expr *pRHS = yymsp[-1].minor.yy322->a[0].pExpr;
  134537. yymsp[-1].minor.yy322->a[0].pExpr = 0;
  134538. sqlite3ExprListDelete(pParse->db, yymsp[-1].minor.yy322);
  134539. /* pRHS cannot be NULL because a malloc error would have been detected
  134540. ** before now and control would have never reached this point */
  134541. if( ALWAYS(pRHS) ){
  134542. pRHS->flags &= ~EP_Collate;
  134543. pRHS->flags |= EP_Generic;
  134544. }
  134545. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, yymsp[-3].minor.yy4 ? TK_NE : TK_EQ, yymsp[-4].minor.yy314, pRHS);
  134546. }else{
  134547. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_IN, yymsp[-4].minor.yy314, 0);
  134548. if( yymsp[-4].minor.yy314 ){
  134549. yymsp[-4].minor.yy314->x.pList = yymsp[-1].minor.yy322;
  134550. sqlite3ExprSetHeightAndFlags(pParse, yymsp[-4].minor.yy314);
  134551. }else{
  134552. sqlite3ExprListDelete(pParse->db, yymsp[-1].minor.yy322);
  134553. }
  134554. if( yymsp[-3].minor.yy4 ) yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_NOT, yymsp[-4].minor.yy314, 0);
  134555. }
  134556. }
  134557. break;
  134558. case 193: /* expr ::= LP select RP */
  134559. {
  134560. yymsp[-2].minor.yy314 = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
  134561. sqlite3PExprAddSelect(pParse, yymsp[-2].minor.yy314, yymsp[-1].minor.yy387);
  134562. }
  134563. break;
  134564. case 194: /* expr ::= expr in_op LP select RP */
  134565. {
  134566. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_IN, yymsp[-4].minor.yy314, 0);
  134567. sqlite3PExprAddSelect(pParse, yymsp[-4].minor.yy314, yymsp[-1].minor.yy387);
  134568. if( yymsp[-3].minor.yy4 ) yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_NOT, yymsp[-4].minor.yy314, 0);
  134569. }
  134570. break;
  134571. case 195: /* expr ::= expr in_op nm dbnm paren_exprlist */
  134572. {
  134573. SrcList *pSrc = sqlite3SrcListAppend(pParse->db, 0,&yymsp[-2].minor.yy0,&yymsp[-1].minor.yy0);
  134574. Select *pSelect = sqlite3SelectNew(pParse, 0,pSrc,0,0,0,0,0,0);
  134575. if( yymsp[0].minor.yy322 ) sqlite3SrcListFuncArgs(pParse, pSelect ? pSrc : 0, yymsp[0].minor.yy322);
  134576. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_IN, yymsp[-4].minor.yy314, 0);
  134577. sqlite3PExprAddSelect(pParse, yymsp[-4].minor.yy314, pSelect);
  134578. if( yymsp[-3].minor.yy4 ) yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_NOT, yymsp[-4].minor.yy314, 0);
  134579. }
  134580. break;
  134581. case 196: /* expr ::= EXISTS LP select RP */
  134582. {
  134583. Expr *p;
  134584. p = yymsp[-3].minor.yy314 = sqlite3PExpr(pParse, TK_EXISTS, 0, 0);
  134585. sqlite3PExprAddSelect(pParse, p, yymsp[-1].minor.yy387);
  134586. }
  134587. break;
  134588. case 197: /* expr ::= CASE case_operand case_exprlist case_else END */
  134589. {
  134590. yymsp[-4].minor.yy314 = sqlite3PExpr(pParse, TK_CASE, yymsp[-3].minor.yy314, 0);
  134591. if( yymsp[-4].minor.yy314 ){
  134592. yymsp[-4].minor.yy314->x.pList = yymsp[-1].minor.yy314 ? sqlite3ExprListAppend(pParse,yymsp[-2].minor.yy322,yymsp[-1].minor.yy314) : yymsp[-2].minor.yy322;
  134593. sqlite3ExprSetHeightAndFlags(pParse, yymsp[-4].minor.yy314);
  134594. }else{
  134595. sqlite3ExprListDelete(pParse->db, yymsp[-2].minor.yy322);
  134596. sqlite3ExprDelete(pParse->db, yymsp[-1].minor.yy314);
  134597. }
  134598. }
  134599. break;
  134600. case 198: /* case_exprlist ::= case_exprlist WHEN expr THEN expr */
  134601. {
  134602. yymsp[-4].minor.yy322 = sqlite3ExprListAppend(pParse,yymsp[-4].minor.yy322, yymsp[-2].minor.yy314);
  134603. yymsp[-4].minor.yy322 = sqlite3ExprListAppend(pParse,yymsp[-4].minor.yy322, yymsp[0].minor.yy314);
  134604. }
  134605. break;
  134606. case 199: /* case_exprlist ::= WHEN expr THEN expr */
  134607. {
  134608. yymsp[-3].minor.yy322 = sqlite3ExprListAppend(pParse,0, yymsp[-2].minor.yy314);
  134609. yymsp[-3].minor.yy322 = sqlite3ExprListAppend(pParse,yymsp[-3].minor.yy322, yymsp[0].minor.yy314);
  134610. }
  134611. break;
  134612. case 202: /* case_operand ::= expr */
  134613. {yymsp[0].minor.yy314 = yymsp[0].minor.yy314; /*A-overwrites-X*/}
  134614. break;
  134615. case 205: /* nexprlist ::= nexprlist COMMA expr */
  134616. {yymsp[-2].minor.yy322 = sqlite3ExprListAppend(pParse,yymsp[-2].minor.yy322,yymsp[0].minor.yy314);}
  134617. break;
  134618. case 206: /* nexprlist ::= expr */
  134619. {yymsp[0].minor.yy322 = sqlite3ExprListAppend(pParse,0,yymsp[0].minor.yy314); /*A-overwrites-Y*/}
  134620. break;
  134621. case 208: /* paren_exprlist ::= LP exprlist RP */
  134622. case 213: /* eidlist_opt ::= LP eidlist RP */ yytestcase(yyruleno==213);
  134623. {yymsp[-2].minor.yy322 = yymsp[-1].minor.yy322;}
  134624. break;
  134625. case 209: /* cmd ::= createkw uniqueflag INDEX ifnotexists nm dbnm ON nm LP sortlist RP where_opt */
  134626. {
  134627. sqlite3CreateIndex(pParse, &yymsp[-7].minor.yy0, &yymsp[-6].minor.yy0,
  134628. sqlite3SrcListAppend(pParse->db,0,&yymsp[-4].minor.yy0,0), yymsp[-2].minor.yy322, yymsp[-10].minor.yy4,
  134629. &yymsp[-11].minor.yy0, yymsp[0].minor.yy314, SQLITE_SO_ASC, yymsp[-8].minor.yy4, SQLITE_IDXTYPE_APPDEF);
  134630. }
  134631. break;
  134632. case 210: /* uniqueflag ::= UNIQUE */
  134633. case 250: /* raisetype ::= ABORT */ yytestcase(yyruleno==250);
  134634. {yymsp[0].minor.yy4 = OE_Abort;}
  134635. break;
  134636. case 211: /* uniqueflag ::= */
  134637. {yymsp[1].minor.yy4 = OE_None;}
  134638. break;
  134639. case 214: /* eidlist ::= eidlist COMMA nm collate sortorder */
  134640. {
  134641. yymsp[-4].minor.yy322 = parserAddExprIdListTerm(pParse, yymsp[-4].minor.yy322, &yymsp[-2].minor.yy0, yymsp[-1].minor.yy4, yymsp[0].minor.yy4);
  134642. }
  134643. break;
  134644. case 215: /* eidlist ::= nm collate sortorder */
  134645. {
  134646. yymsp[-2].minor.yy322 = parserAddExprIdListTerm(pParse, 0, &yymsp[-2].minor.yy0, yymsp[-1].minor.yy4, yymsp[0].minor.yy4); /*A-overwrites-Y*/
  134647. }
  134648. break;
  134649. case 218: /* cmd ::= DROP INDEX ifexists fullname */
  134650. {sqlite3DropIndex(pParse, yymsp[0].minor.yy259, yymsp[-1].minor.yy4);}
  134651. break;
  134652. case 219: /* cmd ::= VACUUM */
  134653. {sqlite3Vacuum(pParse,0);}
  134654. break;
  134655. case 220: /* cmd ::= VACUUM nm */
  134656. {sqlite3Vacuum(pParse,&yymsp[0].minor.yy0);}
  134657. break;
  134658. case 221: /* cmd ::= PRAGMA nm dbnm */
  134659. {sqlite3Pragma(pParse,&yymsp[-1].minor.yy0,&yymsp[0].minor.yy0,0,0);}
  134660. break;
  134661. case 222: /* cmd ::= PRAGMA nm dbnm EQ nmnum */
  134662. {sqlite3Pragma(pParse,&yymsp[-3].minor.yy0,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0,0);}
  134663. break;
  134664. case 223: /* cmd ::= PRAGMA nm dbnm LP nmnum RP */
  134665. {sqlite3Pragma(pParse,&yymsp[-4].minor.yy0,&yymsp[-3].minor.yy0,&yymsp[-1].minor.yy0,0);}
  134666. break;
  134667. case 224: /* cmd ::= PRAGMA nm dbnm EQ minus_num */
  134668. {sqlite3Pragma(pParse,&yymsp[-3].minor.yy0,&yymsp[-2].minor.yy0,&yymsp[0].minor.yy0,1);}
  134669. break;
  134670. case 225: /* cmd ::= PRAGMA nm dbnm LP minus_num RP */
  134671. {sqlite3Pragma(pParse,&yymsp[-4].minor.yy0,&yymsp[-3].minor.yy0,&yymsp[-1].minor.yy0,1);}
  134672. break;
  134673. case 228: /* cmd ::= createkw trigger_decl BEGIN trigger_cmd_list END */
  134674. {
  134675. Token all;
  134676. all.z = yymsp[-3].minor.yy0.z;
  134677. all.n = (int)(yymsp[0].minor.yy0.z - yymsp[-3].minor.yy0.z) + yymsp[0].minor.yy0.n;
  134678. sqlite3FinishTrigger(pParse, yymsp[-1].minor.yy203, &all);
  134679. }
  134680. break;
  134681. case 229: /* trigger_decl ::= temp TRIGGER ifnotexists nm dbnm trigger_time trigger_event ON fullname foreach_clause when_clause */
  134682. {
  134683. sqlite3BeginTrigger(pParse, &yymsp[-7].minor.yy0, &yymsp[-6].minor.yy0, yymsp[-5].minor.yy4, yymsp[-4].minor.yy90.a, yymsp[-4].minor.yy90.b, yymsp[-2].minor.yy259, yymsp[0].minor.yy314, yymsp[-10].minor.yy4, yymsp[-8].minor.yy4);
  134684. yymsp[-10].minor.yy0 = (yymsp[-6].minor.yy0.n==0?yymsp[-7].minor.yy0:yymsp[-6].minor.yy0); /*A-overwrites-T*/
  134685. }
  134686. break;
  134687. case 230: /* trigger_time ::= BEFORE|AFTER */
  134688. { yymsp[0].minor.yy4 = yymsp[0].major; /*A-overwrites-X*/ }
  134689. break;
  134690. case 231: /* trigger_time ::= INSTEAD OF */
  134691. { yymsp[-1].minor.yy4 = TK_INSTEAD;}
  134692. break;
  134693. case 232: /* trigger_time ::= */
  134694. { yymsp[1].minor.yy4 = TK_BEFORE; }
  134695. break;
  134696. case 233: /* trigger_event ::= DELETE|INSERT */
  134697. case 234: /* trigger_event ::= UPDATE */ yytestcase(yyruleno==234);
  134698. {yymsp[0].minor.yy90.a = yymsp[0].major; /*A-overwrites-X*/ yymsp[0].minor.yy90.b = 0;}
  134699. break;
  134700. case 235: /* trigger_event ::= UPDATE OF idlist */
  134701. {yymsp[-2].minor.yy90.a = TK_UPDATE; yymsp[-2].minor.yy90.b = yymsp[0].minor.yy384;}
  134702. break;
  134703. case 236: /* when_clause ::= */
  134704. case 255: /* key_opt ::= */ yytestcase(yyruleno==255);
  134705. { yymsp[1].minor.yy314 = 0; }
  134706. break;
  134707. case 237: /* when_clause ::= WHEN expr */
  134708. case 256: /* key_opt ::= KEY expr */ yytestcase(yyruleno==256);
  134709. { yymsp[-1].minor.yy314 = yymsp[0].minor.yy314; }
  134710. break;
  134711. case 238: /* trigger_cmd_list ::= trigger_cmd_list trigger_cmd SEMI */
  134712. {
  134713. assert( yymsp[-2].minor.yy203!=0 );
  134714. yymsp[-2].minor.yy203->pLast->pNext = yymsp[-1].minor.yy203;
  134715. yymsp[-2].minor.yy203->pLast = yymsp[-1].minor.yy203;
  134716. }
  134717. break;
  134718. case 239: /* trigger_cmd_list ::= trigger_cmd SEMI */
  134719. {
  134720. assert( yymsp[-1].minor.yy203!=0 );
  134721. yymsp[-1].minor.yy203->pLast = yymsp[-1].minor.yy203;
  134722. }
  134723. break;
  134724. case 240: /* trnm ::= nm DOT nm */
  134725. {
  134726. yymsp[-2].minor.yy0 = yymsp[0].minor.yy0;
  134727. sqlite3ErrorMsg(pParse,
  134728. "qualified table names are not allowed on INSERT, UPDATE, and DELETE "
  134729. "statements within triggers");
  134730. }
  134731. break;
  134732. case 241: /* tridxby ::= INDEXED BY nm */
  134733. {
  134734. sqlite3ErrorMsg(pParse,
  134735. "the INDEXED BY clause is not allowed on UPDATE or DELETE statements "
  134736. "within triggers");
  134737. }
  134738. break;
  134739. case 242: /* tridxby ::= NOT INDEXED */
  134740. {
  134741. sqlite3ErrorMsg(pParse,
  134742. "the NOT INDEXED clause is not allowed on UPDATE or DELETE statements "
  134743. "within triggers");
  134744. }
  134745. break;
  134746. case 243: /* trigger_cmd ::= UPDATE orconf trnm tridxby SET setlist where_opt scanpt */
  134747. {yylhsminor.yy203 = sqlite3TriggerUpdateStep(pParse->db, &yymsp[-5].minor.yy0, yymsp[-2].minor.yy322, yymsp[-1].minor.yy314, yymsp[-6].minor.yy4, yymsp[-7].minor.yy0.z, yymsp[0].minor.yy336);}
  134748. yymsp[-7].minor.yy203 = yylhsminor.yy203;
  134749. break;
  134750. case 244: /* trigger_cmd ::= scanpt insert_cmd INTO trnm idlist_opt select scanpt */
  134751. {yylhsminor.yy203 = sqlite3TriggerInsertStep(pParse->db,&yymsp[-3].minor.yy0,yymsp[-2].minor.yy384,yymsp[-1].minor.yy387,yymsp[-5].minor.yy4,yymsp[-6].minor.yy336,yymsp[0].minor.yy336);/*yylhsminor.yy203-overwrites-yymsp[-5].minor.yy4*/}
  134752. yymsp[-6].minor.yy203 = yylhsminor.yy203;
  134753. break;
  134754. case 245: /* trigger_cmd ::= DELETE FROM trnm tridxby where_opt scanpt */
  134755. {yylhsminor.yy203 = sqlite3TriggerDeleteStep(pParse->db, &yymsp[-3].minor.yy0, yymsp[-1].minor.yy314, yymsp[-5].minor.yy0.z, yymsp[0].minor.yy336);}
  134756. yymsp[-5].minor.yy203 = yylhsminor.yy203;
  134757. break;
  134758. case 246: /* trigger_cmd ::= scanpt select scanpt */
  134759. {yylhsminor.yy203 = sqlite3TriggerSelectStep(pParse->db, yymsp[-1].minor.yy387, yymsp[-2].minor.yy336, yymsp[0].minor.yy336); /*yylhsminor.yy203-overwrites-yymsp[-1].minor.yy387*/}
  134760. yymsp[-2].minor.yy203 = yylhsminor.yy203;
  134761. break;
  134762. case 247: /* expr ::= RAISE LP IGNORE RP */
  134763. {
  134764. yymsp[-3].minor.yy314 = sqlite3PExpr(pParse, TK_RAISE, 0, 0);
  134765. if( yymsp[-3].minor.yy314 ){
  134766. yymsp[-3].minor.yy314->affinity = OE_Ignore;
  134767. }
  134768. }
  134769. break;
  134770. case 248: /* expr ::= RAISE LP raisetype COMMA nm RP */
  134771. {
  134772. yymsp[-5].minor.yy314 = sqlite3ExprAlloc(pParse->db, TK_RAISE, &yymsp[-1].minor.yy0, 1);
  134773. if( yymsp[-5].minor.yy314 ) {
  134774. yymsp[-5].minor.yy314->affinity = (char)yymsp[-3].minor.yy4;
  134775. }
  134776. }
  134777. break;
  134778. case 249: /* raisetype ::= ROLLBACK */
  134779. {yymsp[0].minor.yy4 = OE_Rollback;}
  134780. break;
  134781. case 251: /* raisetype ::= FAIL */
  134782. {yymsp[0].minor.yy4 = OE_Fail;}
  134783. break;
  134784. case 252: /* cmd ::= DROP TRIGGER ifexists fullname */
  134785. {
  134786. sqlite3DropTrigger(pParse,yymsp[0].minor.yy259,yymsp[-1].minor.yy4);
  134787. }
  134788. break;
  134789. case 253: /* cmd ::= ATTACH database_kw_opt expr AS expr key_opt */
  134790. {
  134791. sqlite3Attach(pParse, yymsp[-3].minor.yy314, yymsp[-1].minor.yy314, yymsp[0].minor.yy314);
  134792. }
  134793. break;
  134794. case 254: /* cmd ::= DETACH database_kw_opt expr */
  134795. {
  134796. sqlite3Detach(pParse, yymsp[0].minor.yy314);
  134797. }
  134798. break;
  134799. case 257: /* cmd ::= REINDEX */
  134800. {sqlite3Reindex(pParse, 0, 0);}
  134801. break;
  134802. case 258: /* cmd ::= REINDEX nm dbnm */
  134803. {sqlite3Reindex(pParse, &yymsp[-1].minor.yy0, &yymsp[0].minor.yy0);}
  134804. break;
  134805. case 259: /* cmd ::= ANALYZE */
  134806. {sqlite3Analyze(pParse, 0, 0);}
  134807. break;
  134808. case 260: /* cmd ::= ANALYZE nm dbnm */
  134809. {sqlite3Analyze(pParse, &yymsp[-1].minor.yy0, &yymsp[0].minor.yy0);}
  134810. break;
  134811. case 261: /* cmd ::= ALTER TABLE fullname RENAME TO nm */
  134812. {
  134813. sqlite3AlterRenameTable(pParse,yymsp[-3].minor.yy259,&yymsp[0].minor.yy0);
  134814. }
  134815. break;
  134816. case 262: /* cmd ::= ALTER TABLE add_column_fullname ADD kwcolumn_opt columnname carglist */
  134817. {
  134818. yymsp[-1].minor.yy0.n = (int)(pParse->sLastToken.z-yymsp[-1].minor.yy0.z) + pParse->sLastToken.n;
  134819. sqlite3AlterFinishAddColumn(pParse, &yymsp[-1].minor.yy0);
  134820. }
  134821. break;
  134822. case 263: /* add_column_fullname ::= fullname */
  134823. {
  134824. disableLookaside(pParse);
  134825. sqlite3AlterBeginAddColumn(pParse, yymsp[0].minor.yy259);
  134826. }
  134827. break;
  134828. case 264: /* cmd ::= create_vtab */
  134829. {sqlite3VtabFinishParse(pParse,0);}
  134830. break;
  134831. case 265: /* cmd ::= create_vtab LP vtabarglist RP */
  134832. {sqlite3VtabFinishParse(pParse,&yymsp[0].minor.yy0);}
  134833. break;
  134834. case 266: /* create_vtab ::= createkw VIRTUAL TABLE ifnotexists nm dbnm USING nm */
  134835. {
  134836. sqlite3VtabBeginParse(pParse, &yymsp[-3].minor.yy0, &yymsp[-2].minor.yy0, &yymsp[0].minor.yy0, yymsp[-4].minor.yy4);
  134837. }
  134838. break;
  134839. case 267: /* vtabarg ::= */
  134840. {sqlite3VtabArgInit(pParse);}
  134841. break;
  134842. case 268: /* vtabargtoken ::= ANY */
  134843. case 269: /* vtabargtoken ::= lp anylist RP */ yytestcase(yyruleno==269);
  134844. case 270: /* lp ::= LP */ yytestcase(yyruleno==270);
  134845. {sqlite3VtabArgExtend(pParse,&yymsp[0].minor.yy0);}
  134846. break;
  134847. case 271: /* with ::= WITH wqlist */
  134848. case 272: /* with ::= WITH RECURSIVE wqlist */ yytestcase(yyruleno==272);
  134849. { sqlite3WithPush(pParse, yymsp[0].minor.yy451, 1); }
  134850. break;
  134851. case 273: /* wqlist ::= nm eidlist_opt AS LP select RP */
  134852. {
  134853. yymsp[-5].minor.yy451 = sqlite3WithAdd(pParse, 0, &yymsp[-5].minor.yy0, yymsp[-4].minor.yy322, yymsp[-1].minor.yy387); /*A-overwrites-X*/
  134854. }
  134855. break;
  134856. case 274: /* wqlist ::= wqlist COMMA nm eidlist_opt AS LP select RP */
  134857. {
  134858. yymsp[-7].minor.yy451 = sqlite3WithAdd(pParse, yymsp[-7].minor.yy451, &yymsp[-5].minor.yy0, yymsp[-4].minor.yy322, yymsp[-1].minor.yy387);
  134859. }
  134860. break;
  134861. default:
  134862. /* (275) input ::= cmdlist */ yytestcase(yyruleno==275);
  134863. /* (276) cmdlist ::= cmdlist ecmd */ yytestcase(yyruleno==276);
  134864. /* (277) cmdlist ::= ecmd (OPTIMIZED OUT) */ assert(yyruleno!=277);
  134865. /* (278) ecmd ::= SEMI */ yytestcase(yyruleno==278);
  134866. /* (279) ecmd ::= explain cmdx SEMI */ yytestcase(yyruleno==279);
  134867. /* (280) explain ::= */ yytestcase(yyruleno==280);
  134868. /* (281) trans_opt ::= */ yytestcase(yyruleno==281);
  134869. /* (282) trans_opt ::= TRANSACTION */ yytestcase(yyruleno==282);
  134870. /* (283) trans_opt ::= TRANSACTION nm */ yytestcase(yyruleno==283);
  134871. /* (284) savepoint_opt ::= SAVEPOINT */ yytestcase(yyruleno==284);
  134872. /* (285) savepoint_opt ::= */ yytestcase(yyruleno==285);
  134873. /* (286) cmd ::= create_table create_table_args */ yytestcase(yyruleno==286);
  134874. /* (287) columnlist ::= columnlist COMMA columnname carglist */ yytestcase(yyruleno==287);
  134875. /* (288) columnlist ::= columnname carglist */ yytestcase(yyruleno==288);
  134876. /* (289) nm ::= ID|INDEXED */ yytestcase(yyruleno==289);
  134877. /* (290) nm ::= STRING */ yytestcase(yyruleno==290);
  134878. /* (291) nm ::= JOIN_KW */ yytestcase(yyruleno==291);
  134879. /* (292) typetoken ::= typename */ yytestcase(yyruleno==292);
  134880. /* (293) typename ::= ID|STRING */ yytestcase(yyruleno==293);
  134881. /* (294) signed ::= plus_num (OPTIMIZED OUT) */ assert(yyruleno!=294);
  134882. /* (295) signed ::= minus_num (OPTIMIZED OUT) */ assert(yyruleno!=295);
  134883. /* (296) carglist ::= carglist ccons */ yytestcase(yyruleno==296);
  134884. /* (297) carglist ::= */ yytestcase(yyruleno==297);
  134885. /* (298) ccons ::= NULL onconf */ yytestcase(yyruleno==298);
  134886. /* (299) conslist_opt ::= COMMA conslist */ yytestcase(yyruleno==299);
  134887. /* (300) conslist ::= conslist tconscomma tcons */ yytestcase(yyruleno==300);
  134888. /* (301) conslist ::= tcons (OPTIMIZED OUT) */ assert(yyruleno!=301);
  134889. /* (302) tconscomma ::= */ yytestcase(yyruleno==302);
  134890. /* (303) defer_subclause_opt ::= defer_subclause (OPTIMIZED OUT) */ assert(yyruleno!=303);
  134891. /* (304) resolvetype ::= raisetype (OPTIMIZED OUT) */ assert(yyruleno!=304);
  134892. /* (305) selectnowith ::= oneselect (OPTIMIZED OUT) */ assert(yyruleno!=305);
  134893. /* (306) oneselect ::= values */ yytestcase(yyruleno==306);
  134894. /* (307) sclp ::= selcollist COMMA */ yytestcase(yyruleno==307);
  134895. /* (308) as ::= ID|STRING */ yytestcase(yyruleno==308);
  134896. /* (309) expr ::= term (OPTIMIZED OUT) */ assert(yyruleno!=309);
  134897. /* (310) likeop ::= LIKE_KW|MATCH */ yytestcase(yyruleno==310);
  134898. /* (311) exprlist ::= nexprlist */ yytestcase(yyruleno==311);
  134899. /* (312) nmnum ::= plus_num (OPTIMIZED OUT) */ assert(yyruleno!=312);
  134900. /* (313) nmnum ::= nm (OPTIMIZED OUT) */ assert(yyruleno!=313);
  134901. /* (314) nmnum ::= ON */ yytestcase(yyruleno==314);
  134902. /* (315) nmnum ::= DELETE */ yytestcase(yyruleno==315);
  134903. /* (316) nmnum ::= DEFAULT */ yytestcase(yyruleno==316);
  134904. /* (317) plus_num ::= INTEGER|FLOAT */ yytestcase(yyruleno==317);
  134905. /* (318) foreach_clause ::= */ yytestcase(yyruleno==318);
  134906. /* (319) foreach_clause ::= FOR EACH ROW */ yytestcase(yyruleno==319);
  134907. /* (320) trnm ::= nm */ yytestcase(yyruleno==320);
  134908. /* (321) tridxby ::= */ yytestcase(yyruleno==321);
  134909. /* (322) database_kw_opt ::= DATABASE */ yytestcase(yyruleno==322);
  134910. /* (323) database_kw_opt ::= */ yytestcase(yyruleno==323);
  134911. /* (324) kwcolumn_opt ::= */ yytestcase(yyruleno==324);
  134912. /* (325) kwcolumn_opt ::= COLUMNKW */ yytestcase(yyruleno==325);
  134913. /* (326) vtabarglist ::= vtabarg */ yytestcase(yyruleno==326);
  134914. /* (327) vtabarglist ::= vtabarglist COMMA vtabarg */ yytestcase(yyruleno==327);
  134915. /* (328) vtabarg ::= vtabarg vtabargtoken */ yytestcase(yyruleno==328);
  134916. /* (329) anylist ::= */ yytestcase(yyruleno==329);
  134917. /* (330) anylist ::= anylist LP anylist RP */ yytestcase(yyruleno==330);
  134918. /* (331) anylist ::= anylist ANY */ yytestcase(yyruleno==331);
  134919. /* (332) with ::= */ yytestcase(yyruleno==332);
  134920. break;
  134921. /********** End reduce actions ************************************************/
  134922. };
  134923. assert( yyruleno<sizeof(yyRuleInfo)/sizeof(yyRuleInfo[0]) );
  134924. yygoto = yyRuleInfo[yyruleno].lhs;
  134925. yysize = yyRuleInfo[yyruleno].nrhs;
  134926. yyact = yy_find_reduce_action(yymsp[yysize].stateno,(YYCODETYPE)yygoto);
  134927. /* There are no SHIFTREDUCE actions on nonterminals because the table
  134928. ** generator has simplified them to pure REDUCE actions. */
  134929. assert( !(yyact>YY_MAX_SHIFT && yyact<=YY_MAX_SHIFTREDUCE) );
  134930. /* It is not possible for a REDUCE to be followed by an error */
  134931. assert( yyact!=YY_ERROR_ACTION );
  134932. yymsp += yysize+1;
  134933. yypParser->yytos = yymsp;
  134934. yymsp->stateno = (YYACTIONTYPE)yyact;
  134935. yymsp->major = (YYCODETYPE)yygoto;
  134936. yyTraceShift(yypParser, yyact, "... then shift");
  134937. }
  134938. /*
  134939. ** The following code executes when the parse fails
  134940. */
  134941. #ifndef YYNOERRORRECOVERY
  134942. static void yy_parse_failed(
  134943. yyParser *yypParser /* The parser */
  134944. ){
  134945. sqlite3ParserARG_FETCH;
  134946. #ifndef NDEBUG
  134947. if( yyTraceFILE ){
  134948. fprintf(yyTraceFILE,"%sFail!\n",yyTracePrompt);
  134949. }
  134950. #endif
  134951. while( yypParser->yytos>yypParser->yystack ) yy_pop_parser_stack(yypParser);
  134952. /* Here code is inserted which will be executed whenever the
  134953. ** parser fails */
  134954. /************ Begin %parse_failure code ***************************************/
  134955. /************ End %parse_failure code *****************************************/
  134956. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  134957. }
  134958. #endif /* YYNOERRORRECOVERY */
  134959. /*
  134960. ** The following code executes when a syntax error first occurs.
  134961. */
  134962. static void yy_syntax_error(
  134963. yyParser *yypParser, /* The parser */
  134964. int yymajor, /* The major type of the error token */
  134965. sqlite3ParserTOKENTYPE yyminor /* The minor type of the error token */
  134966. ){
  134967. sqlite3ParserARG_FETCH;
  134968. #define TOKEN yyminor
  134969. /************ Begin %syntax_error code ****************************************/
  134970. UNUSED_PARAMETER(yymajor); /* Silence some compiler warnings */
  134971. if( TOKEN.z[0] ){
  134972. sqlite3ErrorMsg(pParse, "near \"%T\": syntax error", &TOKEN);
  134973. }else{
  134974. sqlite3ErrorMsg(pParse, "incomplete input");
  134975. }
  134976. /************ End %syntax_error code ******************************************/
  134977. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  134978. }
  134979. /*
  134980. ** The following is executed when the parser accepts
  134981. */
  134982. static void yy_accept(
  134983. yyParser *yypParser /* The parser */
  134984. ){
  134985. sqlite3ParserARG_FETCH;
  134986. #ifndef NDEBUG
  134987. if( yyTraceFILE ){
  134988. fprintf(yyTraceFILE,"%sAccept!\n",yyTracePrompt);
  134989. }
  134990. #endif
  134991. #ifndef YYNOERRORRECOVERY
  134992. yypParser->yyerrcnt = -1;
  134993. #endif
  134994. assert( yypParser->yytos==yypParser->yystack );
  134995. /* Here code is inserted which will be executed whenever the
  134996. ** parser accepts */
  134997. /*********** Begin %parse_accept code *****************************************/
  134998. /*********** End %parse_accept code *******************************************/
  134999. sqlite3ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  135000. }
  135001. /* The main parser program.
  135002. ** The first argument is a pointer to a structure obtained from
  135003. ** "sqlite3ParserAlloc" which describes the current state of the parser.
  135004. ** The second argument is the major token number. The third is
  135005. ** the minor token. The fourth optional argument is whatever the
  135006. ** user wants (and specified in the grammar) and is available for
  135007. ** use by the action routines.
  135008. **
  135009. ** Inputs:
  135010. ** <ul>
  135011. ** <li> A pointer to the parser (an opaque structure.)
  135012. ** <li> The major token number.
  135013. ** <li> The minor token number.
  135014. ** <li> An option argument of a grammar-specified type.
  135015. ** </ul>
  135016. **
  135017. ** Outputs:
  135018. ** None.
  135019. */
  135020. SQLITE_PRIVATE void sqlite3Parser(
  135021. void *yyp, /* The parser */
  135022. int yymajor, /* The major token code number */
  135023. sqlite3ParserTOKENTYPE yyminor /* The value for the token */
  135024. sqlite3ParserARG_PDECL /* Optional %extra_argument parameter */
  135025. ){
  135026. YYMINORTYPE yyminorunion;
  135027. unsigned int yyact; /* The parser action. */
  135028. #if !defined(YYERRORSYMBOL) && !defined(YYNOERRORRECOVERY)
  135029. int yyendofinput; /* True if we are at the end of input */
  135030. #endif
  135031. #ifdef YYERRORSYMBOL
  135032. int yyerrorhit = 0; /* True if yymajor has invoked an error */
  135033. #endif
  135034. yyParser *yypParser; /* The parser */
  135035. yypParser = (yyParser*)yyp;
  135036. assert( yypParser->yytos!=0 );
  135037. #if !defined(YYERRORSYMBOL) && !defined(YYNOERRORRECOVERY)
  135038. yyendofinput = (yymajor==0);
  135039. #endif
  135040. sqlite3ParserARG_STORE;
  135041. #ifndef NDEBUG
  135042. if( yyTraceFILE ){
  135043. int stateno = yypParser->yytos->stateno;
  135044. if( stateno < YY_MIN_REDUCE ){
  135045. fprintf(yyTraceFILE,"%sInput '%s' in state %d\n",
  135046. yyTracePrompt,yyTokenName[yymajor],stateno);
  135047. }else{
  135048. fprintf(yyTraceFILE,"%sInput '%s' with pending reduce %d\n",
  135049. yyTracePrompt,yyTokenName[yymajor],stateno-YY_MIN_REDUCE);
  135050. }
  135051. }
  135052. #endif
  135053. do{
  135054. yyact = yy_find_shift_action(yypParser,(YYCODETYPE)yymajor);
  135055. if( yyact >= YY_MIN_REDUCE ){
  135056. yy_reduce(yypParser,yyact-YY_MIN_REDUCE,yymajor,yyminor);
  135057. }else if( yyact <= YY_MAX_SHIFTREDUCE ){
  135058. yy_shift(yypParser,yyact,yymajor,yyminor);
  135059. #ifndef YYNOERRORRECOVERY
  135060. yypParser->yyerrcnt--;
  135061. #endif
  135062. yymajor = YYNOCODE;
  135063. }else if( yyact==YY_ACCEPT_ACTION ){
  135064. yypParser->yytos--;
  135065. yy_accept(yypParser);
  135066. return;
  135067. }else{
  135068. assert( yyact == YY_ERROR_ACTION );
  135069. yyminorunion.yy0 = yyminor;
  135070. #ifdef YYERRORSYMBOL
  135071. int yymx;
  135072. #endif
  135073. #ifndef NDEBUG
  135074. if( yyTraceFILE ){
  135075. fprintf(yyTraceFILE,"%sSyntax Error!\n",yyTracePrompt);
  135076. }
  135077. #endif
  135078. #ifdef YYERRORSYMBOL
  135079. /* A syntax error has occurred.
  135080. ** The response to an error depends upon whether or not the
  135081. ** grammar defines an error token "ERROR".
  135082. **
  135083. ** This is what we do if the grammar does define ERROR:
  135084. **
  135085. ** * Call the %syntax_error function.
  135086. **
  135087. ** * Begin popping the stack until we enter a state where
  135088. ** it is legal to shift the error symbol, then shift
  135089. ** the error symbol.
  135090. **
  135091. ** * Set the error count to three.
  135092. **
  135093. ** * Begin accepting and shifting new tokens. No new error
  135094. ** processing will occur until three tokens have been
  135095. ** shifted successfully.
  135096. **
  135097. */
  135098. if( yypParser->yyerrcnt<0 ){
  135099. yy_syntax_error(yypParser,yymajor,yyminor);
  135100. }
  135101. yymx = yypParser->yytos->major;
  135102. if( yymx==YYERRORSYMBOL || yyerrorhit ){
  135103. #ifndef NDEBUG
  135104. if( yyTraceFILE ){
  135105. fprintf(yyTraceFILE,"%sDiscard input token %s\n",
  135106. yyTracePrompt,yyTokenName[yymajor]);
  135107. }
  135108. #endif
  135109. yy_destructor(yypParser, (YYCODETYPE)yymajor, &yyminorunion);
  135110. yymajor = YYNOCODE;
  135111. }else{
  135112. while( yypParser->yytos >= yypParser->yystack
  135113. && yymx != YYERRORSYMBOL
  135114. && (yyact = yy_find_reduce_action(
  135115. yypParser->yytos->stateno,
  135116. YYERRORSYMBOL)) >= YY_MIN_REDUCE
  135117. ){
  135118. yy_pop_parser_stack(yypParser);
  135119. }
  135120. if( yypParser->yytos < yypParser->yystack || yymajor==0 ){
  135121. yy_destructor(yypParser,(YYCODETYPE)yymajor,&yyminorunion);
  135122. yy_parse_failed(yypParser);
  135123. #ifndef YYNOERRORRECOVERY
  135124. yypParser->yyerrcnt = -1;
  135125. #endif
  135126. yymajor = YYNOCODE;
  135127. }else if( yymx!=YYERRORSYMBOL ){
  135128. yy_shift(yypParser,yyact,YYERRORSYMBOL,yyminor);
  135129. }
  135130. }
  135131. yypParser->yyerrcnt = 3;
  135132. yyerrorhit = 1;
  135133. #elif defined(YYNOERRORRECOVERY)
  135134. /* If the YYNOERRORRECOVERY macro is defined, then do not attempt to
  135135. ** do any kind of error recovery. Instead, simply invoke the syntax
  135136. ** error routine and continue going as if nothing had happened.
  135137. **
  135138. ** Applications can set this macro (for example inside %include) if
  135139. ** they intend to abandon the parse upon the first syntax error seen.
  135140. */
  135141. yy_syntax_error(yypParser,yymajor, yyminor);
  135142. yy_destructor(yypParser,(YYCODETYPE)yymajor,&yyminorunion);
  135143. yymajor = YYNOCODE;
  135144. #else /* YYERRORSYMBOL is not defined */
  135145. /* This is what we do if the grammar does not define ERROR:
  135146. **
  135147. ** * Report an error message, and throw away the input token.
  135148. **
  135149. ** * If the input token is $, then fail the parse.
  135150. **
  135151. ** As before, subsequent error messages are suppressed until
  135152. ** three input tokens have been successfully shifted.
  135153. */
  135154. if( yypParser->yyerrcnt<=0 ){
  135155. yy_syntax_error(yypParser,yymajor, yyminor);
  135156. }
  135157. yypParser->yyerrcnt = 3;
  135158. yy_destructor(yypParser,(YYCODETYPE)yymajor,&yyminorunion);
  135159. if( yyendofinput ){
  135160. yy_parse_failed(yypParser);
  135161. #ifndef YYNOERRORRECOVERY
  135162. yypParser->yyerrcnt = -1;
  135163. #endif
  135164. }
  135165. yymajor = YYNOCODE;
  135166. #endif
  135167. }
  135168. }while( yymajor!=YYNOCODE && yypParser->yytos>yypParser->yystack );
  135169. #ifndef NDEBUG
  135170. if( yyTraceFILE ){
  135171. yyStackEntry *i;
  135172. char cDiv = '[';
  135173. fprintf(yyTraceFILE,"%sReturn. Stack=",yyTracePrompt);
  135174. for(i=&yypParser->yystack[1]; i<=yypParser->yytos; i++){
  135175. fprintf(yyTraceFILE,"%c%s", cDiv, yyTokenName[i->major]);
  135176. cDiv = ' ';
  135177. }
  135178. fprintf(yyTraceFILE,"]\n");
  135179. }
  135180. #endif
  135181. return;
  135182. }
  135183. /************** End of parse.c ***********************************************/
  135184. /************** Begin file tokenize.c ****************************************/
  135185. /*
  135186. ** 2001 September 15
  135187. **
  135188. ** The author disclaims copyright to this source code. In place of
  135189. ** a legal notice, here is a blessing:
  135190. **
  135191. ** May you do good and not evil.
  135192. ** May you find forgiveness for yourself and forgive others.
  135193. ** May you share freely, never taking more than you give.
  135194. **
  135195. *************************************************************************
  135196. ** An tokenizer for SQL
  135197. **
  135198. ** This file contains C code that splits an SQL input string up into
  135199. ** individual tokens and sends those tokens one-by-one over to the
  135200. ** parser for analysis.
  135201. */
  135202. /* #include "sqliteInt.h" */
  135203. /* #include <stdlib.h> */
  135204. /* Character classes for tokenizing
  135205. **
  135206. ** In the sqlite3GetToken() function, a switch() on aiClass[c] is implemented
  135207. ** using a lookup table, whereas a switch() directly on c uses a binary search.
  135208. ** The lookup table is much faster. To maximize speed, and to ensure that
  135209. ** a lookup table is used, all of the classes need to be small integers and
  135210. ** all of them need to be used within the switch.
  135211. */
  135212. #define CC_X 0 /* The letter 'x', or start of BLOB literal */
  135213. #define CC_KYWD 1 /* Alphabetics or '_'. Usable in a keyword */
  135214. #define CC_ID 2 /* unicode characters usable in IDs */
  135215. #define CC_DIGIT 3 /* Digits */
  135216. #define CC_DOLLAR 4 /* '$' */
  135217. #define CC_VARALPHA 5 /* '@', '#', ':'. Alphabetic SQL variables */
  135218. #define CC_VARNUM 6 /* '?'. Numeric SQL variables */
  135219. #define CC_SPACE 7 /* Space characters */
  135220. #define CC_QUOTE 8 /* '"', '\'', or '`'. String literals, quoted ids */
  135221. #define CC_QUOTE2 9 /* '['. [...] style quoted ids */
  135222. #define CC_PIPE 10 /* '|'. Bitwise OR or concatenate */
  135223. #define CC_MINUS 11 /* '-'. Minus or SQL-style comment */
  135224. #define CC_LT 12 /* '<'. Part of < or <= or <> */
  135225. #define CC_GT 13 /* '>'. Part of > or >= */
  135226. #define CC_EQ 14 /* '='. Part of = or == */
  135227. #define CC_BANG 15 /* '!'. Part of != */
  135228. #define CC_SLASH 16 /* '/'. / or c-style comment */
  135229. #define CC_LP 17 /* '(' */
  135230. #define CC_RP 18 /* ')' */
  135231. #define CC_SEMI 19 /* ';' */
  135232. #define CC_PLUS 20 /* '+' */
  135233. #define CC_STAR 21 /* '*' */
  135234. #define CC_PERCENT 22 /* '%' */
  135235. #define CC_COMMA 23 /* ',' */
  135236. #define CC_AND 24 /* '&' */
  135237. #define CC_TILDA 25 /* '~' */
  135238. #define CC_DOT 26 /* '.' */
  135239. #define CC_ILLEGAL 27 /* Illegal character */
  135240. static const unsigned char aiClass[] = {
  135241. #ifdef SQLITE_ASCII
  135242. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xa xb xc xd xe xf */
  135243. /* 0x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 7, 7, 27, 7, 7, 27, 27,
  135244. /* 1x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  135245. /* 2x */ 7, 15, 8, 5, 4, 22, 24, 8, 17, 18, 21, 20, 23, 11, 26, 16,
  135246. /* 3x */ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 5, 19, 12, 14, 13, 6,
  135247. /* 4x */ 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  135248. /* 5x */ 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 9, 27, 27, 27, 1,
  135249. /* 6x */ 8, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
  135250. /* 7x */ 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 27, 10, 27, 25, 27,
  135251. /* 8x */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135252. /* 9x */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135253. /* Ax */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135254. /* Bx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135255. /* Cx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135256. /* Dx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135257. /* Ex */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
  135258. /* Fx */ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2
  135259. #endif
  135260. #ifdef SQLITE_EBCDIC
  135261. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xa xb xc xd xe xf */
  135262. /* 0x */ 27, 27, 27, 27, 27, 7, 27, 27, 27, 27, 27, 27, 7, 7, 27, 27,
  135263. /* 1x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  135264. /* 2x */ 27, 27, 27, 27, 27, 7, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  135265. /* 3x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
  135266. /* 4x */ 7, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 26, 12, 17, 20, 10,
  135267. /* 5x */ 24, 27, 27, 27, 27, 27, 27, 27, 27, 27, 15, 4, 21, 18, 19, 27,
  135268. /* 6x */ 11, 16, 27, 27, 27, 27, 27, 27, 27, 27, 27, 23, 22, 1, 13, 6,
  135269. /* 7x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 8, 5, 5, 5, 8, 14, 8,
  135270. /* 8x */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  135271. /* 9x */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  135272. /* Ax */ 27, 25, 1, 1, 1, 1, 1, 0, 1, 1, 27, 27, 27, 27, 27, 27,
  135273. /* Bx */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 9, 27, 27, 27, 27, 27,
  135274. /* Cx */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  135275. /* Dx */ 27, 1, 1, 1, 1, 1, 1, 1, 1, 1, 27, 27, 27, 27, 27, 27,
  135276. /* Ex */ 27, 27, 1, 1, 1, 1, 1, 0, 1, 1, 27, 27, 27, 27, 27, 27,
  135277. /* Fx */ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 27, 27, 27, 27, 27, 27,
  135278. #endif
  135279. };
  135280. /*
  135281. ** The charMap() macro maps alphabetic characters (only) into their
  135282. ** lower-case ASCII equivalent. On ASCII machines, this is just
  135283. ** an upper-to-lower case map. On EBCDIC machines we also need
  135284. ** to adjust the encoding. The mapping is only valid for alphabetics
  135285. ** which are the only characters for which this feature is used.
  135286. **
  135287. ** Used by keywordhash.h
  135288. */
  135289. #ifdef SQLITE_ASCII
  135290. # define charMap(X) sqlite3UpperToLower[(unsigned char)X]
  135291. #endif
  135292. #ifdef SQLITE_EBCDIC
  135293. # define charMap(X) ebcdicToAscii[(unsigned char)X]
  135294. const unsigned char ebcdicToAscii[] = {
  135295. /* 0 1 2 3 4 5 6 7 8 9 A B C D E F */
  135296. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x */
  135297. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 1x */
  135298. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 2x */
  135299. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 3x */
  135300. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 4x */
  135301. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 5x */
  135302. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 95, 0, 0, /* 6x */
  135303. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 7x */
  135304. 0, 97, 98, 99,100,101,102,103,104,105, 0, 0, 0, 0, 0, 0, /* 8x */
  135305. 0,106,107,108,109,110,111,112,113,114, 0, 0, 0, 0, 0, 0, /* 9x */
  135306. 0, 0,115,116,117,118,119,120,121,122, 0, 0, 0, 0, 0, 0, /* Ax */
  135307. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Bx */
  135308. 0, 97, 98, 99,100,101,102,103,104,105, 0, 0, 0, 0, 0, 0, /* Cx */
  135309. 0,106,107,108,109,110,111,112,113,114, 0, 0, 0, 0, 0, 0, /* Dx */
  135310. 0, 0,115,116,117,118,119,120,121,122, 0, 0, 0, 0, 0, 0, /* Ex */
  135311. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Fx */
  135312. };
  135313. #endif
  135314. /*
  135315. ** The sqlite3KeywordCode function looks up an identifier to determine if
  135316. ** it is a keyword. If it is a keyword, the token code of that keyword is
  135317. ** returned. If the input is not a keyword, TK_ID is returned.
  135318. **
  135319. ** The implementation of this routine was generated by a program,
  135320. ** mkkeywordhash.c, located in the tool subdirectory of the distribution.
  135321. ** The output of the mkkeywordhash.c program is written into a file
  135322. ** named keywordhash.h and then included into this source file by
  135323. ** the #include below.
  135324. */
  135325. /************** Include keywordhash.h in the middle of tokenize.c ************/
  135326. /************** Begin file keywordhash.h *************************************/
  135327. /***** This file contains automatically generated code ******
  135328. **
  135329. ** The code in this file has been automatically generated by
  135330. **
  135331. ** sqlite/tool/mkkeywordhash.c
  135332. **
  135333. ** The code in this file implements a function that determines whether
  135334. ** or not a given identifier is really an SQL keyword. The same thing
  135335. ** might be implemented more directly using a hand-written hash table.
  135336. ** But by using this automatically generated code, the size of the code
  135337. ** is substantially reduced. This is important for embedded applications
  135338. ** on platforms with limited memory.
  135339. */
  135340. /* Hash score: 182 */
  135341. /* zKWText[] encodes 834 bytes of keyword text in 554 bytes */
  135342. /* REINDEXEDESCAPEACHECKEYBEFOREIGNOREGEXPLAINSTEADDATABASELECT */
  135343. /* ABLEFTHENDEFERRABLELSEXCEPTRANSACTIONATURALTERAISEXCLUSIVE */
  135344. /* XISTSAVEPOINTERSECTRIGGEREFERENCESCONSTRAINTOFFSETEMPORARY */
  135345. /* UNIQUERYWITHOUTERELEASEATTACHAVINGROUPDATEBEGINNERECURSIVE */
  135346. /* BETWEENOTNULLIKECASCADELETECASECOLLATECREATECURRENT_DATEDETACH */
  135347. /* IMMEDIATEJOINSERTMATCHPLANALYZEPRAGMABORTVALUESVIRTUALIMITWHEN */
  135348. /* WHERENAMEAFTEREPLACEANDEFAULTAUTOINCREMENTCASTCOLUMNCOMMIT */
  135349. /* CONFLICTCROSSCURRENT_TIMESTAMPRIMARYDEFERREDISTINCTDROPFAIL */
  135350. /* FROMFULLGLOBYIFISNULLORDERESTRICTRIGHTROLLBACKROWUNIONUSING */
  135351. /* VACUUMVIEWINITIALLY */
  135352. static const char zKWText[553] = {
  135353. 'R','E','I','N','D','E','X','E','D','E','S','C','A','P','E','A','C','H',
  135354. 'E','C','K','E','Y','B','E','F','O','R','E','I','G','N','O','R','E','G',
  135355. 'E','X','P','L','A','I','N','S','T','E','A','D','D','A','T','A','B','A',
  135356. 'S','E','L','E','C','T','A','B','L','E','F','T','H','E','N','D','E','F',
  135357. 'E','R','R','A','B','L','E','L','S','E','X','C','E','P','T','R','A','N',
  135358. 'S','A','C','T','I','O','N','A','T','U','R','A','L','T','E','R','A','I',
  135359. 'S','E','X','C','L','U','S','I','V','E','X','I','S','T','S','A','V','E',
  135360. 'P','O','I','N','T','E','R','S','E','C','T','R','I','G','G','E','R','E',
  135361. 'F','E','R','E','N','C','E','S','C','O','N','S','T','R','A','I','N','T',
  135362. 'O','F','F','S','E','T','E','M','P','O','R','A','R','Y','U','N','I','Q',
  135363. 'U','E','R','Y','W','I','T','H','O','U','T','E','R','E','L','E','A','S',
  135364. 'E','A','T','T','A','C','H','A','V','I','N','G','R','O','U','P','D','A',
  135365. 'T','E','B','E','G','I','N','N','E','R','E','C','U','R','S','I','V','E',
  135366. 'B','E','T','W','E','E','N','O','T','N','U','L','L','I','K','E','C','A',
  135367. 'S','C','A','D','E','L','E','T','E','C','A','S','E','C','O','L','L','A',
  135368. 'T','E','C','R','E','A','T','E','C','U','R','R','E','N','T','_','D','A',
  135369. 'T','E','D','E','T','A','C','H','I','M','M','E','D','I','A','T','E','J',
  135370. 'O','I','N','S','E','R','T','M','A','T','C','H','P','L','A','N','A','L',
  135371. 'Y','Z','E','P','R','A','G','M','A','B','O','R','T','V','A','L','U','E',
  135372. 'S','V','I','R','T','U','A','L','I','M','I','T','W','H','E','N','W','H',
  135373. 'E','R','E','N','A','M','E','A','F','T','E','R','E','P','L','A','C','E',
  135374. 'A','N','D','E','F','A','U','L','T','A','U','T','O','I','N','C','R','E',
  135375. 'M','E','N','T','C','A','S','T','C','O','L','U','M','N','C','O','M','M',
  135376. 'I','T','C','O','N','F','L','I','C','T','C','R','O','S','S','C','U','R',
  135377. 'R','E','N','T','_','T','I','M','E','S','T','A','M','P','R','I','M','A',
  135378. 'R','Y','D','E','F','E','R','R','E','D','I','S','T','I','N','C','T','D',
  135379. 'R','O','P','F','A','I','L','F','R','O','M','F','U','L','L','G','L','O',
  135380. 'B','Y','I','F','I','S','N','U','L','L','O','R','D','E','R','E','S','T',
  135381. 'R','I','C','T','R','I','G','H','T','R','O','L','L','B','A','C','K','R',
  135382. 'O','W','U','N','I','O','N','U','S','I','N','G','V','A','C','U','U','M',
  135383. 'V','I','E','W','I','N','I','T','I','A','L','L','Y',
  135384. };
  135385. /* aKWHash[i] is the hash value for the i-th keyword */
  135386. static const unsigned char aKWHash[127] = {
  135387. 76, 105, 117, 74, 0, 45, 0, 0, 82, 0, 77, 0, 0,
  135388. 42, 12, 78, 15, 0, 116, 85, 54, 112, 0, 19, 0, 0,
  135389. 121, 0, 119, 115, 0, 22, 93, 0, 9, 0, 0, 70, 71,
  135390. 0, 69, 6, 0, 48, 90, 102, 0, 118, 101, 0, 0, 44,
  135391. 0, 103, 24, 0, 17, 0, 122, 53, 23, 0, 5, 110, 25,
  135392. 96, 0, 0, 124, 106, 60, 123, 57, 28, 55, 0, 91, 0,
  135393. 100, 26, 0, 99, 0, 0, 0, 95, 92, 97, 88, 109, 14,
  135394. 39, 108, 0, 81, 0, 18, 89, 111, 32, 0, 120, 80, 113,
  135395. 62, 46, 84, 0, 0, 94, 40, 59, 114, 0, 36, 0, 0,
  135396. 29, 0, 86, 63, 64, 0, 20, 61, 0, 56,
  135397. };
  135398. /* aKWNext[] forms the hash collision chain. If aKWHash[i]==0
  135399. ** then the i-th keyword has no more hash collisions. Otherwise,
  135400. ** the next keyword with the same hash is aKWHash[i]-1. */
  135401. static const unsigned char aKWNext[124] = {
  135402. 0, 0, 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0,
  135403. 0, 2, 0, 0, 0, 0, 0, 0, 13, 0, 0, 0, 0,
  135404. 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  135405. 0, 0, 0, 0, 33, 0, 21, 0, 0, 0, 0, 0, 50,
  135406. 0, 43, 3, 47, 0, 0, 0, 0, 30, 0, 58, 0, 38,
  135407. 0, 0, 0, 1, 66, 0, 0, 67, 0, 41, 0, 0, 0,
  135408. 0, 0, 0, 49, 65, 0, 0, 0, 0, 31, 52, 16, 34,
  135409. 10, 0, 0, 0, 0, 0, 0, 0, 11, 72, 79, 0, 8,
  135410. 0, 104, 98, 0, 107, 0, 87, 0, 75, 51, 0, 27, 37,
  135411. 73, 83, 0, 35, 68, 0, 0,
  135412. };
  135413. /* aKWLen[i] is the length (in bytes) of the i-th keyword */
  135414. static const unsigned char aKWLen[124] = {
  135415. 7, 7, 5, 4, 6, 4, 5, 3, 6, 7, 3, 6, 6,
  135416. 7, 7, 3, 8, 2, 6, 5, 4, 4, 3, 10, 4, 6,
  135417. 11, 6, 2, 7, 5, 5, 9, 6, 9, 9, 7, 10, 10,
  135418. 4, 6, 2, 3, 9, 4, 2, 6, 5, 7, 4, 5, 7,
  135419. 6, 6, 5, 6, 5, 5, 9, 7, 7, 3, 2, 4, 4,
  135420. 7, 3, 6, 4, 7, 6, 12, 6, 9, 4, 6, 5, 4,
  135421. 7, 6, 5, 6, 7, 5, 4, 5, 6, 5, 7, 3, 7,
  135422. 13, 2, 2, 4, 6, 6, 8, 5, 17, 12, 7, 8, 8,
  135423. 2, 4, 4, 4, 4, 4, 2, 2, 6, 5, 8, 5, 8,
  135424. 3, 5, 5, 6, 4, 9, 3,
  135425. };
  135426. /* aKWOffset[i] is the index into zKWText[] of the start of
  135427. ** the text for the i-th keyword. */
  135428. static const unsigned short int aKWOffset[124] = {
  135429. 0, 2, 2, 8, 9, 14, 16, 20, 23, 25, 25, 29, 33,
  135430. 36, 41, 46, 48, 53, 54, 59, 62, 65, 67, 69, 78, 81,
  135431. 86, 91, 95, 96, 101, 105, 109, 117, 122, 128, 136, 142, 152,
  135432. 159, 162, 162, 165, 167, 167, 171, 176, 179, 184, 184, 188, 192,
  135433. 199, 204, 209, 212, 218, 221, 225, 234, 240, 240, 240, 243, 246,
  135434. 250, 251, 255, 261, 265, 272, 278, 290, 296, 305, 307, 313, 318,
  135435. 320, 327, 332, 337, 343, 349, 354, 358, 361, 367, 371, 378, 380,
  135436. 387, 389, 391, 400, 404, 410, 416, 424, 429, 429, 445, 452, 459,
  135437. 460, 467, 471, 475, 479, 483, 486, 488, 490, 496, 500, 508, 513,
  135438. 521, 524, 529, 534, 540, 544, 549,
  135439. };
  135440. /* aKWCode[i] is the parser symbol code for the i-th keyword */
  135441. static const unsigned char aKWCode[124] = {
  135442. TK_REINDEX, TK_INDEXED, TK_INDEX, TK_DESC, TK_ESCAPE,
  135443. TK_EACH, TK_CHECK, TK_KEY, TK_BEFORE, TK_FOREIGN,
  135444. TK_FOR, TK_IGNORE, TK_LIKE_KW, TK_EXPLAIN, TK_INSTEAD,
  135445. TK_ADD, TK_DATABASE, TK_AS, TK_SELECT, TK_TABLE,
  135446. TK_JOIN_KW, TK_THEN, TK_END, TK_DEFERRABLE, TK_ELSE,
  135447. TK_EXCEPT, TK_TRANSACTION,TK_ACTION, TK_ON, TK_JOIN_KW,
  135448. TK_ALTER, TK_RAISE, TK_EXCLUSIVE, TK_EXISTS, TK_SAVEPOINT,
  135449. TK_INTERSECT, TK_TRIGGER, TK_REFERENCES, TK_CONSTRAINT, TK_INTO,
  135450. TK_OFFSET, TK_OF, TK_SET, TK_TEMP, TK_TEMP,
  135451. TK_OR, TK_UNIQUE, TK_QUERY, TK_WITHOUT, TK_WITH,
  135452. TK_JOIN_KW, TK_RELEASE, TK_ATTACH, TK_HAVING, TK_GROUP,
  135453. TK_UPDATE, TK_BEGIN, TK_JOIN_KW, TK_RECURSIVE, TK_BETWEEN,
  135454. TK_NOTNULL, TK_NOT, TK_NO, TK_NULL, TK_LIKE_KW,
  135455. TK_CASCADE, TK_ASC, TK_DELETE, TK_CASE, TK_COLLATE,
  135456. TK_CREATE, TK_CTIME_KW, TK_DETACH, TK_IMMEDIATE, TK_JOIN,
  135457. TK_INSERT, TK_MATCH, TK_PLAN, TK_ANALYZE, TK_PRAGMA,
  135458. TK_ABORT, TK_VALUES, TK_VIRTUAL, TK_LIMIT, TK_WHEN,
  135459. TK_WHERE, TK_RENAME, TK_AFTER, TK_REPLACE, TK_AND,
  135460. TK_DEFAULT, TK_AUTOINCR, TK_TO, TK_IN, TK_CAST,
  135461. TK_COLUMNKW, TK_COMMIT, TK_CONFLICT, TK_JOIN_KW, TK_CTIME_KW,
  135462. TK_CTIME_KW, TK_PRIMARY, TK_DEFERRED, TK_DISTINCT, TK_IS,
  135463. TK_DROP, TK_FAIL, TK_FROM, TK_JOIN_KW, TK_LIKE_KW,
  135464. TK_BY, TK_IF, TK_ISNULL, TK_ORDER, TK_RESTRICT,
  135465. TK_JOIN_KW, TK_ROLLBACK, TK_ROW, TK_UNION, TK_USING,
  135466. TK_VACUUM, TK_VIEW, TK_INITIALLY, TK_ALL,
  135467. };
  135468. /* Check to see if z[0..n-1] is a keyword. If it is, write the
  135469. ** parser symbol code for that keyword into *pType. Always
  135470. ** return the integer n (the length of the token). */
  135471. static int keywordCode(const char *z, int n, int *pType){
  135472. int i, j;
  135473. const char *zKW;
  135474. if( n>=2 ){
  135475. i = ((charMap(z[0])*4) ^ (charMap(z[n-1])*3) ^ n) % 127;
  135476. for(i=((int)aKWHash[i])-1; i>=0; i=((int)aKWNext[i])-1){
  135477. if( aKWLen[i]!=n ) continue;
  135478. j = 0;
  135479. zKW = &zKWText[aKWOffset[i]];
  135480. #ifdef SQLITE_ASCII
  135481. while( j<n && (z[j]&~0x20)==zKW[j] ){ j++; }
  135482. #endif
  135483. #ifdef SQLITE_EBCDIC
  135484. while( j<n && toupper(z[j])==zKW[j] ){ j++; }
  135485. #endif
  135486. if( j<n ) continue;
  135487. testcase( i==0 ); /* REINDEX */
  135488. testcase( i==1 ); /* INDEXED */
  135489. testcase( i==2 ); /* INDEX */
  135490. testcase( i==3 ); /* DESC */
  135491. testcase( i==4 ); /* ESCAPE */
  135492. testcase( i==5 ); /* EACH */
  135493. testcase( i==6 ); /* CHECK */
  135494. testcase( i==7 ); /* KEY */
  135495. testcase( i==8 ); /* BEFORE */
  135496. testcase( i==9 ); /* FOREIGN */
  135497. testcase( i==10 ); /* FOR */
  135498. testcase( i==11 ); /* IGNORE */
  135499. testcase( i==12 ); /* REGEXP */
  135500. testcase( i==13 ); /* EXPLAIN */
  135501. testcase( i==14 ); /* INSTEAD */
  135502. testcase( i==15 ); /* ADD */
  135503. testcase( i==16 ); /* DATABASE */
  135504. testcase( i==17 ); /* AS */
  135505. testcase( i==18 ); /* SELECT */
  135506. testcase( i==19 ); /* TABLE */
  135507. testcase( i==20 ); /* LEFT */
  135508. testcase( i==21 ); /* THEN */
  135509. testcase( i==22 ); /* END */
  135510. testcase( i==23 ); /* DEFERRABLE */
  135511. testcase( i==24 ); /* ELSE */
  135512. testcase( i==25 ); /* EXCEPT */
  135513. testcase( i==26 ); /* TRANSACTION */
  135514. testcase( i==27 ); /* ACTION */
  135515. testcase( i==28 ); /* ON */
  135516. testcase( i==29 ); /* NATURAL */
  135517. testcase( i==30 ); /* ALTER */
  135518. testcase( i==31 ); /* RAISE */
  135519. testcase( i==32 ); /* EXCLUSIVE */
  135520. testcase( i==33 ); /* EXISTS */
  135521. testcase( i==34 ); /* SAVEPOINT */
  135522. testcase( i==35 ); /* INTERSECT */
  135523. testcase( i==36 ); /* TRIGGER */
  135524. testcase( i==37 ); /* REFERENCES */
  135525. testcase( i==38 ); /* CONSTRAINT */
  135526. testcase( i==39 ); /* INTO */
  135527. testcase( i==40 ); /* OFFSET */
  135528. testcase( i==41 ); /* OF */
  135529. testcase( i==42 ); /* SET */
  135530. testcase( i==43 ); /* TEMPORARY */
  135531. testcase( i==44 ); /* TEMP */
  135532. testcase( i==45 ); /* OR */
  135533. testcase( i==46 ); /* UNIQUE */
  135534. testcase( i==47 ); /* QUERY */
  135535. testcase( i==48 ); /* WITHOUT */
  135536. testcase( i==49 ); /* WITH */
  135537. testcase( i==50 ); /* OUTER */
  135538. testcase( i==51 ); /* RELEASE */
  135539. testcase( i==52 ); /* ATTACH */
  135540. testcase( i==53 ); /* HAVING */
  135541. testcase( i==54 ); /* GROUP */
  135542. testcase( i==55 ); /* UPDATE */
  135543. testcase( i==56 ); /* BEGIN */
  135544. testcase( i==57 ); /* INNER */
  135545. testcase( i==58 ); /* RECURSIVE */
  135546. testcase( i==59 ); /* BETWEEN */
  135547. testcase( i==60 ); /* NOTNULL */
  135548. testcase( i==61 ); /* NOT */
  135549. testcase( i==62 ); /* NO */
  135550. testcase( i==63 ); /* NULL */
  135551. testcase( i==64 ); /* LIKE */
  135552. testcase( i==65 ); /* CASCADE */
  135553. testcase( i==66 ); /* ASC */
  135554. testcase( i==67 ); /* DELETE */
  135555. testcase( i==68 ); /* CASE */
  135556. testcase( i==69 ); /* COLLATE */
  135557. testcase( i==70 ); /* CREATE */
  135558. testcase( i==71 ); /* CURRENT_DATE */
  135559. testcase( i==72 ); /* DETACH */
  135560. testcase( i==73 ); /* IMMEDIATE */
  135561. testcase( i==74 ); /* JOIN */
  135562. testcase( i==75 ); /* INSERT */
  135563. testcase( i==76 ); /* MATCH */
  135564. testcase( i==77 ); /* PLAN */
  135565. testcase( i==78 ); /* ANALYZE */
  135566. testcase( i==79 ); /* PRAGMA */
  135567. testcase( i==80 ); /* ABORT */
  135568. testcase( i==81 ); /* VALUES */
  135569. testcase( i==82 ); /* VIRTUAL */
  135570. testcase( i==83 ); /* LIMIT */
  135571. testcase( i==84 ); /* WHEN */
  135572. testcase( i==85 ); /* WHERE */
  135573. testcase( i==86 ); /* RENAME */
  135574. testcase( i==87 ); /* AFTER */
  135575. testcase( i==88 ); /* REPLACE */
  135576. testcase( i==89 ); /* AND */
  135577. testcase( i==90 ); /* DEFAULT */
  135578. testcase( i==91 ); /* AUTOINCREMENT */
  135579. testcase( i==92 ); /* TO */
  135580. testcase( i==93 ); /* IN */
  135581. testcase( i==94 ); /* CAST */
  135582. testcase( i==95 ); /* COLUMN */
  135583. testcase( i==96 ); /* COMMIT */
  135584. testcase( i==97 ); /* CONFLICT */
  135585. testcase( i==98 ); /* CROSS */
  135586. testcase( i==99 ); /* CURRENT_TIMESTAMP */
  135587. testcase( i==100 ); /* CURRENT_TIME */
  135588. testcase( i==101 ); /* PRIMARY */
  135589. testcase( i==102 ); /* DEFERRED */
  135590. testcase( i==103 ); /* DISTINCT */
  135591. testcase( i==104 ); /* IS */
  135592. testcase( i==105 ); /* DROP */
  135593. testcase( i==106 ); /* FAIL */
  135594. testcase( i==107 ); /* FROM */
  135595. testcase( i==108 ); /* FULL */
  135596. testcase( i==109 ); /* GLOB */
  135597. testcase( i==110 ); /* BY */
  135598. testcase( i==111 ); /* IF */
  135599. testcase( i==112 ); /* ISNULL */
  135600. testcase( i==113 ); /* ORDER */
  135601. testcase( i==114 ); /* RESTRICT */
  135602. testcase( i==115 ); /* RIGHT */
  135603. testcase( i==116 ); /* ROLLBACK */
  135604. testcase( i==117 ); /* ROW */
  135605. testcase( i==118 ); /* UNION */
  135606. testcase( i==119 ); /* USING */
  135607. testcase( i==120 ); /* VACUUM */
  135608. testcase( i==121 ); /* VIEW */
  135609. testcase( i==122 ); /* INITIALLY */
  135610. testcase( i==123 ); /* ALL */
  135611. *pType = aKWCode[i];
  135612. break;
  135613. }
  135614. }
  135615. return n;
  135616. }
  135617. SQLITE_PRIVATE int sqlite3KeywordCode(const unsigned char *z, int n){
  135618. int id = TK_ID;
  135619. keywordCode((char*)z, n, &id);
  135620. return id;
  135621. }
  135622. #define SQLITE_N_KEYWORD 124
  135623. /************** End of keywordhash.h *****************************************/
  135624. /************** Continuing where we left off in tokenize.c *******************/
  135625. /*
  135626. ** If X is a character that can be used in an identifier then
  135627. ** IdChar(X) will be true. Otherwise it is false.
  135628. **
  135629. ** For ASCII, any character with the high-order bit set is
  135630. ** allowed in an identifier. For 7-bit characters,
  135631. ** sqlite3IsIdChar[X] must be 1.
  135632. **
  135633. ** For EBCDIC, the rules are more complex but have the same
  135634. ** end result.
  135635. **
  135636. ** Ticket #1066. the SQL standard does not allow '$' in the
  135637. ** middle of identifiers. But many SQL implementations do.
  135638. ** SQLite will allow '$' in identifiers for compatibility.
  135639. ** But the feature is undocumented.
  135640. */
  135641. #ifdef SQLITE_ASCII
  135642. #define IdChar(C) ((sqlite3CtypeMap[(unsigned char)C]&0x46)!=0)
  135643. #endif
  135644. #ifdef SQLITE_EBCDIC
  135645. SQLITE_PRIVATE const char sqlite3IsEbcdicIdChar[] = {
  135646. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
  135647. 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 4x */
  135648. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 0, 0, 0, /* 5x */
  135649. 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, /* 6x */
  135650. 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, /* 7x */
  135651. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 0, /* 8x */
  135652. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 1, 0, /* 9x */
  135653. 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, /* Ax */
  135654. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Bx */
  135655. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Cx */
  135656. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Dx */
  135657. 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Ex */
  135658. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 0, /* Fx */
  135659. };
  135660. #define IdChar(C) (((c=C)>=0x42 && sqlite3IsEbcdicIdChar[c-0x40]))
  135661. #endif
  135662. /* Make the IdChar function accessible from ctime.c */
  135663. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  135664. SQLITE_PRIVATE int sqlite3IsIdChar(u8 c){ return IdChar(c); }
  135665. #endif
  135666. /*
  135667. ** Return the length (in bytes) of the token that begins at z[0].
  135668. ** Store the token type in *tokenType before returning.
  135669. */
  135670. SQLITE_PRIVATE int sqlite3GetToken(const unsigned char *z, int *tokenType){
  135671. int i, c;
  135672. switch( aiClass[*z] ){ /* Switch on the character-class of the first byte
  135673. ** of the token. See the comment on the CC_ defines
  135674. ** above. */
  135675. case CC_SPACE: {
  135676. testcase( z[0]==' ' );
  135677. testcase( z[0]=='\t' );
  135678. testcase( z[0]=='\n' );
  135679. testcase( z[0]=='\f' );
  135680. testcase( z[0]=='\r' );
  135681. for(i=1; sqlite3Isspace(z[i]); i++){}
  135682. *tokenType = TK_SPACE;
  135683. return i;
  135684. }
  135685. case CC_MINUS: {
  135686. if( z[1]=='-' ){
  135687. for(i=2; (c=z[i])!=0 && c!='\n'; i++){}
  135688. *tokenType = TK_SPACE; /* IMP: R-22934-25134 */
  135689. return i;
  135690. }
  135691. *tokenType = TK_MINUS;
  135692. return 1;
  135693. }
  135694. case CC_LP: {
  135695. *tokenType = TK_LP;
  135696. return 1;
  135697. }
  135698. case CC_RP: {
  135699. *tokenType = TK_RP;
  135700. return 1;
  135701. }
  135702. case CC_SEMI: {
  135703. *tokenType = TK_SEMI;
  135704. return 1;
  135705. }
  135706. case CC_PLUS: {
  135707. *tokenType = TK_PLUS;
  135708. return 1;
  135709. }
  135710. case CC_STAR: {
  135711. *tokenType = TK_STAR;
  135712. return 1;
  135713. }
  135714. case CC_SLASH: {
  135715. if( z[1]!='*' || z[2]==0 ){
  135716. *tokenType = TK_SLASH;
  135717. return 1;
  135718. }
  135719. for(i=3, c=z[2]; (c!='*' || z[i]!='/') && (c=z[i])!=0; i++){}
  135720. if( c ) i++;
  135721. *tokenType = TK_SPACE; /* IMP: R-22934-25134 */
  135722. return i;
  135723. }
  135724. case CC_PERCENT: {
  135725. *tokenType = TK_REM;
  135726. return 1;
  135727. }
  135728. case CC_EQ: {
  135729. *tokenType = TK_EQ;
  135730. return 1 + (z[1]=='=');
  135731. }
  135732. case CC_LT: {
  135733. if( (c=z[1])=='=' ){
  135734. *tokenType = TK_LE;
  135735. return 2;
  135736. }else if( c=='>' ){
  135737. *tokenType = TK_NE;
  135738. return 2;
  135739. }else if( c=='<' ){
  135740. *tokenType = TK_LSHIFT;
  135741. return 2;
  135742. }else{
  135743. *tokenType = TK_LT;
  135744. return 1;
  135745. }
  135746. }
  135747. case CC_GT: {
  135748. if( (c=z[1])=='=' ){
  135749. *tokenType = TK_GE;
  135750. return 2;
  135751. }else if( c=='>' ){
  135752. *tokenType = TK_RSHIFT;
  135753. return 2;
  135754. }else{
  135755. *tokenType = TK_GT;
  135756. return 1;
  135757. }
  135758. }
  135759. case CC_BANG: {
  135760. if( z[1]!='=' ){
  135761. *tokenType = TK_ILLEGAL;
  135762. return 1;
  135763. }else{
  135764. *tokenType = TK_NE;
  135765. return 2;
  135766. }
  135767. }
  135768. case CC_PIPE: {
  135769. if( z[1]!='|' ){
  135770. *tokenType = TK_BITOR;
  135771. return 1;
  135772. }else{
  135773. *tokenType = TK_CONCAT;
  135774. return 2;
  135775. }
  135776. }
  135777. case CC_COMMA: {
  135778. *tokenType = TK_COMMA;
  135779. return 1;
  135780. }
  135781. case CC_AND: {
  135782. *tokenType = TK_BITAND;
  135783. return 1;
  135784. }
  135785. case CC_TILDA: {
  135786. *tokenType = TK_BITNOT;
  135787. return 1;
  135788. }
  135789. case CC_QUOTE: {
  135790. int delim = z[0];
  135791. testcase( delim=='`' );
  135792. testcase( delim=='\'' );
  135793. testcase( delim=='"' );
  135794. for(i=1; (c=z[i])!=0; i++){
  135795. if( c==delim ){
  135796. if( z[i+1]==delim ){
  135797. i++;
  135798. }else{
  135799. break;
  135800. }
  135801. }
  135802. }
  135803. if( c=='\'' ){
  135804. *tokenType = TK_STRING;
  135805. return i+1;
  135806. }else if( c!=0 ){
  135807. *tokenType = TK_ID;
  135808. return i+1;
  135809. }else{
  135810. *tokenType = TK_ILLEGAL;
  135811. return i;
  135812. }
  135813. }
  135814. case CC_DOT: {
  135815. #ifndef SQLITE_OMIT_FLOATING_POINT
  135816. if( !sqlite3Isdigit(z[1]) )
  135817. #endif
  135818. {
  135819. *tokenType = TK_DOT;
  135820. return 1;
  135821. }
  135822. /* If the next character is a digit, this is a floating point
  135823. ** number that begins with ".". Fall thru into the next case */
  135824. }
  135825. case CC_DIGIT: {
  135826. testcase( z[0]=='0' ); testcase( z[0]=='1' ); testcase( z[0]=='2' );
  135827. testcase( z[0]=='3' ); testcase( z[0]=='4' ); testcase( z[0]=='5' );
  135828. testcase( z[0]=='6' ); testcase( z[0]=='7' ); testcase( z[0]=='8' );
  135829. testcase( z[0]=='9' );
  135830. *tokenType = TK_INTEGER;
  135831. #ifndef SQLITE_OMIT_HEX_INTEGER
  135832. if( z[0]=='0' && (z[1]=='x' || z[1]=='X') && sqlite3Isxdigit(z[2]) ){
  135833. for(i=3; sqlite3Isxdigit(z[i]); i++){}
  135834. return i;
  135835. }
  135836. #endif
  135837. for(i=0; sqlite3Isdigit(z[i]); i++){}
  135838. #ifndef SQLITE_OMIT_FLOATING_POINT
  135839. if( z[i]=='.' ){
  135840. i++;
  135841. while( sqlite3Isdigit(z[i]) ){ i++; }
  135842. *tokenType = TK_FLOAT;
  135843. }
  135844. if( (z[i]=='e' || z[i]=='E') &&
  135845. ( sqlite3Isdigit(z[i+1])
  135846. || ((z[i+1]=='+' || z[i+1]=='-') && sqlite3Isdigit(z[i+2]))
  135847. )
  135848. ){
  135849. i += 2;
  135850. while( sqlite3Isdigit(z[i]) ){ i++; }
  135851. *tokenType = TK_FLOAT;
  135852. }
  135853. #endif
  135854. while( IdChar(z[i]) ){
  135855. *tokenType = TK_ILLEGAL;
  135856. i++;
  135857. }
  135858. return i;
  135859. }
  135860. case CC_QUOTE2: {
  135861. for(i=1, c=z[0]; c!=']' && (c=z[i])!=0; i++){}
  135862. *tokenType = c==']' ? TK_ID : TK_ILLEGAL;
  135863. return i;
  135864. }
  135865. case CC_VARNUM: {
  135866. *tokenType = TK_VARIABLE;
  135867. for(i=1; sqlite3Isdigit(z[i]); i++){}
  135868. return i;
  135869. }
  135870. case CC_DOLLAR:
  135871. case CC_VARALPHA: {
  135872. int n = 0;
  135873. testcase( z[0]=='$' ); testcase( z[0]=='@' );
  135874. testcase( z[0]==':' ); testcase( z[0]=='#' );
  135875. *tokenType = TK_VARIABLE;
  135876. for(i=1; (c=z[i])!=0; i++){
  135877. if( IdChar(c) ){
  135878. n++;
  135879. #ifndef SQLITE_OMIT_TCL_VARIABLE
  135880. }else if( c=='(' && n>0 ){
  135881. do{
  135882. i++;
  135883. }while( (c=z[i])!=0 && !sqlite3Isspace(c) && c!=')' );
  135884. if( c==')' ){
  135885. i++;
  135886. }else{
  135887. *tokenType = TK_ILLEGAL;
  135888. }
  135889. break;
  135890. }else if( c==':' && z[i+1]==':' ){
  135891. i++;
  135892. #endif
  135893. }else{
  135894. break;
  135895. }
  135896. }
  135897. if( n==0 ) *tokenType = TK_ILLEGAL;
  135898. return i;
  135899. }
  135900. case CC_KYWD: {
  135901. for(i=1; aiClass[z[i]]<=CC_KYWD; i++){}
  135902. if( IdChar(z[i]) ){
  135903. /* This token started out using characters that can appear in keywords,
  135904. ** but z[i] is a character not allowed within keywords, so this must
  135905. ** be an identifier instead */
  135906. i++;
  135907. break;
  135908. }
  135909. *tokenType = TK_ID;
  135910. return keywordCode((char*)z, i, tokenType);
  135911. }
  135912. case CC_X: {
  135913. #ifndef SQLITE_OMIT_BLOB_LITERAL
  135914. testcase( z[0]=='x' ); testcase( z[0]=='X' );
  135915. if( z[1]=='\'' ){
  135916. *tokenType = TK_BLOB;
  135917. for(i=2; sqlite3Isxdigit(z[i]); i++){}
  135918. if( z[i]!='\'' || i%2 ){
  135919. *tokenType = TK_ILLEGAL;
  135920. while( z[i] && z[i]!='\'' ){ i++; }
  135921. }
  135922. if( z[i] ) i++;
  135923. return i;
  135924. }
  135925. #endif
  135926. /* If it is not a BLOB literal, then it must be an ID, since no
  135927. ** SQL keywords start with the letter 'x'. Fall through */
  135928. }
  135929. case CC_ID: {
  135930. i = 1;
  135931. break;
  135932. }
  135933. default: {
  135934. *tokenType = TK_ILLEGAL;
  135935. return 1;
  135936. }
  135937. }
  135938. while( IdChar(z[i]) ){ i++; }
  135939. *tokenType = TK_ID;
  135940. return i;
  135941. }
  135942. /*
  135943. ** Run the parser on the given SQL string. The parser structure is
  135944. ** passed in. An SQLITE_ status code is returned. If an error occurs
  135945. ** then an and attempt is made to write an error message into
  135946. ** memory obtained from sqlite3_malloc() and to make *pzErrMsg point to that
  135947. ** error message.
  135948. */
  135949. SQLITE_PRIVATE int sqlite3RunParser(Parse *pParse, const char *zSql, char **pzErrMsg){
  135950. int nErr = 0; /* Number of errors encountered */
  135951. void *pEngine; /* The LEMON-generated LALR(1) parser */
  135952. int n = 0; /* Length of the next token token */
  135953. int tokenType; /* type of the next token */
  135954. int lastTokenParsed = -1; /* type of the previous token */
  135955. sqlite3 *db = pParse->db; /* The database connection */
  135956. int mxSqlLen; /* Max length of an SQL string */
  135957. #ifdef sqlite3Parser_ENGINEALWAYSONSTACK
  135958. yyParser sEngine; /* Space to hold the Lemon-generated Parser object */
  135959. #endif
  135960. assert( zSql!=0 );
  135961. mxSqlLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
  135962. if( db->nVdbeActive==0 ){
  135963. db->u1.isInterrupted = 0;
  135964. }
  135965. pParse->rc = SQLITE_OK;
  135966. pParse->zTail = zSql;
  135967. assert( pzErrMsg!=0 );
  135968. /* sqlite3ParserTrace(stdout, "parser: "); */
  135969. #ifdef sqlite3Parser_ENGINEALWAYSONSTACK
  135970. pEngine = &sEngine;
  135971. sqlite3ParserInit(pEngine);
  135972. #else
  135973. pEngine = sqlite3ParserAlloc(sqlite3Malloc);
  135974. if( pEngine==0 ){
  135975. sqlite3OomFault(db);
  135976. return SQLITE_NOMEM_BKPT;
  135977. }
  135978. #endif
  135979. assert( pParse->pNewTable==0 );
  135980. assert( pParse->pNewTrigger==0 );
  135981. assert( pParse->nVar==0 );
  135982. assert( pParse->pVList==0 );
  135983. while( 1 ){
  135984. if( zSql[0]!=0 ){
  135985. n = sqlite3GetToken((u8*)zSql, &tokenType);
  135986. mxSqlLen -= n;
  135987. if( mxSqlLen<0 ){
  135988. pParse->rc = SQLITE_TOOBIG;
  135989. break;
  135990. }
  135991. }else{
  135992. /* Upon reaching the end of input, call the parser two more times
  135993. ** with tokens TK_SEMI and 0, in that order. */
  135994. if( lastTokenParsed==TK_SEMI ){
  135995. tokenType = 0;
  135996. }else if( lastTokenParsed==0 ){
  135997. break;
  135998. }else{
  135999. tokenType = TK_SEMI;
  136000. }
  136001. n = 0;
  136002. }
  136003. if( tokenType>=TK_SPACE ){
  136004. assert( tokenType==TK_SPACE || tokenType==TK_ILLEGAL );
  136005. if( db->u1.isInterrupted ){
  136006. pParse->rc = SQLITE_INTERRUPT;
  136007. break;
  136008. }
  136009. if( tokenType==TK_ILLEGAL ){
  136010. sqlite3ErrorMsg(pParse, "unrecognized token: \"%.*s\"", n, zSql);
  136011. break;
  136012. }
  136013. zSql += n;
  136014. }else{
  136015. pParse->sLastToken.z = zSql;
  136016. pParse->sLastToken.n = n;
  136017. sqlite3Parser(pEngine, tokenType, pParse->sLastToken, pParse);
  136018. lastTokenParsed = tokenType;
  136019. zSql += n;
  136020. if( pParse->rc!=SQLITE_OK || db->mallocFailed ) break;
  136021. }
  136022. }
  136023. assert( nErr==0 );
  136024. pParse->zTail = zSql;
  136025. #ifdef YYTRACKMAXSTACKDEPTH
  136026. sqlite3_mutex_enter(sqlite3MallocMutex());
  136027. sqlite3StatusHighwater(SQLITE_STATUS_PARSER_STACK,
  136028. sqlite3ParserStackPeak(pEngine)
  136029. );
  136030. sqlite3_mutex_leave(sqlite3MallocMutex());
  136031. #endif /* YYDEBUG */
  136032. #ifdef sqlite3Parser_ENGINEALWAYSONSTACK
  136033. sqlite3ParserFinalize(pEngine);
  136034. #else
  136035. sqlite3ParserFree(pEngine, sqlite3_free);
  136036. #endif
  136037. if( db->mallocFailed ){
  136038. pParse->rc = SQLITE_NOMEM_BKPT;
  136039. }
  136040. if( pParse->rc!=SQLITE_OK && pParse->rc!=SQLITE_DONE && pParse->zErrMsg==0 ){
  136041. pParse->zErrMsg = sqlite3MPrintf(db, "%s", sqlite3ErrStr(pParse->rc));
  136042. }
  136043. assert( pzErrMsg!=0 );
  136044. if( pParse->zErrMsg ){
  136045. *pzErrMsg = pParse->zErrMsg;
  136046. sqlite3_log(pParse->rc, "%s", *pzErrMsg);
  136047. pParse->zErrMsg = 0;
  136048. nErr++;
  136049. }
  136050. if( pParse->pVdbe && pParse->nErr>0 && pParse->nested==0 ){
  136051. sqlite3VdbeDelete(pParse->pVdbe);
  136052. pParse->pVdbe = 0;
  136053. }
  136054. #ifndef SQLITE_OMIT_SHARED_CACHE
  136055. if( pParse->nested==0 ){
  136056. sqlite3DbFree(db, pParse->aTableLock);
  136057. pParse->aTableLock = 0;
  136058. pParse->nTableLock = 0;
  136059. }
  136060. #endif
  136061. #ifndef SQLITE_OMIT_VIRTUALTABLE
  136062. sqlite3_free(pParse->apVtabLock);
  136063. #endif
  136064. if( !IN_DECLARE_VTAB ){
  136065. /* If the pParse->declareVtab flag is set, do not delete any table
  136066. ** structure built up in pParse->pNewTable. The calling code (see vtab.c)
  136067. ** will take responsibility for freeing the Table structure.
  136068. */
  136069. sqlite3DeleteTable(db, pParse->pNewTable);
  136070. }
  136071. if( pParse->pWithToFree ) sqlite3WithDelete(db, pParse->pWithToFree);
  136072. sqlite3DeleteTrigger(db, pParse->pNewTrigger);
  136073. sqlite3DbFree(db, pParse->pVList);
  136074. while( pParse->pAinc ){
  136075. AutoincInfo *p = pParse->pAinc;
  136076. pParse->pAinc = p->pNext;
  136077. sqlite3DbFreeNN(db, p);
  136078. }
  136079. while( pParse->pZombieTab ){
  136080. Table *p = pParse->pZombieTab;
  136081. pParse->pZombieTab = p->pNextZombie;
  136082. sqlite3DeleteTable(db, p);
  136083. }
  136084. assert( nErr==0 || pParse->rc!=SQLITE_OK );
  136085. return nErr;
  136086. }
  136087. /************** End of tokenize.c ********************************************/
  136088. /************** Begin file complete.c ****************************************/
  136089. /*
  136090. ** 2001 September 15
  136091. **
  136092. ** The author disclaims copyright to this source code. In place of
  136093. ** a legal notice, here is a blessing:
  136094. **
  136095. ** May you do good and not evil.
  136096. ** May you find forgiveness for yourself and forgive others.
  136097. ** May you share freely, never taking more than you give.
  136098. **
  136099. *************************************************************************
  136100. ** An tokenizer for SQL
  136101. **
  136102. ** This file contains C code that implements the sqlite3_complete() API.
  136103. ** This code used to be part of the tokenizer.c source file. But by
  136104. ** separating it out, the code will be automatically omitted from
  136105. ** static links that do not use it.
  136106. */
  136107. /* #include "sqliteInt.h" */
  136108. #ifndef SQLITE_OMIT_COMPLETE
  136109. /*
  136110. ** This is defined in tokenize.c. We just have to import the definition.
  136111. */
  136112. #ifndef SQLITE_AMALGAMATION
  136113. #ifdef SQLITE_ASCII
  136114. #define IdChar(C) ((sqlite3CtypeMap[(unsigned char)C]&0x46)!=0)
  136115. #endif
  136116. #ifdef SQLITE_EBCDIC
  136117. SQLITE_PRIVATE const char sqlite3IsEbcdicIdChar[];
  136118. #define IdChar(C) (((c=C)>=0x42 && sqlite3IsEbcdicIdChar[c-0x40]))
  136119. #endif
  136120. #endif /* SQLITE_AMALGAMATION */
  136121. /*
  136122. ** Token types used by the sqlite3_complete() routine. See the header
  136123. ** comments on that procedure for additional information.
  136124. */
  136125. #define tkSEMI 0
  136126. #define tkWS 1
  136127. #define tkOTHER 2
  136128. #ifndef SQLITE_OMIT_TRIGGER
  136129. #define tkEXPLAIN 3
  136130. #define tkCREATE 4
  136131. #define tkTEMP 5
  136132. #define tkTRIGGER 6
  136133. #define tkEND 7
  136134. #endif
  136135. /*
  136136. ** Return TRUE if the given SQL string ends in a semicolon.
  136137. **
  136138. ** Special handling is require for CREATE TRIGGER statements.
  136139. ** Whenever the CREATE TRIGGER keywords are seen, the statement
  136140. ** must end with ";END;".
  136141. **
  136142. ** This implementation uses a state machine with 8 states:
  136143. **
  136144. ** (0) INVALID We have not yet seen a non-whitespace character.
  136145. **
  136146. ** (1) START At the beginning or end of an SQL statement. This routine
  136147. ** returns 1 if it ends in the START state and 0 if it ends
  136148. ** in any other state.
  136149. **
  136150. ** (2) NORMAL We are in the middle of statement which ends with a single
  136151. ** semicolon.
  136152. **
  136153. ** (3) EXPLAIN The keyword EXPLAIN has been seen at the beginning of
  136154. ** a statement.
  136155. **
  136156. ** (4) CREATE The keyword CREATE has been seen at the beginning of a
  136157. ** statement, possibly preceded by EXPLAIN and/or followed by
  136158. ** TEMP or TEMPORARY
  136159. **
  136160. ** (5) TRIGGER We are in the middle of a trigger definition that must be
  136161. ** ended by a semicolon, the keyword END, and another semicolon.
  136162. **
  136163. ** (6) SEMI We've seen the first semicolon in the ";END;" that occurs at
  136164. ** the end of a trigger definition.
  136165. **
  136166. ** (7) END We've seen the ";END" of the ";END;" that occurs at the end
  136167. ** of a trigger definition.
  136168. **
  136169. ** Transitions between states above are determined by tokens extracted
  136170. ** from the input. The following tokens are significant:
  136171. **
  136172. ** (0) tkSEMI A semicolon.
  136173. ** (1) tkWS Whitespace.
  136174. ** (2) tkOTHER Any other SQL token.
  136175. ** (3) tkEXPLAIN The "explain" keyword.
  136176. ** (4) tkCREATE The "create" keyword.
  136177. ** (5) tkTEMP The "temp" or "temporary" keyword.
  136178. ** (6) tkTRIGGER The "trigger" keyword.
  136179. ** (7) tkEND The "end" keyword.
  136180. **
  136181. ** Whitespace never causes a state transition and is always ignored.
  136182. ** This means that a SQL string of all whitespace is invalid.
  136183. **
  136184. ** If we compile with SQLITE_OMIT_TRIGGER, all of the computation needed
  136185. ** to recognize the end of a trigger can be omitted. All we have to do
  136186. ** is look for a semicolon that is not part of an string or comment.
  136187. */
  136188. SQLITE_API int sqlite3_complete(const char *zSql){
  136189. u8 state = 0; /* Current state, using numbers defined in header comment */
  136190. u8 token; /* Value of the next token */
  136191. #ifndef SQLITE_OMIT_TRIGGER
  136192. /* A complex statement machine used to detect the end of a CREATE TRIGGER
  136193. ** statement. This is the normal case.
  136194. */
  136195. static const u8 trans[8][8] = {
  136196. /* Token: */
  136197. /* State: ** SEMI WS OTHER EXPLAIN CREATE TEMP TRIGGER END */
  136198. /* 0 INVALID: */ { 1, 0, 2, 3, 4, 2, 2, 2, },
  136199. /* 1 START: */ { 1, 1, 2, 3, 4, 2, 2, 2, },
  136200. /* 2 NORMAL: */ { 1, 2, 2, 2, 2, 2, 2, 2, },
  136201. /* 3 EXPLAIN: */ { 1, 3, 3, 2, 4, 2, 2, 2, },
  136202. /* 4 CREATE: */ { 1, 4, 2, 2, 2, 4, 5, 2, },
  136203. /* 5 TRIGGER: */ { 6, 5, 5, 5, 5, 5, 5, 5, },
  136204. /* 6 SEMI: */ { 6, 6, 5, 5, 5, 5, 5, 7, },
  136205. /* 7 END: */ { 1, 7, 5, 5, 5, 5, 5, 5, },
  136206. };
  136207. #else
  136208. /* If triggers are not supported by this compile then the statement machine
  136209. ** used to detect the end of a statement is much simpler
  136210. */
  136211. static const u8 trans[3][3] = {
  136212. /* Token: */
  136213. /* State: ** SEMI WS OTHER */
  136214. /* 0 INVALID: */ { 1, 0, 2, },
  136215. /* 1 START: */ { 1, 1, 2, },
  136216. /* 2 NORMAL: */ { 1, 2, 2, },
  136217. };
  136218. #endif /* SQLITE_OMIT_TRIGGER */
  136219. #ifdef SQLITE_ENABLE_API_ARMOR
  136220. if( zSql==0 ){
  136221. (void)SQLITE_MISUSE_BKPT;
  136222. return 0;
  136223. }
  136224. #endif
  136225. while( *zSql ){
  136226. switch( *zSql ){
  136227. case ';': { /* A semicolon */
  136228. token = tkSEMI;
  136229. break;
  136230. }
  136231. case ' ':
  136232. case '\r':
  136233. case '\t':
  136234. case '\n':
  136235. case '\f': { /* White space is ignored */
  136236. token = tkWS;
  136237. break;
  136238. }
  136239. case '/': { /* C-style comments */
  136240. if( zSql[1]!='*' ){
  136241. token = tkOTHER;
  136242. break;
  136243. }
  136244. zSql += 2;
  136245. while( zSql[0] && (zSql[0]!='*' || zSql[1]!='/') ){ zSql++; }
  136246. if( zSql[0]==0 ) return 0;
  136247. zSql++;
  136248. token = tkWS;
  136249. break;
  136250. }
  136251. case '-': { /* SQL-style comments from "--" to end of line */
  136252. if( zSql[1]!='-' ){
  136253. token = tkOTHER;
  136254. break;
  136255. }
  136256. while( *zSql && *zSql!='\n' ){ zSql++; }
  136257. if( *zSql==0 ) return state==1;
  136258. token = tkWS;
  136259. break;
  136260. }
  136261. case '[': { /* Microsoft-style identifiers in [...] */
  136262. zSql++;
  136263. while( *zSql && *zSql!=']' ){ zSql++; }
  136264. if( *zSql==0 ) return 0;
  136265. token = tkOTHER;
  136266. break;
  136267. }
  136268. case '`': /* Grave-accent quoted symbols used by MySQL */
  136269. case '"': /* single- and double-quoted strings */
  136270. case '\'': {
  136271. int c = *zSql;
  136272. zSql++;
  136273. while( *zSql && *zSql!=c ){ zSql++; }
  136274. if( *zSql==0 ) return 0;
  136275. token = tkOTHER;
  136276. break;
  136277. }
  136278. default: {
  136279. #ifdef SQLITE_EBCDIC
  136280. unsigned char c;
  136281. #endif
  136282. if( IdChar((u8)*zSql) ){
  136283. /* Keywords and unquoted identifiers */
  136284. int nId;
  136285. for(nId=1; IdChar(zSql[nId]); nId++){}
  136286. #ifdef SQLITE_OMIT_TRIGGER
  136287. token = tkOTHER;
  136288. #else
  136289. switch( *zSql ){
  136290. case 'c': case 'C': {
  136291. if( nId==6 && sqlite3StrNICmp(zSql, "create", 6)==0 ){
  136292. token = tkCREATE;
  136293. }else{
  136294. token = tkOTHER;
  136295. }
  136296. break;
  136297. }
  136298. case 't': case 'T': {
  136299. if( nId==7 && sqlite3StrNICmp(zSql, "trigger", 7)==0 ){
  136300. token = tkTRIGGER;
  136301. }else if( nId==4 && sqlite3StrNICmp(zSql, "temp", 4)==0 ){
  136302. token = tkTEMP;
  136303. }else if( nId==9 && sqlite3StrNICmp(zSql, "temporary", 9)==0 ){
  136304. token = tkTEMP;
  136305. }else{
  136306. token = tkOTHER;
  136307. }
  136308. break;
  136309. }
  136310. case 'e': case 'E': {
  136311. if( nId==3 && sqlite3StrNICmp(zSql, "end", 3)==0 ){
  136312. token = tkEND;
  136313. }else
  136314. #ifndef SQLITE_OMIT_EXPLAIN
  136315. if( nId==7 && sqlite3StrNICmp(zSql, "explain", 7)==0 ){
  136316. token = tkEXPLAIN;
  136317. }else
  136318. #endif
  136319. {
  136320. token = tkOTHER;
  136321. }
  136322. break;
  136323. }
  136324. default: {
  136325. token = tkOTHER;
  136326. break;
  136327. }
  136328. }
  136329. #endif /* SQLITE_OMIT_TRIGGER */
  136330. zSql += nId-1;
  136331. }else{
  136332. /* Operators and special symbols */
  136333. token = tkOTHER;
  136334. }
  136335. break;
  136336. }
  136337. }
  136338. state = trans[state][token];
  136339. zSql++;
  136340. }
  136341. return state==1;
  136342. }
  136343. #ifndef SQLITE_OMIT_UTF16
  136344. /*
  136345. ** This routine is the same as the sqlite3_complete() routine described
  136346. ** above, except that the parameter is required to be UTF-16 encoded, not
  136347. ** UTF-8.
  136348. */
  136349. SQLITE_API int sqlite3_complete16(const void *zSql){
  136350. sqlite3_value *pVal;
  136351. char const *zSql8;
  136352. int rc;
  136353. #ifndef SQLITE_OMIT_AUTOINIT
  136354. rc = sqlite3_initialize();
  136355. if( rc ) return rc;
  136356. #endif
  136357. pVal = sqlite3ValueNew(0);
  136358. sqlite3ValueSetStr(pVal, -1, zSql, SQLITE_UTF16NATIVE, SQLITE_STATIC);
  136359. zSql8 = sqlite3ValueText(pVal, SQLITE_UTF8);
  136360. if( zSql8 ){
  136361. rc = sqlite3_complete(zSql8);
  136362. }else{
  136363. rc = SQLITE_NOMEM_BKPT;
  136364. }
  136365. sqlite3ValueFree(pVal);
  136366. return rc & 0xff;
  136367. }
  136368. #endif /* SQLITE_OMIT_UTF16 */
  136369. #endif /* SQLITE_OMIT_COMPLETE */
  136370. /************** End of complete.c ********************************************/
  136371. /************** Begin file main.c ********************************************/
  136372. /*
  136373. ** 2001 September 15
  136374. **
  136375. ** The author disclaims copyright to this source code. In place of
  136376. ** a legal notice, here is a blessing:
  136377. **
  136378. ** May you do good and not evil.
  136379. ** May you find forgiveness for yourself and forgive others.
  136380. ** May you share freely, never taking more than you give.
  136381. **
  136382. *************************************************************************
  136383. ** Main file for the SQLite library. The routines in this file
  136384. ** implement the programmer interface to the library. Routines in
  136385. ** other files are for internal use by SQLite and should not be
  136386. ** accessed by users of the library.
  136387. */
  136388. /* #include "sqliteInt.h" */
  136389. #ifdef SQLITE_ENABLE_FTS3
  136390. /************** Include fts3.h in the middle of main.c ***********************/
  136391. /************** Begin file fts3.h ********************************************/
  136392. /*
  136393. ** 2006 Oct 10
  136394. **
  136395. ** The author disclaims copyright to this source code. In place of
  136396. ** a legal notice, here is a blessing:
  136397. **
  136398. ** May you do good and not evil.
  136399. ** May you find forgiveness for yourself and forgive others.
  136400. ** May you share freely, never taking more than you give.
  136401. **
  136402. ******************************************************************************
  136403. **
  136404. ** This header file is used by programs that want to link against the
  136405. ** FTS3 library. All it does is declare the sqlite3Fts3Init() interface.
  136406. */
  136407. /* #include "sqlite3.h" */
  136408. #if 0
  136409. extern "C" {
  136410. #endif /* __cplusplus */
  136411. SQLITE_PRIVATE int sqlite3Fts3Init(sqlite3 *db);
  136412. #if 0
  136413. } /* extern "C" */
  136414. #endif /* __cplusplus */
  136415. /************** End of fts3.h ************************************************/
  136416. /************** Continuing where we left off in main.c ***********************/
  136417. #endif
  136418. #ifdef SQLITE_ENABLE_RTREE
  136419. /************** Include rtree.h in the middle of main.c **********************/
  136420. /************** Begin file rtree.h *******************************************/
  136421. /*
  136422. ** 2008 May 26
  136423. **
  136424. ** The author disclaims copyright to this source code. In place of
  136425. ** a legal notice, here is a blessing:
  136426. **
  136427. ** May you do good and not evil.
  136428. ** May you find forgiveness for yourself and forgive others.
  136429. ** May you share freely, never taking more than you give.
  136430. **
  136431. ******************************************************************************
  136432. **
  136433. ** This header file is used by programs that want to link against the
  136434. ** RTREE library. All it does is declare the sqlite3RtreeInit() interface.
  136435. */
  136436. /* #include "sqlite3.h" */
  136437. #ifdef SQLITE_OMIT_VIRTUALTABLE
  136438. # undef SQLITE_ENABLE_RTREE
  136439. #endif
  136440. #if 0
  136441. extern "C" {
  136442. #endif /* __cplusplus */
  136443. SQLITE_PRIVATE int sqlite3RtreeInit(sqlite3 *db);
  136444. #if 0
  136445. } /* extern "C" */
  136446. #endif /* __cplusplus */
  136447. /************** End of rtree.h ***********************************************/
  136448. /************** Continuing where we left off in main.c ***********************/
  136449. #endif
  136450. #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
  136451. /************** Include sqliteicu.h in the middle of main.c ******************/
  136452. /************** Begin file sqliteicu.h ***************************************/
  136453. /*
  136454. ** 2008 May 26
  136455. **
  136456. ** The author disclaims copyright to this source code. In place of
  136457. ** a legal notice, here is a blessing:
  136458. **
  136459. ** May you do good and not evil.
  136460. ** May you find forgiveness for yourself and forgive others.
  136461. ** May you share freely, never taking more than you give.
  136462. **
  136463. ******************************************************************************
  136464. **
  136465. ** This header file is used by programs that want to link against the
  136466. ** ICU extension. All it does is declare the sqlite3IcuInit() interface.
  136467. */
  136468. /* #include "sqlite3.h" */
  136469. #if 0
  136470. extern "C" {
  136471. #endif /* __cplusplus */
  136472. SQLITE_PRIVATE int sqlite3IcuInit(sqlite3 *db);
  136473. #if 0
  136474. } /* extern "C" */
  136475. #endif /* __cplusplus */
  136476. /************** End of sqliteicu.h *******************************************/
  136477. /************** Continuing where we left off in main.c ***********************/
  136478. #endif
  136479. #ifdef SQLITE_ENABLE_JSON1
  136480. SQLITE_PRIVATE int sqlite3Json1Init(sqlite3*);
  136481. #endif
  136482. #ifdef SQLITE_ENABLE_STMTVTAB
  136483. SQLITE_PRIVATE int sqlite3StmtVtabInit(sqlite3*);
  136484. #endif
  136485. #ifdef SQLITE_ENABLE_FTS5
  136486. SQLITE_PRIVATE int sqlite3Fts5Init(sqlite3*);
  136487. #endif
  136488. #ifndef SQLITE_AMALGAMATION
  136489. /* IMPLEMENTATION-OF: R-46656-45156 The sqlite3_version[] string constant
  136490. ** contains the text of SQLITE_VERSION macro.
  136491. */
  136492. SQLITE_API const char sqlite3_version[] = SQLITE_VERSION;
  136493. #endif
  136494. /* IMPLEMENTATION-OF: R-53536-42575 The sqlite3_libversion() function returns
  136495. ** a pointer to the to the sqlite3_version[] string constant.
  136496. */
  136497. SQLITE_API const char *sqlite3_libversion(void){ return sqlite3_version; }
  136498. /* IMPLEMENTATION-OF: R-25063-23286 The sqlite3_sourceid() function returns a
  136499. ** pointer to a string constant whose value is the same as the
  136500. ** SQLITE_SOURCE_ID C preprocessor macro. Except if SQLite is built using
  136501. ** an edited copy of the amalgamation, then the last four characters of
  136502. ** the hash might be different from SQLITE_SOURCE_ID.
  136503. */
  136504. /* SQLITE_API const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; } */
  136505. /* IMPLEMENTATION-OF: R-35210-63508 The sqlite3_libversion_number() function
  136506. ** returns an integer equal to SQLITE_VERSION_NUMBER.
  136507. */
  136508. SQLITE_API int sqlite3_libversion_number(void){ return SQLITE_VERSION_NUMBER; }
  136509. /* IMPLEMENTATION-OF: R-20790-14025 The sqlite3_threadsafe() function returns
  136510. ** zero if and only if SQLite was compiled with mutexing code omitted due to
  136511. ** the SQLITE_THREADSAFE compile-time option being set to 0.
  136512. */
  136513. SQLITE_API int sqlite3_threadsafe(void){ return SQLITE_THREADSAFE; }
  136514. /*
  136515. ** When compiling the test fixture or with debugging enabled (on Win32),
  136516. ** this variable being set to non-zero will cause OSTRACE macros to emit
  136517. ** extra diagnostic information.
  136518. */
  136519. #ifdef SQLITE_HAVE_OS_TRACE
  136520. # ifndef SQLITE_DEBUG_OS_TRACE
  136521. # define SQLITE_DEBUG_OS_TRACE 0
  136522. # endif
  136523. int sqlite3OSTrace = SQLITE_DEBUG_OS_TRACE;
  136524. #endif
  136525. #if !defined(SQLITE_OMIT_TRACE) && defined(SQLITE_ENABLE_IOTRACE)
  136526. /*
  136527. ** If the following function pointer is not NULL and if
  136528. ** SQLITE_ENABLE_IOTRACE is enabled, then messages describing
  136529. ** I/O active are written using this function. These messages
  136530. ** are intended for debugging activity only.
  136531. */
  136532. SQLITE_API void (SQLITE_CDECL *sqlite3IoTrace)(const char*, ...) = 0;
  136533. #endif
  136534. /*
  136535. ** If the following global variable points to a string which is the
  136536. ** name of a directory, then that directory will be used to store
  136537. ** temporary files.
  136538. **
  136539. ** See also the "PRAGMA temp_store_directory" SQL command.
  136540. */
  136541. SQLITE_API char *sqlite3_temp_directory = 0;
  136542. /*
  136543. ** If the following global variable points to a string which is the
  136544. ** name of a directory, then that directory will be used to store
  136545. ** all database files specified with a relative pathname.
  136546. **
  136547. ** See also the "PRAGMA data_store_directory" SQL command.
  136548. */
  136549. SQLITE_API char *sqlite3_data_directory = 0;
  136550. /*
  136551. ** Initialize SQLite.
  136552. **
  136553. ** This routine must be called to initialize the memory allocation,
  136554. ** VFS, and mutex subsystems prior to doing any serious work with
  136555. ** SQLite. But as long as you do not compile with SQLITE_OMIT_AUTOINIT
  136556. ** this routine will be called automatically by key routines such as
  136557. ** sqlite3_open().
  136558. **
  136559. ** This routine is a no-op except on its very first call for the process,
  136560. ** or for the first call after a call to sqlite3_shutdown.
  136561. **
  136562. ** The first thread to call this routine runs the initialization to
  136563. ** completion. If subsequent threads call this routine before the first
  136564. ** thread has finished the initialization process, then the subsequent
  136565. ** threads must block until the first thread finishes with the initialization.
  136566. **
  136567. ** The first thread might call this routine recursively. Recursive
  136568. ** calls to this routine should not block, of course. Otherwise the
  136569. ** initialization process would never complete.
  136570. **
  136571. ** Let X be the first thread to enter this routine. Let Y be some other
  136572. ** thread. Then while the initial invocation of this routine by X is
  136573. ** incomplete, it is required that:
  136574. **
  136575. ** * Calls to this routine from Y must block until the outer-most
  136576. ** call by X completes.
  136577. **
  136578. ** * Recursive calls to this routine from thread X return immediately
  136579. ** without blocking.
  136580. */
  136581. SQLITE_API int sqlite3_initialize(void){
  136582. MUTEX_LOGIC( sqlite3_mutex *pMaster; ) /* The main static mutex */
  136583. int rc; /* Result code */
  136584. #ifdef SQLITE_EXTRA_INIT
  136585. int bRunExtraInit = 0; /* Extra initialization needed */
  136586. #endif
  136587. #ifdef SQLITE_OMIT_WSD
  136588. rc = sqlite3_wsd_init(4096, 24);
  136589. if( rc!=SQLITE_OK ){
  136590. return rc;
  136591. }
  136592. #endif
  136593. /* If the following assert() fails on some obscure processor/compiler
  136594. ** combination, the work-around is to set the correct pointer
  136595. ** size at compile-time using -DSQLITE_PTRSIZE=n compile-time option */
  136596. assert( SQLITE_PTRSIZE==sizeof(char*) );
  136597. /* If SQLite is already completely initialized, then this call
  136598. ** to sqlite3_initialize() should be a no-op. But the initialization
  136599. ** must be complete. So isInit must not be set until the very end
  136600. ** of this routine.
  136601. */
  136602. if( sqlite3GlobalConfig.isInit ) return SQLITE_OK;
  136603. /* Make sure the mutex subsystem is initialized. If unable to
  136604. ** initialize the mutex subsystem, return early with the error.
  136605. ** If the system is so sick that we are unable to allocate a mutex,
  136606. ** there is not much SQLite is going to be able to do.
  136607. **
  136608. ** The mutex subsystem must take care of serializing its own
  136609. ** initialization.
  136610. */
  136611. rc = sqlite3MutexInit();
  136612. if( rc ) return rc;
  136613. /* Initialize the malloc() system and the recursive pInitMutex mutex.
  136614. ** This operation is protected by the STATIC_MASTER mutex. Note that
  136615. ** MutexAlloc() is called for a static mutex prior to initializing the
  136616. ** malloc subsystem - this implies that the allocation of a static
  136617. ** mutex must not require support from the malloc subsystem.
  136618. */
  136619. MUTEX_LOGIC( pMaster = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER); )
  136620. sqlite3_mutex_enter(pMaster);
  136621. sqlite3GlobalConfig.isMutexInit = 1;
  136622. if( !sqlite3GlobalConfig.isMallocInit ){
  136623. rc = sqlite3MallocInit();
  136624. }
  136625. if( rc==SQLITE_OK ){
  136626. sqlite3GlobalConfig.isMallocInit = 1;
  136627. if( !sqlite3GlobalConfig.pInitMutex ){
  136628. sqlite3GlobalConfig.pInitMutex =
  136629. sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
  136630. if( sqlite3GlobalConfig.bCoreMutex && !sqlite3GlobalConfig.pInitMutex ){
  136631. rc = SQLITE_NOMEM_BKPT;
  136632. }
  136633. }
  136634. }
  136635. if( rc==SQLITE_OK ){
  136636. sqlite3GlobalConfig.nRefInitMutex++;
  136637. }
  136638. sqlite3_mutex_leave(pMaster);
  136639. /* If rc is not SQLITE_OK at this point, then either the malloc
  136640. ** subsystem could not be initialized or the system failed to allocate
  136641. ** the pInitMutex mutex. Return an error in either case. */
  136642. if( rc!=SQLITE_OK ){
  136643. return rc;
  136644. }
  136645. /* Do the rest of the initialization under the recursive mutex so
  136646. ** that we will be able to handle recursive calls into
  136647. ** sqlite3_initialize(). The recursive calls normally come through
  136648. ** sqlite3_os_init() when it invokes sqlite3_vfs_register(), but other
  136649. ** recursive calls might also be possible.
  136650. **
  136651. ** IMPLEMENTATION-OF: R-00140-37445 SQLite automatically serializes calls
  136652. ** to the xInit method, so the xInit method need not be threadsafe.
  136653. **
  136654. ** The following mutex is what serializes access to the appdef pcache xInit
  136655. ** methods. The sqlite3_pcache_methods.xInit() all is embedded in the
  136656. ** call to sqlite3PcacheInitialize().
  136657. */
  136658. sqlite3_mutex_enter(sqlite3GlobalConfig.pInitMutex);
  136659. if( sqlite3GlobalConfig.isInit==0 && sqlite3GlobalConfig.inProgress==0 ){
  136660. sqlite3GlobalConfig.inProgress = 1;
  136661. #ifdef SQLITE_ENABLE_SQLLOG
  136662. {
  136663. extern void sqlite3_init_sqllog(void);
  136664. sqlite3_init_sqllog();
  136665. }
  136666. #endif
  136667. memset(&sqlite3BuiltinFunctions, 0, sizeof(sqlite3BuiltinFunctions));
  136668. sqlite3RegisterBuiltinFunctions();
  136669. if( sqlite3GlobalConfig.isPCacheInit==0 ){
  136670. rc = sqlite3PcacheInitialize();
  136671. }
  136672. if( rc==SQLITE_OK ){
  136673. sqlite3GlobalConfig.isPCacheInit = 1;
  136674. rc = sqlite3OsInit();
  136675. }
  136676. #ifdef SQLITE_ENABLE_DESERIALIZE
  136677. if( rc==SQLITE_OK ){
  136678. rc = sqlite3MemdbInit();
  136679. }
  136680. #endif
  136681. if( rc==SQLITE_OK ){
  136682. sqlite3PCacheBufferSetup( sqlite3GlobalConfig.pPage,
  136683. sqlite3GlobalConfig.szPage, sqlite3GlobalConfig.nPage);
  136684. sqlite3GlobalConfig.isInit = 1;
  136685. #ifdef SQLITE_EXTRA_INIT
  136686. bRunExtraInit = 1;
  136687. #endif
  136688. }
  136689. sqlite3GlobalConfig.inProgress = 0;
  136690. }
  136691. sqlite3_mutex_leave(sqlite3GlobalConfig.pInitMutex);
  136692. /* Go back under the static mutex and clean up the recursive
  136693. ** mutex to prevent a resource leak.
  136694. */
  136695. sqlite3_mutex_enter(pMaster);
  136696. sqlite3GlobalConfig.nRefInitMutex--;
  136697. if( sqlite3GlobalConfig.nRefInitMutex<=0 ){
  136698. assert( sqlite3GlobalConfig.nRefInitMutex==0 );
  136699. sqlite3_mutex_free(sqlite3GlobalConfig.pInitMutex);
  136700. sqlite3GlobalConfig.pInitMutex = 0;
  136701. }
  136702. sqlite3_mutex_leave(pMaster);
  136703. /* The following is just a sanity check to make sure SQLite has
  136704. ** been compiled correctly. It is important to run this code, but
  136705. ** we don't want to run it too often and soak up CPU cycles for no
  136706. ** reason. So we run it once during initialization.
  136707. */
  136708. #ifndef NDEBUG
  136709. #ifndef SQLITE_OMIT_FLOATING_POINT
  136710. /* This section of code's only "output" is via assert() statements. */
  136711. if( rc==SQLITE_OK ){
  136712. u64 x = (((u64)1)<<63)-1;
  136713. double y;
  136714. assert(sizeof(x)==8);
  136715. assert(sizeof(x)==sizeof(y));
  136716. memcpy(&y, &x, 8);
  136717. assert( sqlite3IsNaN(y) );
  136718. }
  136719. #endif
  136720. #endif
  136721. /* Do extra initialization steps requested by the SQLITE_EXTRA_INIT
  136722. ** compile-time option.
  136723. */
  136724. #ifdef SQLITE_EXTRA_INIT
  136725. if( bRunExtraInit ){
  136726. int SQLITE_EXTRA_INIT(const char*);
  136727. rc = SQLITE_EXTRA_INIT(0);
  136728. }
  136729. #endif
  136730. return rc;
  136731. }
  136732. /*
  136733. ** Undo the effects of sqlite3_initialize(). Must not be called while
  136734. ** there are outstanding database connections or memory allocations or
  136735. ** while any part of SQLite is otherwise in use in any thread. This
  136736. ** routine is not threadsafe. But it is safe to invoke this routine
  136737. ** on when SQLite is already shut down. If SQLite is already shut down
  136738. ** when this routine is invoked, then this routine is a harmless no-op.
  136739. */
  136740. SQLITE_API int sqlite3_shutdown(void){
  136741. #ifdef SQLITE_OMIT_WSD
  136742. int rc = sqlite3_wsd_init(4096, 24);
  136743. if( rc!=SQLITE_OK ){
  136744. return rc;
  136745. }
  136746. #endif
  136747. if( sqlite3GlobalConfig.isInit ){
  136748. #ifdef SQLITE_EXTRA_SHUTDOWN
  136749. void SQLITE_EXTRA_SHUTDOWN(void);
  136750. SQLITE_EXTRA_SHUTDOWN();
  136751. #endif
  136752. sqlite3_os_end();
  136753. sqlite3_reset_auto_extension();
  136754. sqlite3GlobalConfig.isInit = 0;
  136755. }
  136756. if( sqlite3GlobalConfig.isPCacheInit ){
  136757. sqlite3PcacheShutdown();
  136758. sqlite3GlobalConfig.isPCacheInit = 0;
  136759. }
  136760. if( sqlite3GlobalConfig.isMallocInit ){
  136761. sqlite3MallocEnd();
  136762. sqlite3GlobalConfig.isMallocInit = 0;
  136763. #ifndef SQLITE_OMIT_SHUTDOWN_DIRECTORIES
  136764. /* The heap subsystem has now been shutdown and these values are supposed
  136765. ** to be NULL or point to memory that was obtained from sqlite3_malloc(),
  136766. ** which would rely on that heap subsystem; therefore, make sure these
  136767. ** values cannot refer to heap memory that was just invalidated when the
  136768. ** heap subsystem was shutdown. This is only done if the current call to
  136769. ** this function resulted in the heap subsystem actually being shutdown.
  136770. */
  136771. sqlite3_data_directory = 0;
  136772. sqlite3_temp_directory = 0;
  136773. #endif
  136774. }
  136775. if( sqlite3GlobalConfig.isMutexInit ){
  136776. sqlite3MutexEnd();
  136777. sqlite3GlobalConfig.isMutexInit = 0;
  136778. }
  136779. return SQLITE_OK;
  136780. }
  136781. /*
  136782. ** This API allows applications to modify the global configuration of
  136783. ** the SQLite library at run-time.
  136784. **
  136785. ** This routine should only be called when there are no outstanding
  136786. ** database connections or memory allocations. This routine is not
  136787. ** threadsafe. Failure to heed these warnings can lead to unpredictable
  136788. ** behavior.
  136789. */
  136790. SQLITE_API int sqlite3_config(int op, ...){
  136791. va_list ap;
  136792. int rc = SQLITE_OK;
  136793. /* sqlite3_config() shall return SQLITE_MISUSE if it is invoked while
  136794. ** the SQLite library is in use. */
  136795. if( sqlite3GlobalConfig.isInit ) return SQLITE_MISUSE_BKPT;
  136796. va_start(ap, op);
  136797. switch( op ){
  136798. /* Mutex configuration options are only available in a threadsafe
  136799. ** compile.
  136800. */
  136801. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-54466-46756 */
  136802. case SQLITE_CONFIG_SINGLETHREAD: {
  136803. /* EVIDENCE-OF: R-02748-19096 This option sets the threading mode to
  136804. ** Single-thread. */
  136805. sqlite3GlobalConfig.bCoreMutex = 0; /* Disable mutex on core */
  136806. sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
  136807. break;
  136808. }
  136809. #endif
  136810. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-20520-54086 */
  136811. case SQLITE_CONFIG_MULTITHREAD: {
  136812. /* EVIDENCE-OF: R-14374-42468 This option sets the threading mode to
  136813. ** Multi-thread. */
  136814. sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
  136815. sqlite3GlobalConfig.bFullMutex = 0; /* Disable mutex on connections */
  136816. break;
  136817. }
  136818. #endif
  136819. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-59593-21810 */
  136820. case SQLITE_CONFIG_SERIALIZED: {
  136821. /* EVIDENCE-OF: R-41220-51800 This option sets the threading mode to
  136822. ** Serialized. */
  136823. sqlite3GlobalConfig.bCoreMutex = 1; /* Enable mutex on core */
  136824. sqlite3GlobalConfig.bFullMutex = 1; /* Enable mutex on connections */
  136825. break;
  136826. }
  136827. #endif
  136828. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-63666-48755 */
  136829. case SQLITE_CONFIG_MUTEX: {
  136830. /* Specify an alternative mutex implementation */
  136831. sqlite3GlobalConfig.mutex = *va_arg(ap, sqlite3_mutex_methods*);
  136832. break;
  136833. }
  136834. #endif
  136835. #if defined(SQLITE_THREADSAFE) && SQLITE_THREADSAFE>0 /* IMP: R-14450-37597 */
  136836. case SQLITE_CONFIG_GETMUTEX: {
  136837. /* Retrieve the current mutex implementation */
  136838. *va_arg(ap, sqlite3_mutex_methods*) = sqlite3GlobalConfig.mutex;
  136839. break;
  136840. }
  136841. #endif
  136842. case SQLITE_CONFIG_MALLOC: {
  136843. /* EVIDENCE-OF: R-55594-21030 The SQLITE_CONFIG_MALLOC option takes a
  136844. ** single argument which is a pointer to an instance of the
  136845. ** sqlite3_mem_methods structure. The argument specifies alternative
  136846. ** low-level memory allocation routines to be used in place of the memory
  136847. ** allocation routines built into SQLite. */
  136848. sqlite3GlobalConfig.m = *va_arg(ap, sqlite3_mem_methods*);
  136849. break;
  136850. }
  136851. case SQLITE_CONFIG_GETMALLOC: {
  136852. /* EVIDENCE-OF: R-51213-46414 The SQLITE_CONFIG_GETMALLOC option takes a
  136853. ** single argument which is a pointer to an instance of the
  136854. ** sqlite3_mem_methods structure. The sqlite3_mem_methods structure is
  136855. ** filled with the currently defined memory allocation routines. */
  136856. if( sqlite3GlobalConfig.m.xMalloc==0 ) sqlite3MemSetDefault();
  136857. *va_arg(ap, sqlite3_mem_methods*) = sqlite3GlobalConfig.m;
  136858. break;
  136859. }
  136860. case SQLITE_CONFIG_MEMSTATUS: {
  136861. /* EVIDENCE-OF: R-61275-35157 The SQLITE_CONFIG_MEMSTATUS option takes
  136862. ** single argument of type int, interpreted as a boolean, which enables
  136863. ** or disables the collection of memory allocation statistics. */
  136864. sqlite3GlobalConfig.bMemstat = va_arg(ap, int);
  136865. break;
  136866. }
  136867. case SQLITE_CONFIG_SMALL_MALLOC: {
  136868. sqlite3GlobalConfig.bSmallMalloc = va_arg(ap, int);
  136869. break;
  136870. }
  136871. case SQLITE_CONFIG_PAGECACHE: {
  136872. /* EVIDENCE-OF: R-18761-36601 There are three arguments to
  136873. ** SQLITE_CONFIG_PAGECACHE: A pointer to 8-byte aligned memory (pMem),
  136874. ** the size of each page cache line (sz), and the number of cache lines
  136875. ** (N). */
  136876. sqlite3GlobalConfig.pPage = va_arg(ap, void*);
  136877. sqlite3GlobalConfig.szPage = va_arg(ap, int);
  136878. sqlite3GlobalConfig.nPage = va_arg(ap, int);
  136879. break;
  136880. }
  136881. case SQLITE_CONFIG_PCACHE_HDRSZ: {
  136882. /* EVIDENCE-OF: R-39100-27317 The SQLITE_CONFIG_PCACHE_HDRSZ option takes
  136883. ** a single parameter which is a pointer to an integer and writes into
  136884. ** that integer the number of extra bytes per page required for each page
  136885. ** in SQLITE_CONFIG_PAGECACHE. */
  136886. *va_arg(ap, int*) =
  136887. sqlite3HeaderSizeBtree() +
  136888. sqlite3HeaderSizePcache() +
  136889. sqlite3HeaderSizePcache1();
  136890. break;
  136891. }
  136892. case SQLITE_CONFIG_PCACHE: {
  136893. /* no-op */
  136894. break;
  136895. }
  136896. case SQLITE_CONFIG_GETPCACHE: {
  136897. /* now an error */
  136898. rc = SQLITE_ERROR;
  136899. break;
  136900. }
  136901. case SQLITE_CONFIG_PCACHE2: {
  136902. /* EVIDENCE-OF: R-63325-48378 The SQLITE_CONFIG_PCACHE2 option takes a
  136903. ** single argument which is a pointer to an sqlite3_pcache_methods2
  136904. ** object. This object specifies the interface to a custom page cache
  136905. ** implementation. */
  136906. sqlite3GlobalConfig.pcache2 = *va_arg(ap, sqlite3_pcache_methods2*);
  136907. break;
  136908. }
  136909. case SQLITE_CONFIG_GETPCACHE2: {
  136910. /* EVIDENCE-OF: R-22035-46182 The SQLITE_CONFIG_GETPCACHE2 option takes a
  136911. ** single argument which is a pointer to an sqlite3_pcache_methods2
  136912. ** object. SQLite copies of the current page cache implementation into
  136913. ** that object. */
  136914. if( sqlite3GlobalConfig.pcache2.xInit==0 ){
  136915. sqlite3PCacheSetDefault();
  136916. }
  136917. *va_arg(ap, sqlite3_pcache_methods2*) = sqlite3GlobalConfig.pcache2;
  136918. break;
  136919. }
  136920. /* EVIDENCE-OF: R-06626-12911 The SQLITE_CONFIG_HEAP option is only
  136921. ** available if SQLite is compiled with either SQLITE_ENABLE_MEMSYS3 or
  136922. ** SQLITE_ENABLE_MEMSYS5 and returns SQLITE_ERROR if invoked otherwise. */
  136923. #if defined(SQLITE_ENABLE_MEMSYS3) || defined(SQLITE_ENABLE_MEMSYS5)
  136924. case SQLITE_CONFIG_HEAP: {
  136925. /* EVIDENCE-OF: R-19854-42126 There are three arguments to
  136926. ** SQLITE_CONFIG_HEAP: An 8-byte aligned pointer to the memory, the
  136927. ** number of bytes in the memory buffer, and the minimum allocation size.
  136928. */
  136929. sqlite3GlobalConfig.pHeap = va_arg(ap, void*);
  136930. sqlite3GlobalConfig.nHeap = va_arg(ap, int);
  136931. sqlite3GlobalConfig.mnReq = va_arg(ap, int);
  136932. if( sqlite3GlobalConfig.mnReq<1 ){
  136933. sqlite3GlobalConfig.mnReq = 1;
  136934. }else if( sqlite3GlobalConfig.mnReq>(1<<12) ){
  136935. /* cap min request size at 2^12 */
  136936. sqlite3GlobalConfig.mnReq = (1<<12);
  136937. }
  136938. if( sqlite3GlobalConfig.pHeap==0 ){
  136939. /* EVIDENCE-OF: R-49920-60189 If the first pointer (the memory pointer)
  136940. ** is NULL, then SQLite reverts to using its default memory allocator
  136941. ** (the system malloc() implementation), undoing any prior invocation of
  136942. ** SQLITE_CONFIG_MALLOC.
  136943. **
  136944. ** Setting sqlite3GlobalConfig.m to all zeros will cause malloc to
  136945. ** revert to its default implementation when sqlite3_initialize() is run
  136946. */
  136947. memset(&sqlite3GlobalConfig.m, 0, sizeof(sqlite3GlobalConfig.m));
  136948. }else{
  136949. /* EVIDENCE-OF: R-61006-08918 If the memory pointer is not NULL then the
  136950. ** alternative memory allocator is engaged to handle all of SQLites
  136951. ** memory allocation needs. */
  136952. #ifdef SQLITE_ENABLE_MEMSYS3
  136953. sqlite3GlobalConfig.m = *sqlite3MemGetMemsys3();
  136954. #endif
  136955. #ifdef SQLITE_ENABLE_MEMSYS5
  136956. sqlite3GlobalConfig.m = *sqlite3MemGetMemsys5();
  136957. #endif
  136958. }
  136959. break;
  136960. }
  136961. #endif
  136962. case SQLITE_CONFIG_LOOKASIDE: {
  136963. sqlite3GlobalConfig.szLookaside = va_arg(ap, int);
  136964. sqlite3GlobalConfig.nLookaside = va_arg(ap, int);
  136965. break;
  136966. }
  136967. /* Record a pointer to the logger function and its first argument.
  136968. ** The default is NULL. Logging is disabled if the function pointer is
  136969. ** NULL.
  136970. */
  136971. case SQLITE_CONFIG_LOG: {
  136972. /* MSVC is picky about pulling func ptrs from va lists.
  136973. ** http://support.microsoft.com/kb/47961
  136974. ** sqlite3GlobalConfig.xLog = va_arg(ap, void(*)(void*,int,const char*));
  136975. */
  136976. typedef void(*LOGFUNC_t)(void*,int,const char*);
  136977. sqlite3GlobalConfig.xLog = va_arg(ap, LOGFUNC_t);
  136978. sqlite3GlobalConfig.pLogArg = va_arg(ap, void*);
  136979. break;
  136980. }
  136981. /* EVIDENCE-OF: R-55548-33817 The compile-time setting for URI filenames
  136982. ** can be changed at start-time using the
  136983. ** sqlite3_config(SQLITE_CONFIG_URI,1) or
  136984. ** sqlite3_config(SQLITE_CONFIG_URI,0) configuration calls.
  136985. */
  136986. case SQLITE_CONFIG_URI: {
  136987. /* EVIDENCE-OF: R-25451-61125 The SQLITE_CONFIG_URI option takes a single
  136988. ** argument of type int. If non-zero, then URI handling is globally
  136989. ** enabled. If the parameter is zero, then URI handling is globally
  136990. ** disabled. */
  136991. sqlite3GlobalConfig.bOpenUri = va_arg(ap, int);
  136992. break;
  136993. }
  136994. case SQLITE_CONFIG_COVERING_INDEX_SCAN: {
  136995. /* EVIDENCE-OF: R-36592-02772 The SQLITE_CONFIG_COVERING_INDEX_SCAN
  136996. ** option takes a single integer argument which is interpreted as a
  136997. ** boolean in order to enable or disable the use of covering indices for
  136998. ** full table scans in the query optimizer. */
  136999. sqlite3GlobalConfig.bUseCis = va_arg(ap, int);
  137000. break;
  137001. }
  137002. #ifdef SQLITE_ENABLE_SQLLOG
  137003. case SQLITE_CONFIG_SQLLOG: {
  137004. typedef void(*SQLLOGFUNC_t)(void*, sqlite3*, const char*, int);
  137005. sqlite3GlobalConfig.xSqllog = va_arg(ap, SQLLOGFUNC_t);
  137006. sqlite3GlobalConfig.pSqllogArg = va_arg(ap, void *);
  137007. break;
  137008. }
  137009. #endif
  137010. case SQLITE_CONFIG_MMAP_SIZE: {
  137011. /* EVIDENCE-OF: R-58063-38258 SQLITE_CONFIG_MMAP_SIZE takes two 64-bit
  137012. ** integer (sqlite3_int64) values that are the default mmap size limit
  137013. ** (the default setting for PRAGMA mmap_size) and the maximum allowed
  137014. ** mmap size limit. */
  137015. sqlite3_int64 szMmap = va_arg(ap, sqlite3_int64);
  137016. sqlite3_int64 mxMmap = va_arg(ap, sqlite3_int64);
  137017. /* EVIDENCE-OF: R-53367-43190 If either argument to this option is
  137018. ** negative, then that argument is changed to its compile-time default.
  137019. **
  137020. ** EVIDENCE-OF: R-34993-45031 The maximum allowed mmap size will be
  137021. ** silently truncated if necessary so that it does not exceed the
  137022. ** compile-time maximum mmap size set by the SQLITE_MAX_MMAP_SIZE
  137023. ** compile-time option.
  137024. */
  137025. if( mxMmap<0 || mxMmap>SQLITE_MAX_MMAP_SIZE ){
  137026. mxMmap = SQLITE_MAX_MMAP_SIZE;
  137027. }
  137028. if( szMmap<0 ) szMmap = SQLITE_DEFAULT_MMAP_SIZE;
  137029. if( szMmap>mxMmap) szMmap = mxMmap;
  137030. sqlite3GlobalConfig.mxMmap = mxMmap;
  137031. sqlite3GlobalConfig.szMmap = szMmap;
  137032. break;
  137033. }
  137034. #if SQLITE_OS_WIN && defined(SQLITE_WIN32_MALLOC) /* IMP: R-04780-55815 */
  137035. case SQLITE_CONFIG_WIN32_HEAPSIZE: {
  137036. /* EVIDENCE-OF: R-34926-03360 SQLITE_CONFIG_WIN32_HEAPSIZE takes a 32-bit
  137037. ** unsigned integer value that specifies the maximum size of the created
  137038. ** heap. */
  137039. sqlite3GlobalConfig.nHeap = va_arg(ap, int);
  137040. break;
  137041. }
  137042. #endif
  137043. case SQLITE_CONFIG_PMASZ: {
  137044. sqlite3GlobalConfig.szPma = va_arg(ap, unsigned int);
  137045. break;
  137046. }
  137047. case SQLITE_CONFIG_STMTJRNL_SPILL: {
  137048. sqlite3GlobalConfig.nStmtSpill = va_arg(ap, int);
  137049. break;
  137050. }
  137051. default: {
  137052. rc = SQLITE_ERROR;
  137053. break;
  137054. }
  137055. }
  137056. va_end(ap);
  137057. return rc;
  137058. }
  137059. /*
  137060. ** Set up the lookaside buffers for a database connection.
  137061. ** Return SQLITE_OK on success.
  137062. ** If lookaside is already active, return SQLITE_BUSY.
  137063. **
  137064. ** The sz parameter is the number of bytes in each lookaside slot.
  137065. ** The cnt parameter is the number of slots. If pStart is NULL the
  137066. ** space for the lookaside memory is obtained from sqlite3_malloc().
  137067. ** If pStart is not NULL then it is sz*cnt bytes of memory to use for
  137068. ** the lookaside memory.
  137069. */
  137070. static int setupLookaside(sqlite3 *db, void *pBuf, int sz, int cnt){
  137071. #ifndef SQLITE_OMIT_LOOKASIDE
  137072. void *pStart;
  137073. if( sqlite3LookasideUsed(db,0)>0 ){
  137074. return SQLITE_BUSY;
  137075. }
  137076. /* Free any existing lookaside buffer for this handle before
  137077. ** allocating a new one so we don't have to have space for
  137078. ** both at the same time.
  137079. */
  137080. if( db->lookaside.bMalloced ){
  137081. sqlite3_free(db->lookaside.pStart);
  137082. }
  137083. /* The size of a lookaside slot after ROUNDDOWN8 needs to be larger
  137084. ** than a pointer to be useful.
  137085. */
  137086. sz = ROUNDDOWN8(sz); /* IMP: R-33038-09382 */
  137087. if( sz<=(int)sizeof(LookasideSlot*) ) sz = 0;
  137088. if( cnt<0 ) cnt = 0;
  137089. if( sz==0 || cnt==0 ){
  137090. sz = 0;
  137091. pStart = 0;
  137092. }else if( pBuf==0 ){
  137093. sqlite3BeginBenignMalloc();
  137094. pStart = sqlite3Malloc( sz*cnt ); /* IMP: R-61949-35727 */
  137095. sqlite3EndBenignMalloc();
  137096. if( pStart ) cnt = sqlite3MallocSize(pStart)/sz;
  137097. }else{
  137098. pStart = pBuf;
  137099. }
  137100. db->lookaside.pStart = pStart;
  137101. db->lookaside.pInit = 0;
  137102. db->lookaside.pFree = 0;
  137103. db->lookaside.sz = (u16)sz;
  137104. if( pStart ){
  137105. int i;
  137106. LookasideSlot *p;
  137107. assert( sz > (int)sizeof(LookasideSlot*) );
  137108. db->lookaside.nSlot = cnt;
  137109. p = (LookasideSlot*)pStart;
  137110. for(i=cnt-1; i>=0; i--){
  137111. p->pNext = db->lookaside.pInit;
  137112. db->lookaside.pInit = p;
  137113. p = (LookasideSlot*)&((u8*)p)[sz];
  137114. }
  137115. db->lookaside.pEnd = p;
  137116. db->lookaside.bDisable = 0;
  137117. db->lookaside.bMalloced = pBuf==0 ?1:0;
  137118. }else{
  137119. db->lookaside.pStart = db;
  137120. db->lookaside.pEnd = db;
  137121. db->lookaside.bDisable = 1;
  137122. db->lookaside.bMalloced = 0;
  137123. db->lookaside.nSlot = 0;
  137124. }
  137125. #endif /* SQLITE_OMIT_LOOKASIDE */
  137126. return SQLITE_OK;
  137127. }
  137128. /*
  137129. ** Return the mutex associated with a database connection.
  137130. */
  137131. SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3 *db){
  137132. #ifdef SQLITE_ENABLE_API_ARMOR
  137133. if( !sqlite3SafetyCheckOk(db) ){
  137134. (void)SQLITE_MISUSE_BKPT;
  137135. return 0;
  137136. }
  137137. #endif
  137138. return db->mutex;
  137139. }
  137140. /*
  137141. ** Free up as much memory as we can from the given database
  137142. ** connection.
  137143. */
  137144. SQLITE_API int sqlite3_db_release_memory(sqlite3 *db){
  137145. int i;
  137146. #ifdef SQLITE_ENABLE_API_ARMOR
  137147. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  137148. #endif
  137149. sqlite3_mutex_enter(db->mutex);
  137150. sqlite3BtreeEnterAll(db);
  137151. for(i=0; i<db->nDb; i++){
  137152. Btree *pBt = db->aDb[i].pBt;
  137153. if( pBt ){
  137154. Pager *pPager = sqlite3BtreePager(pBt);
  137155. sqlite3PagerShrink(pPager);
  137156. }
  137157. }
  137158. sqlite3BtreeLeaveAll(db);
  137159. sqlite3_mutex_leave(db->mutex);
  137160. return SQLITE_OK;
  137161. }
  137162. /*
  137163. ** Flush any dirty pages in the pager-cache for any attached database
  137164. ** to disk.
  137165. */
  137166. SQLITE_API int sqlite3_db_cacheflush(sqlite3 *db){
  137167. int i;
  137168. int rc = SQLITE_OK;
  137169. int bSeenBusy = 0;
  137170. #ifdef SQLITE_ENABLE_API_ARMOR
  137171. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  137172. #endif
  137173. sqlite3_mutex_enter(db->mutex);
  137174. sqlite3BtreeEnterAll(db);
  137175. for(i=0; rc==SQLITE_OK && i<db->nDb; i++){
  137176. Btree *pBt = db->aDb[i].pBt;
  137177. if( pBt && sqlite3BtreeIsInTrans(pBt) ){
  137178. Pager *pPager = sqlite3BtreePager(pBt);
  137179. rc = sqlite3PagerFlush(pPager);
  137180. if( rc==SQLITE_BUSY ){
  137181. bSeenBusy = 1;
  137182. rc = SQLITE_OK;
  137183. }
  137184. }
  137185. }
  137186. sqlite3BtreeLeaveAll(db);
  137187. sqlite3_mutex_leave(db->mutex);
  137188. return ((rc==SQLITE_OK && bSeenBusy) ? SQLITE_BUSY : rc);
  137189. }
  137190. /*
  137191. ** Configuration settings for an individual database connection
  137192. */
  137193. SQLITE_API int sqlite3_db_config(sqlite3 *db, int op, ...){
  137194. va_list ap;
  137195. int rc;
  137196. va_start(ap, op);
  137197. switch( op ){
  137198. case SQLITE_DBCONFIG_MAINDBNAME: {
  137199. /* IMP: R-06824-28531 */
  137200. /* IMP: R-36257-52125 */
  137201. db->aDb[0].zDbSName = va_arg(ap,char*);
  137202. rc = SQLITE_OK;
  137203. break;
  137204. }
  137205. case SQLITE_DBCONFIG_LOOKASIDE: {
  137206. void *pBuf = va_arg(ap, void*); /* IMP: R-26835-10964 */
  137207. int sz = va_arg(ap, int); /* IMP: R-47871-25994 */
  137208. int cnt = va_arg(ap, int); /* IMP: R-04460-53386 */
  137209. rc = setupLookaside(db, pBuf, sz, cnt);
  137210. break;
  137211. }
  137212. default: {
  137213. static const struct {
  137214. int op; /* The opcode */
  137215. u32 mask; /* Mask of the bit in sqlite3.flags to set/clear */
  137216. } aFlagOp[] = {
  137217. { SQLITE_DBCONFIG_ENABLE_FKEY, SQLITE_ForeignKeys },
  137218. { SQLITE_DBCONFIG_ENABLE_TRIGGER, SQLITE_EnableTrigger },
  137219. { SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, SQLITE_Fts3Tokenizer },
  137220. { SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION, SQLITE_LoadExtension },
  137221. { SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE, SQLITE_NoCkptOnClose },
  137222. { SQLITE_DBCONFIG_ENABLE_QPSG, SQLITE_EnableQPSG },
  137223. { SQLITE_DBCONFIG_TRIGGER_EQP, SQLITE_TriggerEQP },
  137224. };
  137225. unsigned int i;
  137226. rc = SQLITE_ERROR; /* IMP: R-42790-23372 */
  137227. for(i=0; i<ArraySize(aFlagOp); i++){
  137228. if( aFlagOp[i].op==op ){
  137229. int onoff = va_arg(ap, int);
  137230. int *pRes = va_arg(ap, int*);
  137231. u32 oldFlags = db->flags;
  137232. if( onoff>0 ){
  137233. db->flags |= aFlagOp[i].mask;
  137234. }else if( onoff==0 ){
  137235. db->flags &= ~aFlagOp[i].mask;
  137236. }
  137237. if( oldFlags!=db->flags ){
  137238. sqlite3ExpirePreparedStatements(db);
  137239. }
  137240. if( pRes ){
  137241. *pRes = (db->flags & aFlagOp[i].mask)!=0;
  137242. }
  137243. rc = SQLITE_OK;
  137244. break;
  137245. }
  137246. }
  137247. break;
  137248. }
  137249. }
  137250. va_end(ap);
  137251. return rc;
  137252. }
  137253. /*
  137254. ** Return true if the buffer z[0..n-1] contains all spaces.
  137255. */
  137256. static int allSpaces(const char *z, int n){
  137257. while( n>0 && z[n-1]==' ' ){ n--; }
  137258. return n==0;
  137259. }
  137260. /*
  137261. ** This is the default collating function named "BINARY" which is always
  137262. ** available.
  137263. **
  137264. ** If the padFlag argument is not NULL then space padding at the end
  137265. ** of strings is ignored. This implements the RTRIM collation.
  137266. */
  137267. static int binCollFunc(
  137268. void *padFlag,
  137269. int nKey1, const void *pKey1,
  137270. int nKey2, const void *pKey2
  137271. ){
  137272. int rc, n;
  137273. n = nKey1<nKey2 ? nKey1 : nKey2;
  137274. /* EVIDENCE-OF: R-65033-28449 The built-in BINARY collation compares
  137275. ** strings byte by byte using the memcmp() function from the standard C
  137276. ** library. */
  137277. assert( pKey1 && pKey2 );
  137278. rc = memcmp(pKey1, pKey2, n);
  137279. if( rc==0 ){
  137280. if( padFlag
  137281. && allSpaces(((char*)pKey1)+n, nKey1-n)
  137282. && allSpaces(((char*)pKey2)+n, nKey2-n)
  137283. ){
  137284. /* EVIDENCE-OF: R-31624-24737 RTRIM is like BINARY except that extra
  137285. ** spaces at the end of either string do not change the result. In other
  137286. ** words, strings will compare equal to one another as long as they
  137287. ** differ only in the number of spaces at the end.
  137288. */
  137289. }else{
  137290. rc = nKey1 - nKey2;
  137291. }
  137292. }
  137293. return rc;
  137294. }
  137295. /*
  137296. ** Another built-in collating sequence: NOCASE.
  137297. **
  137298. ** This collating sequence is intended to be used for "case independent
  137299. ** comparison". SQLite's knowledge of upper and lower case equivalents
  137300. ** extends only to the 26 characters used in the English language.
  137301. **
  137302. ** At the moment there is only a UTF-8 implementation.
  137303. */
  137304. static int nocaseCollatingFunc(
  137305. void *NotUsed,
  137306. int nKey1, const void *pKey1,
  137307. int nKey2, const void *pKey2
  137308. ){
  137309. int r = sqlite3StrNICmp(
  137310. (const char *)pKey1, (const char *)pKey2, (nKey1<nKey2)?nKey1:nKey2);
  137311. UNUSED_PARAMETER(NotUsed);
  137312. if( 0==r ){
  137313. r = nKey1-nKey2;
  137314. }
  137315. return r;
  137316. }
  137317. /*
  137318. ** Return the ROWID of the most recent insert
  137319. */
  137320. SQLITE_API sqlite_int64 sqlite3_last_insert_rowid(sqlite3 *db){
  137321. #ifdef SQLITE_ENABLE_API_ARMOR
  137322. if( !sqlite3SafetyCheckOk(db) ){
  137323. (void)SQLITE_MISUSE_BKPT;
  137324. return 0;
  137325. }
  137326. #endif
  137327. return db->lastRowid;
  137328. }
  137329. /*
  137330. ** Set the value returned by the sqlite3_last_insert_rowid() API function.
  137331. */
  137332. SQLITE_API void sqlite3_set_last_insert_rowid(sqlite3 *db, sqlite3_int64 iRowid){
  137333. #ifdef SQLITE_ENABLE_API_ARMOR
  137334. if( !sqlite3SafetyCheckOk(db) ){
  137335. (void)SQLITE_MISUSE_BKPT;
  137336. return;
  137337. }
  137338. #endif
  137339. sqlite3_mutex_enter(db->mutex);
  137340. db->lastRowid = iRowid;
  137341. sqlite3_mutex_leave(db->mutex);
  137342. }
  137343. /*
  137344. ** Return the number of changes in the most recent call to sqlite3_exec().
  137345. */
  137346. SQLITE_API int sqlite3_changes(sqlite3 *db){
  137347. #ifdef SQLITE_ENABLE_API_ARMOR
  137348. if( !sqlite3SafetyCheckOk(db) ){
  137349. (void)SQLITE_MISUSE_BKPT;
  137350. return 0;
  137351. }
  137352. #endif
  137353. return db->nChange;
  137354. }
  137355. /*
  137356. ** Return the number of changes since the database handle was opened.
  137357. */
  137358. SQLITE_API int sqlite3_total_changes(sqlite3 *db){
  137359. #ifdef SQLITE_ENABLE_API_ARMOR
  137360. if( !sqlite3SafetyCheckOk(db) ){
  137361. (void)SQLITE_MISUSE_BKPT;
  137362. return 0;
  137363. }
  137364. #endif
  137365. return db->nTotalChange;
  137366. }
  137367. /*
  137368. ** Close all open savepoints. This function only manipulates fields of the
  137369. ** database handle object, it does not close any savepoints that may be open
  137370. ** at the b-tree/pager level.
  137371. */
  137372. SQLITE_PRIVATE void sqlite3CloseSavepoints(sqlite3 *db){
  137373. while( db->pSavepoint ){
  137374. Savepoint *pTmp = db->pSavepoint;
  137375. db->pSavepoint = pTmp->pNext;
  137376. sqlite3DbFree(db, pTmp);
  137377. }
  137378. db->nSavepoint = 0;
  137379. db->nStatement = 0;
  137380. db->isTransactionSavepoint = 0;
  137381. }
  137382. /*
  137383. ** Invoke the destructor function associated with FuncDef p, if any. Except,
  137384. ** if this is not the last copy of the function, do not invoke it. Multiple
  137385. ** copies of a single function are created when create_function() is called
  137386. ** with SQLITE_ANY as the encoding.
  137387. */
  137388. static void functionDestroy(sqlite3 *db, FuncDef *p){
  137389. FuncDestructor *pDestructor = p->u.pDestructor;
  137390. if( pDestructor ){
  137391. pDestructor->nRef--;
  137392. if( pDestructor->nRef==0 ){
  137393. pDestructor->xDestroy(pDestructor->pUserData);
  137394. sqlite3DbFree(db, pDestructor);
  137395. }
  137396. }
  137397. }
  137398. /*
  137399. ** Disconnect all sqlite3_vtab objects that belong to database connection
  137400. ** db. This is called when db is being closed.
  137401. */
  137402. static void disconnectAllVtab(sqlite3 *db){
  137403. #ifndef SQLITE_OMIT_VIRTUALTABLE
  137404. int i;
  137405. HashElem *p;
  137406. sqlite3BtreeEnterAll(db);
  137407. for(i=0; i<db->nDb; i++){
  137408. Schema *pSchema = db->aDb[i].pSchema;
  137409. if( db->aDb[i].pSchema ){
  137410. for(p=sqliteHashFirst(&pSchema->tblHash); p; p=sqliteHashNext(p)){
  137411. Table *pTab = (Table *)sqliteHashData(p);
  137412. if( IsVirtual(pTab) ) sqlite3VtabDisconnect(db, pTab);
  137413. }
  137414. }
  137415. }
  137416. for(p=sqliteHashFirst(&db->aModule); p; p=sqliteHashNext(p)){
  137417. Module *pMod = (Module *)sqliteHashData(p);
  137418. if( pMod->pEpoTab ){
  137419. sqlite3VtabDisconnect(db, pMod->pEpoTab);
  137420. }
  137421. }
  137422. sqlite3VtabUnlockList(db);
  137423. sqlite3BtreeLeaveAll(db);
  137424. #else
  137425. UNUSED_PARAMETER(db);
  137426. #endif
  137427. }
  137428. /*
  137429. ** Return TRUE if database connection db has unfinalized prepared
  137430. ** statements or unfinished sqlite3_backup objects.
  137431. */
  137432. static int connectionIsBusy(sqlite3 *db){
  137433. int j;
  137434. assert( sqlite3_mutex_held(db->mutex) );
  137435. if( db->pVdbe ) return 1;
  137436. for(j=0; j<db->nDb; j++){
  137437. Btree *pBt = db->aDb[j].pBt;
  137438. if( pBt && sqlite3BtreeIsInBackup(pBt) ) return 1;
  137439. }
  137440. return 0;
  137441. }
  137442. /*
  137443. ** Close an existing SQLite database
  137444. */
  137445. static int sqlite3Close(sqlite3 *db, int forceZombie){
  137446. if( !db ){
  137447. /* EVIDENCE-OF: R-63257-11740 Calling sqlite3_close() or
  137448. ** sqlite3_close_v2() with a NULL pointer argument is a harmless no-op. */
  137449. return SQLITE_OK;
  137450. }
  137451. if( !sqlite3SafetyCheckSickOrOk(db) ){
  137452. return SQLITE_MISUSE_BKPT;
  137453. }
  137454. sqlite3_mutex_enter(db->mutex);
  137455. if( db->mTrace & SQLITE_TRACE_CLOSE ){
  137456. db->xTrace(SQLITE_TRACE_CLOSE, db->pTraceArg, db, 0);
  137457. }
  137458. /* Force xDisconnect calls on all virtual tables */
  137459. disconnectAllVtab(db);
  137460. /* If a transaction is open, the disconnectAllVtab() call above
  137461. ** will not have called the xDisconnect() method on any virtual
  137462. ** tables in the db->aVTrans[] array. The following sqlite3VtabRollback()
  137463. ** call will do so. We need to do this before the check for active
  137464. ** SQL statements below, as the v-table implementation may be storing
  137465. ** some prepared statements internally.
  137466. */
  137467. sqlite3VtabRollback(db);
  137468. /* Legacy behavior (sqlite3_close() behavior) is to return
  137469. ** SQLITE_BUSY if the connection can not be closed immediately.
  137470. */
  137471. if( !forceZombie && connectionIsBusy(db) ){
  137472. sqlite3ErrorWithMsg(db, SQLITE_BUSY, "unable to close due to unfinalized "
  137473. "statements or unfinished backups");
  137474. sqlite3_mutex_leave(db->mutex);
  137475. return SQLITE_BUSY;
  137476. }
  137477. #ifdef SQLITE_ENABLE_SQLLOG
  137478. if( sqlite3GlobalConfig.xSqllog ){
  137479. /* Closing the handle. Fourth parameter is passed the value 2. */
  137480. sqlite3GlobalConfig.xSqllog(sqlite3GlobalConfig.pSqllogArg, db, 0, 2);
  137481. }
  137482. #endif
  137483. /* Convert the connection into a zombie and then close it.
  137484. */
  137485. db->magic = SQLITE_MAGIC_ZOMBIE;
  137486. sqlite3LeaveMutexAndCloseZombie(db);
  137487. return SQLITE_OK;
  137488. }
  137489. /*
  137490. ** Two variations on the public interface for closing a database
  137491. ** connection. The sqlite3_close() version returns SQLITE_BUSY and
  137492. ** leaves the connection option if there are unfinalized prepared
  137493. ** statements or unfinished sqlite3_backups. The sqlite3_close_v2()
  137494. ** version forces the connection to become a zombie if there are
  137495. ** unclosed resources, and arranges for deallocation when the last
  137496. ** prepare statement or sqlite3_backup closes.
  137497. */
  137498. SQLITE_API int sqlite3_close(sqlite3 *db){ return sqlite3Close(db,0); }
  137499. SQLITE_API int sqlite3_close_v2(sqlite3 *db){ return sqlite3Close(db,1); }
  137500. /*
  137501. ** Close the mutex on database connection db.
  137502. **
  137503. ** Furthermore, if database connection db is a zombie (meaning that there
  137504. ** has been a prior call to sqlite3_close(db) or sqlite3_close_v2(db)) and
  137505. ** every sqlite3_stmt has now been finalized and every sqlite3_backup has
  137506. ** finished, then free all resources.
  137507. */
  137508. SQLITE_PRIVATE void sqlite3LeaveMutexAndCloseZombie(sqlite3 *db){
  137509. HashElem *i; /* Hash table iterator */
  137510. int j;
  137511. /* If there are outstanding sqlite3_stmt or sqlite3_backup objects
  137512. ** or if the connection has not yet been closed by sqlite3_close_v2(),
  137513. ** then just leave the mutex and return.
  137514. */
  137515. if( db->magic!=SQLITE_MAGIC_ZOMBIE || connectionIsBusy(db) ){
  137516. sqlite3_mutex_leave(db->mutex);
  137517. return;
  137518. }
  137519. /* If we reach this point, it means that the database connection has
  137520. ** closed all sqlite3_stmt and sqlite3_backup objects and has been
  137521. ** passed to sqlite3_close (meaning that it is a zombie). Therefore,
  137522. ** go ahead and free all resources.
  137523. */
  137524. /* If a transaction is open, roll it back. This also ensures that if
  137525. ** any database schemas have been modified by an uncommitted transaction
  137526. ** they are reset. And that the required b-tree mutex is held to make
  137527. ** the pager rollback and schema reset an atomic operation. */
  137528. sqlite3RollbackAll(db, SQLITE_OK);
  137529. /* Free any outstanding Savepoint structures. */
  137530. sqlite3CloseSavepoints(db);
  137531. /* Close all database connections */
  137532. for(j=0; j<db->nDb; j++){
  137533. struct Db *pDb = &db->aDb[j];
  137534. if( pDb->pBt ){
  137535. sqlite3BtreeClose(pDb->pBt);
  137536. pDb->pBt = 0;
  137537. if( j!=1 ){
  137538. pDb->pSchema = 0;
  137539. }
  137540. }
  137541. }
  137542. /* Clear the TEMP schema separately and last */
  137543. if( db->aDb[1].pSchema ){
  137544. sqlite3SchemaClear(db->aDb[1].pSchema);
  137545. }
  137546. sqlite3VtabUnlockList(db);
  137547. /* Free up the array of auxiliary databases */
  137548. sqlite3CollapseDatabaseArray(db);
  137549. assert( db->nDb<=2 );
  137550. assert( db->aDb==db->aDbStatic );
  137551. /* Tell the code in notify.c that the connection no longer holds any
  137552. ** locks and does not require any further unlock-notify callbacks.
  137553. */
  137554. sqlite3ConnectionClosed(db);
  137555. for(i=sqliteHashFirst(&db->aFunc); i; i=sqliteHashNext(i)){
  137556. FuncDef *pNext, *p;
  137557. p = sqliteHashData(i);
  137558. do{
  137559. functionDestroy(db, p);
  137560. pNext = p->pNext;
  137561. sqlite3DbFree(db, p);
  137562. p = pNext;
  137563. }while( p );
  137564. }
  137565. sqlite3HashClear(&db->aFunc);
  137566. for(i=sqliteHashFirst(&db->aCollSeq); i; i=sqliteHashNext(i)){
  137567. CollSeq *pColl = (CollSeq *)sqliteHashData(i);
  137568. /* Invoke any destructors registered for collation sequence user data. */
  137569. for(j=0; j<3; j++){
  137570. if( pColl[j].xDel ){
  137571. pColl[j].xDel(pColl[j].pUser);
  137572. }
  137573. }
  137574. sqlite3DbFree(db, pColl);
  137575. }
  137576. sqlite3HashClear(&db->aCollSeq);
  137577. #ifndef SQLITE_OMIT_VIRTUALTABLE
  137578. for(i=sqliteHashFirst(&db->aModule); i; i=sqliteHashNext(i)){
  137579. Module *pMod = (Module *)sqliteHashData(i);
  137580. if( pMod->xDestroy ){
  137581. pMod->xDestroy(pMod->pAux);
  137582. }
  137583. sqlite3VtabEponymousTableClear(db, pMod);
  137584. sqlite3DbFree(db, pMod);
  137585. }
  137586. sqlite3HashClear(&db->aModule);
  137587. #endif
  137588. sqlite3Error(db, SQLITE_OK); /* Deallocates any cached error strings. */
  137589. sqlite3ValueFree(db->pErr);
  137590. sqlite3CloseExtensions(db);
  137591. #if SQLITE_USER_AUTHENTICATION
  137592. sqlite3_free(db->auth.zAuthUser);
  137593. sqlite3_free(db->auth.zAuthPW);
  137594. #endif
  137595. db->magic = SQLITE_MAGIC_ERROR;
  137596. /* The temp-database schema is allocated differently from the other schema
  137597. ** objects (using sqliteMalloc() directly, instead of sqlite3BtreeSchema()).
  137598. ** So it needs to be freed here. Todo: Why not roll the temp schema into
  137599. ** the same sqliteMalloc() as the one that allocates the database
  137600. ** structure?
  137601. */
  137602. sqlite3DbFree(db, db->aDb[1].pSchema);
  137603. sqlite3_mutex_leave(db->mutex);
  137604. db->magic = SQLITE_MAGIC_CLOSED;
  137605. sqlite3_mutex_free(db->mutex);
  137606. assert( sqlite3LookasideUsed(db,0)==0 );
  137607. if( db->lookaside.bMalloced ){
  137608. sqlite3_free(db->lookaside.pStart);
  137609. }
  137610. sqlite3_free(db);
  137611. }
  137612. /*
  137613. ** Rollback all database files. If tripCode is not SQLITE_OK, then
  137614. ** any write cursors are invalidated ("tripped" - as in "tripping a circuit
  137615. ** breaker") and made to return tripCode if there are any further
  137616. ** attempts to use that cursor. Read cursors remain open and valid
  137617. ** but are "saved" in case the table pages are moved around.
  137618. */
  137619. SQLITE_PRIVATE void sqlite3RollbackAll(sqlite3 *db, int tripCode){
  137620. int i;
  137621. int inTrans = 0;
  137622. int schemaChange;
  137623. assert( sqlite3_mutex_held(db->mutex) );
  137624. sqlite3BeginBenignMalloc();
  137625. /* Obtain all b-tree mutexes before making any calls to BtreeRollback().
  137626. ** This is important in case the transaction being rolled back has
  137627. ** modified the database schema. If the b-tree mutexes are not taken
  137628. ** here, then another shared-cache connection might sneak in between
  137629. ** the database rollback and schema reset, which can cause false
  137630. ** corruption reports in some cases. */
  137631. sqlite3BtreeEnterAll(db);
  137632. schemaChange = (db->mDbFlags & DBFLAG_SchemaChange)!=0 && db->init.busy==0;
  137633. for(i=0; i<db->nDb; i++){
  137634. Btree *p = db->aDb[i].pBt;
  137635. if( p ){
  137636. if( sqlite3BtreeIsInTrans(p) ){
  137637. inTrans = 1;
  137638. }
  137639. sqlite3BtreeRollback(p, tripCode, !schemaChange);
  137640. }
  137641. }
  137642. sqlite3VtabRollback(db);
  137643. sqlite3EndBenignMalloc();
  137644. if( (db->mDbFlags&DBFLAG_SchemaChange)!=0 && db->init.busy==0 ){
  137645. sqlite3ExpirePreparedStatements(db);
  137646. sqlite3ResetAllSchemasOfConnection(db);
  137647. }
  137648. sqlite3BtreeLeaveAll(db);
  137649. /* Any deferred constraint violations have now been resolved. */
  137650. db->nDeferredCons = 0;
  137651. db->nDeferredImmCons = 0;
  137652. db->flags &= ~SQLITE_DeferFKs;
  137653. /* If one has been configured, invoke the rollback-hook callback */
  137654. if( db->xRollbackCallback && (inTrans || !db->autoCommit) ){
  137655. db->xRollbackCallback(db->pRollbackArg);
  137656. }
  137657. }
  137658. /*
  137659. ** Return a static string containing the name corresponding to the error code
  137660. ** specified in the argument.
  137661. */
  137662. #if defined(SQLITE_NEED_ERR_NAME)
  137663. SQLITE_PRIVATE const char *sqlite3ErrName(int rc){
  137664. const char *zName = 0;
  137665. int i, origRc = rc;
  137666. for(i=0; i<2 && zName==0; i++, rc &= 0xff){
  137667. switch( rc ){
  137668. case SQLITE_OK: zName = "SQLITE_OK"; break;
  137669. case SQLITE_ERROR: zName = "SQLITE_ERROR"; break;
  137670. case SQLITE_INTERNAL: zName = "SQLITE_INTERNAL"; break;
  137671. case SQLITE_PERM: zName = "SQLITE_PERM"; break;
  137672. case SQLITE_ABORT: zName = "SQLITE_ABORT"; break;
  137673. case SQLITE_ABORT_ROLLBACK: zName = "SQLITE_ABORT_ROLLBACK"; break;
  137674. case SQLITE_BUSY: zName = "SQLITE_BUSY"; break;
  137675. case SQLITE_BUSY_RECOVERY: zName = "SQLITE_BUSY_RECOVERY"; break;
  137676. case SQLITE_BUSY_SNAPSHOT: zName = "SQLITE_BUSY_SNAPSHOT"; break;
  137677. case SQLITE_LOCKED: zName = "SQLITE_LOCKED"; break;
  137678. case SQLITE_LOCKED_SHAREDCACHE: zName = "SQLITE_LOCKED_SHAREDCACHE";break;
  137679. case SQLITE_NOMEM: zName = "SQLITE_NOMEM"; break;
  137680. case SQLITE_READONLY: zName = "SQLITE_READONLY"; break;
  137681. case SQLITE_READONLY_RECOVERY: zName = "SQLITE_READONLY_RECOVERY"; break;
  137682. case SQLITE_READONLY_CANTINIT: zName = "SQLITE_READONLY_CANTINIT"; break;
  137683. case SQLITE_READONLY_ROLLBACK: zName = "SQLITE_READONLY_ROLLBACK"; break;
  137684. case SQLITE_READONLY_DBMOVED: zName = "SQLITE_READONLY_DBMOVED"; break;
  137685. case SQLITE_READONLY_DIRECTORY: zName = "SQLITE_READONLY_DIRECTORY";break;
  137686. case SQLITE_INTERRUPT: zName = "SQLITE_INTERRUPT"; break;
  137687. case SQLITE_IOERR: zName = "SQLITE_IOERR"; break;
  137688. case SQLITE_IOERR_READ: zName = "SQLITE_IOERR_READ"; break;
  137689. case SQLITE_IOERR_SHORT_READ: zName = "SQLITE_IOERR_SHORT_READ"; break;
  137690. case SQLITE_IOERR_WRITE: zName = "SQLITE_IOERR_WRITE"; break;
  137691. case SQLITE_IOERR_FSYNC: zName = "SQLITE_IOERR_FSYNC"; break;
  137692. case SQLITE_IOERR_DIR_FSYNC: zName = "SQLITE_IOERR_DIR_FSYNC"; break;
  137693. case SQLITE_IOERR_TRUNCATE: zName = "SQLITE_IOERR_TRUNCATE"; break;
  137694. case SQLITE_IOERR_FSTAT: zName = "SQLITE_IOERR_FSTAT"; break;
  137695. case SQLITE_IOERR_UNLOCK: zName = "SQLITE_IOERR_UNLOCK"; break;
  137696. case SQLITE_IOERR_RDLOCK: zName = "SQLITE_IOERR_RDLOCK"; break;
  137697. case SQLITE_IOERR_DELETE: zName = "SQLITE_IOERR_DELETE"; break;
  137698. case SQLITE_IOERR_NOMEM: zName = "SQLITE_IOERR_NOMEM"; break;
  137699. case SQLITE_IOERR_ACCESS: zName = "SQLITE_IOERR_ACCESS"; break;
  137700. case SQLITE_IOERR_CHECKRESERVEDLOCK:
  137701. zName = "SQLITE_IOERR_CHECKRESERVEDLOCK"; break;
  137702. case SQLITE_IOERR_LOCK: zName = "SQLITE_IOERR_LOCK"; break;
  137703. case SQLITE_IOERR_CLOSE: zName = "SQLITE_IOERR_CLOSE"; break;
  137704. case SQLITE_IOERR_DIR_CLOSE: zName = "SQLITE_IOERR_DIR_CLOSE"; break;
  137705. case SQLITE_IOERR_SHMOPEN: zName = "SQLITE_IOERR_SHMOPEN"; break;
  137706. case SQLITE_IOERR_SHMSIZE: zName = "SQLITE_IOERR_SHMSIZE"; break;
  137707. case SQLITE_IOERR_SHMLOCK: zName = "SQLITE_IOERR_SHMLOCK"; break;
  137708. case SQLITE_IOERR_SHMMAP: zName = "SQLITE_IOERR_SHMMAP"; break;
  137709. case SQLITE_IOERR_SEEK: zName = "SQLITE_IOERR_SEEK"; break;
  137710. case SQLITE_IOERR_DELETE_NOENT: zName = "SQLITE_IOERR_DELETE_NOENT";break;
  137711. case SQLITE_IOERR_MMAP: zName = "SQLITE_IOERR_MMAP"; break;
  137712. case SQLITE_IOERR_GETTEMPPATH: zName = "SQLITE_IOERR_GETTEMPPATH"; break;
  137713. case SQLITE_IOERR_CONVPATH: zName = "SQLITE_IOERR_CONVPATH"; break;
  137714. case SQLITE_CORRUPT: zName = "SQLITE_CORRUPT"; break;
  137715. case SQLITE_CORRUPT_VTAB: zName = "SQLITE_CORRUPT_VTAB"; break;
  137716. case SQLITE_NOTFOUND: zName = "SQLITE_NOTFOUND"; break;
  137717. case SQLITE_FULL: zName = "SQLITE_FULL"; break;
  137718. case SQLITE_CANTOPEN: zName = "SQLITE_CANTOPEN"; break;
  137719. case SQLITE_CANTOPEN_NOTEMPDIR: zName = "SQLITE_CANTOPEN_NOTEMPDIR";break;
  137720. case SQLITE_CANTOPEN_ISDIR: zName = "SQLITE_CANTOPEN_ISDIR"; break;
  137721. case SQLITE_CANTOPEN_FULLPATH: zName = "SQLITE_CANTOPEN_FULLPATH"; break;
  137722. case SQLITE_CANTOPEN_CONVPATH: zName = "SQLITE_CANTOPEN_CONVPATH"; break;
  137723. case SQLITE_PROTOCOL: zName = "SQLITE_PROTOCOL"; break;
  137724. case SQLITE_EMPTY: zName = "SQLITE_EMPTY"; break;
  137725. case SQLITE_SCHEMA: zName = "SQLITE_SCHEMA"; break;
  137726. case SQLITE_TOOBIG: zName = "SQLITE_TOOBIG"; break;
  137727. case SQLITE_CONSTRAINT: zName = "SQLITE_CONSTRAINT"; break;
  137728. case SQLITE_CONSTRAINT_UNIQUE: zName = "SQLITE_CONSTRAINT_UNIQUE"; break;
  137729. case SQLITE_CONSTRAINT_TRIGGER: zName = "SQLITE_CONSTRAINT_TRIGGER";break;
  137730. case SQLITE_CONSTRAINT_FOREIGNKEY:
  137731. zName = "SQLITE_CONSTRAINT_FOREIGNKEY"; break;
  137732. case SQLITE_CONSTRAINT_CHECK: zName = "SQLITE_CONSTRAINT_CHECK"; break;
  137733. case SQLITE_CONSTRAINT_PRIMARYKEY:
  137734. zName = "SQLITE_CONSTRAINT_PRIMARYKEY"; break;
  137735. case SQLITE_CONSTRAINT_NOTNULL: zName = "SQLITE_CONSTRAINT_NOTNULL";break;
  137736. case SQLITE_CONSTRAINT_COMMITHOOK:
  137737. zName = "SQLITE_CONSTRAINT_COMMITHOOK"; break;
  137738. case SQLITE_CONSTRAINT_VTAB: zName = "SQLITE_CONSTRAINT_VTAB"; break;
  137739. case SQLITE_CONSTRAINT_FUNCTION:
  137740. zName = "SQLITE_CONSTRAINT_FUNCTION"; break;
  137741. case SQLITE_CONSTRAINT_ROWID: zName = "SQLITE_CONSTRAINT_ROWID"; break;
  137742. case SQLITE_MISMATCH: zName = "SQLITE_MISMATCH"; break;
  137743. case SQLITE_MISUSE: zName = "SQLITE_MISUSE"; break;
  137744. case SQLITE_NOLFS: zName = "SQLITE_NOLFS"; break;
  137745. case SQLITE_AUTH: zName = "SQLITE_AUTH"; break;
  137746. case SQLITE_FORMAT: zName = "SQLITE_FORMAT"; break;
  137747. case SQLITE_RANGE: zName = "SQLITE_RANGE"; break;
  137748. case SQLITE_NOTADB: zName = "SQLITE_NOTADB"; break;
  137749. case SQLITE_ROW: zName = "SQLITE_ROW"; break;
  137750. case SQLITE_NOTICE: zName = "SQLITE_NOTICE"; break;
  137751. case SQLITE_NOTICE_RECOVER_WAL: zName = "SQLITE_NOTICE_RECOVER_WAL";break;
  137752. case SQLITE_NOTICE_RECOVER_ROLLBACK:
  137753. zName = "SQLITE_NOTICE_RECOVER_ROLLBACK"; break;
  137754. case SQLITE_WARNING: zName = "SQLITE_WARNING"; break;
  137755. case SQLITE_WARNING_AUTOINDEX: zName = "SQLITE_WARNING_AUTOINDEX"; break;
  137756. case SQLITE_DONE: zName = "SQLITE_DONE"; break;
  137757. }
  137758. }
  137759. if( zName==0 ){
  137760. static char zBuf[50];
  137761. sqlite3_snprintf(sizeof(zBuf), zBuf, "SQLITE_UNKNOWN(%d)", origRc);
  137762. zName = zBuf;
  137763. }
  137764. return zName;
  137765. }
  137766. #endif
  137767. /*
  137768. ** Return a static string that describes the kind of error specified in the
  137769. ** argument.
  137770. */
  137771. SQLITE_PRIVATE const char *sqlite3ErrStr(int rc){
  137772. static const char* const aMsg[] = {
  137773. /* SQLITE_OK */ "not an error",
  137774. /* SQLITE_ERROR */ "SQL logic error",
  137775. /* SQLITE_INTERNAL */ 0,
  137776. /* SQLITE_PERM */ "access permission denied",
  137777. /* SQLITE_ABORT */ "query aborted",
  137778. /* SQLITE_BUSY */ "database is locked",
  137779. /* SQLITE_LOCKED */ "database table is locked",
  137780. /* SQLITE_NOMEM */ "out of memory",
  137781. /* SQLITE_READONLY */ "attempt to write a readonly database",
  137782. /* SQLITE_INTERRUPT */ "interrupted",
  137783. /* SQLITE_IOERR */ "disk I/O error",
  137784. /* SQLITE_CORRUPT */ "database disk image is malformed",
  137785. /* SQLITE_NOTFOUND */ "unknown operation",
  137786. /* SQLITE_FULL */ "database or disk is full",
  137787. /* SQLITE_CANTOPEN */ "unable to open database file",
  137788. /* SQLITE_PROTOCOL */ "locking protocol",
  137789. /* SQLITE_EMPTY */ 0,
  137790. /* SQLITE_SCHEMA */ "database schema has changed",
  137791. /* SQLITE_TOOBIG */ "string or blob too big",
  137792. /* SQLITE_CONSTRAINT */ "constraint failed",
  137793. /* SQLITE_MISMATCH */ "datatype mismatch",
  137794. /* SQLITE_MISUSE */ "bad parameter or other API misuse",
  137795. #ifdef SQLITE_DISABLE_LFS
  137796. /* SQLITE_NOLFS */ "large file support is disabled",
  137797. #else
  137798. /* SQLITE_NOLFS */ 0,
  137799. #endif
  137800. /* SQLITE_AUTH */ "authorization denied",
  137801. /* SQLITE_FORMAT */ 0,
  137802. /* SQLITE_RANGE */ "column index out of range",
  137803. /* SQLITE_NOTADB */ "file is not a database",
  137804. /* SQLITE_NOTICE */ "notification message",
  137805. /* SQLITE_WARNING */ "warning message",
  137806. };
  137807. const char *zErr = "unknown error";
  137808. switch( rc ){
  137809. case SQLITE_ABORT_ROLLBACK: {
  137810. zErr = "abort due to ROLLBACK";
  137811. break;
  137812. }
  137813. case SQLITE_ROW: {
  137814. zErr = "another row available";
  137815. break;
  137816. }
  137817. case SQLITE_DONE: {
  137818. zErr = "no more rows available";
  137819. break;
  137820. }
  137821. default: {
  137822. rc &= 0xff;
  137823. if( ALWAYS(rc>=0) && rc<ArraySize(aMsg) && aMsg[rc]!=0 ){
  137824. zErr = aMsg[rc];
  137825. }
  137826. break;
  137827. }
  137828. }
  137829. return zErr;
  137830. }
  137831. /*
  137832. ** This routine implements a busy callback that sleeps and tries
  137833. ** again until a timeout value is reached. The timeout value is
  137834. ** an integer number of milliseconds passed in as the first
  137835. ** argument.
  137836. **
  137837. ** Return non-zero to retry the lock. Return zero to stop trying
  137838. ** and cause SQLite to return SQLITE_BUSY.
  137839. */
  137840. static int sqliteDefaultBusyCallback(
  137841. void *ptr, /* Database connection */
  137842. int count, /* Number of times table has been busy */
  137843. sqlite3_file *pFile /* The file on which the lock occurred */
  137844. ){
  137845. #if SQLITE_OS_WIN || HAVE_USLEEP
  137846. /* This case is for systems that have support for sleeping for fractions of
  137847. ** a second. Examples: All windows systems, unix systems with usleep() */
  137848. static const u8 delays[] =
  137849. { 1, 2, 5, 10, 15, 20, 25, 25, 25, 50, 50, 100 };
  137850. static const u8 totals[] =
  137851. { 0, 1, 3, 8, 18, 33, 53, 78, 103, 128, 178, 228 };
  137852. # define NDELAY ArraySize(delays)
  137853. sqlite3 *db = (sqlite3 *)ptr;
  137854. int tmout = db->busyTimeout;
  137855. int delay, prior;
  137856. #ifdef SQLITE_ENABLE_SETLK_TIMEOUT
  137857. if( sqlite3OsFileControl(pFile,SQLITE_FCNTL_LOCK_TIMEOUT,&tmout)==SQLITE_OK ){
  137858. if( count ){
  137859. tmout = 0;
  137860. sqlite3OsFileControl(pFile, SQLITE_FCNTL_LOCK_TIMEOUT, &tmout);
  137861. return 0;
  137862. }else{
  137863. return 1;
  137864. }
  137865. }
  137866. #else
  137867. UNUSED_PARAMETER(pFile);
  137868. #endif
  137869. assert( count>=0 );
  137870. if( count < NDELAY ){
  137871. delay = delays[count];
  137872. prior = totals[count];
  137873. }else{
  137874. delay = delays[NDELAY-1];
  137875. prior = totals[NDELAY-1] + delay*(count-(NDELAY-1));
  137876. }
  137877. if( prior + delay > tmout ){
  137878. delay = tmout - prior;
  137879. if( delay<=0 ) return 0;
  137880. }
  137881. sqlite3OsSleep(db->pVfs, delay*1000);
  137882. return 1;
  137883. #else
  137884. /* This case for unix systems that lack usleep() support. Sleeping
  137885. ** must be done in increments of whole seconds */
  137886. sqlite3 *db = (sqlite3 *)ptr;
  137887. int tmout = ((sqlite3 *)ptr)->busyTimeout;
  137888. UNUSED_PARAMETER(pFile);
  137889. if( (count+1)*1000 > tmout ){
  137890. return 0;
  137891. }
  137892. sqlite3OsSleep(db->pVfs, 1000000);
  137893. return 1;
  137894. #endif
  137895. }
  137896. /*
  137897. ** Invoke the given busy handler.
  137898. **
  137899. ** This routine is called when an operation failed to acquire a
  137900. ** lock on VFS file pFile.
  137901. **
  137902. ** If this routine returns non-zero, the lock is retried. If it
  137903. ** returns 0, the operation aborts with an SQLITE_BUSY error.
  137904. */
  137905. SQLITE_PRIVATE int sqlite3InvokeBusyHandler(BusyHandler *p, sqlite3_file *pFile){
  137906. int rc;
  137907. if( p->xBusyHandler==0 || p->nBusy<0 ) return 0;
  137908. if( p->bExtraFileArg ){
  137909. /* Add an extra parameter with the pFile pointer to the end of the
  137910. ** callback argument list */
  137911. int (*xTra)(void*,int,sqlite3_file*);
  137912. xTra = (int(*)(void*,int,sqlite3_file*))p->xBusyHandler;
  137913. rc = xTra(p->pBusyArg, p->nBusy, pFile);
  137914. }else{
  137915. /* Legacy style busy handler callback */
  137916. rc = p->xBusyHandler(p->pBusyArg, p->nBusy);
  137917. }
  137918. if( rc==0 ){
  137919. p->nBusy = -1;
  137920. }else{
  137921. p->nBusy++;
  137922. }
  137923. return rc;
  137924. }
  137925. /*
  137926. ** This routine sets the busy callback for an Sqlite database to the
  137927. ** given callback function with the given argument.
  137928. */
  137929. SQLITE_API int sqlite3_busy_handler(
  137930. sqlite3 *db,
  137931. int (*xBusy)(void*,int),
  137932. void *pArg
  137933. ){
  137934. #ifdef SQLITE_ENABLE_API_ARMOR
  137935. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  137936. #endif
  137937. sqlite3_mutex_enter(db->mutex);
  137938. db->busyHandler.xBusyHandler = xBusy;
  137939. db->busyHandler.pBusyArg = pArg;
  137940. db->busyHandler.nBusy = 0;
  137941. db->busyHandler.bExtraFileArg = 0;
  137942. db->busyTimeout = 0;
  137943. sqlite3_mutex_leave(db->mutex);
  137944. return SQLITE_OK;
  137945. }
  137946. #ifndef SQLITE_OMIT_PROGRESS_CALLBACK
  137947. /*
  137948. ** This routine sets the progress callback for an Sqlite database to the
  137949. ** given callback function with the given argument. The progress callback will
  137950. ** be invoked every nOps opcodes.
  137951. */
  137952. SQLITE_API void sqlite3_progress_handler(
  137953. sqlite3 *db,
  137954. int nOps,
  137955. int (*xProgress)(void*),
  137956. void *pArg
  137957. ){
  137958. #ifdef SQLITE_ENABLE_API_ARMOR
  137959. if( !sqlite3SafetyCheckOk(db) ){
  137960. (void)SQLITE_MISUSE_BKPT;
  137961. return;
  137962. }
  137963. #endif
  137964. sqlite3_mutex_enter(db->mutex);
  137965. if( nOps>0 ){
  137966. db->xProgress = xProgress;
  137967. db->nProgressOps = (unsigned)nOps;
  137968. db->pProgressArg = pArg;
  137969. }else{
  137970. db->xProgress = 0;
  137971. db->nProgressOps = 0;
  137972. db->pProgressArg = 0;
  137973. }
  137974. sqlite3_mutex_leave(db->mutex);
  137975. }
  137976. #endif
  137977. /*
  137978. ** This routine installs a default busy handler that waits for the
  137979. ** specified number of milliseconds before returning 0.
  137980. */
  137981. SQLITE_API int sqlite3_busy_timeout(sqlite3 *db, int ms){
  137982. #ifdef SQLITE_ENABLE_API_ARMOR
  137983. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  137984. #endif
  137985. if( ms>0 ){
  137986. sqlite3_busy_handler(db, (int(*)(void*,int))sqliteDefaultBusyCallback,
  137987. (void*)db);
  137988. db->busyTimeout = ms;
  137989. db->busyHandler.bExtraFileArg = 1;
  137990. }else{
  137991. sqlite3_busy_handler(db, 0, 0);
  137992. }
  137993. return SQLITE_OK;
  137994. }
  137995. /*
  137996. ** Cause any pending operation to stop at its earliest opportunity.
  137997. */
  137998. SQLITE_API void sqlite3_interrupt(sqlite3 *db){
  137999. #ifdef SQLITE_ENABLE_API_ARMOR
  138000. if( !sqlite3SafetyCheckOk(db) && (db==0 || db->magic!=SQLITE_MAGIC_ZOMBIE) ){
  138001. (void)SQLITE_MISUSE_BKPT;
  138002. return;
  138003. }
  138004. #endif
  138005. db->u1.isInterrupted = 1;
  138006. }
  138007. /*
  138008. ** This function is exactly the same as sqlite3_create_function(), except
  138009. ** that it is designed to be called by internal code. The difference is
  138010. ** that if a malloc() fails in sqlite3_create_function(), an error code
  138011. ** is returned and the mallocFailed flag cleared.
  138012. */
  138013. SQLITE_PRIVATE int sqlite3CreateFunc(
  138014. sqlite3 *db,
  138015. const char *zFunctionName,
  138016. int nArg,
  138017. int enc,
  138018. void *pUserData,
  138019. void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
  138020. void (*xStep)(sqlite3_context*,int,sqlite3_value **),
  138021. void (*xFinal)(sqlite3_context*),
  138022. FuncDestructor *pDestructor
  138023. ){
  138024. FuncDef *p;
  138025. int nName;
  138026. int extraFlags;
  138027. assert( sqlite3_mutex_held(db->mutex) );
  138028. if( zFunctionName==0 ||
  138029. (xSFunc && (xFinal || xStep)) ||
  138030. (!xSFunc && (xFinal && !xStep)) ||
  138031. (!xSFunc && (!xFinal && xStep)) ||
  138032. (nArg<-1 || nArg>SQLITE_MAX_FUNCTION_ARG) ||
  138033. (255<(nName = sqlite3Strlen30( zFunctionName))) ){
  138034. return SQLITE_MISUSE_BKPT;
  138035. }
  138036. assert( SQLITE_FUNC_CONSTANT==SQLITE_DETERMINISTIC );
  138037. extraFlags = enc & SQLITE_DETERMINISTIC;
  138038. enc &= (SQLITE_FUNC_ENCMASK|SQLITE_ANY);
  138039. #ifndef SQLITE_OMIT_UTF16
  138040. /* If SQLITE_UTF16 is specified as the encoding type, transform this
  138041. ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
  138042. ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
  138043. **
  138044. ** If SQLITE_ANY is specified, add three versions of the function
  138045. ** to the hash table.
  138046. */
  138047. if( enc==SQLITE_UTF16 ){
  138048. enc = SQLITE_UTF16NATIVE;
  138049. }else if( enc==SQLITE_ANY ){
  138050. int rc;
  138051. rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF8|extraFlags,
  138052. pUserData, xSFunc, xStep, xFinal, pDestructor);
  138053. if( rc==SQLITE_OK ){
  138054. rc = sqlite3CreateFunc(db, zFunctionName, nArg, SQLITE_UTF16LE|extraFlags,
  138055. pUserData, xSFunc, xStep, xFinal, pDestructor);
  138056. }
  138057. if( rc!=SQLITE_OK ){
  138058. return rc;
  138059. }
  138060. enc = SQLITE_UTF16BE;
  138061. }
  138062. #else
  138063. enc = SQLITE_UTF8;
  138064. #endif
  138065. /* Check if an existing function is being overridden or deleted. If so,
  138066. ** and there are active VMs, then return SQLITE_BUSY. If a function
  138067. ** is being overridden/deleted but there are no active VMs, allow the
  138068. ** operation to continue but invalidate all precompiled statements.
  138069. */
  138070. p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 0);
  138071. if( p && (p->funcFlags & SQLITE_FUNC_ENCMASK)==enc && p->nArg==nArg ){
  138072. if( db->nVdbeActive ){
  138073. sqlite3ErrorWithMsg(db, SQLITE_BUSY,
  138074. "unable to delete/modify user-function due to active statements");
  138075. assert( !db->mallocFailed );
  138076. return SQLITE_BUSY;
  138077. }else{
  138078. sqlite3ExpirePreparedStatements(db);
  138079. }
  138080. }
  138081. p = sqlite3FindFunction(db, zFunctionName, nArg, (u8)enc, 1);
  138082. assert(p || db->mallocFailed);
  138083. if( !p ){
  138084. return SQLITE_NOMEM_BKPT;
  138085. }
  138086. /* If an older version of the function with a configured destructor is
  138087. ** being replaced invoke the destructor function here. */
  138088. functionDestroy(db, p);
  138089. if( pDestructor ){
  138090. pDestructor->nRef++;
  138091. }
  138092. p->u.pDestructor = pDestructor;
  138093. p->funcFlags = (p->funcFlags & SQLITE_FUNC_ENCMASK) | extraFlags;
  138094. testcase( p->funcFlags & SQLITE_DETERMINISTIC );
  138095. p->xSFunc = xSFunc ? xSFunc : xStep;
  138096. p->xFinalize = xFinal;
  138097. p->pUserData = pUserData;
  138098. p->nArg = (u16)nArg;
  138099. return SQLITE_OK;
  138100. }
  138101. /*
  138102. ** Create new user functions.
  138103. */
  138104. SQLITE_API int sqlite3_create_function(
  138105. sqlite3 *db,
  138106. const char *zFunc,
  138107. int nArg,
  138108. int enc,
  138109. void *p,
  138110. void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
  138111. void (*xStep)(sqlite3_context*,int,sqlite3_value **),
  138112. void (*xFinal)(sqlite3_context*)
  138113. ){
  138114. return sqlite3_create_function_v2(db, zFunc, nArg, enc, p, xSFunc, xStep,
  138115. xFinal, 0);
  138116. }
  138117. SQLITE_API int sqlite3_create_function_v2(
  138118. sqlite3 *db,
  138119. const char *zFunc,
  138120. int nArg,
  138121. int enc,
  138122. void *p,
  138123. void (*xSFunc)(sqlite3_context*,int,sqlite3_value **),
  138124. void (*xStep)(sqlite3_context*,int,sqlite3_value **),
  138125. void (*xFinal)(sqlite3_context*),
  138126. void (*xDestroy)(void *)
  138127. ){
  138128. int rc = SQLITE_ERROR;
  138129. FuncDestructor *pArg = 0;
  138130. #ifdef SQLITE_ENABLE_API_ARMOR
  138131. if( !sqlite3SafetyCheckOk(db) ){
  138132. return SQLITE_MISUSE_BKPT;
  138133. }
  138134. #endif
  138135. sqlite3_mutex_enter(db->mutex);
  138136. if( xDestroy ){
  138137. pArg = (FuncDestructor *)sqlite3DbMallocZero(db, sizeof(FuncDestructor));
  138138. if( !pArg ){
  138139. xDestroy(p);
  138140. goto out;
  138141. }
  138142. pArg->xDestroy = xDestroy;
  138143. pArg->pUserData = p;
  138144. }
  138145. rc = sqlite3CreateFunc(db, zFunc, nArg, enc, p, xSFunc, xStep, xFinal, pArg);
  138146. if( pArg && pArg->nRef==0 ){
  138147. assert( rc!=SQLITE_OK );
  138148. xDestroy(p);
  138149. sqlite3DbFree(db, pArg);
  138150. }
  138151. out:
  138152. rc = sqlite3ApiExit(db, rc);
  138153. sqlite3_mutex_leave(db->mutex);
  138154. return rc;
  138155. }
  138156. #ifndef SQLITE_OMIT_UTF16
  138157. SQLITE_API int sqlite3_create_function16(
  138158. sqlite3 *db,
  138159. const void *zFunctionName,
  138160. int nArg,
  138161. int eTextRep,
  138162. void *p,
  138163. void (*xSFunc)(sqlite3_context*,int,sqlite3_value**),
  138164. void (*xStep)(sqlite3_context*,int,sqlite3_value**),
  138165. void (*xFinal)(sqlite3_context*)
  138166. ){
  138167. int rc;
  138168. char *zFunc8;
  138169. #ifdef SQLITE_ENABLE_API_ARMOR
  138170. if( !sqlite3SafetyCheckOk(db) || zFunctionName==0 ) return SQLITE_MISUSE_BKPT;
  138171. #endif
  138172. sqlite3_mutex_enter(db->mutex);
  138173. assert( !db->mallocFailed );
  138174. zFunc8 = sqlite3Utf16to8(db, zFunctionName, -1, SQLITE_UTF16NATIVE);
  138175. rc = sqlite3CreateFunc(db, zFunc8, nArg, eTextRep, p, xSFunc,xStep,xFinal,0);
  138176. sqlite3DbFree(db, zFunc8);
  138177. rc = sqlite3ApiExit(db, rc);
  138178. sqlite3_mutex_leave(db->mutex);
  138179. return rc;
  138180. }
  138181. #endif
  138182. /*
  138183. ** Declare that a function has been overloaded by a virtual table.
  138184. **
  138185. ** If the function already exists as a regular global function, then
  138186. ** this routine is a no-op. If the function does not exist, then create
  138187. ** a new one that always throws a run-time error.
  138188. **
  138189. ** When virtual tables intend to provide an overloaded function, they
  138190. ** should call this routine to make sure the global function exists.
  138191. ** A global function must exist in order for name resolution to work
  138192. ** properly.
  138193. */
  138194. SQLITE_API int sqlite3_overload_function(
  138195. sqlite3 *db,
  138196. const char *zName,
  138197. int nArg
  138198. ){
  138199. int rc = SQLITE_OK;
  138200. #ifdef SQLITE_ENABLE_API_ARMOR
  138201. if( !sqlite3SafetyCheckOk(db) || zName==0 || nArg<-2 ){
  138202. return SQLITE_MISUSE_BKPT;
  138203. }
  138204. #endif
  138205. sqlite3_mutex_enter(db->mutex);
  138206. if( sqlite3FindFunction(db, zName, nArg, SQLITE_UTF8, 0)==0 ){
  138207. rc = sqlite3CreateFunc(db, zName, nArg, SQLITE_UTF8,
  138208. 0, sqlite3InvalidFunction, 0, 0, 0);
  138209. }
  138210. rc = sqlite3ApiExit(db, rc);
  138211. sqlite3_mutex_leave(db->mutex);
  138212. return rc;
  138213. }
  138214. #ifndef SQLITE_OMIT_TRACE
  138215. /*
  138216. ** Register a trace function. The pArg from the previously registered trace
  138217. ** is returned.
  138218. **
  138219. ** A NULL trace function means that no tracing is executes. A non-NULL
  138220. ** trace is a pointer to a function that is invoked at the start of each
  138221. ** SQL statement.
  138222. */
  138223. #ifndef SQLITE_OMIT_DEPRECATED
  138224. SQLITE_API void *sqlite3_trace(sqlite3 *db, void(*xTrace)(void*,const char*), void *pArg){
  138225. void *pOld;
  138226. #ifdef SQLITE_ENABLE_API_ARMOR
  138227. if( !sqlite3SafetyCheckOk(db) ){
  138228. (void)SQLITE_MISUSE_BKPT;
  138229. return 0;
  138230. }
  138231. #endif
  138232. sqlite3_mutex_enter(db->mutex);
  138233. pOld = db->pTraceArg;
  138234. db->mTrace = xTrace ? SQLITE_TRACE_LEGACY : 0;
  138235. db->xTrace = (int(*)(u32,void*,void*,void*))xTrace;
  138236. db->pTraceArg = pArg;
  138237. sqlite3_mutex_leave(db->mutex);
  138238. return pOld;
  138239. }
  138240. #endif /* SQLITE_OMIT_DEPRECATED */
  138241. /* Register a trace callback using the version-2 interface.
  138242. */
  138243. SQLITE_API int sqlite3_trace_v2(
  138244. sqlite3 *db, /* Trace this connection */
  138245. unsigned mTrace, /* Mask of events to be traced */
  138246. int(*xTrace)(unsigned,void*,void*,void*), /* Callback to invoke */
  138247. void *pArg /* Context */
  138248. ){
  138249. #ifdef SQLITE_ENABLE_API_ARMOR
  138250. if( !sqlite3SafetyCheckOk(db) ){
  138251. return SQLITE_MISUSE_BKPT;
  138252. }
  138253. #endif
  138254. sqlite3_mutex_enter(db->mutex);
  138255. if( mTrace==0 ) xTrace = 0;
  138256. if( xTrace==0 ) mTrace = 0;
  138257. db->mTrace = mTrace;
  138258. db->xTrace = xTrace;
  138259. db->pTraceArg = pArg;
  138260. sqlite3_mutex_leave(db->mutex);
  138261. return SQLITE_OK;
  138262. }
  138263. #ifndef SQLITE_OMIT_DEPRECATED
  138264. /*
  138265. ** Register a profile function. The pArg from the previously registered
  138266. ** profile function is returned.
  138267. **
  138268. ** A NULL profile function means that no profiling is executes. A non-NULL
  138269. ** profile is a pointer to a function that is invoked at the conclusion of
  138270. ** each SQL statement that is run.
  138271. */
  138272. SQLITE_API void *sqlite3_profile(
  138273. sqlite3 *db,
  138274. void (*xProfile)(void*,const char*,sqlite_uint64),
  138275. void *pArg
  138276. ){
  138277. void *pOld;
  138278. #ifdef SQLITE_ENABLE_API_ARMOR
  138279. if( !sqlite3SafetyCheckOk(db) ){
  138280. (void)SQLITE_MISUSE_BKPT;
  138281. return 0;
  138282. }
  138283. #endif
  138284. sqlite3_mutex_enter(db->mutex);
  138285. pOld = db->pProfileArg;
  138286. db->xProfile = xProfile;
  138287. db->pProfileArg = pArg;
  138288. sqlite3_mutex_leave(db->mutex);
  138289. return pOld;
  138290. }
  138291. #endif /* SQLITE_OMIT_DEPRECATED */
  138292. #endif /* SQLITE_OMIT_TRACE */
  138293. /*
  138294. ** Register a function to be invoked when a transaction commits.
  138295. ** If the invoked function returns non-zero, then the commit becomes a
  138296. ** rollback.
  138297. */
  138298. SQLITE_API void *sqlite3_commit_hook(
  138299. sqlite3 *db, /* Attach the hook to this database */
  138300. int (*xCallback)(void*), /* Function to invoke on each commit */
  138301. void *pArg /* Argument to the function */
  138302. ){
  138303. void *pOld;
  138304. #ifdef SQLITE_ENABLE_API_ARMOR
  138305. if( !sqlite3SafetyCheckOk(db) ){
  138306. (void)SQLITE_MISUSE_BKPT;
  138307. return 0;
  138308. }
  138309. #endif
  138310. sqlite3_mutex_enter(db->mutex);
  138311. pOld = db->pCommitArg;
  138312. db->xCommitCallback = xCallback;
  138313. db->pCommitArg = pArg;
  138314. sqlite3_mutex_leave(db->mutex);
  138315. return pOld;
  138316. }
  138317. /*
  138318. ** Register a callback to be invoked each time a row is updated,
  138319. ** inserted or deleted using this database connection.
  138320. */
  138321. SQLITE_API void *sqlite3_update_hook(
  138322. sqlite3 *db, /* Attach the hook to this database */
  138323. void (*xCallback)(void*,int,char const *,char const *,sqlite_int64),
  138324. void *pArg /* Argument to the function */
  138325. ){
  138326. void *pRet;
  138327. #ifdef SQLITE_ENABLE_API_ARMOR
  138328. if( !sqlite3SafetyCheckOk(db) ){
  138329. (void)SQLITE_MISUSE_BKPT;
  138330. return 0;
  138331. }
  138332. #endif
  138333. sqlite3_mutex_enter(db->mutex);
  138334. pRet = db->pUpdateArg;
  138335. db->xUpdateCallback = xCallback;
  138336. db->pUpdateArg = pArg;
  138337. sqlite3_mutex_leave(db->mutex);
  138338. return pRet;
  138339. }
  138340. /*
  138341. ** Register a callback to be invoked each time a transaction is rolled
  138342. ** back by this database connection.
  138343. */
  138344. SQLITE_API void *sqlite3_rollback_hook(
  138345. sqlite3 *db, /* Attach the hook to this database */
  138346. void (*xCallback)(void*), /* Callback function */
  138347. void *pArg /* Argument to the function */
  138348. ){
  138349. void *pRet;
  138350. #ifdef SQLITE_ENABLE_API_ARMOR
  138351. if( !sqlite3SafetyCheckOk(db) ){
  138352. (void)SQLITE_MISUSE_BKPT;
  138353. return 0;
  138354. }
  138355. #endif
  138356. sqlite3_mutex_enter(db->mutex);
  138357. pRet = db->pRollbackArg;
  138358. db->xRollbackCallback = xCallback;
  138359. db->pRollbackArg = pArg;
  138360. sqlite3_mutex_leave(db->mutex);
  138361. return pRet;
  138362. }
  138363. #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
  138364. /*
  138365. ** Register a callback to be invoked each time a row is updated,
  138366. ** inserted or deleted using this database connection.
  138367. */
  138368. SQLITE_API void *sqlite3_preupdate_hook(
  138369. sqlite3 *db, /* Attach the hook to this database */
  138370. void(*xCallback)( /* Callback function */
  138371. void*,sqlite3*,int,char const*,char const*,sqlite3_int64,sqlite3_int64),
  138372. void *pArg /* First callback argument */
  138373. ){
  138374. void *pRet;
  138375. sqlite3_mutex_enter(db->mutex);
  138376. pRet = db->pPreUpdateArg;
  138377. db->xPreUpdateCallback = xCallback;
  138378. db->pPreUpdateArg = pArg;
  138379. sqlite3_mutex_leave(db->mutex);
  138380. return pRet;
  138381. }
  138382. #endif /* SQLITE_ENABLE_PREUPDATE_HOOK */
  138383. #ifndef SQLITE_OMIT_WAL
  138384. /*
  138385. ** The sqlite3_wal_hook() callback registered by sqlite3_wal_autocheckpoint().
  138386. ** Invoke sqlite3_wal_checkpoint if the number of frames in the log file
  138387. ** is greater than sqlite3.pWalArg cast to an integer (the value configured by
  138388. ** wal_autocheckpoint()).
  138389. */
  138390. SQLITE_PRIVATE int sqlite3WalDefaultHook(
  138391. void *pClientData, /* Argument */
  138392. sqlite3 *db, /* Connection */
  138393. const char *zDb, /* Database */
  138394. int nFrame /* Size of WAL */
  138395. ){
  138396. if( nFrame>=SQLITE_PTR_TO_INT(pClientData) ){
  138397. sqlite3BeginBenignMalloc();
  138398. sqlite3_wal_checkpoint(db, zDb);
  138399. sqlite3EndBenignMalloc();
  138400. }
  138401. return SQLITE_OK;
  138402. }
  138403. #endif /* SQLITE_OMIT_WAL */
  138404. /*
  138405. ** Configure an sqlite3_wal_hook() callback to automatically checkpoint
  138406. ** a database after committing a transaction if there are nFrame or
  138407. ** more frames in the log file. Passing zero or a negative value as the
  138408. ** nFrame parameter disables automatic checkpoints entirely.
  138409. **
  138410. ** The callback registered by this function replaces any existing callback
  138411. ** registered using sqlite3_wal_hook(). Likewise, registering a callback
  138412. ** using sqlite3_wal_hook() disables the automatic checkpoint mechanism
  138413. ** configured by this function.
  138414. */
  138415. SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int nFrame){
  138416. #ifdef SQLITE_OMIT_WAL
  138417. UNUSED_PARAMETER(db);
  138418. UNUSED_PARAMETER(nFrame);
  138419. #else
  138420. #ifdef SQLITE_ENABLE_API_ARMOR
  138421. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  138422. #endif
  138423. if( nFrame>0 ){
  138424. sqlite3_wal_hook(db, sqlite3WalDefaultHook, SQLITE_INT_TO_PTR(nFrame));
  138425. }else{
  138426. sqlite3_wal_hook(db, 0, 0);
  138427. }
  138428. #endif
  138429. return SQLITE_OK;
  138430. }
  138431. /*
  138432. ** Register a callback to be invoked each time a transaction is written
  138433. ** into the write-ahead-log by this database connection.
  138434. */
  138435. SQLITE_API void *sqlite3_wal_hook(
  138436. sqlite3 *db, /* Attach the hook to this db handle */
  138437. int(*xCallback)(void *, sqlite3*, const char*, int),
  138438. void *pArg /* First argument passed to xCallback() */
  138439. ){
  138440. #ifndef SQLITE_OMIT_WAL
  138441. void *pRet;
  138442. #ifdef SQLITE_ENABLE_API_ARMOR
  138443. if( !sqlite3SafetyCheckOk(db) ){
  138444. (void)SQLITE_MISUSE_BKPT;
  138445. return 0;
  138446. }
  138447. #endif
  138448. sqlite3_mutex_enter(db->mutex);
  138449. pRet = db->pWalArg;
  138450. db->xWalCallback = xCallback;
  138451. db->pWalArg = pArg;
  138452. sqlite3_mutex_leave(db->mutex);
  138453. return pRet;
  138454. #else
  138455. return 0;
  138456. #endif
  138457. }
  138458. /*
  138459. ** Checkpoint database zDb.
  138460. */
  138461. SQLITE_API int sqlite3_wal_checkpoint_v2(
  138462. sqlite3 *db, /* Database handle */
  138463. const char *zDb, /* Name of attached database (or NULL) */
  138464. int eMode, /* SQLITE_CHECKPOINT_* value */
  138465. int *pnLog, /* OUT: Size of WAL log in frames */
  138466. int *pnCkpt /* OUT: Total number of frames checkpointed */
  138467. ){
  138468. #ifdef SQLITE_OMIT_WAL
  138469. return SQLITE_OK;
  138470. #else
  138471. int rc; /* Return code */
  138472. int iDb = SQLITE_MAX_ATTACHED; /* sqlite3.aDb[] index of db to checkpoint */
  138473. #ifdef SQLITE_ENABLE_API_ARMOR
  138474. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  138475. #endif
  138476. /* Initialize the output variables to -1 in case an error occurs. */
  138477. if( pnLog ) *pnLog = -1;
  138478. if( pnCkpt ) *pnCkpt = -1;
  138479. assert( SQLITE_CHECKPOINT_PASSIVE==0 );
  138480. assert( SQLITE_CHECKPOINT_FULL==1 );
  138481. assert( SQLITE_CHECKPOINT_RESTART==2 );
  138482. assert( SQLITE_CHECKPOINT_TRUNCATE==3 );
  138483. if( eMode<SQLITE_CHECKPOINT_PASSIVE || eMode>SQLITE_CHECKPOINT_TRUNCATE ){
  138484. /* EVIDENCE-OF: R-03996-12088 The M parameter must be a valid checkpoint
  138485. ** mode: */
  138486. return SQLITE_MISUSE;
  138487. }
  138488. sqlite3_mutex_enter(db->mutex);
  138489. if( zDb && zDb[0] ){
  138490. iDb = sqlite3FindDbName(db, zDb);
  138491. }
  138492. if( iDb<0 ){
  138493. rc = SQLITE_ERROR;
  138494. sqlite3ErrorWithMsg(db, SQLITE_ERROR, "unknown database: %s", zDb);
  138495. }else{
  138496. db->busyHandler.nBusy = 0;
  138497. rc = sqlite3Checkpoint(db, iDb, eMode, pnLog, pnCkpt);
  138498. sqlite3Error(db, rc);
  138499. }
  138500. rc = sqlite3ApiExit(db, rc);
  138501. /* If there are no active statements, clear the interrupt flag at this
  138502. ** point. */
  138503. if( db->nVdbeActive==0 ){
  138504. db->u1.isInterrupted = 0;
  138505. }
  138506. sqlite3_mutex_leave(db->mutex);
  138507. return rc;
  138508. #endif
  138509. }
  138510. /*
  138511. ** Checkpoint database zDb. If zDb is NULL, or if the buffer zDb points
  138512. ** to contains a zero-length string, all attached databases are
  138513. ** checkpointed.
  138514. */
  138515. SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb){
  138516. /* EVIDENCE-OF: R-41613-20553 The sqlite3_wal_checkpoint(D,X) is equivalent to
  138517. ** sqlite3_wal_checkpoint_v2(D,X,SQLITE_CHECKPOINT_PASSIVE,0,0). */
  138518. return sqlite3_wal_checkpoint_v2(db,zDb,SQLITE_CHECKPOINT_PASSIVE,0,0);
  138519. }
  138520. #ifndef SQLITE_OMIT_WAL
  138521. /*
  138522. ** Run a checkpoint on database iDb. This is a no-op if database iDb is
  138523. ** not currently open in WAL mode.
  138524. **
  138525. ** If a transaction is open on the database being checkpointed, this
  138526. ** function returns SQLITE_LOCKED and a checkpoint is not attempted. If
  138527. ** an error occurs while running the checkpoint, an SQLite error code is
  138528. ** returned (i.e. SQLITE_IOERR). Otherwise, SQLITE_OK.
  138529. **
  138530. ** The mutex on database handle db should be held by the caller. The mutex
  138531. ** associated with the specific b-tree being checkpointed is taken by
  138532. ** this function while the checkpoint is running.
  138533. **
  138534. ** If iDb is passed SQLITE_MAX_ATTACHED, then all attached databases are
  138535. ** checkpointed. If an error is encountered it is returned immediately -
  138536. ** no attempt is made to checkpoint any remaining databases.
  138537. **
  138538. ** Parameter eMode is one of SQLITE_CHECKPOINT_PASSIVE, FULL, RESTART
  138539. ** or TRUNCATE.
  138540. */
  138541. SQLITE_PRIVATE int sqlite3Checkpoint(sqlite3 *db, int iDb, int eMode, int *pnLog, int *pnCkpt){
  138542. int rc = SQLITE_OK; /* Return code */
  138543. int i; /* Used to iterate through attached dbs */
  138544. int bBusy = 0; /* True if SQLITE_BUSY has been encountered */
  138545. assert( sqlite3_mutex_held(db->mutex) );
  138546. assert( !pnLog || *pnLog==-1 );
  138547. assert( !pnCkpt || *pnCkpt==-1 );
  138548. for(i=0; i<db->nDb && rc==SQLITE_OK; i++){
  138549. if( i==iDb || iDb==SQLITE_MAX_ATTACHED ){
  138550. rc = sqlite3BtreeCheckpoint(db->aDb[i].pBt, eMode, pnLog, pnCkpt);
  138551. pnLog = 0;
  138552. pnCkpt = 0;
  138553. if( rc==SQLITE_BUSY ){
  138554. bBusy = 1;
  138555. rc = SQLITE_OK;
  138556. }
  138557. }
  138558. }
  138559. return (rc==SQLITE_OK && bBusy) ? SQLITE_BUSY : rc;
  138560. }
  138561. #endif /* SQLITE_OMIT_WAL */
  138562. /*
  138563. ** This function returns true if main-memory should be used instead of
  138564. ** a temporary file for transient pager files and statement journals.
  138565. ** The value returned depends on the value of db->temp_store (runtime
  138566. ** parameter) and the compile time value of SQLITE_TEMP_STORE. The
  138567. ** following table describes the relationship between these two values
  138568. ** and this functions return value.
  138569. **
  138570. ** SQLITE_TEMP_STORE db->temp_store Location of temporary database
  138571. ** ----------------- -------------- ------------------------------
  138572. ** 0 any file (return 0)
  138573. ** 1 1 file (return 0)
  138574. ** 1 2 memory (return 1)
  138575. ** 1 0 file (return 0)
  138576. ** 2 1 file (return 0)
  138577. ** 2 2 memory (return 1)
  138578. ** 2 0 memory (return 1)
  138579. ** 3 any memory (return 1)
  138580. */
  138581. SQLITE_PRIVATE int sqlite3TempInMemory(const sqlite3 *db){
  138582. #if SQLITE_TEMP_STORE==1
  138583. return ( db->temp_store==2 );
  138584. #endif
  138585. #if SQLITE_TEMP_STORE==2
  138586. return ( db->temp_store!=1 );
  138587. #endif
  138588. #if SQLITE_TEMP_STORE==3
  138589. UNUSED_PARAMETER(db);
  138590. return 1;
  138591. #endif
  138592. #if SQLITE_TEMP_STORE<1 || SQLITE_TEMP_STORE>3
  138593. UNUSED_PARAMETER(db);
  138594. return 0;
  138595. #endif
  138596. }
  138597. /*
  138598. ** Return UTF-8 encoded English language explanation of the most recent
  138599. ** error.
  138600. */
  138601. SQLITE_API const char *sqlite3_errmsg(sqlite3 *db){
  138602. const char *z;
  138603. if( !db ){
  138604. return sqlite3ErrStr(SQLITE_NOMEM_BKPT);
  138605. }
  138606. if( !sqlite3SafetyCheckSickOrOk(db) ){
  138607. return sqlite3ErrStr(SQLITE_MISUSE_BKPT);
  138608. }
  138609. sqlite3_mutex_enter(db->mutex);
  138610. if( db->mallocFailed ){
  138611. z = sqlite3ErrStr(SQLITE_NOMEM_BKPT);
  138612. }else{
  138613. testcase( db->pErr==0 );
  138614. z = (char*)sqlite3_value_text(db->pErr);
  138615. assert( !db->mallocFailed );
  138616. if( z==0 ){
  138617. z = sqlite3ErrStr(db->errCode);
  138618. }
  138619. }
  138620. sqlite3_mutex_leave(db->mutex);
  138621. return z;
  138622. }
  138623. #ifndef SQLITE_OMIT_UTF16
  138624. /*
  138625. ** Return UTF-16 encoded English language explanation of the most recent
  138626. ** error.
  138627. */
  138628. SQLITE_API const void *sqlite3_errmsg16(sqlite3 *db){
  138629. static const u16 outOfMem[] = {
  138630. 'o', 'u', 't', ' ', 'o', 'f', ' ', 'm', 'e', 'm', 'o', 'r', 'y', 0
  138631. };
  138632. static const u16 misuse[] = {
  138633. 'b', 'a', 'd', ' ', 'p', 'a', 'r', 'a', 'm', 'e', 't', 'e', 'r', ' ',
  138634. 'o', 'r', ' ', 'o', 't', 'h', 'e', 'r', ' ', 'A', 'P', 'I', ' ',
  138635. 'm', 'i', 's', 'u', 's', 'e', 0
  138636. };
  138637. const void *z;
  138638. if( !db ){
  138639. return (void *)outOfMem;
  138640. }
  138641. if( !sqlite3SafetyCheckSickOrOk(db) ){
  138642. return (void *)misuse;
  138643. }
  138644. sqlite3_mutex_enter(db->mutex);
  138645. if( db->mallocFailed ){
  138646. z = (void *)outOfMem;
  138647. }else{
  138648. z = sqlite3_value_text16(db->pErr);
  138649. if( z==0 ){
  138650. sqlite3ErrorWithMsg(db, db->errCode, sqlite3ErrStr(db->errCode));
  138651. z = sqlite3_value_text16(db->pErr);
  138652. }
  138653. /* A malloc() may have failed within the call to sqlite3_value_text16()
  138654. ** above. If this is the case, then the db->mallocFailed flag needs to
  138655. ** be cleared before returning. Do this directly, instead of via
  138656. ** sqlite3ApiExit(), to avoid setting the database handle error message.
  138657. */
  138658. sqlite3OomClear(db);
  138659. }
  138660. sqlite3_mutex_leave(db->mutex);
  138661. return z;
  138662. }
  138663. #endif /* SQLITE_OMIT_UTF16 */
  138664. /*
  138665. ** Return the most recent error code generated by an SQLite routine. If NULL is
  138666. ** passed to this function, we assume a malloc() failed during sqlite3_open().
  138667. */
  138668. SQLITE_API int sqlite3_errcode(sqlite3 *db){
  138669. if( db && !sqlite3SafetyCheckSickOrOk(db) ){
  138670. return SQLITE_MISUSE_BKPT;
  138671. }
  138672. if( !db || db->mallocFailed ){
  138673. return SQLITE_NOMEM_BKPT;
  138674. }
  138675. return db->errCode & db->errMask;
  138676. }
  138677. SQLITE_API int sqlite3_extended_errcode(sqlite3 *db){
  138678. if( db && !sqlite3SafetyCheckSickOrOk(db) ){
  138679. return SQLITE_MISUSE_BKPT;
  138680. }
  138681. if( !db || db->mallocFailed ){
  138682. return SQLITE_NOMEM_BKPT;
  138683. }
  138684. return db->errCode;
  138685. }
  138686. SQLITE_API int sqlite3_system_errno(sqlite3 *db){
  138687. return db ? db->iSysErrno : 0;
  138688. }
  138689. /*
  138690. ** Return a string that describes the kind of error specified in the
  138691. ** argument. For now, this simply calls the internal sqlite3ErrStr()
  138692. ** function.
  138693. */
  138694. SQLITE_API const char *sqlite3_errstr(int rc){
  138695. return sqlite3ErrStr(rc);
  138696. }
  138697. /*
  138698. ** Create a new collating function for database "db". The name is zName
  138699. ** and the encoding is enc.
  138700. */
  138701. static int createCollation(
  138702. sqlite3* db,
  138703. const char *zName,
  138704. u8 enc,
  138705. void* pCtx,
  138706. int(*xCompare)(void*,int,const void*,int,const void*),
  138707. void(*xDel)(void*)
  138708. ){
  138709. CollSeq *pColl;
  138710. int enc2;
  138711. assert( sqlite3_mutex_held(db->mutex) );
  138712. /* If SQLITE_UTF16 is specified as the encoding type, transform this
  138713. ** to one of SQLITE_UTF16LE or SQLITE_UTF16BE using the
  138714. ** SQLITE_UTF16NATIVE macro. SQLITE_UTF16 is not used internally.
  138715. */
  138716. enc2 = enc;
  138717. testcase( enc2==SQLITE_UTF16 );
  138718. testcase( enc2==SQLITE_UTF16_ALIGNED );
  138719. if( enc2==SQLITE_UTF16 || enc2==SQLITE_UTF16_ALIGNED ){
  138720. enc2 = SQLITE_UTF16NATIVE;
  138721. }
  138722. if( enc2<SQLITE_UTF8 || enc2>SQLITE_UTF16BE ){
  138723. return SQLITE_MISUSE_BKPT;
  138724. }
  138725. /* Check if this call is removing or replacing an existing collation
  138726. ** sequence. If so, and there are active VMs, return busy. If there
  138727. ** are no active VMs, invalidate any pre-compiled statements.
  138728. */
  138729. pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 0);
  138730. if( pColl && pColl->xCmp ){
  138731. if( db->nVdbeActive ){
  138732. sqlite3ErrorWithMsg(db, SQLITE_BUSY,
  138733. "unable to delete/modify collation sequence due to active statements");
  138734. return SQLITE_BUSY;
  138735. }
  138736. sqlite3ExpirePreparedStatements(db);
  138737. /* If collation sequence pColl was created directly by a call to
  138738. ** sqlite3_create_collation, and not generated by synthCollSeq(),
  138739. ** then any copies made by synthCollSeq() need to be invalidated.
  138740. ** Also, collation destructor - CollSeq.xDel() - function may need
  138741. ** to be called.
  138742. */
  138743. if( (pColl->enc & ~SQLITE_UTF16_ALIGNED)==enc2 ){
  138744. CollSeq *aColl = sqlite3HashFind(&db->aCollSeq, zName);
  138745. int j;
  138746. for(j=0; j<3; j++){
  138747. CollSeq *p = &aColl[j];
  138748. if( p->enc==pColl->enc ){
  138749. if( p->xDel ){
  138750. p->xDel(p->pUser);
  138751. }
  138752. p->xCmp = 0;
  138753. }
  138754. }
  138755. }
  138756. }
  138757. pColl = sqlite3FindCollSeq(db, (u8)enc2, zName, 1);
  138758. if( pColl==0 ) return SQLITE_NOMEM_BKPT;
  138759. pColl->xCmp = xCompare;
  138760. pColl->pUser = pCtx;
  138761. pColl->xDel = xDel;
  138762. pColl->enc = (u8)(enc2 | (enc & SQLITE_UTF16_ALIGNED));
  138763. sqlite3Error(db, SQLITE_OK);
  138764. return SQLITE_OK;
  138765. }
  138766. /*
  138767. ** This array defines hard upper bounds on limit values. The
  138768. ** initializer must be kept in sync with the SQLITE_LIMIT_*
  138769. ** #defines in sqlite3.h.
  138770. */
  138771. static const int aHardLimit[] = {
  138772. SQLITE_MAX_LENGTH,
  138773. SQLITE_MAX_SQL_LENGTH,
  138774. SQLITE_MAX_COLUMN,
  138775. SQLITE_MAX_EXPR_DEPTH,
  138776. SQLITE_MAX_COMPOUND_SELECT,
  138777. SQLITE_MAX_VDBE_OP,
  138778. SQLITE_MAX_FUNCTION_ARG,
  138779. SQLITE_MAX_ATTACHED,
  138780. SQLITE_MAX_LIKE_PATTERN_LENGTH,
  138781. SQLITE_MAX_VARIABLE_NUMBER, /* IMP: R-38091-32352 */
  138782. SQLITE_MAX_TRIGGER_DEPTH,
  138783. SQLITE_MAX_WORKER_THREADS,
  138784. };
  138785. /*
  138786. ** Make sure the hard limits are set to reasonable values
  138787. */
  138788. #if SQLITE_MAX_LENGTH<100
  138789. # error SQLITE_MAX_LENGTH must be at least 100
  138790. #endif
  138791. #if SQLITE_MAX_SQL_LENGTH<100
  138792. # error SQLITE_MAX_SQL_LENGTH must be at least 100
  138793. #endif
  138794. #if SQLITE_MAX_SQL_LENGTH>SQLITE_MAX_LENGTH
  138795. # error SQLITE_MAX_SQL_LENGTH must not be greater than SQLITE_MAX_LENGTH
  138796. #endif
  138797. #if SQLITE_MAX_COMPOUND_SELECT<2
  138798. # error SQLITE_MAX_COMPOUND_SELECT must be at least 2
  138799. #endif
  138800. #if SQLITE_MAX_VDBE_OP<40
  138801. # error SQLITE_MAX_VDBE_OP must be at least 40
  138802. #endif
  138803. #if SQLITE_MAX_FUNCTION_ARG<0 || SQLITE_MAX_FUNCTION_ARG>127
  138804. # error SQLITE_MAX_FUNCTION_ARG must be between 0 and 127
  138805. #endif
  138806. #if SQLITE_MAX_ATTACHED<0 || SQLITE_MAX_ATTACHED>125
  138807. # error SQLITE_MAX_ATTACHED must be between 0 and 125
  138808. #endif
  138809. #if SQLITE_MAX_LIKE_PATTERN_LENGTH<1
  138810. # error SQLITE_MAX_LIKE_PATTERN_LENGTH must be at least 1
  138811. #endif
  138812. #if SQLITE_MAX_COLUMN>32767
  138813. # error SQLITE_MAX_COLUMN must not exceed 32767
  138814. #endif
  138815. #if SQLITE_MAX_TRIGGER_DEPTH<1
  138816. # error SQLITE_MAX_TRIGGER_DEPTH must be at least 1
  138817. #endif
  138818. #if SQLITE_MAX_WORKER_THREADS<0 || SQLITE_MAX_WORKER_THREADS>50
  138819. # error SQLITE_MAX_WORKER_THREADS must be between 0 and 50
  138820. #endif
  138821. /*
  138822. ** Change the value of a limit. Report the old value.
  138823. ** If an invalid limit index is supplied, report -1.
  138824. ** Make no changes but still report the old value if the
  138825. ** new limit is negative.
  138826. **
  138827. ** A new lower limit does not shrink existing constructs.
  138828. ** It merely prevents new constructs that exceed the limit
  138829. ** from forming.
  138830. */
  138831. SQLITE_API int sqlite3_limit(sqlite3 *db, int limitId, int newLimit){
  138832. int oldLimit;
  138833. #ifdef SQLITE_ENABLE_API_ARMOR
  138834. if( !sqlite3SafetyCheckOk(db) ){
  138835. (void)SQLITE_MISUSE_BKPT;
  138836. return -1;
  138837. }
  138838. #endif
  138839. /* EVIDENCE-OF: R-30189-54097 For each limit category SQLITE_LIMIT_NAME
  138840. ** there is a hard upper bound set at compile-time by a C preprocessor
  138841. ** macro called SQLITE_MAX_NAME. (The "_LIMIT_" in the name is changed to
  138842. ** "_MAX_".)
  138843. */
  138844. assert( aHardLimit[SQLITE_LIMIT_LENGTH]==SQLITE_MAX_LENGTH );
  138845. assert( aHardLimit[SQLITE_LIMIT_SQL_LENGTH]==SQLITE_MAX_SQL_LENGTH );
  138846. assert( aHardLimit[SQLITE_LIMIT_COLUMN]==SQLITE_MAX_COLUMN );
  138847. assert( aHardLimit[SQLITE_LIMIT_EXPR_DEPTH]==SQLITE_MAX_EXPR_DEPTH );
  138848. assert( aHardLimit[SQLITE_LIMIT_COMPOUND_SELECT]==SQLITE_MAX_COMPOUND_SELECT);
  138849. assert( aHardLimit[SQLITE_LIMIT_VDBE_OP]==SQLITE_MAX_VDBE_OP );
  138850. assert( aHardLimit[SQLITE_LIMIT_FUNCTION_ARG]==SQLITE_MAX_FUNCTION_ARG );
  138851. assert( aHardLimit[SQLITE_LIMIT_ATTACHED]==SQLITE_MAX_ATTACHED );
  138852. assert( aHardLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH]==
  138853. SQLITE_MAX_LIKE_PATTERN_LENGTH );
  138854. assert( aHardLimit[SQLITE_LIMIT_VARIABLE_NUMBER]==SQLITE_MAX_VARIABLE_NUMBER);
  138855. assert( aHardLimit[SQLITE_LIMIT_TRIGGER_DEPTH]==SQLITE_MAX_TRIGGER_DEPTH );
  138856. assert( aHardLimit[SQLITE_LIMIT_WORKER_THREADS]==SQLITE_MAX_WORKER_THREADS );
  138857. assert( SQLITE_LIMIT_WORKER_THREADS==(SQLITE_N_LIMIT-1) );
  138858. if( limitId<0 || limitId>=SQLITE_N_LIMIT ){
  138859. return -1;
  138860. }
  138861. oldLimit = db->aLimit[limitId];
  138862. if( newLimit>=0 ){ /* IMP: R-52476-28732 */
  138863. if( newLimit>aHardLimit[limitId] ){
  138864. newLimit = aHardLimit[limitId]; /* IMP: R-51463-25634 */
  138865. }
  138866. db->aLimit[limitId] = newLimit;
  138867. }
  138868. return oldLimit; /* IMP: R-53341-35419 */
  138869. }
  138870. /*
  138871. ** This function is used to parse both URIs and non-URI filenames passed by the
  138872. ** user to API functions sqlite3_open() or sqlite3_open_v2(), and for database
  138873. ** URIs specified as part of ATTACH statements.
  138874. **
  138875. ** The first argument to this function is the name of the VFS to use (or
  138876. ** a NULL to signify the default VFS) if the URI does not contain a "vfs=xxx"
  138877. ** query parameter. The second argument contains the URI (or non-URI filename)
  138878. ** itself. When this function is called the *pFlags variable should contain
  138879. ** the default flags to open the database handle with. The value stored in
  138880. ** *pFlags may be updated before returning if the URI filename contains
  138881. ** "cache=xxx" or "mode=xxx" query parameters.
  138882. **
  138883. ** If successful, SQLITE_OK is returned. In this case *ppVfs is set to point to
  138884. ** the VFS that should be used to open the database file. *pzFile is set to
  138885. ** point to a buffer containing the name of the file to open. It is the
  138886. ** responsibility of the caller to eventually call sqlite3_free() to release
  138887. ** this buffer.
  138888. **
  138889. ** If an error occurs, then an SQLite error code is returned and *pzErrMsg
  138890. ** may be set to point to a buffer containing an English language error
  138891. ** message. It is the responsibility of the caller to eventually release
  138892. ** this buffer by calling sqlite3_free().
  138893. */
  138894. SQLITE_PRIVATE int sqlite3ParseUri(
  138895. const char *zDefaultVfs, /* VFS to use if no "vfs=xxx" query option */
  138896. const char *zUri, /* Nul-terminated URI to parse */
  138897. unsigned int *pFlags, /* IN/OUT: SQLITE_OPEN_XXX flags */
  138898. sqlite3_vfs **ppVfs, /* OUT: VFS to use */
  138899. char **pzFile, /* OUT: Filename component of URI */
  138900. char **pzErrMsg /* OUT: Error message (if rc!=SQLITE_OK) */
  138901. ){
  138902. int rc = SQLITE_OK;
  138903. unsigned int flags = *pFlags;
  138904. const char *zVfs = zDefaultVfs;
  138905. char *zFile;
  138906. char c;
  138907. int nUri = sqlite3Strlen30(zUri);
  138908. assert( *pzErrMsg==0 );
  138909. if( ((flags & SQLITE_OPEN_URI) /* IMP: R-48725-32206 */
  138910. || sqlite3GlobalConfig.bOpenUri) /* IMP: R-51689-46548 */
  138911. && nUri>=5 && memcmp(zUri, "file:", 5)==0 /* IMP: R-57884-37496 */
  138912. ){
  138913. char *zOpt;
  138914. int eState; /* Parser state when parsing URI */
  138915. int iIn; /* Input character index */
  138916. int iOut = 0; /* Output character index */
  138917. u64 nByte = nUri+2; /* Bytes of space to allocate */
  138918. /* Make sure the SQLITE_OPEN_URI flag is set to indicate to the VFS xOpen
  138919. ** method that there may be extra parameters following the file-name. */
  138920. flags |= SQLITE_OPEN_URI;
  138921. for(iIn=0; iIn<nUri; iIn++) nByte += (zUri[iIn]=='&');
  138922. zFile = sqlite3_malloc64(nByte);
  138923. if( !zFile ) return SQLITE_NOMEM_BKPT;
  138924. iIn = 5;
  138925. #ifdef SQLITE_ALLOW_URI_AUTHORITY
  138926. if( strncmp(zUri+5, "///", 3)==0 ){
  138927. iIn = 7;
  138928. /* The following condition causes URIs with five leading / characters
  138929. ** like file://///host/path to be converted into UNCs like //host/path.
  138930. ** The correct URI for that UNC has only two or four leading / characters
  138931. ** file://host/path or file:////host/path. But 5 leading slashes is a
  138932. ** common error, we are told, so we handle it as a special case. */
  138933. if( strncmp(zUri+7, "///", 3)==0 ){ iIn++; }
  138934. }else if( strncmp(zUri+5, "//localhost/", 12)==0 ){
  138935. iIn = 16;
  138936. }
  138937. #else
  138938. /* Discard the scheme and authority segments of the URI. */
  138939. if( zUri[5]=='/' && zUri[6]=='/' ){
  138940. iIn = 7;
  138941. while( zUri[iIn] && zUri[iIn]!='/' ) iIn++;
  138942. if( iIn!=7 && (iIn!=16 || memcmp("localhost", &zUri[7], 9)) ){
  138943. *pzErrMsg = sqlite3_mprintf("invalid uri authority: %.*s",
  138944. iIn-7, &zUri[7]);
  138945. rc = SQLITE_ERROR;
  138946. goto parse_uri_out;
  138947. }
  138948. }
  138949. #endif
  138950. /* Copy the filename and any query parameters into the zFile buffer.
  138951. ** Decode %HH escape codes along the way.
  138952. **
  138953. ** Within this loop, variable eState may be set to 0, 1 or 2, depending
  138954. ** on the parsing context. As follows:
  138955. **
  138956. ** 0: Parsing file-name.
  138957. ** 1: Parsing name section of a name=value query parameter.
  138958. ** 2: Parsing value section of a name=value query parameter.
  138959. */
  138960. eState = 0;
  138961. while( (c = zUri[iIn])!=0 && c!='#' ){
  138962. iIn++;
  138963. if( c=='%'
  138964. && sqlite3Isxdigit(zUri[iIn])
  138965. && sqlite3Isxdigit(zUri[iIn+1])
  138966. ){
  138967. int octet = (sqlite3HexToInt(zUri[iIn++]) << 4);
  138968. octet += sqlite3HexToInt(zUri[iIn++]);
  138969. assert( octet>=0 && octet<256 );
  138970. if( octet==0 ){
  138971. #ifndef SQLITE_ENABLE_URI_00_ERROR
  138972. /* This branch is taken when "%00" appears within the URI. In this
  138973. ** case we ignore all text in the remainder of the path, name or
  138974. ** value currently being parsed. So ignore the current character
  138975. ** and skip to the next "?", "=" or "&", as appropriate. */
  138976. while( (c = zUri[iIn])!=0 && c!='#'
  138977. && (eState!=0 || c!='?')
  138978. && (eState!=1 || (c!='=' && c!='&'))
  138979. && (eState!=2 || c!='&')
  138980. ){
  138981. iIn++;
  138982. }
  138983. continue;
  138984. #else
  138985. /* If ENABLE_URI_00_ERROR is defined, "%00" in a URI is an error. */
  138986. *pzErrMsg = sqlite3_mprintf("unexpected %%00 in uri");
  138987. rc = SQLITE_ERROR;
  138988. goto parse_uri_out;
  138989. #endif
  138990. }
  138991. c = octet;
  138992. }else if( eState==1 && (c=='&' || c=='=') ){
  138993. if( zFile[iOut-1]==0 ){
  138994. /* An empty option name. Ignore this option altogether. */
  138995. while( zUri[iIn] && zUri[iIn]!='#' && zUri[iIn-1]!='&' ) iIn++;
  138996. continue;
  138997. }
  138998. if( c=='&' ){
  138999. zFile[iOut++] = '\0';
  139000. }else{
  139001. eState = 2;
  139002. }
  139003. c = 0;
  139004. }else if( (eState==0 && c=='?') || (eState==2 && c=='&') ){
  139005. c = 0;
  139006. eState = 1;
  139007. }
  139008. zFile[iOut++] = c;
  139009. }
  139010. if( eState==1 ) zFile[iOut++] = '\0';
  139011. zFile[iOut++] = '\0';
  139012. zFile[iOut++] = '\0';
  139013. /* Check if there were any options specified that should be interpreted
  139014. ** here. Options that are interpreted here include "vfs" and those that
  139015. ** correspond to flags that may be passed to the sqlite3_open_v2()
  139016. ** method. */
  139017. zOpt = &zFile[sqlite3Strlen30(zFile)+1];
  139018. while( zOpt[0] ){
  139019. int nOpt = sqlite3Strlen30(zOpt);
  139020. char *zVal = &zOpt[nOpt+1];
  139021. int nVal = sqlite3Strlen30(zVal);
  139022. if( nOpt==3 && memcmp("vfs", zOpt, 3)==0 ){
  139023. zVfs = zVal;
  139024. }else{
  139025. struct OpenMode {
  139026. const char *z;
  139027. int mode;
  139028. } *aMode = 0;
  139029. char *zModeType = 0;
  139030. int mask = 0;
  139031. int limit = 0;
  139032. if( nOpt==5 && memcmp("cache", zOpt, 5)==0 ){
  139033. static struct OpenMode aCacheMode[] = {
  139034. { "shared", SQLITE_OPEN_SHAREDCACHE },
  139035. { "private", SQLITE_OPEN_PRIVATECACHE },
  139036. { 0, 0 }
  139037. };
  139038. mask = SQLITE_OPEN_SHAREDCACHE|SQLITE_OPEN_PRIVATECACHE;
  139039. aMode = aCacheMode;
  139040. limit = mask;
  139041. zModeType = "cache";
  139042. }
  139043. if( nOpt==4 && memcmp("mode", zOpt, 4)==0 ){
  139044. static struct OpenMode aOpenMode[] = {
  139045. { "ro", SQLITE_OPEN_READONLY },
  139046. { "rw", SQLITE_OPEN_READWRITE },
  139047. { "rwc", SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE },
  139048. { "memory", SQLITE_OPEN_MEMORY },
  139049. { 0, 0 }
  139050. };
  139051. mask = SQLITE_OPEN_READONLY | SQLITE_OPEN_READWRITE
  139052. | SQLITE_OPEN_CREATE | SQLITE_OPEN_MEMORY;
  139053. aMode = aOpenMode;
  139054. limit = mask & flags;
  139055. zModeType = "access";
  139056. }
  139057. if( aMode ){
  139058. int i;
  139059. int mode = 0;
  139060. for(i=0; aMode[i].z; i++){
  139061. const char *z = aMode[i].z;
  139062. if( nVal==sqlite3Strlen30(z) && 0==memcmp(zVal, z, nVal) ){
  139063. mode = aMode[i].mode;
  139064. break;
  139065. }
  139066. }
  139067. if( mode==0 ){
  139068. *pzErrMsg = sqlite3_mprintf("no such %s mode: %s", zModeType, zVal);
  139069. rc = SQLITE_ERROR;
  139070. goto parse_uri_out;
  139071. }
  139072. if( (mode & ~SQLITE_OPEN_MEMORY)>limit ){
  139073. *pzErrMsg = sqlite3_mprintf("%s mode not allowed: %s",
  139074. zModeType, zVal);
  139075. rc = SQLITE_PERM;
  139076. goto parse_uri_out;
  139077. }
  139078. flags = (flags & ~mask) | mode;
  139079. }
  139080. }
  139081. zOpt = &zVal[nVal+1];
  139082. }
  139083. }else{
  139084. zFile = sqlite3_malloc64(nUri+2);
  139085. if( !zFile ) return SQLITE_NOMEM_BKPT;
  139086. if( nUri ){
  139087. memcpy(zFile, zUri, nUri);
  139088. }
  139089. zFile[nUri] = '\0';
  139090. zFile[nUri+1] = '\0';
  139091. flags &= ~SQLITE_OPEN_URI;
  139092. }
  139093. *ppVfs = sqlite3_vfs_find(zVfs);
  139094. if( *ppVfs==0 ){
  139095. *pzErrMsg = sqlite3_mprintf("no such vfs: %s", zVfs);
  139096. rc = SQLITE_ERROR;
  139097. }
  139098. parse_uri_out:
  139099. if( rc!=SQLITE_OK ){
  139100. sqlite3_free(zFile);
  139101. zFile = 0;
  139102. }
  139103. *pFlags = flags;
  139104. *pzFile = zFile;
  139105. return rc;
  139106. }
  139107. /*
  139108. ** This routine does the work of opening a database on behalf of
  139109. ** sqlite3_open() and sqlite3_open16(). The database filename "zFilename"
  139110. ** is UTF-8 encoded.
  139111. */
  139112. static int openDatabase(
  139113. const char *zFilename, /* Database filename UTF-8 encoded */
  139114. sqlite3 **ppDb, /* OUT: Returned database handle */
  139115. unsigned int flags, /* Operational flags */
  139116. const char *zVfs /* Name of the VFS to use */
  139117. ){
  139118. sqlite3 *db; /* Store allocated handle here */
  139119. int rc; /* Return code */
  139120. int isThreadsafe; /* True for threadsafe connections */
  139121. char *zOpen = 0; /* Filename argument to pass to BtreeOpen() */
  139122. char *zErrMsg = 0; /* Error message from sqlite3ParseUri() */
  139123. #ifdef SQLITE_ENABLE_API_ARMOR
  139124. if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
  139125. #endif
  139126. *ppDb = 0;
  139127. #ifndef SQLITE_OMIT_AUTOINIT
  139128. rc = sqlite3_initialize();
  139129. if( rc ) return rc;
  139130. #endif
  139131. if( sqlite3GlobalConfig.bCoreMutex==0 ){
  139132. isThreadsafe = 0;
  139133. }else if( flags & SQLITE_OPEN_NOMUTEX ){
  139134. isThreadsafe = 0;
  139135. }else if( flags & SQLITE_OPEN_FULLMUTEX ){
  139136. isThreadsafe = 1;
  139137. }else{
  139138. isThreadsafe = sqlite3GlobalConfig.bFullMutex;
  139139. }
  139140. if( flags & SQLITE_OPEN_PRIVATECACHE ){
  139141. flags &= ~SQLITE_OPEN_SHAREDCACHE;
  139142. }else if( sqlite3GlobalConfig.sharedCacheEnabled ){
  139143. flags |= SQLITE_OPEN_SHAREDCACHE;
  139144. }
  139145. /* Remove harmful bits from the flags parameter
  139146. **
  139147. ** The SQLITE_OPEN_NOMUTEX and SQLITE_OPEN_FULLMUTEX flags were
  139148. ** dealt with in the previous code block. Besides these, the only
  139149. ** valid input flags for sqlite3_open_v2() are SQLITE_OPEN_READONLY,
  139150. ** SQLITE_OPEN_READWRITE, SQLITE_OPEN_CREATE, SQLITE_OPEN_SHAREDCACHE,
  139151. ** SQLITE_OPEN_PRIVATECACHE, and some reserved bits. Silently mask
  139152. ** off all other flags.
  139153. */
  139154. flags &= ~( SQLITE_OPEN_DELETEONCLOSE |
  139155. SQLITE_OPEN_EXCLUSIVE |
  139156. SQLITE_OPEN_MAIN_DB |
  139157. SQLITE_OPEN_TEMP_DB |
  139158. SQLITE_OPEN_TRANSIENT_DB |
  139159. SQLITE_OPEN_MAIN_JOURNAL |
  139160. SQLITE_OPEN_TEMP_JOURNAL |
  139161. SQLITE_OPEN_SUBJOURNAL |
  139162. SQLITE_OPEN_MASTER_JOURNAL |
  139163. SQLITE_OPEN_NOMUTEX |
  139164. SQLITE_OPEN_FULLMUTEX |
  139165. SQLITE_OPEN_WAL
  139166. );
  139167. /* Allocate the sqlite data structure */
  139168. db = sqlite3MallocZero( sizeof(sqlite3) );
  139169. if( db==0 ) goto opendb_out;
  139170. if( isThreadsafe
  139171. #ifdef SQLITE_ENABLE_MULTITHREADED_CHECKS
  139172. || sqlite3GlobalConfig.bCoreMutex
  139173. #endif
  139174. ){
  139175. db->mutex = sqlite3MutexAlloc(SQLITE_MUTEX_RECURSIVE);
  139176. if( db->mutex==0 ){
  139177. sqlite3_free(db);
  139178. db = 0;
  139179. goto opendb_out;
  139180. }
  139181. if( isThreadsafe==0 ){
  139182. sqlite3MutexWarnOnContention(db->mutex);
  139183. }
  139184. }
  139185. sqlite3_mutex_enter(db->mutex);
  139186. db->errMask = 0xff;
  139187. db->nDb = 2;
  139188. db->magic = SQLITE_MAGIC_BUSY;
  139189. db->aDb = db->aDbStatic;
  139190. assert( sizeof(db->aLimit)==sizeof(aHardLimit) );
  139191. memcpy(db->aLimit, aHardLimit, sizeof(db->aLimit));
  139192. db->aLimit[SQLITE_LIMIT_WORKER_THREADS] = SQLITE_DEFAULT_WORKER_THREADS;
  139193. db->autoCommit = 1;
  139194. db->nextAutovac = -1;
  139195. db->szMmap = sqlite3GlobalConfig.szMmap;
  139196. db->nextPagesize = 0;
  139197. db->nMaxSorterMmap = 0x7FFFFFFF;
  139198. db->flags |= SQLITE_ShortColNames | SQLITE_EnableTrigger | SQLITE_CacheSpill
  139199. #if !defined(SQLITE_DEFAULT_AUTOMATIC_INDEX) || SQLITE_DEFAULT_AUTOMATIC_INDEX
  139200. | SQLITE_AutoIndex
  139201. #endif
  139202. #if SQLITE_DEFAULT_CKPTFULLFSYNC
  139203. | SQLITE_CkptFullFSync
  139204. #endif
  139205. #if SQLITE_DEFAULT_FILE_FORMAT<4
  139206. | SQLITE_LegacyFileFmt
  139207. #endif
  139208. #ifdef SQLITE_ENABLE_LOAD_EXTENSION
  139209. | SQLITE_LoadExtension
  139210. #endif
  139211. #if SQLITE_DEFAULT_RECURSIVE_TRIGGERS
  139212. | SQLITE_RecTriggers
  139213. #endif
  139214. #if defined(SQLITE_DEFAULT_FOREIGN_KEYS) && SQLITE_DEFAULT_FOREIGN_KEYS
  139215. | SQLITE_ForeignKeys
  139216. #endif
  139217. #if defined(SQLITE_REVERSE_UNORDERED_SELECTS)
  139218. | SQLITE_ReverseOrder
  139219. #endif
  139220. #if defined(SQLITE_ENABLE_OVERSIZE_CELL_CHECK)
  139221. | SQLITE_CellSizeCk
  139222. #endif
  139223. #if defined(SQLITE_ENABLE_FTS3_TOKENIZER)
  139224. | SQLITE_Fts3Tokenizer
  139225. #endif
  139226. #if defined(SQLITE_ENABLE_QPSG)
  139227. | SQLITE_EnableQPSG
  139228. #endif
  139229. ;
  139230. sqlite3HashInit(&db->aCollSeq);
  139231. #ifndef SQLITE_OMIT_VIRTUALTABLE
  139232. sqlite3HashInit(&db->aModule);
  139233. #endif
  139234. /* Add the default collation sequence BINARY. BINARY works for both UTF-8
  139235. ** and UTF-16, so add a version for each to avoid any unnecessary
  139236. ** conversions. The only error that can occur here is a malloc() failure.
  139237. **
  139238. ** EVIDENCE-OF: R-52786-44878 SQLite defines three built-in collating
  139239. ** functions:
  139240. */
  139241. createCollation(db, sqlite3StrBINARY, SQLITE_UTF8, 0, binCollFunc, 0);
  139242. createCollation(db, sqlite3StrBINARY, SQLITE_UTF16BE, 0, binCollFunc, 0);
  139243. createCollation(db, sqlite3StrBINARY, SQLITE_UTF16LE, 0, binCollFunc, 0);
  139244. createCollation(db, "NOCASE", SQLITE_UTF8, 0, nocaseCollatingFunc, 0);
  139245. createCollation(db, "RTRIM", SQLITE_UTF8, (void*)1, binCollFunc, 0);
  139246. if( db->mallocFailed ){
  139247. goto opendb_out;
  139248. }
  139249. /* EVIDENCE-OF: R-08308-17224 The default collating function for all
  139250. ** strings is BINARY.
  139251. */
  139252. db->pDfltColl = sqlite3FindCollSeq(db, SQLITE_UTF8, sqlite3StrBINARY, 0);
  139253. assert( db->pDfltColl!=0 );
  139254. /* Parse the filename/URI argument
  139255. **
  139256. ** Only allow sensible combinations of bits in the flags argument.
  139257. ** Throw an error if any non-sense combination is used. If we
  139258. ** do not block illegal combinations here, it could trigger
  139259. ** assert() statements in deeper layers. Sensible combinations
  139260. ** are:
  139261. **
  139262. ** 1: SQLITE_OPEN_READONLY
  139263. ** 2: SQLITE_OPEN_READWRITE
  139264. ** 6: SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE
  139265. */
  139266. db->openFlags = flags;
  139267. assert( SQLITE_OPEN_READONLY == 0x01 );
  139268. assert( SQLITE_OPEN_READWRITE == 0x02 );
  139269. assert( SQLITE_OPEN_CREATE == 0x04 );
  139270. testcase( (1<<(flags&7))==0x02 ); /* READONLY */
  139271. testcase( (1<<(flags&7))==0x04 ); /* READWRITE */
  139272. testcase( (1<<(flags&7))==0x40 ); /* READWRITE | CREATE */
  139273. if( ((1<<(flags&7)) & 0x46)==0 ){
  139274. rc = SQLITE_MISUSE_BKPT; /* IMP: R-65497-44594 */
  139275. }else{
  139276. rc = sqlite3ParseUri(zVfs, zFilename, &flags, &db->pVfs, &zOpen, &zErrMsg);
  139277. }
  139278. if( rc!=SQLITE_OK ){
  139279. if( rc==SQLITE_NOMEM ) sqlite3OomFault(db);
  139280. sqlite3ErrorWithMsg(db, rc, zErrMsg ? "%s" : 0, zErrMsg);
  139281. sqlite3_free(zErrMsg);
  139282. goto opendb_out;
  139283. }
  139284. /* Open the backend database driver */
  139285. rc = sqlite3BtreeOpen(db->pVfs, zOpen, db, &db->aDb[0].pBt, 0,
  139286. flags | SQLITE_OPEN_MAIN_DB);
  139287. if( rc!=SQLITE_OK ){
  139288. if( rc==SQLITE_IOERR_NOMEM ){
  139289. rc = SQLITE_NOMEM_BKPT;
  139290. }
  139291. sqlite3Error(db, rc);
  139292. goto opendb_out;
  139293. }
  139294. sqlite3BtreeEnter(db->aDb[0].pBt);
  139295. db->aDb[0].pSchema = sqlite3SchemaGet(db, db->aDb[0].pBt);
  139296. if( !db->mallocFailed ) ENC(db) = SCHEMA_ENC(db);
  139297. sqlite3BtreeLeave(db->aDb[0].pBt);
  139298. db->aDb[1].pSchema = sqlite3SchemaGet(db, 0);
  139299. /* The default safety_level for the main database is FULL; for the temp
  139300. ** database it is OFF. This matches the pager layer defaults.
  139301. */
  139302. db->aDb[0].zDbSName = "main";
  139303. db->aDb[0].safety_level = SQLITE_DEFAULT_SYNCHRONOUS+1;
  139304. db->aDb[1].zDbSName = "temp";
  139305. db->aDb[1].safety_level = PAGER_SYNCHRONOUS_OFF;
  139306. db->magic = SQLITE_MAGIC_OPEN;
  139307. if( db->mallocFailed ){
  139308. goto opendb_out;
  139309. }
  139310. /* Register all built-in functions, but do not attempt to read the
  139311. ** database schema yet. This is delayed until the first time the database
  139312. ** is accessed.
  139313. */
  139314. sqlite3Error(db, SQLITE_OK);
  139315. sqlite3RegisterPerConnectionBuiltinFunctions(db);
  139316. rc = sqlite3_errcode(db);
  139317. #ifdef SQLITE_ENABLE_FTS5
  139318. /* Register any built-in FTS5 module before loading the automatic
  139319. ** extensions. This allows automatic extensions to register FTS5
  139320. ** tokenizers and auxiliary functions. */
  139321. if( !db->mallocFailed && rc==SQLITE_OK ){
  139322. rc = sqlite3Fts5Init(db);
  139323. }
  139324. #endif
  139325. /* Load automatic extensions - extensions that have been registered
  139326. ** using the sqlite3_automatic_extension() API.
  139327. */
  139328. if( rc==SQLITE_OK ){
  139329. sqlite3AutoLoadExtensions(db);
  139330. rc = sqlite3_errcode(db);
  139331. if( rc!=SQLITE_OK ){
  139332. goto opendb_out;
  139333. }
  139334. }
  139335. #ifdef SQLITE_ENABLE_FTS1
  139336. if( !db->mallocFailed ){
  139337. extern int sqlite3Fts1Init(sqlite3*);
  139338. rc = sqlite3Fts1Init(db);
  139339. }
  139340. #endif
  139341. #ifdef SQLITE_ENABLE_FTS2
  139342. if( !db->mallocFailed && rc==SQLITE_OK ){
  139343. extern int sqlite3Fts2Init(sqlite3*);
  139344. rc = sqlite3Fts2Init(db);
  139345. }
  139346. #endif
  139347. #ifdef SQLITE_ENABLE_FTS3 /* automatically defined by SQLITE_ENABLE_FTS4 */
  139348. if( !db->mallocFailed && rc==SQLITE_OK ){
  139349. rc = sqlite3Fts3Init(db);
  139350. }
  139351. #endif
  139352. #if defined(SQLITE_ENABLE_ICU) || defined(SQLITE_ENABLE_ICU_COLLATIONS)
  139353. if( !db->mallocFailed && rc==SQLITE_OK ){
  139354. rc = sqlite3IcuInit(db);
  139355. }
  139356. #endif
  139357. #ifdef SQLITE_ENABLE_RTREE
  139358. if( !db->mallocFailed && rc==SQLITE_OK){
  139359. rc = sqlite3RtreeInit(db);
  139360. }
  139361. #endif
  139362. #ifdef SQLITE_ENABLE_DBPAGE_VTAB
  139363. if( !db->mallocFailed && rc==SQLITE_OK){
  139364. rc = sqlite3DbpageRegister(db);
  139365. }
  139366. #endif
  139367. #ifdef SQLITE_ENABLE_DBSTAT_VTAB
  139368. if( !db->mallocFailed && rc==SQLITE_OK){
  139369. rc = sqlite3DbstatRegister(db);
  139370. }
  139371. #endif
  139372. #ifdef SQLITE_ENABLE_JSON1
  139373. if( !db->mallocFailed && rc==SQLITE_OK){
  139374. rc = sqlite3Json1Init(db);
  139375. }
  139376. #endif
  139377. #ifdef SQLITE_ENABLE_STMTVTAB
  139378. if( !db->mallocFailed && rc==SQLITE_OK){
  139379. rc = sqlite3StmtVtabInit(db);
  139380. }
  139381. #endif
  139382. /* -DSQLITE_DEFAULT_LOCKING_MODE=1 makes EXCLUSIVE the default locking
  139383. ** mode. -DSQLITE_DEFAULT_LOCKING_MODE=0 make NORMAL the default locking
  139384. ** mode. Doing nothing at all also makes NORMAL the default.
  139385. */
  139386. #ifdef SQLITE_DEFAULT_LOCKING_MODE
  139387. db->dfltLockMode = SQLITE_DEFAULT_LOCKING_MODE;
  139388. sqlite3PagerLockingMode(sqlite3BtreePager(db->aDb[0].pBt),
  139389. SQLITE_DEFAULT_LOCKING_MODE);
  139390. #endif
  139391. if( rc ) sqlite3Error(db, rc);
  139392. /* Enable the lookaside-malloc subsystem */
  139393. setupLookaside(db, 0, sqlite3GlobalConfig.szLookaside,
  139394. sqlite3GlobalConfig.nLookaside);
  139395. sqlite3_wal_autocheckpoint(db, SQLITE_DEFAULT_WAL_AUTOCHECKPOINT);
  139396. opendb_out:
  139397. if( db ){
  139398. assert( db->mutex!=0 || isThreadsafe==0
  139399. || sqlite3GlobalConfig.bFullMutex==0 );
  139400. sqlite3_mutex_leave(db->mutex);
  139401. }
  139402. rc = sqlite3_errcode(db);
  139403. assert( db!=0 || rc==SQLITE_NOMEM );
  139404. if( rc==SQLITE_NOMEM ){
  139405. sqlite3_close(db);
  139406. db = 0;
  139407. }else if( rc!=SQLITE_OK ){
  139408. db->magic = SQLITE_MAGIC_SICK;
  139409. }
  139410. *ppDb = db;
  139411. #ifdef SQLITE_ENABLE_SQLLOG
  139412. if( sqlite3GlobalConfig.xSqllog ){
  139413. /* Opening a db handle. Fourth parameter is passed 0. */
  139414. void *pArg = sqlite3GlobalConfig.pSqllogArg;
  139415. sqlite3GlobalConfig.xSqllog(pArg, db, zFilename, 0);
  139416. }
  139417. #endif
  139418. #if defined(SQLITE_HAS_CODEC)
  139419. if( rc==SQLITE_OK ){
  139420. const char *zKey;
  139421. if( (zKey = sqlite3_uri_parameter(zOpen, "hexkey"))!=0 && zKey[0] ){
  139422. u8 iByte;
  139423. int i;
  139424. char zDecoded[40];
  139425. for(i=0, iByte=0; i<sizeof(zDecoded)*2 && sqlite3Isxdigit(zKey[i]); i++){
  139426. iByte = (iByte<<4) + sqlite3HexToInt(zKey[i]);
  139427. if( (i&1)!=0 ) zDecoded[i/2] = iByte;
  139428. }
  139429. sqlite3_key_v2(db, 0, zDecoded, i/2);
  139430. }else if( (zKey = sqlite3_uri_parameter(zOpen, "key"))!=0 ){
  139431. sqlite3_key_v2(db, 0, zKey, sqlite3Strlen30(zKey));
  139432. }
  139433. }
  139434. #endif
  139435. sqlite3_free(zOpen);
  139436. return rc & 0xff;
  139437. }
  139438. /*
  139439. ** Open a new database handle.
  139440. */
  139441. SQLITE_API int sqlite3_open(
  139442. const char *zFilename,
  139443. sqlite3 **ppDb
  139444. ){
  139445. return openDatabase(zFilename, ppDb,
  139446. SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
  139447. }
  139448. SQLITE_API int sqlite3_open_v2(
  139449. const char *filename, /* Database filename (UTF-8) */
  139450. sqlite3 **ppDb, /* OUT: SQLite db handle */
  139451. int flags, /* Flags */
  139452. const char *zVfs /* Name of VFS module to use */
  139453. ){
  139454. return openDatabase(filename, ppDb, (unsigned int)flags, zVfs);
  139455. }
  139456. #ifndef SQLITE_OMIT_UTF16
  139457. /*
  139458. ** Open a new database handle.
  139459. */
  139460. SQLITE_API int sqlite3_open16(
  139461. const void *zFilename,
  139462. sqlite3 **ppDb
  139463. ){
  139464. char const *zFilename8; /* zFilename encoded in UTF-8 instead of UTF-16 */
  139465. sqlite3_value *pVal;
  139466. int rc;
  139467. #ifdef SQLITE_ENABLE_API_ARMOR
  139468. if( ppDb==0 ) return SQLITE_MISUSE_BKPT;
  139469. #endif
  139470. *ppDb = 0;
  139471. #ifndef SQLITE_OMIT_AUTOINIT
  139472. rc = sqlite3_initialize();
  139473. if( rc ) return rc;
  139474. #endif
  139475. if( zFilename==0 ) zFilename = "\000\000";
  139476. pVal = sqlite3ValueNew(0);
  139477. sqlite3ValueSetStr(pVal, -1, zFilename, SQLITE_UTF16NATIVE, SQLITE_STATIC);
  139478. zFilename8 = sqlite3ValueText(pVal, SQLITE_UTF8);
  139479. if( zFilename8 ){
  139480. rc = openDatabase(zFilename8, ppDb,
  139481. SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, 0);
  139482. assert( *ppDb || rc==SQLITE_NOMEM );
  139483. if( rc==SQLITE_OK && !DbHasProperty(*ppDb, 0, DB_SchemaLoaded) ){
  139484. SCHEMA_ENC(*ppDb) = ENC(*ppDb) = SQLITE_UTF16NATIVE;
  139485. }
  139486. }else{
  139487. rc = SQLITE_NOMEM_BKPT;
  139488. }
  139489. sqlite3ValueFree(pVal);
  139490. return rc & 0xff;
  139491. }
  139492. #endif /* SQLITE_OMIT_UTF16 */
  139493. /*
  139494. ** Register a new collation sequence with the database handle db.
  139495. */
  139496. SQLITE_API int sqlite3_create_collation(
  139497. sqlite3* db,
  139498. const char *zName,
  139499. int enc,
  139500. void* pCtx,
  139501. int(*xCompare)(void*,int,const void*,int,const void*)
  139502. ){
  139503. return sqlite3_create_collation_v2(db, zName, enc, pCtx, xCompare, 0);
  139504. }
  139505. /*
  139506. ** Register a new collation sequence with the database handle db.
  139507. */
  139508. SQLITE_API int sqlite3_create_collation_v2(
  139509. sqlite3* db,
  139510. const char *zName,
  139511. int enc,
  139512. void* pCtx,
  139513. int(*xCompare)(void*,int,const void*,int,const void*),
  139514. void(*xDel)(void*)
  139515. ){
  139516. int rc;
  139517. #ifdef SQLITE_ENABLE_API_ARMOR
  139518. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  139519. #endif
  139520. sqlite3_mutex_enter(db->mutex);
  139521. assert( !db->mallocFailed );
  139522. rc = createCollation(db, zName, (u8)enc, pCtx, xCompare, xDel);
  139523. rc = sqlite3ApiExit(db, rc);
  139524. sqlite3_mutex_leave(db->mutex);
  139525. return rc;
  139526. }
  139527. #ifndef SQLITE_OMIT_UTF16
  139528. /*
  139529. ** Register a new collation sequence with the database handle db.
  139530. */
  139531. SQLITE_API int sqlite3_create_collation16(
  139532. sqlite3* db,
  139533. const void *zName,
  139534. int enc,
  139535. void* pCtx,
  139536. int(*xCompare)(void*,int,const void*,int,const void*)
  139537. ){
  139538. int rc = SQLITE_OK;
  139539. char *zName8;
  139540. #ifdef SQLITE_ENABLE_API_ARMOR
  139541. if( !sqlite3SafetyCheckOk(db) || zName==0 ) return SQLITE_MISUSE_BKPT;
  139542. #endif
  139543. sqlite3_mutex_enter(db->mutex);
  139544. assert( !db->mallocFailed );
  139545. zName8 = sqlite3Utf16to8(db, zName, -1, SQLITE_UTF16NATIVE);
  139546. if( zName8 ){
  139547. rc = createCollation(db, zName8, (u8)enc, pCtx, xCompare, 0);
  139548. sqlite3DbFree(db, zName8);
  139549. }
  139550. rc = sqlite3ApiExit(db, rc);
  139551. sqlite3_mutex_leave(db->mutex);
  139552. return rc;
  139553. }
  139554. #endif /* SQLITE_OMIT_UTF16 */
  139555. /*
  139556. ** Register a collation sequence factory callback with the database handle
  139557. ** db. Replace any previously installed collation sequence factory.
  139558. */
  139559. SQLITE_API int sqlite3_collation_needed(
  139560. sqlite3 *db,
  139561. void *pCollNeededArg,
  139562. void(*xCollNeeded)(void*,sqlite3*,int eTextRep,const char*)
  139563. ){
  139564. #ifdef SQLITE_ENABLE_API_ARMOR
  139565. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  139566. #endif
  139567. sqlite3_mutex_enter(db->mutex);
  139568. db->xCollNeeded = xCollNeeded;
  139569. db->xCollNeeded16 = 0;
  139570. db->pCollNeededArg = pCollNeededArg;
  139571. sqlite3_mutex_leave(db->mutex);
  139572. return SQLITE_OK;
  139573. }
  139574. #ifndef SQLITE_OMIT_UTF16
  139575. /*
  139576. ** Register a collation sequence factory callback with the database handle
  139577. ** db. Replace any previously installed collation sequence factory.
  139578. */
  139579. SQLITE_API int sqlite3_collation_needed16(
  139580. sqlite3 *db,
  139581. void *pCollNeededArg,
  139582. void(*xCollNeeded16)(void*,sqlite3*,int eTextRep,const void*)
  139583. ){
  139584. #ifdef SQLITE_ENABLE_API_ARMOR
  139585. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  139586. #endif
  139587. sqlite3_mutex_enter(db->mutex);
  139588. db->xCollNeeded = 0;
  139589. db->xCollNeeded16 = xCollNeeded16;
  139590. db->pCollNeededArg = pCollNeededArg;
  139591. sqlite3_mutex_leave(db->mutex);
  139592. return SQLITE_OK;
  139593. }
  139594. #endif /* SQLITE_OMIT_UTF16 */
  139595. #ifndef SQLITE_OMIT_DEPRECATED
  139596. /*
  139597. ** This function is now an anachronism. It used to be used to recover from a
  139598. ** malloc() failure, but SQLite now does this automatically.
  139599. */
  139600. SQLITE_API int sqlite3_global_recover(void){
  139601. return SQLITE_OK;
  139602. }
  139603. #endif
  139604. /*
  139605. ** Test to see whether or not the database connection is in autocommit
  139606. ** mode. Return TRUE if it is and FALSE if not. Autocommit mode is on
  139607. ** by default. Autocommit is disabled by a BEGIN statement and reenabled
  139608. ** by the next COMMIT or ROLLBACK.
  139609. */
  139610. SQLITE_API int sqlite3_get_autocommit(sqlite3 *db){
  139611. #ifdef SQLITE_ENABLE_API_ARMOR
  139612. if( !sqlite3SafetyCheckOk(db) ){
  139613. (void)SQLITE_MISUSE_BKPT;
  139614. return 0;
  139615. }
  139616. #endif
  139617. return db->autoCommit;
  139618. }
  139619. /*
  139620. ** The following routines are substitutes for constants SQLITE_CORRUPT,
  139621. ** SQLITE_MISUSE, SQLITE_CANTOPEN, SQLITE_NOMEM and possibly other error
  139622. ** constants. They serve two purposes:
  139623. **
  139624. ** 1. Serve as a convenient place to set a breakpoint in a debugger
  139625. ** to detect when version error conditions occurs.
  139626. **
  139627. ** 2. Invoke sqlite3_log() to provide the source code location where
  139628. ** a low-level error is first detected.
  139629. */
  139630. SQLITE_PRIVATE int sqlite3ReportError(int iErr, int lineno, const char *zType){
  139631. sqlite3_log(iErr, "%s at line %d of [%.10s]",
  139632. zType, lineno, 20+sqlite3_sourceid());
  139633. return iErr;
  139634. }
  139635. SQLITE_PRIVATE int sqlite3CorruptError(int lineno){
  139636. testcase( sqlite3GlobalConfig.xLog!=0 );
  139637. return sqlite3ReportError(SQLITE_CORRUPT, lineno, "database corruption");
  139638. }
  139639. SQLITE_PRIVATE int sqlite3MisuseError(int lineno){
  139640. testcase( sqlite3GlobalConfig.xLog!=0 );
  139641. return sqlite3ReportError(SQLITE_MISUSE, lineno, "misuse");
  139642. }
  139643. SQLITE_PRIVATE int sqlite3CantopenError(int lineno){
  139644. testcase( sqlite3GlobalConfig.xLog!=0 );
  139645. return sqlite3ReportError(SQLITE_CANTOPEN, lineno, "cannot open file");
  139646. }
  139647. #ifdef SQLITE_DEBUG
  139648. SQLITE_PRIVATE int sqlite3CorruptPgnoError(int lineno, Pgno pgno){
  139649. char zMsg[100];
  139650. sqlite3_snprintf(sizeof(zMsg), zMsg, "database corruption page %d", pgno);
  139651. testcase( sqlite3GlobalConfig.xLog!=0 );
  139652. return sqlite3ReportError(SQLITE_CORRUPT, lineno, zMsg);
  139653. }
  139654. SQLITE_PRIVATE int sqlite3NomemError(int lineno){
  139655. testcase( sqlite3GlobalConfig.xLog!=0 );
  139656. return sqlite3ReportError(SQLITE_NOMEM, lineno, "OOM");
  139657. }
  139658. SQLITE_PRIVATE int sqlite3IoerrnomemError(int lineno){
  139659. testcase( sqlite3GlobalConfig.xLog!=0 );
  139660. return sqlite3ReportError(SQLITE_IOERR_NOMEM, lineno, "I/O OOM error");
  139661. }
  139662. #endif
  139663. #ifndef SQLITE_OMIT_DEPRECATED
  139664. /*
  139665. ** This is a convenience routine that makes sure that all thread-specific
  139666. ** data for this thread has been deallocated.
  139667. **
  139668. ** SQLite no longer uses thread-specific data so this routine is now a
  139669. ** no-op. It is retained for historical compatibility.
  139670. */
  139671. SQLITE_API void sqlite3_thread_cleanup(void){
  139672. }
  139673. #endif
  139674. /*
  139675. ** Return meta information about a specific column of a database table.
  139676. ** See comment in sqlite3.h (sqlite.h.in) for details.
  139677. */
  139678. SQLITE_API int sqlite3_table_column_metadata(
  139679. sqlite3 *db, /* Connection handle */
  139680. const char *zDbName, /* Database name or NULL */
  139681. const char *zTableName, /* Table name */
  139682. const char *zColumnName, /* Column name */
  139683. char const **pzDataType, /* OUTPUT: Declared data type */
  139684. char const **pzCollSeq, /* OUTPUT: Collation sequence name */
  139685. int *pNotNull, /* OUTPUT: True if NOT NULL constraint exists */
  139686. int *pPrimaryKey, /* OUTPUT: True if column part of PK */
  139687. int *pAutoinc /* OUTPUT: True if column is auto-increment */
  139688. ){
  139689. int rc;
  139690. char *zErrMsg = 0;
  139691. Table *pTab = 0;
  139692. Column *pCol = 0;
  139693. int iCol = 0;
  139694. char const *zDataType = 0;
  139695. char const *zCollSeq = 0;
  139696. int notnull = 0;
  139697. int primarykey = 0;
  139698. int autoinc = 0;
  139699. #ifdef SQLITE_ENABLE_API_ARMOR
  139700. if( !sqlite3SafetyCheckOk(db) || zTableName==0 ){
  139701. return SQLITE_MISUSE_BKPT;
  139702. }
  139703. #endif
  139704. /* Ensure the database schema has been loaded */
  139705. sqlite3_mutex_enter(db->mutex);
  139706. sqlite3BtreeEnterAll(db);
  139707. rc = sqlite3Init(db, &zErrMsg);
  139708. if( SQLITE_OK!=rc ){
  139709. goto error_out;
  139710. }
  139711. /* Locate the table in question */
  139712. pTab = sqlite3FindTable(db, zTableName, zDbName);
  139713. if( !pTab || pTab->pSelect ){
  139714. pTab = 0;
  139715. goto error_out;
  139716. }
  139717. /* Find the column for which info is requested */
  139718. if( zColumnName==0 ){
  139719. /* Query for existance of table only */
  139720. }else{
  139721. for(iCol=0; iCol<pTab->nCol; iCol++){
  139722. pCol = &pTab->aCol[iCol];
  139723. if( 0==sqlite3StrICmp(pCol->zName, zColumnName) ){
  139724. break;
  139725. }
  139726. }
  139727. if( iCol==pTab->nCol ){
  139728. if( HasRowid(pTab) && sqlite3IsRowid(zColumnName) ){
  139729. iCol = pTab->iPKey;
  139730. pCol = iCol>=0 ? &pTab->aCol[iCol] : 0;
  139731. }else{
  139732. pTab = 0;
  139733. goto error_out;
  139734. }
  139735. }
  139736. }
  139737. /* The following block stores the meta information that will be returned
  139738. ** to the caller in local variables zDataType, zCollSeq, notnull, primarykey
  139739. ** and autoinc. At this point there are two possibilities:
  139740. **
  139741. ** 1. The specified column name was rowid", "oid" or "_rowid_"
  139742. ** and there is no explicitly declared IPK column.
  139743. **
  139744. ** 2. The table is not a view and the column name identified an
  139745. ** explicitly declared column. Copy meta information from *pCol.
  139746. */
  139747. if( pCol ){
  139748. zDataType = sqlite3ColumnType(pCol,0);
  139749. zCollSeq = pCol->zColl;
  139750. notnull = pCol->notNull!=0;
  139751. primarykey = (pCol->colFlags & COLFLAG_PRIMKEY)!=0;
  139752. autoinc = pTab->iPKey==iCol && (pTab->tabFlags & TF_Autoincrement)!=0;
  139753. }else{
  139754. zDataType = "INTEGER";
  139755. primarykey = 1;
  139756. }
  139757. if( !zCollSeq ){
  139758. zCollSeq = sqlite3StrBINARY;
  139759. }
  139760. error_out:
  139761. sqlite3BtreeLeaveAll(db);
  139762. /* Whether the function call succeeded or failed, set the output parameters
  139763. ** to whatever their local counterparts contain. If an error did occur,
  139764. ** this has the effect of zeroing all output parameters.
  139765. */
  139766. if( pzDataType ) *pzDataType = zDataType;
  139767. if( pzCollSeq ) *pzCollSeq = zCollSeq;
  139768. if( pNotNull ) *pNotNull = notnull;
  139769. if( pPrimaryKey ) *pPrimaryKey = primarykey;
  139770. if( pAutoinc ) *pAutoinc = autoinc;
  139771. if( SQLITE_OK==rc && !pTab ){
  139772. sqlite3DbFree(db, zErrMsg);
  139773. zErrMsg = sqlite3MPrintf(db, "no such table column: %s.%s", zTableName,
  139774. zColumnName);
  139775. rc = SQLITE_ERROR;
  139776. }
  139777. sqlite3ErrorWithMsg(db, rc, (zErrMsg?"%s":0), zErrMsg);
  139778. sqlite3DbFree(db, zErrMsg);
  139779. rc = sqlite3ApiExit(db, rc);
  139780. sqlite3_mutex_leave(db->mutex);
  139781. return rc;
  139782. }
  139783. /*
  139784. ** Sleep for a little while. Return the amount of time slept.
  139785. */
  139786. SQLITE_API int sqlite3_sleep(int ms){
  139787. sqlite3_vfs *pVfs;
  139788. int rc;
  139789. pVfs = sqlite3_vfs_find(0);
  139790. if( pVfs==0 ) return 0;
  139791. /* This function works in milliseconds, but the underlying OsSleep()
  139792. ** API uses microseconds. Hence the 1000's.
  139793. */
  139794. rc = (sqlite3OsSleep(pVfs, 1000*ms)/1000);
  139795. return rc;
  139796. }
  139797. /*
  139798. ** Enable or disable the extended result codes.
  139799. */
  139800. SQLITE_API int sqlite3_extended_result_codes(sqlite3 *db, int onoff){
  139801. #ifdef SQLITE_ENABLE_API_ARMOR
  139802. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  139803. #endif
  139804. sqlite3_mutex_enter(db->mutex);
  139805. db->errMask = onoff ? 0xffffffff : 0xff;
  139806. sqlite3_mutex_leave(db->mutex);
  139807. return SQLITE_OK;
  139808. }
  139809. /*
  139810. ** Invoke the xFileControl method on a particular database.
  139811. */
  139812. SQLITE_API int sqlite3_file_control(sqlite3 *db, const char *zDbName, int op, void *pArg){
  139813. int rc = SQLITE_ERROR;
  139814. Btree *pBtree;
  139815. #ifdef SQLITE_ENABLE_API_ARMOR
  139816. if( !sqlite3SafetyCheckOk(db) ) return SQLITE_MISUSE_BKPT;
  139817. #endif
  139818. sqlite3_mutex_enter(db->mutex);
  139819. pBtree = sqlite3DbNameToBtree(db, zDbName);
  139820. if( pBtree ){
  139821. Pager *pPager;
  139822. sqlite3_file *fd;
  139823. sqlite3BtreeEnter(pBtree);
  139824. pPager = sqlite3BtreePager(pBtree);
  139825. assert( pPager!=0 );
  139826. fd = sqlite3PagerFile(pPager);
  139827. assert( fd!=0 );
  139828. if( op==SQLITE_FCNTL_FILE_POINTER ){
  139829. *(sqlite3_file**)pArg = fd;
  139830. rc = SQLITE_OK;
  139831. }else if( op==SQLITE_FCNTL_VFS_POINTER ){
  139832. *(sqlite3_vfs**)pArg = sqlite3PagerVfs(pPager);
  139833. rc = SQLITE_OK;
  139834. }else if( op==SQLITE_FCNTL_JOURNAL_POINTER ){
  139835. *(sqlite3_file**)pArg = sqlite3PagerJrnlFile(pPager);
  139836. rc = SQLITE_OK;
  139837. }else{
  139838. rc = sqlite3OsFileControl(fd, op, pArg);
  139839. }
  139840. sqlite3BtreeLeave(pBtree);
  139841. }
  139842. sqlite3_mutex_leave(db->mutex);
  139843. return rc;
  139844. }
  139845. /*
  139846. ** Interface to the testing logic.
  139847. */
  139848. SQLITE_API int sqlite3_test_control(int op, ...){
  139849. int rc = 0;
  139850. #ifdef SQLITE_UNTESTABLE
  139851. UNUSED_PARAMETER(op);
  139852. #else
  139853. va_list ap;
  139854. va_start(ap, op);
  139855. switch( op ){
  139856. /*
  139857. ** Save the current state of the PRNG.
  139858. */
  139859. case SQLITE_TESTCTRL_PRNG_SAVE: {
  139860. sqlite3PrngSaveState();
  139861. break;
  139862. }
  139863. /*
  139864. ** Restore the state of the PRNG to the last state saved using
  139865. ** PRNG_SAVE. If PRNG_SAVE has never before been called, then
  139866. ** this verb acts like PRNG_RESET.
  139867. */
  139868. case SQLITE_TESTCTRL_PRNG_RESTORE: {
  139869. sqlite3PrngRestoreState();
  139870. break;
  139871. }
  139872. /*
  139873. ** Reset the PRNG back to its uninitialized state. The next call
  139874. ** to sqlite3_randomness() will reseed the PRNG using a single call
  139875. ** to the xRandomness method of the default VFS.
  139876. */
  139877. case SQLITE_TESTCTRL_PRNG_RESET: {
  139878. sqlite3_randomness(0,0);
  139879. break;
  139880. }
  139881. /*
  139882. ** sqlite3_test_control(BITVEC_TEST, size, program)
  139883. **
  139884. ** Run a test against a Bitvec object of size. The program argument
  139885. ** is an array of integers that defines the test. Return -1 on a
  139886. ** memory allocation error, 0 on success, or non-zero for an error.
  139887. ** See the sqlite3BitvecBuiltinTest() for additional information.
  139888. */
  139889. case SQLITE_TESTCTRL_BITVEC_TEST: {
  139890. int sz = va_arg(ap, int);
  139891. int *aProg = va_arg(ap, int*);
  139892. rc = sqlite3BitvecBuiltinTest(sz, aProg);
  139893. break;
  139894. }
  139895. /*
  139896. ** sqlite3_test_control(FAULT_INSTALL, xCallback)
  139897. **
  139898. ** Arrange to invoke xCallback() whenever sqlite3FaultSim() is called,
  139899. ** if xCallback is not NULL.
  139900. **
  139901. ** As a test of the fault simulator mechanism itself, sqlite3FaultSim(0)
  139902. ** is called immediately after installing the new callback and the return
  139903. ** value from sqlite3FaultSim(0) becomes the return from
  139904. ** sqlite3_test_control().
  139905. */
  139906. case SQLITE_TESTCTRL_FAULT_INSTALL: {
  139907. /* MSVC is picky about pulling func ptrs from va lists.
  139908. ** http://support.microsoft.com/kb/47961
  139909. ** sqlite3GlobalConfig.xTestCallback = va_arg(ap, int(*)(int));
  139910. */
  139911. typedef int(*TESTCALLBACKFUNC_t)(int);
  139912. sqlite3GlobalConfig.xTestCallback = va_arg(ap, TESTCALLBACKFUNC_t);
  139913. rc = sqlite3FaultSim(0);
  139914. break;
  139915. }
  139916. /*
  139917. ** sqlite3_test_control(BENIGN_MALLOC_HOOKS, xBegin, xEnd)
  139918. **
  139919. ** Register hooks to call to indicate which malloc() failures
  139920. ** are benign.
  139921. */
  139922. case SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS: {
  139923. typedef void (*void_function)(void);
  139924. void_function xBenignBegin;
  139925. void_function xBenignEnd;
  139926. xBenignBegin = va_arg(ap, void_function);
  139927. xBenignEnd = va_arg(ap, void_function);
  139928. sqlite3BenignMallocHooks(xBenignBegin, xBenignEnd);
  139929. break;
  139930. }
  139931. /*
  139932. ** sqlite3_test_control(SQLITE_TESTCTRL_PENDING_BYTE, unsigned int X)
  139933. **
  139934. ** Set the PENDING byte to the value in the argument, if X>0.
  139935. ** Make no changes if X==0. Return the value of the pending byte
  139936. ** as it existing before this routine was called.
  139937. **
  139938. ** IMPORTANT: Changing the PENDING byte from 0x40000000 results in
  139939. ** an incompatible database file format. Changing the PENDING byte
  139940. ** while any database connection is open results in undefined and
  139941. ** deleterious behavior.
  139942. */
  139943. case SQLITE_TESTCTRL_PENDING_BYTE: {
  139944. rc = PENDING_BYTE;
  139945. #ifndef SQLITE_OMIT_WSD
  139946. {
  139947. unsigned int newVal = va_arg(ap, unsigned int);
  139948. if( newVal ) sqlite3PendingByte = newVal;
  139949. }
  139950. #endif
  139951. break;
  139952. }
  139953. /*
  139954. ** sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, int X)
  139955. **
  139956. ** This action provides a run-time test to see whether or not
  139957. ** assert() was enabled at compile-time. If X is true and assert()
  139958. ** is enabled, then the return value is true. If X is true and
  139959. ** assert() is disabled, then the return value is zero. If X is
  139960. ** false and assert() is enabled, then the assertion fires and the
  139961. ** process aborts. If X is false and assert() is disabled, then the
  139962. ** return value is zero.
  139963. */
  139964. case SQLITE_TESTCTRL_ASSERT: {
  139965. volatile int x = 0;
  139966. assert( /*side-effects-ok*/ (x = va_arg(ap,int))!=0 );
  139967. rc = x;
  139968. break;
  139969. }
  139970. /*
  139971. ** sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, int X)
  139972. **
  139973. ** This action provides a run-time test to see how the ALWAYS and
  139974. ** NEVER macros were defined at compile-time.
  139975. **
  139976. ** The return value is ALWAYS(X) if X is true, or 0 if X is false.
  139977. **
  139978. ** The recommended test is X==2. If the return value is 2, that means
  139979. ** ALWAYS() and NEVER() are both no-op pass-through macros, which is the
  139980. ** default setting. If the return value is 1, then ALWAYS() is either
  139981. ** hard-coded to true or else it asserts if its argument is false.
  139982. ** The first behavior (hard-coded to true) is the case if
  139983. ** SQLITE_TESTCTRL_ASSERT shows that assert() is disabled and the second
  139984. ** behavior (assert if the argument to ALWAYS() is false) is the case if
  139985. ** SQLITE_TESTCTRL_ASSERT shows that assert() is enabled.
  139986. **
  139987. ** The run-time test procedure might look something like this:
  139988. **
  139989. ** if( sqlite3_test_control(SQLITE_TESTCTRL_ALWAYS, 2)==2 ){
  139990. ** // ALWAYS() and NEVER() are no-op pass-through macros
  139991. ** }else if( sqlite3_test_control(SQLITE_TESTCTRL_ASSERT, 1) ){
  139992. ** // ALWAYS(x) asserts that x is true. NEVER(x) asserts x is false.
  139993. ** }else{
  139994. ** // ALWAYS(x) is a constant 1. NEVER(x) is a constant 0.
  139995. ** }
  139996. */
  139997. case SQLITE_TESTCTRL_ALWAYS: {
  139998. int x = va_arg(ap,int);
  139999. rc = x ? ALWAYS(x) : 0;
  140000. break;
  140001. }
  140002. /*
  140003. ** sqlite3_test_control(SQLITE_TESTCTRL_BYTEORDER);
  140004. **
  140005. ** The integer returned reveals the byte-order of the computer on which
  140006. ** SQLite is running:
  140007. **
  140008. ** 1 big-endian, determined at run-time
  140009. ** 10 little-endian, determined at run-time
  140010. ** 432101 big-endian, determined at compile-time
  140011. ** 123410 little-endian, determined at compile-time
  140012. */
  140013. case SQLITE_TESTCTRL_BYTEORDER: {
  140014. rc = SQLITE_BYTEORDER*100 + SQLITE_LITTLEENDIAN*10 + SQLITE_BIGENDIAN;
  140015. break;
  140016. }
  140017. /* sqlite3_test_control(SQLITE_TESTCTRL_RESERVE, sqlite3 *db, int N)
  140018. **
  140019. ** Set the nReserve size to N for the main database on the database
  140020. ** connection db.
  140021. */
  140022. case SQLITE_TESTCTRL_RESERVE: {
  140023. sqlite3 *db = va_arg(ap, sqlite3*);
  140024. int x = va_arg(ap,int);
  140025. sqlite3_mutex_enter(db->mutex);
  140026. sqlite3BtreeSetPageSize(db->aDb[0].pBt, 0, x, 0);
  140027. sqlite3_mutex_leave(db->mutex);
  140028. break;
  140029. }
  140030. /* sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS, sqlite3 *db, int N)
  140031. **
  140032. ** Enable or disable various optimizations for testing purposes. The
  140033. ** argument N is a bitmask of optimizations to be disabled. For normal
  140034. ** operation N should be 0. The idea is that a test program (like the
  140035. ** SQL Logic Test or SLT test module) can run the same SQL multiple times
  140036. ** with various optimizations disabled to verify that the same answer
  140037. ** is obtained in every case.
  140038. */
  140039. case SQLITE_TESTCTRL_OPTIMIZATIONS: {
  140040. sqlite3 *db = va_arg(ap, sqlite3*);
  140041. db->dbOptFlags = (u16)(va_arg(ap, int) & 0xffff);
  140042. break;
  140043. }
  140044. #ifdef SQLITE_N_KEYWORD
  140045. /* sqlite3_test_control(SQLITE_TESTCTRL_ISKEYWORD, const char *zWord)
  140046. **
  140047. ** If zWord is a keyword recognized by the parser, then return the
  140048. ** number of keywords. Or if zWord is not a keyword, return 0.
  140049. **
  140050. ** This test feature is only available in the amalgamation since
  140051. ** the SQLITE_N_KEYWORD macro is not defined in this file if SQLite
  140052. ** is built using separate source files.
  140053. */
  140054. case SQLITE_TESTCTRL_ISKEYWORD: {
  140055. const char *zWord = va_arg(ap, const char*);
  140056. int n = sqlite3Strlen30(zWord);
  140057. rc = (sqlite3KeywordCode((u8*)zWord, n)!=TK_ID) ? SQLITE_N_KEYWORD : 0;
  140058. break;
  140059. }
  140060. #endif
  140061. /* sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
  140062. **
  140063. ** If parameter onoff is non-zero, configure the wrappers so that all
  140064. ** subsequent calls to localtime() and variants fail. If onoff is zero,
  140065. ** undo this setting.
  140066. */
  140067. case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
  140068. sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
  140069. break;
  140070. }
  140071. /* sqlite3_test_control(SQLITE_TESTCTRL_NEVER_CORRUPT, int);
  140072. **
  140073. ** Set or clear a flag that indicates that the database file is always well-
  140074. ** formed and never corrupt. This flag is clear by default, indicating that
  140075. ** database files might have arbitrary corruption. Setting the flag during
  140076. ** testing causes certain assert() statements in the code to be activated
  140077. ** that demonstrat invariants on well-formed database files.
  140078. */
  140079. case SQLITE_TESTCTRL_NEVER_CORRUPT: {
  140080. sqlite3GlobalConfig.neverCorrupt = va_arg(ap, int);
  140081. break;
  140082. }
  140083. /* Set the threshold at which OP_Once counters reset back to zero.
  140084. ** By default this is 0x7ffffffe (over 2 billion), but that value is
  140085. ** too big to test in a reasonable amount of time, so this control is
  140086. ** provided to set a small and easily reachable reset value.
  140087. */
  140088. case SQLITE_TESTCTRL_ONCE_RESET_THRESHOLD: {
  140089. sqlite3GlobalConfig.iOnceResetThreshold = va_arg(ap, int);
  140090. break;
  140091. }
  140092. /* sqlite3_test_control(SQLITE_TESTCTRL_VDBE_COVERAGE, xCallback, ptr);
  140093. **
  140094. ** Set the VDBE coverage callback function to xCallback with context
  140095. ** pointer ptr.
  140096. */
  140097. case SQLITE_TESTCTRL_VDBE_COVERAGE: {
  140098. #ifdef SQLITE_VDBE_COVERAGE
  140099. typedef void (*branch_callback)(void*,int,u8,u8);
  140100. sqlite3GlobalConfig.xVdbeBranch = va_arg(ap,branch_callback);
  140101. sqlite3GlobalConfig.pVdbeBranchArg = va_arg(ap,void*);
  140102. #endif
  140103. break;
  140104. }
  140105. /* sqlite3_test_control(SQLITE_TESTCTRL_SORTER_MMAP, db, nMax); */
  140106. case SQLITE_TESTCTRL_SORTER_MMAP: {
  140107. sqlite3 *db = va_arg(ap, sqlite3*);
  140108. db->nMaxSorterMmap = va_arg(ap, int);
  140109. break;
  140110. }
  140111. /* sqlite3_test_control(SQLITE_TESTCTRL_ISINIT);
  140112. **
  140113. ** Return SQLITE_OK if SQLite has been initialized and SQLITE_ERROR if
  140114. ** not.
  140115. */
  140116. case SQLITE_TESTCTRL_ISINIT: {
  140117. if( sqlite3GlobalConfig.isInit==0 ) rc = SQLITE_ERROR;
  140118. break;
  140119. }
  140120. /* sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, db, dbName, onOff, tnum);
  140121. **
  140122. ** This test control is used to create imposter tables. "db" is a pointer
  140123. ** to the database connection. dbName is the database name (ex: "main" or
  140124. ** "temp") which will receive the imposter. "onOff" turns imposter mode on
  140125. ** or off. "tnum" is the root page of the b-tree to which the imposter
  140126. ** table should connect.
  140127. **
  140128. ** Enable imposter mode only when the schema has already been parsed. Then
  140129. ** run a single CREATE TABLE statement to construct the imposter table in
  140130. ** the parsed schema. Then turn imposter mode back off again.
  140131. **
  140132. ** If onOff==0 and tnum>0 then reset the schema for all databases, causing
  140133. ** the schema to be reparsed the next time it is needed. This has the
  140134. ** effect of erasing all imposter tables.
  140135. */
  140136. case SQLITE_TESTCTRL_IMPOSTER: {
  140137. sqlite3 *db = va_arg(ap, sqlite3*);
  140138. sqlite3_mutex_enter(db->mutex);
  140139. db->init.iDb = sqlite3FindDbName(db, va_arg(ap,const char*));
  140140. db->init.busy = db->init.imposterTable = va_arg(ap,int);
  140141. db->init.newTnum = va_arg(ap,int);
  140142. if( db->init.busy==0 && db->init.newTnum>0 ){
  140143. sqlite3ResetAllSchemasOfConnection(db);
  140144. }
  140145. sqlite3_mutex_leave(db->mutex);
  140146. break;
  140147. }
  140148. #if defined(YYCOVERAGE)
  140149. /* sqlite3_test_control(SQLITE_TESTCTRL_PARSER_COVERAGE, FILE *out)
  140150. **
  140151. ** This test control (only available when SQLite is compiled with
  140152. ** -DYYCOVERAGE) writes a report onto "out" that shows all
  140153. ** state/lookahead combinations in the parser state machine
  140154. ** which are never exercised. If any state is missed, make the
  140155. ** return code SQLITE_ERROR.
  140156. */
  140157. case SQLITE_TESTCTRL_PARSER_COVERAGE: {
  140158. FILE *out = va_arg(ap, FILE*);
  140159. if( sqlite3ParserCoverage(out) ) rc = SQLITE_ERROR;
  140160. break;
  140161. }
  140162. #endif /* defined(YYCOVERAGE) */
  140163. }
  140164. va_end(ap);
  140165. #endif /* SQLITE_UNTESTABLE */
  140166. return rc;
  140167. }
  140168. /*
  140169. ** This is a utility routine, useful to VFS implementations, that checks
  140170. ** to see if a database file was a URI that contained a specific query
  140171. ** parameter, and if so obtains the value of the query parameter.
  140172. **
  140173. ** The zFilename argument is the filename pointer passed into the xOpen()
  140174. ** method of a VFS implementation. The zParam argument is the name of the
  140175. ** query parameter we seek. This routine returns the value of the zParam
  140176. ** parameter if it exists. If the parameter does not exist, this routine
  140177. ** returns a NULL pointer.
  140178. */
  140179. SQLITE_API const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam){
  140180. if( zFilename==0 || zParam==0 ) return 0;
  140181. zFilename += sqlite3Strlen30(zFilename) + 1;
  140182. while( zFilename[0] ){
  140183. int x = strcmp(zFilename, zParam);
  140184. zFilename += sqlite3Strlen30(zFilename) + 1;
  140185. if( x==0 ) return zFilename;
  140186. zFilename += sqlite3Strlen30(zFilename) + 1;
  140187. }
  140188. return 0;
  140189. }
  140190. /*
  140191. ** Return a boolean value for a query parameter.
  140192. */
  140193. SQLITE_API int sqlite3_uri_boolean(const char *zFilename, const char *zParam, int bDflt){
  140194. const char *z = sqlite3_uri_parameter(zFilename, zParam);
  140195. bDflt = bDflt!=0;
  140196. return z ? sqlite3GetBoolean(z, bDflt) : bDflt;
  140197. }
  140198. /*
  140199. ** Return a 64-bit integer value for a query parameter.
  140200. */
  140201. SQLITE_API sqlite3_int64 sqlite3_uri_int64(
  140202. const char *zFilename, /* Filename as passed to xOpen */
  140203. const char *zParam, /* URI parameter sought */
  140204. sqlite3_int64 bDflt /* return if parameter is missing */
  140205. ){
  140206. const char *z = sqlite3_uri_parameter(zFilename, zParam);
  140207. sqlite3_int64 v;
  140208. if( z && sqlite3DecOrHexToI64(z, &v)==0 ){
  140209. bDflt = v;
  140210. }
  140211. return bDflt;
  140212. }
  140213. /*
  140214. ** Return the Btree pointer identified by zDbName. Return NULL if not found.
  140215. */
  140216. SQLITE_PRIVATE Btree *sqlite3DbNameToBtree(sqlite3 *db, const char *zDbName){
  140217. int iDb = zDbName ? sqlite3FindDbName(db, zDbName) : 0;
  140218. return iDb<0 ? 0 : db->aDb[iDb].pBt;
  140219. }
  140220. /*
  140221. ** Return the filename of the database associated with a database
  140222. ** connection.
  140223. */
  140224. SQLITE_API const char *sqlite3_db_filename(sqlite3 *db, const char *zDbName){
  140225. Btree *pBt;
  140226. #ifdef SQLITE_ENABLE_API_ARMOR
  140227. if( !sqlite3SafetyCheckOk(db) ){
  140228. (void)SQLITE_MISUSE_BKPT;
  140229. return 0;
  140230. }
  140231. #endif
  140232. pBt = sqlite3DbNameToBtree(db, zDbName);
  140233. return pBt ? sqlite3BtreeGetFilename(pBt) : 0;
  140234. }
  140235. /*
  140236. ** Return 1 if database is read-only or 0 if read/write. Return -1 if
  140237. ** no such database exists.
  140238. */
  140239. SQLITE_API int sqlite3_db_readonly(sqlite3 *db, const char *zDbName){
  140240. Btree *pBt;
  140241. #ifdef SQLITE_ENABLE_API_ARMOR
  140242. if( !sqlite3SafetyCheckOk(db) ){
  140243. (void)SQLITE_MISUSE_BKPT;
  140244. return -1;
  140245. }
  140246. #endif
  140247. pBt = sqlite3DbNameToBtree(db, zDbName);
  140248. return pBt ? sqlite3BtreeIsReadonly(pBt) : -1;
  140249. }
  140250. #ifdef SQLITE_ENABLE_SNAPSHOT
  140251. /*
  140252. ** Obtain a snapshot handle for the snapshot of database zDb currently
  140253. ** being read by handle db.
  140254. */
  140255. SQLITE_API int sqlite3_snapshot_get(
  140256. sqlite3 *db,
  140257. const char *zDb,
  140258. sqlite3_snapshot **ppSnapshot
  140259. ){
  140260. int rc = SQLITE_ERROR;
  140261. #ifndef SQLITE_OMIT_WAL
  140262. #ifdef SQLITE_ENABLE_API_ARMOR
  140263. if( !sqlite3SafetyCheckOk(db) ){
  140264. return SQLITE_MISUSE_BKPT;
  140265. }
  140266. #endif
  140267. sqlite3_mutex_enter(db->mutex);
  140268. if( db->autoCommit==0 ){
  140269. int iDb = sqlite3FindDbName(db, zDb);
  140270. if( iDb==0 || iDb>1 ){
  140271. Btree *pBt = db->aDb[iDb].pBt;
  140272. if( 0==sqlite3BtreeIsInTrans(pBt) ){
  140273. rc = sqlite3BtreeBeginTrans(pBt, 0);
  140274. if( rc==SQLITE_OK ){
  140275. rc = sqlite3PagerSnapshotGet(sqlite3BtreePager(pBt), ppSnapshot);
  140276. }
  140277. }
  140278. }
  140279. }
  140280. sqlite3_mutex_leave(db->mutex);
  140281. #endif /* SQLITE_OMIT_WAL */
  140282. return rc;
  140283. }
  140284. /*
  140285. ** Open a read-transaction on the snapshot idendified by pSnapshot.
  140286. */
  140287. SQLITE_API int sqlite3_snapshot_open(
  140288. sqlite3 *db,
  140289. const char *zDb,
  140290. sqlite3_snapshot *pSnapshot
  140291. ){
  140292. int rc = SQLITE_ERROR;
  140293. #ifndef SQLITE_OMIT_WAL
  140294. #ifdef SQLITE_ENABLE_API_ARMOR
  140295. if( !sqlite3SafetyCheckOk(db) ){
  140296. return SQLITE_MISUSE_BKPT;
  140297. }
  140298. #endif
  140299. sqlite3_mutex_enter(db->mutex);
  140300. if( db->autoCommit==0 ){
  140301. int iDb;
  140302. iDb = sqlite3FindDbName(db, zDb);
  140303. if( iDb==0 || iDb>1 ){
  140304. Btree *pBt = db->aDb[iDb].pBt;
  140305. if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
  140306. rc = sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), pSnapshot);
  140307. if( rc==SQLITE_OK ){
  140308. rc = sqlite3BtreeBeginTrans(pBt, 0);
  140309. sqlite3PagerSnapshotOpen(sqlite3BtreePager(pBt), 0);
  140310. }
  140311. }
  140312. }
  140313. }
  140314. sqlite3_mutex_leave(db->mutex);
  140315. #endif /* SQLITE_OMIT_WAL */
  140316. return rc;
  140317. }
  140318. /*
  140319. ** Recover as many snapshots as possible from the wal file associated with
  140320. ** schema zDb of database db.
  140321. */
  140322. SQLITE_API int sqlite3_snapshot_recover(sqlite3 *db, const char *zDb){
  140323. int rc = SQLITE_ERROR;
  140324. int iDb;
  140325. #ifndef SQLITE_OMIT_WAL
  140326. #ifdef SQLITE_ENABLE_API_ARMOR
  140327. if( !sqlite3SafetyCheckOk(db) ){
  140328. return SQLITE_MISUSE_BKPT;
  140329. }
  140330. #endif
  140331. sqlite3_mutex_enter(db->mutex);
  140332. iDb = sqlite3FindDbName(db, zDb);
  140333. if( iDb==0 || iDb>1 ){
  140334. Btree *pBt = db->aDb[iDb].pBt;
  140335. if( 0==sqlite3BtreeIsInReadTrans(pBt) ){
  140336. rc = sqlite3BtreeBeginTrans(pBt, 0);
  140337. if( rc==SQLITE_OK ){
  140338. rc = sqlite3PagerSnapshotRecover(sqlite3BtreePager(pBt));
  140339. sqlite3BtreeCommit(pBt);
  140340. }
  140341. }
  140342. }
  140343. sqlite3_mutex_leave(db->mutex);
  140344. #endif /* SQLITE_OMIT_WAL */
  140345. return rc;
  140346. }
  140347. /*
  140348. ** Free a snapshot handle obtained from sqlite3_snapshot_get().
  140349. */
  140350. SQLITE_API void sqlite3_snapshot_free(sqlite3_snapshot *pSnapshot){
  140351. sqlite3_free(pSnapshot);
  140352. }
  140353. #endif /* SQLITE_ENABLE_SNAPSHOT */
  140354. #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
  140355. /*
  140356. ** Given the name of a compile-time option, return true if that option
  140357. ** was used and false if not.
  140358. **
  140359. ** The name can optionally begin with "SQLITE_" but the "SQLITE_" prefix
  140360. ** is not required for a match.
  140361. */
  140362. SQLITE_API int sqlite3_compileoption_used(const char *zOptName){
  140363. int i, n;
  140364. int nOpt;
  140365. const char **azCompileOpt;
  140366. #if SQLITE_ENABLE_API_ARMOR
  140367. if( zOptName==0 ){
  140368. (void)SQLITE_MISUSE_BKPT;
  140369. return 0;
  140370. }
  140371. #endif
  140372. azCompileOpt = sqlite3CompileOptions(&nOpt);
  140373. if( sqlite3StrNICmp(zOptName, "SQLITE_", 7)==0 ) zOptName += 7;
  140374. n = sqlite3Strlen30(zOptName);
  140375. /* Since nOpt is normally in single digits, a linear search is
  140376. ** adequate. No need for a binary search. */
  140377. for(i=0; i<nOpt; i++){
  140378. if( sqlite3StrNICmp(zOptName, azCompileOpt[i], n)==0
  140379. && sqlite3IsIdChar((unsigned char)azCompileOpt[i][n])==0
  140380. ){
  140381. return 1;
  140382. }
  140383. }
  140384. return 0;
  140385. }
  140386. /*
  140387. ** Return the N-th compile-time option string. If N is out of range,
  140388. ** return a NULL pointer.
  140389. */
  140390. SQLITE_API const char *sqlite3_compileoption_get(int N){
  140391. int nOpt;
  140392. const char **azCompileOpt;
  140393. azCompileOpt = sqlite3CompileOptions(&nOpt);
  140394. if( N>=0 && N<nOpt ){
  140395. return azCompileOpt[N];
  140396. }
  140397. return 0;
  140398. }
  140399. #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
  140400. /************** End of main.c ************************************************/
  140401. /************** Begin file notify.c ******************************************/
  140402. /*
  140403. ** 2009 March 3
  140404. **
  140405. ** The author disclaims copyright to this source code. In place of
  140406. ** a legal notice, here is a blessing:
  140407. **
  140408. ** May you do good and not evil.
  140409. ** May you find forgiveness for yourself and forgive others.
  140410. ** May you share freely, never taking more than you give.
  140411. **
  140412. *************************************************************************
  140413. **
  140414. ** This file contains the implementation of the sqlite3_unlock_notify()
  140415. ** API method and its associated functionality.
  140416. */
  140417. /* #include "sqliteInt.h" */
  140418. /* #include "btreeInt.h" */
  140419. /* Omit this entire file if SQLITE_ENABLE_UNLOCK_NOTIFY is not defined. */
  140420. #ifdef SQLITE_ENABLE_UNLOCK_NOTIFY
  140421. /*
  140422. ** Public interfaces:
  140423. **
  140424. ** sqlite3ConnectionBlocked()
  140425. ** sqlite3ConnectionUnlocked()
  140426. ** sqlite3ConnectionClosed()
  140427. ** sqlite3_unlock_notify()
  140428. */
  140429. #define assertMutexHeld() \
  140430. assert( sqlite3_mutex_held(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER)) )
  140431. /*
  140432. ** Head of a linked list of all sqlite3 objects created by this process
  140433. ** for which either sqlite3.pBlockingConnection or sqlite3.pUnlockConnection
  140434. ** is not NULL. This variable may only accessed while the STATIC_MASTER
  140435. ** mutex is held.
  140436. */
  140437. static sqlite3 *SQLITE_WSD sqlite3BlockedList = 0;
  140438. #ifndef NDEBUG
  140439. /*
  140440. ** This function is a complex assert() that verifies the following
  140441. ** properties of the blocked connections list:
  140442. **
  140443. ** 1) Each entry in the list has a non-NULL value for either
  140444. ** pUnlockConnection or pBlockingConnection, or both.
  140445. **
  140446. ** 2) All entries in the list that share a common value for
  140447. ** xUnlockNotify are grouped together.
  140448. **
  140449. ** 3) If the argument db is not NULL, then none of the entries in the
  140450. ** blocked connections list have pUnlockConnection or pBlockingConnection
  140451. ** set to db. This is used when closing connection db.
  140452. */
  140453. static void checkListProperties(sqlite3 *db){
  140454. sqlite3 *p;
  140455. for(p=sqlite3BlockedList; p; p=p->pNextBlocked){
  140456. int seen = 0;
  140457. sqlite3 *p2;
  140458. /* Verify property (1) */
  140459. assert( p->pUnlockConnection || p->pBlockingConnection );
  140460. /* Verify property (2) */
  140461. for(p2=sqlite3BlockedList; p2!=p; p2=p2->pNextBlocked){
  140462. if( p2->xUnlockNotify==p->xUnlockNotify ) seen = 1;
  140463. assert( p2->xUnlockNotify==p->xUnlockNotify || !seen );
  140464. assert( db==0 || p->pUnlockConnection!=db );
  140465. assert( db==0 || p->pBlockingConnection!=db );
  140466. }
  140467. }
  140468. }
  140469. #else
  140470. # define checkListProperties(x)
  140471. #endif
  140472. /*
  140473. ** Remove connection db from the blocked connections list. If connection
  140474. ** db is not currently a part of the list, this function is a no-op.
  140475. */
  140476. static void removeFromBlockedList(sqlite3 *db){
  140477. sqlite3 **pp;
  140478. assertMutexHeld();
  140479. for(pp=&sqlite3BlockedList; *pp; pp = &(*pp)->pNextBlocked){
  140480. if( *pp==db ){
  140481. *pp = (*pp)->pNextBlocked;
  140482. break;
  140483. }
  140484. }
  140485. }
  140486. /*
  140487. ** Add connection db to the blocked connections list. It is assumed
  140488. ** that it is not already a part of the list.
  140489. */
  140490. static void addToBlockedList(sqlite3 *db){
  140491. sqlite3 **pp;
  140492. assertMutexHeld();
  140493. for(
  140494. pp=&sqlite3BlockedList;
  140495. *pp && (*pp)->xUnlockNotify!=db->xUnlockNotify;
  140496. pp=&(*pp)->pNextBlocked
  140497. );
  140498. db->pNextBlocked = *pp;
  140499. *pp = db;
  140500. }
  140501. /*
  140502. ** Obtain the STATIC_MASTER mutex.
  140503. */
  140504. static void enterMutex(void){
  140505. sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  140506. checkListProperties(0);
  140507. }
  140508. /*
  140509. ** Release the STATIC_MASTER mutex.
  140510. */
  140511. static void leaveMutex(void){
  140512. assertMutexHeld();
  140513. checkListProperties(0);
  140514. sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
  140515. }
  140516. /*
  140517. ** Register an unlock-notify callback.
  140518. **
  140519. ** This is called after connection "db" has attempted some operation
  140520. ** but has received an SQLITE_LOCKED error because another connection
  140521. ** (call it pOther) in the same process was busy using the same shared
  140522. ** cache. pOther is found by looking at db->pBlockingConnection.
  140523. **
  140524. ** If there is no blocking connection, the callback is invoked immediately,
  140525. ** before this routine returns.
  140526. **
  140527. ** If pOther is already blocked on db, then report SQLITE_LOCKED, to indicate
  140528. ** a deadlock.
  140529. **
  140530. ** Otherwise, make arrangements to invoke xNotify when pOther drops
  140531. ** its locks.
  140532. **
  140533. ** Each call to this routine overrides any prior callbacks registered
  140534. ** on the same "db". If xNotify==0 then any prior callbacks are immediately
  140535. ** cancelled.
  140536. */
  140537. SQLITE_API int sqlite3_unlock_notify(
  140538. sqlite3 *db,
  140539. void (*xNotify)(void **, int),
  140540. void *pArg
  140541. ){
  140542. int rc = SQLITE_OK;
  140543. sqlite3_mutex_enter(db->mutex);
  140544. enterMutex();
  140545. if( xNotify==0 ){
  140546. removeFromBlockedList(db);
  140547. db->pBlockingConnection = 0;
  140548. db->pUnlockConnection = 0;
  140549. db->xUnlockNotify = 0;
  140550. db->pUnlockArg = 0;
  140551. }else if( 0==db->pBlockingConnection ){
  140552. /* The blocking transaction has been concluded. Or there never was a
  140553. ** blocking transaction. In either case, invoke the notify callback
  140554. ** immediately.
  140555. */
  140556. xNotify(&pArg, 1);
  140557. }else{
  140558. sqlite3 *p;
  140559. for(p=db->pBlockingConnection; p && p!=db; p=p->pUnlockConnection){}
  140560. if( p ){
  140561. rc = SQLITE_LOCKED; /* Deadlock detected. */
  140562. }else{
  140563. db->pUnlockConnection = db->pBlockingConnection;
  140564. db->xUnlockNotify = xNotify;
  140565. db->pUnlockArg = pArg;
  140566. removeFromBlockedList(db);
  140567. addToBlockedList(db);
  140568. }
  140569. }
  140570. leaveMutex();
  140571. assert( !db->mallocFailed );
  140572. sqlite3ErrorWithMsg(db, rc, (rc?"database is deadlocked":0));
  140573. sqlite3_mutex_leave(db->mutex);
  140574. return rc;
  140575. }
  140576. /*
  140577. ** This function is called while stepping or preparing a statement
  140578. ** associated with connection db. The operation will return SQLITE_LOCKED
  140579. ** to the user because it requires a lock that will not be available
  140580. ** until connection pBlocker concludes its current transaction.
  140581. */
  140582. SQLITE_PRIVATE void sqlite3ConnectionBlocked(sqlite3 *db, sqlite3 *pBlocker){
  140583. enterMutex();
  140584. if( db->pBlockingConnection==0 && db->pUnlockConnection==0 ){
  140585. addToBlockedList(db);
  140586. }
  140587. db->pBlockingConnection = pBlocker;
  140588. leaveMutex();
  140589. }
  140590. /*
  140591. ** This function is called when
  140592. ** the transaction opened by database db has just finished. Locks held
  140593. ** by database connection db have been released.
  140594. **
  140595. ** This function loops through each entry in the blocked connections
  140596. ** list and does the following:
  140597. **
  140598. ** 1) If the sqlite3.pBlockingConnection member of a list entry is
  140599. ** set to db, then set pBlockingConnection=0.
  140600. **
  140601. ** 2) If the sqlite3.pUnlockConnection member of a list entry is
  140602. ** set to db, then invoke the configured unlock-notify callback and
  140603. ** set pUnlockConnection=0.
  140604. **
  140605. ** 3) If the two steps above mean that pBlockingConnection==0 and
  140606. ** pUnlockConnection==0, remove the entry from the blocked connections
  140607. ** list.
  140608. */
  140609. SQLITE_PRIVATE void sqlite3ConnectionUnlocked(sqlite3 *db){
  140610. void (*xUnlockNotify)(void **, int) = 0; /* Unlock-notify cb to invoke */
  140611. int nArg = 0; /* Number of entries in aArg[] */
  140612. sqlite3 **pp; /* Iterator variable */
  140613. void **aArg; /* Arguments to the unlock callback */
  140614. void **aDyn = 0; /* Dynamically allocated space for aArg[] */
  140615. void *aStatic[16]; /* Starter space for aArg[]. No malloc required */
  140616. aArg = aStatic;
  140617. enterMutex(); /* Enter STATIC_MASTER mutex */
  140618. /* This loop runs once for each entry in the blocked-connections list. */
  140619. for(pp=&sqlite3BlockedList; *pp; /* no-op */ ){
  140620. sqlite3 *p = *pp;
  140621. /* Step 1. */
  140622. if( p->pBlockingConnection==db ){
  140623. p->pBlockingConnection = 0;
  140624. }
  140625. /* Step 2. */
  140626. if( p->pUnlockConnection==db ){
  140627. assert( p->xUnlockNotify );
  140628. if( p->xUnlockNotify!=xUnlockNotify && nArg!=0 ){
  140629. xUnlockNotify(aArg, nArg);
  140630. nArg = 0;
  140631. }
  140632. sqlite3BeginBenignMalloc();
  140633. assert( aArg==aDyn || (aDyn==0 && aArg==aStatic) );
  140634. assert( nArg<=(int)ArraySize(aStatic) || aArg==aDyn );
  140635. if( (!aDyn && nArg==(int)ArraySize(aStatic))
  140636. || (aDyn && nArg==(int)(sqlite3MallocSize(aDyn)/sizeof(void*)))
  140637. ){
  140638. /* The aArg[] array needs to grow. */
  140639. void **pNew = (void **)sqlite3Malloc(nArg*sizeof(void *)*2);
  140640. if( pNew ){
  140641. memcpy(pNew, aArg, nArg*sizeof(void *));
  140642. sqlite3_free(aDyn);
  140643. aDyn = aArg = pNew;
  140644. }else{
  140645. /* This occurs when the array of context pointers that need to
  140646. ** be passed to the unlock-notify callback is larger than the
  140647. ** aStatic[] array allocated on the stack and the attempt to
  140648. ** allocate a larger array from the heap has failed.
  140649. **
  140650. ** This is a difficult situation to handle. Returning an error
  140651. ** code to the caller is insufficient, as even if an error code
  140652. ** is returned the transaction on connection db will still be
  140653. ** closed and the unlock-notify callbacks on blocked connections
  140654. ** will go unissued. This might cause the application to wait
  140655. ** indefinitely for an unlock-notify callback that will never
  140656. ** arrive.
  140657. **
  140658. ** Instead, invoke the unlock-notify callback with the context
  140659. ** array already accumulated. We can then clear the array and
  140660. ** begin accumulating any further context pointers without
  140661. ** requiring any dynamic allocation. This is sub-optimal because
  140662. ** it means that instead of one callback with a large array of
  140663. ** context pointers the application will receive two or more
  140664. ** callbacks with smaller arrays of context pointers, which will
  140665. ** reduce the applications ability to prioritize multiple
  140666. ** connections. But it is the best that can be done under the
  140667. ** circumstances.
  140668. */
  140669. xUnlockNotify(aArg, nArg);
  140670. nArg = 0;
  140671. }
  140672. }
  140673. sqlite3EndBenignMalloc();
  140674. aArg[nArg++] = p->pUnlockArg;
  140675. xUnlockNotify = p->xUnlockNotify;
  140676. p->pUnlockConnection = 0;
  140677. p->xUnlockNotify = 0;
  140678. p->pUnlockArg = 0;
  140679. }
  140680. /* Step 3. */
  140681. if( p->pBlockingConnection==0 && p->pUnlockConnection==0 ){
  140682. /* Remove connection p from the blocked connections list. */
  140683. *pp = p->pNextBlocked;
  140684. p->pNextBlocked = 0;
  140685. }else{
  140686. pp = &p->pNextBlocked;
  140687. }
  140688. }
  140689. if( nArg!=0 ){
  140690. xUnlockNotify(aArg, nArg);
  140691. }
  140692. sqlite3_free(aDyn);
  140693. leaveMutex(); /* Leave STATIC_MASTER mutex */
  140694. }
  140695. /*
  140696. ** This is called when the database connection passed as an argument is
  140697. ** being closed. The connection is removed from the blocked list.
  140698. */
  140699. SQLITE_PRIVATE void sqlite3ConnectionClosed(sqlite3 *db){
  140700. sqlite3ConnectionUnlocked(db);
  140701. enterMutex();
  140702. removeFromBlockedList(db);
  140703. checkListProperties(db);
  140704. leaveMutex();
  140705. }
  140706. #endif
  140707. /************** End of notify.c **********************************************/
  140708. /************** Begin file fts3.c ********************************************/
  140709. /*
  140710. ** 2006 Oct 10
  140711. **
  140712. ** The author disclaims copyright to this source code. In place of
  140713. ** a legal notice, here is a blessing:
  140714. **
  140715. ** May you do good and not evil.
  140716. ** May you find forgiveness for yourself and forgive others.
  140717. ** May you share freely, never taking more than you give.
  140718. **
  140719. ******************************************************************************
  140720. **
  140721. ** This is an SQLite module implementing full-text search.
  140722. */
  140723. /*
  140724. ** The code in this file is only compiled if:
  140725. **
  140726. ** * The FTS3 module is being built as an extension
  140727. ** (in which case SQLITE_CORE is not defined), or
  140728. **
  140729. ** * The FTS3 module is being built into the core of
  140730. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  140731. */
  140732. /* The full-text index is stored in a series of b+tree (-like)
  140733. ** structures called segments which map terms to doclists. The
  140734. ** structures are like b+trees in layout, but are constructed from the
  140735. ** bottom up in optimal fashion and are not updatable. Since trees
  140736. ** are built from the bottom up, things will be described from the
  140737. ** bottom up.
  140738. **
  140739. **
  140740. **** Varints ****
  140741. ** The basic unit of encoding is a variable-length integer called a
  140742. ** varint. We encode variable-length integers in little-endian order
  140743. ** using seven bits * per byte as follows:
  140744. **
  140745. ** KEY:
  140746. ** A = 0xxxxxxx 7 bits of data and one flag bit
  140747. ** B = 1xxxxxxx 7 bits of data and one flag bit
  140748. **
  140749. ** 7 bits - A
  140750. ** 14 bits - BA
  140751. ** 21 bits - BBA
  140752. ** and so on.
  140753. **
  140754. ** This is similar in concept to how sqlite encodes "varints" but
  140755. ** the encoding is not the same. SQLite varints are big-endian
  140756. ** are are limited to 9 bytes in length whereas FTS3 varints are
  140757. ** little-endian and can be up to 10 bytes in length (in theory).
  140758. **
  140759. ** Example encodings:
  140760. **
  140761. ** 1: 0x01
  140762. ** 127: 0x7f
  140763. ** 128: 0x81 0x00
  140764. **
  140765. **
  140766. **** Document lists ****
  140767. ** A doclist (document list) holds a docid-sorted list of hits for a
  140768. ** given term. Doclists hold docids and associated token positions.
  140769. ** A docid is the unique integer identifier for a single document.
  140770. ** A position is the index of a word within the document. The first
  140771. ** word of the document has a position of 0.
  140772. **
  140773. ** FTS3 used to optionally store character offsets using a compile-time
  140774. ** option. But that functionality is no longer supported.
  140775. **
  140776. ** A doclist is stored like this:
  140777. **
  140778. ** array {
  140779. ** varint docid; (delta from previous doclist)
  140780. ** array { (position list for column 0)
  140781. ** varint position; (2 more than the delta from previous position)
  140782. ** }
  140783. ** array {
  140784. ** varint POS_COLUMN; (marks start of position list for new column)
  140785. ** varint column; (index of new column)
  140786. ** array {
  140787. ** varint position; (2 more than the delta from previous position)
  140788. ** }
  140789. ** }
  140790. ** varint POS_END; (marks end of positions for this document.
  140791. ** }
  140792. **
  140793. ** Here, array { X } means zero or more occurrences of X, adjacent in
  140794. ** memory. A "position" is an index of a token in the token stream
  140795. ** generated by the tokenizer. Note that POS_END and POS_COLUMN occur
  140796. ** in the same logical place as the position element, and act as sentinals
  140797. ** ending a position list array. POS_END is 0. POS_COLUMN is 1.
  140798. ** The positions numbers are not stored literally but rather as two more
  140799. ** than the difference from the prior position, or the just the position plus
  140800. ** 2 for the first position. Example:
  140801. **
  140802. ** label: A B C D E F G H I J K
  140803. ** value: 123 5 9 1 1 14 35 0 234 72 0
  140804. **
  140805. ** The 123 value is the first docid. For column zero in this document
  140806. ** there are two matches at positions 3 and 10 (5-2 and 9-2+3). The 1
  140807. ** at D signals the start of a new column; the 1 at E indicates that the
  140808. ** new column is column number 1. There are two positions at 12 and 45
  140809. ** (14-2 and 35-2+12). The 0 at H indicate the end-of-document. The
  140810. ** 234 at I is the delta to next docid (357). It has one position 70
  140811. ** (72-2) and then terminates with the 0 at K.
  140812. **
  140813. ** A "position-list" is the list of positions for multiple columns for
  140814. ** a single docid. A "column-list" is the set of positions for a single
  140815. ** column. Hence, a position-list consists of one or more column-lists,
  140816. ** a document record consists of a docid followed by a position-list and
  140817. ** a doclist consists of one or more document records.
  140818. **
  140819. ** A bare doclist omits the position information, becoming an
  140820. ** array of varint-encoded docids.
  140821. **
  140822. **** Segment leaf nodes ****
  140823. ** Segment leaf nodes store terms and doclists, ordered by term. Leaf
  140824. ** nodes are written using LeafWriter, and read using LeafReader (to
  140825. ** iterate through a single leaf node's data) and LeavesReader (to
  140826. ** iterate through a segment's entire leaf layer). Leaf nodes have
  140827. ** the format:
  140828. **
  140829. ** varint iHeight; (height from leaf level, always 0)
  140830. ** varint nTerm; (length of first term)
  140831. ** char pTerm[nTerm]; (content of first term)
  140832. ** varint nDoclist; (length of term's associated doclist)
  140833. ** char pDoclist[nDoclist]; (content of doclist)
  140834. ** array {
  140835. ** (further terms are delta-encoded)
  140836. ** varint nPrefix; (length of prefix shared with previous term)
  140837. ** varint nSuffix; (length of unshared suffix)
  140838. ** char pTermSuffix[nSuffix];(unshared suffix of next term)
  140839. ** varint nDoclist; (length of term's associated doclist)
  140840. ** char pDoclist[nDoclist]; (content of doclist)
  140841. ** }
  140842. **
  140843. ** Here, array { X } means zero or more occurrences of X, adjacent in
  140844. ** memory.
  140845. **
  140846. ** Leaf nodes are broken into blocks which are stored contiguously in
  140847. ** the %_segments table in sorted order. This means that when the end
  140848. ** of a node is reached, the next term is in the node with the next
  140849. ** greater node id.
  140850. **
  140851. ** New data is spilled to a new leaf node when the current node
  140852. ** exceeds LEAF_MAX bytes (default 2048). New data which itself is
  140853. ** larger than STANDALONE_MIN (default 1024) is placed in a standalone
  140854. ** node (a leaf node with a single term and doclist). The goal of
  140855. ** these settings is to pack together groups of small doclists while
  140856. ** making it efficient to directly access large doclists. The
  140857. ** assumption is that large doclists represent terms which are more
  140858. ** likely to be query targets.
  140859. **
  140860. ** TODO(shess) It may be useful for blocking decisions to be more
  140861. ** dynamic. For instance, it may make more sense to have a 2.5k leaf
  140862. ** node rather than splitting into 2k and .5k nodes. My intuition is
  140863. ** that this might extend through 2x or 4x the pagesize.
  140864. **
  140865. **
  140866. **** Segment interior nodes ****
  140867. ** Segment interior nodes store blockids for subtree nodes and terms
  140868. ** to describe what data is stored by the each subtree. Interior
  140869. ** nodes are written using InteriorWriter, and read using
  140870. ** InteriorReader. InteriorWriters are created as needed when
  140871. ** SegmentWriter creates new leaf nodes, or when an interior node
  140872. ** itself grows too big and must be split. The format of interior
  140873. ** nodes:
  140874. **
  140875. ** varint iHeight; (height from leaf level, always >0)
  140876. ** varint iBlockid; (block id of node's leftmost subtree)
  140877. ** optional {
  140878. ** varint nTerm; (length of first term)
  140879. ** char pTerm[nTerm]; (content of first term)
  140880. ** array {
  140881. ** (further terms are delta-encoded)
  140882. ** varint nPrefix; (length of shared prefix with previous term)
  140883. ** varint nSuffix; (length of unshared suffix)
  140884. ** char pTermSuffix[nSuffix]; (unshared suffix of next term)
  140885. ** }
  140886. ** }
  140887. **
  140888. ** Here, optional { X } means an optional element, while array { X }
  140889. ** means zero or more occurrences of X, adjacent in memory.
  140890. **
  140891. ** An interior node encodes n terms separating n+1 subtrees. The
  140892. ** subtree blocks are contiguous, so only the first subtree's blockid
  140893. ** is encoded. The subtree at iBlockid will contain all terms less
  140894. ** than the first term encoded (or all terms if no term is encoded).
  140895. ** Otherwise, for terms greater than or equal to pTerm[i] but less
  140896. ** than pTerm[i+1], the subtree for that term will be rooted at
  140897. ** iBlockid+i. Interior nodes only store enough term data to
  140898. ** distinguish adjacent children (if the rightmost term of the left
  140899. ** child is "something", and the leftmost term of the right child is
  140900. ** "wicked", only "w" is stored).
  140901. **
  140902. ** New data is spilled to a new interior node at the same height when
  140903. ** the current node exceeds INTERIOR_MAX bytes (default 2048).
  140904. ** INTERIOR_MIN_TERMS (default 7) keeps large terms from monopolizing
  140905. ** interior nodes and making the tree too skinny. The interior nodes
  140906. ** at a given height are naturally tracked by interior nodes at
  140907. ** height+1, and so on.
  140908. **
  140909. **
  140910. **** Segment directory ****
  140911. ** The segment directory in table %_segdir stores meta-information for
  140912. ** merging and deleting segments, and also the root node of the
  140913. ** segment's tree.
  140914. **
  140915. ** The root node is the top node of the segment's tree after encoding
  140916. ** the entire segment, restricted to ROOT_MAX bytes (default 1024).
  140917. ** This could be either a leaf node or an interior node. If the top
  140918. ** node requires more than ROOT_MAX bytes, it is flushed to %_segments
  140919. ** and a new root interior node is generated (which should always fit
  140920. ** within ROOT_MAX because it only needs space for 2 varints, the
  140921. ** height and the blockid of the previous root).
  140922. **
  140923. ** The meta-information in the segment directory is:
  140924. ** level - segment level (see below)
  140925. ** idx - index within level
  140926. ** - (level,idx uniquely identify a segment)
  140927. ** start_block - first leaf node
  140928. ** leaves_end_block - last leaf node
  140929. ** end_block - last block (including interior nodes)
  140930. ** root - contents of root node
  140931. **
  140932. ** If the root node is a leaf node, then start_block,
  140933. ** leaves_end_block, and end_block are all 0.
  140934. **
  140935. **
  140936. **** Segment merging ****
  140937. ** To amortize update costs, segments are grouped into levels and
  140938. ** merged in batches. Each increase in level represents exponentially
  140939. ** more documents.
  140940. **
  140941. ** New documents (actually, document updates) are tokenized and
  140942. ** written individually (using LeafWriter) to a level 0 segment, with
  140943. ** incrementing idx. When idx reaches MERGE_COUNT (default 16), all
  140944. ** level 0 segments are merged into a single level 1 segment. Level 1
  140945. ** is populated like level 0, and eventually MERGE_COUNT level 1
  140946. ** segments are merged to a single level 2 segment (representing
  140947. ** MERGE_COUNT^2 updates), and so on.
  140948. **
  140949. ** A segment merge traverses all segments at a given level in
  140950. ** parallel, performing a straightforward sorted merge. Since segment
  140951. ** leaf nodes are written in to the %_segments table in order, this
  140952. ** merge traverses the underlying sqlite disk structures efficiently.
  140953. ** After the merge, all segment blocks from the merged level are
  140954. ** deleted.
  140955. **
  140956. ** MERGE_COUNT controls how often we merge segments. 16 seems to be
  140957. ** somewhat of a sweet spot for insertion performance. 32 and 64 show
  140958. ** very similar performance numbers to 16 on insertion, though they're
  140959. ** a tiny bit slower (perhaps due to more overhead in merge-time
  140960. ** sorting). 8 is about 20% slower than 16, 4 about 50% slower than
  140961. ** 16, 2 about 66% slower than 16.
  140962. **
  140963. ** At query time, high MERGE_COUNT increases the number of segments
  140964. ** which need to be scanned and merged. For instance, with 100k docs
  140965. ** inserted:
  140966. **
  140967. ** MERGE_COUNT segments
  140968. ** 16 25
  140969. ** 8 12
  140970. ** 4 10
  140971. ** 2 6
  140972. **
  140973. ** This appears to have only a moderate impact on queries for very
  140974. ** frequent terms (which are somewhat dominated by segment merge
  140975. ** costs), and infrequent and non-existent terms still seem to be fast
  140976. ** even with many segments.
  140977. **
  140978. ** TODO(shess) That said, it would be nice to have a better query-side
  140979. ** argument for MERGE_COUNT of 16. Also, it is possible/likely that
  140980. ** optimizations to things like doclist merging will swing the sweet
  140981. ** spot around.
  140982. **
  140983. **
  140984. **
  140985. **** Handling of deletions and updates ****
  140986. ** Since we're using a segmented structure, with no docid-oriented
  140987. ** index into the term index, we clearly cannot simply update the term
  140988. ** index when a document is deleted or updated. For deletions, we
  140989. ** write an empty doclist (varint(docid) varint(POS_END)), for updates
  140990. ** we simply write the new doclist. Segment merges overwrite older
  140991. ** data for a particular docid with newer data, so deletes or updates
  140992. ** will eventually overtake the earlier data and knock it out. The
  140993. ** query logic likewise merges doclists so that newer data knocks out
  140994. ** older data.
  140995. */
  140996. /************** Include fts3Int.h in the middle of fts3.c ********************/
  140997. /************** Begin file fts3Int.h *****************************************/
  140998. /*
  140999. ** 2009 Nov 12
  141000. **
  141001. ** The author disclaims copyright to this source code. In place of
  141002. ** a legal notice, here is a blessing:
  141003. **
  141004. ** May you do good and not evil.
  141005. ** May you find forgiveness for yourself and forgive others.
  141006. ** May you share freely, never taking more than you give.
  141007. **
  141008. ******************************************************************************
  141009. **
  141010. */
  141011. #ifndef _FTSINT_H
  141012. #define _FTSINT_H
  141013. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  141014. # define NDEBUG 1
  141015. #endif
  141016. /* FTS3/FTS4 require virtual tables */
  141017. #ifdef SQLITE_OMIT_VIRTUALTABLE
  141018. # undef SQLITE_ENABLE_FTS3
  141019. # undef SQLITE_ENABLE_FTS4
  141020. #endif
  141021. /*
  141022. ** FTS4 is really an extension for FTS3. It is enabled using the
  141023. ** SQLITE_ENABLE_FTS3 macro. But to avoid confusion we also all
  141024. ** the SQLITE_ENABLE_FTS4 macro to serve as an alisse for SQLITE_ENABLE_FTS3.
  141025. */
  141026. #if defined(SQLITE_ENABLE_FTS4) && !defined(SQLITE_ENABLE_FTS3)
  141027. # define SQLITE_ENABLE_FTS3
  141028. #endif
  141029. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  141030. /* If not building as part of the core, include sqlite3ext.h. */
  141031. #ifndef SQLITE_CORE
  141032. /* # include "sqlite3ext.h" */
  141033. SQLITE_EXTENSION_INIT3
  141034. #endif
  141035. /* #include "sqlite3.h" */
  141036. /************** Include fts3_tokenizer.h in the middle of fts3Int.h **********/
  141037. /************** Begin file fts3_tokenizer.h **********************************/
  141038. /*
  141039. ** 2006 July 10
  141040. **
  141041. ** The author disclaims copyright to this source code.
  141042. **
  141043. *************************************************************************
  141044. ** Defines the interface to tokenizers used by fulltext-search. There
  141045. ** are three basic components:
  141046. **
  141047. ** sqlite3_tokenizer_module is a singleton defining the tokenizer
  141048. ** interface functions. This is essentially the class structure for
  141049. ** tokenizers.
  141050. **
  141051. ** sqlite3_tokenizer is used to define a particular tokenizer, perhaps
  141052. ** including customization information defined at creation time.
  141053. **
  141054. ** sqlite3_tokenizer_cursor is generated by a tokenizer to generate
  141055. ** tokens from a particular input.
  141056. */
  141057. #ifndef _FTS3_TOKENIZER_H_
  141058. #define _FTS3_TOKENIZER_H_
  141059. /* TODO(shess) Only used for SQLITE_OK and SQLITE_DONE at this time.
  141060. ** If tokenizers are to be allowed to call sqlite3_*() functions, then
  141061. ** we will need a way to register the API consistently.
  141062. */
  141063. /* #include "sqlite3.h" */
  141064. /*
  141065. ** Structures used by the tokenizer interface. When a new tokenizer
  141066. ** implementation is registered, the caller provides a pointer to
  141067. ** an sqlite3_tokenizer_module containing pointers to the callback
  141068. ** functions that make up an implementation.
  141069. **
  141070. ** When an fts3 table is created, it passes any arguments passed to
  141071. ** the tokenizer clause of the CREATE VIRTUAL TABLE statement to the
  141072. ** sqlite3_tokenizer_module.xCreate() function of the requested tokenizer
  141073. ** implementation. The xCreate() function in turn returns an
  141074. ** sqlite3_tokenizer structure representing the specific tokenizer to
  141075. ** be used for the fts3 table (customized by the tokenizer clause arguments).
  141076. **
  141077. ** To tokenize an input buffer, the sqlite3_tokenizer_module.xOpen()
  141078. ** method is called. It returns an sqlite3_tokenizer_cursor object
  141079. ** that may be used to tokenize a specific input buffer based on
  141080. ** the tokenization rules supplied by a specific sqlite3_tokenizer
  141081. ** object.
  141082. */
  141083. typedef struct sqlite3_tokenizer_module sqlite3_tokenizer_module;
  141084. typedef struct sqlite3_tokenizer sqlite3_tokenizer;
  141085. typedef struct sqlite3_tokenizer_cursor sqlite3_tokenizer_cursor;
  141086. struct sqlite3_tokenizer_module {
  141087. /*
  141088. ** Structure version. Should always be set to 0 or 1.
  141089. */
  141090. int iVersion;
  141091. /*
  141092. ** Create a new tokenizer. The values in the argv[] array are the
  141093. ** arguments passed to the "tokenizer" clause of the CREATE VIRTUAL
  141094. ** TABLE statement that created the fts3 table. For example, if
  141095. ** the following SQL is executed:
  141096. **
  141097. ** CREATE .. USING fts3( ... , tokenizer <tokenizer-name> arg1 arg2)
  141098. **
  141099. ** then argc is set to 2, and the argv[] array contains pointers
  141100. ** to the strings "arg1" and "arg2".
  141101. **
  141102. ** This method should return either SQLITE_OK (0), or an SQLite error
  141103. ** code. If SQLITE_OK is returned, then *ppTokenizer should be set
  141104. ** to point at the newly created tokenizer structure. The generic
  141105. ** sqlite3_tokenizer.pModule variable should not be initialized by
  141106. ** this callback. The caller will do so.
  141107. */
  141108. int (*xCreate)(
  141109. int argc, /* Size of argv array */
  141110. const char *const*argv, /* Tokenizer argument strings */
  141111. sqlite3_tokenizer **ppTokenizer /* OUT: Created tokenizer */
  141112. );
  141113. /*
  141114. ** Destroy an existing tokenizer. The fts3 module calls this method
  141115. ** exactly once for each successful call to xCreate().
  141116. */
  141117. int (*xDestroy)(sqlite3_tokenizer *pTokenizer);
  141118. /*
  141119. ** Create a tokenizer cursor to tokenize an input buffer. The caller
  141120. ** is responsible for ensuring that the input buffer remains valid
  141121. ** until the cursor is closed (using the xClose() method).
  141122. */
  141123. int (*xOpen)(
  141124. sqlite3_tokenizer *pTokenizer, /* Tokenizer object */
  141125. const char *pInput, int nBytes, /* Input buffer */
  141126. sqlite3_tokenizer_cursor **ppCursor /* OUT: Created tokenizer cursor */
  141127. );
  141128. /*
  141129. ** Destroy an existing tokenizer cursor. The fts3 module calls this
  141130. ** method exactly once for each successful call to xOpen().
  141131. */
  141132. int (*xClose)(sqlite3_tokenizer_cursor *pCursor);
  141133. /*
  141134. ** Retrieve the next token from the tokenizer cursor pCursor. This
  141135. ** method should either return SQLITE_OK and set the values of the
  141136. ** "OUT" variables identified below, or SQLITE_DONE to indicate that
  141137. ** the end of the buffer has been reached, or an SQLite error code.
  141138. **
  141139. ** *ppToken should be set to point at a buffer containing the
  141140. ** normalized version of the token (i.e. after any case-folding and/or
  141141. ** stemming has been performed). *pnBytes should be set to the length
  141142. ** of this buffer in bytes. The input text that generated the token is
  141143. ** identified by the byte offsets returned in *piStartOffset and
  141144. ** *piEndOffset. *piStartOffset should be set to the index of the first
  141145. ** byte of the token in the input buffer. *piEndOffset should be set
  141146. ** to the index of the first byte just past the end of the token in
  141147. ** the input buffer.
  141148. **
  141149. ** The buffer *ppToken is set to point at is managed by the tokenizer
  141150. ** implementation. It is only required to be valid until the next call
  141151. ** to xNext() or xClose().
  141152. */
  141153. /* TODO(shess) current implementation requires pInput to be
  141154. ** nul-terminated. This should either be fixed, or pInput/nBytes
  141155. ** should be converted to zInput.
  141156. */
  141157. int (*xNext)(
  141158. sqlite3_tokenizer_cursor *pCursor, /* Tokenizer cursor */
  141159. const char **ppToken, int *pnBytes, /* OUT: Normalized text for token */
  141160. int *piStartOffset, /* OUT: Byte offset of token in input buffer */
  141161. int *piEndOffset, /* OUT: Byte offset of end of token in input buffer */
  141162. int *piPosition /* OUT: Number of tokens returned before this one */
  141163. );
  141164. /***********************************************************************
  141165. ** Methods below this point are only available if iVersion>=1.
  141166. */
  141167. /*
  141168. ** Configure the language id of a tokenizer cursor.
  141169. */
  141170. int (*xLanguageid)(sqlite3_tokenizer_cursor *pCsr, int iLangid);
  141171. };
  141172. struct sqlite3_tokenizer {
  141173. const sqlite3_tokenizer_module *pModule; /* The module for this tokenizer */
  141174. /* Tokenizer implementations will typically add additional fields */
  141175. };
  141176. struct sqlite3_tokenizer_cursor {
  141177. sqlite3_tokenizer *pTokenizer; /* Tokenizer for this cursor. */
  141178. /* Tokenizer implementations will typically add additional fields */
  141179. };
  141180. int fts3_global_term_cnt(int iTerm, int iCol);
  141181. int fts3_term_cnt(int iTerm, int iCol);
  141182. #endif /* _FTS3_TOKENIZER_H_ */
  141183. /************** End of fts3_tokenizer.h **************************************/
  141184. /************** Continuing where we left off in fts3Int.h ********************/
  141185. /************** Include fts3_hash.h in the middle of fts3Int.h ***************/
  141186. /************** Begin file fts3_hash.h ***************************************/
  141187. /*
  141188. ** 2001 September 22
  141189. **
  141190. ** The author disclaims copyright to this source code. In place of
  141191. ** a legal notice, here is a blessing:
  141192. **
  141193. ** May you do good and not evil.
  141194. ** May you find forgiveness for yourself and forgive others.
  141195. ** May you share freely, never taking more than you give.
  141196. **
  141197. *************************************************************************
  141198. ** This is the header file for the generic hash-table implementation
  141199. ** used in SQLite. We've modified it slightly to serve as a standalone
  141200. ** hash table implementation for the full-text indexing module.
  141201. **
  141202. */
  141203. #ifndef _FTS3_HASH_H_
  141204. #define _FTS3_HASH_H_
  141205. /* Forward declarations of structures. */
  141206. typedef struct Fts3Hash Fts3Hash;
  141207. typedef struct Fts3HashElem Fts3HashElem;
  141208. /* A complete hash table is an instance of the following structure.
  141209. ** The internals of this structure are intended to be opaque -- client
  141210. ** code should not attempt to access or modify the fields of this structure
  141211. ** directly. Change this structure only by using the routines below.
  141212. ** However, many of the "procedures" and "functions" for modifying and
  141213. ** accessing this structure are really macros, so we can't really make
  141214. ** this structure opaque.
  141215. */
  141216. struct Fts3Hash {
  141217. char keyClass; /* HASH_INT, _POINTER, _STRING, _BINARY */
  141218. char copyKey; /* True if copy of key made on insert */
  141219. int count; /* Number of entries in this table */
  141220. Fts3HashElem *first; /* The first element of the array */
  141221. int htsize; /* Number of buckets in the hash table */
  141222. struct _fts3ht { /* the hash table */
  141223. int count; /* Number of entries with this hash */
  141224. Fts3HashElem *chain; /* Pointer to first entry with this hash */
  141225. } *ht;
  141226. };
  141227. /* Each element in the hash table is an instance of the following
  141228. ** structure. All elements are stored on a single doubly-linked list.
  141229. **
  141230. ** Again, this structure is intended to be opaque, but it can't really
  141231. ** be opaque because it is used by macros.
  141232. */
  141233. struct Fts3HashElem {
  141234. Fts3HashElem *next, *prev; /* Next and previous elements in the table */
  141235. void *data; /* Data associated with this element */
  141236. void *pKey; int nKey; /* Key associated with this element */
  141237. };
  141238. /*
  141239. ** There are 2 different modes of operation for a hash table:
  141240. **
  141241. ** FTS3_HASH_STRING pKey points to a string that is nKey bytes long
  141242. ** (including the null-terminator, if any). Case
  141243. ** is respected in comparisons.
  141244. **
  141245. ** FTS3_HASH_BINARY pKey points to binary data nKey bytes long.
  141246. ** memcmp() is used to compare keys.
  141247. **
  141248. ** A copy of the key is made if the copyKey parameter to fts3HashInit is 1.
  141249. */
  141250. #define FTS3_HASH_STRING 1
  141251. #define FTS3_HASH_BINARY 2
  141252. /*
  141253. ** Access routines. To delete, insert a NULL pointer.
  141254. */
  141255. SQLITE_PRIVATE void sqlite3Fts3HashInit(Fts3Hash *pNew, char keyClass, char copyKey);
  141256. SQLITE_PRIVATE void *sqlite3Fts3HashInsert(Fts3Hash*, const void *pKey, int nKey, void *pData);
  141257. SQLITE_PRIVATE void *sqlite3Fts3HashFind(const Fts3Hash*, const void *pKey, int nKey);
  141258. SQLITE_PRIVATE void sqlite3Fts3HashClear(Fts3Hash*);
  141259. SQLITE_PRIVATE Fts3HashElem *sqlite3Fts3HashFindElem(const Fts3Hash *, const void *, int);
  141260. /*
  141261. ** Shorthand for the functions above
  141262. */
  141263. #define fts3HashInit sqlite3Fts3HashInit
  141264. #define fts3HashInsert sqlite3Fts3HashInsert
  141265. #define fts3HashFind sqlite3Fts3HashFind
  141266. #define fts3HashClear sqlite3Fts3HashClear
  141267. #define fts3HashFindElem sqlite3Fts3HashFindElem
  141268. /*
  141269. ** Macros for looping over all elements of a hash table. The idiom is
  141270. ** like this:
  141271. **
  141272. ** Fts3Hash h;
  141273. ** Fts3HashElem *p;
  141274. ** ...
  141275. ** for(p=fts3HashFirst(&h); p; p=fts3HashNext(p)){
  141276. ** SomeStructure *pData = fts3HashData(p);
  141277. ** // do something with pData
  141278. ** }
  141279. */
  141280. #define fts3HashFirst(H) ((H)->first)
  141281. #define fts3HashNext(E) ((E)->next)
  141282. #define fts3HashData(E) ((E)->data)
  141283. #define fts3HashKey(E) ((E)->pKey)
  141284. #define fts3HashKeysize(E) ((E)->nKey)
  141285. /*
  141286. ** Number of entries in a hash table
  141287. */
  141288. #define fts3HashCount(H) ((H)->count)
  141289. #endif /* _FTS3_HASH_H_ */
  141290. /************** End of fts3_hash.h *******************************************/
  141291. /************** Continuing where we left off in fts3Int.h ********************/
  141292. /*
  141293. ** This constant determines the maximum depth of an FTS expression tree
  141294. ** that the library will create and use. FTS uses recursion to perform
  141295. ** various operations on the query tree, so the disadvantage of a large
  141296. ** limit is that it may allow very large queries to use large amounts
  141297. ** of stack space (perhaps causing a stack overflow).
  141298. */
  141299. #ifndef SQLITE_FTS3_MAX_EXPR_DEPTH
  141300. # define SQLITE_FTS3_MAX_EXPR_DEPTH 12
  141301. #endif
  141302. /*
  141303. ** This constant controls how often segments are merged. Once there are
  141304. ** FTS3_MERGE_COUNT segments of level N, they are merged into a single
  141305. ** segment of level N+1.
  141306. */
  141307. #define FTS3_MERGE_COUNT 16
  141308. /*
  141309. ** This is the maximum amount of data (in bytes) to store in the
  141310. ** Fts3Table.pendingTerms hash table. Normally, the hash table is
  141311. ** populated as documents are inserted/updated/deleted in a transaction
  141312. ** and used to create a new segment when the transaction is committed.
  141313. ** However if this limit is reached midway through a transaction, a new
  141314. ** segment is created and the hash table cleared immediately.
  141315. */
  141316. #define FTS3_MAX_PENDING_DATA (1*1024*1024)
  141317. /*
  141318. ** Macro to return the number of elements in an array. SQLite has a
  141319. ** similar macro called ArraySize(). Use a different name to avoid
  141320. ** a collision when building an amalgamation with built-in FTS3.
  141321. */
  141322. #define SizeofArray(X) ((int)(sizeof(X)/sizeof(X[0])))
  141323. #ifndef MIN
  141324. # define MIN(x,y) ((x)<(y)?(x):(y))
  141325. #endif
  141326. #ifndef MAX
  141327. # define MAX(x,y) ((x)>(y)?(x):(y))
  141328. #endif
  141329. /*
  141330. ** Maximum length of a varint encoded integer. The varint format is different
  141331. ** from that used by SQLite, so the maximum length is 10, not 9.
  141332. */
  141333. #define FTS3_VARINT_MAX 10
  141334. /*
  141335. ** FTS4 virtual tables may maintain multiple indexes - one index of all terms
  141336. ** in the document set and zero or more prefix indexes. All indexes are stored
  141337. ** as one or more b+-trees in the %_segments and %_segdir tables.
  141338. **
  141339. ** It is possible to determine which index a b+-tree belongs to based on the
  141340. ** value stored in the "%_segdir.level" column. Given this value L, the index
  141341. ** that the b+-tree belongs to is (L<<10). In other words, all b+-trees with
  141342. ** level values between 0 and 1023 (inclusive) belong to index 0, all levels
  141343. ** between 1024 and 2047 to index 1, and so on.
  141344. **
  141345. ** It is considered impossible for an index to use more than 1024 levels. In
  141346. ** theory though this may happen, but only after at least
  141347. ** (FTS3_MERGE_COUNT^1024) separate flushes of the pending-terms tables.
  141348. */
  141349. #define FTS3_SEGDIR_MAXLEVEL 1024
  141350. #define FTS3_SEGDIR_MAXLEVEL_STR "1024"
  141351. /*
  141352. ** The testcase() macro is only used by the amalgamation. If undefined,
  141353. ** make it a no-op.
  141354. */
  141355. #ifndef testcase
  141356. # define testcase(X)
  141357. #endif
  141358. /*
  141359. ** Terminator values for position-lists and column-lists.
  141360. */
  141361. #define POS_COLUMN (1) /* Column-list terminator */
  141362. #define POS_END (0) /* Position-list terminator */
  141363. /*
  141364. ** This section provides definitions to allow the
  141365. ** FTS3 extension to be compiled outside of the
  141366. ** amalgamation.
  141367. */
  141368. #ifndef SQLITE_AMALGAMATION
  141369. /*
  141370. ** Macros indicating that conditional expressions are always true or
  141371. ** false.
  141372. */
  141373. #ifdef SQLITE_COVERAGE_TEST
  141374. # define ALWAYS(x) (1)
  141375. # define NEVER(X) (0)
  141376. #elif defined(SQLITE_DEBUG)
  141377. # define ALWAYS(x) sqlite3Fts3Always((x)!=0)
  141378. # define NEVER(x) sqlite3Fts3Never((x)!=0)
  141379. SQLITE_PRIVATE int sqlite3Fts3Always(int b);
  141380. SQLITE_PRIVATE int sqlite3Fts3Never(int b);
  141381. #else
  141382. # define ALWAYS(x) (x)
  141383. # define NEVER(x) (x)
  141384. #endif
  141385. /*
  141386. ** Internal types used by SQLite.
  141387. */
  141388. typedef unsigned char u8; /* 1-byte (or larger) unsigned integer */
  141389. typedef short int i16; /* 2-byte (or larger) signed integer */
  141390. typedef unsigned int u32; /* 4-byte unsigned integer */
  141391. typedef sqlite3_uint64 u64; /* 8-byte unsigned integer */
  141392. typedef sqlite3_int64 i64; /* 8-byte signed integer */
  141393. /*
  141394. ** Macro used to suppress compiler warnings for unused parameters.
  141395. */
  141396. #define UNUSED_PARAMETER(x) (void)(x)
  141397. /*
  141398. ** Activate assert() only if SQLITE_TEST is enabled.
  141399. */
  141400. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  141401. # define NDEBUG 1
  141402. #endif
  141403. /*
  141404. ** The TESTONLY macro is used to enclose variable declarations or
  141405. ** other bits of code that are needed to support the arguments
  141406. ** within testcase() and assert() macros.
  141407. */
  141408. #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
  141409. # define TESTONLY(X) X
  141410. #else
  141411. # define TESTONLY(X)
  141412. #endif
  141413. #endif /* SQLITE_AMALGAMATION */
  141414. #ifdef SQLITE_DEBUG
  141415. SQLITE_PRIVATE int sqlite3Fts3Corrupt(void);
  141416. # define FTS_CORRUPT_VTAB sqlite3Fts3Corrupt()
  141417. #else
  141418. # define FTS_CORRUPT_VTAB SQLITE_CORRUPT_VTAB
  141419. #endif
  141420. typedef struct Fts3Table Fts3Table;
  141421. typedef struct Fts3Cursor Fts3Cursor;
  141422. typedef struct Fts3Expr Fts3Expr;
  141423. typedef struct Fts3Phrase Fts3Phrase;
  141424. typedef struct Fts3PhraseToken Fts3PhraseToken;
  141425. typedef struct Fts3Doclist Fts3Doclist;
  141426. typedef struct Fts3SegFilter Fts3SegFilter;
  141427. typedef struct Fts3DeferredToken Fts3DeferredToken;
  141428. typedef struct Fts3SegReader Fts3SegReader;
  141429. typedef struct Fts3MultiSegReader Fts3MultiSegReader;
  141430. typedef struct MatchinfoBuffer MatchinfoBuffer;
  141431. /*
  141432. ** A connection to a fulltext index is an instance of the following
  141433. ** structure. The xCreate and xConnect methods create an instance
  141434. ** of this structure and xDestroy and xDisconnect free that instance.
  141435. ** All other methods receive a pointer to the structure as one of their
  141436. ** arguments.
  141437. */
  141438. struct Fts3Table {
  141439. sqlite3_vtab base; /* Base class used by SQLite core */
  141440. sqlite3 *db; /* The database connection */
  141441. const char *zDb; /* logical database name */
  141442. const char *zName; /* virtual table name */
  141443. int nColumn; /* number of named columns in virtual table */
  141444. char **azColumn; /* column names. malloced */
  141445. u8 *abNotindexed; /* True for 'notindexed' columns */
  141446. sqlite3_tokenizer *pTokenizer; /* tokenizer for inserts and queries */
  141447. char *zContentTbl; /* content=xxx option, or NULL */
  141448. char *zLanguageid; /* languageid=xxx option, or NULL */
  141449. int nAutoincrmerge; /* Value configured by 'automerge' */
  141450. u32 nLeafAdd; /* Number of leaf blocks added this trans */
  141451. /* Precompiled statements used by the implementation. Each of these
  141452. ** statements is run and reset within a single virtual table API call.
  141453. */
  141454. sqlite3_stmt *aStmt[40];
  141455. sqlite3_stmt *pSeekStmt; /* Cache for fts3CursorSeekStmt() */
  141456. char *zReadExprlist;
  141457. char *zWriteExprlist;
  141458. int nNodeSize; /* Soft limit for node size */
  141459. u8 bFts4; /* True for FTS4, false for FTS3 */
  141460. u8 bHasStat; /* True if %_stat table exists (2==unknown) */
  141461. u8 bHasDocsize; /* True if %_docsize table exists */
  141462. u8 bDescIdx; /* True if doclists are in reverse order */
  141463. u8 bIgnoreSavepoint; /* True to ignore xSavepoint invocations */
  141464. int nPgsz; /* Page size for host database */
  141465. char *zSegmentsTbl; /* Name of %_segments table */
  141466. sqlite3_blob *pSegments; /* Blob handle open on %_segments table */
  141467. /*
  141468. ** The following array of hash tables is used to buffer pending index
  141469. ** updates during transactions. All pending updates buffered at any one
  141470. ** time must share a common language-id (see the FTS4 langid= feature).
  141471. ** The current language id is stored in variable iPrevLangid.
  141472. **
  141473. ** A single FTS4 table may have multiple full-text indexes. For each index
  141474. ** there is an entry in the aIndex[] array. Index 0 is an index of all the
  141475. ** terms that appear in the document set. Each subsequent index in aIndex[]
  141476. ** is an index of prefixes of a specific length.
  141477. **
  141478. ** Variable nPendingData contains an estimate the memory consumed by the
  141479. ** pending data structures, including hash table overhead, but not including
  141480. ** malloc overhead. When nPendingData exceeds nMaxPendingData, all hash
  141481. ** tables are flushed to disk. Variable iPrevDocid is the docid of the most
  141482. ** recently inserted record.
  141483. */
  141484. int nIndex; /* Size of aIndex[] */
  141485. struct Fts3Index {
  141486. int nPrefix; /* Prefix length (0 for main terms index) */
  141487. Fts3Hash hPending; /* Pending terms table for this index */
  141488. } *aIndex;
  141489. int nMaxPendingData; /* Max pending data before flush to disk */
  141490. int nPendingData; /* Current bytes of pending data */
  141491. sqlite_int64 iPrevDocid; /* Docid of most recently inserted document */
  141492. int iPrevLangid; /* Langid of recently inserted document */
  141493. int bPrevDelete; /* True if last operation was a delete */
  141494. #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
  141495. /* State variables used for validating that the transaction control
  141496. ** methods of the virtual table are called at appropriate times. These
  141497. ** values do not contribute to FTS functionality; they are used for
  141498. ** verifying the operation of the SQLite core.
  141499. */
  141500. int inTransaction; /* True after xBegin but before xCommit/xRollback */
  141501. int mxSavepoint; /* Largest valid xSavepoint integer */
  141502. #endif
  141503. #ifdef SQLITE_TEST
  141504. /* True to disable the incremental doclist optimization. This is controled
  141505. ** by special insert command 'test-no-incr-doclist'. */
  141506. int bNoIncrDoclist;
  141507. #endif
  141508. };
  141509. /*
  141510. ** When the core wants to read from the virtual table, it creates a
  141511. ** virtual table cursor (an instance of the following structure) using
  141512. ** the xOpen method. Cursors are destroyed using the xClose method.
  141513. */
  141514. struct Fts3Cursor {
  141515. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  141516. i16 eSearch; /* Search strategy (see below) */
  141517. u8 isEof; /* True if at End Of Results */
  141518. u8 isRequireSeek; /* True if must seek pStmt to %_content row */
  141519. u8 bSeekStmt; /* True if pStmt is a seek */
  141520. sqlite3_stmt *pStmt; /* Prepared statement in use by the cursor */
  141521. Fts3Expr *pExpr; /* Parsed MATCH query string */
  141522. int iLangid; /* Language being queried for */
  141523. int nPhrase; /* Number of matchable phrases in query */
  141524. Fts3DeferredToken *pDeferred; /* Deferred search tokens, if any */
  141525. sqlite3_int64 iPrevId; /* Previous id read from aDoclist */
  141526. char *pNextId; /* Pointer into the body of aDoclist */
  141527. char *aDoclist; /* List of docids for full-text queries */
  141528. int nDoclist; /* Size of buffer at aDoclist */
  141529. u8 bDesc; /* True to sort in descending order */
  141530. int eEvalmode; /* An FTS3_EVAL_XX constant */
  141531. int nRowAvg; /* Average size of database rows, in pages */
  141532. sqlite3_int64 nDoc; /* Documents in table */
  141533. i64 iMinDocid; /* Minimum docid to return */
  141534. i64 iMaxDocid; /* Maximum docid to return */
  141535. int isMatchinfoNeeded; /* True when aMatchinfo[] needs filling in */
  141536. MatchinfoBuffer *pMIBuffer; /* Buffer for matchinfo data */
  141537. };
  141538. #define FTS3_EVAL_FILTER 0
  141539. #define FTS3_EVAL_NEXT 1
  141540. #define FTS3_EVAL_MATCHINFO 2
  141541. /*
  141542. ** The Fts3Cursor.eSearch member is always set to one of the following.
  141543. ** Actualy, Fts3Cursor.eSearch can be greater than or equal to
  141544. ** FTS3_FULLTEXT_SEARCH. If so, then Fts3Cursor.eSearch - 2 is the index
  141545. ** of the column to be searched. For example, in
  141546. **
  141547. ** CREATE VIRTUAL TABLE ex1 USING fts3(a,b,c,d);
  141548. ** SELECT docid FROM ex1 WHERE b MATCH 'one two three';
  141549. **
  141550. ** Because the LHS of the MATCH operator is 2nd column "b",
  141551. ** Fts3Cursor.eSearch will be set to FTS3_FULLTEXT_SEARCH+1. (+0 for a,
  141552. ** +1 for b, +2 for c, +3 for d.) If the LHS of MATCH were "ex1"
  141553. ** indicating that all columns should be searched,
  141554. ** then eSearch would be set to FTS3_FULLTEXT_SEARCH+4.
  141555. */
  141556. #define FTS3_FULLSCAN_SEARCH 0 /* Linear scan of %_content table */
  141557. #define FTS3_DOCID_SEARCH 1 /* Lookup by rowid on %_content table */
  141558. #define FTS3_FULLTEXT_SEARCH 2 /* Full-text index search */
  141559. /*
  141560. ** The lower 16-bits of the sqlite3_index_info.idxNum value set by
  141561. ** the xBestIndex() method contains the Fts3Cursor.eSearch value described
  141562. ** above. The upper 16-bits contain a combination of the following
  141563. ** bits, used to describe extra constraints on full-text searches.
  141564. */
  141565. #define FTS3_HAVE_LANGID 0x00010000 /* languageid=? */
  141566. #define FTS3_HAVE_DOCID_GE 0x00020000 /* docid>=? */
  141567. #define FTS3_HAVE_DOCID_LE 0x00040000 /* docid<=? */
  141568. struct Fts3Doclist {
  141569. char *aAll; /* Array containing doclist (or NULL) */
  141570. int nAll; /* Size of a[] in bytes */
  141571. char *pNextDocid; /* Pointer to next docid */
  141572. sqlite3_int64 iDocid; /* Current docid (if pList!=0) */
  141573. int bFreeList; /* True if pList should be sqlite3_free()d */
  141574. char *pList; /* Pointer to position list following iDocid */
  141575. int nList; /* Length of position list */
  141576. };
  141577. /*
  141578. ** A "phrase" is a sequence of one or more tokens that must match in
  141579. ** sequence. A single token is the base case and the most common case.
  141580. ** For a sequence of tokens contained in double-quotes (i.e. "one two three")
  141581. ** nToken will be the number of tokens in the string.
  141582. */
  141583. struct Fts3PhraseToken {
  141584. char *z; /* Text of the token */
  141585. int n; /* Number of bytes in buffer z */
  141586. int isPrefix; /* True if token ends with a "*" character */
  141587. int bFirst; /* True if token must appear at position 0 */
  141588. /* Variables above this point are populated when the expression is
  141589. ** parsed (by code in fts3_expr.c). Below this point the variables are
  141590. ** used when evaluating the expression. */
  141591. Fts3DeferredToken *pDeferred; /* Deferred token object for this token */
  141592. Fts3MultiSegReader *pSegcsr; /* Segment-reader for this token */
  141593. };
  141594. struct Fts3Phrase {
  141595. /* Cache of doclist for this phrase. */
  141596. Fts3Doclist doclist;
  141597. int bIncr; /* True if doclist is loaded incrementally */
  141598. int iDoclistToken;
  141599. /* Used by sqlite3Fts3EvalPhrasePoslist() if this is a descendent of an
  141600. ** OR condition. */
  141601. char *pOrPoslist;
  141602. i64 iOrDocid;
  141603. /* Variables below this point are populated by fts3_expr.c when parsing
  141604. ** a MATCH expression. Everything above is part of the evaluation phase.
  141605. */
  141606. int nToken; /* Number of tokens in the phrase */
  141607. int iColumn; /* Index of column this phrase must match */
  141608. Fts3PhraseToken aToken[1]; /* One entry for each token in the phrase */
  141609. };
  141610. /*
  141611. ** A tree of these objects forms the RHS of a MATCH operator.
  141612. **
  141613. ** If Fts3Expr.eType is FTSQUERY_PHRASE and isLoaded is true, then aDoclist
  141614. ** points to a malloced buffer, size nDoclist bytes, containing the results
  141615. ** of this phrase query in FTS3 doclist format. As usual, the initial
  141616. ** "Length" field found in doclists stored on disk is omitted from this
  141617. ** buffer.
  141618. **
  141619. ** Variable aMI is used only for FTSQUERY_NEAR nodes to store the global
  141620. ** matchinfo data. If it is not NULL, it points to an array of size nCol*3,
  141621. ** where nCol is the number of columns in the queried FTS table. The array
  141622. ** is populated as follows:
  141623. **
  141624. ** aMI[iCol*3 + 0] = Undefined
  141625. ** aMI[iCol*3 + 1] = Number of occurrences
  141626. ** aMI[iCol*3 + 2] = Number of rows containing at least one instance
  141627. **
  141628. ** The aMI array is allocated using sqlite3_malloc(). It should be freed
  141629. ** when the expression node is.
  141630. */
  141631. struct Fts3Expr {
  141632. int eType; /* One of the FTSQUERY_XXX values defined below */
  141633. int nNear; /* Valid if eType==FTSQUERY_NEAR */
  141634. Fts3Expr *pParent; /* pParent->pLeft==this or pParent->pRight==this */
  141635. Fts3Expr *pLeft; /* Left operand */
  141636. Fts3Expr *pRight; /* Right operand */
  141637. Fts3Phrase *pPhrase; /* Valid if eType==FTSQUERY_PHRASE */
  141638. /* The following are used by the fts3_eval.c module. */
  141639. sqlite3_int64 iDocid; /* Current docid */
  141640. u8 bEof; /* True this expression is at EOF already */
  141641. u8 bStart; /* True if iDocid is valid */
  141642. u8 bDeferred; /* True if this expression is entirely deferred */
  141643. /* The following are used by the fts3_snippet.c module. */
  141644. int iPhrase; /* Index of this phrase in matchinfo() results */
  141645. u32 *aMI; /* See above */
  141646. };
  141647. /*
  141648. ** Candidate values for Fts3Query.eType. Note that the order of the first
  141649. ** four values is in order of precedence when parsing expressions. For
  141650. ** example, the following:
  141651. **
  141652. ** "a OR b AND c NOT d NEAR e"
  141653. **
  141654. ** is equivalent to:
  141655. **
  141656. ** "a OR (b AND (c NOT (d NEAR e)))"
  141657. */
  141658. #define FTSQUERY_NEAR 1
  141659. #define FTSQUERY_NOT 2
  141660. #define FTSQUERY_AND 3
  141661. #define FTSQUERY_OR 4
  141662. #define FTSQUERY_PHRASE 5
  141663. /* fts3_write.c */
  141664. SQLITE_PRIVATE int sqlite3Fts3UpdateMethod(sqlite3_vtab*,int,sqlite3_value**,sqlite3_int64*);
  141665. SQLITE_PRIVATE int sqlite3Fts3PendingTermsFlush(Fts3Table *);
  141666. SQLITE_PRIVATE void sqlite3Fts3PendingTermsClear(Fts3Table *);
  141667. SQLITE_PRIVATE int sqlite3Fts3Optimize(Fts3Table *);
  141668. SQLITE_PRIVATE int sqlite3Fts3SegReaderNew(int, int, sqlite3_int64,
  141669. sqlite3_int64, sqlite3_int64, const char *, int, Fts3SegReader**);
  141670. SQLITE_PRIVATE int sqlite3Fts3SegReaderPending(
  141671. Fts3Table*,int,const char*,int,int,Fts3SegReader**);
  141672. SQLITE_PRIVATE void sqlite3Fts3SegReaderFree(Fts3SegReader *);
  141673. SQLITE_PRIVATE int sqlite3Fts3AllSegdirs(Fts3Table*, int, int, int, sqlite3_stmt **);
  141674. SQLITE_PRIVATE int sqlite3Fts3ReadBlock(Fts3Table*, sqlite3_int64, char **, int*, int*);
  141675. SQLITE_PRIVATE int sqlite3Fts3SelectDoctotal(Fts3Table *, sqlite3_stmt **);
  141676. SQLITE_PRIVATE int sqlite3Fts3SelectDocsize(Fts3Table *, sqlite3_int64, sqlite3_stmt **);
  141677. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  141678. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredTokens(Fts3Cursor *);
  141679. SQLITE_PRIVATE int sqlite3Fts3DeferToken(Fts3Cursor *, Fts3PhraseToken *, int);
  141680. SQLITE_PRIVATE int sqlite3Fts3CacheDeferredDoclists(Fts3Cursor *);
  141681. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredDoclists(Fts3Cursor *);
  141682. SQLITE_PRIVATE int sqlite3Fts3DeferredTokenList(Fts3DeferredToken *, char **, int *);
  141683. #else
  141684. # define sqlite3Fts3FreeDeferredTokens(x)
  141685. # define sqlite3Fts3DeferToken(x,y,z) SQLITE_OK
  141686. # define sqlite3Fts3CacheDeferredDoclists(x) SQLITE_OK
  141687. # define sqlite3Fts3FreeDeferredDoclists(x)
  141688. # define sqlite3Fts3DeferredTokenList(x,y,z) SQLITE_OK
  141689. #endif
  141690. SQLITE_PRIVATE void sqlite3Fts3SegmentsClose(Fts3Table *);
  141691. SQLITE_PRIVATE int sqlite3Fts3MaxLevel(Fts3Table *, int *);
  141692. /* Special values interpreted by sqlite3SegReaderCursor() */
  141693. #define FTS3_SEGCURSOR_PENDING -1
  141694. #define FTS3_SEGCURSOR_ALL -2
  141695. SQLITE_PRIVATE int sqlite3Fts3SegReaderStart(Fts3Table*, Fts3MultiSegReader*, Fts3SegFilter*);
  141696. SQLITE_PRIVATE int sqlite3Fts3SegReaderStep(Fts3Table *, Fts3MultiSegReader *);
  141697. SQLITE_PRIVATE void sqlite3Fts3SegReaderFinish(Fts3MultiSegReader *);
  141698. SQLITE_PRIVATE int sqlite3Fts3SegReaderCursor(Fts3Table *,
  141699. int, int, int, const char *, int, int, int, Fts3MultiSegReader *);
  141700. /* Flags allowed as part of the 4th argument to SegmentReaderIterate() */
  141701. #define FTS3_SEGMENT_REQUIRE_POS 0x00000001
  141702. #define FTS3_SEGMENT_IGNORE_EMPTY 0x00000002
  141703. #define FTS3_SEGMENT_COLUMN_FILTER 0x00000004
  141704. #define FTS3_SEGMENT_PREFIX 0x00000008
  141705. #define FTS3_SEGMENT_SCAN 0x00000010
  141706. #define FTS3_SEGMENT_FIRST 0x00000020
  141707. /* Type passed as 4th argument to SegmentReaderIterate() */
  141708. struct Fts3SegFilter {
  141709. const char *zTerm;
  141710. int nTerm;
  141711. int iCol;
  141712. int flags;
  141713. };
  141714. struct Fts3MultiSegReader {
  141715. /* Used internally by sqlite3Fts3SegReaderXXX() calls */
  141716. Fts3SegReader **apSegment; /* Array of Fts3SegReader objects */
  141717. int nSegment; /* Size of apSegment array */
  141718. int nAdvance; /* How many seg-readers to advance */
  141719. Fts3SegFilter *pFilter; /* Pointer to filter object */
  141720. char *aBuffer; /* Buffer to merge doclists in */
  141721. int nBuffer; /* Allocated size of aBuffer[] in bytes */
  141722. int iColFilter; /* If >=0, filter for this column */
  141723. int bRestart;
  141724. /* Used by fts3.c only. */
  141725. int nCost; /* Cost of running iterator */
  141726. int bLookup; /* True if a lookup of a single entry. */
  141727. /* Output values. Valid only after Fts3SegReaderStep() returns SQLITE_ROW. */
  141728. char *zTerm; /* Pointer to term buffer */
  141729. int nTerm; /* Size of zTerm in bytes */
  141730. char *aDoclist; /* Pointer to doclist buffer */
  141731. int nDoclist; /* Size of aDoclist[] in bytes */
  141732. };
  141733. SQLITE_PRIVATE int sqlite3Fts3Incrmerge(Fts3Table*,int,int);
  141734. #define fts3GetVarint32(p, piVal) ( \
  141735. (*(u8*)(p)&0x80) ? sqlite3Fts3GetVarint32(p, piVal) : (*piVal=*(u8*)(p), 1) \
  141736. )
  141737. /* fts3.c */
  141738. SQLITE_PRIVATE void sqlite3Fts3ErrMsg(char**,const char*,...);
  141739. SQLITE_PRIVATE int sqlite3Fts3PutVarint(char *, sqlite3_int64);
  141740. SQLITE_PRIVATE int sqlite3Fts3GetVarint(const char *, sqlite_int64 *);
  141741. SQLITE_PRIVATE int sqlite3Fts3GetVarint32(const char *, int *);
  141742. SQLITE_PRIVATE int sqlite3Fts3VarintLen(sqlite3_uint64);
  141743. SQLITE_PRIVATE void sqlite3Fts3Dequote(char *);
  141744. SQLITE_PRIVATE void sqlite3Fts3DoclistPrev(int,char*,int,char**,sqlite3_int64*,int*,u8*);
  141745. SQLITE_PRIVATE int sqlite3Fts3EvalPhraseStats(Fts3Cursor *, Fts3Expr *, u32 *);
  141746. SQLITE_PRIVATE int sqlite3Fts3FirstFilter(sqlite3_int64, char *, int, char *);
  141747. SQLITE_PRIVATE void sqlite3Fts3CreateStatTable(int*, Fts3Table*);
  141748. SQLITE_PRIVATE int sqlite3Fts3EvalTestDeferred(Fts3Cursor *pCsr, int *pRc);
  141749. /* fts3_tokenizer.c */
  141750. SQLITE_PRIVATE const char *sqlite3Fts3NextToken(const char *, int *);
  141751. SQLITE_PRIVATE int sqlite3Fts3InitHashTable(sqlite3 *, Fts3Hash *, const char *);
  141752. SQLITE_PRIVATE int sqlite3Fts3InitTokenizer(Fts3Hash *pHash, const char *,
  141753. sqlite3_tokenizer **, char **
  141754. );
  141755. SQLITE_PRIVATE int sqlite3Fts3IsIdChar(char);
  141756. /* fts3_snippet.c */
  141757. SQLITE_PRIVATE void sqlite3Fts3Offsets(sqlite3_context*, Fts3Cursor*);
  141758. SQLITE_PRIVATE void sqlite3Fts3Snippet(sqlite3_context *, Fts3Cursor *, const char *,
  141759. const char *, const char *, int, int
  141760. );
  141761. SQLITE_PRIVATE void sqlite3Fts3Matchinfo(sqlite3_context *, Fts3Cursor *, const char *);
  141762. SQLITE_PRIVATE void sqlite3Fts3MIBufferFree(MatchinfoBuffer *p);
  141763. /* fts3_expr.c */
  141764. SQLITE_PRIVATE int sqlite3Fts3ExprParse(sqlite3_tokenizer *, int,
  141765. char **, int, int, int, const char *, int, Fts3Expr **, char **
  141766. );
  141767. SQLITE_PRIVATE void sqlite3Fts3ExprFree(Fts3Expr *);
  141768. #ifdef SQLITE_TEST
  141769. SQLITE_PRIVATE int sqlite3Fts3ExprInitTestInterface(sqlite3 *db);
  141770. SQLITE_PRIVATE int sqlite3Fts3InitTerm(sqlite3 *db);
  141771. #endif
  141772. SQLITE_PRIVATE int sqlite3Fts3OpenTokenizer(sqlite3_tokenizer *, int, const char *, int,
  141773. sqlite3_tokenizer_cursor **
  141774. );
  141775. /* fts3_aux.c */
  141776. SQLITE_PRIVATE int sqlite3Fts3InitAux(sqlite3 *db);
  141777. SQLITE_PRIVATE void sqlite3Fts3EvalPhraseCleanup(Fts3Phrase *);
  141778. SQLITE_PRIVATE int sqlite3Fts3MsrIncrStart(
  141779. Fts3Table*, Fts3MultiSegReader*, int, const char*, int);
  141780. SQLITE_PRIVATE int sqlite3Fts3MsrIncrNext(
  141781. Fts3Table *, Fts3MultiSegReader *, sqlite3_int64 *, char **, int *);
  141782. SQLITE_PRIVATE int sqlite3Fts3EvalPhrasePoslist(Fts3Cursor *, Fts3Expr *, int iCol, char **);
  141783. SQLITE_PRIVATE int sqlite3Fts3MsrOvfl(Fts3Cursor *, Fts3MultiSegReader *, int *);
  141784. SQLITE_PRIVATE int sqlite3Fts3MsrIncrRestart(Fts3MultiSegReader *pCsr);
  141785. /* fts3_tokenize_vtab.c */
  141786. SQLITE_PRIVATE int sqlite3Fts3InitTok(sqlite3*, Fts3Hash *);
  141787. /* fts3_unicode2.c (functions generated by parsing unicode text files) */
  141788. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  141789. SQLITE_PRIVATE int sqlite3FtsUnicodeFold(int, int);
  141790. SQLITE_PRIVATE int sqlite3FtsUnicodeIsalnum(int);
  141791. SQLITE_PRIVATE int sqlite3FtsUnicodeIsdiacritic(int);
  141792. #endif
  141793. #endif /* !SQLITE_CORE || SQLITE_ENABLE_FTS3 */
  141794. #endif /* _FTSINT_H */
  141795. /************** End of fts3Int.h *********************************************/
  141796. /************** Continuing where we left off in fts3.c ***********************/
  141797. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  141798. #if defined(SQLITE_ENABLE_FTS3) && !defined(SQLITE_CORE)
  141799. # define SQLITE_CORE 1
  141800. #endif
  141801. /* #include <assert.h> */
  141802. /* #include <stdlib.h> */
  141803. /* #include <stddef.h> */
  141804. /* #include <stdio.h> */
  141805. /* #include <string.h> */
  141806. /* #include <stdarg.h> */
  141807. /* #include "fts3.h" */
  141808. #ifndef SQLITE_CORE
  141809. /* # include "sqlite3ext.h" */
  141810. SQLITE_EXTENSION_INIT1
  141811. #endif
  141812. static int fts3EvalNext(Fts3Cursor *pCsr);
  141813. static int fts3EvalStart(Fts3Cursor *pCsr);
  141814. static int fts3TermSegReaderCursor(
  141815. Fts3Cursor *, const char *, int, int, Fts3MultiSegReader **);
  141816. #ifndef SQLITE_AMALGAMATION
  141817. # if defined(SQLITE_DEBUG)
  141818. SQLITE_PRIVATE int sqlite3Fts3Always(int b) { assert( b ); return b; }
  141819. SQLITE_PRIVATE int sqlite3Fts3Never(int b) { assert( !b ); return b; }
  141820. # endif
  141821. #endif
  141822. /*
  141823. ** Write a 64-bit variable-length integer to memory starting at p[0].
  141824. ** The length of data written will be between 1 and FTS3_VARINT_MAX bytes.
  141825. ** The number of bytes written is returned.
  141826. */
  141827. SQLITE_PRIVATE int sqlite3Fts3PutVarint(char *p, sqlite_int64 v){
  141828. unsigned char *q = (unsigned char *) p;
  141829. sqlite_uint64 vu = v;
  141830. do{
  141831. *q++ = (unsigned char) ((vu & 0x7f) | 0x80);
  141832. vu >>= 7;
  141833. }while( vu!=0 );
  141834. q[-1] &= 0x7f; /* turn off high bit in final byte */
  141835. assert( q - (unsigned char *)p <= FTS3_VARINT_MAX );
  141836. return (int) (q - (unsigned char *)p);
  141837. }
  141838. #define GETVARINT_STEP(v, ptr, shift, mask1, mask2, var, ret) \
  141839. v = (v & mask1) | ( (*ptr++) << shift ); \
  141840. if( (v & mask2)==0 ){ var = v; return ret; }
  141841. #define GETVARINT_INIT(v, ptr, shift, mask1, mask2, var, ret) \
  141842. v = (*ptr++); \
  141843. if( (v & mask2)==0 ){ var = v; return ret; }
  141844. /*
  141845. ** Read a 64-bit variable-length integer from memory starting at p[0].
  141846. ** Return the number of bytes read, or 0 on error.
  141847. ** The value is stored in *v.
  141848. */
  141849. SQLITE_PRIVATE int sqlite3Fts3GetVarint(const char *pBuf, sqlite_int64 *v){
  141850. const unsigned char *p = (const unsigned char*)pBuf;
  141851. const unsigned char *pStart = p;
  141852. u32 a;
  141853. u64 b;
  141854. int shift;
  141855. GETVARINT_INIT(a, p, 0, 0x00, 0x80, *v, 1);
  141856. GETVARINT_STEP(a, p, 7, 0x7F, 0x4000, *v, 2);
  141857. GETVARINT_STEP(a, p, 14, 0x3FFF, 0x200000, *v, 3);
  141858. GETVARINT_STEP(a, p, 21, 0x1FFFFF, 0x10000000, *v, 4);
  141859. b = (a & 0x0FFFFFFF );
  141860. for(shift=28; shift<=63; shift+=7){
  141861. u64 c = *p++;
  141862. b += (c&0x7F) << shift;
  141863. if( (c & 0x80)==0 ) break;
  141864. }
  141865. *v = b;
  141866. return (int)(p - pStart);
  141867. }
  141868. /*
  141869. ** Similar to sqlite3Fts3GetVarint(), except that the output is truncated to
  141870. ** a non-negative 32-bit integer before it is returned.
  141871. */
  141872. SQLITE_PRIVATE int sqlite3Fts3GetVarint32(const char *p, int *pi){
  141873. u32 a;
  141874. #ifndef fts3GetVarint32
  141875. GETVARINT_INIT(a, p, 0, 0x00, 0x80, *pi, 1);
  141876. #else
  141877. a = (*p++);
  141878. assert( a & 0x80 );
  141879. #endif
  141880. GETVARINT_STEP(a, p, 7, 0x7F, 0x4000, *pi, 2);
  141881. GETVARINT_STEP(a, p, 14, 0x3FFF, 0x200000, *pi, 3);
  141882. GETVARINT_STEP(a, p, 21, 0x1FFFFF, 0x10000000, *pi, 4);
  141883. a = (a & 0x0FFFFFFF );
  141884. *pi = (int)(a | ((u32)(*p & 0x07) << 28));
  141885. assert( 0==(a & 0x80000000) );
  141886. assert( *pi>=0 );
  141887. return 5;
  141888. }
  141889. /*
  141890. ** Return the number of bytes required to encode v as a varint
  141891. */
  141892. SQLITE_PRIVATE int sqlite3Fts3VarintLen(sqlite3_uint64 v){
  141893. int i = 0;
  141894. do{
  141895. i++;
  141896. v >>= 7;
  141897. }while( v!=0 );
  141898. return i;
  141899. }
  141900. /*
  141901. ** Convert an SQL-style quoted string into a normal string by removing
  141902. ** the quote characters. The conversion is done in-place. If the
  141903. ** input does not begin with a quote character, then this routine
  141904. ** is a no-op.
  141905. **
  141906. ** Examples:
  141907. **
  141908. ** "abc" becomes abc
  141909. ** 'xyz' becomes xyz
  141910. ** [pqr] becomes pqr
  141911. ** `mno` becomes mno
  141912. **
  141913. */
  141914. SQLITE_PRIVATE void sqlite3Fts3Dequote(char *z){
  141915. char quote; /* Quote character (if any ) */
  141916. quote = z[0];
  141917. if( quote=='[' || quote=='\'' || quote=='"' || quote=='`' ){
  141918. int iIn = 1; /* Index of next byte to read from input */
  141919. int iOut = 0; /* Index of next byte to write to output */
  141920. /* If the first byte was a '[', then the close-quote character is a ']' */
  141921. if( quote=='[' ) quote = ']';
  141922. while( z[iIn] ){
  141923. if( z[iIn]==quote ){
  141924. if( z[iIn+1]!=quote ) break;
  141925. z[iOut++] = quote;
  141926. iIn += 2;
  141927. }else{
  141928. z[iOut++] = z[iIn++];
  141929. }
  141930. }
  141931. z[iOut] = '\0';
  141932. }
  141933. }
  141934. /*
  141935. ** Read a single varint from the doclist at *pp and advance *pp to point
  141936. ** to the first byte past the end of the varint. Add the value of the varint
  141937. ** to *pVal.
  141938. */
  141939. static void fts3GetDeltaVarint(char **pp, sqlite3_int64 *pVal){
  141940. sqlite3_int64 iVal;
  141941. *pp += sqlite3Fts3GetVarint(*pp, &iVal);
  141942. *pVal += iVal;
  141943. }
  141944. /*
  141945. ** When this function is called, *pp points to the first byte following a
  141946. ** varint that is part of a doclist (or position-list, or any other list
  141947. ** of varints). This function moves *pp to point to the start of that varint,
  141948. ** and sets *pVal by the varint value.
  141949. **
  141950. ** Argument pStart points to the first byte of the doclist that the
  141951. ** varint is part of.
  141952. */
  141953. static void fts3GetReverseVarint(
  141954. char **pp,
  141955. char *pStart,
  141956. sqlite3_int64 *pVal
  141957. ){
  141958. sqlite3_int64 iVal;
  141959. char *p;
  141960. /* Pointer p now points at the first byte past the varint we are
  141961. ** interested in. So, unless the doclist is corrupt, the 0x80 bit is
  141962. ** clear on character p[-1]. */
  141963. for(p = (*pp)-2; p>=pStart && *p&0x80; p--);
  141964. p++;
  141965. *pp = p;
  141966. sqlite3Fts3GetVarint(p, &iVal);
  141967. *pVal = iVal;
  141968. }
  141969. /*
  141970. ** The xDisconnect() virtual table method.
  141971. */
  141972. static int fts3DisconnectMethod(sqlite3_vtab *pVtab){
  141973. Fts3Table *p = (Fts3Table *)pVtab;
  141974. int i;
  141975. assert( p->nPendingData==0 );
  141976. assert( p->pSegments==0 );
  141977. /* Free any prepared statements held */
  141978. sqlite3_finalize(p->pSeekStmt);
  141979. for(i=0; i<SizeofArray(p->aStmt); i++){
  141980. sqlite3_finalize(p->aStmt[i]);
  141981. }
  141982. sqlite3_free(p->zSegmentsTbl);
  141983. sqlite3_free(p->zReadExprlist);
  141984. sqlite3_free(p->zWriteExprlist);
  141985. sqlite3_free(p->zContentTbl);
  141986. sqlite3_free(p->zLanguageid);
  141987. /* Invoke the tokenizer destructor to free the tokenizer. */
  141988. p->pTokenizer->pModule->xDestroy(p->pTokenizer);
  141989. sqlite3_free(p);
  141990. return SQLITE_OK;
  141991. }
  141992. /*
  141993. ** Write an error message into *pzErr
  141994. */
  141995. SQLITE_PRIVATE void sqlite3Fts3ErrMsg(char **pzErr, const char *zFormat, ...){
  141996. va_list ap;
  141997. sqlite3_free(*pzErr);
  141998. va_start(ap, zFormat);
  141999. *pzErr = sqlite3_vmprintf(zFormat, ap);
  142000. va_end(ap);
  142001. }
  142002. /*
  142003. ** Construct one or more SQL statements from the format string given
  142004. ** and then evaluate those statements. The success code is written
  142005. ** into *pRc.
  142006. **
  142007. ** If *pRc is initially non-zero then this routine is a no-op.
  142008. */
  142009. static void fts3DbExec(
  142010. int *pRc, /* Success code */
  142011. sqlite3 *db, /* Database in which to run SQL */
  142012. const char *zFormat, /* Format string for SQL */
  142013. ... /* Arguments to the format string */
  142014. ){
  142015. va_list ap;
  142016. char *zSql;
  142017. if( *pRc ) return;
  142018. va_start(ap, zFormat);
  142019. zSql = sqlite3_vmprintf(zFormat, ap);
  142020. va_end(ap);
  142021. if( zSql==0 ){
  142022. *pRc = SQLITE_NOMEM;
  142023. }else{
  142024. *pRc = sqlite3_exec(db, zSql, 0, 0, 0);
  142025. sqlite3_free(zSql);
  142026. }
  142027. }
  142028. /*
  142029. ** The xDestroy() virtual table method.
  142030. */
  142031. static int fts3DestroyMethod(sqlite3_vtab *pVtab){
  142032. Fts3Table *p = (Fts3Table *)pVtab;
  142033. int rc = SQLITE_OK; /* Return code */
  142034. const char *zDb = p->zDb; /* Name of database (e.g. "main", "temp") */
  142035. sqlite3 *db = p->db; /* Database handle */
  142036. /* Drop the shadow tables */
  142037. if( p->zContentTbl==0 ){
  142038. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_content'", zDb, p->zName);
  142039. }
  142040. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_segments'", zDb,p->zName);
  142041. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_segdir'", zDb, p->zName);
  142042. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_docsize'", zDb, p->zName);
  142043. fts3DbExec(&rc, db, "DROP TABLE IF EXISTS %Q.'%q_stat'", zDb, p->zName);
  142044. /* If everything has worked, invoke fts3DisconnectMethod() to free the
  142045. ** memory associated with the Fts3Table structure and return SQLITE_OK.
  142046. ** Otherwise, return an SQLite error code.
  142047. */
  142048. return (rc==SQLITE_OK ? fts3DisconnectMethod(pVtab) : rc);
  142049. }
  142050. /*
  142051. ** Invoke sqlite3_declare_vtab() to declare the schema for the FTS3 table
  142052. ** passed as the first argument. This is done as part of the xConnect()
  142053. ** and xCreate() methods.
  142054. **
  142055. ** If *pRc is non-zero when this function is called, it is a no-op.
  142056. ** Otherwise, if an error occurs, an SQLite error code is stored in *pRc
  142057. ** before returning.
  142058. */
  142059. static void fts3DeclareVtab(int *pRc, Fts3Table *p){
  142060. if( *pRc==SQLITE_OK ){
  142061. int i; /* Iterator variable */
  142062. int rc; /* Return code */
  142063. char *zSql; /* SQL statement passed to declare_vtab() */
  142064. char *zCols; /* List of user defined columns */
  142065. const char *zLanguageid;
  142066. zLanguageid = (p->zLanguageid ? p->zLanguageid : "__langid");
  142067. sqlite3_vtab_config(p->db, SQLITE_VTAB_CONSTRAINT_SUPPORT, 1);
  142068. /* Create a list of user columns for the virtual table */
  142069. zCols = sqlite3_mprintf("%Q, ", p->azColumn[0]);
  142070. for(i=1; zCols && i<p->nColumn; i++){
  142071. zCols = sqlite3_mprintf("%z%Q, ", zCols, p->azColumn[i]);
  142072. }
  142073. /* Create the whole "CREATE TABLE" statement to pass to SQLite */
  142074. zSql = sqlite3_mprintf(
  142075. "CREATE TABLE x(%s %Q HIDDEN, docid HIDDEN, %Q HIDDEN)",
  142076. zCols, p->zName, zLanguageid
  142077. );
  142078. if( !zCols || !zSql ){
  142079. rc = SQLITE_NOMEM;
  142080. }else{
  142081. rc = sqlite3_declare_vtab(p->db, zSql);
  142082. }
  142083. sqlite3_free(zSql);
  142084. sqlite3_free(zCols);
  142085. *pRc = rc;
  142086. }
  142087. }
  142088. /*
  142089. ** Create the %_stat table if it does not already exist.
  142090. */
  142091. SQLITE_PRIVATE void sqlite3Fts3CreateStatTable(int *pRc, Fts3Table *p){
  142092. fts3DbExec(pRc, p->db,
  142093. "CREATE TABLE IF NOT EXISTS %Q.'%q_stat'"
  142094. "(id INTEGER PRIMARY KEY, value BLOB);",
  142095. p->zDb, p->zName
  142096. );
  142097. if( (*pRc)==SQLITE_OK ) p->bHasStat = 1;
  142098. }
  142099. /*
  142100. ** Create the backing store tables (%_content, %_segments and %_segdir)
  142101. ** required by the FTS3 table passed as the only argument. This is done
  142102. ** as part of the vtab xCreate() method.
  142103. **
  142104. ** If the p->bHasDocsize boolean is true (indicating that this is an
  142105. ** FTS4 table, not an FTS3 table) then also create the %_docsize and
  142106. ** %_stat tables required by FTS4.
  142107. */
  142108. static int fts3CreateTables(Fts3Table *p){
  142109. int rc = SQLITE_OK; /* Return code */
  142110. int i; /* Iterator variable */
  142111. sqlite3 *db = p->db; /* The database connection */
  142112. if( p->zContentTbl==0 ){
  142113. const char *zLanguageid = p->zLanguageid;
  142114. char *zContentCols; /* Columns of %_content table */
  142115. /* Create a list of user columns for the content table */
  142116. zContentCols = sqlite3_mprintf("docid INTEGER PRIMARY KEY");
  142117. for(i=0; zContentCols && i<p->nColumn; i++){
  142118. char *z = p->azColumn[i];
  142119. zContentCols = sqlite3_mprintf("%z, 'c%d%q'", zContentCols, i, z);
  142120. }
  142121. if( zLanguageid && zContentCols ){
  142122. zContentCols = sqlite3_mprintf("%z, langid", zContentCols, zLanguageid);
  142123. }
  142124. if( zContentCols==0 ) rc = SQLITE_NOMEM;
  142125. /* Create the content table */
  142126. fts3DbExec(&rc, db,
  142127. "CREATE TABLE %Q.'%q_content'(%s)",
  142128. p->zDb, p->zName, zContentCols
  142129. );
  142130. sqlite3_free(zContentCols);
  142131. }
  142132. /* Create other tables */
  142133. fts3DbExec(&rc, db,
  142134. "CREATE TABLE %Q.'%q_segments'(blockid INTEGER PRIMARY KEY, block BLOB);",
  142135. p->zDb, p->zName
  142136. );
  142137. fts3DbExec(&rc, db,
  142138. "CREATE TABLE %Q.'%q_segdir'("
  142139. "level INTEGER,"
  142140. "idx INTEGER,"
  142141. "start_block INTEGER,"
  142142. "leaves_end_block INTEGER,"
  142143. "end_block INTEGER,"
  142144. "root BLOB,"
  142145. "PRIMARY KEY(level, idx)"
  142146. ");",
  142147. p->zDb, p->zName
  142148. );
  142149. if( p->bHasDocsize ){
  142150. fts3DbExec(&rc, db,
  142151. "CREATE TABLE %Q.'%q_docsize'(docid INTEGER PRIMARY KEY, size BLOB);",
  142152. p->zDb, p->zName
  142153. );
  142154. }
  142155. assert( p->bHasStat==p->bFts4 );
  142156. if( p->bHasStat ){
  142157. sqlite3Fts3CreateStatTable(&rc, p);
  142158. }
  142159. return rc;
  142160. }
  142161. /*
  142162. ** Store the current database page-size in bytes in p->nPgsz.
  142163. **
  142164. ** If *pRc is non-zero when this function is called, it is a no-op.
  142165. ** Otherwise, if an error occurs, an SQLite error code is stored in *pRc
  142166. ** before returning.
  142167. */
  142168. static void fts3DatabasePageSize(int *pRc, Fts3Table *p){
  142169. if( *pRc==SQLITE_OK ){
  142170. int rc; /* Return code */
  142171. char *zSql; /* SQL text "PRAGMA %Q.page_size" */
  142172. sqlite3_stmt *pStmt; /* Compiled "PRAGMA %Q.page_size" statement */
  142173. zSql = sqlite3_mprintf("PRAGMA %Q.page_size", p->zDb);
  142174. if( !zSql ){
  142175. rc = SQLITE_NOMEM;
  142176. }else{
  142177. rc = sqlite3_prepare(p->db, zSql, -1, &pStmt, 0);
  142178. if( rc==SQLITE_OK ){
  142179. sqlite3_step(pStmt);
  142180. p->nPgsz = sqlite3_column_int(pStmt, 0);
  142181. rc = sqlite3_finalize(pStmt);
  142182. }else if( rc==SQLITE_AUTH ){
  142183. p->nPgsz = 1024;
  142184. rc = SQLITE_OK;
  142185. }
  142186. }
  142187. assert( p->nPgsz>0 || rc!=SQLITE_OK );
  142188. sqlite3_free(zSql);
  142189. *pRc = rc;
  142190. }
  142191. }
  142192. /*
  142193. ** "Special" FTS4 arguments are column specifications of the following form:
  142194. **
  142195. ** <key> = <value>
  142196. **
  142197. ** There may not be whitespace surrounding the "=" character. The <value>
  142198. ** term may be quoted, but the <key> may not.
  142199. */
  142200. static int fts3IsSpecialColumn(
  142201. const char *z,
  142202. int *pnKey,
  142203. char **pzValue
  142204. ){
  142205. char *zValue;
  142206. const char *zCsr = z;
  142207. while( *zCsr!='=' ){
  142208. if( *zCsr=='\0' ) return 0;
  142209. zCsr++;
  142210. }
  142211. *pnKey = (int)(zCsr-z);
  142212. zValue = sqlite3_mprintf("%s", &zCsr[1]);
  142213. if( zValue ){
  142214. sqlite3Fts3Dequote(zValue);
  142215. }
  142216. *pzValue = zValue;
  142217. return 1;
  142218. }
  142219. /*
  142220. ** Append the output of a printf() style formatting to an existing string.
  142221. */
  142222. static void fts3Appendf(
  142223. int *pRc, /* IN/OUT: Error code */
  142224. char **pz, /* IN/OUT: Pointer to string buffer */
  142225. const char *zFormat, /* Printf format string to append */
  142226. ... /* Arguments for printf format string */
  142227. ){
  142228. if( *pRc==SQLITE_OK ){
  142229. va_list ap;
  142230. char *z;
  142231. va_start(ap, zFormat);
  142232. z = sqlite3_vmprintf(zFormat, ap);
  142233. va_end(ap);
  142234. if( z && *pz ){
  142235. char *z2 = sqlite3_mprintf("%s%s", *pz, z);
  142236. sqlite3_free(z);
  142237. z = z2;
  142238. }
  142239. if( z==0 ) *pRc = SQLITE_NOMEM;
  142240. sqlite3_free(*pz);
  142241. *pz = z;
  142242. }
  142243. }
  142244. /*
  142245. ** Return a copy of input string zInput enclosed in double-quotes (") and
  142246. ** with all double quote characters escaped. For example:
  142247. **
  142248. ** fts3QuoteId("un \"zip\"") -> "un \"\"zip\"\""
  142249. **
  142250. ** The pointer returned points to memory obtained from sqlite3_malloc(). It
  142251. ** is the callers responsibility to call sqlite3_free() to release this
  142252. ** memory.
  142253. */
  142254. static char *fts3QuoteId(char const *zInput){
  142255. int nRet;
  142256. char *zRet;
  142257. nRet = 2 + (int)strlen(zInput)*2 + 1;
  142258. zRet = sqlite3_malloc(nRet);
  142259. if( zRet ){
  142260. int i;
  142261. char *z = zRet;
  142262. *(z++) = '"';
  142263. for(i=0; zInput[i]; i++){
  142264. if( zInput[i]=='"' ) *(z++) = '"';
  142265. *(z++) = zInput[i];
  142266. }
  142267. *(z++) = '"';
  142268. *(z++) = '\0';
  142269. }
  142270. return zRet;
  142271. }
  142272. /*
  142273. ** Return a list of comma separated SQL expressions and a FROM clause that
  142274. ** could be used in a SELECT statement such as the following:
  142275. **
  142276. ** SELECT <list of expressions> FROM %_content AS x ...
  142277. **
  142278. ** to return the docid, followed by each column of text data in order
  142279. ** from left to write. If parameter zFunc is not NULL, then instead of
  142280. ** being returned directly each column of text data is passed to an SQL
  142281. ** function named zFunc first. For example, if zFunc is "unzip" and the
  142282. ** table has the three user-defined columns "a", "b", and "c", the following
  142283. ** string is returned:
  142284. **
  142285. ** "docid, unzip(x.'a'), unzip(x.'b'), unzip(x.'c') FROM %_content AS x"
  142286. **
  142287. ** The pointer returned points to a buffer allocated by sqlite3_malloc(). It
  142288. ** is the responsibility of the caller to eventually free it.
  142289. **
  142290. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op (and
  142291. ** a NULL pointer is returned). Otherwise, if an OOM error is encountered
  142292. ** by this function, NULL is returned and *pRc is set to SQLITE_NOMEM. If
  142293. ** no error occurs, *pRc is left unmodified.
  142294. */
  142295. static char *fts3ReadExprList(Fts3Table *p, const char *zFunc, int *pRc){
  142296. char *zRet = 0;
  142297. char *zFree = 0;
  142298. char *zFunction;
  142299. int i;
  142300. if( p->zContentTbl==0 ){
  142301. if( !zFunc ){
  142302. zFunction = "";
  142303. }else{
  142304. zFree = zFunction = fts3QuoteId(zFunc);
  142305. }
  142306. fts3Appendf(pRc, &zRet, "docid");
  142307. for(i=0; i<p->nColumn; i++){
  142308. fts3Appendf(pRc, &zRet, ",%s(x.'c%d%q')", zFunction, i, p->azColumn[i]);
  142309. }
  142310. if( p->zLanguageid ){
  142311. fts3Appendf(pRc, &zRet, ", x.%Q", "langid");
  142312. }
  142313. sqlite3_free(zFree);
  142314. }else{
  142315. fts3Appendf(pRc, &zRet, "rowid");
  142316. for(i=0; i<p->nColumn; i++){
  142317. fts3Appendf(pRc, &zRet, ", x.'%q'", p->azColumn[i]);
  142318. }
  142319. if( p->zLanguageid ){
  142320. fts3Appendf(pRc, &zRet, ", x.%Q", p->zLanguageid);
  142321. }
  142322. }
  142323. fts3Appendf(pRc, &zRet, " FROM '%q'.'%q%s' AS x",
  142324. p->zDb,
  142325. (p->zContentTbl ? p->zContentTbl : p->zName),
  142326. (p->zContentTbl ? "" : "_content")
  142327. );
  142328. return zRet;
  142329. }
  142330. /*
  142331. ** Return a list of N comma separated question marks, where N is the number
  142332. ** of columns in the %_content table (one for the docid plus one for each
  142333. ** user-defined text column).
  142334. **
  142335. ** If argument zFunc is not NULL, then all but the first question mark
  142336. ** is preceded by zFunc and an open bracket, and followed by a closed
  142337. ** bracket. For example, if zFunc is "zip" and the FTS3 table has three
  142338. ** user-defined text columns, the following string is returned:
  142339. **
  142340. ** "?, zip(?), zip(?), zip(?)"
  142341. **
  142342. ** The pointer returned points to a buffer allocated by sqlite3_malloc(). It
  142343. ** is the responsibility of the caller to eventually free it.
  142344. **
  142345. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op (and
  142346. ** a NULL pointer is returned). Otherwise, if an OOM error is encountered
  142347. ** by this function, NULL is returned and *pRc is set to SQLITE_NOMEM. If
  142348. ** no error occurs, *pRc is left unmodified.
  142349. */
  142350. static char *fts3WriteExprList(Fts3Table *p, const char *zFunc, int *pRc){
  142351. char *zRet = 0;
  142352. char *zFree = 0;
  142353. char *zFunction;
  142354. int i;
  142355. if( !zFunc ){
  142356. zFunction = "";
  142357. }else{
  142358. zFree = zFunction = fts3QuoteId(zFunc);
  142359. }
  142360. fts3Appendf(pRc, &zRet, "?");
  142361. for(i=0; i<p->nColumn; i++){
  142362. fts3Appendf(pRc, &zRet, ",%s(?)", zFunction);
  142363. }
  142364. if( p->zLanguageid ){
  142365. fts3Appendf(pRc, &zRet, ", ?");
  142366. }
  142367. sqlite3_free(zFree);
  142368. return zRet;
  142369. }
  142370. /*
  142371. ** This function interprets the string at (*pp) as a non-negative integer
  142372. ** value. It reads the integer and sets *pnOut to the value read, then
  142373. ** sets *pp to point to the byte immediately following the last byte of
  142374. ** the integer value.
  142375. **
  142376. ** Only decimal digits ('0'..'9') may be part of an integer value.
  142377. **
  142378. ** If *pp does not being with a decimal digit SQLITE_ERROR is returned and
  142379. ** the output value undefined. Otherwise SQLITE_OK is returned.
  142380. **
  142381. ** This function is used when parsing the "prefix=" FTS4 parameter.
  142382. */
  142383. static int fts3GobbleInt(const char **pp, int *pnOut){
  142384. const int MAX_NPREFIX = 10000000;
  142385. const char *p; /* Iterator pointer */
  142386. int nInt = 0; /* Output value */
  142387. for(p=*pp; p[0]>='0' && p[0]<='9'; p++){
  142388. nInt = nInt * 10 + (p[0] - '0');
  142389. if( nInt>MAX_NPREFIX ){
  142390. nInt = 0;
  142391. break;
  142392. }
  142393. }
  142394. if( p==*pp ) return SQLITE_ERROR;
  142395. *pnOut = nInt;
  142396. *pp = p;
  142397. return SQLITE_OK;
  142398. }
  142399. /*
  142400. ** This function is called to allocate an array of Fts3Index structures
  142401. ** representing the indexes maintained by the current FTS table. FTS tables
  142402. ** always maintain the main "terms" index, but may also maintain one or
  142403. ** more "prefix" indexes, depending on the value of the "prefix=" parameter
  142404. ** (if any) specified as part of the CREATE VIRTUAL TABLE statement.
  142405. **
  142406. ** Argument zParam is passed the value of the "prefix=" option if one was
  142407. ** specified, or NULL otherwise.
  142408. **
  142409. ** If no error occurs, SQLITE_OK is returned and *apIndex set to point to
  142410. ** the allocated array. *pnIndex is set to the number of elements in the
  142411. ** array. If an error does occur, an SQLite error code is returned.
  142412. **
  142413. ** Regardless of whether or not an error is returned, it is the responsibility
  142414. ** of the caller to call sqlite3_free() on the output array to free it.
  142415. */
  142416. static int fts3PrefixParameter(
  142417. const char *zParam, /* ABC in prefix=ABC parameter to parse */
  142418. int *pnIndex, /* OUT: size of *apIndex[] array */
  142419. struct Fts3Index **apIndex /* OUT: Array of indexes for this table */
  142420. ){
  142421. struct Fts3Index *aIndex; /* Allocated array */
  142422. int nIndex = 1; /* Number of entries in array */
  142423. if( zParam && zParam[0] ){
  142424. const char *p;
  142425. nIndex++;
  142426. for(p=zParam; *p; p++){
  142427. if( *p==',' ) nIndex++;
  142428. }
  142429. }
  142430. aIndex = sqlite3_malloc(sizeof(struct Fts3Index) * nIndex);
  142431. *apIndex = aIndex;
  142432. if( !aIndex ){
  142433. return SQLITE_NOMEM;
  142434. }
  142435. memset(aIndex, 0, sizeof(struct Fts3Index) * nIndex);
  142436. if( zParam ){
  142437. const char *p = zParam;
  142438. int i;
  142439. for(i=1; i<nIndex; i++){
  142440. int nPrefix = 0;
  142441. if( fts3GobbleInt(&p, &nPrefix) ) return SQLITE_ERROR;
  142442. assert( nPrefix>=0 );
  142443. if( nPrefix==0 ){
  142444. nIndex--;
  142445. i--;
  142446. }else{
  142447. aIndex[i].nPrefix = nPrefix;
  142448. }
  142449. p++;
  142450. }
  142451. }
  142452. *pnIndex = nIndex;
  142453. return SQLITE_OK;
  142454. }
  142455. /*
  142456. ** This function is called when initializing an FTS4 table that uses the
  142457. ** content=xxx option. It determines the number of and names of the columns
  142458. ** of the new FTS4 table.
  142459. **
  142460. ** The third argument passed to this function is the value passed to the
  142461. ** config=xxx option (i.e. "xxx"). This function queries the database for
  142462. ** a table of that name. If found, the output variables are populated
  142463. ** as follows:
  142464. **
  142465. ** *pnCol: Set to the number of columns table xxx has,
  142466. **
  142467. ** *pnStr: Set to the total amount of space required to store a copy
  142468. ** of each columns name, including the nul-terminator.
  142469. **
  142470. ** *pazCol: Set to point to an array of *pnCol strings. Each string is
  142471. ** the name of the corresponding column in table xxx. The array
  142472. ** and its contents are allocated using a single allocation. It
  142473. ** is the responsibility of the caller to free this allocation
  142474. ** by eventually passing the *pazCol value to sqlite3_free().
  142475. **
  142476. ** If the table cannot be found, an error code is returned and the output
  142477. ** variables are undefined. Or, if an OOM is encountered, SQLITE_NOMEM is
  142478. ** returned (and the output variables are undefined).
  142479. */
  142480. static int fts3ContentColumns(
  142481. sqlite3 *db, /* Database handle */
  142482. const char *zDb, /* Name of db (i.e. "main", "temp" etc.) */
  142483. const char *zTbl, /* Name of content table */
  142484. const char ***pazCol, /* OUT: Malloc'd array of column names */
  142485. int *pnCol, /* OUT: Size of array *pazCol */
  142486. int *pnStr, /* OUT: Bytes of string content */
  142487. char **pzErr /* OUT: error message */
  142488. ){
  142489. int rc = SQLITE_OK; /* Return code */
  142490. char *zSql; /* "SELECT *" statement on zTbl */
  142491. sqlite3_stmt *pStmt = 0; /* Compiled version of zSql */
  142492. zSql = sqlite3_mprintf("SELECT * FROM %Q.%Q", zDb, zTbl);
  142493. if( !zSql ){
  142494. rc = SQLITE_NOMEM;
  142495. }else{
  142496. rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
  142497. if( rc!=SQLITE_OK ){
  142498. sqlite3Fts3ErrMsg(pzErr, "%s", sqlite3_errmsg(db));
  142499. }
  142500. }
  142501. sqlite3_free(zSql);
  142502. if( rc==SQLITE_OK ){
  142503. const char **azCol; /* Output array */
  142504. int nStr = 0; /* Size of all column names (incl. 0x00) */
  142505. int nCol; /* Number of table columns */
  142506. int i; /* Used to iterate through columns */
  142507. /* Loop through the returned columns. Set nStr to the number of bytes of
  142508. ** space required to store a copy of each column name, including the
  142509. ** nul-terminator byte. */
  142510. nCol = sqlite3_column_count(pStmt);
  142511. for(i=0; i<nCol; i++){
  142512. const char *zCol = sqlite3_column_name(pStmt, i);
  142513. nStr += (int)strlen(zCol) + 1;
  142514. }
  142515. /* Allocate and populate the array to return. */
  142516. azCol = (const char **)sqlite3_malloc(sizeof(char *) * nCol + nStr);
  142517. if( azCol==0 ){
  142518. rc = SQLITE_NOMEM;
  142519. }else{
  142520. char *p = (char *)&azCol[nCol];
  142521. for(i=0; i<nCol; i++){
  142522. const char *zCol = sqlite3_column_name(pStmt, i);
  142523. int n = (int)strlen(zCol)+1;
  142524. memcpy(p, zCol, n);
  142525. azCol[i] = p;
  142526. p += n;
  142527. }
  142528. }
  142529. sqlite3_finalize(pStmt);
  142530. /* Set the output variables. */
  142531. *pnCol = nCol;
  142532. *pnStr = nStr;
  142533. *pazCol = azCol;
  142534. }
  142535. return rc;
  142536. }
  142537. /*
  142538. ** This function is the implementation of both the xConnect and xCreate
  142539. ** methods of the FTS3 virtual table.
  142540. **
  142541. ** The argv[] array contains the following:
  142542. **
  142543. ** argv[0] -> module name ("fts3" or "fts4")
  142544. ** argv[1] -> database name
  142545. ** argv[2] -> table name
  142546. ** argv[...] -> "column name" and other module argument fields.
  142547. */
  142548. static int fts3InitVtab(
  142549. int isCreate, /* True for xCreate, false for xConnect */
  142550. sqlite3 *db, /* The SQLite database connection */
  142551. void *pAux, /* Hash table containing tokenizers */
  142552. int argc, /* Number of elements in argv array */
  142553. const char * const *argv, /* xCreate/xConnect argument array */
  142554. sqlite3_vtab **ppVTab, /* Write the resulting vtab structure here */
  142555. char **pzErr /* Write any error message here */
  142556. ){
  142557. Fts3Hash *pHash = (Fts3Hash *)pAux;
  142558. Fts3Table *p = 0; /* Pointer to allocated vtab */
  142559. int rc = SQLITE_OK; /* Return code */
  142560. int i; /* Iterator variable */
  142561. int nByte; /* Size of allocation used for *p */
  142562. int iCol; /* Column index */
  142563. int nString = 0; /* Bytes required to hold all column names */
  142564. int nCol = 0; /* Number of columns in the FTS table */
  142565. char *zCsr; /* Space for holding column names */
  142566. int nDb; /* Bytes required to hold database name */
  142567. int nName; /* Bytes required to hold table name */
  142568. int isFts4 = (argv[0][3]=='4'); /* True for FTS4, false for FTS3 */
  142569. const char **aCol; /* Array of column names */
  142570. sqlite3_tokenizer *pTokenizer = 0; /* Tokenizer for this table */
  142571. int nIndex = 0; /* Size of aIndex[] array */
  142572. struct Fts3Index *aIndex = 0; /* Array of indexes for this table */
  142573. /* The results of parsing supported FTS4 key=value options: */
  142574. int bNoDocsize = 0; /* True to omit %_docsize table */
  142575. int bDescIdx = 0; /* True to store descending indexes */
  142576. char *zPrefix = 0; /* Prefix parameter value (or NULL) */
  142577. char *zCompress = 0; /* compress=? parameter (or NULL) */
  142578. char *zUncompress = 0; /* uncompress=? parameter (or NULL) */
  142579. char *zContent = 0; /* content=? parameter (or NULL) */
  142580. char *zLanguageid = 0; /* languageid=? parameter (or NULL) */
  142581. char **azNotindexed = 0; /* The set of notindexed= columns */
  142582. int nNotindexed = 0; /* Size of azNotindexed[] array */
  142583. assert( strlen(argv[0])==4 );
  142584. assert( (sqlite3_strnicmp(argv[0], "fts4", 4)==0 && isFts4)
  142585. || (sqlite3_strnicmp(argv[0], "fts3", 4)==0 && !isFts4)
  142586. );
  142587. nDb = (int)strlen(argv[1]) + 1;
  142588. nName = (int)strlen(argv[2]) + 1;
  142589. nByte = sizeof(const char *) * (argc-2);
  142590. aCol = (const char **)sqlite3_malloc(nByte);
  142591. if( aCol ){
  142592. memset((void*)aCol, 0, nByte);
  142593. azNotindexed = (char **)sqlite3_malloc(nByte);
  142594. }
  142595. if( azNotindexed ){
  142596. memset(azNotindexed, 0, nByte);
  142597. }
  142598. if( !aCol || !azNotindexed ){
  142599. rc = SQLITE_NOMEM;
  142600. goto fts3_init_out;
  142601. }
  142602. /* Loop through all of the arguments passed by the user to the FTS3/4
  142603. ** module (i.e. all the column names and special arguments). This loop
  142604. ** does the following:
  142605. **
  142606. ** + Figures out the number of columns the FTSX table will have, and
  142607. ** the number of bytes of space that must be allocated to store copies
  142608. ** of the column names.
  142609. **
  142610. ** + If there is a tokenizer specification included in the arguments,
  142611. ** initializes the tokenizer pTokenizer.
  142612. */
  142613. for(i=3; rc==SQLITE_OK && i<argc; i++){
  142614. char const *z = argv[i];
  142615. int nKey;
  142616. char *zVal;
  142617. /* Check if this is a tokenizer specification */
  142618. if( !pTokenizer
  142619. && strlen(z)>8
  142620. && 0==sqlite3_strnicmp(z, "tokenize", 8)
  142621. && 0==sqlite3Fts3IsIdChar(z[8])
  142622. ){
  142623. rc = sqlite3Fts3InitTokenizer(pHash, &z[9], &pTokenizer, pzErr);
  142624. }
  142625. /* Check if it is an FTS4 special argument. */
  142626. else if( isFts4 && fts3IsSpecialColumn(z, &nKey, &zVal) ){
  142627. struct Fts4Option {
  142628. const char *zOpt;
  142629. int nOpt;
  142630. } aFts4Opt[] = {
  142631. { "matchinfo", 9 }, /* 0 -> MATCHINFO */
  142632. { "prefix", 6 }, /* 1 -> PREFIX */
  142633. { "compress", 8 }, /* 2 -> COMPRESS */
  142634. { "uncompress", 10 }, /* 3 -> UNCOMPRESS */
  142635. { "order", 5 }, /* 4 -> ORDER */
  142636. { "content", 7 }, /* 5 -> CONTENT */
  142637. { "languageid", 10 }, /* 6 -> LANGUAGEID */
  142638. { "notindexed", 10 } /* 7 -> NOTINDEXED */
  142639. };
  142640. int iOpt;
  142641. if( !zVal ){
  142642. rc = SQLITE_NOMEM;
  142643. }else{
  142644. for(iOpt=0; iOpt<SizeofArray(aFts4Opt); iOpt++){
  142645. struct Fts4Option *pOp = &aFts4Opt[iOpt];
  142646. if( nKey==pOp->nOpt && !sqlite3_strnicmp(z, pOp->zOpt, pOp->nOpt) ){
  142647. break;
  142648. }
  142649. }
  142650. switch( iOpt ){
  142651. case 0: /* MATCHINFO */
  142652. if( strlen(zVal)!=4 || sqlite3_strnicmp(zVal, "fts3", 4) ){
  142653. sqlite3Fts3ErrMsg(pzErr, "unrecognized matchinfo: %s", zVal);
  142654. rc = SQLITE_ERROR;
  142655. }
  142656. bNoDocsize = 1;
  142657. break;
  142658. case 1: /* PREFIX */
  142659. sqlite3_free(zPrefix);
  142660. zPrefix = zVal;
  142661. zVal = 0;
  142662. break;
  142663. case 2: /* COMPRESS */
  142664. sqlite3_free(zCompress);
  142665. zCompress = zVal;
  142666. zVal = 0;
  142667. break;
  142668. case 3: /* UNCOMPRESS */
  142669. sqlite3_free(zUncompress);
  142670. zUncompress = zVal;
  142671. zVal = 0;
  142672. break;
  142673. case 4: /* ORDER */
  142674. if( (strlen(zVal)!=3 || sqlite3_strnicmp(zVal, "asc", 3))
  142675. && (strlen(zVal)!=4 || sqlite3_strnicmp(zVal, "desc", 4))
  142676. ){
  142677. sqlite3Fts3ErrMsg(pzErr, "unrecognized order: %s", zVal);
  142678. rc = SQLITE_ERROR;
  142679. }
  142680. bDescIdx = (zVal[0]=='d' || zVal[0]=='D');
  142681. break;
  142682. case 5: /* CONTENT */
  142683. sqlite3_free(zContent);
  142684. zContent = zVal;
  142685. zVal = 0;
  142686. break;
  142687. case 6: /* LANGUAGEID */
  142688. assert( iOpt==6 );
  142689. sqlite3_free(zLanguageid);
  142690. zLanguageid = zVal;
  142691. zVal = 0;
  142692. break;
  142693. case 7: /* NOTINDEXED */
  142694. azNotindexed[nNotindexed++] = zVal;
  142695. zVal = 0;
  142696. break;
  142697. default:
  142698. assert( iOpt==SizeofArray(aFts4Opt) );
  142699. sqlite3Fts3ErrMsg(pzErr, "unrecognized parameter: %s", z);
  142700. rc = SQLITE_ERROR;
  142701. break;
  142702. }
  142703. sqlite3_free(zVal);
  142704. }
  142705. }
  142706. /* Otherwise, the argument is a column name. */
  142707. else {
  142708. nString += (int)(strlen(z) + 1);
  142709. aCol[nCol++] = z;
  142710. }
  142711. }
  142712. /* If a content=xxx option was specified, the following:
  142713. **
  142714. ** 1. Ignore any compress= and uncompress= options.
  142715. **
  142716. ** 2. If no column names were specified as part of the CREATE VIRTUAL
  142717. ** TABLE statement, use all columns from the content table.
  142718. */
  142719. if( rc==SQLITE_OK && zContent ){
  142720. sqlite3_free(zCompress);
  142721. sqlite3_free(zUncompress);
  142722. zCompress = 0;
  142723. zUncompress = 0;
  142724. if( nCol==0 ){
  142725. sqlite3_free((void*)aCol);
  142726. aCol = 0;
  142727. rc = fts3ContentColumns(db, argv[1], zContent,&aCol,&nCol,&nString,pzErr);
  142728. /* If a languageid= option was specified, remove the language id
  142729. ** column from the aCol[] array. */
  142730. if( rc==SQLITE_OK && zLanguageid ){
  142731. int j;
  142732. for(j=0; j<nCol; j++){
  142733. if( sqlite3_stricmp(zLanguageid, aCol[j])==0 ){
  142734. int k;
  142735. for(k=j; k<nCol; k++) aCol[k] = aCol[k+1];
  142736. nCol--;
  142737. break;
  142738. }
  142739. }
  142740. }
  142741. }
  142742. }
  142743. if( rc!=SQLITE_OK ) goto fts3_init_out;
  142744. if( nCol==0 ){
  142745. assert( nString==0 );
  142746. aCol[0] = "content";
  142747. nString = 8;
  142748. nCol = 1;
  142749. }
  142750. if( pTokenizer==0 ){
  142751. rc = sqlite3Fts3InitTokenizer(pHash, "simple", &pTokenizer, pzErr);
  142752. if( rc!=SQLITE_OK ) goto fts3_init_out;
  142753. }
  142754. assert( pTokenizer );
  142755. rc = fts3PrefixParameter(zPrefix, &nIndex, &aIndex);
  142756. if( rc==SQLITE_ERROR ){
  142757. assert( zPrefix );
  142758. sqlite3Fts3ErrMsg(pzErr, "error parsing prefix parameter: %s", zPrefix);
  142759. }
  142760. if( rc!=SQLITE_OK ) goto fts3_init_out;
  142761. /* Allocate and populate the Fts3Table structure. */
  142762. nByte = sizeof(Fts3Table) + /* Fts3Table */
  142763. nCol * sizeof(char *) + /* azColumn */
  142764. nIndex * sizeof(struct Fts3Index) + /* aIndex */
  142765. nCol * sizeof(u8) + /* abNotindexed */
  142766. nName + /* zName */
  142767. nDb + /* zDb */
  142768. nString; /* Space for azColumn strings */
  142769. p = (Fts3Table*)sqlite3_malloc(nByte);
  142770. if( p==0 ){
  142771. rc = SQLITE_NOMEM;
  142772. goto fts3_init_out;
  142773. }
  142774. memset(p, 0, nByte);
  142775. p->db = db;
  142776. p->nColumn = nCol;
  142777. p->nPendingData = 0;
  142778. p->azColumn = (char **)&p[1];
  142779. p->pTokenizer = pTokenizer;
  142780. p->nMaxPendingData = FTS3_MAX_PENDING_DATA;
  142781. p->bHasDocsize = (isFts4 && bNoDocsize==0);
  142782. p->bHasStat = (u8)isFts4;
  142783. p->bFts4 = (u8)isFts4;
  142784. p->bDescIdx = (u8)bDescIdx;
  142785. p->nAutoincrmerge = 0xff; /* 0xff means setting unknown */
  142786. p->zContentTbl = zContent;
  142787. p->zLanguageid = zLanguageid;
  142788. zContent = 0;
  142789. zLanguageid = 0;
  142790. TESTONLY( p->inTransaction = -1 );
  142791. TESTONLY( p->mxSavepoint = -1 );
  142792. p->aIndex = (struct Fts3Index *)&p->azColumn[nCol];
  142793. memcpy(p->aIndex, aIndex, sizeof(struct Fts3Index) * nIndex);
  142794. p->nIndex = nIndex;
  142795. for(i=0; i<nIndex; i++){
  142796. fts3HashInit(&p->aIndex[i].hPending, FTS3_HASH_STRING, 1);
  142797. }
  142798. p->abNotindexed = (u8 *)&p->aIndex[nIndex];
  142799. /* Fill in the zName and zDb fields of the vtab structure. */
  142800. zCsr = (char *)&p->abNotindexed[nCol];
  142801. p->zName = zCsr;
  142802. memcpy(zCsr, argv[2], nName);
  142803. zCsr += nName;
  142804. p->zDb = zCsr;
  142805. memcpy(zCsr, argv[1], nDb);
  142806. zCsr += nDb;
  142807. /* Fill in the azColumn array */
  142808. for(iCol=0; iCol<nCol; iCol++){
  142809. char *z;
  142810. int n = 0;
  142811. z = (char *)sqlite3Fts3NextToken(aCol[iCol], &n);
  142812. if( n>0 ){
  142813. memcpy(zCsr, z, n);
  142814. }
  142815. zCsr[n] = '\0';
  142816. sqlite3Fts3Dequote(zCsr);
  142817. p->azColumn[iCol] = zCsr;
  142818. zCsr += n+1;
  142819. assert( zCsr <= &((char *)p)[nByte] );
  142820. }
  142821. /* Fill in the abNotindexed array */
  142822. for(iCol=0; iCol<nCol; iCol++){
  142823. int n = (int)strlen(p->azColumn[iCol]);
  142824. for(i=0; i<nNotindexed; i++){
  142825. char *zNot = azNotindexed[i];
  142826. if( zNot && n==(int)strlen(zNot)
  142827. && 0==sqlite3_strnicmp(p->azColumn[iCol], zNot, n)
  142828. ){
  142829. p->abNotindexed[iCol] = 1;
  142830. sqlite3_free(zNot);
  142831. azNotindexed[i] = 0;
  142832. }
  142833. }
  142834. }
  142835. for(i=0; i<nNotindexed; i++){
  142836. if( azNotindexed[i] ){
  142837. sqlite3Fts3ErrMsg(pzErr, "no such column: %s", azNotindexed[i]);
  142838. rc = SQLITE_ERROR;
  142839. }
  142840. }
  142841. if( rc==SQLITE_OK && (zCompress==0)!=(zUncompress==0) ){
  142842. char const *zMiss = (zCompress==0 ? "compress" : "uncompress");
  142843. rc = SQLITE_ERROR;
  142844. sqlite3Fts3ErrMsg(pzErr, "missing %s parameter in fts4 constructor", zMiss);
  142845. }
  142846. p->zReadExprlist = fts3ReadExprList(p, zUncompress, &rc);
  142847. p->zWriteExprlist = fts3WriteExprList(p, zCompress, &rc);
  142848. if( rc!=SQLITE_OK ) goto fts3_init_out;
  142849. /* If this is an xCreate call, create the underlying tables in the
  142850. ** database. TODO: For xConnect(), it could verify that said tables exist.
  142851. */
  142852. if( isCreate ){
  142853. rc = fts3CreateTables(p);
  142854. }
  142855. /* Check to see if a legacy fts3 table has been "upgraded" by the
  142856. ** addition of a %_stat table so that it can use incremental merge.
  142857. */
  142858. if( !isFts4 && !isCreate ){
  142859. p->bHasStat = 2;
  142860. }
  142861. /* Figure out the page-size for the database. This is required in order to
  142862. ** estimate the cost of loading large doclists from the database. */
  142863. fts3DatabasePageSize(&rc, p);
  142864. p->nNodeSize = p->nPgsz-35;
  142865. /* Declare the table schema to SQLite. */
  142866. fts3DeclareVtab(&rc, p);
  142867. fts3_init_out:
  142868. sqlite3_free(zPrefix);
  142869. sqlite3_free(aIndex);
  142870. sqlite3_free(zCompress);
  142871. sqlite3_free(zUncompress);
  142872. sqlite3_free(zContent);
  142873. sqlite3_free(zLanguageid);
  142874. for(i=0; i<nNotindexed; i++) sqlite3_free(azNotindexed[i]);
  142875. sqlite3_free((void *)aCol);
  142876. sqlite3_free((void *)azNotindexed);
  142877. if( rc!=SQLITE_OK ){
  142878. if( p ){
  142879. fts3DisconnectMethod((sqlite3_vtab *)p);
  142880. }else if( pTokenizer ){
  142881. pTokenizer->pModule->xDestroy(pTokenizer);
  142882. }
  142883. }else{
  142884. assert( p->pSegments==0 );
  142885. *ppVTab = &p->base;
  142886. }
  142887. return rc;
  142888. }
  142889. /*
  142890. ** The xConnect() and xCreate() methods for the virtual table. All the
  142891. ** work is done in function fts3InitVtab().
  142892. */
  142893. static int fts3ConnectMethod(
  142894. sqlite3 *db, /* Database connection */
  142895. void *pAux, /* Pointer to tokenizer hash table */
  142896. int argc, /* Number of elements in argv array */
  142897. const char * const *argv, /* xCreate/xConnect argument array */
  142898. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  142899. char **pzErr /* OUT: sqlite3_malloc'd error message */
  142900. ){
  142901. return fts3InitVtab(0, db, pAux, argc, argv, ppVtab, pzErr);
  142902. }
  142903. static int fts3CreateMethod(
  142904. sqlite3 *db, /* Database connection */
  142905. void *pAux, /* Pointer to tokenizer hash table */
  142906. int argc, /* Number of elements in argv array */
  142907. const char * const *argv, /* xCreate/xConnect argument array */
  142908. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  142909. char **pzErr /* OUT: sqlite3_malloc'd error message */
  142910. ){
  142911. return fts3InitVtab(1, db, pAux, argc, argv, ppVtab, pzErr);
  142912. }
  142913. /*
  142914. ** Set the pIdxInfo->estimatedRows variable to nRow. Unless this
  142915. ** extension is currently being used by a version of SQLite too old to
  142916. ** support estimatedRows. In that case this function is a no-op.
  142917. */
  142918. static void fts3SetEstimatedRows(sqlite3_index_info *pIdxInfo, i64 nRow){
  142919. #if SQLITE_VERSION_NUMBER>=3008002
  142920. if( sqlite3_libversion_number()>=3008002 ){
  142921. pIdxInfo->estimatedRows = nRow;
  142922. }
  142923. #endif
  142924. }
  142925. /*
  142926. ** Set the SQLITE_INDEX_SCAN_UNIQUE flag in pIdxInfo->flags. Unless this
  142927. ** extension is currently being used by a version of SQLite too old to
  142928. ** support index-info flags. In that case this function is a no-op.
  142929. */
  142930. static void fts3SetUniqueFlag(sqlite3_index_info *pIdxInfo){
  142931. #if SQLITE_VERSION_NUMBER>=3008012
  142932. if( sqlite3_libversion_number()>=3008012 ){
  142933. pIdxInfo->idxFlags |= SQLITE_INDEX_SCAN_UNIQUE;
  142934. }
  142935. #endif
  142936. }
  142937. /*
  142938. ** Implementation of the xBestIndex method for FTS3 tables. There
  142939. ** are three possible strategies, in order of preference:
  142940. **
  142941. ** 1. Direct lookup by rowid or docid.
  142942. ** 2. Full-text search using a MATCH operator on a non-docid column.
  142943. ** 3. Linear scan of %_content table.
  142944. */
  142945. static int fts3BestIndexMethod(sqlite3_vtab *pVTab, sqlite3_index_info *pInfo){
  142946. Fts3Table *p = (Fts3Table *)pVTab;
  142947. int i; /* Iterator variable */
  142948. int iCons = -1; /* Index of constraint to use */
  142949. int iLangidCons = -1; /* Index of langid=x constraint, if present */
  142950. int iDocidGe = -1; /* Index of docid>=x constraint, if present */
  142951. int iDocidLe = -1; /* Index of docid<=x constraint, if present */
  142952. int iIdx;
  142953. /* By default use a full table scan. This is an expensive option,
  142954. ** so search through the constraints to see if a more efficient
  142955. ** strategy is possible.
  142956. */
  142957. pInfo->idxNum = FTS3_FULLSCAN_SEARCH;
  142958. pInfo->estimatedCost = 5000000;
  142959. for(i=0; i<pInfo->nConstraint; i++){
  142960. int bDocid; /* True if this constraint is on docid */
  142961. struct sqlite3_index_constraint *pCons = &pInfo->aConstraint[i];
  142962. if( pCons->usable==0 ){
  142963. if( pCons->op==SQLITE_INDEX_CONSTRAINT_MATCH ){
  142964. /* There exists an unusable MATCH constraint. This means that if
  142965. ** the planner does elect to use the results of this call as part
  142966. ** of the overall query plan the user will see an "unable to use
  142967. ** function MATCH in the requested context" error. To discourage
  142968. ** this, return a very high cost here. */
  142969. pInfo->idxNum = FTS3_FULLSCAN_SEARCH;
  142970. pInfo->estimatedCost = 1e50;
  142971. fts3SetEstimatedRows(pInfo, ((sqlite3_int64)1) << 50);
  142972. return SQLITE_OK;
  142973. }
  142974. continue;
  142975. }
  142976. bDocid = (pCons->iColumn<0 || pCons->iColumn==p->nColumn+1);
  142977. /* A direct lookup on the rowid or docid column. Assign a cost of 1.0. */
  142978. if( iCons<0 && pCons->op==SQLITE_INDEX_CONSTRAINT_EQ && bDocid ){
  142979. pInfo->idxNum = FTS3_DOCID_SEARCH;
  142980. pInfo->estimatedCost = 1.0;
  142981. iCons = i;
  142982. }
  142983. /* A MATCH constraint. Use a full-text search.
  142984. **
  142985. ** If there is more than one MATCH constraint available, use the first
  142986. ** one encountered. If there is both a MATCH constraint and a direct
  142987. ** rowid/docid lookup, prefer the MATCH strategy. This is done even
  142988. ** though the rowid/docid lookup is faster than a MATCH query, selecting
  142989. ** it would lead to an "unable to use function MATCH in the requested
  142990. ** context" error.
  142991. */
  142992. if( pCons->op==SQLITE_INDEX_CONSTRAINT_MATCH
  142993. && pCons->iColumn>=0 && pCons->iColumn<=p->nColumn
  142994. ){
  142995. pInfo->idxNum = FTS3_FULLTEXT_SEARCH + pCons->iColumn;
  142996. pInfo->estimatedCost = 2.0;
  142997. iCons = i;
  142998. }
  142999. /* Equality constraint on the langid column */
  143000. if( pCons->op==SQLITE_INDEX_CONSTRAINT_EQ
  143001. && pCons->iColumn==p->nColumn + 2
  143002. ){
  143003. iLangidCons = i;
  143004. }
  143005. if( bDocid ){
  143006. switch( pCons->op ){
  143007. case SQLITE_INDEX_CONSTRAINT_GE:
  143008. case SQLITE_INDEX_CONSTRAINT_GT:
  143009. iDocidGe = i;
  143010. break;
  143011. case SQLITE_INDEX_CONSTRAINT_LE:
  143012. case SQLITE_INDEX_CONSTRAINT_LT:
  143013. iDocidLe = i;
  143014. break;
  143015. }
  143016. }
  143017. }
  143018. /* If using a docid=? or rowid=? strategy, set the UNIQUE flag. */
  143019. if( pInfo->idxNum==FTS3_DOCID_SEARCH ) fts3SetUniqueFlag(pInfo);
  143020. iIdx = 1;
  143021. if( iCons>=0 ){
  143022. pInfo->aConstraintUsage[iCons].argvIndex = iIdx++;
  143023. pInfo->aConstraintUsage[iCons].omit = 1;
  143024. }
  143025. if( iLangidCons>=0 ){
  143026. pInfo->idxNum |= FTS3_HAVE_LANGID;
  143027. pInfo->aConstraintUsage[iLangidCons].argvIndex = iIdx++;
  143028. }
  143029. if( iDocidGe>=0 ){
  143030. pInfo->idxNum |= FTS3_HAVE_DOCID_GE;
  143031. pInfo->aConstraintUsage[iDocidGe].argvIndex = iIdx++;
  143032. }
  143033. if( iDocidLe>=0 ){
  143034. pInfo->idxNum |= FTS3_HAVE_DOCID_LE;
  143035. pInfo->aConstraintUsage[iDocidLe].argvIndex = iIdx++;
  143036. }
  143037. /* Regardless of the strategy selected, FTS can deliver rows in rowid (or
  143038. ** docid) order. Both ascending and descending are possible.
  143039. */
  143040. if( pInfo->nOrderBy==1 ){
  143041. struct sqlite3_index_orderby *pOrder = &pInfo->aOrderBy[0];
  143042. if( pOrder->iColumn<0 || pOrder->iColumn==p->nColumn+1 ){
  143043. if( pOrder->desc ){
  143044. pInfo->idxStr = "DESC";
  143045. }else{
  143046. pInfo->idxStr = "ASC";
  143047. }
  143048. pInfo->orderByConsumed = 1;
  143049. }
  143050. }
  143051. assert( p->pSegments==0 );
  143052. return SQLITE_OK;
  143053. }
  143054. /*
  143055. ** Implementation of xOpen method.
  143056. */
  143057. static int fts3OpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  143058. sqlite3_vtab_cursor *pCsr; /* Allocated cursor */
  143059. UNUSED_PARAMETER(pVTab);
  143060. /* Allocate a buffer large enough for an Fts3Cursor structure. If the
  143061. ** allocation succeeds, zero it and return SQLITE_OK. Otherwise,
  143062. ** if the allocation fails, return SQLITE_NOMEM.
  143063. */
  143064. *ppCsr = pCsr = (sqlite3_vtab_cursor *)sqlite3_malloc(sizeof(Fts3Cursor));
  143065. if( !pCsr ){
  143066. return SQLITE_NOMEM;
  143067. }
  143068. memset(pCsr, 0, sizeof(Fts3Cursor));
  143069. return SQLITE_OK;
  143070. }
  143071. /*
  143072. ** Finalize the statement handle at pCsr->pStmt.
  143073. **
  143074. ** Or, if that statement handle is one created by fts3CursorSeekStmt(),
  143075. ** and the Fts3Table.pSeekStmt slot is currently NULL, save the statement
  143076. ** pointer there instead of finalizing it.
  143077. */
  143078. static void fts3CursorFinalizeStmt(Fts3Cursor *pCsr){
  143079. if( pCsr->bSeekStmt ){
  143080. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  143081. if( p->pSeekStmt==0 ){
  143082. p->pSeekStmt = pCsr->pStmt;
  143083. sqlite3_reset(pCsr->pStmt);
  143084. pCsr->pStmt = 0;
  143085. }
  143086. pCsr->bSeekStmt = 0;
  143087. }
  143088. sqlite3_finalize(pCsr->pStmt);
  143089. }
  143090. /*
  143091. ** Free all resources currently held by the cursor passed as the only
  143092. ** argument.
  143093. */
  143094. static void fts3ClearCursor(Fts3Cursor *pCsr){
  143095. fts3CursorFinalizeStmt(pCsr);
  143096. sqlite3Fts3FreeDeferredTokens(pCsr);
  143097. sqlite3_free(pCsr->aDoclist);
  143098. sqlite3Fts3MIBufferFree(pCsr->pMIBuffer);
  143099. sqlite3Fts3ExprFree(pCsr->pExpr);
  143100. memset(&(&pCsr->base)[1], 0, sizeof(Fts3Cursor)-sizeof(sqlite3_vtab_cursor));
  143101. }
  143102. /*
  143103. ** Close the cursor. For additional information see the documentation
  143104. ** on the xClose method of the virtual table interface.
  143105. */
  143106. static int fts3CloseMethod(sqlite3_vtab_cursor *pCursor){
  143107. Fts3Cursor *pCsr = (Fts3Cursor *)pCursor;
  143108. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  143109. fts3ClearCursor(pCsr);
  143110. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  143111. sqlite3_free(pCsr);
  143112. return SQLITE_OK;
  143113. }
  143114. /*
  143115. ** If pCsr->pStmt has not been prepared (i.e. if pCsr->pStmt==0), then
  143116. ** compose and prepare an SQL statement of the form:
  143117. **
  143118. ** "SELECT <columns> FROM %_content WHERE rowid = ?"
  143119. **
  143120. ** (or the equivalent for a content=xxx table) and set pCsr->pStmt to
  143121. ** it. If an error occurs, return an SQLite error code.
  143122. */
  143123. static int fts3CursorSeekStmt(Fts3Cursor *pCsr){
  143124. int rc = SQLITE_OK;
  143125. if( pCsr->pStmt==0 ){
  143126. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  143127. char *zSql;
  143128. if( p->pSeekStmt ){
  143129. pCsr->pStmt = p->pSeekStmt;
  143130. p->pSeekStmt = 0;
  143131. }else{
  143132. zSql = sqlite3_mprintf("SELECT %s WHERE rowid = ?", p->zReadExprlist);
  143133. if( !zSql ) return SQLITE_NOMEM;
  143134. rc = sqlite3_prepare_v3(p->db, zSql,-1,SQLITE_PREPARE_PERSISTENT,&pCsr->pStmt,0);
  143135. sqlite3_free(zSql);
  143136. }
  143137. if( rc==SQLITE_OK ) pCsr->bSeekStmt = 1;
  143138. }
  143139. return rc;
  143140. }
  143141. /*
  143142. ** Position the pCsr->pStmt statement so that it is on the row
  143143. ** of the %_content table that contains the last match. Return
  143144. ** SQLITE_OK on success.
  143145. */
  143146. static int fts3CursorSeek(sqlite3_context *pContext, Fts3Cursor *pCsr){
  143147. int rc = SQLITE_OK;
  143148. if( pCsr->isRequireSeek ){
  143149. rc = fts3CursorSeekStmt(pCsr);
  143150. if( rc==SQLITE_OK ){
  143151. sqlite3_bind_int64(pCsr->pStmt, 1, pCsr->iPrevId);
  143152. pCsr->isRequireSeek = 0;
  143153. if( SQLITE_ROW==sqlite3_step(pCsr->pStmt) ){
  143154. return SQLITE_OK;
  143155. }else{
  143156. rc = sqlite3_reset(pCsr->pStmt);
  143157. if( rc==SQLITE_OK && ((Fts3Table *)pCsr->base.pVtab)->zContentTbl==0 ){
  143158. /* If no row was found and no error has occurred, then the %_content
  143159. ** table is missing a row that is present in the full-text index.
  143160. ** The data structures are corrupt. */
  143161. rc = FTS_CORRUPT_VTAB;
  143162. pCsr->isEof = 1;
  143163. }
  143164. }
  143165. }
  143166. }
  143167. if( rc!=SQLITE_OK && pContext ){
  143168. sqlite3_result_error_code(pContext, rc);
  143169. }
  143170. return rc;
  143171. }
  143172. /*
  143173. ** This function is used to process a single interior node when searching
  143174. ** a b-tree for a term or term prefix. The node data is passed to this
  143175. ** function via the zNode/nNode parameters. The term to search for is
  143176. ** passed in zTerm/nTerm.
  143177. **
  143178. ** If piFirst is not NULL, then this function sets *piFirst to the blockid
  143179. ** of the child node that heads the sub-tree that may contain the term.
  143180. **
  143181. ** If piLast is not NULL, then *piLast is set to the right-most child node
  143182. ** that heads a sub-tree that may contain a term for which zTerm/nTerm is
  143183. ** a prefix.
  143184. **
  143185. ** If an OOM error occurs, SQLITE_NOMEM is returned. Otherwise, SQLITE_OK.
  143186. */
  143187. static int fts3ScanInteriorNode(
  143188. const char *zTerm, /* Term to select leaves for */
  143189. int nTerm, /* Size of term zTerm in bytes */
  143190. const char *zNode, /* Buffer containing segment interior node */
  143191. int nNode, /* Size of buffer at zNode */
  143192. sqlite3_int64 *piFirst, /* OUT: Selected child node */
  143193. sqlite3_int64 *piLast /* OUT: Selected child node */
  143194. ){
  143195. int rc = SQLITE_OK; /* Return code */
  143196. const char *zCsr = zNode; /* Cursor to iterate through node */
  143197. const char *zEnd = &zCsr[nNode];/* End of interior node buffer */
  143198. char *zBuffer = 0; /* Buffer to load terms into */
  143199. int nAlloc = 0; /* Size of allocated buffer */
  143200. int isFirstTerm = 1; /* True when processing first term on page */
  143201. sqlite3_int64 iChild; /* Block id of child node to descend to */
  143202. /* Skip over the 'height' varint that occurs at the start of every
  143203. ** interior node. Then load the blockid of the left-child of the b-tree
  143204. ** node into variable iChild.
  143205. **
  143206. ** Even if the data structure on disk is corrupted, this (reading two
  143207. ** varints from the buffer) does not risk an overread. If zNode is a
  143208. ** root node, then the buffer comes from a SELECT statement. SQLite does
  143209. ** not make this guarantee explicitly, but in practice there are always
  143210. ** either more than 20 bytes of allocated space following the nNode bytes of
  143211. ** contents, or two zero bytes. Or, if the node is read from the %_segments
  143212. ** table, then there are always 20 bytes of zeroed padding following the
  143213. ** nNode bytes of content (see sqlite3Fts3ReadBlock() for details).
  143214. */
  143215. zCsr += sqlite3Fts3GetVarint(zCsr, &iChild);
  143216. zCsr += sqlite3Fts3GetVarint(zCsr, &iChild);
  143217. if( zCsr>zEnd ){
  143218. return FTS_CORRUPT_VTAB;
  143219. }
  143220. while( zCsr<zEnd && (piFirst || piLast) ){
  143221. int cmp; /* memcmp() result */
  143222. int nSuffix; /* Size of term suffix */
  143223. int nPrefix = 0; /* Size of term prefix */
  143224. int nBuffer; /* Total term size */
  143225. /* Load the next term on the node into zBuffer. Use realloc() to expand
  143226. ** the size of zBuffer if required. */
  143227. if( !isFirstTerm ){
  143228. zCsr += fts3GetVarint32(zCsr, &nPrefix);
  143229. }
  143230. isFirstTerm = 0;
  143231. zCsr += fts3GetVarint32(zCsr, &nSuffix);
  143232. assert( nPrefix>=0 && nSuffix>=0 );
  143233. if( &zCsr[nSuffix]>zEnd ){
  143234. rc = FTS_CORRUPT_VTAB;
  143235. goto finish_scan;
  143236. }
  143237. if( nPrefix+nSuffix>nAlloc ){
  143238. char *zNew;
  143239. nAlloc = (nPrefix+nSuffix) * 2;
  143240. zNew = (char *)sqlite3_realloc(zBuffer, nAlloc);
  143241. if( !zNew ){
  143242. rc = SQLITE_NOMEM;
  143243. goto finish_scan;
  143244. }
  143245. zBuffer = zNew;
  143246. }
  143247. assert( zBuffer );
  143248. memcpy(&zBuffer[nPrefix], zCsr, nSuffix);
  143249. nBuffer = nPrefix + nSuffix;
  143250. zCsr += nSuffix;
  143251. /* Compare the term we are searching for with the term just loaded from
  143252. ** the interior node. If the specified term is greater than or equal
  143253. ** to the term from the interior node, then all terms on the sub-tree
  143254. ** headed by node iChild are smaller than zTerm. No need to search
  143255. ** iChild.
  143256. **
  143257. ** If the interior node term is larger than the specified term, then
  143258. ** the tree headed by iChild may contain the specified term.
  143259. */
  143260. cmp = memcmp(zTerm, zBuffer, (nBuffer>nTerm ? nTerm : nBuffer));
  143261. if( piFirst && (cmp<0 || (cmp==0 && nBuffer>nTerm)) ){
  143262. *piFirst = iChild;
  143263. piFirst = 0;
  143264. }
  143265. if( piLast && cmp<0 ){
  143266. *piLast = iChild;
  143267. piLast = 0;
  143268. }
  143269. iChild++;
  143270. };
  143271. if( piFirst ) *piFirst = iChild;
  143272. if( piLast ) *piLast = iChild;
  143273. finish_scan:
  143274. sqlite3_free(zBuffer);
  143275. return rc;
  143276. }
  143277. /*
  143278. ** The buffer pointed to by argument zNode (size nNode bytes) contains an
  143279. ** interior node of a b-tree segment. The zTerm buffer (size nTerm bytes)
  143280. ** contains a term. This function searches the sub-tree headed by the zNode
  143281. ** node for the range of leaf nodes that may contain the specified term
  143282. ** or terms for which the specified term is a prefix.
  143283. **
  143284. ** If piLeaf is not NULL, then *piLeaf is set to the blockid of the
  143285. ** left-most leaf node in the tree that may contain the specified term.
  143286. ** If piLeaf2 is not NULL, then *piLeaf2 is set to the blockid of the
  143287. ** right-most leaf node that may contain a term for which the specified
  143288. ** term is a prefix.
  143289. **
  143290. ** It is possible that the range of returned leaf nodes does not contain
  143291. ** the specified term or any terms for which it is a prefix. However, if the
  143292. ** segment does contain any such terms, they are stored within the identified
  143293. ** range. Because this function only inspects interior segment nodes (and
  143294. ** never loads leaf nodes into memory), it is not possible to be sure.
  143295. **
  143296. ** If an error occurs, an error code other than SQLITE_OK is returned.
  143297. */
  143298. static int fts3SelectLeaf(
  143299. Fts3Table *p, /* Virtual table handle */
  143300. const char *zTerm, /* Term to select leaves for */
  143301. int nTerm, /* Size of term zTerm in bytes */
  143302. const char *zNode, /* Buffer containing segment interior node */
  143303. int nNode, /* Size of buffer at zNode */
  143304. sqlite3_int64 *piLeaf, /* Selected leaf node */
  143305. sqlite3_int64 *piLeaf2 /* Selected leaf node */
  143306. ){
  143307. int rc = SQLITE_OK; /* Return code */
  143308. int iHeight; /* Height of this node in tree */
  143309. assert( piLeaf || piLeaf2 );
  143310. fts3GetVarint32(zNode, &iHeight);
  143311. rc = fts3ScanInteriorNode(zTerm, nTerm, zNode, nNode, piLeaf, piLeaf2);
  143312. assert( !piLeaf2 || !piLeaf || rc!=SQLITE_OK || (*piLeaf<=*piLeaf2) );
  143313. if( rc==SQLITE_OK && iHeight>1 ){
  143314. char *zBlob = 0; /* Blob read from %_segments table */
  143315. int nBlob = 0; /* Size of zBlob in bytes */
  143316. if( piLeaf && piLeaf2 && (*piLeaf!=*piLeaf2) ){
  143317. rc = sqlite3Fts3ReadBlock(p, *piLeaf, &zBlob, &nBlob, 0);
  143318. if( rc==SQLITE_OK ){
  143319. rc = fts3SelectLeaf(p, zTerm, nTerm, zBlob, nBlob, piLeaf, 0);
  143320. }
  143321. sqlite3_free(zBlob);
  143322. piLeaf = 0;
  143323. zBlob = 0;
  143324. }
  143325. if( rc==SQLITE_OK ){
  143326. rc = sqlite3Fts3ReadBlock(p, piLeaf?*piLeaf:*piLeaf2, &zBlob, &nBlob, 0);
  143327. }
  143328. if( rc==SQLITE_OK ){
  143329. rc = fts3SelectLeaf(p, zTerm, nTerm, zBlob, nBlob, piLeaf, piLeaf2);
  143330. }
  143331. sqlite3_free(zBlob);
  143332. }
  143333. return rc;
  143334. }
  143335. /*
  143336. ** This function is used to create delta-encoded serialized lists of FTS3
  143337. ** varints. Each call to this function appends a single varint to a list.
  143338. */
  143339. static void fts3PutDeltaVarint(
  143340. char **pp, /* IN/OUT: Output pointer */
  143341. sqlite3_int64 *piPrev, /* IN/OUT: Previous value written to list */
  143342. sqlite3_int64 iVal /* Write this value to the list */
  143343. ){
  143344. assert( iVal-*piPrev > 0 || (*piPrev==0 && iVal==0) );
  143345. *pp += sqlite3Fts3PutVarint(*pp, iVal-*piPrev);
  143346. *piPrev = iVal;
  143347. }
  143348. /*
  143349. ** When this function is called, *ppPoslist is assumed to point to the
  143350. ** start of a position-list. After it returns, *ppPoslist points to the
  143351. ** first byte after the position-list.
  143352. **
  143353. ** A position list is list of positions (delta encoded) and columns for
  143354. ** a single document record of a doclist. So, in other words, this
  143355. ** routine advances *ppPoslist so that it points to the next docid in
  143356. ** the doclist, or to the first byte past the end of the doclist.
  143357. **
  143358. ** If pp is not NULL, then the contents of the position list are copied
  143359. ** to *pp. *pp is set to point to the first byte past the last byte copied
  143360. ** before this function returns.
  143361. */
  143362. static void fts3PoslistCopy(char **pp, char **ppPoslist){
  143363. char *pEnd = *ppPoslist;
  143364. char c = 0;
  143365. /* The end of a position list is marked by a zero encoded as an FTS3
  143366. ** varint. A single POS_END (0) byte. Except, if the 0 byte is preceded by
  143367. ** a byte with the 0x80 bit set, then it is not a varint 0, but the tail
  143368. ** of some other, multi-byte, value.
  143369. **
  143370. ** The following while-loop moves pEnd to point to the first byte that is not
  143371. ** immediately preceded by a byte with the 0x80 bit set. Then increments
  143372. ** pEnd once more so that it points to the byte immediately following the
  143373. ** last byte in the position-list.
  143374. */
  143375. while( *pEnd | c ){
  143376. c = *pEnd++ & 0x80;
  143377. testcase( c!=0 && (*pEnd)==0 );
  143378. }
  143379. pEnd++; /* Advance past the POS_END terminator byte */
  143380. if( pp ){
  143381. int n = (int)(pEnd - *ppPoslist);
  143382. char *p = *pp;
  143383. memcpy(p, *ppPoslist, n);
  143384. p += n;
  143385. *pp = p;
  143386. }
  143387. *ppPoslist = pEnd;
  143388. }
  143389. /*
  143390. ** When this function is called, *ppPoslist is assumed to point to the
  143391. ** start of a column-list. After it returns, *ppPoslist points to the
  143392. ** to the terminator (POS_COLUMN or POS_END) byte of the column-list.
  143393. **
  143394. ** A column-list is list of delta-encoded positions for a single column
  143395. ** within a single document within a doclist.
  143396. **
  143397. ** The column-list is terminated either by a POS_COLUMN varint (1) or
  143398. ** a POS_END varint (0). This routine leaves *ppPoslist pointing to
  143399. ** the POS_COLUMN or POS_END that terminates the column-list.
  143400. **
  143401. ** If pp is not NULL, then the contents of the column-list are copied
  143402. ** to *pp. *pp is set to point to the first byte past the last byte copied
  143403. ** before this function returns. The POS_COLUMN or POS_END terminator
  143404. ** is not copied into *pp.
  143405. */
  143406. static void fts3ColumnlistCopy(char **pp, char **ppPoslist){
  143407. char *pEnd = *ppPoslist;
  143408. char c = 0;
  143409. /* A column-list is terminated by either a 0x01 or 0x00 byte that is
  143410. ** not part of a multi-byte varint.
  143411. */
  143412. while( 0xFE & (*pEnd | c) ){
  143413. c = *pEnd++ & 0x80;
  143414. testcase( c!=0 && ((*pEnd)&0xfe)==0 );
  143415. }
  143416. if( pp ){
  143417. int n = (int)(pEnd - *ppPoslist);
  143418. char *p = *pp;
  143419. memcpy(p, *ppPoslist, n);
  143420. p += n;
  143421. *pp = p;
  143422. }
  143423. *ppPoslist = pEnd;
  143424. }
  143425. /*
  143426. ** Value used to signify the end of an position-list. This is safe because
  143427. ** it is not possible to have a document with 2^31 terms.
  143428. */
  143429. #define POSITION_LIST_END 0x7fffffff
  143430. /*
  143431. ** This function is used to help parse position-lists. When this function is
  143432. ** called, *pp may point to the start of the next varint in the position-list
  143433. ** being parsed, or it may point to 1 byte past the end of the position-list
  143434. ** (in which case **pp will be a terminator bytes POS_END (0) or
  143435. ** (1)).
  143436. **
  143437. ** If *pp points past the end of the current position-list, set *pi to
  143438. ** POSITION_LIST_END and return. Otherwise, read the next varint from *pp,
  143439. ** increment the current value of *pi by the value read, and set *pp to
  143440. ** point to the next value before returning.
  143441. **
  143442. ** Before calling this routine *pi must be initialized to the value of
  143443. ** the previous position, or zero if we are reading the first position
  143444. ** in the position-list. Because positions are delta-encoded, the value
  143445. ** of the previous position is needed in order to compute the value of
  143446. ** the next position.
  143447. */
  143448. static void fts3ReadNextPos(
  143449. char **pp, /* IN/OUT: Pointer into position-list buffer */
  143450. sqlite3_int64 *pi /* IN/OUT: Value read from position-list */
  143451. ){
  143452. if( (**pp)&0xFE ){
  143453. fts3GetDeltaVarint(pp, pi);
  143454. *pi -= 2;
  143455. }else{
  143456. *pi = POSITION_LIST_END;
  143457. }
  143458. }
  143459. /*
  143460. ** If parameter iCol is not 0, write an POS_COLUMN (1) byte followed by
  143461. ** the value of iCol encoded as a varint to *pp. This will start a new
  143462. ** column list.
  143463. **
  143464. ** Set *pp to point to the byte just after the last byte written before
  143465. ** returning (do not modify it if iCol==0). Return the total number of bytes
  143466. ** written (0 if iCol==0).
  143467. */
  143468. static int fts3PutColNumber(char **pp, int iCol){
  143469. int n = 0; /* Number of bytes written */
  143470. if( iCol ){
  143471. char *p = *pp; /* Output pointer */
  143472. n = 1 + sqlite3Fts3PutVarint(&p[1], iCol);
  143473. *p = 0x01;
  143474. *pp = &p[n];
  143475. }
  143476. return n;
  143477. }
  143478. /*
  143479. ** Compute the union of two position lists. The output written
  143480. ** into *pp contains all positions of both *pp1 and *pp2 in sorted
  143481. ** order and with any duplicates removed. All pointers are
  143482. ** updated appropriately. The caller is responsible for insuring
  143483. ** that there is enough space in *pp to hold the complete output.
  143484. */
  143485. static void fts3PoslistMerge(
  143486. char **pp, /* Output buffer */
  143487. char **pp1, /* Left input list */
  143488. char **pp2 /* Right input list */
  143489. ){
  143490. char *p = *pp;
  143491. char *p1 = *pp1;
  143492. char *p2 = *pp2;
  143493. while( *p1 || *p2 ){
  143494. int iCol1; /* The current column index in pp1 */
  143495. int iCol2; /* The current column index in pp2 */
  143496. if( *p1==POS_COLUMN ) fts3GetVarint32(&p1[1], &iCol1);
  143497. else if( *p1==POS_END ) iCol1 = POSITION_LIST_END;
  143498. else iCol1 = 0;
  143499. if( *p2==POS_COLUMN ) fts3GetVarint32(&p2[1], &iCol2);
  143500. else if( *p2==POS_END ) iCol2 = POSITION_LIST_END;
  143501. else iCol2 = 0;
  143502. if( iCol1==iCol2 ){
  143503. sqlite3_int64 i1 = 0; /* Last position from pp1 */
  143504. sqlite3_int64 i2 = 0; /* Last position from pp2 */
  143505. sqlite3_int64 iPrev = 0;
  143506. int n = fts3PutColNumber(&p, iCol1);
  143507. p1 += n;
  143508. p2 += n;
  143509. /* At this point, both p1 and p2 point to the start of column-lists
  143510. ** for the same column (the column with index iCol1 and iCol2).
  143511. ** A column-list is a list of non-negative delta-encoded varints, each
  143512. ** incremented by 2 before being stored. Each list is terminated by a
  143513. ** POS_END (0) or POS_COLUMN (1). The following block merges the two lists
  143514. ** and writes the results to buffer p. p is left pointing to the byte
  143515. ** after the list written. No terminator (POS_END or POS_COLUMN) is
  143516. ** written to the output.
  143517. */
  143518. fts3GetDeltaVarint(&p1, &i1);
  143519. fts3GetDeltaVarint(&p2, &i2);
  143520. do {
  143521. fts3PutDeltaVarint(&p, &iPrev, (i1<i2) ? i1 : i2);
  143522. iPrev -= 2;
  143523. if( i1==i2 ){
  143524. fts3ReadNextPos(&p1, &i1);
  143525. fts3ReadNextPos(&p2, &i2);
  143526. }else if( i1<i2 ){
  143527. fts3ReadNextPos(&p1, &i1);
  143528. }else{
  143529. fts3ReadNextPos(&p2, &i2);
  143530. }
  143531. }while( i1!=POSITION_LIST_END || i2!=POSITION_LIST_END );
  143532. }else if( iCol1<iCol2 ){
  143533. p1 += fts3PutColNumber(&p, iCol1);
  143534. fts3ColumnlistCopy(&p, &p1);
  143535. }else{
  143536. p2 += fts3PutColNumber(&p, iCol2);
  143537. fts3ColumnlistCopy(&p, &p2);
  143538. }
  143539. }
  143540. *p++ = POS_END;
  143541. *pp = p;
  143542. *pp1 = p1 + 1;
  143543. *pp2 = p2 + 1;
  143544. }
  143545. /*
  143546. ** This function is used to merge two position lists into one. When it is
  143547. ** called, *pp1 and *pp2 must both point to position lists. A position-list is
  143548. ** the part of a doclist that follows each document id. For example, if a row
  143549. ** contains:
  143550. **
  143551. ** 'a b c'|'x y z'|'a b b a'
  143552. **
  143553. ** Then the position list for this row for token 'b' would consist of:
  143554. **
  143555. ** 0x02 0x01 0x02 0x03 0x03 0x00
  143556. **
  143557. ** When this function returns, both *pp1 and *pp2 are left pointing to the
  143558. ** byte following the 0x00 terminator of their respective position lists.
  143559. **
  143560. ** If isSaveLeft is 0, an entry is added to the output position list for
  143561. ** each position in *pp2 for which there exists one or more positions in
  143562. ** *pp1 so that (pos(*pp2)>pos(*pp1) && pos(*pp2)-pos(*pp1)<=nToken). i.e.
  143563. ** when the *pp1 token appears before the *pp2 token, but not more than nToken
  143564. ** slots before it.
  143565. **
  143566. ** e.g. nToken==1 searches for adjacent positions.
  143567. */
  143568. static int fts3PoslistPhraseMerge(
  143569. char **pp, /* IN/OUT: Preallocated output buffer */
  143570. int nToken, /* Maximum difference in token positions */
  143571. int isSaveLeft, /* Save the left position */
  143572. int isExact, /* If *pp1 is exactly nTokens before *pp2 */
  143573. char **pp1, /* IN/OUT: Left input list */
  143574. char **pp2 /* IN/OUT: Right input list */
  143575. ){
  143576. char *p = *pp;
  143577. char *p1 = *pp1;
  143578. char *p2 = *pp2;
  143579. int iCol1 = 0;
  143580. int iCol2 = 0;
  143581. /* Never set both isSaveLeft and isExact for the same invocation. */
  143582. assert( isSaveLeft==0 || isExact==0 );
  143583. assert( p!=0 && *p1!=0 && *p2!=0 );
  143584. if( *p1==POS_COLUMN ){
  143585. p1++;
  143586. p1 += fts3GetVarint32(p1, &iCol1);
  143587. }
  143588. if( *p2==POS_COLUMN ){
  143589. p2++;
  143590. p2 += fts3GetVarint32(p2, &iCol2);
  143591. }
  143592. while( 1 ){
  143593. if( iCol1==iCol2 ){
  143594. char *pSave = p;
  143595. sqlite3_int64 iPrev = 0;
  143596. sqlite3_int64 iPos1 = 0;
  143597. sqlite3_int64 iPos2 = 0;
  143598. if( iCol1 ){
  143599. *p++ = POS_COLUMN;
  143600. p += sqlite3Fts3PutVarint(p, iCol1);
  143601. }
  143602. assert( *p1!=POS_END && *p1!=POS_COLUMN );
  143603. assert( *p2!=POS_END && *p2!=POS_COLUMN );
  143604. fts3GetDeltaVarint(&p1, &iPos1); iPos1 -= 2;
  143605. fts3GetDeltaVarint(&p2, &iPos2); iPos2 -= 2;
  143606. while( 1 ){
  143607. if( iPos2==iPos1+nToken
  143608. || (isExact==0 && iPos2>iPos1 && iPos2<=iPos1+nToken)
  143609. ){
  143610. sqlite3_int64 iSave;
  143611. iSave = isSaveLeft ? iPos1 : iPos2;
  143612. fts3PutDeltaVarint(&p, &iPrev, iSave+2); iPrev -= 2;
  143613. pSave = 0;
  143614. assert( p );
  143615. }
  143616. if( (!isSaveLeft && iPos2<=(iPos1+nToken)) || iPos2<=iPos1 ){
  143617. if( (*p2&0xFE)==0 ) break;
  143618. fts3GetDeltaVarint(&p2, &iPos2); iPos2 -= 2;
  143619. }else{
  143620. if( (*p1&0xFE)==0 ) break;
  143621. fts3GetDeltaVarint(&p1, &iPos1); iPos1 -= 2;
  143622. }
  143623. }
  143624. if( pSave ){
  143625. assert( pp && p );
  143626. p = pSave;
  143627. }
  143628. fts3ColumnlistCopy(0, &p1);
  143629. fts3ColumnlistCopy(0, &p2);
  143630. assert( (*p1&0xFE)==0 && (*p2&0xFE)==0 );
  143631. if( 0==*p1 || 0==*p2 ) break;
  143632. p1++;
  143633. p1 += fts3GetVarint32(p1, &iCol1);
  143634. p2++;
  143635. p2 += fts3GetVarint32(p2, &iCol2);
  143636. }
  143637. /* Advance pointer p1 or p2 (whichever corresponds to the smaller of
  143638. ** iCol1 and iCol2) so that it points to either the 0x00 that marks the
  143639. ** end of the position list, or the 0x01 that precedes the next
  143640. ** column-number in the position list.
  143641. */
  143642. else if( iCol1<iCol2 ){
  143643. fts3ColumnlistCopy(0, &p1);
  143644. if( 0==*p1 ) break;
  143645. p1++;
  143646. p1 += fts3GetVarint32(p1, &iCol1);
  143647. }else{
  143648. fts3ColumnlistCopy(0, &p2);
  143649. if( 0==*p2 ) break;
  143650. p2++;
  143651. p2 += fts3GetVarint32(p2, &iCol2);
  143652. }
  143653. }
  143654. fts3PoslistCopy(0, &p2);
  143655. fts3PoslistCopy(0, &p1);
  143656. *pp1 = p1;
  143657. *pp2 = p2;
  143658. if( *pp==p ){
  143659. return 0;
  143660. }
  143661. *p++ = 0x00;
  143662. *pp = p;
  143663. return 1;
  143664. }
  143665. /*
  143666. ** Merge two position-lists as required by the NEAR operator. The argument
  143667. ** position lists correspond to the left and right phrases of an expression
  143668. ** like:
  143669. **
  143670. ** "phrase 1" NEAR "phrase number 2"
  143671. **
  143672. ** Position list *pp1 corresponds to the left-hand side of the NEAR
  143673. ** expression and *pp2 to the right. As usual, the indexes in the position
  143674. ** lists are the offsets of the last token in each phrase (tokens "1" and "2"
  143675. ** in the example above).
  143676. **
  143677. ** The output position list - written to *pp - is a copy of *pp2 with those
  143678. ** entries that are not sufficiently NEAR entries in *pp1 removed.
  143679. */
  143680. static int fts3PoslistNearMerge(
  143681. char **pp, /* Output buffer */
  143682. char *aTmp, /* Temporary buffer space */
  143683. int nRight, /* Maximum difference in token positions */
  143684. int nLeft, /* Maximum difference in token positions */
  143685. char **pp1, /* IN/OUT: Left input list */
  143686. char **pp2 /* IN/OUT: Right input list */
  143687. ){
  143688. char *p1 = *pp1;
  143689. char *p2 = *pp2;
  143690. char *pTmp1 = aTmp;
  143691. char *pTmp2;
  143692. char *aTmp2;
  143693. int res = 1;
  143694. fts3PoslistPhraseMerge(&pTmp1, nRight, 0, 0, pp1, pp2);
  143695. aTmp2 = pTmp2 = pTmp1;
  143696. *pp1 = p1;
  143697. *pp2 = p2;
  143698. fts3PoslistPhraseMerge(&pTmp2, nLeft, 1, 0, pp2, pp1);
  143699. if( pTmp1!=aTmp && pTmp2!=aTmp2 ){
  143700. fts3PoslistMerge(pp, &aTmp, &aTmp2);
  143701. }else if( pTmp1!=aTmp ){
  143702. fts3PoslistCopy(pp, &aTmp);
  143703. }else if( pTmp2!=aTmp2 ){
  143704. fts3PoslistCopy(pp, &aTmp2);
  143705. }else{
  143706. res = 0;
  143707. }
  143708. return res;
  143709. }
  143710. /*
  143711. ** An instance of this function is used to merge together the (potentially
  143712. ** large number of) doclists for each term that matches a prefix query.
  143713. ** See function fts3TermSelectMerge() for details.
  143714. */
  143715. typedef struct TermSelect TermSelect;
  143716. struct TermSelect {
  143717. char *aaOutput[16]; /* Malloc'd output buffers */
  143718. int anOutput[16]; /* Size each output buffer in bytes */
  143719. };
  143720. /*
  143721. ** This function is used to read a single varint from a buffer. Parameter
  143722. ** pEnd points 1 byte past the end of the buffer. When this function is
  143723. ** called, if *pp points to pEnd or greater, then the end of the buffer
  143724. ** has been reached. In this case *pp is set to 0 and the function returns.
  143725. **
  143726. ** If *pp does not point to or past pEnd, then a single varint is read
  143727. ** from *pp. *pp is then set to point 1 byte past the end of the read varint.
  143728. **
  143729. ** If bDescIdx is false, the value read is added to *pVal before returning.
  143730. ** If it is true, the value read is subtracted from *pVal before this
  143731. ** function returns.
  143732. */
  143733. static void fts3GetDeltaVarint3(
  143734. char **pp, /* IN/OUT: Point to read varint from */
  143735. char *pEnd, /* End of buffer */
  143736. int bDescIdx, /* True if docids are descending */
  143737. sqlite3_int64 *pVal /* IN/OUT: Integer value */
  143738. ){
  143739. if( *pp>=pEnd ){
  143740. *pp = 0;
  143741. }else{
  143742. sqlite3_int64 iVal;
  143743. *pp += sqlite3Fts3GetVarint(*pp, &iVal);
  143744. if( bDescIdx ){
  143745. *pVal -= iVal;
  143746. }else{
  143747. *pVal += iVal;
  143748. }
  143749. }
  143750. }
  143751. /*
  143752. ** This function is used to write a single varint to a buffer. The varint
  143753. ** is written to *pp. Before returning, *pp is set to point 1 byte past the
  143754. ** end of the value written.
  143755. **
  143756. ** If *pbFirst is zero when this function is called, the value written to
  143757. ** the buffer is that of parameter iVal.
  143758. **
  143759. ** If *pbFirst is non-zero when this function is called, then the value
  143760. ** written is either (iVal-*piPrev) (if bDescIdx is zero) or (*piPrev-iVal)
  143761. ** (if bDescIdx is non-zero).
  143762. **
  143763. ** Before returning, this function always sets *pbFirst to 1 and *piPrev
  143764. ** to the value of parameter iVal.
  143765. */
  143766. static void fts3PutDeltaVarint3(
  143767. char **pp, /* IN/OUT: Output pointer */
  143768. int bDescIdx, /* True for descending docids */
  143769. sqlite3_int64 *piPrev, /* IN/OUT: Previous value written to list */
  143770. int *pbFirst, /* IN/OUT: True after first int written */
  143771. sqlite3_int64 iVal /* Write this value to the list */
  143772. ){
  143773. sqlite3_int64 iWrite;
  143774. if( bDescIdx==0 || *pbFirst==0 ){
  143775. iWrite = iVal - *piPrev;
  143776. }else{
  143777. iWrite = *piPrev - iVal;
  143778. }
  143779. assert( *pbFirst || *piPrev==0 );
  143780. assert( *pbFirst==0 || iWrite>0 );
  143781. *pp += sqlite3Fts3PutVarint(*pp, iWrite);
  143782. *piPrev = iVal;
  143783. *pbFirst = 1;
  143784. }
  143785. /*
  143786. ** This macro is used by various functions that merge doclists. The two
  143787. ** arguments are 64-bit docid values. If the value of the stack variable
  143788. ** bDescDoclist is 0 when this macro is invoked, then it returns (i1-i2).
  143789. ** Otherwise, (i2-i1).
  143790. **
  143791. ** Using this makes it easier to write code that can merge doclists that are
  143792. ** sorted in either ascending or descending order.
  143793. */
  143794. #define DOCID_CMP(i1, i2) ((bDescDoclist?-1:1) * (i1-i2))
  143795. /*
  143796. ** This function does an "OR" merge of two doclists (output contains all
  143797. ** positions contained in either argument doclist). If the docids in the
  143798. ** input doclists are sorted in ascending order, parameter bDescDoclist
  143799. ** should be false. If they are sorted in ascending order, it should be
  143800. ** passed a non-zero value.
  143801. **
  143802. ** If no error occurs, *paOut is set to point at an sqlite3_malloc'd buffer
  143803. ** containing the output doclist and SQLITE_OK is returned. In this case
  143804. ** *pnOut is set to the number of bytes in the output doclist.
  143805. **
  143806. ** If an error occurs, an SQLite error code is returned. The output values
  143807. ** are undefined in this case.
  143808. */
  143809. static int fts3DoclistOrMerge(
  143810. int bDescDoclist, /* True if arguments are desc */
  143811. char *a1, int n1, /* First doclist */
  143812. char *a2, int n2, /* Second doclist */
  143813. char **paOut, int *pnOut /* OUT: Malloc'd doclist */
  143814. ){
  143815. sqlite3_int64 i1 = 0;
  143816. sqlite3_int64 i2 = 0;
  143817. sqlite3_int64 iPrev = 0;
  143818. char *pEnd1 = &a1[n1];
  143819. char *pEnd2 = &a2[n2];
  143820. char *p1 = a1;
  143821. char *p2 = a2;
  143822. char *p;
  143823. char *aOut;
  143824. int bFirstOut = 0;
  143825. *paOut = 0;
  143826. *pnOut = 0;
  143827. /* Allocate space for the output. Both the input and output doclists
  143828. ** are delta encoded. If they are in ascending order (bDescDoclist==0),
  143829. ** then the first docid in each list is simply encoded as a varint. For
  143830. ** each subsequent docid, the varint stored is the difference between the
  143831. ** current and previous docid (a positive number - since the list is in
  143832. ** ascending order).
  143833. **
  143834. ** The first docid written to the output is therefore encoded using the
  143835. ** same number of bytes as it is in whichever of the input lists it is
  143836. ** read from. And each subsequent docid read from the same input list
  143837. ** consumes either the same or less bytes as it did in the input (since
  143838. ** the difference between it and the previous value in the output must
  143839. ** be a positive value less than or equal to the delta value read from
  143840. ** the input list). The same argument applies to all but the first docid
  143841. ** read from the 'other' list. And to the contents of all position lists
  143842. ** that will be copied and merged from the input to the output.
  143843. **
  143844. ** However, if the first docid copied to the output is a negative number,
  143845. ** then the encoding of the first docid from the 'other' input list may
  143846. ** be larger in the output than it was in the input (since the delta value
  143847. ** may be a larger positive integer than the actual docid).
  143848. **
  143849. ** The space required to store the output is therefore the sum of the
  143850. ** sizes of the two inputs, plus enough space for exactly one of the input
  143851. ** docids to grow.
  143852. **
  143853. ** A symetric argument may be made if the doclists are in descending
  143854. ** order.
  143855. */
  143856. aOut = sqlite3_malloc(n1+n2+FTS3_VARINT_MAX-1);
  143857. if( !aOut ) return SQLITE_NOMEM;
  143858. p = aOut;
  143859. fts3GetDeltaVarint3(&p1, pEnd1, 0, &i1);
  143860. fts3GetDeltaVarint3(&p2, pEnd2, 0, &i2);
  143861. while( p1 || p2 ){
  143862. sqlite3_int64 iDiff = DOCID_CMP(i1, i2);
  143863. if( p2 && p1 && iDiff==0 ){
  143864. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i1);
  143865. fts3PoslistMerge(&p, &p1, &p2);
  143866. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  143867. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  143868. }else if( !p2 || (p1 && iDiff<0) ){
  143869. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i1);
  143870. fts3PoslistCopy(&p, &p1);
  143871. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  143872. }else{
  143873. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i2);
  143874. fts3PoslistCopy(&p, &p2);
  143875. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  143876. }
  143877. }
  143878. *paOut = aOut;
  143879. *pnOut = (int)(p-aOut);
  143880. assert( *pnOut<=n1+n2+FTS3_VARINT_MAX-1 );
  143881. return SQLITE_OK;
  143882. }
  143883. /*
  143884. ** This function does a "phrase" merge of two doclists. In a phrase merge,
  143885. ** the output contains a copy of each position from the right-hand input
  143886. ** doclist for which there is a position in the left-hand input doclist
  143887. ** exactly nDist tokens before it.
  143888. **
  143889. ** If the docids in the input doclists are sorted in ascending order,
  143890. ** parameter bDescDoclist should be false. If they are sorted in ascending
  143891. ** order, it should be passed a non-zero value.
  143892. **
  143893. ** The right-hand input doclist is overwritten by this function.
  143894. */
  143895. static int fts3DoclistPhraseMerge(
  143896. int bDescDoclist, /* True if arguments are desc */
  143897. int nDist, /* Distance from left to right (1=adjacent) */
  143898. char *aLeft, int nLeft, /* Left doclist */
  143899. char **paRight, int *pnRight /* IN/OUT: Right/output doclist */
  143900. ){
  143901. sqlite3_int64 i1 = 0;
  143902. sqlite3_int64 i2 = 0;
  143903. sqlite3_int64 iPrev = 0;
  143904. char *aRight = *paRight;
  143905. char *pEnd1 = &aLeft[nLeft];
  143906. char *pEnd2 = &aRight[*pnRight];
  143907. char *p1 = aLeft;
  143908. char *p2 = aRight;
  143909. char *p;
  143910. int bFirstOut = 0;
  143911. char *aOut;
  143912. assert( nDist>0 );
  143913. if( bDescDoclist ){
  143914. aOut = sqlite3_malloc(*pnRight + FTS3_VARINT_MAX);
  143915. if( aOut==0 ) return SQLITE_NOMEM;
  143916. }else{
  143917. aOut = aRight;
  143918. }
  143919. p = aOut;
  143920. fts3GetDeltaVarint3(&p1, pEnd1, 0, &i1);
  143921. fts3GetDeltaVarint3(&p2, pEnd2, 0, &i2);
  143922. while( p1 && p2 ){
  143923. sqlite3_int64 iDiff = DOCID_CMP(i1, i2);
  143924. if( iDiff==0 ){
  143925. char *pSave = p;
  143926. sqlite3_int64 iPrevSave = iPrev;
  143927. int bFirstOutSave = bFirstOut;
  143928. fts3PutDeltaVarint3(&p, bDescDoclist, &iPrev, &bFirstOut, i1);
  143929. if( 0==fts3PoslistPhraseMerge(&p, nDist, 0, 1, &p1, &p2) ){
  143930. p = pSave;
  143931. iPrev = iPrevSave;
  143932. bFirstOut = bFirstOutSave;
  143933. }
  143934. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  143935. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  143936. }else if( iDiff<0 ){
  143937. fts3PoslistCopy(0, &p1);
  143938. fts3GetDeltaVarint3(&p1, pEnd1, bDescDoclist, &i1);
  143939. }else{
  143940. fts3PoslistCopy(0, &p2);
  143941. fts3GetDeltaVarint3(&p2, pEnd2, bDescDoclist, &i2);
  143942. }
  143943. }
  143944. *pnRight = (int)(p - aOut);
  143945. if( bDescDoclist ){
  143946. sqlite3_free(aRight);
  143947. *paRight = aOut;
  143948. }
  143949. return SQLITE_OK;
  143950. }
  143951. /*
  143952. ** Argument pList points to a position list nList bytes in size. This
  143953. ** function checks to see if the position list contains any entries for
  143954. ** a token in position 0 (of any column). If so, it writes argument iDelta
  143955. ** to the output buffer pOut, followed by a position list consisting only
  143956. ** of the entries from pList at position 0, and terminated by an 0x00 byte.
  143957. ** The value returned is the number of bytes written to pOut (if any).
  143958. */
  143959. SQLITE_PRIVATE int sqlite3Fts3FirstFilter(
  143960. sqlite3_int64 iDelta, /* Varint that may be written to pOut */
  143961. char *pList, /* Position list (no 0x00 term) */
  143962. int nList, /* Size of pList in bytes */
  143963. char *pOut /* Write output here */
  143964. ){
  143965. int nOut = 0;
  143966. int bWritten = 0; /* True once iDelta has been written */
  143967. char *p = pList;
  143968. char *pEnd = &pList[nList];
  143969. if( *p!=0x01 ){
  143970. if( *p==0x02 ){
  143971. nOut += sqlite3Fts3PutVarint(&pOut[nOut], iDelta);
  143972. pOut[nOut++] = 0x02;
  143973. bWritten = 1;
  143974. }
  143975. fts3ColumnlistCopy(0, &p);
  143976. }
  143977. while( p<pEnd ){
  143978. sqlite3_int64 iCol;
  143979. p++;
  143980. p += sqlite3Fts3GetVarint(p, &iCol);
  143981. if( *p==0x02 ){
  143982. if( bWritten==0 ){
  143983. nOut += sqlite3Fts3PutVarint(&pOut[nOut], iDelta);
  143984. bWritten = 1;
  143985. }
  143986. pOut[nOut++] = 0x01;
  143987. nOut += sqlite3Fts3PutVarint(&pOut[nOut], iCol);
  143988. pOut[nOut++] = 0x02;
  143989. }
  143990. fts3ColumnlistCopy(0, &p);
  143991. }
  143992. if( bWritten ){
  143993. pOut[nOut++] = 0x00;
  143994. }
  143995. return nOut;
  143996. }
  143997. /*
  143998. ** Merge all doclists in the TermSelect.aaOutput[] array into a single
  143999. ** doclist stored in TermSelect.aaOutput[0]. If successful, delete all
  144000. ** other doclists (except the aaOutput[0] one) and return SQLITE_OK.
  144001. **
  144002. ** If an OOM error occurs, return SQLITE_NOMEM. In this case it is
  144003. ** the responsibility of the caller to free any doclists left in the
  144004. ** TermSelect.aaOutput[] array.
  144005. */
  144006. static int fts3TermSelectFinishMerge(Fts3Table *p, TermSelect *pTS){
  144007. char *aOut = 0;
  144008. int nOut = 0;
  144009. int i;
  144010. /* Loop through the doclists in the aaOutput[] array. Merge them all
  144011. ** into a single doclist.
  144012. */
  144013. for(i=0; i<SizeofArray(pTS->aaOutput); i++){
  144014. if( pTS->aaOutput[i] ){
  144015. if( !aOut ){
  144016. aOut = pTS->aaOutput[i];
  144017. nOut = pTS->anOutput[i];
  144018. pTS->aaOutput[i] = 0;
  144019. }else{
  144020. int nNew;
  144021. char *aNew;
  144022. int rc = fts3DoclistOrMerge(p->bDescIdx,
  144023. pTS->aaOutput[i], pTS->anOutput[i], aOut, nOut, &aNew, &nNew
  144024. );
  144025. if( rc!=SQLITE_OK ){
  144026. sqlite3_free(aOut);
  144027. return rc;
  144028. }
  144029. sqlite3_free(pTS->aaOutput[i]);
  144030. sqlite3_free(aOut);
  144031. pTS->aaOutput[i] = 0;
  144032. aOut = aNew;
  144033. nOut = nNew;
  144034. }
  144035. }
  144036. }
  144037. pTS->aaOutput[0] = aOut;
  144038. pTS->anOutput[0] = nOut;
  144039. return SQLITE_OK;
  144040. }
  144041. /*
  144042. ** Merge the doclist aDoclist/nDoclist into the TermSelect object passed
  144043. ** as the first argument. The merge is an "OR" merge (see function
  144044. ** fts3DoclistOrMerge() for details).
  144045. **
  144046. ** This function is called with the doclist for each term that matches
  144047. ** a queried prefix. It merges all these doclists into one, the doclist
  144048. ** for the specified prefix. Since there can be a very large number of
  144049. ** doclists to merge, the merging is done pair-wise using the TermSelect
  144050. ** object.
  144051. **
  144052. ** This function returns SQLITE_OK if the merge is successful, or an
  144053. ** SQLite error code (SQLITE_NOMEM) if an error occurs.
  144054. */
  144055. static int fts3TermSelectMerge(
  144056. Fts3Table *p, /* FTS table handle */
  144057. TermSelect *pTS, /* TermSelect object to merge into */
  144058. char *aDoclist, /* Pointer to doclist */
  144059. int nDoclist /* Size of aDoclist in bytes */
  144060. ){
  144061. if( pTS->aaOutput[0]==0 ){
  144062. /* If this is the first term selected, copy the doclist to the output
  144063. ** buffer using memcpy().
  144064. **
  144065. ** Add FTS3_VARINT_MAX bytes of unused space to the end of the
  144066. ** allocation. This is so as to ensure that the buffer is big enough
  144067. ** to hold the current doclist AND'd with any other doclist. If the
  144068. ** doclists are stored in order=ASC order, this padding would not be
  144069. ** required (since the size of [doclistA AND doclistB] is always less
  144070. ** than or equal to the size of [doclistA] in that case). But this is
  144071. ** not true for order=DESC. For example, a doclist containing (1, -1)
  144072. ** may be smaller than (-1), as in the first example the -1 may be stored
  144073. ** as a single-byte delta, whereas in the second it must be stored as a
  144074. ** FTS3_VARINT_MAX byte varint.
  144075. **
  144076. ** Similar padding is added in the fts3DoclistOrMerge() function.
  144077. */
  144078. pTS->aaOutput[0] = sqlite3_malloc(nDoclist + FTS3_VARINT_MAX + 1);
  144079. pTS->anOutput[0] = nDoclist;
  144080. if( pTS->aaOutput[0] ){
  144081. memcpy(pTS->aaOutput[0], aDoclist, nDoclist);
  144082. }else{
  144083. return SQLITE_NOMEM;
  144084. }
  144085. }else{
  144086. char *aMerge = aDoclist;
  144087. int nMerge = nDoclist;
  144088. int iOut;
  144089. for(iOut=0; iOut<SizeofArray(pTS->aaOutput); iOut++){
  144090. if( pTS->aaOutput[iOut]==0 ){
  144091. assert( iOut>0 );
  144092. pTS->aaOutput[iOut] = aMerge;
  144093. pTS->anOutput[iOut] = nMerge;
  144094. break;
  144095. }else{
  144096. char *aNew;
  144097. int nNew;
  144098. int rc = fts3DoclistOrMerge(p->bDescIdx, aMerge, nMerge,
  144099. pTS->aaOutput[iOut], pTS->anOutput[iOut], &aNew, &nNew
  144100. );
  144101. if( rc!=SQLITE_OK ){
  144102. if( aMerge!=aDoclist ) sqlite3_free(aMerge);
  144103. return rc;
  144104. }
  144105. if( aMerge!=aDoclist ) sqlite3_free(aMerge);
  144106. sqlite3_free(pTS->aaOutput[iOut]);
  144107. pTS->aaOutput[iOut] = 0;
  144108. aMerge = aNew;
  144109. nMerge = nNew;
  144110. if( (iOut+1)==SizeofArray(pTS->aaOutput) ){
  144111. pTS->aaOutput[iOut] = aMerge;
  144112. pTS->anOutput[iOut] = nMerge;
  144113. }
  144114. }
  144115. }
  144116. }
  144117. return SQLITE_OK;
  144118. }
  144119. /*
  144120. ** Append SegReader object pNew to the end of the pCsr->apSegment[] array.
  144121. */
  144122. static int fts3SegReaderCursorAppend(
  144123. Fts3MultiSegReader *pCsr,
  144124. Fts3SegReader *pNew
  144125. ){
  144126. if( (pCsr->nSegment%16)==0 ){
  144127. Fts3SegReader **apNew;
  144128. int nByte = (pCsr->nSegment + 16)*sizeof(Fts3SegReader*);
  144129. apNew = (Fts3SegReader **)sqlite3_realloc(pCsr->apSegment, nByte);
  144130. if( !apNew ){
  144131. sqlite3Fts3SegReaderFree(pNew);
  144132. return SQLITE_NOMEM;
  144133. }
  144134. pCsr->apSegment = apNew;
  144135. }
  144136. pCsr->apSegment[pCsr->nSegment++] = pNew;
  144137. return SQLITE_OK;
  144138. }
  144139. /*
  144140. ** Add seg-reader objects to the Fts3MultiSegReader object passed as the
  144141. ** 8th argument.
  144142. **
  144143. ** This function returns SQLITE_OK if successful, or an SQLite error code
  144144. ** otherwise.
  144145. */
  144146. static int fts3SegReaderCursor(
  144147. Fts3Table *p, /* FTS3 table handle */
  144148. int iLangid, /* Language id */
  144149. int iIndex, /* Index to search (from 0 to p->nIndex-1) */
  144150. int iLevel, /* Level of segments to scan */
  144151. const char *zTerm, /* Term to query for */
  144152. int nTerm, /* Size of zTerm in bytes */
  144153. int isPrefix, /* True for a prefix search */
  144154. int isScan, /* True to scan from zTerm to EOF */
  144155. Fts3MultiSegReader *pCsr /* Cursor object to populate */
  144156. ){
  144157. int rc = SQLITE_OK; /* Error code */
  144158. sqlite3_stmt *pStmt = 0; /* Statement to iterate through segments */
  144159. int rc2; /* Result of sqlite3_reset() */
  144160. /* If iLevel is less than 0 and this is not a scan, include a seg-reader
  144161. ** for the pending-terms. If this is a scan, then this call must be being
  144162. ** made by an fts4aux module, not an FTS table. In this case calling
  144163. ** Fts3SegReaderPending might segfault, as the data structures used by
  144164. ** fts4aux are not completely populated. So it's easiest to filter these
  144165. ** calls out here. */
  144166. if( iLevel<0 && p->aIndex ){
  144167. Fts3SegReader *pSeg = 0;
  144168. rc = sqlite3Fts3SegReaderPending(p, iIndex, zTerm, nTerm, isPrefix||isScan, &pSeg);
  144169. if( rc==SQLITE_OK && pSeg ){
  144170. rc = fts3SegReaderCursorAppend(pCsr, pSeg);
  144171. }
  144172. }
  144173. if( iLevel!=FTS3_SEGCURSOR_PENDING ){
  144174. if( rc==SQLITE_OK ){
  144175. rc = sqlite3Fts3AllSegdirs(p, iLangid, iIndex, iLevel, &pStmt);
  144176. }
  144177. while( rc==SQLITE_OK && SQLITE_ROW==(rc = sqlite3_step(pStmt)) ){
  144178. Fts3SegReader *pSeg = 0;
  144179. /* Read the values returned by the SELECT into local variables. */
  144180. sqlite3_int64 iStartBlock = sqlite3_column_int64(pStmt, 1);
  144181. sqlite3_int64 iLeavesEndBlock = sqlite3_column_int64(pStmt, 2);
  144182. sqlite3_int64 iEndBlock = sqlite3_column_int64(pStmt, 3);
  144183. int nRoot = sqlite3_column_bytes(pStmt, 4);
  144184. char const *zRoot = sqlite3_column_blob(pStmt, 4);
  144185. /* If zTerm is not NULL, and this segment is not stored entirely on its
  144186. ** root node, the range of leaves scanned can be reduced. Do this. */
  144187. if( iStartBlock && zTerm ){
  144188. sqlite3_int64 *pi = (isPrefix ? &iLeavesEndBlock : 0);
  144189. rc = fts3SelectLeaf(p, zTerm, nTerm, zRoot, nRoot, &iStartBlock, pi);
  144190. if( rc!=SQLITE_OK ) goto finished;
  144191. if( isPrefix==0 && isScan==0 ) iLeavesEndBlock = iStartBlock;
  144192. }
  144193. rc = sqlite3Fts3SegReaderNew(pCsr->nSegment+1,
  144194. (isPrefix==0 && isScan==0),
  144195. iStartBlock, iLeavesEndBlock,
  144196. iEndBlock, zRoot, nRoot, &pSeg
  144197. );
  144198. if( rc!=SQLITE_OK ) goto finished;
  144199. rc = fts3SegReaderCursorAppend(pCsr, pSeg);
  144200. }
  144201. }
  144202. finished:
  144203. rc2 = sqlite3_reset(pStmt);
  144204. if( rc==SQLITE_DONE ) rc = rc2;
  144205. return rc;
  144206. }
  144207. /*
  144208. ** Set up a cursor object for iterating through a full-text index or a
  144209. ** single level therein.
  144210. */
  144211. SQLITE_PRIVATE int sqlite3Fts3SegReaderCursor(
  144212. Fts3Table *p, /* FTS3 table handle */
  144213. int iLangid, /* Language-id to search */
  144214. int iIndex, /* Index to search (from 0 to p->nIndex-1) */
  144215. int iLevel, /* Level of segments to scan */
  144216. const char *zTerm, /* Term to query for */
  144217. int nTerm, /* Size of zTerm in bytes */
  144218. int isPrefix, /* True for a prefix search */
  144219. int isScan, /* True to scan from zTerm to EOF */
  144220. Fts3MultiSegReader *pCsr /* Cursor object to populate */
  144221. ){
  144222. assert( iIndex>=0 && iIndex<p->nIndex );
  144223. assert( iLevel==FTS3_SEGCURSOR_ALL
  144224. || iLevel==FTS3_SEGCURSOR_PENDING
  144225. || iLevel>=0
  144226. );
  144227. assert( iLevel<FTS3_SEGDIR_MAXLEVEL );
  144228. assert( FTS3_SEGCURSOR_ALL<0 && FTS3_SEGCURSOR_PENDING<0 );
  144229. assert( isPrefix==0 || isScan==0 );
  144230. memset(pCsr, 0, sizeof(Fts3MultiSegReader));
  144231. return fts3SegReaderCursor(
  144232. p, iLangid, iIndex, iLevel, zTerm, nTerm, isPrefix, isScan, pCsr
  144233. );
  144234. }
  144235. /*
  144236. ** In addition to its current configuration, have the Fts3MultiSegReader
  144237. ** passed as the 4th argument also scan the doclist for term zTerm/nTerm.
  144238. **
  144239. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  144240. */
  144241. static int fts3SegReaderCursorAddZero(
  144242. Fts3Table *p, /* FTS virtual table handle */
  144243. int iLangid,
  144244. const char *zTerm, /* Term to scan doclist of */
  144245. int nTerm, /* Number of bytes in zTerm */
  144246. Fts3MultiSegReader *pCsr /* Fts3MultiSegReader to modify */
  144247. ){
  144248. return fts3SegReaderCursor(p,
  144249. iLangid, 0, FTS3_SEGCURSOR_ALL, zTerm, nTerm, 0, 0,pCsr
  144250. );
  144251. }
  144252. /*
  144253. ** Open an Fts3MultiSegReader to scan the doclist for term zTerm/nTerm. Or,
  144254. ** if isPrefix is true, to scan the doclist for all terms for which
  144255. ** zTerm/nTerm is a prefix. If successful, return SQLITE_OK and write
  144256. ** a pointer to the new Fts3MultiSegReader to *ppSegcsr. Otherwise, return
  144257. ** an SQLite error code.
  144258. **
  144259. ** It is the responsibility of the caller to free this object by eventually
  144260. ** passing it to fts3SegReaderCursorFree()
  144261. **
  144262. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  144263. ** Output parameter *ppSegcsr is set to 0 if an error occurs.
  144264. */
  144265. static int fts3TermSegReaderCursor(
  144266. Fts3Cursor *pCsr, /* Virtual table cursor handle */
  144267. const char *zTerm, /* Term to query for */
  144268. int nTerm, /* Size of zTerm in bytes */
  144269. int isPrefix, /* True for a prefix search */
  144270. Fts3MultiSegReader **ppSegcsr /* OUT: Allocated seg-reader cursor */
  144271. ){
  144272. Fts3MultiSegReader *pSegcsr; /* Object to allocate and return */
  144273. int rc = SQLITE_NOMEM; /* Return code */
  144274. pSegcsr = sqlite3_malloc(sizeof(Fts3MultiSegReader));
  144275. if( pSegcsr ){
  144276. int i;
  144277. int bFound = 0; /* True once an index has been found */
  144278. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  144279. if( isPrefix ){
  144280. for(i=1; bFound==0 && i<p->nIndex; i++){
  144281. if( p->aIndex[i].nPrefix==nTerm ){
  144282. bFound = 1;
  144283. rc = sqlite3Fts3SegReaderCursor(p, pCsr->iLangid,
  144284. i, FTS3_SEGCURSOR_ALL, zTerm, nTerm, 0, 0, pSegcsr
  144285. );
  144286. pSegcsr->bLookup = 1;
  144287. }
  144288. }
  144289. for(i=1; bFound==0 && i<p->nIndex; i++){
  144290. if( p->aIndex[i].nPrefix==nTerm+1 ){
  144291. bFound = 1;
  144292. rc = sqlite3Fts3SegReaderCursor(p, pCsr->iLangid,
  144293. i, FTS3_SEGCURSOR_ALL, zTerm, nTerm, 1, 0, pSegcsr
  144294. );
  144295. if( rc==SQLITE_OK ){
  144296. rc = fts3SegReaderCursorAddZero(
  144297. p, pCsr->iLangid, zTerm, nTerm, pSegcsr
  144298. );
  144299. }
  144300. }
  144301. }
  144302. }
  144303. if( bFound==0 ){
  144304. rc = sqlite3Fts3SegReaderCursor(p, pCsr->iLangid,
  144305. 0, FTS3_SEGCURSOR_ALL, zTerm, nTerm, isPrefix, 0, pSegcsr
  144306. );
  144307. pSegcsr->bLookup = !isPrefix;
  144308. }
  144309. }
  144310. *ppSegcsr = pSegcsr;
  144311. return rc;
  144312. }
  144313. /*
  144314. ** Free an Fts3MultiSegReader allocated by fts3TermSegReaderCursor().
  144315. */
  144316. static void fts3SegReaderCursorFree(Fts3MultiSegReader *pSegcsr){
  144317. sqlite3Fts3SegReaderFinish(pSegcsr);
  144318. sqlite3_free(pSegcsr);
  144319. }
  144320. /*
  144321. ** This function retrieves the doclist for the specified term (or term
  144322. ** prefix) from the database.
  144323. */
  144324. static int fts3TermSelect(
  144325. Fts3Table *p, /* Virtual table handle */
  144326. Fts3PhraseToken *pTok, /* Token to query for */
  144327. int iColumn, /* Column to query (or -ve for all columns) */
  144328. int *pnOut, /* OUT: Size of buffer at *ppOut */
  144329. char **ppOut /* OUT: Malloced result buffer */
  144330. ){
  144331. int rc; /* Return code */
  144332. Fts3MultiSegReader *pSegcsr; /* Seg-reader cursor for this term */
  144333. TermSelect tsc; /* Object for pair-wise doclist merging */
  144334. Fts3SegFilter filter; /* Segment term filter configuration */
  144335. pSegcsr = pTok->pSegcsr;
  144336. memset(&tsc, 0, sizeof(TermSelect));
  144337. filter.flags = FTS3_SEGMENT_IGNORE_EMPTY | FTS3_SEGMENT_REQUIRE_POS
  144338. | (pTok->isPrefix ? FTS3_SEGMENT_PREFIX : 0)
  144339. | (pTok->bFirst ? FTS3_SEGMENT_FIRST : 0)
  144340. | (iColumn<p->nColumn ? FTS3_SEGMENT_COLUMN_FILTER : 0);
  144341. filter.iCol = iColumn;
  144342. filter.zTerm = pTok->z;
  144343. filter.nTerm = pTok->n;
  144344. rc = sqlite3Fts3SegReaderStart(p, pSegcsr, &filter);
  144345. while( SQLITE_OK==rc
  144346. && SQLITE_ROW==(rc = sqlite3Fts3SegReaderStep(p, pSegcsr))
  144347. ){
  144348. rc = fts3TermSelectMerge(p, &tsc, pSegcsr->aDoclist, pSegcsr->nDoclist);
  144349. }
  144350. if( rc==SQLITE_OK ){
  144351. rc = fts3TermSelectFinishMerge(p, &tsc);
  144352. }
  144353. if( rc==SQLITE_OK ){
  144354. *ppOut = tsc.aaOutput[0];
  144355. *pnOut = tsc.anOutput[0];
  144356. }else{
  144357. int i;
  144358. for(i=0; i<SizeofArray(tsc.aaOutput); i++){
  144359. sqlite3_free(tsc.aaOutput[i]);
  144360. }
  144361. }
  144362. fts3SegReaderCursorFree(pSegcsr);
  144363. pTok->pSegcsr = 0;
  144364. return rc;
  144365. }
  144366. /*
  144367. ** This function counts the total number of docids in the doclist stored
  144368. ** in buffer aList[], size nList bytes.
  144369. **
  144370. ** If the isPoslist argument is true, then it is assumed that the doclist
  144371. ** contains a position-list following each docid. Otherwise, it is assumed
  144372. ** that the doclist is simply a list of docids stored as delta encoded
  144373. ** varints.
  144374. */
  144375. static int fts3DoclistCountDocids(char *aList, int nList){
  144376. int nDoc = 0; /* Return value */
  144377. if( aList ){
  144378. char *aEnd = &aList[nList]; /* Pointer to one byte after EOF */
  144379. char *p = aList; /* Cursor */
  144380. while( p<aEnd ){
  144381. nDoc++;
  144382. while( (*p++)&0x80 ); /* Skip docid varint */
  144383. fts3PoslistCopy(0, &p); /* Skip over position list */
  144384. }
  144385. }
  144386. return nDoc;
  144387. }
  144388. /*
  144389. ** Advance the cursor to the next row in the %_content table that
  144390. ** matches the search criteria. For a MATCH search, this will be
  144391. ** the next row that matches. For a full-table scan, this will be
  144392. ** simply the next row in the %_content table. For a docid lookup,
  144393. ** this routine simply sets the EOF flag.
  144394. **
  144395. ** Return SQLITE_OK if nothing goes wrong. SQLITE_OK is returned
  144396. ** even if we reach end-of-file. The fts3EofMethod() will be called
  144397. ** subsequently to determine whether or not an EOF was hit.
  144398. */
  144399. static int fts3NextMethod(sqlite3_vtab_cursor *pCursor){
  144400. int rc;
  144401. Fts3Cursor *pCsr = (Fts3Cursor *)pCursor;
  144402. if( pCsr->eSearch==FTS3_DOCID_SEARCH || pCsr->eSearch==FTS3_FULLSCAN_SEARCH ){
  144403. if( SQLITE_ROW!=sqlite3_step(pCsr->pStmt) ){
  144404. pCsr->isEof = 1;
  144405. rc = sqlite3_reset(pCsr->pStmt);
  144406. }else{
  144407. pCsr->iPrevId = sqlite3_column_int64(pCsr->pStmt, 0);
  144408. rc = SQLITE_OK;
  144409. }
  144410. }else{
  144411. rc = fts3EvalNext((Fts3Cursor *)pCursor);
  144412. }
  144413. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  144414. return rc;
  144415. }
  144416. /*
  144417. ** The following are copied from sqliteInt.h.
  144418. **
  144419. ** Constants for the largest and smallest possible 64-bit signed integers.
  144420. ** These macros are designed to work correctly on both 32-bit and 64-bit
  144421. ** compilers.
  144422. */
  144423. #ifndef SQLITE_AMALGAMATION
  144424. # define LARGEST_INT64 (0xffffffff|(((sqlite3_int64)0x7fffffff)<<32))
  144425. # define SMALLEST_INT64 (((sqlite3_int64)-1) - LARGEST_INT64)
  144426. #endif
  144427. /*
  144428. ** If the numeric type of argument pVal is "integer", then return it
  144429. ** converted to a 64-bit signed integer. Otherwise, return a copy of
  144430. ** the second parameter, iDefault.
  144431. */
  144432. static sqlite3_int64 fts3DocidRange(sqlite3_value *pVal, i64 iDefault){
  144433. if( pVal ){
  144434. int eType = sqlite3_value_numeric_type(pVal);
  144435. if( eType==SQLITE_INTEGER ){
  144436. return sqlite3_value_int64(pVal);
  144437. }
  144438. }
  144439. return iDefault;
  144440. }
  144441. /*
  144442. ** This is the xFilter interface for the virtual table. See
  144443. ** the virtual table xFilter method documentation for additional
  144444. ** information.
  144445. **
  144446. ** If idxNum==FTS3_FULLSCAN_SEARCH then do a full table scan against
  144447. ** the %_content table.
  144448. **
  144449. ** If idxNum==FTS3_DOCID_SEARCH then do a docid lookup for a single entry
  144450. ** in the %_content table.
  144451. **
  144452. ** If idxNum>=FTS3_FULLTEXT_SEARCH then use the full text index. The
  144453. ** column on the left-hand side of the MATCH operator is column
  144454. ** number idxNum-FTS3_FULLTEXT_SEARCH, 0 indexed. argv[0] is the right-hand
  144455. ** side of the MATCH operator.
  144456. */
  144457. static int fts3FilterMethod(
  144458. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  144459. int idxNum, /* Strategy index */
  144460. const char *idxStr, /* Unused */
  144461. int nVal, /* Number of elements in apVal */
  144462. sqlite3_value **apVal /* Arguments for the indexing scheme */
  144463. ){
  144464. int rc = SQLITE_OK;
  144465. char *zSql; /* SQL statement used to access %_content */
  144466. int eSearch;
  144467. Fts3Table *p = (Fts3Table *)pCursor->pVtab;
  144468. Fts3Cursor *pCsr = (Fts3Cursor *)pCursor;
  144469. sqlite3_value *pCons = 0; /* The MATCH or rowid constraint, if any */
  144470. sqlite3_value *pLangid = 0; /* The "langid = ?" constraint, if any */
  144471. sqlite3_value *pDocidGe = 0; /* The "docid >= ?" constraint, if any */
  144472. sqlite3_value *pDocidLe = 0; /* The "docid <= ?" constraint, if any */
  144473. int iIdx;
  144474. UNUSED_PARAMETER(idxStr);
  144475. UNUSED_PARAMETER(nVal);
  144476. eSearch = (idxNum & 0x0000FFFF);
  144477. assert( eSearch>=0 && eSearch<=(FTS3_FULLTEXT_SEARCH+p->nColumn) );
  144478. assert( p->pSegments==0 );
  144479. /* Collect arguments into local variables */
  144480. iIdx = 0;
  144481. if( eSearch!=FTS3_FULLSCAN_SEARCH ) pCons = apVal[iIdx++];
  144482. if( idxNum & FTS3_HAVE_LANGID ) pLangid = apVal[iIdx++];
  144483. if( idxNum & FTS3_HAVE_DOCID_GE ) pDocidGe = apVal[iIdx++];
  144484. if( idxNum & FTS3_HAVE_DOCID_LE ) pDocidLe = apVal[iIdx++];
  144485. assert( iIdx==nVal );
  144486. /* In case the cursor has been used before, clear it now. */
  144487. fts3ClearCursor(pCsr);
  144488. /* Set the lower and upper bounds on docids to return */
  144489. pCsr->iMinDocid = fts3DocidRange(pDocidGe, SMALLEST_INT64);
  144490. pCsr->iMaxDocid = fts3DocidRange(pDocidLe, LARGEST_INT64);
  144491. if( idxStr ){
  144492. pCsr->bDesc = (idxStr[0]=='D');
  144493. }else{
  144494. pCsr->bDesc = p->bDescIdx;
  144495. }
  144496. pCsr->eSearch = (i16)eSearch;
  144497. if( eSearch!=FTS3_DOCID_SEARCH && eSearch!=FTS3_FULLSCAN_SEARCH ){
  144498. int iCol = eSearch-FTS3_FULLTEXT_SEARCH;
  144499. const char *zQuery = (const char *)sqlite3_value_text(pCons);
  144500. if( zQuery==0 && sqlite3_value_type(pCons)!=SQLITE_NULL ){
  144501. return SQLITE_NOMEM;
  144502. }
  144503. pCsr->iLangid = 0;
  144504. if( pLangid ) pCsr->iLangid = sqlite3_value_int(pLangid);
  144505. assert( p->base.zErrMsg==0 );
  144506. rc = sqlite3Fts3ExprParse(p->pTokenizer, pCsr->iLangid,
  144507. p->azColumn, p->bFts4, p->nColumn, iCol, zQuery, -1, &pCsr->pExpr,
  144508. &p->base.zErrMsg
  144509. );
  144510. if( rc!=SQLITE_OK ){
  144511. return rc;
  144512. }
  144513. rc = fts3EvalStart(pCsr);
  144514. sqlite3Fts3SegmentsClose(p);
  144515. if( rc!=SQLITE_OK ) return rc;
  144516. pCsr->pNextId = pCsr->aDoclist;
  144517. pCsr->iPrevId = 0;
  144518. }
  144519. /* Compile a SELECT statement for this cursor. For a full-table-scan, the
  144520. ** statement loops through all rows of the %_content table. For a
  144521. ** full-text query or docid lookup, the statement retrieves a single
  144522. ** row by docid.
  144523. */
  144524. if( eSearch==FTS3_FULLSCAN_SEARCH ){
  144525. if( pDocidGe || pDocidLe ){
  144526. zSql = sqlite3_mprintf(
  144527. "SELECT %s WHERE rowid BETWEEN %lld AND %lld ORDER BY rowid %s",
  144528. p->zReadExprlist, pCsr->iMinDocid, pCsr->iMaxDocid,
  144529. (pCsr->bDesc ? "DESC" : "ASC")
  144530. );
  144531. }else{
  144532. zSql = sqlite3_mprintf("SELECT %s ORDER BY rowid %s",
  144533. p->zReadExprlist, (pCsr->bDesc ? "DESC" : "ASC")
  144534. );
  144535. }
  144536. if( zSql ){
  144537. rc = sqlite3_prepare_v3(p->db,zSql,-1,SQLITE_PREPARE_PERSISTENT,&pCsr->pStmt,0);
  144538. sqlite3_free(zSql);
  144539. }else{
  144540. rc = SQLITE_NOMEM;
  144541. }
  144542. }else if( eSearch==FTS3_DOCID_SEARCH ){
  144543. rc = fts3CursorSeekStmt(pCsr);
  144544. if( rc==SQLITE_OK ){
  144545. rc = sqlite3_bind_value(pCsr->pStmt, 1, pCons);
  144546. }
  144547. }
  144548. if( rc!=SQLITE_OK ) return rc;
  144549. return fts3NextMethod(pCursor);
  144550. }
  144551. /*
  144552. ** This is the xEof method of the virtual table. SQLite calls this
  144553. ** routine to find out if it has reached the end of a result set.
  144554. */
  144555. static int fts3EofMethod(sqlite3_vtab_cursor *pCursor){
  144556. Fts3Cursor *pCsr = (Fts3Cursor*)pCursor;
  144557. if( pCsr->isEof ){
  144558. fts3ClearCursor(pCsr);
  144559. pCsr->isEof = 1;
  144560. }
  144561. return pCsr->isEof;
  144562. }
  144563. /*
  144564. ** This is the xRowid method. The SQLite core calls this routine to
  144565. ** retrieve the rowid for the current row of the result set. fts3
  144566. ** exposes %_content.docid as the rowid for the virtual table. The
  144567. ** rowid should be written to *pRowid.
  144568. */
  144569. static int fts3RowidMethod(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  144570. Fts3Cursor *pCsr = (Fts3Cursor *) pCursor;
  144571. *pRowid = pCsr->iPrevId;
  144572. return SQLITE_OK;
  144573. }
  144574. /*
  144575. ** This is the xColumn method, called by SQLite to request a value from
  144576. ** the row that the supplied cursor currently points to.
  144577. **
  144578. ** If:
  144579. **
  144580. ** (iCol < p->nColumn) -> The value of the iCol'th user column.
  144581. ** (iCol == p->nColumn) -> Magic column with the same name as the table.
  144582. ** (iCol == p->nColumn+1) -> Docid column
  144583. ** (iCol == p->nColumn+2) -> Langid column
  144584. */
  144585. static int fts3ColumnMethod(
  144586. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  144587. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  144588. int iCol /* Index of column to read value from */
  144589. ){
  144590. int rc = SQLITE_OK; /* Return Code */
  144591. Fts3Cursor *pCsr = (Fts3Cursor *) pCursor;
  144592. Fts3Table *p = (Fts3Table *)pCursor->pVtab;
  144593. /* The column value supplied by SQLite must be in range. */
  144594. assert( iCol>=0 && iCol<=p->nColumn+2 );
  144595. switch( iCol-p->nColumn ){
  144596. case 0:
  144597. /* The special 'table-name' column */
  144598. sqlite3_result_pointer(pCtx, pCsr, "fts3cursor", 0);
  144599. break;
  144600. case 1:
  144601. /* The docid column */
  144602. sqlite3_result_int64(pCtx, pCsr->iPrevId);
  144603. break;
  144604. case 2:
  144605. if( pCsr->pExpr ){
  144606. sqlite3_result_int64(pCtx, pCsr->iLangid);
  144607. break;
  144608. }else if( p->zLanguageid==0 ){
  144609. sqlite3_result_int(pCtx, 0);
  144610. break;
  144611. }else{
  144612. iCol = p->nColumn;
  144613. /* fall-through */
  144614. }
  144615. default:
  144616. /* A user column. Or, if this is a full-table scan, possibly the
  144617. ** language-id column. Seek the cursor. */
  144618. rc = fts3CursorSeek(0, pCsr);
  144619. if( rc==SQLITE_OK && sqlite3_data_count(pCsr->pStmt)-1>iCol ){
  144620. sqlite3_result_value(pCtx, sqlite3_column_value(pCsr->pStmt, iCol+1));
  144621. }
  144622. break;
  144623. }
  144624. assert( ((Fts3Table *)pCsr->base.pVtab)->pSegments==0 );
  144625. return rc;
  144626. }
  144627. /*
  144628. ** This function is the implementation of the xUpdate callback used by
  144629. ** FTS3 virtual tables. It is invoked by SQLite each time a row is to be
  144630. ** inserted, updated or deleted.
  144631. */
  144632. static int fts3UpdateMethod(
  144633. sqlite3_vtab *pVtab, /* Virtual table handle */
  144634. int nArg, /* Size of argument array */
  144635. sqlite3_value **apVal, /* Array of arguments */
  144636. sqlite_int64 *pRowid /* OUT: The affected (or effected) rowid */
  144637. ){
  144638. return sqlite3Fts3UpdateMethod(pVtab, nArg, apVal, pRowid);
  144639. }
  144640. /*
  144641. ** Implementation of xSync() method. Flush the contents of the pending-terms
  144642. ** hash-table to the database.
  144643. */
  144644. static int fts3SyncMethod(sqlite3_vtab *pVtab){
  144645. /* Following an incremental-merge operation, assuming that the input
  144646. ** segments are not completely consumed (the usual case), they are updated
  144647. ** in place to remove the entries that have already been merged. This
  144648. ** involves updating the leaf block that contains the smallest unmerged
  144649. ** entry and each block (if any) between the leaf and the root node. So
  144650. ** if the height of the input segment b-trees is N, and input segments
  144651. ** are merged eight at a time, updating the input segments at the end
  144652. ** of an incremental-merge requires writing (8*(1+N)) blocks. N is usually
  144653. ** small - often between 0 and 2. So the overhead of the incremental
  144654. ** merge is somewhere between 8 and 24 blocks. To avoid this overhead
  144655. ** dwarfing the actual productive work accomplished, the incremental merge
  144656. ** is only attempted if it will write at least 64 leaf blocks. Hence
  144657. ** nMinMerge.
  144658. **
  144659. ** Of course, updating the input segments also involves deleting a bunch
  144660. ** of blocks from the segments table. But this is not considered overhead
  144661. ** as it would also be required by a crisis-merge that used the same input
  144662. ** segments.
  144663. */
  144664. const u32 nMinMerge = 64; /* Minimum amount of incr-merge work to do */
  144665. Fts3Table *p = (Fts3Table*)pVtab;
  144666. int rc;
  144667. i64 iLastRowid = sqlite3_last_insert_rowid(p->db);
  144668. rc = sqlite3Fts3PendingTermsFlush(p);
  144669. if( rc==SQLITE_OK
  144670. && p->nLeafAdd>(nMinMerge/16)
  144671. && p->nAutoincrmerge && p->nAutoincrmerge!=0xff
  144672. ){
  144673. int mxLevel = 0; /* Maximum relative level value in db */
  144674. int A; /* Incr-merge parameter A */
  144675. rc = sqlite3Fts3MaxLevel(p, &mxLevel);
  144676. assert( rc==SQLITE_OK || mxLevel==0 );
  144677. A = p->nLeafAdd * mxLevel;
  144678. A += (A/2);
  144679. if( A>(int)nMinMerge ) rc = sqlite3Fts3Incrmerge(p, A, p->nAutoincrmerge);
  144680. }
  144681. sqlite3Fts3SegmentsClose(p);
  144682. sqlite3_set_last_insert_rowid(p->db, iLastRowid);
  144683. return rc;
  144684. }
  144685. /*
  144686. ** If it is currently unknown whether or not the FTS table has an %_stat
  144687. ** table (if p->bHasStat==2), attempt to determine this (set p->bHasStat
  144688. ** to 0 or 1). Return SQLITE_OK if successful, or an SQLite error code
  144689. ** if an error occurs.
  144690. */
  144691. static int fts3SetHasStat(Fts3Table *p){
  144692. int rc = SQLITE_OK;
  144693. if( p->bHasStat==2 ){
  144694. char *zTbl = sqlite3_mprintf("%s_stat", p->zName);
  144695. if( zTbl ){
  144696. int res = sqlite3_table_column_metadata(p->db, p->zDb, zTbl, 0,0,0,0,0,0);
  144697. sqlite3_free(zTbl);
  144698. p->bHasStat = (res==SQLITE_OK);
  144699. }else{
  144700. rc = SQLITE_NOMEM;
  144701. }
  144702. }
  144703. return rc;
  144704. }
  144705. /*
  144706. ** Implementation of xBegin() method.
  144707. */
  144708. static int fts3BeginMethod(sqlite3_vtab *pVtab){
  144709. Fts3Table *p = (Fts3Table*)pVtab;
  144710. UNUSED_PARAMETER(pVtab);
  144711. assert( p->pSegments==0 );
  144712. assert( p->nPendingData==0 );
  144713. assert( p->inTransaction!=1 );
  144714. TESTONLY( p->inTransaction = 1 );
  144715. TESTONLY( p->mxSavepoint = -1; );
  144716. p->nLeafAdd = 0;
  144717. return fts3SetHasStat(p);
  144718. }
  144719. /*
  144720. ** Implementation of xCommit() method. This is a no-op. The contents of
  144721. ** the pending-terms hash-table have already been flushed into the database
  144722. ** by fts3SyncMethod().
  144723. */
  144724. static int fts3CommitMethod(sqlite3_vtab *pVtab){
  144725. TESTONLY( Fts3Table *p = (Fts3Table*)pVtab );
  144726. UNUSED_PARAMETER(pVtab);
  144727. assert( p->nPendingData==0 );
  144728. assert( p->inTransaction!=0 );
  144729. assert( p->pSegments==0 );
  144730. TESTONLY( p->inTransaction = 0 );
  144731. TESTONLY( p->mxSavepoint = -1; );
  144732. return SQLITE_OK;
  144733. }
  144734. /*
  144735. ** Implementation of xRollback(). Discard the contents of the pending-terms
  144736. ** hash-table. Any changes made to the database are reverted by SQLite.
  144737. */
  144738. static int fts3RollbackMethod(sqlite3_vtab *pVtab){
  144739. Fts3Table *p = (Fts3Table*)pVtab;
  144740. sqlite3Fts3PendingTermsClear(p);
  144741. assert( p->inTransaction!=0 );
  144742. TESTONLY( p->inTransaction = 0 );
  144743. TESTONLY( p->mxSavepoint = -1; );
  144744. return SQLITE_OK;
  144745. }
  144746. /*
  144747. ** When called, *ppPoslist must point to the byte immediately following the
  144748. ** end of a position-list. i.e. ( (*ppPoslist)[-1]==POS_END ). This function
  144749. ** moves *ppPoslist so that it instead points to the first byte of the
  144750. ** same position list.
  144751. */
  144752. static void fts3ReversePoslist(char *pStart, char **ppPoslist){
  144753. char *p = &(*ppPoslist)[-2];
  144754. char c = 0;
  144755. /* Skip backwards passed any trailing 0x00 bytes added by NearTrim() */
  144756. while( p>pStart && (c=*p--)==0 );
  144757. /* Search backwards for a varint with value zero (the end of the previous
  144758. ** poslist). This is an 0x00 byte preceded by some byte that does not
  144759. ** have the 0x80 bit set. */
  144760. while( p>pStart && (*p & 0x80) | c ){
  144761. c = *p--;
  144762. }
  144763. assert( p==pStart || c==0 );
  144764. /* At this point p points to that preceding byte without the 0x80 bit
  144765. ** set. So to find the start of the poslist, skip forward 2 bytes then
  144766. ** over a varint.
  144767. **
  144768. ** Normally. The other case is that p==pStart and the poslist to return
  144769. ** is the first in the doclist. In this case do not skip forward 2 bytes.
  144770. ** The second part of the if condition (c==0 && *ppPoslist>&p[2])
  144771. ** is required for cases where the first byte of a doclist and the
  144772. ** doclist is empty. For example, if the first docid is 10, a doclist
  144773. ** that begins with:
  144774. **
  144775. ** 0x0A 0x00 <next docid delta varint>
  144776. */
  144777. if( p>pStart || (c==0 && *ppPoslist>&p[2]) ){ p = &p[2]; }
  144778. while( *p++&0x80 );
  144779. *ppPoslist = p;
  144780. }
  144781. /*
  144782. ** Helper function used by the implementation of the overloaded snippet(),
  144783. ** offsets() and optimize() SQL functions.
  144784. **
  144785. ** If the value passed as the third argument is a blob of size
  144786. ** sizeof(Fts3Cursor*), then the blob contents are copied to the
  144787. ** output variable *ppCsr and SQLITE_OK is returned. Otherwise, an error
  144788. ** message is written to context pContext and SQLITE_ERROR returned. The
  144789. ** string passed via zFunc is used as part of the error message.
  144790. */
  144791. static int fts3FunctionArg(
  144792. sqlite3_context *pContext, /* SQL function call context */
  144793. const char *zFunc, /* Function name */
  144794. sqlite3_value *pVal, /* argv[0] passed to function */
  144795. Fts3Cursor **ppCsr /* OUT: Store cursor handle here */
  144796. ){
  144797. int rc;
  144798. *ppCsr = (Fts3Cursor*)sqlite3_value_pointer(pVal, "fts3cursor");
  144799. if( (*ppCsr)!=0 ){
  144800. rc = SQLITE_OK;
  144801. }else{
  144802. char *zErr = sqlite3_mprintf("illegal first argument to %s", zFunc);
  144803. sqlite3_result_error(pContext, zErr, -1);
  144804. sqlite3_free(zErr);
  144805. rc = SQLITE_ERROR;
  144806. }
  144807. return rc;
  144808. }
  144809. /*
  144810. ** Implementation of the snippet() function for FTS3
  144811. */
  144812. static void fts3SnippetFunc(
  144813. sqlite3_context *pContext, /* SQLite function call context */
  144814. int nVal, /* Size of apVal[] array */
  144815. sqlite3_value **apVal /* Array of arguments */
  144816. ){
  144817. Fts3Cursor *pCsr; /* Cursor handle passed through apVal[0] */
  144818. const char *zStart = "<b>";
  144819. const char *zEnd = "</b>";
  144820. const char *zEllipsis = "<b>...</b>";
  144821. int iCol = -1;
  144822. int nToken = 15; /* Default number of tokens in snippet */
  144823. /* There must be at least one argument passed to this function (otherwise
  144824. ** the non-overloaded version would have been called instead of this one).
  144825. */
  144826. assert( nVal>=1 );
  144827. if( nVal>6 ){
  144828. sqlite3_result_error(pContext,
  144829. "wrong number of arguments to function snippet()", -1);
  144830. return;
  144831. }
  144832. if( fts3FunctionArg(pContext, "snippet", apVal[0], &pCsr) ) return;
  144833. switch( nVal ){
  144834. case 6: nToken = sqlite3_value_int(apVal[5]);
  144835. case 5: iCol = sqlite3_value_int(apVal[4]);
  144836. case 4: zEllipsis = (const char*)sqlite3_value_text(apVal[3]);
  144837. case 3: zEnd = (const char*)sqlite3_value_text(apVal[2]);
  144838. case 2: zStart = (const char*)sqlite3_value_text(apVal[1]);
  144839. }
  144840. if( !zEllipsis || !zEnd || !zStart ){
  144841. sqlite3_result_error_nomem(pContext);
  144842. }else if( nToken==0 ){
  144843. sqlite3_result_text(pContext, "", -1, SQLITE_STATIC);
  144844. }else if( SQLITE_OK==fts3CursorSeek(pContext, pCsr) ){
  144845. sqlite3Fts3Snippet(pContext, pCsr, zStart, zEnd, zEllipsis, iCol, nToken);
  144846. }
  144847. }
  144848. /*
  144849. ** Implementation of the offsets() function for FTS3
  144850. */
  144851. static void fts3OffsetsFunc(
  144852. sqlite3_context *pContext, /* SQLite function call context */
  144853. int nVal, /* Size of argument array */
  144854. sqlite3_value **apVal /* Array of arguments */
  144855. ){
  144856. Fts3Cursor *pCsr; /* Cursor handle passed through apVal[0] */
  144857. UNUSED_PARAMETER(nVal);
  144858. assert( nVal==1 );
  144859. if( fts3FunctionArg(pContext, "offsets", apVal[0], &pCsr) ) return;
  144860. assert( pCsr );
  144861. if( SQLITE_OK==fts3CursorSeek(pContext, pCsr) ){
  144862. sqlite3Fts3Offsets(pContext, pCsr);
  144863. }
  144864. }
  144865. /*
  144866. ** Implementation of the special optimize() function for FTS3. This
  144867. ** function merges all segments in the database to a single segment.
  144868. ** Example usage is:
  144869. **
  144870. ** SELECT optimize(t) FROM t LIMIT 1;
  144871. **
  144872. ** where 't' is the name of an FTS3 table.
  144873. */
  144874. static void fts3OptimizeFunc(
  144875. sqlite3_context *pContext, /* SQLite function call context */
  144876. int nVal, /* Size of argument array */
  144877. sqlite3_value **apVal /* Array of arguments */
  144878. ){
  144879. int rc; /* Return code */
  144880. Fts3Table *p; /* Virtual table handle */
  144881. Fts3Cursor *pCursor; /* Cursor handle passed through apVal[0] */
  144882. UNUSED_PARAMETER(nVal);
  144883. assert( nVal==1 );
  144884. if( fts3FunctionArg(pContext, "optimize", apVal[0], &pCursor) ) return;
  144885. p = (Fts3Table *)pCursor->base.pVtab;
  144886. assert( p );
  144887. rc = sqlite3Fts3Optimize(p);
  144888. switch( rc ){
  144889. case SQLITE_OK:
  144890. sqlite3_result_text(pContext, "Index optimized", -1, SQLITE_STATIC);
  144891. break;
  144892. case SQLITE_DONE:
  144893. sqlite3_result_text(pContext, "Index already optimal", -1, SQLITE_STATIC);
  144894. break;
  144895. default:
  144896. sqlite3_result_error_code(pContext, rc);
  144897. break;
  144898. }
  144899. }
  144900. /*
  144901. ** Implementation of the matchinfo() function for FTS3
  144902. */
  144903. static void fts3MatchinfoFunc(
  144904. sqlite3_context *pContext, /* SQLite function call context */
  144905. int nVal, /* Size of argument array */
  144906. sqlite3_value **apVal /* Array of arguments */
  144907. ){
  144908. Fts3Cursor *pCsr; /* Cursor handle passed through apVal[0] */
  144909. assert( nVal==1 || nVal==2 );
  144910. if( SQLITE_OK==fts3FunctionArg(pContext, "matchinfo", apVal[0], &pCsr) ){
  144911. const char *zArg = 0;
  144912. if( nVal>1 ){
  144913. zArg = (const char *)sqlite3_value_text(apVal[1]);
  144914. }
  144915. sqlite3Fts3Matchinfo(pContext, pCsr, zArg);
  144916. }
  144917. }
  144918. /*
  144919. ** This routine implements the xFindFunction method for the FTS3
  144920. ** virtual table.
  144921. */
  144922. static int fts3FindFunctionMethod(
  144923. sqlite3_vtab *pVtab, /* Virtual table handle */
  144924. int nArg, /* Number of SQL function arguments */
  144925. const char *zName, /* Name of SQL function */
  144926. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), /* OUT: Result */
  144927. void **ppArg /* Unused */
  144928. ){
  144929. struct Overloaded {
  144930. const char *zName;
  144931. void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  144932. } aOverload[] = {
  144933. { "snippet", fts3SnippetFunc },
  144934. { "offsets", fts3OffsetsFunc },
  144935. { "optimize", fts3OptimizeFunc },
  144936. { "matchinfo", fts3MatchinfoFunc },
  144937. };
  144938. int i; /* Iterator variable */
  144939. UNUSED_PARAMETER(pVtab);
  144940. UNUSED_PARAMETER(nArg);
  144941. UNUSED_PARAMETER(ppArg);
  144942. for(i=0; i<SizeofArray(aOverload); i++){
  144943. if( strcmp(zName, aOverload[i].zName)==0 ){
  144944. *pxFunc = aOverload[i].xFunc;
  144945. return 1;
  144946. }
  144947. }
  144948. /* No function of the specified name was found. Return 0. */
  144949. return 0;
  144950. }
  144951. /*
  144952. ** Implementation of FTS3 xRename method. Rename an fts3 table.
  144953. */
  144954. static int fts3RenameMethod(
  144955. sqlite3_vtab *pVtab, /* Virtual table handle */
  144956. const char *zName /* New name of table */
  144957. ){
  144958. Fts3Table *p = (Fts3Table *)pVtab;
  144959. sqlite3 *db = p->db; /* Database connection */
  144960. int rc; /* Return Code */
  144961. /* At this point it must be known if the %_stat table exists or not.
  144962. ** So bHasStat may not be 2. */
  144963. rc = fts3SetHasStat(p);
  144964. /* As it happens, the pending terms table is always empty here. This is
  144965. ** because an "ALTER TABLE RENAME TABLE" statement inside a transaction
  144966. ** always opens a savepoint transaction. And the xSavepoint() method
  144967. ** flushes the pending terms table. But leave the (no-op) call to
  144968. ** PendingTermsFlush() in in case that changes.
  144969. */
  144970. assert( p->nPendingData==0 );
  144971. if( rc==SQLITE_OK ){
  144972. rc = sqlite3Fts3PendingTermsFlush(p);
  144973. }
  144974. if( p->zContentTbl==0 ){
  144975. fts3DbExec(&rc, db,
  144976. "ALTER TABLE %Q.'%q_content' RENAME TO '%q_content';",
  144977. p->zDb, p->zName, zName
  144978. );
  144979. }
  144980. if( p->bHasDocsize ){
  144981. fts3DbExec(&rc, db,
  144982. "ALTER TABLE %Q.'%q_docsize' RENAME TO '%q_docsize';",
  144983. p->zDb, p->zName, zName
  144984. );
  144985. }
  144986. if( p->bHasStat ){
  144987. fts3DbExec(&rc, db,
  144988. "ALTER TABLE %Q.'%q_stat' RENAME TO '%q_stat';",
  144989. p->zDb, p->zName, zName
  144990. );
  144991. }
  144992. fts3DbExec(&rc, db,
  144993. "ALTER TABLE %Q.'%q_segments' RENAME TO '%q_segments';",
  144994. p->zDb, p->zName, zName
  144995. );
  144996. fts3DbExec(&rc, db,
  144997. "ALTER TABLE %Q.'%q_segdir' RENAME TO '%q_segdir';",
  144998. p->zDb, p->zName, zName
  144999. );
  145000. return rc;
  145001. }
  145002. /*
  145003. ** The xSavepoint() method.
  145004. **
  145005. ** Flush the contents of the pending-terms table to disk.
  145006. */
  145007. static int fts3SavepointMethod(sqlite3_vtab *pVtab, int iSavepoint){
  145008. int rc = SQLITE_OK;
  145009. UNUSED_PARAMETER(iSavepoint);
  145010. assert( ((Fts3Table *)pVtab)->inTransaction );
  145011. assert( ((Fts3Table *)pVtab)->mxSavepoint < iSavepoint );
  145012. TESTONLY( ((Fts3Table *)pVtab)->mxSavepoint = iSavepoint );
  145013. if( ((Fts3Table *)pVtab)->bIgnoreSavepoint==0 ){
  145014. rc = fts3SyncMethod(pVtab);
  145015. }
  145016. return rc;
  145017. }
  145018. /*
  145019. ** The xRelease() method.
  145020. **
  145021. ** This is a no-op.
  145022. */
  145023. static int fts3ReleaseMethod(sqlite3_vtab *pVtab, int iSavepoint){
  145024. TESTONLY( Fts3Table *p = (Fts3Table*)pVtab );
  145025. UNUSED_PARAMETER(iSavepoint);
  145026. UNUSED_PARAMETER(pVtab);
  145027. assert( p->inTransaction );
  145028. assert( p->mxSavepoint >= iSavepoint );
  145029. TESTONLY( p->mxSavepoint = iSavepoint-1 );
  145030. return SQLITE_OK;
  145031. }
  145032. /*
  145033. ** The xRollbackTo() method.
  145034. **
  145035. ** Discard the contents of the pending terms table.
  145036. */
  145037. static int fts3RollbackToMethod(sqlite3_vtab *pVtab, int iSavepoint){
  145038. Fts3Table *p = (Fts3Table*)pVtab;
  145039. UNUSED_PARAMETER(iSavepoint);
  145040. assert( p->inTransaction );
  145041. assert( p->mxSavepoint >= iSavepoint );
  145042. TESTONLY( p->mxSavepoint = iSavepoint );
  145043. sqlite3Fts3PendingTermsClear(p);
  145044. return SQLITE_OK;
  145045. }
  145046. static const sqlite3_module fts3Module = {
  145047. /* iVersion */ 2,
  145048. /* xCreate */ fts3CreateMethod,
  145049. /* xConnect */ fts3ConnectMethod,
  145050. /* xBestIndex */ fts3BestIndexMethod,
  145051. /* xDisconnect */ fts3DisconnectMethod,
  145052. /* xDestroy */ fts3DestroyMethod,
  145053. /* xOpen */ fts3OpenMethod,
  145054. /* xClose */ fts3CloseMethod,
  145055. /* xFilter */ fts3FilterMethod,
  145056. /* xNext */ fts3NextMethod,
  145057. /* xEof */ fts3EofMethod,
  145058. /* xColumn */ fts3ColumnMethod,
  145059. /* xRowid */ fts3RowidMethod,
  145060. /* xUpdate */ fts3UpdateMethod,
  145061. /* xBegin */ fts3BeginMethod,
  145062. /* xSync */ fts3SyncMethod,
  145063. /* xCommit */ fts3CommitMethod,
  145064. /* xRollback */ fts3RollbackMethod,
  145065. /* xFindFunction */ fts3FindFunctionMethod,
  145066. /* xRename */ fts3RenameMethod,
  145067. /* xSavepoint */ fts3SavepointMethod,
  145068. /* xRelease */ fts3ReleaseMethod,
  145069. /* xRollbackTo */ fts3RollbackToMethod,
  145070. };
  145071. /*
  145072. ** This function is registered as the module destructor (called when an
  145073. ** FTS3 enabled database connection is closed). It frees the memory
  145074. ** allocated for the tokenizer hash table.
  145075. */
  145076. static void hashDestroy(void *p){
  145077. Fts3Hash *pHash = (Fts3Hash *)p;
  145078. sqlite3Fts3HashClear(pHash);
  145079. sqlite3_free(pHash);
  145080. }
  145081. /*
  145082. ** The fts3 built-in tokenizers - "simple", "porter" and "icu"- are
  145083. ** implemented in files fts3_tokenizer1.c, fts3_porter.c and fts3_icu.c
  145084. ** respectively. The following three forward declarations are for functions
  145085. ** declared in these files used to retrieve the respective implementations.
  145086. **
  145087. ** Calling sqlite3Fts3SimpleTokenizerModule() sets the value pointed
  145088. ** to by the argument to point to the "simple" tokenizer implementation.
  145089. ** And so on.
  145090. */
  145091. SQLITE_PRIVATE void sqlite3Fts3SimpleTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  145092. SQLITE_PRIVATE void sqlite3Fts3PorterTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  145093. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  145094. SQLITE_PRIVATE void sqlite3Fts3UnicodeTokenizer(sqlite3_tokenizer_module const**ppModule);
  145095. #endif
  145096. #ifdef SQLITE_ENABLE_ICU
  145097. SQLITE_PRIVATE void sqlite3Fts3IcuTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  145098. #endif
  145099. /*
  145100. ** Initialize the fts3 extension. If this extension is built as part
  145101. ** of the sqlite library, then this function is called directly by
  145102. ** SQLite. If fts3 is built as a dynamically loadable extension, this
  145103. ** function is called by the sqlite3_extension_init() entry point.
  145104. */
  145105. SQLITE_PRIVATE int sqlite3Fts3Init(sqlite3 *db){
  145106. int rc = SQLITE_OK;
  145107. Fts3Hash *pHash = 0;
  145108. const sqlite3_tokenizer_module *pSimple = 0;
  145109. const sqlite3_tokenizer_module *pPorter = 0;
  145110. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  145111. const sqlite3_tokenizer_module *pUnicode = 0;
  145112. #endif
  145113. #ifdef SQLITE_ENABLE_ICU
  145114. const sqlite3_tokenizer_module *pIcu = 0;
  145115. sqlite3Fts3IcuTokenizerModule(&pIcu);
  145116. #endif
  145117. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  145118. sqlite3Fts3UnicodeTokenizer(&pUnicode);
  145119. #endif
  145120. #ifdef SQLITE_TEST
  145121. rc = sqlite3Fts3InitTerm(db);
  145122. if( rc!=SQLITE_OK ) return rc;
  145123. #endif
  145124. rc = sqlite3Fts3InitAux(db);
  145125. if( rc!=SQLITE_OK ) return rc;
  145126. sqlite3Fts3SimpleTokenizerModule(&pSimple);
  145127. sqlite3Fts3PorterTokenizerModule(&pPorter);
  145128. /* Allocate and initialize the hash-table used to store tokenizers. */
  145129. pHash = sqlite3_malloc(sizeof(Fts3Hash));
  145130. if( !pHash ){
  145131. rc = SQLITE_NOMEM;
  145132. }else{
  145133. sqlite3Fts3HashInit(pHash, FTS3_HASH_STRING, 1);
  145134. }
  145135. /* Load the built-in tokenizers into the hash table */
  145136. if( rc==SQLITE_OK ){
  145137. if( sqlite3Fts3HashInsert(pHash, "simple", 7, (void *)pSimple)
  145138. || sqlite3Fts3HashInsert(pHash, "porter", 7, (void *)pPorter)
  145139. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  145140. || sqlite3Fts3HashInsert(pHash, "unicode61", 10, (void *)pUnicode)
  145141. #endif
  145142. #ifdef SQLITE_ENABLE_ICU
  145143. || (pIcu && sqlite3Fts3HashInsert(pHash, "icu", 4, (void *)pIcu))
  145144. #endif
  145145. ){
  145146. rc = SQLITE_NOMEM;
  145147. }
  145148. }
  145149. #ifdef SQLITE_TEST
  145150. if( rc==SQLITE_OK ){
  145151. rc = sqlite3Fts3ExprInitTestInterface(db);
  145152. }
  145153. #endif
  145154. /* Create the virtual table wrapper around the hash-table and overload
  145155. ** the four scalar functions. If this is successful, register the
  145156. ** module with sqlite.
  145157. */
  145158. if( SQLITE_OK==rc
  145159. && SQLITE_OK==(rc = sqlite3Fts3InitHashTable(db, pHash, "fts3_tokenizer"))
  145160. && SQLITE_OK==(rc = sqlite3_overload_function(db, "snippet", -1))
  145161. && SQLITE_OK==(rc = sqlite3_overload_function(db, "offsets", 1))
  145162. && SQLITE_OK==(rc = sqlite3_overload_function(db, "matchinfo", 1))
  145163. && SQLITE_OK==(rc = sqlite3_overload_function(db, "matchinfo", 2))
  145164. && SQLITE_OK==(rc = sqlite3_overload_function(db, "optimize", 1))
  145165. ){
  145166. rc = sqlite3_create_module_v2(
  145167. db, "fts3", &fts3Module, (void *)pHash, hashDestroy
  145168. );
  145169. if( rc==SQLITE_OK ){
  145170. rc = sqlite3_create_module_v2(
  145171. db, "fts4", &fts3Module, (void *)pHash, 0
  145172. );
  145173. }
  145174. if( rc==SQLITE_OK ){
  145175. rc = sqlite3Fts3InitTok(db, (void *)pHash);
  145176. }
  145177. return rc;
  145178. }
  145179. /* An error has occurred. Delete the hash table and return the error code. */
  145180. assert( rc!=SQLITE_OK );
  145181. if( pHash ){
  145182. sqlite3Fts3HashClear(pHash);
  145183. sqlite3_free(pHash);
  145184. }
  145185. return rc;
  145186. }
  145187. /*
  145188. ** Allocate an Fts3MultiSegReader for each token in the expression headed
  145189. ** by pExpr.
  145190. **
  145191. ** An Fts3SegReader object is a cursor that can seek or scan a range of
  145192. ** entries within a single segment b-tree. An Fts3MultiSegReader uses multiple
  145193. ** Fts3SegReader objects internally to provide an interface to seek or scan
  145194. ** within the union of all segments of a b-tree. Hence the name.
  145195. **
  145196. ** If the allocated Fts3MultiSegReader just seeks to a single entry in a
  145197. ** segment b-tree (if the term is not a prefix or it is a prefix for which
  145198. ** there exists prefix b-tree of the right length) then it may be traversed
  145199. ** and merged incrementally. Otherwise, it has to be merged into an in-memory
  145200. ** doclist and then traversed.
  145201. */
  145202. static void fts3EvalAllocateReaders(
  145203. Fts3Cursor *pCsr, /* FTS cursor handle */
  145204. Fts3Expr *pExpr, /* Allocate readers for this expression */
  145205. int *pnToken, /* OUT: Total number of tokens in phrase. */
  145206. int *pnOr, /* OUT: Total number of OR nodes in expr. */
  145207. int *pRc /* IN/OUT: Error code */
  145208. ){
  145209. if( pExpr && SQLITE_OK==*pRc ){
  145210. if( pExpr->eType==FTSQUERY_PHRASE ){
  145211. int i;
  145212. int nToken = pExpr->pPhrase->nToken;
  145213. *pnToken += nToken;
  145214. for(i=0; i<nToken; i++){
  145215. Fts3PhraseToken *pToken = &pExpr->pPhrase->aToken[i];
  145216. int rc = fts3TermSegReaderCursor(pCsr,
  145217. pToken->z, pToken->n, pToken->isPrefix, &pToken->pSegcsr
  145218. );
  145219. if( rc!=SQLITE_OK ){
  145220. *pRc = rc;
  145221. return;
  145222. }
  145223. }
  145224. assert( pExpr->pPhrase->iDoclistToken==0 );
  145225. pExpr->pPhrase->iDoclistToken = -1;
  145226. }else{
  145227. *pnOr += (pExpr->eType==FTSQUERY_OR);
  145228. fts3EvalAllocateReaders(pCsr, pExpr->pLeft, pnToken, pnOr, pRc);
  145229. fts3EvalAllocateReaders(pCsr, pExpr->pRight, pnToken, pnOr, pRc);
  145230. }
  145231. }
  145232. }
  145233. /*
  145234. ** Arguments pList/nList contain the doclist for token iToken of phrase p.
  145235. ** It is merged into the main doclist stored in p->doclist.aAll/nAll.
  145236. **
  145237. ** This function assumes that pList points to a buffer allocated using
  145238. ** sqlite3_malloc(). This function takes responsibility for eventually
  145239. ** freeing the buffer.
  145240. **
  145241. ** SQLITE_OK is returned if successful, or SQLITE_NOMEM if an error occurs.
  145242. */
  145243. static int fts3EvalPhraseMergeToken(
  145244. Fts3Table *pTab, /* FTS Table pointer */
  145245. Fts3Phrase *p, /* Phrase to merge pList/nList into */
  145246. int iToken, /* Token pList/nList corresponds to */
  145247. char *pList, /* Pointer to doclist */
  145248. int nList /* Number of bytes in pList */
  145249. ){
  145250. int rc = SQLITE_OK;
  145251. assert( iToken!=p->iDoclistToken );
  145252. if( pList==0 ){
  145253. sqlite3_free(p->doclist.aAll);
  145254. p->doclist.aAll = 0;
  145255. p->doclist.nAll = 0;
  145256. }
  145257. else if( p->iDoclistToken<0 ){
  145258. p->doclist.aAll = pList;
  145259. p->doclist.nAll = nList;
  145260. }
  145261. else if( p->doclist.aAll==0 ){
  145262. sqlite3_free(pList);
  145263. }
  145264. else {
  145265. char *pLeft;
  145266. char *pRight;
  145267. int nLeft;
  145268. int nRight;
  145269. int nDiff;
  145270. if( p->iDoclistToken<iToken ){
  145271. pLeft = p->doclist.aAll;
  145272. nLeft = p->doclist.nAll;
  145273. pRight = pList;
  145274. nRight = nList;
  145275. nDiff = iToken - p->iDoclistToken;
  145276. }else{
  145277. pRight = p->doclist.aAll;
  145278. nRight = p->doclist.nAll;
  145279. pLeft = pList;
  145280. nLeft = nList;
  145281. nDiff = p->iDoclistToken - iToken;
  145282. }
  145283. rc = fts3DoclistPhraseMerge(
  145284. pTab->bDescIdx, nDiff, pLeft, nLeft, &pRight, &nRight
  145285. );
  145286. sqlite3_free(pLeft);
  145287. p->doclist.aAll = pRight;
  145288. p->doclist.nAll = nRight;
  145289. }
  145290. if( iToken>p->iDoclistToken ) p->iDoclistToken = iToken;
  145291. return rc;
  145292. }
  145293. /*
  145294. ** Load the doclist for phrase p into p->doclist.aAll/nAll. The loaded doclist
  145295. ** does not take deferred tokens into account.
  145296. **
  145297. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  145298. */
  145299. static int fts3EvalPhraseLoad(
  145300. Fts3Cursor *pCsr, /* FTS Cursor handle */
  145301. Fts3Phrase *p /* Phrase object */
  145302. ){
  145303. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  145304. int iToken;
  145305. int rc = SQLITE_OK;
  145306. for(iToken=0; rc==SQLITE_OK && iToken<p->nToken; iToken++){
  145307. Fts3PhraseToken *pToken = &p->aToken[iToken];
  145308. assert( pToken->pDeferred==0 || pToken->pSegcsr==0 );
  145309. if( pToken->pSegcsr ){
  145310. int nThis = 0;
  145311. char *pThis = 0;
  145312. rc = fts3TermSelect(pTab, pToken, p->iColumn, &nThis, &pThis);
  145313. if( rc==SQLITE_OK ){
  145314. rc = fts3EvalPhraseMergeToken(pTab, p, iToken, pThis, nThis);
  145315. }
  145316. }
  145317. assert( pToken->pSegcsr==0 );
  145318. }
  145319. return rc;
  145320. }
  145321. /*
  145322. ** This function is called on each phrase after the position lists for
  145323. ** any deferred tokens have been loaded into memory. It updates the phrases
  145324. ** current position list to include only those positions that are really
  145325. ** instances of the phrase (after considering deferred tokens). If this
  145326. ** means that the phrase does not appear in the current row, doclist.pList
  145327. ** and doclist.nList are both zeroed.
  145328. **
  145329. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  145330. */
  145331. static int fts3EvalDeferredPhrase(Fts3Cursor *pCsr, Fts3Phrase *pPhrase){
  145332. int iToken; /* Used to iterate through phrase tokens */
  145333. char *aPoslist = 0; /* Position list for deferred tokens */
  145334. int nPoslist = 0; /* Number of bytes in aPoslist */
  145335. int iPrev = -1; /* Token number of previous deferred token */
  145336. assert( pPhrase->doclist.bFreeList==0 );
  145337. for(iToken=0; iToken<pPhrase->nToken; iToken++){
  145338. Fts3PhraseToken *pToken = &pPhrase->aToken[iToken];
  145339. Fts3DeferredToken *pDeferred = pToken->pDeferred;
  145340. if( pDeferred ){
  145341. char *pList;
  145342. int nList;
  145343. int rc = sqlite3Fts3DeferredTokenList(pDeferred, &pList, &nList);
  145344. if( rc!=SQLITE_OK ) return rc;
  145345. if( pList==0 ){
  145346. sqlite3_free(aPoslist);
  145347. pPhrase->doclist.pList = 0;
  145348. pPhrase->doclist.nList = 0;
  145349. return SQLITE_OK;
  145350. }else if( aPoslist==0 ){
  145351. aPoslist = pList;
  145352. nPoslist = nList;
  145353. }else{
  145354. char *aOut = pList;
  145355. char *p1 = aPoslist;
  145356. char *p2 = aOut;
  145357. assert( iPrev>=0 );
  145358. fts3PoslistPhraseMerge(&aOut, iToken-iPrev, 0, 1, &p1, &p2);
  145359. sqlite3_free(aPoslist);
  145360. aPoslist = pList;
  145361. nPoslist = (int)(aOut - aPoslist);
  145362. if( nPoslist==0 ){
  145363. sqlite3_free(aPoslist);
  145364. pPhrase->doclist.pList = 0;
  145365. pPhrase->doclist.nList = 0;
  145366. return SQLITE_OK;
  145367. }
  145368. }
  145369. iPrev = iToken;
  145370. }
  145371. }
  145372. if( iPrev>=0 ){
  145373. int nMaxUndeferred = pPhrase->iDoclistToken;
  145374. if( nMaxUndeferred<0 ){
  145375. pPhrase->doclist.pList = aPoslist;
  145376. pPhrase->doclist.nList = nPoslist;
  145377. pPhrase->doclist.iDocid = pCsr->iPrevId;
  145378. pPhrase->doclist.bFreeList = 1;
  145379. }else{
  145380. int nDistance;
  145381. char *p1;
  145382. char *p2;
  145383. char *aOut;
  145384. if( nMaxUndeferred>iPrev ){
  145385. p1 = aPoslist;
  145386. p2 = pPhrase->doclist.pList;
  145387. nDistance = nMaxUndeferred - iPrev;
  145388. }else{
  145389. p1 = pPhrase->doclist.pList;
  145390. p2 = aPoslist;
  145391. nDistance = iPrev - nMaxUndeferred;
  145392. }
  145393. aOut = (char *)sqlite3_malloc(nPoslist+8);
  145394. if( !aOut ){
  145395. sqlite3_free(aPoslist);
  145396. return SQLITE_NOMEM;
  145397. }
  145398. pPhrase->doclist.pList = aOut;
  145399. if( fts3PoslistPhraseMerge(&aOut, nDistance, 0, 1, &p1, &p2) ){
  145400. pPhrase->doclist.bFreeList = 1;
  145401. pPhrase->doclist.nList = (int)(aOut - pPhrase->doclist.pList);
  145402. }else{
  145403. sqlite3_free(aOut);
  145404. pPhrase->doclist.pList = 0;
  145405. pPhrase->doclist.nList = 0;
  145406. }
  145407. sqlite3_free(aPoslist);
  145408. }
  145409. }
  145410. return SQLITE_OK;
  145411. }
  145412. /*
  145413. ** Maximum number of tokens a phrase may have to be considered for the
  145414. ** incremental doclists strategy.
  145415. */
  145416. #define MAX_INCR_PHRASE_TOKENS 4
  145417. /*
  145418. ** This function is called for each Fts3Phrase in a full-text query
  145419. ** expression to initialize the mechanism for returning rows. Once this
  145420. ** function has been called successfully on an Fts3Phrase, it may be
  145421. ** used with fts3EvalPhraseNext() to iterate through the matching docids.
  145422. **
  145423. ** If parameter bOptOk is true, then the phrase may (or may not) use the
  145424. ** incremental loading strategy. Otherwise, the entire doclist is loaded into
  145425. ** memory within this call.
  145426. **
  145427. ** SQLITE_OK is returned if no error occurs, otherwise an SQLite error code.
  145428. */
  145429. static int fts3EvalPhraseStart(Fts3Cursor *pCsr, int bOptOk, Fts3Phrase *p){
  145430. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  145431. int rc = SQLITE_OK; /* Error code */
  145432. int i;
  145433. /* Determine if doclists may be loaded from disk incrementally. This is
  145434. ** possible if the bOptOk argument is true, the FTS doclists will be
  145435. ** scanned in forward order, and the phrase consists of
  145436. ** MAX_INCR_PHRASE_TOKENS or fewer tokens, none of which are are "^first"
  145437. ** tokens or prefix tokens that cannot use a prefix-index. */
  145438. int bHaveIncr = 0;
  145439. int bIncrOk = (bOptOk
  145440. && pCsr->bDesc==pTab->bDescIdx
  145441. && p->nToken<=MAX_INCR_PHRASE_TOKENS && p->nToken>0
  145442. #ifdef SQLITE_TEST
  145443. && pTab->bNoIncrDoclist==0
  145444. #endif
  145445. );
  145446. for(i=0; bIncrOk==1 && i<p->nToken; i++){
  145447. Fts3PhraseToken *pToken = &p->aToken[i];
  145448. if( pToken->bFirst || (pToken->pSegcsr!=0 && !pToken->pSegcsr->bLookup) ){
  145449. bIncrOk = 0;
  145450. }
  145451. if( pToken->pSegcsr ) bHaveIncr = 1;
  145452. }
  145453. if( bIncrOk && bHaveIncr ){
  145454. /* Use the incremental approach. */
  145455. int iCol = (p->iColumn >= pTab->nColumn ? -1 : p->iColumn);
  145456. for(i=0; rc==SQLITE_OK && i<p->nToken; i++){
  145457. Fts3PhraseToken *pToken = &p->aToken[i];
  145458. Fts3MultiSegReader *pSegcsr = pToken->pSegcsr;
  145459. if( pSegcsr ){
  145460. rc = sqlite3Fts3MsrIncrStart(pTab, pSegcsr, iCol, pToken->z, pToken->n);
  145461. }
  145462. }
  145463. p->bIncr = 1;
  145464. }else{
  145465. /* Load the full doclist for the phrase into memory. */
  145466. rc = fts3EvalPhraseLoad(pCsr, p);
  145467. p->bIncr = 0;
  145468. }
  145469. assert( rc!=SQLITE_OK || p->nToken<1 || p->aToken[0].pSegcsr==0 || p->bIncr );
  145470. return rc;
  145471. }
  145472. /*
  145473. ** This function is used to iterate backwards (from the end to start)
  145474. ** through doclists. It is used by this module to iterate through phrase
  145475. ** doclists in reverse and by the fts3_write.c module to iterate through
  145476. ** pending-terms lists when writing to databases with "order=desc".
  145477. **
  145478. ** The doclist may be sorted in ascending (parameter bDescIdx==0) or
  145479. ** descending (parameter bDescIdx==1) order of docid. Regardless, this
  145480. ** function iterates from the end of the doclist to the beginning.
  145481. */
  145482. SQLITE_PRIVATE void sqlite3Fts3DoclistPrev(
  145483. int bDescIdx, /* True if the doclist is desc */
  145484. char *aDoclist, /* Pointer to entire doclist */
  145485. int nDoclist, /* Length of aDoclist in bytes */
  145486. char **ppIter, /* IN/OUT: Iterator pointer */
  145487. sqlite3_int64 *piDocid, /* IN/OUT: Docid pointer */
  145488. int *pnList, /* OUT: List length pointer */
  145489. u8 *pbEof /* OUT: End-of-file flag */
  145490. ){
  145491. char *p = *ppIter;
  145492. assert( nDoclist>0 );
  145493. assert( *pbEof==0 );
  145494. assert( p || *piDocid==0 );
  145495. assert( !p || (p>aDoclist && p<&aDoclist[nDoclist]) );
  145496. if( p==0 ){
  145497. sqlite3_int64 iDocid = 0;
  145498. char *pNext = 0;
  145499. char *pDocid = aDoclist;
  145500. char *pEnd = &aDoclist[nDoclist];
  145501. int iMul = 1;
  145502. while( pDocid<pEnd ){
  145503. sqlite3_int64 iDelta;
  145504. pDocid += sqlite3Fts3GetVarint(pDocid, &iDelta);
  145505. iDocid += (iMul * iDelta);
  145506. pNext = pDocid;
  145507. fts3PoslistCopy(0, &pDocid);
  145508. while( pDocid<pEnd && *pDocid==0 ) pDocid++;
  145509. iMul = (bDescIdx ? -1 : 1);
  145510. }
  145511. *pnList = (int)(pEnd - pNext);
  145512. *ppIter = pNext;
  145513. *piDocid = iDocid;
  145514. }else{
  145515. int iMul = (bDescIdx ? -1 : 1);
  145516. sqlite3_int64 iDelta;
  145517. fts3GetReverseVarint(&p, aDoclist, &iDelta);
  145518. *piDocid -= (iMul * iDelta);
  145519. if( p==aDoclist ){
  145520. *pbEof = 1;
  145521. }else{
  145522. char *pSave = p;
  145523. fts3ReversePoslist(aDoclist, &p);
  145524. *pnList = (int)(pSave - p);
  145525. }
  145526. *ppIter = p;
  145527. }
  145528. }
  145529. /*
  145530. ** Iterate forwards through a doclist.
  145531. */
  145532. SQLITE_PRIVATE void sqlite3Fts3DoclistNext(
  145533. int bDescIdx, /* True if the doclist is desc */
  145534. char *aDoclist, /* Pointer to entire doclist */
  145535. int nDoclist, /* Length of aDoclist in bytes */
  145536. char **ppIter, /* IN/OUT: Iterator pointer */
  145537. sqlite3_int64 *piDocid, /* IN/OUT: Docid pointer */
  145538. u8 *pbEof /* OUT: End-of-file flag */
  145539. ){
  145540. char *p = *ppIter;
  145541. assert( nDoclist>0 );
  145542. assert( *pbEof==0 );
  145543. assert( p || *piDocid==0 );
  145544. assert( !p || (p>=aDoclist && p<=&aDoclist[nDoclist]) );
  145545. if( p==0 ){
  145546. p = aDoclist;
  145547. p += sqlite3Fts3GetVarint(p, piDocid);
  145548. }else{
  145549. fts3PoslistCopy(0, &p);
  145550. while( p<&aDoclist[nDoclist] && *p==0 ) p++;
  145551. if( p>=&aDoclist[nDoclist] ){
  145552. *pbEof = 1;
  145553. }else{
  145554. sqlite3_int64 iVar;
  145555. p += sqlite3Fts3GetVarint(p, &iVar);
  145556. *piDocid += ((bDescIdx ? -1 : 1) * iVar);
  145557. }
  145558. }
  145559. *ppIter = p;
  145560. }
  145561. /*
  145562. ** Advance the iterator pDL to the next entry in pDL->aAll/nAll. Set *pbEof
  145563. ** to true if EOF is reached.
  145564. */
  145565. static void fts3EvalDlPhraseNext(
  145566. Fts3Table *pTab,
  145567. Fts3Doclist *pDL,
  145568. u8 *pbEof
  145569. ){
  145570. char *pIter; /* Used to iterate through aAll */
  145571. char *pEnd = &pDL->aAll[pDL->nAll]; /* 1 byte past end of aAll */
  145572. if( pDL->pNextDocid ){
  145573. pIter = pDL->pNextDocid;
  145574. }else{
  145575. pIter = pDL->aAll;
  145576. }
  145577. if( pIter>=pEnd ){
  145578. /* We have already reached the end of this doclist. EOF. */
  145579. *pbEof = 1;
  145580. }else{
  145581. sqlite3_int64 iDelta;
  145582. pIter += sqlite3Fts3GetVarint(pIter, &iDelta);
  145583. if( pTab->bDescIdx==0 || pDL->pNextDocid==0 ){
  145584. pDL->iDocid += iDelta;
  145585. }else{
  145586. pDL->iDocid -= iDelta;
  145587. }
  145588. pDL->pList = pIter;
  145589. fts3PoslistCopy(0, &pIter);
  145590. pDL->nList = (int)(pIter - pDL->pList);
  145591. /* pIter now points just past the 0x00 that terminates the position-
  145592. ** list for document pDL->iDocid. However, if this position-list was
  145593. ** edited in place by fts3EvalNearTrim(), then pIter may not actually
  145594. ** point to the start of the next docid value. The following line deals
  145595. ** with this case by advancing pIter past the zero-padding added by
  145596. ** fts3EvalNearTrim(). */
  145597. while( pIter<pEnd && *pIter==0 ) pIter++;
  145598. pDL->pNextDocid = pIter;
  145599. assert( pIter>=&pDL->aAll[pDL->nAll] || *pIter );
  145600. *pbEof = 0;
  145601. }
  145602. }
  145603. /*
  145604. ** Helper type used by fts3EvalIncrPhraseNext() and incrPhraseTokenNext().
  145605. */
  145606. typedef struct TokenDoclist TokenDoclist;
  145607. struct TokenDoclist {
  145608. int bIgnore;
  145609. sqlite3_int64 iDocid;
  145610. char *pList;
  145611. int nList;
  145612. };
  145613. /*
  145614. ** Token pToken is an incrementally loaded token that is part of a
  145615. ** multi-token phrase. Advance it to the next matching document in the
  145616. ** database and populate output variable *p with the details of the new
  145617. ** entry. Or, if the iterator has reached EOF, set *pbEof to true.
  145618. **
  145619. ** If an error occurs, return an SQLite error code. Otherwise, return
  145620. ** SQLITE_OK.
  145621. */
  145622. static int incrPhraseTokenNext(
  145623. Fts3Table *pTab, /* Virtual table handle */
  145624. Fts3Phrase *pPhrase, /* Phrase to advance token of */
  145625. int iToken, /* Specific token to advance */
  145626. TokenDoclist *p, /* OUT: Docid and doclist for new entry */
  145627. u8 *pbEof /* OUT: True if iterator is at EOF */
  145628. ){
  145629. int rc = SQLITE_OK;
  145630. if( pPhrase->iDoclistToken==iToken ){
  145631. assert( p->bIgnore==0 );
  145632. assert( pPhrase->aToken[iToken].pSegcsr==0 );
  145633. fts3EvalDlPhraseNext(pTab, &pPhrase->doclist, pbEof);
  145634. p->pList = pPhrase->doclist.pList;
  145635. p->nList = pPhrase->doclist.nList;
  145636. p->iDocid = pPhrase->doclist.iDocid;
  145637. }else{
  145638. Fts3PhraseToken *pToken = &pPhrase->aToken[iToken];
  145639. assert( pToken->pDeferred==0 );
  145640. assert( pToken->pSegcsr || pPhrase->iDoclistToken>=0 );
  145641. if( pToken->pSegcsr ){
  145642. assert( p->bIgnore==0 );
  145643. rc = sqlite3Fts3MsrIncrNext(
  145644. pTab, pToken->pSegcsr, &p->iDocid, &p->pList, &p->nList
  145645. );
  145646. if( p->pList==0 ) *pbEof = 1;
  145647. }else{
  145648. p->bIgnore = 1;
  145649. }
  145650. }
  145651. return rc;
  145652. }
  145653. /*
  145654. ** The phrase iterator passed as the second argument:
  145655. **
  145656. ** * features at least one token that uses an incremental doclist, and
  145657. **
  145658. ** * does not contain any deferred tokens.
  145659. **
  145660. ** Advance it to the next matching documnent in the database and populate
  145661. ** the Fts3Doclist.pList and nList fields.
  145662. **
  145663. ** If there is no "next" entry and no error occurs, then *pbEof is set to
  145664. ** 1 before returning. Otherwise, if no error occurs and the iterator is
  145665. ** successfully advanced, *pbEof is set to 0.
  145666. **
  145667. ** If an error occurs, return an SQLite error code. Otherwise, return
  145668. ** SQLITE_OK.
  145669. */
  145670. static int fts3EvalIncrPhraseNext(
  145671. Fts3Cursor *pCsr, /* FTS Cursor handle */
  145672. Fts3Phrase *p, /* Phrase object to advance to next docid */
  145673. u8 *pbEof /* OUT: Set to 1 if EOF */
  145674. ){
  145675. int rc = SQLITE_OK;
  145676. Fts3Doclist *pDL = &p->doclist;
  145677. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  145678. u8 bEof = 0;
  145679. /* This is only called if it is guaranteed that the phrase has at least
  145680. ** one incremental token. In which case the bIncr flag is set. */
  145681. assert( p->bIncr==1 );
  145682. if( p->nToken==1 ){
  145683. rc = sqlite3Fts3MsrIncrNext(pTab, p->aToken[0].pSegcsr,
  145684. &pDL->iDocid, &pDL->pList, &pDL->nList
  145685. );
  145686. if( pDL->pList==0 ) bEof = 1;
  145687. }else{
  145688. int bDescDoclist = pCsr->bDesc;
  145689. struct TokenDoclist a[MAX_INCR_PHRASE_TOKENS];
  145690. memset(a, 0, sizeof(a));
  145691. assert( p->nToken<=MAX_INCR_PHRASE_TOKENS );
  145692. assert( p->iDoclistToken<MAX_INCR_PHRASE_TOKENS );
  145693. while( bEof==0 ){
  145694. int bMaxSet = 0;
  145695. sqlite3_int64 iMax = 0; /* Largest docid for all iterators */
  145696. int i; /* Used to iterate through tokens */
  145697. /* Advance the iterator for each token in the phrase once. */
  145698. for(i=0; rc==SQLITE_OK && i<p->nToken && bEof==0; i++){
  145699. rc = incrPhraseTokenNext(pTab, p, i, &a[i], &bEof);
  145700. if( a[i].bIgnore==0 && (bMaxSet==0 || DOCID_CMP(iMax, a[i].iDocid)<0) ){
  145701. iMax = a[i].iDocid;
  145702. bMaxSet = 1;
  145703. }
  145704. }
  145705. assert( rc!=SQLITE_OK || (p->nToken>=1 && a[p->nToken-1].bIgnore==0) );
  145706. assert( rc!=SQLITE_OK || bMaxSet );
  145707. /* Keep advancing iterators until they all point to the same document */
  145708. for(i=0; i<p->nToken; i++){
  145709. while( rc==SQLITE_OK && bEof==0
  145710. && a[i].bIgnore==0 && DOCID_CMP(a[i].iDocid, iMax)<0
  145711. ){
  145712. rc = incrPhraseTokenNext(pTab, p, i, &a[i], &bEof);
  145713. if( DOCID_CMP(a[i].iDocid, iMax)>0 ){
  145714. iMax = a[i].iDocid;
  145715. i = 0;
  145716. }
  145717. }
  145718. }
  145719. /* Check if the current entries really are a phrase match */
  145720. if( bEof==0 ){
  145721. int nList = 0;
  145722. int nByte = a[p->nToken-1].nList;
  145723. char *aDoclist = sqlite3_malloc(nByte+1);
  145724. if( !aDoclist ) return SQLITE_NOMEM;
  145725. memcpy(aDoclist, a[p->nToken-1].pList, nByte+1);
  145726. for(i=0; i<(p->nToken-1); i++){
  145727. if( a[i].bIgnore==0 ){
  145728. char *pL = a[i].pList;
  145729. char *pR = aDoclist;
  145730. char *pOut = aDoclist;
  145731. int nDist = p->nToken-1-i;
  145732. int res = fts3PoslistPhraseMerge(&pOut, nDist, 0, 1, &pL, &pR);
  145733. if( res==0 ) break;
  145734. nList = (int)(pOut - aDoclist);
  145735. }
  145736. }
  145737. if( i==(p->nToken-1) ){
  145738. pDL->iDocid = iMax;
  145739. pDL->pList = aDoclist;
  145740. pDL->nList = nList;
  145741. pDL->bFreeList = 1;
  145742. break;
  145743. }
  145744. sqlite3_free(aDoclist);
  145745. }
  145746. }
  145747. }
  145748. *pbEof = bEof;
  145749. return rc;
  145750. }
  145751. /*
  145752. ** Attempt to move the phrase iterator to point to the next matching docid.
  145753. ** If an error occurs, return an SQLite error code. Otherwise, return
  145754. ** SQLITE_OK.
  145755. **
  145756. ** If there is no "next" entry and no error occurs, then *pbEof is set to
  145757. ** 1 before returning. Otherwise, if no error occurs and the iterator is
  145758. ** successfully advanced, *pbEof is set to 0.
  145759. */
  145760. static int fts3EvalPhraseNext(
  145761. Fts3Cursor *pCsr, /* FTS Cursor handle */
  145762. Fts3Phrase *p, /* Phrase object to advance to next docid */
  145763. u8 *pbEof /* OUT: Set to 1 if EOF */
  145764. ){
  145765. int rc = SQLITE_OK;
  145766. Fts3Doclist *pDL = &p->doclist;
  145767. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  145768. if( p->bIncr ){
  145769. rc = fts3EvalIncrPhraseNext(pCsr, p, pbEof);
  145770. }else if( pCsr->bDesc!=pTab->bDescIdx && pDL->nAll ){
  145771. sqlite3Fts3DoclistPrev(pTab->bDescIdx, pDL->aAll, pDL->nAll,
  145772. &pDL->pNextDocid, &pDL->iDocid, &pDL->nList, pbEof
  145773. );
  145774. pDL->pList = pDL->pNextDocid;
  145775. }else{
  145776. fts3EvalDlPhraseNext(pTab, pDL, pbEof);
  145777. }
  145778. return rc;
  145779. }
  145780. /*
  145781. **
  145782. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  145783. ** Otherwise, fts3EvalPhraseStart() is called on all phrases within the
  145784. ** expression. Also the Fts3Expr.bDeferred variable is set to true for any
  145785. ** expressions for which all descendent tokens are deferred.
  145786. **
  145787. ** If parameter bOptOk is zero, then it is guaranteed that the
  145788. ** Fts3Phrase.doclist.aAll/nAll variables contain the entire doclist for
  145789. ** each phrase in the expression (subject to deferred token processing).
  145790. ** Or, if bOptOk is non-zero, then one or more tokens within the expression
  145791. ** may be loaded incrementally, meaning doclist.aAll/nAll is not available.
  145792. **
  145793. ** If an error occurs within this function, *pRc is set to an SQLite error
  145794. ** code before returning.
  145795. */
  145796. static void fts3EvalStartReaders(
  145797. Fts3Cursor *pCsr, /* FTS Cursor handle */
  145798. Fts3Expr *pExpr, /* Expression to initialize phrases in */
  145799. int *pRc /* IN/OUT: Error code */
  145800. ){
  145801. if( pExpr && SQLITE_OK==*pRc ){
  145802. if( pExpr->eType==FTSQUERY_PHRASE ){
  145803. int nToken = pExpr->pPhrase->nToken;
  145804. if( nToken ){
  145805. int i;
  145806. for(i=0; i<nToken; i++){
  145807. if( pExpr->pPhrase->aToken[i].pDeferred==0 ) break;
  145808. }
  145809. pExpr->bDeferred = (i==nToken);
  145810. }
  145811. *pRc = fts3EvalPhraseStart(pCsr, 1, pExpr->pPhrase);
  145812. }else{
  145813. fts3EvalStartReaders(pCsr, pExpr->pLeft, pRc);
  145814. fts3EvalStartReaders(pCsr, pExpr->pRight, pRc);
  145815. pExpr->bDeferred = (pExpr->pLeft->bDeferred && pExpr->pRight->bDeferred);
  145816. }
  145817. }
  145818. }
  145819. /*
  145820. ** An array of the following structures is assembled as part of the process
  145821. ** of selecting tokens to defer before the query starts executing (as part
  145822. ** of the xFilter() method). There is one element in the array for each
  145823. ** token in the FTS expression.
  145824. **
  145825. ** Tokens are divided into AND/NEAR clusters. All tokens in a cluster belong
  145826. ** to phrases that are connected only by AND and NEAR operators (not OR or
  145827. ** NOT). When determining tokens to defer, each AND/NEAR cluster is considered
  145828. ** separately. The root of a tokens AND/NEAR cluster is stored in
  145829. ** Fts3TokenAndCost.pRoot.
  145830. */
  145831. typedef struct Fts3TokenAndCost Fts3TokenAndCost;
  145832. struct Fts3TokenAndCost {
  145833. Fts3Phrase *pPhrase; /* The phrase the token belongs to */
  145834. int iToken; /* Position of token in phrase */
  145835. Fts3PhraseToken *pToken; /* The token itself */
  145836. Fts3Expr *pRoot; /* Root of NEAR/AND cluster */
  145837. int nOvfl; /* Number of overflow pages to load doclist */
  145838. int iCol; /* The column the token must match */
  145839. };
  145840. /*
  145841. ** This function is used to populate an allocated Fts3TokenAndCost array.
  145842. **
  145843. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  145844. ** Otherwise, if an error occurs during execution, *pRc is set to an
  145845. ** SQLite error code.
  145846. */
  145847. static void fts3EvalTokenCosts(
  145848. Fts3Cursor *pCsr, /* FTS Cursor handle */
  145849. Fts3Expr *pRoot, /* Root of current AND/NEAR cluster */
  145850. Fts3Expr *pExpr, /* Expression to consider */
  145851. Fts3TokenAndCost **ppTC, /* Write new entries to *(*ppTC)++ */
  145852. Fts3Expr ***ppOr, /* Write new OR root to *(*ppOr)++ */
  145853. int *pRc /* IN/OUT: Error code */
  145854. ){
  145855. if( *pRc==SQLITE_OK ){
  145856. if( pExpr->eType==FTSQUERY_PHRASE ){
  145857. Fts3Phrase *pPhrase = pExpr->pPhrase;
  145858. int i;
  145859. for(i=0; *pRc==SQLITE_OK && i<pPhrase->nToken; i++){
  145860. Fts3TokenAndCost *pTC = (*ppTC)++;
  145861. pTC->pPhrase = pPhrase;
  145862. pTC->iToken = i;
  145863. pTC->pRoot = pRoot;
  145864. pTC->pToken = &pPhrase->aToken[i];
  145865. pTC->iCol = pPhrase->iColumn;
  145866. *pRc = sqlite3Fts3MsrOvfl(pCsr, pTC->pToken->pSegcsr, &pTC->nOvfl);
  145867. }
  145868. }else if( pExpr->eType!=FTSQUERY_NOT ){
  145869. assert( pExpr->eType==FTSQUERY_OR
  145870. || pExpr->eType==FTSQUERY_AND
  145871. || pExpr->eType==FTSQUERY_NEAR
  145872. );
  145873. assert( pExpr->pLeft && pExpr->pRight );
  145874. if( pExpr->eType==FTSQUERY_OR ){
  145875. pRoot = pExpr->pLeft;
  145876. **ppOr = pRoot;
  145877. (*ppOr)++;
  145878. }
  145879. fts3EvalTokenCosts(pCsr, pRoot, pExpr->pLeft, ppTC, ppOr, pRc);
  145880. if( pExpr->eType==FTSQUERY_OR ){
  145881. pRoot = pExpr->pRight;
  145882. **ppOr = pRoot;
  145883. (*ppOr)++;
  145884. }
  145885. fts3EvalTokenCosts(pCsr, pRoot, pExpr->pRight, ppTC, ppOr, pRc);
  145886. }
  145887. }
  145888. }
  145889. /*
  145890. ** Determine the average document (row) size in pages. If successful,
  145891. ** write this value to *pnPage and return SQLITE_OK. Otherwise, return
  145892. ** an SQLite error code.
  145893. **
  145894. ** The average document size in pages is calculated by first calculating
  145895. ** determining the average size in bytes, B. If B is less than the amount
  145896. ** of data that will fit on a single leaf page of an intkey table in
  145897. ** this database, then the average docsize is 1. Otherwise, it is 1 plus
  145898. ** the number of overflow pages consumed by a record B bytes in size.
  145899. */
  145900. static int fts3EvalAverageDocsize(Fts3Cursor *pCsr, int *pnPage){
  145901. int rc = SQLITE_OK;
  145902. if( pCsr->nRowAvg==0 ){
  145903. /* The average document size, which is required to calculate the cost
  145904. ** of each doclist, has not yet been determined. Read the required
  145905. ** data from the %_stat table to calculate it.
  145906. **
  145907. ** Entry 0 of the %_stat table is a blob containing (nCol+1) FTS3
  145908. ** varints, where nCol is the number of columns in the FTS3 table.
  145909. ** The first varint is the number of documents currently stored in
  145910. ** the table. The following nCol varints contain the total amount of
  145911. ** data stored in all rows of each column of the table, from left
  145912. ** to right.
  145913. */
  145914. Fts3Table *p = (Fts3Table*)pCsr->base.pVtab;
  145915. sqlite3_stmt *pStmt;
  145916. sqlite3_int64 nDoc = 0;
  145917. sqlite3_int64 nByte = 0;
  145918. const char *pEnd;
  145919. const char *a;
  145920. rc = sqlite3Fts3SelectDoctotal(p, &pStmt);
  145921. if( rc!=SQLITE_OK ) return rc;
  145922. a = sqlite3_column_blob(pStmt, 0);
  145923. assert( a );
  145924. pEnd = &a[sqlite3_column_bytes(pStmt, 0)];
  145925. a += sqlite3Fts3GetVarint(a, &nDoc);
  145926. while( a<pEnd ){
  145927. a += sqlite3Fts3GetVarint(a, &nByte);
  145928. }
  145929. if( nDoc==0 || nByte==0 ){
  145930. sqlite3_reset(pStmt);
  145931. return FTS_CORRUPT_VTAB;
  145932. }
  145933. pCsr->nDoc = nDoc;
  145934. pCsr->nRowAvg = (int)(((nByte / nDoc) + p->nPgsz) / p->nPgsz);
  145935. assert( pCsr->nRowAvg>0 );
  145936. rc = sqlite3_reset(pStmt);
  145937. }
  145938. *pnPage = pCsr->nRowAvg;
  145939. return rc;
  145940. }
  145941. /*
  145942. ** This function is called to select the tokens (if any) that will be
  145943. ** deferred. The array aTC[] has already been populated when this is
  145944. ** called.
  145945. **
  145946. ** This function is called once for each AND/NEAR cluster in the
  145947. ** expression. Each invocation determines which tokens to defer within
  145948. ** the cluster with root node pRoot. See comments above the definition
  145949. ** of struct Fts3TokenAndCost for more details.
  145950. **
  145951. ** If no error occurs, SQLITE_OK is returned and sqlite3Fts3DeferToken()
  145952. ** called on each token to defer. Otherwise, an SQLite error code is
  145953. ** returned.
  145954. */
  145955. static int fts3EvalSelectDeferred(
  145956. Fts3Cursor *pCsr, /* FTS Cursor handle */
  145957. Fts3Expr *pRoot, /* Consider tokens with this root node */
  145958. Fts3TokenAndCost *aTC, /* Array of expression tokens and costs */
  145959. int nTC /* Number of entries in aTC[] */
  145960. ){
  145961. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  145962. int nDocSize = 0; /* Number of pages per doc loaded */
  145963. int rc = SQLITE_OK; /* Return code */
  145964. int ii; /* Iterator variable for various purposes */
  145965. int nOvfl = 0; /* Total overflow pages used by doclists */
  145966. int nToken = 0; /* Total number of tokens in cluster */
  145967. int nMinEst = 0; /* The minimum count for any phrase so far. */
  145968. int nLoad4 = 1; /* (Phrases that will be loaded)^4. */
  145969. /* Tokens are never deferred for FTS tables created using the content=xxx
  145970. ** option. The reason being that it is not guaranteed that the content
  145971. ** table actually contains the same data as the index. To prevent this from
  145972. ** causing any problems, the deferred token optimization is completely
  145973. ** disabled for content=xxx tables. */
  145974. if( pTab->zContentTbl ){
  145975. return SQLITE_OK;
  145976. }
  145977. /* Count the tokens in this AND/NEAR cluster. If none of the doclists
  145978. ** associated with the tokens spill onto overflow pages, or if there is
  145979. ** only 1 token, exit early. No tokens to defer in this case. */
  145980. for(ii=0; ii<nTC; ii++){
  145981. if( aTC[ii].pRoot==pRoot ){
  145982. nOvfl += aTC[ii].nOvfl;
  145983. nToken++;
  145984. }
  145985. }
  145986. if( nOvfl==0 || nToken<2 ) return SQLITE_OK;
  145987. /* Obtain the average docsize (in pages). */
  145988. rc = fts3EvalAverageDocsize(pCsr, &nDocSize);
  145989. assert( rc!=SQLITE_OK || nDocSize>0 );
  145990. /* Iterate through all tokens in this AND/NEAR cluster, in ascending order
  145991. ** of the number of overflow pages that will be loaded by the pager layer
  145992. ** to retrieve the entire doclist for the token from the full-text index.
  145993. ** Load the doclists for tokens that are either:
  145994. **
  145995. ** a. The cheapest token in the entire query (i.e. the one visited by the
  145996. ** first iteration of this loop), or
  145997. **
  145998. ** b. Part of a multi-token phrase.
  145999. **
  146000. ** After each token doclist is loaded, merge it with the others from the
  146001. ** same phrase and count the number of documents that the merged doclist
  146002. ** contains. Set variable "nMinEst" to the smallest number of documents in
  146003. ** any phrase doclist for which 1 or more token doclists have been loaded.
  146004. ** Let nOther be the number of other phrases for which it is certain that
  146005. ** one or more tokens will not be deferred.
  146006. **
  146007. ** Then, for each token, defer it if loading the doclist would result in
  146008. ** loading N or more overflow pages into memory, where N is computed as:
  146009. **
  146010. ** (nMinEst + 4^nOther - 1) / (4^nOther)
  146011. */
  146012. for(ii=0; ii<nToken && rc==SQLITE_OK; ii++){
  146013. int iTC; /* Used to iterate through aTC[] array. */
  146014. Fts3TokenAndCost *pTC = 0; /* Set to cheapest remaining token. */
  146015. /* Set pTC to point to the cheapest remaining token. */
  146016. for(iTC=0; iTC<nTC; iTC++){
  146017. if( aTC[iTC].pToken && aTC[iTC].pRoot==pRoot
  146018. && (!pTC || aTC[iTC].nOvfl<pTC->nOvfl)
  146019. ){
  146020. pTC = &aTC[iTC];
  146021. }
  146022. }
  146023. assert( pTC );
  146024. if( ii && pTC->nOvfl>=((nMinEst+(nLoad4/4)-1)/(nLoad4/4))*nDocSize ){
  146025. /* The number of overflow pages to load for this (and therefore all
  146026. ** subsequent) tokens is greater than the estimated number of pages
  146027. ** that will be loaded if all subsequent tokens are deferred.
  146028. */
  146029. Fts3PhraseToken *pToken = pTC->pToken;
  146030. rc = sqlite3Fts3DeferToken(pCsr, pToken, pTC->iCol);
  146031. fts3SegReaderCursorFree(pToken->pSegcsr);
  146032. pToken->pSegcsr = 0;
  146033. }else{
  146034. /* Set nLoad4 to the value of (4^nOther) for the next iteration of the
  146035. ** for-loop. Except, limit the value to 2^24 to prevent it from
  146036. ** overflowing the 32-bit integer it is stored in. */
  146037. if( ii<12 ) nLoad4 = nLoad4*4;
  146038. if( ii==0 || (pTC->pPhrase->nToken>1 && ii!=nToken-1) ){
  146039. /* Either this is the cheapest token in the entire query, or it is
  146040. ** part of a multi-token phrase. Either way, the entire doclist will
  146041. ** (eventually) be loaded into memory. It may as well be now. */
  146042. Fts3PhraseToken *pToken = pTC->pToken;
  146043. int nList = 0;
  146044. char *pList = 0;
  146045. rc = fts3TermSelect(pTab, pToken, pTC->iCol, &nList, &pList);
  146046. assert( rc==SQLITE_OK || pList==0 );
  146047. if( rc==SQLITE_OK ){
  146048. rc = fts3EvalPhraseMergeToken(
  146049. pTab, pTC->pPhrase, pTC->iToken,pList,nList
  146050. );
  146051. }
  146052. if( rc==SQLITE_OK ){
  146053. int nCount;
  146054. nCount = fts3DoclistCountDocids(
  146055. pTC->pPhrase->doclist.aAll, pTC->pPhrase->doclist.nAll
  146056. );
  146057. if( ii==0 || nCount<nMinEst ) nMinEst = nCount;
  146058. }
  146059. }
  146060. }
  146061. pTC->pToken = 0;
  146062. }
  146063. return rc;
  146064. }
  146065. /*
  146066. ** This function is called from within the xFilter method. It initializes
  146067. ** the full-text query currently stored in pCsr->pExpr. To iterate through
  146068. ** the results of a query, the caller does:
  146069. **
  146070. ** fts3EvalStart(pCsr);
  146071. ** while( 1 ){
  146072. ** fts3EvalNext(pCsr);
  146073. ** if( pCsr->bEof ) break;
  146074. ** ... return row pCsr->iPrevId to the caller ...
  146075. ** }
  146076. */
  146077. static int fts3EvalStart(Fts3Cursor *pCsr){
  146078. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  146079. int rc = SQLITE_OK;
  146080. int nToken = 0;
  146081. int nOr = 0;
  146082. /* Allocate a MultiSegReader for each token in the expression. */
  146083. fts3EvalAllocateReaders(pCsr, pCsr->pExpr, &nToken, &nOr, &rc);
  146084. /* Determine which, if any, tokens in the expression should be deferred. */
  146085. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  146086. if( rc==SQLITE_OK && nToken>1 && pTab->bFts4 ){
  146087. Fts3TokenAndCost *aTC;
  146088. Fts3Expr **apOr;
  146089. aTC = (Fts3TokenAndCost *)sqlite3_malloc(
  146090. sizeof(Fts3TokenAndCost) * nToken
  146091. + sizeof(Fts3Expr *) * nOr * 2
  146092. );
  146093. apOr = (Fts3Expr **)&aTC[nToken];
  146094. if( !aTC ){
  146095. rc = SQLITE_NOMEM;
  146096. }else{
  146097. int ii;
  146098. Fts3TokenAndCost *pTC = aTC;
  146099. Fts3Expr **ppOr = apOr;
  146100. fts3EvalTokenCosts(pCsr, 0, pCsr->pExpr, &pTC, &ppOr, &rc);
  146101. nToken = (int)(pTC-aTC);
  146102. nOr = (int)(ppOr-apOr);
  146103. if( rc==SQLITE_OK ){
  146104. rc = fts3EvalSelectDeferred(pCsr, 0, aTC, nToken);
  146105. for(ii=0; rc==SQLITE_OK && ii<nOr; ii++){
  146106. rc = fts3EvalSelectDeferred(pCsr, apOr[ii], aTC, nToken);
  146107. }
  146108. }
  146109. sqlite3_free(aTC);
  146110. }
  146111. }
  146112. #endif
  146113. fts3EvalStartReaders(pCsr, pCsr->pExpr, &rc);
  146114. return rc;
  146115. }
  146116. /*
  146117. ** Invalidate the current position list for phrase pPhrase.
  146118. */
  146119. static void fts3EvalInvalidatePoslist(Fts3Phrase *pPhrase){
  146120. if( pPhrase->doclist.bFreeList ){
  146121. sqlite3_free(pPhrase->doclist.pList);
  146122. }
  146123. pPhrase->doclist.pList = 0;
  146124. pPhrase->doclist.nList = 0;
  146125. pPhrase->doclist.bFreeList = 0;
  146126. }
  146127. /*
  146128. ** This function is called to edit the position list associated with
  146129. ** the phrase object passed as the fifth argument according to a NEAR
  146130. ** condition. For example:
  146131. **
  146132. ** abc NEAR/5 "def ghi"
  146133. **
  146134. ** Parameter nNear is passed the NEAR distance of the expression (5 in
  146135. ** the example above). When this function is called, *paPoslist points to
  146136. ** the position list, and *pnToken is the number of phrase tokens in, the
  146137. ** phrase on the other side of the NEAR operator to pPhrase. For example,
  146138. ** if pPhrase refers to the "def ghi" phrase, then *paPoslist points to
  146139. ** the position list associated with phrase "abc".
  146140. **
  146141. ** All positions in the pPhrase position list that are not sufficiently
  146142. ** close to a position in the *paPoslist position list are removed. If this
  146143. ** leaves 0 positions, zero is returned. Otherwise, non-zero.
  146144. **
  146145. ** Before returning, *paPoslist is set to point to the position lsit
  146146. ** associated with pPhrase. And *pnToken is set to the number of tokens in
  146147. ** pPhrase.
  146148. */
  146149. static int fts3EvalNearTrim(
  146150. int nNear, /* NEAR distance. As in "NEAR/nNear". */
  146151. char *aTmp, /* Temporary space to use */
  146152. char **paPoslist, /* IN/OUT: Position list */
  146153. int *pnToken, /* IN/OUT: Tokens in phrase of *paPoslist */
  146154. Fts3Phrase *pPhrase /* The phrase object to trim the doclist of */
  146155. ){
  146156. int nParam1 = nNear + pPhrase->nToken;
  146157. int nParam2 = nNear + *pnToken;
  146158. int nNew;
  146159. char *p2;
  146160. char *pOut;
  146161. int res;
  146162. assert( pPhrase->doclist.pList );
  146163. p2 = pOut = pPhrase->doclist.pList;
  146164. res = fts3PoslistNearMerge(
  146165. &pOut, aTmp, nParam1, nParam2, paPoslist, &p2
  146166. );
  146167. if( res ){
  146168. nNew = (int)(pOut - pPhrase->doclist.pList) - 1;
  146169. assert( pPhrase->doclist.pList[nNew]=='\0' );
  146170. assert( nNew<=pPhrase->doclist.nList && nNew>0 );
  146171. memset(&pPhrase->doclist.pList[nNew], 0, pPhrase->doclist.nList - nNew);
  146172. pPhrase->doclist.nList = nNew;
  146173. *paPoslist = pPhrase->doclist.pList;
  146174. *pnToken = pPhrase->nToken;
  146175. }
  146176. return res;
  146177. }
  146178. /*
  146179. ** This function is a no-op if *pRc is other than SQLITE_OK when it is called.
  146180. ** Otherwise, it advances the expression passed as the second argument to
  146181. ** point to the next matching row in the database. Expressions iterate through
  146182. ** matching rows in docid order. Ascending order if Fts3Cursor.bDesc is zero,
  146183. ** or descending if it is non-zero.
  146184. **
  146185. ** If an error occurs, *pRc is set to an SQLite error code. Otherwise, if
  146186. ** successful, the following variables in pExpr are set:
  146187. **
  146188. ** Fts3Expr.bEof (non-zero if EOF - there is no next row)
  146189. ** Fts3Expr.iDocid (valid if bEof==0. The docid of the next row)
  146190. **
  146191. ** If the expression is of type FTSQUERY_PHRASE, and the expression is not
  146192. ** at EOF, then the following variables are populated with the position list
  146193. ** for the phrase for the visited row:
  146194. **
  146195. ** FTs3Expr.pPhrase->doclist.nList (length of pList in bytes)
  146196. ** FTs3Expr.pPhrase->doclist.pList (pointer to position list)
  146197. **
  146198. ** It says above that this function advances the expression to the next
  146199. ** matching row. This is usually true, but there are the following exceptions:
  146200. **
  146201. ** 1. Deferred tokens are not taken into account. If a phrase consists
  146202. ** entirely of deferred tokens, it is assumed to match every row in
  146203. ** the db. In this case the position-list is not populated at all.
  146204. **
  146205. ** Or, if a phrase contains one or more deferred tokens and one or
  146206. ** more non-deferred tokens, then the expression is advanced to the
  146207. ** next possible match, considering only non-deferred tokens. In other
  146208. ** words, if the phrase is "A B C", and "B" is deferred, the expression
  146209. ** is advanced to the next row that contains an instance of "A * C",
  146210. ** where "*" may match any single token. The position list in this case
  146211. ** is populated as for "A * C" before returning.
  146212. **
  146213. ** 2. NEAR is treated as AND. If the expression is "x NEAR y", it is
  146214. ** advanced to point to the next row that matches "x AND y".
  146215. **
  146216. ** See sqlite3Fts3EvalTestDeferred() for details on testing if a row is
  146217. ** really a match, taking into account deferred tokens and NEAR operators.
  146218. */
  146219. static void fts3EvalNextRow(
  146220. Fts3Cursor *pCsr, /* FTS Cursor handle */
  146221. Fts3Expr *pExpr, /* Expr. to advance to next matching row */
  146222. int *pRc /* IN/OUT: Error code */
  146223. ){
  146224. if( *pRc==SQLITE_OK ){
  146225. int bDescDoclist = pCsr->bDesc; /* Used by DOCID_CMP() macro */
  146226. assert( pExpr->bEof==0 );
  146227. pExpr->bStart = 1;
  146228. switch( pExpr->eType ){
  146229. case FTSQUERY_NEAR:
  146230. case FTSQUERY_AND: {
  146231. Fts3Expr *pLeft = pExpr->pLeft;
  146232. Fts3Expr *pRight = pExpr->pRight;
  146233. assert( !pLeft->bDeferred || !pRight->bDeferred );
  146234. if( pLeft->bDeferred ){
  146235. /* LHS is entirely deferred. So we assume it matches every row.
  146236. ** Advance the RHS iterator to find the next row visited. */
  146237. fts3EvalNextRow(pCsr, pRight, pRc);
  146238. pExpr->iDocid = pRight->iDocid;
  146239. pExpr->bEof = pRight->bEof;
  146240. }else if( pRight->bDeferred ){
  146241. /* RHS is entirely deferred. So we assume it matches every row.
  146242. ** Advance the LHS iterator to find the next row visited. */
  146243. fts3EvalNextRow(pCsr, pLeft, pRc);
  146244. pExpr->iDocid = pLeft->iDocid;
  146245. pExpr->bEof = pLeft->bEof;
  146246. }else{
  146247. /* Neither the RHS or LHS are deferred. */
  146248. fts3EvalNextRow(pCsr, pLeft, pRc);
  146249. fts3EvalNextRow(pCsr, pRight, pRc);
  146250. while( !pLeft->bEof && !pRight->bEof && *pRc==SQLITE_OK ){
  146251. sqlite3_int64 iDiff = DOCID_CMP(pLeft->iDocid, pRight->iDocid);
  146252. if( iDiff==0 ) break;
  146253. if( iDiff<0 ){
  146254. fts3EvalNextRow(pCsr, pLeft, pRc);
  146255. }else{
  146256. fts3EvalNextRow(pCsr, pRight, pRc);
  146257. }
  146258. }
  146259. pExpr->iDocid = pLeft->iDocid;
  146260. pExpr->bEof = (pLeft->bEof || pRight->bEof);
  146261. if( pExpr->eType==FTSQUERY_NEAR && pExpr->bEof ){
  146262. assert( pRight->eType==FTSQUERY_PHRASE );
  146263. if( pRight->pPhrase->doclist.aAll ){
  146264. Fts3Doclist *pDl = &pRight->pPhrase->doclist;
  146265. while( *pRc==SQLITE_OK && pRight->bEof==0 ){
  146266. memset(pDl->pList, 0, pDl->nList);
  146267. fts3EvalNextRow(pCsr, pRight, pRc);
  146268. }
  146269. }
  146270. if( pLeft->pPhrase && pLeft->pPhrase->doclist.aAll ){
  146271. Fts3Doclist *pDl = &pLeft->pPhrase->doclist;
  146272. while( *pRc==SQLITE_OK && pLeft->bEof==0 ){
  146273. memset(pDl->pList, 0, pDl->nList);
  146274. fts3EvalNextRow(pCsr, pLeft, pRc);
  146275. }
  146276. }
  146277. }
  146278. }
  146279. break;
  146280. }
  146281. case FTSQUERY_OR: {
  146282. Fts3Expr *pLeft = pExpr->pLeft;
  146283. Fts3Expr *pRight = pExpr->pRight;
  146284. sqlite3_int64 iCmp = DOCID_CMP(pLeft->iDocid, pRight->iDocid);
  146285. assert( pLeft->bStart || pLeft->iDocid==pRight->iDocid );
  146286. assert( pRight->bStart || pLeft->iDocid==pRight->iDocid );
  146287. if( pRight->bEof || (pLeft->bEof==0 && iCmp<0) ){
  146288. fts3EvalNextRow(pCsr, pLeft, pRc);
  146289. }else if( pLeft->bEof || iCmp>0 ){
  146290. fts3EvalNextRow(pCsr, pRight, pRc);
  146291. }else{
  146292. fts3EvalNextRow(pCsr, pLeft, pRc);
  146293. fts3EvalNextRow(pCsr, pRight, pRc);
  146294. }
  146295. pExpr->bEof = (pLeft->bEof && pRight->bEof);
  146296. iCmp = DOCID_CMP(pLeft->iDocid, pRight->iDocid);
  146297. if( pRight->bEof || (pLeft->bEof==0 && iCmp<0) ){
  146298. pExpr->iDocid = pLeft->iDocid;
  146299. }else{
  146300. pExpr->iDocid = pRight->iDocid;
  146301. }
  146302. break;
  146303. }
  146304. case FTSQUERY_NOT: {
  146305. Fts3Expr *pLeft = pExpr->pLeft;
  146306. Fts3Expr *pRight = pExpr->pRight;
  146307. if( pRight->bStart==0 ){
  146308. fts3EvalNextRow(pCsr, pRight, pRc);
  146309. assert( *pRc!=SQLITE_OK || pRight->bStart );
  146310. }
  146311. fts3EvalNextRow(pCsr, pLeft, pRc);
  146312. if( pLeft->bEof==0 ){
  146313. while( !*pRc
  146314. && !pRight->bEof
  146315. && DOCID_CMP(pLeft->iDocid, pRight->iDocid)>0
  146316. ){
  146317. fts3EvalNextRow(pCsr, pRight, pRc);
  146318. }
  146319. }
  146320. pExpr->iDocid = pLeft->iDocid;
  146321. pExpr->bEof = pLeft->bEof;
  146322. break;
  146323. }
  146324. default: {
  146325. Fts3Phrase *pPhrase = pExpr->pPhrase;
  146326. fts3EvalInvalidatePoslist(pPhrase);
  146327. *pRc = fts3EvalPhraseNext(pCsr, pPhrase, &pExpr->bEof);
  146328. pExpr->iDocid = pPhrase->doclist.iDocid;
  146329. break;
  146330. }
  146331. }
  146332. }
  146333. }
  146334. /*
  146335. ** If *pRc is not SQLITE_OK, or if pExpr is not the root node of a NEAR
  146336. ** cluster, then this function returns 1 immediately.
  146337. **
  146338. ** Otherwise, it checks if the current row really does match the NEAR
  146339. ** expression, using the data currently stored in the position lists
  146340. ** (Fts3Expr->pPhrase.doclist.pList/nList) for each phrase in the expression.
  146341. **
  146342. ** If the current row is a match, the position list associated with each
  146343. ** phrase in the NEAR expression is edited in place to contain only those
  146344. ** phrase instances sufficiently close to their peers to satisfy all NEAR
  146345. ** constraints. In this case it returns 1. If the NEAR expression does not
  146346. ** match the current row, 0 is returned. The position lists may or may not
  146347. ** be edited if 0 is returned.
  146348. */
  146349. static int fts3EvalNearTest(Fts3Expr *pExpr, int *pRc){
  146350. int res = 1;
  146351. /* The following block runs if pExpr is the root of a NEAR query.
  146352. ** For example, the query:
  146353. **
  146354. ** "w" NEAR "x" NEAR "y" NEAR "z"
  146355. **
  146356. ** which is represented in tree form as:
  146357. **
  146358. ** |
  146359. ** +--NEAR--+ <-- root of NEAR query
  146360. ** | |
  146361. ** +--NEAR--+ "z"
  146362. ** | |
  146363. ** +--NEAR--+ "y"
  146364. ** | |
  146365. ** "w" "x"
  146366. **
  146367. ** The right-hand child of a NEAR node is always a phrase. The
  146368. ** left-hand child may be either a phrase or a NEAR node. There are
  146369. ** no exceptions to this - it's the way the parser in fts3_expr.c works.
  146370. */
  146371. if( *pRc==SQLITE_OK
  146372. && pExpr->eType==FTSQUERY_NEAR
  146373. && (pExpr->pParent==0 || pExpr->pParent->eType!=FTSQUERY_NEAR)
  146374. ){
  146375. Fts3Expr *p;
  146376. int nTmp = 0; /* Bytes of temp space */
  146377. char *aTmp; /* Temp space for PoslistNearMerge() */
  146378. /* Allocate temporary working space. */
  146379. for(p=pExpr; p->pLeft; p=p->pLeft){
  146380. assert( p->pRight->pPhrase->doclist.nList>0 );
  146381. nTmp += p->pRight->pPhrase->doclist.nList;
  146382. }
  146383. nTmp += p->pPhrase->doclist.nList;
  146384. aTmp = sqlite3_malloc(nTmp*2);
  146385. if( !aTmp ){
  146386. *pRc = SQLITE_NOMEM;
  146387. res = 0;
  146388. }else{
  146389. char *aPoslist = p->pPhrase->doclist.pList;
  146390. int nToken = p->pPhrase->nToken;
  146391. for(p=p->pParent;res && p && p->eType==FTSQUERY_NEAR; p=p->pParent){
  146392. Fts3Phrase *pPhrase = p->pRight->pPhrase;
  146393. int nNear = p->nNear;
  146394. res = fts3EvalNearTrim(nNear, aTmp, &aPoslist, &nToken, pPhrase);
  146395. }
  146396. aPoslist = pExpr->pRight->pPhrase->doclist.pList;
  146397. nToken = pExpr->pRight->pPhrase->nToken;
  146398. for(p=pExpr->pLeft; p && res; p=p->pLeft){
  146399. int nNear;
  146400. Fts3Phrase *pPhrase;
  146401. assert( p->pParent && p->pParent->pLeft==p );
  146402. nNear = p->pParent->nNear;
  146403. pPhrase = (
  146404. p->eType==FTSQUERY_NEAR ? p->pRight->pPhrase : p->pPhrase
  146405. );
  146406. res = fts3EvalNearTrim(nNear, aTmp, &aPoslist, &nToken, pPhrase);
  146407. }
  146408. }
  146409. sqlite3_free(aTmp);
  146410. }
  146411. return res;
  146412. }
  146413. /*
  146414. ** This function is a helper function for sqlite3Fts3EvalTestDeferred().
  146415. ** Assuming no error occurs or has occurred, It returns non-zero if the
  146416. ** expression passed as the second argument matches the row that pCsr
  146417. ** currently points to, or zero if it does not.
  146418. **
  146419. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  146420. ** If an error occurs during execution of this function, *pRc is set to
  146421. ** the appropriate SQLite error code. In this case the returned value is
  146422. ** undefined.
  146423. */
  146424. static int fts3EvalTestExpr(
  146425. Fts3Cursor *pCsr, /* FTS cursor handle */
  146426. Fts3Expr *pExpr, /* Expr to test. May or may not be root. */
  146427. int *pRc /* IN/OUT: Error code */
  146428. ){
  146429. int bHit = 1; /* Return value */
  146430. if( *pRc==SQLITE_OK ){
  146431. switch( pExpr->eType ){
  146432. case FTSQUERY_NEAR:
  146433. case FTSQUERY_AND:
  146434. bHit = (
  146435. fts3EvalTestExpr(pCsr, pExpr->pLeft, pRc)
  146436. && fts3EvalTestExpr(pCsr, pExpr->pRight, pRc)
  146437. && fts3EvalNearTest(pExpr, pRc)
  146438. );
  146439. /* If the NEAR expression does not match any rows, zero the doclist for
  146440. ** all phrases involved in the NEAR. This is because the snippet(),
  146441. ** offsets() and matchinfo() functions are not supposed to recognize
  146442. ** any instances of phrases that are part of unmatched NEAR queries.
  146443. ** For example if this expression:
  146444. **
  146445. ** ... MATCH 'a OR (b NEAR c)'
  146446. **
  146447. ** is matched against a row containing:
  146448. **
  146449. ** 'a b d e'
  146450. **
  146451. ** then any snippet() should ony highlight the "a" term, not the "b"
  146452. ** (as "b" is part of a non-matching NEAR clause).
  146453. */
  146454. if( bHit==0
  146455. && pExpr->eType==FTSQUERY_NEAR
  146456. && (pExpr->pParent==0 || pExpr->pParent->eType!=FTSQUERY_NEAR)
  146457. ){
  146458. Fts3Expr *p;
  146459. for(p=pExpr; p->pPhrase==0; p=p->pLeft){
  146460. if( p->pRight->iDocid==pCsr->iPrevId ){
  146461. fts3EvalInvalidatePoslist(p->pRight->pPhrase);
  146462. }
  146463. }
  146464. if( p->iDocid==pCsr->iPrevId ){
  146465. fts3EvalInvalidatePoslist(p->pPhrase);
  146466. }
  146467. }
  146468. break;
  146469. case FTSQUERY_OR: {
  146470. int bHit1 = fts3EvalTestExpr(pCsr, pExpr->pLeft, pRc);
  146471. int bHit2 = fts3EvalTestExpr(pCsr, pExpr->pRight, pRc);
  146472. bHit = bHit1 || bHit2;
  146473. break;
  146474. }
  146475. case FTSQUERY_NOT:
  146476. bHit = (
  146477. fts3EvalTestExpr(pCsr, pExpr->pLeft, pRc)
  146478. && !fts3EvalTestExpr(pCsr, pExpr->pRight, pRc)
  146479. );
  146480. break;
  146481. default: {
  146482. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  146483. if( pCsr->pDeferred
  146484. && (pExpr->iDocid==pCsr->iPrevId || pExpr->bDeferred)
  146485. ){
  146486. Fts3Phrase *pPhrase = pExpr->pPhrase;
  146487. assert( pExpr->bDeferred || pPhrase->doclist.bFreeList==0 );
  146488. if( pExpr->bDeferred ){
  146489. fts3EvalInvalidatePoslist(pPhrase);
  146490. }
  146491. *pRc = fts3EvalDeferredPhrase(pCsr, pPhrase);
  146492. bHit = (pPhrase->doclist.pList!=0);
  146493. pExpr->iDocid = pCsr->iPrevId;
  146494. }else
  146495. #endif
  146496. {
  146497. bHit = (pExpr->bEof==0 && pExpr->iDocid==pCsr->iPrevId);
  146498. }
  146499. break;
  146500. }
  146501. }
  146502. }
  146503. return bHit;
  146504. }
  146505. /*
  146506. ** This function is called as the second part of each xNext operation when
  146507. ** iterating through the results of a full-text query. At this point the
  146508. ** cursor points to a row that matches the query expression, with the
  146509. ** following caveats:
  146510. **
  146511. ** * Up until this point, "NEAR" operators in the expression have been
  146512. ** treated as "AND".
  146513. **
  146514. ** * Deferred tokens have not yet been considered.
  146515. **
  146516. ** If *pRc is not SQLITE_OK when this function is called, it immediately
  146517. ** returns 0. Otherwise, it tests whether or not after considering NEAR
  146518. ** operators and deferred tokens the current row is still a match for the
  146519. ** expression. It returns 1 if both of the following are true:
  146520. **
  146521. ** 1. *pRc is SQLITE_OK when this function returns, and
  146522. **
  146523. ** 2. After scanning the current FTS table row for the deferred tokens,
  146524. ** it is determined that the row does *not* match the query.
  146525. **
  146526. ** Or, if no error occurs and it seems the current row does match the FTS
  146527. ** query, return 0.
  146528. */
  146529. SQLITE_PRIVATE int sqlite3Fts3EvalTestDeferred(Fts3Cursor *pCsr, int *pRc){
  146530. int rc = *pRc;
  146531. int bMiss = 0;
  146532. if( rc==SQLITE_OK ){
  146533. /* If there are one or more deferred tokens, load the current row into
  146534. ** memory and scan it to determine the position list for each deferred
  146535. ** token. Then, see if this row is really a match, considering deferred
  146536. ** tokens and NEAR operators (neither of which were taken into account
  146537. ** earlier, by fts3EvalNextRow()).
  146538. */
  146539. if( pCsr->pDeferred ){
  146540. rc = fts3CursorSeek(0, pCsr);
  146541. if( rc==SQLITE_OK ){
  146542. rc = sqlite3Fts3CacheDeferredDoclists(pCsr);
  146543. }
  146544. }
  146545. bMiss = (0==fts3EvalTestExpr(pCsr, pCsr->pExpr, &rc));
  146546. /* Free the position-lists accumulated for each deferred token above. */
  146547. sqlite3Fts3FreeDeferredDoclists(pCsr);
  146548. *pRc = rc;
  146549. }
  146550. return (rc==SQLITE_OK && bMiss);
  146551. }
  146552. /*
  146553. ** Advance to the next document that matches the FTS expression in
  146554. ** Fts3Cursor.pExpr.
  146555. */
  146556. static int fts3EvalNext(Fts3Cursor *pCsr){
  146557. int rc = SQLITE_OK; /* Return Code */
  146558. Fts3Expr *pExpr = pCsr->pExpr;
  146559. assert( pCsr->isEof==0 );
  146560. if( pExpr==0 ){
  146561. pCsr->isEof = 1;
  146562. }else{
  146563. do {
  146564. if( pCsr->isRequireSeek==0 ){
  146565. sqlite3_reset(pCsr->pStmt);
  146566. }
  146567. assert( sqlite3_data_count(pCsr->pStmt)==0 );
  146568. fts3EvalNextRow(pCsr, pExpr, &rc);
  146569. pCsr->isEof = pExpr->bEof;
  146570. pCsr->isRequireSeek = 1;
  146571. pCsr->isMatchinfoNeeded = 1;
  146572. pCsr->iPrevId = pExpr->iDocid;
  146573. }while( pCsr->isEof==0 && sqlite3Fts3EvalTestDeferred(pCsr, &rc) );
  146574. }
  146575. /* Check if the cursor is past the end of the docid range specified
  146576. ** by Fts3Cursor.iMinDocid/iMaxDocid. If so, set the EOF flag. */
  146577. if( rc==SQLITE_OK && (
  146578. (pCsr->bDesc==0 && pCsr->iPrevId>pCsr->iMaxDocid)
  146579. || (pCsr->bDesc!=0 && pCsr->iPrevId<pCsr->iMinDocid)
  146580. )){
  146581. pCsr->isEof = 1;
  146582. }
  146583. return rc;
  146584. }
  146585. /*
  146586. ** Restart interation for expression pExpr so that the next call to
  146587. ** fts3EvalNext() visits the first row. Do not allow incremental
  146588. ** loading or merging of phrase doclists for this iteration.
  146589. **
  146590. ** If *pRc is other than SQLITE_OK when this function is called, it is
  146591. ** a no-op. If an error occurs within this function, *pRc is set to an
  146592. ** SQLite error code before returning.
  146593. */
  146594. static void fts3EvalRestart(
  146595. Fts3Cursor *pCsr,
  146596. Fts3Expr *pExpr,
  146597. int *pRc
  146598. ){
  146599. if( pExpr && *pRc==SQLITE_OK ){
  146600. Fts3Phrase *pPhrase = pExpr->pPhrase;
  146601. if( pPhrase ){
  146602. fts3EvalInvalidatePoslist(pPhrase);
  146603. if( pPhrase->bIncr ){
  146604. int i;
  146605. for(i=0; i<pPhrase->nToken; i++){
  146606. Fts3PhraseToken *pToken = &pPhrase->aToken[i];
  146607. assert( pToken->pDeferred==0 );
  146608. if( pToken->pSegcsr ){
  146609. sqlite3Fts3MsrIncrRestart(pToken->pSegcsr);
  146610. }
  146611. }
  146612. *pRc = fts3EvalPhraseStart(pCsr, 0, pPhrase);
  146613. }
  146614. pPhrase->doclist.pNextDocid = 0;
  146615. pPhrase->doclist.iDocid = 0;
  146616. pPhrase->pOrPoslist = 0;
  146617. }
  146618. pExpr->iDocid = 0;
  146619. pExpr->bEof = 0;
  146620. pExpr->bStart = 0;
  146621. fts3EvalRestart(pCsr, pExpr->pLeft, pRc);
  146622. fts3EvalRestart(pCsr, pExpr->pRight, pRc);
  146623. }
  146624. }
  146625. /*
  146626. ** After allocating the Fts3Expr.aMI[] array for each phrase in the
  146627. ** expression rooted at pExpr, the cursor iterates through all rows matched
  146628. ** by pExpr, calling this function for each row. This function increments
  146629. ** the values in Fts3Expr.aMI[] according to the position-list currently
  146630. ** found in Fts3Expr.pPhrase->doclist.pList for each of the phrase
  146631. ** expression nodes.
  146632. */
  146633. static void fts3EvalUpdateCounts(Fts3Expr *pExpr){
  146634. if( pExpr ){
  146635. Fts3Phrase *pPhrase = pExpr->pPhrase;
  146636. if( pPhrase && pPhrase->doclist.pList ){
  146637. int iCol = 0;
  146638. char *p = pPhrase->doclist.pList;
  146639. assert( *p );
  146640. while( 1 ){
  146641. u8 c = 0;
  146642. int iCnt = 0;
  146643. while( 0xFE & (*p | c) ){
  146644. if( (c&0x80)==0 ) iCnt++;
  146645. c = *p++ & 0x80;
  146646. }
  146647. /* aMI[iCol*3 + 1] = Number of occurrences
  146648. ** aMI[iCol*3 + 2] = Number of rows containing at least one instance
  146649. */
  146650. pExpr->aMI[iCol*3 + 1] += iCnt;
  146651. pExpr->aMI[iCol*3 + 2] += (iCnt>0);
  146652. if( *p==0x00 ) break;
  146653. p++;
  146654. p += fts3GetVarint32(p, &iCol);
  146655. }
  146656. }
  146657. fts3EvalUpdateCounts(pExpr->pLeft);
  146658. fts3EvalUpdateCounts(pExpr->pRight);
  146659. }
  146660. }
  146661. /*
  146662. ** Expression pExpr must be of type FTSQUERY_PHRASE.
  146663. **
  146664. ** If it is not already allocated and populated, this function allocates and
  146665. ** populates the Fts3Expr.aMI[] array for expression pExpr. If pExpr is part
  146666. ** of a NEAR expression, then it also allocates and populates the same array
  146667. ** for all other phrases that are part of the NEAR expression.
  146668. **
  146669. ** SQLITE_OK is returned if the aMI[] array is successfully allocated and
  146670. ** populated. Otherwise, if an error occurs, an SQLite error code is returned.
  146671. */
  146672. static int fts3EvalGatherStats(
  146673. Fts3Cursor *pCsr, /* Cursor object */
  146674. Fts3Expr *pExpr /* FTSQUERY_PHRASE expression */
  146675. ){
  146676. int rc = SQLITE_OK; /* Return code */
  146677. assert( pExpr->eType==FTSQUERY_PHRASE );
  146678. if( pExpr->aMI==0 ){
  146679. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  146680. Fts3Expr *pRoot; /* Root of NEAR expression */
  146681. Fts3Expr *p; /* Iterator used for several purposes */
  146682. sqlite3_int64 iPrevId = pCsr->iPrevId;
  146683. sqlite3_int64 iDocid;
  146684. u8 bEof;
  146685. /* Find the root of the NEAR expression */
  146686. pRoot = pExpr;
  146687. while( pRoot->pParent && pRoot->pParent->eType==FTSQUERY_NEAR ){
  146688. pRoot = pRoot->pParent;
  146689. }
  146690. iDocid = pRoot->iDocid;
  146691. bEof = pRoot->bEof;
  146692. assert( pRoot->bStart );
  146693. /* Allocate space for the aMSI[] array of each FTSQUERY_PHRASE node */
  146694. for(p=pRoot; p; p=p->pLeft){
  146695. Fts3Expr *pE = (p->eType==FTSQUERY_PHRASE?p:p->pRight);
  146696. assert( pE->aMI==0 );
  146697. pE->aMI = (u32 *)sqlite3_malloc(pTab->nColumn * 3 * sizeof(u32));
  146698. if( !pE->aMI ) return SQLITE_NOMEM;
  146699. memset(pE->aMI, 0, pTab->nColumn * 3 * sizeof(u32));
  146700. }
  146701. fts3EvalRestart(pCsr, pRoot, &rc);
  146702. while( pCsr->isEof==0 && rc==SQLITE_OK ){
  146703. do {
  146704. /* Ensure the %_content statement is reset. */
  146705. if( pCsr->isRequireSeek==0 ) sqlite3_reset(pCsr->pStmt);
  146706. assert( sqlite3_data_count(pCsr->pStmt)==0 );
  146707. /* Advance to the next document */
  146708. fts3EvalNextRow(pCsr, pRoot, &rc);
  146709. pCsr->isEof = pRoot->bEof;
  146710. pCsr->isRequireSeek = 1;
  146711. pCsr->isMatchinfoNeeded = 1;
  146712. pCsr->iPrevId = pRoot->iDocid;
  146713. }while( pCsr->isEof==0
  146714. && pRoot->eType==FTSQUERY_NEAR
  146715. && sqlite3Fts3EvalTestDeferred(pCsr, &rc)
  146716. );
  146717. if( rc==SQLITE_OK && pCsr->isEof==0 ){
  146718. fts3EvalUpdateCounts(pRoot);
  146719. }
  146720. }
  146721. pCsr->isEof = 0;
  146722. pCsr->iPrevId = iPrevId;
  146723. if( bEof ){
  146724. pRoot->bEof = bEof;
  146725. }else{
  146726. /* Caution: pRoot may iterate through docids in ascending or descending
  146727. ** order. For this reason, even though it seems more defensive, the
  146728. ** do loop can not be written:
  146729. **
  146730. ** do {...} while( pRoot->iDocid<iDocid && rc==SQLITE_OK );
  146731. */
  146732. fts3EvalRestart(pCsr, pRoot, &rc);
  146733. do {
  146734. fts3EvalNextRow(pCsr, pRoot, &rc);
  146735. assert( pRoot->bEof==0 );
  146736. }while( pRoot->iDocid!=iDocid && rc==SQLITE_OK );
  146737. }
  146738. }
  146739. return rc;
  146740. }
  146741. /*
  146742. ** This function is used by the matchinfo() module to query a phrase
  146743. ** expression node for the following information:
  146744. **
  146745. ** 1. The total number of occurrences of the phrase in each column of
  146746. ** the FTS table (considering all rows), and
  146747. **
  146748. ** 2. For each column, the number of rows in the table for which the
  146749. ** column contains at least one instance of the phrase.
  146750. **
  146751. ** If no error occurs, SQLITE_OK is returned and the values for each column
  146752. ** written into the array aiOut as follows:
  146753. **
  146754. ** aiOut[iCol*3 + 1] = Number of occurrences
  146755. ** aiOut[iCol*3 + 2] = Number of rows containing at least one instance
  146756. **
  146757. ** Caveats:
  146758. **
  146759. ** * If a phrase consists entirely of deferred tokens, then all output
  146760. ** values are set to the number of documents in the table. In other
  146761. ** words we assume that very common tokens occur exactly once in each
  146762. ** column of each row of the table.
  146763. **
  146764. ** * If a phrase contains some deferred tokens (and some non-deferred
  146765. ** tokens), count the potential occurrence identified by considering
  146766. ** the non-deferred tokens instead of actual phrase occurrences.
  146767. **
  146768. ** * If the phrase is part of a NEAR expression, then only phrase instances
  146769. ** that meet the NEAR constraint are included in the counts.
  146770. */
  146771. SQLITE_PRIVATE int sqlite3Fts3EvalPhraseStats(
  146772. Fts3Cursor *pCsr, /* FTS cursor handle */
  146773. Fts3Expr *pExpr, /* Phrase expression */
  146774. u32 *aiOut /* Array to write results into (see above) */
  146775. ){
  146776. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  146777. int rc = SQLITE_OK;
  146778. int iCol;
  146779. if( pExpr->bDeferred && pExpr->pParent->eType!=FTSQUERY_NEAR ){
  146780. assert( pCsr->nDoc>0 );
  146781. for(iCol=0; iCol<pTab->nColumn; iCol++){
  146782. aiOut[iCol*3 + 1] = (u32)pCsr->nDoc;
  146783. aiOut[iCol*3 + 2] = (u32)pCsr->nDoc;
  146784. }
  146785. }else{
  146786. rc = fts3EvalGatherStats(pCsr, pExpr);
  146787. if( rc==SQLITE_OK ){
  146788. assert( pExpr->aMI );
  146789. for(iCol=0; iCol<pTab->nColumn; iCol++){
  146790. aiOut[iCol*3 + 1] = pExpr->aMI[iCol*3 + 1];
  146791. aiOut[iCol*3 + 2] = pExpr->aMI[iCol*3 + 2];
  146792. }
  146793. }
  146794. }
  146795. return rc;
  146796. }
  146797. /*
  146798. ** The expression pExpr passed as the second argument to this function
  146799. ** must be of type FTSQUERY_PHRASE.
  146800. **
  146801. ** The returned value is either NULL or a pointer to a buffer containing
  146802. ** a position-list indicating the occurrences of the phrase in column iCol
  146803. ** of the current row.
  146804. **
  146805. ** More specifically, the returned buffer contains 1 varint for each
  146806. ** occurrence of the phrase in the column, stored using the normal (delta+2)
  146807. ** compression and is terminated by either an 0x01 or 0x00 byte. For example,
  146808. ** if the requested column contains "a b X c d X X" and the position-list
  146809. ** for 'X' is requested, the buffer returned may contain:
  146810. **
  146811. ** 0x04 0x05 0x03 0x01 or 0x04 0x05 0x03 0x00
  146812. **
  146813. ** This function works regardless of whether or not the phrase is deferred,
  146814. ** incremental, or neither.
  146815. */
  146816. SQLITE_PRIVATE int sqlite3Fts3EvalPhrasePoslist(
  146817. Fts3Cursor *pCsr, /* FTS3 cursor object */
  146818. Fts3Expr *pExpr, /* Phrase to return doclist for */
  146819. int iCol, /* Column to return position list for */
  146820. char **ppOut /* OUT: Pointer to position list */
  146821. ){
  146822. Fts3Phrase *pPhrase = pExpr->pPhrase;
  146823. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  146824. char *pIter;
  146825. int iThis;
  146826. sqlite3_int64 iDocid;
  146827. /* If this phrase is applies specifically to some column other than
  146828. ** column iCol, return a NULL pointer. */
  146829. *ppOut = 0;
  146830. assert( iCol>=0 && iCol<pTab->nColumn );
  146831. if( (pPhrase->iColumn<pTab->nColumn && pPhrase->iColumn!=iCol) ){
  146832. return SQLITE_OK;
  146833. }
  146834. iDocid = pExpr->iDocid;
  146835. pIter = pPhrase->doclist.pList;
  146836. if( iDocid!=pCsr->iPrevId || pExpr->bEof ){
  146837. int rc = SQLITE_OK;
  146838. int bDescDoclist = pTab->bDescIdx; /* For DOCID_CMP macro */
  146839. int bOr = 0;
  146840. u8 bTreeEof = 0;
  146841. Fts3Expr *p; /* Used to iterate from pExpr to root */
  146842. Fts3Expr *pNear; /* Most senior NEAR ancestor (or pExpr) */
  146843. int bMatch;
  146844. /* Check if this phrase descends from an OR expression node. If not,
  146845. ** return NULL. Otherwise, the entry that corresponds to docid
  146846. ** pCsr->iPrevId may lie earlier in the doclist buffer. Or, if the
  146847. ** tree that the node is part of has been marked as EOF, but the node
  146848. ** itself is not EOF, then it may point to an earlier entry. */
  146849. pNear = pExpr;
  146850. for(p=pExpr->pParent; p; p=p->pParent){
  146851. if( p->eType==FTSQUERY_OR ) bOr = 1;
  146852. if( p->eType==FTSQUERY_NEAR ) pNear = p;
  146853. if( p->bEof ) bTreeEof = 1;
  146854. }
  146855. if( bOr==0 ) return SQLITE_OK;
  146856. /* This is the descendent of an OR node. In this case we cannot use
  146857. ** an incremental phrase. Load the entire doclist for the phrase
  146858. ** into memory in this case. */
  146859. if( pPhrase->bIncr ){
  146860. int bEofSave = pNear->bEof;
  146861. fts3EvalRestart(pCsr, pNear, &rc);
  146862. while( rc==SQLITE_OK && !pNear->bEof ){
  146863. fts3EvalNextRow(pCsr, pNear, &rc);
  146864. if( bEofSave==0 && pNear->iDocid==iDocid ) break;
  146865. }
  146866. assert( rc!=SQLITE_OK || pPhrase->bIncr==0 );
  146867. }
  146868. if( bTreeEof ){
  146869. while( rc==SQLITE_OK && !pNear->bEof ){
  146870. fts3EvalNextRow(pCsr, pNear, &rc);
  146871. }
  146872. }
  146873. if( rc!=SQLITE_OK ) return rc;
  146874. bMatch = 1;
  146875. for(p=pNear; p; p=p->pLeft){
  146876. u8 bEof = 0;
  146877. Fts3Expr *pTest = p;
  146878. Fts3Phrase *pPh;
  146879. assert( pTest->eType==FTSQUERY_NEAR || pTest->eType==FTSQUERY_PHRASE );
  146880. if( pTest->eType==FTSQUERY_NEAR ) pTest = pTest->pRight;
  146881. assert( pTest->eType==FTSQUERY_PHRASE );
  146882. pPh = pTest->pPhrase;
  146883. pIter = pPh->pOrPoslist;
  146884. iDocid = pPh->iOrDocid;
  146885. if( pCsr->bDesc==bDescDoclist ){
  146886. bEof = !pPh->doclist.nAll ||
  146887. (pIter >= (pPh->doclist.aAll + pPh->doclist.nAll));
  146888. while( (pIter==0 || DOCID_CMP(iDocid, pCsr->iPrevId)<0 ) && bEof==0 ){
  146889. sqlite3Fts3DoclistNext(
  146890. bDescDoclist, pPh->doclist.aAll, pPh->doclist.nAll,
  146891. &pIter, &iDocid, &bEof
  146892. );
  146893. }
  146894. }else{
  146895. bEof = !pPh->doclist.nAll || (pIter && pIter<=pPh->doclist.aAll);
  146896. while( (pIter==0 || DOCID_CMP(iDocid, pCsr->iPrevId)>0 ) && bEof==0 ){
  146897. int dummy;
  146898. sqlite3Fts3DoclistPrev(
  146899. bDescDoclist, pPh->doclist.aAll, pPh->doclist.nAll,
  146900. &pIter, &iDocid, &dummy, &bEof
  146901. );
  146902. }
  146903. }
  146904. pPh->pOrPoslist = pIter;
  146905. pPh->iOrDocid = iDocid;
  146906. if( bEof || iDocid!=pCsr->iPrevId ) bMatch = 0;
  146907. }
  146908. if( bMatch ){
  146909. pIter = pPhrase->pOrPoslist;
  146910. }else{
  146911. pIter = 0;
  146912. }
  146913. }
  146914. if( pIter==0 ) return SQLITE_OK;
  146915. if( *pIter==0x01 ){
  146916. pIter++;
  146917. pIter += fts3GetVarint32(pIter, &iThis);
  146918. }else{
  146919. iThis = 0;
  146920. }
  146921. while( iThis<iCol ){
  146922. fts3ColumnlistCopy(0, &pIter);
  146923. if( *pIter==0x00 ) return SQLITE_OK;
  146924. pIter++;
  146925. pIter += fts3GetVarint32(pIter, &iThis);
  146926. }
  146927. if( *pIter==0x00 ){
  146928. pIter = 0;
  146929. }
  146930. *ppOut = ((iCol==iThis)?pIter:0);
  146931. return SQLITE_OK;
  146932. }
  146933. /*
  146934. ** Free all components of the Fts3Phrase structure that were allocated by
  146935. ** the eval module. Specifically, this means to free:
  146936. **
  146937. ** * the contents of pPhrase->doclist, and
  146938. ** * any Fts3MultiSegReader objects held by phrase tokens.
  146939. */
  146940. SQLITE_PRIVATE void sqlite3Fts3EvalPhraseCleanup(Fts3Phrase *pPhrase){
  146941. if( pPhrase ){
  146942. int i;
  146943. sqlite3_free(pPhrase->doclist.aAll);
  146944. fts3EvalInvalidatePoslist(pPhrase);
  146945. memset(&pPhrase->doclist, 0, sizeof(Fts3Doclist));
  146946. for(i=0; i<pPhrase->nToken; i++){
  146947. fts3SegReaderCursorFree(pPhrase->aToken[i].pSegcsr);
  146948. pPhrase->aToken[i].pSegcsr = 0;
  146949. }
  146950. }
  146951. }
  146952. /*
  146953. ** Return SQLITE_CORRUPT_VTAB.
  146954. */
  146955. #ifdef SQLITE_DEBUG
  146956. SQLITE_PRIVATE int sqlite3Fts3Corrupt(){
  146957. return SQLITE_CORRUPT_VTAB;
  146958. }
  146959. #endif
  146960. #if !SQLITE_CORE
  146961. /*
  146962. ** Initialize API pointer table, if required.
  146963. */
  146964. #ifdef _WIN32
  146965. __declspec(dllexport)
  146966. #endif
  146967. SQLITE_API int sqlite3_fts3_init(
  146968. sqlite3 *db,
  146969. char **pzErrMsg,
  146970. const sqlite3_api_routines *pApi
  146971. ){
  146972. SQLITE_EXTENSION_INIT2(pApi)
  146973. return sqlite3Fts3Init(db);
  146974. }
  146975. #endif
  146976. #endif
  146977. /************** End of fts3.c ************************************************/
  146978. /************** Begin file fts3_aux.c ****************************************/
  146979. /*
  146980. ** 2011 Jan 27
  146981. **
  146982. ** The author disclaims copyright to this source code. In place of
  146983. ** a legal notice, here is a blessing:
  146984. **
  146985. ** May you do good and not evil.
  146986. ** May you find forgiveness for yourself and forgive others.
  146987. ** May you share freely, never taking more than you give.
  146988. **
  146989. ******************************************************************************
  146990. **
  146991. */
  146992. /* #include "fts3Int.h" */
  146993. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  146994. /* #include <string.h> */
  146995. /* #include <assert.h> */
  146996. typedef struct Fts3auxTable Fts3auxTable;
  146997. typedef struct Fts3auxCursor Fts3auxCursor;
  146998. struct Fts3auxTable {
  146999. sqlite3_vtab base; /* Base class used by SQLite core */
  147000. Fts3Table *pFts3Tab;
  147001. };
  147002. struct Fts3auxCursor {
  147003. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  147004. Fts3MultiSegReader csr; /* Must be right after "base" */
  147005. Fts3SegFilter filter;
  147006. char *zStop;
  147007. int nStop; /* Byte-length of string zStop */
  147008. int iLangid; /* Language id to query */
  147009. int isEof; /* True if cursor is at EOF */
  147010. sqlite3_int64 iRowid; /* Current rowid */
  147011. int iCol; /* Current value of 'col' column */
  147012. int nStat; /* Size of aStat[] array */
  147013. struct Fts3auxColstats {
  147014. sqlite3_int64 nDoc; /* 'documents' values for current csr row */
  147015. sqlite3_int64 nOcc; /* 'occurrences' values for current csr row */
  147016. } *aStat;
  147017. };
  147018. /*
  147019. ** Schema of the terms table.
  147020. */
  147021. #define FTS3_AUX_SCHEMA \
  147022. "CREATE TABLE x(term, col, documents, occurrences, languageid HIDDEN)"
  147023. /*
  147024. ** This function does all the work for both the xConnect and xCreate methods.
  147025. ** These tables have no persistent representation of their own, so xConnect
  147026. ** and xCreate are identical operations.
  147027. */
  147028. static int fts3auxConnectMethod(
  147029. sqlite3 *db, /* Database connection */
  147030. void *pUnused, /* Unused */
  147031. int argc, /* Number of elements in argv array */
  147032. const char * const *argv, /* xCreate/xConnect argument array */
  147033. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  147034. char **pzErr /* OUT: sqlite3_malloc'd error message */
  147035. ){
  147036. char const *zDb; /* Name of database (e.g. "main") */
  147037. char const *zFts3; /* Name of fts3 table */
  147038. int nDb; /* Result of strlen(zDb) */
  147039. int nFts3; /* Result of strlen(zFts3) */
  147040. int nByte; /* Bytes of space to allocate here */
  147041. int rc; /* value returned by declare_vtab() */
  147042. Fts3auxTable *p; /* Virtual table object to return */
  147043. UNUSED_PARAMETER(pUnused);
  147044. /* The user should invoke this in one of two forms:
  147045. **
  147046. ** CREATE VIRTUAL TABLE xxx USING fts4aux(fts4-table);
  147047. ** CREATE VIRTUAL TABLE xxx USING fts4aux(fts4-table-db, fts4-table);
  147048. */
  147049. if( argc!=4 && argc!=5 ) goto bad_args;
  147050. zDb = argv[1];
  147051. nDb = (int)strlen(zDb);
  147052. if( argc==5 ){
  147053. if( nDb==4 && 0==sqlite3_strnicmp("temp", zDb, 4) ){
  147054. zDb = argv[3];
  147055. nDb = (int)strlen(zDb);
  147056. zFts3 = argv[4];
  147057. }else{
  147058. goto bad_args;
  147059. }
  147060. }else{
  147061. zFts3 = argv[3];
  147062. }
  147063. nFts3 = (int)strlen(zFts3);
  147064. rc = sqlite3_declare_vtab(db, FTS3_AUX_SCHEMA);
  147065. if( rc!=SQLITE_OK ) return rc;
  147066. nByte = sizeof(Fts3auxTable) + sizeof(Fts3Table) + nDb + nFts3 + 2;
  147067. p = (Fts3auxTable *)sqlite3_malloc(nByte);
  147068. if( !p ) return SQLITE_NOMEM;
  147069. memset(p, 0, nByte);
  147070. p->pFts3Tab = (Fts3Table *)&p[1];
  147071. p->pFts3Tab->zDb = (char *)&p->pFts3Tab[1];
  147072. p->pFts3Tab->zName = &p->pFts3Tab->zDb[nDb+1];
  147073. p->pFts3Tab->db = db;
  147074. p->pFts3Tab->nIndex = 1;
  147075. memcpy((char *)p->pFts3Tab->zDb, zDb, nDb);
  147076. memcpy((char *)p->pFts3Tab->zName, zFts3, nFts3);
  147077. sqlite3Fts3Dequote((char *)p->pFts3Tab->zName);
  147078. *ppVtab = (sqlite3_vtab *)p;
  147079. return SQLITE_OK;
  147080. bad_args:
  147081. sqlite3Fts3ErrMsg(pzErr, "invalid arguments to fts4aux constructor");
  147082. return SQLITE_ERROR;
  147083. }
  147084. /*
  147085. ** This function does the work for both the xDisconnect and xDestroy methods.
  147086. ** These tables have no persistent representation of their own, so xDisconnect
  147087. ** and xDestroy are identical operations.
  147088. */
  147089. static int fts3auxDisconnectMethod(sqlite3_vtab *pVtab){
  147090. Fts3auxTable *p = (Fts3auxTable *)pVtab;
  147091. Fts3Table *pFts3 = p->pFts3Tab;
  147092. int i;
  147093. /* Free any prepared statements held */
  147094. for(i=0; i<SizeofArray(pFts3->aStmt); i++){
  147095. sqlite3_finalize(pFts3->aStmt[i]);
  147096. }
  147097. sqlite3_free(pFts3->zSegmentsTbl);
  147098. sqlite3_free(p);
  147099. return SQLITE_OK;
  147100. }
  147101. #define FTS4AUX_EQ_CONSTRAINT 1
  147102. #define FTS4AUX_GE_CONSTRAINT 2
  147103. #define FTS4AUX_LE_CONSTRAINT 4
  147104. /*
  147105. ** xBestIndex - Analyze a WHERE and ORDER BY clause.
  147106. */
  147107. static int fts3auxBestIndexMethod(
  147108. sqlite3_vtab *pVTab,
  147109. sqlite3_index_info *pInfo
  147110. ){
  147111. int i;
  147112. int iEq = -1;
  147113. int iGe = -1;
  147114. int iLe = -1;
  147115. int iLangid = -1;
  147116. int iNext = 1; /* Next free argvIndex value */
  147117. UNUSED_PARAMETER(pVTab);
  147118. /* This vtab delivers always results in "ORDER BY term ASC" order. */
  147119. if( pInfo->nOrderBy==1
  147120. && pInfo->aOrderBy[0].iColumn==0
  147121. && pInfo->aOrderBy[0].desc==0
  147122. ){
  147123. pInfo->orderByConsumed = 1;
  147124. }
  147125. /* Search for equality and range constraints on the "term" column.
  147126. ** And equality constraints on the hidden "languageid" column. */
  147127. for(i=0; i<pInfo->nConstraint; i++){
  147128. if( pInfo->aConstraint[i].usable ){
  147129. int op = pInfo->aConstraint[i].op;
  147130. int iCol = pInfo->aConstraint[i].iColumn;
  147131. if( iCol==0 ){
  147132. if( op==SQLITE_INDEX_CONSTRAINT_EQ ) iEq = i;
  147133. if( op==SQLITE_INDEX_CONSTRAINT_LT ) iLe = i;
  147134. if( op==SQLITE_INDEX_CONSTRAINT_LE ) iLe = i;
  147135. if( op==SQLITE_INDEX_CONSTRAINT_GT ) iGe = i;
  147136. if( op==SQLITE_INDEX_CONSTRAINT_GE ) iGe = i;
  147137. }
  147138. if( iCol==4 ){
  147139. if( op==SQLITE_INDEX_CONSTRAINT_EQ ) iLangid = i;
  147140. }
  147141. }
  147142. }
  147143. if( iEq>=0 ){
  147144. pInfo->idxNum = FTS4AUX_EQ_CONSTRAINT;
  147145. pInfo->aConstraintUsage[iEq].argvIndex = iNext++;
  147146. pInfo->estimatedCost = 5;
  147147. }else{
  147148. pInfo->idxNum = 0;
  147149. pInfo->estimatedCost = 20000;
  147150. if( iGe>=0 ){
  147151. pInfo->idxNum += FTS4AUX_GE_CONSTRAINT;
  147152. pInfo->aConstraintUsage[iGe].argvIndex = iNext++;
  147153. pInfo->estimatedCost /= 2;
  147154. }
  147155. if( iLe>=0 ){
  147156. pInfo->idxNum += FTS4AUX_LE_CONSTRAINT;
  147157. pInfo->aConstraintUsage[iLe].argvIndex = iNext++;
  147158. pInfo->estimatedCost /= 2;
  147159. }
  147160. }
  147161. if( iLangid>=0 ){
  147162. pInfo->aConstraintUsage[iLangid].argvIndex = iNext++;
  147163. pInfo->estimatedCost--;
  147164. }
  147165. return SQLITE_OK;
  147166. }
  147167. /*
  147168. ** xOpen - Open a cursor.
  147169. */
  147170. static int fts3auxOpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  147171. Fts3auxCursor *pCsr; /* Pointer to cursor object to return */
  147172. UNUSED_PARAMETER(pVTab);
  147173. pCsr = (Fts3auxCursor *)sqlite3_malloc(sizeof(Fts3auxCursor));
  147174. if( !pCsr ) return SQLITE_NOMEM;
  147175. memset(pCsr, 0, sizeof(Fts3auxCursor));
  147176. *ppCsr = (sqlite3_vtab_cursor *)pCsr;
  147177. return SQLITE_OK;
  147178. }
  147179. /*
  147180. ** xClose - Close a cursor.
  147181. */
  147182. static int fts3auxCloseMethod(sqlite3_vtab_cursor *pCursor){
  147183. Fts3Table *pFts3 = ((Fts3auxTable *)pCursor->pVtab)->pFts3Tab;
  147184. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  147185. sqlite3Fts3SegmentsClose(pFts3);
  147186. sqlite3Fts3SegReaderFinish(&pCsr->csr);
  147187. sqlite3_free((void *)pCsr->filter.zTerm);
  147188. sqlite3_free(pCsr->zStop);
  147189. sqlite3_free(pCsr->aStat);
  147190. sqlite3_free(pCsr);
  147191. return SQLITE_OK;
  147192. }
  147193. static int fts3auxGrowStatArray(Fts3auxCursor *pCsr, int nSize){
  147194. if( nSize>pCsr->nStat ){
  147195. struct Fts3auxColstats *aNew;
  147196. aNew = (struct Fts3auxColstats *)sqlite3_realloc(pCsr->aStat,
  147197. sizeof(struct Fts3auxColstats) * nSize
  147198. );
  147199. if( aNew==0 ) return SQLITE_NOMEM;
  147200. memset(&aNew[pCsr->nStat], 0,
  147201. sizeof(struct Fts3auxColstats) * (nSize - pCsr->nStat)
  147202. );
  147203. pCsr->aStat = aNew;
  147204. pCsr->nStat = nSize;
  147205. }
  147206. return SQLITE_OK;
  147207. }
  147208. /*
  147209. ** xNext - Advance the cursor to the next row, if any.
  147210. */
  147211. static int fts3auxNextMethod(sqlite3_vtab_cursor *pCursor){
  147212. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  147213. Fts3Table *pFts3 = ((Fts3auxTable *)pCursor->pVtab)->pFts3Tab;
  147214. int rc;
  147215. /* Increment our pretend rowid value. */
  147216. pCsr->iRowid++;
  147217. for(pCsr->iCol++; pCsr->iCol<pCsr->nStat; pCsr->iCol++){
  147218. if( pCsr->aStat[pCsr->iCol].nDoc>0 ) return SQLITE_OK;
  147219. }
  147220. rc = sqlite3Fts3SegReaderStep(pFts3, &pCsr->csr);
  147221. if( rc==SQLITE_ROW ){
  147222. int i = 0;
  147223. int nDoclist = pCsr->csr.nDoclist;
  147224. char *aDoclist = pCsr->csr.aDoclist;
  147225. int iCol;
  147226. int eState = 0;
  147227. if( pCsr->zStop ){
  147228. int n = (pCsr->nStop<pCsr->csr.nTerm) ? pCsr->nStop : pCsr->csr.nTerm;
  147229. int mc = memcmp(pCsr->zStop, pCsr->csr.zTerm, n);
  147230. if( mc<0 || (mc==0 && pCsr->csr.nTerm>pCsr->nStop) ){
  147231. pCsr->isEof = 1;
  147232. return SQLITE_OK;
  147233. }
  147234. }
  147235. if( fts3auxGrowStatArray(pCsr, 2) ) return SQLITE_NOMEM;
  147236. memset(pCsr->aStat, 0, sizeof(struct Fts3auxColstats) * pCsr->nStat);
  147237. iCol = 0;
  147238. while( i<nDoclist ){
  147239. sqlite3_int64 v = 0;
  147240. i += sqlite3Fts3GetVarint(&aDoclist[i], &v);
  147241. switch( eState ){
  147242. /* State 0. In this state the integer just read was a docid. */
  147243. case 0:
  147244. pCsr->aStat[0].nDoc++;
  147245. eState = 1;
  147246. iCol = 0;
  147247. break;
  147248. /* State 1. In this state we are expecting either a 1, indicating
  147249. ** that the following integer will be a column number, or the
  147250. ** start of a position list for column 0.
  147251. **
  147252. ** The only difference between state 1 and state 2 is that if the
  147253. ** integer encountered in state 1 is not 0 or 1, then we need to
  147254. ** increment the column 0 "nDoc" count for this term.
  147255. */
  147256. case 1:
  147257. assert( iCol==0 );
  147258. if( v>1 ){
  147259. pCsr->aStat[1].nDoc++;
  147260. }
  147261. eState = 2;
  147262. /* fall through */
  147263. case 2:
  147264. if( v==0 ){ /* 0x00. Next integer will be a docid. */
  147265. eState = 0;
  147266. }else if( v==1 ){ /* 0x01. Next integer will be a column number. */
  147267. eState = 3;
  147268. }else{ /* 2 or greater. A position. */
  147269. pCsr->aStat[iCol+1].nOcc++;
  147270. pCsr->aStat[0].nOcc++;
  147271. }
  147272. break;
  147273. /* State 3. The integer just read is a column number. */
  147274. default: assert( eState==3 );
  147275. iCol = (int)v;
  147276. if( fts3auxGrowStatArray(pCsr, iCol+2) ) return SQLITE_NOMEM;
  147277. pCsr->aStat[iCol+1].nDoc++;
  147278. eState = 2;
  147279. break;
  147280. }
  147281. }
  147282. pCsr->iCol = 0;
  147283. rc = SQLITE_OK;
  147284. }else{
  147285. pCsr->isEof = 1;
  147286. }
  147287. return rc;
  147288. }
  147289. /*
  147290. ** xFilter - Initialize a cursor to point at the start of its data.
  147291. */
  147292. static int fts3auxFilterMethod(
  147293. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  147294. int idxNum, /* Strategy index */
  147295. const char *idxStr, /* Unused */
  147296. int nVal, /* Number of elements in apVal */
  147297. sqlite3_value **apVal /* Arguments for the indexing scheme */
  147298. ){
  147299. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  147300. Fts3Table *pFts3 = ((Fts3auxTable *)pCursor->pVtab)->pFts3Tab;
  147301. int rc;
  147302. int isScan = 0;
  147303. int iLangVal = 0; /* Language id to query */
  147304. int iEq = -1; /* Index of term=? value in apVal */
  147305. int iGe = -1; /* Index of term>=? value in apVal */
  147306. int iLe = -1; /* Index of term<=? value in apVal */
  147307. int iLangid = -1; /* Index of languageid=? value in apVal */
  147308. int iNext = 0;
  147309. UNUSED_PARAMETER(nVal);
  147310. UNUSED_PARAMETER(idxStr);
  147311. assert( idxStr==0 );
  147312. assert( idxNum==FTS4AUX_EQ_CONSTRAINT || idxNum==0
  147313. || idxNum==FTS4AUX_LE_CONSTRAINT || idxNum==FTS4AUX_GE_CONSTRAINT
  147314. || idxNum==(FTS4AUX_LE_CONSTRAINT|FTS4AUX_GE_CONSTRAINT)
  147315. );
  147316. if( idxNum==FTS4AUX_EQ_CONSTRAINT ){
  147317. iEq = iNext++;
  147318. }else{
  147319. isScan = 1;
  147320. if( idxNum & FTS4AUX_GE_CONSTRAINT ){
  147321. iGe = iNext++;
  147322. }
  147323. if( idxNum & FTS4AUX_LE_CONSTRAINT ){
  147324. iLe = iNext++;
  147325. }
  147326. }
  147327. if( iNext<nVal ){
  147328. iLangid = iNext++;
  147329. }
  147330. /* In case this cursor is being reused, close and zero it. */
  147331. testcase(pCsr->filter.zTerm);
  147332. sqlite3Fts3SegReaderFinish(&pCsr->csr);
  147333. sqlite3_free((void *)pCsr->filter.zTerm);
  147334. sqlite3_free(pCsr->aStat);
  147335. memset(&pCsr->csr, 0, ((u8*)&pCsr[1]) - (u8*)&pCsr->csr);
  147336. pCsr->filter.flags = FTS3_SEGMENT_REQUIRE_POS|FTS3_SEGMENT_IGNORE_EMPTY;
  147337. if( isScan ) pCsr->filter.flags |= FTS3_SEGMENT_SCAN;
  147338. if( iEq>=0 || iGe>=0 ){
  147339. const unsigned char *zStr = sqlite3_value_text(apVal[0]);
  147340. assert( (iEq==0 && iGe==-1) || (iEq==-1 && iGe==0) );
  147341. if( zStr ){
  147342. pCsr->filter.zTerm = sqlite3_mprintf("%s", zStr);
  147343. pCsr->filter.nTerm = sqlite3_value_bytes(apVal[0]);
  147344. if( pCsr->filter.zTerm==0 ) return SQLITE_NOMEM;
  147345. }
  147346. }
  147347. if( iLe>=0 ){
  147348. pCsr->zStop = sqlite3_mprintf("%s", sqlite3_value_text(apVal[iLe]));
  147349. pCsr->nStop = sqlite3_value_bytes(apVal[iLe]);
  147350. if( pCsr->zStop==0 ) return SQLITE_NOMEM;
  147351. }
  147352. if( iLangid>=0 ){
  147353. iLangVal = sqlite3_value_int(apVal[iLangid]);
  147354. /* If the user specified a negative value for the languageid, use zero
  147355. ** instead. This works, as the "languageid=?" constraint will also
  147356. ** be tested by the VDBE layer. The test will always be false (since
  147357. ** this module will not return a row with a negative languageid), and
  147358. ** so the overall query will return zero rows. */
  147359. if( iLangVal<0 ) iLangVal = 0;
  147360. }
  147361. pCsr->iLangid = iLangVal;
  147362. rc = sqlite3Fts3SegReaderCursor(pFts3, iLangVal, 0, FTS3_SEGCURSOR_ALL,
  147363. pCsr->filter.zTerm, pCsr->filter.nTerm, 0, isScan, &pCsr->csr
  147364. );
  147365. if( rc==SQLITE_OK ){
  147366. rc = sqlite3Fts3SegReaderStart(pFts3, &pCsr->csr, &pCsr->filter);
  147367. }
  147368. if( rc==SQLITE_OK ) rc = fts3auxNextMethod(pCursor);
  147369. return rc;
  147370. }
  147371. /*
  147372. ** xEof - Return true if the cursor is at EOF, or false otherwise.
  147373. */
  147374. static int fts3auxEofMethod(sqlite3_vtab_cursor *pCursor){
  147375. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  147376. return pCsr->isEof;
  147377. }
  147378. /*
  147379. ** xColumn - Return a column value.
  147380. */
  147381. static int fts3auxColumnMethod(
  147382. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  147383. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  147384. int iCol /* Index of column to read value from */
  147385. ){
  147386. Fts3auxCursor *p = (Fts3auxCursor *)pCursor;
  147387. assert( p->isEof==0 );
  147388. switch( iCol ){
  147389. case 0: /* term */
  147390. sqlite3_result_text(pCtx, p->csr.zTerm, p->csr.nTerm, SQLITE_TRANSIENT);
  147391. break;
  147392. case 1: /* col */
  147393. if( p->iCol ){
  147394. sqlite3_result_int(pCtx, p->iCol-1);
  147395. }else{
  147396. sqlite3_result_text(pCtx, "*", -1, SQLITE_STATIC);
  147397. }
  147398. break;
  147399. case 2: /* documents */
  147400. sqlite3_result_int64(pCtx, p->aStat[p->iCol].nDoc);
  147401. break;
  147402. case 3: /* occurrences */
  147403. sqlite3_result_int64(pCtx, p->aStat[p->iCol].nOcc);
  147404. break;
  147405. default: /* languageid */
  147406. assert( iCol==4 );
  147407. sqlite3_result_int(pCtx, p->iLangid);
  147408. break;
  147409. }
  147410. return SQLITE_OK;
  147411. }
  147412. /*
  147413. ** xRowid - Return the current rowid for the cursor.
  147414. */
  147415. static int fts3auxRowidMethod(
  147416. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  147417. sqlite_int64 *pRowid /* OUT: Rowid value */
  147418. ){
  147419. Fts3auxCursor *pCsr = (Fts3auxCursor *)pCursor;
  147420. *pRowid = pCsr->iRowid;
  147421. return SQLITE_OK;
  147422. }
  147423. /*
  147424. ** Register the fts3aux module with database connection db. Return SQLITE_OK
  147425. ** if successful or an error code if sqlite3_create_module() fails.
  147426. */
  147427. SQLITE_PRIVATE int sqlite3Fts3InitAux(sqlite3 *db){
  147428. static const sqlite3_module fts3aux_module = {
  147429. 0, /* iVersion */
  147430. fts3auxConnectMethod, /* xCreate */
  147431. fts3auxConnectMethod, /* xConnect */
  147432. fts3auxBestIndexMethod, /* xBestIndex */
  147433. fts3auxDisconnectMethod, /* xDisconnect */
  147434. fts3auxDisconnectMethod, /* xDestroy */
  147435. fts3auxOpenMethod, /* xOpen */
  147436. fts3auxCloseMethod, /* xClose */
  147437. fts3auxFilterMethod, /* xFilter */
  147438. fts3auxNextMethod, /* xNext */
  147439. fts3auxEofMethod, /* xEof */
  147440. fts3auxColumnMethod, /* xColumn */
  147441. fts3auxRowidMethod, /* xRowid */
  147442. 0, /* xUpdate */
  147443. 0, /* xBegin */
  147444. 0, /* xSync */
  147445. 0, /* xCommit */
  147446. 0, /* xRollback */
  147447. 0, /* xFindFunction */
  147448. 0, /* xRename */
  147449. 0, /* xSavepoint */
  147450. 0, /* xRelease */
  147451. 0 /* xRollbackTo */
  147452. };
  147453. int rc; /* Return code */
  147454. rc = sqlite3_create_module(db, "fts4aux", &fts3aux_module, 0);
  147455. return rc;
  147456. }
  147457. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  147458. /************** End of fts3_aux.c ********************************************/
  147459. /************** Begin file fts3_expr.c ***************************************/
  147460. /*
  147461. ** 2008 Nov 28
  147462. **
  147463. ** The author disclaims copyright to this source code. In place of
  147464. ** a legal notice, here is a blessing:
  147465. **
  147466. ** May you do good and not evil.
  147467. ** May you find forgiveness for yourself and forgive others.
  147468. ** May you share freely, never taking more than you give.
  147469. **
  147470. ******************************************************************************
  147471. **
  147472. ** This module contains code that implements a parser for fts3 query strings
  147473. ** (the right-hand argument to the MATCH operator). Because the supported
  147474. ** syntax is relatively simple, the whole tokenizer/parser system is
  147475. ** hand-coded.
  147476. */
  147477. /* #include "fts3Int.h" */
  147478. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  147479. /*
  147480. ** By default, this module parses the legacy syntax that has been
  147481. ** traditionally used by fts3. Or, if SQLITE_ENABLE_FTS3_PARENTHESIS
  147482. ** is defined, then it uses the new syntax. The differences between
  147483. ** the new and the old syntaxes are:
  147484. **
  147485. ** a) The new syntax supports parenthesis. The old does not.
  147486. **
  147487. ** b) The new syntax supports the AND and NOT operators. The old does not.
  147488. **
  147489. ** c) The old syntax supports the "-" token qualifier. This is not
  147490. ** supported by the new syntax (it is replaced by the NOT operator).
  147491. **
  147492. ** d) When using the old syntax, the OR operator has a greater precedence
  147493. ** than an implicit AND. When using the new, both implicity and explicit
  147494. ** AND operators have a higher precedence than OR.
  147495. **
  147496. ** If compiled with SQLITE_TEST defined, then this module exports the
  147497. ** symbol "int sqlite3_fts3_enable_parentheses". Setting this variable
  147498. ** to zero causes the module to use the old syntax. If it is set to
  147499. ** non-zero the new syntax is activated. This is so both syntaxes can
  147500. ** be tested using a single build of testfixture.
  147501. **
  147502. ** The following describes the syntax supported by the fts3 MATCH
  147503. ** operator in a similar format to that used by the lemon parser
  147504. ** generator. This module does not use actually lemon, it uses a
  147505. ** custom parser.
  147506. **
  147507. ** query ::= andexpr (OR andexpr)*.
  147508. **
  147509. ** andexpr ::= notexpr (AND? notexpr)*.
  147510. **
  147511. ** notexpr ::= nearexpr (NOT nearexpr|-TOKEN)*.
  147512. ** notexpr ::= LP query RP.
  147513. **
  147514. ** nearexpr ::= phrase (NEAR distance_opt nearexpr)*.
  147515. **
  147516. ** distance_opt ::= .
  147517. ** distance_opt ::= / INTEGER.
  147518. **
  147519. ** phrase ::= TOKEN.
  147520. ** phrase ::= COLUMN:TOKEN.
  147521. ** phrase ::= "TOKEN TOKEN TOKEN...".
  147522. */
  147523. #ifdef SQLITE_TEST
  147524. SQLITE_API int sqlite3_fts3_enable_parentheses = 0;
  147525. #else
  147526. # ifdef SQLITE_ENABLE_FTS3_PARENTHESIS
  147527. # define sqlite3_fts3_enable_parentheses 1
  147528. # else
  147529. # define sqlite3_fts3_enable_parentheses 0
  147530. # endif
  147531. #endif
  147532. /*
  147533. ** Default span for NEAR operators.
  147534. */
  147535. #define SQLITE_FTS3_DEFAULT_NEAR_PARAM 10
  147536. /* #include <string.h> */
  147537. /* #include <assert.h> */
  147538. /*
  147539. ** isNot:
  147540. ** This variable is used by function getNextNode(). When getNextNode() is
  147541. ** called, it sets ParseContext.isNot to true if the 'next node' is a
  147542. ** FTSQUERY_PHRASE with a unary "-" attached to it. i.e. "mysql" in the
  147543. ** FTS3 query "sqlite -mysql". Otherwise, ParseContext.isNot is set to
  147544. ** zero.
  147545. */
  147546. typedef struct ParseContext ParseContext;
  147547. struct ParseContext {
  147548. sqlite3_tokenizer *pTokenizer; /* Tokenizer module */
  147549. int iLangid; /* Language id used with tokenizer */
  147550. const char **azCol; /* Array of column names for fts3 table */
  147551. int bFts4; /* True to allow FTS4-only syntax */
  147552. int nCol; /* Number of entries in azCol[] */
  147553. int iDefaultCol; /* Default column to query */
  147554. int isNot; /* True if getNextNode() sees a unary - */
  147555. sqlite3_context *pCtx; /* Write error message here */
  147556. int nNest; /* Number of nested brackets */
  147557. };
  147558. /*
  147559. ** This function is equivalent to the standard isspace() function.
  147560. **
  147561. ** The standard isspace() can be awkward to use safely, because although it
  147562. ** is defined to accept an argument of type int, its behavior when passed
  147563. ** an integer that falls outside of the range of the unsigned char type
  147564. ** is undefined (and sometimes, "undefined" means segfault). This wrapper
  147565. ** is defined to accept an argument of type char, and always returns 0 for
  147566. ** any values that fall outside of the range of the unsigned char type (i.e.
  147567. ** negative values).
  147568. */
  147569. static int fts3isspace(char c){
  147570. return c==' ' || c=='\t' || c=='\n' || c=='\r' || c=='\v' || c=='\f';
  147571. }
  147572. /*
  147573. ** Allocate nByte bytes of memory using sqlite3_malloc(). If successful,
  147574. ** zero the memory before returning a pointer to it. If unsuccessful,
  147575. ** return NULL.
  147576. */
  147577. static void *fts3MallocZero(int nByte){
  147578. void *pRet = sqlite3_malloc(nByte);
  147579. if( pRet ) memset(pRet, 0, nByte);
  147580. return pRet;
  147581. }
  147582. SQLITE_PRIVATE int sqlite3Fts3OpenTokenizer(
  147583. sqlite3_tokenizer *pTokenizer,
  147584. int iLangid,
  147585. const char *z,
  147586. int n,
  147587. sqlite3_tokenizer_cursor **ppCsr
  147588. ){
  147589. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  147590. sqlite3_tokenizer_cursor *pCsr = 0;
  147591. int rc;
  147592. rc = pModule->xOpen(pTokenizer, z, n, &pCsr);
  147593. assert( rc==SQLITE_OK || pCsr==0 );
  147594. if( rc==SQLITE_OK ){
  147595. pCsr->pTokenizer = pTokenizer;
  147596. if( pModule->iVersion>=1 ){
  147597. rc = pModule->xLanguageid(pCsr, iLangid);
  147598. if( rc!=SQLITE_OK ){
  147599. pModule->xClose(pCsr);
  147600. pCsr = 0;
  147601. }
  147602. }
  147603. }
  147604. *ppCsr = pCsr;
  147605. return rc;
  147606. }
  147607. /*
  147608. ** Function getNextNode(), which is called by fts3ExprParse(), may itself
  147609. ** call fts3ExprParse(). So this forward declaration is required.
  147610. */
  147611. static int fts3ExprParse(ParseContext *, const char *, int, Fts3Expr **, int *);
  147612. /*
  147613. ** Extract the next token from buffer z (length n) using the tokenizer
  147614. ** and other information (column names etc.) in pParse. Create an Fts3Expr
  147615. ** structure of type FTSQUERY_PHRASE containing a phrase consisting of this
  147616. ** single token and set *ppExpr to point to it. If the end of the buffer is
  147617. ** reached before a token is found, set *ppExpr to zero. It is the
  147618. ** responsibility of the caller to eventually deallocate the allocated
  147619. ** Fts3Expr structure (if any) by passing it to sqlite3_free().
  147620. **
  147621. ** Return SQLITE_OK if successful, or SQLITE_NOMEM if a memory allocation
  147622. ** fails.
  147623. */
  147624. static int getNextToken(
  147625. ParseContext *pParse, /* fts3 query parse context */
  147626. int iCol, /* Value for Fts3Phrase.iColumn */
  147627. const char *z, int n, /* Input string */
  147628. Fts3Expr **ppExpr, /* OUT: expression */
  147629. int *pnConsumed /* OUT: Number of bytes consumed */
  147630. ){
  147631. sqlite3_tokenizer *pTokenizer = pParse->pTokenizer;
  147632. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  147633. int rc;
  147634. sqlite3_tokenizer_cursor *pCursor;
  147635. Fts3Expr *pRet = 0;
  147636. int i = 0;
  147637. /* Set variable i to the maximum number of bytes of input to tokenize. */
  147638. for(i=0; i<n; i++){
  147639. if( sqlite3_fts3_enable_parentheses && (z[i]=='(' || z[i]==')') ) break;
  147640. if( z[i]=='"' ) break;
  147641. }
  147642. *pnConsumed = i;
  147643. rc = sqlite3Fts3OpenTokenizer(pTokenizer, pParse->iLangid, z, i, &pCursor);
  147644. if( rc==SQLITE_OK ){
  147645. const char *zToken;
  147646. int nToken = 0, iStart = 0, iEnd = 0, iPosition = 0;
  147647. int nByte; /* total space to allocate */
  147648. rc = pModule->xNext(pCursor, &zToken, &nToken, &iStart, &iEnd, &iPosition);
  147649. if( rc==SQLITE_OK ){
  147650. nByte = sizeof(Fts3Expr) + sizeof(Fts3Phrase) + nToken;
  147651. pRet = (Fts3Expr *)fts3MallocZero(nByte);
  147652. if( !pRet ){
  147653. rc = SQLITE_NOMEM;
  147654. }else{
  147655. pRet->eType = FTSQUERY_PHRASE;
  147656. pRet->pPhrase = (Fts3Phrase *)&pRet[1];
  147657. pRet->pPhrase->nToken = 1;
  147658. pRet->pPhrase->iColumn = iCol;
  147659. pRet->pPhrase->aToken[0].n = nToken;
  147660. pRet->pPhrase->aToken[0].z = (char *)&pRet->pPhrase[1];
  147661. memcpy(pRet->pPhrase->aToken[0].z, zToken, nToken);
  147662. if( iEnd<n && z[iEnd]=='*' ){
  147663. pRet->pPhrase->aToken[0].isPrefix = 1;
  147664. iEnd++;
  147665. }
  147666. while( 1 ){
  147667. if( !sqlite3_fts3_enable_parentheses
  147668. && iStart>0 && z[iStart-1]=='-'
  147669. ){
  147670. pParse->isNot = 1;
  147671. iStart--;
  147672. }else if( pParse->bFts4 && iStart>0 && z[iStart-1]=='^' ){
  147673. pRet->pPhrase->aToken[0].bFirst = 1;
  147674. iStart--;
  147675. }else{
  147676. break;
  147677. }
  147678. }
  147679. }
  147680. *pnConsumed = iEnd;
  147681. }else if( i && rc==SQLITE_DONE ){
  147682. rc = SQLITE_OK;
  147683. }
  147684. pModule->xClose(pCursor);
  147685. }
  147686. *ppExpr = pRet;
  147687. return rc;
  147688. }
  147689. /*
  147690. ** Enlarge a memory allocation. If an out-of-memory allocation occurs,
  147691. ** then free the old allocation.
  147692. */
  147693. static void *fts3ReallocOrFree(void *pOrig, int nNew){
  147694. void *pRet = sqlite3_realloc(pOrig, nNew);
  147695. if( !pRet ){
  147696. sqlite3_free(pOrig);
  147697. }
  147698. return pRet;
  147699. }
  147700. /*
  147701. ** Buffer zInput, length nInput, contains the contents of a quoted string
  147702. ** that appeared as part of an fts3 query expression. Neither quote character
  147703. ** is included in the buffer. This function attempts to tokenize the entire
  147704. ** input buffer and create an Fts3Expr structure of type FTSQUERY_PHRASE
  147705. ** containing the results.
  147706. **
  147707. ** If successful, SQLITE_OK is returned and *ppExpr set to point at the
  147708. ** allocated Fts3Expr structure. Otherwise, either SQLITE_NOMEM (out of memory
  147709. ** error) or SQLITE_ERROR (tokenization error) is returned and *ppExpr set
  147710. ** to 0.
  147711. */
  147712. static int getNextString(
  147713. ParseContext *pParse, /* fts3 query parse context */
  147714. const char *zInput, int nInput, /* Input string */
  147715. Fts3Expr **ppExpr /* OUT: expression */
  147716. ){
  147717. sqlite3_tokenizer *pTokenizer = pParse->pTokenizer;
  147718. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  147719. int rc;
  147720. Fts3Expr *p = 0;
  147721. sqlite3_tokenizer_cursor *pCursor = 0;
  147722. char *zTemp = 0;
  147723. int nTemp = 0;
  147724. const int nSpace = sizeof(Fts3Expr) + sizeof(Fts3Phrase);
  147725. int nToken = 0;
  147726. /* The final Fts3Expr data structure, including the Fts3Phrase,
  147727. ** Fts3PhraseToken structures token buffers are all stored as a single
  147728. ** allocation so that the expression can be freed with a single call to
  147729. ** sqlite3_free(). Setting this up requires a two pass approach.
  147730. **
  147731. ** The first pass, in the block below, uses a tokenizer cursor to iterate
  147732. ** through the tokens in the expression. This pass uses fts3ReallocOrFree()
  147733. ** to assemble data in two dynamic buffers:
  147734. **
  147735. ** Buffer p: Points to the Fts3Expr structure, followed by the Fts3Phrase
  147736. ** structure, followed by the array of Fts3PhraseToken
  147737. ** structures. This pass only populates the Fts3PhraseToken array.
  147738. **
  147739. ** Buffer zTemp: Contains copies of all tokens.
  147740. **
  147741. ** The second pass, in the block that begins "if( rc==SQLITE_DONE )" below,
  147742. ** appends buffer zTemp to buffer p, and fills in the Fts3Expr and Fts3Phrase
  147743. ** structures.
  147744. */
  147745. rc = sqlite3Fts3OpenTokenizer(
  147746. pTokenizer, pParse->iLangid, zInput, nInput, &pCursor);
  147747. if( rc==SQLITE_OK ){
  147748. int ii;
  147749. for(ii=0; rc==SQLITE_OK; ii++){
  147750. const char *zByte;
  147751. int nByte = 0, iBegin = 0, iEnd = 0, iPos = 0;
  147752. rc = pModule->xNext(pCursor, &zByte, &nByte, &iBegin, &iEnd, &iPos);
  147753. if( rc==SQLITE_OK ){
  147754. Fts3PhraseToken *pToken;
  147755. p = fts3ReallocOrFree(p, nSpace + ii*sizeof(Fts3PhraseToken));
  147756. if( !p ) goto no_mem;
  147757. zTemp = fts3ReallocOrFree(zTemp, nTemp + nByte);
  147758. if( !zTemp ) goto no_mem;
  147759. assert( nToken==ii );
  147760. pToken = &((Fts3Phrase *)(&p[1]))->aToken[ii];
  147761. memset(pToken, 0, sizeof(Fts3PhraseToken));
  147762. memcpy(&zTemp[nTemp], zByte, nByte);
  147763. nTemp += nByte;
  147764. pToken->n = nByte;
  147765. pToken->isPrefix = (iEnd<nInput && zInput[iEnd]=='*');
  147766. pToken->bFirst = (iBegin>0 && zInput[iBegin-1]=='^');
  147767. nToken = ii+1;
  147768. }
  147769. }
  147770. pModule->xClose(pCursor);
  147771. pCursor = 0;
  147772. }
  147773. if( rc==SQLITE_DONE ){
  147774. int jj;
  147775. char *zBuf = 0;
  147776. p = fts3ReallocOrFree(p, nSpace + nToken*sizeof(Fts3PhraseToken) + nTemp);
  147777. if( !p ) goto no_mem;
  147778. memset(p, 0, (char *)&(((Fts3Phrase *)&p[1])->aToken[0])-(char *)p);
  147779. p->eType = FTSQUERY_PHRASE;
  147780. p->pPhrase = (Fts3Phrase *)&p[1];
  147781. p->pPhrase->iColumn = pParse->iDefaultCol;
  147782. p->pPhrase->nToken = nToken;
  147783. zBuf = (char *)&p->pPhrase->aToken[nToken];
  147784. if( zTemp ){
  147785. memcpy(zBuf, zTemp, nTemp);
  147786. sqlite3_free(zTemp);
  147787. }else{
  147788. assert( nTemp==0 );
  147789. }
  147790. for(jj=0; jj<p->pPhrase->nToken; jj++){
  147791. p->pPhrase->aToken[jj].z = zBuf;
  147792. zBuf += p->pPhrase->aToken[jj].n;
  147793. }
  147794. rc = SQLITE_OK;
  147795. }
  147796. *ppExpr = p;
  147797. return rc;
  147798. no_mem:
  147799. if( pCursor ){
  147800. pModule->xClose(pCursor);
  147801. }
  147802. sqlite3_free(zTemp);
  147803. sqlite3_free(p);
  147804. *ppExpr = 0;
  147805. return SQLITE_NOMEM;
  147806. }
  147807. /*
  147808. ** The output variable *ppExpr is populated with an allocated Fts3Expr
  147809. ** structure, or set to 0 if the end of the input buffer is reached.
  147810. **
  147811. ** Returns an SQLite error code. SQLITE_OK if everything works, SQLITE_NOMEM
  147812. ** if a malloc failure occurs, or SQLITE_ERROR if a parse error is encountered.
  147813. ** If SQLITE_ERROR is returned, pContext is populated with an error message.
  147814. */
  147815. static int getNextNode(
  147816. ParseContext *pParse, /* fts3 query parse context */
  147817. const char *z, int n, /* Input string */
  147818. Fts3Expr **ppExpr, /* OUT: expression */
  147819. int *pnConsumed /* OUT: Number of bytes consumed */
  147820. ){
  147821. static const struct Fts3Keyword {
  147822. char *z; /* Keyword text */
  147823. unsigned char n; /* Length of the keyword */
  147824. unsigned char parenOnly; /* Only valid in paren mode */
  147825. unsigned char eType; /* Keyword code */
  147826. } aKeyword[] = {
  147827. { "OR" , 2, 0, FTSQUERY_OR },
  147828. { "AND", 3, 1, FTSQUERY_AND },
  147829. { "NOT", 3, 1, FTSQUERY_NOT },
  147830. { "NEAR", 4, 0, FTSQUERY_NEAR }
  147831. };
  147832. int ii;
  147833. int iCol;
  147834. int iColLen;
  147835. int rc;
  147836. Fts3Expr *pRet = 0;
  147837. const char *zInput = z;
  147838. int nInput = n;
  147839. pParse->isNot = 0;
  147840. /* Skip over any whitespace before checking for a keyword, an open or
  147841. ** close bracket, or a quoted string.
  147842. */
  147843. while( nInput>0 && fts3isspace(*zInput) ){
  147844. nInput--;
  147845. zInput++;
  147846. }
  147847. if( nInput==0 ){
  147848. return SQLITE_DONE;
  147849. }
  147850. /* See if we are dealing with a keyword. */
  147851. for(ii=0; ii<(int)(sizeof(aKeyword)/sizeof(struct Fts3Keyword)); ii++){
  147852. const struct Fts3Keyword *pKey = &aKeyword[ii];
  147853. if( (pKey->parenOnly & ~sqlite3_fts3_enable_parentheses)!=0 ){
  147854. continue;
  147855. }
  147856. if( nInput>=pKey->n && 0==memcmp(zInput, pKey->z, pKey->n) ){
  147857. int nNear = SQLITE_FTS3_DEFAULT_NEAR_PARAM;
  147858. int nKey = pKey->n;
  147859. char cNext;
  147860. /* If this is a "NEAR" keyword, check for an explicit nearness. */
  147861. if( pKey->eType==FTSQUERY_NEAR ){
  147862. assert( nKey==4 );
  147863. if( zInput[4]=='/' && zInput[5]>='0' && zInput[5]<='9' ){
  147864. nNear = 0;
  147865. for(nKey=5; zInput[nKey]>='0' && zInput[nKey]<='9'; nKey++){
  147866. nNear = nNear * 10 + (zInput[nKey] - '0');
  147867. }
  147868. }
  147869. }
  147870. /* At this point this is probably a keyword. But for that to be true,
  147871. ** the next byte must contain either whitespace, an open or close
  147872. ** parenthesis, a quote character, or EOF.
  147873. */
  147874. cNext = zInput[nKey];
  147875. if( fts3isspace(cNext)
  147876. || cNext=='"' || cNext=='(' || cNext==')' || cNext==0
  147877. ){
  147878. pRet = (Fts3Expr *)fts3MallocZero(sizeof(Fts3Expr));
  147879. if( !pRet ){
  147880. return SQLITE_NOMEM;
  147881. }
  147882. pRet->eType = pKey->eType;
  147883. pRet->nNear = nNear;
  147884. *ppExpr = pRet;
  147885. *pnConsumed = (int)((zInput - z) + nKey);
  147886. return SQLITE_OK;
  147887. }
  147888. /* Turns out that wasn't a keyword after all. This happens if the
  147889. ** user has supplied a token such as "ORacle". Continue.
  147890. */
  147891. }
  147892. }
  147893. /* See if we are dealing with a quoted phrase. If this is the case, then
  147894. ** search for the closing quote and pass the whole string to getNextString()
  147895. ** for processing. This is easy to do, as fts3 has no syntax for escaping
  147896. ** a quote character embedded in a string.
  147897. */
  147898. if( *zInput=='"' ){
  147899. for(ii=1; ii<nInput && zInput[ii]!='"'; ii++);
  147900. *pnConsumed = (int)((zInput - z) + ii + 1);
  147901. if( ii==nInput ){
  147902. return SQLITE_ERROR;
  147903. }
  147904. return getNextString(pParse, &zInput[1], ii-1, ppExpr);
  147905. }
  147906. if( sqlite3_fts3_enable_parentheses ){
  147907. if( *zInput=='(' ){
  147908. int nConsumed = 0;
  147909. pParse->nNest++;
  147910. rc = fts3ExprParse(pParse, zInput+1, nInput-1, ppExpr, &nConsumed);
  147911. if( rc==SQLITE_OK && !*ppExpr ){ rc = SQLITE_DONE; }
  147912. *pnConsumed = (int)(zInput - z) + 1 + nConsumed;
  147913. return rc;
  147914. }else if( *zInput==')' ){
  147915. pParse->nNest--;
  147916. *pnConsumed = (int)((zInput - z) + 1);
  147917. *ppExpr = 0;
  147918. return SQLITE_DONE;
  147919. }
  147920. }
  147921. /* If control flows to this point, this must be a regular token, or
  147922. ** the end of the input. Read a regular token using the sqlite3_tokenizer
  147923. ** interface. Before doing so, figure out if there is an explicit
  147924. ** column specifier for the token.
  147925. **
  147926. ** TODO: Strangely, it is not possible to associate a column specifier
  147927. ** with a quoted phrase, only with a single token. Not sure if this was
  147928. ** an implementation artifact or an intentional decision when fts3 was
  147929. ** first implemented. Whichever it was, this module duplicates the
  147930. ** limitation.
  147931. */
  147932. iCol = pParse->iDefaultCol;
  147933. iColLen = 0;
  147934. for(ii=0; ii<pParse->nCol; ii++){
  147935. const char *zStr = pParse->azCol[ii];
  147936. int nStr = (int)strlen(zStr);
  147937. if( nInput>nStr && zInput[nStr]==':'
  147938. && sqlite3_strnicmp(zStr, zInput, nStr)==0
  147939. ){
  147940. iCol = ii;
  147941. iColLen = (int)((zInput - z) + nStr + 1);
  147942. break;
  147943. }
  147944. }
  147945. rc = getNextToken(pParse, iCol, &z[iColLen], n-iColLen, ppExpr, pnConsumed);
  147946. *pnConsumed += iColLen;
  147947. return rc;
  147948. }
  147949. /*
  147950. ** The argument is an Fts3Expr structure for a binary operator (any type
  147951. ** except an FTSQUERY_PHRASE). Return an integer value representing the
  147952. ** precedence of the operator. Lower values have a higher precedence (i.e.
  147953. ** group more tightly). For example, in the C language, the == operator
  147954. ** groups more tightly than ||, and would therefore have a higher precedence.
  147955. **
  147956. ** When using the new fts3 query syntax (when SQLITE_ENABLE_FTS3_PARENTHESIS
  147957. ** is defined), the order of the operators in precedence from highest to
  147958. ** lowest is:
  147959. **
  147960. ** NEAR
  147961. ** NOT
  147962. ** AND (including implicit ANDs)
  147963. ** OR
  147964. **
  147965. ** Note that when using the old query syntax, the OR operator has a higher
  147966. ** precedence than the AND operator.
  147967. */
  147968. static int opPrecedence(Fts3Expr *p){
  147969. assert( p->eType!=FTSQUERY_PHRASE );
  147970. if( sqlite3_fts3_enable_parentheses ){
  147971. return p->eType;
  147972. }else if( p->eType==FTSQUERY_NEAR ){
  147973. return 1;
  147974. }else if( p->eType==FTSQUERY_OR ){
  147975. return 2;
  147976. }
  147977. assert( p->eType==FTSQUERY_AND );
  147978. return 3;
  147979. }
  147980. /*
  147981. ** Argument ppHead contains a pointer to the current head of a query
  147982. ** expression tree being parsed. pPrev is the expression node most recently
  147983. ** inserted into the tree. This function adds pNew, which is always a binary
  147984. ** operator node, into the expression tree based on the relative precedence
  147985. ** of pNew and the existing nodes of the tree. This may result in the head
  147986. ** of the tree changing, in which case *ppHead is set to the new root node.
  147987. */
  147988. static void insertBinaryOperator(
  147989. Fts3Expr **ppHead, /* Pointer to the root node of a tree */
  147990. Fts3Expr *pPrev, /* Node most recently inserted into the tree */
  147991. Fts3Expr *pNew /* New binary node to insert into expression tree */
  147992. ){
  147993. Fts3Expr *pSplit = pPrev;
  147994. while( pSplit->pParent && opPrecedence(pSplit->pParent)<=opPrecedence(pNew) ){
  147995. pSplit = pSplit->pParent;
  147996. }
  147997. if( pSplit->pParent ){
  147998. assert( pSplit->pParent->pRight==pSplit );
  147999. pSplit->pParent->pRight = pNew;
  148000. pNew->pParent = pSplit->pParent;
  148001. }else{
  148002. *ppHead = pNew;
  148003. }
  148004. pNew->pLeft = pSplit;
  148005. pSplit->pParent = pNew;
  148006. }
  148007. /*
  148008. ** Parse the fts3 query expression found in buffer z, length n. This function
  148009. ** returns either when the end of the buffer is reached or an unmatched
  148010. ** closing bracket - ')' - is encountered.
  148011. **
  148012. ** If successful, SQLITE_OK is returned, *ppExpr is set to point to the
  148013. ** parsed form of the expression and *pnConsumed is set to the number of
  148014. ** bytes read from buffer z. Otherwise, *ppExpr is set to 0 and SQLITE_NOMEM
  148015. ** (out of memory error) or SQLITE_ERROR (parse error) is returned.
  148016. */
  148017. static int fts3ExprParse(
  148018. ParseContext *pParse, /* fts3 query parse context */
  148019. const char *z, int n, /* Text of MATCH query */
  148020. Fts3Expr **ppExpr, /* OUT: Parsed query structure */
  148021. int *pnConsumed /* OUT: Number of bytes consumed */
  148022. ){
  148023. Fts3Expr *pRet = 0;
  148024. Fts3Expr *pPrev = 0;
  148025. Fts3Expr *pNotBranch = 0; /* Only used in legacy parse mode */
  148026. int nIn = n;
  148027. const char *zIn = z;
  148028. int rc = SQLITE_OK;
  148029. int isRequirePhrase = 1;
  148030. while( rc==SQLITE_OK ){
  148031. Fts3Expr *p = 0;
  148032. int nByte = 0;
  148033. rc = getNextNode(pParse, zIn, nIn, &p, &nByte);
  148034. assert( nByte>0 || (rc!=SQLITE_OK && p==0) );
  148035. if( rc==SQLITE_OK ){
  148036. if( p ){
  148037. int isPhrase;
  148038. if( !sqlite3_fts3_enable_parentheses
  148039. && p->eType==FTSQUERY_PHRASE && pParse->isNot
  148040. ){
  148041. /* Create an implicit NOT operator. */
  148042. Fts3Expr *pNot = fts3MallocZero(sizeof(Fts3Expr));
  148043. if( !pNot ){
  148044. sqlite3Fts3ExprFree(p);
  148045. rc = SQLITE_NOMEM;
  148046. goto exprparse_out;
  148047. }
  148048. pNot->eType = FTSQUERY_NOT;
  148049. pNot->pRight = p;
  148050. p->pParent = pNot;
  148051. if( pNotBranch ){
  148052. pNot->pLeft = pNotBranch;
  148053. pNotBranch->pParent = pNot;
  148054. }
  148055. pNotBranch = pNot;
  148056. p = pPrev;
  148057. }else{
  148058. int eType = p->eType;
  148059. isPhrase = (eType==FTSQUERY_PHRASE || p->pLeft);
  148060. /* The isRequirePhrase variable is set to true if a phrase or
  148061. ** an expression contained in parenthesis is required. If a
  148062. ** binary operator (AND, OR, NOT or NEAR) is encounted when
  148063. ** isRequirePhrase is set, this is a syntax error.
  148064. */
  148065. if( !isPhrase && isRequirePhrase ){
  148066. sqlite3Fts3ExprFree(p);
  148067. rc = SQLITE_ERROR;
  148068. goto exprparse_out;
  148069. }
  148070. if( isPhrase && !isRequirePhrase ){
  148071. /* Insert an implicit AND operator. */
  148072. Fts3Expr *pAnd;
  148073. assert( pRet && pPrev );
  148074. pAnd = fts3MallocZero(sizeof(Fts3Expr));
  148075. if( !pAnd ){
  148076. sqlite3Fts3ExprFree(p);
  148077. rc = SQLITE_NOMEM;
  148078. goto exprparse_out;
  148079. }
  148080. pAnd->eType = FTSQUERY_AND;
  148081. insertBinaryOperator(&pRet, pPrev, pAnd);
  148082. pPrev = pAnd;
  148083. }
  148084. /* This test catches attempts to make either operand of a NEAR
  148085. ** operator something other than a phrase. For example, either of
  148086. ** the following:
  148087. **
  148088. ** (bracketed expression) NEAR phrase
  148089. ** phrase NEAR (bracketed expression)
  148090. **
  148091. ** Return an error in either case.
  148092. */
  148093. if( pPrev && (
  148094. (eType==FTSQUERY_NEAR && !isPhrase && pPrev->eType!=FTSQUERY_PHRASE)
  148095. || (eType!=FTSQUERY_PHRASE && isPhrase && pPrev->eType==FTSQUERY_NEAR)
  148096. )){
  148097. sqlite3Fts3ExprFree(p);
  148098. rc = SQLITE_ERROR;
  148099. goto exprparse_out;
  148100. }
  148101. if( isPhrase ){
  148102. if( pRet ){
  148103. assert( pPrev && pPrev->pLeft && pPrev->pRight==0 );
  148104. pPrev->pRight = p;
  148105. p->pParent = pPrev;
  148106. }else{
  148107. pRet = p;
  148108. }
  148109. }else{
  148110. insertBinaryOperator(&pRet, pPrev, p);
  148111. }
  148112. isRequirePhrase = !isPhrase;
  148113. }
  148114. pPrev = p;
  148115. }
  148116. assert( nByte>0 );
  148117. }
  148118. assert( rc!=SQLITE_OK || (nByte>0 && nByte<=nIn) );
  148119. nIn -= nByte;
  148120. zIn += nByte;
  148121. }
  148122. if( rc==SQLITE_DONE && pRet && isRequirePhrase ){
  148123. rc = SQLITE_ERROR;
  148124. }
  148125. if( rc==SQLITE_DONE ){
  148126. rc = SQLITE_OK;
  148127. if( !sqlite3_fts3_enable_parentheses && pNotBranch ){
  148128. if( !pRet ){
  148129. rc = SQLITE_ERROR;
  148130. }else{
  148131. Fts3Expr *pIter = pNotBranch;
  148132. while( pIter->pLeft ){
  148133. pIter = pIter->pLeft;
  148134. }
  148135. pIter->pLeft = pRet;
  148136. pRet->pParent = pIter;
  148137. pRet = pNotBranch;
  148138. }
  148139. }
  148140. }
  148141. *pnConsumed = n - nIn;
  148142. exprparse_out:
  148143. if( rc!=SQLITE_OK ){
  148144. sqlite3Fts3ExprFree(pRet);
  148145. sqlite3Fts3ExprFree(pNotBranch);
  148146. pRet = 0;
  148147. }
  148148. *ppExpr = pRet;
  148149. return rc;
  148150. }
  148151. /*
  148152. ** Return SQLITE_ERROR if the maximum depth of the expression tree passed
  148153. ** as the only argument is more than nMaxDepth.
  148154. */
  148155. static int fts3ExprCheckDepth(Fts3Expr *p, int nMaxDepth){
  148156. int rc = SQLITE_OK;
  148157. if( p ){
  148158. if( nMaxDepth<0 ){
  148159. rc = SQLITE_TOOBIG;
  148160. }else{
  148161. rc = fts3ExprCheckDepth(p->pLeft, nMaxDepth-1);
  148162. if( rc==SQLITE_OK ){
  148163. rc = fts3ExprCheckDepth(p->pRight, nMaxDepth-1);
  148164. }
  148165. }
  148166. }
  148167. return rc;
  148168. }
  148169. /*
  148170. ** This function attempts to transform the expression tree at (*pp) to
  148171. ** an equivalent but more balanced form. The tree is modified in place.
  148172. ** If successful, SQLITE_OK is returned and (*pp) set to point to the
  148173. ** new root expression node.
  148174. **
  148175. ** nMaxDepth is the maximum allowable depth of the balanced sub-tree.
  148176. **
  148177. ** Otherwise, if an error occurs, an SQLite error code is returned and
  148178. ** expression (*pp) freed.
  148179. */
  148180. static int fts3ExprBalance(Fts3Expr **pp, int nMaxDepth){
  148181. int rc = SQLITE_OK; /* Return code */
  148182. Fts3Expr *pRoot = *pp; /* Initial root node */
  148183. Fts3Expr *pFree = 0; /* List of free nodes. Linked by pParent. */
  148184. int eType = pRoot->eType; /* Type of node in this tree */
  148185. if( nMaxDepth==0 ){
  148186. rc = SQLITE_ERROR;
  148187. }
  148188. if( rc==SQLITE_OK ){
  148189. if( (eType==FTSQUERY_AND || eType==FTSQUERY_OR) ){
  148190. Fts3Expr **apLeaf;
  148191. apLeaf = (Fts3Expr **)sqlite3_malloc(sizeof(Fts3Expr *) * nMaxDepth);
  148192. if( 0==apLeaf ){
  148193. rc = SQLITE_NOMEM;
  148194. }else{
  148195. memset(apLeaf, 0, sizeof(Fts3Expr *) * nMaxDepth);
  148196. }
  148197. if( rc==SQLITE_OK ){
  148198. int i;
  148199. Fts3Expr *p;
  148200. /* Set $p to point to the left-most leaf in the tree of eType nodes. */
  148201. for(p=pRoot; p->eType==eType; p=p->pLeft){
  148202. assert( p->pParent==0 || p->pParent->pLeft==p );
  148203. assert( p->pLeft && p->pRight );
  148204. }
  148205. /* This loop runs once for each leaf in the tree of eType nodes. */
  148206. while( 1 ){
  148207. int iLvl;
  148208. Fts3Expr *pParent = p->pParent; /* Current parent of p */
  148209. assert( pParent==0 || pParent->pLeft==p );
  148210. p->pParent = 0;
  148211. if( pParent ){
  148212. pParent->pLeft = 0;
  148213. }else{
  148214. pRoot = 0;
  148215. }
  148216. rc = fts3ExprBalance(&p, nMaxDepth-1);
  148217. if( rc!=SQLITE_OK ) break;
  148218. for(iLvl=0; p && iLvl<nMaxDepth; iLvl++){
  148219. if( apLeaf[iLvl]==0 ){
  148220. apLeaf[iLvl] = p;
  148221. p = 0;
  148222. }else{
  148223. assert( pFree );
  148224. pFree->pLeft = apLeaf[iLvl];
  148225. pFree->pRight = p;
  148226. pFree->pLeft->pParent = pFree;
  148227. pFree->pRight->pParent = pFree;
  148228. p = pFree;
  148229. pFree = pFree->pParent;
  148230. p->pParent = 0;
  148231. apLeaf[iLvl] = 0;
  148232. }
  148233. }
  148234. if( p ){
  148235. sqlite3Fts3ExprFree(p);
  148236. rc = SQLITE_TOOBIG;
  148237. break;
  148238. }
  148239. /* If that was the last leaf node, break out of the loop */
  148240. if( pParent==0 ) break;
  148241. /* Set $p to point to the next leaf in the tree of eType nodes */
  148242. for(p=pParent->pRight; p->eType==eType; p=p->pLeft);
  148243. /* Remove pParent from the original tree. */
  148244. assert( pParent->pParent==0 || pParent->pParent->pLeft==pParent );
  148245. pParent->pRight->pParent = pParent->pParent;
  148246. if( pParent->pParent ){
  148247. pParent->pParent->pLeft = pParent->pRight;
  148248. }else{
  148249. assert( pParent==pRoot );
  148250. pRoot = pParent->pRight;
  148251. }
  148252. /* Link pParent into the free node list. It will be used as an
  148253. ** internal node of the new tree. */
  148254. pParent->pParent = pFree;
  148255. pFree = pParent;
  148256. }
  148257. if( rc==SQLITE_OK ){
  148258. p = 0;
  148259. for(i=0; i<nMaxDepth; i++){
  148260. if( apLeaf[i] ){
  148261. if( p==0 ){
  148262. p = apLeaf[i];
  148263. p->pParent = 0;
  148264. }else{
  148265. assert( pFree!=0 );
  148266. pFree->pRight = p;
  148267. pFree->pLeft = apLeaf[i];
  148268. pFree->pLeft->pParent = pFree;
  148269. pFree->pRight->pParent = pFree;
  148270. p = pFree;
  148271. pFree = pFree->pParent;
  148272. p->pParent = 0;
  148273. }
  148274. }
  148275. }
  148276. pRoot = p;
  148277. }else{
  148278. /* An error occurred. Delete the contents of the apLeaf[] array
  148279. ** and pFree list. Everything else is cleaned up by the call to
  148280. ** sqlite3Fts3ExprFree(pRoot) below. */
  148281. Fts3Expr *pDel;
  148282. for(i=0; i<nMaxDepth; i++){
  148283. sqlite3Fts3ExprFree(apLeaf[i]);
  148284. }
  148285. while( (pDel=pFree)!=0 ){
  148286. pFree = pDel->pParent;
  148287. sqlite3_free(pDel);
  148288. }
  148289. }
  148290. assert( pFree==0 );
  148291. sqlite3_free( apLeaf );
  148292. }
  148293. }else if( eType==FTSQUERY_NOT ){
  148294. Fts3Expr *pLeft = pRoot->pLeft;
  148295. Fts3Expr *pRight = pRoot->pRight;
  148296. pRoot->pLeft = 0;
  148297. pRoot->pRight = 0;
  148298. pLeft->pParent = 0;
  148299. pRight->pParent = 0;
  148300. rc = fts3ExprBalance(&pLeft, nMaxDepth-1);
  148301. if( rc==SQLITE_OK ){
  148302. rc = fts3ExprBalance(&pRight, nMaxDepth-1);
  148303. }
  148304. if( rc!=SQLITE_OK ){
  148305. sqlite3Fts3ExprFree(pRight);
  148306. sqlite3Fts3ExprFree(pLeft);
  148307. }else{
  148308. assert( pLeft && pRight );
  148309. pRoot->pLeft = pLeft;
  148310. pLeft->pParent = pRoot;
  148311. pRoot->pRight = pRight;
  148312. pRight->pParent = pRoot;
  148313. }
  148314. }
  148315. }
  148316. if( rc!=SQLITE_OK ){
  148317. sqlite3Fts3ExprFree(pRoot);
  148318. pRoot = 0;
  148319. }
  148320. *pp = pRoot;
  148321. return rc;
  148322. }
  148323. /*
  148324. ** This function is similar to sqlite3Fts3ExprParse(), with the following
  148325. ** differences:
  148326. **
  148327. ** 1. It does not do expression rebalancing.
  148328. ** 2. It does not check that the expression does not exceed the
  148329. ** maximum allowable depth.
  148330. ** 3. Even if it fails, *ppExpr may still be set to point to an
  148331. ** expression tree. It should be deleted using sqlite3Fts3ExprFree()
  148332. ** in this case.
  148333. */
  148334. static int fts3ExprParseUnbalanced(
  148335. sqlite3_tokenizer *pTokenizer, /* Tokenizer module */
  148336. int iLangid, /* Language id for tokenizer */
  148337. char **azCol, /* Array of column names for fts3 table */
  148338. int bFts4, /* True to allow FTS4-only syntax */
  148339. int nCol, /* Number of entries in azCol[] */
  148340. int iDefaultCol, /* Default column to query */
  148341. const char *z, int n, /* Text of MATCH query */
  148342. Fts3Expr **ppExpr /* OUT: Parsed query structure */
  148343. ){
  148344. int nParsed;
  148345. int rc;
  148346. ParseContext sParse;
  148347. memset(&sParse, 0, sizeof(ParseContext));
  148348. sParse.pTokenizer = pTokenizer;
  148349. sParse.iLangid = iLangid;
  148350. sParse.azCol = (const char **)azCol;
  148351. sParse.nCol = nCol;
  148352. sParse.iDefaultCol = iDefaultCol;
  148353. sParse.bFts4 = bFts4;
  148354. if( z==0 ){
  148355. *ppExpr = 0;
  148356. return SQLITE_OK;
  148357. }
  148358. if( n<0 ){
  148359. n = (int)strlen(z);
  148360. }
  148361. rc = fts3ExprParse(&sParse, z, n, ppExpr, &nParsed);
  148362. assert( rc==SQLITE_OK || *ppExpr==0 );
  148363. /* Check for mismatched parenthesis */
  148364. if( rc==SQLITE_OK && sParse.nNest ){
  148365. rc = SQLITE_ERROR;
  148366. }
  148367. return rc;
  148368. }
  148369. /*
  148370. ** Parameters z and n contain a pointer to and length of a buffer containing
  148371. ** an fts3 query expression, respectively. This function attempts to parse the
  148372. ** query expression and create a tree of Fts3Expr structures representing the
  148373. ** parsed expression. If successful, *ppExpr is set to point to the head
  148374. ** of the parsed expression tree and SQLITE_OK is returned. If an error
  148375. ** occurs, either SQLITE_NOMEM (out-of-memory error) or SQLITE_ERROR (parse
  148376. ** error) is returned and *ppExpr is set to 0.
  148377. **
  148378. ** If parameter n is a negative number, then z is assumed to point to a
  148379. ** nul-terminated string and the length is determined using strlen().
  148380. **
  148381. ** The first parameter, pTokenizer, is passed the fts3 tokenizer module to
  148382. ** use to normalize query tokens while parsing the expression. The azCol[]
  148383. ** array, which is assumed to contain nCol entries, should contain the names
  148384. ** of each column in the target fts3 table, in order from left to right.
  148385. ** Column names must be nul-terminated strings.
  148386. **
  148387. ** The iDefaultCol parameter should be passed the index of the table column
  148388. ** that appears on the left-hand-side of the MATCH operator (the default
  148389. ** column to match against for tokens for which a column name is not explicitly
  148390. ** specified as part of the query string), or -1 if tokens may by default
  148391. ** match any table column.
  148392. */
  148393. SQLITE_PRIVATE int sqlite3Fts3ExprParse(
  148394. sqlite3_tokenizer *pTokenizer, /* Tokenizer module */
  148395. int iLangid, /* Language id for tokenizer */
  148396. char **azCol, /* Array of column names for fts3 table */
  148397. int bFts4, /* True to allow FTS4-only syntax */
  148398. int nCol, /* Number of entries in azCol[] */
  148399. int iDefaultCol, /* Default column to query */
  148400. const char *z, int n, /* Text of MATCH query */
  148401. Fts3Expr **ppExpr, /* OUT: Parsed query structure */
  148402. char **pzErr /* OUT: Error message (sqlite3_malloc) */
  148403. ){
  148404. int rc = fts3ExprParseUnbalanced(
  148405. pTokenizer, iLangid, azCol, bFts4, nCol, iDefaultCol, z, n, ppExpr
  148406. );
  148407. /* Rebalance the expression. And check that its depth does not exceed
  148408. ** SQLITE_FTS3_MAX_EXPR_DEPTH. */
  148409. if( rc==SQLITE_OK && *ppExpr ){
  148410. rc = fts3ExprBalance(ppExpr, SQLITE_FTS3_MAX_EXPR_DEPTH);
  148411. if( rc==SQLITE_OK ){
  148412. rc = fts3ExprCheckDepth(*ppExpr, SQLITE_FTS3_MAX_EXPR_DEPTH);
  148413. }
  148414. }
  148415. if( rc!=SQLITE_OK ){
  148416. sqlite3Fts3ExprFree(*ppExpr);
  148417. *ppExpr = 0;
  148418. if( rc==SQLITE_TOOBIG ){
  148419. sqlite3Fts3ErrMsg(pzErr,
  148420. "FTS expression tree is too large (maximum depth %d)",
  148421. SQLITE_FTS3_MAX_EXPR_DEPTH
  148422. );
  148423. rc = SQLITE_ERROR;
  148424. }else if( rc==SQLITE_ERROR ){
  148425. sqlite3Fts3ErrMsg(pzErr, "malformed MATCH expression: [%s]", z);
  148426. }
  148427. }
  148428. return rc;
  148429. }
  148430. /*
  148431. ** Free a single node of an expression tree.
  148432. */
  148433. static void fts3FreeExprNode(Fts3Expr *p){
  148434. assert( p->eType==FTSQUERY_PHRASE || p->pPhrase==0 );
  148435. sqlite3Fts3EvalPhraseCleanup(p->pPhrase);
  148436. sqlite3_free(p->aMI);
  148437. sqlite3_free(p);
  148438. }
  148439. /*
  148440. ** Free a parsed fts3 query expression allocated by sqlite3Fts3ExprParse().
  148441. **
  148442. ** This function would be simpler if it recursively called itself. But
  148443. ** that would mean passing a sufficiently large expression to ExprParse()
  148444. ** could cause a stack overflow.
  148445. */
  148446. SQLITE_PRIVATE void sqlite3Fts3ExprFree(Fts3Expr *pDel){
  148447. Fts3Expr *p;
  148448. assert( pDel==0 || pDel->pParent==0 );
  148449. for(p=pDel; p && (p->pLeft||p->pRight); p=(p->pLeft ? p->pLeft : p->pRight)){
  148450. assert( p->pParent==0 || p==p->pParent->pRight || p==p->pParent->pLeft );
  148451. }
  148452. while( p ){
  148453. Fts3Expr *pParent = p->pParent;
  148454. fts3FreeExprNode(p);
  148455. if( pParent && p==pParent->pLeft && pParent->pRight ){
  148456. p = pParent->pRight;
  148457. while( p && (p->pLeft || p->pRight) ){
  148458. assert( p==p->pParent->pRight || p==p->pParent->pLeft );
  148459. p = (p->pLeft ? p->pLeft : p->pRight);
  148460. }
  148461. }else{
  148462. p = pParent;
  148463. }
  148464. }
  148465. }
  148466. /****************************************************************************
  148467. *****************************************************************************
  148468. ** Everything after this point is just test code.
  148469. */
  148470. #ifdef SQLITE_TEST
  148471. /* #include <stdio.h> */
  148472. /*
  148473. ** Function to query the hash-table of tokenizers (see README.tokenizers).
  148474. */
  148475. static int queryTestTokenizer(
  148476. sqlite3 *db,
  148477. const char *zName,
  148478. const sqlite3_tokenizer_module **pp
  148479. ){
  148480. int rc;
  148481. sqlite3_stmt *pStmt;
  148482. const char zSql[] = "SELECT fts3_tokenizer(?)";
  148483. *pp = 0;
  148484. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  148485. if( rc!=SQLITE_OK ){
  148486. return rc;
  148487. }
  148488. sqlite3_bind_text(pStmt, 1, zName, -1, SQLITE_STATIC);
  148489. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  148490. if( sqlite3_column_type(pStmt, 0)==SQLITE_BLOB ){
  148491. memcpy((void *)pp, sqlite3_column_blob(pStmt, 0), sizeof(*pp));
  148492. }
  148493. }
  148494. return sqlite3_finalize(pStmt);
  148495. }
  148496. /*
  148497. ** Return a pointer to a buffer containing a text representation of the
  148498. ** expression passed as the first argument. The buffer is obtained from
  148499. ** sqlite3_malloc(). It is the responsibility of the caller to use
  148500. ** sqlite3_free() to release the memory. If an OOM condition is encountered,
  148501. ** NULL is returned.
  148502. **
  148503. ** If the second argument is not NULL, then its contents are prepended to
  148504. ** the returned expression text and then freed using sqlite3_free().
  148505. */
  148506. static char *exprToString(Fts3Expr *pExpr, char *zBuf){
  148507. if( pExpr==0 ){
  148508. return sqlite3_mprintf("");
  148509. }
  148510. switch( pExpr->eType ){
  148511. case FTSQUERY_PHRASE: {
  148512. Fts3Phrase *pPhrase = pExpr->pPhrase;
  148513. int i;
  148514. zBuf = sqlite3_mprintf(
  148515. "%zPHRASE %d 0", zBuf, pPhrase->iColumn);
  148516. for(i=0; zBuf && i<pPhrase->nToken; i++){
  148517. zBuf = sqlite3_mprintf("%z %.*s%s", zBuf,
  148518. pPhrase->aToken[i].n, pPhrase->aToken[i].z,
  148519. (pPhrase->aToken[i].isPrefix?"+":"")
  148520. );
  148521. }
  148522. return zBuf;
  148523. }
  148524. case FTSQUERY_NEAR:
  148525. zBuf = sqlite3_mprintf("%zNEAR/%d ", zBuf, pExpr->nNear);
  148526. break;
  148527. case FTSQUERY_NOT:
  148528. zBuf = sqlite3_mprintf("%zNOT ", zBuf);
  148529. break;
  148530. case FTSQUERY_AND:
  148531. zBuf = sqlite3_mprintf("%zAND ", zBuf);
  148532. break;
  148533. case FTSQUERY_OR:
  148534. zBuf = sqlite3_mprintf("%zOR ", zBuf);
  148535. break;
  148536. }
  148537. if( zBuf ) zBuf = sqlite3_mprintf("%z{", zBuf);
  148538. if( zBuf ) zBuf = exprToString(pExpr->pLeft, zBuf);
  148539. if( zBuf ) zBuf = sqlite3_mprintf("%z} {", zBuf);
  148540. if( zBuf ) zBuf = exprToString(pExpr->pRight, zBuf);
  148541. if( zBuf ) zBuf = sqlite3_mprintf("%z}", zBuf);
  148542. return zBuf;
  148543. }
  148544. /*
  148545. ** This is the implementation of a scalar SQL function used to test the
  148546. ** expression parser. It should be called as follows:
  148547. **
  148548. ** fts3_exprtest(<tokenizer>, <expr>, <column 1>, ...);
  148549. **
  148550. ** The first argument, <tokenizer>, is the name of the fts3 tokenizer used
  148551. ** to parse the query expression (see README.tokenizers). The second argument
  148552. ** is the query expression to parse. Each subsequent argument is the name
  148553. ** of a column of the fts3 table that the query expression may refer to.
  148554. ** For example:
  148555. **
  148556. ** SELECT fts3_exprtest('simple', 'Bill col2:Bloggs', 'col1', 'col2');
  148557. */
  148558. static void fts3ExprTest(
  148559. sqlite3_context *context,
  148560. int argc,
  148561. sqlite3_value **argv
  148562. ){
  148563. sqlite3_tokenizer_module const *pModule = 0;
  148564. sqlite3_tokenizer *pTokenizer = 0;
  148565. int rc;
  148566. char **azCol = 0;
  148567. const char *zExpr;
  148568. int nExpr;
  148569. int nCol;
  148570. int ii;
  148571. Fts3Expr *pExpr;
  148572. char *zBuf = 0;
  148573. sqlite3 *db = sqlite3_context_db_handle(context);
  148574. if( argc<3 ){
  148575. sqlite3_result_error(context,
  148576. "Usage: fts3_exprtest(tokenizer, expr, col1, ...", -1
  148577. );
  148578. return;
  148579. }
  148580. rc = queryTestTokenizer(db,
  148581. (const char *)sqlite3_value_text(argv[0]), &pModule);
  148582. if( rc==SQLITE_NOMEM ){
  148583. sqlite3_result_error_nomem(context);
  148584. goto exprtest_out;
  148585. }else if( !pModule ){
  148586. sqlite3_result_error(context, "No such tokenizer module", -1);
  148587. goto exprtest_out;
  148588. }
  148589. rc = pModule->xCreate(0, 0, &pTokenizer);
  148590. assert( rc==SQLITE_NOMEM || rc==SQLITE_OK );
  148591. if( rc==SQLITE_NOMEM ){
  148592. sqlite3_result_error_nomem(context);
  148593. goto exprtest_out;
  148594. }
  148595. pTokenizer->pModule = pModule;
  148596. zExpr = (const char *)sqlite3_value_text(argv[1]);
  148597. nExpr = sqlite3_value_bytes(argv[1]);
  148598. nCol = argc-2;
  148599. azCol = (char **)sqlite3_malloc(nCol*sizeof(char *));
  148600. if( !azCol ){
  148601. sqlite3_result_error_nomem(context);
  148602. goto exprtest_out;
  148603. }
  148604. for(ii=0; ii<nCol; ii++){
  148605. azCol[ii] = (char *)sqlite3_value_text(argv[ii+2]);
  148606. }
  148607. if( sqlite3_user_data(context) ){
  148608. char *zDummy = 0;
  148609. rc = sqlite3Fts3ExprParse(
  148610. pTokenizer, 0, azCol, 0, nCol, nCol, zExpr, nExpr, &pExpr, &zDummy
  148611. );
  148612. assert( rc==SQLITE_OK || pExpr==0 );
  148613. sqlite3_free(zDummy);
  148614. }else{
  148615. rc = fts3ExprParseUnbalanced(
  148616. pTokenizer, 0, azCol, 0, nCol, nCol, zExpr, nExpr, &pExpr
  148617. );
  148618. }
  148619. if( rc!=SQLITE_OK && rc!=SQLITE_NOMEM ){
  148620. sqlite3Fts3ExprFree(pExpr);
  148621. sqlite3_result_error(context, "Error parsing expression", -1);
  148622. }else if( rc==SQLITE_NOMEM || !(zBuf = exprToString(pExpr, 0)) ){
  148623. sqlite3_result_error_nomem(context);
  148624. }else{
  148625. sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
  148626. sqlite3_free(zBuf);
  148627. }
  148628. sqlite3Fts3ExprFree(pExpr);
  148629. exprtest_out:
  148630. if( pModule && pTokenizer ){
  148631. rc = pModule->xDestroy(pTokenizer);
  148632. }
  148633. sqlite3_free(azCol);
  148634. }
  148635. /*
  148636. ** Register the query expression parser test function fts3_exprtest()
  148637. ** with database connection db.
  148638. */
  148639. SQLITE_PRIVATE int sqlite3Fts3ExprInitTestInterface(sqlite3* db){
  148640. int rc = sqlite3_create_function(
  148641. db, "fts3_exprtest", -1, SQLITE_UTF8, 0, fts3ExprTest, 0, 0
  148642. );
  148643. if( rc==SQLITE_OK ){
  148644. rc = sqlite3_create_function(db, "fts3_exprtest_rebalance",
  148645. -1, SQLITE_UTF8, (void *)1, fts3ExprTest, 0, 0
  148646. );
  148647. }
  148648. return rc;
  148649. }
  148650. #endif
  148651. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  148652. /************** End of fts3_expr.c *******************************************/
  148653. /************** Begin file fts3_hash.c ***************************************/
  148654. /*
  148655. ** 2001 September 22
  148656. **
  148657. ** The author disclaims copyright to this source code. In place of
  148658. ** a legal notice, here is a blessing:
  148659. **
  148660. ** May you do good and not evil.
  148661. ** May you find forgiveness for yourself and forgive others.
  148662. ** May you share freely, never taking more than you give.
  148663. **
  148664. *************************************************************************
  148665. ** This is the implementation of generic hash-tables used in SQLite.
  148666. ** We've modified it slightly to serve as a standalone hash table
  148667. ** implementation for the full-text indexing module.
  148668. */
  148669. /*
  148670. ** The code in this file is only compiled if:
  148671. **
  148672. ** * The FTS3 module is being built as an extension
  148673. ** (in which case SQLITE_CORE is not defined), or
  148674. **
  148675. ** * The FTS3 module is being built into the core of
  148676. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  148677. */
  148678. /* #include "fts3Int.h" */
  148679. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  148680. /* #include <assert.h> */
  148681. /* #include <stdlib.h> */
  148682. /* #include <string.h> */
  148683. /* #include "fts3_hash.h" */
  148684. /*
  148685. ** Malloc and Free functions
  148686. */
  148687. static void *fts3HashMalloc(int n){
  148688. void *p = sqlite3_malloc(n);
  148689. if( p ){
  148690. memset(p, 0, n);
  148691. }
  148692. return p;
  148693. }
  148694. static void fts3HashFree(void *p){
  148695. sqlite3_free(p);
  148696. }
  148697. /* Turn bulk memory into a hash table object by initializing the
  148698. ** fields of the Hash structure.
  148699. **
  148700. ** "pNew" is a pointer to the hash table that is to be initialized.
  148701. ** keyClass is one of the constants
  148702. ** FTS3_HASH_BINARY or FTS3_HASH_STRING. The value of keyClass
  148703. ** determines what kind of key the hash table will use. "copyKey" is
  148704. ** true if the hash table should make its own private copy of keys and
  148705. ** false if it should just use the supplied pointer.
  148706. */
  148707. SQLITE_PRIVATE void sqlite3Fts3HashInit(Fts3Hash *pNew, char keyClass, char copyKey){
  148708. assert( pNew!=0 );
  148709. assert( keyClass>=FTS3_HASH_STRING && keyClass<=FTS3_HASH_BINARY );
  148710. pNew->keyClass = keyClass;
  148711. pNew->copyKey = copyKey;
  148712. pNew->first = 0;
  148713. pNew->count = 0;
  148714. pNew->htsize = 0;
  148715. pNew->ht = 0;
  148716. }
  148717. /* Remove all entries from a hash table. Reclaim all memory.
  148718. ** Call this routine to delete a hash table or to reset a hash table
  148719. ** to the empty state.
  148720. */
  148721. SQLITE_PRIVATE void sqlite3Fts3HashClear(Fts3Hash *pH){
  148722. Fts3HashElem *elem; /* For looping over all elements of the table */
  148723. assert( pH!=0 );
  148724. elem = pH->first;
  148725. pH->first = 0;
  148726. fts3HashFree(pH->ht);
  148727. pH->ht = 0;
  148728. pH->htsize = 0;
  148729. while( elem ){
  148730. Fts3HashElem *next_elem = elem->next;
  148731. if( pH->copyKey && elem->pKey ){
  148732. fts3HashFree(elem->pKey);
  148733. }
  148734. fts3HashFree(elem);
  148735. elem = next_elem;
  148736. }
  148737. pH->count = 0;
  148738. }
  148739. /*
  148740. ** Hash and comparison functions when the mode is FTS3_HASH_STRING
  148741. */
  148742. static int fts3StrHash(const void *pKey, int nKey){
  148743. const char *z = (const char *)pKey;
  148744. unsigned h = 0;
  148745. if( nKey<=0 ) nKey = (int) strlen(z);
  148746. while( nKey > 0 ){
  148747. h = (h<<3) ^ h ^ *z++;
  148748. nKey--;
  148749. }
  148750. return (int)(h & 0x7fffffff);
  148751. }
  148752. static int fts3StrCompare(const void *pKey1, int n1, const void *pKey2, int n2){
  148753. if( n1!=n2 ) return 1;
  148754. return strncmp((const char*)pKey1,(const char*)pKey2,n1);
  148755. }
  148756. /*
  148757. ** Hash and comparison functions when the mode is FTS3_HASH_BINARY
  148758. */
  148759. static int fts3BinHash(const void *pKey, int nKey){
  148760. int h = 0;
  148761. const char *z = (const char *)pKey;
  148762. while( nKey-- > 0 ){
  148763. h = (h<<3) ^ h ^ *(z++);
  148764. }
  148765. return h & 0x7fffffff;
  148766. }
  148767. static int fts3BinCompare(const void *pKey1, int n1, const void *pKey2, int n2){
  148768. if( n1!=n2 ) return 1;
  148769. return memcmp(pKey1,pKey2,n1);
  148770. }
  148771. /*
  148772. ** Return a pointer to the appropriate hash function given the key class.
  148773. **
  148774. ** The C syntax in this function definition may be unfamilar to some
  148775. ** programmers, so we provide the following additional explanation:
  148776. **
  148777. ** The name of the function is "ftsHashFunction". The function takes a
  148778. ** single parameter "keyClass". The return value of ftsHashFunction()
  148779. ** is a pointer to another function. Specifically, the return value
  148780. ** of ftsHashFunction() is a pointer to a function that takes two parameters
  148781. ** with types "const void*" and "int" and returns an "int".
  148782. */
  148783. static int (*ftsHashFunction(int keyClass))(const void*,int){
  148784. if( keyClass==FTS3_HASH_STRING ){
  148785. return &fts3StrHash;
  148786. }else{
  148787. assert( keyClass==FTS3_HASH_BINARY );
  148788. return &fts3BinHash;
  148789. }
  148790. }
  148791. /*
  148792. ** Return a pointer to the appropriate hash function given the key class.
  148793. **
  148794. ** For help in interpreted the obscure C code in the function definition,
  148795. ** see the header comment on the previous function.
  148796. */
  148797. static int (*ftsCompareFunction(int keyClass))(const void*,int,const void*,int){
  148798. if( keyClass==FTS3_HASH_STRING ){
  148799. return &fts3StrCompare;
  148800. }else{
  148801. assert( keyClass==FTS3_HASH_BINARY );
  148802. return &fts3BinCompare;
  148803. }
  148804. }
  148805. /* Link an element into the hash table
  148806. */
  148807. static void fts3HashInsertElement(
  148808. Fts3Hash *pH, /* The complete hash table */
  148809. struct _fts3ht *pEntry, /* The entry into which pNew is inserted */
  148810. Fts3HashElem *pNew /* The element to be inserted */
  148811. ){
  148812. Fts3HashElem *pHead; /* First element already in pEntry */
  148813. pHead = pEntry->chain;
  148814. if( pHead ){
  148815. pNew->next = pHead;
  148816. pNew->prev = pHead->prev;
  148817. if( pHead->prev ){ pHead->prev->next = pNew; }
  148818. else { pH->first = pNew; }
  148819. pHead->prev = pNew;
  148820. }else{
  148821. pNew->next = pH->first;
  148822. if( pH->first ){ pH->first->prev = pNew; }
  148823. pNew->prev = 0;
  148824. pH->first = pNew;
  148825. }
  148826. pEntry->count++;
  148827. pEntry->chain = pNew;
  148828. }
  148829. /* Resize the hash table so that it cantains "new_size" buckets.
  148830. ** "new_size" must be a power of 2. The hash table might fail
  148831. ** to resize if sqliteMalloc() fails.
  148832. **
  148833. ** Return non-zero if a memory allocation error occurs.
  148834. */
  148835. static int fts3Rehash(Fts3Hash *pH, int new_size){
  148836. struct _fts3ht *new_ht; /* The new hash table */
  148837. Fts3HashElem *elem, *next_elem; /* For looping over existing elements */
  148838. int (*xHash)(const void*,int); /* The hash function */
  148839. assert( (new_size & (new_size-1))==0 );
  148840. new_ht = (struct _fts3ht *)fts3HashMalloc( new_size*sizeof(struct _fts3ht) );
  148841. if( new_ht==0 ) return 1;
  148842. fts3HashFree(pH->ht);
  148843. pH->ht = new_ht;
  148844. pH->htsize = new_size;
  148845. xHash = ftsHashFunction(pH->keyClass);
  148846. for(elem=pH->first, pH->first=0; elem; elem = next_elem){
  148847. int h = (*xHash)(elem->pKey, elem->nKey) & (new_size-1);
  148848. next_elem = elem->next;
  148849. fts3HashInsertElement(pH, &new_ht[h], elem);
  148850. }
  148851. return 0;
  148852. }
  148853. /* This function (for internal use only) locates an element in an
  148854. ** hash table that matches the given key. The hash for this key has
  148855. ** already been computed and is passed as the 4th parameter.
  148856. */
  148857. static Fts3HashElem *fts3FindElementByHash(
  148858. const Fts3Hash *pH, /* The pH to be searched */
  148859. const void *pKey, /* The key we are searching for */
  148860. int nKey,
  148861. int h /* The hash for this key. */
  148862. ){
  148863. Fts3HashElem *elem; /* Used to loop thru the element list */
  148864. int count; /* Number of elements left to test */
  148865. int (*xCompare)(const void*,int,const void*,int); /* comparison function */
  148866. if( pH->ht ){
  148867. struct _fts3ht *pEntry = &pH->ht[h];
  148868. elem = pEntry->chain;
  148869. count = pEntry->count;
  148870. xCompare = ftsCompareFunction(pH->keyClass);
  148871. while( count-- && elem ){
  148872. if( (*xCompare)(elem->pKey,elem->nKey,pKey,nKey)==0 ){
  148873. return elem;
  148874. }
  148875. elem = elem->next;
  148876. }
  148877. }
  148878. return 0;
  148879. }
  148880. /* Remove a single entry from the hash table given a pointer to that
  148881. ** element and a hash on the element's key.
  148882. */
  148883. static void fts3RemoveElementByHash(
  148884. Fts3Hash *pH, /* The pH containing "elem" */
  148885. Fts3HashElem* elem, /* The element to be removed from the pH */
  148886. int h /* Hash value for the element */
  148887. ){
  148888. struct _fts3ht *pEntry;
  148889. if( elem->prev ){
  148890. elem->prev->next = elem->next;
  148891. }else{
  148892. pH->first = elem->next;
  148893. }
  148894. if( elem->next ){
  148895. elem->next->prev = elem->prev;
  148896. }
  148897. pEntry = &pH->ht[h];
  148898. if( pEntry->chain==elem ){
  148899. pEntry->chain = elem->next;
  148900. }
  148901. pEntry->count--;
  148902. if( pEntry->count<=0 ){
  148903. pEntry->chain = 0;
  148904. }
  148905. if( pH->copyKey && elem->pKey ){
  148906. fts3HashFree(elem->pKey);
  148907. }
  148908. fts3HashFree( elem );
  148909. pH->count--;
  148910. if( pH->count<=0 ){
  148911. assert( pH->first==0 );
  148912. assert( pH->count==0 );
  148913. fts3HashClear(pH);
  148914. }
  148915. }
  148916. SQLITE_PRIVATE Fts3HashElem *sqlite3Fts3HashFindElem(
  148917. const Fts3Hash *pH,
  148918. const void *pKey,
  148919. int nKey
  148920. ){
  148921. int h; /* A hash on key */
  148922. int (*xHash)(const void*,int); /* The hash function */
  148923. if( pH==0 || pH->ht==0 ) return 0;
  148924. xHash = ftsHashFunction(pH->keyClass);
  148925. assert( xHash!=0 );
  148926. h = (*xHash)(pKey,nKey);
  148927. assert( (pH->htsize & (pH->htsize-1))==0 );
  148928. return fts3FindElementByHash(pH,pKey,nKey, h & (pH->htsize-1));
  148929. }
  148930. /*
  148931. ** Attempt to locate an element of the hash table pH with a key
  148932. ** that matches pKey,nKey. Return the data for this element if it is
  148933. ** found, or NULL if there is no match.
  148934. */
  148935. SQLITE_PRIVATE void *sqlite3Fts3HashFind(const Fts3Hash *pH, const void *pKey, int nKey){
  148936. Fts3HashElem *pElem; /* The element that matches key (if any) */
  148937. pElem = sqlite3Fts3HashFindElem(pH, pKey, nKey);
  148938. return pElem ? pElem->data : 0;
  148939. }
  148940. /* Insert an element into the hash table pH. The key is pKey,nKey
  148941. ** and the data is "data".
  148942. **
  148943. ** If no element exists with a matching key, then a new
  148944. ** element is created. A copy of the key is made if the copyKey
  148945. ** flag is set. NULL is returned.
  148946. **
  148947. ** If another element already exists with the same key, then the
  148948. ** new data replaces the old data and the old data is returned.
  148949. ** The key is not copied in this instance. If a malloc fails, then
  148950. ** the new data is returned and the hash table is unchanged.
  148951. **
  148952. ** If the "data" parameter to this function is NULL, then the
  148953. ** element corresponding to "key" is removed from the hash table.
  148954. */
  148955. SQLITE_PRIVATE void *sqlite3Fts3HashInsert(
  148956. Fts3Hash *pH, /* The hash table to insert into */
  148957. const void *pKey, /* The key */
  148958. int nKey, /* Number of bytes in the key */
  148959. void *data /* The data */
  148960. ){
  148961. int hraw; /* Raw hash value of the key */
  148962. int h; /* the hash of the key modulo hash table size */
  148963. Fts3HashElem *elem; /* Used to loop thru the element list */
  148964. Fts3HashElem *new_elem; /* New element added to the pH */
  148965. int (*xHash)(const void*,int); /* The hash function */
  148966. assert( pH!=0 );
  148967. xHash = ftsHashFunction(pH->keyClass);
  148968. assert( xHash!=0 );
  148969. hraw = (*xHash)(pKey, nKey);
  148970. assert( (pH->htsize & (pH->htsize-1))==0 );
  148971. h = hraw & (pH->htsize-1);
  148972. elem = fts3FindElementByHash(pH,pKey,nKey,h);
  148973. if( elem ){
  148974. void *old_data = elem->data;
  148975. if( data==0 ){
  148976. fts3RemoveElementByHash(pH,elem,h);
  148977. }else{
  148978. elem->data = data;
  148979. }
  148980. return old_data;
  148981. }
  148982. if( data==0 ) return 0;
  148983. if( (pH->htsize==0 && fts3Rehash(pH,8))
  148984. || (pH->count>=pH->htsize && fts3Rehash(pH, pH->htsize*2))
  148985. ){
  148986. pH->count = 0;
  148987. return data;
  148988. }
  148989. assert( pH->htsize>0 );
  148990. new_elem = (Fts3HashElem*)fts3HashMalloc( sizeof(Fts3HashElem) );
  148991. if( new_elem==0 ) return data;
  148992. if( pH->copyKey && pKey!=0 ){
  148993. new_elem->pKey = fts3HashMalloc( nKey );
  148994. if( new_elem->pKey==0 ){
  148995. fts3HashFree(new_elem);
  148996. return data;
  148997. }
  148998. memcpy((void*)new_elem->pKey, pKey, nKey);
  148999. }else{
  149000. new_elem->pKey = (void*)pKey;
  149001. }
  149002. new_elem->nKey = nKey;
  149003. pH->count++;
  149004. assert( pH->htsize>0 );
  149005. assert( (pH->htsize & (pH->htsize-1))==0 );
  149006. h = hraw & (pH->htsize-1);
  149007. fts3HashInsertElement(pH, &pH->ht[h], new_elem);
  149008. new_elem->data = data;
  149009. return 0;
  149010. }
  149011. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  149012. /************** End of fts3_hash.c *******************************************/
  149013. /************** Begin file fts3_porter.c *************************************/
  149014. /*
  149015. ** 2006 September 30
  149016. **
  149017. ** The author disclaims copyright to this source code. In place of
  149018. ** a legal notice, here is a blessing:
  149019. **
  149020. ** May you do good and not evil.
  149021. ** May you find forgiveness for yourself and forgive others.
  149022. ** May you share freely, never taking more than you give.
  149023. **
  149024. *************************************************************************
  149025. ** Implementation of the full-text-search tokenizer that implements
  149026. ** a Porter stemmer.
  149027. */
  149028. /*
  149029. ** The code in this file is only compiled if:
  149030. **
  149031. ** * The FTS3 module is being built as an extension
  149032. ** (in which case SQLITE_CORE is not defined), or
  149033. **
  149034. ** * The FTS3 module is being built into the core of
  149035. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  149036. */
  149037. /* #include "fts3Int.h" */
  149038. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  149039. /* #include <assert.h> */
  149040. /* #include <stdlib.h> */
  149041. /* #include <stdio.h> */
  149042. /* #include <string.h> */
  149043. /* #include "fts3_tokenizer.h" */
  149044. /*
  149045. ** Class derived from sqlite3_tokenizer
  149046. */
  149047. typedef struct porter_tokenizer {
  149048. sqlite3_tokenizer base; /* Base class */
  149049. } porter_tokenizer;
  149050. /*
  149051. ** Class derived from sqlite3_tokenizer_cursor
  149052. */
  149053. typedef struct porter_tokenizer_cursor {
  149054. sqlite3_tokenizer_cursor base;
  149055. const char *zInput; /* input we are tokenizing */
  149056. int nInput; /* size of the input */
  149057. int iOffset; /* current position in zInput */
  149058. int iToken; /* index of next token to be returned */
  149059. char *zToken; /* storage for current token */
  149060. int nAllocated; /* space allocated to zToken buffer */
  149061. } porter_tokenizer_cursor;
  149062. /*
  149063. ** Create a new tokenizer instance.
  149064. */
  149065. static int porterCreate(
  149066. int argc, const char * const *argv,
  149067. sqlite3_tokenizer **ppTokenizer
  149068. ){
  149069. porter_tokenizer *t;
  149070. UNUSED_PARAMETER(argc);
  149071. UNUSED_PARAMETER(argv);
  149072. t = (porter_tokenizer *) sqlite3_malloc(sizeof(*t));
  149073. if( t==NULL ) return SQLITE_NOMEM;
  149074. memset(t, 0, sizeof(*t));
  149075. *ppTokenizer = &t->base;
  149076. return SQLITE_OK;
  149077. }
  149078. /*
  149079. ** Destroy a tokenizer
  149080. */
  149081. static int porterDestroy(sqlite3_tokenizer *pTokenizer){
  149082. sqlite3_free(pTokenizer);
  149083. return SQLITE_OK;
  149084. }
  149085. /*
  149086. ** Prepare to begin tokenizing a particular string. The input
  149087. ** string to be tokenized is zInput[0..nInput-1]. A cursor
  149088. ** used to incrementally tokenize this string is returned in
  149089. ** *ppCursor.
  149090. */
  149091. static int porterOpen(
  149092. sqlite3_tokenizer *pTokenizer, /* The tokenizer */
  149093. const char *zInput, int nInput, /* String to be tokenized */
  149094. sqlite3_tokenizer_cursor **ppCursor /* OUT: Tokenization cursor */
  149095. ){
  149096. porter_tokenizer_cursor *c;
  149097. UNUSED_PARAMETER(pTokenizer);
  149098. c = (porter_tokenizer_cursor *) sqlite3_malloc(sizeof(*c));
  149099. if( c==NULL ) return SQLITE_NOMEM;
  149100. c->zInput = zInput;
  149101. if( zInput==0 ){
  149102. c->nInput = 0;
  149103. }else if( nInput<0 ){
  149104. c->nInput = (int)strlen(zInput);
  149105. }else{
  149106. c->nInput = nInput;
  149107. }
  149108. c->iOffset = 0; /* start tokenizing at the beginning */
  149109. c->iToken = 0;
  149110. c->zToken = NULL; /* no space allocated, yet. */
  149111. c->nAllocated = 0;
  149112. *ppCursor = &c->base;
  149113. return SQLITE_OK;
  149114. }
  149115. /*
  149116. ** Close a tokenization cursor previously opened by a call to
  149117. ** porterOpen() above.
  149118. */
  149119. static int porterClose(sqlite3_tokenizer_cursor *pCursor){
  149120. porter_tokenizer_cursor *c = (porter_tokenizer_cursor *) pCursor;
  149121. sqlite3_free(c->zToken);
  149122. sqlite3_free(c);
  149123. return SQLITE_OK;
  149124. }
  149125. /*
  149126. ** Vowel or consonant
  149127. */
  149128. static const char cType[] = {
  149129. 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0,
  149130. 1, 1, 1, 2, 1
  149131. };
  149132. /*
  149133. ** isConsonant() and isVowel() determine if their first character in
  149134. ** the string they point to is a consonant or a vowel, according
  149135. ** to Porter ruls.
  149136. **
  149137. ** A consonate is any letter other than 'a', 'e', 'i', 'o', or 'u'.
  149138. ** 'Y' is a consonant unless it follows another consonant,
  149139. ** in which case it is a vowel.
  149140. **
  149141. ** In these routine, the letters are in reverse order. So the 'y' rule
  149142. ** is that 'y' is a consonant unless it is followed by another
  149143. ** consonent.
  149144. */
  149145. static int isVowel(const char*);
  149146. static int isConsonant(const char *z){
  149147. int j;
  149148. char x = *z;
  149149. if( x==0 ) return 0;
  149150. assert( x>='a' && x<='z' );
  149151. j = cType[x-'a'];
  149152. if( j<2 ) return j;
  149153. return z[1]==0 || isVowel(z + 1);
  149154. }
  149155. static int isVowel(const char *z){
  149156. int j;
  149157. char x = *z;
  149158. if( x==0 ) return 0;
  149159. assert( x>='a' && x<='z' );
  149160. j = cType[x-'a'];
  149161. if( j<2 ) return 1-j;
  149162. return isConsonant(z + 1);
  149163. }
  149164. /*
  149165. ** Let any sequence of one or more vowels be represented by V and let
  149166. ** C be sequence of one or more consonants. Then every word can be
  149167. ** represented as:
  149168. **
  149169. ** [C] (VC){m} [V]
  149170. **
  149171. ** In prose: A word is an optional consonant followed by zero or
  149172. ** vowel-consonant pairs followed by an optional vowel. "m" is the
  149173. ** number of vowel consonant pairs. This routine computes the value
  149174. ** of m for the first i bytes of a word.
  149175. **
  149176. ** Return true if the m-value for z is 1 or more. In other words,
  149177. ** return true if z contains at least one vowel that is followed
  149178. ** by a consonant.
  149179. **
  149180. ** In this routine z[] is in reverse order. So we are really looking
  149181. ** for an instance of a consonant followed by a vowel.
  149182. */
  149183. static int m_gt_0(const char *z){
  149184. while( isVowel(z) ){ z++; }
  149185. if( *z==0 ) return 0;
  149186. while( isConsonant(z) ){ z++; }
  149187. return *z!=0;
  149188. }
  149189. /* Like mgt0 above except we are looking for a value of m which is
  149190. ** exactly 1
  149191. */
  149192. static int m_eq_1(const char *z){
  149193. while( isVowel(z) ){ z++; }
  149194. if( *z==0 ) return 0;
  149195. while( isConsonant(z) ){ z++; }
  149196. if( *z==0 ) return 0;
  149197. while( isVowel(z) ){ z++; }
  149198. if( *z==0 ) return 1;
  149199. while( isConsonant(z) ){ z++; }
  149200. return *z==0;
  149201. }
  149202. /* Like mgt0 above except we are looking for a value of m>1 instead
  149203. ** or m>0
  149204. */
  149205. static int m_gt_1(const char *z){
  149206. while( isVowel(z) ){ z++; }
  149207. if( *z==0 ) return 0;
  149208. while( isConsonant(z) ){ z++; }
  149209. if( *z==0 ) return 0;
  149210. while( isVowel(z) ){ z++; }
  149211. if( *z==0 ) return 0;
  149212. while( isConsonant(z) ){ z++; }
  149213. return *z!=0;
  149214. }
  149215. /*
  149216. ** Return TRUE if there is a vowel anywhere within z[0..n-1]
  149217. */
  149218. static int hasVowel(const char *z){
  149219. while( isConsonant(z) ){ z++; }
  149220. return *z!=0;
  149221. }
  149222. /*
  149223. ** Return TRUE if the word ends in a double consonant.
  149224. **
  149225. ** The text is reversed here. So we are really looking at
  149226. ** the first two characters of z[].
  149227. */
  149228. static int doubleConsonant(const char *z){
  149229. return isConsonant(z) && z[0]==z[1];
  149230. }
  149231. /*
  149232. ** Return TRUE if the word ends with three letters which
  149233. ** are consonant-vowel-consonent and where the final consonant
  149234. ** is not 'w', 'x', or 'y'.
  149235. **
  149236. ** The word is reversed here. So we are really checking the
  149237. ** first three letters and the first one cannot be in [wxy].
  149238. */
  149239. static int star_oh(const char *z){
  149240. return
  149241. isConsonant(z) &&
  149242. z[0]!='w' && z[0]!='x' && z[0]!='y' &&
  149243. isVowel(z+1) &&
  149244. isConsonant(z+2);
  149245. }
  149246. /*
  149247. ** If the word ends with zFrom and xCond() is true for the stem
  149248. ** of the word that preceeds the zFrom ending, then change the
  149249. ** ending to zTo.
  149250. **
  149251. ** The input word *pz and zFrom are both in reverse order. zTo
  149252. ** is in normal order.
  149253. **
  149254. ** Return TRUE if zFrom matches. Return FALSE if zFrom does not
  149255. ** match. Not that TRUE is returned even if xCond() fails and
  149256. ** no substitution occurs.
  149257. */
  149258. static int stem(
  149259. char **pz, /* The word being stemmed (Reversed) */
  149260. const char *zFrom, /* If the ending matches this... (Reversed) */
  149261. const char *zTo, /* ... change the ending to this (not reversed) */
  149262. int (*xCond)(const char*) /* Condition that must be true */
  149263. ){
  149264. char *z = *pz;
  149265. while( *zFrom && *zFrom==*z ){ z++; zFrom++; }
  149266. if( *zFrom!=0 ) return 0;
  149267. if( xCond && !xCond(z) ) return 1;
  149268. while( *zTo ){
  149269. *(--z) = *(zTo++);
  149270. }
  149271. *pz = z;
  149272. return 1;
  149273. }
  149274. /*
  149275. ** This is the fallback stemmer used when the porter stemmer is
  149276. ** inappropriate. The input word is copied into the output with
  149277. ** US-ASCII case folding. If the input word is too long (more
  149278. ** than 20 bytes if it contains no digits or more than 6 bytes if
  149279. ** it contains digits) then word is truncated to 20 or 6 bytes
  149280. ** by taking 10 or 3 bytes from the beginning and end.
  149281. */
  149282. static void copy_stemmer(const char *zIn, int nIn, char *zOut, int *pnOut){
  149283. int i, mx, j;
  149284. int hasDigit = 0;
  149285. for(i=0; i<nIn; i++){
  149286. char c = zIn[i];
  149287. if( c>='A' && c<='Z' ){
  149288. zOut[i] = c - 'A' + 'a';
  149289. }else{
  149290. if( c>='0' && c<='9' ) hasDigit = 1;
  149291. zOut[i] = c;
  149292. }
  149293. }
  149294. mx = hasDigit ? 3 : 10;
  149295. if( nIn>mx*2 ){
  149296. for(j=mx, i=nIn-mx; i<nIn; i++, j++){
  149297. zOut[j] = zOut[i];
  149298. }
  149299. i = j;
  149300. }
  149301. zOut[i] = 0;
  149302. *pnOut = i;
  149303. }
  149304. /*
  149305. ** Stem the input word zIn[0..nIn-1]. Store the output in zOut.
  149306. ** zOut is at least big enough to hold nIn bytes. Write the actual
  149307. ** size of the output word (exclusive of the '\0' terminator) into *pnOut.
  149308. **
  149309. ** Any upper-case characters in the US-ASCII character set ([A-Z])
  149310. ** are converted to lower case. Upper-case UTF characters are
  149311. ** unchanged.
  149312. **
  149313. ** Words that are longer than about 20 bytes are stemmed by retaining
  149314. ** a few bytes from the beginning and the end of the word. If the
  149315. ** word contains digits, 3 bytes are taken from the beginning and
  149316. ** 3 bytes from the end. For long words without digits, 10 bytes
  149317. ** are taken from each end. US-ASCII case folding still applies.
  149318. **
  149319. ** If the input word contains not digits but does characters not
  149320. ** in [a-zA-Z] then no stemming is attempted and this routine just
  149321. ** copies the input into the input into the output with US-ASCII
  149322. ** case folding.
  149323. **
  149324. ** Stemming never increases the length of the word. So there is
  149325. ** no chance of overflowing the zOut buffer.
  149326. */
  149327. static void porter_stemmer(const char *zIn, int nIn, char *zOut, int *pnOut){
  149328. int i, j;
  149329. char zReverse[28];
  149330. char *z, *z2;
  149331. if( nIn<3 || nIn>=(int)sizeof(zReverse)-7 ){
  149332. /* The word is too big or too small for the porter stemmer.
  149333. ** Fallback to the copy stemmer */
  149334. copy_stemmer(zIn, nIn, zOut, pnOut);
  149335. return;
  149336. }
  149337. for(i=0, j=sizeof(zReverse)-6; i<nIn; i++, j--){
  149338. char c = zIn[i];
  149339. if( c>='A' && c<='Z' ){
  149340. zReverse[j] = c + 'a' - 'A';
  149341. }else if( c>='a' && c<='z' ){
  149342. zReverse[j] = c;
  149343. }else{
  149344. /* The use of a character not in [a-zA-Z] means that we fallback
  149345. ** to the copy stemmer */
  149346. copy_stemmer(zIn, nIn, zOut, pnOut);
  149347. return;
  149348. }
  149349. }
  149350. memset(&zReverse[sizeof(zReverse)-5], 0, 5);
  149351. z = &zReverse[j+1];
  149352. /* Step 1a */
  149353. if( z[0]=='s' ){
  149354. if(
  149355. !stem(&z, "sess", "ss", 0) &&
  149356. !stem(&z, "sei", "i", 0) &&
  149357. !stem(&z, "ss", "ss", 0)
  149358. ){
  149359. z++;
  149360. }
  149361. }
  149362. /* Step 1b */
  149363. z2 = z;
  149364. if( stem(&z, "dee", "ee", m_gt_0) ){
  149365. /* Do nothing. The work was all in the test */
  149366. }else if(
  149367. (stem(&z, "gni", "", hasVowel) || stem(&z, "de", "", hasVowel))
  149368. && z!=z2
  149369. ){
  149370. if( stem(&z, "ta", "ate", 0) ||
  149371. stem(&z, "lb", "ble", 0) ||
  149372. stem(&z, "zi", "ize", 0) ){
  149373. /* Do nothing. The work was all in the test */
  149374. }else if( doubleConsonant(z) && (*z!='l' && *z!='s' && *z!='z') ){
  149375. z++;
  149376. }else if( m_eq_1(z) && star_oh(z) ){
  149377. *(--z) = 'e';
  149378. }
  149379. }
  149380. /* Step 1c */
  149381. if( z[0]=='y' && hasVowel(z+1) ){
  149382. z[0] = 'i';
  149383. }
  149384. /* Step 2 */
  149385. switch( z[1] ){
  149386. case 'a':
  149387. if( !stem(&z, "lanoita", "ate", m_gt_0) ){
  149388. stem(&z, "lanoit", "tion", m_gt_0);
  149389. }
  149390. break;
  149391. case 'c':
  149392. if( !stem(&z, "icne", "ence", m_gt_0) ){
  149393. stem(&z, "icna", "ance", m_gt_0);
  149394. }
  149395. break;
  149396. case 'e':
  149397. stem(&z, "rezi", "ize", m_gt_0);
  149398. break;
  149399. case 'g':
  149400. stem(&z, "igol", "log", m_gt_0);
  149401. break;
  149402. case 'l':
  149403. if( !stem(&z, "ilb", "ble", m_gt_0)
  149404. && !stem(&z, "illa", "al", m_gt_0)
  149405. && !stem(&z, "iltne", "ent", m_gt_0)
  149406. && !stem(&z, "ile", "e", m_gt_0)
  149407. ){
  149408. stem(&z, "ilsuo", "ous", m_gt_0);
  149409. }
  149410. break;
  149411. case 'o':
  149412. if( !stem(&z, "noitazi", "ize", m_gt_0)
  149413. && !stem(&z, "noita", "ate", m_gt_0)
  149414. ){
  149415. stem(&z, "rota", "ate", m_gt_0);
  149416. }
  149417. break;
  149418. case 's':
  149419. if( !stem(&z, "msila", "al", m_gt_0)
  149420. && !stem(&z, "ssenevi", "ive", m_gt_0)
  149421. && !stem(&z, "ssenluf", "ful", m_gt_0)
  149422. ){
  149423. stem(&z, "ssensuo", "ous", m_gt_0);
  149424. }
  149425. break;
  149426. case 't':
  149427. if( !stem(&z, "itila", "al", m_gt_0)
  149428. && !stem(&z, "itivi", "ive", m_gt_0)
  149429. ){
  149430. stem(&z, "itilib", "ble", m_gt_0);
  149431. }
  149432. break;
  149433. }
  149434. /* Step 3 */
  149435. switch( z[0] ){
  149436. case 'e':
  149437. if( !stem(&z, "etaci", "ic", m_gt_0)
  149438. && !stem(&z, "evita", "", m_gt_0)
  149439. ){
  149440. stem(&z, "ezila", "al", m_gt_0);
  149441. }
  149442. break;
  149443. case 'i':
  149444. stem(&z, "itici", "ic", m_gt_0);
  149445. break;
  149446. case 'l':
  149447. if( !stem(&z, "laci", "ic", m_gt_0) ){
  149448. stem(&z, "luf", "", m_gt_0);
  149449. }
  149450. break;
  149451. case 's':
  149452. stem(&z, "ssen", "", m_gt_0);
  149453. break;
  149454. }
  149455. /* Step 4 */
  149456. switch( z[1] ){
  149457. case 'a':
  149458. if( z[0]=='l' && m_gt_1(z+2) ){
  149459. z += 2;
  149460. }
  149461. break;
  149462. case 'c':
  149463. if( z[0]=='e' && z[2]=='n' && (z[3]=='a' || z[3]=='e') && m_gt_1(z+4) ){
  149464. z += 4;
  149465. }
  149466. break;
  149467. case 'e':
  149468. if( z[0]=='r' && m_gt_1(z+2) ){
  149469. z += 2;
  149470. }
  149471. break;
  149472. case 'i':
  149473. if( z[0]=='c' && m_gt_1(z+2) ){
  149474. z += 2;
  149475. }
  149476. break;
  149477. case 'l':
  149478. if( z[0]=='e' && z[2]=='b' && (z[3]=='a' || z[3]=='i') && m_gt_1(z+4) ){
  149479. z += 4;
  149480. }
  149481. break;
  149482. case 'n':
  149483. if( z[0]=='t' ){
  149484. if( z[2]=='a' ){
  149485. if( m_gt_1(z+3) ){
  149486. z += 3;
  149487. }
  149488. }else if( z[2]=='e' ){
  149489. if( !stem(&z, "tneme", "", m_gt_1)
  149490. && !stem(&z, "tnem", "", m_gt_1)
  149491. ){
  149492. stem(&z, "tne", "", m_gt_1);
  149493. }
  149494. }
  149495. }
  149496. break;
  149497. case 'o':
  149498. if( z[0]=='u' ){
  149499. if( m_gt_1(z+2) ){
  149500. z += 2;
  149501. }
  149502. }else if( z[3]=='s' || z[3]=='t' ){
  149503. stem(&z, "noi", "", m_gt_1);
  149504. }
  149505. break;
  149506. case 's':
  149507. if( z[0]=='m' && z[2]=='i' && m_gt_1(z+3) ){
  149508. z += 3;
  149509. }
  149510. break;
  149511. case 't':
  149512. if( !stem(&z, "eta", "", m_gt_1) ){
  149513. stem(&z, "iti", "", m_gt_1);
  149514. }
  149515. break;
  149516. case 'u':
  149517. if( z[0]=='s' && z[2]=='o' && m_gt_1(z+3) ){
  149518. z += 3;
  149519. }
  149520. break;
  149521. case 'v':
  149522. case 'z':
  149523. if( z[0]=='e' && z[2]=='i' && m_gt_1(z+3) ){
  149524. z += 3;
  149525. }
  149526. break;
  149527. }
  149528. /* Step 5a */
  149529. if( z[0]=='e' ){
  149530. if( m_gt_1(z+1) ){
  149531. z++;
  149532. }else if( m_eq_1(z+1) && !star_oh(z+1) ){
  149533. z++;
  149534. }
  149535. }
  149536. /* Step 5b */
  149537. if( m_gt_1(z) && z[0]=='l' && z[1]=='l' ){
  149538. z++;
  149539. }
  149540. /* z[] is now the stemmed word in reverse order. Flip it back
  149541. ** around into forward order and return.
  149542. */
  149543. *pnOut = i = (int)strlen(z);
  149544. zOut[i] = 0;
  149545. while( *z ){
  149546. zOut[--i] = *(z++);
  149547. }
  149548. }
  149549. /*
  149550. ** Characters that can be part of a token. We assume any character
  149551. ** whose value is greater than 0x80 (any UTF character) can be
  149552. ** part of a token. In other words, delimiters all must have
  149553. ** values of 0x7f or lower.
  149554. */
  149555. static const char porterIdChar[] = {
  149556. /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
  149557. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 3x */
  149558. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 4x */
  149559. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 5x */
  149560. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 6x */
  149561. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 7x */
  149562. };
  149563. #define isDelim(C) (((ch=C)&0x80)==0 && (ch<0x30 || !porterIdChar[ch-0x30]))
  149564. /*
  149565. ** Extract the next token from a tokenization cursor. The cursor must
  149566. ** have been opened by a prior call to porterOpen().
  149567. */
  149568. static int porterNext(
  149569. sqlite3_tokenizer_cursor *pCursor, /* Cursor returned by porterOpen */
  149570. const char **pzToken, /* OUT: *pzToken is the token text */
  149571. int *pnBytes, /* OUT: Number of bytes in token */
  149572. int *piStartOffset, /* OUT: Starting offset of token */
  149573. int *piEndOffset, /* OUT: Ending offset of token */
  149574. int *piPosition /* OUT: Position integer of token */
  149575. ){
  149576. porter_tokenizer_cursor *c = (porter_tokenizer_cursor *) pCursor;
  149577. const char *z = c->zInput;
  149578. while( c->iOffset<c->nInput ){
  149579. int iStartOffset, ch;
  149580. /* Scan past delimiter characters */
  149581. while( c->iOffset<c->nInput && isDelim(z[c->iOffset]) ){
  149582. c->iOffset++;
  149583. }
  149584. /* Count non-delimiter characters. */
  149585. iStartOffset = c->iOffset;
  149586. while( c->iOffset<c->nInput && !isDelim(z[c->iOffset]) ){
  149587. c->iOffset++;
  149588. }
  149589. if( c->iOffset>iStartOffset ){
  149590. int n = c->iOffset-iStartOffset;
  149591. if( n>c->nAllocated ){
  149592. char *pNew;
  149593. c->nAllocated = n+20;
  149594. pNew = sqlite3_realloc(c->zToken, c->nAllocated);
  149595. if( !pNew ) return SQLITE_NOMEM;
  149596. c->zToken = pNew;
  149597. }
  149598. porter_stemmer(&z[iStartOffset], n, c->zToken, pnBytes);
  149599. *pzToken = c->zToken;
  149600. *piStartOffset = iStartOffset;
  149601. *piEndOffset = c->iOffset;
  149602. *piPosition = c->iToken++;
  149603. return SQLITE_OK;
  149604. }
  149605. }
  149606. return SQLITE_DONE;
  149607. }
  149608. /*
  149609. ** The set of routines that implement the porter-stemmer tokenizer
  149610. */
  149611. static const sqlite3_tokenizer_module porterTokenizerModule = {
  149612. 0,
  149613. porterCreate,
  149614. porterDestroy,
  149615. porterOpen,
  149616. porterClose,
  149617. porterNext,
  149618. 0
  149619. };
  149620. /*
  149621. ** Allocate a new porter tokenizer. Return a pointer to the new
  149622. ** tokenizer in *ppModule
  149623. */
  149624. SQLITE_PRIVATE void sqlite3Fts3PorterTokenizerModule(
  149625. sqlite3_tokenizer_module const**ppModule
  149626. ){
  149627. *ppModule = &porterTokenizerModule;
  149628. }
  149629. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  149630. /************** End of fts3_porter.c *****************************************/
  149631. /************** Begin file fts3_tokenizer.c **********************************/
  149632. /*
  149633. ** 2007 June 22
  149634. **
  149635. ** The author disclaims copyright to this source code. In place of
  149636. ** a legal notice, here is a blessing:
  149637. **
  149638. ** May you do good and not evil.
  149639. ** May you find forgiveness for yourself and forgive others.
  149640. ** May you share freely, never taking more than you give.
  149641. **
  149642. ******************************************************************************
  149643. **
  149644. ** This is part of an SQLite module implementing full-text search.
  149645. ** This particular file implements the generic tokenizer interface.
  149646. */
  149647. /*
  149648. ** The code in this file is only compiled if:
  149649. **
  149650. ** * The FTS3 module is being built as an extension
  149651. ** (in which case SQLITE_CORE is not defined), or
  149652. **
  149653. ** * The FTS3 module is being built into the core of
  149654. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  149655. */
  149656. /* #include "fts3Int.h" */
  149657. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  149658. /* #include <assert.h> */
  149659. /* #include <string.h> */
  149660. /*
  149661. ** Return true if the two-argument version of fts3_tokenizer()
  149662. ** has been activated via a prior call to sqlite3_db_config(db,
  149663. ** SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER, 1, 0);
  149664. */
  149665. static int fts3TokenizerEnabled(sqlite3_context *context){
  149666. sqlite3 *db = sqlite3_context_db_handle(context);
  149667. int isEnabled = 0;
  149668. sqlite3_db_config(db,SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER,-1,&isEnabled);
  149669. return isEnabled;
  149670. }
  149671. /*
  149672. ** Implementation of the SQL scalar function for accessing the underlying
  149673. ** hash table. This function may be called as follows:
  149674. **
  149675. ** SELECT <function-name>(<key-name>);
  149676. ** SELECT <function-name>(<key-name>, <pointer>);
  149677. **
  149678. ** where <function-name> is the name passed as the second argument
  149679. ** to the sqlite3Fts3InitHashTable() function (e.g. 'fts3_tokenizer').
  149680. **
  149681. ** If the <pointer> argument is specified, it must be a blob value
  149682. ** containing a pointer to be stored as the hash data corresponding
  149683. ** to the string <key-name>. If <pointer> is not specified, then
  149684. ** the string <key-name> must already exist in the has table. Otherwise,
  149685. ** an error is returned.
  149686. **
  149687. ** Whether or not the <pointer> argument is specified, the value returned
  149688. ** is a blob containing the pointer stored as the hash data corresponding
  149689. ** to string <key-name> (after the hash-table is updated, if applicable).
  149690. */
  149691. static void fts3TokenizerFunc(
  149692. sqlite3_context *context,
  149693. int argc,
  149694. sqlite3_value **argv
  149695. ){
  149696. Fts3Hash *pHash;
  149697. void *pPtr = 0;
  149698. const unsigned char *zName;
  149699. int nName;
  149700. assert( argc==1 || argc==2 );
  149701. pHash = (Fts3Hash *)sqlite3_user_data(context);
  149702. zName = sqlite3_value_text(argv[0]);
  149703. nName = sqlite3_value_bytes(argv[0])+1;
  149704. if( argc==2 ){
  149705. if( fts3TokenizerEnabled(context) ){
  149706. void *pOld;
  149707. int n = sqlite3_value_bytes(argv[1]);
  149708. if( zName==0 || n!=sizeof(pPtr) ){
  149709. sqlite3_result_error(context, "argument type mismatch", -1);
  149710. return;
  149711. }
  149712. pPtr = *(void **)sqlite3_value_blob(argv[1]);
  149713. pOld = sqlite3Fts3HashInsert(pHash, (void *)zName, nName, pPtr);
  149714. if( pOld==pPtr ){
  149715. sqlite3_result_error(context, "out of memory", -1);
  149716. }
  149717. }else{
  149718. sqlite3_result_error(context, "fts3tokenize disabled", -1);
  149719. return;
  149720. }
  149721. }else{
  149722. if( zName ){
  149723. pPtr = sqlite3Fts3HashFind(pHash, zName, nName);
  149724. }
  149725. if( !pPtr ){
  149726. char *zErr = sqlite3_mprintf("unknown tokenizer: %s", zName);
  149727. sqlite3_result_error(context, zErr, -1);
  149728. sqlite3_free(zErr);
  149729. return;
  149730. }
  149731. }
  149732. sqlite3_result_blob(context, (void *)&pPtr, sizeof(pPtr), SQLITE_TRANSIENT);
  149733. }
  149734. SQLITE_PRIVATE int sqlite3Fts3IsIdChar(char c){
  149735. static const char isFtsIdChar[] = {
  149736. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x */
  149737. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 1x */
  149738. 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 2x */
  149739. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 3x */
  149740. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 4x */
  149741. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 5x */
  149742. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 6x */
  149743. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 7x */
  149744. };
  149745. return (c&0x80 || isFtsIdChar[(int)(c)]);
  149746. }
  149747. SQLITE_PRIVATE const char *sqlite3Fts3NextToken(const char *zStr, int *pn){
  149748. const char *z1;
  149749. const char *z2 = 0;
  149750. /* Find the start of the next token. */
  149751. z1 = zStr;
  149752. while( z2==0 ){
  149753. char c = *z1;
  149754. switch( c ){
  149755. case '\0': return 0; /* No more tokens here */
  149756. case '\'':
  149757. case '"':
  149758. case '`': {
  149759. z2 = z1;
  149760. while( *++z2 && (*z2!=c || *++z2==c) );
  149761. break;
  149762. }
  149763. case '[':
  149764. z2 = &z1[1];
  149765. while( *z2 && z2[0]!=']' ) z2++;
  149766. if( *z2 ) z2++;
  149767. break;
  149768. default:
  149769. if( sqlite3Fts3IsIdChar(*z1) ){
  149770. z2 = &z1[1];
  149771. while( sqlite3Fts3IsIdChar(*z2) ) z2++;
  149772. }else{
  149773. z1++;
  149774. }
  149775. }
  149776. }
  149777. *pn = (int)(z2-z1);
  149778. return z1;
  149779. }
  149780. SQLITE_PRIVATE int sqlite3Fts3InitTokenizer(
  149781. Fts3Hash *pHash, /* Tokenizer hash table */
  149782. const char *zArg, /* Tokenizer name */
  149783. sqlite3_tokenizer **ppTok, /* OUT: Tokenizer (if applicable) */
  149784. char **pzErr /* OUT: Set to malloced error message */
  149785. ){
  149786. int rc;
  149787. char *z = (char *)zArg;
  149788. int n = 0;
  149789. char *zCopy;
  149790. char *zEnd; /* Pointer to nul-term of zCopy */
  149791. sqlite3_tokenizer_module *m;
  149792. zCopy = sqlite3_mprintf("%s", zArg);
  149793. if( !zCopy ) return SQLITE_NOMEM;
  149794. zEnd = &zCopy[strlen(zCopy)];
  149795. z = (char *)sqlite3Fts3NextToken(zCopy, &n);
  149796. if( z==0 ){
  149797. assert( n==0 );
  149798. z = zCopy;
  149799. }
  149800. z[n] = '\0';
  149801. sqlite3Fts3Dequote(z);
  149802. m = (sqlite3_tokenizer_module *)sqlite3Fts3HashFind(pHash,z,(int)strlen(z)+1);
  149803. if( !m ){
  149804. sqlite3Fts3ErrMsg(pzErr, "unknown tokenizer: %s", z);
  149805. rc = SQLITE_ERROR;
  149806. }else{
  149807. char const **aArg = 0;
  149808. int iArg = 0;
  149809. z = &z[n+1];
  149810. while( z<zEnd && (NULL!=(z = (char *)sqlite3Fts3NextToken(z, &n))) ){
  149811. int nNew = sizeof(char *)*(iArg+1);
  149812. char const **aNew = (const char **)sqlite3_realloc((void *)aArg, nNew);
  149813. if( !aNew ){
  149814. sqlite3_free(zCopy);
  149815. sqlite3_free((void *)aArg);
  149816. return SQLITE_NOMEM;
  149817. }
  149818. aArg = aNew;
  149819. aArg[iArg++] = z;
  149820. z[n] = '\0';
  149821. sqlite3Fts3Dequote(z);
  149822. z = &z[n+1];
  149823. }
  149824. rc = m->xCreate(iArg, aArg, ppTok);
  149825. assert( rc!=SQLITE_OK || *ppTok );
  149826. if( rc!=SQLITE_OK ){
  149827. sqlite3Fts3ErrMsg(pzErr, "unknown tokenizer");
  149828. }else{
  149829. (*ppTok)->pModule = m;
  149830. }
  149831. sqlite3_free((void *)aArg);
  149832. }
  149833. sqlite3_free(zCopy);
  149834. return rc;
  149835. }
  149836. #ifdef SQLITE_TEST
  149837. #if defined(INCLUDE_SQLITE_TCL_H)
  149838. # include "sqlite_tcl.h"
  149839. #else
  149840. # include "tcl.h"
  149841. #endif
  149842. /* #include <string.h> */
  149843. /*
  149844. ** Implementation of a special SQL scalar function for testing tokenizers
  149845. ** designed to be used in concert with the Tcl testing framework. This
  149846. ** function must be called with two or more arguments:
  149847. **
  149848. ** SELECT <function-name>(<key-name>, ..., <input-string>);
  149849. **
  149850. ** where <function-name> is the name passed as the second argument
  149851. ** to the sqlite3Fts3InitHashTable() function (e.g. 'fts3_tokenizer')
  149852. ** concatenated with the string '_test' (e.g. 'fts3_tokenizer_test').
  149853. **
  149854. ** The return value is a string that may be interpreted as a Tcl
  149855. ** list. For each token in the <input-string>, three elements are
  149856. ** added to the returned list. The first is the token position, the
  149857. ** second is the token text (folded, stemmed, etc.) and the third is the
  149858. ** substring of <input-string> associated with the token. For example,
  149859. ** using the built-in "simple" tokenizer:
  149860. **
  149861. ** SELECT fts_tokenizer_test('simple', 'I don't see how');
  149862. **
  149863. ** will return the string:
  149864. **
  149865. ** "{0 i I 1 dont don't 2 see see 3 how how}"
  149866. **
  149867. */
  149868. static void testFunc(
  149869. sqlite3_context *context,
  149870. int argc,
  149871. sqlite3_value **argv
  149872. ){
  149873. Fts3Hash *pHash;
  149874. sqlite3_tokenizer_module *p;
  149875. sqlite3_tokenizer *pTokenizer = 0;
  149876. sqlite3_tokenizer_cursor *pCsr = 0;
  149877. const char *zErr = 0;
  149878. const char *zName;
  149879. int nName;
  149880. const char *zInput;
  149881. int nInput;
  149882. const char *azArg[64];
  149883. const char *zToken;
  149884. int nToken = 0;
  149885. int iStart = 0;
  149886. int iEnd = 0;
  149887. int iPos = 0;
  149888. int i;
  149889. Tcl_Obj *pRet;
  149890. if( argc<2 ){
  149891. sqlite3_result_error(context, "insufficient arguments", -1);
  149892. return;
  149893. }
  149894. nName = sqlite3_value_bytes(argv[0]);
  149895. zName = (const char *)sqlite3_value_text(argv[0]);
  149896. nInput = sqlite3_value_bytes(argv[argc-1]);
  149897. zInput = (const char *)sqlite3_value_text(argv[argc-1]);
  149898. pHash = (Fts3Hash *)sqlite3_user_data(context);
  149899. p = (sqlite3_tokenizer_module *)sqlite3Fts3HashFind(pHash, zName, nName+1);
  149900. if( !p ){
  149901. char *zErr2 = sqlite3_mprintf("unknown tokenizer: %s", zName);
  149902. sqlite3_result_error(context, zErr2, -1);
  149903. sqlite3_free(zErr2);
  149904. return;
  149905. }
  149906. pRet = Tcl_NewObj();
  149907. Tcl_IncrRefCount(pRet);
  149908. for(i=1; i<argc-1; i++){
  149909. azArg[i-1] = (const char *)sqlite3_value_text(argv[i]);
  149910. }
  149911. if( SQLITE_OK!=p->xCreate(argc-2, azArg, &pTokenizer) ){
  149912. zErr = "error in xCreate()";
  149913. goto finish;
  149914. }
  149915. pTokenizer->pModule = p;
  149916. if( sqlite3Fts3OpenTokenizer(pTokenizer, 0, zInput, nInput, &pCsr) ){
  149917. zErr = "error in xOpen()";
  149918. goto finish;
  149919. }
  149920. while( SQLITE_OK==p->xNext(pCsr, &zToken, &nToken, &iStart, &iEnd, &iPos) ){
  149921. Tcl_ListObjAppendElement(0, pRet, Tcl_NewIntObj(iPos));
  149922. Tcl_ListObjAppendElement(0, pRet, Tcl_NewStringObj(zToken, nToken));
  149923. zToken = &zInput[iStart];
  149924. nToken = iEnd-iStart;
  149925. Tcl_ListObjAppendElement(0, pRet, Tcl_NewStringObj(zToken, nToken));
  149926. }
  149927. if( SQLITE_OK!=p->xClose(pCsr) ){
  149928. zErr = "error in xClose()";
  149929. goto finish;
  149930. }
  149931. if( SQLITE_OK!=p->xDestroy(pTokenizer) ){
  149932. zErr = "error in xDestroy()";
  149933. goto finish;
  149934. }
  149935. finish:
  149936. if( zErr ){
  149937. sqlite3_result_error(context, zErr, -1);
  149938. }else{
  149939. sqlite3_result_text(context, Tcl_GetString(pRet), -1, SQLITE_TRANSIENT);
  149940. }
  149941. Tcl_DecrRefCount(pRet);
  149942. }
  149943. static
  149944. int registerTokenizer(
  149945. sqlite3 *db,
  149946. char *zName,
  149947. const sqlite3_tokenizer_module *p
  149948. ){
  149949. int rc;
  149950. sqlite3_stmt *pStmt;
  149951. const char zSql[] = "SELECT fts3_tokenizer(?, ?)";
  149952. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  149953. if( rc!=SQLITE_OK ){
  149954. return rc;
  149955. }
  149956. sqlite3_bind_text(pStmt, 1, zName, -1, SQLITE_STATIC);
  149957. sqlite3_bind_blob(pStmt, 2, &p, sizeof(p), SQLITE_STATIC);
  149958. sqlite3_step(pStmt);
  149959. return sqlite3_finalize(pStmt);
  149960. }
  149961. static
  149962. int queryTokenizer(
  149963. sqlite3 *db,
  149964. char *zName,
  149965. const sqlite3_tokenizer_module **pp
  149966. ){
  149967. int rc;
  149968. sqlite3_stmt *pStmt;
  149969. const char zSql[] = "SELECT fts3_tokenizer(?)";
  149970. *pp = 0;
  149971. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  149972. if( rc!=SQLITE_OK ){
  149973. return rc;
  149974. }
  149975. sqlite3_bind_text(pStmt, 1, zName, -1, SQLITE_STATIC);
  149976. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  149977. if( sqlite3_column_type(pStmt, 0)==SQLITE_BLOB ){
  149978. memcpy((void *)pp, sqlite3_column_blob(pStmt, 0), sizeof(*pp));
  149979. }
  149980. }
  149981. return sqlite3_finalize(pStmt);
  149982. }
  149983. SQLITE_PRIVATE void sqlite3Fts3SimpleTokenizerModule(sqlite3_tokenizer_module const**ppModule);
  149984. /*
  149985. ** Implementation of the scalar function fts3_tokenizer_internal_test().
  149986. ** This function is used for testing only, it is not included in the
  149987. ** build unless SQLITE_TEST is defined.
  149988. **
  149989. ** The purpose of this is to test that the fts3_tokenizer() function
  149990. ** can be used as designed by the C-code in the queryTokenizer and
  149991. ** registerTokenizer() functions above. These two functions are repeated
  149992. ** in the README.tokenizer file as an example, so it is important to
  149993. ** test them.
  149994. **
  149995. ** To run the tests, evaluate the fts3_tokenizer_internal_test() scalar
  149996. ** function with no arguments. An assert() will fail if a problem is
  149997. ** detected. i.e.:
  149998. **
  149999. ** SELECT fts3_tokenizer_internal_test();
  150000. **
  150001. */
  150002. static void intTestFunc(
  150003. sqlite3_context *context,
  150004. int argc,
  150005. sqlite3_value **argv
  150006. ){
  150007. int rc;
  150008. const sqlite3_tokenizer_module *p1;
  150009. const sqlite3_tokenizer_module *p2;
  150010. sqlite3 *db = (sqlite3 *)sqlite3_user_data(context);
  150011. UNUSED_PARAMETER(argc);
  150012. UNUSED_PARAMETER(argv);
  150013. /* Test the query function */
  150014. sqlite3Fts3SimpleTokenizerModule(&p1);
  150015. rc = queryTokenizer(db, "simple", &p2);
  150016. assert( rc==SQLITE_OK );
  150017. assert( p1==p2 );
  150018. rc = queryTokenizer(db, "nosuchtokenizer", &p2);
  150019. assert( rc==SQLITE_ERROR );
  150020. assert( p2==0 );
  150021. assert( 0==strcmp(sqlite3_errmsg(db), "unknown tokenizer: nosuchtokenizer") );
  150022. /* Test the storage function */
  150023. if( fts3TokenizerEnabled(context) ){
  150024. rc = registerTokenizer(db, "nosuchtokenizer", p1);
  150025. assert( rc==SQLITE_OK );
  150026. rc = queryTokenizer(db, "nosuchtokenizer", &p2);
  150027. assert( rc==SQLITE_OK );
  150028. assert( p2==p1 );
  150029. }
  150030. sqlite3_result_text(context, "ok", -1, SQLITE_STATIC);
  150031. }
  150032. #endif
  150033. /*
  150034. ** Set up SQL objects in database db used to access the contents of
  150035. ** the hash table pointed to by argument pHash. The hash table must
  150036. ** been initialized to use string keys, and to take a private copy
  150037. ** of the key when a value is inserted. i.e. by a call similar to:
  150038. **
  150039. ** sqlite3Fts3HashInit(pHash, FTS3_HASH_STRING, 1);
  150040. **
  150041. ** This function adds a scalar function (see header comment above
  150042. ** fts3TokenizerFunc() in this file for details) and, if ENABLE_TABLE is
  150043. ** defined at compilation time, a temporary virtual table (see header
  150044. ** comment above struct HashTableVtab) to the database schema. Both
  150045. ** provide read/write access to the contents of *pHash.
  150046. **
  150047. ** The third argument to this function, zName, is used as the name
  150048. ** of both the scalar and, if created, the virtual table.
  150049. */
  150050. SQLITE_PRIVATE int sqlite3Fts3InitHashTable(
  150051. sqlite3 *db,
  150052. Fts3Hash *pHash,
  150053. const char *zName
  150054. ){
  150055. int rc = SQLITE_OK;
  150056. void *p = (void *)pHash;
  150057. const int any = SQLITE_ANY;
  150058. #ifdef SQLITE_TEST
  150059. char *zTest = 0;
  150060. char *zTest2 = 0;
  150061. void *pdb = (void *)db;
  150062. zTest = sqlite3_mprintf("%s_test", zName);
  150063. zTest2 = sqlite3_mprintf("%s_internal_test", zName);
  150064. if( !zTest || !zTest2 ){
  150065. rc = SQLITE_NOMEM;
  150066. }
  150067. #endif
  150068. if( SQLITE_OK==rc ){
  150069. rc = sqlite3_create_function(db, zName, 1, any, p, fts3TokenizerFunc, 0, 0);
  150070. }
  150071. if( SQLITE_OK==rc ){
  150072. rc = sqlite3_create_function(db, zName, 2, any, p, fts3TokenizerFunc, 0, 0);
  150073. }
  150074. #ifdef SQLITE_TEST
  150075. if( SQLITE_OK==rc ){
  150076. rc = sqlite3_create_function(db, zTest, -1, any, p, testFunc, 0, 0);
  150077. }
  150078. if( SQLITE_OK==rc ){
  150079. rc = sqlite3_create_function(db, zTest2, 0, any, pdb, intTestFunc, 0, 0);
  150080. }
  150081. #endif
  150082. #ifdef SQLITE_TEST
  150083. sqlite3_free(zTest);
  150084. sqlite3_free(zTest2);
  150085. #endif
  150086. return rc;
  150087. }
  150088. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  150089. /************** End of fts3_tokenizer.c **************************************/
  150090. /************** Begin file fts3_tokenizer1.c *********************************/
  150091. /*
  150092. ** 2006 Oct 10
  150093. **
  150094. ** The author disclaims copyright to this source code. In place of
  150095. ** a legal notice, here is a blessing:
  150096. **
  150097. ** May you do good and not evil.
  150098. ** May you find forgiveness for yourself and forgive others.
  150099. ** May you share freely, never taking more than you give.
  150100. **
  150101. ******************************************************************************
  150102. **
  150103. ** Implementation of the "simple" full-text-search tokenizer.
  150104. */
  150105. /*
  150106. ** The code in this file is only compiled if:
  150107. **
  150108. ** * The FTS3 module is being built as an extension
  150109. ** (in which case SQLITE_CORE is not defined), or
  150110. **
  150111. ** * The FTS3 module is being built into the core of
  150112. ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
  150113. */
  150114. /* #include "fts3Int.h" */
  150115. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  150116. /* #include <assert.h> */
  150117. /* #include <stdlib.h> */
  150118. /* #include <stdio.h> */
  150119. /* #include <string.h> */
  150120. /* #include "fts3_tokenizer.h" */
  150121. typedef struct simple_tokenizer {
  150122. sqlite3_tokenizer base;
  150123. char delim[128]; /* flag ASCII delimiters */
  150124. } simple_tokenizer;
  150125. typedef struct simple_tokenizer_cursor {
  150126. sqlite3_tokenizer_cursor base;
  150127. const char *pInput; /* input we are tokenizing */
  150128. int nBytes; /* size of the input */
  150129. int iOffset; /* current position in pInput */
  150130. int iToken; /* index of next token to be returned */
  150131. char *pToken; /* storage for current token */
  150132. int nTokenAllocated; /* space allocated to zToken buffer */
  150133. } simple_tokenizer_cursor;
  150134. static int simpleDelim(simple_tokenizer *t, unsigned char c){
  150135. return c<0x80 && t->delim[c];
  150136. }
  150137. static int fts3_isalnum(int x){
  150138. return (x>='0' && x<='9') || (x>='A' && x<='Z') || (x>='a' && x<='z');
  150139. }
  150140. /*
  150141. ** Create a new tokenizer instance.
  150142. */
  150143. static int simpleCreate(
  150144. int argc, const char * const *argv,
  150145. sqlite3_tokenizer **ppTokenizer
  150146. ){
  150147. simple_tokenizer *t;
  150148. t = (simple_tokenizer *) sqlite3_malloc(sizeof(*t));
  150149. if( t==NULL ) return SQLITE_NOMEM;
  150150. memset(t, 0, sizeof(*t));
  150151. /* TODO(shess) Delimiters need to remain the same from run to run,
  150152. ** else we need to reindex. One solution would be a meta-table to
  150153. ** track such information in the database, then we'd only want this
  150154. ** information on the initial create.
  150155. */
  150156. if( argc>1 ){
  150157. int i, n = (int)strlen(argv[1]);
  150158. for(i=0; i<n; i++){
  150159. unsigned char ch = argv[1][i];
  150160. /* We explicitly don't support UTF-8 delimiters for now. */
  150161. if( ch>=0x80 ){
  150162. sqlite3_free(t);
  150163. return SQLITE_ERROR;
  150164. }
  150165. t->delim[ch] = 1;
  150166. }
  150167. } else {
  150168. /* Mark non-alphanumeric ASCII characters as delimiters */
  150169. int i;
  150170. for(i=1; i<0x80; i++){
  150171. t->delim[i] = !fts3_isalnum(i) ? -1 : 0;
  150172. }
  150173. }
  150174. *ppTokenizer = &t->base;
  150175. return SQLITE_OK;
  150176. }
  150177. /*
  150178. ** Destroy a tokenizer
  150179. */
  150180. static int simpleDestroy(sqlite3_tokenizer *pTokenizer){
  150181. sqlite3_free(pTokenizer);
  150182. return SQLITE_OK;
  150183. }
  150184. /*
  150185. ** Prepare to begin tokenizing a particular string. The input
  150186. ** string to be tokenized is pInput[0..nBytes-1]. A cursor
  150187. ** used to incrementally tokenize this string is returned in
  150188. ** *ppCursor.
  150189. */
  150190. static int simpleOpen(
  150191. sqlite3_tokenizer *pTokenizer, /* The tokenizer */
  150192. const char *pInput, int nBytes, /* String to be tokenized */
  150193. sqlite3_tokenizer_cursor **ppCursor /* OUT: Tokenization cursor */
  150194. ){
  150195. simple_tokenizer_cursor *c;
  150196. UNUSED_PARAMETER(pTokenizer);
  150197. c = (simple_tokenizer_cursor *) sqlite3_malloc(sizeof(*c));
  150198. if( c==NULL ) return SQLITE_NOMEM;
  150199. c->pInput = pInput;
  150200. if( pInput==0 ){
  150201. c->nBytes = 0;
  150202. }else if( nBytes<0 ){
  150203. c->nBytes = (int)strlen(pInput);
  150204. }else{
  150205. c->nBytes = nBytes;
  150206. }
  150207. c->iOffset = 0; /* start tokenizing at the beginning */
  150208. c->iToken = 0;
  150209. c->pToken = NULL; /* no space allocated, yet. */
  150210. c->nTokenAllocated = 0;
  150211. *ppCursor = &c->base;
  150212. return SQLITE_OK;
  150213. }
  150214. /*
  150215. ** Close a tokenization cursor previously opened by a call to
  150216. ** simpleOpen() above.
  150217. */
  150218. static int simpleClose(sqlite3_tokenizer_cursor *pCursor){
  150219. simple_tokenizer_cursor *c = (simple_tokenizer_cursor *) pCursor;
  150220. sqlite3_free(c->pToken);
  150221. sqlite3_free(c);
  150222. return SQLITE_OK;
  150223. }
  150224. /*
  150225. ** Extract the next token from a tokenization cursor. The cursor must
  150226. ** have been opened by a prior call to simpleOpen().
  150227. */
  150228. static int simpleNext(
  150229. sqlite3_tokenizer_cursor *pCursor, /* Cursor returned by simpleOpen */
  150230. const char **ppToken, /* OUT: *ppToken is the token text */
  150231. int *pnBytes, /* OUT: Number of bytes in token */
  150232. int *piStartOffset, /* OUT: Starting offset of token */
  150233. int *piEndOffset, /* OUT: Ending offset of token */
  150234. int *piPosition /* OUT: Position integer of token */
  150235. ){
  150236. simple_tokenizer_cursor *c = (simple_tokenizer_cursor *) pCursor;
  150237. simple_tokenizer *t = (simple_tokenizer *) pCursor->pTokenizer;
  150238. unsigned char *p = (unsigned char *)c->pInput;
  150239. while( c->iOffset<c->nBytes ){
  150240. int iStartOffset;
  150241. /* Scan past delimiter characters */
  150242. while( c->iOffset<c->nBytes && simpleDelim(t, p[c->iOffset]) ){
  150243. c->iOffset++;
  150244. }
  150245. /* Count non-delimiter characters. */
  150246. iStartOffset = c->iOffset;
  150247. while( c->iOffset<c->nBytes && !simpleDelim(t, p[c->iOffset]) ){
  150248. c->iOffset++;
  150249. }
  150250. if( c->iOffset>iStartOffset ){
  150251. int i, n = c->iOffset-iStartOffset;
  150252. if( n>c->nTokenAllocated ){
  150253. char *pNew;
  150254. c->nTokenAllocated = n+20;
  150255. pNew = sqlite3_realloc(c->pToken, c->nTokenAllocated);
  150256. if( !pNew ) return SQLITE_NOMEM;
  150257. c->pToken = pNew;
  150258. }
  150259. for(i=0; i<n; i++){
  150260. /* TODO(shess) This needs expansion to handle UTF-8
  150261. ** case-insensitivity.
  150262. */
  150263. unsigned char ch = p[iStartOffset+i];
  150264. c->pToken[i] = (char)((ch>='A' && ch<='Z') ? ch-'A'+'a' : ch);
  150265. }
  150266. *ppToken = c->pToken;
  150267. *pnBytes = n;
  150268. *piStartOffset = iStartOffset;
  150269. *piEndOffset = c->iOffset;
  150270. *piPosition = c->iToken++;
  150271. return SQLITE_OK;
  150272. }
  150273. }
  150274. return SQLITE_DONE;
  150275. }
  150276. /*
  150277. ** The set of routines that implement the simple tokenizer
  150278. */
  150279. static const sqlite3_tokenizer_module simpleTokenizerModule = {
  150280. 0,
  150281. simpleCreate,
  150282. simpleDestroy,
  150283. simpleOpen,
  150284. simpleClose,
  150285. simpleNext,
  150286. 0,
  150287. };
  150288. /*
  150289. ** Allocate a new simple tokenizer. Return a pointer to the new
  150290. ** tokenizer in *ppModule
  150291. */
  150292. SQLITE_PRIVATE void sqlite3Fts3SimpleTokenizerModule(
  150293. sqlite3_tokenizer_module const**ppModule
  150294. ){
  150295. *ppModule = &simpleTokenizerModule;
  150296. }
  150297. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  150298. /************** End of fts3_tokenizer1.c *************************************/
  150299. /************** Begin file fts3_tokenize_vtab.c ******************************/
  150300. /*
  150301. ** 2013 Apr 22
  150302. **
  150303. ** The author disclaims copyright to this source code. In place of
  150304. ** a legal notice, here is a blessing:
  150305. **
  150306. ** May you do good and not evil.
  150307. ** May you find forgiveness for yourself and forgive others.
  150308. ** May you share freely, never taking more than you give.
  150309. **
  150310. ******************************************************************************
  150311. **
  150312. ** This file contains code for the "fts3tokenize" virtual table module.
  150313. ** An fts3tokenize virtual table is created as follows:
  150314. **
  150315. ** CREATE VIRTUAL TABLE <tbl> USING fts3tokenize(
  150316. ** <tokenizer-name>, <arg-1>, ...
  150317. ** );
  150318. **
  150319. ** The table created has the following schema:
  150320. **
  150321. ** CREATE TABLE <tbl>(input, token, start, end, position)
  150322. **
  150323. ** When queried, the query must include a WHERE clause of type:
  150324. **
  150325. ** input = <string>
  150326. **
  150327. ** The virtual table module tokenizes this <string>, using the FTS3
  150328. ** tokenizer specified by the arguments to the CREATE VIRTUAL TABLE
  150329. ** statement and returns one row for each token in the result. With
  150330. ** fields set as follows:
  150331. **
  150332. ** input: Always set to a copy of <string>
  150333. ** token: A token from the input.
  150334. ** start: Byte offset of the token within the input <string>.
  150335. ** end: Byte offset of the byte immediately following the end of the
  150336. ** token within the input string.
  150337. ** pos: Token offset of token within input.
  150338. **
  150339. */
  150340. /* #include "fts3Int.h" */
  150341. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  150342. /* #include <string.h> */
  150343. /* #include <assert.h> */
  150344. typedef struct Fts3tokTable Fts3tokTable;
  150345. typedef struct Fts3tokCursor Fts3tokCursor;
  150346. /*
  150347. ** Virtual table structure.
  150348. */
  150349. struct Fts3tokTable {
  150350. sqlite3_vtab base; /* Base class used by SQLite core */
  150351. const sqlite3_tokenizer_module *pMod;
  150352. sqlite3_tokenizer *pTok;
  150353. };
  150354. /*
  150355. ** Virtual table cursor structure.
  150356. */
  150357. struct Fts3tokCursor {
  150358. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  150359. char *zInput; /* Input string */
  150360. sqlite3_tokenizer_cursor *pCsr; /* Cursor to iterate through zInput */
  150361. int iRowid; /* Current 'rowid' value */
  150362. const char *zToken; /* Current 'token' value */
  150363. int nToken; /* Size of zToken in bytes */
  150364. int iStart; /* Current 'start' value */
  150365. int iEnd; /* Current 'end' value */
  150366. int iPos; /* Current 'pos' value */
  150367. };
  150368. /*
  150369. ** Query FTS for the tokenizer implementation named zName.
  150370. */
  150371. static int fts3tokQueryTokenizer(
  150372. Fts3Hash *pHash,
  150373. const char *zName,
  150374. const sqlite3_tokenizer_module **pp,
  150375. char **pzErr
  150376. ){
  150377. sqlite3_tokenizer_module *p;
  150378. int nName = (int)strlen(zName);
  150379. p = (sqlite3_tokenizer_module *)sqlite3Fts3HashFind(pHash, zName, nName+1);
  150380. if( !p ){
  150381. sqlite3Fts3ErrMsg(pzErr, "unknown tokenizer: %s", zName);
  150382. return SQLITE_ERROR;
  150383. }
  150384. *pp = p;
  150385. return SQLITE_OK;
  150386. }
  150387. /*
  150388. ** The second argument, argv[], is an array of pointers to nul-terminated
  150389. ** strings. This function makes a copy of the array and strings into a
  150390. ** single block of memory. It then dequotes any of the strings that appear
  150391. ** to be quoted.
  150392. **
  150393. ** If successful, output parameter *pazDequote is set to point at the
  150394. ** array of dequoted strings and SQLITE_OK is returned. The caller is
  150395. ** responsible for eventually calling sqlite3_free() to free the array
  150396. ** in this case. Or, if an error occurs, an SQLite error code is returned.
  150397. ** The final value of *pazDequote is undefined in this case.
  150398. */
  150399. static int fts3tokDequoteArray(
  150400. int argc, /* Number of elements in argv[] */
  150401. const char * const *argv, /* Input array */
  150402. char ***pazDequote /* Output array */
  150403. ){
  150404. int rc = SQLITE_OK; /* Return code */
  150405. if( argc==0 ){
  150406. *pazDequote = 0;
  150407. }else{
  150408. int i;
  150409. int nByte = 0;
  150410. char **azDequote;
  150411. for(i=0; i<argc; i++){
  150412. nByte += (int)(strlen(argv[i]) + 1);
  150413. }
  150414. *pazDequote = azDequote = sqlite3_malloc(sizeof(char *)*argc + nByte);
  150415. if( azDequote==0 ){
  150416. rc = SQLITE_NOMEM;
  150417. }else{
  150418. char *pSpace = (char *)&azDequote[argc];
  150419. for(i=0; i<argc; i++){
  150420. int n = (int)strlen(argv[i]);
  150421. azDequote[i] = pSpace;
  150422. memcpy(pSpace, argv[i], n+1);
  150423. sqlite3Fts3Dequote(pSpace);
  150424. pSpace += (n+1);
  150425. }
  150426. }
  150427. }
  150428. return rc;
  150429. }
  150430. /*
  150431. ** Schema of the tokenizer table.
  150432. */
  150433. #define FTS3_TOK_SCHEMA "CREATE TABLE x(input, token, start, end, position)"
  150434. /*
  150435. ** This function does all the work for both the xConnect and xCreate methods.
  150436. ** These tables have no persistent representation of their own, so xConnect
  150437. ** and xCreate are identical operations.
  150438. **
  150439. ** argv[0]: module name
  150440. ** argv[1]: database name
  150441. ** argv[2]: table name
  150442. ** argv[3]: first argument (tokenizer name)
  150443. */
  150444. static int fts3tokConnectMethod(
  150445. sqlite3 *db, /* Database connection */
  150446. void *pHash, /* Hash table of tokenizers */
  150447. int argc, /* Number of elements in argv array */
  150448. const char * const *argv, /* xCreate/xConnect argument array */
  150449. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  150450. char **pzErr /* OUT: sqlite3_malloc'd error message */
  150451. ){
  150452. Fts3tokTable *pTab = 0;
  150453. const sqlite3_tokenizer_module *pMod = 0;
  150454. sqlite3_tokenizer *pTok = 0;
  150455. int rc;
  150456. char **azDequote = 0;
  150457. int nDequote;
  150458. rc = sqlite3_declare_vtab(db, FTS3_TOK_SCHEMA);
  150459. if( rc!=SQLITE_OK ) return rc;
  150460. nDequote = argc-3;
  150461. rc = fts3tokDequoteArray(nDequote, &argv[3], &azDequote);
  150462. if( rc==SQLITE_OK ){
  150463. const char *zModule;
  150464. if( nDequote<1 ){
  150465. zModule = "simple";
  150466. }else{
  150467. zModule = azDequote[0];
  150468. }
  150469. rc = fts3tokQueryTokenizer((Fts3Hash*)pHash, zModule, &pMod, pzErr);
  150470. }
  150471. assert( (rc==SQLITE_OK)==(pMod!=0) );
  150472. if( rc==SQLITE_OK ){
  150473. const char * const *azArg = (const char * const *)&azDequote[1];
  150474. rc = pMod->xCreate((nDequote>1 ? nDequote-1 : 0), azArg, &pTok);
  150475. }
  150476. if( rc==SQLITE_OK ){
  150477. pTab = (Fts3tokTable *)sqlite3_malloc(sizeof(Fts3tokTable));
  150478. if( pTab==0 ){
  150479. rc = SQLITE_NOMEM;
  150480. }
  150481. }
  150482. if( rc==SQLITE_OK ){
  150483. memset(pTab, 0, sizeof(Fts3tokTable));
  150484. pTab->pMod = pMod;
  150485. pTab->pTok = pTok;
  150486. *ppVtab = &pTab->base;
  150487. }else{
  150488. if( pTok ){
  150489. pMod->xDestroy(pTok);
  150490. }
  150491. }
  150492. sqlite3_free(azDequote);
  150493. return rc;
  150494. }
  150495. /*
  150496. ** This function does the work for both the xDisconnect and xDestroy methods.
  150497. ** These tables have no persistent representation of their own, so xDisconnect
  150498. ** and xDestroy are identical operations.
  150499. */
  150500. static int fts3tokDisconnectMethod(sqlite3_vtab *pVtab){
  150501. Fts3tokTable *pTab = (Fts3tokTable *)pVtab;
  150502. pTab->pMod->xDestroy(pTab->pTok);
  150503. sqlite3_free(pTab);
  150504. return SQLITE_OK;
  150505. }
  150506. /*
  150507. ** xBestIndex - Analyze a WHERE and ORDER BY clause.
  150508. */
  150509. static int fts3tokBestIndexMethod(
  150510. sqlite3_vtab *pVTab,
  150511. sqlite3_index_info *pInfo
  150512. ){
  150513. int i;
  150514. UNUSED_PARAMETER(pVTab);
  150515. for(i=0; i<pInfo->nConstraint; i++){
  150516. if( pInfo->aConstraint[i].usable
  150517. && pInfo->aConstraint[i].iColumn==0
  150518. && pInfo->aConstraint[i].op==SQLITE_INDEX_CONSTRAINT_EQ
  150519. ){
  150520. pInfo->idxNum = 1;
  150521. pInfo->aConstraintUsage[i].argvIndex = 1;
  150522. pInfo->aConstraintUsage[i].omit = 1;
  150523. pInfo->estimatedCost = 1;
  150524. return SQLITE_OK;
  150525. }
  150526. }
  150527. pInfo->idxNum = 0;
  150528. assert( pInfo->estimatedCost>1000000.0 );
  150529. return SQLITE_OK;
  150530. }
  150531. /*
  150532. ** xOpen - Open a cursor.
  150533. */
  150534. static int fts3tokOpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  150535. Fts3tokCursor *pCsr;
  150536. UNUSED_PARAMETER(pVTab);
  150537. pCsr = (Fts3tokCursor *)sqlite3_malloc(sizeof(Fts3tokCursor));
  150538. if( pCsr==0 ){
  150539. return SQLITE_NOMEM;
  150540. }
  150541. memset(pCsr, 0, sizeof(Fts3tokCursor));
  150542. *ppCsr = (sqlite3_vtab_cursor *)pCsr;
  150543. return SQLITE_OK;
  150544. }
  150545. /*
  150546. ** Reset the tokenizer cursor passed as the only argument. As if it had
  150547. ** just been returned by fts3tokOpenMethod().
  150548. */
  150549. static void fts3tokResetCursor(Fts3tokCursor *pCsr){
  150550. if( pCsr->pCsr ){
  150551. Fts3tokTable *pTab = (Fts3tokTable *)(pCsr->base.pVtab);
  150552. pTab->pMod->xClose(pCsr->pCsr);
  150553. pCsr->pCsr = 0;
  150554. }
  150555. sqlite3_free(pCsr->zInput);
  150556. pCsr->zInput = 0;
  150557. pCsr->zToken = 0;
  150558. pCsr->nToken = 0;
  150559. pCsr->iStart = 0;
  150560. pCsr->iEnd = 0;
  150561. pCsr->iPos = 0;
  150562. pCsr->iRowid = 0;
  150563. }
  150564. /*
  150565. ** xClose - Close a cursor.
  150566. */
  150567. static int fts3tokCloseMethod(sqlite3_vtab_cursor *pCursor){
  150568. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  150569. fts3tokResetCursor(pCsr);
  150570. sqlite3_free(pCsr);
  150571. return SQLITE_OK;
  150572. }
  150573. /*
  150574. ** xNext - Advance the cursor to the next row, if any.
  150575. */
  150576. static int fts3tokNextMethod(sqlite3_vtab_cursor *pCursor){
  150577. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  150578. Fts3tokTable *pTab = (Fts3tokTable *)(pCursor->pVtab);
  150579. int rc; /* Return code */
  150580. pCsr->iRowid++;
  150581. rc = pTab->pMod->xNext(pCsr->pCsr,
  150582. &pCsr->zToken, &pCsr->nToken,
  150583. &pCsr->iStart, &pCsr->iEnd, &pCsr->iPos
  150584. );
  150585. if( rc!=SQLITE_OK ){
  150586. fts3tokResetCursor(pCsr);
  150587. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  150588. }
  150589. return rc;
  150590. }
  150591. /*
  150592. ** xFilter - Initialize a cursor to point at the start of its data.
  150593. */
  150594. static int fts3tokFilterMethod(
  150595. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  150596. int idxNum, /* Strategy index */
  150597. const char *idxStr, /* Unused */
  150598. int nVal, /* Number of elements in apVal */
  150599. sqlite3_value **apVal /* Arguments for the indexing scheme */
  150600. ){
  150601. int rc = SQLITE_ERROR;
  150602. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  150603. Fts3tokTable *pTab = (Fts3tokTable *)(pCursor->pVtab);
  150604. UNUSED_PARAMETER(idxStr);
  150605. UNUSED_PARAMETER(nVal);
  150606. fts3tokResetCursor(pCsr);
  150607. if( idxNum==1 ){
  150608. const char *zByte = (const char *)sqlite3_value_text(apVal[0]);
  150609. int nByte = sqlite3_value_bytes(apVal[0]);
  150610. pCsr->zInput = sqlite3_malloc(nByte+1);
  150611. if( pCsr->zInput==0 ){
  150612. rc = SQLITE_NOMEM;
  150613. }else{
  150614. memcpy(pCsr->zInput, zByte, nByte);
  150615. pCsr->zInput[nByte] = 0;
  150616. rc = pTab->pMod->xOpen(pTab->pTok, pCsr->zInput, nByte, &pCsr->pCsr);
  150617. if( rc==SQLITE_OK ){
  150618. pCsr->pCsr->pTokenizer = pTab->pTok;
  150619. }
  150620. }
  150621. }
  150622. if( rc!=SQLITE_OK ) return rc;
  150623. return fts3tokNextMethod(pCursor);
  150624. }
  150625. /*
  150626. ** xEof - Return true if the cursor is at EOF, or false otherwise.
  150627. */
  150628. static int fts3tokEofMethod(sqlite3_vtab_cursor *pCursor){
  150629. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  150630. return (pCsr->zToken==0);
  150631. }
  150632. /*
  150633. ** xColumn - Return a column value.
  150634. */
  150635. static int fts3tokColumnMethod(
  150636. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  150637. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  150638. int iCol /* Index of column to read value from */
  150639. ){
  150640. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  150641. /* CREATE TABLE x(input, token, start, end, position) */
  150642. switch( iCol ){
  150643. case 0:
  150644. sqlite3_result_text(pCtx, pCsr->zInput, -1, SQLITE_TRANSIENT);
  150645. break;
  150646. case 1:
  150647. sqlite3_result_text(pCtx, pCsr->zToken, pCsr->nToken, SQLITE_TRANSIENT);
  150648. break;
  150649. case 2:
  150650. sqlite3_result_int(pCtx, pCsr->iStart);
  150651. break;
  150652. case 3:
  150653. sqlite3_result_int(pCtx, pCsr->iEnd);
  150654. break;
  150655. default:
  150656. assert( iCol==4 );
  150657. sqlite3_result_int(pCtx, pCsr->iPos);
  150658. break;
  150659. }
  150660. return SQLITE_OK;
  150661. }
  150662. /*
  150663. ** xRowid - Return the current rowid for the cursor.
  150664. */
  150665. static int fts3tokRowidMethod(
  150666. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  150667. sqlite_int64 *pRowid /* OUT: Rowid value */
  150668. ){
  150669. Fts3tokCursor *pCsr = (Fts3tokCursor *)pCursor;
  150670. *pRowid = (sqlite3_int64)pCsr->iRowid;
  150671. return SQLITE_OK;
  150672. }
  150673. /*
  150674. ** Register the fts3tok module with database connection db. Return SQLITE_OK
  150675. ** if successful or an error code if sqlite3_create_module() fails.
  150676. */
  150677. SQLITE_PRIVATE int sqlite3Fts3InitTok(sqlite3 *db, Fts3Hash *pHash){
  150678. static const sqlite3_module fts3tok_module = {
  150679. 0, /* iVersion */
  150680. fts3tokConnectMethod, /* xCreate */
  150681. fts3tokConnectMethod, /* xConnect */
  150682. fts3tokBestIndexMethod, /* xBestIndex */
  150683. fts3tokDisconnectMethod, /* xDisconnect */
  150684. fts3tokDisconnectMethod, /* xDestroy */
  150685. fts3tokOpenMethod, /* xOpen */
  150686. fts3tokCloseMethod, /* xClose */
  150687. fts3tokFilterMethod, /* xFilter */
  150688. fts3tokNextMethod, /* xNext */
  150689. fts3tokEofMethod, /* xEof */
  150690. fts3tokColumnMethod, /* xColumn */
  150691. fts3tokRowidMethod, /* xRowid */
  150692. 0, /* xUpdate */
  150693. 0, /* xBegin */
  150694. 0, /* xSync */
  150695. 0, /* xCommit */
  150696. 0, /* xRollback */
  150697. 0, /* xFindFunction */
  150698. 0, /* xRename */
  150699. 0, /* xSavepoint */
  150700. 0, /* xRelease */
  150701. 0 /* xRollbackTo */
  150702. };
  150703. int rc; /* Return code */
  150704. rc = sqlite3_create_module(db, "fts3tokenize", &fts3tok_module, (void*)pHash);
  150705. return rc;
  150706. }
  150707. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  150708. /************** End of fts3_tokenize_vtab.c **********************************/
  150709. /************** Begin file fts3_write.c **************************************/
  150710. /*
  150711. ** 2009 Oct 23
  150712. **
  150713. ** The author disclaims copyright to this source code. In place of
  150714. ** a legal notice, here is a blessing:
  150715. **
  150716. ** May you do good and not evil.
  150717. ** May you find forgiveness for yourself and forgive others.
  150718. ** May you share freely, never taking more than you give.
  150719. **
  150720. ******************************************************************************
  150721. **
  150722. ** This file is part of the SQLite FTS3 extension module. Specifically,
  150723. ** this file contains code to insert, update and delete rows from FTS3
  150724. ** tables. It also contains code to merge FTS3 b-tree segments. Some
  150725. ** of the sub-routines used to merge segments are also used by the query
  150726. ** code in fts3.c.
  150727. */
  150728. /* #include "fts3Int.h" */
  150729. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  150730. /* #include <string.h> */
  150731. /* #include <assert.h> */
  150732. /* #include <stdlib.h> */
  150733. #define FTS_MAX_APPENDABLE_HEIGHT 16
  150734. /*
  150735. ** When full-text index nodes are loaded from disk, the buffer that they
  150736. ** are loaded into has the following number of bytes of padding at the end
  150737. ** of it. i.e. if a full-text index node is 900 bytes in size, then a buffer
  150738. ** of 920 bytes is allocated for it.
  150739. **
  150740. ** This means that if we have a pointer into a buffer containing node data,
  150741. ** it is always safe to read up to two varints from it without risking an
  150742. ** overread, even if the node data is corrupted.
  150743. */
  150744. #define FTS3_NODE_PADDING (FTS3_VARINT_MAX*2)
  150745. /*
  150746. ** Under certain circumstances, b-tree nodes (doclists) can be loaded into
  150747. ** memory incrementally instead of all at once. This can be a big performance
  150748. ** win (reduced IO and CPU) if SQLite stops calling the virtual table xNext()
  150749. ** method before retrieving all query results (as may happen, for example,
  150750. ** if a query has a LIMIT clause).
  150751. **
  150752. ** Incremental loading is used for b-tree nodes FTS3_NODE_CHUNK_THRESHOLD
  150753. ** bytes and larger. Nodes are loaded in chunks of FTS3_NODE_CHUNKSIZE bytes.
  150754. ** The code is written so that the hard lower-limit for each of these values
  150755. ** is 1. Clearly such small values would be inefficient, but can be useful
  150756. ** for testing purposes.
  150757. **
  150758. ** If this module is built with SQLITE_TEST defined, these constants may
  150759. ** be overridden at runtime for testing purposes. File fts3_test.c contains
  150760. ** a Tcl interface to read and write the values.
  150761. */
  150762. #ifdef SQLITE_TEST
  150763. int test_fts3_node_chunksize = (4*1024);
  150764. int test_fts3_node_chunk_threshold = (4*1024)*4;
  150765. # define FTS3_NODE_CHUNKSIZE test_fts3_node_chunksize
  150766. # define FTS3_NODE_CHUNK_THRESHOLD test_fts3_node_chunk_threshold
  150767. #else
  150768. # define FTS3_NODE_CHUNKSIZE (4*1024)
  150769. # define FTS3_NODE_CHUNK_THRESHOLD (FTS3_NODE_CHUNKSIZE*4)
  150770. #endif
  150771. /*
  150772. ** The two values that may be meaningfully bound to the :1 parameter in
  150773. ** statements SQL_REPLACE_STAT and SQL_SELECT_STAT.
  150774. */
  150775. #define FTS_STAT_DOCTOTAL 0
  150776. #define FTS_STAT_INCRMERGEHINT 1
  150777. #define FTS_STAT_AUTOINCRMERGE 2
  150778. /*
  150779. ** If FTS_LOG_MERGES is defined, call sqlite3_log() to report each automatic
  150780. ** and incremental merge operation that takes place. This is used for
  150781. ** debugging FTS only, it should not usually be turned on in production
  150782. ** systems.
  150783. */
  150784. #ifdef FTS3_LOG_MERGES
  150785. static void fts3LogMerge(int nMerge, sqlite3_int64 iAbsLevel){
  150786. sqlite3_log(SQLITE_OK, "%d-way merge from level %d", nMerge, (int)iAbsLevel);
  150787. }
  150788. #else
  150789. #define fts3LogMerge(x, y)
  150790. #endif
  150791. typedef struct PendingList PendingList;
  150792. typedef struct SegmentNode SegmentNode;
  150793. typedef struct SegmentWriter SegmentWriter;
  150794. /*
  150795. ** An instance of the following data structure is used to build doclists
  150796. ** incrementally. See function fts3PendingListAppend() for details.
  150797. */
  150798. struct PendingList {
  150799. int nData;
  150800. char *aData;
  150801. int nSpace;
  150802. sqlite3_int64 iLastDocid;
  150803. sqlite3_int64 iLastCol;
  150804. sqlite3_int64 iLastPos;
  150805. };
  150806. /*
  150807. ** Each cursor has a (possibly empty) linked list of the following objects.
  150808. */
  150809. struct Fts3DeferredToken {
  150810. Fts3PhraseToken *pToken; /* Pointer to corresponding expr token */
  150811. int iCol; /* Column token must occur in */
  150812. Fts3DeferredToken *pNext; /* Next in list of deferred tokens */
  150813. PendingList *pList; /* Doclist is assembled here */
  150814. };
  150815. /*
  150816. ** An instance of this structure is used to iterate through the terms on
  150817. ** a contiguous set of segment b-tree leaf nodes. Although the details of
  150818. ** this structure are only manipulated by code in this file, opaque handles
  150819. ** of type Fts3SegReader* are also used by code in fts3.c to iterate through
  150820. ** terms when querying the full-text index. See functions:
  150821. **
  150822. ** sqlite3Fts3SegReaderNew()
  150823. ** sqlite3Fts3SegReaderFree()
  150824. ** sqlite3Fts3SegReaderIterate()
  150825. **
  150826. ** Methods used to manipulate Fts3SegReader structures:
  150827. **
  150828. ** fts3SegReaderNext()
  150829. ** fts3SegReaderFirstDocid()
  150830. ** fts3SegReaderNextDocid()
  150831. */
  150832. struct Fts3SegReader {
  150833. int iIdx; /* Index within level, or 0x7FFFFFFF for PT */
  150834. u8 bLookup; /* True for a lookup only */
  150835. u8 rootOnly; /* True for a root-only reader */
  150836. sqlite3_int64 iStartBlock; /* Rowid of first leaf block to traverse */
  150837. sqlite3_int64 iLeafEndBlock; /* Rowid of final leaf block to traverse */
  150838. sqlite3_int64 iEndBlock; /* Rowid of final block in segment (or 0) */
  150839. sqlite3_int64 iCurrentBlock; /* Current leaf block (or 0) */
  150840. char *aNode; /* Pointer to node data (or NULL) */
  150841. int nNode; /* Size of buffer at aNode (or 0) */
  150842. int nPopulate; /* If >0, bytes of buffer aNode[] loaded */
  150843. sqlite3_blob *pBlob; /* If not NULL, blob handle to read node */
  150844. Fts3HashElem **ppNextElem;
  150845. /* Variables set by fts3SegReaderNext(). These may be read directly
  150846. ** by the caller. They are valid from the time SegmentReaderNew() returns
  150847. ** until SegmentReaderNext() returns something other than SQLITE_OK
  150848. ** (i.e. SQLITE_DONE).
  150849. */
  150850. int nTerm; /* Number of bytes in current term */
  150851. char *zTerm; /* Pointer to current term */
  150852. int nTermAlloc; /* Allocated size of zTerm buffer */
  150853. char *aDoclist; /* Pointer to doclist of current entry */
  150854. int nDoclist; /* Size of doclist in current entry */
  150855. /* The following variables are used by fts3SegReaderNextDocid() to iterate
  150856. ** through the current doclist (aDoclist/nDoclist).
  150857. */
  150858. char *pOffsetList;
  150859. int nOffsetList; /* For descending pending seg-readers only */
  150860. sqlite3_int64 iDocid;
  150861. };
  150862. #define fts3SegReaderIsPending(p) ((p)->ppNextElem!=0)
  150863. #define fts3SegReaderIsRootOnly(p) ((p)->rootOnly!=0)
  150864. /*
  150865. ** An instance of this structure is used to create a segment b-tree in the
  150866. ** database. The internal details of this type are only accessed by the
  150867. ** following functions:
  150868. **
  150869. ** fts3SegWriterAdd()
  150870. ** fts3SegWriterFlush()
  150871. ** fts3SegWriterFree()
  150872. */
  150873. struct SegmentWriter {
  150874. SegmentNode *pTree; /* Pointer to interior tree structure */
  150875. sqlite3_int64 iFirst; /* First slot in %_segments written */
  150876. sqlite3_int64 iFree; /* Next free slot in %_segments */
  150877. char *zTerm; /* Pointer to previous term buffer */
  150878. int nTerm; /* Number of bytes in zTerm */
  150879. int nMalloc; /* Size of malloc'd buffer at zMalloc */
  150880. char *zMalloc; /* Malloc'd space (possibly) used for zTerm */
  150881. int nSize; /* Size of allocation at aData */
  150882. int nData; /* Bytes of data in aData */
  150883. char *aData; /* Pointer to block from malloc() */
  150884. i64 nLeafData; /* Number of bytes of leaf data written */
  150885. };
  150886. /*
  150887. ** Type SegmentNode is used by the following three functions to create
  150888. ** the interior part of the segment b+-tree structures (everything except
  150889. ** the leaf nodes). These functions and type are only ever used by code
  150890. ** within the fts3SegWriterXXX() family of functions described above.
  150891. **
  150892. ** fts3NodeAddTerm()
  150893. ** fts3NodeWrite()
  150894. ** fts3NodeFree()
  150895. **
  150896. ** When a b+tree is written to the database (either as a result of a merge
  150897. ** or the pending-terms table being flushed), leaves are written into the
  150898. ** database file as soon as they are completely populated. The interior of
  150899. ** the tree is assembled in memory and written out only once all leaves have
  150900. ** been populated and stored. This is Ok, as the b+-tree fanout is usually
  150901. ** very large, meaning that the interior of the tree consumes relatively
  150902. ** little memory.
  150903. */
  150904. struct SegmentNode {
  150905. SegmentNode *pParent; /* Parent node (or NULL for root node) */
  150906. SegmentNode *pRight; /* Pointer to right-sibling */
  150907. SegmentNode *pLeftmost; /* Pointer to left-most node of this depth */
  150908. int nEntry; /* Number of terms written to node so far */
  150909. char *zTerm; /* Pointer to previous term buffer */
  150910. int nTerm; /* Number of bytes in zTerm */
  150911. int nMalloc; /* Size of malloc'd buffer at zMalloc */
  150912. char *zMalloc; /* Malloc'd space (possibly) used for zTerm */
  150913. int nData; /* Bytes of valid data so far */
  150914. char *aData; /* Node data */
  150915. };
  150916. /*
  150917. ** Valid values for the second argument to fts3SqlStmt().
  150918. */
  150919. #define SQL_DELETE_CONTENT 0
  150920. #define SQL_IS_EMPTY 1
  150921. #define SQL_DELETE_ALL_CONTENT 2
  150922. #define SQL_DELETE_ALL_SEGMENTS 3
  150923. #define SQL_DELETE_ALL_SEGDIR 4
  150924. #define SQL_DELETE_ALL_DOCSIZE 5
  150925. #define SQL_DELETE_ALL_STAT 6
  150926. #define SQL_SELECT_CONTENT_BY_ROWID 7
  150927. #define SQL_NEXT_SEGMENT_INDEX 8
  150928. #define SQL_INSERT_SEGMENTS 9
  150929. #define SQL_NEXT_SEGMENTS_ID 10
  150930. #define SQL_INSERT_SEGDIR 11
  150931. #define SQL_SELECT_LEVEL 12
  150932. #define SQL_SELECT_LEVEL_RANGE 13
  150933. #define SQL_SELECT_LEVEL_COUNT 14
  150934. #define SQL_SELECT_SEGDIR_MAX_LEVEL 15
  150935. #define SQL_DELETE_SEGDIR_LEVEL 16
  150936. #define SQL_DELETE_SEGMENTS_RANGE 17
  150937. #define SQL_CONTENT_INSERT 18
  150938. #define SQL_DELETE_DOCSIZE 19
  150939. #define SQL_REPLACE_DOCSIZE 20
  150940. #define SQL_SELECT_DOCSIZE 21
  150941. #define SQL_SELECT_STAT 22
  150942. #define SQL_REPLACE_STAT 23
  150943. #define SQL_SELECT_ALL_PREFIX_LEVEL 24
  150944. #define SQL_DELETE_ALL_TERMS_SEGDIR 25
  150945. #define SQL_DELETE_SEGDIR_RANGE 26
  150946. #define SQL_SELECT_ALL_LANGID 27
  150947. #define SQL_FIND_MERGE_LEVEL 28
  150948. #define SQL_MAX_LEAF_NODE_ESTIMATE 29
  150949. #define SQL_DELETE_SEGDIR_ENTRY 30
  150950. #define SQL_SHIFT_SEGDIR_ENTRY 31
  150951. #define SQL_SELECT_SEGDIR 32
  150952. #define SQL_CHOMP_SEGDIR 33
  150953. #define SQL_SEGMENT_IS_APPENDABLE 34
  150954. #define SQL_SELECT_INDEXES 35
  150955. #define SQL_SELECT_MXLEVEL 36
  150956. #define SQL_SELECT_LEVEL_RANGE2 37
  150957. #define SQL_UPDATE_LEVEL_IDX 38
  150958. #define SQL_UPDATE_LEVEL 39
  150959. /*
  150960. ** This function is used to obtain an SQLite prepared statement handle
  150961. ** for the statement identified by the second argument. If successful,
  150962. ** *pp is set to the requested statement handle and SQLITE_OK returned.
  150963. ** Otherwise, an SQLite error code is returned and *pp is set to 0.
  150964. **
  150965. ** If argument apVal is not NULL, then it must point to an array with
  150966. ** at least as many entries as the requested statement has bound
  150967. ** parameters. The values are bound to the statements parameters before
  150968. ** returning.
  150969. */
  150970. static int fts3SqlStmt(
  150971. Fts3Table *p, /* Virtual table handle */
  150972. int eStmt, /* One of the SQL_XXX constants above */
  150973. sqlite3_stmt **pp, /* OUT: Statement handle */
  150974. sqlite3_value **apVal /* Values to bind to statement */
  150975. ){
  150976. const char *azSql[] = {
  150977. /* 0 */ "DELETE FROM %Q.'%q_content' WHERE rowid = ?",
  150978. /* 1 */ "SELECT NOT EXISTS(SELECT docid FROM %Q.'%q_content' WHERE rowid!=?)",
  150979. /* 2 */ "DELETE FROM %Q.'%q_content'",
  150980. /* 3 */ "DELETE FROM %Q.'%q_segments'",
  150981. /* 4 */ "DELETE FROM %Q.'%q_segdir'",
  150982. /* 5 */ "DELETE FROM %Q.'%q_docsize'",
  150983. /* 6 */ "DELETE FROM %Q.'%q_stat'",
  150984. /* 7 */ "SELECT %s WHERE rowid=?",
  150985. /* 8 */ "SELECT (SELECT max(idx) FROM %Q.'%q_segdir' WHERE level = ?) + 1",
  150986. /* 9 */ "REPLACE INTO %Q.'%q_segments'(blockid, block) VALUES(?, ?)",
  150987. /* 10 */ "SELECT coalesce((SELECT max(blockid) FROM %Q.'%q_segments') + 1, 1)",
  150988. /* 11 */ "REPLACE INTO %Q.'%q_segdir' VALUES(?,?,?,?,?,?)",
  150989. /* Return segments in order from oldest to newest.*/
  150990. /* 12 */ "SELECT idx, start_block, leaves_end_block, end_block, root "
  150991. "FROM %Q.'%q_segdir' WHERE level = ? ORDER BY idx ASC",
  150992. /* 13 */ "SELECT idx, start_block, leaves_end_block, end_block, root "
  150993. "FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?"
  150994. "ORDER BY level DESC, idx ASC",
  150995. /* 14 */ "SELECT count(*) FROM %Q.'%q_segdir' WHERE level = ?",
  150996. /* 15 */ "SELECT max(level) FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?",
  150997. /* 16 */ "DELETE FROM %Q.'%q_segdir' WHERE level = ?",
  150998. /* 17 */ "DELETE FROM %Q.'%q_segments' WHERE blockid BETWEEN ? AND ?",
  150999. /* 18 */ "INSERT INTO %Q.'%q_content' VALUES(%s)",
  151000. /* 19 */ "DELETE FROM %Q.'%q_docsize' WHERE docid = ?",
  151001. /* 20 */ "REPLACE INTO %Q.'%q_docsize' VALUES(?,?)",
  151002. /* 21 */ "SELECT size FROM %Q.'%q_docsize' WHERE docid=?",
  151003. /* 22 */ "SELECT value FROM %Q.'%q_stat' WHERE id=?",
  151004. /* 23 */ "REPLACE INTO %Q.'%q_stat' VALUES(?,?)",
  151005. /* 24 */ "",
  151006. /* 25 */ "",
  151007. /* 26 */ "DELETE FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?",
  151008. /* 27 */ "SELECT ? UNION SELECT level / (1024 * ?) FROM %Q.'%q_segdir'",
  151009. /* This statement is used to determine which level to read the input from
  151010. ** when performing an incremental merge. It returns the absolute level number
  151011. ** of the oldest level in the db that contains at least ? segments. Or,
  151012. ** if no level in the FTS index contains more than ? segments, the statement
  151013. ** returns zero rows. */
  151014. /* 28 */ "SELECT level, count(*) AS cnt FROM %Q.'%q_segdir' "
  151015. " GROUP BY level HAVING cnt>=?"
  151016. " ORDER BY (level %% 1024) ASC LIMIT 1",
  151017. /* Estimate the upper limit on the number of leaf nodes in a new segment
  151018. ** created by merging the oldest :2 segments from absolute level :1. See
  151019. ** function sqlite3Fts3Incrmerge() for details. */
  151020. /* 29 */ "SELECT 2 * total(1 + leaves_end_block - start_block) "
  151021. " FROM %Q.'%q_segdir' WHERE level = ? AND idx < ?",
  151022. /* SQL_DELETE_SEGDIR_ENTRY
  151023. ** Delete the %_segdir entry on absolute level :1 with index :2. */
  151024. /* 30 */ "DELETE FROM %Q.'%q_segdir' WHERE level = ? AND idx = ?",
  151025. /* SQL_SHIFT_SEGDIR_ENTRY
  151026. ** Modify the idx value for the segment with idx=:3 on absolute level :2
  151027. ** to :1. */
  151028. /* 31 */ "UPDATE %Q.'%q_segdir' SET idx = ? WHERE level=? AND idx=?",
  151029. /* SQL_SELECT_SEGDIR
  151030. ** Read a single entry from the %_segdir table. The entry from absolute
  151031. ** level :1 with index value :2. */
  151032. /* 32 */ "SELECT idx, start_block, leaves_end_block, end_block, root "
  151033. "FROM %Q.'%q_segdir' WHERE level = ? AND idx = ?",
  151034. /* SQL_CHOMP_SEGDIR
  151035. ** Update the start_block (:1) and root (:2) fields of the %_segdir
  151036. ** entry located on absolute level :3 with index :4. */
  151037. /* 33 */ "UPDATE %Q.'%q_segdir' SET start_block = ?, root = ?"
  151038. "WHERE level = ? AND idx = ?",
  151039. /* SQL_SEGMENT_IS_APPENDABLE
  151040. ** Return a single row if the segment with end_block=? is appendable. Or
  151041. ** no rows otherwise. */
  151042. /* 34 */ "SELECT 1 FROM %Q.'%q_segments' WHERE blockid=? AND block IS NULL",
  151043. /* SQL_SELECT_INDEXES
  151044. ** Return the list of valid segment indexes for absolute level ? */
  151045. /* 35 */ "SELECT idx FROM %Q.'%q_segdir' WHERE level=? ORDER BY 1 ASC",
  151046. /* SQL_SELECT_MXLEVEL
  151047. ** Return the largest relative level in the FTS index or indexes. */
  151048. /* 36 */ "SELECT max( level %% 1024 ) FROM %Q.'%q_segdir'",
  151049. /* Return segments in order from oldest to newest.*/
  151050. /* 37 */ "SELECT level, idx, end_block "
  151051. "FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ? "
  151052. "ORDER BY level DESC, idx ASC",
  151053. /* Update statements used while promoting segments */
  151054. /* 38 */ "UPDATE OR FAIL %Q.'%q_segdir' SET level=-1,idx=? "
  151055. "WHERE level=? AND idx=?",
  151056. /* 39 */ "UPDATE OR FAIL %Q.'%q_segdir' SET level=? WHERE level=-1"
  151057. };
  151058. int rc = SQLITE_OK;
  151059. sqlite3_stmt *pStmt;
  151060. assert( SizeofArray(azSql)==SizeofArray(p->aStmt) );
  151061. assert( eStmt<SizeofArray(azSql) && eStmt>=0 );
  151062. pStmt = p->aStmt[eStmt];
  151063. if( !pStmt ){
  151064. char *zSql;
  151065. if( eStmt==SQL_CONTENT_INSERT ){
  151066. zSql = sqlite3_mprintf(azSql[eStmt], p->zDb, p->zName, p->zWriteExprlist);
  151067. }else if( eStmt==SQL_SELECT_CONTENT_BY_ROWID ){
  151068. zSql = sqlite3_mprintf(azSql[eStmt], p->zReadExprlist);
  151069. }else{
  151070. zSql = sqlite3_mprintf(azSql[eStmt], p->zDb, p->zName);
  151071. }
  151072. if( !zSql ){
  151073. rc = SQLITE_NOMEM;
  151074. }else{
  151075. rc = sqlite3_prepare_v3(p->db, zSql, -1, SQLITE_PREPARE_PERSISTENT,
  151076. &pStmt, NULL);
  151077. sqlite3_free(zSql);
  151078. assert( rc==SQLITE_OK || pStmt==0 );
  151079. p->aStmt[eStmt] = pStmt;
  151080. }
  151081. }
  151082. if( apVal ){
  151083. int i;
  151084. int nParam = sqlite3_bind_parameter_count(pStmt);
  151085. for(i=0; rc==SQLITE_OK && i<nParam; i++){
  151086. rc = sqlite3_bind_value(pStmt, i+1, apVal[i]);
  151087. }
  151088. }
  151089. *pp = pStmt;
  151090. return rc;
  151091. }
  151092. static int fts3SelectDocsize(
  151093. Fts3Table *pTab, /* FTS3 table handle */
  151094. sqlite3_int64 iDocid, /* Docid to bind for SQL_SELECT_DOCSIZE */
  151095. sqlite3_stmt **ppStmt /* OUT: Statement handle */
  151096. ){
  151097. sqlite3_stmt *pStmt = 0; /* Statement requested from fts3SqlStmt() */
  151098. int rc; /* Return code */
  151099. rc = fts3SqlStmt(pTab, SQL_SELECT_DOCSIZE, &pStmt, 0);
  151100. if( rc==SQLITE_OK ){
  151101. sqlite3_bind_int64(pStmt, 1, iDocid);
  151102. rc = sqlite3_step(pStmt);
  151103. if( rc!=SQLITE_ROW || sqlite3_column_type(pStmt, 0)!=SQLITE_BLOB ){
  151104. rc = sqlite3_reset(pStmt);
  151105. if( rc==SQLITE_OK ) rc = FTS_CORRUPT_VTAB;
  151106. pStmt = 0;
  151107. }else{
  151108. rc = SQLITE_OK;
  151109. }
  151110. }
  151111. *ppStmt = pStmt;
  151112. return rc;
  151113. }
  151114. SQLITE_PRIVATE int sqlite3Fts3SelectDoctotal(
  151115. Fts3Table *pTab, /* Fts3 table handle */
  151116. sqlite3_stmt **ppStmt /* OUT: Statement handle */
  151117. ){
  151118. sqlite3_stmt *pStmt = 0;
  151119. int rc;
  151120. rc = fts3SqlStmt(pTab, SQL_SELECT_STAT, &pStmt, 0);
  151121. if( rc==SQLITE_OK ){
  151122. sqlite3_bind_int(pStmt, 1, FTS_STAT_DOCTOTAL);
  151123. if( sqlite3_step(pStmt)!=SQLITE_ROW
  151124. || sqlite3_column_type(pStmt, 0)!=SQLITE_BLOB
  151125. ){
  151126. rc = sqlite3_reset(pStmt);
  151127. if( rc==SQLITE_OK ) rc = FTS_CORRUPT_VTAB;
  151128. pStmt = 0;
  151129. }
  151130. }
  151131. *ppStmt = pStmt;
  151132. return rc;
  151133. }
  151134. SQLITE_PRIVATE int sqlite3Fts3SelectDocsize(
  151135. Fts3Table *pTab, /* Fts3 table handle */
  151136. sqlite3_int64 iDocid, /* Docid to read size data for */
  151137. sqlite3_stmt **ppStmt /* OUT: Statement handle */
  151138. ){
  151139. return fts3SelectDocsize(pTab, iDocid, ppStmt);
  151140. }
  151141. /*
  151142. ** Similar to fts3SqlStmt(). Except, after binding the parameters in
  151143. ** array apVal[] to the SQL statement identified by eStmt, the statement
  151144. ** is executed.
  151145. **
  151146. ** Returns SQLITE_OK if the statement is successfully executed, or an
  151147. ** SQLite error code otherwise.
  151148. */
  151149. static void fts3SqlExec(
  151150. int *pRC, /* Result code */
  151151. Fts3Table *p, /* The FTS3 table */
  151152. int eStmt, /* Index of statement to evaluate */
  151153. sqlite3_value **apVal /* Parameters to bind */
  151154. ){
  151155. sqlite3_stmt *pStmt;
  151156. int rc;
  151157. if( *pRC ) return;
  151158. rc = fts3SqlStmt(p, eStmt, &pStmt, apVal);
  151159. if( rc==SQLITE_OK ){
  151160. sqlite3_step(pStmt);
  151161. rc = sqlite3_reset(pStmt);
  151162. }
  151163. *pRC = rc;
  151164. }
  151165. /*
  151166. ** This function ensures that the caller has obtained an exclusive
  151167. ** shared-cache table-lock on the %_segdir table. This is required before
  151168. ** writing data to the fts3 table. If this lock is not acquired first, then
  151169. ** the caller may end up attempting to take this lock as part of committing
  151170. ** a transaction, causing SQLite to return SQLITE_LOCKED or
  151171. ** LOCKED_SHAREDCACHEto a COMMIT command.
  151172. **
  151173. ** It is best to avoid this because if FTS3 returns any error when
  151174. ** committing a transaction, the whole transaction will be rolled back.
  151175. ** And this is not what users expect when they get SQLITE_LOCKED_SHAREDCACHE.
  151176. ** It can still happen if the user locks the underlying tables directly
  151177. ** instead of accessing them via FTS.
  151178. */
  151179. static int fts3Writelock(Fts3Table *p){
  151180. int rc = SQLITE_OK;
  151181. if( p->nPendingData==0 ){
  151182. sqlite3_stmt *pStmt;
  151183. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_LEVEL, &pStmt, 0);
  151184. if( rc==SQLITE_OK ){
  151185. sqlite3_bind_null(pStmt, 1);
  151186. sqlite3_step(pStmt);
  151187. rc = sqlite3_reset(pStmt);
  151188. }
  151189. }
  151190. return rc;
  151191. }
  151192. /*
  151193. ** FTS maintains a separate indexes for each language-id (a 32-bit integer).
  151194. ** Within each language id, a separate index is maintained to store the
  151195. ** document terms, and each configured prefix size (configured the FTS
  151196. ** "prefix=" option). And each index consists of multiple levels ("relative
  151197. ** levels").
  151198. **
  151199. ** All three of these values (the language id, the specific index and the
  151200. ** level within the index) are encoded in 64-bit integer values stored
  151201. ** in the %_segdir table on disk. This function is used to convert three
  151202. ** separate component values into the single 64-bit integer value that
  151203. ** can be used to query the %_segdir table.
  151204. **
  151205. ** Specifically, each language-id/index combination is allocated 1024
  151206. ** 64-bit integer level values ("absolute levels"). The main terms index
  151207. ** for language-id 0 is allocate values 0-1023. The first prefix index
  151208. ** (if any) for language-id 0 is allocated values 1024-2047. And so on.
  151209. ** Language 1 indexes are allocated immediately following language 0.
  151210. **
  151211. ** So, for a system with nPrefix prefix indexes configured, the block of
  151212. ** absolute levels that corresponds to language-id iLangid and index
  151213. ** iIndex starts at absolute level ((iLangid * (nPrefix+1) + iIndex) * 1024).
  151214. */
  151215. static sqlite3_int64 getAbsoluteLevel(
  151216. Fts3Table *p, /* FTS3 table handle */
  151217. int iLangid, /* Language id */
  151218. int iIndex, /* Index in p->aIndex[] */
  151219. int iLevel /* Level of segments */
  151220. ){
  151221. sqlite3_int64 iBase; /* First absolute level for iLangid/iIndex */
  151222. assert( iLangid>=0 );
  151223. assert( p->nIndex>0 );
  151224. assert( iIndex>=0 && iIndex<p->nIndex );
  151225. iBase = ((sqlite3_int64)iLangid * p->nIndex + iIndex) * FTS3_SEGDIR_MAXLEVEL;
  151226. return iBase + iLevel;
  151227. }
  151228. /*
  151229. ** Set *ppStmt to a statement handle that may be used to iterate through
  151230. ** all rows in the %_segdir table, from oldest to newest. If successful,
  151231. ** return SQLITE_OK. If an error occurs while preparing the statement,
  151232. ** return an SQLite error code.
  151233. **
  151234. ** There is only ever one instance of this SQL statement compiled for
  151235. ** each FTS3 table.
  151236. **
  151237. ** The statement returns the following columns from the %_segdir table:
  151238. **
  151239. ** 0: idx
  151240. ** 1: start_block
  151241. ** 2: leaves_end_block
  151242. ** 3: end_block
  151243. ** 4: root
  151244. */
  151245. SQLITE_PRIVATE int sqlite3Fts3AllSegdirs(
  151246. Fts3Table *p, /* FTS3 table */
  151247. int iLangid, /* Language being queried */
  151248. int iIndex, /* Index for p->aIndex[] */
  151249. int iLevel, /* Level to select (relative level) */
  151250. sqlite3_stmt **ppStmt /* OUT: Compiled statement */
  151251. ){
  151252. int rc;
  151253. sqlite3_stmt *pStmt = 0;
  151254. assert( iLevel==FTS3_SEGCURSOR_ALL || iLevel>=0 );
  151255. assert( iLevel<FTS3_SEGDIR_MAXLEVEL );
  151256. assert( iIndex>=0 && iIndex<p->nIndex );
  151257. if( iLevel<0 ){
  151258. /* "SELECT * FROM %_segdir WHERE level BETWEEN ? AND ? ORDER BY ..." */
  151259. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL_RANGE, &pStmt, 0);
  151260. if( rc==SQLITE_OK ){
  151261. sqlite3_bind_int64(pStmt, 1, getAbsoluteLevel(p, iLangid, iIndex, 0));
  151262. sqlite3_bind_int64(pStmt, 2,
  151263. getAbsoluteLevel(p, iLangid, iIndex, FTS3_SEGDIR_MAXLEVEL-1)
  151264. );
  151265. }
  151266. }else{
  151267. /* "SELECT * FROM %_segdir WHERE level = ? ORDER BY ..." */
  151268. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL, &pStmt, 0);
  151269. if( rc==SQLITE_OK ){
  151270. sqlite3_bind_int64(pStmt, 1, getAbsoluteLevel(p, iLangid, iIndex,iLevel));
  151271. }
  151272. }
  151273. *ppStmt = pStmt;
  151274. return rc;
  151275. }
  151276. /*
  151277. ** Append a single varint to a PendingList buffer. SQLITE_OK is returned
  151278. ** if successful, or an SQLite error code otherwise.
  151279. **
  151280. ** This function also serves to allocate the PendingList structure itself.
  151281. ** For example, to create a new PendingList structure containing two
  151282. ** varints:
  151283. **
  151284. ** PendingList *p = 0;
  151285. ** fts3PendingListAppendVarint(&p, 1);
  151286. ** fts3PendingListAppendVarint(&p, 2);
  151287. */
  151288. static int fts3PendingListAppendVarint(
  151289. PendingList **pp, /* IN/OUT: Pointer to PendingList struct */
  151290. sqlite3_int64 i /* Value to append to data */
  151291. ){
  151292. PendingList *p = *pp;
  151293. /* Allocate or grow the PendingList as required. */
  151294. if( !p ){
  151295. p = sqlite3_malloc(sizeof(*p) + 100);
  151296. if( !p ){
  151297. return SQLITE_NOMEM;
  151298. }
  151299. p->nSpace = 100;
  151300. p->aData = (char *)&p[1];
  151301. p->nData = 0;
  151302. }
  151303. else if( p->nData+FTS3_VARINT_MAX+1>p->nSpace ){
  151304. int nNew = p->nSpace * 2;
  151305. p = sqlite3_realloc(p, sizeof(*p) + nNew);
  151306. if( !p ){
  151307. sqlite3_free(*pp);
  151308. *pp = 0;
  151309. return SQLITE_NOMEM;
  151310. }
  151311. p->nSpace = nNew;
  151312. p->aData = (char *)&p[1];
  151313. }
  151314. /* Append the new serialized varint to the end of the list. */
  151315. p->nData += sqlite3Fts3PutVarint(&p->aData[p->nData], i);
  151316. p->aData[p->nData] = '\0';
  151317. *pp = p;
  151318. return SQLITE_OK;
  151319. }
  151320. /*
  151321. ** Add a docid/column/position entry to a PendingList structure. Non-zero
  151322. ** is returned if the structure is sqlite3_realloced as part of adding
  151323. ** the entry. Otherwise, zero.
  151324. **
  151325. ** If an OOM error occurs, *pRc is set to SQLITE_NOMEM before returning.
  151326. ** Zero is always returned in this case. Otherwise, if no OOM error occurs,
  151327. ** it is set to SQLITE_OK.
  151328. */
  151329. static int fts3PendingListAppend(
  151330. PendingList **pp, /* IN/OUT: PendingList structure */
  151331. sqlite3_int64 iDocid, /* Docid for entry to add */
  151332. sqlite3_int64 iCol, /* Column for entry to add */
  151333. sqlite3_int64 iPos, /* Position of term for entry to add */
  151334. int *pRc /* OUT: Return code */
  151335. ){
  151336. PendingList *p = *pp;
  151337. int rc = SQLITE_OK;
  151338. assert( !p || p->iLastDocid<=iDocid );
  151339. if( !p || p->iLastDocid!=iDocid ){
  151340. sqlite3_int64 iDelta = iDocid - (p ? p->iLastDocid : 0);
  151341. if( p ){
  151342. assert( p->nData<p->nSpace );
  151343. assert( p->aData[p->nData]==0 );
  151344. p->nData++;
  151345. }
  151346. if( SQLITE_OK!=(rc = fts3PendingListAppendVarint(&p, iDelta)) ){
  151347. goto pendinglistappend_out;
  151348. }
  151349. p->iLastCol = -1;
  151350. p->iLastPos = 0;
  151351. p->iLastDocid = iDocid;
  151352. }
  151353. if( iCol>0 && p->iLastCol!=iCol ){
  151354. if( SQLITE_OK!=(rc = fts3PendingListAppendVarint(&p, 1))
  151355. || SQLITE_OK!=(rc = fts3PendingListAppendVarint(&p, iCol))
  151356. ){
  151357. goto pendinglistappend_out;
  151358. }
  151359. p->iLastCol = iCol;
  151360. p->iLastPos = 0;
  151361. }
  151362. if( iCol>=0 ){
  151363. assert( iPos>p->iLastPos || (iPos==0 && p->iLastPos==0) );
  151364. rc = fts3PendingListAppendVarint(&p, 2+iPos-p->iLastPos);
  151365. if( rc==SQLITE_OK ){
  151366. p->iLastPos = iPos;
  151367. }
  151368. }
  151369. pendinglistappend_out:
  151370. *pRc = rc;
  151371. if( p!=*pp ){
  151372. *pp = p;
  151373. return 1;
  151374. }
  151375. return 0;
  151376. }
  151377. /*
  151378. ** Free a PendingList object allocated by fts3PendingListAppend().
  151379. */
  151380. static void fts3PendingListDelete(PendingList *pList){
  151381. sqlite3_free(pList);
  151382. }
  151383. /*
  151384. ** Add an entry to one of the pending-terms hash tables.
  151385. */
  151386. static int fts3PendingTermsAddOne(
  151387. Fts3Table *p,
  151388. int iCol,
  151389. int iPos,
  151390. Fts3Hash *pHash, /* Pending terms hash table to add entry to */
  151391. const char *zToken,
  151392. int nToken
  151393. ){
  151394. PendingList *pList;
  151395. int rc = SQLITE_OK;
  151396. pList = (PendingList *)fts3HashFind(pHash, zToken, nToken);
  151397. if( pList ){
  151398. p->nPendingData -= (pList->nData + nToken + sizeof(Fts3HashElem));
  151399. }
  151400. if( fts3PendingListAppend(&pList, p->iPrevDocid, iCol, iPos, &rc) ){
  151401. if( pList==fts3HashInsert(pHash, zToken, nToken, pList) ){
  151402. /* Malloc failed while inserting the new entry. This can only
  151403. ** happen if there was no previous entry for this token.
  151404. */
  151405. assert( 0==fts3HashFind(pHash, zToken, nToken) );
  151406. sqlite3_free(pList);
  151407. rc = SQLITE_NOMEM;
  151408. }
  151409. }
  151410. if( rc==SQLITE_OK ){
  151411. p->nPendingData += (pList->nData + nToken + sizeof(Fts3HashElem));
  151412. }
  151413. return rc;
  151414. }
  151415. /*
  151416. ** Tokenize the nul-terminated string zText and add all tokens to the
  151417. ** pending-terms hash-table. The docid used is that currently stored in
  151418. ** p->iPrevDocid, and the column is specified by argument iCol.
  151419. **
  151420. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code.
  151421. */
  151422. static int fts3PendingTermsAdd(
  151423. Fts3Table *p, /* Table into which text will be inserted */
  151424. int iLangid, /* Language id to use */
  151425. const char *zText, /* Text of document to be inserted */
  151426. int iCol, /* Column into which text is being inserted */
  151427. u32 *pnWord /* IN/OUT: Incr. by number tokens inserted */
  151428. ){
  151429. int rc;
  151430. int iStart = 0;
  151431. int iEnd = 0;
  151432. int iPos = 0;
  151433. int nWord = 0;
  151434. char const *zToken;
  151435. int nToken = 0;
  151436. sqlite3_tokenizer *pTokenizer = p->pTokenizer;
  151437. sqlite3_tokenizer_module const *pModule = pTokenizer->pModule;
  151438. sqlite3_tokenizer_cursor *pCsr;
  151439. int (*xNext)(sqlite3_tokenizer_cursor *pCursor,
  151440. const char**,int*,int*,int*,int*);
  151441. assert( pTokenizer && pModule );
  151442. /* If the user has inserted a NULL value, this function may be called with
  151443. ** zText==0. In this case, add zero token entries to the hash table and
  151444. ** return early. */
  151445. if( zText==0 ){
  151446. *pnWord = 0;
  151447. return SQLITE_OK;
  151448. }
  151449. rc = sqlite3Fts3OpenTokenizer(pTokenizer, iLangid, zText, -1, &pCsr);
  151450. if( rc!=SQLITE_OK ){
  151451. return rc;
  151452. }
  151453. xNext = pModule->xNext;
  151454. while( SQLITE_OK==rc
  151455. && SQLITE_OK==(rc = xNext(pCsr, &zToken, &nToken, &iStart, &iEnd, &iPos))
  151456. ){
  151457. int i;
  151458. if( iPos>=nWord ) nWord = iPos+1;
  151459. /* Positions cannot be negative; we use -1 as a terminator internally.
  151460. ** Tokens must have a non-zero length.
  151461. */
  151462. if( iPos<0 || !zToken || nToken<=0 ){
  151463. rc = SQLITE_ERROR;
  151464. break;
  151465. }
  151466. /* Add the term to the terms index */
  151467. rc = fts3PendingTermsAddOne(
  151468. p, iCol, iPos, &p->aIndex[0].hPending, zToken, nToken
  151469. );
  151470. /* Add the term to each of the prefix indexes that it is not too
  151471. ** short for. */
  151472. for(i=1; rc==SQLITE_OK && i<p->nIndex; i++){
  151473. struct Fts3Index *pIndex = &p->aIndex[i];
  151474. if( nToken<pIndex->nPrefix ) continue;
  151475. rc = fts3PendingTermsAddOne(
  151476. p, iCol, iPos, &pIndex->hPending, zToken, pIndex->nPrefix
  151477. );
  151478. }
  151479. }
  151480. pModule->xClose(pCsr);
  151481. *pnWord += nWord;
  151482. return (rc==SQLITE_DONE ? SQLITE_OK : rc);
  151483. }
  151484. /*
  151485. ** Calling this function indicates that subsequent calls to
  151486. ** fts3PendingTermsAdd() are to add term/position-list pairs for the
  151487. ** contents of the document with docid iDocid.
  151488. */
  151489. static int fts3PendingTermsDocid(
  151490. Fts3Table *p, /* Full-text table handle */
  151491. int bDelete, /* True if this op is a delete */
  151492. int iLangid, /* Language id of row being written */
  151493. sqlite_int64 iDocid /* Docid of row being written */
  151494. ){
  151495. assert( iLangid>=0 );
  151496. assert( bDelete==1 || bDelete==0 );
  151497. /* TODO(shess) Explore whether partially flushing the buffer on
  151498. ** forced-flush would provide better performance. I suspect that if
  151499. ** we ordered the doclists by size and flushed the largest until the
  151500. ** buffer was half empty, that would let the less frequent terms
  151501. ** generate longer doclists.
  151502. */
  151503. if( iDocid<p->iPrevDocid
  151504. || (iDocid==p->iPrevDocid && p->bPrevDelete==0)
  151505. || p->iPrevLangid!=iLangid
  151506. || p->nPendingData>p->nMaxPendingData
  151507. ){
  151508. int rc = sqlite3Fts3PendingTermsFlush(p);
  151509. if( rc!=SQLITE_OK ) return rc;
  151510. }
  151511. p->iPrevDocid = iDocid;
  151512. p->iPrevLangid = iLangid;
  151513. p->bPrevDelete = bDelete;
  151514. return SQLITE_OK;
  151515. }
  151516. /*
  151517. ** Discard the contents of the pending-terms hash tables.
  151518. */
  151519. SQLITE_PRIVATE void sqlite3Fts3PendingTermsClear(Fts3Table *p){
  151520. int i;
  151521. for(i=0; i<p->nIndex; i++){
  151522. Fts3HashElem *pElem;
  151523. Fts3Hash *pHash = &p->aIndex[i].hPending;
  151524. for(pElem=fts3HashFirst(pHash); pElem; pElem=fts3HashNext(pElem)){
  151525. PendingList *pList = (PendingList *)fts3HashData(pElem);
  151526. fts3PendingListDelete(pList);
  151527. }
  151528. fts3HashClear(pHash);
  151529. }
  151530. p->nPendingData = 0;
  151531. }
  151532. /*
  151533. ** This function is called by the xUpdate() method as part of an INSERT
  151534. ** operation. It adds entries for each term in the new record to the
  151535. ** pendingTerms hash table.
  151536. **
  151537. ** Argument apVal is the same as the similarly named argument passed to
  151538. ** fts3InsertData(). Parameter iDocid is the docid of the new row.
  151539. */
  151540. static int fts3InsertTerms(
  151541. Fts3Table *p,
  151542. int iLangid,
  151543. sqlite3_value **apVal,
  151544. u32 *aSz
  151545. ){
  151546. int i; /* Iterator variable */
  151547. for(i=2; i<p->nColumn+2; i++){
  151548. int iCol = i-2;
  151549. if( p->abNotindexed[iCol]==0 ){
  151550. const char *zText = (const char *)sqlite3_value_text(apVal[i]);
  151551. int rc = fts3PendingTermsAdd(p, iLangid, zText, iCol, &aSz[iCol]);
  151552. if( rc!=SQLITE_OK ){
  151553. return rc;
  151554. }
  151555. aSz[p->nColumn] += sqlite3_value_bytes(apVal[i]);
  151556. }
  151557. }
  151558. return SQLITE_OK;
  151559. }
  151560. /*
  151561. ** This function is called by the xUpdate() method for an INSERT operation.
  151562. ** The apVal parameter is passed a copy of the apVal argument passed by
  151563. ** SQLite to the xUpdate() method. i.e:
  151564. **
  151565. ** apVal[0] Not used for INSERT.
  151566. ** apVal[1] rowid
  151567. ** apVal[2] Left-most user-defined column
  151568. ** ...
  151569. ** apVal[p->nColumn+1] Right-most user-defined column
  151570. ** apVal[p->nColumn+2] Hidden column with same name as table
  151571. ** apVal[p->nColumn+3] Hidden "docid" column (alias for rowid)
  151572. ** apVal[p->nColumn+4] Hidden languageid column
  151573. */
  151574. static int fts3InsertData(
  151575. Fts3Table *p, /* Full-text table */
  151576. sqlite3_value **apVal, /* Array of values to insert */
  151577. sqlite3_int64 *piDocid /* OUT: Docid for row just inserted */
  151578. ){
  151579. int rc; /* Return code */
  151580. sqlite3_stmt *pContentInsert; /* INSERT INTO %_content VALUES(...) */
  151581. if( p->zContentTbl ){
  151582. sqlite3_value *pRowid = apVal[p->nColumn+3];
  151583. if( sqlite3_value_type(pRowid)==SQLITE_NULL ){
  151584. pRowid = apVal[1];
  151585. }
  151586. if( sqlite3_value_type(pRowid)!=SQLITE_INTEGER ){
  151587. return SQLITE_CONSTRAINT;
  151588. }
  151589. *piDocid = sqlite3_value_int64(pRowid);
  151590. return SQLITE_OK;
  151591. }
  151592. /* Locate the statement handle used to insert data into the %_content
  151593. ** table. The SQL for this statement is:
  151594. **
  151595. ** INSERT INTO %_content VALUES(?, ?, ?, ...)
  151596. **
  151597. ** The statement features N '?' variables, where N is the number of user
  151598. ** defined columns in the FTS3 table, plus one for the docid field.
  151599. */
  151600. rc = fts3SqlStmt(p, SQL_CONTENT_INSERT, &pContentInsert, &apVal[1]);
  151601. if( rc==SQLITE_OK && p->zLanguageid ){
  151602. rc = sqlite3_bind_int(
  151603. pContentInsert, p->nColumn+2,
  151604. sqlite3_value_int(apVal[p->nColumn+4])
  151605. );
  151606. }
  151607. if( rc!=SQLITE_OK ) return rc;
  151608. /* There is a quirk here. The users INSERT statement may have specified
  151609. ** a value for the "rowid" field, for the "docid" field, or for both.
  151610. ** Which is a problem, since "rowid" and "docid" are aliases for the
  151611. ** same value. For example:
  151612. **
  151613. ** INSERT INTO fts3tbl(rowid, docid) VALUES(1, 2);
  151614. **
  151615. ** In FTS3, this is an error. It is an error to specify non-NULL values
  151616. ** for both docid and some other rowid alias.
  151617. */
  151618. if( SQLITE_NULL!=sqlite3_value_type(apVal[3+p->nColumn]) ){
  151619. if( SQLITE_NULL==sqlite3_value_type(apVal[0])
  151620. && SQLITE_NULL!=sqlite3_value_type(apVal[1])
  151621. ){
  151622. /* A rowid/docid conflict. */
  151623. return SQLITE_ERROR;
  151624. }
  151625. rc = sqlite3_bind_value(pContentInsert, 1, apVal[3+p->nColumn]);
  151626. if( rc!=SQLITE_OK ) return rc;
  151627. }
  151628. /* Execute the statement to insert the record. Set *piDocid to the
  151629. ** new docid value.
  151630. */
  151631. sqlite3_step(pContentInsert);
  151632. rc = sqlite3_reset(pContentInsert);
  151633. *piDocid = sqlite3_last_insert_rowid(p->db);
  151634. return rc;
  151635. }
  151636. /*
  151637. ** Remove all data from the FTS3 table. Clear the hash table containing
  151638. ** pending terms.
  151639. */
  151640. static int fts3DeleteAll(Fts3Table *p, int bContent){
  151641. int rc = SQLITE_OK; /* Return code */
  151642. /* Discard the contents of the pending-terms hash table. */
  151643. sqlite3Fts3PendingTermsClear(p);
  151644. /* Delete everything from the shadow tables. Except, leave %_content as
  151645. ** is if bContent is false. */
  151646. assert( p->zContentTbl==0 || bContent==0 );
  151647. if( bContent ) fts3SqlExec(&rc, p, SQL_DELETE_ALL_CONTENT, 0);
  151648. fts3SqlExec(&rc, p, SQL_DELETE_ALL_SEGMENTS, 0);
  151649. fts3SqlExec(&rc, p, SQL_DELETE_ALL_SEGDIR, 0);
  151650. if( p->bHasDocsize ){
  151651. fts3SqlExec(&rc, p, SQL_DELETE_ALL_DOCSIZE, 0);
  151652. }
  151653. if( p->bHasStat ){
  151654. fts3SqlExec(&rc, p, SQL_DELETE_ALL_STAT, 0);
  151655. }
  151656. return rc;
  151657. }
  151658. /*
  151659. **
  151660. */
  151661. static int langidFromSelect(Fts3Table *p, sqlite3_stmt *pSelect){
  151662. int iLangid = 0;
  151663. if( p->zLanguageid ) iLangid = sqlite3_column_int(pSelect, p->nColumn+1);
  151664. return iLangid;
  151665. }
  151666. /*
  151667. ** The first element in the apVal[] array is assumed to contain the docid
  151668. ** (an integer) of a row about to be deleted. Remove all terms from the
  151669. ** full-text index.
  151670. */
  151671. static void fts3DeleteTerms(
  151672. int *pRC, /* Result code */
  151673. Fts3Table *p, /* The FTS table to delete from */
  151674. sqlite3_value *pRowid, /* The docid to be deleted */
  151675. u32 *aSz, /* Sizes of deleted document written here */
  151676. int *pbFound /* OUT: Set to true if row really does exist */
  151677. ){
  151678. int rc;
  151679. sqlite3_stmt *pSelect;
  151680. assert( *pbFound==0 );
  151681. if( *pRC ) return;
  151682. rc = fts3SqlStmt(p, SQL_SELECT_CONTENT_BY_ROWID, &pSelect, &pRowid);
  151683. if( rc==SQLITE_OK ){
  151684. if( SQLITE_ROW==sqlite3_step(pSelect) ){
  151685. int i;
  151686. int iLangid = langidFromSelect(p, pSelect);
  151687. i64 iDocid = sqlite3_column_int64(pSelect, 0);
  151688. rc = fts3PendingTermsDocid(p, 1, iLangid, iDocid);
  151689. for(i=1; rc==SQLITE_OK && i<=p->nColumn; i++){
  151690. int iCol = i-1;
  151691. if( p->abNotindexed[iCol]==0 ){
  151692. const char *zText = (const char *)sqlite3_column_text(pSelect, i);
  151693. rc = fts3PendingTermsAdd(p, iLangid, zText, -1, &aSz[iCol]);
  151694. aSz[p->nColumn] += sqlite3_column_bytes(pSelect, i);
  151695. }
  151696. }
  151697. if( rc!=SQLITE_OK ){
  151698. sqlite3_reset(pSelect);
  151699. *pRC = rc;
  151700. return;
  151701. }
  151702. *pbFound = 1;
  151703. }
  151704. rc = sqlite3_reset(pSelect);
  151705. }else{
  151706. sqlite3_reset(pSelect);
  151707. }
  151708. *pRC = rc;
  151709. }
  151710. /*
  151711. ** Forward declaration to account for the circular dependency between
  151712. ** functions fts3SegmentMerge() and fts3AllocateSegdirIdx().
  151713. */
  151714. static int fts3SegmentMerge(Fts3Table *, int, int, int);
  151715. /*
  151716. ** This function allocates a new level iLevel index in the segdir table.
  151717. ** Usually, indexes are allocated within a level sequentially starting
  151718. ** with 0, so the allocated index is one greater than the value returned
  151719. ** by:
  151720. **
  151721. ** SELECT max(idx) FROM %_segdir WHERE level = :iLevel
  151722. **
  151723. ** However, if there are already FTS3_MERGE_COUNT indexes at the requested
  151724. ** level, they are merged into a single level (iLevel+1) segment and the
  151725. ** allocated index is 0.
  151726. **
  151727. ** If successful, *piIdx is set to the allocated index slot and SQLITE_OK
  151728. ** returned. Otherwise, an SQLite error code is returned.
  151729. */
  151730. static int fts3AllocateSegdirIdx(
  151731. Fts3Table *p,
  151732. int iLangid, /* Language id */
  151733. int iIndex, /* Index for p->aIndex */
  151734. int iLevel,
  151735. int *piIdx
  151736. ){
  151737. int rc; /* Return Code */
  151738. sqlite3_stmt *pNextIdx; /* Query for next idx at level iLevel */
  151739. int iNext = 0; /* Result of query pNextIdx */
  151740. assert( iLangid>=0 );
  151741. assert( p->nIndex>=1 );
  151742. /* Set variable iNext to the next available segdir index at level iLevel. */
  151743. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENT_INDEX, &pNextIdx, 0);
  151744. if( rc==SQLITE_OK ){
  151745. sqlite3_bind_int64(
  151746. pNextIdx, 1, getAbsoluteLevel(p, iLangid, iIndex, iLevel)
  151747. );
  151748. if( SQLITE_ROW==sqlite3_step(pNextIdx) ){
  151749. iNext = sqlite3_column_int(pNextIdx, 0);
  151750. }
  151751. rc = sqlite3_reset(pNextIdx);
  151752. }
  151753. if( rc==SQLITE_OK ){
  151754. /* If iNext is FTS3_MERGE_COUNT, indicating that level iLevel is already
  151755. ** full, merge all segments in level iLevel into a single iLevel+1
  151756. ** segment and allocate (newly freed) index 0 at level iLevel. Otherwise,
  151757. ** if iNext is less than FTS3_MERGE_COUNT, allocate index iNext.
  151758. */
  151759. if( iNext>=FTS3_MERGE_COUNT ){
  151760. fts3LogMerge(16, getAbsoluteLevel(p, iLangid, iIndex, iLevel));
  151761. rc = fts3SegmentMerge(p, iLangid, iIndex, iLevel);
  151762. *piIdx = 0;
  151763. }else{
  151764. *piIdx = iNext;
  151765. }
  151766. }
  151767. return rc;
  151768. }
  151769. /*
  151770. ** The %_segments table is declared as follows:
  151771. **
  151772. ** CREATE TABLE %_segments(blockid INTEGER PRIMARY KEY, block BLOB)
  151773. **
  151774. ** This function reads data from a single row of the %_segments table. The
  151775. ** specific row is identified by the iBlockid parameter. If paBlob is not
  151776. ** NULL, then a buffer is allocated using sqlite3_malloc() and populated
  151777. ** with the contents of the blob stored in the "block" column of the
  151778. ** identified table row is. Whether or not paBlob is NULL, *pnBlob is set
  151779. ** to the size of the blob in bytes before returning.
  151780. **
  151781. ** If an error occurs, or the table does not contain the specified row,
  151782. ** an SQLite error code is returned. Otherwise, SQLITE_OK is returned. If
  151783. ** paBlob is non-NULL, then it is the responsibility of the caller to
  151784. ** eventually free the returned buffer.
  151785. **
  151786. ** This function may leave an open sqlite3_blob* handle in the
  151787. ** Fts3Table.pSegments variable. This handle is reused by subsequent calls
  151788. ** to this function. The handle may be closed by calling the
  151789. ** sqlite3Fts3SegmentsClose() function. Reusing a blob handle is a handy
  151790. ** performance improvement, but the blob handle should always be closed
  151791. ** before control is returned to the user (to prevent a lock being held
  151792. ** on the database file for longer than necessary). Thus, any virtual table
  151793. ** method (xFilter etc.) that may directly or indirectly call this function
  151794. ** must call sqlite3Fts3SegmentsClose() before returning.
  151795. */
  151796. SQLITE_PRIVATE int sqlite3Fts3ReadBlock(
  151797. Fts3Table *p, /* FTS3 table handle */
  151798. sqlite3_int64 iBlockid, /* Access the row with blockid=$iBlockid */
  151799. char **paBlob, /* OUT: Blob data in malloc'd buffer */
  151800. int *pnBlob, /* OUT: Size of blob data */
  151801. int *pnLoad /* OUT: Bytes actually loaded */
  151802. ){
  151803. int rc; /* Return code */
  151804. /* pnBlob must be non-NULL. paBlob may be NULL or non-NULL. */
  151805. assert( pnBlob );
  151806. if( p->pSegments ){
  151807. rc = sqlite3_blob_reopen(p->pSegments, iBlockid);
  151808. }else{
  151809. if( 0==p->zSegmentsTbl ){
  151810. p->zSegmentsTbl = sqlite3_mprintf("%s_segments", p->zName);
  151811. if( 0==p->zSegmentsTbl ) return SQLITE_NOMEM;
  151812. }
  151813. rc = sqlite3_blob_open(
  151814. p->db, p->zDb, p->zSegmentsTbl, "block", iBlockid, 0, &p->pSegments
  151815. );
  151816. }
  151817. if( rc==SQLITE_OK ){
  151818. int nByte = sqlite3_blob_bytes(p->pSegments);
  151819. *pnBlob = nByte;
  151820. if( paBlob ){
  151821. char *aByte = sqlite3_malloc(nByte + FTS3_NODE_PADDING);
  151822. if( !aByte ){
  151823. rc = SQLITE_NOMEM;
  151824. }else{
  151825. if( pnLoad && nByte>(FTS3_NODE_CHUNK_THRESHOLD) ){
  151826. nByte = FTS3_NODE_CHUNKSIZE;
  151827. *pnLoad = nByte;
  151828. }
  151829. rc = sqlite3_blob_read(p->pSegments, aByte, nByte, 0);
  151830. memset(&aByte[nByte], 0, FTS3_NODE_PADDING);
  151831. if( rc!=SQLITE_OK ){
  151832. sqlite3_free(aByte);
  151833. aByte = 0;
  151834. }
  151835. }
  151836. *paBlob = aByte;
  151837. }
  151838. }
  151839. return rc;
  151840. }
  151841. /*
  151842. ** Close the blob handle at p->pSegments, if it is open. See comments above
  151843. ** the sqlite3Fts3ReadBlock() function for details.
  151844. */
  151845. SQLITE_PRIVATE void sqlite3Fts3SegmentsClose(Fts3Table *p){
  151846. sqlite3_blob_close(p->pSegments);
  151847. p->pSegments = 0;
  151848. }
  151849. static int fts3SegReaderIncrRead(Fts3SegReader *pReader){
  151850. int nRead; /* Number of bytes to read */
  151851. int rc; /* Return code */
  151852. nRead = MIN(pReader->nNode - pReader->nPopulate, FTS3_NODE_CHUNKSIZE);
  151853. rc = sqlite3_blob_read(
  151854. pReader->pBlob,
  151855. &pReader->aNode[pReader->nPopulate],
  151856. nRead,
  151857. pReader->nPopulate
  151858. );
  151859. if( rc==SQLITE_OK ){
  151860. pReader->nPopulate += nRead;
  151861. memset(&pReader->aNode[pReader->nPopulate], 0, FTS3_NODE_PADDING);
  151862. if( pReader->nPopulate==pReader->nNode ){
  151863. sqlite3_blob_close(pReader->pBlob);
  151864. pReader->pBlob = 0;
  151865. pReader->nPopulate = 0;
  151866. }
  151867. }
  151868. return rc;
  151869. }
  151870. static int fts3SegReaderRequire(Fts3SegReader *pReader, char *pFrom, int nByte){
  151871. int rc = SQLITE_OK;
  151872. assert( !pReader->pBlob
  151873. || (pFrom>=pReader->aNode && pFrom<&pReader->aNode[pReader->nNode])
  151874. );
  151875. while( pReader->pBlob && rc==SQLITE_OK
  151876. && (pFrom - pReader->aNode + nByte)>pReader->nPopulate
  151877. ){
  151878. rc = fts3SegReaderIncrRead(pReader);
  151879. }
  151880. return rc;
  151881. }
  151882. /*
  151883. ** Set an Fts3SegReader cursor to point at EOF.
  151884. */
  151885. static void fts3SegReaderSetEof(Fts3SegReader *pSeg){
  151886. if( !fts3SegReaderIsRootOnly(pSeg) ){
  151887. sqlite3_free(pSeg->aNode);
  151888. sqlite3_blob_close(pSeg->pBlob);
  151889. pSeg->pBlob = 0;
  151890. }
  151891. pSeg->aNode = 0;
  151892. }
  151893. /*
  151894. ** Move the iterator passed as the first argument to the next term in the
  151895. ** segment. If successful, SQLITE_OK is returned. If there is no next term,
  151896. ** SQLITE_DONE. Otherwise, an SQLite error code.
  151897. */
  151898. static int fts3SegReaderNext(
  151899. Fts3Table *p,
  151900. Fts3SegReader *pReader,
  151901. int bIncr
  151902. ){
  151903. int rc; /* Return code of various sub-routines */
  151904. char *pNext; /* Cursor variable */
  151905. int nPrefix; /* Number of bytes in term prefix */
  151906. int nSuffix; /* Number of bytes in term suffix */
  151907. if( !pReader->aDoclist ){
  151908. pNext = pReader->aNode;
  151909. }else{
  151910. pNext = &pReader->aDoclist[pReader->nDoclist];
  151911. }
  151912. if( !pNext || pNext>=&pReader->aNode[pReader->nNode] ){
  151913. if( fts3SegReaderIsPending(pReader) ){
  151914. Fts3HashElem *pElem = *(pReader->ppNextElem);
  151915. sqlite3_free(pReader->aNode);
  151916. pReader->aNode = 0;
  151917. if( pElem ){
  151918. char *aCopy;
  151919. PendingList *pList = (PendingList *)fts3HashData(pElem);
  151920. int nCopy = pList->nData+1;
  151921. pReader->zTerm = (char *)fts3HashKey(pElem);
  151922. pReader->nTerm = fts3HashKeysize(pElem);
  151923. aCopy = (char*)sqlite3_malloc(nCopy);
  151924. if( !aCopy ) return SQLITE_NOMEM;
  151925. memcpy(aCopy, pList->aData, nCopy);
  151926. pReader->nNode = pReader->nDoclist = nCopy;
  151927. pReader->aNode = pReader->aDoclist = aCopy;
  151928. pReader->ppNextElem++;
  151929. assert( pReader->aNode );
  151930. }
  151931. return SQLITE_OK;
  151932. }
  151933. fts3SegReaderSetEof(pReader);
  151934. /* If iCurrentBlock>=iLeafEndBlock, this is an EOF condition. All leaf
  151935. ** blocks have already been traversed. */
  151936. assert( pReader->iCurrentBlock<=pReader->iLeafEndBlock );
  151937. if( pReader->iCurrentBlock>=pReader->iLeafEndBlock ){
  151938. return SQLITE_OK;
  151939. }
  151940. rc = sqlite3Fts3ReadBlock(
  151941. p, ++pReader->iCurrentBlock, &pReader->aNode, &pReader->nNode,
  151942. (bIncr ? &pReader->nPopulate : 0)
  151943. );
  151944. if( rc!=SQLITE_OK ) return rc;
  151945. assert( pReader->pBlob==0 );
  151946. if( bIncr && pReader->nPopulate<pReader->nNode ){
  151947. pReader->pBlob = p->pSegments;
  151948. p->pSegments = 0;
  151949. }
  151950. pNext = pReader->aNode;
  151951. }
  151952. assert( !fts3SegReaderIsPending(pReader) );
  151953. rc = fts3SegReaderRequire(pReader, pNext, FTS3_VARINT_MAX*2);
  151954. if( rc!=SQLITE_OK ) return rc;
  151955. /* Because of the FTS3_NODE_PADDING bytes of padding, the following is
  151956. ** safe (no risk of overread) even if the node data is corrupted. */
  151957. pNext += fts3GetVarint32(pNext, &nPrefix);
  151958. pNext += fts3GetVarint32(pNext, &nSuffix);
  151959. if( nPrefix<0 || nSuffix<=0
  151960. || &pNext[nSuffix]>&pReader->aNode[pReader->nNode]
  151961. ){
  151962. return FTS_CORRUPT_VTAB;
  151963. }
  151964. if( nPrefix+nSuffix>pReader->nTermAlloc ){
  151965. int nNew = (nPrefix+nSuffix)*2;
  151966. char *zNew = sqlite3_realloc(pReader->zTerm, nNew);
  151967. if( !zNew ){
  151968. return SQLITE_NOMEM;
  151969. }
  151970. pReader->zTerm = zNew;
  151971. pReader->nTermAlloc = nNew;
  151972. }
  151973. rc = fts3SegReaderRequire(pReader, pNext, nSuffix+FTS3_VARINT_MAX);
  151974. if( rc!=SQLITE_OK ) return rc;
  151975. memcpy(&pReader->zTerm[nPrefix], pNext, nSuffix);
  151976. pReader->nTerm = nPrefix+nSuffix;
  151977. pNext += nSuffix;
  151978. pNext += fts3GetVarint32(pNext, &pReader->nDoclist);
  151979. pReader->aDoclist = pNext;
  151980. pReader->pOffsetList = 0;
  151981. /* Check that the doclist does not appear to extend past the end of the
  151982. ** b-tree node. And that the final byte of the doclist is 0x00. If either
  151983. ** of these statements is untrue, then the data structure is corrupt.
  151984. */
  151985. if( &pReader->aDoclist[pReader->nDoclist]>&pReader->aNode[pReader->nNode]
  151986. || (pReader->nPopulate==0 && pReader->aDoclist[pReader->nDoclist-1])
  151987. ){
  151988. return FTS_CORRUPT_VTAB;
  151989. }
  151990. return SQLITE_OK;
  151991. }
  151992. /*
  151993. ** Set the SegReader to point to the first docid in the doclist associated
  151994. ** with the current term.
  151995. */
  151996. static int fts3SegReaderFirstDocid(Fts3Table *pTab, Fts3SegReader *pReader){
  151997. int rc = SQLITE_OK;
  151998. assert( pReader->aDoclist );
  151999. assert( !pReader->pOffsetList );
  152000. if( pTab->bDescIdx && fts3SegReaderIsPending(pReader) ){
  152001. u8 bEof = 0;
  152002. pReader->iDocid = 0;
  152003. pReader->nOffsetList = 0;
  152004. sqlite3Fts3DoclistPrev(0,
  152005. pReader->aDoclist, pReader->nDoclist, &pReader->pOffsetList,
  152006. &pReader->iDocid, &pReader->nOffsetList, &bEof
  152007. );
  152008. }else{
  152009. rc = fts3SegReaderRequire(pReader, pReader->aDoclist, FTS3_VARINT_MAX);
  152010. if( rc==SQLITE_OK ){
  152011. int n = sqlite3Fts3GetVarint(pReader->aDoclist, &pReader->iDocid);
  152012. pReader->pOffsetList = &pReader->aDoclist[n];
  152013. }
  152014. }
  152015. return rc;
  152016. }
  152017. /*
  152018. ** Advance the SegReader to point to the next docid in the doclist
  152019. ** associated with the current term.
  152020. **
  152021. ** If arguments ppOffsetList and pnOffsetList are not NULL, then
  152022. ** *ppOffsetList is set to point to the first column-offset list
  152023. ** in the doclist entry (i.e. immediately past the docid varint).
  152024. ** *pnOffsetList is set to the length of the set of column-offset
  152025. ** lists, not including the nul-terminator byte. For example:
  152026. */
  152027. static int fts3SegReaderNextDocid(
  152028. Fts3Table *pTab,
  152029. Fts3SegReader *pReader, /* Reader to advance to next docid */
  152030. char **ppOffsetList, /* OUT: Pointer to current position-list */
  152031. int *pnOffsetList /* OUT: Length of *ppOffsetList in bytes */
  152032. ){
  152033. int rc = SQLITE_OK;
  152034. char *p = pReader->pOffsetList;
  152035. char c = 0;
  152036. assert( p );
  152037. if( pTab->bDescIdx && fts3SegReaderIsPending(pReader) ){
  152038. /* A pending-terms seg-reader for an FTS4 table that uses order=desc.
  152039. ** Pending-terms doclists are always built up in ascending order, so
  152040. ** we have to iterate through them backwards here. */
  152041. u8 bEof = 0;
  152042. if( ppOffsetList ){
  152043. *ppOffsetList = pReader->pOffsetList;
  152044. *pnOffsetList = pReader->nOffsetList - 1;
  152045. }
  152046. sqlite3Fts3DoclistPrev(0,
  152047. pReader->aDoclist, pReader->nDoclist, &p, &pReader->iDocid,
  152048. &pReader->nOffsetList, &bEof
  152049. );
  152050. if( bEof ){
  152051. pReader->pOffsetList = 0;
  152052. }else{
  152053. pReader->pOffsetList = p;
  152054. }
  152055. }else{
  152056. char *pEnd = &pReader->aDoclist[pReader->nDoclist];
  152057. /* Pointer p currently points at the first byte of an offset list. The
  152058. ** following block advances it to point one byte past the end of
  152059. ** the same offset list. */
  152060. while( 1 ){
  152061. /* The following line of code (and the "p++" below the while() loop) is
  152062. ** normally all that is required to move pointer p to the desired
  152063. ** position. The exception is if this node is being loaded from disk
  152064. ** incrementally and pointer "p" now points to the first byte past
  152065. ** the populated part of pReader->aNode[].
  152066. */
  152067. while( *p | c ) c = *p++ & 0x80;
  152068. assert( *p==0 );
  152069. if( pReader->pBlob==0 || p<&pReader->aNode[pReader->nPopulate] ) break;
  152070. rc = fts3SegReaderIncrRead(pReader);
  152071. if( rc!=SQLITE_OK ) return rc;
  152072. }
  152073. p++;
  152074. /* If required, populate the output variables with a pointer to and the
  152075. ** size of the previous offset-list.
  152076. */
  152077. if( ppOffsetList ){
  152078. *ppOffsetList = pReader->pOffsetList;
  152079. *pnOffsetList = (int)(p - pReader->pOffsetList - 1);
  152080. }
  152081. /* List may have been edited in place by fts3EvalNearTrim() */
  152082. while( p<pEnd && *p==0 ) p++;
  152083. /* If there are no more entries in the doclist, set pOffsetList to
  152084. ** NULL. Otherwise, set Fts3SegReader.iDocid to the next docid and
  152085. ** Fts3SegReader.pOffsetList to point to the next offset list before
  152086. ** returning.
  152087. */
  152088. if( p>=pEnd ){
  152089. pReader->pOffsetList = 0;
  152090. }else{
  152091. rc = fts3SegReaderRequire(pReader, p, FTS3_VARINT_MAX);
  152092. if( rc==SQLITE_OK ){
  152093. sqlite3_int64 iDelta;
  152094. pReader->pOffsetList = p + sqlite3Fts3GetVarint(p, &iDelta);
  152095. if( pTab->bDescIdx ){
  152096. pReader->iDocid -= iDelta;
  152097. }else{
  152098. pReader->iDocid += iDelta;
  152099. }
  152100. }
  152101. }
  152102. }
  152103. return SQLITE_OK;
  152104. }
  152105. SQLITE_PRIVATE int sqlite3Fts3MsrOvfl(
  152106. Fts3Cursor *pCsr,
  152107. Fts3MultiSegReader *pMsr,
  152108. int *pnOvfl
  152109. ){
  152110. Fts3Table *p = (Fts3Table*)pCsr->base.pVtab;
  152111. int nOvfl = 0;
  152112. int ii;
  152113. int rc = SQLITE_OK;
  152114. int pgsz = p->nPgsz;
  152115. assert( p->bFts4 );
  152116. assert( pgsz>0 );
  152117. for(ii=0; rc==SQLITE_OK && ii<pMsr->nSegment; ii++){
  152118. Fts3SegReader *pReader = pMsr->apSegment[ii];
  152119. if( !fts3SegReaderIsPending(pReader)
  152120. && !fts3SegReaderIsRootOnly(pReader)
  152121. ){
  152122. sqlite3_int64 jj;
  152123. for(jj=pReader->iStartBlock; jj<=pReader->iLeafEndBlock; jj++){
  152124. int nBlob;
  152125. rc = sqlite3Fts3ReadBlock(p, jj, 0, &nBlob, 0);
  152126. if( rc!=SQLITE_OK ) break;
  152127. if( (nBlob+35)>pgsz ){
  152128. nOvfl += (nBlob + 34)/pgsz;
  152129. }
  152130. }
  152131. }
  152132. }
  152133. *pnOvfl = nOvfl;
  152134. return rc;
  152135. }
  152136. /*
  152137. ** Free all allocations associated with the iterator passed as the
  152138. ** second argument.
  152139. */
  152140. SQLITE_PRIVATE void sqlite3Fts3SegReaderFree(Fts3SegReader *pReader){
  152141. if( pReader ){
  152142. if( !fts3SegReaderIsPending(pReader) ){
  152143. sqlite3_free(pReader->zTerm);
  152144. }
  152145. if( !fts3SegReaderIsRootOnly(pReader) ){
  152146. sqlite3_free(pReader->aNode);
  152147. }
  152148. sqlite3_blob_close(pReader->pBlob);
  152149. }
  152150. sqlite3_free(pReader);
  152151. }
  152152. /*
  152153. ** Allocate a new SegReader object.
  152154. */
  152155. SQLITE_PRIVATE int sqlite3Fts3SegReaderNew(
  152156. int iAge, /* Segment "age". */
  152157. int bLookup, /* True for a lookup only */
  152158. sqlite3_int64 iStartLeaf, /* First leaf to traverse */
  152159. sqlite3_int64 iEndLeaf, /* Final leaf to traverse */
  152160. sqlite3_int64 iEndBlock, /* Final block of segment */
  152161. const char *zRoot, /* Buffer containing root node */
  152162. int nRoot, /* Size of buffer containing root node */
  152163. Fts3SegReader **ppReader /* OUT: Allocated Fts3SegReader */
  152164. ){
  152165. Fts3SegReader *pReader; /* Newly allocated SegReader object */
  152166. int nExtra = 0; /* Bytes to allocate segment root node */
  152167. assert( iStartLeaf<=iEndLeaf );
  152168. if( iStartLeaf==0 ){
  152169. nExtra = nRoot + FTS3_NODE_PADDING;
  152170. }
  152171. pReader = (Fts3SegReader *)sqlite3_malloc(sizeof(Fts3SegReader) + nExtra);
  152172. if( !pReader ){
  152173. return SQLITE_NOMEM;
  152174. }
  152175. memset(pReader, 0, sizeof(Fts3SegReader));
  152176. pReader->iIdx = iAge;
  152177. pReader->bLookup = bLookup!=0;
  152178. pReader->iStartBlock = iStartLeaf;
  152179. pReader->iLeafEndBlock = iEndLeaf;
  152180. pReader->iEndBlock = iEndBlock;
  152181. if( nExtra ){
  152182. /* The entire segment is stored in the root node. */
  152183. pReader->aNode = (char *)&pReader[1];
  152184. pReader->rootOnly = 1;
  152185. pReader->nNode = nRoot;
  152186. memcpy(pReader->aNode, zRoot, nRoot);
  152187. memset(&pReader->aNode[nRoot], 0, FTS3_NODE_PADDING);
  152188. }else{
  152189. pReader->iCurrentBlock = iStartLeaf-1;
  152190. }
  152191. *ppReader = pReader;
  152192. return SQLITE_OK;
  152193. }
  152194. /*
  152195. ** This is a comparison function used as a qsort() callback when sorting
  152196. ** an array of pending terms by term. This occurs as part of flushing
  152197. ** the contents of the pending-terms hash table to the database.
  152198. */
  152199. static int SQLITE_CDECL fts3CompareElemByTerm(
  152200. const void *lhs,
  152201. const void *rhs
  152202. ){
  152203. char *z1 = fts3HashKey(*(Fts3HashElem **)lhs);
  152204. char *z2 = fts3HashKey(*(Fts3HashElem **)rhs);
  152205. int n1 = fts3HashKeysize(*(Fts3HashElem **)lhs);
  152206. int n2 = fts3HashKeysize(*(Fts3HashElem **)rhs);
  152207. int n = (n1<n2 ? n1 : n2);
  152208. int c = memcmp(z1, z2, n);
  152209. if( c==0 ){
  152210. c = n1 - n2;
  152211. }
  152212. return c;
  152213. }
  152214. /*
  152215. ** This function is used to allocate an Fts3SegReader that iterates through
  152216. ** a subset of the terms stored in the Fts3Table.pendingTerms array.
  152217. **
  152218. ** If the isPrefixIter parameter is zero, then the returned SegReader iterates
  152219. ** through each term in the pending-terms table. Or, if isPrefixIter is
  152220. ** non-zero, it iterates through each term and its prefixes. For example, if
  152221. ** the pending terms hash table contains the terms "sqlite", "mysql" and
  152222. ** "firebird", then the iterator visits the following 'terms' (in the order
  152223. ** shown):
  152224. **
  152225. ** f fi fir fire fireb firebi firebir firebird
  152226. ** m my mys mysq mysql
  152227. ** s sq sql sqli sqlit sqlite
  152228. **
  152229. ** Whereas if isPrefixIter is zero, the terms visited are:
  152230. **
  152231. ** firebird mysql sqlite
  152232. */
  152233. SQLITE_PRIVATE int sqlite3Fts3SegReaderPending(
  152234. Fts3Table *p, /* Virtual table handle */
  152235. int iIndex, /* Index for p->aIndex */
  152236. const char *zTerm, /* Term to search for */
  152237. int nTerm, /* Size of buffer zTerm */
  152238. int bPrefix, /* True for a prefix iterator */
  152239. Fts3SegReader **ppReader /* OUT: SegReader for pending-terms */
  152240. ){
  152241. Fts3SegReader *pReader = 0; /* Fts3SegReader object to return */
  152242. Fts3HashElem *pE; /* Iterator variable */
  152243. Fts3HashElem **aElem = 0; /* Array of term hash entries to scan */
  152244. int nElem = 0; /* Size of array at aElem */
  152245. int rc = SQLITE_OK; /* Return Code */
  152246. Fts3Hash *pHash;
  152247. pHash = &p->aIndex[iIndex].hPending;
  152248. if( bPrefix ){
  152249. int nAlloc = 0; /* Size of allocated array at aElem */
  152250. for(pE=fts3HashFirst(pHash); pE; pE=fts3HashNext(pE)){
  152251. char *zKey = (char *)fts3HashKey(pE);
  152252. int nKey = fts3HashKeysize(pE);
  152253. if( nTerm==0 || (nKey>=nTerm && 0==memcmp(zKey, zTerm, nTerm)) ){
  152254. if( nElem==nAlloc ){
  152255. Fts3HashElem **aElem2;
  152256. nAlloc += 16;
  152257. aElem2 = (Fts3HashElem **)sqlite3_realloc(
  152258. aElem, nAlloc*sizeof(Fts3HashElem *)
  152259. );
  152260. if( !aElem2 ){
  152261. rc = SQLITE_NOMEM;
  152262. nElem = 0;
  152263. break;
  152264. }
  152265. aElem = aElem2;
  152266. }
  152267. aElem[nElem++] = pE;
  152268. }
  152269. }
  152270. /* If more than one term matches the prefix, sort the Fts3HashElem
  152271. ** objects in term order using qsort(). This uses the same comparison
  152272. ** callback as is used when flushing terms to disk.
  152273. */
  152274. if( nElem>1 ){
  152275. qsort(aElem, nElem, sizeof(Fts3HashElem *), fts3CompareElemByTerm);
  152276. }
  152277. }else{
  152278. /* The query is a simple term lookup that matches at most one term in
  152279. ** the index. All that is required is a straight hash-lookup.
  152280. **
  152281. ** Because the stack address of pE may be accessed via the aElem pointer
  152282. ** below, the "Fts3HashElem *pE" must be declared so that it is valid
  152283. ** within this entire function, not just this "else{...}" block.
  152284. */
  152285. pE = fts3HashFindElem(pHash, zTerm, nTerm);
  152286. if( pE ){
  152287. aElem = &pE;
  152288. nElem = 1;
  152289. }
  152290. }
  152291. if( nElem>0 ){
  152292. int nByte = sizeof(Fts3SegReader) + (nElem+1)*sizeof(Fts3HashElem *);
  152293. pReader = (Fts3SegReader *)sqlite3_malloc(nByte);
  152294. if( !pReader ){
  152295. rc = SQLITE_NOMEM;
  152296. }else{
  152297. memset(pReader, 0, nByte);
  152298. pReader->iIdx = 0x7FFFFFFF;
  152299. pReader->ppNextElem = (Fts3HashElem **)&pReader[1];
  152300. memcpy(pReader->ppNextElem, aElem, nElem*sizeof(Fts3HashElem *));
  152301. }
  152302. }
  152303. if( bPrefix ){
  152304. sqlite3_free(aElem);
  152305. }
  152306. *ppReader = pReader;
  152307. return rc;
  152308. }
  152309. /*
  152310. ** Compare the entries pointed to by two Fts3SegReader structures.
  152311. ** Comparison is as follows:
  152312. **
  152313. ** 1) EOF is greater than not EOF.
  152314. **
  152315. ** 2) The current terms (if any) are compared using memcmp(). If one
  152316. ** term is a prefix of another, the longer term is considered the
  152317. ** larger.
  152318. **
  152319. ** 3) By segment age. An older segment is considered larger.
  152320. */
  152321. static int fts3SegReaderCmp(Fts3SegReader *pLhs, Fts3SegReader *pRhs){
  152322. int rc;
  152323. if( pLhs->aNode && pRhs->aNode ){
  152324. int rc2 = pLhs->nTerm - pRhs->nTerm;
  152325. if( rc2<0 ){
  152326. rc = memcmp(pLhs->zTerm, pRhs->zTerm, pLhs->nTerm);
  152327. }else{
  152328. rc = memcmp(pLhs->zTerm, pRhs->zTerm, pRhs->nTerm);
  152329. }
  152330. if( rc==0 ){
  152331. rc = rc2;
  152332. }
  152333. }else{
  152334. rc = (pLhs->aNode==0) - (pRhs->aNode==0);
  152335. }
  152336. if( rc==0 ){
  152337. rc = pRhs->iIdx - pLhs->iIdx;
  152338. }
  152339. assert( rc!=0 );
  152340. return rc;
  152341. }
  152342. /*
  152343. ** A different comparison function for SegReader structures. In this
  152344. ** version, it is assumed that each SegReader points to an entry in
  152345. ** a doclist for identical terms. Comparison is made as follows:
  152346. **
  152347. ** 1) EOF (end of doclist in this case) is greater than not EOF.
  152348. **
  152349. ** 2) By current docid.
  152350. **
  152351. ** 3) By segment age. An older segment is considered larger.
  152352. */
  152353. static int fts3SegReaderDoclistCmp(Fts3SegReader *pLhs, Fts3SegReader *pRhs){
  152354. int rc = (pLhs->pOffsetList==0)-(pRhs->pOffsetList==0);
  152355. if( rc==0 ){
  152356. if( pLhs->iDocid==pRhs->iDocid ){
  152357. rc = pRhs->iIdx - pLhs->iIdx;
  152358. }else{
  152359. rc = (pLhs->iDocid > pRhs->iDocid) ? 1 : -1;
  152360. }
  152361. }
  152362. assert( pLhs->aNode && pRhs->aNode );
  152363. return rc;
  152364. }
  152365. static int fts3SegReaderDoclistCmpRev(Fts3SegReader *pLhs, Fts3SegReader *pRhs){
  152366. int rc = (pLhs->pOffsetList==0)-(pRhs->pOffsetList==0);
  152367. if( rc==0 ){
  152368. if( pLhs->iDocid==pRhs->iDocid ){
  152369. rc = pRhs->iIdx - pLhs->iIdx;
  152370. }else{
  152371. rc = (pLhs->iDocid < pRhs->iDocid) ? 1 : -1;
  152372. }
  152373. }
  152374. assert( pLhs->aNode && pRhs->aNode );
  152375. return rc;
  152376. }
  152377. /*
  152378. ** Compare the term that the Fts3SegReader object passed as the first argument
  152379. ** points to with the term specified by arguments zTerm and nTerm.
  152380. **
  152381. ** If the pSeg iterator is already at EOF, return 0. Otherwise, return
  152382. ** -ve if the pSeg term is less than zTerm/nTerm, 0 if the two terms are
  152383. ** equal, or +ve if the pSeg term is greater than zTerm/nTerm.
  152384. */
  152385. static int fts3SegReaderTermCmp(
  152386. Fts3SegReader *pSeg, /* Segment reader object */
  152387. const char *zTerm, /* Term to compare to */
  152388. int nTerm /* Size of term zTerm in bytes */
  152389. ){
  152390. int res = 0;
  152391. if( pSeg->aNode ){
  152392. if( pSeg->nTerm>nTerm ){
  152393. res = memcmp(pSeg->zTerm, zTerm, nTerm);
  152394. }else{
  152395. res = memcmp(pSeg->zTerm, zTerm, pSeg->nTerm);
  152396. }
  152397. if( res==0 ){
  152398. res = pSeg->nTerm-nTerm;
  152399. }
  152400. }
  152401. return res;
  152402. }
  152403. /*
  152404. ** Argument apSegment is an array of nSegment elements. It is known that
  152405. ** the final (nSegment-nSuspect) members are already in sorted order
  152406. ** (according to the comparison function provided). This function shuffles
  152407. ** the array around until all entries are in sorted order.
  152408. */
  152409. static void fts3SegReaderSort(
  152410. Fts3SegReader **apSegment, /* Array to sort entries of */
  152411. int nSegment, /* Size of apSegment array */
  152412. int nSuspect, /* Unsorted entry count */
  152413. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) /* Comparison function */
  152414. ){
  152415. int i; /* Iterator variable */
  152416. assert( nSuspect<=nSegment );
  152417. if( nSuspect==nSegment ) nSuspect--;
  152418. for(i=nSuspect-1; i>=0; i--){
  152419. int j;
  152420. for(j=i; j<(nSegment-1); j++){
  152421. Fts3SegReader *pTmp;
  152422. if( xCmp(apSegment[j], apSegment[j+1])<0 ) break;
  152423. pTmp = apSegment[j+1];
  152424. apSegment[j+1] = apSegment[j];
  152425. apSegment[j] = pTmp;
  152426. }
  152427. }
  152428. #ifndef NDEBUG
  152429. /* Check that the list really is sorted now. */
  152430. for(i=0; i<(nSuspect-1); i++){
  152431. assert( xCmp(apSegment[i], apSegment[i+1])<0 );
  152432. }
  152433. #endif
  152434. }
  152435. /*
  152436. ** Insert a record into the %_segments table.
  152437. */
  152438. static int fts3WriteSegment(
  152439. Fts3Table *p, /* Virtual table handle */
  152440. sqlite3_int64 iBlock, /* Block id for new block */
  152441. char *z, /* Pointer to buffer containing block data */
  152442. int n /* Size of buffer z in bytes */
  152443. ){
  152444. sqlite3_stmt *pStmt;
  152445. int rc = fts3SqlStmt(p, SQL_INSERT_SEGMENTS, &pStmt, 0);
  152446. if( rc==SQLITE_OK ){
  152447. sqlite3_bind_int64(pStmt, 1, iBlock);
  152448. sqlite3_bind_blob(pStmt, 2, z, n, SQLITE_STATIC);
  152449. sqlite3_step(pStmt);
  152450. rc = sqlite3_reset(pStmt);
  152451. sqlite3_bind_null(pStmt, 2);
  152452. }
  152453. return rc;
  152454. }
  152455. /*
  152456. ** Find the largest relative level number in the table. If successful, set
  152457. ** *pnMax to this value and return SQLITE_OK. Otherwise, if an error occurs,
  152458. ** set *pnMax to zero and return an SQLite error code.
  152459. */
  152460. SQLITE_PRIVATE int sqlite3Fts3MaxLevel(Fts3Table *p, int *pnMax){
  152461. int rc;
  152462. int mxLevel = 0;
  152463. sqlite3_stmt *pStmt = 0;
  152464. rc = fts3SqlStmt(p, SQL_SELECT_MXLEVEL, &pStmt, 0);
  152465. if( rc==SQLITE_OK ){
  152466. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  152467. mxLevel = sqlite3_column_int(pStmt, 0);
  152468. }
  152469. rc = sqlite3_reset(pStmt);
  152470. }
  152471. *pnMax = mxLevel;
  152472. return rc;
  152473. }
  152474. /*
  152475. ** Insert a record into the %_segdir table.
  152476. */
  152477. static int fts3WriteSegdir(
  152478. Fts3Table *p, /* Virtual table handle */
  152479. sqlite3_int64 iLevel, /* Value for "level" field (absolute level) */
  152480. int iIdx, /* Value for "idx" field */
  152481. sqlite3_int64 iStartBlock, /* Value for "start_block" field */
  152482. sqlite3_int64 iLeafEndBlock, /* Value for "leaves_end_block" field */
  152483. sqlite3_int64 iEndBlock, /* Value for "end_block" field */
  152484. sqlite3_int64 nLeafData, /* Bytes of leaf data in segment */
  152485. char *zRoot, /* Blob value for "root" field */
  152486. int nRoot /* Number of bytes in buffer zRoot */
  152487. ){
  152488. sqlite3_stmt *pStmt;
  152489. int rc = fts3SqlStmt(p, SQL_INSERT_SEGDIR, &pStmt, 0);
  152490. if( rc==SQLITE_OK ){
  152491. sqlite3_bind_int64(pStmt, 1, iLevel);
  152492. sqlite3_bind_int(pStmt, 2, iIdx);
  152493. sqlite3_bind_int64(pStmt, 3, iStartBlock);
  152494. sqlite3_bind_int64(pStmt, 4, iLeafEndBlock);
  152495. if( nLeafData==0 ){
  152496. sqlite3_bind_int64(pStmt, 5, iEndBlock);
  152497. }else{
  152498. char *zEnd = sqlite3_mprintf("%lld %lld", iEndBlock, nLeafData);
  152499. if( !zEnd ) return SQLITE_NOMEM;
  152500. sqlite3_bind_text(pStmt, 5, zEnd, -1, sqlite3_free);
  152501. }
  152502. sqlite3_bind_blob(pStmt, 6, zRoot, nRoot, SQLITE_STATIC);
  152503. sqlite3_step(pStmt);
  152504. rc = sqlite3_reset(pStmt);
  152505. sqlite3_bind_null(pStmt, 6);
  152506. }
  152507. return rc;
  152508. }
  152509. /*
  152510. ** Return the size of the common prefix (if any) shared by zPrev and
  152511. ** zNext, in bytes. For example,
  152512. **
  152513. ** fts3PrefixCompress("abc", 3, "abcdef", 6) // returns 3
  152514. ** fts3PrefixCompress("abX", 3, "abcdef", 6) // returns 2
  152515. ** fts3PrefixCompress("abX", 3, "Xbcdef", 6) // returns 0
  152516. */
  152517. static int fts3PrefixCompress(
  152518. const char *zPrev, /* Buffer containing previous term */
  152519. int nPrev, /* Size of buffer zPrev in bytes */
  152520. const char *zNext, /* Buffer containing next term */
  152521. int nNext /* Size of buffer zNext in bytes */
  152522. ){
  152523. int n;
  152524. UNUSED_PARAMETER(nNext);
  152525. for(n=0; n<nPrev && zPrev[n]==zNext[n]; n++);
  152526. return n;
  152527. }
  152528. /*
  152529. ** Add term zTerm to the SegmentNode. It is guaranteed that zTerm is larger
  152530. ** (according to memcmp) than the previous term.
  152531. */
  152532. static int fts3NodeAddTerm(
  152533. Fts3Table *p, /* Virtual table handle */
  152534. SegmentNode **ppTree, /* IN/OUT: SegmentNode handle */
  152535. int isCopyTerm, /* True if zTerm/nTerm is transient */
  152536. const char *zTerm, /* Pointer to buffer containing term */
  152537. int nTerm /* Size of term in bytes */
  152538. ){
  152539. SegmentNode *pTree = *ppTree;
  152540. int rc;
  152541. SegmentNode *pNew;
  152542. /* First try to append the term to the current node. Return early if
  152543. ** this is possible.
  152544. */
  152545. if( pTree ){
  152546. int nData = pTree->nData; /* Current size of node in bytes */
  152547. int nReq = nData; /* Required space after adding zTerm */
  152548. int nPrefix; /* Number of bytes of prefix compression */
  152549. int nSuffix; /* Suffix length */
  152550. nPrefix = fts3PrefixCompress(pTree->zTerm, pTree->nTerm, zTerm, nTerm);
  152551. nSuffix = nTerm-nPrefix;
  152552. nReq += sqlite3Fts3VarintLen(nPrefix)+sqlite3Fts3VarintLen(nSuffix)+nSuffix;
  152553. if( nReq<=p->nNodeSize || !pTree->zTerm ){
  152554. if( nReq>p->nNodeSize ){
  152555. /* An unusual case: this is the first term to be added to the node
  152556. ** and the static node buffer (p->nNodeSize bytes) is not large
  152557. ** enough. Use a separately malloced buffer instead This wastes
  152558. ** p->nNodeSize bytes, but since this scenario only comes about when
  152559. ** the database contain two terms that share a prefix of almost 2KB,
  152560. ** this is not expected to be a serious problem.
  152561. */
  152562. assert( pTree->aData==(char *)&pTree[1] );
  152563. pTree->aData = (char *)sqlite3_malloc(nReq);
  152564. if( !pTree->aData ){
  152565. return SQLITE_NOMEM;
  152566. }
  152567. }
  152568. if( pTree->zTerm ){
  152569. /* There is no prefix-length field for first term in a node */
  152570. nData += sqlite3Fts3PutVarint(&pTree->aData[nData], nPrefix);
  152571. }
  152572. nData += sqlite3Fts3PutVarint(&pTree->aData[nData], nSuffix);
  152573. memcpy(&pTree->aData[nData], &zTerm[nPrefix], nSuffix);
  152574. pTree->nData = nData + nSuffix;
  152575. pTree->nEntry++;
  152576. if( isCopyTerm ){
  152577. if( pTree->nMalloc<nTerm ){
  152578. char *zNew = sqlite3_realloc(pTree->zMalloc, nTerm*2);
  152579. if( !zNew ){
  152580. return SQLITE_NOMEM;
  152581. }
  152582. pTree->nMalloc = nTerm*2;
  152583. pTree->zMalloc = zNew;
  152584. }
  152585. pTree->zTerm = pTree->zMalloc;
  152586. memcpy(pTree->zTerm, zTerm, nTerm);
  152587. pTree->nTerm = nTerm;
  152588. }else{
  152589. pTree->zTerm = (char *)zTerm;
  152590. pTree->nTerm = nTerm;
  152591. }
  152592. return SQLITE_OK;
  152593. }
  152594. }
  152595. /* If control flows to here, it was not possible to append zTerm to the
  152596. ** current node. Create a new node (a right-sibling of the current node).
  152597. ** If this is the first node in the tree, the term is added to it.
  152598. **
  152599. ** Otherwise, the term is not added to the new node, it is left empty for
  152600. ** now. Instead, the term is inserted into the parent of pTree. If pTree
  152601. ** has no parent, one is created here.
  152602. */
  152603. pNew = (SegmentNode *)sqlite3_malloc(sizeof(SegmentNode) + p->nNodeSize);
  152604. if( !pNew ){
  152605. return SQLITE_NOMEM;
  152606. }
  152607. memset(pNew, 0, sizeof(SegmentNode));
  152608. pNew->nData = 1 + FTS3_VARINT_MAX;
  152609. pNew->aData = (char *)&pNew[1];
  152610. if( pTree ){
  152611. SegmentNode *pParent = pTree->pParent;
  152612. rc = fts3NodeAddTerm(p, &pParent, isCopyTerm, zTerm, nTerm);
  152613. if( pTree->pParent==0 ){
  152614. pTree->pParent = pParent;
  152615. }
  152616. pTree->pRight = pNew;
  152617. pNew->pLeftmost = pTree->pLeftmost;
  152618. pNew->pParent = pParent;
  152619. pNew->zMalloc = pTree->zMalloc;
  152620. pNew->nMalloc = pTree->nMalloc;
  152621. pTree->zMalloc = 0;
  152622. }else{
  152623. pNew->pLeftmost = pNew;
  152624. rc = fts3NodeAddTerm(p, &pNew, isCopyTerm, zTerm, nTerm);
  152625. }
  152626. *ppTree = pNew;
  152627. return rc;
  152628. }
  152629. /*
  152630. ** Helper function for fts3NodeWrite().
  152631. */
  152632. static int fts3TreeFinishNode(
  152633. SegmentNode *pTree,
  152634. int iHeight,
  152635. sqlite3_int64 iLeftChild
  152636. ){
  152637. int nStart;
  152638. assert( iHeight>=1 && iHeight<128 );
  152639. nStart = FTS3_VARINT_MAX - sqlite3Fts3VarintLen(iLeftChild);
  152640. pTree->aData[nStart] = (char)iHeight;
  152641. sqlite3Fts3PutVarint(&pTree->aData[nStart+1], iLeftChild);
  152642. return nStart;
  152643. }
  152644. /*
  152645. ** Write the buffer for the segment node pTree and all of its peers to the
  152646. ** database. Then call this function recursively to write the parent of
  152647. ** pTree and its peers to the database.
  152648. **
  152649. ** Except, if pTree is a root node, do not write it to the database. Instead,
  152650. ** set output variables *paRoot and *pnRoot to contain the root node.
  152651. **
  152652. ** If successful, SQLITE_OK is returned and output variable *piLast is
  152653. ** set to the largest blockid written to the database (or zero if no
  152654. ** blocks were written to the db). Otherwise, an SQLite error code is
  152655. ** returned.
  152656. */
  152657. static int fts3NodeWrite(
  152658. Fts3Table *p, /* Virtual table handle */
  152659. SegmentNode *pTree, /* SegmentNode handle */
  152660. int iHeight, /* Height of this node in tree */
  152661. sqlite3_int64 iLeaf, /* Block id of first leaf node */
  152662. sqlite3_int64 iFree, /* Block id of next free slot in %_segments */
  152663. sqlite3_int64 *piLast, /* OUT: Block id of last entry written */
  152664. char **paRoot, /* OUT: Data for root node */
  152665. int *pnRoot /* OUT: Size of root node in bytes */
  152666. ){
  152667. int rc = SQLITE_OK;
  152668. if( !pTree->pParent ){
  152669. /* Root node of the tree. */
  152670. int nStart = fts3TreeFinishNode(pTree, iHeight, iLeaf);
  152671. *piLast = iFree-1;
  152672. *pnRoot = pTree->nData - nStart;
  152673. *paRoot = &pTree->aData[nStart];
  152674. }else{
  152675. SegmentNode *pIter;
  152676. sqlite3_int64 iNextFree = iFree;
  152677. sqlite3_int64 iNextLeaf = iLeaf;
  152678. for(pIter=pTree->pLeftmost; pIter && rc==SQLITE_OK; pIter=pIter->pRight){
  152679. int nStart = fts3TreeFinishNode(pIter, iHeight, iNextLeaf);
  152680. int nWrite = pIter->nData - nStart;
  152681. rc = fts3WriteSegment(p, iNextFree, &pIter->aData[nStart], nWrite);
  152682. iNextFree++;
  152683. iNextLeaf += (pIter->nEntry+1);
  152684. }
  152685. if( rc==SQLITE_OK ){
  152686. assert( iNextLeaf==iFree );
  152687. rc = fts3NodeWrite(
  152688. p, pTree->pParent, iHeight+1, iFree, iNextFree, piLast, paRoot, pnRoot
  152689. );
  152690. }
  152691. }
  152692. return rc;
  152693. }
  152694. /*
  152695. ** Free all memory allocations associated with the tree pTree.
  152696. */
  152697. static void fts3NodeFree(SegmentNode *pTree){
  152698. if( pTree ){
  152699. SegmentNode *p = pTree->pLeftmost;
  152700. fts3NodeFree(p->pParent);
  152701. while( p ){
  152702. SegmentNode *pRight = p->pRight;
  152703. if( p->aData!=(char *)&p[1] ){
  152704. sqlite3_free(p->aData);
  152705. }
  152706. assert( pRight==0 || p->zMalloc==0 );
  152707. sqlite3_free(p->zMalloc);
  152708. sqlite3_free(p);
  152709. p = pRight;
  152710. }
  152711. }
  152712. }
  152713. /*
  152714. ** Add a term to the segment being constructed by the SegmentWriter object
  152715. ** *ppWriter. When adding the first term to a segment, *ppWriter should
  152716. ** be passed NULL. This function will allocate a new SegmentWriter object
  152717. ** and return it via the input/output variable *ppWriter in this case.
  152718. **
  152719. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code.
  152720. */
  152721. static int fts3SegWriterAdd(
  152722. Fts3Table *p, /* Virtual table handle */
  152723. SegmentWriter **ppWriter, /* IN/OUT: SegmentWriter handle */
  152724. int isCopyTerm, /* True if buffer zTerm must be copied */
  152725. const char *zTerm, /* Pointer to buffer containing term */
  152726. int nTerm, /* Size of term in bytes */
  152727. const char *aDoclist, /* Pointer to buffer containing doclist */
  152728. int nDoclist /* Size of doclist in bytes */
  152729. ){
  152730. int nPrefix; /* Size of term prefix in bytes */
  152731. int nSuffix; /* Size of term suffix in bytes */
  152732. int nReq; /* Number of bytes required on leaf page */
  152733. int nData;
  152734. SegmentWriter *pWriter = *ppWriter;
  152735. if( !pWriter ){
  152736. int rc;
  152737. sqlite3_stmt *pStmt;
  152738. /* Allocate the SegmentWriter structure */
  152739. pWriter = (SegmentWriter *)sqlite3_malloc(sizeof(SegmentWriter));
  152740. if( !pWriter ) return SQLITE_NOMEM;
  152741. memset(pWriter, 0, sizeof(SegmentWriter));
  152742. *ppWriter = pWriter;
  152743. /* Allocate a buffer in which to accumulate data */
  152744. pWriter->aData = (char *)sqlite3_malloc(p->nNodeSize);
  152745. if( !pWriter->aData ) return SQLITE_NOMEM;
  152746. pWriter->nSize = p->nNodeSize;
  152747. /* Find the next free blockid in the %_segments table */
  152748. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENTS_ID, &pStmt, 0);
  152749. if( rc!=SQLITE_OK ) return rc;
  152750. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  152751. pWriter->iFree = sqlite3_column_int64(pStmt, 0);
  152752. pWriter->iFirst = pWriter->iFree;
  152753. }
  152754. rc = sqlite3_reset(pStmt);
  152755. if( rc!=SQLITE_OK ) return rc;
  152756. }
  152757. nData = pWriter->nData;
  152758. nPrefix = fts3PrefixCompress(pWriter->zTerm, pWriter->nTerm, zTerm, nTerm);
  152759. nSuffix = nTerm-nPrefix;
  152760. /* Figure out how many bytes are required by this new entry */
  152761. nReq = sqlite3Fts3VarintLen(nPrefix) + /* varint containing prefix size */
  152762. sqlite3Fts3VarintLen(nSuffix) + /* varint containing suffix size */
  152763. nSuffix + /* Term suffix */
  152764. sqlite3Fts3VarintLen(nDoclist) + /* Size of doclist */
  152765. nDoclist; /* Doclist data */
  152766. if( nData>0 && nData+nReq>p->nNodeSize ){
  152767. int rc;
  152768. /* The current leaf node is full. Write it out to the database. */
  152769. rc = fts3WriteSegment(p, pWriter->iFree++, pWriter->aData, nData);
  152770. if( rc!=SQLITE_OK ) return rc;
  152771. p->nLeafAdd++;
  152772. /* Add the current term to the interior node tree. The term added to
  152773. ** the interior tree must:
  152774. **
  152775. ** a) be greater than the largest term on the leaf node just written
  152776. ** to the database (still available in pWriter->zTerm), and
  152777. **
  152778. ** b) be less than or equal to the term about to be added to the new
  152779. ** leaf node (zTerm/nTerm).
  152780. **
  152781. ** In other words, it must be the prefix of zTerm 1 byte longer than
  152782. ** the common prefix (if any) of zTerm and pWriter->zTerm.
  152783. */
  152784. assert( nPrefix<nTerm );
  152785. rc = fts3NodeAddTerm(p, &pWriter->pTree, isCopyTerm, zTerm, nPrefix+1);
  152786. if( rc!=SQLITE_OK ) return rc;
  152787. nData = 0;
  152788. pWriter->nTerm = 0;
  152789. nPrefix = 0;
  152790. nSuffix = nTerm;
  152791. nReq = 1 + /* varint containing prefix size */
  152792. sqlite3Fts3VarintLen(nTerm) + /* varint containing suffix size */
  152793. nTerm + /* Term suffix */
  152794. sqlite3Fts3VarintLen(nDoclist) + /* Size of doclist */
  152795. nDoclist; /* Doclist data */
  152796. }
  152797. /* Increase the total number of bytes written to account for the new entry. */
  152798. pWriter->nLeafData += nReq;
  152799. /* If the buffer currently allocated is too small for this entry, realloc
  152800. ** the buffer to make it large enough.
  152801. */
  152802. if( nReq>pWriter->nSize ){
  152803. char *aNew = sqlite3_realloc(pWriter->aData, nReq);
  152804. if( !aNew ) return SQLITE_NOMEM;
  152805. pWriter->aData = aNew;
  152806. pWriter->nSize = nReq;
  152807. }
  152808. assert( nData+nReq<=pWriter->nSize );
  152809. /* Append the prefix-compressed term and doclist to the buffer. */
  152810. nData += sqlite3Fts3PutVarint(&pWriter->aData[nData], nPrefix);
  152811. nData += sqlite3Fts3PutVarint(&pWriter->aData[nData], nSuffix);
  152812. memcpy(&pWriter->aData[nData], &zTerm[nPrefix], nSuffix);
  152813. nData += nSuffix;
  152814. nData += sqlite3Fts3PutVarint(&pWriter->aData[nData], nDoclist);
  152815. memcpy(&pWriter->aData[nData], aDoclist, nDoclist);
  152816. pWriter->nData = nData + nDoclist;
  152817. /* Save the current term so that it can be used to prefix-compress the next.
  152818. ** If the isCopyTerm parameter is true, then the buffer pointed to by
  152819. ** zTerm is transient, so take a copy of the term data. Otherwise, just
  152820. ** store a copy of the pointer.
  152821. */
  152822. if( isCopyTerm ){
  152823. if( nTerm>pWriter->nMalloc ){
  152824. char *zNew = sqlite3_realloc(pWriter->zMalloc, nTerm*2);
  152825. if( !zNew ){
  152826. return SQLITE_NOMEM;
  152827. }
  152828. pWriter->nMalloc = nTerm*2;
  152829. pWriter->zMalloc = zNew;
  152830. pWriter->zTerm = zNew;
  152831. }
  152832. assert( pWriter->zTerm==pWriter->zMalloc );
  152833. memcpy(pWriter->zTerm, zTerm, nTerm);
  152834. }else{
  152835. pWriter->zTerm = (char *)zTerm;
  152836. }
  152837. pWriter->nTerm = nTerm;
  152838. return SQLITE_OK;
  152839. }
  152840. /*
  152841. ** Flush all data associated with the SegmentWriter object pWriter to the
  152842. ** database. This function must be called after all terms have been added
  152843. ** to the segment using fts3SegWriterAdd(). If successful, SQLITE_OK is
  152844. ** returned. Otherwise, an SQLite error code.
  152845. */
  152846. static int fts3SegWriterFlush(
  152847. Fts3Table *p, /* Virtual table handle */
  152848. SegmentWriter *pWriter, /* SegmentWriter to flush to the db */
  152849. sqlite3_int64 iLevel, /* Value for 'level' column of %_segdir */
  152850. int iIdx /* Value for 'idx' column of %_segdir */
  152851. ){
  152852. int rc; /* Return code */
  152853. if( pWriter->pTree ){
  152854. sqlite3_int64 iLast = 0; /* Largest block id written to database */
  152855. sqlite3_int64 iLastLeaf; /* Largest leaf block id written to db */
  152856. char *zRoot = NULL; /* Pointer to buffer containing root node */
  152857. int nRoot = 0; /* Size of buffer zRoot */
  152858. iLastLeaf = pWriter->iFree;
  152859. rc = fts3WriteSegment(p, pWriter->iFree++, pWriter->aData, pWriter->nData);
  152860. if( rc==SQLITE_OK ){
  152861. rc = fts3NodeWrite(p, pWriter->pTree, 1,
  152862. pWriter->iFirst, pWriter->iFree, &iLast, &zRoot, &nRoot);
  152863. }
  152864. if( rc==SQLITE_OK ){
  152865. rc = fts3WriteSegdir(p, iLevel, iIdx,
  152866. pWriter->iFirst, iLastLeaf, iLast, pWriter->nLeafData, zRoot, nRoot);
  152867. }
  152868. }else{
  152869. /* The entire tree fits on the root node. Write it to the segdir table. */
  152870. rc = fts3WriteSegdir(p, iLevel, iIdx,
  152871. 0, 0, 0, pWriter->nLeafData, pWriter->aData, pWriter->nData);
  152872. }
  152873. p->nLeafAdd++;
  152874. return rc;
  152875. }
  152876. /*
  152877. ** Release all memory held by the SegmentWriter object passed as the
  152878. ** first argument.
  152879. */
  152880. static void fts3SegWriterFree(SegmentWriter *pWriter){
  152881. if( pWriter ){
  152882. sqlite3_free(pWriter->aData);
  152883. sqlite3_free(pWriter->zMalloc);
  152884. fts3NodeFree(pWriter->pTree);
  152885. sqlite3_free(pWriter);
  152886. }
  152887. }
  152888. /*
  152889. ** The first value in the apVal[] array is assumed to contain an integer.
  152890. ** This function tests if there exist any documents with docid values that
  152891. ** are different from that integer. i.e. if deleting the document with docid
  152892. ** pRowid would mean the FTS3 table were empty.
  152893. **
  152894. ** If successful, *pisEmpty is set to true if the table is empty except for
  152895. ** document pRowid, or false otherwise, and SQLITE_OK is returned. If an
  152896. ** error occurs, an SQLite error code is returned.
  152897. */
  152898. static int fts3IsEmpty(Fts3Table *p, sqlite3_value *pRowid, int *pisEmpty){
  152899. sqlite3_stmt *pStmt;
  152900. int rc;
  152901. if( p->zContentTbl ){
  152902. /* If using the content=xxx option, assume the table is never empty */
  152903. *pisEmpty = 0;
  152904. rc = SQLITE_OK;
  152905. }else{
  152906. rc = fts3SqlStmt(p, SQL_IS_EMPTY, &pStmt, &pRowid);
  152907. if( rc==SQLITE_OK ){
  152908. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  152909. *pisEmpty = sqlite3_column_int(pStmt, 0);
  152910. }
  152911. rc = sqlite3_reset(pStmt);
  152912. }
  152913. }
  152914. return rc;
  152915. }
  152916. /*
  152917. ** Set *pnMax to the largest segment level in the database for the index
  152918. ** iIndex.
  152919. **
  152920. ** Segment levels are stored in the 'level' column of the %_segdir table.
  152921. **
  152922. ** Return SQLITE_OK if successful, or an SQLite error code if not.
  152923. */
  152924. static int fts3SegmentMaxLevel(
  152925. Fts3Table *p,
  152926. int iLangid,
  152927. int iIndex,
  152928. sqlite3_int64 *pnMax
  152929. ){
  152930. sqlite3_stmt *pStmt;
  152931. int rc;
  152932. assert( iIndex>=0 && iIndex<p->nIndex );
  152933. /* Set pStmt to the compiled version of:
  152934. **
  152935. ** SELECT max(level) FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?
  152936. **
  152937. ** (1024 is actually the value of macro FTS3_SEGDIR_PREFIXLEVEL_STR).
  152938. */
  152939. rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR_MAX_LEVEL, &pStmt, 0);
  152940. if( rc!=SQLITE_OK ) return rc;
  152941. sqlite3_bind_int64(pStmt, 1, getAbsoluteLevel(p, iLangid, iIndex, 0));
  152942. sqlite3_bind_int64(pStmt, 2,
  152943. getAbsoluteLevel(p, iLangid, iIndex, FTS3_SEGDIR_MAXLEVEL-1)
  152944. );
  152945. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  152946. *pnMax = sqlite3_column_int64(pStmt, 0);
  152947. }
  152948. return sqlite3_reset(pStmt);
  152949. }
  152950. /*
  152951. ** iAbsLevel is an absolute level that may be assumed to exist within
  152952. ** the database. This function checks if it is the largest level number
  152953. ** within its index. Assuming no error occurs, *pbMax is set to 1 if
  152954. ** iAbsLevel is indeed the largest level, or 0 otherwise, and SQLITE_OK
  152955. ** is returned. If an error occurs, an error code is returned and the
  152956. ** final value of *pbMax is undefined.
  152957. */
  152958. static int fts3SegmentIsMaxLevel(Fts3Table *p, i64 iAbsLevel, int *pbMax){
  152959. /* Set pStmt to the compiled version of:
  152960. **
  152961. ** SELECT max(level) FROM %Q.'%q_segdir' WHERE level BETWEEN ? AND ?
  152962. **
  152963. ** (1024 is actually the value of macro FTS3_SEGDIR_PREFIXLEVEL_STR).
  152964. */
  152965. sqlite3_stmt *pStmt;
  152966. int rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR_MAX_LEVEL, &pStmt, 0);
  152967. if( rc!=SQLITE_OK ) return rc;
  152968. sqlite3_bind_int64(pStmt, 1, iAbsLevel+1);
  152969. sqlite3_bind_int64(pStmt, 2,
  152970. ((iAbsLevel/FTS3_SEGDIR_MAXLEVEL)+1) * FTS3_SEGDIR_MAXLEVEL
  152971. );
  152972. *pbMax = 0;
  152973. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  152974. *pbMax = sqlite3_column_type(pStmt, 0)==SQLITE_NULL;
  152975. }
  152976. return sqlite3_reset(pStmt);
  152977. }
  152978. /*
  152979. ** Delete all entries in the %_segments table associated with the segment
  152980. ** opened with seg-reader pSeg. This function does not affect the contents
  152981. ** of the %_segdir table.
  152982. */
  152983. static int fts3DeleteSegment(
  152984. Fts3Table *p, /* FTS table handle */
  152985. Fts3SegReader *pSeg /* Segment to delete */
  152986. ){
  152987. int rc = SQLITE_OK; /* Return code */
  152988. if( pSeg->iStartBlock ){
  152989. sqlite3_stmt *pDelete; /* SQL statement to delete rows */
  152990. rc = fts3SqlStmt(p, SQL_DELETE_SEGMENTS_RANGE, &pDelete, 0);
  152991. if( rc==SQLITE_OK ){
  152992. sqlite3_bind_int64(pDelete, 1, pSeg->iStartBlock);
  152993. sqlite3_bind_int64(pDelete, 2, pSeg->iEndBlock);
  152994. sqlite3_step(pDelete);
  152995. rc = sqlite3_reset(pDelete);
  152996. }
  152997. }
  152998. return rc;
  152999. }
  153000. /*
  153001. ** This function is used after merging multiple segments into a single large
  153002. ** segment to delete the old, now redundant, segment b-trees. Specifically,
  153003. ** it:
  153004. **
  153005. ** 1) Deletes all %_segments entries for the segments associated with
  153006. ** each of the SegReader objects in the array passed as the third
  153007. ** argument, and
  153008. **
  153009. ** 2) deletes all %_segdir entries with level iLevel, or all %_segdir
  153010. ** entries regardless of level if (iLevel<0).
  153011. **
  153012. ** SQLITE_OK is returned if successful, otherwise an SQLite error code.
  153013. */
  153014. static int fts3DeleteSegdir(
  153015. Fts3Table *p, /* Virtual table handle */
  153016. int iLangid, /* Language id */
  153017. int iIndex, /* Index for p->aIndex */
  153018. int iLevel, /* Level of %_segdir entries to delete */
  153019. Fts3SegReader **apSegment, /* Array of SegReader objects */
  153020. int nReader /* Size of array apSegment */
  153021. ){
  153022. int rc = SQLITE_OK; /* Return Code */
  153023. int i; /* Iterator variable */
  153024. sqlite3_stmt *pDelete = 0; /* SQL statement to delete rows */
  153025. for(i=0; rc==SQLITE_OK && i<nReader; i++){
  153026. rc = fts3DeleteSegment(p, apSegment[i]);
  153027. }
  153028. if( rc!=SQLITE_OK ){
  153029. return rc;
  153030. }
  153031. assert( iLevel>=0 || iLevel==FTS3_SEGCURSOR_ALL );
  153032. if( iLevel==FTS3_SEGCURSOR_ALL ){
  153033. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_RANGE, &pDelete, 0);
  153034. if( rc==SQLITE_OK ){
  153035. sqlite3_bind_int64(pDelete, 1, getAbsoluteLevel(p, iLangid, iIndex, 0));
  153036. sqlite3_bind_int64(pDelete, 2,
  153037. getAbsoluteLevel(p, iLangid, iIndex, FTS3_SEGDIR_MAXLEVEL-1)
  153038. );
  153039. }
  153040. }else{
  153041. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_LEVEL, &pDelete, 0);
  153042. if( rc==SQLITE_OK ){
  153043. sqlite3_bind_int64(
  153044. pDelete, 1, getAbsoluteLevel(p, iLangid, iIndex, iLevel)
  153045. );
  153046. }
  153047. }
  153048. if( rc==SQLITE_OK ){
  153049. sqlite3_step(pDelete);
  153050. rc = sqlite3_reset(pDelete);
  153051. }
  153052. return rc;
  153053. }
  153054. /*
  153055. ** When this function is called, buffer *ppList (size *pnList bytes) contains
  153056. ** a position list that may (or may not) feature multiple columns. This
  153057. ** function adjusts the pointer *ppList and the length *pnList so that they
  153058. ** identify the subset of the position list that corresponds to column iCol.
  153059. **
  153060. ** If there are no entries in the input position list for column iCol, then
  153061. ** *pnList is set to zero before returning.
  153062. **
  153063. ** If parameter bZero is non-zero, then any part of the input list following
  153064. ** the end of the output list is zeroed before returning.
  153065. */
  153066. static void fts3ColumnFilter(
  153067. int iCol, /* Column to filter on */
  153068. int bZero, /* Zero out anything following *ppList */
  153069. char **ppList, /* IN/OUT: Pointer to position list */
  153070. int *pnList /* IN/OUT: Size of buffer *ppList in bytes */
  153071. ){
  153072. char *pList = *ppList;
  153073. int nList = *pnList;
  153074. char *pEnd = &pList[nList];
  153075. int iCurrent = 0;
  153076. char *p = pList;
  153077. assert( iCol>=0 );
  153078. while( 1 ){
  153079. char c = 0;
  153080. while( p<pEnd && (c | *p)&0xFE ) c = *p++ & 0x80;
  153081. if( iCol==iCurrent ){
  153082. nList = (int)(p - pList);
  153083. break;
  153084. }
  153085. nList -= (int)(p - pList);
  153086. pList = p;
  153087. if( nList==0 ){
  153088. break;
  153089. }
  153090. p = &pList[1];
  153091. p += fts3GetVarint32(p, &iCurrent);
  153092. }
  153093. if( bZero && &pList[nList]!=pEnd ){
  153094. memset(&pList[nList], 0, pEnd - &pList[nList]);
  153095. }
  153096. *ppList = pList;
  153097. *pnList = nList;
  153098. }
  153099. /*
  153100. ** Cache data in the Fts3MultiSegReader.aBuffer[] buffer (overwriting any
  153101. ** existing data). Grow the buffer if required.
  153102. **
  153103. ** If successful, return SQLITE_OK. Otherwise, if an OOM error is encountered
  153104. ** trying to resize the buffer, return SQLITE_NOMEM.
  153105. */
  153106. static int fts3MsrBufferData(
  153107. Fts3MultiSegReader *pMsr, /* Multi-segment-reader handle */
  153108. char *pList,
  153109. int nList
  153110. ){
  153111. if( nList>pMsr->nBuffer ){
  153112. char *pNew;
  153113. pMsr->nBuffer = nList*2;
  153114. pNew = (char *)sqlite3_realloc(pMsr->aBuffer, pMsr->nBuffer);
  153115. if( !pNew ) return SQLITE_NOMEM;
  153116. pMsr->aBuffer = pNew;
  153117. }
  153118. memcpy(pMsr->aBuffer, pList, nList);
  153119. return SQLITE_OK;
  153120. }
  153121. SQLITE_PRIVATE int sqlite3Fts3MsrIncrNext(
  153122. Fts3Table *p, /* Virtual table handle */
  153123. Fts3MultiSegReader *pMsr, /* Multi-segment-reader handle */
  153124. sqlite3_int64 *piDocid, /* OUT: Docid value */
  153125. char **paPoslist, /* OUT: Pointer to position list */
  153126. int *pnPoslist /* OUT: Size of position list in bytes */
  153127. ){
  153128. int nMerge = pMsr->nAdvance;
  153129. Fts3SegReader **apSegment = pMsr->apSegment;
  153130. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) = (
  153131. p->bDescIdx ? fts3SegReaderDoclistCmpRev : fts3SegReaderDoclistCmp
  153132. );
  153133. if( nMerge==0 ){
  153134. *paPoslist = 0;
  153135. return SQLITE_OK;
  153136. }
  153137. while( 1 ){
  153138. Fts3SegReader *pSeg;
  153139. pSeg = pMsr->apSegment[0];
  153140. if( pSeg->pOffsetList==0 ){
  153141. *paPoslist = 0;
  153142. break;
  153143. }else{
  153144. int rc;
  153145. char *pList;
  153146. int nList;
  153147. int j;
  153148. sqlite3_int64 iDocid = apSegment[0]->iDocid;
  153149. rc = fts3SegReaderNextDocid(p, apSegment[0], &pList, &nList);
  153150. j = 1;
  153151. while( rc==SQLITE_OK
  153152. && j<nMerge
  153153. && apSegment[j]->pOffsetList
  153154. && apSegment[j]->iDocid==iDocid
  153155. ){
  153156. rc = fts3SegReaderNextDocid(p, apSegment[j], 0, 0);
  153157. j++;
  153158. }
  153159. if( rc!=SQLITE_OK ) return rc;
  153160. fts3SegReaderSort(pMsr->apSegment, nMerge, j, xCmp);
  153161. if( nList>0 && fts3SegReaderIsPending(apSegment[0]) ){
  153162. rc = fts3MsrBufferData(pMsr, pList, nList+1);
  153163. if( rc!=SQLITE_OK ) return rc;
  153164. assert( (pMsr->aBuffer[nList] & 0xFE)==0x00 );
  153165. pList = pMsr->aBuffer;
  153166. }
  153167. if( pMsr->iColFilter>=0 ){
  153168. fts3ColumnFilter(pMsr->iColFilter, 1, &pList, &nList);
  153169. }
  153170. if( nList>0 ){
  153171. *paPoslist = pList;
  153172. *piDocid = iDocid;
  153173. *pnPoslist = nList;
  153174. break;
  153175. }
  153176. }
  153177. }
  153178. return SQLITE_OK;
  153179. }
  153180. static int fts3SegReaderStart(
  153181. Fts3Table *p, /* Virtual table handle */
  153182. Fts3MultiSegReader *pCsr, /* Cursor object */
  153183. const char *zTerm, /* Term searched for (or NULL) */
  153184. int nTerm /* Length of zTerm in bytes */
  153185. ){
  153186. int i;
  153187. int nSeg = pCsr->nSegment;
  153188. /* If the Fts3SegFilter defines a specific term (or term prefix) to search
  153189. ** for, then advance each segment iterator until it points to a term of
  153190. ** equal or greater value than the specified term. This prevents many
  153191. ** unnecessary merge/sort operations for the case where single segment
  153192. ** b-tree leaf nodes contain more than one term.
  153193. */
  153194. for(i=0; pCsr->bRestart==0 && i<pCsr->nSegment; i++){
  153195. int res = 0;
  153196. Fts3SegReader *pSeg = pCsr->apSegment[i];
  153197. do {
  153198. int rc = fts3SegReaderNext(p, pSeg, 0);
  153199. if( rc!=SQLITE_OK ) return rc;
  153200. }while( zTerm && (res = fts3SegReaderTermCmp(pSeg, zTerm, nTerm))<0 );
  153201. if( pSeg->bLookup && res!=0 ){
  153202. fts3SegReaderSetEof(pSeg);
  153203. }
  153204. }
  153205. fts3SegReaderSort(pCsr->apSegment, nSeg, nSeg, fts3SegReaderCmp);
  153206. return SQLITE_OK;
  153207. }
  153208. SQLITE_PRIVATE int sqlite3Fts3SegReaderStart(
  153209. Fts3Table *p, /* Virtual table handle */
  153210. Fts3MultiSegReader *pCsr, /* Cursor object */
  153211. Fts3SegFilter *pFilter /* Restrictions on range of iteration */
  153212. ){
  153213. pCsr->pFilter = pFilter;
  153214. return fts3SegReaderStart(p, pCsr, pFilter->zTerm, pFilter->nTerm);
  153215. }
  153216. SQLITE_PRIVATE int sqlite3Fts3MsrIncrStart(
  153217. Fts3Table *p, /* Virtual table handle */
  153218. Fts3MultiSegReader *pCsr, /* Cursor object */
  153219. int iCol, /* Column to match on. */
  153220. const char *zTerm, /* Term to iterate through a doclist for */
  153221. int nTerm /* Number of bytes in zTerm */
  153222. ){
  153223. int i;
  153224. int rc;
  153225. int nSegment = pCsr->nSegment;
  153226. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) = (
  153227. p->bDescIdx ? fts3SegReaderDoclistCmpRev : fts3SegReaderDoclistCmp
  153228. );
  153229. assert( pCsr->pFilter==0 );
  153230. assert( zTerm && nTerm>0 );
  153231. /* Advance each segment iterator until it points to the term zTerm/nTerm. */
  153232. rc = fts3SegReaderStart(p, pCsr, zTerm, nTerm);
  153233. if( rc!=SQLITE_OK ) return rc;
  153234. /* Determine how many of the segments actually point to zTerm/nTerm. */
  153235. for(i=0; i<nSegment; i++){
  153236. Fts3SegReader *pSeg = pCsr->apSegment[i];
  153237. if( !pSeg->aNode || fts3SegReaderTermCmp(pSeg, zTerm, nTerm) ){
  153238. break;
  153239. }
  153240. }
  153241. pCsr->nAdvance = i;
  153242. /* Advance each of the segments to point to the first docid. */
  153243. for(i=0; i<pCsr->nAdvance; i++){
  153244. rc = fts3SegReaderFirstDocid(p, pCsr->apSegment[i]);
  153245. if( rc!=SQLITE_OK ) return rc;
  153246. }
  153247. fts3SegReaderSort(pCsr->apSegment, i, i, xCmp);
  153248. assert( iCol<0 || iCol<p->nColumn );
  153249. pCsr->iColFilter = iCol;
  153250. return SQLITE_OK;
  153251. }
  153252. /*
  153253. ** This function is called on a MultiSegReader that has been started using
  153254. ** sqlite3Fts3MsrIncrStart(). One or more calls to MsrIncrNext() may also
  153255. ** have been made. Calling this function puts the MultiSegReader in such
  153256. ** a state that if the next two calls are:
  153257. **
  153258. ** sqlite3Fts3SegReaderStart()
  153259. ** sqlite3Fts3SegReaderStep()
  153260. **
  153261. ** then the entire doclist for the term is available in
  153262. ** MultiSegReader.aDoclist/nDoclist.
  153263. */
  153264. SQLITE_PRIVATE int sqlite3Fts3MsrIncrRestart(Fts3MultiSegReader *pCsr){
  153265. int i; /* Used to iterate through segment-readers */
  153266. assert( pCsr->zTerm==0 );
  153267. assert( pCsr->nTerm==0 );
  153268. assert( pCsr->aDoclist==0 );
  153269. assert( pCsr->nDoclist==0 );
  153270. pCsr->nAdvance = 0;
  153271. pCsr->bRestart = 1;
  153272. for(i=0; i<pCsr->nSegment; i++){
  153273. pCsr->apSegment[i]->pOffsetList = 0;
  153274. pCsr->apSegment[i]->nOffsetList = 0;
  153275. pCsr->apSegment[i]->iDocid = 0;
  153276. }
  153277. return SQLITE_OK;
  153278. }
  153279. SQLITE_PRIVATE int sqlite3Fts3SegReaderStep(
  153280. Fts3Table *p, /* Virtual table handle */
  153281. Fts3MultiSegReader *pCsr /* Cursor object */
  153282. ){
  153283. int rc = SQLITE_OK;
  153284. int isIgnoreEmpty = (pCsr->pFilter->flags & FTS3_SEGMENT_IGNORE_EMPTY);
  153285. int isRequirePos = (pCsr->pFilter->flags & FTS3_SEGMENT_REQUIRE_POS);
  153286. int isColFilter = (pCsr->pFilter->flags & FTS3_SEGMENT_COLUMN_FILTER);
  153287. int isPrefix = (pCsr->pFilter->flags & FTS3_SEGMENT_PREFIX);
  153288. int isScan = (pCsr->pFilter->flags & FTS3_SEGMENT_SCAN);
  153289. int isFirst = (pCsr->pFilter->flags & FTS3_SEGMENT_FIRST);
  153290. Fts3SegReader **apSegment = pCsr->apSegment;
  153291. int nSegment = pCsr->nSegment;
  153292. Fts3SegFilter *pFilter = pCsr->pFilter;
  153293. int (*xCmp)(Fts3SegReader *, Fts3SegReader *) = (
  153294. p->bDescIdx ? fts3SegReaderDoclistCmpRev : fts3SegReaderDoclistCmp
  153295. );
  153296. if( pCsr->nSegment==0 ) return SQLITE_OK;
  153297. do {
  153298. int nMerge;
  153299. int i;
  153300. /* Advance the first pCsr->nAdvance entries in the apSegment[] array
  153301. ** forward. Then sort the list in order of current term again.
  153302. */
  153303. for(i=0; i<pCsr->nAdvance; i++){
  153304. Fts3SegReader *pSeg = apSegment[i];
  153305. if( pSeg->bLookup ){
  153306. fts3SegReaderSetEof(pSeg);
  153307. }else{
  153308. rc = fts3SegReaderNext(p, pSeg, 0);
  153309. }
  153310. if( rc!=SQLITE_OK ) return rc;
  153311. }
  153312. fts3SegReaderSort(apSegment, nSegment, pCsr->nAdvance, fts3SegReaderCmp);
  153313. pCsr->nAdvance = 0;
  153314. /* If all the seg-readers are at EOF, we're finished. return SQLITE_OK. */
  153315. assert( rc==SQLITE_OK );
  153316. if( apSegment[0]->aNode==0 ) break;
  153317. pCsr->nTerm = apSegment[0]->nTerm;
  153318. pCsr->zTerm = apSegment[0]->zTerm;
  153319. /* If this is a prefix-search, and if the term that apSegment[0] points
  153320. ** to does not share a suffix with pFilter->zTerm/nTerm, then all
  153321. ** required callbacks have been made. In this case exit early.
  153322. **
  153323. ** Similarly, if this is a search for an exact match, and the first term
  153324. ** of segment apSegment[0] is not a match, exit early.
  153325. */
  153326. if( pFilter->zTerm && !isScan ){
  153327. if( pCsr->nTerm<pFilter->nTerm
  153328. || (!isPrefix && pCsr->nTerm>pFilter->nTerm)
  153329. || memcmp(pCsr->zTerm, pFilter->zTerm, pFilter->nTerm)
  153330. ){
  153331. break;
  153332. }
  153333. }
  153334. nMerge = 1;
  153335. while( nMerge<nSegment
  153336. && apSegment[nMerge]->aNode
  153337. && apSegment[nMerge]->nTerm==pCsr->nTerm
  153338. && 0==memcmp(pCsr->zTerm, apSegment[nMerge]->zTerm, pCsr->nTerm)
  153339. ){
  153340. nMerge++;
  153341. }
  153342. assert( isIgnoreEmpty || (isRequirePos && !isColFilter) );
  153343. if( nMerge==1
  153344. && !isIgnoreEmpty
  153345. && !isFirst
  153346. && (p->bDescIdx==0 || fts3SegReaderIsPending(apSegment[0])==0)
  153347. ){
  153348. pCsr->nDoclist = apSegment[0]->nDoclist;
  153349. if( fts3SegReaderIsPending(apSegment[0]) ){
  153350. rc = fts3MsrBufferData(pCsr, apSegment[0]->aDoclist, pCsr->nDoclist);
  153351. pCsr->aDoclist = pCsr->aBuffer;
  153352. }else{
  153353. pCsr->aDoclist = apSegment[0]->aDoclist;
  153354. }
  153355. if( rc==SQLITE_OK ) rc = SQLITE_ROW;
  153356. }else{
  153357. int nDoclist = 0; /* Size of doclist */
  153358. sqlite3_int64 iPrev = 0; /* Previous docid stored in doclist */
  153359. /* The current term of the first nMerge entries in the array
  153360. ** of Fts3SegReader objects is the same. The doclists must be merged
  153361. ** and a single term returned with the merged doclist.
  153362. */
  153363. for(i=0; i<nMerge; i++){
  153364. fts3SegReaderFirstDocid(p, apSegment[i]);
  153365. }
  153366. fts3SegReaderSort(apSegment, nMerge, nMerge, xCmp);
  153367. while( apSegment[0]->pOffsetList ){
  153368. int j; /* Number of segments that share a docid */
  153369. char *pList = 0;
  153370. int nList = 0;
  153371. int nByte;
  153372. sqlite3_int64 iDocid = apSegment[0]->iDocid;
  153373. fts3SegReaderNextDocid(p, apSegment[0], &pList, &nList);
  153374. j = 1;
  153375. while( j<nMerge
  153376. && apSegment[j]->pOffsetList
  153377. && apSegment[j]->iDocid==iDocid
  153378. ){
  153379. fts3SegReaderNextDocid(p, apSegment[j], 0, 0);
  153380. j++;
  153381. }
  153382. if( isColFilter ){
  153383. fts3ColumnFilter(pFilter->iCol, 0, &pList, &nList);
  153384. }
  153385. if( !isIgnoreEmpty || nList>0 ){
  153386. /* Calculate the 'docid' delta value to write into the merged
  153387. ** doclist. */
  153388. sqlite3_int64 iDelta;
  153389. if( p->bDescIdx && nDoclist>0 ){
  153390. iDelta = iPrev - iDocid;
  153391. }else{
  153392. iDelta = iDocid - iPrev;
  153393. }
  153394. assert( iDelta>0 || (nDoclist==0 && iDelta==iDocid) );
  153395. assert( nDoclist>0 || iDelta==iDocid );
  153396. nByte = sqlite3Fts3VarintLen(iDelta) + (isRequirePos?nList+1:0);
  153397. if( nDoclist+nByte>pCsr->nBuffer ){
  153398. char *aNew;
  153399. pCsr->nBuffer = (nDoclist+nByte)*2;
  153400. aNew = sqlite3_realloc(pCsr->aBuffer, pCsr->nBuffer);
  153401. if( !aNew ){
  153402. return SQLITE_NOMEM;
  153403. }
  153404. pCsr->aBuffer = aNew;
  153405. }
  153406. if( isFirst ){
  153407. char *a = &pCsr->aBuffer[nDoclist];
  153408. int nWrite;
  153409. nWrite = sqlite3Fts3FirstFilter(iDelta, pList, nList, a);
  153410. if( nWrite ){
  153411. iPrev = iDocid;
  153412. nDoclist += nWrite;
  153413. }
  153414. }else{
  153415. nDoclist += sqlite3Fts3PutVarint(&pCsr->aBuffer[nDoclist], iDelta);
  153416. iPrev = iDocid;
  153417. if( isRequirePos ){
  153418. memcpy(&pCsr->aBuffer[nDoclist], pList, nList);
  153419. nDoclist += nList;
  153420. pCsr->aBuffer[nDoclist++] = '\0';
  153421. }
  153422. }
  153423. }
  153424. fts3SegReaderSort(apSegment, nMerge, j, xCmp);
  153425. }
  153426. if( nDoclist>0 ){
  153427. pCsr->aDoclist = pCsr->aBuffer;
  153428. pCsr->nDoclist = nDoclist;
  153429. rc = SQLITE_ROW;
  153430. }
  153431. }
  153432. pCsr->nAdvance = nMerge;
  153433. }while( rc==SQLITE_OK );
  153434. return rc;
  153435. }
  153436. SQLITE_PRIVATE void sqlite3Fts3SegReaderFinish(
  153437. Fts3MultiSegReader *pCsr /* Cursor object */
  153438. ){
  153439. if( pCsr ){
  153440. int i;
  153441. for(i=0; i<pCsr->nSegment; i++){
  153442. sqlite3Fts3SegReaderFree(pCsr->apSegment[i]);
  153443. }
  153444. sqlite3_free(pCsr->apSegment);
  153445. sqlite3_free(pCsr->aBuffer);
  153446. pCsr->nSegment = 0;
  153447. pCsr->apSegment = 0;
  153448. pCsr->aBuffer = 0;
  153449. }
  153450. }
  153451. /*
  153452. ** Decode the "end_block" field, selected by column iCol of the SELECT
  153453. ** statement passed as the first argument.
  153454. **
  153455. ** The "end_block" field may contain either an integer, or a text field
  153456. ** containing the text representation of two non-negative integers separated
  153457. ** by one or more space (0x20) characters. In the first case, set *piEndBlock
  153458. ** to the integer value and *pnByte to zero before returning. In the second,
  153459. ** set *piEndBlock to the first value and *pnByte to the second.
  153460. */
  153461. static void fts3ReadEndBlockField(
  153462. sqlite3_stmt *pStmt,
  153463. int iCol,
  153464. i64 *piEndBlock,
  153465. i64 *pnByte
  153466. ){
  153467. const unsigned char *zText = sqlite3_column_text(pStmt, iCol);
  153468. if( zText ){
  153469. int i;
  153470. int iMul = 1;
  153471. i64 iVal = 0;
  153472. for(i=0; zText[i]>='0' && zText[i]<='9'; i++){
  153473. iVal = iVal*10 + (zText[i] - '0');
  153474. }
  153475. *piEndBlock = iVal;
  153476. while( zText[i]==' ' ) i++;
  153477. iVal = 0;
  153478. if( zText[i]=='-' ){
  153479. i++;
  153480. iMul = -1;
  153481. }
  153482. for(/* no-op */; zText[i]>='0' && zText[i]<='9'; i++){
  153483. iVal = iVal*10 + (zText[i] - '0');
  153484. }
  153485. *pnByte = (iVal * (i64)iMul);
  153486. }
  153487. }
  153488. /*
  153489. ** A segment of size nByte bytes has just been written to absolute level
  153490. ** iAbsLevel. Promote any segments that should be promoted as a result.
  153491. */
  153492. static int fts3PromoteSegments(
  153493. Fts3Table *p, /* FTS table handle */
  153494. sqlite3_int64 iAbsLevel, /* Absolute level just updated */
  153495. sqlite3_int64 nByte /* Size of new segment at iAbsLevel */
  153496. ){
  153497. int rc = SQLITE_OK;
  153498. sqlite3_stmt *pRange;
  153499. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL_RANGE2, &pRange, 0);
  153500. if( rc==SQLITE_OK ){
  153501. int bOk = 0;
  153502. i64 iLast = (iAbsLevel/FTS3_SEGDIR_MAXLEVEL + 1) * FTS3_SEGDIR_MAXLEVEL - 1;
  153503. i64 nLimit = (nByte*3)/2;
  153504. /* Loop through all entries in the %_segdir table corresponding to
  153505. ** segments in this index on levels greater than iAbsLevel. If there is
  153506. ** at least one such segment, and it is possible to determine that all
  153507. ** such segments are smaller than nLimit bytes in size, they will be
  153508. ** promoted to level iAbsLevel. */
  153509. sqlite3_bind_int64(pRange, 1, iAbsLevel+1);
  153510. sqlite3_bind_int64(pRange, 2, iLast);
  153511. while( SQLITE_ROW==sqlite3_step(pRange) ){
  153512. i64 nSize = 0, dummy;
  153513. fts3ReadEndBlockField(pRange, 2, &dummy, &nSize);
  153514. if( nSize<=0 || nSize>nLimit ){
  153515. /* If nSize==0, then the %_segdir.end_block field does not not
  153516. ** contain a size value. This happens if it was written by an
  153517. ** old version of FTS. In this case it is not possible to determine
  153518. ** the size of the segment, and so segment promotion does not
  153519. ** take place. */
  153520. bOk = 0;
  153521. break;
  153522. }
  153523. bOk = 1;
  153524. }
  153525. rc = sqlite3_reset(pRange);
  153526. if( bOk ){
  153527. int iIdx = 0;
  153528. sqlite3_stmt *pUpdate1 = 0;
  153529. sqlite3_stmt *pUpdate2 = 0;
  153530. if( rc==SQLITE_OK ){
  153531. rc = fts3SqlStmt(p, SQL_UPDATE_LEVEL_IDX, &pUpdate1, 0);
  153532. }
  153533. if( rc==SQLITE_OK ){
  153534. rc = fts3SqlStmt(p, SQL_UPDATE_LEVEL, &pUpdate2, 0);
  153535. }
  153536. if( rc==SQLITE_OK ){
  153537. /* Loop through all %_segdir entries for segments in this index with
  153538. ** levels equal to or greater than iAbsLevel. As each entry is visited,
  153539. ** updated it to set (level = -1) and (idx = N), where N is 0 for the
  153540. ** oldest segment in the range, 1 for the next oldest, and so on.
  153541. **
  153542. ** In other words, move all segments being promoted to level -1,
  153543. ** setting the "idx" fields as appropriate to keep them in the same
  153544. ** order. The contents of level -1 (which is never used, except
  153545. ** transiently here), will be moved back to level iAbsLevel below. */
  153546. sqlite3_bind_int64(pRange, 1, iAbsLevel);
  153547. while( SQLITE_ROW==sqlite3_step(pRange) ){
  153548. sqlite3_bind_int(pUpdate1, 1, iIdx++);
  153549. sqlite3_bind_int(pUpdate1, 2, sqlite3_column_int(pRange, 0));
  153550. sqlite3_bind_int(pUpdate1, 3, sqlite3_column_int(pRange, 1));
  153551. sqlite3_step(pUpdate1);
  153552. rc = sqlite3_reset(pUpdate1);
  153553. if( rc!=SQLITE_OK ){
  153554. sqlite3_reset(pRange);
  153555. break;
  153556. }
  153557. }
  153558. }
  153559. if( rc==SQLITE_OK ){
  153560. rc = sqlite3_reset(pRange);
  153561. }
  153562. /* Move level -1 to level iAbsLevel */
  153563. if( rc==SQLITE_OK ){
  153564. sqlite3_bind_int64(pUpdate2, 1, iAbsLevel);
  153565. sqlite3_step(pUpdate2);
  153566. rc = sqlite3_reset(pUpdate2);
  153567. }
  153568. }
  153569. }
  153570. return rc;
  153571. }
  153572. /*
  153573. ** Merge all level iLevel segments in the database into a single
  153574. ** iLevel+1 segment. Or, if iLevel<0, merge all segments into a
  153575. ** single segment with a level equal to the numerically largest level
  153576. ** currently present in the database.
  153577. **
  153578. ** If this function is called with iLevel<0, but there is only one
  153579. ** segment in the database, SQLITE_DONE is returned immediately.
  153580. ** Otherwise, if successful, SQLITE_OK is returned. If an error occurs,
  153581. ** an SQLite error code is returned.
  153582. */
  153583. static int fts3SegmentMerge(
  153584. Fts3Table *p,
  153585. int iLangid, /* Language id to merge */
  153586. int iIndex, /* Index in p->aIndex[] to merge */
  153587. int iLevel /* Level to merge */
  153588. ){
  153589. int rc; /* Return code */
  153590. int iIdx = 0; /* Index of new segment */
  153591. sqlite3_int64 iNewLevel = 0; /* Level/index to create new segment at */
  153592. SegmentWriter *pWriter = 0; /* Used to write the new, merged, segment */
  153593. Fts3SegFilter filter; /* Segment term filter condition */
  153594. Fts3MultiSegReader csr; /* Cursor to iterate through level(s) */
  153595. int bIgnoreEmpty = 0; /* True to ignore empty segments */
  153596. i64 iMaxLevel = 0; /* Max level number for this index/langid */
  153597. assert( iLevel==FTS3_SEGCURSOR_ALL
  153598. || iLevel==FTS3_SEGCURSOR_PENDING
  153599. || iLevel>=0
  153600. );
  153601. assert( iLevel<FTS3_SEGDIR_MAXLEVEL );
  153602. assert( iIndex>=0 && iIndex<p->nIndex );
  153603. rc = sqlite3Fts3SegReaderCursor(p, iLangid, iIndex, iLevel, 0, 0, 1, 0, &csr);
  153604. if( rc!=SQLITE_OK || csr.nSegment==0 ) goto finished;
  153605. if( iLevel!=FTS3_SEGCURSOR_PENDING ){
  153606. rc = fts3SegmentMaxLevel(p, iLangid, iIndex, &iMaxLevel);
  153607. if( rc!=SQLITE_OK ) goto finished;
  153608. }
  153609. if( iLevel==FTS3_SEGCURSOR_ALL ){
  153610. /* This call is to merge all segments in the database to a single
  153611. ** segment. The level of the new segment is equal to the numerically
  153612. ** greatest segment level currently present in the database for this
  153613. ** index. The idx of the new segment is always 0. */
  153614. if( csr.nSegment==1 && 0==fts3SegReaderIsPending(csr.apSegment[0]) ){
  153615. rc = SQLITE_DONE;
  153616. goto finished;
  153617. }
  153618. iNewLevel = iMaxLevel;
  153619. bIgnoreEmpty = 1;
  153620. }else{
  153621. /* This call is to merge all segments at level iLevel. find the next
  153622. ** available segment index at level iLevel+1. The call to
  153623. ** fts3AllocateSegdirIdx() will merge the segments at level iLevel+1 to
  153624. ** a single iLevel+2 segment if necessary. */
  153625. assert( FTS3_SEGCURSOR_PENDING==-1 );
  153626. iNewLevel = getAbsoluteLevel(p, iLangid, iIndex, iLevel+1);
  153627. rc = fts3AllocateSegdirIdx(p, iLangid, iIndex, iLevel+1, &iIdx);
  153628. bIgnoreEmpty = (iLevel!=FTS3_SEGCURSOR_PENDING) && (iNewLevel>iMaxLevel);
  153629. }
  153630. if( rc!=SQLITE_OK ) goto finished;
  153631. assert( csr.nSegment>0 );
  153632. assert( iNewLevel>=getAbsoluteLevel(p, iLangid, iIndex, 0) );
  153633. assert( iNewLevel<getAbsoluteLevel(p, iLangid, iIndex,FTS3_SEGDIR_MAXLEVEL) );
  153634. memset(&filter, 0, sizeof(Fts3SegFilter));
  153635. filter.flags = FTS3_SEGMENT_REQUIRE_POS;
  153636. filter.flags |= (bIgnoreEmpty ? FTS3_SEGMENT_IGNORE_EMPTY : 0);
  153637. rc = sqlite3Fts3SegReaderStart(p, &csr, &filter);
  153638. while( SQLITE_OK==rc ){
  153639. rc = sqlite3Fts3SegReaderStep(p, &csr);
  153640. if( rc!=SQLITE_ROW ) break;
  153641. rc = fts3SegWriterAdd(p, &pWriter, 1,
  153642. csr.zTerm, csr.nTerm, csr.aDoclist, csr.nDoclist);
  153643. }
  153644. if( rc!=SQLITE_OK ) goto finished;
  153645. assert( pWriter || bIgnoreEmpty );
  153646. if( iLevel!=FTS3_SEGCURSOR_PENDING ){
  153647. rc = fts3DeleteSegdir(
  153648. p, iLangid, iIndex, iLevel, csr.apSegment, csr.nSegment
  153649. );
  153650. if( rc!=SQLITE_OK ) goto finished;
  153651. }
  153652. if( pWriter ){
  153653. rc = fts3SegWriterFlush(p, pWriter, iNewLevel, iIdx);
  153654. if( rc==SQLITE_OK ){
  153655. if( iLevel==FTS3_SEGCURSOR_PENDING || iNewLevel<iMaxLevel ){
  153656. rc = fts3PromoteSegments(p, iNewLevel, pWriter->nLeafData);
  153657. }
  153658. }
  153659. }
  153660. finished:
  153661. fts3SegWriterFree(pWriter);
  153662. sqlite3Fts3SegReaderFinish(&csr);
  153663. return rc;
  153664. }
  153665. /*
  153666. ** Flush the contents of pendingTerms to level 0 segments.
  153667. */
  153668. SQLITE_PRIVATE int sqlite3Fts3PendingTermsFlush(Fts3Table *p){
  153669. int rc = SQLITE_OK;
  153670. int i;
  153671. for(i=0; rc==SQLITE_OK && i<p->nIndex; i++){
  153672. rc = fts3SegmentMerge(p, p->iPrevLangid, i, FTS3_SEGCURSOR_PENDING);
  153673. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  153674. }
  153675. sqlite3Fts3PendingTermsClear(p);
  153676. /* Determine the auto-incr-merge setting if unknown. If enabled,
  153677. ** estimate the number of leaf blocks of content to be written
  153678. */
  153679. if( rc==SQLITE_OK && p->bHasStat
  153680. && p->nAutoincrmerge==0xff && p->nLeafAdd>0
  153681. ){
  153682. sqlite3_stmt *pStmt = 0;
  153683. rc = fts3SqlStmt(p, SQL_SELECT_STAT, &pStmt, 0);
  153684. if( rc==SQLITE_OK ){
  153685. sqlite3_bind_int(pStmt, 1, FTS_STAT_AUTOINCRMERGE);
  153686. rc = sqlite3_step(pStmt);
  153687. if( rc==SQLITE_ROW ){
  153688. p->nAutoincrmerge = sqlite3_column_int(pStmt, 0);
  153689. if( p->nAutoincrmerge==1 ) p->nAutoincrmerge = 8;
  153690. }else if( rc==SQLITE_DONE ){
  153691. p->nAutoincrmerge = 0;
  153692. }
  153693. rc = sqlite3_reset(pStmt);
  153694. }
  153695. }
  153696. return rc;
  153697. }
  153698. /*
  153699. ** Encode N integers as varints into a blob.
  153700. */
  153701. static void fts3EncodeIntArray(
  153702. int N, /* The number of integers to encode */
  153703. u32 *a, /* The integer values */
  153704. char *zBuf, /* Write the BLOB here */
  153705. int *pNBuf /* Write number of bytes if zBuf[] used here */
  153706. ){
  153707. int i, j;
  153708. for(i=j=0; i<N; i++){
  153709. j += sqlite3Fts3PutVarint(&zBuf[j], (sqlite3_int64)a[i]);
  153710. }
  153711. *pNBuf = j;
  153712. }
  153713. /*
  153714. ** Decode a blob of varints into N integers
  153715. */
  153716. static void fts3DecodeIntArray(
  153717. int N, /* The number of integers to decode */
  153718. u32 *a, /* Write the integer values */
  153719. const char *zBuf, /* The BLOB containing the varints */
  153720. int nBuf /* size of the BLOB */
  153721. ){
  153722. int i, j;
  153723. UNUSED_PARAMETER(nBuf);
  153724. for(i=j=0; i<N; i++){
  153725. sqlite3_int64 x;
  153726. j += sqlite3Fts3GetVarint(&zBuf[j], &x);
  153727. assert(j<=nBuf);
  153728. a[i] = (u32)(x & 0xffffffff);
  153729. }
  153730. }
  153731. /*
  153732. ** Insert the sizes (in tokens) for each column of the document
  153733. ** with docid equal to p->iPrevDocid. The sizes are encoded as
  153734. ** a blob of varints.
  153735. */
  153736. static void fts3InsertDocsize(
  153737. int *pRC, /* Result code */
  153738. Fts3Table *p, /* Table into which to insert */
  153739. u32 *aSz /* Sizes of each column, in tokens */
  153740. ){
  153741. char *pBlob; /* The BLOB encoding of the document size */
  153742. int nBlob; /* Number of bytes in the BLOB */
  153743. sqlite3_stmt *pStmt; /* Statement used to insert the encoding */
  153744. int rc; /* Result code from subfunctions */
  153745. if( *pRC ) return;
  153746. pBlob = sqlite3_malloc( 10*p->nColumn );
  153747. if( pBlob==0 ){
  153748. *pRC = SQLITE_NOMEM;
  153749. return;
  153750. }
  153751. fts3EncodeIntArray(p->nColumn, aSz, pBlob, &nBlob);
  153752. rc = fts3SqlStmt(p, SQL_REPLACE_DOCSIZE, &pStmt, 0);
  153753. if( rc ){
  153754. sqlite3_free(pBlob);
  153755. *pRC = rc;
  153756. return;
  153757. }
  153758. sqlite3_bind_int64(pStmt, 1, p->iPrevDocid);
  153759. sqlite3_bind_blob(pStmt, 2, pBlob, nBlob, sqlite3_free);
  153760. sqlite3_step(pStmt);
  153761. *pRC = sqlite3_reset(pStmt);
  153762. }
  153763. /*
  153764. ** Record 0 of the %_stat table contains a blob consisting of N varints,
  153765. ** where N is the number of user defined columns in the fts3 table plus
  153766. ** two. If nCol is the number of user defined columns, then values of the
  153767. ** varints are set as follows:
  153768. **
  153769. ** Varint 0: Total number of rows in the table.
  153770. **
  153771. ** Varint 1..nCol: For each column, the total number of tokens stored in
  153772. ** the column for all rows of the table.
  153773. **
  153774. ** Varint 1+nCol: The total size, in bytes, of all text values in all
  153775. ** columns of all rows of the table.
  153776. **
  153777. */
  153778. static void fts3UpdateDocTotals(
  153779. int *pRC, /* The result code */
  153780. Fts3Table *p, /* Table being updated */
  153781. u32 *aSzIns, /* Size increases */
  153782. u32 *aSzDel, /* Size decreases */
  153783. int nChng /* Change in the number of documents */
  153784. ){
  153785. char *pBlob; /* Storage for BLOB written into %_stat */
  153786. int nBlob; /* Size of BLOB written into %_stat */
  153787. u32 *a; /* Array of integers that becomes the BLOB */
  153788. sqlite3_stmt *pStmt; /* Statement for reading and writing */
  153789. int i; /* Loop counter */
  153790. int rc; /* Result code from subfunctions */
  153791. const int nStat = p->nColumn+2;
  153792. if( *pRC ) return;
  153793. a = sqlite3_malloc( (sizeof(u32)+10)*nStat );
  153794. if( a==0 ){
  153795. *pRC = SQLITE_NOMEM;
  153796. return;
  153797. }
  153798. pBlob = (char*)&a[nStat];
  153799. rc = fts3SqlStmt(p, SQL_SELECT_STAT, &pStmt, 0);
  153800. if( rc ){
  153801. sqlite3_free(a);
  153802. *pRC = rc;
  153803. return;
  153804. }
  153805. sqlite3_bind_int(pStmt, 1, FTS_STAT_DOCTOTAL);
  153806. if( sqlite3_step(pStmt)==SQLITE_ROW ){
  153807. fts3DecodeIntArray(nStat, a,
  153808. sqlite3_column_blob(pStmt, 0),
  153809. sqlite3_column_bytes(pStmt, 0));
  153810. }else{
  153811. memset(a, 0, sizeof(u32)*(nStat) );
  153812. }
  153813. rc = sqlite3_reset(pStmt);
  153814. if( rc!=SQLITE_OK ){
  153815. sqlite3_free(a);
  153816. *pRC = rc;
  153817. return;
  153818. }
  153819. if( nChng<0 && a[0]<(u32)(-nChng) ){
  153820. a[0] = 0;
  153821. }else{
  153822. a[0] += nChng;
  153823. }
  153824. for(i=0; i<p->nColumn+1; i++){
  153825. u32 x = a[i+1];
  153826. if( x+aSzIns[i] < aSzDel[i] ){
  153827. x = 0;
  153828. }else{
  153829. x = x + aSzIns[i] - aSzDel[i];
  153830. }
  153831. a[i+1] = x;
  153832. }
  153833. fts3EncodeIntArray(nStat, a, pBlob, &nBlob);
  153834. rc = fts3SqlStmt(p, SQL_REPLACE_STAT, &pStmt, 0);
  153835. if( rc ){
  153836. sqlite3_free(a);
  153837. *pRC = rc;
  153838. return;
  153839. }
  153840. sqlite3_bind_int(pStmt, 1, FTS_STAT_DOCTOTAL);
  153841. sqlite3_bind_blob(pStmt, 2, pBlob, nBlob, SQLITE_STATIC);
  153842. sqlite3_step(pStmt);
  153843. *pRC = sqlite3_reset(pStmt);
  153844. sqlite3_bind_null(pStmt, 2);
  153845. sqlite3_free(a);
  153846. }
  153847. /*
  153848. ** Merge the entire database so that there is one segment for each
  153849. ** iIndex/iLangid combination.
  153850. */
  153851. static int fts3DoOptimize(Fts3Table *p, int bReturnDone){
  153852. int bSeenDone = 0;
  153853. int rc;
  153854. sqlite3_stmt *pAllLangid = 0;
  153855. rc = fts3SqlStmt(p, SQL_SELECT_ALL_LANGID, &pAllLangid, 0);
  153856. if( rc==SQLITE_OK ){
  153857. int rc2;
  153858. sqlite3_bind_int(pAllLangid, 1, p->iPrevLangid);
  153859. sqlite3_bind_int(pAllLangid, 2, p->nIndex);
  153860. while( sqlite3_step(pAllLangid)==SQLITE_ROW ){
  153861. int i;
  153862. int iLangid = sqlite3_column_int(pAllLangid, 0);
  153863. for(i=0; rc==SQLITE_OK && i<p->nIndex; i++){
  153864. rc = fts3SegmentMerge(p, iLangid, i, FTS3_SEGCURSOR_ALL);
  153865. if( rc==SQLITE_DONE ){
  153866. bSeenDone = 1;
  153867. rc = SQLITE_OK;
  153868. }
  153869. }
  153870. }
  153871. rc2 = sqlite3_reset(pAllLangid);
  153872. if( rc==SQLITE_OK ) rc = rc2;
  153873. }
  153874. sqlite3Fts3SegmentsClose(p);
  153875. sqlite3Fts3PendingTermsClear(p);
  153876. return (rc==SQLITE_OK && bReturnDone && bSeenDone) ? SQLITE_DONE : rc;
  153877. }
  153878. /*
  153879. ** This function is called when the user executes the following statement:
  153880. **
  153881. ** INSERT INTO <tbl>(<tbl>) VALUES('rebuild');
  153882. **
  153883. ** The entire FTS index is discarded and rebuilt. If the table is one
  153884. ** created using the content=xxx option, then the new index is based on
  153885. ** the current contents of the xxx table. Otherwise, it is rebuilt based
  153886. ** on the contents of the %_content table.
  153887. */
  153888. static int fts3DoRebuild(Fts3Table *p){
  153889. int rc; /* Return Code */
  153890. rc = fts3DeleteAll(p, 0);
  153891. if( rc==SQLITE_OK ){
  153892. u32 *aSz = 0;
  153893. u32 *aSzIns = 0;
  153894. u32 *aSzDel = 0;
  153895. sqlite3_stmt *pStmt = 0;
  153896. int nEntry = 0;
  153897. /* Compose and prepare an SQL statement to loop through the content table */
  153898. char *zSql = sqlite3_mprintf("SELECT %s" , p->zReadExprlist);
  153899. if( !zSql ){
  153900. rc = SQLITE_NOMEM;
  153901. }else{
  153902. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pStmt, 0);
  153903. sqlite3_free(zSql);
  153904. }
  153905. if( rc==SQLITE_OK ){
  153906. int nByte = sizeof(u32) * (p->nColumn+1)*3;
  153907. aSz = (u32 *)sqlite3_malloc(nByte);
  153908. if( aSz==0 ){
  153909. rc = SQLITE_NOMEM;
  153910. }else{
  153911. memset(aSz, 0, nByte);
  153912. aSzIns = &aSz[p->nColumn+1];
  153913. aSzDel = &aSzIns[p->nColumn+1];
  153914. }
  153915. }
  153916. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  153917. int iCol;
  153918. int iLangid = langidFromSelect(p, pStmt);
  153919. rc = fts3PendingTermsDocid(p, 0, iLangid, sqlite3_column_int64(pStmt, 0));
  153920. memset(aSz, 0, sizeof(aSz[0]) * (p->nColumn+1));
  153921. for(iCol=0; rc==SQLITE_OK && iCol<p->nColumn; iCol++){
  153922. if( p->abNotindexed[iCol]==0 ){
  153923. const char *z = (const char *) sqlite3_column_text(pStmt, iCol+1);
  153924. rc = fts3PendingTermsAdd(p, iLangid, z, iCol, &aSz[iCol]);
  153925. aSz[p->nColumn] += sqlite3_column_bytes(pStmt, iCol+1);
  153926. }
  153927. }
  153928. if( p->bHasDocsize ){
  153929. fts3InsertDocsize(&rc, p, aSz);
  153930. }
  153931. if( rc!=SQLITE_OK ){
  153932. sqlite3_finalize(pStmt);
  153933. pStmt = 0;
  153934. }else{
  153935. nEntry++;
  153936. for(iCol=0; iCol<=p->nColumn; iCol++){
  153937. aSzIns[iCol] += aSz[iCol];
  153938. }
  153939. }
  153940. }
  153941. if( p->bFts4 ){
  153942. fts3UpdateDocTotals(&rc, p, aSzIns, aSzDel, nEntry);
  153943. }
  153944. sqlite3_free(aSz);
  153945. if( pStmt ){
  153946. int rc2 = sqlite3_finalize(pStmt);
  153947. if( rc==SQLITE_OK ){
  153948. rc = rc2;
  153949. }
  153950. }
  153951. }
  153952. return rc;
  153953. }
  153954. /*
  153955. ** This function opens a cursor used to read the input data for an
  153956. ** incremental merge operation. Specifically, it opens a cursor to scan
  153957. ** the oldest nSeg segments (idx=0 through idx=(nSeg-1)) in absolute
  153958. ** level iAbsLevel.
  153959. */
  153960. static int fts3IncrmergeCsr(
  153961. Fts3Table *p, /* FTS3 table handle */
  153962. sqlite3_int64 iAbsLevel, /* Absolute level to open */
  153963. int nSeg, /* Number of segments to merge */
  153964. Fts3MultiSegReader *pCsr /* Cursor object to populate */
  153965. ){
  153966. int rc; /* Return Code */
  153967. sqlite3_stmt *pStmt = 0; /* Statement used to read %_segdir entry */
  153968. int nByte; /* Bytes allocated at pCsr->apSegment[] */
  153969. /* Allocate space for the Fts3MultiSegReader.aCsr[] array */
  153970. memset(pCsr, 0, sizeof(*pCsr));
  153971. nByte = sizeof(Fts3SegReader *) * nSeg;
  153972. pCsr->apSegment = (Fts3SegReader **)sqlite3_malloc(nByte);
  153973. if( pCsr->apSegment==0 ){
  153974. rc = SQLITE_NOMEM;
  153975. }else{
  153976. memset(pCsr->apSegment, 0, nByte);
  153977. rc = fts3SqlStmt(p, SQL_SELECT_LEVEL, &pStmt, 0);
  153978. }
  153979. if( rc==SQLITE_OK ){
  153980. int i;
  153981. int rc2;
  153982. sqlite3_bind_int64(pStmt, 1, iAbsLevel);
  153983. assert( pCsr->nSegment==0 );
  153984. for(i=0; rc==SQLITE_OK && sqlite3_step(pStmt)==SQLITE_ROW && i<nSeg; i++){
  153985. rc = sqlite3Fts3SegReaderNew(i, 0,
  153986. sqlite3_column_int64(pStmt, 1), /* segdir.start_block */
  153987. sqlite3_column_int64(pStmt, 2), /* segdir.leaves_end_block */
  153988. sqlite3_column_int64(pStmt, 3), /* segdir.end_block */
  153989. sqlite3_column_blob(pStmt, 4), /* segdir.root */
  153990. sqlite3_column_bytes(pStmt, 4), /* segdir.root */
  153991. &pCsr->apSegment[i]
  153992. );
  153993. pCsr->nSegment++;
  153994. }
  153995. rc2 = sqlite3_reset(pStmt);
  153996. if( rc==SQLITE_OK ) rc = rc2;
  153997. }
  153998. return rc;
  153999. }
  154000. typedef struct IncrmergeWriter IncrmergeWriter;
  154001. typedef struct NodeWriter NodeWriter;
  154002. typedef struct Blob Blob;
  154003. typedef struct NodeReader NodeReader;
  154004. /*
  154005. ** An instance of the following structure is used as a dynamic buffer
  154006. ** to build up nodes or other blobs of data in.
  154007. **
  154008. ** The function blobGrowBuffer() is used to extend the allocation.
  154009. */
  154010. struct Blob {
  154011. char *a; /* Pointer to allocation */
  154012. int n; /* Number of valid bytes of data in a[] */
  154013. int nAlloc; /* Allocated size of a[] (nAlloc>=n) */
  154014. };
  154015. /*
  154016. ** This structure is used to build up buffers containing segment b-tree
  154017. ** nodes (blocks).
  154018. */
  154019. struct NodeWriter {
  154020. sqlite3_int64 iBlock; /* Current block id */
  154021. Blob key; /* Last key written to the current block */
  154022. Blob block; /* Current block image */
  154023. };
  154024. /*
  154025. ** An object of this type contains the state required to create or append
  154026. ** to an appendable b-tree segment.
  154027. */
  154028. struct IncrmergeWriter {
  154029. int nLeafEst; /* Space allocated for leaf blocks */
  154030. int nWork; /* Number of leaf pages flushed */
  154031. sqlite3_int64 iAbsLevel; /* Absolute level of input segments */
  154032. int iIdx; /* Index of *output* segment in iAbsLevel+1 */
  154033. sqlite3_int64 iStart; /* Block number of first allocated block */
  154034. sqlite3_int64 iEnd; /* Block number of last allocated block */
  154035. sqlite3_int64 nLeafData; /* Bytes of leaf page data so far */
  154036. u8 bNoLeafData; /* If true, store 0 for segment size */
  154037. NodeWriter aNodeWriter[FTS_MAX_APPENDABLE_HEIGHT];
  154038. };
  154039. /*
  154040. ** An object of the following type is used to read data from a single
  154041. ** FTS segment node. See the following functions:
  154042. **
  154043. ** nodeReaderInit()
  154044. ** nodeReaderNext()
  154045. ** nodeReaderRelease()
  154046. */
  154047. struct NodeReader {
  154048. const char *aNode;
  154049. int nNode;
  154050. int iOff; /* Current offset within aNode[] */
  154051. /* Output variables. Containing the current node entry. */
  154052. sqlite3_int64 iChild; /* Pointer to child node */
  154053. Blob term; /* Current term */
  154054. const char *aDoclist; /* Pointer to doclist */
  154055. int nDoclist; /* Size of doclist in bytes */
  154056. };
  154057. /*
  154058. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  154059. ** Otherwise, if the allocation at pBlob->a is not already at least nMin
  154060. ** bytes in size, extend (realloc) it to be so.
  154061. **
  154062. ** If an OOM error occurs, set *pRc to SQLITE_NOMEM and leave pBlob->a
  154063. ** unmodified. Otherwise, if the allocation succeeds, update pBlob->nAlloc
  154064. ** to reflect the new size of the pBlob->a[] buffer.
  154065. */
  154066. static void blobGrowBuffer(Blob *pBlob, int nMin, int *pRc){
  154067. if( *pRc==SQLITE_OK && nMin>pBlob->nAlloc ){
  154068. int nAlloc = nMin;
  154069. char *a = (char *)sqlite3_realloc(pBlob->a, nAlloc);
  154070. if( a ){
  154071. pBlob->nAlloc = nAlloc;
  154072. pBlob->a = a;
  154073. }else{
  154074. *pRc = SQLITE_NOMEM;
  154075. }
  154076. }
  154077. }
  154078. /*
  154079. ** Attempt to advance the node-reader object passed as the first argument to
  154080. ** the next entry on the node.
  154081. **
  154082. ** Return an error code if an error occurs (SQLITE_NOMEM is possible).
  154083. ** Otherwise return SQLITE_OK. If there is no next entry on the node
  154084. ** (e.g. because the current entry is the last) set NodeReader->aNode to
  154085. ** NULL to indicate EOF. Otherwise, populate the NodeReader structure output
  154086. ** variables for the new entry.
  154087. */
  154088. static int nodeReaderNext(NodeReader *p){
  154089. int bFirst = (p->term.n==0); /* True for first term on the node */
  154090. int nPrefix = 0; /* Bytes to copy from previous term */
  154091. int nSuffix = 0; /* Bytes to append to the prefix */
  154092. int rc = SQLITE_OK; /* Return code */
  154093. assert( p->aNode );
  154094. if( p->iChild && bFirst==0 ) p->iChild++;
  154095. if( p->iOff>=p->nNode ){
  154096. /* EOF */
  154097. p->aNode = 0;
  154098. }else{
  154099. if( bFirst==0 ){
  154100. p->iOff += fts3GetVarint32(&p->aNode[p->iOff], &nPrefix);
  154101. }
  154102. p->iOff += fts3GetVarint32(&p->aNode[p->iOff], &nSuffix);
  154103. blobGrowBuffer(&p->term, nPrefix+nSuffix, &rc);
  154104. if( rc==SQLITE_OK ){
  154105. memcpy(&p->term.a[nPrefix], &p->aNode[p->iOff], nSuffix);
  154106. p->term.n = nPrefix+nSuffix;
  154107. p->iOff += nSuffix;
  154108. if( p->iChild==0 ){
  154109. p->iOff += fts3GetVarint32(&p->aNode[p->iOff], &p->nDoclist);
  154110. p->aDoclist = &p->aNode[p->iOff];
  154111. p->iOff += p->nDoclist;
  154112. }
  154113. }
  154114. }
  154115. assert( p->iOff<=p->nNode );
  154116. return rc;
  154117. }
  154118. /*
  154119. ** Release all dynamic resources held by node-reader object *p.
  154120. */
  154121. static void nodeReaderRelease(NodeReader *p){
  154122. sqlite3_free(p->term.a);
  154123. }
  154124. /*
  154125. ** Initialize a node-reader object to read the node in buffer aNode/nNode.
  154126. **
  154127. ** If successful, SQLITE_OK is returned and the NodeReader object set to
  154128. ** point to the first entry on the node (if any). Otherwise, an SQLite
  154129. ** error code is returned.
  154130. */
  154131. static int nodeReaderInit(NodeReader *p, const char *aNode, int nNode){
  154132. memset(p, 0, sizeof(NodeReader));
  154133. p->aNode = aNode;
  154134. p->nNode = nNode;
  154135. /* Figure out if this is a leaf or an internal node. */
  154136. if( p->aNode[0] ){
  154137. /* An internal node. */
  154138. p->iOff = 1 + sqlite3Fts3GetVarint(&p->aNode[1], &p->iChild);
  154139. }else{
  154140. p->iOff = 1;
  154141. }
  154142. return nodeReaderNext(p);
  154143. }
  154144. /*
  154145. ** This function is called while writing an FTS segment each time a leaf o
  154146. ** node is finished and written to disk. The key (zTerm/nTerm) is guaranteed
  154147. ** to be greater than the largest key on the node just written, but smaller
  154148. ** than or equal to the first key that will be written to the next leaf
  154149. ** node.
  154150. **
  154151. ** The block id of the leaf node just written to disk may be found in
  154152. ** (pWriter->aNodeWriter[0].iBlock) when this function is called.
  154153. */
  154154. static int fts3IncrmergePush(
  154155. Fts3Table *p, /* Fts3 table handle */
  154156. IncrmergeWriter *pWriter, /* Writer object */
  154157. const char *zTerm, /* Term to write to internal node */
  154158. int nTerm /* Bytes at zTerm */
  154159. ){
  154160. sqlite3_int64 iPtr = pWriter->aNodeWriter[0].iBlock;
  154161. int iLayer;
  154162. assert( nTerm>0 );
  154163. for(iLayer=1; ALWAYS(iLayer<FTS_MAX_APPENDABLE_HEIGHT); iLayer++){
  154164. sqlite3_int64 iNextPtr = 0;
  154165. NodeWriter *pNode = &pWriter->aNodeWriter[iLayer];
  154166. int rc = SQLITE_OK;
  154167. int nPrefix;
  154168. int nSuffix;
  154169. int nSpace;
  154170. /* Figure out how much space the key will consume if it is written to
  154171. ** the current node of layer iLayer. Due to the prefix compression,
  154172. ** the space required changes depending on which node the key is to
  154173. ** be added to. */
  154174. nPrefix = fts3PrefixCompress(pNode->key.a, pNode->key.n, zTerm, nTerm);
  154175. nSuffix = nTerm - nPrefix;
  154176. nSpace = sqlite3Fts3VarintLen(nPrefix);
  154177. nSpace += sqlite3Fts3VarintLen(nSuffix) + nSuffix;
  154178. if( pNode->key.n==0 || (pNode->block.n + nSpace)<=p->nNodeSize ){
  154179. /* If the current node of layer iLayer contains zero keys, or if adding
  154180. ** the key to it will not cause it to grow to larger than nNodeSize
  154181. ** bytes in size, write the key here. */
  154182. Blob *pBlk = &pNode->block;
  154183. if( pBlk->n==0 ){
  154184. blobGrowBuffer(pBlk, p->nNodeSize, &rc);
  154185. if( rc==SQLITE_OK ){
  154186. pBlk->a[0] = (char)iLayer;
  154187. pBlk->n = 1 + sqlite3Fts3PutVarint(&pBlk->a[1], iPtr);
  154188. }
  154189. }
  154190. blobGrowBuffer(pBlk, pBlk->n + nSpace, &rc);
  154191. blobGrowBuffer(&pNode->key, nTerm, &rc);
  154192. if( rc==SQLITE_OK ){
  154193. if( pNode->key.n ){
  154194. pBlk->n += sqlite3Fts3PutVarint(&pBlk->a[pBlk->n], nPrefix);
  154195. }
  154196. pBlk->n += sqlite3Fts3PutVarint(&pBlk->a[pBlk->n], nSuffix);
  154197. memcpy(&pBlk->a[pBlk->n], &zTerm[nPrefix], nSuffix);
  154198. pBlk->n += nSuffix;
  154199. memcpy(pNode->key.a, zTerm, nTerm);
  154200. pNode->key.n = nTerm;
  154201. }
  154202. }else{
  154203. /* Otherwise, flush the current node of layer iLayer to disk.
  154204. ** Then allocate a new, empty sibling node. The key will be written
  154205. ** into the parent of this node. */
  154206. rc = fts3WriteSegment(p, pNode->iBlock, pNode->block.a, pNode->block.n);
  154207. assert( pNode->block.nAlloc>=p->nNodeSize );
  154208. pNode->block.a[0] = (char)iLayer;
  154209. pNode->block.n = 1 + sqlite3Fts3PutVarint(&pNode->block.a[1], iPtr+1);
  154210. iNextPtr = pNode->iBlock;
  154211. pNode->iBlock++;
  154212. pNode->key.n = 0;
  154213. }
  154214. if( rc!=SQLITE_OK || iNextPtr==0 ) return rc;
  154215. iPtr = iNextPtr;
  154216. }
  154217. assert( 0 );
  154218. return 0;
  154219. }
  154220. /*
  154221. ** Append a term and (optionally) doclist to the FTS segment node currently
  154222. ** stored in blob *pNode. The node need not contain any terms, but the
  154223. ** header must be written before this function is called.
  154224. **
  154225. ** A node header is a single 0x00 byte for a leaf node, or a height varint
  154226. ** followed by the left-hand-child varint for an internal node.
  154227. **
  154228. ** The term to be appended is passed via arguments zTerm/nTerm. For a
  154229. ** leaf node, the doclist is passed as aDoclist/nDoclist. For an internal
  154230. ** node, both aDoclist and nDoclist must be passed 0.
  154231. **
  154232. ** If the size of the value in blob pPrev is zero, then this is the first
  154233. ** term written to the node. Otherwise, pPrev contains a copy of the
  154234. ** previous term. Before this function returns, it is updated to contain a
  154235. ** copy of zTerm/nTerm.
  154236. **
  154237. ** It is assumed that the buffer associated with pNode is already large
  154238. ** enough to accommodate the new entry. The buffer associated with pPrev
  154239. ** is extended by this function if requrired.
  154240. **
  154241. ** If an error (i.e. OOM condition) occurs, an SQLite error code is
  154242. ** returned. Otherwise, SQLITE_OK.
  154243. */
  154244. static int fts3AppendToNode(
  154245. Blob *pNode, /* Current node image to append to */
  154246. Blob *pPrev, /* Buffer containing previous term written */
  154247. const char *zTerm, /* New term to write */
  154248. int nTerm, /* Size of zTerm in bytes */
  154249. const char *aDoclist, /* Doclist (or NULL) to write */
  154250. int nDoclist /* Size of aDoclist in bytes */
  154251. ){
  154252. int rc = SQLITE_OK; /* Return code */
  154253. int bFirst = (pPrev->n==0); /* True if this is the first term written */
  154254. int nPrefix; /* Size of term prefix in bytes */
  154255. int nSuffix; /* Size of term suffix in bytes */
  154256. /* Node must have already been started. There must be a doclist for a
  154257. ** leaf node, and there must not be a doclist for an internal node. */
  154258. assert( pNode->n>0 );
  154259. assert( (pNode->a[0]=='\0')==(aDoclist!=0) );
  154260. blobGrowBuffer(pPrev, nTerm, &rc);
  154261. if( rc!=SQLITE_OK ) return rc;
  154262. nPrefix = fts3PrefixCompress(pPrev->a, pPrev->n, zTerm, nTerm);
  154263. nSuffix = nTerm - nPrefix;
  154264. memcpy(pPrev->a, zTerm, nTerm);
  154265. pPrev->n = nTerm;
  154266. if( bFirst==0 ){
  154267. pNode->n += sqlite3Fts3PutVarint(&pNode->a[pNode->n], nPrefix);
  154268. }
  154269. pNode->n += sqlite3Fts3PutVarint(&pNode->a[pNode->n], nSuffix);
  154270. memcpy(&pNode->a[pNode->n], &zTerm[nPrefix], nSuffix);
  154271. pNode->n += nSuffix;
  154272. if( aDoclist ){
  154273. pNode->n += sqlite3Fts3PutVarint(&pNode->a[pNode->n], nDoclist);
  154274. memcpy(&pNode->a[pNode->n], aDoclist, nDoclist);
  154275. pNode->n += nDoclist;
  154276. }
  154277. assert( pNode->n<=pNode->nAlloc );
  154278. return SQLITE_OK;
  154279. }
  154280. /*
  154281. ** Append the current term and doclist pointed to by cursor pCsr to the
  154282. ** appendable b-tree segment opened for writing by pWriter.
  154283. **
  154284. ** Return SQLITE_OK if successful, or an SQLite error code otherwise.
  154285. */
  154286. static int fts3IncrmergeAppend(
  154287. Fts3Table *p, /* Fts3 table handle */
  154288. IncrmergeWriter *pWriter, /* Writer object */
  154289. Fts3MultiSegReader *pCsr /* Cursor containing term and doclist */
  154290. ){
  154291. const char *zTerm = pCsr->zTerm;
  154292. int nTerm = pCsr->nTerm;
  154293. const char *aDoclist = pCsr->aDoclist;
  154294. int nDoclist = pCsr->nDoclist;
  154295. int rc = SQLITE_OK; /* Return code */
  154296. int nSpace; /* Total space in bytes required on leaf */
  154297. int nPrefix; /* Size of prefix shared with previous term */
  154298. int nSuffix; /* Size of suffix (nTerm - nPrefix) */
  154299. NodeWriter *pLeaf; /* Object used to write leaf nodes */
  154300. pLeaf = &pWriter->aNodeWriter[0];
  154301. nPrefix = fts3PrefixCompress(pLeaf->key.a, pLeaf->key.n, zTerm, nTerm);
  154302. nSuffix = nTerm - nPrefix;
  154303. nSpace = sqlite3Fts3VarintLen(nPrefix);
  154304. nSpace += sqlite3Fts3VarintLen(nSuffix) + nSuffix;
  154305. nSpace += sqlite3Fts3VarintLen(nDoclist) + nDoclist;
  154306. /* If the current block is not empty, and if adding this term/doclist
  154307. ** to the current block would make it larger than Fts3Table.nNodeSize
  154308. ** bytes, write this block out to the database. */
  154309. if( pLeaf->block.n>0 && (pLeaf->block.n + nSpace)>p->nNodeSize ){
  154310. rc = fts3WriteSegment(p, pLeaf->iBlock, pLeaf->block.a, pLeaf->block.n);
  154311. pWriter->nWork++;
  154312. /* Add the current term to the parent node. The term added to the
  154313. ** parent must:
  154314. **
  154315. ** a) be greater than the largest term on the leaf node just written
  154316. ** to the database (still available in pLeaf->key), and
  154317. **
  154318. ** b) be less than or equal to the term about to be added to the new
  154319. ** leaf node (zTerm/nTerm).
  154320. **
  154321. ** In other words, it must be the prefix of zTerm 1 byte longer than
  154322. ** the common prefix (if any) of zTerm and pWriter->zTerm.
  154323. */
  154324. if( rc==SQLITE_OK ){
  154325. rc = fts3IncrmergePush(p, pWriter, zTerm, nPrefix+1);
  154326. }
  154327. /* Advance to the next output block */
  154328. pLeaf->iBlock++;
  154329. pLeaf->key.n = 0;
  154330. pLeaf->block.n = 0;
  154331. nSuffix = nTerm;
  154332. nSpace = 1;
  154333. nSpace += sqlite3Fts3VarintLen(nSuffix) + nSuffix;
  154334. nSpace += sqlite3Fts3VarintLen(nDoclist) + nDoclist;
  154335. }
  154336. pWriter->nLeafData += nSpace;
  154337. blobGrowBuffer(&pLeaf->block, pLeaf->block.n + nSpace, &rc);
  154338. if( rc==SQLITE_OK ){
  154339. if( pLeaf->block.n==0 ){
  154340. pLeaf->block.n = 1;
  154341. pLeaf->block.a[0] = '\0';
  154342. }
  154343. rc = fts3AppendToNode(
  154344. &pLeaf->block, &pLeaf->key, zTerm, nTerm, aDoclist, nDoclist
  154345. );
  154346. }
  154347. return rc;
  154348. }
  154349. /*
  154350. ** This function is called to release all dynamic resources held by the
  154351. ** merge-writer object pWriter, and if no error has occurred, to flush
  154352. ** all outstanding node buffers held by pWriter to disk.
  154353. **
  154354. ** If *pRc is not SQLITE_OK when this function is called, then no attempt
  154355. ** is made to write any data to disk. Instead, this function serves only
  154356. ** to release outstanding resources.
  154357. **
  154358. ** Otherwise, if *pRc is initially SQLITE_OK and an error occurs while
  154359. ** flushing buffers to disk, *pRc is set to an SQLite error code before
  154360. ** returning.
  154361. */
  154362. static void fts3IncrmergeRelease(
  154363. Fts3Table *p, /* FTS3 table handle */
  154364. IncrmergeWriter *pWriter, /* Merge-writer object */
  154365. int *pRc /* IN/OUT: Error code */
  154366. ){
  154367. int i; /* Used to iterate through non-root layers */
  154368. int iRoot; /* Index of root in pWriter->aNodeWriter */
  154369. NodeWriter *pRoot; /* NodeWriter for root node */
  154370. int rc = *pRc; /* Error code */
  154371. /* Set iRoot to the index in pWriter->aNodeWriter[] of the output segment
  154372. ** root node. If the segment fits entirely on a single leaf node, iRoot
  154373. ** will be set to 0. If the root node is the parent of the leaves, iRoot
  154374. ** will be 1. And so on. */
  154375. for(iRoot=FTS_MAX_APPENDABLE_HEIGHT-1; iRoot>=0; iRoot--){
  154376. NodeWriter *pNode = &pWriter->aNodeWriter[iRoot];
  154377. if( pNode->block.n>0 ) break;
  154378. assert( *pRc || pNode->block.nAlloc==0 );
  154379. assert( *pRc || pNode->key.nAlloc==0 );
  154380. sqlite3_free(pNode->block.a);
  154381. sqlite3_free(pNode->key.a);
  154382. }
  154383. /* Empty output segment. This is a no-op. */
  154384. if( iRoot<0 ) return;
  154385. /* The entire output segment fits on a single node. Normally, this means
  154386. ** the node would be stored as a blob in the "root" column of the %_segdir
  154387. ** table. However, this is not permitted in this case. The problem is that
  154388. ** space has already been reserved in the %_segments table, and so the
  154389. ** start_block and end_block fields of the %_segdir table must be populated.
  154390. ** And, by design or by accident, released versions of FTS cannot handle
  154391. ** segments that fit entirely on the root node with start_block!=0.
  154392. **
  154393. ** Instead, create a synthetic root node that contains nothing but a
  154394. ** pointer to the single content node. So that the segment consists of a
  154395. ** single leaf and a single interior (root) node.
  154396. **
  154397. ** Todo: Better might be to defer allocating space in the %_segments
  154398. ** table until we are sure it is needed.
  154399. */
  154400. if( iRoot==0 ){
  154401. Blob *pBlock = &pWriter->aNodeWriter[1].block;
  154402. blobGrowBuffer(pBlock, 1 + FTS3_VARINT_MAX, &rc);
  154403. if( rc==SQLITE_OK ){
  154404. pBlock->a[0] = 0x01;
  154405. pBlock->n = 1 + sqlite3Fts3PutVarint(
  154406. &pBlock->a[1], pWriter->aNodeWriter[0].iBlock
  154407. );
  154408. }
  154409. iRoot = 1;
  154410. }
  154411. pRoot = &pWriter->aNodeWriter[iRoot];
  154412. /* Flush all currently outstanding nodes to disk. */
  154413. for(i=0; i<iRoot; i++){
  154414. NodeWriter *pNode = &pWriter->aNodeWriter[i];
  154415. if( pNode->block.n>0 && rc==SQLITE_OK ){
  154416. rc = fts3WriteSegment(p, pNode->iBlock, pNode->block.a, pNode->block.n);
  154417. }
  154418. sqlite3_free(pNode->block.a);
  154419. sqlite3_free(pNode->key.a);
  154420. }
  154421. /* Write the %_segdir record. */
  154422. if( rc==SQLITE_OK ){
  154423. rc = fts3WriteSegdir(p,
  154424. pWriter->iAbsLevel+1, /* level */
  154425. pWriter->iIdx, /* idx */
  154426. pWriter->iStart, /* start_block */
  154427. pWriter->aNodeWriter[0].iBlock, /* leaves_end_block */
  154428. pWriter->iEnd, /* end_block */
  154429. (pWriter->bNoLeafData==0 ? pWriter->nLeafData : 0), /* end_block */
  154430. pRoot->block.a, pRoot->block.n /* root */
  154431. );
  154432. }
  154433. sqlite3_free(pRoot->block.a);
  154434. sqlite3_free(pRoot->key.a);
  154435. *pRc = rc;
  154436. }
  154437. /*
  154438. ** Compare the term in buffer zLhs (size in bytes nLhs) with that in
  154439. ** zRhs (size in bytes nRhs) using memcmp. If one term is a prefix of
  154440. ** the other, it is considered to be smaller than the other.
  154441. **
  154442. ** Return -ve if zLhs is smaller than zRhs, 0 if it is equal, or +ve
  154443. ** if it is greater.
  154444. */
  154445. static int fts3TermCmp(
  154446. const char *zLhs, int nLhs, /* LHS of comparison */
  154447. const char *zRhs, int nRhs /* RHS of comparison */
  154448. ){
  154449. int nCmp = MIN(nLhs, nRhs);
  154450. int res;
  154451. res = memcmp(zLhs, zRhs, nCmp);
  154452. if( res==0 ) res = nLhs - nRhs;
  154453. return res;
  154454. }
  154455. /*
  154456. ** Query to see if the entry in the %_segments table with blockid iEnd is
  154457. ** NULL. If no error occurs and the entry is NULL, set *pbRes 1 before
  154458. ** returning. Otherwise, set *pbRes to 0.
  154459. **
  154460. ** Or, if an error occurs while querying the database, return an SQLite
  154461. ** error code. The final value of *pbRes is undefined in this case.
  154462. **
  154463. ** This is used to test if a segment is an "appendable" segment. If it
  154464. ** is, then a NULL entry has been inserted into the %_segments table
  154465. ** with blockid %_segdir.end_block.
  154466. */
  154467. static int fts3IsAppendable(Fts3Table *p, sqlite3_int64 iEnd, int *pbRes){
  154468. int bRes = 0; /* Result to set *pbRes to */
  154469. sqlite3_stmt *pCheck = 0; /* Statement to query database with */
  154470. int rc; /* Return code */
  154471. rc = fts3SqlStmt(p, SQL_SEGMENT_IS_APPENDABLE, &pCheck, 0);
  154472. if( rc==SQLITE_OK ){
  154473. sqlite3_bind_int64(pCheck, 1, iEnd);
  154474. if( SQLITE_ROW==sqlite3_step(pCheck) ) bRes = 1;
  154475. rc = sqlite3_reset(pCheck);
  154476. }
  154477. *pbRes = bRes;
  154478. return rc;
  154479. }
  154480. /*
  154481. ** This function is called when initializing an incremental-merge operation.
  154482. ** It checks if the existing segment with index value iIdx at absolute level
  154483. ** (iAbsLevel+1) can be appended to by the incremental merge. If it can, the
  154484. ** merge-writer object *pWriter is initialized to write to it.
  154485. **
  154486. ** An existing segment can be appended to by an incremental merge if:
  154487. **
  154488. ** * It was initially created as an appendable segment (with all required
  154489. ** space pre-allocated), and
  154490. **
  154491. ** * The first key read from the input (arguments zKey and nKey) is
  154492. ** greater than the largest key currently stored in the potential
  154493. ** output segment.
  154494. */
  154495. static int fts3IncrmergeLoad(
  154496. Fts3Table *p, /* Fts3 table handle */
  154497. sqlite3_int64 iAbsLevel, /* Absolute level of input segments */
  154498. int iIdx, /* Index of candidate output segment */
  154499. const char *zKey, /* First key to write */
  154500. int nKey, /* Number of bytes in nKey */
  154501. IncrmergeWriter *pWriter /* Populate this object */
  154502. ){
  154503. int rc; /* Return code */
  154504. sqlite3_stmt *pSelect = 0; /* SELECT to read %_segdir entry */
  154505. rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR, &pSelect, 0);
  154506. if( rc==SQLITE_OK ){
  154507. sqlite3_int64 iStart = 0; /* Value of %_segdir.start_block */
  154508. sqlite3_int64 iLeafEnd = 0; /* Value of %_segdir.leaves_end_block */
  154509. sqlite3_int64 iEnd = 0; /* Value of %_segdir.end_block */
  154510. const char *aRoot = 0; /* Pointer to %_segdir.root buffer */
  154511. int nRoot = 0; /* Size of aRoot[] in bytes */
  154512. int rc2; /* Return code from sqlite3_reset() */
  154513. int bAppendable = 0; /* Set to true if segment is appendable */
  154514. /* Read the %_segdir entry for index iIdx absolute level (iAbsLevel+1) */
  154515. sqlite3_bind_int64(pSelect, 1, iAbsLevel+1);
  154516. sqlite3_bind_int(pSelect, 2, iIdx);
  154517. if( sqlite3_step(pSelect)==SQLITE_ROW ){
  154518. iStart = sqlite3_column_int64(pSelect, 1);
  154519. iLeafEnd = sqlite3_column_int64(pSelect, 2);
  154520. fts3ReadEndBlockField(pSelect, 3, &iEnd, &pWriter->nLeafData);
  154521. if( pWriter->nLeafData<0 ){
  154522. pWriter->nLeafData = pWriter->nLeafData * -1;
  154523. }
  154524. pWriter->bNoLeafData = (pWriter->nLeafData==0);
  154525. nRoot = sqlite3_column_bytes(pSelect, 4);
  154526. aRoot = sqlite3_column_blob(pSelect, 4);
  154527. }else{
  154528. return sqlite3_reset(pSelect);
  154529. }
  154530. /* Check for the zero-length marker in the %_segments table */
  154531. rc = fts3IsAppendable(p, iEnd, &bAppendable);
  154532. /* Check that zKey/nKey is larger than the largest key the candidate */
  154533. if( rc==SQLITE_OK && bAppendable ){
  154534. char *aLeaf = 0;
  154535. int nLeaf = 0;
  154536. rc = sqlite3Fts3ReadBlock(p, iLeafEnd, &aLeaf, &nLeaf, 0);
  154537. if( rc==SQLITE_OK ){
  154538. NodeReader reader;
  154539. for(rc = nodeReaderInit(&reader, aLeaf, nLeaf);
  154540. rc==SQLITE_OK && reader.aNode;
  154541. rc = nodeReaderNext(&reader)
  154542. ){
  154543. assert( reader.aNode );
  154544. }
  154545. if( fts3TermCmp(zKey, nKey, reader.term.a, reader.term.n)<=0 ){
  154546. bAppendable = 0;
  154547. }
  154548. nodeReaderRelease(&reader);
  154549. }
  154550. sqlite3_free(aLeaf);
  154551. }
  154552. if( rc==SQLITE_OK && bAppendable ){
  154553. /* It is possible to append to this segment. Set up the IncrmergeWriter
  154554. ** object to do so. */
  154555. int i;
  154556. int nHeight = (int)aRoot[0];
  154557. NodeWriter *pNode;
  154558. pWriter->nLeafEst = (int)((iEnd - iStart) + 1)/FTS_MAX_APPENDABLE_HEIGHT;
  154559. pWriter->iStart = iStart;
  154560. pWriter->iEnd = iEnd;
  154561. pWriter->iAbsLevel = iAbsLevel;
  154562. pWriter->iIdx = iIdx;
  154563. for(i=nHeight+1; i<FTS_MAX_APPENDABLE_HEIGHT; i++){
  154564. pWriter->aNodeWriter[i].iBlock = pWriter->iStart + i*pWriter->nLeafEst;
  154565. }
  154566. pNode = &pWriter->aNodeWriter[nHeight];
  154567. pNode->iBlock = pWriter->iStart + pWriter->nLeafEst*nHeight;
  154568. blobGrowBuffer(&pNode->block, MAX(nRoot, p->nNodeSize), &rc);
  154569. if( rc==SQLITE_OK ){
  154570. memcpy(pNode->block.a, aRoot, nRoot);
  154571. pNode->block.n = nRoot;
  154572. }
  154573. for(i=nHeight; i>=0 && rc==SQLITE_OK; i--){
  154574. NodeReader reader;
  154575. pNode = &pWriter->aNodeWriter[i];
  154576. rc = nodeReaderInit(&reader, pNode->block.a, pNode->block.n);
  154577. while( reader.aNode && rc==SQLITE_OK ) rc = nodeReaderNext(&reader);
  154578. blobGrowBuffer(&pNode->key, reader.term.n, &rc);
  154579. if( rc==SQLITE_OK ){
  154580. memcpy(pNode->key.a, reader.term.a, reader.term.n);
  154581. pNode->key.n = reader.term.n;
  154582. if( i>0 ){
  154583. char *aBlock = 0;
  154584. int nBlock = 0;
  154585. pNode = &pWriter->aNodeWriter[i-1];
  154586. pNode->iBlock = reader.iChild;
  154587. rc = sqlite3Fts3ReadBlock(p, reader.iChild, &aBlock, &nBlock, 0);
  154588. blobGrowBuffer(&pNode->block, MAX(nBlock, p->nNodeSize), &rc);
  154589. if( rc==SQLITE_OK ){
  154590. memcpy(pNode->block.a, aBlock, nBlock);
  154591. pNode->block.n = nBlock;
  154592. }
  154593. sqlite3_free(aBlock);
  154594. }
  154595. }
  154596. nodeReaderRelease(&reader);
  154597. }
  154598. }
  154599. rc2 = sqlite3_reset(pSelect);
  154600. if( rc==SQLITE_OK ) rc = rc2;
  154601. }
  154602. return rc;
  154603. }
  154604. /*
  154605. ** Determine the largest segment index value that exists within absolute
  154606. ** level iAbsLevel+1. If no error occurs, set *piIdx to this value plus
  154607. ** one before returning SQLITE_OK. Or, if there are no segments at all
  154608. ** within level iAbsLevel, set *piIdx to zero.
  154609. **
  154610. ** If an error occurs, return an SQLite error code. The final value of
  154611. ** *piIdx is undefined in this case.
  154612. */
  154613. static int fts3IncrmergeOutputIdx(
  154614. Fts3Table *p, /* FTS Table handle */
  154615. sqlite3_int64 iAbsLevel, /* Absolute index of input segments */
  154616. int *piIdx /* OUT: Next free index at iAbsLevel+1 */
  154617. ){
  154618. int rc;
  154619. sqlite3_stmt *pOutputIdx = 0; /* SQL used to find output index */
  154620. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENT_INDEX, &pOutputIdx, 0);
  154621. if( rc==SQLITE_OK ){
  154622. sqlite3_bind_int64(pOutputIdx, 1, iAbsLevel+1);
  154623. sqlite3_step(pOutputIdx);
  154624. *piIdx = sqlite3_column_int(pOutputIdx, 0);
  154625. rc = sqlite3_reset(pOutputIdx);
  154626. }
  154627. return rc;
  154628. }
  154629. /*
  154630. ** Allocate an appendable output segment on absolute level iAbsLevel+1
  154631. ** with idx value iIdx.
  154632. **
  154633. ** In the %_segdir table, a segment is defined by the values in three
  154634. ** columns:
  154635. **
  154636. ** start_block
  154637. ** leaves_end_block
  154638. ** end_block
  154639. **
  154640. ** When an appendable segment is allocated, it is estimated that the
  154641. ** maximum number of leaf blocks that may be required is the sum of the
  154642. ** number of leaf blocks consumed by the input segments, plus the number
  154643. ** of input segments, multiplied by two. This value is stored in stack
  154644. ** variable nLeafEst.
  154645. **
  154646. ** A total of 16*nLeafEst blocks are allocated when an appendable segment
  154647. ** is created ((1 + end_block - start_block)==16*nLeafEst). The contiguous
  154648. ** array of leaf nodes starts at the first block allocated. The array
  154649. ** of interior nodes that are parents of the leaf nodes start at block
  154650. ** (start_block + (1 + end_block - start_block) / 16). And so on.
  154651. **
  154652. ** In the actual code below, the value "16" is replaced with the
  154653. ** pre-processor macro FTS_MAX_APPENDABLE_HEIGHT.
  154654. */
  154655. static int fts3IncrmergeWriter(
  154656. Fts3Table *p, /* Fts3 table handle */
  154657. sqlite3_int64 iAbsLevel, /* Absolute level of input segments */
  154658. int iIdx, /* Index of new output segment */
  154659. Fts3MultiSegReader *pCsr, /* Cursor that data will be read from */
  154660. IncrmergeWriter *pWriter /* Populate this object */
  154661. ){
  154662. int rc; /* Return Code */
  154663. int i; /* Iterator variable */
  154664. int nLeafEst = 0; /* Blocks allocated for leaf nodes */
  154665. sqlite3_stmt *pLeafEst = 0; /* SQL used to determine nLeafEst */
  154666. sqlite3_stmt *pFirstBlock = 0; /* SQL used to determine first block */
  154667. /* Calculate nLeafEst. */
  154668. rc = fts3SqlStmt(p, SQL_MAX_LEAF_NODE_ESTIMATE, &pLeafEst, 0);
  154669. if( rc==SQLITE_OK ){
  154670. sqlite3_bind_int64(pLeafEst, 1, iAbsLevel);
  154671. sqlite3_bind_int64(pLeafEst, 2, pCsr->nSegment);
  154672. if( SQLITE_ROW==sqlite3_step(pLeafEst) ){
  154673. nLeafEst = sqlite3_column_int(pLeafEst, 0);
  154674. }
  154675. rc = sqlite3_reset(pLeafEst);
  154676. }
  154677. if( rc!=SQLITE_OK ) return rc;
  154678. /* Calculate the first block to use in the output segment */
  154679. rc = fts3SqlStmt(p, SQL_NEXT_SEGMENTS_ID, &pFirstBlock, 0);
  154680. if( rc==SQLITE_OK ){
  154681. if( SQLITE_ROW==sqlite3_step(pFirstBlock) ){
  154682. pWriter->iStart = sqlite3_column_int64(pFirstBlock, 0);
  154683. pWriter->iEnd = pWriter->iStart - 1;
  154684. pWriter->iEnd += nLeafEst * FTS_MAX_APPENDABLE_HEIGHT;
  154685. }
  154686. rc = sqlite3_reset(pFirstBlock);
  154687. }
  154688. if( rc!=SQLITE_OK ) return rc;
  154689. /* Insert the marker in the %_segments table to make sure nobody tries
  154690. ** to steal the space just allocated. This is also used to identify
  154691. ** appendable segments. */
  154692. rc = fts3WriteSegment(p, pWriter->iEnd, 0, 0);
  154693. if( rc!=SQLITE_OK ) return rc;
  154694. pWriter->iAbsLevel = iAbsLevel;
  154695. pWriter->nLeafEst = nLeafEst;
  154696. pWriter->iIdx = iIdx;
  154697. /* Set up the array of NodeWriter objects */
  154698. for(i=0; i<FTS_MAX_APPENDABLE_HEIGHT; i++){
  154699. pWriter->aNodeWriter[i].iBlock = pWriter->iStart + i*pWriter->nLeafEst;
  154700. }
  154701. return SQLITE_OK;
  154702. }
  154703. /*
  154704. ** Remove an entry from the %_segdir table. This involves running the
  154705. ** following two statements:
  154706. **
  154707. ** DELETE FROM %_segdir WHERE level = :iAbsLevel AND idx = :iIdx
  154708. ** UPDATE %_segdir SET idx = idx - 1 WHERE level = :iAbsLevel AND idx > :iIdx
  154709. **
  154710. ** The DELETE statement removes the specific %_segdir level. The UPDATE
  154711. ** statement ensures that the remaining segments have contiguously allocated
  154712. ** idx values.
  154713. */
  154714. static int fts3RemoveSegdirEntry(
  154715. Fts3Table *p, /* FTS3 table handle */
  154716. sqlite3_int64 iAbsLevel, /* Absolute level to delete from */
  154717. int iIdx /* Index of %_segdir entry to delete */
  154718. ){
  154719. int rc; /* Return code */
  154720. sqlite3_stmt *pDelete = 0; /* DELETE statement */
  154721. rc = fts3SqlStmt(p, SQL_DELETE_SEGDIR_ENTRY, &pDelete, 0);
  154722. if( rc==SQLITE_OK ){
  154723. sqlite3_bind_int64(pDelete, 1, iAbsLevel);
  154724. sqlite3_bind_int(pDelete, 2, iIdx);
  154725. sqlite3_step(pDelete);
  154726. rc = sqlite3_reset(pDelete);
  154727. }
  154728. return rc;
  154729. }
  154730. /*
  154731. ** One or more segments have just been removed from absolute level iAbsLevel.
  154732. ** Update the 'idx' values of the remaining segments in the level so that
  154733. ** the idx values are a contiguous sequence starting from 0.
  154734. */
  154735. static int fts3RepackSegdirLevel(
  154736. Fts3Table *p, /* FTS3 table handle */
  154737. sqlite3_int64 iAbsLevel /* Absolute level to repack */
  154738. ){
  154739. int rc; /* Return code */
  154740. int *aIdx = 0; /* Array of remaining idx values */
  154741. int nIdx = 0; /* Valid entries in aIdx[] */
  154742. int nAlloc = 0; /* Allocated size of aIdx[] */
  154743. int i; /* Iterator variable */
  154744. sqlite3_stmt *pSelect = 0; /* Select statement to read idx values */
  154745. sqlite3_stmt *pUpdate = 0; /* Update statement to modify idx values */
  154746. rc = fts3SqlStmt(p, SQL_SELECT_INDEXES, &pSelect, 0);
  154747. if( rc==SQLITE_OK ){
  154748. int rc2;
  154749. sqlite3_bind_int64(pSelect, 1, iAbsLevel);
  154750. while( SQLITE_ROW==sqlite3_step(pSelect) ){
  154751. if( nIdx>=nAlloc ){
  154752. int *aNew;
  154753. nAlloc += 16;
  154754. aNew = sqlite3_realloc(aIdx, nAlloc*sizeof(int));
  154755. if( !aNew ){
  154756. rc = SQLITE_NOMEM;
  154757. break;
  154758. }
  154759. aIdx = aNew;
  154760. }
  154761. aIdx[nIdx++] = sqlite3_column_int(pSelect, 0);
  154762. }
  154763. rc2 = sqlite3_reset(pSelect);
  154764. if( rc==SQLITE_OK ) rc = rc2;
  154765. }
  154766. if( rc==SQLITE_OK ){
  154767. rc = fts3SqlStmt(p, SQL_SHIFT_SEGDIR_ENTRY, &pUpdate, 0);
  154768. }
  154769. if( rc==SQLITE_OK ){
  154770. sqlite3_bind_int64(pUpdate, 2, iAbsLevel);
  154771. }
  154772. assert( p->bIgnoreSavepoint==0 );
  154773. p->bIgnoreSavepoint = 1;
  154774. for(i=0; rc==SQLITE_OK && i<nIdx; i++){
  154775. if( aIdx[i]!=i ){
  154776. sqlite3_bind_int(pUpdate, 3, aIdx[i]);
  154777. sqlite3_bind_int(pUpdate, 1, i);
  154778. sqlite3_step(pUpdate);
  154779. rc = sqlite3_reset(pUpdate);
  154780. }
  154781. }
  154782. p->bIgnoreSavepoint = 0;
  154783. sqlite3_free(aIdx);
  154784. return rc;
  154785. }
  154786. static void fts3StartNode(Blob *pNode, int iHeight, sqlite3_int64 iChild){
  154787. pNode->a[0] = (char)iHeight;
  154788. if( iChild ){
  154789. assert( pNode->nAlloc>=1+sqlite3Fts3VarintLen(iChild) );
  154790. pNode->n = 1 + sqlite3Fts3PutVarint(&pNode->a[1], iChild);
  154791. }else{
  154792. assert( pNode->nAlloc>=1 );
  154793. pNode->n = 1;
  154794. }
  154795. }
  154796. /*
  154797. ** The first two arguments are a pointer to and the size of a segment b-tree
  154798. ** node. The node may be a leaf or an internal node.
  154799. **
  154800. ** This function creates a new node image in blob object *pNew by copying
  154801. ** all terms that are greater than or equal to zTerm/nTerm (for leaf nodes)
  154802. ** or greater than zTerm/nTerm (for internal nodes) from aNode/nNode.
  154803. */
  154804. static int fts3TruncateNode(
  154805. const char *aNode, /* Current node image */
  154806. int nNode, /* Size of aNode in bytes */
  154807. Blob *pNew, /* OUT: Write new node image here */
  154808. const char *zTerm, /* Omit all terms smaller than this */
  154809. int nTerm, /* Size of zTerm in bytes */
  154810. sqlite3_int64 *piBlock /* OUT: Block number in next layer down */
  154811. ){
  154812. NodeReader reader; /* Reader object */
  154813. Blob prev = {0, 0, 0}; /* Previous term written to new node */
  154814. int rc = SQLITE_OK; /* Return code */
  154815. int bLeaf = aNode[0]=='\0'; /* True for a leaf node */
  154816. /* Allocate required output space */
  154817. blobGrowBuffer(pNew, nNode, &rc);
  154818. if( rc!=SQLITE_OK ) return rc;
  154819. pNew->n = 0;
  154820. /* Populate new node buffer */
  154821. for(rc = nodeReaderInit(&reader, aNode, nNode);
  154822. rc==SQLITE_OK && reader.aNode;
  154823. rc = nodeReaderNext(&reader)
  154824. ){
  154825. if( pNew->n==0 ){
  154826. int res = fts3TermCmp(reader.term.a, reader.term.n, zTerm, nTerm);
  154827. if( res<0 || (bLeaf==0 && res==0) ) continue;
  154828. fts3StartNode(pNew, (int)aNode[0], reader.iChild);
  154829. *piBlock = reader.iChild;
  154830. }
  154831. rc = fts3AppendToNode(
  154832. pNew, &prev, reader.term.a, reader.term.n,
  154833. reader.aDoclist, reader.nDoclist
  154834. );
  154835. if( rc!=SQLITE_OK ) break;
  154836. }
  154837. if( pNew->n==0 ){
  154838. fts3StartNode(pNew, (int)aNode[0], reader.iChild);
  154839. *piBlock = reader.iChild;
  154840. }
  154841. assert( pNew->n<=pNew->nAlloc );
  154842. nodeReaderRelease(&reader);
  154843. sqlite3_free(prev.a);
  154844. return rc;
  154845. }
  154846. /*
  154847. ** Remove all terms smaller than zTerm/nTerm from segment iIdx in absolute
  154848. ** level iAbsLevel. This may involve deleting entries from the %_segments
  154849. ** table, and modifying existing entries in both the %_segments and %_segdir
  154850. ** tables.
  154851. **
  154852. ** SQLITE_OK is returned if the segment is updated successfully. Or an
  154853. ** SQLite error code otherwise.
  154854. */
  154855. static int fts3TruncateSegment(
  154856. Fts3Table *p, /* FTS3 table handle */
  154857. sqlite3_int64 iAbsLevel, /* Absolute level of segment to modify */
  154858. int iIdx, /* Index within level of segment to modify */
  154859. const char *zTerm, /* Remove terms smaller than this */
  154860. int nTerm /* Number of bytes in buffer zTerm */
  154861. ){
  154862. int rc = SQLITE_OK; /* Return code */
  154863. Blob root = {0,0,0}; /* New root page image */
  154864. Blob block = {0,0,0}; /* Buffer used for any other block */
  154865. sqlite3_int64 iBlock = 0; /* Block id */
  154866. sqlite3_int64 iNewStart = 0; /* New value for iStartBlock */
  154867. sqlite3_int64 iOldStart = 0; /* Old value for iStartBlock */
  154868. sqlite3_stmt *pFetch = 0; /* Statement used to fetch segdir */
  154869. rc = fts3SqlStmt(p, SQL_SELECT_SEGDIR, &pFetch, 0);
  154870. if( rc==SQLITE_OK ){
  154871. int rc2; /* sqlite3_reset() return code */
  154872. sqlite3_bind_int64(pFetch, 1, iAbsLevel);
  154873. sqlite3_bind_int(pFetch, 2, iIdx);
  154874. if( SQLITE_ROW==sqlite3_step(pFetch) ){
  154875. const char *aRoot = sqlite3_column_blob(pFetch, 4);
  154876. int nRoot = sqlite3_column_bytes(pFetch, 4);
  154877. iOldStart = sqlite3_column_int64(pFetch, 1);
  154878. rc = fts3TruncateNode(aRoot, nRoot, &root, zTerm, nTerm, &iBlock);
  154879. }
  154880. rc2 = sqlite3_reset(pFetch);
  154881. if( rc==SQLITE_OK ) rc = rc2;
  154882. }
  154883. while( rc==SQLITE_OK && iBlock ){
  154884. char *aBlock = 0;
  154885. int nBlock = 0;
  154886. iNewStart = iBlock;
  154887. rc = sqlite3Fts3ReadBlock(p, iBlock, &aBlock, &nBlock, 0);
  154888. if( rc==SQLITE_OK ){
  154889. rc = fts3TruncateNode(aBlock, nBlock, &block, zTerm, nTerm, &iBlock);
  154890. }
  154891. if( rc==SQLITE_OK ){
  154892. rc = fts3WriteSegment(p, iNewStart, block.a, block.n);
  154893. }
  154894. sqlite3_free(aBlock);
  154895. }
  154896. /* Variable iNewStart now contains the first valid leaf node. */
  154897. if( rc==SQLITE_OK && iNewStart ){
  154898. sqlite3_stmt *pDel = 0;
  154899. rc = fts3SqlStmt(p, SQL_DELETE_SEGMENTS_RANGE, &pDel, 0);
  154900. if( rc==SQLITE_OK ){
  154901. sqlite3_bind_int64(pDel, 1, iOldStart);
  154902. sqlite3_bind_int64(pDel, 2, iNewStart-1);
  154903. sqlite3_step(pDel);
  154904. rc = sqlite3_reset(pDel);
  154905. }
  154906. }
  154907. if( rc==SQLITE_OK ){
  154908. sqlite3_stmt *pChomp = 0;
  154909. rc = fts3SqlStmt(p, SQL_CHOMP_SEGDIR, &pChomp, 0);
  154910. if( rc==SQLITE_OK ){
  154911. sqlite3_bind_int64(pChomp, 1, iNewStart);
  154912. sqlite3_bind_blob(pChomp, 2, root.a, root.n, SQLITE_STATIC);
  154913. sqlite3_bind_int64(pChomp, 3, iAbsLevel);
  154914. sqlite3_bind_int(pChomp, 4, iIdx);
  154915. sqlite3_step(pChomp);
  154916. rc = sqlite3_reset(pChomp);
  154917. sqlite3_bind_null(pChomp, 2);
  154918. }
  154919. }
  154920. sqlite3_free(root.a);
  154921. sqlite3_free(block.a);
  154922. return rc;
  154923. }
  154924. /*
  154925. ** This function is called after an incrmental-merge operation has run to
  154926. ** merge (or partially merge) two or more segments from absolute level
  154927. ** iAbsLevel.
  154928. **
  154929. ** Each input segment is either removed from the db completely (if all of
  154930. ** its data was copied to the output segment by the incrmerge operation)
  154931. ** or modified in place so that it no longer contains those entries that
  154932. ** have been duplicated in the output segment.
  154933. */
  154934. static int fts3IncrmergeChomp(
  154935. Fts3Table *p, /* FTS table handle */
  154936. sqlite3_int64 iAbsLevel, /* Absolute level containing segments */
  154937. Fts3MultiSegReader *pCsr, /* Chomp all segments opened by this cursor */
  154938. int *pnRem /* Number of segments not deleted */
  154939. ){
  154940. int i;
  154941. int nRem = 0;
  154942. int rc = SQLITE_OK;
  154943. for(i=pCsr->nSegment-1; i>=0 && rc==SQLITE_OK; i--){
  154944. Fts3SegReader *pSeg = 0;
  154945. int j;
  154946. /* Find the Fts3SegReader object with Fts3SegReader.iIdx==i. It is hiding
  154947. ** somewhere in the pCsr->apSegment[] array. */
  154948. for(j=0; ALWAYS(j<pCsr->nSegment); j++){
  154949. pSeg = pCsr->apSegment[j];
  154950. if( pSeg->iIdx==i ) break;
  154951. }
  154952. assert( j<pCsr->nSegment && pSeg->iIdx==i );
  154953. if( pSeg->aNode==0 ){
  154954. /* Seg-reader is at EOF. Remove the entire input segment. */
  154955. rc = fts3DeleteSegment(p, pSeg);
  154956. if( rc==SQLITE_OK ){
  154957. rc = fts3RemoveSegdirEntry(p, iAbsLevel, pSeg->iIdx);
  154958. }
  154959. *pnRem = 0;
  154960. }else{
  154961. /* The incremental merge did not copy all the data from this
  154962. ** segment to the upper level. The segment is modified in place
  154963. ** so that it contains no keys smaller than zTerm/nTerm. */
  154964. const char *zTerm = pSeg->zTerm;
  154965. int nTerm = pSeg->nTerm;
  154966. rc = fts3TruncateSegment(p, iAbsLevel, pSeg->iIdx, zTerm, nTerm);
  154967. nRem++;
  154968. }
  154969. }
  154970. if( rc==SQLITE_OK && nRem!=pCsr->nSegment ){
  154971. rc = fts3RepackSegdirLevel(p, iAbsLevel);
  154972. }
  154973. *pnRem = nRem;
  154974. return rc;
  154975. }
  154976. /*
  154977. ** Store an incr-merge hint in the database.
  154978. */
  154979. static int fts3IncrmergeHintStore(Fts3Table *p, Blob *pHint){
  154980. sqlite3_stmt *pReplace = 0;
  154981. int rc; /* Return code */
  154982. rc = fts3SqlStmt(p, SQL_REPLACE_STAT, &pReplace, 0);
  154983. if( rc==SQLITE_OK ){
  154984. sqlite3_bind_int(pReplace, 1, FTS_STAT_INCRMERGEHINT);
  154985. sqlite3_bind_blob(pReplace, 2, pHint->a, pHint->n, SQLITE_STATIC);
  154986. sqlite3_step(pReplace);
  154987. rc = sqlite3_reset(pReplace);
  154988. sqlite3_bind_null(pReplace, 2);
  154989. }
  154990. return rc;
  154991. }
  154992. /*
  154993. ** Load an incr-merge hint from the database. The incr-merge hint, if one
  154994. ** exists, is stored in the rowid==1 row of the %_stat table.
  154995. **
  154996. ** If successful, populate blob *pHint with the value read from the %_stat
  154997. ** table and return SQLITE_OK. Otherwise, if an error occurs, return an
  154998. ** SQLite error code.
  154999. */
  155000. static int fts3IncrmergeHintLoad(Fts3Table *p, Blob *pHint){
  155001. sqlite3_stmt *pSelect = 0;
  155002. int rc;
  155003. pHint->n = 0;
  155004. rc = fts3SqlStmt(p, SQL_SELECT_STAT, &pSelect, 0);
  155005. if( rc==SQLITE_OK ){
  155006. int rc2;
  155007. sqlite3_bind_int(pSelect, 1, FTS_STAT_INCRMERGEHINT);
  155008. if( SQLITE_ROW==sqlite3_step(pSelect) ){
  155009. const char *aHint = sqlite3_column_blob(pSelect, 0);
  155010. int nHint = sqlite3_column_bytes(pSelect, 0);
  155011. if( aHint ){
  155012. blobGrowBuffer(pHint, nHint, &rc);
  155013. if( rc==SQLITE_OK ){
  155014. memcpy(pHint->a, aHint, nHint);
  155015. pHint->n = nHint;
  155016. }
  155017. }
  155018. }
  155019. rc2 = sqlite3_reset(pSelect);
  155020. if( rc==SQLITE_OK ) rc = rc2;
  155021. }
  155022. return rc;
  155023. }
  155024. /*
  155025. ** If *pRc is not SQLITE_OK when this function is called, it is a no-op.
  155026. ** Otherwise, append an entry to the hint stored in blob *pHint. Each entry
  155027. ** consists of two varints, the absolute level number of the input segments
  155028. ** and the number of input segments.
  155029. **
  155030. ** If successful, leave *pRc set to SQLITE_OK and return. If an error occurs,
  155031. ** set *pRc to an SQLite error code before returning.
  155032. */
  155033. static void fts3IncrmergeHintPush(
  155034. Blob *pHint, /* Hint blob to append to */
  155035. i64 iAbsLevel, /* First varint to store in hint */
  155036. int nInput, /* Second varint to store in hint */
  155037. int *pRc /* IN/OUT: Error code */
  155038. ){
  155039. blobGrowBuffer(pHint, pHint->n + 2*FTS3_VARINT_MAX, pRc);
  155040. if( *pRc==SQLITE_OK ){
  155041. pHint->n += sqlite3Fts3PutVarint(&pHint->a[pHint->n], iAbsLevel);
  155042. pHint->n += sqlite3Fts3PutVarint(&pHint->a[pHint->n], (i64)nInput);
  155043. }
  155044. }
  155045. /*
  155046. ** Read the last entry (most recently pushed) from the hint blob *pHint
  155047. ** and then remove the entry. Write the two values read to *piAbsLevel and
  155048. ** *pnInput before returning.
  155049. **
  155050. ** If no error occurs, return SQLITE_OK. If the hint blob in *pHint does
  155051. ** not contain at least two valid varints, return SQLITE_CORRUPT_VTAB.
  155052. */
  155053. static int fts3IncrmergeHintPop(Blob *pHint, i64 *piAbsLevel, int *pnInput){
  155054. const int nHint = pHint->n;
  155055. int i;
  155056. i = pHint->n-2;
  155057. while( i>0 && (pHint->a[i-1] & 0x80) ) i--;
  155058. while( i>0 && (pHint->a[i-1] & 0x80) ) i--;
  155059. pHint->n = i;
  155060. i += sqlite3Fts3GetVarint(&pHint->a[i], piAbsLevel);
  155061. i += fts3GetVarint32(&pHint->a[i], pnInput);
  155062. if( i!=nHint ) return FTS_CORRUPT_VTAB;
  155063. return SQLITE_OK;
  155064. }
  155065. /*
  155066. ** Attempt an incremental merge that writes nMerge leaf blocks.
  155067. **
  155068. ** Incremental merges happen nMin segments at a time. The segments
  155069. ** to be merged are the nMin oldest segments (the ones with the smallest
  155070. ** values for the _segdir.idx field) in the highest level that contains
  155071. ** at least nMin segments. Multiple merges might occur in an attempt to
  155072. ** write the quota of nMerge leaf blocks.
  155073. */
  155074. SQLITE_PRIVATE int sqlite3Fts3Incrmerge(Fts3Table *p, int nMerge, int nMin){
  155075. int rc; /* Return code */
  155076. int nRem = nMerge; /* Number of leaf pages yet to be written */
  155077. Fts3MultiSegReader *pCsr; /* Cursor used to read input data */
  155078. Fts3SegFilter *pFilter; /* Filter used with cursor pCsr */
  155079. IncrmergeWriter *pWriter; /* Writer object */
  155080. int nSeg = 0; /* Number of input segments */
  155081. sqlite3_int64 iAbsLevel = 0; /* Absolute level number to work on */
  155082. Blob hint = {0, 0, 0}; /* Hint read from %_stat table */
  155083. int bDirtyHint = 0; /* True if blob 'hint' has been modified */
  155084. /* Allocate space for the cursor, filter and writer objects */
  155085. const int nAlloc = sizeof(*pCsr) + sizeof(*pFilter) + sizeof(*pWriter);
  155086. pWriter = (IncrmergeWriter *)sqlite3_malloc(nAlloc);
  155087. if( !pWriter ) return SQLITE_NOMEM;
  155088. pFilter = (Fts3SegFilter *)&pWriter[1];
  155089. pCsr = (Fts3MultiSegReader *)&pFilter[1];
  155090. rc = fts3IncrmergeHintLoad(p, &hint);
  155091. while( rc==SQLITE_OK && nRem>0 ){
  155092. const i64 nMod = FTS3_SEGDIR_MAXLEVEL * p->nIndex;
  155093. sqlite3_stmt *pFindLevel = 0; /* SQL used to determine iAbsLevel */
  155094. int bUseHint = 0; /* True if attempting to append */
  155095. int iIdx = 0; /* Largest idx in level (iAbsLevel+1) */
  155096. /* Search the %_segdir table for the absolute level with the smallest
  155097. ** relative level number that contains at least nMin segments, if any.
  155098. ** If one is found, set iAbsLevel to the absolute level number and
  155099. ** nSeg to nMin. If no level with at least nMin segments can be found,
  155100. ** set nSeg to -1.
  155101. */
  155102. rc = fts3SqlStmt(p, SQL_FIND_MERGE_LEVEL, &pFindLevel, 0);
  155103. sqlite3_bind_int(pFindLevel, 1, MAX(2, nMin));
  155104. if( sqlite3_step(pFindLevel)==SQLITE_ROW ){
  155105. iAbsLevel = sqlite3_column_int64(pFindLevel, 0);
  155106. nSeg = sqlite3_column_int(pFindLevel, 1);
  155107. assert( nSeg>=2 );
  155108. }else{
  155109. nSeg = -1;
  155110. }
  155111. rc = sqlite3_reset(pFindLevel);
  155112. /* If the hint read from the %_stat table is not empty, check if the
  155113. ** last entry in it specifies a relative level smaller than or equal
  155114. ** to the level identified by the block above (if any). If so, this
  155115. ** iteration of the loop will work on merging at the hinted level.
  155116. */
  155117. if( rc==SQLITE_OK && hint.n ){
  155118. int nHint = hint.n;
  155119. sqlite3_int64 iHintAbsLevel = 0; /* Hint level */
  155120. int nHintSeg = 0; /* Hint number of segments */
  155121. rc = fts3IncrmergeHintPop(&hint, &iHintAbsLevel, &nHintSeg);
  155122. if( nSeg<0 || (iAbsLevel % nMod) >= (iHintAbsLevel % nMod) ){
  155123. iAbsLevel = iHintAbsLevel;
  155124. nSeg = nHintSeg;
  155125. bUseHint = 1;
  155126. bDirtyHint = 1;
  155127. }else{
  155128. /* This undoes the effect of the HintPop() above - so that no entry
  155129. ** is removed from the hint blob. */
  155130. hint.n = nHint;
  155131. }
  155132. }
  155133. /* If nSeg is less that zero, then there is no level with at least
  155134. ** nMin segments and no hint in the %_stat table. No work to do.
  155135. ** Exit early in this case. */
  155136. if( nSeg<0 ) break;
  155137. /* Open a cursor to iterate through the contents of the oldest nSeg
  155138. ** indexes of absolute level iAbsLevel. If this cursor is opened using
  155139. ** the 'hint' parameters, it is possible that there are less than nSeg
  155140. ** segments available in level iAbsLevel. In this case, no work is
  155141. ** done on iAbsLevel - fall through to the next iteration of the loop
  155142. ** to start work on some other level. */
  155143. memset(pWriter, 0, nAlloc);
  155144. pFilter->flags = FTS3_SEGMENT_REQUIRE_POS;
  155145. if( rc==SQLITE_OK ){
  155146. rc = fts3IncrmergeOutputIdx(p, iAbsLevel, &iIdx);
  155147. assert( bUseHint==1 || bUseHint==0 );
  155148. if( iIdx==0 || (bUseHint && iIdx==1) ){
  155149. int bIgnore = 0;
  155150. rc = fts3SegmentIsMaxLevel(p, iAbsLevel+1, &bIgnore);
  155151. if( bIgnore ){
  155152. pFilter->flags |= FTS3_SEGMENT_IGNORE_EMPTY;
  155153. }
  155154. }
  155155. }
  155156. if( rc==SQLITE_OK ){
  155157. rc = fts3IncrmergeCsr(p, iAbsLevel, nSeg, pCsr);
  155158. }
  155159. if( SQLITE_OK==rc && pCsr->nSegment==nSeg
  155160. && SQLITE_OK==(rc = sqlite3Fts3SegReaderStart(p, pCsr, pFilter))
  155161. && SQLITE_ROW==(rc = sqlite3Fts3SegReaderStep(p, pCsr))
  155162. ){
  155163. if( bUseHint && iIdx>0 ){
  155164. const char *zKey = pCsr->zTerm;
  155165. int nKey = pCsr->nTerm;
  155166. rc = fts3IncrmergeLoad(p, iAbsLevel, iIdx-1, zKey, nKey, pWriter);
  155167. }else{
  155168. rc = fts3IncrmergeWriter(p, iAbsLevel, iIdx, pCsr, pWriter);
  155169. }
  155170. if( rc==SQLITE_OK && pWriter->nLeafEst ){
  155171. fts3LogMerge(nSeg, iAbsLevel);
  155172. do {
  155173. rc = fts3IncrmergeAppend(p, pWriter, pCsr);
  155174. if( rc==SQLITE_OK ) rc = sqlite3Fts3SegReaderStep(p, pCsr);
  155175. if( pWriter->nWork>=nRem && rc==SQLITE_ROW ) rc = SQLITE_OK;
  155176. }while( rc==SQLITE_ROW );
  155177. /* Update or delete the input segments */
  155178. if( rc==SQLITE_OK ){
  155179. nRem -= (1 + pWriter->nWork);
  155180. rc = fts3IncrmergeChomp(p, iAbsLevel, pCsr, &nSeg);
  155181. if( nSeg!=0 ){
  155182. bDirtyHint = 1;
  155183. fts3IncrmergeHintPush(&hint, iAbsLevel, nSeg, &rc);
  155184. }
  155185. }
  155186. }
  155187. if( nSeg!=0 ){
  155188. pWriter->nLeafData = pWriter->nLeafData * -1;
  155189. }
  155190. fts3IncrmergeRelease(p, pWriter, &rc);
  155191. if( nSeg==0 && pWriter->bNoLeafData==0 ){
  155192. fts3PromoteSegments(p, iAbsLevel+1, pWriter->nLeafData);
  155193. }
  155194. }
  155195. sqlite3Fts3SegReaderFinish(pCsr);
  155196. }
  155197. /* Write the hint values into the %_stat table for the next incr-merger */
  155198. if( bDirtyHint && rc==SQLITE_OK ){
  155199. rc = fts3IncrmergeHintStore(p, &hint);
  155200. }
  155201. sqlite3_free(pWriter);
  155202. sqlite3_free(hint.a);
  155203. return rc;
  155204. }
  155205. /*
  155206. ** Convert the text beginning at *pz into an integer and return
  155207. ** its value. Advance *pz to point to the first character past
  155208. ** the integer.
  155209. **
  155210. ** This function used for parameters to merge= and incrmerge=
  155211. ** commands.
  155212. */
  155213. static int fts3Getint(const char **pz){
  155214. const char *z = *pz;
  155215. int i = 0;
  155216. while( (*z)>='0' && (*z)<='9' && i<214748363 ) i = 10*i + *(z++) - '0';
  155217. *pz = z;
  155218. return i;
  155219. }
  155220. /*
  155221. ** Process statements of the form:
  155222. **
  155223. ** INSERT INTO table(table) VALUES('merge=A,B');
  155224. **
  155225. ** A and B are integers that decode to be the number of leaf pages
  155226. ** written for the merge, and the minimum number of segments on a level
  155227. ** before it will be selected for a merge, respectively.
  155228. */
  155229. static int fts3DoIncrmerge(
  155230. Fts3Table *p, /* FTS3 table handle */
  155231. const char *zParam /* Nul-terminated string containing "A,B" */
  155232. ){
  155233. int rc;
  155234. int nMin = (FTS3_MERGE_COUNT / 2);
  155235. int nMerge = 0;
  155236. const char *z = zParam;
  155237. /* Read the first integer value */
  155238. nMerge = fts3Getint(&z);
  155239. /* If the first integer value is followed by a ',', read the second
  155240. ** integer value. */
  155241. if( z[0]==',' && z[1]!='\0' ){
  155242. z++;
  155243. nMin = fts3Getint(&z);
  155244. }
  155245. if( z[0]!='\0' || nMin<2 ){
  155246. rc = SQLITE_ERROR;
  155247. }else{
  155248. rc = SQLITE_OK;
  155249. if( !p->bHasStat ){
  155250. assert( p->bFts4==0 );
  155251. sqlite3Fts3CreateStatTable(&rc, p);
  155252. }
  155253. if( rc==SQLITE_OK ){
  155254. rc = sqlite3Fts3Incrmerge(p, nMerge, nMin);
  155255. }
  155256. sqlite3Fts3SegmentsClose(p);
  155257. }
  155258. return rc;
  155259. }
  155260. /*
  155261. ** Process statements of the form:
  155262. **
  155263. ** INSERT INTO table(table) VALUES('automerge=X');
  155264. **
  155265. ** where X is an integer. X==0 means to turn automerge off. X!=0 means
  155266. ** turn it on. The setting is persistent.
  155267. */
  155268. static int fts3DoAutoincrmerge(
  155269. Fts3Table *p, /* FTS3 table handle */
  155270. const char *zParam /* Nul-terminated string containing boolean */
  155271. ){
  155272. int rc = SQLITE_OK;
  155273. sqlite3_stmt *pStmt = 0;
  155274. p->nAutoincrmerge = fts3Getint(&zParam);
  155275. if( p->nAutoincrmerge==1 || p->nAutoincrmerge>FTS3_MERGE_COUNT ){
  155276. p->nAutoincrmerge = 8;
  155277. }
  155278. if( !p->bHasStat ){
  155279. assert( p->bFts4==0 );
  155280. sqlite3Fts3CreateStatTable(&rc, p);
  155281. if( rc ) return rc;
  155282. }
  155283. rc = fts3SqlStmt(p, SQL_REPLACE_STAT, &pStmt, 0);
  155284. if( rc ) return rc;
  155285. sqlite3_bind_int(pStmt, 1, FTS_STAT_AUTOINCRMERGE);
  155286. sqlite3_bind_int(pStmt, 2, p->nAutoincrmerge);
  155287. sqlite3_step(pStmt);
  155288. rc = sqlite3_reset(pStmt);
  155289. return rc;
  155290. }
  155291. /*
  155292. ** Return a 64-bit checksum for the FTS index entry specified by the
  155293. ** arguments to this function.
  155294. */
  155295. static u64 fts3ChecksumEntry(
  155296. const char *zTerm, /* Pointer to buffer containing term */
  155297. int nTerm, /* Size of zTerm in bytes */
  155298. int iLangid, /* Language id for current row */
  155299. int iIndex, /* Index (0..Fts3Table.nIndex-1) */
  155300. i64 iDocid, /* Docid for current row. */
  155301. int iCol, /* Column number */
  155302. int iPos /* Position */
  155303. ){
  155304. int i;
  155305. u64 ret = (u64)iDocid;
  155306. ret += (ret<<3) + iLangid;
  155307. ret += (ret<<3) + iIndex;
  155308. ret += (ret<<3) + iCol;
  155309. ret += (ret<<3) + iPos;
  155310. for(i=0; i<nTerm; i++) ret += (ret<<3) + zTerm[i];
  155311. return ret;
  155312. }
  155313. /*
  155314. ** Return a checksum of all entries in the FTS index that correspond to
  155315. ** language id iLangid. The checksum is calculated by XORing the checksums
  155316. ** of each individual entry (see fts3ChecksumEntry()) together.
  155317. **
  155318. ** If successful, the checksum value is returned and *pRc set to SQLITE_OK.
  155319. ** Otherwise, if an error occurs, *pRc is set to an SQLite error code. The
  155320. ** return value is undefined in this case.
  155321. */
  155322. static u64 fts3ChecksumIndex(
  155323. Fts3Table *p, /* FTS3 table handle */
  155324. int iLangid, /* Language id to return cksum for */
  155325. int iIndex, /* Index to cksum (0..p->nIndex-1) */
  155326. int *pRc /* OUT: Return code */
  155327. ){
  155328. Fts3SegFilter filter;
  155329. Fts3MultiSegReader csr;
  155330. int rc;
  155331. u64 cksum = 0;
  155332. assert( *pRc==SQLITE_OK );
  155333. memset(&filter, 0, sizeof(filter));
  155334. memset(&csr, 0, sizeof(csr));
  155335. filter.flags = FTS3_SEGMENT_REQUIRE_POS|FTS3_SEGMENT_IGNORE_EMPTY;
  155336. filter.flags |= FTS3_SEGMENT_SCAN;
  155337. rc = sqlite3Fts3SegReaderCursor(
  155338. p, iLangid, iIndex, FTS3_SEGCURSOR_ALL, 0, 0, 0, 1,&csr
  155339. );
  155340. if( rc==SQLITE_OK ){
  155341. rc = sqlite3Fts3SegReaderStart(p, &csr, &filter);
  155342. }
  155343. if( rc==SQLITE_OK ){
  155344. while( SQLITE_ROW==(rc = sqlite3Fts3SegReaderStep(p, &csr)) ){
  155345. char *pCsr = csr.aDoclist;
  155346. char *pEnd = &pCsr[csr.nDoclist];
  155347. i64 iDocid = 0;
  155348. i64 iCol = 0;
  155349. i64 iPos = 0;
  155350. pCsr += sqlite3Fts3GetVarint(pCsr, &iDocid);
  155351. while( pCsr<pEnd ){
  155352. i64 iVal = 0;
  155353. pCsr += sqlite3Fts3GetVarint(pCsr, &iVal);
  155354. if( pCsr<pEnd ){
  155355. if( iVal==0 || iVal==1 ){
  155356. iCol = 0;
  155357. iPos = 0;
  155358. if( iVal ){
  155359. pCsr += sqlite3Fts3GetVarint(pCsr, &iCol);
  155360. }else{
  155361. pCsr += sqlite3Fts3GetVarint(pCsr, &iVal);
  155362. iDocid += iVal;
  155363. }
  155364. }else{
  155365. iPos += (iVal - 2);
  155366. cksum = cksum ^ fts3ChecksumEntry(
  155367. csr.zTerm, csr.nTerm, iLangid, iIndex, iDocid,
  155368. (int)iCol, (int)iPos
  155369. );
  155370. }
  155371. }
  155372. }
  155373. }
  155374. }
  155375. sqlite3Fts3SegReaderFinish(&csr);
  155376. *pRc = rc;
  155377. return cksum;
  155378. }
  155379. /*
  155380. ** Check if the contents of the FTS index match the current contents of the
  155381. ** content table. If no error occurs and the contents do match, set *pbOk
  155382. ** to true and return SQLITE_OK. Or if the contents do not match, set *pbOk
  155383. ** to false before returning.
  155384. **
  155385. ** If an error occurs (e.g. an OOM or IO error), return an SQLite error
  155386. ** code. The final value of *pbOk is undefined in this case.
  155387. */
  155388. static int fts3IntegrityCheck(Fts3Table *p, int *pbOk){
  155389. int rc = SQLITE_OK; /* Return code */
  155390. u64 cksum1 = 0; /* Checksum based on FTS index contents */
  155391. u64 cksum2 = 0; /* Checksum based on %_content contents */
  155392. sqlite3_stmt *pAllLangid = 0; /* Statement to return all language-ids */
  155393. /* This block calculates the checksum according to the FTS index. */
  155394. rc = fts3SqlStmt(p, SQL_SELECT_ALL_LANGID, &pAllLangid, 0);
  155395. if( rc==SQLITE_OK ){
  155396. int rc2;
  155397. sqlite3_bind_int(pAllLangid, 1, p->iPrevLangid);
  155398. sqlite3_bind_int(pAllLangid, 2, p->nIndex);
  155399. while( rc==SQLITE_OK && sqlite3_step(pAllLangid)==SQLITE_ROW ){
  155400. int iLangid = sqlite3_column_int(pAllLangid, 0);
  155401. int i;
  155402. for(i=0; i<p->nIndex; i++){
  155403. cksum1 = cksum1 ^ fts3ChecksumIndex(p, iLangid, i, &rc);
  155404. }
  155405. }
  155406. rc2 = sqlite3_reset(pAllLangid);
  155407. if( rc==SQLITE_OK ) rc = rc2;
  155408. }
  155409. /* This block calculates the checksum according to the %_content table */
  155410. if( rc==SQLITE_OK ){
  155411. sqlite3_tokenizer_module const *pModule = p->pTokenizer->pModule;
  155412. sqlite3_stmt *pStmt = 0;
  155413. char *zSql;
  155414. zSql = sqlite3_mprintf("SELECT %s" , p->zReadExprlist);
  155415. if( !zSql ){
  155416. rc = SQLITE_NOMEM;
  155417. }else{
  155418. rc = sqlite3_prepare_v2(p->db, zSql, -1, &pStmt, 0);
  155419. sqlite3_free(zSql);
  155420. }
  155421. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  155422. i64 iDocid = sqlite3_column_int64(pStmt, 0);
  155423. int iLang = langidFromSelect(p, pStmt);
  155424. int iCol;
  155425. for(iCol=0; rc==SQLITE_OK && iCol<p->nColumn; iCol++){
  155426. if( p->abNotindexed[iCol]==0 ){
  155427. const char *zText = (const char *)sqlite3_column_text(pStmt, iCol+1);
  155428. int nText = sqlite3_column_bytes(pStmt, iCol+1);
  155429. sqlite3_tokenizer_cursor *pT = 0;
  155430. rc = sqlite3Fts3OpenTokenizer(p->pTokenizer, iLang, zText, nText,&pT);
  155431. while( rc==SQLITE_OK ){
  155432. char const *zToken; /* Buffer containing token */
  155433. int nToken = 0; /* Number of bytes in token */
  155434. int iDum1 = 0, iDum2 = 0; /* Dummy variables */
  155435. int iPos = 0; /* Position of token in zText */
  155436. rc = pModule->xNext(pT, &zToken, &nToken, &iDum1, &iDum2, &iPos);
  155437. if( rc==SQLITE_OK ){
  155438. int i;
  155439. cksum2 = cksum2 ^ fts3ChecksumEntry(
  155440. zToken, nToken, iLang, 0, iDocid, iCol, iPos
  155441. );
  155442. for(i=1; i<p->nIndex; i++){
  155443. if( p->aIndex[i].nPrefix<=nToken ){
  155444. cksum2 = cksum2 ^ fts3ChecksumEntry(
  155445. zToken, p->aIndex[i].nPrefix, iLang, i, iDocid, iCol, iPos
  155446. );
  155447. }
  155448. }
  155449. }
  155450. }
  155451. if( pT ) pModule->xClose(pT);
  155452. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  155453. }
  155454. }
  155455. }
  155456. sqlite3_finalize(pStmt);
  155457. }
  155458. *pbOk = (cksum1==cksum2);
  155459. return rc;
  155460. }
  155461. /*
  155462. ** Run the integrity-check. If no error occurs and the current contents of
  155463. ** the FTS index are correct, return SQLITE_OK. Or, if the contents of the
  155464. ** FTS index are incorrect, return SQLITE_CORRUPT_VTAB.
  155465. **
  155466. ** Or, if an error (e.g. an OOM or IO error) occurs, return an SQLite
  155467. ** error code.
  155468. **
  155469. ** The integrity-check works as follows. For each token and indexed token
  155470. ** prefix in the document set, a 64-bit checksum is calculated (by code
  155471. ** in fts3ChecksumEntry()) based on the following:
  155472. **
  155473. ** + The index number (0 for the main index, 1 for the first prefix
  155474. ** index etc.),
  155475. ** + The token (or token prefix) text itself,
  155476. ** + The language-id of the row it appears in,
  155477. ** + The docid of the row it appears in,
  155478. ** + The column it appears in, and
  155479. ** + The tokens position within that column.
  155480. **
  155481. ** The checksums for all entries in the index are XORed together to create
  155482. ** a single checksum for the entire index.
  155483. **
  155484. ** The integrity-check code calculates the same checksum in two ways:
  155485. **
  155486. ** 1. By scanning the contents of the FTS index, and
  155487. ** 2. By scanning and tokenizing the content table.
  155488. **
  155489. ** If the two checksums are identical, the integrity-check is deemed to have
  155490. ** passed.
  155491. */
  155492. static int fts3DoIntegrityCheck(
  155493. Fts3Table *p /* FTS3 table handle */
  155494. ){
  155495. int rc;
  155496. int bOk = 0;
  155497. rc = fts3IntegrityCheck(p, &bOk);
  155498. if( rc==SQLITE_OK && bOk==0 ) rc = FTS_CORRUPT_VTAB;
  155499. return rc;
  155500. }
  155501. /*
  155502. ** Handle a 'special' INSERT of the form:
  155503. **
  155504. ** "INSERT INTO tbl(tbl) VALUES(<expr>)"
  155505. **
  155506. ** Argument pVal contains the result of <expr>. Currently the only
  155507. ** meaningful value to insert is the text 'optimize'.
  155508. */
  155509. static int fts3SpecialInsert(Fts3Table *p, sqlite3_value *pVal){
  155510. int rc; /* Return Code */
  155511. const char *zVal = (const char *)sqlite3_value_text(pVal);
  155512. int nVal = sqlite3_value_bytes(pVal);
  155513. if( !zVal ){
  155514. return SQLITE_NOMEM;
  155515. }else if( nVal==8 && 0==sqlite3_strnicmp(zVal, "optimize", 8) ){
  155516. rc = fts3DoOptimize(p, 0);
  155517. }else if( nVal==7 && 0==sqlite3_strnicmp(zVal, "rebuild", 7) ){
  155518. rc = fts3DoRebuild(p);
  155519. }else if( nVal==15 && 0==sqlite3_strnicmp(zVal, "integrity-check", 15) ){
  155520. rc = fts3DoIntegrityCheck(p);
  155521. }else if( nVal>6 && 0==sqlite3_strnicmp(zVal, "merge=", 6) ){
  155522. rc = fts3DoIncrmerge(p, &zVal[6]);
  155523. }else if( nVal>10 && 0==sqlite3_strnicmp(zVal, "automerge=", 10) ){
  155524. rc = fts3DoAutoincrmerge(p, &zVal[10]);
  155525. #ifdef SQLITE_TEST
  155526. }else if( nVal>9 && 0==sqlite3_strnicmp(zVal, "nodesize=", 9) ){
  155527. p->nNodeSize = atoi(&zVal[9]);
  155528. rc = SQLITE_OK;
  155529. }else if( nVal>11 && 0==sqlite3_strnicmp(zVal, "maxpending=", 9) ){
  155530. p->nMaxPendingData = atoi(&zVal[11]);
  155531. rc = SQLITE_OK;
  155532. }else if( nVal>21 && 0==sqlite3_strnicmp(zVal, "test-no-incr-doclist=", 21) ){
  155533. p->bNoIncrDoclist = atoi(&zVal[21]);
  155534. rc = SQLITE_OK;
  155535. #endif
  155536. }else{
  155537. rc = SQLITE_ERROR;
  155538. }
  155539. return rc;
  155540. }
  155541. #ifndef SQLITE_DISABLE_FTS4_DEFERRED
  155542. /*
  155543. ** Delete all cached deferred doclists. Deferred doclists are cached
  155544. ** (allocated) by the sqlite3Fts3CacheDeferredDoclists() function.
  155545. */
  155546. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredDoclists(Fts3Cursor *pCsr){
  155547. Fts3DeferredToken *pDef;
  155548. for(pDef=pCsr->pDeferred; pDef; pDef=pDef->pNext){
  155549. fts3PendingListDelete(pDef->pList);
  155550. pDef->pList = 0;
  155551. }
  155552. }
  155553. /*
  155554. ** Free all entries in the pCsr->pDeffered list. Entries are added to
  155555. ** this list using sqlite3Fts3DeferToken().
  155556. */
  155557. SQLITE_PRIVATE void sqlite3Fts3FreeDeferredTokens(Fts3Cursor *pCsr){
  155558. Fts3DeferredToken *pDef;
  155559. Fts3DeferredToken *pNext;
  155560. for(pDef=pCsr->pDeferred; pDef; pDef=pNext){
  155561. pNext = pDef->pNext;
  155562. fts3PendingListDelete(pDef->pList);
  155563. sqlite3_free(pDef);
  155564. }
  155565. pCsr->pDeferred = 0;
  155566. }
  155567. /*
  155568. ** Generate deferred-doclists for all tokens in the pCsr->pDeferred list
  155569. ** based on the row that pCsr currently points to.
  155570. **
  155571. ** A deferred-doclist is like any other doclist with position information
  155572. ** included, except that it only contains entries for a single row of the
  155573. ** table, not for all rows.
  155574. */
  155575. SQLITE_PRIVATE int sqlite3Fts3CacheDeferredDoclists(Fts3Cursor *pCsr){
  155576. int rc = SQLITE_OK; /* Return code */
  155577. if( pCsr->pDeferred ){
  155578. int i; /* Used to iterate through table columns */
  155579. sqlite3_int64 iDocid; /* Docid of the row pCsr points to */
  155580. Fts3DeferredToken *pDef; /* Used to iterate through deferred tokens */
  155581. Fts3Table *p = (Fts3Table *)pCsr->base.pVtab;
  155582. sqlite3_tokenizer *pT = p->pTokenizer;
  155583. sqlite3_tokenizer_module const *pModule = pT->pModule;
  155584. assert( pCsr->isRequireSeek==0 );
  155585. iDocid = sqlite3_column_int64(pCsr->pStmt, 0);
  155586. for(i=0; i<p->nColumn && rc==SQLITE_OK; i++){
  155587. if( p->abNotindexed[i]==0 ){
  155588. const char *zText = (const char *)sqlite3_column_text(pCsr->pStmt, i+1);
  155589. sqlite3_tokenizer_cursor *pTC = 0;
  155590. rc = sqlite3Fts3OpenTokenizer(pT, pCsr->iLangid, zText, -1, &pTC);
  155591. while( rc==SQLITE_OK ){
  155592. char const *zToken; /* Buffer containing token */
  155593. int nToken = 0; /* Number of bytes in token */
  155594. int iDum1 = 0, iDum2 = 0; /* Dummy variables */
  155595. int iPos = 0; /* Position of token in zText */
  155596. rc = pModule->xNext(pTC, &zToken, &nToken, &iDum1, &iDum2, &iPos);
  155597. for(pDef=pCsr->pDeferred; pDef && rc==SQLITE_OK; pDef=pDef->pNext){
  155598. Fts3PhraseToken *pPT = pDef->pToken;
  155599. if( (pDef->iCol>=p->nColumn || pDef->iCol==i)
  155600. && (pPT->bFirst==0 || iPos==0)
  155601. && (pPT->n==nToken || (pPT->isPrefix && pPT->n<nToken))
  155602. && (0==memcmp(zToken, pPT->z, pPT->n))
  155603. ){
  155604. fts3PendingListAppend(&pDef->pList, iDocid, i, iPos, &rc);
  155605. }
  155606. }
  155607. }
  155608. if( pTC ) pModule->xClose(pTC);
  155609. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  155610. }
  155611. }
  155612. for(pDef=pCsr->pDeferred; pDef && rc==SQLITE_OK; pDef=pDef->pNext){
  155613. if( pDef->pList ){
  155614. rc = fts3PendingListAppendVarint(&pDef->pList, 0);
  155615. }
  155616. }
  155617. }
  155618. return rc;
  155619. }
  155620. SQLITE_PRIVATE int sqlite3Fts3DeferredTokenList(
  155621. Fts3DeferredToken *p,
  155622. char **ppData,
  155623. int *pnData
  155624. ){
  155625. char *pRet;
  155626. int nSkip;
  155627. sqlite3_int64 dummy;
  155628. *ppData = 0;
  155629. *pnData = 0;
  155630. if( p->pList==0 ){
  155631. return SQLITE_OK;
  155632. }
  155633. pRet = (char *)sqlite3_malloc(p->pList->nData);
  155634. if( !pRet ) return SQLITE_NOMEM;
  155635. nSkip = sqlite3Fts3GetVarint(p->pList->aData, &dummy);
  155636. *pnData = p->pList->nData - nSkip;
  155637. *ppData = pRet;
  155638. memcpy(pRet, &p->pList->aData[nSkip], *pnData);
  155639. return SQLITE_OK;
  155640. }
  155641. /*
  155642. ** Add an entry for token pToken to the pCsr->pDeferred list.
  155643. */
  155644. SQLITE_PRIVATE int sqlite3Fts3DeferToken(
  155645. Fts3Cursor *pCsr, /* Fts3 table cursor */
  155646. Fts3PhraseToken *pToken, /* Token to defer */
  155647. int iCol /* Column that token must appear in (or -1) */
  155648. ){
  155649. Fts3DeferredToken *pDeferred;
  155650. pDeferred = sqlite3_malloc(sizeof(*pDeferred));
  155651. if( !pDeferred ){
  155652. return SQLITE_NOMEM;
  155653. }
  155654. memset(pDeferred, 0, sizeof(*pDeferred));
  155655. pDeferred->pToken = pToken;
  155656. pDeferred->pNext = pCsr->pDeferred;
  155657. pDeferred->iCol = iCol;
  155658. pCsr->pDeferred = pDeferred;
  155659. assert( pToken->pDeferred==0 );
  155660. pToken->pDeferred = pDeferred;
  155661. return SQLITE_OK;
  155662. }
  155663. #endif
  155664. /*
  155665. ** SQLite value pRowid contains the rowid of a row that may or may not be
  155666. ** present in the FTS3 table. If it is, delete it and adjust the contents
  155667. ** of subsiduary data structures accordingly.
  155668. */
  155669. static int fts3DeleteByRowid(
  155670. Fts3Table *p,
  155671. sqlite3_value *pRowid,
  155672. int *pnChng, /* IN/OUT: Decrement if row is deleted */
  155673. u32 *aSzDel
  155674. ){
  155675. int rc = SQLITE_OK; /* Return code */
  155676. int bFound = 0; /* True if *pRowid really is in the table */
  155677. fts3DeleteTerms(&rc, p, pRowid, aSzDel, &bFound);
  155678. if( bFound && rc==SQLITE_OK ){
  155679. int isEmpty = 0; /* Deleting *pRowid leaves the table empty */
  155680. rc = fts3IsEmpty(p, pRowid, &isEmpty);
  155681. if( rc==SQLITE_OK ){
  155682. if( isEmpty ){
  155683. /* Deleting this row means the whole table is empty. In this case
  155684. ** delete the contents of all three tables and throw away any
  155685. ** data in the pendingTerms hash table. */
  155686. rc = fts3DeleteAll(p, 1);
  155687. *pnChng = 0;
  155688. memset(aSzDel, 0, sizeof(u32) * (p->nColumn+1) * 2);
  155689. }else{
  155690. *pnChng = *pnChng - 1;
  155691. if( p->zContentTbl==0 ){
  155692. fts3SqlExec(&rc, p, SQL_DELETE_CONTENT, &pRowid);
  155693. }
  155694. if( p->bHasDocsize ){
  155695. fts3SqlExec(&rc, p, SQL_DELETE_DOCSIZE, &pRowid);
  155696. }
  155697. }
  155698. }
  155699. }
  155700. return rc;
  155701. }
  155702. /*
  155703. ** This function does the work for the xUpdate method of FTS3 virtual
  155704. ** tables. The schema of the virtual table being:
  155705. **
  155706. ** CREATE TABLE <table name>(
  155707. ** <user columns>,
  155708. ** <table name> HIDDEN,
  155709. ** docid HIDDEN,
  155710. ** <langid> HIDDEN
  155711. ** );
  155712. **
  155713. **
  155714. */
  155715. SQLITE_PRIVATE int sqlite3Fts3UpdateMethod(
  155716. sqlite3_vtab *pVtab, /* FTS3 vtab object */
  155717. int nArg, /* Size of argument array */
  155718. sqlite3_value **apVal, /* Array of arguments */
  155719. sqlite_int64 *pRowid /* OUT: The affected (or effected) rowid */
  155720. ){
  155721. Fts3Table *p = (Fts3Table *)pVtab;
  155722. int rc = SQLITE_OK; /* Return Code */
  155723. u32 *aSzIns = 0; /* Sizes of inserted documents */
  155724. u32 *aSzDel = 0; /* Sizes of deleted documents */
  155725. int nChng = 0; /* Net change in number of documents */
  155726. int bInsertDone = 0;
  155727. /* At this point it must be known if the %_stat table exists or not.
  155728. ** So bHasStat may not be 2. */
  155729. assert( p->bHasStat==0 || p->bHasStat==1 );
  155730. assert( p->pSegments==0 );
  155731. assert(
  155732. nArg==1 /* DELETE operations */
  155733. || nArg==(2 + p->nColumn + 3) /* INSERT or UPDATE operations */
  155734. );
  155735. /* Check for a "special" INSERT operation. One of the form:
  155736. **
  155737. ** INSERT INTO xyz(xyz) VALUES('command');
  155738. */
  155739. if( nArg>1
  155740. && sqlite3_value_type(apVal[0])==SQLITE_NULL
  155741. && sqlite3_value_type(apVal[p->nColumn+2])!=SQLITE_NULL
  155742. ){
  155743. rc = fts3SpecialInsert(p, apVal[p->nColumn+2]);
  155744. goto update_out;
  155745. }
  155746. if( nArg>1 && sqlite3_value_int(apVal[2 + p->nColumn + 2])<0 ){
  155747. rc = SQLITE_CONSTRAINT;
  155748. goto update_out;
  155749. }
  155750. /* Allocate space to hold the change in document sizes */
  155751. aSzDel = sqlite3_malloc( sizeof(aSzDel[0])*(p->nColumn+1)*2 );
  155752. if( aSzDel==0 ){
  155753. rc = SQLITE_NOMEM;
  155754. goto update_out;
  155755. }
  155756. aSzIns = &aSzDel[p->nColumn+1];
  155757. memset(aSzDel, 0, sizeof(aSzDel[0])*(p->nColumn+1)*2);
  155758. rc = fts3Writelock(p);
  155759. if( rc!=SQLITE_OK ) goto update_out;
  155760. /* If this is an INSERT operation, or an UPDATE that modifies the rowid
  155761. ** value, then this operation requires constraint handling.
  155762. **
  155763. ** If the on-conflict mode is REPLACE, this means that the existing row
  155764. ** should be deleted from the database before inserting the new row. Or,
  155765. ** if the on-conflict mode is other than REPLACE, then this method must
  155766. ** detect the conflict and return SQLITE_CONSTRAINT before beginning to
  155767. ** modify the database file.
  155768. */
  155769. if( nArg>1 && p->zContentTbl==0 ){
  155770. /* Find the value object that holds the new rowid value. */
  155771. sqlite3_value *pNewRowid = apVal[3+p->nColumn];
  155772. if( sqlite3_value_type(pNewRowid)==SQLITE_NULL ){
  155773. pNewRowid = apVal[1];
  155774. }
  155775. if( sqlite3_value_type(pNewRowid)!=SQLITE_NULL && (
  155776. sqlite3_value_type(apVal[0])==SQLITE_NULL
  155777. || sqlite3_value_int64(apVal[0])!=sqlite3_value_int64(pNewRowid)
  155778. )){
  155779. /* The new rowid is not NULL (in this case the rowid will be
  155780. ** automatically assigned and there is no chance of a conflict), and
  155781. ** the statement is either an INSERT or an UPDATE that modifies the
  155782. ** rowid column. So if the conflict mode is REPLACE, then delete any
  155783. ** existing row with rowid=pNewRowid.
  155784. **
  155785. ** Or, if the conflict mode is not REPLACE, insert the new record into
  155786. ** the %_content table. If we hit the duplicate rowid constraint (or any
  155787. ** other error) while doing so, return immediately.
  155788. **
  155789. ** This branch may also run if pNewRowid contains a value that cannot
  155790. ** be losslessly converted to an integer. In this case, the eventual
  155791. ** call to fts3InsertData() (either just below or further on in this
  155792. ** function) will return SQLITE_MISMATCH. If fts3DeleteByRowid is
  155793. ** invoked, it will delete zero rows (since no row will have
  155794. ** docid=$pNewRowid if $pNewRowid is not an integer value).
  155795. */
  155796. if( sqlite3_vtab_on_conflict(p->db)==SQLITE_REPLACE ){
  155797. rc = fts3DeleteByRowid(p, pNewRowid, &nChng, aSzDel);
  155798. }else{
  155799. rc = fts3InsertData(p, apVal, pRowid);
  155800. bInsertDone = 1;
  155801. }
  155802. }
  155803. }
  155804. if( rc!=SQLITE_OK ){
  155805. goto update_out;
  155806. }
  155807. /* If this is a DELETE or UPDATE operation, remove the old record. */
  155808. if( sqlite3_value_type(apVal[0])!=SQLITE_NULL ){
  155809. assert( sqlite3_value_type(apVal[0])==SQLITE_INTEGER );
  155810. rc = fts3DeleteByRowid(p, apVal[0], &nChng, aSzDel);
  155811. }
  155812. /* If this is an INSERT or UPDATE operation, insert the new record. */
  155813. if( nArg>1 && rc==SQLITE_OK ){
  155814. int iLangid = sqlite3_value_int(apVal[2 + p->nColumn + 2]);
  155815. if( bInsertDone==0 ){
  155816. rc = fts3InsertData(p, apVal, pRowid);
  155817. if( rc==SQLITE_CONSTRAINT && p->zContentTbl==0 ){
  155818. rc = FTS_CORRUPT_VTAB;
  155819. }
  155820. }
  155821. if( rc==SQLITE_OK ){
  155822. rc = fts3PendingTermsDocid(p, 0, iLangid, *pRowid);
  155823. }
  155824. if( rc==SQLITE_OK ){
  155825. assert( p->iPrevDocid==*pRowid );
  155826. rc = fts3InsertTerms(p, iLangid, apVal, aSzIns);
  155827. }
  155828. if( p->bHasDocsize ){
  155829. fts3InsertDocsize(&rc, p, aSzIns);
  155830. }
  155831. nChng++;
  155832. }
  155833. if( p->bFts4 ){
  155834. fts3UpdateDocTotals(&rc, p, aSzIns, aSzDel, nChng);
  155835. }
  155836. update_out:
  155837. sqlite3_free(aSzDel);
  155838. sqlite3Fts3SegmentsClose(p);
  155839. return rc;
  155840. }
  155841. /*
  155842. ** Flush any data in the pending-terms hash table to disk. If successful,
  155843. ** merge all segments in the database (including the new segment, if
  155844. ** there was any data to flush) into a single segment.
  155845. */
  155846. SQLITE_PRIVATE int sqlite3Fts3Optimize(Fts3Table *p){
  155847. int rc;
  155848. rc = sqlite3_exec(p->db, "SAVEPOINT fts3", 0, 0, 0);
  155849. if( rc==SQLITE_OK ){
  155850. rc = fts3DoOptimize(p, 1);
  155851. if( rc==SQLITE_OK || rc==SQLITE_DONE ){
  155852. int rc2 = sqlite3_exec(p->db, "RELEASE fts3", 0, 0, 0);
  155853. if( rc2!=SQLITE_OK ) rc = rc2;
  155854. }else{
  155855. sqlite3_exec(p->db, "ROLLBACK TO fts3", 0, 0, 0);
  155856. sqlite3_exec(p->db, "RELEASE fts3", 0, 0, 0);
  155857. }
  155858. }
  155859. sqlite3Fts3SegmentsClose(p);
  155860. return rc;
  155861. }
  155862. #endif
  155863. /************** End of fts3_write.c ******************************************/
  155864. /************** Begin file fts3_snippet.c ************************************/
  155865. /*
  155866. ** 2009 Oct 23
  155867. **
  155868. ** The author disclaims copyright to this source code. In place of
  155869. ** a legal notice, here is a blessing:
  155870. **
  155871. ** May you do good and not evil.
  155872. ** May you find forgiveness for yourself and forgive others.
  155873. ** May you share freely, never taking more than you give.
  155874. **
  155875. ******************************************************************************
  155876. */
  155877. /* #include "fts3Int.h" */
  155878. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  155879. /* #include <string.h> */
  155880. /* #include <assert.h> */
  155881. /*
  155882. ** Characters that may appear in the second argument to matchinfo().
  155883. */
  155884. #define FTS3_MATCHINFO_NPHRASE 'p' /* 1 value */
  155885. #define FTS3_MATCHINFO_NCOL 'c' /* 1 value */
  155886. #define FTS3_MATCHINFO_NDOC 'n' /* 1 value */
  155887. #define FTS3_MATCHINFO_AVGLENGTH 'a' /* nCol values */
  155888. #define FTS3_MATCHINFO_LENGTH 'l' /* nCol values */
  155889. #define FTS3_MATCHINFO_LCS 's' /* nCol values */
  155890. #define FTS3_MATCHINFO_HITS 'x' /* 3*nCol*nPhrase values */
  155891. #define FTS3_MATCHINFO_LHITS 'y' /* nCol*nPhrase values */
  155892. #define FTS3_MATCHINFO_LHITS_BM 'b' /* nCol*nPhrase values */
  155893. /*
  155894. ** The default value for the second argument to matchinfo().
  155895. */
  155896. #define FTS3_MATCHINFO_DEFAULT "pcx"
  155897. /*
  155898. ** Used as an fts3ExprIterate() context when loading phrase doclists to
  155899. ** Fts3Expr.aDoclist[]/nDoclist.
  155900. */
  155901. typedef struct LoadDoclistCtx LoadDoclistCtx;
  155902. struct LoadDoclistCtx {
  155903. Fts3Cursor *pCsr; /* FTS3 Cursor */
  155904. int nPhrase; /* Number of phrases seen so far */
  155905. int nToken; /* Number of tokens seen so far */
  155906. };
  155907. /*
  155908. ** The following types are used as part of the implementation of the
  155909. ** fts3BestSnippet() routine.
  155910. */
  155911. typedef struct SnippetIter SnippetIter;
  155912. typedef struct SnippetPhrase SnippetPhrase;
  155913. typedef struct SnippetFragment SnippetFragment;
  155914. struct SnippetIter {
  155915. Fts3Cursor *pCsr; /* Cursor snippet is being generated from */
  155916. int iCol; /* Extract snippet from this column */
  155917. int nSnippet; /* Requested snippet length (in tokens) */
  155918. int nPhrase; /* Number of phrases in query */
  155919. SnippetPhrase *aPhrase; /* Array of size nPhrase */
  155920. int iCurrent; /* First token of current snippet */
  155921. };
  155922. struct SnippetPhrase {
  155923. int nToken; /* Number of tokens in phrase */
  155924. char *pList; /* Pointer to start of phrase position list */
  155925. int iHead; /* Next value in position list */
  155926. char *pHead; /* Position list data following iHead */
  155927. int iTail; /* Next value in trailing position list */
  155928. char *pTail; /* Position list data following iTail */
  155929. };
  155930. struct SnippetFragment {
  155931. int iCol; /* Column snippet is extracted from */
  155932. int iPos; /* Index of first token in snippet */
  155933. u64 covered; /* Mask of query phrases covered */
  155934. u64 hlmask; /* Mask of snippet terms to highlight */
  155935. };
  155936. /*
  155937. ** This type is used as an fts3ExprIterate() context object while
  155938. ** accumulating the data returned by the matchinfo() function.
  155939. */
  155940. typedef struct MatchInfo MatchInfo;
  155941. struct MatchInfo {
  155942. Fts3Cursor *pCursor; /* FTS3 Cursor */
  155943. int nCol; /* Number of columns in table */
  155944. int nPhrase; /* Number of matchable phrases in query */
  155945. sqlite3_int64 nDoc; /* Number of docs in database */
  155946. char flag;
  155947. u32 *aMatchinfo; /* Pre-allocated buffer */
  155948. };
  155949. /*
  155950. ** An instance of this structure is used to manage a pair of buffers, each
  155951. ** (nElem * sizeof(u32)) bytes in size. See the MatchinfoBuffer code below
  155952. ** for details.
  155953. */
  155954. struct MatchinfoBuffer {
  155955. u8 aRef[3];
  155956. int nElem;
  155957. int bGlobal; /* Set if global data is loaded */
  155958. char *zMatchinfo;
  155959. u32 aMatchinfo[1];
  155960. };
  155961. /*
  155962. ** The snippet() and offsets() functions both return text values. An instance
  155963. ** of the following structure is used to accumulate those values while the
  155964. ** functions are running. See fts3StringAppend() for details.
  155965. */
  155966. typedef struct StrBuffer StrBuffer;
  155967. struct StrBuffer {
  155968. char *z; /* Pointer to buffer containing string */
  155969. int n; /* Length of z in bytes (excl. nul-term) */
  155970. int nAlloc; /* Allocated size of buffer z in bytes */
  155971. };
  155972. /*************************************************************************
  155973. ** Start of MatchinfoBuffer code.
  155974. */
  155975. /*
  155976. ** Allocate a two-slot MatchinfoBuffer object.
  155977. */
  155978. static MatchinfoBuffer *fts3MIBufferNew(int nElem, const char *zMatchinfo){
  155979. MatchinfoBuffer *pRet;
  155980. int nByte = sizeof(u32) * (2*nElem + 1) + sizeof(MatchinfoBuffer);
  155981. int nStr = (int)strlen(zMatchinfo);
  155982. pRet = sqlite3_malloc(nByte + nStr+1);
  155983. if( pRet ){
  155984. memset(pRet, 0, nByte);
  155985. pRet->aMatchinfo[0] = (u8*)(&pRet->aMatchinfo[1]) - (u8*)pRet;
  155986. pRet->aMatchinfo[1+nElem] = pRet->aMatchinfo[0] + sizeof(u32)*(nElem+1);
  155987. pRet->nElem = nElem;
  155988. pRet->zMatchinfo = ((char*)pRet) + nByte;
  155989. memcpy(pRet->zMatchinfo, zMatchinfo, nStr+1);
  155990. pRet->aRef[0] = 1;
  155991. }
  155992. return pRet;
  155993. }
  155994. static void fts3MIBufferFree(void *p){
  155995. MatchinfoBuffer *pBuf = (MatchinfoBuffer*)((u8*)p - ((u32*)p)[-1]);
  155996. assert( (u32*)p==&pBuf->aMatchinfo[1]
  155997. || (u32*)p==&pBuf->aMatchinfo[pBuf->nElem+2]
  155998. );
  155999. if( (u32*)p==&pBuf->aMatchinfo[1] ){
  156000. pBuf->aRef[1] = 0;
  156001. }else{
  156002. pBuf->aRef[2] = 0;
  156003. }
  156004. if( pBuf->aRef[0]==0 && pBuf->aRef[1]==0 && pBuf->aRef[2]==0 ){
  156005. sqlite3_free(pBuf);
  156006. }
  156007. }
  156008. static void (*fts3MIBufferAlloc(MatchinfoBuffer *p, u32 **paOut))(void*){
  156009. void (*xRet)(void*) = 0;
  156010. u32 *aOut = 0;
  156011. if( p->aRef[1]==0 ){
  156012. p->aRef[1] = 1;
  156013. aOut = &p->aMatchinfo[1];
  156014. xRet = fts3MIBufferFree;
  156015. }
  156016. else if( p->aRef[2]==0 ){
  156017. p->aRef[2] = 1;
  156018. aOut = &p->aMatchinfo[p->nElem+2];
  156019. xRet = fts3MIBufferFree;
  156020. }else{
  156021. aOut = (u32*)sqlite3_malloc(p->nElem * sizeof(u32));
  156022. if( aOut ){
  156023. xRet = sqlite3_free;
  156024. if( p->bGlobal ) memcpy(aOut, &p->aMatchinfo[1], p->nElem*sizeof(u32));
  156025. }
  156026. }
  156027. *paOut = aOut;
  156028. return xRet;
  156029. }
  156030. static void fts3MIBufferSetGlobal(MatchinfoBuffer *p){
  156031. p->bGlobal = 1;
  156032. memcpy(&p->aMatchinfo[2+p->nElem], &p->aMatchinfo[1], p->nElem*sizeof(u32));
  156033. }
  156034. /*
  156035. ** Free a MatchinfoBuffer object allocated using fts3MIBufferNew()
  156036. */
  156037. SQLITE_PRIVATE void sqlite3Fts3MIBufferFree(MatchinfoBuffer *p){
  156038. if( p ){
  156039. assert( p->aRef[0]==1 );
  156040. p->aRef[0] = 0;
  156041. if( p->aRef[0]==0 && p->aRef[1]==0 && p->aRef[2]==0 ){
  156042. sqlite3_free(p);
  156043. }
  156044. }
  156045. }
  156046. /*
  156047. ** End of MatchinfoBuffer code.
  156048. *************************************************************************/
  156049. /*
  156050. ** This function is used to help iterate through a position-list. A position
  156051. ** list is a list of unique integers, sorted from smallest to largest. Each
  156052. ** element of the list is represented by an FTS3 varint that takes the value
  156053. ** of the difference between the current element and the previous one plus
  156054. ** two. For example, to store the position-list:
  156055. **
  156056. ** 4 9 113
  156057. **
  156058. ** the three varints:
  156059. **
  156060. ** 6 7 106
  156061. **
  156062. ** are encoded.
  156063. **
  156064. ** When this function is called, *pp points to the start of an element of
  156065. ** the list. *piPos contains the value of the previous entry in the list.
  156066. ** After it returns, *piPos contains the value of the next element of the
  156067. ** list and *pp is advanced to the following varint.
  156068. */
  156069. static void fts3GetDeltaPosition(char **pp, int *piPos){
  156070. int iVal;
  156071. *pp += fts3GetVarint32(*pp, &iVal);
  156072. *piPos += (iVal-2);
  156073. }
  156074. /*
  156075. ** Helper function for fts3ExprIterate() (see below).
  156076. */
  156077. static int fts3ExprIterate2(
  156078. Fts3Expr *pExpr, /* Expression to iterate phrases of */
  156079. int *piPhrase, /* Pointer to phrase counter */
  156080. int (*x)(Fts3Expr*,int,void*), /* Callback function to invoke for phrases */
  156081. void *pCtx /* Second argument to pass to callback */
  156082. ){
  156083. int rc; /* Return code */
  156084. int eType = pExpr->eType; /* Type of expression node pExpr */
  156085. if( eType!=FTSQUERY_PHRASE ){
  156086. assert( pExpr->pLeft && pExpr->pRight );
  156087. rc = fts3ExprIterate2(pExpr->pLeft, piPhrase, x, pCtx);
  156088. if( rc==SQLITE_OK && eType!=FTSQUERY_NOT ){
  156089. rc = fts3ExprIterate2(pExpr->pRight, piPhrase, x, pCtx);
  156090. }
  156091. }else{
  156092. rc = x(pExpr, *piPhrase, pCtx);
  156093. (*piPhrase)++;
  156094. }
  156095. return rc;
  156096. }
  156097. /*
  156098. ** Iterate through all phrase nodes in an FTS3 query, except those that
  156099. ** are part of a sub-tree that is the right-hand-side of a NOT operator.
  156100. ** For each phrase node found, the supplied callback function is invoked.
  156101. **
  156102. ** If the callback function returns anything other than SQLITE_OK,
  156103. ** the iteration is abandoned and the error code returned immediately.
  156104. ** Otherwise, SQLITE_OK is returned after a callback has been made for
  156105. ** all eligible phrase nodes.
  156106. */
  156107. static int fts3ExprIterate(
  156108. Fts3Expr *pExpr, /* Expression to iterate phrases of */
  156109. int (*x)(Fts3Expr*,int,void*), /* Callback function to invoke for phrases */
  156110. void *pCtx /* Second argument to pass to callback */
  156111. ){
  156112. int iPhrase = 0; /* Variable used as the phrase counter */
  156113. return fts3ExprIterate2(pExpr, &iPhrase, x, pCtx);
  156114. }
  156115. /*
  156116. ** This is an fts3ExprIterate() callback used while loading the doclists
  156117. ** for each phrase into Fts3Expr.aDoclist[]/nDoclist. See also
  156118. ** fts3ExprLoadDoclists().
  156119. */
  156120. static int fts3ExprLoadDoclistsCb(Fts3Expr *pExpr, int iPhrase, void *ctx){
  156121. int rc = SQLITE_OK;
  156122. Fts3Phrase *pPhrase = pExpr->pPhrase;
  156123. LoadDoclistCtx *p = (LoadDoclistCtx *)ctx;
  156124. UNUSED_PARAMETER(iPhrase);
  156125. p->nPhrase++;
  156126. p->nToken += pPhrase->nToken;
  156127. return rc;
  156128. }
  156129. /*
  156130. ** Load the doclists for each phrase in the query associated with FTS3 cursor
  156131. ** pCsr.
  156132. **
  156133. ** If pnPhrase is not NULL, then *pnPhrase is set to the number of matchable
  156134. ** phrases in the expression (all phrases except those directly or
  156135. ** indirectly descended from the right-hand-side of a NOT operator). If
  156136. ** pnToken is not NULL, then it is set to the number of tokens in all
  156137. ** matchable phrases of the expression.
  156138. */
  156139. static int fts3ExprLoadDoclists(
  156140. Fts3Cursor *pCsr, /* Fts3 cursor for current query */
  156141. int *pnPhrase, /* OUT: Number of phrases in query */
  156142. int *pnToken /* OUT: Number of tokens in query */
  156143. ){
  156144. int rc; /* Return Code */
  156145. LoadDoclistCtx sCtx = {0,0,0}; /* Context for fts3ExprIterate() */
  156146. sCtx.pCsr = pCsr;
  156147. rc = fts3ExprIterate(pCsr->pExpr, fts3ExprLoadDoclistsCb, (void *)&sCtx);
  156148. if( pnPhrase ) *pnPhrase = sCtx.nPhrase;
  156149. if( pnToken ) *pnToken = sCtx.nToken;
  156150. return rc;
  156151. }
  156152. static int fts3ExprPhraseCountCb(Fts3Expr *pExpr, int iPhrase, void *ctx){
  156153. (*(int *)ctx)++;
  156154. pExpr->iPhrase = iPhrase;
  156155. return SQLITE_OK;
  156156. }
  156157. static int fts3ExprPhraseCount(Fts3Expr *pExpr){
  156158. int nPhrase = 0;
  156159. (void)fts3ExprIterate(pExpr, fts3ExprPhraseCountCb, (void *)&nPhrase);
  156160. return nPhrase;
  156161. }
  156162. /*
  156163. ** Advance the position list iterator specified by the first two
  156164. ** arguments so that it points to the first element with a value greater
  156165. ** than or equal to parameter iNext.
  156166. */
  156167. static void fts3SnippetAdvance(char **ppIter, int *piIter, int iNext){
  156168. char *pIter = *ppIter;
  156169. if( pIter ){
  156170. int iIter = *piIter;
  156171. while( iIter<iNext ){
  156172. if( 0==(*pIter & 0xFE) ){
  156173. iIter = -1;
  156174. pIter = 0;
  156175. break;
  156176. }
  156177. fts3GetDeltaPosition(&pIter, &iIter);
  156178. }
  156179. *piIter = iIter;
  156180. *ppIter = pIter;
  156181. }
  156182. }
  156183. /*
  156184. ** Advance the snippet iterator to the next candidate snippet.
  156185. */
  156186. static int fts3SnippetNextCandidate(SnippetIter *pIter){
  156187. int i; /* Loop counter */
  156188. if( pIter->iCurrent<0 ){
  156189. /* The SnippetIter object has just been initialized. The first snippet
  156190. ** candidate always starts at offset 0 (even if this candidate has a
  156191. ** score of 0.0).
  156192. */
  156193. pIter->iCurrent = 0;
  156194. /* Advance the 'head' iterator of each phrase to the first offset that
  156195. ** is greater than or equal to (iNext+nSnippet).
  156196. */
  156197. for(i=0; i<pIter->nPhrase; i++){
  156198. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  156199. fts3SnippetAdvance(&pPhrase->pHead, &pPhrase->iHead, pIter->nSnippet);
  156200. }
  156201. }else{
  156202. int iStart;
  156203. int iEnd = 0x7FFFFFFF;
  156204. for(i=0; i<pIter->nPhrase; i++){
  156205. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  156206. if( pPhrase->pHead && pPhrase->iHead<iEnd ){
  156207. iEnd = pPhrase->iHead;
  156208. }
  156209. }
  156210. if( iEnd==0x7FFFFFFF ){
  156211. return 1;
  156212. }
  156213. pIter->iCurrent = iStart = iEnd - pIter->nSnippet + 1;
  156214. for(i=0; i<pIter->nPhrase; i++){
  156215. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  156216. fts3SnippetAdvance(&pPhrase->pHead, &pPhrase->iHead, iEnd+1);
  156217. fts3SnippetAdvance(&pPhrase->pTail, &pPhrase->iTail, iStart);
  156218. }
  156219. }
  156220. return 0;
  156221. }
  156222. /*
  156223. ** Retrieve information about the current candidate snippet of snippet
  156224. ** iterator pIter.
  156225. */
  156226. static void fts3SnippetDetails(
  156227. SnippetIter *pIter, /* Snippet iterator */
  156228. u64 mCovered, /* Bitmask of phrases already covered */
  156229. int *piToken, /* OUT: First token of proposed snippet */
  156230. int *piScore, /* OUT: "Score" for this snippet */
  156231. u64 *pmCover, /* OUT: Bitmask of phrases covered */
  156232. u64 *pmHighlight /* OUT: Bitmask of terms to highlight */
  156233. ){
  156234. int iStart = pIter->iCurrent; /* First token of snippet */
  156235. int iScore = 0; /* Score of this snippet */
  156236. int i; /* Loop counter */
  156237. u64 mCover = 0; /* Mask of phrases covered by this snippet */
  156238. u64 mHighlight = 0; /* Mask of tokens to highlight in snippet */
  156239. for(i=0; i<pIter->nPhrase; i++){
  156240. SnippetPhrase *pPhrase = &pIter->aPhrase[i];
  156241. if( pPhrase->pTail ){
  156242. char *pCsr = pPhrase->pTail;
  156243. int iCsr = pPhrase->iTail;
  156244. while( iCsr<(iStart+pIter->nSnippet) ){
  156245. int j;
  156246. u64 mPhrase = (u64)1 << i;
  156247. u64 mPos = (u64)1 << (iCsr - iStart);
  156248. assert( iCsr>=iStart );
  156249. if( (mCover|mCovered)&mPhrase ){
  156250. iScore++;
  156251. }else{
  156252. iScore += 1000;
  156253. }
  156254. mCover |= mPhrase;
  156255. for(j=0; j<pPhrase->nToken; j++){
  156256. mHighlight |= (mPos>>j);
  156257. }
  156258. if( 0==(*pCsr & 0x0FE) ) break;
  156259. fts3GetDeltaPosition(&pCsr, &iCsr);
  156260. }
  156261. }
  156262. }
  156263. /* Set the output variables before returning. */
  156264. *piToken = iStart;
  156265. *piScore = iScore;
  156266. *pmCover = mCover;
  156267. *pmHighlight = mHighlight;
  156268. }
  156269. /*
  156270. ** This function is an fts3ExprIterate() callback used by fts3BestSnippet().
  156271. ** Each invocation populates an element of the SnippetIter.aPhrase[] array.
  156272. */
  156273. static int fts3SnippetFindPositions(Fts3Expr *pExpr, int iPhrase, void *ctx){
  156274. SnippetIter *p = (SnippetIter *)ctx;
  156275. SnippetPhrase *pPhrase = &p->aPhrase[iPhrase];
  156276. char *pCsr;
  156277. int rc;
  156278. pPhrase->nToken = pExpr->pPhrase->nToken;
  156279. rc = sqlite3Fts3EvalPhrasePoslist(p->pCsr, pExpr, p->iCol, &pCsr);
  156280. assert( rc==SQLITE_OK || pCsr==0 );
  156281. if( pCsr ){
  156282. int iFirst = 0;
  156283. pPhrase->pList = pCsr;
  156284. fts3GetDeltaPosition(&pCsr, &iFirst);
  156285. assert( iFirst>=0 );
  156286. pPhrase->pHead = pCsr;
  156287. pPhrase->pTail = pCsr;
  156288. pPhrase->iHead = iFirst;
  156289. pPhrase->iTail = iFirst;
  156290. }else{
  156291. assert( rc!=SQLITE_OK || (
  156292. pPhrase->pList==0 && pPhrase->pHead==0 && pPhrase->pTail==0
  156293. ));
  156294. }
  156295. return rc;
  156296. }
  156297. /*
  156298. ** Select the fragment of text consisting of nFragment contiguous tokens
  156299. ** from column iCol that represent the "best" snippet. The best snippet
  156300. ** is the snippet with the highest score, where scores are calculated
  156301. ** by adding:
  156302. **
  156303. ** (a) +1 point for each occurrence of a matchable phrase in the snippet.
  156304. **
  156305. ** (b) +1000 points for the first occurrence of each matchable phrase in
  156306. ** the snippet for which the corresponding mCovered bit is not set.
  156307. **
  156308. ** The selected snippet parameters are stored in structure *pFragment before
  156309. ** returning. The score of the selected snippet is stored in *piScore
  156310. ** before returning.
  156311. */
  156312. static int fts3BestSnippet(
  156313. int nSnippet, /* Desired snippet length */
  156314. Fts3Cursor *pCsr, /* Cursor to create snippet for */
  156315. int iCol, /* Index of column to create snippet from */
  156316. u64 mCovered, /* Mask of phrases already covered */
  156317. u64 *pmSeen, /* IN/OUT: Mask of phrases seen */
  156318. SnippetFragment *pFragment, /* OUT: Best snippet found */
  156319. int *piScore /* OUT: Score of snippet pFragment */
  156320. ){
  156321. int rc; /* Return Code */
  156322. int nList; /* Number of phrases in expression */
  156323. SnippetIter sIter; /* Iterates through snippet candidates */
  156324. int nByte; /* Number of bytes of space to allocate */
  156325. int iBestScore = -1; /* Best snippet score found so far */
  156326. int i; /* Loop counter */
  156327. memset(&sIter, 0, sizeof(sIter));
  156328. /* Iterate through the phrases in the expression to count them. The same
  156329. ** callback makes sure the doclists are loaded for each phrase.
  156330. */
  156331. rc = fts3ExprLoadDoclists(pCsr, &nList, 0);
  156332. if( rc!=SQLITE_OK ){
  156333. return rc;
  156334. }
  156335. /* Now that it is known how many phrases there are, allocate and zero
  156336. ** the required space using malloc().
  156337. */
  156338. nByte = sizeof(SnippetPhrase) * nList;
  156339. sIter.aPhrase = (SnippetPhrase *)sqlite3_malloc(nByte);
  156340. if( !sIter.aPhrase ){
  156341. return SQLITE_NOMEM;
  156342. }
  156343. memset(sIter.aPhrase, 0, nByte);
  156344. /* Initialize the contents of the SnippetIter object. Then iterate through
  156345. ** the set of phrases in the expression to populate the aPhrase[] array.
  156346. */
  156347. sIter.pCsr = pCsr;
  156348. sIter.iCol = iCol;
  156349. sIter.nSnippet = nSnippet;
  156350. sIter.nPhrase = nList;
  156351. sIter.iCurrent = -1;
  156352. rc = fts3ExprIterate(pCsr->pExpr, fts3SnippetFindPositions, (void*)&sIter);
  156353. if( rc==SQLITE_OK ){
  156354. /* Set the *pmSeen output variable. */
  156355. for(i=0; i<nList; i++){
  156356. if( sIter.aPhrase[i].pHead ){
  156357. *pmSeen |= (u64)1 << i;
  156358. }
  156359. }
  156360. /* Loop through all candidate snippets. Store the best snippet in
  156361. ** *pFragment. Store its associated 'score' in iBestScore.
  156362. */
  156363. pFragment->iCol = iCol;
  156364. while( !fts3SnippetNextCandidate(&sIter) ){
  156365. int iPos;
  156366. int iScore;
  156367. u64 mCover;
  156368. u64 mHighlite;
  156369. fts3SnippetDetails(&sIter, mCovered, &iPos, &iScore, &mCover,&mHighlite);
  156370. assert( iScore>=0 );
  156371. if( iScore>iBestScore ){
  156372. pFragment->iPos = iPos;
  156373. pFragment->hlmask = mHighlite;
  156374. pFragment->covered = mCover;
  156375. iBestScore = iScore;
  156376. }
  156377. }
  156378. *piScore = iBestScore;
  156379. }
  156380. sqlite3_free(sIter.aPhrase);
  156381. return rc;
  156382. }
  156383. /*
  156384. ** Append a string to the string-buffer passed as the first argument.
  156385. **
  156386. ** If nAppend is negative, then the length of the string zAppend is
  156387. ** determined using strlen().
  156388. */
  156389. static int fts3StringAppend(
  156390. StrBuffer *pStr, /* Buffer to append to */
  156391. const char *zAppend, /* Pointer to data to append to buffer */
  156392. int nAppend /* Size of zAppend in bytes (or -1) */
  156393. ){
  156394. if( nAppend<0 ){
  156395. nAppend = (int)strlen(zAppend);
  156396. }
  156397. /* If there is insufficient space allocated at StrBuffer.z, use realloc()
  156398. ** to grow the buffer until so that it is big enough to accomadate the
  156399. ** appended data.
  156400. */
  156401. if( pStr->n+nAppend+1>=pStr->nAlloc ){
  156402. int nAlloc = pStr->nAlloc+nAppend+100;
  156403. char *zNew = sqlite3_realloc(pStr->z, nAlloc);
  156404. if( !zNew ){
  156405. return SQLITE_NOMEM;
  156406. }
  156407. pStr->z = zNew;
  156408. pStr->nAlloc = nAlloc;
  156409. }
  156410. assert( pStr->z!=0 && (pStr->nAlloc >= pStr->n+nAppend+1) );
  156411. /* Append the data to the string buffer. */
  156412. memcpy(&pStr->z[pStr->n], zAppend, nAppend);
  156413. pStr->n += nAppend;
  156414. pStr->z[pStr->n] = '\0';
  156415. return SQLITE_OK;
  156416. }
  156417. /*
  156418. ** The fts3BestSnippet() function often selects snippets that end with a
  156419. ** query term. That is, the final term of the snippet is always a term
  156420. ** that requires highlighting. For example, if 'X' is a highlighted term
  156421. ** and '.' is a non-highlighted term, BestSnippet() may select:
  156422. **
  156423. ** ........X.....X
  156424. **
  156425. ** This function "shifts" the beginning of the snippet forward in the
  156426. ** document so that there are approximately the same number of
  156427. ** non-highlighted terms to the right of the final highlighted term as there
  156428. ** are to the left of the first highlighted term. For example, to this:
  156429. **
  156430. ** ....X.....X....
  156431. **
  156432. ** This is done as part of extracting the snippet text, not when selecting
  156433. ** the snippet. Snippet selection is done based on doclists only, so there
  156434. ** is no way for fts3BestSnippet() to know whether or not the document
  156435. ** actually contains terms that follow the final highlighted term.
  156436. */
  156437. static int fts3SnippetShift(
  156438. Fts3Table *pTab, /* FTS3 table snippet comes from */
  156439. int iLangid, /* Language id to use in tokenizing */
  156440. int nSnippet, /* Number of tokens desired for snippet */
  156441. const char *zDoc, /* Document text to extract snippet from */
  156442. int nDoc, /* Size of buffer zDoc in bytes */
  156443. int *piPos, /* IN/OUT: First token of snippet */
  156444. u64 *pHlmask /* IN/OUT: Mask of tokens to highlight */
  156445. ){
  156446. u64 hlmask = *pHlmask; /* Local copy of initial highlight-mask */
  156447. if( hlmask ){
  156448. int nLeft; /* Tokens to the left of first highlight */
  156449. int nRight; /* Tokens to the right of last highlight */
  156450. int nDesired; /* Ideal number of tokens to shift forward */
  156451. for(nLeft=0; !(hlmask & ((u64)1 << nLeft)); nLeft++);
  156452. for(nRight=0; !(hlmask & ((u64)1 << (nSnippet-1-nRight))); nRight++);
  156453. nDesired = (nLeft-nRight)/2;
  156454. /* Ideally, the start of the snippet should be pushed forward in the
  156455. ** document nDesired tokens. This block checks if there are actually
  156456. ** nDesired tokens to the right of the snippet. If so, *piPos and
  156457. ** *pHlMask are updated to shift the snippet nDesired tokens to the
  156458. ** right. Otherwise, the snippet is shifted by the number of tokens
  156459. ** available.
  156460. */
  156461. if( nDesired>0 ){
  156462. int nShift; /* Number of tokens to shift snippet by */
  156463. int iCurrent = 0; /* Token counter */
  156464. int rc; /* Return Code */
  156465. sqlite3_tokenizer_module *pMod;
  156466. sqlite3_tokenizer_cursor *pC;
  156467. pMod = (sqlite3_tokenizer_module *)pTab->pTokenizer->pModule;
  156468. /* Open a cursor on zDoc/nDoc. Check if there are (nSnippet+nDesired)
  156469. ** or more tokens in zDoc/nDoc.
  156470. */
  156471. rc = sqlite3Fts3OpenTokenizer(pTab->pTokenizer, iLangid, zDoc, nDoc, &pC);
  156472. if( rc!=SQLITE_OK ){
  156473. return rc;
  156474. }
  156475. while( rc==SQLITE_OK && iCurrent<(nSnippet+nDesired) ){
  156476. const char *ZDUMMY; int DUMMY1 = 0, DUMMY2 = 0, DUMMY3 = 0;
  156477. rc = pMod->xNext(pC, &ZDUMMY, &DUMMY1, &DUMMY2, &DUMMY3, &iCurrent);
  156478. }
  156479. pMod->xClose(pC);
  156480. if( rc!=SQLITE_OK && rc!=SQLITE_DONE ){ return rc; }
  156481. nShift = (rc==SQLITE_DONE)+iCurrent-nSnippet;
  156482. assert( nShift<=nDesired );
  156483. if( nShift>0 ){
  156484. *piPos += nShift;
  156485. *pHlmask = hlmask >> nShift;
  156486. }
  156487. }
  156488. }
  156489. return SQLITE_OK;
  156490. }
  156491. /*
  156492. ** Extract the snippet text for fragment pFragment from cursor pCsr and
  156493. ** append it to string buffer pOut.
  156494. */
  156495. static int fts3SnippetText(
  156496. Fts3Cursor *pCsr, /* FTS3 Cursor */
  156497. SnippetFragment *pFragment, /* Snippet to extract */
  156498. int iFragment, /* Fragment number */
  156499. int isLast, /* True for final fragment in snippet */
  156500. int nSnippet, /* Number of tokens in extracted snippet */
  156501. const char *zOpen, /* String inserted before highlighted term */
  156502. const char *zClose, /* String inserted after highlighted term */
  156503. const char *zEllipsis, /* String inserted between snippets */
  156504. StrBuffer *pOut /* Write output here */
  156505. ){
  156506. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  156507. int rc; /* Return code */
  156508. const char *zDoc; /* Document text to extract snippet from */
  156509. int nDoc; /* Size of zDoc in bytes */
  156510. int iCurrent = 0; /* Current token number of document */
  156511. int iEnd = 0; /* Byte offset of end of current token */
  156512. int isShiftDone = 0; /* True after snippet is shifted */
  156513. int iPos = pFragment->iPos; /* First token of snippet */
  156514. u64 hlmask = pFragment->hlmask; /* Highlight-mask for snippet */
  156515. int iCol = pFragment->iCol+1; /* Query column to extract text from */
  156516. sqlite3_tokenizer_module *pMod; /* Tokenizer module methods object */
  156517. sqlite3_tokenizer_cursor *pC; /* Tokenizer cursor open on zDoc/nDoc */
  156518. zDoc = (const char *)sqlite3_column_text(pCsr->pStmt, iCol);
  156519. if( zDoc==0 ){
  156520. if( sqlite3_column_type(pCsr->pStmt, iCol)!=SQLITE_NULL ){
  156521. return SQLITE_NOMEM;
  156522. }
  156523. return SQLITE_OK;
  156524. }
  156525. nDoc = sqlite3_column_bytes(pCsr->pStmt, iCol);
  156526. /* Open a token cursor on the document. */
  156527. pMod = (sqlite3_tokenizer_module *)pTab->pTokenizer->pModule;
  156528. rc = sqlite3Fts3OpenTokenizer(pTab->pTokenizer, pCsr->iLangid, zDoc,nDoc,&pC);
  156529. if( rc!=SQLITE_OK ){
  156530. return rc;
  156531. }
  156532. while( rc==SQLITE_OK ){
  156533. const char *ZDUMMY; /* Dummy argument used with tokenizer */
  156534. int DUMMY1 = -1; /* Dummy argument used with tokenizer */
  156535. int iBegin = 0; /* Offset in zDoc of start of token */
  156536. int iFin = 0; /* Offset in zDoc of end of token */
  156537. int isHighlight = 0; /* True for highlighted terms */
  156538. /* Variable DUMMY1 is initialized to a negative value above. Elsewhere
  156539. ** in the FTS code the variable that the third argument to xNext points to
  156540. ** is initialized to zero before the first (*but not necessarily
  156541. ** subsequent*) call to xNext(). This is done for a particular application
  156542. ** that needs to know whether or not the tokenizer is being used for
  156543. ** snippet generation or for some other purpose.
  156544. **
  156545. ** Extreme care is required when writing code to depend on this
  156546. ** initialization. It is not a documented part of the tokenizer interface.
  156547. ** If a tokenizer is used directly by any code outside of FTS, this
  156548. ** convention might not be respected. */
  156549. rc = pMod->xNext(pC, &ZDUMMY, &DUMMY1, &iBegin, &iFin, &iCurrent);
  156550. if( rc!=SQLITE_OK ){
  156551. if( rc==SQLITE_DONE ){
  156552. /* Special case - the last token of the snippet is also the last token
  156553. ** of the column. Append any punctuation that occurred between the end
  156554. ** of the previous token and the end of the document to the output.
  156555. ** Then break out of the loop. */
  156556. rc = fts3StringAppend(pOut, &zDoc[iEnd], -1);
  156557. }
  156558. break;
  156559. }
  156560. if( iCurrent<iPos ){ continue; }
  156561. if( !isShiftDone ){
  156562. int n = nDoc - iBegin;
  156563. rc = fts3SnippetShift(
  156564. pTab, pCsr->iLangid, nSnippet, &zDoc[iBegin], n, &iPos, &hlmask
  156565. );
  156566. isShiftDone = 1;
  156567. /* Now that the shift has been done, check if the initial "..." are
  156568. ** required. They are required if (a) this is not the first fragment,
  156569. ** or (b) this fragment does not begin at position 0 of its column.
  156570. */
  156571. if( rc==SQLITE_OK ){
  156572. if( iPos>0 || iFragment>0 ){
  156573. rc = fts3StringAppend(pOut, zEllipsis, -1);
  156574. }else if( iBegin ){
  156575. rc = fts3StringAppend(pOut, zDoc, iBegin);
  156576. }
  156577. }
  156578. if( rc!=SQLITE_OK || iCurrent<iPos ) continue;
  156579. }
  156580. if( iCurrent>=(iPos+nSnippet) ){
  156581. if( isLast ){
  156582. rc = fts3StringAppend(pOut, zEllipsis, -1);
  156583. }
  156584. break;
  156585. }
  156586. /* Set isHighlight to true if this term should be highlighted. */
  156587. isHighlight = (hlmask & ((u64)1 << (iCurrent-iPos)))!=0;
  156588. if( iCurrent>iPos ) rc = fts3StringAppend(pOut, &zDoc[iEnd], iBegin-iEnd);
  156589. if( rc==SQLITE_OK && isHighlight ) rc = fts3StringAppend(pOut, zOpen, -1);
  156590. if( rc==SQLITE_OK ) rc = fts3StringAppend(pOut, &zDoc[iBegin], iFin-iBegin);
  156591. if( rc==SQLITE_OK && isHighlight ) rc = fts3StringAppend(pOut, zClose, -1);
  156592. iEnd = iFin;
  156593. }
  156594. pMod->xClose(pC);
  156595. return rc;
  156596. }
  156597. /*
  156598. ** This function is used to count the entries in a column-list (a
  156599. ** delta-encoded list of term offsets within a single column of a single
  156600. ** row). When this function is called, *ppCollist should point to the
  156601. ** beginning of the first varint in the column-list (the varint that
  156602. ** contains the position of the first matching term in the column data).
  156603. ** Before returning, *ppCollist is set to point to the first byte after
  156604. ** the last varint in the column-list (either the 0x00 signifying the end
  156605. ** of the position-list, or the 0x01 that precedes the column number of
  156606. ** the next column in the position-list).
  156607. **
  156608. ** The number of elements in the column-list is returned.
  156609. */
  156610. static int fts3ColumnlistCount(char **ppCollist){
  156611. char *pEnd = *ppCollist;
  156612. char c = 0;
  156613. int nEntry = 0;
  156614. /* A column-list is terminated by either a 0x01 or 0x00. */
  156615. while( 0xFE & (*pEnd | c) ){
  156616. c = *pEnd++ & 0x80;
  156617. if( !c ) nEntry++;
  156618. }
  156619. *ppCollist = pEnd;
  156620. return nEntry;
  156621. }
  156622. /*
  156623. ** This function gathers 'y' or 'b' data for a single phrase.
  156624. */
  156625. static void fts3ExprLHits(
  156626. Fts3Expr *pExpr, /* Phrase expression node */
  156627. MatchInfo *p /* Matchinfo context */
  156628. ){
  156629. Fts3Table *pTab = (Fts3Table *)p->pCursor->base.pVtab;
  156630. int iStart;
  156631. Fts3Phrase *pPhrase = pExpr->pPhrase;
  156632. char *pIter = pPhrase->doclist.pList;
  156633. int iCol = 0;
  156634. assert( p->flag==FTS3_MATCHINFO_LHITS_BM || p->flag==FTS3_MATCHINFO_LHITS );
  156635. if( p->flag==FTS3_MATCHINFO_LHITS ){
  156636. iStart = pExpr->iPhrase * p->nCol;
  156637. }else{
  156638. iStart = pExpr->iPhrase * ((p->nCol + 31) / 32);
  156639. }
  156640. while( 1 ){
  156641. int nHit = fts3ColumnlistCount(&pIter);
  156642. if( (pPhrase->iColumn>=pTab->nColumn || pPhrase->iColumn==iCol) ){
  156643. if( p->flag==FTS3_MATCHINFO_LHITS ){
  156644. p->aMatchinfo[iStart + iCol] = (u32)nHit;
  156645. }else if( nHit ){
  156646. p->aMatchinfo[iStart + (iCol+1)/32] |= (1 << (iCol&0x1F));
  156647. }
  156648. }
  156649. assert( *pIter==0x00 || *pIter==0x01 );
  156650. if( *pIter!=0x01 ) break;
  156651. pIter++;
  156652. pIter += fts3GetVarint32(pIter, &iCol);
  156653. }
  156654. }
  156655. /*
  156656. ** Gather the results for matchinfo directives 'y' and 'b'.
  156657. */
  156658. static void fts3ExprLHitGather(
  156659. Fts3Expr *pExpr,
  156660. MatchInfo *p
  156661. ){
  156662. assert( (pExpr->pLeft==0)==(pExpr->pRight==0) );
  156663. if( pExpr->bEof==0 && pExpr->iDocid==p->pCursor->iPrevId ){
  156664. if( pExpr->pLeft ){
  156665. fts3ExprLHitGather(pExpr->pLeft, p);
  156666. fts3ExprLHitGather(pExpr->pRight, p);
  156667. }else{
  156668. fts3ExprLHits(pExpr, p);
  156669. }
  156670. }
  156671. }
  156672. /*
  156673. ** fts3ExprIterate() callback used to collect the "global" matchinfo stats
  156674. ** for a single query.
  156675. **
  156676. ** fts3ExprIterate() callback to load the 'global' elements of a
  156677. ** FTS3_MATCHINFO_HITS matchinfo array. The global stats are those elements
  156678. ** of the matchinfo array that are constant for all rows returned by the
  156679. ** current query.
  156680. **
  156681. ** Argument pCtx is actually a pointer to a struct of type MatchInfo. This
  156682. ** function populates Matchinfo.aMatchinfo[] as follows:
  156683. **
  156684. ** for(iCol=0; iCol<nCol; iCol++){
  156685. ** aMatchinfo[3*iPhrase*nCol + 3*iCol + 1] = X;
  156686. ** aMatchinfo[3*iPhrase*nCol + 3*iCol + 2] = Y;
  156687. ** }
  156688. **
  156689. ** where X is the number of matches for phrase iPhrase is column iCol of all
  156690. ** rows of the table. Y is the number of rows for which column iCol contains
  156691. ** at least one instance of phrase iPhrase.
  156692. **
  156693. ** If the phrase pExpr consists entirely of deferred tokens, then all X and
  156694. ** Y values are set to nDoc, where nDoc is the number of documents in the
  156695. ** file system. This is done because the full-text index doclist is required
  156696. ** to calculate these values properly, and the full-text index doclist is
  156697. ** not available for deferred tokens.
  156698. */
  156699. static int fts3ExprGlobalHitsCb(
  156700. Fts3Expr *pExpr, /* Phrase expression node */
  156701. int iPhrase, /* Phrase number (numbered from zero) */
  156702. void *pCtx /* Pointer to MatchInfo structure */
  156703. ){
  156704. MatchInfo *p = (MatchInfo *)pCtx;
  156705. return sqlite3Fts3EvalPhraseStats(
  156706. p->pCursor, pExpr, &p->aMatchinfo[3*iPhrase*p->nCol]
  156707. );
  156708. }
  156709. /*
  156710. ** fts3ExprIterate() callback used to collect the "local" part of the
  156711. ** FTS3_MATCHINFO_HITS array. The local stats are those elements of the
  156712. ** array that are different for each row returned by the query.
  156713. */
  156714. static int fts3ExprLocalHitsCb(
  156715. Fts3Expr *pExpr, /* Phrase expression node */
  156716. int iPhrase, /* Phrase number */
  156717. void *pCtx /* Pointer to MatchInfo structure */
  156718. ){
  156719. int rc = SQLITE_OK;
  156720. MatchInfo *p = (MatchInfo *)pCtx;
  156721. int iStart = iPhrase * p->nCol * 3;
  156722. int i;
  156723. for(i=0; i<p->nCol && rc==SQLITE_OK; i++){
  156724. char *pCsr;
  156725. rc = sqlite3Fts3EvalPhrasePoslist(p->pCursor, pExpr, i, &pCsr);
  156726. if( pCsr ){
  156727. p->aMatchinfo[iStart+i*3] = fts3ColumnlistCount(&pCsr);
  156728. }else{
  156729. p->aMatchinfo[iStart+i*3] = 0;
  156730. }
  156731. }
  156732. return rc;
  156733. }
  156734. static int fts3MatchinfoCheck(
  156735. Fts3Table *pTab,
  156736. char cArg,
  156737. char **pzErr
  156738. ){
  156739. if( (cArg==FTS3_MATCHINFO_NPHRASE)
  156740. || (cArg==FTS3_MATCHINFO_NCOL)
  156741. || (cArg==FTS3_MATCHINFO_NDOC && pTab->bFts4)
  156742. || (cArg==FTS3_MATCHINFO_AVGLENGTH && pTab->bFts4)
  156743. || (cArg==FTS3_MATCHINFO_LENGTH && pTab->bHasDocsize)
  156744. || (cArg==FTS3_MATCHINFO_LCS)
  156745. || (cArg==FTS3_MATCHINFO_HITS)
  156746. || (cArg==FTS3_MATCHINFO_LHITS)
  156747. || (cArg==FTS3_MATCHINFO_LHITS_BM)
  156748. ){
  156749. return SQLITE_OK;
  156750. }
  156751. sqlite3Fts3ErrMsg(pzErr, "unrecognized matchinfo request: %c", cArg);
  156752. return SQLITE_ERROR;
  156753. }
  156754. static int fts3MatchinfoSize(MatchInfo *pInfo, char cArg){
  156755. int nVal; /* Number of integers output by cArg */
  156756. switch( cArg ){
  156757. case FTS3_MATCHINFO_NDOC:
  156758. case FTS3_MATCHINFO_NPHRASE:
  156759. case FTS3_MATCHINFO_NCOL:
  156760. nVal = 1;
  156761. break;
  156762. case FTS3_MATCHINFO_AVGLENGTH:
  156763. case FTS3_MATCHINFO_LENGTH:
  156764. case FTS3_MATCHINFO_LCS:
  156765. nVal = pInfo->nCol;
  156766. break;
  156767. case FTS3_MATCHINFO_LHITS:
  156768. nVal = pInfo->nCol * pInfo->nPhrase;
  156769. break;
  156770. case FTS3_MATCHINFO_LHITS_BM:
  156771. nVal = pInfo->nPhrase * ((pInfo->nCol + 31) / 32);
  156772. break;
  156773. default:
  156774. assert( cArg==FTS3_MATCHINFO_HITS );
  156775. nVal = pInfo->nCol * pInfo->nPhrase * 3;
  156776. break;
  156777. }
  156778. return nVal;
  156779. }
  156780. static int fts3MatchinfoSelectDoctotal(
  156781. Fts3Table *pTab,
  156782. sqlite3_stmt **ppStmt,
  156783. sqlite3_int64 *pnDoc,
  156784. const char **paLen
  156785. ){
  156786. sqlite3_stmt *pStmt;
  156787. const char *a;
  156788. sqlite3_int64 nDoc;
  156789. if( !*ppStmt ){
  156790. int rc = sqlite3Fts3SelectDoctotal(pTab, ppStmt);
  156791. if( rc!=SQLITE_OK ) return rc;
  156792. }
  156793. pStmt = *ppStmt;
  156794. assert( sqlite3_data_count(pStmt)==1 );
  156795. a = sqlite3_column_blob(pStmt, 0);
  156796. a += sqlite3Fts3GetVarint(a, &nDoc);
  156797. if( nDoc==0 ) return FTS_CORRUPT_VTAB;
  156798. *pnDoc = (u32)nDoc;
  156799. if( paLen ) *paLen = a;
  156800. return SQLITE_OK;
  156801. }
  156802. /*
  156803. ** An instance of the following structure is used to store state while
  156804. ** iterating through a multi-column position-list corresponding to the
  156805. ** hits for a single phrase on a single row in order to calculate the
  156806. ** values for a matchinfo() FTS3_MATCHINFO_LCS request.
  156807. */
  156808. typedef struct LcsIterator LcsIterator;
  156809. struct LcsIterator {
  156810. Fts3Expr *pExpr; /* Pointer to phrase expression */
  156811. int iPosOffset; /* Tokens count up to end of this phrase */
  156812. char *pRead; /* Cursor used to iterate through aDoclist */
  156813. int iPos; /* Current position */
  156814. };
  156815. /*
  156816. ** If LcsIterator.iCol is set to the following value, the iterator has
  156817. ** finished iterating through all offsets for all columns.
  156818. */
  156819. #define LCS_ITERATOR_FINISHED 0x7FFFFFFF;
  156820. static int fts3MatchinfoLcsCb(
  156821. Fts3Expr *pExpr, /* Phrase expression node */
  156822. int iPhrase, /* Phrase number (numbered from zero) */
  156823. void *pCtx /* Pointer to MatchInfo structure */
  156824. ){
  156825. LcsIterator *aIter = (LcsIterator *)pCtx;
  156826. aIter[iPhrase].pExpr = pExpr;
  156827. return SQLITE_OK;
  156828. }
  156829. /*
  156830. ** Advance the iterator passed as an argument to the next position. Return
  156831. ** 1 if the iterator is at EOF or if it now points to the start of the
  156832. ** position list for the next column.
  156833. */
  156834. static int fts3LcsIteratorAdvance(LcsIterator *pIter){
  156835. char *pRead = pIter->pRead;
  156836. sqlite3_int64 iRead;
  156837. int rc = 0;
  156838. pRead += sqlite3Fts3GetVarint(pRead, &iRead);
  156839. if( iRead==0 || iRead==1 ){
  156840. pRead = 0;
  156841. rc = 1;
  156842. }else{
  156843. pIter->iPos += (int)(iRead-2);
  156844. }
  156845. pIter->pRead = pRead;
  156846. return rc;
  156847. }
  156848. /*
  156849. ** This function implements the FTS3_MATCHINFO_LCS matchinfo() flag.
  156850. **
  156851. ** If the call is successful, the longest-common-substring lengths for each
  156852. ** column are written into the first nCol elements of the pInfo->aMatchinfo[]
  156853. ** array before returning. SQLITE_OK is returned in this case.
  156854. **
  156855. ** Otherwise, if an error occurs, an SQLite error code is returned and the
  156856. ** data written to the first nCol elements of pInfo->aMatchinfo[] is
  156857. ** undefined.
  156858. */
  156859. static int fts3MatchinfoLcs(Fts3Cursor *pCsr, MatchInfo *pInfo){
  156860. LcsIterator *aIter;
  156861. int i;
  156862. int iCol;
  156863. int nToken = 0;
  156864. /* Allocate and populate the array of LcsIterator objects. The array
  156865. ** contains one element for each matchable phrase in the query.
  156866. **/
  156867. aIter = sqlite3_malloc(sizeof(LcsIterator) * pCsr->nPhrase);
  156868. if( !aIter ) return SQLITE_NOMEM;
  156869. memset(aIter, 0, sizeof(LcsIterator) * pCsr->nPhrase);
  156870. (void)fts3ExprIterate(pCsr->pExpr, fts3MatchinfoLcsCb, (void*)aIter);
  156871. for(i=0; i<pInfo->nPhrase; i++){
  156872. LcsIterator *pIter = &aIter[i];
  156873. nToken -= pIter->pExpr->pPhrase->nToken;
  156874. pIter->iPosOffset = nToken;
  156875. }
  156876. for(iCol=0; iCol<pInfo->nCol; iCol++){
  156877. int nLcs = 0; /* LCS value for this column */
  156878. int nLive = 0; /* Number of iterators in aIter not at EOF */
  156879. for(i=0; i<pInfo->nPhrase; i++){
  156880. int rc;
  156881. LcsIterator *pIt = &aIter[i];
  156882. rc = sqlite3Fts3EvalPhrasePoslist(pCsr, pIt->pExpr, iCol, &pIt->pRead);
  156883. if( rc!=SQLITE_OK ) return rc;
  156884. if( pIt->pRead ){
  156885. pIt->iPos = pIt->iPosOffset;
  156886. fts3LcsIteratorAdvance(&aIter[i]);
  156887. nLive++;
  156888. }
  156889. }
  156890. while( nLive>0 ){
  156891. LcsIterator *pAdv = 0; /* The iterator to advance by one position */
  156892. int nThisLcs = 0; /* LCS for the current iterator positions */
  156893. for(i=0; i<pInfo->nPhrase; i++){
  156894. LcsIterator *pIter = &aIter[i];
  156895. if( pIter->pRead==0 ){
  156896. /* This iterator is already at EOF for this column. */
  156897. nThisLcs = 0;
  156898. }else{
  156899. if( pAdv==0 || pIter->iPos<pAdv->iPos ){
  156900. pAdv = pIter;
  156901. }
  156902. if( nThisLcs==0 || pIter->iPos==pIter[-1].iPos ){
  156903. nThisLcs++;
  156904. }else{
  156905. nThisLcs = 1;
  156906. }
  156907. if( nThisLcs>nLcs ) nLcs = nThisLcs;
  156908. }
  156909. }
  156910. if( fts3LcsIteratorAdvance(pAdv) ) nLive--;
  156911. }
  156912. pInfo->aMatchinfo[iCol] = nLcs;
  156913. }
  156914. sqlite3_free(aIter);
  156915. return SQLITE_OK;
  156916. }
  156917. /*
  156918. ** Populate the buffer pInfo->aMatchinfo[] with an array of integers to
  156919. ** be returned by the matchinfo() function. Argument zArg contains the
  156920. ** format string passed as the second argument to matchinfo (or the
  156921. ** default value "pcx" if no second argument was specified). The format
  156922. ** string has already been validated and the pInfo->aMatchinfo[] array
  156923. ** is guaranteed to be large enough for the output.
  156924. **
  156925. ** If bGlobal is true, then populate all fields of the matchinfo() output.
  156926. ** If it is false, then assume that those fields that do not change between
  156927. ** rows (i.e. FTS3_MATCHINFO_NPHRASE, NCOL, NDOC, AVGLENGTH and part of HITS)
  156928. ** have already been populated.
  156929. **
  156930. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  156931. ** occurs. If a value other than SQLITE_OK is returned, the state the
  156932. ** pInfo->aMatchinfo[] buffer is left in is undefined.
  156933. */
  156934. static int fts3MatchinfoValues(
  156935. Fts3Cursor *pCsr, /* FTS3 cursor object */
  156936. int bGlobal, /* True to grab the global stats */
  156937. MatchInfo *pInfo, /* Matchinfo context object */
  156938. const char *zArg /* Matchinfo format string */
  156939. ){
  156940. int rc = SQLITE_OK;
  156941. int i;
  156942. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  156943. sqlite3_stmt *pSelect = 0;
  156944. for(i=0; rc==SQLITE_OK && zArg[i]; i++){
  156945. pInfo->flag = zArg[i];
  156946. switch( zArg[i] ){
  156947. case FTS3_MATCHINFO_NPHRASE:
  156948. if( bGlobal ) pInfo->aMatchinfo[0] = pInfo->nPhrase;
  156949. break;
  156950. case FTS3_MATCHINFO_NCOL:
  156951. if( bGlobal ) pInfo->aMatchinfo[0] = pInfo->nCol;
  156952. break;
  156953. case FTS3_MATCHINFO_NDOC:
  156954. if( bGlobal ){
  156955. sqlite3_int64 nDoc = 0;
  156956. rc = fts3MatchinfoSelectDoctotal(pTab, &pSelect, &nDoc, 0);
  156957. pInfo->aMatchinfo[0] = (u32)nDoc;
  156958. }
  156959. break;
  156960. case FTS3_MATCHINFO_AVGLENGTH:
  156961. if( bGlobal ){
  156962. sqlite3_int64 nDoc; /* Number of rows in table */
  156963. const char *a; /* Aggregate column length array */
  156964. rc = fts3MatchinfoSelectDoctotal(pTab, &pSelect, &nDoc, &a);
  156965. if( rc==SQLITE_OK ){
  156966. int iCol;
  156967. for(iCol=0; iCol<pInfo->nCol; iCol++){
  156968. u32 iVal;
  156969. sqlite3_int64 nToken;
  156970. a += sqlite3Fts3GetVarint(a, &nToken);
  156971. iVal = (u32)(((u32)(nToken&0xffffffff)+nDoc/2)/nDoc);
  156972. pInfo->aMatchinfo[iCol] = iVal;
  156973. }
  156974. }
  156975. }
  156976. break;
  156977. case FTS3_MATCHINFO_LENGTH: {
  156978. sqlite3_stmt *pSelectDocsize = 0;
  156979. rc = sqlite3Fts3SelectDocsize(pTab, pCsr->iPrevId, &pSelectDocsize);
  156980. if( rc==SQLITE_OK ){
  156981. int iCol;
  156982. const char *a = sqlite3_column_blob(pSelectDocsize, 0);
  156983. for(iCol=0; iCol<pInfo->nCol; iCol++){
  156984. sqlite3_int64 nToken;
  156985. a += sqlite3Fts3GetVarint(a, &nToken);
  156986. pInfo->aMatchinfo[iCol] = (u32)nToken;
  156987. }
  156988. }
  156989. sqlite3_reset(pSelectDocsize);
  156990. break;
  156991. }
  156992. case FTS3_MATCHINFO_LCS:
  156993. rc = fts3ExprLoadDoclists(pCsr, 0, 0);
  156994. if( rc==SQLITE_OK ){
  156995. rc = fts3MatchinfoLcs(pCsr, pInfo);
  156996. }
  156997. break;
  156998. case FTS3_MATCHINFO_LHITS_BM:
  156999. case FTS3_MATCHINFO_LHITS: {
  157000. int nZero = fts3MatchinfoSize(pInfo, zArg[i]) * sizeof(u32);
  157001. memset(pInfo->aMatchinfo, 0, nZero);
  157002. fts3ExprLHitGather(pCsr->pExpr, pInfo);
  157003. break;
  157004. }
  157005. default: {
  157006. Fts3Expr *pExpr;
  157007. assert( zArg[i]==FTS3_MATCHINFO_HITS );
  157008. pExpr = pCsr->pExpr;
  157009. rc = fts3ExprLoadDoclists(pCsr, 0, 0);
  157010. if( rc!=SQLITE_OK ) break;
  157011. if( bGlobal ){
  157012. if( pCsr->pDeferred ){
  157013. rc = fts3MatchinfoSelectDoctotal(pTab, &pSelect, &pInfo->nDoc, 0);
  157014. if( rc!=SQLITE_OK ) break;
  157015. }
  157016. rc = fts3ExprIterate(pExpr, fts3ExprGlobalHitsCb,(void*)pInfo);
  157017. sqlite3Fts3EvalTestDeferred(pCsr, &rc);
  157018. if( rc!=SQLITE_OK ) break;
  157019. }
  157020. (void)fts3ExprIterate(pExpr, fts3ExprLocalHitsCb,(void*)pInfo);
  157021. break;
  157022. }
  157023. }
  157024. pInfo->aMatchinfo += fts3MatchinfoSize(pInfo, zArg[i]);
  157025. }
  157026. sqlite3_reset(pSelect);
  157027. return rc;
  157028. }
  157029. /*
  157030. ** Populate pCsr->aMatchinfo[] with data for the current row. The
  157031. ** 'matchinfo' data is an array of 32-bit unsigned integers (C type u32).
  157032. */
  157033. static void fts3GetMatchinfo(
  157034. sqlite3_context *pCtx, /* Return results here */
  157035. Fts3Cursor *pCsr, /* FTS3 Cursor object */
  157036. const char *zArg /* Second argument to matchinfo() function */
  157037. ){
  157038. MatchInfo sInfo;
  157039. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  157040. int rc = SQLITE_OK;
  157041. int bGlobal = 0; /* Collect 'global' stats as well as local */
  157042. u32 *aOut = 0;
  157043. void (*xDestroyOut)(void*) = 0;
  157044. memset(&sInfo, 0, sizeof(MatchInfo));
  157045. sInfo.pCursor = pCsr;
  157046. sInfo.nCol = pTab->nColumn;
  157047. /* If there is cached matchinfo() data, but the format string for the
  157048. ** cache does not match the format string for this request, discard
  157049. ** the cached data. */
  157050. if( pCsr->pMIBuffer && strcmp(pCsr->pMIBuffer->zMatchinfo, zArg) ){
  157051. sqlite3Fts3MIBufferFree(pCsr->pMIBuffer);
  157052. pCsr->pMIBuffer = 0;
  157053. }
  157054. /* If Fts3Cursor.pMIBuffer is NULL, then this is the first time the
  157055. ** matchinfo function has been called for this query. In this case
  157056. ** allocate the array used to accumulate the matchinfo data and
  157057. ** initialize those elements that are constant for every row.
  157058. */
  157059. if( pCsr->pMIBuffer==0 ){
  157060. int nMatchinfo = 0; /* Number of u32 elements in match-info */
  157061. int i; /* Used to iterate through zArg */
  157062. /* Determine the number of phrases in the query */
  157063. pCsr->nPhrase = fts3ExprPhraseCount(pCsr->pExpr);
  157064. sInfo.nPhrase = pCsr->nPhrase;
  157065. /* Determine the number of integers in the buffer returned by this call. */
  157066. for(i=0; zArg[i]; i++){
  157067. char *zErr = 0;
  157068. if( fts3MatchinfoCheck(pTab, zArg[i], &zErr) ){
  157069. sqlite3_result_error(pCtx, zErr, -1);
  157070. sqlite3_free(zErr);
  157071. return;
  157072. }
  157073. nMatchinfo += fts3MatchinfoSize(&sInfo, zArg[i]);
  157074. }
  157075. /* Allocate space for Fts3Cursor.aMatchinfo[] and Fts3Cursor.zMatchinfo. */
  157076. pCsr->pMIBuffer = fts3MIBufferNew(nMatchinfo, zArg);
  157077. if( !pCsr->pMIBuffer ) rc = SQLITE_NOMEM;
  157078. pCsr->isMatchinfoNeeded = 1;
  157079. bGlobal = 1;
  157080. }
  157081. if( rc==SQLITE_OK ){
  157082. xDestroyOut = fts3MIBufferAlloc(pCsr->pMIBuffer, &aOut);
  157083. if( xDestroyOut==0 ){
  157084. rc = SQLITE_NOMEM;
  157085. }
  157086. }
  157087. if( rc==SQLITE_OK ){
  157088. sInfo.aMatchinfo = aOut;
  157089. sInfo.nPhrase = pCsr->nPhrase;
  157090. rc = fts3MatchinfoValues(pCsr, bGlobal, &sInfo, zArg);
  157091. if( bGlobal ){
  157092. fts3MIBufferSetGlobal(pCsr->pMIBuffer);
  157093. }
  157094. }
  157095. if( rc!=SQLITE_OK ){
  157096. sqlite3_result_error_code(pCtx, rc);
  157097. if( xDestroyOut ) xDestroyOut(aOut);
  157098. }else{
  157099. int n = pCsr->pMIBuffer->nElem * sizeof(u32);
  157100. sqlite3_result_blob(pCtx, aOut, n, xDestroyOut);
  157101. }
  157102. }
  157103. /*
  157104. ** Implementation of snippet() function.
  157105. */
  157106. SQLITE_PRIVATE void sqlite3Fts3Snippet(
  157107. sqlite3_context *pCtx, /* SQLite function call context */
  157108. Fts3Cursor *pCsr, /* Cursor object */
  157109. const char *zStart, /* Snippet start text - "<b>" */
  157110. const char *zEnd, /* Snippet end text - "</b>" */
  157111. const char *zEllipsis, /* Snippet ellipsis text - "<b>...</b>" */
  157112. int iCol, /* Extract snippet from this column */
  157113. int nToken /* Approximate number of tokens in snippet */
  157114. ){
  157115. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  157116. int rc = SQLITE_OK;
  157117. int i;
  157118. StrBuffer res = {0, 0, 0};
  157119. /* The returned text includes up to four fragments of text extracted from
  157120. ** the data in the current row. The first iteration of the for(...) loop
  157121. ** below attempts to locate a single fragment of text nToken tokens in
  157122. ** size that contains at least one instance of all phrases in the query
  157123. ** expression that appear in the current row. If such a fragment of text
  157124. ** cannot be found, the second iteration of the loop attempts to locate
  157125. ** a pair of fragments, and so on.
  157126. */
  157127. int nSnippet = 0; /* Number of fragments in this snippet */
  157128. SnippetFragment aSnippet[4]; /* Maximum of 4 fragments per snippet */
  157129. int nFToken = -1; /* Number of tokens in each fragment */
  157130. if( !pCsr->pExpr ){
  157131. sqlite3_result_text(pCtx, "", 0, SQLITE_STATIC);
  157132. return;
  157133. }
  157134. for(nSnippet=1; 1; nSnippet++){
  157135. int iSnip; /* Loop counter 0..nSnippet-1 */
  157136. u64 mCovered = 0; /* Bitmask of phrases covered by snippet */
  157137. u64 mSeen = 0; /* Bitmask of phrases seen by BestSnippet() */
  157138. if( nToken>=0 ){
  157139. nFToken = (nToken+nSnippet-1) / nSnippet;
  157140. }else{
  157141. nFToken = -1 * nToken;
  157142. }
  157143. for(iSnip=0; iSnip<nSnippet; iSnip++){
  157144. int iBestScore = -1; /* Best score of columns checked so far */
  157145. int iRead; /* Used to iterate through columns */
  157146. SnippetFragment *pFragment = &aSnippet[iSnip];
  157147. memset(pFragment, 0, sizeof(*pFragment));
  157148. /* Loop through all columns of the table being considered for snippets.
  157149. ** If the iCol argument to this function was negative, this means all
  157150. ** columns of the FTS3 table. Otherwise, only column iCol is considered.
  157151. */
  157152. for(iRead=0; iRead<pTab->nColumn; iRead++){
  157153. SnippetFragment sF = {0, 0, 0, 0};
  157154. int iS = 0;
  157155. if( iCol>=0 && iRead!=iCol ) continue;
  157156. /* Find the best snippet of nFToken tokens in column iRead. */
  157157. rc = fts3BestSnippet(nFToken, pCsr, iRead, mCovered, &mSeen, &sF, &iS);
  157158. if( rc!=SQLITE_OK ){
  157159. goto snippet_out;
  157160. }
  157161. if( iS>iBestScore ){
  157162. *pFragment = sF;
  157163. iBestScore = iS;
  157164. }
  157165. }
  157166. mCovered |= pFragment->covered;
  157167. }
  157168. /* If all query phrases seen by fts3BestSnippet() are present in at least
  157169. ** one of the nSnippet snippet fragments, break out of the loop.
  157170. */
  157171. assert( (mCovered&mSeen)==mCovered );
  157172. if( mSeen==mCovered || nSnippet==SizeofArray(aSnippet) ) break;
  157173. }
  157174. assert( nFToken>0 );
  157175. for(i=0; i<nSnippet && rc==SQLITE_OK; i++){
  157176. rc = fts3SnippetText(pCsr, &aSnippet[i],
  157177. i, (i==nSnippet-1), nFToken, zStart, zEnd, zEllipsis, &res
  157178. );
  157179. }
  157180. snippet_out:
  157181. sqlite3Fts3SegmentsClose(pTab);
  157182. if( rc!=SQLITE_OK ){
  157183. sqlite3_result_error_code(pCtx, rc);
  157184. sqlite3_free(res.z);
  157185. }else{
  157186. sqlite3_result_text(pCtx, res.z, -1, sqlite3_free);
  157187. }
  157188. }
  157189. typedef struct TermOffset TermOffset;
  157190. typedef struct TermOffsetCtx TermOffsetCtx;
  157191. struct TermOffset {
  157192. char *pList; /* Position-list */
  157193. int iPos; /* Position just read from pList */
  157194. int iOff; /* Offset of this term from read positions */
  157195. };
  157196. struct TermOffsetCtx {
  157197. Fts3Cursor *pCsr;
  157198. int iCol; /* Column of table to populate aTerm for */
  157199. int iTerm;
  157200. sqlite3_int64 iDocid;
  157201. TermOffset *aTerm;
  157202. };
  157203. /*
  157204. ** This function is an fts3ExprIterate() callback used by sqlite3Fts3Offsets().
  157205. */
  157206. static int fts3ExprTermOffsetInit(Fts3Expr *pExpr, int iPhrase, void *ctx){
  157207. TermOffsetCtx *p = (TermOffsetCtx *)ctx;
  157208. int nTerm; /* Number of tokens in phrase */
  157209. int iTerm; /* For looping through nTerm phrase terms */
  157210. char *pList; /* Pointer to position list for phrase */
  157211. int iPos = 0; /* First position in position-list */
  157212. int rc;
  157213. UNUSED_PARAMETER(iPhrase);
  157214. rc = sqlite3Fts3EvalPhrasePoslist(p->pCsr, pExpr, p->iCol, &pList);
  157215. nTerm = pExpr->pPhrase->nToken;
  157216. if( pList ){
  157217. fts3GetDeltaPosition(&pList, &iPos);
  157218. assert( iPos>=0 );
  157219. }
  157220. for(iTerm=0; iTerm<nTerm; iTerm++){
  157221. TermOffset *pT = &p->aTerm[p->iTerm++];
  157222. pT->iOff = nTerm-iTerm-1;
  157223. pT->pList = pList;
  157224. pT->iPos = iPos;
  157225. }
  157226. return rc;
  157227. }
  157228. /*
  157229. ** Implementation of offsets() function.
  157230. */
  157231. SQLITE_PRIVATE void sqlite3Fts3Offsets(
  157232. sqlite3_context *pCtx, /* SQLite function call context */
  157233. Fts3Cursor *pCsr /* Cursor object */
  157234. ){
  157235. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  157236. sqlite3_tokenizer_module const *pMod = pTab->pTokenizer->pModule;
  157237. int rc; /* Return Code */
  157238. int nToken; /* Number of tokens in query */
  157239. int iCol; /* Column currently being processed */
  157240. StrBuffer res = {0, 0, 0}; /* Result string */
  157241. TermOffsetCtx sCtx; /* Context for fts3ExprTermOffsetInit() */
  157242. if( !pCsr->pExpr ){
  157243. sqlite3_result_text(pCtx, "", 0, SQLITE_STATIC);
  157244. return;
  157245. }
  157246. memset(&sCtx, 0, sizeof(sCtx));
  157247. assert( pCsr->isRequireSeek==0 );
  157248. /* Count the number of terms in the query */
  157249. rc = fts3ExprLoadDoclists(pCsr, 0, &nToken);
  157250. if( rc!=SQLITE_OK ) goto offsets_out;
  157251. /* Allocate the array of TermOffset iterators. */
  157252. sCtx.aTerm = (TermOffset *)sqlite3_malloc(sizeof(TermOffset)*nToken);
  157253. if( 0==sCtx.aTerm ){
  157254. rc = SQLITE_NOMEM;
  157255. goto offsets_out;
  157256. }
  157257. sCtx.iDocid = pCsr->iPrevId;
  157258. sCtx.pCsr = pCsr;
  157259. /* Loop through the table columns, appending offset information to
  157260. ** string-buffer res for each column.
  157261. */
  157262. for(iCol=0; iCol<pTab->nColumn; iCol++){
  157263. sqlite3_tokenizer_cursor *pC; /* Tokenizer cursor */
  157264. const char *ZDUMMY; /* Dummy argument used with xNext() */
  157265. int NDUMMY = 0; /* Dummy argument used with xNext() */
  157266. int iStart = 0;
  157267. int iEnd = 0;
  157268. int iCurrent = 0;
  157269. const char *zDoc;
  157270. int nDoc;
  157271. /* Initialize the contents of sCtx.aTerm[] for column iCol. There is
  157272. ** no way that this operation can fail, so the return code from
  157273. ** fts3ExprIterate() can be discarded.
  157274. */
  157275. sCtx.iCol = iCol;
  157276. sCtx.iTerm = 0;
  157277. (void)fts3ExprIterate(pCsr->pExpr, fts3ExprTermOffsetInit, (void*)&sCtx);
  157278. /* Retreive the text stored in column iCol. If an SQL NULL is stored
  157279. ** in column iCol, jump immediately to the next iteration of the loop.
  157280. ** If an OOM occurs while retrieving the data (this can happen if SQLite
  157281. ** needs to transform the data from utf-16 to utf-8), return SQLITE_NOMEM
  157282. ** to the caller.
  157283. */
  157284. zDoc = (const char *)sqlite3_column_text(pCsr->pStmt, iCol+1);
  157285. nDoc = sqlite3_column_bytes(pCsr->pStmt, iCol+1);
  157286. if( zDoc==0 ){
  157287. if( sqlite3_column_type(pCsr->pStmt, iCol+1)==SQLITE_NULL ){
  157288. continue;
  157289. }
  157290. rc = SQLITE_NOMEM;
  157291. goto offsets_out;
  157292. }
  157293. /* Initialize a tokenizer iterator to iterate through column iCol. */
  157294. rc = sqlite3Fts3OpenTokenizer(pTab->pTokenizer, pCsr->iLangid,
  157295. zDoc, nDoc, &pC
  157296. );
  157297. if( rc!=SQLITE_OK ) goto offsets_out;
  157298. rc = pMod->xNext(pC, &ZDUMMY, &NDUMMY, &iStart, &iEnd, &iCurrent);
  157299. while( rc==SQLITE_OK ){
  157300. int i; /* Used to loop through terms */
  157301. int iMinPos = 0x7FFFFFFF; /* Position of next token */
  157302. TermOffset *pTerm = 0; /* TermOffset associated with next token */
  157303. for(i=0; i<nToken; i++){
  157304. TermOffset *pT = &sCtx.aTerm[i];
  157305. if( pT->pList && (pT->iPos-pT->iOff)<iMinPos ){
  157306. iMinPos = pT->iPos-pT->iOff;
  157307. pTerm = pT;
  157308. }
  157309. }
  157310. if( !pTerm ){
  157311. /* All offsets for this column have been gathered. */
  157312. rc = SQLITE_DONE;
  157313. }else{
  157314. assert( iCurrent<=iMinPos );
  157315. if( 0==(0xFE&*pTerm->pList) ){
  157316. pTerm->pList = 0;
  157317. }else{
  157318. fts3GetDeltaPosition(&pTerm->pList, &pTerm->iPos);
  157319. }
  157320. while( rc==SQLITE_OK && iCurrent<iMinPos ){
  157321. rc = pMod->xNext(pC, &ZDUMMY, &NDUMMY, &iStart, &iEnd, &iCurrent);
  157322. }
  157323. if( rc==SQLITE_OK ){
  157324. char aBuffer[64];
  157325. sqlite3_snprintf(sizeof(aBuffer), aBuffer,
  157326. "%d %d %d %d ", iCol, pTerm-sCtx.aTerm, iStart, iEnd-iStart
  157327. );
  157328. rc = fts3StringAppend(&res, aBuffer, -1);
  157329. }else if( rc==SQLITE_DONE && pTab->zContentTbl==0 ){
  157330. rc = FTS_CORRUPT_VTAB;
  157331. }
  157332. }
  157333. }
  157334. if( rc==SQLITE_DONE ){
  157335. rc = SQLITE_OK;
  157336. }
  157337. pMod->xClose(pC);
  157338. if( rc!=SQLITE_OK ) goto offsets_out;
  157339. }
  157340. offsets_out:
  157341. sqlite3_free(sCtx.aTerm);
  157342. assert( rc!=SQLITE_DONE );
  157343. sqlite3Fts3SegmentsClose(pTab);
  157344. if( rc!=SQLITE_OK ){
  157345. sqlite3_result_error_code(pCtx, rc);
  157346. sqlite3_free(res.z);
  157347. }else{
  157348. sqlite3_result_text(pCtx, res.z, res.n-1, sqlite3_free);
  157349. }
  157350. return;
  157351. }
  157352. /*
  157353. ** Implementation of matchinfo() function.
  157354. */
  157355. SQLITE_PRIVATE void sqlite3Fts3Matchinfo(
  157356. sqlite3_context *pContext, /* Function call context */
  157357. Fts3Cursor *pCsr, /* FTS3 table cursor */
  157358. const char *zArg /* Second arg to matchinfo() function */
  157359. ){
  157360. Fts3Table *pTab = (Fts3Table *)pCsr->base.pVtab;
  157361. const char *zFormat;
  157362. if( zArg ){
  157363. zFormat = zArg;
  157364. }else{
  157365. zFormat = FTS3_MATCHINFO_DEFAULT;
  157366. }
  157367. if( !pCsr->pExpr ){
  157368. sqlite3_result_blob(pContext, "", 0, SQLITE_STATIC);
  157369. return;
  157370. }else{
  157371. /* Retrieve matchinfo() data. */
  157372. fts3GetMatchinfo(pContext, pCsr, zFormat);
  157373. sqlite3Fts3SegmentsClose(pTab);
  157374. }
  157375. }
  157376. #endif
  157377. /************** End of fts3_snippet.c ****************************************/
  157378. /************** Begin file fts3_unicode.c ************************************/
  157379. /*
  157380. ** 2012 May 24
  157381. **
  157382. ** The author disclaims copyright to this source code. In place of
  157383. ** a legal notice, here is a blessing:
  157384. **
  157385. ** May you do good and not evil.
  157386. ** May you find forgiveness for yourself and forgive others.
  157387. ** May you share freely, never taking more than you give.
  157388. **
  157389. ******************************************************************************
  157390. **
  157391. ** Implementation of the "unicode" full-text-search tokenizer.
  157392. */
  157393. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  157394. /* #include "fts3Int.h" */
  157395. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  157396. /* #include <assert.h> */
  157397. /* #include <stdlib.h> */
  157398. /* #include <stdio.h> */
  157399. /* #include <string.h> */
  157400. /* #include "fts3_tokenizer.h" */
  157401. /*
  157402. ** The following two macros - READ_UTF8 and WRITE_UTF8 - have been copied
  157403. ** from the sqlite3 source file utf.c. If this file is compiled as part
  157404. ** of the amalgamation, they are not required.
  157405. */
  157406. #ifndef SQLITE_AMALGAMATION
  157407. static const unsigned char sqlite3Utf8Trans1[] = {
  157408. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  157409. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  157410. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  157411. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  157412. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  157413. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  157414. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  157415. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  157416. };
  157417. #define READ_UTF8(zIn, zTerm, c) \
  157418. c = *(zIn++); \
  157419. if( c>=0xc0 ){ \
  157420. c = sqlite3Utf8Trans1[c-0xc0]; \
  157421. while( zIn!=zTerm && (*zIn & 0xc0)==0x80 ){ \
  157422. c = (c<<6) + (0x3f & *(zIn++)); \
  157423. } \
  157424. if( c<0x80 \
  157425. || (c&0xFFFFF800)==0xD800 \
  157426. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } \
  157427. }
  157428. #define WRITE_UTF8(zOut, c) { \
  157429. if( c<0x00080 ){ \
  157430. *zOut++ = (u8)(c&0xFF); \
  157431. } \
  157432. else if( c<0x00800 ){ \
  157433. *zOut++ = 0xC0 + (u8)((c>>6)&0x1F); \
  157434. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  157435. } \
  157436. else if( c<0x10000 ){ \
  157437. *zOut++ = 0xE0 + (u8)((c>>12)&0x0F); \
  157438. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  157439. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  157440. }else{ \
  157441. *zOut++ = 0xF0 + (u8)((c>>18) & 0x07); \
  157442. *zOut++ = 0x80 + (u8)((c>>12) & 0x3F); \
  157443. *zOut++ = 0x80 + (u8)((c>>6) & 0x3F); \
  157444. *zOut++ = 0x80 + (u8)(c & 0x3F); \
  157445. } \
  157446. }
  157447. #endif /* ifndef SQLITE_AMALGAMATION */
  157448. typedef struct unicode_tokenizer unicode_tokenizer;
  157449. typedef struct unicode_cursor unicode_cursor;
  157450. struct unicode_tokenizer {
  157451. sqlite3_tokenizer base;
  157452. int bRemoveDiacritic;
  157453. int nException;
  157454. int *aiException;
  157455. };
  157456. struct unicode_cursor {
  157457. sqlite3_tokenizer_cursor base;
  157458. const unsigned char *aInput; /* Input text being tokenized */
  157459. int nInput; /* Size of aInput[] in bytes */
  157460. int iOff; /* Current offset within aInput[] */
  157461. int iToken; /* Index of next token to be returned */
  157462. char *zToken; /* storage for current token */
  157463. int nAlloc; /* space allocated at zToken */
  157464. };
  157465. /*
  157466. ** Destroy a tokenizer allocated by unicodeCreate().
  157467. */
  157468. static int unicodeDestroy(sqlite3_tokenizer *pTokenizer){
  157469. if( pTokenizer ){
  157470. unicode_tokenizer *p = (unicode_tokenizer *)pTokenizer;
  157471. sqlite3_free(p->aiException);
  157472. sqlite3_free(p);
  157473. }
  157474. return SQLITE_OK;
  157475. }
  157476. /*
  157477. ** As part of a tokenchars= or separators= option, the CREATE VIRTUAL TABLE
  157478. ** statement has specified that the tokenizer for this table shall consider
  157479. ** all characters in string zIn/nIn to be separators (if bAlnum==0) or
  157480. ** token characters (if bAlnum==1).
  157481. **
  157482. ** For each codepoint in the zIn/nIn string, this function checks if the
  157483. ** sqlite3FtsUnicodeIsalnum() function already returns the desired result.
  157484. ** If so, no action is taken. Otherwise, the codepoint is added to the
  157485. ** unicode_tokenizer.aiException[] array. For the purposes of tokenization,
  157486. ** the return value of sqlite3FtsUnicodeIsalnum() is inverted for all
  157487. ** codepoints in the aiException[] array.
  157488. **
  157489. ** If a standalone diacritic mark (one that sqlite3FtsUnicodeIsdiacritic()
  157490. ** identifies as a diacritic) occurs in the zIn/nIn string it is ignored.
  157491. ** It is not possible to change the behavior of the tokenizer with respect
  157492. ** to these codepoints.
  157493. */
  157494. static int unicodeAddExceptions(
  157495. unicode_tokenizer *p, /* Tokenizer to add exceptions to */
  157496. int bAlnum, /* Replace Isalnum() return value with this */
  157497. const char *zIn, /* Array of characters to make exceptions */
  157498. int nIn /* Length of z in bytes */
  157499. ){
  157500. const unsigned char *z = (const unsigned char *)zIn;
  157501. const unsigned char *zTerm = &z[nIn];
  157502. unsigned int iCode;
  157503. int nEntry = 0;
  157504. assert( bAlnum==0 || bAlnum==1 );
  157505. while( z<zTerm ){
  157506. READ_UTF8(z, zTerm, iCode);
  157507. assert( (sqlite3FtsUnicodeIsalnum((int)iCode) & 0xFFFFFFFE)==0 );
  157508. if( sqlite3FtsUnicodeIsalnum((int)iCode)!=bAlnum
  157509. && sqlite3FtsUnicodeIsdiacritic((int)iCode)==0
  157510. ){
  157511. nEntry++;
  157512. }
  157513. }
  157514. if( nEntry ){
  157515. int *aNew; /* New aiException[] array */
  157516. int nNew; /* Number of valid entries in array aNew[] */
  157517. aNew = sqlite3_realloc(p->aiException, (p->nException+nEntry)*sizeof(int));
  157518. if( aNew==0 ) return SQLITE_NOMEM;
  157519. nNew = p->nException;
  157520. z = (const unsigned char *)zIn;
  157521. while( z<zTerm ){
  157522. READ_UTF8(z, zTerm, iCode);
  157523. if( sqlite3FtsUnicodeIsalnum((int)iCode)!=bAlnum
  157524. && sqlite3FtsUnicodeIsdiacritic((int)iCode)==0
  157525. ){
  157526. int i, j;
  157527. for(i=0; i<nNew && aNew[i]<(int)iCode; i++);
  157528. for(j=nNew; j>i; j--) aNew[j] = aNew[j-1];
  157529. aNew[i] = (int)iCode;
  157530. nNew++;
  157531. }
  157532. }
  157533. p->aiException = aNew;
  157534. p->nException = nNew;
  157535. }
  157536. return SQLITE_OK;
  157537. }
  157538. /*
  157539. ** Return true if the p->aiException[] array contains the value iCode.
  157540. */
  157541. static int unicodeIsException(unicode_tokenizer *p, int iCode){
  157542. if( p->nException>0 ){
  157543. int *a = p->aiException;
  157544. int iLo = 0;
  157545. int iHi = p->nException-1;
  157546. while( iHi>=iLo ){
  157547. int iTest = (iHi + iLo) / 2;
  157548. if( iCode==a[iTest] ){
  157549. return 1;
  157550. }else if( iCode>a[iTest] ){
  157551. iLo = iTest+1;
  157552. }else{
  157553. iHi = iTest-1;
  157554. }
  157555. }
  157556. }
  157557. return 0;
  157558. }
  157559. /*
  157560. ** Return true if, for the purposes of tokenization, codepoint iCode is
  157561. ** considered a token character (not a separator).
  157562. */
  157563. static int unicodeIsAlnum(unicode_tokenizer *p, int iCode){
  157564. assert( (sqlite3FtsUnicodeIsalnum(iCode) & 0xFFFFFFFE)==0 );
  157565. return sqlite3FtsUnicodeIsalnum(iCode) ^ unicodeIsException(p, iCode);
  157566. }
  157567. /*
  157568. ** Create a new tokenizer instance.
  157569. */
  157570. static int unicodeCreate(
  157571. int nArg, /* Size of array argv[] */
  157572. const char * const *azArg, /* Tokenizer creation arguments */
  157573. sqlite3_tokenizer **pp /* OUT: New tokenizer handle */
  157574. ){
  157575. unicode_tokenizer *pNew; /* New tokenizer object */
  157576. int i;
  157577. int rc = SQLITE_OK;
  157578. pNew = (unicode_tokenizer *) sqlite3_malloc(sizeof(unicode_tokenizer));
  157579. if( pNew==NULL ) return SQLITE_NOMEM;
  157580. memset(pNew, 0, sizeof(unicode_tokenizer));
  157581. pNew->bRemoveDiacritic = 1;
  157582. for(i=0; rc==SQLITE_OK && i<nArg; i++){
  157583. const char *z = azArg[i];
  157584. int n = (int)strlen(z);
  157585. if( n==19 && memcmp("remove_diacritics=1", z, 19)==0 ){
  157586. pNew->bRemoveDiacritic = 1;
  157587. }
  157588. else if( n==19 && memcmp("remove_diacritics=0", z, 19)==0 ){
  157589. pNew->bRemoveDiacritic = 0;
  157590. }
  157591. else if( n>=11 && memcmp("tokenchars=", z, 11)==0 ){
  157592. rc = unicodeAddExceptions(pNew, 1, &z[11], n-11);
  157593. }
  157594. else if( n>=11 && memcmp("separators=", z, 11)==0 ){
  157595. rc = unicodeAddExceptions(pNew, 0, &z[11], n-11);
  157596. }
  157597. else{
  157598. /* Unrecognized argument */
  157599. rc = SQLITE_ERROR;
  157600. }
  157601. }
  157602. if( rc!=SQLITE_OK ){
  157603. unicodeDestroy((sqlite3_tokenizer *)pNew);
  157604. pNew = 0;
  157605. }
  157606. *pp = (sqlite3_tokenizer *)pNew;
  157607. return rc;
  157608. }
  157609. /*
  157610. ** Prepare to begin tokenizing a particular string. The input
  157611. ** string to be tokenized is pInput[0..nBytes-1]. A cursor
  157612. ** used to incrementally tokenize this string is returned in
  157613. ** *ppCursor.
  157614. */
  157615. static int unicodeOpen(
  157616. sqlite3_tokenizer *p, /* The tokenizer */
  157617. const char *aInput, /* Input string */
  157618. int nInput, /* Size of string aInput in bytes */
  157619. sqlite3_tokenizer_cursor **pp /* OUT: New cursor object */
  157620. ){
  157621. unicode_cursor *pCsr;
  157622. pCsr = (unicode_cursor *)sqlite3_malloc(sizeof(unicode_cursor));
  157623. if( pCsr==0 ){
  157624. return SQLITE_NOMEM;
  157625. }
  157626. memset(pCsr, 0, sizeof(unicode_cursor));
  157627. pCsr->aInput = (const unsigned char *)aInput;
  157628. if( aInput==0 ){
  157629. pCsr->nInput = 0;
  157630. }else if( nInput<0 ){
  157631. pCsr->nInput = (int)strlen(aInput);
  157632. }else{
  157633. pCsr->nInput = nInput;
  157634. }
  157635. *pp = &pCsr->base;
  157636. UNUSED_PARAMETER(p);
  157637. return SQLITE_OK;
  157638. }
  157639. /*
  157640. ** Close a tokenization cursor previously opened by a call to
  157641. ** simpleOpen() above.
  157642. */
  157643. static int unicodeClose(sqlite3_tokenizer_cursor *pCursor){
  157644. unicode_cursor *pCsr = (unicode_cursor *) pCursor;
  157645. sqlite3_free(pCsr->zToken);
  157646. sqlite3_free(pCsr);
  157647. return SQLITE_OK;
  157648. }
  157649. /*
  157650. ** Extract the next token from a tokenization cursor. The cursor must
  157651. ** have been opened by a prior call to simpleOpen().
  157652. */
  157653. static int unicodeNext(
  157654. sqlite3_tokenizer_cursor *pC, /* Cursor returned by simpleOpen */
  157655. const char **paToken, /* OUT: Token text */
  157656. int *pnToken, /* OUT: Number of bytes at *paToken */
  157657. int *piStart, /* OUT: Starting offset of token */
  157658. int *piEnd, /* OUT: Ending offset of token */
  157659. int *piPos /* OUT: Position integer of token */
  157660. ){
  157661. unicode_cursor *pCsr = (unicode_cursor *)pC;
  157662. unicode_tokenizer *p = ((unicode_tokenizer *)pCsr->base.pTokenizer);
  157663. unsigned int iCode = 0;
  157664. char *zOut;
  157665. const unsigned char *z = &pCsr->aInput[pCsr->iOff];
  157666. const unsigned char *zStart = z;
  157667. const unsigned char *zEnd;
  157668. const unsigned char *zTerm = &pCsr->aInput[pCsr->nInput];
  157669. /* Scan past any delimiter characters before the start of the next token.
  157670. ** Return SQLITE_DONE early if this takes us all the way to the end of
  157671. ** the input. */
  157672. while( z<zTerm ){
  157673. READ_UTF8(z, zTerm, iCode);
  157674. if( unicodeIsAlnum(p, (int)iCode) ) break;
  157675. zStart = z;
  157676. }
  157677. if( zStart>=zTerm ) return SQLITE_DONE;
  157678. zOut = pCsr->zToken;
  157679. do {
  157680. int iOut;
  157681. /* Grow the output buffer if required. */
  157682. if( (zOut-pCsr->zToken)>=(pCsr->nAlloc-4) ){
  157683. char *zNew = sqlite3_realloc(pCsr->zToken, pCsr->nAlloc+64);
  157684. if( !zNew ) return SQLITE_NOMEM;
  157685. zOut = &zNew[zOut - pCsr->zToken];
  157686. pCsr->zToken = zNew;
  157687. pCsr->nAlloc += 64;
  157688. }
  157689. /* Write the folded case of the last character read to the output */
  157690. zEnd = z;
  157691. iOut = sqlite3FtsUnicodeFold((int)iCode, p->bRemoveDiacritic);
  157692. if( iOut ){
  157693. WRITE_UTF8(zOut, iOut);
  157694. }
  157695. /* If the cursor is not at EOF, read the next character */
  157696. if( z>=zTerm ) break;
  157697. READ_UTF8(z, zTerm, iCode);
  157698. }while( unicodeIsAlnum(p, (int)iCode)
  157699. || sqlite3FtsUnicodeIsdiacritic((int)iCode)
  157700. );
  157701. /* Set the output variables and return. */
  157702. pCsr->iOff = (int)(z - pCsr->aInput);
  157703. *paToken = pCsr->zToken;
  157704. *pnToken = (int)(zOut - pCsr->zToken);
  157705. *piStart = (int)(zStart - pCsr->aInput);
  157706. *piEnd = (int)(zEnd - pCsr->aInput);
  157707. *piPos = pCsr->iToken++;
  157708. return SQLITE_OK;
  157709. }
  157710. /*
  157711. ** Set *ppModule to a pointer to the sqlite3_tokenizer_module
  157712. ** structure for the unicode tokenizer.
  157713. */
  157714. SQLITE_PRIVATE void sqlite3Fts3UnicodeTokenizer(sqlite3_tokenizer_module const **ppModule){
  157715. static const sqlite3_tokenizer_module module = {
  157716. 0,
  157717. unicodeCreate,
  157718. unicodeDestroy,
  157719. unicodeOpen,
  157720. unicodeClose,
  157721. unicodeNext,
  157722. 0,
  157723. };
  157724. *ppModule = &module;
  157725. }
  157726. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  157727. #endif /* ifndef SQLITE_DISABLE_FTS3_UNICODE */
  157728. /************** End of fts3_unicode.c ****************************************/
  157729. /************** Begin file fts3_unicode2.c ***********************************/
  157730. /*
  157731. ** 2012 May 25
  157732. **
  157733. ** The author disclaims copyright to this source code. In place of
  157734. ** a legal notice, here is a blessing:
  157735. **
  157736. ** May you do good and not evil.
  157737. ** May you find forgiveness for yourself and forgive others.
  157738. ** May you share freely, never taking more than you give.
  157739. **
  157740. ******************************************************************************
  157741. */
  157742. /*
  157743. ** DO NOT EDIT THIS MACHINE GENERATED FILE.
  157744. */
  157745. #ifndef SQLITE_DISABLE_FTS3_UNICODE
  157746. #if defined(SQLITE_ENABLE_FTS3) || defined(SQLITE_ENABLE_FTS4)
  157747. /* #include <assert.h> */
  157748. /*
  157749. ** Return true if the argument corresponds to a unicode codepoint
  157750. ** classified as either a letter or a number. Otherwise false.
  157751. **
  157752. ** The results are undefined if the value passed to this function
  157753. ** is less than zero.
  157754. */
  157755. SQLITE_PRIVATE int sqlite3FtsUnicodeIsalnum(int c){
  157756. /* Each unsigned integer in the following array corresponds to a contiguous
  157757. ** range of unicode codepoints that are not either letters or numbers (i.e.
  157758. ** codepoints for which this function should return 0).
  157759. **
  157760. ** The most significant 22 bits in each 32-bit value contain the first
  157761. ** codepoint in the range. The least significant 10 bits are used to store
  157762. ** the size of the range (always at least 1). In other words, the value
  157763. ** ((C<<22) + N) represents a range of N codepoints starting with codepoint
  157764. ** C. It is not possible to represent a range larger than 1023 codepoints
  157765. ** using this format.
  157766. */
  157767. static const unsigned int aEntry[] = {
  157768. 0x00000030, 0x0000E807, 0x00016C06, 0x0001EC2F, 0x0002AC07,
  157769. 0x0002D001, 0x0002D803, 0x0002EC01, 0x0002FC01, 0x00035C01,
  157770. 0x0003DC01, 0x000B0804, 0x000B480E, 0x000B9407, 0x000BB401,
  157771. 0x000BBC81, 0x000DD401, 0x000DF801, 0x000E1002, 0x000E1C01,
  157772. 0x000FD801, 0x00120808, 0x00156806, 0x00162402, 0x00163C01,
  157773. 0x00164437, 0x0017CC02, 0x00180005, 0x00181816, 0x00187802,
  157774. 0x00192C15, 0x0019A804, 0x0019C001, 0x001B5001, 0x001B580F,
  157775. 0x001B9C07, 0x001BF402, 0x001C000E, 0x001C3C01, 0x001C4401,
  157776. 0x001CC01B, 0x001E980B, 0x001FAC09, 0x001FD804, 0x00205804,
  157777. 0x00206C09, 0x00209403, 0x0020A405, 0x0020C00F, 0x00216403,
  157778. 0x00217801, 0x0023901B, 0x00240004, 0x0024E803, 0x0024F812,
  157779. 0x00254407, 0x00258804, 0x0025C001, 0x00260403, 0x0026F001,
  157780. 0x0026F807, 0x00271C02, 0x00272C03, 0x00275C01, 0x00278802,
  157781. 0x0027C802, 0x0027E802, 0x00280403, 0x0028F001, 0x0028F805,
  157782. 0x00291C02, 0x00292C03, 0x00294401, 0x0029C002, 0x0029D401,
  157783. 0x002A0403, 0x002AF001, 0x002AF808, 0x002B1C03, 0x002B2C03,
  157784. 0x002B8802, 0x002BC002, 0x002C0403, 0x002CF001, 0x002CF807,
  157785. 0x002D1C02, 0x002D2C03, 0x002D5802, 0x002D8802, 0x002DC001,
  157786. 0x002E0801, 0x002EF805, 0x002F1803, 0x002F2804, 0x002F5C01,
  157787. 0x002FCC08, 0x00300403, 0x0030F807, 0x00311803, 0x00312804,
  157788. 0x00315402, 0x00318802, 0x0031FC01, 0x00320802, 0x0032F001,
  157789. 0x0032F807, 0x00331803, 0x00332804, 0x00335402, 0x00338802,
  157790. 0x00340802, 0x0034F807, 0x00351803, 0x00352804, 0x00355C01,
  157791. 0x00358802, 0x0035E401, 0x00360802, 0x00372801, 0x00373C06,
  157792. 0x00375801, 0x00376008, 0x0037C803, 0x0038C401, 0x0038D007,
  157793. 0x0038FC01, 0x00391C09, 0x00396802, 0x003AC401, 0x003AD006,
  157794. 0x003AEC02, 0x003B2006, 0x003C041F, 0x003CD00C, 0x003DC417,
  157795. 0x003E340B, 0x003E6424, 0x003EF80F, 0x003F380D, 0x0040AC14,
  157796. 0x00412806, 0x00415804, 0x00417803, 0x00418803, 0x00419C07,
  157797. 0x0041C404, 0x0042080C, 0x00423C01, 0x00426806, 0x0043EC01,
  157798. 0x004D740C, 0x004E400A, 0x00500001, 0x0059B402, 0x005A0001,
  157799. 0x005A6C02, 0x005BAC03, 0x005C4803, 0x005CC805, 0x005D4802,
  157800. 0x005DC802, 0x005ED023, 0x005F6004, 0x005F7401, 0x0060000F,
  157801. 0x0062A401, 0x0064800C, 0x0064C00C, 0x00650001, 0x00651002,
  157802. 0x0066C011, 0x00672002, 0x00677822, 0x00685C05, 0x00687802,
  157803. 0x0069540A, 0x0069801D, 0x0069FC01, 0x006A8007, 0x006AA006,
  157804. 0x006C0005, 0x006CD011, 0x006D6823, 0x006E0003, 0x006E840D,
  157805. 0x006F980E, 0x006FF004, 0x00709014, 0x0070EC05, 0x0071F802,
  157806. 0x00730008, 0x00734019, 0x0073B401, 0x0073C803, 0x00770027,
  157807. 0x0077F004, 0x007EF401, 0x007EFC03, 0x007F3403, 0x007F7403,
  157808. 0x007FB403, 0x007FF402, 0x00800065, 0x0081A806, 0x0081E805,
  157809. 0x00822805, 0x0082801A, 0x00834021, 0x00840002, 0x00840C04,
  157810. 0x00842002, 0x00845001, 0x00845803, 0x00847806, 0x00849401,
  157811. 0x00849C01, 0x0084A401, 0x0084B801, 0x0084E802, 0x00850005,
  157812. 0x00852804, 0x00853C01, 0x00864264, 0x00900027, 0x0091000B,
  157813. 0x0092704E, 0x00940200, 0x009C0475, 0x009E53B9, 0x00AD400A,
  157814. 0x00B39406, 0x00B3BC03, 0x00B3E404, 0x00B3F802, 0x00B5C001,
  157815. 0x00B5FC01, 0x00B7804F, 0x00B8C00C, 0x00BA001A, 0x00BA6C59,
  157816. 0x00BC00D6, 0x00BFC00C, 0x00C00005, 0x00C02019, 0x00C0A807,
  157817. 0x00C0D802, 0x00C0F403, 0x00C26404, 0x00C28001, 0x00C3EC01,
  157818. 0x00C64002, 0x00C6580A, 0x00C70024, 0x00C8001F, 0x00C8A81E,
  157819. 0x00C94001, 0x00C98020, 0x00CA2827, 0x00CB003F, 0x00CC0100,
  157820. 0x01370040, 0x02924037, 0x0293F802, 0x02983403, 0x0299BC10,
  157821. 0x029A7C01, 0x029BC008, 0x029C0017, 0x029C8002, 0x029E2402,
  157822. 0x02A00801, 0x02A01801, 0x02A02C01, 0x02A08C09, 0x02A0D804,
  157823. 0x02A1D004, 0x02A20002, 0x02A2D011, 0x02A33802, 0x02A38012,
  157824. 0x02A3E003, 0x02A4980A, 0x02A51C0D, 0x02A57C01, 0x02A60004,
  157825. 0x02A6CC1B, 0x02A77802, 0x02A8A40E, 0x02A90C01, 0x02A93002,
  157826. 0x02A97004, 0x02A9DC03, 0x02A9EC01, 0x02AAC001, 0x02AAC803,
  157827. 0x02AADC02, 0x02AAF802, 0x02AB0401, 0x02AB7802, 0x02ABAC07,
  157828. 0x02ABD402, 0x02AF8C0B, 0x03600001, 0x036DFC02, 0x036FFC02,
  157829. 0x037FFC01, 0x03EC7801, 0x03ECA401, 0x03EEC810, 0x03F4F802,
  157830. 0x03F7F002, 0x03F8001A, 0x03F88007, 0x03F8C023, 0x03F95013,
  157831. 0x03F9A004, 0x03FBFC01, 0x03FC040F, 0x03FC6807, 0x03FCEC06,
  157832. 0x03FD6C0B, 0x03FF8007, 0x03FFA007, 0x03FFE405, 0x04040003,
  157833. 0x0404DC09, 0x0405E411, 0x0406400C, 0x0407402E, 0x040E7C01,
  157834. 0x040F4001, 0x04215C01, 0x04247C01, 0x0424FC01, 0x04280403,
  157835. 0x04281402, 0x04283004, 0x0428E003, 0x0428FC01, 0x04294009,
  157836. 0x0429FC01, 0x042CE407, 0x04400003, 0x0440E016, 0x04420003,
  157837. 0x0442C012, 0x04440003, 0x04449C0E, 0x04450004, 0x04460003,
  157838. 0x0446CC0E, 0x04471404, 0x045AAC0D, 0x0491C004, 0x05BD442E,
  157839. 0x05BE3C04, 0x074000F6, 0x07440027, 0x0744A4B5, 0x07480046,
  157840. 0x074C0057, 0x075B0401, 0x075B6C01, 0x075BEC01, 0x075C5401,
  157841. 0x075CD401, 0x075D3C01, 0x075DBC01, 0x075E2401, 0x075EA401,
  157842. 0x075F0C01, 0x07BBC002, 0x07C0002C, 0x07C0C064, 0x07C2800F,
  157843. 0x07C2C40E, 0x07C3040F, 0x07C3440F, 0x07C4401F, 0x07C4C03C,
  157844. 0x07C5C02B, 0x07C7981D, 0x07C8402B, 0x07C90009, 0x07C94002,
  157845. 0x07CC0021, 0x07CCC006, 0x07CCDC46, 0x07CE0014, 0x07CE8025,
  157846. 0x07CF1805, 0x07CF8011, 0x07D0003F, 0x07D10001, 0x07D108B6,
  157847. 0x07D3E404, 0x07D4003E, 0x07D50004, 0x07D54018, 0x07D7EC46,
  157848. 0x07D9140B, 0x07DA0046, 0x07DC0074, 0x38000401, 0x38008060,
  157849. 0x380400F0,
  157850. };
  157851. static const unsigned int aAscii[4] = {
  157852. 0xFFFFFFFF, 0xFC00FFFF, 0xF8000001, 0xF8000001,
  157853. };
  157854. if( (unsigned int)c<128 ){
  157855. return ( (aAscii[c >> 5] & ((unsigned int)1 << (c & 0x001F)))==0 );
  157856. }else if( (unsigned int)c<(1<<22) ){
  157857. unsigned int key = (((unsigned int)c)<<10) | 0x000003FF;
  157858. int iRes = 0;
  157859. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  157860. int iLo = 0;
  157861. while( iHi>=iLo ){
  157862. int iTest = (iHi + iLo) / 2;
  157863. if( key >= aEntry[iTest] ){
  157864. iRes = iTest;
  157865. iLo = iTest+1;
  157866. }else{
  157867. iHi = iTest-1;
  157868. }
  157869. }
  157870. assert( aEntry[0]<key );
  157871. assert( key>=aEntry[iRes] );
  157872. return (((unsigned int)c) >= ((aEntry[iRes]>>10) + (aEntry[iRes]&0x3FF)));
  157873. }
  157874. return 1;
  157875. }
  157876. /*
  157877. ** If the argument is a codepoint corresponding to a lowercase letter
  157878. ** in the ASCII range with a diacritic added, return the codepoint
  157879. ** of the ASCII letter only. For example, if passed 235 - "LATIN
  157880. ** SMALL LETTER E WITH DIAERESIS" - return 65 ("LATIN SMALL LETTER
  157881. ** E"). The resuls of passing a codepoint that corresponds to an
  157882. ** uppercase letter are undefined.
  157883. */
  157884. static int remove_diacritic(int c){
  157885. unsigned short aDia[] = {
  157886. 0, 1797, 1848, 1859, 1891, 1928, 1940, 1995,
  157887. 2024, 2040, 2060, 2110, 2168, 2206, 2264, 2286,
  157888. 2344, 2383, 2472, 2488, 2516, 2596, 2668, 2732,
  157889. 2782, 2842, 2894, 2954, 2984, 3000, 3028, 3336,
  157890. 3456, 3696, 3712, 3728, 3744, 3896, 3912, 3928,
  157891. 3968, 4008, 4040, 4106, 4138, 4170, 4202, 4234,
  157892. 4266, 4296, 4312, 4344, 4408, 4424, 4472, 4504,
  157893. 6148, 6198, 6264, 6280, 6360, 6429, 6505, 6529,
  157894. 61448, 61468, 61534, 61592, 61642, 61688, 61704, 61726,
  157895. 61784, 61800, 61836, 61880, 61914, 61948, 61998, 62122,
  157896. 62154, 62200, 62218, 62302, 62364, 62442, 62478, 62536,
  157897. 62554, 62584, 62604, 62640, 62648, 62656, 62664, 62730,
  157898. 62924, 63050, 63082, 63274, 63390,
  157899. };
  157900. char aChar[] = {
  157901. '\0', 'a', 'c', 'e', 'i', 'n', 'o', 'u', 'y', 'y', 'a', 'c',
  157902. 'd', 'e', 'e', 'g', 'h', 'i', 'j', 'k', 'l', 'n', 'o', 'r',
  157903. 's', 't', 'u', 'u', 'w', 'y', 'z', 'o', 'u', 'a', 'i', 'o',
  157904. 'u', 'g', 'k', 'o', 'j', 'g', 'n', 'a', 'e', 'i', 'o', 'r',
  157905. 'u', 's', 't', 'h', 'a', 'e', 'o', 'y', '\0', '\0', '\0', '\0',
  157906. '\0', '\0', '\0', '\0', 'a', 'b', 'd', 'd', 'e', 'f', 'g', 'h',
  157907. 'h', 'i', 'k', 'l', 'l', 'm', 'n', 'p', 'r', 'r', 's', 't',
  157908. 'u', 'v', 'w', 'w', 'x', 'y', 'z', 'h', 't', 'w', 'y', 'a',
  157909. 'e', 'i', 'o', 'u', 'y',
  157910. };
  157911. unsigned int key = (((unsigned int)c)<<3) | 0x00000007;
  157912. int iRes = 0;
  157913. int iHi = sizeof(aDia)/sizeof(aDia[0]) - 1;
  157914. int iLo = 0;
  157915. while( iHi>=iLo ){
  157916. int iTest = (iHi + iLo) / 2;
  157917. if( key >= aDia[iTest] ){
  157918. iRes = iTest;
  157919. iLo = iTest+1;
  157920. }else{
  157921. iHi = iTest-1;
  157922. }
  157923. }
  157924. assert( key>=aDia[iRes] );
  157925. return ((c > (aDia[iRes]>>3) + (aDia[iRes]&0x07)) ? c : (int)aChar[iRes]);
  157926. }
  157927. /*
  157928. ** Return true if the argument interpreted as a unicode codepoint
  157929. ** is a diacritical modifier character.
  157930. */
  157931. SQLITE_PRIVATE int sqlite3FtsUnicodeIsdiacritic(int c){
  157932. unsigned int mask0 = 0x08029FDF;
  157933. unsigned int mask1 = 0x000361F8;
  157934. if( c<768 || c>817 ) return 0;
  157935. return (c < 768+32) ?
  157936. (mask0 & (1 << (c-768))) :
  157937. (mask1 & (1 << (c-768-32)));
  157938. }
  157939. /*
  157940. ** Interpret the argument as a unicode codepoint. If the codepoint
  157941. ** is an upper case character that has a lower case equivalent,
  157942. ** return the codepoint corresponding to the lower case version.
  157943. ** Otherwise, return a copy of the argument.
  157944. **
  157945. ** The results are undefined if the value passed to this function
  157946. ** is less than zero.
  157947. */
  157948. SQLITE_PRIVATE int sqlite3FtsUnicodeFold(int c, int bRemoveDiacritic){
  157949. /* Each entry in the following array defines a rule for folding a range
  157950. ** of codepoints to lower case. The rule applies to a range of nRange
  157951. ** codepoints starting at codepoint iCode.
  157952. **
  157953. ** If the least significant bit in flags is clear, then the rule applies
  157954. ** to all nRange codepoints (i.e. all nRange codepoints are upper case and
  157955. ** need to be folded). Or, if it is set, then the rule only applies to
  157956. ** every second codepoint in the range, starting with codepoint C.
  157957. **
  157958. ** The 7 most significant bits in flags are an index into the aiOff[]
  157959. ** array. If a specific codepoint C does require folding, then its lower
  157960. ** case equivalent is ((C + aiOff[flags>>1]) & 0xFFFF).
  157961. **
  157962. ** The contents of this array are generated by parsing the CaseFolding.txt
  157963. ** file distributed as part of the "Unicode Character Database". See
  157964. ** http://www.unicode.org for details.
  157965. */
  157966. static const struct TableEntry {
  157967. unsigned short iCode;
  157968. unsigned char flags;
  157969. unsigned char nRange;
  157970. } aEntry[] = {
  157971. {65, 14, 26}, {181, 64, 1}, {192, 14, 23},
  157972. {216, 14, 7}, {256, 1, 48}, {306, 1, 6},
  157973. {313, 1, 16}, {330, 1, 46}, {376, 116, 1},
  157974. {377, 1, 6}, {383, 104, 1}, {385, 50, 1},
  157975. {386, 1, 4}, {390, 44, 1}, {391, 0, 1},
  157976. {393, 42, 2}, {395, 0, 1}, {398, 32, 1},
  157977. {399, 38, 1}, {400, 40, 1}, {401, 0, 1},
  157978. {403, 42, 1}, {404, 46, 1}, {406, 52, 1},
  157979. {407, 48, 1}, {408, 0, 1}, {412, 52, 1},
  157980. {413, 54, 1}, {415, 56, 1}, {416, 1, 6},
  157981. {422, 60, 1}, {423, 0, 1}, {425, 60, 1},
  157982. {428, 0, 1}, {430, 60, 1}, {431, 0, 1},
  157983. {433, 58, 2}, {435, 1, 4}, {439, 62, 1},
  157984. {440, 0, 1}, {444, 0, 1}, {452, 2, 1},
  157985. {453, 0, 1}, {455, 2, 1}, {456, 0, 1},
  157986. {458, 2, 1}, {459, 1, 18}, {478, 1, 18},
  157987. {497, 2, 1}, {498, 1, 4}, {502, 122, 1},
  157988. {503, 134, 1}, {504, 1, 40}, {544, 110, 1},
  157989. {546, 1, 18}, {570, 70, 1}, {571, 0, 1},
  157990. {573, 108, 1}, {574, 68, 1}, {577, 0, 1},
  157991. {579, 106, 1}, {580, 28, 1}, {581, 30, 1},
  157992. {582, 1, 10}, {837, 36, 1}, {880, 1, 4},
  157993. {886, 0, 1}, {902, 18, 1}, {904, 16, 3},
  157994. {908, 26, 1}, {910, 24, 2}, {913, 14, 17},
  157995. {931, 14, 9}, {962, 0, 1}, {975, 4, 1},
  157996. {976, 140, 1}, {977, 142, 1}, {981, 146, 1},
  157997. {982, 144, 1}, {984, 1, 24}, {1008, 136, 1},
  157998. {1009, 138, 1}, {1012, 130, 1}, {1013, 128, 1},
  157999. {1015, 0, 1}, {1017, 152, 1}, {1018, 0, 1},
  158000. {1021, 110, 3}, {1024, 34, 16}, {1040, 14, 32},
  158001. {1120, 1, 34}, {1162, 1, 54}, {1216, 6, 1},
  158002. {1217, 1, 14}, {1232, 1, 88}, {1329, 22, 38},
  158003. {4256, 66, 38}, {4295, 66, 1}, {4301, 66, 1},
  158004. {7680, 1, 150}, {7835, 132, 1}, {7838, 96, 1},
  158005. {7840, 1, 96}, {7944, 150, 8}, {7960, 150, 6},
  158006. {7976, 150, 8}, {7992, 150, 8}, {8008, 150, 6},
  158007. {8025, 151, 8}, {8040, 150, 8}, {8072, 150, 8},
  158008. {8088, 150, 8}, {8104, 150, 8}, {8120, 150, 2},
  158009. {8122, 126, 2}, {8124, 148, 1}, {8126, 100, 1},
  158010. {8136, 124, 4}, {8140, 148, 1}, {8152, 150, 2},
  158011. {8154, 120, 2}, {8168, 150, 2}, {8170, 118, 2},
  158012. {8172, 152, 1}, {8184, 112, 2}, {8186, 114, 2},
  158013. {8188, 148, 1}, {8486, 98, 1}, {8490, 92, 1},
  158014. {8491, 94, 1}, {8498, 12, 1}, {8544, 8, 16},
  158015. {8579, 0, 1}, {9398, 10, 26}, {11264, 22, 47},
  158016. {11360, 0, 1}, {11362, 88, 1}, {11363, 102, 1},
  158017. {11364, 90, 1}, {11367, 1, 6}, {11373, 84, 1},
  158018. {11374, 86, 1}, {11375, 80, 1}, {11376, 82, 1},
  158019. {11378, 0, 1}, {11381, 0, 1}, {11390, 78, 2},
  158020. {11392, 1, 100}, {11499, 1, 4}, {11506, 0, 1},
  158021. {42560, 1, 46}, {42624, 1, 24}, {42786, 1, 14},
  158022. {42802, 1, 62}, {42873, 1, 4}, {42877, 76, 1},
  158023. {42878, 1, 10}, {42891, 0, 1}, {42893, 74, 1},
  158024. {42896, 1, 4}, {42912, 1, 10}, {42922, 72, 1},
  158025. {65313, 14, 26},
  158026. };
  158027. static const unsigned short aiOff[] = {
  158028. 1, 2, 8, 15, 16, 26, 28, 32,
  158029. 37, 38, 40, 48, 63, 64, 69, 71,
  158030. 79, 80, 116, 202, 203, 205, 206, 207,
  158031. 209, 210, 211, 213, 214, 217, 218, 219,
  158032. 775, 7264, 10792, 10795, 23228, 23256, 30204, 54721,
  158033. 54753, 54754, 54756, 54787, 54793, 54809, 57153, 57274,
  158034. 57921, 58019, 58363, 61722, 65268, 65341, 65373, 65406,
  158035. 65408, 65410, 65415, 65424, 65436, 65439, 65450, 65462,
  158036. 65472, 65476, 65478, 65480, 65482, 65488, 65506, 65511,
  158037. 65514, 65521, 65527, 65528, 65529,
  158038. };
  158039. int ret = c;
  158040. assert( sizeof(unsigned short)==2 && sizeof(unsigned char)==1 );
  158041. if( c<128 ){
  158042. if( c>='A' && c<='Z' ) ret = c + ('a' - 'A');
  158043. }else if( c<65536 ){
  158044. const struct TableEntry *p;
  158045. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  158046. int iLo = 0;
  158047. int iRes = -1;
  158048. assert( c>aEntry[0].iCode );
  158049. while( iHi>=iLo ){
  158050. int iTest = (iHi + iLo) / 2;
  158051. int cmp = (c - aEntry[iTest].iCode);
  158052. if( cmp>=0 ){
  158053. iRes = iTest;
  158054. iLo = iTest+1;
  158055. }else{
  158056. iHi = iTest-1;
  158057. }
  158058. }
  158059. assert( iRes>=0 && c>=aEntry[iRes].iCode );
  158060. p = &aEntry[iRes];
  158061. if( c<(p->iCode + p->nRange) && 0==(0x01 & p->flags & (p->iCode ^ c)) ){
  158062. ret = (c + (aiOff[p->flags>>1])) & 0x0000FFFF;
  158063. assert( ret>0 );
  158064. }
  158065. if( bRemoveDiacritic ) ret = remove_diacritic(ret);
  158066. }
  158067. else if( c>=66560 && c<66600 ){
  158068. ret = c + 40;
  158069. }
  158070. return ret;
  158071. }
  158072. #endif /* defined(SQLITE_ENABLE_FTS3) || defined(SQLITE_ENABLE_FTS4) */
  158073. #endif /* !defined(SQLITE_DISABLE_FTS3_UNICODE) */
  158074. /************** End of fts3_unicode2.c ***************************************/
  158075. /************** Begin file rtree.c *******************************************/
  158076. /*
  158077. ** 2001 September 15
  158078. **
  158079. ** The author disclaims copyright to this source code. In place of
  158080. ** a legal notice, here is a blessing:
  158081. **
  158082. ** May you do good and not evil.
  158083. ** May you find forgiveness for yourself and forgive others.
  158084. ** May you share freely, never taking more than you give.
  158085. **
  158086. *************************************************************************
  158087. ** This file contains code for implementations of the r-tree and r*-tree
  158088. ** algorithms packaged as an SQLite virtual table module.
  158089. */
  158090. /*
  158091. ** Database Format of R-Tree Tables
  158092. ** --------------------------------
  158093. **
  158094. ** The data structure for a single virtual r-tree table is stored in three
  158095. ** native SQLite tables declared as follows. In each case, the '%' character
  158096. ** in the table name is replaced with the user-supplied name of the r-tree
  158097. ** table.
  158098. **
  158099. ** CREATE TABLE %_node(nodeno INTEGER PRIMARY KEY, data BLOB)
  158100. ** CREATE TABLE %_parent(nodeno INTEGER PRIMARY KEY, parentnode INTEGER)
  158101. ** CREATE TABLE %_rowid(rowid INTEGER PRIMARY KEY, nodeno INTEGER)
  158102. **
  158103. ** The data for each node of the r-tree structure is stored in the %_node
  158104. ** table. For each node that is not the root node of the r-tree, there is
  158105. ** an entry in the %_parent table associating the node with its parent.
  158106. ** And for each row of data in the table, there is an entry in the %_rowid
  158107. ** table that maps from the entries rowid to the id of the node that it
  158108. ** is stored on.
  158109. **
  158110. ** The root node of an r-tree always exists, even if the r-tree table is
  158111. ** empty. The nodeno of the root node is always 1. All other nodes in the
  158112. ** table must be the same size as the root node. The content of each node
  158113. ** is formatted as follows:
  158114. **
  158115. ** 1. If the node is the root node (node 1), then the first 2 bytes
  158116. ** of the node contain the tree depth as a big-endian integer.
  158117. ** For non-root nodes, the first 2 bytes are left unused.
  158118. **
  158119. ** 2. The next 2 bytes contain the number of entries currently
  158120. ** stored in the node.
  158121. **
  158122. ** 3. The remainder of the node contains the node entries. Each entry
  158123. ** consists of a single 8-byte integer followed by an even number
  158124. ** of 4-byte coordinates. For leaf nodes the integer is the rowid
  158125. ** of a record. For internal nodes it is the node number of a
  158126. ** child page.
  158127. */
  158128. #if !defined(SQLITE_CORE) \
  158129. || (defined(SQLITE_ENABLE_RTREE) && !defined(SQLITE_OMIT_VIRTUALTABLE))
  158130. #ifndef SQLITE_CORE
  158131. /* #include "sqlite3ext.h" */
  158132. SQLITE_EXTENSION_INIT1
  158133. #else
  158134. /* #include "sqlite3.h" */
  158135. #endif
  158136. /* #include <string.h> */
  158137. /* #include <assert.h> */
  158138. /* #include <stdio.h> */
  158139. #ifndef SQLITE_AMALGAMATION
  158140. #include "sqlite3rtree.h"
  158141. typedef sqlite3_int64 i64;
  158142. typedef sqlite3_uint64 u64;
  158143. typedef unsigned char u8;
  158144. typedef unsigned short u16;
  158145. typedef unsigned int u32;
  158146. #endif
  158147. /* The following macro is used to suppress compiler warnings.
  158148. */
  158149. #ifndef UNUSED_PARAMETER
  158150. # define UNUSED_PARAMETER(x) (void)(x)
  158151. #endif
  158152. typedef struct Rtree Rtree;
  158153. typedef struct RtreeCursor RtreeCursor;
  158154. typedef struct RtreeNode RtreeNode;
  158155. typedef struct RtreeCell RtreeCell;
  158156. typedef struct RtreeConstraint RtreeConstraint;
  158157. typedef struct RtreeMatchArg RtreeMatchArg;
  158158. typedef struct RtreeGeomCallback RtreeGeomCallback;
  158159. typedef union RtreeCoord RtreeCoord;
  158160. typedef struct RtreeSearchPoint RtreeSearchPoint;
  158161. /* The rtree may have between 1 and RTREE_MAX_DIMENSIONS dimensions. */
  158162. #define RTREE_MAX_DIMENSIONS 5
  158163. /* Size of hash table Rtree.aHash. This hash table is not expected to
  158164. ** ever contain very many entries, so a fixed number of buckets is
  158165. ** used.
  158166. */
  158167. #define HASHSIZE 97
  158168. /* The xBestIndex method of this virtual table requires an estimate of
  158169. ** the number of rows in the virtual table to calculate the costs of
  158170. ** various strategies. If possible, this estimate is loaded from the
  158171. ** sqlite_stat1 table (with RTREE_MIN_ROWEST as a hard-coded minimum).
  158172. ** Otherwise, if no sqlite_stat1 entry is available, use
  158173. ** RTREE_DEFAULT_ROWEST.
  158174. */
  158175. #define RTREE_DEFAULT_ROWEST 1048576
  158176. #define RTREE_MIN_ROWEST 100
  158177. /*
  158178. ** An rtree virtual-table object.
  158179. */
  158180. struct Rtree {
  158181. sqlite3_vtab base; /* Base class. Must be first */
  158182. sqlite3 *db; /* Host database connection */
  158183. int iNodeSize; /* Size in bytes of each node in the node table */
  158184. u8 nDim; /* Number of dimensions */
  158185. u8 nDim2; /* Twice the number of dimensions */
  158186. u8 eCoordType; /* RTREE_COORD_REAL32 or RTREE_COORD_INT32 */
  158187. u8 nBytesPerCell; /* Bytes consumed per cell */
  158188. u8 inWrTrans; /* True if inside write transaction */
  158189. int iDepth; /* Current depth of the r-tree structure */
  158190. char *zDb; /* Name of database containing r-tree table */
  158191. char *zName; /* Name of r-tree table */
  158192. u32 nBusy; /* Current number of users of this structure */
  158193. i64 nRowEst; /* Estimated number of rows in this table */
  158194. u32 nCursor; /* Number of open cursors */
  158195. /* List of nodes removed during a CondenseTree operation. List is
  158196. ** linked together via the pointer normally used for hash chains -
  158197. ** RtreeNode.pNext. RtreeNode.iNode stores the depth of the sub-tree
  158198. ** headed by the node (leaf nodes have RtreeNode.iNode==0).
  158199. */
  158200. RtreeNode *pDeleted;
  158201. int iReinsertHeight; /* Height of sub-trees Reinsert() has run on */
  158202. /* Blob I/O on xxx_node */
  158203. sqlite3_blob *pNodeBlob;
  158204. /* Statements to read/write/delete a record from xxx_node */
  158205. sqlite3_stmt *pWriteNode;
  158206. sqlite3_stmt *pDeleteNode;
  158207. /* Statements to read/write/delete a record from xxx_rowid */
  158208. sqlite3_stmt *pReadRowid;
  158209. sqlite3_stmt *pWriteRowid;
  158210. sqlite3_stmt *pDeleteRowid;
  158211. /* Statements to read/write/delete a record from xxx_parent */
  158212. sqlite3_stmt *pReadParent;
  158213. sqlite3_stmt *pWriteParent;
  158214. sqlite3_stmt *pDeleteParent;
  158215. RtreeNode *aHash[HASHSIZE]; /* Hash table of in-memory nodes. */
  158216. };
  158217. /* Possible values for Rtree.eCoordType: */
  158218. #define RTREE_COORD_REAL32 0
  158219. #define RTREE_COORD_INT32 1
  158220. /*
  158221. ** If SQLITE_RTREE_INT_ONLY is defined, then this virtual table will
  158222. ** only deal with integer coordinates. No floating point operations
  158223. ** will be done.
  158224. */
  158225. #ifdef SQLITE_RTREE_INT_ONLY
  158226. typedef sqlite3_int64 RtreeDValue; /* High accuracy coordinate */
  158227. typedef int RtreeValue; /* Low accuracy coordinate */
  158228. # define RTREE_ZERO 0
  158229. #else
  158230. typedef double RtreeDValue; /* High accuracy coordinate */
  158231. typedef float RtreeValue; /* Low accuracy coordinate */
  158232. # define RTREE_ZERO 0.0
  158233. #endif
  158234. /*
  158235. ** When doing a search of an r-tree, instances of the following structure
  158236. ** record intermediate results from the tree walk.
  158237. **
  158238. ** The id is always a node-id. For iLevel>=1 the id is the node-id of
  158239. ** the node that the RtreeSearchPoint represents. When iLevel==0, however,
  158240. ** the id is of the parent node and the cell that RtreeSearchPoint
  158241. ** represents is the iCell-th entry in the parent node.
  158242. */
  158243. struct RtreeSearchPoint {
  158244. RtreeDValue rScore; /* The score for this node. Smallest goes first. */
  158245. sqlite3_int64 id; /* Node ID */
  158246. u8 iLevel; /* 0=entries. 1=leaf node. 2+ for higher */
  158247. u8 eWithin; /* PARTLY_WITHIN or FULLY_WITHIN */
  158248. u8 iCell; /* Cell index within the node */
  158249. };
  158250. /*
  158251. ** The minimum number of cells allowed for a node is a third of the
  158252. ** maximum. In Gutman's notation:
  158253. **
  158254. ** m = M/3
  158255. **
  158256. ** If an R*-tree "Reinsert" operation is required, the same number of
  158257. ** cells are removed from the overfull node and reinserted into the tree.
  158258. */
  158259. #define RTREE_MINCELLS(p) ((((p)->iNodeSize-4)/(p)->nBytesPerCell)/3)
  158260. #define RTREE_REINSERT(p) RTREE_MINCELLS(p)
  158261. #define RTREE_MAXCELLS 51
  158262. /*
  158263. ** The smallest possible node-size is (512-64)==448 bytes. And the largest
  158264. ** supported cell size is 48 bytes (8 byte rowid + ten 4 byte coordinates).
  158265. ** Therefore all non-root nodes must contain at least 3 entries. Since
  158266. ** 3^40 is greater than 2^64, an r-tree structure always has a depth of
  158267. ** 40 or less.
  158268. */
  158269. #define RTREE_MAX_DEPTH 40
  158270. /*
  158271. ** Number of entries in the cursor RtreeNode cache. The first entry is
  158272. ** used to cache the RtreeNode for RtreeCursor.sPoint. The remaining
  158273. ** entries cache the RtreeNode for the first elements of the priority queue.
  158274. */
  158275. #define RTREE_CACHE_SZ 5
  158276. /*
  158277. ** An rtree cursor object.
  158278. */
  158279. struct RtreeCursor {
  158280. sqlite3_vtab_cursor base; /* Base class. Must be first */
  158281. u8 atEOF; /* True if at end of search */
  158282. u8 bPoint; /* True if sPoint is valid */
  158283. int iStrategy; /* Copy of idxNum search parameter */
  158284. int nConstraint; /* Number of entries in aConstraint */
  158285. RtreeConstraint *aConstraint; /* Search constraints. */
  158286. int nPointAlloc; /* Number of slots allocated for aPoint[] */
  158287. int nPoint; /* Number of slots used in aPoint[] */
  158288. int mxLevel; /* iLevel value for root of the tree */
  158289. RtreeSearchPoint *aPoint; /* Priority queue for search points */
  158290. RtreeSearchPoint sPoint; /* Cached next search point */
  158291. RtreeNode *aNode[RTREE_CACHE_SZ]; /* Rtree node cache */
  158292. u32 anQueue[RTREE_MAX_DEPTH+1]; /* Number of queued entries by iLevel */
  158293. };
  158294. /* Return the Rtree of a RtreeCursor */
  158295. #define RTREE_OF_CURSOR(X) ((Rtree*)((X)->base.pVtab))
  158296. /*
  158297. ** A coordinate can be either a floating point number or a integer. All
  158298. ** coordinates within a single R-Tree are always of the same time.
  158299. */
  158300. union RtreeCoord {
  158301. RtreeValue f; /* Floating point value */
  158302. int i; /* Integer value */
  158303. u32 u; /* Unsigned for byte-order conversions */
  158304. };
  158305. /*
  158306. ** The argument is an RtreeCoord. Return the value stored within the RtreeCoord
  158307. ** formatted as a RtreeDValue (double or int64). This macro assumes that local
  158308. ** variable pRtree points to the Rtree structure associated with the
  158309. ** RtreeCoord.
  158310. */
  158311. #ifdef SQLITE_RTREE_INT_ONLY
  158312. # define DCOORD(coord) ((RtreeDValue)coord.i)
  158313. #else
  158314. # define DCOORD(coord) ( \
  158315. (pRtree->eCoordType==RTREE_COORD_REAL32) ? \
  158316. ((double)coord.f) : \
  158317. ((double)coord.i) \
  158318. )
  158319. #endif
  158320. /*
  158321. ** A search constraint.
  158322. */
  158323. struct RtreeConstraint {
  158324. int iCoord; /* Index of constrained coordinate */
  158325. int op; /* Constraining operation */
  158326. union {
  158327. RtreeDValue rValue; /* Constraint value. */
  158328. int (*xGeom)(sqlite3_rtree_geometry*,int,RtreeDValue*,int*);
  158329. int (*xQueryFunc)(sqlite3_rtree_query_info*);
  158330. } u;
  158331. sqlite3_rtree_query_info *pInfo; /* xGeom and xQueryFunc argument */
  158332. };
  158333. /* Possible values for RtreeConstraint.op */
  158334. #define RTREE_EQ 0x41 /* A */
  158335. #define RTREE_LE 0x42 /* B */
  158336. #define RTREE_LT 0x43 /* C */
  158337. #define RTREE_GE 0x44 /* D */
  158338. #define RTREE_GT 0x45 /* E */
  158339. #define RTREE_MATCH 0x46 /* F: Old-style sqlite3_rtree_geometry_callback() */
  158340. #define RTREE_QUERY 0x47 /* G: New-style sqlite3_rtree_query_callback() */
  158341. /*
  158342. ** An rtree structure node.
  158343. */
  158344. struct RtreeNode {
  158345. RtreeNode *pParent; /* Parent node */
  158346. i64 iNode; /* The node number */
  158347. int nRef; /* Number of references to this node */
  158348. int isDirty; /* True if the node needs to be written to disk */
  158349. u8 *zData; /* Content of the node, as should be on disk */
  158350. RtreeNode *pNext; /* Next node in this hash collision chain */
  158351. };
  158352. /* Return the number of cells in a node */
  158353. #define NCELL(pNode) readInt16(&(pNode)->zData[2])
  158354. /*
  158355. ** A single cell from a node, deserialized
  158356. */
  158357. struct RtreeCell {
  158358. i64 iRowid; /* Node or entry ID */
  158359. RtreeCoord aCoord[RTREE_MAX_DIMENSIONS*2]; /* Bounding box coordinates */
  158360. };
  158361. /*
  158362. ** This object becomes the sqlite3_user_data() for the SQL functions
  158363. ** that are created by sqlite3_rtree_geometry_callback() and
  158364. ** sqlite3_rtree_query_callback() and which appear on the right of MATCH
  158365. ** operators in order to constrain a search.
  158366. **
  158367. ** xGeom and xQueryFunc are the callback functions. Exactly one of
  158368. ** xGeom and xQueryFunc fields is non-NULL, depending on whether the
  158369. ** SQL function was created using sqlite3_rtree_geometry_callback() or
  158370. ** sqlite3_rtree_query_callback().
  158371. **
  158372. ** This object is deleted automatically by the destructor mechanism in
  158373. ** sqlite3_create_function_v2().
  158374. */
  158375. struct RtreeGeomCallback {
  158376. int (*xGeom)(sqlite3_rtree_geometry*, int, RtreeDValue*, int*);
  158377. int (*xQueryFunc)(sqlite3_rtree_query_info*);
  158378. void (*xDestructor)(void*);
  158379. void *pContext;
  158380. };
  158381. /*
  158382. ** An instance of this structure (in the form of a BLOB) is returned by
  158383. ** the SQL functions that sqlite3_rtree_geometry_callback() and
  158384. ** sqlite3_rtree_query_callback() create, and is read as the right-hand
  158385. ** operand to the MATCH operator of an R-Tree.
  158386. */
  158387. struct RtreeMatchArg {
  158388. u32 iSize; /* Size of this object */
  158389. RtreeGeomCallback cb; /* Info about the callback functions */
  158390. int nParam; /* Number of parameters to the SQL function */
  158391. sqlite3_value **apSqlParam; /* Original SQL parameter values */
  158392. RtreeDValue aParam[1]; /* Values for parameters to the SQL function */
  158393. };
  158394. #ifndef MAX
  158395. # define MAX(x,y) ((x) < (y) ? (y) : (x))
  158396. #endif
  158397. #ifndef MIN
  158398. # define MIN(x,y) ((x) > (y) ? (y) : (x))
  158399. #endif
  158400. /* What version of GCC is being used. 0 means GCC is not being used .
  158401. ** Note that the GCC_VERSION macro will also be set correctly when using
  158402. ** clang, since clang works hard to be gcc compatible. So the gcc
  158403. ** optimizations will also work when compiling with clang.
  158404. */
  158405. #ifndef GCC_VERSION
  158406. #if defined(__GNUC__) && !defined(SQLITE_DISABLE_INTRINSIC)
  158407. # define GCC_VERSION (__GNUC__*1000000+__GNUC_MINOR__*1000+__GNUC_PATCHLEVEL__)
  158408. #else
  158409. # define GCC_VERSION 0
  158410. #endif
  158411. #endif
  158412. /* The testcase() macro should already be defined in the amalgamation. If
  158413. ** it is not, make it a no-op.
  158414. */
  158415. #ifndef SQLITE_AMALGAMATION
  158416. # define testcase(X)
  158417. #endif
  158418. /*
  158419. ** Macros to determine whether the machine is big or little endian,
  158420. ** and whether or not that determination is run-time or compile-time.
  158421. **
  158422. ** For best performance, an attempt is made to guess at the byte-order
  158423. ** using C-preprocessor macros. If that is unsuccessful, or if
  158424. ** -DSQLITE_RUNTIME_BYTEORDER=1 is set, then byte-order is determined
  158425. ** at run-time.
  158426. */
  158427. #ifndef SQLITE_BYTEORDER
  158428. #if defined(i386) || defined(__i386__) || defined(_M_IX86) || \
  158429. defined(__x86_64) || defined(__x86_64__) || defined(_M_X64) || \
  158430. defined(_M_AMD64) || defined(_M_ARM) || defined(__x86) || \
  158431. defined(__arm__)
  158432. # define SQLITE_BYTEORDER 1234
  158433. #elif defined(sparc) || defined(__ppc__)
  158434. # define SQLITE_BYTEORDER 4321
  158435. #else
  158436. # define SQLITE_BYTEORDER 0 /* 0 means "unknown at compile-time" */
  158437. #endif
  158438. #endif
  158439. /* What version of MSVC is being used. 0 means MSVC is not being used */
  158440. #ifndef MSVC_VERSION
  158441. #if defined(_MSC_VER) && !defined(SQLITE_DISABLE_INTRINSIC)
  158442. # define MSVC_VERSION _MSC_VER
  158443. #else
  158444. # define MSVC_VERSION 0
  158445. #endif
  158446. #endif
  158447. /*
  158448. ** Functions to deserialize a 16 bit integer, 32 bit real number and
  158449. ** 64 bit integer. The deserialized value is returned.
  158450. */
  158451. static int readInt16(u8 *p){
  158452. return (p[0]<<8) + p[1];
  158453. }
  158454. static void readCoord(u8 *p, RtreeCoord *pCoord){
  158455. assert( ((((char*)p) - (char*)0)&3)==0 ); /* p is always 4-byte aligned */
  158456. #if SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  158457. pCoord->u = _byteswap_ulong(*(u32*)p);
  158458. #elif SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  158459. pCoord->u = __builtin_bswap32(*(u32*)p);
  158460. #elif SQLITE_BYTEORDER==4321
  158461. pCoord->u = *(u32*)p;
  158462. #else
  158463. pCoord->u = (
  158464. (((u32)p[0]) << 24) +
  158465. (((u32)p[1]) << 16) +
  158466. (((u32)p[2]) << 8) +
  158467. (((u32)p[3]) << 0)
  158468. );
  158469. #endif
  158470. }
  158471. static i64 readInt64(u8 *p){
  158472. #if SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  158473. u64 x;
  158474. memcpy(&x, p, 8);
  158475. return (i64)_byteswap_uint64(x);
  158476. #elif SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  158477. u64 x;
  158478. memcpy(&x, p, 8);
  158479. return (i64)__builtin_bswap64(x);
  158480. #elif SQLITE_BYTEORDER==4321
  158481. i64 x;
  158482. memcpy(&x, p, 8);
  158483. return x;
  158484. #else
  158485. return (i64)(
  158486. (((u64)p[0]) << 56) +
  158487. (((u64)p[1]) << 48) +
  158488. (((u64)p[2]) << 40) +
  158489. (((u64)p[3]) << 32) +
  158490. (((u64)p[4]) << 24) +
  158491. (((u64)p[5]) << 16) +
  158492. (((u64)p[6]) << 8) +
  158493. (((u64)p[7]) << 0)
  158494. );
  158495. #endif
  158496. }
  158497. /*
  158498. ** Functions to serialize a 16 bit integer, 32 bit real number and
  158499. ** 64 bit integer. The value returned is the number of bytes written
  158500. ** to the argument buffer (always 2, 4 and 8 respectively).
  158501. */
  158502. static void writeInt16(u8 *p, int i){
  158503. p[0] = (i>> 8)&0xFF;
  158504. p[1] = (i>> 0)&0xFF;
  158505. }
  158506. static int writeCoord(u8 *p, RtreeCoord *pCoord){
  158507. u32 i;
  158508. assert( ((((char*)p) - (char*)0)&3)==0 ); /* p is always 4-byte aligned */
  158509. assert( sizeof(RtreeCoord)==4 );
  158510. assert( sizeof(u32)==4 );
  158511. #if SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  158512. i = __builtin_bswap32(pCoord->u);
  158513. memcpy(p, &i, 4);
  158514. #elif SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  158515. i = _byteswap_ulong(pCoord->u);
  158516. memcpy(p, &i, 4);
  158517. #elif SQLITE_BYTEORDER==4321
  158518. i = pCoord->u;
  158519. memcpy(p, &i, 4);
  158520. #else
  158521. i = pCoord->u;
  158522. p[0] = (i>>24)&0xFF;
  158523. p[1] = (i>>16)&0xFF;
  158524. p[2] = (i>> 8)&0xFF;
  158525. p[3] = (i>> 0)&0xFF;
  158526. #endif
  158527. return 4;
  158528. }
  158529. static int writeInt64(u8 *p, i64 i){
  158530. #if SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  158531. i = (i64)__builtin_bswap64((u64)i);
  158532. memcpy(p, &i, 8);
  158533. #elif SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  158534. i = (i64)_byteswap_uint64((u64)i);
  158535. memcpy(p, &i, 8);
  158536. #elif SQLITE_BYTEORDER==4321
  158537. memcpy(p, &i, 8);
  158538. #else
  158539. p[0] = (i>>56)&0xFF;
  158540. p[1] = (i>>48)&0xFF;
  158541. p[2] = (i>>40)&0xFF;
  158542. p[3] = (i>>32)&0xFF;
  158543. p[4] = (i>>24)&0xFF;
  158544. p[5] = (i>>16)&0xFF;
  158545. p[6] = (i>> 8)&0xFF;
  158546. p[7] = (i>> 0)&0xFF;
  158547. #endif
  158548. return 8;
  158549. }
  158550. /*
  158551. ** Increment the reference count of node p.
  158552. */
  158553. static void nodeReference(RtreeNode *p){
  158554. if( p ){
  158555. p->nRef++;
  158556. }
  158557. }
  158558. /*
  158559. ** Clear the content of node p (set all bytes to 0x00).
  158560. */
  158561. static void nodeZero(Rtree *pRtree, RtreeNode *p){
  158562. memset(&p->zData[2], 0, pRtree->iNodeSize-2);
  158563. p->isDirty = 1;
  158564. }
  158565. /*
  158566. ** Given a node number iNode, return the corresponding key to use
  158567. ** in the Rtree.aHash table.
  158568. */
  158569. static int nodeHash(i64 iNode){
  158570. return iNode % HASHSIZE;
  158571. }
  158572. /*
  158573. ** Search the node hash table for node iNode. If found, return a pointer
  158574. ** to it. Otherwise, return 0.
  158575. */
  158576. static RtreeNode *nodeHashLookup(Rtree *pRtree, i64 iNode){
  158577. RtreeNode *p;
  158578. for(p=pRtree->aHash[nodeHash(iNode)]; p && p->iNode!=iNode; p=p->pNext);
  158579. return p;
  158580. }
  158581. /*
  158582. ** Add node pNode to the node hash table.
  158583. */
  158584. static void nodeHashInsert(Rtree *pRtree, RtreeNode *pNode){
  158585. int iHash;
  158586. assert( pNode->pNext==0 );
  158587. iHash = nodeHash(pNode->iNode);
  158588. pNode->pNext = pRtree->aHash[iHash];
  158589. pRtree->aHash[iHash] = pNode;
  158590. }
  158591. /*
  158592. ** Remove node pNode from the node hash table.
  158593. */
  158594. static void nodeHashDelete(Rtree *pRtree, RtreeNode *pNode){
  158595. RtreeNode **pp;
  158596. if( pNode->iNode!=0 ){
  158597. pp = &pRtree->aHash[nodeHash(pNode->iNode)];
  158598. for( ; (*pp)!=pNode; pp = &(*pp)->pNext){ assert(*pp); }
  158599. *pp = pNode->pNext;
  158600. pNode->pNext = 0;
  158601. }
  158602. }
  158603. /*
  158604. ** Allocate and return new r-tree node. Initially, (RtreeNode.iNode==0),
  158605. ** indicating that node has not yet been assigned a node number. It is
  158606. ** assigned a node number when nodeWrite() is called to write the
  158607. ** node contents out to the database.
  158608. */
  158609. static RtreeNode *nodeNew(Rtree *pRtree, RtreeNode *pParent){
  158610. RtreeNode *pNode;
  158611. pNode = (RtreeNode *)sqlite3_malloc(sizeof(RtreeNode) + pRtree->iNodeSize);
  158612. if( pNode ){
  158613. memset(pNode, 0, sizeof(RtreeNode) + pRtree->iNodeSize);
  158614. pNode->zData = (u8 *)&pNode[1];
  158615. pNode->nRef = 1;
  158616. pNode->pParent = pParent;
  158617. pNode->isDirty = 1;
  158618. nodeReference(pParent);
  158619. }
  158620. return pNode;
  158621. }
  158622. /*
  158623. ** Clear the Rtree.pNodeBlob object
  158624. */
  158625. static void nodeBlobReset(Rtree *pRtree){
  158626. if( pRtree->pNodeBlob && pRtree->inWrTrans==0 && pRtree->nCursor==0 ){
  158627. sqlite3_blob *pBlob = pRtree->pNodeBlob;
  158628. pRtree->pNodeBlob = 0;
  158629. sqlite3_blob_close(pBlob);
  158630. }
  158631. }
  158632. /*
  158633. ** Obtain a reference to an r-tree node.
  158634. */
  158635. static int nodeAcquire(
  158636. Rtree *pRtree, /* R-tree structure */
  158637. i64 iNode, /* Node number to load */
  158638. RtreeNode *pParent, /* Either the parent node or NULL */
  158639. RtreeNode **ppNode /* OUT: Acquired node */
  158640. ){
  158641. int rc = SQLITE_OK;
  158642. RtreeNode *pNode = 0;
  158643. /* Check if the requested node is already in the hash table. If so,
  158644. ** increase its reference count and return it.
  158645. */
  158646. if( (pNode = nodeHashLookup(pRtree, iNode)) ){
  158647. assert( !pParent || !pNode->pParent || pNode->pParent==pParent );
  158648. if( pParent && !pNode->pParent ){
  158649. nodeReference(pParent);
  158650. pNode->pParent = pParent;
  158651. }
  158652. pNode->nRef++;
  158653. *ppNode = pNode;
  158654. return SQLITE_OK;
  158655. }
  158656. if( pRtree->pNodeBlob ){
  158657. sqlite3_blob *pBlob = pRtree->pNodeBlob;
  158658. pRtree->pNodeBlob = 0;
  158659. rc = sqlite3_blob_reopen(pBlob, iNode);
  158660. pRtree->pNodeBlob = pBlob;
  158661. if( rc ){
  158662. nodeBlobReset(pRtree);
  158663. if( rc==SQLITE_NOMEM ) return SQLITE_NOMEM;
  158664. }
  158665. }
  158666. if( pRtree->pNodeBlob==0 ){
  158667. char *zTab = sqlite3_mprintf("%s_node", pRtree->zName);
  158668. if( zTab==0 ) return SQLITE_NOMEM;
  158669. rc = sqlite3_blob_open(pRtree->db, pRtree->zDb, zTab, "data", iNode, 0,
  158670. &pRtree->pNodeBlob);
  158671. sqlite3_free(zTab);
  158672. }
  158673. if( rc ){
  158674. nodeBlobReset(pRtree);
  158675. *ppNode = 0;
  158676. /* If unable to open an sqlite3_blob on the desired row, that can only
  158677. ** be because the shadow tables hold erroneous data. */
  158678. if( rc==SQLITE_ERROR ) rc = SQLITE_CORRUPT_VTAB;
  158679. }else if( pRtree->iNodeSize==sqlite3_blob_bytes(pRtree->pNodeBlob) ){
  158680. pNode = (RtreeNode *)sqlite3_malloc(sizeof(RtreeNode)+pRtree->iNodeSize);
  158681. if( !pNode ){
  158682. rc = SQLITE_NOMEM;
  158683. }else{
  158684. pNode->pParent = pParent;
  158685. pNode->zData = (u8 *)&pNode[1];
  158686. pNode->nRef = 1;
  158687. pNode->iNode = iNode;
  158688. pNode->isDirty = 0;
  158689. pNode->pNext = 0;
  158690. rc = sqlite3_blob_read(pRtree->pNodeBlob, pNode->zData,
  158691. pRtree->iNodeSize, 0);
  158692. nodeReference(pParent);
  158693. }
  158694. }
  158695. /* If the root node was just loaded, set pRtree->iDepth to the height
  158696. ** of the r-tree structure. A height of zero means all data is stored on
  158697. ** the root node. A height of one means the children of the root node
  158698. ** are the leaves, and so on. If the depth as specified on the root node
  158699. ** is greater than RTREE_MAX_DEPTH, the r-tree structure must be corrupt.
  158700. */
  158701. if( pNode && iNode==1 ){
  158702. pRtree->iDepth = readInt16(pNode->zData);
  158703. if( pRtree->iDepth>RTREE_MAX_DEPTH ){
  158704. rc = SQLITE_CORRUPT_VTAB;
  158705. }
  158706. }
  158707. /* If no error has occurred so far, check if the "number of entries"
  158708. ** field on the node is too large. If so, set the return code to
  158709. ** SQLITE_CORRUPT_VTAB.
  158710. */
  158711. if( pNode && rc==SQLITE_OK ){
  158712. if( NCELL(pNode)>((pRtree->iNodeSize-4)/pRtree->nBytesPerCell) ){
  158713. rc = SQLITE_CORRUPT_VTAB;
  158714. }
  158715. }
  158716. if( rc==SQLITE_OK ){
  158717. if( pNode!=0 ){
  158718. nodeHashInsert(pRtree, pNode);
  158719. }else{
  158720. rc = SQLITE_CORRUPT_VTAB;
  158721. }
  158722. *ppNode = pNode;
  158723. }else{
  158724. sqlite3_free(pNode);
  158725. *ppNode = 0;
  158726. }
  158727. return rc;
  158728. }
  158729. /*
  158730. ** Overwrite cell iCell of node pNode with the contents of pCell.
  158731. */
  158732. static void nodeOverwriteCell(
  158733. Rtree *pRtree, /* The overall R-Tree */
  158734. RtreeNode *pNode, /* The node into which the cell is to be written */
  158735. RtreeCell *pCell, /* The cell to write */
  158736. int iCell /* Index into pNode into which pCell is written */
  158737. ){
  158738. int ii;
  158739. u8 *p = &pNode->zData[4 + pRtree->nBytesPerCell*iCell];
  158740. p += writeInt64(p, pCell->iRowid);
  158741. for(ii=0; ii<pRtree->nDim2; ii++){
  158742. p += writeCoord(p, &pCell->aCoord[ii]);
  158743. }
  158744. pNode->isDirty = 1;
  158745. }
  158746. /*
  158747. ** Remove the cell with index iCell from node pNode.
  158748. */
  158749. static void nodeDeleteCell(Rtree *pRtree, RtreeNode *pNode, int iCell){
  158750. u8 *pDst = &pNode->zData[4 + pRtree->nBytesPerCell*iCell];
  158751. u8 *pSrc = &pDst[pRtree->nBytesPerCell];
  158752. int nByte = (NCELL(pNode) - iCell - 1) * pRtree->nBytesPerCell;
  158753. memmove(pDst, pSrc, nByte);
  158754. writeInt16(&pNode->zData[2], NCELL(pNode)-1);
  158755. pNode->isDirty = 1;
  158756. }
  158757. /*
  158758. ** Insert the contents of cell pCell into node pNode. If the insert
  158759. ** is successful, return SQLITE_OK.
  158760. **
  158761. ** If there is not enough free space in pNode, return SQLITE_FULL.
  158762. */
  158763. static int nodeInsertCell(
  158764. Rtree *pRtree, /* The overall R-Tree */
  158765. RtreeNode *pNode, /* Write new cell into this node */
  158766. RtreeCell *pCell /* The cell to be inserted */
  158767. ){
  158768. int nCell; /* Current number of cells in pNode */
  158769. int nMaxCell; /* Maximum number of cells for pNode */
  158770. nMaxCell = (pRtree->iNodeSize-4)/pRtree->nBytesPerCell;
  158771. nCell = NCELL(pNode);
  158772. assert( nCell<=nMaxCell );
  158773. if( nCell<nMaxCell ){
  158774. nodeOverwriteCell(pRtree, pNode, pCell, nCell);
  158775. writeInt16(&pNode->zData[2], nCell+1);
  158776. pNode->isDirty = 1;
  158777. }
  158778. return (nCell==nMaxCell);
  158779. }
  158780. /*
  158781. ** If the node is dirty, write it out to the database.
  158782. */
  158783. static int nodeWrite(Rtree *pRtree, RtreeNode *pNode){
  158784. int rc = SQLITE_OK;
  158785. if( pNode->isDirty ){
  158786. sqlite3_stmt *p = pRtree->pWriteNode;
  158787. if( pNode->iNode ){
  158788. sqlite3_bind_int64(p, 1, pNode->iNode);
  158789. }else{
  158790. sqlite3_bind_null(p, 1);
  158791. }
  158792. sqlite3_bind_blob(p, 2, pNode->zData, pRtree->iNodeSize, SQLITE_STATIC);
  158793. sqlite3_step(p);
  158794. pNode->isDirty = 0;
  158795. rc = sqlite3_reset(p);
  158796. sqlite3_bind_null(p, 2);
  158797. if( pNode->iNode==0 && rc==SQLITE_OK ){
  158798. pNode->iNode = sqlite3_last_insert_rowid(pRtree->db);
  158799. nodeHashInsert(pRtree, pNode);
  158800. }
  158801. }
  158802. return rc;
  158803. }
  158804. /*
  158805. ** Release a reference to a node. If the node is dirty and the reference
  158806. ** count drops to zero, the node data is written to the database.
  158807. */
  158808. static int nodeRelease(Rtree *pRtree, RtreeNode *pNode){
  158809. int rc = SQLITE_OK;
  158810. if( pNode ){
  158811. assert( pNode->nRef>0 );
  158812. pNode->nRef--;
  158813. if( pNode->nRef==0 ){
  158814. if( pNode->iNode==1 ){
  158815. pRtree->iDepth = -1;
  158816. }
  158817. if( pNode->pParent ){
  158818. rc = nodeRelease(pRtree, pNode->pParent);
  158819. }
  158820. if( rc==SQLITE_OK ){
  158821. rc = nodeWrite(pRtree, pNode);
  158822. }
  158823. nodeHashDelete(pRtree, pNode);
  158824. sqlite3_free(pNode);
  158825. }
  158826. }
  158827. return rc;
  158828. }
  158829. /*
  158830. ** Return the 64-bit integer value associated with cell iCell of
  158831. ** node pNode. If pNode is a leaf node, this is a rowid. If it is
  158832. ** an internal node, then the 64-bit integer is a child page number.
  158833. */
  158834. static i64 nodeGetRowid(
  158835. Rtree *pRtree, /* The overall R-Tree */
  158836. RtreeNode *pNode, /* The node from which to extract the ID */
  158837. int iCell /* The cell index from which to extract the ID */
  158838. ){
  158839. assert( iCell<NCELL(pNode) );
  158840. return readInt64(&pNode->zData[4 + pRtree->nBytesPerCell*iCell]);
  158841. }
  158842. /*
  158843. ** Return coordinate iCoord from cell iCell in node pNode.
  158844. */
  158845. static void nodeGetCoord(
  158846. Rtree *pRtree, /* The overall R-Tree */
  158847. RtreeNode *pNode, /* The node from which to extract a coordinate */
  158848. int iCell, /* The index of the cell within the node */
  158849. int iCoord, /* Which coordinate to extract */
  158850. RtreeCoord *pCoord /* OUT: Space to write result to */
  158851. ){
  158852. readCoord(&pNode->zData[12 + pRtree->nBytesPerCell*iCell + 4*iCoord], pCoord);
  158853. }
  158854. /*
  158855. ** Deserialize cell iCell of node pNode. Populate the structure pointed
  158856. ** to by pCell with the results.
  158857. */
  158858. static void nodeGetCell(
  158859. Rtree *pRtree, /* The overall R-Tree */
  158860. RtreeNode *pNode, /* The node containing the cell to be read */
  158861. int iCell, /* Index of the cell within the node */
  158862. RtreeCell *pCell /* OUT: Write the cell contents here */
  158863. ){
  158864. u8 *pData;
  158865. RtreeCoord *pCoord;
  158866. int ii = 0;
  158867. pCell->iRowid = nodeGetRowid(pRtree, pNode, iCell);
  158868. pData = pNode->zData + (12 + pRtree->nBytesPerCell*iCell);
  158869. pCoord = pCell->aCoord;
  158870. do{
  158871. readCoord(pData, &pCoord[ii]);
  158872. readCoord(pData+4, &pCoord[ii+1]);
  158873. pData += 8;
  158874. ii += 2;
  158875. }while( ii<pRtree->nDim2 );
  158876. }
  158877. /* Forward declaration for the function that does the work of
  158878. ** the virtual table module xCreate() and xConnect() methods.
  158879. */
  158880. static int rtreeInit(
  158881. sqlite3 *, void *, int, const char *const*, sqlite3_vtab **, char **, int
  158882. );
  158883. /*
  158884. ** Rtree virtual table module xCreate method.
  158885. */
  158886. static int rtreeCreate(
  158887. sqlite3 *db,
  158888. void *pAux,
  158889. int argc, const char *const*argv,
  158890. sqlite3_vtab **ppVtab,
  158891. char **pzErr
  158892. ){
  158893. return rtreeInit(db, pAux, argc, argv, ppVtab, pzErr, 1);
  158894. }
  158895. /*
  158896. ** Rtree virtual table module xConnect method.
  158897. */
  158898. static int rtreeConnect(
  158899. sqlite3 *db,
  158900. void *pAux,
  158901. int argc, const char *const*argv,
  158902. sqlite3_vtab **ppVtab,
  158903. char **pzErr
  158904. ){
  158905. return rtreeInit(db, pAux, argc, argv, ppVtab, pzErr, 0);
  158906. }
  158907. /*
  158908. ** Increment the r-tree reference count.
  158909. */
  158910. static void rtreeReference(Rtree *pRtree){
  158911. pRtree->nBusy++;
  158912. }
  158913. /*
  158914. ** Decrement the r-tree reference count. When the reference count reaches
  158915. ** zero the structure is deleted.
  158916. */
  158917. static void rtreeRelease(Rtree *pRtree){
  158918. pRtree->nBusy--;
  158919. if( pRtree->nBusy==0 ){
  158920. pRtree->inWrTrans = 0;
  158921. pRtree->nCursor = 0;
  158922. nodeBlobReset(pRtree);
  158923. sqlite3_finalize(pRtree->pWriteNode);
  158924. sqlite3_finalize(pRtree->pDeleteNode);
  158925. sqlite3_finalize(pRtree->pReadRowid);
  158926. sqlite3_finalize(pRtree->pWriteRowid);
  158927. sqlite3_finalize(pRtree->pDeleteRowid);
  158928. sqlite3_finalize(pRtree->pReadParent);
  158929. sqlite3_finalize(pRtree->pWriteParent);
  158930. sqlite3_finalize(pRtree->pDeleteParent);
  158931. sqlite3_free(pRtree);
  158932. }
  158933. }
  158934. /*
  158935. ** Rtree virtual table module xDisconnect method.
  158936. */
  158937. static int rtreeDisconnect(sqlite3_vtab *pVtab){
  158938. rtreeRelease((Rtree *)pVtab);
  158939. return SQLITE_OK;
  158940. }
  158941. /*
  158942. ** Rtree virtual table module xDestroy method.
  158943. */
  158944. static int rtreeDestroy(sqlite3_vtab *pVtab){
  158945. Rtree *pRtree = (Rtree *)pVtab;
  158946. int rc;
  158947. char *zCreate = sqlite3_mprintf(
  158948. "DROP TABLE '%q'.'%q_node';"
  158949. "DROP TABLE '%q'.'%q_rowid';"
  158950. "DROP TABLE '%q'.'%q_parent';",
  158951. pRtree->zDb, pRtree->zName,
  158952. pRtree->zDb, pRtree->zName,
  158953. pRtree->zDb, pRtree->zName
  158954. );
  158955. if( !zCreate ){
  158956. rc = SQLITE_NOMEM;
  158957. }else{
  158958. nodeBlobReset(pRtree);
  158959. rc = sqlite3_exec(pRtree->db, zCreate, 0, 0, 0);
  158960. sqlite3_free(zCreate);
  158961. }
  158962. if( rc==SQLITE_OK ){
  158963. rtreeRelease(pRtree);
  158964. }
  158965. return rc;
  158966. }
  158967. /*
  158968. ** Rtree virtual table module xOpen method.
  158969. */
  158970. static int rtreeOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){
  158971. int rc = SQLITE_NOMEM;
  158972. Rtree *pRtree = (Rtree *)pVTab;
  158973. RtreeCursor *pCsr;
  158974. pCsr = (RtreeCursor *)sqlite3_malloc(sizeof(RtreeCursor));
  158975. if( pCsr ){
  158976. memset(pCsr, 0, sizeof(RtreeCursor));
  158977. pCsr->base.pVtab = pVTab;
  158978. rc = SQLITE_OK;
  158979. pRtree->nCursor++;
  158980. }
  158981. *ppCursor = (sqlite3_vtab_cursor *)pCsr;
  158982. return rc;
  158983. }
  158984. /*
  158985. ** Free the RtreeCursor.aConstraint[] array and its contents.
  158986. */
  158987. static void freeCursorConstraints(RtreeCursor *pCsr){
  158988. if( pCsr->aConstraint ){
  158989. int i; /* Used to iterate through constraint array */
  158990. for(i=0; i<pCsr->nConstraint; i++){
  158991. sqlite3_rtree_query_info *pInfo = pCsr->aConstraint[i].pInfo;
  158992. if( pInfo ){
  158993. if( pInfo->xDelUser ) pInfo->xDelUser(pInfo->pUser);
  158994. sqlite3_free(pInfo);
  158995. }
  158996. }
  158997. sqlite3_free(pCsr->aConstraint);
  158998. pCsr->aConstraint = 0;
  158999. }
  159000. }
  159001. /*
  159002. ** Rtree virtual table module xClose method.
  159003. */
  159004. static int rtreeClose(sqlite3_vtab_cursor *cur){
  159005. Rtree *pRtree = (Rtree *)(cur->pVtab);
  159006. int ii;
  159007. RtreeCursor *pCsr = (RtreeCursor *)cur;
  159008. assert( pRtree->nCursor>0 );
  159009. freeCursorConstraints(pCsr);
  159010. sqlite3_free(pCsr->aPoint);
  159011. for(ii=0; ii<RTREE_CACHE_SZ; ii++) nodeRelease(pRtree, pCsr->aNode[ii]);
  159012. sqlite3_free(pCsr);
  159013. pRtree->nCursor--;
  159014. nodeBlobReset(pRtree);
  159015. return SQLITE_OK;
  159016. }
  159017. /*
  159018. ** Rtree virtual table module xEof method.
  159019. **
  159020. ** Return non-zero if the cursor does not currently point to a valid
  159021. ** record (i.e if the scan has finished), or zero otherwise.
  159022. */
  159023. static int rtreeEof(sqlite3_vtab_cursor *cur){
  159024. RtreeCursor *pCsr = (RtreeCursor *)cur;
  159025. return pCsr->atEOF;
  159026. }
  159027. /*
  159028. ** Convert raw bits from the on-disk RTree record into a coordinate value.
  159029. ** The on-disk format is big-endian and needs to be converted for little-
  159030. ** endian platforms. The on-disk record stores integer coordinates if
  159031. ** eInt is true and it stores 32-bit floating point records if eInt is
  159032. ** false. a[] is the four bytes of the on-disk record to be decoded.
  159033. ** Store the results in "r".
  159034. **
  159035. ** There are five versions of this macro. The last one is generic. The
  159036. ** other four are various architectures-specific optimizations.
  159037. */
  159038. #if SQLITE_BYTEORDER==1234 && MSVC_VERSION>=1300
  159039. #define RTREE_DECODE_COORD(eInt, a, r) { \
  159040. RtreeCoord c; /* Coordinate decoded */ \
  159041. c.u = _byteswap_ulong(*(u32*)a); \
  159042. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  159043. }
  159044. #elif SQLITE_BYTEORDER==1234 && GCC_VERSION>=4003000
  159045. #define RTREE_DECODE_COORD(eInt, a, r) { \
  159046. RtreeCoord c; /* Coordinate decoded */ \
  159047. c.u = __builtin_bswap32(*(u32*)a); \
  159048. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  159049. }
  159050. #elif SQLITE_BYTEORDER==1234
  159051. #define RTREE_DECODE_COORD(eInt, a, r) { \
  159052. RtreeCoord c; /* Coordinate decoded */ \
  159053. memcpy(&c.u,a,4); \
  159054. c.u = ((c.u>>24)&0xff)|((c.u>>8)&0xff00)| \
  159055. ((c.u&0xff)<<24)|((c.u&0xff00)<<8); \
  159056. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  159057. }
  159058. #elif SQLITE_BYTEORDER==4321
  159059. #define RTREE_DECODE_COORD(eInt, a, r) { \
  159060. RtreeCoord c; /* Coordinate decoded */ \
  159061. memcpy(&c.u,a,4); \
  159062. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  159063. }
  159064. #else
  159065. #define RTREE_DECODE_COORD(eInt, a, r) { \
  159066. RtreeCoord c; /* Coordinate decoded */ \
  159067. c.u = ((u32)a[0]<<24) + ((u32)a[1]<<16) \
  159068. +((u32)a[2]<<8) + a[3]; \
  159069. r = eInt ? (sqlite3_rtree_dbl)c.i : (sqlite3_rtree_dbl)c.f; \
  159070. }
  159071. #endif
  159072. /*
  159073. ** Check the RTree node or entry given by pCellData and p against the MATCH
  159074. ** constraint pConstraint.
  159075. */
  159076. static int rtreeCallbackConstraint(
  159077. RtreeConstraint *pConstraint, /* The constraint to test */
  159078. int eInt, /* True if RTree holding integer coordinates */
  159079. u8 *pCellData, /* Raw cell content */
  159080. RtreeSearchPoint *pSearch, /* Container of this cell */
  159081. sqlite3_rtree_dbl *prScore, /* OUT: score for the cell */
  159082. int *peWithin /* OUT: visibility of the cell */
  159083. ){
  159084. sqlite3_rtree_query_info *pInfo = pConstraint->pInfo; /* Callback info */
  159085. int nCoord = pInfo->nCoord; /* No. of coordinates */
  159086. int rc; /* Callback return code */
  159087. RtreeCoord c; /* Translator union */
  159088. sqlite3_rtree_dbl aCoord[RTREE_MAX_DIMENSIONS*2]; /* Decoded coordinates */
  159089. assert( pConstraint->op==RTREE_MATCH || pConstraint->op==RTREE_QUERY );
  159090. assert( nCoord==2 || nCoord==4 || nCoord==6 || nCoord==8 || nCoord==10 );
  159091. if( pConstraint->op==RTREE_QUERY && pSearch->iLevel==1 ){
  159092. pInfo->iRowid = readInt64(pCellData);
  159093. }
  159094. pCellData += 8;
  159095. #ifndef SQLITE_RTREE_INT_ONLY
  159096. if( eInt==0 ){
  159097. switch( nCoord ){
  159098. case 10: readCoord(pCellData+36, &c); aCoord[9] = c.f;
  159099. readCoord(pCellData+32, &c); aCoord[8] = c.f;
  159100. case 8: readCoord(pCellData+28, &c); aCoord[7] = c.f;
  159101. readCoord(pCellData+24, &c); aCoord[6] = c.f;
  159102. case 6: readCoord(pCellData+20, &c); aCoord[5] = c.f;
  159103. readCoord(pCellData+16, &c); aCoord[4] = c.f;
  159104. case 4: readCoord(pCellData+12, &c); aCoord[3] = c.f;
  159105. readCoord(pCellData+8, &c); aCoord[2] = c.f;
  159106. default: readCoord(pCellData+4, &c); aCoord[1] = c.f;
  159107. readCoord(pCellData, &c); aCoord[0] = c.f;
  159108. }
  159109. }else
  159110. #endif
  159111. {
  159112. switch( nCoord ){
  159113. case 10: readCoord(pCellData+36, &c); aCoord[9] = c.i;
  159114. readCoord(pCellData+32, &c); aCoord[8] = c.i;
  159115. case 8: readCoord(pCellData+28, &c); aCoord[7] = c.i;
  159116. readCoord(pCellData+24, &c); aCoord[6] = c.i;
  159117. case 6: readCoord(pCellData+20, &c); aCoord[5] = c.i;
  159118. readCoord(pCellData+16, &c); aCoord[4] = c.i;
  159119. case 4: readCoord(pCellData+12, &c); aCoord[3] = c.i;
  159120. readCoord(pCellData+8, &c); aCoord[2] = c.i;
  159121. default: readCoord(pCellData+4, &c); aCoord[1] = c.i;
  159122. readCoord(pCellData, &c); aCoord[0] = c.i;
  159123. }
  159124. }
  159125. if( pConstraint->op==RTREE_MATCH ){
  159126. int eWithin = 0;
  159127. rc = pConstraint->u.xGeom((sqlite3_rtree_geometry*)pInfo,
  159128. nCoord, aCoord, &eWithin);
  159129. if( eWithin==0 ) *peWithin = NOT_WITHIN;
  159130. *prScore = RTREE_ZERO;
  159131. }else{
  159132. pInfo->aCoord = aCoord;
  159133. pInfo->iLevel = pSearch->iLevel - 1;
  159134. pInfo->rScore = pInfo->rParentScore = pSearch->rScore;
  159135. pInfo->eWithin = pInfo->eParentWithin = pSearch->eWithin;
  159136. rc = pConstraint->u.xQueryFunc(pInfo);
  159137. if( pInfo->eWithin<*peWithin ) *peWithin = pInfo->eWithin;
  159138. if( pInfo->rScore<*prScore || *prScore<RTREE_ZERO ){
  159139. *prScore = pInfo->rScore;
  159140. }
  159141. }
  159142. return rc;
  159143. }
  159144. /*
  159145. ** Check the internal RTree node given by pCellData against constraint p.
  159146. ** If this constraint cannot be satisfied by any child within the node,
  159147. ** set *peWithin to NOT_WITHIN.
  159148. */
  159149. static void rtreeNonleafConstraint(
  159150. RtreeConstraint *p, /* The constraint to test */
  159151. int eInt, /* True if RTree holds integer coordinates */
  159152. u8 *pCellData, /* Raw cell content as appears on disk */
  159153. int *peWithin /* Adjust downward, as appropriate */
  159154. ){
  159155. sqlite3_rtree_dbl val; /* Coordinate value convert to a double */
  159156. /* p->iCoord might point to either a lower or upper bound coordinate
  159157. ** in a coordinate pair. But make pCellData point to the lower bound.
  159158. */
  159159. pCellData += 8 + 4*(p->iCoord&0xfe);
  159160. assert(p->op==RTREE_LE || p->op==RTREE_LT || p->op==RTREE_GE
  159161. || p->op==RTREE_GT || p->op==RTREE_EQ );
  159162. assert( ((((char*)pCellData) - (char*)0)&3)==0 ); /* 4-byte aligned */
  159163. switch( p->op ){
  159164. case RTREE_LE:
  159165. case RTREE_LT:
  159166. case RTREE_EQ:
  159167. RTREE_DECODE_COORD(eInt, pCellData, val);
  159168. /* val now holds the lower bound of the coordinate pair */
  159169. if( p->u.rValue>=val ) return;
  159170. if( p->op!=RTREE_EQ ) break; /* RTREE_LE and RTREE_LT end here */
  159171. /* Fall through for the RTREE_EQ case */
  159172. default: /* RTREE_GT or RTREE_GE, or fallthrough of RTREE_EQ */
  159173. pCellData += 4;
  159174. RTREE_DECODE_COORD(eInt, pCellData, val);
  159175. /* val now holds the upper bound of the coordinate pair */
  159176. if( p->u.rValue<=val ) return;
  159177. }
  159178. *peWithin = NOT_WITHIN;
  159179. }
  159180. /*
  159181. ** Check the leaf RTree cell given by pCellData against constraint p.
  159182. ** If this constraint is not satisfied, set *peWithin to NOT_WITHIN.
  159183. ** If the constraint is satisfied, leave *peWithin unchanged.
  159184. **
  159185. ** The constraint is of the form: xN op $val
  159186. **
  159187. ** The op is given by p->op. The xN is p->iCoord-th coordinate in
  159188. ** pCellData. $val is given by p->u.rValue.
  159189. */
  159190. static void rtreeLeafConstraint(
  159191. RtreeConstraint *p, /* The constraint to test */
  159192. int eInt, /* True if RTree holds integer coordinates */
  159193. u8 *pCellData, /* Raw cell content as appears on disk */
  159194. int *peWithin /* Adjust downward, as appropriate */
  159195. ){
  159196. RtreeDValue xN; /* Coordinate value converted to a double */
  159197. assert(p->op==RTREE_LE || p->op==RTREE_LT || p->op==RTREE_GE
  159198. || p->op==RTREE_GT || p->op==RTREE_EQ );
  159199. pCellData += 8 + p->iCoord*4;
  159200. assert( ((((char*)pCellData) - (char*)0)&3)==0 ); /* 4-byte aligned */
  159201. RTREE_DECODE_COORD(eInt, pCellData, xN);
  159202. switch( p->op ){
  159203. case RTREE_LE: if( xN <= p->u.rValue ) return; break;
  159204. case RTREE_LT: if( xN < p->u.rValue ) return; break;
  159205. case RTREE_GE: if( xN >= p->u.rValue ) return; break;
  159206. case RTREE_GT: if( xN > p->u.rValue ) return; break;
  159207. default: if( xN == p->u.rValue ) return; break;
  159208. }
  159209. *peWithin = NOT_WITHIN;
  159210. }
  159211. /*
  159212. ** One of the cells in node pNode is guaranteed to have a 64-bit
  159213. ** integer value equal to iRowid. Return the index of this cell.
  159214. */
  159215. static int nodeRowidIndex(
  159216. Rtree *pRtree,
  159217. RtreeNode *pNode,
  159218. i64 iRowid,
  159219. int *piIndex
  159220. ){
  159221. int ii;
  159222. int nCell = NCELL(pNode);
  159223. assert( nCell<200 );
  159224. for(ii=0; ii<nCell; ii++){
  159225. if( nodeGetRowid(pRtree, pNode, ii)==iRowid ){
  159226. *piIndex = ii;
  159227. return SQLITE_OK;
  159228. }
  159229. }
  159230. return SQLITE_CORRUPT_VTAB;
  159231. }
  159232. /*
  159233. ** Return the index of the cell containing a pointer to node pNode
  159234. ** in its parent. If pNode is the root node, return -1.
  159235. */
  159236. static int nodeParentIndex(Rtree *pRtree, RtreeNode *pNode, int *piIndex){
  159237. RtreeNode *pParent = pNode->pParent;
  159238. if( pParent ){
  159239. return nodeRowidIndex(pRtree, pParent, pNode->iNode, piIndex);
  159240. }
  159241. *piIndex = -1;
  159242. return SQLITE_OK;
  159243. }
  159244. /*
  159245. ** Compare two search points. Return negative, zero, or positive if the first
  159246. ** is less than, equal to, or greater than the second.
  159247. **
  159248. ** The rScore is the primary key. Smaller rScore values come first.
  159249. ** If the rScore is a tie, then use iLevel as the tie breaker with smaller
  159250. ** iLevel values coming first. In this way, if rScore is the same for all
  159251. ** SearchPoints, then iLevel becomes the deciding factor and the result
  159252. ** is a depth-first search, which is the desired default behavior.
  159253. */
  159254. static int rtreeSearchPointCompare(
  159255. const RtreeSearchPoint *pA,
  159256. const RtreeSearchPoint *pB
  159257. ){
  159258. if( pA->rScore<pB->rScore ) return -1;
  159259. if( pA->rScore>pB->rScore ) return +1;
  159260. if( pA->iLevel<pB->iLevel ) return -1;
  159261. if( pA->iLevel>pB->iLevel ) return +1;
  159262. return 0;
  159263. }
  159264. /*
  159265. ** Interchange two search points in a cursor.
  159266. */
  159267. static void rtreeSearchPointSwap(RtreeCursor *p, int i, int j){
  159268. RtreeSearchPoint t = p->aPoint[i];
  159269. assert( i<j );
  159270. p->aPoint[i] = p->aPoint[j];
  159271. p->aPoint[j] = t;
  159272. i++; j++;
  159273. if( i<RTREE_CACHE_SZ ){
  159274. if( j>=RTREE_CACHE_SZ ){
  159275. nodeRelease(RTREE_OF_CURSOR(p), p->aNode[i]);
  159276. p->aNode[i] = 0;
  159277. }else{
  159278. RtreeNode *pTemp = p->aNode[i];
  159279. p->aNode[i] = p->aNode[j];
  159280. p->aNode[j] = pTemp;
  159281. }
  159282. }
  159283. }
  159284. /*
  159285. ** Return the search point with the lowest current score.
  159286. */
  159287. static RtreeSearchPoint *rtreeSearchPointFirst(RtreeCursor *pCur){
  159288. return pCur->bPoint ? &pCur->sPoint : pCur->nPoint ? pCur->aPoint : 0;
  159289. }
  159290. /*
  159291. ** Get the RtreeNode for the search point with the lowest score.
  159292. */
  159293. static RtreeNode *rtreeNodeOfFirstSearchPoint(RtreeCursor *pCur, int *pRC){
  159294. sqlite3_int64 id;
  159295. int ii = 1 - pCur->bPoint;
  159296. assert( ii==0 || ii==1 );
  159297. assert( pCur->bPoint || pCur->nPoint );
  159298. if( pCur->aNode[ii]==0 ){
  159299. assert( pRC!=0 );
  159300. id = ii ? pCur->aPoint[0].id : pCur->sPoint.id;
  159301. *pRC = nodeAcquire(RTREE_OF_CURSOR(pCur), id, 0, &pCur->aNode[ii]);
  159302. }
  159303. return pCur->aNode[ii];
  159304. }
  159305. /*
  159306. ** Push a new element onto the priority queue
  159307. */
  159308. static RtreeSearchPoint *rtreeEnqueue(
  159309. RtreeCursor *pCur, /* The cursor */
  159310. RtreeDValue rScore, /* Score for the new search point */
  159311. u8 iLevel /* Level for the new search point */
  159312. ){
  159313. int i, j;
  159314. RtreeSearchPoint *pNew;
  159315. if( pCur->nPoint>=pCur->nPointAlloc ){
  159316. int nNew = pCur->nPointAlloc*2 + 8;
  159317. pNew = sqlite3_realloc(pCur->aPoint, nNew*sizeof(pCur->aPoint[0]));
  159318. if( pNew==0 ) return 0;
  159319. pCur->aPoint = pNew;
  159320. pCur->nPointAlloc = nNew;
  159321. }
  159322. i = pCur->nPoint++;
  159323. pNew = pCur->aPoint + i;
  159324. pNew->rScore = rScore;
  159325. pNew->iLevel = iLevel;
  159326. assert( iLevel<=RTREE_MAX_DEPTH );
  159327. while( i>0 ){
  159328. RtreeSearchPoint *pParent;
  159329. j = (i-1)/2;
  159330. pParent = pCur->aPoint + j;
  159331. if( rtreeSearchPointCompare(pNew, pParent)>=0 ) break;
  159332. rtreeSearchPointSwap(pCur, j, i);
  159333. i = j;
  159334. pNew = pParent;
  159335. }
  159336. return pNew;
  159337. }
  159338. /*
  159339. ** Allocate a new RtreeSearchPoint and return a pointer to it. Return
  159340. ** NULL if malloc fails.
  159341. */
  159342. static RtreeSearchPoint *rtreeSearchPointNew(
  159343. RtreeCursor *pCur, /* The cursor */
  159344. RtreeDValue rScore, /* Score for the new search point */
  159345. u8 iLevel /* Level for the new search point */
  159346. ){
  159347. RtreeSearchPoint *pNew, *pFirst;
  159348. pFirst = rtreeSearchPointFirst(pCur);
  159349. pCur->anQueue[iLevel]++;
  159350. if( pFirst==0
  159351. || pFirst->rScore>rScore
  159352. || (pFirst->rScore==rScore && pFirst->iLevel>iLevel)
  159353. ){
  159354. if( pCur->bPoint ){
  159355. int ii;
  159356. pNew = rtreeEnqueue(pCur, rScore, iLevel);
  159357. if( pNew==0 ) return 0;
  159358. ii = (int)(pNew - pCur->aPoint) + 1;
  159359. if( ii<RTREE_CACHE_SZ ){
  159360. assert( pCur->aNode[ii]==0 );
  159361. pCur->aNode[ii] = pCur->aNode[0];
  159362. }else{
  159363. nodeRelease(RTREE_OF_CURSOR(pCur), pCur->aNode[0]);
  159364. }
  159365. pCur->aNode[0] = 0;
  159366. *pNew = pCur->sPoint;
  159367. }
  159368. pCur->sPoint.rScore = rScore;
  159369. pCur->sPoint.iLevel = iLevel;
  159370. pCur->bPoint = 1;
  159371. return &pCur->sPoint;
  159372. }else{
  159373. return rtreeEnqueue(pCur, rScore, iLevel);
  159374. }
  159375. }
  159376. #if 0
  159377. /* Tracing routines for the RtreeSearchPoint queue */
  159378. static void tracePoint(RtreeSearchPoint *p, int idx, RtreeCursor *pCur){
  159379. if( idx<0 ){ printf(" s"); }else{ printf("%2d", idx); }
  159380. printf(" %d.%05lld.%02d %g %d",
  159381. p->iLevel, p->id, p->iCell, p->rScore, p->eWithin
  159382. );
  159383. idx++;
  159384. if( idx<RTREE_CACHE_SZ ){
  159385. printf(" %p\n", pCur->aNode[idx]);
  159386. }else{
  159387. printf("\n");
  159388. }
  159389. }
  159390. static void traceQueue(RtreeCursor *pCur, const char *zPrefix){
  159391. int ii;
  159392. printf("=== %9s ", zPrefix);
  159393. if( pCur->bPoint ){
  159394. tracePoint(&pCur->sPoint, -1, pCur);
  159395. }
  159396. for(ii=0; ii<pCur->nPoint; ii++){
  159397. if( ii>0 || pCur->bPoint ) printf(" ");
  159398. tracePoint(&pCur->aPoint[ii], ii, pCur);
  159399. }
  159400. }
  159401. # define RTREE_QUEUE_TRACE(A,B) traceQueue(A,B)
  159402. #else
  159403. # define RTREE_QUEUE_TRACE(A,B) /* no-op */
  159404. #endif
  159405. /* Remove the search point with the lowest current score.
  159406. */
  159407. static void rtreeSearchPointPop(RtreeCursor *p){
  159408. int i, j, k, n;
  159409. i = 1 - p->bPoint;
  159410. assert( i==0 || i==1 );
  159411. if( p->aNode[i] ){
  159412. nodeRelease(RTREE_OF_CURSOR(p), p->aNode[i]);
  159413. p->aNode[i] = 0;
  159414. }
  159415. if( p->bPoint ){
  159416. p->anQueue[p->sPoint.iLevel]--;
  159417. p->bPoint = 0;
  159418. }else if( p->nPoint ){
  159419. p->anQueue[p->aPoint[0].iLevel]--;
  159420. n = --p->nPoint;
  159421. p->aPoint[0] = p->aPoint[n];
  159422. if( n<RTREE_CACHE_SZ-1 ){
  159423. p->aNode[1] = p->aNode[n+1];
  159424. p->aNode[n+1] = 0;
  159425. }
  159426. i = 0;
  159427. while( (j = i*2+1)<n ){
  159428. k = j+1;
  159429. if( k<n && rtreeSearchPointCompare(&p->aPoint[k], &p->aPoint[j])<0 ){
  159430. if( rtreeSearchPointCompare(&p->aPoint[k], &p->aPoint[i])<0 ){
  159431. rtreeSearchPointSwap(p, i, k);
  159432. i = k;
  159433. }else{
  159434. break;
  159435. }
  159436. }else{
  159437. if( rtreeSearchPointCompare(&p->aPoint[j], &p->aPoint[i])<0 ){
  159438. rtreeSearchPointSwap(p, i, j);
  159439. i = j;
  159440. }else{
  159441. break;
  159442. }
  159443. }
  159444. }
  159445. }
  159446. }
  159447. /*
  159448. ** Continue the search on cursor pCur until the front of the queue
  159449. ** contains an entry suitable for returning as a result-set row,
  159450. ** or until the RtreeSearchPoint queue is empty, indicating that the
  159451. ** query has completed.
  159452. */
  159453. static int rtreeStepToLeaf(RtreeCursor *pCur){
  159454. RtreeSearchPoint *p;
  159455. Rtree *pRtree = RTREE_OF_CURSOR(pCur);
  159456. RtreeNode *pNode;
  159457. int eWithin;
  159458. int rc = SQLITE_OK;
  159459. int nCell;
  159460. int nConstraint = pCur->nConstraint;
  159461. int ii;
  159462. int eInt;
  159463. RtreeSearchPoint x;
  159464. eInt = pRtree->eCoordType==RTREE_COORD_INT32;
  159465. while( (p = rtreeSearchPointFirst(pCur))!=0 && p->iLevel>0 ){
  159466. pNode = rtreeNodeOfFirstSearchPoint(pCur, &rc);
  159467. if( rc ) return rc;
  159468. nCell = NCELL(pNode);
  159469. assert( nCell<200 );
  159470. while( p->iCell<nCell ){
  159471. sqlite3_rtree_dbl rScore = (sqlite3_rtree_dbl)-1;
  159472. u8 *pCellData = pNode->zData + (4+pRtree->nBytesPerCell*p->iCell);
  159473. eWithin = FULLY_WITHIN;
  159474. for(ii=0; ii<nConstraint; ii++){
  159475. RtreeConstraint *pConstraint = pCur->aConstraint + ii;
  159476. if( pConstraint->op>=RTREE_MATCH ){
  159477. rc = rtreeCallbackConstraint(pConstraint, eInt, pCellData, p,
  159478. &rScore, &eWithin);
  159479. if( rc ) return rc;
  159480. }else if( p->iLevel==1 ){
  159481. rtreeLeafConstraint(pConstraint, eInt, pCellData, &eWithin);
  159482. }else{
  159483. rtreeNonleafConstraint(pConstraint, eInt, pCellData, &eWithin);
  159484. }
  159485. if( eWithin==NOT_WITHIN ) break;
  159486. }
  159487. p->iCell++;
  159488. if( eWithin==NOT_WITHIN ) continue;
  159489. x.iLevel = p->iLevel - 1;
  159490. if( x.iLevel ){
  159491. x.id = readInt64(pCellData);
  159492. x.iCell = 0;
  159493. }else{
  159494. x.id = p->id;
  159495. x.iCell = p->iCell - 1;
  159496. }
  159497. if( p->iCell>=nCell ){
  159498. RTREE_QUEUE_TRACE(pCur, "POP-S:");
  159499. rtreeSearchPointPop(pCur);
  159500. }
  159501. if( rScore<RTREE_ZERO ) rScore = RTREE_ZERO;
  159502. p = rtreeSearchPointNew(pCur, rScore, x.iLevel);
  159503. if( p==0 ) return SQLITE_NOMEM;
  159504. p->eWithin = (u8)eWithin;
  159505. p->id = x.id;
  159506. p->iCell = x.iCell;
  159507. RTREE_QUEUE_TRACE(pCur, "PUSH-S:");
  159508. break;
  159509. }
  159510. if( p->iCell>=nCell ){
  159511. RTREE_QUEUE_TRACE(pCur, "POP-Se:");
  159512. rtreeSearchPointPop(pCur);
  159513. }
  159514. }
  159515. pCur->atEOF = p==0;
  159516. return SQLITE_OK;
  159517. }
  159518. /*
  159519. ** Rtree virtual table module xNext method.
  159520. */
  159521. static int rtreeNext(sqlite3_vtab_cursor *pVtabCursor){
  159522. RtreeCursor *pCsr = (RtreeCursor *)pVtabCursor;
  159523. int rc = SQLITE_OK;
  159524. /* Move to the next entry that matches the configured constraints. */
  159525. RTREE_QUEUE_TRACE(pCsr, "POP-Nx:");
  159526. rtreeSearchPointPop(pCsr);
  159527. rc = rtreeStepToLeaf(pCsr);
  159528. return rc;
  159529. }
  159530. /*
  159531. ** Rtree virtual table module xRowid method.
  159532. */
  159533. static int rtreeRowid(sqlite3_vtab_cursor *pVtabCursor, sqlite_int64 *pRowid){
  159534. RtreeCursor *pCsr = (RtreeCursor *)pVtabCursor;
  159535. RtreeSearchPoint *p = rtreeSearchPointFirst(pCsr);
  159536. int rc = SQLITE_OK;
  159537. RtreeNode *pNode = rtreeNodeOfFirstSearchPoint(pCsr, &rc);
  159538. if( rc==SQLITE_OK && p ){
  159539. *pRowid = nodeGetRowid(RTREE_OF_CURSOR(pCsr), pNode, p->iCell);
  159540. }
  159541. return rc;
  159542. }
  159543. /*
  159544. ** Rtree virtual table module xColumn method.
  159545. */
  159546. static int rtreeColumn(sqlite3_vtab_cursor *cur, sqlite3_context *ctx, int i){
  159547. Rtree *pRtree = (Rtree *)cur->pVtab;
  159548. RtreeCursor *pCsr = (RtreeCursor *)cur;
  159549. RtreeSearchPoint *p = rtreeSearchPointFirst(pCsr);
  159550. RtreeCoord c;
  159551. int rc = SQLITE_OK;
  159552. RtreeNode *pNode = rtreeNodeOfFirstSearchPoint(pCsr, &rc);
  159553. if( rc ) return rc;
  159554. if( p==0 ) return SQLITE_OK;
  159555. if( i==0 ){
  159556. sqlite3_result_int64(ctx, nodeGetRowid(pRtree, pNode, p->iCell));
  159557. }else{
  159558. nodeGetCoord(pRtree, pNode, p->iCell, i-1, &c);
  159559. #ifndef SQLITE_RTREE_INT_ONLY
  159560. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  159561. sqlite3_result_double(ctx, c.f);
  159562. }else
  159563. #endif
  159564. {
  159565. assert( pRtree->eCoordType==RTREE_COORD_INT32 );
  159566. sqlite3_result_int(ctx, c.i);
  159567. }
  159568. }
  159569. return SQLITE_OK;
  159570. }
  159571. /*
  159572. ** Use nodeAcquire() to obtain the leaf node containing the record with
  159573. ** rowid iRowid. If successful, set *ppLeaf to point to the node and
  159574. ** return SQLITE_OK. If there is no such record in the table, set
  159575. ** *ppLeaf to 0 and return SQLITE_OK. If an error occurs, set *ppLeaf
  159576. ** to zero and return an SQLite error code.
  159577. */
  159578. static int findLeafNode(
  159579. Rtree *pRtree, /* RTree to search */
  159580. i64 iRowid, /* The rowid searching for */
  159581. RtreeNode **ppLeaf, /* Write the node here */
  159582. sqlite3_int64 *piNode /* Write the node-id here */
  159583. ){
  159584. int rc;
  159585. *ppLeaf = 0;
  159586. sqlite3_bind_int64(pRtree->pReadRowid, 1, iRowid);
  159587. if( sqlite3_step(pRtree->pReadRowid)==SQLITE_ROW ){
  159588. i64 iNode = sqlite3_column_int64(pRtree->pReadRowid, 0);
  159589. if( piNode ) *piNode = iNode;
  159590. rc = nodeAcquire(pRtree, iNode, 0, ppLeaf);
  159591. sqlite3_reset(pRtree->pReadRowid);
  159592. }else{
  159593. rc = sqlite3_reset(pRtree->pReadRowid);
  159594. }
  159595. return rc;
  159596. }
  159597. /*
  159598. ** This function is called to configure the RtreeConstraint object passed
  159599. ** as the second argument for a MATCH constraint. The value passed as the
  159600. ** first argument to this function is the right-hand operand to the MATCH
  159601. ** operator.
  159602. */
  159603. static int deserializeGeometry(sqlite3_value *pValue, RtreeConstraint *pCons){
  159604. RtreeMatchArg *pBlob, *pSrc; /* BLOB returned by geometry function */
  159605. sqlite3_rtree_query_info *pInfo; /* Callback information */
  159606. pSrc = sqlite3_value_pointer(pValue, "RtreeMatchArg");
  159607. if( pSrc==0 ) return SQLITE_ERROR;
  159608. pInfo = (sqlite3_rtree_query_info*)
  159609. sqlite3_malloc64( sizeof(*pInfo)+pSrc->iSize );
  159610. if( !pInfo ) return SQLITE_NOMEM;
  159611. memset(pInfo, 0, sizeof(*pInfo));
  159612. pBlob = (RtreeMatchArg*)&pInfo[1];
  159613. memcpy(pBlob, pSrc, pSrc->iSize);
  159614. pInfo->pContext = pBlob->cb.pContext;
  159615. pInfo->nParam = pBlob->nParam;
  159616. pInfo->aParam = pBlob->aParam;
  159617. pInfo->apSqlParam = pBlob->apSqlParam;
  159618. if( pBlob->cb.xGeom ){
  159619. pCons->u.xGeom = pBlob->cb.xGeom;
  159620. }else{
  159621. pCons->op = RTREE_QUERY;
  159622. pCons->u.xQueryFunc = pBlob->cb.xQueryFunc;
  159623. }
  159624. pCons->pInfo = pInfo;
  159625. return SQLITE_OK;
  159626. }
  159627. /*
  159628. ** Rtree virtual table module xFilter method.
  159629. */
  159630. static int rtreeFilter(
  159631. sqlite3_vtab_cursor *pVtabCursor,
  159632. int idxNum, const char *idxStr,
  159633. int argc, sqlite3_value **argv
  159634. ){
  159635. Rtree *pRtree = (Rtree *)pVtabCursor->pVtab;
  159636. RtreeCursor *pCsr = (RtreeCursor *)pVtabCursor;
  159637. RtreeNode *pRoot = 0;
  159638. int ii;
  159639. int rc = SQLITE_OK;
  159640. int iCell = 0;
  159641. rtreeReference(pRtree);
  159642. /* Reset the cursor to the same state as rtreeOpen() leaves it in. */
  159643. freeCursorConstraints(pCsr);
  159644. sqlite3_free(pCsr->aPoint);
  159645. memset(pCsr, 0, sizeof(RtreeCursor));
  159646. pCsr->base.pVtab = (sqlite3_vtab*)pRtree;
  159647. pCsr->iStrategy = idxNum;
  159648. if( idxNum==1 ){
  159649. /* Special case - lookup by rowid. */
  159650. RtreeNode *pLeaf; /* Leaf on which the required cell resides */
  159651. RtreeSearchPoint *p; /* Search point for the leaf */
  159652. i64 iRowid = sqlite3_value_int64(argv[0]);
  159653. i64 iNode = 0;
  159654. rc = findLeafNode(pRtree, iRowid, &pLeaf, &iNode);
  159655. if( rc==SQLITE_OK && pLeaf!=0 ){
  159656. p = rtreeSearchPointNew(pCsr, RTREE_ZERO, 0);
  159657. assert( p!=0 ); /* Always returns pCsr->sPoint */
  159658. pCsr->aNode[0] = pLeaf;
  159659. p->id = iNode;
  159660. p->eWithin = PARTLY_WITHIN;
  159661. rc = nodeRowidIndex(pRtree, pLeaf, iRowid, &iCell);
  159662. p->iCell = (u8)iCell;
  159663. RTREE_QUEUE_TRACE(pCsr, "PUSH-F1:");
  159664. }else{
  159665. pCsr->atEOF = 1;
  159666. }
  159667. }else{
  159668. /* Normal case - r-tree scan. Set up the RtreeCursor.aConstraint array
  159669. ** with the configured constraints.
  159670. */
  159671. rc = nodeAcquire(pRtree, 1, 0, &pRoot);
  159672. if( rc==SQLITE_OK && argc>0 ){
  159673. pCsr->aConstraint = sqlite3_malloc(sizeof(RtreeConstraint)*argc);
  159674. pCsr->nConstraint = argc;
  159675. if( !pCsr->aConstraint ){
  159676. rc = SQLITE_NOMEM;
  159677. }else{
  159678. memset(pCsr->aConstraint, 0, sizeof(RtreeConstraint)*argc);
  159679. memset(pCsr->anQueue, 0, sizeof(u32)*(pRtree->iDepth + 1));
  159680. assert( (idxStr==0 && argc==0)
  159681. || (idxStr && (int)strlen(idxStr)==argc*2) );
  159682. for(ii=0; ii<argc; ii++){
  159683. RtreeConstraint *p = &pCsr->aConstraint[ii];
  159684. p->op = idxStr[ii*2];
  159685. p->iCoord = idxStr[ii*2+1]-'0';
  159686. if( p->op>=RTREE_MATCH ){
  159687. /* A MATCH operator. The right-hand-side must be a blob that
  159688. ** can be cast into an RtreeMatchArg object. One created using
  159689. ** an sqlite3_rtree_geometry_callback() SQL user function.
  159690. */
  159691. rc = deserializeGeometry(argv[ii], p);
  159692. if( rc!=SQLITE_OK ){
  159693. break;
  159694. }
  159695. p->pInfo->nCoord = pRtree->nDim2;
  159696. p->pInfo->anQueue = pCsr->anQueue;
  159697. p->pInfo->mxLevel = pRtree->iDepth + 1;
  159698. }else{
  159699. #ifdef SQLITE_RTREE_INT_ONLY
  159700. p->u.rValue = sqlite3_value_int64(argv[ii]);
  159701. #else
  159702. p->u.rValue = sqlite3_value_double(argv[ii]);
  159703. #endif
  159704. }
  159705. }
  159706. }
  159707. }
  159708. if( rc==SQLITE_OK ){
  159709. RtreeSearchPoint *pNew;
  159710. pNew = rtreeSearchPointNew(pCsr, RTREE_ZERO, (u8)(pRtree->iDepth+1));
  159711. if( pNew==0 ) return SQLITE_NOMEM;
  159712. pNew->id = 1;
  159713. pNew->iCell = 0;
  159714. pNew->eWithin = PARTLY_WITHIN;
  159715. assert( pCsr->bPoint==1 );
  159716. pCsr->aNode[0] = pRoot;
  159717. pRoot = 0;
  159718. RTREE_QUEUE_TRACE(pCsr, "PUSH-Fm:");
  159719. rc = rtreeStepToLeaf(pCsr);
  159720. }
  159721. }
  159722. nodeRelease(pRtree, pRoot);
  159723. rtreeRelease(pRtree);
  159724. return rc;
  159725. }
  159726. /*
  159727. ** Rtree virtual table module xBestIndex method. There are three
  159728. ** table scan strategies to choose from (in order from most to
  159729. ** least desirable):
  159730. **
  159731. ** idxNum idxStr Strategy
  159732. ** ------------------------------------------------
  159733. ** 1 Unused Direct lookup by rowid.
  159734. ** 2 See below R-tree query or full-table scan.
  159735. ** ------------------------------------------------
  159736. **
  159737. ** If strategy 1 is used, then idxStr is not meaningful. If strategy
  159738. ** 2 is used, idxStr is formatted to contain 2 bytes for each
  159739. ** constraint used. The first two bytes of idxStr correspond to
  159740. ** the constraint in sqlite3_index_info.aConstraintUsage[] with
  159741. ** (argvIndex==1) etc.
  159742. **
  159743. ** The first of each pair of bytes in idxStr identifies the constraint
  159744. ** operator as follows:
  159745. **
  159746. ** Operator Byte Value
  159747. ** ----------------------
  159748. ** = 0x41 ('A')
  159749. ** <= 0x42 ('B')
  159750. ** < 0x43 ('C')
  159751. ** >= 0x44 ('D')
  159752. ** > 0x45 ('E')
  159753. ** MATCH 0x46 ('F')
  159754. ** ----------------------
  159755. **
  159756. ** The second of each pair of bytes identifies the coordinate column
  159757. ** to which the constraint applies. The leftmost coordinate column
  159758. ** is 'a', the second from the left 'b' etc.
  159759. */
  159760. static int rtreeBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
  159761. Rtree *pRtree = (Rtree*)tab;
  159762. int rc = SQLITE_OK;
  159763. int ii;
  159764. int bMatch = 0; /* True if there exists a MATCH constraint */
  159765. i64 nRow; /* Estimated rows returned by this scan */
  159766. int iIdx = 0;
  159767. char zIdxStr[RTREE_MAX_DIMENSIONS*8+1];
  159768. memset(zIdxStr, 0, sizeof(zIdxStr));
  159769. /* Check if there exists a MATCH constraint - even an unusable one. If there
  159770. ** is, do not consider the lookup-by-rowid plan as using such a plan would
  159771. ** require the VDBE to evaluate the MATCH constraint, which is not currently
  159772. ** possible. */
  159773. for(ii=0; ii<pIdxInfo->nConstraint; ii++){
  159774. if( pIdxInfo->aConstraint[ii].op==SQLITE_INDEX_CONSTRAINT_MATCH ){
  159775. bMatch = 1;
  159776. }
  159777. }
  159778. assert( pIdxInfo->idxStr==0 );
  159779. for(ii=0; ii<pIdxInfo->nConstraint && iIdx<(int)(sizeof(zIdxStr)-1); ii++){
  159780. struct sqlite3_index_constraint *p = &pIdxInfo->aConstraint[ii];
  159781. if( bMatch==0 && p->usable
  159782. && p->iColumn==0 && p->op==SQLITE_INDEX_CONSTRAINT_EQ
  159783. ){
  159784. /* We have an equality constraint on the rowid. Use strategy 1. */
  159785. int jj;
  159786. for(jj=0; jj<ii; jj++){
  159787. pIdxInfo->aConstraintUsage[jj].argvIndex = 0;
  159788. pIdxInfo->aConstraintUsage[jj].omit = 0;
  159789. }
  159790. pIdxInfo->idxNum = 1;
  159791. pIdxInfo->aConstraintUsage[ii].argvIndex = 1;
  159792. pIdxInfo->aConstraintUsage[jj].omit = 1;
  159793. /* This strategy involves a two rowid lookups on an B-Tree structures
  159794. ** and then a linear search of an R-Tree node. This should be
  159795. ** considered almost as quick as a direct rowid lookup (for which
  159796. ** sqlite uses an internal cost of 0.0). It is expected to return
  159797. ** a single row.
  159798. */
  159799. pIdxInfo->estimatedCost = 30.0;
  159800. pIdxInfo->estimatedRows = 1;
  159801. return SQLITE_OK;
  159802. }
  159803. if( p->usable && (p->iColumn>0 || p->op==SQLITE_INDEX_CONSTRAINT_MATCH) ){
  159804. u8 op;
  159805. switch( p->op ){
  159806. case SQLITE_INDEX_CONSTRAINT_EQ: op = RTREE_EQ; break;
  159807. case SQLITE_INDEX_CONSTRAINT_GT: op = RTREE_GT; break;
  159808. case SQLITE_INDEX_CONSTRAINT_LE: op = RTREE_LE; break;
  159809. case SQLITE_INDEX_CONSTRAINT_LT: op = RTREE_LT; break;
  159810. case SQLITE_INDEX_CONSTRAINT_GE: op = RTREE_GE; break;
  159811. default:
  159812. assert( p->op==SQLITE_INDEX_CONSTRAINT_MATCH );
  159813. op = RTREE_MATCH;
  159814. break;
  159815. }
  159816. zIdxStr[iIdx++] = op;
  159817. zIdxStr[iIdx++] = (char)(p->iColumn - 1 + '0');
  159818. pIdxInfo->aConstraintUsage[ii].argvIndex = (iIdx/2);
  159819. pIdxInfo->aConstraintUsage[ii].omit = 1;
  159820. }
  159821. }
  159822. pIdxInfo->idxNum = 2;
  159823. pIdxInfo->needToFreeIdxStr = 1;
  159824. if( iIdx>0 && 0==(pIdxInfo->idxStr = sqlite3_mprintf("%s", zIdxStr)) ){
  159825. return SQLITE_NOMEM;
  159826. }
  159827. nRow = pRtree->nRowEst >> (iIdx/2);
  159828. pIdxInfo->estimatedCost = (double)6.0 * (double)nRow;
  159829. pIdxInfo->estimatedRows = nRow;
  159830. return rc;
  159831. }
  159832. /*
  159833. ** Return the N-dimensional volumn of the cell stored in *p.
  159834. */
  159835. static RtreeDValue cellArea(Rtree *pRtree, RtreeCell *p){
  159836. RtreeDValue area = (RtreeDValue)1;
  159837. assert( pRtree->nDim>=1 && pRtree->nDim<=5 );
  159838. #ifndef SQLITE_RTREE_INT_ONLY
  159839. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  159840. switch( pRtree->nDim ){
  159841. case 5: area = p->aCoord[9].f - p->aCoord[8].f;
  159842. case 4: area *= p->aCoord[7].f - p->aCoord[6].f;
  159843. case 3: area *= p->aCoord[5].f - p->aCoord[4].f;
  159844. case 2: area *= p->aCoord[3].f - p->aCoord[2].f;
  159845. default: area *= p->aCoord[1].f - p->aCoord[0].f;
  159846. }
  159847. }else
  159848. #endif
  159849. {
  159850. switch( pRtree->nDim ){
  159851. case 5: area = p->aCoord[9].i - p->aCoord[8].i;
  159852. case 4: area *= p->aCoord[7].i - p->aCoord[6].i;
  159853. case 3: area *= p->aCoord[5].i - p->aCoord[4].i;
  159854. case 2: area *= p->aCoord[3].i - p->aCoord[2].i;
  159855. default: area *= p->aCoord[1].i - p->aCoord[0].i;
  159856. }
  159857. }
  159858. return area;
  159859. }
  159860. /*
  159861. ** Return the margin length of cell p. The margin length is the sum
  159862. ** of the objects size in each dimension.
  159863. */
  159864. static RtreeDValue cellMargin(Rtree *pRtree, RtreeCell *p){
  159865. RtreeDValue margin = 0;
  159866. int ii = pRtree->nDim2 - 2;
  159867. do{
  159868. margin += (DCOORD(p->aCoord[ii+1]) - DCOORD(p->aCoord[ii]));
  159869. ii -= 2;
  159870. }while( ii>=0 );
  159871. return margin;
  159872. }
  159873. /*
  159874. ** Store the union of cells p1 and p2 in p1.
  159875. */
  159876. static void cellUnion(Rtree *pRtree, RtreeCell *p1, RtreeCell *p2){
  159877. int ii = 0;
  159878. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  159879. do{
  159880. p1->aCoord[ii].f = MIN(p1->aCoord[ii].f, p2->aCoord[ii].f);
  159881. p1->aCoord[ii+1].f = MAX(p1->aCoord[ii+1].f, p2->aCoord[ii+1].f);
  159882. ii += 2;
  159883. }while( ii<pRtree->nDim2 );
  159884. }else{
  159885. do{
  159886. p1->aCoord[ii].i = MIN(p1->aCoord[ii].i, p2->aCoord[ii].i);
  159887. p1->aCoord[ii+1].i = MAX(p1->aCoord[ii+1].i, p2->aCoord[ii+1].i);
  159888. ii += 2;
  159889. }while( ii<pRtree->nDim2 );
  159890. }
  159891. }
  159892. /*
  159893. ** Return true if the area covered by p2 is a subset of the area covered
  159894. ** by p1. False otherwise.
  159895. */
  159896. static int cellContains(Rtree *pRtree, RtreeCell *p1, RtreeCell *p2){
  159897. int ii;
  159898. int isInt = (pRtree->eCoordType==RTREE_COORD_INT32);
  159899. for(ii=0; ii<pRtree->nDim2; ii+=2){
  159900. RtreeCoord *a1 = &p1->aCoord[ii];
  159901. RtreeCoord *a2 = &p2->aCoord[ii];
  159902. if( (!isInt && (a2[0].f<a1[0].f || a2[1].f>a1[1].f))
  159903. || ( isInt && (a2[0].i<a1[0].i || a2[1].i>a1[1].i))
  159904. ){
  159905. return 0;
  159906. }
  159907. }
  159908. return 1;
  159909. }
  159910. /*
  159911. ** Return the amount cell p would grow by if it were unioned with pCell.
  159912. */
  159913. static RtreeDValue cellGrowth(Rtree *pRtree, RtreeCell *p, RtreeCell *pCell){
  159914. RtreeDValue area;
  159915. RtreeCell cell;
  159916. memcpy(&cell, p, sizeof(RtreeCell));
  159917. area = cellArea(pRtree, &cell);
  159918. cellUnion(pRtree, &cell, pCell);
  159919. return (cellArea(pRtree, &cell)-area);
  159920. }
  159921. static RtreeDValue cellOverlap(
  159922. Rtree *pRtree,
  159923. RtreeCell *p,
  159924. RtreeCell *aCell,
  159925. int nCell
  159926. ){
  159927. int ii;
  159928. RtreeDValue overlap = RTREE_ZERO;
  159929. for(ii=0; ii<nCell; ii++){
  159930. int jj;
  159931. RtreeDValue o = (RtreeDValue)1;
  159932. for(jj=0; jj<pRtree->nDim2; jj+=2){
  159933. RtreeDValue x1, x2;
  159934. x1 = MAX(DCOORD(p->aCoord[jj]), DCOORD(aCell[ii].aCoord[jj]));
  159935. x2 = MIN(DCOORD(p->aCoord[jj+1]), DCOORD(aCell[ii].aCoord[jj+1]));
  159936. if( x2<x1 ){
  159937. o = (RtreeDValue)0;
  159938. break;
  159939. }else{
  159940. o = o * (x2-x1);
  159941. }
  159942. }
  159943. overlap += o;
  159944. }
  159945. return overlap;
  159946. }
  159947. /*
  159948. ** This function implements the ChooseLeaf algorithm from Gutman[84].
  159949. ** ChooseSubTree in r*tree terminology.
  159950. */
  159951. static int ChooseLeaf(
  159952. Rtree *pRtree, /* Rtree table */
  159953. RtreeCell *pCell, /* Cell to insert into rtree */
  159954. int iHeight, /* Height of sub-tree rooted at pCell */
  159955. RtreeNode **ppLeaf /* OUT: Selected leaf page */
  159956. ){
  159957. int rc;
  159958. int ii;
  159959. RtreeNode *pNode = 0;
  159960. rc = nodeAcquire(pRtree, 1, 0, &pNode);
  159961. for(ii=0; rc==SQLITE_OK && ii<(pRtree->iDepth-iHeight); ii++){
  159962. int iCell;
  159963. sqlite3_int64 iBest = 0;
  159964. RtreeDValue fMinGrowth = RTREE_ZERO;
  159965. RtreeDValue fMinArea = RTREE_ZERO;
  159966. int nCell = NCELL(pNode);
  159967. RtreeCell cell;
  159968. RtreeNode *pChild;
  159969. RtreeCell *aCell = 0;
  159970. /* Select the child node which will be enlarged the least if pCell
  159971. ** is inserted into it. Resolve ties by choosing the entry with
  159972. ** the smallest area.
  159973. */
  159974. for(iCell=0; iCell<nCell; iCell++){
  159975. int bBest = 0;
  159976. RtreeDValue growth;
  159977. RtreeDValue area;
  159978. nodeGetCell(pRtree, pNode, iCell, &cell);
  159979. growth = cellGrowth(pRtree, &cell, pCell);
  159980. area = cellArea(pRtree, &cell);
  159981. if( iCell==0||growth<fMinGrowth||(growth==fMinGrowth && area<fMinArea) ){
  159982. bBest = 1;
  159983. }
  159984. if( bBest ){
  159985. fMinGrowth = growth;
  159986. fMinArea = area;
  159987. iBest = cell.iRowid;
  159988. }
  159989. }
  159990. sqlite3_free(aCell);
  159991. rc = nodeAcquire(pRtree, iBest, pNode, &pChild);
  159992. nodeRelease(pRtree, pNode);
  159993. pNode = pChild;
  159994. }
  159995. *ppLeaf = pNode;
  159996. return rc;
  159997. }
  159998. /*
  159999. ** A cell with the same content as pCell has just been inserted into
  160000. ** the node pNode. This function updates the bounding box cells in
  160001. ** all ancestor elements.
  160002. */
  160003. static int AdjustTree(
  160004. Rtree *pRtree, /* Rtree table */
  160005. RtreeNode *pNode, /* Adjust ancestry of this node. */
  160006. RtreeCell *pCell /* This cell was just inserted */
  160007. ){
  160008. RtreeNode *p = pNode;
  160009. while( p->pParent ){
  160010. RtreeNode *pParent = p->pParent;
  160011. RtreeCell cell;
  160012. int iCell;
  160013. if( nodeParentIndex(pRtree, p, &iCell) ){
  160014. return SQLITE_CORRUPT_VTAB;
  160015. }
  160016. nodeGetCell(pRtree, pParent, iCell, &cell);
  160017. if( !cellContains(pRtree, &cell, pCell) ){
  160018. cellUnion(pRtree, &cell, pCell);
  160019. nodeOverwriteCell(pRtree, pParent, &cell, iCell);
  160020. }
  160021. p = pParent;
  160022. }
  160023. return SQLITE_OK;
  160024. }
  160025. /*
  160026. ** Write mapping (iRowid->iNode) to the <rtree>_rowid table.
  160027. */
  160028. static int rowidWrite(Rtree *pRtree, sqlite3_int64 iRowid, sqlite3_int64 iNode){
  160029. sqlite3_bind_int64(pRtree->pWriteRowid, 1, iRowid);
  160030. sqlite3_bind_int64(pRtree->pWriteRowid, 2, iNode);
  160031. sqlite3_step(pRtree->pWriteRowid);
  160032. return sqlite3_reset(pRtree->pWriteRowid);
  160033. }
  160034. /*
  160035. ** Write mapping (iNode->iPar) to the <rtree>_parent table.
  160036. */
  160037. static int parentWrite(Rtree *pRtree, sqlite3_int64 iNode, sqlite3_int64 iPar){
  160038. sqlite3_bind_int64(pRtree->pWriteParent, 1, iNode);
  160039. sqlite3_bind_int64(pRtree->pWriteParent, 2, iPar);
  160040. sqlite3_step(pRtree->pWriteParent);
  160041. return sqlite3_reset(pRtree->pWriteParent);
  160042. }
  160043. static int rtreeInsertCell(Rtree *, RtreeNode *, RtreeCell *, int);
  160044. /*
  160045. ** Arguments aIdx, aDistance and aSpare all point to arrays of size
  160046. ** nIdx. The aIdx array contains the set of integers from 0 to
  160047. ** (nIdx-1) in no particular order. This function sorts the values
  160048. ** in aIdx according to the indexed values in aDistance. For
  160049. ** example, assuming the inputs:
  160050. **
  160051. ** aIdx = { 0, 1, 2, 3 }
  160052. ** aDistance = { 5.0, 2.0, 7.0, 6.0 }
  160053. **
  160054. ** this function sets the aIdx array to contain:
  160055. **
  160056. ** aIdx = { 0, 1, 2, 3 }
  160057. **
  160058. ** The aSpare array is used as temporary working space by the
  160059. ** sorting algorithm.
  160060. */
  160061. static void SortByDistance(
  160062. int *aIdx,
  160063. int nIdx,
  160064. RtreeDValue *aDistance,
  160065. int *aSpare
  160066. ){
  160067. if( nIdx>1 ){
  160068. int iLeft = 0;
  160069. int iRight = 0;
  160070. int nLeft = nIdx/2;
  160071. int nRight = nIdx-nLeft;
  160072. int *aLeft = aIdx;
  160073. int *aRight = &aIdx[nLeft];
  160074. SortByDistance(aLeft, nLeft, aDistance, aSpare);
  160075. SortByDistance(aRight, nRight, aDistance, aSpare);
  160076. memcpy(aSpare, aLeft, sizeof(int)*nLeft);
  160077. aLeft = aSpare;
  160078. while( iLeft<nLeft || iRight<nRight ){
  160079. if( iLeft==nLeft ){
  160080. aIdx[iLeft+iRight] = aRight[iRight];
  160081. iRight++;
  160082. }else if( iRight==nRight ){
  160083. aIdx[iLeft+iRight] = aLeft[iLeft];
  160084. iLeft++;
  160085. }else{
  160086. RtreeDValue fLeft = aDistance[aLeft[iLeft]];
  160087. RtreeDValue fRight = aDistance[aRight[iRight]];
  160088. if( fLeft<fRight ){
  160089. aIdx[iLeft+iRight] = aLeft[iLeft];
  160090. iLeft++;
  160091. }else{
  160092. aIdx[iLeft+iRight] = aRight[iRight];
  160093. iRight++;
  160094. }
  160095. }
  160096. }
  160097. #if 0
  160098. /* Check that the sort worked */
  160099. {
  160100. int jj;
  160101. for(jj=1; jj<nIdx; jj++){
  160102. RtreeDValue left = aDistance[aIdx[jj-1]];
  160103. RtreeDValue right = aDistance[aIdx[jj]];
  160104. assert( left<=right );
  160105. }
  160106. }
  160107. #endif
  160108. }
  160109. }
  160110. /*
  160111. ** Arguments aIdx, aCell and aSpare all point to arrays of size
  160112. ** nIdx. The aIdx array contains the set of integers from 0 to
  160113. ** (nIdx-1) in no particular order. This function sorts the values
  160114. ** in aIdx according to dimension iDim of the cells in aCell. The
  160115. ** minimum value of dimension iDim is considered first, the
  160116. ** maximum used to break ties.
  160117. **
  160118. ** The aSpare array is used as temporary working space by the
  160119. ** sorting algorithm.
  160120. */
  160121. static void SortByDimension(
  160122. Rtree *pRtree,
  160123. int *aIdx,
  160124. int nIdx,
  160125. int iDim,
  160126. RtreeCell *aCell,
  160127. int *aSpare
  160128. ){
  160129. if( nIdx>1 ){
  160130. int iLeft = 0;
  160131. int iRight = 0;
  160132. int nLeft = nIdx/2;
  160133. int nRight = nIdx-nLeft;
  160134. int *aLeft = aIdx;
  160135. int *aRight = &aIdx[nLeft];
  160136. SortByDimension(pRtree, aLeft, nLeft, iDim, aCell, aSpare);
  160137. SortByDimension(pRtree, aRight, nRight, iDim, aCell, aSpare);
  160138. memcpy(aSpare, aLeft, sizeof(int)*nLeft);
  160139. aLeft = aSpare;
  160140. while( iLeft<nLeft || iRight<nRight ){
  160141. RtreeDValue xleft1 = DCOORD(aCell[aLeft[iLeft]].aCoord[iDim*2]);
  160142. RtreeDValue xleft2 = DCOORD(aCell[aLeft[iLeft]].aCoord[iDim*2+1]);
  160143. RtreeDValue xright1 = DCOORD(aCell[aRight[iRight]].aCoord[iDim*2]);
  160144. RtreeDValue xright2 = DCOORD(aCell[aRight[iRight]].aCoord[iDim*2+1]);
  160145. if( (iLeft!=nLeft) && ((iRight==nRight)
  160146. || (xleft1<xright1)
  160147. || (xleft1==xright1 && xleft2<xright2)
  160148. )){
  160149. aIdx[iLeft+iRight] = aLeft[iLeft];
  160150. iLeft++;
  160151. }else{
  160152. aIdx[iLeft+iRight] = aRight[iRight];
  160153. iRight++;
  160154. }
  160155. }
  160156. #if 0
  160157. /* Check that the sort worked */
  160158. {
  160159. int jj;
  160160. for(jj=1; jj<nIdx; jj++){
  160161. RtreeDValue xleft1 = aCell[aIdx[jj-1]].aCoord[iDim*2];
  160162. RtreeDValue xleft2 = aCell[aIdx[jj-1]].aCoord[iDim*2+1];
  160163. RtreeDValue xright1 = aCell[aIdx[jj]].aCoord[iDim*2];
  160164. RtreeDValue xright2 = aCell[aIdx[jj]].aCoord[iDim*2+1];
  160165. assert( xleft1<=xright1 && (xleft1<xright1 || xleft2<=xright2) );
  160166. }
  160167. }
  160168. #endif
  160169. }
  160170. }
  160171. /*
  160172. ** Implementation of the R*-tree variant of SplitNode from Beckman[1990].
  160173. */
  160174. static int splitNodeStartree(
  160175. Rtree *pRtree,
  160176. RtreeCell *aCell,
  160177. int nCell,
  160178. RtreeNode *pLeft,
  160179. RtreeNode *pRight,
  160180. RtreeCell *pBboxLeft,
  160181. RtreeCell *pBboxRight
  160182. ){
  160183. int **aaSorted;
  160184. int *aSpare;
  160185. int ii;
  160186. int iBestDim = 0;
  160187. int iBestSplit = 0;
  160188. RtreeDValue fBestMargin = RTREE_ZERO;
  160189. int nByte = (pRtree->nDim+1)*(sizeof(int*)+nCell*sizeof(int));
  160190. aaSorted = (int **)sqlite3_malloc(nByte);
  160191. if( !aaSorted ){
  160192. return SQLITE_NOMEM;
  160193. }
  160194. aSpare = &((int *)&aaSorted[pRtree->nDim])[pRtree->nDim*nCell];
  160195. memset(aaSorted, 0, nByte);
  160196. for(ii=0; ii<pRtree->nDim; ii++){
  160197. int jj;
  160198. aaSorted[ii] = &((int *)&aaSorted[pRtree->nDim])[ii*nCell];
  160199. for(jj=0; jj<nCell; jj++){
  160200. aaSorted[ii][jj] = jj;
  160201. }
  160202. SortByDimension(pRtree, aaSorted[ii], nCell, ii, aCell, aSpare);
  160203. }
  160204. for(ii=0; ii<pRtree->nDim; ii++){
  160205. RtreeDValue margin = RTREE_ZERO;
  160206. RtreeDValue fBestOverlap = RTREE_ZERO;
  160207. RtreeDValue fBestArea = RTREE_ZERO;
  160208. int iBestLeft = 0;
  160209. int nLeft;
  160210. for(
  160211. nLeft=RTREE_MINCELLS(pRtree);
  160212. nLeft<=(nCell-RTREE_MINCELLS(pRtree));
  160213. nLeft++
  160214. ){
  160215. RtreeCell left;
  160216. RtreeCell right;
  160217. int kk;
  160218. RtreeDValue overlap;
  160219. RtreeDValue area;
  160220. memcpy(&left, &aCell[aaSorted[ii][0]], sizeof(RtreeCell));
  160221. memcpy(&right, &aCell[aaSorted[ii][nCell-1]], sizeof(RtreeCell));
  160222. for(kk=1; kk<(nCell-1); kk++){
  160223. if( kk<nLeft ){
  160224. cellUnion(pRtree, &left, &aCell[aaSorted[ii][kk]]);
  160225. }else{
  160226. cellUnion(pRtree, &right, &aCell[aaSorted[ii][kk]]);
  160227. }
  160228. }
  160229. margin += cellMargin(pRtree, &left);
  160230. margin += cellMargin(pRtree, &right);
  160231. overlap = cellOverlap(pRtree, &left, &right, 1);
  160232. area = cellArea(pRtree, &left) + cellArea(pRtree, &right);
  160233. if( (nLeft==RTREE_MINCELLS(pRtree))
  160234. || (overlap<fBestOverlap)
  160235. || (overlap==fBestOverlap && area<fBestArea)
  160236. ){
  160237. iBestLeft = nLeft;
  160238. fBestOverlap = overlap;
  160239. fBestArea = area;
  160240. }
  160241. }
  160242. if( ii==0 || margin<fBestMargin ){
  160243. iBestDim = ii;
  160244. fBestMargin = margin;
  160245. iBestSplit = iBestLeft;
  160246. }
  160247. }
  160248. memcpy(pBboxLeft, &aCell[aaSorted[iBestDim][0]], sizeof(RtreeCell));
  160249. memcpy(pBboxRight, &aCell[aaSorted[iBestDim][iBestSplit]], sizeof(RtreeCell));
  160250. for(ii=0; ii<nCell; ii++){
  160251. RtreeNode *pTarget = (ii<iBestSplit)?pLeft:pRight;
  160252. RtreeCell *pBbox = (ii<iBestSplit)?pBboxLeft:pBboxRight;
  160253. RtreeCell *pCell = &aCell[aaSorted[iBestDim][ii]];
  160254. nodeInsertCell(pRtree, pTarget, pCell);
  160255. cellUnion(pRtree, pBbox, pCell);
  160256. }
  160257. sqlite3_free(aaSorted);
  160258. return SQLITE_OK;
  160259. }
  160260. static int updateMapping(
  160261. Rtree *pRtree,
  160262. i64 iRowid,
  160263. RtreeNode *pNode,
  160264. int iHeight
  160265. ){
  160266. int (*xSetMapping)(Rtree *, sqlite3_int64, sqlite3_int64);
  160267. xSetMapping = ((iHeight==0)?rowidWrite:parentWrite);
  160268. if( iHeight>0 ){
  160269. RtreeNode *pChild = nodeHashLookup(pRtree, iRowid);
  160270. if( pChild ){
  160271. nodeRelease(pRtree, pChild->pParent);
  160272. nodeReference(pNode);
  160273. pChild->pParent = pNode;
  160274. }
  160275. }
  160276. return xSetMapping(pRtree, iRowid, pNode->iNode);
  160277. }
  160278. static int SplitNode(
  160279. Rtree *pRtree,
  160280. RtreeNode *pNode,
  160281. RtreeCell *pCell,
  160282. int iHeight
  160283. ){
  160284. int i;
  160285. int newCellIsRight = 0;
  160286. int rc = SQLITE_OK;
  160287. int nCell = NCELL(pNode);
  160288. RtreeCell *aCell;
  160289. int *aiUsed;
  160290. RtreeNode *pLeft = 0;
  160291. RtreeNode *pRight = 0;
  160292. RtreeCell leftbbox;
  160293. RtreeCell rightbbox;
  160294. /* Allocate an array and populate it with a copy of pCell and
  160295. ** all cells from node pLeft. Then zero the original node.
  160296. */
  160297. aCell = sqlite3_malloc((sizeof(RtreeCell)+sizeof(int))*(nCell+1));
  160298. if( !aCell ){
  160299. rc = SQLITE_NOMEM;
  160300. goto splitnode_out;
  160301. }
  160302. aiUsed = (int *)&aCell[nCell+1];
  160303. memset(aiUsed, 0, sizeof(int)*(nCell+1));
  160304. for(i=0; i<nCell; i++){
  160305. nodeGetCell(pRtree, pNode, i, &aCell[i]);
  160306. }
  160307. nodeZero(pRtree, pNode);
  160308. memcpy(&aCell[nCell], pCell, sizeof(RtreeCell));
  160309. nCell++;
  160310. if( pNode->iNode==1 ){
  160311. pRight = nodeNew(pRtree, pNode);
  160312. pLeft = nodeNew(pRtree, pNode);
  160313. pRtree->iDepth++;
  160314. pNode->isDirty = 1;
  160315. writeInt16(pNode->zData, pRtree->iDepth);
  160316. }else{
  160317. pLeft = pNode;
  160318. pRight = nodeNew(pRtree, pLeft->pParent);
  160319. nodeReference(pLeft);
  160320. }
  160321. if( !pLeft || !pRight ){
  160322. rc = SQLITE_NOMEM;
  160323. goto splitnode_out;
  160324. }
  160325. memset(pLeft->zData, 0, pRtree->iNodeSize);
  160326. memset(pRight->zData, 0, pRtree->iNodeSize);
  160327. rc = splitNodeStartree(pRtree, aCell, nCell, pLeft, pRight,
  160328. &leftbbox, &rightbbox);
  160329. if( rc!=SQLITE_OK ){
  160330. goto splitnode_out;
  160331. }
  160332. /* Ensure both child nodes have node numbers assigned to them by calling
  160333. ** nodeWrite(). Node pRight always needs a node number, as it was created
  160334. ** by nodeNew() above. But node pLeft sometimes already has a node number.
  160335. ** In this case avoid the all to nodeWrite().
  160336. */
  160337. if( SQLITE_OK!=(rc = nodeWrite(pRtree, pRight))
  160338. || (0==pLeft->iNode && SQLITE_OK!=(rc = nodeWrite(pRtree, pLeft)))
  160339. ){
  160340. goto splitnode_out;
  160341. }
  160342. rightbbox.iRowid = pRight->iNode;
  160343. leftbbox.iRowid = pLeft->iNode;
  160344. if( pNode->iNode==1 ){
  160345. rc = rtreeInsertCell(pRtree, pLeft->pParent, &leftbbox, iHeight+1);
  160346. if( rc!=SQLITE_OK ){
  160347. goto splitnode_out;
  160348. }
  160349. }else{
  160350. RtreeNode *pParent = pLeft->pParent;
  160351. int iCell;
  160352. rc = nodeParentIndex(pRtree, pLeft, &iCell);
  160353. if( rc==SQLITE_OK ){
  160354. nodeOverwriteCell(pRtree, pParent, &leftbbox, iCell);
  160355. rc = AdjustTree(pRtree, pParent, &leftbbox);
  160356. }
  160357. if( rc!=SQLITE_OK ){
  160358. goto splitnode_out;
  160359. }
  160360. }
  160361. if( (rc = rtreeInsertCell(pRtree, pRight->pParent, &rightbbox, iHeight+1)) ){
  160362. goto splitnode_out;
  160363. }
  160364. for(i=0; i<NCELL(pRight); i++){
  160365. i64 iRowid = nodeGetRowid(pRtree, pRight, i);
  160366. rc = updateMapping(pRtree, iRowid, pRight, iHeight);
  160367. if( iRowid==pCell->iRowid ){
  160368. newCellIsRight = 1;
  160369. }
  160370. if( rc!=SQLITE_OK ){
  160371. goto splitnode_out;
  160372. }
  160373. }
  160374. if( pNode->iNode==1 ){
  160375. for(i=0; i<NCELL(pLeft); i++){
  160376. i64 iRowid = nodeGetRowid(pRtree, pLeft, i);
  160377. rc = updateMapping(pRtree, iRowid, pLeft, iHeight);
  160378. if( rc!=SQLITE_OK ){
  160379. goto splitnode_out;
  160380. }
  160381. }
  160382. }else if( newCellIsRight==0 ){
  160383. rc = updateMapping(pRtree, pCell->iRowid, pLeft, iHeight);
  160384. }
  160385. if( rc==SQLITE_OK ){
  160386. rc = nodeRelease(pRtree, pRight);
  160387. pRight = 0;
  160388. }
  160389. if( rc==SQLITE_OK ){
  160390. rc = nodeRelease(pRtree, pLeft);
  160391. pLeft = 0;
  160392. }
  160393. splitnode_out:
  160394. nodeRelease(pRtree, pRight);
  160395. nodeRelease(pRtree, pLeft);
  160396. sqlite3_free(aCell);
  160397. return rc;
  160398. }
  160399. /*
  160400. ** If node pLeaf is not the root of the r-tree and its pParent pointer is
  160401. ** still NULL, load all ancestor nodes of pLeaf into memory and populate
  160402. ** the pLeaf->pParent chain all the way up to the root node.
  160403. **
  160404. ** This operation is required when a row is deleted (or updated - an update
  160405. ** is implemented as a delete followed by an insert). SQLite provides the
  160406. ** rowid of the row to delete, which can be used to find the leaf on which
  160407. ** the entry resides (argument pLeaf). Once the leaf is located, this
  160408. ** function is called to determine its ancestry.
  160409. */
  160410. static int fixLeafParent(Rtree *pRtree, RtreeNode *pLeaf){
  160411. int rc = SQLITE_OK;
  160412. RtreeNode *pChild = pLeaf;
  160413. while( rc==SQLITE_OK && pChild->iNode!=1 && pChild->pParent==0 ){
  160414. int rc2 = SQLITE_OK; /* sqlite3_reset() return code */
  160415. sqlite3_bind_int64(pRtree->pReadParent, 1, pChild->iNode);
  160416. rc = sqlite3_step(pRtree->pReadParent);
  160417. if( rc==SQLITE_ROW ){
  160418. RtreeNode *pTest; /* Used to test for reference loops */
  160419. i64 iNode; /* Node number of parent node */
  160420. /* Before setting pChild->pParent, test that we are not creating a
  160421. ** loop of references (as we would if, say, pChild==pParent). We don't
  160422. ** want to do this as it leads to a memory leak when trying to delete
  160423. ** the referenced counted node structures.
  160424. */
  160425. iNode = sqlite3_column_int64(pRtree->pReadParent, 0);
  160426. for(pTest=pLeaf; pTest && pTest->iNode!=iNode; pTest=pTest->pParent);
  160427. if( !pTest ){
  160428. rc2 = nodeAcquire(pRtree, iNode, 0, &pChild->pParent);
  160429. }
  160430. }
  160431. rc = sqlite3_reset(pRtree->pReadParent);
  160432. if( rc==SQLITE_OK ) rc = rc2;
  160433. if( rc==SQLITE_OK && !pChild->pParent ) rc = SQLITE_CORRUPT_VTAB;
  160434. pChild = pChild->pParent;
  160435. }
  160436. return rc;
  160437. }
  160438. static int deleteCell(Rtree *, RtreeNode *, int, int);
  160439. static int removeNode(Rtree *pRtree, RtreeNode *pNode, int iHeight){
  160440. int rc;
  160441. int rc2;
  160442. RtreeNode *pParent = 0;
  160443. int iCell;
  160444. assert( pNode->nRef==1 );
  160445. /* Remove the entry in the parent cell. */
  160446. rc = nodeParentIndex(pRtree, pNode, &iCell);
  160447. if( rc==SQLITE_OK ){
  160448. pParent = pNode->pParent;
  160449. pNode->pParent = 0;
  160450. rc = deleteCell(pRtree, pParent, iCell, iHeight+1);
  160451. }
  160452. rc2 = nodeRelease(pRtree, pParent);
  160453. if( rc==SQLITE_OK ){
  160454. rc = rc2;
  160455. }
  160456. if( rc!=SQLITE_OK ){
  160457. return rc;
  160458. }
  160459. /* Remove the xxx_node entry. */
  160460. sqlite3_bind_int64(pRtree->pDeleteNode, 1, pNode->iNode);
  160461. sqlite3_step(pRtree->pDeleteNode);
  160462. if( SQLITE_OK!=(rc = sqlite3_reset(pRtree->pDeleteNode)) ){
  160463. return rc;
  160464. }
  160465. /* Remove the xxx_parent entry. */
  160466. sqlite3_bind_int64(pRtree->pDeleteParent, 1, pNode->iNode);
  160467. sqlite3_step(pRtree->pDeleteParent);
  160468. if( SQLITE_OK!=(rc = sqlite3_reset(pRtree->pDeleteParent)) ){
  160469. return rc;
  160470. }
  160471. /* Remove the node from the in-memory hash table and link it into
  160472. ** the Rtree.pDeleted list. Its contents will be re-inserted later on.
  160473. */
  160474. nodeHashDelete(pRtree, pNode);
  160475. pNode->iNode = iHeight;
  160476. pNode->pNext = pRtree->pDeleted;
  160477. pNode->nRef++;
  160478. pRtree->pDeleted = pNode;
  160479. return SQLITE_OK;
  160480. }
  160481. static int fixBoundingBox(Rtree *pRtree, RtreeNode *pNode){
  160482. RtreeNode *pParent = pNode->pParent;
  160483. int rc = SQLITE_OK;
  160484. if( pParent ){
  160485. int ii;
  160486. int nCell = NCELL(pNode);
  160487. RtreeCell box; /* Bounding box for pNode */
  160488. nodeGetCell(pRtree, pNode, 0, &box);
  160489. for(ii=1; ii<nCell; ii++){
  160490. RtreeCell cell;
  160491. nodeGetCell(pRtree, pNode, ii, &cell);
  160492. cellUnion(pRtree, &box, &cell);
  160493. }
  160494. box.iRowid = pNode->iNode;
  160495. rc = nodeParentIndex(pRtree, pNode, &ii);
  160496. if( rc==SQLITE_OK ){
  160497. nodeOverwriteCell(pRtree, pParent, &box, ii);
  160498. rc = fixBoundingBox(pRtree, pParent);
  160499. }
  160500. }
  160501. return rc;
  160502. }
  160503. /*
  160504. ** Delete the cell at index iCell of node pNode. After removing the
  160505. ** cell, adjust the r-tree data structure if required.
  160506. */
  160507. static int deleteCell(Rtree *pRtree, RtreeNode *pNode, int iCell, int iHeight){
  160508. RtreeNode *pParent;
  160509. int rc;
  160510. if( SQLITE_OK!=(rc = fixLeafParent(pRtree, pNode)) ){
  160511. return rc;
  160512. }
  160513. /* Remove the cell from the node. This call just moves bytes around
  160514. ** the in-memory node image, so it cannot fail.
  160515. */
  160516. nodeDeleteCell(pRtree, pNode, iCell);
  160517. /* If the node is not the tree root and now has less than the minimum
  160518. ** number of cells, remove it from the tree. Otherwise, update the
  160519. ** cell in the parent node so that it tightly contains the updated
  160520. ** node.
  160521. */
  160522. pParent = pNode->pParent;
  160523. assert( pParent || pNode->iNode==1 );
  160524. if( pParent ){
  160525. if( NCELL(pNode)<RTREE_MINCELLS(pRtree) ){
  160526. rc = removeNode(pRtree, pNode, iHeight);
  160527. }else{
  160528. rc = fixBoundingBox(pRtree, pNode);
  160529. }
  160530. }
  160531. return rc;
  160532. }
  160533. static int Reinsert(
  160534. Rtree *pRtree,
  160535. RtreeNode *pNode,
  160536. RtreeCell *pCell,
  160537. int iHeight
  160538. ){
  160539. int *aOrder;
  160540. int *aSpare;
  160541. RtreeCell *aCell;
  160542. RtreeDValue *aDistance;
  160543. int nCell;
  160544. RtreeDValue aCenterCoord[RTREE_MAX_DIMENSIONS];
  160545. int iDim;
  160546. int ii;
  160547. int rc = SQLITE_OK;
  160548. int n;
  160549. memset(aCenterCoord, 0, sizeof(RtreeDValue)*RTREE_MAX_DIMENSIONS);
  160550. nCell = NCELL(pNode)+1;
  160551. n = (nCell+1)&(~1);
  160552. /* Allocate the buffers used by this operation. The allocation is
  160553. ** relinquished before this function returns.
  160554. */
  160555. aCell = (RtreeCell *)sqlite3_malloc(n * (
  160556. sizeof(RtreeCell) + /* aCell array */
  160557. sizeof(int) + /* aOrder array */
  160558. sizeof(int) + /* aSpare array */
  160559. sizeof(RtreeDValue) /* aDistance array */
  160560. ));
  160561. if( !aCell ){
  160562. return SQLITE_NOMEM;
  160563. }
  160564. aOrder = (int *)&aCell[n];
  160565. aSpare = (int *)&aOrder[n];
  160566. aDistance = (RtreeDValue *)&aSpare[n];
  160567. for(ii=0; ii<nCell; ii++){
  160568. if( ii==(nCell-1) ){
  160569. memcpy(&aCell[ii], pCell, sizeof(RtreeCell));
  160570. }else{
  160571. nodeGetCell(pRtree, pNode, ii, &aCell[ii]);
  160572. }
  160573. aOrder[ii] = ii;
  160574. for(iDim=0; iDim<pRtree->nDim; iDim++){
  160575. aCenterCoord[iDim] += DCOORD(aCell[ii].aCoord[iDim*2]);
  160576. aCenterCoord[iDim] += DCOORD(aCell[ii].aCoord[iDim*2+1]);
  160577. }
  160578. }
  160579. for(iDim=0; iDim<pRtree->nDim; iDim++){
  160580. aCenterCoord[iDim] = (aCenterCoord[iDim]/(nCell*(RtreeDValue)2));
  160581. }
  160582. for(ii=0; ii<nCell; ii++){
  160583. aDistance[ii] = RTREE_ZERO;
  160584. for(iDim=0; iDim<pRtree->nDim; iDim++){
  160585. RtreeDValue coord = (DCOORD(aCell[ii].aCoord[iDim*2+1]) -
  160586. DCOORD(aCell[ii].aCoord[iDim*2]));
  160587. aDistance[ii] += (coord-aCenterCoord[iDim])*(coord-aCenterCoord[iDim]);
  160588. }
  160589. }
  160590. SortByDistance(aOrder, nCell, aDistance, aSpare);
  160591. nodeZero(pRtree, pNode);
  160592. for(ii=0; rc==SQLITE_OK && ii<(nCell-(RTREE_MINCELLS(pRtree)+1)); ii++){
  160593. RtreeCell *p = &aCell[aOrder[ii]];
  160594. nodeInsertCell(pRtree, pNode, p);
  160595. if( p->iRowid==pCell->iRowid ){
  160596. if( iHeight==0 ){
  160597. rc = rowidWrite(pRtree, p->iRowid, pNode->iNode);
  160598. }else{
  160599. rc = parentWrite(pRtree, p->iRowid, pNode->iNode);
  160600. }
  160601. }
  160602. }
  160603. if( rc==SQLITE_OK ){
  160604. rc = fixBoundingBox(pRtree, pNode);
  160605. }
  160606. for(; rc==SQLITE_OK && ii<nCell; ii++){
  160607. /* Find a node to store this cell in. pNode->iNode currently contains
  160608. ** the height of the sub-tree headed by the cell.
  160609. */
  160610. RtreeNode *pInsert;
  160611. RtreeCell *p = &aCell[aOrder[ii]];
  160612. rc = ChooseLeaf(pRtree, p, iHeight, &pInsert);
  160613. if( rc==SQLITE_OK ){
  160614. int rc2;
  160615. rc = rtreeInsertCell(pRtree, pInsert, p, iHeight);
  160616. rc2 = nodeRelease(pRtree, pInsert);
  160617. if( rc==SQLITE_OK ){
  160618. rc = rc2;
  160619. }
  160620. }
  160621. }
  160622. sqlite3_free(aCell);
  160623. return rc;
  160624. }
  160625. /*
  160626. ** Insert cell pCell into node pNode. Node pNode is the head of a
  160627. ** subtree iHeight high (leaf nodes have iHeight==0).
  160628. */
  160629. static int rtreeInsertCell(
  160630. Rtree *pRtree,
  160631. RtreeNode *pNode,
  160632. RtreeCell *pCell,
  160633. int iHeight
  160634. ){
  160635. int rc = SQLITE_OK;
  160636. if( iHeight>0 ){
  160637. RtreeNode *pChild = nodeHashLookup(pRtree, pCell->iRowid);
  160638. if( pChild ){
  160639. nodeRelease(pRtree, pChild->pParent);
  160640. nodeReference(pNode);
  160641. pChild->pParent = pNode;
  160642. }
  160643. }
  160644. if( nodeInsertCell(pRtree, pNode, pCell) ){
  160645. if( iHeight<=pRtree->iReinsertHeight || pNode->iNode==1){
  160646. rc = SplitNode(pRtree, pNode, pCell, iHeight);
  160647. }else{
  160648. pRtree->iReinsertHeight = iHeight;
  160649. rc = Reinsert(pRtree, pNode, pCell, iHeight);
  160650. }
  160651. }else{
  160652. rc = AdjustTree(pRtree, pNode, pCell);
  160653. if( rc==SQLITE_OK ){
  160654. if( iHeight==0 ){
  160655. rc = rowidWrite(pRtree, pCell->iRowid, pNode->iNode);
  160656. }else{
  160657. rc = parentWrite(pRtree, pCell->iRowid, pNode->iNode);
  160658. }
  160659. }
  160660. }
  160661. return rc;
  160662. }
  160663. static int reinsertNodeContent(Rtree *pRtree, RtreeNode *pNode){
  160664. int ii;
  160665. int rc = SQLITE_OK;
  160666. int nCell = NCELL(pNode);
  160667. for(ii=0; rc==SQLITE_OK && ii<nCell; ii++){
  160668. RtreeNode *pInsert;
  160669. RtreeCell cell;
  160670. nodeGetCell(pRtree, pNode, ii, &cell);
  160671. /* Find a node to store this cell in. pNode->iNode currently contains
  160672. ** the height of the sub-tree headed by the cell.
  160673. */
  160674. rc = ChooseLeaf(pRtree, &cell, (int)pNode->iNode, &pInsert);
  160675. if( rc==SQLITE_OK ){
  160676. int rc2;
  160677. rc = rtreeInsertCell(pRtree, pInsert, &cell, (int)pNode->iNode);
  160678. rc2 = nodeRelease(pRtree, pInsert);
  160679. if( rc==SQLITE_OK ){
  160680. rc = rc2;
  160681. }
  160682. }
  160683. }
  160684. return rc;
  160685. }
  160686. /*
  160687. ** Select a currently unused rowid for a new r-tree record.
  160688. */
  160689. static int newRowid(Rtree *pRtree, i64 *piRowid){
  160690. int rc;
  160691. sqlite3_bind_null(pRtree->pWriteRowid, 1);
  160692. sqlite3_bind_null(pRtree->pWriteRowid, 2);
  160693. sqlite3_step(pRtree->pWriteRowid);
  160694. rc = sqlite3_reset(pRtree->pWriteRowid);
  160695. *piRowid = sqlite3_last_insert_rowid(pRtree->db);
  160696. return rc;
  160697. }
  160698. /*
  160699. ** Remove the entry with rowid=iDelete from the r-tree structure.
  160700. */
  160701. static int rtreeDeleteRowid(Rtree *pRtree, sqlite3_int64 iDelete){
  160702. int rc; /* Return code */
  160703. RtreeNode *pLeaf = 0; /* Leaf node containing record iDelete */
  160704. int iCell; /* Index of iDelete cell in pLeaf */
  160705. RtreeNode *pRoot = 0; /* Root node of rtree structure */
  160706. /* Obtain a reference to the root node to initialize Rtree.iDepth */
  160707. rc = nodeAcquire(pRtree, 1, 0, &pRoot);
  160708. /* Obtain a reference to the leaf node that contains the entry
  160709. ** about to be deleted.
  160710. */
  160711. if( rc==SQLITE_OK ){
  160712. rc = findLeafNode(pRtree, iDelete, &pLeaf, 0);
  160713. }
  160714. /* Delete the cell in question from the leaf node. */
  160715. if( rc==SQLITE_OK ){
  160716. int rc2;
  160717. rc = nodeRowidIndex(pRtree, pLeaf, iDelete, &iCell);
  160718. if( rc==SQLITE_OK ){
  160719. rc = deleteCell(pRtree, pLeaf, iCell, 0);
  160720. }
  160721. rc2 = nodeRelease(pRtree, pLeaf);
  160722. if( rc==SQLITE_OK ){
  160723. rc = rc2;
  160724. }
  160725. }
  160726. /* Delete the corresponding entry in the <rtree>_rowid table. */
  160727. if( rc==SQLITE_OK ){
  160728. sqlite3_bind_int64(pRtree->pDeleteRowid, 1, iDelete);
  160729. sqlite3_step(pRtree->pDeleteRowid);
  160730. rc = sqlite3_reset(pRtree->pDeleteRowid);
  160731. }
  160732. /* Check if the root node now has exactly one child. If so, remove
  160733. ** it, schedule the contents of the child for reinsertion and
  160734. ** reduce the tree height by one.
  160735. **
  160736. ** This is equivalent to copying the contents of the child into
  160737. ** the root node (the operation that Gutman's paper says to perform
  160738. ** in this scenario).
  160739. */
  160740. if( rc==SQLITE_OK && pRtree->iDepth>0 && NCELL(pRoot)==1 ){
  160741. int rc2;
  160742. RtreeNode *pChild = 0;
  160743. i64 iChild = nodeGetRowid(pRtree, pRoot, 0);
  160744. rc = nodeAcquire(pRtree, iChild, pRoot, &pChild);
  160745. if( rc==SQLITE_OK ){
  160746. rc = removeNode(pRtree, pChild, pRtree->iDepth-1);
  160747. }
  160748. rc2 = nodeRelease(pRtree, pChild);
  160749. if( rc==SQLITE_OK ) rc = rc2;
  160750. if( rc==SQLITE_OK ){
  160751. pRtree->iDepth--;
  160752. writeInt16(pRoot->zData, pRtree->iDepth);
  160753. pRoot->isDirty = 1;
  160754. }
  160755. }
  160756. /* Re-insert the contents of any underfull nodes removed from the tree. */
  160757. for(pLeaf=pRtree->pDeleted; pLeaf; pLeaf=pRtree->pDeleted){
  160758. if( rc==SQLITE_OK ){
  160759. rc = reinsertNodeContent(pRtree, pLeaf);
  160760. }
  160761. pRtree->pDeleted = pLeaf->pNext;
  160762. sqlite3_free(pLeaf);
  160763. }
  160764. /* Release the reference to the root node. */
  160765. if( rc==SQLITE_OK ){
  160766. rc = nodeRelease(pRtree, pRoot);
  160767. }else{
  160768. nodeRelease(pRtree, pRoot);
  160769. }
  160770. return rc;
  160771. }
  160772. /*
  160773. ** Rounding constants for float->double conversion.
  160774. */
  160775. #define RNDTOWARDS (1.0 - 1.0/8388608.0) /* Round towards zero */
  160776. #define RNDAWAY (1.0 + 1.0/8388608.0) /* Round away from zero */
  160777. #if !defined(SQLITE_RTREE_INT_ONLY)
  160778. /*
  160779. ** Convert an sqlite3_value into an RtreeValue (presumably a float)
  160780. ** while taking care to round toward negative or positive, respectively.
  160781. */
  160782. static RtreeValue rtreeValueDown(sqlite3_value *v){
  160783. double d = sqlite3_value_double(v);
  160784. float f = (float)d;
  160785. if( f>d ){
  160786. f = (float)(d*(d<0 ? RNDAWAY : RNDTOWARDS));
  160787. }
  160788. return f;
  160789. }
  160790. static RtreeValue rtreeValueUp(sqlite3_value *v){
  160791. double d = sqlite3_value_double(v);
  160792. float f = (float)d;
  160793. if( f<d ){
  160794. f = (float)(d*(d<0 ? RNDTOWARDS : RNDAWAY));
  160795. }
  160796. return f;
  160797. }
  160798. #endif /* !defined(SQLITE_RTREE_INT_ONLY) */
  160799. /*
  160800. ** A constraint has failed while inserting a row into an rtree table.
  160801. ** Assuming no OOM error occurs, this function sets the error message
  160802. ** (at pRtree->base.zErrMsg) to an appropriate value and returns
  160803. ** SQLITE_CONSTRAINT.
  160804. **
  160805. ** Parameter iCol is the index of the leftmost column involved in the
  160806. ** constraint failure. If it is 0, then the constraint that failed is
  160807. ** the unique constraint on the id column. Otherwise, it is the rtree
  160808. ** (c1<=c2) constraint on columns iCol and iCol+1 that has failed.
  160809. **
  160810. ** If an OOM occurs, SQLITE_NOMEM is returned instead of SQLITE_CONSTRAINT.
  160811. */
  160812. static int rtreeConstraintError(Rtree *pRtree, int iCol){
  160813. sqlite3_stmt *pStmt = 0;
  160814. char *zSql;
  160815. int rc;
  160816. assert( iCol==0 || iCol%2 );
  160817. zSql = sqlite3_mprintf("SELECT * FROM %Q.%Q", pRtree->zDb, pRtree->zName);
  160818. if( zSql ){
  160819. rc = sqlite3_prepare_v2(pRtree->db, zSql, -1, &pStmt, 0);
  160820. }else{
  160821. rc = SQLITE_NOMEM;
  160822. }
  160823. sqlite3_free(zSql);
  160824. if( rc==SQLITE_OK ){
  160825. if( iCol==0 ){
  160826. const char *zCol = sqlite3_column_name(pStmt, 0);
  160827. pRtree->base.zErrMsg = sqlite3_mprintf(
  160828. "UNIQUE constraint failed: %s.%s", pRtree->zName, zCol
  160829. );
  160830. }else{
  160831. const char *zCol1 = sqlite3_column_name(pStmt, iCol);
  160832. const char *zCol2 = sqlite3_column_name(pStmt, iCol+1);
  160833. pRtree->base.zErrMsg = sqlite3_mprintf(
  160834. "rtree constraint failed: %s.(%s<=%s)", pRtree->zName, zCol1, zCol2
  160835. );
  160836. }
  160837. }
  160838. sqlite3_finalize(pStmt);
  160839. return (rc==SQLITE_OK ? SQLITE_CONSTRAINT : rc);
  160840. }
  160841. /*
  160842. ** The xUpdate method for rtree module virtual tables.
  160843. */
  160844. static int rtreeUpdate(
  160845. sqlite3_vtab *pVtab,
  160846. int nData,
  160847. sqlite3_value **azData,
  160848. sqlite_int64 *pRowid
  160849. ){
  160850. Rtree *pRtree = (Rtree *)pVtab;
  160851. int rc = SQLITE_OK;
  160852. RtreeCell cell; /* New cell to insert if nData>1 */
  160853. int bHaveRowid = 0; /* Set to 1 after new rowid is determined */
  160854. rtreeReference(pRtree);
  160855. assert(nData>=1);
  160856. cell.iRowid = 0; /* Used only to suppress a compiler warning */
  160857. /* Constraint handling. A write operation on an r-tree table may return
  160858. ** SQLITE_CONSTRAINT for two reasons:
  160859. **
  160860. ** 1. A duplicate rowid value, or
  160861. ** 2. The supplied data violates the "x2>=x1" constraint.
  160862. **
  160863. ** In the first case, if the conflict-handling mode is REPLACE, then
  160864. ** the conflicting row can be removed before proceeding. In the second
  160865. ** case, SQLITE_CONSTRAINT must be returned regardless of the
  160866. ** conflict-handling mode specified by the user.
  160867. */
  160868. if( nData>1 ){
  160869. int ii;
  160870. /* Populate the cell.aCoord[] array. The first coordinate is azData[3].
  160871. **
  160872. ** NB: nData can only be less than nDim*2+3 if the rtree is mis-declared
  160873. ** with "column" that are interpreted as table constraints.
  160874. ** Example: CREATE VIRTUAL TABLE bad USING rtree(x,y,CHECK(y>5));
  160875. ** This problem was discovered after years of use, so we silently ignore
  160876. ** these kinds of misdeclared tables to avoid breaking any legacy.
  160877. */
  160878. assert( nData<=(pRtree->nDim2 + 3) );
  160879. #ifndef SQLITE_RTREE_INT_ONLY
  160880. if( pRtree->eCoordType==RTREE_COORD_REAL32 ){
  160881. for(ii=0; ii<nData-4; ii+=2){
  160882. cell.aCoord[ii].f = rtreeValueDown(azData[ii+3]);
  160883. cell.aCoord[ii+1].f = rtreeValueUp(azData[ii+4]);
  160884. if( cell.aCoord[ii].f>cell.aCoord[ii+1].f ){
  160885. rc = rtreeConstraintError(pRtree, ii+1);
  160886. goto constraint;
  160887. }
  160888. }
  160889. }else
  160890. #endif
  160891. {
  160892. for(ii=0; ii<nData-4; ii+=2){
  160893. cell.aCoord[ii].i = sqlite3_value_int(azData[ii+3]);
  160894. cell.aCoord[ii+1].i = sqlite3_value_int(azData[ii+4]);
  160895. if( cell.aCoord[ii].i>cell.aCoord[ii+1].i ){
  160896. rc = rtreeConstraintError(pRtree, ii+1);
  160897. goto constraint;
  160898. }
  160899. }
  160900. }
  160901. /* If a rowid value was supplied, check if it is already present in
  160902. ** the table. If so, the constraint has failed. */
  160903. if( sqlite3_value_type(azData[2])!=SQLITE_NULL ){
  160904. cell.iRowid = sqlite3_value_int64(azData[2]);
  160905. if( sqlite3_value_type(azData[0])==SQLITE_NULL
  160906. || sqlite3_value_int64(azData[0])!=cell.iRowid
  160907. ){
  160908. int steprc;
  160909. sqlite3_bind_int64(pRtree->pReadRowid, 1, cell.iRowid);
  160910. steprc = sqlite3_step(pRtree->pReadRowid);
  160911. rc = sqlite3_reset(pRtree->pReadRowid);
  160912. if( SQLITE_ROW==steprc ){
  160913. if( sqlite3_vtab_on_conflict(pRtree->db)==SQLITE_REPLACE ){
  160914. rc = rtreeDeleteRowid(pRtree, cell.iRowid);
  160915. }else{
  160916. rc = rtreeConstraintError(pRtree, 0);
  160917. goto constraint;
  160918. }
  160919. }
  160920. }
  160921. bHaveRowid = 1;
  160922. }
  160923. }
  160924. /* If azData[0] is not an SQL NULL value, it is the rowid of a
  160925. ** record to delete from the r-tree table. The following block does
  160926. ** just that.
  160927. */
  160928. if( sqlite3_value_type(azData[0])!=SQLITE_NULL ){
  160929. rc = rtreeDeleteRowid(pRtree, sqlite3_value_int64(azData[0]));
  160930. }
  160931. /* If the azData[] array contains more than one element, elements
  160932. ** (azData[2]..azData[argc-1]) contain a new record to insert into
  160933. ** the r-tree structure.
  160934. */
  160935. if( rc==SQLITE_OK && nData>1 ){
  160936. /* Insert the new record into the r-tree */
  160937. RtreeNode *pLeaf = 0;
  160938. /* Figure out the rowid of the new row. */
  160939. if( bHaveRowid==0 ){
  160940. rc = newRowid(pRtree, &cell.iRowid);
  160941. }
  160942. *pRowid = cell.iRowid;
  160943. if( rc==SQLITE_OK ){
  160944. rc = ChooseLeaf(pRtree, &cell, 0, &pLeaf);
  160945. }
  160946. if( rc==SQLITE_OK ){
  160947. int rc2;
  160948. pRtree->iReinsertHeight = -1;
  160949. rc = rtreeInsertCell(pRtree, pLeaf, &cell, 0);
  160950. rc2 = nodeRelease(pRtree, pLeaf);
  160951. if( rc==SQLITE_OK ){
  160952. rc = rc2;
  160953. }
  160954. }
  160955. }
  160956. constraint:
  160957. rtreeRelease(pRtree);
  160958. return rc;
  160959. }
  160960. /*
  160961. ** Called when a transaction starts.
  160962. */
  160963. static int rtreeBeginTransaction(sqlite3_vtab *pVtab){
  160964. Rtree *pRtree = (Rtree *)pVtab;
  160965. assert( pRtree->inWrTrans==0 );
  160966. pRtree->inWrTrans++;
  160967. return SQLITE_OK;
  160968. }
  160969. /*
  160970. ** Called when a transaction completes (either by COMMIT or ROLLBACK).
  160971. ** The sqlite3_blob object should be released at this point.
  160972. */
  160973. static int rtreeEndTransaction(sqlite3_vtab *pVtab){
  160974. Rtree *pRtree = (Rtree *)pVtab;
  160975. pRtree->inWrTrans = 0;
  160976. nodeBlobReset(pRtree);
  160977. return SQLITE_OK;
  160978. }
  160979. /*
  160980. ** The xRename method for rtree module virtual tables.
  160981. */
  160982. static int rtreeRename(sqlite3_vtab *pVtab, const char *zNewName){
  160983. Rtree *pRtree = (Rtree *)pVtab;
  160984. int rc = SQLITE_NOMEM;
  160985. char *zSql = sqlite3_mprintf(
  160986. "ALTER TABLE %Q.'%q_node' RENAME TO \"%w_node\";"
  160987. "ALTER TABLE %Q.'%q_parent' RENAME TO \"%w_parent\";"
  160988. "ALTER TABLE %Q.'%q_rowid' RENAME TO \"%w_rowid\";"
  160989. , pRtree->zDb, pRtree->zName, zNewName
  160990. , pRtree->zDb, pRtree->zName, zNewName
  160991. , pRtree->zDb, pRtree->zName, zNewName
  160992. );
  160993. if( zSql ){
  160994. nodeBlobReset(pRtree);
  160995. rc = sqlite3_exec(pRtree->db, zSql, 0, 0, 0);
  160996. sqlite3_free(zSql);
  160997. }
  160998. return rc;
  160999. }
  161000. /*
  161001. ** The xSavepoint method.
  161002. **
  161003. ** This module does not need to do anything to support savepoints. However,
  161004. ** it uses this hook to close any open blob handle. This is done because a
  161005. ** DROP TABLE command - which fortunately always opens a savepoint - cannot
  161006. ** succeed if there are any open blob handles. i.e. if the blob handle were
  161007. ** not closed here, the following would fail:
  161008. **
  161009. ** BEGIN;
  161010. ** INSERT INTO rtree...
  161011. ** DROP TABLE <tablename>; -- Would fail with SQLITE_LOCKED
  161012. ** COMMIT;
  161013. */
  161014. static int rtreeSavepoint(sqlite3_vtab *pVtab, int iSavepoint){
  161015. Rtree *pRtree = (Rtree *)pVtab;
  161016. int iwt = pRtree->inWrTrans;
  161017. UNUSED_PARAMETER(iSavepoint);
  161018. pRtree->inWrTrans = 0;
  161019. nodeBlobReset(pRtree);
  161020. pRtree->inWrTrans = iwt;
  161021. return SQLITE_OK;
  161022. }
  161023. /*
  161024. ** This function populates the pRtree->nRowEst variable with an estimate
  161025. ** of the number of rows in the virtual table. If possible, this is based
  161026. ** on sqlite_stat1 data. Otherwise, use RTREE_DEFAULT_ROWEST.
  161027. */
  161028. static int rtreeQueryStat1(sqlite3 *db, Rtree *pRtree){
  161029. const char *zFmt = "SELECT stat FROM %Q.sqlite_stat1 WHERE tbl = '%q_rowid'";
  161030. char *zSql;
  161031. sqlite3_stmt *p;
  161032. int rc;
  161033. i64 nRow = 0;
  161034. rc = sqlite3_table_column_metadata(
  161035. db, pRtree->zDb, "sqlite_stat1",0,0,0,0,0,0
  161036. );
  161037. if( rc!=SQLITE_OK ){
  161038. pRtree->nRowEst = RTREE_DEFAULT_ROWEST;
  161039. return rc==SQLITE_ERROR ? SQLITE_OK : rc;
  161040. }
  161041. zSql = sqlite3_mprintf(zFmt, pRtree->zDb, pRtree->zName);
  161042. if( zSql==0 ){
  161043. rc = SQLITE_NOMEM;
  161044. }else{
  161045. rc = sqlite3_prepare_v2(db, zSql, -1, &p, 0);
  161046. if( rc==SQLITE_OK ){
  161047. if( sqlite3_step(p)==SQLITE_ROW ) nRow = sqlite3_column_int64(p, 0);
  161048. rc = sqlite3_finalize(p);
  161049. }else if( rc!=SQLITE_NOMEM ){
  161050. rc = SQLITE_OK;
  161051. }
  161052. if( rc==SQLITE_OK ){
  161053. if( nRow==0 ){
  161054. pRtree->nRowEst = RTREE_DEFAULT_ROWEST;
  161055. }else{
  161056. pRtree->nRowEst = MAX(nRow, RTREE_MIN_ROWEST);
  161057. }
  161058. }
  161059. sqlite3_free(zSql);
  161060. }
  161061. return rc;
  161062. }
  161063. static sqlite3_module rtreeModule = {
  161064. 2, /* iVersion */
  161065. rtreeCreate, /* xCreate - create a table */
  161066. rtreeConnect, /* xConnect - connect to an existing table */
  161067. rtreeBestIndex, /* xBestIndex - Determine search strategy */
  161068. rtreeDisconnect, /* xDisconnect - Disconnect from a table */
  161069. rtreeDestroy, /* xDestroy - Drop a table */
  161070. rtreeOpen, /* xOpen - open a cursor */
  161071. rtreeClose, /* xClose - close a cursor */
  161072. rtreeFilter, /* xFilter - configure scan constraints */
  161073. rtreeNext, /* xNext - advance a cursor */
  161074. rtreeEof, /* xEof */
  161075. rtreeColumn, /* xColumn - read data */
  161076. rtreeRowid, /* xRowid - read data */
  161077. rtreeUpdate, /* xUpdate - write data */
  161078. rtreeBeginTransaction, /* xBegin - begin transaction */
  161079. rtreeEndTransaction, /* xSync - sync transaction */
  161080. rtreeEndTransaction, /* xCommit - commit transaction */
  161081. rtreeEndTransaction, /* xRollback - rollback transaction */
  161082. 0, /* xFindFunction - function overloading */
  161083. rtreeRename, /* xRename - rename the table */
  161084. rtreeSavepoint, /* xSavepoint */
  161085. 0, /* xRelease */
  161086. 0, /* xRollbackTo */
  161087. };
  161088. static int rtreeSqlInit(
  161089. Rtree *pRtree,
  161090. sqlite3 *db,
  161091. const char *zDb,
  161092. const char *zPrefix,
  161093. int isCreate
  161094. ){
  161095. int rc = SQLITE_OK;
  161096. #define N_STATEMENT 8
  161097. static const char *azSql[N_STATEMENT] = {
  161098. /* Write the xxx_node table */
  161099. "INSERT OR REPLACE INTO '%q'.'%q_node' VALUES(:1, :2)",
  161100. "DELETE FROM '%q'.'%q_node' WHERE nodeno = :1",
  161101. /* Read and write the xxx_rowid table */
  161102. "SELECT nodeno FROM '%q'.'%q_rowid' WHERE rowid = :1",
  161103. "INSERT OR REPLACE INTO '%q'.'%q_rowid' VALUES(:1, :2)",
  161104. "DELETE FROM '%q'.'%q_rowid' WHERE rowid = :1",
  161105. /* Read and write the xxx_parent table */
  161106. "SELECT parentnode FROM '%q'.'%q_parent' WHERE nodeno = :1",
  161107. "INSERT OR REPLACE INTO '%q'.'%q_parent' VALUES(:1, :2)",
  161108. "DELETE FROM '%q'.'%q_parent' WHERE nodeno = :1"
  161109. };
  161110. sqlite3_stmt **appStmt[N_STATEMENT];
  161111. int i;
  161112. pRtree->db = db;
  161113. if( isCreate ){
  161114. char *zCreate = sqlite3_mprintf(
  161115. "CREATE TABLE \"%w\".\"%w_node\"(nodeno INTEGER PRIMARY KEY, data BLOB);"
  161116. "CREATE TABLE \"%w\".\"%w_rowid\"(rowid INTEGER PRIMARY KEY, nodeno INTEGER);"
  161117. "CREATE TABLE \"%w\".\"%w_parent\"(nodeno INTEGER PRIMARY KEY,"
  161118. " parentnode INTEGER);"
  161119. "INSERT INTO '%q'.'%q_node' VALUES(1, zeroblob(%d))",
  161120. zDb, zPrefix, zDb, zPrefix, zDb, zPrefix, zDb, zPrefix, pRtree->iNodeSize
  161121. );
  161122. if( !zCreate ){
  161123. return SQLITE_NOMEM;
  161124. }
  161125. rc = sqlite3_exec(db, zCreate, 0, 0, 0);
  161126. sqlite3_free(zCreate);
  161127. if( rc!=SQLITE_OK ){
  161128. return rc;
  161129. }
  161130. }
  161131. appStmt[0] = &pRtree->pWriteNode;
  161132. appStmt[1] = &pRtree->pDeleteNode;
  161133. appStmt[2] = &pRtree->pReadRowid;
  161134. appStmt[3] = &pRtree->pWriteRowid;
  161135. appStmt[4] = &pRtree->pDeleteRowid;
  161136. appStmt[5] = &pRtree->pReadParent;
  161137. appStmt[6] = &pRtree->pWriteParent;
  161138. appStmt[7] = &pRtree->pDeleteParent;
  161139. rc = rtreeQueryStat1(db, pRtree);
  161140. for(i=0; i<N_STATEMENT && rc==SQLITE_OK; i++){
  161141. char *zSql = sqlite3_mprintf(azSql[i], zDb, zPrefix);
  161142. if( zSql ){
  161143. rc = sqlite3_prepare_v3(db, zSql, -1, SQLITE_PREPARE_PERSISTENT,
  161144. appStmt[i], 0);
  161145. }else{
  161146. rc = SQLITE_NOMEM;
  161147. }
  161148. sqlite3_free(zSql);
  161149. }
  161150. return rc;
  161151. }
  161152. /*
  161153. ** The second argument to this function contains the text of an SQL statement
  161154. ** that returns a single integer value. The statement is compiled and executed
  161155. ** using database connection db. If successful, the integer value returned
  161156. ** is written to *piVal and SQLITE_OK returned. Otherwise, an SQLite error
  161157. ** code is returned and the value of *piVal after returning is not defined.
  161158. */
  161159. static int getIntFromStmt(sqlite3 *db, const char *zSql, int *piVal){
  161160. int rc = SQLITE_NOMEM;
  161161. if( zSql ){
  161162. sqlite3_stmt *pStmt = 0;
  161163. rc = sqlite3_prepare_v2(db, zSql, -1, &pStmt, 0);
  161164. if( rc==SQLITE_OK ){
  161165. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  161166. *piVal = sqlite3_column_int(pStmt, 0);
  161167. }
  161168. rc = sqlite3_finalize(pStmt);
  161169. }
  161170. }
  161171. return rc;
  161172. }
  161173. /*
  161174. ** This function is called from within the xConnect() or xCreate() method to
  161175. ** determine the node-size used by the rtree table being created or connected
  161176. ** to. If successful, pRtree->iNodeSize is populated and SQLITE_OK returned.
  161177. ** Otherwise, an SQLite error code is returned.
  161178. **
  161179. ** If this function is being called as part of an xConnect(), then the rtree
  161180. ** table already exists. In this case the node-size is determined by inspecting
  161181. ** the root node of the tree.
  161182. **
  161183. ** Otherwise, for an xCreate(), use 64 bytes less than the database page-size.
  161184. ** This ensures that each node is stored on a single database page. If the
  161185. ** database page-size is so large that more than RTREE_MAXCELLS entries
  161186. ** would fit in a single node, use a smaller node-size.
  161187. */
  161188. static int getNodeSize(
  161189. sqlite3 *db, /* Database handle */
  161190. Rtree *pRtree, /* Rtree handle */
  161191. int isCreate, /* True for xCreate, false for xConnect */
  161192. char **pzErr /* OUT: Error message, if any */
  161193. ){
  161194. int rc;
  161195. char *zSql;
  161196. if( isCreate ){
  161197. int iPageSize = 0;
  161198. zSql = sqlite3_mprintf("PRAGMA %Q.page_size", pRtree->zDb);
  161199. rc = getIntFromStmt(db, zSql, &iPageSize);
  161200. if( rc==SQLITE_OK ){
  161201. pRtree->iNodeSize = iPageSize-64;
  161202. if( (4+pRtree->nBytesPerCell*RTREE_MAXCELLS)<pRtree->iNodeSize ){
  161203. pRtree->iNodeSize = 4+pRtree->nBytesPerCell*RTREE_MAXCELLS;
  161204. }
  161205. }else{
  161206. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  161207. }
  161208. }else{
  161209. zSql = sqlite3_mprintf(
  161210. "SELECT length(data) FROM '%q'.'%q_node' WHERE nodeno = 1",
  161211. pRtree->zDb, pRtree->zName
  161212. );
  161213. rc = getIntFromStmt(db, zSql, &pRtree->iNodeSize);
  161214. if( rc!=SQLITE_OK ){
  161215. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  161216. }else if( pRtree->iNodeSize<(512-64) ){
  161217. rc = SQLITE_CORRUPT_VTAB;
  161218. *pzErr = sqlite3_mprintf("undersize RTree blobs in \"%q_node\"",
  161219. pRtree->zName);
  161220. }
  161221. }
  161222. sqlite3_free(zSql);
  161223. return rc;
  161224. }
  161225. /*
  161226. ** This function is the implementation of both the xConnect and xCreate
  161227. ** methods of the r-tree virtual table.
  161228. **
  161229. ** argv[0] -> module name
  161230. ** argv[1] -> database name
  161231. ** argv[2] -> table name
  161232. ** argv[...] -> column names...
  161233. */
  161234. static int rtreeInit(
  161235. sqlite3 *db, /* Database connection */
  161236. void *pAux, /* One of the RTREE_COORD_* constants */
  161237. int argc, const char *const*argv, /* Parameters to CREATE TABLE statement */
  161238. sqlite3_vtab **ppVtab, /* OUT: New virtual table */
  161239. char **pzErr, /* OUT: Error message, if any */
  161240. int isCreate /* True for xCreate, false for xConnect */
  161241. ){
  161242. int rc = SQLITE_OK;
  161243. Rtree *pRtree;
  161244. int nDb; /* Length of string argv[1] */
  161245. int nName; /* Length of string argv[2] */
  161246. int eCoordType = (pAux ? RTREE_COORD_INT32 : RTREE_COORD_REAL32);
  161247. const char *aErrMsg[] = {
  161248. 0, /* 0 */
  161249. "Wrong number of columns for an rtree table", /* 1 */
  161250. "Too few columns for an rtree table", /* 2 */
  161251. "Too many columns for an rtree table" /* 3 */
  161252. };
  161253. int iErr = (argc<6) ? 2 : argc>(RTREE_MAX_DIMENSIONS*2+4) ? 3 : argc%2;
  161254. if( aErrMsg[iErr] ){
  161255. *pzErr = sqlite3_mprintf("%s", aErrMsg[iErr]);
  161256. return SQLITE_ERROR;
  161257. }
  161258. sqlite3_vtab_config(db, SQLITE_VTAB_CONSTRAINT_SUPPORT, 1);
  161259. /* Allocate the sqlite3_vtab structure */
  161260. nDb = (int)strlen(argv[1]);
  161261. nName = (int)strlen(argv[2]);
  161262. pRtree = (Rtree *)sqlite3_malloc(sizeof(Rtree)+nDb+nName+2);
  161263. if( !pRtree ){
  161264. return SQLITE_NOMEM;
  161265. }
  161266. memset(pRtree, 0, sizeof(Rtree)+nDb+nName+2);
  161267. pRtree->nBusy = 1;
  161268. pRtree->base.pModule = &rtreeModule;
  161269. pRtree->zDb = (char *)&pRtree[1];
  161270. pRtree->zName = &pRtree->zDb[nDb+1];
  161271. pRtree->nDim = (u8)((argc-4)/2);
  161272. pRtree->nDim2 = pRtree->nDim*2;
  161273. pRtree->nBytesPerCell = 8 + pRtree->nDim2*4;
  161274. pRtree->eCoordType = (u8)eCoordType;
  161275. memcpy(pRtree->zDb, argv[1], nDb);
  161276. memcpy(pRtree->zName, argv[2], nName);
  161277. /* Figure out the node size to use. */
  161278. rc = getNodeSize(db, pRtree, isCreate, pzErr);
  161279. /* Create/Connect to the underlying relational database schema. If
  161280. ** that is successful, call sqlite3_declare_vtab() to configure
  161281. ** the r-tree table schema.
  161282. */
  161283. if( rc==SQLITE_OK ){
  161284. if( (rc = rtreeSqlInit(pRtree, db, argv[1], argv[2], isCreate)) ){
  161285. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  161286. }else{
  161287. char *zSql = sqlite3_mprintf("CREATE TABLE x(%s", argv[3]);
  161288. char *zTmp;
  161289. int ii;
  161290. for(ii=4; zSql && ii<argc; ii++){
  161291. zTmp = zSql;
  161292. zSql = sqlite3_mprintf("%s, %s", zTmp, argv[ii]);
  161293. sqlite3_free(zTmp);
  161294. }
  161295. if( zSql ){
  161296. zTmp = zSql;
  161297. zSql = sqlite3_mprintf("%s);", zTmp);
  161298. sqlite3_free(zTmp);
  161299. }
  161300. if( !zSql ){
  161301. rc = SQLITE_NOMEM;
  161302. }else if( SQLITE_OK!=(rc = sqlite3_declare_vtab(db, zSql)) ){
  161303. *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  161304. }
  161305. sqlite3_free(zSql);
  161306. }
  161307. }
  161308. if( rc==SQLITE_OK ){
  161309. *ppVtab = (sqlite3_vtab *)pRtree;
  161310. }else{
  161311. assert( *ppVtab==0 );
  161312. assert( pRtree->nBusy==1 );
  161313. rtreeRelease(pRtree);
  161314. }
  161315. return rc;
  161316. }
  161317. /*
  161318. ** Implementation of a scalar function that decodes r-tree nodes to
  161319. ** human readable strings. This can be used for debugging and analysis.
  161320. **
  161321. ** The scalar function takes two arguments: (1) the number of dimensions
  161322. ** to the rtree (between 1 and 5, inclusive) and (2) a blob of data containing
  161323. ** an r-tree node. For a two-dimensional r-tree structure called "rt", to
  161324. ** deserialize all nodes, a statement like:
  161325. **
  161326. ** SELECT rtreenode(2, data) FROM rt_node;
  161327. **
  161328. ** The human readable string takes the form of a Tcl list with one
  161329. ** entry for each cell in the r-tree node. Each entry is itself a
  161330. ** list, containing the 8-byte rowid/pageno followed by the
  161331. ** <num-dimension>*2 coordinates.
  161332. */
  161333. static void rtreenode(sqlite3_context *ctx, int nArg, sqlite3_value **apArg){
  161334. char *zText = 0;
  161335. RtreeNode node;
  161336. Rtree tree;
  161337. int ii;
  161338. UNUSED_PARAMETER(nArg);
  161339. memset(&node, 0, sizeof(RtreeNode));
  161340. memset(&tree, 0, sizeof(Rtree));
  161341. tree.nDim = (u8)sqlite3_value_int(apArg[0]);
  161342. tree.nDim2 = tree.nDim*2;
  161343. tree.nBytesPerCell = 8 + 8 * tree.nDim;
  161344. node.zData = (u8 *)sqlite3_value_blob(apArg[1]);
  161345. for(ii=0; ii<NCELL(&node); ii++){
  161346. char zCell[512];
  161347. int nCell = 0;
  161348. RtreeCell cell;
  161349. int jj;
  161350. nodeGetCell(&tree, &node, ii, &cell);
  161351. sqlite3_snprintf(512-nCell,&zCell[nCell],"%lld", cell.iRowid);
  161352. nCell = (int)strlen(zCell);
  161353. for(jj=0; jj<tree.nDim2; jj++){
  161354. #ifndef SQLITE_RTREE_INT_ONLY
  161355. sqlite3_snprintf(512-nCell,&zCell[nCell], " %g",
  161356. (double)cell.aCoord[jj].f);
  161357. #else
  161358. sqlite3_snprintf(512-nCell,&zCell[nCell], " %d",
  161359. cell.aCoord[jj].i);
  161360. #endif
  161361. nCell = (int)strlen(zCell);
  161362. }
  161363. if( zText ){
  161364. char *zTextNew = sqlite3_mprintf("%s {%s}", zText, zCell);
  161365. sqlite3_free(zText);
  161366. zText = zTextNew;
  161367. }else{
  161368. zText = sqlite3_mprintf("{%s}", zCell);
  161369. }
  161370. }
  161371. sqlite3_result_text(ctx, zText, -1, sqlite3_free);
  161372. }
  161373. /* This routine implements an SQL function that returns the "depth" parameter
  161374. ** from the front of a blob that is an r-tree node. For example:
  161375. **
  161376. ** SELECT rtreedepth(data) FROM rt_node WHERE nodeno=1;
  161377. **
  161378. ** The depth value is 0 for all nodes other than the root node, and the root
  161379. ** node always has nodeno=1, so the example above is the primary use for this
  161380. ** routine. This routine is intended for testing and analysis only.
  161381. */
  161382. static void rtreedepth(sqlite3_context *ctx, int nArg, sqlite3_value **apArg){
  161383. UNUSED_PARAMETER(nArg);
  161384. if( sqlite3_value_type(apArg[0])!=SQLITE_BLOB
  161385. || sqlite3_value_bytes(apArg[0])<2
  161386. ){
  161387. sqlite3_result_error(ctx, "Invalid argument to rtreedepth()", -1);
  161388. }else{
  161389. u8 *zBlob = (u8 *)sqlite3_value_blob(apArg[0]);
  161390. sqlite3_result_int(ctx, readInt16(zBlob));
  161391. }
  161392. }
  161393. /*
  161394. ** Context object passed between the various routines that make up the
  161395. ** implementation of integrity-check function rtreecheck().
  161396. */
  161397. typedef struct RtreeCheck RtreeCheck;
  161398. struct RtreeCheck {
  161399. sqlite3 *db; /* Database handle */
  161400. const char *zDb; /* Database containing rtree table */
  161401. const char *zTab; /* Name of rtree table */
  161402. int bInt; /* True for rtree_i32 table */
  161403. int nDim; /* Number of dimensions for this rtree tbl */
  161404. sqlite3_stmt *pGetNode; /* Statement used to retrieve nodes */
  161405. sqlite3_stmt *aCheckMapping[2]; /* Statements to query %_parent/%_rowid */
  161406. int nLeaf; /* Number of leaf cells in table */
  161407. int nNonLeaf; /* Number of non-leaf cells in table */
  161408. int rc; /* Return code */
  161409. char *zReport; /* Message to report */
  161410. int nErr; /* Number of lines in zReport */
  161411. };
  161412. #define RTREE_CHECK_MAX_ERROR 100
  161413. /*
  161414. ** Reset SQL statement pStmt. If the sqlite3_reset() call returns an error,
  161415. ** and RtreeCheck.rc==SQLITE_OK, set RtreeCheck.rc to the error code.
  161416. */
  161417. static void rtreeCheckReset(RtreeCheck *pCheck, sqlite3_stmt *pStmt){
  161418. int rc = sqlite3_reset(pStmt);
  161419. if( pCheck->rc==SQLITE_OK ) pCheck->rc = rc;
  161420. }
  161421. /*
  161422. ** The second and subsequent arguments to this function are a format string
  161423. ** and printf style arguments. This function formats the string and attempts
  161424. ** to compile it as an SQL statement.
  161425. **
  161426. ** If successful, a pointer to the new SQL statement is returned. Otherwise,
  161427. ** NULL is returned and an error code left in RtreeCheck.rc.
  161428. */
  161429. static sqlite3_stmt *rtreeCheckPrepare(
  161430. RtreeCheck *pCheck, /* RtreeCheck object */
  161431. const char *zFmt, ... /* Format string and trailing args */
  161432. ){
  161433. va_list ap;
  161434. char *z;
  161435. sqlite3_stmt *pRet = 0;
  161436. va_start(ap, zFmt);
  161437. z = sqlite3_vmprintf(zFmt, ap);
  161438. if( pCheck->rc==SQLITE_OK ){
  161439. if( z==0 ){
  161440. pCheck->rc = SQLITE_NOMEM;
  161441. }else{
  161442. pCheck->rc = sqlite3_prepare_v2(pCheck->db, z, -1, &pRet, 0);
  161443. }
  161444. }
  161445. sqlite3_free(z);
  161446. va_end(ap);
  161447. return pRet;
  161448. }
  161449. /*
  161450. ** The second and subsequent arguments to this function are a printf()
  161451. ** style format string and arguments. This function formats the string and
  161452. ** appends it to the report being accumuated in pCheck.
  161453. */
  161454. static void rtreeCheckAppendMsg(RtreeCheck *pCheck, const char *zFmt, ...){
  161455. va_list ap;
  161456. va_start(ap, zFmt);
  161457. if( pCheck->rc==SQLITE_OK && pCheck->nErr<RTREE_CHECK_MAX_ERROR ){
  161458. char *z = sqlite3_vmprintf(zFmt, ap);
  161459. if( z==0 ){
  161460. pCheck->rc = SQLITE_NOMEM;
  161461. }else{
  161462. pCheck->zReport = sqlite3_mprintf("%z%s%z",
  161463. pCheck->zReport, (pCheck->zReport ? "\n" : ""), z
  161464. );
  161465. if( pCheck->zReport==0 ){
  161466. pCheck->rc = SQLITE_NOMEM;
  161467. }
  161468. }
  161469. pCheck->nErr++;
  161470. }
  161471. va_end(ap);
  161472. }
  161473. /*
  161474. ** This function is a no-op if there is already an error code stored
  161475. ** in the RtreeCheck object indicated by the first argument. NULL is
  161476. ** returned in this case.
  161477. **
  161478. ** Otherwise, the contents of rtree table node iNode are loaded from
  161479. ** the database and copied into a buffer obtained from sqlite3_malloc().
  161480. ** If no error occurs, a pointer to the buffer is returned and (*pnNode)
  161481. ** is set to the size of the buffer in bytes.
  161482. **
  161483. ** Or, if an error does occur, NULL is returned and an error code left
  161484. ** in the RtreeCheck object. The final value of *pnNode is undefined in
  161485. ** this case.
  161486. */
  161487. static u8 *rtreeCheckGetNode(RtreeCheck *pCheck, i64 iNode, int *pnNode){
  161488. u8 *pRet = 0; /* Return value */
  161489. assert( pCheck->rc==SQLITE_OK );
  161490. if( pCheck->pGetNode==0 ){
  161491. pCheck->pGetNode = rtreeCheckPrepare(pCheck,
  161492. "SELECT data FROM %Q.'%q_node' WHERE nodeno=?",
  161493. pCheck->zDb, pCheck->zTab
  161494. );
  161495. }
  161496. if( pCheck->rc==SQLITE_OK ){
  161497. sqlite3_bind_int64(pCheck->pGetNode, 1, iNode);
  161498. if( sqlite3_step(pCheck->pGetNode)==SQLITE_ROW ){
  161499. int nNode = sqlite3_column_bytes(pCheck->pGetNode, 0);
  161500. const u8 *pNode = (const u8*)sqlite3_column_blob(pCheck->pGetNode, 0);
  161501. pRet = sqlite3_malloc(nNode);
  161502. if( pRet==0 ){
  161503. pCheck->rc = SQLITE_NOMEM;
  161504. }else{
  161505. memcpy(pRet, pNode, nNode);
  161506. *pnNode = nNode;
  161507. }
  161508. }
  161509. rtreeCheckReset(pCheck, pCheck->pGetNode);
  161510. if( pCheck->rc==SQLITE_OK && pRet==0 ){
  161511. rtreeCheckAppendMsg(pCheck, "Node %lld missing from database", iNode);
  161512. }
  161513. }
  161514. return pRet;
  161515. }
  161516. /*
  161517. ** This function is used to check that the %_parent (if bLeaf==0) or %_rowid
  161518. ** (if bLeaf==1) table contains a specified entry. The schemas of the
  161519. ** two tables are:
  161520. **
  161521. ** CREATE TABLE %_parent(nodeno INTEGER PRIMARY KEY, parentnode INTEGER)
  161522. ** CREATE TABLE %_rowid(rowid INTEGER PRIMARY KEY, nodeno INTEGER)
  161523. **
  161524. ** In both cases, this function checks that there exists an entry with
  161525. ** IPK value iKey and the second column set to iVal.
  161526. **
  161527. */
  161528. static void rtreeCheckMapping(
  161529. RtreeCheck *pCheck, /* RtreeCheck object */
  161530. int bLeaf, /* True for a leaf cell, false for interior */
  161531. i64 iKey, /* Key for mapping */
  161532. i64 iVal /* Expected value for mapping */
  161533. ){
  161534. int rc;
  161535. sqlite3_stmt *pStmt;
  161536. const char *azSql[2] = {
  161537. "SELECT parentnode FROM %Q.'%q_parent' WHERE nodeno=?",
  161538. "SELECT nodeno FROM %Q.'%q_rowid' WHERE rowid=?"
  161539. };
  161540. assert( bLeaf==0 || bLeaf==1 );
  161541. if( pCheck->aCheckMapping[bLeaf]==0 ){
  161542. pCheck->aCheckMapping[bLeaf] = rtreeCheckPrepare(pCheck,
  161543. azSql[bLeaf], pCheck->zDb, pCheck->zTab
  161544. );
  161545. }
  161546. if( pCheck->rc!=SQLITE_OK ) return;
  161547. pStmt = pCheck->aCheckMapping[bLeaf];
  161548. sqlite3_bind_int64(pStmt, 1, iKey);
  161549. rc = sqlite3_step(pStmt);
  161550. if( rc==SQLITE_DONE ){
  161551. rtreeCheckAppendMsg(pCheck, "Mapping (%lld -> %lld) missing from %s table",
  161552. iKey, iVal, (bLeaf ? "%_rowid" : "%_parent")
  161553. );
  161554. }else if( rc==SQLITE_ROW ){
  161555. i64 ii = sqlite3_column_int64(pStmt, 0);
  161556. if( ii!=iVal ){
  161557. rtreeCheckAppendMsg(pCheck,
  161558. "Found (%lld -> %lld) in %s table, expected (%lld -> %lld)",
  161559. iKey, ii, (bLeaf ? "%_rowid" : "%_parent"), iKey, iVal
  161560. );
  161561. }
  161562. }
  161563. rtreeCheckReset(pCheck, pStmt);
  161564. }
  161565. /*
  161566. ** Argument pCell points to an array of coordinates stored on an rtree page.
  161567. ** This function checks that the coordinates are internally consistent (no
  161568. ** x1>x2 conditions) and adds an error message to the RtreeCheck object
  161569. ** if they are not.
  161570. **
  161571. ** Additionally, if pParent is not NULL, then it is assumed to point to
  161572. ** the array of coordinates on the parent page that bound the page
  161573. ** containing pCell. In this case it is also verified that the two
  161574. ** sets of coordinates are mutually consistent and an error message added
  161575. ** to the RtreeCheck object if they are not.
  161576. */
  161577. static void rtreeCheckCellCoord(
  161578. RtreeCheck *pCheck,
  161579. i64 iNode, /* Node id to use in error messages */
  161580. int iCell, /* Cell number to use in error messages */
  161581. u8 *pCell, /* Pointer to cell coordinates */
  161582. u8 *pParent /* Pointer to parent coordinates */
  161583. ){
  161584. RtreeCoord c1, c2;
  161585. RtreeCoord p1, p2;
  161586. int i;
  161587. for(i=0; i<pCheck->nDim; i++){
  161588. readCoord(&pCell[4*2*i], &c1);
  161589. readCoord(&pCell[4*(2*i + 1)], &c2);
  161590. /* printf("%e, %e\n", c1.u.f, c2.u.f); */
  161591. if( pCheck->bInt ? c1.i>c2.i : c1.f>c2.f ){
  161592. rtreeCheckAppendMsg(pCheck,
  161593. "Dimension %d of cell %d on node %lld is corrupt", i, iCell, iNode
  161594. );
  161595. }
  161596. if( pParent ){
  161597. readCoord(&pParent[4*2*i], &p1);
  161598. readCoord(&pParent[4*(2*i + 1)], &p2);
  161599. if( (pCheck->bInt ? c1.i<p1.i : c1.f<p1.f)
  161600. || (pCheck->bInt ? c2.i>p2.i : c2.f>p2.f)
  161601. ){
  161602. rtreeCheckAppendMsg(pCheck,
  161603. "Dimension %d of cell %d on node %lld is corrupt relative to parent"
  161604. , i, iCell, iNode
  161605. );
  161606. }
  161607. }
  161608. }
  161609. }
  161610. /*
  161611. ** Run rtreecheck() checks on node iNode, which is at depth iDepth within
  161612. ** the r-tree structure. Argument aParent points to the array of coordinates
  161613. ** that bound node iNode on the parent node.
  161614. **
  161615. ** If any problems are discovered, an error message is appended to the
  161616. ** report accumulated in the RtreeCheck object.
  161617. */
  161618. static void rtreeCheckNode(
  161619. RtreeCheck *pCheck,
  161620. int iDepth, /* Depth of iNode (0==leaf) */
  161621. u8 *aParent, /* Buffer containing parent coords */
  161622. i64 iNode /* Node to check */
  161623. ){
  161624. u8 *aNode = 0;
  161625. int nNode = 0;
  161626. assert( iNode==1 || aParent!=0 );
  161627. assert( pCheck->nDim>0 );
  161628. aNode = rtreeCheckGetNode(pCheck, iNode, &nNode);
  161629. if( aNode ){
  161630. if( nNode<4 ){
  161631. rtreeCheckAppendMsg(pCheck,
  161632. "Node %lld is too small (%d bytes)", iNode, nNode
  161633. );
  161634. }else{
  161635. int nCell; /* Number of cells on page */
  161636. int i; /* Used to iterate through cells */
  161637. if( aParent==0 ){
  161638. iDepth = readInt16(aNode);
  161639. if( iDepth>RTREE_MAX_DEPTH ){
  161640. rtreeCheckAppendMsg(pCheck, "Rtree depth out of range (%d)", iDepth);
  161641. sqlite3_free(aNode);
  161642. return;
  161643. }
  161644. }
  161645. nCell = readInt16(&aNode[2]);
  161646. if( (4 + nCell*(8 + pCheck->nDim*2*4))>nNode ){
  161647. rtreeCheckAppendMsg(pCheck,
  161648. "Node %lld is too small for cell count of %d (%d bytes)",
  161649. iNode, nCell, nNode
  161650. );
  161651. }else{
  161652. for(i=0; i<nCell; i++){
  161653. u8 *pCell = &aNode[4 + i*(8 + pCheck->nDim*2*4)];
  161654. i64 iVal = readInt64(pCell);
  161655. rtreeCheckCellCoord(pCheck, iNode, i, &pCell[8], aParent);
  161656. if( iDepth>0 ){
  161657. rtreeCheckMapping(pCheck, 0, iVal, iNode);
  161658. rtreeCheckNode(pCheck, iDepth-1, &pCell[8], iVal);
  161659. pCheck->nNonLeaf++;
  161660. }else{
  161661. rtreeCheckMapping(pCheck, 1, iVal, iNode);
  161662. pCheck->nLeaf++;
  161663. }
  161664. }
  161665. }
  161666. }
  161667. sqlite3_free(aNode);
  161668. }
  161669. }
  161670. /*
  161671. ** The second argument to this function must be either "_rowid" or
  161672. ** "_parent". This function checks that the number of entries in the
  161673. ** %_rowid or %_parent table is exactly nExpect. If not, it adds
  161674. ** an error message to the report in the RtreeCheck object indicated
  161675. ** by the first argument.
  161676. */
  161677. static void rtreeCheckCount(RtreeCheck *pCheck, const char *zTbl, i64 nExpect){
  161678. if( pCheck->rc==SQLITE_OK ){
  161679. sqlite3_stmt *pCount;
  161680. pCount = rtreeCheckPrepare(pCheck, "SELECT count(*) FROM %Q.'%q%s'",
  161681. pCheck->zDb, pCheck->zTab, zTbl
  161682. );
  161683. if( pCount ){
  161684. if( sqlite3_step(pCount)==SQLITE_ROW ){
  161685. i64 nActual = sqlite3_column_int64(pCount, 0);
  161686. if( nActual!=nExpect ){
  161687. rtreeCheckAppendMsg(pCheck, "Wrong number of entries in %%%s table"
  161688. " - expected %lld, actual %lld" , zTbl, nExpect, nActual
  161689. );
  161690. }
  161691. }
  161692. pCheck->rc = sqlite3_finalize(pCount);
  161693. }
  161694. }
  161695. }
  161696. /*
  161697. ** This function does the bulk of the work for the rtree integrity-check.
  161698. ** It is called by rtreecheck(), which is the SQL function implementation.
  161699. */
  161700. static int rtreeCheckTable(
  161701. sqlite3 *db, /* Database handle to access db through */
  161702. const char *zDb, /* Name of db ("main", "temp" etc.) */
  161703. const char *zTab, /* Name of rtree table to check */
  161704. char **pzReport /* OUT: sqlite3_malloc'd report text */
  161705. ){
  161706. RtreeCheck check; /* Common context for various routines */
  161707. sqlite3_stmt *pStmt = 0; /* Used to find column count of rtree table */
  161708. int bEnd = 0; /* True if transaction should be closed */
  161709. /* Initialize the context object */
  161710. memset(&check, 0, sizeof(check));
  161711. check.db = db;
  161712. check.zDb = zDb;
  161713. check.zTab = zTab;
  161714. /* If there is not already an open transaction, open one now. This is
  161715. ** to ensure that the queries run as part of this integrity-check operate
  161716. ** on a consistent snapshot. */
  161717. if( sqlite3_get_autocommit(db) ){
  161718. check.rc = sqlite3_exec(db, "BEGIN", 0, 0, 0);
  161719. bEnd = 1;
  161720. }
  161721. /* Find number of dimensions in the rtree table. */
  161722. pStmt = rtreeCheckPrepare(&check, "SELECT * FROM %Q.%Q", zDb, zTab);
  161723. if( pStmt ){
  161724. int rc;
  161725. check.nDim = (sqlite3_column_count(pStmt) - 1) / 2;
  161726. if( check.nDim<1 ){
  161727. rtreeCheckAppendMsg(&check, "Schema corrupt or not an rtree");
  161728. }else if( SQLITE_ROW==sqlite3_step(pStmt) ){
  161729. check.bInt = (sqlite3_column_type(pStmt, 1)==SQLITE_INTEGER);
  161730. }
  161731. rc = sqlite3_finalize(pStmt);
  161732. if( rc!=SQLITE_CORRUPT ) check.rc = rc;
  161733. }
  161734. /* Do the actual integrity-check */
  161735. if( check.nDim>=1 ){
  161736. if( check.rc==SQLITE_OK ){
  161737. rtreeCheckNode(&check, 0, 0, 1);
  161738. }
  161739. rtreeCheckCount(&check, "_rowid", check.nLeaf);
  161740. rtreeCheckCount(&check, "_parent", check.nNonLeaf);
  161741. }
  161742. /* Finalize SQL statements used by the integrity-check */
  161743. sqlite3_finalize(check.pGetNode);
  161744. sqlite3_finalize(check.aCheckMapping[0]);
  161745. sqlite3_finalize(check.aCheckMapping[1]);
  161746. /* If one was opened, close the transaction */
  161747. if( bEnd ){
  161748. int rc = sqlite3_exec(db, "END", 0, 0, 0);
  161749. if( check.rc==SQLITE_OK ) check.rc = rc;
  161750. }
  161751. *pzReport = check.zReport;
  161752. return check.rc;
  161753. }
  161754. /*
  161755. ** Usage:
  161756. **
  161757. ** rtreecheck(<rtree-table>);
  161758. ** rtreecheck(<database>, <rtree-table>);
  161759. **
  161760. ** Invoking this SQL function runs an integrity-check on the named rtree
  161761. ** table. The integrity-check verifies the following:
  161762. **
  161763. ** 1. For each cell in the r-tree structure (%_node table), that:
  161764. **
  161765. ** a) for each dimension, (coord1 <= coord2).
  161766. **
  161767. ** b) unless the cell is on the root node, that the cell is bounded
  161768. ** by the parent cell on the parent node.
  161769. **
  161770. ** c) for leaf nodes, that there is an entry in the %_rowid
  161771. ** table corresponding to the cell's rowid value that
  161772. ** points to the correct node.
  161773. **
  161774. ** d) for cells on non-leaf nodes, that there is an entry in the
  161775. ** %_parent table mapping from the cell's child node to the
  161776. ** node that it resides on.
  161777. **
  161778. ** 2. That there are the same number of entries in the %_rowid table
  161779. ** as there are leaf cells in the r-tree structure, and that there
  161780. ** is a leaf cell that corresponds to each entry in the %_rowid table.
  161781. **
  161782. ** 3. That there are the same number of entries in the %_parent table
  161783. ** as there are non-leaf cells in the r-tree structure, and that
  161784. ** there is a non-leaf cell that corresponds to each entry in the
  161785. ** %_parent table.
  161786. */
  161787. static void rtreecheck(
  161788. sqlite3_context *ctx,
  161789. int nArg,
  161790. sqlite3_value **apArg
  161791. ){
  161792. if( nArg!=1 && nArg!=2 ){
  161793. sqlite3_result_error(ctx,
  161794. "wrong number of arguments to function rtreecheck()", -1
  161795. );
  161796. }else{
  161797. int rc;
  161798. char *zReport = 0;
  161799. const char *zDb = (const char*)sqlite3_value_text(apArg[0]);
  161800. const char *zTab;
  161801. if( nArg==1 ){
  161802. zTab = zDb;
  161803. zDb = "main";
  161804. }else{
  161805. zTab = (const char*)sqlite3_value_text(apArg[1]);
  161806. }
  161807. rc = rtreeCheckTable(sqlite3_context_db_handle(ctx), zDb, zTab, &zReport);
  161808. if( rc==SQLITE_OK ){
  161809. sqlite3_result_text(ctx, zReport ? zReport : "ok", -1, SQLITE_TRANSIENT);
  161810. }else{
  161811. sqlite3_result_error_code(ctx, rc);
  161812. }
  161813. sqlite3_free(zReport);
  161814. }
  161815. }
  161816. /*
  161817. ** Register the r-tree module with database handle db. This creates the
  161818. ** virtual table module "rtree" and the debugging/analysis scalar
  161819. ** function "rtreenode".
  161820. */
  161821. SQLITE_PRIVATE int sqlite3RtreeInit(sqlite3 *db){
  161822. const int utf8 = SQLITE_UTF8;
  161823. int rc;
  161824. rc = sqlite3_create_function(db, "rtreenode", 2, utf8, 0, rtreenode, 0, 0);
  161825. if( rc==SQLITE_OK ){
  161826. rc = sqlite3_create_function(db, "rtreedepth", 1, utf8, 0,rtreedepth, 0, 0);
  161827. }
  161828. if( rc==SQLITE_OK ){
  161829. rc = sqlite3_create_function(db, "rtreecheck", -1, utf8, 0,rtreecheck, 0,0);
  161830. }
  161831. if( rc==SQLITE_OK ){
  161832. #ifdef SQLITE_RTREE_INT_ONLY
  161833. void *c = (void *)RTREE_COORD_INT32;
  161834. #else
  161835. void *c = (void *)RTREE_COORD_REAL32;
  161836. #endif
  161837. rc = sqlite3_create_module_v2(db, "rtree", &rtreeModule, c, 0);
  161838. }
  161839. if( rc==SQLITE_OK ){
  161840. void *c = (void *)RTREE_COORD_INT32;
  161841. rc = sqlite3_create_module_v2(db, "rtree_i32", &rtreeModule, c, 0);
  161842. }
  161843. return rc;
  161844. }
  161845. /*
  161846. ** This routine deletes the RtreeGeomCallback object that was attached
  161847. ** one of the SQL functions create by sqlite3_rtree_geometry_callback()
  161848. ** or sqlite3_rtree_query_callback(). In other words, this routine is the
  161849. ** destructor for an RtreeGeomCallback objecct. This routine is called when
  161850. ** the corresponding SQL function is deleted.
  161851. */
  161852. static void rtreeFreeCallback(void *p){
  161853. RtreeGeomCallback *pInfo = (RtreeGeomCallback*)p;
  161854. if( pInfo->xDestructor ) pInfo->xDestructor(pInfo->pContext);
  161855. sqlite3_free(p);
  161856. }
  161857. /*
  161858. ** This routine frees the BLOB that is returned by geomCallback().
  161859. */
  161860. static void rtreeMatchArgFree(void *pArg){
  161861. int i;
  161862. RtreeMatchArg *p = (RtreeMatchArg*)pArg;
  161863. for(i=0; i<p->nParam; i++){
  161864. sqlite3_value_free(p->apSqlParam[i]);
  161865. }
  161866. sqlite3_free(p);
  161867. }
  161868. /*
  161869. ** Each call to sqlite3_rtree_geometry_callback() or
  161870. ** sqlite3_rtree_query_callback() creates an ordinary SQLite
  161871. ** scalar function that is implemented by this routine.
  161872. **
  161873. ** All this function does is construct an RtreeMatchArg object that
  161874. ** contains the geometry-checking callback routines and a list of
  161875. ** parameters to this function, then return that RtreeMatchArg object
  161876. ** as a BLOB.
  161877. **
  161878. ** The R-Tree MATCH operator will read the returned BLOB, deserialize
  161879. ** the RtreeMatchArg object, and use the RtreeMatchArg object to figure
  161880. ** out which elements of the R-Tree should be returned by the query.
  161881. */
  161882. static void geomCallback(sqlite3_context *ctx, int nArg, sqlite3_value **aArg){
  161883. RtreeGeomCallback *pGeomCtx = (RtreeGeomCallback *)sqlite3_user_data(ctx);
  161884. RtreeMatchArg *pBlob;
  161885. int nBlob;
  161886. int memErr = 0;
  161887. nBlob = sizeof(RtreeMatchArg) + (nArg-1)*sizeof(RtreeDValue)
  161888. + nArg*sizeof(sqlite3_value*);
  161889. pBlob = (RtreeMatchArg *)sqlite3_malloc(nBlob);
  161890. if( !pBlob ){
  161891. sqlite3_result_error_nomem(ctx);
  161892. }else{
  161893. int i;
  161894. pBlob->iSize = nBlob;
  161895. pBlob->cb = pGeomCtx[0];
  161896. pBlob->apSqlParam = (sqlite3_value**)&pBlob->aParam[nArg];
  161897. pBlob->nParam = nArg;
  161898. for(i=0; i<nArg; i++){
  161899. pBlob->apSqlParam[i] = sqlite3_value_dup(aArg[i]);
  161900. if( pBlob->apSqlParam[i]==0 ) memErr = 1;
  161901. #ifdef SQLITE_RTREE_INT_ONLY
  161902. pBlob->aParam[i] = sqlite3_value_int64(aArg[i]);
  161903. #else
  161904. pBlob->aParam[i] = sqlite3_value_double(aArg[i]);
  161905. #endif
  161906. }
  161907. if( memErr ){
  161908. sqlite3_result_error_nomem(ctx);
  161909. rtreeMatchArgFree(pBlob);
  161910. }else{
  161911. sqlite3_result_pointer(ctx, pBlob, "RtreeMatchArg", rtreeMatchArgFree);
  161912. }
  161913. }
  161914. }
  161915. /*
  161916. ** Register a new geometry function for use with the r-tree MATCH operator.
  161917. */
  161918. SQLITE_API int sqlite3_rtree_geometry_callback(
  161919. sqlite3 *db, /* Register SQL function on this connection */
  161920. const char *zGeom, /* Name of the new SQL function */
  161921. int (*xGeom)(sqlite3_rtree_geometry*,int,RtreeDValue*,int*), /* Callback */
  161922. void *pContext /* Extra data associated with the callback */
  161923. ){
  161924. RtreeGeomCallback *pGeomCtx; /* Context object for new user-function */
  161925. /* Allocate and populate the context object. */
  161926. pGeomCtx = (RtreeGeomCallback *)sqlite3_malloc(sizeof(RtreeGeomCallback));
  161927. if( !pGeomCtx ) return SQLITE_NOMEM;
  161928. pGeomCtx->xGeom = xGeom;
  161929. pGeomCtx->xQueryFunc = 0;
  161930. pGeomCtx->xDestructor = 0;
  161931. pGeomCtx->pContext = pContext;
  161932. return sqlite3_create_function_v2(db, zGeom, -1, SQLITE_ANY,
  161933. (void *)pGeomCtx, geomCallback, 0, 0, rtreeFreeCallback
  161934. );
  161935. }
  161936. /*
  161937. ** Register a new 2nd-generation geometry function for use with the
  161938. ** r-tree MATCH operator.
  161939. */
  161940. SQLITE_API int sqlite3_rtree_query_callback(
  161941. sqlite3 *db, /* Register SQL function on this connection */
  161942. const char *zQueryFunc, /* Name of new SQL function */
  161943. int (*xQueryFunc)(sqlite3_rtree_query_info*), /* Callback */
  161944. void *pContext, /* Extra data passed into the callback */
  161945. void (*xDestructor)(void*) /* Destructor for the extra data */
  161946. ){
  161947. RtreeGeomCallback *pGeomCtx; /* Context object for new user-function */
  161948. /* Allocate and populate the context object. */
  161949. pGeomCtx = (RtreeGeomCallback *)sqlite3_malloc(sizeof(RtreeGeomCallback));
  161950. if( !pGeomCtx ) return SQLITE_NOMEM;
  161951. pGeomCtx->xGeom = 0;
  161952. pGeomCtx->xQueryFunc = xQueryFunc;
  161953. pGeomCtx->xDestructor = xDestructor;
  161954. pGeomCtx->pContext = pContext;
  161955. return sqlite3_create_function_v2(db, zQueryFunc, -1, SQLITE_ANY,
  161956. (void *)pGeomCtx, geomCallback, 0, 0, rtreeFreeCallback
  161957. );
  161958. }
  161959. #if !SQLITE_CORE
  161960. #ifdef _WIN32
  161961. __declspec(dllexport)
  161962. #endif
  161963. SQLITE_API int sqlite3_rtree_init(
  161964. sqlite3 *db,
  161965. char **pzErrMsg,
  161966. const sqlite3_api_routines *pApi
  161967. ){
  161968. SQLITE_EXTENSION_INIT2(pApi)
  161969. return sqlite3RtreeInit(db);
  161970. }
  161971. #endif
  161972. #endif
  161973. /************** End of rtree.c ***********************************************/
  161974. /************** Begin file icu.c *********************************************/
  161975. /*
  161976. ** 2007 May 6
  161977. **
  161978. ** The author disclaims copyright to this source code. In place of
  161979. ** a legal notice, here is a blessing:
  161980. **
  161981. ** May you do good and not evil.
  161982. ** May you find forgiveness for yourself and forgive others.
  161983. ** May you share freely, never taking more than you give.
  161984. **
  161985. *************************************************************************
  161986. ** $Id: icu.c,v 1.7 2007/12/13 21:54:11 drh Exp $
  161987. **
  161988. ** This file implements an integration between the ICU library
  161989. ** ("International Components for Unicode", an open-source library
  161990. ** for handling unicode data) and SQLite. The integration uses
  161991. ** ICU to provide the following to SQLite:
  161992. **
  161993. ** * An implementation of the SQL regexp() function (and hence REGEXP
  161994. ** operator) using the ICU uregex_XX() APIs.
  161995. **
  161996. ** * Implementations of the SQL scalar upper() and lower() functions
  161997. ** for case mapping.
  161998. **
  161999. ** * Integration of ICU and SQLite collation sequences.
  162000. **
  162001. ** * An implementation of the LIKE operator that uses ICU to
  162002. ** provide case-independent matching.
  162003. */
  162004. #if !defined(SQLITE_CORE) \
  162005. || defined(SQLITE_ENABLE_ICU) \
  162006. || defined(SQLITE_ENABLE_ICU_COLLATIONS)
  162007. /* Include ICU headers */
  162008. #include <unicode/utypes.h>
  162009. #include <unicode/uregex.h>
  162010. #include <unicode/ustring.h>
  162011. #include <unicode/ucol.h>
  162012. /* #include <assert.h> */
  162013. #ifndef SQLITE_CORE
  162014. /* #include "sqlite3ext.h" */
  162015. SQLITE_EXTENSION_INIT1
  162016. #else
  162017. /* #include "sqlite3.h" */
  162018. #endif
  162019. /*
  162020. ** This function is called when an ICU function called from within
  162021. ** the implementation of an SQL scalar function returns an error.
  162022. **
  162023. ** The scalar function context passed as the first argument is
  162024. ** loaded with an error message based on the following two args.
  162025. */
  162026. static void icuFunctionError(
  162027. sqlite3_context *pCtx, /* SQLite scalar function context */
  162028. const char *zName, /* Name of ICU function that failed */
  162029. UErrorCode e /* Error code returned by ICU function */
  162030. ){
  162031. char zBuf[128];
  162032. sqlite3_snprintf(128, zBuf, "ICU error: %s(): %s", zName, u_errorName(e));
  162033. zBuf[127] = '\0';
  162034. sqlite3_result_error(pCtx, zBuf, -1);
  162035. }
  162036. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_ICU)
  162037. /*
  162038. ** Maximum length (in bytes) of the pattern in a LIKE or GLOB
  162039. ** operator.
  162040. */
  162041. #ifndef SQLITE_MAX_LIKE_PATTERN_LENGTH
  162042. # define SQLITE_MAX_LIKE_PATTERN_LENGTH 50000
  162043. #endif
  162044. /*
  162045. ** Version of sqlite3_free() that is always a function, never a macro.
  162046. */
  162047. static void xFree(void *p){
  162048. sqlite3_free(p);
  162049. }
  162050. /*
  162051. ** This lookup table is used to help decode the first byte of
  162052. ** a multi-byte UTF8 character. It is copied here from SQLite source
  162053. ** code file utf8.c.
  162054. */
  162055. static const unsigned char icuUtf8Trans1[] = {
  162056. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  162057. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  162058. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  162059. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  162060. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  162061. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  162062. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  162063. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  162064. };
  162065. #define SQLITE_ICU_READ_UTF8(zIn, c) \
  162066. c = *(zIn++); \
  162067. if( c>=0xc0 ){ \
  162068. c = icuUtf8Trans1[c-0xc0]; \
  162069. while( (*zIn & 0xc0)==0x80 ){ \
  162070. c = (c<<6) + (0x3f & *(zIn++)); \
  162071. } \
  162072. }
  162073. #define SQLITE_ICU_SKIP_UTF8(zIn) \
  162074. assert( *zIn ); \
  162075. if( *(zIn++)>=0xc0 ){ \
  162076. while( (*zIn & 0xc0)==0x80 ){zIn++;} \
  162077. }
  162078. /*
  162079. ** Compare two UTF-8 strings for equality where the first string is
  162080. ** a "LIKE" expression. Return true (1) if they are the same and
  162081. ** false (0) if they are different.
  162082. */
  162083. static int icuLikeCompare(
  162084. const uint8_t *zPattern, /* LIKE pattern */
  162085. const uint8_t *zString, /* The UTF-8 string to compare against */
  162086. const UChar32 uEsc /* The escape character */
  162087. ){
  162088. static const uint32_t MATCH_ONE = (uint32_t)'_';
  162089. static const uint32_t MATCH_ALL = (uint32_t)'%';
  162090. int prevEscape = 0; /* True if the previous character was uEsc */
  162091. while( 1 ){
  162092. /* Read (and consume) the next character from the input pattern. */
  162093. uint32_t uPattern;
  162094. SQLITE_ICU_READ_UTF8(zPattern, uPattern);
  162095. if( uPattern==0 ) break;
  162096. /* There are now 4 possibilities:
  162097. **
  162098. ** 1. uPattern is an unescaped match-all character "%",
  162099. ** 2. uPattern is an unescaped match-one character "_",
  162100. ** 3. uPattern is an unescaped escape character, or
  162101. ** 4. uPattern is to be handled as an ordinary character
  162102. */
  162103. if( !prevEscape && uPattern==MATCH_ALL ){
  162104. /* Case 1. */
  162105. uint8_t c;
  162106. /* Skip any MATCH_ALL or MATCH_ONE characters that follow a
  162107. ** MATCH_ALL. For each MATCH_ONE, skip one character in the
  162108. ** test string.
  162109. */
  162110. while( (c=*zPattern) == MATCH_ALL || c == MATCH_ONE ){
  162111. if( c==MATCH_ONE ){
  162112. if( *zString==0 ) return 0;
  162113. SQLITE_ICU_SKIP_UTF8(zString);
  162114. }
  162115. zPattern++;
  162116. }
  162117. if( *zPattern==0 ) return 1;
  162118. while( *zString ){
  162119. if( icuLikeCompare(zPattern, zString, uEsc) ){
  162120. return 1;
  162121. }
  162122. SQLITE_ICU_SKIP_UTF8(zString);
  162123. }
  162124. return 0;
  162125. }else if( !prevEscape && uPattern==MATCH_ONE ){
  162126. /* Case 2. */
  162127. if( *zString==0 ) return 0;
  162128. SQLITE_ICU_SKIP_UTF8(zString);
  162129. }else if( !prevEscape && uPattern==(uint32_t)uEsc){
  162130. /* Case 3. */
  162131. prevEscape = 1;
  162132. }else{
  162133. /* Case 4. */
  162134. uint32_t uString;
  162135. SQLITE_ICU_READ_UTF8(zString, uString);
  162136. uString = (uint32_t)u_foldCase((UChar32)uString, U_FOLD_CASE_DEFAULT);
  162137. uPattern = (uint32_t)u_foldCase((UChar32)uPattern, U_FOLD_CASE_DEFAULT);
  162138. if( uString!=uPattern ){
  162139. return 0;
  162140. }
  162141. prevEscape = 0;
  162142. }
  162143. }
  162144. return *zString==0;
  162145. }
  162146. /*
  162147. ** Implementation of the like() SQL function. This function implements
  162148. ** the build-in LIKE operator. The first argument to the function is the
  162149. ** pattern and the second argument is the string. So, the SQL statements:
  162150. **
  162151. ** A LIKE B
  162152. **
  162153. ** is implemented as like(B, A). If there is an escape character E,
  162154. **
  162155. ** A LIKE B ESCAPE E
  162156. **
  162157. ** is mapped to like(B, A, E).
  162158. */
  162159. static void icuLikeFunc(
  162160. sqlite3_context *context,
  162161. int argc,
  162162. sqlite3_value **argv
  162163. ){
  162164. const unsigned char *zA = sqlite3_value_text(argv[0]);
  162165. const unsigned char *zB = sqlite3_value_text(argv[1]);
  162166. UChar32 uEsc = 0;
  162167. /* Limit the length of the LIKE or GLOB pattern to avoid problems
  162168. ** of deep recursion and N*N behavior in patternCompare().
  162169. */
  162170. if( sqlite3_value_bytes(argv[0])>SQLITE_MAX_LIKE_PATTERN_LENGTH ){
  162171. sqlite3_result_error(context, "LIKE or GLOB pattern too complex", -1);
  162172. return;
  162173. }
  162174. if( argc==3 ){
  162175. /* The escape character string must consist of a single UTF-8 character.
  162176. ** Otherwise, return an error.
  162177. */
  162178. int nE= sqlite3_value_bytes(argv[2]);
  162179. const unsigned char *zE = sqlite3_value_text(argv[2]);
  162180. int i = 0;
  162181. if( zE==0 ) return;
  162182. U8_NEXT(zE, i, nE, uEsc);
  162183. if( i!=nE){
  162184. sqlite3_result_error(context,
  162185. "ESCAPE expression must be a single character", -1);
  162186. return;
  162187. }
  162188. }
  162189. if( zA && zB ){
  162190. sqlite3_result_int(context, icuLikeCompare(zA, zB, uEsc));
  162191. }
  162192. }
  162193. /*
  162194. ** Function to delete compiled regexp objects. Registered as
  162195. ** a destructor function with sqlite3_set_auxdata().
  162196. */
  162197. static void icuRegexpDelete(void *p){
  162198. URegularExpression *pExpr = (URegularExpression *)p;
  162199. uregex_close(pExpr);
  162200. }
  162201. /*
  162202. ** Implementation of SQLite REGEXP operator. This scalar function takes
  162203. ** two arguments. The first is a regular expression pattern to compile
  162204. ** the second is a string to match against that pattern. If either
  162205. ** argument is an SQL NULL, then NULL Is returned. Otherwise, the result
  162206. ** is 1 if the string matches the pattern, or 0 otherwise.
  162207. **
  162208. ** SQLite maps the regexp() function to the regexp() operator such
  162209. ** that the following two are equivalent:
  162210. **
  162211. ** zString REGEXP zPattern
  162212. ** regexp(zPattern, zString)
  162213. **
  162214. ** Uses the following ICU regexp APIs:
  162215. **
  162216. ** uregex_open()
  162217. ** uregex_matches()
  162218. ** uregex_close()
  162219. */
  162220. static void icuRegexpFunc(sqlite3_context *p, int nArg, sqlite3_value **apArg){
  162221. UErrorCode status = U_ZERO_ERROR;
  162222. URegularExpression *pExpr;
  162223. UBool res;
  162224. const UChar *zString = sqlite3_value_text16(apArg[1]);
  162225. (void)nArg; /* Unused parameter */
  162226. /* If the left hand side of the regexp operator is NULL,
  162227. ** then the result is also NULL.
  162228. */
  162229. if( !zString ){
  162230. return;
  162231. }
  162232. pExpr = sqlite3_get_auxdata(p, 0);
  162233. if( !pExpr ){
  162234. const UChar *zPattern = sqlite3_value_text16(apArg[0]);
  162235. if( !zPattern ){
  162236. return;
  162237. }
  162238. pExpr = uregex_open(zPattern, -1, 0, 0, &status);
  162239. if( U_SUCCESS(status) ){
  162240. sqlite3_set_auxdata(p, 0, pExpr, icuRegexpDelete);
  162241. }else{
  162242. assert(!pExpr);
  162243. icuFunctionError(p, "uregex_open", status);
  162244. return;
  162245. }
  162246. }
  162247. /* Configure the text that the regular expression operates on. */
  162248. uregex_setText(pExpr, zString, -1, &status);
  162249. if( !U_SUCCESS(status) ){
  162250. icuFunctionError(p, "uregex_setText", status);
  162251. return;
  162252. }
  162253. /* Attempt the match */
  162254. res = uregex_matches(pExpr, 0, &status);
  162255. if( !U_SUCCESS(status) ){
  162256. icuFunctionError(p, "uregex_matches", status);
  162257. return;
  162258. }
  162259. /* Set the text that the regular expression operates on to a NULL
  162260. ** pointer. This is not really necessary, but it is tidier than
  162261. ** leaving the regular expression object configured with an invalid
  162262. ** pointer after this function returns.
  162263. */
  162264. uregex_setText(pExpr, 0, 0, &status);
  162265. /* Return 1 or 0. */
  162266. sqlite3_result_int(p, res ? 1 : 0);
  162267. }
  162268. /*
  162269. ** Implementations of scalar functions for case mapping - upper() and
  162270. ** lower(). Function upper() converts its input to upper-case (ABC).
  162271. ** Function lower() converts to lower-case (abc).
  162272. **
  162273. ** ICU provides two types of case mapping, "general" case mapping and
  162274. ** "language specific". Refer to ICU documentation for the differences
  162275. ** between the two.
  162276. **
  162277. ** To utilise "general" case mapping, the upper() or lower() scalar
  162278. ** functions are invoked with one argument:
  162279. **
  162280. ** upper('ABC') -> 'abc'
  162281. ** lower('abc') -> 'ABC'
  162282. **
  162283. ** To access ICU "language specific" case mapping, upper() or lower()
  162284. ** should be invoked with two arguments. The second argument is the name
  162285. ** of the locale to use. Passing an empty string ("") or SQL NULL value
  162286. ** as the second argument is the same as invoking the 1 argument version
  162287. ** of upper() or lower().
  162288. **
  162289. ** lower('I', 'en_us') -> 'i'
  162290. ** lower('I', 'tr_tr') -> '\u131' (small dotless i)
  162291. **
  162292. ** http://www.icu-project.org/userguide/posix.html#case_mappings
  162293. */
  162294. static void icuCaseFunc16(sqlite3_context *p, int nArg, sqlite3_value **apArg){
  162295. const UChar *zInput; /* Pointer to input string */
  162296. UChar *zOutput = 0; /* Pointer to output buffer */
  162297. int nInput; /* Size of utf-16 input string in bytes */
  162298. int nOut; /* Size of output buffer in bytes */
  162299. int cnt;
  162300. int bToUpper; /* True for toupper(), false for tolower() */
  162301. UErrorCode status;
  162302. const char *zLocale = 0;
  162303. assert(nArg==1 || nArg==2);
  162304. bToUpper = (sqlite3_user_data(p)!=0);
  162305. if( nArg==2 ){
  162306. zLocale = (const char *)sqlite3_value_text(apArg[1]);
  162307. }
  162308. zInput = sqlite3_value_text16(apArg[0]);
  162309. if( !zInput ){
  162310. return;
  162311. }
  162312. nOut = nInput = sqlite3_value_bytes16(apArg[0]);
  162313. if( nOut==0 ){
  162314. sqlite3_result_text16(p, "", 0, SQLITE_STATIC);
  162315. return;
  162316. }
  162317. for(cnt=0; cnt<2; cnt++){
  162318. UChar *zNew = sqlite3_realloc(zOutput, nOut);
  162319. if( zNew==0 ){
  162320. sqlite3_free(zOutput);
  162321. sqlite3_result_error_nomem(p);
  162322. return;
  162323. }
  162324. zOutput = zNew;
  162325. status = U_ZERO_ERROR;
  162326. if( bToUpper ){
  162327. nOut = 2*u_strToUpper(zOutput,nOut/2,zInput,nInput/2,zLocale,&status);
  162328. }else{
  162329. nOut = 2*u_strToLower(zOutput,nOut/2,zInput,nInput/2,zLocale,&status);
  162330. }
  162331. if( U_SUCCESS(status) ){
  162332. sqlite3_result_text16(p, zOutput, nOut, xFree);
  162333. }else if( status==U_BUFFER_OVERFLOW_ERROR ){
  162334. assert( cnt==0 );
  162335. continue;
  162336. }else{
  162337. icuFunctionError(p, bToUpper ? "u_strToUpper" : "u_strToLower", status);
  162338. }
  162339. return;
  162340. }
  162341. assert( 0 ); /* Unreachable */
  162342. }
  162343. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_ICU) */
  162344. /*
  162345. ** Collation sequence destructor function. The pCtx argument points to
  162346. ** a UCollator structure previously allocated using ucol_open().
  162347. */
  162348. static void icuCollationDel(void *pCtx){
  162349. UCollator *p = (UCollator *)pCtx;
  162350. ucol_close(p);
  162351. }
  162352. /*
  162353. ** Collation sequence comparison function. The pCtx argument points to
  162354. ** a UCollator structure previously allocated using ucol_open().
  162355. */
  162356. static int icuCollationColl(
  162357. void *pCtx,
  162358. int nLeft,
  162359. const void *zLeft,
  162360. int nRight,
  162361. const void *zRight
  162362. ){
  162363. UCollationResult res;
  162364. UCollator *p = (UCollator *)pCtx;
  162365. res = ucol_strcoll(p, (UChar *)zLeft, nLeft/2, (UChar *)zRight, nRight/2);
  162366. switch( res ){
  162367. case UCOL_LESS: return -1;
  162368. case UCOL_GREATER: return +1;
  162369. case UCOL_EQUAL: return 0;
  162370. }
  162371. assert(!"Unexpected return value from ucol_strcoll()");
  162372. return 0;
  162373. }
  162374. /*
  162375. ** Implementation of the scalar function icu_load_collation().
  162376. **
  162377. ** This scalar function is used to add ICU collation based collation
  162378. ** types to an SQLite database connection. It is intended to be called
  162379. ** as follows:
  162380. **
  162381. ** SELECT icu_load_collation(<locale>, <collation-name>);
  162382. **
  162383. ** Where <locale> is a string containing an ICU locale identifier (i.e.
  162384. ** "en_AU", "tr_TR" etc.) and <collation-name> is the name of the
  162385. ** collation sequence to create.
  162386. */
  162387. static void icuLoadCollation(
  162388. sqlite3_context *p,
  162389. int nArg,
  162390. sqlite3_value **apArg
  162391. ){
  162392. sqlite3 *db = (sqlite3 *)sqlite3_user_data(p);
  162393. UErrorCode status = U_ZERO_ERROR;
  162394. const char *zLocale; /* Locale identifier - (eg. "jp_JP") */
  162395. const char *zName; /* SQL Collation sequence name (eg. "japanese") */
  162396. UCollator *pUCollator; /* ICU library collation object */
  162397. int rc; /* Return code from sqlite3_create_collation_x() */
  162398. assert(nArg==2);
  162399. (void)nArg; /* Unused parameter */
  162400. zLocale = (const char *)sqlite3_value_text(apArg[0]);
  162401. zName = (const char *)sqlite3_value_text(apArg[1]);
  162402. if( !zLocale || !zName ){
  162403. return;
  162404. }
  162405. pUCollator = ucol_open(zLocale, &status);
  162406. if( !U_SUCCESS(status) ){
  162407. icuFunctionError(p, "ucol_open", status);
  162408. return;
  162409. }
  162410. assert(p);
  162411. rc = sqlite3_create_collation_v2(db, zName, SQLITE_UTF16, (void *)pUCollator,
  162412. icuCollationColl, icuCollationDel
  162413. );
  162414. if( rc!=SQLITE_OK ){
  162415. ucol_close(pUCollator);
  162416. sqlite3_result_error(p, "Error registering collation function", -1);
  162417. }
  162418. }
  162419. /*
  162420. ** Register the ICU extension functions with database db.
  162421. */
  162422. SQLITE_PRIVATE int sqlite3IcuInit(sqlite3 *db){
  162423. static const struct IcuScalar {
  162424. const char *zName; /* Function name */
  162425. unsigned char nArg; /* Number of arguments */
  162426. unsigned short enc; /* Optimal text encoding */
  162427. unsigned char iContext; /* sqlite3_user_data() context */
  162428. void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  162429. } scalars[] = {
  162430. {"icu_load_collation", 2, SQLITE_UTF8, 1, icuLoadCollation},
  162431. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_ICU)
  162432. {"regexp", 2, SQLITE_ANY|SQLITE_DETERMINISTIC, 0, icuRegexpFunc},
  162433. {"lower", 1, SQLITE_UTF16|SQLITE_DETERMINISTIC, 0, icuCaseFunc16},
  162434. {"lower", 2, SQLITE_UTF16|SQLITE_DETERMINISTIC, 0, icuCaseFunc16},
  162435. {"upper", 1, SQLITE_UTF16|SQLITE_DETERMINISTIC, 1, icuCaseFunc16},
  162436. {"upper", 2, SQLITE_UTF16|SQLITE_DETERMINISTIC, 1, icuCaseFunc16},
  162437. {"lower", 1, SQLITE_UTF8|SQLITE_DETERMINISTIC, 0, icuCaseFunc16},
  162438. {"lower", 2, SQLITE_UTF8|SQLITE_DETERMINISTIC, 0, icuCaseFunc16},
  162439. {"upper", 1, SQLITE_UTF8|SQLITE_DETERMINISTIC, 1, icuCaseFunc16},
  162440. {"upper", 2, SQLITE_UTF8|SQLITE_DETERMINISTIC, 1, icuCaseFunc16},
  162441. {"like", 2, SQLITE_UTF8|SQLITE_DETERMINISTIC, 0, icuLikeFunc},
  162442. {"like", 3, SQLITE_UTF8|SQLITE_DETERMINISTIC, 0, icuLikeFunc},
  162443. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_ICU) */
  162444. };
  162445. int rc = SQLITE_OK;
  162446. int i;
  162447. for(i=0; rc==SQLITE_OK && i<(int)(sizeof(scalars)/sizeof(scalars[0])); i++){
  162448. const struct IcuScalar *p = &scalars[i];
  162449. rc = sqlite3_create_function(
  162450. db, p->zName, p->nArg, p->enc,
  162451. p->iContext ? (void*)db : (void*)0,
  162452. p->xFunc, 0, 0
  162453. );
  162454. }
  162455. return rc;
  162456. }
  162457. #if !SQLITE_CORE
  162458. #ifdef _WIN32
  162459. __declspec(dllexport)
  162460. #endif
  162461. SQLITE_API int sqlite3_icu_init(
  162462. sqlite3 *db,
  162463. char **pzErrMsg,
  162464. const sqlite3_api_routines *pApi
  162465. ){
  162466. SQLITE_EXTENSION_INIT2(pApi)
  162467. return sqlite3IcuInit(db);
  162468. }
  162469. #endif
  162470. #endif
  162471. /************** End of icu.c *************************************************/
  162472. /************** Begin file fts3_icu.c ****************************************/
  162473. /*
  162474. ** 2007 June 22
  162475. **
  162476. ** The author disclaims copyright to this source code. In place of
  162477. ** a legal notice, here is a blessing:
  162478. **
  162479. ** May you do good and not evil.
  162480. ** May you find forgiveness for yourself and forgive others.
  162481. ** May you share freely, never taking more than you give.
  162482. **
  162483. *************************************************************************
  162484. ** This file implements a tokenizer for fts3 based on the ICU library.
  162485. */
  162486. /* #include "fts3Int.h" */
  162487. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
  162488. #ifdef SQLITE_ENABLE_ICU
  162489. /* #include <assert.h> */
  162490. /* #include <string.h> */
  162491. /* #include "fts3_tokenizer.h" */
  162492. #include <unicode/ubrk.h>
  162493. /* #include <unicode/ucol.h> */
  162494. /* #include <unicode/ustring.h> */
  162495. #include <unicode/utf16.h>
  162496. typedef struct IcuTokenizer IcuTokenizer;
  162497. typedef struct IcuCursor IcuCursor;
  162498. struct IcuTokenizer {
  162499. sqlite3_tokenizer base;
  162500. char *zLocale;
  162501. };
  162502. struct IcuCursor {
  162503. sqlite3_tokenizer_cursor base;
  162504. UBreakIterator *pIter; /* ICU break-iterator object */
  162505. int nChar; /* Number of UChar elements in pInput */
  162506. UChar *aChar; /* Copy of input using utf-16 encoding */
  162507. int *aOffset; /* Offsets of each character in utf-8 input */
  162508. int nBuffer;
  162509. char *zBuffer;
  162510. int iToken;
  162511. };
  162512. /*
  162513. ** Create a new tokenizer instance.
  162514. */
  162515. static int icuCreate(
  162516. int argc, /* Number of entries in argv[] */
  162517. const char * const *argv, /* Tokenizer creation arguments */
  162518. sqlite3_tokenizer **ppTokenizer /* OUT: Created tokenizer */
  162519. ){
  162520. IcuTokenizer *p;
  162521. int n = 0;
  162522. if( argc>0 ){
  162523. n = strlen(argv[0])+1;
  162524. }
  162525. p = (IcuTokenizer *)sqlite3_malloc(sizeof(IcuTokenizer)+n);
  162526. if( !p ){
  162527. return SQLITE_NOMEM;
  162528. }
  162529. memset(p, 0, sizeof(IcuTokenizer));
  162530. if( n ){
  162531. p->zLocale = (char *)&p[1];
  162532. memcpy(p->zLocale, argv[0], n);
  162533. }
  162534. *ppTokenizer = (sqlite3_tokenizer *)p;
  162535. return SQLITE_OK;
  162536. }
  162537. /*
  162538. ** Destroy a tokenizer
  162539. */
  162540. static int icuDestroy(sqlite3_tokenizer *pTokenizer){
  162541. IcuTokenizer *p = (IcuTokenizer *)pTokenizer;
  162542. sqlite3_free(p);
  162543. return SQLITE_OK;
  162544. }
  162545. /*
  162546. ** Prepare to begin tokenizing a particular string. The input
  162547. ** string to be tokenized is pInput[0..nBytes-1]. A cursor
  162548. ** used to incrementally tokenize this string is returned in
  162549. ** *ppCursor.
  162550. */
  162551. static int icuOpen(
  162552. sqlite3_tokenizer *pTokenizer, /* The tokenizer */
  162553. const char *zInput, /* Input string */
  162554. int nInput, /* Length of zInput in bytes */
  162555. sqlite3_tokenizer_cursor **ppCursor /* OUT: Tokenization cursor */
  162556. ){
  162557. IcuTokenizer *p = (IcuTokenizer *)pTokenizer;
  162558. IcuCursor *pCsr;
  162559. const int32_t opt = U_FOLD_CASE_DEFAULT;
  162560. UErrorCode status = U_ZERO_ERROR;
  162561. int nChar;
  162562. UChar32 c;
  162563. int iInput = 0;
  162564. int iOut = 0;
  162565. *ppCursor = 0;
  162566. if( zInput==0 ){
  162567. nInput = 0;
  162568. zInput = "";
  162569. }else if( nInput<0 ){
  162570. nInput = strlen(zInput);
  162571. }
  162572. nChar = nInput+1;
  162573. pCsr = (IcuCursor *)sqlite3_malloc(
  162574. sizeof(IcuCursor) + /* IcuCursor */
  162575. ((nChar+3)&~3) * sizeof(UChar) + /* IcuCursor.aChar[] */
  162576. (nChar+1) * sizeof(int) /* IcuCursor.aOffset[] */
  162577. );
  162578. if( !pCsr ){
  162579. return SQLITE_NOMEM;
  162580. }
  162581. memset(pCsr, 0, sizeof(IcuCursor));
  162582. pCsr->aChar = (UChar *)&pCsr[1];
  162583. pCsr->aOffset = (int *)&pCsr->aChar[(nChar+3)&~3];
  162584. pCsr->aOffset[iOut] = iInput;
  162585. U8_NEXT(zInput, iInput, nInput, c);
  162586. while( c>0 ){
  162587. int isError = 0;
  162588. c = u_foldCase(c, opt);
  162589. U16_APPEND(pCsr->aChar, iOut, nChar, c, isError);
  162590. if( isError ){
  162591. sqlite3_free(pCsr);
  162592. return SQLITE_ERROR;
  162593. }
  162594. pCsr->aOffset[iOut] = iInput;
  162595. if( iInput<nInput ){
  162596. U8_NEXT(zInput, iInput, nInput, c);
  162597. }else{
  162598. c = 0;
  162599. }
  162600. }
  162601. pCsr->pIter = ubrk_open(UBRK_WORD, p->zLocale, pCsr->aChar, iOut, &status);
  162602. if( !U_SUCCESS(status) ){
  162603. sqlite3_free(pCsr);
  162604. return SQLITE_ERROR;
  162605. }
  162606. pCsr->nChar = iOut;
  162607. ubrk_first(pCsr->pIter);
  162608. *ppCursor = (sqlite3_tokenizer_cursor *)pCsr;
  162609. return SQLITE_OK;
  162610. }
  162611. /*
  162612. ** Close a tokenization cursor previously opened by a call to icuOpen().
  162613. */
  162614. static int icuClose(sqlite3_tokenizer_cursor *pCursor){
  162615. IcuCursor *pCsr = (IcuCursor *)pCursor;
  162616. ubrk_close(pCsr->pIter);
  162617. sqlite3_free(pCsr->zBuffer);
  162618. sqlite3_free(pCsr);
  162619. return SQLITE_OK;
  162620. }
  162621. /*
  162622. ** Extract the next token from a tokenization cursor.
  162623. */
  162624. static int icuNext(
  162625. sqlite3_tokenizer_cursor *pCursor, /* Cursor returned by simpleOpen */
  162626. const char **ppToken, /* OUT: *ppToken is the token text */
  162627. int *pnBytes, /* OUT: Number of bytes in token */
  162628. int *piStartOffset, /* OUT: Starting offset of token */
  162629. int *piEndOffset, /* OUT: Ending offset of token */
  162630. int *piPosition /* OUT: Position integer of token */
  162631. ){
  162632. IcuCursor *pCsr = (IcuCursor *)pCursor;
  162633. int iStart = 0;
  162634. int iEnd = 0;
  162635. int nByte = 0;
  162636. while( iStart==iEnd ){
  162637. UChar32 c;
  162638. iStart = ubrk_current(pCsr->pIter);
  162639. iEnd = ubrk_next(pCsr->pIter);
  162640. if( iEnd==UBRK_DONE ){
  162641. return SQLITE_DONE;
  162642. }
  162643. while( iStart<iEnd ){
  162644. int iWhite = iStart;
  162645. U16_NEXT(pCsr->aChar, iWhite, pCsr->nChar, c);
  162646. if( u_isspace(c) ){
  162647. iStart = iWhite;
  162648. }else{
  162649. break;
  162650. }
  162651. }
  162652. assert(iStart<=iEnd);
  162653. }
  162654. do {
  162655. UErrorCode status = U_ZERO_ERROR;
  162656. if( nByte ){
  162657. char *zNew = sqlite3_realloc(pCsr->zBuffer, nByte);
  162658. if( !zNew ){
  162659. return SQLITE_NOMEM;
  162660. }
  162661. pCsr->zBuffer = zNew;
  162662. pCsr->nBuffer = nByte;
  162663. }
  162664. u_strToUTF8(
  162665. pCsr->zBuffer, pCsr->nBuffer, &nByte, /* Output vars */
  162666. &pCsr->aChar[iStart], iEnd-iStart, /* Input vars */
  162667. &status /* Output success/failure */
  162668. );
  162669. } while( nByte>pCsr->nBuffer );
  162670. *ppToken = pCsr->zBuffer;
  162671. *pnBytes = nByte;
  162672. *piStartOffset = pCsr->aOffset[iStart];
  162673. *piEndOffset = pCsr->aOffset[iEnd];
  162674. *piPosition = pCsr->iToken++;
  162675. return SQLITE_OK;
  162676. }
  162677. /*
  162678. ** The set of routines that implement the simple tokenizer
  162679. */
  162680. static const sqlite3_tokenizer_module icuTokenizerModule = {
  162681. 0, /* iVersion */
  162682. icuCreate, /* xCreate */
  162683. icuDestroy, /* xCreate */
  162684. icuOpen, /* xOpen */
  162685. icuClose, /* xClose */
  162686. icuNext, /* xNext */
  162687. 0, /* xLanguageid */
  162688. };
  162689. /*
  162690. ** Set *ppModule to point at the implementation of the ICU tokenizer.
  162691. */
  162692. SQLITE_PRIVATE void sqlite3Fts3IcuTokenizerModule(
  162693. sqlite3_tokenizer_module const**ppModule
  162694. ){
  162695. *ppModule = &icuTokenizerModule;
  162696. }
  162697. #endif /* defined(SQLITE_ENABLE_ICU) */
  162698. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */
  162699. /************** End of fts3_icu.c ********************************************/
  162700. /************** Begin file sqlite3rbu.c **************************************/
  162701. /*
  162702. ** 2014 August 30
  162703. **
  162704. ** The author disclaims copyright to this source code. In place of
  162705. ** a legal notice, here is a blessing:
  162706. **
  162707. ** May you do good and not evil.
  162708. ** May you find forgiveness for yourself and forgive others.
  162709. ** May you share freely, never taking more than you give.
  162710. **
  162711. *************************************************************************
  162712. **
  162713. **
  162714. ** OVERVIEW
  162715. **
  162716. ** The RBU extension requires that the RBU update be packaged as an
  162717. ** SQLite database. The tables it expects to find are described in
  162718. ** sqlite3rbu.h. Essentially, for each table xyz in the target database
  162719. ** that the user wishes to write to, a corresponding data_xyz table is
  162720. ** created in the RBU database and populated with one row for each row to
  162721. ** update, insert or delete from the target table.
  162722. **
  162723. ** The update proceeds in three stages:
  162724. **
  162725. ** 1) The database is updated. The modified database pages are written
  162726. ** to a *-oal file. A *-oal file is just like a *-wal file, except
  162727. ** that it is named "<database>-oal" instead of "<database>-wal".
  162728. ** Because regular SQLite clients do not look for file named
  162729. ** "<database>-oal", they go on using the original database in
  162730. ** rollback mode while the *-oal file is being generated.
  162731. **
  162732. ** During this stage RBU does not update the database by writing
  162733. ** directly to the target tables. Instead it creates "imposter"
  162734. ** tables using the SQLITE_TESTCTRL_IMPOSTER interface that it uses
  162735. ** to update each b-tree individually. All updates required by each
  162736. ** b-tree are completed before moving on to the next, and all
  162737. ** updates are done in sorted key order.
  162738. **
  162739. ** 2) The "<database>-oal" file is moved to the equivalent "<database>-wal"
  162740. ** location using a call to rename(2). Before doing this the RBU
  162741. ** module takes an EXCLUSIVE lock on the database file, ensuring
  162742. ** that there are no other active readers.
  162743. **
  162744. ** Once the EXCLUSIVE lock is released, any other database readers
  162745. ** detect the new *-wal file and read the database in wal mode. At
  162746. ** this point they see the new version of the database - including
  162747. ** the updates made as part of the RBU update.
  162748. **
  162749. ** 3) The new *-wal file is checkpointed. This proceeds in the same way
  162750. ** as a regular database checkpoint, except that a single frame is
  162751. ** checkpointed each time sqlite3rbu_step() is called. If the RBU
  162752. ** handle is closed before the entire *-wal file is checkpointed,
  162753. ** the checkpoint progress is saved in the RBU database and the
  162754. ** checkpoint can be resumed by another RBU client at some point in
  162755. ** the future.
  162756. **
  162757. ** POTENTIAL PROBLEMS
  162758. **
  162759. ** The rename() call might not be portable. And RBU is not currently
  162760. ** syncing the directory after renaming the file.
  162761. **
  162762. ** When state is saved, any commit to the *-oal file and the commit to
  162763. ** the RBU update database are not atomic. So if the power fails at the
  162764. ** wrong moment they might get out of sync. As the main database will be
  162765. ** committed before the RBU update database this will likely either just
  162766. ** pass unnoticed, or result in SQLITE_CONSTRAINT errors (due to UNIQUE
  162767. ** constraint violations).
  162768. **
  162769. ** If some client does modify the target database mid RBU update, or some
  162770. ** other error occurs, the RBU extension will keep throwing errors. It's
  162771. ** not really clear how to get out of this state. The system could just
  162772. ** by delete the RBU update database and *-oal file and have the device
  162773. ** download the update again and start over.
  162774. **
  162775. ** At present, for an UPDATE, both the new.* and old.* records are
  162776. ** collected in the rbu_xyz table. And for both UPDATEs and DELETEs all
  162777. ** fields are collected. This means we're probably writing a lot more
  162778. ** data to disk when saving the state of an ongoing update to the RBU
  162779. ** update database than is strictly necessary.
  162780. **
  162781. */
  162782. /* #include <assert.h> */
  162783. /* #include <string.h> */
  162784. /* #include <stdio.h> */
  162785. /* #include "sqlite3.h" */
  162786. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_RBU)
  162787. /************** Include sqlite3rbu.h in the middle of sqlite3rbu.c ***********/
  162788. /************** Begin file sqlite3rbu.h **************************************/
  162789. /*
  162790. ** 2014 August 30
  162791. **
  162792. ** The author disclaims copyright to this source code. In place of
  162793. ** a legal notice, here is a blessing:
  162794. **
  162795. ** May you do good and not evil.
  162796. ** May you find forgiveness for yourself and forgive others.
  162797. ** May you share freely, never taking more than you give.
  162798. **
  162799. *************************************************************************
  162800. **
  162801. ** This file contains the public interface for the RBU extension.
  162802. */
  162803. /*
  162804. ** SUMMARY
  162805. **
  162806. ** Writing a transaction containing a large number of operations on
  162807. ** b-tree indexes that are collectively larger than the available cache
  162808. ** memory can be very inefficient.
  162809. **
  162810. ** The problem is that in order to update a b-tree, the leaf page (at least)
  162811. ** containing the entry being inserted or deleted must be modified. If the
  162812. ** working set of leaves is larger than the available cache memory, then a
  162813. ** single leaf that is modified more than once as part of the transaction
  162814. ** may be loaded from or written to the persistent media multiple times.
  162815. ** Additionally, because the index updates are likely to be applied in
  162816. ** random order, access to pages within the database is also likely to be in
  162817. ** random order, which is itself quite inefficient.
  162818. **
  162819. ** One way to improve the situation is to sort the operations on each index
  162820. ** by index key before applying them to the b-tree. This leads to an IO
  162821. ** pattern that resembles a single linear scan through the index b-tree,
  162822. ** and all but guarantees each modified leaf page is loaded and stored
  162823. ** exactly once. SQLite uses this trick to improve the performance of
  162824. ** CREATE INDEX commands. This extension allows it to be used to improve
  162825. ** the performance of large transactions on existing databases.
  162826. **
  162827. ** Additionally, this extension allows the work involved in writing the
  162828. ** large transaction to be broken down into sub-transactions performed
  162829. ** sequentially by separate processes. This is useful if the system cannot
  162830. ** guarantee that a single update process will run for long enough to apply
  162831. ** the entire update, for example because the update is being applied on a
  162832. ** mobile device that is frequently rebooted. Even after the writer process
  162833. ** has committed one or more sub-transactions, other database clients continue
  162834. ** to read from the original database snapshot. In other words, partially
  162835. ** applied transactions are not visible to other clients.
  162836. **
  162837. ** "RBU" stands for "Resumable Bulk Update". As in a large database update
  162838. ** transmitted via a wireless network to a mobile device. A transaction
  162839. ** applied using this extension is hence refered to as an "RBU update".
  162840. **
  162841. **
  162842. ** LIMITATIONS
  162843. **
  162844. ** An "RBU update" transaction is subject to the following limitations:
  162845. **
  162846. ** * The transaction must consist of INSERT, UPDATE and DELETE operations
  162847. ** only.
  162848. **
  162849. ** * INSERT statements may not use any default values.
  162850. **
  162851. ** * UPDATE and DELETE statements must identify their target rows by
  162852. ** non-NULL PRIMARY KEY values. Rows with NULL values stored in PRIMARY
  162853. ** KEY fields may not be updated or deleted. If the table being written
  162854. ** has no PRIMARY KEY, affected rows must be identified by rowid.
  162855. **
  162856. ** * UPDATE statements may not modify PRIMARY KEY columns.
  162857. **
  162858. ** * No triggers will be fired.
  162859. **
  162860. ** * No foreign key violations are detected or reported.
  162861. **
  162862. ** * CHECK constraints are not enforced.
  162863. **
  162864. ** * No constraint handling mode except for "OR ROLLBACK" is supported.
  162865. **
  162866. **
  162867. ** PREPARATION
  162868. **
  162869. ** An "RBU update" is stored as a separate SQLite database. A database
  162870. ** containing an RBU update is an "RBU database". For each table in the
  162871. ** target database to be updated, the RBU database should contain a table
  162872. ** named "data_<target name>" containing the same set of columns as the
  162873. ** target table, and one more - "rbu_control". The data_% table should
  162874. ** have no PRIMARY KEY or UNIQUE constraints, but each column should have
  162875. ** the same type as the corresponding column in the target database.
  162876. ** The "rbu_control" column should have no type at all. For example, if
  162877. ** the target database contains:
  162878. **
  162879. ** CREATE TABLE t1(a INTEGER PRIMARY KEY, b TEXT, c UNIQUE);
  162880. **
  162881. ** Then the RBU database should contain:
  162882. **
  162883. ** CREATE TABLE data_t1(a INTEGER, b TEXT, c, rbu_control);
  162884. **
  162885. ** The order of the columns in the data_% table does not matter.
  162886. **
  162887. ** Instead of a regular table, the RBU database may also contain virtual
  162888. ** tables or view named using the data_<target> naming scheme.
  162889. **
  162890. ** Instead of the plain data_<target> naming scheme, RBU database tables
  162891. ** may also be named data<integer>_<target>, where <integer> is any sequence
  162892. ** of zero or more numeric characters (0-9). This can be significant because
  162893. ** tables within the RBU database are always processed in order sorted by
  162894. ** name. By judicious selection of the <integer> portion of the names
  162895. ** of the RBU tables the user can therefore control the order in which they
  162896. ** are processed. This can be useful, for example, to ensure that "external
  162897. ** content" FTS4 tables are updated before their underlying content tables.
  162898. **
  162899. ** If the target database table is a virtual table or a table that has no
  162900. ** PRIMARY KEY declaration, the data_% table must also contain a column
  162901. ** named "rbu_rowid". This column is mapped to the tables implicit primary
  162902. ** key column - "rowid". Virtual tables for which the "rowid" column does
  162903. ** not function like a primary key value cannot be updated using RBU. For
  162904. ** example, if the target db contains either of the following:
  162905. **
  162906. ** CREATE VIRTUAL TABLE x1 USING fts3(a, b);
  162907. ** CREATE TABLE x1(a, b)
  162908. **
  162909. ** then the RBU database should contain:
  162910. **
  162911. ** CREATE TABLE data_x1(a, b, rbu_rowid, rbu_control);
  162912. **
  162913. ** All non-hidden columns (i.e. all columns matched by "SELECT *") of the
  162914. ** target table must be present in the input table. For virtual tables,
  162915. ** hidden columns are optional - they are updated by RBU if present in
  162916. ** the input table, or not otherwise. For example, to write to an fts4
  162917. ** table with a hidden languageid column such as:
  162918. **
  162919. ** CREATE VIRTUAL TABLE ft1 USING fts4(a, b, languageid='langid');
  162920. **
  162921. ** Either of the following input table schemas may be used:
  162922. **
  162923. ** CREATE TABLE data_ft1(a, b, langid, rbu_rowid, rbu_control);
  162924. ** CREATE TABLE data_ft1(a, b, rbu_rowid, rbu_control);
  162925. **
  162926. ** For each row to INSERT into the target database as part of the RBU
  162927. ** update, the corresponding data_% table should contain a single record
  162928. ** with the "rbu_control" column set to contain integer value 0. The
  162929. ** other columns should be set to the values that make up the new record
  162930. ** to insert.
  162931. **
  162932. ** If the target database table has an INTEGER PRIMARY KEY, it is not
  162933. ** possible to insert a NULL value into the IPK column. Attempting to
  162934. ** do so results in an SQLITE_MISMATCH error.
  162935. **
  162936. ** For each row to DELETE from the target database as part of the RBU
  162937. ** update, the corresponding data_% table should contain a single record
  162938. ** with the "rbu_control" column set to contain integer value 1. The
  162939. ** real primary key values of the row to delete should be stored in the
  162940. ** corresponding columns of the data_% table. The values stored in the
  162941. ** other columns are not used.
  162942. **
  162943. ** For each row to UPDATE from the target database as part of the RBU
  162944. ** update, the corresponding data_% table should contain a single record
  162945. ** with the "rbu_control" column set to contain a value of type text.
  162946. ** The real primary key values identifying the row to update should be
  162947. ** stored in the corresponding columns of the data_% table row, as should
  162948. ** the new values of all columns being update. The text value in the
  162949. ** "rbu_control" column must contain the same number of characters as
  162950. ** there are columns in the target database table, and must consist entirely
  162951. ** of 'x' and '.' characters (or in some special cases 'd' - see below). For
  162952. ** each column that is being updated, the corresponding character is set to
  162953. ** 'x'. For those that remain as they are, the corresponding character of the
  162954. ** rbu_control value should be set to '.'. For example, given the tables
  162955. ** above, the update statement:
  162956. **
  162957. ** UPDATE t1 SET c = 'usa' WHERE a = 4;
  162958. **
  162959. ** is represented by the data_t1 row created by:
  162960. **
  162961. ** INSERT INTO data_t1(a, b, c, rbu_control) VALUES(4, NULL, 'usa', '..x');
  162962. **
  162963. ** Instead of an 'x' character, characters of the rbu_control value specified
  162964. ** for UPDATEs may also be set to 'd'. In this case, instead of updating the
  162965. ** target table with the value stored in the corresponding data_% column, the
  162966. ** user-defined SQL function "rbu_delta()" is invoked and the result stored in
  162967. ** the target table column. rbu_delta() is invoked with two arguments - the
  162968. ** original value currently stored in the target table column and the
  162969. ** value specified in the data_xxx table.
  162970. **
  162971. ** For example, this row:
  162972. **
  162973. ** INSERT INTO data_t1(a, b, c, rbu_control) VALUES(4, NULL, 'usa', '..d');
  162974. **
  162975. ** is similar to an UPDATE statement such as:
  162976. **
  162977. ** UPDATE t1 SET c = rbu_delta(c, 'usa') WHERE a = 4;
  162978. **
  162979. ** Finally, if an 'f' character appears in place of a 'd' or 's' in an
  162980. ** ota_control string, the contents of the data_xxx table column is assumed
  162981. ** to be a "fossil delta" - a patch to be applied to a blob value in the
  162982. ** format used by the fossil source-code management system. In this case
  162983. ** the existing value within the target database table must be of type BLOB.
  162984. ** It is replaced by the result of applying the specified fossil delta to
  162985. ** itself.
  162986. **
  162987. ** If the target database table is a virtual table or a table with no PRIMARY
  162988. ** KEY, the rbu_control value should not include a character corresponding
  162989. ** to the rbu_rowid value. For example, this:
  162990. **
  162991. ** INSERT INTO data_ft1(a, b, rbu_rowid, rbu_control)
  162992. ** VALUES(NULL, 'usa', 12, '.x');
  162993. **
  162994. ** causes a result similar to:
  162995. **
  162996. ** UPDATE ft1 SET b = 'usa' WHERE rowid = 12;
  162997. **
  162998. ** The data_xxx tables themselves should have no PRIMARY KEY declarations.
  162999. ** However, RBU is more efficient if reading the rows in from each data_xxx
  163000. ** table in "rowid" order is roughly the same as reading them sorted by
  163001. ** the PRIMARY KEY of the corresponding target database table. In other
  163002. ** words, rows should be sorted using the destination table PRIMARY KEY
  163003. ** fields before they are inserted into the data_xxx tables.
  163004. **
  163005. ** USAGE
  163006. **
  163007. ** The API declared below allows an application to apply an RBU update
  163008. ** stored on disk to an existing target database. Essentially, the
  163009. ** application:
  163010. **
  163011. ** 1) Opens an RBU handle using the sqlite3rbu_open() function.
  163012. **
  163013. ** 2) Registers any required virtual table modules with the database
  163014. ** handle returned by sqlite3rbu_db(). Also, if required, register
  163015. ** the rbu_delta() implementation.
  163016. **
  163017. ** 3) Calls the sqlite3rbu_step() function one or more times on
  163018. ** the new handle. Each call to sqlite3rbu_step() performs a single
  163019. ** b-tree operation, so thousands of calls may be required to apply
  163020. ** a complete update.
  163021. **
  163022. ** 4) Calls sqlite3rbu_close() to close the RBU update handle. If
  163023. ** sqlite3rbu_step() has been called enough times to completely
  163024. ** apply the update to the target database, then the RBU database
  163025. ** is marked as fully applied. Otherwise, the state of the RBU
  163026. ** update application is saved in the RBU database for later
  163027. ** resumption.
  163028. **
  163029. ** See comments below for more detail on APIs.
  163030. **
  163031. ** If an update is only partially applied to the target database by the
  163032. ** time sqlite3rbu_close() is called, various state information is saved
  163033. ** within the RBU database. This allows subsequent processes to automatically
  163034. ** resume the RBU update from where it left off.
  163035. **
  163036. ** To remove all RBU extension state information, returning an RBU database
  163037. ** to its original contents, it is sufficient to drop all tables that begin
  163038. ** with the prefix "rbu_"
  163039. **
  163040. ** DATABASE LOCKING
  163041. **
  163042. ** An RBU update may not be applied to a database in WAL mode. Attempting
  163043. ** to do so is an error (SQLITE_ERROR).
  163044. **
  163045. ** While an RBU handle is open, a SHARED lock may be held on the target
  163046. ** database file. This means it is possible for other clients to read the
  163047. ** database, but not to write it.
  163048. **
  163049. ** If an RBU update is started and then suspended before it is completed,
  163050. ** then an external client writes to the database, then attempting to resume
  163051. ** the suspended RBU update is also an error (SQLITE_BUSY).
  163052. */
  163053. #ifndef _SQLITE3RBU_H
  163054. #define _SQLITE3RBU_H
  163055. /* #include "sqlite3.h" ** Required for error code definitions ** */
  163056. #if 0
  163057. extern "C" {
  163058. #endif
  163059. typedef struct sqlite3rbu sqlite3rbu;
  163060. /*
  163061. ** Open an RBU handle.
  163062. **
  163063. ** Argument zTarget is the path to the target database. Argument zRbu is
  163064. ** the path to the RBU database. Each call to this function must be matched
  163065. ** by a call to sqlite3rbu_close(). When opening the databases, RBU passes
  163066. ** the SQLITE_CONFIG_URI flag to sqlite3_open_v2(). So if either zTarget
  163067. ** or zRbu begin with "file:", it will be interpreted as an SQLite
  163068. ** database URI, not a regular file name.
  163069. **
  163070. ** If the zState argument is passed a NULL value, the RBU extension stores
  163071. ** the current state of the update (how many rows have been updated, which
  163072. ** indexes are yet to be updated etc.) within the RBU database itself. This
  163073. ** can be convenient, as it means that the RBU application does not need to
  163074. ** organize removing a separate state file after the update is concluded.
  163075. ** Or, if zState is non-NULL, it must be a path to a database file in which
  163076. ** the RBU extension can store the state of the update.
  163077. **
  163078. ** When resuming an RBU update, the zState argument must be passed the same
  163079. ** value as when the RBU update was started.
  163080. **
  163081. ** Once the RBU update is finished, the RBU extension does not
  163082. ** automatically remove any zState database file, even if it created it.
  163083. **
  163084. ** By default, RBU uses the default VFS to access the files on disk. To
  163085. ** use a VFS other than the default, an SQLite "file:" URI containing a
  163086. ** "vfs=..." option may be passed as the zTarget option.
  163087. **
  163088. ** IMPORTANT NOTE FOR ZIPVFS USERS: The RBU extension works with all of
  163089. ** SQLite's built-in VFSs, including the multiplexor VFS. However it does
  163090. ** not work out of the box with zipvfs. Refer to the comment describing
  163091. ** the zipvfs_create_vfs() API below for details on using RBU with zipvfs.
  163092. */
  163093. SQLITE_API sqlite3rbu *sqlite3rbu_open(
  163094. const char *zTarget,
  163095. const char *zRbu,
  163096. const char *zState
  163097. );
  163098. /*
  163099. ** Open an RBU handle to perform an RBU vacuum on database file zTarget.
  163100. ** An RBU vacuum is similar to SQLite's built-in VACUUM command, except
  163101. ** that it can be suspended and resumed like an RBU update.
  163102. **
  163103. ** The second argument to this function identifies a database in which
  163104. ** to store the state of the RBU vacuum operation if it is suspended. The
  163105. ** first time sqlite3rbu_vacuum() is called, to start an RBU vacuum
  163106. ** operation, the state database should either not exist or be empty
  163107. ** (contain no tables). If an RBU vacuum is suspended by calling
  163108. ** sqlite3rbu_close() on the RBU handle before sqlite3rbu_step() has
  163109. ** returned SQLITE_DONE, the vacuum state is stored in the state database.
  163110. ** The vacuum can be resumed by calling this function to open a new RBU
  163111. ** handle specifying the same target and state databases.
  163112. **
  163113. ** If the second argument passed to this function is NULL, then the
  163114. ** name of the state database is "<database>-vacuum", where <database>
  163115. ** is the name of the target database file. In this case, on UNIX, if the
  163116. ** state database is not already present in the file-system, it is created
  163117. ** with the same permissions as the target db is made.
  163118. **
  163119. ** This function does not delete the state database after an RBU vacuum
  163120. ** is completed, even if it created it. However, if the call to
  163121. ** sqlite3rbu_close() returns any value other than SQLITE_OK, the contents
  163122. ** of the state tables within the state database are zeroed. This way,
  163123. ** the next call to sqlite3rbu_vacuum() opens a handle that starts a
  163124. ** new RBU vacuum operation.
  163125. **
  163126. ** As with sqlite3rbu_open(), Zipvfs users should rever to the comment
  163127. ** describing the sqlite3rbu_create_vfs() API function below for
  163128. ** a description of the complications associated with using RBU with
  163129. ** zipvfs databases.
  163130. */
  163131. SQLITE_API sqlite3rbu *sqlite3rbu_vacuum(
  163132. const char *zTarget,
  163133. const char *zState
  163134. );
  163135. /*
  163136. ** Configure a limit for the amount of temp space that may be used by
  163137. ** the RBU handle passed as the first argument. The new limit is specified
  163138. ** in bytes by the second parameter. If it is positive, the limit is updated.
  163139. ** If the second parameter to this function is passed zero, then the limit
  163140. ** is removed entirely. If the second parameter is negative, the limit is
  163141. ** not modified (this is useful for querying the current limit).
  163142. **
  163143. ** In all cases the returned value is the current limit in bytes (zero
  163144. ** indicates unlimited).
  163145. **
  163146. ** If the temp space limit is exceeded during operation, an SQLITE_FULL
  163147. ** error is returned.
  163148. */
  163149. SQLITE_API sqlite3_int64 sqlite3rbu_temp_size_limit(sqlite3rbu*, sqlite3_int64);
  163150. /*
  163151. ** Return the current amount of temp file space, in bytes, currently used by
  163152. ** the RBU handle passed as the only argument.
  163153. */
  163154. SQLITE_API sqlite3_int64 sqlite3rbu_temp_size(sqlite3rbu*);
  163155. /*
  163156. ** Internally, each RBU connection uses a separate SQLite database
  163157. ** connection to access the target and rbu update databases. This
  163158. ** API allows the application direct access to these database handles.
  163159. **
  163160. ** The first argument passed to this function must be a valid, open, RBU
  163161. ** handle. The second argument should be passed zero to access the target
  163162. ** database handle, or non-zero to access the rbu update database handle.
  163163. ** Accessing the underlying database handles may be useful in the
  163164. ** following scenarios:
  163165. **
  163166. ** * If any target tables are virtual tables, it may be necessary to
  163167. ** call sqlite3_create_module() on the target database handle to
  163168. ** register the required virtual table implementations.
  163169. **
  163170. ** * If the data_xxx tables in the RBU source database are virtual
  163171. ** tables, the application may need to call sqlite3_create_module() on
  163172. ** the rbu update db handle to any required virtual table
  163173. ** implementations.
  163174. **
  163175. ** * If the application uses the "rbu_delta()" feature described above,
  163176. ** it must use sqlite3_create_function() or similar to register the
  163177. ** rbu_delta() implementation with the target database handle.
  163178. **
  163179. ** If an error has occurred, either while opening or stepping the RBU object,
  163180. ** this function may return NULL. The error code and message may be collected
  163181. ** when sqlite3rbu_close() is called.
  163182. **
  163183. ** Database handles returned by this function remain valid until the next
  163184. ** call to any sqlite3rbu_xxx() function other than sqlite3rbu_db().
  163185. */
  163186. SQLITE_API sqlite3 *sqlite3rbu_db(sqlite3rbu*, int bRbu);
  163187. /*
  163188. ** Do some work towards applying the RBU update to the target db.
  163189. **
  163190. ** Return SQLITE_DONE if the update has been completely applied, or
  163191. ** SQLITE_OK if no error occurs but there remains work to do to apply
  163192. ** the RBU update. If an error does occur, some other error code is
  163193. ** returned.
  163194. **
  163195. ** Once a call to sqlite3rbu_step() has returned a value other than
  163196. ** SQLITE_OK, all subsequent calls on the same RBU handle are no-ops
  163197. ** that immediately return the same value.
  163198. */
  163199. SQLITE_API int sqlite3rbu_step(sqlite3rbu *pRbu);
  163200. /*
  163201. ** Force RBU to save its state to disk.
  163202. **
  163203. ** If a power failure or application crash occurs during an update, following
  163204. ** system recovery RBU may resume the update from the point at which the state
  163205. ** was last saved. In other words, from the most recent successful call to
  163206. ** sqlite3rbu_close() or this function.
  163207. **
  163208. ** SQLITE_OK is returned if successful, or an SQLite error code otherwise.
  163209. */
  163210. SQLITE_API int sqlite3rbu_savestate(sqlite3rbu *pRbu);
  163211. /*
  163212. ** Close an RBU handle.
  163213. **
  163214. ** If the RBU update has been completely applied, mark the RBU database
  163215. ** as fully applied. Otherwise, assuming no error has occurred, save the
  163216. ** current state of the RBU update appliation to the RBU database.
  163217. **
  163218. ** If an error has already occurred as part of an sqlite3rbu_step()
  163219. ** or sqlite3rbu_open() call, or if one occurs within this function, an
  163220. ** SQLite error code is returned. Additionally, if pzErrmsg is not NULL,
  163221. ** *pzErrmsg may be set to point to a buffer containing a utf-8 formatted
  163222. ** English language error message. It is the responsibility of the caller to
  163223. ** eventually free any such buffer using sqlite3_free().
  163224. **
  163225. ** Otherwise, if no error occurs, this function returns SQLITE_OK if the
  163226. ** update has been partially applied, or SQLITE_DONE if it has been
  163227. ** completely applied.
  163228. */
  163229. SQLITE_API int sqlite3rbu_close(sqlite3rbu *pRbu, char **pzErrmsg);
  163230. /*
  163231. ** Return the total number of key-value operations (inserts, deletes or
  163232. ** updates) that have been performed on the target database since the
  163233. ** current RBU update was started.
  163234. */
  163235. SQLITE_API sqlite3_int64 sqlite3rbu_progress(sqlite3rbu *pRbu);
  163236. /*
  163237. ** Obtain permyriadage (permyriadage is to 10000 as percentage is to 100)
  163238. ** progress indications for the two stages of an RBU update. This API may
  163239. ** be useful for driving GUI progress indicators and similar.
  163240. **
  163241. ** An RBU update is divided into two stages:
  163242. **
  163243. ** * Stage 1, in which changes are accumulated in an oal/wal file, and
  163244. ** * Stage 2, in which the contents of the wal file are copied into the
  163245. ** main database.
  163246. **
  163247. ** The update is visible to non-RBU clients during stage 2. During stage 1
  163248. ** non-RBU reader clients may see the original database.
  163249. **
  163250. ** If this API is called during stage 2 of the update, output variable
  163251. ** (*pnOne) is set to 10000 to indicate that stage 1 has finished and (*pnTwo)
  163252. ** to a value between 0 and 10000 to indicate the permyriadage progress of
  163253. ** stage 2. A value of 5000 indicates that stage 2 is half finished,
  163254. ** 9000 indicates that it is 90% finished, and so on.
  163255. **
  163256. ** If this API is called during stage 1 of the update, output variable
  163257. ** (*pnTwo) is set to 0 to indicate that stage 2 has not yet started. The
  163258. ** value to which (*pnOne) is set depends on whether or not the RBU
  163259. ** database contains an "rbu_count" table. The rbu_count table, if it
  163260. ** exists, must contain the same columns as the following:
  163261. **
  163262. ** CREATE TABLE rbu_count(tbl TEXT PRIMARY KEY, cnt INTEGER) WITHOUT ROWID;
  163263. **
  163264. ** There must be one row in the table for each source (data_xxx) table within
  163265. ** the RBU database. The 'tbl' column should contain the name of the source
  163266. ** table. The 'cnt' column should contain the number of rows within the
  163267. ** source table.
  163268. **
  163269. ** If the rbu_count table is present and populated correctly and this
  163270. ** API is called during stage 1, the *pnOne output variable is set to the
  163271. ** permyriadage progress of the same stage. If the rbu_count table does
  163272. ** not exist, then (*pnOne) is set to -1 during stage 1. If the rbu_count
  163273. ** table exists but is not correctly populated, the value of the *pnOne
  163274. ** output variable during stage 1 is undefined.
  163275. */
  163276. SQLITE_API void sqlite3rbu_bp_progress(sqlite3rbu *pRbu, int *pnOne, int*pnTwo);
  163277. /*
  163278. ** Obtain an indication as to the current stage of an RBU update or vacuum.
  163279. ** This function always returns one of the SQLITE_RBU_STATE_XXX constants
  163280. ** defined in this file. Return values should be interpreted as follows:
  163281. **
  163282. ** SQLITE_RBU_STATE_OAL:
  163283. ** RBU is currently building a *-oal file. The next call to sqlite3rbu_step()
  163284. ** may either add further data to the *-oal file, or compute data that will
  163285. ** be added by a subsequent call.
  163286. **
  163287. ** SQLITE_RBU_STATE_MOVE:
  163288. ** RBU has finished building the *-oal file. The next call to sqlite3rbu_step()
  163289. ** will move the *-oal file to the equivalent *-wal path. If the current
  163290. ** operation is an RBU update, then the updated version of the database
  163291. ** file will become visible to ordinary SQLite clients following the next
  163292. ** call to sqlite3rbu_step().
  163293. **
  163294. ** SQLITE_RBU_STATE_CHECKPOINT:
  163295. ** RBU is currently performing an incremental checkpoint. The next call to
  163296. ** sqlite3rbu_step() will copy a page of data from the *-wal file into
  163297. ** the target database file.
  163298. **
  163299. ** SQLITE_RBU_STATE_DONE:
  163300. ** The RBU operation has finished. Any subsequent calls to sqlite3rbu_step()
  163301. ** will immediately return SQLITE_DONE.
  163302. **
  163303. ** SQLITE_RBU_STATE_ERROR:
  163304. ** An error has occurred. Any subsequent calls to sqlite3rbu_step() will
  163305. ** immediately return the SQLite error code associated with the error.
  163306. */
  163307. #define SQLITE_RBU_STATE_OAL 1
  163308. #define SQLITE_RBU_STATE_MOVE 2
  163309. #define SQLITE_RBU_STATE_CHECKPOINT 3
  163310. #define SQLITE_RBU_STATE_DONE 4
  163311. #define SQLITE_RBU_STATE_ERROR 5
  163312. SQLITE_API int sqlite3rbu_state(sqlite3rbu *pRbu);
  163313. /*
  163314. ** Create an RBU VFS named zName that accesses the underlying file-system
  163315. ** via existing VFS zParent. Or, if the zParent parameter is passed NULL,
  163316. ** then the new RBU VFS uses the default system VFS to access the file-system.
  163317. ** The new object is registered as a non-default VFS with SQLite before
  163318. ** returning.
  163319. **
  163320. ** Part of the RBU implementation uses a custom VFS object. Usually, this
  163321. ** object is created and deleted automatically by RBU.
  163322. **
  163323. ** The exception is for applications that also use zipvfs. In this case,
  163324. ** the custom VFS must be explicitly created by the user before the RBU
  163325. ** handle is opened. The RBU VFS should be installed so that the zipvfs
  163326. ** VFS uses the RBU VFS, which in turn uses any other VFS layers in use
  163327. ** (for example multiplexor) to access the file-system. For example,
  163328. ** to assemble an RBU enabled VFS stack that uses both zipvfs and
  163329. ** multiplexor (error checking omitted):
  163330. **
  163331. ** // Create a VFS named "multiplex" (not the default).
  163332. ** sqlite3_multiplex_initialize(0, 0);
  163333. **
  163334. ** // Create an rbu VFS named "rbu" that uses multiplexor. If the
  163335. ** // second argument were replaced with NULL, the "rbu" VFS would
  163336. ** // access the file-system via the system default VFS, bypassing the
  163337. ** // multiplexor.
  163338. ** sqlite3rbu_create_vfs("rbu", "multiplex");
  163339. **
  163340. ** // Create a zipvfs VFS named "zipvfs" that uses rbu.
  163341. ** zipvfs_create_vfs_v3("zipvfs", "rbu", 0, xCompressorAlgorithmDetector);
  163342. **
  163343. ** // Make zipvfs the default VFS.
  163344. ** sqlite3_vfs_register(sqlite3_vfs_find("zipvfs"), 1);
  163345. **
  163346. ** Because the default VFS created above includes a RBU functionality, it
  163347. ** may be used by RBU clients. Attempting to use RBU with a zipvfs VFS stack
  163348. ** that does not include the RBU layer results in an error.
  163349. **
  163350. ** The overhead of adding the "rbu" VFS to the system is negligible for
  163351. ** non-RBU users. There is no harm in an application accessing the
  163352. ** file-system via "rbu" all the time, even if it only uses RBU functionality
  163353. ** occasionally.
  163354. */
  163355. SQLITE_API int sqlite3rbu_create_vfs(const char *zName, const char *zParent);
  163356. /*
  163357. ** Deregister and destroy an RBU vfs created by an earlier call to
  163358. ** sqlite3rbu_create_vfs().
  163359. **
  163360. ** VFS objects are not reference counted. If a VFS object is destroyed
  163361. ** before all database handles that use it have been closed, the results
  163362. ** are undefined.
  163363. */
  163364. SQLITE_API void sqlite3rbu_destroy_vfs(const char *zName);
  163365. #if 0
  163366. } /* end of the 'extern "C"' block */
  163367. #endif
  163368. #endif /* _SQLITE3RBU_H */
  163369. /************** End of sqlite3rbu.h ******************************************/
  163370. /************** Continuing where we left off in sqlite3rbu.c *****************/
  163371. #if defined(_WIN32_WCE)
  163372. /* #include "windows.h" */
  163373. #endif
  163374. /* Maximum number of prepared UPDATE statements held by this module */
  163375. #define SQLITE_RBU_UPDATE_CACHESIZE 16
  163376. /* Delta checksums disabled by default. Compile with -DRBU_ENABLE_DELTA_CKSUM
  163377. ** to enable checksum verification.
  163378. */
  163379. #ifndef RBU_ENABLE_DELTA_CKSUM
  163380. # define RBU_ENABLE_DELTA_CKSUM 0
  163381. #endif
  163382. /*
  163383. ** Swap two objects of type TYPE.
  163384. */
  163385. #if !defined(SQLITE_AMALGAMATION)
  163386. # define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
  163387. #endif
  163388. /*
  163389. ** The rbu_state table is used to save the state of a partially applied
  163390. ** update so that it can be resumed later. The table consists of integer
  163391. ** keys mapped to values as follows:
  163392. **
  163393. ** RBU_STATE_STAGE:
  163394. ** May be set to integer values 1, 2, 4 or 5. As follows:
  163395. ** 1: the *-rbu file is currently under construction.
  163396. ** 2: the *-rbu file has been constructed, but not yet moved
  163397. ** to the *-wal path.
  163398. ** 4: the checkpoint is underway.
  163399. ** 5: the rbu update has been checkpointed.
  163400. **
  163401. ** RBU_STATE_TBL:
  163402. ** Only valid if STAGE==1. The target database name of the table
  163403. ** currently being written.
  163404. **
  163405. ** RBU_STATE_IDX:
  163406. ** Only valid if STAGE==1. The target database name of the index
  163407. ** currently being written, or NULL if the main table is currently being
  163408. ** updated.
  163409. **
  163410. ** RBU_STATE_ROW:
  163411. ** Only valid if STAGE==1. Number of rows already processed for the current
  163412. ** table/index.
  163413. **
  163414. ** RBU_STATE_PROGRESS:
  163415. ** Trbul number of sqlite3rbu_step() calls made so far as part of this
  163416. ** rbu update.
  163417. **
  163418. ** RBU_STATE_CKPT:
  163419. ** Valid if STAGE==4. The 64-bit checksum associated with the wal-index
  163420. ** header created by recovering the *-wal file. This is used to detect
  163421. ** cases when another client appends frames to the *-wal file in the
  163422. ** middle of an incremental checkpoint (an incremental checkpoint cannot
  163423. ** be continued if this happens).
  163424. **
  163425. ** RBU_STATE_COOKIE:
  163426. ** Valid if STAGE==1. The current change-counter cookie value in the
  163427. ** target db file.
  163428. **
  163429. ** RBU_STATE_OALSZ:
  163430. ** Valid if STAGE==1. The size in bytes of the *-oal file.
  163431. */
  163432. #define RBU_STATE_STAGE 1
  163433. #define RBU_STATE_TBL 2
  163434. #define RBU_STATE_IDX 3
  163435. #define RBU_STATE_ROW 4
  163436. #define RBU_STATE_PROGRESS 5
  163437. #define RBU_STATE_CKPT 6
  163438. #define RBU_STATE_COOKIE 7
  163439. #define RBU_STATE_OALSZ 8
  163440. #define RBU_STATE_PHASEONESTEP 9
  163441. #define RBU_STAGE_OAL 1
  163442. #define RBU_STAGE_MOVE 2
  163443. #define RBU_STAGE_CAPTURE 3
  163444. #define RBU_STAGE_CKPT 4
  163445. #define RBU_STAGE_DONE 5
  163446. #define RBU_CREATE_STATE \
  163447. "CREATE TABLE IF NOT EXISTS %s.rbu_state(k INTEGER PRIMARY KEY, v)"
  163448. typedef struct RbuFrame RbuFrame;
  163449. typedef struct RbuObjIter RbuObjIter;
  163450. typedef struct RbuState RbuState;
  163451. typedef struct rbu_vfs rbu_vfs;
  163452. typedef struct rbu_file rbu_file;
  163453. typedef struct RbuUpdateStmt RbuUpdateStmt;
  163454. #if !defined(SQLITE_AMALGAMATION)
  163455. typedef unsigned int u32;
  163456. typedef unsigned short u16;
  163457. typedef unsigned char u8;
  163458. typedef sqlite3_int64 i64;
  163459. #endif
  163460. /*
  163461. ** These values must match the values defined in wal.c for the equivalent
  163462. ** locks. These are not magic numbers as they are part of the SQLite file
  163463. ** format.
  163464. */
  163465. #define WAL_LOCK_WRITE 0
  163466. #define WAL_LOCK_CKPT 1
  163467. #define WAL_LOCK_READ0 3
  163468. #define SQLITE_FCNTL_RBUCNT 5149216
  163469. /*
  163470. ** A structure to store values read from the rbu_state table in memory.
  163471. */
  163472. struct RbuState {
  163473. int eStage;
  163474. char *zTbl;
  163475. char *zIdx;
  163476. i64 iWalCksum;
  163477. int nRow;
  163478. i64 nProgress;
  163479. u32 iCookie;
  163480. i64 iOalSz;
  163481. i64 nPhaseOneStep;
  163482. };
  163483. struct RbuUpdateStmt {
  163484. char *zMask; /* Copy of update mask used with pUpdate */
  163485. sqlite3_stmt *pUpdate; /* Last update statement (or NULL) */
  163486. RbuUpdateStmt *pNext;
  163487. };
  163488. /*
  163489. ** An iterator of this type is used to iterate through all objects in
  163490. ** the target database that require updating. For each such table, the
  163491. ** iterator visits, in order:
  163492. **
  163493. ** * the table itself,
  163494. ** * each index of the table (zero or more points to visit), and
  163495. ** * a special "cleanup table" state.
  163496. **
  163497. ** abIndexed:
  163498. ** If the table has no indexes on it, abIndexed is set to NULL. Otherwise,
  163499. ** it points to an array of flags nTblCol elements in size. The flag is
  163500. ** set for each column that is either a part of the PK or a part of an
  163501. ** index. Or clear otherwise.
  163502. **
  163503. */
  163504. struct RbuObjIter {
  163505. sqlite3_stmt *pTblIter; /* Iterate through tables */
  163506. sqlite3_stmt *pIdxIter; /* Index iterator */
  163507. int nTblCol; /* Size of azTblCol[] array */
  163508. char **azTblCol; /* Array of unquoted target column names */
  163509. char **azTblType; /* Array of target column types */
  163510. int *aiSrcOrder; /* src table col -> target table col */
  163511. u8 *abTblPk; /* Array of flags, set on target PK columns */
  163512. u8 *abNotNull; /* Array of flags, set on NOT NULL columns */
  163513. u8 *abIndexed; /* Array of flags, set on indexed & PK cols */
  163514. int eType; /* Table type - an RBU_PK_XXX value */
  163515. /* Output variables. zTbl==0 implies EOF. */
  163516. int bCleanup; /* True in "cleanup" state */
  163517. const char *zTbl; /* Name of target db table */
  163518. const char *zDataTbl; /* Name of rbu db table (or null) */
  163519. const char *zIdx; /* Name of target db index (or null) */
  163520. int iTnum; /* Root page of current object */
  163521. int iPkTnum; /* If eType==EXTERNAL, root of PK index */
  163522. int bUnique; /* Current index is unique */
  163523. int nIndex; /* Number of aux. indexes on table zTbl */
  163524. /* Statements created by rbuObjIterPrepareAll() */
  163525. int nCol; /* Number of columns in current object */
  163526. sqlite3_stmt *pSelect; /* Source data */
  163527. sqlite3_stmt *pInsert; /* Statement for INSERT operations */
  163528. sqlite3_stmt *pDelete; /* Statement for DELETE ops */
  163529. sqlite3_stmt *pTmpInsert; /* Insert into rbu_tmp_$zDataTbl */
  163530. /* Last UPDATE used (for PK b-tree updates only), or NULL. */
  163531. RbuUpdateStmt *pRbuUpdate;
  163532. };
  163533. /*
  163534. ** Values for RbuObjIter.eType
  163535. **
  163536. ** 0: Table does not exist (error)
  163537. ** 1: Table has an implicit rowid.
  163538. ** 2: Table has an explicit IPK column.
  163539. ** 3: Table has an external PK index.
  163540. ** 4: Table is WITHOUT ROWID.
  163541. ** 5: Table is a virtual table.
  163542. */
  163543. #define RBU_PK_NOTABLE 0
  163544. #define RBU_PK_NONE 1
  163545. #define RBU_PK_IPK 2
  163546. #define RBU_PK_EXTERNAL 3
  163547. #define RBU_PK_WITHOUT_ROWID 4
  163548. #define RBU_PK_VTAB 5
  163549. /*
  163550. ** Within the RBU_STAGE_OAL stage, each call to sqlite3rbu_step() performs
  163551. ** one of the following operations.
  163552. */
  163553. #define RBU_INSERT 1 /* Insert on a main table b-tree */
  163554. #define RBU_DELETE 2 /* Delete a row from a main table b-tree */
  163555. #define RBU_REPLACE 3 /* Delete and then insert a row */
  163556. #define RBU_IDX_DELETE 4 /* Delete a row from an aux. index b-tree */
  163557. #define RBU_IDX_INSERT 5 /* Insert on an aux. index b-tree */
  163558. #define RBU_UPDATE 6 /* Update a row in a main table b-tree */
  163559. /*
  163560. ** A single step of an incremental checkpoint - frame iWalFrame of the wal
  163561. ** file should be copied to page iDbPage of the database file.
  163562. */
  163563. struct RbuFrame {
  163564. u32 iDbPage;
  163565. u32 iWalFrame;
  163566. };
  163567. /*
  163568. ** RBU handle.
  163569. **
  163570. ** nPhaseOneStep:
  163571. ** If the RBU database contains an rbu_count table, this value is set to
  163572. ** a running estimate of the number of b-tree operations required to
  163573. ** finish populating the *-oal file. This allows the sqlite3_bp_progress()
  163574. ** API to calculate the permyriadage progress of populating the *-oal file
  163575. ** using the formula:
  163576. **
  163577. ** permyriadage = (10000 * nProgress) / nPhaseOneStep
  163578. **
  163579. ** nPhaseOneStep is initialized to the sum of:
  163580. **
  163581. ** nRow * (nIndex + 1)
  163582. **
  163583. ** for all source tables in the RBU database, where nRow is the number
  163584. ** of rows in the source table and nIndex the number of indexes on the
  163585. ** corresponding target database table.
  163586. **
  163587. ** This estimate is accurate if the RBU update consists entirely of
  163588. ** INSERT operations. However, it is inaccurate if:
  163589. **
  163590. ** * the RBU update contains any UPDATE operations. If the PK specified
  163591. ** for an UPDATE operation does not exist in the target table, then
  163592. ** no b-tree operations are required on index b-trees. Or if the
  163593. ** specified PK does exist, then (nIndex*2) such operations are
  163594. ** required (one delete and one insert on each index b-tree).
  163595. **
  163596. ** * the RBU update contains any DELETE operations for which the specified
  163597. ** PK does not exist. In this case no operations are required on index
  163598. ** b-trees.
  163599. **
  163600. ** * the RBU update contains REPLACE operations. These are similar to
  163601. ** UPDATE operations.
  163602. **
  163603. ** nPhaseOneStep is updated to account for the conditions above during the
  163604. ** first pass of each source table. The updated nPhaseOneStep value is
  163605. ** stored in the rbu_state table if the RBU update is suspended.
  163606. */
  163607. struct sqlite3rbu {
  163608. int eStage; /* Value of RBU_STATE_STAGE field */
  163609. sqlite3 *dbMain; /* target database handle */
  163610. sqlite3 *dbRbu; /* rbu database handle */
  163611. char *zTarget; /* Path to target db */
  163612. char *zRbu; /* Path to rbu db */
  163613. char *zState; /* Path to state db (or NULL if zRbu) */
  163614. char zStateDb[5]; /* Db name for state ("stat" or "main") */
  163615. int rc; /* Value returned by last rbu_step() call */
  163616. char *zErrmsg; /* Error message if rc!=SQLITE_OK */
  163617. int nStep; /* Rows processed for current object */
  163618. int nProgress; /* Rows processed for all objects */
  163619. RbuObjIter objiter; /* Iterator for skipping through tbl/idx */
  163620. const char *zVfsName; /* Name of automatically created rbu vfs */
  163621. rbu_file *pTargetFd; /* File handle open on target db */
  163622. int nPagePerSector; /* Pages per sector for pTargetFd */
  163623. i64 iOalSz;
  163624. i64 nPhaseOneStep;
  163625. /* The following state variables are used as part of the incremental
  163626. ** checkpoint stage (eStage==RBU_STAGE_CKPT). See comments surrounding
  163627. ** function rbuSetupCheckpoint() for details. */
  163628. u32 iMaxFrame; /* Largest iWalFrame value in aFrame[] */
  163629. u32 mLock;
  163630. int nFrame; /* Entries in aFrame[] array */
  163631. int nFrameAlloc; /* Allocated size of aFrame[] array */
  163632. RbuFrame *aFrame;
  163633. int pgsz;
  163634. u8 *aBuf;
  163635. i64 iWalCksum;
  163636. i64 szTemp; /* Current size of all temp files in use */
  163637. i64 szTempLimit; /* Total size limit for temp files */
  163638. /* Used in RBU vacuum mode only */
  163639. int nRbu; /* Number of RBU VFS in the stack */
  163640. rbu_file *pRbuFd; /* Fd for main db of dbRbu */
  163641. };
  163642. /*
  163643. ** An rbu VFS is implemented using an instance of this structure.
  163644. **
  163645. ** Variable pRbu is only non-NULL for automatically created RBU VFS objects.
  163646. ** It is NULL for RBU VFS objects created explicitly using
  163647. ** sqlite3rbu_create_vfs(). It is used to track the total amount of temp
  163648. ** space used by the RBU handle.
  163649. */
  163650. struct rbu_vfs {
  163651. sqlite3_vfs base; /* rbu VFS shim methods */
  163652. sqlite3_vfs *pRealVfs; /* Underlying VFS */
  163653. sqlite3_mutex *mutex; /* Mutex to protect pMain */
  163654. sqlite3rbu *pRbu; /* Owner RBU object */
  163655. rbu_file *pMain; /* Linked list of main db files */
  163656. };
  163657. /*
  163658. ** Each file opened by an rbu VFS is represented by an instance of
  163659. ** the following structure.
  163660. **
  163661. ** If this is a temporary file (pRbu!=0 && flags&DELETE_ON_CLOSE), variable
  163662. ** "sz" is set to the current size of the database file.
  163663. */
  163664. struct rbu_file {
  163665. sqlite3_file base; /* sqlite3_file methods */
  163666. sqlite3_file *pReal; /* Underlying file handle */
  163667. rbu_vfs *pRbuVfs; /* Pointer to the rbu_vfs object */
  163668. sqlite3rbu *pRbu; /* Pointer to rbu object (rbu target only) */
  163669. i64 sz; /* Size of file in bytes (temp only) */
  163670. int openFlags; /* Flags this file was opened with */
  163671. u32 iCookie; /* Cookie value for main db files */
  163672. u8 iWriteVer; /* "write-version" value for main db files */
  163673. u8 bNolock; /* True to fail EXCLUSIVE locks */
  163674. int nShm; /* Number of entries in apShm[] array */
  163675. char **apShm; /* Array of mmap'd *-shm regions */
  163676. char *zDel; /* Delete this when closing file */
  163677. const char *zWal; /* Wal filename for this main db file */
  163678. rbu_file *pWalFd; /* Wal file descriptor for this main db */
  163679. rbu_file *pMainNext; /* Next MAIN_DB file */
  163680. };
  163681. /*
  163682. ** True for an RBU vacuum handle, or false otherwise.
  163683. */
  163684. #define rbuIsVacuum(p) ((p)->zTarget==0)
  163685. /*************************************************************************
  163686. ** The following three functions, found below:
  163687. **
  163688. ** rbuDeltaGetInt()
  163689. ** rbuDeltaChecksum()
  163690. ** rbuDeltaApply()
  163691. **
  163692. ** are lifted from the fossil source code (http://fossil-scm.org). They
  163693. ** are used to implement the scalar SQL function rbu_fossil_delta().
  163694. */
  163695. /*
  163696. ** Read bytes from *pz and convert them into a positive integer. When
  163697. ** finished, leave *pz pointing to the first character past the end of
  163698. ** the integer. The *pLen parameter holds the length of the string
  163699. ** in *pz and is decremented once for each character in the integer.
  163700. */
  163701. static unsigned int rbuDeltaGetInt(const char **pz, int *pLen){
  163702. static const signed char zValue[] = {
  163703. -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
  163704. -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
  163705. -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
  163706. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1, -1, -1, -1,
  163707. -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24,
  163708. 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, 36,
  163709. -1, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51,
  163710. 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, -1, -1, -1, 63, -1,
  163711. };
  163712. unsigned int v = 0;
  163713. int c;
  163714. unsigned char *z = (unsigned char*)*pz;
  163715. unsigned char *zStart = z;
  163716. while( (c = zValue[0x7f&*(z++)])>=0 ){
  163717. v = (v<<6) + c;
  163718. }
  163719. z--;
  163720. *pLen -= z - zStart;
  163721. *pz = (char*)z;
  163722. return v;
  163723. }
  163724. #if RBU_ENABLE_DELTA_CKSUM
  163725. /*
  163726. ** Compute a 32-bit checksum on the N-byte buffer. Return the result.
  163727. */
  163728. static unsigned int rbuDeltaChecksum(const char *zIn, size_t N){
  163729. const unsigned char *z = (const unsigned char *)zIn;
  163730. unsigned sum0 = 0;
  163731. unsigned sum1 = 0;
  163732. unsigned sum2 = 0;
  163733. unsigned sum3 = 0;
  163734. while(N >= 16){
  163735. sum0 += ((unsigned)z[0] + z[4] + z[8] + z[12]);
  163736. sum1 += ((unsigned)z[1] + z[5] + z[9] + z[13]);
  163737. sum2 += ((unsigned)z[2] + z[6] + z[10]+ z[14]);
  163738. sum3 += ((unsigned)z[3] + z[7] + z[11]+ z[15]);
  163739. z += 16;
  163740. N -= 16;
  163741. }
  163742. while(N >= 4){
  163743. sum0 += z[0];
  163744. sum1 += z[1];
  163745. sum2 += z[2];
  163746. sum3 += z[3];
  163747. z += 4;
  163748. N -= 4;
  163749. }
  163750. sum3 += (sum2 << 8) + (sum1 << 16) + (sum0 << 24);
  163751. switch(N){
  163752. case 3: sum3 += (z[2] << 8);
  163753. case 2: sum3 += (z[1] << 16);
  163754. case 1: sum3 += (z[0] << 24);
  163755. default: ;
  163756. }
  163757. return sum3;
  163758. }
  163759. #endif
  163760. /*
  163761. ** Apply a delta.
  163762. **
  163763. ** The output buffer should be big enough to hold the whole output
  163764. ** file and a NUL terminator at the end. The delta_output_size()
  163765. ** routine will determine this size for you.
  163766. **
  163767. ** The delta string should be null-terminated. But the delta string
  163768. ** may contain embedded NUL characters (if the input and output are
  163769. ** binary files) so we also have to pass in the length of the delta in
  163770. ** the lenDelta parameter.
  163771. **
  163772. ** This function returns the size of the output file in bytes (excluding
  163773. ** the final NUL terminator character). Except, if the delta string is
  163774. ** malformed or intended for use with a source file other than zSrc,
  163775. ** then this routine returns -1.
  163776. **
  163777. ** Refer to the delta_create() documentation above for a description
  163778. ** of the delta file format.
  163779. */
  163780. static int rbuDeltaApply(
  163781. const char *zSrc, /* The source or pattern file */
  163782. int lenSrc, /* Length of the source file */
  163783. const char *zDelta, /* Delta to apply to the pattern */
  163784. int lenDelta, /* Length of the delta */
  163785. char *zOut /* Write the output into this preallocated buffer */
  163786. ){
  163787. unsigned int limit;
  163788. unsigned int total = 0;
  163789. #if RBU_ENABLE_DELTA_CKSUM
  163790. char *zOrigOut = zOut;
  163791. #endif
  163792. limit = rbuDeltaGetInt(&zDelta, &lenDelta);
  163793. if( *zDelta!='\n' ){
  163794. /* ERROR: size integer not terminated by "\n" */
  163795. return -1;
  163796. }
  163797. zDelta++; lenDelta--;
  163798. while( *zDelta && lenDelta>0 ){
  163799. unsigned int cnt, ofst;
  163800. cnt = rbuDeltaGetInt(&zDelta, &lenDelta);
  163801. switch( zDelta[0] ){
  163802. case '@': {
  163803. zDelta++; lenDelta--;
  163804. ofst = rbuDeltaGetInt(&zDelta, &lenDelta);
  163805. if( lenDelta>0 && zDelta[0]!=',' ){
  163806. /* ERROR: copy command not terminated by ',' */
  163807. return -1;
  163808. }
  163809. zDelta++; lenDelta--;
  163810. total += cnt;
  163811. if( total>limit ){
  163812. /* ERROR: copy exceeds output file size */
  163813. return -1;
  163814. }
  163815. if( (int)(ofst+cnt) > lenSrc ){
  163816. /* ERROR: copy extends past end of input */
  163817. return -1;
  163818. }
  163819. memcpy(zOut, &zSrc[ofst], cnt);
  163820. zOut += cnt;
  163821. break;
  163822. }
  163823. case ':': {
  163824. zDelta++; lenDelta--;
  163825. total += cnt;
  163826. if( total>limit ){
  163827. /* ERROR: insert command gives an output larger than predicted */
  163828. return -1;
  163829. }
  163830. if( (int)cnt>lenDelta ){
  163831. /* ERROR: insert count exceeds size of delta */
  163832. return -1;
  163833. }
  163834. memcpy(zOut, zDelta, cnt);
  163835. zOut += cnt;
  163836. zDelta += cnt;
  163837. lenDelta -= cnt;
  163838. break;
  163839. }
  163840. case ';': {
  163841. zDelta++; lenDelta--;
  163842. zOut[0] = 0;
  163843. #if RBU_ENABLE_DELTA_CKSUM
  163844. if( cnt!=rbuDeltaChecksum(zOrigOut, total) ){
  163845. /* ERROR: bad checksum */
  163846. return -1;
  163847. }
  163848. #endif
  163849. if( total!=limit ){
  163850. /* ERROR: generated size does not match predicted size */
  163851. return -1;
  163852. }
  163853. return total;
  163854. }
  163855. default: {
  163856. /* ERROR: unknown delta operator */
  163857. return -1;
  163858. }
  163859. }
  163860. }
  163861. /* ERROR: unterminated delta */
  163862. return -1;
  163863. }
  163864. static int rbuDeltaOutputSize(const char *zDelta, int lenDelta){
  163865. int size;
  163866. size = rbuDeltaGetInt(&zDelta, &lenDelta);
  163867. if( *zDelta!='\n' ){
  163868. /* ERROR: size integer not terminated by "\n" */
  163869. return -1;
  163870. }
  163871. return size;
  163872. }
  163873. /*
  163874. ** End of code taken from fossil.
  163875. *************************************************************************/
  163876. /*
  163877. ** Implementation of SQL scalar function rbu_fossil_delta().
  163878. **
  163879. ** This function applies a fossil delta patch to a blob. Exactly two
  163880. ** arguments must be passed to this function. The first is the blob to
  163881. ** patch and the second the patch to apply. If no error occurs, this
  163882. ** function returns the patched blob.
  163883. */
  163884. static void rbuFossilDeltaFunc(
  163885. sqlite3_context *context,
  163886. int argc,
  163887. sqlite3_value **argv
  163888. ){
  163889. const char *aDelta;
  163890. int nDelta;
  163891. const char *aOrig;
  163892. int nOrig;
  163893. int nOut;
  163894. int nOut2;
  163895. char *aOut;
  163896. assert( argc==2 );
  163897. nOrig = sqlite3_value_bytes(argv[0]);
  163898. aOrig = (const char*)sqlite3_value_blob(argv[0]);
  163899. nDelta = sqlite3_value_bytes(argv[1]);
  163900. aDelta = (const char*)sqlite3_value_blob(argv[1]);
  163901. /* Figure out the size of the output */
  163902. nOut = rbuDeltaOutputSize(aDelta, nDelta);
  163903. if( nOut<0 ){
  163904. sqlite3_result_error(context, "corrupt fossil delta", -1);
  163905. return;
  163906. }
  163907. aOut = sqlite3_malloc(nOut+1);
  163908. if( aOut==0 ){
  163909. sqlite3_result_error_nomem(context);
  163910. }else{
  163911. nOut2 = rbuDeltaApply(aOrig, nOrig, aDelta, nDelta, aOut);
  163912. if( nOut2!=nOut ){
  163913. sqlite3_result_error(context, "corrupt fossil delta", -1);
  163914. }else{
  163915. sqlite3_result_blob(context, aOut, nOut, sqlite3_free);
  163916. }
  163917. }
  163918. }
  163919. /*
  163920. ** Prepare the SQL statement in buffer zSql against database handle db.
  163921. ** If successful, set *ppStmt to point to the new statement and return
  163922. ** SQLITE_OK.
  163923. **
  163924. ** Otherwise, if an error does occur, set *ppStmt to NULL and return
  163925. ** an SQLite error code. Additionally, set output variable *pzErrmsg to
  163926. ** point to a buffer containing an error message. It is the responsibility
  163927. ** of the caller to (eventually) free this buffer using sqlite3_free().
  163928. */
  163929. static int prepareAndCollectError(
  163930. sqlite3 *db,
  163931. sqlite3_stmt **ppStmt,
  163932. char **pzErrmsg,
  163933. const char *zSql
  163934. ){
  163935. int rc = sqlite3_prepare_v2(db, zSql, -1, ppStmt, 0);
  163936. if( rc!=SQLITE_OK ){
  163937. *pzErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  163938. *ppStmt = 0;
  163939. }
  163940. return rc;
  163941. }
  163942. /*
  163943. ** Reset the SQL statement passed as the first argument. Return a copy
  163944. ** of the value returned by sqlite3_reset().
  163945. **
  163946. ** If an error has occurred, then set *pzErrmsg to point to a buffer
  163947. ** containing an error message. It is the responsibility of the caller
  163948. ** to eventually free this buffer using sqlite3_free().
  163949. */
  163950. static int resetAndCollectError(sqlite3_stmt *pStmt, char **pzErrmsg){
  163951. int rc = sqlite3_reset(pStmt);
  163952. if( rc!=SQLITE_OK ){
  163953. *pzErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(sqlite3_db_handle(pStmt)));
  163954. }
  163955. return rc;
  163956. }
  163957. /*
  163958. ** Unless it is NULL, argument zSql points to a buffer allocated using
  163959. ** sqlite3_malloc containing an SQL statement. This function prepares the SQL
  163960. ** statement against database db and frees the buffer. If statement
  163961. ** compilation is successful, *ppStmt is set to point to the new statement
  163962. ** handle and SQLITE_OK is returned.
  163963. **
  163964. ** Otherwise, if an error occurs, *ppStmt is set to NULL and an error code
  163965. ** returned. In this case, *pzErrmsg may also be set to point to an error
  163966. ** message. It is the responsibility of the caller to free this error message
  163967. ** buffer using sqlite3_free().
  163968. **
  163969. ** If argument zSql is NULL, this function assumes that an OOM has occurred.
  163970. ** In this case SQLITE_NOMEM is returned and *ppStmt set to NULL.
  163971. */
  163972. static int prepareFreeAndCollectError(
  163973. sqlite3 *db,
  163974. sqlite3_stmt **ppStmt,
  163975. char **pzErrmsg,
  163976. char *zSql
  163977. ){
  163978. int rc;
  163979. assert( *pzErrmsg==0 );
  163980. if( zSql==0 ){
  163981. rc = SQLITE_NOMEM;
  163982. *ppStmt = 0;
  163983. }else{
  163984. rc = prepareAndCollectError(db, ppStmt, pzErrmsg, zSql);
  163985. sqlite3_free(zSql);
  163986. }
  163987. return rc;
  163988. }
  163989. /*
  163990. ** Free the RbuObjIter.azTblCol[] and RbuObjIter.abTblPk[] arrays allocated
  163991. ** by an earlier call to rbuObjIterCacheTableInfo().
  163992. */
  163993. static void rbuObjIterFreeCols(RbuObjIter *pIter){
  163994. int i;
  163995. for(i=0; i<pIter->nTblCol; i++){
  163996. sqlite3_free(pIter->azTblCol[i]);
  163997. sqlite3_free(pIter->azTblType[i]);
  163998. }
  163999. sqlite3_free(pIter->azTblCol);
  164000. pIter->azTblCol = 0;
  164001. pIter->azTblType = 0;
  164002. pIter->aiSrcOrder = 0;
  164003. pIter->abTblPk = 0;
  164004. pIter->abNotNull = 0;
  164005. pIter->nTblCol = 0;
  164006. pIter->eType = 0; /* Invalid value */
  164007. }
  164008. /*
  164009. ** Finalize all statements and free all allocations that are specific to
  164010. ** the current object (table/index pair).
  164011. */
  164012. static void rbuObjIterClearStatements(RbuObjIter *pIter){
  164013. RbuUpdateStmt *pUp;
  164014. sqlite3_finalize(pIter->pSelect);
  164015. sqlite3_finalize(pIter->pInsert);
  164016. sqlite3_finalize(pIter->pDelete);
  164017. sqlite3_finalize(pIter->pTmpInsert);
  164018. pUp = pIter->pRbuUpdate;
  164019. while( pUp ){
  164020. RbuUpdateStmt *pTmp = pUp->pNext;
  164021. sqlite3_finalize(pUp->pUpdate);
  164022. sqlite3_free(pUp);
  164023. pUp = pTmp;
  164024. }
  164025. pIter->pSelect = 0;
  164026. pIter->pInsert = 0;
  164027. pIter->pDelete = 0;
  164028. pIter->pRbuUpdate = 0;
  164029. pIter->pTmpInsert = 0;
  164030. pIter->nCol = 0;
  164031. }
  164032. /*
  164033. ** Clean up any resources allocated as part of the iterator object passed
  164034. ** as the only argument.
  164035. */
  164036. static void rbuObjIterFinalize(RbuObjIter *pIter){
  164037. rbuObjIterClearStatements(pIter);
  164038. sqlite3_finalize(pIter->pTblIter);
  164039. sqlite3_finalize(pIter->pIdxIter);
  164040. rbuObjIterFreeCols(pIter);
  164041. memset(pIter, 0, sizeof(RbuObjIter));
  164042. }
  164043. /*
  164044. ** Advance the iterator to the next position.
  164045. **
  164046. ** If no error occurs, SQLITE_OK is returned and the iterator is left
  164047. ** pointing to the next entry. Otherwise, an error code and message is
  164048. ** left in the RBU handle passed as the first argument. A copy of the
  164049. ** error code is returned.
  164050. */
  164051. static int rbuObjIterNext(sqlite3rbu *p, RbuObjIter *pIter){
  164052. int rc = p->rc;
  164053. if( rc==SQLITE_OK ){
  164054. /* Free any SQLite statements used while processing the previous object */
  164055. rbuObjIterClearStatements(pIter);
  164056. if( pIter->zIdx==0 ){
  164057. rc = sqlite3_exec(p->dbMain,
  164058. "DROP TRIGGER IF EXISTS temp.rbu_insert_tr;"
  164059. "DROP TRIGGER IF EXISTS temp.rbu_update1_tr;"
  164060. "DROP TRIGGER IF EXISTS temp.rbu_update2_tr;"
  164061. "DROP TRIGGER IF EXISTS temp.rbu_delete_tr;"
  164062. , 0, 0, &p->zErrmsg
  164063. );
  164064. }
  164065. if( rc==SQLITE_OK ){
  164066. if( pIter->bCleanup ){
  164067. rbuObjIterFreeCols(pIter);
  164068. pIter->bCleanup = 0;
  164069. rc = sqlite3_step(pIter->pTblIter);
  164070. if( rc!=SQLITE_ROW ){
  164071. rc = resetAndCollectError(pIter->pTblIter, &p->zErrmsg);
  164072. pIter->zTbl = 0;
  164073. }else{
  164074. pIter->zTbl = (const char*)sqlite3_column_text(pIter->pTblIter, 0);
  164075. pIter->zDataTbl = (const char*)sqlite3_column_text(pIter->pTblIter,1);
  164076. rc = (pIter->zDataTbl && pIter->zTbl) ? SQLITE_OK : SQLITE_NOMEM;
  164077. }
  164078. }else{
  164079. if( pIter->zIdx==0 ){
  164080. sqlite3_stmt *pIdx = pIter->pIdxIter;
  164081. rc = sqlite3_bind_text(pIdx, 1, pIter->zTbl, -1, SQLITE_STATIC);
  164082. }
  164083. if( rc==SQLITE_OK ){
  164084. rc = sqlite3_step(pIter->pIdxIter);
  164085. if( rc!=SQLITE_ROW ){
  164086. rc = resetAndCollectError(pIter->pIdxIter, &p->zErrmsg);
  164087. pIter->bCleanup = 1;
  164088. pIter->zIdx = 0;
  164089. }else{
  164090. pIter->zIdx = (const char*)sqlite3_column_text(pIter->pIdxIter, 0);
  164091. pIter->iTnum = sqlite3_column_int(pIter->pIdxIter, 1);
  164092. pIter->bUnique = sqlite3_column_int(pIter->pIdxIter, 2);
  164093. rc = pIter->zIdx ? SQLITE_OK : SQLITE_NOMEM;
  164094. }
  164095. }
  164096. }
  164097. }
  164098. }
  164099. if( rc!=SQLITE_OK ){
  164100. rbuObjIterFinalize(pIter);
  164101. p->rc = rc;
  164102. }
  164103. return rc;
  164104. }
  164105. /*
  164106. ** The implementation of the rbu_target_name() SQL function. This function
  164107. ** accepts one or two arguments. The first argument is the name of a table -
  164108. ** the name of a table in the RBU database. The second, if it is present, is 1
  164109. ** for a view or 0 for a table.
  164110. **
  164111. ** For a non-vacuum RBU handle, if the table name matches the pattern:
  164112. **
  164113. ** data[0-9]_<name>
  164114. **
  164115. ** where <name> is any sequence of 1 or more characters, <name> is returned.
  164116. ** Otherwise, if the only argument does not match the above pattern, an SQL
  164117. ** NULL is returned.
  164118. **
  164119. ** "data_t1" -> "t1"
  164120. ** "data0123_t2" -> "t2"
  164121. ** "dataAB_t3" -> NULL
  164122. **
  164123. ** For an rbu vacuum handle, a copy of the first argument is returned if
  164124. ** the second argument is either missing or 0 (not a view).
  164125. */
  164126. static void rbuTargetNameFunc(
  164127. sqlite3_context *pCtx,
  164128. int argc,
  164129. sqlite3_value **argv
  164130. ){
  164131. sqlite3rbu *p = sqlite3_user_data(pCtx);
  164132. const char *zIn;
  164133. assert( argc==1 || argc==2 );
  164134. zIn = (const char*)sqlite3_value_text(argv[0]);
  164135. if( zIn ){
  164136. if( rbuIsVacuum(p) ){
  164137. if( argc==1 || 0==sqlite3_value_int(argv[1]) ){
  164138. sqlite3_result_text(pCtx, zIn, -1, SQLITE_STATIC);
  164139. }
  164140. }else{
  164141. if( strlen(zIn)>4 && memcmp("data", zIn, 4)==0 ){
  164142. int i;
  164143. for(i=4; zIn[i]>='0' && zIn[i]<='9'; i++);
  164144. if( zIn[i]=='_' && zIn[i+1] ){
  164145. sqlite3_result_text(pCtx, &zIn[i+1], -1, SQLITE_STATIC);
  164146. }
  164147. }
  164148. }
  164149. }
  164150. }
  164151. /*
  164152. ** Initialize the iterator structure passed as the second argument.
  164153. **
  164154. ** If no error occurs, SQLITE_OK is returned and the iterator is left
  164155. ** pointing to the first entry. Otherwise, an error code and message is
  164156. ** left in the RBU handle passed as the first argument. A copy of the
  164157. ** error code is returned.
  164158. */
  164159. static int rbuObjIterFirst(sqlite3rbu *p, RbuObjIter *pIter){
  164160. int rc;
  164161. memset(pIter, 0, sizeof(RbuObjIter));
  164162. rc = prepareFreeAndCollectError(p->dbRbu, &pIter->pTblIter, &p->zErrmsg,
  164163. sqlite3_mprintf(
  164164. "SELECT rbu_target_name(name, type='view') AS target, name "
  164165. "FROM sqlite_master "
  164166. "WHERE type IN ('table', 'view') AND target IS NOT NULL "
  164167. " %s "
  164168. "ORDER BY name"
  164169. , rbuIsVacuum(p) ? "AND rootpage!=0 AND rootpage IS NOT NULL" : ""));
  164170. if( rc==SQLITE_OK ){
  164171. rc = prepareAndCollectError(p->dbMain, &pIter->pIdxIter, &p->zErrmsg,
  164172. "SELECT name, rootpage, sql IS NULL OR substr(8, 6)=='UNIQUE' "
  164173. " FROM main.sqlite_master "
  164174. " WHERE type='index' AND tbl_name = ?"
  164175. );
  164176. }
  164177. pIter->bCleanup = 1;
  164178. p->rc = rc;
  164179. return rbuObjIterNext(p, pIter);
  164180. }
  164181. /*
  164182. ** This is a wrapper around "sqlite3_mprintf(zFmt, ...)". If an OOM occurs,
  164183. ** an error code is stored in the RBU handle passed as the first argument.
  164184. **
  164185. ** If an error has already occurred (p->rc is already set to something other
  164186. ** than SQLITE_OK), then this function returns NULL without modifying the
  164187. ** stored error code. In this case it still calls sqlite3_free() on any
  164188. ** printf() parameters associated with %z conversions.
  164189. */
  164190. static char *rbuMPrintf(sqlite3rbu *p, const char *zFmt, ...){
  164191. char *zSql = 0;
  164192. va_list ap;
  164193. va_start(ap, zFmt);
  164194. zSql = sqlite3_vmprintf(zFmt, ap);
  164195. if( p->rc==SQLITE_OK ){
  164196. if( zSql==0 ) p->rc = SQLITE_NOMEM;
  164197. }else{
  164198. sqlite3_free(zSql);
  164199. zSql = 0;
  164200. }
  164201. va_end(ap);
  164202. return zSql;
  164203. }
  164204. /*
  164205. ** Argument zFmt is a sqlite3_mprintf() style format string. The trailing
  164206. ** arguments are the usual subsitution values. This function performs
  164207. ** the printf() style substitutions and executes the result as an SQL
  164208. ** statement on the RBU handles database.
  164209. **
  164210. ** If an error occurs, an error code and error message is stored in the
  164211. ** RBU handle. If an error has already occurred when this function is
  164212. ** called, it is a no-op.
  164213. */
  164214. static int rbuMPrintfExec(sqlite3rbu *p, sqlite3 *db, const char *zFmt, ...){
  164215. va_list ap;
  164216. char *zSql;
  164217. va_start(ap, zFmt);
  164218. zSql = sqlite3_vmprintf(zFmt, ap);
  164219. if( p->rc==SQLITE_OK ){
  164220. if( zSql==0 ){
  164221. p->rc = SQLITE_NOMEM;
  164222. }else{
  164223. p->rc = sqlite3_exec(db, zSql, 0, 0, &p->zErrmsg);
  164224. }
  164225. }
  164226. sqlite3_free(zSql);
  164227. va_end(ap);
  164228. return p->rc;
  164229. }
  164230. /*
  164231. ** Attempt to allocate and return a pointer to a zeroed block of nByte
  164232. ** bytes.
  164233. **
  164234. ** If an error (i.e. an OOM condition) occurs, return NULL and leave an
  164235. ** error code in the rbu handle passed as the first argument. Or, if an
  164236. ** error has already occurred when this function is called, return NULL
  164237. ** immediately without attempting the allocation or modifying the stored
  164238. ** error code.
  164239. */
  164240. static void *rbuMalloc(sqlite3rbu *p, int nByte){
  164241. void *pRet = 0;
  164242. if( p->rc==SQLITE_OK ){
  164243. assert( nByte>0 );
  164244. pRet = sqlite3_malloc64(nByte);
  164245. if( pRet==0 ){
  164246. p->rc = SQLITE_NOMEM;
  164247. }else{
  164248. memset(pRet, 0, nByte);
  164249. }
  164250. }
  164251. return pRet;
  164252. }
  164253. /*
  164254. ** Allocate and zero the pIter->azTblCol[] and abTblPk[] arrays so that
  164255. ** there is room for at least nCol elements. If an OOM occurs, store an
  164256. ** error code in the RBU handle passed as the first argument.
  164257. */
  164258. static void rbuAllocateIterArrays(sqlite3rbu *p, RbuObjIter *pIter, int nCol){
  164259. int nByte = (2*sizeof(char*) + sizeof(int) + 3*sizeof(u8)) * nCol;
  164260. char **azNew;
  164261. azNew = (char**)rbuMalloc(p, nByte);
  164262. if( azNew ){
  164263. pIter->azTblCol = azNew;
  164264. pIter->azTblType = &azNew[nCol];
  164265. pIter->aiSrcOrder = (int*)&pIter->azTblType[nCol];
  164266. pIter->abTblPk = (u8*)&pIter->aiSrcOrder[nCol];
  164267. pIter->abNotNull = (u8*)&pIter->abTblPk[nCol];
  164268. pIter->abIndexed = (u8*)&pIter->abNotNull[nCol];
  164269. }
  164270. }
  164271. /*
  164272. ** The first argument must be a nul-terminated string. This function
  164273. ** returns a copy of the string in memory obtained from sqlite3_malloc().
  164274. ** It is the responsibility of the caller to eventually free this memory
  164275. ** using sqlite3_free().
  164276. **
  164277. ** If an OOM condition is encountered when attempting to allocate memory,
  164278. ** output variable (*pRc) is set to SQLITE_NOMEM before returning. Otherwise,
  164279. ** if the allocation succeeds, (*pRc) is left unchanged.
  164280. */
  164281. static char *rbuStrndup(const char *zStr, int *pRc){
  164282. char *zRet = 0;
  164283. assert( *pRc==SQLITE_OK );
  164284. if( zStr ){
  164285. size_t nCopy = strlen(zStr) + 1;
  164286. zRet = (char*)sqlite3_malloc64(nCopy);
  164287. if( zRet ){
  164288. memcpy(zRet, zStr, nCopy);
  164289. }else{
  164290. *pRc = SQLITE_NOMEM;
  164291. }
  164292. }
  164293. return zRet;
  164294. }
  164295. /*
  164296. ** Finalize the statement passed as the second argument.
  164297. **
  164298. ** If the sqlite3_finalize() call indicates that an error occurs, and the
  164299. ** rbu handle error code is not already set, set the error code and error
  164300. ** message accordingly.
  164301. */
  164302. static void rbuFinalize(sqlite3rbu *p, sqlite3_stmt *pStmt){
  164303. sqlite3 *db = sqlite3_db_handle(pStmt);
  164304. int rc = sqlite3_finalize(pStmt);
  164305. if( p->rc==SQLITE_OK && rc!=SQLITE_OK ){
  164306. p->rc = rc;
  164307. p->zErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  164308. }
  164309. }
  164310. /* Determine the type of a table.
  164311. **
  164312. ** peType is of type (int*), a pointer to an output parameter of type
  164313. ** (int). This call sets the output parameter as follows, depending
  164314. ** on the type of the table specified by parameters dbName and zTbl.
  164315. **
  164316. ** RBU_PK_NOTABLE: No such table.
  164317. ** RBU_PK_NONE: Table has an implicit rowid.
  164318. ** RBU_PK_IPK: Table has an explicit IPK column.
  164319. ** RBU_PK_EXTERNAL: Table has an external PK index.
  164320. ** RBU_PK_WITHOUT_ROWID: Table is WITHOUT ROWID.
  164321. ** RBU_PK_VTAB: Table is a virtual table.
  164322. **
  164323. ** Argument *piPk is also of type (int*), and also points to an output
  164324. ** parameter. Unless the table has an external primary key index
  164325. ** (i.e. unless *peType is set to 3), then *piPk is set to zero. Or,
  164326. ** if the table does have an external primary key index, then *piPk
  164327. ** is set to the root page number of the primary key index before
  164328. ** returning.
  164329. **
  164330. ** ALGORITHM:
  164331. **
  164332. ** if( no entry exists in sqlite_master ){
  164333. ** return RBU_PK_NOTABLE
  164334. ** }else if( sql for the entry starts with "CREATE VIRTUAL" ){
  164335. ** return RBU_PK_VTAB
  164336. ** }else if( "PRAGMA index_list()" for the table contains a "pk" index ){
  164337. ** if( the index that is the pk exists in sqlite_master ){
  164338. ** *piPK = rootpage of that index.
  164339. ** return RBU_PK_EXTERNAL
  164340. ** }else{
  164341. ** return RBU_PK_WITHOUT_ROWID
  164342. ** }
  164343. ** }else if( "PRAGMA table_info()" lists one or more "pk" columns ){
  164344. ** return RBU_PK_IPK
  164345. ** }else{
  164346. ** return RBU_PK_NONE
  164347. ** }
  164348. */
  164349. static void rbuTableType(
  164350. sqlite3rbu *p,
  164351. const char *zTab,
  164352. int *peType,
  164353. int *piTnum,
  164354. int *piPk
  164355. ){
  164356. /*
  164357. ** 0) SELECT count(*) FROM sqlite_master where name=%Q AND IsVirtual(%Q)
  164358. ** 1) PRAGMA index_list = ?
  164359. ** 2) SELECT count(*) FROM sqlite_master where name=%Q
  164360. ** 3) PRAGMA table_info = ?
  164361. */
  164362. sqlite3_stmt *aStmt[4] = {0, 0, 0, 0};
  164363. *peType = RBU_PK_NOTABLE;
  164364. *piPk = 0;
  164365. assert( p->rc==SQLITE_OK );
  164366. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[0], &p->zErrmsg,
  164367. sqlite3_mprintf(
  164368. "SELECT (sql LIKE 'create virtual%%'), rootpage"
  164369. " FROM sqlite_master"
  164370. " WHERE name=%Q", zTab
  164371. ));
  164372. if( p->rc!=SQLITE_OK || sqlite3_step(aStmt[0])!=SQLITE_ROW ){
  164373. /* Either an error, or no such table. */
  164374. goto rbuTableType_end;
  164375. }
  164376. if( sqlite3_column_int(aStmt[0], 0) ){
  164377. *peType = RBU_PK_VTAB; /* virtual table */
  164378. goto rbuTableType_end;
  164379. }
  164380. *piTnum = sqlite3_column_int(aStmt[0], 1);
  164381. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[1], &p->zErrmsg,
  164382. sqlite3_mprintf("PRAGMA index_list=%Q",zTab)
  164383. );
  164384. if( p->rc ) goto rbuTableType_end;
  164385. while( sqlite3_step(aStmt[1])==SQLITE_ROW ){
  164386. const u8 *zOrig = sqlite3_column_text(aStmt[1], 3);
  164387. const u8 *zIdx = sqlite3_column_text(aStmt[1], 1);
  164388. if( zOrig && zIdx && zOrig[0]=='p' ){
  164389. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[2], &p->zErrmsg,
  164390. sqlite3_mprintf(
  164391. "SELECT rootpage FROM sqlite_master WHERE name = %Q", zIdx
  164392. ));
  164393. if( p->rc==SQLITE_OK ){
  164394. if( sqlite3_step(aStmt[2])==SQLITE_ROW ){
  164395. *piPk = sqlite3_column_int(aStmt[2], 0);
  164396. *peType = RBU_PK_EXTERNAL;
  164397. }else{
  164398. *peType = RBU_PK_WITHOUT_ROWID;
  164399. }
  164400. }
  164401. goto rbuTableType_end;
  164402. }
  164403. }
  164404. p->rc = prepareFreeAndCollectError(p->dbMain, &aStmt[3], &p->zErrmsg,
  164405. sqlite3_mprintf("PRAGMA table_info=%Q",zTab)
  164406. );
  164407. if( p->rc==SQLITE_OK ){
  164408. while( sqlite3_step(aStmt[3])==SQLITE_ROW ){
  164409. if( sqlite3_column_int(aStmt[3],5)>0 ){
  164410. *peType = RBU_PK_IPK; /* explicit IPK column */
  164411. goto rbuTableType_end;
  164412. }
  164413. }
  164414. *peType = RBU_PK_NONE;
  164415. }
  164416. rbuTableType_end: {
  164417. unsigned int i;
  164418. for(i=0; i<sizeof(aStmt)/sizeof(aStmt[0]); i++){
  164419. rbuFinalize(p, aStmt[i]);
  164420. }
  164421. }
  164422. }
  164423. /*
  164424. ** This is a helper function for rbuObjIterCacheTableInfo(). It populates
  164425. ** the pIter->abIndexed[] array.
  164426. */
  164427. static void rbuObjIterCacheIndexedCols(sqlite3rbu *p, RbuObjIter *pIter){
  164428. sqlite3_stmt *pList = 0;
  164429. int bIndex = 0;
  164430. if( p->rc==SQLITE_OK ){
  164431. memcpy(pIter->abIndexed, pIter->abTblPk, sizeof(u8)*pIter->nTblCol);
  164432. p->rc = prepareFreeAndCollectError(p->dbMain, &pList, &p->zErrmsg,
  164433. sqlite3_mprintf("PRAGMA main.index_list = %Q", pIter->zTbl)
  164434. );
  164435. }
  164436. pIter->nIndex = 0;
  164437. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pList) ){
  164438. const char *zIdx = (const char*)sqlite3_column_text(pList, 1);
  164439. sqlite3_stmt *pXInfo = 0;
  164440. if( zIdx==0 ) break;
  164441. p->rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  164442. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", zIdx)
  164443. );
  164444. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  164445. int iCid = sqlite3_column_int(pXInfo, 1);
  164446. if( iCid>=0 ) pIter->abIndexed[iCid] = 1;
  164447. }
  164448. rbuFinalize(p, pXInfo);
  164449. bIndex = 1;
  164450. pIter->nIndex++;
  164451. }
  164452. if( pIter->eType==RBU_PK_WITHOUT_ROWID ){
  164453. /* "PRAGMA index_list" includes the main PK b-tree */
  164454. pIter->nIndex--;
  164455. }
  164456. rbuFinalize(p, pList);
  164457. if( bIndex==0 ) pIter->abIndexed = 0;
  164458. }
  164459. /*
  164460. ** If they are not already populated, populate the pIter->azTblCol[],
  164461. ** pIter->abTblPk[], pIter->nTblCol and pIter->bRowid variables according to
  164462. ** the table (not index) that the iterator currently points to.
  164463. **
  164464. ** Return SQLITE_OK if successful, or an SQLite error code otherwise. If
  164465. ** an error does occur, an error code and error message are also left in
  164466. ** the RBU handle.
  164467. */
  164468. static int rbuObjIterCacheTableInfo(sqlite3rbu *p, RbuObjIter *pIter){
  164469. if( pIter->azTblCol==0 ){
  164470. sqlite3_stmt *pStmt = 0;
  164471. int nCol = 0;
  164472. int i; /* for() loop iterator variable */
  164473. int bRbuRowid = 0; /* If input table has column "rbu_rowid" */
  164474. int iOrder = 0;
  164475. int iTnum = 0;
  164476. /* Figure out the type of table this step will deal with. */
  164477. assert( pIter->eType==0 );
  164478. rbuTableType(p, pIter->zTbl, &pIter->eType, &iTnum, &pIter->iPkTnum);
  164479. if( p->rc==SQLITE_OK && pIter->eType==RBU_PK_NOTABLE ){
  164480. p->rc = SQLITE_ERROR;
  164481. p->zErrmsg = sqlite3_mprintf("no such table: %s", pIter->zTbl);
  164482. }
  164483. if( p->rc ) return p->rc;
  164484. if( pIter->zIdx==0 ) pIter->iTnum = iTnum;
  164485. assert( pIter->eType==RBU_PK_NONE || pIter->eType==RBU_PK_IPK
  164486. || pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_WITHOUT_ROWID
  164487. || pIter->eType==RBU_PK_VTAB
  164488. );
  164489. /* Populate the azTblCol[] and nTblCol variables based on the columns
  164490. ** of the input table. Ignore any input table columns that begin with
  164491. ** "rbu_". */
  164492. p->rc = prepareFreeAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  164493. sqlite3_mprintf("SELECT * FROM '%q'", pIter->zDataTbl)
  164494. );
  164495. if( p->rc==SQLITE_OK ){
  164496. nCol = sqlite3_column_count(pStmt);
  164497. rbuAllocateIterArrays(p, pIter, nCol);
  164498. }
  164499. for(i=0; p->rc==SQLITE_OK && i<nCol; i++){
  164500. const char *zName = (const char*)sqlite3_column_name(pStmt, i);
  164501. if( sqlite3_strnicmp("rbu_", zName, 4) ){
  164502. char *zCopy = rbuStrndup(zName, &p->rc);
  164503. pIter->aiSrcOrder[pIter->nTblCol] = pIter->nTblCol;
  164504. pIter->azTblCol[pIter->nTblCol++] = zCopy;
  164505. }
  164506. else if( 0==sqlite3_stricmp("rbu_rowid", zName) ){
  164507. bRbuRowid = 1;
  164508. }
  164509. }
  164510. sqlite3_finalize(pStmt);
  164511. pStmt = 0;
  164512. if( p->rc==SQLITE_OK
  164513. && rbuIsVacuum(p)==0
  164514. && bRbuRowid!=(pIter->eType==RBU_PK_VTAB || pIter->eType==RBU_PK_NONE)
  164515. ){
  164516. p->rc = SQLITE_ERROR;
  164517. p->zErrmsg = sqlite3_mprintf(
  164518. "table %q %s rbu_rowid column", pIter->zDataTbl,
  164519. (bRbuRowid ? "may not have" : "requires")
  164520. );
  164521. }
  164522. /* Check that all non-HIDDEN columns in the destination table are also
  164523. ** present in the input table. Populate the abTblPk[], azTblType[] and
  164524. ** aiTblOrder[] arrays at the same time. */
  164525. if( p->rc==SQLITE_OK ){
  164526. p->rc = prepareFreeAndCollectError(p->dbMain, &pStmt, &p->zErrmsg,
  164527. sqlite3_mprintf("PRAGMA table_info(%Q)", pIter->zTbl)
  164528. );
  164529. }
  164530. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  164531. const char *zName = (const char*)sqlite3_column_text(pStmt, 1);
  164532. if( zName==0 ) break; /* An OOM - finalize() below returns S_NOMEM */
  164533. for(i=iOrder; i<pIter->nTblCol; i++){
  164534. if( 0==strcmp(zName, pIter->azTblCol[i]) ) break;
  164535. }
  164536. if( i==pIter->nTblCol ){
  164537. p->rc = SQLITE_ERROR;
  164538. p->zErrmsg = sqlite3_mprintf("column missing from %q: %s",
  164539. pIter->zDataTbl, zName
  164540. );
  164541. }else{
  164542. int iPk = sqlite3_column_int(pStmt, 5);
  164543. int bNotNull = sqlite3_column_int(pStmt, 3);
  164544. const char *zType = (const char*)sqlite3_column_text(pStmt, 2);
  164545. if( i!=iOrder ){
  164546. SWAP(int, pIter->aiSrcOrder[i], pIter->aiSrcOrder[iOrder]);
  164547. SWAP(char*, pIter->azTblCol[i], pIter->azTblCol[iOrder]);
  164548. }
  164549. pIter->azTblType[iOrder] = rbuStrndup(zType, &p->rc);
  164550. pIter->abTblPk[iOrder] = (iPk!=0);
  164551. pIter->abNotNull[iOrder] = (u8)bNotNull || (iPk!=0);
  164552. iOrder++;
  164553. }
  164554. }
  164555. rbuFinalize(p, pStmt);
  164556. rbuObjIterCacheIndexedCols(p, pIter);
  164557. assert( pIter->eType!=RBU_PK_VTAB || pIter->abIndexed==0 );
  164558. assert( pIter->eType!=RBU_PK_VTAB || pIter->nIndex==0 );
  164559. }
  164560. return p->rc;
  164561. }
  164562. /*
  164563. ** This function constructs and returns a pointer to a nul-terminated
  164564. ** string containing some SQL clause or list based on one or more of the
  164565. ** column names currently stored in the pIter->azTblCol[] array.
  164566. */
  164567. static char *rbuObjIterGetCollist(
  164568. sqlite3rbu *p, /* RBU object */
  164569. RbuObjIter *pIter /* Object iterator for column names */
  164570. ){
  164571. char *zList = 0;
  164572. const char *zSep = "";
  164573. int i;
  164574. for(i=0; i<pIter->nTblCol; i++){
  164575. const char *z = pIter->azTblCol[i];
  164576. zList = rbuMPrintf(p, "%z%s\"%w\"", zList, zSep, z);
  164577. zSep = ", ";
  164578. }
  164579. return zList;
  164580. }
  164581. /*
  164582. ** This function is used to create a SELECT list (the list of SQL
  164583. ** expressions that follows a SELECT keyword) for a SELECT statement
  164584. ** used to read from an data_xxx or rbu_tmp_xxx table while updating the
  164585. ** index object currently indicated by the iterator object passed as the
  164586. ** second argument. A "PRAGMA index_xinfo = <idxname>" statement is used
  164587. ** to obtain the required information.
  164588. **
  164589. ** If the index is of the following form:
  164590. **
  164591. ** CREATE INDEX i1 ON t1(c, b COLLATE nocase);
  164592. **
  164593. ** and "t1" is a table with an explicit INTEGER PRIMARY KEY column
  164594. ** "ipk", the returned string is:
  164595. **
  164596. ** "`c` COLLATE 'BINARY', `b` COLLATE 'NOCASE', `ipk` COLLATE 'BINARY'"
  164597. **
  164598. ** As well as the returned string, three other malloc'd strings are
  164599. ** returned via output parameters. As follows:
  164600. **
  164601. ** pzImposterCols: ...
  164602. ** pzImposterPk: ...
  164603. ** pzWhere: ...
  164604. */
  164605. static char *rbuObjIterGetIndexCols(
  164606. sqlite3rbu *p, /* RBU object */
  164607. RbuObjIter *pIter, /* Object iterator for column names */
  164608. char **pzImposterCols, /* OUT: Columns for imposter table */
  164609. char **pzImposterPk, /* OUT: Imposter PK clause */
  164610. char **pzWhere, /* OUT: WHERE clause */
  164611. int *pnBind /* OUT: Trbul number of columns */
  164612. ){
  164613. int rc = p->rc; /* Error code */
  164614. int rc2; /* sqlite3_finalize() return code */
  164615. char *zRet = 0; /* String to return */
  164616. char *zImpCols = 0; /* String to return via *pzImposterCols */
  164617. char *zImpPK = 0; /* String to return via *pzImposterPK */
  164618. char *zWhere = 0; /* String to return via *pzWhere */
  164619. int nBind = 0; /* Value to return via *pnBind */
  164620. const char *zCom = ""; /* Set to ", " later on */
  164621. const char *zAnd = ""; /* Set to " AND " later on */
  164622. sqlite3_stmt *pXInfo = 0; /* PRAGMA index_xinfo = ? */
  164623. if( rc==SQLITE_OK ){
  164624. assert( p->zErrmsg==0 );
  164625. rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  164626. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", pIter->zIdx)
  164627. );
  164628. }
  164629. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  164630. int iCid = sqlite3_column_int(pXInfo, 1);
  164631. int bDesc = sqlite3_column_int(pXInfo, 3);
  164632. const char *zCollate = (const char*)sqlite3_column_text(pXInfo, 4);
  164633. const char *zCol;
  164634. const char *zType;
  164635. if( iCid<0 ){
  164636. /* An integer primary key. If the table has an explicit IPK, use
  164637. ** its name. Otherwise, use "rbu_rowid". */
  164638. if( pIter->eType==RBU_PK_IPK ){
  164639. int i;
  164640. for(i=0; pIter->abTblPk[i]==0; i++);
  164641. assert( i<pIter->nTblCol );
  164642. zCol = pIter->azTblCol[i];
  164643. }else if( rbuIsVacuum(p) ){
  164644. zCol = "_rowid_";
  164645. }else{
  164646. zCol = "rbu_rowid";
  164647. }
  164648. zType = "INTEGER";
  164649. }else{
  164650. zCol = pIter->azTblCol[iCid];
  164651. zType = pIter->azTblType[iCid];
  164652. }
  164653. zRet = sqlite3_mprintf("%z%s\"%w\" COLLATE %Q", zRet, zCom, zCol, zCollate);
  164654. if( pIter->bUnique==0 || sqlite3_column_int(pXInfo, 5) ){
  164655. const char *zOrder = (bDesc ? " DESC" : "");
  164656. zImpPK = sqlite3_mprintf("%z%s\"rbu_imp_%d%w\"%s",
  164657. zImpPK, zCom, nBind, zCol, zOrder
  164658. );
  164659. }
  164660. zImpCols = sqlite3_mprintf("%z%s\"rbu_imp_%d%w\" %s COLLATE %Q",
  164661. zImpCols, zCom, nBind, zCol, zType, zCollate
  164662. );
  164663. zWhere = sqlite3_mprintf(
  164664. "%z%s\"rbu_imp_%d%w\" IS ?", zWhere, zAnd, nBind, zCol
  164665. );
  164666. if( zRet==0 || zImpPK==0 || zImpCols==0 || zWhere==0 ) rc = SQLITE_NOMEM;
  164667. zCom = ", ";
  164668. zAnd = " AND ";
  164669. nBind++;
  164670. }
  164671. rc2 = sqlite3_finalize(pXInfo);
  164672. if( rc==SQLITE_OK ) rc = rc2;
  164673. if( rc!=SQLITE_OK ){
  164674. sqlite3_free(zRet);
  164675. sqlite3_free(zImpCols);
  164676. sqlite3_free(zImpPK);
  164677. sqlite3_free(zWhere);
  164678. zRet = 0;
  164679. zImpCols = 0;
  164680. zImpPK = 0;
  164681. zWhere = 0;
  164682. p->rc = rc;
  164683. }
  164684. *pzImposterCols = zImpCols;
  164685. *pzImposterPk = zImpPK;
  164686. *pzWhere = zWhere;
  164687. *pnBind = nBind;
  164688. return zRet;
  164689. }
  164690. /*
  164691. ** Assuming the current table columns are "a", "b" and "c", and the zObj
  164692. ** paramter is passed "old", return a string of the form:
  164693. **
  164694. ** "old.a, old.b, old.b"
  164695. **
  164696. ** With the column names escaped.
  164697. **
  164698. ** For tables with implicit rowids - RBU_PK_EXTERNAL and RBU_PK_NONE, append
  164699. ** the text ", old._rowid_" to the returned value.
  164700. */
  164701. static char *rbuObjIterGetOldlist(
  164702. sqlite3rbu *p,
  164703. RbuObjIter *pIter,
  164704. const char *zObj
  164705. ){
  164706. char *zList = 0;
  164707. if( p->rc==SQLITE_OK && pIter->abIndexed ){
  164708. const char *zS = "";
  164709. int i;
  164710. for(i=0; i<pIter->nTblCol; i++){
  164711. if( pIter->abIndexed[i] ){
  164712. const char *zCol = pIter->azTblCol[i];
  164713. zList = sqlite3_mprintf("%z%s%s.\"%w\"", zList, zS, zObj, zCol);
  164714. }else{
  164715. zList = sqlite3_mprintf("%z%sNULL", zList, zS);
  164716. }
  164717. zS = ", ";
  164718. if( zList==0 ){
  164719. p->rc = SQLITE_NOMEM;
  164720. break;
  164721. }
  164722. }
  164723. /* For a table with implicit rowids, append "old._rowid_" to the list. */
  164724. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  164725. zList = rbuMPrintf(p, "%z, %s._rowid_", zList, zObj);
  164726. }
  164727. }
  164728. return zList;
  164729. }
  164730. /*
  164731. ** Return an expression that can be used in a WHERE clause to match the
  164732. ** primary key of the current table. For example, if the table is:
  164733. **
  164734. ** CREATE TABLE t1(a, b, c, PRIMARY KEY(b, c));
  164735. **
  164736. ** Return the string:
  164737. **
  164738. ** "b = ?1 AND c = ?2"
  164739. */
  164740. static char *rbuObjIterGetWhere(
  164741. sqlite3rbu *p,
  164742. RbuObjIter *pIter
  164743. ){
  164744. char *zList = 0;
  164745. if( pIter->eType==RBU_PK_VTAB || pIter->eType==RBU_PK_NONE ){
  164746. zList = rbuMPrintf(p, "_rowid_ = ?%d", pIter->nTblCol+1);
  164747. }else if( pIter->eType==RBU_PK_EXTERNAL ){
  164748. const char *zSep = "";
  164749. int i;
  164750. for(i=0; i<pIter->nTblCol; i++){
  164751. if( pIter->abTblPk[i] ){
  164752. zList = rbuMPrintf(p, "%z%sc%d=?%d", zList, zSep, i, i+1);
  164753. zSep = " AND ";
  164754. }
  164755. }
  164756. zList = rbuMPrintf(p,
  164757. "_rowid_ = (SELECT id FROM rbu_imposter2 WHERE %z)", zList
  164758. );
  164759. }else{
  164760. const char *zSep = "";
  164761. int i;
  164762. for(i=0; i<pIter->nTblCol; i++){
  164763. if( pIter->abTblPk[i] ){
  164764. const char *zCol = pIter->azTblCol[i];
  164765. zList = rbuMPrintf(p, "%z%s\"%w\"=?%d", zList, zSep, zCol, i+1);
  164766. zSep = " AND ";
  164767. }
  164768. }
  164769. }
  164770. return zList;
  164771. }
  164772. /*
  164773. ** The SELECT statement iterating through the keys for the current object
  164774. ** (p->objiter.pSelect) currently points to a valid row. However, there
  164775. ** is something wrong with the rbu_control value in the rbu_control value
  164776. ** stored in the (p->nCol+1)'th column. Set the error code and error message
  164777. ** of the RBU handle to something reflecting this.
  164778. */
  164779. static void rbuBadControlError(sqlite3rbu *p){
  164780. p->rc = SQLITE_ERROR;
  164781. p->zErrmsg = sqlite3_mprintf("invalid rbu_control value");
  164782. }
  164783. /*
  164784. ** Return a nul-terminated string containing the comma separated list of
  164785. ** assignments that should be included following the "SET" keyword of
  164786. ** an UPDATE statement used to update the table object that the iterator
  164787. ** passed as the second argument currently points to if the rbu_control
  164788. ** column of the data_xxx table entry is set to zMask.
  164789. **
  164790. ** The memory for the returned string is obtained from sqlite3_malloc().
  164791. ** It is the responsibility of the caller to eventually free it using
  164792. ** sqlite3_free().
  164793. **
  164794. ** If an OOM error is encountered when allocating space for the new
  164795. ** string, an error code is left in the rbu handle passed as the first
  164796. ** argument and NULL is returned. Or, if an error has already occurred
  164797. ** when this function is called, NULL is returned immediately, without
  164798. ** attempting the allocation or modifying the stored error code.
  164799. */
  164800. static char *rbuObjIterGetSetlist(
  164801. sqlite3rbu *p,
  164802. RbuObjIter *pIter,
  164803. const char *zMask
  164804. ){
  164805. char *zList = 0;
  164806. if( p->rc==SQLITE_OK ){
  164807. int i;
  164808. if( (int)strlen(zMask)!=pIter->nTblCol ){
  164809. rbuBadControlError(p);
  164810. }else{
  164811. const char *zSep = "";
  164812. for(i=0; i<pIter->nTblCol; i++){
  164813. char c = zMask[pIter->aiSrcOrder[i]];
  164814. if( c=='x' ){
  164815. zList = rbuMPrintf(p, "%z%s\"%w\"=?%d",
  164816. zList, zSep, pIter->azTblCol[i], i+1
  164817. );
  164818. zSep = ", ";
  164819. }
  164820. else if( c=='d' ){
  164821. zList = rbuMPrintf(p, "%z%s\"%w\"=rbu_delta(\"%w\", ?%d)",
  164822. zList, zSep, pIter->azTblCol[i], pIter->azTblCol[i], i+1
  164823. );
  164824. zSep = ", ";
  164825. }
  164826. else if( c=='f' ){
  164827. zList = rbuMPrintf(p, "%z%s\"%w\"=rbu_fossil_delta(\"%w\", ?%d)",
  164828. zList, zSep, pIter->azTblCol[i], pIter->azTblCol[i], i+1
  164829. );
  164830. zSep = ", ";
  164831. }
  164832. }
  164833. }
  164834. }
  164835. return zList;
  164836. }
  164837. /*
  164838. ** Return a nul-terminated string consisting of nByte comma separated
  164839. ** "?" expressions. For example, if nByte is 3, return a pointer to
  164840. ** a buffer containing the string "?,?,?".
  164841. **
  164842. ** The memory for the returned string is obtained from sqlite3_malloc().
  164843. ** It is the responsibility of the caller to eventually free it using
  164844. ** sqlite3_free().
  164845. **
  164846. ** If an OOM error is encountered when allocating space for the new
  164847. ** string, an error code is left in the rbu handle passed as the first
  164848. ** argument and NULL is returned. Or, if an error has already occurred
  164849. ** when this function is called, NULL is returned immediately, without
  164850. ** attempting the allocation or modifying the stored error code.
  164851. */
  164852. static char *rbuObjIterGetBindlist(sqlite3rbu *p, int nBind){
  164853. char *zRet = 0;
  164854. int nByte = nBind*2 + 1;
  164855. zRet = (char*)rbuMalloc(p, nByte);
  164856. if( zRet ){
  164857. int i;
  164858. for(i=0; i<nBind; i++){
  164859. zRet[i*2] = '?';
  164860. zRet[i*2+1] = (i+1==nBind) ? '\0' : ',';
  164861. }
  164862. }
  164863. return zRet;
  164864. }
  164865. /*
  164866. ** The iterator currently points to a table (not index) of type
  164867. ** RBU_PK_WITHOUT_ROWID. This function creates the PRIMARY KEY
  164868. ** declaration for the corresponding imposter table. For example,
  164869. ** if the iterator points to a table created as:
  164870. **
  164871. ** CREATE TABLE t1(a, b, c, PRIMARY KEY(b, a DESC)) WITHOUT ROWID
  164872. **
  164873. ** this function returns:
  164874. **
  164875. ** PRIMARY KEY("b", "a" DESC)
  164876. */
  164877. static char *rbuWithoutRowidPK(sqlite3rbu *p, RbuObjIter *pIter){
  164878. char *z = 0;
  164879. assert( pIter->zIdx==0 );
  164880. if( p->rc==SQLITE_OK ){
  164881. const char *zSep = "PRIMARY KEY(";
  164882. sqlite3_stmt *pXList = 0; /* PRAGMA index_list = (pIter->zTbl) */
  164883. sqlite3_stmt *pXInfo = 0; /* PRAGMA index_xinfo = <pk-index> */
  164884. p->rc = prepareFreeAndCollectError(p->dbMain, &pXList, &p->zErrmsg,
  164885. sqlite3_mprintf("PRAGMA main.index_list = %Q", pIter->zTbl)
  164886. );
  164887. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXList) ){
  164888. const char *zOrig = (const char*)sqlite3_column_text(pXList,3);
  164889. if( zOrig && strcmp(zOrig, "pk")==0 ){
  164890. const char *zIdx = (const char*)sqlite3_column_text(pXList,1);
  164891. if( zIdx ){
  164892. p->rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  164893. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", zIdx)
  164894. );
  164895. }
  164896. break;
  164897. }
  164898. }
  164899. rbuFinalize(p, pXList);
  164900. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  164901. if( sqlite3_column_int(pXInfo, 5) ){
  164902. /* int iCid = sqlite3_column_int(pXInfo, 0); */
  164903. const char *zCol = (const char*)sqlite3_column_text(pXInfo, 2);
  164904. const char *zDesc = sqlite3_column_int(pXInfo, 3) ? " DESC" : "";
  164905. z = rbuMPrintf(p, "%z%s\"%w\"%s", z, zSep, zCol, zDesc);
  164906. zSep = ", ";
  164907. }
  164908. }
  164909. z = rbuMPrintf(p, "%z)", z);
  164910. rbuFinalize(p, pXInfo);
  164911. }
  164912. return z;
  164913. }
  164914. /*
  164915. ** This function creates the second imposter table used when writing to
  164916. ** a table b-tree where the table has an external primary key. If the
  164917. ** iterator passed as the second argument does not currently point to
  164918. ** a table (not index) with an external primary key, this function is a
  164919. ** no-op.
  164920. **
  164921. ** Assuming the iterator does point to a table with an external PK, this
  164922. ** function creates a WITHOUT ROWID imposter table named "rbu_imposter2"
  164923. ** used to access that PK index. For example, if the target table is
  164924. ** declared as follows:
  164925. **
  164926. ** CREATE TABLE t1(a, b TEXT, c REAL, PRIMARY KEY(b, c));
  164927. **
  164928. ** then the imposter table schema is:
  164929. **
  164930. ** CREATE TABLE rbu_imposter2(c1 TEXT, c2 REAL, id INTEGER) WITHOUT ROWID;
  164931. **
  164932. */
  164933. static void rbuCreateImposterTable2(sqlite3rbu *p, RbuObjIter *pIter){
  164934. if( p->rc==SQLITE_OK && pIter->eType==RBU_PK_EXTERNAL ){
  164935. int tnum = pIter->iPkTnum; /* Root page of PK index */
  164936. sqlite3_stmt *pQuery = 0; /* SELECT name ... WHERE rootpage = $tnum */
  164937. const char *zIdx = 0; /* Name of PK index */
  164938. sqlite3_stmt *pXInfo = 0; /* PRAGMA main.index_xinfo = $zIdx */
  164939. const char *zComma = "";
  164940. char *zCols = 0; /* Used to build up list of table cols */
  164941. char *zPk = 0; /* Used to build up table PK declaration */
  164942. /* Figure out the name of the primary key index for the current table.
  164943. ** This is needed for the argument to "PRAGMA index_xinfo". Set
  164944. ** zIdx to point to a nul-terminated string containing this name. */
  164945. p->rc = prepareAndCollectError(p->dbMain, &pQuery, &p->zErrmsg,
  164946. "SELECT name FROM sqlite_master WHERE rootpage = ?"
  164947. );
  164948. if( p->rc==SQLITE_OK ){
  164949. sqlite3_bind_int(pQuery, 1, tnum);
  164950. if( SQLITE_ROW==sqlite3_step(pQuery) ){
  164951. zIdx = (const char*)sqlite3_column_text(pQuery, 0);
  164952. }
  164953. }
  164954. if( zIdx ){
  164955. p->rc = prepareFreeAndCollectError(p->dbMain, &pXInfo, &p->zErrmsg,
  164956. sqlite3_mprintf("PRAGMA main.index_xinfo = %Q", zIdx)
  164957. );
  164958. }
  164959. rbuFinalize(p, pQuery);
  164960. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pXInfo) ){
  164961. int bKey = sqlite3_column_int(pXInfo, 5);
  164962. if( bKey ){
  164963. int iCid = sqlite3_column_int(pXInfo, 1);
  164964. int bDesc = sqlite3_column_int(pXInfo, 3);
  164965. const char *zCollate = (const char*)sqlite3_column_text(pXInfo, 4);
  164966. zCols = rbuMPrintf(p, "%z%sc%d %s COLLATE %Q", zCols, zComma,
  164967. iCid, pIter->azTblType[iCid], zCollate
  164968. );
  164969. zPk = rbuMPrintf(p, "%z%sc%d%s", zPk, zComma, iCid, bDesc?" DESC":"");
  164970. zComma = ", ";
  164971. }
  164972. }
  164973. zCols = rbuMPrintf(p, "%z, id INTEGER", zCols);
  164974. rbuFinalize(p, pXInfo);
  164975. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 1, tnum);
  164976. rbuMPrintfExec(p, p->dbMain,
  164977. "CREATE TABLE rbu_imposter2(%z, PRIMARY KEY(%z)) WITHOUT ROWID",
  164978. zCols, zPk
  164979. );
  164980. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 0);
  164981. }
  164982. }
  164983. /*
  164984. ** If an error has already occurred when this function is called, it
  164985. ** immediately returns zero (without doing any work). Or, if an error
  164986. ** occurs during the execution of this function, it sets the error code
  164987. ** in the sqlite3rbu object indicated by the first argument and returns
  164988. ** zero.
  164989. **
  164990. ** The iterator passed as the second argument is guaranteed to point to
  164991. ** a table (not an index) when this function is called. This function
  164992. ** attempts to create any imposter table required to write to the main
  164993. ** table b-tree of the table before returning. Non-zero is returned if
  164994. ** an imposter table are created, or zero otherwise.
  164995. **
  164996. ** An imposter table is required in all cases except RBU_PK_VTAB. Only
  164997. ** virtual tables are written to directly. The imposter table has the
  164998. ** same schema as the actual target table (less any UNIQUE constraints).
  164999. ** More precisely, the "same schema" means the same columns, types,
  165000. ** collation sequences. For tables that do not have an external PRIMARY
  165001. ** KEY, it also means the same PRIMARY KEY declaration.
  165002. */
  165003. static void rbuCreateImposterTable(sqlite3rbu *p, RbuObjIter *pIter){
  165004. if( p->rc==SQLITE_OK && pIter->eType!=RBU_PK_VTAB ){
  165005. int tnum = pIter->iTnum;
  165006. const char *zComma = "";
  165007. char *zSql = 0;
  165008. int iCol;
  165009. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 1);
  165010. for(iCol=0; p->rc==SQLITE_OK && iCol<pIter->nTblCol; iCol++){
  165011. const char *zPk = "";
  165012. const char *zCol = pIter->azTblCol[iCol];
  165013. const char *zColl = 0;
  165014. p->rc = sqlite3_table_column_metadata(
  165015. p->dbMain, "main", pIter->zTbl, zCol, 0, &zColl, 0, 0, 0
  165016. );
  165017. if( pIter->eType==RBU_PK_IPK && pIter->abTblPk[iCol] ){
  165018. /* If the target table column is an "INTEGER PRIMARY KEY", add
  165019. ** "PRIMARY KEY" to the imposter table column declaration. */
  165020. zPk = "PRIMARY KEY ";
  165021. }
  165022. zSql = rbuMPrintf(p, "%z%s\"%w\" %s %sCOLLATE %Q%s",
  165023. zSql, zComma, zCol, pIter->azTblType[iCol], zPk, zColl,
  165024. (pIter->abNotNull[iCol] ? " NOT NULL" : "")
  165025. );
  165026. zComma = ", ";
  165027. }
  165028. if( pIter->eType==RBU_PK_WITHOUT_ROWID ){
  165029. char *zPk = rbuWithoutRowidPK(p, pIter);
  165030. if( zPk ){
  165031. zSql = rbuMPrintf(p, "%z, %z", zSql, zPk);
  165032. }
  165033. }
  165034. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 1, tnum);
  165035. rbuMPrintfExec(p, p->dbMain, "CREATE TABLE \"rbu_imp_%w\"(%z)%s",
  165036. pIter->zTbl, zSql,
  165037. (pIter->eType==RBU_PK_WITHOUT_ROWID ? " WITHOUT ROWID" : "")
  165038. );
  165039. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 0);
  165040. }
  165041. }
  165042. /*
  165043. ** Prepare a statement used to insert rows into the "rbu_tmp_xxx" table.
  165044. ** Specifically a statement of the form:
  165045. **
  165046. ** INSERT INTO rbu_tmp_xxx VALUES(?, ?, ? ...);
  165047. **
  165048. ** The number of bound variables is equal to the number of columns in
  165049. ** the target table, plus one (for the rbu_control column), plus one more
  165050. ** (for the rbu_rowid column) if the target table is an implicit IPK or
  165051. ** virtual table.
  165052. */
  165053. static void rbuObjIterPrepareTmpInsert(
  165054. sqlite3rbu *p,
  165055. RbuObjIter *pIter,
  165056. const char *zCollist,
  165057. const char *zRbuRowid
  165058. ){
  165059. int bRbuRowid = (pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE);
  165060. char *zBind = rbuObjIterGetBindlist(p, pIter->nTblCol + 1 + bRbuRowid);
  165061. if( zBind ){
  165062. assert( pIter->pTmpInsert==0 );
  165063. p->rc = prepareFreeAndCollectError(
  165064. p->dbRbu, &pIter->pTmpInsert, &p->zErrmsg, sqlite3_mprintf(
  165065. "INSERT INTO %s.'rbu_tmp_%q'(rbu_control,%s%s) VALUES(%z)",
  165066. p->zStateDb, pIter->zDataTbl, zCollist, zRbuRowid, zBind
  165067. ));
  165068. }
  165069. }
  165070. static void rbuTmpInsertFunc(
  165071. sqlite3_context *pCtx,
  165072. int nVal,
  165073. sqlite3_value **apVal
  165074. ){
  165075. sqlite3rbu *p = sqlite3_user_data(pCtx);
  165076. int rc = SQLITE_OK;
  165077. int i;
  165078. assert( sqlite3_value_int(apVal[0])!=0
  165079. || p->objiter.eType==RBU_PK_EXTERNAL
  165080. || p->objiter.eType==RBU_PK_NONE
  165081. );
  165082. if( sqlite3_value_int(apVal[0])!=0 ){
  165083. p->nPhaseOneStep += p->objiter.nIndex;
  165084. }
  165085. for(i=0; rc==SQLITE_OK && i<nVal; i++){
  165086. rc = sqlite3_bind_value(p->objiter.pTmpInsert, i+1, apVal[i]);
  165087. }
  165088. if( rc==SQLITE_OK ){
  165089. sqlite3_step(p->objiter.pTmpInsert);
  165090. rc = sqlite3_reset(p->objiter.pTmpInsert);
  165091. }
  165092. if( rc!=SQLITE_OK ){
  165093. sqlite3_result_error_code(pCtx, rc);
  165094. }
  165095. }
  165096. /*
  165097. ** Ensure that the SQLite statement handles required to update the
  165098. ** target database object currently indicated by the iterator passed
  165099. ** as the second argument are available.
  165100. */
  165101. static int rbuObjIterPrepareAll(
  165102. sqlite3rbu *p,
  165103. RbuObjIter *pIter,
  165104. int nOffset /* Add "LIMIT -1 OFFSET $nOffset" to SELECT */
  165105. ){
  165106. assert( pIter->bCleanup==0 );
  165107. if( pIter->pSelect==0 && rbuObjIterCacheTableInfo(p, pIter)==SQLITE_OK ){
  165108. const int tnum = pIter->iTnum;
  165109. char *zCollist = 0; /* List of indexed columns */
  165110. char **pz = &p->zErrmsg;
  165111. const char *zIdx = pIter->zIdx;
  165112. char *zLimit = 0;
  165113. if( nOffset ){
  165114. zLimit = sqlite3_mprintf(" LIMIT -1 OFFSET %d", nOffset);
  165115. if( !zLimit ) p->rc = SQLITE_NOMEM;
  165116. }
  165117. if( zIdx ){
  165118. const char *zTbl = pIter->zTbl;
  165119. char *zImposterCols = 0; /* Columns for imposter table */
  165120. char *zImposterPK = 0; /* Primary key declaration for imposter */
  165121. char *zWhere = 0; /* WHERE clause on PK columns */
  165122. char *zBind = 0;
  165123. int nBind = 0;
  165124. assert( pIter->eType!=RBU_PK_VTAB );
  165125. zCollist = rbuObjIterGetIndexCols(
  165126. p, pIter, &zImposterCols, &zImposterPK, &zWhere, &nBind
  165127. );
  165128. zBind = rbuObjIterGetBindlist(p, nBind);
  165129. /* Create the imposter table used to write to this index. */
  165130. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 1);
  165131. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 1,tnum);
  165132. rbuMPrintfExec(p, p->dbMain,
  165133. "CREATE TABLE \"rbu_imp_%w\"( %s, PRIMARY KEY( %s ) ) WITHOUT ROWID",
  165134. zTbl, zImposterCols, zImposterPK
  165135. );
  165136. sqlite3_test_control(SQLITE_TESTCTRL_IMPOSTER, p->dbMain, "main", 0, 0);
  165137. /* Create the statement to insert index entries */
  165138. pIter->nCol = nBind;
  165139. if( p->rc==SQLITE_OK ){
  165140. p->rc = prepareFreeAndCollectError(
  165141. p->dbMain, &pIter->pInsert, &p->zErrmsg,
  165142. sqlite3_mprintf("INSERT INTO \"rbu_imp_%w\" VALUES(%s)", zTbl, zBind)
  165143. );
  165144. }
  165145. /* And to delete index entries */
  165146. if( rbuIsVacuum(p)==0 && p->rc==SQLITE_OK ){
  165147. p->rc = prepareFreeAndCollectError(
  165148. p->dbMain, &pIter->pDelete, &p->zErrmsg,
  165149. sqlite3_mprintf("DELETE FROM \"rbu_imp_%w\" WHERE %s", zTbl, zWhere)
  165150. );
  165151. }
  165152. /* Create the SELECT statement to read keys in sorted order */
  165153. if( p->rc==SQLITE_OK ){
  165154. char *zSql;
  165155. if( rbuIsVacuum(p) ){
  165156. zSql = sqlite3_mprintf(
  165157. "SELECT %s, 0 AS rbu_control FROM '%q' ORDER BY %s%s",
  165158. zCollist,
  165159. pIter->zDataTbl,
  165160. zCollist, zLimit
  165161. );
  165162. }else
  165163. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  165164. zSql = sqlite3_mprintf(
  165165. "SELECT %s, rbu_control FROM %s.'rbu_tmp_%q' ORDER BY %s%s",
  165166. zCollist, p->zStateDb, pIter->zDataTbl,
  165167. zCollist, zLimit
  165168. );
  165169. }else{
  165170. zSql = sqlite3_mprintf(
  165171. "SELECT %s, rbu_control FROM %s.'rbu_tmp_%q' "
  165172. "UNION ALL "
  165173. "SELECT %s, rbu_control FROM '%q' "
  165174. "WHERE typeof(rbu_control)='integer' AND rbu_control!=1 "
  165175. "ORDER BY %s%s",
  165176. zCollist, p->zStateDb, pIter->zDataTbl,
  165177. zCollist, pIter->zDataTbl,
  165178. zCollist, zLimit
  165179. );
  165180. }
  165181. p->rc = prepareFreeAndCollectError(p->dbRbu, &pIter->pSelect, pz, zSql);
  165182. }
  165183. sqlite3_free(zImposterCols);
  165184. sqlite3_free(zImposterPK);
  165185. sqlite3_free(zWhere);
  165186. sqlite3_free(zBind);
  165187. }else{
  165188. int bRbuRowid = (pIter->eType==RBU_PK_VTAB)
  165189. ||(pIter->eType==RBU_PK_NONE)
  165190. ||(pIter->eType==RBU_PK_EXTERNAL && rbuIsVacuum(p));
  165191. const char *zTbl = pIter->zTbl; /* Table this step applies to */
  165192. const char *zWrite; /* Imposter table name */
  165193. char *zBindings = rbuObjIterGetBindlist(p, pIter->nTblCol + bRbuRowid);
  165194. char *zWhere = rbuObjIterGetWhere(p, pIter);
  165195. char *zOldlist = rbuObjIterGetOldlist(p, pIter, "old");
  165196. char *zNewlist = rbuObjIterGetOldlist(p, pIter, "new");
  165197. zCollist = rbuObjIterGetCollist(p, pIter);
  165198. pIter->nCol = pIter->nTblCol;
  165199. /* Create the imposter table or tables (if required). */
  165200. rbuCreateImposterTable(p, pIter);
  165201. rbuCreateImposterTable2(p, pIter);
  165202. zWrite = (pIter->eType==RBU_PK_VTAB ? "" : "rbu_imp_");
  165203. /* Create the INSERT statement to write to the target PK b-tree */
  165204. if( p->rc==SQLITE_OK ){
  165205. p->rc = prepareFreeAndCollectError(p->dbMain, &pIter->pInsert, pz,
  165206. sqlite3_mprintf(
  165207. "INSERT INTO \"%s%w\"(%s%s) VALUES(%s)",
  165208. zWrite, zTbl, zCollist, (bRbuRowid ? ", _rowid_" : ""), zBindings
  165209. )
  165210. );
  165211. }
  165212. /* Create the DELETE statement to write to the target PK b-tree.
  165213. ** Because it only performs INSERT operations, this is not required for
  165214. ** an rbu vacuum handle. */
  165215. if( rbuIsVacuum(p)==0 && p->rc==SQLITE_OK ){
  165216. p->rc = prepareFreeAndCollectError(p->dbMain, &pIter->pDelete, pz,
  165217. sqlite3_mprintf(
  165218. "DELETE FROM \"%s%w\" WHERE %s", zWrite, zTbl, zWhere
  165219. )
  165220. );
  165221. }
  165222. if( rbuIsVacuum(p)==0 && pIter->abIndexed ){
  165223. const char *zRbuRowid = "";
  165224. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  165225. zRbuRowid = ", rbu_rowid";
  165226. }
  165227. /* Create the rbu_tmp_xxx table and the triggers to populate it. */
  165228. rbuMPrintfExec(p, p->dbRbu,
  165229. "CREATE TABLE IF NOT EXISTS %s.'rbu_tmp_%q' AS "
  165230. "SELECT *%s FROM '%q' WHERE 0;"
  165231. , p->zStateDb, pIter->zDataTbl
  165232. , (pIter->eType==RBU_PK_EXTERNAL ? ", 0 AS rbu_rowid" : "")
  165233. , pIter->zDataTbl
  165234. );
  165235. rbuMPrintfExec(p, p->dbMain,
  165236. "CREATE TEMP TRIGGER rbu_delete_tr BEFORE DELETE ON \"%s%w\" "
  165237. "BEGIN "
  165238. " SELECT rbu_tmp_insert(3, %s);"
  165239. "END;"
  165240. "CREATE TEMP TRIGGER rbu_update1_tr BEFORE UPDATE ON \"%s%w\" "
  165241. "BEGIN "
  165242. " SELECT rbu_tmp_insert(3, %s);"
  165243. "END;"
  165244. "CREATE TEMP TRIGGER rbu_update2_tr AFTER UPDATE ON \"%s%w\" "
  165245. "BEGIN "
  165246. " SELECT rbu_tmp_insert(4, %s);"
  165247. "END;",
  165248. zWrite, zTbl, zOldlist,
  165249. zWrite, zTbl, zOldlist,
  165250. zWrite, zTbl, zNewlist
  165251. );
  165252. if( pIter->eType==RBU_PK_EXTERNAL || pIter->eType==RBU_PK_NONE ){
  165253. rbuMPrintfExec(p, p->dbMain,
  165254. "CREATE TEMP TRIGGER rbu_insert_tr AFTER INSERT ON \"%s%w\" "
  165255. "BEGIN "
  165256. " SELECT rbu_tmp_insert(0, %s);"
  165257. "END;",
  165258. zWrite, zTbl, zNewlist
  165259. );
  165260. }
  165261. rbuObjIterPrepareTmpInsert(p, pIter, zCollist, zRbuRowid);
  165262. }
  165263. /* Create the SELECT statement to read keys from data_xxx */
  165264. if( p->rc==SQLITE_OK ){
  165265. const char *zRbuRowid = "";
  165266. if( bRbuRowid ){
  165267. zRbuRowid = rbuIsVacuum(p) ? ",_rowid_ " : ",rbu_rowid";
  165268. }
  165269. p->rc = prepareFreeAndCollectError(p->dbRbu, &pIter->pSelect, pz,
  165270. sqlite3_mprintf(
  165271. "SELECT %s,%s rbu_control%s FROM '%q'%s",
  165272. zCollist,
  165273. (rbuIsVacuum(p) ? "0 AS " : ""),
  165274. zRbuRowid,
  165275. pIter->zDataTbl, zLimit
  165276. )
  165277. );
  165278. }
  165279. sqlite3_free(zWhere);
  165280. sqlite3_free(zOldlist);
  165281. sqlite3_free(zNewlist);
  165282. sqlite3_free(zBindings);
  165283. }
  165284. sqlite3_free(zCollist);
  165285. sqlite3_free(zLimit);
  165286. }
  165287. return p->rc;
  165288. }
  165289. /*
  165290. ** Set output variable *ppStmt to point to an UPDATE statement that may
  165291. ** be used to update the imposter table for the main table b-tree of the
  165292. ** table object that pIter currently points to, assuming that the
  165293. ** rbu_control column of the data_xyz table contains zMask.
  165294. **
  165295. ** If the zMask string does not specify any columns to update, then this
  165296. ** is not an error. Output variable *ppStmt is set to NULL in this case.
  165297. */
  165298. static int rbuGetUpdateStmt(
  165299. sqlite3rbu *p, /* RBU handle */
  165300. RbuObjIter *pIter, /* Object iterator */
  165301. const char *zMask, /* rbu_control value ('x.x.') */
  165302. sqlite3_stmt **ppStmt /* OUT: UPDATE statement handle */
  165303. ){
  165304. RbuUpdateStmt **pp;
  165305. RbuUpdateStmt *pUp = 0;
  165306. int nUp = 0;
  165307. /* In case an error occurs */
  165308. *ppStmt = 0;
  165309. /* Search for an existing statement. If one is found, shift it to the front
  165310. ** of the LRU queue and return immediately. Otherwise, leave nUp pointing
  165311. ** to the number of statements currently in the cache and pUp to the
  165312. ** last object in the list. */
  165313. for(pp=&pIter->pRbuUpdate; *pp; pp=&((*pp)->pNext)){
  165314. pUp = *pp;
  165315. if( strcmp(pUp->zMask, zMask)==0 ){
  165316. *pp = pUp->pNext;
  165317. pUp->pNext = pIter->pRbuUpdate;
  165318. pIter->pRbuUpdate = pUp;
  165319. *ppStmt = pUp->pUpdate;
  165320. return SQLITE_OK;
  165321. }
  165322. nUp++;
  165323. }
  165324. assert( pUp==0 || pUp->pNext==0 );
  165325. if( nUp>=SQLITE_RBU_UPDATE_CACHESIZE ){
  165326. for(pp=&pIter->pRbuUpdate; *pp!=pUp; pp=&((*pp)->pNext));
  165327. *pp = 0;
  165328. sqlite3_finalize(pUp->pUpdate);
  165329. pUp->pUpdate = 0;
  165330. }else{
  165331. pUp = (RbuUpdateStmt*)rbuMalloc(p, sizeof(RbuUpdateStmt)+pIter->nTblCol+1);
  165332. }
  165333. if( pUp ){
  165334. char *zWhere = rbuObjIterGetWhere(p, pIter);
  165335. char *zSet = rbuObjIterGetSetlist(p, pIter, zMask);
  165336. char *zUpdate = 0;
  165337. pUp->zMask = (char*)&pUp[1];
  165338. memcpy(pUp->zMask, zMask, pIter->nTblCol);
  165339. pUp->pNext = pIter->pRbuUpdate;
  165340. pIter->pRbuUpdate = pUp;
  165341. if( zSet ){
  165342. const char *zPrefix = "";
  165343. if( pIter->eType!=RBU_PK_VTAB ) zPrefix = "rbu_imp_";
  165344. zUpdate = sqlite3_mprintf("UPDATE \"%s%w\" SET %s WHERE %s",
  165345. zPrefix, pIter->zTbl, zSet, zWhere
  165346. );
  165347. p->rc = prepareFreeAndCollectError(
  165348. p->dbMain, &pUp->pUpdate, &p->zErrmsg, zUpdate
  165349. );
  165350. *ppStmt = pUp->pUpdate;
  165351. }
  165352. sqlite3_free(zWhere);
  165353. sqlite3_free(zSet);
  165354. }
  165355. return p->rc;
  165356. }
  165357. static sqlite3 *rbuOpenDbhandle(
  165358. sqlite3rbu *p,
  165359. const char *zName,
  165360. int bUseVfs
  165361. ){
  165362. sqlite3 *db = 0;
  165363. if( p->rc==SQLITE_OK ){
  165364. const int flags = SQLITE_OPEN_READWRITE|SQLITE_OPEN_CREATE|SQLITE_OPEN_URI;
  165365. p->rc = sqlite3_open_v2(zName, &db, flags, bUseVfs ? p->zVfsName : 0);
  165366. if( p->rc ){
  165367. p->zErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(db));
  165368. sqlite3_close(db);
  165369. db = 0;
  165370. }
  165371. }
  165372. return db;
  165373. }
  165374. /*
  165375. ** Free an RbuState object allocated by rbuLoadState().
  165376. */
  165377. static void rbuFreeState(RbuState *p){
  165378. if( p ){
  165379. sqlite3_free(p->zTbl);
  165380. sqlite3_free(p->zIdx);
  165381. sqlite3_free(p);
  165382. }
  165383. }
  165384. /*
  165385. ** Allocate an RbuState object and load the contents of the rbu_state
  165386. ** table into it. Return a pointer to the new object. It is the
  165387. ** responsibility of the caller to eventually free the object using
  165388. ** sqlite3_free().
  165389. **
  165390. ** If an error occurs, leave an error code and message in the rbu handle
  165391. ** and return NULL.
  165392. */
  165393. static RbuState *rbuLoadState(sqlite3rbu *p){
  165394. RbuState *pRet = 0;
  165395. sqlite3_stmt *pStmt = 0;
  165396. int rc;
  165397. int rc2;
  165398. pRet = (RbuState*)rbuMalloc(p, sizeof(RbuState));
  165399. if( pRet==0 ) return 0;
  165400. rc = prepareFreeAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  165401. sqlite3_mprintf("SELECT k, v FROM %s.rbu_state", p->zStateDb)
  165402. );
  165403. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  165404. switch( sqlite3_column_int(pStmt, 0) ){
  165405. case RBU_STATE_STAGE:
  165406. pRet->eStage = sqlite3_column_int(pStmt, 1);
  165407. if( pRet->eStage!=RBU_STAGE_OAL
  165408. && pRet->eStage!=RBU_STAGE_MOVE
  165409. && pRet->eStage!=RBU_STAGE_CKPT
  165410. ){
  165411. p->rc = SQLITE_CORRUPT;
  165412. }
  165413. break;
  165414. case RBU_STATE_TBL:
  165415. pRet->zTbl = rbuStrndup((char*)sqlite3_column_text(pStmt, 1), &rc);
  165416. break;
  165417. case RBU_STATE_IDX:
  165418. pRet->zIdx = rbuStrndup((char*)sqlite3_column_text(pStmt, 1), &rc);
  165419. break;
  165420. case RBU_STATE_ROW:
  165421. pRet->nRow = sqlite3_column_int(pStmt, 1);
  165422. break;
  165423. case RBU_STATE_PROGRESS:
  165424. pRet->nProgress = sqlite3_column_int64(pStmt, 1);
  165425. break;
  165426. case RBU_STATE_CKPT:
  165427. pRet->iWalCksum = sqlite3_column_int64(pStmt, 1);
  165428. break;
  165429. case RBU_STATE_COOKIE:
  165430. pRet->iCookie = (u32)sqlite3_column_int64(pStmt, 1);
  165431. break;
  165432. case RBU_STATE_OALSZ:
  165433. pRet->iOalSz = (u32)sqlite3_column_int64(pStmt, 1);
  165434. break;
  165435. case RBU_STATE_PHASEONESTEP:
  165436. pRet->nPhaseOneStep = sqlite3_column_int64(pStmt, 1);
  165437. break;
  165438. default:
  165439. rc = SQLITE_CORRUPT;
  165440. break;
  165441. }
  165442. }
  165443. rc2 = sqlite3_finalize(pStmt);
  165444. if( rc==SQLITE_OK ) rc = rc2;
  165445. p->rc = rc;
  165446. return pRet;
  165447. }
  165448. /*
  165449. ** Open the database handle and attach the RBU database as "rbu". If an
  165450. ** error occurs, leave an error code and message in the RBU handle.
  165451. */
  165452. static void rbuOpenDatabase(sqlite3rbu *p, int *pbRetry){
  165453. assert( p->rc || (p->dbMain==0 && p->dbRbu==0) );
  165454. assert( p->rc || rbuIsVacuum(p) || p->zTarget!=0 );
  165455. /* Open the RBU database */
  165456. p->dbRbu = rbuOpenDbhandle(p, p->zRbu, 1);
  165457. if( p->rc==SQLITE_OK && rbuIsVacuum(p) ){
  165458. sqlite3_file_control(p->dbRbu, "main", SQLITE_FCNTL_RBUCNT, (void*)p);
  165459. if( p->zState==0 ){
  165460. const char *zFile = sqlite3_db_filename(p->dbRbu, "main");
  165461. p->zState = rbuMPrintf(p, "file://%s-vacuum?modeof=%s", zFile, zFile);
  165462. }
  165463. }
  165464. /* If using separate RBU and state databases, attach the state database to
  165465. ** the RBU db handle now. */
  165466. if( p->zState ){
  165467. rbuMPrintfExec(p, p->dbRbu, "ATTACH %Q AS stat", p->zState);
  165468. memcpy(p->zStateDb, "stat", 4);
  165469. }else{
  165470. memcpy(p->zStateDb, "main", 4);
  165471. }
  165472. #if 0
  165473. if( p->rc==SQLITE_OK && rbuIsVacuum(p) ){
  165474. p->rc = sqlite3_exec(p->dbRbu, "BEGIN", 0, 0, 0);
  165475. }
  165476. #endif
  165477. /* If it has not already been created, create the rbu_state table */
  165478. rbuMPrintfExec(p, p->dbRbu, RBU_CREATE_STATE, p->zStateDb);
  165479. #if 0
  165480. if( rbuIsVacuum(p) ){
  165481. if( p->rc==SQLITE_OK ){
  165482. int rc2;
  165483. int bOk = 0;
  165484. sqlite3_stmt *pCnt = 0;
  165485. p->rc = prepareAndCollectError(p->dbRbu, &pCnt, &p->zErrmsg,
  165486. "SELECT count(*) FROM stat.sqlite_master"
  165487. );
  165488. if( p->rc==SQLITE_OK
  165489. && sqlite3_step(pCnt)==SQLITE_ROW
  165490. && 1==sqlite3_column_int(pCnt, 0)
  165491. ){
  165492. bOk = 1;
  165493. }
  165494. rc2 = sqlite3_finalize(pCnt);
  165495. if( p->rc==SQLITE_OK ) p->rc = rc2;
  165496. if( p->rc==SQLITE_OK && bOk==0 ){
  165497. p->rc = SQLITE_ERROR;
  165498. p->zErrmsg = sqlite3_mprintf("invalid state database");
  165499. }
  165500. if( p->rc==SQLITE_OK ){
  165501. p->rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, 0);
  165502. }
  165503. }
  165504. }
  165505. #endif
  165506. if( p->rc==SQLITE_OK && rbuIsVacuum(p) ){
  165507. int bOpen = 0;
  165508. int rc;
  165509. p->nRbu = 0;
  165510. p->pRbuFd = 0;
  165511. rc = sqlite3_file_control(p->dbRbu, "main", SQLITE_FCNTL_RBUCNT, (void*)p);
  165512. if( rc!=SQLITE_NOTFOUND ) p->rc = rc;
  165513. if( p->eStage>=RBU_STAGE_MOVE ){
  165514. bOpen = 1;
  165515. }else{
  165516. RbuState *pState = rbuLoadState(p);
  165517. if( pState ){
  165518. bOpen = (pState->eStage>=RBU_STAGE_MOVE);
  165519. rbuFreeState(pState);
  165520. }
  165521. }
  165522. if( bOpen ) p->dbMain = rbuOpenDbhandle(p, p->zRbu, p->nRbu<=1);
  165523. }
  165524. p->eStage = 0;
  165525. if( p->rc==SQLITE_OK && p->dbMain==0 ){
  165526. if( !rbuIsVacuum(p) ){
  165527. p->dbMain = rbuOpenDbhandle(p, p->zTarget, 1);
  165528. }else if( p->pRbuFd->pWalFd ){
  165529. if( pbRetry ){
  165530. p->pRbuFd->bNolock = 0;
  165531. sqlite3_close(p->dbRbu);
  165532. sqlite3_close(p->dbMain);
  165533. p->dbMain = 0;
  165534. p->dbRbu = 0;
  165535. *pbRetry = 1;
  165536. return;
  165537. }
  165538. p->rc = SQLITE_ERROR;
  165539. p->zErrmsg = sqlite3_mprintf("cannot vacuum wal mode database");
  165540. }else{
  165541. char *zTarget;
  165542. char *zExtra = 0;
  165543. if( strlen(p->zRbu)>=5 && 0==memcmp("file:", p->zRbu, 5) ){
  165544. zExtra = &p->zRbu[5];
  165545. while( *zExtra ){
  165546. if( *zExtra++=='?' ) break;
  165547. }
  165548. if( *zExtra=='\0' ) zExtra = 0;
  165549. }
  165550. zTarget = sqlite3_mprintf("file:%s-vacuum?rbu_memory=1%s%s",
  165551. sqlite3_db_filename(p->dbRbu, "main"),
  165552. (zExtra==0 ? "" : "&"), (zExtra==0 ? "" : zExtra)
  165553. );
  165554. if( zTarget==0 ){
  165555. p->rc = SQLITE_NOMEM;
  165556. return;
  165557. }
  165558. p->dbMain = rbuOpenDbhandle(p, zTarget, p->nRbu<=1);
  165559. sqlite3_free(zTarget);
  165560. }
  165561. }
  165562. if( p->rc==SQLITE_OK ){
  165563. p->rc = sqlite3_create_function(p->dbMain,
  165564. "rbu_tmp_insert", -1, SQLITE_UTF8, (void*)p, rbuTmpInsertFunc, 0, 0
  165565. );
  165566. }
  165567. if( p->rc==SQLITE_OK ){
  165568. p->rc = sqlite3_create_function(p->dbMain,
  165569. "rbu_fossil_delta", 2, SQLITE_UTF8, 0, rbuFossilDeltaFunc, 0, 0
  165570. );
  165571. }
  165572. if( p->rc==SQLITE_OK ){
  165573. p->rc = sqlite3_create_function(p->dbRbu,
  165574. "rbu_target_name", -1, SQLITE_UTF8, (void*)p, rbuTargetNameFunc, 0, 0
  165575. );
  165576. }
  165577. if( p->rc==SQLITE_OK ){
  165578. p->rc = sqlite3_file_control(p->dbMain, "main", SQLITE_FCNTL_RBU, (void*)p);
  165579. }
  165580. rbuMPrintfExec(p, p->dbMain, "SELECT * FROM sqlite_master");
  165581. /* Mark the database file just opened as an RBU target database. If
  165582. ** this call returns SQLITE_NOTFOUND, then the RBU vfs is not in use.
  165583. ** This is an error. */
  165584. if( p->rc==SQLITE_OK ){
  165585. p->rc = sqlite3_file_control(p->dbMain, "main", SQLITE_FCNTL_RBU, (void*)p);
  165586. }
  165587. if( p->rc==SQLITE_NOTFOUND ){
  165588. p->rc = SQLITE_ERROR;
  165589. p->zErrmsg = sqlite3_mprintf("rbu vfs not found");
  165590. }
  165591. }
  165592. /*
  165593. ** This routine is a copy of the sqlite3FileSuffix3() routine from the core.
  165594. ** It is a no-op unless SQLITE_ENABLE_8_3_NAMES is defined.
  165595. **
  165596. ** If SQLITE_ENABLE_8_3_NAMES is set at compile-time and if the database
  165597. ** filename in zBaseFilename is a URI with the "8_3_names=1" parameter and
  165598. ** if filename in z[] has a suffix (a.k.a. "extension") that is longer than
  165599. ** three characters, then shorten the suffix on z[] to be the last three
  165600. ** characters of the original suffix.
  165601. **
  165602. ** If SQLITE_ENABLE_8_3_NAMES is set to 2 at compile-time, then always
  165603. ** do the suffix shortening regardless of URI parameter.
  165604. **
  165605. ** Examples:
  165606. **
  165607. ** test.db-journal => test.nal
  165608. ** test.db-wal => test.wal
  165609. ** test.db-shm => test.shm
  165610. ** test.db-mj7f3319fa => test.9fa
  165611. */
  165612. static void rbuFileSuffix3(const char *zBase, char *z){
  165613. #ifdef SQLITE_ENABLE_8_3_NAMES
  165614. #if SQLITE_ENABLE_8_3_NAMES<2
  165615. if( sqlite3_uri_boolean(zBase, "8_3_names", 0) )
  165616. #endif
  165617. {
  165618. int i, sz;
  165619. sz = (int)strlen(z)&0xffffff;
  165620. for(i=sz-1; i>0 && z[i]!='/' && z[i]!='.'; i--){}
  165621. if( z[i]=='.' && sz>i+4 ) memmove(&z[i+1], &z[sz-3], 4);
  165622. }
  165623. #endif
  165624. }
  165625. /*
  165626. ** Return the current wal-index header checksum for the target database
  165627. ** as a 64-bit integer.
  165628. **
  165629. ** The checksum is store in the first page of xShmMap memory as an 8-byte
  165630. ** blob starting at byte offset 40.
  165631. */
  165632. static i64 rbuShmChecksum(sqlite3rbu *p){
  165633. i64 iRet = 0;
  165634. if( p->rc==SQLITE_OK ){
  165635. sqlite3_file *pDb = p->pTargetFd->pReal;
  165636. u32 volatile *ptr;
  165637. p->rc = pDb->pMethods->xShmMap(pDb, 0, 32*1024, 0, (void volatile**)&ptr);
  165638. if( p->rc==SQLITE_OK ){
  165639. iRet = ((i64)ptr[10] << 32) + ptr[11];
  165640. }
  165641. }
  165642. return iRet;
  165643. }
  165644. /*
  165645. ** This function is called as part of initializing or reinitializing an
  165646. ** incremental checkpoint.
  165647. **
  165648. ** It populates the sqlite3rbu.aFrame[] array with the set of
  165649. ** (wal frame -> db page) copy operations required to checkpoint the
  165650. ** current wal file, and obtains the set of shm locks required to safely
  165651. ** perform the copy operations directly on the file-system.
  165652. **
  165653. ** If argument pState is not NULL, then the incremental checkpoint is
  165654. ** being resumed. In this case, if the checksum of the wal-index-header
  165655. ** following recovery is not the same as the checksum saved in the RbuState
  165656. ** object, then the rbu handle is set to DONE state. This occurs if some
  165657. ** other client appends a transaction to the wal file in the middle of
  165658. ** an incremental checkpoint.
  165659. */
  165660. static void rbuSetupCheckpoint(sqlite3rbu *p, RbuState *pState){
  165661. /* If pState is NULL, then the wal file may not have been opened and
  165662. ** recovered. Running a read-statement here to ensure that doing so
  165663. ** does not interfere with the "capture" process below. */
  165664. if( pState==0 ){
  165665. p->eStage = 0;
  165666. if( p->rc==SQLITE_OK ){
  165667. p->rc = sqlite3_exec(p->dbMain, "SELECT * FROM sqlite_master", 0, 0, 0);
  165668. }
  165669. }
  165670. /* Assuming no error has occurred, run a "restart" checkpoint with the
  165671. ** sqlite3rbu.eStage variable set to CAPTURE. This turns on the following
  165672. ** special behaviour in the rbu VFS:
  165673. **
  165674. ** * If the exclusive shm WRITER or READ0 lock cannot be obtained,
  165675. ** the checkpoint fails with SQLITE_BUSY (normally SQLite would
  165676. ** proceed with running a passive checkpoint instead of failing).
  165677. **
  165678. ** * Attempts to read from the *-wal file or write to the database file
  165679. ** do not perform any IO. Instead, the frame/page combinations that
  165680. ** would be read/written are recorded in the sqlite3rbu.aFrame[]
  165681. ** array.
  165682. **
  165683. ** * Calls to xShmLock(UNLOCK) to release the exclusive shm WRITER,
  165684. ** READ0 and CHECKPOINT locks taken as part of the checkpoint are
  165685. ** no-ops. These locks will not be released until the connection
  165686. ** is closed.
  165687. **
  165688. ** * Attempting to xSync() the database file causes an SQLITE_INTERNAL
  165689. ** error.
  165690. **
  165691. ** As a result, unless an error (i.e. OOM or SQLITE_BUSY) occurs, the
  165692. ** checkpoint below fails with SQLITE_INTERNAL, and leaves the aFrame[]
  165693. ** array populated with a set of (frame -> page) mappings. Because the
  165694. ** WRITER, CHECKPOINT and READ0 locks are still held, it is safe to copy
  165695. ** data from the wal file into the database file according to the
  165696. ** contents of aFrame[].
  165697. */
  165698. if( p->rc==SQLITE_OK ){
  165699. int rc2;
  165700. p->eStage = RBU_STAGE_CAPTURE;
  165701. rc2 = sqlite3_exec(p->dbMain, "PRAGMA main.wal_checkpoint=restart", 0, 0,0);
  165702. if( rc2!=SQLITE_INTERNAL ) p->rc = rc2;
  165703. }
  165704. if( p->rc==SQLITE_OK && p->nFrame>0 ){
  165705. p->eStage = RBU_STAGE_CKPT;
  165706. p->nStep = (pState ? pState->nRow : 0);
  165707. p->aBuf = rbuMalloc(p, p->pgsz);
  165708. p->iWalCksum = rbuShmChecksum(p);
  165709. }
  165710. if( p->rc==SQLITE_OK ){
  165711. if( p->nFrame==0 || (pState && pState->iWalCksum!=p->iWalCksum) ){
  165712. p->rc = SQLITE_DONE;
  165713. p->eStage = RBU_STAGE_DONE;
  165714. }else{
  165715. int nSectorSize;
  165716. sqlite3_file *pDb = p->pTargetFd->pReal;
  165717. sqlite3_file *pWal = p->pTargetFd->pWalFd->pReal;
  165718. assert( p->nPagePerSector==0 );
  165719. nSectorSize = pDb->pMethods->xSectorSize(pDb);
  165720. if( nSectorSize>p->pgsz ){
  165721. p->nPagePerSector = nSectorSize / p->pgsz;
  165722. }else{
  165723. p->nPagePerSector = 1;
  165724. }
  165725. /* Call xSync() on the wal file. This causes SQLite to sync the
  165726. ** directory in which the target database and the wal file reside, in
  165727. ** case it has not been synced since the rename() call in
  165728. ** rbuMoveOalFile(). */
  165729. p->rc = pWal->pMethods->xSync(pWal, SQLITE_SYNC_NORMAL);
  165730. }
  165731. }
  165732. }
  165733. /*
  165734. ** Called when iAmt bytes are read from offset iOff of the wal file while
  165735. ** the rbu object is in capture mode. Record the frame number of the frame
  165736. ** being read in the aFrame[] array.
  165737. */
  165738. static int rbuCaptureWalRead(sqlite3rbu *pRbu, i64 iOff, int iAmt){
  165739. const u32 mReq = (1<<WAL_LOCK_WRITE)|(1<<WAL_LOCK_CKPT)|(1<<WAL_LOCK_READ0);
  165740. u32 iFrame;
  165741. if( pRbu->mLock!=mReq ){
  165742. pRbu->rc = SQLITE_BUSY;
  165743. return SQLITE_INTERNAL;
  165744. }
  165745. pRbu->pgsz = iAmt;
  165746. if( pRbu->nFrame==pRbu->nFrameAlloc ){
  165747. int nNew = (pRbu->nFrameAlloc ? pRbu->nFrameAlloc : 64) * 2;
  165748. RbuFrame *aNew;
  165749. aNew = (RbuFrame*)sqlite3_realloc64(pRbu->aFrame, nNew * sizeof(RbuFrame));
  165750. if( aNew==0 ) return SQLITE_NOMEM;
  165751. pRbu->aFrame = aNew;
  165752. pRbu->nFrameAlloc = nNew;
  165753. }
  165754. iFrame = (u32)((iOff-32) / (i64)(iAmt+24)) + 1;
  165755. if( pRbu->iMaxFrame<iFrame ) pRbu->iMaxFrame = iFrame;
  165756. pRbu->aFrame[pRbu->nFrame].iWalFrame = iFrame;
  165757. pRbu->aFrame[pRbu->nFrame].iDbPage = 0;
  165758. pRbu->nFrame++;
  165759. return SQLITE_OK;
  165760. }
  165761. /*
  165762. ** Called when a page of data is written to offset iOff of the database
  165763. ** file while the rbu handle is in capture mode. Record the page number
  165764. ** of the page being written in the aFrame[] array.
  165765. */
  165766. static int rbuCaptureDbWrite(sqlite3rbu *pRbu, i64 iOff){
  165767. pRbu->aFrame[pRbu->nFrame-1].iDbPage = (u32)(iOff / pRbu->pgsz) + 1;
  165768. return SQLITE_OK;
  165769. }
  165770. /*
  165771. ** This is called as part of an incremental checkpoint operation. Copy
  165772. ** a single frame of data from the wal file into the database file, as
  165773. ** indicated by the RbuFrame object.
  165774. */
  165775. static void rbuCheckpointFrame(sqlite3rbu *p, RbuFrame *pFrame){
  165776. sqlite3_file *pWal = p->pTargetFd->pWalFd->pReal;
  165777. sqlite3_file *pDb = p->pTargetFd->pReal;
  165778. i64 iOff;
  165779. assert( p->rc==SQLITE_OK );
  165780. iOff = (i64)(pFrame->iWalFrame-1) * (p->pgsz + 24) + 32 + 24;
  165781. p->rc = pWal->pMethods->xRead(pWal, p->aBuf, p->pgsz, iOff);
  165782. if( p->rc ) return;
  165783. iOff = (i64)(pFrame->iDbPage-1) * p->pgsz;
  165784. p->rc = pDb->pMethods->xWrite(pDb, p->aBuf, p->pgsz, iOff);
  165785. }
  165786. /*
  165787. ** Take an EXCLUSIVE lock on the database file.
  165788. */
  165789. static void rbuLockDatabase(sqlite3rbu *p){
  165790. sqlite3_file *pReal = p->pTargetFd->pReal;
  165791. assert( p->rc==SQLITE_OK );
  165792. p->rc = pReal->pMethods->xLock(pReal, SQLITE_LOCK_SHARED);
  165793. if( p->rc==SQLITE_OK ){
  165794. p->rc = pReal->pMethods->xLock(pReal, SQLITE_LOCK_EXCLUSIVE);
  165795. }
  165796. }
  165797. #if defined(_WIN32_WCE)
  165798. static LPWSTR rbuWinUtf8ToUnicode(const char *zFilename){
  165799. int nChar;
  165800. LPWSTR zWideFilename;
  165801. nChar = MultiByteToWideChar(CP_UTF8, 0, zFilename, -1, NULL, 0);
  165802. if( nChar==0 ){
  165803. return 0;
  165804. }
  165805. zWideFilename = sqlite3_malloc64( nChar*sizeof(zWideFilename[0]) );
  165806. if( zWideFilename==0 ){
  165807. return 0;
  165808. }
  165809. memset(zWideFilename, 0, nChar*sizeof(zWideFilename[0]));
  165810. nChar = MultiByteToWideChar(CP_UTF8, 0, zFilename, -1, zWideFilename,
  165811. nChar);
  165812. if( nChar==0 ){
  165813. sqlite3_free(zWideFilename);
  165814. zWideFilename = 0;
  165815. }
  165816. return zWideFilename;
  165817. }
  165818. #endif
  165819. /*
  165820. ** The RBU handle is currently in RBU_STAGE_OAL state, with a SHARED lock
  165821. ** on the database file. This proc moves the *-oal file to the *-wal path,
  165822. ** then reopens the database file (this time in vanilla, non-oal, WAL mode).
  165823. ** If an error occurs, leave an error code and error message in the rbu
  165824. ** handle.
  165825. */
  165826. static void rbuMoveOalFile(sqlite3rbu *p){
  165827. const char *zBase = sqlite3_db_filename(p->dbMain, "main");
  165828. const char *zMove = zBase;
  165829. char *zOal;
  165830. char *zWal;
  165831. if( rbuIsVacuum(p) ){
  165832. zMove = sqlite3_db_filename(p->dbRbu, "main");
  165833. }
  165834. zOal = sqlite3_mprintf("%s-oal", zMove);
  165835. zWal = sqlite3_mprintf("%s-wal", zMove);
  165836. assert( p->eStage==RBU_STAGE_MOVE );
  165837. assert( p->rc==SQLITE_OK && p->zErrmsg==0 );
  165838. if( zWal==0 || zOal==0 ){
  165839. p->rc = SQLITE_NOMEM;
  165840. }else{
  165841. /* Move the *-oal file to *-wal. At this point connection p->db is
  165842. ** holding a SHARED lock on the target database file (because it is
  165843. ** in WAL mode). So no other connection may be writing the db.
  165844. **
  165845. ** In order to ensure that there are no database readers, an EXCLUSIVE
  165846. ** lock is obtained here before the *-oal is moved to *-wal.
  165847. */
  165848. rbuLockDatabase(p);
  165849. if( p->rc==SQLITE_OK ){
  165850. rbuFileSuffix3(zBase, zWal);
  165851. rbuFileSuffix3(zBase, zOal);
  165852. /* Re-open the databases. */
  165853. rbuObjIterFinalize(&p->objiter);
  165854. sqlite3_close(p->dbRbu);
  165855. sqlite3_close(p->dbMain);
  165856. p->dbMain = 0;
  165857. p->dbRbu = 0;
  165858. #if defined(_WIN32_WCE)
  165859. {
  165860. LPWSTR zWideOal;
  165861. LPWSTR zWideWal;
  165862. zWideOal = rbuWinUtf8ToUnicode(zOal);
  165863. if( zWideOal ){
  165864. zWideWal = rbuWinUtf8ToUnicode(zWal);
  165865. if( zWideWal ){
  165866. if( MoveFileW(zWideOal, zWideWal) ){
  165867. p->rc = SQLITE_OK;
  165868. }else{
  165869. p->rc = SQLITE_IOERR;
  165870. }
  165871. sqlite3_free(zWideWal);
  165872. }else{
  165873. p->rc = SQLITE_IOERR_NOMEM;
  165874. }
  165875. sqlite3_free(zWideOal);
  165876. }else{
  165877. p->rc = SQLITE_IOERR_NOMEM;
  165878. }
  165879. }
  165880. #else
  165881. p->rc = rename(zOal, zWal) ? SQLITE_IOERR : SQLITE_OK;
  165882. #endif
  165883. if( p->rc==SQLITE_OK ){
  165884. rbuOpenDatabase(p, 0);
  165885. rbuSetupCheckpoint(p, 0);
  165886. }
  165887. }
  165888. }
  165889. sqlite3_free(zWal);
  165890. sqlite3_free(zOal);
  165891. }
  165892. /*
  165893. ** The SELECT statement iterating through the keys for the current object
  165894. ** (p->objiter.pSelect) currently points to a valid row. This function
  165895. ** determines the type of operation requested by this row and returns
  165896. ** one of the following values to indicate the result:
  165897. **
  165898. ** * RBU_INSERT
  165899. ** * RBU_DELETE
  165900. ** * RBU_IDX_DELETE
  165901. ** * RBU_UPDATE
  165902. **
  165903. ** If RBU_UPDATE is returned, then output variable *pzMask is set to
  165904. ** point to the text value indicating the columns to update.
  165905. **
  165906. ** If the rbu_control field contains an invalid value, an error code and
  165907. ** message are left in the RBU handle and zero returned.
  165908. */
  165909. static int rbuStepType(sqlite3rbu *p, const char **pzMask){
  165910. int iCol = p->objiter.nCol; /* Index of rbu_control column */
  165911. int res = 0; /* Return value */
  165912. switch( sqlite3_column_type(p->objiter.pSelect, iCol) ){
  165913. case SQLITE_INTEGER: {
  165914. int iVal = sqlite3_column_int(p->objiter.pSelect, iCol);
  165915. switch( iVal ){
  165916. case 0: res = RBU_INSERT; break;
  165917. case 1: res = RBU_DELETE; break;
  165918. case 2: res = RBU_REPLACE; break;
  165919. case 3: res = RBU_IDX_DELETE; break;
  165920. case 4: res = RBU_IDX_INSERT; break;
  165921. }
  165922. break;
  165923. }
  165924. case SQLITE_TEXT: {
  165925. const unsigned char *z = sqlite3_column_text(p->objiter.pSelect, iCol);
  165926. if( z==0 ){
  165927. p->rc = SQLITE_NOMEM;
  165928. }else{
  165929. *pzMask = (const char*)z;
  165930. }
  165931. res = RBU_UPDATE;
  165932. break;
  165933. }
  165934. default:
  165935. break;
  165936. }
  165937. if( res==0 ){
  165938. rbuBadControlError(p);
  165939. }
  165940. return res;
  165941. }
  165942. #ifdef SQLITE_DEBUG
  165943. /*
  165944. ** Assert that column iCol of statement pStmt is named zName.
  165945. */
  165946. static void assertColumnName(sqlite3_stmt *pStmt, int iCol, const char *zName){
  165947. const char *zCol = sqlite3_column_name(pStmt, iCol);
  165948. assert( 0==sqlite3_stricmp(zName, zCol) );
  165949. }
  165950. #else
  165951. # define assertColumnName(x,y,z)
  165952. #endif
  165953. /*
  165954. ** Argument eType must be one of RBU_INSERT, RBU_DELETE, RBU_IDX_INSERT or
  165955. ** RBU_IDX_DELETE. This function performs the work of a single
  165956. ** sqlite3rbu_step() call for the type of operation specified by eType.
  165957. */
  165958. static void rbuStepOneOp(sqlite3rbu *p, int eType){
  165959. RbuObjIter *pIter = &p->objiter;
  165960. sqlite3_value *pVal;
  165961. sqlite3_stmt *pWriter;
  165962. int i;
  165963. assert( p->rc==SQLITE_OK );
  165964. assert( eType!=RBU_DELETE || pIter->zIdx==0 );
  165965. assert( eType==RBU_DELETE || eType==RBU_IDX_DELETE
  165966. || eType==RBU_INSERT || eType==RBU_IDX_INSERT
  165967. );
  165968. /* If this is a delete, decrement nPhaseOneStep by nIndex. If the DELETE
  165969. ** statement below does actually delete a row, nPhaseOneStep will be
  165970. ** incremented by the same amount when SQL function rbu_tmp_insert()
  165971. ** is invoked by the trigger. */
  165972. if( eType==RBU_DELETE ){
  165973. p->nPhaseOneStep -= p->objiter.nIndex;
  165974. }
  165975. if( eType==RBU_IDX_DELETE || eType==RBU_DELETE ){
  165976. pWriter = pIter->pDelete;
  165977. }else{
  165978. pWriter = pIter->pInsert;
  165979. }
  165980. for(i=0; i<pIter->nCol; i++){
  165981. /* If this is an INSERT into a table b-tree and the table has an
  165982. ** explicit INTEGER PRIMARY KEY, check that this is not an attempt
  165983. ** to write a NULL into the IPK column. That is not permitted. */
  165984. if( eType==RBU_INSERT
  165985. && pIter->zIdx==0 && pIter->eType==RBU_PK_IPK && pIter->abTblPk[i]
  165986. && sqlite3_column_type(pIter->pSelect, i)==SQLITE_NULL
  165987. ){
  165988. p->rc = SQLITE_MISMATCH;
  165989. p->zErrmsg = sqlite3_mprintf("datatype mismatch");
  165990. return;
  165991. }
  165992. if( eType==RBU_DELETE && pIter->abTblPk[i]==0 ){
  165993. continue;
  165994. }
  165995. pVal = sqlite3_column_value(pIter->pSelect, i);
  165996. p->rc = sqlite3_bind_value(pWriter, i+1, pVal);
  165997. if( p->rc ) return;
  165998. }
  165999. if( pIter->zIdx==0 ){
  166000. if( pIter->eType==RBU_PK_VTAB
  166001. || pIter->eType==RBU_PK_NONE
  166002. || (pIter->eType==RBU_PK_EXTERNAL && rbuIsVacuum(p))
  166003. ){
  166004. /* For a virtual table, or a table with no primary key, the
  166005. ** SELECT statement is:
  166006. **
  166007. ** SELECT <cols>, rbu_control, rbu_rowid FROM ....
  166008. **
  166009. ** Hence column_value(pIter->nCol+1).
  166010. */
  166011. assertColumnName(pIter->pSelect, pIter->nCol+1,
  166012. rbuIsVacuum(p) ? "rowid" : "rbu_rowid"
  166013. );
  166014. pVal = sqlite3_column_value(pIter->pSelect, pIter->nCol+1);
  166015. p->rc = sqlite3_bind_value(pWriter, pIter->nCol+1, pVal);
  166016. }
  166017. }
  166018. if( p->rc==SQLITE_OK ){
  166019. sqlite3_step(pWriter);
  166020. p->rc = resetAndCollectError(pWriter, &p->zErrmsg);
  166021. }
  166022. }
  166023. /*
  166024. ** This function does the work for an sqlite3rbu_step() call.
  166025. **
  166026. ** The object-iterator (p->objiter) currently points to a valid object,
  166027. ** and the input cursor (p->objiter.pSelect) currently points to a valid
  166028. ** input row. Perform whatever processing is required and return.
  166029. **
  166030. ** If no error occurs, SQLITE_OK is returned. Otherwise, an error code
  166031. ** and message is left in the RBU handle and a copy of the error code
  166032. ** returned.
  166033. */
  166034. static int rbuStep(sqlite3rbu *p){
  166035. RbuObjIter *pIter = &p->objiter;
  166036. const char *zMask = 0;
  166037. int eType = rbuStepType(p, &zMask);
  166038. if( eType ){
  166039. assert( eType==RBU_INSERT || eType==RBU_DELETE
  166040. || eType==RBU_REPLACE || eType==RBU_IDX_DELETE
  166041. || eType==RBU_IDX_INSERT || eType==RBU_UPDATE
  166042. );
  166043. assert( eType!=RBU_UPDATE || pIter->zIdx==0 );
  166044. if( pIter->zIdx==0 && (eType==RBU_IDX_DELETE || eType==RBU_IDX_INSERT) ){
  166045. rbuBadControlError(p);
  166046. }
  166047. else if( eType==RBU_REPLACE ){
  166048. if( pIter->zIdx==0 ){
  166049. p->nPhaseOneStep += p->objiter.nIndex;
  166050. rbuStepOneOp(p, RBU_DELETE);
  166051. }
  166052. if( p->rc==SQLITE_OK ) rbuStepOneOp(p, RBU_INSERT);
  166053. }
  166054. else if( eType!=RBU_UPDATE ){
  166055. rbuStepOneOp(p, eType);
  166056. }
  166057. else{
  166058. sqlite3_value *pVal;
  166059. sqlite3_stmt *pUpdate = 0;
  166060. assert( eType==RBU_UPDATE );
  166061. p->nPhaseOneStep -= p->objiter.nIndex;
  166062. rbuGetUpdateStmt(p, pIter, zMask, &pUpdate);
  166063. if( pUpdate ){
  166064. int i;
  166065. for(i=0; p->rc==SQLITE_OK && i<pIter->nCol; i++){
  166066. char c = zMask[pIter->aiSrcOrder[i]];
  166067. pVal = sqlite3_column_value(pIter->pSelect, i);
  166068. if( pIter->abTblPk[i] || c!='.' ){
  166069. p->rc = sqlite3_bind_value(pUpdate, i+1, pVal);
  166070. }
  166071. }
  166072. if( p->rc==SQLITE_OK
  166073. && (pIter->eType==RBU_PK_VTAB || pIter->eType==RBU_PK_NONE)
  166074. ){
  166075. /* Bind the rbu_rowid value to column _rowid_ */
  166076. assertColumnName(pIter->pSelect, pIter->nCol+1, "rbu_rowid");
  166077. pVal = sqlite3_column_value(pIter->pSelect, pIter->nCol+1);
  166078. p->rc = sqlite3_bind_value(pUpdate, pIter->nCol+1, pVal);
  166079. }
  166080. if( p->rc==SQLITE_OK ){
  166081. sqlite3_step(pUpdate);
  166082. p->rc = resetAndCollectError(pUpdate, &p->zErrmsg);
  166083. }
  166084. }
  166085. }
  166086. }
  166087. return p->rc;
  166088. }
  166089. /*
  166090. ** Increment the schema cookie of the main database opened by p->dbMain.
  166091. **
  166092. ** Or, if this is an RBU vacuum, set the schema cookie of the main db
  166093. ** opened by p->dbMain to one more than the schema cookie of the main
  166094. ** db opened by p->dbRbu.
  166095. */
  166096. static void rbuIncrSchemaCookie(sqlite3rbu *p){
  166097. if( p->rc==SQLITE_OK ){
  166098. sqlite3 *dbread = (rbuIsVacuum(p) ? p->dbRbu : p->dbMain);
  166099. int iCookie = 1000000;
  166100. sqlite3_stmt *pStmt;
  166101. p->rc = prepareAndCollectError(dbread, &pStmt, &p->zErrmsg,
  166102. "PRAGMA schema_version"
  166103. );
  166104. if( p->rc==SQLITE_OK ){
  166105. /* Coverage: it may be that this sqlite3_step() cannot fail. There
  166106. ** is already a transaction open, so the prepared statement cannot
  166107. ** throw an SQLITE_SCHEMA exception. The only database page the
  166108. ** statement reads is page 1, which is guaranteed to be in the cache.
  166109. ** And no memory allocations are required. */
  166110. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  166111. iCookie = sqlite3_column_int(pStmt, 0);
  166112. }
  166113. rbuFinalize(p, pStmt);
  166114. }
  166115. if( p->rc==SQLITE_OK ){
  166116. rbuMPrintfExec(p, p->dbMain, "PRAGMA schema_version = %d", iCookie+1);
  166117. }
  166118. }
  166119. }
  166120. /*
  166121. ** Update the contents of the rbu_state table within the rbu database. The
  166122. ** value stored in the RBU_STATE_STAGE column is eStage. All other values
  166123. ** are determined by inspecting the rbu handle passed as the first argument.
  166124. */
  166125. static void rbuSaveState(sqlite3rbu *p, int eStage){
  166126. if( p->rc==SQLITE_OK || p->rc==SQLITE_DONE ){
  166127. sqlite3_stmt *pInsert = 0;
  166128. rbu_file *pFd = (rbuIsVacuum(p) ? p->pRbuFd : p->pTargetFd);
  166129. int rc;
  166130. assert( p->zErrmsg==0 );
  166131. rc = prepareFreeAndCollectError(p->dbRbu, &pInsert, &p->zErrmsg,
  166132. sqlite3_mprintf(
  166133. "INSERT OR REPLACE INTO %s.rbu_state(k, v) VALUES "
  166134. "(%d, %d), "
  166135. "(%d, %Q), "
  166136. "(%d, %Q), "
  166137. "(%d, %d), "
  166138. "(%d, %d), "
  166139. "(%d, %lld), "
  166140. "(%d, %lld), "
  166141. "(%d, %lld), "
  166142. "(%d, %lld) ",
  166143. p->zStateDb,
  166144. RBU_STATE_STAGE, eStage,
  166145. RBU_STATE_TBL, p->objiter.zTbl,
  166146. RBU_STATE_IDX, p->objiter.zIdx,
  166147. RBU_STATE_ROW, p->nStep,
  166148. RBU_STATE_PROGRESS, p->nProgress,
  166149. RBU_STATE_CKPT, p->iWalCksum,
  166150. RBU_STATE_COOKIE, (i64)pFd->iCookie,
  166151. RBU_STATE_OALSZ, p->iOalSz,
  166152. RBU_STATE_PHASEONESTEP, p->nPhaseOneStep
  166153. )
  166154. );
  166155. assert( pInsert==0 || rc==SQLITE_OK );
  166156. if( rc==SQLITE_OK ){
  166157. sqlite3_step(pInsert);
  166158. rc = sqlite3_finalize(pInsert);
  166159. }
  166160. if( rc!=SQLITE_OK ) p->rc = rc;
  166161. }
  166162. }
  166163. /*
  166164. ** The second argument passed to this function is the name of a PRAGMA
  166165. ** setting - "page_size", "auto_vacuum", "user_version" or "application_id".
  166166. ** This function executes the following on sqlite3rbu.dbRbu:
  166167. **
  166168. ** "PRAGMA main.$zPragma"
  166169. **
  166170. ** where $zPragma is the string passed as the second argument, then
  166171. ** on sqlite3rbu.dbMain:
  166172. **
  166173. ** "PRAGMA main.$zPragma = $val"
  166174. **
  166175. ** where $val is the value returned by the first PRAGMA invocation.
  166176. **
  166177. ** In short, it copies the value of the specified PRAGMA setting from
  166178. ** dbRbu to dbMain.
  166179. */
  166180. static void rbuCopyPragma(sqlite3rbu *p, const char *zPragma){
  166181. if( p->rc==SQLITE_OK ){
  166182. sqlite3_stmt *pPragma = 0;
  166183. p->rc = prepareFreeAndCollectError(p->dbRbu, &pPragma, &p->zErrmsg,
  166184. sqlite3_mprintf("PRAGMA main.%s", zPragma)
  166185. );
  166186. if( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pPragma) ){
  166187. p->rc = rbuMPrintfExec(p, p->dbMain, "PRAGMA main.%s = %d",
  166188. zPragma, sqlite3_column_int(pPragma, 0)
  166189. );
  166190. }
  166191. rbuFinalize(p, pPragma);
  166192. }
  166193. }
  166194. /*
  166195. ** The RBU handle passed as the only argument has just been opened and
  166196. ** the state database is empty. If this RBU handle was opened for an
  166197. ** RBU vacuum operation, create the schema in the target db.
  166198. */
  166199. static void rbuCreateTargetSchema(sqlite3rbu *p){
  166200. sqlite3_stmt *pSql = 0;
  166201. sqlite3_stmt *pInsert = 0;
  166202. assert( rbuIsVacuum(p) );
  166203. p->rc = sqlite3_exec(p->dbMain, "PRAGMA writable_schema=1", 0,0, &p->zErrmsg);
  166204. if( p->rc==SQLITE_OK ){
  166205. p->rc = prepareAndCollectError(p->dbRbu, &pSql, &p->zErrmsg,
  166206. "SELECT sql FROM sqlite_master WHERE sql!='' AND rootpage!=0"
  166207. " AND name!='sqlite_sequence' "
  166208. " ORDER BY type DESC"
  166209. );
  166210. }
  166211. while( p->rc==SQLITE_OK && sqlite3_step(pSql)==SQLITE_ROW ){
  166212. const char *zSql = (const char*)sqlite3_column_text(pSql, 0);
  166213. p->rc = sqlite3_exec(p->dbMain, zSql, 0, 0, &p->zErrmsg);
  166214. }
  166215. rbuFinalize(p, pSql);
  166216. if( p->rc!=SQLITE_OK ) return;
  166217. if( p->rc==SQLITE_OK ){
  166218. p->rc = prepareAndCollectError(p->dbRbu, &pSql, &p->zErrmsg,
  166219. "SELECT * FROM sqlite_master WHERE rootpage=0 OR rootpage IS NULL"
  166220. );
  166221. }
  166222. if( p->rc==SQLITE_OK ){
  166223. p->rc = prepareAndCollectError(p->dbMain, &pInsert, &p->zErrmsg,
  166224. "INSERT INTO sqlite_master VALUES(?,?,?,?,?)"
  166225. );
  166226. }
  166227. while( p->rc==SQLITE_OK && sqlite3_step(pSql)==SQLITE_ROW ){
  166228. int i;
  166229. for(i=0; i<5; i++){
  166230. sqlite3_bind_value(pInsert, i+1, sqlite3_column_value(pSql, i));
  166231. }
  166232. sqlite3_step(pInsert);
  166233. p->rc = sqlite3_reset(pInsert);
  166234. }
  166235. if( p->rc==SQLITE_OK ){
  166236. p->rc = sqlite3_exec(p->dbMain, "PRAGMA writable_schema=0",0,0,&p->zErrmsg);
  166237. }
  166238. rbuFinalize(p, pSql);
  166239. rbuFinalize(p, pInsert);
  166240. }
  166241. /*
  166242. ** Step the RBU object.
  166243. */
  166244. SQLITE_API int sqlite3rbu_step(sqlite3rbu *p){
  166245. if( p ){
  166246. switch( p->eStage ){
  166247. case RBU_STAGE_OAL: {
  166248. RbuObjIter *pIter = &p->objiter;
  166249. /* If this is an RBU vacuum operation and the state table was empty
  166250. ** when this handle was opened, create the target database schema. */
  166251. if( rbuIsVacuum(p) && p->nProgress==0 && p->rc==SQLITE_OK ){
  166252. rbuCreateTargetSchema(p);
  166253. rbuCopyPragma(p, "user_version");
  166254. rbuCopyPragma(p, "application_id");
  166255. }
  166256. while( p->rc==SQLITE_OK && pIter->zTbl ){
  166257. if( pIter->bCleanup ){
  166258. /* Clean up the rbu_tmp_xxx table for the previous table. It
  166259. ** cannot be dropped as there are currently active SQL statements.
  166260. ** But the contents can be deleted. */
  166261. if( rbuIsVacuum(p)==0 && pIter->abIndexed ){
  166262. rbuMPrintfExec(p, p->dbRbu,
  166263. "DELETE FROM %s.'rbu_tmp_%q'", p->zStateDb, pIter->zDataTbl
  166264. );
  166265. }
  166266. }else{
  166267. rbuObjIterPrepareAll(p, pIter, 0);
  166268. /* Advance to the next row to process. */
  166269. if( p->rc==SQLITE_OK ){
  166270. int rc = sqlite3_step(pIter->pSelect);
  166271. if( rc==SQLITE_ROW ){
  166272. p->nProgress++;
  166273. p->nStep++;
  166274. return rbuStep(p);
  166275. }
  166276. p->rc = sqlite3_reset(pIter->pSelect);
  166277. p->nStep = 0;
  166278. }
  166279. }
  166280. rbuObjIterNext(p, pIter);
  166281. }
  166282. if( p->rc==SQLITE_OK ){
  166283. assert( pIter->zTbl==0 );
  166284. rbuSaveState(p, RBU_STAGE_MOVE);
  166285. rbuIncrSchemaCookie(p);
  166286. if( p->rc==SQLITE_OK ){
  166287. p->rc = sqlite3_exec(p->dbMain, "COMMIT", 0, 0, &p->zErrmsg);
  166288. }
  166289. if( p->rc==SQLITE_OK ){
  166290. p->rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, &p->zErrmsg);
  166291. }
  166292. p->eStage = RBU_STAGE_MOVE;
  166293. }
  166294. break;
  166295. }
  166296. case RBU_STAGE_MOVE: {
  166297. if( p->rc==SQLITE_OK ){
  166298. rbuMoveOalFile(p);
  166299. p->nProgress++;
  166300. }
  166301. break;
  166302. }
  166303. case RBU_STAGE_CKPT: {
  166304. if( p->rc==SQLITE_OK ){
  166305. if( p->nStep>=p->nFrame ){
  166306. sqlite3_file *pDb = p->pTargetFd->pReal;
  166307. /* Sync the db file */
  166308. p->rc = pDb->pMethods->xSync(pDb, SQLITE_SYNC_NORMAL);
  166309. /* Update nBackfill */
  166310. if( p->rc==SQLITE_OK ){
  166311. void volatile *ptr;
  166312. p->rc = pDb->pMethods->xShmMap(pDb, 0, 32*1024, 0, &ptr);
  166313. if( p->rc==SQLITE_OK ){
  166314. ((u32 volatile*)ptr)[24] = p->iMaxFrame;
  166315. }
  166316. }
  166317. if( p->rc==SQLITE_OK ){
  166318. p->eStage = RBU_STAGE_DONE;
  166319. p->rc = SQLITE_DONE;
  166320. }
  166321. }else{
  166322. /* At one point the following block copied a single frame from the
  166323. ** wal file to the database file. So that one call to sqlite3rbu_step()
  166324. ** checkpointed a single frame.
  166325. **
  166326. ** However, if the sector-size is larger than the page-size, and the
  166327. ** application calls sqlite3rbu_savestate() or close() immediately
  166328. ** after this step, then rbu_step() again, then a power failure occurs,
  166329. ** then the database page written here may be damaged. Work around
  166330. ** this by checkpointing frames until the next page in the aFrame[]
  166331. ** lies on a different disk sector to the current one. */
  166332. u32 iSector;
  166333. do{
  166334. RbuFrame *pFrame = &p->aFrame[p->nStep];
  166335. iSector = (pFrame->iDbPage-1) / p->nPagePerSector;
  166336. rbuCheckpointFrame(p, pFrame);
  166337. p->nStep++;
  166338. }while( p->nStep<p->nFrame
  166339. && iSector==((p->aFrame[p->nStep].iDbPage-1) / p->nPagePerSector)
  166340. && p->rc==SQLITE_OK
  166341. );
  166342. }
  166343. p->nProgress++;
  166344. }
  166345. break;
  166346. }
  166347. default:
  166348. break;
  166349. }
  166350. return p->rc;
  166351. }else{
  166352. return SQLITE_NOMEM;
  166353. }
  166354. }
  166355. /*
  166356. ** Compare strings z1 and z2, returning 0 if they are identical, or non-zero
  166357. ** otherwise. Either or both argument may be NULL. Two NULL values are
  166358. ** considered equal, and NULL is considered distinct from all other values.
  166359. */
  166360. static int rbuStrCompare(const char *z1, const char *z2){
  166361. if( z1==0 && z2==0 ) return 0;
  166362. if( z1==0 || z2==0 ) return 1;
  166363. return (sqlite3_stricmp(z1, z2)!=0);
  166364. }
  166365. /*
  166366. ** This function is called as part of sqlite3rbu_open() when initializing
  166367. ** an rbu handle in OAL stage. If the rbu update has not started (i.e.
  166368. ** the rbu_state table was empty) it is a no-op. Otherwise, it arranges
  166369. ** things so that the next call to sqlite3rbu_step() continues on from
  166370. ** where the previous rbu handle left off.
  166371. **
  166372. ** If an error occurs, an error code and error message are left in the
  166373. ** rbu handle passed as the first argument.
  166374. */
  166375. static void rbuSetupOal(sqlite3rbu *p, RbuState *pState){
  166376. assert( p->rc==SQLITE_OK );
  166377. if( pState->zTbl ){
  166378. RbuObjIter *pIter = &p->objiter;
  166379. int rc = SQLITE_OK;
  166380. while( rc==SQLITE_OK && pIter->zTbl && (pIter->bCleanup
  166381. || rbuStrCompare(pIter->zIdx, pState->zIdx)
  166382. || rbuStrCompare(pIter->zTbl, pState->zTbl)
  166383. )){
  166384. rc = rbuObjIterNext(p, pIter);
  166385. }
  166386. if( rc==SQLITE_OK && !pIter->zTbl ){
  166387. rc = SQLITE_ERROR;
  166388. p->zErrmsg = sqlite3_mprintf("rbu_state mismatch error");
  166389. }
  166390. if( rc==SQLITE_OK ){
  166391. p->nStep = pState->nRow;
  166392. rc = rbuObjIterPrepareAll(p, &p->objiter, p->nStep);
  166393. }
  166394. p->rc = rc;
  166395. }
  166396. }
  166397. /*
  166398. ** If there is a "*-oal" file in the file-system corresponding to the
  166399. ** target database in the file-system, delete it. If an error occurs,
  166400. ** leave an error code and error message in the rbu handle.
  166401. */
  166402. static void rbuDeleteOalFile(sqlite3rbu *p){
  166403. char *zOal = rbuMPrintf(p, "%s-oal", p->zTarget);
  166404. if( zOal ){
  166405. sqlite3_vfs *pVfs = sqlite3_vfs_find(0);
  166406. assert( pVfs && p->rc==SQLITE_OK && p->zErrmsg==0 );
  166407. pVfs->xDelete(pVfs, zOal, 0);
  166408. sqlite3_free(zOal);
  166409. }
  166410. }
  166411. /*
  166412. ** Allocate a private rbu VFS for the rbu handle passed as the only
  166413. ** argument. This VFS will be used unless the call to sqlite3rbu_open()
  166414. ** specified a URI with a vfs=? option in place of a target database
  166415. ** file name.
  166416. */
  166417. static void rbuCreateVfs(sqlite3rbu *p){
  166418. int rnd;
  166419. char zRnd[64];
  166420. assert( p->rc==SQLITE_OK );
  166421. sqlite3_randomness(sizeof(int), (void*)&rnd);
  166422. sqlite3_snprintf(sizeof(zRnd), zRnd, "rbu_vfs_%d", rnd);
  166423. p->rc = sqlite3rbu_create_vfs(zRnd, 0);
  166424. if( p->rc==SQLITE_OK ){
  166425. sqlite3_vfs *pVfs = sqlite3_vfs_find(zRnd);
  166426. assert( pVfs );
  166427. p->zVfsName = pVfs->zName;
  166428. ((rbu_vfs*)pVfs)->pRbu = p;
  166429. }
  166430. }
  166431. /*
  166432. ** Destroy the private VFS created for the rbu handle passed as the only
  166433. ** argument by an earlier call to rbuCreateVfs().
  166434. */
  166435. static void rbuDeleteVfs(sqlite3rbu *p){
  166436. if( p->zVfsName ){
  166437. sqlite3rbu_destroy_vfs(p->zVfsName);
  166438. p->zVfsName = 0;
  166439. }
  166440. }
  166441. /*
  166442. ** This user-defined SQL function is invoked with a single argument - the
  166443. ** name of a table expected to appear in the target database. It returns
  166444. ** the number of auxilliary indexes on the table.
  166445. */
  166446. static void rbuIndexCntFunc(
  166447. sqlite3_context *pCtx,
  166448. int nVal,
  166449. sqlite3_value **apVal
  166450. ){
  166451. sqlite3rbu *p = (sqlite3rbu*)sqlite3_user_data(pCtx);
  166452. sqlite3_stmt *pStmt = 0;
  166453. char *zErrmsg = 0;
  166454. int rc;
  166455. assert( nVal==1 );
  166456. rc = prepareFreeAndCollectError(p->dbMain, &pStmt, &zErrmsg,
  166457. sqlite3_mprintf("SELECT count(*) FROM sqlite_master "
  166458. "WHERE type='index' AND tbl_name = %Q", sqlite3_value_text(apVal[0]))
  166459. );
  166460. if( rc!=SQLITE_OK ){
  166461. sqlite3_result_error(pCtx, zErrmsg, -1);
  166462. }else{
  166463. int nIndex = 0;
  166464. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  166465. nIndex = sqlite3_column_int(pStmt, 0);
  166466. }
  166467. rc = sqlite3_finalize(pStmt);
  166468. if( rc==SQLITE_OK ){
  166469. sqlite3_result_int(pCtx, nIndex);
  166470. }else{
  166471. sqlite3_result_error(pCtx, sqlite3_errmsg(p->dbMain), -1);
  166472. }
  166473. }
  166474. sqlite3_free(zErrmsg);
  166475. }
  166476. /*
  166477. ** If the RBU database contains the rbu_count table, use it to initialize
  166478. ** the sqlite3rbu.nPhaseOneStep variable. The schema of the rbu_count table
  166479. ** is assumed to contain the same columns as:
  166480. **
  166481. ** CREATE TABLE rbu_count(tbl TEXT PRIMARY KEY, cnt INTEGER) WITHOUT ROWID;
  166482. **
  166483. ** There should be one row in the table for each data_xxx table in the
  166484. ** database. The 'tbl' column should contain the name of a data_xxx table,
  166485. ** and the cnt column the number of rows it contains.
  166486. **
  166487. ** sqlite3rbu.nPhaseOneStep is initialized to the sum of (1 + nIndex) * cnt
  166488. ** for all rows in the rbu_count table, where nIndex is the number of
  166489. ** indexes on the corresponding target database table.
  166490. */
  166491. static void rbuInitPhaseOneSteps(sqlite3rbu *p){
  166492. if( p->rc==SQLITE_OK ){
  166493. sqlite3_stmt *pStmt = 0;
  166494. int bExists = 0; /* True if rbu_count exists */
  166495. p->nPhaseOneStep = -1;
  166496. p->rc = sqlite3_create_function(p->dbRbu,
  166497. "rbu_index_cnt", 1, SQLITE_UTF8, (void*)p, rbuIndexCntFunc, 0, 0
  166498. );
  166499. /* Check for the rbu_count table. If it does not exist, or if an error
  166500. ** occurs, nPhaseOneStep will be left set to -1. */
  166501. if( p->rc==SQLITE_OK ){
  166502. p->rc = prepareAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  166503. "SELECT 1 FROM sqlite_master WHERE tbl_name = 'rbu_count'"
  166504. );
  166505. }
  166506. if( p->rc==SQLITE_OK ){
  166507. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  166508. bExists = 1;
  166509. }
  166510. p->rc = sqlite3_finalize(pStmt);
  166511. }
  166512. if( p->rc==SQLITE_OK && bExists ){
  166513. p->rc = prepareAndCollectError(p->dbRbu, &pStmt, &p->zErrmsg,
  166514. "SELECT sum(cnt * (1 + rbu_index_cnt(rbu_target_name(tbl))))"
  166515. "FROM rbu_count"
  166516. );
  166517. if( p->rc==SQLITE_OK ){
  166518. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  166519. p->nPhaseOneStep = sqlite3_column_int64(pStmt, 0);
  166520. }
  166521. p->rc = sqlite3_finalize(pStmt);
  166522. }
  166523. }
  166524. }
  166525. }
  166526. static sqlite3rbu *openRbuHandle(
  166527. const char *zTarget,
  166528. const char *zRbu,
  166529. const char *zState
  166530. ){
  166531. sqlite3rbu *p;
  166532. size_t nTarget = zTarget ? strlen(zTarget) : 0;
  166533. size_t nRbu = strlen(zRbu);
  166534. size_t nByte = sizeof(sqlite3rbu) + nTarget+1 + nRbu+1;
  166535. p = (sqlite3rbu*)sqlite3_malloc64(nByte);
  166536. if( p ){
  166537. RbuState *pState = 0;
  166538. /* Create the custom VFS. */
  166539. memset(p, 0, sizeof(sqlite3rbu));
  166540. rbuCreateVfs(p);
  166541. /* Open the target, RBU and state databases */
  166542. if( p->rc==SQLITE_OK ){
  166543. char *pCsr = (char*)&p[1];
  166544. int bRetry = 0;
  166545. if( zTarget ){
  166546. p->zTarget = pCsr;
  166547. memcpy(p->zTarget, zTarget, nTarget+1);
  166548. pCsr += nTarget+1;
  166549. }
  166550. p->zRbu = pCsr;
  166551. memcpy(p->zRbu, zRbu, nRbu+1);
  166552. pCsr += nRbu+1;
  166553. if( zState ){
  166554. p->zState = rbuMPrintf(p, "%s", zState);
  166555. }
  166556. /* If the first attempt to open the database file fails and the bRetry
  166557. ** flag it set, this means that the db was not opened because it seemed
  166558. ** to be a wal-mode db. But, this may have happened due to an earlier
  166559. ** RBU vacuum operation leaving an old wal file in the directory.
  166560. ** If this is the case, it will have been checkpointed and deleted
  166561. ** when the handle was closed and a second attempt to open the
  166562. ** database may succeed. */
  166563. rbuOpenDatabase(p, &bRetry);
  166564. if( bRetry ){
  166565. rbuOpenDatabase(p, 0);
  166566. }
  166567. }
  166568. if( p->rc==SQLITE_OK ){
  166569. pState = rbuLoadState(p);
  166570. assert( pState || p->rc!=SQLITE_OK );
  166571. if( p->rc==SQLITE_OK ){
  166572. if( pState->eStage==0 ){
  166573. rbuDeleteOalFile(p);
  166574. rbuInitPhaseOneSteps(p);
  166575. p->eStage = RBU_STAGE_OAL;
  166576. }else{
  166577. p->eStage = pState->eStage;
  166578. p->nPhaseOneStep = pState->nPhaseOneStep;
  166579. }
  166580. p->nProgress = pState->nProgress;
  166581. p->iOalSz = pState->iOalSz;
  166582. }
  166583. }
  166584. assert( p->rc!=SQLITE_OK || p->eStage!=0 );
  166585. if( p->rc==SQLITE_OK && p->pTargetFd->pWalFd ){
  166586. if( p->eStage==RBU_STAGE_OAL ){
  166587. p->rc = SQLITE_ERROR;
  166588. p->zErrmsg = sqlite3_mprintf("cannot update wal mode database");
  166589. }else if( p->eStage==RBU_STAGE_MOVE ){
  166590. p->eStage = RBU_STAGE_CKPT;
  166591. p->nStep = 0;
  166592. }
  166593. }
  166594. if( p->rc==SQLITE_OK
  166595. && (p->eStage==RBU_STAGE_OAL || p->eStage==RBU_STAGE_MOVE)
  166596. && pState->eStage!=0
  166597. ){
  166598. rbu_file *pFd = (rbuIsVacuum(p) ? p->pRbuFd : p->pTargetFd);
  166599. if( pFd->iCookie!=pState->iCookie ){
  166600. /* At this point (pTargetFd->iCookie) contains the value of the
  166601. ** change-counter cookie (the thing that gets incremented when a
  166602. ** transaction is committed in rollback mode) currently stored on
  166603. ** page 1 of the database file. */
  166604. p->rc = SQLITE_BUSY;
  166605. p->zErrmsg = sqlite3_mprintf("database modified during rbu %s",
  166606. (rbuIsVacuum(p) ? "vacuum" : "update")
  166607. );
  166608. }
  166609. }
  166610. if( p->rc==SQLITE_OK ){
  166611. if( p->eStage==RBU_STAGE_OAL ){
  166612. sqlite3 *db = p->dbMain;
  166613. p->rc = sqlite3_exec(p->dbRbu, "BEGIN", 0, 0, &p->zErrmsg);
  166614. /* Point the object iterator at the first object */
  166615. if( p->rc==SQLITE_OK ){
  166616. p->rc = rbuObjIterFirst(p, &p->objiter);
  166617. }
  166618. /* If the RBU database contains no data_xxx tables, declare the RBU
  166619. ** update finished. */
  166620. if( p->rc==SQLITE_OK && p->objiter.zTbl==0 ){
  166621. p->rc = SQLITE_DONE;
  166622. p->eStage = RBU_STAGE_DONE;
  166623. }else{
  166624. if( p->rc==SQLITE_OK && pState->eStage==0 && rbuIsVacuum(p) ){
  166625. rbuCopyPragma(p, "page_size");
  166626. rbuCopyPragma(p, "auto_vacuum");
  166627. }
  166628. /* Open transactions both databases. The *-oal file is opened or
  166629. ** created at this point. */
  166630. if( p->rc==SQLITE_OK ){
  166631. p->rc = sqlite3_exec(db, "BEGIN IMMEDIATE", 0, 0, &p->zErrmsg);
  166632. }
  166633. /* Check if the main database is a zipvfs db. If it is, set the upper
  166634. ** level pager to use "journal_mode=off". This prevents it from
  166635. ** generating a large journal using a temp file. */
  166636. if( p->rc==SQLITE_OK ){
  166637. int frc = sqlite3_file_control(db, "main", SQLITE_FCNTL_ZIPVFS, 0);
  166638. if( frc==SQLITE_OK ){
  166639. p->rc = sqlite3_exec(
  166640. db, "PRAGMA journal_mode=off",0,0,&p->zErrmsg);
  166641. }
  166642. }
  166643. if( p->rc==SQLITE_OK ){
  166644. rbuSetupOal(p, pState);
  166645. }
  166646. }
  166647. }else if( p->eStage==RBU_STAGE_MOVE ){
  166648. /* no-op */
  166649. }else if( p->eStage==RBU_STAGE_CKPT ){
  166650. rbuSetupCheckpoint(p, pState);
  166651. }else if( p->eStage==RBU_STAGE_DONE ){
  166652. p->rc = SQLITE_DONE;
  166653. }else{
  166654. p->rc = SQLITE_CORRUPT;
  166655. }
  166656. }
  166657. rbuFreeState(pState);
  166658. }
  166659. return p;
  166660. }
  166661. /*
  166662. ** Allocate and return an RBU handle with all fields zeroed except for the
  166663. ** error code, which is set to SQLITE_MISUSE.
  166664. */
  166665. static sqlite3rbu *rbuMisuseError(void){
  166666. sqlite3rbu *pRet;
  166667. pRet = sqlite3_malloc64(sizeof(sqlite3rbu));
  166668. if( pRet ){
  166669. memset(pRet, 0, sizeof(sqlite3rbu));
  166670. pRet->rc = SQLITE_MISUSE;
  166671. }
  166672. return pRet;
  166673. }
  166674. /*
  166675. ** Open and return a new RBU handle.
  166676. */
  166677. SQLITE_API sqlite3rbu *sqlite3rbu_open(
  166678. const char *zTarget,
  166679. const char *zRbu,
  166680. const char *zState
  166681. ){
  166682. if( zTarget==0 || zRbu==0 ){ return rbuMisuseError(); }
  166683. /* TODO: Check that zTarget and zRbu are non-NULL */
  166684. return openRbuHandle(zTarget, zRbu, zState);
  166685. }
  166686. /*
  166687. ** Open a handle to begin or resume an RBU VACUUM operation.
  166688. */
  166689. SQLITE_API sqlite3rbu *sqlite3rbu_vacuum(
  166690. const char *zTarget,
  166691. const char *zState
  166692. ){
  166693. if( zTarget==0 ){ return rbuMisuseError(); }
  166694. /* TODO: Check that both arguments are non-NULL */
  166695. return openRbuHandle(0, zTarget, zState);
  166696. }
  166697. /*
  166698. ** Return the database handle used by pRbu.
  166699. */
  166700. SQLITE_API sqlite3 *sqlite3rbu_db(sqlite3rbu *pRbu, int bRbu){
  166701. sqlite3 *db = 0;
  166702. if( pRbu ){
  166703. db = (bRbu ? pRbu->dbRbu : pRbu->dbMain);
  166704. }
  166705. return db;
  166706. }
  166707. /*
  166708. ** If the error code currently stored in the RBU handle is SQLITE_CONSTRAINT,
  166709. ** then edit any error message string so as to remove all occurrences of
  166710. ** the pattern "rbu_imp_[0-9]*".
  166711. */
  166712. static void rbuEditErrmsg(sqlite3rbu *p){
  166713. if( p->rc==SQLITE_CONSTRAINT && p->zErrmsg ){
  166714. unsigned int i;
  166715. size_t nErrmsg = strlen(p->zErrmsg);
  166716. for(i=0; i<(nErrmsg-8); i++){
  166717. if( memcmp(&p->zErrmsg[i], "rbu_imp_", 8)==0 ){
  166718. int nDel = 8;
  166719. while( p->zErrmsg[i+nDel]>='0' && p->zErrmsg[i+nDel]<='9' ) nDel++;
  166720. memmove(&p->zErrmsg[i], &p->zErrmsg[i+nDel], nErrmsg + 1 - i - nDel);
  166721. nErrmsg -= nDel;
  166722. }
  166723. }
  166724. }
  166725. }
  166726. /*
  166727. ** Close the RBU handle.
  166728. */
  166729. SQLITE_API int sqlite3rbu_close(sqlite3rbu *p, char **pzErrmsg){
  166730. int rc;
  166731. if( p ){
  166732. /* Commit the transaction to the *-oal file. */
  166733. if( p->rc==SQLITE_OK && p->eStage==RBU_STAGE_OAL ){
  166734. p->rc = sqlite3_exec(p->dbMain, "COMMIT", 0, 0, &p->zErrmsg);
  166735. }
  166736. /* Sync the db file if currently doing an incremental checkpoint */
  166737. if( p->rc==SQLITE_OK && p->eStage==RBU_STAGE_CKPT ){
  166738. sqlite3_file *pDb = p->pTargetFd->pReal;
  166739. p->rc = pDb->pMethods->xSync(pDb, SQLITE_SYNC_NORMAL);
  166740. }
  166741. rbuSaveState(p, p->eStage);
  166742. if( p->rc==SQLITE_OK && p->eStage==RBU_STAGE_OAL ){
  166743. p->rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, &p->zErrmsg);
  166744. }
  166745. /* Close any open statement handles. */
  166746. rbuObjIterFinalize(&p->objiter);
  166747. /* If this is an RBU vacuum handle and the vacuum has either finished
  166748. ** successfully or encountered an error, delete the contents of the
  166749. ** state table. This causes the next call to sqlite3rbu_vacuum()
  166750. ** specifying the current target and state databases to start a new
  166751. ** vacuum from scratch. */
  166752. if( rbuIsVacuum(p) && p->rc!=SQLITE_OK && p->dbRbu ){
  166753. int rc2 = sqlite3_exec(p->dbRbu, "DELETE FROM stat.rbu_state", 0, 0, 0);
  166754. if( p->rc==SQLITE_DONE && rc2!=SQLITE_OK ) p->rc = rc2;
  166755. }
  166756. /* Close the open database handle and VFS object. */
  166757. sqlite3_close(p->dbRbu);
  166758. sqlite3_close(p->dbMain);
  166759. assert( p->szTemp==0 );
  166760. rbuDeleteVfs(p);
  166761. sqlite3_free(p->aBuf);
  166762. sqlite3_free(p->aFrame);
  166763. rbuEditErrmsg(p);
  166764. rc = p->rc;
  166765. if( pzErrmsg ){
  166766. *pzErrmsg = p->zErrmsg;
  166767. }else{
  166768. sqlite3_free(p->zErrmsg);
  166769. }
  166770. sqlite3_free(p->zState);
  166771. sqlite3_free(p);
  166772. }else{
  166773. rc = SQLITE_NOMEM;
  166774. *pzErrmsg = 0;
  166775. }
  166776. return rc;
  166777. }
  166778. /*
  166779. ** Return the total number of key-value operations (inserts, deletes or
  166780. ** updates) that have been performed on the target database since the
  166781. ** current RBU update was started.
  166782. */
  166783. SQLITE_API sqlite3_int64 sqlite3rbu_progress(sqlite3rbu *pRbu){
  166784. return pRbu->nProgress;
  166785. }
  166786. /*
  166787. ** Return permyriadage progress indications for the two main stages of
  166788. ** an RBU update.
  166789. */
  166790. SQLITE_API void sqlite3rbu_bp_progress(sqlite3rbu *p, int *pnOne, int *pnTwo){
  166791. const int MAX_PROGRESS = 10000;
  166792. switch( p->eStage ){
  166793. case RBU_STAGE_OAL:
  166794. if( p->nPhaseOneStep>0 ){
  166795. *pnOne = (int)(MAX_PROGRESS * (i64)p->nProgress/(i64)p->nPhaseOneStep);
  166796. }else{
  166797. *pnOne = -1;
  166798. }
  166799. *pnTwo = 0;
  166800. break;
  166801. case RBU_STAGE_MOVE:
  166802. *pnOne = MAX_PROGRESS;
  166803. *pnTwo = 0;
  166804. break;
  166805. case RBU_STAGE_CKPT:
  166806. *pnOne = MAX_PROGRESS;
  166807. *pnTwo = (int)(MAX_PROGRESS * (i64)p->nStep / (i64)p->nFrame);
  166808. break;
  166809. case RBU_STAGE_DONE:
  166810. *pnOne = MAX_PROGRESS;
  166811. *pnTwo = MAX_PROGRESS;
  166812. break;
  166813. default:
  166814. assert( 0 );
  166815. }
  166816. }
  166817. /*
  166818. ** Return the current state of the RBU vacuum or update operation.
  166819. */
  166820. SQLITE_API int sqlite3rbu_state(sqlite3rbu *p){
  166821. int aRes[] = {
  166822. 0, SQLITE_RBU_STATE_OAL, SQLITE_RBU_STATE_MOVE,
  166823. 0, SQLITE_RBU_STATE_CHECKPOINT, SQLITE_RBU_STATE_DONE
  166824. };
  166825. assert( RBU_STAGE_OAL==1 );
  166826. assert( RBU_STAGE_MOVE==2 );
  166827. assert( RBU_STAGE_CKPT==4 );
  166828. assert( RBU_STAGE_DONE==5 );
  166829. assert( aRes[RBU_STAGE_OAL]==SQLITE_RBU_STATE_OAL );
  166830. assert( aRes[RBU_STAGE_MOVE]==SQLITE_RBU_STATE_MOVE );
  166831. assert( aRes[RBU_STAGE_CKPT]==SQLITE_RBU_STATE_CHECKPOINT );
  166832. assert( aRes[RBU_STAGE_DONE]==SQLITE_RBU_STATE_DONE );
  166833. if( p->rc!=SQLITE_OK && p->rc!=SQLITE_DONE ){
  166834. return SQLITE_RBU_STATE_ERROR;
  166835. }else{
  166836. assert( p->rc!=SQLITE_DONE || p->eStage==RBU_STAGE_DONE );
  166837. assert( p->eStage==RBU_STAGE_OAL
  166838. || p->eStage==RBU_STAGE_MOVE
  166839. || p->eStage==RBU_STAGE_CKPT
  166840. || p->eStage==RBU_STAGE_DONE
  166841. );
  166842. return aRes[p->eStage];
  166843. }
  166844. }
  166845. SQLITE_API int sqlite3rbu_savestate(sqlite3rbu *p){
  166846. int rc = p->rc;
  166847. if( rc==SQLITE_DONE ) return SQLITE_OK;
  166848. assert( p->eStage>=RBU_STAGE_OAL && p->eStage<=RBU_STAGE_DONE );
  166849. if( p->eStage==RBU_STAGE_OAL ){
  166850. assert( rc!=SQLITE_DONE );
  166851. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbMain, "COMMIT", 0, 0, 0);
  166852. }
  166853. /* Sync the db file */
  166854. if( rc==SQLITE_OK && p->eStage==RBU_STAGE_CKPT ){
  166855. sqlite3_file *pDb = p->pTargetFd->pReal;
  166856. rc = pDb->pMethods->xSync(pDb, SQLITE_SYNC_NORMAL);
  166857. }
  166858. p->rc = rc;
  166859. rbuSaveState(p, p->eStage);
  166860. rc = p->rc;
  166861. if( p->eStage==RBU_STAGE_OAL ){
  166862. assert( rc!=SQLITE_DONE );
  166863. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbRbu, "COMMIT", 0, 0, 0);
  166864. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbRbu, "BEGIN IMMEDIATE", 0, 0, 0);
  166865. if( rc==SQLITE_OK ) rc = sqlite3_exec(p->dbMain, "BEGIN IMMEDIATE", 0, 0,0);
  166866. }
  166867. p->rc = rc;
  166868. return rc;
  166869. }
  166870. /**************************************************************************
  166871. ** Beginning of RBU VFS shim methods. The VFS shim modifies the behaviour
  166872. ** of a standard VFS in the following ways:
  166873. **
  166874. ** 1. Whenever the first page of a main database file is read or
  166875. ** written, the value of the change-counter cookie is stored in
  166876. ** rbu_file.iCookie. Similarly, the value of the "write-version"
  166877. ** database header field is stored in rbu_file.iWriteVer. This ensures
  166878. ** that the values are always trustworthy within an open transaction.
  166879. **
  166880. ** 2. Whenever an SQLITE_OPEN_WAL file is opened, the (rbu_file.pWalFd)
  166881. ** member variable of the associated database file descriptor is set
  166882. ** to point to the new file. A mutex protected linked list of all main
  166883. ** db fds opened using a particular RBU VFS is maintained at
  166884. ** rbu_vfs.pMain to facilitate this.
  166885. **
  166886. ** 3. Using a new file-control "SQLITE_FCNTL_RBU", a main db rbu_file
  166887. ** object can be marked as the target database of an RBU update. This
  166888. ** turns on the following extra special behaviour:
  166889. **
  166890. ** 3a. If xAccess() is called to check if there exists a *-wal file
  166891. ** associated with an RBU target database currently in RBU_STAGE_OAL
  166892. ** stage (preparing the *-oal file), the following special handling
  166893. ** applies:
  166894. **
  166895. ** * if the *-wal file does exist, return SQLITE_CANTOPEN. An RBU
  166896. ** target database may not be in wal mode already.
  166897. **
  166898. ** * if the *-wal file does not exist, set the output parameter to
  166899. ** non-zero (to tell SQLite that it does exist) anyway.
  166900. **
  166901. ** Then, when xOpen() is called to open the *-wal file associated with
  166902. ** the RBU target in RBU_STAGE_OAL stage, instead of opening the *-wal
  166903. ** file, the rbu vfs opens the corresponding *-oal file instead.
  166904. **
  166905. ** 3b. The *-shm pages returned by xShmMap() for a target db file in
  166906. ** RBU_STAGE_OAL mode are actually stored in heap memory. This is to
  166907. ** avoid creating a *-shm file on disk. Additionally, xShmLock() calls
  166908. ** are no-ops on target database files in RBU_STAGE_OAL mode. This is
  166909. ** because assert() statements in some VFS implementations fail if
  166910. ** xShmLock() is called before xShmMap().
  166911. **
  166912. ** 3c. If an EXCLUSIVE lock is attempted on a target database file in any
  166913. ** mode except RBU_STAGE_DONE (all work completed and checkpointed), it
  166914. ** fails with an SQLITE_BUSY error. This is to stop RBU connections
  166915. ** from automatically checkpointing a *-wal (or *-oal) file from within
  166916. ** sqlite3_close().
  166917. **
  166918. ** 3d. In RBU_STAGE_CAPTURE mode, all xRead() calls on the wal file, and
  166919. ** all xWrite() calls on the target database file perform no IO.
  166920. ** Instead the frame and page numbers that would be read and written
  166921. ** are recorded. Additionally, successful attempts to obtain exclusive
  166922. ** xShmLock() WRITER, CHECKPOINTER and READ0 locks on the target
  166923. ** database file are recorded. xShmLock() calls to unlock the same
  166924. ** locks are no-ops (so that once obtained, these locks are never
  166925. ** relinquished). Finally, calls to xSync() on the target database
  166926. ** file fail with SQLITE_INTERNAL errors.
  166927. */
  166928. static void rbuUnlockShm(rbu_file *p){
  166929. assert( p->openFlags & SQLITE_OPEN_MAIN_DB );
  166930. if( p->pRbu ){
  166931. int (*xShmLock)(sqlite3_file*,int,int,int) = p->pReal->pMethods->xShmLock;
  166932. int i;
  166933. for(i=0; i<SQLITE_SHM_NLOCK;i++){
  166934. if( (1<<i) & p->pRbu->mLock ){
  166935. xShmLock(p->pReal, i, 1, SQLITE_SHM_UNLOCK|SQLITE_SHM_EXCLUSIVE);
  166936. }
  166937. }
  166938. p->pRbu->mLock = 0;
  166939. }
  166940. }
  166941. /*
  166942. */
  166943. static int rbuUpdateTempSize(rbu_file *pFd, sqlite3_int64 nNew){
  166944. sqlite3rbu *pRbu = pFd->pRbu;
  166945. i64 nDiff = nNew - pFd->sz;
  166946. pRbu->szTemp += nDiff;
  166947. pFd->sz = nNew;
  166948. assert( pRbu->szTemp>=0 );
  166949. if( pRbu->szTempLimit && pRbu->szTemp>pRbu->szTempLimit ) return SQLITE_FULL;
  166950. return SQLITE_OK;
  166951. }
  166952. /*
  166953. ** Close an rbu file.
  166954. */
  166955. static int rbuVfsClose(sqlite3_file *pFile){
  166956. rbu_file *p = (rbu_file*)pFile;
  166957. int rc;
  166958. int i;
  166959. /* Free the contents of the apShm[] array. And the array itself. */
  166960. for(i=0; i<p->nShm; i++){
  166961. sqlite3_free(p->apShm[i]);
  166962. }
  166963. sqlite3_free(p->apShm);
  166964. p->apShm = 0;
  166965. sqlite3_free(p->zDel);
  166966. if( p->openFlags & SQLITE_OPEN_MAIN_DB ){
  166967. rbu_file **pp;
  166968. sqlite3_mutex_enter(p->pRbuVfs->mutex);
  166969. for(pp=&p->pRbuVfs->pMain; *pp!=p; pp=&((*pp)->pMainNext));
  166970. *pp = p->pMainNext;
  166971. sqlite3_mutex_leave(p->pRbuVfs->mutex);
  166972. rbuUnlockShm(p);
  166973. p->pReal->pMethods->xShmUnmap(p->pReal, 0);
  166974. }
  166975. else if( (p->openFlags & SQLITE_OPEN_DELETEONCLOSE) && p->pRbu ){
  166976. rbuUpdateTempSize(p, 0);
  166977. }
  166978. /* Close the underlying file handle */
  166979. rc = p->pReal->pMethods->xClose(p->pReal);
  166980. return rc;
  166981. }
  166982. /*
  166983. ** Read and return an unsigned 32-bit big-endian integer from the buffer
  166984. ** passed as the only argument.
  166985. */
  166986. static u32 rbuGetU32(u8 *aBuf){
  166987. return ((u32)aBuf[0] << 24)
  166988. + ((u32)aBuf[1] << 16)
  166989. + ((u32)aBuf[2] << 8)
  166990. + ((u32)aBuf[3]);
  166991. }
  166992. /*
  166993. ** Write an unsigned 32-bit value in big-endian format to the supplied
  166994. ** buffer.
  166995. */
  166996. static void rbuPutU32(u8 *aBuf, u32 iVal){
  166997. aBuf[0] = (iVal >> 24) & 0xFF;
  166998. aBuf[1] = (iVal >> 16) & 0xFF;
  166999. aBuf[2] = (iVal >> 8) & 0xFF;
  167000. aBuf[3] = (iVal >> 0) & 0xFF;
  167001. }
  167002. static void rbuPutU16(u8 *aBuf, u16 iVal){
  167003. aBuf[0] = (iVal >> 8) & 0xFF;
  167004. aBuf[1] = (iVal >> 0) & 0xFF;
  167005. }
  167006. /*
  167007. ** Read data from an rbuVfs-file.
  167008. */
  167009. static int rbuVfsRead(
  167010. sqlite3_file *pFile,
  167011. void *zBuf,
  167012. int iAmt,
  167013. sqlite_int64 iOfst
  167014. ){
  167015. rbu_file *p = (rbu_file*)pFile;
  167016. sqlite3rbu *pRbu = p->pRbu;
  167017. int rc;
  167018. if( pRbu && pRbu->eStage==RBU_STAGE_CAPTURE ){
  167019. assert( p->openFlags & SQLITE_OPEN_WAL );
  167020. rc = rbuCaptureWalRead(p->pRbu, iOfst, iAmt);
  167021. }else{
  167022. if( pRbu && pRbu->eStage==RBU_STAGE_OAL
  167023. && (p->openFlags & SQLITE_OPEN_WAL)
  167024. && iOfst>=pRbu->iOalSz
  167025. ){
  167026. rc = SQLITE_OK;
  167027. memset(zBuf, 0, iAmt);
  167028. }else{
  167029. rc = p->pReal->pMethods->xRead(p->pReal, zBuf, iAmt, iOfst);
  167030. #if 1
  167031. /* If this is being called to read the first page of the target
  167032. ** database as part of an rbu vacuum operation, synthesize the
  167033. ** contents of the first page if it does not yet exist. Otherwise,
  167034. ** SQLite will not check for a *-wal file. */
  167035. if( pRbu && rbuIsVacuum(pRbu)
  167036. && rc==SQLITE_IOERR_SHORT_READ && iOfst==0
  167037. && (p->openFlags & SQLITE_OPEN_MAIN_DB)
  167038. && pRbu->rc==SQLITE_OK
  167039. ){
  167040. sqlite3_file *pFd = (sqlite3_file*)pRbu->pRbuFd;
  167041. rc = pFd->pMethods->xRead(pFd, zBuf, iAmt, iOfst);
  167042. if( rc==SQLITE_OK ){
  167043. u8 *aBuf = (u8*)zBuf;
  167044. u32 iRoot = rbuGetU32(&aBuf[52]) ? 1 : 0;
  167045. rbuPutU32(&aBuf[52], iRoot); /* largest root page number */
  167046. rbuPutU32(&aBuf[36], 0); /* number of free pages */
  167047. rbuPutU32(&aBuf[32], 0); /* first page on free list trunk */
  167048. rbuPutU32(&aBuf[28], 1); /* size of db file in pages */
  167049. rbuPutU32(&aBuf[24], pRbu->pRbuFd->iCookie+1); /* Change counter */
  167050. if( iAmt>100 ){
  167051. memset(&aBuf[100], 0, iAmt-100);
  167052. rbuPutU16(&aBuf[105], iAmt & 0xFFFF);
  167053. aBuf[100] = 0x0D;
  167054. }
  167055. }
  167056. }
  167057. #endif
  167058. }
  167059. if( rc==SQLITE_OK && iOfst==0 && (p->openFlags & SQLITE_OPEN_MAIN_DB) ){
  167060. /* These look like magic numbers. But they are stable, as they are part
  167061. ** of the definition of the SQLite file format, which may not change. */
  167062. u8 *pBuf = (u8*)zBuf;
  167063. p->iCookie = rbuGetU32(&pBuf[24]);
  167064. p->iWriteVer = pBuf[19];
  167065. }
  167066. }
  167067. return rc;
  167068. }
  167069. /*
  167070. ** Write data to an rbuVfs-file.
  167071. */
  167072. static int rbuVfsWrite(
  167073. sqlite3_file *pFile,
  167074. const void *zBuf,
  167075. int iAmt,
  167076. sqlite_int64 iOfst
  167077. ){
  167078. rbu_file *p = (rbu_file*)pFile;
  167079. sqlite3rbu *pRbu = p->pRbu;
  167080. int rc;
  167081. if( pRbu && pRbu->eStage==RBU_STAGE_CAPTURE ){
  167082. assert( p->openFlags & SQLITE_OPEN_MAIN_DB );
  167083. rc = rbuCaptureDbWrite(p->pRbu, iOfst);
  167084. }else{
  167085. if( pRbu ){
  167086. if( pRbu->eStage==RBU_STAGE_OAL
  167087. && (p->openFlags & SQLITE_OPEN_WAL)
  167088. && iOfst>=pRbu->iOalSz
  167089. ){
  167090. pRbu->iOalSz = iAmt + iOfst;
  167091. }else if( p->openFlags & SQLITE_OPEN_DELETEONCLOSE ){
  167092. i64 szNew = iAmt+iOfst;
  167093. if( szNew>p->sz ){
  167094. rc = rbuUpdateTempSize(p, szNew);
  167095. if( rc!=SQLITE_OK ) return rc;
  167096. }
  167097. }
  167098. }
  167099. rc = p->pReal->pMethods->xWrite(p->pReal, zBuf, iAmt, iOfst);
  167100. if( rc==SQLITE_OK && iOfst==0 && (p->openFlags & SQLITE_OPEN_MAIN_DB) ){
  167101. /* These look like magic numbers. But they are stable, as they are part
  167102. ** of the definition of the SQLite file format, which may not change. */
  167103. u8 *pBuf = (u8*)zBuf;
  167104. p->iCookie = rbuGetU32(&pBuf[24]);
  167105. p->iWriteVer = pBuf[19];
  167106. }
  167107. }
  167108. return rc;
  167109. }
  167110. /*
  167111. ** Truncate an rbuVfs-file.
  167112. */
  167113. static int rbuVfsTruncate(sqlite3_file *pFile, sqlite_int64 size){
  167114. rbu_file *p = (rbu_file*)pFile;
  167115. if( (p->openFlags & SQLITE_OPEN_DELETEONCLOSE) && p->pRbu ){
  167116. int rc = rbuUpdateTempSize(p, size);
  167117. if( rc!=SQLITE_OK ) return rc;
  167118. }
  167119. return p->pReal->pMethods->xTruncate(p->pReal, size);
  167120. }
  167121. /*
  167122. ** Sync an rbuVfs-file.
  167123. */
  167124. static int rbuVfsSync(sqlite3_file *pFile, int flags){
  167125. rbu_file *p = (rbu_file *)pFile;
  167126. if( p->pRbu && p->pRbu->eStage==RBU_STAGE_CAPTURE ){
  167127. if( p->openFlags & SQLITE_OPEN_MAIN_DB ){
  167128. return SQLITE_INTERNAL;
  167129. }
  167130. return SQLITE_OK;
  167131. }
  167132. return p->pReal->pMethods->xSync(p->pReal, flags);
  167133. }
  167134. /*
  167135. ** Return the current file-size of an rbuVfs-file.
  167136. */
  167137. static int rbuVfsFileSize(sqlite3_file *pFile, sqlite_int64 *pSize){
  167138. rbu_file *p = (rbu_file *)pFile;
  167139. int rc;
  167140. rc = p->pReal->pMethods->xFileSize(p->pReal, pSize);
  167141. /* If this is an RBU vacuum operation and this is the target database,
  167142. ** pretend that it has at least one page. Otherwise, SQLite will not
  167143. ** check for the existance of a *-wal file. rbuVfsRead() contains
  167144. ** similar logic. */
  167145. if( rc==SQLITE_OK && *pSize==0
  167146. && p->pRbu && rbuIsVacuum(p->pRbu)
  167147. && (p->openFlags & SQLITE_OPEN_MAIN_DB)
  167148. ){
  167149. *pSize = 1024;
  167150. }
  167151. return rc;
  167152. }
  167153. /*
  167154. ** Lock an rbuVfs-file.
  167155. */
  167156. static int rbuVfsLock(sqlite3_file *pFile, int eLock){
  167157. rbu_file *p = (rbu_file*)pFile;
  167158. sqlite3rbu *pRbu = p->pRbu;
  167159. int rc = SQLITE_OK;
  167160. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  167161. if( eLock==SQLITE_LOCK_EXCLUSIVE
  167162. && (p->bNolock || (pRbu && pRbu->eStage!=RBU_STAGE_DONE))
  167163. ){
  167164. /* Do not allow EXCLUSIVE locks. Preventing SQLite from taking this
  167165. ** prevents it from checkpointing the database from sqlite3_close(). */
  167166. rc = SQLITE_BUSY;
  167167. }else{
  167168. rc = p->pReal->pMethods->xLock(p->pReal, eLock);
  167169. }
  167170. return rc;
  167171. }
  167172. /*
  167173. ** Unlock an rbuVfs-file.
  167174. */
  167175. static int rbuVfsUnlock(sqlite3_file *pFile, int eLock){
  167176. rbu_file *p = (rbu_file *)pFile;
  167177. return p->pReal->pMethods->xUnlock(p->pReal, eLock);
  167178. }
  167179. /*
  167180. ** Check if another file-handle holds a RESERVED lock on an rbuVfs-file.
  167181. */
  167182. static int rbuVfsCheckReservedLock(sqlite3_file *pFile, int *pResOut){
  167183. rbu_file *p = (rbu_file *)pFile;
  167184. return p->pReal->pMethods->xCheckReservedLock(p->pReal, pResOut);
  167185. }
  167186. /*
  167187. ** File control method. For custom operations on an rbuVfs-file.
  167188. */
  167189. static int rbuVfsFileControl(sqlite3_file *pFile, int op, void *pArg){
  167190. rbu_file *p = (rbu_file *)pFile;
  167191. int (*xControl)(sqlite3_file*,int,void*) = p->pReal->pMethods->xFileControl;
  167192. int rc;
  167193. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB)
  167194. || p->openFlags & (SQLITE_OPEN_TRANSIENT_DB|SQLITE_OPEN_TEMP_JOURNAL)
  167195. );
  167196. if( op==SQLITE_FCNTL_RBU ){
  167197. sqlite3rbu *pRbu = (sqlite3rbu*)pArg;
  167198. /* First try to find another RBU vfs lower down in the vfs stack. If
  167199. ** one is found, this vfs will operate in pass-through mode. The lower
  167200. ** level vfs will do the special RBU handling. */
  167201. rc = xControl(p->pReal, op, pArg);
  167202. if( rc==SQLITE_NOTFOUND ){
  167203. /* Now search for a zipvfs instance lower down in the VFS stack. If
  167204. ** one is found, this is an error. */
  167205. void *dummy = 0;
  167206. rc = xControl(p->pReal, SQLITE_FCNTL_ZIPVFS, &dummy);
  167207. if( rc==SQLITE_OK ){
  167208. rc = SQLITE_ERROR;
  167209. pRbu->zErrmsg = sqlite3_mprintf("rbu/zipvfs setup error");
  167210. }else if( rc==SQLITE_NOTFOUND ){
  167211. pRbu->pTargetFd = p;
  167212. p->pRbu = pRbu;
  167213. if( p->pWalFd ) p->pWalFd->pRbu = pRbu;
  167214. rc = SQLITE_OK;
  167215. }
  167216. }
  167217. return rc;
  167218. }
  167219. else if( op==SQLITE_FCNTL_RBUCNT ){
  167220. sqlite3rbu *pRbu = (sqlite3rbu*)pArg;
  167221. pRbu->nRbu++;
  167222. pRbu->pRbuFd = p;
  167223. p->bNolock = 1;
  167224. }
  167225. rc = xControl(p->pReal, op, pArg);
  167226. if( rc==SQLITE_OK && op==SQLITE_FCNTL_VFSNAME ){
  167227. rbu_vfs *pRbuVfs = p->pRbuVfs;
  167228. char *zIn = *(char**)pArg;
  167229. char *zOut = sqlite3_mprintf("rbu(%s)/%z", pRbuVfs->base.zName, zIn);
  167230. *(char**)pArg = zOut;
  167231. if( zOut==0 ) rc = SQLITE_NOMEM;
  167232. }
  167233. return rc;
  167234. }
  167235. /*
  167236. ** Return the sector-size in bytes for an rbuVfs-file.
  167237. */
  167238. static int rbuVfsSectorSize(sqlite3_file *pFile){
  167239. rbu_file *p = (rbu_file *)pFile;
  167240. return p->pReal->pMethods->xSectorSize(p->pReal);
  167241. }
  167242. /*
  167243. ** Return the device characteristic flags supported by an rbuVfs-file.
  167244. */
  167245. static int rbuVfsDeviceCharacteristics(sqlite3_file *pFile){
  167246. rbu_file *p = (rbu_file *)pFile;
  167247. return p->pReal->pMethods->xDeviceCharacteristics(p->pReal);
  167248. }
  167249. /*
  167250. ** Take or release a shared-memory lock.
  167251. */
  167252. static int rbuVfsShmLock(sqlite3_file *pFile, int ofst, int n, int flags){
  167253. rbu_file *p = (rbu_file*)pFile;
  167254. sqlite3rbu *pRbu = p->pRbu;
  167255. int rc = SQLITE_OK;
  167256. #ifdef SQLITE_AMALGAMATION
  167257. assert( WAL_CKPT_LOCK==1 );
  167258. #endif
  167259. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  167260. if( pRbu && (pRbu->eStage==RBU_STAGE_OAL || pRbu->eStage==RBU_STAGE_MOVE) ){
  167261. /* Magic number 1 is the WAL_CKPT_LOCK lock. Preventing SQLite from
  167262. ** taking this lock also prevents any checkpoints from occurring.
  167263. ** todo: really, it's not clear why this might occur, as
  167264. ** wal_autocheckpoint ought to be turned off. */
  167265. if( ofst==WAL_LOCK_CKPT && n==1 ) rc = SQLITE_BUSY;
  167266. }else{
  167267. int bCapture = 0;
  167268. if( n==1 && (flags & SQLITE_SHM_EXCLUSIVE)
  167269. && pRbu && pRbu->eStage==RBU_STAGE_CAPTURE
  167270. && (ofst==WAL_LOCK_WRITE || ofst==WAL_LOCK_CKPT || ofst==WAL_LOCK_READ0)
  167271. ){
  167272. bCapture = 1;
  167273. }
  167274. if( bCapture==0 || 0==(flags & SQLITE_SHM_UNLOCK) ){
  167275. rc = p->pReal->pMethods->xShmLock(p->pReal, ofst, n, flags);
  167276. if( bCapture && rc==SQLITE_OK ){
  167277. pRbu->mLock |= (1 << ofst);
  167278. }
  167279. }
  167280. }
  167281. return rc;
  167282. }
  167283. /*
  167284. ** Obtain a pointer to a mapping of a single 32KiB page of the *-shm file.
  167285. */
  167286. static int rbuVfsShmMap(
  167287. sqlite3_file *pFile,
  167288. int iRegion,
  167289. int szRegion,
  167290. int isWrite,
  167291. void volatile **pp
  167292. ){
  167293. rbu_file *p = (rbu_file*)pFile;
  167294. int rc = SQLITE_OK;
  167295. int eStage = (p->pRbu ? p->pRbu->eStage : 0);
  167296. /* If not in RBU_STAGE_OAL, allow this call to pass through. Or, if this
  167297. ** rbu is in the RBU_STAGE_OAL state, use heap memory for *-shm space
  167298. ** instead of a file on disk. */
  167299. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  167300. if( eStage==RBU_STAGE_OAL || eStage==RBU_STAGE_MOVE ){
  167301. if( iRegion<=p->nShm ){
  167302. int nByte = (iRegion+1) * sizeof(char*);
  167303. char **apNew = (char**)sqlite3_realloc64(p->apShm, nByte);
  167304. if( apNew==0 ){
  167305. rc = SQLITE_NOMEM;
  167306. }else{
  167307. memset(&apNew[p->nShm], 0, sizeof(char*) * (1 + iRegion - p->nShm));
  167308. p->apShm = apNew;
  167309. p->nShm = iRegion+1;
  167310. }
  167311. }
  167312. if( rc==SQLITE_OK && p->apShm[iRegion]==0 ){
  167313. char *pNew = (char*)sqlite3_malloc64(szRegion);
  167314. if( pNew==0 ){
  167315. rc = SQLITE_NOMEM;
  167316. }else{
  167317. memset(pNew, 0, szRegion);
  167318. p->apShm[iRegion] = pNew;
  167319. }
  167320. }
  167321. if( rc==SQLITE_OK ){
  167322. *pp = p->apShm[iRegion];
  167323. }else{
  167324. *pp = 0;
  167325. }
  167326. }else{
  167327. assert( p->apShm==0 );
  167328. rc = p->pReal->pMethods->xShmMap(p->pReal, iRegion, szRegion, isWrite, pp);
  167329. }
  167330. return rc;
  167331. }
  167332. /*
  167333. ** Memory barrier.
  167334. */
  167335. static void rbuVfsShmBarrier(sqlite3_file *pFile){
  167336. rbu_file *p = (rbu_file *)pFile;
  167337. p->pReal->pMethods->xShmBarrier(p->pReal);
  167338. }
  167339. /*
  167340. ** The xShmUnmap method.
  167341. */
  167342. static int rbuVfsShmUnmap(sqlite3_file *pFile, int delFlag){
  167343. rbu_file *p = (rbu_file*)pFile;
  167344. int rc = SQLITE_OK;
  167345. int eStage = (p->pRbu ? p->pRbu->eStage : 0);
  167346. assert( p->openFlags & (SQLITE_OPEN_MAIN_DB|SQLITE_OPEN_TEMP_DB) );
  167347. if( eStage==RBU_STAGE_OAL || eStage==RBU_STAGE_MOVE ){
  167348. /* no-op */
  167349. }else{
  167350. /* Release the checkpointer and writer locks */
  167351. rbuUnlockShm(p);
  167352. rc = p->pReal->pMethods->xShmUnmap(p->pReal, delFlag);
  167353. }
  167354. return rc;
  167355. }
  167356. /*
  167357. ** Given that zWal points to a buffer containing a wal file name passed to
  167358. ** either the xOpen() or xAccess() VFS method, return a pointer to the
  167359. ** file-handle opened by the same database connection on the corresponding
  167360. ** database file.
  167361. */
  167362. static rbu_file *rbuFindMaindb(rbu_vfs *pRbuVfs, const char *zWal){
  167363. rbu_file *pDb;
  167364. sqlite3_mutex_enter(pRbuVfs->mutex);
  167365. for(pDb=pRbuVfs->pMain; pDb && pDb->zWal!=zWal; pDb=pDb->pMainNext){}
  167366. sqlite3_mutex_leave(pRbuVfs->mutex);
  167367. return pDb;
  167368. }
  167369. /*
  167370. ** A main database named zName has just been opened. The following
  167371. ** function returns a pointer to a buffer owned by SQLite that contains
  167372. ** the name of the *-wal file this db connection will use. SQLite
  167373. ** happens to pass a pointer to this buffer when using xAccess()
  167374. ** or xOpen() to operate on the *-wal file.
  167375. */
  167376. static const char *rbuMainToWal(const char *zName, int flags){
  167377. int n = (int)strlen(zName);
  167378. const char *z = &zName[n];
  167379. if( flags & SQLITE_OPEN_URI ){
  167380. int odd = 0;
  167381. while( 1 ){
  167382. if( z[0]==0 ){
  167383. odd = 1 - odd;
  167384. if( odd && z[1]==0 ) break;
  167385. }
  167386. z++;
  167387. }
  167388. z += 2;
  167389. }else{
  167390. while( *z==0 ) z++;
  167391. }
  167392. z += (n + 8 + 1);
  167393. return z;
  167394. }
  167395. /*
  167396. ** Open an rbu file handle.
  167397. */
  167398. static int rbuVfsOpen(
  167399. sqlite3_vfs *pVfs,
  167400. const char *zName,
  167401. sqlite3_file *pFile,
  167402. int flags,
  167403. int *pOutFlags
  167404. ){
  167405. static sqlite3_io_methods rbuvfs_io_methods = {
  167406. 2, /* iVersion */
  167407. rbuVfsClose, /* xClose */
  167408. rbuVfsRead, /* xRead */
  167409. rbuVfsWrite, /* xWrite */
  167410. rbuVfsTruncate, /* xTruncate */
  167411. rbuVfsSync, /* xSync */
  167412. rbuVfsFileSize, /* xFileSize */
  167413. rbuVfsLock, /* xLock */
  167414. rbuVfsUnlock, /* xUnlock */
  167415. rbuVfsCheckReservedLock, /* xCheckReservedLock */
  167416. rbuVfsFileControl, /* xFileControl */
  167417. rbuVfsSectorSize, /* xSectorSize */
  167418. rbuVfsDeviceCharacteristics, /* xDeviceCharacteristics */
  167419. rbuVfsShmMap, /* xShmMap */
  167420. rbuVfsShmLock, /* xShmLock */
  167421. rbuVfsShmBarrier, /* xShmBarrier */
  167422. rbuVfsShmUnmap, /* xShmUnmap */
  167423. 0, 0 /* xFetch, xUnfetch */
  167424. };
  167425. rbu_vfs *pRbuVfs = (rbu_vfs*)pVfs;
  167426. sqlite3_vfs *pRealVfs = pRbuVfs->pRealVfs;
  167427. rbu_file *pFd = (rbu_file *)pFile;
  167428. int rc = SQLITE_OK;
  167429. const char *zOpen = zName;
  167430. int oflags = flags;
  167431. memset(pFd, 0, sizeof(rbu_file));
  167432. pFd->pReal = (sqlite3_file*)&pFd[1];
  167433. pFd->pRbuVfs = pRbuVfs;
  167434. pFd->openFlags = flags;
  167435. if( zName ){
  167436. if( flags & SQLITE_OPEN_MAIN_DB ){
  167437. /* A main database has just been opened. The following block sets
  167438. ** (pFd->zWal) to point to a buffer owned by SQLite that contains
  167439. ** the name of the *-wal file this db connection will use. SQLite
  167440. ** happens to pass a pointer to this buffer when using xAccess()
  167441. ** or xOpen() to operate on the *-wal file. */
  167442. pFd->zWal = rbuMainToWal(zName, flags);
  167443. }
  167444. else if( flags & SQLITE_OPEN_WAL ){
  167445. rbu_file *pDb = rbuFindMaindb(pRbuVfs, zName);
  167446. if( pDb ){
  167447. if( pDb->pRbu && pDb->pRbu->eStage==RBU_STAGE_OAL ){
  167448. /* This call is to open a *-wal file. Intead, open the *-oal. This
  167449. ** code ensures that the string passed to xOpen() is terminated by a
  167450. ** pair of '\0' bytes in case the VFS attempts to extract a URI
  167451. ** parameter from it. */
  167452. const char *zBase = zName;
  167453. size_t nCopy;
  167454. char *zCopy;
  167455. if( rbuIsVacuum(pDb->pRbu) ){
  167456. zBase = sqlite3_db_filename(pDb->pRbu->dbRbu, "main");
  167457. zBase = rbuMainToWal(zBase, SQLITE_OPEN_URI);
  167458. }
  167459. nCopy = strlen(zBase);
  167460. zCopy = sqlite3_malloc64(nCopy+2);
  167461. if( zCopy ){
  167462. memcpy(zCopy, zBase, nCopy);
  167463. zCopy[nCopy-3] = 'o';
  167464. zCopy[nCopy] = '\0';
  167465. zCopy[nCopy+1] = '\0';
  167466. zOpen = (const char*)(pFd->zDel = zCopy);
  167467. }else{
  167468. rc = SQLITE_NOMEM;
  167469. }
  167470. pFd->pRbu = pDb->pRbu;
  167471. }
  167472. pDb->pWalFd = pFd;
  167473. }
  167474. }
  167475. }else{
  167476. pFd->pRbu = pRbuVfs->pRbu;
  167477. }
  167478. if( oflags & SQLITE_OPEN_MAIN_DB
  167479. && sqlite3_uri_boolean(zName, "rbu_memory", 0)
  167480. ){
  167481. assert( oflags & SQLITE_OPEN_MAIN_DB );
  167482. oflags = SQLITE_OPEN_TEMP_DB | SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE |
  167483. SQLITE_OPEN_EXCLUSIVE | SQLITE_OPEN_DELETEONCLOSE;
  167484. zOpen = 0;
  167485. }
  167486. if( rc==SQLITE_OK ){
  167487. rc = pRealVfs->xOpen(pRealVfs, zOpen, pFd->pReal, oflags, pOutFlags);
  167488. }
  167489. if( pFd->pReal->pMethods ){
  167490. /* The xOpen() operation has succeeded. Set the sqlite3_file.pMethods
  167491. ** pointer and, if the file is a main database file, link it into the
  167492. ** mutex protected linked list of all such files. */
  167493. pFile->pMethods = &rbuvfs_io_methods;
  167494. if( flags & SQLITE_OPEN_MAIN_DB ){
  167495. sqlite3_mutex_enter(pRbuVfs->mutex);
  167496. pFd->pMainNext = pRbuVfs->pMain;
  167497. pRbuVfs->pMain = pFd;
  167498. sqlite3_mutex_leave(pRbuVfs->mutex);
  167499. }
  167500. }else{
  167501. sqlite3_free(pFd->zDel);
  167502. }
  167503. return rc;
  167504. }
  167505. /*
  167506. ** Delete the file located at zPath.
  167507. */
  167508. static int rbuVfsDelete(sqlite3_vfs *pVfs, const char *zPath, int dirSync){
  167509. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167510. return pRealVfs->xDelete(pRealVfs, zPath, dirSync);
  167511. }
  167512. /*
  167513. ** Test for access permissions. Return true if the requested permission
  167514. ** is available, or false otherwise.
  167515. */
  167516. static int rbuVfsAccess(
  167517. sqlite3_vfs *pVfs,
  167518. const char *zPath,
  167519. int flags,
  167520. int *pResOut
  167521. ){
  167522. rbu_vfs *pRbuVfs = (rbu_vfs*)pVfs;
  167523. sqlite3_vfs *pRealVfs = pRbuVfs->pRealVfs;
  167524. int rc;
  167525. rc = pRealVfs->xAccess(pRealVfs, zPath, flags, pResOut);
  167526. /* If this call is to check if a *-wal file associated with an RBU target
  167527. ** database connection exists, and the RBU update is in RBU_STAGE_OAL,
  167528. ** the following special handling is activated:
  167529. **
  167530. ** a) if the *-wal file does exist, return SQLITE_CANTOPEN. This
  167531. ** ensures that the RBU extension never tries to update a database
  167532. ** in wal mode, even if the first page of the database file has
  167533. ** been damaged.
  167534. **
  167535. ** b) if the *-wal file does not exist, claim that it does anyway,
  167536. ** causing SQLite to call xOpen() to open it. This call will also
  167537. ** be intercepted (see the rbuVfsOpen() function) and the *-oal
  167538. ** file opened instead.
  167539. */
  167540. if( rc==SQLITE_OK && flags==SQLITE_ACCESS_EXISTS ){
  167541. rbu_file *pDb = rbuFindMaindb(pRbuVfs, zPath);
  167542. if( pDb && pDb->pRbu && pDb->pRbu->eStage==RBU_STAGE_OAL ){
  167543. if( *pResOut ){
  167544. rc = SQLITE_CANTOPEN;
  167545. }else{
  167546. sqlite3_int64 sz = 0;
  167547. rc = rbuVfsFileSize(&pDb->base, &sz);
  167548. *pResOut = (sz>0);
  167549. }
  167550. }
  167551. }
  167552. return rc;
  167553. }
  167554. /*
  167555. ** Populate buffer zOut with the full canonical pathname corresponding
  167556. ** to the pathname in zPath. zOut is guaranteed to point to a buffer
  167557. ** of at least (DEVSYM_MAX_PATHNAME+1) bytes.
  167558. */
  167559. static int rbuVfsFullPathname(
  167560. sqlite3_vfs *pVfs,
  167561. const char *zPath,
  167562. int nOut,
  167563. char *zOut
  167564. ){
  167565. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167566. return pRealVfs->xFullPathname(pRealVfs, zPath, nOut, zOut);
  167567. }
  167568. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  167569. /*
  167570. ** Open the dynamic library located at zPath and return a handle.
  167571. */
  167572. static void *rbuVfsDlOpen(sqlite3_vfs *pVfs, const char *zPath){
  167573. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167574. return pRealVfs->xDlOpen(pRealVfs, zPath);
  167575. }
  167576. /*
  167577. ** Populate the buffer zErrMsg (size nByte bytes) with a human readable
  167578. ** utf-8 string describing the most recent error encountered associated
  167579. ** with dynamic libraries.
  167580. */
  167581. static void rbuVfsDlError(sqlite3_vfs *pVfs, int nByte, char *zErrMsg){
  167582. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167583. pRealVfs->xDlError(pRealVfs, nByte, zErrMsg);
  167584. }
  167585. /*
  167586. ** Return a pointer to the symbol zSymbol in the dynamic library pHandle.
  167587. */
  167588. static void (*rbuVfsDlSym(
  167589. sqlite3_vfs *pVfs,
  167590. void *pArg,
  167591. const char *zSym
  167592. ))(void){
  167593. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167594. return pRealVfs->xDlSym(pRealVfs, pArg, zSym);
  167595. }
  167596. /*
  167597. ** Close the dynamic library handle pHandle.
  167598. */
  167599. static void rbuVfsDlClose(sqlite3_vfs *pVfs, void *pHandle){
  167600. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167601. pRealVfs->xDlClose(pRealVfs, pHandle);
  167602. }
  167603. #endif /* SQLITE_OMIT_LOAD_EXTENSION */
  167604. /*
  167605. ** Populate the buffer pointed to by zBufOut with nByte bytes of
  167606. ** random data.
  167607. */
  167608. static int rbuVfsRandomness(sqlite3_vfs *pVfs, int nByte, char *zBufOut){
  167609. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167610. return pRealVfs->xRandomness(pRealVfs, nByte, zBufOut);
  167611. }
  167612. /*
  167613. ** Sleep for nMicro microseconds. Return the number of microseconds
  167614. ** actually slept.
  167615. */
  167616. static int rbuVfsSleep(sqlite3_vfs *pVfs, int nMicro){
  167617. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167618. return pRealVfs->xSleep(pRealVfs, nMicro);
  167619. }
  167620. /*
  167621. ** Return the current time as a Julian Day number in *pTimeOut.
  167622. */
  167623. static int rbuVfsCurrentTime(sqlite3_vfs *pVfs, double *pTimeOut){
  167624. sqlite3_vfs *pRealVfs = ((rbu_vfs*)pVfs)->pRealVfs;
  167625. return pRealVfs->xCurrentTime(pRealVfs, pTimeOut);
  167626. }
  167627. /*
  167628. ** No-op.
  167629. */
  167630. static int rbuVfsGetLastError(sqlite3_vfs *pVfs, int a, char *b){
  167631. return 0;
  167632. }
  167633. /*
  167634. ** Deregister and destroy an RBU vfs created by an earlier call to
  167635. ** sqlite3rbu_create_vfs().
  167636. */
  167637. SQLITE_API void sqlite3rbu_destroy_vfs(const char *zName){
  167638. sqlite3_vfs *pVfs = sqlite3_vfs_find(zName);
  167639. if( pVfs && pVfs->xOpen==rbuVfsOpen ){
  167640. sqlite3_mutex_free(((rbu_vfs*)pVfs)->mutex);
  167641. sqlite3_vfs_unregister(pVfs);
  167642. sqlite3_free(pVfs);
  167643. }
  167644. }
  167645. /*
  167646. ** Create an RBU VFS named zName that accesses the underlying file-system
  167647. ** via existing VFS zParent. The new object is registered as a non-default
  167648. ** VFS with SQLite before returning.
  167649. */
  167650. SQLITE_API int sqlite3rbu_create_vfs(const char *zName, const char *zParent){
  167651. /* Template for VFS */
  167652. static sqlite3_vfs vfs_template = {
  167653. 1, /* iVersion */
  167654. 0, /* szOsFile */
  167655. 0, /* mxPathname */
  167656. 0, /* pNext */
  167657. 0, /* zName */
  167658. 0, /* pAppData */
  167659. rbuVfsOpen, /* xOpen */
  167660. rbuVfsDelete, /* xDelete */
  167661. rbuVfsAccess, /* xAccess */
  167662. rbuVfsFullPathname, /* xFullPathname */
  167663. #ifndef SQLITE_OMIT_LOAD_EXTENSION
  167664. rbuVfsDlOpen, /* xDlOpen */
  167665. rbuVfsDlError, /* xDlError */
  167666. rbuVfsDlSym, /* xDlSym */
  167667. rbuVfsDlClose, /* xDlClose */
  167668. #else
  167669. 0, 0, 0, 0,
  167670. #endif
  167671. rbuVfsRandomness, /* xRandomness */
  167672. rbuVfsSleep, /* xSleep */
  167673. rbuVfsCurrentTime, /* xCurrentTime */
  167674. rbuVfsGetLastError, /* xGetLastError */
  167675. 0, /* xCurrentTimeInt64 (version 2) */
  167676. 0, 0, 0 /* Unimplemented version 3 methods */
  167677. };
  167678. rbu_vfs *pNew = 0; /* Newly allocated VFS */
  167679. int rc = SQLITE_OK;
  167680. size_t nName;
  167681. size_t nByte;
  167682. nName = strlen(zName);
  167683. nByte = sizeof(rbu_vfs) + nName + 1;
  167684. pNew = (rbu_vfs*)sqlite3_malloc64(nByte);
  167685. if( pNew==0 ){
  167686. rc = SQLITE_NOMEM;
  167687. }else{
  167688. sqlite3_vfs *pParent; /* Parent VFS */
  167689. memset(pNew, 0, nByte);
  167690. pParent = sqlite3_vfs_find(zParent);
  167691. if( pParent==0 ){
  167692. rc = SQLITE_NOTFOUND;
  167693. }else{
  167694. char *zSpace;
  167695. memcpy(&pNew->base, &vfs_template, sizeof(sqlite3_vfs));
  167696. pNew->base.mxPathname = pParent->mxPathname;
  167697. pNew->base.szOsFile = sizeof(rbu_file) + pParent->szOsFile;
  167698. pNew->pRealVfs = pParent;
  167699. pNew->base.zName = (const char*)(zSpace = (char*)&pNew[1]);
  167700. memcpy(zSpace, zName, nName);
  167701. /* Allocate the mutex and register the new VFS (not as the default) */
  167702. pNew->mutex = sqlite3_mutex_alloc(SQLITE_MUTEX_RECURSIVE);
  167703. if( pNew->mutex==0 ){
  167704. rc = SQLITE_NOMEM;
  167705. }else{
  167706. rc = sqlite3_vfs_register(&pNew->base, 0);
  167707. }
  167708. }
  167709. if( rc!=SQLITE_OK ){
  167710. sqlite3_mutex_free(pNew->mutex);
  167711. sqlite3_free(pNew);
  167712. }
  167713. }
  167714. return rc;
  167715. }
  167716. /*
  167717. ** Configure the aggregate temp file size limit for this RBU handle.
  167718. */
  167719. SQLITE_API sqlite3_int64 sqlite3rbu_temp_size_limit(sqlite3rbu *pRbu, sqlite3_int64 n){
  167720. if( n>=0 ){
  167721. pRbu->szTempLimit = n;
  167722. }
  167723. return pRbu->szTempLimit;
  167724. }
  167725. SQLITE_API sqlite3_int64 sqlite3rbu_temp_size(sqlite3rbu *pRbu){
  167726. return pRbu->szTemp;
  167727. }
  167728. /**************************************************************************/
  167729. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_RBU) */
  167730. /************** End of sqlite3rbu.c ******************************************/
  167731. /************** Begin file dbstat.c ******************************************/
  167732. /*
  167733. ** 2010 July 12
  167734. **
  167735. ** The author disclaims copyright to this source code. In place of
  167736. ** a legal notice, here is a blessing:
  167737. **
  167738. ** May you do good and not evil.
  167739. ** May you find forgiveness for yourself and forgive others.
  167740. ** May you share freely, never taking more than you give.
  167741. **
  167742. ******************************************************************************
  167743. **
  167744. ** This file contains an implementation of the "dbstat" virtual table.
  167745. **
  167746. ** The dbstat virtual table is used to extract low-level formatting
  167747. ** information from an SQLite database in order to implement the
  167748. ** "sqlite3_analyzer" utility. See the ../tool/spaceanal.tcl script
  167749. ** for an example implementation.
  167750. **
  167751. ** Additional information is available on the "dbstat.html" page of the
  167752. ** official SQLite documentation.
  167753. */
  167754. /* #include "sqliteInt.h" ** Requires access to internal data structures ** */
  167755. #if (defined(SQLITE_ENABLE_DBSTAT_VTAB) || defined(SQLITE_TEST)) \
  167756. && !defined(SQLITE_OMIT_VIRTUALTABLE)
  167757. /*
  167758. ** Page paths:
  167759. **
  167760. ** The value of the 'path' column describes the path taken from the
  167761. ** root-node of the b-tree structure to each page. The value of the
  167762. ** root-node path is '/'.
  167763. **
  167764. ** The value of the path for the left-most child page of the root of
  167765. ** a b-tree is '/000/'. (Btrees store content ordered from left to right
  167766. ** so the pages to the left have smaller keys than the pages to the right.)
  167767. ** The next to left-most child of the root page is
  167768. ** '/001', and so on, each sibling page identified by a 3-digit hex
  167769. ** value. The children of the 451st left-most sibling have paths such
  167770. ** as '/1c2/000/, '/1c2/001/' etc.
  167771. **
  167772. ** Overflow pages are specified by appending a '+' character and a
  167773. ** six-digit hexadecimal value to the path to the cell they are linked
  167774. ** from. For example, the three overflow pages in a chain linked from
  167775. ** the left-most cell of the 450th child of the root page are identified
  167776. ** by the paths:
  167777. **
  167778. ** '/1c2/000+000000' // First page in overflow chain
  167779. ** '/1c2/000+000001' // Second page in overflow chain
  167780. ** '/1c2/000+000002' // Third page in overflow chain
  167781. **
  167782. ** If the paths are sorted using the BINARY collation sequence, then
  167783. ** the overflow pages associated with a cell will appear earlier in the
  167784. ** sort-order than its child page:
  167785. **
  167786. ** '/1c2/000/' // Left-most child of 451st child of root
  167787. */
  167788. #define VTAB_SCHEMA \
  167789. "CREATE TABLE xx( " \
  167790. " name TEXT, /* Name of table or index */" \
  167791. " path TEXT, /* Path to page from root */" \
  167792. " pageno INTEGER, /* Page number */" \
  167793. " pagetype TEXT, /* 'internal', 'leaf' or 'overflow' */" \
  167794. " ncell INTEGER, /* Cells on page (0 for overflow) */" \
  167795. " payload INTEGER, /* Bytes of payload on this page */" \
  167796. " unused INTEGER, /* Bytes of unused space on this page */" \
  167797. " mx_payload INTEGER, /* Largest payload size of all cells */" \
  167798. " pgoffset INTEGER, /* Offset of page in file */" \
  167799. " pgsize INTEGER, /* Size of the page */" \
  167800. " schema TEXT HIDDEN /* Database schema being analyzed */" \
  167801. ");"
  167802. typedef struct StatTable StatTable;
  167803. typedef struct StatCursor StatCursor;
  167804. typedef struct StatPage StatPage;
  167805. typedef struct StatCell StatCell;
  167806. struct StatCell {
  167807. int nLocal; /* Bytes of local payload */
  167808. u32 iChildPg; /* Child node (or 0 if this is a leaf) */
  167809. int nOvfl; /* Entries in aOvfl[] */
  167810. u32 *aOvfl; /* Array of overflow page numbers */
  167811. int nLastOvfl; /* Bytes of payload on final overflow page */
  167812. int iOvfl; /* Iterates through aOvfl[] */
  167813. };
  167814. struct StatPage {
  167815. u32 iPgno;
  167816. DbPage *pPg;
  167817. int iCell;
  167818. char *zPath; /* Path to this page */
  167819. /* Variables populated by statDecodePage(): */
  167820. u8 flags; /* Copy of flags byte */
  167821. int nCell; /* Number of cells on page */
  167822. int nUnused; /* Number of unused bytes on page */
  167823. StatCell *aCell; /* Array of parsed cells */
  167824. u32 iRightChildPg; /* Right-child page number (or 0) */
  167825. int nMxPayload; /* Largest payload of any cell on this page */
  167826. };
  167827. struct StatCursor {
  167828. sqlite3_vtab_cursor base;
  167829. sqlite3_stmt *pStmt; /* Iterates through set of root pages */
  167830. int isEof; /* After pStmt has returned SQLITE_DONE */
  167831. int iDb; /* Schema used for this query */
  167832. StatPage aPage[32];
  167833. int iPage; /* Current entry in aPage[] */
  167834. /* Values to return. */
  167835. char *zName; /* Value of 'name' column */
  167836. char *zPath; /* Value of 'path' column */
  167837. u32 iPageno; /* Value of 'pageno' column */
  167838. char *zPagetype; /* Value of 'pagetype' column */
  167839. int nCell; /* Value of 'ncell' column */
  167840. int nPayload; /* Value of 'payload' column */
  167841. int nUnused; /* Value of 'unused' column */
  167842. int nMxPayload; /* Value of 'mx_payload' column */
  167843. i64 iOffset; /* Value of 'pgOffset' column */
  167844. int szPage; /* Value of 'pgSize' column */
  167845. };
  167846. struct StatTable {
  167847. sqlite3_vtab base;
  167848. sqlite3 *db;
  167849. int iDb; /* Index of database to analyze */
  167850. };
  167851. #ifndef get2byte
  167852. # define get2byte(x) ((x)[0]<<8 | (x)[1])
  167853. #endif
  167854. /*
  167855. ** Connect to or create a statvfs virtual table.
  167856. */
  167857. static int statConnect(
  167858. sqlite3 *db,
  167859. void *pAux,
  167860. int argc, const char *const*argv,
  167861. sqlite3_vtab **ppVtab,
  167862. char **pzErr
  167863. ){
  167864. StatTable *pTab = 0;
  167865. int rc = SQLITE_OK;
  167866. int iDb;
  167867. if( argc>=4 ){
  167868. Token nm;
  167869. sqlite3TokenInit(&nm, (char*)argv[3]);
  167870. iDb = sqlite3FindDb(db, &nm);
  167871. if( iDb<0 ){
  167872. *pzErr = sqlite3_mprintf("no such database: %s", argv[3]);
  167873. return SQLITE_ERROR;
  167874. }
  167875. }else{
  167876. iDb = 0;
  167877. }
  167878. rc = sqlite3_declare_vtab(db, VTAB_SCHEMA);
  167879. if( rc==SQLITE_OK ){
  167880. pTab = (StatTable *)sqlite3_malloc64(sizeof(StatTable));
  167881. if( pTab==0 ) rc = SQLITE_NOMEM_BKPT;
  167882. }
  167883. assert( rc==SQLITE_OK || pTab==0 );
  167884. if( rc==SQLITE_OK ){
  167885. memset(pTab, 0, sizeof(StatTable));
  167886. pTab->db = db;
  167887. pTab->iDb = iDb;
  167888. }
  167889. *ppVtab = (sqlite3_vtab*)pTab;
  167890. return rc;
  167891. }
  167892. /*
  167893. ** Disconnect from or destroy a statvfs virtual table.
  167894. */
  167895. static int statDisconnect(sqlite3_vtab *pVtab){
  167896. sqlite3_free(pVtab);
  167897. return SQLITE_OK;
  167898. }
  167899. /*
  167900. ** There is no "best-index". This virtual table always does a linear
  167901. ** scan. However, a schema=? constraint should cause this table to
  167902. ** operate on a different database schema, so check for it.
  167903. **
  167904. ** idxNum is normally 0, but will be 1 if a schema=? constraint exists.
  167905. */
  167906. static int statBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
  167907. int i;
  167908. pIdxInfo->estimatedCost = 1.0e6; /* Initial cost estimate */
  167909. /* Look for a valid schema=? constraint. If found, change the idxNum to
  167910. ** 1 and request the value of that constraint be sent to xFilter. And
  167911. ** lower the cost estimate to encourage the constrained version to be
  167912. ** used.
  167913. */
  167914. for(i=0; i<pIdxInfo->nConstraint; i++){
  167915. if( pIdxInfo->aConstraint[i].usable==0 ) continue;
  167916. if( pIdxInfo->aConstraint[i].op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
  167917. if( pIdxInfo->aConstraint[i].iColumn!=10 ) continue;
  167918. pIdxInfo->idxNum = 1;
  167919. pIdxInfo->estimatedCost = 1.0;
  167920. pIdxInfo->aConstraintUsage[i].argvIndex = 1;
  167921. pIdxInfo->aConstraintUsage[i].omit = 1;
  167922. break;
  167923. }
  167924. /* Records are always returned in ascending order of (name, path).
  167925. ** If this will satisfy the client, set the orderByConsumed flag so that
  167926. ** SQLite does not do an external sort.
  167927. */
  167928. if( ( pIdxInfo->nOrderBy==1
  167929. && pIdxInfo->aOrderBy[0].iColumn==0
  167930. && pIdxInfo->aOrderBy[0].desc==0
  167931. ) ||
  167932. ( pIdxInfo->nOrderBy==2
  167933. && pIdxInfo->aOrderBy[0].iColumn==0
  167934. && pIdxInfo->aOrderBy[0].desc==0
  167935. && pIdxInfo->aOrderBy[1].iColumn==1
  167936. && pIdxInfo->aOrderBy[1].desc==0
  167937. )
  167938. ){
  167939. pIdxInfo->orderByConsumed = 1;
  167940. }
  167941. return SQLITE_OK;
  167942. }
  167943. /*
  167944. ** Open a new statvfs cursor.
  167945. */
  167946. static int statOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){
  167947. StatTable *pTab = (StatTable *)pVTab;
  167948. StatCursor *pCsr;
  167949. pCsr = (StatCursor *)sqlite3_malloc64(sizeof(StatCursor));
  167950. if( pCsr==0 ){
  167951. return SQLITE_NOMEM_BKPT;
  167952. }else{
  167953. memset(pCsr, 0, sizeof(StatCursor));
  167954. pCsr->base.pVtab = pVTab;
  167955. pCsr->iDb = pTab->iDb;
  167956. }
  167957. *ppCursor = (sqlite3_vtab_cursor *)pCsr;
  167958. return SQLITE_OK;
  167959. }
  167960. static void statClearPage(StatPage *p){
  167961. int i;
  167962. if( p->aCell ){
  167963. for(i=0; i<p->nCell; i++){
  167964. sqlite3_free(p->aCell[i].aOvfl);
  167965. }
  167966. sqlite3_free(p->aCell);
  167967. }
  167968. sqlite3PagerUnref(p->pPg);
  167969. sqlite3_free(p->zPath);
  167970. memset(p, 0, sizeof(StatPage));
  167971. }
  167972. static void statResetCsr(StatCursor *pCsr){
  167973. int i;
  167974. sqlite3_reset(pCsr->pStmt);
  167975. for(i=0; i<ArraySize(pCsr->aPage); i++){
  167976. statClearPage(&pCsr->aPage[i]);
  167977. }
  167978. pCsr->iPage = 0;
  167979. sqlite3_free(pCsr->zPath);
  167980. pCsr->zPath = 0;
  167981. pCsr->isEof = 0;
  167982. }
  167983. /*
  167984. ** Close a statvfs cursor.
  167985. */
  167986. static int statClose(sqlite3_vtab_cursor *pCursor){
  167987. StatCursor *pCsr = (StatCursor *)pCursor;
  167988. statResetCsr(pCsr);
  167989. sqlite3_finalize(pCsr->pStmt);
  167990. sqlite3_free(pCsr);
  167991. return SQLITE_OK;
  167992. }
  167993. static void getLocalPayload(
  167994. int nUsable, /* Usable bytes per page */
  167995. u8 flags, /* Page flags */
  167996. int nTotal, /* Total record (payload) size */
  167997. int *pnLocal /* OUT: Bytes stored locally */
  167998. ){
  167999. int nLocal;
  168000. int nMinLocal;
  168001. int nMaxLocal;
  168002. if( flags==0x0D ){ /* Table leaf node */
  168003. nMinLocal = (nUsable - 12) * 32 / 255 - 23;
  168004. nMaxLocal = nUsable - 35;
  168005. }else{ /* Index interior and leaf nodes */
  168006. nMinLocal = (nUsable - 12) * 32 / 255 - 23;
  168007. nMaxLocal = (nUsable - 12) * 64 / 255 - 23;
  168008. }
  168009. nLocal = nMinLocal + (nTotal - nMinLocal) % (nUsable - 4);
  168010. if( nLocal>nMaxLocal ) nLocal = nMinLocal;
  168011. *pnLocal = nLocal;
  168012. }
  168013. static int statDecodePage(Btree *pBt, StatPage *p){
  168014. int nUnused;
  168015. int iOff;
  168016. int nHdr;
  168017. int isLeaf;
  168018. int szPage;
  168019. u8 *aData = sqlite3PagerGetData(p->pPg);
  168020. u8 *aHdr = &aData[p->iPgno==1 ? 100 : 0];
  168021. p->flags = aHdr[0];
  168022. p->nCell = get2byte(&aHdr[3]);
  168023. p->nMxPayload = 0;
  168024. isLeaf = (p->flags==0x0A || p->flags==0x0D);
  168025. nHdr = 12 - isLeaf*4 + (p->iPgno==1)*100;
  168026. nUnused = get2byte(&aHdr[5]) - nHdr - 2*p->nCell;
  168027. nUnused += (int)aHdr[7];
  168028. iOff = get2byte(&aHdr[1]);
  168029. while( iOff ){
  168030. nUnused += get2byte(&aData[iOff+2]);
  168031. iOff = get2byte(&aData[iOff]);
  168032. }
  168033. p->nUnused = nUnused;
  168034. p->iRightChildPg = isLeaf ? 0 : sqlite3Get4byte(&aHdr[8]);
  168035. szPage = sqlite3BtreeGetPageSize(pBt);
  168036. if( p->nCell ){
  168037. int i; /* Used to iterate through cells */
  168038. int nUsable; /* Usable bytes per page */
  168039. sqlite3BtreeEnter(pBt);
  168040. nUsable = szPage - sqlite3BtreeGetReserveNoMutex(pBt);
  168041. sqlite3BtreeLeave(pBt);
  168042. p->aCell = sqlite3_malloc64((p->nCell+1) * sizeof(StatCell));
  168043. if( p->aCell==0 ) return SQLITE_NOMEM_BKPT;
  168044. memset(p->aCell, 0, (p->nCell+1) * sizeof(StatCell));
  168045. for(i=0; i<p->nCell; i++){
  168046. StatCell *pCell = &p->aCell[i];
  168047. iOff = get2byte(&aData[nHdr+i*2]);
  168048. if( !isLeaf ){
  168049. pCell->iChildPg = sqlite3Get4byte(&aData[iOff]);
  168050. iOff += 4;
  168051. }
  168052. if( p->flags==0x05 ){
  168053. /* A table interior node. nPayload==0. */
  168054. }else{
  168055. u32 nPayload; /* Bytes of payload total (local+overflow) */
  168056. int nLocal; /* Bytes of payload stored locally */
  168057. iOff += getVarint32(&aData[iOff], nPayload);
  168058. if( p->flags==0x0D ){
  168059. u64 dummy;
  168060. iOff += sqlite3GetVarint(&aData[iOff], &dummy);
  168061. }
  168062. if( nPayload>(u32)p->nMxPayload ) p->nMxPayload = nPayload;
  168063. getLocalPayload(nUsable, p->flags, nPayload, &nLocal);
  168064. pCell->nLocal = nLocal;
  168065. assert( nLocal>=0 );
  168066. assert( nPayload>=(u32)nLocal );
  168067. assert( nLocal<=(nUsable-35) );
  168068. if( nPayload>(u32)nLocal ){
  168069. int j;
  168070. int nOvfl = ((nPayload - nLocal) + nUsable-4 - 1) / (nUsable - 4);
  168071. pCell->nLastOvfl = (nPayload-nLocal) - (nOvfl-1) * (nUsable-4);
  168072. pCell->nOvfl = nOvfl;
  168073. pCell->aOvfl = sqlite3_malloc64(sizeof(u32)*nOvfl);
  168074. if( pCell->aOvfl==0 ) return SQLITE_NOMEM_BKPT;
  168075. pCell->aOvfl[0] = sqlite3Get4byte(&aData[iOff+nLocal]);
  168076. for(j=1; j<nOvfl; j++){
  168077. int rc;
  168078. u32 iPrev = pCell->aOvfl[j-1];
  168079. DbPage *pPg = 0;
  168080. rc = sqlite3PagerGet(sqlite3BtreePager(pBt), iPrev, &pPg, 0);
  168081. if( rc!=SQLITE_OK ){
  168082. assert( pPg==0 );
  168083. return rc;
  168084. }
  168085. pCell->aOvfl[j] = sqlite3Get4byte(sqlite3PagerGetData(pPg));
  168086. sqlite3PagerUnref(pPg);
  168087. }
  168088. }
  168089. }
  168090. }
  168091. }
  168092. return SQLITE_OK;
  168093. }
  168094. /*
  168095. ** Populate the pCsr->iOffset and pCsr->szPage member variables. Based on
  168096. ** the current value of pCsr->iPageno.
  168097. */
  168098. static void statSizeAndOffset(StatCursor *pCsr){
  168099. StatTable *pTab = (StatTable *)((sqlite3_vtab_cursor *)pCsr)->pVtab;
  168100. Btree *pBt = pTab->db->aDb[pTab->iDb].pBt;
  168101. Pager *pPager = sqlite3BtreePager(pBt);
  168102. sqlite3_file *fd;
  168103. sqlite3_int64 x[2];
  168104. /* The default page size and offset */
  168105. pCsr->szPage = sqlite3BtreeGetPageSize(pBt);
  168106. pCsr->iOffset = (i64)pCsr->szPage * (pCsr->iPageno - 1);
  168107. /* If connected to a ZIPVFS backend, override the page size and
  168108. ** offset with actual values obtained from ZIPVFS.
  168109. */
  168110. fd = sqlite3PagerFile(pPager);
  168111. x[0] = pCsr->iPageno;
  168112. if( sqlite3OsFileControl(fd, 230440, &x)==SQLITE_OK ){
  168113. pCsr->iOffset = x[0];
  168114. pCsr->szPage = (int)x[1];
  168115. }
  168116. }
  168117. /*
  168118. ** Move a statvfs cursor to the next entry in the file.
  168119. */
  168120. static int statNext(sqlite3_vtab_cursor *pCursor){
  168121. int rc;
  168122. int nPayload;
  168123. char *z;
  168124. StatCursor *pCsr = (StatCursor *)pCursor;
  168125. StatTable *pTab = (StatTable *)pCursor->pVtab;
  168126. Btree *pBt = pTab->db->aDb[pCsr->iDb].pBt;
  168127. Pager *pPager = sqlite3BtreePager(pBt);
  168128. sqlite3_free(pCsr->zPath);
  168129. pCsr->zPath = 0;
  168130. statNextRestart:
  168131. if( pCsr->aPage[0].pPg==0 ){
  168132. rc = sqlite3_step(pCsr->pStmt);
  168133. if( rc==SQLITE_ROW ){
  168134. int nPage;
  168135. u32 iRoot = (u32)sqlite3_column_int64(pCsr->pStmt, 1);
  168136. sqlite3PagerPagecount(pPager, &nPage);
  168137. if( nPage==0 ){
  168138. pCsr->isEof = 1;
  168139. return sqlite3_reset(pCsr->pStmt);
  168140. }
  168141. rc = sqlite3PagerGet(pPager, iRoot, &pCsr->aPage[0].pPg, 0);
  168142. pCsr->aPage[0].iPgno = iRoot;
  168143. pCsr->aPage[0].iCell = 0;
  168144. pCsr->aPage[0].zPath = z = sqlite3_mprintf("/");
  168145. pCsr->iPage = 0;
  168146. if( z==0 ) rc = SQLITE_NOMEM_BKPT;
  168147. }else{
  168148. pCsr->isEof = 1;
  168149. return sqlite3_reset(pCsr->pStmt);
  168150. }
  168151. }else{
  168152. /* Page p itself has already been visited. */
  168153. StatPage *p = &pCsr->aPage[pCsr->iPage];
  168154. while( p->iCell<p->nCell ){
  168155. StatCell *pCell = &p->aCell[p->iCell];
  168156. if( pCell->iOvfl<pCell->nOvfl ){
  168157. int nUsable;
  168158. sqlite3BtreeEnter(pBt);
  168159. nUsable = sqlite3BtreeGetPageSize(pBt) -
  168160. sqlite3BtreeGetReserveNoMutex(pBt);
  168161. sqlite3BtreeLeave(pBt);
  168162. pCsr->zName = (char *)sqlite3_column_text(pCsr->pStmt, 0);
  168163. pCsr->iPageno = pCell->aOvfl[pCell->iOvfl];
  168164. pCsr->zPagetype = "overflow";
  168165. pCsr->nCell = 0;
  168166. pCsr->nMxPayload = 0;
  168167. pCsr->zPath = z = sqlite3_mprintf(
  168168. "%s%.3x+%.6x", p->zPath, p->iCell, pCell->iOvfl
  168169. );
  168170. if( pCell->iOvfl<pCell->nOvfl-1 ){
  168171. pCsr->nUnused = 0;
  168172. pCsr->nPayload = nUsable - 4;
  168173. }else{
  168174. pCsr->nPayload = pCell->nLastOvfl;
  168175. pCsr->nUnused = nUsable - 4 - pCsr->nPayload;
  168176. }
  168177. pCell->iOvfl++;
  168178. statSizeAndOffset(pCsr);
  168179. return z==0 ? SQLITE_NOMEM_BKPT : SQLITE_OK;
  168180. }
  168181. if( p->iRightChildPg ) break;
  168182. p->iCell++;
  168183. }
  168184. if( !p->iRightChildPg || p->iCell>p->nCell ){
  168185. statClearPage(p);
  168186. if( pCsr->iPage==0 ) return statNext(pCursor);
  168187. pCsr->iPage--;
  168188. goto statNextRestart; /* Tail recursion */
  168189. }
  168190. pCsr->iPage++;
  168191. assert( p==&pCsr->aPage[pCsr->iPage-1] );
  168192. if( p->iCell==p->nCell ){
  168193. p[1].iPgno = p->iRightChildPg;
  168194. }else{
  168195. p[1].iPgno = p->aCell[p->iCell].iChildPg;
  168196. }
  168197. rc = sqlite3PagerGet(pPager, p[1].iPgno, &p[1].pPg, 0);
  168198. p[1].iCell = 0;
  168199. p[1].zPath = z = sqlite3_mprintf("%s%.3x/", p->zPath, p->iCell);
  168200. p->iCell++;
  168201. if( z==0 ) rc = SQLITE_NOMEM_BKPT;
  168202. }
  168203. /* Populate the StatCursor fields with the values to be returned
  168204. ** by the xColumn() and xRowid() methods.
  168205. */
  168206. if( rc==SQLITE_OK ){
  168207. int i;
  168208. StatPage *p = &pCsr->aPage[pCsr->iPage];
  168209. pCsr->zName = (char *)sqlite3_column_text(pCsr->pStmt, 0);
  168210. pCsr->iPageno = p->iPgno;
  168211. rc = statDecodePage(pBt, p);
  168212. if( rc==SQLITE_OK ){
  168213. statSizeAndOffset(pCsr);
  168214. switch( p->flags ){
  168215. case 0x05: /* table internal */
  168216. case 0x02: /* index internal */
  168217. pCsr->zPagetype = "internal";
  168218. break;
  168219. case 0x0D: /* table leaf */
  168220. case 0x0A: /* index leaf */
  168221. pCsr->zPagetype = "leaf";
  168222. break;
  168223. default:
  168224. pCsr->zPagetype = "corrupted";
  168225. break;
  168226. }
  168227. pCsr->nCell = p->nCell;
  168228. pCsr->nUnused = p->nUnused;
  168229. pCsr->nMxPayload = p->nMxPayload;
  168230. pCsr->zPath = z = sqlite3_mprintf("%s", p->zPath);
  168231. if( z==0 ) rc = SQLITE_NOMEM_BKPT;
  168232. nPayload = 0;
  168233. for(i=0; i<p->nCell; i++){
  168234. nPayload += p->aCell[i].nLocal;
  168235. }
  168236. pCsr->nPayload = nPayload;
  168237. }
  168238. }
  168239. return rc;
  168240. }
  168241. static int statEof(sqlite3_vtab_cursor *pCursor){
  168242. StatCursor *pCsr = (StatCursor *)pCursor;
  168243. return pCsr->isEof;
  168244. }
  168245. static int statFilter(
  168246. sqlite3_vtab_cursor *pCursor,
  168247. int idxNum, const char *idxStr,
  168248. int argc, sqlite3_value **argv
  168249. ){
  168250. StatCursor *pCsr = (StatCursor *)pCursor;
  168251. StatTable *pTab = (StatTable*)(pCursor->pVtab);
  168252. char *zSql;
  168253. int rc = SQLITE_OK;
  168254. char *zMaster;
  168255. if( idxNum==1 ){
  168256. const char *zDbase = (const char*)sqlite3_value_text(argv[0]);
  168257. pCsr->iDb = sqlite3FindDbName(pTab->db, zDbase);
  168258. if( pCsr->iDb<0 ){
  168259. sqlite3_free(pCursor->pVtab->zErrMsg);
  168260. pCursor->pVtab->zErrMsg = sqlite3_mprintf("no such schema: %s", zDbase);
  168261. return pCursor->pVtab->zErrMsg ? SQLITE_ERROR : SQLITE_NOMEM_BKPT;
  168262. }
  168263. }else{
  168264. pCsr->iDb = pTab->iDb;
  168265. }
  168266. statResetCsr(pCsr);
  168267. sqlite3_finalize(pCsr->pStmt);
  168268. pCsr->pStmt = 0;
  168269. zMaster = pCsr->iDb==1 ? "sqlite_temp_master" : "sqlite_master";
  168270. zSql = sqlite3_mprintf(
  168271. "SELECT 'sqlite_master' AS name, 1 AS rootpage, 'table' AS type"
  168272. " UNION ALL "
  168273. "SELECT name, rootpage, type"
  168274. " FROM \"%w\".%s WHERE rootpage!=0"
  168275. " ORDER BY name", pTab->db->aDb[pCsr->iDb].zDbSName, zMaster);
  168276. if( zSql==0 ){
  168277. return SQLITE_NOMEM_BKPT;
  168278. }else{
  168279. rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pCsr->pStmt, 0);
  168280. sqlite3_free(zSql);
  168281. }
  168282. if( rc==SQLITE_OK ){
  168283. rc = statNext(pCursor);
  168284. }
  168285. return rc;
  168286. }
  168287. static int statColumn(
  168288. sqlite3_vtab_cursor *pCursor,
  168289. sqlite3_context *ctx,
  168290. int i
  168291. ){
  168292. StatCursor *pCsr = (StatCursor *)pCursor;
  168293. switch( i ){
  168294. case 0: /* name */
  168295. sqlite3_result_text(ctx, pCsr->zName, -1, SQLITE_TRANSIENT);
  168296. break;
  168297. case 1: /* path */
  168298. sqlite3_result_text(ctx, pCsr->zPath, -1, SQLITE_TRANSIENT);
  168299. break;
  168300. case 2: /* pageno */
  168301. sqlite3_result_int64(ctx, pCsr->iPageno);
  168302. break;
  168303. case 3: /* pagetype */
  168304. sqlite3_result_text(ctx, pCsr->zPagetype, -1, SQLITE_STATIC);
  168305. break;
  168306. case 4: /* ncell */
  168307. sqlite3_result_int(ctx, pCsr->nCell);
  168308. break;
  168309. case 5: /* payload */
  168310. sqlite3_result_int(ctx, pCsr->nPayload);
  168311. break;
  168312. case 6: /* unused */
  168313. sqlite3_result_int(ctx, pCsr->nUnused);
  168314. break;
  168315. case 7: /* mx_payload */
  168316. sqlite3_result_int(ctx, pCsr->nMxPayload);
  168317. break;
  168318. case 8: /* pgoffset */
  168319. sqlite3_result_int64(ctx, pCsr->iOffset);
  168320. break;
  168321. case 9: /* pgsize */
  168322. sqlite3_result_int(ctx, pCsr->szPage);
  168323. break;
  168324. default: { /* schema */
  168325. sqlite3 *db = sqlite3_context_db_handle(ctx);
  168326. int iDb = pCsr->iDb;
  168327. sqlite3_result_text(ctx, db->aDb[iDb].zDbSName, -1, SQLITE_STATIC);
  168328. break;
  168329. }
  168330. }
  168331. return SQLITE_OK;
  168332. }
  168333. static int statRowid(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  168334. StatCursor *pCsr = (StatCursor *)pCursor;
  168335. *pRowid = pCsr->iPageno;
  168336. return SQLITE_OK;
  168337. }
  168338. /*
  168339. ** Invoke this routine to register the "dbstat" virtual table module
  168340. */
  168341. SQLITE_PRIVATE int sqlite3DbstatRegister(sqlite3 *db){
  168342. static sqlite3_module dbstat_module = {
  168343. 0, /* iVersion */
  168344. statConnect, /* xCreate */
  168345. statConnect, /* xConnect */
  168346. statBestIndex, /* xBestIndex */
  168347. statDisconnect, /* xDisconnect */
  168348. statDisconnect, /* xDestroy */
  168349. statOpen, /* xOpen - open a cursor */
  168350. statClose, /* xClose - close a cursor */
  168351. statFilter, /* xFilter - configure scan constraints */
  168352. statNext, /* xNext - advance a cursor */
  168353. statEof, /* xEof - check for end of scan */
  168354. statColumn, /* xColumn - read data */
  168355. statRowid, /* xRowid - read data */
  168356. 0, /* xUpdate */
  168357. 0, /* xBegin */
  168358. 0, /* xSync */
  168359. 0, /* xCommit */
  168360. 0, /* xRollback */
  168361. 0, /* xFindMethod */
  168362. 0, /* xRename */
  168363. 0, /* xSavepoint */
  168364. 0, /* xRelease */
  168365. 0, /* xRollbackTo */
  168366. };
  168367. return sqlite3_create_module(db, "dbstat", &dbstat_module, 0);
  168368. }
  168369. #elif defined(SQLITE_ENABLE_DBSTAT_VTAB)
  168370. SQLITE_PRIVATE int sqlite3DbstatRegister(sqlite3 *db){ return SQLITE_OK; }
  168371. #endif /* SQLITE_ENABLE_DBSTAT_VTAB */
  168372. /************** End of dbstat.c **********************************************/
  168373. /************** Begin file dbpage.c ******************************************/
  168374. /*
  168375. ** 2017-10-11
  168376. **
  168377. ** The author disclaims copyright to this source code. In place of
  168378. ** a legal notice, here is a blessing:
  168379. **
  168380. ** May you do good and not evil.
  168381. ** May you find forgiveness for yourself and forgive others.
  168382. ** May you share freely, never taking more than you give.
  168383. **
  168384. ******************************************************************************
  168385. **
  168386. ** This file contains an implementation of the "sqlite_dbpage" virtual table.
  168387. **
  168388. ** The sqlite_dbpage virtual table is used to read or write whole raw
  168389. ** pages of the database file. The pager interface is used so that
  168390. ** uncommitted changes and changes recorded in the WAL file are correctly
  168391. ** retrieved.
  168392. **
  168393. ** Usage example:
  168394. **
  168395. ** SELECT data FROM sqlite_dbpage('aux1') WHERE pgno=123;
  168396. **
  168397. ** This is an eponymous virtual table so it does not need to be created before
  168398. ** use. The optional argument to the sqlite_dbpage() table name is the
  168399. ** schema for the database file that is to be read. The default schema is
  168400. ** "main".
  168401. **
  168402. ** The data field of sqlite_dbpage table can be updated. The new
  168403. ** value must be a BLOB which is the correct page size, otherwise the
  168404. ** update fails. Rows may not be deleted or inserted.
  168405. */
  168406. /* #include "sqliteInt.h" ** Requires access to internal data structures ** */
  168407. #if (defined(SQLITE_ENABLE_DBPAGE_VTAB) || defined(SQLITE_TEST)) \
  168408. && !defined(SQLITE_OMIT_VIRTUALTABLE)
  168409. typedef struct DbpageTable DbpageTable;
  168410. typedef struct DbpageCursor DbpageCursor;
  168411. struct DbpageCursor {
  168412. sqlite3_vtab_cursor base; /* Base class. Must be first */
  168413. int pgno; /* Current page number */
  168414. int mxPgno; /* Last page to visit on this scan */
  168415. Pager *pPager; /* Pager being read/written */
  168416. DbPage *pPage1; /* Page 1 of the database */
  168417. int iDb; /* Index of database to analyze */
  168418. int szPage; /* Size of each page in bytes */
  168419. };
  168420. struct DbpageTable {
  168421. sqlite3_vtab base; /* Base class. Must be first */
  168422. sqlite3 *db; /* The database */
  168423. };
  168424. /* Columns */
  168425. #define DBPAGE_COLUMN_PGNO 0
  168426. #define DBPAGE_COLUMN_DATA 1
  168427. #define DBPAGE_COLUMN_SCHEMA 2
  168428. /*
  168429. ** Connect to or create a dbpagevfs virtual table.
  168430. */
  168431. static int dbpageConnect(
  168432. sqlite3 *db,
  168433. void *pAux,
  168434. int argc, const char *const*argv,
  168435. sqlite3_vtab **ppVtab,
  168436. char **pzErr
  168437. ){
  168438. DbpageTable *pTab = 0;
  168439. int rc = SQLITE_OK;
  168440. rc = sqlite3_declare_vtab(db,
  168441. "CREATE TABLE x(pgno INTEGER PRIMARY KEY, data BLOB, schema HIDDEN)");
  168442. if( rc==SQLITE_OK ){
  168443. pTab = (DbpageTable *)sqlite3_malloc64(sizeof(DbpageTable));
  168444. if( pTab==0 ) rc = SQLITE_NOMEM_BKPT;
  168445. }
  168446. assert( rc==SQLITE_OK || pTab==0 );
  168447. if( rc==SQLITE_OK ){
  168448. memset(pTab, 0, sizeof(DbpageTable));
  168449. pTab->db = db;
  168450. }
  168451. *ppVtab = (sqlite3_vtab*)pTab;
  168452. return rc;
  168453. }
  168454. /*
  168455. ** Disconnect from or destroy a dbpagevfs virtual table.
  168456. */
  168457. static int dbpageDisconnect(sqlite3_vtab *pVtab){
  168458. sqlite3_free(pVtab);
  168459. return SQLITE_OK;
  168460. }
  168461. /*
  168462. ** idxNum:
  168463. **
  168464. ** 0 schema=main, full table scan
  168465. ** 1 schema=main, pgno=?1
  168466. ** 2 schema=?1, full table scan
  168467. ** 3 schema=?1, pgno=?2
  168468. */
  168469. static int dbpageBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
  168470. int i;
  168471. int iPlan = 0;
  168472. /* If there is a schema= constraint, it must be honored. Report a
  168473. ** ridiculously large estimated cost if the schema= constraint is
  168474. ** unavailable
  168475. */
  168476. for(i=0; i<pIdxInfo->nConstraint; i++){
  168477. struct sqlite3_index_constraint *p = &pIdxInfo->aConstraint[i];
  168478. if( p->iColumn!=DBPAGE_COLUMN_SCHEMA ) continue;
  168479. if( p->op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
  168480. if( !p->usable ){
  168481. /* No solution. Use the default SQLITE_BIG_DBL cost */
  168482. pIdxInfo->estimatedRows = 0x7fffffff;
  168483. return SQLITE_OK;
  168484. }
  168485. iPlan = 2;
  168486. pIdxInfo->aConstraintUsage[i].argvIndex = 1;
  168487. pIdxInfo->aConstraintUsage[i].omit = 1;
  168488. break;
  168489. }
  168490. /* If we reach this point, it means that either there is no schema=
  168491. ** constraint (in which case we use the "main" schema) or else the
  168492. ** schema constraint was accepted. Lower the estimated cost accordingly
  168493. */
  168494. pIdxInfo->estimatedCost = 1.0e6;
  168495. /* Check for constraints against pgno */
  168496. for(i=0; i<pIdxInfo->nConstraint; i++){
  168497. struct sqlite3_index_constraint *p = &pIdxInfo->aConstraint[i];
  168498. if( p->usable && p->iColumn<=0 && p->op==SQLITE_INDEX_CONSTRAINT_EQ ){
  168499. pIdxInfo->estimatedRows = 1;
  168500. pIdxInfo->idxFlags = SQLITE_INDEX_SCAN_UNIQUE;
  168501. pIdxInfo->estimatedCost = 1.0;
  168502. pIdxInfo->aConstraintUsage[i].argvIndex = iPlan ? 2 : 1;
  168503. pIdxInfo->aConstraintUsage[i].omit = 1;
  168504. iPlan |= 1;
  168505. break;
  168506. }
  168507. }
  168508. pIdxInfo->idxNum = iPlan;
  168509. if( pIdxInfo->nOrderBy>=1
  168510. && pIdxInfo->aOrderBy[0].iColumn<=0
  168511. && pIdxInfo->aOrderBy[0].desc==0
  168512. ){
  168513. pIdxInfo->orderByConsumed = 1;
  168514. }
  168515. return SQLITE_OK;
  168516. }
  168517. /*
  168518. ** Open a new dbpagevfs cursor.
  168519. */
  168520. static int dbpageOpen(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor){
  168521. DbpageCursor *pCsr;
  168522. pCsr = (DbpageCursor *)sqlite3_malloc64(sizeof(DbpageCursor));
  168523. if( pCsr==0 ){
  168524. return SQLITE_NOMEM_BKPT;
  168525. }else{
  168526. memset(pCsr, 0, sizeof(DbpageCursor));
  168527. pCsr->base.pVtab = pVTab;
  168528. pCsr->pgno = -1;
  168529. }
  168530. *ppCursor = (sqlite3_vtab_cursor *)pCsr;
  168531. return SQLITE_OK;
  168532. }
  168533. /*
  168534. ** Close a dbpagevfs cursor.
  168535. */
  168536. static int dbpageClose(sqlite3_vtab_cursor *pCursor){
  168537. DbpageCursor *pCsr = (DbpageCursor *)pCursor;
  168538. if( pCsr->pPage1 ) sqlite3PagerUnrefPageOne(pCsr->pPage1);
  168539. sqlite3_free(pCsr);
  168540. return SQLITE_OK;
  168541. }
  168542. /*
  168543. ** Move a dbpagevfs cursor to the next entry in the file.
  168544. */
  168545. static int dbpageNext(sqlite3_vtab_cursor *pCursor){
  168546. int rc = SQLITE_OK;
  168547. DbpageCursor *pCsr = (DbpageCursor *)pCursor;
  168548. pCsr->pgno++;
  168549. return rc;
  168550. }
  168551. static int dbpageEof(sqlite3_vtab_cursor *pCursor){
  168552. DbpageCursor *pCsr = (DbpageCursor *)pCursor;
  168553. return pCsr->pgno > pCsr->mxPgno;
  168554. }
  168555. /*
  168556. ** idxNum:
  168557. **
  168558. ** 0 schema=main, full table scan
  168559. ** 1 schema=main, pgno=?1
  168560. ** 2 schema=?1, full table scan
  168561. ** 3 schema=?1, pgno=?2
  168562. **
  168563. ** idxStr is not used
  168564. */
  168565. static int dbpageFilter(
  168566. sqlite3_vtab_cursor *pCursor,
  168567. int idxNum, const char *idxStr,
  168568. int argc, sqlite3_value **argv
  168569. ){
  168570. DbpageCursor *pCsr = (DbpageCursor *)pCursor;
  168571. DbpageTable *pTab = (DbpageTable *)pCursor->pVtab;
  168572. int rc;
  168573. sqlite3 *db = pTab->db;
  168574. Btree *pBt;
  168575. /* Default setting is no rows of result */
  168576. pCsr->pgno = 1;
  168577. pCsr->mxPgno = 0;
  168578. if( idxNum & 2 ){
  168579. const char *zSchema;
  168580. assert( argc>=1 );
  168581. zSchema = (const char*)sqlite3_value_text(argv[0]);
  168582. pCsr->iDb = sqlite3FindDbName(db, zSchema);
  168583. if( pCsr->iDb<0 ) return SQLITE_OK;
  168584. }else{
  168585. pCsr->iDb = 0;
  168586. }
  168587. pBt = db->aDb[pCsr->iDb].pBt;
  168588. if( pBt==0 ) return SQLITE_OK;
  168589. pCsr->pPager = sqlite3BtreePager(pBt);
  168590. pCsr->szPage = sqlite3BtreeGetPageSize(pBt);
  168591. pCsr->mxPgno = sqlite3BtreeLastPage(pBt);
  168592. if( idxNum & 1 ){
  168593. assert( argc>(idxNum>>1) );
  168594. pCsr->pgno = sqlite3_value_int(argv[idxNum>>1]);
  168595. if( pCsr->pgno<1 || pCsr->pgno>pCsr->mxPgno ){
  168596. pCsr->pgno = 1;
  168597. pCsr->mxPgno = 0;
  168598. }else{
  168599. pCsr->mxPgno = pCsr->pgno;
  168600. }
  168601. }else{
  168602. assert( pCsr->pgno==1 );
  168603. }
  168604. if( pCsr->pPage1 ) sqlite3PagerUnrefPageOne(pCsr->pPage1);
  168605. rc = sqlite3PagerGet(pCsr->pPager, 1, &pCsr->pPage1, 0);
  168606. return rc;
  168607. }
  168608. static int dbpageColumn(
  168609. sqlite3_vtab_cursor *pCursor,
  168610. sqlite3_context *ctx,
  168611. int i
  168612. ){
  168613. DbpageCursor *pCsr = (DbpageCursor *)pCursor;
  168614. int rc = SQLITE_OK;
  168615. switch( i ){
  168616. case 0: { /* pgno */
  168617. sqlite3_result_int(ctx, pCsr->pgno);
  168618. break;
  168619. }
  168620. case 1: { /* data */
  168621. DbPage *pDbPage = 0;
  168622. rc = sqlite3PagerGet(pCsr->pPager, pCsr->pgno, (DbPage**)&pDbPage, 0);
  168623. if( rc==SQLITE_OK ){
  168624. sqlite3_result_blob(ctx, sqlite3PagerGetData(pDbPage), pCsr->szPage,
  168625. SQLITE_TRANSIENT);
  168626. }
  168627. sqlite3PagerUnref(pDbPage);
  168628. break;
  168629. }
  168630. default: { /* schema */
  168631. sqlite3 *db = sqlite3_context_db_handle(ctx);
  168632. sqlite3_result_text(ctx, db->aDb[pCsr->iDb].zDbSName, -1, SQLITE_STATIC);
  168633. break;
  168634. }
  168635. }
  168636. return SQLITE_OK;
  168637. }
  168638. static int dbpageRowid(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  168639. DbpageCursor *pCsr = (DbpageCursor *)pCursor;
  168640. *pRowid = pCsr->pgno;
  168641. return SQLITE_OK;
  168642. }
  168643. static int dbpageUpdate(
  168644. sqlite3_vtab *pVtab,
  168645. int argc,
  168646. sqlite3_value **argv,
  168647. sqlite_int64 *pRowid
  168648. ){
  168649. DbpageTable *pTab = (DbpageTable *)pVtab;
  168650. Pgno pgno;
  168651. DbPage *pDbPage = 0;
  168652. int rc = SQLITE_OK;
  168653. char *zErr = 0;
  168654. const char *zSchema;
  168655. int iDb;
  168656. Btree *pBt;
  168657. Pager *pPager;
  168658. int szPage;
  168659. if( argc==1 ){
  168660. zErr = "cannot delete";
  168661. goto update_fail;
  168662. }
  168663. pgno = sqlite3_value_int(argv[0]);
  168664. if( (Pgno)sqlite3_value_int(argv[1])!=pgno ){
  168665. zErr = "cannot insert";
  168666. goto update_fail;
  168667. }
  168668. zSchema = (const char*)sqlite3_value_text(argv[4]);
  168669. iDb = zSchema ? sqlite3FindDbName(pTab->db, zSchema) : -1;
  168670. if( iDb<0 ){
  168671. zErr = "no such schema";
  168672. goto update_fail;
  168673. }
  168674. pBt = pTab->db->aDb[iDb].pBt;
  168675. if( pgno<1 || pBt==0 || pgno>(int)sqlite3BtreeLastPage(pBt) ){
  168676. zErr = "bad page number";
  168677. goto update_fail;
  168678. }
  168679. szPage = sqlite3BtreeGetPageSize(pBt);
  168680. if( sqlite3_value_type(argv[3])!=SQLITE_BLOB
  168681. || sqlite3_value_bytes(argv[3])!=szPage
  168682. ){
  168683. zErr = "bad page value";
  168684. goto update_fail;
  168685. }
  168686. pPager = sqlite3BtreePager(pBt);
  168687. rc = sqlite3PagerGet(pPager, pgno, (DbPage**)&pDbPage, 0);
  168688. if( rc==SQLITE_OK ){
  168689. rc = sqlite3PagerWrite(pDbPage);
  168690. if( rc==SQLITE_OK ){
  168691. memcpy(sqlite3PagerGetData(pDbPage),
  168692. sqlite3_value_blob(argv[3]),
  168693. szPage);
  168694. }
  168695. }
  168696. sqlite3PagerUnref(pDbPage);
  168697. return rc;
  168698. update_fail:
  168699. sqlite3_free(pVtab->zErrMsg);
  168700. pVtab->zErrMsg = sqlite3_mprintf("%s", zErr);
  168701. return SQLITE_ERROR;
  168702. }
  168703. /* Since we do not know in advance which database files will be
  168704. ** written by the sqlite_dbpage virtual table, start a write transaction
  168705. ** on them all.
  168706. */
  168707. static int dbpageBegin(sqlite3_vtab *pVtab){
  168708. DbpageTable *pTab = (DbpageTable *)pVtab;
  168709. sqlite3 *db = pTab->db;
  168710. int i;
  168711. for(i=0; i<db->nDb; i++){
  168712. Btree *pBt = db->aDb[i].pBt;
  168713. if( pBt ) sqlite3BtreeBeginTrans(pBt, 1);
  168714. }
  168715. return SQLITE_OK;
  168716. }
  168717. /*
  168718. ** Invoke this routine to register the "dbpage" virtual table module
  168719. */
  168720. SQLITE_PRIVATE int sqlite3DbpageRegister(sqlite3 *db){
  168721. static sqlite3_module dbpage_module = {
  168722. 0, /* iVersion */
  168723. dbpageConnect, /* xCreate */
  168724. dbpageConnect, /* xConnect */
  168725. dbpageBestIndex, /* xBestIndex */
  168726. dbpageDisconnect, /* xDisconnect */
  168727. dbpageDisconnect, /* xDestroy */
  168728. dbpageOpen, /* xOpen - open a cursor */
  168729. dbpageClose, /* xClose - close a cursor */
  168730. dbpageFilter, /* xFilter - configure scan constraints */
  168731. dbpageNext, /* xNext - advance a cursor */
  168732. dbpageEof, /* xEof - check for end of scan */
  168733. dbpageColumn, /* xColumn - read data */
  168734. dbpageRowid, /* xRowid - read data */
  168735. dbpageUpdate, /* xUpdate */
  168736. dbpageBegin, /* xBegin */
  168737. 0, /* xSync */
  168738. 0, /* xCommit */
  168739. 0, /* xRollback */
  168740. 0, /* xFindMethod */
  168741. 0, /* xRename */
  168742. 0, /* xSavepoint */
  168743. 0, /* xRelease */
  168744. 0, /* xRollbackTo */
  168745. };
  168746. return sqlite3_create_module(db, "sqlite_dbpage", &dbpage_module, 0);
  168747. }
  168748. #elif defined(SQLITE_ENABLE_DBPAGE_VTAB)
  168749. SQLITE_PRIVATE int sqlite3DbpageRegister(sqlite3 *db){ return SQLITE_OK; }
  168750. #endif /* SQLITE_ENABLE_DBSTAT_VTAB */
  168751. /************** End of dbpage.c **********************************************/
  168752. /************** Begin file sqlite3session.c **********************************/
  168753. #if defined(SQLITE_ENABLE_SESSION) && defined(SQLITE_ENABLE_PREUPDATE_HOOK)
  168754. /* #include "sqlite3session.h" */
  168755. /* #include <assert.h> */
  168756. /* #include <string.h> */
  168757. #ifndef SQLITE_AMALGAMATION
  168758. /* # include "sqliteInt.h" */
  168759. /* # include "vdbeInt.h" */
  168760. #endif
  168761. typedef struct SessionTable SessionTable;
  168762. typedef struct SessionChange SessionChange;
  168763. typedef struct SessionBuffer SessionBuffer;
  168764. typedef struct SessionInput SessionInput;
  168765. /*
  168766. ** Minimum chunk size used by streaming versions of functions.
  168767. */
  168768. #ifndef SESSIONS_STRM_CHUNK_SIZE
  168769. # ifdef SQLITE_TEST
  168770. # define SESSIONS_STRM_CHUNK_SIZE 64
  168771. # else
  168772. # define SESSIONS_STRM_CHUNK_SIZE 1024
  168773. # endif
  168774. #endif
  168775. typedef struct SessionHook SessionHook;
  168776. struct SessionHook {
  168777. void *pCtx;
  168778. int (*xOld)(void*,int,sqlite3_value**);
  168779. int (*xNew)(void*,int,sqlite3_value**);
  168780. int (*xCount)(void*);
  168781. int (*xDepth)(void*);
  168782. };
  168783. /*
  168784. ** Session handle structure.
  168785. */
  168786. struct sqlite3_session {
  168787. sqlite3 *db; /* Database handle session is attached to */
  168788. char *zDb; /* Name of database session is attached to */
  168789. int bEnable; /* True if currently recording */
  168790. int bIndirect; /* True if all changes are indirect */
  168791. int bAutoAttach; /* True to auto-attach tables */
  168792. int rc; /* Non-zero if an error has occurred */
  168793. void *pFilterCtx; /* First argument to pass to xTableFilter */
  168794. int (*xTableFilter)(void *pCtx, const char *zTab);
  168795. sqlite3_value *pZeroBlob; /* Value containing X'' */
  168796. sqlite3_session *pNext; /* Next session object on same db. */
  168797. SessionTable *pTable; /* List of attached tables */
  168798. SessionHook hook; /* APIs to grab new and old data with */
  168799. };
  168800. /*
  168801. ** Instances of this structure are used to build strings or binary records.
  168802. */
  168803. struct SessionBuffer {
  168804. u8 *aBuf; /* Pointer to changeset buffer */
  168805. int nBuf; /* Size of buffer aBuf */
  168806. int nAlloc; /* Size of allocation containing aBuf */
  168807. };
  168808. /*
  168809. ** An object of this type is used internally as an abstraction for
  168810. ** input data. Input data may be supplied either as a single large buffer
  168811. ** (e.g. sqlite3changeset_start()) or using a stream function (e.g.
  168812. ** sqlite3changeset_start_strm()).
  168813. */
  168814. struct SessionInput {
  168815. int bNoDiscard; /* If true, do not discard in InputBuffer() */
  168816. int iCurrent; /* Offset in aData[] of current change */
  168817. int iNext; /* Offset in aData[] of next change */
  168818. u8 *aData; /* Pointer to buffer containing changeset */
  168819. int nData; /* Number of bytes in aData */
  168820. SessionBuffer buf; /* Current read buffer */
  168821. int (*xInput)(void*, void*, int*); /* Input stream call (or NULL) */
  168822. void *pIn; /* First argument to xInput */
  168823. int bEof; /* Set to true after xInput finished */
  168824. };
  168825. /*
  168826. ** Structure for changeset iterators.
  168827. */
  168828. struct sqlite3_changeset_iter {
  168829. SessionInput in; /* Input buffer or stream */
  168830. SessionBuffer tblhdr; /* Buffer to hold apValue/zTab/abPK/ */
  168831. int bPatchset; /* True if this is a patchset */
  168832. int rc; /* Iterator error code */
  168833. sqlite3_stmt *pConflict; /* Points to conflicting row, if any */
  168834. char *zTab; /* Current table */
  168835. int nCol; /* Number of columns in zTab */
  168836. int op; /* Current operation */
  168837. int bIndirect; /* True if current change was indirect */
  168838. u8 *abPK; /* Primary key array */
  168839. sqlite3_value **apValue; /* old.* and new.* values */
  168840. };
  168841. /*
  168842. ** Each session object maintains a set of the following structures, one
  168843. ** for each table the session object is monitoring. The structures are
  168844. ** stored in a linked list starting at sqlite3_session.pTable.
  168845. **
  168846. ** The keys of the SessionTable.aChange[] hash table are all rows that have
  168847. ** been modified in any way since the session object was attached to the
  168848. ** table.
  168849. **
  168850. ** The data associated with each hash-table entry is a structure containing
  168851. ** a subset of the initial values that the modified row contained at the
  168852. ** start of the session. Or no initial values if the row was inserted.
  168853. */
  168854. struct SessionTable {
  168855. SessionTable *pNext;
  168856. char *zName; /* Local name of table */
  168857. int nCol; /* Number of columns in table zName */
  168858. int bStat1; /* True if this is sqlite_stat1 */
  168859. const char **azCol; /* Column names */
  168860. u8 *abPK; /* Array of primary key flags */
  168861. int nEntry; /* Total number of entries in hash table */
  168862. int nChange; /* Size of apChange[] array */
  168863. SessionChange **apChange; /* Hash table buckets */
  168864. };
  168865. /*
  168866. ** RECORD FORMAT:
  168867. **
  168868. ** The following record format is similar to (but not compatible with) that
  168869. ** used in SQLite database files. This format is used as part of the
  168870. ** change-set binary format, and so must be architecture independent.
  168871. **
  168872. ** Unlike the SQLite database record format, each field is self-contained -
  168873. ** there is no separation of header and data. Each field begins with a
  168874. ** single byte describing its type, as follows:
  168875. **
  168876. ** 0x00: Undefined value.
  168877. ** 0x01: Integer value.
  168878. ** 0x02: Real value.
  168879. ** 0x03: Text value.
  168880. ** 0x04: Blob value.
  168881. ** 0x05: SQL NULL value.
  168882. **
  168883. ** Note that the above match the definitions of SQLITE_INTEGER, SQLITE_TEXT
  168884. ** and so on in sqlite3.h. For undefined and NULL values, the field consists
  168885. ** only of the single type byte. For other types of values, the type byte
  168886. ** is followed by:
  168887. **
  168888. ** Text values:
  168889. ** A varint containing the number of bytes in the value (encoded using
  168890. ** UTF-8). Followed by a buffer containing the UTF-8 representation
  168891. ** of the text value. There is no nul terminator.
  168892. **
  168893. ** Blob values:
  168894. ** A varint containing the number of bytes in the value, followed by
  168895. ** a buffer containing the value itself.
  168896. **
  168897. ** Integer values:
  168898. ** An 8-byte big-endian integer value.
  168899. **
  168900. ** Real values:
  168901. ** An 8-byte big-endian IEEE 754-2008 real value.
  168902. **
  168903. ** Varint values are encoded in the same way as varints in the SQLite
  168904. ** record format.
  168905. **
  168906. ** CHANGESET FORMAT:
  168907. **
  168908. ** A changeset is a collection of DELETE, UPDATE and INSERT operations on
  168909. ** one or more tables. Operations on a single table are grouped together,
  168910. ** but may occur in any order (i.e. deletes, updates and inserts are all
  168911. ** mixed together).
  168912. **
  168913. ** Each group of changes begins with a table header:
  168914. **
  168915. ** 1 byte: Constant 0x54 (capital 'T')
  168916. ** Varint: Number of columns in the table.
  168917. ** nCol bytes: 0x01 for PK columns, 0x00 otherwise.
  168918. ** N bytes: Unqualified table name (encoded using UTF-8). Nul-terminated.
  168919. **
  168920. ** Followed by one or more changes to the table.
  168921. **
  168922. ** 1 byte: Either SQLITE_INSERT (0x12), UPDATE (0x17) or DELETE (0x09).
  168923. ** 1 byte: The "indirect-change" flag.
  168924. ** old.* record: (delete and update only)
  168925. ** new.* record: (insert and update only)
  168926. **
  168927. ** The "old.*" and "new.*" records, if present, are N field records in the
  168928. ** format described above under "RECORD FORMAT", where N is the number of
  168929. ** columns in the table. The i'th field of each record is associated with
  168930. ** the i'th column of the table, counting from left to right in the order
  168931. ** in which columns were declared in the CREATE TABLE statement.
  168932. **
  168933. ** The new.* record that is part of each INSERT change contains the values
  168934. ** that make up the new row. Similarly, the old.* record that is part of each
  168935. ** DELETE change contains the values that made up the row that was deleted
  168936. ** from the database. In the changeset format, the records that are part
  168937. ** of INSERT or DELETE changes never contain any undefined (type byte 0x00)
  168938. ** fields.
  168939. **
  168940. ** Within the old.* record associated with an UPDATE change, all fields
  168941. ** associated with table columns that are not PRIMARY KEY columns and are
  168942. ** not modified by the UPDATE change are set to "undefined". Other fields
  168943. ** are set to the values that made up the row before the UPDATE that the
  168944. ** change records took place. Within the new.* record, fields associated
  168945. ** with table columns modified by the UPDATE change contain the new
  168946. ** values. Fields associated with table columns that are not modified
  168947. ** are set to "undefined".
  168948. **
  168949. ** PATCHSET FORMAT:
  168950. **
  168951. ** A patchset is also a collection of changes. It is similar to a changeset,
  168952. ** but leaves undefined those fields that are not useful if no conflict
  168953. ** resolution is required when applying the changeset.
  168954. **
  168955. ** Each group of changes begins with a table header:
  168956. **
  168957. ** 1 byte: Constant 0x50 (capital 'P')
  168958. ** Varint: Number of columns in the table.
  168959. ** nCol bytes: 0x01 for PK columns, 0x00 otherwise.
  168960. ** N bytes: Unqualified table name (encoded using UTF-8). Nul-terminated.
  168961. **
  168962. ** Followed by one or more changes to the table.
  168963. **
  168964. ** 1 byte: Either SQLITE_INSERT (0x12), UPDATE (0x17) or DELETE (0x09).
  168965. ** 1 byte: The "indirect-change" flag.
  168966. ** single record: (PK fields for DELETE, PK and modified fields for UPDATE,
  168967. ** full record for INSERT).
  168968. **
  168969. ** As in the changeset format, each field of the single record that is part
  168970. ** of a patchset change is associated with the correspondingly positioned
  168971. ** table column, counting from left to right within the CREATE TABLE
  168972. ** statement.
  168973. **
  168974. ** For a DELETE change, all fields within the record except those associated
  168975. ** with PRIMARY KEY columns are omitted. The PRIMARY KEY fields contain the
  168976. ** values identifying the row to delete.
  168977. **
  168978. ** For an UPDATE change, all fields except those associated with PRIMARY KEY
  168979. ** columns and columns that are modified by the UPDATE are set to "undefined".
  168980. ** PRIMARY KEY fields contain the values identifying the table row to update,
  168981. ** and fields associated with modified columns contain the new column values.
  168982. **
  168983. ** The records associated with INSERT changes are in the same format as for
  168984. ** changesets. It is not possible for a record associated with an INSERT
  168985. ** change to contain a field set to "undefined".
  168986. */
  168987. /*
  168988. ** For each row modified during a session, there exists a single instance of
  168989. ** this structure stored in a SessionTable.aChange[] hash table.
  168990. */
  168991. struct SessionChange {
  168992. int op; /* One of UPDATE, DELETE, INSERT */
  168993. int bIndirect; /* True if this change is "indirect" */
  168994. int nRecord; /* Number of bytes in buffer aRecord[] */
  168995. u8 *aRecord; /* Buffer containing old.* record */
  168996. SessionChange *pNext; /* For hash-table collisions */
  168997. };
  168998. /*
  168999. ** Write a varint with value iVal into the buffer at aBuf. Return the
  169000. ** number of bytes written.
  169001. */
  169002. static int sessionVarintPut(u8 *aBuf, int iVal){
  169003. return putVarint32(aBuf, iVal);
  169004. }
  169005. /*
  169006. ** Return the number of bytes required to store value iVal as a varint.
  169007. */
  169008. static int sessionVarintLen(int iVal){
  169009. return sqlite3VarintLen(iVal);
  169010. }
  169011. /*
  169012. ** Read a varint value from aBuf[] into *piVal. Return the number of
  169013. ** bytes read.
  169014. */
  169015. static int sessionVarintGet(u8 *aBuf, int *piVal){
  169016. return getVarint32(aBuf, *piVal);
  169017. }
  169018. /* Load an unaligned and unsigned 32-bit integer */
  169019. #define SESSION_UINT32(x) (((u32)(x)[0]<<24)|((x)[1]<<16)|((x)[2]<<8)|(x)[3])
  169020. /*
  169021. ** Read a 64-bit big-endian integer value from buffer aRec[]. Return
  169022. ** the value read.
  169023. */
  169024. static sqlite3_int64 sessionGetI64(u8 *aRec){
  169025. u64 x = SESSION_UINT32(aRec);
  169026. u32 y = SESSION_UINT32(aRec+4);
  169027. x = (x<<32) + y;
  169028. return (sqlite3_int64)x;
  169029. }
  169030. /*
  169031. ** Write a 64-bit big-endian integer value to the buffer aBuf[].
  169032. */
  169033. static void sessionPutI64(u8 *aBuf, sqlite3_int64 i){
  169034. aBuf[0] = (i>>56) & 0xFF;
  169035. aBuf[1] = (i>>48) & 0xFF;
  169036. aBuf[2] = (i>>40) & 0xFF;
  169037. aBuf[3] = (i>>32) & 0xFF;
  169038. aBuf[4] = (i>>24) & 0xFF;
  169039. aBuf[5] = (i>>16) & 0xFF;
  169040. aBuf[6] = (i>> 8) & 0xFF;
  169041. aBuf[7] = (i>> 0) & 0xFF;
  169042. }
  169043. /*
  169044. ** This function is used to serialize the contents of value pValue (see
  169045. ** comment titled "RECORD FORMAT" above).
  169046. **
  169047. ** If it is non-NULL, the serialized form of the value is written to
  169048. ** buffer aBuf. *pnWrite is set to the number of bytes written before
  169049. ** returning. Or, if aBuf is NULL, the only thing this function does is
  169050. ** set *pnWrite.
  169051. **
  169052. ** If no error occurs, SQLITE_OK is returned. Or, if an OOM error occurs
  169053. ** within a call to sqlite3_value_text() (may fail if the db is utf-16))
  169054. ** SQLITE_NOMEM is returned.
  169055. */
  169056. static int sessionSerializeValue(
  169057. u8 *aBuf, /* If non-NULL, write serialized value here */
  169058. sqlite3_value *pValue, /* Value to serialize */
  169059. int *pnWrite /* IN/OUT: Increment by bytes written */
  169060. ){
  169061. int nByte; /* Size of serialized value in bytes */
  169062. if( pValue ){
  169063. int eType; /* Value type (SQLITE_NULL, TEXT etc.) */
  169064. eType = sqlite3_value_type(pValue);
  169065. if( aBuf ) aBuf[0] = eType;
  169066. switch( eType ){
  169067. case SQLITE_NULL:
  169068. nByte = 1;
  169069. break;
  169070. case SQLITE_INTEGER:
  169071. case SQLITE_FLOAT:
  169072. if( aBuf ){
  169073. /* TODO: SQLite does something special to deal with mixed-endian
  169074. ** floating point values (e.g. ARM7). This code probably should
  169075. ** too. */
  169076. u64 i;
  169077. if( eType==SQLITE_INTEGER ){
  169078. i = (u64)sqlite3_value_int64(pValue);
  169079. }else{
  169080. double r;
  169081. assert( sizeof(double)==8 && sizeof(u64)==8 );
  169082. r = sqlite3_value_double(pValue);
  169083. memcpy(&i, &r, 8);
  169084. }
  169085. sessionPutI64(&aBuf[1], i);
  169086. }
  169087. nByte = 9;
  169088. break;
  169089. default: {
  169090. u8 *z;
  169091. int n;
  169092. int nVarint;
  169093. assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
  169094. if( eType==SQLITE_TEXT ){
  169095. z = (u8 *)sqlite3_value_text(pValue);
  169096. }else{
  169097. z = (u8 *)sqlite3_value_blob(pValue);
  169098. }
  169099. n = sqlite3_value_bytes(pValue);
  169100. if( z==0 && (eType!=SQLITE_BLOB || n>0) ) return SQLITE_NOMEM;
  169101. nVarint = sessionVarintLen(n);
  169102. if( aBuf ){
  169103. sessionVarintPut(&aBuf[1], n);
  169104. if( n ) memcpy(&aBuf[nVarint + 1], z, n);
  169105. }
  169106. nByte = 1 + nVarint + n;
  169107. break;
  169108. }
  169109. }
  169110. }else{
  169111. nByte = 1;
  169112. if( aBuf ) aBuf[0] = '\0';
  169113. }
  169114. if( pnWrite ) *pnWrite += nByte;
  169115. return SQLITE_OK;
  169116. }
  169117. /*
  169118. ** This macro is used to calculate hash key values for data structures. In
  169119. ** order to use this macro, the entire data structure must be represented
  169120. ** as a series of unsigned integers. In order to calculate a hash-key value
  169121. ** for a data structure represented as three such integers, the macro may
  169122. ** then be used as follows:
  169123. **
  169124. ** int hash_key_value;
  169125. ** hash_key_value = HASH_APPEND(0, <value 1>);
  169126. ** hash_key_value = HASH_APPEND(hash_key_value, <value 2>);
  169127. ** hash_key_value = HASH_APPEND(hash_key_value, <value 3>);
  169128. **
  169129. ** In practice, the data structures this macro is used for are the primary
  169130. ** key values of modified rows.
  169131. */
  169132. #define HASH_APPEND(hash, add) ((hash) << 3) ^ (hash) ^ (unsigned int)(add)
  169133. /*
  169134. ** Append the hash of the 64-bit integer passed as the second argument to the
  169135. ** hash-key value passed as the first. Return the new hash-key value.
  169136. */
  169137. static unsigned int sessionHashAppendI64(unsigned int h, i64 i){
  169138. h = HASH_APPEND(h, i & 0xFFFFFFFF);
  169139. return HASH_APPEND(h, (i>>32)&0xFFFFFFFF);
  169140. }
  169141. /*
  169142. ** Append the hash of the blob passed via the second and third arguments to
  169143. ** the hash-key value passed as the first. Return the new hash-key value.
  169144. */
  169145. static unsigned int sessionHashAppendBlob(unsigned int h, int n, const u8 *z){
  169146. int i;
  169147. for(i=0; i<n; i++) h = HASH_APPEND(h, z[i]);
  169148. return h;
  169149. }
  169150. /*
  169151. ** Append the hash of the data type passed as the second argument to the
  169152. ** hash-key value passed as the first. Return the new hash-key value.
  169153. */
  169154. static unsigned int sessionHashAppendType(unsigned int h, int eType){
  169155. return HASH_APPEND(h, eType);
  169156. }
  169157. /*
  169158. ** This function may only be called from within a pre-update callback.
  169159. ** It calculates a hash based on the primary key values of the old.* or
  169160. ** new.* row currently available and, assuming no error occurs, writes it to
  169161. ** *piHash before returning. If the primary key contains one or more NULL
  169162. ** values, *pbNullPK is set to true before returning.
  169163. **
  169164. ** If an error occurs, an SQLite error code is returned and the final values
  169165. ** of *piHash asn *pbNullPK are undefined. Otherwise, SQLITE_OK is returned
  169166. ** and the output variables are set as described above.
  169167. */
  169168. static int sessionPreupdateHash(
  169169. sqlite3_session *pSession, /* Session object that owns pTab */
  169170. SessionTable *pTab, /* Session table handle */
  169171. int bNew, /* True to hash the new.* PK */
  169172. int *piHash, /* OUT: Hash value */
  169173. int *pbNullPK /* OUT: True if there are NULL values in PK */
  169174. ){
  169175. unsigned int h = 0; /* Hash value to return */
  169176. int i; /* Used to iterate through columns */
  169177. assert( *pbNullPK==0 );
  169178. assert( pTab->nCol==pSession->hook.xCount(pSession->hook.pCtx) );
  169179. for(i=0; i<pTab->nCol; i++){
  169180. if( pTab->abPK[i] ){
  169181. int rc;
  169182. int eType;
  169183. sqlite3_value *pVal;
  169184. if( bNew ){
  169185. rc = pSession->hook.xNew(pSession->hook.pCtx, i, &pVal);
  169186. }else{
  169187. rc = pSession->hook.xOld(pSession->hook.pCtx, i, &pVal);
  169188. }
  169189. if( rc!=SQLITE_OK ) return rc;
  169190. eType = sqlite3_value_type(pVal);
  169191. h = sessionHashAppendType(h, eType);
  169192. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  169193. i64 iVal;
  169194. if( eType==SQLITE_INTEGER ){
  169195. iVal = sqlite3_value_int64(pVal);
  169196. }else{
  169197. double rVal = sqlite3_value_double(pVal);
  169198. assert( sizeof(iVal)==8 && sizeof(rVal)==8 );
  169199. memcpy(&iVal, &rVal, 8);
  169200. }
  169201. h = sessionHashAppendI64(h, iVal);
  169202. }else if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  169203. const u8 *z;
  169204. int n;
  169205. if( eType==SQLITE_TEXT ){
  169206. z = (const u8 *)sqlite3_value_text(pVal);
  169207. }else{
  169208. z = (const u8 *)sqlite3_value_blob(pVal);
  169209. }
  169210. n = sqlite3_value_bytes(pVal);
  169211. if( !z && (eType!=SQLITE_BLOB || n>0) ) return SQLITE_NOMEM;
  169212. h = sessionHashAppendBlob(h, n, z);
  169213. }else{
  169214. assert( eType==SQLITE_NULL );
  169215. assert( pTab->bStat1==0 || i!=1 );
  169216. *pbNullPK = 1;
  169217. }
  169218. }
  169219. }
  169220. *piHash = (h % pTab->nChange);
  169221. return SQLITE_OK;
  169222. }
  169223. /*
  169224. ** The buffer that the argument points to contains a serialized SQL value.
  169225. ** Return the number of bytes of space occupied by the value (including
  169226. ** the type byte).
  169227. */
  169228. static int sessionSerialLen(u8 *a){
  169229. int e = *a;
  169230. int n;
  169231. if( e==0 || e==0xFF ) return 1;
  169232. if( e==SQLITE_NULL ) return 1;
  169233. if( e==SQLITE_INTEGER || e==SQLITE_FLOAT ) return 9;
  169234. return sessionVarintGet(&a[1], &n) + 1 + n;
  169235. }
  169236. /*
  169237. ** Based on the primary key values stored in change aRecord, calculate a
  169238. ** hash key. Assume the has table has nBucket buckets. The hash keys
  169239. ** calculated by this function are compatible with those calculated by
  169240. ** sessionPreupdateHash().
  169241. **
  169242. ** The bPkOnly argument is non-zero if the record at aRecord[] is from
  169243. ** a patchset DELETE. In this case the non-PK fields are omitted entirely.
  169244. */
  169245. static unsigned int sessionChangeHash(
  169246. SessionTable *pTab, /* Table handle */
  169247. int bPkOnly, /* Record consists of PK fields only */
  169248. u8 *aRecord, /* Change record */
  169249. int nBucket /* Assume this many buckets in hash table */
  169250. ){
  169251. unsigned int h = 0; /* Value to return */
  169252. int i; /* Used to iterate through columns */
  169253. u8 *a = aRecord; /* Used to iterate through change record */
  169254. for(i=0; i<pTab->nCol; i++){
  169255. int eType = *a;
  169256. int isPK = pTab->abPK[i];
  169257. if( bPkOnly && isPK==0 ) continue;
  169258. /* It is not possible for eType to be SQLITE_NULL here. The session
  169259. ** module does not record changes for rows with NULL values stored in
  169260. ** primary key columns. */
  169261. assert( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT
  169262. || eType==SQLITE_TEXT || eType==SQLITE_BLOB
  169263. || eType==SQLITE_NULL || eType==0
  169264. );
  169265. assert( !isPK || (eType!=0 && eType!=SQLITE_NULL) );
  169266. if( isPK ){
  169267. a++;
  169268. h = sessionHashAppendType(h, eType);
  169269. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  169270. h = sessionHashAppendI64(h, sessionGetI64(a));
  169271. a += 8;
  169272. }else{
  169273. int n;
  169274. a += sessionVarintGet(a, &n);
  169275. h = sessionHashAppendBlob(h, n, a);
  169276. a += n;
  169277. }
  169278. }else{
  169279. a += sessionSerialLen(a);
  169280. }
  169281. }
  169282. return (h % nBucket);
  169283. }
  169284. /*
  169285. ** Arguments aLeft and aRight are pointers to change records for table pTab.
  169286. ** This function returns true if the two records apply to the same row (i.e.
  169287. ** have the same values stored in the primary key columns), or false
  169288. ** otherwise.
  169289. */
  169290. static int sessionChangeEqual(
  169291. SessionTable *pTab, /* Table used for PK definition */
  169292. int bLeftPkOnly, /* True if aLeft[] contains PK fields only */
  169293. u8 *aLeft, /* Change record */
  169294. int bRightPkOnly, /* True if aRight[] contains PK fields only */
  169295. u8 *aRight /* Change record */
  169296. ){
  169297. u8 *a1 = aLeft; /* Cursor to iterate through aLeft */
  169298. u8 *a2 = aRight; /* Cursor to iterate through aRight */
  169299. int iCol; /* Used to iterate through table columns */
  169300. for(iCol=0; iCol<pTab->nCol; iCol++){
  169301. if( pTab->abPK[iCol] ){
  169302. int n1 = sessionSerialLen(a1);
  169303. int n2 = sessionSerialLen(a2);
  169304. if( n1!=n2 || memcmp(a1, a2, n1) ){
  169305. return 0;
  169306. }
  169307. a1 += n1;
  169308. a2 += n2;
  169309. }else{
  169310. if( bLeftPkOnly==0 ) a1 += sessionSerialLen(a1);
  169311. if( bRightPkOnly==0 ) a2 += sessionSerialLen(a2);
  169312. }
  169313. }
  169314. return 1;
  169315. }
  169316. /*
  169317. ** Arguments aLeft and aRight both point to buffers containing change
  169318. ** records with nCol columns. This function "merges" the two records into
  169319. ** a single records which is written to the buffer at *paOut. *paOut is
  169320. ** then set to point to one byte after the last byte written before
  169321. ** returning.
  169322. **
  169323. ** The merging of records is done as follows: For each column, if the
  169324. ** aRight record contains a value for the column, copy the value from
  169325. ** their. Otherwise, if aLeft contains a value, copy it. If neither
  169326. ** record contains a value for a given column, then neither does the
  169327. ** output record.
  169328. */
  169329. static void sessionMergeRecord(
  169330. u8 **paOut,
  169331. int nCol,
  169332. u8 *aLeft,
  169333. u8 *aRight
  169334. ){
  169335. u8 *a1 = aLeft; /* Cursor used to iterate through aLeft */
  169336. u8 *a2 = aRight; /* Cursor used to iterate through aRight */
  169337. u8 *aOut = *paOut; /* Output cursor */
  169338. int iCol; /* Used to iterate from 0 to nCol */
  169339. for(iCol=0; iCol<nCol; iCol++){
  169340. int n1 = sessionSerialLen(a1);
  169341. int n2 = sessionSerialLen(a2);
  169342. if( *a2 ){
  169343. memcpy(aOut, a2, n2);
  169344. aOut += n2;
  169345. }else{
  169346. memcpy(aOut, a1, n1);
  169347. aOut += n1;
  169348. }
  169349. a1 += n1;
  169350. a2 += n2;
  169351. }
  169352. *paOut = aOut;
  169353. }
  169354. /*
  169355. ** This is a helper function used by sessionMergeUpdate().
  169356. **
  169357. ** When this function is called, both *paOne and *paTwo point to a value
  169358. ** within a change record. Before it returns, both have been advanced so
  169359. ** as to point to the next value in the record.
  169360. **
  169361. ** If, when this function is called, *paTwo points to a valid value (i.e.
  169362. ** *paTwo[0] is not 0x00 - the "no value" placeholder), a copy of the *paTwo
  169363. ** pointer is returned and *pnVal is set to the number of bytes in the
  169364. ** serialized value. Otherwise, a copy of *paOne is returned and *pnVal
  169365. ** set to the number of bytes in the value at *paOne. If *paOne points
  169366. ** to the "no value" placeholder, *pnVal is set to 1. In other words:
  169367. **
  169368. ** if( *paTwo is valid ) return *paTwo;
  169369. ** return *paOne;
  169370. **
  169371. */
  169372. static u8 *sessionMergeValue(
  169373. u8 **paOne, /* IN/OUT: Left-hand buffer pointer */
  169374. u8 **paTwo, /* IN/OUT: Right-hand buffer pointer */
  169375. int *pnVal /* OUT: Bytes in returned value */
  169376. ){
  169377. u8 *a1 = *paOne;
  169378. u8 *a2 = *paTwo;
  169379. u8 *pRet = 0;
  169380. int n1;
  169381. assert( a1 );
  169382. if( a2 ){
  169383. int n2 = sessionSerialLen(a2);
  169384. if( *a2 ){
  169385. *pnVal = n2;
  169386. pRet = a2;
  169387. }
  169388. *paTwo = &a2[n2];
  169389. }
  169390. n1 = sessionSerialLen(a1);
  169391. if( pRet==0 ){
  169392. *pnVal = n1;
  169393. pRet = a1;
  169394. }
  169395. *paOne = &a1[n1];
  169396. return pRet;
  169397. }
  169398. /*
  169399. ** This function is used by changeset_concat() to merge two UPDATE changes
  169400. ** on the same row.
  169401. */
  169402. static int sessionMergeUpdate(
  169403. u8 **paOut, /* IN/OUT: Pointer to output buffer */
  169404. SessionTable *pTab, /* Table change pertains to */
  169405. int bPatchset, /* True if records are patchset records */
  169406. u8 *aOldRecord1, /* old.* record for first change */
  169407. u8 *aOldRecord2, /* old.* record for second change */
  169408. u8 *aNewRecord1, /* new.* record for first change */
  169409. u8 *aNewRecord2 /* new.* record for second change */
  169410. ){
  169411. u8 *aOld1 = aOldRecord1;
  169412. u8 *aOld2 = aOldRecord2;
  169413. u8 *aNew1 = aNewRecord1;
  169414. u8 *aNew2 = aNewRecord2;
  169415. u8 *aOut = *paOut;
  169416. int i;
  169417. if( bPatchset==0 ){
  169418. int bRequired = 0;
  169419. assert( aOldRecord1 && aNewRecord1 );
  169420. /* Write the old.* vector first. */
  169421. for(i=0; i<pTab->nCol; i++){
  169422. int nOld;
  169423. u8 *aOld;
  169424. int nNew;
  169425. u8 *aNew;
  169426. aOld = sessionMergeValue(&aOld1, &aOld2, &nOld);
  169427. aNew = sessionMergeValue(&aNew1, &aNew2, &nNew);
  169428. if( pTab->abPK[i] || nOld!=nNew || memcmp(aOld, aNew, nNew) ){
  169429. if( pTab->abPK[i]==0 ) bRequired = 1;
  169430. memcpy(aOut, aOld, nOld);
  169431. aOut += nOld;
  169432. }else{
  169433. *(aOut++) = '\0';
  169434. }
  169435. }
  169436. if( !bRequired ) return 0;
  169437. }
  169438. /* Write the new.* vector */
  169439. aOld1 = aOldRecord1;
  169440. aOld2 = aOldRecord2;
  169441. aNew1 = aNewRecord1;
  169442. aNew2 = aNewRecord2;
  169443. for(i=0; i<pTab->nCol; i++){
  169444. int nOld;
  169445. u8 *aOld;
  169446. int nNew;
  169447. u8 *aNew;
  169448. aOld = sessionMergeValue(&aOld1, &aOld2, &nOld);
  169449. aNew = sessionMergeValue(&aNew1, &aNew2, &nNew);
  169450. if( bPatchset==0
  169451. && (pTab->abPK[i] || (nOld==nNew && 0==memcmp(aOld, aNew, nNew)))
  169452. ){
  169453. *(aOut++) = '\0';
  169454. }else{
  169455. memcpy(aOut, aNew, nNew);
  169456. aOut += nNew;
  169457. }
  169458. }
  169459. *paOut = aOut;
  169460. return 1;
  169461. }
  169462. /*
  169463. ** This function is only called from within a pre-update-hook callback.
  169464. ** It determines if the current pre-update-hook change affects the same row
  169465. ** as the change stored in argument pChange. If so, it returns true. Otherwise
  169466. ** if the pre-update-hook does not affect the same row as pChange, it returns
  169467. ** false.
  169468. */
  169469. static int sessionPreupdateEqual(
  169470. sqlite3_session *pSession, /* Session object that owns SessionTable */
  169471. SessionTable *pTab, /* Table associated with change */
  169472. SessionChange *pChange, /* Change to compare to */
  169473. int op /* Current pre-update operation */
  169474. ){
  169475. int iCol; /* Used to iterate through columns */
  169476. u8 *a = pChange->aRecord; /* Cursor used to scan change record */
  169477. assert( op==SQLITE_INSERT || op==SQLITE_UPDATE || op==SQLITE_DELETE );
  169478. for(iCol=0; iCol<pTab->nCol; iCol++){
  169479. if( !pTab->abPK[iCol] ){
  169480. a += sessionSerialLen(a);
  169481. }else{
  169482. sqlite3_value *pVal; /* Value returned by preupdate_new/old */
  169483. int rc; /* Error code from preupdate_new/old */
  169484. int eType = *a++; /* Type of value from change record */
  169485. /* The following calls to preupdate_new() and preupdate_old() can not
  169486. ** fail. This is because they cache their return values, and by the
  169487. ** time control flows to here they have already been called once from
  169488. ** within sessionPreupdateHash(). The first two asserts below verify
  169489. ** this (that the method has already been called). */
  169490. if( op==SQLITE_INSERT ){
  169491. /* assert( db->pPreUpdate->pNewUnpacked || db->pPreUpdate->aNew ); */
  169492. rc = pSession->hook.xNew(pSession->hook.pCtx, iCol, &pVal);
  169493. }else{
  169494. /* assert( db->pPreUpdate->pUnpacked ); */
  169495. rc = pSession->hook.xOld(pSession->hook.pCtx, iCol, &pVal);
  169496. }
  169497. assert( rc==SQLITE_OK );
  169498. if( sqlite3_value_type(pVal)!=eType ) return 0;
  169499. /* A SessionChange object never has a NULL value in a PK column */
  169500. assert( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT
  169501. || eType==SQLITE_BLOB || eType==SQLITE_TEXT
  169502. );
  169503. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  169504. i64 iVal = sessionGetI64(a);
  169505. a += 8;
  169506. if( eType==SQLITE_INTEGER ){
  169507. if( sqlite3_value_int64(pVal)!=iVal ) return 0;
  169508. }else{
  169509. double rVal;
  169510. assert( sizeof(iVal)==8 && sizeof(rVal)==8 );
  169511. memcpy(&rVal, &iVal, 8);
  169512. if( sqlite3_value_double(pVal)!=rVal ) return 0;
  169513. }
  169514. }else{
  169515. int n;
  169516. const u8 *z;
  169517. a += sessionVarintGet(a, &n);
  169518. if( sqlite3_value_bytes(pVal)!=n ) return 0;
  169519. if( eType==SQLITE_TEXT ){
  169520. z = sqlite3_value_text(pVal);
  169521. }else{
  169522. z = sqlite3_value_blob(pVal);
  169523. }
  169524. if( n>0 && memcmp(a, z, n) ) return 0;
  169525. a += n;
  169526. }
  169527. }
  169528. }
  169529. return 1;
  169530. }
  169531. /*
  169532. ** If required, grow the hash table used to store changes on table pTab
  169533. ** (part of the session pSession). If a fatal OOM error occurs, set the
  169534. ** session object to failed and return SQLITE_ERROR. Otherwise, return
  169535. ** SQLITE_OK.
  169536. **
  169537. ** It is possible that a non-fatal OOM error occurs in this function. In
  169538. ** that case the hash-table does not grow, but SQLITE_OK is returned anyway.
  169539. ** Growing the hash table in this case is a performance optimization only,
  169540. ** it is not required for correct operation.
  169541. */
  169542. static int sessionGrowHash(int bPatchset, SessionTable *pTab){
  169543. if( pTab->nChange==0 || pTab->nEntry>=(pTab->nChange/2) ){
  169544. int i;
  169545. SessionChange **apNew;
  169546. int nNew = (pTab->nChange ? pTab->nChange : 128) * 2;
  169547. apNew = (SessionChange **)sqlite3_malloc(sizeof(SessionChange *) * nNew);
  169548. if( apNew==0 ){
  169549. if( pTab->nChange==0 ){
  169550. return SQLITE_ERROR;
  169551. }
  169552. return SQLITE_OK;
  169553. }
  169554. memset(apNew, 0, sizeof(SessionChange *) * nNew);
  169555. for(i=0; i<pTab->nChange; i++){
  169556. SessionChange *p;
  169557. SessionChange *pNext;
  169558. for(p=pTab->apChange[i]; p; p=pNext){
  169559. int bPkOnly = (p->op==SQLITE_DELETE && bPatchset);
  169560. int iHash = sessionChangeHash(pTab, bPkOnly, p->aRecord, nNew);
  169561. pNext = p->pNext;
  169562. p->pNext = apNew[iHash];
  169563. apNew[iHash] = p;
  169564. }
  169565. }
  169566. sqlite3_free(pTab->apChange);
  169567. pTab->nChange = nNew;
  169568. pTab->apChange = apNew;
  169569. }
  169570. return SQLITE_OK;
  169571. }
  169572. /*
  169573. ** This function queries the database for the names of the columns of table
  169574. ** zThis, in schema zDb.
  169575. **
  169576. ** Otherwise, if they are not NULL, variable *pnCol is set to the number
  169577. ** of columns in the database table and variable *pzTab is set to point to a
  169578. ** nul-terminated copy of the table name. *pazCol (if not NULL) is set to
  169579. ** point to an array of pointers to column names. And *pabPK (again, if not
  169580. ** NULL) is set to point to an array of booleans - true if the corresponding
  169581. ** column is part of the primary key.
  169582. **
  169583. ** For example, if the table is declared as:
  169584. **
  169585. ** CREATE TABLE tbl1(w, x, y, z, PRIMARY KEY(w, z));
  169586. **
  169587. ** Then the four output variables are populated as follows:
  169588. **
  169589. ** *pnCol = 4
  169590. ** *pzTab = "tbl1"
  169591. ** *pazCol = {"w", "x", "y", "z"}
  169592. ** *pabPK = {1, 0, 0, 1}
  169593. **
  169594. ** All returned buffers are part of the same single allocation, which must
  169595. ** be freed using sqlite3_free() by the caller
  169596. */
  169597. static int sessionTableInfo(
  169598. sqlite3 *db, /* Database connection */
  169599. const char *zDb, /* Name of attached database (e.g. "main") */
  169600. const char *zThis, /* Table name */
  169601. int *pnCol, /* OUT: number of columns */
  169602. const char **pzTab, /* OUT: Copy of zThis */
  169603. const char ***pazCol, /* OUT: Array of column names for table */
  169604. u8 **pabPK /* OUT: Array of booleans - true for PK col */
  169605. ){
  169606. char *zPragma;
  169607. sqlite3_stmt *pStmt;
  169608. int rc;
  169609. int nByte;
  169610. int nDbCol = 0;
  169611. int nThis;
  169612. int i;
  169613. u8 *pAlloc = 0;
  169614. char **azCol = 0;
  169615. u8 *abPK = 0;
  169616. assert( pazCol && pabPK );
  169617. nThis = sqlite3Strlen30(zThis);
  169618. if( nThis==12 && 0==sqlite3_stricmp("sqlite_stat1", zThis) ){
  169619. rc = sqlite3_table_column_metadata(db, zDb, zThis, 0, 0, 0, 0, 0, 0);
  169620. if( rc==SQLITE_OK ){
  169621. /* For sqlite_stat1, pretend that (tbl,idx) is the PRIMARY KEY. */
  169622. zPragma = sqlite3_mprintf(
  169623. "SELECT 0, 'tbl', '', 0, '', 1 UNION ALL "
  169624. "SELECT 1, 'idx', '', 0, '', 2 UNION ALL "
  169625. "SELECT 2, 'stat', '', 0, '', 0"
  169626. );
  169627. }else if( rc==SQLITE_ERROR ){
  169628. zPragma = sqlite3_mprintf("");
  169629. }else{
  169630. return rc;
  169631. }
  169632. }else{
  169633. zPragma = sqlite3_mprintf("PRAGMA '%q'.table_info('%q')", zDb, zThis);
  169634. }
  169635. if( !zPragma ) return SQLITE_NOMEM;
  169636. rc = sqlite3_prepare_v2(db, zPragma, -1, &pStmt, 0);
  169637. sqlite3_free(zPragma);
  169638. if( rc!=SQLITE_OK ) return rc;
  169639. nByte = nThis + 1;
  169640. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  169641. nByte += sqlite3_column_bytes(pStmt, 1);
  169642. nDbCol++;
  169643. }
  169644. rc = sqlite3_reset(pStmt);
  169645. if( rc==SQLITE_OK ){
  169646. nByte += nDbCol * (sizeof(const char *) + sizeof(u8) + 1);
  169647. pAlloc = sqlite3_malloc(nByte);
  169648. if( pAlloc==0 ){
  169649. rc = SQLITE_NOMEM;
  169650. }
  169651. }
  169652. if( rc==SQLITE_OK ){
  169653. azCol = (char **)pAlloc;
  169654. pAlloc = (u8 *)&azCol[nDbCol];
  169655. abPK = (u8 *)pAlloc;
  169656. pAlloc = &abPK[nDbCol];
  169657. if( pzTab ){
  169658. memcpy(pAlloc, zThis, nThis+1);
  169659. *pzTab = (char *)pAlloc;
  169660. pAlloc += nThis+1;
  169661. }
  169662. i = 0;
  169663. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  169664. int nName = sqlite3_column_bytes(pStmt, 1);
  169665. const unsigned char *zName = sqlite3_column_text(pStmt, 1);
  169666. if( zName==0 ) break;
  169667. memcpy(pAlloc, zName, nName+1);
  169668. azCol[i] = (char *)pAlloc;
  169669. pAlloc += nName+1;
  169670. abPK[i] = sqlite3_column_int(pStmt, 5);
  169671. i++;
  169672. }
  169673. rc = sqlite3_reset(pStmt);
  169674. }
  169675. /* If successful, populate the output variables. Otherwise, zero them and
  169676. ** free any allocation made. An error code will be returned in this case.
  169677. */
  169678. if( rc==SQLITE_OK ){
  169679. *pazCol = (const char **)azCol;
  169680. *pabPK = abPK;
  169681. *pnCol = nDbCol;
  169682. }else{
  169683. *pazCol = 0;
  169684. *pabPK = 0;
  169685. *pnCol = 0;
  169686. if( pzTab ) *pzTab = 0;
  169687. sqlite3_free(azCol);
  169688. }
  169689. sqlite3_finalize(pStmt);
  169690. return rc;
  169691. }
  169692. /*
  169693. ** This function is only called from within a pre-update handler for a
  169694. ** write to table pTab, part of session pSession. If this is the first
  169695. ** write to this table, initalize the SessionTable.nCol, azCol[] and
  169696. ** abPK[] arrays accordingly.
  169697. **
  169698. ** If an error occurs, an error code is stored in sqlite3_session.rc and
  169699. ** non-zero returned. Or, if no error occurs but the table has no primary
  169700. ** key, sqlite3_session.rc is left set to SQLITE_OK and non-zero returned to
  169701. ** indicate that updates on this table should be ignored. SessionTable.abPK
  169702. ** is set to NULL in this case.
  169703. */
  169704. static int sessionInitTable(sqlite3_session *pSession, SessionTable *pTab){
  169705. if( pTab->nCol==0 ){
  169706. u8 *abPK;
  169707. assert( pTab->azCol==0 || pTab->abPK==0 );
  169708. pSession->rc = sessionTableInfo(pSession->db, pSession->zDb,
  169709. pTab->zName, &pTab->nCol, 0, &pTab->azCol, &abPK
  169710. );
  169711. if( pSession->rc==SQLITE_OK ){
  169712. int i;
  169713. for(i=0; i<pTab->nCol; i++){
  169714. if( abPK[i] ){
  169715. pTab->abPK = abPK;
  169716. break;
  169717. }
  169718. }
  169719. if( 0==sqlite3_stricmp("sqlite_stat1", pTab->zName) ){
  169720. pTab->bStat1 = 1;
  169721. }
  169722. }
  169723. }
  169724. return (pSession->rc || pTab->abPK==0);
  169725. }
  169726. /*
  169727. ** Versions of the four methods in object SessionHook for use with the
  169728. ** sqlite_stat1 table. The purpose of this is to substitute a zero-length
  169729. ** blob each time a NULL value is read from the "idx" column of the
  169730. ** sqlite_stat1 table.
  169731. */
  169732. typedef struct SessionStat1Ctx SessionStat1Ctx;
  169733. struct SessionStat1Ctx {
  169734. SessionHook hook;
  169735. sqlite3_session *pSession;
  169736. };
  169737. static int sessionStat1Old(void *pCtx, int iCol, sqlite3_value **ppVal){
  169738. SessionStat1Ctx *p = (SessionStat1Ctx*)pCtx;
  169739. sqlite3_value *pVal = 0;
  169740. int rc = p->hook.xOld(p->hook.pCtx, iCol, &pVal);
  169741. if( rc==SQLITE_OK && iCol==1 && sqlite3_value_type(pVal)==SQLITE_NULL ){
  169742. pVal = p->pSession->pZeroBlob;
  169743. }
  169744. *ppVal = pVal;
  169745. return rc;
  169746. }
  169747. static int sessionStat1New(void *pCtx, int iCol, sqlite3_value **ppVal){
  169748. SessionStat1Ctx *p = (SessionStat1Ctx*)pCtx;
  169749. sqlite3_value *pVal = 0;
  169750. int rc = p->hook.xNew(p->hook.pCtx, iCol, &pVal);
  169751. if( rc==SQLITE_OK && iCol==1 && sqlite3_value_type(pVal)==SQLITE_NULL ){
  169752. pVal = p->pSession->pZeroBlob;
  169753. }
  169754. *ppVal = pVal;
  169755. return rc;
  169756. }
  169757. static int sessionStat1Count(void *pCtx){
  169758. SessionStat1Ctx *p = (SessionStat1Ctx*)pCtx;
  169759. return p->hook.xCount(p->hook.pCtx);
  169760. }
  169761. static int sessionStat1Depth(void *pCtx){
  169762. SessionStat1Ctx *p = (SessionStat1Ctx*)pCtx;
  169763. return p->hook.xDepth(p->hook.pCtx);
  169764. }
  169765. /*
  169766. ** This function is only called from with a pre-update-hook reporting a
  169767. ** change on table pTab (attached to session pSession). The type of change
  169768. ** (UPDATE, INSERT, DELETE) is specified by the first argument.
  169769. **
  169770. ** Unless one is already present or an error occurs, an entry is added
  169771. ** to the changed-rows hash table associated with table pTab.
  169772. */
  169773. static void sessionPreupdateOneChange(
  169774. int op, /* One of SQLITE_UPDATE, INSERT, DELETE */
  169775. sqlite3_session *pSession, /* Session object pTab is attached to */
  169776. SessionTable *pTab /* Table that change applies to */
  169777. ){
  169778. int iHash;
  169779. int bNull = 0;
  169780. int rc = SQLITE_OK;
  169781. SessionStat1Ctx stat1 = {0};
  169782. if( pSession->rc ) return;
  169783. /* Load table details if required */
  169784. if( sessionInitTable(pSession, pTab) ) return;
  169785. /* Check the number of columns in this xPreUpdate call matches the
  169786. ** number of columns in the table. */
  169787. if( pTab->nCol!=pSession->hook.xCount(pSession->hook.pCtx) ){
  169788. pSession->rc = SQLITE_SCHEMA;
  169789. return;
  169790. }
  169791. /* Grow the hash table if required */
  169792. if( sessionGrowHash(0, pTab) ){
  169793. pSession->rc = SQLITE_NOMEM;
  169794. return;
  169795. }
  169796. if( pTab->bStat1 ){
  169797. stat1.hook = pSession->hook;
  169798. stat1.pSession = pSession;
  169799. pSession->hook.pCtx = (void*)&stat1;
  169800. pSession->hook.xNew = sessionStat1New;
  169801. pSession->hook.xOld = sessionStat1Old;
  169802. pSession->hook.xCount = sessionStat1Count;
  169803. pSession->hook.xDepth = sessionStat1Depth;
  169804. if( pSession->pZeroBlob==0 ){
  169805. sqlite3_value *p = sqlite3ValueNew(0);
  169806. if( p==0 ){
  169807. rc = SQLITE_NOMEM;
  169808. goto error_out;
  169809. }
  169810. sqlite3ValueSetStr(p, 0, "", 0, SQLITE_STATIC);
  169811. pSession->pZeroBlob = p;
  169812. }
  169813. }
  169814. /* Calculate the hash-key for this change. If the primary key of the row
  169815. ** includes a NULL value, exit early. Such changes are ignored by the
  169816. ** session module. */
  169817. rc = sessionPreupdateHash(pSession, pTab, op==SQLITE_INSERT, &iHash, &bNull);
  169818. if( rc!=SQLITE_OK ) goto error_out;
  169819. if( bNull==0 ){
  169820. /* Search the hash table for an existing record for this row. */
  169821. SessionChange *pC;
  169822. for(pC=pTab->apChange[iHash]; pC; pC=pC->pNext){
  169823. if( sessionPreupdateEqual(pSession, pTab, pC, op) ) break;
  169824. }
  169825. if( pC==0 ){
  169826. /* Create a new change object containing all the old values (if
  169827. ** this is an SQLITE_UPDATE or SQLITE_DELETE), or just the PK
  169828. ** values (if this is an INSERT). */
  169829. SessionChange *pChange; /* New change object */
  169830. int nByte; /* Number of bytes to allocate */
  169831. int i; /* Used to iterate through columns */
  169832. assert( rc==SQLITE_OK );
  169833. pTab->nEntry++;
  169834. /* Figure out how large an allocation is required */
  169835. nByte = sizeof(SessionChange);
  169836. for(i=0; i<pTab->nCol; i++){
  169837. sqlite3_value *p = 0;
  169838. if( op!=SQLITE_INSERT ){
  169839. TESTONLY(int trc = ) pSession->hook.xOld(pSession->hook.pCtx, i, &p);
  169840. assert( trc==SQLITE_OK );
  169841. }else if( pTab->abPK[i] ){
  169842. TESTONLY(int trc = ) pSession->hook.xNew(pSession->hook.pCtx, i, &p);
  169843. assert( trc==SQLITE_OK );
  169844. }
  169845. /* This may fail if SQLite value p contains a utf-16 string that must
  169846. ** be converted to utf-8 and an OOM error occurs while doing so. */
  169847. rc = sessionSerializeValue(0, p, &nByte);
  169848. if( rc!=SQLITE_OK ) goto error_out;
  169849. }
  169850. /* Allocate the change object */
  169851. pChange = (SessionChange *)sqlite3_malloc(nByte);
  169852. if( !pChange ){
  169853. rc = SQLITE_NOMEM;
  169854. goto error_out;
  169855. }else{
  169856. memset(pChange, 0, sizeof(SessionChange));
  169857. pChange->aRecord = (u8 *)&pChange[1];
  169858. }
  169859. /* Populate the change object. None of the preupdate_old(),
  169860. ** preupdate_new() or SerializeValue() calls below may fail as all
  169861. ** required values and encodings have already been cached in memory.
  169862. ** It is not possible for an OOM to occur in this block. */
  169863. nByte = 0;
  169864. for(i=0; i<pTab->nCol; i++){
  169865. sqlite3_value *p = 0;
  169866. if( op!=SQLITE_INSERT ){
  169867. pSession->hook.xOld(pSession->hook.pCtx, i, &p);
  169868. }else if( pTab->abPK[i] ){
  169869. pSession->hook.xNew(pSession->hook.pCtx, i, &p);
  169870. }
  169871. sessionSerializeValue(&pChange->aRecord[nByte], p, &nByte);
  169872. }
  169873. /* Add the change to the hash-table */
  169874. if( pSession->bIndirect || pSession->hook.xDepth(pSession->hook.pCtx) ){
  169875. pChange->bIndirect = 1;
  169876. }
  169877. pChange->nRecord = nByte;
  169878. pChange->op = op;
  169879. pChange->pNext = pTab->apChange[iHash];
  169880. pTab->apChange[iHash] = pChange;
  169881. }else if( pC->bIndirect ){
  169882. /* If the existing change is considered "indirect", but this current
  169883. ** change is "direct", mark the change object as direct. */
  169884. if( pSession->hook.xDepth(pSession->hook.pCtx)==0
  169885. && pSession->bIndirect==0
  169886. ){
  169887. pC->bIndirect = 0;
  169888. }
  169889. }
  169890. }
  169891. /* If an error has occurred, mark the session object as failed. */
  169892. error_out:
  169893. if( pTab->bStat1 ){
  169894. pSession->hook = stat1.hook;
  169895. }
  169896. if( rc!=SQLITE_OK ){
  169897. pSession->rc = rc;
  169898. }
  169899. }
  169900. static int sessionFindTable(
  169901. sqlite3_session *pSession,
  169902. const char *zName,
  169903. SessionTable **ppTab
  169904. ){
  169905. int rc = SQLITE_OK;
  169906. int nName = sqlite3Strlen30(zName);
  169907. SessionTable *pRet;
  169908. /* Search for an existing table */
  169909. for(pRet=pSession->pTable; pRet; pRet=pRet->pNext){
  169910. if( 0==sqlite3_strnicmp(pRet->zName, zName, nName+1) ) break;
  169911. }
  169912. if( pRet==0 && pSession->bAutoAttach ){
  169913. /* If there is a table-filter configured, invoke it. If it returns 0,
  169914. ** do not automatically add the new table. */
  169915. if( pSession->xTableFilter==0
  169916. || pSession->xTableFilter(pSession->pFilterCtx, zName)
  169917. ){
  169918. rc = sqlite3session_attach(pSession, zName);
  169919. if( rc==SQLITE_OK ){
  169920. for(pRet=pSession->pTable; pRet->pNext; pRet=pRet->pNext);
  169921. assert( 0==sqlite3_strnicmp(pRet->zName, zName, nName+1) );
  169922. }
  169923. }
  169924. }
  169925. assert( rc==SQLITE_OK || pRet==0 );
  169926. *ppTab = pRet;
  169927. return rc;
  169928. }
  169929. /*
  169930. ** The 'pre-update' hook registered by this module with SQLite databases.
  169931. */
  169932. static void xPreUpdate(
  169933. void *pCtx, /* Copy of third arg to preupdate_hook() */
  169934. sqlite3 *db, /* Database handle */
  169935. int op, /* SQLITE_UPDATE, DELETE or INSERT */
  169936. char const *zDb, /* Database name */
  169937. char const *zName, /* Table name */
  169938. sqlite3_int64 iKey1, /* Rowid of row about to be deleted/updated */
  169939. sqlite3_int64 iKey2 /* New rowid value (for a rowid UPDATE) */
  169940. ){
  169941. sqlite3_session *pSession;
  169942. int nDb = sqlite3Strlen30(zDb);
  169943. assert( sqlite3_mutex_held(db->mutex) );
  169944. for(pSession=(sqlite3_session *)pCtx; pSession; pSession=pSession->pNext){
  169945. SessionTable *pTab;
  169946. /* If this session is attached to a different database ("main", "temp"
  169947. ** etc.), or if it is not currently enabled, there is nothing to do. Skip
  169948. ** to the next session object attached to this database. */
  169949. if( pSession->bEnable==0 ) continue;
  169950. if( pSession->rc ) continue;
  169951. if( sqlite3_strnicmp(zDb, pSession->zDb, nDb+1) ) continue;
  169952. pSession->rc = sessionFindTable(pSession, zName, &pTab);
  169953. if( pTab ){
  169954. assert( pSession->rc==SQLITE_OK );
  169955. sessionPreupdateOneChange(op, pSession, pTab);
  169956. if( op==SQLITE_UPDATE ){
  169957. sessionPreupdateOneChange(SQLITE_INSERT, pSession, pTab);
  169958. }
  169959. }
  169960. }
  169961. }
  169962. /*
  169963. ** The pre-update hook implementations.
  169964. */
  169965. static int sessionPreupdateOld(void *pCtx, int iVal, sqlite3_value **ppVal){
  169966. return sqlite3_preupdate_old((sqlite3*)pCtx, iVal, ppVal);
  169967. }
  169968. static int sessionPreupdateNew(void *pCtx, int iVal, sqlite3_value **ppVal){
  169969. return sqlite3_preupdate_new((sqlite3*)pCtx, iVal, ppVal);
  169970. }
  169971. static int sessionPreupdateCount(void *pCtx){
  169972. return sqlite3_preupdate_count((sqlite3*)pCtx);
  169973. }
  169974. static int sessionPreupdateDepth(void *pCtx){
  169975. return sqlite3_preupdate_depth((sqlite3*)pCtx);
  169976. }
  169977. /*
  169978. ** Install the pre-update hooks on the session object passed as the only
  169979. ** argument.
  169980. */
  169981. static void sessionPreupdateHooks(
  169982. sqlite3_session *pSession
  169983. ){
  169984. pSession->hook.pCtx = (void*)pSession->db;
  169985. pSession->hook.xOld = sessionPreupdateOld;
  169986. pSession->hook.xNew = sessionPreupdateNew;
  169987. pSession->hook.xCount = sessionPreupdateCount;
  169988. pSession->hook.xDepth = sessionPreupdateDepth;
  169989. }
  169990. typedef struct SessionDiffCtx SessionDiffCtx;
  169991. struct SessionDiffCtx {
  169992. sqlite3_stmt *pStmt;
  169993. int nOldOff;
  169994. };
  169995. /*
  169996. ** The diff hook implementations.
  169997. */
  169998. static int sessionDiffOld(void *pCtx, int iVal, sqlite3_value **ppVal){
  169999. SessionDiffCtx *p = (SessionDiffCtx*)pCtx;
  170000. *ppVal = sqlite3_column_value(p->pStmt, iVal+p->nOldOff);
  170001. return SQLITE_OK;
  170002. }
  170003. static int sessionDiffNew(void *pCtx, int iVal, sqlite3_value **ppVal){
  170004. SessionDiffCtx *p = (SessionDiffCtx*)pCtx;
  170005. *ppVal = sqlite3_column_value(p->pStmt, iVal);
  170006. return SQLITE_OK;
  170007. }
  170008. static int sessionDiffCount(void *pCtx){
  170009. SessionDiffCtx *p = (SessionDiffCtx*)pCtx;
  170010. return p->nOldOff ? p->nOldOff : sqlite3_column_count(p->pStmt);
  170011. }
  170012. static int sessionDiffDepth(void *pCtx){
  170013. return 0;
  170014. }
  170015. /*
  170016. ** Install the diff hooks on the session object passed as the only
  170017. ** argument.
  170018. */
  170019. static void sessionDiffHooks(
  170020. sqlite3_session *pSession,
  170021. SessionDiffCtx *pDiffCtx
  170022. ){
  170023. pSession->hook.pCtx = (void*)pDiffCtx;
  170024. pSession->hook.xOld = sessionDiffOld;
  170025. pSession->hook.xNew = sessionDiffNew;
  170026. pSession->hook.xCount = sessionDiffCount;
  170027. pSession->hook.xDepth = sessionDiffDepth;
  170028. }
  170029. static char *sessionExprComparePK(
  170030. int nCol,
  170031. const char *zDb1, const char *zDb2,
  170032. const char *zTab,
  170033. const char **azCol, u8 *abPK
  170034. ){
  170035. int i;
  170036. const char *zSep = "";
  170037. char *zRet = 0;
  170038. for(i=0; i<nCol; i++){
  170039. if( abPK[i] ){
  170040. zRet = sqlite3_mprintf("%z%s\"%w\".\"%w\".\"%w\"=\"%w\".\"%w\".\"%w\"",
  170041. zRet, zSep, zDb1, zTab, azCol[i], zDb2, zTab, azCol[i]
  170042. );
  170043. zSep = " AND ";
  170044. if( zRet==0 ) break;
  170045. }
  170046. }
  170047. return zRet;
  170048. }
  170049. static char *sessionExprCompareOther(
  170050. int nCol,
  170051. const char *zDb1, const char *zDb2,
  170052. const char *zTab,
  170053. const char **azCol, u8 *abPK
  170054. ){
  170055. int i;
  170056. const char *zSep = "";
  170057. char *zRet = 0;
  170058. int bHave = 0;
  170059. for(i=0; i<nCol; i++){
  170060. if( abPK[i]==0 ){
  170061. bHave = 1;
  170062. zRet = sqlite3_mprintf(
  170063. "%z%s\"%w\".\"%w\".\"%w\" IS NOT \"%w\".\"%w\".\"%w\"",
  170064. zRet, zSep, zDb1, zTab, azCol[i], zDb2, zTab, azCol[i]
  170065. );
  170066. zSep = " OR ";
  170067. if( zRet==0 ) break;
  170068. }
  170069. }
  170070. if( bHave==0 ){
  170071. assert( zRet==0 );
  170072. zRet = sqlite3_mprintf("0");
  170073. }
  170074. return zRet;
  170075. }
  170076. static char *sessionSelectFindNew(
  170077. int nCol,
  170078. const char *zDb1, /* Pick rows in this db only */
  170079. const char *zDb2, /* But not in this one */
  170080. const char *zTbl, /* Table name */
  170081. const char *zExpr
  170082. ){
  170083. char *zRet = sqlite3_mprintf(
  170084. "SELECT * FROM \"%w\".\"%w\" WHERE NOT EXISTS ("
  170085. " SELECT 1 FROM \"%w\".\"%w\" WHERE %s"
  170086. ")",
  170087. zDb1, zTbl, zDb2, zTbl, zExpr
  170088. );
  170089. return zRet;
  170090. }
  170091. static int sessionDiffFindNew(
  170092. int op,
  170093. sqlite3_session *pSession,
  170094. SessionTable *pTab,
  170095. const char *zDb1,
  170096. const char *zDb2,
  170097. char *zExpr
  170098. ){
  170099. int rc = SQLITE_OK;
  170100. char *zStmt = sessionSelectFindNew(pTab->nCol, zDb1, zDb2, pTab->zName,zExpr);
  170101. if( zStmt==0 ){
  170102. rc = SQLITE_NOMEM;
  170103. }else{
  170104. sqlite3_stmt *pStmt;
  170105. rc = sqlite3_prepare(pSession->db, zStmt, -1, &pStmt, 0);
  170106. if( rc==SQLITE_OK ){
  170107. SessionDiffCtx *pDiffCtx = (SessionDiffCtx*)pSession->hook.pCtx;
  170108. pDiffCtx->pStmt = pStmt;
  170109. pDiffCtx->nOldOff = 0;
  170110. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  170111. sessionPreupdateOneChange(op, pSession, pTab);
  170112. }
  170113. rc = sqlite3_finalize(pStmt);
  170114. }
  170115. sqlite3_free(zStmt);
  170116. }
  170117. return rc;
  170118. }
  170119. static int sessionDiffFindModified(
  170120. sqlite3_session *pSession,
  170121. SessionTable *pTab,
  170122. const char *zFrom,
  170123. const char *zExpr
  170124. ){
  170125. int rc = SQLITE_OK;
  170126. char *zExpr2 = sessionExprCompareOther(pTab->nCol,
  170127. pSession->zDb, zFrom, pTab->zName, pTab->azCol, pTab->abPK
  170128. );
  170129. if( zExpr2==0 ){
  170130. rc = SQLITE_NOMEM;
  170131. }else{
  170132. char *zStmt = sqlite3_mprintf(
  170133. "SELECT * FROM \"%w\".\"%w\", \"%w\".\"%w\" WHERE %s AND (%z)",
  170134. pSession->zDb, pTab->zName, zFrom, pTab->zName, zExpr, zExpr2
  170135. );
  170136. if( zStmt==0 ){
  170137. rc = SQLITE_NOMEM;
  170138. }else{
  170139. sqlite3_stmt *pStmt;
  170140. rc = sqlite3_prepare(pSession->db, zStmt, -1, &pStmt, 0);
  170141. if( rc==SQLITE_OK ){
  170142. SessionDiffCtx *pDiffCtx = (SessionDiffCtx*)pSession->hook.pCtx;
  170143. pDiffCtx->pStmt = pStmt;
  170144. pDiffCtx->nOldOff = pTab->nCol;
  170145. while( SQLITE_ROW==sqlite3_step(pStmt) ){
  170146. sessionPreupdateOneChange(SQLITE_UPDATE, pSession, pTab);
  170147. }
  170148. rc = sqlite3_finalize(pStmt);
  170149. }
  170150. sqlite3_free(zStmt);
  170151. }
  170152. }
  170153. return rc;
  170154. }
  170155. SQLITE_API int sqlite3session_diff(
  170156. sqlite3_session *pSession,
  170157. const char *zFrom,
  170158. const char *zTbl,
  170159. char **pzErrMsg
  170160. ){
  170161. const char *zDb = pSession->zDb;
  170162. int rc = pSession->rc;
  170163. SessionDiffCtx d;
  170164. memset(&d, 0, sizeof(d));
  170165. sessionDiffHooks(pSession, &d);
  170166. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  170167. if( pzErrMsg ) *pzErrMsg = 0;
  170168. if( rc==SQLITE_OK ){
  170169. char *zExpr = 0;
  170170. sqlite3 *db = pSession->db;
  170171. SessionTable *pTo; /* Table zTbl */
  170172. /* Locate and if necessary initialize the target table object */
  170173. rc = sessionFindTable(pSession, zTbl, &pTo);
  170174. if( pTo==0 ) goto diff_out;
  170175. if( sessionInitTable(pSession, pTo) ){
  170176. rc = pSession->rc;
  170177. goto diff_out;
  170178. }
  170179. /* Check the table schemas match */
  170180. if( rc==SQLITE_OK ){
  170181. int bHasPk = 0;
  170182. int bMismatch = 0;
  170183. int nCol; /* Columns in zFrom.zTbl */
  170184. u8 *abPK;
  170185. const char **azCol = 0;
  170186. rc = sessionTableInfo(db, zFrom, zTbl, &nCol, 0, &azCol, &abPK);
  170187. if( rc==SQLITE_OK ){
  170188. if( pTo->nCol!=nCol ){
  170189. bMismatch = 1;
  170190. }else{
  170191. int i;
  170192. for(i=0; i<nCol; i++){
  170193. if( pTo->abPK[i]!=abPK[i] ) bMismatch = 1;
  170194. if( sqlite3_stricmp(azCol[i], pTo->azCol[i]) ) bMismatch = 1;
  170195. if( abPK[i] ) bHasPk = 1;
  170196. }
  170197. }
  170198. }
  170199. sqlite3_free((char*)azCol);
  170200. if( bMismatch ){
  170201. *pzErrMsg = sqlite3_mprintf("table schemas do not match");
  170202. rc = SQLITE_SCHEMA;
  170203. }
  170204. if( bHasPk==0 ){
  170205. /* Ignore tables with no primary keys */
  170206. goto diff_out;
  170207. }
  170208. }
  170209. if( rc==SQLITE_OK ){
  170210. zExpr = sessionExprComparePK(pTo->nCol,
  170211. zDb, zFrom, pTo->zName, pTo->azCol, pTo->abPK
  170212. );
  170213. }
  170214. /* Find new rows */
  170215. if( rc==SQLITE_OK ){
  170216. rc = sessionDiffFindNew(SQLITE_INSERT, pSession, pTo, zDb, zFrom, zExpr);
  170217. }
  170218. /* Find old rows */
  170219. if( rc==SQLITE_OK ){
  170220. rc = sessionDiffFindNew(SQLITE_DELETE, pSession, pTo, zFrom, zDb, zExpr);
  170221. }
  170222. /* Find modified rows */
  170223. if( rc==SQLITE_OK ){
  170224. rc = sessionDiffFindModified(pSession, pTo, zFrom, zExpr);
  170225. }
  170226. sqlite3_free(zExpr);
  170227. }
  170228. diff_out:
  170229. sessionPreupdateHooks(pSession);
  170230. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  170231. return rc;
  170232. }
  170233. /*
  170234. ** Create a session object. This session object will record changes to
  170235. ** database zDb attached to connection db.
  170236. */
  170237. SQLITE_API int sqlite3session_create(
  170238. sqlite3 *db, /* Database handle */
  170239. const char *zDb, /* Name of db (e.g. "main") */
  170240. sqlite3_session **ppSession /* OUT: New session object */
  170241. ){
  170242. sqlite3_session *pNew; /* Newly allocated session object */
  170243. sqlite3_session *pOld; /* Session object already attached to db */
  170244. int nDb = sqlite3Strlen30(zDb); /* Length of zDb in bytes */
  170245. /* Zero the output value in case an error occurs. */
  170246. *ppSession = 0;
  170247. /* Allocate and populate the new session object. */
  170248. pNew = (sqlite3_session *)sqlite3_malloc(sizeof(sqlite3_session) + nDb + 1);
  170249. if( !pNew ) return SQLITE_NOMEM;
  170250. memset(pNew, 0, sizeof(sqlite3_session));
  170251. pNew->db = db;
  170252. pNew->zDb = (char *)&pNew[1];
  170253. pNew->bEnable = 1;
  170254. memcpy(pNew->zDb, zDb, nDb+1);
  170255. sessionPreupdateHooks(pNew);
  170256. /* Add the new session object to the linked list of session objects
  170257. ** attached to database handle $db. Do this under the cover of the db
  170258. ** handle mutex. */
  170259. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  170260. pOld = (sqlite3_session*)sqlite3_preupdate_hook(db, xPreUpdate, (void*)pNew);
  170261. pNew->pNext = pOld;
  170262. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  170263. *ppSession = pNew;
  170264. return SQLITE_OK;
  170265. }
  170266. /*
  170267. ** Free the list of table objects passed as the first argument. The contents
  170268. ** of the changed-rows hash tables are also deleted.
  170269. */
  170270. static void sessionDeleteTable(SessionTable *pList){
  170271. SessionTable *pNext;
  170272. SessionTable *pTab;
  170273. for(pTab=pList; pTab; pTab=pNext){
  170274. int i;
  170275. pNext = pTab->pNext;
  170276. for(i=0; i<pTab->nChange; i++){
  170277. SessionChange *p;
  170278. SessionChange *pNextChange;
  170279. for(p=pTab->apChange[i]; p; p=pNextChange){
  170280. pNextChange = p->pNext;
  170281. sqlite3_free(p);
  170282. }
  170283. }
  170284. sqlite3_free((char*)pTab->azCol); /* cast works around VC++ bug */
  170285. sqlite3_free(pTab->apChange);
  170286. sqlite3_free(pTab);
  170287. }
  170288. }
  170289. /*
  170290. ** Delete a session object previously allocated using sqlite3session_create().
  170291. */
  170292. SQLITE_API void sqlite3session_delete(sqlite3_session *pSession){
  170293. sqlite3 *db = pSession->db;
  170294. sqlite3_session *pHead;
  170295. sqlite3_session **pp;
  170296. /* Unlink the session from the linked list of sessions attached to the
  170297. ** database handle. Hold the db mutex while doing so. */
  170298. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  170299. pHead = (sqlite3_session*)sqlite3_preupdate_hook(db, 0, 0);
  170300. for(pp=&pHead; ALWAYS((*pp)!=0); pp=&((*pp)->pNext)){
  170301. if( (*pp)==pSession ){
  170302. *pp = (*pp)->pNext;
  170303. if( pHead ) sqlite3_preupdate_hook(db, xPreUpdate, (void*)pHead);
  170304. break;
  170305. }
  170306. }
  170307. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  170308. sqlite3ValueFree(pSession->pZeroBlob);
  170309. /* Delete all attached table objects. And the contents of their
  170310. ** associated hash-tables. */
  170311. sessionDeleteTable(pSession->pTable);
  170312. /* Free the session object itself. */
  170313. sqlite3_free(pSession);
  170314. }
  170315. /*
  170316. ** Set a table filter on a Session Object.
  170317. */
  170318. SQLITE_API void sqlite3session_table_filter(
  170319. sqlite3_session *pSession,
  170320. int(*xFilter)(void*, const char*),
  170321. void *pCtx /* First argument passed to xFilter */
  170322. ){
  170323. pSession->bAutoAttach = 1;
  170324. pSession->pFilterCtx = pCtx;
  170325. pSession->xTableFilter = xFilter;
  170326. }
  170327. /*
  170328. ** Attach a table to a session. All subsequent changes made to the table
  170329. ** while the session object is enabled will be recorded.
  170330. **
  170331. ** Only tables that have a PRIMARY KEY defined may be attached. It does
  170332. ** not matter if the PRIMARY KEY is an "INTEGER PRIMARY KEY" (rowid alias)
  170333. ** or not.
  170334. */
  170335. SQLITE_API int sqlite3session_attach(
  170336. sqlite3_session *pSession, /* Session object */
  170337. const char *zName /* Table name */
  170338. ){
  170339. int rc = SQLITE_OK;
  170340. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  170341. if( !zName ){
  170342. pSession->bAutoAttach = 1;
  170343. }else{
  170344. SessionTable *pTab; /* New table object (if required) */
  170345. int nName; /* Number of bytes in string zName */
  170346. /* First search for an existing entry. If one is found, this call is
  170347. ** a no-op. Return early. */
  170348. nName = sqlite3Strlen30(zName);
  170349. for(pTab=pSession->pTable; pTab; pTab=pTab->pNext){
  170350. if( 0==sqlite3_strnicmp(pTab->zName, zName, nName+1) ) break;
  170351. }
  170352. if( !pTab ){
  170353. /* Allocate new SessionTable object. */
  170354. pTab = (SessionTable *)sqlite3_malloc(sizeof(SessionTable) + nName + 1);
  170355. if( !pTab ){
  170356. rc = SQLITE_NOMEM;
  170357. }else{
  170358. /* Populate the new SessionTable object and link it into the list.
  170359. ** The new object must be linked onto the end of the list, not
  170360. ** simply added to the start of it in order to ensure that tables
  170361. ** appear in the correct order when a changeset or patchset is
  170362. ** eventually generated. */
  170363. SessionTable **ppTab;
  170364. memset(pTab, 0, sizeof(SessionTable));
  170365. pTab->zName = (char *)&pTab[1];
  170366. memcpy(pTab->zName, zName, nName+1);
  170367. for(ppTab=&pSession->pTable; *ppTab; ppTab=&(*ppTab)->pNext);
  170368. *ppTab = pTab;
  170369. }
  170370. }
  170371. }
  170372. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  170373. return rc;
  170374. }
  170375. /*
  170376. ** Ensure that there is room in the buffer to append nByte bytes of data.
  170377. ** If not, use sqlite3_realloc() to grow the buffer so that there is.
  170378. **
  170379. ** If successful, return zero. Otherwise, if an OOM condition is encountered,
  170380. ** set *pRc to SQLITE_NOMEM and return non-zero.
  170381. */
  170382. static int sessionBufferGrow(SessionBuffer *p, int nByte, int *pRc){
  170383. if( *pRc==SQLITE_OK && p->nAlloc-p->nBuf<nByte ){
  170384. u8 *aNew;
  170385. int nNew = p->nAlloc ? p->nAlloc : 128;
  170386. do {
  170387. nNew = nNew*2;
  170388. }while( nNew<(p->nBuf+nByte) );
  170389. aNew = (u8 *)sqlite3_realloc(p->aBuf, nNew);
  170390. if( 0==aNew ){
  170391. *pRc = SQLITE_NOMEM;
  170392. }else{
  170393. p->aBuf = aNew;
  170394. p->nAlloc = nNew;
  170395. }
  170396. }
  170397. return (*pRc!=SQLITE_OK);
  170398. }
  170399. /*
  170400. ** Append the value passed as the second argument to the buffer passed
  170401. ** as the first.
  170402. **
  170403. ** This function is a no-op if *pRc is non-zero when it is called.
  170404. ** Otherwise, if an error occurs, *pRc is set to an SQLite error code
  170405. ** before returning.
  170406. */
  170407. static void sessionAppendValue(SessionBuffer *p, sqlite3_value *pVal, int *pRc){
  170408. int rc = *pRc;
  170409. if( rc==SQLITE_OK ){
  170410. int nByte = 0;
  170411. rc = sessionSerializeValue(0, pVal, &nByte);
  170412. sessionBufferGrow(p, nByte, &rc);
  170413. if( rc==SQLITE_OK ){
  170414. rc = sessionSerializeValue(&p->aBuf[p->nBuf], pVal, 0);
  170415. p->nBuf += nByte;
  170416. }else{
  170417. *pRc = rc;
  170418. }
  170419. }
  170420. }
  170421. /*
  170422. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170423. ** called. Otherwise, append a single byte to the buffer.
  170424. **
  170425. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  170426. ** returning.
  170427. */
  170428. static void sessionAppendByte(SessionBuffer *p, u8 v, int *pRc){
  170429. if( 0==sessionBufferGrow(p, 1, pRc) ){
  170430. p->aBuf[p->nBuf++] = v;
  170431. }
  170432. }
  170433. /*
  170434. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170435. ** called. Otherwise, append a single varint to the buffer.
  170436. **
  170437. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  170438. ** returning.
  170439. */
  170440. static void sessionAppendVarint(SessionBuffer *p, int v, int *pRc){
  170441. if( 0==sessionBufferGrow(p, 9, pRc) ){
  170442. p->nBuf += sessionVarintPut(&p->aBuf[p->nBuf], v);
  170443. }
  170444. }
  170445. /*
  170446. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170447. ** called. Otherwise, append a blob of data to the buffer.
  170448. **
  170449. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  170450. ** returning.
  170451. */
  170452. static void sessionAppendBlob(
  170453. SessionBuffer *p,
  170454. const u8 *aBlob,
  170455. int nBlob,
  170456. int *pRc
  170457. ){
  170458. if( nBlob>0 && 0==sessionBufferGrow(p, nBlob, pRc) ){
  170459. memcpy(&p->aBuf[p->nBuf], aBlob, nBlob);
  170460. p->nBuf += nBlob;
  170461. }
  170462. }
  170463. /*
  170464. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170465. ** called. Otherwise, append a string to the buffer. All bytes in the string
  170466. ** up to (but not including) the nul-terminator are written to the buffer.
  170467. **
  170468. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  170469. ** returning.
  170470. */
  170471. static void sessionAppendStr(
  170472. SessionBuffer *p,
  170473. const char *zStr,
  170474. int *pRc
  170475. ){
  170476. int nStr = sqlite3Strlen30(zStr);
  170477. if( 0==sessionBufferGrow(p, nStr, pRc) ){
  170478. memcpy(&p->aBuf[p->nBuf], zStr, nStr);
  170479. p->nBuf += nStr;
  170480. }
  170481. }
  170482. /*
  170483. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170484. ** called. Otherwise, append the string representation of integer iVal
  170485. ** to the buffer. No nul-terminator is written.
  170486. **
  170487. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  170488. ** returning.
  170489. */
  170490. static void sessionAppendInteger(
  170491. SessionBuffer *p, /* Buffer to append to */
  170492. int iVal, /* Value to write the string rep. of */
  170493. int *pRc /* IN/OUT: Error code */
  170494. ){
  170495. char aBuf[24];
  170496. sqlite3_snprintf(sizeof(aBuf)-1, aBuf, "%d", iVal);
  170497. sessionAppendStr(p, aBuf, pRc);
  170498. }
  170499. /*
  170500. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170501. ** called. Otherwise, append the string zStr enclosed in quotes (") and
  170502. ** with any embedded quote characters escaped to the buffer. No
  170503. ** nul-terminator byte is written.
  170504. **
  170505. ** If an OOM condition is encountered, set *pRc to SQLITE_NOMEM before
  170506. ** returning.
  170507. */
  170508. static void sessionAppendIdent(
  170509. SessionBuffer *p, /* Buffer to a append to */
  170510. const char *zStr, /* String to quote, escape and append */
  170511. int *pRc /* IN/OUT: Error code */
  170512. ){
  170513. int nStr = sqlite3Strlen30(zStr)*2 + 2 + 1;
  170514. if( 0==sessionBufferGrow(p, nStr, pRc) ){
  170515. char *zOut = (char *)&p->aBuf[p->nBuf];
  170516. const char *zIn = zStr;
  170517. *zOut++ = '"';
  170518. while( *zIn ){
  170519. if( *zIn=='"' ) *zOut++ = '"';
  170520. *zOut++ = *(zIn++);
  170521. }
  170522. *zOut++ = '"';
  170523. p->nBuf = (int)((u8 *)zOut - p->aBuf);
  170524. }
  170525. }
  170526. /*
  170527. ** This function is a no-op if *pRc is other than SQLITE_OK when it is
  170528. ** called. Otherwse, it appends the serialized version of the value stored
  170529. ** in column iCol of the row that SQL statement pStmt currently points
  170530. ** to to the buffer.
  170531. */
  170532. static void sessionAppendCol(
  170533. SessionBuffer *p, /* Buffer to append to */
  170534. sqlite3_stmt *pStmt, /* Handle pointing to row containing value */
  170535. int iCol, /* Column to read value from */
  170536. int *pRc /* IN/OUT: Error code */
  170537. ){
  170538. if( *pRc==SQLITE_OK ){
  170539. int eType = sqlite3_column_type(pStmt, iCol);
  170540. sessionAppendByte(p, (u8)eType, pRc);
  170541. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  170542. sqlite3_int64 i;
  170543. u8 aBuf[8];
  170544. if( eType==SQLITE_INTEGER ){
  170545. i = sqlite3_column_int64(pStmt, iCol);
  170546. }else{
  170547. double r = sqlite3_column_double(pStmt, iCol);
  170548. memcpy(&i, &r, 8);
  170549. }
  170550. sessionPutI64(aBuf, i);
  170551. sessionAppendBlob(p, aBuf, 8, pRc);
  170552. }
  170553. if( eType==SQLITE_BLOB || eType==SQLITE_TEXT ){
  170554. u8 *z;
  170555. int nByte;
  170556. if( eType==SQLITE_BLOB ){
  170557. z = (u8 *)sqlite3_column_blob(pStmt, iCol);
  170558. }else{
  170559. z = (u8 *)sqlite3_column_text(pStmt, iCol);
  170560. }
  170561. nByte = sqlite3_column_bytes(pStmt, iCol);
  170562. if( z || (eType==SQLITE_BLOB && nByte==0) ){
  170563. sessionAppendVarint(p, nByte, pRc);
  170564. sessionAppendBlob(p, z, nByte, pRc);
  170565. }else{
  170566. *pRc = SQLITE_NOMEM;
  170567. }
  170568. }
  170569. }
  170570. }
  170571. /*
  170572. **
  170573. ** This function appends an update change to the buffer (see the comments
  170574. ** under "CHANGESET FORMAT" at the top of the file). An update change
  170575. ** consists of:
  170576. **
  170577. ** 1 byte: SQLITE_UPDATE (0x17)
  170578. ** n bytes: old.* record (see RECORD FORMAT)
  170579. ** m bytes: new.* record (see RECORD FORMAT)
  170580. **
  170581. ** The SessionChange object passed as the third argument contains the
  170582. ** values that were stored in the row when the session began (the old.*
  170583. ** values). The statement handle passed as the second argument points
  170584. ** at the current version of the row (the new.* values).
  170585. **
  170586. ** If all of the old.* values are equal to their corresponding new.* value
  170587. ** (i.e. nothing has changed), then no data at all is appended to the buffer.
  170588. **
  170589. ** Otherwise, the old.* record contains all primary key values and the
  170590. ** original values of any fields that have been modified. The new.* record
  170591. ** contains the new values of only those fields that have been modified.
  170592. */
  170593. static int sessionAppendUpdate(
  170594. SessionBuffer *pBuf, /* Buffer to append to */
  170595. int bPatchset, /* True for "patchset", 0 for "changeset" */
  170596. sqlite3_stmt *pStmt, /* Statement handle pointing at new row */
  170597. SessionChange *p, /* Object containing old values */
  170598. u8 *abPK /* Boolean array - true for PK columns */
  170599. ){
  170600. int rc = SQLITE_OK;
  170601. SessionBuffer buf2 = {0,0,0}; /* Buffer to accumulate new.* record in */
  170602. int bNoop = 1; /* Set to zero if any values are modified */
  170603. int nRewind = pBuf->nBuf; /* Set to zero if any values are modified */
  170604. int i; /* Used to iterate through columns */
  170605. u8 *pCsr = p->aRecord; /* Used to iterate through old.* values */
  170606. sessionAppendByte(pBuf, SQLITE_UPDATE, &rc);
  170607. sessionAppendByte(pBuf, p->bIndirect, &rc);
  170608. for(i=0; i<sqlite3_column_count(pStmt); i++){
  170609. int bChanged = 0;
  170610. int nAdvance;
  170611. int eType = *pCsr;
  170612. switch( eType ){
  170613. case SQLITE_NULL:
  170614. nAdvance = 1;
  170615. if( sqlite3_column_type(pStmt, i)!=SQLITE_NULL ){
  170616. bChanged = 1;
  170617. }
  170618. break;
  170619. case SQLITE_FLOAT:
  170620. case SQLITE_INTEGER: {
  170621. nAdvance = 9;
  170622. if( eType==sqlite3_column_type(pStmt, i) ){
  170623. sqlite3_int64 iVal = sessionGetI64(&pCsr[1]);
  170624. if( eType==SQLITE_INTEGER ){
  170625. if( iVal==sqlite3_column_int64(pStmt, i) ) break;
  170626. }else{
  170627. double dVal;
  170628. memcpy(&dVal, &iVal, 8);
  170629. if( dVal==sqlite3_column_double(pStmt, i) ) break;
  170630. }
  170631. }
  170632. bChanged = 1;
  170633. break;
  170634. }
  170635. default: {
  170636. int n;
  170637. int nHdr = 1 + sessionVarintGet(&pCsr[1], &n);
  170638. assert( eType==SQLITE_TEXT || eType==SQLITE_BLOB );
  170639. nAdvance = nHdr + n;
  170640. if( eType==sqlite3_column_type(pStmt, i)
  170641. && n==sqlite3_column_bytes(pStmt, i)
  170642. && (n==0 || 0==memcmp(&pCsr[nHdr], sqlite3_column_blob(pStmt, i), n))
  170643. ){
  170644. break;
  170645. }
  170646. bChanged = 1;
  170647. }
  170648. }
  170649. /* If at least one field has been modified, this is not a no-op. */
  170650. if( bChanged ) bNoop = 0;
  170651. /* Add a field to the old.* record. This is omitted if this modules is
  170652. ** currently generating a patchset. */
  170653. if( bPatchset==0 ){
  170654. if( bChanged || abPK[i] ){
  170655. sessionAppendBlob(pBuf, pCsr, nAdvance, &rc);
  170656. }else{
  170657. sessionAppendByte(pBuf, 0, &rc);
  170658. }
  170659. }
  170660. /* Add a field to the new.* record. Or the only record if currently
  170661. ** generating a patchset. */
  170662. if( bChanged || (bPatchset && abPK[i]) ){
  170663. sessionAppendCol(&buf2, pStmt, i, &rc);
  170664. }else{
  170665. sessionAppendByte(&buf2, 0, &rc);
  170666. }
  170667. pCsr += nAdvance;
  170668. }
  170669. if( bNoop ){
  170670. pBuf->nBuf = nRewind;
  170671. }else{
  170672. sessionAppendBlob(pBuf, buf2.aBuf, buf2.nBuf, &rc);
  170673. }
  170674. sqlite3_free(buf2.aBuf);
  170675. return rc;
  170676. }
  170677. /*
  170678. ** Append a DELETE change to the buffer passed as the first argument. Use
  170679. ** the changeset format if argument bPatchset is zero, or the patchset
  170680. ** format otherwise.
  170681. */
  170682. static int sessionAppendDelete(
  170683. SessionBuffer *pBuf, /* Buffer to append to */
  170684. int bPatchset, /* True for "patchset", 0 for "changeset" */
  170685. SessionChange *p, /* Object containing old values */
  170686. int nCol, /* Number of columns in table */
  170687. u8 *abPK /* Boolean array - true for PK columns */
  170688. ){
  170689. int rc = SQLITE_OK;
  170690. sessionAppendByte(pBuf, SQLITE_DELETE, &rc);
  170691. sessionAppendByte(pBuf, p->bIndirect, &rc);
  170692. if( bPatchset==0 ){
  170693. sessionAppendBlob(pBuf, p->aRecord, p->nRecord, &rc);
  170694. }else{
  170695. int i;
  170696. u8 *a = p->aRecord;
  170697. for(i=0; i<nCol; i++){
  170698. u8 *pStart = a;
  170699. int eType = *a++;
  170700. switch( eType ){
  170701. case 0:
  170702. case SQLITE_NULL:
  170703. assert( abPK[i]==0 );
  170704. break;
  170705. case SQLITE_FLOAT:
  170706. case SQLITE_INTEGER:
  170707. a += 8;
  170708. break;
  170709. default: {
  170710. int n;
  170711. a += sessionVarintGet(a, &n);
  170712. a += n;
  170713. break;
  170714. }
  170715. }
  170716. if( abPK[i] ){
  170717. sessionAppendBlob(pBuf, pStart, (int)(a-pStart), &rc);
  170718. }
  170719. }
  170720. assert( (a - p->aRecord)==p->nRecord );
  170721. }
  170722. return rc;
  170723. }
  170724. /*
  170725. ** Formulate and prepare a SELECT statement to retrieve a row from table
  170726. ** zTab in database zDb based on its primary key. i.e.
  170727. **
  170728. ** SELECT * FROM zDb.zTab WHERE pk1 = ? AND pk2 = ? AND ...
  170729. */
  170730. static int sessionSelectStmt(
  170731. sqlite3 *db, /* Database handle */
  170732. const char *zDb, /* Database name */
  170733. const char *zTab, /* Table name */
  170734. int nCol, /* Number of columns in table */
  170735. const char **azCol, /* Names of table columns */
  170736. u8 *abPK, /* PRIMARY KEY array */
  170737. sqlite3_stmt **ppStmt /* OUT: Prepared SELECT statement */
  170738. ){
  170739. int rc = SQLITE_OK;
  170740. char *zSql = 0;
  170741. int nSql = -1;
  170742. if( 0==sqlite3_stricmp("sqlite_stat1", zTab) ){
  170743. zSql = sqlite3_mprintf(
  170744. "SELECT tbl, ?2, stat FROM %Q.sqlite_stat1 WHERE tbl IS ?1 AND "
  170745. "idx IS (CASE WHEN ?2=X'' THEN NULL ELSE ?2 END)", zDb
  170746. );
  170747. if( zSql==0 ) rc = SQLITE_NOMEM;
  170748. }else{
  170749. int i;
  170750. const char *zSep = "";
  170751. SessionBuffer buf = {0, 0, 0};
  170752. sessionAppendStr(&buf, "SELECT * FROM ", &rc);
  170753. sessionAppendIdent(&buf, zDb, &rc);
  170754. sessionAppendStr(&buf, ".", &rc);
  170755. sessionAppendIdent(&buf, zTab, &rc);
  170756. sessionAppendStr(&buf, " WHERE ", &rc);
  170757. for(i=0; i<nCol; i++){
  170758. if( abPK[i] ){
  170759. sessionAppendStr(&buf, zSep, &rc);
  170760. sessionAppendIdent(&buf, azCol[i], &rc);
  170761. sessionAppendStr(&buf, " IS ?", &rc);
  170762. sessionAppendInteger(&buf, i+1, &rc);
  170763. zSep = " AND ";
  170764. }
  170765. }
  170766. zSql = (char*)buf.aBuf;
  170767. nSql = buf.nBuf;
  170768. }
  170769. if( rc==SQLITE_OK ){
  170770. rc = sqlite3_prepare_v2(db, zSql, nSql, ppStmt, 0);
  170771. }
  170772. sqlite3_free(zSql);
  170773. return rc;
  170774. }
  170775. /*
  170776. ** Bind the PRIMARY KEY values from the change passed in argument pChange
  170777. ** to the SELECT statement passed as the first argument. The SELECT statement
  170778. ** is as prepared by function sessionSelectStmt().
  170779. **
  170780. ** Return SQLITE_OK if all PK values are successfully bound, or an SQLite
  170781. ** error code (e.g. SQLITE_NOMEM) otherwise.
  170782. */
  170783. static int sessionSelectBind(
  170784. sqlite3_stmt *pSelect, /* SELECT from sessionSelectStmt() */
  170785. int nCol, /* Number of columns in table */
  170786. u8 *abPK, /* PRIMARY KEY array */
  170787. SessionChange *pChange /* Change structure */
  170788. ){
  170789. int i;
  170790. int rc = SQLITE_OK;
  170791. u8 *a = pChange->aRecord;
  170792. for(i=0; i<nCol && rc==SQLITE_OK; i++){
  170793. int eType = *a++;
  170794. switch( eType ){
  170795. case 0:
  170796. case SQLITE_NULL:
  170797. assert( abPK[i]==0 );
  170798. break;
  170799. case SQLITE_INTEGER: {
  170800. if( abPK[i] ){
  170801. i64 iVal = sessionGetI64(a);
  170802. rc = sqlite3_bind_int64(pSelect, i+1, iVal);
  170803. }
  170804. a += 8;
  170805. break;
  170806. }
  170807. case SQLITE_FLOAT: {
  170808. if( abPK[i] ){
  170809. double rVal;
  170810. i64 iVal = sessionGetI64(a);
  170811. memcpy(&rVal, &iVal, 8);
  170812. rc = sqlite3_bind_double(pSelect, i+1, rVal);
  170813. }
  170814. a += 8;
  170815. break;
  170816. }
  170817. case SQLITE_TEXT: {
  170818. int n;
  170819. a += sessionVarintGet(a, &n);
  170820. if( abPK[i] ){
  170821. rc = sqlite3_bind_text(pSelect, i+1, (char *)a, n, SQLITE_TRANSIENT);
  170822. }
  170823. a += n;
  170824. break;
  170825. }
  170826. default: {
  170827. int n;
  170828. assert( eType==SQLITE_BLOB );
  170829. a += sessionVarintGet(a, &n);
  170830. if( abPK[i] ){
  170831. rc = sqlite3_bind_blob(pSelect, i+1, a, n, SQLITE_TRANSIENT);
  170832. }
  170833. a += n;
  170834. break;
  170835. }
  170836. }
  170837. }
  170838. return rc;
  170839. }
  170840. /*
  170841. ** This function is a no-op if *pRc is set to other than SQLITE_OK when it
  170842. ** is called. Otherwise, append a serialized table header (part of the binary
  170843. ** changeset format) to buffer *pBuf. If an error occurs, set *pRc to an
  170844. ** SQLite error code before returning.
  170845. */
  170846. static void sessionAppendTableHdr(
  170847. SessionBuffer *pBuf, /* Append header to this buffer */
  170848. int bPatchset, /* Use the patchset format if true */
  170849. SessionTable *pTab, /* Table object to append header for */
  170850. int *pRc /* IN/OUT: Error code */
  170851. ){
  170852. /* Write a table header */
  170853. sessionAppendByte(pBuf, (bPatchset ? 'P' : 'T'), pRc);
  170854. sessionAppendVarint(pBuf, pTab->nCol, pRc);
  170855. sessionAppendBlob(pBuf, pTab->abPK, pTab->nCol, pRc);
  170856. sessionAppendBlob(pBuf, (u8 *)pTab->zName, (int)strlen(pTab->zName)+1, pRc);
  170857. }
  170858. /*
  170859. ** Generate either a changeset (if argument bPatchset is zero) or a patchset
  170860. ** (if it is non-zero) based on the current contents of the session object
  170861. ** passed as the first argument.
  170862. **
  170863. ** If no error occurs, SQLITE_OK is returned and the new changeset/patchset
  170864. ** stored in output variables *pnChangeset and *ppChangeset. Or, if an error
  170865. ** occurs, an SQLite error code is returned and both output variables set
  170866. ** to 0.
  170867. */
  170868. static int sessionGenerateChangeset(
  170869. sqlite3_session *pSession, /* Session object */
  170870. int bPatchset, /* True for patchset, false for changeset */
  170871. int (*xOutput)(void *pOut, const void *pData, int nData),
  170872. void *pOut, /* First argument for xOutput */
  170873. int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
  170874. void **ppChangeset /* OUT: Buffer containing changeset */
  170875. ){
  170876. sqlite3 *db = pSession->db; /* Source database handle */
  170877. SessionTable *pTab; /* Used to iterate through attached tables */
  170878. SessionBuffer buf = {0,0,0}; /* Buffer in which to accumlate changeset */
  170879. int rc; /* Return code */
  170880. assert( xOutput==0 || (pnChangeset==0 && ppChangeset==0 ) );
  170881. /* Zero the output variables in case an error occurs. If this session
  170882. ** object is already in the error state (sqlite3_session.rc != SQLITE_OK),
  170883. ** this call will be a no-op. */
  170884. if( xOutput==0 ){
  170885. *pnChangeset = 0;
  170886. *ppChangeset = 0;
  170887. }
  170888. if( pSession->rc ) return pSession->rc;
  170889. rc = sqlite3_exec(pSession->db, "SAVEPOINT changeset", 0, 0, 0);
  170890. if( rc!=SQLITE_OK ) return rc;
  170891. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  170892. for(pTab=pSession->pTable; rc==SQLITE_OK && pTab; pTab=pTab->pNext){
  170893. if( pTab->nEntry ){
  170894. const char *zName = pTab->zName;
  170895. int nCol; /* Number of columns in table */
  170896. u8 *abPK; /* Primary key array */
  170897. const char **azCol = 0; /* Table columns */
  170898. int i; /* Used to iterate through hash buckets */
  170899. sqlite3_stmt *pSel = 0; /* SELECT statement to query table pTab */
  170900. int nRewind = buf.nBuf; /* Initial size of write buffer */
  170901. int nNoop; /* Size of buffer after writing tbl header */
  170902. /* Check the table schema is still Ok. */
  170903. rc = sessionTableInfo(db, pSession->zDb, zName, &nCol, 0, &azCol, &abPK);
  170904. if( !rc && (pTab->nCol!=nCol || memcmp(abPK, pTab->abPK, nCol)) ){
  170905. rc = SQLITE_SCHEMA;
  170906. }
  170907. /* Write a table header */
  170908. sessionAppendTableHdr(&buf, bPatchset, pTab, &rc);
  170909. /* Build and compile a statement to execute: */
  170910. if( rc==SQLITE_OK ){
  170911. rc = sessionSelectStmt(
  170912. db, pSession->zDb, zName, nCol, azCol, abPK, &pSel);
  170913. }
  170914. nNoop = buf.nBuf;
  170915. for(i=0; i<pTab->nChange && rc==SQLITE_OK; i++){
  170916. SessionChange *p; /* Used to iterate through changes */
  170917. for(p=pTab->apChange[i]; rc==SQLITE_OK && p; p=p->pNext){
  170918. rc = sessionSelectBind(pSel, nCol, abPK, p);
  170919. if( rc!=SQLITE_OK ) continue;
  170920. if( sqlite3_step(pSel)==SQLITE_ROW ){
  170921. if( p->op==SQLITE_INSERT ){
  170922. int iCol;
  170923. sessionAppendByte(&buf, SQLITE_INSERT, &rc);
  170924. sessionAppendByte(&buf, p->bIndirect, &rc);
  170925. for(iCol=0; iCol<nCol; iCol++){
  170926. sessionAppendCol(&buf, pSel, iCol, &rc);
  170927. }
  170928. }else{
  170929. rc = sessionAppendUpdate(&buf, bPatchset, pSel, p, abPK);
  170930. }
  170931. }else if( p->op!=SQLITE_INSERT ){
  170932. rc = sessionAppendDelete(&buf, bPatchset, p, nCol, abPK);
  170933. }
  170934. if( rc==SQLITE_OK ){
  170935. rc = sqlite3_reset(pSel);
  170936. }
  170937. /* If the buffer is now larger than SESSIONS_STRM_CHUNK_SIZE, pass
  170938. ** its contents to the xOutput() callback. */
  170939. if( xOutput
  170940. && rc==SQLITE_OK
  170941. && buf.nBuf>nNoop
  170942. && buf.nBuf>SESSIONS_STRM_CHUNK_SIZE
  170943. ){
  170944. rc = xOutput(pOut, (void*)buf.aBuf, buf.nBuf);
  170945. nNoop = -1;
  170946. buf.nBuf = 0;
  170947. }
  170948. }
  170949. }
  170950. sqlite3_finalize(pSel);
  170951. if( buf.nBuf==nNoop ){
  170952. buf.nBuf = nRewind;
  170953. }
  170954. sqlite3_free((char*)azCol); /* cast works around VC++ bug */
  170955. }
  170956. }
  170957. if( rc==SQLITE_OK ){
  170958. if( xOutput==0 ){
  170959. *pnChangeset = buf.nBuf;
  170960. *ppChangeset = buf.aBuf;
  170961. buf.aBuf = 0;
  170962. }else if( buf.nBuf>0 ){
  170963. rc = xOutput(pOut, (void*)buf.aBuf, buf.nBuf);
  170964. }
  170965. }
  170966. sqlite3_free(buf.aBuf);
  170967. sqlite3_exec(db, "RELEASE changeset", 0, 0, 0);
  170968. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  170969. return rc;
  170970. }
  170971. /*
  170972. ** Obtain a changeset object containing all changes recorded by the
  170973. ** session object passed as the first argument.
  170974. **
  170975. ** It is the responsibility of the caller to eventually free the buffer
  170976. ** using sqlite3_free().
  170977. */
  170978. SQLITE_API int sqlite3session_changeset(
  170979. sqlite3_session *pSession, /* Session object */
  170980. int *pnChangeset, /* OUT: Size of buffer at *ppChangeset */
  170981. void **ppChangeset /* OUT: Buffer containing changeset */
  170982. ){
  170983. return sessionGenerateChangeset(pSession, 0, 0, 0, pnChangeset, ppChangeset);
  170984. }
  170985. /*
  170986. ** Streaming version of sqlite3session_changeset().
  170987. */
  170988. SQLITE_API int sqlite3session_changeset_strm(
  170989. sqlite3_session *pSession,
  170990. int (*xOutput)(void *pOut, const void *pData, int nData),
  170991. void *pOut
  170992. ){
  170993. return sessionGenerateChangeset(pSession, 0, xOutput, pOut, 0, 0);
  170994. }
  170995. /*
  170996. ** Streaming version of sqlite3session_patchset().
  170997. */
  170998. SQLITE_API int sqlite3session_patchset_strm(
  170999. sqlite3_session *pSession,
  171000. int (*xOutput)(void *pOut, const void *pData, int nData),
  171001. void *pOut
  171002. ){
  171003. return sessionGenerateChangeset(pSession, 1, xOutput, pOut, 0, 0);
  171004. }
  171005. /*
  171006. ** Obtain a patchset object containing all changes recorded by the
  171007. ** session object passed as the first argument.
  171008. **
  171009. ** It is the responsibility of the caller to eventually free the buffer
  171010. ** using sqlite3_free().
  171011. */
  171012. SQLITE_API int sqlite3session_patchset(
  171013. sqlite3_session *pSession, /* Session object */
  171014. int *pnPatchset, /* OUT: Size of buffer at *ppChangeset */
  171015. void **ppPatchset /* OUT: Buffer containing changeset */
  171016. ){
  171017. return sessionGenerateChangeset(pSession, 1, 0, 0, pnPatchset, ppPatchset);
  171018. }
  171019. /*
  171020. ** Enable or disable the session object passed as the first argument.
  171021. */
  171022. SQLITE_API int sqlite3session_enable(sqlite3_session *pSession, int bEnable){
  171023. int ret;
  171024. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  171025. if( bEnable>=0 ){
  171026. pSession->bEnable = bEnable;
  171027. }
  171028. ret = pSession->bEnable;
  171029. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  171030. return ret;
  171031. }
  171032. /*
  171033. ** Enable or disable the session object passed as the first argument.
  171034. */
  171035. SQLITE_API int sqlite3session_indirect(sqlite3_session *pSession, int bIndirect){
  171036. int ret;
  171037. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  171038. if( bIndirect>=0 ){
  171039. pSession->bIndirect = bIndirect;
  171040. }
  171041. ret = pSession->bIndirect;
  171042. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  171043. return ret;
  171044. }
  171045. /*
  171046. ** Return true if there have been no changes to monitored tables recorded
  171047. ** by the session object passed as the only argument.
  171048. */
  171049. SQLITE_API int sqlite3session_isempty(sqlite3_session *pSession){
  171050. int ret = 0;
  171051. SessionTable *pTab;
  171052. sqlite3_mutex_enter(sqlite3_db_mutex(pSession->db));
  171053. for(pTab=pSession->pTable; pTab && ret==0; pTab=pTab->pNext){
  171054. ret = (pTab->nEntry>0);
  171055. }
  171056. sqlite3_mutex_leave(sqlite3_db_mutex(pSession->db));
  171057. return (ret==0);
  171058. }
  171059. /*
  171060. ** Do the work for either sqlite3changeset_start() or start_strm().
  171061. */
  171062. static int sessionChangesetStart(
  171063. sqlite3_changeset_iter **pp, /* OUT: Changeset iterator handle */
  171064. int (*xInput)(void *pIn, void *pData, int *pnData),
  171065. void *pIn,
  171066. int nChangeset, /* Size of buffer pChangeset in bytes */
  171067. void *pChangeset /* Pointer to buffer containing changeset */
  171068. ){
  171069. sqlite3_changeset_iter *pRet; /* Iterator to return */
  171070. int nByte; /* Number of bytes to allocate for iterator */
  171071. assert( xInput==0 || (pChangeset==0 && nChangeset==0) );
  171072. /* Zero the output variable in case an error occurs. */
  171073. *pp = 0;
  171074. /* Allocate and initialize the iterator structure. */
  171075. nByte = sizeof(sqlite3_changeset_iter);
  171076. pRet = (sqlite3_changeset_iter *)sqlite3_malloc(nByte);
  171077. if( !pRet ) return SQLITE_NOMEM;
  171078. memset(pRet, 0, sizeof(sqlite3_changeset_iter));
  171079. pRet->in.aData = (u8 *)pChangeset;
  171080. pRet->in.nData = nChangeset;
  171081. pRet->in.xInput = xInput;
  171082. pRet->in.pIn = pIn;
  171083. pRet->in.bEof = (xInput ? 0 : 1);
  171084. /* Populate the output variable and return success. */
  171085. *pp = pRet;
  171086. return SQLITE_OK;
  171087. }
  171088. /*
  171089. ** Create an iterator used to iterate through the contents of a changeset.
  171090. */
  171091. SQLITE_API int sqlite3changeset_start(
  171092. sqlite3_changeset_iter **pp, /* OUT: Changeset iterator handle */
  171093. int nChangeset, /* Size of buffer pChangeset in bytes */
  171094. void *pChangeset /* Pointer to buffer containing changeset */
  171095. ){
  171096. return sessionChangesetStart(pp, 0, 0, nChangeset, pChangeset);
  171097. }
  171098. /*
  171099. ** Streaming version of sqlite3changeset_start().
  171100. */
  171101. SQLITE_API int sqlite3changeset_start_strm(
  171102. sqlite3_changeset_iter **pp, /* OUT: Changeset iterator handle */
  171103. int (*xInput)(void *pIn, void *pData, int *pnData),
  171104. void *pIn
  171105. ){
  171106. return sessionChangesetStart(pp, xInput, pIn, 0, 0);
  171107. }
  171108. /*
  171109. ** If the SessionInput object passed as the only argument is a streaming
  171110. ** object and the buffer is full, discard some data to free up space.
  171111. */
  171112. static void sessionDiscardData(SessionInput *pIn){
  171113. if( pIn->xInput && pIn->iNext>=SESSIONS_STRM_CHUNK_SIZE ){
  171114. int nMove = pIn->buf.nBuf - pIn->iNext;
  171115. assert( nMove>=0 );
  171116. if( nMove>0 ){
  171117. memmove(pIn->buf.aBuf, &pIn->buf.aBuf[pIn->iNext], nMove);
  171118. }
  171119. pIn->buf.nBuf -= pIn->iNext;
  171120. pIn->iNext = 0;
  171121. pIn->nData = pIn->buf.nBuf;
  171122. }
  171123. }
  171124. /*
  171125. ** Ensure that there are at least nByte bytes available in the buffer. Or,
  171126. ** if there are not nByte bytes remaining in the input, that all available
  171127. ** data is in the buffer.
  171128. **
  171129. ** Return an SQLite error code if an error occurs, or SQLITE_OK otherwise.
  171130. */
  171131. static int sessionInputBuffer(SessionInput *pIn, int nByte){
  171132. int rc = SQLITE_OK;
  171133. if( pIn->xInput ){
  171134. while( !pIn->bEof && (pIn->iNext+nByte)>=pIn->nData && rc==SQLITE_OK ){
  171135. int nNew = SESSIONS_STRM_CHUNK_SIZE;
  171136. if( pIn->bNoDiscard==0 ) sessionDiscardData(pIn);
  171137. if( SQLITE_OK==sessionBufferGrow(&pIn->buf, nNew, &rc) ){
  171138. rc = pIn->xInput(pIn->pIn, &pIn->buf.aBuf[pIn->buf.nBuf], &nNew);
  171139. if( nNew==0 ){
  171140. pIn->bEof = 1;
  171141. }else{
  171142. pIn->buf.nBuf += nNew;
  171143. }
  171144. }
  171145. pIn->aData = pIn->buf.aBuf;
  171146. pIn->nData = pIn->buf.nBuf;
  171147. }
  171148. }
  171149. return rc;
  171150. }
  171151. /*
  171152. ** When this function is called, *ppRec points to the start of a record
  171153. ** that contains nCol values. This function advances the pointer *ppRec
  171154. ** until it points to the byte immediately following that record.
  171155. */
  171156. static void sessionSkipRecord(
  171157. u8 **ppRec, /* IN/OUT: Record pointer */
  171158. int nCol /* Number of values in record */
  171159. ){
  171160. u8 *aRec = *ppRec;
  171161. int i;
  171162. for(i=0; i<nCol; i++){
  171163. int eType = *aRec++;
  171164. if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  171165. int nByte;
  171166. aRec += sessionVarintGet((u8*)aRec, &nByte);
  171167. aRec += nByte;
  171168. }else if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  171169. aRec += 8;
  171170. }
  171171. }
  171172. *ppRec = aRec;
  171173. }
  171174. /*
  171175. ** This function sets the value of the sqlite3_value object passed as the
  171176. ** first argument to a copy of the string or blob held in the aData[]
  171177. ** buffer. SQLITE_OK is returned if successful, or SQLITE_NOMEM if an OOM
  171178. ** error occurs.
  171179. */
  171180. static int sessionValueSetStr(
  171181. sqlite3_value *pVal, /* Set the value of this object */
  171182. u8 *aData, /* Buffer containing string or blob data */
  171183. int nData, /* Size of buffer aData[] in bytes */
  171184. u8 enc /* String encoding (0 for blobs) */
  171185. ){
  171186. /* In theory this code could just pass SQLITE_TRANSIENT as the final
  171187. ** argument to sqlite3ValueSetStr() and have the copy created
  171188. ** automatically. But doing so makes it difficult to detect any OOM
  171189. ** error. Hence the code to create the copy externally. */
  171190. u8 *aCopy = sqlite3_malloc(nData+1);
  171191. if( aCopy==0 ) return SQLITE_NOMEM;
  171192. memcpy(aCopy, aData, nData);
  171193. sqlite3ValueSetStr(pVal, nData, (char*)aCopy, enc, sqlite3_free);
  171194. return SQLITE_OK;
  171195. }
  171196. /*
  171197. ** Deserialize a single record from a buffer in memory. See "RECORD FORMAT"
  171198. ** for details.
  171199. **
  171200. ** When this function is called, *paChange points to the start of the record
  171201. ** to deserialize. Assuming no error occurs, *paChange is set to point to
  171202. ** one byte after the end of the same record before this function returns.
  171203. ** If the argument abPK is NULL, then the record contains nCol values. Or,
  171204. ** if abPK is other than NULL, then the record contains only the PK fields
  171205. ** (in other words, it is a patchset DELETE record).
  171206. **
  171207. ** If successful, each element of the apOut[] array (allocated by the caller)
  171208. ** is set to point to an sqlite3_value object containing the value read
  171209. ** from the corresponding position in the record. If that value is not
  171210. ** included in the record (i.e. because the record is part of an UPDATE change
  171211. ** and the field was not modified), the corresponding element of apOut[] is
  171212. ** set to NULL.
  171213. **
  171214. ** It is the responsibility of the caller to free all sqlite_value structures
  171215. ** using sqlite3_free().
  171216. **
  171217. ** If an error occurs, an SQLite error code (e.g. SQLITE_NOMEM) is returned.
  171218. ** The apOut[] array may have been partially populated in this case.
  171219. */
  171220. static int sessionReadRecord(
  171221. SessionInput *pIn, /* Input data */
  171222. int nCol, /* Number of values in record */
  171223. u8 *abPK, /* Array of primary key flags, or NULL */
  171224. sqlite3_value **apOut /* Write values to this array */
  171225. ){
  171226. int i; /* Used to iterate through columns */
  171227. int rc = SQLITE_OK;
  171228. for(i=0; i<nCol && rc==SQLITE_OK; i++){
  171229. int eType = 0; /* Type of value (SQLITE_NULL, TEXT etc.) */
  171230. if( abPK && abPK[i]==0 ) continue;
  171231. rc = sessionInputBuffer(pIn, 9);
  171232. if( rc==SQLITE_OK ){
  171233. if( pIn->iNext>=pIn->nData ){
  171234. rc = SQLITE_CORRUPT_BKPT;
  171235. }else{
  171236. eType = pIn->aData[pIn->iNext++];
  171237. assert( apOut[i]==0 );
  171238. if( eType ){
  171239. apOut[i] = sqlite3ValueNew(0);
  171240. if( !apOut[i] ) rc = SQLITE_NOMEM;
  171241. }
  171242. }
  171243. }
  171244. if( rc==SQLITE_OK ){
  171245. u8 *aVal = &pIn->aData[pIn->iNext];
  171246. if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  171247. int nByte;
  171248. pIn->iNext += sessionVarintGet(aVal, &nByte);
  171249. rc = sessionInputBuffer(pIn, nByte);
  171250. if( rc==SQLITE_OK ){
  171251. if( nByte<0 || nByte>pIn->nData-pIn->iNext ){
  171252. rc = SQLITE_CORRUPT_BKPT;
  171253. }else{
  171254. u8 enc = (eType==SQLITE_TEXT ? SQLITE_UTF8 : 0);
  171255. rc = sessionValueSetStr(apOut[i],&pIn->aData[pIn->iNext],nByte,enc);
  171256. pIn->iNext += nByte;
  171257. }
  171258. }
  171259. }
  171260. if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  171261. sqlite3_int64 v = sessionGetI64(aVal);
  171262. if( eType==SQLITE_INTEGER ){
  171263. sqlite3VdbeMemSetInt64(apOut[i], v);
  171264. }else{
  171265. double d;
  171266. memcpy(&d, &v, 8);
  171267. sqlite3VdbeMemSetDouble(apOut[i], d);
  171268. }
  171269. pIn->iNext += 8;
  171270. }
  171271. }
  171272. }
  171273. return rc;
  171274. }
  171275. /*
  171276. ** The input pointer currently points to the second byte of a table-header.
  171277. ** Specifically, to the following:
  171278. **
  171279. ** + number of columns in table (varint)
  171280. ** + array of PK flags (1 byte per column),
  171281. ** + table name (nul terminated).
  171282. **
  171283. ** This function ensures that all of the above is present in the input
  171284. ** buffer (i.e. that it can be accessed without any calls to xInput()).
  171285. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code.
  171286. ** The input pointer is not moved.
  171287. */
  171288. static int sessionChangesetBufferTblhdr(SessionInput *pIn, int *pnByte){
  171289. int rc = SQLITE_OK;
  171290. int nCol = 0;
  171291. int nRead = 0;
  171292. rc = sessionInputBuffer(pIn, 9);
  171293. if( rc==SQLITE_OK ){
  171294. nRead += sessionVarintGet(&pIn->aData[pIn->iNext + nRead], &nCol);
  171295. /* The hard upper limit for the number of columns in an SQLite
  171296. ** database table is, according to sqliteLimit.h, 32676. So
  171297. ** consider any table-header that purports to have more than 65536
  171298. ** columns to be corrupt. This is convenient because otherwise,
  171299. ** if the (nCol>65536) condition below were omitted, a sufficiently
  171300. ** large value for nCol may cause nRead to wrap around and become
  171301. ** negative. Leading to a crash. */
  171302. if( nCol<0 || nCol>65536 ){
  171303. rc = SQLITE_CORRUPT_BKPT;
  171304. }else{
  171305. rc = sessionInputBuffer(pIn, nRead+nCol+100);
  171306. nRead += nCol;
  171307. }
  171308. }
  171309. while( rc==SQLITE_OK ){
  171310. while( (pIn->iNext + nRead)<pIn->nData && pIn->aData[pIn->iNext + nRead] ){
  171311. nRead++;
  171312. }
  171313. if( (pIn->iNext + nRead)<pIn->nData ) break;
  171314. rc = sessionInputBuffer(pIn, nRead + 100);
  171315. }
  171316. *pnByte = nRead+1;
  171317. return rc;
  171318. }
  171319. /*
  171320. ** The input pointer currently points to the first byte of the first field
  171321. ** of a record consisting of nCol columns. This function ensures the entire
  171322. ** record is buffered. It does not move the input pointer.
  171323. **
  171324. ** If successful, SQLITE_OK is returned and *pnByte is set to the size of
  171325. ** the record in bytes. Otherwise, an SQLite error code is returned. The
  171326. ** final value of *pnByte is undefined in this case.
  171327. */
  171328. static int sessionChangesetBufferRecord(
  171329. SessionInput *pIn, /* Input data */
  171330. int nCol, /* Number of columns in record */
  171331. int *pnByte /* OUT: Size of record in bytes */
  171332. ){
  171333. int rc = SQLITE_OK;
  171334. int nByte = 0;
  171335. int i;
  171336. for(i=0; rc==SQLITE_OK && i<nCol; i++){
  171337. int eType;
  171338. rc = sessionInputBuffer(pIn, nByte + 10);
  171339. if( rc==SQLITE_OK ){
  171340. eType = pIn->aData[pIn->iNext + nByte++];
  171341. if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
  171342. int n;
  171343. nByte += sessionVarintGet(&pIn->aData[pIn->iNext+nByte], &n);
  171344. nByte += n;
  171345. rc = sessionInputBuffer(pIn, nByte);
  171346. }else if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
  171347. nByte += 8;
  171348. }
  171349. }
  171350. }
  171351. *pnByte = nByte;
  171352. return rc;
  171353. }
  171354. /*
  171355. ** The input pointer currently points to the second byte of a table-header.
  171356. ** Specifically, to the following:
  171357. **
  171358. ** + number of columns in table (varint)
  171359. ** + array of PK flags (1 byte per column),
  171360. ** + table name (nul terminated).
  171361. **
  171362. ** This function decodes the table-header and populates the p->nCol,
  171363. ** p->zTab and p->abPK[] variables accordingly. The p->apValue[] array is
  171364. ** also allocated or resized according to the new value of p->nCol. The
  171365. ** input pointer is left pointing to the byte following the table header.
  171366. **
  171367. ** If successful, SQLITE_OK is returned. Otherwise, an SQLite error code
  171368. ** is returned and the final values of the various fields enumerated above
  171369. ** are undefined.
  171370. */
  171371. static int sessionChangesetReadTblhdr(sqlite3_changeset_iter *p){
  171372. int rc;
  171373. int nCopy;
  171374. assert( p->rc==SQLITE_OK );
  171375. rc = sessionChangesetBufferTblhdr(&p->in, &nCopy);
  171376. if( rc==SQLITE_OK ){
  171377. int nByte;
  171378. int nVarint;
  171379. nVarint = sessionVarintGet(&p->in.aData[p->in.iNext], &p->nCol);
  171380. if( p->nCol>0 ){
  171381. nCopy -= nVarint;
  171382. p->in.iNext += nVarint;
  171383. nByte = p->nCol * sizeof(sqlite3_value*) * 2 + nCopy;
  171384. p->tblhdr.nBuf = 0;
  171385. sessionBufferGrow(&p->tblhdr, nByte, &rc);
  171386. }else{
  171387. rc = SQLITE_CORRUPT_BKPT;
  171388. }
  171389. }
  171390. if( rc==SQLITE_OK ){
  171391. int iPK = sizeof(sqlite3_value*)*p->nCol*2;
  171392. memset(p->tblhdr.aBuf, 0, iPK);
  171393. memcpy(&p->tblhdr.aBuf[iPK], &p->in.aData[p->in.iNext], nCopy);
  171394. p->in.iNext += nCopy;
  171395. }
  171396. p->apValue = (sqlite3_value**)p->tblhdr.aBuf;
  171397. p->abPK = (u8*)&p->apValue[p->nCol*2];
  171398. p->zTab = (char*)&p->abPK[p->nCol];
  171399. return (p->rc = rc);
  171400. }
  171401. /*
  171402. ** Advance the changeset iterator to the next change.
  171403. **
  171404. ** If both paRec and pnRec are NULL, then this function works like the public
  171405. ** API sqlite3changeset_next(). If SQLITE_ROW is returned, then the
  171406. ** sqlite3changeset_new() and old() APIs may be used to query for values.
  171407. **
  171408. ** Otherwise, if paRec and pnRec are not NULL, then a pointer to the change
  171409. ** record is written to *paRec before returning and the number of bytes in
  171410. ** the record to *pnRec.
  171411. **
  171412. ** Either way, this function returns SQLITE_ROW if the iterator is
  171413. ** successfully advanced to the next change in the changeset, an SQLite
  171414. ** error code if an error occurs, or SQLITE_DONE if there are no further
  171415. ** changes in the changeset.
  171416. */
  171417. static int sessionChangesetNext(
  171418. sqlite3_changeset_iter *p, /* Changeset iterator */
  171419. u8 **paRec, /* If non-NULL, store record pointer here */
  171420. int *pnRec, /* If non-NULL, store size of record here */
  171421. int *pbNew /* If non-NULL, true if new table */
  171422. ){
  171423. int i;
  171424. u8 op;
  171425. assert( (paRec==0 && pnRec==0) || (paRec && pnRec) );
  171426. /* If the iterator is in the error-state, return immediately. */
  171427. if( p->rc!=SQLITE_OK ) return p->rc;
  171428. /* Free the current contents of p->apValue[], if any. */
  171429. if( p->apValue ){
  171430. for(i=0; i<p->nCol*2; i++){
  171431. sqlite3ValueFree(p->apValue[i]);
  171432. }
  171433. memset(p->apValue, 0, sizeof(sqlite3_value*)*p->nCol*2);
  171434. }
  171435. /* Make sure the buffer contains at least 10 bytes of input data, or all
  171436. ** remaining data if there are less than 10 bytes available. This is
  171437. ** sufficient either for the 'T' or 'P' byte and the varint that follows
  171438. ** it, or for the two single byte values otherwise. */
  171439. p->rc = sessionInputBuffer(&p->in, 2);
  171440. if( p->rc!=SQLITE_OK ) return p->rc;
  171441. /* If the iterator is already at the end of the changeset, return DONE. */
  171442. if( p->in.iNext>=p->in.nData ){
  171443. return SQLITE_DONE;
  171444. }
  171445. sessionDiscardData(&p->in);
  171446. p->in.iCurrent = p->in.iNext;
  171447. op = p->in.aData[p->in.iNext++];
  171448. while( op=='T' || op=='P' ){
  171449. if( pbNew ) *pbNew = 1;
  171450. p->bPatchset = (op=='P');
  171451. if( sessionChangesetReadTblhdr(p) ) return p->rc;
  171452. if( (p->rc = sessionInputBuffer(&p->in, 2)) ) return p->rc;
  171453. p->in.iCurrent = p->in.iNext;
  171454. if( p->in.iNext>=p->in.nData ) return SQLITE_DONE;
  171455. op = p->in.aData[p->in.iNext++];
  171456. }
  171457. if( p->zTab==0 ){
  171458. /* The first record in the changeset is not a table header. Must be a
  171459. ** corrupt changeset. */
  171460. assert( p->in.iNext==1 );
  171461. return (p->rc = SQLITE_CORRUPT_BKPT);
  171462. }
  171463. p->op = op;
  171464. p->bIndirect = p->in.aData[p->in.iNext++];
  171465. if( p->op!=SQLITE_UPDATE && p->op!=SQLITE_DELETE && p->op!=SQLITE_INSERT ){
  171466. return (p->rc = SQLITE_CORRUPT_BKPT);
  171467. }
  171468. if( paRec ){
  171469. int nVal; /* Number of values to buffer */
  171470. if( p->bPatchset==0 && op==SQLITE_UPDATE ){
  171471. nVal = p->nCol * 2;
  171472. }else if( p->bPatchset && op==SQLITE_DELETE ){
  171473. nVal = 0;
  171474. for(i=0; i<p->nCol; i++) if( p->abPK[i] ) nVal++;
  171475. }else{
  171476. nVal = p->nCol;
  171477. }
  171478. p->rc = sessionChangesetBufferRecord(&p->in, nVal, pnRec);
  171479. if( p->rc!=SQLITE_OK ) return p->rc;
  171480. *paRec = &p->in.aData[p->in.iNext];
  171481. p->in.iNext += *pnRec;
  171482. }else{
  171483. /* If this is an UPDATE or DELETE, read the old.* record. */
  171484. if( p->op!=SQLITE_INSERT && (p->bPatchset==0 || p->op==SQLITE_DELETE) ){
  171485. u8 *abPK = p->bPatchset ? p->abPK : 0;
  171486. p->rc = sessionReadRecord(&p->in, p->nCol, abPK, p->apValue);
  171487. if( p->rc!=SQLITE_OK ) return p->rc;
  171488. }
  171489. /* If this is an INSERT or UPDATE, read the new.* record. */
  171490. if( p->op!=SQLITE_DELETE ){
  171491. p->rc = sessionReadRecord(&p->in, p->nCol, 0, &p->apValue[p->nCol]);
  171492. if( p->rc!=SQLITE_OK ) return p->rc;
  171493. }
  171494. if( p->bPatchset && p->op==SQLITE_UPDATE ){
  171495. /* If this is an UPDATE that is part of a patchset, then all PK and
  171496. ** modified fields are present in the new.* record. The old.* record
  171497. ** is currently completely empty. This block shifts the PK fields from
  171498. ** new.* to old.*, to accommodate the code that reads these arrays. */
  171499. for(i=0; i<p->nCol; i++){
  171500. assert( p->apValue[i]==0 );
  171501. if( p->abPK[i] ){
  171502. p->apValue[i] = p->apValue[i+p->nCol];
  171503. if( p->apValue[i]==0 ) return (p->rc = SQLITE_CORRUPT_BKPT);
  171504. p->apValue[i+p->nCol] = 0;
  171505. }
  171506. }
  171507. }
  171508. }
  171509. return SQLITE_ROW;
  171510. }
  171511. /*
  171512. ** Advance an iterator created by sqlite3changeset_start() to the next
  171513. ** change in the changeset. This function may return SQLITE_ROW, SQLITE_DONE
  171514. ** or SQLITE_CORRUPT.
  171515. **
  171516. ** This function may not be called on iterators passed to a conflict handler
  171517. ** callback by changeset_apply().
  171518. */
  171519. SQLITE_API int sqlite3changeset_next(sqlite3_changeset_iter *p){
  171520. return sessionChangesetNext(p, 0, 0, 0);
  171521. }
  171522. /*
  171523. ** The following function extracts information on the current change
  171524. ** from a changeset iterator. It may only be called after changeset_next()
  171525. ** has returned SQLITE_ROW.
  171526. */
  171527. SQLITE_API int sqlite3changeset_op(
  171528. sqlite3_changeset_iter *pIter, /* Iterator handle */
  171529. const char **pzTab, /* OUT: Pointer to table name */
  171530. int *pnCol, /* OUT: Number of columns in table */
  171531. int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */
  171532. int *pbIndirect /* OUT: True if change is indirect */
  171533. ){
  171534. *pOp = pIter->op;
  171535. *pnCol = pIter->nCol;
  171536. *pzTab = pIter->zTab;
  171537. if( pbIndirect ) *pbIndirect = pIter->bIndirect;
  171538. return SQLITE_OK;
  171539. }
  171540. /*
  171541. ** Return information regarding the PRIMARY KEY and number of columns in
  171542. ** the database table affected by the change that pIter currently points
  171543. ** to. This function may only be called after changeset_next() returns
  171544. ** SQLITE_ROW.
  171545. */
  171546. SQLITE_API int sqlite3changeset_pk(
  171547. sqlite3_changeset_iter *pIter, /* Iterator object */
  171548. unsigned char **pabPK, /* OUT: Array of boolean - true for PK cols */
  171549. int *pnCol /* OUT: Number of entries in output array */
  171550. ){
  171551. *pabPK = pIter->abPK;
  171552. if( pnCol ) *pnCol = pIter->nCol;
  171553. return SQLITE_OK;
  171554. }
  171555. /*
  171556. ** This function may only be called while the iterator is pointing to an
  171557. ** SQLITE_UPDATE or SQLITE_DELETE change (see sqlite3changeset_op()).
  171558. ** Otherwise, SQLITE_MISUSE is returned.
  171559. **
  171560. ** It sets *ppValue to point to an sqlite3_value structure containing the
  171561. ** iVal'th value in the old.* record. Or, if that particular value is not
  171562. ** included in the record (because the change is an UPDATE and the field
  171563. ** was not modified and is not a PK column), set *ppValue to NULL.
  171564. **
  171565. ** If value iVal is out-of-range, SQLITE_RANGE is returned and *ppValue is
  171566. ** not modified. Otherwise, SQLITE_OK.
  171567. */
  171568. SQLITE_API int sqlite3changeset_old(
  171569. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  171570. int iVal, /* Index of old.* value to retrieve */
  171571. sqlite3_value **ppValue /* OUT: Old value (or NULL pointer) */
  171572. ){
  171573. if( pIter->op!=SQLITE_UPDATE && pIter->op!=SQLITE_DELETE ){
  171574. return SQLITE_MISUSE;
  171575. }
  171576. if( iVal<0 || iVal>=pIter->nCol ){
  171577. return SQLITE_RANGE;
  171578. }
  171579. *ppValue = pIter->apValue[iVal];
  171580. return SQLITE_OK;
  171581. }
  171582. /*
  171583. ** This function may only be called while the iterator is pointing to an
  171584. ** SQLITE_UPDATE or SQLITE_INSERT change (see sqlite3changeset_op()).
  171585. ** Otherwise, SQLITE_MISUSE is returned.
  171586. **
  171587. ** It sets *ppValue to point to an sqlite3_value structure containing the
  171588. ** iVal'th value in the new.* record. Or, if that particular value is not
  171589. ** included in the record (because the change is an UPDATE and the field
  171590. ** was not modified), set *ppValue to NULL.
  171591. **
  171592. ** If value iVal is out-of-range, SQLITE_RANGE is returned and *ppValue is
  171593. ** not modified. Otherwise, SQLITE_OK.
  171594. */
  171595. SQLITE_API int sqlite3changeset_new(
  171596. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  171597. int iVal, /* Index of new.* value to retrieve */
  171598. sqlite3_value **ppValue /* OUT: New value (or NULL pointer) */
  171599. ){
  171600. if( pIter->op!=SQLITE_UPDATE && pIter->op!=SQLITE_INSERT ){
  171601. return SQLITE_MISUSE;
  171602. }
  171603. if( iVal<0 || iVal>=pIter->nCol ){
  171604. return SQLITE_RANGE;
  171605. }
  171606. *ppValue = pIter->apValue[pIter->nCol+iVal];
  171607. return SQLITE_OK;
  171608. }
  171609. /*
  171610. ** The following two macros are used internally. They are similar to the
  171611. ** sqlite3changeset_new() and sqlite3changeset_old() functions, except that
  171612. ** they omit all error checking and return a pointer to the requested value.
  171613. */
  171614. #define sessionChangesetNew(pIter, iVal) (pIter)->apValue[(pIter)->nCol+(iVal)]
  171615. #define sessionChangesetOld(pIter, iVal) (pIter)->apValue[(iVal)]
  171616. /*
  171617. ** This function may only be called with a changeset iterator that has been
  171618. ** passed to an SQLITE_CHANGESET_DATA or SQLITE_CHANGESET_CONFLICT
  171619. ** conflict-handler function. Otherwise, SQLITE_MISUSE is returned.
  171620. **
  171621. ** If successful, *ppValue is set to point to an sqlite3_value structure
  171622. ** containing the iVal'th value of the conflicting record.
  171623. **
  171624. ** If value iVal is out-of-range or some other error occurs, an SQLite error
  171625. ** code is returned. Otherwise, SQLITE_OK.
  171626. */
  171627. SQLITE_API int sqlite3changeset_conflict(
  171628. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  171629. int iVal, /* Index of conflict record value to fetch */
  171630. sqlite3_value **ppValue /* OUT: Value from conflicting row */
  171631. ){
  171632. if( !pIter->pConflict ){
  171633. return SQLITE_MISUSE;
  171634. }
  171635. if( iVal<0 || iVal>=pIter->nCol ){
  171636. return SQLITE_RANGE;
  171637. }
  171638. *ppValue = sqlite3_column_value(pIter->pConflict, iVal);
  171639. return SQLITE_OK;
  171640. }
  171641. /*
  171642. ** This function may only be called with an iterator passed to an
  171643. ** SQLITE_CHANGESET_FOREIGN_KEY conflict handler callback. In this case
  171644. ** it sets the output variable to the total number of known foreign key
  171645. ** violations in the destination database and returns SQLITE_OK.
  171646. **
  171647. ** In all other cases this function returns SQLITE_MISUSE.
  171648. */
  171649. SQLITE_API int sqlite3changeset_fk_conflicts(
  171650. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  171651. int *pnOut /* OUT: Number of FK violations */
  171652. ){
  171653. if( pIter->pConflict || pIter->apValue ){
  171654. return SQLITE_MISUSE;
  171655. }
  171656. *pnOut = pIter->nCol;
  171657. return SQLITE_OK;
  171658. }
  171659. /*
  171660. ** Finalize an iterator allocated with sqlite3changeset_start().
  171661. **
  171662. ** This function may not be called on iterators passed to a conflict handler
  171663. ** callback by changeset_apply().
  171664. */
  171665. SQLITE_API int sqlite3changeset_finalize(sqlite3_changeset_iter *p){
  171666. int rc = SQLITE_OK;
  171667. if( p ){
  171668. int i; /* Used to iterate through p->apValue[] */
  171669. rc = p->rc;
  171670. if( p->apValue ){
  171671. for(i=0; i<p->nCol*2; i++) sqlite3ValueFree(p->apValue[i]);
  171672. }
  171673. sqlite3_free(p->tblhdr.aBuf);
  171674. sqlite3_free(p->in.buf.aBuf);
  171675. sqlite3_free(p);
  171676. }
  171677. return rc;
  171678. }
  171679. static int sessionChangesetInvert(
  171680. SessionInput *pInput, /* Input changeset */
  171681. int (*xOutput)(void *pOut, const void *pData, int nData),
  171682. void *pOut,
  171683. int *pnInverted, /* OUT: Number of bytes in output changeset */
  171684. void **ppInverted /* OUT: Inverse of pChangeset */
  171685. ){
  171686. int rc = SQLITE_OK; /* Return value */
  171687. SessionBuffer sOut; /* Output buffer */
  171688. int nCol = 0; /* Number of cols in current table */
  171689. u8 *abPK = 0; /* PK array for current table */
  171690. sqlite3_value **apVal = 0; /* Space for values for UPDATE inversion */
  171691. SessionBuffer sPK = {0, 0, 0}; /* PK array for current table */
  171692. /* Initialize the output buffer */
  171693. memset(&sOut, 0, sizeof(SessionBuffer));
  171694. /* Zero the output variables in case an error occurs. */
  171695. if( ppInverted ){
  171696. *ppInverted = 0;
  171697. *pnInverted = 0;
  171698. }
  171699. while( 1 ){
  171700. u8 eType;
  171701. /* Test for EOF. */
  171702. if( (rc = sessionInputBuffer(pInput, 2)) ) goto finished_invert;
  171703. if( pInput->iNext>=pInput->nData ) break;
  171704. eType = pInput->aData[pInput->iNext];
  171705. switch( eType ){
  171706. case 'T': {
  171707. /* A 'table' record consists of:
  171708. **
  171709. ** * A constant 'T' character,
  171710. ** * Number of columns in said table (a varint),
  171711. ** * An array of nCol bytes (sPK),
  171712. ** * A nul-terminated table name.
  171713. */
  171714. int nByte;
  171715. int nVar;
  171716. pInput->iNext++;
  171717. if( (rc = sessionChangesetBufferTblhdr(pInput, &nByte)) ){
  171718. goto finished_invert;
  171719. }
  171720. nVar = sessionVarintGet(&pInput->aData[pInput->iNext], &nCol);
  171721. sPK.nBuf = 0;
  171722. sessionAppendBlob(&sPK, &pInput->aData[pInput->iNext+nVar], nCol, &rc);
  171723. sessionAppendByte(&sOut, eType, &rc);
  171724. sessionAppendBlob(&sOut, &pInput->aData[pInput->iNext], nByte, &rc);
  171725. if( rc ) goto finished_invert;
  171726. pInput->iNext += nByte;
  171727. sqlite3_free(apVal);
  171728. apVal = 0;
  171729. abPK = sPK.aBuf;
  171730. break;
  171731. }
  171732. case SQLITE_INSERT:
  171733. case SQLITE_DELETE: {
  171734. int nByte;
  171735. int bIndirect = pInput->aData[pInput->iNext+1];
  171736. int eType2 = (eType==SQLITE_DELETE ? SQLITE_INSERT : SQLITE_DELETE);
  171737. pInput->iNext += 2;
  171738. assert( rc==SQLITE_OK );
  171739. rc = sessionChangesetBufferRecord(pInput, nCol, &nByte);
  171740. sessionAppendByte(&sOut, eType2, &rc);
  171741. sessionAppendByte(&sOut, bIndirect, &rc);
  171742. sessionAppendBlob(&sOut, &pInput->aData[pInput->iNext], nByte, &rc);
  171743. pInput->iNext += nByte;
  171744. if( rc ) goto finished_invert;
  171745. break;
  171746. }
  171747. case SQLITE_UPDATE: {
  171748. int iCol;
  171749. if( 0==apVal ){
  171750. apVal = (sqlite3_value **)sqlite3_malloc(sizeof(apVal[0])*nCol*2);
  171751. if( 0==apVal ){
  171752. rc = SQLITE_NOMEM;
  171753. goto finished_invert;
  171754. }
  171755. memset(apVal, 0, sizeof(apVal[0])*nCol*2);
  171756. }
  171757. /* Write the header for the new UPDATE change. Same as the original. */
  171758. sessionAppendByte(&sOut, eType, &rc);
  171759. sessionAppendByte(&sOut, pInput->aData[pInput->iNext+1], &rc);
  171760. /* Read the old.* and new.* records for the update change. */
  171761. pInput->iNext += 2;
  171762. rc = sessionReadRecord(pInput, nCol, 0, &apVal[0]);
  171763. if( rc==SQLITE_OK ){
  171764. rc = sessionReadRecord(pInput, nCol, 0, &apVal[nCol]);
  171765. }
  171766. /* Write the new old.* record. Consists of the PK columns from the
  171767. ** original old.* record, and the other values from the original
  171768. ** new.* record. */
  171769. for(iCol=0; iCol<nCol; iCol++){
  171770. sqlite3_value *pVal = apVal[iCol + (abPK[iCol] ? 0 : nCol)];
  171771. sessionAppendValue(&sOut, pVal, &rc);
  171772. }
  171773. /* Write the new new.* record. Consists of a copy of all values
  171774. ** from the original old.* record, except for the PK columns, which
  171775. ** are set to "undefined". */
  171776. for(iCol=0; iCol<nCol; iCol++){
  171777. sqlite3_value *pVal = (abPK[iCol] ? 0 : apVal[iCol]);
  171778. sessionAppendValue(&sOut, pVal, &rc);
  171779. }
  171780. for(iCol=0; iCol<nCol*2; iCol++){
  171781. sqlite3ValueFree(apVal[iCol]);
  171782. }
  171783. memset(apVal, 0, sizeof(apVal[0])*nCol*2);
  171784. if( rc!=SQLITE_OK ){
  171785. goto finished_invert;
  171786. }
  171787. break;
  171788. }
  171789. default:
  171790. rc = SQLITE_CORRUPT_BKPT;
  171791. goto finished_invert;
  171792. }
  171793. assert( rc==SQLITE_OK );
  171794. if( xOutput && sOut.nBuf>=SESSIONS_STRM_CHUNK_SIZE ){
  171795. rc = xOutput(pOut, sOut.aBuf, sOut.nBuf);
  171796. sOut.nBuf = 0;
  171797. if( rc!=SQLITE_OK ) goto finished_invert;
  171798. }
  171799. }
  171800. assert( rc==SQLITE_OK );
  171801. if( pnInverted ){
  171802. *pnInverted = sOut.nBuf;
  171803. *ppInverted = sOut.aBuf;
  171804. sOut.aBuf = 0;
  171805. }else if( sOut.nBuf>0 ){
  171806. rc = xOutput(pOut, sOut.aBuf, sOut.nBuf);
  171807. }
  171808. finished_invert:
  171809. sqlite3_free(sOut.aBuf);
  171810. sqlite3_free(apVal);
  171811. sqlite3_free(sPK.aBuf);
  171812. return rc;
  171813. }
  171814. /*
  171815. ** Invert a changeset object.
  171816. */
  171817. SQLITE_API int sqlite3changeset_invert(
  171818. int nChangeset, /* Number of bytes in input */
  171819. const void *pChangeset, /* Input changeset */
  171820. int *pnInverted, /* OUT: Number of bytes in output changeset */
  171821. void **ppInverted /* OUT: Inverse of pChangeset */
  171822. ){
  171823. SessionInput sInput;
  171824. /* Set up the input stream */
  171825. memset(&sInput, 0, sizeof(SessionInput));
  171826. sInput.nData = nChangeset;
  171827. sInput.aData = (u8*)pChangeset;
  171828. return sessionChangesetInvert(&sInput, 0, 0, pnInverted, ppInverted);
  171829. }
  171830. /*
  171831. ** Streaming version of sqlite3changeset_invert().
  171832. */
  171833. SQLITE_API int sqlite3changeset_invert_strm(
  171834. int (*xInput)(void *pIn, void *pData, int *pnData),
  171835. void *pIn,
  171836. int (*xOutput)(void *pOut, const void *pData, int nData),
  171837. void *pOut
  171838. ){
  171839. SessionInput sInput;
  171840. int rc;
  171841. /* Set up the input stream */
  171842. memset(&sInput, 0, sizeof(SessionInput));
  171843. sInput.xInput = xInput;
  171844. sInput.pIn = pIn;
  171845. rc = sessionChangesetInvert(&sInput, xOutput, pOut, 0, 0);
  171846. sqlite3_free(sInput.buf.aBuf);
  171847. return rc;
  171848. }
  171849. typedef struct SessionApplyCtx SessionApplyCtx;
  171850. struct SessionApplyCtx {
  171851. sqlite3 *db;
  171852. sqlite3_stmt *pDelete; /* DELETE statement */
  171853. sqlite3_stmt *pUpdate; /* UPDATE statement */
  171854. sqlite3_stmt *pInsert; /* INSERT statement */
  171855. sqlite3_stmt *pSelect; /* SELECT statement */
  171856. int nCol; /* Size of azCol[] and abPK[] arrays */
  171857. const char **azCol; /* Array of column names */
  171858. u8 *abPK; /* Boolean array - true if column is in PK */
  171859. int bStat1; /* True if table is sqlite_stat1 */
  171860. int bDeferConstraints; /* True to defer constraints */
  171861. SessionBuffer constraints; /* Deferred constraints are stored here */
  171862. SessionBuffer rebase; /* Rebase information (if any) here */
  171863. int bRebaseStarted; /* If table header is already in rebase */
  171864. };
  171865. /*
  171866. ** Formulate a statement to DELETE a row from database db. Assuming a table
  171867. ** structure like this:
  171868. **
  171869. ** CREATE TABLE x(a, b, c, d, PRIMARY KEY(a, c));
  171870. **
  171871. ** The DELETE statement looks like this:
  171872. **
  171873. ** DELETE FROM x WHERE a = :1 AND c = :3 AND (:5 OR b IS :2 AND d IS :4)
  171874. **
  171875. ** Variable :5 (nCol+1) is a boolean. It should be set to 0 if we require
  171876. ** matching b and d values, or 1 otherwise. The second case comes up if the
  171877. ** conflict handler is invoked with NOTFOUND and returns CHANGESET_REPLACE.
  171878. **
  171879. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pDelete is left
  171880. ** pointing to the prepared version of the SQL statement.
  171881. */
  171882. static int sessionDeleteRow(
  171883. sqlite3 *db, /* Database handle */
  171884. const char *zTab, /* Table name */
  171885. SessionApplyCtx *p /* Session changeset-apply context */
  171886. ){
  171887. int i;
  171888. const char *zSep = "";
  171889. int rc = SQLITE_OK;
  171890. SessionBuffer buf = {0, 0, 0};
  171891. int nPk = 0;
  171892. sessionAppendStr(&buf, "DELETE FROM ", &rc);
  171893. sessionAppendIdent(&buf, zTab, &rc);
  171894. sessionAppendStr(&buf, " WHERE ", &rc);
  171895. for(i=0; i<p->nCol; i++){
  171896. if( p->abPK[i] ){
  171897. nPk++;
  171898. sessionAppendStr(&buf, zSep, &rc);
  171899. sessionAppendIdent(&buf, p->azCol[i], &rc);
  171900. sessionAppendStr(&buf, " = ?", &rc);
  171901. sessionAppendInteger(&buf, i+1, &rc);
  171902. zSep = " AND ";
  171903. }
  171904. }
  171905. if( nPk<p->nCol ){
  171906. sessionAppendStr(&buf, " AND (?", &rc);
  171907. sessionAppendInteger(&buf, p->nCol+1, &rc);
  171908. sessionAppendStr(&buf, " OR ", &rc);
  171909. zSep = "";
  171910. for(i=0; i<p->nCol; i++){
  171911. if( !p->abPK[i] ){
  171912. sessionAppendStr(&buf, zSep, &rc);
  171913. sessionAppendIdent(&buf, p->azCol[i], &rc);
  171914. sessionAppendStr(&buf, " IS ?", &rc);
  171915. sessionAppendInteger(&buf, i+1, &rc);
  171916. zSep = "AND ";
  171917. }
  171918. }
  171919. sessionAppendStr(&buf, ")", &rc);
  171920. }
  171921. if( rc==SQLITE_OK ){
  171922. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, &p->pDelete, 0);
  171923. }
  171924. sqlite3_free(buf.aBuf);
  171925. return rc;
  171926. }
  171927. /*
  171928. ** Formulate and prepare a statement to UPDATE a row from database db.
  171929. ** Assuming a table structure like this:
  171930. **
  171931. ** CREATE TABLE x(a, b, c, d, PRIMARY KEY(a, c));
  171932. **
  171933. ** The UPDATE statement looks like this:
  171934. **
  171935. ** UPDATE x SET
  171936. ** a = CASE WHEN ?2 THEN ?3 ELSE a END,
  171937. ** b = CASE WHEN ?5 THEN ?6 ELSE b END,
  171938. ** c = CASE WHEN ?8 THEN ?9 ELSE c END,
  171939. ** d = CASE WHEN ?11 THEN ?12 ELSE d END
  171940. ** WHERE a = ?1 AND c = ?7 AND (?13 OR
  171941. ** (?5==0 OR b IS ?4) AND (?11==0 OR d IS ?10) AND
  171942. ** )
  171943. **
  171944. ** For each column in the table, there are three variables to bind:
  171945. **
  171946. ** ?(i*3+1) The old.* value of the column, if any.
  171947. ** ?(i*3+2) A boolean flag indicating that the value is being modified.
  171948. ** ?(i*3+3) The new.* value of the column, if any.
  171949. **
  171950. ** Also, a boolean flag that, if set to true, causes the statement to update
  171951. ** a row even if the non-PK values do not match. This is required if the
  171952. ** conflict-handler is invoked with CHANGESET_DATA and returns
  171953. ** CHANGESET_REPLACE. This is variable "?(nCol*3+1)".
  171954. **
  171955. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pUpdate is left
  171956. ** pointing to the prepared version of the SQL statement.
  171957. */
  171958. static int sessionUpdateRow(
  171959. sqlite3 *db, /* Database handle */
  171960. const char *zTab, /* Table name */
  171961. SessionApplyCtx *p /* Session changeset-apply context */
  171962. ){
  171963. int rc = SQLITE_OK;
  171964. int i;
  171965. const char *zSep = "";
  171966. SessionBuffer buf = {0, 0, 0};
  171967. /* Append "UPDATE tbl SET " */
  171968. sessionAppendStr(&buf, "UPDATE ", &rc);
  171969. sessionAppendIdent(&buf, zTab, &rc);
  171970. sessionAppendStr(&buf, " SET ", &rc);
  171971. /* Append the assignments */
  171972. for(i=0; i<p->nCol; i++){
  171973. sessionAppendStr(&buf, zSep, &rc);
  171974. sessionAppendIdent(&buf, p->azCol[i], &rc);
  171975. sessionAppendStr(&buf, " = CASE WHEN ?", &rc);
  171976. sessionAppendInteger(&buf, i*3+2, &rc);
  171977. sessionAppendStr(&buf, " THEN ?", &rc);
  171978. sessionAppendInteger(&buf, i*3+3, &rc);
  171979. sessionAppendStr(&buf, " ELSE ", &rc);
  171980. sessionAppendIdent(&buf, p->azCol[i], &rc);
  171981. sessionAppendStr(&buf, " END", &rc);
  171982. zSep = ", ";
  171983. }
  171984. /* Append the PK part of the WHERE clause */
  171985. sessionAppendStr(&buf, " WHERE ", &rc);
  171986. for(i=0; i<p->nCol; i++){
  171987. if( p->abPK[i] ){
  171988. sessionAppendIdent(&buf, p->azCol[i], &rc);
  171989. sessionAppendStr(&buf, " = ?", &rc);
  171990. sessionAppendInteger(&buf, i*3+1, &rc);
  171991. sessionAppendStr(&buf, " AND ", &rc);
  171992. }
  171993. }
  171994. /* Append the non-PK part of the WHERE clause */
  171995. sessionAppendStr(&buf, " (?", &rc);
  171996. sessionAppendInteger(&buf, p->nCol*3+1, &rc);
  171997. sessionAppendStr(&buf, " OR 1", &rc);
  171998. for(i=0; i<p->nCol; i++){
  171999. if( !p->abPK[i] ){
  172000. sessionAppendStr(&buf, " AND (?", &rc);
  172001. sessionAppendInteger(&buf, i*3+2, &rc);
  172002. sessionAppendStr(&buf, "=0 OR ", &rc);
  172003. sessionAppendIdent(&buf, p->azCol[i], &rc);
  172004. sessionAppendStr(&buf, " IS ?", &rc);
  172005. sessionAppendInteger(&buf, i*3+1, &rc);
  172006. sessionAppendStr(&buf, ")", &rc);
  172007. }
  172008. }
  172009. sessionAppendStr(&buf, ")", &rc);
  172010. if( rc==SQLITE_OK ){
  172011. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, &p->pUpdate, 0);
  172012. }
  172013. sqlite3_free(buf.aBuf);
  172014. return rc;
  172015. }
  172016. /*
  172017. ** Formulate and prepare an SQL statement to query table zTab by primary
  172018. ** key. Assuming the following table structure:
  172019. **
  172020. ** CREATE TABLE x(a, b, c, d, PRIMARY KEY(a, c));
  172021. **
  172022. ** The SELECT statement looks like this:
  172023. **
  172024. ** SELECT * FROM x WHERE a = ?1 AND c = ?3
  172025. **
  172026. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pSelect is left
  172027. ** pointing to the prepared version of the SQL statement.
  172028. */
  172029. static int sessionSelectRow(
  172030. sqlite3 *db, /* Database handle */
  172031. const char *zTab, /* Table name */
  172032. SessionApplyCtx *p /* Session changeset-apply context */
  172033. ){
  172034. return sessionSelectStmt(
  172035. db, "main", zTab, p->nCol, p->azCol, p->abPK, &p->pSelect);
  172036. }
  172037. /*
  172038. ** Formulate and prepare an INSERT statement to add a record to table zTab.
  172039. ** For example:
  172040. **
  172041. ** INSERT INTO main."zTab" VALUES(?1, ?2, ?3 ...);
  172042. **
  172043. ** If successful, SQLITE_OK is returned and SessionApplyCtx.pInsert is left
  172044. ** pointing to the prepared version of the SQL statement.
  172045. */
  172046. static int sessionInsertRow(
  172047. sqlite3 *db, /* Database handle */
  172048. const char *zTab, /* Table name */
  172049. SessionApplyCtx *p /* Session changeset-apply context */
  172050. ){
  172051. int rc = SQLITE_OK;
  172052. int i;
  172053. SessionBuffer buf = {0, 0, 0};
  172054. sessionAppendStr(&buf, "INSERT INTO main.", &rc);
  172055. sessionAppendIdent(&buf, zTab, &rc);
  172056. sessionAppendStr(&buf, "(", &rc);
  172057. for(i=0; i<p->nCol; i++){
  172058. if( i!=0 ) sessionAppendStr(&buf, ", ", &rc);
  172059. sessionAppendIdent(&buf, p->azCol[i], &rc);
  172060. }
  172061. sessionAppendStr(&buf, ") VALUES(?", &rc);
  172062. for(i=1; i<p->nCol; i++){
  172063. sessionAppendStr(&buf, ", ?", &rc);
  172064. }
  172065. sessionAppendStr(&buf, ")", &rc);
  172066. if( rc==SQLITE_OK ){
  172067. rc = sqlite3_prepare_v2(db, (char *)buf.aBuf, buf.nBuf, &p->pInsert, 0);
  172068. }
  172069. sqlite3_free(buf.aBuf);
  172070. return rc;
  172071. }
  172072. static int sessionPrepare(sqlite3 *db, sqlite3_stmt **pp, const char *zSql){
  172073. return sqlite3_prepare_v2(db, zSql, -1, pp, 0);
  172074. }
  172075. /*
  172076. ** Prepare statements for applying changes to the sqlite_stat1 table.
  172077. ** These are similar to those created by sessionSelectRow(),
  172078. ** sessionInsertRow(), sessionUpdateRow() and sessionDeleteRow() for
  172079. ** other tables.
  172080. */
  172081. static int sessionStat1Sql(sqlite3 *db, SessionApplyCtx *p){
  172082. int rc = sessionSelectRow(db, "sqlite_stat1", p);
  172083. if( rc==SQLITE_OK ){
  172084. rc = sessionPrepare(db, &p->pInsert,
  172085. "INSERT INTO main.sqlite_stat1 VALUES(?1, "
  172086. "CASE WHEN length(?2)=0 AND typeof(?2)='blob' THEN NULL ELSE ?2 END, "
  172087. "?3)"
  172088. );
  172089. }
  172090. if( rc==SQLITE_OK ){
  172091. rc = sessionPrepare(db, &p->pUpdate,
  172092. "UPDATE main.sqlite_stat1 SET "
  172093. "tbl = CASE WHEN ?2 THEN ?3 ELSE tbl END, "
  172094. "idx = CASE WHEN ?5 THEN ?6 ELSE idx END, "
  172095. "stat = CASE WHEN ?8 THEN ?9 ELSE stat END "
  172096. "WHERE tbl=?1 AND idx IS "
  172097. "CASE WHEN length(?4)=0 AND typeof(?4)='blob' THEN NULL ELSE ?4 END "
  172098. "AND (?10 OR ?8=0 OR stat IS ?7)"
  172099. );
  172100. }
  172101. if( rc==SQLITE_OK ){
  172102. rc = sessionPrepare(db, &p->pDelete,
  172103. "DELETE FROM main.sqlite_stat1 WHERE tbl=?1 AND idx IS "
  172104. "CASE WHEN length(?2)=0 AND typeof(?2)='blob' THEN NULL ELSE ?2 END "
  172105. "AND (?4 OR stat IS ?3)"
  172106. );
  172107. }
  172108. return rc;
  172109. }
  172110. /*
  172111. ** A wrapper around sqlite3_bind_value() that detects an extra problem.
  172112. ** See comments in the body of this function for details.
  172113. */
  172114. static int sessionBindValue(
  172115. sqlite3_stmt *pStmt, /* Statement to bind value to */
  172116. int i, /* Parameter number to bind to */
  172117. sqlite3_value *pVal /* Value to bind */
  172118. ){
  172119. int eType = sqlite3_value_type(pVal);
  172120. /* COVERAGE: The (pVal->z==0) branch is never true using current versions
  172121. ** of SQLite. If a malloc fails in an sqlite3_value_xxx() function, either
  172122. ** the (pVal->z) variable remains as it was or the type of the value is
  172123. ** set to SQLITE_NULL. */
  172124. if( (eType==SQLITE_TEXT || eType==SQLITE_BLOB) && pVal->z==0 ){
  172125. /* This condition occurs when an earlier OOM in a call to
  172126. ** sqlite3_value_text() or sqlite3_value_blob() (perhaps from within
  172127. ** a conflict-handler) has zeroed the pVal->z pointer. Return NOMEM. */
  172128. return SQLITE_NOMEM;
  172129. }
  172130. return sqlite3_bind_value(pStmt, i, pVal);
  172131. }
  172132. /*
  172133. ** Iterator pIter must point to an SQLITE_INSERT entry. This function
  172134. ** transfers new.* values from the current iterator entry to statement
  172135. ** pStmt. The table being inserted into has nCol columns.
  172136. **
  172137. ** New.* value $i from the iterator is bound to variable ($i+1) of
  172138. ** statement pStmt. If parameter abPK is NULL, all values from 0 to (nCol-1)
  172139. ** are transfered to the statement. Otherwise, if abPK is not NULL, it points
  172140. ** to an array nCol elements in size. In this case only those values for
  172141. ** which abPK[$i] is true are read from the iterator and bound to the
  172142. ** statement.
  172143. **
  172144. ** An SQLite error code is returned if an error occurs. Otherwise, SQLITE_OK.
  172145. */
  172146. static int sessionBindRow(
  172147. sqlite3_changeset_iter *pIter, /* Iterator to read values from */
  172148. int(*xValue)(sqlite3_changeset_iter *, int, sqlite3_value **),
  172149. int nCol, /* Number of columns */
  172150. u8 *abPK, /* If not NULL, bind only if true */
  172151. sqlite3_stmt *pStmt /* Bind values to this statement */
  172152. ){
  172153. int i;
  172154. int rc = SQLITE_OK;
  172155. /* Neither sqlite3changeset_old or sqlite3changeset_new can fail if the
  172156. ** argument iterator points to a suitable entry. Make sure that xValue
  172157. ** is one of these to guarantee that it is safe to ignore the return
  172158. ** in the code below. */
  172159. assert( xValue==sqlite3changeset_old || xValue==sqlite3changeset_new );
  172160. for(i=0; rc==SQLITE_OK && i<nCol; i++){
  172161. if( !abPK || abPK[i] ){
  172162. sqlite3_value *pVal;
  172163. (void)xValue(pIter, i, &pVal);
  172164. if( pVal==0 ){
  172165. /* The value in the changeset was "undefined". This indicates a
  172166. ** corrupt changeset blob. */
  172167. rc = SQLITE_CORRUPT_BKPT;
  172168. }else{
  172169. rc = sessionBindValue(pStmt, i+1, pVal);
  172170. }
  172171. }
  172172. }
  172173. return rc;
  172174. }
  172175. /*
  172176. ** SQL statement pSelect is as generated by the sessionSelectRow() function.
  172177. ** This function binds the primary key values from the change that changeset
  172178. ** iterator pIter points to to the SELECT and attempts to seek to the table
  172179. ** entry. If a row is found, the SELECT statement left pointing at the row
  172180. ** and SQLITE_ROW is returned. Otherwise, if no row is found and no error
  172181. ** has occured, the statement is reset and SQLITE_OK is returned. If an
  172182. ** error occurs, the statement is reset and an SQLite error code is returned.
  172183. **
  172184. ** If this function returns SQLITE_ROW, the caller must eventually reset()
  172185. ** statement pSelect. If any other value is returned, the statement does
  172186. ** not require a reset().
  172187. **
  172188. ** If the iterator currently points to an INSERT record, bind values from the
  172189. ** new.* record to the SELECT statement. Or, if it points to a DELETE or
  172190. ** UPDATE, bind values from the old.* record.
  172191. */
  172192. static int sessionSeekToRow(
  172193. sqlite3 *db, /* Database handle */
  172194. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  172195. u8 *abPK, /* Primary key flags array */
  172196. sqlite3_stmt *pSelect /* SELECT statement from sessionSelectRow() */
  172197. ){
  172198. int rc; /* Return code */
  172199. int nCol; /* Number of columns in table */
  172200. int op; /* Changset operation (SQLITE_UPDATE etc.) */
  172201. const char *zDummy; /* Unused */
  172202. sqlite3changeset_op(pIter, &zDummy, &nCol, &op, 0);
  172203. rc = sessionBindRow(pIter,
  172204. op==SQLITE_INSERT ? sqlite3changeset_new : sqlite3changeset_old,
  172205. nCol, abPK, pSelect
  172206. );
  172207. if( rc==SQLITE_OK ){
  172208. rc = sqlite3_step(pSelect);
  172209. if( rc!=SQLITE_ROW ) rc = sqlite3_reset(pSelect);
  172210. }
  172211. return rc;
  172212. }
  172213. /*
  172214. ** This function is called from within sqlite3changset_apply_v2() when
  172215. ** a conflict is encountered and resolved using conflict resolution
  172216. ** mode eType (either SQLITE_CHANGESET_OMIT or SQLITE_CHANGESET_REPLACE)..
  172217. ** It adds a conflict resolution record to the buffer in
  172218. ** SessionApplyCtx.rebase, which will eventually be returned to the caller
  172219. ** of apply_v2() as the "rebase" buffer.
  172220. **
  172221. ** Return SQLITE_OK if successful, or an SQLite error code otherwise.
  172222. */
  172223. static int sessionRebaseAdd(
  172224. SessionApplyCtx *p, /* Apply context */
  172225. int eType, /* Conflict resolution (OMIT or REPLACE) */
  172226. sqlite3_changeset_iter *pIter /* Iterator pointing at current change */
  172227. ){
  172228. int rc = SQLITE_OK;
  172229. int i;
  172230. int eOp = pIter->op;
  172231. if( p->bRebaseStarted==0 ){
  172232. /* Append a table-header to the rebase buffer */
  172233. const char *zTab = pIter->zTab;
  172234. sessionAppendByte(&p->rebase, 'T', &rc);
  172235. sessionAppendVarint(&p->rebase, p->nCol, &rc);
  172236. sessionAppendBlob(&p->rebase, p->abPK, p->nCol, &rc);
  172237. sessionAppendBlob(&p->rebase, (u8*)zTab, (int)strlen(zTab)+1, &rc);
  172238. p->bRebaseStarted = 1;
  172239. }
  172240. assert( eType==SQLITE_CHANGESET_REPLACE||eType==SQLITE_CHANGESET_OMIT );
  172241. assert( eOp==SQLITE_DELETE || eOp==SQLITE_INSERT || eOp==SQLITE_UPDATE );
  172242. sessionAppendByte(&p->rebase,
  172243. (eOp==SQLITE_DELETE ? SQLITE_DELETE : SQLITE_INSERT), &rc
  172244. );
  172245. sessionAppendByte(&p->rebase, (eType==SQLITE_CHANGESET_REPLACE), &rc);
  172246. for(i=0; i<p->nCol; i++){
  172247. sqlite3_value *pVal = 0;
  172248. if( eOp==SQLITE_DELETE || (eOp==SQLITE_UPDATE && p->abPK[i]) ){
  172249. sqlite3changeset_old(pIter, i, &pVal);
  172250. }else{
  172251. sqlite3changeset_new(pIter, i, &pVal);
  172252. }
  172253. sessionAppendValue(&p->rebase, pVal, &rc);
  172254. }
  172255. return rc;
  172256. }
  172257. /*
  172258. ** Invoke the conflict handler for the change that the changeset iterator
  172259. ** currently points to.
  172260. **
  172261. ** Argument eType must be either CHANGESET_DATA or CHANGESET_CONFLICT.
  172262. ** If argument pbReplace is NULL, then the type of conflict handler invoked
  172263. ** depends solely on eType, as follows:
  172264. **
  172265. ** eType value Value passed to xConflict
  172266. ** -------------------------------------------------
  172267. ** CHANGESET_DATA CHANGESET_NOTFOUND
  172268. ** CHANGESET_CONFLICT CHANGESET_CONSTRAINT
  172269. **
  172270. ** Or, if pbReplace is not NULL, then an attempt is made to find an existing
  172271. ** record with the same primary key as the record about to be deleted, updated
  172272. ** or inserted. If such a record can be found, it is available to the conflict
  172273. ** handler as the "conflicting" record. In this case the type of conflict
  172274. ** handler invoked is as follows:
  172275. **
  172276. ** eType value PK Record found? Value passed to xConflict
  172277. ** ----------------------------------------------------------------
  172278. ** CHANGESET_DATA Yes CHANGESET_DATA
  172279. ** CHANGESET_DATA No CHANGESET_NOTFOUND
  172280. ** CHANGESET_CONFLICT Yes CHANGESET_CONFLICT
  172281. ** CHANGESET_CONFLICT No CHANGESET_CONSTRAINT
  172282. **
  172283. ** If pbReplace is not NULL, and a record with a matching PK is found, and
  172284. ** the conflict handler function returns SQLITE_CHANGESET_REPLACE, *pbReplace
  172285. ** is set to non-zero before returning SQLITE_OK.
  172286. **
  172287. ** If the conflict handler returns SQLITE_CHANGESET_ABORT, SQLITE_ABORT is
  172288. ** returned. Or, if the conflict handler returns an invalid value,
  172289. ** SQLITE_MISUSE. If the conflict handler returns SQLITE_CHANGESET_OMIT,
  172290. ** this function returns SQLITE_OK.
  172291. */
  172292. static int sessionConflictHandler(
  172293. int eType, /* Either CHANGESET_DATA or CONFLICT */
  172294. SessionApplyCtx *p, /* changeset_apply() context */
  172295. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  172296. int(*xConflict)(void *, int, sqlite3_changeset_iter*),
  172297. void *pCtx, /* First argument for conflict handler */
  172298. int *pbReplace /* OUT: Set to true if PK row is found */
  172299. ){
  172300. int res = 0; /* Value returned by conflict handler */
  172301. int rc;
  172302. int nCol;
  172303. int op;
  172304. const char *zDummy;
  172305. sqlite3changeset_op(pIter, &zDummy, &nCol, &op, 0);
  172306. assert( eType==SQLITE_CHANGESET_CONFLICT || eType==SQLITE_CHANGESET_DATA );
  172307. assert( SQLITE_CHANGESET_CONFLICT+1==SQLITE_CHANGESET_CONSTRAINT );
  172308. assert( SQLITE_CHANGESET_DATA+1==SQLITE_CHANGESET_NOTFOUND );
  172309. /* Bind the new.* PRIMARY KEY values to the SELECT statement. */
  172310. if( pbReplace ){
  172311. rc = sessionSeekToRow(p->db, pIter, p->abPK, p->pSelect);
  172312. }else{
  172313. rc = SQLITE_OK;
  172314. }
  172315. if( rc==SQLITE_ROW ){
  172316. /* There exists another row with the new.* primary key. */
  172317. pIter->pConflict = p->pSelect;
  172318. res = xConflict(pCtx, eType, pIter);
  172319. pIter->pConflict = 0;
  172320. rc = sqlite3_reset(p->pSelect);
  172321. }else if( rc==SQLITE_OK ){
  172322. if( p->bDeferConstraints && eType==SQLITE_CHANGESET_CONFLICT ){
  172323. /* Instead of invoking the conflict handler, append the change blob
  172324. ** to the SessionApplyCtx.constraints buffer. */
  172325. u8 *aBlob = &pIter->in.aData[pIter->in.iCurrent];
  172326. int nBlob = pIter->in.iNext - pIter->in.iCurrent;
  172327. sessionAppendBlob(&p->constraints, aBlob, nBlob, &rc);
  172328. return SQLITE_OK;
  172329. }else{
  172330. /* No other row with the new.* primary key. */
  172331. res = xConflict(pCtx, eType+1, pIter);
  172332. if( res==SQLITE_CHANGESET_REPLACE ) rc = SQLITE_MISUSE;
  172333. }
  172334. }
  172335. if( rc==SQLITE_OK ){
  172336. switch( res ){
  172337. case SQLITE_CHANGESET_REPLACE:
  172338. assert( pbReplace );
  172339. *pbReplace = 1;
  172340. break;
  172341. case SQLITE_CHANGESET_OMIT:
  172342. break;
  172343. case SQLITE_CHANGESET_ABORT:
  172344. rc = SQLITE_ABORT;
  172345. break;
  172346. default:
  172347. rc = SQLITE_MISUSE;
  172348. break;
  172349. }
  172350. if( rc==SQLITE_OK ){
  172351. rc = sessionRebaseAdd(p, res, pIter);
  172352. }
  172353. }
  172354. return rc;
  172355. }
  172356. /*
  172357. ** Attempt to apply the change that the iterator passed as the first argument
  172358. ** currently points to to the database. If a conflict is encountered, invoke
  172359. ** the conflict handler callback.
  172360. **
  172361. ** If argument pbRetry is NULL, then ignore any CHANGESET_DATA conflict. If
  172362. ** one is encountered, update or delete the row with the matching primary key
  172363. ** instead. Or, if pbRetry is not NULL and a CHANGESET_DATA conflict occurs,
  172364. ** invoke the conflict handler. If it returns CHANGESET_REPLACE, set *pbRetry
  172365. ** to true before returning. In this case the caller will invoke this function
  172366. ** again, this time with pbRetry set to NULL.
  172367. **
  172368. ** If argument pbReplace is NULL and a CHANGESET_CONFLICT conflict is
  172369. ** encountered invoke the conflict handler with CHANGESET_CONSTRAINT instead.
  172370. ** Or, if pbReplace is not NULL, invoke it with CHANGESET_CONFLICT. If such
  172371. ** an invocation returns SQLITE_CHANGESET_REPLACE, set *pbReplace to true
  172372. ** before retrying. In this case the caller attempts to remove the conflicting
  172373. ** row before invoking this function again, this time with pbReplace set
  172374. ** to NULL.
  172375. **
  172376. ** If any conflict handler returns SQLITE_CHANGESET_ABORT, this function
  172377. ** returns SQLITE_ABORT. Otherwise, if no error occurs, SQLITE_OK is
  172378. ** returned.
  172379. */
  172380. static int sessionApplyOneOp(
  172381. sqlite3_changeset_iter *pIter, /* Changeset iterator */
  172382. SessionApplyCtx *p, /* changeset_apply() context */
  172383. int(*xConflict)(void *, int, sqlite3_changeset_iter *),
  172384. void *pCtx, /* First argument for the conflict handler */
  172385. int *pbReplace, /* OUT: True to remove PK row and retry */
  172386. int *pbRetry /* OUT: True to retry. */
  172387. ){
  172388. const char *zDummy;
  172389. int op;
  172390. int nCol;
  172391. int rc = SQLITE_OK;
  172392. assert( p->pDelete && p->pUpdate && p->pInsert && p->pSelect );
  172393. assert( p->azCol && p->abPK );
  172394. assert( !pbReplace || *pbReplace==0 );
  172395. sqlite3changeset_op(pIter, &zDummy, &nCol, &op, 0);
  172396. if( op==SQLITE_DELETE ){
  172397. /* Bind values to the DELETE statement. If conflict handling is required,
  172398. ** bind values for all columns and set bound variable (nCol+1) to true.
  172399. ** Or, if conflict handling is not required, bind just the PK column
  172400. ** values and, if it exists, set (nCol+1) to false. Conflict handling
  172401. ** is not required if:
  172402. **
  172403. ** * this is a patchset, or
  172404. ** * (pbRetry==0), or
  172405. ** * all columns of the table are PK columns (in this case there is
  172406. ** no (nCol+1) variable to bind to).
  172407. */
  172408. u8 *abPK = (pIter->bPatchset ? p->abPK : 0);
  172409. rc = sessionBindRow(pIter, sqlite3changeset_old, nCol, abPK, p->pDelete);
  172410. if( rc==SQLITE_OK && sqlite3_bind_parameter_count(p->pDelete)>nCol ){
  172411. rc = sqlite3_bind_int(p->pDelete, nCol+1, (pbRetry==0 || abPK));
  172412. }
  172413. if( rc!=SQLITE_OK ) return rc;
  172414. sqlite3_step(p->pDelete);
  172415. rc = sqlite3_reset(p->pDelete);
  172416. if( rc==SQLITE_OK && sqlite3_changes(p->db)==0 ){
  172417. rc = sessionConflictHandler(
  172418. SQLITE_CHANGESET_DATA, p, pIter, xConflict, pCtx, pbRetry
  172419. );
  172420. }else if( (rc&0xff)==SQLITE_CONSTRAINT ){
  172421. rc = sessionConflictHandler(
  172422. SQLITE_CHANGESET_CONFLICT, p, pIter, xConflict, pCtx, 0
  172423. );
  172424. }
  172425. }else if( op==SQLITE_UPDATE ){
  172426. int i;
  172427. /* Bind values to the UPDATE statement. */
  172428. for(i=0; rc==SQLITE_OK && i<nCol; i++){
  172429. sqlite3_value *pOld = sessionChangesetOld(pIter, i);
  172430. sqlite3_value *pNew = sessionChangesetNew(pIter, i);
  172431. sqlite3_bind_int(p->pUpdate, i*3+2, !!pNew);
  172432. if( pOld ){
  172433. rc = sessionBindValue(p->pUpdate, i*3+1, pOld);
  172434. }
  172435. if( rc==SQLITE_OK && pNew ){
  172436. rc = sessionBindValue(p->pUpdate, i*3+3, pNew);
  172437. }
  172438. }
  172439. if( rc==SQLITE_OK ){
  172440. sqlite3_bind_int(p->pUpdate, nCol*3+1, pbRetry==0 || pIter->bPatchset);
  172441. }
  172442. if( rc!=SQLITE_OK ) return rc;
  172443. /* Attempt the UPDATE. In the case of a NOTFOUND or DATA conflict,
  172444. ** the result will be SQLITE_OK with 0 rows modified. */
  172445. sqlite3_step(p->pUpdate);
  172446. rc = sqlite3_reset(p->pUpdate);
  172447. if( rc==SQLITE_OK && sqlite3_changes(p->db)==0 ){
  172448. /* A NOTFOUND or DATA error. Search the table to see if it contains
  172449. ** a row with a matching primary key. If so, this is a DATA conflict.
  172450. ** Otherwise, if there is no primary key match, it is a NOTFOUND. */
  172451. rc = sessionConflictHandler(
  172452. SQLITE_CHANGESET_DATA, p, pIter, xConflict, pCtx, pbRetry
  172453. );
  172454. }else if( (rc&0xff)==SQLITE_CONSTRAINT ){
  172455. /* This is always a CONSTRAINT conflict. */
  172456. rc = sessionConflictHandler(
  172457. SQLITE_CHANGESET_CONFLICT, p, pIter, xConflict, pCtx, 0
  172458. );
  172459. }
  172460. }else{
  172461. assert( op==SQLITE_INSERT );
  172462. if( p->bStat1 ){
  172463. /* Check if there is a conflicting row. For sqlite_stat1, this needs
  172464. ** to be done using a SELECT, as there is no PRIMARY KEY in the
  172465. ** database schema to throw an exception if a duplicate is inserted. */
  172466. rc = sessionSeekToRow(p->db, pIter, p->abPK, p->pSelect);
  172467. if( rc==SQLITE_ROW ){
  172468. rc = SQLITE_CONSTRAINT;
  172469. sqlite3_reset(p->pSelect);
  172470. }
  172471. }
  172472. if( rc==SQLITE_OK ){
  172473. rc = sessionBindRow(pIter, sqlite3changeset_new, nCol, 0, p->pInsert);
  172474. if( rc!=SQLITE_OK ) return rc;
  172475. sqlite3_step(p->pInsert);
  172476. rc = sqlite3_reset(p->pInsert);
  172477. }
  172478. if( (rc&0xff)==SQLITE_CONSTRAINT ){
  172479. rc = sessionConflictHandler(
  172480. SQLITE_CHANGESET_CONFLICT, p, pIter, xConflict, pCtx, pbReplace
  172481. );
  172482. }
  172483. }
  172484. return rc;
  172485. }
  172486. /*
  172487. ** Attempt to apply the change that the iterator passed as the first argument
  172488. ** currently points to to the database. If a conflict is encountered, invoke
  172489. ** the conflict handler callback.
  172490. **
  172491. ** The difference between this function and sessionApplyOne() is that this
  172492. ** function handles the case where the conflict-handler is invoked and
  172493. ** returns SQLITE_CHANGESET_REPLACE - indicating that the change should be
  172494. ** retried in some manner.
  172495. */
  172496. static int sessionApplyOneWithRetry(
  172497. sqlite3 *db, /* Apply change to "main" db of this handle */
  172498. sqlite3_changeset_iter *pIter, /* Changeset iterator to read change from */
  172499. SessionApplyCtx *pApply, /* Apply context */
  172500. int(*xConflict)(void*, int, sqlite3_changeset_iter*),
  172501. void *pCtx /* First argument passed to xConflict */
  172502. ){
  172503. int bReplace = 0;
  172504. int bRetry = 0;
  172505. int rc;
  172506. rc = sessionApplyOneOp(pIter, pApply, xConflict, pCtx, &bReplace, &bRetry);
  172507. if( rc==SQLITE_OK ){
  172508. /* If the bRetry flag is set, the change has not been applied due to an
  172509. ** SQLITE_CHANGESET_DATA problem (i.e. this is an UPDATE or DELETE and
  172510. ** a row with the correct PK is present in the db, but one or more other
  172511. ** fields do not contain the expected values) and the conflict handler
  172512. ** returned SQLITE_CHANGESET_REPLACE. In this case retry the operation,
  172513. ** but pass NULL as the final argument so that sessionApplyOneOp() ignores
  172514. ** the SQLITE_CHANGESET_DATA problem. */
  172515. if( bRetry ){
  172516. assert( pIter->op==SQLITE_UPDATE || pIter->op==SQLITE_DELETE );
  172517. rc = sessionApplyOneOp(pIter, pApply, xConflict, pCtx, 0, 0);
  172518. }
  172519. /* If the bReplace flag is set, the change is an INSERT that has not
  172520. ** been performed because the database already contains a row with the
  172521. ** specified primary key and the conflict handler returned
  172522. ** SQLITE_CHANGESET_REPLACE. In this case remove the conflicting row
  172523. ** before reattempting the INSERT. */
  172524. else if( bReplace ){
  172525. assert( pIter->op==SQLITE_INSERT );
  172526. rc = sqlite3_exec(db, "SAVEPOINT replace_op", 0, 0, 0);
  172527. if( rc==SQLITE_OK ){
  172528. rc = sessionBindRow(pIter,
  172529. sqlite3changeset_new, pApply->nCol, pApply->abPK, pApply->pDelete);
  172530. sqlite3_bind_int(pApply->pDelete, pApply->nCol+1, 1);
  172531. }
  172532. if( rc==SQLITE_OK ){
  172533. sqlite3_step(pApply->pDelete);
  172534. rc = sqlite3_reset(pApply->pDelete);
  172535. }
  172536. if( rc==SQLITE_OK ){
  172537. rc = sessionApplyOneOp(pIter, pApply, xConflict, pCtx, 0, 0);
  172538. }
  172539. if( rc==SQLITE_OK ){
  172540. rc = sqlite3_exec(db, "RELEASE replace_op", 0, 0, 0);
  172541. }
  172542. }
  172543. }
  172544. return rc;
  172545. }
  172546. /*
  172547. ** Retry the changes accumulated in the pApply->constraints buffer.
  172548. */
  172549. static int sessionRetryConstraints(
  172550. sqlite3 *db,
  172551. int bPatchset,
  172552. const char *zTab,
  172553. SessionApplyCtx *pApply,
  172554. int(*xConflict)(void*, int, sqlite3_changeset_iter*),
  172555. void *pCtx /* First argument passed to xConflict */
  172556. ){
  172557. int rc = SQLITE_OK;
  172558. while( pApply->constraints.nBuf ){
  172559. sqlite3_changeset_iter *pIter2 = 0;
  172560. SessionBuffer cons = pApply->constraints;
  172561. memset(&pApply->constraints, 0, sizeof(SessionBuffer));
  172562. rc = sessionChangesetStart(&pIter2, 0, 0, cons.nBuf, cons.aBuf);
  172563. if( rc==SQLITE_OK ){
  172564. int nByte = 2*pApply->nCol*sizeof(sqlite3_value*);
  172565. int rc2;
  172566. pIter2->bPatchset = bPatchset;
  172567. pIter2->zTab = (char*)zTab;
  172568. pIter2->nCol = pApply->nCol;
  172569. pIter2->abPK = pApply->abPK;
  172570. sessionBufferGrow(&pIter2->tblhdr, nByte, &rc);
  172571. pIter2->apValue = (sqlite3_value**)pIter2->tblhdr.aBuf;
  172572. if( rc==SQLITE_OK ) memset(pIter2->apValue, 0, nByte);
  172573. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3changeset_next(pIter2) ){
  172574. rc = sessionApplyOneWithRetry(db, pIter2, pApply, xConflict, pCtx);
  172575. }
  172576. rc2 = sqlite3changeset_finalize(pIter2);
  172577. if( rc==SQLITE_OK ) rc = rc2;
  172578. }
  172579. assert( pApply->bDeferConstraints || pApply->constraints.nBuf==0 );
  172580. sqlite3_free(cons.aBuf);
  172581. if( rc!=SQLITE_OK ) break;
  172582. if( pApply->constraints.nBuf>=cons.nBuf ){
  172583. /* No progress was made on the last round. */
  172584. pApply->bDeferConstraints = 0;
  172585. }
  172586. }
  172587. return rc;
  172588. }
  172589. /*
  172590. ** Argument pIter is a changeset iterator that has been initialized, but
  172591. ** not yet passed to sqlite3changeset_next(). This function applies the
  172592. ** changeset to the main database attached to handle "db". The supplied
  172593. ** conflict handler callback is invoked to resolve any conflicts encountered
  172594. ** while applying the change.
  172595. */
  172596. static int sessionChangesetApply(
  172597. sqlite3 *db, /* Apply change to "main" db of this handle */
  172598. sqlite3_changeset_iter *pIter, /* Changeset to apply */
  172599. int(*xFilter)(
  172600. void *pCtx, /* Copy of sixth arg to _apply() */
  172601. const char *zTab /* Table name */
  172602. ),
  172603. int(*xConflict)(
  172604. void *pCtx, /* Copy of fifth arg to _apply() */
  172605. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  172606. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  172607. ),
  172608. void *pCtx, /* First argument passed to xConflict */
  172609. void **ppRebase, int *pnRebase, /* OUT: Rebase information */
  172610. int flags /* SESSION_APPLY_XXX flags */
  172611. ){
  172612. int schemaMismatch = 0;
  172613. int rc = SQLITE_OK; /* Return code */
  172614. const char *zTab = 0; /* Name of current table */
  172615. int nTab = 0; /* Result of sqlite3Strlen30(zTab) */
  172616. SessionApplyCtx sApply; /* changeset_apply() context object */
  172617. int bPatchset;
  172618. assert( xConflict!=0 );
  172619. pIter->in.bNoDiscard = 1;
  172620. memset(&sApply, 0, sizeof(sApply));
  172621. sqlite3_mutex_enter(sqlite3_db_mutex(db));
  172622. if( (flags & SQLITE_CHANGESETAPPLY_NOSAVEPOINT)==0 ){
  172623. rc = sqlite3_exec(db, "SAVEPOINT changeset_apply", 0, 0, 0);
  172624. }
  172625. if( rc==SQLITE_OK ){
  172626. rc = sqlite3_exec(db, "PRAGMA defer_foreign_keys = 1", 0, 0, 0);
  172627. }
  172628. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3changeset_next(pIter) ){
  172629. int nCol;
  172630. int op;
  172631. const char *zNew;
  172632. sqlite3changeset_op(pIter, &zNew, &nCol, &op, 0);
  172633. if( zTab==0 || sqlite3_strnicmp(zNew, zTab, nTab+1) ){
  172634. u8 *abPK;
  172635. rc = sessionRetryConstraints(
  172636. db, pIter->bPatchset, zTab, &sApply, xConflict, pCtx
  172637. );
  172638. if( rc!=SQLITE_OK ) break;
  172639. sqlite3_free((char*)sApply.azCol); /* cast works around VC++ bug */
  172640. sqlite3_finalize(sApply.pDelete);
  172641. sqlite3_finalize(sApply.pUpdate);
  172642. sqlite3_finalize(sApply.pInsert);
  172643. sqlite3_finalize(sApply.pSelect);
  172644. sApply.db = db;
  172645. sApply.pDelete = 0;
  172646. sApply.pUpdate = 0;
  172647. sApply.pInsert = 0;
  172648. sApply.pSelect = 0;
  172649. sApply.nCol = 0;
  172650. sApply.azCol = 0;
  172651. sApply.abPK = 0;
  172652. sApply.bStat1 = 0;
  172653. sApply.bDeferConstraints = 1;
  172654. sApply.bRebaseStarted = 0;
  172655. memset(&sApply.constraints, 0, sizeof(SessionBuffer));
  172656. /* If an xFilter() callback was specified, invoke it now. If the
  172657. ** xFilter callback returns zero, skip this table. If it returns
  172658. ** non-zero, proceed. */
  172659. schemaMismatch = (xFilter && (0==xFilter(pCtx, zNew)));
  172660. if( schemaMismatch ){
  172661. zTab = sqlite3_mprintf("%s", zNew);
  172662. if( zTab==0 ){
  172663. rc = SQLITE_NOMEM;
  172664. break;
  172665. }
  172666. nTab = (int)strlen(zTab);
  172667. sApply.azCol = (const char **)zTab;
  172668. }else{
  172669. int nMinCol = 0;
  172670. int i;
  172671. sqlite3changeset_pk(pIter, &abPK, 0);
  172672. rc = sessionTableInfo(
  172673. db, "main", zNew, &sApply.nCol, &zTab, &sApply.azCol, &sApply.abPK
  172674. );
  172675. if( rc!=SQLITE_OK ) break;
  172676. for(i=0; i<sApply.nCol; i++){
  172677. if( sApply.abPK[i] ) nMinCol = i+1;
  172678. }
  172679. if( sApply.nCol==0 ){
  172680. schemaMismatch = 1;
  172681. sqlite3_log(SQLITE_SCHEMA,
  172682. "sqlite3changeset_apply(): no such table: %s", zTab
  172683. );
  172684. }
  172685. else if( sApply.nCol<nCol ){
  172686. schemaMismatch = 1;
  172687. sqlite3_log(SQLITE_SCHEMA,
  172688. "sqlite3changeset_apply(): table %s has %d columns, "
  172689. "expected %d or more",
  172690. zTab, sApply.nCol, nCol
  172691. );
  172692. }
  172693. else if( nCol<nMinCol || memcmp(sApply.abPK, abPK, nCol)!=0 ){
  172694. schemaMismatch = 1;
  172695. sqlite3_log(SQLITE_SCHEMA, "sqlite3changeset_apply(): "
  172696. "primary key mismatch for table %s", zTab
  172697. );
  172698. }
  172699. else{
  172700. sApply.nCol = nCol;
  172701. if( 0==sqlite3_stricmp(zTab, "sqlite_stat1") ){
  172702. if( (rc = sessionStat1Sql(db, &sApply) ) ){
  172703. break;
  172704. }
  172705. sApply.bStat1 = 1;
  172706. }else{
  172707. if((rc = sessionSelectRow(db, zTab, &sApply))
  172708. || (rc = sessionUpdateRow(db, zTab, &sApply))
  172709. || (rc = sessionDeleteRow(db, zTab, &sApply))
  172710. || (rc = sessionInsertRow(db, zTab, &sApply))
  172711. ){
  172712. break;
  172713. }
  172714. sApply.bStat1 = 0;
  172715. }
  172716. }
  172717. nTab = sqlite3Strlen30(zTab);
  172718. }
  172719. }
  172720. /* If there is a schema mismatch on the current table, proceed to the
  172721. ** next change. A log message has already been issued. */
  172722. if( schemaMismatch ) continue;
  172723. rc = sessionApplyOneWithRetry(db, pIter, &sApply, xConflict, pCtx);
  172724. }
  172725. bPatchset = pIter->bPatchset;
  172726. if( rc==SQLITE_OK ){
  172727. rc = sqlite3changeset_finalize(pIter);
  172728. }else{
  172729. sqlite3changeset_finalize(pIter);
  172730. }
  172731. if( rc==SQLITE_OK ){
  172732. rc = sessionRetryConstraints(db, bPatchset, zTab, &sApply, xConflict, pCtx);
  172733. }
  172734. if( rc==SQLITE_OK ){
  172735. int nFk, notUsed;
  172736. sqlite3_db_status(db, SQLITE_DBSTATUS_DEFERRED_FKS, &nFk, &notUsed, 0);
  172737. if( nFk!=0 ){
  172738. int res = SQLITE_CHANGESET_ABORT;
  172739. sqlite3_changeset_iter sIter;
  172740. memset(&sIter, 0, sizeof(sIter));
  172741. sIter.nCol = nFk;
  172742. res = xConflict(pCtx, SQLITE_CHANGESET_FOREIGN_KEY, &sIter);
  172743. if( res!=SQLITE_CHANGESET_OMIT ){
  172744. rc = SQLITE_CONSTRAINT;
  172745. }
  172746. }
  172747. }
  172748. sqlite3_exec(db, "PRAGMA defer_foreign_keys = 0", 0, 0, 0);
  172749. if( (flags & SQLITE_CHANGESETAPPLY_NOSAVEPOINT)==0 ){
  172750. if( rc==SQLITE_OK ){
  172751. rc = sqlite3_exec(db, "RELEASE changeset_apply", 0, 0, 0);
  172752. }else{
  172753. sqlite3_exec(db, "ROLLBACK TO changeset_apply", 0, 0, 0);
  172754. sqlite3_exec(db, "RELEASE changeset_apply", 0, 0, 0);
  172755. }
  172756. }
  172757. if( rc==SQLITE_OK && bPatchset==0 && ppRebase && pnRebase ){
  172758. *ppRebase = (void*)sApply.rebase.aBuf;
  172759. *pnRebase = sApply.rebase.nBuf;
  172760. sApply.rebase.aBuf = 0;
  172761. }
  172762. sqlite3_finalize(sApply.pInsert);
  172763. sqlite3_finalize(sApply.pDelete);
  172764. sqlite3_finalize(sApply.pUpdate);
  172765. sqlite3_finalize(sApply.pSelect);
  172766. sqlite3_free((char*)sApply.azCol); /* cast works around VC++ bug */
  172767. sqlite3_free((char*)sApply.constraints.aBuf);
  172768. sqlite3_free((char*)sApply.rebase.aBuf);
  172769. sqlite3_mutex_leave(sqlite3_db_mutex(db));
  172770. return rc;
  172771. }
  172772. /*
  172773. ** Apply the changeset passed via pChangeset/nChangeset to the main
  172774. ** database attached to handle "db".
  172775. */
  172776. SQLITE_API int sqlite3changeset_apply_v2(
  172777. sqlite3 *db, /* Apply change to "main" db of this handle */
  172778. int nChangeset, /* Size of changeset in bytes */
  172779. void *pChangeset, /* Changeset blob */
  172780. int(*xFilter)(
  172781. void *pCtx, /* Copy of sixth arg to _apply() */
  172782. const char *zTab /* Table name */
  172783. ),
  172784. int(*xConflict)(
  172785. void *pCtx, /* Copy of sixth arg to _apply() */
  172786. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  172787. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  172788. ),
  172789. void *pCtx, /* First argument passed to xConflict */
  172790. void **ppRebase, int *pnRebase,
  172791. int flags
  172792. ){
  172793. sqlite3_changeset_iter *pIter; /* Iterator to skip through changeset */
  172794. int rc = sqlite3changeset_start(&pIter, nChangeset, pChangeset);
  172795. if( rc==SQLITE_OK ){
  172796. rc = sessionChangesetApply(
  172797. db, pIter, xFilter, xConflict, pCtx, ppRebase, pnRebase, flags
  172798. );
  172799. }
  172800. return rc;
  172801. }
  172802. /*
  172803. ** Apply the changeset passed via pChangeset/nChangeset to the main database
  172804. ** attached to handle "db". Invoke the supplied conflict handler callback
  172805. ** to resolve any conflicts encountered while applying the change.
  172806. */
  172807. SQLITE_API int sqlite3changeset_apply(
  172808. sqlite3 *db, /* Apply change to "main" db of this handle */
  172809. int nChangeset, /* Size of changeset in bytes */
  172810. void *pChangeset, /* Changeset blob */
  172811. int(*xFilter)(
  172812. void *pCtx, /* Copy of sixth arg to _apply() */
  172813. const char *zTab /* Table name */
  172814. ),
  172815. int(*xConflict)(
  172816. void *pCtx, /* Copy of fifth arg to _apply() */
  172817. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  172818. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  172819. ),
  172820. void *pCtx /* First argument passed to xConflict */
  172821. ){
  172822. return sqlite3changeset_apply_v2(
  172823. db, nChangeset, pChangeset, xFilter, xConflict, pCtx, 0, 0, 0
  172824. );
  172825. }
  172826. /*
  172827. ** Apply the changeset passed via xInput/pIn to the main database
  172828. ** attached to handle "db". Invoke the supplied conflict handler callback
  172829. ** to resolve any conflicts encountered while applying the change.
  172830. */
  172831. SQLITE_API int sqlite3changeset_apply_v2_strm(
  172832. sqlite3 *db, /* Apply change to "main" db of this handle */
  172833. int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
  172834. void *pIn, /* First arg for xInput */
  172835. int(*xFilter)(
  172836. void *pCtx, /* Copy of sixth arg to _apply() */
  172837. const char *zTab /* Table name */
  172838. ),
  172839. int(*xConflict)(
  172840. void *pCtx, /* Copy of sixth arg to _apply() */
  172841. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  172842. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  172843. ),
  172844. void *pCtx, /* First argument passed to xConflict */
  172845. void **ppRebase, int *pnRebase,
  172846. int flags
  172847. ){
  172848. sqlite3_changeset_iter *pIter; /* Iterator to skip through changeset */
  172849. int rc = sqlite3changeset_start_strm(&pIter, xInput, pIn);
  172850. if( rc==SQLITE_OK ){
  172851. rc = sessionChangesetApply(
  172852. db, pIter, xFilter, xConflict, pCtx, ppRebase, pnRebase, flags
  172853. );
  172854. }
  172855. return rc;
  172856. }
  172857. SQLITE_API int sqlite3changeset_apply_strm(
  172858. sqlite3 *db, /* Apply change to "main" db of this handle */
  172859. int (*xInput)(void *pIn, void *pData, int *pnData), /* Input function */
  172860. void *pIn, /* First arg for xInput */
  172861. int(*xFilter)(
  172862. void *pCtx, /* Copy of sixth arg to _apply() */
  172863. const char *zTab /* Table name */
  172864. ),
  172865. int(*xConflict)(
  172866. void *pCtx, /* Copy of sixth arg to _apply() */
  172867. int eConflict, /* DATA, MISSING, CONFLICT, CONSTRAINT */
  172868. sqlite3_changeset_iter *p /* Handle describing change and conflict */
  172869. ),
  172870. void *pCtx /* First argument passed to xConflict */
  172871. ){
  172872. return sqlite3changeset_apply_v2_strm(
  172873. db, xInput, pIn, xFilter, xConflict, pCtx, 0, 0, 0
  172874. );
  172875. }
  172876. /*
  172877. ** sqlite3_changegroup handle.
  172878. */
  172879. struct sqlite3_changegroup {
  172880. int rc; /* Error code */
  172881. int bPatch; /* True to accumulate patchsets */
  172882. SessionTable *pList; /* List of tables in current patch */
  172883. };
  172884. /*
  172885. ** This function is called to merge two changes to the same row together as
  172886. ** part of an sqlite3changeset_concat() operation. A new change object is
  172887. ** allocated and a pointer to it stored in *ppNew.
  172888. */
  172889. static int sessionChangeMerge(
  172890. SessionTable *pTab, /* Table structure */
  172891. int bRebase, /* True for a rebase hash-table */
  172892. int bPatchset, /* True for patchsets */
  172893. SessionChange *pExist, /* Existing change */
  172894. int op2, /* Second change operation */
  172895. int bIndirect, /* True if second change is indirect */
  172896. u8 *aRec, /* Second change record */
  172897. int nRec, /* Number of bytes in aRec */
  172898. SessionChange **ppNew /* OUT: Merged change */
  172899. ){
  172900. SessionChange *pNew = 0;
  172901. int rc = SQLITE_OK;
  172902. if( !pExist ){
  172903. pNew = (SessionChange *)sqlite3_malloc(sizeof(SessionChange) + nRec);
  172904. if( !pNew ){
  172905. return SQLITE_NOMEM;
  172906. }
  172907. memset(pNew, 0, sizeof(SessionChange));
  172908. pNew->op = op2;
  172909. pNew->bIndirect = bIndirect;
  172910. pNew->aRecord = (u8*)&pNew[1];
  172911. if( bIndirect==0 || bRebase==0 ){
  172912. pNew->nRecord = nRec;
  172913. memcpy(pNew->aRecord, aRec, nRec);
  172914. }else{
  172915. int i;
  172916. u8 *pIn = aRec;
  172917. u8 *pOut = pNew->aRecord;
  172918. for(i=0; i<pTab->nCol; i++){
  172919. int nIn = sessionSerialLen(pIn);
  172920. if( *pIn==0 ){
  172921. *pOut++ = 0;
  172922. }else if( pTab->abPK[i]==0 ){
  172923. *pOut++ = 0xFF;
  172924. }else{
  172925. memcpy(pOut, pIn, nIn);
  172926. pOut += nIn;
  172927. }
  172928. pIn += nIn;
  172929. }
  172930. pNew->nRecord = pOut - pNew->aRecord;
  172931. }
  172932. }else if( bRebase ){
  172933. if( pExist->op==SQLITE_DELETE && pExist->bIndirect ){
  172934. *ppNew = pExist;
  172935. }else{
  172936. int nByte = nRec + pExist->nRecord + sizeof(SessionChange);
  172937. pNew = (SessionChange*)sqlite3_malloc(nByte);
  172938. if( pNew==0 ){
  172939. rc = SQLITE_NOMEM;
  172940. }else{
  172941. int i;
  172942. u8 *a1 = pExist->aRecord;
  172943. u8 *a2 = aRec;
  172944. u8 *pOut;
  172945. memset(pNew, 0, nByte);
  172946. pNew->bIndirect = bIndirect || pExist->bIndirect;
  172947. pNew->op = op2;
  172948. pOut = pNew->aRecord = (u8*)&pNew[1];
  172949. for(i=0; i<pTab->nCol; i++){
  172950. int n1 = sessionSerialLen(a1);
  172951. int n2 = sessionSerialLen(a2);
  172952. if( *a1==0xFF || (pTab->abPK[i]==0 && bIndirect) ){
  172953. *pOut++ = 0xFF;
  172954. }else if( *a2==0 ){
  172955. memcpy(pOut, a1, n1);
  172956. pOut += n1;
  172957. }else{
  172958. memcpy(pOut, a2, n2);
  172959. pOut += n2;
  172960. }
  172961. a1 += n1;
  172962. a2 += n2;
  172963. }
  172964. pNew->nRecord = pOut - pNew->aRecord;
  172965. }
  172966. sqlite3_free(pExist);
  172967. }
  172968. }else{
  172969. int op1 = pExist->op;
  172970. /*
  172971. ** op1=INSERT, op2=INSERT -> Unsupported. Discard op2.
  172972. ** op1=INSERT, op2=UPDATE -> INSERT.
  172973. ** op1=INSERT, op2=DELETE -> (none)
  172974. **
  172975. ** op1=UPDATE, op2=INSERT -> Unsupported. Discard op2.
  172976. ** op1=UPDATE, op2=UPDATE -> UPDATE.
  172977. ** op1=UPDATE, op2=DELETE -> DELETE.
  172978. **
  172979. ** op1=DELETE, op2=INSERT -> UPDATE.
  172980. ** op1=DELETE, op2=UPDATE -> Unsupported. Discard op2.
  172981. ** op1=DELETE, op2=DELETE -> Unsupported. Discard op2.
  172982. */
  172983. if( (op1==SQLITE_INSERT && op2==SQLITE_INSERT)
  172984. || (op1==SQLITE_UPDATE && op2==SQLITE_INSERT)
  172985. || (op1==SQLITE_DELETE && op2==SQLITE_UPDATE)
  172986. || (op1==SQLITE_DELETE && op2==SQLITE_DELETE)
  172987. ){
  172988. pNew = pExist;
  172989. }else if( op1==SQLITE_INSERT && op2==SQLITE_DELETE ){
  172990. sqlite3_free(pExist);
  172991. assert( pNew==0 );
  172992. }else{
  172993. u8 *aExist = pExist->aRecord;
  172994. int nByte;
  172995. u8 *aCsr;
  172996. /* Allocate a new SessionChange object. Ensure that the aRecord[]
  172997. ** buffer of the new object is large enough to hold any record that
  172998. ** may be generated by combining the input records. */
  172999. nByte = sizeof(SessionChange) + pExist->nRecord + nRec;
  173000. pNew = (SessionChange *)sqlite3_malloc(nByte);
  173001. if( !pNew ){
  173002. sqlite3_free(pExist);
  173003. return SQLITE_NOMEM;
  173004. }
  173005. memset(pNew, 0, sizeof(SessionChange));
  173006. pNew->bIndirect = (bIndirect && pExist->bIndirect);
  173007. aCsr = pNew->aRecord = (u8 *)&pNew[1];
  173008. if( op1==SQLITE_INSERT ){ /* INSERT + UPDATE */
  173009. u8 *a1 = aRec;
  173010. assert( op2==SQLITE_UPDATE );
  173011. pNew->op = SQLITE_INSERT;
  173012. if( bPatchset==0 ) sessionSkipRecord(&a1, pTab->nCol);
  173013. sessionMergeRecord(&aCsr, pTab->nCol, aExist, a1);
  173014. }else if( op1==SQLITE_DELETE ){ /* DELETE + INSERT */
  173015. assert( op2==SQLITE_INSERT );
  173016. pNew->op = SQLITE_UPDATE;
  173017. if( bPatchset ){
  173018. memcpy(aCsr, aRec, nRec);
  173019. aCsr += nRec;
  173020. }else{
  173021. if( 0==sessionMergeUpdate(&aCsr, pTab, bPatchset, aExist, 0,aRec,0) ){
  173022. sqlite3_free(pNew);
  173023. pNew = 0;
  173024. }
  173025. }
  173026. }else if( op2==SQLITE_UPDATE ){ /* UPDATE + UPDATE */
  173027. u8 *a1 = aExist;
  173028. u8 *a2 = aRec;
  173029. assert( op1==SQLITE_UPDATE );
  173030. if( bPatchset==0 ){
  173031. sessionSkipRecord(&a1, pTab->nCol);
  173032. sessionSkipRecord(&a2, pTab->nCol);
  173033. }
  173034. pNew->op = SQLITE_UPDATE;
  173035. if( 0==sessionMergeUpdate(&aCsr, pTab, bPatchset, aRec, aExist,a1,a2) ){
  173036. sqlite3_free(pNew);
  173037. pNew = 0;
  173038. }
  173039. }else{ /* UPDATE + DELETE */
  173040. assert( op1==SQLITE_UPDATE && op2==SQLITE_DELETE );
  173041. pNew->op = SQLITE_DELETE;
  173042. if( bPatchset ){
  173043. memcpy(aCsr, aRec, nRec);
  173044. aCsr += nRec;
  173045. }else{
  173046. sessionMergeRecord(&aCsr, pTab->nCol, aRec, aExist);
  173047. }
  173048. }
  173049. if( pNew ){
  173050. pNew->nRecord = (int)(aCsr - pNew->aRecord);
  173051. }
  173052. sqlite3_free(pExist);
  173053. }
  173054. }
  173055. *ppNew = pNew;
  173056. return rc;
  173057. }
  173058. /*
  173059. ** Add all changes in the changeset traversed by the iterator passed as
  173060. ** the first argument to the changegroup hash tables.
  173061. */
  173062. static int sessionChangesetToHash(
  173063. sqlite3_changeset_iter *pIter, /* Iterator to read from */
  173064. sqlite3_changegroup *pGrp, /* Changegroup object to add changeset to */
  173065. int bRebase /* True if hash table is for rebasing */
  173066. ){
  173067. u8 *aRec;
  173068. int nRec;
  173069. int rc = SQLITE_OK;
  173070. SessionTable *pTab = 0;
  173071. while( SQLITE_ROW==sessionChangesetNext(pIter, &aRec, &nRec, 0) ){
  173072. const char *zNew;
  173073. int nCol;
  173074. int op;
  173075. int iHash;
  173076. int bIndirect;
  173077. SessionChange *pChange;
  173078. SessionChange *pExist = 0;
  173079. SessionChange **pp;
  173080. if( pGrp->pList==0 ){
  173081. pGrp->bPatch = pIter->bPatchset;
  173082. }else if( pIter->bPatchset!=pGrp->bPatch ){
  173083. rc = SQLITE_ERROR;
  173084. break;
  173085. }
  173086. sqlite3changeset_op(pIter, &zNew, &nCol, &op, &bIndirect);
  173087. if( !pTab || sqlite3_stricmp(zNew, pTab->zName) ){
  173088. /* Search the list for a matching table */
  173089. int nNew = (int)strlen(zNew);
  173090. u8 *abPK;
  173091. sqlite3changeset_pk(pIter, &abPK, 0);
  173092. for(pTab = pGrp->pList; pTab; pTab=pTab->pNext){
  173093. if( 0==sqlite3_strnicmp(pTab->zName, zNew, nNew+1) ) break;
  173094. }
  173095. if( !pTab ){
  173096. SessionTable **ppTab;
  173097. pTab = sqlite3_malloc(sizeof(SessionTable) + nCol + nNew+1);
  173098. if( !pTab ){
  173099. rc = SQLITE_NOMEM;
  173100. break;
  173101. }
  173102. memset(pTab, 0, sizeof(SessionTable));
  173103. pTab->nCol = nCol;
  173104. pTab->abPK = (u8*)&pTab[1];
  173105. memcpy(pTab->abPK, abPK, nCol);
  173106. pTab->zName = (char*)&pTab->abPK[nCol];
  173107. memcpy(pTab->zName, zNew, nNew+1);
  173108. /* The new object must be linked on to the end of the list, not
  173109. ** simply added to the start of it. This is to ensure that the
  173110. ** tables within the output of sqlite3changegroup_output() are in
  173111. ** the right order. */
  173112. for(ppTab=&pGrp->pList; *ppTab; ppTab=&(*ppTab)->pNext);
  173113. *ppTab = pTab;
  173114. }else if( pTab->nCol!=nCol || memcmp(pTab->abPK, abPK, nCol) ){
  173115. rc = SQLITE_SCHEMA;
  173116. break;
  173117. }
  173118. }
  173119. if( sessionGrowHash(pIter->bPatchset, pTab) ){
  173120. rc = SQLITE_NOMEM;
  173121. break;
  173122. }
  173123. iHash = sessionChangeHash(
  173124. pTab, (pIter->bPatchset && op==SQLITE_DELETE), aRec, pTab->nChange
  173125. );
  173126. /* Search for existing entry. If found, remove it from the hash table.
  173127. ** Code below may link it back in.
  173128. */
  173129. for(pp=&pTab->apChange[iHash]; *pp; pp=&(*pp)->pNext){
  173130. int bPkOnly1 = 0;
  173131. int bPkOnly2 = 0;
  173132. if( pIter->bPatchset ){
  173133. bPkOnly1 = (*pp)->op==SQLITE_DELETE;
  173134. bPkOnly2 = op==SQLITE_DELETE;
  173135. }
  173136. if( sessionChangeEqual(pTab, bPkOnly1, (*pp)->aRecord, bPkOnly2, aRec) ){
  173137. pExist = *pp;
  173138. *pp = (*pp)->pNext;
  173139. pTab->nEntry--;
  173140. break;
  173141. }
  173142. }
  173143. rc = sessionChangeMerge(pTab, bRebase,
  173144. pIter->bPatchset, pExist, op, bIndirect, aRec, nRec, &pChange
  173145. );
  173146. if( rc ) break;
  173147. if( pChange ){
  173148. pChange->pNext = pTab->apChange[iHash];
  173149. pTab->apChange[iHash] = pChange;
  173150. pTab->nEntry++;
  173151. }
  173152. }
  173153. if( rc==SQLITE_OK ) rc = pIter->rc;
  173154. return rc;
  173155. }
  173156. /*
  173157. ** Serialize a changeset (or patchset) based on all changesets (or patchsets)
  173158. ** added to the changegroup object passed as the first argument.
  173159. **
  173160. ** If xOutput is not NULL, then the changeset/patchset is returned to the
  173161. ** user via one or more calls to xOutput, as with the other streaming
  173162. ** interfaces.
  173163. **
  173164. ** Or, if xOutput is NULL, then (*ppOut) is populated with a pointer to a
  173165. ** buffer containing the output changeset before this function returns. In
  173166. ** this case (*pnOut) is set to the size of the output buffer in bytes. It
  173167. ** is the responsibility of the caller to free the output buffer using
  173168. ** sqlite3_free() when it is no longer required.
  173169. **
  173170. ** If successful, SQLITE_OK is returned. Or, if an error occurs, an SQLite
  173171. ** error code. If an error occurs and xOutput is NULL, (*ppOut) and (*pnOut)
  173172. ** are both set to 0 before returning.
  173173. */
  173174. static int sessionChangegroupOutput(
  173175. sqlite3_changegroup *pGrp,
  173176. int (*xOutput)(void *pOut, const void *pData, int nData),
  173177. void *pOut,
  173178. int *pnOut,
  173179. void **ppOut
  173180. ){
  173181. int rc = SQLITE_OK;
  173182. SessionBuffer buf = {0, 0, 0};
  173183. SessionTable *pTab;
  173184. assert( xOutput==0 || (ppOut==0 && pnOut==0) );
  173185. /* Create the serialized output changeset based on the contents of the
  173186. ** hash tables attached to the SessionTable objects in list p->pList.
  173187. */
  173188. for(pTab=pGrp->pList; rc==SQLITE_OK && pTab; pTab=pTab->pNext){
  173189. int i;
  173190. if( pTab->nEntry==0 ) continue;
  173191. sessionAppendTableHdr(&buf, pGrp->bPatch, pTab, &rc);
  173192. for(i=0; i<pTab->nChange; i++){
  173193. SessionChange *p;
  173194. for(p=pTab->apChange[i]; p; p=p->pNext){
  173195. sessionAppendByte(&buf, p->op, &rc);
  173196. sessionAppendByte(&buf, p->bIndirect, &rc);
  173197. sessionAppendBlob(&buf, p->aRecord, p->nRecord, &rc);
  173198. }
  173199. }
  173200. if( rc==SQLITE_OK && xOutput && buf.nBuf>=SESSIONS_STRM_CHUNK_SIZE ){
  173201. rc = xOutput(pOut, buf.aBuf, buf.nBuf);
  173202. buf.nBuf = 0;
  173203. }
  173204. }
  173205. if( rc==SQLITE_OK ){
  173206. if( xOutput ){
  173207. if( buf.nBuf>0 ) rc = xOutput(pOut, buf.aBuf, buf.nBuf);
  173208. }else{
  173209. *ppOut = buf.aBuf;
  173210. *pnOut = buf.nBuf;
  173211. buf.aBuf = 0;
  173212. }
  173213. }
  173214. sqlite3_free(buf.aBuf);
  173215. return rc;
  173216. }
  173217. /*
  173218. ** Allocate a new, empty, sqlite3_changegroup.
  173219. */
  173220. SQLITE_API int sqlite3changegroup_new(sqlite3_changegroup **pp){
  173221. int rc = SQLITE_OK; /* Return code */
  173222. sqlite3_changegroup *p; /* New object */
  173223. p = (sqlite3_changegroup*)sqlite3_malloc(sizeof(sqlite3_changegroup));
  173224. if( p==0 ){
  173225. rc = SQLITE_NOMEM;
  173226. }else{
  173227. memset(p, 0, sizeof(sqlite3_changegroup));
  173228. }
  173229. *pp = p;
  173230. return rc;
  173231. }
  173232. /*
  173233. ** Add the changeset currently stored in buffer pData, size nData bytes,
  173234. ** to changeset-group p.
  173235. */
  173236. SQLITE_API int sqlite3changegroup_add(sqlite3_changegroup *pGrp, int nData, void *pData){
  173237. sqlite3_changeset_iter *pIter; /* Iterator opened on pData/nData */
  173238. int rc; /* Return code */
  173239. rc = sqlite3changeset_start(&pIter, nData, pData);
  173240. if( rc==SQLITE_OK ){
  173241. rc = sessionChangesetToHash(pIter, pGrp, 0);
  173242. }
  173243. sqlite3changeset_finalize(pIter);
  173244. return rc;
  173245. }
  173246. /*
  173247. ** Obtain a buffer containing a changeset representing the concatenation
  173248. ** of all changesets added to the group so far.
  173249. */
  173250. SQLITE_API int sqlite3changegroup_output(
  173251. sqlite3_changegroup *pGrp,
  173252. int *pnData,
  173253. void **ppData
  173254. ){
  173255. return sessionChangegroupOutput(pGrp, 0, 0, pnData, ppData);
  173256. }
  173257. /*
  173258. ** Streaming versions of changegroup_add().
  173259. */
  173260. SQLITE_API int sqlite3changegroup_add_strm(
  173261. sqlite3_changegroup *pGrp,
  173262. int (*xInput)(void *pIn, void *pData, int *pnData),
  173263. void *pIn
  173264. ){
  173265. sqlite3_changeset_iter *pIter; /* Iterator opened on pData/nData */
  173266. int rc; /* Return code */
  173267. rc = sqlite3changeset_start_strm(&pIter, xInput, pIn);
  173268. if( rc==SQLITE_OK ){
  173269. rc = sessionChangesetToHash(pIter, pGrp, 0);
  173270. }
  173271. sqlite3changeset_finalize(pIter);
  173272. return rc;
  173273. }
  173274. /*
  173275. ** Streaming versions of changegroup_output().
  173276. */
  173277. SQLITE_API int sqlite3changegroup_output_strm(
  173278. sqlite3_changegroup *pGrp,
  173279. int (*xOutput)(void *pOut, const void *pData, int nData),
  173280. void *pOut
  173281. ){
  173282. return sessionChangegroupOutput(pGrp, xOutput, pOut, 0, 0);
  173283. }
  173284. /*
  173285. ** Delete a changegroup object.
  173286. */
  173287. SQLITE_API void sqlite3changegroup_delete(sqlite3_changegroup *pGrp){
  173288. if( pGrp ){
  173289. sessionDeleteTable(pGrp->pList);
  173290. sqlite3_free(pGrp);
  173291. }
  173292. }
  173293. /*
  173294. ** Combine two changesets together.
  173295. */
  173296. SQLITE_API int sqlite3changeset_concat(
  173297. int nLeft, /* Number of bytes in lhs input */
  173298. void *pLeft, /* Lhs input changeset */
  173299. int nRight /* Number of bytes in rhs input */,
  173300. void *pRight, /* Rhs input changeset */
  173301. int *pnOut, /* OUT: Number of bytes in output changeset */
  173302. void **ppOut /* OUT: changeset (left <concat> right) */
  173303. ){
  173304. sqlite3_changegroup *pGrp;
  173305. int rc;
  173306. rc = sqlite3changegroup_new(&pGrp);
  173307. if( rc==SQLITE_OK ){
  173308. rc = sqlite3changegroup_add(pGrp, nLeft, pLeft);
  173309. }
  173310. if( rc==SQLITE_OK ){
  173311. rc = sqlite3changegroup_add(pGrp, nRight, pRight);
  173312. }
  173313. if( rc==SQLITE_OK ){
  173314. rc = sqlite3changegroup_output(pGrp, pnOut, ppOut);
  173315. }
  173316. sqlite3changegroup_delete(pGrp);
  173317. return rc;
  173318. }
  173319. /*
  173320. ** Streaming version of sqlite3changeset_concat().
  173321. */
  173322. SQLITE_API int sqlite3changeset_concat_strm(
  173323. int (*xInputA)(void *pIn, void *pData, int *pnData),
  173324. void *pInA,
  173325. int (*xInputB)(void *pIn, void *pData, int *pnData),
  173326. void *pInB,
  173327. int (*xOutput)(void *pOut, const void *pData, int nData),
  173328. void *pOut
  173329. ){
  173330. sqlite3_changegroup *pGrp;
  173331. int rc;
  173332. rc = sqlite3changegroup_new(&pGrp);
  173333. if( rc==SQLITE_OK ){
  173334. rc = sqlite3changegroup_add_strm(pGrp, xInputA, pInA);
  173335. }
  173336. if( rc==SQLITE_OK ){
  173337. rc = sqlite3changegroup_add_strm(pGrp, xInputB, pInB);
  173338. }
  173339. if( rc==SQLITE_OK ){
  173340. rc = sqlite3changegroup_output_strm(pGrp, xOutput, pOut);
  173341. }
  173342. sqlite3changegroup_delete(pGrp);
  173343. return rc;
  173344. }
  173345. /*
  173346. ** Changeset rebaser handle.
  173347. */
  173348. struct sqlite3_rebaser {
  173349. sqlite3_changegroup grp; /* Hash table */
  173350. };
  173351. /*
  173352. ** Buffers a1 and a2 must both contain a sessions module record nCol
  173353. ** fields in size. This function appends an nCol sessions module
  173354. ** record to buffer pBuf that is a copy of a1, except that for
  173355. ** each field that is undefined in a1[], swap in the field from a2[].
  173356. */
  173357. static void sessionAppendRecordMerge(
  173358. SessionBuffer *pBuf, /* Buffer to append to */
  173359. int nCol, /* Number of columns in each record */
  173360. u8 *a1, int n1, /* Record 1 */
  173361. u8 *a2, int n2, /* Record 2 */
  173362. int *pRc /* IN/OUT: error code */
  173363. ){
  173364. sessionBufferGrow(pBuf, n1+n2, pRc);
  173365. if( *pRc==SQLITE_OK ){
  173366. int i;
  173367. u8 *pOut = &pBuf->aBuf[pBuf->nBuf];
  173368. for(i=0; i<nCol; i++){
  173369. int nn1 = sessionSerialLen(a1);
  173370. int nn2 = sessionSerialLen(a2);
  173371. if( *a1==0 || *a1==0xFF ){
  173372. memcpy(pOut, a2, nn2);
  173373. pOut += nn2;
  173374. }else{
  173375. memcpy(pOut, a1, nn1);
  173376. pOut += nn1;
  173377. }
  173378. a1 += nn1;
  173379. a2 += nn2;
  173380. }
  173381. pBuf->nBuf = pOut-pBuf->aBuf;
  173382. assert( pBuf->nBuf<=pBuf->nAlloc );
  173383. }
  173384. }
  173385. /*
  173386. ** This function is called when rebasing a local UPDATE change against one
  173387. ** or more remote UPDATE changes. The aRec/nRec buffer contains the current
  173388. ** old.* and new.* records for the change. The rebase buffer (a single
  173389. ** record) is in aChange/nChange. The rebased change is appended to buffer
  173390. ** pBuf.
  173391. **
  173392. ** Rebasing the UPDATE involves:
  173393. **
  173394. ** * Removing any changes to fields for which the corresponding field
  173395. ** in the rebase buffer is set to "replaced" (type 0xFF). If this
  173396. ** means the UPDATE change updates no fields, nothing is appended
  173397. ** to the output buffer.
  173398. **
  173399. ** * For each field modified by the local change for which the
  173400. ** corresponding field in the rebase buffer is not "undefined" (0x00)
  173401. ** or "replaced" (0xFF), the old.* value is replaced by the value
  173402. ** in the rebase buffer.
  173403. */
  173404. static void sessionAppendPartialUpdate(
  173405. SessionBuffer *pBuf, /* Append record here */
  173406. sqlite3_changeset_iter *pIter, /* Iterator pointed at local change */
  173407. u8 *aRec, int nRec, /* Local change */
  173408. u8 *aChange, int nChange, /* Record to rebase against */
  173409. int *pRc /* IN/OUT: Return Code */
  173410. ){
  173411. sessionBufferGrow(pBuf, 2+nRec+nChange, pRc);
  173412. if( *pRc==SQLITE_OK ){
  173413. int bData = 0;
  173414. u8 *pOut = &pBuf->aBuf[pBuf->nBuf];
  173415. int i;
  173416. u8 *a1 = aRec;
  173417. u8 *a2 = aChange;
  173418. *pOut++ = SQLITE_UPDATE;
  173419. *pOut++ = pIter->bIndirect;
  173420. for(i=0; i<pIter->nCol; i++){
  173421. int n1 = sessionSerialLen(a1);
  173422. int n2 = sessionSerialLen(a2);
  173423. if( pIter->abPK[i] || a2[0]==0 ){
  173424. if( !pIter->abPK[i] ) bData = 1;
  173425. memcpy(pOut, a1, n1);
  173426. pOut += n1;
  173427. }else if( a2[0]!=0xFF ){
  173428. bData = 1;
  173429. memcpy(pOut, a2, n2);
  173430. pOut += n2;
  173431. }else{
  173432. *pOut++ = '\0';
  173433. }
  173434. a1 += n1;
  173435. a2 += n2;
  173436. }
  173437. if( bData ){
  173438. a2 = aChange;
  173439. for(i=0; i<pIter->nCol; i++){
  173440. int n1 = sessionSerialLen(a1);
  173441. int n2 = sessionSerialLen(a2);
  173442. if( pIter->abPK[i] || a2[0]!=0xFF ){
  173443. memcpy(pOut, a1, n1);
  173444. pOut += n1;
  173445. }else{
  173446. *pOut++ = '\0';
  173447. }
  173448. a1 += n1;
  173449. a2 += n2;
  173450. }
  173451. pBuf->nBuf = (pOut - pBuf->aBuf);
  173452. }
  173453. }
  173454. }
  173455. /*
  173456. ** pIter is configured to iterate through a changeset. This function rebases
  173457. ** that changeset according to the current configuration of the rebaser
  173458. ** object passed as the first argument. If no error occurs and argument xOutput
  173459. ** is not NULL, then the changeset is returned to the caller by invoking
  173460. ** xOutput zero or more times and SQLITE_OK returned. Or, if xOutput is NULL,
  173461. ** then (*ppOut) is set to point to a buffer containing the rebased changeset
  173462. ** before this function returns. In this case (*pnOut) is set to the size of
  173463. ** the buffer in bytes. It is the responsibility of the caller to eventually
  173464. ** free the (*ppOut) buffer using sqlite3_free().
  173465. **
  173466. ** If an error occurs, an SQLite error code is returned. If ppOut and
  173467. ** pnOut are not NULL, then the two output parameters are set to 0 before
  173468. ** returning.
  173469. */
  173470. static int sessionRebase(
  173471. sqlite3_rebaser *p, /* Rebaser hash table */
  173472. sqlite3_changeset_iter *pIter, /* Input data */
  173473. int (*xOutput)(void *pOut, const void *pData, int nData),
  173474. void *pOut, /* Context for xOutput callback */
  173475. int *pnOut, /* OUT: Number of bytes in output changeset */
  173476. void **ppOut /* OUT: Inverse of pChangeset */
  173477. ){
  173478. int rc = SQLITE_OK;
  173479. u8 *aRec = 0;
  173480. int nRec = 0;
  173481. int bNew = 0;
  173482. SessionTable *pTab = 0;
  173483. SessionBuffer sOut = {0,0,0};
  173484. while( SQLITE_ROW==sessionChangesetNext(pIter, &aRec, &nRec, &bNew) ){
  173485. SessionChange *pChange = 0;
  173486. int bDone = 0;
  173487. if( bNew ){
  173488. const char *zTab = pIter->zTab;
  173489. for(pTab=p->grp.pList; pTab; pTab=pTab->pNext){
  173490. if( 0==sqlite3_stricmp(pTab->zName, zTab) ) break;
  173491. }
  173492. bNew = 0;
  173493. /* A patchset may not be rebased */
  173494. if( pIter->bPatchset ){
  173495. rc = SQLITE_ERROR;
  173496. }
  173497. /* Append a table header to the output for this new table */
  173498. sessionAppendByte(&sOut, pIter->bPatchset ? 'P' : 'T', &rc);
  173499. sessionAppendVarint(&sOut, pIter->nCol, &rc);
  173500. sessionAppendBlob(&sOut, pIter->abPK, pIter->nCol, &rc);
  173501. sessionAppendBlob(&sOut,(u8*)pIter->zTab,(int)strlen(pIter->zTab)+1,&rc);
  173502. }
  173503. if( pTab && rc==SQLITE_OK ){
  173504. int iHash = sessionChangeHash(pTab, 0, aRec, pTab->nChange);
  173505. for(pChange=pTab->apChange[iHash]; pChange; pChange=pChange->pNext){
  173506. if( sessionChangeEqual(pTab, 0, aRec, 0, pChange->aRecord) ){
  173507. break;
  173508. }
  173509. }
  173510. }
  173511. if( pChange ){
  173512. assert( pChange->op==SQLITE_DELETE || pChange->op==SQLITE_INSERT );
  173513. switch( pIter->op ){
  173514. case SQLITE_INSERT:
  173515. if( pChange->op==SQLITE_INSERT ){
  173516. bDone = 1;
  173517. if( pChange->bIndirect==0 ){
  173518. sessionAppendByte(&sOut, SQLITE_UPDATE, &rc);
  173519. sessionAppendByte(&sOut, pIter->bIndirect, &rc);
  173520. sessionAppendBlob(&sOut, pChange->aRecord, pChange->nRecord, &rc);
  173521. sessionAppendBlob(&sOut, aRec, nRec, &rc);
  173522. }
  173523. }
  173524. break;
  173525. case SQLITE_UPDATE:
  173526. bDone = 1;
  173527. if( pChange->op==SQLITE_DELETE ){
  173528. if( pChange->bIndirect==0 ){
  173529. u8 *pCsr = aRec;
  173530. sessionSkipRecord(&pCsr, pIter->nCol);
  173531. sessionAppendByte(&sOut, SQLITE_INSERT, &rc);
  173532. sessionAppendByte(&sOut, pIter->bIndirect, &rc);
  173533. sessionAppendRecordMerge(&sOut, pIter->nCol,
  173534. pCsr, nRec-(pCsr-aRec),
  173535. pChange->aRecord, pChange->nRecord, &rc
  173536. );
  173537. }
  173538. }else{
  173539. sessionAppendPartialUpdate(&sOut, pIter,
  173540. aRec, nRec, pChange->aRecord, pChange->nRecord, &rc
  173541. );
  173542. }
  173543. break;
  173544. default:
  173545. assert( pIter->op==SQLITE_DELETE );
  173546. bDone = 1;
  173547. if( pChange->op==SQLITE_INSERT ){
  173548. sessionAppendByte(&sOut, SQLITE_DELETE, &rc);
  173549. sessionAppendByte(&sOut, pIter->bIndirect, &rc);
  173550. sessionAppendRecordMerge(&sOut, pIter->nCol,
  173551. pChange->aRecord, pChange->nRecord, aRec, nRec, &rc
  173552. );
  173553. }
  173554. break;
  173555. }
  173556. }
  173557. if( bDone==0 ){
  173558. sessionAppendByte(&sOut, pIter->op, &rc);
  173559. sessionAppendByte(&sOut, pIter->bIndirect, &rc);
  173560. sessionAppendBlob(&sOut, aRec, nRec, &rc);
  173561. }
  173562. if( rc==SQLITE_OK && xOutput && sOut.nBuf>SESSIONS_STRM_CHUNK_SIZE ){
  173563. rc = xOutput(pOut, sOut.aBuf, sOut.nBuf);
  173564. sOut.nBuf = 0;
  173565. }
  173566. if( rc ) break;
  173567. }
  173568. if( rc!=SQLITE_OK ){
  173569. sqlite3_free(sOut.aBuf);
  173570. memset(&sOut, 0, sizeof(sOut));
  173571. }
  173572. if( rc==SQLITE_OK ){
  173573. if( xOutput ){
  173574. if( sOut.nBuf>0 ){
  173575. rc = xOutput(pOut, sOut.aBuf, sOut.nBuf);
  173576. }
  173577. }else{
  173578. *ppOut = (void*)sOut.aBuf;
  173579. *pnOut = sOut.nBuf;
  173580. sOut.aBuf = 0;
  173581. }
  173582. }
  173583. sqlite3_free(sOut.aBuf);
  173584. return rc;
  173585. }
  173586. /*
  173587. ** Create a new rebaser object.
  173588. */
  173589. SQLITE_API int sqlite3rebaser_create(sqlite3_rebaser **ppNew){
  173590. int rc = SQLITE_OK;
  173591. sqlite3_rebaser *pNew;
  173592. pNew = sqlite3_malloc(sizeof(sqlite3_rebaser));
  173593. if( pNew==0 ){
  173594. rc = SQLITE_NOMEM;
  173595. }else{
  173596. memset(pNew, 0, sizeof(sqlite3_rebaser));
  173597. }
  173598. *ppNew = pNew;
  173599. return rc;
  173600. }
  173601. /*
  173602. ** Call this one or more times to configure a rebaser.
  173603. */
  173604. SQLITE_API int sqlite3rebaser_configure(
  173605. sqlite3_rebaser *p,
  173606. int nRebase, const void *pRebase
  173607. ){
  173608. sqlite3_changeset_iter *pIter = 0; /* Iterator opened on pData/nData */
  173609. int rc; /* Return code */
  173610. rc = sqlite3changeset_start(&pIter, nRebase, (void*)pRebase);
  173611. if( rc==SQLITE_OK ){
  173612. rc = sessionChangesetToHash(pIter, &p->grp, 1);
  173613. }
  173614. sqlite3changeset_finalize(pIter);
  173615. return rc;
  173616. }
  173617. /*
  173618. ** Rebase a changeset according to current rebaser configuration
  173619. */
  173620. SQLITE_API int sqlite3rebaser_rebase(
  173621. sqlite3_rebaser *p,
  173622. int nIn, const void *pIn,
  173623. int *pnOut, void **ppOut
  173624. ){
  173625. sqlite3_changeset_iter *pIter = 0; /* Iterator to skip through input */
  173626. int rc = sqlite3changeset_start(&pIter, nIn, (void*)pIn);
  173627. if( rc==SQLITE_OK ){
  173628. rc = sessionRebase(p, pIter, 0, 0, pnOut, ppOut);
  173629. sqlite3changeset_finalize(pIter);
  173630. }
  173631. return rc;
  173632. }
  173633. /*
  173634. ** Rebase a changeset according to current rebaser configuration
  173635. */
  173636. SQLITE_API int sqlite3rebaser_rebase_strm(
  173637. sqlite3_rebaser *p,
  173638. int (*xInput)(void *pIn, void *pData, int *pnData),
  173639. void *pIn,
  173640. int (*xOutput)(void *pOut, const void *pData, int nData),
  173641. void *pOut
  173642. ){
  173643. sqlite3_changeset_iter *pIter = 0; /* Iterator to skip through input */
  173644. int rc = sqlite3changeset_start_strm(&pIter, xInput, pIn);
  173645. if( rc==SQLITE_OK ){
  173646. rc = sessionRebase(p, pIter, xOutput, pOut, 0, 0);
  173647. sqlite3changeset_finalize(pIter);
  173648. }
  173649. return rc;
  173650. }
  173651. /*
  173652. ** Destroy a rebaser object
  173653. */
  173654. SQLITE_API void sqlite3rebaser_delete(sqlite3_rebaser *p){
  173655. if( p ){
  173656. sessionDeleteTable(p->grp.pList);
  173657. sqlite3_free(p);
  173658. }
  173659. }
  173660. #endif /* SQLITE_ENABLE_SESSION && SQLITE_ENABLE_PREUPDATE_HOOK */
  173661. /************** End of sqlite3session.c **************************************/
  173662. /************** Begin file json1.c *******************************************/
  173663. /*
  173664. ** 2015-08-12
  173665. **
  173666. ** The author disclaims copyright to this source code. In place of
  173667. ** a legal notice, here is a blessing:
  173668. **
  173669. ** May you do good and not evil.
  173670. ** May you find forgiveness for yourself and forgive others.
  173671. ** May you share freely, never taking more than you give.
  173672. **
  173673. ******************************************************************************
  173674. **
  173675. ** This SQLite extension implements JSON functions. The interface is
  173676. ** modeled after MySQL JSON functions:
  173677. **
  173678. ** https://dev.mysql.com/doc/refman/5.7/en/json.html
  173679. **
  173680. ** For the time being, all JSON is stored as pure text. (We might add
  173681. ** a JSONB type in the future which stores a binary encoding of JSON in
  173682. ** a BLOB, but there is no support for JSONB in the current implementation.
  173683. ** This implementation parses JSON text at 250 MB/s, so it is hard to see
  173684. ** how JSONB might improve on that.)
  173685. */
  173686. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_JSON1)
  173687. #if !defined(SQLITEINT_H)
  173688. /* #include "sqlite3ext.h" */
  173689. #endif
  173690. SQLITE_EXTENSION_INIT1
  173691. /* #include <assert.h> */
  173692. /* #include <string.h> */
  173693. /* #include <stdlib.h> */
  173694. /* #include <stdarg.h> */
  173695. /* Mark a function parameter as unused, to suppress nuisance compiler
  173696. ** warnings. */
  173697. #ifndef UNUSED_PARAM
  173698. # define UNUSED_PARAM(X) (void)(X)
  173699. #endif
  173700. #ifndef LARGEST_INT64
  173701. # define LARGEST_INT64 (0xffffffff|(((sqlite3_int64)0x7fffffff)<<32))
  173702. # define SMALLEST_INT64 (((sqlite3_int64)-1) - LARGEST_INT64)
  173703. #endif
  173704. /*
  173705. ** Versions of isspace(), isalnum() and isdigit() to which it is safe
  173706. ** to pass signed char values.
  173707. */
  173708. #ifdef sqlite3Isdigit
  173709. /* Use the SQLite core versions if this routine is part of the
  173710. ** SQLite amalgamation */
  173711. # define safe_isdigit(x) sqlite3Isdigit(x)
  173712. # define safe_isalnum(x) sqlite3Isalnum(x)
  173713. # define safe_isxdigit(x) sqlite3Isxdigit(x)
  173714. #else
  173715. /* Use the standard library for separate compilation */
  173716. #include <ctype.h> /* amalgamator: keep */
  173717. # define safe_isdigit(x) isdigit((unsigned char)(x))
  173718. # define safe_isalnum(x) isalnum((unsigned char)(x))
  173719. # define safe_isxdigit(x) isxdigit((unsigned char)(x))
  173720. #endif
  173721. /*
  173722. ** Growing our own isspace() routine this way is twice as fast as
  173723. ** the library isspace() function, resulting in a 7% overall performance
  173724. ** increase for the parser. (Ubuntu14.10 gcc 4.8.4 x64 with -Os).
  173725. */
  173726. static const char jsonIsSpace[] = {
  173727. 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0, 1, 0, 0,
  173728. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173729. 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173730. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173731. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173732. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173733. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173734. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173735. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173736. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173737. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173738. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173739. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173740. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173741. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173742. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  173743. };
  173744. #define safe_isspace(x) (jsonIsSpace[(unsigned char)x])
  173745. #ifndef SQLITE_AMALGAMATION
  173746. /* Unsigned integer types. These are already defined in the sqliteInt.h,
  173747. ** but the definitions need to be repeated for separate compilation. */
  173748. typedef sqlite3_uint64 u64;
  173749. typedef unsigned int u32;
  173750. typedef unsigned short int u16;
  173751. typedef unsigned char u8;
  173752. #endif
  173753. /* Objects */
  173754. typedef struct JsonString JsonString;
  173755. typedef struct JsonNode JsonNode;
  173756. typedef struct JsonParse JsonParse;
  173757. /* An instance of this object represents a JSON string
  173758. ** under construction. Really, this is a generic string accumulator
  173759. ** that can be and is used to create strings other than JSON.
  173760. */
  173761. struct JsonString {
  173762. sqlite3_context *pCtx; /* Function context - put error messages here */
  173763. char *zBuf; /* Append JSON content here */
  173764. u64 nAlloc; /* Bytes of storage available in zBuf[] */
  173765. u64 nUsed; /* Bytes of zBuf[] currently used */
  173766. u8 bStatic; /* True if zBuf is static space */
  173767. u8 bErr; /* True if an error has been encountered */
  173768. char zSpace[100]; /* Initial static space */
  173769. };
  173770. /* JSON type values
  173771. */
  173772. #define JSON_NULL 0
  173773. #define JSON_TRUE 1
  173774. #define JSON_FALSE 2
  173775. #define JSON_INT 3
  173776. #define JSON_REAL 4
  173777. #define JSON_STRING 5
  173778. #define JSON_ARRAY 6
  173779. #define JSON_OBJECT 7
  173780. /* The "subtype" set for JSON values */
  173781. #define JSON_SUBTYPE 74 /* Ascii for "J" */
  173782. /*
  173783. ** Names of the various JSON types:
  173784. */
  173785. static const char * const jsonType[] = {
  173786. "null", "true", "false", "integer", "real", "text", "array", "object"
  173787. };
  173788. /* Bit values for the JsonNode.jnFlag field
  173789. */
  173790. #define JNODE_RAW 0x01 /* Content is raw, not JSON encoded */
  173791. #define JNODE_ESCAPE 0x02 /* Content is text with \ escapes */
  173792. #define JNODE_REMOVE 0x04 /* Do not output */
  173793. #define JNODE_REPLACE 0x08 /* Replace with JsonNode.u.iReplace */
  173794. #define JNODE_PATCH 0x10 /* Patch with JsonNode.u.pPatch */
  173795. #define JNODE_APPEND 0x20 /* More ARRAY/OBJECT entries at u.iAppend */
  173796. #define JNODE_LABEL 0x40 /* Is a label of an object */
  173797. /* A single node of parsed JSON
  173798. */
  173799. struct JsonNode {
  173800. u8 eType; /* One of the JSON_ type values */
  173801. u8 jnFlags; /* JNODE flags */
  173802. u32 n; /* Bytes of content, or number of sub-nodes */
  173803. union {
  173804. const char *zJContent; /* Content for INT, REAL, and STRING */
  173805. u32 iAppend; /* More terms for ARRAY and OBJECT */
  173806. u32 iKey; /* Key for ARRAY objects in json_tree() */
  173807. u32 iReplace; /* Replacement content for JNODE_REPLACE */
  173808. JsonNode *pPatch; /* Node chain of patch for JNODE_PATCH */
  173809. } u;
  173810. };
  173811. /* A completely parsed JSON string
  173812. */
  173813. struct JsonParse {
  173814. u32 nNode; /* Number of slots of aNode[] used */
  173815. u32 nAlloc; /* Number of slots of aNode[] allocated */
  173816. JsonNode *aNode; /* Array of nodes containing the parse */
  173817. const char *zJson; /* Original JSON string */
  173818. u32 *aUp; /* Index of parent of each node */
  173819. u8 oom; /* Set to true if out of memory */
  173820. u8 nErr; /* Number of errors seen */
  173821. u16 iDepth; /* Nesting depth */
  173822. int nJson; /* Length of the zJson string in bytes */
  173823. };
  173824. /*
  173825. ** Maximum nesting depth of JSON for this implementation.
  173826. **
  173827. ** This limit is needed to avoid a stack overflow in the recursive
  173828. ** descent parser. A depth of 2000 is far deeper than any sane JSON
  173829. ** should go.
  173830. */
  173831. #define JSON_MAX_DEPTH 2000
  173832. /**************************************************************************
  173833. ** Utility routines for dealing with JsonString objects
  173834. **************************************************************************/
  173835. /* Set the JsonString object to an empty string
  173836. */
  173837. static void jsonZero(JsonString *p){
  173838. p->zBuf = p->zSpace;
  173839. p->nAlloc = sizeof(p->zSpace);
  173840. p->nUsed = 0;
  173841. p->bStatic = 1;
  173842. }
  173843. /* Initialize the JsonString object
  173844. */
  173845. static void jsonInit(JsonString *p, sqlite3_context *pCtx){
  173846. p->pCtx = pCtx;
  173847. p->bErr = 0;
  173848. jsonZero(p);
  173849. }
  173850. /* Free all allocated memory and reset the JsonString object back to its
  173851. ** initial state.
  173852. */
  173853. static void jsonReset(JsonString *p){
  173854. if( !p->bStatic ) sqlite3_free(p->zBuf);
  173855. jsonZero(p);
  173856. }
  173857. /* Report an out-of-memory (OOM) condition
  173858. */
  173859. static void jsonOom(JsonString *p){
  173860. p->bErr = 1;
  173861. sqlite3_result_error_nomem(p->pCtx);
  173862. jsonReset(p);
  173863. }
  173864. /* Enlarge pJson->zBuf so that it can hold at least N more bytes.
  173865. ** Return zero on success. Return non-zero on an OOM error
  173866. */
  173867. static int jsonGrow(JsonString *p, u32 N){
  173868. u64 nTotal = N<p->nAlloc ? p->nAlloc*2 : p->nAlloc+N+10;
  173869. char *zNew;
  173870. if( p->bStatic ){
  173871. if( p->bErr ) return 1;
  173872. zNew = sqlite3_malloc64(nTotal);
  173873. if( zNew==0 ){
  173874. jsonOom(p);
  173875. return SQLITE_NOMEM;
  173876. }
  173877. memcpy(zNew, p->zBuf, (size_t)p->nUsed);
  173878. p->zBuf = zNew;
  173879. p->bStatic = 0;
  173880. }else{
  173881. zNew = sqlite3_realloc64(p->zBuf, nTotal);
  173882. if( zNew==0 ){
  173883. jsonOom(p);
  173884. return SQLITE_NOMEM;
  173885. }
  173886. p->zBuf = zNew;
  173887. }
  173888. p->nAlloc = nTotal;
  173889. return SQLITE_OK;
  173890. }
  173891. /* Append N bytes from zIn onto the end of the JsonString string.
  173892. */
  173893. static void jsonAppendRaw(JsonString *p, const char *zIn, u32 N){
  173894. if( (N+p->nUsed >= p->nAlloc) && jsonGrow(p,N)!=0 ) return;
  173895. memcpy(p->zBuf+p->nUsed, zIn, N);
  173896. p->nUsed += N;
  173897. }
  173898. /* Append formatted text (not to exceed N bytes) to the JsonString.
  173899. */
  173900. static void jsonPrintf(int N, JsonString *p, const char *zFormat, ...){
  173901. va_list ap;
  173902. if( (p->nUsed + N >= p->nAlloc) && jsonGrow(p, N) ) return;
  173903. va_start(ap, zFormat);
  173904. sqlite3_vsnprintf(N, p->zBuf+p->nUsed, zFormat, ap);
  173905. va_end(ap);
  173906. p->nUsed += (int)strlen(p->zBuf+p->nUsed);
  173907. }
  173908. /* Append a single character
  173909. */
  173910. static void jsonAppendChar(JsonString *p, char c){
  173911. if( p->nUsed>=p->nAlloc && jsonGrow(p,1)!=0 ) return;
  173912. p->zBuf[p->nUsed++] = c;
  173913. }
  173914. /* Append a comma separator to the output buffer, if the previous
  173915. ** character is not '[' or '{'.
  173916. */
  173917. static void jsonAppendSeparator(JsonString *p){
  173918. char c;
  173919. if( p->nUsed==0 ) return;
  173920. c = p->zBuf[p->nUsed-1];
  173921. if( c!='[' && c!='{' ) jsonAppendChar(p, ',');
  173922. }
  173923. /* Append the N-byte string in zIn to the end of the JsonString string
  173924. ** under construction. Enclose the string in "..." and escape
  173925. ** any double-quotes or backslash characters contained within the
  173926. ** string.
  173927. */
  173928. static void jsonAppendString(JsonString *p, const char *zIn, u32 N){
  173929. u32 i;
  173930. if( (N+p->nUsed+2 >= p->nAlloc) && jsonGrow(p,N+2)!=0 ) return;
  173931. p->zBuf[p->nUsed++] = '"';
  173932. for(i=0; i<N; i++){
  173933. unsigned char c = ((unsigned const char*)zIn)[i];
  173934. if( c=='"' || c=='\\' ){
  173935. json_simple_escape:
  173936. if( (p->nUsed+N+3-i > p->nAlloc) && jsonGrow(p,N+3-i)!=0 ) return;
  173937. p->zBuf[p->nUsed++] = '\\';
  173938. }else if( c<=0x1f ){
  173939. static const char aSpecial[] = {
  173940. 0, 0, 0, 0, 0, 0, 0, 0, 'b', 't', 'n', 0, 'f', 'r', 0, 0,
  173941. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
  173942. };
  173943. assert( sizeof(aSpecial)==32 );
  173944. assert( aSpecial['\b']=='b' );
  173945. assert( aSpecial['\f']=='f' );
  173946. assert( aSpecial['\n']=='n' );
  173947. assert( aSpecial['\r']=='r' );
  173948. assert( aSpecial['\t']=='t' );
  173949. if( aSpecial[c] ){
  173950. c = aSpecial[c];
  173951. goto json_simple_escape;
  173952. }
  173953. if( (p->nUsed+N+7+i > p->nAlloc) && jsonGrow(p,N+7-i)!=0 ) return;
  173954. p->zBuf[p->nUsed++] = '\\';
  173955. p->zBuf[p->nUsed++] = 'u';
  173956. p->zBuf[p->nUsed++] = '0';
  173957. p->zBuf[p->nUsed++] = '0';
  173958. p->zBuf[p->nUsed++] = '0' + (c>>4);
  173959. c = "0123456789abcdef"[c&0xf];
  173960. }
  173961. p->zBuf[p->nUsed++] = c;
  173962. }
  173963. p->zBuf[p->nUsed++] = '"';
  173964. assert( p->nUsed<p->nAlloc );
  173965. }
  173966. /*
  173967. ** Append a function parameter value to the JSON string under
  173968. ** construction.
  173969. */
  173970. static void jsonAppendValue(
  173971. JsonString *p, /* Append to this JSON string */
  173972. sqlite3_value *pValue /* Value to append */
  173973. ){
  173974. switch( sqlite3_value_type(pValue) ){
  173975. case SQLITE_NULL: {
  173976. jsonAppendRaw(p, "null", 4);
  173977. break;
  173978. }
  173979. case SQLITE_INTEGER:
  173980. case SQLITE_FLOAT: {
  173981. const char *z = (const char*)sqlite3_value_text(pValue);
  173982. u32 n = (u32)sqlite3_value_bytes(pValue);
  173983. jsonAppendRaw(p, z, n);
  173984. break;
  173985. }
  173986. case SQLITE_TEXT: {
  173987. const char *z = (const char*)sqlite3_value_text(pValue);
  173988. u32 n = (u32)sqlite3_value_bytes(pValue);
  173989. if( sqlite3_value_subtype(pValue)==JSON_SUBTYPE ){
  173990. jsonAppendRaw(p, z, n);
  173991. }else{
  173992. jsonAppendString(p, z, n);
  173993. }
  173994. break;
  173995. }
  173996. default: {
  173997. if( p->bErr==0 ){
  173998. sqlite3_result_error(p->pCtx, "JSON cannot hold BLOB values", -1);
  173999. p->bErr = 2;
  174000. jsonReset(p);
  174001. }
  174002. break;
  174003. }
  174004. }
  174005. }
  174006. /* Make the JSON in p the result of the SQL function.
  174007. */
  174008. static void jsonResult(JsonString *p){
  174009. if( p->bErr==0 ){
  174010. sqlite3_result_text64(p->pCtx, p->zBuf, p->nUsed,
  174011. p->bStatic ? SQLITE_TRANSIENT : sqlite3_free,
  174012. SQLITE_UTF8);
  174013. jsonZero(p);
  174014. }
  174015. assert( p->bStatic );
  174016. }
  174017. /**************************************************************************
  174018. ** Utility routines for dealing with JsonNode and JsonParse objects
  174019. **************************************************************************/
  174020. /*
  174021. ** Return the number of consecutive JsonNode slots need to represent
  174022. ** the parsed JSON at pNode. The minimum answer is 1. For ARRAY and
  174023. ** OBJECT types, the number might be larger.
  174024. **
  174025. ** Appended elements are not counted. The value returned is the number
  174026. ** by which the JsonNode counter should increment in order to go to the
  174027. ** next peer value.
  174028. */
  174029. static u32 jsonNodeSize(JsonNode *pNode){
  174030. return pNode->eType>=JSON_ARRAY ? pNode->n+1 : 1;
  174031. }
  174032. /*
  174033. ** Reclaim all memory allocated by a JsonParse object. But do not
  174034. ** delete the JsonParse object itself.
  174035. */
  174036. static void jsonParseReset(JsonParse *pParse){
  174037. sqlite3_free(pParse->aNode);
  174038. pParse->aNode = 0;
  174039. pParse->nNode = 0;
  174040. pParse->nAlloc = 0;
  174041. sqlite3_free(pParse->aUp);
  174042. pParse->aUp = 0;
  174043. }
  174044. /*
  174045. ** Free a JsonParse object that was obtained from sqlite3_malloc().
  174046. */
  174047. static void jsonParseFree(JsonParse *pParse){
  174048. jsonParseReset(pParse);
  174049. sqlite3_free(pParse);
  174050. }
  174051. /*
  174052. ** Convert the JsonNode pNode into a pure JSON string and
  174053. ** append to pOut. Subsubstructure is also included. Return
  174054. ** the number of JsonNode objects that are encoded.
  174055. */
  174056. static void jsonRenderNode(
  174057. JsonNode *pNode, /* The node to render */
  174058. JsonString *pOut, /* Write JSON here */
  174059. sqlite3_value **aReplace /* Replacement values */
  174060. ){
  174061. if( pNode->jnFlags & (JNODE_REPLACE|JNODE_PATCH) ){
  174062. if( pNode->jnFlags & JNODE_REPLACE ){
  174063. jsonAppendValue(pOut, aReplace[pNode->u.iReplace]);
  174064. return;
  174065. }
  174066. pNode = pNode->u.pPatch;
  174067. }
  174068. switch( pNode->eType ){
  174069. default: {
  174070. assert( pNode->eType==JSON_NULL );
  174071. jsonAppendRaw(pOut, "null", 4);
  174072. break;
  174073. }
  174074. case JSON_TRUE: {
  174075. jsonAppendRaw(pOut, "true", 4);
  174076. break;
  174077. }
  174078. case JSON_FALSE: {
  174079. jsonAppendRaw(pOut, "false", 5);
  174080. break;
  174081. }
  174082. case JSON_STRING: {
  174083. if( pNode->jnFlags & JNODE_RAW ){
  174084. jsonAppendString(pOut, pNode->u.zJContent, pNode->n);
  174085. break;
  174086. }
  174087. /* Fall through into the next case */
  174088. }
  174089. case JSON_REAL:
  174090. case JSON_INT: {
  174091. jsonAppendRaw(pOut, pNode->u.zJContent, pNode->n);
  174092. break;
  174093. }
  174094. case JSON_ARRAY: {
  174095. u32 j = 1;
  174096. jsonAppendChar(pOut, '[');
  174097. for(;;){
  174098. while( j<=pNode->n ){
  174099. if( (pNode[j].jnFlags & JNODE_REMOVE)==0 ){
  174100. jsonAppendSeparator(pOut);
  174101. jsonRenderNode(&pNode[j], pOut, aReplace);
  174102. }
  174103. j += jsonNodeSize(&pNode[j]);
  174104. }
  174105. if( (pNode->jnFlags & JNODE_APPEND)==0 ) break;
  174106. pNode = &pNode[pNode->u.iAppend];
  174107. j = 1;
  174108. }
  174109. jsonAppendChar(pOut, ']');
  174110. break;
  174111. }
  174112. case JSON_OBJECT: {
  174113. u32 j = 1;
  174114. jsonAppendChar(pOut, '{');
  174115. for(;;){
  174116. while( j<=pNode->n ){
  174117. if( (pNode[j+1].jnFlags & JNODE_REMOVE)==0 ){
  174118. jsonAppendSeparator(pOut);
  174119. jsonRenderNode(&pNode[j], pOut, aReplace);
  174120. jsonAppendChar(pOut, ':');
  174121. jsonRenderNode(&pNode[j+1], pOut, aReplace);
  174122. }
  174123. j += 1 + jsonNodeSize(&pNode[j+1]);
  174124. }
  174125. if( (pNode->jnFlags & JNODE_APPEND)==0 ) break;
  174126. pNode = &pNode[pNode->u.iAppend];
  174127. j = 1;
  174128. }
  174129. jsonAppendChar(pOut, '}');
  174130. break;
  174131. }
  174132. }
  174133. }
  174134. /*
  174135. ** Return a JsonNode and all its descendents as a JSON string.
  174136. */
  174137. static void jsonReturnJson(
  174138. JsonNode *pNode, /* Node to return */
  174139. sqlite3_context *pCtx, /* Return value for this function */
  174140. sqlite3_value **aReplace /* Array of replacement values */
  174141. ){
  174142. JsonString s;
  174143. jsonInit(&s, pCtx);
  174144. jsonRenderNode(pNode, &s, aReplace);
  174145. jsonResult(&s);
  174146. sqlite3_result_subtype(pCtx, JSON_SUBTYPE);
  174147. }
  174148. /*
  174149. ** Make the JsonNode the return value of the function.
  174150. */
  174151. static void jsonReturn(
  174152. JsonNode *pNode, /* Node to return */
  174153. sqlite3_context *pCtx, /* Return value for this function */
  174154. sqlite3_value **aReplace /* Array of replacement values */
  174155. ){
  174156. switch( pNode->eType ){
  174157. default: {
  174158. assert( pNode->eType==JSON_NULL );
  174159. sqlite3_result_null(pCtx);
  174160. break;
  174161. }
  174162. case JSON_TRUE: {
  174163. sqlite3_result_int(pCtx, 1);
  174164. break;
  174165. }
  174166. case JSON_FALSE: {
  174167. sqlite3_result_int(pCtx, 0);
  174168. break;
  174169. }
  174170. case JSON_INT: {
  174171. sqlite3_int64 i = 0;
  174172. const char *z = pNode->u.zJContent;
  174173. if( z[0]=='-' ){ z++; }
  174174. while( z[0]>='0' && z[0]<='9' ){
  174175. unsigned v = *(z++) - '0';
  174176. if( i>=LARGEST_INT64/10 ){
  174177. if( i>LARGEST_INT64/10 ) goto int_as_real;
  174178. if( z[0]>='0' && z[0]<='9' ) goto int_as_real;
  174179. if( v==9 ) goto int_as_real;
  174180. if( v==8 ){
  174181. if( pNode->u.zJContent[0]=='-' ){
  174182. sqlite3_result_int64(pCtx, SMALLEST_INT64);
  174183. goto int_done;
  174184. }else{
  174185. goto int_as_real;
  174186. }
  174187. }
  174188. }
  174189. i = i*10 + v;
  174190. }
  174191. if( pNode->u.zJContent[0]=='-' ){ i = -i; }
  174192. sqlite3_result_int64(pCtx, i);
  174193. int_done:
  174194. break;
  174195. int_as_real: /* fall through to real */;
  174196. }
  174197. case JSON_REAL: {
  174198. double r;
  174199. #ifdef SQLITE_AMALGAMATION
  174200. const char *z = pNode->u.zJContent;
  174201. sqlite3AtoF(z, &r, sqlite3Strlen30(z), SQLITE_UTF8);
  174202. #else
  174203. r = strtod(pNode->u.zJContent, 0);
  174204. #endif
  174205. sqlite3_result_double(pCtx, r);
  174206. break;
  174207. }
  174208. case JSON_STRING: {
  174209. #if 0 /* Never happens because JNODE_RAW is only set by json_set(),
  174210. ** json_insert() and json_replace() and those routines do not
  174211. ** call jsonReturn() */
  174212. if( pNode->jnFlags & JNODE_RAW ){
  174213. sqlite3_result_text(pCtx, pNode->u.zJContent, pNode->n,
  174214. SQLITE_TRANSIENT);
  174215. }else
  174216. #endif
  174217. assert( (pNode->jnFlags & JNODE_RAW)==0 );
  174218. if( (pNode->jnFlags & JNODE_ESCAPE)==0 ){
  174219. /* JSON formatted without any backslash-escapes */
  174220. sqlite3_result_text(pCtx, pNode->u.zJContent+1, pNode->n-2,
  174221. SQLITE_TRANSIENT);
  174222. }else{
  174223. /* Translate JSON formatted string into raw text */
  174224. u32 i;
  174225. u32 n = pNode->n;
  174226. const char *z = pNode->u.zJContent;
  174227. char *zOut;
  174228. u32 j;
  174229. zOut = sqlite3_malloc( n+1 );
  174230. if( zOut==0 ){
  174231. sqlite3_result_error_nomem(pCtx);
  174232. break;
  174233. }
  174234. for(i=1, j=0; i<n-1; i++){
  174235. char c = z[i];
  174236. if( c!='\\' ){
  174237. zOut[j++] = c;
  174238. }else{
  174239. c = z[++i];
  174240. if( c=='u' ){
  174241. u32 v = 0, k;
  174242. for(k=0; k<4; i++, k++){
  174243. assert( i<n-2 );
  174244. c = z[i+1];
  174245. assert( safe_isxdigit(c) );
  174246. if( c<='9' ) v = v*16 + c - '0';
  174247. else if( c<='F' ) v = v*16 + c - 'A' + 10;
  174248. else v = v*16 + c - 'a' + 10;
  174249. }
  174250. if( v==0 ) break;
  174251. if( v<=0x7f ){
  174252. zOut[j++] = (char)v;
  174253. }else if( v<=0x7ff ){
  174254. zOut[j++] = (char)(0xc0 | (v>>6));
  174255. zOut[j++] = 0x80 | (v&0x3f);
  174256. }else{
  174257. zOut[j++] = (char)(0xe0 | (v>>12));
  174258. zOut[j++] = 0x80 | ((v>>6)&0x3f);
  174259. zOut[j++] = 0x80 | (v&0x3f);
  174260. }
  174261. }else{
  174262. if( c=='b' ){
  174263. c = '\b';
  174264. }else if( c=='f' ){
  174265. c = '\f';
  174266. }else if( c=='n' ){
  174267. c = '\n';
  174268. }else if( c=='r' ){
  174269. c = '\r';
  174270. }else if( c=='t' ){
  174271. c = '\t';
  174272. }
  174273. zOut[j++] = c;
  174274. }
  174275. }
  174276. }
  174277. zOut[j] = 0;
  174278. sqlite3_result_text(pCtx, zOut, j, sqlite3_free);
  174279. }
  174280. break;
  174281. }
  174282. case JSON_ARRAY:
  174283. case JSON_OBJECT: {
  174284. jsonReturnJson(pNode, pCtx, aReplace);
  174285. break;
  174286. }
  174287. }
  174288. }
  174289. /* Forward reference */
  174290. static int jsonParseAddNode(JsonParse*,u32,u32,const char*);
  174291. /*
  174292. ** A macro to hint to the compiler that a function should not be
  174293. ** inlined.
  174294. */
  174295. #if defined(__GNUC__)
  174296. # define JSON_NOINLINE __attribute__((noinline))
  174297. #elif defined(_MSC_VER) && _MSC_VER>=1310
  174298. # define JSON_NOINLINE __declspec(noinline)
  174299. #else
  174300. # define JSON_NOINLINE
  174301. #endif
  174302. static JSON_NOINLINE int jsonParseAddNodeExpand(
  174303. JsonParse *pParse, /* Append the node to this object */
  174304. u32 eType, /* Node type */
  174305. u32 n, /* Content size or sub-node count */
  174306. const char *zContent /* Content */
  174307. ){
  174308. u32 nNew;
  174309. JsonNode *pNew;
  174310. assert( pParse->nNode>=pParse->nAlloc );
  174311. if( pParse->oom ) return -1;
  174312. nNew = pParse->nAlloc*2 + 10;
  174313. pNew = sqlite3_realloc(pParse->aNode, sizeof(JsonNode)*nNew);
  174314. if( pNew==0 ){
  174315. pParse->oom = 1;
  174316. return -1;
  174317. }
  174318. pParse->nAlloc = nNew;
  174319. pParse->aNode = pNew;
  174320. assert( pParse->nNode<pParse->nAlloc );
  174321. return jsonParseAddNode(pParse, eType, n, zContent);
  174322. }
  174323. /*
  174324. ** Create a new JsonNode instance based on the arguments and append that
  174325. ** instance to the JsonParse. Return the index in pParse->aNode[] of the
  174326. ** new node, or -1 if a memory allocation fails.
  174327. */
  174328. static int jsonParseAddNode(
  174329. JsonParse *pParse, /* Append the node to this object */
  174330. u32 eType, /* Node type */
  174331. u32 n, /* Content size or sub-node count */
  174332. const char *zContent /* Content */
  174333. ){
  174334. JsonNode *p;
  174335. if( pParse->nNode>=pParse->nAlloc ){
  174336. return jsonParseAddNodeExpand(pParse, eType, n, zContent);
  174337. }
  174338. p = &pParse->aNode[pParse->nNode];
  174339. p->eType = (u8)eType;
  174340. p->jnFlags = 0;
  174341. p->n = n;
  174342. p->u.zJContent = zContent;
  174343. return pParse->nNode++;
  174344. }
  174345. /*
  174346. ** Return true if z[] begins with 4 (or more) hexadecimal digits
  174347. */
  174348. static int jsonIs4Hex(const char *z){
  174349. int i;
  174350. for(i=0; i<4; i++) if( !safe_isxdigit(z[i]) ) return 0;
  174351. return 1;
  174352. }
  174353. /*
  174354. ** Parse a single JSON value which begins at pParse->zJson[i]. Return the
  174355. ** index of the first character past the end of the value parsed.
  174356. **
  174357. ** Return negative for a syntax error. Special cases: return -2 if the
  174358. ** first non-whitespace character is '}' and return -3 if the first
  174359. ** non-whitespace character is ']'.
  174360. */
  174361. static int jsonParseValue(JsonParse *pParse, u32 i){
  174362. char c;
  174363. u32 j;
  174364. int iThis;
  174365. int x;
  174366. JsonNode *pNode;
  174367. const char *z = pParse->zJson;
  174368. while( safe_isspace(z[i]) ){ i++; }
  174369. if( (c = z[i])=='{' ){
  174370. /* Parse object */
  174371. iThis = jsonParseAddNode(pParse, JSON_OBJECT, 0, 0);
  174372. if( iThis<0 ) return -1;
  174373. for(j=i+1;;j++){
  174374. while( safe_isspace(z[j]) ){ j++; }
  174375. if( ++pParse->iDepth > JSON_MAX_DEPTH ) return -1;
  174376. x = jsonParseValue(pParse, j);
  174377. if( x<0 ){
  174378. pParse->iDepth--;
  174379. if( x==(-2) && pParse->nNode==(u32)iThis+1 ) return j+1;
  174380. return -1;
  174381. }
  174382. if( pParse->oom ) return -1;
  174383. pNode = &pParse->aNode[pParse->nNode-1];
  174384. if( pNode->eType!=JSON_STRING ) return -1;
  174385. pNode->jnFlags |= JNODE_LABEL;
  174386. j = x;
  174387. while( safe_isspace(z[j]) ){ j++; }
  174388. if( z[j]!=':' ) return -1;
  174389. j++;
  174390. x = jsonParseValue(pParse, j);
  174391. pParse->iDepth--;
  174392. if( x<0 ) return -1;
  174393. j = x;
  174394. while( safe_isspace(z[j]) ){ j++; }
  174395. c = z[j];
  174396. if( c==',' ) continue;
  174397. if( c!='}' ) return -1;
  174398. break;
  174399. }
  174400. pParse->aNode[iThis].n = pParse->nNode - (u32)iThis - 1;
  174401. return j+1;
  174402. }else if( c=='[' ){
  174403. /* Parse array */
  174404. iThis = jsonParseAddNode(pParse, JSON_ARRAY, 0, 0);
  174405. if( iThis<0 ) return -1;
  174406. for(j=i+1;;j++){
  174407. while( safe_isspace(z[j]) ){ j++; }
  174408. if( ++pParse->iDepth > JSON_MAX_DEPTH ) return -1;
  174409. x = jsonParseValue(pParse, j);
  174410. pParse->iDepth--;
  174411. if( x<0 ){
  174412. if( x==(-3) && pParse->nNode==(u32)iThis+1 ) return j+1;
  174413. return -1;
  174414. }
  174415. j = x;
  174416. while( safe_isspace(z[j]) ){ j++; }
  174417. c = z[j];
  174418. if( c==',' ) continue;
  174419. if( c!=']' ) return -1;
  174420. break;
  174421. }
  174422. pParse->aNode[iThis].n = pParse->nNode - (u32)iThis - 1;
  174423. return j+1;
  174424. }else if( c=='"' ){
  174425. /* Parse string */
  174426. u8 jnFlags = 0;
  174427. j = i+1;
  174428. for(;;){
  174429. c = z[j];
  174430. if( (c & ~0x1f)==0 ){
  174431. /* Control characters are not allowed in strings */
  174432. return -1;
  174433. }
  174434. if( c=='\\' ){
  174435. c = z[++j];
  174436. if( c=='"' || c=='\\' || c=='/' || c=='b' || c=='f'
  174437. || c=='n' || c=='r' || c=='t'
  174438. || (c=='u' && jsonIs4Hex(z+j+1)) ){
  174439. jnFlags = JNODE_ESCAPE;
  174440. }else{
  174441. return -1;
  174442. }
  174443. }else if( c=='"' ){
  174444. break;
  174445. }
  174446. j++;
  174447. }
  174448. jsonParseAddNode(pParse, JSON_STRING, j+1-i, &z[i]);
  174449. if( !pParse->oom ) pParse->aNode[pParse->nNode-1].jnFlags = jnFlags;
  174450. return j+1;
  174451. }else if( c=='n'
  174452. && strncmp(z+i,"null",4)==0
  174453. && !safe_isalnum(z[i+4]) ){
  174454. jsonParseAddNode(pParse, JSON_NULL, 0, 0);
  174455. return i+4;
  174456. }else if( c=='t'
  174457. && strncmp(z+i,"true",4)==0
  174458. && !safe_isalnum(z[i+4]) ){
  174459. jsonParseAddNode(pParse, JSON_TRUE, 0, 0);
  174460. return i+4;
  174461. }else if( c=='f'
  174462. && strncmp(z+i,"false",5)==0
  174463. && !safe_isalnum(z[i+5]) ){
  174464. jsonParseAddNode(pParse, JSON_FALSE, 0, 0);
  174465. return i+5;
  174466. }else if( c=='-' || (c>='0' && c<='9') ){
  174467. /* Parse number */
  174468. u8 seenDP = 0;
  174469. u8 seenE = 0;
  174470. assert( '-' < '0' );
  174471. if( c<='0' ){
  174472. j = c=='-' ? i+1 : i;
  174473. if( z[j]=='0' && z[j+1]>='0' && z[j+1]<='9' ) return -1;
  174474. }
  174475. j = i+1;
  174476. for(;; j++){
  174477. c = z[j];
  174478. if( c>='0' && c<='9' ) continue;
  174479. if( c=='.' ){
  174480. if( z[j-1]=='-' ) return -1;
  174481. if( seenDP ) return -1;
  174482. seenDP = 1;
  174483. continue;
  174484. }
  174485. if( c=='e' || c=='E' ){
  174486. if( z[j-1]<'0' ) return -1;
  174487. if( seenE ) return -1;
  174488. seenDP = seenE = 1;
  174489. c = z[j+1];
  174490. if( c=='+' || c=='-' ){
  174491. j++;
  174492. c = z[j+1];
  174493. }
  174494. if( c<'0' || c>'9' ) return -1;
  174495. continue;
  174496. }
  174497. break;
  174498. }
  174499. if( z[j-1]<'0' ) return -1;
  174500. jsonParseAddNode(pParse, seenDP ? JSON_REAL : JSON_INT,
  174501. j - i, &z[i]);
  174502. return j;
  174503. }else if( c=='}' ){
  174504. return -2; /* End of {...} */
  174505. }else if( c==']' ){
  174506. return -3; /* End of [...] */
  174507. }else if( c==0 ){
  174508. return 0; /* End of file */
  174509. }else{
  174510. return -1; /* Syntax error */
  174511. }
  174512. }
  174513. /*
  174514. ** Parse a complete JSON string. Return 0 on success or non-zero if there
  174515. ** are any errors. If an error occurs, free all memory associated with
  174516. ** pParse.
  174517. **
  174518. ** pParse is uninitialized when this routine is called.
  174519. */
  174520. static int jsonParse(
  174521. JsonParse *pParse, /* Initialize and fill this JsonParse object */
  174522. sqlite3_context *pCtx, /* Report errors here */
  174523. const char *zJson /* Input JSON text to be parsed */
  174524. ){
  174525. int i;
  174526. memset(pParse, 0, sizeof(*pParse));
  174527. if( zJson==0 ) return 1;
  174528. pParse->zJson = zJson;
  174529. i = jsonParseValue(pParse, 0);
  174530. if( pParse->oom ) i = -1;
  174531. if( i>0 ){
  174532. assert( pParse->iDepth==0 );
  174533. while( safe_isspace(zJson[i]) ) i++;
  174534. if( zJson[i] ) i = -1;
  174535. }
  174536. if( i<=0 ){
  174537. if( pCtx!=0 ){
  174538. if( pParse->oom ){
  174539. sqlite3_result_error_nomem(pCtx);
  174540. }else{
  174541. sqlite3_result_error(pCtx, "malformed JSON", -1);
  174542. }
  174543. }
  174544. jsonParseReset(pParse);
  174545. return 1;
  174546. }
  174547. return 0;
  174548. }
  174549. /* Mark node i of pParse as being a child of iParent. Call recursively
  174550. ** to fill in all the descendants of node i.
  174551. */
  174552. static void jsonParseFillInParentage(JsonParse *pParse, u32 i, u32 iParent){
  174553. JsonNode *pNode = &pParse->aNode[i];
  174554. u32 j;
  174555. pParse->aUp[i] = iParent;
  174556. switch( pNode->eType ){
  174557. case JSON_ARRAY: {
  174558. for(j=1; j<=pNode->n; j += jsonNodeSize(pNode+j)){
  174559. jsonParseFillInParentage(pParse, i+j, i);
  174560. }
  174561. break;
  174562. }
  174563. case JSON_OBJECT: {
  174564. for(j=1; j<=pNode->n; j += jsonNodeSize(pNode+j+1)+1){
  174565. pParse->aUp[i+j] = i;
  174566. jsonParseFillInParentage(pParse, i+j+1, i);
  174567. }
  174568. break;
  174569. }
  174570. default: {
  174571. break;
  174572. }
  174573. }
  174574. }
  174575. /*
  174576. ** Compute the parentage of all nodes in a completed parse.
  174577. */
  174578. static int jsonParseFindParents(JsonParse *pParse){
  174579. u32 *aUp;
  174580. assert( pParse->aUp==0 );
  174581. aUp = pParse->aUp = sqlite3_malloc( sizeof(u32)*pParse->nNode );
  174582. if( aUp==0 ){
  174583. pParse->oom = 1;
  174584. return SQLITE_NOMEM;
  174585. }
  174586. jsonParseFillInParentage(pParse, 0, 0);
  174587. return SQLITE_OK;
  174588. }
  174589. /*
  174590. ** Magic number used for the JSON parse cache in sqlite3_get_auxdata()
  174591. */
  174592. #define JSON_CACHE_ID (-429938)
  174593. /*
  174594. ** Obtain a complete parse of the JSON found in the first argument
  174595. ** of the argv array. Use the sqlite3_get_auxdata() cache for this
  174596. ** parse if it is available. If the cache is not available or if it
  174597. ** is no longer valid, parse the JSON again and return the new parse,
  174598. ** and also register the new parse so that it will be available for
  174599. ** future sqlite3_get_auxdata() calls.
  174600. */
  174601. static JsonParse *jsonParseCached(
  174602. sqlite3_context *pCtx,
  174603. sqlite3_value **argv
  174604. ){
  174605. const char *zJson = (const char*)sqlite3_value_text(argv[0]);
  174606. int nJson = sqlite3_value_bytes(argv[0]);
  174607. JsonParse *p;
  174608. if( zJson==0 ) return 0;
  174609. p = (JsonParse*)sqlite3_get_auxdata(pCtx, JSON_CACHE_ID);
  174610. if( p && p->nJson==nJson && memcmp(p->zJson,zJson,nJson)==0 ){
  174611. p->nErr = 0;
  174612. return p; /* The cached entry matches, so return it */
  174613. }
  174614. p = sqlite3_malloc( sizeof(*p) + nJson + 1 );
  174615. if( p==0 ){
  174616. sqlite3_result_error_nomem(pCtx);
  174617. return 0;
  174618. }
  174619. memset(p, 0, sizeof(*p));
  174620. p->zJson = (char*)&p[1];
  174621. memcpy((char*)p->zJson, zJson, nJson+1);
  174622. if( jsonParse(p, pCtx, p->zJson) ){
  174623. sqlite3_free(p);
  174624. return 0;
  174625. }
  174626. p->nJson = nJson;
  174627. sqlite3_set_auxdata(pCtx, JSON_CACHE_ID, p, (void(*)(void*))jsonParseFree);
  174628. return (JsonParse*)sqlite3_get_auxdata(pCtx, JSON_CACHE_ID);
  174629. }
  174630. /*
  174631. ** Compare the OBJECT label at pNode against zKey,nKey. Return true on
  174632. ** a match.
  174633. */
  174634. static int jsonLabelCompare(JsonNode *pNode, const char *zKey, u32 nKey){
  174635. if( pNode->jnFlags & JNODE_RAW ){
  174636. if( pNode->n!=nKey ) return 0;
  174637. return strncmp(pNode->u.zJContent, zKey, nKey)==0;
  174638. }else{
  174639. if( pNode->n!=nKey+2 ) return 0;
  174640. return strncmp(pNode->u.zJContent+1, zKey, nKey)==0;
  174641. }
  174642. }
  174643. /* forward declaration */
  174644. static JsonNode *jsonLookupAppend(JsonParse*,const char*,int*,const char**);
  174645. /*
  174646. ** Search along zPath to find the node specified. Return a pointer
  174647. ** to that node, or NULL if zPath is malformed or if there is no such
  174648. ** node.
  174649. **
  174650. ** If pApnd!=0, then try to append new nodes to complete zPath if it is
  174651. ** possible to do so and if no existing node corresponds to zPath. If
  174652. ** new nodes are appended *pApnd is set to 1.
  174653. */
  174654. static JsonNode *jsonLookupStep(
  174655. JsonParse *pParse, /* The JSON to search */
  174656. u32 iRoot, /* Begin the search at this node */
  174657. const char *zPath, /* The path to search */
  174658. int *pApnd, /* Append nodes to complete path if not NULL */
  174659. const char **pzErr /* Make *pzErr point to any syntax error in zPath */
  174660. ){
  174661. u32 i, j, nKey;
  174662. const char *zKey;
  174663. JsonNode *pRoot = &pParse->aNode[iRoot];
  174664. if( zPath[0]==0 ) return pRoot;
  174665. if( zPath[0]=='.' ){
  174666. if( pRoot->eType!=JSON_OBJECT ) return 0;
  174667. zPath++;
  174668. if( zPath[0]=='"' ){
  174669. zKey = zPath + 1;
  174670. for(i=1; zPath[i] && zPath[i]!='"'; i++){}
  174671. nKey = i-1;
  174672. if( zPath[i] ){
  174673. i++;
  174674. }else{
  174675. *pzErr = zPath;
  174676. return 0;
  174677. }
  174678. }else{
  174679. zKey = zPath;
  174680. for(i=0; zPath[i] && zPath[i]!='.' && zPath[i]!='['; i++){}
  174681. nKey = i;
  174682. }
  174683. if( nKey==0 ){
  174684. *pzErr = zPath;
  174685. return 0;
  174686. }
  174687. j = 1;
  174688. for(;;){
  174689. while( j<=pRoot->n ){
  174690. if( jsonLabelCompare(pRoot+j, zKey, nKey) ){
  174691. return jsonLookupStep(pParse, iRoot+j+1, &zPath[i], pApnd, pzErr);
  174692. }
  174693. j++;
  174694. j += jsonNodeSize(&pRoot[j]);
  174695. }
  174696. if( (pRoot->jnFlags & JNODE_APPEND)==0 ) break;
  174697. iRoot += pRoot->u.iAppend;
  174698. pRoot = &pParse->aNode[iRoot];
  174699. j = 1;
  174700. }
  174701. if( pApnd ){
  174702. u32 iStart, iLabel;
  174703. JsonNode *pNode;
  174704. iStart = jsonParseAddNode(pParse, JSON_OBJECT, 2, 0);
  174705. iLabel = jsonParseAddNode(pParse, JSON_STRING, i, zPath);
  174706. zPath += i;
  174707. pNode = jsonLookupAppend(pParse, zPath, pApnd, pzErr);
  174708. if( pParse->oom ) return 0;
  174709. if( pNode ){
  174710. pRoot = &pParse->aNode[iRoot];
  174711. pRoot->u.iAppend = iStart - iRoot;
  174712. pRoot->jnFlags |= JNODE_APPEND;
  174713. pParse->aNode[iLabel].jnFlags |= JNODE_RAW;
  174714. }
  174715. return pNode;
  174716. }
  174717. }else if( zPath[0]=='[' && safe_isdigit(zPath[1]) ){
  174718. if( pRoot->eType!=JSON_ARRAY ) return 0;
  174719. i = 0;
  174720. j = 1;
  174721. while( safe_isdigit(zPath[j]) ){
  174722. i = i*10 + zPath[j] - '0';
  174723. j++;
  174724. }
  174725. if( zPath[j]!=']' ){
  174726. *pzErr = zPath;
  174727. return 0;
  174728. }
  174729. zPath += j + 1;
  174730. j = 1;
  174731. for(;;){
  174732. while( j<=pRoot->n && (i>0 || (pRoot[j].jnFlags & JNODE_REMOVE)!=0) ){
  174733. if( (pRoot[j].jnFlags & JNODE_REMOVE)==0 ) i--;
  174734. j += jsonNodeSize(&pRoot[j]);
  174735. }
  174736. if( (pRoot->jnFlags & JNODE_APPEND)==0 ) break;
  174737. iRoot += pRoot->u.iAppend;
  174738. pRoot = &pParse->aNode[iRoot];
  174739. j = 1;
  174740. }
  174741. if( j<=pRoot->n ){
  174742. return jsonLookupStep(pParse, iRoot+j, zPath, pApnd, pzErr);
  174743. }
  174744. if( i==0 && pApnd ){
  174745. u32 iStart;
  174746. JsonNode *pNode;
  174747. iStart = jsonParseAddNode(pParse, JSON_ARRAY, 1, 0);
  174748. pNode = jsonLookupAppend(pParse, zPath, pApnd, pzErr);
  174749. if( pParse->oom ) return 0;
  174750. if( pNode ){
  174751. pRoot = &pParse->aNode[iRoot];
  174752. pRoot->u.iAppend = iStart - iRoot;
  174753. pRoot->jnFlags |= JNODE_APPEND;
  174754. }
  174755. return pNode;
  174756. }
  174757. }else{
  174758. *pzErr = zPath;
  174759. }
  174760. return 0;
  174761. }
  174762. /*
  174763. ** Append content to pParse that will complete zPath. Return a pointer
  174764. ** to the inserted node, or return NULL if the append fails.
  174765. */
  174766. static JsonNode *jsonLookupAppend(
  174767. JsonParse *pParse, /* Append content to the JSON parse */
  174768. const char *zPath, /* Description of content to append */
  174769. int *pApnd, /* Set this flag to 1 */
  174770. const char **pzErr /* Make this point to any syntax error */
  174771. ){
  174772. *pApnd = 1;
  174773. if( zPath[0]==0 ){
  174774. jsonParseAddNode(pParse, JSON_NULL, 0, 0);
  174775. return pParse->oom ? 0 : &pParse->aNode[pParse->nNode-1];
  174776. }
  174777. if( zPath[0]=='.' ){
  174778. jsonParseAddNode(pParse, JSON_OBJECT, 0, 0);
  174779. }else if( strncmp(zPath,"[0]",3)==0 ){
  174780. jsonParseAddNode(pParse, JSON_ARRAY, 0, 0);
  174781. }else{
  174782. return 0;
  174783. }
  174784. if( pParse->oom ) return 0;
  174785. return jsonLookupStep(pParse, pParse->nNode-1, zPath, pApnd, pzErr);
  174786. }
  174787. /*
  174788. ** Return the text of a syntax error message on a JSON path. Space is
  174789. ** obtained from sqlite3_malloc().
  174790. */
  174791. static char *jsonPathSyntaxError(const char *zErr){
  174792. return sqlite3_mprintf("JSON path error near '%q'", zErr);
  174793. }
  174794. /*
  174795. ** Do a node lookup using zPath. Return a pointer to the node on success.
  174796. ** Return NULL if not found or if there is an error.
  174797. **
  174798. ** On an error, write an error message into pCtx and increment the
  174799. ** pParse->nErr counter.
  174800. **
  174801. ** If pApnd!=NULL then try to append missing nodes and set *pApnd = 1 if
  174802. ** nodes are appended.
  174803. */
  174804. static JsonNode *jsonLookup(
  174805. JsonParse *pParse, /* The JSON to search */
  174806. const char *zPath, /* The path to search */
  174807. int *pApnd, /* Append nodes to complete path if not NULL */
  174808. sqlite3_context *pCtx /* Report errors here, if not NULL */
  174809. ){
  174810. const char *zErr = 0;
  174811. JsonNode *pNode = 0;
  174812. char *zMsg;
  174813. if( zPath==0 ) return 0;
  174814. if( zPath[0]!='$' ){
  174815. zErr = zPath;
  174816. goto lookup_err;
  174817. }
  174818. zPath++;
  174819. pNode = jsonLookupStep(pParse, 0, zPath, pApnd, &zErr);
  174820. if( zErr==0 ) return pNode;
  174821. lookup_err:
  174822. pParse->nErr++;
  174823. assert( zErr!=0 && pCtx!=0 );
  174824. zMsg = jsonPathSyntaxError(zErr);
  174825. if( zMsg ){
  174826. sqlite3_result_error(pCtx, zMsg, -1);
  174827. sqlite3_free(zMsg);
  174828. }else{
  174829. sqlite3_result_error_nomem(pCtx);
  174830. }
  174831. return 0;
  174832. }
  174833. /*
  174834. ** Report the wrong number of arguments for json_insert(), json_replace()
  174835. ** or json_set().
  174836. */
  174837. static void jsonWrongNumArgs(
  174838. sqlite3_context *pCtx,
  174839. const char *zFuncName
  174840. ){
  174841. char *zMsg = sqlite3_mprintf("json_%s() needs an odd number of arguments",
  174842. zFuncName);
  174843. sqlite3_result_error(pCtx, zMsg, -1);
  174844. sqlite3_free(zMsg);
  174845. }
  174846. /*
  174847. ** Mark all NULL entries in the Object passed in as JNODE_REMOVE.
  174848. */
  174849. static void jsonRemoveAllNulls(JsonNode *pNode){
  174850. int i, n;
  174851. assert( pNode->eType==JSON_OBJECT );
  174852. n = pNode->n;
  174853. for(i=2; i<=n; i += jsonNodeSize(&pNode[i])+1){
  174854. switch( pNode[i].eType ){
  174855. case JSON_NULL:
  174856. pNode[i].jnFlags |= JNODE_REMOVE;
  174857. break;
  174858. case JSON_OBJECT:
  174859. jsonRemoveAllNulls(&pNode[i]);
  174860. break;
  174861. }
  174862. }
  174863. }
  174864. /****************************************************************************
  174865. ** SQL functions used for testing and debugging
  174866. ****************************************************************************/
  174867. #ifdef SQLITE_DEBUG
  174868. /*
  174869. ** The json_parse(JSON) function returns a string which describes
  174870. ** a parse of the JSON provided. Or it returns NULL if JSON is not
  174871. ** well-formed.
  174872. */
  174873. static void jsonParseFunc(
  174874. sqlite3_context *ctx,
  174875. int argc,
  174876. sqlite3_value **argv
  174877. ){
  174878. JsonString s; /* Output string - not real JSON */
  174879. JsonParse x; /* The parse */
  174880. u32 i;
  174881. assert( argc==1 );
  174882. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  174883. jsonParseFindParents(&x);
  174884. jsonInit(&s, ctx);
  174885. for(i=0; i<x.nNode; i++){
  174886. const char *zType;
  174887. if( x.aNode[i].jnFlags & JNODE_LABEL ){
  174888. assert( x.aNode[i].eType==JSON_STRING );
  174889. zType = "label";
  174890. }else{
  174891. zType = jsonType[x.aNode[i].eType];
  174892. }
  174893. jsonPrintf(100, &s,"node %3u: %7s n=%-4d up=%-4d",
  174894. i, zType, x.aNode[i].n, x.aUp[i]);
  174895. if( x.aNode[i].u.zJContent!=0 ){
  174896. jsonAppendRaw(&s, " ", 1);
  174897. jsonAppendRaw(&s, x.aNode[i].u.zJContent, x.aNode[i].n);
  174898. }
  174899. jsonAppendRaw(&s, "\n", 1);
  174900. }
  174901. jsonParseReset(&x);
  174902. jsonResult(&s);
  174903. }
  174904. /*
  174905. ** The json_test1(JSON) function return true (1) if the input is JSON
  174906. ** text generated by another json function. It returns (0) if the input
  174907. ** is not known to be JSON.
  174908. */
  174909. static void jsonTest1Func(
  174910. sqlite3_context *ctx,
  174911. int argc,
  174912. sqlite3_value **argv
  174913. ){
  174914. UNUSED_PARAM(argc);
  174915. sqlite3_result_int(ctx, sqlite3_value_subtype(argv[0])==JSON_SUBTYPE);
  174916. }
  174917. #endif /* SQLITE_DEBUG */
  174918. /****************************************************************************
  174919. ** Scalar SQL function implementations
  174920. ****************************************************************************/
  174921. /*
  174922. ** Implementation of the json_QUOTE(VALUE) function. Return a JSON value
  174923. ** corresponding to the SQL value input. Mostly this means putting
  174924. ** double-quotes around strings and returning the unquoted string "null"
  174925. ** when given a NULL input.
  174926. */
  174927. static void jsonQuoteFunc(
  174928. sqlite3_context *ctx,
  174929. int argc,
  174930. sqlite3_value **argv
  174931. ){
  174932. JsonString jx;
  174933. UNUSED_PARAM(argc);
  174934. jsonInit(&jx, ctx);
  174935. jsonAppendValue(&jx, argv[0]);
  174936. jsonResult(&jx);
  174937. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  174938. }
  174939. /*
  174940. ** Implementation of the json_array(VALUE,...) function. Return a JSON
  174941. ** array that contains all values given in arguments. Or if any argument
  174942. ** is a BLOB, throw an error.
  174943. */
  174944. static void jsonArrayFunc(
  174945. sqlite3_context *ctx,
  174946. int argc,
  174947. sqlite3_value **argv
  174948. ){
  174949. int i;
  174950. JsonString jx;
  174951. jsonInit(&jx, ctx);
  174952. jsonAppendChar(&jx, '[');
  174953. for(i=0; i<argc; i++){
  174954. jsonAppendSeparator(&jx);
  174955. jsonAppendValue(&jx, argv[i]);
  174956. }
  174957. jsonAppendChar(&jx, ']');
  174958. jsonResult(&jx);
  174959. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  174960. }
  174961. /*
  174962. ** json_array_length(JSON)
  174963. ** json_array_length(JSON, PATH)
  174964. **
  174965. ** Return the number of elements in the top-level JSON array.
  174966. ** Return 0 if the input is not a well-formed JSON array.
  174967. */
  174968. static void jsonArrayLengthFunc(
  174969. sqlite3_context *ctx,
  174970. int argc,
  174971. sqlite3_value **argv
  174972. ){
  174973. JsonParse *p; /* The parse */
  174974. sqlite3_int64 n = 0;
  174975. u32 i;
  174976. JsonNode *pNode;
  174977. p = jsonParseCached(ctx, argv);
  174978. if( p==0 ) return;
  174979. assert( p->nNode );
  174980. if( argc==2 ){
  174981. const char *zPath = (const char*)sqlite3_value_text(argv[1]);
  174982. pNode = jsonLookup(p, zPath, 0, ctx);
  174983. }else{
  174984. pNode = p->aNode;
  174985. }
  174986. if( pNode==0 ){
  174987. return;
  174988. }
  174989. if( pNode->eType==JSON_ARRAY ){
  174990. assert( (pNode->jnFlags & JNODE_APPEND)==0 );
  174991. for(i=1; i<=pNode->n; n++){
  174992. i += jsonNodeSize(&pNode[i]);
  174993. }
  174994. }
  174995. sqlite3_result_int64(ctx, n);
  174996. }
  174997. /*
  174998. ** json_extract(JSON, PATH, ...)
  174999. **
  175000. ** Return the element described by PATH. Return NULL if there is no
  175001. ** PATH element. If there are multiple PATHs, then return a JSON array
  175002. ** with the result from each path. Throw an error if the JSON or any PATH
  175003. ** is malformed.
  175004. */
  175005. static void jsonExtractFunc(
  175006. sqlite3_context *ctx,
  175007. int argc,
  175008. sqlite3_value **argv
  175009. ){
  175010. JsonParse *p; /* The parse */
  175011. JsonNode *pNode;
  175012. const char *zPath;
  175013. JsonString jx;
  175014. int i;
  175015. if( argc<2 ) return;
  175016. p = jsonParseCached(ctx, argv);
  175017. if( p==0 ) return;
  175018. jsonInit(&jx, ctx);
  175019. jsonAppendChar(&jx, '[');
  175020. for(i=1; i<argc; i++){
  175021. zPath = (const char*)sqlite3_value_text(argv[i]);
  175022. pNode = jsonLookup(p, zPath, 0, ctx);
  175023. if( p->nErr ) break;
  175024. if( argc>2 ){
  175025. jsonAppendSeparator(&jx);
  175026. if( pNode ){
  175027. jsonRenderNode(pNode, &jx, 0);
  175028. }else{
  175029. jsonAppendRaw(&jx, "null", 4);
  175030. }
  175031. }else if( pNode ){
  175032. jsonReturn(pNode, ctx, 0);
  175033. }
  175034. }
  175035. if( argc>2 && i==argc ){
  175036. jsonAppendChar(&jx, ']');
  175037. jsonResult(&jx);
  175038. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  175039. }
  175040. jsonReset(&jx);
  175041. }
  175042. /* This is the RFC 7396 MergePatch algorithm.
  175043. */
  175044. static JsonNode *jsonMergePatch(
  175045. JsonParse *pParse, /* The JSON parser that contains the TARGET */
  175046. u32 iTarget, /* Node of the TARGET in pParse */
  175047. JsonNode *pPatch /* The PATCH */
  175048. ){
  175049. u32 i, j;
  175050. u32 iRoot;
  175051. JsonNode *pTarget;
  175052. if( pPatch->eType!=JSON_OBJECT ){
  175053. return pPatch;
  175054. }
  175055. assert( iTarget>=0 && iTarget<pParse->nNode );
  175056. pTarget = &pParse->aNode[iTarget];
  175057. assert( (pPatch->jnFlags & JNODE_APPEND)==0 );
  175058. if( pTarget->eType!=JSON_OBJECT ){
  175059. jsonRemoveAllNulls(pPatch);
  175060. return pPatch;
  175061. }
  175062. iRoot = iTarget;
  175063. for(i=1; i<pPatch->n; i += jsonNodeSize(&pPatch[i+1])+1){
  175064. u32 nKey;
  175065. const char *zKey;
  175066. assert( pPatch[i].eType==JSON_STRING );
  175067. assert( pPatch[i].jnFlags & JNODE_LABEL );
  175068. nKey = pPatch[i].n;
  175069. zKey = pPatch[i].u.zJContent;
  175070. assert( (pPatch[i].jnFlags & JNODE_RAW)==0 );
  175071. for(j=1; j<pTarget->n; j += jsonNodeSize(&pTarget[j+1])+1 ){
  175072. assert( pTarget[j].eType==JSON_STRING );
  175073. assert( pTarget[j].jnFlags & JNODE_LABEL );
  175074. assert( (pPatch[i].jnFlags & JNODE_RAW)==0 );
  175075. if( pTarget[j].n==nKey && strncmp(pTarget[j].u.zJContent,zKey,nKey)==0 ){
  175076. if( pTarget[j+1].jnFlags & (JNODE_REMOVE|JNODE_PATCH) ) break;
  175077. if( pPatch[i+1].eType==JSON_NULL ){
  175078. pTarget[j+1].jnFlags |= JNODE_REMOVE;
  175079. }else{
  175080. JsonNode *pNew = jsonMergePatch(pParse, iTarget+j+1, &pPatch[i+1]);
  175081. if( pNew==0 ) return 0;
  175082. pTarget = &pParse->aNode[iTarget];
  175083. if( pNew!=&pTarget[j+1] ){
  175084. pTarget[j+1].u.pPatch = pNew;
  175085. pTarget[j+1].jnFlags |= JNODE_PATCH;
  175086. }
  175087. }
  175088. break;
  175089. }
  175090. }
  175091. if( j>=pTarget->n && pPatch[i+1].eType!=JSON_NULL ){
  175092. int iStart, iPatch;
  175093. iStart = jsonParseAddNode(pParse, JSON_OBJECT, 2, 0);
  175094. jsonParseAddNode(pParse, JSON_STRING, nKey, zKey);
  175095. iPatch = jsonParseAddNode(pParse, JSON_TRUE, 0, 0);
  175096. if( pParse->oom ) return 0;
  175097. jsonRemoveAllNulls(pPatch);
  175098. pTarget = &pParse->aNode[iTarget];
  175099. pParse->aNode[iRoot].jnFlags |= JNODE_APPEND;
  175100. pParse->aNode[iRoot].u.iAppend = iStart - iRoot;
  175101. iRoot = iStart;
  175102. pParse->aNode[iPatch].jnFlags |= JNODE_PATCH;
  175103. pParse->aNode[iPatch].u.pPatch = &pPatch[i+1];
  175104. }
  175105. }
  175106. return pTarget;
  175107. }
  175108. /*
  175109. ** Implementation of the json_mergepatch(JSON1,JSON2) function. Return a JSON
  175110. ** object that is the result of running the RFC 7396 MergePatch() algorithm
  175111. ** on the two arguments.
  175112. */
  175113. static void jsonPatchFunc(
  175114. sqlite3_context *ctx,
  175115. int argc,
  175116. sqlite3_value **argv
  175117. ){
  175118. JsonParse x; /* The JSON that is being patched */
  175119. JsonParse y; /* The patch */
  175120. JsonNode *pResult; /* The result of the merge */
  175121. UNUSED_PARAM(argc);
  175122. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  175123. if( jsonParse(&y, ctx, (const char*)sqlite3_value_text(argv[1])) ){
  175124. jsonParseReset(&x);
  175125. return;
  175126. }
  175127. pResult = jsonMergePatch(&x, 0, y.aNode);
  175128. assert( pResult!=0 || x.oom );
  175129. if( pResult ){
  175130. jsonReturnJson(pResult, ctx, 0);
  175131. }else{
  175132. sqlite3_result_error_nomem(ctx);
  175133. }
  175134. jsonParseReset(&x);
  175135. jsonParseReset(&y);
  175136. }
  175137. /*
  175138. ** Implementation of the json_object(NAME,VALUE,...) function. Return a JSON
  175139. ** object that contains all name/value given in arguments. Or if any name
  175140. ** is not a string or if any value is a BLOB, throw an error.
  175141. */
  175142. static void jsonObjectFunc(
  175143. sqlite3_context *ctx,
  175144. int argc,
  175145. sqlite3_value **argv
  175146. ){
  175147. int i;
  175148. JsonString jx;
  175149. const char *z;
  175150. u32 n;
  175151. if( argc&1 ){
  175152. sqlite3_result_error(ctx, "json_object() requires an even number "
  175153. "of arguments", -1);
  175154. return;
  175155. }
  175156. jsonInit(&jx, ctx);
  175157. jsonAppendChar(&jx, '{');
  175158. for(i=0; i<argc; i+=2){
  175159. if( sqlite3_value_type(argv[i])!=SQLITE_TEXT ){
  175160. sqlite3_result_error(ctx, "json_object() labels must be TEXT", -1);
  175161. jsonReset(&jx);
  175162. return;
  175163. }
  175164. jsonAppendSeparator(&jx);
  175165. z = (const char*)sqlite3_value_text(argv[i]);
  175166. n = (u32)sqlite3_value_bytes(argv[i]);
  175167. jsonAppendString(&jx, z, n);
  175168. jsonAppendChar(&jx, ':');
  175169. jsonAppendValue(&jx, argv[i+1]);
  175170. }
  175171. jsonAppendChar(&jx, '}');
  175172. jsonResult(&jx);
  175173. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  175174. }
  175175. /*
  175176. ** json_remove(JSON, PATH, ...)
  175177. **
  175178. ** Remove the named elements from JSON and return the result. malformed
  175179. ** JSON or PATH arguments result in an error.
  175180. */
  175181. static void jsonRemoveFunc(
  175182. sqlite3_context *ctx,
  175183. int argc,
  175184. sqlite3_value **argv
  175185. ){
  175186. JsonParse x; /* The parse */
  175187. JsonNode *pNode;
  175188. const char *zPath;
  175189. u32 i;
  175190. if( argc<1 ) return;
  175191. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  175192. assert( x.nNode );
  175193. for(i=1; i<(u32)argc; i++){
  175194. zPath = (const char*)sqlite3_value_text(argv[i]);
  175195. if( zPath==0 ) goto remove_done;
  175196. pNode = jsonLookup(&x, zPath, 0, ctx);
  175197. if( x.nErr ) goto remove_done;
  175198. if( pNode ) pNode->jnFlags |= JNODE_REMOVE;
  175199. }
  175200. if( (x.aNode[0].jnFlags & JNODE_REMOVE)==0 ){
  175201. jsonReturnJson(x.aNode, ctx, 0);
  175202. }
  175203. remove_done:
  175204. jsonParseReset(&x);
  175205. }
  175206. /*
  175207. ** json_replace(JSON, PATH, VALUE, ...)
  175208. **
  175209. ** Replace the value at PATH with VALUE. If PATH does not already exist,
  175210. ** this routine is a no-op. If JSON or PATH is malformed, throw an error.
  175211. */
  175212. static void jsonReplaceFunc(
  175213. sqlite3_context *ctx,
  175214. int argc,
  175215. sqlite3_value **argv
  175216. ){
  175217. JsonParse x; /* The parse */
  175218. JsonNode *pNode;
  175219. const char *zPath;
  175220. u32 i;
  175221. if( argc<1 ) return;
  175222. if( (argc&1)==0 ) {
  175223. jsonWrongNumArgs(ctx, "replace");
  175224. return;
  175225. }
  175226. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  175227. assert( x.nNode );
  175228. for(i=1; i<(u32)argc; i+=2){
  175229. zPath = (const char*)sqlite3_value_text(argv[i]);
  175230. pNode = jsonLookup(&x, zPath, 0, ctx);
  175231. if( x.nErr ) goto replace_err;
  175232. if( pNode ){
  175233. pNode->jnFlags |= (u8)JNODE_REPLACE;
  175234. pNode->u.iReplace = i + 1;
  175235. }
  175236. }
  175237. if( x.aNode[0].jnFlags & JNODE_REPLACE ){
  175238. sqlite3_result_value(ctx, argv[x.aNode[0].u.iReplace]);
  175239. }else{
  175240. jsonReturnJson(x.aNode, ctx, argv);
  175241. }
  175242. replace_err:
  175243. jsonParseReset(&x);
  175244. }
  175245. /*
  175246. ** json_set(JSON, PATH, VALUE, ...)
  175247. **
  175248. ** Set the value at PATH to VALUE. Create the PATH if it does not already
  175249. ** exist. Overwrite existing values that do exist.
  175250. ** If JSON or PATH is malformed, throw an error.
  175251. **
  175252. ** json_insert(JSON, PATH, VALUE, ...)
  175253. **
  175254. ** Create PATH and initialize it to VALUE. If PATH already exists, this
  175255. ** routine is a no-op. If JSON or PATH is malformed, throw an error.
  175256. */
  175257. static void jsonSetFunc(
  175258. sqlite3_context *ctx,
  175259. int argc,
  175260. sqlite3_value **argv
  175261. ){
  175262. JsonParse x; /* The parse */
  175263. JsonNode *pNode;
  175264. const char *zPath;
  175265. u32 i;
  175266. int bApnd;
  175267. int bIsSet = *(int*)sqlite3_user_data(ctx);
  175268. if( argc<1 ) return;
  175269. if( (argc&1)==0 ) {
  175270. jsonWrongNumArgs(ctx, bIsSet ? "set" : "insert");
  175271. return;
  175272. }
  175273. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  175274. assert( x.nNode );
  175275. for(i=1; i<(u32)argc; i+=2){
  175276. zPath = (const char*)sqlite3_value_text(argv[i]);
  175277. bApnd = 0;
  175278. pNode = jsonLookup(&x, zPath, &bApnd, ctx);
  175279. if( x.oom ){
  175280. sqlite3_result_error_nomem(ctx);
  175281. goto jsonSetDone;
  175282. }else if( x.nErr ){
  175283. goto jsonSetDone;
  175284. }else if( pNode && (bApnd || bIsSet) ){
  175285. pNode->jnFlags |= (u8)JNODE_REPLACE;
  175286. pNode->u.iReplace = i + 1;
  175287. }
  175288. }
  175289. if( x.aNode[0].jnFlags & JNODE_REPLACE ){
  175290. sqlite3_result_value(ctx, argv[x.aNode[0].u.iReplace]);
  175291. }else{
  175292. jsonReturnJson(x.aNode, ctx, argv);
  175293. }
  175294. jsonSetDone:
  175295. jsonParseReset(&x);
  175296. }
  175297. /*
  175298. ** json_type(JSON)
  175299. ** json_type(JSON, PATH)
  175300. **
  175301. ** Return the top-level "type" of a JSON string. Throw an error if
  175302. ** either the JSON or PATH inputs are not well-formed.
  175303. */
  175304. static void jsonTypeFunc(
  175305. sqlite3_context *ctx,
  175306. int argc,
  175307. sqlite3_value **argv
  175308. ){
  175309. JsonParse x; /* The parse */
  175310. const char *zPath;
  175311. JsonNode *pNode;
  175312. if( jsonParse(&x, ctx, (const char*)sqlite3_value_text(argv[0])) ) return;
  175313. assert( x.nNode );
  175314. if( argc==2 ){
  175315. zPath = (const char*)sqlite3_value_text(argv[1]);
  175316. pNode = jsonLookup(&x, zPath, 0, ctx);
  175317. }else{
  175318. pNode = x.aNode;
  175319. }
  175320. if( pNode ){
  175321. sqlite3_result_text(ctx, jsonType[pNode->eType], -1, SQLITE_STATIC);
  175322. }
  175323. jsonParseReset(&x);
  175324. }
  175325. /*
  175326. ** json_valid(JSON)
  175327. **
  175328. ** Return 1 if JSON is a well-formed JSON string according to RFC-7159.
  175329. ** Return 0 otherwise.
  175330. */
  175331. static void jsonValidFunc(
  175332. sqlite3_context *ctx,
  175333. int argc,
  175334. sqlite3_value **argv
  175335. ){
  175336. JsonParse x; /* The parse */
  175337. int rc = 0;
  175338. UNUSED_PARAM(argc);
  175339. if( jsonParse(&x, 0, (const char*)sqlite3_value_text(argv[0]))==0 ){
  175340. rc = 1;
  175341. }
  175342. jsonParseReset(&x);
  175343. sqlite3_result_int(ctx, rc);
  175344. }
  175345. /****************************************************************************
  175346. ** Aggregate SQL function implementations
  175347. ****************************************************************************/
  175348. /*
  175349. ** json_group_array(VALUE)
  175350. **
  175351. ** Return a JSON array composed of all values in the aggregate.
  175352. */
  175353. static void jsonArrayStep(
  175354. sqlite3_context *ctx,
  175355. int argc,
  175356. sqlite3_value **argv
  175357. ){
  175358. JsonString *pStr;
  175359. UNUSED_PARAM(argc);
  175360. pStr = (JsonString*)sqlite3_aggregate_context(ctx, sizeof(*pStr));
  175361. if( pStr ){
  175362. if( pStr->zBuf==0 ){
  175363. jsonInit(pStr, ctx);
  175364. jsonAppendChar(pStr, '[');
  175365. }else{
  175366. jsonAppendChar(pStr, ',');
  175367. pStr->pCtx = ctx;
  175368. }
  175369. jsonAppendValue(pStr, argv[0]);
  175370. }
  175371. }
  175372. static void jsonArrayFinal(sqlite3_context *ctx){
  175373. JsonString *pStr;
  175374. pStr = (JsonString*)sqlite3_aggregate_context(ctx, 0);
  175375. if( pStr ){
  175376. pStr->pCtx = ctx;
  175377. jsonAppendChar(pStr, ']');
  175378. if( pStr->bErr ){
  175379. if( pStr->bErr==1 ) sqlite3_result_error_nomem(ctx);
  175380. assert( pStr->bStatic );
  175381. }else{
  175382. sqlite3_result_text(ctx, pStr->zBuf, pStr->nUsed,
  175383. pStr->bStatic ? SQLITE_TRANSIENT : sqlite3_free);
  175384. pStr->bStatic = 1;
  175385. }
  175386. }else{
  175387. sqlite3_result_text(ctx, "[]", 2, SQLITE_STATIC);
  175388. }
  175389. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  175390. }
  175391. /*
  175392. ** json_group_obj(NAME,VALUE)
  175393. **
  175394. ** Return a JSON object composed of all names and values in the aggregate.
  175395. */
  175396. static void jsonObjectStep(
  175397. sqlite3_context *ctx,
  175398. int argc,
  175399. sqlite3_value **argv
  175400. ){
  175401. JsonString *pStr;
  175402. const char *z;
  175403. u32 n;
  175404. UNUSED_PARAM(argc);
  175405. pStr = (JsonString*)sqlite3_aggregate_context(ctx, sizeof(*pStr));
  175406. if( pStr ){
  175407. if( pStr->zBuf==0 ){
  175408. jsonInit(pStr, ctx);
  175409. jsonAppendChar(pStr, '{');
  175410. }else{
  175411. jsonAppendChar(pStr, ',');
  175412. pStr->pCtx = ctx;
  175413. }
  175414. z = (const char*)sqlite3_value_text(argv[0]);
  175415. n = (u32)sqlite3_value_bytes(argv[0]);
  175416. jsonAppendString(pStr, z, n);
  175417. jsonAppendChar(pStr, ':');
  175418. jsonAppendValue(pStr, argv[1]);
  175419. }
  175420. }
  175421. static void jsonObjectFinal(sqlite3_context *ctx){
  175422. JsonString *pStr;
  175423. pStr = (JsonString*)sqlite3_aggregate_context(ctx, 0);
  175424. if( pStr ){
  175425. jsonAppendChar(pStr, '}');
  175426. if( pStr->bErr ){
  175427. if( pStr->bErr==1 ) sqlite3_result_error_nomem(ctx);
  175428. assert( pStr->bStatic );
  175429. }else{
  175430. sqlite3_result_text(ctx, pStr->zBuf, pStr->nUsed,
  175431. pStr->bStatic ? SQLITE_TRANSIENT : sqlite3_free);
  175432. pStr->bStatic = 1;
  175433. }
  175434. }else{
  175435. sqlite3_result_text(ctx, "{}", 2, SQLITE_STATIC);
  175436. }
  175437. sqlite3_result_subtype(ctx, JSON_SUBTYPE);
  175438. }
  175439. #ifndef SQLITE_OMIT_VIRTUALTABLE
  175440. /****************************************************************************
  175441. ** The json_each virtual table
  175442. ****************************************************************************/
  175443. typedef struct JsonEachCursor JsonEachCursor;
  175444. struct JsonEachCursor {
  175445. sqlite3_vtab_cursor base; /* Base class - must be first */
  175446. u32 iRowid; /* The rowid */
  175447. u32 iBegin; /* The first node of the scan */
  175448. u32 i; /* Index in sParse.aNode[] of current row */
  175449. u32 iEnd; /* EOF when i equals or exceeds this value */
  175450. u8 eType; /* Type of top-level element */
  175451. u8 bRecursive; /* True for json_tree(). False for json_each() */
  175452. char *zJson; /* Input JSON */
  175453. char *zRoot; /* Path by which to filter zJson */
  175454. JsonParse sParse; /* Parse of the input JSON */
  175455. };
  175456. /* Constructor for the json_each virtual table */
  175457. static int jsonEachConnect(
  175458. sqlite3 *db,
  175459. void *pAux,
  175460. int argc, const char *const*argv,
  175461. sqlite3_vtab **ppVtab,
  175462. char **pzErr
  175463. ){
  175464. sqlite3_vtab *pNew;
  175465. int rc;
  175466. /* Column numbers */
  175467. #define JEACH_KEY 0
  175468. #define JEACH_VALUE 1
  175469. #define JEACH_TYPE 2
  175470. #define JEACH_ATOM 3
  175471. #define JEACH_ID 4
  175472. #define JEACH_PARENT 5
  175473. #define JEACH_FULLKEY 6
  175474. #define JEACH_PATH 7
  175475. #define JEACH_JSON 8
  175476. #define JEACH_ROOT 9
  175477. UNUSED_PARAM(pzErr);
  175478. UNUSED_PARAM(argv);
  175479. UNUSED_PARAM(argc);
  175480. UNUSED_PARAM(pAux);
  175481. rc = sqlite3_declare_vtab(db,
  175482. "CREATE TABLE x(key,value,type,atom,id,parent,fullkey,path,"
  175483. "json HIDDEN,root HIDDEN)");
  175484. if( rc==SQLITE_OK ){
  175485. pNew = *ppVtab = sqlite3_malloc( sizeof(*pNew) );
  175486. if( pNew==0 ) return SQLITE_NOMEM;
  175487. memset(pNew, 0, sizeof(*pNew));
  175488. }
  175489. return rc;
  175490. }
  175491. /* destructor for json_each virtual table */
  175492. static int jsonEachDisconnect(sqlite3_vtab *pVtab){
  175493. sqlite3_free(pVtab);
  175494. return SQLITE_OK;
  175495. }
  175496. /* constructor for a JsonEachCursor object for json_each(). */
  175497. static int jsonEachOpenEach(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){
  175498. JsonEachCursor *pCur;
  175499. UNUSED_PARAM(p);
  175500. pCur = sqlite3_malloc( sizeof(*pCur) );
  175501. if( pCur==0 ) return SQLITE_NOMEM;
  175502. memset(pCur, 0, sizeof(*pCur));
  175503. *ppCursor = &pCur->base;
  175504. return SQLITE_OK;
  175505. }
  175506. /* constructor for a JsonEachCursor object for json_tree(). */
  175507. static int jsonEachOpenTree(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){
  175508. int rc = jsonEachOpenEach(p, ppCursor);
  175509. if( rc==SQLITE_OK ){
  175510. JsonEachCursor *pCur = (JsonEachCursor*)*ppCursor;
  175511. pCur->bRecursive = 1;
  175512. }
  175513. return rc;
  175514. }
  175515. /* Reset a JsonEachCursor back to its original state. Free any memory
  175516. ** held. */
  175517. static void jsonEachCursorReset(JsonEachCursor *p){
  175518. sqlite3_free(p->zJson);
  175519. sqlite3_free(p->zRoot);
  175520. jsonParseReset(&p->sParse);
  175521. p->iRowid = 0;
  175522. p->i = 0;
  175523. p->iEnd = 0;
  175524. p->eType = 0;
  175525. p->zJson = 0;
  175526. p->zRoot = 0;
  175527. }
  175528. /* Destructor for a jsonEachCursor object */
  175529. static int jsonEachClose(sqlite3_vtab_cursor *cur){
  175530. JsonEachCursor *p = (JsonEachCursor*)cur;
  175531. jsonEachCursorReset(p);
  175532. sqlite3_free(cur);
  175533. return SQLITE_OK;
  175534. }
  175535. /* Return TRUE if the jsonEachCursor object has been advanced off the end
  175536. ** of the JSON object */
  175537. static int jsonEachEof(sqlite3_vtab_cursor *cur){
  175538. JsonEachCursor *p = (JsonEachCursor*)cur;
  175539. return p->i >= p->iEnd;
  175540. }
  175541. /* Advance the cursor to the next element for json_tree() */
  175542. static int jsonEachNext(sqlite3_vtab_cursor *cur){
  175543. JsonEachCursor *p = (JsonEachCursor*)cur;
  175544. if( p->bRecursive ){
  175545. if( p->sParse.aNode[p->i].jnFlags & JNODE_LABEL ) p->i++;
  175546. p->i++;
  175547. p->iRowid++;
  175548. if( p->i<p->iEnd ){
  175549. u32 iUp = p->sParse.aUp[p->i];
  175550. JsonNode *pUp = &p->sParse.aNode[iUp];
  175551. p->eType = pUp->eType;
  175552. if( pUp->eType==JSON_ARRAY ){
  175553. if( iUp==p->i-1 ){
  175554. pUp->u.iKey = 0;
  175555. }else{
  175556. pUp->u.iKey++;
  175557. }
  175558. }
  175559. }
  175560. }else{
  175561. switch( p->eType ){
  175562. case JSON_ARRAY: {
  175563. p->i += jsonNodeSize(&p->sParse.aNode[p->i]);
  175564. p->iRowid++;
  175565. break;
  175566. }
  175567. case JSON_OBJECT: {
  175568. p->i += 1 + jsonNodeSize(&p->sParse.aNode[p->i+1]);
  175569. p->iRowid++;
  175570. break;
  175571. }
  175572. default: {
  175573. p->i = p->iEnd;
  175574. break;
  175575. }
  175576. }
  175577. }
  175578. return SQLITE_OK;
  175579. }
  175580. /* Append the name of the path for element i to pStr
  175581. */
  175582. static void jsonEachComputePath(
  175583. JsonEachCursor *p, /* The cursor */
  175584. JsonString *pStr, /* Write the path here */
  175585. u32 i /* Path to this element */
  175586. ){
  175587. JsonNode *pNode, *pUp;
  175588. u32 iUp;
  175589. if( i==0 ){
  175590. jsonAppendChar(pStr, '$');
  175591. return;
  175592. }
  175593. iUp = p->sParse.aUp[i];
  175594. jsonEachComputePath(p, pStr, iUp);
  175595. pNode = &p->sParse.aNode[i];
  175596. pUp = &p->sParse.aNode[iUp];
  175597. if( pUp->eType==JSON_ARRAY ){
  175598. jsonPrintf(30, pStr, "[%d]", pUp->u.iKey);
  175599. }else{
  175600. assert( pUp->eType==JSON_OBJECT );
  175601. if( (pNode->jnFlags & JNODE_LABEL)==0 ) pNode--;
  175602. assert( pNode->eType==JSON_STRING );
  175603. assert( pNode->jnFlags & JNODE_LABEL );
  175604. jsonPrintf(pNode->n+1, pStr, ".%.*s", pNode->n-2, pNode->u.zJContent+1);
  175605. }
  175606. }
  175607. /* Return the value of a column */
  175608. static int jsonEachColumn(
  175609. sqlite3_vtab_cursor *cur, /* The cursor */
  175610. sqlite3_context *ctx, /* First argument to sqlite3_result_...() */
  175611. int i /* Which column to return */
  175612. ){
  175613. JsonEachCursor *p = (JsonEachCursor*)cur;
  175614. JsonNode *pThis = &p->sParse.aNode[p->i];
  175615. switch( i ){
  175616. case JEACH_KEY: {
  175617. if( p->i==0 ) break;
  175618. if( p->eType==JSON_OBJECT ){
  175619. jsonReturn(pThis, ctx, 0);
  175620. }else if( p->eType==JSON_ARRAY ){
  175621. u32 iKey;
  175622. if( p->bRecursive ){
  175623. if( p->iRowid==0 ) break;
  175624. iKey = p->sParse.aNode[p->sParse.aUp[p->i]].u.iKey;
  175625. }else{
  175626. iKey = p->iRowid;
  175627. }
  175628. sqlite3_result_int64(ctx, (sqlite3_int64)iKey);
  175629. }
  175630. break;
  175631. }
  175632. case JEACH_VALUE: {
  175633. if( pThis->jnFlags & JNODE_LABEL ) pThis++;
  175634. jsonReturn(pThis, ctx, 0);
  175635. break;
  175636. }
  175637. case JEACH_TYPE: {
  175638. if( pThis->jnFlags & JNODE_LABEL ) pThis++;
  175639. sqlite3_result_text(ctx, jsonType[pThis->eType], -1, SQLITE_STATIC);
  175640. break;
  175641. }
  175642. case JEACH_ATOM: {
  175643. if( pThis->jnFlags & JNODE_LABEL ) pThis++;
  175644. if( pThis->eType>=JSON_ARRAY ) break;
  175645. jsonReturn(pThis, ctx, 0);
  175646. break;
  175647. }
  175648. case JEACH_ID: {
  175649. sqlite3_result_int64(ctx,
  175650. (sqlite3_int64)p->i + ((pThis->jnFlags & JNODE_LABEL)!=0));
  175651. break;
  175652. }
  175653. case JEACH_PARENT: {
  175654. if( p->i>p->iBegin && p->bRecursive ){
  175655. sqlite3_result_int64(ctx, (sqlite3_int64)p->sParse.aUp[p->i]);
  175656. }
  175657. break;
  175658. }
  175659. case JEACH_FULLKEY: {
  175660. JsonString x;
  175661. jsonInit(&x, ctx);
  175662. if( p->bRecursive ){
  175663. jsonEachComputePath(p, &x, p->i);
  175664. }else{
  175665. if( p->zRoot ){
  175666. jsonAppendRaw(&x, p->zRoot, (int)strlen(p->zRoot));
  175667. }else{
  175668. jsonAppendChar(&x, '$');
  175669. }
  175670. if( p->eType==JSON_ARRAY ){
  175671. jsonPrintf(30, &x, "[%d]", p->iRowid);
  175672. }else{
  175673. jsonPrintf(pThis->n, &x, ".%.*s", pThis->n-2, pThis->u.zJContent+1);
  175674. }
  175675. }
  175676. jsonResult(&x);
  175677. break;
  175678. }
  175679. case JEACH_PATH: {
  175680. if( p->bRecursive ){
  175681. JsonString x;
  175682. jsonInit(&x, ctx);
  175683. jsonEachComputePath(p, &x, p->sParse.aUp[p->i]);
  175684. jsonResult(&x);
  175685. break;
  175686. }
  175687. /* For json_each() path and root are the same so fall through
  175688. ** into the root case */
  175689. }
  175690. default: {
  175691. const char *zRoot = p->zRoot;
  175692. if( zRoot==0 ) zRoot = "$";
  175693. sqlite3_result_text(ctx, zRoot, -1, SQLITE_STATIC);
  175694. break;
  175695. }
  175696. case JEACH_JSON: {
  175697. assert( i==JEACH_JSON );
  175698. sqlite3_result_text(ctx, p->sParse.zJson, -1, SQLITE_STATIC);
  175699. break;
  175700. }
  175701. }
  175702. return SQLITE_OK;
  175703. }
  175704. /* Return the current rowid value */
  175705. static int jsonEachRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){
  175706. JsonEachCursor *p = (JsonEachCursor*)cur;
  175707. *pRowid = p->iRowid;
  175708. return SQLITE_OK;
  175709. }
  175710. /* The query strategy is to look for an equality constraint on the json
  175711. ** column. Without such a constraint, the table cannot operate. idxNum is
  175712. ** 1 if the constraint is found, 3 if the constraint and zRoot are found,
  175713. ** and 0 otherwise.
  175714. */
  175715. static int jsonEachBestIndex(
  175716. sqlite3_vtab *tab,
  175717. sqlite3_index_info *pIdxInfo
  175718. ){
  175719. int i;
  175720. int jsonIdx = -1;
  175721. int rootIdx = -1;
  175722. const struct sqlite3_index_constraint *pConstraint;
  175723. UNUSED_PARAM(tab);
  175724. pConstraint = pIdxInfo->aConstraint;
  175725. for(i=0; i<pIdxInfo->nConstraint; i++, pConstraint++){
  175726. if( pConstraint->usable==0 ) continue;
  175727. if( pConstraint->op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
  175728. switch( pConstraint->iColumn ){
  175729. case JEACH_JSON: jsonIdx = i; break;
  175730. case JEACH_ROOT: rootIdx = i; break;
  175731. default: /* no-op */ break;
  175732. }
  175733. }
  175734. if( jsonIdx<0 ){
  175735. pIdxInfo->idxNum = 0;
  175736. pIdxInfo->estimatedCost = 1e99;
  175737. }else{
  175738. pIdxInfo->estimatedCost = 1.0;
  175739. pIdxInfo->aConstraintUsage[jsonIdx].argvIndex = 1;
  175740. pIdxInfo->aConstraintUsage[jsonIdx].omit = 1;
  175741. if( rootIdx<0 ){
  175742. pIdxInfo->idxNum = 1;
  175743. }else{
  175744. pIdxInfo->aConstraintUsage[rootIdx].argvIndex = 2;
  175745. pIdxInfo->aConstraintUsage[rootIdx].omit = 1;
  175746. pIdxInfo->idxNum = 3;
  175747. }
  175748. }
  175749. return SQLITE_OK;
  175750. }
  175751. /* Start a search on a new JSON string */
  175752. static int jsonEachFilter(
  175753. sqlite3_vtab_cursor *cur,
  175754. int idxNum, const char *idxStr,
  175755. int argc, sqlite3_value **argv
  175756. ){
  175757. JsonEachCursor *p = (JsonEachCursor*)cur;
  175758. const char *z;
  175759. const char *zRoot = 0;
  175760. sqlite3_int64 n;
  175761. UNUSED_PARAM(idxStr);
  175762. UNUSED_PARAM(argc);
  175763. jsonEachCursorReset(p);
  175764. if( idxNum==0 ) return SQLITE_OK;
  175765. z = (const char*)sqlite3_value_text(argv[0]);
  175766. if( z==0 ) return SQLITE_OK;
  175767. n = sqlite3_value_bytes(argv[0]);
  175768. p->zJson = sqlite3_malloc64( n+1 );
  175769. if( p->zJson==0 ) return SQLITE_NOMEM;
  175770. memcpy(p->zJson, z, (size_t)n+1);
  175771. if( jsonParse(&p->sParse, 0, p->zJson) ){
  175772. int rc = SQLITE_NOMEM;
  175773. if( p->sParse.oom==0 ){
  175774. sqlite3_free(cur->pVtab->zErrMsg);
  175775. cur->pVtab->zErrMsg = sqlite3_mprintf("malformed JSON");
  175776. if( cur->pVtab->zErrMsg ) rc = SQLITE_ERROR;
  175777. }
  175778. jsonEachCursorReset(p);
  175779. return rc;
  175780. }else if( p->bRecursive && jsonParseFindParents(&p->sParse) ){
  175781. jsonEachCursorReset(p);
  175782. return SQLITE_NOMEM;
  175783. }else{
  175784. JsonNode *pNode = 0;
  175785. if( idxNum==3 ){
  175786. const char *zErr = 0;
  175787. zRoot = (const char*)sqlite3_value_text(argv[1]);
  175788. if( zRoot==0 ) return SQLITE_OK;
  175789. n = sqlite3_value_bytes(argv[1]);
  175790. p->zRoot = sqlite3_malloc64( n+1 );
  175791. if( p->zRoot==0 ) return SQLITE_NOMEM;
  175792. memcpy(p->zRoot, zRoot, (size_t)n+1);
  175793. if( zRoot[0]!='$' ){
  175794. zErr = zRoot;
  175795. }else{
  175796. pNode = jsonLookupStep(&p->sParse, 0, p->zRoot+1, 0, &zErr);
  175797. }
  175798. if( zErr ){
  175799. sqlite3_free(cur->pVtab->zErrMsg);
  175800. cur->pVtab->zErrMsg = jsonPathSyntaxError(zErr);
  175801. jsonEachCursorReset(p);
  175802. return cur->pVtab->zErrMsg ? SQLITE_ERROR : SQLITE_NOMEM;
  175803. }else if( pNode==0 ){
  175804. return SQLITE_OK;
  175805. }
  175806. }else{
  175807. pNode = p->sParse.aNode;
  175808. }
  175809. p->iBegin = p->i = (int)(pNode - p->sParse.aNode);
  175810. p->eType = pNode->eType;
  175811. if( p->eType>=JSON_ARRAY ){
  175812. pNode->u.iKey = 0;
  175813. p->iEnd = p->i + pNode->n + 1;
  175814. if( p->bRecursive ){
  175815. p->eType = p->sParse.aNode[p->sParse.aUp[p->i]].eType;
  175816. if( p->i>0 && (p->sParse.aNode[p->i-1].jnFlags & JNODE_LABEL)!=0 ){
  175817. p->i--;
  175818. }
  175819. }else{
  175820. p->i++;
  175821. }
  175822. }else{
  175823. p->iEnd = p->i+1;
  175824. }
  175825. }
  175826. return SQLITE_OK;
  175827. }
  175828. /* The methods of the json_each virtual table */
  175829. static sqlite3_module jsonEachModule = {
  175830. 0, /* iVersion */
  175831. 0, /* xCreate */
  175832. jsonEachConnect, /* xConnect */
  175833. jsonEachBestIndex, /* xBestIndex */
  175834. jsonEachDisconnect, /* xDisconnect */
  175835. 0, /* xDestroy */
  175836. jsonEachOpenEach, /* xOpen - open a cursor */
  175837. jsonEachClose, /* xClose - close a cursor */
  175838. jsonEachFilter, /* xFilter - configure scan constraints */
  175839. jsonEachNext, /* xNext - advance a cursor */
  175840. jsonEachEof, /* xEof - check for end of scan */
  175841. jsonEachColumn, /* xColumn - read data */
  175842. jsonEachRowid, /* xRowid - read data */
  175843. 0, /* xUpdate */
  175844. 0, /* xBegin */
  175845. 0, /* xSync */
  175846. 0, /* xCommit */
  175847. 0, /* xRollback */
  175848. 0, /* xFindMethod */
  175849. 0, /* xRename */
  175850. 0, /* xSavepoint */
  175851. 0, /* xRelease */
  175852. 0 /* xRollbackTo */
  175853. };
  175854. /* The methods of the json_tree virtual table. */
  175855. static sqlite3_module jsonTreeModule = {
  175856. 0, /* iVersion */
  175857. 0, /* xCreate */
  175858. jsonEachConnect, /* xConnect */
  175859. jsonEachBestIndex, /* xBestIndex */
  175860. jsonEachDisconnect, /* xDisconnect */
  175861. 0, /* xDestroy */
  175862. jsonEachOpenTree, /* xOpen - open a cursor */
  175863. jsonEachClose, /* xClose - close a cursor */
  175864. jsonEachFilter, /* xFilter - configure scan constraints */
  175865. jsonEachNext, /* xNext - advance a cursor */
  175866. jsonEachEof, /* xEof - check for end of scan */
  175867. jsonEachColumn, /* xColumn - read data */
  175868. jsonEachRowid, /* xRowid - read data */
  175869. 0, /* xUpdate */
  175870. 0, /* xBegin */
  175871. 0, /* xSync */
  175872. 0, /* xCommit */
  175873. 0, /* xRollback */
  175874. 0, /* xFindMethod */
  175875. 0, /* xRename */
  175876. 0, /* xSavepoint */
  175877. 0, /* xRelease */
  175878. 0 /* xRollbackTo */
  175879. };
  175880. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  175881. /****************************************************************************
  175882. ** The following routines are the only publically visible identifiers in this
  175883. ** file. Call the following routines in order to register the various SQL
  175884. ** functions and the virtual table implemented by this file.
  175885. ****************************************************************************/
  175886. SQLITE_PRIVATE int sqlite3Json1Init(sqlite3 *db){
  175887. int rc = SQLITE_OK;
  175888. unsigned int i;
  175889. static const struct {
  175890. const char *zName;
  175891. int nArg;
  175892. int flag;
  175893. void (*xFunc)(sqlite3_context*,int,sqlite3_value**);
  175894. } aFunc[] = {
  175895. { "json", 1, 0, jsonRemoveFunc },
  175896. { "json_array", -1, 0, jsonArrayFunc },
  175897. { "json_array_length", 1, 0, jsonArrayLengthFunc },
  175898. { "json_array_length", 2, 0, jsonArrayLengthFunc },
  175899. { "json_extract", -1, 0, jsonExtractFunc },
  175900. { "json_insert", -1, 0, jsonSetFunc },
  175901. { "json_object", -1, 0, jsonObjectFunc },
  175902. { "json_patch", 2, 0, jsonPatchFunc },
  175903. { "json_quote", 1, 0, jsonQuoteFunc },
  175904. { "json_remove", -1, 0, jsonRemoveFunc },
  175905. { "json_replace", -1, 0, jsonReplaceFunc },
  175906. { "json_set", -1, 1, jsonSetFunc },
  175907. { "json_type", 1, 0, jsonTypeFunc },
  175908. { "json_type", 2, 0, jsonTypeFunc },
  175909. { "json_valid", 1, 0, jsonValidFunc },
  175910. #if SQLITE_DEBUG
  175911. /* DEBUG and TESTING functions */
  175912. { "json_parse", 1, 0, jsonParseFunc },
  175913. { "json_test1", 1, 0, jsonTest1Func },
  175914. #endif
  175915. };
  175916. static const struct {
  175917. const char *zName;
  175918. int nArg;
  175919. void (*xStep)(sqlite3_context*,int,sqlite3_value**);
  175920. void (*xFinal)(sqlite3_context*);
  175921. } aAgg[] = {
  175922. { "json_group_array", 1, jsonArrayStep, jsonArrayFinal },
  175923. { "json_group_object", 2, jsonObjectStep, jsonObjectFinal },
  175924. };
  175925. #ifndef SQLITE_OMIT_VIRTUALTABLE
  175926. static const struct {
  175927. const char *zName;
  175928. sqlite3_module *pModule;
  175929. } aMod[] = {
  175930. { "json_each", &jsonEachModule },
  175931. { "json_tree", &jsonTreeModule },
  175932. };
  175933. #endif
  175934. for(i=0; i<sizeof(aFunc)/sizeof(aFunc[0]) && rc==SQLITE_OK; i++){
  175935. rc = sqlite3_create_function(db, aFunc[i].zName, aFunc[i].nArg,
  175936. SQLITE_UTF8 | SQLITE_DETERMINISTIC,
  175937. (void*)&aFunc[i].flag,
  175938. aFunc[i].xFunc, 0, 0);
  175939. }
  175940. for(i=0; i<sizeof(aAgg)/sizeof(aAgg[0]) && rc==SQLITE_OK; i++){
  175941. rc = sqlite3_create_function(db, aAgg[i].zName, aAgg[i].nArg,
  175942. SQLITE_UTF8 | SQLITE_DETERMINISTIC, 0,
  175943. 0, aAgg[i].xStep, aAgg[i].xFinal);
  175944. }
  175945. #ifndef SQLITE_OMIT_VIRTUALTABLE
  175946. for(i=0; i<sizeof(aMod)/sizeof(aMod[0]) && rc==SQLITE_OK; i++){
  175947. rc = sqlite3_create_module(db, aMod[i].zName, aMod[i].pModule, 0);
  175948. }
  175949. #endif
  175950. return rc;
  175951. }
  175952. #ifndef SQLITE_CORE
  175953. #ifdef _WIN32
  175954. __declspec(dllexport)
  175955. #endif
  175956. SQLITE_API int sqlite3_json_init(
  175957. sqlite3 *db,
  175958. char **pzErrMsg,
  175959. const sqlite3_api_routines *pApi
  175960. ){
  175961. SQLITE_EXTENSION_INIT2(pApi);
  175962. (void)pzErrMsg; /* Unused parameter */
  175963. return sqlite3Json1Init(db);
  175964. }
  175965. #endif
  175966. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_JSON1) */
  175967. /************** End of json1.c ***********************************************/
  175968. /************** Begin file fts5.c ********************************************/
  175969. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS5)
  175970. #if !defined(NDEBUG) && !defined(SQLITE_DEBUG)
  175971. # define NDEBUG 1
  175972. #endif
  175973. #if defined(NDEBUG) && defined(SQLITE_DEBUG)
  175974. # undef NDEBUG
  175975. #endif
  175976. /*
  175977. ** 2014 May 31
  175978. **
  175979. ** The author disclaims copyright to this source code. In place of
  175980. ** a legal notice, here is a blessing:
  175981. **
  175982. ** May you do good and not evil.
  175983. ** May you find forgiveness for yourself and forgive others.
  175984. ** May you share freely, never taking more than you give.
  175985. **
  175986. ******************************************************************************
  175987. **
  175988. ** Interfaces to extend FTS5. Using the interfaces defined in this file,
  175989. ** FTS5 may be extended with:
  175990. **
  175991. ** * custom tokenizers, and
  175992. ** * custom auxiliary functions.
  175993. */
  175994. #ifndef _FTS5_H
  175995. #define _FTS5_H
  175996. /* #include "sqlite3.h" */
  175997. #if 0
  175998. extern "C" {
  175999. #endif
  176000. /*************************************************************************
  176001. ** CUSTOM AUXILIARY FUNCTIONS
  176002. **
  176003. ** Virtual table implementations may overload SQL functions by implementing
  176004. ** the sqlite3_module.xFindFunction() method.
  176005. */
  176006. typedef struct Fts5ExtensionApi Fts5ExtensionApi;
  176007. typedef struct Fts5Context Fts5Context;
  176008. typedef struct Fts5PhraseIter Fts5PhraseIter;
  176009. typedef void (*fts5_extension_function)(
  176010. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  176011. Fts5Context *pFts, /* First arg to pass to pApi functions */
  176012. sqlite3_context *pCtx, /* Context for returning result/error */
  176013. int nVal, /* Number of values in apVal[] array */
  176014. sqlite3_value **apVal /* Array of trailing arguments */
  176015. );
  176016. struct Fts5PhraseIter {
  176017. const unsigned char *a;
  176018. const unsigned char *b;
  176019. };
  176020. /*
  176021. ** EXTENSION API FUNCTIONS
  176022. **
  176023. ** xUserData(pFts):
  176024. ** Return a copy of the context pointer the extension function was
  176025. ** registered with.
  176026. **
  176027. ** xColumnTotalSize(pFts, iCol, pnToken):
  176028. ** If parameter iCol is less than zero, set output variable *pnToken
  176029. ** to the total number of tokens in the FTS5 table. Or, if iCol is
  176030. ** non-negative but less than the number of columns in the table, return
  176031. ** the total number of tokens in column iCol, considering all rows in
  176032. ** the FTS5 table.
  176033. **
  176034. ** If parameter iCol is greater than or equal to the number of columns
  176035. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  176036. ** an OOM condition or IO error), an appropriate SQLite error code is
  176037. ** returned.
  176038. **
  176039. ** xColumnCount(pFts):
  176040. ** Return the number of columns in the table.
  176041. **
  176042. ** xColumnSize(pFts, iCol, pnToken):
  176043. ** If parameter iCol is less than zero, set output variable *pnToken
  176044. ** to the total number of tokens in the current row. Or, if iCol is
  176045. ** non-negative but less than the number of columns in the table, set
  176046. ** *pnToken to the number of tokens in column iCol of the current row.
  176047. **
  176048. ** If parameter iCol is greater than or equal to the number of columns
  176049. ** in the table, SQLITE_RANGE is returned. Or, if an error occurs (e.g.
  176050. ** an OOM condition or IO error), an appropriate SQLite error code is
  176051. ** returned.
  176052. **
  176053. ** This function may be quite inefficient if used with an FTS5 table
  176054. ** created with the "columnsize=0" option.
  176055. **
  176056. ** xColumnText:
  176057. ** This function attempts to retrieve the text of column iCol of the
  176058. ** current document. If successful, (*pz) is set to point to a buffer
  176059. ** containing the text in utf-8 encoding, (*pn) is set to the size in bytes
  176060. ** (not characters) of the buffer and SQLITE_OK is returned. Otherwise,
  176061. ** if an error occurs, an SQLite error code is returned and the final values
  176062. ** of (*pz) and (*pn) are undefined.
  176063. **
  176064. ** xPhraseCount:
  176065. ** Returns the number of phrases in the current query expression.
  176066. **
  176067. ** xPhraseSize:
  176068. ** Returns the number of tokens in phrase iPhrase of the query. Phrases
  176069. ** are numbered starting from zero.
  176070. **
  176071. ** xInstCount:
  176072. ** Set *pnInst to the total number of occurrences of all phrases within
  176073. ** the query within the current row. Return SQLITE_OK if successful, or
  176074. ** an error code (i.e. SQLITE_NOMEM) if an error occurs.
  176075. **
  176076. ** This API can be quite slow if used with an FTS5 table created with the
  176077. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  176078. ** with either "detail=none" or "detail=column" and "content=" option
  176079. ** (i.e. if it is a contentless table), then this API always returns 0.
  176080. **
  176081. ** xInst:
  176082. ** Query for the details of phrase match iIdx within the current row.
  176083. ** Phrase matches are numbered starting from zero, so the iIdx argument
  176084. ** should be greater than or equal to zero and smaller than the value
  176085. ** output by xInstCount().
  176086. **
  176087. ** Usually, output parameter *piPhrase is set to the phrase number, *piCol
  176088. ** to the column in which it occurs and *piOff the token offset of the
  176089. ** first token of the phrase. The exception is if the table was created
  176090. ** with the offsets=0 option specified. In this case *piOff is always
  176091. ** set to -1.
  176092. **
  176093. ** Returns SQLITE_OK if successful, or an error code (i.e. SQLITE_NOMEM)
  176094. ** if an error occurs.
  176095. **
  176096. ** This API can be quite slow if used with an FTS5 table created with the
  176097. ** "detail=none" or "detail=column" option.
  176098. **
  176099. ** xRowid:
  176100. ** Returns the rowid of the current row.
  176101. **
  176102. ** xTokenize:
  176103. ** Tokenize text using the tokenizer belonging to the FTS5 table.
  176104. **
  176105. ** xQueryPhrase(pFts5, iPhrase, pUserData, xCallback):
  176106. ** This API function is used to query the FTS table for phrase iPhrase
  176107. ** of the current query. Specifically, a query equivalent to:
  176108. **
  176109. ** ... FROM ftstable WHERE ftstable MATCH $p ORDER BY rowid
  176110. **
  176111. ** with $p set to a phrase equivalent to the phrase iPhrase of the
  176112. ** current query is executed. Any column filter that applies to
  176113. ** phrase iPhrase of the current query is included in $p. For each
  176114. ** row visited, the callback function passed as the fourth argument
  176115. ** is invoked. The context and API objects passed to the callback
  176116. ** function may be used to access the properties of each matched row.
  176117. ** Invoking Api.xUserData() returns a copy of the pointer passed as
  176118. ** the third argument to pUserData.
  176119. **
  176120. ** If the callback function returns any value other than SQLITE_OK, the
  176121. ** query is abandoned and the xQueryPhrase function returns immediately.
  176122. ** If the returned value is SQLITE_DONE, xQueryPhrase returns SQLITE_OK.
  176123. ** Otherwise, the error code is propagated upwards.
  176124. **
  176125. ** If the query runs to completion without incident, SQLITE_OK is returned.
  176126. ** Or, if some error occurs before the query completes or is aborted by
  176127. ** the callback, an SQLite error code is returned.
  176128. **
  176129. **
  176130. ** xSetAuxdata(pFts5, pAux, xDelete)
  176131. **
  176132. ** Save the pointer passed as the second argument as the extension functions
  176133. ** "auxiliary data". The pointer may then be retrieved by the current or any
  176134. ** future invocation of the same fts5 extension function made as part of
  176135. ** of the same MATCH query using the xGetAuxdata() API.
  176136. **
  176137. ** Each extension function is allocated a single auxiliary data slot for
  176138. ** each FTS query (MATCH expression). If the extension function is invoked
  176139. ** more than once for a single FTS query, then all invocations share a
  176140. ** single auxiliary data context.
  176141. **
  176142. ** If there is already an auxiliary data pointer when this function is
  176143. ** invoked, then it is replaced by the new pointer. If an xDelete callback
  176144. ** was specified along with the original pointer, it is invoked at this
  176145. ** point.
  176146. **
  176147. ** The xDelete callback, if one is specified, is also invoked on the
  176148. ** auxiliary data pointer after the FTS5 query has finished.
  176149. **
  176150. ** If an error (e.g. an OOM condition) occurs within this function, an
  176151. ** the auxiliary data is set to NULL and an error code returned. If the
  176152. ** xDelete parameter was not NULL, it is invoked on the auxiliary data
  176153. ** pointer before returning.
  176154. **
  176155. **
  176156. ** xGetAuxdata(pFts5, bClear)
  176157. **
  176158. ** Returns the current auxiliary data pointer for the fts5 extension
  176159. ** function. See the xSetAuxdata() method for details.
  176160. **
  176161. ** If the bClear argument is non-zero, then the auxiliary data is cleared
  176162. ** (set to NULL) before this function returns. In this case the xDelete,
  176163. ** if any, is not invoked.
  176164. **
  176165. **
  176166. ** xRowCount(pFts5, pnRow)
  176167. **
  176168. ** This function is used to retrieve the total number of rows in the table.
  176169. ** In other words, the same value that would be returned by:
  176170. **
  176171. ** SELECT count(*) FROM ftstable;
  176172. **
  176173. ** xPhraseFirst()
  176174. ** This function is used, along with type Fts5PhraseIter and the xPhraseNext
  176175. ** method, to iterate through all instances of a single query phrase within
  176176. ** the current row. This is the same information as is accessible via the
  176177. ** xInstCount/xInst APIs. While the xInstCount/xInst APIs are more convenient
  176178. ** to use, this API may be faster under some circumstances. To iterate
  176179. ** through instances of phrase iPhrase, use the following code:
  176180. **
  176181. ** Fts5PhraseIter iter;
  176182. ** int iCol, iOff;
  176183. ** for(pApi->xPhraseFirst(pFts, iPhrase, &iter, &iCol, &iOff);
  176184. ** iCol>=0;
  176185. ** pApi->xPhraseNext(pFts, &iter, &iCol, &iOff)
  176186. ** ){
  176187. ** // An instance of phrase iPhrase at offset iOff of column iCol
  176188. ** }
  176189. **
  176190. ** The Fts5PhraseIter structure is defined above. Applications should not
  176191. ** modify this structure directly - it should only be used as shown above
  176192. ** with the xPhraseFirst() and xPhraseNext() API methods (and by
  176193. ** xPhraseFirstColumn() and xPhraseNextColumn() as illustrated below).
  176194. **
  176195. ** This API can be quite slow if used with an FTS5 table created with the
  176196. ** "detail=none" or "detail=column" option. If the FTS5 table is created
  176197. ** with either "detail=none" or "detail=column" and "content=" option
  176198. ** (i.e. if it is a contentless table), then this API always iterates
  176199. ** through an empty set (all calls to xPhraseFirst() set iCol to -1).
  176200. **
  176201. ** xPhraseNext()
  176202. ** See xPhraseFirst above.
  176203. **
  176204. ** xPhraseFirstColumn()
  176205. ** This function and xPhraseNextColumn() are similar to the xPhraseFirst()
  176206. ** and xPhraseNext() APIs described above. The difference is that instead
  176207. ** of iterating through all instances of a phrase in the current row, these
  176208. ** APIs are used to iterate through the set of columns in the current row
  176209. ** that contain one or more instances of a specified phrase. For example:
  176210. **
  176211. ** Fts5PhraseIter iter;
  176212. ** int iCol;
  176213. ** for(pApi->xPhraseFirstColumn(pFts, iPhrase, &iter, &iCol);
  176214. ** iCol>=0;
  176215. ** pApi->xPhraseNextColumn(pFts, &iter, &iCol)
  176216. ** ){
  176217. ** // Column iCol contains at least one instance of phrase iPhrase
  176218. ** }
  176219. **
  176220. ** This API can be quite slow if used with an FTS5 table created with the
  176221. ** "detail=none" option. If the FTS5 table is created with either
  176222. ** "detail=none" "content=" option (i.e. if it is a contentless table),
  176223. ** then this API always iterates through an empty set (all calls to
  176224. ** xPhraseFirstColumn() set iCol to -1).
  176225. **
  176226. ** The information accessed using this API and its companion
  176227. ** xPhraseFirstColumn() may also be obtained using xPhraseFirst/xPhraseNext
  176228. ** (or xInst/xInstCount). The chief advantage of this API is that it is
  176229. ** significantly more efficient than those alternatives when used with
  176230. ** "detail=column" tables.
  176231. **
  176232. ** xPhraseNextColumn()
  176233. ** See xPhraseFirstColumn above.
  176234. */
  176235. struct Fts5ExtensionApi {
  176236. int iVersion; /* Currently always set to 3 */
  176237. void *(*xUserData)(Fts5Context*);
  176238. int (*xColumnCount)(Fts5Context*);
  176239. int (*xRowCount)(Fts5Context*, sqlite3_int64 *pnRow);
  176240. int (*xColumnTotalSize)(Fts5Context*, int iCol, sqlite3_int64 *pnToken);
  176241. int (*xTokenize)(Fts5Context*,
  176242. const char *pText, int nText, /* Text to tokenize */
  176243. void *pCtx, /* Context passed to xToken() */
  176244. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  176245. );
  176246. int (*xPhraseCount)(Fts5Context*);
  176247. int (*xPhraseSize)(Fts5Context*, int iPhrase);
  176248. int (*xInstCount)(Fts5Context*, int *pnInst);
  176249. int (*xInst)(Fts5Context*, int iIdx, int *piPhrase, int *piCol, int *piOff);
  176250. sqlite3_int64 (*xRowid)(Fts5Context*);
  176251. int (*xColumnText)(Fts5Context*, int iCol, const char **pz, int *pn);
  176252. int (*xColumnSize)(Fts5Context*, int iCol, int *pnToken);
  176253. int (*xQueryPhrase)(Fts5Context*, int iPhrase, void *pUserData,
  176254. int(*)(const Fts5ExtensionApi*,Fts5Context*,void*)
  176255. );
  176256. int (*xSetAuxdata)(Fts5Context*, void *pAux, void(*xDelete)(void*));
  176257. void *(*xGetAuxdata)(Fts5Context*, int bClear);
  176258. int (*xPhraseFirst)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*, int*);
  176259. void (*xPhraseNext)(Fts5Context*, Fts5PhraseIter*, int *piCol, int *piOff);
  176260. int (*xPhraseFirstColumn)(Fts5Context*, int iPhrase, Fts5PhraseIter*, int*);
  176261. void (*xPhraseNextColumn)(Fts5Context*, Fts5PhraseIter*, int *piCol);
  176262. };
  176263. /*
  176264. ** CUSTOM AUXILIARY FUNCTIONS
  176265. *************************************************************************/
  176266. /*************************************************************************
  176267. ** CUSTOM TOKENIZERS
  176268. **
  176269. ** Applications may also register custom tokenizer types. A tokenizer
  176270. ** is registered by providing fts5 with a populated instance of the
  176271. ** following structure. All structure methods must be defined, setting
  176272. ** any member of the fts5_tokenizer struct to NULL leads to undefined
  176273. ** behaviour. The structure methods are expected to function as follows:
  176274. **
  176275. ** xCreate:
  176276. ** This function is used to allocate and initialize a tokenizer instance.
  176277. ** A tokenizer instance is required to actually tokenize text.
  176278. **
  176279. ** The first argument passed to this function is a copy of the (void*)
  176280. ** pointer provided by the application when the fts5_tokenizer object
  176281. ** was registered with FTS5 (the third argument to xCreateTokenizer()).
  176282. ** The second and third arguments are an array of nul-terminated strings
  176283. ** containing the tokenizer arguments, if any, specified following the
  176284. ** tokenizer name as part of the CREATE VIRTUAL TABLE statement used
  176285. ** to create the FTS5 table.
  176286. **
  176287. ** The final argument is an output variable. If successful, (*ppOut)
  176288. ** should be set to point to the new tokenizer handle and SQLITE_OK
  176289. ** returned. If an error occurs, some value other than SQLITE_OK should
  176290. ** be returned. In this case, fts5 assumes that the final value of *ppOut
  176291. ** is undefined.
  176292. **
  176293. ** xDelete:
  176294. ** This function is invoked to delete a tokenizer handle previously
  176295. ** allocated using xCreate(). Fts5 guarantees that this function will
  176296. ** be invoked exactly once for each successful call to xCreate().
  176297. **
  176298. ** xTokenize:
  176299. ** This function is expected to tokenize the nText byte string indicated
  176300. ** by argument pText. pText may or may not be nul-terminated. The first
  176301. ** argument passed to this function is a pointer to an Fts5Tokenizer object
  176302. ** returned by an earlier call to xCreate().
  176303. **
  176304. ** The second argument indicates the reason that FTS5 is requesting
  176305. ** tokenization of the supplied text. This is always one of the following
  176306. ** four values:
  176307. **
  176308. ** <ul><li> <b>FTS5_TOKENIZE_DOCUMENT</b> - A document is being inserted into
  176309. ** or removed from the FTS table. The tokenizer is being invoked to
  176310. ** determine the set of tokens to add to (or delete from) the
  176311. ** FTS index.
  176312. **
  176313. ** <li> <b>FTS5_TOKENIZE_QUERY</b> - A MATCH query is being executed
  176314. ** against the FTS index. The tokenizer is being called to tokenize
  176315. ** a bareword or quoted string specified as part of the query.
  176316. **
  176317. ** <li> <b>(FTS5_TOKENIZE_QUERY | FTS5_TOKENIZE_PREFIX)</b> - Same as
  176318. ** FTS5_TOKENIZE_QUERY, except that the bareword or quoted string is
  176319. ** followed by a "*" character, indicating that the last token
  176320. ** returned by the tokenizer will be treated as a token prefix.
  176321. **
  176322. ** <li> <b>FTS5_TOKENIZE_AUX</b> - The tokenizer is being invoked to
  176323. ** satisfy an fts5_api.xTokenize() request made by an auxiliary
  176324. ** function. Or an fts5_api.xColumnSize() request made by the same
  176325. ** on a columnsize=0 database.
  176326. ** </ul>
  176327. **
  176328. ** For each token in the input string, the supplied callback xToken() must
  176329. ** be invoked. The first argument to it should be a copy of the pointer
  176330. ** passed as the second argument to xTokenize(). The third and fourth
  176331. ** arguments are a pointer to a buffer containing the token text, and the
  176332. ** size of the token in bytes. The 4th and 5th arguments are the byte offsets
  176333. ** of the first byte of and first byte immediately following the text from
  176334. ** which the token is derived within the input.
  176335. **
  176336. ** The second argument passed to the xToken() callback ("tflags") should
  176337. ** normally be set to 0. The exception is if the tokenizer supports
  176338. ** synonyms. In this case see the discussion below for details.
  176339. **
  176340. ** FTS5 assumes the xToken() callback is invoked for each token in the
  176341. ** order that they occur within the input text.
  176342. **
  176343. ** If an xToken() callback returns any value other than SQLITE_OK, then
  176344. ** the tokenization should be abandoned and the xTokenize() method should
  176345. ** immediately return a copy of the xToken() return value. Or, if the
  176346. ** input buffer is exhausted, xTokenize() should return SQLITE_OK. Finally,
  176347. ** if an error occurs with the xTokenize() implementation itself, it
  176348. ** may abandon the tokenization and return any error code other than
  176349. ** SQLITE_OK or SQLITE_DONE.
  176350. **
  176351. ** SYNONYM SUPPORT
  176352. **
  176353. ** Custom tokenizers may also support synonyms. Consider a case in which a
  176354. ** user wishes to query for a phrase such as "first place". Using the
  176355. ** built-in tokenizers, the FTS5 query 'first + place' will match instances
  176356. ** of "first place" within the document set, but not alternative forms
  176357. ** such as "1st place". In some applications, it would be better to match
  176358. ** all instances of "first place" or "1st place" regardless of which form
  176359. ** the user specified in the MATCH query text.
  176360. **
  176361. ** There are several ways to approach this in FTS5:
  176362. **
  176363. ** <ol><li> By mapping all synonyms to a single token. In this case, the
  176364. ** In the above example, this means that the tokenizer returns the
  176365. ** same token for inputs "first" and "1st". Say that token is in
  176366. ** fact "first", so that when the user inserts the document "I won
  176367. ** 1st place" entries are added to the index for tokens "i", "won",
  176368. ** "first" and "place". If the user then queries for '1st + place',
  176369. ** the tokenizer substitutes "first" for "1st" and the query works
  176370. ** as expected.
  176371. **
  176372. ** <li> By adding multiple synonyms for a single term to the FTS index.
  176373. ** In this case, when tokenizing query text, the tokenizer may
  176374. ** provide multiple synonyms for a single term within the document.
  176375. ** FTS5 then queries the index for each synonym individually. For
  176376. ** example, faced with the query:
  176377. **
  176378. ** <codeblock>
  176379. ** ... MATCH 'first place'</codeblock>
  176380. **
  176381. ** the tokenizer offers both "1st" and "first" as synonyms for the
  176382. ** first token in the MATCH query and FTS5 effectively runs a query
  176383. ** similar to:
  176384. **
  176385. ** <codeblock>
  176386. ** ... MATCH '(first OR 1st) place'</codeblock>
  176387. **
  176388. ** except that, for the purposes of auxiliary functions, the query
  176389. ** still appears to contain just two phrases - "(first OR 1st)"
  176390. ** being treated as a single phrase.
  176391. **
  176392. ** <li> By adding multiple synonyms for a single term to the FTS index.
  176393. ** Using this method, when tokenizing document text, the tokenizer
  176394. ** provides multiple synonyms for each token. So that when a
  176395. ** document such as "I won first place" is tokenized, entries are
  176396. ** added to the FTS index for "i", "won", "first", "1st" and
  176397. ** "place".
  176398. **
  176399. ** This way, even if the tokenizer does not provide synonyms
  176400. ** when tokenizing query text (it should not - to do would be
  176401. ** inefficient), it doesn't matter if the user queries for
  176402. ** 'first + place' or '1st + place', as there are entires in the
  176403. ** FTS index corresponding to both forms of the first token.
  176404. ** </ol>
  176405. **
  176406. ** Whether it is parsing document or query text, any call to xToken that
  176407. ** specifies a <i>tflags</i> argument with the FTS5_TOKEN_COLOCATED bit
  176408. ** is considered to supply a synonym for the previous token. For example,
  176409. ** when parsing the document "I won first place", a tokenizer that supports
  176410. ** synonyms would call xToken() 5 times, as follows:
  176411. **
  176412. ** <codeblock>
  176413. ** xToken(pCtx, 0, "i", 1, 0, 1);
  176414. ** xToken(pCtx, 0, "won", 3, 2, 5);
  176415. ** xToken(pCtx, 0, "first", 5, 6, 11);
  176416. ** xToken(pCtx, FTS5_TOKEN_COLOCATED, "1st", 3, 6, 11);
  176417. ** xToken(pCtx, 0, "place", 5, 12, 17);
  176418. **</codeblock>
  176419. **
  176420. ** It is an error to specify the FTS5_TOKEN_COLOCATED flag the first time
  176421. ** xToken() is called. Multiple synonyms may be specified for a single token
  176422. ** by making multiple calls to xToken(FTS5_TOKEN_COLOCATED) in sequence.
  176423. ** There is no limit to the number of synonyms that may be provided for a
  176424. ** single token.
  176425. **
  176426. ** In many cases, method (1) above is the best approach. It does not add
  176427. ** extra data to the FTS index or require FTS5 to query for multiple terms,
  176428. ** so it is efficient in terms of disk space and query speed. However, it
  176429. ** does not support prefix queries very well. If, as suggested above, the
  176430. ** token "first" is subsituted for "1st" by the tokenizer, then the query:
  176431. **
  176432. ** <codeblock>
  176433. ** ... MATCH '1s*'</codeblock>
  176434. **
  176435. ** will not match documents that contain the token "1st" (as the tokenizer
  176436. ** will probably not map "1s" to any prefix of "first").
  176437. **
  176438. ** For full prefix support, method (3) may be preferred. In this case,
  176439. ** because the index contains entries for both "first" and "1st", prefix
  176440. ** queries such as 'fi*' or '1s*' will match correctly. However, because
  176441. ** extra entries are added to the FTS index, this method uses more space
  176442. ** within the database.
  176443. **
  176444. ** Method (2) offers a midpoint between (1) and (3). Using this method,
  176445. ** a query such as '1s*' will match documents that contain the literal
  176446. ** token "1st", but not "first" (assuming the tokenizer is not able to
  176447. ** provide synonyms for prefixes). However, a non-prefix query like '1st'
  176448. ** will match against "1st" and "first". This method does not require
  176449. ** extra disk space, as no extra entries are added to the FTS index.
  176450. ** On the other hand, it may require more CPU cycles to run MATCH queries,
  176451. ** as separate queries of the FTS index are required for each synonym.
  176452. **
  176453. ** When using methods (2) or (3), it is important that the tokenizer only
  176454. ** provide synonyms when tokenizing document text (method (2)) or query
  176455. ** text (method (3)), not both. Doing so will not cause any errors, but is
  176456. ** inefficient.
  176457. */
  176458. typedef struct Fts5Tokenizer Fts5Tokenizer;
  176459. typedef struct fts5_tokenizer fts5_tokenizer;
  176460. struct fts5_tokenizer {
  176461. int (*xCreate)(void*, const char **azArg, int nArg, Fts5Tokenizer **ppOut);
  176462. void (*xDelete)(Fts5Tokenizer*);
  176463. int (*xTokenize)(Fts5Tokenizer*,
  176464. void *pCtx,
  176465. int flags, /* Mask of FTS5_TOKENIZE_* flags */
  176466. const char *pText, int nText,
  176467. int (*xToken)(
  176468. void *pCtx, /* Copy of 2nd argument to xTokenize() */
  176469. int tflags, /* Mask of FTS5_TOKEN_* flags */
  176470. const char *pToken, /* Pointer to buffer containing token */
  176471. int nToken, /* Size of token in bytes */
  176472. int iStart, /* Byte offset of token within input text */
  176473. int iEnd /* Byte offset of end of token within input text */
  176474. )
  176475. );
  176476. };
  176477. /* Flags that may be passed as the third argument to xTokenize() */
  176478. #define FTS5_TOKENIZE_QUERY 0x0001
  176479. #define FTS5_TOKENIZE_PREFIX 0x0002
  176480. #define FTS5_TOKENIZE_DOCUMENT 0x0004
  176481. #define FTS5_TOKENIZE_AUX 0x0008
  176482. /* Flags that may be passed by the tokenizer implementation back to FTS5
  176483. ** as the third argument to the supplied xToken callback. */
  176484. #define FTS5_TOKEN_COLOCATED 0x0001 /* Same position as prev. token */
  176485. /*
  176486. ** END OF CUSTOM TOKENIZERS
  176487. *************************************************************************/
  176488. /*************************************************************************
  176489. ** FTS5 EXTENSION REGISTRATION API
  176490. */
  176491. typedef struct fts5_api fts5_api;
  176492. struct fts5_api {
  176493. int iVersion; /* Currently always set to 2 */
  176494. /* Create a new tokenizer */
  176495. int (*xCreateTokenizer)(
  176496. fts5_api *pApi,
  176497. const char *zName,
  176498. void *pContext,
  176499. fts5_tokenizer *pTokenizer,
  176500. void (*xDestroy)(void*)
  176501. );
  176502. /* Find an existing tokenizer */
  176503. int (*xFindTokenizer)(
  176504. fts5_api *pApi,
  176505. const char *zName,
  176506. void **ppContext,
  176507. fts5_tokenizer *pTokenizer
  176508. );
  176509. /* Create a new auxiliary function */
  176510. int (*xCreateFunction)(
  176511. fts5_api *pApi,
  176512. const char *zName,
  176513. void *pContext,
  176514. fts5_extension_function xFunction,
  176515. void (*xDestroy)(void*)
  176516. );
  176517. };
  176518. /*
  176519. ** END OF REGISTRATION API
  176520. *************************************************************************/
  176521. #if 0
  176522. } /* end of the 'extern "C"' block */
  176523. #endif
  176524. #endif /* _FTS5_H */
  176525. /*
  176526. ** 2014 May 31
  176527. **
  176528. ** The author disclaims copyright to this source code. In place of
  176529. ** a legal notice, here is a blessing:
  176530. **
  176531. ** May you do good and not evil.
  176532. ** May you find forgiveness for yourself and forgive others.
  176533. ** May you share freely, never taking more than you give.
  176534. **
  176535. ******************************************************************************
  176536. **
  176537. */
  176538. #ifndef _FTS5INT_H
  176539. #define _FTS5INT_H
  176540. /* #include "fts5.h" */
  176541. /* #include "sqlite3ext.h" */
  176542. SQLITE_EXTENSION_INIT1
  176543. /* #include <string.h> */
  176544. /* #include <assert.h> */
  176545. #ifndef SQLITE_AMALGAMATION
  176546. typedef unsigned char u8;
  176547. typedef unsigned int u32;
  176548. typedef unsigned short u16;
  176549. typedef short i16;
  176550. typedef sqlite3_int64 i64;
  176551. typedef sqlite3_uint64 u64;
  176552. #ifndef ArraySize
  176553. # define ArraySize(x) ((int)(sizeof(x) / sizeof(x[0])))
  176554. #endif
  176555. #define testcase(x)
  176556. #define ALWAYS(x) 1
  176557. #define NEVER(x) 0
  176558. #define MIN(x,y) (((x) < (y)) ? (x) : (y))
  176559. #define MAX(x,y) (((x) > (y)) ? (x) : (y))
  176560. /*
  176561. ** Constants for the largest and smallest possible 64-bit signed integers.
  176562. */
  176563. # define LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
  176564. # define SMALLEST_INT64 (((i64)-1) - LARGEST_INT64)
  176565. #endif
  176566. /* Truncate very long tokens to this many bytes. Hard limit is
  176567. ** (65536-1-1-4-9)==65521 bytes. The limiting factor is the 16-bit offset
  176568. ** field that occurs at the start of each leaf page (see fts5_index.c). */
  176569. #define FTS5_MAX_TOKEN_SIZE 32768
  176570. /*
  176571. ** Maximum number of prefix indexes on single FTS5 table. This must be
  176572. ** less than 32. If it is set to anything large than that, an #error
  176573. ** directive in fts5_index.c will cause the build to fail.
  176574. */
  176575. #define FTS5_MAX_PREFIX_INDEXES 31
  176576. #define FTS5_DEFAULT_NEARDIST 10
  176577. #define FTS5_DEFAULT_RANK "bm25"
  176578. /* Name of rank and rowid columns */
  176579. #define FTS5_RANK_NAME "rank"
  176580. #define FTS5_ROWID_NAME "rowid"
  176581. #ifdef SQLITE_DEBUG
  176582. # define FTS5_CORRUPT sqlite3Fts5Corrupt()
  176583. static int sqlite3Fts5Corrupt(void);
  176584. #else
  176585. # define FTS5_CORRUPT SQLITE_CORRUPT_VTAB
  176586. #endif
  176587. /*
  176588. ** The assert_nc() macro is similar to the assert() macro, except that it
  176589. ** is used for assert() conditions that are true only if it can be
  176590. ** guranteed that the database is not corrupt.
  176591. */
  176592. #ifdef SQLITE_DEBUG
  176593. SQLITE_API extern int sqlite3_fts5_may_be_corrupt;
  176594. # define assert_nc(x) assert(sqlite3_fts5_may_be_corrupt || (x))
  176595. #else
  176596. # define assert_nc(x) assert(x)
  176597. #endif
  176598. /* Mark a function parameter as unused, to suppress nuisance compiler
  176599. ** warnings. */
  176600. #ifndef UNUSED_PARAM
  176601. # define UNUSED_PARAM(X) (void)(X)
  176602. #endif
  176603. #ifndef UNUSED_PARAM2
  176604. # define UNUSED_PARAM2(X, Y) (void)(X), (void)(Y)
  176605. #endif
  176606. typedef struct Fts5Global Fts5Global;
  176607. typedef struct Fts5Colset Fts5Colset;
  176608. /* If a NEAR() clump or phrase may only match a specific set of columns,
  176609. ** then an object of the following type is used to record the set of columns.
  176610. ** Each entry in the aiCol[] array is a column that may be matched.
  176611. **
  176612. ** This object is used by fts5_expr.c and fts5_index.c.
  176613. */
  176614. struct Fts5Colset {
  176615. int nCol;
  176616. int aiCol[1];
  176617. };
  176618. /**************************************************************************
  176619. ** Interface to code in fts5_config.c. fts5_config.c contains contains code
  176620. ** to parse the arguments passed to the CREATE VIRTUAL TABLE statement.
  176621. */
  176622. typedef struct Fts5Config Fts5Config;
  176623. /*
  176624. ** An instance of the following structure encodes all information that can
  176625. ** be gleaned from the CREATE VIRTUAL TABLE statement.
  176626. **
  176627. ** And all information loaded from the %_config table.
  176628. **
  176629. ** nAutomerge:
  176630. ** The minimum number of segments that an auto-merge operation should
  176631. ** attempt to merge together. A value of 1 sets the object to use the
  176632. ** compile time default. Zero disables auto-merge altogether.
  176633. **
  176634. ** zContent:
  176635. **
  176636. ** zContentRowid:
  176637. ** The value of the content_rowid= option, if one was specified. Or
  176638. ** the string "rowid" otherwise. This text is not quoted - if it is
  176639. ** used as part of an SQL statement it needs to be quoted appropriately.
  176640. **
  176641. ** zContentExprlist:
  176642. **
  176643. ** pzErrmsg:
  176644. ** This exists in order to allow the fts5_index.c module to return a
  176645. ** decent error message if it encounters a file-format version it does
  176646. ** not understand.
  176647. **
  176648. ** bColumnsize:
  176649. ** True if the %_docsize table is created.
  176650. **
  176651. ** bPrefixIndex:
  176652. ** This is only used for debugging. If set to false, any prefix indexes
  176653. ** are ignored. This value is configured using:
  176654. **
  176655. ** INSERT INTO tbl(tbl, rank) VALUES('prefix-index', $bPrefixIndex);
  176656. **
  176657. */
  176658. struct Fts5Config {
  176659. sqlite3 *db; /* Database handle */
  176660. char *zDb; /* Database holding FTS index (e.g. "main") */
  176661. char *zName; /* Name of FTS index */
  176662. int nCol; /* Number of columns */
  176663. char **azCol; /* Column names */
  176664. u8 *abUnindexed; /* True for unindexed columns */
  176665. int nPrefix; /* Number of prefix indexes */
  176666. int *aPrefix; /* Sizes in bytes of nPrefix prefix indexes */
  176667. int eContent; /* An FTS5_CONTENT value */
  176668. char *zContent; /* content table */
  176669. char *zContentRowid; /* "content_rowid=" option value */
  176670. int bColumnsize; /* "columnsize=" option value (dflt==1) */
  176671. int eDetail; /* FTS5_DETAIL_XXX value */
  176672. char *zContentExprlist;
  176673. Fts5Tokenizer *pTok;
  176674. fts5_tokenizer *pTokApi;
  176675. /* Values loaded from the %_config table */
  176676. int iCookie; /* Incremented when %_config is modified */
  176677. int pgsz; /* Approximate page size used in %_data */
  176678. int nAutomerge; /* 'automerge' setting */
  176679. int nCrisisMerge; /* Maximum allowed segments per level */
  176680. int nUsermerge; /* 'usermerge' setting */
  176681. int nHashSize; /* Bytes of memory for in-memory hash */
  176682. char *zRank; /* Name of rank function */
  176683. char *zRankArgs; /* Arguments to rank function */
  176684. /* If non-NULL, points to sqlite3_vtab.base.zErrmsg. Often NULL. */
  176685. char **pzErrmsg;
  176686. #ifdef SQLITE_DEBUG
  176687. int bPrefixIndex; /* True to use prefix-indexes */
  176688. #endif
  176689. };
  176690. /* Current expected value of %_config table 'version' field */
  176691. #define FTS5_CURRENT_VERSION 4
  176692. #define FTS5_CONTENT_NORMAL 0
  176693. #define FTS5_CONTENT_NONE 1
  176694. #define FTS5_CONTENT_EXTERNAL 2
  176695. #define FTS5_DETAIL_FULL 0
  176696. #define FTS5_DETAIL_NONE 1
  176697. #define FTS5_DETAIL_COLUMNS 2
  176698. static int sqlite3Fts5ConfigParse(
  176699. Fts5Global*, sqlite3*, int, const char **, Fts5Config**, char**
  176700. );
  176701. static void sqlite3Fts5ConfigFree(Fts5Config*);
  176702. static int sqlite3Fts5ConfigDeclareVtab(Fts5Config *pConfig);
  176703. static int sqlite3Fts5Tokenize(
  176704. Fts5Config *pConfig, /* FTS5 Configuration object */
  176705. int flags, /* FTS5_TOKENIZE_* flags */
  176706. const char *pText, int nText, /* Text to tokenize */
  176707. void *pCtx, /* Context passed to xToken() */
  176708. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  176709. );
  176710. static void sqlite3Fts5Dequote(char *z);
  176711. /* Load the contents of the %_config table */
  176712. static int sqlite3Fts5ConfigLoad(Fts5Config*, int);
  176713. /* Set the value of a single config attribute */
  176714. static int sqlite3Fts5ConfigSetValue(Fts5Config*, const char*, sqlite3_value*, int*);
  176715. static int sqlite3Fts5ConfigParseRank(const char*, char**, char**);
  176716. /*
  176717. ** End of interface to code in fts5_config.c.
  176718. **************************************************************************/
  176719. /**************************************************************************
  176720. ** Interface to code in fts5_buffer.c.
  176721. */
  176722. /*
  176723. ** Buffer object for the incremental building of string data.
  176724. */
  176725. typedef struct Fts5Buffer Fts5Buffer;
  176726. struct Fts5Buffer {
  176727. u8 *p;
  176728. int n;
  176729. int nSpace;
  176730. };
  176731. static int sqlite3Fts5BufferSize(int*, Fts5Buffer*, u32);
  176732. static void sqlite3Fts5BufferAppendVarint(int*, Fts5Buffer*, i64);
  176733. static void sqlite3Fts5BufferAppendBlob(int*, Fts5Buffer*, u32, const u8*);
  176734. static void sqlite3Fts5BufferAppendString(int *, Fts5Buffer*, const char*);
  176735. static void sqlite3Fts5BufferFree(Fts5Buffer*);
  176736. static void sqlite3Fts5BufferZero(Fts5Buffer*);
  176737. static void sqlite3Fts5BufferSet(int*, Fts5Buffer*, int, const u8*);
  176738. static void sqlite3Fts5BufferAppendPrintf(int *, Fts5Buffer*, char *zFmt, ...);
  176739. static char *sqlite3Fts5Mprintf(int *pRc, const char *zFmt, ...);
  176740. #define fts5BufferZero(x) sqlite3Fts5BufferZero(x)
  176741. #define fts5BufferAppendVarint(a,b,c) sqlite3Fts5BufferAppendVarint(a,b,c)
  176742. #define fts5BufferFree(a) sqlite3Fts5BufferFree(a)
  176743. #define fts5BufferAppendBlob(a,b,c,d) sqlite3Fts5BufferAppendBlob(a,b,c,d)
  176744. #define fts5BufferSet(a,b,c,d) sqlite3Fts5BufferSet(a,b,c,d)
  176745. #define fts5BufferGrow(pRc,pBuf,nn) ( \
  176746. (u32)((pBuf)->n) + (u32)(nn) <= (u32)((pBuf)->nSpace) ? 0 : \
  176747. sqlite3Fts5BufferSize((pRc),(pBuf),(nn)+(pBuf)->n) \
  176748. )
  176749. /* Write and decode big-endian 32-bit integer values */
  176750. static void sqlite3Fts5Put32(u8*, int);
  176751. static int sqlite3Fts5Get32(const u8*);
  176752. #define FTS5_POS2COLUMN(iPos) (int)(iPos >> 32)
  176753. #define FTS5_POS2OFFSET(iPos) (int)(iPos & 0xFFFFFFFF)
  176754. typedef struct Fts5PoslistReader Fts5PoslistReader;
  176755. struct Fts5PoslistReader {
  176756. /* Variables used only by sqlite3Fts5PoslistIterXXX() functions. */
  176757. const u8 *a; /* Position list to iterate through */
  176758. int n; /* Size of buffer at a[] in bytes */
  176759. int i; /* Current offset in a[] */
  176760. u8 bFlag; /* For client use (any custom purpose) */
  176761. /* Output variables */
  176762. u8 bEof; /* Set to true at EOF */
  176763. i64 iPos; /* (iCol<<32) + iPos */
  176764. };
  176765. static int sqlite3Fts5PoslistReaderInit(
  176766. const u8 *a, int n, /* Poslist buffer to iterate through */
  176767. Fts5PoslistReader *pIter /* Iterator object to initialize */
  176768. );
  176769. static int sqlite3Fts5PoslistReaderNext(Fts5PoslistReader*);
  176770. typedef struct Fts5PoslistWriter Fts5PoslistWriter;
  176771. struct Fts5PoslistWriter {
  176772. i64 iPrev;
  176773. };
  176774. static int sqlite3Fts5PoslistWriterAppend(Fts5Buffer*, Fts5PoslistWriter*, i64);
  176775. static void sqlite3Fts5PoslistSafeAppend(Fts5Buffer*, i64*, i64);
  176776. static int sqlite3Fts5PoslistNext64(
  176777. const u8 *a, int n, /* Buffer containing poslist */
  176778. int *pi, /* IN/OUT: Offset within a[] */
  176779. i64 *piOff /* IN/OUT: Current offset */
  176780. );
  176781. /* Malloc utility */
  176782. static void *sqlite3Fts5MallocZero(int *pRc, int nByte);
  176783. static char *sqlite3Fts5Strndup(int *pRc, const char *pIn, int nIn);
  176784. /* Character set tests (like isspace(), isalpha() etc.) */
  176785. static int sqlite3Fts5IsBareword(char t);
  176786. /* Bucket of terms object used by the integrity-check in offsets=0 mode. */
  176787. typedef struct Fts5Termset Fts5Termset;
  176788. static int sqlite3Fts5TermsetNew(Fts5Termset**);
  176789. static int sqlite3Fts5TermsetAdd(Fts5Termset*, int, const char*, int, int *pbPresent);
  176790. static void sqlite3Fts5TermsetFree(Fts5Termset*);
  176791. /*
  176792. ** End of interface to code in fts5_buffer.c.
  176793. **************************************************************************/
  176794. /**************************************************************************
  176795. ** Interface to code in fts5_index.c. fts5_index.c contains contains code
  176796. ** to access the data stored in the %_data table.
  176797. */
  176798. typedef struct Fts5Index Fts5Index;
  176799. typedef struct Fts5IndexIter Fts5IndexIter;
  176800. struct Fts5IndexIter {
  176801. i64 iRowid;
  176802. const u8 *pData;
  176803. int nData;
  176804. u8 bEof;
  176805. };
  176806. #define sqlite3Fts5IterEof(x) ((x)->bEof)
  176807. /*
  176808. ** Values used as part of the flags argument passed to IndexQuery().
  176809. */
  176810. #define FTS5INDEX_QUERY_PREFIX 0x0001 /* Prefix query */
  176811. #define FTS5INDEX_QUERY_DESC 0x0002 /* Docs in descending rowid order */
  176812. #define FTS5INDEX_QUERY_TEST_NOIDX 0x0004 /* Do not use prefix index */
  176813. #define FTS5INDEX_QUERY_SCAN 0x0008 /* Scan query (fts5vocab) */
  176814. /* The following are used internally by the fts5_index.c module. They are
  176815. ** defined here only to make it easier to avoid clashes with the flags
  176816. ** above. */
  176817. #define FTS5INDEX_QUERY_SKIPEMPTY 0x0010
  176818. #define FTS5INDEX_QUERY_NOOUTPUT 0x0020
  176819. /*
  176820. ** Create/destroy an Fts5Index object.
  176821. */
  176822. static int sqlite3Fts5IndexOpen(Fts5Config *pConfig, int bCreate, Fts5Index**, char**);
  176823. static int sqlite3Fts5IndexClose(Fts5Index *p);
  176824. /*
  176825. ** Return a simple checksum value based on the arguments.
  176826. */
  176827. static u64 sqlite3Fts5IndexEntryCksum(
  176828. i64 iRowid,
  176829. int iCol,
  176830. int iPos,
  176831. int iIdx,
  176832. const char *pTerm,
  176833. int nTerm
  176834. );
  176835. /*
  176836. ** Argument p points to a buffer containing utf-8 text that is n bytes in
  176837. ** size. Return the number of bytes in the nChar character prefix of the
  176838. ** buffer, or 0 if there are less than nChar characters in total.
  176839. */
  176840. static int sqlite3Fts5IndexCharlenToBytelen(
  176841. const char *p,
  176842. int nByte,
  176843. int nChar
  176844. );
  176845. /*
  176846. ** Open a new iterator to iterate though all rowids that match the
  176847. ** specified token or token prefix.
  176848. */
  176849. static int sqlite3Fts5IndexQuery(
  176850. Fts5Index *p, /* FTS index to query */
  176851. const char *pToken, int nToken, /* Token (or prefix) to query for */
  176852. int flags, /* Mask of FTS5INDEX_QUERY_X flags */
  176853. Fts5Colset *pColset, /* Match these columns only */
  176854. Fts5IndexIter **ppIter /* OUT: New iterator object */
  176855. );
  176856. /*
  176857. ** The various operations on open token or token prefix iterators opened
  176858. ** using sqlite3Fts5IndexQuery().
  176859. */
  176860. static int sqlite3Fts5IterNext(Fts5IndexIter*);
  176861. static int sqlite3Fts5IterNextFrom(Fts5IndexIter*, i64 iMatch);
  176862. /*
  176863. ** Close an iterator opened by sqlite3Fts5IndexQuery().
  176864. */
  176865. static void sqlite3Fts5IterClose(Fts5IndexIter*);
  176866. /*
  176867. ** This interface is used by the fts5vocab module.
  176868. */
  176869. static const char *sqlite3Fts5IterTerm(Fts5IndexIter*, int*);
  176870. static int sqlite3Fts5IterNextScan(Fts5IndexIter*);
  176871. /*
  176872. ** Insert or remove data to or from the index. Each time a document is
  176873. ** added to or removed from the index, this function is called one or more
  176874. ** times.
  176875. **
  176876. ** For an insert, it must be called once for each token in the new document.
  176877. ** If the operation is a delete, it must be called (at least) once for each
  176878. ** unique token in the document with an iCol value less than zero. The iPos
  176879. ** argument is ignored for a delete.
  176880. */
  176881. static int sqlite3Fts5IndexWrite(
  176882. Fts5Index *p, /* Index to write to */
  176883. int iCol, /* Column token appears in (-ve -> delete) */
  176884. int iPos, /* Position of token within column */
  176885. const char *pToken, int nToken /* Token to add or remove to or from index */
  176886. );
  176887. /*
  176888. ** Indicate that subsequent calls to sqlite3Fts5IndexWrite() pertain to
  176889. ** document iDocid.
  176890. */
  176891. static int sqlite3Fts5IndexBeginWrite(
  176892. Fts5Index *p, /* Index to write to */
  176893. int bDelete, /* True if current operation is a delete */
  176894. i64 iDocid /* Docid to add or remove data from */
  176895. );
  176896. /*
  176897. ** Flush any data stored in the in-memory hash tables to the database.
  176898. ** Also close any open blob handles.
  176899. */
  176900. static int sqlite3Fts5IndexSync(Fts5Index *p);
  176901. /*
  176902. ** Discard any data stored in the in-memory hash tables. Do not write it
  176903. ** to the database. Additionally, assume that the contents of the %_data
  176904. ** table may have changed on disk. So any in-memory caches of %_data
  176905. ** records must be invalidated.
  176906. */
  176907. static int sqlite3Fts5IndexRollback(Fts5Index *p);
  176908. /*
  176909. ** Get or set the "averages" values.
  176910. */
  176911. static int sqlite3Fts5IndexGetAverages(Fts5Index *p, i64 *pnRow, i64 *anSize);
  176912. static int sqlite3Fts5IndexSetAverages(Fts5Index *p, const u8*, int);
  176913. /*
  176914. ** Functions called by the storage module as part of integrity-check.
  176915. */
  176916. static int sqlite3Fts5IndexIntegrityCheck(Fts5Index*, u64 cksum);
  176917. /*
  176918. ** Called during virtual module initialization to register UDF
  176919. ** fts5_decode() with SQLite
  176920. */
  176921. static int sqlite3Fts5IndexInit(sqlite3*);
  176922. static int sqlite3Fts5IndexSetCookie(Fts5Index*, int);
  176923. /*
  176924. ** Return the total number of entries read from the %_data table by
  176925. ** this connection since it was created.
  176926. */
  176927. static int sqlite3Fts5IndexReads(Fts5Index *p);
  176928. static int sqlite3Fts5IndexReinit(Fts5Index *p);
  176929. static int sqlite3Fts5IndexOptimize(Fts5Index *p);
  176930. static int sqlite3Fts5IndexMerge(Fts5Index *p, int nMerge);
  176931. static int sqlite3Fts5IndexReset(Fts5Index *p);
  176932. static int sqlite3Fts5IndexLoadConfig(Fts5Index *p);
  176933. /*
  176934. ** End of interface to code in fts5_index.c.
  176935. **************************************************************************/
  176936. /**************************************************************************
  176937. ** Interface to code in fts5_varint.c.
  176938. */
  176939. static int sqlite3Fts5GetVarint32(const unsigned char *p, u32 *v);
  176940. static int sqlite3Fts5GetVarintLen(u32 iVal);
  176941. static u8 sqlite3Fts5GetVarint(const unsigned char*, u64*);
  176942. static int sqlite3Fts5PutVarint(unsigned char *p, u64 v);
  176943. #define fts5GetVarint32(a,b) sqlite3Fts5GetVarint32(a,(u32*)&b)
  176944. #define fts5GetVarint sqlite3Fts5GetVarint
  176945. #define fts5FastGetVarint32(a, iOff, nVal) { \
  176946. nVal = (a)[iOff++]; \
  176947. if( nVal & 0x80 ){ \
  176948. iOff--; \
  176949. iOff += fts5GetVarint32(&(a)[iOff], nVal); \
  176950. } \
  176951. }
  176952. /*
  176953. ** End of interface to code in fts5_varint.c.
  176954. **************************************************************************/
  176955. /**************************************************************************
  176956. ** Interface to code in fts5.c.
  176957. */
  176958. static int sqlite3Fts5GetTokenizer(
  176959. Fts5Global*,
  176960. const char **azArg,
  176961. int nArg,
  176962. Fts5Tokenizer**,
  176963. fts5_tokenizer**,
  176964. char **pzErr
  176965. );
  176966. static Fts5Index *sqlite3Fts5IndexFromCsrid(Fts5Global*, i64, Fts5Config **);
  176967. /*
  176968. ** End of interface to code in fts5.c.
  176969. **************************************************************************/
  176970. /**************************************************************************
  176971. ** Interface to code in fts5_hash.c.
  176972. */
  176973. typedef struct Fts5Hash Fts5Hash;
  176974. /*
  176975. ** Create a hash table, free a hash table.
  176976. */
  176977. static int sqlite3Fts5HashNew(Fts5Config*, Fts5Hash**, int *pnSize);
  176978. static void sqlite3Fts5HashFree(Fts5Hash*);
  176979. static int sqlite3Fts5HashWrite(
  176980. Fts5Hash*,
  176981. i64 iRowid, /* Rowid for this entry */
  176982. int iCol, /* Column token appears in (-ve -> delete) */
  176983. int iPos, /* Position of token within column */
  176984. char bByte,
  176985. const char *pToken, int nToken /* Token to add or remove to or from index */
  176986. );
  176987. /*
  176988. ** Empty (but do not delete) a hash table.
  176989. */
  176990. static void sqlite3Fts5HashClear(Fts5Hash*);
  176991. static int sqlite3Fts5HashQuery(
  176992. Fts5Hash*, /* Hash table to query */
  176993. const char *pTerm, int nTerm, /* Query term */
  176994. const u8 **ppDoclist, /* OUT: Pointer to doclist for pTerm */
  176995. int *pnDoclist /* OUT: Size of doclist in bytes */
  176996. );
  176997. static int sqlite3Fts5HashScanInit(
  176998. Fts5Hash*, /* Hash table to query */
  176999. const char *pTerm, int nTerm /* Query prefix */
  177000. );
  177001. static void sqlite3Fts5HashScanNext(Fts5Hash*);
  177002. static int sqlite3Fts5HashScanEof(Fts5Hash*);
  177003. static void sqlite3Fts5HashScanEntry(Fts5Hash *,
  177004. const char **pzTerm, /* OUT: term (nul-terminated) */
  177005. const u8 **ppDoclist, /* OUT: pointer to doclist */
  177006. int *pnDoclist /* OUT: size of doclist in bytes */
  177007. );
  177008. /*
  177009. ** End of interface to code in fts5_hash.c.
  177010. **************************************************************************/
  177011. /**************************************************************************
  177012. ** Interface to code in fts5_storage.c. fts5_storage.c contains contains
  177013. ** code to access the data stored in the %_content and %_docsize tables.
  177014. */
  177015. #define FTS5_STMT_SCAN_ASC 0 /* SELECT rowid, * FROM ... ORDER BY 1 ASC */
  177016. #define FTS5_STMT_SCAN_DESC 1 /* SELECT rowid, * FROM ... ORDER BY 1 DESC */
  177017. #define FTS5_STMT_LOOKUP 2 /* SELECT rowid, * FROM ... WHERE rowid=? */
  177018. typedef struct Fts5Storage Fts5Storage;
  177019. static int sqlite3Fts5StorageOpen(Fts5Config*, Fts5Index*, int, Fts5Storage**, char**);
  177020. static int sqlite3Fts5StorageClose(Fts5Storage *p);
  177021. static int sqlite3Fts5StorageRename(Fts5Storage*, const char *zName);
  177022. static int sqlite3Fts5DropAll(Fts5Config*);
  177023. static int sqlite3Fts5CreateTable(Fts5Config*, const char*, const char*, int, char **);
  177024. static int sqlite3Fts5StorageDelete(Fts5Storage *p, i64, sqlite3_value**);
  177025. static int sqlite3Fts5StorageContentInsert(Fts5Storage *p, sqlite3_value**, i64*);
  177026. static int sqlite3Fts5StorageIndexInsert(Fts5Storage *p, sqlite3_value**, i64);
  177027. static int sqlite3Fts5StorageIntegrity(Fts5Storage *p);
  177028. static int sqlite3Fts5StorageStmt(Fts5Storage *p, int eStmt, sqlite3_stmt**, char**);
  177029. static void sqlite3Fts5StorageStmtRelease(Fts5Storage *p, int eStmt, sqlite3_stmt*);
  177030. static int sqlite3Fts5StorageDocsize(Fts5Storage *p, i64 iRowid, int *aCol);
  177031. static int sqlite3Fts5StorageSize(Fts5Storage *p, int iCol, i64 *pnAvg);
  177032. static int sqlite3Fts5StorageRowCount(Fts5Storage *p, i64 *pnRow);
  177033. static int sqlite3Fts5StorageSync(Fts5Storage *p);
  177034. static int sqlite3Fts5StorageRollback(Fts5Storage *p);
  177035. static int sqlite3Fts5StorageConfigValue(
  177036. Fts5Storage *p, const char*, sqlite3_value*, int
  177037. );
  177038. static int sqlite3Fts5StorageDeleteAll(Fts5Storage *p);
  177039. static int sqlite3Fts5StorageRebuild(Fts5Storage *p);
  177040. static int sqlite3Fts5StorageOptimize(Fts5Storage *p);
  177041. static int sqlite3Fts5StorageMerge(Fts5Storage *p, int nMerge);
  177042. static int sqlite3Fts5StorageReset(Fts5Storage *p);
  177043. /*
  177044. ** End of interface to code in fts5_storage.c.
  177045. **************************************************************************/
  177046. /**************************************************************************
  177047. ** Interface to code in fts5_expr.c.
  177048. */
  177049. typedef struct Fts5Expr Fts5Expr;
  177050. typedef struct Fts5ExprNode Fts5ExprNode;
  177051. typedef struct Fts5Parse Fts5Parse;
  177052. typedef struct Fts5Token Fts5Token;
  177053. typedef struct Fts5ExprPhrase Fts5ExprPhrase;
  177054. typedef struct Fts5ExprNearset Fts5ExprNearset;
  177055. struct Fts5Token {
  177056. const char *p; /* Token text (not NULL terminated) */
  177057. int n; /* Size of buffer p in bytes */
  177058. };
  177059. /* Parse a MATCH expression. */
  177060. static int sqlite3Fts5ExprNew(
  177061. Fts5Config *pConfig,
  177062. int iCol, /* Column on LHS of MATCH operator */
  177063. const char *zExpr,
  177064. Fts5Expr **ppNew,
  177065. char **pzErr
  177066. );
  177067. /*
  177068. ** for(rc = sqlite3Fts5ExprFirst(pExpr, pIdx, bDesc);
  177069. ** rc==SQLITE_OK && 0==sqlite3Fts5ExprEof(pExpr);
  177070. ** rc = sqlite3Fts5ExprNext(pExpr)
  177071. ** ){
  177072. ** // The document with rowid iRowid matches the expression!
  177073. ** i64 iRowid = sqlite3Fts5ExprRowid(pExpr);
  177074. ** }
  177075. */
  177076. static int sqlite3Fts5ExprFirst(Fts5Expr*, Fts5Index *pIdx, i64 iMin, int bDesc);
  177077. static int sqlite3Fts5ExprNext(Fts5Expr*, i64 iMax);
  177078. static int sqlite3Fts5ExprEof(Fts5Expr*);
  177079. static i64 sqlite3Fts5ExprRowid(Fts5Expr*);
  177080. static void sqlite3Fts5ExprFree(Fts5Expr*);
  177081. /* Called during startup to register a UDF with SQLite */
  177082. static int sqlite3Fts5ExprInit(Fts5Global*, sqlite3*);
  177083. static int sqlite3Fts5ExprPhraseCount(Fts5Expr*);
  177084. static int sqlite3Fts5ExprPhraseSize(Fts5Expr*, int iPhrase);
  177085. static int sqlite3Fts5ExprPoslist(Fts5Expr*, int, const u8 **);
  177086. typedef struct Fts5PoslistPopulator Fts5PoslistPopulator;
  177087. static Fts5PoslistPopulator *sqlite3Fts5ExprClearPoslists(Fts5Expr*, int);
  177088. static int sqlite3Fts5ExprPopulatePoslists(
  177089. Fts5Config*, Fts5Expr*, Fts5PoslistPopulator*, int, const char*, int
  177090. );
  177091. static void sqlite3Fts5ExprCheckPoslists(Fts5Expr*, i64);
  177092. static int sqlite3Fts5ExprClonePhrase(Fts5Expr*, int, Fts5Expr**);
  177093. static int sqlite3Fts5ExprPhraseCollist(Fts5Expr *, int, const u8 **, int *);
  177094. /*******************************************
  177095. ** The fts5_expr.c API above this point is used by the other hand-written
  177096. ** C code in this module. The interfaces below this point are called by
  177097. ** the parser code in fts5parse.y. */
  177098. static void sqlite3Fts5ParseError(Fts5Parse *pParse, const char *zFmt, ...);
  177099. static Fts5ExprNode *sqlite3Fts5ParseNode(
  177100. Fts5Parse *pParse,
  177101. int eType,
  177102. Fts5ExprNode *pLeft,
  177103. Fts5ExprNode *pRight,
  177104. Fts5ExprNearset *pNear
  177105. );
  177106. static Fts5ExprNode *sqlite3Fts5ParseImplicitAnd(
  177107. Fts5Parse *pParse,
  177108. Fts5ExprNode *pLeft,
  177109. Fts5ExprNode *pRight
  177110. );
  177111. static Fts5ExprPhrase *sqlite3Fts5ParseTerm(
  177112. Fts5Parse *pParse,
  177113. Fts5ExprPhrase *pPhrase,
  177114. Fts5Token *pToken,
  177115. int bPrefix
  177116. );
  177117. static void sqlite3Fts5ParseSetCaret(Fts5ExprPhrase*);
  177118. static Fts5ExprNearset *sqlite3Fts5ParseNearset(
  177119. Fts5Parse*,
  177120. Fts5ExprNearset*,
  177121. Fts5ExprPhrase*
  177122. );
  177123. static Fts5Colset *sqlite3Fts5ParseColset(
  177124. Fts5Parse*,
  177125. Fts5Colset*,
  177126. Fts5Token *
  177127. );
  177128. static void sqlite3Fts5ParsePhraseFree(Fts5ExprPhrase*);
  177129. static void sqlite3Fts5ParseNearsetFree(Fts5ExprNearset*);
  177130. static void sqlite3Fts5ParseNodeFree(Fts5ExprNode*);
  177131. static void sqlite3Fts5ParseSetDistance(Fts5Parse*, Fts5ExprNearset*, Fts5Token*);
  177132. static void sqlite3Fts5ParseSetColset(Fts5Parse*, Fts5ExprNode*, Fts5Colset*);
  177133. static Fts5Colset *sqlite3Fts5ParseColsetInvert(Fts5Parse*, Fts5Colset*);
  177134. static void sqlite3Fts5ParseFinished(Fts5Parse *pParse, Fts5ExprNode *p);
  177135. static void sqlite3Fts5ParseNear(Fts5Parse *pParse, Fts5Token*);
  177136. /*
  177137. ** End of interface to code in fts5_expr.c.
  177138. **************************************************************************/
  177139. /**************************************************************************
  177140. ** Interface to code in fts5_aux.c.
  177141. */
  177142. static int sqlite3Fts5AuxInit(fts5_api*);
  177143. /*
  177144. ** End of interface to code in fts5_aux.c.
  177145. **************************************************************************/
  177146. /**************************************************************************
  177147. ** Interface to code in fts5_tokenizer.c.
  177148. */
  177149. static int sqlite3Fts5TokenizerInit(fts5_api*);
  177150. /*
  177151. ** End of interface to code in fts5_tokenizer.c.
  177152. **************************************************************************/
  177153. /**************************************************************************
  177154. ** Interface to code in fts5_vocab.c.
  177155. */
  177156. static int sqlite3Fts5VocabInit(Fts5Global*, sqlite3*);
  177157. /*
  177158. ** End of interface to code in fts5_vocab.c.
  177159. **************************************************************************/
  177160. /**************************************************************************
  177161. ** Interface to automatically generated code in fts5_unicode2.c.
  177162. */
  177163. static int sqlite3Fts5UnicodeIsalnum(int c);
  177164. static int sqlite3Fts5UnicodeIsdiacritic(int c);
  177165. static int sqlite3Fts5UnicodeFold(int c, int bRemoveDiacritic);
  177166. /*
  177167. ** End of interface to code in fts5_unicode2.c.
  177168. **************************************************************************/
  177169. #endif
  177170. #define FTS5_OR 1
  177171. #define FTS5_AND 2
  177172. #define FTS5_NOT 3
  177173. #define FTS5_TERM 4
  177174. #define FTS5_COLON 5
  177175. #define FTS5_MINUS 6
  177176. #define FTS5_LCP 7
  177177. #define FTS5_RCP 8
  177178. #define FTS5_STRING 9
  177179. #define FTS5_LP 10
  177180. #define FTS5_RP 11
  177181. #define FTS5_CARET 12
  177182. #define FTS5_COMMA 13
  177183. #define FTS5_PLUS 14
  177184. #define FTS5_STAR 15
  177185. /*
  177186. ** 2000-05-29
  177187. **
  177188. ** The author disclaims copyright to this source code. In place of
  177189. ** a legal notice, here is a blessing:
  177190. **
  177191. ** May you do good and not evil.
  177192. ** May you find forgiveness for yourself and forgive others.
  177193. ** May you share freely, never taking more than you give.
  177194. **
  177195. *************************************************************************
  177196. ** Driver template for the LEMON parser generator.
  177197. **
  177198. ** The "lemon" program processes an LALR(1) input grammar file, then uses
  177199. ** this template to construct a parser. The "lemon" program inserts text
  177200. ** at each "%%" line. Also, any "P-a-r-s-e" identifer prefix (without the
  177201. ** interstitial "-" characters) contained in this template is changed into
  177202. ** the value of the %name directive from the grammar. Otherwise, the content
  177203. ** of this template is copied straight through into the generate parser
  177204. ** source file.
  177205. **
  177206. ** The following is the concatenation of all %include directives from the
  177207. ** input grammar file:
  177208. */
  177209. /* #include <stdio.h> */
  177210. /************ Begin %include sections from the grammar ************************/
  177211. /* #include "fts5Int.h" */
  177212. /* #include "fts5parse.h" */
  177213. /*
  177214. ** Disable all error recovery processing in the parser push-down
  177215. ** automaton.
  177216. */
  177217. #define fts5YYNOERRORRECOVERY 1
  177218. /*
  177219. ** Make fts5yytestcase() the same as testcase()
  177220. */
  177221. #define fts5yytestcase(X) testcase(X)
  177222. /*
  177223. ** Indicate that sqlite3ParserFree() will never be called with a null
  177224. ** pointer.
  177225. */
  177226. #define fts5YYPARSEFREENOTNULL 1
  177227. /*
  177228. ** Alternative datatype for the argument to the malloc() routine passed
  177229. ** into sqlite3ParserAlloc(). The default is size_t.
  177230. */
  177231. #define fts5YYMALLOCARGTYPE u64
  177232. /**************** End of %include directives **********************************/
  177233. /* These constants specify the various numeric values for terminal symbols
  177234. ** in a format understandable to "makeheaders". This section is blank unless
  177235. ** "lemon" is run with the "-m" command-line option.
  177236. ***************** Begin makeheaders token definitions *************************/
  177237. /**************** End makeheaders token definitions ***************************/
  177238. /* The next sections is a series of control #defines.
  177239. ** various aspects of the generated parser.
  177240. ** fts5YYCODETYPE is the data type used to store the integer codes
  177241. ** that represent terminal and non-terminal symbols.
  177242. ** "unsigned char" is used if there are fewer than
  177243. ** 256 symbols. Larger types otherwise.
  177244. ** fts5YYNOCODE is a number of type fts5YYCODETYPE that is not used for
  177245. ** any terminal or nonterminal symbol.
  177246. ** fts5YYFALLBACK If defined, this indicates that one or more tokens
  177247. ** (also known as: "terminal symbols") have fall-back
  177248. ** values which should be used if the original symbol
  177249. ** would not parse. This permits keywords to sometimes
  177250. ** be used as identifiers, for example.
  177251. ** fts5YYACTIONTYPE is the data type used for "action codes" - numbers
  177252. ** that indicate what to do in response to the next
  177253. ** token.
  177254. ** sqlite3Fts5ParserFTS5TOKENTYPE is the data type used for minor type for terminal
  177255. ** symbols. Background: A "minor type" is a semantic
  177256. ** value associated with a terminal or non-terminal
  177257. ** symbols. For example, for an "ID" terminal symbol,
  177258. ** the minor type might be the name of the identifier.
  177259. ** Each non-terminal can have a different minor type.
  177260. ** Terminal symbols all have the same minor type, though.
  177261. ** This macros defines the minor type for terminal
  177262. ** symbols.
  177263. ** fts5YYMINORTYPE is the data type used for all minor types.
  177264. ** This is typically a union of many types, one of
  177265. ** which is sqlite3Fts5ParserFTS5TOKENTYPE. The entry in the union
  177266. ** for terminal symbols is called "fts5yy0".
  177267. ** fts5YYSTACKDEPTH is the maximum depth of the parser's stack. If
  177268. ** zero the stack is dynamically sized using realloc()
  177269. ** sqlite3Fts5ParserARG_SDECL A static variable declaration for the %extra_argument
  177270. ** sqlite3Fts5ParserARG_PDECL A parameter declaration for the %extra_argument
  177271. ** sqlite3Fts5ParserARG_STORE Code to store %extra_argument into fts5yypParser
  177272. ** sqlite3Fts5ParserARG_FETCH Code to extract %extra_argument from fts5yypParser
  177273. ** fts5YYERRORSYMBOL is the code number of the error symbol. If not
  177274. ** defined, then do no error processing.
  177275. ** fts5YYNSTATE the combined number of states.
  177276. ** fts5YYNRULE the number of rules in the grammar
  177277. ** fts5YYNFTS5TOKEN Number of terminal symbols
  177278. ** fts5YY_MAX_SHIFT Maximum value for shift actions
  177279. ** fts5YY_MIN_SHIFTREDUCE Minimum value for shift-reduce actions
  177280. ** fts5YY_MAX_SHIFTREDUCE Maximum value for shift-reduce actions
  177281. ** fts5YY_ERROR_ACTION The fts5yy_action[] code for syntax error
  177282. ** fts5YY_ACCEPT_ACTION The fts5yy_action[] code for accept
  177283. ** fts5YY_NO_ACTION The fts5yy_action[] code for no-op
  177284. ** fts5YY_MIN_REDUCE Minimum value for reduce actions
  177285. ** fts5YY_MAX_REDUCE Maximum value for reduce actions
  177286. */
  177287. #ifndef INTERFACE
  177288. # define INTERFACE 1
  177289. #endif
  177290. /************* Begin control #defines *****************************************/
  177291. #define fts5YYCODETYPE unsigned char
  177292. #define fts5YYNOCODE 29
  177293. #define fts5YYACTIONTYPE unsigned char
  177294. #define sqlite3Fts5ParserFTS5TOKENTYPE Fts5Token
  177295. typedef union {
  177296. int fts5yyinit;
  177297. sqlite3Fts5ParserFTS5TOKENTYPE fts5yy0;
  177298. int fts5yy4;
  177299. Fts5ExprPhrase* fts5yy11;
  177300. Fts5ExprNearset* fts5yy14;
  177301. Fts5Colset* fts5yy43;
  177302. Fts5ExprNode* fts5yy54;
  177303. } fts5YYMINORTYPE;
  177304. #ifndef fts5YYSTACKDEPTH
  177305. #define fts5YYSTACKDEPTH 100
  177306. #endif
  177307. #define sqlite3Fts5ParserARG_SDECL Fts5Parse *pParse;
  177308. #define sqlite3Fts5ParserARG_PDECL ,Fts5Parse *pParse
  177309. #define sqlite3Fts5ParserARG_FETCH Fts5Parse *pParse = fts5yypParser->pParse
  177310. #define sqlite3Fts5ParserARG_STORE fts5yypParser->pParse = pParse
  177311. #define fts5YYNSTATE 35
  177312. #define fts5YYNRULE 28
  177313. #define fts5YYNFTS5TOKEN 16
  177314. #define fts5YY_MAX_SHIFT 34
  177315. #define fts5YY_MIN_SHIFTREDUCE 52
  177316. #define fts5YY_MAX_SHIFTREDUCE 79
  177317. #define fts5YY_ERROR_ACTION 80
  177318. #define fts5YY_ACCEPT_ACTION 81
  177319. #define fts5YY_NO_ACTION 82
  177320. #define fts5YY_MIN_REDUCE 83
  177321. #define fts5YY_MAX_REDUCE 110
  177322. /************* End control #defines *******************************************/
  177323. /* Define the fts5yytestcase() macro to be a no-op if is not already defined
  177324. ** otherwise.
  177325. **
  177326. ** Applications can choose to define fts5yytestcase() in the %include section
  177327. ** to a macro that can assist in verifying code coverage. For production
  177328. ** code the fts5yytestcase() macro should be turned off. But it is useful
  177329. ** for testing.
  177330. */
  177331. #ifndef fts5yytestcase
  177332. # define fts5yytestcase(X)
  177333. #endif
  177334. /* Next are the tables used to determine what action to take based on the
  177335. ** current state and lookahead token. These tables are used to implement
  177336. ** functions that take a state number and lookahead value and return an
  177337. ** action integer.
  177338. **
  177339. ** Suppose the action integer is N. Then the action is determined as
  177340. ** follows
  177341. **
  177342. ** 0 <= N <= fts5YY_MAX_SHIFT Shift N. That is, push the lookahead
  177343. ** token onto the stack and goto state N.
  177344. **
  177345. ** N between fts5YY_MIN_SHIFTREDUCE Shift to an arbitrary state then
  177346. ** and fts5YY_MAX_SHIFTREDUCE reduce by rule N-fts5YY_MIN_SHIFTREDUCE.
  177347. **
  177348. ** N == fts5YY_ERROR_ACTION A syntax error has occurred.
  177349. **
  177350. ** N == fts5YY_ACCEPT_ACTION The parser accepts its input.
  177351. **
  177352. ** N == fts5YY_NO_ACTION No such action. Denotes unused
  177353. ** slots in the fts5yy_action[] table.
  177354. **
  177355. ** N between fts5YY_MIN_REDUCE Reduce by rule N-fts5YY_MIN_REDUCE
  177356. ** and fts5YY_MAX_REDUCE
  177357. **
  177358. ** The action table is constructed as a single large table named fts5yy_action[].
  177359. ** Given state S and lookahead X, the action is computed as either:
  177360. **
  177361. ** (A) N = fts5yy_action[ fts5yy_shift_ofst[S] + X ]
  177362. ** (B) N = fts5yy_default[S]
  177363. **
  177364. ** The (A) formula is preferred. The B formula is used instead if
  177365. ** fts5yy_lookahead[fts5yy_shift_ofst[S]+X] is not equal to X.
  177366. **
  177367. ** The formulas above are for computing the action when the lookahead is
  177368. ** a terminal symbol. If the lookahead is a non-terminal (as occurs after
  177369. ** a reduce action) then the fts5yy_reduce_ofst[] array is used in place of
  177370. ** the fts5yy_shift_ofst[] array.
  177371. **
  177372. ** The following are the tables generated in this section:
  177373. **
  177374. ** fts5yy_action[] A single table containing all actions.
  177375. ** fts5yy_lookahead[] A table containing the lookahead for each entry in
  177376. ** fts5yy_action. Used to detect hash collisions.
  177377. ** fts5yy_shift_ofst[] For each state, the offset into fts5yy_action for
  177378. ** shifting terminals.
  177379. ** fts5yy_reduce_ofst[] For each state, the offset into fts5yy_action for
  177380. ** shifting non-terminals after a reduce.
  177381. ** fts5yy_default[] Default action for each state.
  177382. **
  177383. *********** Begin parsing tables **********************************************/
  177384. #define fts5YY_ACTTAB_COUNT (105)
  177385. static const fts5YYACTIONTYPE fts5yy_action[] = {
  177386. /* 0 */ 81, 20, 96, 6, 28, 99, 98, 26, 26, 18,
  177387. /* 10 */ 96, 6, 28, 17, 98, 56, 26, 19, 96, 6,
  177388. /* 20 */ 28, 14, 98, 108, 26, 92, 96, 6, 28, 25,
  177389. /* 30 */ 98, 78, 26, 21, 96, 6, 28, 107, 98, 58,
  177390. /* 40 */ 26, 29, 96, 6, 28, 32, 98, 22, 26, 24,
  177391. /* 50 */ 16, 23, 11, 1, 14, 13, 24, 16, 31, 11,
  177392. /* 60 */ 3, 97, 13, 27, 8, 98, 82, 26, 7, 4,
  177393. /* 70 */ 5, 3, 4, 5, 3, 83, 4, 5, 3, 63,
  177394. /* 80 */ 33, 34, 62, 12, 2, 86, 13, 10, 12, 71,
  177395. /* 90 */ 10, 13, 78, 5, 3, 78, 9, 30, 75, 82,
  177396. /* 100 */ 54, 57, 53, 57, 15,
  177397. };
  177398. static const fts5YYCODETYPE fts5yy_lookahead[] = {
  177399. /* 0 */ 17, 18, 19, 20, 21, 23, 23, 25, 25, 18,
  177400. /* 10 */ 19, 20, 21, 7, 23, 9, 25, 18, 19, 20,
  177401. /* 20 */ 21, 9, 23, 27, 25, 18, 19, 20, 21, 25,
  177402. /* 30 */ 23, 15, 25, 18, 19, 20, 21, 27, 23, 9,
  177403. /* 40 */ 25, 18, 19, 20, 21, 14, 23, 22, 25, 6,
  177404. /* 50 */ 7, 22, 9, 10, 9, 12, 6, 7, 13, 9,
  177405. /* 60 */ 3, 19, 12, 21, 5, 23, 28, 25, 5, 1,
  177406. /* 70 */ 2, 3, 1, 2, 3, 0, 1, 2, 3, 11,
  177407. /* 80 */ 25, 26, 11, 9, 10, 5, 12, 10, 9, 11,
  177408. /* 90 */ 10, 12, 15, 2, 3, 15, 24, 25, 9, 28,
  177409. /* 100 */ 8, 9, 8, 9, 9, 28, 28, 28, 28, 28,
  177410. /* 110 */ 28, 28, 28, 28, 28, 28, 28, 28, 28, 28,
  177411. /* 120 */ 28,
  177412. };
  177413. #define fts5YY_SHIFT_COUNT (34)
  177414. #define fts5YY_SHIFT_MIN (0)
  177415. #define fts5YY_SHIFT_MAX (95)
  177416. static const unsigned char fts5yy_shift_ofst[] = {
  177417. /* 0 */ 43, 43, 43, 43, 43, 43, 50, 74, 79, 45,
  177418. /* 10 */ 12, 80, 77, 12, 16, 16, 30, 30, 68, 71,
  177419. /* 20 */ 75, 91, 92, 94, 6, 31, 31, 59, 63, 57,
  177420. /* 30 */ 31, 89, 95, 31, 78,
  177421. };
  177422. #define fts5YY_REDUCE_COUNT (17)
  177423. #define fts5YY_REDUCE_MIN (-18)
  177424. #define fts5YY_REDUCE_MAX (72)
  177425. static const signed char fts5yy_reduce_ofst[] = {
  177426. /* 0 */ -17, -9, -1, 7, 15, 23, 42, -18, -18, 55,
  177427. /* 10 */ 72, -4, -4, 4, -4, 10, 25, 29,
  177428. };
  177429. static const fts5YYACTIONTYPE fts5yy_default[] = {
  177430. /* 0 */ 80, 80, 80, 80, 80, 80, 95, 80, 80, 105,
  177431. /* 10 */ 80, 110, 110, 80, 110, 110, 80, 80, 80, 80,
  177432. /* 20 */ 80, 91, 80, 80, 80, 101, 100, 80, 80, 90,
  177433. /* 30 */ 103, 80, 80, 104, 80,
  177434. };
  177435. /********** End of lemon-generated parsing tables *****************************/
  177436. /* The next table maps tokens (terminal symbols) into fallback tokens.
  177437. ** If a construct like the following:
  177438. **
  177439. ** %fallback ID X Y Z.
  177440. **
  177441. ** appears in the grammar, then ID becomes a fallback token for X, Y,
  177442. ** and Z. Whenever one of the tokens X, Y, or Z is input to the parser
  177443. ** but it does not parse, the type of the token is changed to ID and
  177444. ** the parse is retried before an error is thrown.
  177445. **
  177446. ** This feature can be used, for example, to cause some keywords in a language
  177447. ** to revert to identifiers if they keyword does not apply in the context where
  177448. ** it appears.
  177449. */
  177450. #ifdef fts5YYFALLBACK
  177451. static const fts5YYCODETYPE fts5yyFallback[] = {
  177452. };
  177453. #endif /* fts5YYFALLBACK */
  177454. /* The following structure represents a single element of the
  177455. ** parser's stack. Information stored includes:
  177456. **
  177457. ** + The state number for the parser at this level of the stack.
  177458. **
  177459. ** + The value of the token stored at this level of the stack.
  177460. ** (In other words, the "major" token.)
  177461. **
  177462. ** + The semantic value stored at this level of the stack. This is
  177463. ** the information used by the action routines in the grammar.
  177464. ** It is sometimes called the "minor" token.
  177465. **
  177466. ** After the "shift" half of a SHIFTREDUCE action, the stateno field
  177467. ** actually contains the reduce action for the second half of the
  177468. ** SHIFTREDUCE.
  177469. */
  177470. struct fts5yyStackEntry {
  177471. fts5YYACTIONTYPE stateno; /* The state-number, or reduce action in SHIFTREDUCE */
  177472. fts5YYCODETYPE major; /* The major token value. This is the code
  177473. ** number for the token at this stack level */
  177474. fts5YYMINORTYPE minor; /* The user-supplied minor token value. This
  177475. ** is the value of the token */
  177476. };
  177477. typedef struct fts5yyStackEntry fts5yyStackEntry;
  177478. /* The state of the parser is completely contained in an instance of
  177479. ** the following structure */
  177480. struct fts5yyParser {
  177481. fts5yyStackEntry *fts5yytos; /* Pointer to top element of the stack */
  177482. #ifdef fts5YYTRACKMAXSTACKDEPTH
  177483. int fts5yyhwm; /* High-water mark of the stack */
  177484. #endif
  177485. #ifndef fts5YYNOERRORRECOVERY
  177486. int fts5yyerrcnt; /* Shifts left before out of the error */
  177487. #endif
  177488. sqlite3Fts5ParserARG_SDECL /* A place to hold %extra_argument */
  177489. #if fts5YYSTACKDEPTH<=0
  177490. int fts5yystksz; /* Current side of the stack */
  177491. fts5yyStackEntry *fts5yystack; /* The parser's stack */
  177492. fts5yyStackEntry fts5yystk0; /* First stack entry */
  177493. #else
  177494. fts5yyStackEntry fts5yystack[fts5YYSTACKDEPTH]; /* The parser's stack */
  177495. fts5yyStackEntry *fts5yystackEnd; /* Last entry in the stack */
  177496. #endif
  177497. };
  177498. typedef struct fts5yyParser fts5yyParser;
  177499. #ifndef NDEBUG
  177500. /* #include <stdio.h> */
  177501. static FILE *fts5yyTraceFILE = 0;
  177502. static char *fts5yyTracePrompt = 0;
  177503. #endif /* NDEBUG */
  177504. #ifndef NDEBUG
  177505. /*
  177506. ** Turn parser tracing on by giving a stream to which to write the trace
  177507. ** and a prompt to preface each trace message. Tracing is turned off
  177508. ** by making either argument NULL
  177509. **
  177510. ** Inputs:
  177511. ** <ul>
  177512. ** <li> A FILE* to which trace output should be written.
  177513. ** If NULL, then tracing is turned off.
  177514. ** <li> A prefix string written at the beginning of every
  177515. ** line of trace output. If NULL, then tracing is
  177516. ** turned off.
  177517. ** </ul>
  177518. **
  177519. ** Outputs:
  177520. ** None.
  177521. */
  177522. static void sqlite3Fts5ParserTrace(FILE *TraceFILE, char *zTracePrompt){
  177523. fts5yyTraceFILE = TraceFILE;
  177524. fts5yyTracePrompt = zTracePrompt;
  177525. if( fts5yyTraceFILE==0 ) fts5yyTracePrompt = 0;
  177526. else if( fts5yyTracePrompt==0 ) fts5yyTraceFILE = 0;
  177527. }
  177528. #endif /* NDEBUG */
  177529. #if defined(fts5YYCOVERAGE) || !defined(NDEBUG)
  177530. /* For tracing shifts, the names of all terminals and nonterminals
  177531. ** are required. The following table supplies these names */
  177532. static const char *const fts5yyTokenName[] = {
  177533. /* 0 */ "$",
  177534. /* 1 */ "OR",
  177535. /* 2 */ "AND",
  177536. /* 3 */ "NOT",
  177537. /* 4 */ "TERM",
  177538. /* 5 */ "COLON",
  177539. /* 6 */ "MINUS",
  177540. /* 7 */ "LCP",
  177541. /* 8 */ "RCP",
  177542. /* 9 */ "STRING",
  177543. /* 10 */ "LP",
  177544. /* 11 */ "RP",
  177545. /* 12 */ "CARET",
  177546. /* 13 */ "COMMA",
  177547. /* 14 */ "PLUS",
  177548. /* 15 */ "STAR",
  177549. /* 16 */ "error",
  177550. /* 17 */ "input",
  177551. /* 18 */ "expr",
  177552. /* 19 */ "cnearset",
  177553. /* 20 */ "exprlist",
  177554. /* 21 */ "colset",
  177555. /* 22 */ "colsetlist",
  177556. /* 23 */ "nearset",
  177557. /* 24 */ "nearphrases",
  177558. /* 25 */ "phrase",
  177559. /* 26 */ "neardist_opt",
  177560. /* 27 */ "star_opt",
  177561. };
  177562. #endif /* defined(fts5YYCOVERAGE) || !defined(NDEBUG) */
  177563. #ifndef NDEBUG
  177564. /* For tracing reduce actions, the names of all rules are required.
  177565. */
  177566. static const char *const fts5yyRuleName[] = {
  177567. /* 0 */ "input ::= expr",
  177568. /* 1 */ "colset ::= MINUS LCP colsetlist RCP",
  177569. /* 2 */ "colset ::= LCP colsetlist RCP",
  177570. /* 3 */ "colset ::= STRING",
  177571. /* 4 */ "colset ::= MINUS STRING",
  177572. /* 5 */ "colsetlist ::= colsetlist STRING",
  177573. /* 6 */ "colsetlist ::= STRING",
  177574. /* 7 */ "expr ::= expr AND expr",
  177575. /* 8 */ "expr ::= expr OR expr",
  177576. /* 9 */ "expr ::= expr NOT expr",
  177577. /* 10 */ "expr ::= colset COLON LP expr RP",
  177578. /* 11 */ "expr ::= LP expr RP",
  177579. /* 12 */ "expr ::= exprlist",
  177580. /* 13 */ "exprlist ::= cnearset",
  177581. /* 14 */ "exprlist ::= exprlist cnearset",
  177582. /* 15 */ "cnearset ::= nearset",
  177583. /* 16 */ "cnearset ::= colset COLON nearset",
  177584. /* 17 */ "nearset ::= phrase",
  177585. /* 18 */ "nearset ::= CARET phrase",
  177586. /* 19 */ "nearset ::= STRING LP nearphrases neardist_opt RP",
  177587. /* 20 */ "nearphrases ::= phrase",
  177588. /* 21 */ "nearphrases ::= nearphrases phrase",
  177589. /* 22 */ "neardist_opt ::=",
  177590. /* 23 */ "neardist_opt ::= COMMA STRING",
  177591. /* 24 */ "phrase ::= phrase PLUS STRING star_opt",
  177592. /* 25 */ "phrase ::= STRING star_opt",
  177593. /* 26 */ "star_opt ::= STAR",
  177594. /* 27 */ "star_opt ::=",
  177595. };
  177596. #endif /* NDEBUG */
  177597. #if fts5YYSTACKDEPTH<=0
  177598. /*
  177599. ** Try to increase the size of the parser stack. Return the number
  177600. ** of errors. Return 0 on success.
  177601. */
  177602. static int fts5yyGrowStack(fts5yyParser *p){
  177603. int newSize;
  177604. int idx;
  177605. fts5yyStackEntry *pNew;
  177606. newSize = p->fts5yystksz*2 + 100;
  177607. idx = p->fts5yytos ? (int)(p->fts5yytos - p->fts5yystack) : 0;
  177608. if( p->fts5yystack==&p->fts5yystk0 ){
  177609. pNew = malloc(newSize*sizeof(pNew[0]));
  177610. if( pNew ) pNew[0] = p->fts5yystk0;
  177611. }else{
  177612. pNew = realloc(p->fts5yystack, newSize*sizeof(pNew[0]));
  177613. }
  177614. if( pNew ){
  177615. p->fts5yystack = pNew;
  177616. p->fts5yytos = &p->fts5yystack[idx];
  177617. #ifndef NDEBUG
  177618. if( fts5yyTraceFILE ){
  177619. fprintf(fts5yyTraceFILE,"%sStack grows from %d to %d entries.\n",
  177620. fts5yyTracePrompt, p->fts5yystksz, newSize);
  177621. }
  177622. #endif
  177623. p->fts5yystksz = newSize;
  177624. }
  177625. return pNew==0;
  177626. }
  177627. #endif
  177628. /* Datatype of the argument to the memory allocated passed as the
  177629. ** second argument to sqlite3Fts5ParserAlloc() below. This can be changed by
  177630. ** putting an appropriate #define in the %include section of the input
  177631. ** grammar.
  177632. */
  177633. #ifndef fts5YYMALLOCARGTYPE
  177634. # define fts5YYMALLOCARGTYPE size_t
  177635. #endif
  177636. /* Initialize a new parser that has already been allocated.
  177637. */
  177638. static void sqlite3Fts5ParserInit(void *fts5yypParser){
  177639. fts5yyParser *pParser = (fts5yyParser*)fts5yypParser;
  177640. #ifdef fts5YYTRACKMAXSTACKDEPTH
  177641. pParser->fts5yyhwm = 0;
  177642. #endif
  177643. #if fts5YYSTACKDEPTH<=0
  177644. pParser->fts5yytos = NULL;
  177645. pParser->fts5yystack = NULL;
  177646. pParser->fts5yystksz = 0;
  177647. if( fts5yyGrowStack(pParser) ){
  177648. pParser->fts5yystack = &pParser->fts5yystk0;
  177649. pParser->fts5yystksz = 1;
  177650. }
  177651. #endif
  177652. #ifndef fts5YYNOERRORRECOVERY
  177653. pParser->fts5yyerrcnt = -1;
  177654. #endif
  177655. pParser->fts5yytos = pParser->fts5yystack;
  177656. pParser->fts5yystack[0].stateno = 0;
  177657. pParser->fts5yystack[0].major = 0;
  177658. #if fts5YYSTACKDEPTH>0
  177659. pParser->fts5yystackEnd = &pParser->fts5yystack[fts5YYSTACKDEPTH-1];
  177660. #endif
  177661. }
  177662. #ifndef sqlite3Fts5Parser_ENGINEALWAYSONSTACK
  177663. /*
  177664. ** This function allocates a new parser.
  177665. ** The only argument is a pointer to a function which works like
  177666. ** malloc.
  177667. **
  177668. ** Inputs:
  177669. ** A pointer to the function used to allocate memory.
  177670. **
  177671. ** Outputs:
  177672. ** A pointer to a parser. This pointer is used in subsequent calls
  177673. ** to sqlite3Fts5Parser and sqlite3Fts5ParserFree.
  177674. */
  177675. static void *sqlite3Fts5ParserAlloc(void *(*mallocProc)(fts5YYMALLOCARGTYPE)){
  177676. fts5yyParser *pParser;
  177677. pParser = (fts5yyParser*)(*mallocProc)( (fts5YYMALLOCARGTYPE)sizeof(fts5yyParser) );
  177678. if( pParser ) sqlite3Fts5ParserInit(pParser);
  177679. return pParser;
  177680. }
  177681. #endif /* sqlite3Fts5Parser_ENGINEALWAYSONSTACK */
  177682. /* The following function deletes the "minor type" or semantic value
  177683. ** associated with a symbol. The symbol can be either a terminal
  177684. ** or nonterminal. "fts5yymajor" is the symbol code, and "fts5yypminor" is
  177685. ** a pointer to the value to be deleted. The code used to do the
  177686. ** deletions is derived from the %destructor and/or %token_destructor
  177687. ** directives of the input grammar.
  177688. */
  177689. static void fts5yy_destructor(
  177690. fts5yyParser *fts5yypParser, /* The parser */
  177691. fts5YYCODETYPE fts5yymajor, /* Type code for object to destroy */
  177692. fts5YYMINORTYPE *fts5yypminor /* The object to be destroyed */
  177693. ){
  177694. sqlite3Fts5ParserARG_FETCH;
  177695. switch( fts5yymajor ){
  177696. /* Here is inserted the actions which take place when a
  177697. ** terminal or non-terminal is destroyed. This can happen
  177698. ** when the symbol is popped from the stack during a
  177699. ** reduce or during error processing or when a parser is
  177700. ** being destroyed before it is finished parsing.
  177701. **
  177702. ** Note: during a reduce, the only symbols destroyed are those
  177703. ** which appear on the RHS of the rule, but which are *not* used
  177704. ** inside the C code.
  177705. */
  177706. /********* Begin destructor definitions ***************************************/
  177707. case 17: /* input */
  177708. {
  177709. (void)pParse;
  177710. }
  177711. break;
  177712. case 18: /* expr */
  177713. case 19: /* cnearset */
  177714. case 20: /* exprlist */
  177715. {
  177716. sqlite3Fts5ParseNodeFree((fts5yypminor->fts5yy54));
  177717. }
  177718. break;
  177719. case 21: /* colset */
  177720. case 22: /* colsetlist */
  177721. {
  177722. sqlite3_free((fts5yypminor->fts5yy43));
  177723. }
  177724. break;
  177725. case 23: /* nearset */
  177726. case 24: /* nearphrases */
  177727. {
  177728. sqlite3Fts5ParseNearsetFree((fts5yypminor->fts5yy14));
  177729. }
  177730. break;
  177731. case 25: /* phrase */
  177732. {
  177733. sqlite3Fts5ParsePhraseFree((fts5yypminor->fts5yy11));
  177734. }
  177735. break;
  177736. /********* End destructor definitions *****************************************/
  177737. default: break; /* If no destructor action specified: do nothing */
  177738. }
  177739. }
  177740. /*
  177741. ** Pop the parser's stack once.
  177742. **
  177743. ** If there is a destructor routine associated with the token which
  177744. ** is popped from the stack, then call it.
  177745. */
  177746. static void fts5yy_pop_parser_stack(fts5yyParser *pParser){
  177747. fts5yyStackEntry *fts5yytos;
  177748. assert( pParser->fts5yytos!=0 );
  177749. assert( pParser->fts5yytos > pParser->fts5yystack );
  177750. fts5yytos = pParser->fts5yytos--;
  177751. #ifndef NDEBUG
  177752. if( fts5yyTraceFILE ){
  177753. fprintf(fts5yyTraceFILE,"%sPopping %s\n",
  177754. fts5yyTracePrompt,
  177755. fts5yyTokenName[fts5yytos->major]);
  177756. }
  177757. #endif
  177758. fts5yy_destructor(pParser, fts5yytos->major, &fts5yytos->minor);
  177759. }
  177760. /*
  177761. ** Clear all secondary memory allocations from the parser
  177762. */
  177763. static void sqlite3Fts5ParserFinalize(void *p){
  177764. fts5yyParser *pParser = (fts5yyParser*)p;
  177765. while( pParser->fts5yytos>pParser->fts5yystack ) fts5yy_pop_parser_stack(pParser);
  177766. #if fts5YYSTACKDEPTH<=0
  177767. if( pParser->fts5yystack!=&pParser->fts5yystk0 ) free(pParser->fts5yystack);
  177768. #endif
  177769. }
  177770. #ifndef sqlite3Fts5Parser_ENGINEALWAYSONSTACK
  177771. /*
  177772. ** Deallocate and destroy a parser. Destructors are called for
  177773. ** all stack elements before shutting the parser down.
  177774. **
  177775. ** If the fts5YYPARSEFREENEVERNULL macro exists (for example because it
  177776. ** is defined in a %include section of the input grammar) then it is
  177777. ** assumed that the input pointer is never NULL.
  177778. */
  177779. static void sqlite3Fts5ParserFree(
  177780. void *p, /* The parser to be deleted */
  177781. void (*freeProc)(void*) /* Function used to reclaim memory */
  177782. ){
  177783. #ifndef fts5YYPARSEFREENEVERNULL
  177784. if( p==0 ) return;
  177785. #endif
  177786. sqlite3Fts5ParserFinalize(p);
  177787. (*freeProc)(p);
  177788. }
  177789. #endif /* sqlite3Fts5Parser_ENGINEALWAYSONSTACK */
  177790. /*
  177791. ** Return the peak depth of the stack for a parser.
  177792. */
  177793. #ifdef fts5YYTRACKMAXSTACKDEPTH
  177794. static int sqlite3Fts5ParserStackPeak(void *p){
  177795. fts5yyParser *pParser = (fts5yyParser*)p;
  177796. return pParser->fts5yyhwm;
  177797. }
  177798. #endif
  177799. /* This array of booleans keeps track of the parser statement
  177800. ** coverage. The element fts5yycoverage[X][Y] is set when the parser
  177801. ** is in state X and has a lookahead token Y. In a well-tested
  177802. ** systems, every element of this matrix should end up being set.
  177803. */
  177804. #if defined(fts5YYCOVERAGE)
  177805. static unsigned char fts5yycoverage[fts5YYNSTATE][fts5YYNFTS5TOKEN];
  177806. #endif
  177807. /*
  177808. ** Write into out a description of every state/lookahead combination that
  177809. **
  177810. ** (1) has not been used by the parser, and
  177811. ** (2) is not a syntax error.
  177812. **
  177813. ** Return the number of missed state/lookahead combinations.
  177814. */
  177815. #if defined(fts5YYCOVERAGE)
  177816. static int sqlite3Fts5ParserCoverage(FILE *out){
  177817. int stateno, iLookAhead, i;
  177818. int nMissed = 0;
  177819. for(stateno=0; stateno<fts5YYNSTATE; stateno++){
  177820. i = fts5yy_shift_ofst[stateno];
  177821. for(iLookAhead=0; iLookAhead<fts5YYNFTS5TOKEN; iLookAhead++){
  177822. if( fts5yy_lookahead[i+iLookAhead]!=iLookAhead ) continue;
  177823. if( fts5yycoverage[stateno][iLookAhead]==0 ) nMissed++;
  177824. if( out ){
  177825. fprintf(out,"State %d lookahead %s %s\n", stateno,
  177826. fts5yyTokenName[iLookAhead],
  177827. fts5yycoverage[stateno][iLookAhead] ? "ok" : "missed");
  177828. }
  177829. }
  177830. }
  177831. return nMissed;
  177832. }
  177833. #endif
  177834. /*
  177835. ** Find the appropriate action for a parser given the terminal
  177836. ** look-ahead token iLookAhead.
  177837. */
  177838. static unsigned int fts5yy_find_shift_action(
  177839. fts5yyParser *pParser, /* The parser */
  177840. fts5YYCODETYPE iLookAhead /* The look-ahead token */
  177841. ){
  177842. int i;
  177843. int stateno = pParser->fts5yytos->stateno;
  177844. if( stateno>fts5YY_MAX_SHIFT ) return stateno;
  177845. assert( stateno <= fts5YY_SHIFT_COUNT );
  177846. #if defined(fts5YYCOVERAGE)
  177847. fts5yycoverage[stateno][iLookAhead] = 1;
  177848. #endif
  177849. do{
  177850. i = fts5yy_shift_ofst[stateno];
  177851. assert( i>=0 );
  177852. assert( i+fts5YYNFTS5TOKEN<=(int)sizeof(fts5yy_lookahead)/sizeof(fts5yy_lookahead[0]) );
  177853. assert( iLookAhead!=fts5YYNOCODE );
  177854. assert( iLookAhead < fts5YYNFTS5TOKEN );
  177855. i += iLookAhead;
  177856. if( fts5yy_lookahead[i]!=iLookAhead ){
  177857. #ifdef fts5YYFALLBACK
  177858. fts5YYCODETYPE iFallback; /* Fallback token */
  177859. if( iLookAhead<sizeof(fts5yyFallback)/sizeof(fts5yyFallback[0])
  177860. && (iFallback = fts5yyFallback[iLookAhead])!=0 ){
  177861. #ifndef NDEBUG
  177862. if( fts5yyTraceFILE ){
  177863. fprintf(fts5yyTraceFILE, "%sFALLBACK %s => %s\n",
  177864. fts5yyTracePrompt, fts5yyTokenName[iLookAhead], fts5yyTokenName[iFallback]);
  177865. }
  177866. #endif
  177867. assert( fts5yyFallback[iFallback]==0 ); /* Fallback loop must terminate */
  177868. iLookAhead = iFallback;
  177869. continue;
  177870. }
  177871. #endif
  177872. #ifdef fts5YYWILDCARD
  177873. {
  177874. int j = i - iLookAhead + fts5YYWILDCARD;
  177875. if(
  177876. #if fts5YY_SHIFT_MIN+fts5YYWILDCARD<0
  177877. j>=0 &&
  177878. #endif
  177879. #if fts5YY_SHIFT_MAX+fts5YYWILDCARD>=fts5YY_ACTTAB_COUNT
  177880. j<fts5YY_ACTTAB_COUNT &&
  177881. #endif
  177882. fts5yy_lookahead[j]==fts5YYWILDCARD && iLookAhead>0
  177883. ){
  177884. #ifndef NDEBUG
  177885. if( fts5yyTraceFILE ){
  177886. fprintf(fts5yyTraceFILE, "%sWILDCARD %s => %s\n",
  177887. fts5yyTracePrompt, fts5yyTokenName[iLookAhead],
  177888. fts5yyTokenName[fts5YYWILDCARD]);
  177889. }
  177890. #endif /* NDEBUG */
  177891. return fts5yy_action[j];
  177892. }
  177893. }
  177894. #endif /* fts5YYWILDCARD */
  177895. return fts5yy_default[stateno];
  177896. }else{
  177897. return fts5yy_action[i];
  177898. }
  177899. }while(1);
  177900. }
  177901. /*
  177902. ** Find the appropriate action for a parser given the non-terminal
  177903. ** look-ahead token iLookAhead.
  177904. */
  177905. static int fts5yy_find_reduce_action(
  177906. int stateno, /* Current state number */
  177907. fts5YYCODETYPE iLookAhead /* The look-ahead token */
  177908. ){
  177909. int i;
  177910. #ifdef fts5YYERRORSYMBOL
  177911. if( stateno>fts5YY_REDUCE_COUNT ){
  177912. return fts5yy_default[stateno];
  177913. }
  177914. #else
  177915. assert( stateno<=fts5YY_REDUCE_COUNT );
  177916. #endif
  177917. i = fts5yy_reduce_ofst[stateno];
  177918. assert( iLookAhead!=fts5YYNOCODE );
  177919. i += iLookAhead;
  177920. #ifdef fts5YYERRORSYMBOL
  177921. if( i<0 || i>=fts5YY_ACTTAB_COUNT || fts5yy_lookahead[i]!=iLookAhead ){
  177922. return fts5yy_default[stateno];
  177923. }
  177924. #else
  177925. assert( i>=0 && i<fts5YY_ACTTAB_COUNT );
  177926. assert( fts5yy_lookahead[i]==iLookAhead );
  177927. #endif
  177928. return fts5yy_action[i];
  177929. }
  177930. /*
  177931. ** The following routine is called if the stack overflows.
  177932. */
  177933. static void fts5yyStackOverflow(fts5yyParser *fts5yypParser){
  177934. sqlite3Fts5ParserARG_FETCH;
  177935. #ifndef NDEBUG
  177936. if( fts5yyTraceFILE ){
  177937. fprintf(fts5yyTraceFILE,"%sStack Overflow!\n",fts5yyTracePrompt);
  177938. }
  177939. #endif
  177940. while( fts5yypParser->fts5yytos>fts5yypParser->fts5yystack ) fts5yy_pop_parser_stack(fts5yypParser);
  177941. /* Here code is inserted which will execute if the parser
  177942. ** stack every overflows */
  177943. /******** Begin %stack_overflow code ******************************************/
  177944. sqlite3Fts5ParseError(pParse, "fts5: parser stack overflow");
  177945. /******** End %stack_overflow code ********************************************/
  177946. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument var */
  177947. }
  177948. /*
  177949. ** Print tracing information for a SHIFT action
  177950. */
  177951. #ifndef NDEBUG
  177952. static void fts5yyTraceShift(fts5yyParser *fts5yypParser, int fts5yyNewState, const char *zTag){
  177953. if( fts5yyTraceFILE ){
  177954. if( fts5yyNewState<fts5YYNSTATE ){
  177955. fprintf(fts5yyTraceFILE,"%s%s '%s', go to state %d\n",
  177956. fts5yyTracePrompt, zTag, fts5yyTokenName[fts5yypParser->fts5yytos->major],
  177957. fts5yyNewState);
  177958. }else{
  177959. fprintf(fts5yyTraceFILE,"%s%s '%s', pending reduce %d\n",
  177960. fts5yyTracePrompt, zTag, fts5yyTokenName[fts5yypParser->fts5yytos->major],
  177961. fts5yyNewState - fts5YY_MIN_REDUCE);
  177962. }
  177963. }
  177964. }
  177965. #else
  177966. # define fts5yyTraceShift(X,Y,Z)
  177967. #endif
  177968. /*
  177969. ** Perform a shift action.
  177970. */
  177971. static void fts5yy_shift(
  177972. fts5yyParser *fts5yypParser, /* The parser to be shifted */
  177973. int fts5yyNewState, /* The new state to shift in */
  177974. int fts5yyMajor, /* The major token to shift in */
  177975. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyMinor /* The minor token to shift in */
  177976. ){
  177977. fts5yyStackEntry *fts5yytos;
  177978. fts5yypParser->fts5yytos++;
  177979. #ifdef fts5YYTRACKMAXSTACKDEPTH
  177980. if( (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack)>fts5yypParser->fts5yyhwm ){
  177981. fts5yypParser->fts5yyhwm++;
  177982. assert( fts5yypParser->fts5yyhwm == (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack) );
  177983. }
  177984. #endif
  177985. #if fts5YYSTACKDEPTH>0
  177986. if( fts5yypParser->fts5yytos>fts5yypParser->fts5yystackEnd ){
  177987. fts5yypParser->fts5yytos--;
  177988. fts5yyStackOverflow(fts5yypParser);
  177989. return;
  177990. }
  177991. #else
  177992. if( fts5yypParser->fts5yytos>=&fts5yypParser->fts5yystack[fts5yypParser->fts5yystksz] ){
  177993. if( fts5yyGrowStack(fts5yypParser) ){
  177994. fts5yypParser->fts5yytos--;
  177995. fts5yyStackOverflow(fts5yypParser);
  177996. return;
  177997. }
  177998. }
  177999. #endif
  178000. if( fts5yyNewState > fts5YY_MAX_SHIFT ){
  178001. fts5yyNewState += fts5YY_MIN_REDUCE - fts5YY_MIN_SHIFTREDUCE;
  178002. }
  178003. fts5yytos = fts5yypParser->fts5yytos;
  178004. fts5yytos->stateno = (fts5YYACTIONTYPE)fts5yyNewState;
  178005. fts5yytos->major = (fts5YYCODETYPE)fts5yyMajor;
  178006. fts5yytos->minor.fts5yy0 = fts5yyMinor;
  178007. fts5yyTraceShift(fts5yypParser, fts5yyNewState, "Shift");
  178008. }
  178009. /* The following table contains information about every rule that
  178010. ** is used during the reduce.
  178011. */
  178012. static const struct {
  178013. fts5YYCODETYPE lhs; /* Symbol on the left-hand side of the rule */
  178014. signed char nrhs; /* Negative of the number of RHS symbols in the rule */
  178015. } fts5yyRuleInfo[] = {
  178016. { 17, -1 }, /* (0) input ::= expr */
  178017. { 21, -4 }, /* (1) colset ::= MINUS LCP colsetlist RCP */
  178018. { 21, -3 }, /* (2) colset ::= LCP colsetlist RCP */
  178019. { 21, -1 }, /* (3) colset ::= STRING */
  178020. { 21, -2 }, /* (4) colset ::= MINUS STRING */
  178021. { 22, -2 }, /* (5) colsetlist ::= colsetlist STRING */
  178022. { 22, -1 }, /* (6) colsetlist ::= STRING */
  178023. { 18, -3 }, /* (7) expr ::= expr AND expr */
  178024. { 18, -3 }, /* (8) expr ::= expr OR expr */
  178025. { 18, -3 }, /* (9) expr ::= expr NOT expr */
  178026. { 18, -5 }, /* (10) expr ::= colset COLON LP expr RP */
  178027. { 18, -3 }, /* (11) expr ::= LP expr RP */
  178028. { 18, -1 }, /* (12) expr ::= exprlist */
  178029. { 20, -1 }, /* (13) exprlist ::= cnearset */
  178030. { 20, -2 }, /* (14) exprlist ::= exprlist cnearset */
  178031. { 19, -1 }, /* (15) cnearset ::= nearset */
  178032. { 19, -3 }, /* (16) cnearset ::= colset COLON nearset */
  178033. { 23, -1 }, /* (17) nearset ::= phrase */
  178034. { 23, -2 }, /* (18) nearset ::= CARET phrase */
  178035. { 23, -5 }, /* (19) nearset ::= STRING LP nearphrases neardist_opt RP */
  178036. { 24, -1 }, /* (20) nearphrases ::= phrase */
  178037. { 24, -2 }, /* (21) nearphrases ::= nearphrases phrase */
  178038. { 26, 0 }, /* (22) neardist_opt ::= */
  178039. { 26, -2 }, /* (23) neardist_opt ::= COMMA STRING */
  178040. { 25, -4 }, /* (24) phrase ::= phrase PLUS STRING star_opt */
  178041. { 25, -2 }, /* (25) phrase ::= STRING star_opt */
  178042. { 27, -1 }, /* (26) star_opt ::= STAR */
  178043. { 27, 0 }, /* (27) star_opt ::= */
  178044. };
  178045. static void fts5yy_accept(fts5yyParser*); /* Forward Declaration */
  178046. /*
  178047. ** Perform a reduce action and the shift that must immediately
  178048. ** follow the reduce.
  178049. **
  178050. ** The fts5yyLookahead and fts5yyLookaheadToken parameters provide reduce actions
  178051. ** access to the lookahead token (if any). The fts5yyLookahead will be fts5YYNOCODE
  178052. ** if the lookahead token has already been consumed. As this procedure is
  178053. ** only called from one place, optimizing compilers will in-line it, which
  178054. ** means that the extra parameters have no performance impact.
  178055. */
  178056. static void fts5yy_reduce(
  178057. fts5yyParser *fts5yypParser, /* The parser */
  178058. unsigned int fts5yyruleno, /* Number of the rule by which to reduce */
  178059. int fts5yyLookahead, /* Lookahead token, or fts5YYNOCODE if none */
  178060. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyLookaheadToken /* Value of the lookahead token */
  178061. ){
  178062. int fts5yygoto; /* The next state */
  178063. int fts5yyact; /* The next action */
  178064. fts5yyStackEntry *fts5yymsp; /* The top of the parser's stack */
  178065. int fts5yysize; /* Amount to pop the stack */
  178066. sqlite3Fts5ParserARG_FETCH;
  178067. (void)fts5yyLookahead;
  178068. (void)fts5yyLookaheadToken;
  178069. fts5yymsp = fts5yypParser->fts5yytos;
  178070. #ifndef NDEBUG
  178071. if( fts5yyTraceFILE && fts5yyruleno<(int)(sizeof(fts5yyRuleName)/sizeof(fts5yyRuleName[0])) ){
  178072. fts5yysize = fts5yyRuleInfo[fts5yyruleno].nrhs;
  178073. if( fts5yysize ){
  178074. fprintf(fts5yyTraceFILE, "%sReduce %d [%s], go to state %d.\n",
  178075. fts5yyTracePrompt,
  178076. fts5yyruleno, fts5yyRuleName[fts5yyruleno], fts5yymsp[fts5yysize].stateno);
  178077. }else{
  178078. fprintf(fts5yyTraceFILE, "%sReduce %d [%s].\n",
  178079. fts5yyTracePrompt, fts5yyruleno, fts5yyRuleName[fts5yyruleno]);
  178080. }
  178081. }
  178082. #endif /* NDEBUG */
  178083. /* Check that the stack is large enough to grow by a single entry
  178084. ** if the RHS of the rule is empty. This ensures that there is room
  178085. ** enough on the stack to push the LHS value */
  178086. if( fts5yyRuleInfo[fts5yyruleno].nrhs==0 ){
  178087. #ifdef fts5YYTRACKMAXSTACKDEPTH
  178088. if( (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack)>fts5yypParser->fts5yyhwm ){
  178089. fts5yypParser->fts5yyhwm++;
  178090. assert( fts5yypParser->fts5yyhwm == (int)(fts5yypParser->fts5yytos - fts5yypParser->fts5yystack));
  178091. }
  178092. #endif
  178093. #if fts5YYSTACKDEPTH>0
  178094. if( fts5yypParser->fts5yytos>=fts5yypParser->fts5yystackEnd ){
  178095. fts5yyStackOverflow(fts5yypParser);
  178096. return;
  178097. }
  178098. #else
  178099. if( fts5yypParser->fts5yytos>=&fts5yypParser->fts5yystack[fts5yypParser->fts5yystksz-1] ){
  178100. if( fts5yyGrowStack(fts5yypParser) ){
  178101. fts5yyStackOverflow(fts5yypParser);
  178102. return;
  178103. }
  178104. fts5yymsp = fts5yypParser->fts5yytos;
  178105. }
  178106. #endif
  178107. }
  178108. switch( fts5yyruleno ){
  178109. /* Beginning here are the reduction cases. A typical example
  178110. ** follows:
  178111. ** case 0:
  178112. ** #line <lineno> <grammarfile>
  178113. ** { ... } // User supplied code
  178114. ** #line <lineno> <thisfile>
  178115. ** break;
  178116. */
  178117. /********** Begin reduce actions **********************************************/
  178118. fts5YYMINORTYPE fts5yylhsminor;
  178119. case 0: /* input ::= expr */
  178120. { sqlite3Fts5ParseFinished(pParse, fts5yymsp[0].minor.fts5yy54); }
  178121. break;
  178122. case 1: /* colset ::= MINUS LCP colsetlist RCP */
  178123. {
  178124. fts5yymsp[-3].minor.fts5yy43 = sqlite3Fts5ParseColsetInvert(pParse, fts5yymsp[-1].minor.fts5yy43);
  178125. }
  178126. break;
  178127. case 2: /* colset ::= LCP colsetlist RCP */
  178128. { fts5yymsp[-2].minor.fts5yy43 = fts5yymsp[-1].minor.fts5yy43; }
  178129. break;
  178130. case 3: /* colset ::= STRING */
  178131. {
  178132. fts5yylhsminor.fts5yy43 = sqlite3Fts5ParseColset(pParse, 0, &fts5yymsp[0].minor.fts5yy0);
  178133. }
  178134. fts5yymsp[0].minor.fts5yy43 = fts5yylhsminor.fts5yy43;
  178135. break;
  178136. case 4: /* colset ::= MINUS STRING */
  178137. {
  178138. fts5yymsp[-1].minor.fts5yy43 = sqlite3Fts5ParseColset(pParse, 0, &fts5yymsp[0].minor.fts5yy0);
  178139. fts5yymsp[-1].minor.fts5yy43 = sqlite3Fts5ParseColsetInvert(pParse, fts5yymsp[-1].minor.fts5yy43);
  178140. }
  178141. break;
  178142. case 5: /* colsetlist ::= colsetlist STRING */
  178143. {
  178144. fts5yylhsminor.fts5yy43 = sqlite3Fts5ParseColset(pParse, fts5yymsp[-1].minor.fts5yy43, &fts5yymsp[0].minor.fts5yy0); }
  178145. fts5yymsp[-1].minor.fts5yy43 = fts5yylhsminor.fts5yy43;
  178146. break;
  178147. case 6: /* colsetlist ::= STRING */
  178148. {
  178149. fts5yylhsminor.fts5yy43 = sqlite3Fts5ParseColset(pParse, 0, &fts5yymsp[0].minor.fts5yy0);
  178150. }
  178151. fts5yymsp[0].minor.fts5yy43 = fts5yylhsminor.fts5yy43;
  178152. break;
  178153. case 7: /* expr ::= expr AND expr */
  178154. {
  178155. fts5yylhsminor.fts5yy54 = sqlite3Fts5ParseNode(pParse, FTS5_AND, fts5yymsp[-2].minor.fts5yy54, fts5yymsp[0].minor.fts5yy54, 0);
  178156. }
  178157. fts5yymsp[-2].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178158. break;
  178159. case 8: /* expr ::= expr OR expr */
  178160. {
  178161. fts5yylhsminor.fts5yy54 = sqlite3Fts5ParseNode(pParse, FTS5_OR, fts5yymsp[-2].minor.fts5yy54, fts5yymsp[0].minor.fts5yy54, 0);
  178162. }
  178163. fts5yymsp[-2].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178164. break;
  178165. case 9: /* expr ::= expr NOT expr */
  178166. {
  178167. fts5yylhsminor.fts5yy54 = sqlite3Fts5ParseNode(pParse, FTS5_NOT, fts5yymsp[-2].minor.fts5yy54, fts5yymsp[0].minor.fts5yy54, 0);
  178168. }
  178169. fts5yymsp[-2].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178170. break;
  178171. case 10: /* expr ::= colset COLON LP expr RP */
  178172. {
  178173. sqlite3Fts5ParseSetColset(pParse, fts5yymsp[-1].minor.fts5yy54, fts5yymsp[-4].minor.fts5yy43);
  178174. fts5yylhsminor.fts5yy54 = fts5yymsp[-1].minor.fts5yy54;
  178175. }
  178176. fts5yymsp[-4].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178177. break;
  178178. case 11: /* expr ::= LP expr RP */
  178179. {fts5yymsp[-2].minor.fts5yy54 = fts5yymsp[-1].minor.fts5yy54;}
  178180. break;
  178181. case 12: /* expr ::= exprlist */
  178182. case 13: /* exprlist ::= cnearset */ fts5yytestcase(fts5yyruleno==13);
  178183. {fts5yylhsminor.fts5yy54 = fts5yymsp[0].minor.fts5yy54;}
  178184. fts5yymsp[0].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178185. break;
  178186. case 14: /* exprlist ::= exprlist cnearset */
  178187. {
  178188. fts5yylhsminor.fts5yy54 = sqlite3Fts5ParseImplicitAnd(pParse, fts5yymsp[-1].minor.fts5yy54, fts5yymsp[0].minor.fts5yy54);
  178189. }
  178190. fts5yymsp[-1].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178191. break;
  178192. case 15: /* cnearset ::= nearset */
  178193. {
  178194. fts5yylhsminor.fts5yy54 = sqlite3Fts5ParseNode(pParse, FTS5_STRING, 0, 0, fts5yymsp[0].minor.fts5yy14);
  178195. }
  178196. fts5yymsp[0].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178197. break;
  178198. case 16: /* cnearset ::= colset COLON nearset */
  178199. {
  178200. fts5yylhsminor.fts5yy54 = sqlite3Fts5ParseNode(pParse, FTS5_STRING, 0, 0, fts5yymsp[0].minor.fts5yy14);
  178201. sqlite3Fts5ParseSetColset(pParse, fts5yylhsminor.fts5yy54, fts5yymsp[-2].minor.fts5yy43);
  178202. }
  178203. fts5yymsp[-2].minor.fts5yy54 = fts5yylhsminor.fts5yy54;
  178204. break;
  178205. case 17: /* nearset ::= phrase */
  178206. { fts5yylhsminor.fts5yy14 = sqlite3Fts5ParseNearset(pParse, 0, fts5yymsp[0].minor.fts5yy11); }
  178207. fts5yymsp[0].minor.fts5yy14 = fts5yylhsminor.fts5yy14;
  178208. break;
  178209. case 18: /* nearset ::= CARET phrase */
  178210. {
  178211. sqlite3Fts5ParseSetCaret(fts5yymsp[0].minor.fts5yy11);
  178212. fts5yymsp[-1].minor.fts5yy14 = sqlite3Fts5ParseNearset(pParse, 0, fts5yymsp[0].minor.fts5yy11);
  178213. }
  178214. break;
  178215. case 19: /* nearset ::= STRING LP nearphrases neardist_opt RP */
  178216. {
  178217. sqlite3Fts5ParseNear(pParse, &fts5yymsp[-4].minor.fts5yy0);
  178218. sqlite3Fts5ParseSetDistance(pParse, fts5yymsp[-2].minor.fts5yy14, &fts5yymsp[-1].minor.fts5yy0);
  178219. fts5yylhsminor.fts5yy14 = fts5yymsp[-2].minor.fts5yy14;
  178220. }
  178221. fts5yymsp[-4].minor.fts5yy14 = fts5yylhsminor.fts5yy14;
  178222. break;
  178223. case 20: /* nearphrases ::= phrase */
  178224. {
  178225. fts5yylhsminor.fts5yy14 = sqlite3Fts5ParseNearset(pParse, 0, fts5yymsp[0].minor.fts5yy11);
  178226. }
  178227. fts5yymsp[0].minor.fts5yy14 = fts5yylhsminor.fts5yy14;
  178228. break;
  178229. case 21: /* nearphrases ::= nearphrases phrase */
  178230. {
  178231. fts5yylhsminor.fts5yy14 = sqlite3Fts5ParseNearset(pParse, fts5yymsp[-1].minor.fts5yy14, fts5yymsp[0].minor.fts5yy11);
  178232. }
  178233. fts5yymsp[-1].minor.fts5yy14 = fts5yylhsminor.fts5yy14;
  178234. break;
  178235. case 22: /* neardist_opt ::= */
  178236. { fts5yymsp[1].minor.fts5yy0.p = 0; fts5yymsp[1].minor.fts5yy0.n = 0; }
  178237. break;
  178238. case 23: /* neardist_opt ::= COMMA STRING */
  178239. { fts5yymsp[-1].minor.fts5yy0 = fts5yymsp[0].minor.fts5yy0; }
  178240. break;
  178241. case 24: /* phrase ::= phrase PLUS STRING star_opt */
  178242. {
  178243. fts5yylhsminor.fts5yy11 = sqlite3Fts5ParseTerm(pParse, fts5yymsp[-3].minor.fts5yy11, &fts5yymsp[-1].minor.fts5yy0, fts5yymsp[0].minor.fts5yy4);
  178244. }
  178245. fts5yymsp[-3].minor.fts5yy11 = fts5yylhsminor.fts5yy11;
  178246. break;
  178247. case 25: /* phrase ::= STRING star_opt */
  178248. {
  178249. fts5yylhsminor.fts5yy11 = sqlite3Fts5ParseTerm(pParse, 0, &fts5yymsp[-1].minor.fts5yy0, fts5yymsp[0].minor.fts5yy4);
  178250. }
  178251. fts5yymsp[-1].minor.fts5yy11 = fts5yylhsminor.fts5yy11;
  178252. break;
  178253. case 26: /* star_opt ::= STAR */
  178254. { fts5yymsp[0].minor.fts5yy4 = 1; }
  178255. break;
  178256. case 27: /* star_opt ::= */
  178257. { fts5yymsp[1].minor.fts5yy4 = 0; }
  178258. break;
  178259. default:
  178260. break;
  178261. /********** End reduce actions ************************************************/
  178262. };
  178263. assert( fts5yyruleno<sizeof(fts5yyRuleInfo)/sizeof(fts5yyRuleInfo[0]) );
  178264. fts5yygoto = fts5yyRuleInfo[fts5yyruleno].lhs;
  178265. fts5yysize = fts5yyRuleInfo[fts5yyruleno].nrhs;
  178266. fts5yyact = fts5yy_find_reduce_action(fts5yymsp[fts5yysize].stateno,(fts5YYCODETYPE)fts5yygoto);
  178267. /* There are no SHIFTREDUCE actions on nonterminals because the table
  178268. ** generator has simplified them to pure REDUCE actions. */
  178269. assert( !(fts5yyact>fts5YY_MAX_SHIFT && fts5yyact<=fts5YY_MAX_SHIFTREDUCE) );
  178270. /* It is not possible for a REDUCE to be followed by an error */
  178271. assert( fts5yyact!=fts5YY_ERROR_ACTION );
  178272. fts5yymsp += fts5yysize+1;
  178273. fts5yypParser->fts5yytos = fts5yymsp;
  178274. fts5yymsp->stateno = (fts5YYACTIONTYPE)fts5yyact;
  178275. fts5yymsp->major = (fts5YYCODETYPE)fts5yygoto;
  178276. fts5yyTraceShift(fts5yypParser, fts5yyact, "... then shift");
  178277. }
  178278. /*
  178279. ** The following code executes when the parse fails
  178280. */
  178281. #ifndef fts5YYNOERRORRECOVERY
  178282. static void fts5yy_parse_failed(
  178283. fts5yyParser *fts5yypParser /* The parser */
  178284. ){
  178285. sqlite3Fts5ParserARG_FETCH;
  178286. #ifndef NDEBUG
  178287. if( fts5yyTraceFILE ){
  178288. fprintf(fts5yyTraceFILE,"%sFail!\n",fts5yyTracePrompt);
  178289. }
  178290. #endif
  178291. while( fts5yypParser->fts5yytos>fts5yypParser->fts5yystack ) fts5yy_pop_parser_stack(fts5yypParser);
  178292. /* Here code is inserted which will be executed whenever the
  178293. ** parser fails */
  178294. /************ Begin %parse_failure code ***************************************/
  178295. /************ End %parse_failure code *****************************************/
  178296. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  178297. }
  178298. #endif /* fts5YYNOERRORRECOVERY */
  178299. /*
  178300. ** The following code executes when a syntax error first occurs.
  178301. */
  178302. static void fts5yy_syntax_error(
  178303. fts5yyParser *fts5yypParser, /* The parser */
  178304. int fts5yymajor, /* The major type of the error token */
  178305. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyminor /* The minor type of the error token */
  178306. ){
  178307. sqlite3Fts5ParserARG_FETCH;
  178308. #define FTS5TOKEN fts5yyminor
  178309. /************ Begin %syntax_error code ****************************************/
  178310. UNUSED_PARAM(fts5yymajor); /* Silence a compiler warning */
  178311. sqlite3Fts5ParseError(
  178312. pParse, "fts5: syntax error near \"%.*s\"",FTS5TOKEN.n,FTS5TOKEN.p
  178313. );
  178314. /************ End %syntax_error code ******************************************/
  178315. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  178316. }
  178317. /*
  178318. ** The following is executed when the parser accepts
  178319. */
  178320. static void fts5yy_accept(
  178321. fts5yyParser *fts5yypParser /* The parser */
  178322. ){
  178323. sqlite3Fts5ParserARG_FETCH;
  178324. #ifndef NDEBUG
  178325. if( fts5yyTraceFILE ){
  178326. fprintf(fts5yyTraceFILE,"%sAccept!\n",fts5yyTracePrompt);
  178327. }
  178328. #endif
  178329. #ifndef fts5YYNOERRORRECOVERY
  178330. fts5yypParser->fts5yyerrcnt = -1;
  178331. #endif
  178332. assert( fts5yypParser->fts5yytos==fts5yypParser->fts5yystack );
  178333. /* Here code is inserted which will be executed whenever the
  178334. ** parser accepts */
  178335. /*********** Begin %parse_accept code *****************************************/
  178336. /*********** End %parse_accept code *******************************************/
  178337. sqlite3Fts5ParserARG_STORE; /* Suppress warning about unused %extra_argument variable */
  178338. }
  178339. /* The main parser program.
  178340. ** The first argument is a pointer to a structure obtained from
  178341. ** "sqlite3Fts5ParserAlloc" which describes the current state of the parser.
  178342. ** The second argument is the major token number. The third is
  178343. ** the minor token. The fourth optional argument is whatever the
  178344. ** user wants (and specified in the grammar) and is available for
  178345. ** use by the action routines.
  178346. **
  178347. ** Inputs:
  178348. ** <ul>
  178349. ** <li> A pointer to the parser (an opaque structure.)
  178350. ** <li> The major token number.
  178351. ** <li> The minor token number.
  178352. ** <li> An option argument of a grammar-specified type.
  178353. ** </ul>
  178354. **
  178355. ** Outputs:
  178356. ** None.
  178357. */
  178358. static void sqlite3Fts5Parser(
  178359. void *fts5yyp, /* The parser */
  178360. int fts5yymajor, /* The major token code number */
  178361. sqlite3Fts5ParserFTS5TOKENTYPE fts5yyminor /* The value for the token */
  178362. sqlite3Fts5ParserARG_PDECL /* Optional %extra_argument parameter */
  178363. ){
  178364. fts5YYMINORTYPE fts5yyminorunion;
  178365. unsigned int fts5yyact; /* The parser action. */
  178366. #if !defined(fts5YYERRORSYMBOL) && !defined(fts5YYNOERRORRECOVERY)
  178367. int fts5yyendofinput; /* True if we are at the end of input */
  178368. #endif
  178369. #ifdef fts5YYERRORSYMBOL
  178370. int fts5yyerrorhit = 0; /* True if fts5yymajor has invoked an error */
  178371. #endif
  178372. fts5yyParser *fts5yypParser; /* The parser */
  178373. fts5yypParser = (fts5yyParser*)fts5yyp;
  178374. assert( fts5yypParser->fts5yytos!=0 );
  178375. #if !defined(fts5YYERRORSYMBOL) && !defined(fts5YYNOERRORRECOVERY)
  178376. fts5yyendofinput = (fts5yymajor==0);
  178377. #endif
  178378. sqlite3Fts5ParserARG_STORE;
  178379. #ifndef NDEBUG
  178380. if( fts5yyTraceFILE ){
  178381. int stateno = fts5yypParser->fts5yytos->stateno;
  178382. if( stateno < fts5YY_MIN_REDUCE ){
  178383. fprintf(fts5yyTraceFILE,"%sInput '%s' in state %d\n",
  178384. fts5yyTracePrompt,fts5yyTokenName[fts5yymajor],stateno);
  178385. }else{
  178386. fprintf(fts5yyTraceFILE,"%sInput '%s' with pending reduce %d\n",
  178387. fts5yyTracePrompt,fts5yyTokenName[fts5yymajor],stateno-fts5YY_MIN_REDUCE);
  178388. }
  178389. }
  178390. #endif
  178391. do{
  178392. fts5yyact = fts5yy_find_shift_action(fts5yypParser,(fts5YYCODETYPE)fts5yymajor);
  178393. if( fts5yyact >= fts5YY_MIN_REDUCE ){
  178394. fts5yy_reduce(fts5yypParser,fts5yyact-fts5YY_MIN_REDUCE,fts5yymajor,fts5yyminor);
  178395. }else if( fts5yyact <= fts5YY_MAX_SHIFTREDUCE ){
  178396. fts5yy_shift(fts5yypParser,fts5yyact,fts5yymajor,fts5yyminor);
  178397. #ifndef fts5YYNOERRORRECOVERY
  178398. fts5yypParser->fts5yyerrcnt--;
  178399. #endif
  178400. fts5yymajor = fts5YYNOCODE;
  178401. }else if( fts5yyact==fts5YY_ACCEPT_ACTION ){
  178402. fts5yypParser->fts5yytos--;
  178403. fts5yy_accept(fts5yypParser);
  178404. return;
  178405. }else{
  178406. assert( fts5yyact == fts5YY_ERROR_ACTION );
  178407. fts5yyminorunion.fts5yy0 = fts5yyminor;
  178408. #ifdef fts5YYERRORSYMBOL
  178409. int fts5yymx;
  178410. #endif
  178411. #ifndef NDEBUG
  178412. if( fts5yyTraceFILE ){
  178413. fprintf(fts5yyTraceFILE,"%sSyntax Error!\n",fts5yyTracePrompt);
  178414. }
  178415. #endif
  178416. #ifdef fts5YYERRORSYMBOL
  178417. /* A syntax error has occurred.
  178418. ** The response to an error depends upon whether or not the
  178419. ** grammar defines an error token "ERROR".
  178420. **
  178421. ** This is what we do if the grammar does define ERROR:
  178422. **
  178423. ** * Call the %syntax_error function.
  178424. **
  178425. ** * Begin popping the stack until we enter a state where
  178426. ** it is legal to shift the error symbol, then shift
  178427. ** the error symbol.
  178428. **
  178429. ** * Set the error count to three.
  178430. **
  178431. ** * Begin accepting and shifting new tokens. No new error
  178432. ** processing will occur until three tokens have been
  178433. ** shifted successfully.
  178434. **
  178435. */
  178436. if( fts5yypParser->fts5yyerrcnt<0 ){
  178437. fts5yy_syntax_error(fts5yypParser,fts5yymajor,fts5yyminor);
  178438. }
  178439. fts5yymx = fts5yypParser->fts5yytos->major;
  178440. if( fts5yymx==fts5YYERRORSYMBOL || fts5yyerrorhit ){
  178441. #ifndef NDEBUG
  178442. if( fts5yyTraceFILE ){
  178443. fprintf(fts5yyTraceFILE,"%sDiscard input token %s\n",
  178444. fts5yyTracePrompt,fts5yyTokenName[fts5yymajor]);
  178445. }
  178446. #endif
  178447. fts5yy_destructor(fts5yypParser, (fts5YYCODETYPE)fts5yymajor, &fts5yyminorunion);
  178448. fts5yymajor = fts5YYNOCODE;
  178449. }else{
  178450. while( fts5yypParser->fts5yytos >= fts5yypParser->fts5yystack
  178451. && fts5yymx != fts5YYERRORSYMBOL
  178452. && (fts5yyact = fts5yy_find_reduce_action(
  178453. fts5yypParser->fts5yytos->stateno,
  178454. fts5YYERRORSYMBOL)) >= fts5YY_MIN_REDUCE
  178455. ){
  178456. fts5yy_pop_parser_stack(fts5yypParser);
  178457. }
  178458. if( fts5yypParser->fts5yytos < fts5yypParser->fts5yystack || fts5yymajor==0 ){
  178459. fts5yy_destructor(fts5yypParser,(fts5YYCODETYPE)fts5yymajor,&fts5yyminorunion);
  178460. fts5yy_parse_failed(fts5yypParser);
  178461. #ifndef fts5YYNOERRORRECOVERY
  178462. fts5yypParser->fts5yyerrcnt = -1;
  178463. #endif
  178464. fts5yymajor = fts5YYNOCODE;
  178465. }else if( fts5yymx!=fts5YYERRORSYMBOL ){
  178466. fts5yy_shift(fts5yypParser,fts5yyact,fts5YYERRORSYMBOL,fts5yyminor);
  178467. }
  178468. }
  178469. fts5yypParser->fts5yyerrcnt = 3;
  178470. fts5yyerrorhit = 1;
  178471. #elif defined(fts5YYNOERRORRECOVERY)
  178472. /* If the fts5YYNOERRORRECOVERY macro is defined, then do not attempt to
  178473. ** do any kind of error recovery. Instead, simply invoke the syntax
  178474. ** error routine and continue going as if nothing had happened.
  178475. **
  178476. ** Applications can set this macro (for example inside %include) if
  178477. ** they intend to abandon the parse upon the first syntax error seen.
  178478. */
  178479. fts5yy_syntax_error(fts5yypParser,fts5yymajor, fts5yyminor);
  178480. fts5yy_destructor(fts5yypParser,(fts5YYCODETYPE)fts5yymajor,&fts5yyminorunion);
  178481. fts5yymajor = fts5YYNOCODE;
  178482. #else /* fts5YYERRORSYMBOL is not defined */
  178483. /* This is what we do if the grammar does not define ERROR:
  178484. **
  178485. ** * Report an error message, and throw away the input token.
  178486. **
  178487. ** * If the input token is $, then fail the parse.
  178488. **
  178489. ** As before, subsequent error messages are suppressed until
  178490. ** three input tokens have been successfully shifted.
  178491. */
  178492. if( fts5yypParser->fts5yyerrcnt<=0 ){
  178493. fts5yy_syntax_error(fts5yypParser,fts5yymajor, fts5yyminor);
  178494. }
  178495. fts5yypParser->fts5yyerrcnt = 3;
  178496. fts5yy_destructor(fts5yypParser,(fts5YYCODETYPE)fts5yymajor,&fts5yyminorunion);
  178497. if( fts5yyendofinput ){
  178498. fts5yy_parse_failed(fts5yypParser);
  178499. #ifndef fts5YYNOERRORRECOVERY
  178500. fts5yypParser->fts5yyerrcnt = -1;
  178501. #endif
  178502. }
  178503. fts5yymajor = fts5YYNOCODE;
  178504. #endif
  178505. }
  178506. }while( fts5yymajor!=fts5YYNOCODE && fts5yypParser->fts5yytos>fts5yypParser->fts5yystack );
  178507. #ifndef NDEBUG
  178508. if( fts5yyTraceFILE ){
  178509. fts5yyStackEntry *i;
  178510. char cDiv = '[';
  178511. fprintf(fts5yyTraceFILE,"%sReturn. Stack=",fts5yyTracePrompt);
  178512. for(i=&fts5yypParser->fts5yystack[1]; i<=fts5yypParser->fts5yytos; i++){
  178513. fprintf(fts5yyTraceFILE,"%c%s", cDiv, fts5yyTokenName[i->major]);
  178514. cDiv = ' ';
  178515. }
  178516. fprintf(fts5yyTraceFILE,"]\n");
  178517. }
  178518. #endif
  178519. return;
  178520. }
  178521. /*
  178522. ** 2014 May 31
  178523. **
  178524. ** The author disclaims copyright to this source code. In place of
  178525. ** a legal notice, here is a blessing:
  178526. **
  178527. ** May you do good and not evil.
  178528. ** May you find forgiveness for yourself and forgive others.
  178529. ** May you share freely, never taking more than you give.
  178530. **
  178531. ******************************************************************************
  178532. */
  178533. /* #include "fts5Int.h" */
  178534. #include <math.h> /* amalgamator: keep */
  178535. /*
  178536. ** Object used to iterate through all "coalesced phrase instances" in
  178537. ** a single column of the current row. If the phrase instances in the
  178538. ** column being considered do not overlap, this object simply iterates
  178539. ** through them. Or, if they do overlap (share one or more tokens in
  178540. ** common), each set of overlapping instances is treated as a single
  178541. ** match. See documentation for the highlight() auxiliary function for
  178542. ** details.
  178543. **
  178544. ** Usage is:
  178545. **
  178546. ** for(rc = fts5CInstIterNext(pApi, pFts, iCol, &iter);
  178547. ** (rc==SQLITE_OK && 0==fts5CInstIterEof(&iter);
  178548. ** rc = fts5CInstIterNext(&iter)
  178549. ** ){
  178550. ** printf("instance starts at %d, ends at %d\n", iter.iStart, iter.iEnd);
  178551. ** }
  178552. **
  178553. */
  178554. typedef struct CInstIter CInstIter;
  178555. struct CInstIter {
  178556. const Fts5ExtensionApi *pApi; /* API offered by current FTS version */
  178557. Fts5Context *pFts; /* First arg to pass to pApi functions */
  178558. int iCol; /* Column to search */
  178559. int iInst; /* Next phrase instance index */
  178560. int nInst; /* Total number of phrase instances */
  178561. /* Output variables */
  178562. int iStart; /* First token in coalesced phrase instance */
  178563. int iEnd; /* Last token in coalesced phrase instance */
  178564. };
  178565. /*
  178566. ** Advance the iterator to the next coalesced phrase instance. Return
  178567. ** an SQLite error code if an error occurs, or SQLITE_OK otherwise.
  178568. */
  178569. static int fts5CInstIterNext(CInstIter *pIter){
  178570. int rc = SQLITE_OK;
  178571. pIter->iStart = -1;
  178572. pIter->iEnd = -1;
  178573. while( rc==SQLITE_OK && pIter->iInst<pIter->nInst ){
  178574. int ip; int ic; int io;
  178575. rc = pIter->pApi->xInst(pIter->pFts, pIter->iInst, &ip, &ic, &io);
  178576. if( rc==SQLITE_OK ){
  178577. if( ic==pIter->iCol ){
  178578. int iEnd = io - 1 + pIter->pApi->xPhraseSize(pIter->pFts, ip);
  178579. if( pIter->iStart<0 ){
  178580. pIter->iStart = io;
  178581. pIter->iEnd = iEnd;
  178582. }else if( io<=pIter->iEnd ){
  178583. if( iEnd>pIter->iEnd ) pIter->iEnd = iEnd;
  178584. }else{
  178585. break;
  178586. }
  178587. }
  178588. pIter->iInst++;
  178589. }
  178590. }
  178591. return rc;
  178592. }
  178593. /*
  178594. ** Initialize the iterator object indicated by the final parameter to
  178595. ** iterate through coalesced phrase instances in column iCol.
  178596. */
  178597. static int fts5CInstIterInit(
  178598. const Fts5ExtensionApi *pApi,
  178599. Fts5Context *pFts,
  178600. int iCol,
  178601. CInstIter *pIter
  178602. ){
  178603. int rc;
  178604. memset(pIter, 0, sizeof(CInstIter));
  178605. pIter->pApi = pApi;
  178606. pIter->pFts = pFts;
  178607. pIter->iCol = iCol;
  178608. rc = pApi->xInstCount(pFts, &pIter->nInst);
  178609. if( rc==SQLITE_OK ){
  178610. rc = fts5CInstIterNext(pIter);
  178611. }
  178612. return rc;
  178613. }
  178614. /*************************************************************************
  178615. ** Start of highlight() implementation.
  178616. */
  178617. typedef struct HighlightContext HighlightContext;
  178618. struct HighlightContext {
  178619. CInstIter iter; /* Coalesced Instance Iterator */
  178620. int iPos; /* Current token offset in zIn[] */
  178621. int iRangeStart; /* First token to include */
  178622. int iRangeEnd; /* If non-zero, last token to include */
  178623. const char *zOpen; /* Opening highlight */
  178624. const char *zClose; /* Closing highlight */
  178625. const char *zIn; /* Input text */
  178626. int nIn; /* Size of input text in bytes */
  178627. int iOff; /* Current offset within zIn[] */
  178628. char *zOut; /* Output value */
  178629. };
  178630. /*
  178631. ** Append text to the HighlightContext output string - p->zOut. Argument
  178632. ** z points to a buffer containing n bytes of text to append. If n is
  178633. ** negative, everything up until the first '\0' is appended to the output.
  178634. **
  178635. ** If *pRc is set to any value other than SQLITE_OK when this function is
  178636. ** called, it is a no-op. If an error (i.e. an OOM condition) is encountered,
  178637. ** *pRc is set to an error code before returning.
  178638. */
  178639. static void fts5HighlightAppend(
  178640. int *pRc,
  178641. HighlightContext *p,
  178642. const char *z, int n
  178643. ){
  178644. if( *pRc==SQLITE_OK ){
  178645. if( n<0 ) n = (int)strlen(z);
  178646. p->zOut = sqlite3_mprintf("%z%.*s", p->zOut, n, z);
  178647. if( p->zOut==0 ) *pRc = SQLITE_NOMEM;
  178648. }
  178649. }
  178650. /*
  178651. ** Tokenizer callback used by implementation of highlight() function.
  178652. */
  178653. static int fts5HighlightCb(
  178654. void *pContext, /* Pointer to HighlightContext object */
  178655. int tflags, /* Mask of FTS5_TOKEN_* flags */
  178656. const char *pToken, /* Buffer containing token */
  178657. int nToken, /* Size of token in bytes */
  178658. int iStartOff, /* Start offset of token */
  178659. int iEndOff /* End offset of token */
  178660. ){
  178661. HighlightContext *p = (HighlightContext*)pContext;
  178662. int rc = SQLITE_OK;
  178663. int iPos;
  178664. UNUSED_PARAM2(pToken, nToken);
  178665. if( tflags & FTS5_TOKEN_COLOCATED ) return SQLITE_OK;
  178666. iPos = p->iPos++;
  178667. if( p->iRangeEnd>0 ){
  178668. if( iPos<p->iRangeStart || iPos>p->iRangeEnd ) return SQLITE_OK;
  178669. if( p->iRangeStart && iPos==p->iRangeStart ) p->iOff = iStartOff;
  178670. }
  178671. if( iPos==p->iter.iStart ){
  178672. fts5HighlightAppend(&rc, p, &p->zIn[p->iOff], iStartOff - p->iOff);
  178673. fts5HighlightAppend(&rc, p, p->zOpen, -1);
  178674. p->iOff = iStartOff;
  178675. }
  178676. if( iPos==p->iter.iEnd ){
  178677. if( p->iRangeEnd && p->iter.iStart<p->iRangeStart ){
  178678. fts5HighlightAppend(&rc, p, p->zOpen, -1);
  178679. }
  178680. fts5HighlightAppend(&rc, p, &p->zIn[p->iOff], iEndOff - p->iOff);
  178681. fts5HighlightAppend(&rc, p, p->zClose, -1);
  178682. p->iOff = iEndOff;
  178683. if( rc==SQLITE_OK ){
  178684. rc = fts5CInstIterNext(&p->iter);
  178685. }
  178686. }
  178687. if( p->iRangeEnd>0 && iPos==p->iRangeEnd ){
  178688. fts5HighlightAppend(&rc, p, &p->zIn[p->iOff], iEndOff - p->iOff);
  178689. p->iOff = iEndOff;
  178690. if( iPos>=p->iter.iStart && iPos<p->iter.iEnd ){
  178691. fts5HighlightAppend(&rc, p, p->zClose, -1);
  178692. }
  178693. }
  178694. return rc;
  178695. }
  178696. /*
  178697. ** Implementation of highlight() function.
  178698. */
  178699. static void fts5HighlightFunction(
  178700. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  178701. Fts5Context *pFts, /* First arg to pass to pApi functions */
  178702. sqlite3_context *pCtx, /* Context for returning result/error */
  178703. int nVal, /* Number of values in apVal[] array */
  178704. sqlite3_value **apVal /* Array of trailing arguments */
  178705. ){
  178706. HighlightContext ctx;
  178707. int rc;
  178708. int iCol;
  178709. if( nVal!=3 ){
  178710. const char *zErr = "wrong number of arguments to function highlight()";
  178711. sqlite3_result_error(pCtx, zErr, -1);
  178712. return;
  178713. }
  178714. iCol = sqlite3_value_int(apVal[0]);
  178715. memset(&ctx, 0, sizeof(HighlightContext));
  178716. ctx.zOpen = (const char*)sqlite3_value_text(apVal[1]);
  178717. ctx.zClose = (const char*)sqlite3_value_text(apVal[2]);
  178718. rc = pApi->xColumnText(pFts, iCol, &ctx.zIn, &ctx.nIn);
  178719. if( ctx.zIn ){
  178720. if( rc==SQLITE_OK ){
  178721. rc = fts5CInstIterInit(pApi, pFts, iCol, &ctx.iter);
  178722. }
  178723. if( rc==SQLITE_OK ){
  178724. rc = pApi->xTokenize(pFts, ctx.zIn, ctx.nIn, (void*)&ctx,fts5HighlightCb);
  178725. }
  178726. fts5HighlightAppend(&rc, &ctx, &ctx.zIn[ctx.iOff], ctx.nIn - ctx.iOff);
  178727. if( rc==SQLITE_OK ){
  178728. sqlite3_result_text(pCtx, (const char*)ctx.zOut, -1, SQLITE_TRANSIENT);
  178729. }
  178730. sqlite3_free(ctx.zOut);
  178731. }
  178732. if( rc!=SQLITE_OK ){
  178733. sqlite3_result_error_code(pCtx, rc);
  178734. }
  178735. }
  178736. /*
  178737. ** End of highlight() implementation.
  178738. **************************************************************************/
  178739. /*
  178740. ** Context object passed to the fts5SentenceFinderCb() function.
  178741. */
  178742. typedef struct Fts5SFinder Fts5SFinder;
  178743. struct Fts5SFinder {
  178744. int iPos; /* Current token position */
  178745. int nFirstAlloc; /* Allocated size of aFirst[] */
  178746. int nFirst; /* Number of entries in aFirst[] */
  178747. int *aFirst; /* Array of first token in each sentence */
  178748. const char *zDoc; /* Document being tokenized */
  178749. };
  178750. /*
  178751. ** Add an entry to the Fts5SFinder.aFirst[] array. Grow the array if
  178752. ** necessary. Return SQLITE_OK if successful, or SQLITE_NOMEM if an
  178753. ** error occurs.
  178754. */
  178755. static int fts5SentenceFinderAdd(Fts5SFinder *p, int iAdd){
  178756. if( p->nFirstAlloc==p->nFirst ){
  178757. int nNew = p->nFirstAlloc ? p->nFirstAlloc*2 : 64;
  178758. int *aNew;
  178759. aNew = (int*)sqlite3_realloc(p->aFirst, nNew*sizeof(int));
  178760. if( aNew==0 ) return SQLITE_NOMEM;
  178761. p->aFirst = aNew;
  178762. p->nFirstAlloc = nNew;
  178763. }
  178764. p->aFirst[p->nFirst++] = iAdd;
  178765. return SQLITE_OK;
  178766. }
  178767. /*
  178768. ** This function is an xTokenize() callback used by the auxiliary snippet()
  178769. ** function. Its job is to identify tokens that are the first in a sentence.
  178770. ** For each such token, an entry is added to the SFinder.aFirst[] array.
  178771. */
  178772. static int fts5SentenceFinderCb(
  178773. void *pContext, /* Pointer to HighlightContext object */
  178774. int tflags, /* Mask of FTS5_TOKEN_* flags */
  178775. const char *pToken, /* Buffer containing token */
  178776. int nToken, /* Size of token in bytes */
  178777. int iStartOff, /* Start offset of token */
  178778. int iEndOff /* End offset of token */
  178779. ){
  178780. int rc = SQLITE_OK;
  178781. UNUSED_PARAM2(pToken, nToken);
  178782. UNUSED_PARAM(iEndOff);
  178783. if( (tflags & FTS5_TOKEN_COLOCATED)==0 ){
  178784. Fts5SFinder *p = (Fts5SFinder*)pContext;
  178785. if( p->iPos>0 ){
  178786. int i;
  178787. char c = 0;
  178788. for(i=iStartOff-1; i>=0; i--){
  178789. c = p->zDoc[i];
  178790. if( c!=' ' && c!='\t' && c!='\n' && c!='\r' ) break;
  178791. }
  178792. if( i!=iStartOff-1 && (c=='.' || c==':') ){
  178793. rc = fts5SentenceFinderAdd(p, p->iPos);
  178794. }
  178795. }else{
  178796. rc = fts5SentenceFinderAdd(p, 0);
  178797. }
  178798. p->iPos++;
  178799. }
  178800. return rc;
  178801. }
  178802. static int fts5SnippetScore(
  178803. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  178804. Fts5Context *pFts, /* First arg to pass to pApi functions */
  178805. int nDocsize, /* Size of column in tokens */
  178806. unsigned char *aSeen, /* Array with one element per query phrase */
  178807. int iCol, /* Column to score */
  178808. int iPos, /* Starting offset to score */
  178809. int nToken, /* Max tokens per snippet */
  178810. int *pnScore, /* OUT: Score */
  178811. int *piPos /* OUT: Adjusted offset */
  178812. ){
  178813. int rc;
  178814. int i;
  178815. int ip = 0;
  178816. int ic = 0;
  178817. int iOff = 0;
  178818. int iFirst = -1;
  178819. int nInst;
  178820. int nScore = 0;
  178821. int iLast = 0;
  178822. rc = pApi->xInstCount(pFts, &nInst);
  178823. for(i=0; i<nInst && rc==SQLITE_OK; i++){
  178824. rc = pApi->xInst(pFts, i, &ip, &ic, &iOff);
  178825. if( rc==SQLITE_OK && ic==iCol && iOff>=iPos && iOff<(iPos+nToken) ){
  178826. nScore += (aSeen[ip] ? 1 : 1000);
  178827. aSeen[ip] = 1;
  178828. if( iFirst<0 ) iFirst = iOff;
  178829. iLast = iOff + pApi->xPhraseSize(pFts, ip);
  178830. }
  178831. }
  178832. *pnScore = nScore;
  178833. if( piPos ){
  178834. int iAdj = iFirst - (nToken - (iLast-iFirst)) / 2;
  178835. if( (iAdj+nToken)>nDocsize ) iAdj = nDocsize - nToken;
  178836. if( iAdj<0 ) iAdj = 0;
  178837. *piPos = iAdj;
  178838. }
  178839. return rc;
  178840. }
  178841. /*
  178842. ** Return the value in pVal interpreted as utf-8 text. Except, if pVal
  178843. ** contains a NULL value, return a pointer to a static string zero
  178844. ** bytes in length instead of a NULL pointer.
  178845. */
  178846. static const char *fts5ValueToText(sqlite3_value *pVal){
  178847. const char *zRet = (const char*)sqlite3_value_text(pVal);
  178848. return zRet ? zRet : "";
  178849. }
  178850. /*
  178851. ** Implementation of snippet() function.
  178852. */
  178853. static void fts5SnippetFunction(
  178854. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  178855. Fts5Context *pFts, /* First arg to pass to pApi functions */
  178856. sqlite3_context *pCtx, /* Context for returning result/error */
  178857. int nVal, /* Number of values in apVal[] array */
  178858. sqlite3_value **apVal /* Array of trailing arguments */
  178859. ){
  178860. HighlightContext ctx;
  178861. int rc = SQLITE_OK; /* Return code */
  178862. int iCol; /* 1st argument to snippet() */
  178863. const char *zEllips; /* 4th argument to snippet() */
  178864. int nToken; /* 5th argument to snippet() */
  178865. int nInst = 0; /* Number of instance matches this row */
  178866. int i; /* Used to iterate through instances */
  178867. int nPhrase; /* Number of phrases in query */
  178868. unsigned char *aSeen; /* Array of "seen instance" flags */
  178869. int iBestCol; /* Column containing best snippet */
  178870. int iBestStart = 0; /* First token of best snippet */
  178871. int nBestScore = 0; /* Score of best snippet */
  178872. int nColSize = 0; /* Total size of iBestCol in tokens */
  178873. Fts5SFinder sFinder; /* Used to find the beginnings of sentences */
  178874. int nCol;
  178875. if( nVal!=5 ){
  178876. const char *zErr = "wrong number of arguments to function snippet()";
  178877. sqlite3_result_error(pCtx, zErr, -1);
  178878. return;
  178879. }
  178880. nCol = pApi->xColumnCount(pFts);
  178881. memset(&ctx, 0, sizeof(HighlightContext));
  178882. iCol = sqlite3_value_int(apVal[0]);
  178883. ctx.zOpen = fts5ValueToText(apVal[1]);
  178884. ctx.zClose = fts5ValueToText(apVal[2]);
  178885. zEllips = fts5ValueToText(apVal[3]);
  178886. nToken = sqlite3_value_int(apVal[4]);
  178887. iBestCol = (iCol>=0 ? iCol : 0);
  178888. nPhrase = pApi->xPhraseCount(pFts);
  178889. aSeen = sqlite3_malloc(nPhrase);
  178890. if( aSeen==0 ){
  178891. rc = SQLITE_NOMEM;
  178892. }
  178893. if( rc==SQLITE_OK ){
  178894. rc = pApi->xInstCount(pFts, &nInst);
  178895. }
  178896. memset(&sFinder, 0, sizeof(Fts5SFinder));
  178897. for(i=0; i<nCol; i++){
  178898. if( iCol<0 || iCol==i ){
  178899. int nDoc;
  178900. int nDocsize;
  178901. int ii;
  178902. sFinder.iPos = 0;
  178903. sFinder.nFirst = 0;
  178904. rc = pApi->xColumnText(pFts, i, &sFinder.zDoc, &nDoc);
  178905. if( rc!=SQLITE_OK ) break;
  178906. rc = pApi->xTokenize(pFts,
  178907. sFinder.zDoc, nDoc, (void*)&sFinder,fts5SentenceFinderCb
  178908. );
  178909. if( rc!=SQLITE_OK ) break;
  178910. rc = pApi->xColumnSize(pFts, i, &nDocsize);
  178911. if( rc!=SQLITE_OK ) break;
  178912. for(ii=0; rc==SQLITE_OK && ii<nInst; ii++){
  178913. int ip, ic, io;
  178914. int iAdj;
  178915. int nScore;
  178916. int jj;
  178917. rc = pApi->xInst(pFts, ii, &ip, &ic, &io);
  178918. if( ic!=i || rc!=SQLITE_OK ) continue;
  178919. memset(aSeen, 0, nPhrase);
  178920. rc = fts5SnippetScore(pApi, pFts, nDocsize, aSeen, i,
  178921. io, nToken, &nScore, &iAdj
  178922. );
  178923. if( rc==SQLITE_OK && nScore>nBestScore ){
  178924. nBestScore = nScore;
  178925. iBestCol = i;
  178926. iBestStart = iAdj;
  178927. nColSize = nDocsize;
  178928. }
  178929. if( rc==SQLITE_OK && sFinder.nFirst && nDocsize>nToken ){
  178930. for(jj=0; jj<(sFinder.nFirst-1); jj++){
  178931. if( sFinder.aFirst[jj+1]>io ) break;
  178932. }
  178933. if( sFinder.aFirst[jj]<io ){
  178934. memset(aSeen, 0, nPhrase);
  178935. rc = fts5SnippetScore(pApi, pFts, nDocsize, aSeen, i,
  178936. sFinder.aFirst[jj], nToken, &nScore, 0
  178937. );
  178938. nScore += (sFinder.aFirst[jj]==0 ? 120 : 100);
  178939. if( rc==SQLITE_OK && nScore>nBestScore ){
  178940. nBestScore = nScore;
  178941. iBestCol = i;
  178942. iBestStart = sFinder.aFirst[jj];
  178943. nColSize = nDocsize;
  178944. }
  178945. }
  178946. }
  178947. }
  178948. }
  178949. }
  178950. if( rc==SQLITE_OK ){
  178951. rc = pApi->xColumnText(pFts, iBestCol, &ctx.zIn, &ctx.nIn);
  178952. }
  178953. if( rc==SQLITE_OK && nColSize==0 ){
  178954. rc = pApi->xColumnSize(pFts, iBestCol, &nColSize);
  178955. }
  178956. if( ctx.zIn ){
  178957. if( rc==SQLITE_OK ){
  178958. rc = fts5CInstIterInit(pApi, pFts, iBestCol, &ctx.iter);
  178959. }
  178960. ctx.iRangeStart = iBestStart;
  178961. ctx.iRangeEnd = iBestStart + nToken - 1;
  178962. if( iBestStart>0 ){
  178963. fts5HighlightAppend(&rc, &ctx, zEllips, -1);
  178964. }
  178965. /* Advance iterator ctx.iter so that it points to the first coalesced
  178966. ** phrase instance at or following position iBestStart. */
  178967. while( ctx.iter.iStart>=0 && ctx.iter.iStart<iBestStart && rc==SQLITE_OK ){
  178968. rc = fts5CInstIterNext(&ctx.iter);
  178969. }
  178970. if( rc==SQLITE_OK ){
  178971. rc = pApi->xTokenize(pFts, ctx.zIn, ctx.nIn, (void*)&ctx,fts5HighlightCb);
  178972. }
  178973. if( ctx.iRangeEnd>=(nColSize-1) ){
  178974. fts5HighlightAppend(&rc, &ctx, &ctx.zIn[ctx.iOff], ctx.nIn - ctx.iOff);
  178975. }else{
  178976. fts5HighlightAppend(&rc, &ctx, zEllips, -1);
  178977. }
  178978. }
  178979. if( rc==SQLITE_OK ){
  178980. sqlite3_result_text(pCtx, (const char*)ctx.zOut, -1, SQLITE_TRANSIENT);
  178981. }else{
  178982. sqlite3_result_error_code(pCtx, rc);
  178983. }
  178984. sqlite3_free(ctx.zOut);
  178985. sqlite3_free(aSeen);
  178986. sqlite3_free(sFinder.aFirst);
  178987. }
  178988. /************************************************************************/
  178989. /*
  178990. ** The first time the bm25() function is called for a query, an instance
  178991. ** of the following structure is allocated and populated.
  178992. */
  178993. typedef struct Fts5Bm25Data Fts5Bm25Data;
  178994. struct Fts5Bm25Data {
  178995. int nPhrase; /* Number of phrases in query */
  178996. double avgdl; /* Average number of tokens in each row */
  178997. double *aIDF; /* IDF for each phrase */
  178998. double *aFreq; /* Array used to calculate phrase freq. */
  178999. };
  179000. /*
  179001. ** Callback used by fts5Bm25GetData() to count the number of rows in the
  179002. ** table matched by each individual phrase within the query.
  179003. */
  179004. static int fts5CountCb(
  179005. const Fts5ExtensionApi *pApi,
  179006. Fts5Context *pFts,
  179007. void *pUserData /* Pointer to sqlite3_int64 variable */
  179008. ){
  179009. sqlite3_int64 *pn = (sqlite3_int64*)pUserData;
  179010. UNUSED_PARAM2(pApi, pFts);
  179011. (*pn)++;
  179012. return SQLITE_OK;
  179013. }
  179014. /*
  179015. ** Set *ppData to point to the Fts5Bm25Data object for the current query.
  179016. ** If the object has not already been allocated, allocate and populate it
  179017. ** now.
  179018. */
  179019. static int fts5Bm25GetData(
  179020. const Fts5ExtensionApi *pApi,
  179021. Fts5Context *pFts,
  179022. Fts5Bm25Data **ppData /* OUT: bm25-data object for this query */
  179023. ){
  179024. int rc = SQLITE_OK; /* Return code */
  179025. Fts5Bm25Data *p; /* Object to return */
  179026. p = pApi->xGetAuxdata(pFts, 0);
  179027. if( p==0 ){
  179028. int nPhrase; /* Number of phrases in query */
  179029. sqlite3_int64 nRow = 0; /* Number of rows in table */
  179030. sqlite3_int64 nToken = 0; /* Number of tokens in table */
  179031. int nByte; /* Bytes of space to allocate */
  179032. int i;
  179033. /* Allocate the Fts5Bm25Data object */
  179034. nPhrase = pApi->xPhraseCount(pFts);
  179035. nByte = sizeof(Fts5Bm25Data) + nPhrase*2*sizeof(double);
  179036. p = (Fts5Bm25Data*)sqlite3_malloc(nByte);
  179037. if( p==0 ){
  179038. rc = SQLITE_NOMEM;
  179039. }else{
  179040. memset(p, 0, nByte);
  179041. p->nPhrase = nPhrase;
  179042. p->aIDF = (double*)&p[1];
  179043. p->aFreq = &p->aIDF[nPhrase];
  179044. }
  179045. /* Calculate the average document length for this FTS5 table */
  179046. if( rc==SQLITE_OK ) rc = pApi->xRowCount(pFts, &nRow);
  179047. if( rc==SQLITE_OK ) rc = pApi->xColumnTotalSize(pFts, -1, &nToken);
  179048. if( rc==SQLITE_OK ) p->avgdl = (double)nToken / (double)nRow;
  179049. /* Calculate an IDF for each phrase in the query */
  179050. for(i=0; rc==SQLITE_OK && i<nPhrase; i++){
  179051. sqlite3_int64 nHit = 0;
  179052. rc = pApi->xQueryPhrase(pFts, i, (void*)&nHit, fts5CountCb);
  179053. if( rc==SQLITE_OK ){
  179054. /* Calculate the IDF (Inverse Document Frequency) for phrase i.
  179055. ** This is done using the standard BM25 formula as found on wikipedia:
  179056. **
  179057. ** IDF = log( (N - nHit + 0.5) / (nHit + 0.5) )
  179058. **
  179059. ** where "N" is the total number of documents in the set and nHit
  179060. ** is the number that contain at least one instance of the phrase
  179061. ** under consideration.
  179062. **
  179063. ** The problem with this is that if (N < 2*nHit), the IDF is
  179064. ** negative. Which is undesirable. So the mimimum allowable IDF is
  179065. ** (1e-6) - roughly the same as a term that appears in just over
  179066. ** half of set of 5,000,000 documents. */
  179067. double idf = log( (nRow - nHit + 0.5) / (nHit + 0.5) );
  179068. if( idf<=0.0 ) idf = 1e-6;
  179069. p->aIDF[i] = idf;
  179070. }
  179071. }
  179072. if( rc!=SQLITE_OK ){
  179073. sqlite3_free(p);
  179074. }else{
  179075. rc = pApi->xSetAuxdata(pFts, p, sqlite3_free);
  179076. }
  179077. if( rc!=SQLITE_OK ) p = 0;
  179078. }
  179079. *ppData = p;
  179080. return rc;
  179081. }
  179082. /*
  179083. ** Implementation of bm25() function.
  179084. */
  179085. static void fts5Bm25Function(
  179086. const Fts5ExtensionApi *pApi, /* API offered by current FTS version */
  179087. Fts5Context *pFts, /* First arg to pass to pApi functions */
  179088. sqlite3_context *pCtx, /* Context for returning result/error */
  179089. int nVal, /* Number of values in apVal[] array */
  179090. sqlite3_value **apVal /* Array of trailing arguments */
  179091. ){
  179092. const double k1 = 1.2; /* Constant "k1" from BM25 formula */
  179093. const double b = 0.75; /* Constant "b" from BM25 formula */
  179094. int rc = SQLITE_OK; /* Error code */
  179095. double score = 0.0; /* SQL function return value */
  179096. Fts5Bm25Data *pData; /* Values allocated/calculated once only */
  179097. int i; /* Iterator variable */
  179098. int nInst = 0; /* Value returned by xInstCount() */
  179099. double D = 0.0; /* Total number of tokens in row */
  179100. double *aFreq = 0; /* Array of phrase freq. for current row */
  179101. /* Calculate the phrase frequency (symbol "f(qi,D)" in the documentation)
  179102. ** for each phrase in the query for the current row. */
  179103. rc = fts5Bm25GetData(pApi, pFts, &pData);
  179104. if( rc==SQLITE_OK ){
  179105. aFreq = pData->aFreq;
  179106. memset(aFreq, 0, sizeof(double) * pData->nPhrase);
  179107. rc = pApi->xInstCount(pFts, &nInst);
  179108. }
  179109. for(i=0; rc==SQLITE_OK && i<nInst; i++){
  179110. int ip; int ic; int io;
  179111. rc = pApi->xInst(pFts, i, &ip, &ic, &io);
  179112. if( rc==SQLITE_OK ){
  179113. double w = (nVal > ic) ? sqlite3_value_double(apVal[ic]) : 1.0;
  179114. aFreq[ip] += w;
  179115. }
  179116. }
  179117. /* Figure out the total size of the current row in tokens. */
  179118. if( rc==SQLITE_OK ){
  179119. int nTok;
  179120. rc = pApi->xColumnSize(pFts, -1, &nTok);
  179121. D = (double)nTok;
  179122. }
  179123. /* Determine the BM25 score for the current row. */
  179124. for(i=0; rc==SQLITE_OK && i<pData->nPhrase; i++){
  179125. score += pData->aIDF[i] * (
  179126. ( aFreq[i] * (k1 + 1.0) ) /
  179127. ( aFreq[i] + k1 * (1 - b + b * D / pData->avgdl) )
  179128. );
  179129. }
  179130. /* If no error has occurred, return the calculated score. Otherwise,
  179131. ** throw an SQL exception. */
  179132. if( rc==SQLITE_OK ){
  179133. sqlite3_result_double(pCtx, -1.0 * score);
  179134. }else{
  179135. sqlite3_result_error_code(pCtx, rc);
  179136. }
  179137. }
  179138. static int sqlite3Fts5AuxInit(fts5_api *pApi){
  179139. struct Builtin {
  179140. const char *zFunc; /* Function name (nul-terminated) */
  179141. void *pUserData; /* User-data pointer */
  179142. fts5_extension_function xFunc;/* Callback function */
  179143. void (*xDestroy)(void*); /* Destructor function */
  179144. } aBuiltin [] = {
  179145. { "snippet", 0, fts5SnippetFunction, 0 },
  179146. { "highlight", 0, fts5HighlightFunction, 0 },
  179147. { "bm25", 0, fts5Bm25Function, 0 },
  179148. };
  179149. int rc = SQLITE_OK; /* Return code */
  179150. int i; /* To iterate through builtin functions */
  179151. for(i=0; rc==SQLITE_OK && i<ArraySize(aBuiltin); i++){
  179152. rc = pApi->xCreateFunction(pApi,
  179153. aBuiltin[i].zFunc,
  179154. aBuiltin[i].pUserData,
  179155. aBuiltin[i].xFunc,
  179156. aBuiltin[i].xDestroy
  179157. );
  179158. }
  179159. return rc;
  179160. }
  179161. /*
  179162. ** 2014 May 31
  179163. **
  179164. ** The author disclaims copyright to this source code. In place of
  179165. ** a legal notice, here is a blessing:
  179166. **
  179167. ** May you do good and not evil.
  179168. ** May you find forgiveness for yourself and forgive others.
  179169. ** May you share freely, never taking more than you give.
  179170. **
  179171. ******************************************************************************
  179172. */
  179173. /* #include "fts5Int.h" */
  179174. static int sqlite3Fts5BufferSize(int *pRc, Fts5Buffer *pBuf, u32 nByte){
  179175. if( (u32)pBuf->nSpace<nByte ){
  179176. u32 nNew = pBuf->nSpace ? pBuf->nSpace : 64;
  179177. u8 *pNew;
  179178. while( nNew<nByte ){
  179179. nNew = nNew * 2;
  179180. }
  179181. pNew = sqlite3_realloc(pBuf->p, nNew);
  179182. if( pNew==0 ){
  179183. *pRc = SQLITE_NOMEM;
  179184. return 1;
  179185. }else{
  179186. pBuf->nSpace = nNew;
  179187. pBuf->p = pNew;
  179188. }
  179189. }
  179190. return 0;
  179191. }
  179192. /*
  179193. ** Encode value iVal as an SQLite varint and append it to the buffer object
  179194. ** pBuf. If an OOM error occurs, set the error code in p.
  179195. */
  179196. static void sqlite3Fts5BufferAppendVarint(int *pRc, Fts5Buffer *pBuf, i64 iVal){
  179197. if( fts5BufferGrow(pRc, pBuf, 9) ) return;
  179198. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], iVal);
  179199. }
  179200. static void sqlite3Fts5Put32(u8 *aBuf, int iVal){
  179201. aBuf[0] = (iVal>>24) & 0x00FF;
  179202. aBuf[1] = (iVal>>16) & 0x00FF;
  179203. aBuf[2] = (iVal>> 8) & 0x00FF;
  179204. aBuf[3] = (iVal>> 0) & 0x00FF;
  179205. }
  179206. static int sqlite3Fts5Get32(const u8 *aBuf){
  179207. return (aBuf[0] << 24) + (aBuf[1] << 16) + (aBuf[2] << 8) + aBuf[3];
  179208. }
  179209. /*
  179210. ** Append buffer nData/pData to buffer pBuf. If an OOM error occurs, set
  179211. ** the error code in p. If an error has already occurred when this function
  179212. ** is called, it is a no-op.
  179213. */
  179214. static void sqlite3Fts5BufferAppendBlob(
  179215. int *pRc,
  179216. Fts5Buffer *pBuf,
  179217. u32 nData,
  179218. const u8 *pData
  179219. ){
  179220. assert_nc( *pRc || nData>=0 );
  179221. if( nData ){
  179222. if( fts5BufferGrow(pRc, pBuf, nData) ) return;
  179223. memcpy(&pBuf->p[pBuf->n], pData, nData);
  179224. pBuf->n += nData;
  179225. }
  179226. }
  179227. /*
  179228. ** Append the nul-terminated string zStr to the buffer pBuf. This function
  179229. ** ensures that the byte following the buffer data is set to 0x00, even
  179230. ** though this byte is not included in the pBuf->n count.
  179231. */
  179232. static void sqlite3Fts5BufferAppendString(
  179233. int *pRc,
  179234. Fts5Buffer *pBuf,
  179235. const char *zStr
  179236. ){
  179237. int nStr = (int)strlen(zStr);
  179238. sqlite3Fts5BufferAppendBlob(pRc, pBuf, nStr+1, (const u8*)zStr);
  179239. pBuf->n--;
  179240. }
  179241. /*
  179242. ** Argument zFmt is a printf() style format string. This function performs
  179243. ** the printf() style processing, then appends the results to buffer pBuf.
  179244. **
  179245. ** Like sqlite3Fts5BufferAppendString(), this function ensures that the byte
  179246. ** following the buffer data is set to 0x00, even though this byte is not
  179247. ** included in the pBuf->n count.
  179248. */
  179249. static void sqlite3Fts5BufferAppendPrintf(
  179250. int *pRc,
  179251. Fts5Buffer *pBuf,
  179252. char *zFmt, ...
  179253. ){
  179254. if( *pRc==SQLITE_OK ){
  179255. char *zTmp;
  179256. va_list ap;
  179257. va_start(ap, zFmt);
  179258. zTmp = sqlite3_vmprintf(zFmt, ap);
  179259. va_end(ap);
  179260. if( zTmp==0 ){
  179261. *pRc = SQLITE_NOMEM;
  179262. }else{
  179263. sqlite3Fts5BufferAppendString(pRc, pBuf, zTmp);
  179264. sqlite3_free(zTmp);
  179265. }
  179266. }
  179267. }
  179268. static char *sqlite3Fts5Mprintf(int *pRc, const char *zFmt, ...){
  179269. char *zRet = 0;
  179270. if( *pRc==SQLITE_OK ){
  179271. va_list ap;
  179272. va_start(ap, zFmt);
  179273. zRet = sqlite3_vmprintf(zFmt, ap);
  179274. va_end(ap);
  179275. if( zRet==0 ){
  179276. *pRc = SQLITE_NOMEM;
  179277. }
  179278. }
  179279. return zRet;
  179280. }
  179281. /*
  179282. ** Free any buffer allocated by pBuf. Zero the structure before returning.
  179283. */
  179284. static void sqlite3Fts5BufferFree(Fts5Buffer *pBuf){
  179285. sqlite3_free(pBuf->p);
  179286. memset(pBuf, 0, sizeof(Fts5Buffer));
  179287. }
  179288. /*
  179289. ** Zero the contents of the buffer object. But do not free the associated
  179290. ** memory allocation.
  179291. */
  179292. static void sqlite3Fts5BufferZero(Fts5Buffer *pBuf){
  179293. pBuf->n = 0;
  179294. }
  179295. /*
  179296. ** Set the buffer to contain nData/pData. If an OOM error occurs, leave an
  179297. ** the error code in p. If an error has already occurred when this function
  179298. ** is called, it is a no-op.
  179299. */
  179300. static void sqlite3Fts5BufferSet(
  179301. int *pRc,
  179302. Fts5Buffer *pBuf,
  179303. int nData,
  179304. const u8 *pData
  179305. ){
  179306. pBuf->n = 0;
  179307. sqlite3Fts5BufferAppendBlob(pRc, pBuf, nData, pData);
  179308. }
  179309. static int sqlite3Fts5PoslistNext64(
  179310. const u8 *a, int n, /* Buffer containing poslist */
  179311. int *pi, /* IN/OUT: Offset within a[] */
  179312. i64 *piOff /* IN/OUT: Current offset */
  179313. ){
  179314. int i = *pi;
  179315. if( i>=n ){
  179316. /* EOF */
  179317. *piOff = -1;
  179318. return 1;
  179319. }else{
  179320. i64 iOff = *piOff;
  179321. int iVal;
  179322. fts5FastGetVarint32(a, i, iVal);
  179323. if( iVal==1 ){
  179324. fts5FastGetVarint32(a, i, iVal);
  179325. iOff = ((i64)iVal) << 32;
  179326. fts5FastGetVarint32(a, i, iVal);
  179327. }
  179328. *piOff = iOff + (iVal-2);
  179329. *pi = i;
  179330. return 0;
  179331. }
  179332. }
  179333. /*
  179334. ** Advance the iterator object passed as the only argument. Return true
  179335. ** if the iterator reaches EOF, or false otherwise.
  179336. */
  179337. static int sqlite3Fts5PoslistReaderNext(Fts5PoslistReader *pIter){
  179338. if( sqlite3Fts5PoslistNext64(pIter->a, pIter->n, &pIter->i, &pIter->iPos) ){
  179339. pIter->bEof = 1;
  179340. }
  179341. return pIter->bEof;
  179342. }
  179343. static int sqlite3Fts5PoslistReaderInit(
  179344. const u8 *a, int n, /* Poslist buffer to iterate through */
  179345. Fts5PoslistReader *pIter /* Iterator object to initialize */
  179346. ){
  179347. memset(pIter, 0, sizeof(*pIter));
  179348. pIter->a = a;
  179349. pIter->n = n;
  179350. sqlite3Fts5PoslistReaderNext(pIter);
  179351. return pIter->bEof;
  179352. }
  179353. /*
  179354. ** Append position iPos to the position list being accumulated in buffer
  179355. ** pBuf, which must be already be large enough to hold the new data.
  179356. ** The previous position written to this list is *piPrev. *piPrev is set
  179357. ** to iPos before returning.
  179358. */
  179359. static void sqlite3Fts5PoslistSafeAppend(
  179360. Fts5Buffer *pBuf,
  179361. i64 *piPrev,
  179362. i64 iPos
  179363. ){
  179364. static const i64 colmask = ((i64)(0x7FFFFFFF)) << 32;
  179365. if( (iPos & colmask) != (*piPrev & colmask) ){
  179366. pBuf->p[pBuf->n++] = 1;
  179367. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], (iPos>>32));
  179368. *piPrev = (iPos & colmask);
  179369. }
  179370. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], (iPos-*piPrev)+2);
  179371. *piPrev = iPos;
  179372. }
  179373. static int sqlite3Fts5PoslistWriterAppend(
  179374. Fts5Buffer *pBuf,
  179375. Fts5PoslistWriter *pWriter,
  179376. i64 iPos
  179377. ){
  179378. int rc = 0; /* Initialized only to suppress erroneous warning from Clang */
  179379. if( fts5BufferGrow(&rc, pBuf, 5+5+5) ) return rc;
  179380. sqlite3Fts5PoslistSafeAppend(pBuf, &pWriter->iPrev, iPos);
  179381. return SQLITE_OK;
  179382. }
  179383. static void *sqlite3Fts5MallocZero(int *pRc, int nByte){
  179384. void *pRet = 0;
  179385. if( *pRc==SQLITE_OK ){
  179386. pRet = sqlite3_malloc(nByte);
  179387. if( pRet==0 ){
  179388. if( nByte>0 ) *pRc = SQLITE_NOMEM;
  179389. }else{
  179390. memset(pRet, 0, nByte);
  179391. }
  179392. }
  179393. return pRet;
  179394. }
  179395. /*
  179396. ** Return a nul-terminated copy of the string indicated by pIn. If nIn
  179397. ** is non-negative, then it is the length of the string in bytes. Otherwise,
  179398. ** the length of the string is determined using strlen().
  179399. **
  179400. ** It is the responsibility of the caller to eventually free the returned
  179401. ** buffer using sqlite3_free(). If an OOM error occurs, NULL is returned.
  179402. */
  179403. static char *sqlite3Fts5Strndup(int *pRc, const char *pIn, int nIn){
  179404. char *zRet = 0;
  179405. if( *pRc==SQLITE_OK ){
  179406. if( nIn<0 ){
  179407. nIn = (int)strlen(pIn);
  179408. }
  179409. zRet = (char*)sqlite3_malloc(nIn+1);
  179410. if( zRet ){
  179411. memcpy(zRet, pIn, nIn);
  179412. zRet[nIn] = '\0';
  179413. }else{
  179414. *pRc = SQLITE_NOMEM;
  179415. }
  179416. }
  179417. return zRet;
  179418. }
  179419. /*
  179420. ** Return true if character 't' may be part of an FTS5 bareword, or false
  179421. ** otherwise. Characters that may be part of barewords:
  179422. **
  179423. ** * All non-ASCII characters,
  179424. ** * The 52 upper and lower case ASCII characters, and
  179425. ** * The 10 integer ASCII characters.
  179426. ** * The underscore character "_" (0x5F).
  179427. ** * The unicode "subsitute" character (0x1A).
  179428. */
  179429. static int sqlite3Fts5IsBareword(char t){
  179430. u8 aBareword[128] = {
  179431. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00 .. 0x0F */
  179432. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, /* 0x10 .. 0x1F */
  179433. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x20 .. 0x2F */
  179434. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 0x30 .. 0x3F */
  179435. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x40 .. 0x4F */
  179436. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 0x50 .. 0x5F */
  179437. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x60 .. 0x6F */
  179438. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 /* 0x70 .. 0x7F */
  179439. };
  179440. return (t & 0x80) || aBareword[(int)t];
  179441. }
  179442. /*************************************************************************
  179443. */
  179444. typedef struct Fts5TermsetEntry Fts5TermsetEntry;
  179445. struct Fts5TermsetEntry {
  179446. char *pTerm;
  179447. int nTerm;
  179448. int iIdx; /* Index (main or aPrefix[] entry) */
  179449. Fts5TermsetEntry *pNext;
  179450. };
  179451. struct Fts5Termset {
  179452. Fts5TermsetEntry *apHash[512];
  179453. };
  179454. static int sqlite3Fts5TermsetNew(Fts5Termset **pp){
  179455. int rc = SQLITE_OK;
  179456. *pp = sqlite3Fts5MallocZero(&rc, sizeof(Fts5Termset));
  179457. return rc;
  179458. }
  179459. static int sqlite3Fts5TermsetAdd(
  179460. Fts5Termset *p,
  179461. int iIdx,
  179462. const char *pTerm, int nTerm,
  179463. int *pbPresent
  179464. ){
  179465. int rc = SQLITE_OK;
  179466. *pbPresent = 0;
  179467. if( p ){
  179468. int i;
  179469. u32 hash = 13;
  179470. Fts5TermsetEntry *pEntry;
  179471. /* Calculate a hash value for this term. This is the same hash checksum
  179472. ** used by the fts5_hash.c module. This is not important for correct
  179473. ** operation of the module, but is necessary to ensure that some tests
  179474. ** designed to produce hash table collisions really do work. */
  179475. for(i=nTerm-1; i>=0; i--){
  179476. hash = (hash << 3) ^ hash ^ pTerm[i];
  179477. }
  179478. hash = (hash << 3) ^ hash ^ iIdx;
  179479. hash = hash % ArraySize(p->apHash);
  179480. for(pEntry=p->apHash[hash]; pEntry; pEntry=pEntry->pNext){
  179481. if( pEntry->iIdx==iIdx
  179482. && pEntry->nTerm==nTerm
  179483. && memcmp(pEntry->pTerm, pTerm, nTerm)==0
  179484. ){
  179485. *pbPresent = 1;
  179486. break;
  179487. }
  179488. }
  179489. if( pEntry==0 ){
  179490. pEntry = sqlite3Fts5MallocZero(&rc, sizeof(Fts5TermsetEntry) + nTerm);
  179491. if( pEntry ){
  179492. pEntry->pTerm = (char*)&pEntry[1];
  179493. pEntry->nTerm = nTerm;
  179494. pEntry->iIdx = iIdx;
  179495. memcpy(pEntry->pTerm, pTerm, nTerm);
  179496. pEntry->pNext = p->apHash[hash];
  179497. p->apHash[hash] = pEntry;
  179498. }
  179499. }
  179500. }
  179501. return rc;
  179502. }
  179503. static void sqlite3Fts5TermsetFree(Fts5Termset *p){
  179504. if( p ){
  179505. u32 i;
  179506. for(i=0; i<ArraySize(p->apHash); i++){
  179507. Fts5TermsetEntry *pEntry = p->apHash[i];
  179508. while( pEntry ){
  179509. Fts5TermsetEntry *pDel = pEntry;
  179510. pEntry = pEntry->pNext;
  179511. sqlite3_free(pDel);
  179512. }
  179513. }
  179514. sqlite3_free(p);
  179515. }
  179516. }
  179517. /*
  179518. ** 2014 Jun 09
  179519. **
  179520. ** The author disclaims copyright to this source code. In place of
  179521. ** a legal notice, here is a blessing:
  179522. **
  179523. ** May you do good and not evil.
  179524. ** May you find forgiveness for yourself and forgive others.
  179525. ** May you share freely, never taking more than you give.
  179526. **
  179527. ******************************************************************************
  179528. **
  179529. ** This is an SQLite module implementing full-text search.
  179530. */
  179531. /* #include "fts5Int.h" */
  179532. #define FTS5_DEFAULT_PAGE_SIZE 4050
  179533. #define FTS5_DEFAULT_AUTOMERGE 4
  179534. #define FTS5_DEFAULT_USERMERGE 4
  179535. #define FTS5_DEFAULT_CRISISMERGE 16
  179536. #define FTS5_DEFAULT_HASHSIZE (1024*1024)
  179537. /* Maximum allowed page size */
  179538. #define FTS5_MAX_PAGE_SIZE (128*1024)
  179539. static int fts5_iswhitespace(char x){
  179540. return (x==' ');
  179541. }
  179542. static int fts5_isopenquote(char x){
  179543. return (x=='"' || x=='\'' || x=='[' || x=='`');
  179544. }
  179545. /*
  179546. ** Argument pIn points to a character that is part of a nul-terminated
  179547. ** string. Return a pointer to the first character following *pIn in
  179548. ** the string that is not a white-space character.
  179549. */
  179550. static const char *fts5ConfigSkipWhitespace(const char *pIn){
  179551. const char *p = pIn;
  179552. if( p ){
  179553. while( fts5_iswhitespace(*p) ){ p++; }
  179554. }
  179555. return p;
  179556. }
  179557. /*
  179558. ** Argument pIn points to a character that is part of a nul-terminated
  179559. ** string. Return a pointer to the first character following *pIn in
  179560. ** the string that is not a "bareword" character.
  179561. */
  179562. static const char *fts5ConfigSkipBareword(const char *pIn){
  179563. const char *p = pIn;
  179564. while ( sqlite3Fts5IsBareword(*p) ) p++;
  179565. if( p==pIn ) p = 0;
  179566. return p;
  179567. }
  179568. static int fts5_isdigit(char a){
  179569. return (a>='0' && a<='9');
  179570. }
  179571. static const char *fts5ConfigSkipLiteral(const char *pIn){
  179572. const char *p = pIn;
  179573. switch( *p ){
  179574. case 'n': case 'N':
  179575. if( sqlite3_strnicmp("null", p, 4)==0 ){
  179576. p = &p[4];
  179577. }else{
  179578. p = 0;
  179579. }
  179580. break;
  179581. case 'x': case 'X':
  179582. p++;
  179583. if( *p=='\'' ){
  179584. p++;
  179585. while( (*p>='a' && *p<='f')
  179586. || (*p>='A' && *p<='F')
  179587. || (*p>='0' && *p<='9')
  179588. ){
  179589. p++;
  179590. }
  179591. if( *p=='\'' && 0==((p-pIn)%2) ){
  179592. p++;
  179593. }else{
  179594. p = 0;
  179595. }
  179596. }else{
  179597. p = 0;
  179598. }
  179599. break;
  179600. case '\'':
  179601. p++;
  179602. while( p ){
  179603. if( *p=='\'' ){
  179604. p++;
  179605. if( *p!='\'' ) break;
  179606. }
  179607. p++;
  179608. if( *p==0 ) p = 0;
  179609. }
  179610. break;
  179611. default:
  179612. /* maybe a number */
  179613. if( *p=='+' || *p=='-' ) p++;
  179614. while( fts5_isdigit(*p) ) p++;
  179615. /* At this point, if the literal was an integer, the parse is
  179616. ** finished. Or, if it is a floating point value, it may continue
  179617. ** with either a decimal point or an 'E' character. */
  179618. if( *p=='.' && fts5_isdigit(p[1]) ){
  179619. p += 2;
  179620. while( fts5_isdigit(*p) ) p++;
  179621. }
  179622. if( p==pIn ) p = 0;
  179623. break;
  179624. }
  179625. return p;
  179626. }
  179627. /*
  179628. ** The first character of the string pointed to by argument z is guaranteed
  179629. ** to be an open-quote character (see function fts5_isopenquote()).
  179630. **
  179631. ** This function searches for the corresponding close-quote character within
  179632. ** the string and, if found, dequotes the string in place and adds a new
  179633. ** nul-terminator byte.
  179634. **
  179635. ** If the close-quote is found, the value returned is the byte offset of
  179636. ** the character immediately following it. Or, if the close-quote is not
  179637. ** found, -1 is returned. If -1 is returned, the buffer is left in an
  179638. ** undefined state.
  179639. */
  179640. static int fts5Dequote(char *z){
  179641. char q;
  179642. int iIn = 1;
  179643. int iOut = 0;
  179644. q = z[0];
  179645. /* Set stack variable q to the close-quote character */
  179646. assert( q=='[' || q=='\'' || q=='"' || q=='`' );
  179647. if( q=='[' ) q = ']';
  179648. while( ALWAYS(z[iIn]) ){
  179649. if( z[iIn]==q ){
  179650. if( z[iIn+1]!=q ){
  179651. /* Character iIn was the close quote. */
  179652. iIn++;
  179653. break;
  179654. }else{
  179655. /* Character iIn and iIn+1 form an escaped quote character. Skip
  179656. ** the input cursor past both and copy a single quote character
  179657. ** to the output buffer. */
  179658. iIn += 2;
  179659. z[iOut++] = q;
  179660. }
  179661. }else{
  179662. z[iOut++] = z[iIn++];
  179663. }
  179664. }
  179665. z[iOut] = '\0';
  179666. return iIn;
  179667. }
  179668. /*
  179669. ** Convert an SQL-style quoted string into a normal string by removing
  179670. ** the quote characters. The conversion is done in-place. If the
  179671. ** input does not begin with a quote character, then this routine
  179672. ** is a no-op.
  179673. **
  179674. ** Examples:
  179675. **
  179676. ** "abc" becomes abc
  179677. ** 'xyz' becomes xyz
  179678. ** [pqr] becomes pqr
  179679. ** `mno` becomes mno
  179680. */
  179681. static void sqlite3Fts5Dequote(char *z){
  179682. char quote; /* Quote character (if any ) */
  179683. assert( 0==fts5_iswhitespace(z[0]) );
  179684. quote = z[0];
  179685. if( quote=='[' || quote=='\'' || quote=='"' || quote=='`' ){
  179686. fts5Dequote(z);
  179687. }
  179688. }
  179689. struct Fts5Enum {
  179690. const char *zName;
  179691. int eVal;
  179692. };
  179693. typedef struct Fts5Enum Fts5Enum;
  179694. static int fts5ConfigSetEnum(
  179695. const Fts5Enum *aEnum,
  179696. const char *zEnum,
  179697. int *peVal
  179698. ){
  179699. int nEnum = (int)strlen(zEnum);
  179700. int i;
  179701. int iVal = -1;
  179702. for(i=0; aEnum[i].zName; i++){
  179703. if( sqlite3_strnicmp(aEnum[i].zName, zEnum, nEnum)==0 ){
  179704. if( iVal>=0 ) return SQLITE_ERROR;
  179705. iVal = aEnum[i].eVal;
  179706. }
  179707. }
  179708. *peVal = iVal;
  179709. return iVal<0 ? SQLITE_ERROR : SQLITE_OK;
  179710. }
  179711. /*
  179712. ** Parse a "special" CREATE VIRTUAL TABLE directive and update
  179713. ** configuration object pConfig as appropriate.
  179714. **
  179715. ** If successful, object pConfig is updated and SQLITE_OK returned. If
  179716. ** an error occurs, an SQLite error code is returned and an error message
  179717. ** may be left in *pzErr. It is the responsibility of the caller to
  179718. ** eventually free any such error message using sqlite3_free().
  179719. */
  179720. static int fts5ConfigParseSpecial(
  179721. Fts5Global *pGlobal,
  179722. Fts5Config *pConfig, /* Configuration object to update */
  179723. const char *zCmd, /* Special command to parse */
  179724. const char *zArg, /* Argument to parse */
  179725. char **pzErr /* OUT: Error message */
  179726. ){
  179727. int rc = SQLITE_OK;
  179728. int nCmd = (int)strlen(zCmd);
  179729. if( sqlite3_strnicmp("prefix", zCmd, nCmd)==0 ){
  179730. const int nByte = sizeof(int) * FTS5_MAX_PREFIX_INDEXES;
  179731. const char *p;
  179732. int bFirst = 1;
  179733. if( pConfig->aPrefix==0 ){
  179734. pConfig->aPrefix = sqlite3Fts5MallocZero(&rc, nByte);
  179735. if( rc ) return rc;
  179736. }
  179737. p = zArg;
  179738. while( 1 ){
  179739. int nPre = 0;
  179740. while( p[0]==' ' ) p++;
  179741. if( bFirst==0 && p[0]==',' ){
  179742. p++;
  179743. while( p[0]==' ' ) p++;
  179744. }else if( p[0]=='\0' ){
  179745. break;
  179746. }
  179747. if( p[0]<'0' || p[0]>'9' ){
  179748. *pzErr = sqlite3_mprintf("malformed prefix=... directive");
  179749. rc = SQLITE_ERROR;
  179750. break;
  179751. }
  179752. if( pConfig->nPrefix==FTS5_MAX_PREFIX_INDEXES ){
  179753. *pzErr = sqlite3_mprintf(
  179754. "too many prefix indexes (max %d)", FTS5_MAX_PREFIX_INDEXES
  179755. );
  179756. rc = SQLITE_ERROR;
  179757. break;
  179758. }
  179759. while( p[0]>='0' && p[0]<='9' && nPre<1000 ){
  179760. nPre = nPre*10 + (p[0] - '0');
  179761. p++;
  179762. }
  179763. if( nPre<=0 || nPre>=1000 ){
  179764. *pzErr = sqlite3_mprintf("prefix length out of range (max 999)");
  179765. rc = SQLITE_ERROR;
  179766. break;
  179767. }
  179768. pConfig->aPrefix[pConfig->nPrefix] = nPre;
  179769. pConfig->nPrefix++;
  179770. bFirst = 0;
  179771. }
  179772. assert( pConfig->nPrefix<=FTS5_MAX_PREFIX_INDEXES );
  179773. return rc;
  179774. }
  179775. if( sqlite3_strnicmp("tokenize", zCmd, nCmd)==0 ){
  179776. const char *p = (const char*)zArg;
  179777. int nArg = (int)strlen(zArg) + 1;
  179778. char **azArg = sqlite3Fts5MallocZero(&rc, sizeof(char*) * nArg);
  179779. char *pDel = sqlite3Fts5MallocZero(&rc, nArg * 2);
  179780. char *pSpace = pDel;
  179781. if( azArg && pSpace ){
  179782. if( pConfig->pTok ){
  179783. *pzErr = sqlite3_mprintf("multiple tokenize=... directives");
  179784. rc = SQLITE_ERROR;
  179785. }else{
  179786. for(nArg=0; p && *p; nArg++){
  179787. const char *p2 = fts5ConfigSkipWhitespace(p);
  179788. if( *p2=='\'' ){
  179789. p = fts5ConfigSkipLiteral(p2);
  179790. }else{
  179791. p = fts5ConfigSkipBareword(p2);
  179792. }
  179793. if( p ){
  179794. memcpy(pSpace, p2, p-p2);
  179795. azArg[nArg] = pSpace;
  179796. sqlite3Fts5Dequote(pSpace);
  179797. pSpace += (p - p2) + 1;
  179798. p = fts5ConfigSkipWhitespace(p);
  179799. }
  179800. }
  179801. if( p==0 ){
  179802. *pzErr = sqlite3_mprintf("parse error in tokenize directive");
  179803. rc = SQLITE_ERROR;
  179804. }else{
  179805. rc = sqlite3Fts5GetTokenizer(pGlobal,
  179806. (const char**)azArg, nArg, &pConfig->pTok, &pConfig->pTokApi,
  179807. pzErr
  179808. );
  179809. }
  179810. }
  179811. }
  179812. sqlite3_free(azArg);
  179813. sqlite3_free(pDel);
  179814. return rc;
  179815. }
  179816. if( sqlite3_strnicmp("content", zCmd, nCmd)==0 ){
  179817. if( pConfig->eContent!=FTS5_CONTENT_NORMAL ){
  179818. *pzErr = sqlite3_mprintf("multiple content=... directives");
  179819. rc = SQLITE_ERROR;
  179820. }else{
  179821. if( zArg[0] ){
  179822. pConfig->eContent = FTS5_CONTENT_EXTERNAL;
  179823. pConfig->zContent = sqlite3Fts5Mprintf(&rc, "%Q.%Q", pConfig->zDb,zArg);
  179824. }else{
  179825. pConfig->eContent = FTS5_CONTENT_NONE;
  179826. }
  179827. }
  179828. return rc;
  179829. }
  179830. if( sqlite3_strnicmp("content_rowid", zCmd, nCmd)==0 ){
  179831. if( pConfig->zContentRowid ){
  179832. *pzErr = sqlite3_mprintf("multiple content_rowid=... directives");
  179833. rc = SQLITE_ERROR;
  179834. }else{
  179835. pConfig->zContentRowid = sqlite3Fts5Strndup(&rc, zArg, -1);
  179836. }
  179837. return rc;
  179838. }
  179839. if( sqlite3_strnicmp("columnsize", zCmd, nCmd)==0 ){
  179840. if( (zArg[0]!='0' && zArg[0]!='1') || zArg[1]!='\0' ){
  179841. *pzErr = sqlite3_mprintf("malformed columnsize=... directive");
  179842. rc = SQLITE_ERROR;
  179843. }else{
  179844. pConfig->bColumnsize = (zArg[0]=='1');
  179845. }
  179846. return rc;
  179847. }
  179848. if( sqlite3_strnicmp("detail", zCmd, nCmd)==0 ){
  179849. const Fts5Enum aDetail[] = {
  179850. { "none", FTS5_DETAIL_NONE },
  179851. { "full", FTS5_DETAIL_FULL },
  179852. { "columns", FTS5_DETAIL_COLUMNS },
  179853. { 0, 0 }
  179854. };
  179855. if( (rc = fts5ConfigSetEnum(aDetail, zArg, &pConfig->eDetail)) ){
  179856. *pzErr = sqlite3_mprintf("malformed detail=... directive");
  179857. }
  179858. return rc;
  179859. }
  179860. *pzErr = sqlite3_mprintf("unrecognized option: \"%.*s\"", nCmd, zCmd);
  179861. return SQLITE_ERROR;
  179862. }
  179863. /*
  179864. ** Allocate an instance of the default tokenizer ("simple") at
  179865. ** Fts5Config.pTokenizer. Return SQLITE_OK if successful, or an SQLite error
  179866. ** code if an error occurs.
  179867. */
  179868. static int fts5ConfigDefaultTokenizer(Fts5Global *pGlobal, Fts5Config *pConfig){
  179869. assert( pConfig->pTok==0 && pConfig->pTokApi==0 );
  179870. return sqlite3Fts5GetTokenizer(
  179871. pGlobal, 0, 0, &pConfig->pTok, &pConfig->pTokApi, 0
  179872. );
  179873. }
  179874. /*
  179875. ** Gobble up the first bareword or quoted word from the input buffer zIn.
  179876. ** Return a pointer to the character immediately following the last in
  179877. ** the gobbled word if successful, or a NULL pointer otherwise (failed
  179878. ** to find close-quote character).
  179879. **
  179880. ** Before returning, set pzOut to point to a new buffer containing a
  179881. ** nul-terminated, dequoted copy of the gobbled word. If the word was
  179882. ** quoted, *pbQuoted is also set to 1 before returning.
  179883. **
  179884. ** If *pRc is other than SQLITE_OK when this function is called, it is
  179885. ** a no-op (NULL is returned). Otherwise, if an OOM occurs within this
  179886. ** function, *pRc is set to SQLITE_NOMEM before returning. *pRc is *not*
  179887. ** set if a parse error (failed to find close quote) occurs.
  179888. */
  179889. static const char *fts5ConfigGobbleWord(
  179890. int *pRc, /* IN/OUT: Error code */
  179891. const char *zIn, /* Buffer to gobble string/bareword from */
  179892. char **pzOut, /* OUT: malloc'd buffer containing str/bw */
  179893. int *pbQuoted /* OUT: Set to true if dequoting required */
  179894. ){
  179895. const char *zRet = 0;
  179896. int nIn = (int)strlen(zIn);
  179897. char *zOut = sqlite3_malloc(nIn+1);
  179898. assert( *pRc==SQLITE_OK );
  179899. *pbQuoted = 0;
  179900. *pzOut = 0;
  179901. if( zOut==0 ){
  179902. *pRc = SQLITE_NOMEM;
  179903. }else{
  179904. memcpy(zOut, zIn, nIn+1);
  179905. if( fts5_isopenquote(zOut[0]) ){
  179906. int ii = fts5Dequote(zOut);
  179907. zRet = &zIn[ii];
  179908. *pbQuoted = 1;
  179909. }else{
  179910. zRet = fts5ConfigSkipBareword(zIn);
  179911. if( zRet ){
  179912. zOut[zRet-zIn] = '\0';
  179913. }
  179914. }
  179915. }
  179916. if( zRet==0 ){
  179917. sqlite3_free(zOut);
  179918. }else{
  179919. *pzOut = zOut;
  179920. }
  179921. return zRet;
  179922. }
  179923. static int fts5ConfigParseColumn(
  179924. Fts5Config *p,
  179925. char *zCol,
  179926. char *zArg,
  179927. char **pzErr
  179928. ){
  179929. int rc = SQLITE_OK;
  179930. if( 0==sqlite3_stricmp(zCol, FTS5_RANK_NAME)
  179931. || 0==sqlite3_stricmp(zCol, FTS5_ROWID_NAME)
  179932. ){
  179933. *pzErr = sqlite3_mprintf("reserved fts5 column name: %s", zCol);
  179934. rc = SQLITE_ERROR;
  179935. }else if( zArg ){
  179936. if( 0==sqlite3_stricmp(zArg, "unindexed") ){
  179937. p->abUnindexed[p->nCol] = 1;
  179938. }else{
  179939. *pzErr = sqlite3_mprintf("unrecognized column option: %s", zArg);
  179940. rc = SQLITE_ERROR;
  179941. }
  179942. }
  179943. p->azCol[p->nCol++] = zCol;
  179944. return rc;
  179945. }
  179946. /*
  179947. ** Populate the Fts5Config.zContentExprlist string.
  179948. */
  179949. static int fts5ConfigMakeExprlist(Fts5Config *p){
  179950. int i;
  179951. int rc = SQLITE_OK;
  179952. Fts5Buffer buf = {0, 0, 0};
  179953. sqlite3Fts5BufferAppendPrintf(&rc, &buf, "T.%Q", p->zContentRowid);
  179954. if( p->eContent!=FTS5_CONTENT_NONE ){
  179955. for(i=0; i<p->nCol; i++){
  179956. if( p->eContent==FTS5_CONTENT_EXTERNAL ){
  179957. sqlite3Fts5BufferAppendPrintf(&rc, &buf, ", T.%Q", p->azCol[i]);
  179958. }else{
  179959. sqlite3Fts5BufferAppendPrintf(&rc, &buf, ", T.c%d", i);
  179960. }
  179961. }
  179962. }
  179963. assert( p->zContentExprlist==0 );
  179964. p->zContentExprlist = (char*)buf.p;
  179965. return rc;
  179966. }
  179967. /*
  179968. ** Arguments nArg/azArg contain the string arguments passed to the xCreate
  179969. ** or xConnect method of the virtual table. This function attempts to
  179970. ** allocate an instance of Fts5Config containing the results of parsing
  179971. ** those arguments.
  179972. **
  179973. ** If successful, SQLITE_OK is returned and *ppOut is set to point to the
  179974. ** new Fts5Config object. If an error occurs, an SQLite error code is
  179975. ** returned, *ppOut is set to NULL and an error message may be left in
  179976. ** *pzErr. It is the responsibility of the caller to eventually free any
  179977. ** such error message using sqlite3_free().
  179978. */
  179979. static int sqlite3Fts5ConfigParse(
  179980. Fts5Global *pGlobal,
  179981. sqlite3 *db,
  179982. int nArg, /* Number of arguments */
  179983. const char **azArg, /* Array of nArg CREATE VIRTUAL TABLE args */
  179984. Fts5Config **ppOut, /* OUT: Results of parse */
  179985. char **pzErr /* OUT: Error message */
  179986. ){
  179987. int rc = SQLITE_OK; /* Return code */
  179988. Fts5Config *pRet; /* New object to return */
  179989. int i;
  179990. int nByte;
  179991. *ppOut = pRet = (Fts5Config*)sqlite3_malloc(sizeof(Fts5Config));
  179992. if( pRet==0 ) return SQLITE_NOMEM;
  179993. memset(pRet, 0, sizeof(Fts5Config));
  179994. pRet->db = db;
  179995. pRet->iCookie = -1;
  179996. nByte = nArg * (sizeof(char*) + sizeof(u8));
  179997. pRet->azCol = (char**)sqlite3Fts5MallocZero(&rc, nByte);
  179998. pRet->abUnindexed = (u8*)&pRet->azCol[nArg];
  179999. pRet->zDb = sqlite3Fts5Strndup(&rc, azArg[1], -1);
  180000. pRet->zName = sqlite3Fts5Strndup(&rc, azArg[2], -1);
  180001. pRet->bColumnsize = 1;
  180002. pRet->eDetail = FTS5_DETAIL_FULL;
  180003. #ifdef SQLITE_DEBUG
  180004. pRet->bPrefixIndex = 1;
  180005. #endif
  180006. if( rc==SQLITE_OK && sqlite3_stricmp(pRet->zName, FTS5_RANK_NAME)==0 ){
  180007. *pzErr = sqlite3_mprintf("reserved fts5 table name: %s", pRet->zName);
  180008. rc = SQLITE_ERROR;
  180009. }
  180010. for(i=3; rc==SQLITE_OK && i<nArg; i++){
  180011. const char *zOrig = azArg[i];
  180012. const char *z;
  180013. char *zOne = 0;
  180014. char *zTwo = 0;
  180015. int bOption = 0;
  180016. int bMustBeCol = 0;
  180017. z = fts5ConfigGobbleWord(&rc, zOrig, &zOne, &bMustBeCol);
  180018. z = fts5ConfigSkipWhitespace(z);
  180019. if( z && *z=='=' ){
  180020. bOption = 1;
  180021. z++;
  180022. if( bMustBeCol ) z = 0;
  180023. }
  180024. z = fts5ConfigSkipWhitespace(z);
  180025. if( z && z[0] ){
  180026. int bDummy;
  180027. z = fts5ConfigGobbleWord(&rc, z, &zTwo, &bDummy);
  180028. if( z && z[0] ) z = 0;
  180029. }
  180030. if( rc==SQLITE_OK ){
  180031. if( z==0 ){
  180032. *pzErr = sqlite3_mprintf("parse error in \"%s\"", zOrig);
  180033. rc = SQLITE_ERROR;
  180034. }else{
  180035. if( bOption ){
  180036. rc = fts5ConfigParseSpecial(pGlobal, pRet, zOne, zTwo?zTwo:"", pzErr);
  180037. }else{
  180038. rc = fts5ConfigParseColumn(pRet, zOne, zTwo, pzErr);
  180039. zOne = 0;
  180040. }
  180041. }
  180042. }
  180043. sqlite3_free(zOne);
  180044. sqlite3_free(zTwo);
  180045. }
  180046. /* If a tokenizer= option was successfully parsed, the tokenizer has
  180047. ** already been allocated. Otherwise, allocate an instance of the default
  180048. ** tokenizer (unicode61) now. */
  180049. if( rc==SQLITE_OK && pRet->pTok==0 ){
  180050. rc = fts5ConfigDefaultTokenizer(pGlobal, pRet);
  180051. }
  180052. /* If no zContent option was specified, fill in the default values. */
  180053. if( rc==SQLITE_OK && pRet->zContent==0 ){
  180054. const char *zTail = 0;
  180055. assert( pRet->eContent==FTS5_CONTENT_NORMAL
  180056. || pRet->eContent==FTS5_CONTENT_NONE
  180057. );
  180058. if( pRet->eContent==FTS5_CONTENT_NORMAL ){
  180059. zTail = "content";
  180060. }else if( pRet->bColumnsize ){
  180061. zTail = "docsize";
  180062. }
  180063. if( zTail ){
  180064. pRet->zContent = sqlite3Fts5Mprintf(
  180065. &rc, "%Q.'%q_%s'", pRet->zDb, pRet->zName, zTail
  180066. );
  180067. }
  180068. }
  180069. if( rc==SQLITE_OK && pRet->zContentRowid==0 ){
  180070. pRet->zContentRowid = sqlite3Fts5Strndup(&rc, "rowid", -1);
  180071. }
  180072. /* Formulate the zContentExprlist text */
  180073. if( rc==SQLITE_OK ){
  180074. rc = fts5ConfigMakeExprlist(pRet);
  180075. }
  180076. if( rc!=SQLITE_OK ){
  180077. sqlite3Fts5ConfigFree(pRet);
  180078. *ppOut = 0;
  180079. }
  180080. return rc;
  180081. }
  180082. /*
  180083. ** Free the configuration object passed as the only argument.
  180084. */
  180085. static void sqlite3Fts5ConfigFree(Fts5Config *pConfig){
  180086. if( pConfig ){
  180087. int i;
  180088. if( pConfig->pTok ){
  180089. pConfig->pTokApi->xDelete(pConfig->pTok);
  180090. }
  180091. sqlite3_free(pConfig->zDb);
  180092. sqlite3_free(pConfig->zName);
  180093. for(i=0; i<pConfig->nCol; i++){
  180094. sqlite3_free(pConfig->azCol[i]);
  180095. }
  180096. sqlite3_free(pConfig->azCol);
  180097. sqlite3_free(pConfig->aPrefix);
  180098. sqlite3_free(pConfig->zRank);
  180099. sqlite3_free(pConfig->zRankArgs);
  180100. sqlite3_free(pConfig->zContent);
  180101. sqlite3_free(pConfig->zContentRowid);
  180102. sqlite3_free(pConfig->zContentExprlist);
  180103. sqlite3_free(pConfig);
  180104. }
  180105. }
  180106. /*
  180107. ** Call sqlite3_declare_vtab() based on the contents of the configuration
  180108. ** object passed as the only argument. Return SQLITE_OK if successful, or
  180109. ** an SQLite error code if an error occurs.
  180110. */
  180111. static int sqlite3Fts5ConfigDeclareVtab(Fts5Config *pConfig){
  180112. int i;
  180113. int rc = SQLITE_OK;
  180114. char *zSql;
  180115. zSql = sqlite3Fts5Mprintf(&rc, "CREATE TABLE x(");
  180116. for(i=0; zSql && i<pConfig->nCol; i++){
  180117. const char *zSep = (i==0?"":", ");
  180118. zSql = sqlite3Fts5Mprintf(&rc, "%z%s%Q", zSql, zSep, pConfig->azCol[i]);
  180119. }
  180120. zSql = sqlite3Fts5Mprintf(&rc, "%z, %Q HIDDEN, %s HIDDEN)",
  180121. zSql, pConfig->zName, FTS5_RANK_NAME
  180122. );
  180123. assert( zSql || rc==SQLITE_NOMEM );
  180124. if( zSql ){
  180125. rc = sqlite3_declare_vtab(pConfig->db, zSql);
  180126. sqlite3_free(zSql);
  180127. }
  180128. return rc;
  180129. }
  180130. /*
  180131. ** Tokenize the text passed via the second and third arguments.
  180132. **
  180133. ** The callback is invoked once for each token in the input text. The
  180134. ** arguments passed to it are, in order:
  180135. **
  180136. ** void *pCtx // Copy of 4th argument to sqlite3Fts5Tokenize()
  180137. ** const char *pToken // Pointer to buffer containing token
  180138. ** int nToken // Size of token in bytes
  180139. ** int iStart // Byte offset of start of token within input text
  180140. ** int iEnd // Byte offset of end of token within input text
  180141. ** int iPos // Position of token in input (first token is 0)
  180142. **
  180143. ** If the callback returns a non-zero value the tokenization is abandoned
  180144. ** and no further callbacks are issued.
  180145. **
  180146. ** This function returns SQLITE_OK if successful or an SQLite error code
  180147. ** if an error occurs. If the tokenization was abandoned early because
  180148. ** the callback returned SQLITE_DONE, this is not an error and this function
  180149. ** still returns SQLITE_OK. Or, if the tokenization was abandoned early
  180150. ** because the callback returned another non-zero value, it is assumed
  180151. ** to be an SQLite error code and returned to the caller.
  180152. */
  180153. static int sqlite3Fts5Tokenize(
  180154. Fts5Config *pConfig, /* FTS5 Configuration object */
  180155. int flags, /* FTS5_TOKENIZE_* flags */
  180156. const char *pText, int nText, /* Text to tokenize */
  180157. void *pCtx, /* Context passed to xToken() */
  180158. int (*xToken)(void*, int, const char*, int, int, int) /* Callback */
  180159. ){
  180160. if( pText==0 ) return SQLITE_OK;
  180161. return pConfig->pTokApi->xTokenize(
  180162. pConfig->pTok, pCtx, flags, pText, nText, xToken
  180163. );
  180164. }
  180165. /*
  180166. ** Argument pIn points to the first character in what is expected to be
  180167. ** a comma-separated list of SQL literals followed by a ')' character.
  180168. ** If it actually is this, return a pointer to the ')'. Otherwise, return
  180169. ** NULL to indicate a parse error.
  180170. */
  180171. static const char *fts5ConfigSkipArgs(const char *pIn){
  180172. const char *p = pIn;
  180173. while( 1 ){
  180174. p = fts5ConfigSkipWhitespace(p);
  180175. p = fts5ConfigSkipLiteral(p);
  180176. p = fts5ConfigSkipWhitespace(p);
  180177. if( p==0 || *p==')' ) break;
  180178. if( *p!=',' ){
  180179. p = 0;
  180180. break;
  180181. }
  180182. p++;
  180183. }
  180184. return p;
  180185. }
  180186. /*
  180187. ** Parameter zIn contains a rank() function specification. The format of
  180188. ** this is:
  180189. **
  180190. ** + Bareword (function name)
  180191. ** + Open parenthesis - "("
  180192. ** + Zero or more SQL literals in a comma separated list
  180193. ** + Close parenthesis - ")"
  180194. */
  180195. static int sqlite3Fts5ConfigParseRank(
  180196. const char *zIn, /* Input string */
  180197. char **pzRank, /* OUT: Rank function name */
  180198. char **pzRankArgs /* OUT: Rank function arguments */
  180199. ){
  180200. const char *p = zIn;
  180201. const char *pRank;
  180202. char *zRank = 0;
  180203. char *zRankArgs = 0;
  180204. int rc = SQLITE_OK;
  180205. *pzRank = 0;
  180206. *pzRankArgs = 0;
  180207. if( p==0 ){
  180208. rc = SQLITE_ERROR;
  180209. }else{
  180210. p = fts5ConfigSkipWhitespace(p);
  180211. pRank = p;
  180212. p = fts5ConfigSkipBareword(p);
  180213. if( p ){
  180214. zRank = sqlite3Fts5MallocZero(&rc, 1 + p - pRank);
  180215. if( zRank ) memcpy(zRank, pRank, p-pRank);
  180216. }else{
  180217. rc = SQLITE_ERROR;
  180218. }
  180219. if( rc==SQLITE_OK ){
  180220. p = fts5ConfigSkipWhitespace(p);
  180221. if( *p!='(' ) rc = SQLITE_ERROR;
  180222. p++;
  180223. }
  180224. if( rc==SQLITE_OK ){
  180225. const char *pArgs;
  180226. p = fts5ConfigSkipWhitespace(p);
  180227. pArgs = p;
  180228. if( *p!=')' ){
  180229. p = fts5ConfigSkipArgs(p);
  180230. if( p==0 ){
  180231. rc = SQLITE_ERROR;
  180232. }else{
  180233. zRankArgs = sqlite3Fts5MallocZero(&rc, 1 + p - pArgs);
  180234. if( zRankArgs ) memcpy(zRankArgs, pArgs, p-pArgs);
  180235. }
  180236. }
  180237. }
  180238. }
  180239. if( rc!=SQLITE_OK ){
  180240. sqlite3_free(zRank);
  180241. assert( zRankArgs==0 );
  180242. }else{
  180243. *pzRank = zRank;
  180244. *pzRankArgs = zRankArgs;
  180245. }
  180246. return rc;
  180247. }
  180248. static int sqlite3Fts5ConfigSetValue(
  180249. Fts5Config *pConfig,
  180250. const char *zKey,
  180251. sqlite3_value *pVal,
  180252. int *pbBadkey
  180253. ){
  180254. int rc = SQLITE_OK;
  180255. if( 0==sqlite3_stricmp(zKey, "pgsz") ){
  180256. int pgsz = 0;
  180257. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  180258. pgsz = sqlite3_value_int(pVal);
  180259. }
  180260. if( pgsz<=0 || pgsz>FTS5_MAX_PAGE_SIZE ){
  180261. *pbBadkey = 1;
  180262. }else{
  180263. pConfig->pgsz = pgsz;
  180264. }
  180265. }
  180266. else if( 0==sqlite3_stricmp(zKey, "hashsize") ){
  180267. int nHashSize = -1;
  180268. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  180269. nHashSize = sqlite3_value_int(pVal);
  180270. }
  180271. if( nHashSize<=0 ){
  180272. *pbBadkey = 1;
  180273. }else{
  180274. pConfig->nHashSize = nHashSize;
  180275. }
  180276. }
  180277. else if( 0==sqlite3_stricmp(zKey, "automerge") ){
  180278. int nAutomerge = -1;
  180279. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  180280. nAutomerge = sqlite3_value_int(pVal);
  180281. }
  180282. if( nAutomerge<0 || nAutomerge>64 ){
  180283. *pbBadkey = 1;
  180284. }else{
  180285. if( nAutomerge==1 ) nAutomerge = FTS5_DEFAULT_AUTOMERGE;
  180286. pConfig->nAutomerge = nAutomerge;
  180287. }
  180288. }
  180289. else if( 0==sqlite3_stricmp(zKey, "usermerge") ){
  180290. int nUsermerge = -1;
  180291. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  180292. nUsermerge = sqlite3_value_int(pVal);
  180293. }
  180294. if( nUsermerge<2 || nUsermerge>16 ){
  180295. *pbBadkey = 1;
  180296. }else{
  180297. pConfig->nUsermerge = nUsermerge;
  180298. }
  180299. }
  180300. else if( 0==sqlite3_stricmp(zKey, "crisismerge") ){
  180301. int nCrisisMerge = -1;
  180302. if( SQLITE_INTEGER==sqlite3_value_numeric_type(pVal) ){
  180303. nCrisisMerge = sqlite3_value_int(pVal);
  180304. }
  180305. if( nCrisisMerge<0 ){
  180306. *pbBadkey = 1;
  180307. }else{
  180308. if( nCrisisMerge<=1 ) nCrisisMerge = FTS5_DEFAULT_CRISISMERGE;
  180309. pConfig->nCrisisMerge = nCrisisMerge;
  180310. }
  180311. }
  180312. else if( 0==sqlite3_stricmp(zKey, "rank") ){
  180313. const char *zIn = (const char*)sqlite3_value_text(pVal);
  180314. char *zRank;
  180315. char *zRankArgs;
  180316. rc = sqlite3Fts5ConfigParseRank(zIn, &zRank, &zRankArgs);
  180317. if( rc==SQLITE_OK ){
  180318. sqlite3_free(pConfig->zRank);
  180319. sqlite3_free(pConfig->zRankArgs);
  180320. pConfig->zRank = zRank;
  180321. pConfig->zRankArgs = zRankArgs;
  180322. }else if( rc==SQLITE_ERROR ){
  180323. rc = SQLITE_OK;
  180324. *pbBadkey = 1;
  180325. }
  180326. }else{
  180327. *pbBadkey = 1;
  180328. }
  180329. return rc;
  180330. }
  180331. /*
  180332. ** Load the contents of the %_config table into memory.
  180333. */
  180334. static int sqlite3Fts5ConfigLoad(Fts5Config *pConfig, int iCookie){
  180335. const char *zSelect = "SELECT k, v FROM %Q.'%q_config'";
  180336. char *zSql;
  180337. sqlite3_stmt *p = 0;
  180338. int rc = SQLITE_OK;
  180339. int iVersion = 0;
  180340. /* Set default values */
  180341. pConfig->pgsz = FTS5_DEFAULT_PAGE_SIZE;
  180342. pConfig->nAutomerge = FTS5_DEFAULT_AUTOMERGE;
  180343. pConfig->nUsermerge = FTS5_DEFAULT_USERMERGE;
  180344. pConfig->nCrisisMerge = FTS5_DEFAULT_CRISISMERGE;
  180345. pConfig->nHashSize = FTS5_DEFAULT_HASHSIZE;
  180346. zSql = sqlite3Fts5Mprintf(&rc, zSelect, pConfig->zDb, pConfig->zName);
  180347. if( zSql ){
  180348. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &p, 0);
  180349. sqlite3_free(zSql);
  180350. }
  180351. assert( rc==SQLITE_OK || p==0 );
  180352. if( rc==SQLITE_OK ){
  180353. while( SQLITE_ROW==sqlite3_step(p) ){
  180354. const char *zK = (const char*)sqlite3_column_text(p, 0);
  180355. sqlite3_value *pVal = sqlite3_column_value(p, 1);
  180356. if( 0==sqlite3_stricmp(zK, "version") ){
  180357. iVersion = sqlite3_value_int(pVal);
  180358. }else{
  180359. int bDummy = 0;
  180360. sqlite3Fts5ConfigSetValue(pConfig, zK, pVal, &bDummy);
  180361. }
  180362. }
  180363. rc = sqlite3_finalize(p);
  180364. }
  180365. if( rc==SQLITE_OK && iVersion!=FTS5_CURRENT_VERSION ){
  180366. rc = SQLITE_ERROR;
  180367. if( pConfig->pzErrmsg ){
  180368. assert( 0==*pConfig->pzErrmsg );
  180369. *pConfig->pzErrmsg = sqlite3_mprintf(
  180370. "invalid fts5 file format (found %d, expected %d) - run 'rebuild'",
  180371. iVersion, FTS5_CURRENT_VERSION
  180372. );
  180373. }
  180374. }
  180375. if( rc==SQLITE_OK ){
  180376. pConfig->iCookie = iCookie;
  180377. }
  180378. return rc;
  180379. }
  180380. /*
  180381. ** 2014 May 31
  180382. **
  180383. ** The author disclaims copyright to this source code. In place of
  180384. ** a legal notice, here is a blessing:
  180385. **
  180386. ** May you do good and not evil.
  180387. ** May you find forgiveness for yourself and forgive others.
  180388. ** May you share freely, never taking more than you give.
  180389. **
  180390. ******************************************************************************
  180391. **
  180392. */
  180393. /* #include "fts5Int.h" */
  180394. /* #include "fts5parse.h" */
  180395. /*
  180396. ** All token types in the generated fts5parse.h file are greater than 0.
  180397. */
  180398. #define FTS5_EOF 0
  180399. #define FTS5_LARGEST_INT64 (0xffffffff|(((i64)0x7fffffff)<<32))
  180400. typedef struct Fts5ExprTerm Fts5ExprTerm;
  180401. /*
  180402. ** Functions generated by lemon from fts5parse.y.
  180403. */
  180404. static void *sqlite3Fts5ParserAlloc(void *(*mallocProc)(u64));
  180405. static void sqlite3Fts5ParserFree(void*, void (*freeProc)(void*));
  180406. static void sqlite3Fts5Parser(void*, int, Fts5Token, Fts5Parse*);
  180407. #ifndef NDEBUG
  180408. /* #include <stdio.h> */
  180409. static void sqlite3Fts5ParserTrace(FILE*, char*);
  180410. #endif
  180411. struct Fts5Expr {
  180412. Fts5Index *pIndex;
  180413. Fts5Config *pConfig;
  180414. Fts5ExprNode *pRoot;
  180415. int bDesc; /* Iterate in descending rowid order */
  180416. int nPhrase; /* Number of phrases in expression */
  180417. Fts5ExprPhrase **apExprPhrase; /* Pointers to phrase objects */
  180418. };
  180419. /*
  180420. ** eType:
  180421. ** Expression node type. Always one of:
  180422. **
  180423. ** FTS5_AND (nChild, apChild valid)
  180424. ** FTS5_OR (nChild, apChild valid)
  180425. ** FTS5_NOT (nChild, apChild valid)
  180426. ** FTS5_STRING (pNear valid)
  180427. ** FTS5_TERM (pNear valid)
  180428. */
  180429. struct Fts5ExprNode {
  180430. int eType; /* Node type */
  180431. int bEof; /* True at EOF */
  180432. int bNomatch; /* True if entry is not a match */
  180433. /* Next method for this node. */
  180434. int (*xNext)(Fts5Expr*, Fts5ExprNode*, int, i64);
  180435. i64 iRowid; /* Current rowid */
  180436. Fts5ExprNearset *pNear; /* For FTS5_STRING - cluster of phrases */
  180437. /* Child nodes. For a NOT node, this array always contains 2 entries. For
  180438. ** AND or OR nodes, it contains 2 or more entries. */
  180439. int nChild; /* Number of child nodes */
  180440. Fts5ExprNode *apChild[1]; /* Array of child nodes */
  180441. };
  180442. #define Fts5NodeIsString(p) ((p)->eType==FTS5_TERM || (p)->eType==FTS5_STRING)
  180443. /*
  180444. ** Invoke the xNext method of an Fts5ExprNode object. This macro should be
  180445. ** used as if it has the same signature as the xNext() methods themselves.
  180446. */
  180447. #define fts5ExprNodeNext(a,b,c,d) (b)->xNext((a), (b), (c), (d))
  180448. /*
  180449. ** An instance of the following structure represents a single search term
  180450. ** or term prefix.
  180451. */
  180452. struct Fts5ExprTerm {
  180453. u8 bPrefix; /* True for a prefix term */
  180454. u8 bFirst; /* True if token must be first in column */
  180455. char *zTerm; /* nul-terminated term */
  180456. Fts5IndexIter *pIter; /* Iterator for this term */
  180457. Fts5ExprTerm *pSynonym; /* Pointer to first in list of synonyms */
  180458. };
  180459. /*
  180460. ** A phrase. One or more terms that must appear in a contiguous sequence
  180461. ** within a document for it to match.
  180462. */
  180463. struct Fts5ExprPhrase {
  180464. Fts5ExprNode *pNode; /* FTS5_STRING node this phrase is part of */
  180465. Fts5Buffer poslist; /* Current position list */
  180466. int nTerm; /* Number of entries in aTerm[] */
  180467. Fts5ExprTerm aTerm[1]; /* Terms that make up this phrase */
  180468. };
  180469. /*
  180470. ** One or more phrases that must appear within a certain token distance of
  180471. ** each other within each matching document.
  180472. */
  180473. struct Fts5ExprNearset {
  180474. int nNear; /* NEAR parameter */
  180475. Fts5Colset *pColset; /* Columns to search (NULL -> all columns) */
  180476. int nPhrase; /* Number of entries in aPhrase[] array */
  180477. Fts5ExprPhrase *apPhrase[1]; /* Array of phrase pointers */
  180478. };
  180479. /*
  180480. ** Parse context.
  180481. */
  180482. struct Fts5Parse {
  180483. Fts5Config *pConfig;
  180484. char *zErr;
  180485. int rc;
  180486. int nPhrase; /* Size of apPhrase array */
  180487. Fts5ExprPhrase **apPhrase; /* Array of all phrases */
  180488. Fts5ExprNode *pExpr; /* Result of a successful parse */
  180489. };
  180490. static void sqlite3Fts5ParseError(Fts5Parse *pParse, const char *zFmt, ...){
  180491. va_list ap;
  180492. va_start(ap, zFmt);
  180493. if( pParse->rc==SQLITE_OK ){
  180494. pParse->zErr = sqlite3_vmprintf(zFmt, ap);
  180495. pParse->rc = SQLITE_ERROR;
  180496. }
  180497. va_end(ap);
  180498. }
  180499. static int fts5ExprIsspace(char t){
  180500. return t==' ' || t=='\t' || t=='\n' || t=='\r';
  180501. }
  180502. /*
  180503. ** Read the first token from the nul-terminated string at *pz.
  180504. */
  180505. static int fts5ExprGetToken(
  180506. Fts5Parse *pParse,
  180507. const char **pz, /* IN/OUT: Pointer into buffer */
  180508. Fts5Token *pToken
  180509. ){
  180510. const char *z = *pz;
  180511. int tok;
  180512. /* Skip past any whitespace */
  180513. while( fts5ExprIsspace(*z) ) z++;
  180514. pToken->p = z;
  180515. pToken->n = 1;
  180516. switch( *z ){
  180517. case '(': tok = FTS5_LP; break;
  180518. case ')': tok = FTS5_RP; break;
  180519. case '{': tok = FTS5_LCP; break;
  180520. case '}': tok = FTS5_RCP; break;
  180521. case ':': tok = FTS5_COLON; break;
  180522. case ',': tok = FTS5_COMMA; break;
  180523. case '+': tok = FTS5_PLUS; break;
  180524. case '*': tok = FTS5_STAR; break;
  180525. case '-': tok = FTS5_MINUS; break;
  180526. case '^': tok = FTS5_CARET; break;
  180527. case '\0': tok = FTS5_EOF; break;
  180528. case '"': {
  180529. const char *z2;
  180530. tok = FTS5_STRING;
  180531. for(z2=&z[1]; 1; z2++){
  180532. if( z2[0]=='"' ){
  180533. z2++;
  180534. if( z2[0]!='"' ) break;
  180535. }
  180536. if( z2[0]=='\0' ){
  180537. sqlite3Fts5ParseError(pParse, "unterminated string");
  180538. return FTS5_EOF;
  180539. }
  180540. }
  180541. pToken->n = (z2 - z);
  180542. break;
  180543. }
  180544. default: {
  180545. const char *z2;
  180546. if( sqlite3Fts5IsBareword(z[0])==0 ){
  180547. sqlite3Fts5ParseError(pParse, "fts5: syntax error near \"%.1s\"", z);
  180548. return FTS5_EOF;
  180549. }
  180550. tok = FTS5_STRING;
  180551. for(z2=&z[1]; sqlite3Fts5IsBareword(*z2); z2++);
  180552. pToken->n = (z2 - z);
  180553. if( pToken->n==2 && memcmp(pToken->p, "OR", 2)==0 ) tok = FTS5_OR;
  180554. if( pToken->n==3 && memcmp(pToken->p, "NOT", 3)==0 ) tok = FTS5_NOT;
  180555. if( pToken->n==3 && memcmp(pToken->p, "AND", 3)==0 ) tok = FTS5_AND;
  180556. break;
  180557. }
  180558. }
  180559. *pz = &pToken->p[pToken->n];
  180560. return tok;
  180561. }
  180562. static void *fts5ParseAlloc(u64 t){ return sqlite3_malloc((int)t); }
  180563. static void fts5ParseFree(void *p){ sqlite3_free(p); }
  180564. static int sqlite3Fts5ExprNew(
  180565. Fts5Config *pConfig, /* FTS5 Configuration */
  180566. int iCol,
  180567. const char *zExpr, /* Expression text */
  180568. Fts5Expr **ppNew,
  180569. char **pzErr
  180570. ){
  180571. Fts5Parse sParse;
  180572. Fts5Token token;
  180573. const char *z = zExpr;
  180574. int t; /* Next token type */
  180575. void *pEngine;
  180576. Fts5Expr *pNew;
  180577. *ppNew = 0;
  180578. *pzErr = 0;
  180579. memset(&sParse, 0, sizeof(sParse));
  180580. pEngine = sqlite3Fts5ParserAlloc(fts5ParseAlloc);
  180581. if( pEngine==0 ){ return SQLITE_NOMEM; }
  180582. sParse.pConfig = pConfig;
  180583. do {
  180584. t = fts5ExprGetToken(&sParse, &z, &token);
  180585. sqlite3Fts5Parser(pEngine, t, token, &sParse);
  180586. }while( sParse.rc==SQLITE_OK && t!=FTS5_EOF );
  180587. sqlite3Fts5ParserFree(pEngine, fts5ParseFree);
  180588. /* If the LHS of the MATCH expression was a user column, apply the
  180589. ** implicit column-filter. */
  180590. if( iCol<pConfig->nCol && sParse.pExpr && sParse.rc==SQLITE_OK ){
  180591. int n = sizeof(Fts5Colset);
  180592. Fts5Colset *pColset = (Fts5Colset*)sqlite3Fts5MallocZero(&sParse.rc, n);
  180593. if( pColset ){
  180594. pColset->nCol = 1;
  180595. pColset->aiCol[0] = iCol;
  180596. sqlite3Fts5ParseSetColset(&sParse, sParse.pExpr, pColset);
  180597. }
  180598. }
  180599. assert( sParse.rc!=SQLITE_OK || sParse.zErr==0 );
  180600. if( sParse.rc==SQLITE_OK ){
  180601. *ppNew = pNew = sqlite3_malloc(sizeof(Fts5Expr));
  180602. if( pNew==0 ){
  180603. sParse.rc = SQLITE_NOMEM;
  180604. sqlite3Fts5ParseNodeFree(sParse.pExpr);
  180605. }else{
  180606. if( !sParse.pExpr ){
  180607. const int nByte = sizeof(Fts5ExprNode);
  180608. pNew->pRoot = (Fts5ExprNode*)sqlite3Fts5MallocZero(&sParse.rc, nByte);
  180609. if( pNew->pRoot ){
  180610. pNew->pRoot->bEof = 1;
  180611. }
  180612. }else{
  180613. pNew->pRoot = sParse.pExpr;
  180614. }
  180615. pNew->pIndex = 0;
  180616. pNew->pConfig = pConfig;
  180617. pNew->apExprPhrase = sParse.apPhrase;
  180618. pNew->nPhrase = sParse.nPhrase;
  180619. sParse.apPhrase = 0;
  180620. }
  180621. }else{
  180622. sqlite3Fts5ParseNodeFree(sParse.pExpr);
  180623. }
  180624. sqlite3_free(sParse.apPhrase);
  180625. *pzErr = sParse.zErr;
  180626. return sParse.rc;
  180627. }
  180628. /*
  180629. ** Free the expression node object passed as the only argument.
  180630. */
  180631. static void sqlite3Fts5ParseNodeFree(Fts5ExprNode *p){
  180632. if( p ){
  180633. int i;
  180634. for(i=0; i<p->nChild; i++){
  180635. sqlite3Fts5ParseNodeFree(p->apChild[i]);
  180636. }
  180637. sqlite3Fts5ParseNearsetFree(p->pNear);
  180638. sqlite3_free(p);
  180639. }
  180640. }
  180641. /*
  180642. ** Free the expression object passed as the only argument.
  180643. */
  180644. static void sqlite3Fts5ExprFree(Fts5Expr *p){
  180645. if( p ){
  180646. sqlite3Fts5ParseNodeFree(p->pRoot);
  180647. sqlite3_free(p->apExprPhrase);
  180648. sqlite3_free(p);
  180649. }
  180650. }
  180651. /*
  180652. ** Argument pTerm must be a synonym iterator. Return the current rowid
  180653. ** that it points to.
  180654. */
  180655. static i64 fts5ExprSynonymRowid(Fts5ExprTerm *pTerm, int bDesc, int *pbEof){
  180656. i64 iRet = 0;
  180657. int bRetValid = 0;
  180658. Fts5ExprTerm *p;
  180659. assert( pTerm->pSynonym );
  180660. assert( bDesc==0 || bDesc==1 );
  180661. for(p=pTerm; p; p=p->pSynonym){
  180662. if( 0==sqlite3Fts5IterEof(p->pIter) ){
  180663. i64 iRowid = p->pIter->iRowid;
  180664. if( bRetValid==0 || (bDesc!=(iRowid<iRet)) ){
  180665. iRet = iRowid;
  180666. bRetValid = 1;
  180667. }
  180668. }
  180669. }
  180670. if( pbEof && bRetValid==0 ) *pbEof = 1;
  180671. return iRet;
  180672. }
  180673. /*
  180674. ** Argument pTerm must be a synonym iterator.
  180675. */
  180676. static int fts5ExprSynonymList(
  180677. Fts5ExprTerm *pTerm,
  180678. i64 iRowid,
  180679. Fts5Buffer *pBuf, /* Use this buffer for space if required */
  180680. u8 **pa, int *pn
  180681. ){
  180682. Fts5PoslistReader aStatic[4];
  180683. Fts5PoslistReader *aIter = aStatic;
  180684. int nIter = 0;
  180685. int nAlloc = 4;
  180686. int rc = SQLITE_OK;
  180687. Fts5ExprTerm *p;
  180688. assert( pTerm->pSynonym );
  180689. for(p=pTerm; p; p=p->pSynonym){
  180690. Fts5IndexIter *pIter = p->pIter;
  180691. if( sqlite3Fts5IterEof(pIter)==0 && pIter->iRowid==iRowid ){
  180692. if( pIter->nData==0 ) continue;
  180693. if( nIter==nAlloc ){
  180694. int nByte = sizeof(Fts5PoslistReader) * nAlloc * 2;
  180695. Fts5PoslistReader *aNew = (Fts5PoslistReader*)sqlite3_malloc(nByte);
  180696. if( aNew==0 ){
  180697. rc = SQLITE_NOMEM;
  180698. goto synonym_poslist_out;
  180699. }
  180700. memcpy(aNew, aIter, sizeof(Fts5PoslistReader) * nIter);
  180701. nAlloc = nAlloc*2;
  180702. if( aIter!=aStatic ) sqlite3_free(aIter);
  180703. aIter = aNew;
  180704. }
  180705. sqlite3Fts5PoslistReaderInit(pIter->pData, pIter->nData, &aIter[nIter]);
  180706. assert( aIter[nIter].bEof==0 );
  180707. nIter++;
  180708. }
  180709. }
  180710. if( nIter==1 ){
  180711. *pa = (u8*)aIter[0].a;
  180712. *pn = aIter[0].n;
  180713. }else{
  180714. Fts5PoslistWriter writer = {0};
  180715. i64 iPrev = -1;
  180716. fts5BufferZero(pBuf);
  180717. while( 1 ){
  180718. int i;
  180719. i64 iMin = FTS5_LARGEST_INT64;
  180720. for(i=0; i<nIter; i++){
  180721. if( aIter[i].bEof==0 ){
  180722. if( aIter[i].iPos==iPrev ){
  180723. if( sqlite3Fts5PoslistReaderNext(&aIter[i]) ) continue;
  180724. }
  180725. if( aIter[i].iPos<iMin ){
  180726. iMin = aIter[i].iPos;
  180727. }
  180728. }
  180729. }
  180730. if( iMin==FTS5_LARGEST_INT64 || rc!=SQLITE_OK ) break;
  180731. rc = sqlite3Fts5PoslistWriterAppend(pBuf, &writer, iMin);
  180732. iPrev = iMin;
  180733. }
  180734. if( rc==SQLITE_OK ){
  180735. *pa = pBuf->p;
  180736. *pn = pBuf->n;
  180737. }
  180738. }
  180739. synonym_poslist_out:
  180740. if( aIter!=aStatic ) sqlite3_free(aIter);
  180741. return rc;
  180742. }
  180743. /*
  180744. ** All individual term iterators in pPhrase are guaranteed to be valid and
  180745. ** pointing to the same rowid when this function is called. This function
  180746. ** checks if the current rowid really is a match, and if so populates
  180747. ** the pPhrase->poslist buffer accordingly. Output parameter *pbMatch
  180748. ** is set to true if this is really a match, or false otherwise.
  180749. **
  180750. ** SQLITE_OK is returned if an error occurs, or an SQLite error code
  180751. ** otherwise. It is not considered an error code if the current rowid is
  180752. ** not a match.
  180753. */
  180754. static int fts5ExprPhraseIsMatch(
  180755. Fts5ExprNode *pNode, /* Node pPhrase belongs to */
  180756. Fts5ExprPhrase *pPhrase, /* Phrase object to initialize */
  180757. int *pbMatch /* OUT: Set to true if really a match */
  180758. ){
  180759. Fts5PoslistWriter writer = {0};
  180760. Fts5PoslistReader aStatic[4];
  180761. Fts5PoslistReader *aIter = aStatic;
  180762. int i;
  180763. int rc = SQLITE_OK;
  180764. int bFirst = pPhrase->aTerm[0].bFirst;
  180765. fts5BufferZero(&pPhrase->poslist);
  180766. /* If the aStatic[] array is not large enough, allocate a large array
  180767. ** using sqlite3_malloc(). This approach could be improved upon. */
  180768. if( pPhrase->nTerm>ArraySize(aStatic) ){
  180769. int nByte = sizeof(Fts5PoslistReader) * pPhrase->nTerm;
  180770. aIter = (Fts5PoslistReader*)sqlite3_malloc(nByte);
  180771. if( !aIter ) return SQLITE_NOMEM;
  180772. }
  180773. memset(aIter, 0, sizeof(Fts5PoslistReader) * pPhrase->nTerm);
  180774. /* Initialize a term iterator for each term in the phrase */
  180775. for(i=0; i<pPhrase->nTerm; i++){
  180776. Fts5ExprTerm *pTerm = &pPhrase->aTerm[i];
  180777. int n = 0;
  180778. int bFlag = 0;
  180779. u8 *a = 0;
  180780. if( pTerm->pSynonym ){
  180781. Fts5Buffer buf = {0, 0, 0};
  180782. rc = fts5ExprSynonymList(pTerm, pNode->iRowid, &buf, &a, &n);
  180783. if( rc ){
  180784. sqlite3_free(a);
  180785. goto ismatch_out;
  180786. }
  180787. if( a==buf.p ) bFlag = 1;
  180788. }else{
  180789. a = (u8*)pTerm->pIter->pData;
  180790. n = pTerm->pIter->nData;
  180791. }
  180792. sqlite3Fts5PoslistReaderInit(a, n, &aIter[i]);
  180793. aIter[i].bFlag = (u8)bFlag;
  180794. if( aIter[i].bEof ) goto ismatch_out;
  180795. }
  180796. while( 1 ){
  180797. int bMatch;
  180798. i64 iPos = aIter[0].iPos;
  180799. do {
  180800. bMatch = 1;
  180801. for(i=0; i<pPhrase->nTerm; i++){
  180802. Fts5PoslistReader *pPos = &aIter[i];
  180803. i64 iAdj = iPos + i;
  180804. if( pPos->iPos!=iAdj ){
  180805. bMatch = 0;
  180806. while( pPos->iPos<iAdj ){
  180807. if( sqlite3Fts5PoslistReaderNext(pPos) ) goto ismatch_out;
  180808. }
  180809. if( pPos->iPos>iAdj ) iPos = pPos->iPos-i;
  180810. }
  180811. }
  180812. }while( bMatch==0 );
  180813. /* Append position iPos to the output */
  180814. if( bFirst==0 || FTS5_POS2OFFSET(iPos)==0 ){
  180815. rc = sqlite3Fts5PoslistWriterAppend(&pPhrase->poslist, &writer, iPos);
  180816. if( rc!=SQLITE_OK ) goto ismatch_out;
  180817. }
  180818. for(i=0; i<pPhrase->nTerm; i++){
  180819. if( sqlite3Fts5PoslistReaderNext(&aIter[i]) ) goto ismatch_out;
  180820. }
  180821. }
  180822. ismatch_out:
  180823. *pbMatch = (pPhrase->poslist.n>0);
  180824. for(i=0; i<pPhrase->nTerm; i++){
  180825. if( aIter[i].bFlag ) sqlite3_free((u8*)aIter[i].a);
  180826. }
  180827. if( aIter!=aStatic ) sqlite3_free(aIter);
  180828. return rc;
  180829. }
  180830. typedef struct Fts5LookaheadReader Fts5LookaheadReader;
  180831. struct Fts5LookaheadReader {
  180832. const u8 *a; /* Buffer containing position list */
  180833. int n; /* Size of buffer a[] in bytes */
  180834. int i; /* Current offset in position list */
  180835. i64 iPos; /* Current position */
  180836. i64 iLookahead; /* Next position */
  180837. };
  180838. #define FTS5_LOOKAHEAD_EOF (((i64)1) << 62)
  180839. static int fts5LookaheadReaderNext(Fts5LookaheadReader *p){
  180840. p->iPos = p->iLookahead;
  180841. if( sqlite3Fts5PoslistNext64(p->a, p->n, &p->i, &p->iLookahead) ){
  180842. p->iLookahead = FTS5_LOOKAHEAD_EOF;
  180843. }
  180844. return (p->iPos==FTS5_LOOKAHEAD_EOF);
  180845. }
  180846. static int fts5LookaheadReaderInit(
  180847. const u8 *a, int n, /* Buffer to read position list from */
  180848. Fts5LookaheadReader *p /* Iterator object to initialize */
  180849. ){
  180850. memset(p, 0, sizeof(Fts5LookaheadReader));
  180851. p->a = a;
  180852. p->n = n;
  180853. fts5LookaheadReaderNext(p);
  180854. return fts5LookaheadReaderNext(p);
  180855. }
  180856. typedef struct Fts5NearTrimmer Fts5NearTrimmer;
  180857. struct Fts5NearTrimmer {
  180858. Fts5LookaheadReader reader; /* Input iterator */
  180859. Fts5PoslistWriter writer; /* Writer context */
  180860. Fts5Buffer *pOut; /* Output poslist */
  180861. };
  180862. /*
  180863. ** The near-set object passed as the first argument contains more than
  180864. ** one phrase. All phrases currently point to the same row. The
  180865. ** Fts5ExprPhrase.poslist buffers are populated accordingly. This function
  180866. ** tests if the current row contains instances of each phrase sufficiently
  180867. ** close together to meet the NEAR constraint. Non-zero is returned if it
  180868. ** does, or zero otherwise.
  180869. **
  180870. ** If in/out parameter (*pRc) is set to other than SQLITE_OK when this
  180871. ** function is called, it is a no-op. Or, if an error (e.g. SQLITE_NOMEM)
  180872. ** occurs within this function (*pRc) is set accordingly before returning.
  180873. ** The return value is undefined in both these cases.
  180874. **
  180875. ** If no error occurs and non-zero (a match) is returned, the position-list
  180876. ** of each phrase object is edited to contain only those entries that
  180877. ** meet the constraint before returning.
  180878. */
  180879. static int fts5ExprNearIsMatch(int *pRc, Fts5ExprNearset *pNear){
  180880. Fts5NearTrimmer aStatic[4];
  180881. Fts5NearTrimmer *a = aStatic;
  180882. Fts5ExprPhrase **apPhrase = pNear->apPhrase;
  180883. int i;
  180884. int rc = *pRc;
  180885. int bMatch;
  180886. assert( pNear->nPhrase>1 );
  180887. /* If the aStatic[] array is not large enough, allocate a large array
  180888. ** using sqlite3_malloc(). This approach could be improved upon. */
  180889. if( pNear->nPhrase>ArraySize(aStatic) ){
  180890. int nByte = sizeof(Fts5NearTrimmer) * pNear->nPhrase;
  180891. a = (Fts5NearTrimmer*)sqlite3Fts5MallocZero(&rc, nByte);
  180892. }else{
  180893. memset(aStatic, 0, sizeof(aStatic));
  180894. }
  180895. if( rc!=SQLITE_OK ){
  180896. *pRc = rc;
  180897. return 0;
  180898. }
  180899. /* Initialize a lookahead iterator for each phrase. After passing the
  180900. ** buffer and buffer size to the lookaside-reader init function, zero
  180901. ** the phrase poslist buffer. The new poslist for the phrase (containing
  180902. ** the same entries as the original with some entries removed on account
  180903. ** of the NEAR constraint) is written over the original even as it is
  180904. ** being read. This is safe as the entries for the new poslist are a
  180905. ** subset of the old, so it is not possible for data yet to be read to
  180906. ** be overwritten. */
  180907. for(i=0; i<pNear->nPhrase; i++){
  180908. Fts5Buffer *pPoslist = &apPhrase[i]->poslist;
  180909. fts5LookaheadReaderInit(pPoslist->p, pPoslist->n, &a[i].reader);
  180910. pPoslist->n = 0;
  180911. a[i].pOut = pPoslist;
  180912. }
  180913. while( 1 ){
  180914. int iAdv;
  180915. i64 iMin;
  180916. i64 iMax;
  180917. /* This block advances the phrase iterators until they point to a set of
  180918. ** entries that together comprise a match. */
  180919. iMax = a[0].reader.iPos;
  180920. do {
  180921. bMatch = 1;
  180922. for(i=0; i<pNear->nPhrase; i++){
  180923. Fts5LookaheadReader *pPos = &a[i].reader;
  180924. iMin = iMax - pNear->apPhrase[i]->nTerm - pNear->nNear;
  180925. if( pPos->iPos<iMin || pPos->iPos>iMax ){
  180926. bMatch = 0;
  180927. while( pPos->iPos<iMin ){
  180928. if( fts5LookaheadReaderNext(pPos) ) goto ismatch_out;
  180929. }
  180930. if( pPos->iPos>iMax ) iMax = pPos->iPos;
  180931. }
  180932. }
  180933. }while( bMatch==0 );
  180934. /* Add an entry to each output position list */
  180935. for(i=0; i<pNear->nPhrase; i++){
  180936. i64 iPos = a[i].reader.iPos;
  180937. Fts5PoslistWriter *pWriter = &a[i].writer;
  180938. if( a[i].pOut->n==0 || iPos!=pWriter->iPrev ){
  180939. sqlite3Fts5PoslistWriterAppend(a[i].pOut, pWriter, iPos);
  180940. }
  180941. }
  180942. iAdv = 0;
  180943. iMin = a[0].reader.iLookahead;
  180944. for(i=0; i<pNear->nPhrase; i++){
  180945. if( a[i].reader.iLookahead < iMin ){
  180946. iMin = a[i].reader.iLookahead;
  180947. iAdv = i;
  180948. }
  180949. }
  180950. if( fts5LookaheadReaderNext(&a[iAdv].reader) ) goto ismatch_out;
  180951. }
  180952. ismatch_out: {
  180953. int bRet = a[0].pOut->n>0;
  180954. *pRc = rc;
  180955. if( a!=aStatic ) sqlite3_free(a);
  180956. return bRet;
  180957. }
  180958. }
  180959. /*
  180960. ** Advance iterator pIter until it points to a value equal to or laster
  180961. ** than the initial value of *piLast. If this means the iterator points
  180962. ** to a value laster than *piLast, update *piLast to the new lastest value.
  180963. **
  180964. ** If the iterator reaches EOF, set *pbEof to true before returning. If
  180965. ** an error occurs, set *pRc to an error code. If either *pbEof or *pRc
  180966. ** are set, return a non-zero value. Otherwise, return zero.
  180967. */
  180968. static int fts5ExprAdvanceto(
  180969. Fts5IndexIter *pIter, /* Iterator to advance */
  180970. int bDesc, /* True if iterator is "rowid DESC" */
  180971. i64 *piLast, /* IN/OUT: Lastest rowid seen so far */
  180972. int *pRc, /* OUT: Error code */
  180973. int *pbEof /* OUT: Set to true if EOF */
  180974. ){
  180975. i64 iLast = *piLast;
  180976. i64 iRowid;
  180977. iRowid = pIter->iRowid;
  180978. if( (bDesc==0 && iLast>iRowid) || (bDesc && iLast<iRowid) ){
  180979. int rc = sqlite3Fts5IterNextFrom(pIter, iLast);
  180980. if( rc || sqlite3Fts5IterEof(pIter) ){
  180981. *pRc = rc;
  180982. *pbEof = 1;
  180983. return 1;
  180984. }
  180985. iRowid = pIter->iRowid;
  180986. assert( (bDesc==0 && iRowid>=iLast) || (bDesc==1 && iRowid<=iLast) );
  180987. }
  180988. *piLast = iRowid;
  180989. return 0;
  180990. }
  180991. static int fts5ExprSynonymAdvanceto(
  180992. Fts5ExprTerm *pTerm, /* Term iterator to advance */
  180993. int bDesc, /* True if iterator is "rowid DESC" */
  180994. i64 *piLast, /* IN/OUT: Lastest rowid seen so far */
  180995. int *pRc /* OUT: Error code */
  180996. ){
  180997. int rc = SQLITE_OK;
  180998. i64 iLast = *piLast;
  180999. Fts5ExprTerm *p;
  181000. int bEof = 0;
  181001. for(p=pTerm; rc==SQLITE_OK && p; p=p->pSynonym){
  181002. if( sqlite3Fts5IterEof(p->pIter)==0 ){
  181003. i64 iRowid = p->pIter->iRowid;
  181004. if( (bDesc==0 && iLast>iRowid) || (bDesc && iLast<iRowid) ){
  181005. rc = sqlite3Fts5IterNextFrom(p->pIter, iLast);
  181006. }
  181007. }
  181008. }
  181009. if( rc!=SQLITE_OK ){
  181010. *pRc = rc;
  181011. bEof = 1;
  181012. }else{
  181013. *piLast = fts5ExprSynonymRowid(pTerm, bDesc, &bEof);
  181014. }
  181015. return bEof;
  181016. }
  181017. static int fts5ExprNearTest(
  181018. int *pRc,
  181019. Fts5Expr *pExpr, /* Expression that pNear is a part of */
  181020. Fts5ExprNode *pNode /* The "NEAR" node (FTS5_STRING) */
  181021. ){
  181022. Fts5ExprNearset *pNear = pNode->pNear;
  181023. int rc = *pRc;
  181024. if( pExpr->pConfig->eDetail!=FTS5_DETAIL_FULL ){
  181025. Fts5ExprTerm *pTerm;
  181026. Fts5ExprPhrase *pPhrase = pNear->apPhrase[0];
  181027. pPhrase->poslist.n = 0;
  181028. for(pTerm=&pPhrase->aTerm[0]; pTerm; pTerm=pTerm->pSynonym){
  181029. Fts5IndexIter *pIter = pTerm->pIter;
  181030. if( sqlite3Fts5IterEof(pIter)==0 ){
  181031. if( pIter->iRowid==pNode->iRowid && pIter->nData>0 ){
  181032. pPhrase->poslist.n = 1;
  181033. }
  181034. }
  181035. }
  181036. return pPhrase->poslist.n;
  181037. }else{
  181038. int i;
  181039. /* Check that each phrase in the nearset matches the current row.
  181040. ** Populate the pPhrase->poslist buffers at the same time. If any
  181041. ** phrase is not a match, break out of the loop early. */
  181042. for(i=0; rc==SQLITE_OK && i<pNear->nPhrase; i++){
  181043. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  181044. if( pPhrase->nTerm>1 || pPhrase->aTerm[0].pSynonym
  181045. || pNear->pColset || pPhrase->aTerm[0].bFirst
  181046. ){
  181047. int bMatch = 0;
  181048. rc = fts5ExprPhraseIsMatch(pNode, pPhrase, &bMatch);
  181049. if( bMatch==0 ) break;
  181050. }else{
  181051. Fts5IndexIter *pIter = pPhrase->aTerm[0].pIter;
  181052. fts5BufferSet(&rc, &pPhrase->poslist, pIter->nData, pIter->pData);
  181053. }
  181054. }
  181055. *pRc = rc;
  181056. if( i==pNear->nPhrase && (i==1 || fts5ExprNearIsMatch(pRc, pNear)) ){
  181057. return 1;
  181058. }
  181059. return 0;
  181060. }
  181061. }
  181062. /*
  181063. ** Initialize all term iterators in the pNear object. If any term is found
  181064. ** to match no documents at all, return immediately without initializing any
  181065. ** further iterators.
  181066. **
  181067. ** If an error occurs, return an SQLite error code. Otherwise, return
  181068. ** SQLITE_OK. It is not considered an error if some term matches zero
  181069. ** documents.
  181070. */
  181071. static int fts5ExprNearInitAll(
  181072. Fts5Expr *pExpr,
  181073. Fts5ExprNode *pNode
  181074. ){
  181075. Fts5ExprNearset *pNear = pNode->pNear;
  181076. int i;
  181077. assert( pNode->bNomatch==0 );
  181078. for(i=0; i<pNear->nPhrase; i++){
  181079. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  181080. if( pPhrase->nTerm==0 ){
  181081. pNode->bEof = 1;
  181082. return SQLITE_OK;
  181083. }else{
  181084. int j;
  181085. for(j=0; j<pPhrase->nTerm; j++){
  181086. Fts5ExprTerm *pTerm = &pPhrase->aTerm[j];
  181087. Fts5ExprTerm *p;
  181088. int bHit = 0;
  181089. for(p=pTerm; p; p=p->pSynonym){
  181090. int rc;
  181091. if( p->pIter ){
  181092. sqlite3Fts5IterClose(p->pIter);
  181093. p->pIter = 0;
  181094. }
  181095. rc = sqlite3Fts5IndexQuery(
  181096. pExpr->pIndex, p->zTerm, (int)strlen(p->zTerm),
  181097. (pTerm->bPrefix ? FTS5INDEX_QUERY_PREFIX : 0) |
  181098. (pExpr->bDesc ? FTS5INDEX_QUERY_DESC : 0),
  181099. pNear->pColset,
  181100. &p->pIter
  181101. );
  181102. assert( (rc==SQLITE_OK)==(p->pIter!=0) );
  181103. if( rc!=SQLITE_OK ) return rc;
  181104. if( 0==sqlite3Fts5IterEof(p->pIter) ){
  181105. bHit = 1;
  181106. }
  181107. }
  181108. if( bHit==0 ){
  181109. pNode->bEof = 1;
  181110. return SQLITE_OK;
  181111. }
  181112. }
  181113. }
  181114. }
  181115. pNode->bEof = 0;
  181116. return SQLITE_OK;
  181117. }
  181118. /*
  181119. ** If pExpr is an ASC iterator, this function returns a value with the
  181120. ** same sign as:
  181121. **
  181122. ** (iLhs - iRhs)
  181123. **
  181124. ** Otherwise, if this is a DESC iterator, the opposite is returned:
  181125. **
  181126. ** (iRhs - iLhs)
  181127. */
  181128. static int fts5RowidCmp(
  181129. Fts5Expr *pExpr,
  181130. i64 iLhs,
  181131. i64 iRhs
  181132. ){
  181133. assert( pExpr->bDesc==0 || pExpr->bDesc==1 );
  181134. if( pExpr->bDesc==0 ){
  181135. if( iLhs<iRhs ) return -1;
  181136. return (iLhs > iRhs);
  181137. }else{
  181138. if( iLhs>iRhs ) return -1;
  181139. return (iLhs < iRhs);
  181140. }
  181141. }
  181142. static void fts5ExprSetEof(Fts5ExprNode *pNode){
  181143. int i;
  181144. pNode->bEof = 1;
  181145. pNode->bNomatch = 0;
  181146. for(i=0; i<pNode->nChild; i++){
  181147. fts5ExprSetEof(pNode->apChild[i]);
  181148. }
  181149. }
  181150. static void fts5ExprNodeZeroPoslist(Fts5ExprNode *pNode){
  181151. if( pNode->eType==FTS5_STRING || pNode->eType==FTS5_TERM ){
  181152. Fts5ExprNearset *pNear = pNode->pNear;
  181153. int i;
  181154. for(i=0; i<pNear->nPhrase; i++){
  181155. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  181156. pPhrase->poslist.n = 0;
  181157. }
  181158. }else{
  181159. int i;
  181160. for(i=0; i<pNode->nChild; i++){
  181161. fts5ExprNodeZeroPoslist(pNode->apChild[i]);
  181162. }
  181163. }
  181164. }
  181165. /*
  181166. ** Compare the values currently indicated by the two nodes as follows:
  181167. **
  181168. ** res = (*p1) - (*p2)
  181169. **
  181170. ** Nodes that point to values that come later in the iteration order are
  181171. ** considered to be larger. Nodes at EOF are the largest of all.
  181172. **
  181173. ** This means that if the iteration order is ASC, then numerically larger
  181174. ** rowids are considered larger. Or if it is the default DESC, numerically
  181175. ** smaller rowids are larger.
  181176. */
  181177. static int fts5NodeCompare(
  181178. Fts5Expr *pExpr,
  181179. Fts5ExprNode *p1,
  181180. Fts5ExprNode *p2
  181181. ){
  181182. if( p2->bEof ) return -1;
  181183. if( p1->bEof ) return +1;
  181184. return fts5RowidCmp(pExpr, p1->iRowid, p2->iRowid);
  181185. }
  181186. /*
  181187. ** All individual term iterators in pNear are guaranteed to be valid when
  181188. ** this function is called. This function checks if all term iterators
  181189. ** point to the same rowid, and if not, advances them until they do.
  181190. ** If an EOF is reached before this happens, *pbEof is set to true before
  181191. ** returning.
  181192. **
  181193. ** SQLITE_OK is returned if an error occurs, or an SQLite error code
  181194. ** otherwise. It is not considered an error code if an iterator reaches
  181195. ** EOF.
  181196. */
  181197. static int fts5ExprNodeTest_STRING(
  181198. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  181199. Fts5ExprNode *pNode
  181200. ){
  181201. Fts5ExprNearset *pNear = pNode->pNear;
  181202. Fts5ExprPhrase *pLeft = pNear->apPhrase[0];
  181203. int rc = SQLITE_OK;
  181204. i64 iLast; /* Lastest rowid any iterator points to */
  181205. int i, j; /* Phrase and token index, respectively */
  181206. int bMatch; /* True if all terms are at the same rowid */
  181207. const int bDesc = pExpr->bDesc;
  181208. /* Check that this node should not be FTS5_TERM */
  181209. assert( pNear->nPhrase>1
  181210. || pNear->apPhrase[0]->nTerm>1
  181211. || pNear->apPhrase[0]->aTerm[0].pSynonym
  181212. || pNear->apPhrase[0]->aTerm[0].bFirst
  181213. );
  181214. /* Initialize iLast, the "lastest" rowid any iterator points to. If the
  181215. ** iterator skips through rowids in the default ascending order, this means
  181216. ** the maximum rowid. Or, if the iterator is "ORDER BY rowid DESC", then it
  181217. ** means the minimum rowid. */
  181218. if( pLeft->aTerm[0].pSynonym ){
  181219. iLast = fts5ExprSynonymRowid(&pLeft->aTerm[0], bDesc, 0);
  181220. }else{
  181221. iLast = pLeft->aTerm[0].pIter->iRowid;
  181222. }
  181223. do {
  181224. bMatch = 1;
  181225. for(i=0; i<pNear->nPhrase; i++){
  181226. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  181227. for(j=0; j<pPhrase->nTerm; j++){
  181228. Fts5ExprTerm *pTerm = &pPhrase->aTerm[j];
  181229. if( pTerm->pSynonym ){
  181230. i64 iRowid = fts5ExprSynonymRowid(pTerm, bDesc, 0);
  181231. if( iRowid==iLast ) continue;
  181232. bMatch = 0;
  181233. if( fts5ExprSynonymAdvanceto(pTerm, bDesc, &iLast, &rc) ){
  181234. pNode->bNomatch = 0;
  181235. pNode->bEof = 1;
  181236. return rc;
  181237. }
  181238. }else{
  181239. Fts5IndexIter *pIter = pPhrase->aTerm[j].pIter;
  181240. if( pIter->iRowid==iLast || pIter->bEof ) continue;
  181241. bMatch = 0;
  181242. if( fts5ExprAdvanceto(pIter, bDesc, &iLast, &rc, &pNode->bEof) ){
  181243. return rc;
  181244. }
  181245. }
  181246. }
  181247. }
  181248. }while( bMatch==0 );
  181249. pNode->iRowid = iLast;
  181250. pNode->bNomatch = ((0==fts5ExprNearTest(&rc, pExpr, pNode)) && rc==SQLITE_OK);
  181251. assert( pNode->bEof==0 || pNode->bNomatch==0 );
  181252. return rc;
  181253. }
  181254. /*
  181255. ** Advance the first term iterator in the first phrase of pNear. Set output
  181256. ** variable *pbEof to true if it reaches EOF or if an error occurs.
  181257. **
  181258. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  181259. ** occurs.
  181260. */
  181261. static int fts5ExprNodeNext_STRING(
  181262. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  181263. Fts5ExprNode *pNode, /* FTS5_STRING or FTS5_TERM node */
  181264. int bFromValid,
  181265. i64 iFrom
  181266. ){
  181267. Fts5ExprTerm *pTerm = &pNode->pNear->apPhrase[0]->aTerm[0];
  181268. int rc = SQLITE_OK;
  181269. pNode->bNomatch = 0;
  181270. if( pTerm->pSynonym ){
  181271. int bEof = 1;
  181272. Fts5ExprTerm *p;
  181273. /* Find the firstest rowid any synonym points to. */
  181274. i64 iRowid = fts5ExprSynonymRowid(pTerm, pExpr->bDesc, 0);
  181275. /* Advance each iterator that currently points to iRowid. Or, if iFrom
  181276. ** is valid - each iterator that points to a rowid before iFrom. */
  181277. for(p=pTerm; p; p=p->pSynonym){
  181278. if( sqlite3Fts5IterEof(p->pIter)==0 ){
  181279. i64 ii = p->pIter->iRowid;
  181280. if( ii==iRowid
  181281. || (bFromValid && ii!=iFrom && (ii>iFrom)==pExpr->bDesc)
  181282. ){
  181283. if( bFromValid ){
  181284. rc = sqlite3Fts5IterNextFrom(p->pIter, iFrom);
  181285. }else{
  181286. rc = sqlite3Fts5IterNext(p->pIter);
  181287. }
  181288. if( rc!=SQLITE_OK ) break;
  181289. if( sqlite3Fts5IterEof(p->pIter)==0 ){
  181290. bEof = 0;
  181291. }
  181292. }else{
  181293. bEof = 0;
  181294. }
  181295. }
  181296. }
  181297. /* Set the EOF flag if either all synonym iterators are at EOF or an
  181298. ** error has occurred. */
  181299. pNode->bEof = (rc || bEof);
  181300. }else{
  181301. Fts5IndexIter *pIter = pTerm->pIter;
  181302. assert( Fts5NodeIsString(pNode) );
  181303. if( bFromValid ){
  181304. rc = sqlite3Fts5IterNextFrom(pIter, iFrom);
  181305. }else{
  181306. rc = sqlite3Fts5IterNext(pIter);
  181307. }
  181308. pNode->bEof = (rc || sqlite3Fts5IterEof(pIter));
  181309. }
  181310. if( pNode->bEof==0 ){
  181311. assert( rc==SQLITE_OK );
  181312. rc = fts5ExprNodeTest_STRING(pExpr, pNode);
  181313. }
  181314. return rc;
  181315. }
  181316. static int fts5ExprNodeTest_TERM(
  181317. Fts5Expr *pExpr, /* Expression that pNear is a part of */
  181318. Fts5ExprNode *pNode /* The "NEAR" node (FTS5_TERM) */
  181319. ){
  181320. /* As this "NEAR" object is actually a single phrase that consists
  181321. ** of a single term only, grab pointers into the poslist managed by the
  181322. ** fts5_index.c iterator object. This is much faster than synthesizing
  181323. ** a new poslist the way we have to for more complicated phrase or NEAR
  181324. ** expressions. */
  181325. Fts5ExprPhrase *pPhrase = pNode->pNear->apPhrase[0];
  181326. Fts5IndexIter *pIter = pPhrase->aTerm[0].pIter;
  181327. assert( pNode->eType==FTS5_TERM );
  181328. assert( pNode->pNear->nPhrase==1 && pPhrase->nTerm==1 );
  181329. assert( pPhrase->aTerm[0].pSynonym==0 );
  181330. pPhrase->poslist.n = pIter->nData;
  181331. if( pExpr->pConfig->eDetail==FTS5_DETAIL_FULL ){
  181332. pPhrase->poslist.p = (u8*)pIter->pData;
  181333. }
  181334. pNode->iRowid = pIter->iRowid;
  181335. pNode->bNomatch = (pPhrase->poslist.n==0);
  181336. return SQLITE_OK;
  181337. }
  181338. /*
  181339. ** xNext() method for a node of type FTS5_TERM.
  181340. */
  181341. static int fts5ExprNodeNext_TERM(
  181342. Fts5Expr *pExpr,
  181343. Fts5ExprNode *pNode,
  181344. int bFromValid,
  181345. i64 iFrom
  181346. ){
  181347. int rc;
  181348. Fts5IndexIter *pIter = pNode->pNear->apPhrase[0]->aTerm[0].pIter;
  181349. assert( pNode->bEof==0 );
  181350. if( bFromValid ){
  181351. rc = sqlite3Fts5IterNextFrom(pIter, iFrom);
  181352. }else{
  181353. rc = sqlite3Fts5IterNext(pIter);
  181354. }
  181355. if( rc==SQLITE_OK && sqlite3Fts5IterEof(pIter)==0 ){
  181356. rc = fts5ExprNodeTest_TERM(pExpr, pNode);
  181357. }else{
  181358. pNode->bEof = 1;
  181359. pNode->bNomatch = 0;
  181360. }
  181361. return rc;
  181362. }
  181363. static void fts5ExprNodeTest_OR(
  181364. Fts5Expr *pExpr, /* Expression of which pNode is a part */
  181365. Fts5ExprNode *pNode /* Expression node to test */
  181366. ){
  181367. Fts5ExprNode *pNext = pNode->apChild[0];
  181368. int i;
  181369. for(i=1; i<pNode->nChild; i++){
  181370. Fts5ExprNode *pChild = pNode->apChild[i];
  181371. int cmp = fts5NodeCompare(pExpr, pNext, pChild);
  181372. if( cmp>0 || (cmp==0 && pChild->bNomatch==0) ){
  181373. pNext = pChild;
  181374. }
  181375. }
  181376. pNode->iRowid = pNext->iRowid;
  181377. pNode->bEof = pNext->bEof;
  181378. pNode->bNomatch = pNext->bNomatch;
  181379. }
  181380. static int fts5ExprNodeNext_OR(
  181381. Fts5Expr *pExpr,
  181382. Fts5ExprNode *pNode,
  181383. int bFromValid,
  181384. i64 iFrom
  181385. ){
  181386. int i;
  181387. i64 iLast = pNode->iRowid;
  181388. for(i=0; i<pNode->nChild; i++){
  181389. Fts5ExprNode *p1 = pNode->apChild[i];
  181390. assert( p1->bEof || fts5RowidCmp(pExpr, p1->iRowid, iLast)>=0 );
  181391. if( p1->bEof==0 ){
  181392. if( (p1->iRowid==iLast)
  181393. || (bFromValid && fts5RowidCmp(pExpr, p1->iRowid, iFrom)<0)
  181394. ){
  181395. int rc = fts5ExprNodeNext(pExpr, p1, bFromValid, iFrom);
  181396. if( rc!=SQLITE_OK ){
  181397. pNode->bNomatch = 0;
  181398. return rc;
  181399. }
  181400. }
  181401. }
  181402. }
  181403. fts5ExprNodeTest_OR(pExpr, pNode);
  181404. return SQLITE_OK;
  181405. }
  181406. /*
  181407. ** Argument pNode is an FTS5_AND node.
  181408. */
  181409. static int fts5ExprNodeTest_AND(
  181410. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  181411. Fts5ExprNode *pAnd /* FTS5_AND node to advance */
  181412. ){
  181413. int iChild;
  181414. i64 iLast = pAnd->iRowid;
  181415. int rc = SQLITE_OK;
  181416. int bMatch;
  181417. assert( pAnd->bEof==0 );
  181418. do {
  181419. pAnd->bNomatch = 0;
  181420. bMatch = 1;
  181421. for(iChild=0; iChild<pAnd->nChild; iChild++){
  181422. Fts5ExprNode *pChild = pAnd->apChild[iChild];
  181423. int cmp = fts5RowidCmp(pExpr, iLast, pChild->iRowid);
  181424. if( cmp>0 ){
  181425. /* Advance pChild until it points to iLast or laster */
  181426. rc = fts5ExprNodeNext(pExpr, pChild, 1, iLast);
  181427. if( rc!=SQLITE_OK ){
  181428. pAnd->bNomatch = 0;
  181429. return rc;
  181430. }
  181431. }
  181432. /* If the child node is now at EOF, so is the parent AND node. Otherwise,
  181433. ** the child node is guaranteed to have advanced at least as far as
  181434. ** rowid iLast. So if it is not at exactly iLast, pChild->iRowid is the
  181435. ** new lastest rowid seen so far. */
  181436. assert( pChild->bEof || fts5RowidCmp(pExpr, iLast, pChild->iRowid)<=0 );
  181437. if( pChild->bEof ){
  181438. fts5ExprSetEof(pAnd);
  181439. bMatch = 1;
  181440. break;
  181441. }else if( iLast!=pChild->iRowid ){
  181442. bMatch = 0;
  181443. iLast = pChild->iRowid;
  181444. }
  181445. if( pChild->bNomatch ){
  181446. pAnd->bNomatch = 1;
  181447. }
  181448. }
  181449. }while( bMatch==0 );
  181450. if( pAnd->bNomatch && pAnd!=pExpr->pRoot ){
  181451. fts5ExprNodeZeroPoslist(pAnd);
  181452. }
  181453. pAnd->iRowid = iLast;
  181454. return SQLITE_OK;
  181455. }
  181456. static int fts5ExprNodeNext_AND(
  181457. Fts5Expr *pExpr,
  181458. Fts5ExprNode *pNode,
  181459. int bFromValid,
  181460. i64 iFrom
  181461. ){
  181462. int rc = fts5ExprNodeNext(pExpr, pNode->apChild[0], bFromValid, iFrom);
  181463. if( rc==SQLITE_OK ){
  181464. rc = fts5ExprNodeTest_AND(pExpr, pNode);
  181465. }else{
  181466. pNode->bNomatch = 0;
  181467. }
  181468. return rc;
  181469. }
  181470. static int fts5ExprNodeTest_NOT(
  181471. Fts5Expr *pExpr, /* Expression pPhrase belongs to */
  181472. Fts5ExprNode *pNode /* FTS5_NOT node to advance */
  181473. ){
  181474. int rc = SQLITE_OK;
  181475. Fts5ExprNode *p1 = pNode->apChild[0];
  181476. Fts5ExprNode *p2 = pNode->apChild[1];
  181477. assert( pNode->nChild==2 );
  181478. while( rc==SQLITE_OK && p1->bEof==0 ){
  181479. int cmp = fts5NodeCompare(pExpr, p1, p2);
  181480. if( cmp>0 ){
  181481. rc = fts5ExprNodeNext(pExpr, p2, 1, p1->iRowid);
  181482. cmp = fts5NodeCompare(pExpr, p1, p2);
  181483. }
  181484. assert( rc!=SQLITE_OK || cmp<=0 );
  181485. if( cmp || p2->bNomatch ) break;
  181486. rc = fts5ExprNodeNext(pExpr, p1, 0, 0);
  181487. }
  181488. pNode->bEof = p1->bEof;
  181489. pNode->bNomatch = p1->bNomatch;
  181490. pNode->iRowid = p1->iRowid;
  181491. if( p1->bEof ){
  181492. fts5ExprNodeZeroPoslist(p2);
  181493. }
  181494. return rc;
  181495. }
  181496. static int fts5ExprNodeNext_NOT(
  181497. Fts5Expr *pExpr,
  181498. Fts5ExprNode *pNode,
  181499. int bFromValid,
  181500. i64 iFrom
  181501. ){
  181502. int rc = fts5ExprNodeNext(pExpr, pNode->apChild[0], bFromValid, iFrom);
  181503. if( rc==SQLITE_OK ){
  181504. rc = fts5ExprNodeTest_NOT(pExpr, pNode);
  181505. }
  181506. if( rc!=SQLITE_OK ){
  181507. pNode->bNomatch = 0;
  181508. }
  181509. return rc;
  181510. }
  181511. /*
  181512. ** If pNode currently points to a match, this function returns SQLITE_OK
  181513. ** without modifying it. Otherwise, pNode is advanced until it does point
  181514. ** to a match or EOF is reached.
  181515. */
  181516. static int fts5ExprNodeTest(
  181517. Fts5Expr *pExpr, /* Expression of which pNode is a part */
  181518. Fts5ExprNode *pNode /* Expression node to test */
  181519. ){
  181520. int rc = SQLITE_OK;
  181521. if( pNode->bEof==0 ){
  181522. switch( pNode->eType ){
  181523. case FTS5_STRING: {
  181524. rc = fts5ExprNodeTest_STRING(pExpr, pNode);
  181525. break;
  181526. }
  181527. case FTS5_TERM: {
  181528. rc = fts5ExprNodeTest_TERM(pExpr, pNode);
  181529. break;
  181530. }
  181531. case FTS5_AND: {
  181532. rc = fts5ExprNodeTest_AND(pExpr, pNode);
  181533. break;
  181534. }
  181535. case FTS5_OR: {
  181536. fts5ExprNodeTest_OR(pExpr, pNode);
  181537. break;
  181538. }
  181539. default: assert( pNode->eType==FTS5_NOT ); {
  181540. rc = fts5ExprNodeTest_NOT(pExpr, pNode);
  181541. break;
  181542. }
  181543. }
  181544. }
  181545. return rc;
  181546. }
  181547. /*
  181548. ** Set node pNode, which is part of expression pExpr, to point to the first
  181549. ** match. If there are no matches, set the Node.bEof flag to indicate EOF.
  181550. **
  181551. ** Return an SQLite error code if an error occurs, or SQLITE_OK otherwise.
  181552. ** It is not an error if there are no matches.
  181553. */
  181554. static int fts5ExprNodeFirst(Fts5Expr *pExpr, Fts5ExprNode *pNode){
  181555. int rc = SQLITE_OK;
  181556. pNode->bEof = 0;
  181557. pNode->bNomatch = 0;
  181558. if( Fts5NodeIsString(pNode) ){
  181559. /* Initialize all term iterators in the NEAR object. */
  181560. rc = fts5ExprNearInitAll(pExpr, pNode);
  181561. }else if( pNode->xNext==0 ){
  181562. pNode->bEof = 1;
  181563. }else{
  181564. int i;
  181565. int nEof = 0;
  181566. for(i=0; i<pNode->nChild && rc==SQLITE_OK; i++){
  181567. Fts5ExprNode *pChild = pNode->apChild[i];
  181568. rc = fts5ExprNodeFirst(pExpr, pNode->apChild[i]);
  181569. assert( pChild->bEof==0 || pChild->bEof==1 );
  181570. nEof += pChild->bEof;
  181571. }
  181572. pNode->iRowid = pNode->apChild[0]->iRowid;
  181573. switch( pNode->eType ){
  181574. case FTS5_AND:
  181575. if( nEof>0 ) fts5ExprSetEof(pNode);
  181576. break;
  181577. case FTS5_OR:
  181578. if( pNode->nChild==nEof ) fts5ExprSetEof(pNode);
  181579. break;
  181580. default:
  181581. assert( pNode->eType==FTS5_NOT );
  181582. pNode->bEof = pNode->apChild[0]->bEof;
  181583. break;
  181584. }
  181585. }
  181586. if( rc==SQLITE_OK ){
  181587. rc = fts5ExprNodeTest(pExpr, pNode);
  181588. }
  181589. return rc;
  181590. }
  181591. /*
  181592. ** Begin iterating through the set of documents in index pIdx matched by
  181593. ** the MATCH expression passed as the first argument. If the "bDesc"
  181594. ** parameter is passed a non-zero value, iteration is in descending rowid
  181595. ** order. Or, if it is zero, in ascending order.
  181596. **
  181597. ** If iterating in ascending rowid order (bDesc==0), the first document
  181598. ** visited is that with the smallest rowid that is larger than or equal
  181599. ** to parameter iFirst. Or, if iterating in ascending order (bDesc==1),
  181600. ** then the first document visited must have a rowid smaller than or
  181601. ** equal to iFirst.
  181602. **
  181603. ** Return SQLITE_OK if successful, or an SQLite error code otherwise. It
  181604. ** is not considered an error if the query does not match any documents.
  181605. */
  181606. static int sqlite3Fts5ExprFirst(Fts5Expr *p, Fts5Index *pIdx, i64 iFirst, int bDesc){
  181607. Fts5ExprNode *pRoot = p->pRoot;
  181608. int rc; /* Return code */
  181609. p->pIndex = pIdx;
  181610. p->bDesc = bDesc;
  181611. rc = fts5ExprNodeFirst(p, pRoot);
  181612. /* If not at EOF but the current rowid occurs earlier than iFirst in
  181613. ** the iteration order, move to document iFirst or later. */
  181614. if( rc==SQLITE_OK
  181615. && 0==pRoot->bEof
  181616. && fts5RowidCmp(p, pRoot->iRowid, iFirst)<0
  181617. ){
  181618. rc = fts5ExprNodeNext(p, pRoot, 1, iFirst);
  181619. }
  181620. /* If the iterator is not at a real match, skip forward until it is. */
  181621. while( pRoot->bNomatch ){
  181622. assert( pRoot->bEof==0 && rc==SQLITE_OK );
  181623. rc = fts5ExprNodeNext(p, pRoot, 0, 0);
  181624. }
  181625. return rc;
  181626. }
  181627. /*
  181628. ** Move to the next document
  181629. **
  181630. ** Return SQLITE_OK if successful, or an SQLite error code otherwise. It
  181631. ** is not considered an error if the query does not match any documents.
  181632. */
  181633. static int sqlite3Fts5ExprNext(Fts5Expr *p, i64 iLast){
  181634. int rc;
  181635. Fts5ExprNode *pRoot = p->pRoot;
  181636. assert( pRoot->bEof==0 && pRoot->bNomatch==0 );
  181637. do {
  181638. rc = fts5ExprNodeNext(p, pRoot, 0, 0);
  181639. assert( pRoot->bNomatch==0 || (rc==SQLITE_OK && pRoot->bEof==0) );
  181640. }while( pRoot->bNomatch );
  181641. if( fts5RowidCmp(p, pRoot->iRowid, iLast)>0 ){
  181642. pRoot->bEof = 1;
  181643. }
  181644. return rc;
  181645. }
  181646. static int sqlite3Fts5ExprEof(Fts5Expr *p){
  181647. return p->pRoot->bEof;
  181648. }
  181649. static i64 sqlite3Fts5ExprRowid(Fts5Expr *p){
  181650. return p->pRoot->iRowid;
  181651. }
  181652. static int fts5ParseStringFromToken(Fts5Token *pToken, char **pz){
  181653. int rc = SQLITE_OK;
  181654. *pz = sqlite3Fts5Strndup(&rc, pToken->p, pToken->n);
  181655. return rc;
  181656. }
  181657. /*
  181658. ** Free the phrase object passed as the only argument.
  181659. */
  181660. static void fts5ExprPhraseFree(Fts5ExprPhrase *pPhrase){
  181661. if( pPhrase ){
  181662. int i;
  181663. for(i=0; i<pPhrase->nTerm; i++){
  181664. Fts5ExprTerm *pSyn;
  181665. Fts5ExprTerm *pNext;
  181666. Fts5ExprTerm *pTerm = &pPhrase->aTerm[i];
  181667. sqlite3_free(pTerm->zTerm);
  181668. sqlite3Fts5IterClose(pTerm->pIter);
  181669. for(pSyn=pTerm->pSynonym; pSyn; pSyn=pNext){
  181670. pNext = pSyn->pSynonym;
  181671. sqlite3Fts5IterClose(pSyn->pIter);
  181672. fts5BufferFree((Fts5Buffer*)&pSyn[1]);
  181673. sqlite3_free(pSyn);
  181674. }
  181675. }
  181676. if( pPhrase->poslist.nSpace>0 ) fts5BufferFree(&pPhrase->poslist);
  181677. sqlite3_free(pPhrase);
  181678. }
  181679. }
  181680. /*
  181681. ** Set the "bFirst" flag on the first token of the phrase passed as the
  181682. ** only argument.
  181683. */
  181684. static void sqlite3Fts5ParseSetCaret(Fts5ExprPhrase *pPhrase){
  181685. if( pPhrase && pPhrase->nTerm ){
  181686. pPhrase->aTerm[0].bFirst = 1;
  181687. }
  181688. }
  181689. /*
  181690. ** If argument pNear is NULL, then a new Fts5ExprNearset object is allocated
  181691. ** and populated with pPhrase. Or, if pNear is not NULL, phrase pPhrase is
  181692. ** appended to it and the results returned.
  181693. **
  181694. ** If an OOM error occurs, both the pNear and pPhrase objects are freed and
  181695. ** NULL returned.
  181696. */
  181697. static Fts5ExprNearset *sqlite3Fts5ParseNearset(
  181698. Fts5Parse *pParse, /* Parse context */
  181699. Fts5ExprNearset *pNear, /* Existing nearset, or NULL */
  181700. Fts5ExprPhrase *pPhrase /* Recently parsed phrase */
  181701. ){
  181702. const int SZALLOC = 8;
  181703. Fts5ExprNearset *pRet = 0;
  181704. if( pParse->rc==SQLITE_OK ){
  181705. if( pPhrase==0 ){
  181706. return pNear;
  181707. }
  181708. if( pNear==0 ){
  181709. int nByte = sizeof(Fts5ExprNearset) + SZALLOC * sizeof(Fts5ExprPhrase*);
  181710. pRet = sqlite3_malloc(nByte);
  181711. if( pRet==0 ){
  181712. pParse->rc = SQLITE_NOMEM;
  181713. }else{
  181714. memset(pRet, 0, nByte);
  181715. }
  181716. }else if( (pNear->nPhrase % SZALLOC)==0 ){
  181717. int nNew = pNear->nPhrase + SZALLOC;
  181718. int nByte = sizeof(Fts5ExprNearset) + nNew * sizeof(Fts5ExprPhrase*);
  181719. pRet = (Fts5ExprNearset*)sqlite3_realloc(pNear, nByte);
  181720. if( pRet==0 ){
  181721. pParse->rc = SQLITE_NOMEM;
  181722. }
  181723. }else{
  181724. pRet = pNear;
  181725. }
  181726. }
  181727. if( pRet==0 ){
  181728. assert( pParse->rc!=SQLITE_OK );
  181729. sqlite3Fts5ParseNearsetFree(pNear);
  181730. sqlite3Fts5ParsePhraseFree(pPhrase);
  181731. }else{
  181732. if( pRet->nPhrase>0 ){
  181733. Fts5ExprPhrase *pLast = pRet->apPhrase[pRet->nPhrase-1];
  181734. assert( pLast==pParse->apPhrase[pParse->nPhrase-2] );
  181735. if( pPhrase->nTerm==0 ){
  181736. fts5ExprPhraseFree(pPhrase);
  181737. pRet->nPhrase--;
  181738. pParse->nPhrase--;
  181739. pPhrase = pLast;
  181740. }else if( pLast->nTerm==0 ){
  181741. fts5ExprPhraseFree(pLast);
  181742. pParse->apPhrase[pParse->nPhrase-2] = pPhrase;
  181743. pParse->nPhrase--;
  181744. pRet->nPhrase--;
  181745. }
  181746. }
  181747. pRet->apPhrase[pRet->nPhrase++] = pPhrase;
  181748. }
  181749. return pRet;
  181750. }
  181751. typedef struct TokenCtx TokenCtx;
  181752. struct TokenCtx {
  181753. Fts5ExprPhrase *pPhrase;
  181754. int rc;
  181755. };
  181756. /*
  181757. ** Callback for tokenizing terms used by ParseTerm().
  181758. */
  181759. static int fts5ParseTokenize(
  181760. void *pContext, /* Pointer to Fts5InsertCtx object */
  181761. int tflags, /* Mask of FTS5_TOKEN_* flags */
  181762. const char *pToken, /* Buffer containing token */
  181763. int nToken, /* Size of token in bytes */
  181764. int iUnused1, /* Start offset of token */
  181765. int iUnused2 /* End offset of token */
  181766. ){
  181767. int rc = SQLITE_OK;
  181768. const int SZALLOC = 8;
  181769. TokenCtx *pCtx = (TokenCtx*)pContext;
  181770. Fts5ExprPhrase *pPhrase = pCtx->pPhrase;
  181771. UNUSED_PARAM2(iUnused1, iUnused2);
  181772. /* If an error has already occurred, this is a no-op */
  181773. if( pCtx->rc!=SQLITE_OK ) return pCtx->rc;
  181774. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  181775. if( pPhrase && pPhrase->nTerm>0 && (tflags & FTS5_TOKEN_COLOCATED) ){
  181776. Fts5ExprTerm *pSyn;
  181777. int nByte = sizeof(Fts5ExprTerm) + sizeof(Fts5Buffer) + nToken+1;
  181778. pSyn = (Fts5ExprTerm*)sqlite3_malloc(nByte);
  181779. if( pSyn==0 ){
  181780. rc = SQLITE_NOMEM;
  181781. }else{
  181782. memset(pSyn, 0, nByte);
  181783. pSyn->zTerm = ((char*)pSyn) + sizeof(Fts5ExprTerm) + sizeof(Fts5Buffer);
  181784. memcpy(pSyn->zTerm, pToken, nToken);
  181785. pSyn->pSynonym = pPhrase->aTerm[pPhrase->nTerm-1].pSynonym;
  181786. pPhrase->aTerm[pPhrase->nTerm-1].pSynonym = pSyn;
  181787. }
  181788. }else{
  181789. Fts5ExprTerm *pTerm;
  181790. if( pPhrase==0 || (pPhrase->nTerm % SZALLOC)==0 ){
  181791. Fts5ExprPhrase *pNew;
  181792. int nNew = SZALLOC + (pPhrase ? pPhrase->nTerm : 0);
  181793. pNew = (Fts5ExprPhrase*)sqlite3_realloc(pPhrase,
  181794. sizeof(Fts5ExprPhrase) + sizeof(Fts5ExprTerm) * nNew
  181795. );
  181796. if( pNew==0 ){
  181797. rc = SQLITE_NOMEM;
  181798. }else{
  181799. if( pPhrase==0 ) memset(pNew, 0, sizeof(Fts5ExprPhrase));
  181800. pCtx->pPhrase = pPhrase = pNew;
  181801. pNew->nTerm = nNew - SZALLOC;
  181802. }
  181803. }
  181804. if( rc==SQLITE_OK ){
  181805. pTerm = &pPhrase->aTerm[pPhrase->nTerm++];
  181806. memset(pTerm, 0, sizeof(Fts5ExprTerm));
  181807. pTerm->zTerm = sqlite3Fts5Strndup(&rc, pToken, nToken);
  181808. }
  181809. }
  181810. pCtx->rc = rc;
  181811. return rc;
  181812. }
  181813. /*
  181814. ** Free the phrase object passed as the only argument.
  181815. */
  181816. static void sqlite3Fts5ParsePhraseFree(Fts5ExprPhrase *pPhrase){
  181817. fts5ExprPhraseFree(pPhrase);
  181818. }
  181819. /*
  181820. ** Free the phrase object passed as the second argument.
  181821. */
  181822. static void sqlite3Fts5ParseNearsetFree(Fts5ExprNearset *pNear){
  181823. if( pNear ){
  181824. int i;
  181825. for(i=0; i<pNear->nPhrase; i++){
  181826. fts5ExprPhraseFree(pNear->apPhrase[i]);
  181827. }
  181828. sqlite3_free(pNear->pColset);
  181829. sqlite3_free(pNear);
  181830. }
  181831. }
  181832. static void sqlite3Fts5ParseFinished(Fts5Parse *pParse, Fts5ExprNode *p){
  181833. assert( pParse->pExpr==0 );
  181834. pParse->pExpr = p;
  181835. }
  181836. /*
  181837. ** This function is called by the parser to process a string token. The
  181838. ** string may or may not be quoted. In any case it is tokenized and a
  181839. ** phrase object consisting of all tokens returned.
  181840. */
  181841. static Fts5ExprPhrase *sqlite3Fts5ParseTerm(
  181842. Fts5Parse *pParse, /* Parse context */
  181843. Fts5ExprPhrase *pAppend, /* Phrase to append to */
  181844. Fts5Token *pToken, /* String to tokenize */
  181845. int bPrefix /* True if there is a trailing "*" */
  181846. ){
  181847. Fts5Config *pConfig = pParse->pConfig;
  181848. TokenCtx sCtx; /* Context object passed to callback */
  181849. int rc; /* Tokenize return code */
  181850. char *z = 0;
  181851. memset(&sCtx, 0, sizeof(TokenCtx));
  181852. sCtx.pPhrase = pAppend;
  181853. rc = fts5ParseStringFromToken(pToken, &z);
  181854. if( rc==SQLITE_OK ){
  181855. int flags = FTS5_TOKENIZE_QUERY | (bPrefix ? FTS5_TOKENIZE_PREFIX : 0);
  181856. int n;
  181857. sqlite3Fts5Dequote(z);
  181858. n = (int)strlen(z);
  181859. rc = sqlite3Fts5Tokenize(pConfig, flags, z, n, &sCtx, fts5ParseTokenize);
  181860. }
  181861. sqlite3_free(z);
  181862. if( rc || (rc = sCtx.rc) ){
  181863. pParse->rc = rc;
  181864. fts5ExprPhraseFree(sCtx.pPhrase);
  181865. sCtx.pPhrase = 0;
  181866. }else{
  181867. if( pAppend==0 ){
  181868. if( (pParse->nPhrase % 8)==0 ){
  181869. int nByte = sizeof(Fts5ExprPhrase*) * (pParse->nPhrase + 8);
  181870. Fts5ExprPhrase **apNew;
  181871. apNew = (Fts5ExprPhrase**)sqlite3_realloc(pParse->apPhrase, nByte);
  181872. if( apNew==0 ){
  181873. pParse->rc = SQLITE_NOMEM;
  181874. fts5ExprPhraseFree(sCtx.pPhrase);
  181875. return 0;
  181876. }
  181877. pParse->apPhrase = apNew;
  181878. }
  181879. pParse->nPhrase++;
  181880. }
  181881. if( sCtx.pPhrase==0 ){
  181882. /* This happens when parsing a token or quoted phrase that contains
  181883. ** no token characters at all. (e.g ... MATCH '""'). */
  181884. sCtx.pPhrase = sqlite3Fts5MallocZero(&pParse->rc, sizeof(Fts5ExprPhrase));
  181885. }else if( sCtx.pPhrase->nTerm ){
  181886. sCtx.pPhrase->aTerm[sCtx.pPhrase->nTerm-1].bPrefix = (u8)bPrefix;
  181887. }
  181888. pParse->apPhrase[pParse->nPhrase-1] = sCtx.pPhrase;
  181889. }
  181890. return sCtx.pPhrase;
  181891. }
  181892. /*
  181893. ** Create a new FTS5 expression by cloning phrase iPhrase of the
  181894. ** expression passed as the second argument.
  181895. */
  181896. static int sqlite3Fts5ExprClonePhrase(
  181897. Fts5Expr *pExpr,
  181898. int iPhrase,
  181899. Fts5Expr **ppNew
  181900. ){
  181901. int rc = SQLITE_OK; /* Return code */
  181902. Fts5ExprPhrase *pOrig; /* The phrase extracted from pExpr */
  181903. Fts5Expr *pNew = 0; /* Expression to return via *ppNew */
  181904. TokenCtx sCtx = {0,0}; /* Context object for fts5ParseTokenize */
  181905. pOrig = pExpr->apExprPhrase[iPhrase];
  181906. pNew = (Fts5Expr*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Expr));
  181907. if( rc==SQLITE_OK ){
  181908. pNew->apExprPhrase = (Fts5ExprPhrase**)sqlite3Fts5MallocZero(&rc,
  181909. sizeof(Fts5ExprPhrase*));
  181910. }
  181911. if( rc==SQLITE_OK ){
  181912. pNew->pRoot = (Fts5ExprNode*)sqlite3Fts5MallocZero(&rc,
  181913. sizeof(Fts5ExprNode));
  181914. }
  181915. if( rc==SQLITE_OK ){
  181916. pNew->pRoot->pNear = (Fts5ExprNearset*)sqlite3Fts5MallocZero(&rc,
  181917. sizeof(Fts5ExprNearset) + sizeof(Fts5ExprPhrase*));
  181918. }
  181919. if( rc==SQLITE_OK ){
  181920. Fts5Colset *pColsetOrig = pOrig->pNode->pNear->pColset;
  181921. if( pColsetOrig ){
  181922. int nByte = sizeof(Fts5Colset) + (pColsetOrig->nCol-1) * sizeof(int);
  181923. Fts5Colset *pColset = (Fts5Colset*)sqlite3Fts5MallocZero(&rc, nByte);
  181924. if( pColset ){
  181925. memcpy(pColset, pColsetOrig, nByte);
  181926. }
  181927. pNew->pRoot->pNear->pColset = pColset;
  181928. }
  181929. }
  181930. if( pOrig->nTerm ){
  181931. int i; /* Used to iterate through phrase terms */
  181932. for(i=0; rc==SQLITE_OK && i<pOrig->nTerm; i++){
  181933. int tflags = 0;
  181934. Fts5ExprTerm *p;
  181935. for(p=&pOrig->aTerm[i]; p && rc==SQLITE_OK; p=p->pSynonym){
  181936. const char *zTerm = p->zTerm;
  181937. rc = fts5ParseTokenize((void*)&sCtx, tflags, zTerm, (int)strlen(zTerm),
  181938. 0, 0);
  181939. tflags = FTS5_TOKEN_COLOCATED;
  181940. }
  181941. if( rc==SQLITE_OK ){
  181942. sCtx.pPhrase->aTerm[i].bPrefix = pOrig->aTerm[i].bPrefix;
  181943. sCtx.pPhrase->aTerm[i].bFirst = pOrig->aTerm[i].bFirst;
  181944. }
  181945. }
  181946. }else{
  181947. /* This happens when parsing a token or quoted phrase that contains
  181948. ** no token characters at all. (e.g ... MATCH '""'). */
  181949. sCtx.pPhrase = sqlite3Fts5MallocZero(&rc, sizeof(Fts5ExprPhrase));
  181950. }
  181951. if( rc==SQLITE_OK ){
  181952. /* All the allocations succeeded. Put the expression object together. */
  181953. pNew->pIndex = pExpr->pIndex;
  181954. pNew->pConfig = pExpr->pConfig;
  181955. pNew->nPhrase = 1;
  181956. pNew->apExprPhrase[0] = sCtx.pPhrase;
  181957. pNew->pRoot->pNear->apPhrase[0] = sCtx.pPhrase;
  181958. pNew->pRoot->pNear->nPhrase = 1;
  181959. sCtx.pPhrase->pNode = pNew->pRoot;
  181960. if( pOrig->nTerm==1
  181961. && pOrig->aTerm[0].pSynonym==0
  181962. && pOrig->aTerm[0].bFirst==0
  181963. ){
  181964. pNew->pRoot->eType = FTS5_TERM;
  181965. pNew->pRoot->xNext = fts5ExprNodeNext_TERM;
  181966. }else{
  181967. pNew->pRoot->eType = FTS5_STRING;
  181968. pNew->pRoot->xNext = fts5ExprNodeNext_STRING;
  181969. }
  181970. }else{
  181971. sqlite3Fts5ExprFree(pNew);
  181972. fts5ExprPhraseFree(sCtx.pPhrase);
  181973. pNew = 0;
  181974. }
  181975. *ppNew = pNew;
  181976. return rc;
  181977. }
  181978. /*
  181979. ** Token pTok has appeared in a MATCH expression where the NEAR operator
  181980. ** is expected. If token pTok does not contain "NEAR", store an error
  181981. ** in the pParse object.
  181982. */
  181983. static void sqlite3Fts5ParseNear(Fts5Parse *pParse, Fts5Token *pTok){
  181984. if( pTok->n!=4 || memcmp("NEAR", pTok->p, 4) ){
  181985. sqlite3Fts5ParseError(
  181986. pParse, "fts5: syntax error near \"%.*s\"", pTok->n, pTok->p
  181987. );
  181988. }
  181989. }
  181990. static void sqlite3Fts5ParseSetDistance(
  181991. Fts5Parse *pParse,
  181992. Fts5ExprNearset *pNear,
  181993. Fts5Token *p
  181994. ){
  181995. if( pNear ){
  181996. int nNear = 0;
  181997. int i;
  181998. if( p->n ){
  181999. for(i=0; i<p->n; i++){
  182000. char c = (char)p->p[i];
  182001. if( c<'0' || c>'9' ){
  182002. sqlite3Fts5ParseError(
  182003. pParse, "expected integer, got \"%.*s\"", p->n, p->p
  182004. );
  182005. return;
  182006. }
  182007. nNear = nNear * 10 + (p->p[i] - '0');
  182008. }
  182009. }else{
  182010. nNear = FTS5_DEFAULT_NEARDIST;
  182011. }
  182012. pNear->nNear = nNear;
  182013. }
  182014. }
  182015. /*
  182016. ** The second argument passed to this function may be NULL, or it may be
  182017. ** an existing Fts5Colset object. This function returns a pointer to
  182018. ** a new colset object containing the contents of (p) with new value column
  182019. ** number iCol appended.
  182020. **
  182021. ** If an OOM error occurs, store an error code in pParse and return NULL.
  182022. ** The old colset object (if any) is not freed in this case.
  182023. */
  182024. static Fts5Colset *fts5ParseColset(
  182025. Fts5Parse *pParse, /* Store SQLITE_NOMEM here if required */
  182026. Fts5Colset *p, /* Existing colset object */
  182027. int iCol /* New column to add to colset object */
  182028. ){
  182029. int nCol = p ? p->nCol : 0; /* Num. columns already in colset object */
  182030. Fts5Colset *pNew; /* New colset object to return */
  182031. assert( pParse->rc==SQLITE_OK );
  182032. assert( iCol>=0 && iCol<pParse->pConfig->nCol );
  182033. pNew = sqlite3_realloc(p, sizeof(Fts5Colset) + sizeof(int)*nCol);
  182034. if( pNew==0 ){
  182035. pParse->rc = SQLITE_NOMEM;
  182036. }else{
  182037. int *aiCol = pNew->aiCol;
  182038. int i, j;
  182039. for(i=0; i<nCol; i++){
  182040. if( aiCol[i]==iCol ) return pNew;
  182041. if( aiCol[i]>iCol ) break;
  182042. }
  182043. for(j=nCol; j>i; j--){
  182044. aiCol[j] = aiCol[j-1];
  182045. }
  182046. aiCol[i] = iCol;
  182047. pNew->nCol = nCol+1;
  182048. #ifndef NDEBUG
  182049. /* Check that the array is in order and contains no duplicate entries. */
  182050. for(i=1; i<pNew->nCol; i++) assert( pNew->aiCol[i]>pNew->aiCol[i-1] );
  182051. #endif
  182052. }
  182053. return pNew;
  182054. }
  182055. /*
  182056. ** Allocate and return an Fts5Colset object specifying the inverse of
  182057. ** the colset passed as the second argument. Free the colset passed
  182058. ** as the second argument before returning.
  182059. */
  182060. static Fts5Colset *sqlite3Fts5ParseColsetInvert(Fts5Parse *pParse, Fts5Colset *p){
  182061. Fts5Colset *pRet;
  182062. int nCol = pParse->pConfig->nCol;
  182063. pRet = (Fts5Colset*)sqlite3Fts5MallocZero(&pParse->rc,
  182064. sizeof(Fts5Colset) + sizeof(int)*nCol
  182065. );
  182066. if( pRet ){
  182067. int i;
  182068. int iOld = 0;
  182069. for(i=0; i<nCol; i++){
  182070. if( iOld>=p->nCol || p->aiCol[iOld]!=i ){
  182071. pRet->aiCol[pRet->nCol++] = i;
  182072. }else{
  182073. iOld++;
  182074. }
  182075. }
  182076. }
  182077. sqlite3_free(p);
  182078. return pRet;
  182079. }
  182080. static Fts5Colset *sqlite3Fts5ParseColset(
  182081. Fts5Parse *pParse, /* Store SQLITE_NOMEM here if required */
  182082. Fts5Colset *pColset, /* Existing colset object */
  182083. Fts5Token *p
  182084. ){
  182085. Fts5Colset *pRet = 0;
  182086. int iCol;
  182087. char *z; /* Dequoted copy of token p */
  182088. z = sqlite3Fts5Strndup(&pParse->rc, p->p, p->n);
  182089. if( pParse->rc==SQLITE_OK ){
  182090. Fts5Config *pConfig = pParse->pConfig;
  182091. sqlite3Fts5Dequote(z);
  182092. for(iCol=0; iCol<pConfig->nCol; iCol++){
  182093. if( 0==sqlite3_stricmp(pConfig->azCol[iCol], z) ) break;
  182094. }
  182095. if( iCol==pConfig->nCol ){
  182096. sqlite3Fts5ParseError(pParse, "no such column: %s", z);
  182097. }else{
  182098. pRet = fts5ParseColset(pParse, pColset, iCol);
  182099. }
  182100. sqlite3_free(z);
  182101. }
  182102. if( pRet==0 ){
  182103. assert( pParse->rc!=SQLITE_OK );
  182104. sqlite3_free(pColset);
  182105. }
  182106. return pRet;
  182107. }
  182108. /*
  182109. ** If argument pOrig is NULL, or if (*pRc) is set to anything other than
  182110. ** SQLITE_OK when this function is called, NULL is returned.
  182111. **
  182112. ** Otherwise, a copy of (*pOrig) is made into memory obtained from
  182113. ** sqlite3Fts5MallocZero() and a pointer to it returned. If the allocation
  182114. ** fails, (*pRc) is set to SQLITE_NOMEM and NULL is returned.
  182115. */
  182116. static Fts5Colset *fts5CloneColset(int *pRc, Fts5Colset *pOrig){
  182117. Fts5Colset *pRet;
  182118. if( pOrig ){
  182119. int nByte = sizeof(Fts5Colset) + (pOrig->nCol-1) * sizeof(int);
  182120. pRet = (Fts5Colset*)sqlite3Fts5MallocZero(pRc, nByte);
  182121. if( pRet ){
  182122. memcpy(pRet, pOrig, nByte);
  182123. }
  182124. }else{
  182125. pRet = 0;
  182126. }
  182127. return pRet;
  182128. }
  182129. /*
  182130. ** Remove from colset pColset any columns that are not also in colset pMerge.
  182131. */
  182132. static void fts5MergeColset(Fts5Colset *pColset, Fts5Colset *pMerge){
  182133. int iIn = 0; /* Next input in pColset */
  182134. int iMerge = 0; /* Next input in pMerge */
  182135. int iOut = 0; /* Next output slot in pColset */
  182136. while( iIn<pColset->nCol && iMerge<pMerge->nCol ){
  182137. int iDiff = pColset->aiCol[iIn] - pMerge->aiCol[iMerge];
  182138. if( iDiff==0 ){
  182139. pColset->aiCol[iOut++] = pMerge->aiCol[iMerge];
  182140. iMerge++;
  182141. iIn++;
  182142. }else if( iDiff>0 ){
  182143. iMerge++;
  182144. }else{
  182145. iIn++;
  182146. }
  182147. }
  182148. pColset->nCol = iOut;
  182149. }
  182150. /*
  182151. ** Recursively apply colset pColset to expression node pNode and all of
  182152. ** its decendents. If (*ppFree) is not NULL, it contains a spare copy
  182153. ** of pColset. This function may use the spare copy and set (*ppFree) to
  182154. ** zero, or it may create copies of pColset using fts5CloneColset().
  182155. */
  182156. static void fts5ParseSetColset(
  182157. Fts5Parse *pParse,
  182158. Fts5ExprNode *pNode,
  182159. Fts5Colset *pColset,
  182160. Fts5Colset **ppFree
  182161. ){
  182162. if( pParse->rc==SQLITE_OK ){
  182163. assert( pNode->eType==FTS5_TERM || pNode->eType==FTS5_STRING
  182164. || pNode->eType==FTS5_AND || pNode->eType==FTS5_OR
  182165. || pNode->eType==FTS5_NOT || pNode->eType==FTS5_EOF
  182166. );
  182167. if( pNode->eType==FTS5_STRING || pNode->eType==FTS5_TERM ){
  182168. Fts5ExprNearset *pNear = pNode->pNear;
  182169. if( pNear->pColset ){
  182170. fts5MergeColset(pNear->pColset, pColset);
  182171. if( pNear->pColset->nCol==0 ){
  182172. pNode->eType = FTS5_EOF;
  182173. pNode->xNext = 0;
  182174. }
  182175. }else if( *ppFree ){
  182176. pNear->pColset = pColset;
  182177. *ppFree = 0;
  182178. }else{
  182179. pNear->pColset = fts5CloneColset(&pParse->rc, pColset);
  182180. }
  182181. }else{
  182182. int i;
  182183. assert( pNode->eType!=FTS5_EOF || pNode->nChild==0 );
  182184. for(i=0; i<pNode->nChild; i++){
  182185. fts5ParseSetColset(pParse, pNode->apChild[i], pColset, ppFree);
  182186. }
  182187. }
  182188. }
  182189. }
  182190. /*
  182191. ** Apply colset pColset to expression node pExpr and all of its descendents.
  182192. */
  182193. static void sqlite3Fts5ParseSetColset(
  182194. Fts5Parse *pParse,
  182195. Fts5ExprNode *pExpr,
  182196. Fts5Colset *pColset
  182197. ){
  182198. Fts5Colset *pFree = pColset;
  182199. if( pParse->pConfig->eDetail==FTS5_DETAIL_NONE ){
  182200. pParse->rc = SQLITE_ERROR;
  182201. pParse->zErr = sqlite3_mprintf(
  182202. "fts5: column queries are not supported (detail=none)"
  182203. );
  182204. }else{
  182205. fts5ParseSetColset(pParse, pExpr, pColset, &pFree);
  182206. }
  182207. sqlite3_free(pFree);
  182208. }
  182209. static void fts5ExprAssignXNext(Fts5ExprNode *pNode){
  182210. switch( pNode->eType ){
  182211. case FTS5_STRING: {
  182212. Fts5ExprNearset *pNear = pNode->pNear;
  182213. if( pNear->nPhrase==1 && pNear->apPhrase[0]->nTerm==1
  182214. && pNear->apPhrase[0]->aTerm[0].pSynonym==0
  182215. && pNear->apPhrase[0]->aTerm[0].bFirst==0
  182216. ){
  182217. pNode->eType = FTS5_TERM;
  182218. pNode->xNext = fts5ExprNodeNext_TERM;
  182219. }else{
  182220. pNode->xNext = fts5ExprNodeNext_STRING;
  182221. }
  182222. break;
  182223. };
  182224. case FTS5_OR: {
  182225. pNode->xNext = fts5ExprNodeNext_OR;
  182226. break;
  182227. };
  182228. case FTS5_AND: {
  182229. pNode->xNext = fts5ExprNodeNext_AND;
  182230. break;
  182231. };
  182232. default: assert( pNode->eType==FTS5_NOT ); {
  182233. pNode->xNext = fts5ExprNodeNext_NOT;
  182234. break;
  182235. };
  182236. }
  182237. }
  182238. static void fts5ExprAddChildren(Fts5ExprNode *p, Fts5ExprNode *pSub){
  182239. if( p->eType!=FTS5_NOT && pSub->eType==p->eType ){
  182240. int nByte = sizeof(Fts5ExprNode*) * pSub->nChild;
  182241. memcpy(&p->apChild[p->nChild], pSub->apChild, nByte);
  182242. p->nChild += pSub->nChild;
  182243. sqlite3_free(pSub);
  182244. }else{
  182245. p->apChild[p->nChild++] = pSub;
  182246. }
  182247. }
  182248. /*
  182249. ** Allocate and return a new expression object. If anything goes wrong (i.e.
  182250. ** OOM error), leave an error code in pParse and return NULL.
  182251. */
  182252. static Fts5ExprNode *sqlite3Fts5ParseNode(
  182253. Fts5Parse *pParse, /* Parse context */
  182254. int eType, /* FTS5_STRING, AND, OR or NOT */
  182255. Fts5ExprNode *pLeft, /* Left hand child expression */
  182256. Fts5ExprNode *pRight, /* Right hand child expression */
  182257. Fts5ExprNearset *pNear /* For STRING expressions, the near cluster */
  182258. ){
  182259. Fts5ExprNode *pRet = 0;
  182260. if( pParse->rc==SQLITE_OK ){
  182261. int nChild = 0; /* Number of children of returned node */
  182262. int nByte; /* Bytes of space to allocate for this node */
  182263. assert( (eType!=FTS5_STRING && !pNear)
  182264. || (eType==FTS5_STRING && !pLeft && !pRight)
  182265. );
  182266. if( eType==FTS5_STRING && pNear==0 ) return 0;
  182267. if( eType!=FTS5_STRING && pLeft==0 ) return pRight;
  182268. if( eType!=FTS5_STRING && pRight==0 ) return pLeft;
  182269. if( eType==FTS5_NOT ){
  182270. nChild = 2;
  182271. }else if( eType==FTS5_AND || eType==FTS5_OR ){
  182272. nChild = 2;
  182273. if( pLeft->eType==eType ) nChild += pLeft->nChild-1;
  182274. if( pRight->eType==eType ) nChild += pRight->nChild-1;
  182275. }
  182276. nByte = sizeof(Fts5ExprNode) + sizeof(Fts5ExprNode*)*(nChild-1);
  182277. pRet = (Fts5ExprNode*)sqlite3Fts5MallocZero(&pParse->rc, nByte);
  182278. if( pRet ){
  182279. pRet->eType = eType;
  182280. pRet->pNear = pNear;
  182281. fts5ExprAssignXNext(pRet);
  182282. if( eType==FTS5_STRING ){
  182283. int iPhrase;
  182284. for(iPhrase=0; iPhrase<pNear->nPhrase; iPhrase++){
  182285. pNear->apPhrase[iPhrase]->pNode = pRet;
  182286. if( pNear->apPhrase[iPhrase]->nTerm==0 ){
  182287. pRet->xNext = 0;
  182288. pRet->eType = FTS5_EOF;
  182289. }
  182290. }
  182291. if( pParse->pConfig->eDetail!=FTS5_DETAIL_FULL ){
  182292. Fts5ExprPhrase *pPhrase = pNear->apPhrase[0];
  182293. if( pNear->nPhrase!=1
  182294. || pPhrase->nTerm>1
  182295. || (pPhrase->nTerm>0 && pPhrase->aTerm[0].bFirst)
  182296. ){
  182297. assert( pParse->rc==SQLITE_OK );
  182298. pParse->rc = SQLITE_ERROR;
  182299. assert( pParse->zErr==0 );
  182300. pParse->zErr = sqlite3_mprintf(
  182301. "fts5: %s queries are not supported (detail!=full)",
  182302. pNear->nPhrase==1 ? "phrase": "NEAR"
  182303. );
  182304. sqlite3_free(pRet);
  182305. pRet = 0;
  182306. }
  182307. }
  182308. }else{
  182309. fts5ExprAddChildren(pRet, pLeft);
  182310. fts5ExprAddChildren(pRet, pRight);
  182311. }
  182312. }
  182313. }
  182314. if( pRet==0 ){
  182315. assert( pParse->rc!=SQLITE_OK );
  182316. sqlite3Fts5ParseNodeFree(pLeft);
  182317. sqlite3Fts5ParseNodeFree(pRight);
  182318. sqlite3Fts5ParseNearsetFree(pNear);
  182319. }
  182320. return pRet;
  182321. }
  182322. static Fts5ExprNode *sqlite3Fts5ParseImplicitAnd(
  182323. Fts5Parse *pParse, /* Parse context */
  182324. Fts5ExprNode *pLeft, /* Left hand child expression */
  182325. Fts5ExprNode *pRight /* Right hand child expression */
  182326. ){
  182327. Fts5ExprNode *pRet = 0;
  182328. Fts5ExprNode *pPrev;
  182329. if( pParse->rc ){
  182330. sqlite3Fts5ParseNodeFree(pLeft);
  182331. sqlite3Fts5ParseNodeFree(pRight);
  182332. }else{
  182333. assert( pLeft->eType==FTS5_STRING
  182334. || pLeft->eType==FTS5_TERM
  182335. || pLeft->eType==FTS5_EOF
  182336. || pLeft->eType==FTS5_AND
  182337. );
  182338. assert( pRight->eType==FTS5_STRING
  182339. || pRight->eType==FTS5_TERM
  182340. || pRight->eType==FTS5_EOF
  182341. );
  182342. if( pLeft->eType==FTS5_AND ){
  182343. pPrev = pLeft->apChild[pLeft->nChild-1];
  182344. }else{
  182345. pPrev = pLeft;
  182346. }
  182347. assert( pPrev->eType==FTS5_STRING
  182348. || pPrev->eType==FTS5_TERM
  182349. || pPrev->eType==FTS5_EOF
  182350. );
  182351. if( pRight->eType==FTS5_EOF ){
  182352. assert( pParse->apPhrase[pParse->nPhrase-1]==pRight->pNear->apPhrase[0] );
  182353. sqlite3Fts5ParseNodeFree(pRight);
  182354. pRet = pLeft;
  182355. pParse->nPhrase--;
  182356. }
  182357. else if( pPrev->eType==FTS5_EOF ){
  182358. Fts5ExprPhrase **ap;
  182359. if( pPrev==pLeft ){
  182360. pRet = pRight;
  182361. }else{
  182362. pLeft->apChild[pLeft->nChild-1] = pRight;
  182363. pRet = pLeft;
  182364. }
  182365. ap = &pParse->apPhrase[pParse->nPhrase-1-pRight->pNear->nPhrase];
  182366. assert( ap[0]==pPrev->pNear->apPhrase[0] );
  182367. memmove(ap, &ap[1], sizeof(Fts5ExprPhrase*)*pRight->pNear->nPhrase);
  182368. pParse->nPhrase--;
  182369. sqlite3Fts5ParseNodeFree(pPrev);
  182370. }
  182371. else{
  182372. pRet = sqlite3Fts5ParseNode(pParse, FTS5_AND, pLeft, pRight, 0);
  182373. }
  182374. }
  182375. return pRet;
  182376. }
  182377. static char *fts5ExprTermPrint(Fts5ExprTerm *pTerm){
  182378. int nByte = 0;
  182379. Fts5ExprTerm *p;
  182380. char *zQuoted;
  182381. /* Determine the maximum amount of space required. */
  182382. for(p=pTerm; p; p=p->pSynonym){
  182383. nByte += (int)strlen(pTerm->zTerm) * 2 + 3 + 2;
  182384. }
  182385. zQuoted = sqlite3_malloc(nByte);
  182386. if( zQuoted ){
  182387. int i = 0;
  182388. for(p=pTerm; p; p=p->pSynonym){
  182389. char *zIn = p->zTerm;
  182390. zQuoted[i++] = '"';
  182391. while( *zIn ){
  182392. if( *zIn=='"' ) zQuoted[i++] = '"';
  182393. zQuoted[i++] = *zIn++;
  182394. }
  182395. zQuoted[i++] = '"';
  182396. if( p->pSynonym ) zQuoted[i++] = '|';
  182397. }
  182398. if( pTerm->bPrefix ){
  182399. zQuoted[i++] = ' ';
  182400. zQuoted[i++] = '*';
  182401. }
  182402. zQuoted[i++] = '\0';
  182403. }
  182404. return zQuoted;
  182405. }
  182406. static char *fts5PrintfAppend(char *zApp, const char *zFmt, ...){
  182407. char *zNew;
  182408. va_list ap;
  182409. va_start(ap, zFmt);
  182410. zNew = sqlite3_vmprintf(zFmt, ap);
  182411. va_end(ap);
  182412. if( zApp && zNew ){
  182413. char *zNew2 = sqlite3_mprintf("%s%s", zApp, zNew);
  182414. sqlite3_free(zNew);
  182415. zNew = zNew2;
  182416. }
  182417. sqlite3_free(zApp);
  182418. return zNew;
  182419. }
  182420. /*
  182421. ** Compose a tcl-readable representation of expression pExpr. Return a
  182422. ** pointer to a buffer containing that representation. It is the
  182423. ** responsibility of the caller to at some point free the buffer using
  182424. ** sqlite3_free().
  182425. */
  182426. static char *fts5ExprPrintTcl(
  182427. Fts5Config *pConfig,
  182428. const char *zNearsetCmd,
  182429. Fts5ExprNode *pExpr
  182430. ){
  182431. char *zRet = 0;
  182432. if( pExpr->eType==FTS5_STRING || pExpr->eType==FTS5_TERM ){
  182433. Fts5ExprNearset *pNear = pExpr->pNear;
  182434. int i;
  182435. int iTerm;
  182436. zRet = fts5PrintfAppend(zRet, "%s ", zNearsetCmd);
  182437. if( zRet==0 ) return 0;
  182438. if( pNear->pColset ){
  182439. int *aiCol = pNear->pColset->aiCol;
  182440. int nCol = pNear->pColset->nCol;
  182441. if( nCol==1 ){
  182442. zRet = fts5PrintfAppend(zRet, "-col %d ", aiCol[0]);
  182443. }else{
  182444. zRet = fts5PrintfAppend(zRet, "-col {%d", aiCol[0]);
  182445. for(i=1; i<pNear->pColset->nCol; i++){
  182446. zRet = fts5PrintfAppend(zRet, " %d", aiCol[i]);
  182447. }
  182448. zRet = fts5PrintfAppend(zRet, "} ");
  182449. }
  182450. if( zRet==0 ) return 0;
  182451. }
  182452. if( pNear->nPhrase>1 ){
  182453. zRet = fts5PrintfAppend(zRet, "-near %d ", pNear->nNear);
  182454. if( zRet==0 ) return 0;
  182455. }
  182456. zRet = fts5PrintfAppend(zRet, "--");
  182457. if( zRet==0 ) return 0;
  182458. for(i=0; i<pNear->nPhrase; i++){
  182459. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  182460. zRet = fts5PrintfAppend(zRet, " {");
  182461. for(iTerm=0; zRet && iTerm<pPhrase->nTerm; iTerm++){
  182462. char *zTerm = pPhrase->aTerm[iTerm].zTerm;
  182463. zRet = fts5PrintfAppend(zRet, "%s%s", iTerm==0?"":" ", zTerm);
  182464. if( pPhrase->aTerm[iTerm].bPrefix ){
  182465. zRet = fts5PrintfAppend(zRet, "*");
  182466. }
  182467. }
  182468. if( zRet ) zRet = fts5PrintfAppend(zRet, "}");
  182469. if( zRet==0 ) return 0;
  182470. }
  182471. }else{
  182472. char const *zOp = 0;
  182473. int i;
  182474. switch( pExpr->eType ){
  182475. case FTS5_AND: zOp = "AND"; break;
  182476. case FTS5_NOT: zOp = "NOT"; break;
  182477. default:
  182478. assert( pExpr->eType==FTS5_OR );
  182479. zOp = "OR";
  182480. break;
  182481. }
  182482. zRet = sqlite3_mprintf("%s", zOp);
  182483. for(i=0; zRet && i<pExpr->nChild; i++){
  182484. char *z = fts5ExprPrintTcl(pConfig, zNearsetCmd, pExpr->apChild[i]);
  182485. if( !z ){
  182486. sqlite3_free(zRet);
  182487. zRet = 0;
  182488. }else{
  182489. zRet = fts5PrintfAppend(zRet, " [%z]", z);
  182490. }
  182491. }
  182492. }
  182493. return zRet;
  182494. }
  182495. static char *fts5ExprPrint(Fts5Config *pConfig, Fts5ExprNode *pExpr){
  182496. char *zRet = 0;
  182497. if( pExpr->eType==0 ){
  182498. return sqlite3_mprintf("\"\"");
  182499. }else
  182500. if( pExpr->eType==FTS5_STRING || pExpr->eType==FTS5_TERM ){
  182501. Fts5ExprNearset *pNear = pExpr->pNear;
  182502. int i;
  182503. int iTerm;
  182504. if( pNear->pColset ){
  182505. int iCol = pNear->pColset->aiCol[0];
  182506. zRet = fts5PrintfAppend(zRet, "%s : ", pConfig->azCol[iCol]);
  182507. if( zRet==0 ) return 0;
  182508. }
  182509. if( pNear->nPhrase>1 ){
  182510. zRet = fts5PrintfAppend(zRet, "NEAR(");
  182511. if( zRet==0 ) return 0;
  182512. }
  182513. for(i=0; i<pNear->nPhrase; i++){
  182514. Fts5ExprPhrase *pPhrase = pNear->apPhrase[i];
  182515. if( i!=0 ){
  182516. zRet = fts5PrintfAppend(zRet, " ");
  182517. if( zRet==0 ) return 0;
  182518. }
  182519. for(iTerm=0; iTerm<pPhrase->nTerm; iTerm++){
  182520. char *zTerm = fts5ExprTermPrint(&pPhrase->aTerm[iTerm]);
  182521. if( zTerm ){
  182522. zRet = fts5PrintfAppend(zRet, "%s%s", iTerm==0?"":" + ", zTerm);
  182523. sqlite3_free(zTerm);
  182524. }
  182525. if( zTerm==0 || zRet==0 ){
  182526. sqlite3_free(zRet);
  182527. return 0;
  182528. }
  182529. }
  182530. }
  182531. if( pNear->nPhrase>1 ){
  182532. zRet = fts5PrintfAppend(zRet, ", %d)", pNear->nNear);
  182533. if( zRet==0 ) return 0;
  182534. }
  182535. }else{
  182536. char const *zOp = 0;
  182537. int i;
  182538. switch( pExpr->eType ){
  182539. case FTS5_AND: zOp = " AND "; break;
  182540. case FTS5_NOT: zOp = " NOT "; break;
  182541. default:
  182542. assert( pExpr->eType==FTS5_OR );
  182543. zOp = " OR ";
  182544. break;
  182545. }
  182546. for(i=0; i<pExpr->nChild; i++){
  182547. char *z = fts5ExprPrint(pConfig, pExpr->apChild[i]);
  182548. if( z==0 ){
  182549. sqlite3_free(zRet);
  182550. zRet = 0;
  182551. }else{
  182552. int e = pExpr->apChild[i]->eType;
  182553. int b = (e!=FTS5_STRING && e!=FTS5_TERM && e!=FTS5_EOF);
  182554. zRet = fts5PrintfAppend(zRet, "%s%s%z%s",
  182555. (i==0 ? "" : zOp),
  182556. (b?"(":""), z, (b?")":"")
  182557. );
  182558. }
  182559. if( zRet==0 ) break;
  182560. }
  182561. }
  182562. return zRet;
  182563. }
  182564. /*
  182565. ** The implementation of user-defined scalar functions fts5_expr() (bTcl==0)
  182566. ** and fts5_expr_tcl() (bTcl!=0).
  182567. */
  182568. static void fts5ExprFunction(
  182569. sqlite3_context *pCtx, /* Function call context */
  182570. int nArg, /* Number of args */
  182571. sqlite3_value **apVal, /* Function arguments */
  182572. int bTcl
  182573. ){
  182574. Fts5Global *pGlobal = (Fts5Global*)sqlite3_user_data(pCtx);
  182575. sqlite3 *db = sqlite3_context_db_handle(pCtx);
  182576. const char *zExpr = 0;
  182577. char *zErr = 0;
  182578. Fts5Expr *pExpr = 0;
  182579. int rc;
  182580. int i;
  182581. const char **azConfig; /* Array of arguments for Fts5Config */
  182582. const char *zNearsetCmd = "nearset";
  182583. int nConfig; /* Size of azConfig[] */
  182584. Fts5Config *pConfig = 0;
  182585. int iArg = 1;
  182586. if( nArg<1 ){
  182587. zErr = sqlite3_mprintf("wrong number of arguments to function %s",
  182588. bTcl ? "fts5_expr_tcl" : "fts5_expr"
  182589. );
  182590. sqlite3_result_error(pCtx, zErr, -1);
  182591. sqlite3_free(zErr);
  182592. return;
  182593. }
  182594. if( bTcl && nArg>1 ){
  182595. zNearsetCmd = (const char*)sqlite3_value_text(apVal[1]);
  182596. iArg = 2;
  182597. }
  182598. nConfig = 3 + (nArg-iArg);
  182599. azConfig = (const char**)sqlite3_malloc(sizeof(char*) * nConfig);
  182600. if( azConfig==0 ){
  182601. sqlite3_result_error_nomem(pCtx);
  182602. return;
  182603. }
  182604. azConfig[0] = 0;
  182605. azConfig[1] = "main";
  182606. azConfig[2] = "tbl";
  182607. for(i=3; iArg<nArg; iArg++){
  182608. azConfig[i++] = (const char*)sqlite3_value_text(apVal[iArg]);
  182609. }
  182610. zExpr = (const char*)sqlite3_value_text(apVal[0]);
  182611. rc = sqlite3Fts5ConfigParse(pGlobal, db, nConfig, azConfig, &pConfig, &zErr);
  182612. if( rc==SQLITE_OK ){
  182613. rc = sqlite3Fts5ExprNew(pConfig, pConfig->nCol, zExpr, &pExpr, &zErr);
  182614. }
  182615. if( rc==SQLITE_OK ){
  182616. char *zText;
  182617. if( pExpr->pRoot->xNext==0 ){
  182618. zText = sqlite3_mprintf("");
  182619. }else if( bTcl ){
  182620. zText = fts5ExprPrintTcl(pConfig, zNearsetCmd, pExpr->pRoot);
  182621. }else{
  182622. zText = fts5ExprPrint(pConfig, pExpr->pRoot);
  182623. }
  182624. if( zText==0 ){
  182625. rc = SQLITE_NOMEM;
  182626. }else{
  182627. sqlite3_result_text(pCtx, zText, -1, SQLITE_TRANSIENT);
  182628. sqlite3_free(zText);
  182629. }
  182630. }
  182631. if( rc!=SQLITE_OK ){
  182632. if( zErr ){
  182633. sqlite3_result_error(pCtx, zErr, -1);
  182634. sqlite3_free(zErr);
  182635. }else{
  182636. sqlite3_result_error_code(pCtx, rc);
  182637. }
  182638. }
  182639. sqlite3_free((void *)azConfig);
  182640. sqlite3Fts5ConfigFree(pConfig);
  182641. sqlite3Fts5ExprFree(pExpr);
  182642. }
  182643. static void fts5ExprFunctionHr(
  182644. sqlite3_context *pCtx, /* Function call context */
  182645. int nArg, /* Number of args */
  182646. sqlite3_value **apVal /* Function arguments */
  182647. ){
  182648. fts5ExprFunction(pCtx, nArg, apVal, 0);
  182649. }
  182650. static void fts5ExprFunctionTcl(
  182651. sqlite3_context *pCtx, /* Function call context */
  182652. int nArg, /* Number of args */
  182653. sqlite3_value **apVal /* Function arguments */
  182654. ){
  182655. fts5ExprFunction(pCtx, nArg, apVal, 1);
  182656. }
  182657. /*
  182658. ** The implementation of an SQLite user-defined-function that accepts a
  182659. ** single integer as an argument. If the integer is an alpha-numeric
  182660. ** unicode code point, 1 is returned. Otherwise 0.
  182661. */
  182662. static void fts5ExprIsAlnum(
  182663. sqlite3_context *pCtx, /* Function call context */
  182664. int nArg, /* Number of args */
  182665. sqlite3_value **apVal /* Function arguments */
  182666. ){
  182667. int iCode;
  182668. if( nArg!=1 ){
  182669. sqlite3_result_error(pCtx,
  182670. "wrong number of arguments to function fts5_isalnum", -1
  182671. );
  182672. return;
  182673. }
  182674. iCode = sqlite3_value_int(apVal[0]);
  182675. sqlite3_result_int(pCtx, sqlite3Fts5UnicodeIsalnum(iCode));
  182676. }
  182677. static void fts5ExprFold(
  182678. sqlite3_context *pCtx, /* Function call context */
  182679. int nArg, /* Number of args */
  182680. sqlite3_value **apVal /* Function arguments */
  182681. ){
  182682. if( nArg!=1 && nArg!=2 ){
  182683. sqlite3_result_error(pCtx,
  182684. "wrong number of arguments to function fts5_fold", -1
  182685. );
  182686. }else{
  182687. int iCode;
  182688. int bRemoveDiacritics = 0;
  182689. iCode = sqlite3_value_int(apVal[0]);
  182690. if( nArg==2 ) bRemoveDiacritics = sqlite3_value_int(apVal[1]);
  182691. sqlite3_result_int(pCtx, sqlite3Fts5UnicodeFold(iCode, bRemoveDiacritics));
  182692. }
  182693. }
  182694. /*
  182695. ** This is called during initialization to register the fts5_expr() scalar
  182696. ** UDF with the SQLite handle passed as the only argument.
  182697. */
  182698. static int sqlite3Fts5ExprInit(Fts5Global *pGlobal, sqlite3 *db){
  182699. struct Fts5ExprFunc {
  182700. const char *z;
  182701. void (*x)(sqlite3_context*,int,sqlite3_value**);
  182702. } aFunc[] = {
  182703. { "fts5_expr", fts5ExprFunctionHr },
  182704. { "fts5_expr_tcl", fts5ExprFunctionTcl },
  182705. { "fts5_isalnum", fts5ExprIsAlnum },
  182706. { "fts5_fold", fts5ExprFold },
  182707. };
  182708. int i;
  182709. int rc = SQLITE_OK;
  182710. void *pCtx = (void*)pGlobal;
  182711. for(i=0; rc==SQLITE_OK && i<ArraySize(aFunc); i++){
  182712. struct Fts5ExprFunc *p = &aFunc[i];
  182713. rc = sqlite3_create_function(db, p->z, -1, SQLITE_UTF8, pCtx, p->x, 0, 0);
  182714. }
  182715. /* Avoid a warning indicating that sqlite3Fts5ParserTrace() is unused */
  182716. #ifndef NDEBUG
  182717. (void)sqlite3Fts5ParserTrace;
  182718. #endif
  182719. return rc;
  182720. }
  182721. /*
  182722. ** Return the number of phrases in expression pExpr.
  182723. */
  182724. static int sqlite3Fts5ExprPhraseCount(Fts5Expr *pExpr){
  182725. return (pExpr ? pExpr->nPhrase : 0);
  182726. }
  182727. /*
  182728. ** Return the number of terms in the iPhrase'th phrase in pExpr.
  182729. */
  182730. static int sqlite3Fts5ExprPhraseSize(Fts5Expr *pExpr, int iPhrase){
  182731. if( iPhrase<0 || iPhrase>=pExpr->nPhrase ) return 0;
  182732. return pExpr->apExprPhrase[iPhrase]->nTerm;
  182733. }
  182734. /*
  182735. ** This function is used to access the current position list for phrase
  182736. ** iPhrase.
  182737. */
  182738. static int sqlite3Fts5ExprPoslist(Fts5Expr *pExpr, int iPhrase, const u8 **pa){
  182739. int nRet;
  182740. Fts5ExprPhrase *pPhrase = pExpr->apExprPhrase[iPhrase];
  182741. Fts5ExprNode *pNode = pPhrase->pNode;
  182742. if( pNode->bEof==0 && pNode->iRowid==pExpr->pRoot->iRowid ){
  182743. *pa = pPhrase->poslist.p;
  182744. nRet = pPhrase->poslist.n;
  182745. }else{
  182746. *pa = 0;
  182747. nRet = 0;
  182748. }
  182749. return nRet;
  182750. }
  182751. struct Fts5PoslistPopulator {
  182752. Fts5PoslistWriter writer;
  182753. int bOk; /* True if ok to populate */
  182754. int bMiss;
  182755. };
  182756. static Fts5PoslistPopulator *sqlite3Fts5ExprClearPoslists(Fts5Expr *pExpr, int bLive){
  182757. Fts5PoslistPopulator *pRet;
  182758. pRet = sqlite3_malloc(sizeof(Fts5PoslistPopulator)*pExpr->nPhrase);
  182759. if( pRet ){
  182760. int i;
  182761. memset(pRet, 0, sizeof(Fts5PoslistPopulator)*pExpr->nPhrase);
  182762. for(i=0; i<pExpr->nPhrase; i++){
  182763. Fts5Buffer *pBuf = &pExpr->apExprPhrase[i]->poslist;
  182764. Fts5ExprNode *pNode = pExpr->apExprPhrase[i]->pNode;
  182765. assert( pExpr->apExprPhrase[i]->nTerm==1 );
  182766. if( bLive &&
  182767. (pBuf->n==0 || pNode->iRowid!=pExpr->pRoot->iRowid || pNode->bEof)
  182768. ){
  182769. pRet[i].bMiss = 1;
  182770. }else{
  182771. pBuf->n = 0;
  182772. }
  182773. }
  182774. }
  182775. return pRet;
  182776. }
  182777. struct Fts5ExprCtx {
  182778. Fts5Expr *pExpr;
  182779. Fts5PoslistPopulator *aPopulator;
  182780. i64 iOff;
  182781. };
  182782. typedef struct Fts5ExprCtx Fts5ExprCtx;
  182783. /*
  182784. ** TODO: Make this more efficient!
  182785. */
  182786. static int fts5ExprColsetTest(Fts5Colset *pColset, int iCol){
  182787. int i;
  182788. for(i=0; i<pColset->nCol; i++){
  182789. if( pColset->aiCol[i]==iCol ) return 1;
  182790. }
  182791. return 0;
  182792. }
  182793. static int fts5ExprPopulatePoslistsCb(
  182794. void *pCtx, /* Copy of 2nd argument to xTokenize() */
  182795. int tflags, /* Mask of FTS5_TOKEN_* flags */
  182796. const char *pToken, /* Pointer to buffer containing token */
  182797. int nToken, /* Size of token in bytes */
  182798. int iUnused1, /* Byte offset of token within input text */
  182799. int iUnused2 /* Byte offset of end of token within input text */
  182800. ){
  182801. Fts5ExprCtx *p = (Fts5ExprCtx*)pCtx;
  182802. Fts5Expr *pExpr = p->pExpr;
  182803. int i;
  182804. UNUSED_PARAM2(iUnused1, iUnused2);
  182805. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  182806. if( (tflags & FTS5_TOKEN_COLOCATED)==0 ) p->iOff++;
  182807. for(i=0; i<pExpr->nPhrase; i++){
  182808. Fts5ExprTerm *pTerm;
  182809. if( p->aPopulator[i].bOk==0 ) continue;
  182810. for(pTerm=&pExpr->apExprPhrase[i]->aTerm[0]; pTerm; pTerm=pTerm->pSynonym){
  182811. int nTerm = (int)strlen(pTerm->zTerm);
  182812. if( (nTerm==nToken || (nTerm<nToken && pTerm->bPrefix))
  182813. && memcmp(pTerm->zTerm, pToken, nTerm)==0
  182814. ){
  182815. int rc = sqlite3Fts5PoslistWriterAppend(
  182816. &pExpr->apExprPhrase[i]->poslist, &p->aPopulator[i].writer, p->iOff
  182817. );
  182818. if( rc ) return rc;
  182819. break;
  182820. }
  182821. }
  182822. }
  182823. return SQLITE_OK;
  182824. }
  182825. static int sqlite3Fts5ExprPopulatePoslists(
  182826. Fts5Config *pConfig,
  182827. Fts5Expr *pExpr,
  182828. Fts5PoslistPopulator *aPopulator,
  182829. int iCol,
  182830. const char *z, int n
  182831. ){
  182832. int i;
  182833. Fts5ExprCtx sCtx;
  182834. sCtx.pExpr = pExpr;
  182835. sCtx.aPopulator = aPopulator;
  182836. sCtx.iOff = (((i64)iCol) << 32) - 1;
  182837. for(i=0; i<pExpr->nPhrase; i++){
  182838. Fts5ExprNode *pNode = pExpr->apExprPhrase[i]->pNode;
  182839. Fts5Colset *pColset = pNode->pNear->pColset;
  182840. if( (pColset && 0==fts5ExprColsetTest(pColset, iCol))
  182841. || aPopulator[i].bMiss
  182842. ){
  182843. aPopulator[i].bOk = 0;
  182844. }else{
  182845. aPopulator[i].bOk = 1;
  182846. }
  182847. }
  182848. return sqlite3Fts5Tokenize(pConfig,
  182849. FTS5_TOKENIZE_DOCUMENT, z, n, (void*)&sCtx, fts5ExprPopulatePoslistsCb
  182850. );
  182851. }
  182852. static void fts5ExprClearPoslists(Fts5ExprNode *pNode){
  182853. if( pNode->eType==FTS5_TERM || pNode->eType==FTS5_STRING ){
  182854. pNode->pNear->apPhrase[0]->poslist.n = 0;
  182855. }else{
  182856. int i;
  182857. for(i=0; i<pNode->nChild; i++){
  182858. fts5ExprClearPoslists(pNode->apChild[i]);
  182859. }
  182860. }
  182861. }
  182862. static int fts5ExprCheckPoslists(Fts5ExprNode *pNode, i64 iRowid){
  182863. pNode->iRowid = iRowid;
  182864. pNode->bEof = 0;
  182865. switch( pNode->eType ){
  182866. case FTS5_TERM:
  182867. case FTS5_STRING:
  182868. return (pNode->pNear->apPhrase[0]->poslist.n>0);
  182869. case FTS5_AND: {
  182870. int i;
  182871. for(i=0; i<pNode->nChild; i++){
  182872. if( fts5ExprCheckPoslists(pNode->apChild[i], iRowid)==0 ){
  182873. fts5ExprClearPoslists(pNode);
  182874. return 0;
  182875. }
  182876. }
  182877. break;
  182878. }
  182879. case FTS5_OR: {
  182880. int i;
  182881. int bRet = 0;
  182882. for(i=0; i<pNode->nChild; i++){
  182883. if( fts5ExprCheckPoslists(pNode->apChild[i], iRowid) ){
  182884. bRet = 1;
  182885. }
  182886. }
  182887. return bRet;
  182888. }
  182889. default: {
  182890. assert( pNode->eType==FTS5_NOT );
  182891. if( 0==fts5ExprCheckPoslists(pNode->apChild[0], iRowid)
  182892. || 0!=fts5ExprCheckPoslists(pNode->apChild[1], iRowid)
  182893. ){
  182894. fts5ExprClearPoslists(pNode);
  182895. return 0;
  182896. }
  182897. break;
  182898. }
  182899. }
  182900. return 1;
  182901. }
  182902. static void sqlite3Fts5ExprCheckPoslists(Fts5Expr *pExpr, i64 iRowid){
  182903. fts5ExprCheckPoslists(pExpr->pRoot, iRowid);
  182904. }
  182905. /*
  182906. ** This function is only called for detail=columns tables.
  182907. */
  182908. static int sqlite3Fts5ExprPhraseCollist(
  182909. Fts5Expr *pExpr,
  182910. int iPhrase,
  182911. const u8 **ppCollist,
  182912. int *pnCollist
  182913. ){
  182914. Fts5ExprPhrase *pPhrase = pExpr->apExprPhrase[iPhrase];
  182915. Fts5ExprNode *pNode = pPhrase->pNode;
  182916. int rc = SQLITE_OK;
  182917. assert( iPhrase>=0 && iPhrase<pExpr->nPhrase );
  182918. assert( pExpr->pConfig->eDetail==FTS5_DETAIL_COLUMNS );
  182919. if( pNode->bEof==0
  182920. && pNode->iRowid==pExpr->pRoot->iRowid
  182921. && pPhrase->poslist.n>0
  182922. ){
  182923. Fts5ExprTerm *pTerm = &pPhrase->aTerm[0];
  182924. if( pTerm->pSynonym ){
  182925. Fts5Buffer *pBuf = (Fts5Buffer*)&pTerm->pSynonym[1];
  182926. rc = fts5ExprSynonymList(
  182927. pTerm, pNode->iRowid, pBuf, (u8**)ppCollist, pnCollist
  182928. );
  182929. }else{
  182930. *ppCollist = pPhrase->aTerm[0].pIter->pData;
  182931. *pnCollist = pPhrase->aTerm[0].pIter->nData;
  182932. }
  182933. }else{
  182934. *ppCollist = 0;
  182935. *pnCollist = 0;
  182936. }
  182937. return rc;
  182938. }
  182939. /*
  182940. ** 2014 August 11
  182941. **
  182942. ** The author disclaims copyright to this source code. In place of
  182943. ** a legal notice, here is a blessing:
  182944. **
  182945. ** May you do good and not evil.
  182946. ** May you find forgiveness for yourself and forgive others.
  182947. ** May you share freely, never taking more than you give.
  182948. **
  182949. ******************************************************************************
  182950. **
  182951. */
  182952. /* #include "fts5Int.h" */
  182953. typedef struct Fts5HashEntry Fts5HashEntry;
  182954. /*
  182955. ** This file contains the implementation of an in-memory hash table used
  182956. ** to accumuluate "term -> doclist" content before it is flused to a level-0
  182957. ** segment.
  182958. */
  182959. struct Fts5Hash {
  182960. int eDetail; /* Copy of Fts5Config.eDetail */
  182961. int *pnByte; /* Pointer to bytes counter */
  182962. int nEntry; /* Number of entries currently in hash */
  182963. int nSlot; /* Size of aSlot[] array */
  182964. Fts5HashEntry *pScan; /* Current ordered scan item */
  182965. Fts5HashEntry **aSlot; /* Array of hash slots */
  182966. };
  182967. /*
  182968. ** Each entry in the hash table is represented by an object of the
  182969. ** following type. Each object, its key (a nul-terminated string) and
  182970. ** its current data are stored in a single memory allocation. The
  182971. ** key immediately follows the object in memory. The position list
  182972. ** data immediately follows the key data in memory.
  182973. **
  182974. ** The data that follows the key is in a similar, but not identical format
  182975. ** to the doclist data stored in the database. It is:
  182976. **
  182977. ** * Rowid, as a varint
  182978. ** * Position list, without 0x00 terminator.
  182979. ** * Size of previous position list and rowid, as a 4 byte
  182980. ** big-endian integer.
  182981. **
  182982. ** iRowidOff:
  182983. ** Offset of last rowid written to data area. Relative to first byte of
  182984. ** structure.
  182985. **
  182986. ** nData:
  182987. ** Bytes of data written since iRowidOff.
  182988. */
  182989. struct Fts5HashEntry {
  182990. Fts5HashEntry *pHashNext; /* Next hash entry with same hash-key */
  182991. Fts5HashEntry *pScanNext; /* Next entry in sorted order */
  182992. int nAlloc; /* Total size of allocation */
  182993. int iSzPoslist; /* Offset of space for 4-byte poslist size */
  182994. int nData; /* Total bytes of data (incl. structure) */
  182995. int nKey; /* Length of key in bytes */
  182996. u8 bDel; /* Set delete-flag @ iSzPoslist */
  182997. u8 bContent; /* Set content-flag (detail=none mode) */
  182998. i16 iCol; /* Column of last value written */
  182999. int iPos; /* Position of last value written */
  183000. i64 iRowid; /* Rowid of last value written */
  183001. };
  183002. /*
  183003. ** Eqivalent to:
  183004. **
  183005. ** char *fts5EntryKey(Fts5HashEntry *pEntry){ return zKey; }
  183006. */
  183007. #define fts5EntryKey(p) ( ((char *)(&(p)[1])) )
  183008. /*
  183009. ** Allocate a new hash table.
  183010. */
  183011. static int sqlite3Fts5HashNew(Fts5Config *pConfig, Fts5Hash **ppNew, int *pnByte){
  183012. int rc = SQLITE_OK;
  183013. Fts5Hash *pNew;
  183014. *ppNew = pNew = (Fts5Hash*)sqlite3_malloc(sizeof(Fts5Hash));
  183015. if( pNew==0 ){
  183016. rc = SQLITE_NOMEM;
  183017. }else{
  183018. int nByte;
  183019. memset(pNew, 0, sizeof(Fts5Hash));
  183020. pNew->pnByte = pnByte;
  183021. pNew->eDetail = pConfig->eDetail;
  183022. pNew->nSlot = 1024;
  183023. nByte = sizeof(Fts5HashEntry*) * pNew->nSlot;
  183024. pNew->aSlot = (Fts5HashEntry**)sqlite3_malloc(nByte);
  183025. if( pNew->aSlot==0 ){
  183026. sqlite3_free(pNew);
  183027. *ppNew = 0;
  183028. rc = SQLITE_NOMEM;
  183029. }else{
  183030. memset(pNew->aSlot, 0, nByte);
  183031. }
  183032. }
  183033. return rc;
  183034. }
  183035. /*
  183036. ** Free a hash table object.
  183037. */
  183038. static void sqlite3Fts5HashFree(Fts5Hash *pHash){
  183039. if( pHash ){
  183040. sqlite3Fts5HashClear(pHash);
  183041. sqlite3_free(pHash->aSlot);
  183042. sqlite3_free(pHash);
  183043. }
  183044. }
  183045. /*
  183046. ** Empty (but do not delete) a hash table.
  183047. */
  183048. static void sqlite3Fts5HashClear(Fts5Hash *pHash){
  183049. int i;
  183050. for(i=0; i<pHash->nSlot; i++){
  183051. Fts5HashEntry *pNext;
  183052. Fts5HashEntry *pSlot;
  183053. for(pSlot=pHash->aSlot[i]; pSlot; pSlot=pNext){
  183054. pNext = pSlot->pHashNext;
  183055. sqlite3_free(pSlot);
  183056. }
  183057. }
  183058. memset(pHash->aSlot, 0, pHash->nSlot * sizeof(Fts5HashEntry*));
  183059. pHash->nEntry = 0;
  183060. }
  183061. static unsigned int fts5HashKey(int nSlot, const u8 *p, int n){
  183062. int i;
  183063. unsigned int h = 13;
  183064. for(i=n-1; i>=0; i--){
  183065. h = (h << 3) ^ h ^ p[i];
  183066. }
  183067. return (h % nSlot);
  183068. }
  183069. static unsigned int fts5HashKey2(int nSlot, u8 b, const u8 *p, int n){
  183070. int i;
  183071. unsigned int h = 13;
  183072. for(i=n-1; i>=0; i--){
  183073. h = (h << 3) ^ h ^ p[i];
  183074. }
  183075. h = (h << 3) ^ h ^ b;
  183076. return (h % nSlot);
  183077. }
  183078. /*
  183079. ** Resize the hash table by doubling the number of slots.
  183080. */
  183081. static int fts5HashResize(Fts5Hash *pHash){
  183082. int nNew = pHash->nSlot*2;
  183083. int i;
  183084. Fts5HashEntry **apNew;
  183085. Fts5HashEntry **apOld = pHash->aSlot;
  183086. apNew = (Fts5HashEntry**)sqlite3_malloc(nNew*sizeof(Fts5HashEntry*));
  183087. if( !apNew ) return SQLITE_NOMEM;
  183088. memset(apNew, 0, nNew*sizeof(Fts5HashEntry*));
  183089. for(i=0; i<pHash->nSlot; i++){
  183090. while( apOld[i] ){
  183091. unsigned int iHash;
  183092. Fts5HashEntry *p = apOld[i];
  183093. apOld[i] = p->pHashNext;
  183094. iHash = fts5HashKey(nNew, (u8*)fts5EntryKey(p),
  183095. (int)strlen(fts5EntryKey(p)));
  183096. p->pHashNext = apNew[iHash];
  183097. apNew[iHash] = p;
  183098. }
  183099. }
  183100. sqlite3_free(apOld);
  183101. pHash->nSlot = nNew;
  183102. pHash->aSlot = apNew;
  183103. return SQLITE_OK;
  183104. }
  183105. static void fts5HashAddPoslistSize(Fts5Hash *pHash, Fts5HashEntry *p){
  183106. if( p->iSzPoslist ){
  183107. u8 *pPtr = (u8*)p;
  183108. if( pHash->eDetail==FTS5_DETAIL_NONE ){
  183109. assert( p->nData==p->iSzPoslist );
  183110. if( p->bDel ){
  183111. pPtr[p->nData++] = 0x00;
  183112. if( p->bContent ){
  183113. pPtr[p->nData++] = 0x00;
  183114. }
  183115. }
  183116. }else{
  183117. int nSz = (p->nData - p->iSzPoslist - 1); /* Size in bytes */
  183118. int nPos = nSz*2 + p->bDel; /* Value of nPos field */
  183119. assert( p->bDel==0 || p->bDel==1 );
  183120. if( nPos<=127 ){
  183121. pPtr[p->iSzPoslist] = (u8)nPos;
  183122. }else{
  183123. int nByte = sqlite3Fts5GetVarintLen((u32)nPos);
  183124. memmove(&pPtr[p->iSzPoslist + nByte], &pPtr[p->iSzPoslist + 1], nSz);
  183125. sqlite3Fts5PutVarint(&pPtr[p->iSzPoslist], nPos);
  183126. p->nData += (nByte-1);
  183127. }
  183128. }
  183129. p->iSzPoslist = 0;
  183130. p->bDel = 0;
  183131. p->bContent = 0;
  183132. }
  183133. }
  183134. /*
  183135. ** Add an entry to the in-memory hash table. The key is the concatenation
  183136. ** of bByte and (pToken/nToken). The value is (iRowid/iCol/iPos).
  183137. **
  183138. ** (bByte || pToken) -> (iRowid,iCol,iPos)
  183139. **
  183140. ** Or, if iCol is negative, then the value is a delete marker.
  183141. */
  183142. static int sqlite3Fts5HashWrite(
  183143. Fts5Hash *pHash,
  183144. i64 iRowid, /* Rowid for this entry */
  183145. int iCol, /* Column token appears in (-ve -> delete) */
  183146. int iPos, /* Position of token within column */
  183147. char bByte, /* First byte of token */
  183148. const char *pToken, int nToken /* Token to add or remove to or from index */
  183149. ){
  183150. unsigned int iHash;
  183151. Fts5HashEntry *p;
  183152. u8 *pPtr;
  183153. int nIncr = 0; /* Amount to increment (*pHash->pnByte) by */
  183154. int bNew; /* If non-delete entry should be written */
  183155. bNew = (pHash->eDetail==FTS5_DETAIL_FULL);
  183156. /* Attempt to locate an existing hash entry */
  183157. iHash = fts5HashKey2(pHash->nSlot, (u8)bByte, (const u8*)pToken, nToken);
  183158. for(p=pHash->aSlot[iHash]; p; p=p->pHashNext){
  183159. char *zKey = fts5EntryKey(p);
  183160. if( zKey[0]==bByte
  183161. && p->nKey==nToken
  183162. && memcmp(&zKey[1], pToken, nToken)==0
  183163. ){
  183164. break;
  183165. }
  183166. }
  183167. /* If an existing hash entry cannot be found, create a new one. */
  183168. if( p==0 ){
  183169. /* Figure out how much space to allocate */
  183170. char *zKey;
  183171. int nByte = sizeof(Fts5HashEntry) + (nToken+1) + 1 + 64;
  183172. if( nByte<128 ) nByte = 128;
  183173. /* Grow the Fts5Hash.aSlot[] array if necessary. */
  183174. if( (pHash->nEntry*2)>=pHash->nSlot ){
  183175. int rc = fts5HashResize(pHash);
  183176. if( rc!=SQLITE_OK ) return rc;
  183177. iHash = fts5HashKey2(pHash->nSlot, (u8)bByte, (const u8*)pToken, nToken);
  183178. }
  183179. /* Allocate new Fts5HashEntry and add it to the hash table. */
  183180. p = (Fts5HashEntry*)sqlite3_malloc(nByte);
  183181. if( !p ) return SQLITE_NOMEM;
  183182. memset(p, 0, sizeof(Fts5HashEntry));
  183183. p->nAlloc = nByte;
  183184. zKey = fts5EntryKey(p);
  183185. zKey[0] = bByte;
  183186. memcpy(&zKey[1], pToken, nToken);
  183187. assert( iHash==fts5HashKey(pHash->nSlot, (u8*)zKey, nToken+1) );
  183188. p->nKey = nToken;
  183189. zKey[nToken+1] = '\0';
  183190. p->nData = nToken+1 + 1 + sizeof(Fts5HashEntry);
  183191. p->pHashNext = pHash->aSlot[iHash];
  183192. pHash->aSlot[iHash] = p;
  183193. pHash->nEntry++;
  183194. /* Add the first rowid field to the hash-entry */
  183195. p->nData += sqlite3Fts5PutVarint(&((u8*)p)[p->nData], iRowid);
  183196. p->iRowid = iRowid;
  183197. p->iSzPoslist = p->nData;
  183198. if( pHash->eDetail!=FTS5_DETAIL_NONE ){
  183199. p->nData += 1;
  183200. p->iCol = (pHash->eDetail==FTS5_DETAIL_FULL ? 0 : -1);
  183201. }
  183202. nIncr += p->nData;
  183203. }else{
  183204. /* Appending to an existing hash-entry. Check that there is enough
  183205. ** space to append the largest possible new entry. Worst case scenario
  183206. ** is:
  183207. **
  183208. ** + 9 bytes for a new rowid,
  183209. ** + 4 byte reserved for the "poslist size" varint.
  183210. ** + 1 byte for a "new column" byte,
  183211. ** + 3 bytes for a new column number (16-bit max) as a varint,
  183212. ** + 5 bytes for the new position offset (32-bit max).
  183213. */
  183214. if( (p->nAlloc - p->nData) < (9 + 4 + 1 + 3 + 5) ){
  183215. int nNew = p->nAlloc * 2;
  183216. Fts5HashEntry *pNew;
  183217. Fts5HashEntry **pp;
  183218. pNew = (Fts5HashEntry*)sqlite3_realloc(p, nNew);
  183219. if( pNew==0 ) return SQLITE_NOMEM;
  183220. pNew->nAlloc = nNew;
  183221. for(pp=&pHash->aSlot[iHash]; *pp!=p; pp=&(*pp)->pHashNext);
  183222. *pp = pNew;
  183223. p = pNew;
  183224. }
  183225. nIncr -= p->nData;
  183226. }
  183227. assert( (p->nAlloc - p->nData) >= (9 + 4 + 1 + 3 + 5) );
  183228. pPtr = (u8*)p;
  183229. /* If this is a new rowid, append the 4-byte size field for the previous
  183230. ** entry, and the new rowid for this entry. */
  183231. if( iRowid!=p->iRowid ){
  183232. fts5HashAddPoslistSize(pHash, p);
  183233. p->nData += sqlite3Fts5PutVarint(&pPtr[p->nData], iRowid - p->iRowid);
  183234. p->iRowid = iRowid;
  183235. bNew = 1;
  183236. p->iSzPoslist = p->nData;
  183237. if( pHash->eDetail!=FTS5_DETAIL_NONE ){
  183238. p->nData += 1;
  183239. p->iCol = (pHash->eDetail==FTS5_DETAIL_FULL ? 0 : -1);
  183240. p->iPos = 0;
  183241. }
  183242. }
  183243. if( iCol>=0 ){
  183244. if( pHash->eDetail==FTS5_DETAIL_NONE ){
  183245. p->bContent = 1;
  183246. }else{
  183247. /* Append a new column value, if necessary */
  183248. assert( iCol>=p->iCol );
  183249. if( iCol!=p->iCol ){
  183250. if( pHash->eDetail==FTS5_DETAIL_FULL ){
  183251. pPtr[p->nData++] = 0x01;
  183252. p->nData += sqlite3Fts5PutVarint(&pPtr[p->nData], iCol);
  183253. p->iCol = (i16)iCol;
  183254. p->iPos = 0;
  183255. }else{
  183256. bNew = 1;
  183257. p->iCol = (i16)(iPos = iCol);
  183258. }
  183259. }
  183260. /* Append the new position offset, if necessary */
  183261. if( bNew ){
  183262. p->nData += sqlite3Fts5PutVarint(&pPtr[p->nData], iPos - p->iPos + 2);
  183263. p->iPos = iPos;
  183264. }
  183265. }
  183266. }else{
  183267. /* This is a delete. Set the delete flag. */
  183268. p->bDel = 1;
  183269. }
  183270. nIncr += p->nData;
  183271. *pHash->pnByte += nIncr;
  183272. return SQLITE_OK;
  183273. }
  183274. /*
  183275. ** Arguments pLeft and pRight point to linked-lists of hash-entry objects,
  183276. ** each sorted in key order. This function merges the two lists into a
  183277. ** single list and returns a pointer to its first element.
  183278. */
  183279. static Fts5HashEntry *fts5HashEntryMerge(
  183280. Fts5HashEntry *pLeft,
  183281. Fts5HashEntry *pRight
  183282. ){
  183283. Fts5HashEntry *p1 = pLeft;
  183284. Fts5HashEntry *p2 = pRight;
  183285. Fts5HashEntry *pRet = 0;
  183286. Fts5HashEntry **ppOut = &pRet;
  183287. while( p1 || p2 ){
  183288. if( p1==0 ){
  183289. *ppOut = p2;
  183290. p2 = 0;
  183291. }else if( p2==0 ){
  183292. *ppOut = p1;
  183293. p1 = 0;
  183294. }else{
  183295. int i = 0;
  183296. char *zKey1 = fts5EntryKey(p1);
  183297. char *zKey2 = fts5EntryKey(p2);
  183298. while( zKey1[i]==zKey2[i] ) i++;
  183299. if( ((u8)zKey1[i])>((u8)zKey2[i]) ){
  183300. /* p2 is smaller */
  183301. *ppOut = p2;
  183302. ppOut = &p2->pScanNext;
  183303. p2 = p2->pScanNext;
  183304. }else{
  183305. /* p1 is smaller */
  183306. *ppOut = p1;
  183307. ppOut = &p1->pScanNext;
  183308. p1 = p1->pScanNext;
  183309. }
  183310. *ppOut = 0;
  183311. }
  183312. }
  183313. return pRet;
  183314. }
  183315. /*
  183316. ** Extract all tokens from hash table iHash and link them into a list
  183317. ** in sorted order. The hash table is cleared before returning. It is
  183318. ** the responsibility of the caller to free the elements of the returned
  183319. ** list.
  183320. */
  183321. static int fts5HashEntrySort(
  183322. Fts5Hash *pHash,
  183323. const char *pTerm, int nTerm, /* Query prefix, if any */
  183324. Fts5HashEntry **ppSorted
  183325. ){
  183326. const int nMergeSlot = 32;
  183327. Fts5HashEntry **ap;
  183328. Fts5HashEntry *pList;
  183329. int iSlot;
  183330. int i;
  183331. *ppSorted = 0;
  183332. ap = sqlite3_malloc(sizeof(Fts5HashEntry*) * nMergeSlot);
  183333. if( !ap ) return SQLITE_NOMEM;
  183334. memset(ap, 0, sizeof(Fts5HashEntry*) * nMergeSlot);
  183335. for(iSlot=0; iSlot<pHash->nSlot; iSlot++){
  183336. Fts5HashEntry *pIter;
  183337. for(pIter=pHash->aSlot[iSlot]; pIter; pIter=pIter->pHashNext){
  183338. if( pTerm==0 || 0==memcmp(fts5EntryKey(pIter), pTerm, nTerm) ){
  183339. Fts5HashEntry *pEntry = pIter;
  183340. pEntry->pScanNext = 0;
  183341. for(i=0; ap[i]; i++){
  183342. pEntry = fts5HashEntryMerge(pEntry, ap[i]);
  183343. ap[i] = 0;
  183344. }
  183345. ap[i] = pEntry;
  183346. }
  183347. }
  183348. }
  183349. pList = 0;
  183350. for(i=0; i<nMergeSlot; i++){
  183351. pList = fts5HashEntryMerge(pList, ap[i]);
  183352. }
  183353. pHash->nEntry = 0;
  183354. sqlite3_free(ap);
  183355. *ppSorted = pList;
  183356. return SQLITE_OK;
  183357. }
  183358. /*
  183359. ** Query the hash table for a doclist associated with term pTerm/nTerm.
  183360. */
  183361. static int sqlite3Fts5HashQuery(
  183362. Fts5Hash *pHash, /* Hash table to query */
  183363. const char *pTerm, int nTerm, /* Query term */
  183364. const u8 **ppDoclist, /* OUT: Pointer to doclist for pTerm */
  183365. int *pnDoclist /* OUT: Size of doclist in bytes */
  183366. ){
  183367. unsigned int iHash = fts5HashKey(pHash->nSlot, (const u8*)pTerm, nTerm);
  183368. char *zKey = 0;
  183369. Fts5HashEntry *p;
  183370. for(p=pHash->aSlot[iHash]; p; p=p->pHashNext){
  183371. zKey = fts5EntryKey(p);
  183372. if( memcmp(zKey, pTerm, nTerm)==0 && zKey[nTerm]==0 ) break;
  183373. }
  183374. if( p ){
  183375. fts5HashAddPoslistSize(pHash, p);
  183376. *ppDoclist = (const u8*)&zKey[nTerm+1];
  183377. *pnDoclist = p->nData - (sizeof(Fts5HashEntry) + nTerm + 1);
  183378. }else{
  183379. *ppDoclist = 0;
  183380. *pnDoclist = 0;
  183381. }
  183382. return SQLITE_OK;
  183383. }
  183384. static int sqlite3Fts5HashScanInit(
  183385. Fts5Hash *p, /* Hash table to query */
  183386. const char *pTerm, int nTerm /* Query prefix */
  183387. ){
  183388. return fts5HashEntrySort(p, pTerm, nTerm, &p->pScan);
  183389. }
  183390. static void sqlite3Fts5HashScanNext(Fts5Hash *p){
  183391. assert( !sqlite3Fts5HashScanEof(p) );
  183392. p->pScan = p->pScan->pScanNext;
  183393. }
  183394. static int sqlite3Fts5HashScanEof(Fts5Hash *p){
  183395. return (p->pScan==0);
  183396. }
  183397. static void sqlite3Fts5HashScanEntry(
  183398. Fts5Hash *pHash,
  183399. const char **pzTerm, /* OUT: term (nul-terminated) */
  183400. const u8 **ppDoclist, /* OUT: pointer to doclist */
  183401. int *pnDoclist /* OUT: size of doclist in bytes */
  183402. ){
  183403. Fts5HashEntry *p;
  183404. if( (p = pHash->pScan) ){
  183405. char *zKey = fts5EntryKey(p);
  183406. int nTerm = (int)strlen(zKey);
  183407. fts5HashAddPoslistSize(pHash, p);
  183408. *pzTerm = zKey;
  183409. *ppDoclist = (const u8*)&zKey[nTerm+1];
  183410. *pnDoclist = p->nData - (sizeof(Fts5HashEntry) + nTerm + 1);
  183411. }else{
  183412. *pzTerm = 0;
  183413. *ppDoclist = 0;
  183414. *pnDoclist = 0;
  183415. }
  183416. }
  183417. /*
  183418. ** 2014 May 31
  183419. **
  183420. ** The author disclaims copyright to this source code. In place of
  183421. ** a legal notice, here is a blessing:
  183422. **
  183423. ** May you do good and not evil.
  183424. ** May you find forgiveness for yourself and forgive others.
  183425. ** May you share freely, never taking more than you give.
  183426. **
  183427. ******************************************************************************
  183428. **
  183429. ** Low level access to the FTS index stored in the database file. The
  183430. ** routines in this file file implement all read and write access to the
  183431. ** %_data table. Other parts of the system access this functionality via
  183432. ** the interface defined in fts5Int.h.
  183433. */
  183434. /* #include "fts5Int.h" */
  183435. /*
  183436. ** Overview:
  183437. **
  183438. ** The %_data table contains all the FTS indexes for an FTS5 virtual table.
  183439. ** As well as the main term index, there may be up to 31 prefix indexes.
  183440. ** The format is similar to FTS3/4, except that:
  183441. **
  183442. ** * all segment b-tree leaf data is stored in fixed size page records
  183443. ** (e.g. 1000 bytes). A single doclist may span multiple pages. Care is
  183444. ** taken to ensure it is possible to iterate in either direction through
  183445. ** the entries in a doclist, or to seek to a specific entry within a
  183446. ** doclist, without loading it into memory.
  183447. **
  183448. ** * large doclists that span many pages have associated "doclist index"
  183449. ** records that contain a copy of the first rowid on each page spanned by
  183450. ** the doclist. This is used to speed up seek operations, and merges of
  183451. ** large doclists with very small doclists.
  183452. **
  183453. ** * extra fields in the "structure record" record the state of ongoing
  183454. ** incremental merge operations.
  183455. **
  183456. */
  183457. #define FTS5_OPT_WORK_UNIT 1000 /* Number of leaf pages per optimize step */
  183458. #define FTS5_WORK_UNIT 64 /* Number of leaf pages in unit of work */
  183459. #define FTS5_MIN_DLIDX_SIZE 4 /* Add dlidx if this many empty pages */
  183460. #define FTS5_MAIN_PREFIX '0'
  183461. #if FTS5_MAX_PREFIX_INDEXES > 31
  183462. # error "FTS5_MAX_PREFIX_INDEXES is too large"
  183463. #endif
  183464. /*
  183465. ** Details:
  183466. **
  183467. ** The %_data table managed by this module,
  183468. **
  183469. ** CREATE TABLE %_data(id INTEGER PRIMARY KEY, block BLOB);
  183470. **
  183471. ** , contains the following 5 types of records. See the comments surrounding
  183472. ** the FTS5_*_ROWID macros below for a description of how %_data rowids are
  183473. ** assigned to each fo them.
  183474. **
  183475. ** 1. Structure Records:
  183476. **
  183477. ** The set of segments that make up an index - the index structure - are
  183478. ** recorded in a single record within the %_data table. The record consists
  183479. ** of a single 32-bit configuration cookie value followed by a list of
  183480. ** SQLite varints. If the FTS table features more than one index (because
  183481. ** there are one or more prefix indexes), it is guaranteed that all share
  183482. ** the same cookie value.
  183483. **
  183484. ** Immediately following the configuration cookie, the record begins with
  183485. ** three varints:
  183486. **
  183487. ** + number of levels,
  183488. ** + total number of segments on all levels,
  183489. ** + value of write counter.
  183490. **
  183491. ** Then, for each level from 0 to nMax:
  183492. **
  183493. ** + number of input segments in ongoing merge.
  183494. ** + total number of segments in level.
  183495. ** + for each segment from oldest to newest:
  183496. ** + segment id (always > 0)
  183497. ** + first leaf page number (often 1, always greater than 0)
  183498. ** + final leaf page number
  183499. **
  183500. ** 2. The Averages Record:
  183501. **
  183502. ** A single record within the %_data table. The data is a list of varints.
  183503. ** The first value is the number of rows in the index. Then, for each column
  183504. ** from left to right, the total number of tokens in the column for all
  183505. ** rows of the table.
  183506. **
  183507. ** 3. Segment leaves:
  183508. **
  183509. ** TERM/DOCLIST FORMAT:
  183510. **
  183511. ** Most of each segment leaf is taken up by term/doclist data. The
  183512. ** general format of term/doclist, starting with the first term
  183513. ** on the leaf page, is:
  183514. **
  183515. ** varint : size of first term
  183516. ** blob: first term data
  183517. ** doclist: first doclist
  183518. ** zero-or-more {
  183519. ** varint: number of bytes in common with previous term
  183520. ** varint: number of bytes of new term data (nNew)
  183521. ** blob: nNew bytes of new term data
  183522. ** doclist: next doclist
  183523. ** }
  183524. **
  183525. ** doclist format:
  183526. **
  183527. ** varint: first rowid
  183528. ** poslist: first poslist
  183529. ** zero-or-more {
  183530. ** varint: rowid delta (always > 0)
  183531. ** poslist: next poslist
  183532. ** }
  183533. **
  183534. ** poslist format:
  183535. **
  183536. ** varint: size of poslist in bytes multiplied by 2, not including
  183537. ** this field. Plus 1 if this entry carries the "delete" flag.
  183538. ** collist: collist for column 0
  183539. ** zero-or-more {
  183540. ** 0x01 byte
  183541. ** varint: column number (I)
  183542. ** collist: collist for column I
  183543. ** }
  183544. **
  183545. ** collist format:
  183546. **
  183547. ** varint: first offset + 2
  183548. ** zero-or-more {
  183549. ** varint: offset delta + 2
  183550. ** }
  183551. **
  183552. ** PAGE FORMAT
  183553. **
  183554. ** Each leaf page begins with a 4-byte header containing 2 16-bit
  183555. ** unsigned integer fields in big-endian format. They are:
  183556. **
  183557. ** * The byte offset of the first rowid on the page, if it exists
  183558. ** and occurs before the first term (otherwise 0).
  183559. **
  183560. ** * The byte offset of the start of the page footer. If the page
  183561. ** footer is 0 bytes in size, then this field is the same as the
  183562. ** size of the leaf page in bytes.
  183563. **
  183564. ** The page footer consists of a single varint for each term located
  183565. ** on the page. Each varint is the byte offset of the current term
  183566. ** within the page, delta-compressed against the previous value. In
  183567. ** other words, the first varint in the footer is the byte offset of
  183568. ** the first term, the second is the byte offset of the second less that
  183569. ** of the first, and so on.
  183570. **
  183571. ** The term/doclist format described above is accurate if the entire
  183572. ** term/doclist data fits on a single leaf page. If this is not the case,
  183573. ** the format is changed in two ways:
  183574. **
  183575. ** + if the first rowid on a page occurs before the first term, it
  183576. ** is stored as a literal value:
  183577. **
  183578. ** varint: first rowid
  183579. **
  183580. ** + the first term on each page is stored in the same way as the
  183581. ** very first term of the segment:
  183582. **
  183583. ** varint : size of first term
  183584. ** blob: first term data
  183585. **
  183586. ** 5. Segment doclist indexes:
  183587. **
  183588. ** Doclist indexes are themselves b-trees, however they usually consist of
  183589. ** a single leaf record only. The format of each doclist index leaf page
  183590. ** is:
  183591. **
  183592. ** * Flags byte. Bits are:
  183593. ** 0x01: Clear if leaf is also the root page, otherwise set.
  183594. **
  183595. ** * Page number of fts index leaf page. As a varint.
  183596. **
  183597. ** * First rowid on page indicated by previous field. As a varint.
  183598. **
  183599. ** * A list of varints, one for each subsequent termless page. A
  183600. ** positive delta if the termless page contains at least one rowid,
  183601. ** or an 0x00 byte otherwise.
  183602. **
  183603. ** Internal doclist index nodes are:
  183604. **
  183605. ** * Flags byte. Bits are:
  183606. ** 0x01: Clear for root page, otherwise set.
  183607. **
  183608. ** * Page number of first child page. As a varint.
  183609. **
  183610. ** * Copy of first rowid on page indicated by previous field. As a varint.
  183611. **
  183612. ** * A list of delta-encoded varints - the first rowid on each subsequent
  183613. ** child page.
  183614. **
  183615. */
  183616. /*
  183617. ** Rowids for the averages and structure records in the %_data table.
  183618. */
  183619. #define FTS5_AVERAGES_ROWID 1 /* Rowid used for the averages record */
  183620. #define FTS5_STRUCTURE_ROWID 10 /* The structure record */
  183621. /*
  183622. ** Macros determining the rowids used by segment leaves and dlidx leaves
  183623. ** and nodes. All nodes and leaves are stored in the %_data table with large
  183624. ** positive rowids.
  183625. **
  183626. ** Each segment has a unique non-zero 16-bit id.
  183627. **
  183628. ** The rowid for each segment leaf is found by passing the segment id and
  183629. ** the leaf page number to the FTS5_SEGMENT_ROWID macro. Leaves are numbered
  183630. ** sequentially starting from 1.
  183631. */
  183632. #define FTS5_DATA_ID_B 16 /* Max seg id number 65535 */
  183633. #define FTS5_DATA_DLI_B 1 /* Doclist-index flag (1 bit) */
  183634. #define FTS5_DATA_HEIGHT_B 5 /* Max dlidx tree height of 32 */
  183635. #define FTS5_DATA_PAGE_B 31 /* Max page number of 2147483648 */
  183636. #define fts5_dri(segid, dlidx, height, pgno) ( \
  183637. ((i64)(segid) << (FTS5_DATA_PAGE_B+FTS5_DATA_HEIGHT_B+FTS5_DATA_DLI_B)) + \
  183638. ((i64)(dlidx) << (FTS5_DATA_PAGE_B + FTS5_DATA_HEIGHT_B)) + \
  183639. ((i64)(height) << (FTS5_DATA_PAGE_B)) + \
  183640. ((i64)(pgno)) \
  183641. )
  183642. #define FTS5_SEGMENT_ROWID(segid, pgno) fts5_dri(segid, 0, 0, pgno)
  183643. #define FTS5_DLIDX_ROWID(segid, height, pgno) fts5_dri(segid, 1, height, pgno)
  183644. /*
  183645. ** Maximum segments permitted in a single index
  183646. */
  183647. #define FTS5_MAX_SEGMENT 2000
  183648. #ifdef SQLITE_DEBUG
  183649. static int sqlite3Fts5Corrupt() { return SQLITE_CORRUPT_VTAB; }
  183650. #endif
  183651. /*
  183652. ** Each time a blob is read from the %_data table, it is padded with this
  183653. ** many zero bytes. This makes it easier to decode the various record formats
  183654. ** without overreading if the records are corrupt.
  183655. */
  183656. #define FTS5_DATA_ZERO_PADDING 8
  183657. #define FTS5_DATA_PADDING 20
  183658. typedef struct Fts5Data Fts5Data;
  183659. typedef struct Fts5DlidxIter Fts5DlidxIter;
  183660. typedef struct Fts5DlidxLvl Fts5DlidxLvl;
  183661. typedef struct Fts5DlidxWriter Fts5DlidxWriter;
  183662. typedef struct Fts5Iter Fts5Iter;
  183663. typedef struct Fts5PageWriter Fts5PageWriter;
  183664. typedef struct Fts5SegIter Fts5SegIter;
  183665. typedef struct Fts5DoclistIter Fts5DoclistIter;
  183666. typedef struct Fts5SegWriter Fts5SegWriter;
  183667. typedef struct Fts5Structure Fts5Structure;
  183668. typedef struct Fts5StructureLevel Fts5StructureLevel;
  183669. typedef struct Fts5StructureSegment Fts5StructureSegment;
  183670. struct Fts5Data {
  183671. u8 *p; /* Pointer to buffer containing record */
  183672. int nn; /* Size of record in bytes */
  183673. int szLeaf; /* Size of leaf without page-index */
  183674. };
  183675. /*
  183676. ** One object per %_data table.
  183677. */
  183678. struct Fts5Index {
  183679. Fts5Config *pConfig; /* Virtual table configuration */
  183680. char *zDataTbl; /* Name of %_data table */
  183681. int nWorkUnit; /* Leaf pages in a "unit" of work */
  183682. /*
  183683. ** Variables related to the accumulation of tokens and doclists within the
  183684. ** in-memory hash tables before they are flushed to disk.
  183685. */
  183686. Fts5Hash *pHash; /* Hash table for in-memory data */
  183687. int nPendingData; /* Current bytes of pending data */
  183688. i64 iWriteRowid; /* Rowid for current doc being written */
  183689. int bDelete; /* Current write is a delete */
  183690. /* Error state. */
  183691. int rc; /* Current error code */
  183692. /* State used by the fts5DataXXX() functions. */
  183693. sqlite3_blob *pReader; /* RO incr-blob open on %_data table */
  183694. sqlite3_stmt *pWriter; /* "INSERT ... %_data VALUES(?,?)" */
  183695. sqlite3_stmt *pDeleter; /* "DELETE FROM %_data ... id>=? AND id<=?" */
  183696. sqlite3_stmt *pIdxWriter; /* "INSERT ... %_idx VALUES(?,?,?,?)" */
  183697. sqlite3_stmt *pIdxDeleter; /* "DELETE FROM %_idx WHERE segid=? */
  183698. sqlite3_stmt *pIdxSelect;
  183699. int nRead; /* Total number of blocks read */
  183700. sqlite3_stmt *pDataVersion;
  183701. i64 iStructVersion; /* data_version when pStruct read */
  183702. Fts5Structure *pStruct; /* Current db structure (or NULL) */
  183703. };
  183704. struct Fts5DoclistIter {
  183705. u8 *aEof; /* Pointer to 1 byte past end of doclist */
  183706. /* Output variables. aPoslist==0 at EOF */
  183707. i64 iRowid;
  183708. u8 *aPoslist;
  183709. int nPoslist;
  183710. int nSize;
  183711. };
  183712. /*
  183713. ** The contents of the "structure" record for each index are represented
  183714. ** using an Fts5Structure record in memory. Which uses instances of the
  183715. ** other Fts5StructureXXX types as components.
  183716. */
  183717. struct Fts5StructureSegment {
  183718. int iSegid; /* Segment id */
  183719. int pgnoFirst; /* First leaf page number in segment */
  183720. int pgnoLast; /* Last leaf page number in segment */
  183721. };
  183722. struct Fts5StructureLevel {
  183723. int nMerge; /* Number of segments in incr-merge */
  183724. int nSeg; /* Total number of segments on level */
  183725. Fts5StructureSegment *aSeg; /* Array of segments. aSeg[0] is oldest. */
  183726. };
  183727. struct Fts5Structure {
  183728. int nRef; /* Object reference count */
  183729. u64 nWriteCounter; /* Total leaves written to level 0 */
  183730. int nSegment; /* Total segments in this structure */
  183731. int nLevel; /* Number of levels in this index */
  183732. Fts5StructureLevel aLevel[1]; /* Array of nLevel level objects */
  183733. };
  183734. /*
  183735. ** An object of type Fts5SegWriter is used to write to segments.
  183736. */
  183737. struct Fts5PageWriter {
  183738. int pgno; /* Page number for this page */
  183739. int iPrevPgidx; /* Previous value written into pgidx */
  183740. Fts5Buffer buf; /* Buffer containing leaf data */
  183741. Fts5Buffer pgidx; /* Buffer containing page-index */
  183742. Fts5Buffer term; /* Buffer containing previous term on page */
  183743. };
  183744. struct Fts5DlidxWriter {
  183745. int pgno; /* Page number for this page */
  183746. int bPrevValid; /* True if iPrev is valid */
  183747. i64 iPrev; /* Previous rowid value written to page */
  183748. Fts5Buffer buf; /* Buffer containing page data */
  183749. };
  183750. struct Fts5SegWriter {
  183751. int iSegid; /* Segid to write to */
  183752. Fts5PageWriter writer; /* PageWriter object */
  183753. i64 iPrevRowid; /* Previous rowid written to current leaf */
  183754. u8 bFirstRowidInDoclist; /* True if next rowid is first in doclist */
  183755. u8 bFirstRowidInPage; /* True if next rowid is first in page */
  183756. /* TODO1: Can use (writer.pgidx.n==0) instead of bFirstTermInPage */
  183757. u8 bFirstTermInPage; /* True if next term will be first in leaf */
  183758. int nLeafWritten; /* Number of leaf pages written */
  183759. int nEmpty; /* Number of contiguous term-less nodes */
  183760. int nDlidx; /* Allocated size of aDlidx[] array */
  183761. Fts5DlidxWriter *aDlidx; /* Array of Fts5DlidxWriter objects */
  183762. /* Values to insert into the %_idx table */
  183763. Fts5Buffer btterm; /* Next term to insert into %_idx table */
  183764. int iBtPage; /* Page number corresponding to btterm */
  183765. };
  183766. typedef struct Fts5CResult Fts5CResult;
  183767. struct Fts5CResult {
  183768. u16 iFirst; /* aSeg[] index of firstest iterator */
  183769. u8 bTermEq; /* True if the terms are equal */
  183770. };
  183771. /*
  183772. ** Object for iterating through a single segment, visiting each term/rowid
  183773. ** pair in the segment.
  183774. **
  183775. ** pSeg:
  183776. ** The segment to iterate through.
  183777. **
  183778. ** iLeafPgno:
  183779. ** Current leaf page number within segment.
  183780. **
  183781. ** iLeafOffset:
  183782. ** Byte offset within the current leaf that is the first byte of the
  183783. ** position list data (one byte passed the position-list size field).
  183784. ** rowid field of the current entry. Usually this is the size field of the
  183785. ** position list data. The exception is if the rowid for the current entry
  183786. ** is the last thing on the leaf page.
  183787. **
  183788. ** pLeaf:
  183789. ** Buffer containing current leaf page data. Set to NULL at EOF.
  183790. **
  183791. ** iTermLeafPgno, iTermLeafOffset:
  183792. ** Leaf page number containing the last term read from the segment. And
  183793. ** the offset immediately following the term data.
  183794. **
  183795. ** flags:
  183796. ** Mask of FTS5_SEGITER_XXX values. Interpreted as follows:
  183797. **
  183798. ** FTS5_SEGITER_ONETERM:
  183799. ** If set, set the iterator to point to EOF after the current doclist
  183800. ** has been exhausted. Do not proceed to the next term in the segment.
  183801. **
  183802. ** FTS5_SEGITER_REVERSE:
  183803. ** This flag is only ever set if FTS5_SEGITER_ONETERM is also set. If
  183804. ** it is set, iterate through rowid in descending order instead of the
  183805. ** default ascending order.
  183806. **
  183807. ** iRowidOffset/nRowidOffset/aRowidOffset:
  183808. ** These are used if the FTS5_SEGITER_REVERSE flag is set.
  183809. **
  183810. ** For each rowid on the page corresponding to the current term, the
  183811. ** corresponding aRowidOffset[] entry is set to the byte offset of the
  183812. ** start of the "position-list-size" field within the page.
  183813. **
  183814. ** iTermIdx:
  183815. ** Index of current term on iTermLeafPgno.
  183816. */
  183817. struct Fts5SegIter {
  183818. Fts5StructureSegment *pSeg; /* Segment to iterate through */
  183819. int flags; /* Mask of configuration flags */
  183820. int iLeafPgno; /* Current leaf page number */
  183821. Fts5Data *pLeaf; /* Current leaf data */
  183822. Fts5Data *pNextLeaf; /* Leaf page (iLeafPgno+1) */
  183823. int iLeafOffset; /* Byte offset within current leaf */
  183824. /* Next method */
  183825. void (*xNext)(Fts5Index*, Fts5SegIter*, int*);
  183826. /* The page and offset from which the current term was read. The offset
  183827. ** is the offset of the first rowid in the current doclist. */
  183828. int iTermLeafPgno;
  183829. int iTermLeafOffset;
  183830. int iPgidxOff; /* Next offset in pgidx */
  183831. int iEndofDoclist;
  183832. /* The following are only used if the FTS5_SEGITER_REVERSE flag is set. */
  183833. int iRowidOffset; /* Current entry in aRowidOffset[] */
  183834. int nRowidOffset; /* Allocated size of aRowidOffset[] array */
  183835. int *aRowidOffset; /* Array of offset to rowid fields */
  183836. Fts5DlidxIter *pDlidx; /* If there is a doclist-index */
  183837. /* Variables populated based on current entry. */
  183838. Fts5Buffer term; /* Current term */
  183839. i64 iRowid; /* Current rowid */
  183840. int nPos; /* Number of bytes in current position list */
  183841. u8 bDel; /* True if the delete flag is set */
  183842. };
  183843. /*
  183844. ** Argument is a pointer to an Fts5Data structure that contains a
  183845. ** leaf page.
  183846. */
  183847. #define ASSERT_SZLEAF_OK(x) assert( \
  183848. (x)->szLeaf==(x)->nn || (x)->szLeaf==fts5GetU16(&(x)->p[2]) \
  183849. )
  183850. #define FTS5_SEGITER_ONETERM 0x01
  183851. #define FTS5_SEGITER_REVERSE 0x02
  183852. /*
  183853. ** Argument is a pointer to an Fts5Data structure that contains a leaf
  183854. ** page. This macro evaluates to true if the leaf contains no terms, or
  183855. ** false if it contains at least one term.
  183856. */
  183857. #define fts5LeafIsTermless(x) ((x)->szLeaf >= (x)->nn)
  183858. #define fts5LeafTermOff(x, i) (fts5GetU16(&(x)->p[(x)->szLeaf + (i)*2]))
  183859. #define fts5LeafFirstRowidOff(x) (fts5GetU16((x)->p))
  183860. /*
  183861. ** Object for iterating through the merged results of one or more segments,
  183862. ** visiting each term/rowid pair in the merged data.
  183863. **
  183864. ** nSeg is always a power of two greater than or equal to the number of
  183865. ** segments that this object is merging data from. Both the aSeg[] and
  183866. ** aFirst[] arrays are sized at nSeg entries. The aSeg[] array is padded
  183867. ** with zeroed objects - these are handled as if they were iterators opened
  183868. ** on empty segments.
  183869. **
  183870. ** The results of comparing segments aSeg[N] and aSeg[N+1], where N is an
  183871. ** even number, is stored in aFirst[(nSeg+N)/2]. The "result" of the
  183872. ** comparison in this context is the index of the iterator that currently
  183873. ** points to the smaller term/rowid combination. Iterators at EOF are
  183874. ** considered to be greater than all other iterators.
  183875. **
  183876. ** aFirst[1] contains the index in aSeg[] of the iterator that points to
  183877. ** the smallest key overall. aFirst[0] is unused.
  183878. **
  183879. ** poslist:
  183880. ** Used by sqlite3Fts5IterPoslist() when the poslist needs to be buffered.
  183881. ** There is no way to tell if this is populated or not.
  183882. */
  183883. struct Fts5Iter {
  183884. Fts5IndexIter base; /* Base class containing output vars */
  183885. Fts5Index *pIndex; /* Index that owns this iterator */
  183886. Fts5Structure *pStruct; /* Database structure for this iterator */
  183887. Fts5Buffer poslist; /* Buffer containing current poslist */
  183888. Fts5Colset *pColset; /* Restrict matches to these columns */
  183889. /* Invoked to set output variables. */
  183890. void (*xSetOutputs)(Fts5Iter*, Fts5SegIter*);
  183891. int nSeg; /* Size of aSeg[] array */
  183892. int bRev; /* True to iterate in reverse order */
  183893. u8 bSkipEmpty; /* True to skip deleted entries */
  183894. i64 iSwitchRowid; /* Firstest rowid of other than aFirst[1] */
  183895. Fts5CResult *aFirst; /* Current merge state (see above) */
  183896. Fts5SegIter aSeg[1]; /* Array of segment iterators */
  183897. };
  183898. /*
  183899. ** An instance of the following type is used to iterate through the contents
  183900. ** of a doclist-index record.
  183901. **
  183902. ** pData:
  183903. ** Record containing the doclist-index data.
  183904. **
  183905. ** bEof:
  183906. ** Set to true once iterator has reached EOF.
  183907. **
  183908. ** iOff:
  183909. ** Set to the current offset within record pData.
  183910. */
  183911. struct Fts5DlidxLvl {
  183912. Fts5Data *pData; /* Data for current page of this level */
  183913. int iOff; /* Current offset into pData */
  183914. int bEof; /* At EOF already */
  183915. int iFirstOff; /* Used by reverse iterators */
  183916. /* Output variables */
  183917. int iLeafPgno; /* Page number of current leaf page */
  183918. i64 iRowid; /* First rowid on leaf iLeafPgno */
  183919. };
  183920. struct Fts5DlidxIter {
  183921. int nLvl;
  183922. int iSegid;
  183923. Fts5DlidxLvl aLvl[1];
  183924. };
  183925. static void fts5PutU16(u8 *aOut, u16 iVal){
  183926. aOut[0] = (iVal>>8);
  183927. aOut[1] = (iVal&0xFF);
  183928. }
  183929. static u16 fts5GetU16(const u8 *aIn){
  183930. return ((u16)aIn[0] << 8) + aIn[1];
  183931. }
  183932. /*
  183933. ** Allocate and return a buffer at least nByte bytes in size.
  183934. **
  183935. ** If an OOM error is encountered, return NULL and set the error code in
  183936. ** the Fts5Index handle passed as the first argument.
  183937. */
  183938. static void *fts5IdxMalloc(Fts5Index *p, int nByte){
  183939. return sqlite3Fts5MallocZero(&p->rc, nByte);
  183940. }
  183941. /*
  183942. ** Compare the contents of the pLeft buffer with the pRight/nRight blob.
  183943. **
  183944. ** Return -ve if pLeft is smaller than pRight, 0 if they are equal or
  183945. ** +ve if pRight is smaller than pLeft. In other words:
  183946. **
  183947. ** res = *pLeft - *pRight
  183948. */
  183949. #ifdef SQLITE_DEBUG
  183950. static int fts5BufferCompareBlob(
  183951. Fts5Buffer *pLeft, /* Left hand side of comparison */
  183952. const u8 *pRight, int nRight /* Right hand side of comparison */
  183953. ){
  183954. int nCmp = MIN(pLeft->n, nRight);
  183955. int res = memcmp(pLeft->p, pRight, nCmp);
  183956. return (res==0 ? (pLeft->n - nRight) : res);
  183957. }
  183958. #endif
  183959. /*
  183960. ** Compare the contents of the two buffers using memcmp(). If one buffer
  183961. ** is a prefix of the other, it is considered the lesser.
  183962. **
  183963. ** Return -ve if pLeft is smaller than pRight, 0 if they are equal or
  183964. ** +ve if pRight is smaller than pLeft. In other words:
  183965. **
  183966. ** res = *pLeft - *pRight
  183967. */
  183968. static int fts5BufferCompare(Fts5Buffer *pLeft, Fts5Buffer *pRight){
  183969. int nCmp = MIN(pLeft->n, pRight->n);
  183970. int res = memcmp(pLeft->p, pRight->p, nCmp);
  183971. return (res==0 ? (pLeft->n - pRight->n) : res);
  183972. }
  183973. static int fts5LeafFirstTermOff(Fts5Data *pLeaf){
  183974. int ret;
  183975. fts5GetVarint32(&pLeaf->p[pLeaf->szLeaf], ret);
  183976. return ret;
  183977. }
  183978. /*
  183979. ** Close the read-only blob handle, if it is open.
  183980. */
  183981. static void fts5CloseReader(Fts5Index *p){
  183982. if( p->pReader ){
  183983. sqlite3_blob *pReader = p->pReader;
  183984. p->pReader = 0;
  183985. sqlite3_blob_close(pReader);
  183986. }
  183987. }
  183988. /*
  183989. ** Retrieve a record from the %_data table.
  183990. **
  183991. ** If an error occurs, NULL is returned and an error left in the
  183992. ** Fts5Index object.
  183993. */
  183994. static Fts5Data *fts5DataRead(Fts5Index *p, i64 iRowid){
  183995. Fts5Data *pRet = 0;
  183996. if( p->rc==SQLITE_OK ){
  183997. int rc = SQLITE_OK;
  183998. if( p->pReader ){
  183999. /* This call may return SQLITE_ABORT if there has been a savepoint
  184000. ** rollback since it was last used. In this case a new blob handle
  184001. ** is required. */
  184002. sqlite3_blob *pBlob = p->pReader;
  184003. p->pReader = 0;
  184004. rc = sqlite3_blob_reopen(pBlob, iRowid);
  184005. assert( p->pReader==0 );
  184006. p->pReader = pBlob;
  184007. if( rc!=SQLITE_OK ){
  184008. fts5CloseReader(p);
  184009. }
  184010. if( rc==SQLITE_ABORT ) rc = SQLITE_OK;
  184011. }
  184012. /* If the blob handle is not open at this point, open it and seek
  184013. ** to the requested entry. */
  184014. if( p->pReader==0 && rc==SQLITE_OK ){
  184015. Fts5Config *pConfig = p->pConfig;
  184016. rc = sqlite3_blob_open(pConfig->db,
  184017. pConfig->zDb, p->zDataTbl, "block", iRowid, 0, &p->pReader
  184018. );
  184019. }
  184020. /* If either of the sqlite3_blob_open() or sqlite3_blob_reopen() calls
  184021. ** above returned SQLITE_ERROR, return SQLITE_CORRUPT_VTAB instead.
  184022. ** All the reasons those functions might return SQLITE_ERROR - missing
  184023. ** table, missing row, non-blob/text in block column - indicate
  184024. ** backing store corruption. */
  184025. if( rc==SQLITE_ERROR ) rc = FTS5_CORRUPT;
  184026. if( rc==SQLITE_OK ){
  184027. u8 *aOut = 0; /* Read blob data into this buffer */
  184028. int nByte = sqlite3_blob_bytes(p->pReader);
  184029. int nAlloc = sizeof(Fts5Data) + nByte + FTS5_DATA_PADDING;
  184030. pRet = (Fts5Data*)sqlite3_malloc(nAlloc);
  184031. if( pRet ){
  184032. pRet->nn = nByte;
  184033. aOut = pRet->p = (u8*)&pRet[1];
  184034. }else{
  184035. rc = SQLITE_NOMEM;
  184036. }
  184037. if( rc==SQLITE_OK ){
  184038. rc = sqlite3_blob_read(p->pReader, aOut, nByte, 0);
  184039. }
  184040. if( rc!=SQLITE_OK ){
  184041. sqlite3_free(pRet);
  184042. pRet = 0;
  184043. }else{
  184044. /* TODO1: Fix this */
  184045. pRet->szLeaf = fts5GetU16(&pRet->p[2]);
  184046. }
  184047. }
  184048. p->rc = rc;
  184049. p->nRead++;
  184050. }
  184051. assert( (pRet==0)==(p->rc!=SQLITE_OK) );
  184052. return pRet;
  184053. }
  184054. /*
  184055. ** Release a reference to data record returned by an earlier call to
  184056. ** fts5DataRead().
  184057. */
  184058. static void fts5DataRelease(Fts5Data *pData){
  184059. sqlite3_free(pData);
  184060. }
  184061. static Fts5Data *fts5LeafRead(Fts5Index *p, i64 iRowid){
  184062. Fts5Data *pRet = fts5DataRead(p, iRowid);
  184063. if( pRet ){
  184064. if( pRet->szLeaf>pRet->nn ){
  184065. p->rc = FTS5_CORRUPT;
  184066. fts5DataRelease(pRet);
  184067. pRet = 0;
  184068. }
  184069. }
  184070. return pRet;
  184071. }
  184072. static int fts5IndexPrepareStmt(
  184073. Fts5Index *p,
  184074. sqlite3_stmt **ppStmt,
  184075. char *zSql
  184076. ){
  184077. if( p->rc==SQLITE_OK ){
  184078. if( zSql ){
  184079. p->rc = sqlite3_prepare_v3(p->pConfig->db, zSql, -1,
  184080. SQLITE_PREPARE_PERSISTENT, ppStmt, 0);
  184081. }else{
  184082. p->rc = SQLITE_NOMEM;
  184083. }
  184084. }
  184085. sqlite3_free(zSql);
  184086. return p->rc;
  184087. }
  184088. /*
  184089. ** INSERT OR REPLACE a record into the %_data table.
  184090. */
  184091. static void fts5DataWrite(Fts5Index *p, i64 iRowid, const u8 *pData, int nData){
  184092. if( p->rc!=SQLITE_OK ) return;
  184093. if( p->pWriter==0 ){
  184094. Fts5Config *pConfig = p->pConfig;
  184095. fts5IndexPrepareStmt(p, &p->pWriter, sqlite3_mprintf(
  184096. "REPLACE INTO '%q'.'%q_data'(id, block) VALUES(?,?)",
  184097. pConfig->zDb, pConfig->zName
  184098. ));
  184099. if( p->rc ) return;
  184100. }
  184101. sqlite3_bind_int64(p->pWriter, 1, iRowid);
  184102. sqlite3_bind_blob(p->pWriter, 2, pData, nData, SQLITE_STATIC);
  184103. sqlite3_step(p->pWriter);
  184104. p->rc = sqlite3_reset(p->pWriter);
  184105. sqlite3_bind_null(p->pWriter, 2);
  184106. }
  184107. /*
  184108. ** Execute the following SQL:
  184109. **
  184110. ** DELETE FROM %_data WHERE id BETWEEN $iFirst AND $iLast
  184111. */
  184112. static void fts5DataDelete(Fts5Index *p, i64 iFirst, i64 iLast){
  184113. if( p->rc!=SQLITE_OK ) return;
  184114. if( p->pDeleter==0 ){
  184115. int rc;
  184116. Fts5Config *pConfig = p->pConfig;
  184117. char *zSql = sqlite3_mprintf(
  184118. "DELETE FROM '%q'.'%q_data' WHERE id>=? AND id<=?",
  184119. pConfig->zDb, pConfig->zName
  184120. );
  184121. if( zSql==0 ){
  184122. rc = SQLITE_NOMEM;
  184123. }else{
  184124. rc = sqlite3_prepare_v3(pConfig->db, zSql, -1,
  184125. SQLITE_PREPARE_PERSISTENT, &p->pDeleter, 0);
  184126. sqlite3_free(zSql);
  184127. }
  184128. if( rc!=SQLITE_OK ){
  184129. p->rc = rc;
  184130. return;
  184131. }
  184132. }
  184133. sqlite3_bind_int64(p->pDeleter, 1, iFirst);
  184134. sqlite3_bind_int64(p->pDeleter, 2, iLast);
  184135. sqlite3_step(p->pDeleter);
  184136. p->rc = sqlite3_reset(p->pDeleter);
  184137. }
  184138. /*
  184139. ** Remove all records associated with segment iSegid.
  184140. */
  184141. static void fts5DataRemoveSegment(Fts5Index *p, int iSegid){
  184142. i64 iFirst = FTS5_SEGMENT_ROWID(iSegid, 0);
  184143. i64 iLast = FTS5_SEGMENT_ROWID(iSegid+1, 0)-1;
  184144. fts5DataDelete(p, iFirst, iLast);
  184145. if( p->pIdxDeleter==0 ){
  184146. Fts5Config *pConfig = p->pConfig;
  184147. fts5IndexPrepareStmt(p, &p->pIdxDeleter, sqlite3_mprintf(
  184148. "DELETE FROM '%q'.'%q_idx' WHERE segid=?",
  184149. pConfig->zDb, pConfig->zName
  184150. ));
  184151. }
  184152. if( p->rc==SQLITE_OK ){
  184153. sqlite3_bind_int(p->pIdxDeleter, 1, iSegid);
  184154. sqlite3_step(p->pIdxDeleter);
  184155. p->rc = sqlite3_reset(p->pIdxDeleter);
  184156. }
  184157. }
  184158. /*
  184159. ** Release a reference to an Fts5Structure object returned by an earlier
  184160. ** call to fts5StructureRead() or fts5StructureDecode().
  184161. */
  184162. static void fts5StructureRelease(Fts5Structure *pStruct){
  184163. if( pStruct && 0>=(--pStruct->nRef) ){
  184164. int i;
  184165. assert( pStruct->nRef==0 );
  184166. for(i=0; i<pStruct->nLevel; i++){
  184167. sqlite3_free(pStruct->aLevel[i].aSeg);
  184168. }
  184169. sqlite3_free(pStruct);
  184170. }
  184171. }
  184172. static void fts5StructureRef(Fts5Structure *pStruct){
  184173. pStruct->nRef++;
  184174. }
  184175. /*
  184176. ** Deserialize and return the structure record currently stored in serialized
  184177. ** form within buffer pData/nData.
  184178. **
  184179. ** The Fts5Structure.aLevel[] and each Fts5StructureLevel.aSeg[] array
  184180. ** are over-allocated by one slot. This allows the structure contents
  184181. ** to be more easily edited.
  184182. **
  184183. ** If an error occurs, *ppOut is set to NULL and an SQLite error code
  184184. ** returned. Otherwise, *ppOut is set to point to the new object and
  184185. ** SQLITE_OK returned.
  184186. */
  184187. static int fts5StructureDecode(
  184188. const u8 *pData, /* Buffer containing serialized structure */
  184189. int nData, /* Size of buffer pData in bytes */
  184190. int *piCookie, /* Configuration cookie value */
  184191. Fts5Structure **ppOut /* OUT: Deserialized object */
  184192. ){
  184193. int rc = SQLITE_OK;
  184194. int i = 0;
  184195. int iLvl;
  184196. int nLevel = 0;
  184197. int nSegment = 0;
  184198. int nByte; /* Bytes of space to allocate at pRet */
  184199. Fts5Structure *pRet = 0; /* Structure object to return */
  184200. /* Grab the cookie value */
  184201. if( piCookie ) *piCookie = sqlite3Fts5Get32(pData);
  184202. i = 4;
  184203. /* Read the total number of levels and segments from the start of the
  184204. ** structure record. */
  184205. i += fts5GetVarint32(&pData[i], nLevel);
  184206. i += fts5GetVarint32(&pData[i], nSegment);
  184207. nByte = (
  184208. sizeof(Fts5Structure) + /* Main structure */
  184209. sizeof(Fts5StructureLevel) * (nLevel-1) /* aLevel[] array */
  184210. );
  184211. pRet = (Fts5Structure*)sqlite3Fts5MallocZero(&rc, nByte);
  184212. if( pRet ){
  184213. pRet->nRef = 1;
  184214. pRet->nLevel = nLevel;
  184215. pRet->nSegment = nSegment;
  184216. i += sqlite3Fts5GetVarint(&pData[i], &pRet->nWriteCounter);
  184217. for(iLvl=0; rc==SQLITE_OK && iLvl<nLevel; iLvl++){
  184218. Fts5StructureLevel *pLvl = &pRet->aLevel[iLvl];
  184219. int nTotal = 0;
  184220. int iSeg;
  184221. if( i>=nData ){
  184222. rc = FTS5_CORRUPT;
  184223. }else{
  184224. i += fts5GetVarint32(&pData[i], pLvl->nMerge);
  184225. i += fts5GetVarint32(&pData[i], nTotal);
  184226. assert( nTotal>=pLvl->nMerge );
  184227. pLvl->aSeg = (Fts5StructureSegment*)sqlite3Fts5MallocZero(&rc,
  184228. nTotal * sizeof(Fts5StructureSegment)
  184229. );
  184230. }
  184231. if( rc==SQLITE_OK ){
  184232. pLvl->nSeg = nTotal;
  184233. for(iSeg=0; iSeg<nTotal; iSeg++){
  184234. if( i>=nData ){
  184235. rc = FTS5_CORRUPT;
  184236. break;
  184237. }
  184238. i += fts5GetVarint32(&pData[i], pLvl->aSeg[iSeg].iSegid);
  184239. i += fts5GetVarint32(&pData[i], pLvl->aSeg[iSeg].pgnoFirst);
  184240. i += fts5GetVarint32(&pData[i], pLvl->aSeg[iSeg].pgnoLast);
  184241. }
  184242. }
  184243. }
  184244. if( rc!=SQLITE_OK ){
  184245. fts5StructureRelease(pRet);
  184246. pRet = 0;
  184247. }
  184248. }
  184249. *ppOut = pRet;
  184250. return rc;
  184251. }
  184252. /*
  184253. **
  184254. */
  184255. static void fts5StructureAddLevel(int *pRc, Fts5Structure **ppStruct){
  184256. if( *pRc==SQLITE_OK ){
  184257. Fts5Structure *pStruct = *ppStruct;
  184258. int nLevel = pStruct->nLevel;
  184259. int nByte = (
  184260. sizeof(Fts5Structure) + /* Main structure */
  184261. sizeof(Fts5StructureLevel) * (nLevel+1) /* aLevel[] array */
  184262. );
  184263. pStruct = sqlite3_realloc(pStruct, nByte);
  184264. if( pStruct ){
  184265. memset(&pStruct->aLevel[nLevel], 0, sizeof(Fts5StructureLevel));
  184266. pStruct->nLevel++;
  184267. *ppStruct = pStruct;
  184268. }else{
  184269. *pRc = SQLITE_NOMEM;
  184270. }
  184271. }
  184272. }
  184273. /*
  184274. ** Extend level iLvl so that there is room for at least nExtra more
  184275. ** segments.
  184276. */
  184277. static void fts5StructureExtendLevel(
  184278. int *pRc,
  184279. Fts5Structure *pStruct,
  184280. int iLvl,
  184281. int nExtra,
  184282. int bInsert
  184283. ){
  184284. if( *pRc==SQLITE_OK ){
  184285. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  184286. Fts5StructureSegment *aNew;
  184287. int nByte;
  184288. nByte = (pLvl->nSeg + nExtra) * sizeof(Fts5StructureSegment);
  184289. aNew = sqlite3_realloc(pLvl->aSeg, nByte);
  184290. if( aNew ){
  184291. if( bInsert==0 ){
  184292. memset(&aNew[pLvl->nSeg], 0, sizeof(Fts5StructureSegment) * nExtra);
  184293. }else{
  184294. int nMove = pLvl->nSeg * sizeof(Fts5StructureSegment);
  184295. memmove(&aNew[nExtra], aNew, nMove);
  184296. memset(aNew, 0, sizeof(Fts5StructureSegment) * nExtra);
  184297. }
  184298. pLvl->aSeg = aNew;
  184299. }else{
  184300. *pRc = SQLITE_NOMEM;
  184301. }
  184302. }
  184303. }
  184304. static Fts5Structure *fts5StructureReadUncached(Fts5Index *p){
  184305. Fts5Structure *pRet = 0;
  184306. Fts5Config *pConfig = p->pConfig;
  184307. int iCookie; /* Configuration cookie */
  184308. Fts5Data *pData;
  184309. pData = fts5DataRead(p, FTS5_STRUCTURE_ROWID);
  184310. if( p->rc==SQLITE_OK ){
  184311. /* TODO: Do we need this if the leaf-index is appended? Probably... */
  184312. memset(&pData->p[pData->nn], 0, FTS5_DATA_PADDING);
  184313. p->rc = fts5StructureDecode(pData->p, pData->nn, &iCookie, &pRet);
  184314. if( p->rc==SQLITE_OK && pConfig->iCookie!=iCookie ){
  184315. p->rc = sqlite3Fts5ConfigLoad(pConfig, iCookie);
  184316. }
  184317. fts5DataRelease(pData);
  184318. if( p->rc!=SQLITE_OK ){
  184319. fts5StructureRelease(pRet);
  184320. pRet = 0;
  184321. }
  184322. }
  184323. return pRet;
  184324. }
  184325. static i64 fts5IndexDataVersion(Fts5Index *p){
  184326. i64 iVersion = 0;
  184327. if( p->rc==SQLITE_OK ){
  184328. if( p->pDataVersion==0 ){
  184329. p->rc = fts5IndexPrepareStmt(p, &p->pDataVersion,
  184330. sqlite3_mprintf("PRAGMA %Q.data_version", p->pConfig->zDb)
  184331. );
  184332. if( p->rc ) return 0;
  184333. }
  184334. if( SQLITE_ROW==sqlite3_step(p->pDataVersion) ){
  184335. iVersion = sqlite3_column_int64(p->pDataVersion, 0);
  184336. }
  184337. p->rc = sqlite3_reset(p->pDataVersion);
  184338. }
  184339. return iVersion;
  184340. }
  184341. /*
  184342. ** Read, deserialize and return the structure record.
  184343. **
  184344. ** The Fts5Structure.aLevel[] and each Fts5StructureLevel.aSeg[] array
  184345. ** are over-allocated as described for function fts5StructureDecode()
  184346. ** above.
  184347. **
  184348. ** If an error occurs, NULL is returned and an error code left in the
  184349. ** Fts5Index handle. If an error has already occurred when this function
  184350. ** is called, it is a no-op.
  184351. */
  184352. static Fts5Structure *fts5StructureRead(Fts5Index *p){
  184353. if( p->pStruct==0 ){
  184354. p->iStructVersion = fts5IndexDataVersion(p);
  184355. if( p->rc==SQLITE_OK ){
  184356. p->pStruct = fts5StructureReadUncached(p);
  184357. }
  184358. }
  184359. #if 0
  184360. else{
  184361. Fts5Structure *pTest = fts5StructureReadUncached(p);
  184362. if( pTest ){
  184363. int i, j;
  184364. assert_nc( p->pStruct->nSegment==pTest->nSegment );
  184365. assert_nc( p->pStruct->nLevel==pTest->nLevel );
  184366. for(i=0; i<pTest->nLevel; i++){
  184367. assert_nc( p->pStruct->aLevel[i].nMerge==pTest->aLevel[i].nMerge );
  184368. assert_nc( p->pStruct->aLevel[i].nSeg==pTest->aLevel[i].nSeg );
  184369. for(j=0; j<pTest->aLevel[i].nSeg; j++){
  184370. Fts5StructureSegment *p1 = &pTest->aLevel[i].aSeg[j];
  184371. Fts5StructureSegment *p2 = &p->pStruct->aLevel[i].aSeg[j];
  184372. assert_nc( p1->iSegid==p2->iSegid );
  184373. assert_nc( p1->pgnoFirst==p2->pgnoFirst );
  184374. assert_nc( p1->pgnoLast==p2->pgnoLast );
  184375. }
  184376. }
  184377. fts5StructureRelease(pTest);
  184378. }
  184379. }
  184380. #endif
  184381. if( p->rc!=SQLITE_OK ) return 0;
  184382. assert( p->iStructVersion!=0 );
  184383. assert( p->pStruct!=0 );
  184384. fts5StructureRef(p->pStruct);
  184385. return p->pStruct;
  184386. }
  184387. static void fts5StructureInvalidate(Fts5Index *p){
  184388. if( p->pStruct ){
  184389. fts5StructureRelease(p->pStruct);
  184390. p->pStruct = 0;
  184391. }
  184392. }
  184393. /*
  184394. ** Return the total number of segments in index structure pStruct. This
  184395. ** function is only ever used as part of assert() conditions.
  184396. */
  184397. #ifdef SQLITE_DEBUG
  184398. static int fts5StructureCountSegments(Fts5Structure *pStruct){
  184399. int nSegment = 0; /* Total number of segments */
  184400. if( pStruct ){
  184401. int iLvl; /* Used to iterate through levels */
  184402. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  184403. nSegment += pStruct->aLevel[iLvl].nSeg;
  184404. }
  184405. }
  184406. return nSegment;
  184407. }
  184408. #endif
  184409. #define fts5BufferSafeAppendBlob(pBuf, pBlob, nBlob) { \
  184410. assert( (pBuf)->nSpace>=((pBuf)->n+nBlob) ); \
  184411. memcpy(&(pBuf)->p[(pBuf)->n], pBlob, nBlob); \
  184412. (pBuf)->n += nBlob; \
  184413. }
  184414. #define fts5BufferSafeAppendVarint(pBuf, iVal) { \
  184415. (pBuf)->n += sqlite3Fts5PutVarint(&(pBuf)->p[(pBuf)->n], (iVal)); \
  184416. assert( (pBuf)->nSpace>=(pBuf)->n ); \
  184417. }
  184418. /*
  184419. ** Serialize and store the "structure" record.
  184420. **
  184421. ** If an error occurs, leave an error code in the Fts5Index object. If an
  184422. ** error has already occurred, this function is a no-op.
  184423. */
  184424. static void fts5StructureWrite(Fts5Index *p, Fts5Structure *pStruct){
  184425. if( p->rc==SQLITE_OK ){
  184426. Fts5Buffer buf; /* Buffer to serialize record into */
  184427. int iLvl; /* Used to iterate through levels */
  184428. int iCookie; /* Cookie value to store */
  184429. assert( pStruct->nSegment==fts5StructureCountSegments(pStruct) );
  184430. memset(&buf, 0, sizeof(Fts5Buffer));
  184431. /* Append the current configuration cookie */
  184432. iCookie = p->pConfig->iCookie;
  184433. if( iCookie<0 ) iCookie = 0;
  184434. if( 0==sqlite3Fts5BufferSize(&p->rc, &buf, 4+9+9+9) ){
  184435. sqlite3Fts5Put32(buf.p, iCookie);
  184436. buf.n = 4;
  184437. fts5BufferSafeAppendVarint(&buf, pStruct->nLevel);
  184438. fts5BufferSafeAppendVarint(&buf, pStruct->nSegment);
  184439. fts5BufferSafeAppendVarint(&buf, (i64)pStruct->nWriteCounter);
  184440. }
  184441. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  184442. int iSeg; /* Used to iterate through segments */
  184443. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  184444. fts5BufferAppendVarint(&p->rc, &buf, pLvl->nMerge);
  184445. fts5BufferAppendVarint(&p->rc, &buf, pLvl->nSeg);
  184446. assert( pLvl->nMerge<=pLvl->nSeg );
  184447. for(iSeg=0; iSeg<pLvl->nSeg; iSeg++){
  184448. fts5BufferAppendVarint(&p->rc, &buf, pLvl->aSeg[iSeg].iSegid);
  184449. fts5BufferAppendVarint(&p->rc, &buf, pLvl->aSeg[iSeg].pgnoFirst);
  184450. fts5BufferAppendVarint(&p->rc, &buf, pLvl->aSeg[iSeg].pgnoLast);
  184451. }
  184452. }
  184453. fts5DataWrite(p, FTS5_STRUCTURE_ROWID, buf.p, buf.n);
  184454. fts5BufferFree(&buf);
  184455. }
  184456. }
  184457. #if 0
  184458. static void fts5DebugStructure(int*,Fts5Buffer*,Fts5Structure*);
  184459. static void fts5PrintStructure(const char *zCaption, Fts5Structure *pStruct){
  184460. int rc = SQLITE_OK;
  184461. Fts5Buffer buf;
  184462. memset(&buf, 0, sizeof(buf));
  184463. fts5DebugStructure(&rc, &buf, pStruct);
  184464. fprintf(stdout, "%s: %s\n", zCaption, buf.p);
  184465. fflush(stdout);
  184466. fts5BufferFree(&buf);
  184467. }
  184468. #else
  184469. # define fts5PrintStructure(x,y)
  184470. #endif
  184471. static int fts5SegmentSize(Fts5StructureSegment *pSeg){
  184472. return 1 + pSeg->pgnoLast - pSeg->pgnoFirst;
  184473. }
  184474. /*
  184475. ** Return a copy of index structure pStruct. Except, promote as many
  184476. ** segments as possible to level iPromote. If an OOM occurs, NULL is
  184477. ** returned.
  184478. */
  184479. static void fts5StructurePromoteTo(
  184480. Fts5Index *p,
  184481. int iPromote,
  184482. int szPromote,
  184483. Fts5Structure *pStruct
  184484. ){
  184485. int il, is;
  184486. Fts5StructureLevel *pOut = &pStruct->aLevel[iPromote];
  184487. if( pOut->nMerge==0 ){
  184488. for(il=iPromote+1; il<pStruct->nLevel; il++){
  184489. Fts5StructureLevel *pLvl = &pStruct->aLevel[il];
  184490. if( pLvl->nMerge ) return;
  184491. for(is=pLvl->nSeg-1; is>=0; is--){
  184492. int sz = fts5SegmentSize(&pLvl->aSeg[is]);
  184493. if( sz>szPromote ) return;
  184494. fts5StructureExtendLevel(&p->rc, pStruct, iPromote, 1, 1);
  184495. if( p->rc ) return;
  184496. memcpy(pOut->aSeg, &pLvl->aSeg[is], sizeof(Fts5StructureSegment));
  184497. pOut->nSeg++;
  184498. pLvl->nSeg--;
  184499. }
  184500. }
  184501. }
  184502. }
  184503. /*
  184504. ** A new segment has just been written to level iLvl of index structure
  184505. ** pStruct. This function determines if any segments should be promoted
  184506. ** as a result. Segments are promoted in two scenarios:
  184507. **
  184508. ** a) If the segment just written is smaller than one or more segments
  184509. ** within the previous populated level, it is promoted to the previous
  184510. ** populated level.
  184511. **
  184512. ** b) If the segment just written is larger than the newest segment on
  184513. ** the next populated level, then that segment, and any other adjacent
  184514. ** segments that are also smaller than the one just written, are
  184515. ** promoted.
  184516. **
  184517. ** If one or more segments are promoted, the structure object is updated
  184518. ** to reflect this.
  184519. */
  184520. static void fts5StructurePromote(
  184521. Fts5Index *p, /* FTS5 backend object */
  184522. int iLvl, /* Index level just updated */
  184523. Fts5Structure *pStruct /* Index structure */
  184524. ){
  184525. if( p->rc==SQLITE_OK ){
  184526. int iTst;
  184527. int iPromote = -1;
  184528. int szPromote = 0; /* Promote anything this size or smaller */
  184529. Fts5StructureSegment *pSeg; /* Segment just written */
  184530. int szSeg; /* Size of segment just written */
  184531. int nSeg = pStruct->aLevel[iLvl].nSeg;
  184532. if( nSeg==0 ) return;
  184533. pSeg = &pStruct->aLevel[iLvl].aSeg[pStruct->aLevel[iLvl].nSeg-1];
  184534. szSeg = (1 + pSeg->pgnoLast - pSeg->pgnoFirst);
  184535. /* Check for condition (a) */
  184536. for(iTst=iLvl-1; iTst>=0 && pStruct->aLevel[iTst].nSeg==0; iTst--);
  184537. if( iTst>=0 ){
  184538. int i;
  184539. int szMax = 0;
  184540. Fts5StructureLevel *pTst = &pStruct->aLevel[iTst];
  184541. assert( pTst->nMerge==0 );
  184542. for(i=0; i<pTst->nSeg; i++){
  184543. int sz = pTst->aSeg[i].pgnoLast - pTst->aSeg[i].pgnoFirst + 1;
  184544. if( sz>szMax ) szMax = sz;
  184545. }
  184546. if( szMax>=szSeg ){
  184547. /* Condition (a) is true. Promote the newest segment on level
  184548. ** iLvl to level iTst. */
  184549. iPromote = iTst;
  184550. szPromote = szMax;
  184551. }
  184552. }
  184553. /* If condition (a) is not met, assume (b) is true. StructurePromoteTo()
  184554. ** is a no-op if it is not. */
  184555. if( iPromote<0 ){
  184556. iPromote = iLvl;
  184557. szPromote = szSeg;
  184558. }
  184559. fts5StructurePromoteTo(p, iPromote, szPromote, pStruct);
  184560. }
  184561. }
  184562. /*
  184563. ** Advance the iterator passed as the only argument. If the end of the
  184564. ** doclist-index page is reached, return non-zero.
  184565. */
  184566. static int fts5DlidxLvlNext(Fts5DlidxLvl *pLvl){
  184567. Fts5Data *pData = pLvl->pData;
  184568. if( pLvl->iOff==0 ){
  184569. assert( pLvl->bEof==0 );
  184570. pLvl->iOff = 1;
  184571. pLvl->iOff += fts5GetVarint32(&pData->p[1], pLvl->iLeafPgno);
  184572. pLvl->iOff += fts5GetVarint(&pData->p[pLvl->iOff], (u64*)&pLvl->iRowid);
  184573. pLvl->iFirstOff = pLvl->iOff;
  184574. }else{
  184575. int iOff;
  184576. for(iOff=pLvl->iOff; iOff<pData->nn; iOff++){
  184577. if( pData->p[iOff] ) break;
  184578. }
  184579. if( iOff<pData->nn ){
  184580. i64 iVal;
  184581. pLvl->iLeafPgno += (iOff - pLvl->iOff) + 1;
  184582. iOff += fts5GetVarint(&pData->p[iOff], (u64*)&iVal);
  184583. pLvl->iRowid += iVal;
  184584. pLvl->iOff = iOff;
  184585. }else{
  184586. pLvl->bEof = 1;
  184587. }
  184588. }
  184589. return pLvl->bEof;
  184590. }
  184591. /*
  184592. ** Advance the iterator passed as the only argument.
  184593. */
  184594. static int fts5DlidxIterNextR(Fts5Index *p, Fts5DlidxIter *pIter, int iLvl){
  184595. Fts5DlidxLvl *pLvl = &pIter->aLvl[iLvl];
  184596. assert( iLvl<pIter->nLvl );
  184597. if( fts5DlidxLvlNext(pLvl) ){
  184598. if( (iLvl+1) < pIter->nLvl ){
  184599. fts5DlidxIterNextR(p, pIter, iLvl+1);
  184600. if( pLvl[1].bEof==0 ){
  184601. fts5DataRelease(pLvl->pData);
  184602. memset(pLvl, 0, sizeof(Fts5DlidxLvl));
  184603. pLvl->pData = fts5DataRead(p,
  184604. FTS5_DLIDX_ROWID(pIter->iSegid, iLvl, pLvl[1].iLeafPgno)
  184605. );
  184606. if( pLvl->pData ) fts5DlidxLvlNext(pLvl);
  184607. }
  184608. }
  184609. }
  184610. return pIter->aLvl[0].bEof;
  184611. }
  184612. static int fts5DlidxIterNext(Fts5Index *p, Fts5DlidxIter *pIter){
  184613. return fts5DlidxIterNextR(p, pIter, 0);
  184614. }
  184615. /*
  184616. ** The iterator passed as the first argument has the following fields set
  184617. ** as follows. This function sets up the rest of the iterator so that it
  184618. ** points to the first rowid in the doclist-index.
  184619. **
  184620. ** pData:
  184621. ** pointer to doclist-index record,
  184622. **
  184623. ** When this function is called pIter->iLeafPgno is the page number the
  184624. ** doclist is associated with (the one featuring the term).
  184625. */
  184626. static int fts5DlidxIterFirst(Fts5DlidxIter *pIter){
  184627. int i;
  184628. for(i=0; i<pIter->nLvl; i++){
  184629. fts5DlidxLvlNext(&pIter->aLvl[i]);
  184630. }
  184631. return pIter->aLvl[0].bEof;
  184632. }
  184633. static int fts5DlidxIterEof(Fts5Index *p, Fts5DlidxIter *pIter){
  184634. return p->rc!=SQLITE_OK || pIter->aLvl[0].bEof;
  184635. }
  184636. static void fts5DlidxIterLast(Fts5Index *p, Fts5DlidxIter *pIter){
  184637. int i;
  184638. /* Advance each level to the last entry on the last page */
  184639. for(i=pIter->nLvl-1; p->rc==SQLITE_OK && i>=0; i--){
  184640. Fts5DlidxLvl *pLvl = &pIter->aLvl[i];
  184641. while( fts5DlidxLvlNext(pLvl)==0 );
  184642. pLvl->bEof = 0;
  184643. if( i>0 ){
  184644. Fts5DlidxLvl *pChild = &pLvl[-1];
  184645. fts5DataRelease(pChild->pData);
  184646. memset(pChild, 0, sizeof(Fts5DlidxLvl));
  184647. pChild->pData = fts5DataRead(p,
  184648. FTS5_DLIDX_ROWID(pIter->iSegid, i-1, pLvl->iLeafPgno)
  184649. );
  184650. }
  184651. }
  184652. }
  184653. /*
  184654. ** Move the iterator passed as the only argument to the previous entry.
  184655. */
  184656. static int fts5DlidxLvlPrev(Fts5DlidxLvl *pLvl){
  184657. int iOff = pLvl->iOff;
  184658. assert( pLvl->bEof==0 );
  184659. if( iOff<=pLvl->iFirstOff ){
  184660. pLvl->bEof = 1;
  184661. }else{
  184662. u8 *a = pLvl->pData->p;
  184663. i64 iVal;
  184664. int iLimit;
  184665. int ii;
  184666. int nZero = 0;
  184667. /* Currently iOff points to the first byte of a varint. This block
  184668. ** decrements iOff until it points to the first byte of the previous
  184669. ** varint. Taking care not to read any memory locations that occur
  184670. ** before the buffer in memory. */
  184671. iLimit = (iOff>9 ? iOff-9 : 0);
  184672. for(iOff--; iOff>iLimit; iOff--){
  184673. if( (a[iOff-1] & 0x80)==0 ) break;
  184674. }
  184675. fts5GetVarint(&a[iOff], (u64*)&iVal);
  184676. pLvl->iRowid -= iVal;
  184677. pLvl->iLeafPgno--;
  184678. /* Skip backwards past any 0x00 varints. */
  184679. for(ii=iOff-1; ii>=pLvl->iFirstOff && a[ii]==0x00; ii--){
  184680. nZero++;
  184681. }
  184682. if( ii>=pLvl->iFirstOff && (a[ii] & 0x80) ){
  184683. /* The byte immediately before the last 0x00 byte has the 0x80 bit
  184684. ** set. So the last 0x00 is only a varint 0 if there are 8 more 0x80
  184685. ** bytes before a[ii]. */
  184686. int bZero = 0; /* True if last 0x00 counts */
  184687. if( (ii-8)>=pLvl->iFirstOff ){
  184688. int j;
  184689. for(j=1; j<=8 && (a[ii-j] & 0x80); j++);
  184690. bZero = (j>8);
  184691. }
  184692. if( bZero==0 ) nZero--;
  184693. }
  184694. pLvl->iLeafPgno -= nZero;
  184695. pLvl->iOff = iOff - nZero;
  184696. }
  184697. return pLvl->bEof;
  184698. }
  184699. static int fts5DlidxIterPrevR(Fts5Index *p, Fts5DlidxIter *pIter, int iLvl){
  184700. Fts5DlidxLvl *pLvl = &pIter->aLvl[iLvl];
  184701. assert( iLvl<pIter->nLvl );
  184702. if( fts5DlidxLvlPrev(pLvl) ){
  184703. if( (iLvl+1) < pIter->nLvl ){
  184704. fts5DlidxIterPrevR(p, pIter, iLvl+1);
  184705. if( pLvl[1].bEof==0 ){
  184706. fts5DataRelease(pLvl->pData);
  184707. memset(pLvl, 0, sizeof(Fts5DlidxLvl));
  184708. pLvl->pData = fts5DataRead(p,
  184709. FTS5_DLIDX_ROWID(pIter->iSegid, iLvl, pLvl[1].iLeafPgno)
  184710. );
  184711. if( pLvl->pData ){
  184712. while( fts5DlidxLvlNext(pLvl)==0 );
  184713. pLvl->bEof = 0;
  184714. }
  184715. }
  184716. }
  184717. }
  184718. return pIter->aLvl[0].bEof;
  184719. }
  184720. static int fts5DlidxIterPrev(Fts5Index *p, Fts5DlidxIter *pIter){
  184721. return fts5DlidxIterPrevR(p, pIter, 0);
  184722. }
  184723. /*
  184724. ** Free a doclist-index iterator object allocated by fts5DlidxIterInit().
  184725. */
  184726. static void fts5DlidxIterFree(Fts5DlidxIter *pIter){
  184727. if( pIter ){
  184728. int i;
  184729. for(i=0; i<pIter->nLvl; i++){
  184730. fts5DataRelease(pIter->aLvl[i].pData);
  184731. }
  184732. sqlite3_free(pIter);
  184733. }
  184734. }
  184735. static Fts5DlidxIter *fts5DlidxIterInit(
  184736. Fts5Index *p, /* Fts5 Backend to iterate within */
  184737. int bRev, /* True for ORDER BY ASC */
  184738. int iSegid, /* Segment id */
  184739. int iLeafPg /* Leaf page number to load dlidx for */
  184740. ){
  184741. Fts5DlidxIter *pIter = 0;
  184742. int i;
  184743. int bDone = 0;
  184744. for(i=0; p->rc==SQLITE_OK && bDone==0; i++){
  184745. int nByte = sizeof(Fts5DlidxIter) + i * sizeof(Fts5DlidxLvl);
  184746. Fts5DlidxIter *pNew;
  184747. pNew = (Fts5DlidxIter*)sqlite3_realloc(pIter, nByte);
  184748. if( pNew==0 ){
  184749. p->rc = SQLITE_NOMEM;
  184750. }else{
  184751. i64 iRowid = FTS5_DLIDX_ROWID(iSegid, i, iLeafPg);
  184752. Fts5DlidxLvl *pLvl = &pNew->aLvl[i];
  184753. pIter = pNew;
  184754. memset(pLvl, 0, sizeof(Fts5DlidxLvl));
  184755. pLvl->pData = fts5DataRead(p, iRowid);
  184756. if( pLvl->pData && (pLvl->pData->p[0] & 0x0001)==0 ){
  184757. bDone = 1;
  184758. }
  184759. pIter->nLvl = i+1;
  184760. }
  184761. }
  184762. if( p->rc==SQLITE_OK ){
  184763. pIter->iSegid = iSegid;
  184764. if( bRev==0 ){
  184765. fts5DlidxIterFirst(pIter);
  184766. }else{
  184767. fts5DlidxIterLast(p, pIter);
  184768. }
  184769. }
  184770. if( p->rc!=SQLITE_OK ){
  184771. fts5DlidxIterFree(pIter);
  184772. pIter = 0;
  184773. }
  184774. return pIter;
  184775. }
  184776. static i64 fts5DlidxIterRowid(Fts5DlidxIter *pIter){
  184777. return pIter->aLvl[0].iRowid;
  184778. }
  184779. static int fts5DlidxIterPgno(Fts5DlidxIter *pIter){
  184780. return pIter->aLvl[0].iLeafPgno;
  184781. }
  184782. /*
  184783. ** Load the next leaf page into the segment iterator.
  184784. */
  184785. static void fts5SegIterNextPage(
  184786. Fts5Index *p, /* FTS5 backend object */
  184787. Fts5SegIter *pIter /* Iterator to advance to next page */
  184788. ){
  184789. Fts5Data *pLeaf;
  184790. Fts5StructureSegment *pSeg = pIter->pSeg;
  184791. fts5DataRelease(pIter->pLeaf);
  184792. pIter->iLeafPgno++;
  184793. if( pIter->pNextLeaf ){
  184794. pIter->pLeaf = pIter->pNextLeaf;
  184795. pIter->pNextLeaf = 0;
  184796. }else if( pIter->iLeafPgno<=pSeg->pgnoLast ){
  184797. pIter->pLeaf = fts5LeafRead(p,
  184798. FTS5_SEGMENT_ROWID(pSeg->iSegid, pIter->iLeafPgno)
  184799. );
  184800. }else{
  184801. pIter->pLeaf = 0;
  184802. }
  184803. pLeaf = pIter->pLeaf;
  184804. if( pLeaf ){
  184805. pIter->iPgidxOff = pLeaf->szLeaf;
  184806. if( fts5LeafIsTermless(pLeaf) ){
  184807. pIter->iEndofDoclist = pLeaf->nn+1;
  184808. }else{
  184809. pIter->iPgidxOff += fts5GetVarint32(&pLeaf->p[pIter->iPgidxOff],
  184810. pIter->iEndofDoclist
  184811. );
  184812. }
  184813. }
  184814. }
  184815. /*
  184816. ** Argument p points to a buffer containing a varint to be interpreted as a
  184817. ** position list size field. Read the varint and return the number of bytes
  184818. ** read. Before returning, set *pnSz to the number of bytes in the position
  184819. ** list, and *pbDel to true if the delete flag is set, or false otherwise.
  184820. */
  184821. static int fts5GetPoslistSize(const u8 *p, int *pnSz, int *pbDel){
  184822. int nSz;
  184823. int n = 0;
  184824. fts5FastGetVarint32(p, n, nSz);
  184825. assert_nc( nSz>=0 );
  184826. *pnSz = nSz/2;
  184827. *pbDel = nSz & 0x0001;
  184828. return n;
  184829. }
  184830. /*
  184831. ** Fts5SegIter.iLeafOffset currently points to the first byte of a
  184832. ** position-list size field. Read the value of the field and store it
  184833. ** in the following variables:
  184834. **
  184835. ** Fts5SegIter.nPos
  184836. ** Fts5SegIter.bDel
  184837. **
  184838. ** Leave Fts5SegIter.iLeafOffset pointing to the first byte of the
  184839. ** position list content (if any).
  184840. */
  184841. static void fts5SegIterLoadNPos(Fts5Index *p, Fts5SegIter *pIter){
  184842. if( p->rc==SQLITE_OK ){
  184843. int iOff = pIter->iLeafOffset; /* Offset to read at */
  184844. ASSERT_SZLEAF_OK(pIter->pLeaf);
  184845. if( p->pConfig->eDetail==FTS5_DETAIL_NONE ){
  184846. int iEod = MIN(pIter->iEndofDoclist, pIter->pLeaf->szLeaf);
  184847. pIter->bDel = 0;
  184848. pIter->nPos = 1;
  184849. if( iOff<iEod && pIter->pLeaf->p[iOff]==0 ){
  184850. pIter->bDel = 1;
  184851. iOff++;
  184852. if( iOff<iEod && pIter->pLeaf->p[iOff]==0 ){
  184853. pIter->nPos = 1;
  184854. iOff++;
  184855. }else{
  184856. pIter->nPos = 0;
  184857. }
  184858. }
  184859. }else{
  184860. int nSz;
  184861. fts5FastGetVarint32(pIter->pLeaf->p, iOff, nSz);
  184862. pIter->bDel = (nSz & 0x0001);
  184863. pIter->nPos = nSz>>1;
  184864. assert_nc( pIter->nPos>=0 );
  184865. }
  184866. pIter->iLeafOffset = iOff;
  184867. }
  184868. }
  184869. static void fts5SegIterLoadRowid(Fts5Index *p, Fts5SegIter *pIter){
  184870. u8 *a = pIter->pLeaf->p; /* Buffer to read data from */
  184871. int iOff = pIter->iLeafOffset;
  184872. ASSERT_SZLEAF_OK(pIter->pLeaf);
  184873. if( iOff>=pIter->pLeaf->szLeaf ){
  184874. fts5SegIterNextPage(p, pIter);
  184875. if( pIter->pLeaf==0 ){
  184876. if( p->rc==SQLITE_OK ) p->rc = FTS5_CORRUPT;
  184877. return;
  184878. }
  184879. iOff = 4;
  184880. a = pIter->pLeaf->p;
  184881. }
  184882. iOff += sqlite3Fts5GetVarint(&a[iOff], (u64*)&pIter->iRowid);
  184883. pIter->iLeafOffset = iOff;
  184884. }
  184885. /*
  184886. ** Fts5SegIter.iLeafOffset currently points to the first byte of the
  184887. ** "nSuffix" field of a term. Function parameter nKeep contains the value
  184888. ** of the "nPrefix" field (if there was one - it is passed 0 if this is
  184889. ** the first term in the segment).
  184890. **
  184891. ** This function populates:
  184892. **
  184893. ** Fts5SegIter.term
  184894. ** Fts5SegIter.rowid
  184895. **
  184896. ** accordingly and leaves (Fts5SegIter.iLeafOffset) set to the content of
  184897. ** the first position list. The position list belonging to document
  184898. ** (Fts5SegIter.iRowid).
  184899. */
  184900. static void fts5SegIterLoadTerm(Fts5Index *p, Fts5SegIter *pIter, int nKeep){
  184901. u8 *a = pIter->pLeaf->p; /* Buffer to read data from */
  184902. int iOff = pIter->iLeafOffset; /* Offset to read at */
  184903. int nNew; /* Bytes of new data */
  184904. iOff += fts5GetVarint32(&a[iOff], nNew);
  184905. if( iOff+nNew>pIter->pLeaf->nn ){
  184906. p->rc = FTS5_CORRUPT;
  184907. return;
  184908. }
  184909. pIter->term.n = nKeep;
  184910. fts5BufferAppendBlob(&p->rc, &pIter->term, nNew, &a[iOff]);
  184911. iOff += nNew;
  184912. pIter->iTermLeafOffset = iOff;
  184913. pIter->iTermLeafPgno = pIter->iLeafPgno;
  184914. pIter->iLeafOffset = iOff;
  184915. if( pIter->iPgidxOff>=pIter->pLeaf->nn ){
  184916. pIter->iEndofDoclist = pIter->pLeaf->nn+1;
  184917. }else{
  184918. int nExtra;
  184919. pIter->iPgidxOff += fts5GetVarint32(&a[pIter->iPgidxOff], nExtra);
  184920. pIter->iEndofDoclist += nExtra;
  184921. }
  184922. fts5SegIterLoadRowid(p, pIter);
  184923. }
  184924. static void fts5SegIterNext(Fts5Index*, Fts5SegIter*, int*);
  184925. static void fts5SegIterNext_Reverse(Fts5Index*, Fts5SegIter*, int*);
  184926. static void fts5SegIterNext_None(Fts5Index*, Fts5SegIter*, int*);
  184927. static void fts5SegIterSetNext(Fts5Index *p, Fts5SegIter *pIter){
  184928. if( pIter->flags & FTS5_SEGITER_REVERSE ){
  184929. pIter->xNext = fts5SegIterNext_Reverse;
  184930. }else if( p->pConfig->eDetail==FTS5_DETAIL_NONE ){
  184931. pIter->xNext = fts5SegIterNext_None;
  184932. }else{
  184933. pIter->xNext = fts5SegIterNext;
  184934. }
  184935. }
  184936. /*
  184937. ** Initialize the iterator object pIter to iterate through the entries in
  184938. ** segment pSeg. The iterator is left pointing to the first entry when
  184939. ** this function returns.
  184940. **
  184941. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. If
  184942. ** an error has already occurred when this function is called, it is a no-op.
  184943. */
  184944. static void fts5SegIterInit(
  184945. Fts5Index *p, /* FTS index object */
  184946. Fts5StructureSegment *pSeg, /* Description of segment */
  184947. Fts5SegIter *pIter /* Object to populate */
  184948. ){
  184949. if( pSeg->pgnoFirst==0 ){
  184950. /* This happens if the segment is being used as an input to an incremental
  184951. ** merge and all data has already been "trimmed". See function
  184952. ** fts5TrimSegments() for details. In this case leave the iterator empty.
  184953. ** The caller will see the (pIter->pLeaf==0) and assume the iterator is
  184954. ** at EOF already. */
  184955. assert( pIter->pLeaf==0 );
  184956. return;
  184957. }
  184958. if( p->rc==SQLITE_OK ){
  184959. memset(pIter, 0, sizeof(*pIter));
  184960. fts5SegIterSetNext(p, pIter);
  184961. pIter->pSeg = pSeg;
  184962. pIter->iLeafPgno = pSeg->pgnoFirst-1;
  184963. fts5SegIterNextPage(p, pIter);
  184964. }
  184965. if( p->rc==SQLITE_OK ){
  184966. pIter->iLeafOffset = 4;
  184967. assert_nc( pIter->pLeaf->nn>4 );
  184968. assert( fts5LeafFirstTermOff(pIter->pLeaf)==4 );
  184969. pIter->iPgidxOff = pIter->pLeaf->szLeaf+1;
  184970. fts5SegIterLoadTerm(p, pIter, 0);
  184971. fts5SegIterLoadNPos(p, pIter);
  184972. }
  184973. }
  184974. /*
  184975. ** This function is only ever called on iterators created by calls to
  184976. ** Fts5IndexQuery() with the FTS5INDEX_QUERY_DESC flag set.
  184977. **
  184978. ** The iterator is in an unusual state when this function is called: the
  184979. ** Fts5SegIter.iLeafOffset variable is set to the offset of the start of
  184980. ** the position-list size field for the first relevant rowid on the page.
  184981. ** Fts5SegIter.rowid is set, but nPos and bDel are not.
  184982. **
  184983. ** This function advances the iterator so that it points to the last
  184984. ** relevant rowid on the page and, if necessary, initializes the
  184985. ** aRowidOffset[] and iRowidOffset variables. At this point the iterator
  184986. ** is in its regular state - Fts5SegIter.iLeafOffset points to the first
  184987. ** byte of the position list content associated with said rowid.
  184988. */
  184989. static void fts5SegIterReverseInitPage(Fts5Index *p, Fts5SegIter *pIter){
  184990. int eDetail = p->pConfig->eDetail;
  184991. int n = pIter->pLeaf->szLeaf;
  184992. int i = pIter->iLeafOffset;
  184993. u8 *a = pIter->pLeaf->p;
  184994. int iRowidOffset = 0;
  184995. if( n>pIter->iEndofDoclist ){
  184996. n = pIter->iEndofDoclist;
  184997. }
  184998. ASSERT_SZLEAF_OK(pIter->pLeaf);
  184999. while( 1 ){
  185000. i64 iDelta = 0;
  185001. if( eDetail==FTS5_DETAIL_NONE ){
  185002. /* todo */
  185003. if( i<n && a[i]==0 ){
  185004. i++;
  185005. if( i<n && a[i]==0 ) i++;
  185006. }
  185007. }else{
  185008. int nPos;
  185009. int bDummy;
  185010. i += fts5GetPoslistSize(&a[i], &nPos, &bDummy);
  185011. i += nPos;
  185012. }
  185013. if( i>=n ) break;
  185014. i += fts5GetVarint(&a[i], (u64*)&iDelta);
  185015. pIter->iRowid += iDelta;
  185016. /* If necessary, grow the pIter->aRowidOffset[] array. */
  185017. if( iRowidOffset>=pIter->nRowidOffset ){
  185018. int nNew = pIter->nRowidOffset + 8;
  185019. int *aNew = (int*)sqlite3_realloc(pIter->aRowidOffset, nNew*sizeof(int));
  185020. if( aNew==0 ){
  185021. p->rc = SQLITE_NOMEM;
  185022. break;
  185023. }
  185024. pIter->aRowidOffset = aNew;
  185025. pIter->nRowidOffset = nNew;
  185026. }
  185027. pIter->aRowidOffset[iRowidOffset++] = pIter->iLeafOffset;
  185028. pIter->iLeafOffset = i;
  185029. }
  185030. pIter->iRowidOffset = iRowidOffset;
  185031. fts5SegIterLoadNPos(p, pIter);
  185032. }
  185033. /*
  185034. **
  185035. */
  185036. static void fts5SegIterReverseNewPage(Fts5Index *p, Fts5SegIter *pIter){
  185037. assert( pIter->flags & FTS5_SEGITER_REVERSE );
  185038. assert( pIter->flags & FTS5_SEGITER_ONETERM );
  185039. fts5DataRelease(pIter->pLeaf);
  185040. pIter->pLeaf = 0;
  185041. while( p->rc==SQLITE_OK && pIter->iLeafPgno>pIter->iTermLeafPgno ){
  185042. Fts5Data *pNew;
  185043. pIter->iLeafPgno--;
  185044. pNew = fts5DataRead(p, FTS5_SEGMENT_ROWID(
  185045. pIter->pSeg->iSegid, pIter->iLeafPgno
  185046. ));
  185047. if( pNew ){
  185048. /* iTermLeafOffset may be equal to szLeaf if the term is the last
  185049. ** thing on the page - i.e. the first rowid is on the following page.
  185050. ** In this case leave pIter->pLeaf==0, this iterator is at EOF. */
  185051. if( pIter->iLeafPgno==pIter->iTermLeafPgno ){
  185052. assert( pIter->pLeaf==0 );
  185053. if( pIter->iTermLeafOffset<pNew->szLeaf ){
  185054. pIter->pLeaf = pNew;
  185055. pIter->iLeafOffset = pIter->iTermLeafOffset;
  185056. }
  185057. }else{
  185058. int iRowidOff;
  185059. iRowidOff = fts5LeafFirstRowidOff(pNew);
  185060. if( iRowidOff ){
  185061. pIter->pLeaf = pNew;
  185062. pIter->iLeafOffset = iRowidOff;
  185063. }
  185064. }
  185065. if( pIter->pLeaf ){
  185066. u8 *a = &pIter->pLeaf->p[pIter->iLeafOffset];
  185067. pIter->iLeafOffset += fts5GetVarint(a, (u64*)&pIter->iRowid);
  185068. break;
  185069. }else{
  185070. fts5DataRelease(pNew);
  185071. }
  185072. }
  185073. }
  185074. if( pIter->pLeaf ){
  185075. pIter->iEndofDoclist = pIter->pLeaf->nn+1;
  185076. fts5SegIterReverseInitPage(p, pIter);
  185077. }
  185078. }
  185079. /*
  185080. ** Return true if the iterator passed as the second argument currently
  185081. ** points to a delete marker. A delete marker is an entry with a 0 byte
  185082. ** position-list.
  185083. */
  185084. static int fts5MultiIterIsEmpty(Fts5Index *p, Fts5Iter *pIter){
  185085. Fts5SegIter *pSeg = &pIter->aSeg[pIter->aFirst[1].iFirst];
  185086. return (p->rc==SQLITE_OK && pSeg->pLeaf && pSeg->nPos==0);
  185087. }
  185088. /*
  185089. ** Advance iterator pIter to the next entry.
  185090. **
  185091. ** This version of fts5SegIterNext() is only used by reverse iterators.
  185092. */
  185093. static void fts5SegIterNext_Reverse(
  185094. Fts5Index *p, /* FTS5 backend object */
  185095. Fts5SegIter *pIter, /* Iterator to advance */
  185096. int *pbUnused /* Unused */
  185097. ){
  185098. assert( pIter->flags & FTS5_SEGITER_REVERSE );
  185099. assert( pIter->pNextLeaf==0 );
  185100. UNUSED_PARAM(pbUnused);
  185101. if( pIter->iRowidOffset>0 ){
  185102. u8 *a = pIter->pLeaf->p;
  185103. int iOff;
  185104. i64 iDelta;
  185105. pIter->iRowidOffset--;
  185106. pIter->iLeafOffset = pIter->aRowidOffset[pIter->iRowidOffset];
  185107. fts5SegIterLoadNPos(p, pIter);
  185108. iOff = pIter->iLeafOffset;
  185109. if( p->pConfig->eDetail!=FTS5_DETAIL_NONE ){
  185110. iOff += pIter->nPos;
  185111. }
  185112. fts5GetVarint(&a[iOff], (u64*)&iDelta);
  185113. pIter->iRowid -= iDelta;
  185114. }else{
  185115. fts5SegIterReverseNewPage(p, pIter);
  185116. }
  185117. }
  185118. /*
  185119. ** Advance iterator pIter to the next entry.
  185120. **
  185121. ** This version of fts5SegIterNext() is only used if detail=none and the
  185122. ** iterator is not a reverse direction iterator.
  185123. */
  185124. static void fts5SegIterNext_None(
  185125. Fts5Index *p, /* FTS5 backend object */
  185126. Fts5SegIter *pIter, /* Iterator to advance */
  185127. int *pbNewTerm /* OUT: Set for new term */
  185128. ){
  185129. int iOff;
  185130. assert( p->rc==SQLITE_OK );
  185131. assert( (pIter->flags & FTS5_SEGITER_REVERSE)==0 );
  185132. assert( p->pConfig->eDetail==FTS5_DETAIL_NONE );
  185133. ASSERT_SZLEAF_OK(pIter->pLeaf);
  185134. iOff = pIter->iLeafOffset;
  185135. /* Next entry is on the next page */
  185136. if( pIter->pSeg && iOff>=pIter->pLeaf->szLeaf ){
  185137. fts5SegIterNextPage(p, pIter);
  185138. if( p->rc || pIter->pLeaf==0 ) return;
  185139. pIter->iRowid = 0;
  185140. iOff = 4;
  185141. }
  185142. if( iOff<pIter->iEndofDoclist ){
  185143. /* Next entry is on the current page */
  185144. i64 iDelta;
  185145. iOff += sqlite3Fts5GetVarint(&pIter->pLeaf->p[iOff], (u64*)&iDelta);
  185146. pIter->iLeafOffset = iOff;
  185147. pIter->iRowid += iDelta;
  185148. }else if( (pIter->flags & FTS5_SEGITER_ONETERM)==0 ){
  185149. if( pIter->pSeg ){
  185150. int nKeep = 0;
  185151. if( iOff!=fts5LeafFirstTermOff(pIter->pLeaf) ){
  185152. iOff += fts5GetVarint32(&pIter->pLeaf->p[iOff], nKeep);
  185153. }
  185154. pIter->iLeafOffset = iOff;
  185155. fts5SegIterLoadTerm(p, pIter, nKeep);
  185156. }else{
  185157. const u8 *pList = 0;
  185158. const char *zTerm = 0;
  185159. int nList;
  185160. sqlite3Fts5HashScanNext(p->pHash);
  185161. sqlite3Fts5HashScanEntry(p->pHash, &zTerm, &pList, &nList);
  185162. if( pList==0 ) goto next_none_eof;
  185163. pIter->pLeaf->p = (u8*)pList;
  185164. pIter->pLeaf->nn = nList;
  185165. pIter->pLeaf->szLeaf = nList;
  185166. pIter->iEndofDoclist = nList;
  185167. sqlite3Fts5BufferSet(&p->rc,&pIter->term, (int)strlen(zTerm), (u8*)zTerm);
  185168. pIter->iLeafOffset = fts5GetVarint(pList, (u64*)&pIter->iRowid);
  185169. }
  185170. if( pbNewTerm ) *pbNewTerm = 1;
  185171. }else{
  185172. goto next_none_eof;
  185173. }
  185174. fts5SegIterLoadNPos(p, pIter);
  185175. return;
  185176. next_none_eof:
  185177. fts5DataRelease(pIter->pLeaf);
  185178. pIter->pLeaf = 0;
  185179. }
  185180. /*
  185181. ** Advance iterator pIter to the next entry.
  185182. **
  185183. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. It
  185184. ** is not considered an error if the iterator reaches EOF. If an error has
  185185. ** already occurred when this function is called, it is a no-op.
  185186. */
  185187. static void fts5SegIterNext(
  185188. Fts5Index *p, /* FTS5 backend object */
  185189. Fts5SegIter *pIter, /* Iterator to advance */
  185190. int *pbNewTerm /* OUT: Set for new term */
  185191. ){
  185192. Fts5Data *pLeaf = pIter->pLeaf;
  185193. int iOff;
  185194. int bNewTerm = 0;
  185195. int nKeep = 0;
  185196. u8 *a;
  185197. int n;
  185198. assert( pbNewTerm==0 || *pbNewTerm==0 );
  185199. assert( p->pConfig->eDetail!=FTS5_DETAIL_NONE );
  185200. /* Search for the end of the position list within the current page. */
  185201. a = pLeaf->p;
  185202. n = pLeaf->szLeaf;
  185203. ASSERT_SZLEAF_OK(pLeaf);
  185204. iOff = pIter->iLeafOffset + pIter->nPos;
  185205. if( iOff<n ){
  185206. /* The next entry is on the current page. */
  185207. assert_nc( iOff<=pIter->iEndofDoclist );
  185208. if( iOff>=pIter->iEndofDoclist ){
  185209. bNewTerm = 1;
  185210. if( iOff!=fts5LeafFirstTermOff(pLeaf) ){
  185211. iOff += fts5GetVarint32(&a[iOff], nKeep);
  185212. }
  185213. }else{
  185214. u64 iDelta;
  185215. iOff += sqlite3Fts5GetVarint(&a[iOff], &iDelta);
  185216. pIter->iRowid += iDelta;
  185217. assert_nc( iDelta>0 );
  185218. }
  185219. pIter->iLeafOffset = iOff;
  185220. }else if( pIter->pSeg==0 ){
  185221. const u8 *pList = 0;
  185222. const char *zTerm = 0;
  185223. int nList = 0;
  185224. assert( (pIter->flags & FTS5_SEGITER_ONETERM) || pbNewTerm );
  185225. if( 0==(pIter->flags & FTS5_SEGITER_ONETERM) ){
  185226. sqlite3Fts5HashScanNext(p->pHash);
  185227. sqlite3Fts5HashScanEntry(p->pHash, &zTerm, &pList, &nList);
  185228. }
  185229. if( pList==0 ){
  185230. fts5DataRelease(pIter->pLeaf);
  185231. pIter->pLeaf = 0;
  185232. }else{
  185233. pIter->pLeaf->p = (u8*)pList;
  185234. pIter->pLeaf->nn = nList;
  185235. pIter->pLeaf->szLeaf = nList;
  185236. pIter->iEndofDoclist = nList+1;
  185237. sqlite3Fts5BufferSet(&p->rc, &pIter->term, (int)strlen(zTerm),
  185238. (u8*)zTerm);
  185239. pIter->iLeafOffset = fts5GetVarint(pList, (u64*)&pIter->iRowid);
  185240. *pbNewTerm = 1;
  185241. }
  185242. }else{
  185243. iOff = 0;
  185244. /* Next entry is not on the current page */
  185245. while( iOff==0 ){
  185246. fts5SegIterNextPage(p, pIter);
  185247. pLeaf = pIter->pLeaf;
  185248. if( pLeaf==0 ) break;
  185249. ASSERT_SZLEAF_OK(pLeaf);
  185250. if( (iOff = fts5LeafFirstRowidOff(pLeaf)) && iOff<pLeaf->szLeaf ){
  185251. iOff += sqlite3Fts5GetVarint(&pLeaf->p[iOff], (u64*)&pIter->iRowid);
  185252. pIter->iLeafOffset = iOff;
  185253. if( pLeaf->nn>pLeaf->szLeaf ){
  185254. pIter->iPgidxOff = pLeaf->szLeaf + fts5GetVarint32(
  185255. &pLeaf->p[pLeaf->szLeaf], pIter->iEndofDoclist
  185256. );
  185257. }
  185258. }
  185259. else if( pLeaf->nn>pLeaf->szLeaf ){
  185260. pIter->iPgidxOff = pLeaf->szLeaf + fts5GetVarint32(
  185261. &pLeaf->p[pLeaf->szLeaf], iOff
  185262. );
  185263. pIter->iLeafOffset = iOff;
  185264. pIter->iEndofDoclist = iOff;
  185265. bNewTerm = 1;
  185266. }
  185267. assert_nc( iOff<pLeaf->szLeaf );
  185268. if( iOff>pLeaf->szLeaf ){
  185269. p->rc = FTS5_CORRUPT;
  185270. return;
  185271. }
  185272. }
  185273. }
  185274. /* Check if the iterator is now at EOF. If so, return early. */
  185275. if( pIter->pLeaf ){
  185276. if( bNewTerm ){
  185277. if( pIter->flags & FTS5_SEGITER_ONETERM ){
  185278. fts5DataRelease(pIter->pLeaf);
  185279. pIter->pLeaf = 0;
  185280. }else{
  185281. fts5SegIterLoadTerm(p, pIter, nKeep);
  185282. fts5SegIterLoadNPos(p, pIter);
  185283. if( pbNewTerm ) *pbNewTerm = 1;
  185284. }
  185285. }else{
  185286. /* The following could be done by calling fts5SegIterLoadNPos(). But
  185287. ** this block is particularly performance critical, so equivalent
  185288. ** code is inlined.
  185289. **
  185290. ** Later: Switched back to fts5SegIterLoadNPos() because it supports
  185291. ** detail=none mode. Not ideal.
  185292. */
  185293. int nSz;
  185294. assert( p->rc==SQLITE_OK );
  185295. assert( pIter->iLeafOffset<=pIter->pLeaf->nn );
  185296. fts5FastGetVarint32(pIter->pLeaf->p, pIter->iLeafOffset, nSz);
  185297. pIter->bDel = (nSz & 0x0001);
  185298. pIter->nPos = nSz>>1;
  185299. assert_nc( pIter->nPos>=0 );
  185300. }
  185301. }
  185302. }
  185303. #define SWAPVAL(T, a, b) { T tmp; tmp=a; a=b; b=tmp; }
  185304. #define fts5IndexSkipVarint(a, iOff) { \
  185305. int iEnd = iOff+9; \
  185306. while( (a[iOff++] & 0x80) && iOff<iEnd ); \
  185307. }
  185308. /*
  185309. ** Iterator pIter currently points to the first rowid in a doclist. This
  185310. ** function sets the iterator up so that iterates in reverse order through
  185311. ** the doclist.
  185312. */
  185313. static void fts5SegIterReverse(Fts5Index *p, Fts5SegIter *pIter){
  185314. Fts5DlidxIter *pDlidx = pIter->pDlidx;
  185315. Fts5Data *pLast = 0;
  185316. int pgnoLast = 0;
  185317. if( pDlidx ){
  185318. int iSegid = pIter->pSeg->iSegid;
  185319. pgnoLast = fts5DlidxIterPgno(pDlidx);
  185320. pLast = fts5DataRead(p, FTS5_SEGMENT_ROWID(iSegid, pgnoLast));
  185321. }else{
  185322. Fts5Data *pLeaf = pIter->pLeaf; /* Current leaf data */
  185323. /* Currently, Fts5SegIter.iLeafOffset points to the first byte of
  185324. ** position-list content for the current rowid. Back it up so that it
  185325. ** points to the start of the position-list size field. */
  185326. int iPoslist;
  185327. if( pIter->iTermLeafPgno==pIter->iLeafPgno ){
  185328. iPoslist = pIter->iTermLeafOffset;
  185329. }else{
  185330. iPoslist = 4;
  185331. }
  185332. fts5IndexSkipVarint(pLeaf->p, iPoslist);
  185333. pIter->iLeafOffset = iPoslist;
  185334. /* If this condition is true then the largest rowid for the current
  185335. ** term may not be stored on the current page. So search forward to
  185336. ** see where said rowid really is. */
  185337. if( pIter->iEndofDoclist>=pLeaf->szLeaf ){
  185338. int pgno;
  185339. Fts5StructureSegment *pSeg = pIter->pSeg;
  185340. /* The last rowid in the doclist may not be on the current page. Search
  185341. ** forward to find the page containing the last rowid. */
  185342. for(pgno=pIter->iLeafPgno+1; !p->rc && pgno<=pSeg->pgnoLast; pgno++){
  185343. i64 iAbs = FTS5_SEGMENT_ROWID(pSeg->iSegid, pgno);
  185344. Fts5Data *pNew = fts5DataRead(p, iAbs);
  185345. if( pNew ){
  185346. int iRowid, bTermless;
  185347. iRowid = fts5LeafFirstRowidOff(pNew);
  185348. bTermless = fts5LeafIsTermless(pNew);
  185349. if( iRowid ){
  185350. SWAPVAL(Fts5Data*, pNew, pLast);
  185351. pgnoLast = pgno;
  185352. }
  185353. fts5DataRelease(pNew);
  185354. if( bTermless==0 ) break;
  185355. }
  185356. }
  185357. }
  185358. }
  185359. /* If pLast is NULL at this point, then the last rowid for this doclist
  185360. ** lies on the page currently indicated by the iterator. In this case
  185361. ** pIter->iLeafOffset is already set to point to the position-list size
  185362. ** field associated with the first relevant rowid on the page.
  185363. **
  185364. ** Or, if pLast is non-NULL, then it is the page that contains the last
  185365. ** rowid. In this case configure the iterator so that it points to the
  185366. ** first rowid on this page.
  185367. */
  185368. if( pLast ){
  185369. int iOff;
  185370. fts5DataRelease(pIter->pLeaf);
  185371. pIter->pLeaf = pLast;
  185372. pIter->iLeafPgno = pgnoLast;
  185373. iOff = fts5LeafFirstRowidOff(pLast);
  185374. iOff += fts5GetVarint(&pLast->p[iOff], (u64*)&pIter->iRowid);
  185375. pIter->iLeafOffset = iOff;
  185376. if( fts5LeafIsTermless(pLast) ){
  185377. pIter->iEndofDoclist = pLast->nn+1;
  185378. }else{
  185379. pIter->iEndofDoclist = fts5LeafFirstTermOff(pLast);
  185380. }
  185381. }
  185382. fts5SegIterReverseInitPage(p, pIter);
  185383. }
  185384. /*
  185385. ** Iterator pIter currently points to the first rowid of a doclist.
  185386. ** There is a doclist-index associated with the final term on the current
  185387. ** page. If the current term is the last term on the page, load the
  185388. ** doclist-index from disk and initialize an iterator at (pIter->pDlidx).
  185389. */
  185390. static void fts5SegIterLoadDlidx(Fts5Index *p, Fts5SegIter *pIter){
  185391. int iSeg = pIter->pSeg->iSegid;
  185392. int bRev = (pIter->flags & FTS5_SEGITER_REVERSE);
  185393. Fts5Data *pLeaf = pIter->pLeaf; /* Current leaf data */
  185394. assert( pIter->flags & FTS5_SEGITER_ONETERM );
  185395. assert( pIter->pDlidx==0 );
  185396. /* Check if the current doclist ends on this page. If it does, return
  185397. ** early without loading the doclist-index (as it belongs to a different
  185398. ** term. */
  185399. if( pIter->iTermLeafPgno==pIter->iLeafPgno
  185400. && pIter->iEndofDoclist<pLeaf->szLeaf
  185401. ){
  185402. return;
  185403. }
  185404. pIter->pDlidx = fts5DlidxIterInit(p, bRev, iSeg, pIter->iTermLeafPgno);
  185405. }
  185406. /*
  185407. ** The iterator object passed as the second argument currently contains
  185408. ** no valid values except for the Fts5SegIter.pLeaf member variable. This
  185409. ** function searches the leaf page for a term matching (pTerm/nTerm).
  185410. **
  185411. ** If the specified term is found on the page, then the iterator is left
  185412. ** pointing to it. If argument bGe is zero and the term is not found,
  185413. ** the iterator is left pointing at EOF.
  185414. **
  185415. ** If bGe is non-zero and the specified term is not found, then the
  185416. ** iterator is left pointing to the smallest term in the segment that
  185417. ** is larger than the specified term, even if this term is not on the
  185418. ** current page.
  185419. */
  185420. static void fts5LeafSeek(
  185421. Fts5Index *p, /* Leave any error code here */
  185422. int bGe, /* True for a >= search */
  185423. Fts5SegIter *pIter, /* Iterator to seek */
  185424. const u8 *pTerm, int nTerm /* Term to search for */
  185425. ){
  185426. int iOff;
  185427. const u8 *a = pIter->pLeaf->p;
  185428. int szLeaf = pIter->pLeaf->szLeaf;
  185429. int n = pIter->pLeaf->nn;
  185430. int nMatch = 0;
  185431. int nKeep = 0;
  185432. int nNew = 0;
  185433. int iTermOff;
  185434. int iPgidx; /* Current offset in pgidx */
  185435. int bEndOfPage = 0;
  185436. assert( p->rc==SQLITE_OK );
  185437. iPgidx = szLeaf;
  185438. iPgidx += fts5GetVarint32(&a[iPgidx], iTermOff);
  185439. iOff = iTermOff;
  185440. if( iOff>n ){
  185441. p->rc = FTS5_CORRUPT;
  185442. return;
  185443. }
  185444. while( 1 ){
  185445. /* Figure out how many new bytes are in this term */
  185446. fts5FastGetVarint32(a, iOff, nNew);
  185447. if( nKeep<nMatch ){
  185448. goto search_failed;
  185449. }
  185450. assert( nKeep>=nMatch );
  185451. if( nKeep==nMatch ){
  185452. int nCmp;
  185453. int i;
  185454. nCmp = MIN(nNew, nTerm-nMatch);
  185455. for(i=0; i<nCmp; i++){
  185456. if( a[iOff+i]!=pTerm[nMatch+i] ) break;
  185457. }
  185458. nMatch += i;
  185459. if( nTerm==nMatch ){
  185460. if( i==nNew ){
  185461. goto search_success;
  185462. }else{
  185463. goto search_failed;
  185464. }
  185465. }else if( i<nNew && a[iOff+i]>pTerm[nMatch] ){
  185466. goto search_failed;
  185467. }
  185468. }
  185469. if( iPgidx>=n ){
  185470. bEndOfPage = 1;
  185471. break;
  185472. }
  185473. iPgidx += fts5GetVarint32(&a[iPgidx], nKeep);
  185474. iTermOff += nKeep;
  185475. iOff = iTermOff;
  185476. if( iOff>=n ){
  185477. p->rc = FTS5_CORRUPT;
  185478. return;
  185479. }
  185480. /* Read the nKeep field of the next term. */
  185481. fts5FastGetVarint32(a, iOff, nKeep);
  185482. }
  185483. search_failed:
  185484. if( bGe==0 ){
  185485. fts5DataRelease(pIter->pLeaf);
  185486. pIter->pLeaf = 0;
  185487. return;
  185488. }else if( bEndOfPage ){
  185489. do {
  185490. fts5SegIterNextPage(p, pIter);
  185491. if( pIter->pLeaf==0 ) return;
  185492. a = pIter->pLeaf->p;
  185493. if( fts5LeafIsTermless(pIter->pLeaf)==0 ){
  185494. iPgidx = pIter->pLeaf->szLeaf;
  185495. iPgidx += fts5GetVarint32(&pIter->pLeaf->p[iPgidx], iOff);
  185496. if( iOff<4 || iOff>=pIter->pLeaf->szLeaf ){
  185497. p->rc = FTS5_CORRUPT;
  185498. }else{
  185499. nKeep = 0;
  185500. iTermOff = iOff;
  185501. n = pIter->pLeaf->nn;
  185502. iOff += fts5GetVarint32(&a[iOff], nNew);
  185503. break;
  185504. }
  185505. }
  185506. }while( 1 );
  185507. }
  185508. search_success:
  185509. pIter->iLeafOffset = iOff + nNew;
  185510. pIter->iTermLeafOffset = pIter->iLeafOffset;
  185511. pIter->iTermLeafPgno = pIter->iLeafPgno;
  185512. fts5BufferSet(&p->rc, &pIter->term, nKeep, pTerm);
  185513. fts5BufferAppendBlob(&p->rc, &pIter->term, nNew, &a[iOff]);
  185514. if( iPgidx>=n ){
  185515. pIter->iEndofDoclist = pIter->pLeaf->nn+1;
  185516. }else{
  185517. int nExtra;
  185518. iPgidx += fts5GetVarint32(&a[iPgidx], nExtra);
  185519. pIter->iEndofDoclist = iTermOff + nExtra;
  185520. }
  185521. pIter->iPgidxOff = iPgidx;
  185522. fts5SegIterLoadRowid(p, pIter);
  185523. fts5SegIterLoadNPos(p, pIter);
  185524. }
  185525. static sqlite3_stmt *fts5IdxSelectStmt(Fts5Index *p){
  185526. if( p->pIdxSelect==0 ){
  185527. Fts5Config *pConfig = p->pConfig;
  185528. fts5IndexPrepareStmt(p, &p->pIdxSelect, sqlite3_mprintf(
  185529. "SELECT pgno FROM '%q'.'%q_idx' WHERE "
  185530. "segid=? AND term<=? ORDER BY term DESC LIMIT 1",
  185531. pConfig->zDb, pConfig->zName
  185532. ));
  185533. }
  185534. return p->pIdxSelect;
  185535. }
  185536. /*
  185537. ** Initialize the object pIter to point to term pTerm/nTerm within segment
  185538. ** pSeg. If there is no such term in the index, the iterator is set to EOF.
  185539. **
  185540. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. If
  185541. ** an error has already occurred when this function is called, it is a no-op.
  185542. */
  185543. static void fts5SegIterSeekInit(
  185544. Fts5Index *p, /* FTS5 backend */
  185545. const u8 *pTerm, int nTerm, /* Term to seek to */
  185546. int flags, /* Mask of FTS5INDEX_XXX flags */
  185547. Fts5StructureSegment *pSeg, /* Description of segment */
  185548. Fts5SegIter *pIter /* Object to populate */
  185549. ){
  185550. int iPg = 1;
  185551. int bGe = (flags & FTS5INDEX_QUERY_SCAN);
  185552. int bDlidx = 0; /* True if there is a doclist-index */
  185553. sqlite3_stmt *pIdxSelect = 0;
  185554. assert( bGe==0 || (flags & FTS5INDEX_QUERY_DESC)==0 );
  185555. assert( pTerm && nTerm );
  185556. memset(pIter, 0, sizeof(*pIter));
  185557. pIter->pSeg = pSeg;
  185558. /* This block sets stack variable iPg to the leaf page number that may
  185559. ** contain term (pTerm/nTerm), if it is present in the segment. */
  185560. pIdxSelect = fts5IdxSelectStmt(p);
  185561. if( p->rc ) return;
  185562. sqlite3_bind_int(pIdxSelect, 1, pSeg->iSegid);
  185563. sqlite3_bind_blob(pIdxSelect, 2, pTerm, nTerm, SQLITE_STATIC);
  185564. if( SQLITE_ROW==sqlite3_step(pIdxSelect) ){
  185565. i64 val = sqlite3_column_int(pIdxSelect, 0);
  185566. iPg = (int)(val>>1);
  185567. bDlidx = (val & 0x0001);
  185568. }
  185569. p->rc = sqlite3_reset(pIdxSelect);
  185570. sqlite3_bind_null(pIdxSelect, 2);
  185571. if( iPg<pSeg->pgnoFirst ){
  185572. iPg = pSeg->pgnoFirst;
  185573. bDlidx = 0;
  185574. }
  185575. pIter->iLeafPgno = iPg - 1;
  185576. fts5SegIterNextPage(p, pIter);
  185577. if( pIter->pLeaf ){
  185578. fts5LeafSeek(p, bGe, pIter, pTerm, nTerm);
  185579. }
  185580. if( p->rc==SQLITE_OK && bGe==0 ){
  185581. pIter->flags |= FTS5_SEGITER_ONETERM;
  185582. if( pIter->pLeaf ){
  185583. if( flags & FTS5INDEX_QUERY_DESC ){
  185584. pIter->flags |= FTS5_SEGITER_REVERSE;
  185585. }
  185586. if( bDlidx ){
  185587. fts5SegIterLoadDlidx(p, pIter);
  185588. }
  185589. if( flags & FTS5INDEX_QUERY_DESC ){
  185590. fts5SegIterReverse(p, pIter);
  185591. }
  185592. }
  185593. }
  185594. fts5SegIterSetNext(p, pIter);
  185595. /* Either:
  185596. **
  185597. ** 1) an error has occurred, or
  185598. ** 2) the iterator points to EOF, or
  185599. ** 3) the iterator points to an entry with term (pTerm/nTerm), or
  185600. ** 4) the FTS5INDEX_QUERY_SCAN flag was set and the iterator points
  185601. ** to an entry with a term greater than or equal to (pTerm/nTerm).
  185602. */
  185603. assert( p->rc!=SQLITE_OK /* 1 */
  185604. || pIter->pLeaf==0 /* 2 */
  185605. || fts5BufferCompareBlob(&pIter->term, pTerm, nTerm)==0 /* 3 */
  185606. || (bGe && fts5BufferCompareBlob(&pIter->term, pTerm, nTerm)>0) /* 4 */
  185607. );
  185608. }
  185609. /*
  185610. ** Initialize the object pIter to point to term pTerm/nTerm within the
  185611. ** in-memory hash table. If there is no such term in the hash-table, the
  185612. ** iterator is set to EOF.
  185613. **
  185614. ** If an error occurs, Fts5Index.rc is set to an appropriate error code. If
  185615. ** an error has already occurred when this function is called, it is a no-op.
  185616. */
  185617. static void fts5SegIterHashInit(
  185618. Fts5Index *p, /* FTS5 backend */
  185619. const u8 *pTerm, int nTerm, /* Term to seek to */
  185620. int flags, /* Mask of FTS5INDEX_XXX flags */
  185621. Fts5SegIter *pIter /* Object to populate */
  185622. ){
  185623. const u8 *pList = 0;
  185624. int nList = 0;
  185625. const u8 *z = 0;
  185626. int n = 0;
  185627. assert( p->pHash );
  185628. assert( p->rc==SQLITE_OK );
  185629. if( pTerm==0 || (flags & FTS5INDEX_QUERY_SCAN) ){
  185630. p->rc = sqlite3Fts5HashScanInit(p->pHash, (const char*)pTerm, nTerm);
  185631. sqlite3Fts5HashScanEntry(p->pHash, (const char**)&z, &pList, &nList);
  185632. n = (z ? (int)strlen((const char*)z) : 0);
  185633. }else{
  185634. pIter->flags |= FTS5_SEGITER_ONETERM;
  185635. sqlite3Fts5HashQuery(p->pHash, (const char*)pTerm, nTerm, &pList, &nList);
  185636. z = pTerm;
  185637. n = nTerm;
  185638. }
  185639. if( pList ){
  185640. Fts5Data *pLeaf;
  185641. sqlite3Fts5BufferSet(&p->rc, &pIter->term, n, z);
  185642. pLeaf = fts5IdxMalloc(p, sizeof(Fts5Data));
  185643. if( pLeaf==0 ) return;
  185644. pLeaf->p = (u8*)pList;
  185645. pLeaf->nn = pLeaf->szLeaf = nList;
  185646. pIter->pLeaf = pLeaf;
  185647. pIter->iLeafOffset = fts5GetVarint(pLeaf->p, (u64*)&pIter->iRowid);
  185648. pIter->iEndofDoclist = pLeaf->nn;
  185649. if( flags & FTS5INDEX_QUERY_DESC ){
  185650. pIter->flags |= FTS5_SEGITER_REVERSE;
  185651. fts5SegIterReverseInitPage(p, pIter);
  185652. }else{
  185653. fts5SegIterLoadNPos(p, pIter);
  185654. }
  185655. }
  185656. fts5SegIterSetNext(p, pIter);
  185657. }
  185658. /*
  185659. ** Zero the iterator passed as the only argument.
  185660. */
  185661. static void fts5SegIterClear(Fts5SegIter *pIter){
  185662. fts5BufferFree(&pIter->term);
  185663. fts5DataRelease(pIter->pLeaf);
  185664. fts5DataRelease(pIter->pNextLeaf);
  185665. fts5DlidxIterFree(pIter->pDlidx);
  185666. sqlite3_free(pIter->aRowidOffset);
  185667. memset(pIter, 0, sizeof(Fts5SegIter));
  185668. }
  185669. #ifdef SQLITE_DEBUG
  185670. /*
  185671. ** This function is used as part of the big assert() procedure implemented by
  185672. ** fts5AssertMultiIterSetup(). It ensures that the result currently stored
  185673. ** in *pRes is the correct result of comparing the current positions of the
  185674. ** two iterators.
  185675. */
  185676. static void fts5AssertComparisonResult(
  185677. Fts5Iter *pIter,
  185678. Fts5SegIter *p1,
  185679. Fts5SegIter *p2,
  185680. Fts5CResult *pRes
  185681. ){
  185682. int i1 = p1 - pIter->aSeg;
  185683. int i2 = p2 - pIter->aSeg;
  185684. if( p1->pLeaf || p2->pLeaf ){
  185685. if( p1->pLeaf==0 ){
  185686. assert( pRes->iFirst==i2 );
  185687. }else if( p2->pLeaf==0 ){
  185688. assert( pRes->iFirst==i1 );
  185689. }else{
  185690. int nMin = MIN(p1->term.n, p2->term.n);
  185691. int res = memcmp(p1->term.p, p2->term.p, nMin);
  185692. if( res==0 ) res = p1->term.n - p2->term.n;
  185693. if( res==0 ){
  185694. assert( pRes->bTermEq==1 );
  185695. assert( p1->iRowid!=p2->iRowid );
  185696. res = ((p1->iRowid > p2->iRowid)==pIter->bRev) ? -1 : 1;
  185697. }else{
  185698. assert( pRes->bTermEq==0 );
  185699. }
  185700. if( res<0 ){
  185701. assert( pRes->iFirst==i1 );
  185702. }else{
  185703. assert( pRes->iFirst==i2 );
  185704. }
  185705. }
  185706. }
  185707. }
  185708. /*
  185709. ** This function is a no-op unless SQLITE_DEBUG is defined when this module
  185710. ** is compiled. In that case, this function is essentially an assert()
  185711. ** statement used to verify that the contents of the pIter->aFirst[] array
  185712. ** are correct.
  185713. */
  185714. static void fts5AssertMultiIterSetup(Fts5Index *p, Fts5Iter *pIter){
  185715. if( p->rc==SQLITE_OK ){
  185716. Fts5SegIter *pFirst = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  185717. int i;
  185718. assert( (pFirst->pLeaf==0)==pIter->base.bEof );
  185719. /* Check that pIter->iSwitchRowid is set correctly. */
  185720. for(i=0; i<pIter->nSeg; i++){
  185721. Fts5SegIter *p1 = &pIter->aSeg[i];
  185722. assert( p1==pFirst
  185723. || p1->pLeaf==0
  185724. || fts5BufferCompare(&pFirst->term, &p1->term)
  185725. || p1->iRowid==pIter->iSwitchRowid
  185726. || (p1->iRowid<pIter->iSwitchRowid)==pIter->bRev
  185727. );
  185728. }
  185729. for(i=0; i<pIter->nSeg; i+=2){
  185730. Fts5SegIter *p1 = &pIter->aSeg[i];
  185731. Fts5SegIter *p2 = &pIter->aSeg[i+1];
  185732. Fts5CResult *pRes = &pIter->aFirst[(pIter->nSeg + i) / 2];
  185733. fts5AssertComparisonResult(pIter, p1, p2, pRes);
  185734. }
  185735. for(i=1; i<(pIter->nSeg / 2); i+=2){
  185736. Fts5SegIter *p1 = &pIter->aSeg[ pIter->aFirst[i*2].iFirst ];
  185737. Fts5SegIter *p2 = &pIter->aSeg[ pIter->aFirst[i*2+1].iFirst ];
  185738. Fts5CResult *pRes = &pIter->aFirst[i];
  185739. fts5AssertComparisonResult(pIter, p1, p2, pRes);
  185740. }
  185741. }
  185742. }
  185743. #else
  185744. # define fts5AssertMultiIterSetup(x,y)
  185745. #endif
  185746. /*
  185747. ** Do the comparison necessary to populate pIter->aFirst[iOut].
  185748. **
  185749. ** If the returned value is non-zero, then it is the index of an entry
  185750. ** in the pIter->aSeg[] array that is (a) not at EOF, and (b) pointing
  185751. ** to a key that is a duplicate of another, higher priority,
  185752. ** segment-iterator in the pSeg->aSeg[] array.
  185753. */
  185754. static int fts5MultiIterDoCompare(Fts5Iter *pIter, int iOut){
  185755. int i1; /* Index of left-hand Fts5SegIter */
  185756. int i2; /* Index of right-hand Fts5SegIter */
  185757. int iRes;
  185758. Fts5SegIter *p1; /* Left-hand Fts5SegIter */
  185759. Fts5SegIter *p2; /* Right-hand Fts5SegIter */
  185760. Fts5CResult *pRes = &pIter->aFirst[iOut];
  185761. assert( iOut<pIter->nSeg && iOut>0 );
  185762. assert( pIter->bRev==0 || pIter->bRev==1 );
  185763. if( iOut>=(pIter->nSeg/2) ){
  185764. i1 = (iOut - pIter->nSeg/2) * 2;
  185765. i2 = i1 + 1;
  185766. }else{
  185767. i1 = pIter->aFirst[iOut*2].iFirst;
  185768. i2 = pIter->aFirst[iOut*2+1].iFirst;
  185769. }
  185770. p1 = &pIter->aSeg[i1];
  185771. p2 = &pIter->aSeg[i2];
  185772. pRes->bTermEq = 0;
  185773. if( p1->pLeaf==0 ){ /* If p1 is at EOF */
  185774. iRes = i2;
  185775. }else if( p2->pLeaf==0 ){ /* If p2 is at EOF */
  185776. iRes = i1;
  185777. }else{
  185778. int res = fts5BufferCompare(&p1->term, &p2->term);
  185779. if( res==0 ){
  185780. assert( i2>i1 );
  185781. assert( i2!=0 );
  185782. pRes->bTermEq = 1;
  185783. if( p1->iRowid==p2->iRowid ){
  185784. p1->bDel = p2->bDel;
  185785. return i2;
  185786. }
  185787. res = ((p1->iRowid > p2->iRowid)==pIter->bRev) ? -1 : +1;
  185788. }
  185789. assert( res!=0 );
  185790. if( res<0 ){
  185791. iRes = i1;
  185792. }else{
  185793. iRes = i2;
  185794. }
  185795. }
  185796. pRes->iFirst = (u16)iRes;
  185797. return 0;
  185798. }
  185799. /*
  185800. ** Move the seg-iter so that it points to the first rowid on page iLeafPgno.
  185801. ** It is an error if leaf iLeafPgno does not exist or contains no rowids.
  185802. */
  185803. static void fts5SegIterGotoPage(
  185804. Fts5Index *p, /* FTS5 backend object */
  185805. Fts5SegIter *pIter, /* Iterator to advance */
  185806. int iLeafPgno
  185807. ){
  185808. assert( iLeafPgno>pIter->iLeafPgno );
  185809. if( iLeafPgno>pIter->pSeg->pgnoLast ){
  185810. p->rc = FTS5_CORRUPT;
  185811. }else{
  185812. fts5DataRelease(pIter->pNextLeaf);
  185813. pIter->pNextLeaf = 0;
  185814. pIter->iLeafPgno = iLeafPgno-1;
  185815. fts5SegIterNextPage(p, pIter);
  185816. assert( p->rc!=SQLITE_OK || pIter->iLeafPgno==iLeafPgno );
  185817. if( p->rc==SQLITE_OK ){
  185818. int iOff;
  185819. u8 *a = pIter->pLeaf->p;
  185820. int n = pIter->pLeaf->szLeaf;
  185821. iOff = fts5LeafFirstRowidOff(pIter->pLeaf);
  185822. if( iOff<4 || iOff>=n ){
  185823. p->rc = FTS5_CORRUPT;
  185824. }else{
  185825. iOff += fts5GetVarint(&a[iOff], (u64*)&pIter->iRowid);
  185826. pIter->iLeafOffset = iOff;
  185827. fts5SegIterLoadNPos(p, pIter);
  185828. }
  185829. }
  185830. }
  185831. }
  185832. /*
  185833. ** Advance the iterator passed as the second argument until it is at or
  185834. ** past rowid iFrom. Regardless of the value of iFrom, the iterator is
  185835. ** always advanced at least once.
  185836. */
  185837. static void fts5SegIterNextFrom(
  185838. Fts5Index *p, /* FTS5 backend object */
  185839. Fts5SegIter *pIter, /* Iterator to advance */
  185840. i64 iMatch /* Advance iterator at least this far */
  185841. ){
  185842. int bRev = (pIter->flags & FTS5_SEGITER_REVERSE);
  185843. Fts5DlidxIter *pDlidx = pIter->pDlidx;
  185844. int iLeafPgno = pIter->iLeafPgno;
  185845. int bMove = 1;
  185846. assert( pIter->flags & FTS5_SEGITER_ONETERM );
  185847. assert( pIter->pDlidx );
  185848. assert( pIter->pLeaf );
  185849. if( bRev==0 ){
  185850. while( !fts5DlidxIterEof(p, pDlidx) && iMatch>fts5DlidxIterRowid(pDlidx) ){
  185851. iLeafPgno = fts5DlidxIterPgno(pDlidx);
  185852. fts5DlidxIterNext(p, pDlidx);
  185853. }
  185854. assert_nc( iLeafPgno>=pIter->iLeafPgno || p->rc );
  185855. if( iLeafPgno>pIter->iLeafPgno ){
  185856. fts5SegIterGotoPage(p, pIter, iLeafPgno);
  185857. bMove = 0;
  185858. }
  185859. }else{
  185860. assert( pIter->pNextLeaf==0 );
  185861. assert( iMatch<pIter->iRowid );
  185862. while( !fts5DlidxIterEof(p, pDlidx) && iMatch<fts5DlidxIterRowid(pDlidx) ){
  185863. fts5DlidxIterPrev(p, pDlidx);
  185864. }
  185865. iLeafPgno = fts5DlidxIterPgno(pDlidx);
  185866. assert( fts5DlidxIterEof(p, pDlidx) || iLeafPgno<=pIter->iLeafPgno );
  185867. if( iLeafPgno<pIter->iLeafPgno ){
  185868. pIter->iLeafPgno = iLeafPgno+1;
  185869. fts5SegIterReverseNewPage(p, pIter);
  185870. bMove = 0;
  185871. }
  185872. }
  185873. do{
  185874. if( bMove && p->rc==SQLITE_OK ) pIter->xNext(p, pIter, 0);
  185875. if( pIter->pLeaf==0 ) break;
  185876. if( bRev==0 && pIter->iRowid>=iMatch ) break;
  185877. if( bRev!=0 && pIter->iRowid<=iMatch ) break;
  185878. bMove = 1;
  185879. }while( p->rc==SQLITE_OK );
  185880. }
  185881. /*
  185882. ** Free the iterator object passed as the second argument.
  185883. */
  185884. static void fts5MultiIterFree(Fts5Iter *pIter){
  185885. if( pIter ){
  185886. int i;
  185887. for(i=0; i<pIter->nSeg; i++){
  185888. fts5SegIterClear(&pIter->aSeg[i]);
  185889. }
  185890. fts5StructureRelease(pIter->pStruct);
  185891. fts5BufferFree(&pIter->poslist);
  185892. sqlite3_free(pIter);
  185893. }
  185894. }
  185895. static void fts5MultiIterAdvanced(
  185896. Fts5Index *p, /* FTS5 backend to iterate within */
  185897. Fts5Iter *pIter, /* Iterator to update aFirst[] array for */
  185898. int iChanged, /* Index of sub-iterator just advanced */
  185899. int iMinset /* Minimum entry in aFirst[] to set */
  185900. ){
  185901. int i;
  185902. for(i=(pIter->nSeg+iChanged)/2; i>=iMinset && p->rc==SQLITE_OK; i=i/2){
  185903. int iEq;
  185904. if( (iEq = fts5MultiIterDoCompare(pIter, i)) ){
  185905. Fts5SegIter *pSeg = &pIter->aSeg[iEq];
  185906. assert( p->rc==SQLITE_OK );
  185907. pSeg->xNext(p, pSeg, 0);
  185908. i = pIter->nSeg + iEq;
  185909. }
  185910. }
  185911. }
  185912. /*
  185913. ** Sub-iterator iChanged of iterator pIter has just been advanced. It still
  185914. ** points to the same term though - just a different rowid. This function
  185915. ** attempts to update the contents of the pIter->aFirst[] accordingly.
  185916. ** If it does so successfully, 0 is returned. Otherwise 1.
  185917. **
  185918. ** If non-zero is returned, the caller should call fts5MultiIterAdvanced()
  185919. ** on the iterator instead. That function does the same as this one, except
  185920. ** that it deals with more complicated cases as well.
  185921. */
  185922. static int fts5MultiIterAdvanceRowid(
  185923. Fts5Iter *pIter, /* Iterator to update aFirst[] array for */
  185924. int iChanged, /* Index of sub-iterator just advanced */
  185925. Fts5SegIter **ppFirst
  185926. ){
  185927. Fts5SegIter *pNew = &pIter->aSeg[iChanged];
  185928. if( pNew->iRowid==pIter->iSwitchRowid
  185929. || (pNew->iRowid<pIter->iSwitchRowid)==pIter->bRev
  185930. ){
  185931. int i;
  185932. Fts5SegIter *pOther = &pIter->aSeg[iChanged ^ 0x0001];
  185933. pIter->iSwitchRowid = pIter->bRev ? SMALLEST_INT64 : LARGEST_INT64;
  185934. for(i=(pIter->nSeg+iChanged)/2; 1; i=i/2){
  185935. Fts5CResult *pRes = &pIter->aFirst[i];
  185936. assert( pNew->pLeaf );
  185937. assert( pRes->bTermEq==0 || pOther->pLeaf );
  185938. if( pRes->bTermEq ){
  185939. if( pNew->iRowid==pOther->iRowid ){
  185940. return 1;
  185941. }else if( (pOther->iRowid>pNew->iRowid)==pIter->bRev ){
  185942. pIter->iSwitchRowid = pOther->iRowid;
  185943. pNew = pOther;
  185944. }else if( (pOther->iRowid>pIter->iSwitchRowid)==pIter->bRev ){
  185945. pIter->iSwitchRowid = pOther->iRowid;
  185946. }
  185947. }
  185948. pRes->iFirst = (u16)(pNew - pIter->aSeg);
  185949. if( i==1 ) break;
  185950. pOther = &pIter->aSeg[ pIter->aFirst[i ^ 0x0001].iFirst ];
  185951. }
  185952. }
  185953. *ppFirst = pNew;
  185954. return 0;
  185955. }
  185956. /*
  185957. ** Set the pIter->bEof variable based on the state of the sub-iterators.
  185958. */
  185959. static void fts5MultiIterSetEof(Fts5Iter *pIter){
  185960. Fts5SegIter *pSeg = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  185961. pIter->base.bEof = pSeg->pLeaf==0;
  185962. pIter->iSwitchRowid = pSeg->iRowid;
  185963. }
  185964. /*
  185965. ** Move the iterator to the next entry.
  185966. **
  185967. ** If an error occurs, an error code is left in Fts5Index.rc. It is not
  185968. ** considered an error if the iterator reaches EOF, or if it is already at
  185969. ** EOF when this function is called.
  185970. */
  185971. static void fts5MultiIterNext(
  185972. Fts5Index *p,
  185973. Fts5Iter *pIter,
  185974. int bFrom, /* True if argument iFrom is valid */
  185975. i64 iFrom /* Advance at least as far as this */
  185976. ){
  185977. int bUseFrom = bFrom;
  185978. assert( pIter->base.bEof==0 );
  185979. while( p->rc==SQLITE_OK ){
  185980. int iFirst = pIter->aFirst[1].iFirst;
  185981. int bNewTerm = 0;
  185982. Fts5SegIter *pSeg = &pIter->aSeg[iFirst];
  185983. assert( p->rc==SQLITE_OK );
  185984. if( bUseFrom && pSeg->pDlidx ){
  185985. fts5SegIterNextFrom(p, pSeg, iFrom);
  185986. }else{
  185987. pSeg->xNext(p, pSeg, &bNewTerm);
  185988. }
  185989. if( pSeg->pLeaf==0 || bNewTerm
  185990. || fts5MultiIterAdvanceRowid(pIter, iFirst, &pSeg)
  185991. ){
  185992. fts5MultiIterAdvanced(p, pIter, iFirst, 1);
  185993. fts5MultiIterSetEof(pIter);
  185994. pSeg = &pIter->aSeg[pIter->aFirst[1].iFirst];
  185995. if( pSeg->pLeaf==0 ) return;
  185996. }
  185997. fts5AssertMultiIterSetup(p, pIter);
  185998. assert( pSeg==&pIter->aSeg[pIter->aFirst[1].iFirst] && pSeg->pLeaf );
  185999. if( pIter->bSkipEmpty==0 || pSeg->nPos ){
  186000. pIter->xSetOutputs(pIter, pSeg);
  186001. return;
  186002. }
  186003. bUseFrom = 0;
  186004. }
  186005. }
  186006. static void fts5MultiIterNext2(
  186007. Fts5Index *p,
  186008. Fts5Iter *pIter,
  186009. int *pbNewTerm /* OUT: True if *might* be new term */
  186010. ){
  186011. assert( pIter->bSkipEmpty );
  186012. if( p->rc==SQLITE_OK ){
  186013. *pbNewTerm = 0;
  186014. do{
  186015. int iFirst = pIter->aFirst[1].iFirst;
  186016. Fts5SegIter *pSeg = &pIter->aSeg[iFirst];
  186017. int bNewTerm = 0;
  186018. assert( p->rc==SQLITE_OK );
  186019. pSeg->xNext(p, pSeg, &bNewTerm);
  186020. if( pSeg->pLeaf==0 || bNewTerm
  186021. || fts5MultiIterAdvanceRowid(pIter, iFirst, &pSeg)
  186022. ){
  186023. fts5MultiIterAdvanced(p, pIter, iFirst, 1);
  186024. fts5MultiIterSetEof(pIter);
  186025. *pbNewTerm = 1;
  186026. }
  186027. fts5AssertMultiIterSetup(p, pIter);
  186028. }while( fts5MultiIterIsEmpty(p, pIter) );
  186029. }
  186030. }
  186031. static void fts5IterSetOutputs_Noop(Fts5Iter *pUnused1, Fts5SegIter *pUnused2){
  186032. UNUSED_PARAM2(pUnused1, pUnused2);
  186033. }
  186034. static Fts5Iter *fts5MultiIterAlloc(
  186035. Fts5Index *p, /* FTS5 backend to iterate within */
  186036. int nSeg
  186037. ){
  186038. Fts5Iter *pNew;
  186039. int nSlot; /* Power of two >= nSeg */
  186040. for(nSlot=2; nSlot<nSeg; nSlot=nSlot*2);
  186041. pNew = fts5IdxMalloc(p,
  186042. sizeof(Fts5Iter) + /* pNew */
  186043. sizeof(Fts5SegIter) * (nSlot-1) + /* pNew->aSeg[] */
  186044. sizeof(Fts5CResult) * nSlot /* pNew->aFirst[] */
  186045. );
  186046. if( pNew ){
  186047. pNew->nSeg = nSlot;
  186048. pNew->aFirst = (Fts5CResult*)&pNew->aSeg[nSlot];
  186049. pNew->pIndex = p;
  186050. pNew->xSetOutputs = fts5IterSetOutputs_Noop;
  186051. }
  186052. return pNew;
  186053. }
  186054. static void fts5PoslistCallback(
  186055. Fts5Index *pUnused,
  186056. void *pContext,
  186057. const u8 *pChunk, int nChunk
  186058. ){
  186059. UNUSED_PARAM(pUnused);
  186060. assert_nc( nChunk>=0 );
  186061. if( nChunk>0 ){
  186062. fts5BufferSafeAppendBlob((Fts5Buffer*)pContext, pChunk, nChunk);
  186063. }
  186064. }
  186065. typedef struct PoslistCallbackCtx PoslistCallbackCtx;
  186066. struct PoslistCallbackCtx {
  186067. Fts5Buffer *pBuf; /* Append to this buffer */
  186068. Fts5Colset *pColset; /* Restrict matches to this column */
  186069. int eState; /* See above */
  186070. };
  186071. typedef struct PoslistOffsetsCtx PoslistOffsetsCtx;
  186072. struct PoslistOffsetsCtx {
  186073. Fts5Buffer *pBuf; /* Append to this buffer */
  186074. Fts5Colset *pColset; /* Restrict matches to this column */
  186075. int iRead;
  186076. int iWrite;
  186077. };
  186078. /*
  186079. ** TODO: Make this more efficient!
  186080. */
  186081. static int fts5IndexColsetTest(Fts5Colset *pColset, int iCol){
  186082. int i;
  186083. for(i=0; i<pColset->nCol; i++){
  186084. if( pColset->aiCol[i]==iCol ) return 1;
  186085. }
  186086. return 0;
  186087. }
  186088. static void fts5PoslistOffsetsCallback(
  186089. Fts5Index *pUnused,
  186090. void *pContext,
  186091. const u8 *pChunk, int nChunk
  186092. ){
  186093. PoslistOffsetsCtx *pCtx = (PoslistOffsetsCtx*)pContext;
  186094. UNUSED_PARAM(pUnused);
  186095. assert_nc( nChunk>=0 );
  186096. if( nChunk>0 ){
  186097. int i = 0;
  186098. while( i<nChunk ){
  186099. int iVal;
  186100. i += fts5GetVarint32(&pChunk[i], iVal);
  186101. iVal += pCtx->iRead - 2;
  186102. pCtx->iRead = iVal;
  186103. if( fts5IndexColsetTest(pCtx->pColset, iVal) ){
  186104. fts5BufferSafeAppendVarint(pCtx->pBuf, iVal + 2 - pCtx->iWrite);
  186105. pCtx->iWrite = iVal;
  186106. }
  186107. }
  186108. }
  186109. }
  186110. static void fts5PoslistFilterCallback(
  186111. Fts5Index *pUnused,
  186112. void *pContext,
  186113. const u8 *pChunk, int nChunk
  186114. ){
  186115. PoslistCallbackCtx *pCtx = (PoslistCallbackCtx*)pContext;
  186116. UNUSED_PARAM(pUnused);
  186117. assert_nc( nChunk>=0 );
  186118. if( nChunk>0 ){
  186119. /* Search through to find the first varint with value 1. This is the
  186120. ** start of the next columns hits. */
  186121. int i = 0;
  186122. int iStart = 0;
  186123. if( pCtx->eState==2 ){
  186124. int iCol;
  186125. fts5FastGetVarint32(pChunk, i, iCol);
  186126. if( fts5IndexColsetTest(pCtx->pColset, iCol) ){
  186127. pCtx->eState = 1;
  186128. fts5BufferSafeAppendVarint(pCtx->pBuf, 1);
  186129. }else{
  186130. pCtx->eState = 0;
  186131. }
  186132. }
  186133. do {
  186134. while( i<nChunk && pChunk[i]!=0x01 ){
  186135. while( pChunk[i] & 0x80 ) i++;
  186136. i++;
  186137. }
  186138. if( pCtx->eState ){
  186139. fts5BufferSafeAppendBlob(pCtx->pBuf, &pChunk[iStart], i-iStart);
  186140. }
  186141. if( i<nChunk ){
  186142. int iCol;
  186143. iStart = i;
  186144. i++;
  186145. if( i>=nChunk ){
  186146. pCtx->eState = 2;
  186147. }else{
  186148. fts5FastGetVarint32(pChunk, i, iCol);
  186149. pCtx->eState = fts5IndexColsetTest(pCtx->pColset, iCol);
  186150. if( pCtx->eState ){
  186151. fts5BufferSafeAppendBlob(pCtx->pBuf, &pChunk[iStart], i-iStart);
  186152. iStart = i;
  186153. }
  186154. }
  186155. }
  186156. }while( i<nChunk );
  186157. }
  186158. }
  186159. static void fts5ChunkIterate(
  186160. Fts5Index *p, /* Index object */
  186161. Fts5SegIter *pSeg, /* Poslist of this iterator */
  186162. void *pCtx, /* Context pointer for xChunk callback */
  186163. void (*xChunk)(Fts5Index*, void*, const u8*, int)
  186164. ){
  186165. int nRem = pSeg->nPos; /* Number of bytes still to come */
  186166. Fts5Data *pData = 0;
  186167. u8 *pChunk = &pSeg->pLeaf->p[pSeg->iLeafOffset];
  186168. int nChunk = MIN(nRem, pSeg->pLeaf->szLeaf - pSeg->iLeafOffset);
  186169. int pgno = pSeg->iLeafPgno;
  186170. int pgnoSave = 0;
  186171. /* This function does notmwork with detail=none databases. */
  186172. assert( p->pConfig->eDetail!=FTS5_DETAIL_NONE );
  186173. if( (pSeg->flags & FTS5_SEGITER_REVERSE)==0 ){
  186174. pgnoSave = pgno+1;
  186175. }
  186176. while( 1 ){
  186177. xChunk(p, pCtx, pChunk, nChunk);
  186178. nRem -= nChunk;
  186179. fts5DataRelease(pData);
  186180. if( nRem<=0 ){
  186181. break;
  186182. }else{
  186183. pgno++;
  186184. pData = fts5LeafRead(p, FTS5_SEGMENT_ROWID(pSeg->pSeg->iSegid, pgno));
  186185. if( pData==0 ) break;
  186186. pChunk = &pData->p[4];
  186187. nChunk = MIN(nRem, pData->szLeaf - 4);
  186188. if( pgno==pgnoSave ){
  186189. assert( pSeg->pNextLeaf==0 );
  186190. pSeg->pNextLeaf = pData;
  186191. pData = 0;
  186192. }
  186193. }
  186194. }
  186195. }
  186196. /*
  186197. ** Iterator pIter currently points to a valid entry (not EOF). This
  186198. ** function appends the position list data for the current entry to
  186199. ** buffer pBuf. It does not make a copy of the position-list size
  186200. ** field.
  186201. */
  186202. static void fts5SegiterPoslist(
  186203. Fts5Index *p,
  186204. Fts5SegIter *pSeg,
  186205. Fts5Colset *pColset,
  186206. Fts5Buffer *pBuf
  186207. ){
  186208. if( 0==fts5BufferGrow(&p->rc, pBuf, pSeg->nPos) ){
  186209. if( pColset==0 ){
  186210. fts5ChunkIterate(p, pSeg, (void*)pBuf, fts5PoslistCallback);
  186211. }else{
  186212. if( p->pConfig->eDetail==FTS5_DETAIL_FULL ){
  186213. PoslistCallbackCtx sCtx;
  186214. sCtx.pBuf = pBuf;
  186215. sCtx.pColset = pColset;
  186216. sCtx.eState = fts5IndexColsetTest(pColset, 0);
  186217. assert( sCtx.eState==0 || sCtx.eState==1 );
  186218. fts5ChunkIterate(p, pSeg, (void*)&sCtx, fts5PoslistFilterCallback);
  186219. }else{
  186220. PoslistOffsetsCtx sCtx;
  186221. memset(&sCtx, 0, sizeof(sCtx));
  186222. sCtx.pBuf = pBuf;
  186223. sCtx.pColset = pColset;
  186224. fts5ChunkIterate(p, pSeg, (void*)&sCtx, fts5PoslistOffsetsCallback);
  186225. }
  186226. }
  186227. }
  186228. }
  186229. /*
  186230. ** IN/OUT parameter (*pa) points to a position list n bytes in size. If
  186231. ** the position list contains entries for column iCol, then (*pa) is set
  186232. ** to point to the sub-position-list for that column and the number of
  186233. ** bytes in it returned. Or, if the argument position list does not
  186234. ** contain any entries for column iCol, return 0.
  186235. */
  186236. static int fts5IndexExtractCol(
  186237. const u8 **pa, /* IN/OUT: Pointer to poslist */
  186238. int n, /* IN: Size of poslist in bytes */
  186239. int iCol /* Column to extract from poslist */
  186240. ){
  186241. int iCurrent = 0; /* Anything before the first 0x01 is col 0 */
  186242. const u8 *p = *pa;
  186243. const u8 *pEnd = &p[n]; /* One byte past end of position list */
  186244. while( iCol>iCurrent ){
  186245. /* Advance pointer p until it points to pEnd or an 0x01 byte that is
  186246. ** not part of a varint. Note that it is not possible for a negative
  186247. ** or extremely large varint to occur within an uncorrupted position
  186248. ** list. So the last byte of each varint may be assumed to have a clear
  186249. ** 0x80 bit. */
  186250. while( *p!=0x01 ){
  186251. while( *p++ & 0x80 );
  186252. if( p>=pEnd ) return 0;
  186253. }
  186254. *pa = p++;
  186255. iCurrent = *p++;
  186256. if( iCurrent & 0x80 ){
  186257. p--;
  186258. p += fts5GetVarint32(p, iCurrent);
  186259. }
  186260. }
  186261. if( iCol!=iCurrent ) return 0;
  186262. /* Advance pointer p until it points to pEnd or an 0x01 byte that is
  186263. ** not part of a varint */
  186264. while( p<pEnd && *p!=0x01 ){
  186265. while( *p++ & 0x80 );
  186266. }
  186267. return p - (*pa);
  186268. }
  186269. static void fts5IndexExtractColset(
  186270. int *pRc,
  186271. Fts5Colset *pColset, /* Colset to filter on */
  186272. const u8 *pPos, int nPos, /* Position list */
  186273. Fts5Buffer *pBuf /* Output buffer */
  186274. ){
  186275. if( *pRc==SQLITE_OK ){
  186276. int i;
  186277. fts5BufferZero(pBuf);
  186278. for(i=0; i<pColset->nCol; i++){
  186279. const u8 *pSub = pPos;
  186280. int nSub = fts5IndexExtractCol(&pSub, nPos, pColset->aiCol[i]);
  186281. if( nSub ){
  186282. fts5BufferAppendBlob(pRc, pBuf, nSub, pSub);
  186283. }
  186284. }
  186285. }
  186286. }
  186287. /*
  186288. ** xSetOutputs callback used by detail=none tables.
  186289. */
  186290. static void fts5IterSetOutputs_None(Fts5Iter *pIter, Fts5SegIter *pSeg){
  186291. assert( pIter->pIndex->pConfig->eDetail==FTS5_DETAIL_NONE );
  186292. pIter->base.iRowid = pSeg->iRowid;
  186293. pIter->base.nData = pSeg->nPos;
  186294. }
  186295. /*
  186296. ** xSetOutputs callback used by detail=full and detail=col tables when no
  186297. ** column filters are specified.
  186298. */
  186299. static void fts5IterSetOutputs_Nocolset(Fts5Iter *pIter, Fts5SegIter *pSeg){
  186300. pIter->base.iRowid = pSeg->iRowid;
  186301. pIter->base.nData = pSeg->nPos;
  186302. assert( pIter->pIndex->pConfig->eDetail!=FTS5_DETAIL_NONE );
  186303. assert( pIter->pColset==0 );
  186304. if( pSeg->iLeafOffset+pSeg->nPos<=pSeg->pLeaf->szLeaf ){
  186305. /* All data is stored on the current page. Populate the output
  186306. ** variables to point into the body of the page object. */
  186307. pIter->base.pData = &pSeg->pLeaf->p[pSeg->iLeafOffset];
  186308. }else{
  186309. /* The data is distributed over two or more pages. Copy it into the
  186310. ** Fts5Iter.poslist buffer and then set the output pointer to point
  186311. ** to this buffer. */
  186312. fts5BufferZero(&pIter->poslist);
  186313. fts5SegiterPoslist(pIter->pIndex, pSeg, 0, &pIter->poslist);
  186314. pIter->base.pData = pIter->poslist.p;
  186315. }
  186316. }
  186317. /*
  186318. ** xSetOutputs callback used when the Fts5Colset object has nCol==0 (match
  186319. ** against no columns at all).
  186320. */
  186321. static void fts5IterSetOutputs_ZeroColset(Fts5Iter *pIter, Fts5SegIter *pSeg){
  186322. UNUSED_PARAM(pSeg);
  186323. pIter->base.nData = 0;
  186324. }
  186325. /*
  186326. ** xSetOutputs callback used by detail=col when there is a column filter
  186327. ** and there are 100 or more columns. Also called as a fallback from
  186328. ** fts5IterSetOutputs_Col100 if the column-list spans more than one page.
  186329. */
  186330. static void fts5IterSetOutputs_Col(Fts5Iter *pIter, Fts5SegIter *pSeg){
  186331. fts5BufferZero(&pIter->poslist);
  186332. fts5SegiterPoslist(pIter->pIndex, pSeg, pIter->pColset, &pIter->poslist);
  186333. pIter->base.iRowid = pSeg->iRowid;
  186334. pIter->base.pData = pIter->poslist.p;
  186335. pIter->base.nData = pIter->poslist.n;
  186336. }
  186337. /*
  186338. ** xSetOutputs callback used when:
  186339. **
  186340. ** * detail=col,
  186341. ** * there is a column filter, and
  186342. ** * the table contains 100 or fewer columns.
  186343. **
  186344. ** The last point is to ensure all column numbers are stored as
  186345. ** single-byte varints.
  186346. */
  186347. static void fts5IterSetOutputs_Col100(Fts5Iter *pIter, Fts5SegIter *pSeg){
  186348. assert( pIter->pIndex->pConfig->eDetail==FTS5_DETAIL_COLUMNS );
  186349. assert( pIter->pColset );
  186350. if( pSeg->iLeafOffset+pSeg->nPos>pSeg->pLeaf->szLeaf ){
  186351. fts5IterSetOutputs_Col(pIter, pSeg);
  186352. }else{
  186353. u8 *a = (u8*)&pSeg->pLeaf->p[pSeg->iLeafOffset];
  186354. u8 *pEnd = (u8*)&a[pSeg->nPos];
  186355. int iPrev = 0;
  186356. int *aiCol = pIter->pColset->aiCol;
  186357. int *aiColEnd = &aiCol[pIter->pColset->nCol];
  186358. u8 *aOut = pIter->poslist.p;
  186359. int iPrevOut = 0;
  186360. pIter->base.iRowid = pSeg->iRowid;
  186361. while( a<pEnd ){
  186362. iPrev += (int)a++[0] - 2;
  186363. while( *aiCol<iPrev ){
  186364. aiCol++;
  186365. if( aiCol==aiColEnd ) goto setoutputs_col_out;
  186366. }
  186367. if( *aiCol==iPrev ){
  186368. *aOut++ = (u8)((iPrev - iPrevOut) + 2);
  186369. iPrevOut = iPrev;
  186370. }
  186371. }
  186372. setoutputs_col_out:
  186373. pIter->base.pData = pIter->poslist.p;
  186374. pIter->base.nData = aOut - pIter->poslist.p;
  186375. }
  186376. }
  186377. /*
  186378. ** xSetOutputs callback used by detail=full when there is a column filter.
  186379. */
  186380. static void fts5IterSetOutputs_Full(Fts5Iter *pIter, Fts5SegIter *pSeg){
  186381. Fts5Colset *pColset = pIter->pColset;
  186382. pIter->base.iRowid = pSeg->iRowid;
  186383. assert( pIter->pIndex->pConfig->eDetail==FTS5_DETAIL_FULL );
  186384. assert( pColset );
  186385. if( pSeg->iLeafOffset+pSeg->nPos<=pSeg->pLeaf->szLeaf ){
  186386. /* All data is stored on the current page. Populate the output
  186387. ** variables to point into the body of the page object. */
  186388. const u8 *a = &pSeg->pLeaf->p[pSeg->iLeafOffset];
  186389. if( pColset->nCol==1 ){
  186390. pIter->base.nData = fts5IndexExtractCol(&a, pSeg->nPos,pColset->aiCol[0]);
  186391. pIter->base.pData = a;
  186392. }else{
  186393. int *pRc = &pIter->pIndex->rc;
  186394. fts5BufferZero(&pIter->poslist);
  186395. fts5IndexExtractColset(pRc, pColset, a, pSeg->nPos, &pIter->poslist);
  186396. pIter->base.pData = pIter->poslist.p;
  186397. pIter->base.nData = pIter->poslist.n;
  186398. }
  186399. }else{
  186400. /* The data is distributed over two or more pages. Copy it into the
  186401. ** Fts5Iter.poslist buffer and then set the output pointer to point
  186402. ** to this buffer. */
  186403. fts5BufferZero(&pIter->poslist);
  186404. fts5SegiterPoslist(pIter->pIndex, pSeg, pColset, &pIter->poslist);
  186405. pIter->base.pData = pIter->poslist.p;
  186406. pIter->base.nData = pIter->poslist.n;
  186407. }
  186408. }
  186409. static void fts5IterSetOutputCb(int *pRc, Fts5Iter *pIter){
  186410. if( *pRc==SQLITE_OK ){
  186411. Fts5Config *pConfig = pIter->pIndex->pConfig;
  186412. if( pConfig->eDetail==FTS5_DETAIL_NONE ){
  186413. pIter->xSetOutputs = fts5IterSetOutputs_None;
  186414. }
  186415. else if( pIter->pColset==0 ){
  186416. pIter->xSetOutputs = fts5IterSetOutputs_Nocolset;
  186417. }
  186418. else if( pIter->pColset->nCol==0 ){
  186419. pIter->xSetOutputs = fts5IterSetOutputs_ZeroColset;
  186420. }
  186421. else if( pConfig->eDetail==FTS5_DETAIL_FULL ){
  186422. pIter->xSetOutputs = fts5IterSetOutputs_Full;
  186423. }
  186424. else{
  186425. assert( pConfig->eDetail==FTS5_DETAIL_COLUMNS );
  186426. if( pConfig->nCol<=100 ){
  186427. pIter->xSetOutputs = fts5IterSetOutputs_Col100;
  186428. sqlite3Fts5BufferSize(pRc, &pIter->poslist, pConfig->nCol);
  186429. }else{
  186430. pIter->xSetOutputs = fts5IterSetOutputs_Col;
  186431. }
  186432. }
  186433. }
  186434. }
  186435. /*
  186436. ** Allocate a new Fts5Iter object.
  186437. **
  186438. ** The new object will be used to iterate through data in structure pStruct.
  186439. ** If iLevel is -ve, then all data in all segments is merged. Or, if iLevel
  186440. ** is zero or greater, data from the first nSegment segments on level iLevel
  186441. ** is merged.
  186442. **
  186443. ** The iterator initially points to the first term/rowid entry in the
  186444. ** iterated data.
  186445. */
  186446. static void fts5MultiIterNew(
  186447. Fts5Index *p, /* FTS5 backend to iterate within */
  186448. Fts5Structure *pStruct, /* Structure of specific index */
  186449. int flags, /* FTS5INDEX_QUERY_XXX flags */
  186450. Fts5Colset *pColset, /* Colset to filter on (or NULL) */
  186451. const u8 *pTerm, int nTerm, /* Term to seek to (or NULL/0) */
  186452. int iLevel, /* Level to iterate (-1 for all) */
  186453. int nSegment, /* Number of segments to merge (iLevel>=0) */
  186454. Fts5Iter **ppOut /* New object */
  186455. ){
  186456. int nSeg = 0; /* Number of segment-iters in use */
  186457. int iIter = 0; /* */
  186458. int iSeg; /* Used to iterate through segments */
  186459. Fts5StructureLevel *pLvl;
  186460. Fts5Iter *pNew;
  186461. assert( (pTerm==0 && nTerm==0) || iLevel<0 );
  186462. /* Allocate space for the new multi-seg-iterator. */
  186463. if( p->rc==SQLITE_OK ){
  186464. if( iLevel<0 ){
  186465. assert( pStruct->nSegment==fts5StructureCountSegments(pStruct) );
  186466. nSeg = pStruct->nSegment;
  186467. nSeg += (p->pHash ? 1 : 0);
  186468. }else{
  186469. nSeg = MIN(pStruct->aLevel[iLevel].nSeg, nSegment);
  186470. }
  186471. }
  186472. *ppOut = pNew = fts5MultiIterAlloc(p, nSeg);
  186473. if( pNew==0 ) return;
  186474. pNew->bRev = (0!=(flags & FTS5INDEX_QUERY_DESC));
  186475. pNew->bSkipEmpty = (0!=(flags & FTS5INDEX_QUERY_SKIPEMPTY));
  186476. pNew->pStruct = pStruct;
  186477. pNew->pColset = pColset;
  186478. fts5StructureRef(pStruct);
  186479. if( (flags & FTS5INDEX_QUERY_NOOUTPUT)==0 ){
  186480. fts5IterSetOutputCb(&p->rc, pNew);
  186481. }
  186482. /* Initialize each of the component segment iterators. */
  186483. if( p->rc==SQLITE_OK ){
  186484. if( iLevel<0 ){
  186485. Fts5StructureLevel *pEnd = &pStruct->aLevel[pStruct->nLevel];
  186486. if( p->pHash ){
  186487. /* Add a segment iterator for the current contents of the hash table. */
  186488. Fts5SegIter *pIter = &pNew->aSeg[iIter++];
  186489. fts5SegIterHashInit(p, pTerm, nTerm, flags, pIter);
  186490. }
  186491. for(pLvl=&pStruct->aLevel[0]; pLvl<pEnd; pLvl++){
  186492. for(iSeg=pLvl->nSeg-1; iSeg>=0; iSeg--){
  186493. Fts5StructureSegment *pSeg = &pLvl->aSeg[iSeg];
  186494. Fts5SegIter *pIter = &pNew->aSeg[iIter++];
  186495. if( pTerm==0 ){
  186496. fts5SegIterInit(p, pSeg, pIter);
  186497. }else{
  186498. fts5SegIterSeekInit(p, pTerm, nTerm, flags, pSeg, pIter);
  186499. }
  186500. }
  186501. }
  186502. }else{
  186503. pLvl = &pStruct->aLevel[iLevel];
  186504. for(iSeg=nSeg-1; iSeg>=0; iSeg--){
  186505. fts5SegIterInit(p, &pLvl->aSeg[iSeg], &pNew->aSeg[iIter++]);
  186506. }
  186507. }
  186508. assert( iIter==nSeg );
  186509. }
  186510. /* If the above was successful, each component iterators now points
  186511. ** to the first entry in its segment. In this case initialize the
  186512. ** aFirst[] array. Or, if an error has occurred, free the iterator
  186513. ** object and set the output variable to NULL. */
  186514. if( p->rc==SQLITE_OK ){
  186515. for(iIter=pNew->nSeg-1; iIter>0; iIter--){
  186516. int iEq;
  186517. if( (iEq = fts5MultiIterDoCompare(pNew, iIter)) ){
  186518. Fts5SegIter *pSeg = &pNew->aSeg[iEq];
  186519. if( p->rc==SQLITE_OK ) pSeg->xNext(p, pSeg, 0);
  186520. fts5MultiIterAdvanced(p, pNew, iEq, iIter);
  186521. }
  186522. }
  186523. fts5MultiIterSetEof(pNew);
  186524. fts5AssertMultiIterSetup(p, pNew);
  186525. if( pNew->bSkipEmpty && fts5MultiIterIsEmpty(p, pNew) ){
  186526. fts5MultiIterNext(p, pNew, 0, 0);
  186527. }else if( pNew->base.bEof==0 ){
  186528. Fts5SegIter *pSeg = &pNew->aSeg[pNew->aFirst[1].iFirst];
  186529. pNew->xSetOutputs(pNew, pSeg);
  186530. }
  186531. }else{
  186532. fts5MultiIterFree(pNew);
  186533. *ppOut = 0;
  186534. }
  186535. }
  186536. /*
  186537. ** Create an Fts5Iter that iterates through the doclist provided
  186538. ** as the second argument.
  186539. */
  186540. static void fts5MultiIterNew2(
  186541. Fts5Index *p, /* FTS5 backend to iterate within */
  186542. Fts5Data *pData, /* Doclist to iterate through */
  186543. int bDesc, /* True for descending rowid order */
  186544. Fts5Iter **ppOut /* New object */
  186545. ){
  186546. Fts5Iter *pNew;
  186547. pNew = fts5MultiIterAlloc(p, 2);
  186548. if( pNew ){
  186549. Fts5SegIter *pIter = &pNew->aSeg[1];
  186550. pIter->flags = FTS5_SEGITER_ONETERM;
  186551. if( pData->szLeaf>0 ){
  186552. pIter->pLeaf = pData;
  186553. pIter->iLeafOffset = fts5GetVarint(pData->p, (u64*)&pIter->iRowid);
  186554. pIter->iEndofDoclist = pData->nn;
  186555. pNew->aFirst[1].iFirst = 1;
  186556. if( bDesc ){
  186557. pNew->bRev = 1;
  186558. pIter->flags |= FTS5_SEGITER_REVERSE;
  186559. fts5SegIterReverseInitPage(p, pIter);
  186560. }else{
  186561. fts5SegIterLoadNPos(p, pIter);
  186562. }
  186563. pData = 0;
  186564. }else{
  186565. pNew->base.bEof = 1;
  186566. }
  186567. fts5SegIterSetNext(p, pIter);
  186568. *ppOut = pNew;
  186569. }
  186570. fts5DataRelease(pData);
  186571. }
  186572. /*
  186573. ** Return true if the iterator is at EOF or if an error has occurred.
  186574. ** False otherwise.
  186575. */
  186576. static int fts5MultiIterEof(Fts5Index *p, Fts5Iter *pIter){
  186577. assert( p->rc
  186578. || (pIter->aSeg[ pIter->aFirst[1].iFirst ].pLeaf==0)==pIter->base.bEof
  186579. );
  186580. return (p->rc || pIter->base.bEof);
  186581. }
  186582. /*
  186583. ** Return the rowid of the entry that the iterator currently points
  186584. ** to. If the iterator points to EOF when this function is called the
  186585. ** results are undefined.
  186586. */
  186587. static i64 fts5MultiIterRowid(Fts5Iter *pIter){
  186588. assert( pIter->aSeg[ pIter->aFirst[1].iFirst ].pLeaf );
  186589. return pIter->aSeg[ pIter->aFirst[1].iFirst ].iRowid;
  186590. }
  186591. /*
  186592. ** Move the iterator to the next entry at or following iMatch.
  186593. */
  186594. static void fts5MultiIterNextFrom(
  186595. Fts5Index *p,
  186596. Fts5Iter *pIter,
  186597. i64 iMatch
  186598. ){
  186599. while( 1 ){
  186600. i64 iRowid;
  186601. fts5MultiIterNext(p, pIter, 1, iMatch);
  186602. if( fts5MultiIterEof(p, pIter) ) break;
  186603. iRowid = fts5MultiIterRowid(pIter);
  186604. if( pIter->bRev==0 && iRowid>=iMatch ) break;
  186605. if( pIter->bRev!=0 && iRowid<=iMatch ) break;
  186606. }
  186607. }
  186608. /*
  186609. ** Return a pointer to a buffer containing the term associated with the
  186610. ** entry that the iterator currently points to.
  186611. */
  186612. static const u8 *fts5MultiIterTerm(Fts5Iter *pIter, int *pn){
  186613. Fts5SegIter *p = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  186614. *pn = p->term.n;
  186615. return p->term.p;
  186616. }
  186617. /*
  186618. ** Allocate a new segment-id for the structure pStruct. The new segment
  186619. ** id must be between 1 and 65335 inclusive, and must not be used by
  186620. ** any currently existing segment. If a free segment id cannot be found,
  186621. ** SQLITE_FULL is returned.
  186622. **
  186623. ** If an error has already occurred, this function is a no-op. 0 is
  186624. ** returned in this case.
  186625. */
  186626. static int fts5AllocateSegid(Fts5Index *p, Fts5Structure *pStruct){
  186627. int iSegid = 0;
  186628. if( p->rc==SQLITE_OK ){
  186629. if( pStruct->nSegment>=FTS5_MAX_SEGMENT ){
  186630. p->rc = SQLITE_FULL;
  186631. }else{
  186632. /* FTS5_MAX_SEGMENT is currently defined as 2000. So the following
  186633. ** array is 63 elements, or 252 bytes, in size. */
  186634. u32 aUsed[(FTS5_MAX_SEGMENT+31) / 32];
  186635. int iLvl, iSeg;
  186636. int i;
  186637. u32 mask;
  186638. memset(aUsed, 0, sizeof(aUsed));
  186639. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  186640. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  186641. int iId = pStruct->aLevel[iLvl].aSeg[iSeg].iSegid;
  186642. if( iId<=FTS5_MAX_SEGMENT ){
  186643. aUsed[(iId-1) / 32] |= 1 << ((iId-1) % 32);
  186644. }
  186645. }
  186646. }
  186647. for(i=0; aUsed[i]==0xFFFFFFFF; i++);
  186648. mask = aUsed[i];
  186649. for(iSegid=0; mask & (1 << iSegid); iSegid++);
  186650. iSegid += 1 + i*32;
  186651. #ifdef SQLITE_DEBUG
  186652. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  186653. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  186654. assert( iSegid!=pStruct->aLevel[iLvl].aSeg[iSeg].iSegid );
  186655. }
  186656. }
  186657. assert( iSegid>0 && iSegid<=FTS5_MAX_SEGMENT );
  186658. {
  186659. sqlite3_stmt *pIdxSelect = fts5IdxSelectStmt(p);
  186660. if( p->rc==SQLITE_OK ){
  186661. u8 aBlob[2] = {0xff, 0xff};
  186662. sqlite3_bind_int(pIdxSelect, 1, iSegid);
  186663. sqlite3_bind_blob(pIdxSelect, 2, aBlob, 2, SQLITE_STATIC);
  186664. assert( sqlite3_step(pIdxSelect)!=SQLITE_ROW );
  186665. p->rc = sqlite3_reset(pIdxSelect);
  186666. sqlite3_bind_null(pIdxSelect, 2);
  186667. }
  186668. }
  186669. #endif
  186670. }
  186671. }
  186672. return iSegid;
  186673. }
  186674. /*
  186675. ** Discard all data currently cached in the hash-tables.
  186676. */
  186677. static void fts5IndexDiscardData(Fts5Index *p){
  186678. assert( p->pHash || p->nPendingData==0 );
  186679. if( p->pHash ){
  186680. sqlite3Fts5HashClear(p->pHash);
  186681. p->nPendingData = 0;
  186682. }
  186683. }
  186684. /*
  186685. ** Return the size of the prefix, in bytes, that buffer
  186686. ** (pNew/<length-unknown>) shares with buffer (pOld/nOld).
  186687. **
  186688. ** Buffer (pNew/<length-unknown>) is guaranteed to be greater
  186689. ** than buffer (pOld/nOld).
  186690. */
  186691. static int fts5PrefixCompress(int nOld, const u8 *pOld, const u8 *pNew){
  186692. int i;
  186693. for(i=0; i<nOld; i++){
  186694. if( pOld[i]!=pNew[i] ) break;
  186695. }
  186696. return i;
  186697. }
  186698. static void fts5WriteDlidxClear(
  186699. Fts5Index *p,
  186700. Fts5SegWriter *pWriter,
  186701. int bFlush /* If true, write dlidx to disk */
  186702. ){
  186703. int i;
  186704. assert( bFlush==0 || (pWriter->nDlidx>0 && pWriter->aDlidx[0].buf.n>0) );
  186705. for(i=0; i<pWriter->nDlidx; i++){
  186706. Fts5DlidxWriter *pDlidx = &pWriter->aDlidx[i];
  186707. if( pDlidx->buf.n==0 ) break;
  186708. if( bFlush ){
  186709. assert( pDlidx->pgno!=0 );
  186710. fts5DataWrite(p,
  186711. FTS5_DLIDX_ROWID(pWriter->iSegid, i, pDlidx->pgno),
  186712. pDlidx->buf.p, pDlidx->buf.n
  186713. );
  186714. }
  186715. sqlite3Fts5BufferZero(&pDlidx->buf);
  186716. pDlidx->bPrevValid = 0;
  186717. }
  186718. }
  186719. /*
  186720. ** Grow the pWriter->aDlidx[] array to at least nLvl elements in size.
  186721. ** Any new array elements are zeroed before returning.
  186722. */
  186723. static int fts5WriteDlidxGrow(
  186724. Fts5Index *p,
  186725. Fts5SegWriter *pWriter,
  186726. int nLvl
  186727. ){
  186728. if( p->rc==SQLITE_OK && nLvl>=pWriter->nDlidx ){
  186729. Fts5DlidxWriter *aDlidx = (Fts5DlidxWriter*)sqlite3_realloc(
  186730. pWriter->aDlidx, sizeof(Fts5DlidxWriter) * nLvl
  186731. );
  186732. if( aDlidx==0 ){
  186733. p->rc = SQLITE_NOMEM;
  186734. }else{
  186735. int nByte = sizeof(Fts5DlidxWriter) * (nLvl - pWriter->nDlidx);
  186736. memset(&aDlidx[pWriter->nDlidx], 0, nByte);
  186737. pWriter->aDlidx = aDlidx;
  186738. pWriter->nDlidx = nLvl;
  186739. }
  186740. }
  186741. return p->rc;
  186742. }
  186743. /*
  186744. ** If the current doclist-index accumulating in pWriter->aDlidx[] is large
  186745. ** enough, flush it to disk and return 1. Otherwise discard it and return
  186746. ** zero.
  186747. */
  186748. static int fts5WriteFlushDlidx(Fts5Index *p, Fts5SegWriter *pWriter){
  186749. int bFlag = 0;
  186750. /* If there were FTS5_MIN_DLIDX_SIZE or more empty leaf pages written
  186751. ** to the database, also write the doclist-index to disk. */
  186752. if( pWriter->aDlidx[0].buf.n>0 && pWriter->nEmpty>=FTS5_MIN_DLIDX_SIZE ){
  186753. bFlag = 1;
  186754. }
  186755. fts5WriteDlidxClear(p, pWriter, bFlag);
  186756. pWriter->nEmpty = 0;
  186757. return bFlag;
  186758. }
  186759. /*
  186760. ** This function is called whenever processing of the doclist for the
  186761. ** last term on leaf page (pWriter->iBtPage) is completed.
  186762. **
  186763. ** The doclist-index for that term is currently stored in-memory within the
  186764. ** Fts5SegWriter.aDlidx[] array. If it is large enough, this function
  186765. ** writes it out to disk. Or, if it is too small to bother with, discards
  186766. ** it.
  186767. **
  186768. ** Fts5SegWriter.btterm currently contains the first term on page iBtPage.
  186769. */
  186770. static void fts5WriteFlushBtree(Fts5Index *p, Fts5SegWriter *pWriter){
  186771. int bFlag;
  186772. assert( pWriter->iBtPage || pWriter->nEmpty==0 );
  186773. if( pWriter->iBtPage==0 ) return;
  186774. bFlag = fts5WriteFlushDlidx(p, pWriter);
  186775. if( p->rc==SQLITE_OK ){
  186776. const char *z = (pWriter->btterm.n>0?(const char*)pWriter->btterm.p:"");
  186777. /* The following was already done in fts5WriteInit(): */
  186778. /* sqlite3_bind_int(p->pIdxWriter, 1, pWriter->iSegid); */
  186779. sqlite3_bind_blob(p->pIdxWriter, 2, z, pWriter->btterm.n, SQLITE_STATIC);
  186780. sqlite3_bind_int64(p->pIdxWriter, 3, bFlag + ((i64)pWriter->iBtPage<<1));
  186781. sqlite3_step(p->pIdxWriter);
  186782. p->rc = sqlite3_reset(p->pIdxWriter);
  186783. sqlite3_bind_null(p->pIdxWriter, 2);
  186784. }
  186785. pWriter->iBtPage = 0;
  186786. }
  186787. /*
  186788. ** This is called once for each leaf page except the first that contains
  186789. ** at least one term. Argument (nTerm/pTerm) is the split-key - a term that
  186790. ** is larger than all terms written to earlier leaves, and equal to or
  186791. ** smaller than the first term on the new leaf.
  186792. **
  186793. ** If an error occurs, an error code is left in Fts5Index.rc. If an error
  186794. ** has already occurred when this function is called, it is a no-op.
  186795. */
  186796. static void fts5WriteBtreeTerm(
  186797. Fts5Index *p, /* FTS5 backend object */
  186798. Fts5SegWriter *pWriter, /* Writer object */
  186799. int nTerm, const u8 *pTerm /* First term on new page */
  186800. ){
  186801. fts5WriteFlushBtree(p, pWriter);
  186802. fts5BufferSet(&p->rc, &pWriter->btterm, nTerm, pTerm);
  186803. pWriter->iBtPage = pWriter->writer.pgno;
  186804. }
  186805. /*
  186806. ** This function is called when flushing a leaf page that contains no
  186807. ** terms at all to disk.
  186808. */
  186809. static void fts5WriteBtreeNoTerm(
  186810. Fts5Index *p, /* FTS5 backend object */
  186811. Fts5SegWriter *pWriter /* Writer object */
  186812. ){
  186813. /* If there were no rowids on the leaf page either and the doclist-index
  186814. ** has already been started, append an 0x00 byte to it. */
  186815. if( pWriter->bFirstRowidInPage && pWriter->aDlidx[0].buf.n>0 ){
  186816. Fts5DlidxWriter *pDlidx = &pWriter->aDlidx[0];
  186817. assert( pDlidx->bPrevValid );
  186818. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, 0);
  186819. }
  186820. /* Increment the "number of sequential leaves without a term" counter. */
  186821. pWriter->nEmpty++;
  186822. }
  186823. static i64 fts5DlidxExtractFirstRowid(Fts5Buffer *pBuf){
  186824. i64 iRowid;
  186825. int iOff;
  186826. iOff = 1 + fts5GetVarint(&pBuf->p[1], (u64*)&iRowid);
  186827. fts5GetVarint(&pBuf->p[iOff], (u64*)&iRowid);
  186828. return iRowid;
  186829. }
  186830. /*
  186831. ** Rowid iRowid has just been appended to the current leaf page. It is the
  186832. ** first on the page. This function appends an appropriate entry to the current
  186833. ** doclist-index.
  186834. */
  186835. static void fts5WriteDlidxAppend(
  186836. Fts5Index *p,
  186837. Fts5SegWriter *pWriter,
  186838. i64 iRowid
  186839. ){
  186840. int i;
  186841. int bDone = 0;
  186842. for(i=0; p->rc==SQLITE_OK && bDone==0; i++){
  186843. i64 iVal;
  186844. Fts5DlidxWriter *pDlidx = &pWriter->aDlidx[i];
  186845. if( pDlidx->buf.n>=p->pConfig->pgsz ){
  186846. /* The current doclist-index page is full. Write it to disk and push
  186847. ** a copy of iRowid (which will become the first rowid on the next
  186848. ** doclist-index leaf page) up into the next level of the b-tree
  186849. ** hierarchy. If the node being flushed is currently the root node,
  186850. ** also push its first rowid upwards. */
  186851. pDlidx->buf.p[0] = 0x01; /* Not the root node */
  186852. fts5DataWrite(p,
  186853. FTS5_DLIDX_ROWID(pWriter->iSegid, i, pDlidx->pgno),
  186854. pDlidx->buf.p, pDlidx->buf.n
  186855. );
  186856. fts5WriteDlidxGrow(p, pWriter, i+2);
  186857. pDlidx = &pWriter->aDlidx[i];
  186858. if( p->rc==SQLITE_OK && pDlidx[1].buf.n==0 ){
  186859. i64 iFirst = fts5DlidxExtractFirstRowid(&pDlidx->buf);
  186860. /* This was the root node. Push its first rowid up to the new root. */
  186861. pDlidx[1].pgno = pDlidx->pgno;
  186862. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx[1].buf, 0);
  186863. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx[1].buf, pDlidx->pgno);
  186864. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx[1].buf, iFirst);
  186865. pDlidx[1].bPrevValid = 1;
  186866. pDlidx[1].iPrev = iFirst;
  186867. }
  186868. sqlite3Fts5BufferZero(&pDlidx->buf);
  186869. pDlidx->bPrevValid = 0;
  186870. pDlidx->pgno++;
  186871. }else{
  186872. bDone = 1;
  186873. }
  186874. if( pDlidx->bPrevValid ){
  186875. iVal = iRowid - pDlidx->iPrev;
  186876. }else{
  186877. i64 iPgno = (i==0 ? pWriter->writer.pgno : pDlidx[-1].pgno);
  186878. assert( pDlidx->buf.n==0 );
  186879. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, !bDone);
  186880. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, iPgno);
  186881. iVal = iRowid;
  186882. }
  186883. sqlite3Fts5BufferAppendVarint(&p->rc, &pDlidx->buf, iVal);
  186884. pDlidx->bPrevValid = 1;
  186885. pDlidx->iPrev = iRowid;
  186886. }
  186887. }
  186888. static void fts5WriteFlushLeaf(Fts5Index *p, Fts5SegWriter *pWriter){
  186889. static const u8 zero[] = { 0x00, 0x00, 0x00, 0x00 };
  186890. Fts5PageWriter *pPage = &pWriter->writer;
  186891. i64 iRowid;
  186892. assert( (pPage->pgidx.n==0)==(pWriter->bFirstTermInPage) );
  186893. /* Set the szLeaf header field. */
  186894. assert( 0==fts5GetU16(&pPage->buf.p[2]) );
  186895. fts5PutU16(&pPage->buf.p[2], (u16)pPage->buf.n);
  186896. if( pWriter->bFirstTermInPage ){
  186897. /* No term was written to this page. */
  186898. assert( pPage->pgidx.n==0 );
  186899. fts5WriteBtreeNoTerm(p, pWriter);
  186900. }else{
  186901. /* Append the pgidx to the page buffer. Set the szLeaf header field. */
  186902. fts5BufferAppendBlob(&p->rc, &pPage->buf, pPage->pgidx.n, pPage->pgidx.p);
  186903. }
  186904. /* Write the page out to disk */
  186905. iRowid = FTS5_SEGMENT_ROWID(pWriter->iSegid, pPage->pgno);
  186906. fts5DataWrite(p, iRowid, pPage->buf.p, pPage->buf.n);
  186907. /* Initialize the next page. */
  186908. fts5BufferZero(&pPage->buf);
  186909. fts5BufferZero(&pPage->pgidx);
  186910. fts5BufferAppendBlob(&p->rc, &pPage->buf, 4, zero);
  186911. pPage->iPrevPgidx = 0;
  186912. pPage->pgno++;
  186913. /* Increase the leaves written counter */
  186914. pWriter->nLeafWritten++;
  186915. /* The new leaf holds no terms or rowids */
  186916. pWriter->bFirstTermInPage = 1;
  186917. pWriter->bFirstRowidInPage = 1;
  186918. }
  186919. /*
  186920. ** Append term pTerm/nTerm to the segment being written by the writer passed
  186921. ** as the second argument.
  186922. **
  186923. ** If an error occurs, set the Fts5Index.rc error code. If an error has
  186924. ** already occurred, this function is a no-op.
  186925. */
  186926. static void fts5WriteAppendTerm(
  186927. Fts5Index *p,
  186928. Fts5SegWriter *pWriter,
  186929. int nTerm, const u8 *pTerm
  186930. ){
  186931. int nPrefix; /* Bytes of prefix compression for term */
  186932. Fts5PageWriter *pPage = &pWriter->writer;
  186933. Fts5Buffer *pPgidx = &pWriter->writer.pgidx;
  186934. assert( p->rc==SQLITE_OK );
  186935. assert( pPage->buf.n>=4 );
  186936. assert( pPage->buf.n>4 || pWriter->bFirstTermInPage );
  186937. /* If the current leaf page is full, flush it to disk. */
  186938. if( (pPage->buf.n + pPgidx->n + nTerm + 2)>=p->pConfig->pgsz ){
  186939. if( pPage->buf.n>4 ){
  186940. fts5WriteFlushLeaf(p, pWriter);
  186941. }
  186942. fts5BufferGrow(&p->rc, &pPage->buf, nTerm+FTS5_DATA_PADDING);
  186943. }
  186944. /* TODO1: Updating pgidx here. */
  186945. pPgidx->n += sqlite3Fts5PutVarint(
  186946. &pPgidx->p[pPgidx->n], pPage->buf.n - pPage->iPrevPgidx
  186947. );
  186948. pPage->iPrevPgidx = pPage->buf.n;
  186949. #if 0
  186950. fts5PutU16(&pPgidx->p[pPgidx->n], pPage->buf.n);
  186951. pPgidx->n += 2;
  186952. #endif
  186953. if( pWriter->bFirstTermInPage ){
  186954. nPrefix = 0;
  186955. if( pPage->pgno!=1 ){
  186956. /* This is the first term on a leaf that is not the leftmost leaf in
  186957. ** the segment b-tree. In this case it is necessary to add a term to
  186958. ** the b-tree hierarchy that is (a) larger than the largest term
  186959. ** already written to the segment and (b) smaller than or equal to
  186960. ** this term. In other words, a prefix of (pTerm/nTerm) that is one
  186961. ** byte longer than the longest prefix (pTerm/nTerm) shares with the
  186962. ** previous term.
  186963. **
  186964. ** Usually, the previous term is available in pPage->term. The exception
  186965. ** is if this is the first term written in an incremental-merge step.
  186966. ** In this case the previous term is not available, so just write a
  186967. ** copy of (pTerm/nTerm) into the parent node. This is slightly
  186968. ** inefficient, but still correct. */
  186969. int n = nTerm;
  186970. if( pPage->term.n ){
  186971. n = 1 + fts5PrefixCompress(pPage->term.n, pPage->term.p, pTerm);
  186972. }
  186973. fts5WriteBtreeTerm(p, pWriter, n, pTerm);
  186974. pPage = &pWriter->writer;
  186975. }
  186976. }else{
  186977. nPrefix = fts5PrefixCompress(pPage->term.n, pPage->term.p, pTerm);
  186978. fts5BufferAppendVarint(&p->rc, &pPage->buf, nPrefix);
  186979. }
  186980. /* Append the number of bytes of new data, then the term data itself
  186981. ** to the page. */
  186982. fts5BufferAppendVarint(&p->rc, &pPage->buf, nTerm - nPrefix);
  186983. fts5BufferAppendBlob(&p->rc, &pPage->buf, nTerm - nPrefix, &pTerm[nPrefix]);
  186984. /* Update the Fts5PageWriter.term field. */
  186985. fts5BufferSet(&p->rc, &pPage->term, nTerm, pTerm);
  186986. pWriter->bFirstTermInPage = 0;
  186987. pWriter->bFirstRowidInPage = 0;
  186988. pWriter->bFirstRowidInDoclist = 1;
  186989. assert( p->rc || (pWriter->nDlidx>0 && pWriter->aDlidx[0].buf.n==0) );
  186990. pWriter->aDlidx[0].pgno = pPage->pgno;
  186991. }
  186992. /*
  186993. ** Append a rowid and position-list size field to the writers output.
  186994. */
  186995. static void fts5WriteAppendRowid(
  186996. Fts5Index *p,
  186997. Fts5SegWriter *pWriter,
  186998. i64 iRowid
  186999. ){
  187000. if( p->rc==SQLITE_OK ){
  187001. Fts5PageWriter *pPage = &pWriter->writer;
  187002. if( (pPage->buf.n + pPage->pgidx.n)>=p->pConfig->pgsz ){
  187003. fts5WriteFlushLeaf(p, pWriter);
  187004. }
  187005. /* If this is to be the first rowid written to the page, set the
  187006. ** rowid-pointer in the page-header. Also append a value to the dlidx
  187007. ** buffer, in case a doclist-index is required. */
  187008. if( pWriter->bFirstRowidInPage ){
  187009. fts5PutU16(pPage->buf.p, (u16)pPage->buf.n);
  187010. fts5WriteDlidxAppend(p, pWriter, iRowid);
  187011. }
  187012. /* Write the rowid. */
  187013. if( pWriter->bFirstRowidInDoclist || pWriter->bFirstRowidInPage ){
  187014. fts5BufferAppendVarint(&p->rc, &pPage->buf, iRowid);
  187015. }else{
  187016. assert( p->rc || iRowid>pWriter->iPrevRowid );
  187017. fts5BufferAppendVarint(&p->rc, &pPage->buf, iRowid - pWriter->iPrevRowid);
  187018. }
  187019. pWriter->iPrevRowid = iRowid;
  187020. pWriter->bFirstRowidInDoclist = 0;
  187021. pWriter->bFirstRowidInPage = 0;
  187022. }
  187023. }
  187024. static void fts5WriteAppendPoslistData(
  187025. Fts5Index *p,
  187026. Fts5SegWriter *pWriter,
  187027. const u8 *aData,
  187028. int nData
  187029. ){
  187030. Fts5PageWriter *pPage = &pWriter->writer;
  187031. const u8 *a = aData;
  187032. int n = nData;
  187033. assert( p->pConfig->pgsz>0 );
  187034. while( p->rc==SQLITE_OK
  187035. && (pPage->buf.n + pPage->pgidx.n + n)>=p->pConfig->pgsz
  187036. ){
  187037. int nReq = p->pConfig->pgsz - pPage->buf.n - pPage->pgidx.n;
  187038. int nCopy = 0;
  187039. while( nCopy<nReq ){
  187040. i64 dummy;
  187041. nCopy += fts5GetVarint(&a[nCopy], (u64*)&dummy);
  187042. }
  187043. fts5BufferAppendBlob(&p->rc, &pPage->buf, nCopy, a);
  187044. a += nCopy;
  187045. n -= nCopy;
  187046. fts5WriteFlushLeaf(p, pWriter);
  187047. }
  187048. if( n>0 ){
  187049. fts5BufferAppendBlob(&p->rc, &pPage->buf, n, a);
  187050. }
  187051. }
  187052. /*
  187053. ** Flush any data cached by the writer object to the database. Free any
  187054. ** allocations associated with the writer.
  187055. */
  187056. static void fts5WriteFinish(
  187057. Fts5Index *p,
  187058. Fts5SegWriter *pWriter, /* Writer object */
  187059. int *pnLeaf /* OUT: Number of leaf pages in b-tree */
  187060. ){
  187061. int i;
  187062. Fts5PageWriter *pLeaf = &pWriter->writer;
  187063. if( p->rc==SQLITE_OK ){
  187064. assert( pLeaf->pgno>=1 );
  187065. if( pLeaf->buf.n>4 ){
  187066. fts5WriteFlushLeaf(p, pWriter);
  187067. }
  187068. *pnLeaf = pLeaf->pgno-1;
  187069. if( pLeaf->pgno>1 ){
  187070. fts5WriteFlushBtree(p, pWriter);
  187071. }
  187072. }
  187073. fts5BufferFree(&pLeaf->term);
  187074. fts5BufferFree(&pLeaf->buf);
  187075. fts5BufferFree(&pLeaf->pgidx);
  187076. fts5BufferFree(&pWriter->btterm);
  187077. for(i=0; i<pWriter->nDlidx; i++){
  187078. sqlite3Fts5BufferFree(&pWriter->aDlidx[i].buf);
  187079. }
  187080. sqlite3_free(pWriter->aDlidx);
  187081. }
  187082. static void fts5WriteInit(
  187083. Fts5Index *p,
  187084. Fts5SegWriter *pWriter,
  187085. int iSegid
  187086. ){
  187087. const int nBuffer = p->pConfig->pgsz + FTS5_DATA_PADDING;
  187088. memset(pWriter, 0, sizeof(Fts5SegWriter));
  187089. pWriter->iSegid = iSegid;
  187090. fts5WriteDlidxGrow(p, pWriter, 1);
  187091. pWriter->writer.pgno = 1;
  187092. pWriter->bFirstTermInPage = 1;
  187093. pWriter->iBtPage = 1;
  187094. assert( pWriter->writer.buf.n==0 );
  187095. assert( pWriter->writer.pgidx.n==0 );
  187096. /* Grow the two buffers to pgsz + padding bytes in size. */
  187097. sqlite3Fts5BufferSize(&p->rc, &pWriter->writer.pgidx, nBuffer);
  187098. sqlite3Fts5BufferSize(&p->rc, &pWriter->writer.buf, nBuffer);
  187099. if( p->pIdxWriter==0 ){
  187100. Fts5Config *pConfig = p->pConfig;
  187101. fts5IndexPrepareStmt(p, &p->pIdxWriter, sqlite3_mprintf(
  187102. "INSERT INTO '%q'.'%q_idx'(segid,term,pgno) VALUES(?,?,?)",
  187103. pConfig->zDb, pConfig->zName
  187104. ));
  187105. }
  187106. if( p->rc==SQLITE_OK ){
  187107. /* Initialize the 4-byte leaf-page header to 0x00. */
  187108. memset(pWriter->writer.buf.p, 0, 4);
  187109. pWriter->writer.buf.n = 4;
  187110. /* Bind the current output segment id to the index-writer. This is an
  187111. ** optimization over binding the same value over and over as rows are
  187112. ** inserted into %_idx by the current writer. */
  187113. sqlite3_bind_int(p->pIdxWriter, 1, pWriter->iSegid);
  187114. }
  187115. }
  187116. /*
  187117. ** Iterator pIter was used to iterate through the input segments of on an
  187118. ** incremental merge operation. This function is called if the incremental
  187119. ** merge step has finished but the input has not been completely exhausted.
  187120. */
  187121. static void fts5TrimSegments(Fts5Index *p, Fts5Iter *pIter){
  187122. int i;
  187123. Fts5Buffer buf;
  187124. memset(&buf, 0, sizeof(Fts5Buffer));
  187125. for(i=0; i<pIter->nSeg; i++){
  187126. Fts5SegIter *pSeg = &pIter->aSeg[i];
  187127. if( pSeg->pSeg==0 ){
  187128. /* no-op */
  187129. }else if( pSeg->pLeaf==0 ){
  187130. /* All keys from this input segment have been transfered to the output.
  187131. ** Set both the first and last page-numbers to 0 to indicate that the
  187132. ** segment is now empty. */
  187133. pSeg->pSeg->pgnoLast = 0;
  187134. pSeg->pSeg->pgnoFirst = 0;
  187135. }else{
  187136. int iOff = pSeg->iTermLeafOffset; /* Offset on new first leaf page */
  187137. i64 iLeafRowid;
  187138. Fts5Data *pData;
  187139. int iId = pSeg->pSeg->iSegid;
  187140. u8 aHdr[4] = {0x00, 0x00, 0x00, 0x00};
  187141. iLeafRowid = FTS5_SEGMENT_ROWID(iId, pSeg->iTermLeafPgno);
  187142. pData = fts5DataRead(p, iLeafRowid);
  187143. if( pData ){
  187144. fts5BufferZero(&buf);
  187145. fts5BufferGrow(&p->rc, &buf, pData->nn);
  187146. fts5BufferAppendBlob(&p->rc, &buf, sizeof(aHdr), aHdr);
  187147. fts5BufferAppendVarint(&p->rc, &buf, pSeg->term.n);
  187148. fts5BufferAppendBlob(&p->rc, &buf, pSeg->term.n, pSeg->term.p);
  187149. fts5BufferAppendBlob(&p->rc, &buf, pData->szLeaf-iOff, &pData->p[iOff]);
  187150. if( p->rc==SQLITE_OK ){
  187151. /* Set the szLeaf field */
  187152. fts5PutU16(&buf.p[2], (u16)buf.n);
  187153. }
  187154. /* Set up the new page-index array */
  187155. fts5BufferAppendVarint(&p->rc, &buf, 4);
  187156. if( pSeg->iLeafPgno==pSeg->iTermLeafPgno
  187157. && pSeg->iEndofDoclist<pData->szLeaf
  187158. ){
  187159. int nDiff = pData->szLeaf - pSeg->iEndofDoclist;
  187160. fts5BufferAppendVarint(&p->rc, &buf, buf.n - 1 - nDiff - 4);
  187161. fts5BufferAppendBlob(&p->rc, &buf,
  187162. pData->nn - pSeg->iPgidxOff, &pData->p[pSeg->iPgidxOff]
  187163. );
  187164. }
  187165. fts5DataRelease(pData);
  187166. pSeg->pSeg->pgnoFirst = pSeg->iTermLeafPgno;
  187167. fts5DataDelete(p, FTS5_SEGMENT_ROWID(iId, 1), iLeafRowid);
  187168. fts5DataWrite(p, iLeafRowid, buf.p, buf.n);
  187169. }
  187170. }
  187171. }
  187172. fts5BufferFree(&buf);
  187173. }
  187174. static void fts5MergeChunkCallback(
  187175. Fts5Index *p,
  187176. void *pCtx,
  187177. const u8 *pChunk, int nChunk
  187178. ){
  187179. Fts5SegWriter *pWriter = (Fts5SegWriter*)pCtx;
  187180. fts5WriteAppendPoslistData(p, pWriter, pChunk, nChunk);
  187181. }
  187182. /*
  187183. **
  187184. */
  187185. static void fts5IndexMergeLevel(
  187186. Fts5Index *p, /* FTS5 backend object */
  187187. Fts5Structure **ppStruct, /* IN/OUT: Stucture of index */
  187188. int iLvl, /* Level to read input from */
  187189. int *pnRem /* Write up to this many output leaves */
  187190. ){
  187191. Fts5Structure *pStruct = *ppStruct;
  187192. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  187193. Fts5StructureLevel *pLvlOut;
  187194. Fts5Iter *pIter = 0; /* Iterator to read input data */
  187195. int nRem = pnRem ? *pnRem : 0; /* Output leaf pages left to write */
  187196. int nInput; /* Number of input segments */
  187197. Fts5SegWriter writer; /* Writer object */
  187198. Fts5StructureSegment *pSeg; /* Output segment */
  187199. Fts5Buffer term;
  187200. int bOldest; /* True if the output segment is the oldest */
  187201. int eDetail = p->pConfig->eDetail;
  187202. const int flags = FTS5INDEX_QUERY_NOOUTPUT;
  187203. int bTermWritten = 0; /* True if current term already output */
  187204. assert( iLvl<pStruct->nLevel );
  187205. assert( pLvl->nMerge<=pLvl->nSeg );
  187206. memset(&writer, 0, sizeof(Fts5SegWriter));
  187207. memset(&term, 0, sizeof(Fts5Buffer));
  187208. if( pLvl->nMerge ){
  187209. pLvlOut = &pStruct->aLevel[iLvl+1];
  187210. assert( pLvlOut->nSeg>0 );
  187211. nInput = pLvl->nMerge;
  187212. pSeg = &pLvlOut->aSeg[pLvlOut->nSeg-1];
  187213. fts5WriteInit(p, &writer, pSeg->iSegid);
  187214. writer.writer.pgno = pSeg->pgnoLast+1;
  187215. writer.iBtPage = 0;
  187216. }else{
  187217. int iSegid = fts5AllocateSegid(p, pStruct);
  187218. /* Extend the Fts5Structure object as required to ensure the output
  187219. ** segment exists. */
  187220. if( iLvl==pStruct->nLevel-1 ){
  187221. fts5StructureAddLevel(&p->rc, ppStruct);
  187222. pStruct = *ppStruct;
  187223. }
  187224. fts5StructureExtendLevel(&p->rc, pStruct, iLvl+1, 1, 0);
  187225. if( p->rc ) return;
  187226. pLvl = &pStruct->aLevel[iLvl];
  187227. pLvlOut = &pStruct->aLevel[iLvl+1];
  187228. fts5WriteInit(p, &writer, iSegid);
  187229. /* Add the new segment to the output level */
  187230. pSeg = &pLvlOut->aSeg[pLvlOut->nSeg];
  187231. pLvlOut->nSeg++;
  187232. pSeg->pgnoFirst = 1;
  187233. pSeg->iSegid = iSegid;
  187234. pStruct->nSegment++;
  187235. /* Read input from all segments in the input level */
  187236. nInput = pLvl->nSeg;
  187237. }
  187238. bOldest = (pLvlOut->nSeg==1 && pStruct->nLevel==iLvl+2);
  187239. assert( iLvl>=0 );
  187240. for(fts5MultiIterNew(p, pStruct, flags, 0, 0, 0, iLvl, nInput, &pIter);
  187241. fts5MultiIterEof(p, pIter)==0;
  187242. fts5MultiIterNext(p, pIter, 0, 0)
  187243. ){
  187244. Fts5SegIter *pSegIter = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  187245. int nPos; /* position-list size field value */
  187246. int nTerm;
  187247. const u8 *pTerm;
  187248. pTerm = fts5MultiIterTerm(pIter, &nTerm);
  187249. if( nTerm!=term.n || memcmp(pTerm, term.p, nTerm) ){
  187250. if( pnRem && writer.nLeafWritten>nRem ){
  187251. break;
  187252. }
  187253. fts5BufferSet(&p->rc, &term, nTerm, pTerm);
  187254. bTermWritten =0;
  187255. }
  187256. /* Check for key annihilation. */
  187257. if( pSegIter->nPos==0 && (bOldest || pSegIter->bDel==0) ) continue;
  187258. if( p->rc==SQLITE_OK && bTermWritten==0 ){
  187259. /* This is a new term. Append a term to the output segment. */
  187260. fts5WriteAppendTerm(p, &writer, nTerm, pTerm);
  187261. bTermWritten = 1;
  187262. }
  187263. /* Append the rowid to the output */
  187264. /* WRITEPOSLISTSIZE */
  187265. fts5WriteAppendRowid(p, &writer, fts5MultiIterRowid(pIter));
  187266. if( eDetail==FTS5_DETAIL_NONE ){
  187267. if( pSegIter->bDel ){
  187268. fts5BufferAppendVarint(&p->rc, &writer.writer.buf, 0);
  187269. if( pSegIter->nPos>0 ){
  187270. fts5BufferAppendVarint(&p->rc, &writer.writer.buf, 0);
  187271. }
  187272. }
  187273. }else{
  187274. /* Append the position-list data to the output */
  187275. nPos = pSegIter->nPos*2 + pSegIter->bDel;
  187276. fts5BufferAppendVarint(&p->rc, &writer.writer.buf, nPos);
  187277. fts5ChunkIterate(p, pSegIter, (void*)&writer, fts5MergeChunkCallback);
  187278. }
  187279. }
  187280. /* Flush the last leaf page to disk. Set the output segment b-tree height
  187281. ** and last leaf page number at the same time. */
  187282. fts5WriteFinish(p, &writer, &pSeg->pgnoLast);
  187283. if( fts5MultiIterEof(p, pIter) ){
  187284. int i;
  187285. /* Remove the redundant segments from the %_data table */
  187286. for(i=0; i<nInput; i++){
  187287. fts5DataRemoveSegment(p, pLvl->aSeg[i].iSegid);
  187288. }
  187289. /* Remove the redundant segments from the input level */
  187290. if( pLvl->nSeg!=nInput ){
  187291. int nMove = (pLvl->nSeg - nInput) * sizeof(Fts5StructureSegment);
  187292. memmove(pLvl->aSeg, &pLvl->aSeg[nInput], nMove);
  187293. }
  187294. pStruct->nSegment -= nInput;
  187295. pLvl->nSeg -= nInput;
  187296. pLvl->nMerge = 0;
  187297. if( pSeg->pgnoLast==0 ){
  187298. pLvlOut->nSeg--;
  187299. pStruct->nSegment--;
  187300. }
  187301. }else{
  187302. assert( pSeg->pgnoLast>0 );
  187303. fts5TrimSegments(p, pIter);
  187304. pLvl->nMerge = nInput;
  187305. }
  187306. fts5MultiIterFree(pIter);
  187307. fts5BufferFree(&term);
  187308. if( pnRem ) *pnRem -= writer.nLeafWritten;
  187309. }
  187310. /*
  187311. ** Do up to nPg pages of automerge work on the index.
  187312. **
  187313. ** Return true if any changes were actually made, or false otherwise.
  187314. */
  187315. static int fts5IndexMerge(
  187316. Fts5Index *p, /* FTS5 backend object */
  187317. Fts5Structure **ppStruct, /* IN/OUT: Current structure of index */
  187318. int nPg, /* Pages of work to do */
  187319. int nMin /* Minimum number of segments to merge */
  187320. ){
  187321. int nRem = nPg;
  187322. int bRet = 0;
  187323. Fts5Structure *pStruct = *ppStruct;
  187324. while( nRem>0 && p->rc==SQLITE_OK ){
  187325. int iLvl; /* To iterate through levels */
  187326. int iBestLvl = 0; /* Level offering the most input segments */
  187327. int nBest = 0; /* Number of input segments on best level */
  187328. /* Set iBestLvl to the level to read input segments from. */
  187329. assert( pStruct->nLevel>0 );
  187330. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  187331. Fts5StructureLevel *pLvl = &pStruct->aLevel[iLvl];
  187332. if( pLvl->nMerge ){
  187333. if( pLvl->nMerge>nBest ){
  187334. iBestLvl = iLvl;
  187335. nBest = pLvl->nMerge;
  187336. }
  187337. break;
  187338. }
  187339. if( pLvl->nSeg>nBest ){
  187340. nBest = pLvl->nSeg;
  187341. iBestLvl = iLvl;
  187342. }
  187343. }
  187344. /* If nBest is still 0, then the index must be empty. */
  187345. #ifdef SQLITE_DEBUG
  187346. for(iLvl=0; nBest==0 && iLvl<pStruct->nLevel; iLvl++){
  187347. assert( pStruct->aLevel[iLvl].nSeg==0 );
  187348. }
  187349. #endif
  187350. if( nBest<nMin && pStruct->aLevel[iBestLvl].nMerge==0 ){
  187351. break;
  187352. }
  187353. bRet = 1;
  187354. fts5IndexMergeLevel(p, &pStruct, iBestLvl, &nRem);
  187355. if( p->rc==SQLITE_OK && pStruct->aLevel[iBestLvl].nMerge==0 ){
  187356. fts5StructurePromote(p, iBestLvl+1, pStruct);
  187357. }
  187358. }
  187359. *ppStruct = pStruct;
  187360. return bRet;
  187361. }
  187362. /*
  187363. ** A total of nLeaf leaf pages of data has just been flushed to a level-0
  187364. ** segment. This function updates the write-counter accordingly and, if
  187365. ** necessary, performs incremental merge work.
  187366. **
  187367. ** If an error occurs, set the Fts5Index.rc error code. If an error has
  187368. ** already occurred, this function is a no-op.
  187369. */
  187370. static void fts5IndexAutomerge(
  187371. Fts5Index *p, /* FTS5 backend object */
  187372. Fts5Structure **ppStruct, /* IN/OUT: Current structure of index */
  187373. int nLeaf /* Number of output leaves just written */
  187374. ){
  187375. if( p->rc==SQLITE_OK && p->pConfig->nAutomerge>0 ){
  187376. Fts5Structure *pStruct = *ppStruct;
  187377. u64 nWrite; /* Initial value of write-counter */
  187378. int nWork; /* Number of work-quanta to perform */
  187379. int nRem; /* Number of leaf pages left to write */
  187380. /* Update the write-counter. While doing so, set nWork. */
  187381. nWrite = pStruct->nWriteCounter;
  187382. nWork = (int)(((nWrite + nLeaf) / p->nWorkUnit) - (nWrite / p->nWorkUnit));
  187383. pStruct->nWriteCounter += nLeaf;
  187384. nRem = (int)(p->nWorkUnit * nWork * pStruct->nLevel);
  187385. fts5IndexMerge(p, ppStruct, nRem, p->pConfig->nAutomerge);
  187386. }
  187387. }
  187388. static void fts5IndexCrisismerge(
  187389. Fts5Index *p, /* FTS5 backend object */
  187390. Fts5Structure **ppStruct /* IN/OUT: Current structure of index */
  187391. ){
  187392. const int nCrisis = p->pConfig->nCrisisMerge;
  187393. Fts5Structure *pStruct = *ppStruct;
  187394. int iLvl = 0;
  187395. assert( p->rc!=SQLITE_OK || pStruct->nLevel>0 );
  187396. while( p->rc==SQLITE_OK && pStruct->aLevel[iLvl].nSeg>=nCrisis ){
  187397. fts5IndexMergeLevel(p, &pStruct, iLvl, 0);
  187398. assert( p->rc!=SQLITE_OK || pStruct->nLevel>(iLvl+1) );
  187399. fts5StructurePromote(p, iLvl+1, pStruct);
  187400. iLvl++;
  187401. }
  187402. *ppStruct = pStruct;
  187403. }
  187404. static int fts5IndexReturn(Fts5Index *p){
  187405. int rc = p->rc;
  187406. p->rc = SQLITE_OK;
  187407. return rc;
  187408. }
  187409. typedef struct Fts5FlushCtx Fts5FlushCtx;
  187410. struct Fts5FlushCtx {
  187411. Fts5Index *pIdx;
  187412. Fts5SegWriter writer;
  187413. };
  187414. /*
  187415. ** Buffer aBuf[] contains a list of varints, all small enough to fit
  187416. ** in a 32-bit integer. Return the size of the largest prefix of this
  187417. ** list nMax bytes or less in size.
  187418. */
  187419. static int fts5PoslistPrefix(const u8 *aBuf, int nMax){
  187420. int ret;
  187421. u32 dummy;
  187422. ret = fts5GetVarint32(aBuf, dummy);
  187423. if( ret<nMax ){
  187424. while( 1 ){
  187425. int i = fts5GetVarint32(&aBuf[ret], dummy);
  187426. if( (ret + i) > nMax ) break;
  187427. ret += i;
  187428. }
  187429. }
  187430. return ret;
  187431. }
  187432. /*
  187433. ** Flush the contents of in-memory hash table iHash to a new level-0
  187434. ** segment on disk. Also update the corresponding structure record.
  187435. **
  187436. ** If an error occurs, set the Fts5Index.rc error code. If an error has
  187437. ** already occurred, this function is a no-op.
  187438. */
  187439. static void fts5FlushOneHash(Fts5Index *p){
  187440. Fts5Hash *pHash = p->pHash;
  187441. Fts5Structure *pStruct;
  187442. int iSegid;
  187443. int pgnoLast = 0; /* Last leaf page number in segment */
  187444. /* Obtain a reference to the index structure and allocate a new segment-id
  187445. ** for the new level-0 segment. */
  187446. pStruct = fts5StructureRead(p);
  187447. iSegid = fts5AllocateSegid(p, pStruct);
  187448. fts5StructureInvalidate(p);
  187449. if( iSegid ){
  187450. const int pgsz = p->pConfig->pgsz;
  187451. int eDetail = p->pConfig->eDetail;
  187452. Fts5StructureSegment *pSeg; /* New segment within pStruct */
  187453. Fts5Buffer *pBuf; /* Buffer in which to assemble leaf page */
  187454. Fts5Buffer *pPgidx; /* Buffer in which to assemble pgidx */
  187455. Fts5SegWriter writer;
  187456. fts5WriteInit(p, &writer, iSegid);
  187457. pBuf = &writer.writer.buf;
  187458. pPgidx = &writer.writer.pgidx;
  187459. /* fts5WriteInit() should have initialized the buffers to (most likely)
  187460. ** the maximum space required. */
  187461. assert( p->rc || pBuf->nSpace>=(pgsz + FTS5_DATA_PADDING) );
  187462. assert( p->rc || pPgidx->nSpace>=(pgsz + FTS5_DATA_PADDING) );
  187463. /* Begin scanning through hash table entries. This loop runs once for each
  187464. ** term/doclist currently stored within the hash table. */
  187465. if( p->rc==SQLITE_OK ){
  187466. p->rc = sqlite3Fts5HashScanInit(pHash, 0, 0);
  187467. }
  187468. while( p->rc==SQLITE_OK && 0==sqlite3Fts5HashScanEof(pHash) ){
  187469. const char *zTerm; /* Buffer containing term */
  187470. const u8 *pDoclist; /* Pointer to doclist for this term */
  187471. int nDoclist; /* Size of doclist in bytes */
  187472. /* Write the term for this entry to disk. */
  187473. sqlite3Fts5HashScanEntry(pHash, &zTerm, &pDoclist, &nDoclist);
  187474. fts5WriteAppendTerm(p, &writer, (int)strlen(zTerm), (const u8*)zTerm);
  187475. assert( writer.bFirstRowidInPage==0 );
  187476. if( pgsz>=(pBuf->n + pPgidx->n + nDoclist + 1) ){
  187477. /* The entire doclist will fit on the current leaf. */
  187478. fts5BufferSafeAppendBlob(pBuf, pDoclist, nDoclist);
  187479. }else{
  187480. i64 iRowid = 0;
  187481. i64 iDelta = 0;
  187482. int iOff = 0;
  187483. /* The entire doclist will not fit on this leaf. The following
  187484. ** loop iterates through the poslists that make up the current
  187485. ** doclist. */
  187486. while( p->rc==SQLITE_OK && iOff<nDoclist ){
  187487. iOff += fts5GetVarint(&pDoclist[iOff], (u64*)&iDelta);
  187488. iRowid += iDelta;
  187489. if( writer.bFirstRowidInPage ){
  187490. fts5PutU16(&pBuf->p[0], (u16)pBuf->n); /* first rowid on page */
  187491. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], iRowid);
  187492. writer.bFirstRowidInPage = 0;
  187493. fts5WriteDlidxAppend(p, &writer, iRowid);
  187494. }else{
  187495. pBuf->n += sqlite3Fts5PutVarint(&pBuf->p[pBuf->n], iDelta);
  187496. }
  187497. assert( pBuf->n<=pBuf->nSpace );
  187498. if( eDetail==FTS5_DETAIL_NONE ){
  187499. if( iOff<nDoclist && pDoclist[iOff]==0 ){
  187500. pBuf->p[pBuf->n++] = 0;
  187501. iOff++;
  187502. if( iOff<nDoclist && pDoclist[iOff]==0 ){
  187503. pBuf->p[pBuf->n++] = 0;
  187504. iOff++;
  187505. }
  187506. }
  187507. if( (pBuf->n + pPgidx->n)>=pgsz ){
  187508. fts5WriteFlushLeaf(p, &writer);
  187509. }
  187510. }else{
  187511. int bDummy;
  187512. int nPos;
  187513. int nCopy = fts5GetPoslistSize(&pDoclist[iOff], &nPos, &bDummy);
  187514. nCopy += nPos;
  187515. if( (pBuf->n + pPgidx->n + nCopy) <= pgsz ){
  187516. /* The entire poslist will fit on the current leaf. So copy
  187517. ** it in one go. */
  187518. fts5BufferSafeAppendBlob(pBuf, &pDoclist[iOff], nCopy);
  187519. }else{
  187520. /* The entire poslist will not fit on this leaf. So it needs
  187521. ** to be broken into sections. The only qualification being
  187522. ** that each varint must be stored contiguously. */
  187523. const u8 *pPoslist = &pDoclist[iOff];
  187524. int iPos = 0;
  187525. while( p->rc==SQLITE_OK ){
  187526. int nSpace = pgsz - pBuf->n - pPgidx->n;
  187527. int n = 0;
  187528. if( (nCopy - iPos)<=nSpace ){
  187529. n = nCopy - iPos;
  187530. }else{
  187531. n = fts5PoslistPrefix(&pPoslist[iPos], nSpace);
  187532. }
  187533. assert( n>0 );
  187534. fts5BufferSafeAppendBlob(pBuf, &pPoslist[iPos], n);
  187535. iPos += n;
  187536. if( (pBuf->n + pPgidx->n)>=pgsz ){
  187537. fts5WriteFlushLeaf(p, &writer);
  187538. }
  187539. if( iPos>=nCopy ) break;
  187540. }
  187541. }
  187542. iOff += nCopy;
  187543. }
  187544. }
  187545. }
  187546. /* TODO2: Doclist terminator written here. */
  187547. /* pBuf->p[pBuf->n++] = '\0'; */
  187548. assert( pBuf->n<=pBuf->nSpace );
  187549. sqlite3Fts5HashScanNext(pHash);
  187550. }
  187551. sqlite3Fts5HashClear(pHash);
  187552. fts5WriteFinish(p, &writer, &pgnoLast);
  187553. /* Update the Fts5Structure. It is written back to the database by the
  187554. ** fts5StructureRelease() call below. */
  187555. if( pStruct->nLevel==0 ){
  187556. fts5StructureAddLevel(&p->rc, &pStruct);
  187557. }
  187558. fts5StructureExtendLevel(&p->rc, pStruct, 0, 1, 0);
  187559. if( p->rc==SQLITE_OK ){
  187560. pSeg = &pStruct->aLevel[0].aSeg[ pStruct->aLevel[0].nSeg++ ];
  187561. pSeg->iSegid = iSegid;
  187562. pSeg->pgnoFirst = 1;
  187563. pSeg->pgnoLast = pgnoLast;
  187564. pStruct->nSegment++;
  187565. }
  187566. fts5StructurePromote(p, 0, pStruct);
  187567. }
  187568. fts5IndexAutomerge(p, &pStruct, pgnoLast);
  187569. fts5IndexCrisismerge(p, &pStruct);
  187570. fts5StructureWrite(p, pStruct);
  187571. fts5StructureRelease(pStruct);
  187572. }
  187573. /*
  187574. ** Flush any data stored in the in-memory hash tables to the database.
  187575. */
  187576. static void fts5IndexFlush(Fts5Index *p){
  187577. /* Unless it is empty, flush the hash table to disk */
  187578. if( p->nPendingData ){
  187579. assert( p->pHash );
  187580. p->nPendingData = 0;
  187581. fts5FlushOneHash(p);
  187582. }
  187583. }
  187584. static Fts5Structure *fts5IndexOptimizeStruct(
  187585. Fts5Index *p,
  187586. Fts5Structure *pStruct
  187587. ){
  187588. Fts5Structure *pNew = 0;
  187589. int nByte = sizeof(Fts5Structure);
  187590. int nSeg = pStruct->nSegment;
  187591. int i;
  187592. /* Figure out if this structure requires optimization. A structure does
  187593. ** not require optimization if either:
  187594. **
  187595. ** + it consists of fewer than two segments, or
  187596. ** + all segments are on the same level, or
  187597. ** + all segments except one are currently inputs to a merge operation.
  187598. **
  187599. ** In the first case, return NULL. In the second, increment the ref-count
  187600. ** on *pStruct and return a copy of the pointer to it.
  187601. */
  187602. if( nSeg<2 ) return 0;
  187603. for(i=0; i<pStruct->nLevel; i++){
  187604. int nThis = pStruct->aLevel[i].nSeg;
  187605. if( nThis==nSeg || (nThis==nSeg-1 && pStruct->aLevel[i].nMerge==nThis) ){
  187606. fts5StructureRef(pStruct);
  187607. return pStruct;
  187608. }
  187609. assert( pStruct->aLevel[i].nMerge<=nThis );
  187610. }
  187611. nByte += (pStruct->nLevel+1) * sizeof(Fts5StructureLevel);
  187612. pNew = (Fts5Structure*)sqlite3Fts5MallocZero(&p->rc, nByte);
  187613. if( pNew ){
  187614. Fts5StructureLevel *pLvl;
  187615. nByte = nSeg * sizeof(Fts5StructureSegment);
  187616. pNew->nLevel = pStruct->nLevel+1;
  187617. pNew->nRef = 1;
  187618. pNew->nWriteCounter = pStruct->nWriteCounter;
  187619. pLvl = &pNew->aLevel[pStruct->nLevel];
  187620. pLvl->aSeg = (Fts5StructureSegment*)sqlite3Fts5MallocZero(&p->rc, nByte);
  187621. if( pLvl->aSeg ){
  187622. int iLvl, iSeg;
  187623. int iSegOut = 0;
  187624. /* Iterate through all segments, from oldest to newest. Add them to
  187625. ** the new Fts5Level object so that pLvl->aSeg[0] is the oldest
  187626. ** segment in the data structure. */
  187627. for(iLvl=pStruct->nLevel-1; iLvl>=0; iLvl--){
  187628. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  187629. pLvl->aSeg[iSegOut] = pStruct->aLevel[iLvl].aSeg[iSeg];
  187630. iSegOut++;
  187631. }
  187632. }
  187633. pNew->nSegment = pLvl->nSeg = nSeg;
  187634. }else{
  187635. sqlite3_free(pNew);
  187636. pNew = 0;
  187637. }
  187638. }
  187639. return pNew;
  187640. }
  187641. static int sqlite3Fts5IndexOptimize(Fts5Index *p){
  187642. Fts5Structure *pStruct;
  187643. Fts5Structure *pNew = 0;
  187644. assert( p->rc==SQLITE_OK );
  187645. fts5IndexFlush(p);
  187646. pStruct = fts5StructureRead(p);
  187647. fts5StructureInvalidate(p);
  187648. if( pStruct ){
  187649. pNew = fts5IndexOptimizeStruct(p, pStruct);
  187650. }
  187651. fts5StructureRelease(pStruct);
  187652. assert( pNew==0 || pNew->nSegment>0 );
  187653. if( pNew ){
  187654. int iLvl;
  187655. for(iLvl=0; pNew->aLevel[iLvl].nSeg==0; iLvl++){}
  187656. while( p->rc==SQLITE_OK && pNew->aLevel[iLvl].nSeg>0 ){
  187657. int nRem = FTS5_OPT_WORK_UNIT;
  187658. fts5IndexMergeLevel(p, &pNew, iLvl, &nRem);
  187659. }
  187660. fts5StructureWrite(p, pNew);
  187661. fts5StructureRelease(pNew);
  187662. }
  187663. return fts5IndexReturn(p);
  187664. }
  187665. /*
  187666. ** This is called to implement the special "VALUES('merge', $nMerge)"
  187667. ** INSERT command.
  187668. */
  187669. static int sqlite3Fts5IndexMerge(Fts5Index *p, int nMerge){
  187670. Fts5Structure *pStruct = fts5StructureRead(p);
  187671. if( pStruct ){
  187672. int nMin = p->pConfig->nUsermerge;
  187673. fts5StructureInvalidate(p);
  187674. if( nMerge<0 ){
  187675. Fts5Structure *pNew = fts5IndexOptimizeStruct(p, pStruct);
  187676. fts5StructureRelease(pStruct);
  187677. pStruct = pNew;
  187678. nMin = 2;
  187679. nMerge = nMerge*-1;
  187680. }
  187681. if( pStruct && pStruct->nLevel ){
  187682. if( fts5IndexMerge(p, &pStruct, nMerge, nMin) ){
  187683. fts5StructureWrite(p, pStruct);
  187684. }
  187685. }
  187686. fts5StructureRelease(pStruct);
  187687. }
  187688. return fts5IndexReturn(p);
  187689. }
  187690. static void fts5AppendRowid(
  187691. Fts5Index *p,
  187692. i64 iDelta,
  187693. Fts5Iter *pUnused,
  187694. Fts5Buffer *pBuf
  187695. ){
  187696. UNUSED_PARAM(pUnused);
  187697. fts5BufferAppendVarint(&p->rc, pBuf, iDelta);
  187698. }
  187699. static void fts5AppendPoslist(
  187700. Fts5Index *p,
  187701. i64 iDelta,
  187702. Fts5Iter *pMulti,
  187703. Fts5Buffer *pBuf
  187704. ){
  187705. int nData = pMulti->base.nData;
  187706. assert( nData>0 );
  187707. if( p->rc==SQLITE_OK && 0==fts5BufferGrow(&p->rc, pBuf, nData+9+9) ){
  187708. fts5BufferSafeAppendVarint(pBuf, iDelta);
  187709. fts5BufferSafeAppendVarint(pBuf, nData*2);
  187710. fts5BufferSafeAppendBlob(pBuf, pMulti->base.pData, nData);
  187711. }
  187712. }
  187713. static void fts5DoclistIterNext(Fts5DoclistIter *pIter){
  187714. u8 *p = pIter->aPoslist + pIter->nSize + pIter->nPoslist;
  187715. assert( pIter->aPoslist );
  187716. if( p>=pIter->aEof ){
  187717. pIter->aPoslist = 0;
  187718. }else{
  187719. i64 iDelta;
  187720. p += fts5GetVarint(p, (u64*)&iDelta);
  187721. pIter->iRowid += iDelta;
  187722. /* Read position list size */
  187723. if( p[0] & 0x80 ){
  187724. int nPos;
  187725. pIter->nSize = fts5GetVarint32(p, nPos);
  187726. pIter->nPoslist = (nPos>>1);
  187727. }else{
  187728. pIter->nPoslist = ((int)(p[0])) >> 1;
  187729. pIter->nSize = 1;
  187730. }
  187731. pIter->aPoslist = p;
  187732. }
  187733. }
  187734. static void fts5DoclistIterInit(
  187735. Fts5Buffer *pBuf,
  187736. Fts5DoclistIter *pIter
  187737. ){
  187738. memset(pIter, 0, sizeof(*pIter));
  187739. pIter->aPoslist = pBuf->p;
  187740. pIter->aEof = &pBuf->p[pBuf->n];
  187741. fts5DoclistIterNext(pIter);
  187742. }
  187743. #if 0
  187744. /*
  187745. ** Append a doclist to buffer pBuf.
  187746. **
  187747. ** This function assumes that space within the buffer has already been
  187748. ** allocated.
  187749. */
  187750. static void fts5MergeAppendDocid(
  187751. Fts5Buffer *pBuf, /* Buffer to write to */
  187752. i64 *piLastRowid, /* IN/OUT: Previous rowid written (if any) */
  187753. i64 iRowid /* Rowid to append */
  187754. ){
  187755. assert( pBuf->n!=0 || (*piLastRowid)==0 );
  187756. fts5BufferSafeAppendVarint(pBuf, iRowid - *piLastRowid);
  187757. *piLastRowid = iRowid;
  187758. }
  187759. #endif
  187760. #define fts5MergeAppendDocid(pBuf, iLastRowid, iRowid) { \
  187761. assert( (pBuf)->n!=0 || (iLastRowid)==0 ); \
  187762. fts5BufferSafeAppendVarint((pBuf), (iRowid) - (iLastRowid)); \
  187763. (iLastRowid) = (iRowid); \
  187764. }
  187765. /*
  187766. ** Swap the contents of buffer *p1 with that of *p2.
  187767. */
  187768. static void fts5BufferSwap(Fts5Buffer *p1, Fts5Buffer *p2){
  187769. Fts5Buffer tmp = *p1;
  187770. *p1 = *p2;
  187771. *p2 = tmp;
  187772. }
  187773. static void fts5NextRowid(Fts5Buffer *pBuf, int *piOff, i64 *piRowid){
  187774. int i = *piOff;
  187775. if( i>=pBuf->n ){
  187776. *piOff = -1;
  187777. }else{
  187778. u64 iVal;
  187779. *piOff = i + sqlite3Fts5GetVarint(&pBuf->p[i], &iVal);
  187780. *piRowid += iVal;
  187781. }
  187782. }
  187783. /*
  187784. ** This is the equivalent of fts5MergePrefixLists() for detail=none mode.
  187785. ** In this case the buffers consist of a delta-encoded list of rowids only.
  187786. */
  187787. static void fts5MergeRowidLists(
  187788. Fts5Index *p, /* FTS5 backend object */
  187789. Fts5Buffer *p1, /* First list to merge */
  187790. Fts5Buffer *p2 /* Second list to merge */
  187791. ){
  187792. int i1 = 0;
  187793. int i2 = 0;
  187794. i64 iRowid1 = 0;
  187795. i64 iRowid2 = 0;
  187796. i64 iOut = 0;
  187797. Fts5Buffer out;
  187798. memset(&out, 0, sizeof(out));
  187799. sqlite3Fts5BufferSize(&p->rc, &out, p1->n + p2->n);
  187800. if( p->rc ) return;
  187801. fts5NextRowid(p1, &i1, &iRowid1);
  187802. fts5NextRowid(p2, &i2, &iRowid2);
  187803. while( i1>=0 || i2>=0 ){
  187804. if( i1>=0 && (i2<0 || iRowid1<iRowid2) ){
  187805. assert( iOut==0 || iRowid1>iOut );
  187806. fts5BufferSafeAppendVarint(&out, iRowid1 - iOut);
  187807. iOut = iRowid1;
  187808. fts5NextRowid(p1, &i1, &iRowid1);
  187809. }else{
  187810. assert( iOut==0 || iRowid2>iOut );
  187811. fts5BufferSafeAppendVarint(&out, iRowid2 - iOut);
  187812. iOut = iRowid2;
  187813. if( i1>=0 && iRowid1==iRowid2 ){
  187814. fts5NextRowid(p1, &i1, &iRowid1);
  187815. }
  187816. fts5NextRowid(p2, &i2, &iRowid2);
  187817. }
  187818. }
  187819. fts5BufferSwap(&out, p1);
  187820. fts5BufferFree(&out);
  187821. }
  187822. /*
  187823. ** Buffers p1 and p2 contain doclists. This function merges the content
  187824. ** of the two doclists together and sets buffer p1 to the result before
  187825. ** returning.
  187826. **
  187827. ** If an error occurs, an error code is left in p->rc. If an error has
  187828. ** already occurred, this function is a no-op.
  187829. */
  187830. static void fts5MergePrefixLists(
  187831. Fts5Index *p, /* FTS5 backend object */
  187832. Fts5Buffer *p1, /* First list to merge */
  187833. Fts5Buffer *p2 /* Second list to merge */
  187834. ){
  187835. if( p2->n ){
  187836. i64 iLastRowid = 0;
  187837. Fts5DoclistIter i1;
  187838. Fts5DoclistIter i2;
  187839. Fts5Buffer out = {0, 0, 0};
  187840. Fts5Buffer tmp = {0, 0, 0};
  187841. /* The maximum size of the output is equal to the sum of the two
  187842. ** input sizes + 1 varint (9 bytes). The extra varint is because if the
  187843. ** first rowid in one input is a large negative number, and the first in
  187844. ** the other a non-negative number, the delta for the non-negative
  187845. ** number will be larger on disk than the literal integer value
  187846. ** was. */
  187847. if( sqlite3Fts5BufferSize(&p->rc, &out, p1->n + p2->n + 9) ) return;
  187848. fts5DoclistIterInit(p1, &i1);
  187849. fts5DoclistIterInit(p2, &i2);
  187850. while( 1 ){
  187851. if( i1.iRowid<i2.iRowid ){
  187852. /* Copy entry from i1 */
  187853. fts5MergeAppendDocid(&out, iLastRowid, i1.iRowid);
  187854. fts5BufferSafeAppendBlob(&out, i1.aPoslist, i1.nPoslist+i1.nSize);
  187855. fts5DoclistIterNext(&i1);
  187856. if( i1.aPoslist==0 ) break;
  187857. }
  187858. else if( i2.iRowid!=i1.iRowid ){
  187859. /* Copy entry from i2 */
  187860. fts5MergeAppendDocid(&out, iLastRowid, i2.iRowid);
  187861. fts5BufferSafeAppendBlob(&out, i2.aPoslist, i2.nPoslist+i2.nSize);
  187862. fts5DoclistIterNext(&i2);
  187863. if( i2.aPoslist==0 ) break;
  187864. }
  187865. else{
  187866. /* Merge the two position lists. */
  187867. i64 iPos1 = 0;
  187868. i64 iPos2 = 0;
  187869. int iOff1 = 0;
  187870. int iOff2 = 0;
  187871. u8 *a1 = &i1.aPoslist[i1.nSize];
  187872. u8 *a2 = &i2.aPoslist[i2.nSize];
  187873. i64 iPrev = 0;
  187874. Fts5PoslistWriter writer;
  187875. memset(&writer, 0, sizeof(writer));
  187876. fts5MergeAppendDocid(&out, iLastRowid, i2.iRowid);
  187877. fts5BufferZero(&tmp);
  187878. sqlite3Fts5BufferSize(&p->rc, &tmp, i1.nPoslist + i2.nPoslist);
  187879. if( p->rc ) break;
  187880. sqlite3Fts5PoslistNext64(a1, i1.nPoslist, &iOff1, &iPos1);
  187881. sqlite3Fts5PoslistNext64(a2, i2.nPoslist, &iOff2, &iPos2);
  187882. assert( iPos1>=0 && iPos2>=0 );
  187883. if( iPos1<iPos2 ){
  187884. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos1);
  187885. sqlite3Fts5PoslistNext64(a1, i1.nPoslist, &iOff1, &iPos1);
  187886. }else{
  187887. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos2);
  187888. sqlite3Fts5PoslistNext64(a2, i2.nPoslist, &iOff2, &iPos2);
  187889. }
  187890. if( iPos1>=0 && iPos2>=0 ){
  187891. while( 1 ){
  187892. if( iPos1<iPos2 ){
  187893. if( iPos1!=iPrev ){
  187894. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos1);
  187895. }
  187896. sqlite3Fts5PoslistNext64(a1, i1.nPoslist, &iOff1, &iPos1);
  187897. if( iPos1<0 ) break;
  187898. }else{
  187899. assert( iPos2!=iPrev );
  187900. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos2);
  187901. sqlite3Fts5PoslistNext64(a2, i2.nPoslist, &iOff2, &iPos2);
  187902. if( iPos2<0 ) break;
  187903. }
  187904. }
  187905. }
  187906. if( iPos1>=0 ){
  187907. if( iPos1!=iPrev ){
  187908. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos1);
  187909. }
  187910. fts5BufferSafeAppendBlob(&tmp, &a1[iOff1], i1.nPoslist-iOff1);
  187911. }else{
  187912. assert( iPos2>=0 && iPos2!=iPrev );
  187913. sqlite3Fts5PoslistSafeAppend(&tmp, &iPrev, iPos2);
  187914. fts5BufferSafeAppendBlob(&tmp, &a2[iOff2], i2.nPoslist-iOff2);
  187915. }
  187916. /* WRITEPOSLISTSIZE */
  187917. fts5BufferSafeAppendVarint(&out, tmp.n * 2);
  187918. fts5BufferSafeAppendBlob(&out, tmp.p, tmp.n);
  187919. fts5DoclistIterNext(&i1);
  187920. fts5DoclistIterNext(&i2);
  187921. if( i1.aPoslist==0 || i2.aPoslist==0 ) break;
  187922. }
  187923. }
  187924. if( i1.aPoslist ){
  187925. fts5MergeAppendDocid(&out, iLastRowid, i1.iRowid);
  187926. fts5BufferSafeAppendBlob(&out, i1.aPoslist, i1.aEof - i1.aPoslist);
  187927. }
  187928. else if( i2.aPoslist ){
  187929. fts5MergeAppendDocid(&out, iLastRowid, i2.iRowid);
  187930. fts5BufferSafeAppendBlob(&out, i2.aPoslist, i2.aEof - i2.aPoslist);
  187931. }
  187932. assert( out.n<=(p1->n+p2->n+9) );
  187933. fts5BufferSet(&p->rc, p1, out.n, out.p);
  187934. fts5BufferFree(&tmp);
  187935. fts5BufferFree(&out);
  187936. }
  187937. }
  187938. static void fts5SetupPrefixIter(
  187939. Fts5Index *p, /* Index to read from */
  187940. int bDesc, /* True for "ORDER BY rowid DESC" */
  187941. const u8 *pToken, /* Buffer containing prefix to match */
  187942. int nToken, /* Size of buffer pToken in bytes */
  187943. Fts5Colset *pColset, /* Restrict matches to these columns */
  187944. Fts5Iter **ppIter /* OUT: New iterator */
  187945. ){
  187946. Fts5Structure *pStruct;
  187947. Fts5Buffer *aBuf;
  187948. const int nBuf = 32;
  187949. void (*xMerge)(Fts5Index*, Fts5Buffer*, Fts5Buffer*);
  187950. void (*xAppend)(Fts5Index*, i64, Fts5Iter*, Fts5Buffer*);
  187951. if( p->pConfig->eDetail==FTS5_DETAIL_NONE ){
  187952. xMerge = fts5MergeRowidLists;
  187953. xAppend = fts5AppendRowid;
  187954. }else{
  187955. xMerge = fts5MergePrefixLists;
  187956. xAppend = fts5AppendPoslist;
  187957. }
  187958. aBuf = (Fts5Buffer*)fts5IdxMalloc(p, sizeof(Fts5Buffer)*nBuf);
  187959. pStruct = fts5StructureRead(p);
  187960. if( aBuf && pStruct ){
  187961. const int flags = FTS5INDEX_QUERY_SCAN
  187962. | FTS5INDEX_QUERY_SKIPEMPTY
  187963. | FTS5INDEX_QUERY_NOOUTPUT;
  187964. int i;
  187965. i64 iLastRowid = 0;
  187966. Fts5Iter *p1 = 0; /* Iterator used to gather data from index */
  187967. Fts5Data *pData;
  187968. Fts5Buffer doclist;
  187969. int bNewTerm = 1;
  187970. memset(&doclist, 0, sizeof(doclist));
  187971. fts5MultiIterNew(p, pStruct, flags, pColset, pToken, nToken, -1, 0, &p1);
  187972. fts5IterSetOutputCb(&p->rc, p1);
  187973. for( /* no-op */ ;
  187974. fts5MultiIterEof(p, p1)==0;
  187975. fts5MultiIterNext2(p, p1, &bNewTerm)
  187976. ){
  187977. Fts5SegIter *pSeg = &p1->aSeg[ p1->aFirst[1].iFirst ];
  187978. int nTerm = pSeg->term.n;
  187979. const u8 *pTerm = pSeg->term.p;
  187980. p1->xSetOutputs(p1, pSeg);
  187981. assert_nc( memcmp(pToken, pTerm, MIN(nToken, nTerm))<=0 );
  187982. if( bNewTerm ){
  187983. if( nTerm<nToken || memcmp(pToken, pTerm, nToken) ) break;
  187984. }
  187985. if( p1->base.nData==0 ) continue;
  187986. if( p1->base.iRowid<=iLastRowid && doclist.n>0 ){
  187987. for(i=0; p->rc==SQLITE_OK && doclist.n; i++){
  187988. assert( i<nBuf );
  187989. if( aBuf[i].n==0 ){
  187990. fts5BufferSwap(&doclist, &aBuf[i]);
  187991. fts5BufferZero(&doclist);
  187992. }else{
  187993. xMerge(p, &doclist, &aBuf[i]);
  187994. fts5BufferZero(&aBuf[i]);
  187995. }
  187996. }
  187997. iLastRowid = 0;
  187998. }
  187999. xAppend(p, p1->base.iRowid-iLastRowid, p1, &doclist);
  188000. iLastRowid = p1->base.iRowid;
  188001. }
  188002. for(i=0; i<nBuf; i++){
  188003. if( p->rc==SQLITE_OK ){
  188004. xMerge(p, &doclist, &aBuf[i]);
  188005. }
  188006. fts5BufferFree(&aBuf[i]);
  188007. }
  188008. fts5MultiIterFree(p1);
  188009. pData = fts5IdxMalloc(p, sizeof(Fts5Data) + doclist.n);
  188010. if( pData ){
  188011. pData->p = (u8*)&pData[1];
  188012. pData->nn = pData->szLeaf = doclist.n;
  188013. if( doclist.n ) memcpy(pData->p, doclist.p, doclist.n);
  188014. fts5MultiIterNew2(p, pData, bDesc, ppIter);
  188015. }
  188016. fts5BufferFree(&doclist);
  188017. }
  188018. fts5StructureRelease(pStruct);
  188019. sqlite3_free(aBuf);
  188020. }
  188021. /*
  188022. ** Indicate that all subsequent calls to sqlite3Fts5IndexWrite() pertain
  188023. ** to the document with rowid iRowid.
  188024. */
  188025. static int sqlite3Fts5IndexBeginWrite(Fts5Index *p, int bDelete, i64 iRowid){
  188026. assert( p->rc==SQLITE_OK );
  188027. /* Allocate the hash table if it has not already been allocated */
  188028. if( p->pHash==0 ){
  188029. p->rc = sqlite3Fts5HashNew(p->pConfig, &p->pHash, &p->nPendingData);
  188030. }
  188031. /* Flush the hash table to disk if required */
  188032. if( iRowid<p->iWriteRowid
  188033. || (iRowid==p->iWriteRowid && p->bDelete==0)
  188034. || (p->nPendingData > p->pConfig->nHashSize)
  188035. ){
  188036. fts5IndexFlush(p);
  188037. }
  188038. p->iWriteRowid = iRowid;
  188039. p->bDelete = bDelete;
  188040. return fts5IndexReturn(p);
  188041. }
  188042. /*
  188043. ** Commit data to disk.
  188044. */
  188045. static int sqlite3Fts5IndexSync(Fts5Index *p){
  188046. assert( p->rc==SQLITE_OK );
  188047. fts5IndexFlush(p);
  188048. fts5CloseReader(p);
  188049. return fts5IndexReturn(p);
  188050. }
  188051. /*
  188052. ** Discard any data stored in the in-memory hash tables. Do not write it
  188053. ** to the database. Additionally, assume that the contents of the %_data
  188054. ** table may have changed on disk. So any in-memory caches of %_data
  188055. ** records must be invalidated.
  188056. */
  188057. static int sqlite3Fts5IndexRollback(Fts5Index *p){
  188058. fts5CloseReader(p);
  188059. fts5IndexDiscardData(p);
  188060. fts5StructureInvalidate(p);
  188061. /* assert( p->rc==SQLITE_OK ); */
  188062. return SQLITE_OK;
  188063. }
  188064. /*
  188065. ** The %_data table is completely empty when this function is called. This
  188066. ** function populates it with the initial structure objects for each index,
  188067. ** and the initial version of the "averages" record (a zero-byte blob).
  188068. */
  188069. static int sqlite3Fts5IndexReinit(Fts5Index *p){
  188070. Fts5Structure s;
  188071. fts5StructureInvalidate(p);
  188072. memset(&s, 0, sizeof(Fts5Structure));
  188073. fts5DataWrite(p, FTS5_AVERAGES_ROWID, (const u8*)"", 0);
  188074. fts5StructureWrite(p, &s);
  188075. return fts5IndexReturn(p);
  188076. }
  188077. /*
  188078. ** Open a new Fts5Index handle. If the bCreate argument is true, create
  188079. ** and initialize the underlying %_data table.
  188080. **
  188081. ** If successful, set *pp to point to the new object and return SQLITE_OK.
  188082. ** Otherwise, set *pp to NULL and return an SQLite error code.
  188083. */
  188084. static int sqlite3Fts5IndexOpen(
  188085. Fts5Config *pConfig,
  188086. int bCreate,
  188087. Fts5Index **pp,
  188088. char **pzErr
  188089. ){
  188090. int rc = SQLITE_OK;
  188091. Fts5Index *p; /* New object */
  188092. *pp = p = (Fts5Index*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Index));
  188093. if( rc==SQLITE_OK ){
  188094. p->pConfig = pConfig;
  188095. p->nWorkUnit = FTS5_WORK_UNIT;
  188096. p->zDataTbl = sqlite3Fts5Mprintf(&rc, "%s_data", pConfig->zName);
  188097. if( p->zDataTbl && bCreate ){
  188098. rc = sqlite3Fts5CreateTable(
  188099. pConfig, "data", "id INTEGER PRIMARY KEY, block BLOB", 0, pzErr
  188100. );
  188101. if( rc==SQLITE_OK ){
  188102. rc = sqlite3Fts5CreateTable(pConfig, "idx",
  188103. "segid, term, pgno, PRIMARY KEY(segid, term)",
  188104. 1, pzErr
  188105. );
  188106. }
  188107. if( rc==SQLITE_OK ){
  188108. rc = sqlite3Fts5IndexReinit(p);
  188109. }
  188110. }
  188111. }
  188112. assert( rc!=SQLITE_OK || p->rc==SQLITE_OK );
  188113. if( rc ){
  188114. sqlite3Fts5IndexClose(p);
  188115. *pp = 0;
  188116. }
  188117. return rc;
  188118. }
  188119. /*
  188120. ** Close a handle opened by an earlier call to sqlite3Fts5IndexOpen().
  188121. */
  188122. static int sqlite3Fts5IndexClose(Fts5Index *p){
  188123. int rc = SQLITE_OK;
  188124. if( p ){
  188125. assert( p->pReader==0 );
  188126. fts5StructureInvalidate(p);
  188127. sqlite3_finalize(p->pWriter);
  188128. sqlite3_finalize(p->pDeleter);
  188129. sqlite3_finalize(p->pIdxWriter);
  188130. sqlite3_finalize(p->pIdxDeleter);
  188131. sqlite3_finalize(p->pIdxSelect);
  188132. sqlite3_finalize(p->pDataVersion);
  188133. sqlite3Fts5HashFree(p->pHash);
  188134. sqlite3_free(p->zDataTbl);
  188135. sqlite3_free(p);
  188136. }
  188137. return rc;
  188138. }
  188139. /*
  188140. ** Argument p points to a buffer containing utf-8 text that is n bytes in
  188141. ** size. Return the number of bytes in the nChar character prefix of the
  188142. ** buffer, or 0 if there are less than nChar characters in total.
  188143. */
  188144. static int sqlite3Fts5IndexCharlenToBytelen(
  188145. const char *p,
  188146. int nByte,
  188147. int nChar
  188148. ){
  188149. int n = 0;
  188150. int i;
  188151. for(i=0; i<nChar; i++){
  188152. if( n>=nByte ) return 0; /* Input contains fewer than nChar chars */
  188153. if( (unsigned char)p[n++]>=0xc0 ){
  188154. while( (p[n] & 0xc0)==0x80 ) n++;
  188155. }
  188156. }
  188157. return n;
  188158. }
  188159. /*
  188160. ** pIn is a UTF-8 encoded string, nIn bytes in size. Return the number of
  188161. ** unicode characters in the string.
  188162. */
  188163. static int fts5IndexCharlen(const char *pIn, int nIn){
  188164. int nChar = 0;
  188165. int i = 0;
  188166. while( i<nIn ){
  188167. if( (unsigned char)pIn[i++]>=0xc0 ){
  188168. while( i<nIn && (pIn[i] & 0xc0)==0x80 ) i++;
  188169. }
  188170. nChar++;
  188171. }
  188172. return nChar;
  188173. }
  188174. /*
  188175. ** Insert or remove data to or from the index. Each time a document is
  188176. ** added to or removed from the index, this function is called one or more
  188177. ** times.
  188178. **
  188179. ** For an insert, it must be called once for each token in the new document.
  188180. ** If the operation is a delete, it must be called (at least) once for each
  188181. ** unique token in the document with an iCol value less than zero. The iPos
  188182. ** argument is ignored for a delete.
  188183. */
  188184. static int sqlite3Fts5IndexWrite(
  188185. Fts5Index *p, /* Index to write to */
  188186. int iCol, /* Column token appears in (-ve -> delete) */
  188187. int iPos, /* Position of token within column */
  188188. const char *pToken, int nToken /* Token to add or remove to or from index */
  188189. ){
  188190. int i; /* Used to iterate through indexes */
  188191. int rc = SQLITE_OK; /* Return code */
  188192. Fts5Config *pConfig = p->pConfig;
  188193. assert( p->rc==SQLITE_OK );
  188194. assert( (iCol<0)==p->bDelete );
  188195. /* Add the entry to the main terms index. */
  188196. rc = sqlite3Fts5HashWrite(
  188197. p->pHash, p->iWriteRowid, iCol, iPos, FTS5_MAIN_PREFIX, pToken, nToken
  188198. );
  188199. for(i=0; i<pConfig->nPrefix && rc==SQLITE_OK; i++){
  188200. const int nChar = pConfig->aPrefix[i];
  188201. int nByte = sqlite3Fts5IndexCharlenToBytelen(pToken, nToken, nChar);
  188202. if( nByte ){
  188203. rc = sqlite3Fts5HashWrite(p->pHash,
  188204. p->iWriteRowid, iCol, iPos, (char)(FTS5_MAIN_PREFIX+i+1), pToken,
  188205. nByte
  188206. );
  188207. }
  188208. }
  188209. return rc;
  188210. }
  188211. /*
  188212. ** Open a new iterator to iterate though all rowid that match the
  188213. ** specified token or token prefix.
  188214. */
  188215. static int sqlite3Fts5IndexQuery(
  188216. Fts5Index *p, /* FTS index to query */
  188217. const char *pToken, int nToken, /* Token (or prefix) to query for */
  188218. int flags, /* Mask of FTS5INDEX_QUERY_X flags */
  188219. Fts5Colset *pColset, /* Match these columns only */
  188220. Fts5IndexIter **ppIter /* OUT: New iterator object */
  188221. ){
  188222. Fts5Config *pConfig = p->pConfig;
  188223. Fts5Iter *pRet = 0;
  188224. Fts5Buffer buf = {0, 0, 0};
  188225. /* If the QUERY_SCAN flag is set, all other flags must be clear. */
  188226. assert( (flags & FTS5INDEX_QUERY_SCAN)==0 || flags==FTS5INDEX_QUERY_SCAN );
  188227. if( sqlite3Fts5BufferSize(&p->rc, &buf, nToken+1)==0 ){
  188228. int iIdx = 0; /* Index to search */
  188229. if( nToken ) memcpy(&buf.p[1], pToken, nToken);
  188230. /* Figure out which index to search and set iIdx accordingly. If this
  188231. ** is a prefix query for which there is no prefix index, set iIdx to
  188232. ** greater than pConfig->nPrefix to indicate that the query will be
  188233. ** satisfied by scanning multiple terms in the main index.
  188234. **
  188235. ** If the QUERY_TEST_NOIDX flag was specified, then this must be a
  188236. ** prefix-query. Instead of using a prefix-index (if one exists),
  188237. ** evaluate the prefix query using the main FTS index. This is used
  188238. ** for internal sanity checking by the integrity-check in debug
  188239. ** mode only. */
  188240. #ifdef SQLITE_DEBUG
  188241. if( pConfig->bPrefixIndex==0 || (flags & FTS5INDEX_QUERY_TEST_NOIDX) ){
  188242. assert( flags & FTS5INDEX_QUERY_PREFIX );
  188243. iIdx = 1+pConfig->nPrefix;
  188244. }else
  188245. #endif
  188246. if( flags & FTS5INDEX_QUERY_PREFIX ){
  188247. int nChar = fts5IndexCharlen(pToken, nToken);
  188248. for(iIdx=1; iIdx<=pConfig->nPrefix; iIdx++){
  188249. if( pConfig->aPrefix[iIdx-1]==nChar ) break;
  188250. }
  188251. }
  188252. if( iIdx<=pConfig->nPrefix ){
  188253. /* Straight index lookup */
  188254. Fts5Structure *pStruct = fts5StructureRead(p);
  188255. buf.p[0] = (u8)(FTS5_MAIN_PREFIX + iIdx);
  188256. if( pStruct ){
  188257. fts5MultiIterNew(p, pStruct, flags | FTS5INDEX_QUERY_SKIPEMPTY,
  188258. pColset, buf.p, nToken+1, -1, 0, &pRet
  188259. );
  188260. fts5StructureRelease(pStruct);
  188261. }
  188262. }else{
  188263. /* Scan multiple terms in the main index */
  188264. int bDesc = (flags & FTS5INDEX_QUERY_DESC)!=0;
  188265. buf.p[0] = FTS5_MAIN_PREFIX;
  188266. fts5SetupPrefixIter(p, bDesc, buf.p, nToken+1, pColset, &pRet);
  188267. assert( p->rc!=SQLITE_OK || pRet->pColset==0 );
  188268. fts5IterSetOutputCb(&p->rc, pRet);
  188269. if( p->rc==SQLITE_OK ){
  188270. Fts5SegIter *pSeg = &pRet->aSeg[pRet->aFirst[1].iFirst];
  188271. if( pSeg->pLeaf ) pRet->xSetOutputs(pRet, pSeg);
  188272. }
  188273. }
  188274. if( p->rc ){
  188275. sqlite3Fts5IterClose((Fts5IndexIter*)pRet);
  188276. pRet = 0;
  188277. fts5CloseReader(p);
  188278. }
  188279. *ppIter = &pRet->base;
  188280. sqlite3Fts5BufferFree(&buf);
  188281. }
  188282. return fts5IndexReturn(p);
  188283. }
  188284. /*
  188285. ** Return true if the iterator passed as the only argument is at EOF.
  188286. */
  188287. /*
  188288. ** Move to the next matching rowid.
  188289. */
  188290. static int sqlite3Fts5IterNext(Fts5IndexIter *pIndexIter){
  188291. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  188292. assert( pIter->pIndex->rc==SQLITE_OK );
  188293. fts5MultiIterNext(pIter->pIndex, pIter, 0, 0);
  188294. return fts5IndexReturn(pIter->pIndex);
  188295. }
  188296. /*
  188297. ** Move to the next matching term/rowid. Used by the fts5vocab module.
  188298. */
  188299. static int sqlite3Fts5IterNextScan(Fts5IndexIter *pIndexIter){
  188300. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  188301. Fts5Index *p = pIter->pIndex;
  188302. assert( pIter->pIndex->rc==SQLITE_OK );
  188303. fts5MultiIterNext(p, pIter, 0, 0);
  188304. if( p->rc==SQLITE_OK ){
  188305. Fts5SegIter *pSeg = &pIter->aSeg[ pIter->aFirst[1].iFirst ];
  188306. if( pSeg->pLeaf && pSeg->term.p[0]!=FTS5_MAIN_PREFIX ){
  188307. fts5DataRelease(pSeg->pLeaf);
  188308. pSeg->pLeaf = 0;
  188309. pIter->base.bEof = 1;
  188310. }
  188311. }
  188312. return fts5IndexReturn(pIter->pIndex);
  188313. }
  188314. /*
  188315. ** Move to the next matching rowid that occurs at or after iMatch. The
  188316. ** definition of "at or after" depends on whether this iterator iterates
  188317. ** in ascending or descending rowid order.
  188318. */
  188319. static int sqlite3Fts5IterNextFrom(Fts5IndexIter *pIndexIter, i64 iMatch){
  188320. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  188321. fts5MultiIterNextFrom(pIter->pIndex, pIter, iMatch);
  188322. return fts5IndexReturn(pIter->pIndex);
  188323. }
  188324. /*
  188325. ** Return the current term.
  188326. */
  188327. static const char *sqlite3Fts5IterTerm(Fts5IndexIter *pIndexIter, int *pn){
  188328. int n;
  188329. const char *z = (const char*)fts5MultiIterTerm((Fts5Iter*)pIndexIter, &n);
  188330. *pn = n-1;
  188331. return &z[1];
  188332. }
  188333. /*
  188334. ** Close an iterator opened by an earlier call to sqlite3Fts5IndexQuery().
  188335. */
  188336. static void sqlite3Fts5IterClose(Fts5IndexIter *pIndexIter){
  188337. if( pIndexIter ){
  188338. Fts5Iter *pIter = (Fts5Iter*)pIndexIter;
  188339. Fts5Index *pIndex = pIter->pIndex;
  188340. fts5MultiIterFree(pIter);
  188341. fts5CloseReader(pIndex);
  188342. }
  188343. }
  188344. /*
  188345. ** Read and decode the "averages" record from the database.
  188346. **
  188347. ** Parameter anSize must point to an array of size nCol, where nCol is
  188348. ** the number of user defined columns in the FTS table.
  188349. */
  188350. static int sqlite3Fts5IndexGetAverages(Fts5Index *p, i64 *pnRow, i64 *anSize){
  188351. int nCol = p->pConfig->nCol;
  188352. Fts5Data *pData;
  188353. *pnRow = 0;
  188354. memset(anSize, 0, sizeof(i64) * nCol);
  188355. pData = fts5DataRead(p, FTS5_AVERAGES_ROWID);
  188356. if( p->rc==SQLITE_OK && pData->nn ){
  188357. int i = 0;
  188358. int iCol;
  188359. i += fts5GetVarint(&pData->p[i], (u64*)pnRow);
  188360. for(iCol=0; i<pData->nn && iCol<nCol; iCol++){
  188361. i += fts5GetVarint(&pData->p[i], (u64*)&anSize[iCol]);
  188362. }
  188363. }
  188364. fts5DataRelease(pData);
  188365. return fts5IndexReturn(p);
  188366. }
  188367. /*
  188368. ** Replace the current "averages" record with the contents of the buffer
  188369. ** supplied as the second argument.
  188370. */
  188371. static int sqlite3Fts5IndexSetAverages(Fts5Index *p, const u8 *pData, int nData){
  188372. assert( p->rc==SQLITE_OK );
  188373. fts5DataWrite(p, FTS5_AVERAGES_ROWID, pData, nData);
  188374. return fts5IndexReturn(p);
  188375. }
  188376. /*
  188377. ** Return the total number of blocks this module has read from the %_data
  188378. ** table since it was created.
  188379. */
  188380. static int sqlite3Fts5IndexReads(Fts5Index *p){
  188381. return p->nRead;
  188382. }
  188383. /*
  188384. ** Set the 32-bit cookie value stored at the start of all structure
  188385. ** records to the value passed as the second argument.
  188386. **
  188387. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  188388. ** occurs.
  188389. */
  188390. static int sqlite3Fts5IndexSetCookie(Fts5Index *p, int iNew){
  188391. int rc; /* Return code */
  188392. Fts5Config *pConfig = p->pConfig; /* Configuration object */
  188393. u8 aCookie[4]; /* Binary representation of iNew */
  188394. sqlite3_blob *pBlob = 0;
  188395. assert( p->rc==SQLITE_OK );
  188396. sqlite3Fts5Put32(aCookie, iNew);
  188397. rc = sqlite3_blob_open(pConfig->db, pConfig->zDb, p->zDataTbl,
  188398. "block", FTS5_STRUCTURE_ROWID, 1, &pBlob
  188399. );
  188400. if( rc==SQLITE_OK ){
  188401. sqlite3_blob_write(pBlob, aCookie, 4, 0);
  188402. rc = sqlite3_blob_close(pBlob);
  188403. }
  188404. return rc;
  188405. }
  188406. static int sqlite3Fts5IndexLoadConfig(Fts5Index *p){
  188407. Fts5Structure *pStruct;
  188408. pStruct = fts5StructureRead(p);
  188409. fts5StructureRelease(pStruct);
  188410. return fts5IndexReturn(p);
  188411. }
  188412. /*************************************************************************
  188413. **************************************************************************
  188414. ** Below this point is the implementation of the integrity-check
  188415. ** functionality.
  188416. */
  188417. /*
  188418. ** Return a simple checksum value based on the arguments.
  188419. */
  188420. static u64 sqlite3Fts5IndexEntryCksum(
  188421. i64 iRowid,
  188422. int iCol,
  188423. int iPos,
  188424. int iIdx,
  188425. const char *pTerm,
  188426. int nTerm
  188427. ){
  188428. int i;
  188429. u64 ret = iRowid;
  188430. ret += (ret<<3) + iCol;
  188431. ret += (ret<<3) + iPos;
  188432. if( iIdx>=0 ) ret += (ret<<3) + (FTS5_MAIN_PREFIX + iIdx);
  188433. for(i=0; i<nTerm; i++) ret += (ret<<3) + pTerm[i];
  188434. return ret;
  188435. }
  188436. #ifdef SQLITE_DEBUG
  188437. /*
  188438. ** This function is purely an internal test. It does not contribute to
  188439. ** FTS functionality, or even the integrity-check, in any way.
  188440. **
  188441. ** Instead, it tests that the same set of pgno/rowid combinations are
  188442. ** visited regardless of whether the doclist-index identified by parameters
  188443. ** iSegid/iLeaf is iterated in forwards or reverse order.
  188444. */
  188445. static void fts5TestDlidxReverse(
  188446. Fts5Index *p,
  188447. int iSegid, /* Segment id to load from */
  188448. int iLeaf /* Load doclist-index for this leaf */
  188449. ){
  188450. Fts5DlidxIter *pDlidx = 0;
  188451. u64 cksum1 = 13;
  188452. u64 cksum2 = 13;
  188453. for(pDlidx=fts5DlidxIterInit(p, 0, iSegid, iLeaf);
  188454. fts5DlidxIterEof(p, pDlidx)==0;
  188455. fts5DlidxIterNext(p, pDlidx)
  188456. ){
  188457. i64 iRowid = fts5DlidxIterRowid(pDlidx);
  188458. int pgno = fts5DlidxIterPgno(pDlidx);
  188459. assert( pgno>iLeaf );
  188460. cksum1 += iRowid + ((i64)pgno<<32);
  188461. }
  188462. fts5DlidxIterFree(pDlidx);
  188463. pDlidx = 0;
  188464. for(pDlidx=fts5DlidxIterInit(p, 1, iSegid, iLeaf);
  188465. fts5DlidxIterEof(p, pDlidx)==0;
  188466. fts5DlidxIterPrev(p, pDlidx)
  188467. ){
  188468. i64 iRowid = fts5DlidxIterRowid(pDlidx);
  188469. int pgno = fts5DlidxIterPgno(pDlidx);
  188470. assert( fts5DlidxIterPgno(pDlidx)>iLeaf );
  188471. cksum2 += iRowid + ((i64)pgno<<32);
  188472. }
  188473. fts5DlidxIterFree(pDlidx);
  188474. pDlidx = 0;
  188475. if( p->rc==SQLITE_OK && cksum1!=cksum2 ) p->rc = FTS5_CORRUPT;
  188476. }
  188477. static int fts5QueryCksum(
  188478. Fts5Index *p, /* Fts5 index object */
  188479. int iIdx,
  188480. const char *z, /* Index key to query for */
  188481. int n, /* Size of index key in bytes */
  188482. int flags, /* Flags for Fts5IndexQuery */
  188483. u64 *pCksum /* IN/OUT: Checksum value */
  188484. ){
  188485. int eDetail = p->pConfig->eDetail;
  188486. u64 cksum = *pCksum;
  188487. Fts5IndexIter *pIter = 0;
  188488. int rc = sqlite3Fts5IndexQuery(p, z, n, flags, 0, &pIter);
  188489. while( rc==SQLITE_OK && 0==sqlite3Fts5IterEof(pIter) ){
  188490. i64 rowid = pIter->iRowid;
  188491. if( eDetail==FTS5_DETAIL_NONE ){
  188492. cksum ^= sqlite3Fts5IndexEntryCksum(rowid, 0, 0, iIdx, z, n);
  188493. }else{
  188494. Fts5PoslistReader sReader;
  188495. for(sqlite3Fts5PoslistReaderInit(pIter->pData, pIter->nData, &sReader);
  188496. sReader.bEof==0;
  188497. sqlite3Fts5PoslistReaderNext(&sReader)
  188498. ){
  188499. int iCol = FTS5_POS2COLUMN(sReader.iPos);
  188500. int iOff = FTS5_POS2OFFSET(sReader.iPos);
  188501. cksum ^= sqlite3Fts5IndexEntryCksum(rowid, iCol, iOff, iIdx, z, n);
  188502. }
  188503. }
  188504. if( rc==SQLITE_OK ){
  188505. rc = sqlite3Fts5IterNext(pIter);
  188506. }
  188507. }
  188508. sqlite3Fts5IterClose(pIter);
  188509. *pCksum = cksum;
  188510. return rc;
  188511. }
  188512. /*
  188513. ** This function is also purely an internal test. It does not contribute to
  188514. ** FTS functionality, or even the integrity-check, in any way.
  188515. */
  188516. static void fts5TestTerm(
  188517. Fts5Index *p,
  188518. Fts5Buffer *pPrev, /* Previous term */
  188519. const char *z, int n, /* Possibly new term to test */
  188520. u64 expected,
  188521. u64 *pCksum
  188522. ){
  188523. int rc = p->rc;
  188524. if( pPrev->n==0 ){
  188525. fts5BufferSet(&rc, pPrev, n, (const u8*)z);
  188526. }else
  188527. if( rc==SQLITE_OK && (pPrev->n!=n || memcmp(pPrev->p, z, n)) ){
  188528. u64 cksum3 = *pCksum;
  188529. const char *zTerm = (const char*)&pPrev->p[1]; /* term sans prefix-byte */
  188530. int nTerm = pPrev->n-1; /* Size of zTerm in bytes */
  188531. int iIdx = (pPrev->p[0] - FTS5_MAIN_PREFIX);
  188532. int flags = (iIdx==0 ? 0 : FTS5INDEX_QUERY_PREFIX);
  188533. u64 ck1 = 0;
  188534. u64 ck2 = 0;
  188535. /* Check that the results returned for ASC and DESC queries are
  188536. ** the same. If not, call this corruption. */
  188537. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, flags, &ck1);
  188538. if( rc==SQLITE_OK ){
  188539. int f = flags|FTS5INDEX_QUERY_DESC;
  188540. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, f, &ck2);
  188541. }
  188542. if( rc==SQLITE_OK && ck1!=ck2 ) rc = FTS5_CORRUPT;
  188543. /* If this is a prefix query, check that the results returned if the
  188544. ** the index is disabled are the same. In both ASC and DESC order.
  188545. **
  188546. ** This check may only be performed if the hash table is empty. This
  188547. ** is because the hash table only supports a single scan query at
  188548. ** a time, and the multi-iter loop from which this function is called
  188549. ** is already performing such a scan. */
  188550. if( p->nPendingData==0 ){
  188551. if( iIdx>0 && rc==SQLITE_OK ){
  188552. int f = flags|FTS5INDEX_QUERY_TEST_NOIDX;
  188553. ck2 = 0;
  188554. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, f, &ck2);
  188555. if( rc==SQLITE_OK && ck1!=ck2 ) rc = FTS5_CORRUPT;
  188556. }
  188557. if( iIdx>0 && rc==SQLITE_OK ){
  188558. int f = flags|FTS5INDEX_QUERY_TEST_NOIDX|FTS5INDEX_QUERY_DESC;
  188559. ck2 = 0;
  188560. rc = fts5QueryCksum(p, iIdx, zTerm, nTerm, f, &ck2);
  188561. if( rc==SQLITE_OK && ck1!=ck2 ) rc = FTS5_CORRUPT;
  188562. }
  188563. }
  188564. cksum3 ^= ck1;
  188565. fts5BufferSet(&rc, pPrev, n, (const u8*)z);
  188566. if( rc==SQLITE_OK && cksum3!=expected ){
  188567. rc = FTS5_CORRUPT;
  188568. }
  188569. *pCksum = cksum3;
  188570. }
  188571. p->rc = rc;
  188572. }
  188573. #else
  188574. # define fts5TestDlidxReverse(x,y,z)
  188575. # define fts5TestTerm(u,v,w,x,y,z)
  188576. #endif
  188577. /*
  188578. ** Check that:
  188579. **
  188580. ** 1) All leaves of pSeg between iFirst and iLast (inclusive) exist and
  188581. ** contain zero terms.
  188582. ** 2) All leaves of pSeg between iNoRowid and iLast (inclusive) exist and
  188583. ** contain zero rowids.
  188584. */
  188585. static void fts5IndexIntegrityCheckEmpty(
  188586. Fts5Index *p,
  188587. Fts5StructureSegment *pSeg, /* Segment to check internal consistency */
  188588. int iFirst,
  188589. int iNoRowid,
  188590. int iLast
  188591. ){
  188592. int i;
  188593. /* Now check that the iter.nEmpty leaves following the current leaf
  188594. ** (a) exist and (b) contain no terms. */
  188595. for(i=iFirst; p->rc==SQLITE_OK && i<=iLast; i++){
  188596. Fts5Data *pLeaf = fts5DataRead(p, FTS5_SEGMENT_ROWID(pSeg->iSegid, i));
  188597. if( pLeaf ){
  188598. if( !fts5LeafIsTermless(pLeaf) ) p->rc = FTS5_CORRUPT;
  188599. if( i>=iNoRowid && 0!=fts5LeafFirstRowidOff(pLeaf) ) p->rc = FTS5_CORRUPT;
  188600. }
  188601. fts5DataRelease(pLeaf);
  188602. }
  188603. }
  188604. static void fts5IntegrityCheckPgidx(Fts5Index *p, Fts5Data *pLeaf){
  188605. int iTermOff = 0;
  188606. int ii;
  188607. Fts5Buffer buf1 = {0,0,0};
  188608. Fts5Buffer buf2 = {0,0,0};
  188609. ii = pLeaf->szLeaf;
  188610. while( ii<pLeaf->nn && p->rc==SQLITE_OK ){
  188611. int res;
  188612. int iOff;
  188613. int nIncr;
  188614. ii += fts5GetVarint32(&pLeaf->p[ii], nIncr);
  188615. iTermOff += nIncr;
  188616. iOff = iTermOff;
  188617. if( iOff>=pLeaf->szLeaf ){
  188618. p->rc = FTS5_CORRUPT;
  188619. }else if( iTermOff==nIncr ){
  188620. int nByte;
  188621. iOff += fts5GetVarint32(&pLeaf->p[iOff], nByte);
  188622. if( (iOff+nByte)>pLeaf->szLeaf ){
  188623. p->rc = FTS5_CORRUPT;
  188624. }else{
  188625. fts5BufferSet(&p->rc, &buf1, nByte, &pLeaf->p[iOff]);
  188626. }
  188627. }else{
  188628. int nKeep, nByte;
  188629. iOff += fts5GetVarint32(&pLeaf->p[iOff], nKeep);
  188630. iOff += fts5GetVarint32(&pLeaf->p[iOff], nByte);
  188631. if( nKeep>buf1.n || (iOff+nByte)>pLeaf->szLeaf ){
  188632. p->rc = FTS5_CORRUPT;
  188633. }else{
  188634. buf1.n = nKeep;
  188635. fts5BufferAppendBlob(&p->rc, &buf1, nByte, &pLeaf->p[iOff]);
  188636. }
  188637. if( p->rc==SQLITE_OK ){
  188638. res = fts5BufferCompare(&buf1, &buf2);
  188639. if( res<=0 ) p->rc = FTS5_CORRUPT;
  188640. }
  188641. }
  188642. fts5BufferSet(&p->rc, &buf2, buf1.n, buf1.p);
  188643. }
  188644. fts5BufferFree(&buf1);
  188645. fts5BufferFree(&buf2);
  188646. }
  188647. static void fts5IndexIntegrityCheckSegment(
  188648. Fts5Index *p, /* FTS5 backend object */
  188649. Fts5StructureSegment *pSeg /* Segment to check internal consistency */
  188650. ){
  188651. Fts5Config *pConfig = p->pConfig;
  188652. sqlite3_stmt *pStmt = 0;
  188653. int rc2;
  188654. int iIdxPrevLeaf = pSeg->pgnoFirst-1;
  188655. int iDlidxPrevLeaf = pSeg->pgnoLast;
  188656. if( pSeg->pgnoFirst==0 ) return;
  188657. fts5IndexPrepareStmt(p, &pStmt, sqlite3_mprintf(
  188658. "SELECT segid, term, (pgno>>1), (pgno&1) FROM %Q.'%q_idx' WHERE segid=%d",
  188659. pConfig->zDb, pConfig->zName, pSeg->iSegid
  188660. ));
  188661. /* Iterate through the b-tree hierarchy. */
  188662. while( p->rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pStmt) ){
  188663. i64 iRow; /* Rowid for this leaf */
  188664. Fts5Data *pLeaf; /* Data for this leaf */
  188665. int nIdxTerm = sqlite3_column_bytes(pStmt, 1);
  188666. const char *zIdxTerm = (const char*)sqlite3_column_text(pStmt, 1);
  188667. int iIdxLeaf = sqlite3_column_int(pStmt, 2);
  188668. int bIdxDlidx = sqlite3_column_int(pStmt, 3);
  188669. /* If the leaf in question has already been trimmed from the segment,
  188670. ** ignore this b-tree entry. Otherwise, load it into memory. */
  188671. if( iIdxLeaf<pSeg->pgnoFirst ) continue;
  188672. iRow = FTS5_SEGMENT_ROWID(pSeg->iSegid, iIdxLeaf);
  188673. pLeaf = fts5LeafRead(p, iRow);
  188674. if( pLeaf==0 ) break;
  188675. /* Check that the leaf contains at least one term, and that it is equal
  188676. ** to or larger than the split-key in zIdxTerm. Also check that if there
  188677. ** is also a rowid pointer within the leaf page header, it points to a
  188678. ** location before the term. */
  188679. if( pLeaf->nn<=pLeaf->szLeaf ){
  188680. p->rc = FTS5_CORRUPT;
  188681. }else{
  188682. int iOff; /* Offset of first term on leaf */
  188683. int iRowidOff; /* Offset of first rowid on leaf */
  188684. int nTerm; /* Size of term on leaf in bytes */
  188685. int res; /* Comparison of term and split-key */
  188686. iOff = fts5LeafFirstTermOff(pLeaf);
  188687. iRowidOff = fts5LeafFirstRowidOff(pLeaf);
  188688. if( iRowidOff>=iOff ){
  188689. p->rc = FTS5_CORRUPT;
  188690. }else{
  188691. iOff += fts5GetVarint32(&pLeaf->p[iOff], nTerm);
  188692. res = memcmp(&pLeaf->p[iOff], zIdxTerm, MIN(nTerm, nIdxTerm));
  188693. if( res==0 ) res = nTerm - nIdxTerm;
  188694. if( res<0 ) p->rc = FTS5_CORRUPT;
  188695. }
  188696. fts5IntegrityCheckPgidx(p, pLeaf);
  188697. }
  188698. fts5DataRelease(pLeaf);
  188699. if( p->rc ) break;
  188700. /* Now check that the iter.nEmpty leaves following the current leaf
  188701. ** (a) exist and (b) contain no terms. */
  188702. fts5IndexIntegrityCheckEmpty(
  188703. p, pSeg, iIdxPrevLeaf+1, iDlidxPrevLeaf+1, iIdxLeaf-1
  188704. );
  188705. if( p->rc ) break;
  188706. /* If there is a doclist-index, check that it looks right. */
  188707. if( bIdxDlidx ){
  188708. Fts5DlidxIter *pDlidx = 0; /* For iterating through doclist index */
  188709. int iPrevLeaf = iIdxLeaf;
  188710. int iSegid = pSeg->iSegid;
  188711. int iPg = 0;
  188712. i64 iKey;
  188713. for(pDlidx=fts5DlidxIterInit(p, 0, iSegid, iIdxLeaf);
  188714. fts5DlidxIterEof(p, pDlidx)==0;
  188715. fts5DlidxIterNext(p, pDlidx)
  188716. ){
  188717. /* Check any rowid-less pages that occur before the current leaf. */
  188718. for(iPg=iPrevLeaf+1; iPg<fts5DlidxIterPgno(pDlidx); iPg++){
  188719. iKey = FTS5_SEGMENT_ROWID(iSegid, iPg);
  188720. pLeaf = fts5DataRead(p, iKey);
  188721. if( pLeaf ){
  188722. if( fts5LeafFirstRowidOff(pLeaf)!=0 ) p->rc = FTS5_CORRUPT;
  188723. fts5DataRelease(pLeaf);
  188724. }
  188725. }
  188726. iPrevLeaf = fts5DlidxIterPgno(pDlidx);
  188727. /* Check that the leaf page indicated by the iterator really does
  188728. ** contain the rowid suggested by the same. */
  188729. iKey = FTS5_SEGMENT_ROWID(iSegid, iPrevLeaf);
  188730. pLeaf = fts5DataRead(p, iKey);
  188731. if( pLeaf ){
  188732. i64 iRowid;
  188733. int iRowidOff = fts5LeafFirstRowidOff(pLeaf);
  188734. ASSERT_SZLEAF_OK(pLeaf);
  188735. if( iRowidOff>=pLeaf->szLeaf ){
  188736. p->rc = FTS5_CORRUPT;
  188737. }else{
  188738. fts5GetVarint(&pLeaf->p[iRowidOff], (u64*)&iRowid);
  188739. if( iRowid!=fts5DlidxIterRowid(pDlidx) ) p->rc = FTS5_CORRUPT;
  188740. }
  188741. fts5DataRelease(pLeaf);
  188742. }
  188743. }
  188744. iDlidxPrevLeaf = iPg;
  188745. fts5DlidxIterFree(pDlidx);
  188746. fts5TestDlidxReverse(p, iSegid, iIdxLeaf);
  188747. }else{
  188748. iDlidxPrevLeaf = pSeg->pgnoLast;
  188749. /* TODO: Check there is no doclist index */
  188750. }
  188751. iIdxPrevLeaf = iIdxLeaf;
  188752. }
  188753. rc2 = sqlite3_finalize(pStmt);
  188754. if( p->rc==SQLITE_OK ) p->rc = rc2;
  188755. /* Page iter.iLeaf must now be the rightmost leaf-page in the segment */
  188756. #if 0
  188757. if( p->rc==SQLITE_OK && iter.iLeaf!=pSeg->pgnoLast ){
  188758. p->rc = FTS5_CORRUPT;
  188759. }
  188760. #endif
  188761. }
  188762. /*
  188763. ** Run internal checks to ensure that the FTS index (a) is internally
  188764. ** consistent and (b) contains entries for which the XOR of the checksums
  188765. ** as calculated by sqlite3Fts5IndexEntryCksum() is cksum.
  188766. **
  188767. ** Return SQLITE_CORRUPT if any of the internal checks fail, or if the
  188768. ** checksum does not match. Return SQLITE_OK if all checks pass without
  188769. ** error, or some other SQLite error code if another error (e.g. OOM)
  188770. ** occurs.
  188771. */
  188772. static int sqlite3Fts5IndexIntegrityCheck(Fts5Index *p, u64 cksum){
  188773. int eDetail = p->pConfig->eDetail;
  188774. u64 cksum2 = 0; /* Checksum based on contents of indexes */
  188775. Fts5Buffer poslist = {0,0,0}; /* Buffer used to hold a poslist */
  188776. Fts5Iter *pIter; /* Used to iterate through entire index */
  188777. Fts5Structure *pStruct; /* Index structure */
  188778. #ifdef SQLITE_DEBUG
  188779. /* Used by extra internal tests only run if NDEBUG is not defined */
  188780. u64 cksum3 = 0; /* Checksum based on contents of indexes */
  188781. Fts5Buffer term = {0,0,0}; /* Buffer used to hold most recent term */
  188782. #endif
  188783. const int flags = FTS5INDEX_QUERY_NOOUTPUT;
  188784. /* Load the FTS index structure */
  188785. pStruct = fts5StructureRead(p);
  188786. /* Check that the internal nodes of each segment match the leaves */
  188787. if( pStruct ){
  188788. int iLvl, iSeg;
  188789. for(iLvl=0; iLvl<pStruct->nLevel; iLvl++){
  188790. for(iSeg=0; iSeg<pStruct->aLevel[iLvl].nSeg; iSeg++){
  188791. Fts5StructureSegment *pSeg = &pStruct->aLevel[iLvl].aSeg[iSeg];
  188792. fts5IndexIntegrityCheckSegment(p, pSeg);
  188793. }
  188794. }
  188795. }
  188796. /* The cksum argument passed to this function is a checksum calculated
  188797. ** based on all expected entries in the FTS index (including prefix index
  188798. ** entries). This block checks that a checksum calculated based on the
  188799. ** actual contents of FTS index is identical.
  188800. **
  188801. ** Two versions of the same checksum are calculated. The first (stack
  188802. ** variable cksum2) based on entries extracted from the full-text index
  188803. ** while doing a linear scan of each individual index in turn.
  188804. **
  188805. ** As each term visited by the linear scans, a separate query for the
  188806. ** same term is performed. cksum3 is calculated based on the entries
  188807. ** extracted by these queries.
  188808. */
  188809. for(fts5MultiIterNew(p, pStruct, flags, 0, 0, 0, -1, 0, &pIter);
  188810. fts5MultiIterEof(p, pIter)==0;
  188811. fts5MultiIterNext(p, pIter, 0, 0)
  188812. ){
  188813. int n; /* Size of term in bytes */
  188814. i64 iPos = 0; /* Position read from poslist */
  188815. int iOff = 0; /* Offset within poslist */
  188816. i64 iRowid = fts5MultiIterRowid(pIter);
  188817. char *z = (char*)fts5MultiIterTerm(pIter, &n);
  188818. /* If this is a new term, query for it. Update cksum3 with the results. */
  188819. fts5TestTerm(p, &term, z, n, cksum2, &cksum3);
  188820. if( eDetail==FTS5_DETAIL_NONE ){
  188821. if( 0==fts5MultiIterIsEmpty(p, pIter) ){
  188822. cksum2 ^= sqlite3Fts5IndexEntryCksum(iRowid, 0, 0, -1, z, n);
  188823. }
  188824. }else{
  188825. poslist.n = 0;
  188826. fts5SegiterPoslist(p, &pIter->aSeg[pIter->aFirst[1].iFirst], 0, &poslist);
  188827. while( 0==sqlite3Fts5PoslistNext64(poslist.p, poslist.n, &iOff, &iPos) ){
  188828. int iCol = FTS5_POS2COLUMN(iPos);
  188829. int iTokOff = FTS5_POS2OFFSET(iPos);
  188830. cksum2 ^= sqlite3Fts5IndexEntryCksum(iRowid, iCol, iTokOff, -1, z, n);
  188831. }
  188832. }
  188833. }
  188834. fts5TestTerm(p, &term, 0, 0, cksum2, &cksum3);
  188835. fts5MultiIterFree(pIter);
  188836. if( p->rc==SQLITE_OK && cksum!=cksum2 ) p->rc = FTS5_CORRUPT;
  188837. fts5StructureRelease(pStruct);
  188838. #ifdef SQLITE_DEBUG
  188839. fts5BufferFree(&term);
  188840. #endif
  188841. fts5BufferFree(&poslist);
  188842. return fts5IndexReturn(p);
  188843. }
  188844. /*************************************************************************
  188845. **************************************************************************
  188846. ** Below this point is the implementation of the fts5_decode() scalar
  188847. ** function only.
  188848. */
  188849. /*
  188850. ** Decode a segment-data rowid from the %_data table. This function is
  188851. ** the opposite of macro FTS5_SEGMENT_ROWID().
  188852. */
  188853. static void fts5DecodeRowid(
  188854. i64 iRowid, /* Rowid from %_data table */
  188855. int *piSegid, /* OUT: Segment id */
  188856. int *pbDlidx, /* OUT: Dlidx flag */
  188857. int *piHeight, /* OUT: Height */
  188858. int *piPgno /* OUT: Page number */
  188859. ){
  188860. *piPgno = (int)(iRowid & (((i64)1 << FTS5_DATA_PAGE_B) - 1));
  188861. iRowid >>= FTS5_DATA_PAGE_B;
  188862. *piHeight = (int)(iRowid & (((i64)1 << FTS5_DATA_HEIGHT_B) - 1));
  188863. iRowid >>= FTS5_DATA_HEIGHT_B;
  188864. *pbDlidx = (int)(iRowid & 0x0001);
  188865. iRowid >>= FTS5_DATA_DLI_B;
  188866. *piSegid = (int)(iRowid & (((i64)1 << FTS5_DATA_ID_B) - 1));
  188867. }
  188868. static void fts5DebugRowid(int *pRc, Fts5Buffer *pBuf, i64 iKey){
  188869. int iSegid, iHeight, iPgno, bDlidx; /* Rowid compenents */
  188870. fts5DecodeRowid(iKey, &iSegid, &bDlidx, &iHeight, &iPgno);
  188871. if( iSegid==0 ){
  188872. if( iKey==FTS5_AVERAGES_ROWID ){
  188873. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "{averages} ");
  188874. }else{
  188875. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "{structure}");
  188876. }
  188877. }
  188878. else{
  188879. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "{%ssegid=%d h=%d pgno=%d}",
  188880. bDlidx ? "dlidx " : "", iSegid, iHeight, iPgno
  188881. );
  188882. }
  188883. }
  188884. static void fts5DebugStructure(
  188885. int *pRc, /* IN/OUT: error code */
  188886. Fts5Buffer *pBuf,
  188887. Fts5Structure *p
  188888. ){
  188889. int iLvl, iSeg; /* Iterate through levels, segments */
  188890. for(iLvl=0; iLvl<p->nLevel; iLvl++){
  188891. Fts5StructureLevel *pLvl = &p->aLevel[iLvl];
  188892. sqlite3Fts5BufferAppendPrintf(pRc, pBuf,
  188893. " {lvl=%d nMerge=%d nSeg=%d", iLvl, pLvl->nMerge, pLvl->nSeg
  188894. );
  188895. for(iSeg=0; iSeg<pLvl->nSeg; iSeg++){
  188896. Fts5StructureSegment *pSeg = &pLvl->aSeg[iSeg];
  188897. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " {id=%d leaves=%d..%d}",
  188898. pSeg->iSegid, pSeg->pgnoFirst, pSeg->pgnoLast
  188899. );
  188900. }
  188901. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "}");
  188902. }
  188903. }
  188904. /*
  188905. ** This is part of the fts5_decode() debugging aid.
  188906. **
  188907. ** Arguments pBlob/nBlob contain a serialized Fts5Structure object. This
  188908. ** function appends a human-readable representation of the same object
  188909. ** to the buffer passed as the second argument.
  188910. */
  188911. static void fts5DecodeStructure(
  188912. int *pRc, /* IN/OUT: error code */
  188913. Fts5Buffer *pBuf,
  188914. const u8 *pBlob, int nBlob
  188915. ){
  188916. int rc; /* Return code */
  188917. Fts5Structure *p = 0; /* Decoded structure object */
  188918. rc = fts5StructureDecode(pBlob, nBlob, 0, &p);
  188919. if( rc!=SQLITE_OK ){
  188920. *pRc = rc;
  188921. return;
  188922. }
  188923. fts5DebugStructure(pRc, pBuf, p);
  188924. fts5StructureRelease(p);
  188925. }
  188926. /*
  188927. ** This is part of the fts5_decode() debugging aid.
  188928. **
  188929. ** Arguments pBlob/nBlob contain an "averages" record. This function
  188930. ** appends a human-readable representation of record to the buffer passed
  188931. ** as the second argument.
  188932. */
  188933. static void fts5DecodeAverages(
  188934. int *pRc, /* IN/OUT: error code */
  188935. Fts5Buffer *pBuf,
  188936. const u8 *pBlob, int nBlob
  188937. ){
  188938. int i = 0;
  188939. const char *zSpace = "";
  188940. while( i<nBlob ){
  188941. u64 iVal;
  188942. i += sqlite3Fts5GetVarint(&pBlob[i], &iVal);
  188943. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, "%s%d", zSpace, (int)iVal);
  188944. zSpace = " ";
  188945. }
  188946. }
  188947. /*
  188948. ** Buffer (a/n) is assumed to contain a list of serialized varints. Read
  188949. ** each varint and append its string representation to buffer pBuf. Return
  188950. ** after either the input buffer is exhausted or a 0 value is read.
  188951. **
  188952. ** The return value is the number of bytes read from the input buffer.
  188953. */
  188954. static int fts5DecodePoslist(int *pRc, Fts5Buffer *pBuf, const u8 *a, int n){
  188955. int iOff = 0;
  188956. while( iOff<n ){
  188957. int iVal;
  188958. iOff += fts5GetVarint32(&a[iOff], iVal);
  188959. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " %d", iVal);
  188960. }
  188961. return iOff;
  188962. }
  188963. /*
  188964. ** The start of buffer (a/n) contains the start of a doclist. The doclist
  188965. ** may or may not finish within the buffer. This function appends a text
  188966. ** representation of the part of the doclist that is present to buffer
  188967. ** pBuf.
  188968. **
  188969. ** The return value is the number of bytes read from the input buffer.
  188970. */
  188971. static int fts5DecodeDoclist(int *pRc, Fts5Buffer *pBuf, const u8 *a, int n){
  188972. i64 iDocid = 0;
  188973. int iOff = 0;
  188974. if( n>0 ){
  188975. iOff = sqlite3Fts5GetVarint(a, (u64*)&iDocid);
  188976. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " id=%lld", iDocid);
  188977. }
  188978. while( iOff<n ){
  188979. int nPos;
  188980. int bDel;
  188981. iOff += fts5GetPoslistSize(&a[iOff], &nPos, &bDel);
  188982. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " nPos=%d%s", nPos, bDel?"*":"");
  188983. iOff += fts5DecodePoslist(pRc, pBuf, &a[iOff], MIN(n-iOff, nPos));
  188984. if( iOff<n ){
  188985. i64 iDelta;
  188986. iOff += sqlite3Fts5GetVarint(&a[iOff], (u64*)&iDelta);
  188987. iDocid += iDelta;
  188988. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " id=%lld", iDocid);
  188989. }
  188990. }
  188991. return iOff;
  188992. }
  188993. /*
  188994. ** This function is part of the fts5_decode() debugging function. It is
  188995. ** only ever used with detail=none tables.
  188996. **
  188997. ** Buffer (pData/nData) contains a doclist in the format used by detail=none
  188998. ** tables. This function appends a human-readable version of that list to
  188999. ** buffer pBuf.
  189000. **
  189001. ** If *pRc is other than SQLITE_OK when this function is called, it is a
  189002. ** no-op. If an OOM or other error occurs within this function, *pRc is
  189003. ** set to an SQLite error code before returning. The final state of buffer
  189004. ** pBuf is undefined in this case.
  189005. */
  189006. static void fts5DecodeRowidList(
  189007. int *pRc, /* IN/OUT: Error code */
  189008. Fts5Buffer *pBuf, /* Buffer to append text to */
  189009. const u8 *pData, int nData /* Data to decode list-of-rowids from */
  189010. ){
  189011. int i = 0;
  189012. i64 iRowid = 0;
  189013. while( i<nData ){
  189014. const char *zApp = "";
  189015. u64 iVal;
  189016. i += sqlite3Fts5GetVarint(&pData[i], &iVal);
  189017. iRowid += iVal;
  189018. if( i<nData && pData[i]==0x00 ){
  189019. i++;
  189020. if( i<nData && pData[i]==0x00 ){
  189021. i++;
  189022. zApp = "+";
  189023. }else{
  189024. zApp = "*";
  189025. }
  189026. }
  189027. sqlite3Fts5BufferAppendPrintf(pRc, pBuf, " %lld%s", iRowid, zApp);
  189028. }
  189029. }
  189030. /*
  189031. ** The implementation of user-defined scalar function fts5_decode().
  189032. */
  189033. static void fts5DecodeFunction(
  189034. sqlite3_context *pCtx, /* Function call context */
  189035. int nArg, /* Number of args (always 2) */
  189036. sqlite3_value **apVal /* Function arguments */
  189037. ){
  189038. i64 iRowid; /* Rowid for record being decoded */
  189039. int iSegid,iHeight,iPgno,bDlidx;/* Rowid components */
  189040. const u8 *aBlob; int n; /* Record to decode */
  189041. u8 *a = 0;
  189042. Fts5Buffer s; /* Build up text to return here */
  189043. int rc = SQLITE_OK; /* Return code */
  189044. int nSpace = 0;
  189045. int eDetailNone = (sqlite3_user_data(pCtx)!=0);
  189046. assert( nArg==2 );
  189047. UNUSED_PARAM(nArg);
  189048. memset(&s, 0, sizeof(Fts5Buffer));
  189049. iRowid = sqlite3_value_int64(apVal[0]);
  189050. /* Make a copy of the second argument (a blob) in aBlob[]. The aBlob[]
  189051. ** copy is followed by FTS5_DATA_ZERO_PADDING 0x00 bytes, which prevents
  189052. ** buffer overreads even if the record is corrupt. */
  189053. n = sqlite3_value_bytes(apVal[1]);
  189054. aBlob = sqlite3_value_blob(apVal[1]);
  189055. nSpace = n + FTS5_DATA_ZERO_PADDING;
  189056. a = (u8*)sqlite3Fts5MallocZero(&rc, nSpace);
  189057. if( a==0 ) goto decode_out;
  189058. memcpy(a, aBlob, n);
  189059. fts5DecodeRowid(iRowid, &iSegid, &bDlidx, &iHeight, &iPgno);
  189060. fts5DebugRowid(&rc, &s, iRowid);
  189061. if( bDlidx ){
  189062. Fts5Data dlidx;
  189063. Fts5DlidxLvl lvl;
  189064. dlidx.p = a;
  189065. dlidx.nn = n;
  189066. memset(&lvl, 0, sizeof(Fts5DlidxLvl));
  189067. lvl.pData = &dlidx;
  189068. lvl.iLeafPgno = iPgno;
  189069. for(fts5DlidxLvlNext(&lvl); lvl.bEof==0; fts5DlidxLvlNext(&lvl)){
  189070. sqlite3Fts5BufferAppendPrintf(&rc, &s,
  189071. " %d(%lld)", lvl.iLeafPgno, lvl.iRowid
  189072. );
  189073. }
  189074. }else if( iSegid==0 ){
  189075. if( iRowid==FTS5_AVERAGES_ROWID ){
  189076. fts5DecodeAverages(&rc, &s, a, n);
  189077. }else{
  189078. fts5DecodeStructure(&rc, &s, a, n);
  189079. }
  189080. }else if( eDetailNone ){
  189081. Fts5Buffer term; /* Current term read from page */
  189082. int szLeaf;
  189083. int iPgidxOff = szLeaf = fts5GetU16(&a[2]);
  189084. int iTermOff;
  189085. int nKeep = 0;
  189086. int iOff;
  189087. memset(&term, 0, sizeof(Fts5Buffer));
  189088. /* Decode any entries that occur before the first term. */
  189089. if( szLeaf<n ){
  189090. iPgidxOff += fts5GetVarint32(&a[iPgidxOff], iTermOff);
  189091. }else{
  189092. iTermOff = szLeaf;
  189093. }
  189094. fts5DecodeRowidList(&rc, &s, &a[4], iTermOff-4);
  189095. iOff = iTermOff;
  189096. while( iOff<szLeaf ){
  189097. int nAppend;
  189098. /* Read the term data for the next term*/
  189099. iOff += fts5GetVarint32(&a[iOff], nAppend);
  189100. term.n = nKeep;
  189101. fts5BufferAppendBlob(&rc, &term, nAppend, &a[iOff]);
  189102. sqlite3Fts5BufferAppendPrintf(
  189103. &rc, &s, " term=%.*s", term.n, (const char*)term.p
  189104. );
  189105. iOff += nAppend;
  189106. /* Figure out where the doclist for this term ends */
  189107. if( iPgidxOff<n ){
  189108. int nIncr;
  189109. iPgidxOff += fts5GetVarint32(&a[iPgidxOff], nIncr);
  189110. iTermOff += nIncr;
  189111. }else{
  189112. iTermOff = szLeaf;
  189113. }
  189114. fts5DecodeRowidList(&rc, &s, &a[iOff], iTermOff-iOff);
  189115. iOff = iTermOff;
  189116. if( iOff<szLeaf ){
  189117. iOff += fts5GetVarint32(&a[iOff], nKeep);
  189118. }
  189119. }
  189120. fts5BufferFree(&term);
  189121. }else{
  189122. Fts5Buffer term; /* Current term read from page */
  189123. int szLeaf; /* Offset of pgidx in a[] */
  189124. int iPgidxOff;
  189125. int iPgidxPrev = 0; /* Previous value read from pgidx */
  189126. int iTermOff = 0;
  189127. int iRowidOff = 0;
  189128. int iOff;
  189129. int nDoclist;
  189130. memset(&term, 0, sizeof(Fts5Buffer));
  189131. if( n<4 ){
  189132. sqlite3Fts5BufferSet(&rc, &s, 7, (const u8*)"corrupt");
  189133. goto decode_out;
  189134. }else{
  189135. iRowidOff = fts5GetU16(&a[0]);
  189136. iPgidxOff = szLeaf = fts5GetU16(&a[2]);
  189137. if( iPgidxOff<n ){
  189138. fts5GetVarint32(&a[iPgidxOff], iTermOff);
  189139. }
  189140. }
  189141. /* Decode the position list tail at the start of the page */
  189142. if( iRowidOff!=0 ){
  189143. iOff = iRowidOff;
  189144. }else if( iTermOff!=0 ){
  189145. iOff = iTermOff;
  189146. }else{
  189147. iOff = szLeaf;
  189148. }
  189149. fts5DecodePoslist(&rc, &s, &a[4], iOff-4);
  189150. /* Decode any more doclist data that appears on the page before the
  189151. ** first term. */
  189152. nDoclist = (iTermOff ? iTermOff : szLeaf) - iOff;
  189153. fts5DecodeDoclist(&rc, &s, &a[iOff], nDoclist);
  189154. while( iPgidxOff<n ){
  189155. int bFirst = (iPgidxOff==szLeaf); /* True for first term on page */
  189156. int nByte; /* Bytes of data */
  189157. int iEnd;
  189158. iPgidxOff += fts5GetVarint32(&a[iPgidxOff], nByte);
  189159. iPgidxPrev += nByte;
  189160. iOff = iPgidxPrev;
  189161. if( iPgidxOff<n ){
  189162. fts5GetVarint32(&a[iPgidxOff], nByte);
  189163. iEnd = iPgidxPrev + nByte;
  189164. }else{
  189165. iEnd = szLeaf;
  189166. }
  189167. if( bFirst==0 ){
  189168. iOff += fts5GetVarint32(&a[iOff], nByte);
  189169. term.n = nByte;
  189170. }
  189171. iOff += fts5GetVarint32(&a[iOff], nByte);
  189172. fts5BufferAppendBlob(&rc, &term, nByte, &a[iOff]);
  189173. iOff += nByte;
  189174. sqlite3Fts5BufferAppendPrintf(
  189175. &rc, &s, " term=%.*s", term.n, (const char*)term.p
  189176. );
  189177. iOff += fts5DecodeDoclist(&rc, &s, &a[iOff], iEnd-iOff);
  189178. }
  189179. fts5BufferFree(&term);
  189180. }
  189181. decode_out:
  189182. sqlite3_free(a);
  189183. if( rc==SQLITE_OK ){
  189184. sqlite3_result_text(pCtx, (const char*)s.p, s.n, SQLITE_TRANSIENT);
  189185. }else{
  189186. sqlite3_result_error_code(pCtx, rc);
  189187. }
  189188. fts5BufferFree(&s);
  189189. }
  189190. /*
  189191. ** The implementation of user-defined scalar function fts5_rowid().
  189192. */
  189193. static void fts5RowidFunction(
  189194. sqlite3_context *pCtx, /* Function call context */
  189195. int nArg, /* Number of args (always 2) */
  189196. sqlite3_value **apVal /* Function arguments */
  189197. ){
  189198. const char *zArg;
  189199. if( nArg==0 ){
  189200. sqlite3_result_error(pCtx, "should be: fts5_rowid(subject, ....)", -1);
  189201. }else{
  189202. zArg = (const char*)sqlite3_value_text(apVal[0]);
  189203. if( 0==sqlite3_stricmp(zArg, "segment") ){
  189204. i64 iRowid;
  189205. int segid, pgno;
  189206. if( nArg!=3 ){
  189207. sqlite3_result_error(pCtx,
  189208. "should be: fts5_rowid('segment', segid, pgno))", -1
  189209. );
  189210. }else{
  189211. segid = sqlite3_value_int(apVal[1]);
  189212. pgno = sqlite3_value_int(apVal[2]);
  189213. iRowid = FTS5_SEGMENT_ROWID(segid, pgno);
  189214. sqlite3_result_int64(pCtx, iRowid);
  189215. }
  189216. }else{
  189217. sqlite3_result_error(pCtx,
  189218. "first arg to fts5_rowid() must be 'segment'" , -1
  189219. );
  189220. }
  189221. }
  189222. }
  189223. /*
  189224. ** This is called as part of registering the FTS5 module with database
  189225. ** connection db. It registers several user-defined scalar functions useful
  189226. ** with FTS5.
  189227. **
  189228. ** If successful, SQLITE_OK is returned. If an error occurs, some other
  189229. ** SQLite error code is returned instead.
  189230. */
  189231. static int sqlite3Fts5IndexInit(sqlite3 *db){
  189232. int rc = sqlite3_create_function(
  189233. db, "fts5_decode", 2, SQLITE_UTF8, 0, fts5DecodeFunction, 0, 0
  189234. );
  189235. if( rc==SQLITE_OK ){
  189236. rc = sqlite3_create_function(
  189237. db, "fts5_decode_none", 2,
  189238. SQLITE_UTF8, (void*)db, fts5DecodeFunction, 0, 0
  189239. );
  189240. }
  189241. if( rc==SQLITE_OK ){
  189242. rc = sqlite3_create_function(
  189243. db, "fts5_rowid", -1, SQLITE_UTF8, 0, fts5RowidFunction, 0, 0
  189244. );
  189245. }
  189246. return rc;
  189247. }
  189248. static int sqlite3Fts5IndexReset(Fts5Index *p){
  189249. assert( p->pStruct==0 || p->iStructVersion!=0 );
  189250. if( fts5IndexDataVersion(p)!=p->iStructVersion ){
  189251. fts5StructureInvalidate(p);
  189252. }
  189253. return fts5IndexReturn(p);
  189254. }
  189255. /*
  189256. ** 2014 Jun 09
  189257. **
  189258. ** The author disclaims copyright to this source code. In place of
  189259. ** a legal notice, here is a blessing:
  189260. **
  189261. ** May you do good and not evil.
  189262. ** May you find forgiveness for yourself and forgive others.
  189263. ** May you share freely, never taking more than you give.
  189264. **
  189265. ******************************************************************************
  189266. **
  189267. ** This is an SQLite module implementing full-text search.
  189268. */
  189269. /* #include "fts5Int.h" */
  189270. /*
  189271. ** This variable is set to false when running tests for which the on disk
  189272. ** structures should not be corrupt. Otherwise, true. If it is false, extra
  189273. ** assert() conditions in the fts5 code are activated - conditions that are
  189274. ** only true if it is guaranteed that the fts5 database is not corrupt.
  189275. */
  189276. SQLITE_API int sqlite3_fts5_may_be_corrupt = 1;
  189277. typedef struct Fts5Auxdata Fts5Auxdata;
  189278. typedef struct Fts5Auxiliary Fts5Auxiliary;
  189279. typedef struct Fts5Cursor Fts5Cursor;
  189280. typedef struct Fts5Sorter Fts5Sorter;
  189281. typedef struct Fts5Table Fts5Table;
  189282. typedef struct Fts5TokenizerModule Fts5TokenizerModule;
  189283. /*
  189284. ** NOTES ON TRANSACTIONS:
  189285. **
  189286. ** SQLite invokes the following virtual table methods as transactions are
  189287. ** opened and closed by the user:
  189288. **
  189289. ** xBegin(): Start of a new transaction.
  189290. ** xSync(): Initial part of two-phase commit.
  189291. ** xCommit(): Final part of two-phase commit.
  189292. ** xRollback(): Rollback the transaction.
  189293. **
  189294. ** Anything that is required as part of a commit that may fail is performed
  189295. ** in the xSync() callback. Current versions of SQLite ignore any errors
  189296. ** returned by xCommit().
  189297. **
  189298. ** And as sub-transactions are opened/closed:
  189299. **
  189300. ** xSavepoint(int S): Open savepoint S.
  189301. ** xRelease(int S): Commit and close savepoint S.
  189302. ** xRollbackTo(int S): Rollback to start of savepoint S.
  189303. **
  189304. ** During a write-transaction the fts5_index.c module may cache some data
  189305. ** in-memory. It is flushed to disk whenever xSync(), xRelease() or
  189306. ** xSavepoint() is called. And discarded whenever xRollback() or xRollbackTo()
  189307. ** is called.
  189308. **
  189309. ** Additionally, if SQLITE_DEBUG is defined, an instance of the following
  189310. ** structure is used to record the current transaction state. This information
  189311. ** is not required, but it is used in the assert() statements executed by
  189312. ** function fts5CheckTransactionState() (see below).
  189313. */
  189314. struct Fts5TransactionState {
  189315. int eState; /* 0==closed, 1==open, 2==synced */
  189316. int iSavepoint; /* Number of open savepoints (0 -> none) */
  189317. };
  189318. /*
  189319. ** A single object of this type is allocated when the FTS5 module is
  189320. ** registered with a database handle. It is used to store pointers to
  189321. ** all registered FTS5 extensions - tokenizers and auxiliary functions.
  189322. */
  189323. struct Fts5Global {
  189324. fts5_api api; /* User visible part of object (see fts5.h) */
  189325. sqlite3 *db; /* Associated database connection */
  189326. i64 iNextId; /* Used to allocate unique cursor ids */
  189327. Fts5Auxiliary *pAux; /* First in list of all aux. functions */
  189328. Fts5TokenizerModule *pTok; /* First in list of all tokenizer modules */
  189329. Fts5TokenizerModule *pDfltTok; /* Default tokenizer module */
  189330. Fts5Cursor *pCsr; /* First in list of all open cursors */
  189331. };
  189332. /*
  189333. ** Each auxiliary function registered with the FTS5 module is represented
  189334. ** by an object of the following type. All such objects are stored as part
  189335. ** of the Fts5Global.pAux list.
  189336. */
  189337. struct Fts5Auxiliary {
  189338. Fts5Global *pGlobal; /* Global context for this function */
  189339. char *zFunc; /* Function name (nul-terminated) */
  189340. void *pUserData; /* User-data pointer */
  189341. fts5_extension_function xFunc; /* Callback function */
  189342. void (*xDestroy)(void*); /* Destructor function */
  189343. Fts5Auxiliary *pNext; /* Next registered auxiliary function */
  189344. };
  189345. /*
  189346. ** Each tokenizer module registered with the FTS5 module is represented
  189347. ** by an object of the following type. All such objects are stored as part
  189348. ** of the Fts5Global.pTok list.
  189349. */
  189350. struct Fts5TokenizerModule {
  189351. char *zName; /* Name of tokenizer */
  189352. void *pUserData; /* User pointer passed to xCreate() */
  189353. fts5_tokenizer x; /* Tokenizer functions */
  189354. void (*xDestroy)(void*); /* Destructor function */
  189355. Fts5TokenizerModule *pNext; /* Next registered tokenizer module */
  189356. };
  189357. /*
  189358. ** Virtual-table object.
  189359. */
  189360. struct Fts5Table {
  189361. sqlite3_vtab base; /* Base class used by SQLite core */
  189362. Fts5Config *pConfig; /* Virtual table configuration */
  189363. Fts5Index *pIndex; /* Full-text index */
  189364. Fts5Storage *pStorage; /* Document store */
  189365. Fts5Global *pGlobal; /* Global (connection wide) data */
  189366. Fts5Cursor *pSortCsr; /* Sort data from this cursor */
  189367. #ifdef SQLITE_DEBUG
  189368. struct Fts5TransactionState ts;
  189369. #endif
  189370. };
  189371. struct Fts5MatchPhrase {
  189372. Fts5Buffer *pPoslist; /* Pointer to current poslist */
  189373. int nTerm; /* Size of phrase in terms */
  189374. };
  189375. /*
  189376. ** pStmt:
  189377. ** SELECT rowid, <fts> FROM <fts> ORDER BY +rank;
  189378. **
  189379. ** aIdx[]:
  189380. ** There is one entry in the aIdx[] array for each phrase in the query,
  189381. ** the value of which is the offset within aPoslist[] following the last
  189382. ** byte of the position list for the corresponding phrase.
  189383. */
  189384. struct Fts5Sorter {
  189385. sqlite3_stmt *pStmt;
  189386. i64 iRowid; /* Current rowid */
  189387. const u8 *aPoslist; /* Position lists for current row */
  189388. int nIdx; /* Number of entries in aIdx[] */
  189389. int aIdx[1]; /* Offsets into aPoslist for current row */
  189390. };
  189391. /*
  189392. ** Virtual-table cursor object.
  189393. **
  189394. ** iSpecial:
  189395. ** If this is a 'special' query (refer to function fts5SpecialMatch()),
  189396. ** then this variable contains the result of the query.
  189397. **
  189398. ** iFirstRowid, iLastRowid:
  189399. ** These variables are only used for FTS5_PLAN_MATCH cursors. Assuming the
  189400. ** cursor iterates in ascending order of rowids, iFirstRowid is the lower
  189401. ** limit of rowids to return, and iLastRowid the upper. In other words, the
  189402. ** WHERE clause in the user's query might have been:
  189403. **
  189404. ** <tbl> MATCH <expr> AND rowid BETWEEN $iFirstRowid AND $iLastRowid
  189405. **
  189406. ** If the cursor iterates in descending order of rowid, iFirstRowid
  189407. ** is the upper limit (i.e. the "first" rowid visited) and iLastRowid
  189408. ** the lower.
  189409. */
  189410. struct Fts5Cursor {
  189411. sqlite3_vtab_cursor base; /* Base class used by SQLite core */
  189412. Fts5Cursor *pNext; /* Next cursor in Fts5Cursor.pCsr list */
  189413. int *aColumnSize; /* Values for xColumnSize() */
  189414. i64 iCsrId; /* Cursor id */
  189415. /* Zero from this point onwards on cursor reset */
  189416. int ePlan; /* FTS5_PLAN_XXX value */
  189417. int bDesc; /* True for "ORDER BY rowid DESC" queries */
  189418. i64 iFirstRowid; /* Return no rowids earlier than this */
  189419. i64 iLastRowid; /* Return no rowids later than this */
  189420. sqlite3_stmt *pStmt; /* Statement used to read %_content */
  189421. Fts5Expr *pExpr; /* Expression for MATCH queries */
  189422. Fts5Sorter *pSorter; /* Sorter for "ORDER BY rank" queries */
  189423. int csrflags; /* Mask of cursor flags (see below) */
  189424. i64 iSpecial; /* Result of special query */
  189425. /* "rank" function. Populated on demand from vtab.xColumn(). */
  189426. char *zRank; /* Custom rank function */
  189427. char *zRankArgs; /* Custom rank function args */
  189428. Fts5Auxiliary *pRank; /* Rank callback (or NULL) */
  189429. int nRankArg; /* Number of trailing arguments for rank() */
  189430. sqlite3_value **apRankArg; /* Array of trailing arguments */
  189431. sqlite3_stmt *pRankArgStmt; /* Origin of objects in apRankArg[] */
  189432. /* Auxiliary data storage */
  189433. Fts5Auxiliary *pAux; /* Currently executing extension function */
  189434. Fts5Auxdata *pAuxdata; /* First in linked list of saved aux-data */
  189435. /* Cache used by auxiliary functions xInst() and xInstCount() */
  189436. Fts5PoslistReader *aInstIter; /* One for each phrase */
  189437. int nInstAlloc; /* Size of aInst[] array (entries / 3) */
  189438. int nInstCount; /* Number of phrase instances */
  189439. int *aInst; /* 3 integers per phrase instance */
  189440. };
  189441. /*
  189442. ** Bits that make up the "idxNum" parameter passed indirectly by
  189443. ** xBestIndex() to xFilter().
  189444. */
  189445. #define FTS5_BI_MATCH 0x0001 /* <tbl> MATCH ? */
  189446. #define FTS5_BI_RANK 0x0002 /* rank MATCH ? */
  189447. #define FTS5_BI_ROWID_EQ 0x0004 /* rowid == ? */
  189448. #define FTS5_BI_ROWID_LE 0x0008 /* rowid <= ? */
  189449. #define FTS5_BI_ROWID_GE 0x0010 /* rowid >= ? */
  189450. #define FTS5_BI_ORDER_RANK 0x0020
  189451. #define FTS5_BI_ORDER_ROWID 0x0040
  189452. #define FTS5_BI_ORDER_DESC 0x0080
  189453. /*
  189454. ** Values for Fts5Cursor.csrflags
  189455. */
  189456. #define FTS5CSR_EOF 0x01
  189457. #define FTS5CSR_REQUIRE_CONTENT 0x02
  189458. #define FTS5CSR_REQUIRE_DOCSIZE 0x04
  189459. #define FTS5CSR_REQUIRE_INST 0x08
  189460. #define FTS5CSR_FREE_ZRANK 0x10
  189461. #define FTS5CSR_REQUIRE_RESEEK 0x20
  189462. #define FTS5CSR_REQUIRE_POSLIST 0x40
  189463. #define BitFlagAllTest(x,y) (((x) & (y))==(y))
  189464. #define BitFlagTest(x,y) (((x) & (y))!=0)
  189465. /*
  189466. ** Macros to Set(), Clear() and Test() cursor flags.
  189467. */
  189468. #define CsrFlagSet(pCsr, flag) ((pCsr)->csrflags |= (flag))
  189469. #define CsrFlagClear(pCsr, flag) ((pCsr)->csrflags &= ~(flag))
  189470. #define CsrFlagTest(pCsr, flag) ((pCsr)->csrflags & (flag))
  189471. struct Fts5Auxdata {
  189472. Fts5Auxiliary *pAux; /* Extension to which this belongs */
  189473. void *pPtr; /* Pointer value */
  189474. void(*xDelete)(void*); /* Destructor */
  189475. Fts5Auxdata *pNext; /* Next object in linked list */
  189476. };
  189477. #ifdef SQLITE_DEBUG
  189478. #define FTS5_BEGIN 1
  189479. #define FTS5_SYNC 2
  189480. #define FTS5_COMMIT 3
  189481. #define FTS5_ROLLBACK 4
  189482. #define FTS5_SAVEPOINT 5
  189483. #define FTS5_RELEASE 6
  189484. #define FTS5_ROLLBACKTO 7
  189485. static void fts5CheckTransactionState(Fts5Table *p, int op, int iSavepoint){
  189486. switch( op ){
  189487. case FTS5_BEGIN:
  189488. assert( p->ts.eState==0 );
  189489. p->ts.eState = 1;
  189490. p->ts.iSavepoint = -1;
  189491. break;
  189492. case FTS5_SYNC:
  189493. assert( p->ts.eState==1 );
  189494. p->ts.eState = 2;
  189495. break;
  189496. case FTS5_COMMIT:
  189497. assert( p->ts.eState==2 );
  189498. p->ts.eState = 0;
  189499. break;
  189500. case FTS5_ROLLBACK:
  189501. assert( p->ts.eState==1 || p->ts.eState==2 || p->ts.eState==0 );
  189502. p->ts.eState = 0;
  189503. break;
  189504. case FTS5_SAVEPOINT:
  189505. assert( p->ts.eState==1 );
  189506. assert( iSavepoint>=0 );
  189507. assert( iSavepoint>p->ts.iSavepoint );
  189508. p->ts.iSavepoint = iSavepoint;
  189509. break;
  189510. case FTS5_RELEASE:
  189511. assert( p->ts.eState==1 );
  189512. assert( iSavepoint>=0 );
  189513. assert( iSavepoint<=p->ts.iSavepoint );
  189514. p->ts.iSavepoint = iSavepoint-1;
  189515. break;
  189516. case FTS5_ROLLBACKTO:
  189517. assert( p->ts.eState==1 );
  189518. assert( iSavepoint>=0 );
  189519. assert( iSavepoint<=p->ts.iSavepoint );
  189520. p->ts.iSavepoint = iSavepoint;
  189521. break;
  189522. }
  189523. }
  189524. #else
  189525. # define fts5CheckTransactionState(x,y,z)
  189526. #endif
  189527. /*
  189528. ** Return true if pTab is a contentless table.
  189529. */
  189530. static int fts5IsContentless(Fts5Table *pTab){
  189531. return pTab->pConfig->eContent==FTS5_CONTENT_NONE;
  189532. }
  189533. /*
  189534. ** Delete a virtual table handle allocated by fts5InitVtab().
  189535. */
  189536. static void fts5FreeVtab(Fts5Table *pTab){
  189537. if( pTab ){
  189538. sqlite3Fts5IndexClose(pTab->pIndex);
  189539. sqlite3Fts5StorageClose(pTab->pStorage);
  189540. sqlite3Fts5ConfigFree(pTab->pConfig);
  189541. sqlite3_free(pTab);
  189542. }
  189543. }
  189544. /*
  189545. ** The xDisconnect() virtual table method.
  189546. */
  189547. static int fts5DisconnectMethod(sqlite3_vtab *pVtab){
  189548. fts5FreeVtab((Fts5Table*)pVtab);
  189549. return SQLITE_OK;
  189550. }
  189551. /*
  189552. ** The xDestroy() virtual table method.
  189553. */
  189554. static int fts5DestroyMethod(sqlite3_vtab *pVtab){
  189555. Fts5Table *pTab = (Fts5Table*)pVtab;
  189556. int rc = sqlite3Fts5DropAll(pTab->pConfig);
  189557. if( rc==SQLITE_OK ){
  189558. fts5FreeVtab((Fts5Table*)pVtab);
  189559. }
  189560. return rc;
  189561. }
  189562. /*
  189563. ** This function is the implementation of both the xConnect and xCreate
  189564. ** methods of the FTS3 virtual table.
  189565. **
  189566. ** The argv[] array contains the following:
  189567. **
  189568. ** argv[0] -> module name ("fts5")
  189569. ** argv[1] -> database name
  189570. ** argv[2] -> table name
  189571. ** argv[...] -> "column name" and other module argument fields.
  189572. */
  189573. static int fts5InitVtab(
  189574. int bCreate, /* True for xCreate, false for xConnect */
  189575. sqlite3 *db, /* The SQLite database connection */
  189576. void *pAux, /* Hash table containing tokenizers */
  189577. int argc, /* Number of elements in argv array */
  189578. const char * const *argv, /* xCreate/xConnect argument array */
  189579. sqlite3_vtab **ppVTab, /* Write the resulting vtab structure here */
  189580. char **pzErr /* Write any error message here */
  189581. ){
  189582. Fts5Global *pGlobal = (Fts5Global*)pAux;
  189583. const char **azConfig = (const char**)argv;
  189584. int rc = SQLITE_OK; /* Return code */
  189585. Fts5Config *pConfig = 0; /* Results of parsing argc/argv */
  189586. Fts5Table *pTab = 0; /* New virtual table object */
  189587. /* Allocate the new vtab object and parse the configuration */
  189588. pTab = (Fts5Table*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Table));
  189589. if( rc==SQLITE_OK ){
  189590. rc = sqlite3Fts5ConfigParse(pGlobal, db, argc, azConfig, &pConfig, pzErr);
  189591. assert( (rc==SQLITE_OK && *pzErr==0) || pConfig==0 );
  189592. }
  189593. if( rc==SQLITE_OK ){
  189594. pTab->pConfig = pConfig;
  189595. pTab->pGlobal = pGlobal;
  189596. }
  189597. /* Open the index sub-system */
  189598. if( rc==SQLITE_OK ){
  189599. rc = sqlite3Fts5IndexOpen(pConfig, bCreate, &pTab->pIndex, pzErr);
  189600. }
  189601. /* Open the storage sub-system */
  189602. if( rc==SQLITE_OK ){
  189603. rc = sqlite3Fts5StorageOpen(
  189604. pConfig, pTab->pIndex, bCreate, &pTab->pStorage, pzErr
  189605. );
  189606. }
  189607. /* Call sqlite3_declare_vtab() */
  189608. if( rc==SQLITE_OK ){
  189609. rc = sqlite3Fts5ConfigDeclareVtab(pConfig);
  189610. }
  189611. /* Load the initial configuration */
  189612. if( rc==SQLITE_OK ){
  189613. assert( pConfig->pzErrmsg==0 );
  189614. pConfig->pzErrmsg = pzErr;
  189615. rc = sqlite3Fts5IndexLoadConfig(pTab->pIndex);
  189616. sqlite3Fts5IndexRollback(pTab->pIndex);
  189617. pConfig->pzErrmsg = 0;
  189618. }
  189619. if( rc!=SQLITE_OK ){
  189620. fts5FreeVtab(pTab);
  189621. pTab = 0;
  189622. }else if( bCreate ){
  189623. fts5CheckTransactionState(pTab, FTS5_BEGIN, 0);
  189624. }
  189625. *ppVTab = (sqlite3_vtab*)pTab;
  189626. return rc;
  189627. }
  189628. /*
  189629. ** The xConnect() and xCreate() methods for the virtual table. All the
  189630. ** work is done in function fts5InitVtab().
  189631. */
  189632. static int fts5ConnectMethod(
  189633. sqlite3 *db, /* Database connection */
  189634. void *pAux, /* Pointer to tokenizer hash table */
  189635. int argc, /* Number of elements in argv array */
  189636. const char * const *argv, /* xCreate/xConnect argument array */
  189637. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  189638. char **pzErr /* OUT: sqlite3_malloc'd error message */
  189639. ){
  189640. return fts5InitVtab(0, db, pAux, argc, argv, ppVtab, pzErr);
  189641. }
  189642. static int fts5CreateMethod(
  189643. sqlite3 *db, /* Database connection */
  189644. void *pAux, /* Pointer to tokenizer hash table */
  189645. int argc, /* Number of elements in argv array */
  189646. const char * const *argv, /* xCreate/xConnect argument array */
  189647. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  189648. char **pzErr /* OUT: sqlite3_malloc'd error message */
  189649. ){
  189650. return fts5InitVtab(1, db, pAux, argc, argv, ppVtab, pzErr);
  189651. }
  189652. /*
  189653. ** The different query plans.
  189654. */
  189655. #define FTS5_PLAN_MATCH 1 /* (<tbl> MATCH ?) */
  189656. #define FTS5_PLAN_SOURCE 2 /* A source cursor for SORTED_MATCH */
  189657. #define FTS5_PLAN_SPECIAL 3 /* An internal query */
  189658. #define FTS5_PLAN_SORTED_MATCH 4 /* (<tbl> MATCH ? ORDER BY rank) */
  189659. #define FTS5_PLAN_SCAN 5 /* No usable constraint */
  189660. #define FTS5_PLAN_ROWID 6 /* (rowid = ?) */
  189661. /*
  189662. ** Set the SQLITE_INDEX_SCAN_UNIQUE flag in pIdxInfo->flags. Unless this
  189663. ** extension is currently being used by a version of SQLite too old to
  189664. ** support index-info flags. In that case this function is a no-op.
  189665. */
  189666. static void fts5SetUniqueFlag(sqlite3_index_info *pIdxInfo){
  189667. #if SQLITE_VERSION_NUMBER>=3008012
  189668. #ifndef SQLITE_CORE
  189669. if( sqlite3_libversion_number()>=3008012 )
  189670. #endif
  189671. {
  189672. pIdxInfo->idxFlags |= SQLITE_INDEX_SCAN_UNIQUE;
  189673. }
  189674. #endif
  189675. }
  189676. /*
  189677. ** Implementation of the xBestIndex method for FTS5 tables. Within the
  189678. ** WHERE constraint, it searches for the following:
  189679. **
  189680. ** 1. A MATCH constraint against the special column.
  189681. ** 2. A MATCH constraint against the "rank" column.
  189682. ** 3. An == constraint against the rowid column.
  189683. ** 4. A < or <= constraint against the rowid column.
  189684. ** 5. A > or >= constraint against the rowid column.
  189685. **
  189686. ** Within the ORDER BY, either:
  189687. **
  189688. ** 5. ORDER BY rank [ASC|DESC]
  189689. ** 6. ORDER BY rowid [ASC|DESC]
  189690. **
  189691. ** Costs are assigned as follows:
  189692. **
  189693. ** a) If an unusable MATCH operator is present in the WHERE clause, the
  189694. ** cost is unconditionally set to 1e50 (a really big number).
  189695. **
  189696. ** a) If a MATCH operator is present, the cost depends on the other
  189697. ** constraints also present. As follows:
  189698. **
  189699. ** * No other constraints: cost=1000.0
  189700. ** * One rowid range constraint: cost=750.0
  189701. ** * Both rowid range constraints: cost=500.0
  189702. ** * An == rowid constraint: cost=100.0
  189703. **
  189704. ** b) Otherwise, if there is no MATCH:
  189705. **
  189706. ** * No other constraints: cost=1000000.0
  189707. ** * One rowid range constraint: cost=750000.0
  189708. ** * Both rowid range constraints: cost=250000.0
  189709. ** * An == rowid constraint: cost=10.0
  189710. **
  189711. ** Costs are not modified by the ORDER BY clause.
  189712. */
  189713. static int fts5BestIndexMethod(sqlite3_vtab *pVTab, sqlite3_index_info *pInfo){
  189714. Fts5Table *pTab = (Fts5Table*)pVTab;
  189715. Fts5Config *pConfig = pTab->pConfig;
  189716. const int nCol = pConfig->nCol;
  189717. int idxFlags = 0; /* Parameter passed through to xFilter() */
  189718. int bHasMatch;
  189719. int iNext;
  189720. int i;
  189721. struct Constraint {
  189722. int op; /* Mask against sqlite3_index_constraint.op */
  189723. int fts5op; /* FTS5 mask for idxFlags */
  189724. int iCol; /* 0==rowid, 1==tbl, 2==rank */
  189725. int omit; /* True to omit this if found */
  189726. int iConsIndex; /* Index in pInfo->aConstraint[] */
  189727. } aConstraint[] = {
  189728. {SQLITE_INDEX_CONSTRAINT_MATCH|SQLITE_INDEX_CONSTRAINT_EQ,
  189729. FTS5_BI_MATCH, 1, 1, -1},
  189730. {SQLITE_INDEX_CONSTRAINT_MATCH|SQLITE_INDEX_CONSTRAINT_EQ,
  189731. FTS5_BI_RANK, 2, 1, -1},
  189732. {SQLITE_INDEX_CONSTRAINT_EQ, FTS5_BI_ROWID_EQ, 0, 0, -1},
  189733. {SQLITE_INDEX_CONSTRAINT_LT|SQLITE_INDEX_CONSTRAINT_LE,
  189734. FTS5_BI_ROWID_LE, 0, 0, -1},
  189735. {SQLITE_INDEX_CONSTRAINT_GT|SQLITE_INDEX_CONSTRAINT_GE,
  189736. FTS5_BI_ROWID_GE, 0, 0, -1},
  189737. };
  189738. int aColMap[3];
  189739. aColMap[0] = -1;
  189740. aColMap[1] = nCol;
  189741. aColMap[2] = nCol+1;
  189742. assert( SQLITE_INDEX_CONSTRAINT_EQ<SQLITE_INDEX_CONSTRAINT_MATCH );
  189743. assert( SQLITE_INDEX_CONSTRAINT_GT<SQLITE_INDEX_CONSTRAINT_MATCH );
  189744. assert( SQLITE_INDEX_CONSTRAINT_LE<SQLITE_INDEX_CONSTRAINT_MATCH );
  189745. assert( SQLITE_INDEX_CONSTRAINT_GE<SQLITE_INDEX_CONSTRAINT_MATCH );
  189746. assert( SQLITE_INDEX_CONSTRAINT_LE<SQLITE_INDEX_CONSTRAINT_MATCH );
  189747. /* Set idxFlags flags for all WHERE clause terms that will be used. */
  189748. for(i=0; i<pInfo->nConstraint; i++){
  189749. struct sqlite3_index_constraint *p = &pInfo->aConstraint[i];
  189750. int iCol = p->iColumn;
  189751. if( (p->op==SQLITE_INDEX_CONSTRAINT_MATCH && iCol>=0 && iCol<=nCol)
  189752. || (p->op==SQLITE_INDEX_CONSTRAINT_EQ && iCol==nCol)
  189753. ){
  189754. /* A MATCH operator or equivalent */
  189755. if( p->usable ){
  189756. idxFlags = (idxFlags & 0xFFFF) | FTS5_BI_MATCH | (iCol << 16);
  189757. aConstraint[0].iConsIndex = i;
  189758. }else{
  189759. /* As there exists an unusable MATCH constraint this is an
  189760. ** unusable plan. Set a prohibitively high cost. */
  189761. pInfo->estimatedCost = 1e50;
  189762. return SQLITE_OK;
  189763. }
  189764. }else if( p->op<=SQLITE_INDEX_CONSTRAINT_MATCH ){
  189765. int j;
  189766. for(j=1; j<ArraySize(aConstraint); j++){
  189767. struct Constraint *pC = &aConstraint[j];
  189768. if( iCol==aColMap[pC->iCol] && (p->op & pC->op) && p->usable ){
  189769. pC->iConsIndex = i;
  189770. idxFlags |= pC->fts5op;
  189771. }
  189772. }
  189773. }
  189774. }
  189775. /* Set idxFlags flags for the ORDER BY clause */
  189776. if( pInfo->nOrderBy==1 ){
  189777. int iSort = pInfo->aOrderBy[0].iColumn;
  189778. if( iSort==(pConfig->nCol+1) && BitFlagTest(idxFlags, FTS5_BI_MATCH) ){
  189779. idxFlags |= FTS5_BI_ORDER_RANK;
  189780. }else if( iSort==-1 ){
  189781. idxFlags |= FTS5_BI_ORDER_ROWID;
  189782. }
  189783. if( BitFlagTest(idxFlags, FTS5_BI_ORDER_RANK|FTS5_BI_ORDER_ROWID) ){
  189784. pInfo->orderByConsumed = 1;
  189785. if( pInfo->aOrderBy[0].desc ){
  189786. idxFlags |= FTS5_BI_ORDER_DESC;
  189787. }
  189788. }
  189789. }
  189790. /* Calculate the estimated cost based on the flags set in idxFlags. */
  189791. bHasMatch = BitFlagTest(idxFlags, FTS5_BI_MATCH);
  189792. if( BitFlagTest(idxFlags, FTS5_BI_ROWID_EQ) ){
  189793. pInfo->estimatedCost = bHasMatch ? 100.0 : 10.0;
  189794. if( bHasMatch==0 ) fts5SetUniqueFlag(pInfo);
  189795. }else if( BitFlagAllTest(idxFlags, FTS5_BI_ROWID_LE|FTS5_BI_ROWID_GE) ){
  189796. pInfo->estimatedCost = bHasMatch ? 500.0 : 250000.0;
  189797. }else if( BitFlagTest(idxFlags, FTS5_BI_ROWID_LE|FTS5_BI_ROWID_GE) ){
  189798. pInfo->estimatedCost = bHasMatch ? 750.0 : 750000.0;
  189799. }else{
  189800. pInfo->estimatedCost = bHasMatch ? 1000.0 : 1000000.0;
  189801. }
  189802. /* Assign argvIndex values to each constraint in use. */
  189803. iNext = 1;
  189804. for(i=0; i<ArraySize(aConstraint); i++){
  189805. struct Constraint *pC = &aConstraint[i];
  189806. if( pC->iConsIndex>=0 ){
  189807. pInfo->aConstraintUsage[pC->iConsIndex].argvIndex = iNext++;
  189808. pInfo->aConstraintUsage[pC->iConsIndex].omit = (unsigned char)pC->omit;
  189809. }
  189810. }
  189811. pInfo->idxNum = idxFlags;
  189812. return SQLITE_OK;
  189813. }
  189814. static int fts5NewTransaction(Fts5Table *pTab){
  189815. Fts5Cursor *pCsr;
  189816. for(pCsr=pTab->pGlobal->pCsr; pCsr; pCsr=pCsr->pNext){
  189817. if( pCsr->base.pVtab==(sqlite3_vtab*)pTab ) return SQLITE_OK;
  189818. }
  189819. return sqlite3Fts5StorageReset(pTab->pStorage);
  189820. }
  189821. /*
  189822. ** Implementation of xOpen method.
  189823. */
  189824. static int fts5OpenMethod(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCsr){
  189825. Fts5Table *pTab = (Fts5Table*)pVTab;
  189826. Fts5Config *pConfig = pTab->pConfig;
  189827. Fts5Cursor *pCsr = 0; /* New cursor object */
  189828. int nByte; /* Bytes of space to allocate */
  189829. int rc; /* Return code */
  189830. rc = fts5NewTransaction(pTab);
  189831. if( rc==SQLITE_OK ){
  189832. nByte = sizeof(Fts5Cursor) + pConfig->nCol * sizeof(int);
  189833. pCsr = (Fts5Cursor*)sqlite3_malloc(nByte);
  189834. if( pCsr ){
  189835. Fts5Global *pGlobal = pTab->pGlobal;
  189836. memset(pCsr, 0, nByte);
  189837. pCsr->aColumnSize = (int*)&pCsr[1];
  189838. pCsr->pNext = pGlobal->pCsr;
  189839. pGlobal->pCsr = pCsr;
  189840. pCsr->iCsrId = ++pGlobal->iNextId;
  189841. }else{
  189842. rc = SQLITE_NOMEM;
  189843. }
  189844. }
  189845. *ppCsr = (sqlite3_vtab_cursor*)pCsr;
  189846. return rc;
  189847. }
  189848. static int fts5StmtType(Fts5Cursor *pCsr){
  189849. if( pCsr->ePlan==FTS5_PLAN_SCAN ){
  189850. return (pCsr->bDesc) ? FTS5_STMT_SCAN_DESC : FTS5_STMT_SCAN_ASC;
  189851. }
  189852. return FTS5_STMT_LOOKUP;
  189853. }
  189854. /*
  189855. ** This function is called after the cursor passed as the only argument
  189856. ** is moved to point at a different row. It clears all cached data
  189857. ** specific to the previous row stored by the cursor object.
  189858. */
  189859. static void fts5CsrNewrow(Fts5Cursor *pCsr){
  189860. CsrFlagSet(pCsr,
  189861. FTS5CSR_REQUIRE_CONTENT
  189862. | FTS5CSR_REQUIRE_DOCSIZE
  189863. | FTS5CSR_REQUIRE_INST
  189864. | FTS5CSR_REQUIRE_POSLIST
  189865. );
  189866. }
  189867. static void fts5FreeCursorComponents(Fts5Cursor *pCsr){
  189868. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  189869. Fts5Auxdata *pData;
  189870. Fts5Auxdata *pNext;
  189871. sqlite3_free(pCsr->aInstIter);
  189872. sqlite3_free(pCsr->aInst);
  189873. if( pCsr->pStmt ){
  189874. int eStmt = fts5StmtType(pCsr);
  189875. sqlite3Fts5StorageStmtRelease(pTab->pStorage, eStmt, pCsr->pStmt);
  189876. }
  189877. if( pCsr->pSorter ){
  189878. Fts5Sorter *pSorter = pCsr->pSorter;
  189879. sqlite3_finalize(pSorter->pStmt);
  189880. sqlite3_free(pSorter);
  189881. }
  189882. if( pCsr->ePlan!=FTS5_PLAN_SOURCE ){
  189883. sqlite3Fts5ExprFree(pCsr->pExpr);
  189884. }
  189885. for(pData=pCsr->pAuxdata; pData; pData=pNext){
  189886. pNext = pData->pNext;
  189887. if( pData->xDelete ) pData->xDelete(pData->pPtr);
  189888. sqlite3_free(pData);
  189889. }
  189890. sqlite3_finalize(pCsr->pRankArgStmt);
  189891. sqlite3_free(pCsr->apRankArg);
  189892. if( CsrFlagTest(pCsr, FTS5CSR_FREE_ZRANK) ){
  189893. sqlite3_free(pCsr->zRank);
  189894. sqlite3_free(pCsr->zRankArgs);
  189895. }
  189896. memset(&pCsr->ePlan, 0, sizeof(Fts5Cursor) - ((u8*)&pCsr->ePlan - (u8*)pCsr));
  189897. }
  189898. /*
  189899. ** Close the cursor. For additional information see the documentation
  189900. ** on the xClose method of the virtual table interface.
  189901. */
  189902. static int fts5CloseMethod(sqlite3_vtab_cursor *pCursor){
  189903. if( pCursor ){
  189904. Fts5Table *pTab = (Fts5Table*)(pCursor->pVtab);
  189905. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  189906. Fts5Cursor **pp;
  189907. fts5FreeCursorComponents(pCsr);
  189908. /* Remove the cursor from the Fts5Global.pCsr list */
  189909. for(pp=&pTab->pGlobal->pCsr; (*pp)!=pCsr; pp=&(*pp)->pNext);
  189910. *pp = pCsr->pNext;
  189911. sqlite3_free(pCsr);
  189912. }
  189913. return SQLITE_OK;
  189914. }
  189915. static int fts5SorterNext(Fts5Cursor *pCsr){
  189916. Fts5Sorter *pSorter = pCsr->pSorter;
  189917. int rc;
  189918. rc = sqlite3_step(pSorter->pStmt);
  189919. if( rc==SQLITE_DONE ){
  189920. rc = SQLITE_OK;
  189921. CsrFlagSet(pCsr, FTS5CSR_EOF);
  189922. }else if( rc==SQLITE_ROW ){
  189923. const u8 *a;
  189924. const u8 *aBlob;
  189925. int nBlob;
  189926. int i;
  189927. int iOff = 0;
  189928. rc = SQLITE_OK;
  189929. pSorter->iRowid = sqlite3_column_int64(pSorter->pStmt, 0);
  189930. nBlob = sqlite3_column_bytes(pSorter->pStmt, 1);
  189931. aBlob = a = sqlite3_column_blob(pSorter->pStmt, 1);
  189932. /* nBlob==0 in detail=none mode. */
  189933. if( nBlob>0 ){
  189934. for(i=0; i<(pSorter->nIdx-1); i++){
  189935. int iVal;
  189936. a += fts5GetVarint32(a, iVal);
  189937. iOff += iVal;
  189938. pSorter->aIdx[i] = iOff;
  189939. }
  189940. pSorter->aIdx[i] = &aBlob[nBlob] - a;
  189941. pSorter->aPoslist = a;
  189942. }
  189943. fts5CsrNewrow(pCsr);
  189944. }
  189945. return rc;
  189946. }
  189947. /*
  189948. ** Set the FTS5CSR_REQUIRE_RESEEK flag on all FTS5_PLAN_MATCH cursors
  189949. ** open on table pTab.
  189950. */
  189951. static void fts5TripCursors(Fts5Table *pTab){
  189952. Fts5Cursor *pCsr;
  189953. for(pCsr=pTab->pGlobal->pCsr; pCsr; pCsr=pCsr->pNext){
  189954. if( pCsr->ePlan==FTS5_PLAN_MATCH
  189955. && pCsr->base.pVtab==(sqlite3_vtab*)pTab
  189956. ){
  189957. CsrFlagSet(pCsr, FTS5CSR_REQUIRE_RESEEK);
  189958. }
  189959. }
  189960. }
  189961. /*
  189962. ** If the REQUIRE_RESEEK flag is set on the cursor passed as the first
  189963. ** argument, close and reopen all Fts5IndexIter iterators that the cursor
  189964. ** is using. Then attempt to move the cursor to a rowid equal to or laster
  189965. ** (in the cursors sort order - ASC or DESC) than the current rowid.
  189966. **
  189967. ** If the new rowid is not equal to the old, set output parameter *pbSkip
  189968. ** to 1 before returning. Otherwise, leave it unchanged.
  189969. **
  189970. ** Return SQLITE_OK if successful or if no reseek was required, or an
  189971. ** error code if an error occurred.
  189972. */
  189973. static int fts5CursorReseek(Fts5Cursor *pCsr, int *pbSkip){
  189974. int rc = SQLITE_OK;
  189975. assert( *pbSkip==0 );
  189976. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_RESEEK) ){
  189977. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  189978. int bDesc = pCsr->bDesc;
  189979. i64 iRowid = sqlite3Fts5ExprRowid(pCsr->pExpr);
  189980. rc = sqlite3Fts5ExprFirst(pCsr->pExpr, pTab->pIndex, iRowid, bDesc);
  189981. if( rc==SQLITE_OK && iRowid!=sqlite3Fts5ExprRowid(pCsr->pExpr) ){
  189982. *pbSkip = 1;
  189983. }
  189984. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_RESEEK);
  189985. fts5CsrNewrow(pCsr);
  189986. if( sqlite3Fts5ExprEof(pCsr->pExpr) ){
  189987. CsrFlagSet(pCsr, FTS5CSR_EOF);
  189988. *pbSkip = 1;
  189989. }
  189990. }
  189991. return rc;
  189992. }
  189993. /*
  189994. ** Advance the cursor to the next row in the table that matches the
  189995. ** search criteria.
  189996. **
  189997. ** Return SQLITE_OK if nothing goes wrong. SQLITE_OK is returned
  189998. ** even if we reach end-of-file. The fts5EofMethod() will be called
  189999. ** subsequently to determine whether or not an EOF was hit.
  190000. */
  190001. static int fts5NextMethod(sqlite3_vtab_cursor *pCursor){
  190002. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  190003. int rc;
  190004. assert( (pCsr->ePlan<3)==
  190005. (pCsr->ePlan==FTS5_PLAN_MATCH || pCsr->ePlan==FTS5_PLAN_SOURCE)
  190006. );
  190007. assert( !CsrFlagTest(pCsr, FTS5CSR_EOF) );
  190008. if( pCsr->ePlan<3 ){
  190009. int bSkip = 0;
  190010. if( (rc = fts5CursorReseek(pCsr, &bSkip)) || bSkip ) return rc;
  190011. rc = sqlite3Fts5ExprNext(pCsr->pExpr, pCsr->iLastRowid);
  190012. CsrFlagSet(pCsr, sqlite3Fts5ExprEof(pCsr->pExpr));
  190013. fts5CsrNewrow(pCsr);
  190014. }else{
  190015. switch( pCsr->ePlan ){
  190016. case FTS5_PLAN_SPECIAL: {
  190017. CsrFlagSet(pCsr, FTS5CSR_EOF);
  190018. rc = SQLITE_OK;
  190019. break;
  190020. }
  190021. case FTS5_PLAN_SORTED_MATCH: {
  190022. rc = fts5SorterNext(pCsr);
  190023. break;
  190024. }
  190025. default:
  190026. rc = sqlite3_step(pCsr->pStmt);
  190027. if( rc!=SQLITE_ROW ){
  190028. CsrFlagSet(pCsr, FTS5CSR_EOF);
  190029. rc = sqlite3_reset(pCsr->pStmt);
  190030. }else{
  190031. rc = SQLITE_OK;
  190032. }
  190033. break;
  190034. }
  190035. }
  190036. return rc;
  190037. }
  190038. static int fts5PrepareStatement(
  190039. sqlite3_stmt **ppStmt,
  190040. Fts5Config *pConfig,
  190041. const char *zFmt,
  190042. ...
  190043. ){
  190044. sqlite3_stmt *pRet = 0;
  190045. int rc;
  190046. char *zSql;
  190047. va_list ap;
  190048. va_start(ap, zFmt);
  190049. zSql = sqlite3_vmprintf(zFmt, ap);
  190050. if( zSql==0 ){
  190051. rc = SQLITE_NOMEM;
  190052. }else{
  190053. rc = sqlite3_prepare_v3(pConfig->db, zSql, -1,
  190054. SQLITE_PREPARE_PERSISTENT, &pRet, 0);
  190055. if( rc!=SQLITE_OK ){
  190056. *pConfig->pzErrmsg = sqlite3_mprintf("%s", sqlite3_errmsg(pConfig->db));
  190057. }
  190058. sqlite3_free(zSql);
  190059. }
  190060. va_end(ap);
  190061. *ppStmt = pRet;
  190062. return rc;
  190063. }
  190064. static int fts5CursorFirstSorted(Fts5Table *pTab, Fts5Cursor *pCsr, int bDesc){
  190065. Fts5Config *pConfig = pTab->pConfig;
  190066. Fts5Sorter *pSorter;
  190067. int nPhrase;
  190068. int nByte;
  190069. int rc;
  190070. const char *zRank = pCsr->zRank;
  190071. const char *zRankArgs = pCsr->zRankArgs;
  190072. nPhrase = sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  190073. nByte = sizeof(Fts5Sorter) + sizeof(int) * (nPhrase-1);
  190074. pSorter = (Fts5Sorter*)sqlite3_malloc(nByte);
  190075. if( pSorter==0 ) return SQLITE_NOMEM;
  190076. memset(pSorter, 0, nByte);
  190077. pSorter->nIdx = nPhrase;
  190078. /* TODO: It would be better to have some system for reusing statement
  190079. ** handles here, rather than preparing a new one for each query. But that
  190080. ** is not possible as SQLite reference counts the virtual table objects.
  190081. ** And since the statement required here reads from this very virtual
  190082. ** table, saving it creates a circular reference.
  190083. **
  190084. ** If SQLite a built-in statement cache, this wouldn't be a problem. */
  190085. rc = fts5PrepareStatement(&pSorter->pStmt, pConfig,
  190086. "SELECT rowid, rank FROM %Q.%Q ORDER BY %s(%s%s%s) %s",
  190087. pConfig->zDb, pConfig->zName, zRank, pConfig->zName,
  190088. (zRankArgs ? ", " : ""),
  190089. (zRankArgs ? zRankArgs : ""),
  190090. bDesc ? "DESC" : "ASC"
  190091. );
  190092. pCsr->pSorter = pSorter;
  190093. if( rc==SQLITE_OK ){
  190094. assert( pTab->pSortCsr==0 );
  190095. pTab->pSortCsr = pCsr;
  190096. rc = fts5SorterNext(pCsr);
  190097. pTab->pSortCsr = 0;
  190098. }
  190099. if( rc!=SQLITE_OK ){
  190100. sqlite3_finalize(pSorter->pStmt);
  190101. sqlite3_free(pSorter);
  190102. pCsr->pSorter = 0;
  190103. }
  190104. return rc;
  190105. }
  190106. static int fts5CursorFirst(Fts5Table *pTab, Fts5Cursor *pCsr, int bDesc){
  190107. int rc;
  190108. Fts5Expr *pExpr = pCsr->pExpr;
  190109. rc = sqlite3Fts5ExprFirst(pExpr, pTab->pIndex, pCsr->iFirstRowid, bDesc);
  190110. if( sqlite3Fts5ExprEof(pExpr) ){
  190111. CsrFlagSet(pCsr, FTS5CSR_EOF);
  190112. }
  190113. fts5CsrNewrow(pCsr);
  190114. return rc;
  190115. }
  190116. /*
  190117. ** Process a "special" query. A special query is identified as one with a
  190118. ** MATCH expression that begins with a '*' character. The remainder of
  190119. ** the text passed to the MATCH operator are used as the special query
  190120. ** parameters.
  190121. */
  190122. static int fts5SpecialMatch(
  190123. Fts5Table *pTab,
  190124. Fts5Cursor *pCsr,
  190125. const char *zQuery
  190126. ){
  190127. int rc = SQLITE_OK; /* Return code */
  190128. const char *z = zQuery; /* Special query text */
  190129. int n; /* Number of bytes in text at z */
  190130. while( z[0]==' ' ) z++;
  190131. for(n=0; z[n] && z[n]!=' '; n++);
  190132. assert( pTab->base.zErrMsg==0 );
  190133. pCsr->ePlan = FTS5_PLAN_SPECIAL;
  190134. if( 0==sqlite3_strnicmp("reads", z, n) ){
  190135. pCsr->iSpecial = sqlite3Fts5IndexReads(pTab->pIndex);
  190136. }
  190137. else if( 0==sqlite3_strnicmp("id", z, n) ){
  190138. pCsr->iSpecial = pCsr->iCsrId;
  190139. }
  190140. else{
  190141. /* An unrecognized directive. Return an error message. */
  190142. pTab->base.zErrMsg = sqlite3_mprintf("unknown special query: %.*s", n, z);
  190143. rc = SQLITE_ERROR;
  190144. }
  190145. return rc;
  190146. }
  190147. /*
  190148. ** Search for an auxiliary function named zName that can be used with table
  190149. ** pTab. If one is found, return a pointer to the corresponding Fts5Auxiliary
  190150. ** structure. Otherwise, if no such function exists, return NULL.
  190151. */
  190152. static Fts5Auxiliary *fts5FindAuxiliary(Fts5Table *pTab, const char *zName){
  190153. Fts5Auxiliary *pAux;
  190154. for(pAux=pTab->pGlobal->pAux; pAux; pAux=pAux->pNext){
  190155. if( sqlite3_stricmp(zName, pAux->zFunc)==0 ) return pAux;
  190156. }
  190157. /* No function of the specified name was found. Return 0. */
  190158. return 0;
  190159. }
  190160. static int fts5FindRankFunction(Fts5Cursor *pCsr){
  190161. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  190162. Fts5Config *pConfig = pTab->pConfig;
  190163. int rc = SQLITE_OK;
  190164. Fts5Auxiliary *pAux = 0;
  190165. const char *zRank = pCsr->zRank;
  190166. const char *zRankArgs = pCsr->zRankArgs;
  190167. if( zRankArgs ){
  190168. char *zSql = sqlite3Fts5Mprintf(&rc, "SELECT %s", zRankArgs);
  190169. if( zSql ){
  190170. sqlite3_stmt *pStmt = 0;
  190171. rc = sqlite3_prepare_v3(pConfig->db, zSql, -1,
  190172. SQLITE_PREPARE_PERSISTENT, &pStmt, 0);
  190173. sqlite3_free(zSql);
  190174. assert( rc==SQLITE_OK || pCsr->pRankArgStmt==0 );
  190175. if( rc==SQLITE_OK ){
  190176. if( SQLITE_ROW==sqlite3_step(pStmt) ){
  190177. int nByte;
  190178. pCsr->nRankArg = sqlite3_column_count(pStmt);
  190179. nByte = sizeof(sqlite3_value*)*pCsr->nRankArg;
  190180. pCsr->apRankArg = (sqlite3_value**)sqlite3Fts5MallocZero(&rc, nByte);
  190181. if( rc==SQLITE_OK ){
  190182. int i;
  190183. for(i=0; i<pCsr->nRankArg; i++){
  190184. pCsr->apRankArg[i] = sqlite3_column_value(pStmt, i);
  190185. }
  190186. }
  190187. pCsr->pRankArgStmt = pStmt;
  190188. }else{
  190189. rc = sqlite3_finalize(pStmt);
  190190. assert( rc!=SQLITE_OK );
  190191. }
  190192. }
  190193. }
  190194. }
  190195. if( rc==SQLITE_OK ){
  190196. pAux = fts5FindAuxiliary(pTab, zRank);
  190197. if( pAux==0 ){
  190198. assert( pTab->base.zErrMsg==0 );
  190199. pTab->base.zErrMsg = sqlite3_mprintf("no such function: %s", zRank);
  190200. rc = SQLITE_ERROR;
  190201. }
  190202. }
  190203. pCsr->pRank = pAux;
  190204. return rc;
  190205. }
  190206. static int fts5CursorParseRank(
  190207. Fts5Config *pConfig,
  190208. Fts5Cursor *pCsr,
  190209. sqlite3_value *pRank
  190210. ){
  190211. int rc = SQLITE_OK;
  190212. if( pRank ){
  190213. const char *z = (const char*)sqlite3_value_text(pRank);
  190214. char *zRank = 0;
  190215. char *zRankArgs = 0;
  190216. if( z==0 ){
  190217. if( sqlite3_value_type(pRank)==SQLITE_NULL ) rc = SQLITE_ERROR;
  190218. }else{
  190219. rc = sqlite3Fts5ConfigParseRank(z, &zRank, &zRankArgs);
  190220. }
  190221. if( rc==SQLITE_OK ){
  190222. pCsr->zRank = zRank;
  190223. pCsr->zRankArgs = zRankArgs;
  190224. CsrFlagSet(pCsr, FTS5CSR_FREE_ZRANK);
  190225. }else if( rc==SQLITE_ERROR ){
  190226. pCsr->base.pVtab->zErrMsg = sqlite3_mprintf(
  190227. "parse error in rank function: %s", z
  190228. );
  190229. }
  190230. }else{
  190231. if( pConfig->zRank ){
  190232. pCsr->zRank = (char*)pConfig->zRank;
  190233. pCsr->zRankArgs = (char*)pConfig->zRankArgs;
  190234. }else{
  190235. pCsr->zRank = (char*)FTS5_DEFAULT_RANK;
  190236. pCsr->zRankArgs = 0;
  190237. }
  190238. }
  190239. return rc;
  190240. }
  190241. static i64 fts5GetRowidLimit(sqlite3_value *pVal, i64 iDefault){
  190242. if( pVal ){
  190243. int eType = sqlite3_value_numeric_type(pVal);
  190244. if( eType==SQLITE_INTEGER ){
  190245. return sqlite3_value_int64(pVal);
  190246. }
  190247. }
  190248. return iDefault;
  190249. }
  190250. /*
  190251. ** This is the xFilter interface for the virtual table. See
  190252. ** the virtual table xFilter method documentation for additional
  190253. ** information.
  190254. **
  190255. ** There are three possible query strategies:
  190256. **
  190257. ** 1. Full-text search using a MATCH operator.
  190258. ** 2. A by-rowid lookup.
  190259. ** 3. A full-table scan.
  190260. */
  190261. static int fts5FilterMethod(
  190262. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  190263. int idxNum, /* Strategy index */
  190264. const char *zUnused, /* Unused */
  190265. int nVal, /* Number of elements in apVal */
  190266. sqlite3_value **apVal /* Arguments for the indexing scheme */
  190267. ){
  190268. Fts5Table *pTab = (Fts5Table*)(pCursor->pVtab);
  190269. Fts5Config *pConfig = pTab->pConfig;
  190270. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  190271. int rc = SQLITE_OK; /* Error code */
  190272. int iVal = 0; /* Counter for apVal[] */
  190273. int bDesc; /* True if ORDER BY [rank|rowid] DESC */
  190274. int bOrderByRank; /* True if ORDER BY rank */
  190275. sqlite3_value *pMatch = 0; /* <tbl> MATCH ? expression (or NULL) */
  190276. sqlite3_value *pRank = 0; /* rank MATCH ? expression (or NULL) */
  190277. sqlite3_value *pRowidEq = 0; /* rowid = ? expression (or NULL) */
  190278. sqlite3_value *pRowidLe = 0; /* rowid <= ? expression (or NULL) */
  190279. sqlite3_value *pRowidGe = 0; /* rowid >= ? expression (or NULL) */
  190280. int iCol; /* Column on LHS of MATCH operator */
  190281. char **pzErrmsg = pConfig->pzErrmsg;
  190282. UNUSED_PARAM(zUnused);
  190283. UNUSED_PARAM(nVal);
  190284. if( pCsr->ePlan ){
  190285. fts5FreeCursorComponents(pCsr);
  190286. memset(&pCsr->ePlan, 0, sizeof(Fts5Cursor) - ((u8*)&pCsr->ePlan-(u8*)pCsr));
  190287. }
  190288. assert( pCsr->pStmt==0 );
  190289. assert( pCsr->pExpr==0 );
  190290. assert( pCsr->csrflags==0 );
  190291. assert( pCsr->pRank==0 );
  190292. assert( pCsr->zRank==0 );
  190293. assert( pCsr->zRankArgs==0 );
  190294. assert( pzErrmsg==0 || pzErrmsg==&pTab->base.zErrMsg );
  190295. pConfig->pzErrmsg = &pTab->base.zErrMsg;
  190296. /* Decode the arguments passed through to this function.
  190297. **
  190298. ** Note: The following set of if(...) statements must be in the same
  190299. ** order as the corresponding entries in the struct at the top of
  190300. ** fts5BestIndexMethod(). */
  190301. if( BitFlagTest(idxNum, FTS5_BI_MATCH) ) pMatch = apVal[iVal++];
  190302. if( BitFlagTest(idxNum, FTS5_BI_RANK) ) pRank = apVal[iVal++];
  190303. if( BitFlagTest(idxNum, FTS5_BI_ROWID_EQ) ) pRowidEq = apVal[iVal++];
  190304. if( BitFlagTest(idxNum, FTS5_BI_ROWID_LE) ) pRowidLe = apVal[iVal++];
  190305. if( BitFlagTest(idxNum, FTS5_BI_ROWID_GE) ) pRowidGe = apVal[iVal++];
  190306. iCol = (idxNum>>16);
  190307. assert( iCol>=0 && iCol<=pConfig->nCol );
  190308. assert( iVal==nVal );
  190309. bOrderByRank = ((idxNum & FTS5_BI_ORDER_RANK) ? 1 : 0);
  190310. pCsr->bDesc = bDesc = ((idxNum & FTS5_BI_ORDER_DESC) ? 1 : 0);
  190311. /* Set the cursor upper and lower rowid limits. Only some strategies
  190312. ** actually use them. This is ok, as the xBestIndex() method leaves the
  190313. ** sqlite3_index_constraint.omit flag clear for range constraints
  190314. ** on the rowid field. */
  190315. if( pRowidEq ){
  190316. pRowidLe = pRowidGe = pRowidEq;
  190317. }
  190318. if( bDesc ){
  190319. pCsr->iFirstRowid = fts5GetRowidLimit(pRowidLe, LARGEST_INT64);
  190320. pCsr->iLastRowid = fts5GetRowidLimit(pRowidGe, SMALLEST_INT64);
  190321. }else{
  190322. pCsr->iLastRowid = fts5GetRowidLimit(pRowidLe, LARGEST_INT64);
  190323. pCsr->iFirstRowid = fts5GetRowidLimit(pRowidGe, SMALLEST_INT64);
  190324. }
  190325. if( pTab->pSortCsr ){
  190326. /* If pSortCsr is non-NULL, then this call is being made as part of
  190327. ** processing for a "... MATCH <expr> ORDER BY rank" query (ePlan is
  190328. ** set to FTS5_PLAN_SORTED_MATCH). pSortCsr is the cursor that will
  190329. ** return results to the user for this query. The current cursor
  190330. ** (pCursor) is used to execute the query issued by function
  190331. ** fts5CursorFirstSorted() above. */
  190332. assert( pRowidEq==0 && pRowidLe==0 && pRowidGe==0 && pRank==0 );
  190333. assert( nVal==0 && pMatch==0 && bOrderByRank==0 && bDesc==0 );
  190334. assert( pCsr->iLastRowid==LARGEST_INT64 );
  190335. assert( pCsr->iFirstRowid==SMALLEST_INT64 );
  190336. pCsr->ePlan = FTS5_PLAN_SOURCE;
  190337. pCsr->pExpr = pTab->pSortCsr->pExpr;
  190338. rc = fts5CursorFirst(pTab, pCsr, bDesc);
  190339. }else if( pMatch ){
  190340. const char *zExpr = (const char*)sqlite3_value_text(apVal[0]);
  190341. if( zExpr==0 ) zExpr = "";
  190342. rc = fts5CursorParseRank(pConfig, pCsr, pRank);
  190343. if( rc==SQLITE_OK ){
  190344. if( zExpr[0]=='*' ){
  190345. /* The user has issued a query of the form "MATCH '*...'". This
  190346. ** indicates that the MATCH expression is not a full text query,
  190347. ** but a request for an internal parameter. */
  190348. rc = fts5SpecialMatch(pTab, pCsr, &zExpr[1]);
  190349. }else{
  190350. char **pzErr = &pTab->base.zErrMsg;
  190351. rc = sqlite3Fts5ExprNew(pConfig, iCol, zExpr, &pCsr->pExpr, pzErr);
  190352. if( rc==SQLITE_OK ){
  190353. if( bOrderByRank ){
  190354. pCsr->ePlan = FTS5_PLAN_SORTED_MATCH;
  190355. rc = fts5CursorFirstSorted(pTab, pCsr, bDesc);
  190356. }else{
  190357. pCsr->ePlan = FTS5_PLAN_MATCH;
  190358. rc = fts5CursorFirst(pTab, pCsr, bDesc);
  190359. }
  190360. }
  190361. }
  190362. }
  190363. }else if( pConfig->zContent==0 ){
  190364. *pConfig->pzErrmsg = sqlite3_mprintf(
  190365. "%s: table does not support scanning", pConfig->zName
  190366. );
  190367. rc = SQLITE_ERROR;
  190368. }else{
  190369. /* This is either a full-table scan (ePlan==FTS5_PLAN_SCAN) or a lookup
  190370. ** by rowid (ePlan==FTS5_PLAN_ROWID). */
  190371. pCsr->ePlan = (pRowidEq ? FTS5_PLAN_ROWID : FTS5_PLAN_SCAN);
  190372. rc = sqlite3Fts5StorageStmt(
  190373. pTab->pStorage, fts5StmtType(pCsr), &pCsr->pStmt, &pTab->base.zErrMsg
  190374. );
  190375. if( rc==SQLITE_OK ){
  190376. if( pCsr->ePlan==FTS5_PLAN_ROWID ){
  190377. sqlite3_bind_value(pCsr->pStmt, 1, apVal[0]);
  190378. }else{
  190379. sqlite3_bind_int64(pCsr->pStmt, 1, pCsr->iFirstRowid);
  190380. sqlite3_bind_int64(pCsr->pStmt, 2, pCsr->iLastRowid);
  190381. }
  190382. rc = fts5NextMethod(pCursor);
  190383. }
  190384. }
  190385. pConfig->pzErrmsg = pzErrmsg;
  190386. return rc;
  190387. }
  190388. /*
  190389. ** This is the xEof method of the virtual table. SQLite calls this
  190390. ** routine to find out if it has reached the end of a result set.
  190391. */
  190392. static int fts5EofMethod(sqlite3_vtab_cursor *pCursor){
  190393. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  190394. return (CsrFlagTest(pCsr, FTS5CSR_EOF) ? 1 : 0);
  190395. }
  190396. /*
  190397. ** Return the rowid that the cursor currently points to.
  190398. */
  190399. static i64 fts5CursorRowid(Fts5Cursor *pCsr){
  190400. assert( pCsr->ePlan==FTS5_PLAN_MATCH
  190401. || pCsr->ePlan==FTS5_PLAN_SORTED_MATCH
  190402. || pCsr->ePlan==FTS5_PLAN_SOURCE
  190403. );
  190404. if( pCsr->pSorter ){
  190405. return pCsr->pSorter->iRowid;
  190406. }else{
  190407. return sqlite3Fts5ExprRowid(pCsr->pExpr);
  190408. }
  190409. }
  190410. /*
  190411. ** This is the xRowid method. The SQLite core calls this routine to
  190412. ** retrieve the rowid for the current row of the result set. fts5
  190413. ** exposes %_content.rowid as the rowid for the virtual table. The
  190414. ** rowid should be written to *pRowid.
  190415. */
  190416. static int fts5RowidMethod(sqlite3_vtab_cursor *pCursor, sqlite_int64 *pRowid){
  190417. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  190418. int ePlan = pCsr->ePlan;
  190419. assert( CsrFlagTest(pCsr, FTS5CSR_EOF)==0 );
  190420. switch( ePlan ){
  190421. case FTS5_PLAN_SPECIAL:
  190422. *pRowid = 0;
  190423. break;
  190424. case FTS5_PLAN_SOURCE:
  190425. case FTS5_PLAN_MATCH:
  190426. case FTS5_PLAN_SORTED_MATCH:
  190427. *pRowid = fts5CursorRowid(pCsr);
  190428. break;
  190429. default:
  190430. *pRowid = sqlite3_column_int64(pCsr->pStmt, 0);
  190431. break;
  190432. }
  190433. return SQLITE_OK;
  190434. }
  190435. /*
  190436. ** If the cursor requires seeking (bSeekRequired flag is set), seek it.
  190437. ** Return SQLITE_OK if no error occurs, or an SQLite error code otherwise.
  190438. **
  190439. ** If argument bErrormsg is true and an error occurs, an error message may
  190440. ** be left in sqlite3_vtab.zErrMsg.
  190441. */
  190442. static int fts5SeekCursor(Fts5Cursor *pCsr, int bErrormsg){
  190443. int rc = SQLITE_OK;
  190444. /* If the cursor does not yet have a statement handle, obtain one now. */
  190445. if( pCsr->pStmt==0 ){
  190446. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  190447. int eStmt = fts5StmtType(pCsr);
  190448. rc = sqlite3Fts5StorageStmt(
  190449. pTab->pStorage, eStmt, &pCsr->pStmt, (bErrormsg?&pTab->base.zErrMsg:0)
  190450. );
  190451. assert( rc!=SQLITE_OK || pTab->base.zErrMsg==0 );
  190452. assert( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_CONTENT) );
  190453. }
  190454. if( rc==SQLITE_OK && CsrFlagTest(pCsr, FTS5CSR_REQUIRE_CONTENT) ){
  190455. assert( pCsr->pExpr );
  190456. sqlite3_reset(pCsr->pStmt);
  190457. sqlite3_bind_int64(pCsr->pStmt, 1, fts5CursorRowid(pCsr));
  190458. rc = sqlite3_step(pCsr->pStmt);
  190459. if( rc==SQLITE_ROW ){
  190460. rc = SQLITE_OK;
  190461. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_CONTENT);
  190462. }else{
  190463. rc = sqlite3_reset(pCsr->pStmt);
  190464. if( rc==SQLITE_OK ){
  190465. rc = FTS5_CORRUPT;
  190466. }
  190467. }
  190468. }
  190469. return rc;
  190470. }
  190471. static void fts5SetVtabError(Fts5Table *p, const char *zFormat, ...){
  190472. va_list ap; /* ... printf arguments */
  190473. va_start(ap, zFormat);
  190474. assert( p->base.zErrMsg==0 );
  190475. p->base.zErrMsg = sqlite3_vmprintf(zFormat, ap);
  190476. va_end(ap);
  190477. }
  190478. /*
  190479. ** This function is called to handle an FTS INSERT command. In other words,
  190480. ** an INSERT statement of the form:
  190481. **
  190482. ** INSERT INTO fts(fts) VALUES($pCmd)
  190483. ** INSERT INTO fts(fts, rank) VALUES($pCmd, $pVal)
  190484. **
  190485. ** Argument pVal is the value assigned to column "fts" by the INSERT
  190486. ** statement. This function returns SQLITE_OK if successful, or an SQLite
  190487. ** error code if an error occurs.
  190488. **
  190489. ** The commands implemented by this function are documented in the "Special
  190490. ** INSERT Directives" section of the documentation. It should be updated if
  190491. ** more commands are added to this function.
  190492. */
  190493. static int fts5SpecialInsert(
  190494. Fts5Table *pTab, /* Fts5 table object */
  190495. const char *zCmd, /* Text inserted into table-name column */
  190496. sqlite3_value *pVal /* Value inserted into rank column */
  190497. ){
  190498. Fts5Config *pConfig = pTab->pConfig;
  190499. int rc = SQLITE_OK;
  190500. int bError = 0;
  190501. if( 0==sqlite3_stricmp("delete-all", zCmd) ){
  190502. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  190503. fts5SetVtabError(pTab,
  190504. "'delete-all' may only be used with a "
  190505. "contentless or external content fts5 table"
  190506. );
  190507. rc = SQLITE_ERROR;
  190508. }else{
  190509. rc = sqlite3Fts5StorageDeleteAll(pTab->pStorage);
  190510. }
  190511. }else if( 0==sqlite3_stricmp("rebuild", zCmd) ){
  190512. if( pConfig->eContent==FTS5_CONTENT_NONE ){
  190513. fts5SetVtabError(pTab,
  190514. "'rebuild' may not be used with a contentless fts5 table"
  190515. );
  190516. rc = SQLITE_ERROR;
  190517. }else{
  190518. rc = sqlite3Fts5StorageRebuild(pTab->pStorage);
  190519. }
  190520. }else if( 0==sqlite3_stricmp("optimize", zCmd) ){
  190521. rc = sqlite3Fts5StorageOptimize(pTab->pStorage);
  190522. }else if( 0==sqlite3_stricmp("merge", zCmd) ){
  190523. int nMerge = sqlite3_value_int(pVal);
  190524. rc = sqlite3Fts5StorageMerge(pTab->pStorage, nMerge);
  190525. }else if( 0==sqlite3_stricmp("integrity-check", zCmd) ){
  190526. rc = sqlite3Fts5StorageIntegrity(pTab->pStorage);
  190527. #ifdef SQLITE_DEBUG
  190528. }else if( 0==sqlite3_stricmp("prefix-index", zCmd) ){
  190529. pConfig->bPrefixIndex = sqlite3_value_int(pVal);
  190530. #endif
  190531. }else{
  190532. rc = sqlite3Fts5IndexLoadConfig(pTab->pIndex);
  190533. if( rc==SQLITE_OK ){
  190534. rc = sqlite3Fts5ConfigSetValue(pTab->pConfig, zCmd, pVal, &bError);
  190535. }
  190536. if( rc==SQLITE_OK ){
  190537. if( bError ){
  190538. rc = SQLITE_ERROR;
  190539. }else{
  190540. rc = sqlite3Fts5StorageConfigValue(pTab->pStorage, zCmd, pVal, 0);
  190541. }
  190542. }
  190543. }
  190544. return rc;
  190545. }
  190546. static int fts5SpecialDelete(
  190547. Fts5Table *pTab,
  190548. sqlite3_value **apVal
  190549. ){
  190550. int rc = SQLITE_OK;
  190551. int eType1 = sqlite3_value_type(apVal[1]);
  190552. if( eType1==SQLITE_INTEGER ){
  190553. sqlite3_int64 iDel = sqlite3_value_int64(apVal[1]);
  190554. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iDel, &apVal[2]);
  190555. }
  190556. return rc;
  190557. }
  190558. static void fts5StorageInsert(
  190559. int *pRc,
  190560. Fts5Table *pTab,
  190561. sqlite3_value **apVal,
  190562. i64 *piRowid
  190563. ){
  190564. int rc = *pRc;
  190565. if( rc==SQLITE_OK ){
  190566. rc = sqlite3Fts5StorageContentInsert(pTab->pStorage, apVal, piRowid);
  190567. }
  190568. if( rc==SQLITE_OK ){
  190569. rc = sqlite3Fts5StorageIndexInsert(pTab->pStorage, apVal, *piRowid);
  190570. }
  190571. *pRc = rc;
  190572. }
  190573. /*
  190574. ** This function is the implementation of the xUpdate callback used by
  190575. ** FTS3 virtual tables. It is invoked by SQLite each time a row is to be
  190576. ** inserted, updated or deleted.
  190577. **
  190578. ** A delete specifies a single argument - the rowid of the row to remove.
  190579. **
  190580. ** Update and insert operations pass:
  190581. **
  190582. ** 1. The "old" rowid, or NULL.
  190583. ** 2. The "new" rowid.
  190584. ** 3. Values for each of the nCol matchable columns.
  190585. ** 4. Values for the two hidden columns (<tablename> and "rank").
  190586. */
  190587. static int fts5UpdateMethod(
  190588. sqlite3_vtab *pVtab, /* Virtual table handle */
  190589. int nArg, /* Size of argument array */
  190590. sqlite3_value **apVal, /* Array of arguments */
  190591. sqlite_int64 *pRowid /* OUT: The affected (or effected) rowid */
  190592. ){
  190593. Fts5Table *pTab = (Fts5Table*)pVtab;
  190594. Fts5Config *pConfig = pTab->pConfig;
  190595. int eType0; /* value_type() of apVal[0] */
  190596. int rc = SQLITE_OK; /* Return code */
  190597. /* A transaction must be open when this is called. */
  190598. assert( pTab->ts.eState==1 );
  190599. assert( pVtab->zErrMsg==0 );
  190600. assert( nArg==1 || nArg==(2+pConfig->nCol+2) );
  190601. assert( nArg==1
  190602. || sqlite3_value_type(apVal[1])==SQLITE_INTEGER
  190603. || sqlite3_value_type(apVal[1])==SQLITE_NULL
  190604. );
  190605. assert( pTab->pConfig->pzErrmsg==0 );
  190606. pTab->pConfig->pzErrmsg = &pTab->base.zErrMsg;
  190607. /* Put any active cursors into REQUIRE_SEEK state. */
  190608. fts5TripCursors(pTab);
  190609. eType0 = sqlite3_value_type(apVal[0]);
  190610. if( eType0==SQLITE_NULL
  190611. && sqlite3_value_type(apVal[2+pConfig->nCol])!=SQLITE_NULL
  190612. ){
  190613. /* A "special" INSERT op. These are handled separately. */
  190614. const char *z = (const char*)sqlite3_value_text(apVal[2+pConfig->nCol]);
  190615. if( pConfig->eContent!=FTS5_CONTENT_NORMAL
  190616. && 0==sqlite3_stricmp("delete", z)
  190617. ){
  190618. rc = fts5SpecialDelete(pTab, apVal);
  190619. }else{
  190620. rc = fts5SpecialInsert(pTab, z, apVal[2 + pConfig->nCol + 1]);
  190621. }
  190622. }else{
  190623. /* A regular INSERT, UPDATE or DELETE statement. The trick here is that
  190624. ** any conflict on the rowid value must be detected before any
  190625. ** modifications are made to the database file. There are 4 cases:
  190626. **
  190627. ** 1) DELETE
  190628. ** 2) UPDATE (rowid not modified)
  190629. ** 3) UPDATE (rowid modified)
  190630. ** 4) INSERT
  190631. **
  190632. ** Cases 3 and 4 may violate the rowid constraint.
  190633. */
  190634. int eConflict = SQLITE_ABORT;
  190635. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  190636. eConflict = sqlite3_vtab_on_conflict(pConfig->db);
  190637. }
  190638. assert( eType0==SQLITE_INTEGER || eType0==SQLITE_NULL );
  190639. assert( nArg!=1 || eType0==SQLITE_INTEGER );
  190640. /* Filter out attempts to run UPDATE or DELETE on contentless tables.
  190641. ** This is not suported. */
  190642. if( eType0==SQLITE_INTEGER && fts5IsContentless(pTab) ){
  190643. pTab->base.zErrMsg = sqlite3_mprintf(
  190644. "cannot %s contentless fts5 table: %s",
  190645. (nArg>1 ? "UPDATE" : "DELETE from"), pConfig->zName
  190646. );
  190647. rc = SQLITE_ERROR;
  190648. }
  190649. /* DELETE */
  190650. else if( nArg==1 ){
  190651. i64 iDel = sqlite3_value_int64(apVal[0]); /* Rowid to delete */
  190652. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iDel, 0);
  190653. }
  190654. /* INSERT */
  190655. else if( eType0!=SQLITE_INTEGER ){
  190656. /* If this is a REPLACE, first remove the current entry (if any) */
  190657. if( eConflict==SQLITE_REPLACE
  190658. && sqlite3_value_type(apVal[1])==SQLITE_INTEGER
  190659. ){
  190660. i64 iNew = sqlite3_value_int64(apVal[1]); /* Rowid to delete */
  190661. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iNew, 0);
  190662. }
  190663. fts5StorageInsert(&rc, pTab, apVal, pRowid);
  190664. }
  190665. /* UPDATE */
  190666. else{
  190667. i64 iOld = sqlite3_value_int64(apVal[0]); /* Old rowid */
  190668. i64 iNew = sqlite3_value_int64(apVal[1]); /* New rowid */
  190669. if( iOld!=iNew ){
  190670. if( eConflict==SQLITE_REPLACE ){
  190671. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iOld, 0);
  190672. if( rc==SQLITE_OK ){
  190673. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iNew, 0);
  190674. }
  190675. fts5StorageInsert(&rc, pTab, apVal, pRowid);
  190676. }else{
  190677. rc = sqlite3Fts5StorageContentInsert(pTab->pStorage, apVal, pRowid);
  190678. if( rc==SQLITE_OK ){
  190679. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iOld, 0);
  190680. }
  190681. if( rc==SQLITE_OK ){
  190682. rc = sqlite3Fts5StorageIndexInsert(pTab->pStorage, apVal, *pRowid);
  190683. }
  190684. }
  190685. }else{
  190686. rc = sqlite3Fts5StorageDelete(pTab->pStorage, iOld, 0);
  190687. fts5StorageInsert(&rc, pTab, apVal, pRowid);
  190688. }
  190689. }
  190690. }
  190691. pTab->pConfig->pzErrmsg = 0;
  190692. return rc;
  190693. }
  190694. /*
  190695. ** Implementation of xSync() method.
  190696. */
  190697. static int fts5SyncMethod(sqlite3_vtab *pVtab){
  190698. int rc;
  190699. Fts5Table *pTab = (Fts5Table*)pVtab;
  190700. fts5CheckTransactionState(pTab, FTS5_SYNC, 0);
  190701. pTab->pConfig->pzErrmsg = &pTab->base.zErrMsg;
  190702. fts5TripCursors(pTab);
  190703. rc = sqlite3Fts5StorageSync(pTab->pStorage);
  190704. pTab->pConfig->pzErrmsg = 0;
  190705. return rc;
  190706. }
  190707. /*
  190708. ** Implementation of xBegin() method.
  190709. */
  190710. static int fts5BeginMethod(sqlite3_vtab *pVtab){
  190711. fts5CheckTransactionState((Fts5Table*)pVtab, FTS5_BEGIN, 0);
  190712. fts5NewTransaction((Fts5Table*)pVtab);
  190713. return SQLITE_OK;
  190714. }
  190715. /*
  190716. ** Implementation of xCommit() method. This is a no-op. The contents of
  190717. ** the pending-terms hash-table have already been flushed into the database
  190718. ** by fts5SyncMethod().
  190719. */
  190720. static int fts5CommitMethod(sqlite3_vtab *pVtab){
  190721. UNUSED_PARAM(pVtab); /* Call below is a no-op for NDEBUG builds */
  190722. fts5CheckTransactionState((Fts5Table*)pVtab, FTS5_COMMIT, 0);
  190723. return SQLITE_OK;
  190724. }
  190725. /*
  190726. ** Implementation of xRollback(). Discard the contents of the pending-terms
  190727. ** hash-table. Any changes made to the database are reverted by SQLite.
  190728. */
  190729. static int fts5RollbackMethod(sqlite3_vtab *pVtab){
  190730. int rc;
  190731. Fts5Table *pTab = (Fts5Table*)pVtab;
  190732. fts5CheckTransactionState(pTab, FTS5_ROLLBACK, 0);
  190733. rc = sqlite3Fts5StorageRollback(pTab->pStorage);
  190734. return rc;
  190735. }
  190736. static int fts5CsrPoslist(Fts5Cursor*, int, const u8**, int*);
  190737. static void *fts5ApiUserData(Fts5Context *pCtx){
  190738. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190739. return pCsr->pAux->pUserData;
  190740. }
  190741. static int fts5ApiColumnCount(Fts5Context *pCtx){
  190742. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190743. return ((Fts5Table*)(pCsr->base.pVtab))->pConfig->nCol;
  190744. }
  190745. static int fts5ApiColumnTotalSize(
  190746. Fts5Context *pCtx,
  190747. int iCol,
  190748. sqlite3_int64 *pnToken
  190749. ){
  190750. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190751. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  190752. return sqlite3Fts5StorageSize(pTab->pStorage, iCol, pnToken);
  190753. }
  190754. static int fts5ApiRowCount(Fts5Context *pCtx, i64 *pnRow){
  190755. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190756. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  190757. return sqlite3Fts5StorageRowCount(pTab->pStorage, pnRow);
  190758. }
  190759. static int fts5ApiTokenize(
  190760. Fts5Context *pCtx,
  190761. const char *pText, int nText,
  190762. void *pUserData,
  190763. int (*xToken)(void*, int, const char*, int, int, int)
  190764. ){
  190765. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190766. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  190767. return sqlite3Fts5Tokenize(
  190768. pTab->pConfig, FTS5_TOKENIZE_AUX, pText, nText, pUserData, xToken
  190769. );
  190770. }
  190771. static int fts5ApiPhraseCount(Fts5Context *pCtx){
  190772. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190773. return sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  190774. }
  190775. static int fts5ApiPhraseSize(Fts5Context *pCtx, int iPhrase){
  190776. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190777. return sqlite3Fts5ExprPhraseSize(pCsr->pExpr, iPhrase);
  190778. }
  190779. static int fts5ApiColumnText(
  190780. Fts5Context *pCtx,
  190781. int iCol,
  190782. const char **pz,
  190783. int *pn
  190784. ){
  190785. int rc = SQLITE_OK;
  190786. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190787. if( fts5IsContentless((Fts5Table*)(pCsr->base.pVtab)) ){
  190788. *pz = 0;
  190789. *pn = 0;
  190790. }else{
  190791. rc = fts5SeekCursor(pCsr, 0);
  190792. if( rc==SQLITE_OK ){
  190793. *pz = (const char*)sqlite3_column_text(pCsr->pStmt, iCol+1);
  190794. *pn = sqlite3_column_bytes(pCsr->pStmt, iCol+1);
  190795. }
  190796. }
  190797. return rc;
  190798. }
  190799. static int fts5CsrPoslist(
  190800. Fts5Cursor *pCsr,
  190801. int iPhrase,
  190802. const u8 **pa,
  190803. int *pn
  190804. ){
  190805. Fts5Config *pConfig = ((Fts5Table*)(pCsr->base.pVtab))->pConfig;
  190806. int rc = SQLITE_OK;
  190807. int bLive = (pCsr->pSorter==0);
  190808. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_POSLIST) ){
  190809. if( pConfig->eDetail!=FTS5_DETAIL_FULL ){
  190810. Fts5PoslistPopulator *aPopulator;
  190811. int i;
  190812. aPopulator = sqlite3Fts5ExprClearPoslists(pCsr->pExpr, bLive);
  190813. if( aPopulator==0 ) rc = SQLITE_NOMEM;
  190814. for(i=0; i<pConfig->nCol && rc==SQLITE_OK; i++){
  190815. int n; const char *z;
  190816. rc = fts5ApiColumnText((Fts5Context*)pCsr, i, &z, &n);
  190817. if( rc==SQLITE_OK ){
  190818. rc = sqlite3Fts5ExprPopulatePoslists(
  190819. pConfig, pCsr->pExpr, aPopulator, i, z, n
  190820. );
  190821. }
  190822. }
  190823. sqlite3_free(aPopulator);
  190824. if( pCsr->pSorter ){
  190825. sqlite3Fts5ExprCheckPoslists(pCsr->pExpr, pCsr->pSorter->iRowid);
  190826. }
  190827. }
  190828. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_POSLIST);
  190829. }
  190830. if( pCsr->pSorter && pConfig->eDetail==FTS5_DETAIL_FULL ){
  190831. Fts5Sorter *pSorter = pCsr->pSorter;
  190832. int i1 = (iPhrase==0 ? 0 : pSorter->aIdx[iPhrase-1]);
  190833. *pn = pSorter->aIdx[iPhrase] - i1;
  190834. *pa = &pSorter->aPoslist[i1];
  190835. }else{
  190836. *pn = sqlite3Fts5ExprPoslist(pCsr->pExpr, iPhrase, pa);
  190837. }
  190838. return rc;
  190839. }
  190840. /*
  190841. ** Ensure that the Fts5Cursor.nInstCount and aInst[] variables are populated
  190842. ** correctly for the current view. Return SQLITE_OK if successful, or an
  190843. ** SQLite error code otherwise.
  190844. */
  190845. static int fts5CacheInstArray(Fts5Cursor *pCsr){
  190846. int rc = SQLITE_OK;
  190847. Fts5PoslistReader *aIter; /* One iterator for each phrase */
  190848. int nIter; /* Number of iterators/phrases */
  190849. nIter = sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  190850. if( pCsr->aInstIter==0 ){
  190851. int nByte = sizeof(Fts5PoslistReader) * nIter;
  190852. pCsr->aInstIter = (Fts5PoslistReader*)sqlite3Fts5MallocZero(&rc, nByte);
  190853. }
  190854. aIter = pCsr->aInstIter;
  190855. if( aIter ){
  190856. int nInst = 0; /* Number instances seen so far */
  190857. int i;
  190858. /* Initialize all iterators */
  190859. for(i=0; i<nIter && rc==SQLITE_OK; i++){
  190860. const u8 *a;
  190861. int n;
  190862. rc = fts5CsrPoslist(pCsr, i, &a, &n);
  190863. if( rc==SQLITE_OK ){
  190864. sqlite3Fts5PoslistReaderInit(a, n, &aIter[i]);
  190865. }
  190866. }
  190867. if( rc==SQLITE_OK ){
  190868. while( 1 ){
  190869. int *aInst;
  190870. int iBest = -1;
  190871. for(i=0; i<nIter; i++){
  190872. if( (aIter[i].bEof==0)
  190873. && (iBest<0 || aIter[i].iPos<aIter[iBest].iPos)
  190874. ){
  190875. iBest = i;
  190876. }
  190877. }
  190878. if( iBest<0 ) break;
  190879. nInst++;
  190880. if( nInst>=pCsr->nInstAlloc ){
  190881. pCsr->nInstAlloc = pCsr->nInstAlloc ? pCsr->nInstAlloc*2 : 32;
  190882. aInst = (int*)sqlite3_realloc(
  190883. pCsr->aInst, pCsr->nInstAlloc*sizeof(int)*3
  190884. );
  190885. if( aInst ){
  190886. pCsr->aInst = aInst;
  190887. }else{
  190888. rc = SQLITE_NOMEM;
  190889. break;
  190890. }
  190891. }
  190892. aInst = &pCsr->aInst[3 * (nInst-1)];
  190893. aInst[0] = iBest;
  190894. aInst[1] = FTS5_POS2COLUMN(aIter[iBest].iPos);
  190895. aInst[2] = FTS5_POS2OFFSET(aIter[iBest].iPos);
  190896. sqlite3Fts5PoslistReaderNext(&aIter[iBest]);
  190897. }
  190898. }
  190899. pCsr->nInstCount = nInst;
  190900. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_INST);
  190901. }
  190902. return rc;
  190903. }
  190904. static int fts5ApiInstCount(Fts5Context *pCtx, int *pnInst){
  190905. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190906. int rc = SQLITE_OK;
  190907. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_INST)==0
  190908. || SQLITE_OK==(rc = fts5CacheInstArray(pCsr)) ){
  190909. *pnInst = pCsr->nInstCount;
  190910. }
  190911. return rc;
  190912. }
  190913. static int fts5ApiInst(
  190914. Fts5Context *pCtx,
  190915. int iIdx,
  190916. int *piPhrase,
  190917. int *piCol,
  190918. int *piOff
  190919. ){
  190920. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190921. int rc = SQLITE_OK;
  190922. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_INST)==0
  190923. || SQLITE_OK==(rc = fts5CacheInstArray(pCsr))
  190924. ){
  190925. if( iIdx<0 || iIdx>=pCsr->nInstCount ){
  190926. rc = SQLITE_RANGE;
  190927. #if 0
  190928. }else if( fts5IsOffsetless((Fts5Table*)pCsr->base.pVtab) ){
  190929. *piPhrase = pCsr->aInst[iIdx*3];
  190930. *piCol = pCsr->aInst[iIdx*3 + 2];
  190931. *piOff = -1;
  190932. #endif
  190933. }else{
  190934. *piPhrase = pCsr->aInst[iIdx*3];
  190935. *piCol = pCsr->aInst[iIdx*3 + 1];
  190936. *piOff = pCsr->aInst[iIdx*3 + 2];
  190937. }
  190938. }
  190939. return rc;
  190940. }
  190941. static sqlite3_int64 fts5ApiRowid(Fts5Context *pCtx){
  190942. return fts5CursorRowid((Fts5Cursor*)pCtx);
  190943. }
  190944. static int fts5ColumnSizeCb(
  190945. void *pContext, /* Pointer to int */
  190946. int tflags,
  190947. const char *pUnused, /* Buffer containing token */
  190948. int nUnused, /* Size of token in bytes */
  190949. int iUnused1, /* Start offset of token */
  190950. int iUnused2 /* End offset of token */
  190951. ){
  190952. int *pCnt = (int*)pContext;
  190953. UNUSED_PARAM2(pUnused, nUnused);
  190954. UNUSED_PARAM2(iUnused1, iUnused2);
  190955. if( (tflags & FTS5_TOKEN_COLOCATED)==0 ){
  190956. (*pCnt)++;
  190957. }
  190958. return SQLITE_OK;
  190959. }
  190960. static int fts5ApiColumnSize(Fts5Context *pCtx, int iCol, int *pnToken){
  190961. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  190962. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  190963. Fts5Config *pConfig = pTab->pConfig;
  190964. int rc = SQLITE_OK;
  190965. if( CsrFlagTest(pCsr, FTS5CSR_REQUIRE_DOCSIZE) ){
  190966. if( pConfig->bColumnsize ){
  190967. i64 iRowid = fts5CursorRowid(pCsr);
  190968. rc = sqlite3Fts5StorageDocsize(pTab->pStorage, iRowid, pCsr->aColumnSize);
  190969. }else if( pConfig->zContent==0 ){
  190970. int i;
  190971. for(i=0; i<pConfig->nCol; i++){
  190972. if( pConfig->abUnindexed[i]==0 ){
  190973. pCsr->aColumnSize[i] = -1;
  190974. }
  190975. }
  190976. }else{
  190977. int i;
  190978. for(i=0; rc==SQLITE_OK && i<pConfig->nCol; i++){
  190979. if( pConfig->abUnindexed[i]==0 ){
  190980. const char *z; int n;
  190981. void *p = (void*)(&pCsr->aColumnSize[i]);
  190982. pCsr->aColumnSize[i] = 0;
  190983. rc = fts5ApiColumnText(pCtx, i, &z, &n);
  190984. if( rc==SQLITE_OK ){
  190985. rc = sqlite3Fts5Tokenize(
  190986. pConfig, FTS5_TOKENIZE_AUX, z, n, p, fts5ColumnSizeCb
  190987. );
  190988. }
  190989. }
  190990. }
  190991. }
  190992. CsrFlagClear(pCsr, FTS5CSR_REQUIRE_DOCSIZE);
  190993. }
  190994. if( iCol<0 ){
  190995. int i;
  190996. *pnToken = 0;
  190997. for(i=0; i<pConfig->nCol; i++){
  190998. *pnToken += pCsr->aColumnSize[i];
  190999. }
  191000. }else if( iCol<pConfig->nCol ){
  191001. *pnToken = pCsr->aColumnSize[iCol];
  191002. }else{
  191003. *pnToken = 0;
  191004. rc = SQLITE_RANGE;
  191005. }
  191006. return rc;
  191007. }
  191008. /*
  191009. ** Implementation of the xSetAuxdata() method.
  191010. */
  191011. static int fts5ApiSetAuxdata(
  191012. Fts5Context *pCtx, /* Fts5 context */
  191013. void *pPtr, /* Pointer to save as auxdata */
  191014. void(*xDelete)(void*) /* Destructor for pPtr (or NULL) */
  191015. ){
  191016. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  191017. Fts5Auxdata *pData;
  191018. /* Search through the cursors list of Fts5Auxdata objects for one that
  191019. ** corresponds to the currently executing auxiliary function. */
  191020. for(pData=pCsr->pAuxdata; pData; pData=pData->pNext){
  191021. if( pData->pAux==pCsr->pAux ) break;
  191022. }
  191023. if( pData ){
  191024. if( pData->xDelete ){
  191025. pData->xDelete(pData->pPtr);
  191026. }
  191027. }else{
  191028. int rc = SQLITE_OK;
  191029. pData = (Fts5Auxdata*)sqlite3Fts5MallocZero(&rc, sizeof(Fts5Auxdata));
  191030. if( pData==0 ){
  191031. if( xDelete ) xDelete(pPtr);
  191032. return rc;
  191033. }
  191034. pData->pAux = pCsr->pAux;
  191035. pData->pNext = pCsr->pAuxdata;
  191036. pCsr->pAuxdata = pData;
  191037. }
  191038. pData->xDelete = xDelete;
  191039. pData->pPtr = pPtr;
  191040. return SQLITE_OK;
  191041. }
  191042. static void *fts5ApiGetAuxdata(Fts5Context *pCtx, int bClear){
  191043. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  191044. Fts5Auxdata *pData;
  191045. void *pRet = 0;
  191046. for(pData=pCsr->pAuxdata; pData; pData=pData->pNext){
  191047. if( pData->pAux==pCsr->pAux ) break;
  191048. }
  191049. if( pData ){
  191050. pRet = pData->pPtr;
  191051. if( bClear ){
  191052. pData->pPtr = 0;
  191053. pData->xDelete = 0;
  191054. }
  191055. }
  191056. return pRet;
  191057. }
  191058. static void fts5ApiPhraseNext(
  191059. Fts5Context *pUnused,
  191060. Fts5PhraseIter *pIter,
  191061. int *piCol, int *piOff
  191062. ){
  191063. UNUSED_PARAM(pUnused);
  191064. if( pIter->a>=pIter->b ){
  191065. *piCol = -1;
  191066. *piOff = -1;
  191067. }else{
  191068. int iVal;
  191069. pIter->a += fts5GetVarint32(pIter->a, iVal);
  191070. if( iVal==1 ){
  191071. pIter->a += fts5GetVarint32(pIter->a, iVal);
  191072. *piCol = iVal;
  191073. *piOff = 0;
  191074. pIter->a += fts5GetVarint32(pIter->a, iVal);
  191075. }
  191076. *piOff += (iVal-2);
  191077. }
  191078. }
  191079. static int fts5ApiPhraseFirst(
  191080. Fts5Context *pCtx,
  191081. int iPhrase,
  191082. Fts5PhraseIter *pIter,
  191083. int *piCol, int *piOff
  191084. ){
  191085. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  191086. int n;
  191087. int rc = fts5CsrPoslist(pCsr, iPhrase, &pIter->a, &n);
  191088. if( rc==SQLITE_OK ){
  191089. pIter->b = &pIter->a[n];
  191090. *piCol = 0;
  191091. *piOff = 0;
  191092. fts5ApiPhraseNext(pCtx, pIter, piCol, piOff);
  191093. }
  191094. return rc;
  191095. }
  191096. static void fts5ApiPhraseNextColumn(
  191097. Fts5Context *pCtx,
  191098. Fts5PhraseIter *pIter,
  191099. int *piCol
  191100. ){
  191101. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  191102. Fts5Config *pConfig = ((Fts5Table*)(pCsr->base.pVtab))->pConfig;
  191103. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  191104. if( pIter->a>=pIter->b ){
  191105. *piCol = -1;
  191106. }else{
  191107. int iIncr;
  191108. pIter->a += fts5GetVarint32(&pIter->a[0], iIncr);
  191109. *piCol += (iIncr-2);
  191110. }
  191111. }else{
  191112. while( 1 ){
  191113. int dummy;
  191114. if( pIter->a>=pIter->b ){
  191115. *piCol = -1;
  191116. return;
  191117. }
  191118. if( pIter->a[0]==0x01 ) break;
  191119. pIter->a += fts5GetVarint32(pIter->a, dummy);
  191120. }
  191121. pIter->a += 1 + fts5GetVarint32(&pIter->a[1], *piCol);
  191122. }
  191123. }
  191124. static int fts5ApiPhraseFirstColumn(
  191125. Fts5Context *pCtx,
  191126. int iPhrase,
  191127. Fts5PhraseIter *pIter,
  191128. int *piCol
  191129. ){
  191130. int rc = SQLITE_OK;
  191131. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  191132. Fts5Config *pConfig = ((Fts5Table*)(pCsr->base.pVtab))->pConfig;
  191133. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  191134. Fts5Sorter *pSorter = pCsr->pSorter;
  191135. int n;
  191136. if( pSorter ){
  191137. int i1 = (iPhrase==0 ? 0 : pSorter->aIdx[iPhrase-1]);
  191138. n = pSorter->aIdx[iPhrase] - i1;
  191139. pIter->a = &pSorter->aPoslist[i1];
  191140. }else{
  191141. rc = sqlite3Fts5ExprPhraseCollist(pCsr->pExpr, iPhrase, &pIter->a, &n);
  191142. }
  191143. if( rc==SQLITE_OK ){
  191144. pIter->b = &pIter->a[n];
  191145. *piCol = 0;
  191146. fts5ApiPhraseNextColumn(pCtx, pIter, piCol);
  191147. }
  191148. }else{
  191149. int n;
  191150. rc = fts5CsrPoslist(pCsr, iPhrase, &pIter->a, &n);
  191151. if( rc==SQLITE_OK ){
  191152. pIter->b = &pIter->a[n];
  191153. if( n<=0 ){
  191154. *piCol = -1;
  191155. }else if( pIter->a[0]==0x01 ){
  191156. pIter->a += 1 + fts5GetVarint32(&pIter->a[1], *piCol);
  191157. }else{
  191158. *piCol = 0;
  191159. }
  191160. }
  191161. }
  191162. return rc;
  191163. }
  191164. static int fts5ApiQueryPhrase(Fts5Context*, int, void*,
  191165. int(*)(const Fts5ExtensionApi*, Fts5Context*, void*)
  191166. );
  191167. static const Fts5ExtensionApi sFts5Api = {
  191168. 2, /* iVersion */
  191169. fts5ApiUserData,
  191170. fts5ApiColumnCount,
  191171. fts5ApiRowCount,
  191172. fts5ApiColumnTotalSize,
  191173. fts5ApiTokenize,
  191174. fts5ApiPhraseCount,
  191175. fts5ApiPhraseSize,
  191176. fts5ApiInstCount,
  191177. fts5ApiInst,
  191178. fts5ApiRowid,
  191179. fts5ApiColumnText,
  191180. fts5ApiColumnSize,
  191181. fts5ApiQueryPhrase,
  191182. fts5ApiSetAuxdata,
  191183. fts5ApiGetAuxdata,
  191184. fts5ApiPhraseFirst,
  191185. fts5ApiPhraseNext,
  191186. fts5ApiPhraseFirstColumn,
  191187. fts5ApiPhraseNextColumn,
  191188. };
  191189. /*
  191190. ** Implementation of API function xQueryPhrase().
  191191. */
  191192. static int fts5ApiQueryPhrase(
  191193. Fts5Context *pCtx,
  191194. int iPhrase,
  191195. void *pUserData,
  191196. int(*xCallback)(const Fts5ExtensionApi*, Fts5Context*, void*)
  191197. ){
  191198. Fts5Cursor *pCsr = (Fts5Cursor*)pCtx;
  191199. Fts5Table *pTab = (Fts5Table*)(pCsr->base.pVtab);
  191200. int rc;
  191201. Fts5Cursor *pNew = 0;
  191202. rc = fts5OpenMethod(pCsr->base.pVtab, (sqlite3_vtab_cursor**)&pNew);
  191203. if( rc==SQLITE_OK ){
  191204. pNew->ePlan = FTS5_PLAN_MATCH;
  191205. pNew->iFirstRowid = SMALLEST_INT64;
  191206. pNew->iLastRowid = LARGEST_INT64;
  191207. pNew->base.pVtab = (sqlite3_vtab*)pTab;
  191208. rc = sqlite3Fts5ExprClonePhrase(pCsr->pExpr, iPhrase, &pNew->pExpr);
  191209. }
  191210. if( rc==SQLITE_OK ){
  191211. for(rc = fts5CursorFirst(pTab, pNew, 0);
  191212. rc==SQLITE_OK && CsrFlagTest(pNew, FTS5CSR_EOF)==0;
  191213. rc = fts5NextMethod((sqlite3_vtab_cursor*)pNew)
  191214. ){
  191215. rc = xCallback(&sFts5Api, (Fts5Context*)pNew, pUserData);
  191216. if( rc!=SQLITE_OK ){
  191217. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  191218. break;
  191219. }
  191220. }
  191221. }
  191222. fts5CloseMethod((sqlite3_vtab_cursor*)pNew);
  191223. return rc;
  191224. }
  191225. static void fts5ApiInvoke(
  191226. Fts5Auxiliary *pAux,
  191227. Fts5Cursor *pCsr,
  191228. sqlite3_context *context,
  191229. int argc,
  191230. sqlite3_value **argv
  191231. ){
  191232. assert( pCsr->pAux==0 );
  191233. pCsr->pAux = pAux;
  191234. pAux->xFunc(&sFts5Api, (Fts5Context*)pCsr, context, argc, argv);
  191235. pCsr->pAux = 0;
  191236. }
  191237. static Fts5Cursor *fts5CursorFromCsrid(Fts5Global *pGlobal, i64 iCsrId){
  191238. Fts5Cursor *pCsr;
  191239. for(pCsr=pGlobal->pCsr; pCsr; pCsr=pCsr->pNext){
  191240. if( pCsr->iCsrId==iCsrId ) break;
  191241. }
  191242. return pCsr;
  191243. }
  191244. static void fts5ApiCallback(
  191245. sqlite3_context *context,
  191246. int argc,
  191247. sqlite3_value **argv
  191248. ){
  191249. Fts5Auxiliary *pAux;
  191250. Fts5Cursor *pCsr;
  191251. i64 iCsrId;
  191252. assert( argc>=1 );
  191253. pAux = (Fts5Auxiliary*)sqlite3_user_data(context);
  191254. iCsrId = sqlite3_value_int64(argv[0]);
  191255. pCsr = fts5CursorFromCsrid(pAux->pGlobal, iCsrId);
  191256. if( pCsr==0 ){
  191257. char *zErr = sqlite3_mprintf("no such cursor: %lld", iCsrId);
  191258. sqlite3_result_error(context, zErr, -1);
  191259. sqlite3_free(zErr);
  191260. }else{
  191261. fts5ApiInvoke(pAux, pCsr, context, argc-1, &argv[1]);
  191262. }
  191263. }
  191264. /*
  191265. ** Given cursor id iId, return a pointer to the corresponding Fts5Index
  191266. ** object. Or NULL If the cursor id does not exist.
  191267. **
  191268. ** If successful, set *ppConfig to point to the associated config object
  191269. ** before returning.
  191270. */
  191271. static Fts5Index *sqlite3Fts5IndexFromCsrid(
  191272. Fts5Global *pGlobal, /* FTS5 global context for db handle */
  191273. i64 iCsrId, /* Id of cursor to find */
  191274. Fts5Config **ppConfig /* OUT: Configuration object */
  191275. ){
  191276. Fts5Cursor *pCsr;
  191277. Fts5Table *pTab;
  191278. pCsr = fts5CursorFromCsrid(pGlobal, iCsrId);
  191279. pTab = (Fts5Table*)pCsr->base.pVtab;
  191280. *ppConfig = pTab->pConfig;
  191281. return pTab->pIndex;
  191282. }
  191283. /*
  191284. ** Return a "position-list blob" corresponding to the current position of
  191285. ** cursor pCsr via sqlite3_result_blob(). A position-list blob contains
  191286. ** the current position-list for each phrase in the query associated with
  191287. ** cursor pCsr.
  191288. **
  191289. ** A position-list blob begins with (nPhrase-1) varints, where nPhrase is
  191290. ** the number of phrases in the query. Following the varints are the
  191291. ** concatenated position lists for each phrase, in order.
  191292. **
  191293. ** The first varint (if it exists) contains the size of the position list
  191294. ** for phrase 0. The second (same disclaimer) contains the size of position
  191295. ** list 1. And so on. There is no size field for the final position list,
  191296. ** as it can be derived from the total size of the blob.
  191297. */
  191298. static int fts5PoslistBlob(sqlite3_context *pCtx, Fts5Cursor *pCsr){
  191299. int i;
  191300. int rc = SQLITE_OK;
  191301. int nPhrase = sqlite3Fts5ExprPhraseCount(pCsr->pExpr);
  191302. Fts5Buffer val;
  191303. memset(&val, 0, sizeof(Fts5Buffer));
  191304. switch( ((Fts5Table*)(pCsr->base.pVtab))->pConfig->eDetail ){
  191305. case FTS5_DETAIL_FULL:
  191306. /* Append the varints */
  191307. for(i=0; i<(nPhrase-1); i++){
  191308. const u8 *dummy;
  191309. int nByte = sqlite3Fts5ExprPoslist(pCsr->pExpr, i, &dummy);
  191310. sqlite3Fts5BufferAppendVarint(&rc, &val, nByte);
  191311. }
  191312. /* Append the position lists */
  191313. for(i=0; i<nPhrase; i++){
  191314. const u8 *pPoslist;
  191315. int nPoslist;
  191316. nPoslist = sqlite3Fts5ExprPoslist(pCsr->pExpr, i, &pPoslist);
  191317. sqlite3Fts5BufferAppendBlob(&rc, &val, nPoslist, pPoslist);
  191318. }
  191319. break;
  191320. case FTS5_DETAIL_COLUMNS:
  191321. /* Append the varints */
  191322. for(i=0; rc==SQLITE_OK && i<(nPhrase-1); i++){
  191323. const u8 *dummy;
  191324. int nByte;
  191325. rc = sqlite3Fts5ExprPhraseCollist(pCsr->pExpr, i, &dummy, &nByte);
  191326. sqlite3Fts5BufferAppendVarint(&rc, &val, nByte);
  191327. }
  191328. /* Append the position lists */
  191329. for(i=0; rc==SQLITE_OK && i<nPhrase; i++){
  191330. const u8 *pPoslist;
  191331. int nPoslist;
  191332. rc = sqlite3Fts5ExprPhraseCollist(pCsr->pExpr, i, &pPoslist, &nPoslist);
  191333. sqlite3Fts5BufferAppendBlob(&rc, &val, nPoslist, pPoslist);
  191334. }
  191335. break;
  191336. default:
  191337. break;
  191338. }
  191339. sqlite3_result_blob(pCtx, val.p, val.n, sqlite3_free);
  191340. return rc;
  191341. }
  191342. /*
  191343. ** This is the xColumn method, called by SQLite to request a value from
  191344. ** the row that the supplied cursor currently points to.
  191345. */
  191346. static int fts5ColumnMethod(
  191347. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  191348. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  191349. int iCol /* Index of column to read value from */
  191350. ){
  191351. Fts5Table *pTab = (Fts5Table*)(pCursor->pVtab);
  191352. Fts5Config *pConfig = pTab->pConfig;
  191353. Fts5Cursor *pCsr = (Fts5Cursor*)pCursor;
  191354. int rc = SQLITE_OK;
  191355. assert( CsrFlagTest(pCsr, FTS5CSR_EOF)==0 );
  191356. if( pCsr->ePlan==FTS5_PLAN_SPECIAL ){
  191357. if( iCol==pConfig->nCol ){
  191358. sqlite3_result_int64(pCtx, pCsr->iSpecial);
  191359. }
  191360. }else
  191361. if( iCol==pConfig->nCol ){
  191362. /* User is requesting the value of the special column with the same name
  191363. ** as the table. Return the cursor integer id number. This value is only
  191364. ** useful in that it may be passed as the first argument to an FTS5
  191365. ** auxiliary function. */
  191366. sqlite3_result_int64(pCtx, pCsr->iCsrId);
  191367. }else if( iCol==pConfig->nCol+1 ){
  191368. /* The value of the "rank" column. */
  191369. if( pCsr->ePlan==FTS5_PLAN_SOURCE ){
  191370. fts5PoslistBlob(pCtx, pCsr);
  191371. }else if(
  191372. pCsr->ePlan==FTS5_PLAN_MATCH
  191373. || pCsr->ePlan==FTS5_PLAN_SORTED_MATCH
  191374. ){
  191375. if( pCsr->pRank || SQLITE_OK==(rc = fts5FindRankFunction(pCsr)) ){
  191376. fts5ApiInvoke(pCsr->pRank, pCsr, pCtx, pCsr->nRankArg, pCsr->apRankArg);
  191377. }
  191378. }
  191379. }else if( !fts5IsContentless(pTab) ){
  191380. rc = fts5SeekCursor(pCsr, 1);
  191381. if( rc==SQLITE_OK ){
  191382. sqlite3_result_value(pCtx, sqlite3_column_value(pCsr->pStmt, iCol+1));
  191383. }
  191384. }
  191385. return rc;
  191386. }
  191387. /*
  191388. ** This routine implements the xFindFunction method for the FTS3
  191389. ** virtual table.
  191390. */
  191391. static int fts5FindFunctionMethod(
  191392. sqlite3_vtab *pVtab, /* Virtual table handle */
  191393. int nUnused, /* Number of SQL function arguments */
  191394. const char *zName, /* Name of SQL function */
  191395. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), /* OUT: Result */
  191396. void **ppArg /* OUT: User data for *pxFunc */
  191397. ){
  191398. Fts5Table *pTab = (Fts5Table*)pVtab;
  191399. Fts5Auxiliary *pAux;
  191400. UNUSED_PARAM(nUnused);
  191401. pAux = fts5FindAuxiliary(pTab, zName);
  191402. if( pAux ){
  191403. *pxFunc = fts5ApiCallback;
  191404. *ppArg = (void*)pAux;
  191405. return 1;
  191406. }
  191407. /* No function of the specified name was found. Return 0. */
  191408. return 0;
  191409. }
  191410. /*
  191411. ** Implementation of FTS5 xRename method. Rename an fts5 table.
  191412. */
  191413. static int fts5RenameMethod(
  191414. sqlite3_vtab *pVtab, /* Virtual table handle */
  191415. const char *zName /* New name of table */
  191416. ){
  191417. Fts5Table *pTab = (Fts5Table*)pVtab;
  191418. return sqlite3Fts5StorageRename(pTab->pStorage, zName);
  191419. }
  191420. /*
  191421. ** The xSavepoint() method.
  191422. **
  191423. ** Flush the contents of the pending-terms table to disk.
  191424. */
  191425. static int fts5SavepointMethod(sqlite3_vtab *pVtab, int iSavepoint){
  191426. Fts5Table *pTab = (Fts5Table*)pVtab;
  191427. UNUSED_PARAM(iSavepoint); /* Call below is a no-op for NDEBUG builds */
  191428. fts5CheckTransactionState(pTab, FTS5_SAVEPOINT, iSavepoint);
  191429. fts5TripCursors(pTab);
  191430. return sqlite3Fts5StorageSync(pTab->pStorage);
  191431. }
  191432. /*
  191433. ** The xRelease() method.
  191434. **
  191435. ** This is a no-op.
  191436. */
  191437. static int fts5ReleaseMethod(sqlite3_vtab *pVtab, int iSavepoint){
  191438. Fts5Table *pTab = (Fts5Table*)pVtab;
  191439. UNUSED_PARAM(iSavepoint); /* Call below is a no-op for NDEBUG builds */
  191440. fts5CheckTransactionState(pTab, FTS5_RELEASE, iSavepoint);
  191441. fts5TripCursors(pTab);
  191442. return sqlite3Fts5StorageSync(pTab->pStorage);
  191443. }
  191444. /*
  191445. ** The xRollbackTo() method.
  191446. **
  191447. ** Discard the contents of the pending terms table.
  191448. */
  191449. static int fts5RollbackToMethod(sqlite3_vtab *pVtab, int iSavepoint){
  191450. Fts5Table *pTab = (Fts5Table*)pVtab;
  191451. UNUSED_PARAM(iSavepoint); /* Call below is a no-op for NDEBUG builds */
  191452. fts5CheckTransactionState(pTab, FTS5_ROLLBACKTO, iSavepoint);
  191453. fts5TripCursors(pTab);
  191454. return sqlite3Fts5StorageRollback(pTab->pStorage);
  191455. }
  191456. /*
  191457. ** Register a new auxiliary function with global context pGlobal.
  191458. */
  191459. static int fts5CreateAux(
  191460. fts5_api *pApi, /* Global context (one per db handle) */
  191461. const char *zName, /* Name of new function */
  191462. void *pUserData, /* User data for aux. function */
  191463. fts5_extension_function xFunc, /* Aux. function implementation */
  191464. void(*xDestroy)(void*) /* Destructor for pUserData */
  191465. ){
  191466. Fts5Global *pGlobal = (Fts5Global*)pApi;
  191467. int rc = sqlite3_overload_function(pGlobal->db, zName, -1);
  191468. if( rc==SQLITE_OK ){
  191469. Fts5Auxiliary *pAux;
  191470. int nName; /* Size of zName in bytes, including \0 */
  191471. int nByte; /* Bytes of space to allocate */
  191472. nName = (int)strlen(zName) + 1;
  191473. nByte = sizeof(Fts5Auxiliary) + nName;
  191474. pAux = (Fts5Auxiliary*)sqlite3_malloc(nByte);
  191475. if( pAux ){
  191476. memset(pAux, 0, nByte);
  191477. pAux->zFunc = (char*)&pAux[1];
  191478. memcpy(pAux->zFunc, zName, nName);
  191479. pAux->pGlobal = pGlobal;
  191480. pAux->pUserData = pUserData;
  191481. pAux->xFunc = xFunc;
  191482. pAux->xDestroy = xDestroy;
  191483. pAux->pNext = pGlobal->pAux;
  191484. pGlobal->pAux = pAux;
  191485. }else{
  191486. rc = SQLITE_NOMEM;
  191487. }
  191488. }
  191489. return rc;
  191490. }
  191491. /*
  191492. ** Register a new tokenizer. This is the implementation of the
  191493. ** fts5_api.xCreateTokenizer() method.
  191494. */
  191495. static int fts5CreateTokenizer(
  191496. fts5_api *pApi, /* Global context (one per db handle) */
  191497. const char *zName, /* Name of new function */
  191498. void *pUserData, /* User data for aux. function */
  191499. fts5_tokenizer *pTokenizer, /* Tokenizer implementation */
  191500. void(*xDestroy)(void*) /* Destructor for pUserData */
  191501. ){
  191502. Fts5Global *pGlobal = (Fts5Global*)pApi;
  191503. Fts5TokenizerModule *pNew;
  191504. int nName; /* Size of zName and its \0 terminator */
  191505. int nByte; /* Bytes of space to allocate */
  191506. int rc = SQLITE_OK;
  191507. nName = (int)strlen(zName) + 1;
  191508. nByte = sizeof(Fts5TokenizerModule) + nName;
  191509. pNew = (Fts5TokenizerModule*)sqlite3_malloc(nByte);
  191510. if( pNew ){
  191511. memset(pNew, 0, nByte);
  191512. pNew->zName = (char*)&pNew[1];
  191513. memcpy(pNew->zName, zName, nName);
  191514. pNew->pUserData = pUserData;
  191515. pNew->x = *pTokenizer;
  191516. pNew->xDestroy = xDestroy;
  191517. pNew->pNext = pGlobal->pTok;
  191518. pGlobal->pTok = pNew;
  191519. if( pNew->pNext==0 ){
  191520. pGlobal->pDfltTok = pNew;
  191521. }
  191522. }else{
  191523. rc = SQLITE_NOMEM;
  191524. }
  191525. return rc;
  191526. }
  191527. static Fts5TokenizerModule *fts5LocateTokenizer(
  191528. Fts5Global *pGlobal,
  191529. const char *zName
  191530. ){
  191531. Fts5TokenizerModule *pMod = 0;
  191532. if( zName==0 ){
  191533. pMod = pGlobal->pDfltTok;
  191534. }else{
  191535. for(pMod=pGlobal->pTok; pMod; pMod=pMod->pNext){
  191536. if( sqlite3_stricmp(zName, pMod->zName)==0 ) break;
  191537. }
  191538. }
  191539. return pMod;
  191540. }
  191541. /*
  191542. ** Find a tokenizer. This is the implementation of the
  191543. ** fts5_api.xFindTokenizer() method.
  191544. */
  191545. static int fts5FindTokenizer(
  191546. fts5_api *pApi, /* Global context (one per db handle) */
  191547. const char *zName, /* Name of new function */
  191548. void **ppUserData,
  191549. fts5_tokenizer *pTokenizer /* Populate this object */
  191550. ){
  191551. int rc = SQLITE_OK;
  191552. Fts5TokenizerModule *pMod;
  191553. pMod = fts5LocateTokenizer((Fts5Global*)pApi, zName);
  191554. if( pMod ){
  191555. *pTokenizer = pMod->x;
  191556. *ppUserData = pMod->pUserData;
  191557. }else{
  191558. memset(pTokenizer, 0, sizeof(fts5_tokenizer));
  191559. rc = SQLITE_ERROR;
  191560. }
  191561. return rc;
  191562. }
  191563. static int sqlite3Fts5GetTokenizer(
  191564. Fts5Global *pGlobal,
  191565. const char **azArg,
  191566. int nArg,
  191567. Fts5Tokenizer **ppTok,
  191568. fts5_tokenizer **ppTokApi,
  191569. char **pzErr
  191570. ){
  191571. Fts5TokenizerModule *pMod;
  191572. int rc = SQLITE_OK;
  191573. pMod = fts5LocateTokenizer(pGlobal, nArg==0 ? 0 : azArg[0]);
  191574. if( pMod==0 ){
  191575. assert( nArg>0 );
  191576. rc = SQLITE_ERROR;
  191577. *pzErr = sqlite3_mprintf("no such tokenizer: %s", azArg[0]);
  191578. }else{
  191579. rc = pMod->x.xCreate(pMod->pUserData, &azArg[1], (nArg?nArg-1:0), ppTok);
  191580. *ppTokApi = &pMod->x;
  191581. if( rc!=SQLITE_OK && pzErr ){
  191582. *pzErr = sqlite3_mprintf("error in tokenizer constructor");
  191583. }
  191584. }
  191585. if( rc!=SQLITE_OK ){
  191586. *ppTokApi = 0;
  191587. *ppTok = 0;
  191588. }
  191589. return rc;
  191590. }
  191591. static void fts5ModuleDestroy(void *pCtx){
  191592. Fts5TokenizerModule *pTok, *pNextTok;
  191593. Fts5Auxiliary *pAux, *pNextAux;
  191594. Fts5Global *pGlobal = (Fts5Global*)pCtx;
  191595. for(pAux=pGlobal->pAux; pAux; pAux=pNextAux){
  191596. pNextAux = pAux->pNext;
  191597. if( pAux->xDestroy ) pAux->xDestroy(pAux->pUserData);
  191598. sqlite3_free(pAux);
  191599. }
  191600. for(pTok=pGlobal->pTok; pTok; pTok=pNextTok){
  191601. pNextTok = pTok->pNext;
  191602. if( pTok->xDestroy ) pTok->xDestroy(pTok->pUserData);
  191603. sqlite3_free(pTok);
  191604. }
  191605. sqlite3_free(pGlobal);
  191606. }
  191607. static void fts5Fts5Func(
  191608. sqlite3_context *pCtx, /* Function call context */
  191609. int nArg, /* Number of args */
  191610. sqlite3_value **apArg /* Function arguments */
  191611. ){
  191612. Fts5Global *pGlobal = (Fts5Global*)sqlite3_user_data(pCtx);
  191613. fts5_api **ppApi;
  191614. UNUSED_PARAM(nArg);
  191615. assert( nArg==1 );
  191616. ppApi = (fts5_api**)sqlite3_value_pointer(apArg[0], "fts5_api_ptr");
  191617. if( ppApi ) *ppApi = &pGlobal->api;
  191618. }
  191619. /*
  191620. ** Implementation of fts5_source_id() function.
  191621. */
  191622. static void fts5SourceIdFunc(
  191623. sqlite3_context *pCtx, /* Function call context */
  191624. int nArg, /* Number of args */
  191625. sqlite3_value **apUnused /* Function arguments */
  191626. ){
  191627. assert( nArg==0 );
  191628. UNUSED_PARAM2(nArg, apUnused);
  191629. sqlite3_result_text(pCtx, "fts5: 2018-04-10 17:39:29 4bb2294022060e61de7da5c227a69ccd846ba330e31626ebcd59a94efd148b3b", -1, SQLITE_TRANSIENT);
  191630. }
  191631. static int fts5Init(sqlite3 *db){
  191632. static const sqlite3_module fts5Mod = {
  191633. /* iVersion */ 2,
  191634. /* xCreate */ fts5CreateMethod,
  191635. /* xConnect */ fts5ConnectMethod,
  191636. /* xBestIndex */ fts5BestIndexMethod,
  191637. /* xDisconnect */ fts5DisconnectMethod,
  191638. /* xDestroy */ fts5DestroyMethod,
  191639. /* xOpen */ fts5OpenMethod,
  191640. /* xClose */ fts5CloseMethod,
  191641. /* xFilter */ fts5FilterMethod,
  191642. /* xNext */ fts5NextMethod,
  191643. /* xEof */ fts5EofMethod,
  191644. /* xColumn */ fts5ColumnMethod,
  191645. /* xRowid */ fts5RowidMethod,
  191646. /* xUpdate */ fts5UpdateMethod,
  191647. /* xBegin */ fts5BeginMethod,
  191648. /* xSync */ fts5SyncMethod,
  191649. /* xCommit */ fts5CommitMethod,
  191650. /* xRollback */ fts5RollbackMethod,
  191651. /* xFindFunction */ fts5FindFunctionMethod,
  191652. /* xRename */ fts5RenameMethod,
  191653. /* xSavepoint */ fts5SavepointMethod,
  191654. /* xRelease */ fts5ReleaseMethod,
  191655. /* xRollbackTo */ fts5RollbackToMethod,
  191656. };
  191657. int rc;
  191658. Fts5Global *pGlobal = 0;
  191659. pGlobal = (Fts5Global*)sqlite3_malloc(sizeof(Fts5Global));
  191660. if( pGlobal==0 ){
  191661. rc = SQLITE_NOMEM;
  191662. }else{
  191663. void *p = (void*)pGlobal;
  191664. memset(pGlobal, 0, sizeof(Fts5Global));
  191665. pGlobal->db = db;
  191666. pGlobal->api.iVersion = 2;
  191667. pGlobal->api.xCreateFunction = fts5CreateAux;
  191668. pGlobal->api.xCreateTokenizer = fts5CreateTokenizer;
  191669. pGlobal->api.xFindTokenizer = fts5FindTokenizer;
  191670. rc = sqlite3_create_module_v2(db, "fts5", &fts5Mod, p, fts5ModuleDestroy);
  191671. if( rc==SQLITE_OK ) rc = sqlite3Fts5IndexInit(db);
  191672. if( rc==SQLITE_OK ) rc = sqlite3Fts5ExprInit(pGlobal, db);
  191673. if( rc==SQLITE_OK ) rc = sqlite3Fts5AuxInit(&pGlobal->api);
  191674. if( rc==SQLITE_OK ) rc = sqlite3Fts5TokenizerInit(&pGlobal->api);
  191675. if( rc==SQLITE_OK ) rc = sqlite3Fts5VocabInit(pGlobal, db);
  191676. if( rc==SQLITE_OK ){
  191677. rc = sqlite3_create_function(
  191678. db, "fts5", 1, SQLITE_UTF8, p, fts5Fts5Func, 0, 0
  191679. );
  191680. }
  191681. if( rc==SQLITE_OK ){
  191682. rc = sqlite3_create_function(
  191683. db, "fts5_source_id", 0, SQLITE_UTF8, p, fts5SourceIdFunc, 0, 0
  191684. );
  191685. }
  191686. }
  191687. /* If SQLITE_FTS5_ENABLE_TEST_MI is defined, assume that the file
  191688. ** fts5_test_mi.c is compiled and linked into the executable. And call
  191689. ** its entry point to enable the matchinfo() demo. */
  191690. #ifdef SQLITE_FTS5_ENABLE_TEST_MI
  191691. if( rc==SQLITE_OK ){
  191692. extern int sqlite3Fts5TestRegisterMatchinfo(sqlite3*);
  191693. rc = sqlite3Fts5TestRegisterMatchinfo(db);
  191694. }
  191695. #endif
  191696. return rc;
  191697. }
  191698. /*
  191699. ** The following functions are used to register the module with SQLite. If
  191700. ** this module is being built as part of the SQLite core (SQLITE_CORE is
  191701. ** defined), then sqlite3_open() will call sqlite3Fts5Init() directly.
  191702. **
  191703. ** Or, if this module is being built as a loadable extension,
  191704. ** sqlite3Fts5Init() is omitted and the two standard entry points
  191705. ** sqlite3_fts_init() and sqlite3_fts5_init() defined instead.
  191706. */
  191707. #ifndef SQLITE_CORE
  191708. #ifdef _WIN32
  191709. __declspec(dllexport)
  191710. #endif
  191711. SQLITE_API int sqlite3_fts_init(
  191712. sqlite3 *db,
  191713. char **pzErrMsg,
  191714. const sqlite3_api_routines *pApi
  191715. ){
  191716. SQLITE_EXTENSION_INIT2(pApi);
  191717. (void)pzErrMsg; /* Unused parameter */
  191718. return fts5Init(db);
  191719. }
  191720. #ifdef _WIN32
  191721. __declspec(dllexport)
  191722. #endif
  191723. SQLITE_API int sqlite3_fts5_init(
  191724. sqlite3 *db,
  191725. char **pzErrMsg,
  191726. const sqlite3_api_routines *pApi
  191727. ){
  191728. SQLITE_EXTENSION_INIT2(pApi);
  191729. (void)pzErrMsg; /* Unused parameter */
  191730. return fts5Init(db);
  191731. }
  191732. #else
  191733. SQLITE_PRIVATE int sqlite3Fts5Init(sqlite3 *db){
  191734. return fts5Init(db);
  191735. }
  191736. #endif
  191737. /*
  191738. ** 2014 May 31
  191739. **
  191740. ** The author disclaims copyright to this source code. In place of
  191741. ** a legal notice, here is a blessing:
  191742. **
  191743. ** May you do good and not evil.
  191744. ** May you find forgiveness for yourself and forgive others.
  191745. ** May you share freely, never taking more than you give.
  191746. **
  191747. ******************************************************************************
  191748. **
  191749. */
  191750. /* #include "fts5Int.h" */
  191751. struct Fts5Storage {
  191752. Fts5Config *pConfig;
  191753. Fts5Index *pIndex;
  191754. int bTotalsValid; /* True if nTotalRow/aTotalSize[] are valid */
  191755. i64 nTotalRow; /* Total number of rows in FTS table */
  191756. i64 *aTotalSize; /* Total sizes of each column */
  191757. sqlite3_stmt *aStmt[11];
  191758. };
  191759. #if FTS5_STMT_SCAN_ASC!=0
  191760. # error "FTS5_STMT_SCAN_ASC mismatch"
  191761. #endif
  191762. #if FTS5_STMT_SCAN_DESC!=1
  191763. # error "FTS5_STMT_SCAN_DESC mismatch"
  191764. #endif
  191765. #if FTS5_STMT_LOOKUP!=2
  191766. # error "FTS5_STMT_LOOKUP mismatch"
  191767. #endif
  191768. #define FTS5_STMT_INSERT_CONTENT 3
  191769. #define FTS5_STMT_REPLACE_CONTENT 4
  191770. #define FTS5_STMT_DELETE_CONTENT 5
  191771. #define FTS5_STMT_REPLACE_DOCSIZE 6
  191772. #define FTS5_STMT_DELETE_DOCSIZE 7
  191773. #define FTS5_STMT_LOOKUP_DOCSIZE 8
  191774. #define FTS5_STMT_REPLACE_CONFIG 9
  191775. #define FTS5_STMT_SCAN 10
  191776. /*
  191777. ** Prepare the two insert statements - Fts5Storage.pInsertContent and
  191778. ** Fts5Storage.pInsertDocsize - if they have not already been prepared.
  191779. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  191780. ** occurs.
  191781. */
  191782. static int fts5StorageGetStmt(
  191783. Fts5Storage *p, /* Storage handle */
  191784. int eStmt, /* FTS5_STMT_XXX constant */
  191785. sqlite3_stmt **ppStmt, /* OUT: Prepared statement handle */
  191786. char **pzErrMsg /* OUT: Error message (if any) */
  191787. ){
  191788. int rc = SQLITE_OK;
  191789. /* If there is no %_docsize table, there should be no requests for
  191790. ** statements to operate on it. */
  191791. assert( p->pConfig->bColumnsize || (
  191792. eStmt!=FTS5_STMT_REPLACE_DOCSIZE
  191793. && eStmt!=FTS5_STMT_DELETE_DOCSIZE
  191794. && eStmt!=FTS5_STMT_LOOKUP_DOCSIZE
  191795. ));
  191796. assert( eStmt>=0 && eStmt<ArraySize(p->aStmt) );
  191797. if( p->aStmt[eStmt]==0 ){
  191798. const char *azStmt[] = {
  191799. "SELECT %s FROM %s T WHERE T.%Q >= ? AND T.%Q <= ? ORDER BY T.%Q ASC",
  191800. "SELECT %s FROM %s T WHERE T.%Q <= ? AND T.%Q >= ? ORDER BY T.%Q DESC",
  191801. "SELECT %s FROM %s T WHERE T.%Q=?", /* LOOKUP */
  191802. "INSERT INTO %Q.'%q_content' VALUES(%s)", /* INSERT_CONTENT */
  191803. "REPLACE INTO %Q.'%q_content' VALUES(%s)", /* REPLACE_CONTENT */
  191804. "DELETE FROM %Q.'%q_content' WHERE id=?", /* DELETE_CONTENT */
  191805. "REPLACE INTO %Q.'%q_docsize' VALUES(?,?)", /* REPLACE_DOCSIZE */
  191806. "DELETE FROM %Q.'%q_docsize' WHERE id=?", /* DELETE_DOCSIZE */
  191807. "SELECT sz FROM %Q.'%q_docsize' WHERE id=?", /* LOOKUP_DOCSIZE */
  191808. "REPLACE INTO %Q.'%q_config' VALUES(?,?)", /* REPLACE_CONFIG */
  191809. "SELECT %s FROM %s AS T", /* SCAN */
  191810. };
  191811. Fts5Config *pC = p->pConfig;
  191812. char *zSql = 0;
  191813. switch( eStmt ){
  191814. case FTS5_STMT_SCAN:
  191815. zSql = sqlite3_mprintf(azStmt[eStmt],
  191816. pC->zContentExprlist, pC->zContent
  191817. );
  191818. break;
  191819. case FTS5_STMT_SCAN_ASC:
  191820. case FTS5_STMT_SCAN_DESC:
  191821. zSql = sqlite3_mprintf(azStmt[eStmt], pC->zContentExprlist,
  191822. pC->zContent, pC->zContentRowid, pC->zContentRowid,
  191823. pC->zContentRowid
  191824. );
  191825. break;
  191826. case FTS5_STMT_LOOKUP:
  191827. zSql = sqlite3_mprintf(azStmt[eStmt],
  191828. pC->zContentExprlist, pC->zContent, pC->zContentRowid
  191829. );
  191830. break;
  191831. case FTS5_STMT_INSERT_CONTENT:
  191832. case FTS5_STMT_REPLACE_CONTENT: {
  191833. int nCol = pC->nCol + 1;
  191834. char *zBind;
  191835. int i;
  191836. zBind = sqlite3_malloc(1 + nCol*2);
  191837. if( zBind ){
  191838. for(i=0; i<nCol; i++){
  191839. zBind[i*2] = '?';
  191840. zBind[i*2 + 1] = ',';
  191841. }
  191842. zBind[i*2-1] = '\0';
  191843. zSql = sqlite3_mprintf(azStmt[eStmt], pC->zDb, pC->zName, zBind);
  191844. sqlite3_free(zBind);
  191845. }
  191846. break;
  191847. }
  191848. default:
  191849. zSql = sqlite3_mprintf(azStmt[eStmt], pC->zDb, pC->zName);
  191850. break;
  191851. }
  191852. if( zSql==0 ){
  191853. rc = SQLITE_NOMEM;
  191854. }else{
  191855. rc = sqlite3_prepare_v3(pC->db, zSql, -1,
  191856. SQLITE_PREPARE_PERSISTENT, &p->aStmt[eStmt], 0);
  191857. sqlite3_free(zSql);
  191858. if( rc!=SQLITE_OK && pzErrMsg ){
  191859. *pzErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(pC->db));
  191860. }
  191861. }
  191862. }
  191863. *ppStmt = p->aStmt[eStmt];
  191864. sqlite3_reset(*ppStmt);
  191865. return rc;
  191866. }
  191867. static int fts5ExecPrintf(
  191868. sqlite3 *db,
  191869. char **pzErr,
  191870. const char *zFormat,
  191871. ...
  191872. ){
  191873. int rc;
  191874. va_list ap; /* ... printf arguments */
  191875. char *zSql;
  191876. va_start(ap, zFormat);
  191877. zSql = sqlite3_vmprintf(zFormat, ap);
  191878. if( zSql==0 ){
  191879. rc = SQLITE_NOMEM;
  191880. }else{
  191881. rc = sqlite3_exec(db, zSql, 0, 0, pzErr);
  191882. sqlite3_free(zSql);
  191883. }
  191884. va_end(ap);
  191885. return rc;
  191886. }
  191887. /*
  191888. ** Drop all shadow tables. Return SQLITE_OK if successful or an SQLite error
  191889. ** code otherwise.
  191890. */
  191891. static int sqlite3Fts5DropAll(Fts5Config *pConfig){
  191892. int rc = fts5ExecPrintf(pConfig->db, 0,
  191893. "DROP TABLE IF EXISTS %Q.'%q_data';"
  191894. "DROP TABLE IF EXISTS %Q.'%q_idx';"
  191895. "DROP TABLE IF EXISTS %Q.'%q_config';",
  191896. pConfig->zDb, pConfig->zName,
  191897. pConfig->zDb, pConfig->zName,
  191898. pConfig->zDb, pConfig->zName
  191899. );
  191900. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  191901. rc = fts5ExecPrintf(pConfig->db, 0,
  191902. "DROP TABLE IF EXISTS %Q.'%q_docsize';",
  191903. pConfig->zDb, pConfig->zName
  191904. );
  191905. }
  191906. if( rc==SQLITE_OK && pConfig->eContent==FTS5_CONTENT_NORMAL ){
  191907. rc = fts5ExecPrintf(pConfig->db, 0,
  191908. "DROP TABLE IF EXISTS %Q.'%q_content';",
  191909. pConfig->zDb, pConfig->zName
  191910. );
  191911. }
  191912. return rc;
  191913. }
  191914. static void fts5StorageRenameOne(
  191915. Fts5Config *pConfig, /* Current FTS5 configuration */
  191916. int *pRc, /* IN/OUT: Error code */
  191917. const char *zTail, /* Tail of table name e.g. "data", "config" */
  191918. const char *zName /* New name of FTS5 table */
  191919. ){
  191920. if( *pRc==SQLITE_OK ){
  191921. *pRc = fts5ExecPrintf(pConfig->db, 0,
  191922. "ALTER TABLE %Q.'%q_%s' RENAME TO '%q_%s';",
  191923. pConfig->zDb, pConfig->zName, zTail, zName, zTail
  191924. );
  191925. }
  191926. }
  191927. static int sqlite3Fts5StorageRename(Fts5Storage *pStorage, const char *zName){
  191928. Fts5Config *pConfig = pStorage->pConfig;
  191929. int rc = sqlite3Fts5StorageSync(pStorage);
  191930. fts5StorageRenameOne(pConfig, &rc, "data", zName);
  191931. fts5StorageRenameOne(pConfig, &rc, "idx", zName);
  191932. fts5StorageRenameOne(pConfig, &rc, "config", zName);
  191933. if( pConfig->bColumnsize ){
  191934. fts5StorageRenameOne(pConfig, &rc, "docsize", zName);
  191935. }
  191936. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  191937. fts5StorageRenameOne(pConfig, &rc, "content", zName);
  191938. }
  191939. return rc;
  191940. }
  191941. /*
  191942. ** Create the shadow table named zPost, with definition zDefn. Return
  191943. ** SQLITE_OK if successful, or an SQLite error code otherwise.
  191944. */
  191945. static int sqlite3Fts5CreateTable(
  191946. Fts5Config *pConfig, /* FTS5 configuration */
  191947. const char *zPost, /* Shadow table to create (e.g. "content") */
  191948. const char *zDefn, /* Columns etc. for shadow table */
  191949. int bWithout, /* True for without rowid */
  191950. char **pzErr /* OUT: Error message */
  191951. ){
  191952. int rc;
  191953. char *zErr = 0;
  191954. rc = fts5ExecPrintf(pConfig->db, &zErr, "CREATE TABLE %Q.'%q_%q'(%s)%s",
  191955. pConfig->zDb, pConfig->zName, zPost, zDefn,
  191956. #ifndef SQLITE_FTS5_NO_WITHOUT_ROWID
  191957. bWithout?" WITHOUT ROWID":
  191958. #endif
  191959. ""
  191960. );
  191961. if( zErr ){
  191962. *pzErr = sqlite3_mprintf(
  191963. "fts5: error creating shadow table %q_%s: %s",
  191964. pConfig->zName, zPost, zErr
  191965. );
  191966. sqlite3_free(zErr);
  191967. }
  191968. return rc;
  191969. }
  191970. /*
  191971. ** Open a new Fts5Index handle. If the bCreate argument is true, create
  191972. ** and initialize the underlying tables
  191973. **
  191974. ** If successful, set *pp to point to the new object and return SQLITE_OK.
  191975. ** Otherwise, set *pp to NULL and return an SQLite error code.
  191976. */
  191977. static int sqlite3Fts5StorageOpen(
  191978. Fts5Config *pConfig,
  191979. Fts5Index *pIndex,
  191980. int bCreate,
  191981. Fts5Storage **pp,
  191982. char **pzErr /* OUT: Error message */
  191983. ){
  191984. int rc = SQLITE_OK;
  191985. Fts5Storage *p; /* New object */
  191986. int nByte; /* Bytes of space to allocate */
  191987. nByte = sizeof(Fts5Storage) /* Fts5Storage object */
  191988. + pConfig->nCol * sizeof(i64); /* Fts5Storage.aTotalSize[] */
  191989. *pp = p = (Fts5Storage*)sqlite3_malloc(nByte);
  191990. if( !p ) return SQLITE_NOMEM;
  191991. memset(p, 0, nByte);
  191992. p->aTotalSize = (i64*)&p[1];
  191993. p->pConfig = pConfig;
  191994. p->pIndex = pIndex;
  191995. if( bCreate ){
  191996. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  191997. int nDefn = 32 + pConfig->nCol*10;
  191998. char *zDefn = sqlite3_malloc(32 + pConfig->nCol * 10);
  191999. if( zDefn==0 ){
  192000. rc = SQLITE_NOMEM;
  192001. }else{
  192002. int i;
  192003. int iOff;
  192004. sqlite3_snprintf(nDefn, zDefn, "id INTEGER PRIMARY KEY");
  192005. iOff = (int)strlen(zDefn);
  192006. for(i=0; i<pConfig->nCol; i++){
  192007. sqlite3_snprintf(nDefn-iOff, &zDefn[iOff], ", c%d", i);
  192008. iOff += (int)strlen(&zDefn[iOff]);
  192009. }
  192010. rc = sqlite3Fts5CreateTable(pConfig, "content", zDefn, 0, pzErr);
  192011. }
  192012. sqlite3_free(zDefn);
  192013. }
  192014. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  192015. rc = sqlite3Fts5CreateTable(
  192016. pConfig, "docsize", "id INTEGER PRIMARY KEY, sz BLOB", 0, pzErr
  192017. );
  192018. }
  192019. if( rc==SQLITE_OK ){
  192020. rc = sqlite3Fts5CreateTable(
  192021. pConfig, "config", "k PRIMARY KEY, v", 1, pzErr
  192022. );
  192023. }
  192024. if( rc==SQLITE_OK ){
  192025. rc = sqlite3Fts5StorageConfigValue(p, "version", 0, FTS5_CURRENT_VERSION);
  192026. }
  192027. }
  192028. if( rc ){
  192029. sqlite3Fts5StorageClose(p);
  192030. *pp = 0;
  192031. }
  192032. return rc;
  192033. }
  192034. /*
  192035. ** Close a handle opened by an earlier call to sqlite3Fts5StorageOpen().
  192036. */
  192037. static int sqlite3Fts5StorageClose(Fts5Storage *p){
  192038. int rc = SQLITE_OK;
  192039. if( p ){
  192040. int i;
  192041. /* Finalize all SQL statements */
  192042. for(i=0; i<ArraySize(p->aStmt); i++){
  192043. sqlite3_finalize(p->aStmt[i]);
  192044. }
  192045. sqlite3_free(p);
  192046. }
  192047. return rc;
  192048. }
  192049. typedef struct Fts5InsertCtx Fts5InsertCtx;
  192050. struct Fts5InsertCtx {
  192051. Fts5Storage *pStorage;
  192052. int iCol;
  192053. int szCol; /* Size of column value in tokens */
  192054. };
  192055. /*
  192056. ** Tokenization callback used when inserting tokens into the FTS index.
  192057. */
  192058. static int fts5StorageInsertCallback(
  192059. void *pContext, /* Pointer to Fts5InsertCtx object */
  192060. int tflags,
  192061. const char *pToken, /* Buffer containing token */
  192062. int nToken, /* Size of token in bytes */
  192063. int iUnused1, /* Start offset of token */
  192064. int iUnused2 /* End offset of token */
  192065. ){
  192066. Fts5InsertCtx *pCtx = (Fts5InsertCtx*)pContext;
  192067. Fts5Index *pIdx = pCtx->pStorage->pIndex;
  192068. UNUSED_PARAM2(iUnused1, iUnused2);
  192069. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  192070. if( (tflags & FTS5_TOKEN_COLOCATED)==0 || pCtx->szCol==0 ){
  192071. pCtx->szCol++;
  192072. }
  192073. return sqlite3Fts5IndexWrite(pIdx, pCtx->iCol, pCtx->szCol-1, pToken, nToken);
  192074. }
  192075. /*
  192076. ** If a row with rowid iDel is present in the %_content table, add the
  192077. ** delete-markers to the FTS index necessary to delete it. Do not actually
  192078. ** remove the %_content row at this time though.
  192079. */
  192080. static int fts5StorageDeleteFromIndex(
  192081. Fts5Storage *p,
  192082. i64 iDel,
  192083. sqlite3_value **apVal
  192084. ){
  192085. Fts5Config *pConfig = p->pConfig;
  192086. sqlite3_stmt *pSeek = 0; /* SELECT to read row iDel from %_data */
  192087. int rc; /* Return code */
  192088. int rc2; /* sqlite3_reset() return code */
  192089. int iCol;
  192090. Fts5InsertCtx ctx;
  192091. if( apVal==0 ){
  192092. rc = fts5StorageGetStmt(p, FTS5_STMT_LOOKUP, &pSeek, 0);
  192093. if( rc!=SQLITE_OK ) return rc;
  192094. sqlite3_bind_int64(pSeek, 1, iDel);
  192095. if( sqlite3_step(pSeek)!=SQLITE_ROW ){
  192096. return sqlite3_reset(pSeek);
  192097. }
  192098. }
  192099. ctx.pStorage = p;
  192100. ctx.iCol = -1;
  192101. rc = sqlite3Fts5IndexBeginWrite(p->pIndex, 1, iDel);
  192102. for(iCol=1; rc==SQLITE_OK && iCol<=pConfig->nCol; iCol++){
  192103. if( pConfig->abUnindexed[iCol-1]==0 ){
  192104. const char *zText;
  192105. int nText;
  192106. if( pSeek ){
  192107. zText = (const char*)sqlite3_column_text(pSeek, iCol);
  192108. nText = sqlite3_column_bytes(pSeek, iCol);
  192109. }else{
  192110. zText = (const char*)sqlite3_value_text(apVal[iCol-1]);
  192111. nText = sqlite3_value_bytes(apVal[iCol-1]);
  192112. }
  192113. ctx.szCol = 0;
  192114. rc = sqlite3Fts5Tokenize(pConfig, FTS5_TOKENIZE_DOCUMENT,
  192115. zText, nText, (void*)&ctx, fts5StorageInsertCallback
  192116. );
  192117. p->aTotalSize[iCol-1] -= (i64)ctx.szCol;
  192118. }
  192119. }
  192120. p->nTotalRow--;
  192121. rc2 = sqlite3_reset(pSeek);
  192122. if( rc==SQLITE_OK ) rc = rc2;
  192123. return rc;
  192124. }
  192125. /*
  192126. ** Insert a record into the %_docsize table. Specifically, do:
  192127. **
  192128. ** INSERT OR REPLACE INTO %_docsize(id, sz) VALUES(iRowid, pBuf);
  192129. **
  192130. ** If there is no %_docsize table (as happens if the columnsize=0 option
  192131. ** is specified when the FTS5 table is created), this function is a no-op.
  192132. */
  192133. static int fts5StorageInsertDocsize(
  192134. Fts5Storage *p, /* Storage module to write to */
  192135. i64 iRowid, /* id value */
  192136. Fts5Buffer *pBuf /* sz value */
  192137. ){
  192138. int rc = SQLITE_OK;
  192139. if( p->pConfig->bColumnsize ){
  192140. sqlite3_stmt *pReplace = 0;
  192141. rc = fts5StorageGetStmt(p, FTS5_STMT_REPLACE_DOCSIZE, &pReplace, 0);
  192142. if( rc==SQLITE_OK ){
  192143. sqlite3_bind_int64(pReplace, 1, iRowid);
  192144. sqlite3_bind_blob(pReplace, 2, pBuf->p, pBuf->n, SQLITE_STATIC);
  192145. sqlite3_step(pReplace);
  192146. rc = sqlite3_reset(pReplace);
  192147. sqlite3_bind_null(pReplace, 2);
  192148. }
  192149. }
  192150. return rc;
  192151. }
  192152. /*
  192153. ** Load the contents of the "averages" record from disk into the
  192154. ** p->nTotalRow and p->aTotalSize[] variables. If successful, and if
  192155. ** argument bCache is true, set the p->bTotalsValid flag to indicate
  192156. ** that the contents of aTotalSize[] and nTotalRow are valid until
  192157. ** further notice.
  192158. **
  192159. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  192160. ** occurs.
  192161. */
  192162. static int fts5StorageLoadTotals(Fts5Storage *p, int bCache){
  192163. int rc = SQLITE_OK;
  192164. if( p->bTotalsValid==0 ){
  192165. rc = sqlite3Fts5IndexGetAverages(p->pIndex, &p->nTotalRow, p->aTotalSize);
  192166. p->bTotalsValid = bCache;
  192167. }
  192168. return rc;
  192169. }
  192170. /*
  192171. ** Store the current contents of the p->nTotalRow and p->aTotalSize[]
  192172. ** variables in the "averages" record on disk.
  192173. **
  192174. ** Return SQLITE_OK if successful, or an SQLite error code if an error
  192175. ** occurs.
  192176. */
  192177. static int fts5StorageSaveTotals(Fts5Storage *p){
  192178. int nCol = p->pConfig->nCol;
  192179. int i;
  192180. Fts5Buffer buf;
  192181. int rc = SQLITE_OK;
  192182. memset(&buf, 0, sizeof(buf));
  192183. sqlite3Fts5BufferAppendVarint(&rc, &buf, p->nTotalRow);
  192184. for(i=0; i<nCol; i++){
  192185. sqlite3Fts5BufferAppendVarint(&rc, &buf, p->aTotalSize[i]);
  192186. }
  192187. if( rc==SQLITE_OK ){
  192188. rc = sqlite3Fts5IndexSetAverages(p->pIndex, buf.p, buf.n);
  192189. }
  192190. sqlite3_free(buf.p);
  192191. return rc;
  192192. }
  192193. /*
  192194. ** Remove a row from the FTS table.
  192195. */
  192196. static int sqlite3Fts5StorageDelete(Fts5Storage *p, i64 iDel, sqlite3_value **apVal){
  192197. Fts5Config *pConfig = p->pConfig;
  192198. int rc;
  192199. sqlite3_stmt *pDel = 0;
  192200. assert( pConfig->eContent!=FTS5_CONTENT_NORMAL || apVal==0 );
  192201. rc = fts5StorageLoadTotals(p, 1);
  192202. /* Delete the index records */
  192203. if( rc==SQLITE_OK ){
  192204. rc = fts5StorageDeleteFromIndex(p, iDel, apVal);
  192205. }
  192206. /* Delete the %_docsize record */
  192207. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  192208. rc = fts5StorageGetStmt(p, FTS5_STMT_DELETE_DOCSIZE, &pDel, 0);
  192209. if( rc==SQLITE_OK ){
  192210. sqlite3_bind_int64(pDel, 1, iDel);
  192211. sqlite3_step(pDel);
  192212. rc = sqlite3_reset(pDel);
  192213. }
  192214. }
  192215. /* Delete the %_content record */
  192216. if( pConfig->eContent==FTS5_CONTENT_NORMAL ){
  192217. if( rc==SQLITE_OK ){
  192218. rc = fts5StorageGetStmt(p, FTS5_STMT_DELETE_CONTENT, &pDel, 0);
  192219. }
  192220. if( rc==SQLITE_OK ){
  192221. sqlite3_bind_int64(pDel, 1, iDel);
  192222. sqlite3_step(pDel);
  192223. rc = sqlite3_reset(pDel);
  192224. }
  192225. }
  192226. return rc;
  192227. }
  192228. /*
  192229. ** Delete all entries in the FTS5 index.
  192230. */
  192231. static int sqlite3Fts5StorageDeleteAll(Fts5Storage *p){
  192232. Fts5Config *pConfig = p->pConfig;
  192233. int rc;
  192234. /* Delete the contents of the %_data and %_docsize tables. */
  192235. rc = fts5ExecPrintf(pConfig->db, 0,
  192236. "DELETE FROM %Q.'%q_data';"
  192237. "DELETE FROM %Q.'%q_idx';",
  192238. pConfig->zDb, pConfig->zName,
  192239. pConfig->zDb, pConfig->zName
  192240. );
  192241. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  192242. rc = fts5ExecPrintf(pConfig->db, 0,
  192243. "DELETE FROM %Q.'%q_docsize';",
  192244. pConfig->zDb, pConfig->zName
  192245. );
  192246. }
  192247. /* Reinitialize the %_data table. This call creates the initial structure
  192248. ** and averages records. */
  192249. if( rc==SQLITE_OK ){
  192250. rc = sqlite3Fts5IndexReinit(p->pIndex);
  192251. }
  192252. if( rc==SQLITE_OK ){
  192253. rc = sqlite3Fts5StorageConfigValue(p, "version", 0, FTS5_CURRENT_VERSION);
  192254. }
  192255. return rc;
  192256. }
  192257. static int sqlite3Fts5StorageRebuild(Fts5Storage *p){
  192258. Fts5Buffer buf = {0,0,0};
  192259. Fts5Config *pConfig = p->pConfig;
  192260. sqlite3_stmt *pScan = 0;
  192261. Fts5InsertCtx ctx;
  192262. int rc;
  192263. memset(&ctx, 0, sizeof(Fts5InsertCtx));
  192264. ctx.pStorage = p;
  192265. rc = sqlite3Fts5StorageDeleteAll(p);
  192266. if( rc==SQLITE_OK ){
  192267. rc = fts5StorageLoadTotals(p, 1);
  192268. }
  192269. if( rc==SQLITE_OK ){
  192270. rc = fts5StorageGetStmt(p, FTS5_STMT_SCAN, &pScan, 0);
  192271. }
  192272. while( rc==SQLITE_OK && SQLITE_ROW==sqlite3_step(pScan) ){
  192273. i64 iRowid = sqlite3_column_int64(pScan, 0);
  192274. sqlite3Fts5BufferZero(&buf);
  192275. rc = sqlite3Fts5IndexBeginWrite(p->pIndex, 0, iRowid);
  192276. for(ctx.iCol=0; rc==SQLITE_OK && ctx.iCol<pConfig->nCol; ctx.iCol++){
  192277. ctx.szCol = 0;
  192278. if( pConfig->abUnindexed[ctx.iCol]==0 ){
  192279. rc = sqlite3Fts5Tokenize(pConfig,
  192280. FTS5_TOKENIZE_DOCUMENT,
  192281. (const char*)sqlite3_column_text(pScan, ctx.iCol+1),
  192282. sqlite3_column_bytes(pScan, ctx.iCol+1),
  192283. (void*)&ctx,
  192284. fts5StorageInsertCallback
  192285. );
  192286. }
  192287. sqlite3Fts5BufferAppendVarint(&rc, &buf, ctx.szCol);
  192288. p->aTotalSize[ctx.iCol] += (i64)ctx.szCol;
  192289. }
  192290. p->nTotalRow++;
  192291. if( rc==SQLITE_OK ){
  192292. rc = fts5StorageInsertDocsize(p, iRowid, &buf);
  192293. }
  192294. }
  192295. sqlite3_free(buf.p);
  192296. /* Write the averages record */
  192297. if( rc==SQLITE_OK ){
  192298. rc = fts5StorageSaveTotals(p);
  192299. }
  192300. return rc;
  192301. }
  192302. static int sqlite3Fts5StorageOptimize(Fts5Storage *p){
  192303. return sqlite3Fts5IndexOptimize(p->pIndex);
  192304. }
  192305. static int sqlite3Fts5StorageMerge(Fts5Storage *p, int nMerge){
  192306. return sqlite3Fts5IndexMerge(p->pIndex, nMerge);
  192307. }
  192308. static int sqlite3Fts5StorageReset(Fts5Storage *p){
  192309. return sqlite3Fts5IndexReset(p->pIndex);
  192310. }
  192311. /*
  192312. ** Allocate a new rowid. This is used for "external content" tables when
  192313. ** a NULL value is inserted into the rowid column. The new rowid is allocated
  192314. ** by inserting a dummy row into the %_docsize table. The dummy will be
  192315. ** overwritten later.
  192316. **
  192317. ** If the %_docsize table does not exist, SQLITE_MISMATCH is returned. In
  192318. ** this case the user is required to provide a rowid explicitly.
  192319. */
  192320. static int fts5StorageNewRowid(Fts5Storage *p, i64 *piRowid){
  192321. int rc = SQLITE_MISMATCH;
  192322. if( p->pConfig->bColumnsize ){
  192323. sqlite3_stmt *pReplace = 0;
  192324. rc = fts5StorageGetStmt(p, FTS5_STMT_REPLACE_DOCSIZE, &pReplace, 0);
  192325. if( rc==SQLITE_OK ){
  192326. sqlite3_bind_null(pReplace, 1);
  192327. sqlite3_bind_null(pReplace, 2);
  192328. sqlite3_step(pReplace);
  192329. rc = sqlite3_reset(pReplace);
  192330. }
  192331. if( rc==SQLITE_OK ){
  192332. *piRowid = sqlite3_last_insert_rowid(p->pConfig->db);
  192333. }
  192334. }
  192335. return rc;
  192336. }
  192337. /*
  192338. ** Insert a new row into the FTS content table.
  192339. */
  192340. static int sqlite3Fts5StorageContentInsert(
  192341. Fts5Storage *p,
  192342. sqlite3_value **apVal,
  192343. i64 *piRowid
  192344. ){
  192345. Fts5Config *pConfig = p->pConfig;
  192346. int rc = SQLITE_OK;
  192347. /* Insert the new row into the %_content table. */
  192348. if( pConfig->eContent!=FTS5_CONTENT_NORMAL ){
  192349. if( sqlite3_value_type(apVal[1])==SQLITE_INTEGER ){
  192350. *piRowid = sqlite3_value_int64(apVal[1]);
  192351. }else{
  192352. rc = fts5StorageNewRowid(p, piRowid);
  192353. }
  192354. }else{
  192355. sqlite3_stmt *pInsert = 0; /* Statement to write %_content table */
  192356. int i; /* Counter variable */
  192357. rc = fts5StorageGetStmt(p, FTS5_STMT_INSERT_CONTENT, &pInsert, 0);
  192358. for(i=1; rc==SQLITE_OK && i<=pConfig->nCol+1; i++){
  192359. rc = sqlite3_bind_value(pInsert, i, apVal[i]);
  192360. }
  192361. if( rc==SQLITE_OK ){
  192362. sqlite3_step(pInsert);
  192363. rc = sqlite3_reset(pInsert);
  192364. }
  192365. *piRowid = sqlite3_last_insert_rowid(pConfig->db);
  192366. }
  192367. return rc;
  192368. }
  192369. /*
  192370. ** Insert new entries into the FTS index and %_docsize table.
  192371. */
  192372. static int sqlite3Fts5StorageIndexInsert(
  192373. Fts5Storage *p,
  192374. sqlite3_value **apVal,
  192375. i64 iRowid
  192376. ){
  192377. Fts5Config *pConfig = p->pConfig;
  192378. int rc = SQLITE_OK; /* Return code */
  192379. Fts5InsertCtx ctx; /* Tokenization callback context object */
  192380. Fts5Buffer buf; /* Buffer used to build up %_docsize blob */
  192381. memset(&buf, 0, sizeof(Fts5Buffer));
  192382. ctx.pStorage = p;
  192383. rc = fts5StorageLoadTotals(p, 1);
  192384. if( rc==SQLITE_OK ){
  192385. rc = sqlite3Fts5IndexBeginWrite(p->pIndex, 0, iRowid);
  192386. }
  192387. for(ctx.iCol=0; rc==SQLITE_OK && ctx.iCol<pConfig->nCol; ctx.iCol++){
  192388. ctx.szCol = 0;
  192389. if( pConfig->abUnindexed[ctx.iCol]==0 ){
  192390. rc = sqlite3Fts5Tokenize(pConfig,
  192391. FTS5_TOKENIZE_DOCUMENT,
  192392. (const char*)sqlite3_value_text(apVal[ctx.iCol+2]),
  192393. sqlite3_value_bytes(apVal[ctx.iCol+2]),
  192394. (void*)&ctx,
  192395. fts5StorageInsertCallback
  192396. );
  192397. }
  192398. sqlite3Fts5BufferAppendVarint(&rc, &buf, ctx.szCol);
  192399. p->aTotalSize[ctx.iCol] += (i64)ctx.szCol;
  192400. }
  192401. p->nTotalRow++;
  192402. /* Write the %_docsize record */
  192403. if( rc==SQLITE_OK ){
  192404. rc = fts5StorageInsertDocsize(p, iRowid, &buf);
  192405. }
  192406. sqlite3_free(buf.p);
  192407. return rc;
  192408. }
  192409. static int fts5StorageCount(Fts5Storage *p, const char *zSuffix, i64 *pnRow){
  192410. Fts5Config *pConfig = p->pConfig;
  192411. char *zSql;
  192412. int rc;
  192413. zSql = sqlite3_mprintf("SELECT count(*) FROM %Q.'%q_%s'",
  192414. pConfig->zDb, pConfig->zName, zSuffix
  192415. );
  192416. if( zSql==0 ){
  192417. rc = SQLITE_NOMEM;
  192418. }else{
  192419. sqlite3_stmt *pCnt = 0;
  192420. rc = sqlite3_prepare_v2(pConfig->db, zSql, -1, &pCnt, 0);
  192421. if( rc==SQLITE_OK ){
  192422. if( SQLITE_ROW==sqlite3_step(pCnt) ){
  192423. *pnRow = sqlite3_column_int64(pCnt, 0);
  192424. }
  192425. rc = sqlite3_finalize(pCnt);
  192426. }
  192427. }
  192428. sqlite3_free(zSql);
  192429. return rc;
  192430. }
  192431. /*
  192432. ** Context object used by sqlite3Fts5StorageIntegrity().
  192433. */
  192434. typedef struct Fts5IntegrityCtx Fts5IntegrityCtx;
  192435. struct Fts5IntegrityCtx {
  192436. i64 iRowid;
  192437. int iCol;
  192438. int szCol;
  192439. u64 cksum;
  192440. Fts5Termset *pTermset;
  192441. Fts5Config *pConfig;
  192442. };
  192443. /*
  192444. ** Tokenization callback used by integrity check.
  192445. */
  192446. static int fts5StorageIntegrityCallback(
  192447. void *pContext, /* Pointer to Fts5IntegrityCtx object */
  192448. int tflags,
  192449. const char *pToken, /* Buffer containing token */
  192450. int nToken, /* Size of token in bytes */
  192451. int iUnused1, /* Start offset of token */
  192452. int iUnused2 /* End offset of token */
  192453. ){
  192454. Fts5IntegrityCtx *pCtx = (Fts5IntegrityCtx*)pContext;
  192455. Fts5Termset *pTermset = pCtx->pTermset;
  192456. int bPresent;
  192457. int ii;
  192458. int rc = SQLITE_OK;
  192459. int iPos;
  192460. int iCol;
  192461. UNUSED_PARAM2(iUnused1, iUnused2);
  192462. if( nToken>FTS5_MAX_TOKEN_SIZE ) nToken = FTS5_MAX_TOKEN_SIZE;
  192463. if( (tflags & FTS5_TOKEN_COLOCATED)==0 || pCtx->szCol==0 ){
  192464. pCtx->szCol++;
  192465. }
  192466. switch( pCtx->pConfig->eDetail ){
  192467. case FTS5_DETAIL_FULL:
  192468. iPos = pCtx->szCol-1;
  192469. iCol = pCtx->iCol;
  192470. break;
  192471. case FTS5_DETAIL_COLUMNS:
  192472. iPos = pCtx->iCol;
  192473. iCol = 0;
  192474. break;
  192475. default:
  192476. assert( pCtx->pConfig->eDetail==FTS5_DETAIL_NONE );
  192477. iPos = 0;
  192478. iCol = 0;
  192479. break;
  192480. }
  192481. rc = sqlite3Fts5TermsetAdd(pTermset, 0, pToken, nToken, &bPresent);
  192482. if( rc==SQLITE_OK && bPresent==0 ){
  192483. pCtx->cksum ^= sqlite3Fts5IndexEntryCksum(
  192484. pCtx->iRowid, iCol, iPos, 0, pToken, nToken
  192485. );
  192486. }
  192487. for(ii=0; rc==SQLITE_OK && ii<pCtx->pConfig->nPrefix; ii++){
  192488. const int nChar = pCtx->pConfig->aPrefix[ii];
  192489. int nByte = sqlite3Fts5IndexCharlenToBytelen(pToken, nToken, nChar);
  192490. if( nByte ){
  192491. rc = sqlite3Fts5TermsetAdd(pTermset, ii+1, pToken, nByte, &bPresent);
  192492. if( bPresent==0 ){
  192493. pCtx->cksum ^= sqlite3Fts5IndexEntryCksum(
  192494. pCtx->iRowid, iCol, iPos, ii+1, pToken, nByte
  192495. );
  192496. }
  192497. }
  192498. }
  192499. return rc;
  192500. }
  192501. /*
  192502. ** Check that the contents of the FTS index match that of the %_content
  192503. ** table. Return SQLITE_OK if they do, or SQLITE_CORRUPT if not. Return
  192504. ** some other SQLite error code if an error occurs while attempting to
  192505. ** determine this.
  192506. */
  192507. static int sqlite3Fts5StorageIntegrity(Fts5Storage *p){
  192508. Fts5Config *pConfig = p->pConfig;
  192509. int rc; /* Return code */
  192510. int *aColSize; /* Array of size pConfig->nCol */
  192511. i64 *aTotalSize; /* Array of size pConfig->nCol */
  192512. Fts5IntegrityCtx ctx;
  192513. sqlite3_stmt *pScan;
  192514. memset(&ctx, 0, sizeof(Fts5IntegrityCtx));
  192515. ctx.pConfig = p->pConfig;
  192516. aTotalSize = (i64*)sqlite3_malloc(pConfig->nCol * (sizeof(int)+sizeof(i64)));
  192517. if( !aTotalSize ) return SQLITE_NOMEM;
  192518. aColSize = (int*)&aTotalSize[pConfig->nCol];
  192519. memset(aTotalSize, 0, sizeof(i64) * pConfig->nCol);
  192520. /* Generate the expected index checksum based on the contents of the
  192521. ** %_content table. This block stores the checksum in ctx.cksum. */
  192522. rc = fts5StorageGetStmt(p, FTS5_STMT_SCAN, &pScan, 0);
  192523. if( rc==SQLITE_OK ){
  192524. int rc2;
  192525. while( SQLITE_ROW==sqlite3_step(pScan) ){
  192526. int i;
  192527. ctx.iRowid = sqlite3_column_int64(pScan, 0);
  192528. ctx.szCol = 0;
  192529. if( pConfig->bColumnsize ){
  192530. rc = sqlite3Fts5StorageDocsize(p, ctx.iRowid, aColSize);
  192531. }
  192532. if( rc==SQLITE_OK && pConfig->eDetail==FTS5_DETAIL_NONE ){
  192533. rc = sqlite3Fts5TermsetNew(&ctx.pTermset);
  192534. }
  192535. for(i=0; rc==SQLITE_OK && i<pConfig->nCol; i++){
  192536. if( pConfig->abUnindexed[i] ) continue;
  192537. ctx.iCol = i;
  192538. ctx.szCol = 0;
  192539. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  192540. rc = sqlite3Fts5TermsetNew(&ctx.pTermset);
  192541. }
  192542. if( rc==SQLITE_OK ){
  192543. rc = sqlite3Fts5Tokenize(pConfig,
  192544. FTS5_TOKENIZE_DOCUMENT,
  192545. (const char*)sqlite3_column_text(pScan, i+1),
  192546. sqlite3_column_bytes(pScan, i+1),
  192547. (void*)&ctx,
  192548. fts5StorageIntegrityCallback
  192549. );
  192550. }
  192551. if( rc==SQLITE_OK && pConfig->bColumnsize && ctx.szCol!=aColSize[i] ){
  192552. rc = FTS5_CORRUPT;
  192553. }
  192554. aTotalSize[i] += ctx.szCol;
  192555. if( pConfig->eDetail==FTS5_DETAIL_COLUMNS ){
  192556. sqlite3Fts5TermsetFree(ctx.pTermset);
  192557. ctx.pTermset = 0;
  192558. }
  192559. }
  192560. sqlite3Fts5TermsetFree(ctx.pTermset);
  192561. ctx.pTermset = 0;
  192562. if( rc!=SQLITE_OK ) break;
  192563. }
  192564. rc2 = sqlite3_reset(pScan);
  192565. if( rc==SQLITE_OK ) rc = rc2;
  192566. }
  192567. /* Test that the "totals" (sometimes called "averages") record looks Ok */
  192568. if( rc==SQLITE_OK ){
  192569. int i;
  192570. rc = fts5StorageLoadTotals(p, 0);
  192571. for(i=0; rc==SQLITE_OK && i<pConfig->nCol; i++){
  192572. if( p->aTotalSize[i]!=aTotalSize[i] ) rc = FTS5_CORRUPT;
  192573. }
  192574. }
  192575. /* Check that the %_docsize and %_content tables contain the expected
  192576. ** number of rows. */
  192577. if( rc==SQLITE_OK && pConfig->eContent==FTS5_CONTENT_NORMAL ){
  192578. i64 nRow = 0;
  192579. rc = fts5StorageCount(p, "content", &nRow);
  192580. if( rc==SQLITE_OK && nRow!=p->nTotalRow ) rc = FTS5_CORRUPT;
  192581. }
  192582. if( rc==SQLITE_OK && pConfig->bColumnsize ){
  192583. i64 nRow = 0;
  192584. rc = fts5StorageCount(p, "docsize", &nRow);
  192585. if( rc==SQLITE_OK && nRow!=p->nTotalRow ) rc = FTS5_CORRUPT;
  192586. }
  192587. /* Pass the expected checksum down to the FTS index module. It will
  192588. ** verify, amongst other things, that it matches the checksum generated by
  192589. ** inspecting the index itself. */
  192590. if( rc==SQLITE_OK ){
  192591. rc = sqlite3Fts5IndexIntegrityCheck(p->pIndex, ctx.cksum);
  192592. }
  192593. sqlite3_free(aTotalSize);
  192594. return rc;
  192595. }
  192596. /*
  192597. ** Obtain an SQLite statement handle that may be used to read data from the
  192598. ** %_content table.
  192599. */
  192600. static int sqlite3Fts5StorageStmt(
  192601. Fts5Storage *p,
  192602. int eStmt,
  192603. sqlite3_stmt **pp,
  192604. char **pzErrMsg
  192605. ){
  192606. int rc;
  192607. assert( eStmt==FTS5_STMT_SCAN_ASC
  192608. || eStmt==FTS5_STMT_SCAN_DESC
  192609. || eStmt==FTS5_STMT_LOOKUP
  192610. );
  192611. rc = fts5StorageGetStmt(p, eStmt, pp, pzErrMsg);
  192612. if( rc==SQLITE_OK ){
  192613. assert( p->aStmt[eStmt]==*pp );
  192614. p->aStmt[eStmt] = 0;
  192615. }
  192616. return rc;
  192617. }
  192618. /*
  192619. ** Release an SQLite statement handle obtained via an earlier call to
  192620. ** sqlite3Fts5StorageStmt(). The eStmt parameter passed to this function
  192621. ** must match that passed to the sqlite3Fts5StorageStmt() call.
  192622. */
  192623. static void sqlite3Fts5StorageStmtRelease(
  192624. Fts5Storage *p,
  192625. int eStmt,
  192626. sqlite3_stmt *pStmt
  192627. ){
  192628. assert( eStmt==FTS5_STMT_SCAN_ASC
  192629. || eStmt==FTS5_STMT_SCAN_DESC
  192630. || eStmt==FTS5_STMT_LOOKUP
  192631. );
  192632. if( p->aStmt[eStmt]==0 ){
  192633. sqlite3_reset(pStmt);
  192634. p->aStmt[eStmt] = pStmt;
  192635. }else{
  192636. sqlite3_finalize(pStmt);
  192637. }
  192638. }
  192639. static int fts5StorageDecodeSizeArray(
  192640. int *aCol, int nCol, /* Array to populate */
  192641. const u8 *aBlob, int nBlob /* Record to read varints from */
  192642. ){
  192643. int i;
  192644. int iOff = 0;
  192645. for(i=0; i<nCol; i++){
  192646. if( iOff>=nBlob ) return 1;
  192647. iOff += fts5GetVarint32(&aBlob[iOff], aCol[i]);
  192648. }
  192649. return (iOff!=nBlob);
  192650. }
  192651. /*
  192652. ** Argument aCol points to an array of integers containing one entry for
  192653. ** each table column. This function reads the %_docsize record for the
  192654. ** specified rowid and populates aCol[] with the results.
  192655. **
  192656. ** An SQLite error code is returned if an error occurs, or SQLITE_OK
  192657. ** otherwise.
  192658. */
  192659. static int sqlite3Fts5StorageDocsize(Fts5Storage *p, i64 iRowid, int *aCol){
  192660. int nCol = p->pConfig->nCol; /* Number of user columns in table */
  192661. sqlite3_stmt *pLookup = 0; /* Statement to query %_docsize */
  192662. int rc; /* Return Code */
  192663. assert( p->pConfig->bColumnsize );
  192664. rc = fts5StorageGetStmt(p, FTS5_STMT_LOOKUP_DOCSIZE, &pLookup, 0);
  192665. if( rc==SQLITE_OK ){
  192666. int bCorrupt = 1;
  192667. sqlite3_bind_int64(pLookup, 1, iRowid);
  192668. if( SQLITE_ROW==sqlite3_step(pLookup) ){
  192669. const u8 *aBlob = sqlite3_column_blob(pLookup, 0);
  192670. int nBlob = sqlite3_column_bytes(pLookup, 0);
  192671. if( 0==fts5StorageDecodeSizeArray(aCol, nCol, aBlob, nBlob) ){
  192672. bCorrupt = 0;
  192673. }
  192674. }
  192675. rc = sqlite3_reset(pLookup);
  192676. if( bCorrupt && rc==SQLITE_OK ){
  192677. rc = FTS5_CORRUPT;
  192678. }
  192679. }
  192680. return rc;
  192681. }
  192682. static int sqlite3Fts5StorageSize(Fts5Storage *p, int iCol, i64 *pnToken){
  192683. int rc = fts5StorageLoadTotals(p, 0);
  192684. if( rc==SQLITE_OK ){
  192685. *pnToken = 0;
  192686. if( iCol<0 ){
  192687. int i;
  192688. for(i=0; i<p->pConfig->nCol; i++){
  192689. *pnToken += p->aTotalSize[i];
  192690. }
  192691. }else if( iCol<p->pConfig->nCol ){
  192692. *pnToken = p->aTotalSize[iCol];
  192693. }else{
  192694. rc = SQLITE_RANGE;
  192695. }
  192696. }
  192697. return rc;
  192698. }
  192699. static int sqlite3Fts5StorageRowCount(Fts5Storage *p, i64 *pnRow){
  192700. int rc = fts5StorageLoadTotals(p, 0);
  192701. if( rc==SQLITE_OK ){
  192702. *pnRow = p->nTotalRow;
  192703. }
  192704. return rc;
  192705. }
  192706. /*
  192707. ** Flush any data currently held in-memory to disk.
  192708. */
  192709. static int sqlite3Fts5StorageSync(Fts5Storage *p){
  192710. int rc = SQLITE_OK;
  192711. i64 iLastRowid = sqlite3_last_insert_rowid(p->pConfig->db);
  192712. if( p->bTotalsValid ){
  192713. rc = fts5StorageSaveTotals(p);
  192714. p->bTotalsValid = 0;
  192715. }
  192716. if( rc==SQLITE_OK ){
  192717. rc = sqlite3Fts5IndexSync(p->pIndex);
  192718. }
  192719. sqlite3_set_last_insert_rowid(p->pConfig->db, iLastRowid);
  192720. return rc;
  192721. }
  192722. static int sqlite3Fts5StorageRollback(Fts5Storage *p){
  192723. p->bTotalsValid = 0;
  192724. return sqlite3Fts5IndexRollback(p->pIndex);
  192725. }
  192726. static int sqlite3Fts5StorageConfigValue(
  192727. Fts5Storage *p,
  192728. const char *z,
  192729. sqlite3_value *pVal,
  192730. int iVal
  192731. ){
  192732. sqlite3_stmt *pReplace = 0;
  192733. int rc = fts5StorageGetStmt(p, FTS5_STMT_REPLACE_CONFIG, &pReplace, 0);
  192734. if( rc==SQLITE_OK ){
  192735. sqlite3_bind_text(pReplace, 1, z, -1, SQLITE_STATIC);
  192736. if( pVal ){
  192737. sqlite3_bind_value(pReplace, 2, pVal);
  192738. }else{
  192739. sqlite3_bind_int(pReplace, 2, iVal);
  192740. }
  192741. sqlite3_step(pReplace);
  192742. rc = sqlite3_reset(pReplace);
  192743. sqlite3_bind_null(pReplace, 1);
  192744. }
  192745. if( rc==SQLITE_OK && pVal ){
  192746. int iNew = p->pConfig->iCookie + 1;
  192747. rc = sqlite3Fts5IndexSetCookie(p->pIndex, iNew);
  192748. if( rc==SQLITE_OK ){
  192749. p->pConfig->iCookie = iNew;
  192750. }
  192751. }
  192752. return rc;
  192753. }
  192754. /*
  192755. ** 2014 May 31
  192756. **
  192757. ** The author disclaims copyright to this source code. In place of
  192758. ** a legal notice, here is a blessing:
  192759. **
  192760. ** May you do good and not evil.
  192761. ** May you find forgiveness for yourself and forgive others.
  192762. ** May you share freely, never taking more than you give.
  192763. **
  192764. ******************************************************************************
  192765. */
  192766. /* #include "fts5Int.h" */
  192767. /**************************************************************************
  192768. ** Start of ascii tokenizer implementation.
  192769. */
  192770. /*
  192771. ** For tokenizers with no "unicode" modifier, the set of token characters
  192772. ** is the same as the set of ASCII range alphanumeric characters.
  192773. */
  192774. static unsigned char aAsciiTokenChar[128] = {
  192775. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x00..0x0F */
  192776. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x10..0x1F */
  192777. 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x20..0x2F */
  192778. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 0x30..0x3F */
  192779. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x40..0x4F */
  192780. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 0x50..0x5F */
  192781. 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 0x60..0x6F */
  192782. 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 0x70..0x7F */
  192783. };
  192784. typedef struct AsciiTokenizer AsciiTokenizer;
  192785. struct AsciiTokenizer {
  192786. unsigned char aTokenChar[128];
  192787. };
  192788. static void fts5AsciiAddExceptions(
  192789. AsciiTokenizer *p,
  192790. const char *zArg,
  192791. int bTokenChars
  192792. ){
  192793. int i;
  192794. for(i=0; zArg[i]; i++){
  192795. if( (zArg[i] & 0x80)==0 ){
  192796. p->aTokenChar[(int)zArg[i]] = (unsigned char)bTokenChars;
  192797. }
  192798. }
  192799. }
  192800. /*
  192801. ** Delete a "ascii" tokenizer.
  192802. */
  192803. static void fts5AsciiDelete(Fts5Tokenizer *p){
  192804. sqlite3_free(p);
  192805. }
  192806. /*
  192807. ** Create an "ascii" tokenizer.
  192808. */
  192809. static int fts5AsciiCreate(
  192810. void *pUnused,
  192811. const char **azArg, int nArg,
  192812. Fts5Tokenizer **ppOut
  192813. ){
  192814. int rc = SQLITE_OK;
  192815. AsciiTokenizer *p = 0;
  192816. UNUSED_PARAM(pUnused);
  192817. if( nArg%2 ){
  192818. rc = SQLITE_ERROR;
  192819. }else{
  192820. p = sqlite3_malloc(sizeof(AsciiTokenizer));
  192821. if( p==0 ){
  192822. rc = SQLITE_NOMEM;
  192823. }else{
  192824. int i;
  192825. memset(p, 0, sizeof(AsciiTokenizer));
  192826. memcpy(p->aTokenChar, aAsciiTokenChar, sizeof(aAsciiTokenChar));
  192827. for(i=0; rc==SQLITE_OK && i<nArg; i+=2){
  192828. const char *zArg = azArg[i+1];
  192829. if( 0==sqlite3_stricmp(azArg[i], "tokenchars") ){
  192830. fts5AsciiAddExceptions(p, zArg, 1);
  192831. }else
  192832. if( 0==sqlite3_stricmp(azArg[i], "separators") ){
  192833. fts5AsciiAddExceptions(p, zArg, 0);
  192834. }else{
  192835. rc = SQLITE_ERROR;
  192836. }
  192837. }
  192838. if( rc!=SQLITE_OK ){
  192839. fts5AsciiDelete((Fts5Tokenizer*)p);
  192840. p = 0;
  192841. }
  192842. }
  192843. }
  192844. *ppOut = (Fts5Tokenizer*)p;
  192845. return rc;
  192846. }
  192847. static void asciiFold(char *aOut, const char *aIn, int nByte){
  192848. int i;
  192849. for(i=0; i<nByte; i++){
  192850. char c = aIn[i];
  192851. if( c>='A' && c<='Z' ) c += 32;
  192852. aOut[i] = c;
  192853. }
  192854. }
  192855. /*
  192856. ** Tokenize some text using the ascii tokenizer.
  192857. */
  192858. static int fts5AsciiTokenize(
  192859. Fts5Tokenizer *pTokenizer,
  192860. void *pCtx,
  192861. int iUnused,
  192862. const char *pText, int nText,
  192863. int (*xToken)(void*, int, const char*, int nToken, int iStart, int iEnd)
  192864. ){
  192865. AsciiTokenizer *p = (AsciiTokenizer*)pTokenizer;
  192866. int rc = SQLITE_OK;
  192867. int ie;
  192868. int is = 0;
  192869. char aFold[64];
  192870. int nFold = sizeof(aFold);
  192871. char *pFold = aFold;
  192872. unsigned char *a = p->aTokenChar;
  192873. UNUSED_PARAM(iUnused);
  192874. while( is<nText && rc==SQLITE_OK ){
  192875. int nByte;
  192876. /* Skip any leading divider characters. */
  192877. while( is<nText && ((pText[is]&0x80)==0 && a[(int)pText[is]]==0) ){
  192878. is++;
  192879. }
  192880. if( is==nText ) break;
  192881. /* Count the token characters */
  192882. ie = is+1;
  192883. while( ie<nText && ((pText[ie]&0x80) || a[(int)pText[ie]] ) ){
  192884. ie++;
  192885. }
  192886. /* Fold to lower case */
  192887. nByte = ie-is;
  192888. if( nByte>nFold ){
  192889. if( pFold!=aFold ) sqlite3_free(pFold);
  192890. pFold = sqlite3_malloc(nByte*2);
  192891. if( pFold==0 ){
  192892. rc = SQLITE_NOMEM;
  192893. break;
  192894. }
  192895. nFold = nByte*2;
  192896. }
  192897. asciiFold(pFold, &pText[is], nByte);
  192898. /* Invoke the token callback */
  192899. rc = xToken(pCtx, 0, pFold, nByte, is, ie);
  192900. is = ie+1;
  192901. }
  192902. if( pFold!=aFold ) sqlite3_free(pFold);
  192903. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  192904. return rc;
  192905. }
  192906. /**************************************************************************
  192907. ** Start of unicode61 tokenizer implementation.
  192908. */
  192909. /*
  192910. ** The following two macros - READ_UTF8 and WRITE_UTF8 - have been copied
  192911. ** from the sqlite3 source file utf.c. If this file is compiled as part
  192912. ** of the amalgamation, they are not required.
  192913. */
  192914. #ifndef SQLITE_AMALGAMATION
  192915. static const unsigned char sqlite3Utf8Trans1[] = {
  192916. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  192917. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  192918. 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  192919. 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  192920. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  192921. 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
  192922. 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
  192923. 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00,
  192924. };
  192925. #define READ_UTF8(zIn, zTerm, c) \
  192926. c = *(zIn++); \
  192927. if( c>=0xc0 ){ \
  192928. c = sqlite3Utf8Trans1[c-0xc0]; \
  192929. while( zIn!=zTerm && (*zIn & 0xc0)==0x80 ){ \
  192930. c = (c<<6) + (0x3f & *(zIn++)); \
  192931. } \
  192932. if( c<0x80 \
  192933. || (c&0xFFFFF800)==0xD800 \
  192934. || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } \
  192935. }
  192936. #define WRITE_UTF8(zOut, c) { \
  192937. if( c<0x00080 ){ \
  192938. *zOut++ = (unsigned char)(c&0xFF); \
  192939. } \
  192940. else if( c<0x00800 ){ \
  192941. *zOut++ = 0xC0 + (unsigned char)((c>>6)&0x1F); \
  192942. *zOut++ = 0x80 + (unsigned char)(c & 0x3F); \
  192943. } \
  192944. else if( c<0x10000 ){ \
  192945. *zOut++ = 0xE0 + (unsigned char)((c>>12)&0x0F); \
  192946. *zOut++ = 0x80 + (unsigned char)((c>>6) & 0x3F); \
  192947. *zOut++ = 0x80 + (unsigned char)(c & 0x3F); \
  192948. }else{ \
  192949. *zOut++ = 0xF0 + (unsigned char)((c>>18) & 0x07); \
  192950. *zOut++ = 0x80 + (unsigned char)((c>>12) & 0x3F); \
  192951. *zOut++ = 0x80 + (unsigned char)((c>>6) & 0x3F); \
  192952. *zOut++ = 0x80 + (unsigned char)(c & 0x3F); \
  192953. } \
  192954. }
  192955. #endif /* ifndef SQLITE_AMALGAMATION */
  192956. typedef struct Unicode61Tokenizer Unicode61Tokenizer;
  192957. struct Unicode61Tokenizer {
  192958. unsigned char aTokenChar[128]; /* ASCII range token characters */
  192959. char *aFold; /* Buffer to fold text into */
  192960. int nFold; /* Size of aFold[] in bytes */
  192961. int bRemoveDiacritic; /* True if remove_diacritics=1 is set */
  192962. int nException;
  192963. int *aiException;
  192964. };
  192965. static int fts5UnicodeAddExceptions(
  192966. Unicode61Tokenizer *p, /* Tokenizer object */
  192967. const char *z, /* Characters to treat as exceptions */
  192968. int bTokenChars /* 1 for 'tokenchars', 0 for 'separators' */
  192969. ){
  192970. int rc = SQLITE_OK;
  192971. int n = (int)strlen(z);
  192972. int *aNew;
  192973. if( n>0 ){
  192974. aNew = (int*)sqlite3_realloc(p->aiException, (n+p->nException)*sizeof(int));
  192975. if( aNew ){
  192976. int nNew = p->nException;
  192977. const unsigned char *zCsr = (const unsigned char*)z;
  192978. const unsigned char *zTerm = (const unsigned char*)&z[n];
  192979. while( zCsr<zTerm ){
  192980. int iCode;
  192981. int bToken;
  192982. READ_UTF8(zCsr, zTerm, iCode);
  192983. if( iCode<128 ){
  192984. p->aTokenChar[iCode] = (unsigned char)bTokenChars;
  192985. }else{
  192986. bToken = sqlite3Fts5UnicodeIsalnum(iCode);
  192987. assert( (bToken==0 || bToken==1) );
  192988. assert( (bTokenChars==0 || bTokenChars==1) );
  192989. if( bToken!=bTokenChars && sqlite3Fts5UnicodeIsdiacritic(iCode)==0 ){
  192990. int i;
  192991. for(i=0; i<nNew; i++){
  192992. if( aNew[i]>iCode ) break;
  192993. }
  192994. memmove(&aNew[i+1], &aNew[i], (nNew-i)*sizeof(int));
  192995. aNew[i] = iCode;
  192996. nNew++;
  192997. }
  192998. }
  192999. }
  193000. p->aiException = aNew;
  193001. p->nException = nNew;
  193002. }else{
  193003. rc = SQLITE_NOMEM;
  193004. }
  193005. }
  193006. return rc;
  193007. }
  193008. /*
  193009. ** Return true if the p->aiException[] array contains the value iCode.
  193010. */
  193011. static int fts5UnicodeIsException(Unicode61Tokenizer *p, int iCode){
  193012. if( p->nException>0 ){
  193013. int *a = p->aiException;
  193014. int iLo = 0;
  193015. int iHi = p->nException-1;
  193016. while( iHi>=iLo ){
  193017. int iTest = (iHi + iLo) / 2;
  193018. if( iCode==a[iTest] ){
  193019. return 1;
  193020. }else if( iCode>a[iTest] ){
  193021. iLo = iTest+1;
  193022. }else{
  193023. iHi = iTest-1;
  193024. }
  193025. }
  193026. }
  193027. return 0;
  193028. }
  193029. /*
  193030. ** Delete a "unicode61" tokenizer.
  193031. */
  193032. static void fts5UnicodeDelete(Fts5Tokenizer *pTok){
  193033. if( pTok ){
  193034. Unicode61Tokenizer *p = (Unicode61Tokenizer*)pTok;
  193035. sqlite3_free(p->aiException);
  193036. sqlite3_free(p->aFold);
  193037. sqlite3_free(p);
  193038. }
  193039. return;
  193040. }
  193041. /*
  193042. ** Create a "unicode61" tokenizer.
  193043. */
  193044. static int fts5UnicodeCreate(
  193045. void *pUnused,
  193046. const char **azArg, int nArg,
  193047. Fts5Tokenizer **ppOut
  193048. ){
  193049. int rc = SQLITE_OK; /* Return code */
  193050. Unicode61Tokenizer *p = 0; /* New tokenizer object */
  193051. UNUSED_PARAM(pUnused);
  193052. if( nArg%2 ){
  193053. rc = SQLITE_ERROR;
  193054. }else{
  193055. p = (Unicode61Tokenizer*)sqlite3_malloc(sizeof(Unicode61Tokenizer));
  193056. if( p ){
  193057. int i;
  193058. memset(p, 0, sizeof(Unicode61Tokenizer));
  193059. memcpy(p->aTokenChar, aAsciiTokenChar, sizeof(aAsciiTokenChar));
  193060. p->bRemoveDiacritic = 1;
  193061. p->nFold = 64;
  193062. p->aFold = sqlite3_malloc(p->nFold * sizeof(char));
  193063. if( p->aFold==0 ){
  193064. rc = SQLITE_NOMEM;
  193065. }
  193066. for(i=0; rc==SQLITE_OK && i<nArg; i+=2){
  193067. const char *zArg = azArg[i+1];
  193068. if( 0==sqlite3_stricmp(azArg[i], "remove_diacritics") ){
  193069. if( (zArg[0]!='0' && zArg[0]!='1') || zArg[1] ){
  193070. rc = SQLITE_ERROR;
  193071. }
  193072. p->bRemoveDiacritic = (zArg[0]=='1');
  193073. }else
  193074. if( 0==sqlite3_stricmp(azArg[i], "tokenchars") ){
  193075. rc = fts5UnicodeAddExceptions(p, zArg, 1);
  193076. }else
  193077. if( 0==sqlite3_stricmp(azArg[i], "separators") ){
  193078. rc = fts5UnicodeAddExceptions(p, zArg, 0);
  193079. }else{
  193080. rc = SQLITE_ERROR;
  193081. }
  193082. }
  193083. }else{
  193084. rc = SQLITE_NOMEM;
  193085. }
  193086. if( rc!=SQLITE_OK ){
  193087. fts5UnicodeDelete((Fts5Tokenizer*)p);
  193088. p = 0;
  193089. }
  193090. *ppOut = (Fts5Tokenizer*)p;
  193091. }
  193092. return rc;
  193093. }
  193094. /*
  193095. ** Return true if, for the purposes of tokenizing with the tokenizer
  193096. ** passed as the first argument, codepoint iCode is considered a token
  193097. ** character (not a separator).
  193098. */
  193099. static int fts5UnicodeIsAlnum(Unicode61Tokenizer *p, int iCode){
  193100. assert( (sqlite3Fts5UnicodeIsalnum(iCode) & 0xFFFFFFFE)==0 );
  193101. return sqlite3Fts5UnicodeIsalnum(iCode) ^ fts5UnicodeIsException(p, iCode);
  193102. }
  193103. static int fts5UnicodeTokenize(
  193104. Fts5Tokenizer *pTokenizer,
  193105. void *pCtx,
  193106. int iUnused,
  193107. const char *pText, int nText,
  193108. int (*xToken)(void*, int, const char*, int nToken, int iStart, int iEnd)
  193109. ){
  193110. Unicode61Tokenizer *p = (Unicode61Tokenizer*)pTokenizer;
  193111. int rc = SQLITE_OK;
  193112. unsigned char *a = p->aTokenChar;
  193113. unsigned char *zTerm = (unsigned char*)&pText[nText];
  193114. unsigned char *zCsr = (unsigned char *)pText;
  193115. /* Output buffer */
  193116. char *aFold = p->aFold;
  193117. int nFold = p->nFold;
  193118. const char *pEnd = &aFold[nFold-6];
  193119. UNUSED_PARAM(iUnused);
  193120. /* Each iteration of this loop gobbles up a contiguous run of separators,
  193121. ** then the next token. */
  193122. while( rc==SQLITE_OK ){
  193123. int iCode; /* non-ASCII codepoint read from input */
  193124. char *zOut = aFold;
  193125. int is;
  193126. int ie;
  193127. /* Skip any separator characters. */
  193128. while( 1 ){
  193129. if( zCsr>=zTerm ) goto tokenize_done;
  193130. if( *zCsr & 0x80 ) {
  193131. /* A character outside of the ascii range. Skip past it if it is
  193132. ** a separator character. Or break out of the loop if it is not. */
  193133. is = zCsr - (unsigned char*)pText;
  193134. READ_UTF8(zCsr, zTerm, iCode);
  193135. if( fts5UnicodeIsAlnum(p, iCode) ){
  193136. goto non_ascii_tokenchar;
  193137. }
  193138. }else{
  193139. if( a[*zCsr] ){
  193140. is = zCsr - (unsigned char*)pText;
  193141. goto ascii_tokenchar;
  193142. }
  193143. zCsr++;
  193144. }
  193145. }
  193146. /* Run through the tokenchars. Fold them into the output buffer along
  193147. ** the way. */
  193148. while( zCsr<zTerm ){
  193149. /* Grow the output buffer so that there is sufficient space to fit the
  193150. ** largest possible utf-8 character. */
  193151. if( zOut>pEnd ){
  193152. aFold = sqlite3_malloc(nFold*2);
  193153. if( aFold==0 ){
  193154. rc = SQLITE_NOMEM;
  193155. goto tokenize_done;
  193156. }
  193157. zOut = &aFold[zOut - p->aFold];
  193158. memcpy(aFold, p->aFold, nFold);
  193159. sqlite3_free(p->aFold);
  193160. p->aFold = aFold;
  193161. p->nFold = nFold = nFold*2;
  193162. pEnd = &aFold[nFold-6];
  193163. }
  193164. if( *zCsr & 0x80 ){
  193165. /* An non-ascii-range character. Fold it into the output buffer if
  193166. ** it is a token character, or break out of the loop if it is not. */
  193167. READ_UTF8(zCsr, zTerm, iCode);
  193168. if( fts5UnicodeIsAlnum(p,iCode)||sqlite3Fts5UnicodeIsdiacritic(iCode) ){
  193169. non_ascii_tokenchar:
  193170. iCode = sqlite3Fts5UnicodeFold(iCode, p->bRemoveDiacritic);
  193171. if( iCode ) WRITE_UTF8(zOut, iCode);
  193172. }else{
  193173. break;
  193174. }
  193175. }else if( a[*zCsr]==0 ){
  193176. /* An ascii-range separator character. End of token. */
  193177. break;
  193178. }else{
  193179. ascii_tokenchar:
  193180. if( *zCsr>='A' && *zCsr<='Z' ){
  193181. *zOut++ = *zCsr + 32;
  193182. }else{
  193183. *zOut++ = *zCsr;
  193184. }
  193185. zCsr++;
  193186. }
  193187. ie = zCsr - (unsigned char*)pText;
  193188. }
  193189. /* Invoke the token callback */
  193190. rc = xToken(pCtx, 0, aFold, zOut-aFold, is, ie);
  193191. }
  193192. tokenize_done:
  193193. if( rc==SQLITE_DONE ) rc = SQLITE_OK;
  193194. return rc;
  193195. }
  193196. /**************************************************************************
  193197. ** Start of porter stemmer implementation.
  193198. */
  193199. /* Any tokens larger than this (in bytes) are passed through without
  193200. ** stemming. */
  193201. #define FTS5_PORTER_MAX_TOKEN 64
  193202. typedef struct PorterTokenizer PorterTokenizer;
  193203. struct PorterTokenizer {
  193204. fts5_tokenizer tokenizer; /* Parent tokenizer module */
  193205. Fts5Tokenizer *pTokenizer; /* Parent tokenizer instance */
  193206. char aBuf[FTS5_PORTER_MAX_TOKEN + 64];
  193207. };
  193208. /*
  193209. ** Delete a "porter" tokenizer.
  193210. */
  193211. static void fts5PorterDelete(Fts5Tokenizer *pTok){
  193212. if( pTok ){
  193213. PorterTokenizer *p = (PorterTokenizer*)pTok;
  193214. if( p->pTokenizer ){
  193215. p->tokenizer.xDelete(p->pTokenizer);
  193216. }
  193217. sqlite3_free(p);
  193218. }
  193219. }
  193220. /*
  193221. ** Create a "porter" tokenizer.
  193222. */
  193223. static int fts5PorterCreate(
  193224. void *pCtx,
  193225. const char **azArg, int nArg,
  193226. Fts5Tokenizer **ppOut
  193227. ){
  193228. fts5_api *pApi = (fts5_api*)pCtx;
  193229. int rc = SQLITE_OK;
  193230. PorterTokenizer *pRet;
  193231. void *pUserdata = 0;
  193232. const char *zBase = "unicode61";
  193233. if( nArg>0 ){
  193234. zBase = azArg[0];
  193235. }
  193236. pRet = (PorterTokenizer*)sqlite3_malloc(sizeof(PorterTokenizer));
  193237. if( pRet ){
  193238. memset(pRet, 0, sizeof(PorterTokenizer));
  193239. rc = pApi->xFindTokenizer(pApi, zBase, &pUserdata, &pRet->tokenizer);
  193240. }else{
  193241. rc = SQLITE_NOMEM;
  193242. }
  193243. if( rc==SQLITE_OK ){
  193244. int nArg2 = (nArg>0 ? nArg-1 : 0);
  193245. const char **azArg2 = (nArg2 ? &azArg[1] : 0);
  193246. rc = pRet->tokenizer.xCreate(pUserdata, azArg2, nArg2, &pRet->pTokenizer);
  193247. }
  193248. if( rc!=SQLITE_OK ){
  193249. fts5PorterDelete((Fts5Tokenizer*)pRet);
  193250. pRet = 0;
  193251. }
  193252. *ppOut = (Fts5Tokenizer*)pRet;
  193253. return rc;
  193254. }
  193255. typedef struct PorterContext PorterContext;
  193256. struct PorterContext {
  193257. void *pCtx;
  193258. int (*xToken)(void*, int, const char*, int, int, int);
  193259. char *aBuf;
  193260. };
  193261. typedef struct PorterRule PorterRule;
  193262. struct PorterRule {
  193263. const char *zSuffix;
  193264. int nSuffix;
  193265. int (*xCond)(char *zStem, int nStem);
  193266. const char *zOutput;
  193267. int nOutput;
  193268. };
  193269. #if 0
  193270. static int fts5PorterApply(char *aBuf, int *pnBuf, PorterRule *aRule){
  193271. int ret = -1;
  193272. int nBuf = *pnBuf;
  193273. PorterRule *p;
  193274. for(p=aRule; p->zSuffix; p++){
  193275. assert( strlen(p->zSuffix)==p->nSuffix );
  193276. assert( strlen(p->zOutput)==p->nOutput );
  193277. if( nBuf<p->nSuffix ) continue;
  193278. if( 0==memcmp(&aBuf[nBuf - p->nSuffix], p->zSuffix, p->nSuffix) ) break;
  193279. }
  193280. if( p->zSuffix ){
  193281. int nStem = nBuf - p->nSuffix;
  193282. if( p->xCond==0 || p->xCond(aBuf, nStem) ){
  193283. memcpy(&aBuf[nStem], p->zOutput, p->nOutput);
  193284. *pnBuf = nStem + p->nOutput;
  193285. ret = p - aRule;
  193286. }
  193287. }
  193288. return ret;
  193289. }
  193290. #endif
  193291. static int fts5PorterIsVowel(char c, int bYIsVowel){
  193292. return (
  193293. c=='a' || c=='e' || c=='i' || c=='o' || c=='u' || (bYIsVowel && c=='y')
  193294. );
  193295. }
  193296. static int fts5PorterGobbleVC(char *zStem, int nStem, int bPrevCons){
  193297. int i;
  193298. int bCons = bPrevCons;
  193299. /* Scan for a vowel */
  193300. for(i=0; i<nStem; i++){
  193301. if( 0==(bCons = !fts5PorterIsVowel(zStem[i], bCons)) ) break;
  193302. }
  193303. /* Scan for a consonent */
  193304. for(i++; i<nStem; i++){
  193305. if( (bCons = !fts5PorterIsVowel(zStem[i], bCons)) ) return i+1;
  193306. }
  193307. return 0;
  193308. }
  193309. /* porter rule condition: (m > 0) */
  193310. static int fts5Porter_MGt0(char *zStem, int nStem){
  193311. return !!fts5PorterGobbleVC(zStem, nStem, 0);
  193312. }
  193313. /* porter rule condition: (m > 1) */
  193314. static int fts5Porter_MGt1(char *zStem, int nStem){
  193315. int n;
  193316. n = fts5PorterGobbleVC(zStem, nStem, 0);
  193317. if( n && fts5PorterGobbleVC(&zStem[n], nStem-n, 1) ){
  193318. return 1;
  193319. }
  193320. return 0;
  193321. }
  193322. /* porter rule condition: (m = 1) */
  193323. static int fts5Porter_MEq1(char *zStem, int nStem){
  193324. int n;
  193325. n = fts5PorterGobbleVC(zStem, nStem, 0);
  193326. if( n && 0==fts5PorterGobbleVC(&zStem[n], nStem-n, 1) ){
  193327. return 1;
  193328. }
  193329. return 0;
  193330. }
  193331. /* porter rule condition: (*o) */
  193332. static int fts5Porter_Ostar(char *zStem, int nStem){
  193333. if( zStem[nStem-1]=='w' || zStem[nStem-1]=='x' || zStem[nStem-1]=='y' ){
  193334. return 0;
  193335. }else{
  193336. int i;
  193337. int mask = 0;
  193338. int bCons = 0;
  193339. for(i=0; i<nStem; i++){
  193340. bCons = !fts5PorterIsVowel(zStem[i], bCons);
  193341. assert( bCons==0 || bCons==1 );
  193342. mask = (mask << 1) + bCons;
  193343. }
  193344. return ((mask & 0x0007)==0x0005);
  193345. }
  193346. }
  193347. /* porter rule condition: (m > 1 and (*S or *T)) */
  193348. static int fts5Porter_MGt1_and_S_or_T(char *zStem, int nStem){
  193349. assert( nStem>0 );
  193350. return (zStem[nStem-1]=='s' || zStem[nStem-1]=='t')
  193351. && fts5Porter_MGt1(zStem, nStem);
  193352. }
  193353. /* porter rule condition: (*v*) */
  193354. static int fts5Porter_Vowel(char *zStem, int nStem){
  193355. int i;
  193356. for(i=0; i<nStem; i++){
  193357. if( fts5PorterIsVowel(zStem[i], i>0) ){
  193358. return 1;
  193359. }
  193360. }
  193361. return 0;
  193362. }
  193363. /**************************************************************************
  193364. ***************************************************************************
  193365. ** GENERATED CODE STARTS HERE (mkportersteps.tcl)
  193366. */
  193367. static int fts5PorterStep4(char *aBuf, int *pnBuf){
  193368. int ret = 0;
  193369. int nBuf = *pnBuf;
  193370. switch( aBuf[nBuf-2] ){
  193371. case 'a':
  193372. if( nBuf>2 && 0==memcmp("al", &aBuf[nBuf-2], 2) ){
  193373. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  193374. *pnBuf = nBuf - 2;
  193375. }
  193376. }
  193377. break;
  193378. case 'c':
  193379. if( nBuf>4 && 0==memcmp("ance", &aBuf[nBuf-4], 4) ){
  193380. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  193381. *pnBuf = nBuf - 4;
  193382. }
  193383. }else if( nBuf>4 && 0==memcmp("ence", &aBuf[nBuf-4], 4) ){
  193384. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  193385. *pnBuf = nBuf - 4;
  193386. }
  193387. }
  193388. break;
  193389. case 'e':
  193390. if( nBuf>2 && 0==memcmp("er", &aBuf[nBuf-2], 2) ){
  193391. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  193392. *pnBuf = nBuf - 2;
  193393. }
  193394. }
  193395. break;
  193396. case 'i':
  193397. if( nBuf>2 && 0==memcmp("ic", &aBuf[nBuf-2], 2) ){
  193398. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  193399. *pnBuf = nBuf - 2;
  193400. }
  193401. }
  193402. break;
  193403. case 'l':
  193404. if( nBuf>4 && 0==memcmp("able", &aBuf[nBuf-4], 4) ){
  193405. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  193406. *pnBuf = nBuf - 4;
  193407. }
  193408. }else if( nBuf>4 && 0==memcmp("ible", &aBuf[nBuf-4], 4) ){
  193409. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  193410. *pnBuf = nBuf - 4;
  193411. }
  193412. }
  193413. break;
  193414. case 'n':
  193415. if( nBuf>3 && 0==memcmp("ant", &aBuf[nBuf-3], 3) ){
  193416. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193417. *pnBuf = nBuf - 3;
  193418. }
  193419. }else if( nBuf>5 && 0==memcmp("ement", &aBuf[nBuf-5], 5) ){
  193420. if( fts5Porter_MGt1(aBuf, nBuf-5) ){
  193421. *pnBuf = nBuf - 5;
  193422. }
  193423. }else if( nBuf>4 && 0==memcmp("ment", &aBuf[nBuf-4], 4) ){
  193424. if( fts5Porter_MGt1(aBuf, nBuf-4) ){
  193425. *pnBuf = nBuf - 4;
  193426. }
  193427. }else if( nBuf>3 && 0==memcmp("ent", &aBuf[nBuf-3], 3) ){
  193428. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193429. *pnBuf = nBuf - 3;
  193430. }
  193431. }
  193432. break;
  193433. case 'o':
  193434. if( nBuf>3 && 0==memcmp("ion", &aBuf[nBuf-3], 3) ){
  193435. if( fts5Porter_MGt1_and_S_or_T(aBuf, nBuf-3) ){
  193436. *pnBuf = nBuf - 3;
  193437. }
  193438. }else if( nBuf>2 && 0==memcmp("ou", &aBuf[nBuf-2], 2) ){
  193439. if( fts5Porter_MGt1(aBuf, nBuf-2) ){
  193440. *pnBuf = nBuf - 2;
  193441. }
  193442. }
  193443. break;
  193444. case 's':
  193445. if( nBuf>3 && 0==memcmp("ism", &aBuf[nBuf-3], 3) ){
  193446. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193447. *pnBuf = nBuf - 3;
  193448. }
  193449. }
  193450. break;
  193451. case 't':
  193452. if( nBuf>3 && 0==memcmp("ate", &aBuf[nBuf-3], 3) ){
  193453. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193454. *pnBuf = nBuf - 3;
  193455. }
  193456. }else if( nBuf>3 && 0==memcmp("iti", &aBuf[nBuf-3], 3) ){
  193457. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193458. *pnBuf = nBuf - 3;
  193459. }
  193460. }
  193461. break;
  193462. case 'u':
  193463. if( nBuf>3 && 0==memcmp("ous", &aBuf[nBuf-3], 3) ){
  193464. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193465. *pnBuf = nBuf - 3;
  193466. }
  193467. }
  193468. break;
  193469. case 'v':
  193470. if( nBuf>3 && 0==memcmp("ive", &aBuf[nBuf-3], 3) ){
  193471. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193472. *pnBuf = nBuf - 3;
  193473. }
  193474. }
  193475. break;
  193476. case 'z':
  193477. if( nBuf>3 && 0==memcmp("ize", &aBuf[nBuf-3], 3) ){
  193478. if( fts5Porter_MGt1(aBuf, nBuf-3) ){
  193479. *pnBuf = nBuf - 3;
  193480. }
  193481. }
  193482. break;
  193483. }
  193484. return ret;
  193485. }
  193486. static int fts5PorterStep1B2(char *aBuf, int *pnBuf){
  193487. int ret = 0;
  193488. int nBuf = *pnBuf;
  193489. switch( aBuf[nBuf-2] ){
  193490. case 'a':
  193491. if( nBuf>2 && 0==memcmp("at", &aBuf[nBuf-2], 2) ){
  193492. memcpy(&aBuf[nBuf-2], "ate", 3);
  193493. *pnBuf = nBuf - 2 + 3;
  193494. ret = 1;
  193495. }
  193496. break;
  193497. case 'b':
  193498. if( nBuf>2 && 0==memcmp("bl", &aBuf[nBuf-2], 2) ){
  193499. memcpy(&aBuf[nBuf-2], "ble", 3);
  193500. *pnBuf = nBuf - 2 + 3;
  193501. ret = 1;
  193502. }
  193503. break;
  193504. case 'i':
  193505. if( nBuf>2 && 0==memcmp("iz", &aBuf[nBuf-2], 2) ){
  193506. memcpy(&aBuf[nBuf-2], "ize", 3);
  193507. *pnBuf = nBuf - 2 + 3;
  193508. ret = 1;
  193509. }
  193510. break;
  193511. }
  193512. return ret;
  193513. }
  193514. static int fts5PorterStep2(char *aBuf, int *pnBuf){
  193515. int ret = 0;
  193516. int nBuf = *pnBuf;
  193517. switch( aBuf[nBuf-2] ){
  193518. case 'a':
  193519. if( nBuf>7 && 0==memcmp("ational", &aBuf[nBuf-7], 7) ){
  193520. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  193521. memcpy(&aBuf[nBuf-7], "ate", 3);
  193522. *pnBuf = nBuf - 7 + 3;
  193523. }
  193524. }else if( nBuf>6 && 0==memcmp("tional", &aBuf[nBuf-6], 6) ){
  193525. if( fts5Porter_MGt0(aBuf, nBuf-6) ){
  193526. memcpy(&aBuf[nBuf-6], "tion", 4);
  193527. *pnBuf = nBuf - 6 + 4;
  193528. }
  193529. }
  193530. break;
  193531. case 'c':
  193532. if( nBuf>4 && 0==memcmp("enci", &aBuf[nBuf-4], 4) ){
  193533. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193534. memcpy(&aBuf[nBuf-4], "ence", 4);
  193535. *pnBuf = nBuf - 4 + 4;
  193536. }
  193537. }else if( nBuf>4 && 0==memcmp("anci", &aBuf[nBuf-4], 4) ){
  193538. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193539. memcpy(&aBuf[nBuf-4], "ance", 4);
  193540. *pnBuf = nBuf - 4 + 4;
  193541. }
  193542. }
  193543. break;
  193544. case 'e':
  193545. if( nBuf>4 && 0==memcmp("izer", &aBuf[nBuf-4], 4) ){
  193546. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193547. memcpy(&aBuf[nBuf-4], "ize", 3);
  193548. *pnBuf = nBuf - 4 + 3;
  193549. }
  193550. }
  193551. break;
  193552. case 'g':
  193553. if( nBuf>4 && 0==memcmp("logi", &aBuf[nBuf-4], 4) ){
  193554. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193555. memcpy(&aBuf[nBuf-4], "log", 3);
  193556. *pnBuf = nBuf - 4 + 3;
  193557. }
  193558. }
  193559. break;
  193560. case 'l':
  193561. if( nBuf>3 && 0==memcmp("bli", &aBuf[nBuf-3], 3) ){
  193562. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  193563. memcpy(&aBuf[nBuf-3], "ble", 3);
  193564. *pnBuf = nBuf - 3 + 3;
  193565. }
  193566. }else if( nBuf>4 && 0==memcmp("alli", &aBuf[nBuf-4], 4) ){
  193567. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193568. memcpy(&aBuf[nBuf-4], "al", 2);
  193569. *pnBuf = nBuf - 4 + 2;
  193570. }
  193571. }else if( nBuf>5 && 0==memcmp("entli", &aBuf[nBuf-5], 5) ){
  193572. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193573. memcpy(&aBuf[nBuf-5], "ent", 3);
  193574. *pnBuf = nBuf - 5 + 3;
  193575. }
  193576. }else if( nBuf>3 && 0==memcmp("eli", &aBuf[nBuf-3], 3) ){
  193577. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  193578. memcpy(&aBuf[nBuf-3], "e", 1);
  193579. *pnBuf = nBuf - 3 + 1;
  193580. }
  193581. }else if( nBuf>5 && 0==memcmp("ousli", &aBuf[nBuf-5], 5) ){
  193582. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193583. memcpy(&aBuf[nBuf-5], "ous", 3);
  193584. *pnBuf = nBuf - 5 + 3;
  193585. }
  193586. }
  193587. break;
  193588. case 'o':
  193589. if( nBuf>7 && 0==memcmp("ization", &aBuf[nBuf-7], 7) ){
  193590. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  193591. memcpy(&aBuf[nBuf-7], "ize", 3);
  193592. *pnBuf = nBuf - 7 + 3;
  193593. }
  193594. }else if( nBuf>5 && 0==memcmp("ation", &aBuf[nBuf-5], 5) ){
  193595. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193596. memcpy(&aBuf[nBuf-5], "ate", 3);
  193597. *pnBuf = nBuf - 5 + 3;
  193598. }
  193599. }else if( nBuf>4 && 0==memcmp("ator", &aBuf[nBuf-4], 4) ){
  193600. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193601. memcpy(&aBuf[nBuf-4], "ate", 3);
  193602. *pnBuf = nBuf - 4 + 3;
  193603. }
  193604. }
  193605. break;
  193606. case 's':
  193607. if( nBuf>5 && 0==memcmp("alism", &aBuf[nBuf-5], 5) ){
  193608. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193609. memcpy(&aBuf[nBuf-5], "al", 2);
  193610. *pnBuf = nBuf - 5 + 2;
  193611. }
  193612. }else if( nBuf>7 && 0==memcmp("iveness", &aBuf[nBuf-7], 7) ){
  193613. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  193614. memcpy(&aBuf[nBuf-7], "ive", 3);
  193615. *pnBuf = nBuf - 7 + 3;
  193616. }
  193617. }else if( nBuf>7 && 0==memcmp("fulness", &aBuf[nBuf-7], 7) ){
  193618. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  193619. memcpy(&aBuf[nBuf-7], "ful", 3);
  193620. *pnBuf = nBuf - 7 + 3;
  193621. }
  193622. }else if( nBuf>7 && 0==memcmp("ousness", &aBuf[nBuf-7], 7) ){
  193623. if( fts5Porter_MGt0(aBuf, nBuf-7) ){
  193624. memcpy(&aBuf[nBuf-7], "ous", 3);
  193625. *pnBuf = nBuf - 7 + 3;
  193626. }
  193627. }
  193628. break;
  193629. case 't':
  193630. if( nBuf>5 && 0==memcmp("aliti", &aBuf[nBuf-5], 5) ){
  193631. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193632. memcpy(&aBuf[nBuf-5], "al", 2);
  193633. *pnBuf = nBuf - 5 + 2;
  193634. }
  193635. }else if( nBuf>5 && 0==memcmp("iviti", &aBuf[nBuf-5], 5) ){
  193636. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193637. memcpy(&aBuf[nBuf-5], "ive", 3);
  193638. *pnBuf = nBuf - 5 + 3;
  193639. }
  193640. }else if( nBuf>6 && 0==memcmp("biliti", &aBuf[nBuf-6], 6) ){
  193641. if( fts5Porter_MGt0(aBuf, nBuf-6) ){
  193642. memcpy(&aBuf[nBuf-6], "ble", 3);
  193643. *pnBuf = nBuf - 6 + 3;
  193644. }
  193645. }
  193646. break;
  193647. }
  193648. return ret;
  193649. }
  193650. static int fts5PorterStep3(char *aBuf, int *pnBuf){
  193651. int ret = 0;
  193652. int nBuf = *pnBuf;
  193653. switch( aBuf[nBuf-2] ){
  193654. case 'a':
  193655. if( nBuf>4 && 0==memcmp("ical", &aBuf[nBuf-4], 4) ){
  193656. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193657. memcpy(&aBuf[nBuf-4], "ic", 2);
  193658. *pnBuf = nBuf - 4 + 2;
  193659. }
  193660. }
  193661. break;
  193662. case 's':
  193663. if( nBuf>4 && 0==memcmp("ness", &aBuf[nBuf-4], 4) ){
  193664. if( fts5Porter_MGt0(aBuf, nBuf-4) ){
  193665. *pnBuf = nBuf - 4;
  193666. }
  193667. }
  193668. break;
  193669. case 't':
  193670. if( nBuf>5 && 0==memcmp("icate", &aBuf[nBuf-5], 5) ){
  193671. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193672. memcpy(&aBuf[nBuf-5], "ic", 2);
  193673. *pnBuf = nBuf - 5 + 2;
  193674. }
  193675. }else if( nBuf>5 && 0==memcmp("iciti", &aBuf[nBuf-5], 5) ){
  193676. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193677. memcpy(&aBuf[nBuf-5], "ic", 2);
  193678. *pnBuf = nBuf - 5 + 2;
  193679. }
  193680. }
  193681. break;
  193682. case 'u':
  193683. if( nBuf>3 && 0==memcmp("ful", &aBuf[nBuf-3], 3) ){
  193684. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  193685. *pnBuf = nBuf - 3;
  193686. }
  193687. }
  193688. break;
  193689. case 'v':
  193690. if( nBuf>5 && 0==memcmp("ative", &aBuf[nBuf-5], 5) ){
  193691. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193692. *pnBuf = nBuf - 5;
  193693. }
  193694. }
  193695. break;
  193696. case 'z':
  193697. if( nBuf>5 && 0==memcmp("alize", &aBuf[nBuf-5], 5) ){
  193698. if( fts5Porter_MGt0(aBuf, nBuf-5) ){
  193699. memcpy(&aBuf[nBuf-5], "al", 2);
  193700. *pnBuf = nBuf - 5 + 2;
  193701. }
  193702. }
  193703. break;
  193704. }
  193705. return ret;
  193706. }
  193707. static int fts5PorterStep1B(char *aBuf, int *pnBuf){
  193708. int ret = 0;
  193709. int nBuf = *pnBuf;
  193710. switch( aBuf[nBuf-2] ){
  193711. case 'e':
  193712. if( nBuf>3 && 0==memcmp("eed", &aBuf[nBuf-3], 3) ){
  193713. if( fts5Porter_MGt0(aBuf, nBuf-3) ){
  193714. memcpy(&aBuf[nBuf-3], "ee", 2);
  193715. *pnBuf = nBuf - 3 + 2;
  193716. }
  193717. }else if( nBuf>2 && 0==memcmp("ed", &aBuf[nBuf-2], 2) ){
  193718. if( fts5Porter_Vowel(aBuf, nBuf-2) ){
  193719. *pnBuf = nBuf - 2;
  193720. ret = 1;
  193721. }
  193722. }
  193723. break;
  193724. case 'n':
  193725. if( nBuf>3 && 0==memcmp("ing", &aBuf[nBuf-3], 3) ){
  193726. if( fts5Porter_Vowel(aBuf, nBuf-3) ){
  193727. *pnBuf = nBuf - 3;
  193728. ret = 1;
  193729. }
  193730. }
  193731. break;
  193732. }
  193733. return ret;
  193734. }
  193735. /*
  193736. ** GENERATED CODE ENDS HERE (mkportersteps.tcl)
  193737. ***************************************************************************
  193738. **************************************************************************/
  193739. static void fts5PorterStep1A(char *aBuf, int *pnBuf){
  193740. int nBuf = *pnBuf;
  193741. if( aBuf[nBuf-1]=='s' ){
  193742. if( aBuf[nBuf-2]=='e' ){
  193743. if( (nBuf>4 && aBuf[nBuf-4]=='s' && aBuf[nBuf-3]=='s')
  193744. || (nBuf>3 && aBuf[nBuf-3]=='i' )
  193745. ){
  193746. *pnBuf = nBuf-2;
  193747. }else{
  193748. *pnBuf = nBuf-1;
  193749. }
  193750. }
  193751. else if( aBuf[nBuf-2]!='s' ){
  193752. *pnBuf = nBuf-1;
  193753. }
  193754. }
  193755. }
  193756. static int fts5PorterCb(
  193757. void *pCtx,
  193758. int tflags,
  193759. const char *pToken,
  193760. int nToken,
  193761. int iStart,
  193762. int iEnd
  193763. ){
  193764. PorterContext *p = (PorterContext*)pCtx;
  193765. char *aBuf;
  193766. int nBuf;
  193767. if( nToken>FTS5_PORTER_MAX_TOKEN || nToken<3 ) goto pass_through;
  193768. aBuf = p->aBuf;
  193769. nBuf = nToken;
  193770. memcpy(aBuf, pToken, nBuf);
  193771. /* Step 1. */
  193772. fts5PorterStep1A(aBuf, &nBuf);
  193773. if( fts5PorterStep1B(aBuf, &nBuf) ){
  193774. if( fts5PorterStep1B2(aBuf, &nBuf)==0 ){
  193775. char c = aBuf[nBuf-1];
  193776. if( fts5PorterIsVowel(c, 0)==0
  193777. && c!='l' && c!='s' && c!='z' && c==aBuf[nBuf-2]
  193778. ){
  193779. nBuf--;
  193780. }else if( fts5Porter_MEq1(aBuf, nBuf) && fts5Porter_Ostar(aBuf, nBuf) ){
  193781. aBuf[nBuf++] = 'e';
  193782. }
  193783. }
  193784. }
  193785. /* Step 1C. */
  193786. if( aBuf[nBuf-1]=='y' && fts5Porter_Vowel(aBuf, nBuf-1) ){
  193787. aBuf[nBuf-1] = 'i';
  193788. }
  193789. /* Steps 2 through 4. */
  193790. fts5PorterStep2(aBuf, &nBuf);
  193791. fts5PorterStep3(aBuf, &nBuf);
  193792. fts5PorterStep4(aBuf, &nBuf);
  193793. /* Step 5a. */
  193794. assert( nBuf>0 );
  193795. if( aBuf[nBuf-1]=='e' ){
  193796. if( fts5Porter_MGt1(aBuf, nBuf-1)
  193797. || (fts5Porter_MEq1(aBuf, nBuf-1) && !fts5Porter_Ostar(aBuf, nBuf-1))
  193798. ){
  193799. nBuf--;
  193800. }
  193801. }
  193802. /* Step 5b. */
  193803. if( nBuf>1 && aBuf[nBuf-1]=='l'
  193804. && aBuf[nBuf-2]=='l' && fts5Porter_MGt1(aBuf, nBuf-1)
  193805. ){
  193806. nBuf--;
  193807. }
  193808. return p->xToken(p->pCtx, tflags, aBuf, nBuf, iStart, iEnd);
  193809. pass_through:
  193810. return p->xToken(p->pCtx, tflags, pToken, nToken, iStart, iEnd);
  193811. }
  193812. /*
  193813. ** Tokenize using the porter tokenizer.
  193814. */
  193815. static int fts5PorterTokenize(
  193816. Fts5Tokenizer *pTokenizer,
  193817. void *pCtx,
  193818. int flags,
  193819. const char *pText, int nText,
  193820. int (*xToken)(void*, int, const char*, int nToken, int iStart, int iEnd)
  193821. ){
  193822. PorterTokenizer *p = (PorterTokenizer*)pTokenizer;
  193823. PorterContext sCtx;
  193824. sCtx.xToken = xToken;
  193825. sCtx.pCtx = pCtx;
  193826. sCtx.aBuf = p->aBuf;
  193827. return p->tokenizer.xTokenize(
  193828. p->pTokenizer, (void*)&sCtx, flags, pText, nText, fts5PorterCb
  193829. );
  193830. }
  193831. /*
  193832. ** Register all built-in tokenizers with FTS5.
  193833. */
  193834. static int sqlite3Fts5TokenizerInit(fts5_api *pApi){
  193835. struct BuiltinTokenizer {
  193836. const char *zName;
  193837. fts5_tokenizer x;
  193838. } aBuiltin[] = {
  193839. { "unicode61", {fts5UnicodeCreate, fts5UnicodeDelete, fts5UnicodeTokenize}},
  193840. { "ascii", {fts5AsciiCreate, fts5AsciiDelete, fts5AsciiTokenize }},
  193841. { "porter", {fts5PorterCreate, fts5PorterDelete, fts5PorterTokenize }},
  193842. };
  193843. int rc = SQLITE_OK; /* Return code */
  193844. int i; /* To iterate through builtin functions */
  193845. for(i=0; rc==SQLITE_OK && i<ArraySize(aBuiltin); i++){
  193846. rc = pApi->xCreateTokenizer(pApi,
  193847. aBuiltin[i].zName,
  193848. (void*)pApi,
  193849. &aBuiltin[i].x,
  193850. 0
  193851. );
  193852. }
  193853. return rc;
  193854. }
  193855. /*
  193856. ** 2012 May 25
  193857. **
  193858. ** The author disclaims copyright to this source code. In place of
  193859. ** a legal notice, here is a blessing:
  193860. **
  193861. ** May you do good and not evil.
  193862. ** May you find forgiveness for yourself and forgive others.
  193863. ** May you share freely, never taking more than you give.
  193864. **
  193865. ******************************************************************************
  193866. */
  193867. /*
  193868. ** DO NOT EDIT THIS MACHINE GENERATED FILE.
  193869. */
  193870. /* #include <assert.h> */
  193871. /*
  193872. ** Return true if the argument corresponds to a unicode codepoint
  193873. ** classified as either a letter or a number. Otherwise false.
  193874. **
  193875. ** The results are undefined if the value passed to this function
  193876. ** is less than zero.
  193877. */
  193878. static int sqlite3Fts5UnicodeIsalnum(int c){
  193879. /* Each unsigned integer in the following array corresponds to a contiguous
  193880. ** range of unicode codepoints that are not either letters or numbers (i.e.
  193881. ** codepoints for which this function should return 0).
  193882. **
  193883. ** The most significant 22 bits in each 32-bit value contain the first
  193884. ** codepoint in the range. The least significant 10 bits are used to store
  193885. ** the size of the range (always at least 1). In other words, the value
  193886. ** ((C<<22) + N) represents a range of N codepoints starting with codepoint
  193887. ** C. It is not possible to represent a range larger than 1023 codepoints
  193888. ** using this format.
  193889. */
  193890. static const unsigned int aEntry[] = {
  193891. 0x00000030, 0x0000E807, 0x00016C06, 0x0001EC2F, 0x0002AC07,
  193892. 0x0002D001, 0x0002D803, 0x0002EC01, 0x0002FC01, 0x00035C01,
  193893. 0x0003DC01, 0x000B0804, 0x000B480E, 0x000B9407, 0x000BB401,
  193894. 0x000BBC81, 0x000DD401, 0x000DF801, 0x000E1002, 0x000E1C01,
  193895. 0x000FD801, 0x00120808, 0x00156806, 0x00162402, 0x00163C01,
  193896. 0x00164437, 0x0017CC02, 0x00180005, 0x00181816, 0x00187802,
  193897. 0x00192C15, 0x0019A804, 0x0019C001, 0x001B5001, 0x001B580F,
  193898. 0x001B9C07, 0x001BF402, 0x001C000E, 0x001C3C01, 0x001C4401,
  193899. 0x001CC01B, 0x001E980B, 0x001FAC09, 0x001FD804, 0x00205804,
  193900. 0x00206C09, 0x00209403, 0x0020A405, 0x0020C00F, 0x00216403,
  193901. 0x00217801, 0x0023901B, 0x00240004, 0x0024E803, 0x0024F812,
  193902. 0x00254407, 0x00258804, 0x0025C001, 0x00260403, 0x0026F001,
  193903. 0x0026F807, 0x00271C02, 0x00272C03, 0x00275C01, 0x00278802,
  193904. 0x0027C802, 0x0027E802, 0x00280403, 0x0028F001, 0x0028F805,
  193905. 0x00291C02, 0x00292C03, 0x00294401, 0x0029C002, 0x0029D401,
  193906. 0x002A0403, 0x002AF001, 0x002AF808, 0x002B1C03, 0x002B2C03,
  193907. 0x002B8802, 0x002BC002, 0x002C0403, 0x002CF001, 0x002CF807,
  193908. 0x002D1C02, 0x002D2C03, 0x002D5802, 0x002D8802, 0x002DC001,
  193909. 0x002E0801, 0x002EF805, 0x002F1803, 0x002F2804, 0x002F5C01,
  193910. 0x002FCC08, 0x00300403, 0x0030F807, 0x00311803, 0x00312804,
  193911. 0x00315402, 0x00318802, 0x0031FC01, 0x00320802, 0x0032F001,
  193912. 0x0032F807, 0x00331803, 0x00332804, 0x00335402, 0x00338802,
  193913. 0x00340802, 0x0034F807, 0x00351803, 0x00352804, 0x00355C01,
  193914. 0x00358802, 0x0035E401, 0x00360802, 0x00372801, 0x00373C06,
  193915. 0x00375801, 0x00376008, 0x0037C803, 0x0038C401, 0x0038D007,
  193916. 0x0038FC01, 0x00391C09, 0x00396802, 0x003AC401, 0x003AD006,
  193917. 0x003AEC02, 0x003B2006, 0x003C041F, 0x003CD00C, 0x003DC417,
  193918. 0x003E340B, 0x003E6424, 0x003EF80F, 0x003F380D, 0x0040AC14,
  193919. 0x00412806, 0x00415804, 0x00417803, 0x00418803, 0x00419C07,
  193920. 0x0041C404, 0x0042080C, 0x00423C01, 0x00426806, 0x0043EC01,
  193921. 0x004D740C, 0x004E400A, 0x00500001, 0x0059B402, 0x005A0001,
  193922. 0x005A6C02, 0x005BAC03, 0x005C4803, 0x005CC805, 0x005D4802,
  193923. 0x005DC802, 0x005ED023, 0x005F6004, 0x005F7401, 0x0060000F,
  193924. 0x0062A401, 0x0064800C, 0x0064C00C, 0x00650001, 0x00651002,
  193925. 0x0066C011, 0x00672002, 0x00677822, 0x00685C05, 0x00687802,
  193926. 0x0069540A, 0x0069801D, 0x0069FC01, 0x006A8007, 0x006AA006,
  193927. 0x006C0005, 0x006CD011, 0x006D6823, 0x006E0003, 0x006E840D,
  193928. 0x006F980E, 0x006FF004, 0x00709014, 0x0070EC05, 0x0071F802,
  193929. 0x00730008, 0x00734019, 0x0073B401, 0x0073C803, 0x00770027,
  193930. 0x0077F004, 0x007EF401, 0x007EFC03, 0x007F3403, 0x007F7403,
  193931. 0x007FB403, 0x007FF402, 0x00800065, 0x0081A806, 0x0081E805,
  193932. 0x00822805, 0x0082801A, 0x00834021, 0x00840002, 0x00840C04,
  193933. 0x00842002, 0x00845001, 0x00845803, 0x00847806, 0x00849401,
  193934. 0x00849C01, 0x0084A401, 0x0084B801, 0x0084E802, 0x00850005,
  193935. 0x00852804, 0x00853C01, 0x00864264, 0x00900027, 0x0091000B,
  193936. 0x0092704E, 0x00940200, 0x009C0475, 0x009E53B9, 0x00AD400A,
  193937. 0x00B39406, 0x00B3BC03, 0x00B3E404, 0x00B3F802, 0x00B5C001,
  193938. 0x00B5FC01, 0x00B7804F, 0x00B8C00C, 0x00BA001A, 0x00BA6C59,
  193939. 0x00BC00D6, 0x00BFC00C, 0x00C00005, 0x00C02019, 0x00C0A807,
  193940. 0x00C0D802, 0x00C0F403, 0x00C26404, 0x00C28001, 0x00C3EC01,
  193941. 0x00C64002, 0x00C6580A, 0x00C70024, 0x00C8001F, 0x00C8A81E,
  193942. 0x00C94001, 0x00C98020, 0x00CA2827, 0x00CB003F, 0x00CC0100,
  193943. 0x01370040, 0x02924037, 0x0293F802, 0x02983403, 0x0299BC10,
  193944. 0x029A7C01, 0x029BC008, 0x029C0017, 0x029C8002, 0x029E2402,
  193945. 0x02A00801, 0x02A01801, 0x02A02C01, 0x02A08C09, 0x02A0D804,
  193946. 0x02A1D004, 0x02A20002, 0x02A2D011, 0x02A33802, 0x02A38012,
  193947. 0x02A3E003, 0x02A4980A, 0x02A51C0D, 0x02A57C01, 0x02A60004,
  193948. 0x02A6CC1B, 0x02A77802, 0x02A8A40E, 0x02A90C01, 0x02A93002,
  193949. 0x02A97004, 0x02A9DC03, 0x02A9EC01, 0x02AAC001, 0x02AAC803,
  193950. 0x02AADC02, 0x02AAF802, 0x02AB0401, 0x02AB7802, 0x02ABAC07,
  193951. 0x02ABD402, 0x02AF8C0B, 0x03600001, 0x036DFC02, 0x036FFC02,
  193952. 0x037FFC01, 0x03EC7801, 0x03ECA401, 0x03EEC810, 0x03F4F802,
  193953. 0x03F7F002, 0x03F8001A, 0x03F88007, 0x03F8C023, 0x03F95013,
  193954. 0x03F9A004, 0x03FBFC01, 0x03FC040F, 0x03FC6807, 0x03FCEC06,
  193955. 0x03FD6C0B, 0x03FF8007, 0x03FFA007, 0x03FFE405, 0x04040003,
  193956. 0x0404DC09, 0x0405E411, 0x0406400C, 0x0407402E, 0x040E7C01,
  193957. 0x040F4001, 0x04215C01, 0x04247C01, 0x0424FC01, 0x04280403,
  193958. 0x04281402, 0x04283004, 0x0428E003, 0x0428FC01, 0x04294009,
  193959. 0x0429FC01, 0x042CE407, 0x04400003, 0x0440E016, 0x04420003,
  193960. 0x0442C012, 0x04440003, 0x04449C0E, 0x04450004, 0x04460003,
  193961. 0x0446CC0E, 0x04471404, 0x045AAC0D, 0x0491C004, 0x05BD442E,
  193962. 0x05BE3C04, 0x074000F6, 0x07440027, 0x0744A4B5, 0x07480046,
  193963. 0x074C0057, 0x075B0401, 0x075B6C01, 0x075BEC01, 0x075C5401,
  193964. 0x075CD401, 0x075D3C01, 0x075DBC01, 0x075E2401, 0x075EA401,
  193965. 0x075F0C01, 0x07BBC002, 0x07C0002C, 0x07C0C064, 0x07C2800F,
  193966. 0x07C2C40E, 0x07C3040F, 0x07C3440F, 0x07C4401F, 0x07C4C03C,
  193967. 0x07C5C02B, 0x07C7981D, 0x07C8402B, 0x07C90009, 0x07C94002,
  193968. 0x07CC0021, 0x07CCC006, 0x07CCDC46, 0x07CE0014, 0x07CE8025,
  193969. 0x07CF1805, 0x07CF8011, 0x07D0003F, 0x07D10001, 0x07D108B6,
  193970. 0x07D3E404, 0x07D4003E, 0x07D50004, 0x07D54018, 0x07D7EC46,
  193971. 0x07D9140B, 0x07DA0046, 0x07DC0074, 0x38000401, 0x38008060,
  193972. 0x380400F0,
  193973. };
  193974. static const unsigned int aAscii[4] = {
  193975. 0xFFFFFFFF, 0xFC00FFFF, 0xF8000001, 0xF8000001,
  193976. };
  193977. if( (unsigned int)c<128 ){
  193978. return ( (aAscii[c >> 5] & (1 << (c & 0x001F)))==0 );
  193979. }else if( (unsigned int)c<(1<<22) ){
  193980. unsigned int key = (((unsigned int)c)<<10) | 0x000003FF;
  193981. int iRes = 0;
  193982. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  193983. int iLo = 0;
  193984. while( iHi>=iLo ){
  193985. int iTest = (iHi + iLo) / 2;
  193986. if( key >= aEntry[iTest] ){
  193987. iRes = iTest;
  193988. iLo = iTest+1;
  193989. }else{
  193990. iHi = iTest-1;
  193991. }
  193992. }
  193993. assert( aEntry[0]<key );
  193994. assert( key>=aEntry[iRes] );
  193995. return (((unsigned int)c) >= ((aEntry[iRes]>>10) + (aEntry[iRes]&0x3FF)));
  193996. }
  193997. return 1;
  193998. }
  193999. /*
  194000. ** If the argument is a codepoint corresponding to a lowercase letter
  194001. ** in the ASCII range with a diacritic added, return the codepoint
  194002. ** of the ASCII letter only. For example, if passed 235 - "LATIN
  194003. ** SMALL LETTER E WITH DIAERESIS" - return 65 ("LATIN SMALL LETTER
  194004. ** E"). The resuls of passing a codepoint that corresponds to an
  194005. ** uppercase letter are undefined.
  194006. */
  194007. static int fts5_remove_diacritic(int c){
  194008. unsigned short aDia[] = {
  194009. 0, 1797, 1848, 1859, 1891, 1928, 1940, 1995,
  194010. 2024, 2040, 2060, 2110, 2168, 2206, 2264, 2286,
  194011. 2344, 2383, 2472, 2488, 2516, 2596, 2668, 2732,
  194012. 2782, 2842, 2894, 2954, 2984, 3000, 3028, 3336,
  194013. 3456, 3696, 3712, 3728, 3744, 3896, 3912, 3928,
  194014. 3968, 4008, 4040, 4106, 4138, 4170, 4202, 4234,
  194015. 4266, 4296, 4312, 4344, 4408, 4424, 4472, 4504,
  194016. 6148, 6198, 6264, 6280, 6360, 6429, 6505, 6529,
  194017. 61448, 61468, 61534, 61592, 61642, 61688, 61704, 61726,
  194018. 61784, 61800, 61836, 61880, 61914, 61948, 61998, 62122,
  194019. 62154, 62200, 62218, 62302, 62364, 62442, 62478, 62536,
  194020. 62554, 62584, 62604, 62640, 62648, 62656, 62664, 62730,
  194021. 62924, 63050, 63082, 63274, 63390,
  194022. };
  194023. char aChar[] = {
  194024. '\0', 'a', 'c', 'e', 'i', 'n', 'o', 'u', 'y', 'y', 'a', 'c',
  194025. 'd', 'e', 'e', 'g', 'h', 'i', 'j', 'k', 'l', 'n', 'o', 'r',
  194026. 's', 't', 'u', 'u', 'w', 'y', 'z', 'o', 'u', 'a', 'i', 'o',
  194027. 'u', 'g', 'k', 'o', 'j', 'g', 'n', 'a', 'e', 'i', 'o', 'r',
  194028. 'u', 's', 't', 'h', 'a', 'e', 'o', 'y', '\0', '\0', '\0', '\0',
  194029. '\0', '\0', '\0', '\0', 'a', 'b', 'd', 'd', 'e', 'f', 'g', 'h',
  194030. 'h', 'i', 'k', 'l', 'l', 'm', 'n', 'p', 'r', 'r', 's', 't',
  194031. 'u', 'v', 'w', 'w', 'x', 'y', 'z', 'h', 't', 'w', 'y', 'a',
  194032. 'e', 'i', 'o', 'u', 'y',
  194033. };
  194034. unsigned int key = (((unsigned int)c)<<3) | 0x00000007;
  194035. int iRes = 0;
  194036. int iHi = sizeof(aDia)/sizeof(aDia[0]) - 1;
  194037. int iLo = 0;
  194038. while( iHi>=iLo ){
  194039. int iTest = (iHi + iLo) / 2;
  194040. if( key >= aDia[iTest] ){
  194041. iRes = iTest;
  194042. iLo = iTest+1;
  194043. }else{
  194044. iHi = iTest-1;
  194045. }
  194046. }
  194047. assert( key>=aDia[iRes] );
  194048. return ((c > (aDia[iRes]>>3) + (aDia[iRes]&0x07)) ? c : (int)aChar[iRes]);
  194049. }
  194050. /*
  194051. ** Return true if the argument interpreted as a unicode codepoint
  194052. ** is a diacritical modifier character.
  194053. */
  194054. static int sqlite3Fts5UnicodeIsdiacritic(int c){
  194055. unsigned int mask0 = 0x08029FDF;
  194056. unsigned int mask1 = 0x000361F8;
  194057. if( c<768 || c>817 ) return 0;
  194058. return (c < 768+32) ?
  194059. (mask0 & (1 << (c-768))) :
  194060. (mask1 & (1 << (c-768-32)));
  194061. }
  194062. /*
  194063. ** Interpret the argument as a unicode codepoint. If the codepoint
  194064. ** is an upper case character that has a lower case equivalent,
  194065. ** return the codepoint corresponding to the lower case version.
  194066. ** Otherwise, return a copy of the argument.
  194067. **
  194068. ** The results are undefined if the value passed to this function
  194069. ** is less than zero.
  194070. */
  194071. static int sqlite3Fts5UnicodeFold(int c, int bRemoveDiacritic){
  194072. /* Each entry in the following array defines a rule for folding a range
  194073. ** of codepoints to lower case. The rule applies to a range of nRange
  194074. ** codepoints starting at codepoint iCode.
  194075. **
  194076. ** If the least significant bit in flags is clear, then the rule applies
  194077. ** to all nRange codepoints (i.e. all nRange codepoints are upper case and
  194078. ** need to be folded). Or, if it is set, then the rule only applies to
  194079. ** every second codepoint in the range, starting with codepoint C.
  194080. **
  194081. ** The 7 most significant bits in flags are an index into the aiOff[]
  194082. ** array. If a specific codepoint C does require folding, then its lower
  194083. ** case equivalent is ((C + aiOff[flags>>1]) & 0xFFFF).
  194084. **
  194085. ** The contents of this array are generated by parsing the CaseFolding.txt
  194086. ** file distributed as part of the "Unicode Character Database". See
  194087. ** http://www.unicode.org for details.
  194088. */
  194089. static const struct TableEntry {
  194090. unsigned short iCode;
  194091. unsigned char flags;
  194092. unsigned char nRange;
  194093. } aEntry[] = {
  194094. {65, 14, 26}, {181, 64, 1}, {192, 14, 23},
  194095. {216, 14, 7}, {256, 1, 48}, {306, 1, 6},
  194096. {313, 1, 16}, {330, 1, 46}, {376, 116, 1},
  194097. {377, 1, 6}, {383, 104, 1}, {385, 50, 1},
  194098. {386, 1, 4}, {390, 44, 1}, {391, 0, 1},
  194099. {393, 42, 2}, {395, 0, 1}, {398, 32, 1},
  194100. {399, 38, 1}, {400, 40, 1}, {401, 0, 1},
  194101. {403, 42, 1}, {404, 46, 1}, {406, 52, 1},
  194102. {407, 48, 1}, {408, 0, 1}, {412, 52, 1},
  194103. {413, 54, 1}, {415, 56, 1}, {416, 1, 6},
  194104. {422, 60, 1}, {423, 0, 1}, {425, 60, 1},
  194105. {428, 0, 1}, {430, 60, 1}, {431, 0, 1},
  194106. {433, 58, 2}, {435, 1, 4}, {439, 62, 1},
  194107. {440, 0, 1}, {444, 0, 1}, {452, 2, 1},
  194108. {453, 0, 1}, {455, 2, 1}, {456, 0, 1},
  194109. {458, 2, 1}, {459, 1, 18}, {478, 1, 18},
  194110. {497, 2, 1}, {498, 1, 4}, {502, 122, 1},
  194111. {503, 134, 1}, {504, 1, 40}, {544, 110, 1},
  194112. {546, 1, 18}, {570, 70, 1}, {571, 0, 1},
  194113. {573, 108, 1}, {574, 68, 1}, {577, 0, 1},
  194114. {579, 106, 1}, {580, 28, 1}, {581, 30, 1},
  194115. {582, 1, 10}, {837, 36, 1}, {880, 1, 4},
  194116. {886, 0, 1}, {902, 18, 1}, {904, 16, 3},
  194117. {908, 26, 1}, {910, 24, 2}, {913, 14, 17},
  194118. {931, 14, 9}, {962, 0, 1}, {975, 4, 1},
  194119. {976, 140, 1}, {977, 142, 1}, {981, 146, 1},
  194120. {982, 144, 1}, {984, 1, 24}, {1008, 136, 1},
  194121. {1009, 138, 1}, {1012, 130, 1}, {1013, 128, 1},
  194122. {1015, 0, 1}, {1017, 152, 1}, {1018, 0, 1},
  194123. {1021, 110, 3}, {1024, 34, 16}, {1040, 14, 32},
  194124. {1120, 1, 34}, {1162, 1, 54}, {1216, 6, 1},
  194125. {1217, 1, 14}, {1232, 1, 88}, {1329, 22, 38},
  194126. {4256, 66, 38}, {4295, 66, 1}, {4301, 66, 1},
  194127. {7680, 1, 150}, {7835, 132, 1}, {7838, 96, 1},
  194128. {7840, 1, 96}, {7944, 150, 8}, {7960, 150, 6},
  194129. {7976, 150, 8}, {7992, 150, 8}, {8008, 150, 6},
  194130. {8025, 151, 8}, {8040, 150, 8}, {8072, 150, 8},
  194131. {8088, 150, 8}, {8104, 150, 8}, {8120, 150, 2},
  194132. {8122, 126, 2}, {8124, 148, 1}, {8126, 100, 1},
  194133. {8136, 124, 4}, {8140, 148, 1}, {8152, 150, 2},
  194134. {8154, 120, 2}, {8168, 150, 2}, {8170, 118, 2},
  194135. {8172, 152, 1}, {8184, 112, 2}, {8186, 114, 2},
  194136. {8188, 148, 1}, {8486, 98, 1}, {8490, 92, 1},
  194137. {8491, 94, 1}, {8498, 12, 1}, {8544, 8, 16},
  194138. {8579, 0, 1}, {9398, 10, 26}, {11264, 22, 47},
  194139. {11360, 0, 1}, {11362, 88, 1}, {11363, 102, 1},
  194140. {11364, 90, 1}, {11367, 1, 6}, {11373, 84, 1},
  194141. {11374, 86, 1}, {11375, 80, 1}, {11376, 82, 1},
  194142. {11378, 0, 1}, {11381, 0, 1}, {11390, 78, 2},
  194143. {11392, 1, 100}, {11499, 1, 4}, {11506, 0, 1},
  194144. {42560, 1, 46}, {42624, 1, 24}, {42786, 1, 14},
  194145. {42802, 1, 62}, {42873, 1, 4}, {42877, 76, 1},
  194146. {42878, 1, 10}, {42891, 0, 1}, {42893, 74, 1},
  194147. {42896, 1, 4}, {42912, 1, 10}, {42922, 72, 1},
  194148. {65313, 14, 26},
  194149. };
  194150. static const unsigned short aiOff[] = {
  194151. 1, 2, 8, 15, 16, 26, 28, 32,
  194152. 37, 38, 40, 48, 63, 64, 69, 71,
  194153. 79, 80, 116, 202, 203, 205, 206, 207,
  194154. 209, 210, 211, 213, 214, 217, 218, 219,
  194155. 775, 7264, 10792, 10795, 23228, 23256, 30204, 54721,
  194156. 54753, 54754, 54756, 54787, 54793, 54809, 57153, 57274,
  194157. 57921, 58019, 58363, 61722, 65268, 65341, 65373, 65406,
  194158. 65408, 65410, 65415, 65424, 65436, 65439, 65450, 65462,
  194159. 65472, 65476, 65478, 65480, 65482, 65488, 65506, 65511,
  194160. 65514, 65521, 65527, 65528, 65529,
  194161. };
  194162. int ret = c;
  194163. assert( sizeof(unsigned short)==2 && sizeof(unsigned char)==1 );
  194164. if( c<128 ){
  194165. if( c>='A' && c<='Z' ) ret = c + ('a' - 'A');
  194166. }else if( c<65536 ){
  194167. const struct TableEntry *p;
  194168. int iHi = sizeof(aEntry)/sizeof(aEntry[0]) - 1;
  194169. int iLo = 0;
  194170. int iRes = -1;
  194171. assert( c>aEntry[0].iCode );
  194172. while( iHi>=iLo ){
  194173. int iTest = (iHi + iLo) / 2;
  194174. int cmp = (c - aEntry[iTest].iCode);
  194175. if( cmp>=0 ){
  194176. iRes = iTest;
  194177. iLo = iTest+1;
  194178. }else{
  194179. iHi = iTest-1;
  194180. }
  194181. }
  194182. assert( iRes>=0 && c>=aEntry[iRes].iCode );
  194183. p = &aEntry[iRes];
  194184. if( c<(p->iCode + p->nRange) && 0==(0x01 & p->flags & (p->iCode ^ c)) ){
  194185. ret = (c + (aiOff[p->flags>>1])) & 0x0000FFFF;
  194186. assert( ret>0 );
  194187. }
  194188. if( bRemoveDiacritic ) ret = fts5_remove_diacritic(ret);
  194189. }
  194190. else if( c>=66560 && c<66600 ){
  194191. ret = c + 40;
  194192. }
  194193. return ret;
  194194. }
  194195. /*
  194196. ** 2015 May 30
  194197. **
  194198. ** The author disclaims copyright to this source code. In place of
  194199. ** a legal notice, here is a blessing:
  194200. **
  194201. ** May you do good and not evil.
  194202. ** May you find forgiveness for yourself and forgive others.
  194203. ** May you share freely, never taking more than you give.
  194204. **
  194205. ******************************************************************************
  194206. **
  194207. ** Routines for varint serialization and deserialization.
  194208. */
  194209. /* #include "fts5Int.h" */
  194210. /*
  194211. ** This is a copy of the sqlite3GetVarint32() routine from the SQLite core.
  194212. ** Except, this version does handle the single byte case that the core
  194213. ** version depends on being handled before its function is called.
  194214. */
  194215. static int sqlite3Fts5GetVarint32(const unsigned char *p, u32 *v){
  194216. u32 a,b;
  194217. /* The 1-byte case. Overwhelmingly the most common. */
  194218. a = *p;
  194219. /* a: p0 (unmasked) */
  194220. if (!(a&0x80))
  194221. {
  194222. /* Values between 0 and 127 */
  194223. *v = a;
  194224. return 1;
  194225. }
  194226. /* The 2-byte case */
  194227. p++;
  194228. b = *p;
  194229. /* b: p1 (unmasked) */
  194230. if (!(b&0x80))
  194231. {
  194232. /* Values between 128 and 16383 */
  194233. a &= 0x7f;
  194234. a = a<<7;
  194235. *v = a | b;
  194236. return 2;
  194237. }
  194238. /* The 3-byte case */
  194239. p++;
  194240. a = a<<14;
  194241. a |= *p;
  194242. /* a: p0<<14 | p2 (unmasked) */
  194243. if (!(a&0x80))
  194244. {
  194245. /* Values between 16384 and 2097151 */
  194246. a &= (0x7f<<14)|(0x7f);
  194247. b &= 0x7f;
  194248. b = b<<7;
  194249. *v = a | b;
  194250. return 3;
  194251. }
  194252. /* A 32-bit varint is used to store size information in btrees.
  194253. ** Objects are rarely larger than 2MiB limit of a 3-byte varint.
  194254. ** A 3-byte varint is sufficient, for example, to record the size
  194255. ** of a 1048569-byte BLOB or string.
  194256. **
  194257. ** We only unroll the first 1-, 2-, and 3- byte cases. The very
  194258. ** rare larger cases can be handled by the slower 64-bit varint
  194259. ** routine.
  194260. */
  194261. {
  194262. u64 v64;
  194263. u8 n;
  194264. p -= 2;
  194265. n = sqlite3Fts5GetVarint(p, &v64);
  194266. *v = (u32)v64;
  194267. assert( n>3 && n<=9 );
  194268. return n;
  194269. }
  194270. }
  194271. /*
  194272. ** Bitmasks used by sqlite3GetVarint(). These precomputed constants
  194273. ** are defined here rather than simply putting the constant expressions
  194274. ** inline in order to work around bugs in the RVT compiler.
  194275. **
  194276. ** SLOT_2_0 A mask for (0x7f<<14) | 0x7f
  194277. **
  194278. ** SLOT_4_2_0 A mask for (0x7f<<28) | SLOT_2_0
  194279. */
  194280. #define SLOT_2_0 0x001fc07f
  194281. #define SLOT_4_2_0 0xf01fc07f
  194282. /*
  194283. ** Read a 64-bit variable-length integer from memory starting at p[0].
  194284. ** Return the number of bytes read. The value is stored in *v.
  194285. */
  194286. static u8 sqlite3Fts5GetVarint(const unsigned char *p, u64 *v){
  194287. u32 a,b,s;
  194288. a = *p;
  194289. /* a: p0 (unmasked) */
  194290. if (!(a&0x80))
  194291. {
  194292. *v = a;
  194293. return 1;
  194294. }
  194295. p++;
  194296. b = *p;
  194297. /* b: p1 (unmasked) */
  194298. if (!(b&0x80))
  194299. {
  194300. a &= 0x7f;
  194301. a = a<<7;
  194302. a |= b;
  194303. *v = a;
  194304. return 2;
  194305. }
  194306. /* Verify that constants are precomputed correctly */
  194307. assert( SLOT_2_0 == ((0x7f<<14) | (0x7f)) );
  194308. assert( SLOT_4_2_0 == ((0xfU<<28) | (0x7f<<14) | (0x7f)) );
  194309. p++;
  194310. a = a<<14;
  194311. a |= *p;
  194312. /* a: p0<<14 | p2 (unmasked) */
  194313. if (!(a&0x80))
  194314. {
  194315. a &= SLOT_2_0;
  194316. b &= 0x7f;
  194317. b = b<<7;
  194318. a |= b;
  194319. *v = a;
  194320. return 3;
  194321. }
  194322. /* CSE1 from below */
  194323. a &= SLOT_2_0;
  194324. p++;
  194325. b = b<<14;
  194326. b |= *p;
  194327. /* b: p1<<14 | p3 (unmasked) */
  194328. if (!(b&0x80))
  194329. {
  194330. b &= SLOT_2_0;
  194331. /* moved CSE1 up */
  194332. /* a &= (0x7f<<14)|(0x7f); */
  194333. a = a<<7;
  194334. a |= b;
  194335. *v = a;
  194336. return 4;
  194337. }
  194338. /* a: p0<<14 | p2 (masked) */
  194339. /* b: p1<<14 | p3 (unmasked) */
  194340. /* 1:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  194341. /* moved CSE1 up */
  194342. /* a &= (0x7f<<14)|(0x7f); */
  194343. b &= SLOT_2_0;
  194344. s = a;
  194345. /* s: p0<<14 | p2 (masked) */
  194346. p++;
  194347. a = a<<14;
  194348. a |= *p;
  194349. /* a: p0<<28 | p2<<14 | p4 (unmasked) */
  194350. if (!(a&0x80))
  194351. {
  194352. /* we can skip these cause they were (effectively) done above in calc'ing s */
  194353. /* a &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  194354. /* b &= (0x7f<<14)|(0x7f); */
  194355. b = b<<7;
  194356. a |= b;
  194357. s = s>>18;
  194358. *v = ((u64)s)<<32 | a;
  194359. return 5;
  194360. }
  194361. /* 2:save off p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  194362. s = s<<7;
  194363. s |= b;
  194364. /* s: p0<<21 | p1<<14 | p2<<7 | p3 (masked) */
  194365. p++;
  194366. b = b<<14;
  194367. b |= *p;
  194368. /* b: p1<<28 | p3<<14 | p5 (unmasked) */
  194369. if (!(b&0x80))
  194370. {
  194371. /* we can skip this cause it was (effectively) done above in calc'ing s */
  194372. /* b &= (0x7f<<28)|(0x7f<<14)|(0x7f); */
  194373. a &= SLOT_2_0;
  194374. a = a<<7;
  194375. a |= b;
  194376. s = s>>18;
  194377. *v = ((u64)s)<<32 | a;
  194378. return 6;
  194379. }
  194380. p++;
  194381. a = a<<14;
  194382. a |= *p;
  194383. /* a: p2<<28 | p4<<14 | p6 (unmasked) */
  194384. if (!(a&0x80))
  194385. {
  194386. a &= SLOT_4_2_0;
  194387. b &= SLOT_2_0;
  194388. b = b<<7;
  194389. a |= b;
  194390. s = s>>11;
  194391. *v = ((u64)s)<<32 | a;
  194392. return 7;
  194393. }
  194394. /* CSE2 from below */
  194395. a &= SLOT_2_0;
  194396. p++;
  194397. b = b<<14;
  194398. b |= *p;
  194399. /* b: p3<<28 | p5<<14 | p7 (unmasked) */
  194400. if (!(b&0x80))
  194401. {
  194402. b &= SLOT_4_2_0;
  194403. /* moved CSE2 up */
  194404. /* a &= (0x7f<<14)|(0x7f); */
  194405. a = a<<7;
  194406. a |= b;
  194407. s = s>>4;
  194408. *v = ((u64)s)<<32 | a;
  194409. return 8;
  194410. }
  194411. p++;
  194412. a = a<<15;
  194413. a |= *p;
  194414. /* a: p4<<29 | p6<<15 | p8 (unmasked) */
  194415. /* moved CSE2 up */
  194416. /* a &= (0x7f<<29)|(0x7f<<15)|(0xff); */
  194417. b &= SLOT_2_0;
  194418. b = b<<8;
  194419. a |= b;
  194420. s = s<<4;
  194421. b = p[-4];
  194422. b &= 0x7f;
  194423. b = b>>3;
  194424. s |= b;
  194425. *v = ((u64)s)<<32 | a;
  194426. return 9;
  194427. }
  194428. /*
  194429. ** The variable-length integer encoding is as follows:
  194430. **
  194431. ** KEY:
  194432. ** A = 0xxxxxxx 7 bits of data and one flag bit
  194433. ** B = 1xxxxxxx 7 bits of data and one flag bit
  194434. ** C = xxxxxxxx 8 bits of data
  194435. **
  194436. ** 7 bits - A
  194437. ** 14 bits - BA
  194438. ** 21 bits - BBA
  194439. ** 28 bits - BBBA
  194440. ** 35 bits - BBBBA
  194441. ** 42 bits - BBBBBA
  194442. ** 49 bits - BBBBBBA
  194443. ** 56 bits - BBBBBBBA
  194444. ** 64 bits - BBBBBBBBC
  194445. */
  194446. #ifdef SQLITE_NOINLINE
  194447. # define FTS5_NOINLINE SQLITE_NOINLINE
  194448. #else
  194449. # define FTS5_NOINLINE
  194450. #endif
  194451. /*
  194452. ** Write a 64-bit variable-length integer to memory starting at p[0].
  194453. ** The length of data write will be between 1 and 9 bytes. The number
  194454. ** of bytes written is returned.
  194455. **
  194456. ** A variable-length integer consists of the lower 7 bits of each byte
  194457. ** for all bytes that have the 8th bit set and one byte with the 8th
  194458. ** bit clear. Except, if we get to the 9th byte, it stores the full
  194459. ** 8 bits and is the last byte.
  194460. */
  194461. static int FTS5_NOINLINE fts5PutVarint64(unsigned char *p, u64 v){
  194462. int i, j, n;
  194463. u8 buf[10];
  194464. if( v & (((u64)0xff000000)<<32) ){
  194465. p[8] = (u8)v;
  194466. v >>= 8;
  194467. for(i=7; i>=0; i--){
  194468. p[i] = (u8)((v & 0x7f) | 0x80);
  194469. v >>= 7;
  194470. }
  194471. return 9;
  194472. }
  194473. n = 0;
  194474. do{
  194475. buf[n++] = (u8)((v & 0x7f) | 0x80);
  194476. v >>= 7;
  194477. }while( v!=0 );
  194478. buf[0] &= 0x7f;
  194479. assert( n<=9 );
  194480. for(i=0, j=n-1; j>=0; j--, i++){
  194481. p[i] = buf[j];
  194482. }
  194483. return n;
  194484. }
  194485. static int sqlite3Fts5PutVarint(unsigned char *p, u64 v){
  194486. if( v<=0x7f ){
  194487. p[0] = v&0x7f;
  194488. return 1;
  194489. }
  194490. if( v<=0x3fff ){
  194491. p[0] = ((v>>7)&0x7f)|0x80;
  194492. p[1] = v&0x7f;
  194493. return 2;
  194494. }
  194495. return fts5PutVarint64(p,v);
  194496. }
  194497. static int sqlite3Fts5GetVarintLen(u32 iVal){
  194498. #if 0
  194499. if( iVal<(1 << 7 ) ) return 1;
  194500. #endif
  194501. assert( iVal>=(1 << 7) );
  194502. if( iVal<(1 << 14) ) return 2;
  194503. if( iVal<(1 << 21) ) return 3;
  194504. if( iVal<(1 << 28) ) return 4;
  194505. return 5;
  194506. }
  194507. /*
  194508. ** 2015 May 08
  194509. **
  194510. ** The author disclaims copyright to this source code. In place of
  194511. ** a legal notice, here is a blessing:
  194512. **
  194513. ** May you do good and not evil.
  194514. ** May you find forgiveness for yourself and forgive others.
  194515. ** May you share freely, never taking more than you give.
  194516. **
  194517. ******************************************************************************
  194518. **
  194519. ** This is an SQLite virtual table module implementing direct access to an
  194520. ** existing FTS5 index. The module may create several different types of
  194521. ** tables:
  194522. **
  194523. ** col:
  194524. ** CREATE TABLE vocab(term, col, doc, cnt, PRIMARY KEY(term, col));
  194525. **
  194526. ** One row for each term/column combination. The value of $doc is set to
  194527. ** the number of fts5 rows that contain at least one instance of term
  194528. ** $term within column $col. Field $cnt is set to the total number of
  194529. ** instances of term $term in column $col (in any row of the fts5 table).
  194530. **
  194531. ** row:
  194532. ** CREATE TABLE vocab(term, doc, cnt, PRIMARY KEY(term));
  194533. **
  194534. ** One row for each term in the database. The value of $doc is set to
  194535. ** the number of fts5 rows that contain at least one instance of term
  194536. ** $term. Field $cnt is set to the total number of instances of term
  194537. ** $term in the database.
  194538. **
  194539. ** instance:
  194540. ** CREATE TABLE vocab(term, doc, col, offset, PRIMARY KEY(<all-fields>));
  194541. **
  194542. ** One row for each term instance in the database.
  194543. */
  194544. /* #include "fts5Int.h" */
  194545. typedef struct Fts5VocabTable Fts5VocabTable;
  194546. typedef struct Fts5VocabCursor Fts5VocabCursor;
  194547. struct Fts5VocabTable {
  194548. sqlite3_vtab base;
  194549. char *zFts5Tbl; /* Name of fts5 table */
  194550. char *zFts5Db; /* Db containing fts5 table */
  194551. sqlite3 *db; /* Database handle */
  194552. Fts5Global *pGlobal; /* FTS5 global object for this database */
  194553. int eType; /* FTS5_VOCAB_COL, ROW or INSTANCE */
  194554. };
  194555. struct Fts5VocabCursor {
  194556. sqlite3_vtab_cursor base;
  194557. sqlite3_stmt *pStmt; /* Statement holding lock on pIndex */
  194558. Fts5Index *pIndex; /* Associated FTS5 index */
  194559. int bEof; /* True if this cursor is at EOF */
  194560. Fts5IndexIter *pIter; /* Term/rowid iterator object */
  194561. int nLeTerm; /* Size of zLeTerm in bytes */
  194562. char *zLeTerm; /* (term <= $zLeTerm) paramater, or NULL */
  194563. /* These are used by 'col' tables only */
  194564. Fts5Config *pConfig; /* Fts5 table configuration */
  194565. int iCol;
  194566. i64 *aCnt;
  194567. i64 *aDoc;
  194568. /* Output values used by all tables. */
  194569. i64 rowid; /* This table's current rowid value */
  194570. Fts5Buffer term; /* Current value of 'term' column */
  194571. /* Output values Used by 'instance' tables only */
  194572. i64 iInstPos;
  194573. int iInstOff;
  194574. };
  194575. #define FTS5_VOCAB_COL 0
  194576. #define FTS5_VOCAB_ROW 1
  194577. #define FTS5_VOCAB_INSTANCE 2
  194578. #define FTS5_VOCAB_COL_SCHEMA "term, col, doc, cnt"
  194579. #define FTS5_VOCAB_ROW_SCHEMA "term, doc, cnt"
  194580. #define FTS5_VOCAB_INST_SCHEMA "term, doc, col, offset"
  194581. /*
  194582. ** Bits for the mask used as the idxNum value by xBestIndex/xFilter.
  194583. */
  194584. #define FTS5_VOCAB_TERM_EQ 0x01
  194585. #define FTS5_VOCAB_TERM_GE 0x02
  194586. #define FTS5_VOCAB_TERM_LE 0x04
  194587. /*
  194588. ** Translate a string containing an fts5vocab table type to an
  194589. ** FTS5_VOCAB_XXX constant. If successful, set *peType to the output
  194590. ** value and return SQLITE_OK. Otherwise, set *pzErr to an error message
  194591. ** and return SQLITE_ERROR.
  194592. */
  194593. static int fts5VocabTableType(const char *zType, char **pzErr, int *peType){
  194594. int rc = SQLITE_OK;
  194595. char *zCopy = sqlite3Fts5Strndup(&rc, zType, -1);
  194596. if( rc==SQLITE_OK ){
  194597. sqlite3Fts5Dequote(zCopy);
  194598. if( sqlite3_stricmp(zCopy, "col")==0 ){
  194599. *peType = FTS5_VOCAB_COL;
  194600. }else
  194601. if( sqlite3_stricmp(zCopy, "row")==0 ){
  194602. *peType = FTS5_VOCAB_ROW;
  194603. }else
  194604. if( sqlite3_stricmp(zCopy, "instance")==0 ){
  194605. *peType = FTS5_VOCAB_INSTANCE;
  194606. }else
  194607. {
  194608. *pzErr = sqlite3_mprintf("fts5vocab: unknown table type: %Q", zCopy);
  194609. rc = SQLITE_ERROR;
  194610. }
  194611. sqlite3_free(zCopy);
  194612. }
  194613. return rc;
  194614. }
  194615. /*
  194616. ** The xDisconnect() virtual table method.
  194617. */
  194618. static int fts5VocabDisconnectMethod(sqlite3_vtab *pVtab){
  194619. Fts5VocabTable *pTab = (Fts5VocabTable*)pVtab;
  194620. sqlite3_free(pTab);
  194621. return SQLITE_OK;
  194622. }
  194623. /*
  194624. ** The xDestroy() virtual table method.
  194625. */
  194626. static int fts5VocabDestroyMethod(sqlite3_vtab *pVtab){
  194627. Fts5VocabTable *pTab = (Fts5VocabTable*)pVtab;
  194628. sqlite3_free(pTab);
  194629. return SQLITE_OK;
  194630. }
  194631. /*
  194632. ** This function is the implementation of both the xConnect and xCreate
  194633. ** methods of the FTS3 virtual table.
  194634. **
  194635. ** The argv[] array contains the following:
  194636. **
  194637. ** argv[0] -> module name ("fts5vocab")
  194638. ** argv[1] -> database name
  194639. ** argv[2] -> table name
  194640. **
  194641. ** then:
  194642. **
  194643. ** argv[3] -> name of fts5 table
  194644. ** argv[4] -> type of fts5vocab table
  194645. **
  194646. ** or, for tables in the TEMP schema only.
  194647. **
  194648. ** argv[3] -> name of fts5 tables database
  194649. ** argv[4] -> name of fts5 table
  194650. ** argv[5] -> type of fts5vocab table
  194651. */
  194652. static int fts5VocabInitVtab(
  194653. sqlite3 *db, /* The SQLite database connection */
  194654. void *pAux, /* Pointer to Fts5Global object */
  194655. int argc, /* Number of elements in argv array */
  194656. const char * const *argv, /* xCreate/xConnect argument array */
  194657. sqlite3_vtab **ppVTab, /* Write the resulting vtab structure here */
  194658. char **pzErr /* Write any error message here */
  194659. ){
  194660. const char *azSchema[] = {
  194661. "CREATE TABlE vocab(" FTS5_VOCAB_COL_SCHEMA ")",
  194662. "CREATE TABlE vocab(" FTS5_VOCAB_ROW_SCHEMA ")",
  194663. "CREATE TABlE vocab(" FTS5_VOCAB_INST_SCHEMA ")"
  194664. };
  194665. Fts5VocabTable *pRet = 0;
  194666. int rc = SQLITE_OK; /* Return code */
  194667. int bDb;
  194668. bDb = (argc==6 && strlen(argv[1])==4 && memcmp("temp", argv[1], 4)==0);
  194669. if( argc!=5 && bDb==0 ){
  194670. *pzErr = sqlite3_mprintf("wrong number of vtable arguments");
  194671. rc = SQLITE_ERROR;
  194672. }else{
  194673. int nByte; /* Bytes of space to allocate */
  194674. const char *zDb = bDb ? argv[3] : argv[1];
  194675. const char *zTab = bDb ? argv[4] : argv[3];
  194676. const char *zType = bDb ? argv[5] : argv[4];
  194677. int nDb = (int)strlen(zDb)+1;
  194678. int nTab = (int)strlen(zTab)+1;
  194679. int eType = 0;
  194680. rc = fts5VocabTableType(zType, pzErr, &eType);
  194681. if( rc==SQLITE_OK ){
  194682. assert( eType>=0 && eType<ArraySize(azSchema) );
  194683. rc = sqlite3_declare_vtab(db, azSchema[eType]);
  194684. }
  194685. nByte = sizeof(Fts5VocabTable) + nDb + nTab;
  194686. pRet = sqlite3Fts5MallocZero(&rc, nByte);
  194687. if( pRet ){
  194688. pRet->pGlobal = (Fts5Global*)pAux;
  194689. pRet->eType = eType;
  194690. pRet->db = db;
  194691. pRet->zFts5Tbl = (char*)&pRet[1];
  194692. pRet->zFts5Db = &pRet->zFts5Tbl[nTab];
  194693. memcpy(pRet->zFts5Tbl, zTab, nTab);
  194694. memcpy(pRet->zFts5Db, zDb, nDb);
  194695. sqlite3Fts5Dequote(pRet->zFts5Tbl);
  194696. sqlite3Fts5Dequote(pRet->zFts5Db);
  194697. }
  194698. }
  194699. *ppVTab = (sqlite3_vtab*)pRet;
  194700. return rc;
  194701. }
  194702. /*
  194703. ** The xConnect() and xCreate() methods for the virtual table. All the
  194704. ** work is done in function fts5VocabInitVtab().
  194705. */
  194706. static int fts5VocabConnectMethod(
  194707. sqlite3 *db, /* Database connection */
  194708. void *pAux, /* Pointer to tokenizer hash table */
  194709. int argc, /* Number of elements in argv array */
  194710. const char * const *argv, /* xCreate/xConnect argument array */
  194711. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  194712. char **pzErr /* OUT: sqlite3_malloc'd error message */
  194713. ){
  194714. return fts5VocabInitVtab(db, pAux, argc, argv, ppVtab, pzErr);
  194715. }
  194716. static int fts5VocabCreateMethod(
  194717. sqlite3 *db, /* Database connection */
  194718. void *pAux, /* Pointer to tokenizer hash table */
  194719. int argc, /* Number of elements in argv array */
  194720. const char * const *argv, /* xCreate/xConnect argument array */
  194721. sqlite3_vtab **ppVtab, /* OUT: New sqlite3_vtab object */
  194722. char **pzErr /* OUT: sqlite3_malloc'd error message */
  194723. ){
  194724. return fts5VocabInitVtab(db, pAux, argc, argv, ppVtab, pzErr);
  194725. }
  194726. /*
  194727. ** Implementation of the xBestIndex method.
  194728. **
  194729. ** Only constraints of the form:
  194730. **
  194731. ** term <= ?
  194732. ** term == ?
  194733. ** term >= ?
  194734. **
  194735. ** are interpreted. Less-than and less-than-or-equal are treated
  194736. ** identically, as are greater-than and greater-than-or-equal.
  194737. */
  194738. static int fts5VocabBestIndexMethod(
  194739. sqlite3_vtab *pUnused,
  194740. sqlite3_index_info *pInfo
  194741. ){
  194742. int i;
  194743. int iTermEq = -1;
  194744. int iTermGe = -1;
  194745. int iTermLe = -1;
  194746. int idxNum = 0;
  194747. int nArg = 0;
  194748. UNUSED_PARAM(pUnused);
  194749. for(i=0; i<pInfo->nConstraint; i++){
  194750. struct sqlite3_index_constraint *p = &pInfo->aConstraint[i];
  194751. if( p->usable==0 ) continue;
  194752. if( p->iColumn==0 ){ /* term column */
  194753. if( p->op==SQLITE_INDEX_CONSTRAINT_EQ ) iTermEq = i;
  194754. if( p->op==SQLITE_INDEX_CONSTRAINT_LE ) iTermLe = i;
  194755. if( p->op==SQLITE_INDEX_CONSTRAINT_LT ) iTermLe = i;
  194756. if( p->op==SQLITE_INDEX_CONSTRAINT_GE ) iTermGe = i;
  194757. if( p->op==SQLITE_INDEX_CONSTRAINT_GT ) iTermGe = i;
  194758. }
  194759. }
  194760. if( iTermEq>=0 ){
  194761. idxNum |= FTS5_VOCAB_TERM_EQ;
  194762. pInfo->aConstraintUsage[iTermEq].argvIndex = ++nArg;
  194763. pInfo->estimatedCost = 100;
  194764. }else{
  194765. pInfo->estimatedCost = 1000000;
  194766. if( iTermGe>=0 ){
  194767. idxNum |= FTS5_VOCAB_TERM_GE;
  194768. pInfo->aConstraintUsage[iTermGe].argvIndex = ++nArg;
  194769. pInfo->estimatedCost = pInfo->estimatedCost / 2;
  194770. }
  194771. if( iTermLe>=0 ){
  194772. idxNum |= FTS5_VOCAB_TERM_LE;
  194773. pInfo->aConstraintUsage[iTermLe].argvIndex = ++nArg;
  194774. pInfo->estimatedCost = pInfo->estimatedCost / 2;
  194775. }
  194776. }
  194777. /* This virtual table always delivers results in ascending order of
  194778. ** the "term" column (column 0). So if the user has requested this
  194779. ** specifically - "ORDER BY term" or "ORDER BY term ASC" - set the
  194780. ** sqlite3_index_info.orderByConsumed flag to tell the core the results
  194781. ** are already in sorted order. */
  194782. if( pInfo->nOrderBy==1
  194783. && pInfo->aOrderBy[0].iColumn==0
  194784. && pInfo->aOrderBy[0].desc==0
  194785. ){
  194786. pInfo->orderByConsumed = 1;
  194787. }
  194788. pInfo->idxNum = idxNum;
  194789. return SQLITE_OK;
  194790. }
  194791. /*
  194792. ** Implementation of xOpen method.
  194793. */
  194794. static int fts5VocabOpenMethod(
  194795. sqlite3_vtab *pVTab,
  194796. sqlite3_vtab_cursor **ppCsr
  194797. ){
  194798. Fts5VocabTable *pTab = (Fts5VocabTable*)pVTab;
  194799. Fts5Index *pIndex = 0;
  194800. Fts5Config *pConfig = 0;
  194801. Fts5VocabCursor *pCsr = 0;
  194802. int rc = SQLITE_OK;
  194803. sqlite3_stmt *pStmt = 0;
  194804. char *zSql = 0;
  194805. zSql = sqlite3Fts5Mprintf(&rc,
  194806. "SELECT t.%Q FROM %Q.%Q AS t WHERE t.%Q MATCH '*id'",
  194807. pTab->zFts5Tbl, pTab->zFts5Db, pTab->zFts5Tbl, pTab->zFts5Tbl
  194808. );
  194809. if( zSql ){
  194810. rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pStmt, 0);
  194811. }
  194812. sqlite3_free(zSql);
  194813. assert( rc==SQLITE_OK || pStmt==0 );
  194814. if( rc==SQLITE_ERROR ) rc = SQLITE_OK;
  194815. if( pStmt && sqlite3_step(pStmt)==SQLITE_ROW ){
  194816. i64 iId = sqlite3_column_int64(pStmt, 0);
  194817. pIndex = sqlite3Fts5IndexFromCsrid(pTab->pGlobal, iId, &pConfig);
  194818. }
  194819. if( rc==SQLITE_OK && pIndex==0 ){
  194820. rc = sqlite3_finalize(pStmt);
  194821. pStmt = 0;
  194822. if( rc==SQLITE_OK ){
  194823. pVTab->zErrMsg = sqlite3_mprintf(
  194824. "no such fts5 table: %s.%s", pTab->zFts5Db, pTab->zFts5Tbl
  194825. );
  194826. rc = SQLITE_ERROR;
  194827. }
  194828. }
  194829. if( rc==SQLITE_OK ){
  194830. int nByte = pConfig->nCol * sizeof(i64) * 2 + sizeof(Fts5VocabCursor);
  194831. pCsr = (Fts5VocabCursor*)sqlite3Fts5MallocZero(&rc, nByte);
  194832. }
  194833. if( pCsr ){
  194834. pCsr->pIndex = pIndex;
  194835. pCsr->pStmt = pStmt;
  194836. pCsr->pConfig = pConfig;
  194837. pCsr->aCnt = (i64*)&pCsr[1];
  194838. pCsr->aDoc = &pCsr->aCnt[pConfig->nCol];
  194839. }else{
  194840. sqlite3_finalize(pStmt);
  194841. }
  194842. *ppCsr = (sqlite3_vtab_cursor*)pCsr;
  194843. return rc;
  194844. }
  194845. static void fts5VocabResetCursor(Fts5VocabCursor *pCsr){
  194846. pCsr->rowid = 0;
  194847. sqlite3Fts5IterClose(pCsr->pIter);
  194848. pCsr->pIter = 0;
  194849. sqlite3_free(pCsr->zLeTerm);
  194850. pCsr->nLeTerm = -1;
  194851. pCsr->zLeTerm = 0;
  194852. }
  194853. /*
  194854. ** Close the cursor. For additional information see the documentation
  194855. ** on the xClose method of the virtual table interface.
  194856. */
  194857. static int fts5VocabCloseMethod(sqlite3_vtab_cursor *pCursor){
  194858. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  194859. fts5VocabResetCursor(pCsr);
  194860. sqlite3Fts5BufferFree(&pCsr->term);
  194861. sqlite3_finalize(pCsr->pStmt);
  194862. sqlite3_free(pCsr);
  194863. return SQLITE_OK;
  194864. }
  194865. static int fts5VocabInstanceNewTerm(Fts5VocabCursor *pCsr){
  194866. int rc = SQLITE_OK;
  194867. if( sqlite3Fts5IterEof(pCsr->pIter) ){
  194868. pCsr->bEof = 1;
  194869. }else{
  194870. const char *zTerm;
  194871. int nTerm;
  194872. zTerm = sqlite3Fts5IterTerm(pCsr->pIter, &nTerm);
  194873. if( pCsr->nLeTerm>=0 ){
  194874. int nCmp = MIN(nTerm, pCsr->nLeTerm);
  194875. int bCmp = memcmp(pCsr->zLeTerm, zTerm, nCmp);
  194876. if( bCmp<0 || (bCmp==0 && pCsr->nLeTerm<nTerm) ){
  194877. pCsr->bEof = 1;
  194878. }
  194879. }
  194880. sqlite3Fts5BufferSet(&rc, &pCsr->term, nTerm, (const u8*)zTerm);
  194881. }
  194882. return rc;
  194883. }
  194884. static int fts5VocabInstanceNext(Fts5VocabCursor *pCsr){
  194885. int eDetail = pCsr->pConfig->eDetail;
  194886. int rc = SQLITE_OK;
  194887. Fts5IndexIter *pIter = pCsr->pIter;
  194888. i64 *pp = &pCsr->iInstPos;
  194889. int *po = &pCsr->iInstOff;
  194890. while( eDetail==FTS5_DETAIL_NONE
  194891. || sqlite3Fts5PoslistNext64(pIter->pData, pIter->nData, po, pp)
  194892. ){
  194893. pCsr->iInstPos = 0;
  194894. pCsr->iInstOff = 0;
  194895. rc = sqlite3Fts5IterNextScan(pCsr->pIter);
  194896. if( rc==SQLITE_OK ){
  194897. rc = fts5VocabInstanceNewTerm(pCsr);
  194898. if( eDetail==FTS5_DETAIL_NONE ) break;
  194899. }
  194900. if( rc ){
  194901. pCsr->bEof = 1;
  194902. break;
  194903. }
  194904. }
  194905. return rc;
  194906. }
  194907. /*
  194908. ** Advance the cursor to the next row in the table.
  194909. */
  194910. static int fts5VocabNextMethod(sqlite3_vtab_cursor *pCursor){
  194911. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  194912. Fts5VocabTable *pTab = (Fts5VocabTable*)pCursor->pVtab;
  194913. int rc = SQLITE_OK;
  194914. int nCol = pCsr->pConfig->nCol;
  194915. pCsr->rowid++;
  194916. if( pTab->eType==FTS5_VOCAB_INSTANCE ){
  194917. return fts5VocabInstanceNext(pCsr);
  194918. }
  194919. if( pTab->eType==FTS5_VOCAB_COL ){
  194920. for(pCsr->iCol++; pCsr->iCol<nCol; pCsr->iCol++){
  194921. if( pCsr->aDoc[pCsr->iCol] ) break;
  194922. }
  194923. }
  194924. if( pTab->eType!=FTS5_VOCAB_COL || pCsr->iCol>=nCol ){
  194925. if( sqlite3Fts5IterEof(pCsr->pIter) ){
  194926. pCsr->bEof = 1;
  194927. }else{
  194928. const char *zTerm;
  194929. int nTerm;
  194930. zTerm = sqlite3Fts5IterTerm(pCsr->pIter, &nTerm);
  194931. if( pCsr->nLeTerm>=0 ){
  194932. int nCmp = MIN(nTerm, pCsr->nLeTerm);
  194933. int bCmp = memcmp(pCsr->zLeTerm, zTerm, nCmp);
  194934. if( bCmp<0 || (bCmp==0 && pCsr->nLeTerm<nTerm) ){
  194935. pCsr->bEof = 1;
  194936. return SQLITE_OK;
  194937. }
  194938. }
  194939. sqlite3Fts5BufferSet(&rc, &pCsr->term, nTerm, (const u8*)zTerm);
  194940. memset(pCsr->aCnt, 0, nCol * sizeof(i64));
  194941. memset(pCsr->aDoc, 0, nCol * sizeof(i64));
  194942. pCsr->iCol = 0;
  194943. assert( pTab->eType==FTS5_VOCAB_COL || pTab->eType==FTS5_VOCAB_ROW );
  194944. while( rc==SQLITE_OK ){
  194945. int eDetail = pCsr->pConfig->eDetail;
  194946. const u8 *pPos; int nPos; /* Position list */
  194947. i64 iPos = 0; /* 64-bit position read from poslist */
  194948. int iOff = 0; /* Current offset within position list */
  194949. pPos = pCsr->pIter->pData;
  194950. nPos = pCsr->pIter->nData;
  194951. switch( pTab->eType ){
  194952. case FTS5_VOCAB_ROW:
  194953. if( eDetail==FTS5_DETAIL_FULL ){
  194954. while( 0==sqlite3Fts5PoslistNext64(pPos, nPos, &iOff, &iPos) ){
  194955. pCsr->aCnt[0]++;
  194956. }
  194957. }
  194958. pCsr->aDoc[0]++;
  194959. break;
  194960. case FTS5_VOCAB_COL:
  194961. if( eDetail==FTS5_DETAIL_FULL ){
  194962. int iCol = -1;
  194963. while( 0==sqlite3Fts5PoslistNext64(pPos, nPos, &iOff, &iPos) ){
  194964. int ii = FTS5_POS2COLUMN(iPos);
  194965. pCsr->aCnt[ii]++;
  194966. if( iCol!=ii ){
  194967. if( ii>=nCol ){
  194968. rc = FTS5_CORRUPT;
  194969. break;
  194970. }
  194971. pCsr->aDoc[ii]++;
  194972. iCol = ii;
  194973. }
  194974. }
  194975. }else if( eDetail==FTS5_DETAIL_COLUMNS ){
  194976. while( 0==sqlite3Fts5PoslistNext64(pPos, nPos, &iOff,&iPos) ){
  194977. assert_nc( iPos>=0 && iPos<nCol );
  194978. if( iPos>=nCol ){
  194979. rc = FTS5_CORRUPT;
  194980. break;
  194981. }
  194982. pCsr->aDoc[iPos]++;
  194983. }
  194984. }else{
  194985. assert( eDetail==FTS5_DETAIL_NONE );
  194986. pCsr->aDoc[0]++;
  194987. }
  194988. break;
  194989. default:
  194990. assert( pTab->eType==FTS5_VOCAB_INSTANCE );
  194991. break;
  194992. }
  194993. if( rc==SQLITE_OK ){
  194994. rc = sqlite3Fts5IterNextScan(pCsr->pIter);
  194995. }
  194996. if( pTab->eType==FTS5_VOCAB_INSTANCE ) break;
  194997. if( rc==SQLITE_OK ){
  194998. zTerm = sqlite3Fts5IterTerm(pCsr->pIter, &nTerm);
  194999. if( nTerm!=pCsr->term.n || memcmp(zTerm, pCsr->term.p, nTerm) ){
  195000. break;
  195001. }
  195002. if( sqlite3Fts5IterEof(pCsr->pIter) ) break;
  195003. }
  195004. }
  195005. }
  195006. }
  195007. if( rc==SQLITE_OK && pCsr->bEof==0 && pTab->eType==FTS5_VOCAB_COL ){
  195008. while( pCsr->aDoc[pCsr->iCol]==0 ) pCsr->iCol++;
  195009. assert( pCsr->iCol<pCsr->pConfig->nCol );
  195010. }
  195011. return rc;
  195012. }
  195013. /*
  195014. ** This is the xFilter implementation for the virtual table.
  195015. */
  195016. static int fts5VocabFilterMethod(
  195017. sqlite3_vtab_cursor *pCursor, /* The cursor used for this query */
  195018. int idxNum, /* Strategy index */
  195019. const char *zUnused, /* Unused */
  195020. int nUnused, /* Number of elements in apVal */
  195021. sqlite3_value **apVal /* Arguments for the indexing scheme */
  195022. ){
  195023. Fts5VocabTable *pTab = (Fts5VocabTable*)pCursor->pVtab;
  195024. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  195025. int eType = pTab->eType;
  195026. int rc = SQLITE_OK;
  195027. int iVal = 0;
  195028. int f = FTS5INDEX_QUERY_SCAN;
  195029. const char *zTerm = 0;
  195030. int nTerm = 0;
  195031. sqlite3_value *pEq = 0;
  195032. sqlite3_value *pGe = 0;
  195033. sqlite3_value *pLe = 0;
  195034. UNUSED_PARAM2(zUnused, nUnused);
  195035. fts5VocabResetCursor(pCsr);
  195036. if( idxNum & FTS5_VOCAB_TERM_EQ ) pEq = apVal[iVal++];
  195037. if( idxNum & FTS5_VOCAB_TERM_GE ) pGe = apVal[iVal++];
  195038. if( idxNum & FTS5_VOCAB_TERM_LE ) pLe = apVal[iVal++];
  195039. if( pEq ){
  195040. zTerm = (const char *)sqlite3_value_text(pEq);
  195041. nTerm = sqlite3_value_bytes(pEq);
  195042. f = 0;
  195043. }else{
  195044. if( pGe ){
  195045. zTerm = (const char *)sqlite3_value_text(pGe);
  195046. nTerm = sqlite3_value_bytes(pGe);
  195047. }
  195048. if( pLe ){
  195049. const char *zCopy = (const char *)sqlite3_value_text(pLe);
  195050. pCsr->nLeTerm = sqlite3_value_bytes(pLe);
  195051. pCsr->zLeTerm = sqlite3_malloc(pCsr->nLeTerm+1);
  195052. if( pCsr->zLeTerm==0 ){
  195053. rc = SQLITE_NOMEM;
  195054. }else{
  195055. memcpy(pCsr->zLeTerm, zCopy, pCsr->nLeTerm+1);
  195056. }
  195057. }
  195058. }
  195059. if( rc==SQLITE_OK ){
  195060. rc = sqlite3Fts5IndexQuery(pCsr->pIndex, zTerm, nTerm, f, 0, &pCsr->pIter);
  195061. }
  195062. if( rc==SQLITE_OK && eType==FTS5_VOCAB_INSTANCE ){
  195063. rc = fts5VocabInstanceNewTerm(pCsr);
  195064. }
  195065. if( rc==SQLITE_OK
  195066. && !pCsr->bEof
  195067. && (eType!=FTS5_VOCAB_INSTANCE || pCsr->pConfig->eDetail!=FTS5_DETAIL_NONE)
  195068. ){
  195069. rc = fts5VocabNextMethod(pCursor);
  195070. }
  195071. return rc;
  195072. }
  195073. /*
  195074. ** This is the xEof method of the virtual table. SQLite calls this
  195075. ** routine to find out if it has reached the end of a result set.
  195076. */
  195077. static int fts5VocabEofMethod(sqlite3_vtab_cursor *pCursor){
  195078. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  195079. return pCsr->bEof;
  195080. }
  195081. static int fts5VocabColumnMethod(
  195082. sqlite3_vtab_cursor *pCursor, /* Cursor to retrieve value from */
  195083. sqlite3_context *pCtx, /* Context for sqlite3_result_xxx() calls */
  195084. int iCol /* Index of column to read value from */
  195085. ){
  195086. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  195087. int eDetail = pCsr->pConfig->eDetail;
  195088. int eType = ((Fts5VocabTable*)(pCursor->pVtab))->eType;
  195089. i64 iVal = 0;
  195090. if( iCol==0 ){
  195091. sqlite3_result_text(
  195092. pCtx, (const char*)pCsr->term.p, pCsr->term.n, SQLITE_TRANSIENT
  195093. );
  195094. }else if( eType==FTS5_VOCAB_COL ){
  195095. assert( iCol==1 || iCol==2 || iCol==3 );
  195096. if( iCol==1 ){
  195097. if( eDetail!=FTS5_DETAIL_NONE ){
  195098. const char *z = pCsr->pConfig->azCol[pCsr->iCol];
  195099. sqlite3_result_text(pCtx, z, -1, SQLITE_STATIC);
  195100. }
  195101. }else if( iCol==2 ){
  195102. iVal = pCsr->aDoc[pCsr->iCol];
  195103. }else{
  195104. iVal = pCsr->aCnt[pCsr->iCol];
  195105. }
  195106. }else if( eType==FTS5_VOCAB_ROW ){
  195107. assert( iCol==1 || iCol==2 );
  195108. if( iCol==1 ){
  195109. iVal = pCsr->aDoc[0];
  195110. }else{
  195111. iVal = pCsr->aCnt[0];
  195112. }
  195113. }else{
  195114. assert( eType==FTS5_VOCAB_INSTANCE );
  195115. switch( iCol ){
  195116. case 1:
  195117. sqlite3_result_int64(pCtx, pCsr->pIter->iRowid);
  195118. break;
  195119. case 2: {
  195120. int ii = -1;
  195121. if( eDetail==FTS5_DETAIL_FULL ){
  195122. ii = FTS5_POS2COLUMN(pCsr->iInstPos);
  195123. }else if( eDetail==FTS5_DETAIL_COLUMNS ){
  195124. ii = (int)pCsr->iInstPos;
  195125. }
  195126. if( ii>=0 && ii<pCsr->pConfig->nCol ){
  195127. const char *z = pCsr->pConfig->azCol[ii];
  195128. sqlite3_result_text(pCtx, z, -1, SQLITE_STATIC);
  195129. }
  195130. break;
  195131. }
  195132. default: {
  195133. assert( iCol==3 );
  195134. if( eDetail==FTS5_DETAIL_FULL ){
  195135. int ii = FTS5_POS2OFFSET(pCsr->iInstPos);
  195136. sqlite3_result_int(pCtx, ii);
  195137. }
  195138. break;
  195139. }
  195140. }
  195141. }
  195142. if( iVal>0 ) sqlite3_result_int64(pCtx, iVal);
  195143. return SQLITE_OK;
  195144. }
  195145. /*
  195146. ** This is the xRowid method. The SQLite core calls this routine to
  195147. ** retrieve the rowid for the current row of the result set. The
  195148. ** rowid should be written to *pRowid.
  195149. */
  195150. static int fts5VocabRowidMethod(
  195151. sqlite3_vtab_cursor *pCursor,
  195152. sqlite_int64 *pRowid
  195153. ){
  195154. Fts5VocabCursor *pCsr = (Fts5VocabCursor*)pCursor;
  195155. *pRowid = pCsr->rowid;
  195156. return SQLITE_OK;
  195157. }
  195158. static int sqlite3Fts5VocabInit(Fts5Global *pGlobal, sqlite3 *db){
  195159. static const sqlite3_module fts5Vocab = {
  195160. /* iVersion */ 2,
  195161. /* xCreate */ fts5VocabCreateMethod,
  195162. /* xConnect */ fts5VocabConnectMethod,
  195163. /* xBestIndex */ fts5VocabBestIndexMethod,
  195164. /* xDisconnect */ fts5VocabDisconnectMethod,
  195165. /* xDestroy */ fts5VocabDestroyMethod,
  195166. /* xOpen */ fts5VocabOpenMethod,
  195167. /* xClose */ fts5VocabCloseMethod,
  195168. /* xFilter */ fts5VocabFilterMethod,
  195169. /* xNext */ fts5VocabNextMethod,
  195170. /* xEof */ fts5VocabEofMethod,
  195171. /* xColumn */ fts5VocabColumnMethod,
  195172. /* xRowid */ fts5VocabRowidMethod,
  195173. /* xUpdate */ 0,
  195174. /* xBegin */ 0,
  195175. /* xSync */ 0,
  195176. /* xCommit */ 0,
  195177. /* xRollback */ 0,
  195178. /* xFindFunction */ 0,
  195179. /* xRename */ 0,
  195180. /* xSavepoint */ 0,
  195181. /* xRelease */ 0,
  195182. /* xRollbackTo */ 0,
  195183. };
  195184. void *p = (void*)pGlobal;
  195185. return sqlite3_create_module_v2(db, "fts5vocab", &fts5Vocab, p, 0);
  195186. }
  195187. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS5) */
  195188. /************** End of fts5.c ************************************************/
  195189. /************** Begin file stmt.c ********************************************/
  195190. /*
  195191. ** 2017-05-31
  195192. **
  195193. ** The author disclaims copyright to this source code. In place of
  195194. ** a legal notice, here is a blessing:
  195195. **
  195196. ** May you do good and not evil.
  195197. ** May you find forgiveness for yourself and forgive others.
  195198. ** May you share freely, never taking more than you give.
  195199. **
  195200. *************************************************************************
  195201. **
  195202. ** This file demonstrates an eponymous virtual table that returns information
  195203. ** about all prepared statements for the database connection.
  195204. **
  195205. ** Usage example:
  195206. **
  195207. ** .load ./stmt
  195208. ** .mode line
  195209. ** .header on
  195210. ** SELECT * FROM stmt;
  195211. */
  195212. #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_STMTVTAB)
  195213. #if !defined(SQLITEINT_H)
  195214. /* #include "sqlite3ext.h" */
  195215. #endif
  195216. SQLITE_EXTENSION_INIT1
  195217. /* #include <assert.h> */
  195218. /* #include <string.h> */
  195219. #ifndef SQLITE_OMIT_VIRTUALTABLE
  195220. /* stmt_vtab is a subclass of sqlite3_vtab which will
  195221. ** serve as the underlying representation of a stmt virtual table
  195222. */
  195223. typedef struct stmt_vtab stmt_vtab;
  195224. struct stmt_vtab {
  195225. sqlite3_vtab base; /* Base class - must be first */
  195226. sqlite3 *db; /* Database connection for this stmt vtab */
  195227. };
  195228. /* stmt_cursor is a subclass of sqlite3_vtab_cursor which will
  195229. ** serve as the underlying representation of a cursor that scans
  195230. ** over rows of the result
  195231. */
  195232. typedef struct stmt_cursor stmt_cursor;
  195233. struct stmt_cursor {
  195234. sqlite3_vtab_cursor base; /* Base class - must be first */
  195235. sqlite3 *db; /* Database connection for this cursor */
  195236. sqlite3_stmt *pStmt; /* Statement cursor is currently pointing at */
  195237. sqlite3_int64 iRowid; /* The rowid */
  195238. };
  195239. /*
  195240. ** The stmtConnect() method is invoked to create a new
  195241. ** stmt_vtab that describes the stmt virtual table.
  195242. **
  195243. ** Think of this routine as the constructor for stmt_vtab objects.
  195244. **
  195245. ** All this routine needs to do is:
  195246. **
  195247. ** (1) Allocate the stmt_vtab object and initialize all fields.
  195248. **
  195249. ** (2) Tell SQLite (via the sqlite3_declare_vtab() interface) what the
  195250. ** result set of queries against stmt will look like.
  195251. */
  195252. static int stmtConnect(
  195253. sqlite3 *db,
  195254. void *pAux,
  195255. int argc, const char *const*argv,
  195256. sqlite3_vtab **ppVtab,
  195257. char **pzErr
  195258. ){
  195259. stmt_vtab *pNew;
  195260. int rc;
  195261. /* Column numbers */
  195262. #define STMT_COLUMN_SQL 0 /* SQL for the statement */
  195263. #define STMT_COLUMN_NCOL 1 /* Number of result columns */
  195264. #define STMT_COLUMN_RO 2 /* True if read-only */
  195265. #define STMT_COLUMN_BUSY 3 /* True if currently busy */
  195266. #define STMT_COLUMN_NSCAN 4 /* SQLITE_STMTSTATUS_FULLSCAN_STEP */
  195267. #define STMT_COLUMN_NSORT 5 /* SQLITE_STMTSTATUS_SORT */
  195268. #define STMT_COLUMN_NAIDX 6 /* SQLITE_STMTSTATUS_AUTOINDEX */
  195269. #define STMT_COLUMN_NSTEP 7 /* SQLITE_STMTSTATUS_VM_STEP */
  195270. #define STMT_COLUMN_REPREP 8 /* SQLITE_STMTSTATUS_REPREPARE */
  195271. #define STMT_COLUMN_RUN 9 /* SQLITE_STMTSTATUS_RUN */
  195272. #define STMT_COLUMN_MEM 10 /* SQLITE_STMTSTATUS_MEMUSED */
  195273. rc = sqlite3_declare_vtab(db,
  195274. "CREATE TABLE x(sql,ncol,ro,busy,nscan,nsort,naidx,nstep,"
  195275. "reprep,run,mem)");
  195276. if( rc==SQLITE_OK ){
  195277. pNew = sqlite3_malloc( sizeof(*pNew) );
  195278. *ppVtab = (sqlite3_vtab*)pNew;
  195279. if( pNew==0 ) return SQLITE_NOMEM;
  195280. memset(pNew, 0, sizeof(*pNew));
  195281. pNew->db = db;
  195282. }
  195283. return rc;
  195284. }
  195285. /*
  195286. ** This method is the destructor for stmt_cursor objects.
  195287. */
  195288. static int stmtDisconnect(sqlite3_vtab *pVtab){
  195289. sqlite3_free(pVtab);
  195290. return SQLITE_OK;
  195291. }
  195292. /*
  195293. ** Constructor for a new stmt_cursor object.
  195294. */
  195295. static int stmtOpen(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){
  195296. stmt_cursor *pCur;
  195297. pCur = sqlite3_malloc( sizeof(*pCur) );
  195298. if( pCur==0 ) return SQLITE_NOMEM;
  195299. memset(pCur, 0, sizeof(*pCur));
  195300. pCur->db = ((stmt_vtab*)p)->db;
  195301. *ppCursor = &pCur->base;
  195302. return SQLITE_OK;
  195303. }
  195304. /*
  195305. ** Destructor for a stmt_cursor.
  195306. */
  195307. static int stmtClose(sqlite3_vtab_cursor *cur){
  195308. sqlite3_free(cur);
  195309. return SQLITE_OK;
  195310. }
  195311. /*
  195312. ** Advance a stmt_cursor to its next row of output.
  195313. */
  195314. static int stmtNext(sqlite3_vtab_cursor *cur){
  195315. stmt_cursor *pCur = (stmt_cursor*)cur;
  195316. pCur->iRowid++;
  195317. pCur->pStmt = sqlite3_next_stmt(pCur->db, pCur->pStmt);
  195318. return SQLITE_OK;
  195319. }
  195320. /*
  195321. ** Return values of columns for the row at which the stmt_cursor
  195322. ** is currently pointing.
  195323. */
  195324. static int stmtColumn(
  195325. sqlite3_vtab_cursor *cur, /* The cursor */
  195326. sqlite3_context *ctx, /* First argument to sqlite3_result_...() */
  195327. int i /* Which column to return */
  195328. ){
  195329. stmt_cursor *pCur = (stmt_cursor*)cur;
  195330. switch( i ){
  195331. case STMT_COLUMN_SQL: {
  195332. sqlite3_result_text(ctx, sqlite3_sql(pCur->pStmt), -1, SQLITE_TRANSIENT);
  195333. break;
  195334. }
  195335. case STMT_COLUMN_NCOL: {
  195336. sqlite3_result_int(ctx, sqlite3_column_count(pCur->pStmt));
  195337. break;
  195338. }
  195339. case STMT_COLUMN_RO: {
  195340. sqlite3_result_int(ctx, sqlite3_stmt_readonly(pCur->pStmt));
  195341. break;
  195342. }
  195343. case STMT_COLUMN_BUSY: {
  195344. sqlite3_result_int(ctx, sqlite3_stmt_busy(pCur->pStmt));
  195345. break;
  195346. }
  195347. case STMT_COLUMN_MEM: {
  195348. i = SQLITE_STMTSTATUS_MEMUSED +
  195349. STMT_COLUMN_NSCAN - SQLITE_STMTSTATUS_FULLSCAN_STEP;
  195350. /* Fall thru */
  195351. }
  195352. case STMT_COLUMN_NSCAN:
  195353. case STMT_COLUMN_NSORT:
  195354. case STMT_COLUMN_NAIDX:
  195355. case STMT_COLUMN_NSTEP:
  195356. case STMT_COLUMN_REPREP:
  195357. case STMT_COLUMN_RUN: {
  195358. sqlite3_result_int(ctx, sqlite3_stmt_status(pCur->pStmt,
  195359. i-STMT_COLUMN_NSCAN+SQLITE_STMTSTATUS_FULLSCAN_STEP, 0));
  195360. break;
  195361. }
  195362. }
  195363. return SQLITE_OK;
  195364. }
  195365. /*
  195366. ** Return the rowid for the current row. In this implementation, the
  195367. ** rowid is the same as the output value.
  195368. */
  195369. static int stmtRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){
  195370. stmt_cursor *pCur = (stmt_cursor*)cur;
  195371. *pRowid = pCur->iRowid;
  195372. return SQLITE_OK;
  195373. }
  195374. /*
  195375. ** Return TRUE if the cursor has been moved off of the last
  195376. ** row of output.
  195377. */
  195378. static int stmtEof(sqlite3_vtab_cursor *cur){
  195379. stmt_cursor *pCur = (stmt_cursor*)cur;
  195380. return pCur->pStmt==0;
  195381. }
  195382. /*
  195383. ** This method is called to "rewind" the stmt_cursor object back
  195384. ** to the first row of output. This method is always called at least
  195385. ** once prior to any call to stmtColumn() or stmtRowid() or
  195386. ** stmtEof().
  195387. */
  195388. static int stmtFilter(
  195389. sqlite3_vtab_cursor *pVtabCursor,
  195390. int idxNum, const char *idxStr,
  195391. int argc, sqlite3_value **argv
  195392. ){
  195393. stmt_cursor *pCur = (stmt_cursor *)pVtabCursor;
  195394. pCur->pStmt = 0;
  195395. pCur->iRowid = 0;
  195396. return stmtNext(pVtabCursor);
  195397. }
  195398. /*
  195399. ** SQLite will invoke this method one or more times while planning a query
  195400. ** that uses the stmt virtual table. This routine needs to create
  195401. ** a query plan for each invocation and compute an estimated cost for that
  195402. ** plan.
  195403. */
  195404. static int stmtBestIndex(
  195405. sqlite3_vtab *tab,
  195406. sqlite3_index_info *pIdxInfo
  195407. ){
  195408. pIdxInfo->estimatedCost = (double)500;
  195409. pIdxInfo->estimatedRows = 500;
  195410. return SQLITE_OK;
  195411. }
  195412. /*
  195413. ** This following structure defines all the methods for the
  195414. ** stmt virtual table.
  195415. */
  195416. static sqlite3_module stmtModule = {
  195417. 0, /* iVersion */
  195418. 0, /* xCreate */
  195419. stmtConnect, /* xConnect */
  195420. stmtBestIndex, /* xBestIndex */
  195421. stmtDisconnect, /* xDisconnect */
  195422. 0, /* xDestroy */
  195423. stmtOpen, /* xOpen - open a cursor */
  195424. stmtClose, /* xClose - close a cursor */
  195425. stmtFilter, /* xFilter - configure scan constraints */
  195426. stmtNext, /* xNext - advance a cursor */
  195427. stmtEof, /* xEof - check for end of scan */
  195428. stmtColumn, /* xColumn - read data */
  195429. stmtRowid, /* xRowid - read data */
  195430. 0, /* xUpdate */
  195431. 0, /* xBegin */
  195432. 0, /* xSync */
  195433. 0, /* xCommit */
  195434. 0, /* xRollback */
  195435. 0, /* xFindMethod */
  195436. 0, /* xRename */
  195437. 0, /* xSavepoint */
  195438. 0, /* xRelease */
  195439. 0, /* xRollbackTo */
  195440. };
  195441. #endif /* SQLITE_OMIT_VIRTUALTABLE */
  195442. SQLITE_PRIVATE int sqlite3StmtVtabInit(sqlite3 *db){
  195443. int rc = SQLITE_OK;
  195444. #ifndef SQLITE_OMIT_VIRTUALTABLE
  195445. rc = sqlite3_create_module(db, "sqlite_stmt", &stmtModule, 0);
  195446. #endif
  195447. return rc;
  195448. }
  195449. #ifndef SQLITE_CORE
  195450. #ifdef _WIN32
  195451. __declspec(dllexport)
  195452. #endif
  195453. SQLITE_API int sqlite3_stmt_init(
  195454. sqlite3 *db,
  195455. char **pzErrMsg,
  195456. const sqlite3_api_routines *pApi
  195457. ){
  195458. int rc = SQLITE_OK;
  195459. SQLITE_EXTENSION_INIT2(pApi);
  195460. #ifndef SQLITE_OMIT_VIRTUALTABLE
  195461. rc = sqlite3StmtVtabInit(db);
  195462. #endif
  195463. return rc;
  195464. }
  195465. #endif /* SQLITE_CORE */
  195466. #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_STMTVTAB) */
  195467. /************** End of stmt.c ************************************************/
  195468. #if __LINE__!=209935
  195469. #undef SQLITE_SOURCE_ID
  195470. #define SQLITE_SOURCE_ID "2018-04-10 17:39:29 4bb2294022060e61de7da5c227a69ccd846ba330e31626ebcd59a94efd14alt2"
  195471. #endif
  195472. /* Return the source-id for this library */
  195473. SQLITE_API const char *sqlite3_sourceid(void){ return SQLITE_SOURCE_ID; }
  195474. /************************** End of sqlite3.c ******************************/
  195475. #else // USE_LIBSQLITE3
  195476. // If users really want to link against the system sqlite3 we
  195477. // need to make this file a noop.
  195478. #endif